* doc/invoke.texi: Add reference to Visibility document.
[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 -Wsynth}
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-invalid-offsetof -Winvalid-pch @gol
225 -Wlarger-than-@var{len} -Wlong-long @gol
226 -Wmain -Wmissing-braces -Wmissing-field-initializers @gol
227 -Wmissing-format-attribute -Wmissing-include-dirs @gol
228 -Wmissing-noreturn @gol
229 -Wno-multichar -Wnonnull -Wpacked -Wpadded @gol
230 -Wparentheses -Wpointer-arith -Wredundant-decls @gol
231 -Wreturn-type -Wsequence-point -Wshadow @gol
232 -Wsign-compare -Wstrict-aliasing -Wstrict-aliasing=2 @gol
233 -Wswitch -Wswitch-default -Wswitch-enum @gol
234 -Wsystem-headers -Wtrigraphs -Wundef -Wuninitialized @gol
235 -Wunknown-pragmas -Wunreachable-code @gol
236 -Wunused -Wunused-function -Wunused-label -Wunused-parameter @gol
237 -Wunused-value -Wunused-variable -Wwrite-strings @gol
238 -Wvariadic-macros}
239
240 @item C-only Warning Options
241 @gccoptlist{-Wbad-function-cast -Wmissing-declarations @gol
242 -Wmissing-prototypes -Wnested-externs -Wold-style-definition @gol
243 -Wstrict-prototypes -Wtraditional @gol
244 -Wdeclaration-after-statement -Wno-pointer-sign}
245
246 @item Debugging Options
247 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
248 @gccoptlist{-d@var{letters} -dumpspecs -dumpmachine -dumpversion @gol
249 -fdump-unnumbered -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
250 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
251 -fdump-ipa-all -fdump-ipa-cgraph @gol
252 -fdump-tree-all @gol
253 -fdump-tree-original@r{[}-@var{n}@r{]} @gol
254 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
255 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
256 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
257 -fdump-tree-ch @gol
258 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
259 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
260 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
261 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
262 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
263 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
264 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
266 -fdump-tree-nrv -fdump-tree-vect @gol
267 -fdump-tree-sink @gol
268 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
269 -fdump-tree-salias @gol
270 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
271 -ftree-vectorizer-verbose=@var{n} @gol
272 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
273 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs -ftree-based-profiling @gol
274 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
275 -ftest-coverage -ftime-report -fvar-tracking @gol
276 -g -g@var{level} -gcoff -gdwarf-2 @gol
277 -ggdb -gstabs -gstabs+ -gvms -gxcoff -gxcoff+ @gol
278 -p -pg -print-file-name=@var{library} -print-libgcc-file-name @gol
279 -print-multi-directory -print-multi-lib @gol
280 -print-prog-name=@var{program} -print-search-dirs -Q @gol
281 -save-temps -time}
282
283 @item Optimization Options
284 @xref{Optimize Options,,Options that Control Optimization}.
285 @gccoptlist{-falign-functions=@var{n} -falign-jumps=@var{n} @gol
286 -falign-labels=@var{n} -falign-loops=@var{n} @gol
287 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
288 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
289 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
290 -fcaller-saves -fcprop-registers -fcse-follow-jumps @gol
291 -fcse-follow-jumps -fcse-skip-blocks -fcx-limited-range -fdata-sections @gol
292 -fdelayed-branch -fdelete-null-pointer-checks @gol
293 -fexpensive-optimizations -ffast-math -ffloat-store @gol
294 -fforce-addr -fforce-mem -ffunction-sections @gol
295 -fgcse -fgcse-lm -fgcse-sm -fgcse-las -fgcse-after-reload @gol
296 -floop-optimize -fcrossjumping -fif-conversion -fif-conversion2 @gol
297 -finline-functions -finline-limit=@var{n} -fkeep-inline-functions @gol
298 -fkeep-static-consts -fmerge-constants -fmerge-all-constants @gol
299 -fmodulo-sched -fno-branch-count-reg @gol
300 -fno-default-inline -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
301 -fno-function-cse -fno-guess-branch-probability @gol
302 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
303 -funsafe-math-optimizations -ffinite-math-only @gol
304 -fno-trapping-math -fno-zero-initialized-in-bss @gol
305 -fomit-frame-pointer -foptimize-register-move @gol
306 -foptimize-sibling-calls -fprefetch-loop-arrays @gol
307 -fprofile-generate -fprofile-use @gol
308 -fregmove -frename-registers @gol
309 -freorder-blocks -freorder-blocks-and-partition -freorder-functions @gol
310 -frerun-cse-after-loop -frerun-loop-opt @gol
311 -frounding-math -fschedule-insns -fschedule-insns2 @gol
312 -fno-sched-interblock -fno-sched-spec -fsched-spec-load @gol
313 -fsched-spec-load-dangerous @gol
314 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
315 -fsched2-use-superblocks @gol
316 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
317 -fsignaling-nans -fsingle-precision-constant -fspeculative-prefetching @gol
318 -fstrength-reduce -fstrict-aliasing -ftracer -fthread-jumps @gol
319 -funroll-all-loops -funroll-loops -fpeel-loops @gol
320 -fsplit-ivs-in-unroller -funswitch-loops @gol
321 -fvariable-expansion-in-unroller @gol
322 -ftree-pre -ftree-ccp -ftree-dce -ftree-loop-optimize @gol
323 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
324 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
325 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
326 -ftree-salias @gol
327 --param @var{name}=@var{value}
328 -O -O0 -O1 -O2 -O3 -Os}
329
330 @item Preprocessor Options
331 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
332 @gccoptlist{-A@var{question}=@var{answer} @gol
333 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
334 -C -dD -dI -dM -dN @gol
335 -D@var{macro}@r{[}=@var{defn}@r{]} -E -H @gol
336 -idirafter @var{dir} @gol
337 -include @var{file} -imacros @var{file} @gol
338 -iprefix @var{file} -iwithprefix @var{dir} @gol
339 -iwithprefixbefore @var{dir} -isystem @var{dir} @gol
340 -M -MM -MF -MG -MP -MQ -MT -nostdinc @gol
341 -P -fworking-directory -remap @gol
342 -trigraphs -undef -U@var{macro} -Wp,@var{option} @gol
343 -Xpreprocessor @var{option}}
344
345 @item Assembler Option
346 @xref{Assembler Options,,Passing Options to the Assembler}.
347 @gccoptlist{-Wa,@var{option} -Xassembler @var{option}}
348
349 @item Linker Options
350 @xref{Link Options,,Options for Linking}.
351 @gccoptlist{@var{object-file-name} -l@var{library} @gol
352 -nostartfiles -nodefaultlibs -nostdlib -pie @gol
353 -s -static -static-libgcc -shared -shared-libgcc -symbolic @gol
354 -Wl,@var{option} -Xlinker @var{option} @gol
355 -u @var{symbol}}
356
357 @item Directory Options
358 @xref{Directory Options,,Options for Directory Search}.
359 @gccoptlist{-B@var{prefix} -I@var{dir} -iquote@var{dir} -L@var{dir} -specs=@var{file} -I-}
360
361 @item Target Options
362 @c I wrote this xref this way to avoid overfull hbox. -- rms
363 @xref{Target Options}.
364 @gccoptlist{-V @var{version} -b @var{machine}}
365
366 @item Machine Dependent Options
367 @xref{Submodel Options,,Hardware Models and Configurations}.
368 @c This list is ordered alphanumerically by subsection name.
369 @c Try and put the significant identifier (CPU or system) first,
370 @c so users have a clue at guessing where the ones they want will be.
371
372 @emph{ARC Options}
373 @gccoptlist{-EB -EL @gol
374 -mmangle-cpu -mcpu=@var{cpu} -mtext=@var{text-section} @gol
375 -mdata=@var{data-section} -mrodata=@var{readonly-data-section}}
376
377 @emph{ARM Options}
378 @gccoptlist{-mapcs-frame -mno-apcs-frame @gol
379 -mabi=@var{name} @gol
380 -mapcs-stack-check -mno-apcs-stack-check @gol
381 -mapcs-float -mno-apcs-float @gol
382 -mapcs-reentrant -mno-apcs-reentrant @gol
383 -msched-prolog -mno-sched-prolog @gol
384 -mlittle-endian -mbig-endian -mwords-little-endian @gol
385 -mfloat-abi=@var{name} -msoft-float -mhard-float -mfpe @gol
386 -mthumb-interwork -mno-thumb-interwork @gol
387 -mcpu=@var{name} -march=@var{name} -mfpu=@var{name} @gol
388 -mstructure-size-boundary=@var{n} @gol
389 -mabort-on-noreturn @gol
390 -mlong-calls -mno-long-calls @gol
391 -msingle-pic-base -mno-single-pic-base @gol
392 -mpic-register=@var{reg} @gol
393 -mnop-fun-dllimport @gol
394 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
395 -mpoke-function-name @gol
396 -mthumb -marm @gol
397 -mtpcs-frame -mtpcs-leaf-frame @gol
398 -mcaller-super-interworking -mcallee-super-interworking}
399
400 @emph{AVR Options}
401 @gccoptlist{-mmcu=@var{mcu} -msize -minit-stack=@var{n} -mno-interrupts @gol
402 -mcall-prologues -mno-tablejump -mtiny-stack -mint8}
403
404 @emph{CRIS Options}
405 @gccoptlist{-mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
406 -mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
407 -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
408 -mstack-align -mdata-align -mconst-align @gol
409 -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
410 -melf -maout -melinux -mlinux -sim -sim2 @gol
411 -mmul-bug-workaround -mno-mul-bug-workaround}
412
413 @emph{Darwin Options}
414 @gccoptlist{-all_load -allowable_client -arch -arch_errors_fatal @gol
415 -arch_only -bind_at_load -bundle -bundle_loader @gol
416 -client_name -compatibility_version -current_version @gol
417 -dead_strip @gol
418 -dependency-file -dylib_file -dylinker_install_name @gol
419 -dynamic -dynamiclib -exported_symbols_list @gol
420 -filelist -flat_namespace -force_cpusubtype_ALL @gol
421 -force_flat_namespace -headerpad_max_install_names @gol
422 -image_base -init -install_name -keep_private_externs @gol
423 -multi_module -multiply_defined -multiply_defined_unused @gol
424 -noall_load -no_dead_strip_inits_and_terms @gol
425 -nofixprebinding -nomultidefs -noprebind -noseglinkedit @gol
426 -pagezero_size -prebind -prebind_all_twolevel_modules @gol
427 -private_bundle -read_only_relocs -sectalign @gol
428 -sectobjectsymbols -whyload -seg1addr @gol
429 -sectcreate -sectobjectsymbols -sectorder @gol
430 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
431 -seg_addr_table -seg_addr_table_filename -seglinkedit @gol
432 -segprot -segs_read_only_addr -segs_read_write_addr @gol
433 -single_module -static -sub_library -sub_umbrella @gol
434 -twolevel_namespace -umbrella -undefined @gol
435 -unexported_symbols_list -weak_reference_mismatches @gol
436 -whatsloaded -F -gused -gfull -mone-byte-bool}
437
438 @emph{DEC Alpha Options}
439 @gccoptlist{-mno-fp-regs -msoft-float -malpha-as -mgas @gol
440 -mieee -mieee-with-inexact -mieee-conformant @gol
441 -mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode} @gol
442 -mtrap-precision=@var{mode} -mbuild-constants @gol
443 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} @gol
444 -mbwx -mmax -mfix -mcix @gol
445 -mfloat-vax -mfloat-ieee @gol
446 -mexplicit-relocs -msmall-data -mlarge-data @gol
447 -msmall-text -mlarge-text @gol
448 -mmemory-latency=@var{time}}
449
450 @emph{DEC Alpha/VMS Options}
451 @gccoptlist{-mvms-return-codes}
452
453 @emph{FRV Options}
454 @gccoptlist{-mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 @gol
455 -mhard-float -msoft-float @gol
456 -malloc-cc -mfixed-cc -mdword -mno-dword @gol
457 -mdouble -mno-double @gol
458 -mmedia -mno-media -mmuladd -mno-muladd @gol
459 -mfdpic -minline-plt -mgprel-ro -multilib-library-pic @gol
460 -mlinked-fp -mlong-calls -malign-labels @gol
461 -mlibrary-pic -macc-4 -macc-8 @gol
462 -mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move @gol
463 -mscc -mno-scc -mcond-exec -mno-cond-exec @gol
464 -mvliw-branch -mno-vliw-branch @gol
465 -mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec @gol
466 -mno-nested-cond-exec -mtomcat-stats @gol
467 -mTLS -mtls @gol
468 -mcpu=@var{cpu}}
469
470 @emph{H8/300 Options}
471 @gccoptlist{-mrelax -mh -ms -mn -mint32 -malign-300}
472
473 @emph{HPPA Options}
474 @gccoptlist{-march=@var{architecture-type} @gol
475 -mbig-switch -mdisable-fpregs -mdisable-indexing @gol
476 -mfast-indirect-calls -mgas -mgnu-ld -mhp-ld @gol
477 -mfixed-range=@var{register-range} @gol
478 -mjump-in-delay -mlinker-opt -mlong-calls @gol
479 -mlong-load-store -mno-big-switch -mno-disable-fpregs @gol
480 -mno-disable-indexing -mno-fast-indirect-calls -mno-gas @gol
481 -mno-jump-in-delay -mno-long-load-store @gol
482 -mno-portable-runtime -mno-soft-float @gol
483 -mno-space-regs -msoft-float -mpa-risc-1-0 @gol
484 -mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime @gol
485 -mschedule=@var{cpu-type} -mspace-regs -msio -mwsio @gol
486 -munix=@var{unix-std} -nolibdld -static -threads}
487
488 @emph{i386 and x86-64 Options}
489 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
490 -mfpmath=@var{unit} @gol
491 -masm=@var{dialect} -mno-fancy-math-387 @gol
492 -mno-fp-ret-in-387 -msoft-float -msvr3-shlib @gol
493 -mno-wide-multiply -mrtd -malign-double @gol
494 -mpreferred-stack-boundary=@var{num} @gol
495 -mmmx -msse -msse2 -msse3 -m3dnow @gol
496 -mthreads -mno-align-stringops -minline-all-stringops @gol
497 -mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
498 -m96bit-long-double -mregparm=@var{num} -momit-leaf-frame-pointer @gol
499 -mno-red-zone -mno-tls-direct-seg-refs @gol
500 -mcmodel=@var{code-model} @gol
501 -m32 -m64}
502
503 @emph{IA-64 Options}
504 @gccoptlist{-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
505 -mvolatile-asm-stop -mregister-names -mno-sdata @gol
506 -mconstant-gp -mauto-pic -minline-float-divide-min-latency @gol
507 -minline-float-divide-max-throughput @gol
508 -minline-int-divide-min-latency @gol
509 -minline-int-divide-max-throughput @gol
510 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
511 -mno-dwarf2-asm -mearly-stop-bits @gol
512 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
513 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
514
515 @emph{M32R/D Options}
516 @gccoptlist{-m32r2 -m32rx -m32r @gol
517 -mdebug @gol
518 -malign-loops -mno-align-loops @gol
519 -missue-rate=@var{number} @gol
520 -mbranch-cost=@var{number} @gol
521 -mmodel=@var{code-size-model-type} @gol
522 -msdata=@var{sdata-type} @gol
523 -mno-flush-func -mflush-func=@var{name} @gol
524 -mno-flush-trap -mflush-trap=@var{number} @gol
525 -G @var{num}}
526
527 @emph{M680x0 Options}
528 @gccoptlist{-m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 @gol
529 -m68060 -mcpu32 -m5200 -m68881 -mbitfield -mc68000 -mc68020 @gol
530 -mnobitfield -mrtd -mshort -msoft-float -mpcrel @gol
531 -malign-int -mstrict-align -msep-data -mno-sep-data @gol
532 -mshared-library-id=n -mid-shared-library -mno-id-shared-library}
533
534 @emph{M68hc1x Options}
535 @gccoptlist{-m6811 -m6812 -m68hc11 -m68hc12 -m68hcs12 @gol
536 -mauto-incdec -minmax -mlong-calls -mshort @gol
537 -msoft-reg-count=@var{count}}
538
539 @emph{MCore Options}
540 @gccoptlist{-mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates @gol
541 -mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
542 -m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
543 -mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
544 -mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
545
546 @emph{MIPS Options}
547 @gccoptlist{-EL -EB -march=@var{arch} -mtune=@var{arch} @gol
548 -mips1 -mips2 -mips3 -mips4 -mips32 -mips32r2 -mips64 @gol
549 -mips16 -mno-mips16 -mabi=@var{abi} -mabicalls -mno-abicalls @gol
550 -mxgot -mno-xgot -mgp32 -mgp64 -mfp32 -mfp64 @gol
551 -mhard-float -msoft-float -msingle-float -mdouble-float @gol
552 -mpaired-single -mips3d @gol
553 -mint64 -mlong64 -mlong32 -msym32 -mno-sym32 @gol
554 -G@var{num} -membedded-data -mno-embedded-data @gol
555 -muninit-const-in-rodata -mno-uninit-const-in-rodata @gol
556 -msplit-addresses -mno-split-addresses @gol
557 -mexplicit-relocs -mno-explicit-relocs @gol
558 -mcheck-zero-division -mno-check-zero-division @gol
559 -mdivide-traps -mdivide-breaks @gol
560 -mmemcpy -mno-memcpy -mlong-calls -mno-long-calls @gol
561 -mmad -mno-mad -mfused-madd -mno-fused-madd -nocpp @gol
562 -mfix-r4000 -mno-fix-r4000 -mfix-r4400 -mno-fix-r4400 @gol
563 -mfix-vr4120 -mno-fix-vr4120 -mfix-vr4130 @gol
564 -mfix-sb1 -mno-fix-sb1 @gol
565 -mflush-func=@var{func} -mno-flush-func @gol
566 -mbranch-likely -mno-branch-likely @gol
567 -mfp-exceptions -mno-fp-exceptions @gol
568 -mvr4130-align -mno-vr4130-align}
569
570 @emph{MMIX Options}
571 @gccoptlist{-mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
572 -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
573 -melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
574 -mno-base-addresses -msingle-exit -mno-single-exit}
575
576 @emph{MN10300 Options}
577 @gccoptlist{-mmult-bug -mno-mult-bug @gol
578 -mam33 -mno-am33 @gol
579 -mam33-2 -mno-am33-2 @gol
580 -mno-crt0 -mrelax}
581
582 @emph{NS32K Options}
583 @gccoptlist{-m32032 -m32332 -m32532 -m32081 -m32381 @gol
584 -mmult-add -mnomult-add -msoft-float -mrtd -mnortd @gol
585 -mregparam -mnoregparam -msb -mnosb @gol
586 -mbitfield -mnobitfield -mhimem -mnohimem}
587
588 @emph{PDP-11 Options}
589 @gccoptlist{-mfpu -msoft-float -mac0 -mno-ac0 -m40 -m45 -m10 @gol
590 -mbcopy -mbcopy-builtin -mint32 -mno-int16 @gol
591 -mint16 -mno-int32 -mfloat32 -mno-float64 @gol
592 -mfloat64 -mno-float32 -mabshi -mno-abshi @gol
593 -mbranch-expensive -mbranch-cheap @gol
594 -msplit -mno-split -munix-asm -mdec-asm}
595
596 @emph{PowerPC Options}
597 See RS/6000 and PowerPC Options.
598
599 @emph{RS/6000 and PowerPC Options}
600 @gccoptlist{-mcpu=@var{cpu-type} @gol
601 -mtune=@var{cpu-type} @gol
602 -mpower -mno-power -mpower2 -mno-power2 @gol
603 -mpowerpc -mpowerpc64 -mno-powerpc @gol
604 -maltivec -mno-altivec @gol
605 -mpowerpc-gpopt -mno-powerpc-gpopt @gol
606 -mpowerpc-gfxopt -mno-powerpc-gfxopt @gol
607 -mnew-mnemonics -mold-mnemonics @gol
608 -mfull-toc -mminimal-toc -mno-fp-in-toc -mno-sum-in-toc @gol
609 -m64 -m32 -mxl-compat -mno-xl-compat -mpe @gol
610 -malign-power -malign-natural @gol
611 -msoft-float -mhard-float -mmultiple -mno-multiple @gol
612 -mstring -mno-string -mupdate -mno-update @gol
613 -mfused-madd -mno-fused-madd -mbit-align -mno-bit-align @gol
614 -mstrict-align -mno-strict-align -mrelocatable @gol
615 -mno-relocatable -mrelocatable-lib -mno-relocatable-lib @gol
616 -mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian @gol
617 -mdynamic-no-pic @gol
618 -mprioritize-restricted-insns=@var{priority} @gol
619 -msched-costly-dep=@var{dependence_type} @gol
620 -minsert-sched-nops=@var{scheme} @gol
621 -mcall-sysv -mcall-netbsd @gol
622 -maix-struct-return -msvr4-struct-return @gol
623 -mabi=altivec -mabi=no-altivec @gol
624 -mabi=spe -mabi=no-spe @gol
625 -misel=yes -misel=no @gol
626 -mspe=yes -mspe=no @gol
627 -mfloat-gprs=yes -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
628 -mprototype -mno-prototype @gol
629 -msim -mmvme -mads -myellowknife -memb -msdata @gol
630 -msdata=@var{opt} -mvxworks -mwindiss -G @var{num} -pthread}
631
632 @emph{S/390 and zSeries Options}
633 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
634 -mhard-float -msoft-float -mbackchain -mno-backchain @gol
635 -mpacked-stack -mno-packed-stack @gol
636 -msmall-exec -mno-small-exec -mmvcle -mno-mvcle @gol
637 -m64 -m31 -mdebug -mno-debug -mesa -mzarch @gol
638 -mtpf-trace -mno-tpf-trace -mfused-madd -mno-fused-madd @gol
639 -mwarn-framesize -mwarn-dynamicstack -mstack-size -mstack-guard}
640
641 @emph{SH Options}
642 @gccoptlist{-m1 -m2 -m2e -m3 -m3e @gol
643 -m4-nofpu -m4-single-only -m4-single -m4 @gol
644 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
645 -m5-64media -m5-64media-nofpu @gol
646 -m5-32media -m5-32media-nofpu @gol
647 -m5-compact -m5-compact-nofpu @gol
648 -mb -ml -mdalign -mrelax @gol
649 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
650 -mieee -misize -mpadstruct -mspace @gol
651 -mprefergot -musermode}
652
653 @emph{SPARC Options}
654 @gccoptlist{-mcpu=@var{cpu-type} @gol
655 -mtune=@var{cpu-type} @gol
656 -mcmodel=@var{code-model} @gol
657 -m32 -m64 -mapp-regs -mno-app-regs @gol
658 -mfaster-structs -mno-faster-structs @gol
659 -mfpu -mno-fpu -mhard-float -msoft-float @gol
660 -mhard-quad-float -msoft-quad-float @gol
661 -mimpure-text -mno-impure-text -mlittle-endian @gol
662 -mstack-bias -mno-stack-bias @gol
663 -munaligned-doubles -mno-unaligned-doubles @gol
664 -mv8plus -mno-v8plus -mvis -mno-vis
665 -threads -pthreads}
666
667 @emph{System V Options}
668 @gccoptlist{-Qy -Qn -YP,@var{paths} -Ym,@var{dir}}
669
670 @emph{TMS320C3x/C4x Options}
671 @gccoptlist{-mcpu=@var{cpu} -mbig -msmall -mregparm -mmemparm @gol
672 -mfast-fix -mmpyi -mbk -mti -mdp-isr-reload @gol
673 -mrpts=@var{count} -mrptb -mdb -mloop-unsigned @gol
674 -mparallel-insns -mparallel-mpy -mpreserve-float}
675
676 @emph{V850 Options}
677 @gccoptlist{-mlong-calls -mno-long-calls -mep -mno-ep @gol
678 -mprolog-function -mno-prolog-function -mspace @gol
679 -mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
680 -mapp-regs -mno-app-regs @gol
681 -mdisable-callt -mno-disable-callt @gol
682 -mv850e1 @gol
683 -mv850e @gol
684 -mv850 -mbig-switch}
685
686 @emph{VAX Options}
687 @gccoptlist{-mg -mgnu -munix}
688
689 @emph{x86-64 Options}
690 See i386 and x86-64 Options.
691
692 @emph{Xstormy16 Options}
693 @gccoptlist{-msim}
694
695 @emph{Xtensa Options}
696 @gccoptlist{-mconst16 -mno-const16 @gol
697 -mfused-madd -mno-fused-madd @gol
698 -mtext-section-literals -mno-text-section-literals @gol
699 -mtarget-align -mno-target-align @gol
700 -mlongcalls -mno-longcalls}
701
702 @emph{zSeries Options}
703 See S/390 and zSeries Options.
704
705 @item Code Generation Options
706 @xref{Code Gen Options,,Options for Code Generation Conventions}.
707 @gccoptlist{-fcall-saved-@var{reg} -fcall-used-@var{reg} @gol
708 -ffixed-@var{reg} -fexceptions @gol
709 -fnon-call-exceptions -funwind-tables @gol
710 -fasynchronous-unwind-tables @gol
711 -finhibit-size-directive -finstrument-functions @gol
712 -fno-common -fno-ident @gol
713 -fpcc-struct-return -fpic -fPIC -fpie -fPIE @gol
714 -freg-struct-return -fshared-data -fshort-enums @gol
715 -fshort-double -fshort-wchar @gol
716 -fverbose-asm -fpack-struct[=@var{n}] -fstack-check @gol
717 -fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym} @gol
718 -fargument-alias -fargument-noalias @gol
719 -fargument-noalias-global -fleading-underscore @gol
720 -ftls-model=@var{model} @gol
721 -ftrapv -fwrapv -fbounds-check @gol
722 -fvisibility}
723 @end table
724
725 @menu
726 * Overall Options:: Controlling the kind of output:
727 an executable, object files, assembler files,
728 or preprocessed source.
729 * C Dialect Options:: Controlling the variant of C language compiled.
730 * C++ Dialect Options:: Variations on C++.
731 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
732 and Objective-C++.
733 * Language Independent Options:: Controlling how diagnostics should be
734 formatted.
735 * Warning Options:: How picky should the compiler be?
736 * Debugging Options:: Symbol tables, measurements, and debugging dumps.
737 * Optimize Options:: How much optimization?
738 * Preprocessor Options:: Controlling header files and macro definitions.
739 Also, getting dependency information for Make.
740 * Assembler Options:: Passing options to the assembler.
741 * Link Options:: Specifying libraries and so on.
742 * Directory Options:: Where to find header files and libraries.
743 Where to find the compiler executable files.
744 * Spec Files:: How to pass switches to sub-processes.
745 * Target Options:: Running a cross-compiler, or an old version of GCC.
746 @end menu
747
748 @node Overall Options
749 @section Options Controlling the Kind of Output
750
751 Compilation can involve up to four stages: preprocessing, compilation
752 proper, assembly and linking, always in that order. GCC is capable of
753 preprocessing and compiling several files either into several
754 assembler input files, or into one assembler input file; then each
755 assembler input file produces an object file, and linking combines all
756 the object files (those newly compiled, and those specified as input)
757 into an executable file.
758
759 @cindex file name suffix
760 For any given input file, the file name suffix determines what kind of
761 compilation is done:
762
763 @table @gcctabopt
764 @item @var{file}.c
765 C source code which must be preprocessed.
766
767 @item @var{file}.i
768 C source code which should not be preprocessed.
769
770 @item @var{file}.ii
771 C++ source code which should not be preprocessed.
772
773 @item @var{file}.m
774 Objective-C source code. Note that you must link with the @file{libobjc}
775 library to make an Objective-C program work.
776
777 @item @var{file}.mi
778 Objective-C source code which should not be preprocessed.
779
780 @item @var{file}.mm
781 @itemx @var{file}.M
782 Objective-C++ source code. Note that you must link with the @file{libobjc}
783 library to make an Objective-C++ program work. Note that @samp{.M} refers
784 to a literal capital M@.
785
786 @item @var{file}.mii
787 Objective-C++ source code which should not be preprocessed.
788
789 @item @var{file}.h
790 C, C++, Objective-C or Objective-C++ header file to be turned into a
791 precompiled header.
792
793 @item @var{file}.cc
794 @itemx @var{file}.cp
795 @itemx @var{file}.cxx
796 @itemx @var{file}.cpp
797 @itemx @var{file}.CPP
798 @itemx @var{file}.c++
799 @itemx @var{file}.C
800 C++ source code which must be preprocessed. Note that in @samp{.cxx},
801 the last two letters must both be literally @samp{x}. Likewise,
802 @samp{.C} refers to a literal capital C@.
803
804 @item @var{file}.hh
805 @itemx @var{file}.H
806 C++ header file to be turned into a precompiled header.
807
808 @item @var{file}.f
809 @itemx @var{file}.for
810 @itemx @var{file}.FOR
811 Fortran source code which should not be preprocessed.
812
813 @item @var{file}.F
814 @itemx @var{file}.fpp
815 @itemx @var{file}.FPP
816 Fortran source code which must be preprocessed (with the traditional
817 preprocessor).
818
819 @item @var{file}.r
820 Fortran source code which must be preprocessed with a RATFOR
821 preprocessor (not included with GCC)@.
822
823 @item @var{file}.f90
824 @itemx @var{file}.f95
825 Fortran 90/95 source code which should not be preprocessed.
826
827 @c FIXME: Descriptions of Java file types.
828 @c @var{file}.java
829 @c @var{file}.class
830 @c @var{file}.zip
831 @c @var{file}.jar
832
833 @item @var{file}.ads
834 Ada source code file which contains a library unit declaration (a
835 declaration of a package, subprogram, or generic, or a generic
836 instantiation), or a library unit renaming declaration (a package,
837 generic, or subprogram renaming declaration). Such files are also
838 called @dfn{specs}.
839
840 @itemx @var{file}.adb
841 Ada source code file containing a library unit body (a subprogram or
842 package body). Such files are also called @dfn{bodies}.
843
844 @c GCC also knows about some suffixes for languages not yet included:
845 @c Pascal:
846 @c @var{file}.p
847 @c @var{file}.pas
848
849 @item @var{file}.s
850 Assembler code.
851
852 @item @var{file}.S
853 Assembler code which must be preprocessed.
854
855 @item @var{other}
856 An object file to be fed straight into linking.
857 Any file name with no recognized suffix is treated this way.
858 @end table
859
860 @opindex x
861 You can specify the input language explicitly with the @option{-x} option:
862
863 @table @gcctabopt
864 @item -x @var{language}
865 Specify explicitly the @var{language} for the following input files
866 (rather than letting the compiler choose a default based on the file
867 name suffix). This option applies to all following input files until
868 the next @option{-x} option. Possible values for @var{language} are:
869 @smallexample
870 c c-header c-cpp-output
871 c++ c++-header c++-cpp-output
872 objective-c objective-c-header objective-c-cpp-output
873 objective-c++ objective-c++-header objective-c++-cpp-output
874 assembler assembler-with-cpp
875 ada
876 f77 f77-cpp-input ratfor
877 f95
878 java
879 treelang
880 @end smallexample
881
882 @item -x none
883 Turn off any specification of a language, so that subsequent files are
884 handled according to their file name suffixes (as they are if @option{-x}
885 has not been used at all).
886
887 @item -pass-exit-codes
888 @opindex pass-exit-codes
889 Normally the @command{gcc} program will exit with the code of 1 if any
890 phase of the compiler returns a non-success return code. If you specify
891 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
892 numerically highest error produced by any phase that returned an error
893 indication.
894 @end table
895
896 If you only want some of the stages of compilation, you can use
897 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
898 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
899 @command{gcc} is to stop. Note that some combinations (for example,
900 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
901
902 @table @gcctabopt
903 @item -c
904 @opindex c
905 Compile or assemble the source files, but do not link. The linking
906 stage simply is not done. The ultimate output is in the form of an
907 object file for each source file.
908
909 By default, the object file name for a source file is made by replacing
910 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
911
912 Unrecognized input files, not requiring compilation or assembly, are
913 ignored.
914
915 @item -S
916 @opindex S
917 Stop after the stage of compilation proper; do not assemble. The output
918 is in the form of an assembler code file for each non-assembler input
919 file specified.
920
921 By default, the assembler file name for a source file is made by
922 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
923
924 Input files that don't require compilation are ignored.
925
926 @item -E
927 @opindex E
928 Stop after the preprocessing stage; do not run the compiler proper. The
929 output is in the form of preprocessed source code, which is sent to the
930 standard output.
931
932 Input files which don't require preprocessing are ignored.
933
934 @cindex output file option
935 @item -o @var{file}
936 @opindex o
937 Place output in file @var{file}. This applies regardless to whatever
938 sort of output is being produced, whether it be an executable file,
939 an object file, an assembler file or preprocessed C code.
940
941 If @option{-o} is not specified, the default is to put an executable
942 file in @file{a.out}, the object file for
943 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
944 assembler file in @file{@var{source}.s}, a precompiled header file in
945 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
946 standard output.
947
948 @item -v
949 @opindex v
950 Print (on standard error output) the commands executed to run the stages
951 of compilation. Also print the version number of the compiler driver
952 program and of the preprocessor and the compiler proper.
953
954 @item -###
955 @opindex ###
956 Like @option{-v} except the commands are not executed and all command
957 arguments are quoted. This is useful for shell scripts to capture the
958 driver-generated command lines.
959
960 @item -pipe
961 @opindex pipe
962 Use pipes rather than temporary files for communication between the
963 various stages of compilation. This fails to work on some systems where
964 the assembler is unable to read from a pipe; but the GNU assembler has
965 no trouble.
966
967 @item -combine
968 @opindex combine
969 If you are compiling multiple source files, this option tells the driver
970 to pass all the source files to the compiler at once (for those
971 languages for which the compiler can handle this). This will allow
972 intermodule analysis (IMA) to be performed by the compiler. Currently the only
973 language for which this is supported is C@. If you pass source files for
974 multiple languages to the driver, using this option, the driver will invoke
975 the compiler(s) that support IMA once each, passing each compiler all the
976 source files appropriate for it. For those languages that do not support
977 IMA this option will be ignored, and the compiler will be invoked once for
978 each source file in that language. If you use this option in conjunction
979 with @option{-save-temps}, the compiler will generate multiple
980 pre-processed files
981 (one for each source file), but only one (combined) @file{.o} or
982 @file{.s} file.
983
984 @item --help
985 @opindex help
986 Print (on the standard output) a description of the command line options
987 understood by @command{gcc}. If the @option{-v} option is also specified
988 then @option{--help} will also be passed on to the various processes
989 invoked by @command{gcc}, so that they can display the command line options
990 they accept. If the @option{-Wextra} option is also specified then command
991 line options which have no documentation associated with them will also
992 be displayed.
993
994 @item --target-help
995 @opindex target-help
996 Print (on the standard output) a description of target specific command
997 line options for each tool.
998
999 @item --version
1000 @opindex version
1001 Display the version number and copyrights of the invoked GCC@.
1002 @end table
1003
1004 @node Invoking G++
1005 @section Compiling C++ Programs
1006
1007 @cindex suffixes for C++ source
1008 @cindex C++ source file suffixes
1009 C++ source files conventionally use one of the suffixes @samp{.C},
1010 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1011 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1012 preprocessed C++ files use the suffix @samp{.ii}. GCC recognizes
1013 files with these names and compiles them as C++ programs even if you
1014 call the compiler the same way as for compiling C programs (usually
1015 with the name @command{gcc}).
1016
1017 @findex g++
1018 @findex c++
1019 However, C++ programs often require class libraries as well as a
1020 compiler that understands the C++ language---and under some
1021 circumstances, you might want to compile programs or header files from
1022 standard input, or otherwise without a suffix that flags them as C++
1023 programs. You might also like to precompile a C header file with a
1024 @samp{.h} extension to be used in C++ compilations. @command{g++} is a
1025 program that calls GCC with the default language set to C++, and
1026 automatically specifies linking against the C++ library. On many
1027 systems, @command{g++} is also installed with the name @command{c++}.
1028
1029 @cindex invoking @command{g++}
1030 When you compile C++ programs, you may specify many of the same
1031 command-line options that you use for compiling programs in any
1032 language; or command-line options meaningful for C and related
1033 languages; or options that are meaningful only for C++ programs.
1034 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1035 explanations of options for languages related to C@.
1036 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1037 explanations of options that are meaningful only for C++ programs.
1038
1039 @node C Dialect Options
1040 @section Options Controlling C Dialect
1041 @cindex dialect options
1042 @cindex language dialect options
1043 @cindex options, dialect
1044
1045 The following options control the dialect of C (or languages derived
1046 from C, such as C++, Objective-C and Objective-C++) that the compiler
1047 accepts:
1048
1049 @table @gcctabopt
1050 @cindex ANSI support
1051 @cindex ISO support
1052 @item -ansi
1053 @opindex ansi
1054 In C mode, support all ISO C90 programs. In C++ mode,
1055 remove GNU extensions that conflict with ISO C++.
1056
1057 This turns off certain features of GCC that are incompatible with ISO
1058 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1059 such as the @code{asm} and @code{typeof} keywords, and
1060 predefined macros such as @code{unix} and @code{vax} that identify the
1061 type of system you are using. It also enables the undesirable and
1062 rarely used ISO trigraph feature. For the C compiler,
1063 it disables recognition of C++ style @samp{//} comments as well as
1064 the @code{inline} keyword.
1065
1066 The alternate keywords @code{__asm__}, @code{__extension__},
1067 @code{__inline__} and @code{__typeof__} continue to work despite
1068 @option{-ansi}. You would not want to use them in an ISO C program, of
1069 course, but it is useful to put them in header files that might be included
1070 in compilations done with @option{-ansi}. Alternate predefined macros
1071 such as @code{__unix__} and @code{__vax__} are also available, with or
1072 without @option{-ansi}.
1073
1074 The @option{-ansi} option does not cause non-ISO programs to be
1075 rejected gratuitously. For that, @option{-pedantic} is required in
1076 addition to @option{-ansi}. @xref{Warning Options}.
1077
1078 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1079 option is used. Some header files may notice this macro and refrain
1080 from declaring certain functions or defining certain macros that the
1081 ISO standard doesn't call for; this is to avoid interfering with any
1082 programs that might use these names for other things.
1083
1084 Functions which would normally be built in but do not have semantics
1085 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1086 functions with @option{-ansi} is used. @xref{Other Builtins,,Other
1087 built-in functions provided by GCC}, for details of the functions
1088 affected.
1089
1090 @item -std=
1091 @opindex std
1092 Determine the language standard. This option is currently only
1093 supported when compiling C or C++. A value for this option must be
1094 provided; possible values are
1095
1096 @table @samp
1097 @item c89
1098 @itemx iso9899:1990
1099 ISO C90 (same as @option{-ansi}).
1100
1101 @item iso9899:199409
1102 ISO C90 as modified in amendment 1.
1103
1104 @item c99
1105 @itemx c9x
1106 @itemx iso9899:1999
1107 @itemx iso9899:199x
1108 ISO C99. Note that this standard is not yet fully supported; see
1109 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information. The
1110 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1111
1112 @item gnu89
1113 Default, ISO C90 plus GNU extensions (including some C99 features).
1114
1115 @item gnu99
1116 @itemx gnu9x
1117 ISO C99 plus GNU extensions. When ISO C99 is fully implemented in GCC,
1118 this will become the default. The name @samp{gnu9x} is deprecated.
1119
1120 @item c++98
1121 The 1998 ISO C++ standard plus amendments.
1122
1123 @item gnu++98
1124 The same as @option{-std=c++98} plus GNU extensions. This is the
1125 default for C++ code.
1126 @end table
1127
1128 Even when this option is not specified, you can still use some of the
1129 features of newer standards in so far as they do not conflict with
1130 previous C standards. For example, you may use @code{__restrict__} even
1131 when @option{-std=c99} is not specified.
1132
1133 The @option{-std} options specifying some version of ISO C have the same
1134 effects as @option{-ansi}, except that features that were not in ISO C90
1135 but are in the specified version (for example, @samp{//} comments and
1136 the @code{inline} keyword in ISO C99) are not disabled.
1137
1138 @xref{Standards,,Language Standards Supported by GCC}, for details of
1139 these standard versions.
1140
1141 @item -aux-info @var{filename}
1142 @opindex aux-info
1143 Output to the given filename prototyped declarations for all functions
1144 declared and/or defined in a translation unit, including those in header
1145 files. This option is silently ignored in any language other than C@.
1146
1147 Besides declarations, the file indicates, in comments, the origin of
1148 each declaration (source file and line), whether the declaration was
1149 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1150 @samp{O} for old, respectively, in the first character after the line
1151 number and the colon), and whether it came from a declaration or a
1152 definition (@samp{C} or @samp{F}, respectively, in the following
1153 character). In the case of function definitions, a K&R-style list of
1154 arguments followed by their declarations is also provided, inside
1155 comments, after the declaration.
1156
1157 @item -fno-asm
1158 @opindex fno-asm
1159 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1160 keyword, so that code can use these words as identifiers. You can use
1161 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1162 instead. @option{-ansi} implies @option{-fno-asm}.
1163
1164 In C++, this switch only affects the @code{typeof} keyword, since
1165 @code{asm} and @code{inline} are standard keywords. You may want to
1166 use the @option{-fno-gnu-keywords} flag instead, which has the same
1167 effect. In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1168 switch only affects the @code{asm} and @code{typeof} keywords, since
1169 @code{inline} is a standard keyword in ISO C99.
1170
1171 @item -fno-builtin
1172 @itemx -fno-builtin-@var{function}
1173 @opindex fno-builtin
1174 @cindex built-in functions
1175 Don't recognize built-in functions that do not begin with
1176 @samp{__builtin_} as prefix. @xref{Other Builtins,,Other built-in
1177 functions provided by GCC}, for details of the functions affected,
1178 including those which are not built-in functions when @option{-ansi} or
1179 @option{-std} options for strict ISO C conformance are used because they
1180 do not have an ISO standard meaning.
1181
1182 GCC normally generates special code to handle certain built-in functions
1183 more efficiently; for instance, calls to @code{alloca} may become single
1184 instructions that adjust the stack directly, and calls to @code{memcpy}
1185 may become inline copy loops. The resulting code is often both smaller
1186 and faster, but since the function calls no longer appear as such, you
1187 cannot set a breakpoint on those calls, nor can you change the behavior
1188 of the functions by linking with a different library. In addition,
1189 when a function is recognized as a built-in function, GCC may use
1190 information about that function to warn about problems with calls to
1191 that function, or to generate more efficient code, even if the
1192 resulting code still contains calls to that function. For example,
1193 warnings are given with @option{-Wformat} for bad calls to
1194 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1195 known not to modify global memory.
1196
1197 With the @option{-fno-builtin-@var{function}} option
1198 only the built-in function @var{function} is
1199 disabled. @var{function} must not begin with @samp{__builtin_}. If a
1200 function is named this is not built-in in this version of GCC, this
1201 option is ignored. There is no corresponding
1202 @option{-fbuiltin-@var{function}} option; if you wish to enable
1203 built-in functions selectively when using @option{-fno-builtin} or
1204 @option{-ffreestanding}, you may define macros such as:
1205
1206 @smallexample
1207 #define abs(n) __builtin_abs ((n))
1208 #define strcpy(d, s) __builtin_strcpy ((d), (s))
1209 @end smallexample
1210
1211 @item -fhosted
1212 @opindex fhosted
1213 @cindex hosted environment
1214
1215 Assert that compilation takes place in a hosted environment. This implies
1216 @option{-fbuiltin}. A hosted environment is one in which the
1217 entire standard library is available, and in which @code{main} has a return
1218 type of @code{int}. Examples are nearly everything except a kernel.
1219 This is equivalent to @option{-fno-freestanding}.
1220
1221 @item -ffreestanding
1222 @opindex ffreestanding
1223 @cindex hosted environment
1224
1225 Assert that compilation takes place in a freestanding environment. This
1226 implies @option{-fno-builtin}. A freestanding environment
1227 is one in which the standard library may not exist, and program startup may
1228 not necessarily be at @code{main}. The most obvious example is an OS kernel.
1229 This is equivalent to @option{-fno-hosted}.
1230
1231 @xref{Standards,,Language Standards Supported by GCC}, for details of
1232 freestanding and hosted environments.
1233
1234 @item -fms-extensions
1235 @opindex fms-extensions
1236 Accept some non-standard constructs used in Microsoft header files.
1237
1238 Some cases of unnamed fields in structures and unions are only
1239 accepted with this option. @xref{Unnamed Fields,,Unnamed struct/union
1240 fields within structs/unions}, for details.
1241
1242 @item -trigraphs
1243 @opindex trigraphs
1244 Support ISO C trigraphs. The @option{-ansi} option (and @option{-std}
1245 options for strict ISO C conformance) implies @option{-trigraphs}.
1246
1247 @item -no-integrated-cpp
1248 @opindex no-integrated-cpp
1249 Performs a compilation in two passes: preprocessing and compiling. This
1250 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1251 @option{-B} option. The user supplied compilation step can then add in
1252 an additional preprocessing step after normal preprocessing but before
1253 compiling. The default is to use the integrated cpp (internal cpp)
1254
1255 The semantics of this option will change if "cc1", "cc1plus", and
1256 "cc1obj" are merged.
1257
1258 @cindex traditional C language
1259 @cindex C language, traditional
1260 @item -traditional
1261 @itemx -traditional-cpp
1262 @opindex traditional-cpp
1263 @opindex traditional
1264 Formerly, these options caused GCC to attempt to emulate a pre-standard
1265 C compiler. They are now only supported with the @option{-E} switch.
1266 The preprocessor continues to support a pre-standard mode. See the GNU
1267 CPP manual for details.
1268
1269 @item -fcond-mismatch
1270 @opindex fcond-mismatch
1271 Allow conditional expressions with mismatched types in the second and
1272 third arguments. The value of such an expression is void. This option
1273 is not supported for C++.
1274
1275 @item -funsigned-char
1276 @opindex funsigned-char
1277 Let the type @code{char} be unsigned, like @code{unsigned char}.
1278
1279 Each kind of machine has a default for what @code{char} should
1280 be. It is either like @code{unsigned char} by default or like
1281 @code{signed char} by default.
1282
1283 Ideally, a portable program should always use @code{signed char} or
1284 @code{unsigned char} when it depends on the signedness of an object.
1285 But many programs have been written to use plain @code{char} and
1286 expect it to be signed, or expect it to be unsigned, depending on the
1287 machines they were written for. This option, and its inverse, let you
1288 make such a program work with the opposite default.
1289
1290 The type @code{char} is always a distinct type from each of
1291 @code{signed char} or @code{unsigned char}, even though its behavior
1292 is always just like one of those two.
1293
1294 @item -fsigned-char
1295 @opindex fsigned-char
1296 Let the type @code{char} be signed, like @code{signed char}.
1297
1298 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1299 the negative form of @option{-funsigned-char}. Likewise, the option
1300 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1301
1302 @item -fsigned-bitfields
1303 @itemx -funsigned-bitfields
1304 @itemx -fno-signed-bitfields
1305 @itemx -fno-unsigned-bitfields
1306 @opindex fsigned-bitfields
1307 @opindex funsigned-bitfields
1308 @opindex fno-signed-bitfields
1309 @opindex fno-unsigned-bitfields
1310 These options control whether a bit-field is signed or unsigned, when the
1311 declaration does not use either @code{signed} or @code{unsigned}. By
1312 default, such a bit-field is signed, because this is consistent: the
1313 basic integer types such as @code{int} are signed types.
1314 @end table
1315
1316 @node C++ Dialect Options
1317 @section Options Controlling C++ Dialect
1318
1319 @cindex compiler options, C++
1320 @cindex C++ options, command line
1321 @cindex options, C++
1322 This section describes the command-line options that are only meaningful
1323 for C++ programs; but you can also use most of the GNU compiler options
1324 regardless of what language your program is in. For example, you
1325 might compile a file @code{firstClass.C} like this:
1326
1327 @smallexample
1328 g++ -g -frepo -O -c firstClass.C
1329 @end smallexample
1330
1331 @noindent
1332 In this example, only @option{-frepo} is an option meant
1333 only for C++ programs; you can use the other options with any
1334 language supported by GCC@.
1335
1336 Here is a list of options that are @emph{only} for compiling C++ programs:
1337
1338 @table @gcctabopt
1339
1340 @item -fabi-version=@var{n}
1341 @opindex fabi-version
1342 Use version @var{n} of the C++ ABI@. Version 2 is the version of the
1343 C++ ABI that first appeared in G++ 3.4. Version 1 is the version of
1344 the C++ ABI that first appeared in G++ 3.2. Version 0 will always be
1345 the version that conforms most closely to the C++ ABI specification.
1346 Therefore, the ABI obtained using version 0 will change as ABI bugs
1347 are fixed.
1348
1349 The default is version 2.
1350
1351 @item -fno-access-control
1352 @opindex fno-access-control
1353 Turn off all access checking. This switch is mainly useful for working
1354 around bugs in the access control code.
1355
1356 @item -fcheck-new
1357 @opindex fcheck-new
1358 Check that the pointer returned by @code{operator new} is non-null
1359 before attempting to modify the storage allocated. This check is
1360 normally unnecessary because the C++ standard specifies that
1361 @code{operator new} will only return @code{0} if it is declared
1362 @samp{throw()}, in which case the compiler will always check the
1363 return value even without this option. In all other cases, when
1364 @code{operator new} has a non-empty exception specification, memory
1365 exhaustion is signalled by throwing @code{std::bad_alloc}. See also
1366 @samp{new (nothrow)}.
1367
1368 @item -fconserve-space
1369 @opindex fconserve-space
1370 Put uninitialized or runtime-initialized global variables into the
1371 common segment, as C does. This saves space in the executable at the
1372 cost of not diagnosing duplicate definitions. If you compile with this
1373 flag and your program mysteriously crashes after @code{main()} has
1374 completed, you may have an object that is being destroyed twice because
1375 two definitions were merged.
1376
1377 This option is no longer useful on most targets, now that support has
1378 been added for putting variables into BSS without making them common.
1379
1380 @item -fno-const-strings
1381 @opindex fno-const-strings
1382 Give string constants type @code{char *} instead of type @code{const
1383 char *}. By default, G++ uses type @code{const char *} as required by
1384 the standard. Even if you use @option{-fno-const-strings}, you cannot
1385 actually modify the value of a string constant.
1386
1387 This option might be removed in a future release of G++. For maximum
1388 portability, you should structure your code so that it works with
1389 string constants that have type @code{const char *}.
1390
1391 @item -fno-elide-constructors
1392 @opindex fno-elide-constructors
1393 The C++ standard allows an implementation to omit creating a temporary
1394 which is only used to initialize another object of the same type.
1395 Specifying this option disables that optimization, and forces G++ to
1396 call the copy constructor in all cases.
1397
1398 @item -fno-enforce-eh-specs
1399 @opindex fno-enforce-eh-specs
1400 Don't check for violation of exception specifications at runtime. This
1401 option violates the C++ standard, but may be useful for reducing code
1402 size in production builds, much like defining @samp{NDEBUG}. The compiler
1403 will still optimize based on the exception specifications.
1404
1405 @item -ffor-scope
1406 @itemx -fno-for-scope
1407 @opindex ffor-scope
1408 @opindex fno-for-scope
1409 If @option{-ffor-scope} is specified, the scope of variables declared in
1410 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1411 as specified by the C++ standard.
1412 If @option{-fno-for-scope} is specified, the scope of variables declared in
1413 a @i{for-init-statement} extends to the end of the enclosing scope,
1414 as was the case in old versions of G++, and other (traditional)
1415 implementations of C++.
1416
1417 The default if neither flag is given to follow the standard,
1418 but to allow and give a warning for old-style code that would
1419 otherwise be invalid, or have different behavior.
1420
1421 @item -fno-gnu-keywords
1422 @opindex fno-gnu-keywords
1423 Do not recognize @code{typeof} as a keyword, so that code can use this
1424 word as an identifier. You can use the keyword @code{__typeof__} instead.
1425 @option{-ansi} implies @option{-fno-gnu-keywords}.
1426
1427 @item -fno-implicit-templates
1428 @opindex fno-implicit-templates
1429 Never emit code for non-inline templates which are instantiated
1430 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1431 @xref{Template Instantiation}, for more information.
1432
1433 @item -fno-implicit-inline-templates
1434 @opindex fno-implicit-inline-templates
1435 Don't emit code for implicit instantiations of inline templates, either.
1436 The default is to handle inlines differently so that compiles with and
1437 without optimization will need the same set of explicit instantiations.
1438
1439 @item -fno-implement-inlines
1440 @opindex fno-implement-inlines
1441 To save space, do not emit out-of-line copies of inline functions
1442 controlled by @samp{#pragma implementation}. This will cause linker
1443 errors if these functions are not inlined everywhere they are called.
1444
1445 @item -fms-extensions
1446 @opindex fms-extensions
1447 Disable pedantic warnings about constructs used in MFC, such as implicit
1448 int and getting a pointer to member function via non-standard syntax.
1449
1450 @item -fno-nonansi-builtins
1451 @opindex fno-nonansi-builtins
1452 Disable built-in declarations of functions that are not mandated by
1453 ANSI/ISO C@. These include @code{ffs}, @code{alloca}, @code{_exit},
1454 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1455
1456 @item -fno-operator-names
1457 @opindex fno-operator-names
1458 Do not treat the operator name keywords @code{and}, @code{bitand},
1459 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1460 synonyms as keywords.
1461
1462 @item -fno-optional-diags
1463 @opindex fno-optional-diags
1464 Disable diagnostics that the standard says a compiler does not need to
1465 issue. Currently, the only such diagnostic issued by G++ is the one for
1466 a name having multiple meanings within a class.
1467
1468 @item -fpermissive
1469 @opindex fpermissive
1470 Downgrade some diagnostics about nonconformant code from errors to
1471 warnings. Thus, using @option{-fpermissive} will allow some
1472 nonconforming code to compile.
1473
1474 @item -frepo
1475 @opindex frepo
1476 Enable automatic template instantiation at link time. This option also
1477 implies @option{-fno-implicit-templates}. @xref{Template
1478 Instantiation}, for more information.
1479
1480 @item -fno-rtti
1481 @opindex fno-rtti
1482 Disable generation of information about every class with virtual
1483 functions for use by the C++ runtime type identification features
1484 (@samp{dynamic_cast} and @samp{typeid}). If you don't use those parts
1485 of the language, you can save some space by using this flag. Note that
1486 exception handling uses the same information, but it will generate it as
1487 needed.
1488
1489 @item -fstats
1490 @opindex fstats
1491 Emit statistics about front-end processing at the end of the compilation.
1492 This information is generally only useful to the G++ development team.
1493
1494 @item -ftemplate-depth-@var{n}
1495 @opindex ftemplate-depth
1496 Set the maximum instantiation depth for template classes to @var{n}.
1497 A limit on the template instantiation depth is needed to detect
1498 endless recursions during template class instantiation. ANSI/ISO C++
1499 conforming programs must not rely on a maximum depth greater than 17.
1500
1501 @item -fno-threadsafe-statics
1502 @opindex fno-threadsafe-statics
1503 Do not emit the extra code to use the routines specified in the C++
1504 ABI for thread-safe initialization of local statics. You can use this
1505 option to reduce code size slightly in code that doesn't need to be
1506 thread-safe.
1507
1508 @item -fuse-cxa-atexit
1509 @opindex fuse-cxa-atexit
1510 Register destructors for objects with static storage duration with the
1511 @code{__cxa_atexit} function rather than the @code{atexit} function.
1512 This option is required for fully standards-compliant handling of static
1513 destructors, but will only work if your C library supports
1514 @code{__cxa_atexit}.
1515
1516 @item -fvisibility-inlines-hidden
1517 @opindex fvisibility-inlines-hidden
1518 Causes all inlined methods to be marked with
1519 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1520 appear in the export table of a DSO and do not require a PLT indirection
1521 when used within the DSO@. Enabling this option can have a dramatic effect
1522 on load and link times of a DSO as it massively reduces the size of the
1523 dynamic export table when the library makes heavy use of templates. While
1524 it can cause bloating through duplication of code within each DSO where
1525 it is used, often the wastage is less than the considerable space occupied
1526 by a long symbol name in the export table which is typical when using
1527 templates and namespaces. For even more savings, combine with the
1528 @option{-fvisibility=hidden} switch.
1529
1530 @item -fno-weak
1531 @opindex fno-weak
1532 Do not use weak symbol support, even if it is provided by the linker.
1533 By default, G++ will use weak symbols if they are available. This
1534 option exists only for testing, and should not be used by end-users;
1535 it will result in inferior code and has no benefits. This option may
1536 be removed in a future release of G++.
1537
1538 @item -nostdinc++
1539 @opindex nostdinc++
1540 Do not search for header files in the standard directories specific to
1541 C++, but do still search the other standard directories. (This option
1542 is used when building the C++ library.)
1543 @end table
1544
1545 In addition, these optimization, warning, and code generation options
1546 have meanings only for C++ programs:
1547
1548 @table @gcctabopt
1549 @item -fno-default-inline
1550 @opindex fno-default-inline
1551 Do not assume @samp{inline} for functions defined inside a class scope.
1552 @xref{Optimize Options,,Options That Control Optimization}. Note that these
1553 functions will have linkage like inline functions; they just won't be
1554 inlined by default.
1555
1556 @item -Wabi @r{(C++ only)}
1557 @opindex Wabi
1558 Warn when G++ generates code that is probably not compatible with the
1559 vendor-neutral C++ ABI@. Although an effort has been made to warn about
1560 all such cases, there are probably some cases that are not warned about,
1561 even though G++ is generating incompatible code. There may also be
1562 cases where warnings are emitted even though the code that is generated
1563 will be compatible.
1564
1565 You should rewrite your code to avoid these warnings if you are
1566 concerned about the fact that code generated by G++ may not be binary
1567 compatible with code generated by other compilers.
1568
1569 The known incompatibilities at this point include:
1570
1571 @itemize @bullet
1572
1573 @item
1574 Incorrect handling of tail-padding for bit-fields. G++ may attempt to
1575 pack data into the same byte as a base class. For example:
1576
1577 @smallexample
1578 struct A @{ virtual void f(); int f1 : 1; @};
1579 struct B : public A @{ int f2 : 1; @};
1580 @end smallexample
1581
1582 @noindent
1583 In this case, G++ will place @code{B::f2} into the same byte
1584 as@code{A::f1}; other compilers will not. You can avoid this problem
1585 by explicitly padding @code{A} so that its size is a multiple of the
1586 byte size on your platform; that will cause G++ and other compilers to
1587 layout @code{B} identically.
1588
1589 @item
1590 Incorrect handling of tail-padding for virtual bases. G++ does not use
1591 tail padding when laying out virtual bases. For example:
1592
1593 @smallexample
1594 struct A @{ virtual void f(); char c1; @};
1595 struct B @{ B(); char c2; @};
1596 struct C : public A, public virtual B @{@};
1597 @end smallexample
1598
1599 @noindent
1600 In this case, G++ will not place @code{B} into the tail-padding for
1601 @code{A}; other compilers will. You can avoid this problem by
1602 explicitly padding @code{A} so that its size is a multiple of its
1603 alignment (ignoring virtual base classes); that will cause G++ and other
1604 compilers to layout @code{C} identically.
1605
1606 @item
1607 Incorrect handling of bit-fields with declared widths greater than that
1608 of their underlying types, when the bit-fields appear in a union. For
1609 example:
1610
1611 @smallexample
1612 union U @{ int i : 4096; @};
1613 @end smallexample
1614
1615 @noindent
1616 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1617 union too small by the number of bits in an @code{int}.
1618
1619 @item
1620 Empty classes can be placed at incorrect offsets. For example:
1621
1622 @smallexample
1623 struct A @{@};
1624
1625 struct B @{
1626 A a;
1627 virtual void f ();
1628 @};
1629
1630 struct C : public B, public A @{@};
1631 @end smallexample
1632
1633 @noindent
1634 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1635 it should be placed at offset zero. G++ mistakenly believes that the
1636 @code{A} data member of @code{B} is already at offset zero.
1637
1638 @item
1639 Names of template functions whose types involve @code{typename} or
1640 template template parameters can be mangled incorrectly.
1641
1642 @smallexample
1643 template <typename Q>
1644 void f(typename Q::X) @{@}
1645
1646 template <template <typename> class Q>
1647 void f(typename Q<int>::X) @{@}
1648 @end smallexample
1649
1650 @noindent
1651 Instantiations of these templates may be mangled incorrectly.
1652
1653 @end itemize
1654
1655 @item -Wctor-dtor-privacy @r{(C++ only)}
1656 @opindex Wctor-dtor-privacy
1657 Warn when a class seems unusable because all the constructors or
1658 destructors in that class are private, and it has neither friends nor
1659 public static member functions.
1660
1661 @item -Wnon-virtual-dtor @r{(C++ only)}
1662 @opindex Wnon-virtual-dtor
1663 Warn when a class appears to be polymorphic, thereby requiring a virtual
1664 destructor, yet it declares a non-virtual one.
1665 This warning is enabled by @option{-Wall}.
1666
1667 @item -Wreorder @r{(C++ only)}
1668 @opindex Wreorder
1669 @cindex reordering, warning
1670 @cindex warning for reordering of member initializers
1671 Warn when the order of member initializers given in the code does not
1672 match the order in which they must be executed. For instance:
1673
1674 @smallexample
1675 struct A @{
1676 int i;
1677 int j;
1678 A(): j (0), i (1) @{ @}
1679 @};
1680 @end smallexample
1681
1682 The compiler will rearrange the member initializers for @samp{i}
1683 and @samp{j} to match the declaration order of the members, emitting
1684 a warning to that effect. This warning is enabled by @option{-Wall}.
1685 @end table
1686
1687 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1688
1689 @table @gcctabopt
1690 @item -Weffc++ @r{(C++ only)}
1691 @opindex Weffc++
1692 Warn about violations of the following style guidelines from Scott Meyers'
1693 @cite{Effective C++} book:
1694
1695 @itemize @bullet
1696 @item
1697 Item 11: Define a copy constructor and an assignment operator for classes
1698 with dynamically allocated memory.
1699
1700 @item
1701 Item 12: Prefer initialization to assignment in constructors.
1702
1703 @item
1704 Item 14: Make destructors virtual in base classes.
1705
1706 @item
1707 Item 15: Have @code{operator=} return a reference to @code{*this}.
1708
1709 @item
1710 Item 23: Don't try to return a reference when you must return an object.
1711
1712 @end itemize
1713
1714 Also warn about violations of the following style guidelines from
1715 Scott Meyers' @cite{More Effective C++} book:
1716
1717 @itemize @bullet
1718 @item
1719 Item 6: Distinguish between prefix and postfix forms of increment and
1720 decrement operators.
1721
1722 @item
1723 Item 7: Never overload @code{&&}, @code{||}, or @code{,}.
1724
1725 @end itemize
1726
1727 When selecting this option, be aware that the standard library
1728 headers do not obey all of these guidelines; use @samp{grep -v}
1729 to filter out those warnings.
1730
1731 @item -Wno-deprecated @r{(C++ only)}
1732 @opindex Wno-deprecated
1733 Do not warn about usage of deprecated features. @xref{Deprecated Features}.
1734
1735 @item -Wno-non-template-friend @r{(C++ only)}
1736 @opindex Wno-non-template-friend
1737 Disable warnings when non-templatized friend functions are declared
1738 within a template. Since the advent of explicit template specification
1739 support in G++, if the name of the friend is an unqualified-id (i.e.,
1740 @samp{friend foo(int)}), the C++ language specification demands that the
1741 friend declare or define an ordinary, nontemplate function. (Section
1742 14.5.3). Before G++ implemented explicit specification, unqualified-ids
1743 could be interpreted as a particular specialization of a templatized
1744 function. Because this non-conforming behavior is no longer the default
1745 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1746 check existing code for potential trouble spots and is on by default.
1747 This new compiler behavior can be turned off with
1748 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1749 but disables the helpful warning.
1750
1751 @item -Wold-style-cast @r{(C++ only)}
1752 @opindex Wold-style-cast
1753 Warn if an old-style (C-style) cast to a non-void type is used within
1754 a C++ program. The new-style casts (@samp{static_cast},
1755 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1756 unintended effects and much easier to search for.
1757
1758 @item -Woverloaded-virtual @r{(C++ only)}
1759 @opindex Woverloaded-virtual
1760 @cindex overloaded virtual fn, warning
1761 @cindex warning for overloaded virtual fn
1762 Warn when a function declaration hides virtual functions from a
1763 base class. For example, in:
1764
1765 @smallexample
1766 struct A @{
1767 virtual void f();
1768 @};
1769
1770 struct B: public A @{
1771 void f(int);
1772 @};
1773 @end smallexample
1774
1775 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1776 like:
1777
1778 @smallexample
1779 B* b;
1780 b->f();
1781 @end smallexample
1782
1783 will fail to compile.
1784
1785 @item -Wno-pmf-conversions @r{(C++ only)}
1786 @opindex Wno-pmf-conversions
1787 Disable the diagnostic for converting a bound pointer to member function
1788 to a plain pointer.
1789
1790 @item -Wsign-promo @r{(C++ only)}
1791 @opindex Wsign-promo
1792 Warn when overload resolution chooses a promotion from unsigned or
1793 enumerated type to a signed type, over a conversion to an unsigned type of
1794 the same size. Previous versions of G++ would try to preserve
1795 unsignedness, but the standard mandates the current behavior.
1796
1797 @item -Wsynth @r{(C++ only)}
1798 @opindex Wsynth
1799 @cindex warning for synthesized methods
1800 @cindex synthesized methods, warning
1801 Warn when G++'s synthesis behavior does not match that of cfront. For
1802 instance:
1803
1804 @smallexample
1805 struct A @{
1806 operator int ();
1807 A& operator = (int);
1808 @};
1809
1810 main ()
1811 @{
1812 A a,b;
1813 a = b;
1814 @}
1815 @end smallexample
1816
1817 In this example, G++ will synthesize a default @samp{A& operator =
1818 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1819 @end table
1820
1821 @node Objective-C and Objective-C++ Dialect Options
1822 @section Options Controlling Objective-C and Objective-C++ Dialects
1823
1824 @cindex compiler options, Objective-C and Objective-C++
1825 @cindex Objective-C and Objective-C++ options, command line
1826 @cindex options, Objective-C and Objective-C++
1827 (NOTE: This manual does not describe the Objective-C and Objective-C++
1828 languages themselves. See @xref{Standards,,Language Standards
1829 Supported by GCC}, for references.)
1830
1831 This section describes the command-line options that are only meaningful
1832 for Objective-C and Objective-C++ programs, but you can also use most of
1833 the language-independent GNU compiler options.
1834 For example, you might compile a file @code{some_class.m} like this:
1835
1836 @smallexample
1837 gcc -g -fgnu-runtime -O -c some_class.m
1838 @end smallexample
1839
1840 @noindent
1841 In this example, @option{-fgnu-runtime} is an option meant only for
1842 Objective-C and Objective-C++ programs; you can use the other options with
1843 any language supported by GCC@.
1844
1845 Note that since Objective-C is an extension of the C language, Objective-C
1846 compilations may also use options specific to the C front-end (e.g.,
1847 @option{-Wtraditional}). Similarly, Objective-C++ compilations may use
1848 C++-specific options (e.g., @option{-Wabi}).
1849
1850 Here is a list of options that are @emph{only} for compiling Objective-C
1851 and Objective-C++ programs:
1852
1853 @table @gcctabopt
1854 @item -fconstant-string-class=@var{class-name}
1855 @opindex fconstant-string-class
1856 Use @var{class-name} as the name of the class to instantiate for each
1857 literal string specified with the syntax @code{@@"@dots{}"}. The default
1858 class name is @code{NXConstantString} if the GNU runtime is being used, and
1859 @code{NSConstantString} if the NeXT runtime is being used (see below). The
1860 @option{-fconstant-cfstrings} option, if also present, will override the
1861 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1862 to be laid out as constant CoreFoundation strings.
1863
1864 @item -fgnu-runtime
1865 @opindex fgnu-runtime
1866 Generate object code compatible with the standard GNU Objective-C
1867 runtime. This is the default for most types of systems.
1868
1869 @item -fnext-runtime
1870 @opindex fnext-runtime
1871 Generate output compatible with the NeXT runtime. This is the default
1872 for NeXT-based systems, including Darwin and Mac OS X@. The macro
1873 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1874 used.
1875
1876 @item -fno-nil-receivers
1877 @opindex fno-nil-receivers
1878 Assume that all Objective-C message dispatches (e.g.,
1879 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1880 is not @code{nil}. This allows for more efficient entry points in the runtime
1881 to be used. Currently, this option is only available in conjunction with
1882 the NeXT runtime on Mac OS X 10.3 and later.
1883
1884 @item -fobjc-exceptions
1885 @opindex fobjc-exceptions
1886 Enable syntactic support for structured exception handling in Objective-C,
1887 similar to what is offered by C++ and Java. Currently, this option is only
1888 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1889
1890 @smallexample
1891 @@try @{
1892 @dots{}
1893 @@throw expr;
1894 @dots{}
1895 @}
1896 @@catch (AnObjCClass *exc) @{
1897 @dots{}
1898 @@throw expr;
1899 @dots{}
1900 @@throw;
1901 @dots{}
1902 @}
1903 @@catch (AnotherClass *exc) @{
1904 @dots{}
1905 @}
1906 @@catch (id allOthers) @{
1907 @dots{}
1908 @}
1909 @@finally @{
1910 @dots{}
1911 @@throw expr;
1912 @dots{}
1913 @}
1914 @end smallexample
1915
1916 The @code{@@throw} statement may appear anywhere in an Objective-C or
1917 Objective-C++ program; when used inside of a @code{@@catch} block, the
1918 @code{@@throw} may appear without an argument (as shown above), in which case
1919 the object caught by the @code{@@catch} will be rethrown.
1920
1921 Note that only (pointers to) Objective-C objects may be thrown and
1922 caught using this scheme. When an object is thrown, it will be caught
1923 by the nearest @code{@@catch} clause capable of handling objects of that type,
1924 analogously to how @code{catch} blocks work in C++ and Java. A
1925 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1926 any and all Objective-C exceptions not caught by previous @code{@@catch}
1927 clauses (if any).
1928
1929 The @code{@@finally} clause, if present, will be executed upon exit from the
1930 immediately preceding @code{@@try @dots{} @@catch} section. This will happen
1931 regardless of whether any exceptions are thrown, caught or rethrown
1932 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1933 of the @code{finally} clause in Java.
1934
1935 There are several caveats to using the new exception mechanism:
1936
1937 @itemize @bullet
1938 @item
1939 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1940 idioms provided by the @code{NSException} class, the new
1941 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1942 systems, due to additional functionality needed in the (NeXT) Objective-C
1943 runtime.
1944
1945 @item
1946 As mentioned above, the new exceptions do not support handling
1947 types other than Objective-C objects. Furthermore, when used from
1948 Objective-C++, the Objective-C exception model does not interoperate with C++
1949 exceptions at this time. This means you cannot @code{@@throw} an exception
1950 from Objective-C and @code{catch} it in C++, or vice versa
1951 (i.e., @code{throw @dots{} @@catch}).
1952 @end itemize
1953
1954 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1955 blocks for thread-safe execution:
1956
1957 @smallexample
1958 @@synchronized (ObjCClass *guard) @{
1959 @dots{}
1960 @}
1961 @end smallexample
1962
1963 Upon entering the @code{@@synchronized} block, a thread of execution shall
1964 first check whether a lock has been placed on the corresponding @code{guard}
1965 object by another thread. If it has, the current thread shall wait until
1966 the other thread relinquishes its lock. Once @code{guard} becomes available,
1967 the current thread will place its own lock on it, execute the code contained in
1968 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1969 making @code{guard} available to other threads).
1970
1971 Unlike Java, Objective-C does not allow for entire methods to be marked
1972 @code{@@synchronized}. Note that throwing exceptions out of
1973 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1974 to be unlocked properly.
1975
1976 @item -freplace-objc-classes
1977 @opindex freplace-objc-classes
1978 Emit a special marker instructing @command{ld(1)} not to statically link in
1979 the resulting object file, and allow @command{dyld(1)} to load it in at
1980 run time instead. This is used in conjunction with the Fix-and-Continue
1981 debugging mode, where the object file in question may be recompiled and
1982 dynamically reloaded in the course of program execution, without the need
1983 to restart the program itself. Currently, Fix-and-Continue functionality
1984 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1985 and later.
1986
1987 @item -fzero-link
1988 @opindex fzero-link
1989 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1990 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1991 compile time) with static class references that get initialized at load time,
1992 which improves run-time performance. Specifying the @option{-fzero-link} flag
1993 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1994 to be retained. This is useful in Zero-Link debugging mode, since it allows
1995 for individual class implementations to be modified during program execution.
1996
1997 @item -gen-decls
1998 @opindex gen-decls
1999 Dump interface declarations for all classes seen in the source file to a
2000 file named @file{@var{sourcename}.decl}.
2001
2002 @item -Wno-protocol
2003 @opindex Wno-protocol
2004 If a class is declared to implement a protocol, a warning is issued for
2005 every method in the protocol that is not implemented by the class. The
2006 default behavior is to issue a warning for every method not explicitly
2007 implemented in the class, even if a method implementation is inherited
2008 from the superclass. If you use the @option{-Wno-protocol} option, then
2009 methods inherited from the superclass are considered to be implemented,
2010 and no warning is issued for them.
2011
2012 @item -Wselector
2013 @opindex Wselector
2014 Warn if multiple methods of different types for the same selector are
2015 found during compilation. The check is performed on the list of methods
2016 in the final stage of compilation. Additionally, a check is performed
2017 for each selector appearing in a @code{@@selector(@dots{})}
2018 expression, and a corresponding method for that selector has been found
2019 during compilation. Because these checks scan the method table only at
2020 the end of compilation, these warnings are not produced if the final
2021 stage of compilation is not reached, for example because an error is
2022 found during compilation, or because the @option{-fsyntax-only} option is
2023 being used.
2024
2025 @item -Wundeclared-selector
2026 @opindex Wundeclared-selector
2027 Warn if a @code{@@selector(@dots{})} expression referring to an
2028 undeclared selector is found. A selector is considered undeclared if no
2029 method with that name has been declared before the
2030 @code{@@selector(@dots{})} expression, either explicitly in an
2031 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2032 an @code{@@implementation} section. This option always performs its
2033 checks as soon as a @code{@@selector(@dots{})} expression is found,
2034 while @option{-Wselector} only performs its checks in the final stage of
2035 compilation. This also enforces the coding style convention
2036 that methods and selectors must be declared before being used.
2037
2038 @item -print-objc-runtime-info
2039 @opindex print-objc-runtime-info
2040 Generate C header describing the largest structure that is passed by
2041 value, if any.
2042
2043 @end table
2044
2045 @node Language Independent Options
2046 @section Options to Control Diagnostic Messages Formatting
2047 @cindex options to control diagnostics formatting
2048 @cindex diagnostic messages
2049 @cindex message formatting
2050
2051 Traditionally, diagnostic messages have been formatted irrespective of
2052 the output device's aspect (e.g.@: its width, @dots{}). The options described
2053 below can be used to control the diagnostic messages formatting
2054 algorithm, e.g.@: how many characters per line, how often source location
2055 information should be reported. Right now, only the C++ front end can
2056 honor these options. However it is expected, in the near future, that
2057 the remaining front ends would be able to digest them correctly.
2058
2059 @table @gcctabopt
2060 @item -fmessage-length=@var{n}
2061 @opindex fmessage-length
2062 Try to format error messages so that they fit on lines of about @var{n}
2063 characters. The default is 72 characters for @command{g++} and 0 for the rest of
2064 the front ends supported by GCC@. If @var{n} is zero, then no
2065 line-wrapping will be done; each error message will appear on a single
2066 line.
2067
2068 @opindex fdiagnostics-show-location
2069 @item -fdiagnostics-show-location=once
2070 Only meaningful in line-wrapping mode. Instructs the diagnostic messages
2071 reporter to emit @emph{once} source location information; that is, in
2072 case the message is too long to fit on a single physical line and has to
2073 be wrapped, the source location won't be emitted (as prefix) again,
2074 over and over, in subsequent continuation lines. This is the default
2075 behavior.
2076
2077 @item -fdiagnostics-show-location=every-line
2078 Only meaningful in line-wrapping mode. Instructs the diagnostic
2079 messages reporter to emit the same source location information (as
2080 prefix) for physical lines that result from the process of breaking
2081 a message which is too long to fit on a single line.
2082
2083 @end table
2084
2085 @node Warning Options
2086 @section Options to Request or Suppress Warnings
2087 @cindex options to control warnings
2088 @cindex warning messages
2089 @cindex messages, warning
2090 @cindex suppressing warnings
2091
2092 Warnings are diagnostic messages that report constructions which
2093 are not inherently erroneous but which are risky or suggest there
2094 may have been an error.
2095
2096 You can request many specific warnings with options beginning @samp{-W},
2097 for example @option{-Wimplicit} to request warnings on implicit
2098 declarations. Each of these specific warning options also has a
2099 negative form beginning @samp{-Wno-} to turn off warnings;
2100 for example, @option{-Wno-implicit}. This manual lists only one of the
2101 two forms, whichever is not the default.
2102
2103 The following options control the amount and kinds of warnings produced
2104 by GCC; for further, language-specific options also refer to
2105 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2106 Options}.
2107
2108 @table @gcctabopt
2109 @cindex syntax checking
2110 @item -fsyntax-only
2111 @opindex fsyntax-only
2112 Check the code for syntax errors, but don't do anything beyond that.
2113
2114 @item -pedantic
2115 @opindex pedantic
2116 Issue all the warnings demanded by strict ISO C and ISO C++;
2117 reject all programs that use forbidden extensions, and some other
2118 programs that do not follow ISO C and ISO C++. For ISO C, follows the
2119 version of the ISO C standard specified by any @option{-std} option used.
2120
2121 Valid ISO C and ISO C++ programs should compile properly with or without
2122 this option (though a rare few will require @option{-ansi} or a
2123 @option{-std} option specifying the required version of ISO C)@. However,
2124 without this option, certain GNU extensions and traditional C and C++
2125 features are supported as well. With this option, they are rejected.
2126
2127 @option{-pedantic} does not cause warning messages for use of the
2128 alternate keywords whose names begin and end with @samp{__}. Pedantic
2129 warnings are also disabled in the expression that follows
2130 @code{__extension__}. However, only system header files should use
2131 these escape routes; application programs should avoid them.
2132 @xref{Alternate Keywords}.
2133
2134 Some users try to use @option{-pedantic} to check programs for strict ISO
2135 C conformance. They soon find that it does not do quite what they want:
2136 it finds some non-ISO practices, but not all---only those for which
2137 ISO C @emph{requires} a diagnostic, and some others for which
2138 diagnostics have been added.
2139
2140 A feature to report any failure to conform to ISO C might be useful in
2141 some instances, but would require considerable additional work and would
2142 be quite different from @option{-pedantic}. We don't have plans to
2143 support such a feature in the near future.
2144
2145 Where the standard specified with @option{-std} represents a GNU
2146 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2147 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2148 extended dialect is based. Warnings from @option{-pedantic} are given
2149 where they are required by the base standard. (It would not make sense
2150 for such warnings to be given only for features not in the specified GNU
2151 C dialect, since by definition the GNU dialects of C include all
2152 features the compiler supports with the given option, and there would be
2153 nothing to warn about.)
2154
2155 @item -pedantic-errors
2156 @opindex pedantic-errors
2157 Like @option{-pedantic}, except that errors are produced rather than
2158 warnings.
2159
2160 @item -w
2161 @opindex w
2162 Inhibit all warning messages.
2163
2164 @item -Wno-import
2165 @opindex Wno-import
2166 Inhibit warning messages about the use of @samp{#import}.
2167
2168 @item -Wchar-subscripts
2169 @opindex Wchar-subscripts
2170 Warn if an array subscript has type @code{char}. This is a common cause
2171 of error, as programmers often forget that this type is signed on some
2172 machines.
2173 This warning is enabled by @option{-Wall}.
2174
2175 @item -Wcomment
2176 @opindex Wcomment
2177 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2178 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2179 This warning is enabled by @option{-Wall}.
2180
2181 @item -Wfatal-errors
2182 @opindex Wfatal-errors
2183 This option causes the compiler to abort compilation on the first error
2184 occurred rather than trying to keep going and printing further error
2185 messages.
2186
2187 @item -Wformat
2188 @opindex Wformat
2189 @opindex ffreestanding
2190 @opindex fno-builtin
2191 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2192 the arguments supplied have types appropriate to the format string
2193 specified, and that the conversions specified in the format string make
2194 sense. This includes standard functions, and others specified by format
2195 attributes (@pxref{Function Attributes}), in the @code{printf},
2196 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2197 not in the C standard) families (or other target-specific families).
2198 Which functions are checked without format attributes having been
2199 specified depends on the standard version selected, and such checks of
2200 functions without the attribute specified are disabled by
2201 @option{-ffreestanding} or @option{-fno-builtin}.
2202
2203 The formats are checked against the format features supported by GNU
2204 libc version 2.2. These include all ISO C90 and C99 features, as well
2205 as features from the Single Unix Specification and some BSD and GNU
2206 extensions. Other library implementations may not support all these
2207 features; GCC does not support warning about features that go beyond a
2208 particular library's limitations. However, if @option{-pedantic} is used
2209 with @option{-Wformat}, warnings will be given about format features not
2210 in the selected standard version (but not for @code{strfmon} formats,
2211 since those are not in any version of the C standard). @xref{C Dialect
2212 Options,,Options Controlling C Dialect}.
2213
2214 Since @option{-Wformat} also checks for null format arguments for
2215 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2216
2217 @option{-Wformat} is included in @option{-Wall}. For more control over some
2218 aspects of format checking, the options @option{-Wformat-y2k},
2219 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2220 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2221 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2222
2223 @item -Wformat-y2k
2224 @opindex Wformat-y2k
2225 If @option{-Wformat} is specified, also warn about @code{strftime}
2226 formats which may yield only a two-digit year.
2227
2228 @item -Wno-format-extra-args
2229 @opindex Wno-format-extra-args
2230 If @option{-Wformat} is specified, do not warn about excess arguments to a
2231 @code{printf} or @code{scanf} format function. The C standard specifies
2232 that such arguments are ignored.
2233
2234 Where the unused arguments lie between used arguments that are
2235 specified with @samp{$} operand number specifications, normally
2236 warnings are still given, since the implementation could not know what
2237 type to pass to @code{va_arg} to skip the unused arguments. However,
2238 in the case of @code{scanf} formats, this option will suppress the
2239 warning if the unused arguments are all pointers, since the Single
2240 Unix Specification says that such unused arguments are allowed.
2241
2242 @item -Wno-format-zero-length
2243 @opindex Wno-format-zero-length
2244 If @option{-Wformat} is specified, do not warn about zero-length formats.
2245 The C standard specifies that zero-length formats are allowed.
2246
2247 @item -Wformat-nonliteral
2248 @opindex Wformat-nonliteral
2249 If @option{-Wformat} is specified, also warn if the format string is not a
2250 string literal and so cannot be checked, unless the format function
2251 takes its format arguments as a @code{va_list}.
2252
2253 @item -Wformat-security
2254 @opindex Wformat-security
2255 If @option{-Wformat} is specified, also warn about uses of format
2256 functions that represent possible security problems. At present, this
2257 warns about calls to @code{printf} and @code{scanf} functions where the
2258 format string is not a string literal and there are no format arguments,
2259 as in @code{printf (foo);}. This may be a security hole if the format
2260 string came from untrusted input and contains @samp{%n}. (This is
2261 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2262 in future warnings may be added to @option{-Wformat-security} that are not
2263 included in @option{-Wformat-nonliteral}.)
2264
2265 @item -Wformat=2
2266 @opindex Wformat=2
2267 Enable @option{-Wformat} plus format checks not included in
2268 @option{-Wformat}. Currently equivalent to @samp{-Wformat
2269 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2270
2271 @item -Wnonnull
2272 @opindex Wnonnull
2273 Warn about passing a null pointer for arguments marked as
2274 requiring a non-null value by the @code{nonnull} function attribute.
2275
2276 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}. It
2277 can be disabled with the @option{-Wno-nonnull} option.
2278
2279 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2280 @opindex Winit-self
2281 Warn about uninitialized variables which are initialized with themselves.
2282 Note this option can only be used with the @option{-Wuninitialized} option,
2283 which in turn only works with @option{-O1} and above.
2284
2285 For example, GCC will warn about @code{i} being uninitialized in the
2286 following snippet only when @option{-Winit-self} has been specified:
2287 @smallexample
2288 @group
2289 int f()
2290 @{
2291 int i = i;
2292 return i;
2293 @}
2294 @end group
2295 @end smallexample
2296
2297 @item -Wimplicit-int
2298 @opindex Wimplicit-int
2299 Warn when a declaration does not specify a type.
2300 This warning is enabled by @option{-Wall}.
2301
2302 @item -Wimplicit-function-declaration
2303 @itemx -Werror-implicit-function-declaration
2304 @opindex Wimplicit-function-declaration
2305 @opindex Werror-implicit-function-declaration
2306 Give a warning (or error) whenever a function is used before being
2307 declared. The form @option{-Wno-error-implicit-function-declaration}
2308 is not supported.
2309 This warning is enabled by @option{-Wall} (as a warning, not an error).
2310
2311 @item -Wimplicit
2312 @opindex Wimplicit
2313 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2314 This warning is enabled by @option{-Wall}.
2315
2316 @item -Wmain
2317 @opindex Wmain
2318 Warn if the type of @samp{main} is suspicious. @samp{main} should be a
2319 function with external linkage, returning int, taking either zero
2320 arguments, two, or three arguments of appropriate types.
2321 This warning is enabled by @option{-Wall}.
2322
2323 @item -Wmissing-braces
2324 @opindex Wmissing-braces
2325 Warn if an aggregate or union initializer is not fully bracketed. In
2326 the following example, the initializer for @samp{a} is not fully
2327 bracketed, but that for @samp{b} is fully bracketed.
2328
2329 @smallexample
2330 int a[2][2] = @{ 0, 1, 2, 3 @};
2331 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2332 @end smallexample
2333
2334 This warning is enabled by @option{-Wall}.
2335
2336 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2337 @opindex Wmissing-include-dirs
2338 Warn if a user-supplied include directory does not exist.
2339
2340 @item -Wparentheses
2341 @opindex Wparentheses
2342 Warn if parentheses are omitted in certain contexts, such
2343 as when there is an assignment in a context where a truth value
2344 is expected, or when operators are nested whose precedence people
2345 often get confused about. Only the warning for an assignment used as
2346 a truth value is supported when compiling C++; the other warnings are
2347 only supported when compiling C@.
2348
2349 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2350 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2351 interpretation from that of ordinary mathematical notation.
2352
2353 Also warn about constructions where there may be confusion to which
2354 @code{if} statement an @code{else} branch belongs. Here is an example of
2355 such a case:
2356
2357 @smallexample
2358 @group
2359 @{
2360 if (a)
2361 if (b)
2362 foo ();
2363 else
2364 bar ();
2365 @}
2366 @end group
2367 @end smallexample
2368
2369 In C, every @code{else} branch belongs to the innermost possible @code{if}
2370 statement, which in this example is @code{if (b)}. This is often not
2371 what the programmer expected, as illustrated in the above example by
2372 indentation the programmer chose. When there is the potential for this
2373 confusion, GCC will issue a warning when this flag is specified.
2374 To eliminate the warning, add explicit braces around the innermost
2375 @code{if} statement so there is no way the @code{else} could belong to
2376 the enclosing @code{if}. The resulting code would look like this:
2377
2378 @smallexample
2379 @group
2380 @{
2381 if (a)
2382 @{
2383 if (b)
2384 foo ();
2385 else
2386 bar ();
2387 @}
2388 @}
2389 @end group
2390 @end smallexample
2391
2392 This warning is enabled by @option{-Wall}.
2393
2394 @item -Wsequence-point
2395 @opindex Wsequence-point
2396 Warn about code that may have undefined semantics because of violations
2397 of sequence point rules in the C standard.
2398
2399 The C standard defines the order in which expressions in a C program are
2400 evaluated in terms of @dfn{sequence points}, which represent a partial
2401 ordering between the execution of parts of the program: those executed
2402 before the sequence point, and those executed after it. These occur
2403 after the evaluation of a full expression (one which is not part of a
2404 larger expression), after the evaluation of the first operand of a
2405 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2406 function is called (but after the evaluation of its arguments and the
2407 expression denoting the called function), and in certain other places.
2408 Other than as expressed by the sequence point rules, the order of
2409 evaluation of subexpressions of an expression is not specified. All
2410 these rules describe only a partial order rather than a total order,
2411 since, for example, if two functions are called within one expression
2412 with no sequence point between them, the order in which the functions
2413 are called is not specified. However, the standards committee have
2414 ruled that function calls do not overlap.
2415
2416 It is not specified when between sequence points modifications to the
2417 values of objects take effect. Programs whose behavior depends on this
2418 have undefined behavior; the C standard specifies that ``Between the
2419 previous and next sequence point an object shall have its stored value
2420 modified at most once by the evaluation of an expression. Furthermore,
2421 the prior value shall be read only to determine the value to be
2422 stored.''. If a program breaks these rules, the results on any
2423 particular implementation are entirely unpredictable.
2424
2425 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2426 = b[n++]} and @code{a[i++] = i;}. Some more complicated cases are not
2427 diagnosed by this option, and it may give an occasional false positive
2428 result, but in general it has been found fairly effective at detecting
2429 this sort of problem in programs.
2430
2431 The present implementation of this option only works for C programs. A
2432 future implementation may also work for C++ programs.
2433
2434 The C standard is worded confusingly, therefore there is some debate
2435 over the precise meaning of the sequence point rules in subtle cases.
2436 Links to discussions of the problem, including proposed formal
2437 definitions, may be found on the GCC readings page, at
2438 @w{@uref{http://gcc.gnu.org/readings.html}}.
2439
2440 This warning is enabled by @option{-Wall}.
2441
2442 @item -Wreturn-type
2443 @opindex Wreturn-type
2444 Warn whenever a function is defined with a return-type that defaults to
2445 @code{int}. Also warn about any @code{return} statement with no
2446 return-value in a function whose return-type is not @code{void}.
2447
2448 For C, also warn if the return type of a function has a type qualifier
2449 such as @code{const}. Such a type qualifier has no effect, since the
2450 value returned by a function is not an lvalue. ISO C prohibits
2451 qualified @code{void} return types on function definitions, so such
2452 return types always receive a warning even without this option.
2453
2454 For C++, a function without return type always produces a diagnostic
2455 message, even when @option{-Wno-return-type} is specified. The only
2456 exceptions are @samp{main} and functions defined in system headers.
2457
2458 This warning is enabled by @option{-Wall}.
2459
2460 @item -Wswitch
2461 @opindex Wswitch
2462 Warn whenever a @code{switch} statement has an index of enumerated type
2463 and lacks a @code{case} for one or more of the named codes of that
2464 enumeration. (The presence of a @code{default} label prevents this
2465 warning.) @code{case} labels outside the enumeration range also
2466 provoke warnings when this option is used.
2467 This warning is enabled by @option{-Wall}.
2468
2469 @item -Wswitch-default
2470 @opindex Wswitch-switch
2471 Warn whenever a @code{switch} statement does not have a @code{default}
2472 case.
2473
2474 @item -Wswitch-enum
2475 @opindex Wswitch-enum
2476 Warn whenever a @code{switch} statement has an index of enumerated type
2477 and lacks a @code{case} for one or more of the named codes of that
2478 enumeration. @code{case} labels outside the enumeration range also
2479 provoke warnings when this option is used.
2480
2481 @item -Wtrigraphs
2482 @opindex Wtrigraphs
2483 Warn if any trigraphs are encountered that might change the meaning of
2484 the program (trigraphs within comments are not warned about).
2485 This warning is enabled by @option{-Wall}.
2486
2487 @item -Wunused-function
2488 @opindex Wunused-function
2489 Warn whenever a static function is declared but not defined or a
2490 non\-inline static function is unused.
2491 This warning is enabled by @option{-Wall}.
2492
2493 @item -Wunused-label
2494 @opindex Wunused-label
2495 Warn whenever a label is declared but not used.
2496 This warning is enabled by @option{-Wall}.
2497
2498 To suppress this warning use the @samp{unused} attribute
2499 (@pxref{Variable Attributes}).
2500
2501 @item -Wunused-parameter
2502 @opindex Wunused-parameter
2503 Warn whenever a function parameter is unused aside from its declaration.
2504
2505 To suppress this warning use the @samp{unused} attribute
2506 (@pxref{Variable Attributes}).
2507
2508 @item -Wunused-variable
2509 @opindex Wunused-variable
2510 Warn whenever a local variable or non-constant static variable is unused
2511 aside from its declaration
2512 This warning is enabled by @option{-Wall}.
2513
2514 To suppress this warning use the @samp{unused} attribute
2515 (@pxref{Variable Attributes}).
2516
2517 @item -Wunused-value
2518 @opindex Wunused-value
2519 Warn whenever a statement computes a result that is explicitly not used.
2520 This warning is enabled by @option{-Wall}.
2521
2522 To suppress this warning cast the expression to @samp{void}.
2523
2524 @item -Wunused
2525 @opindex Wunused
2526 All the above @option{-Wunused} options combined.
2527
2528 In order to get a warning about an unused function parameter, you must
2529 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2530 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2531
2532 @item -Wuninitialized
2533 @opindex Wuninitialized
2534 Warn if an automatic variable is used without first being initialized or
2535 if a variable may be clobbered by a @code{setjmp} call.
2536
2537 These warnings are possible only in optimizing compilation,
2538 because they require data flow information that is computed only
2539 when optimizing. If you don't specify @option{-O}, you simply won't
2540 get these warnings.
2541
2542 If you want to warn about code which uses the uninitialized value of the
2543 variable in its own initializer, use the @option{-Winit-self} option.
2544
2545 These warnings occur only for variables that are candidates for
2546 register allocation. Therefore, they do not occur for a variable that
2547 is declared @code{volatile}, or whose address is taken, or whose size
2548 is other than 1, 2, 4 or 8 bytes. Also, they do not occur for
2549 structures, unions or arrays, even when they are in registers.
2550
2551 Note that there may be no warning about a variable that is used only
2552 to compute a value that itself is never used, because such
2553 computations may be deleted by data flow analysis before the warnings
2554 are printed.
2555
2556 These warnings are made optional because GCC is not smart
2557 enough to see all the reasons why the code might be correct
2558 despite appearing to have an error. Here is one example of how
2559 this can happen:
2560
2561 @smallexample
2562 @group
2563 @{
2564 int x;
2565 switch (y)
2566 @{
2567 case 1: x = 1;
2568 break;
2569 case 2: x = 4;
2570 break;
2571 case 3: x = 5;
2572 @}
2573 foo (x);
2574 @}
2575 @end group
2576 @end smallexample
2577
2578 @noindent
2579 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2580 always initialized, but GCC doesn't know this. Here is
2581 another common case:
2582
2583 @smallexample
2584 @{
2585 int save_y;
2586 if (change_y) save_y = y, y = new_y;
2587 @dots{}
2588 if (change_y) y = save_y;
2589 @}
2590 @end smallexample
2591
2592 @noindent
2593 This has no bug because @code{save_y} is used only if it is set.
2594
2595 @cindex @code{longjmp} warnings
2596 This option also warns when a non-volatile automatic variable might be
2597 changed by a call to @code{longjmp}. These warnings as well are possible
2598 only in optimizing compilation.
2599
2600 The compiler sees only the calls to @code{setjmp}. It cannot know
2601 where @code{longjmp} will be called; in fact, a signal handler could
2602 call it at any point in the code. As a result, you may get a warning
2603 even when there is in fact no problem because @code{longjmp} cannot
2604 in fact be called at the place which would cause a problem.
2605
2606 Some spurious warnings can be avoided if you declare all the functions
2607 you use that never return as @code{noreturn}. @xref{Function
2608 Attributes}.
2609
2610 This warning is enabled by @option{-Wall}.
2611
2612 @item -Wunknown-pragmas
2613 @opindex Wunknown-pragmas
2614 @cindex warning for unknown pragmas
2615 @cindex unknown pragmas, warning
2616 @cindex pragmas, warning of unknown
2617 Warn when a #pragma directive is encountered which is not understood by
2618 GCC@. If this command line option is used, warnings will even be issued
2619 for unknown pragmas in system header files. This is not the case if
2620 the warnings were only enabled by the @option{-Wall} command line option.
2621
2622 @item -Wstrict-aliasing
2623 @opindex Wstrict-aliasing
2624 This option is only active when @option{-fstrict-aliasing} is active.
2625 It warns about code which might break the strict aliasing rules that the
2626 compiler is using for optimization. The warning does not catch all
2627 cases, but does attempt to catch the more common pitfalls. It is
2628 included in @option{-Wall}.
2629
2630 @item -Wstrict-aliasing=2
2631 @opindex Wstrict-aliasing=2
2632 This option is only active when @option{-fstrict-aliasing} is active.
2633 It warns about all code which might break the strict aliasing rules that the
2634 compiler is using for optimization. This warning catches all cases, but
2635 it will also give a warning for some ambiguous cases that are safe.
2636
2637 @item -Wall
2638 @opindex Wall
2639 All of the above @samp{-W} options combined. This enables all the
2640 warnings about constructions that some users consider questionable, and
2641 that are easy to avoid (or modify to prevent the warning), even in
2642 conjunction with macros. This also enables some language-specific
2643 warnings described in @ref{C++ Dialect Options} and
2644 @ref{Objective-C and Objective-C++ Dialect Options}.
2645 @end table
2646
2647 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2648 Some of them warn about constructions that users generally do not
2649 consider questionable, but which occasionally you might wish to check
2650 for; others warn about constructions that are necessary or hard to avoid
2651 in some cases, and there is no simple way to modify the code to suppress
2652 the warning.
2653
2654 @table @gcctabopt
2655 @item -Wextra
2656 @opindex W
2657 @opindex Wextra
2658 (This option used to be called @option{-W}. The older name is still
2659 supported, but the newer name is more descriptive.) Print extra warning
2660 messages for these events:
2661
2662 @itemize @bullet
2663 @item
2664 A function can return either with or without a value. (Falling
2665 off the end of the function body is considered returning without
2666 a value.) For example, this function would evoke such a
2667 warning:
2668
2669 @smallexample
2670 @group
2671 foo (a)
2672 @{
2673 if (a > 0)
2674 return a;
2675 @}
2676 @end group
2677 @end smallexample
2678
2679 @item
2680 An expression-statement or the left-hand side of a comma expression
2681 contains no side effects.
2682 To suppress the warning, cast the unused expression to void.
2683 For example, an expression such as @samp{x[i,j]} will cause a warning,
2684 but @samp{x[(void)i,j]} will not.
2685
2686 @item
2687 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2688
2689 @item
2690 Storage-class specifiers like @code{static} are not the first things in
2691 a declaration. According to the C Standard, this usage is obsolescent.
2692
2693 @item
2694 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2695 arguments.
2696
2697 @item
2698 A comparison between signed and unsigned values could produce an
2699 incorrect result when the signed value is converted to unsigned.
2700 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2701
2702 @item
2703 An aggregate has an initializer which does not initialize all members.
2704 This warning can be independently controlled by
2705 @option{-Wmissing-field-initializers}.
2706
2707 @item
2708 A function parameter is declared without a type specifier in K&R-style
2709 functions:
2710
2711 @smallexample
2712 void foo(bar) @{ @}
2713 @end smallexample
2714
2715 @item
2716 An empty body occurs in an @samp{if} or @samp{else} statement.
2717
2718 @item
2719 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2720 @samp{>}, or @samp{>=}.
2721
2722 @item
2723 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2724
2725 @item
2726 Any of several floating-point events that often indicate errors, such as
2727 overflow, underflow, loss of precision, etc.
2728
2729 @item @r{(C++ only)}
2730 An enumerator and a non-enumerator both appear in a conditional expression.
2731
2732 @item @r{(C++ only)}
2733 A non-static reference or non-static @samp{const} member appears in a
2734 class without constructors.
2735
2736 @item @r{(C++ only)}
2737 Ambiguous virtual bases.
2738
2739 @item @r{(C++ only)}
2740 Subscripting an array which has been declared @samp{register}.
2741
2742 @item @r{(C++ only)}
2743 Taking the address of a variable which has been declared @samp{register}.
2744
2745 @item @r{(C++ only)}
2746 A base class is not initialized in a derived class' copy constructor.
2747 @end itemize
2748
2749 @item -Wno-div-by-zero
2750 @opindex Wno-div-by-zero
2751 @opindex Wdiv-by-zero
2752 Do not warn about compile-time integer division by zero. Floating point
2753 division by zero is not warned about, as it can be a legitimate way of
2754 obtaining infinities and NaNs.
2755
2756 @item -Wsystem-headers
2757 @opindex Wsystem-headers
2758 @cindex warnings from system headers
2759 @cindex system headers, warnings from
2760 Print warning messages for constructs found in system header files.
2761 Warnings from system headers are normally suppressed, on the assumption
2762 that they usually do not indicate real problems and would only make the
2763 compiler output harder to read. Using this command line option tells
2764 GCC to emit warnings from system headers as if they occurred in user
2765 code. However, note that using @option{-Wall} in conjunction with this
2766 option will @emph{not} warn about unknown pragmas in system
2767 headers---for that, @option{-Wunknown-pragmas} must also be used.
2768
2769 @item -Wfloat-equal
2770 @opindex Wfloat-equal
2771 Warn if floating point values are used in equality comparisons.
2772
2773 The idea behind this is that sometimes it is convenient (for the
2774 programmer) to consider floating-point values as approximations to
2775 infinitely precise real numbers. If you are doing this, then you need
2776 to compute (by analyzing the code, or in some other way) the maximum or
2777 likely maximum error that the computation introduces, and allow for it
2778 when performing comparisons (and when producing output, but that's a
2779 different problem). In particular, instead of testing for equality, you
2780 would check to see whether the two values have ranges that overlap; and
2781 this is done with the relational operators, so equality comparisons are
2782 probably mistaken.
2783
2784 @item -Wtraditional @r{(C only)}
2785 @opindex Wtraditional
2786 Warn about certain constructs that behave differently in traditional and
2787 ISO C@. Also warn about ISO C constructs that have no traditional C
2788 equivalent, and/or problematic constructs which should be avoided.
2789
2790 @itemize @bullet
2791 @item
2792 Macro parameters that appear within string literals in the macro body.
2793 In traditional C macro replacement takes place within string literals,
2794 but does not in ISO C@.
2795
2796 @item
2797 In traditional C, some preprocessor directives did not exist.
2798 Traditional preprocessors would only consider a line to be a directive
2799 if the @samp{#} appeared in column 1 on the line. Therefore
2800 @option{-Wtraditional} warns about directives that traditional C
2801 understands but would ignore because the @samp{#} does not appear as the
2802 first character on the line. It also suggests you hide directives like
2803 @samp{#pragma} not understood by traditional C by indenting them. Some
2804 traditional implementations would not recognize @samp{#elif}, so it
2805 suggests avoiding it altogether.
2806
2807 @item
2808 A function-like macro that appears without arguments.
2809
2810 @item
2811 The unary plus operator.
2812
2813 @item
2814 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2815 constant suffixes. (Traditional C does support the @samp{L} suffix on integer
2816 constants.) Note, these suffixes appear in macros defined in the system
2817 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2818 Use of these macros in user code might normally lead to spurious
2819 warnings, however GCC's integrated preprocessor has enough context to
2820 avoid warning in these cases.
2821
2822 @item
2823 A function declared external in one block and then used after the end of
2824 the block.
2825
2826 @item
2827 A @code{switch} statement has an operand of type @code{long}.
2828
2829 @item
2830 A non-@code{static} function declaration follows a @code{static} one.
2831 This construct is not accepted by some traditional C compilers.
2832
2833 @item
2834 The ISO type of an integer constant has a different width or
2835 signedness from its traditional type. This warning is only issued if
2836 the base of the constant is ten. I.e.@: hexadecimal or octal values, which
2837 typically represent bit patterns, are not warned about.
2838
2839 @item
2840 Usage of ISO string concatenation is detected.
2841
2842 @item
2843 Initialization of automatic aggregates.
2844
2845 @item
2846 Identifier conflicts with labels. Traditional C lacks a separate
2847 namespace for labels.
2848
2849 @item
2850 Initialization of unions. If the initializer is zero, the warning is
2851 omitted. This is done under the assumption that the zero initializer in
2852 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2853 initializer warnings and relies on default initialization to zero in the
2854 traditional C case.
2855
2856 @item
2857 Conversions by prototypes between fixed/floating point values and vice
2858 versa. The absence of these prototypes when compiling with traditional
2859 C would cause serious problems. This is a subset of the possible
2860 conversion warnings, for the full set use @option{-Wconversion}.
2861
2862 @item
2863 Use of ISO C style function definitions. This warning intentionally is
2864 @emph{not} issued for prototype declarations or variadic functions
2865 because these ISO C features will appear in your code when using
2866 libiberty's traditional C compatibility macros, @code{PARAMS} and
2867 @code{VPARAMS}. This warning is also bypassed for nested functions
2868 because that feature is already a GCC extension and thus not relevant to
2869 traditional C compatibility.
2870 @end itemize
2871
2872 @item -Wdeclaration-after-statement @r{(C only)}
2873 @opindex Wdeclaration-after-statement
2874 Warn when a declaration is found after a statement in a block. This
2875 construct, known from C++, was introduced with ISO C99 and is by default
2876 allowed in GCC@. It is not supported by ISO C90 and was not supported by
2877 GCC versions before GCC 3.0. @xref{Mixed Declarations}.
2878
2879 @item -Wundef
2880 @opindex Wundef
2881 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2882
2883 @item -Wno-endif-labels
2884 @opindex Wno-endif-labels
2885 @opindex Wendif-labels
2886 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2887
2888 @item -Wshadow
2889 @opindex Wshadow
2890 Warn whenever a local variable shadows another local variable, parameter or
2891 global variable or whenever a built-in function is shadowed.
2892
2893 @item -Wlarger-than-@var{len}
2894 @opindex Wlarger-than
2895 Warn whenever an object of larger than @var{len} bytes is defined.
2896
2897 @item -Wpointer-arith
2898 @opindex Wpointer-arith
2899 Warn about anything that depends on the ``size of'' a function type or
2900 of @code{void}. GNU C assigns these types a size of 1, for
2901 convenience in calculations with @code{void *} pointers and pointers
2902 to functions.
2903
2904 @item -Wbad-function-cast @r{(C only)}
2905 @opindex Wbad-function-cast
2906 Warn whenever a function call is cast to a non-matching type.
2907 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2908
2909 @item -Wcast-qual
2910 @opindex Wcast-qual
2911 Warn whenever a pointer is cast so as to remove a type qualifier from
2912 the target type. For example, warn if a @code{const char *} is cast
2913 to an ordinary @code{char *}.
2914
2915 @item -Wcast-align
2916 @opindex Wcast-align
2917 Warn whenever a pointer is cast such that the required alignment of the
2918 target is increased. For example, warn if a @code{char *} is cast to
2919 an @code{int *} on machines where integers can only be accessed at
2920 two- or four-byte boundaries.
2921
2922 @item -Wwrite-strings
2923 @opindex Wwrite-strings
2924 When compiling C, give string constants the type @code{const
2925 char[@var{length}]} so that
2926 copying the address of one into a non-@code{const} @code{char *}
2927 pointer will get a warning; when compiling C++, warn about the
2928 deprecated conversion from string constants to @code{char *}.
2929 These warnings will help you find at
2930 compile time code that can try to write into a string constant, but
2931 only if you have been very careful about using @code{const} in
2932 declarations and prototypes. Otherwise, it will just be a nuisance;
2933 this is why we did not make @option{-Wall} request these warnings.
2934
2935 @item -Wconversion
2936 @opindex Wconversion
2937 Warn if a prototype causes a type conversion that is different from what
2938 would happen to the same argument in the absence of a prototype. This
2939 includes conversions of fixed point to floating and vice versa, and
2940 conversions changing the width or signedness of a fixed point argument
2941 except when the same as the default promotion.
2942
2943 Also, warn if a negative integer constant expression is implicitly
2944 converted to an unsigned type. For example, warn about the assignment
2945 @code{x = -1} if @code{x} is unsigned. But do not warn about explicit
2946 casts like @code{(unsigned) -1}.
2947
2948 @item -Wsign-compare
2949 @opindex Wsign-compare
2950 @cindex warning for comparison of signed and unsigned values
2951 @cindex comparison of signed and unsigned values, warning
2952 @cindex signed and unsigned values, comparison warning
2953 Warn when a comparison between signed and unsigned values could produce
2954 an incorrect result when the signed value is converted to unsigned.
2955 This warning is also enabled by @option{-Wextra}; to get the other warnings
2956 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2957
2958 @item -Waggregate-return
2959 @opindex Waggregate-return
2960 Warn if any functions that return structures or unions are defined or
2961 called. (In languages where you can return an array, this also elicits
2962 a warning.)
2963
2964 @item -Wstrict-prototypes @r{(C only)}
2965 @opindex Wstrict-prototypes
2966 Warn if a function is declared or defined without specifying the
2967 argument types. (An old-style function definition is permitted without
2968 a warning if preceded by a declaration which specifies the argument
2969 types.)
2970
2971 @item -Wold-style-definition @r{(C only)}
2972 @opindex Wold-style-definition
2973 Warn if an old-style function definition is used. A warning is given
2974 even if there is a previous prototype.
2975
2976 @item -Wmissing-prototypes @r{(C only)}
2977 @opindex Wmissing-prototypes
2978 Warn if a global function is defined without a previous prototype
2979 declaration. This warning is issued even if the definition itself
2980 provides a prototype. The aim is to detect global functions that fail
2981 to be declared in header files.
2982
2983 @item -Wmissing-declarations @r{(C only)}
2984 @opindex Wmissing-declarations
2985 Warn if a global function is defined without a previous declaration.
2986 Do so even if the definition itself provides a prototype.
2987 Use this option to detect global functions that are not declared in
2988 header files.
2989
2990 @item -Wmissing-field-initializers
2991 @opindex Wmissing-field-initializers
2992 @opindex W
2993 @opindex Wextra
2994 Warn if a structure's initializer has some fields missing. For
2995 example, the following code would cause such a warning, because
2996 @code{x.h} is implicitly zero:
2997
2998 @smallexample
2999 struct s @{ int f, g, h; @};
3000 struct s x = @{ 3, 4 @};
3001 @end smallexample
3002
3003 This option does not warn about designated initializers, so the following
3004 modification would not trigger a warning:
3005
3006 @smallexample
3007 struct s @{ int f, g, h; @};
3008 struct s x = @{ .f = 3, .g = 4 @};
3009 @end smallexample
3010
3011 This warning is included in @option{-Wextra}. To get other @option{-Wextra}
3012 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3013
3014 @item -Wmissing-noreturn
3015 @opindex Wmissing-noreturn
3016 Warn about functions which might be candidates for attribute @code{noreturn}.
3017 Note these are only possible candidates, not absolute ones. Care should
3018 be taken to manually verify functions actually do not ever return before
3019 adding the @code{noreturn} attribute, otherwise subtle code generation
3020 bugs could be introduced. You will not get a warning for @code{main} in
3021 hosted C environments.
3022
3023 @item -Wmissing-format-attribute
3024 @opindex Wmissing-format-attribute
3025 @opindex Wformat
3026 If @option{-Wformat} is enabled, also warn about functions which might be
3027 candidates for @code{format} attributes. Note these are only possible
3028 candidates, not absolute ones. GCC will guess that @code{format}
3029 attributes might be appropriate for any function that calls a function
3030 like @code{vprintf} or @code{vscanf}, but this might not always be the
3031 case, and some functions for which @code{format} attributes are
3032 appropriate may not be detected. This option has no effect unless
3033 @option{-Wformat} is enabled (possibly by @option{-Wall}).
3034
3035 @item -Wno-multichar
3036 @opindex Wno-multichar
3037 @opindex Wmultichar
3038 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3039 Usually they indicate a typo in the user's code, as they have
3040 implementation-defined values, and should not be used in portable code.
3041
3042 @item -Wno-deprecated-declarations
3043 @opindex Wno-deprecated-declarations
3044 Do not warn about uses of functions, variables, and types marked as
3045 deprecated by using the @code{deprecated} attribute.
3046 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3047 @pxref{Type Attributes}.)
3048
3049 @item -Wpacked
3050 @opindex Wpacked
3051 Warn if a structure is given the packed attribute, but the packed
3052 attribute has no effect on the layout or size of the structure.
3053 Such structures may be mis-aligned for little benefit. For
3054 instance, in this code, the variable @code{f.x} in @code{struct bar}
3055 will be misaligned even though @code{struct bar} does not itself
3056 have the packed attribute:
3057
3058 @smallexample
3059 @group
3060 struct foo @{
3061 int x;
3062 char a, b, c, d;
3063 @} __attribute__((packed));
3064 struct bar @{
3065 char z;
3066 struct foo f;
3067 @};
3068 @end group
3069 @end smallexample
3070
3071 @item -Wpadded
3072 @opindex Wpadded
3073 Warn if padding is included in a structure, either to align an element
3074 of the structure or to align the whole structure. Sometimes when this
3075 happens it is possible to rearrange the fields of the structure to
3076 reduce the padding and so make the structure smaller.
3077
3078 @item -Wredundant-decls
3079 @opindex Wredundant-decls
3080 Warn if anything is declared more than once in the same scope, even in
3081 cases where multiple declaration is valid and changes nothing.
3082
3083 @item -Wnested-externs @r{(C only)}
3084 @opindex Wnested-externs
3085 Warn if an @code{extern} declaration is encountered within a function.
3086
3087 @item -Wunreachable-code
3088 @opindex Wunreachable-code
3089 Warn if the compiler detects that code will never be executed.
3090
3091 This option is intended to warn when the compiler detects that at
3092 least a whole line of source code will never be executed, because
3093 some condition is never satisfied or because it is after a
3094 procedure that never returns.
3095
3096 It is possible for this option to produce a warning even though there
3097 are circumstances under which part of the affected line can be executed,
3098 so care should be taken when removing apparently-unreachable code.
3099
3100 For instance, when a function is inlined, a warning may mean that the
3101 line is unreachable in only one inlined copy of the function.
3102
3103 This option is not made part of @option{-Wall} because in a debugging
3104 version of a program there is often substantial code which checks
3105 correct functioning of the program and is, hopefully, unreachable
3106 because the program does work. Another common use of unreachable
3107 code is to provide behavior which is selectable at compile-time.
3108
3109 @item -Winline
3110 @opindex Winline
3111 Warn if a function can not be inlined and it was declared as inline.
3112 Even with this option, the compiler will not warn about failures to
3113 inline functions declared in system headers.
3114
3115 The compiler uses a variety of heuristics to determine whether or not
3116 to inline a function. For example, the compiler takes into account
3117 the size of the function being inlined and the the amount of inlining
3118 that has already been done in the current function. Therefore,
3119 seemingly insignificant changes in the source program can cause the
3120 warnings produced by @option{-Winline} to appear or disappear.
3121
3122 @item -Wno-invalid-offsetof @r{(C++ only)}
3123 @opindex Wno-invalid-offsetof
3124 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3125 type. According to the 1998 ISO C++ standard, applying @samp{offsetof}
3126 to a non-POD type is undefined. In existing C++ implementations,
3127 however, @samp{offsetof} typically gives meaningful results even when
3128 applied to certain kinds of non-POD types. (Such as a simple
3129 @samp{struct} that fails to be a POD type only by virtue of having a
3130 constructor.) This flag is for users who are aware that they are
3131 writing nonportable code and who have deliberately chosen to ignore the
3132 warning about it.
3133
3134 The restrictions on @samp{offsetof} may be relaxed in a future version
3135 of the C++ standard.
3136
3137 @item -Winvalid-pch
3138 @opindex Winvalid-pch
3139 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3140 the search path but can't be used.
3141
3142 @item -Wlong-long
3143 @opindex Wlong-long
3144 @opindex Wno-long-long
3145 Warn if @samp{long long} type is used. This is default. To inhibit
3146 the warning messages, use @option{-Wno-long-long}. Flags
3147 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3148 only when @option{-pedantic} flag is used.
3149
3150 @item -Wvariadic-macros
3151 @opindex Wvariadic-macros
3152 @opindex Wno-variadic-macros
3153 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3154 alternate syntax when in pedantic ISO C99 mode. This is default.
3155 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3156
3157 @item -Wdisabled-optimization
3158 @opindex Wdisabled-optimization
3159 Warn if a requested optimization pass is disabled. This warning does
3160 not generally indicate that there is anything wrong with your code; it
3161 merely indicates that GCC's optimizers were unable to handle the code
3162 effectively. Often, the problem is that your code is too big or too
3163 complex; GCC will refuse to optimize programs when the optimization
3164 itself is likely to take inordinate amounts of time.
3165
3166 @item -Wno-pointer-sign
3167 @opindex Wno-pointer-sign
3168 Don't warn for pointer argument passing or assignment with different signedness.
3169 Only useful in the negative form since this warning is enabled by default.
3170 This option is only supported for C and Objective-C@.
3171
3172 @item -Werror
3173 @opindex Werror
3174 Make all warnings into errors.
3175 @end table
3176
3177 @node Debugging Options
3178 @section Options for Debugging Your Program or GCC
3179 @cindex options, debugging
3180 @cindex debugging information options
3181
3182 GCC has various special options that are used for debugging
3183 either your program or GCC:
3184
3185 @table @gcctabopt
3186 @item -g
3187 @opindex g
3188 Produce debugging information in the operating system's native format
3189 (stabs, COFF, XCOFF, or DWARF 2)@. GDB can work with this debugging
3190 information.
3191
3192 On most systems that use stabs format, @option{-g} enables use of extra
3193 debugging information that only GDB can use; this extra information
3194 makes debugging work better in GDB but will probably make other debuggers
3195 crash or
3196 refuse to read the program. If you want to control for certain whether
3197 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3198 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3199
3200 GCC allows you to use @option{-g} with
3201 @option{-O}. The shortcuts taken by optimized code may occasionally
3202 produce surprising results: some variables you declared may not exist
3203 at all; flow of control may briefly move where you did not expect it;
3204 some statements may not be executed because they compute constant
3205 results or their values were already at hand; some statements may
3206 execute in different places because they were moved out of loops.
3207
3208 Nevertheless it proves possible to debug optimized output. This makes
3209 it reasonable to use the optimizer for programs that might have bugs.
3210
3211 The following options are useful when GCC is generated with the
3212 capability for more than one debugging format.
3213
3214 @item -ggdb
3215 @opindex ggdb
3216 Produce debugging information for use by GDB@. This means to use the
3217 most expressive format available (DWARF 2, stabs, or the native format
3218 if neither of those are supported), including GDB extensions if at all
3219 possible.
3220
3221 @item -gstabs
3222 @opindex gstabs
3223 Produce debugging information in stabs format (if that is supported),
3224 without GDB extensions. This is the format used by DBX on most BSD
3225 systems. On MIPS, Alpha and System V Release 4 systems this option
3226 produces stabs debugging output which is not understood by DBX or SDB@.
3227 On System V Release 4 systems this option requires the GNU assembler.
3228
3229 @item -feliminate-unused-debug-symbols
3230 @opindex feliminate-unused-debug-symbols
3231 Produce debugging information in stabs format (if that is supported),
3232 for only symbols that are actually used.
3233
3234 @item -gstabs+
3235 @opindex gstabs+
3236 Produce debugging information in stabs format (if that is supported),
3237 using GNU extensions understood only by the GNU debugger (GDB)@. The
3238 use of these extensions is likely to make other debuggers crash or
3239 refuse to read the program.
3240
3241 @item -gcoff
3242 @opindex gcoff
3243 Produce debugging information in COFF format (if that is supported).
3244 This is the format used by SDB on most System V systems prior to
3245 System V Release 4.
3246
3247 @item -gxcoff
3248 @opindex gxcoff
3249 Produce debugging information in XCOFF format (if that is supported).
3250 This is the format used by the DBX debugger on IBM RS/6000 systems.
3251
3252 @item -gxcoff+
3253 @opindex gxcoff+
3254 Produce debugging information in XCOFF format (if that is supported),
3255 using GNU extensions understood only by the GNU debugger (GDB)@. The
3256 use of these extensions is likely to make other debuggers crash or
3257 refuse to read the program, and may cause assemblers other than the GNU
3258 assembler (GAS) to fail with an error.
3259
3260 @item -gdwarf-2
3261 @opindex gdwarf-2
3262 Produce debugging information in DWARF version 2 format (if that is
3263 supported). This is the format used by DBX on IRIX 6. With this
3264 option, GCC uses features of DWARF version 3 when they are useful;
3265 version 3 is upward compatible with version 2, but may still cause
3266 problems for older debuggers.
3267
3268 @item -gvms
3269 @opindex gvms
3270 Produce debugging information in VMS debug format (if that is
3271 supported). This is the format used by DEBUG on VMS systems.
3272
3273 @item -g@var{level}
3274 @itemx -ggdb@var{level}
3275 @itemx -gstabs@var{level}
3276 @itemx -gcoff@var{level}
3277 @itemx -gxcoff@var{level}
3278 @itemx -gvms@var{level}
3279 Request debugging information and also use @var{level} to specify how
3280 much information. The default level is 2.
3281
3282 Level 1 produces minimal information, enough for making backtraces in
3283 parts of the program that you don't plan to debug. This includes
3284 descriptions of functions and external variables, but no information
3285 about local variables and no line numbers.
3286
3287 Level 3 includes extra information, such as all the macro definitions
3288 present in the program. Some debuggers support macro expansion when
3289 you use @option{-g3}.
3290
3291 @option{-gdwarf-2} does not accept a concatenated debug level, because
3292 GCC used to support an option @option{-gdwarf} that meant to generate
3293 debug information in version 1 of the DWARF format (which is very
3294 different from version 2), and it would have been too confusing. That
3295 debug format is long obsolete, but the option cannot be changed now.
3296 Instead use an additional @option{-g@var{level}} option to change the
3297 debug level for DWARF2.
3298
3299 @item -feliminate-dwarf2-dups
3300 @opindex feliminate-dwarf2-dups
3301 Compress DWARF2 debugging information by eliminating duplicated
3302 information about each symbol. This option only makes sense when
3303 generating DWARF2 debugging information with @option{-gdwarf-2}.
3304
3305 @cindex @command{prof}
3306 @item -p
3307 @opindex p
3308 Generate extra code to write profile information suitable for the
3309 analysis program @command{prof}. You must use this option when compiling
3310 the source files you want data about, and you must also use it when
3311 linking.
3312
3313 @cindex @command{gprof}
3314 @item -pg
3315 @opindex pg
3316 Generate extra code to write profile information suitable for the
3317 analysis program @command{gprof}. You must use this option when compiling
3318 the source files you want data about, and you must also use it when
3319 linking.
3320
3321 @item -Q
3322 @opindex Q
3323 Makes the compiler print out each function name as it is compiled, and
3324 print some statistics about each pass when it finishes.
3325
3326 @item -ftime-report
3327 @opindex ftime-report
3328 Makes the compiler print some statistics about the time consumed by each
3329 pass when it finishes.
3330
3331 @item -fmem-report
3332 @opindex fmem-report
3333 Makes the compiler print some statistics about permanent memory
3334 allocation when it finishes.
3335
3336 @item -fprofile-arcs
3337 @opindex fprofile-arcs
3338 Add code so that program flow @dfn{arcs} are instrumented. During
3339 execution the program records how many times each branch and call is
3340 executed and how many times it is taken or returns. When the compiled
3341 program exits it saves this data to a file called
3342 @file{@var{auxname}.gcda} for each source file. The data may be used for
3343 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3344 test coverage analysis (@option{-ftest-coverage}). Each object file's
3345 @var{auxname} is generated from the name of the output file, if
3346 explicitly specified and it is not the final executable, otherwise it is
3347 the basename of the source file. In both cases any suffix is removed
3348 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3349 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3350
3351 @cindex @command{gcov}
3352 @item --coverage
3353 @opindex coverage
3354
3355 This option is used to compile and link code instrumented for coverage
3356 analysis. The option is a synonym for @option{-fprofile-arcs}
3357 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3358 linking). See the documentation for those options for more details.
3359
3360 @itemize
3361
3362 @item
3363 Compile the source files with @option{-fprofile-arcs} plus optimization
3364 and code generation options. For test coverage analysis, use the
3365 additional @option{-ftest-coverage} option. You do not need to profile
3366 every source file in a program.
3367
3368 @item
3369 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3370 (the latter implies the former).
3371
3372 @item
3373 Run the program on a representative workload to generate the arc profile
3374 information. This may be repeated any number of times. You can run
3375 concurrent instances of your program, and provided that the file system
3376 supports locking, the data files will be correctly updated. Also
3377 @code{fork} calls are detected and correctly handled (double counting
3378 will not happen).
3379
3380 @item
3381 For profile-directed optimizations, compile the source files again with
3382 the same optimization and code generation options plus
3383 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3384 Control Optimization}).
3385
3386 @item
3387 For test coverage analysis, use @command{gcov} to produce human readable
3388 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3389 @command{gcov} documentation for further information.
3390
3391 @end itemize
3392
3393 With @option{-fprofile-arcs}, for each function of your program GCC
3394 creates a program flow graph, then finds a spanning tree for the graph.
3395 Only arcs that are not on the spanning tree have to be instrumented: the
3396 compiler adds code to count the number of times that these arcs are
3397 executed. When an arc is the only exit or only entrance to a block, the
3398 instrumentation code can be added to the block; otherwise, a new basic
3399 block must be created to hold the instrumentation code.
3400
3401 @item -ftree-based-profiling
3402 @opindex ftree-based-profiling
3403 This option is used in addition to @option{-fprofile-arcs} or
3404 @option{-fbranch-probabilities} to control whether those optimizations
3405 are performed on a tree-based or rtl-based internal representation.
3406 If you use this option when compiling with @option{-fprofile-arcs},
3407 you must also use it when compiling later with @option{-fbranch-probabilities}.
3408 Currently the tree-based optimization is in an early stage of
3409 development, and this option is recommended only for those people
3410 working on improving it.
3411
3412 @need 2000
3413 @item -ftest-coverage
3414 @opindex ftest-coverage
3415 Produce a notes file that the @command{gcov} code-coverage utility
3416 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3417 show program coverage. Each source file's note file is called
3418 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3419 above for a description of @var{auxname} and instructions on how to
3420 generate test coverage data. Coverage data will match the source files
3421 more closely, if you do not optimize.
3422
3423 @item -d@var{letters}
3424 @item -fdump-rtl-@var{pass}
3425 @opindex d
3426 Says to make debugging dumps during compilation at times specified by
3427 @var{letters}. This is used for debugging the RTL-based passes of the
3428 compiler. The file names for most of the dumps are made by appending a
3429 pass number and a word to the @var{dumpname}. @var{dumpname} is generated
3430 from the name of the output file, if explicitly specified and it is not
3431 an executable, otherwise it is the basename of the source file.
3432
3433 Most debug dumps can be enabled either passing a letter to the @option{-d}
3434 option, or with a long @option{-fdump-rtl} switch; here are the possible
3435 letters for use in @var{letters} and @var{pass}, and their meanings:
3436
3437 @table @gcctabopt
3438 @item -dA
3439 @opindex dA
3440 Annotate the assembler output with miscellaneous debugging information.
3441
3442 @item -db
3443 @itemx -fdump-rtl-bp
3444 @opindex db
3445 @opindex fdump-rtl-bp
3446 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3447
3448 @item -dB
3449 @itemx -fdump-rtl-bbro
3450 @opindex dB
3451 @opindex fdump-rtl-bbro
3452 Dump after block reordering, to @file{@var{file}.30.bbro}.
3453
3454 @item -dc
3455 @itemx -fdump-rtl-combine
3456 @opindex dc
3457 @opindex fdump-rtl-combine
3458 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3459
3460 @item -dC
3461 @itemx -fdump-rtl-ce1
3462 @itemx -fdump-rtl-ce2
3463 @opindex dC
3464 @opindex fdump-rtl-ce1
3465 @opindex fdump-rtl-ce2
3466 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3467 first if conversion, to the file @file{@var{file}.11.ce1}. @option{-dC}
3468 and @option{-fdump-rtl-ce2} enable dumping after the second if
3469 conversion, to the file @file{@var{file}.18.ce2}.
3470
3471 @item -dd
3472 @itemx -fdump-rtl-btl
3473 @itemx -fdump-rtl-dbr
3474 @opindex dd
3475 @opindex fdump-rtl-btl
3476 @opindex fdump-rtl-dbr
3477 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3478 target load optimization, to to @file{@var{file}.31.btl}. @option{-dd}
3479 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3480 scheduling, to @file{@var{file}.36.dbr}.
3481
3482 @item -dD
3483 @opindex dD
3484 Dump all macro definitions, at the end of preprocessing, in addition to
3485 normal output.
3486
3487 @item -dE
3488 @itemx -fdump-rtl-ce3
3489 @opindex dE
3490 @opindex fdump-rtl-ce3
3491 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3492
3493 @item -df
3494 @itemx -fdump-rtl-cfg
3495 @itemx -fdump-rtl-life
3496 @opindex df
3497 @opindex fdump-rtl-cfg
3498 @opindex fdump-rtl-life
3499 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3500 and data flow analysis, to @file{@var{file}.08.cfg}. @option{-df}
3501 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3502 to @file{@var{file}.16.life}.
3503
3504 @item -dg
3505 @itemx -fdump-rtl-greg
3506 @opindex dg
3507 @opindex fdump-rtl-greg
3508 Dump after global register allocation, to @file{@var{file}.23.greg}.
3509
3510 @item -dG
3511 @itemx -fdump-rtl-gcse
3512 @itemx -fdump-rtl-bypass
3513 @opindex dG
3514 @opindex fdump-rtl-gcse
3515 @opindex fdump-rtl-bypass
3516 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3517 @file{@var{file}.05.gcse}. @option{-dG} and @option{-fdump-rtl-bypass}
3518 enable dumping after jump bypassing and control flow optimizations, to
3519 @file{@var{file}.07.bypass}.
3520
3521 @item -dh
3522 @itemx -fdump-rtl-eh
3523 @opindex dh
3524 @opindex fdump-rtl-eh
3525 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3526
3527 @item -di
3528 @itemx -fdump-rtl-sibling
3529 @opindex di
3530 @opindex fdump-rtl-sibling
3531 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3532
3533 @item -dj
3534 @itemx -fdump-rtl-jump
3535 @opindex dj
3536 @opindex fdump-rtl-jump
3537 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3538
3539 @item -dk
3540 @itemx -fdump-rtl-stack
3541 @opindex dk
3542 @opindex fdump-rtl-stack
3543 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3544
3545 @item -dl
3546 @itemx -fdump-rtl-lreg
3547 @opindex dl
3548 @opindex fdump-rtl-lreg
3549 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3550
3551 @item -dL
3552 @itemx -fdump-rtl-loop
3553 @itemx -fdump-rtl-loop2
3554 @opindex dL
3555 @opindex fdump-rtl-loop
3556 @opindex fdump-rtl-loop2
3557 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3558 loop optimization pass, to @file{@var{file}.06.loop}. @option{-dL} and
3559 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3560 @file{@var{file}.13.loop2}.
3561
3562 @item -dm
3563 @itemx -fdump-rtl-sms
3564 @opindex dm
3565 @opindex fdump-rtl-sms
3566 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3567
3568 @item -dM
3569 @itemx -fdump-rtl-mach
3570 @opindex dM
3571 @opindex fdump-rtl-mach
3572 Dump after performing the machine dependent reorganization pass, to
3573 @file{@var{file}.35.mach}.
3574
3575 @item -dn
3576 @itemx -fdump-rtl-rnreg
3577 @opindex dn
3578 @opindex fdump-rtl-rnreg
3579 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3580
3581 @item -dN
3582 @itemx -fdump-rtl-regmove
3583 @opindex dN
3584 @opindex fdump-rtl-regmove
3585 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3586
3587 @item -do
3588 @itemx -fdump-rtl-postreload
3589 @opindex do
3590 @opindex fdump-rtl-postreload
3591 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3592
3593 @item -dr
3594 @itemx -fdump-rtl-expand
3595 @opindex dr
3596 @opindex fdump-rtl-expand
3597 Dump after RTL generation, to @file{@var{file}.00.expand}.
3598
3599 @item -dR
3600 @itemx -fdump-rtl-sched2
3601 @opindex dR
3602 @opindex fdump-rtl-sched2
3603 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3604
3605 @item -ds
3606 @itemx -fdump-rtl-cse
3607 @opindex ds
3608 @opindex fdump-rtl-cse
3609 Dump after CSE (including the jump optimization that sometimes follows
3610 CSE), to @file{@var{file}.04.cse}.
3611
3612 @item -dS
3613 @itemx -fdump-rtl-sched
3614 @opindex dS
3615 @opindex fdump-rtl-sched
3616 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3617
3618 @item -dt
3619 @itemx -fdump-rtl-cse2
3620 @opindex dt
3621 @opindex fdump-rtl-cse2
3622 Dump after the second CSE pass (including the jump optimization that
3623 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3624
3625 @item -dT
3626 @itemx -fdump-rtl-tracer
3627 @opindex dT
3628 @opindex fdump-rtl-tracer
3629 Dump after running tracer, to @file{@var{file}.12.tracer}.
3630
3631 @item -dV
3632 @itemx -fdump-rtl-vpt
3633 @itemx -fdump-rtl-vartrack
3634 @opindex dV
3635 @opindex fdump-rtl-vpt
3636 @opindex fdump-rtl-vartrack
3637 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3638 profile transformations, to @file{@var{file}.10.vpt}. @option{-dV}
3639 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3640 to @file{@var{file}.34.vartrack}.
3641
3642 @item -dw
3643 @itemx -fdump-rtl-flow2
3644 @opindex dw
3645 @opindex fdump-rtl-flow2
3646 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3647
3648 @item -dz
3649 @itemx -fdump-rtl-peephole2
3650 @opindex dz
3651 @opindex fdump-rtl-peephole2
3652 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3653
3654 @item -dZ
3655 @itemx -fdump-rtl-web
3656 @opindex dZ
3657 @opindex fdump-rtl-web
3658 Dump after live range splitting, to @file{@var{file}.14.web}.
3659
3660 @item -da
3661 @itemx -fdump-rtl-all
3662 @opindex da
3663 @opindex fdump-rtl-all
3664 Produce all the dumps listed above.
3665
3666 @item -dH
3667 @opindex dH
3668 Produce a core dump whenever an error occurs.
3669
3670 @item -dm
3671 @opindex dm
3672 Print statistics on memory usage, at the end of the run, to
3673 standard error.
3674
3675 @item -dp
3676 @opindex dp
3677 Annotate the assembler output with a comment indicating which
3678 pattern and alternative was used. The length of each instruction is
3679 also printed.
3680
3681 @item -dP
3682 @opindex dP
3683 Dump the RTL in the assembler output as a comment before each instruction.
3684 Also turns on @option{-dp} annotation.
3685
3686 @item -dv
3687 @opindex dv
3688 For each of the other indicated dump files (either with @option{-d} or
3689 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3690 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3691
3692 @item -dx
3693 @opindex dx
3694 Just generate RTL for a function instead of compiling it. Usually used
3695 with @samp{r} (@option{-fdump-rtl-expand}).
3696
3697 @item -dy
3698 @opindex dy
3699 Dump debugging information during parsing, to standard error.
3700 @end table
3701
3702 @item -fdump-unnumbered
3703 @opindex fdump-unnumbered
3704 When doing debugging dumps (see @option{-d} option above), suppress instruction
3705 numbers and line number note output. This makes it more feasible to
3706 use diff on debugging dumps for compiler invocations with different
3707 options, in particular with and without @option{-g}.
3708
3709 @item -fdump-translation-unit @r{(C and C++ only)}
3710 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3711 @opindex fdump-translation-unit
3712 Dump a representation of the tree structure for the entire translation
3713 unit to a file. The file name is made by appending @file{.tu} to the
3714 source file name. If the @samp{-@var{options}} form is used, @var{options}
3715 controls the details of the dump as described for the
3716 @option{-fdump-tree} options.
3717
3718 @item -fdump-class-hierarchy @r{(C++ only)}
3719 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3720 @opindex fdump-class-hierarchy
3721 Dump a representation of each class's hierarchy and virtual function
3722 table layout to a file. The file name is made by appending @file{.class}
3723 to the source file name. If the @samp{-@var{options}} form is used,
3724 @var{options} controls the details of the dump as described for the
3725 @option{-fdump-tree} options.
3726
3727 @item -fdump-ipa-@var{switch}
3728 @opindex fdump-ipa
3729 Control the dumping at various stages of inter-procedural analysis
3730 language tree to a file. The file name is generated by appending a switch
3731 specific suffix to the source file name. The following dumps are possible:
3732
3733 @table @samp
3734 @item all
3735 Enables all inter-procedural analysis dumps; currently the only produced
3736 dump is the @samp{cgraph} dump.
3737
3738 @item cgraph
3739 Dumps information about call-graph optimization, unused function removal,
3740 and inlining decisions.
3741 @end table
3742
3743 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3744 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3745 @opindex fdump-tree
3746 Control the dumping at various stages of processing the intermediate
3747 language tree to a file. The file name is generated by appending a switch
3748 specific suffix to the source file name. If the @samp{-@var{options}}
3749 form is used, @var{options} is a list of @samp{-} separated options that
3750 control the details of the dump. Not all options are applicable to all
3751 dumps, those which are not meaningful will be ignored. The following
3752 options are available
3753
3754 @table @samp
3755 @item address
3756 Print the address of each node. Usually this is not meaningful as it
3757 changes according to the environment and source file. Its primary use
3758 is for tying up a dump file with a debug environment.
3759 @item slim
3760 Inhibit dumping of members of a scope or body of a function merely
3761 because that scope has been reached. Only dump such items when they
3762 are directly reachable by some other path. When dumping pretty-printed
3763 trees, this option inhibits dumping the bodies of control structures.
3764 @item raw
3765 Print a raw representation of the tree. By default, trees are
3766 pretty-printed into a C-like representation.
3767 @item details
3768 Enable more detailed dumps (not honored by every dump option).
3769 @item stats
3770 Enable dumping various statistics about the pass (not honored by every dump
3771 option).
3772 @item blocks
3773 Enable showing basic block boundaries (disabled in raw dumps).
3774 @item vops
3775 Enable showing virtual operands for every statement.
3776 @item lineno
3777 Enable showing line numbers for statements.
3778 @item uid
3779 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3780 @item all
3781 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3782 @end table
3783
3784 The following tree dumps are possible:
3785 @table @samp
3786
3787 @item original
3788 Dump before any tree based optimization, to @file{@var{file}.original}.
3789
3790 @item optimized
3791 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3792
3793 @item inlined
3794 Dump after function inlining, to @file{@var{file}.inlined}.
3795
3796 @item gimple
3797 @opindex fdump-tree-gimple
3798 Dump each function before and after the gimplification pass to a file. The
3799 file name is made by appending @file{.gimple} to the source file name.
3800
3801 @item cfg
3802 @opindex fdump-tree-cfg
3803 Dump the control flow graph of each function to a file. The file name is
3804 made by appending @file{.cfg} to the source file name.
3805
3806 @item vcg
3807 @opindex fdump-tree-vcg
3808 Dump the control flow graph of each function to a file in VCG format. The
3809 file name is made by appending @file{.vcg} to the source file name. Note
3810 that if the file contains more than one function, the generated file cannot
3811 be used directly by VCG@. You will need to cut and paste each function's
3812 graph into its own separate file first.
3813
3814 @item ch
3815 @opindex fdump-tree-ch
3816 Dump each function after copying loop headers. The file name is made by
3817 appending @file{.ch} to the source file name.
3818
3819 @item ssa
3820 @opindex fdump-tree-ssa
3821 Dump SSA related information to a file. The file name is made by appending
3822 @file{.ssa} to the source file name.
3823
3824 @item salias
3825 @opindex fdump-tree-salias
3826 Dump structure aliasing variable information to a file. This file name
3827 is made by appending @file{.salias} to the source file name.
3828
3829 @item alias
3830 @opindex fdump-tree-alias
3831 Dump aliasing information for each function. The file name is made by
3832 appending @file{.alias} to the source file name.
3833
3834 @item ccp
3835 @opindex fdump-tree-ccp
3836 Dump each function after CCP@. The file name is made by appending
3837 @file{.ccp} to the source file name.
3838
3839 @item pre
3840 @opindex fdump-tree-pre
3841 Dump trees after partial redundancy elimination. The file name is made
3842 by appending @file{.pre} to the source file name.
3843
3844 @item fre
3845 @opindex fdump-tree-fre
3846 Dump trees after full redundancy elimination. The file name is made
3847 by appending @file{.fre} to the source file name.
3848
3849 @item dce
3850 @opindex fdump-tree-dce
3851 Dump each function after dead code elimination. The file name is made by
3852 appending @file{.dce} to the source file name.
3853
3854 @item mudflap
3855 @opindex fdump-tree-mudflap
3856 Dump each function after adding mudflap instrumentation. The file name is
3857 made by appending @file{.mudflap} to the source file name.
3858
3859 @item sra
3860 @opindex fdump-tree-sra
3861 Dump each function after performing scalar replacement of aggregates. The
3862 file name is made by appending @file{.sra} to the source file name.
3863
3864 @item sink
3865 @opindex fdump-tree-sink
3866 Dump each function after performing code sinking. The file name is made
3867 by appending @file{.sink} to the source file name.
3868
3869 @item dom
3870 @opindex fdump-tree-dom
3871 Dump each function after applying dominator tree optimizations. The file
3872 name is made by appending @file{.dom} to the source file name.
3873
3874 @item dse
3875 @opindex fdump-tree-dse
3876 Dump each function after applying dead store elimination. The file
3877 name is made by appending @file{.dse} to the source file name.
3878
3879 @item phiopt
3880 @opindex fdump-tree-phiopt
3881 Dump each function after optimizing PHI nodes into straightline code. The file
3882 name is made by appending @file{.phiopt} to the source file name.
3883
3884 @item forwprop
3885 @opindex fdump-tree-forwprop
3886 Dump each function after forward propagating single use variables. The file
3887 name is made by appending @file{.forwprop} to the source file name.
3888
3889 @item copyrename
3890 @opindex fdump-tree-copyrename
3891 Dump each function after applying the copy rename optimization. The file
3892 name is made by appending @file{.copyrename} to the source file name.
3893
3894 @item nrv
3895 @opindex fdump-tree-nrv
3896 Dump each function after applying the named return value optimization on
3897 generic trees. The file name is made by appending @file{.nrv} to the source
3898 file name.
3899
3900 @item vect
3901 @opindex fdump-tree-vect
3902 Dump each function after applying vectorization of loops. The file name is
3903 made by appending @file{.vect} to the source file name.
3904
3905 @item all
3906 @opindex fdump-tree-all
3907 Enable all the available tree dumps with the flags provided in this option.
3908 @end table
3909
3910 @item -ftree-vectorizer-verbose=@var{n}
3911 @opindex ftree-vectorizer-verbose
3912 This option controls the amount of debugging output the vectorizer prints.
3913 This information is written to standard error, unless @option{-fdump-tree-all}
3914 or @option{-fdump-tree-vect} is specified, in which case it is output to the
3915 usual dump listing file, @file{.vect}.
3916
3917 @item -frandom-seed=@var{string}
3918 @opindex frandom-string
3919 This option provides a seed that GCC uses when it would otherwise use
3920 random numbers. It is used to generate certain symbol names
3921 that have to be different in every compiled file. It is also used to
3922 place unique stamps in coverage data files and the object files that
3923 produce them. You can use the @option{-frandom-seed} option to produce
3924 reproducibly identical object files.
3925
3926 The @var{string} should be different for every file you compile.
3927
3928 @item -fsched-verbose=@var{n}
3929 @opindex fsched-verbose
3930 On targets that use instruction scheduling, this option controls the
3931 amount of debugging output the scheduler prints. This information is
3932 written to standard error, unless @option{-dS} or @option{-dR} is
3933 specified, in which case it is output to the usual dump
3934 listing file, @file{.sched} or @file{.sched2} respectively. However
3935 for @var{n} greater than nine, the output is always printed to standard
3936 error.
3937
3938 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3939 same information as @option{-dRS}. For @var{n} greater than one, it
3940 also output basic block probabilities, detailed ready list information
3941 and unit/insn info. For @var{n} greater than two, it includes RTL
3942 at abort point, control-flow and regions info. And for @var{n} over
3943 four, @option{-fsched-verbose} also includes dependence info.
3944
3945 @item -save-temps
3946 @opindex save-temps
3947 Store the usual ``temporary'' intermediate files permanently; place them
3948 in the current directory and name them based on the source file. Thus,
3949 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3950 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}. This creates a
3951 preprocessed @file{foo.i} output file even though the compiler now
3952 normally uses an integrated preprocessor.
3953
3954 When used in combination with the @option{-x} command line option,
3955 @option{-save-temps} is sensible enough to avoid over writing an
3956 input source file with the same extension as an intermediate file.
3957 The corresponding intermediate file may be obtained by renaming the
3958 source file before using @option{-save-temps}.
3959
3960 @item -time
3961 @opindex time
3962 Report the CPU time taken by each subprocess in the compilation
3963 sequence. For C source files, this is the compiler proper and assembler
3964 (plus the linker if linking is done). The output looks like this:
3965
3966 @smallexample
3967 # cc1 0.12 0.01
3968 # as 0.00 0.01
3969 @end smallexample
3970
3971 The first number on each line is the ``user time'', that is time spent
3972 executing the program itself. The second number is ``system time'',
3973 time spent executing operating system routines on behalf of the program.
3974 Both numbers are in seconds.
3975
3976 @item -fvar-tracking
3977 @opindex fvar-tracking
3978 Run variable tracking pass. It computes where variables are stored at each
3979 position in code. Better debugging information is then generated
3980 (if the debugging information format supports this information).
3981
3982 It is enabled by default when compiling with optimization (@option{-Os},
3983 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
3984 the debug info format supports it.
3985
3986 @item -print-file-name=@var{library}
3987 @opindex print-file-name
3988 Print the full absolute name of the library file @var{library} that
3989 would be used when linking---and don't do anything else. With this
3990 option, GCC does not compile or link anything; it just prints the
3991 file name.
3992
3993 @item -print-multi-directory
3994 @opindex print-multi-directory
3995 Print the directory name corresponding to the multilib selected by any
3996 other switches present in the command line. This directory is supposed
3997 to exist in @env{GCC_EXEC_PREFIX}.
3998
3999 @item -print-multi-lib
4000 @opindex print-multi-lib
4001 Print the mapping from multilib directory names to compiler switches
4002 that enable them. The directory name is separated from the switches by
4003 @samp{;}, and each switch starts with an @samp{@@} instead of the
4004 @samp{-}, without spaces between multiple switches. This is supposed to
4005 ease shell-processing.
4006
4007 @item -print-prog-name=@var{program}
4008 @opindex print-prog-name
4009 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4010
4011 @item -print-libgcc-file-name
4012 @opindex print-libgcc-file-name
4013 Same as @option{-print-file-name=libgcc.a}.
4014
4015 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4016 but you do want to link with @file{libgcc.a}. You can do
4017
4018 @smallexample
4019 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4020 @end smallexample
4021
4022 @item -print-search-dirs
4023 @opindex print-search-dirs
4024 Print the name of the configured installation directory and a list of
4025 program and library directories @command{gcc} will search---and don't do anything else.
4026
4027 This is useful when @command{gcc} prints the error message
4028 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4029 To resolve this you either need to put @file{cpp0} and the other compiler
4030 components where @command{gcc} expects to find them, or you can set the environment
4031 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4032 Don't forget the trailing @samp{/}.
4033 @xref{Environment Variables}.
4034
4035 @item -dumpmachine
4036 @opindex dumpmachine
4037 Print the compiler's target machine (for example,
4038 @samp{i686-pc-linux-gnu})---and don't do anything else.
4039
4040 @item -dumpversion
4041 @opindex dumpversion
4042 Print the compiler version (for example, @samp{3.0})---and don't do
4043 anything else.
4044
4045 @item -dumpspecs
4046 @opindex dumpspecs
4047 Print the compiler's built-in specs---and don't do anything else. (This
4048 is used when GCC itself is being built.) @xref{Spec Files}.
4049
4050 @item -feliminate-unused-debug-types
4051 @opindex feliminate-unused-debug-types
4052 Normally, when producing DWARF2 output, GCC will emit debugging
4053 information for all types declared in a compilation
4054 unit, regardless of whether or not they are actually used
4055 in that compilation unit. Sometimes this is useful, such as
4056 if, in the debugger, you want to cast a value to a type that is
4057 not actually used in your program (but is declared). More often,
4058 however, this results in a significant amount of wasted space.
4059 With this option, GCC will avoid producing debug symbol output
4060 for types that are nowhere used in the source file being compiled.
4061 @end table
4062
4063 @node Optimize Options
4064 @section Options That Control Optimization
4065 @cindex optimize options
4066 @cindex options, optimization
4067
4068 These options control various sorts of optimizations.
4069
4070 Without any optimization option, the compiler's goal is to reduce the
4071 cost of compilation and to make debugging produce the expected
4072 results. Statements are independent: if you stop the program with a
4073 breakpoint between statements, you can then assign a new value to any
4074 variable or change the program counter to any other statement in the
4075 function and get exactly the results you would expect from the source
4076 code.
4077
4078 Turning on optimization flags makes the compiler attempt to improve
4079 the performance and/or code size at the expense of compilation time
4080 and possibly the ability to debug the program.
4081
4082 The compiler performs optimization based on the knowledge it has of
4083 the program. Optimization levels @option{-O2} and above, in
4084 particular, enable @emph{unit-at-a-time} mode, which allows the
4085 compiler to consider information gained from later functions in
4086 the file when compiling a function. Compiling multiple files at
4087 once to a single output file in @emph{unit-at-a-time} mode allows
4088 the compiler to use information gained from all of the files when
4089 compiling each of them.
4090
4091 Not all optimizations are controlled directly by a flag. Only
4092 optimizations that have a flag are listed.
4093
4094 @table @gcctabopt
4095 @item -O
4096 @itemx -O1
4097 @opindex O
4098 @opindex O1
4099 Optimize. Optimizing compilation takes somewhat more time, and a lot
4100 more memory for a large function.
4101
4102 With @option{-O}, the compiler tries to reduce code size and execution
4103 time, without performing any optimizations that take a great deal of
4104 compilation time.
4105
4106 @option{-O} turns on the following optimization flags:
4107 @gccoptlist{-fdefer-pop @gol
4108 -fdelayed-branch @gol
4109 -fguess-branch-probability @gol
4110 -fcprop-registers @gol
4111 -floop-optimize @gol
4112 -fif-conversion @gol
4113 -fif-conversion2 @gol
4114 -ftree-ccp @gol
4115 -ftree-dce @gol
4116 -ftree-dom @gol
4117 -ftree-dse @gol
4118 -ftree-ter @gol
4119 -ftree-live_range_split @gol
4120 -ftree-sra @gol
4121 -ftree-copyrename @gol
4122 -ftree-fre @gol
4123 -ftree-ch @gol
4124 -fmerge-constants}
4125
4126 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4127 where doing so does not interfere with debugging.
4128
4129 @item -O2
4130 @opindex O2
4131 Optimize even more. GCC performs nearly all supported optimizations
4132 that do not involve a space-speed tradeoff. The compiler does not
4133 perform loop unrolling or function inlining when you specify @option{-O2}.
4134 As compared to @option{-O}, this option increases both compilation time
4135 and the performance of the generated code.
4136
4137 @option{-O2} turns on all optimization flags specified by @option{-O}. It
4138 also turns on the following optimization flags:
4139 @gccoptlist{-fthread-jumps @gol
4140 -fcrossjumping @gol
4141 -foptimize-sibling-calls @gol
4142 -fcse-follow-jumps -fcse-skip-blocks @gol
4143 -fgcse -fgcse-lm @gol
4144 -fexpensive-optimizations @gol
4145 -fstrength-reduce @gol
4146 -frerun-cse-after-loop -frerun-loop-opt @gol
4147 -fcaller-saves @gol
4148 -fforce-mem @gol
4149 -fpeephole2 @gol
4150 -fschedule-insns -fschedule-insns2 @gol
4151 -fsched-interblock -fsched-spec @gol
4152 -fregmove @gol
4153 -fstrict-aliasing @gol
4154 -fdelete-null-pointer-checks @gol
4155 -freorder-blocks -freorder-functions @gol
4156 -funit-at-a-time @gol
4157 -falign-functions -falign-jumps @gol
4158 -falign-loops -falign-labels @gol
4159 -ftree-pre}
4160
4161 Please note the warning under @option{-fgcse} about
4162 invoking @option{-O2} on programs that use computed gotos.
4163
4164 @item -O3
4165 @opindex O3
4166 Optimize yet more. @option{-O3} turns on all optimizations specified by
4167 @option{-O2} and also turns on the @option{-finline-functions},
4168 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4169
4170 @item -O0
4171 @opindex O0
4172 Do not optimize. This is the default.
4173
4174 @item -Os
4175 @opindex Os
4176 Optimize for size. @option{-Os} enables all @option{-O2} optimizations that
4177 do not typically increase code size. It also performs further
4178 optimizations designed to reduce code size.
4179
4180 @option{-Os} disables the following optimization flags:
4181 @gccoptlist{-falign-functions -falign-jumps -falign-loops @gol
4182 -falign-labels -freorder-blocks -freorder-blocks-and-partition -fprefetch-loop-arrays}
4183
4184 If you use multiple @option{-O} options, with or without level numbers,
4185 the last such option is the one that is effective.
4186 @end table
4187
4188 Options of the form @option{-f@var{flag}} specify machine-independent
4189 flags. Most flags have both positive and negative forms; the negative
4190 form of @option{-ffoo} would be @option{-fno-foo}. In the table
4191 below, only one of the forms is listed---the one you typically will
4192 use. You can figure out the other form by either removing @samp{no-}
4193 or adding it.
4194
4195 The following options control specific optimizations. They are either
4196 activated by @option{-O} options or are related to ones that are. You
4197 can use the following flags in the rare cases when ``fine-tuning'' of
4198 optimizations to be performed is desired.
4199
4200 @table @gcctabopt
4201 @item -fno-default-inline
4202 @opindex fno-default-inline
4203 Do not make member functions inline by default merely because they are
4204 defined inside the class scope (C++ only). Otherwise, when you specify
4205 @w{@option{-O}}, member functions defined inside class scope are compiled
4206 inline by default; i.e., you don't need to add @samp{inline} in front of
4207 the member function name.
4208
4209 @item -fno-defer-pop
4210 @opindex fno-defer-pop
4211 Always pop the arguments to each function call as soon as that function
4212 returns. For machines which must pop arguments after a function call,
4213 the compiler normally lets arguments accumulate on the stack for several
4214 function calls and pops them all at once.
4215
4216 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4217
4218 @item -fforce-mem
4219 @opindex fforce-mem
4220 Force memory operands to be copied into registers before doing
4221 arithmetic on them. This produces better code by making all memory
4222 references potential common subexpressions. When they are not common
4223 subexpressions, instruction combination should eliminate the separate
4224 register-load.
4225
4226 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4227
4228 @item -fforce-addr
4229 @opindex fforce-addr
4230 Force memory address constants to be copied into registers before
4231 doing arithmetic on them. This may produce better code just as
4232 @option{-fforce-mem} may.
4233
4234 @item -fomit-frame-pointer
4235 @opindex fomit-frame-pointer
4236 Don't keep the frame pointer in a register for functions that
4237 don't need one. This avoids the instructions to save, set up and
4238 restore frame pointers; it also makes an extra register available
4239 in many functions. @strong{It also makes debugging impossible on
4240 some machines.}
4241
4242 On some machines, such as the VAX, this flag has no effect, because
4243 the standard calling sequence automatically handles the frame pointer
4244 and nothing is saved by pretending it doesn't exist. The
4245 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4246 whether a target machine supports this flag. @xref{Registers,,Register
4247 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4248
4249 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4250
4251 @item -foptimize-sibling-calls
4252 @opindex foptimize-sibling-calls
4253 Optimize sibling and tail recursive calls.
4254
4255 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4256
4257 @item -fno-inline
4258 @opindex fno-inline
4259 Don't pay attention to the @code{inline} keyword. Normally this option
4260 is used to keep the compiler from expanding any functions inline.
4261 Note that if you are not optimizing, no functions can be expanded inline.
4262
4263 @item -finline-functions
4264 @opindex finline-functions
4265 Integrate all simple functions into their callers. The compiler
4266 heuristically decides which functions are simple enough to be worth
4267 integrating in this way.
4268
4269 If all calls to a given function are integrated, and the function is
4270 declared @code{static}, then the function is normally not output as
4271 assembler code in its own right.
4272
4273 Enabled at level @option{-O3}.
4274
4275 @item -finline-limit=@var{n}
4276 @opindex finline-limit
4277 By default, GCC limits the size of functions that can be inlined. This flag
4278 allows the control of this limit for functions that are explicitly marked as
4279 inline (i.e., marked with the inline keyword or defined within the class
4280 definition in c++). @var{n} is the size of functions that can be inlined in
4281 number of pseudo instructions (not counting parameter handling). The default
4282 value of @var{n} is 600.
4283 Increasing this value can result in more inlined code at
4284 the cost of compilation time and memory consumption. Decreasing usually makes
4285 the compilation faster and less code will be inlined (which presumably
4286 means slower programs). This option is particularly useful for programs that
4287 use inlining heavily such as those based on recursive templates with C++.
4288
4289 Inlining is actually controlled by a number of parameters, which may be
4290 specified individually by using @option{--param @var{name}=@var{value}}.
4291 The @option{-finline-limit=@var{n}} option sets some of these parameters
4292 as follows:
4293
4294 @table @gcctabopt
4295 @item max-inline-insns-single
4296 is set to @var{n}/2.
4297 @item max-inline-insns-auto
4298 is set to @var{n}/2.
4299 @item min-inline-insns
4300 is set to 130 or @var{n}/4, whichever is smaller.
4301 @item max-inline-insns-rtl
4302 is set to @var{n}.
4303 @end table
4304
4305 See below for a documentation of the individual
4306 parameters controlling inlining.
4307
4308 @emph{Note:} pseudo instruction represents, in this particular context, an
4309 abstract measurement of function's size. In no way, it represents a count
4310 of assembly instructions and as such its exact meaning might change from one
4311 release to an another.
4312
4313 @item -fkeep-inline-functions
4314 @opindex fkeep-inline-functions
4315 In C, emit @code{static} functions that are declared @code{inline}
4316 into the object file, even if the function has been inlined into all
4317 of its callers. This switch does not affect functions using the
4318 @code{extern inline} extension in GNU C@. In C++, emit any and all
4319 inline functions into the object file.
4320
4321 @item -fkeep-static-consts
4322 @opindex fkeep-static-consts
4323 Emit variables declared @code{static const} when optimization isn't turned
4324 on, even if the variables aren't referenced.
4325
4326 GCC enables this option by default. If you want to force the compiler to
4327 check if the variable was referenced, regardless of whether or not
4328 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4329
4330 @item -fmerge-constants
4331 Attempt to merge identical constants (string constants and floating point
4332 constants) across compilation units.
4333
4334 This option is the default for optimized compilation if the assembler and
4335 linker support it. Use @option{-fno-merge-constants} to inhibit this
4336 behavior.
4337
4338 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4339
4340 @item -fmerge-all-constants
4341 Attempt to merge identical constants and identical variables.
4342
4343 This option implies @option{-fmerge-constants}. In addition to
4344 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4345 arrays or initialized constant variables with integral or floating point
4346 types. Languages like C or C++ require each non-automatic variable to
4347 have distinct location, so using this option will result in non-conforming
4348 behavior.
4349
4350 @item -fmodulo-sched
4351 @opindex fmodulo-sched
4352 Perform swing modulo scheduling immediately before the first scheduling
4353 pass. This pass looks at innermost loops and reorders their
4354 instructions by overlapping different iterations.
4355
4356 @item -fno-branch-count-reg
4357 @opindex fno-branch-count-reg
4358 Do not use ``decrement and branch'' instructions on a count register,
4359 but instead generate a sequence of instructions that decrement a
4360 register, compare it against zero, then branch based upon the result.
4361 This option is only meaningful on architectures that support such
4362 instructions, which include x86, PowerPC, IA-64 and S/390.
4363
4364 The default is @option{-fbranch-count-reg}, enabled when
4365 @option{-fstrength-reduce} is enabled.
4366
4367 @item -fno-function-cse
4368 @opindex fno-function-cse
4369 Do not put function addresses in registers; make each instruction that
4370 calls a constant function contain the function's address explicitly.
4371
4372 This option results in less efficient code, but some strange hacks
4373 that alter the assembler output may be confused by the optimizations
4374 performed when this option is not used.
4375
4376 The default is @option{-ffunction-cse}
4377
4378 @item -fno-zero-initialized-in-bss
4379 @opindex fno-zero-initialized-in-bss
4380 If the target supports a BSS section, GCC by default puts variables that
4381 are initialized to zero into BSS@. This can save space in the resulting
4382 code.
4383
4384 This option turns off this behavior because some programs explicitly
4385 rely on variables going to the data section. E.g., so that the
4386 resulting executable can find the beginning of that section and/or make
4387 assumptions based on that.
4388
4389 The default is @option{-fzero-initialized-in-bss}.
4390
4391 @item -fbounds-check
4392 @opindex fbounds-check
4393 For front-ends that support it, generate additional code to check that
4394 indices used to access arrays are within the declared range. This is
4395 currently only supported by the Java and Fortran front-ends, where
4396 this option defaults to true and false respectively.
4397
4398 @item -fmudflap -fmudflapth -fmudflapir
4399 @opindex fmudflap
4400 @opindex fmudflapth
4401 @opindex fmudflapir
4402 @cindex bounds checking
4403 @cindex mudflap
4404 For front-ends that support it (C and C++), instrument all risky
4405 pointer/array dereferencing operations, some standard library
4406 string/heap functions, and some other associated constructs with
4407 range/validity tests. Modules so instrumented should be immune to
4408 buffer overflows, invalid heap use, and some other classes of C/C++
4409 programming errors. The instrumentation relies on a separate runtime
4410 library (@file{libmudflap}), which will be linked into a program if
4411 @option{-fmudflap} is given at link time. Run-time behavior of the
4412 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4413 environment variable. See @code{env MUDFLAP_OPTIONS=-help a.out}
4414 for its options.
4415
4416 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4417 link if your program is multi-threaded. Use @option{-fmudflapir}, in
4418 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4419 instrumentation should ignore pointer reads. This produces less
4420 instrumentation (and therefore faster execution) and still provides
4421 some protection against outright memory corrupting writes, but allows
4422 erroneously read data to propagate within a program.
4423
4424 @item -fstrength-reduce
4425 @opindex fstrength-reduce
4426 Perform the optimizations of loop strength reduction and
4427 elimination of iteration variables.
4428
4429 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4430
4431 @item -fthread-jumps
4432 @opindex fthread-jumps
4433 Perform optimizations where we check to see if a jump branches to a
4434 location where another comparison subsumed by the first is found. If
4435 so, the first branch is redirected to either the destination of the
4436 second branch or a point immediately following it, depending on whether
4437 the condition is known to be true or false.
4438
4439 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4440
4441 @item -fcse-follow-jumps
4442 @opindex fcse-follow-jumps
4443 In common subexpression elimination, scan through jump instructions
4444 when the target of the jump is not reached by any other path. For
4445 example, when CSE encounters an @code{if} statement with an
4446 @code{else} clause, CSE will follow the jump when the condition
4447 tested is false.
4448
4449 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4450
4451 @item -fcse-skip-blocks
4452 @opindex fcse-skip-blocks
4453 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4454 follow jumps which conditionally skip over blocks. When CSE
4455 encounters a simple @code{if} statement with no else clause,
4456 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4457 body of the @code{if}.
4458
4459 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4460
4461 @item -frerun-cse-after-loop
4462 @opindex frerun-cse-after-loop
4463 Re-run common subexpression elimination after loop optimizations has been
4464 performed.
4465
4466 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4467
4468 @item -frerun-loop-opt
4469 @opindex frerun-loop-opt
4470 Run the loop optimizer twice.
4471
4472 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4473
4474 @item -fgcse
4475 @opindex fgcse
4476 Perform a global common subexpression elimination pass.
4477 This pass also performs global constant and copy propagation.
4478
4479 @emph{Note:} When compiling a program using computed gotos, a GCC
4480 extension, you may get better runtime performance if you disable
4481 the global common subexpression elimination pass by adding
4482 @option{-fno-gcse} to the command line.
4483
4484 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4485
4486 @item -fgcse-lm
4487 @opindex fgcse-lm
4488 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4489 attempt to move loads which are only killed by stores into themselves. This
4490 allows a loop containing a load/store sequence to be changed to a load outside
4491 the loop, and a copy/store within the loop.
4492
4493 Enabled by default when gcse is enabled.
4494
4495 @item -fgcse-sm
4496 @opindex fgcse-sm
4497 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4498 global common subexpression elimination. This pass will attempt to move
4499 stores out of loops. When used in conjunction with @option{-fgcse-lm},
4500 loops containing a load/store sequence can be changed to a load before
4501 the loop and a store after the loop.
4502
4503 Not enabled at any optimization level.
4504
4505 @item -fgcse-las
4506 @opindex fgcse-las
4507 When @option{-fgcse-las} is enabled, the global common subexpression
4508 elimination pass eliminates redundant loads that come after stores to the
4509 same memory location (both partial and full redundancies).
4510
4511 Not enabled at any optimization level.
4512
4513 @item -fgcse-after-reload
4514 @opindex fgcse-after-reload
4515 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4516 pass is performed after reload. The purpose of this pass is to cleanup
4517 redundant spilling.
4518
4519 @item -floop-optimize
4520 @opindex floop-optimize
4521 Perform loop optimizations: move constant expressions out of loops, simplify
4522 exit test conditions and optionally do strength-reduction as well.
4523
4524 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4525
4526 @item -floop-optimize2
4527 @opindex floop-optimize2
4528 Perform loop optimizations using the new loop optimizer. The optimizations
4529 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4530 by separate flags.
4531
4532 @item -fcrossjumping
4533 @opindex crossjumping
4534 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
4535 resulting code may or may not perform better than without cross-jumping.
4536
4537 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4538
4539 @item -fif-conversion
4540 @opindex if-conversion
4541 Attempt to transform conditional jumps into branch-less equivalents. This
4542 include use of conditional moves, min, max, set flags and abs instructions, and
4543 some tricks doable by standard arithmetics. The use of conditional execution
4544 on chips where it is available is controlled by @code{if-conversion2}.
4545
4546 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4547
4548 @item -fif-conversion2
4549 @opindex if-conversion2
4550 Use conditional execution (where available) to transform conditional jumps into
4551 branch-less equivalents.
4552
4553 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4554
4555 @item -fdelete-null-pointer-checks
4556 @opindex fdelete-null-pointer-checks
4557 Use global dataflow analysis to identify and eliminate useless checks
4558 for null pointers. The compiler assumes that dereferencing a null
4559 pointer would have halted the program. If a pointer is checked after
4560 it has already been dereferenced, it cannot be null.
4561
4562 In some environments, this assumption is not true, and programs can
4563 safely dereference null pointers. Use
4564 @option{-fno-delete-null-pointer-checks} to disable this optimization
4565 for programs which depend on that behavior.
4566
4567 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4568
4569 @item -fexpensive-optimizations
4570 @opindex fexpensive-optimizations
4571 Perform a number of minor optimizations that are relatively expensive.
4572
4573 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4574
4575 @item -foptimize-register-move
4576 @itemx -fregmove
4577 @opindex foptimize-register-move
4578 @opindex fregmove
4579 Attempt to reassign register numbers in move instructions and as
4580 operands of other simple instructions in order to maximize the amount of
4581 register tying. This is especially helpful on machines with two-operand
4582 instructions.
4583
4584 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4585 optimization.
4586
4587 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4588
4589 @item -fdelayed-branch
4590 @opindex fdelayed-branch
4591 If supported for the target machine, attempt to reorder instructions
4592 to exploit instruction slots available after delayed branch
4593 instructions.
4594
4595 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4596
4597 @item -fschedule-insns
4598 @opindex fschedule-insns
4599 If supported for the target machine, attempt to reorder instructions to
4600 eliminate execution stalls due to required data being unavailable. This
4601 helps machines that have slow floating point or memory load instructions
4602 by allowing other instructions to be issued until the result of the load
4603 or floating point instruction is required.
4604
4605 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4606
4607 @item -fschedule-insns2
4608 @opindex fschedule-insns2
4609 Similar to @option{-fschedule-insns}, but requests an additional pass of
4610 instruction scheduling after register allocation has been done. This is
4611 especially useful on machines with a relatively small number of
4612 registers and where memory load instructions take more than one cycle.
4613
4614 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4615
4616 @item -fno-sched-interblock
4617 @opindex fno-sched-interblock
4618 Don't schedule instructions across basic blocks. This is normally
4619 enabled by default when scheduling before register allocation, i.e.@:
4620 with @option{-fschedule-insns} or at @option{-O2} or higher.
4621
4622 @item -fno-sched-spec
4623 @opindex fno-sched-spec
4624 Don't allow speculative motion of non-load instructions. This is normally
4625 enabled by default when scheduling before register allocation, i.e.@:
4626 with @option{-fschedule-insns} or at @option{-O2} or higher.
4627
4628 @item -fsched-spec-load
4629 @opindex fsched-spec-load
4630 Allow speculative motion of some load instructions. This only makes
4631 sense when scheduling before register allocation, i.e.@: with
4632 @option{-fschedule-insns} or at @option{-O2} or higher.
4633
4634 @item -fsched-spec-load-dangerous
4635 @opindex fsched-spec-load-dangerous
4636 Allow speculative motion of more load instructions. This only makes
4637 sense when scheduling before register allocation, i.e.@: with
4638 @option{-fschedule-insns} or at @option{-O2} or higher.
4639
4640 @item -fsched-stalled-insns=@var{n}
4641 @opindex fsched-stalled-insns
4642 Define how many insns (if any) can be moved prematurely from the queue
4643 of stalled insns into the ready list, during the second scheduling pass.
4644
4645 @item -fsched-stalled-insns-dep=@var{n}
4646 @opindex fsched-stalled-insns-dep
4647 Define how many insn groups (cycles) will be examined for a dependency
4648 on a stalled insn that is candidate for premature removal from the queue
4649 of stalled insns. Has an effect only during the second scheduling pass,
4650 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4651
4652 @item -fsched2-use-superblocks
4653 @opindex fsched2-use-superblocks
4654 When scheduling after register allocation, do use superblock scheduling
4655 algorithm. Superblock scheduling allows motion across basic block boundaries
4656 resulting on faster schedules. This option is experimental, as not all machine
4657 descriptions used by GCC model the CPU closely enough to avoid unreliable
4658 results from the algorithm.
4659
4660 This only makes sense when scheduling after register allocation, i.e.@: with
4661 @option{-fschedule-insns2} or at @option{-O2} or higher.
4662
4663 @item -fsched2-use-traces
4664 @opindex fsched2-use-traces
4665 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4666 allocation and additionally perform code duplication in order to increase the
4667 size of superblocks using tracer pass. See @option{-ftracer} for details on
4668 trace formation.
4669
4670 This mode should produce faster but significantly longer programs. Also
4671 without @option{-fbranch-probabilities} the traces constructed may not
4672 match the reality and hurt the performance. This only makes
4673 sense when scheduling after register allocation, i.e.@: with
4674 @option{-fschedule-insns2} or at @option{-O2} or higher.
4675
4676 @item -freschedule-modulo-scheduled-loops
4677 @opindex fscheduling-in-modulo-scheduled-loops
4678 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4679 we may want to prevent the later scheduling passes from changing its schedule, we use this
4680 option to control that.
4681
4682 @item -fcaller-saves
4683 @opindex fcaller-saves
4684 Enable values to be allocated in registers that will be clobbered by
4685 function calls, by emitting extra instructions to save and restore the
4686 registers around such calls. Such allocation is done only when it
4687 seems to result in better code than would otherwise be produced.
4688
4689 This option is always enabled by default on certain machines, usually
4690 those which have no call-preserved registers to use instead.
4691
4692 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4693
4694 @item -ftree-pre
4695 Perform Partial Redundancy Elimination (PRE) on trees. This flag is
4696 enabled by default at @option{-O2} and @option{-O3}.
4697
4698 @item -ftree-fre
4699 Perform Full Redundancy Elimination (FRE) on trees. The difference
4700 between FRE and PRE is that FRE only considers expressions
4701 that are computed on all paths leading to the redundant computation.
4702 This analysis faster than PRE, though it exposes fewer redundancies.
4703 This flag is enabled by default at @option{-O} and higher.
4704
4705 @item -ftree-salias
4706 Perform structural alias analysis on trees. This flag
4707 is enabled by default at @option{-O} and higher.
4708
4709 @item -ftree-sink
4710 Perform forward store motion on trees. This flag is
4711 enabled by default at @option{-O} and higher.
4712
4713 @item -ftree-ccp
4714 Perform sparse conditional constant propagation (CCP) on trees. This flag
4715 is enabled by default at @option{-O} and higher.
4716
4717 @item -ftree-dce
4718 Perform dead code elimination (DCE) on trees. This flag is enabled by
4719 default at @option{-O} and higher.
4720
4721 @item -ftree-dominator-opts
4722 Perform dead code elimination (DCE) on trees. This flag is enabled by
4723 default at @option{-O} and higher.
4724
4725 @item -ftree-ch
4726 Perform loop header copying on trees. This is beneficial since it increases
4727 effectiveness of code motion optimizations. It also saves one jump. This flag
4728 is enabled by default at @option{-O} and higher. It is not enabled
4729 for @option{-Os}, since it usually increases code size.
4730
4731 @item -ftree-loop-optimize
4732 Perform loop optimizations on trees. This flag is enabled by default
4733 at @option{-O} and higher.
4734
4735 @item -ftree-loop-linear
4736 Perform linear loop transformations on tree. This flag can improve cache
4737 performance and allow further loop optimizations to take place.
4738
4739 @item -ftree-lim
4740 Perform loop invariant motion on trees. This pass moves only invartiants that
4741 would be hard to handle on rtl level (function calls, operations that expand to
4742 nontrivial sequences of insns). With @option{-funswitch-loops} it also moves
4743 operands of conditions that are invariant out of the loop, so that we can use
4744 just trivial invariantness analysis in loop unswitching. The pass also includes
4745 store motion.
4746
4747 @item -fivcanon
4748 Create a canonical counter for number of iterations in the loop for that
4749 determining number of iterations requires complicated analysis. Later
4750 optimizations then may determine the number easily. Useful especially
4751 in connection with unrolling.
4752
4753 @item -fivopts
4754 Perform induction variable optimizations (strength reduction, induction
4755 variable merging and induction variable elimination) on trees.
4756
4757 @item -ftree-sra
4758 Perform scalar replacement of aggregates. This pass replaces structure
4759 references with scalars to prevent committing structures to memory too
4760 early. This flag is enabled by default at @option{-O} and higher.
4761
4762 @item -ftree-copyrename
4763 Perform copy renaming on trees. This pass attempts to rename compiler
4764 temporaries to other variables at copy locations, usually resulting in
4765 variable names which more closely resemble the original variables. This flag
4766 is enabled by default at @option{-O} and higher.
4767
4768 @item -ftree-ter
4769 Perform temporary expression replacement during the SSA->normal phase. Single
4770 use/single def temporaries are replaced at their use location with their
4771 defining expression. This results in non-GIMPLE code, but gives the expanders
4772 much more complex trees to work on resulting in better RTL generation. This is
4773 enabled by default at @option{-O} and higher.
4774
4775 @item -ftree-lrs
4776 Perform live range splitting during the SSA->normal phase. Distinct live
4777 ranges of a variable are split into unique variables, allowing for better
4778 optimization later. This is enabled by default at @option{-O} and higher.
4779
4780 @item -ftree-vectorize
4781 Perform loop vectorization on trees.
4782
4783 @item -ftracer
4784 @opindex ftracer
4785 Perform tail duplication to enlarge superblock size. This transformation
4786 simplifies the control flow of the function allowing other optimizations to do
4787 better job.
4788
4789 @item -funroll-loops
4790 @opindex funroll-loops
4791 Unroll loops whose number of iterations can be determined at compile
4792 time or upon entry to the loop. @option{-funroll-loops} implies both
4793 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}. This
4794 option makes code larger, and may or may not make it run faster.
4795
4796 @item -funroll-all-loops
4797 @opindex funroll-all-loops
4798 Unroll all loops, even if their number of iterations is uncertain when
4799 the loop is entered. This usually makes programs run more slowly.
4800 @option{-funroll-all-loops} implies the same options as
4801 @option{-funroll-loops},
4802
4803 @item -fsplit-ivs-in-unroller
4804 @opindex -fsplit-ivs-in-unroller
4805 Enables expressing of values of induction variables in later iterations
4806 of the unrolled loop using the value in the first iteration. This breaks
4807 long dependency chains, thus improving efficiency of the scheduling passes
4808 (for best results, @option{-fweb} should be used as well).
4809
4810 Combination of @option{-fweb} and CSE is often sufficient to obtain the
4811 same effect. However in cases the loop body is more complicated than
4812 a single basic block, this is not reliable. It also does not work at all
4813 on some of the architectures due to restrictions in the CSE pass.
4814
4815 This optimization is enabled by default.
4816
4817 @item -fvariable-expansion-in-unroller
4818 @opindex -fvariable-expansion-in-unroller
4819 With this option, the compiler will create multiple copies of some
4820 local variables when unrolling a loop which can result in superior code.
4821
4822 @item -fprefetch-loop-arrays
4823 @opindex fprefetch-loop-arrays
4824 If supported by the target machine, generate instructions to prefetch
4825 memory to improve the performance of loops that access large arrays.
4826
4827 These options may generate better or worse code; results are highly
4828 dependent on the structure of loops within the source code.
4829
4830 @item -fno-peephole
4831 @itemx -fno-peephole2
4832 @opindex fno-peephole
4833 @opindex fno-peephole2
4834 Disable any machine-specific peephole optimizations. The difference
4835 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4836 are implemented in the compiler; some targets use one, some use the
4837 other, a few use both.
4838
4839 @option{-fpeephole} is enabled by default.
4840 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4841
4842 @item -fno-guess-branch-probability
4843 @opindex fno-guess-branch-probability
4844 Do not guess branch probabilities using heuristics.
4845
4846 GCC will use heuristics to guess branch probabilities if they are
4847 not provided by profiling feedback (@option{-fprofile-arcs}). These
4848 heuristics are based on the control flow graph. If some branch probabilities
4849 are specified by @samp{__builtin_expect}, then the heuristics will be
4850 used to guess branch probabilities for the rest of the control flow graph,
4851 taking the @samp{__builtin_expect} info into account. The interactions
4852 between the heuristics and @samp{__builtin_expect} can be complex, and in
4853 some cases, it may be useful to disable the heuristics so that the effects
4854 of @samp{__builtin_expect} are easier to understand.
4855
4856 The default is @option{-fguess-branch-probability} at levels
4857 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4858
4859 @item -freorder-blocks
4860 @opindex freorder-blocks
4861 Reorder basic blocks in the compiled function in order to reduce number of
4862 taken branches and improve code locality.
4863
4864 Enabled at levels @option{-O2}, @option{-O3}.
4865
4866 @item -freorder-blocks-and-partition
4867 @opindex freorder-blocks-and-partition
4868 In addition to reordering basic blocks in the compiled function, in order
4869 to reduce number of taken branches, partitions hot and cold basic blocks
4870 into separate sections of the assembly and .o files, to improve
4871 paging and cache locality performance.
4872
4873 This optimization is automatically turned off in the presence of
4874 exception handling, for linkonce sections, for functions with a user-defined
4875 section attribute and on any architecture that does not support named
4876 sections.
4877
4878 @item -freorder-functions
4879 @opindex freorder-functions
4880 Reorder functions in the object file in order to
4881 improve code locality. This is implemented by using special
4882 subsections @code{.text.hot} for most frequently executed functions and
4883 @code{.text.unlikely} for unlikely executed functions. Reordering is done by
4884 the linker so object file format must support named sections and linker must
4885 place them in a reasonable way.
4886
4887 Also profile feedback must be available in to make this option effective. See
4888 @option{-fprofile-arcs} for details.
4889
4890 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4891
4892 @item -fstrict-aliasing
4893 @opindex fstrict-aliasing
4894 Allows the compiler to assume the strictest aliasing rules applicable to
4895 the language being compiled. For C (and C++), this activates
4896 optimizations based on the type of expressions. In particular, an
4897 object of one type is assumed never to reside at the same address as an
4898 object of a different type, unless the types are almost the same. For
4899 example, an @code{unsigned int} can alias an @code{int}, but not a
4900 @code{void*} or a @code{double}. A character type may alias any other
4901 type.
4902
4903 Pay special attention to code like this:
4904 @smallexample
4905 union a_union @{
4906 int i;
4907 double d;
4908 @};
4909
4910 int f() @{
4911 a_union t;
4912 t.d = 3.0;
4913 return t.i;
4914 @}
4915 @end smallexample
4916 The practice of reading from a different union member than the one most
4917 recently written to (called ``type-punning'') is common. Even with
4918 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4919 is accessed through the union type. So, the code above will work as
4920 expected. However, this code might not:
4921 @smallexample
4922 int f() @{
4923 a_union t;
4924 int* ip;
4925 t.d = 3.0;
4926 ip = &t.i;
4927 return *ip;
4928 @}
4929 @end smallexample
4930
4931 Every language that wishes to perform language-specific alias analysis
4932 should define a function that computes, given an @code{tree}
4933 node, an alias set for the node. Nodes in different alias sets are not
4934 allowed to alias. For an example, see the C front-end function
4935 @code{c_get_alias_set}.
4936
4937 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4938
4939 @item -falign-functions
4940 @itemx -falign-functions=@var{n}
4941 @opindex falign-functions
4942 Align the start of functions to the next power-of-two greater than
4943 @var{n}, skipping up to @var{n} bytes. For instance,
4944 @option{-falign-functions=32} aligns functions to the next 32-byte
4945 boundary, but @option{-falign-functions=24} would align to the next
4946 32-byte boundary only if this can be done by skipping 23 bytes or less.
4947
4948 @option{-fno-align-functions} and @option{-falign-functions=1} are
4949 equivalent and mean that functions will not be aligned.
4950
4951 Some assemblers only support this flag when @var{n} is a power of two;
4952 in that case, it is rounded up.
4953
4954 If @var{n} is not specified or is zero, use a machine-dependent default.
4955
4956 Enabled at levels @option{-O2}, @option{-O3}.
4957
4958 @item -falign-labels
4959 @itemx -falign-labels=@var{n}
4960 @opindex falign-labels
4961 Align all branch targets to a power-of-two boundary, skipping up to
4962 @var{n} bytes like @option{-falign-functions}. This option can easily
4963 make code slower, because it must insert dummy operations for when the
4964 branch target is reached in the usual flow of the code.
4965
4966 @option{-fno-align-labels} and @option{-falign-labels=1} are
4967 equivalent and mean that labels will not be aligned.
4968
4969 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4970 are greater than this value, then their values are used instead.
4971
4972 If @var{n} is not specified or is zero, use a machine-dependent default
4973 which is very likely to be @samp{1}, meaning no alignment.
4974
4975 Enabled at levels @option{-O2}, @option{-O3}.
4976
4977 @item -falign-loops
4978 @itemx -falign-loops=@var{n}
4979 @opindex falign-loops
4980 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4981 like @option{-falign-functions}. The hope is that the loop will be
4982 executed many times, which will make up for any execution of the dummy
4983 operations.
4984
4985 @option{-fno-align-loops} and @option{-falign-loops=1} are
4986 equivalent and mean that loops will not be aligned.
4987
4988 If @var{n} is not specified or is zero, use a machine-dependent default.
4989
4990 Enabled at levels @option{-O2}, @option{-O3}.
4991
4992 @item -falign-jumps
4993 @itemx -falign-jumps=@var{n}
4994 @opindex falign-jumps
4995 Align branch targets to a power-of-two boundary, for branch targets
4996 where the targets can only be reached by jumping, skipping up to @var{n}
4997 bytes like @option{-falign-functions}. In this case, no dummy operations
4998 need be executed.
4999
5000 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5001 equivalent and mean that loops will not be aligned.
5002
5003 If @var{n} is not specified or is zero, use a machine-dependent default.
5004
5005 Enabled at levels @option{-O2}, @option{-O3}.
5006
5007 @item -funit-at-a-time
5008 @opindex funit-at-a-time
5009 Parse the whole compilation unit before starting to produce code.
5010 This allows some extra optimizations to take place but consumes
5011 more memory (in general). There are some compatibility issues
5012 with @emph{unit-at-at-time} mode:
5013 @itemize @bullet
5014 @item
5015 enabling @emph{unit-at-a-time} mode may change the order
5016 in which functions, variables, and top-level @code{asm} statements
5017 are emitted, and will likely break code relying on some particular
5018 ordering. The majority of such top-level @code{asm} statements,
5019 though, can be replaced by @code{section} attributes.
5020
5021 @item
5022 @emph{unit-at-a-time} mode removes unreferenced static variables
5023 and functions are removed. This may result in undefined references
5024 when an @code{asm} statement refers directly to variables or functions
5025 that are otherwise unused. In that case either the variable/function
5026 shall be listed as an operand of the @code{asm} statement operand or,
5027 in the case of top-level @code{asm} statements the attribute @code{used}
5028 shall be used on the declaration.
5029
5030 @item
5031 Static functions now can use non-standard passing conventions that
5032 may break @code{asm} statements calling functions directly. Again,
5033 attribute @code{used} will prevent this behavior.
5034 @end itemize
5035
5036 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5037 but this scheme may not be supported by future releases of GCC@.
5038
5039 Enabled at levels @option{-O2}, @option{-O3}.
5040
5041 @item -fweb
5042 @opindex fweb
5043 Constructs webs as commonly used for register allocation purposes and assign
5044 each web individual pseudo register. This allows the register allocation pass
5045 to operate on pseudos directly, but also strengthens several other optimization
5046 passes, such as CSE, loop optimizer and trivial dead code remover. It can,
5047 however, make debugging impossible, since variables will no longer stay in a
5048 ``home register''.
5049
5050 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os},
5051 on targets where the default format for debugging information supports
5052 variable tracking.
5053
5054 @item -fno-cprop-registers
5055 @opindex fno-cprop-registers
5056 After register allocation and post-register allocation instruction splitting,
5057 we perform a copy-propagation pass to try to reduce scheduling dependencies
5058 and occasionally eliminate the copy.
5059
5060 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5061
5062 @item -fprofile-generate
5063 @opindex fprofile-generate
5064
5065 Enable options usually used for instrumenting application to produce
5066 profile useful for later recompilation with profile feedback based
5067 optimization. You must use @option{-fprofile-generate} both when
5068 compiling and when linking your program.
5069
5070 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5071
5072 @item -fprofile-use
5073 @opindex fprofile-use
5074 Enable profile feedback directed optimizations, and optimizations
5075 generally profitable only with profile feedback available.
5076
5077 The following options are enabled: @code{-fbranch-probabilities},
5078 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
5079
5080 @end table
5081
5082 The following options control compiler behavior regarding floating
5083 point arithmetic. These options trade off between speed and
5084 correctness. All must be specifically enabled.
5085
5086 @table @gcctabopt
5087 @item -ffloat-store
5088 @opindex ffloat-store
5089 Do not store floating point variables in registers, and inhibit other
5090 options that might change whether a floating point value is taken from a
5091 register or memory.
5092
5093 @cindex floating point precision
5094 This option prevents undesirable excess precision on machines such as
5095 the 68000 where the floating registers (of the 68881) keep more
5096 precision than a @code{double} is supposed to have. Similarly for the
5097 x86 architecture. For most programs, the excess precision does only
5098 good, but a few programs rely on the precise definition of IEEE floating
5099 point. Use @option{-ffloat-store} for such programs, after modifying
5100 them to store all pertinent intermediate computations into variables.
5101
5102 @item -ffast-math
5103 @opindex ffast-math
5104 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5105 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5106 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5107 and @option{fcx-limited-range}.
5108
5109 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5110
5111 This option should never be turned on by any @option{-O} option since
5112 it can result in incorrect output for programs which depend on
5113 an exact implementation of IEEE or ISO rules/specifications for
5114 math functions.
5115
5116 @item -fno-math-errno
5117 @opindex fno-math-errno
5118 Do not set ERRNO after calling math functions that are executed
5119 with a single instruction, e.g., sqrt. A program that relies on
5120 IEEE exceptions for math error handling may want to use this flag
5121 for speed while maintaining IEEE arithmetic compatibility.
5122
5123 This option should never be turned on by any @option{-O} option since
5124 it can result in incorrect output for programs which depend on
5125 an exact implementation of IEEE or ISO rules/specifications for
5126 math functions.
5127
5128 The default is @option{-fmath-errno}.
5129
5130 @item -funsafe-math-optimizations
5131 @opindex funsafe-math-optimizations
5132 Allow optimizations for floating-point arithmetic that (a) assume
5133 that arguments and results are valid and (b) may violate IEEE or
5134 ANSI standards. When used at link-time, it may include libraries
5135 or startup files that change the default FPU control word or other
5136 similar optimizations.
5137
5138 This option should never be turned on by any @option{-O} option since
5139 it can result in incorrect output for programs which depend on
5140 an exact implementation of IEEE or ISO rules/specifications for
5141 math functions.
5142
5143 The default is @option{-fno-unsafe-math-optimizations}.
5144
5145 @item -ffinite-math-only
5146 @opindex ffinite-math-only
5147 Allow optimizations for floating-point arithmetic that assume
5148 that arguments and results are not NaNs or +-Infs.
5149
5150 This option should never be turned on by any @option{-O} option since
5151 it can result in incorrect output for programs which depend on
5152 an exact implementation of IEEE or ISO rules/specifications.
5153
5154 The default is @option{-fno-finite-math-only}.
5155
5156 @item -fno-trapping-math
5157 @opindex fno-trapping-math
5158 Compile code assuming that floating-point operations cannot generate
5159 user-visible traps. These traps include division by zero, overflow,
5160 underflow, inexact result and invalid operation. This option implies
5161 @option{-fno-signaling-nans}. Setting this option may allow faster
5162 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5163
5164 This option should never be turned on by any @option{-O} option since
5165 it can result in incorrect output for programs which depend on
5166 an exact implementation of IEEE or ISO rules/specifications for
5167 math functions.
5168
5169 The default is @option{-ftrapping-math}.
5170
5171 @item -frounding-math
5172 @opindex frounding-math
5173 Disable transformations and optimizations that assume default floating
5174 point rounding behavior. This is round-to-zero for all floating point
5175 to integer conversions, and round-to-nearest for all other arithmetic
5176 truncations. This option should be specified for programs that change
5177 the FP rounding mode dynamically, or that may be executed with a
5178 non-default rounding mode. This option disables constant folding of
5179 floating point expressions at compile-time (which may be affected by
5180 rounding mode) and arithmetic transformations that are unsafe in the
5181 presence of sign-dependent rounding modes.
5182
5183 The default is @option{-fno-rounding-math}.
5184
5185 This option is experimental and does not currently guarantee to
5186 disable all GCC optimizations that are affected by rounding mode.
5187 Future versions of GCC may provide finer control of this setting
5188 using C99's @code{FENV_ACCESS} pragma. This command line option
5189 will be used to specify the default state for @code{FENV_ACCESS}.
5190
5191 @item -fsignaling-nans
5192 @opindex fsignaling-nans
5193 Compile code assuming that IEEE signaling NaNs may generate user-visible
5194 traps during floating-point operations. Setting this option disables
5195 optimizations that may change the number of exceptions visible with
5196 signaling NaNs. This option implies @option{-ftrapping-math}.
5197
5198 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5199 be defined.
5200
5201 The default is @option{-fno-signaling-nans}.
5202
5203 This option is experimental and does not currently guarantee to
5204 disable all GCC optimizations that affect signaling NaN behavior.
5205
5206 @item -fsingle-precision-constant
5207 @opindex fsingle-precision-constant
5208 Treat floating point constant as single precision constant instead of
5209 implicitly converting it to double precision constant.
5210
5211 @item -fcx-limited-range
5212 @itemx -fno-cx-limited-range
5213 @opindex fcx-limited-range
5214 @opindex fno-cx-limited-range
5215 When enabled, this option states that a range reduction step is not
5216 needed when performing complex division. The default is
5217 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5218
5219 This option controls the default setting of the ISO C99
5220 @code{CX_LIMITED_RANGE} pragma. Nevertheless, the option applies to
5221 all languages.
5222
5223 @end table
5224
5225 The following options control optimizations that may improve
5226 performance, but are not enabled by any @option{-O} options. This
5227 section includes experimental options that may produce broken code.
5228
5229 @table @gcctabopt
5230 @item -fbranch-probabilities
5231 @opindex fbranch-probabilities
5232 After running a program compiled with @option{-fprofile-arcs}
5233 (@pxref{Debugging Options,, Options for Debugging Your Program or
5234 @command{gcc}}), you can compile it a second time using
5235 @option{-fbranch-probabilities}, to improve optimizations based on
5236 the number of times each branch was taken. When the program
5237 compiled with @option{-fprofile-arcs} exits it saves arc execution
5238 counts to a file called @file{@var{sourcename}.gcda} for each source
5239 file The information in this data file is very dependent on the
5240 structure of the generated code, so you must use the same source code
5241 and the same optimization options for both compilations.
5242
5243 With @option{-fbranch-probabilities}, GCC puts a
5244 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5245 These can be used to improve optimization. Currently, they are only
5246 used in one place: in @file{reorg.c}, instead of guessing which path a
5247 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5248 exactly determine which path is taken more often.
5249
5250 @item -fprofile-values
5251 @opindex fprofile-values
5252 If combined with @option{-fprofile-arcs}, it adds code so that some
5253 data about values of expressions in the program is gathered.
5254
5255 With @option{-fbranch-probabilities}, it reads back the data gathered
5256 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5257 notes to instructions for their later usage in optimizations.
5258
5259 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5260
5261 @item -fvpt
5262 @opindex fvpt
5263 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5264 a code to gather information about values of expressions.
5265
5266 With @option{-fbranch-probabilities}, it reads back the data gathered
5267 and actually performs the optimizations based on them.
5268 Currently the optimizations include specialization of division operation
5269 using the knowledge about the value of the denominator.
5270
5271 @item -fspeculative-prefetching
5272 @opindex fspeculative-prefetching
5273 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5274 a code to gather information about addresses of memory references in the
5275 program.
5276
5277 With @option{-fbranch-probabilities}, it reads back the data gathered
5278 and issues prefetch instructions according to them. In addition to the opportunities
5279 noticed by @option{-fprefetch-loop-arrays}, it also notices more complicated
5280 memory access patterns---for example accesses to the data stored in linked
5281 list whose elements are usually allocated sequentially.
5282
5283 In order to prevent issuing double prefetches, usage of
5284 @option{-fspeculative-prefetching} implies @option{-fno-prefetch-loop-arrays}.
5285
5286 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5287
5288 @item -frename-registers
5289 @opindex frename-registers
5290 Attempt to avoid false dependencies in scheduled code by making use
5291 of registers left over after register allocation. This optimization
5292 will most benefit processors with lots of registers. Depending on the
5293 debug information format adopted by the target, however, it can
5294 make debugging impossible, since variables will no longer stay in
5295 a ``home register''.
5296
5297 Not enabled by default at any level because it has known bugs.
5298
5299 @item -ftracer
5300 @opindex ftracer
5301 Perform tail duplication to enlarge superblock size. This transformation
5302 simplifies the control flow of the function allowing other optimizations to do
5303 better job.
5304
5305 Enabled with @option{-fprofile-use}.
5306
5307 @item -funroll-loops
5308 @opindex funroll-loops
5309 Unroll loops whose number of iterations can be determined at compile time or
5310 upon entry to the loop. @option{-funroll-loops} implies
5311 @option{-frerun-cse-after-loop}. It also turns on complete loop peeling
5312 (i.e.@: complete removal of loops with small constant number of iterations).
5313 This option makes code larger, and may or may not make it run faster.
5314
5315 Enabled with @option{-fprofile-use}.
5316
5317 @item -funroll-all-loops
5318 @opindex funroll-all-loops
5319 Unroll all loops, even if their number of iterations is uncertain when
5320 the loop is entered. This usually makes programs run more slowly.
5321 @option{-funroll-all-loops} implies the same options as
5322 @option{-funroll-loops}.
5323
5324 @item -fpeel-loops
5325 @opindex fpeel-loops
5326 Peels the loops for that there is enough information that they do not
5327 roll much (from profile feedback). It also turns on complete loop peeling
5328 (i.e.@: complete removal of loops with small constant number of iterations).
5329
5330 Enabled with @option{-fprofile-use}.
5331
5332 @item -fmove-loop-invariants
5333 @opindex fmove-loop-invariants
5334 Enables the loop invariant motion pass in the new loop optimizer. Enabled
5335 at level @option{-O1}
5336
5337 @item -funswitch-loops
5338 @opindex funswitch-loops
5339 Move branches with loop invariant conditions out of the loop, with duplicates
5340 of the loop on both branches (modified according to result of the condition).
5341
5342 @item -fprefetch-loop-arrays
5343 @opindex fprefetch-loop-arrays
5344 If supported by the target machine, generate instructions to prefetch
5345 memory to improve the performance of loops that access large arrays.
5346
5347 Disabled at level @option{-Os}.
5348
5349 @item -ffunction-sections
5350 @itemx -fdata-sections
5351 @opindex ffunction-sections
5352 @opindex fdata-sections
5353 Place each function or data item into its own section in the output
5354 file if the target supports arbitrary sections. The name of the
5355 function or the name of the data item determines the section's name
5356 in the output file.
5357
5358 Use these options on systems where the linker can perform optimizations
5359 to improve locality of reference in the instruction space. Most systems
5360 using the ELF object format and SPARC processors running Solaris 2 have
5361 linkers with such optimizations. AIX may have these optimizations in
5362 the future.
5363
5364 Only use these options when there are significant benefits from doing
5365 so. When you specify these options, the assembler and linker will
5366 create larger object and executable files and will also be slower.
5367 You will not be able to use @code{gprof} on all systems if you
5368 specify this option and you may have problems with debugging if
5369 you specify both this option and @option{-g}.
5370
5371 @item -fbranch-target-load-optimize
5372 @opindex fbranch-target-load-optimize
5373 Perform branch target register load optimization before prologue / epilogue
5374 threading.
5375 The use of target registers can typically be exposed only during reload,
5376 thus hoisting loads out of loops and doing inter-block scheduling needs
5377 a separate optimization pass.
5378
5379 @item -fbranch-target-load-optimize2
5380 @opindex fbranch-target-load-optimize2
5381 Perform branch target register load optimization after prologue / epilogue
5382 threading.
5383
5384 @item -fbtr-bb-exclusive
5385 @opindex fbtr-bb-exclusive
5386 When performing branch target register load optimization, don't reuse
5387 branch target registers in within any basic block.
5388
5389 @item --param @var{name}=@var{value}
5390 @opindex param
5391 In some places, GCC uses various constants to control the amount of
5392 optimization that is done. For example, GCC will not inline functions
5393 that contain more that a certain number of instructions. You can
5394 control some of these constants on the command-line using the
5395 @option{--param} option.
5396
5397 The names of specific parameters, and the meaning of the values, are
5398 tied to the internals of the compiler, and are subject to change
5399 without notice in future releases.
5400
5401 In each case, the @var{value} is an integer. The allowable choices for
5402 @var{name} are given in the following table:
5403
5404 @table @gcctabopt
5405 @item sra-max-structure-size
5406 The maximum structure size, in bytes, at which the scalar replacement
5407 of aggregates (SRA) optimization will perform block copies. The
5408 default value, 0, implies that GCC will select the most appropriate
5409 size itself.
5410
5411 @item sra-field-structure-ratio
5412 The threshold ratio (as a percentage) between instantiated fields and
5413 the complete structure size. We say that if the ratio of the number
5414 of bytes in instantiated fields to the number of bytes in the complete
5415 structure exceeds this parameter, then block copies are not used. The
5416 default is 75.
5417
5418 @item max-crossjump-edges
5419 The maximum number of incoming edges to consider for crossjumping.
5420 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5421 the number of edges incoming to each block. Increasing values mean
5422 more aggressive optimization, making the compile time increase with
5423 probably small improvement in executable size.
5424
5425 @item min-crossjump-insns
5426 The minimum number of instructions which must be matched at the end
5427 of two blocks before crossjumping will be performed on them. This
5428 value is ignored in the case where all instructions in the block being
5429 crossjumped from are matched. The default value is 5.
5430
5431 @item max-goto-duplication-insns
5432 The maximum number of instructions to duplicate to a block that jumps
5433 to a computed goto. To avoid @math{O(N^2)} behavior in a number of
5434 passes, GCC factors computed gotos early in the compilation process,
5435 and unfactors them as late as possible. Only computed jumps at the
5436 end of a basic blocks with no more than max-goto-duplication-insns are
5437 unfactored. The default value is 8.
5438
5439 @item max-delay-slot-insn-search
5440 The maximum number of instructions to consider when looking for an
5441 instruction to fill a delay slot. If more than this arbitrary number of
5442 instructions is searched, the time savings from filling the delay slot
5443 will be minimal so stop searching. Increasing values mean more
5444 aggressive optimization, making the compile time increase with probably
5445 small improvement in executable run time.
5446
5447 @item max-delay-slot-live-search
5448 When trying to fill delay slots, the maximum number of instructions to
5449 consider when searching for a block with valid live register
5450 information. Increasing this arbitrarily chosen value means more
5451 aggressive optimization, increasing the compile time. This parameter
5452 should be removed when the delay slot code is rewritten to maintain the
5453 control-flow graph.
5454
5455 @item max-gcse-memory
5456 The approximate maximum amount of memory that will be allocated in
5457 order to perform the global common subexpression elimination
5458 optimization. If more memory than specified is required, the
5459 optimization will not be done.
5460
5461 @item max-gcse-passes
5462 The maximum number of passes of GCSE to run. The default is 1.
5463
5464 @item max-pending-list-length
5465 The maximum number of pending dependencies scheduling will allow
5466 before flushing the current state and starting over. Large functions
5467 with few branches or calls can create excessively large lists which
5468 needlessly consume memory and resources.
5469
5470 @item max-inline-insns-single
5471 Several parameters control the tree inliner used in gcc.
5472 This number sets the maximum number of instructions (counted in GCC's
5473 internal representation) in a single function that the tree inliner
5474 will consider for inlining. This only affects functions declared
5475 inline and methods implemented in a class declaration (C++).
5476 The default value is 500.
5477
5478 @item max-inline-insns-auto
5479 When you use @option{-finline-functions} (included in @option{-O3}),
5480 a lot of functions that would otherwise not be considered for inlining
5481 by the compiler will be investigated. To those functions, a different
5482 (more restrictive) limit compared to functions declared inline can
5483 be applied.
5484 The default value is 120.
5485
5486 @item large-function-insns
5487 The limit specifying really large functions. For functions larger than this
5488 limit after inlining inlining is constrained by
5489 @option{--param large-function-growth}. This parameter is useful primarily
5490 to avoid extreme compilation time caused by non-linear algorithms used by the
5491 backend.
5492 This parameter is ignored when @option{-funit-at-a-time} is not used.
5493 The default value is 3000.
5494
5495 @item large-function-growth
5496 Specifies maximal growth of large function caused by inlining in percents.
5497 This parameter is ignored when @option{-funit-at-a-time} is not used.
5498 The default value is 100 which limits large function growth to 2.0 times
5499 the original size.
5500
5501 @item inline-unit-growth
5502 Specifies maximal overall growth of the compilation unit caused by inlining.
5503 This parameter is ignored when @option{-funit-at-a-time} is not used.
5504 The default value is 50 which limits unit growth to 1.5 times the original
5505 size.
5506
5507 @item max-inline-insns-recursive
5508 @itemx max-inline-insns-recursive-auto
5509 Specifies maximum number of instructions out-of-line copy of self recursive inline
5510 function can grow into by performing recursive inlining.
5511
5512 For functions declared inline @option{--param max-inline-insns-recursive} is
5513 taken into acount. For function not declared inline, recursive inlining
5514 happens only when @option{-finline-functions} (included in @option{-O3}) is
5515 enabled and @option{--param max-inline-insns-recursive-auto} is used. The
5516 default value is 500.
5517
5518 @item max-inline-recursive-depth
5519 @itemx max-inline-recursive-depth-auto
5520 Specifies maximum recursion depth used by the recursive inlining.
5521
5522 For functions declared inline @option{--param max-inline-recursive-depth} is
5523 taken into acount. For function not declared inline, recursive inlining
5524 happens only when @option{-finline-functions} (included in @option{-O3}) is
5525 enabled and @option{--param max-inline-recursive-depth-auto} is used. The
5526 default value is 500.
5527
5528 @item max-unrolled-insns
5529 The maximum number of instructions that a loop should have if that loop
5530 is unrolled, and if the loop is unrolled, it determines how many times
5531 the loop code is unrolled.
5532
5533 @item max-average-unrolled-insns
5534 The maximum number of instructions biased by probabilities of their execution
5535 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5536 it determines how many times the loop code is unrolled.
5537
5538 @item max-unroll-times
5539 The maximum number of unrollings of a single loop.
5540
5541 @item max-peeled-insns
5542 The maximum number of instructions that a loop should have if that loop
5543 is peeled, and if the loop is peeled, it determines how many times
5544 the loop code is peeled.
5545
5546 @item max-peel-times
5547 The maximum number of peelings of a single loop.
5548
5549 @item max-completely-peeled-insns
5550 The maximum number of insns of a completely peeled loop.
5551
5552 @item max-completely-peel-times
5553 The maximum number of iterations of a loop to be suitable for complete peeling.
5554
5555 @item max-unswitch-insns
5556 The maximum number of insns of an unswitched loop.
5557
5558 @item max-unswitch-level
5559 The maximum number of branches unswitched in a single loop.
5560
5561 @item lim-expensive
5562 The minimum cost of an expensive expression in the loop invariant motion.
5563
5564 @item iv-consider-all-candidates-bound
5565 Bound on number of candidates for induction variables below that
5566 all candidates are considered for each use in induction variable
5567 optimizations. Only the most relevant candidates are considered
5568 if there are more candidates, to avoid quadratic time complexity.
5569
5570 @item iv-max-considered-uses
5571 The induction variable optimizations give up on loops that contain more
5572 induction variable uses.
5573
5574 @item iv-always-prune-cand-set-bound
5575 If number of candidates in the set is smaller than this value,
5576 we always try to remove unnecessary ivs from the set during its
5577 optimization when a new iv is added to the set.
5578
5579 @item max-iterations-to-track
5580
5581 The maximum number of iterations of a loop the brute force algorithm
5582 for analysis of # of iterations of the loop tries to evaluate.
5583
5584 @item hot-bb-count-fraction
5585 Select fraction of the maximal count of repetitions of basic block in program
5586 given basic block needs to have to be considered hot.
5587
5588 @item hot-bb-frequency-fraction
5589 Select fraction of the maximal frequency of executions of basic block in
5590 function given basic block needs to have to be considered hot
5591
5592 @item tracer-dynamic-coverage
5593 @itemx tracer-dynamic-coverage-feedback
5594
5595 This value is used to limit superblock formation once the given percentage of
5596 executed instructions is covered. This limits unnecessary code size
5597 expansion.
5598
5599 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5600 feedback is available. The real profiles (as opposed to statically estimated
5601 ones) are much less balanced allowing the threshold to be larger value.
5602
5603 @item tracer-max-code-growth
5604 Stop tail duplication once code growth has reached given percentage. This is
5605 rather hokey argument, as most of the duplicates will be eliminated later in
5606 cross jumping, so it may be set to much higher values than is the desired code
5607 growth.
5608
5609 @item tracer-min-branch-ratio
5610
5611 Stop reverse growth when the reverse probability of best edge is less than this
5612 threshold (in percent).
5613
5614 @item tracer-min-branch-ratio
5615 @itemx tracer-min-branch-ratio-feedback
5616
5617 Stop forward growth if the best edge do have probability lower than this
5618 threshold.
5619
5620 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5621 compilation for profile feedback and one for compilation without. The value
5622 for compilation with profile feedback needs to be more conservative (higher) in
5623 order to make tracer effective.
5624
5625 @item max-cse-path-length
5626
5627 Maximum number of basic blocks on path that cse considers. The default is 10.
5628
5629 @item global-var-threshold
5630
5631 Counts the number of function calls (@var{n}) and the number of
5632 call-clobbered variables (@var{v}). If @var{n}x@var{v} is larger than this limit, a
5633 single artificial variable will be created to represent all the
5634 call-clobbered variables at function call sites. This artificial
5635 variable will then be made to alias every call-clobbered variable.
5636 (done as @code{int * size_t} on the host machine; beware overflow).
5637
5638 @item max-aliased-vops
5639
5640 Maximum number of virtual operands allowed to represent aliases
5641 before triggering the alias grouping heuristic. Alias grouping
5642 reduces compile times and memory consumption needed for aliasing at
5643 the expense of precision loss in alias information.
5644
5645 @item ggc-min-expand
5646
5647 GCC uses a garbage collector to manage its own memory allocation. This
5648 parameter specifies the minimum percentage by which the garbage
5649 collector's heap should be allowed to expand between collections.
5650 Tuning this may improve compilation speed; it has no effect on code
5651 generation.
5652
5653 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5654 RAM >= 1GB@. If @code{getrlimit} is available, the notion of "RAM" is
5655 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}. If
5656 GCC is not able to calculate RAM on a particular platform, the lower
5657 bound of 30% is used. Setting this parameter and
5658 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5659 every opportunity. This is extremely slow, but can be useful for
5660 debugging.
5661
5662 @item ggc-min-heapsize
5663
5664 Minimum size of the garbage collector's heap before it begins bothering
5665 to collect garbage. The first collection occurs after the heap expands
5666 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}. Again,
5667 tuning this may improve compilation speed, and has no effect on code
5668 generation.
5669
5670 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5671 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5672 with a lower bound of 4096 (four megabytes) and an upper bound of
5673 131072 (128 megabytes). If GCC is not able to calculate RAM on a
5674 particular platform, the lower bound is used. Setting this parameter
5675 very large effectively disables garbage collection. Setting this
5676 parameter and @option{ggc-min-expand} to zero causes a full collection
5677 to occur at every opportunity.
5678
5679 @item max-reload-search-insns
5680 The maximum number of instruction reload should look backward for equivalent
5681 register. Increasing values mean more aggressive optimization, making the
5682 compile time increase with probably slightly better performance. The default
5683 value is 100.
5684
5685 @item max-cselib-memory-location
5686 The maximum number of memory locations cselib should take into acount.
5687 Increasing values mean more aggressive optimization, making the compile time
5688 increase with probably slightly better performance. The default value is 500.
5689
5690 @item reorder-blocks-duplicate
5691 @itemx reorder-blocks-duplicate-feedback
5692
5693 Used by basic block reordering pass to decide whether to use unconditional
5694 branch or duplicate the code on its destination. Code is duplicated when its
5695 estimated size is smaller than this value multiplied by the estimated size of
5696 unconditional jump in the hot spots of the program.
5697
5698 The @option{reorder-block-duplicate-feedback} is used only when profile
5699 feedback is available and may be set to higher values than
5700 @option{reorder-block-duplicate} since information about the hot spots is more
5701 accurate.
5702
5703 @item max-sched-region-blocks
5704 The maximum number of blocks in a region to be considered for
5705 interblock scheduling. The default value is 10.
5706
5707 @item max-sched-region-insns
5708 The maximum number of insns in a region to be considered for
5709 interblock scheduling. The default value is 100.
5710
5711 @item max-last-value-rtl
5712
5713 The maximum size measured as number of RTLs that can be recorded in an expression
5714 in combiner for a pseudo register as last known value of that register. The default
5715 is 10000.
5716
5717 @item integer-share-limit
5718 Small integer constants can use a shared data structure, reducing the
5719 compiler's memory usage and increasing its speed. This sets the maximum
5720 value of a shared integer constant's. The default value is 256.
5721
5722 @end table
5723 @end table
5724
5725 @node Preprocessor Options
5726 @section Options Controlling the Preprocessor
5727 @cindex preprocessor options
5728 @cindex options, preprocessor
5729
5730 These options control the C preprocessor, which is run on each C source
5731 file before actual compilation.
5732
5733 If you use the @option{-E} option, nothing is done except preprocessing.
5734 Some of these options make sense only together with @option{-E} because
5735 they cause the preprocessor output to be unsuitable for actual
5736 compilation.
5737
5738 @table @gcctabopt
5739 @opindex Wp
5740 You can use @option{-Wp,@var{option}} to bypass the compiler driver
5741 and pass @var{option} directly through to the preprocessor. If
5742 @var{option} contains commas, it is split into multiple options at the
5743 commas. However, many options are modified, translated or interpreted
5744 by the compiler driver before being passed to the preprocessor, and
5745 @option{-Wp} forcibly bypasses this phase. The preprocessor's direct
5746 interface is undocumented and subject to change, so whenever possible
5747 you should avoid using @option{-Wp} and let the driver handle the
5748 options instead.
5749
5750 @item -Xpreprocessor @var{option}
5751 @opindex preprocessor
5752 Pass @var{option} as an option to the preprocessor. You can use this to
5753 supply system-specific preprocessor options which GCC does not know how to
5754 recognize.
5755
5756 If you want to pass an option that takes an argument, you must use
5757 @option{-Xpreprocessor} twice, once for the option and once for the argument.
5758 @end table
5759
5760 @include cppopts.texi
5761
5762 @node Assembler Options
5763 @section Passing Options to the Assembler
5764
5765 @c prevent bad page break with this line
5766 You can pass options to the assembler.
5767
5768 @table @gcctabopt
5769 @item -Wa,@var{option}
5770 @opindex Wa
5771 Pass @var{option} as an option to the assembler. If @var{option}
5772 contains commas, it is split into multiple options at the commas.
5773
5774 @item -Xassembler @var{option}
5775 @opindex Xassembler
5776 Pass @var{option} as an option to the assembler. You can use this to
5777 supply system-specific assembler options which GCC does not know how to
5778 recognize.
5779
5780 If you want to pass an option that takes an argument, you must use
5781 @option{-Xassembler} twice, once for the option and once for the argument.
5782
5783 @end table
5784
5785 @node Link Options
5786 @section Options for Linking
5787 @cindex link options
5788 @cindex options, linking
5789
5790 These options come into play when the compiler links object files into
5791 an executable output file. They are meaningless if the compiler is
5792 not doing a link step.
5793
5794 @table @gcctabopt
5795 @cindex file names
5796 @item @var{object-file-name}
5797 A file name that does not end in a special recognized suffix is
5798 considered to name an object file or library. (Object files are
5799 distinguished from libraries by the linker according to the file
5800 contents.) If linking is done, these object files are used as input
5801 to the linker.
5802
5803 @item -c
5804 @itemx -S
5805 @itemx -E
5806 @opindex c
5807 @opindex S
5808 @opindex E
5809 If any of these options is used, then the linker is not run, and
5810 object file names should not be used as arguments. @xref{Overall
5811 Options}.
5812
5813 @cindex Libraries
5814 @item -l@var{library}
5815 @itemx -l @var{library}
5816 @opindex l
5817 Search the library named @var{library} when linking. (The second
5818 alternative with the library as a separate argument is only for
5819 POSIX compliance and is not recommended.)
5820
5821 It makes a difference where in the command you write this option; the
5822 linker searches and processes libraries and object files in the order they
5823 are specified. Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
5824 after file @file{foo.o} but before @file{bar.o}. If @file{bar.o} refers
5825 to functions in @samp{z}, those functions may not be loaded.
5826
5827 The linker searches a standard list of directories for the library,
5828 which is actually a file named @file{lib@var{library}.a}. The linker
5829 then uses this file as if it had been specified precisely by name.
5830
5831 The directories searched include several standard system directories
5832 plus any that you specify with @option{-L}.
5833
5834 Normally the files found this way are library files---archive files
5835 whose members are object files. The linker handles an archive file by
5836 scanning through it for members which define symbols that have so far
5837 been referenced but not defined. But if the file that is found is an
5838 ordinary object file, it is linked in the usual fashion. The only
5839 difference between using an @option{-l} option and specifying a file name
5840 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5841 and searches several directories.
5842
5843 @item -lobjc
5844 @opindex lobjc
5845 You need this special case of the @option{-l} option in order to
5846 link an Objective-C or Objective-C++ program.
5847
5848 @item -nostartfiles
5849 @opindex nostartfiles
5850 Do not use the standard system startup files when linking.
5851 The standard system libraries are used normally, unless @option{-nostdlib}
5852 or @option{-nodefaultlibs} is used.
5853
5854 @item -nodefaultlibs
5855 @opindex nodefaultlibs
5856 Do not use the standard system libraries when linking.
5857 Only the libraries you specify will be passed to the linker.
5858 The standard startup files are used normally, unless @option{-nostartfiles}
5859 is used. The compiler may generate calls to @code{memcmp},
5860 @code{memset}, @code{memcpy} and @code{memmove}.
5861 These entries are usually resolved by entries in
5862 libc. These entry points should be supplied through some other
5863 mechanism when this option is specified.
5864
5865 @item -nostdlib
5866 @opindex nostdlib
5867 Do not use the standard system startup files or libraries when linking.
5868 No startup files and only the libraries you specify will be passed to
5869 the linker. The compiler may generate calls to @code{memcmp}, @code{memset},
5870 @code{memcpy} and @code{memmove}.
5871 These entries are usually resolved by entries in
5872 libc. These entry points should be supplied through some other
5873 mechanism when this option is specified.
5874
5875 @cindex @option{-lgcc}, use with @option{-nostdlib}
5876 @cindex @option{-nostdlib} and unresolved references
5877 @cindex unresolved references and @option{-nostdlib}
5878 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5879 @cindex @option{-nodefaultlibs} and unresolved references
5880 @cindex unresolved references and @option{-nodefaultlibs}
5881 One of the standard libraries bypassed by @option{-nostdlib} and
5882 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5883 that GCC uses to overcome shortcomings of particular machines, or special
5884 needs for some languages.
5885 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5886 Collection (GCC) Internals},
5887 for more discussion of @file{libgcc.a}.)
5888 In most cases, you need @file{libgcc.a} even when you want to avoid
5889 other standard libraries. In other words, when you specify @option{-nostdlib}
5890 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5891 This ensures that you have no unresolved references to internal GCC
5892 library subroutines. (For example, @samp{__main}, used to ensure C++
5893 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5894 GNU Compiler Collection (GCC) Internals}.)
5895
5896 @item -pie
5897 @opindex pie
5898 Produce a position independent executable on targets which support it.
5899 For predictable results, you must also specify the same set of options
5900 that were used to generate code (@option{-fpie}, @option{-fPIE},
5901 or model suboptions) when you specify this option.
5902
5903 @item -s
5904 @opindex s
5905 Remove all symbol table and relocation information from the executable.
5906
5907 @item -static
5908 @opindex static
5909 On systems that support dynamic linking, this prevents linking with the shared
5910 libraries. On other systems, this option has no effect.
5911
5912 @item -shared
5913 @opindex shared
5914 Produce a shared object which can then be linked with other objects to
5915 form an executable. Not all systems support this option. For predictable
5916 results, you must also specify the same set of options that were used to
5917 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5918 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5919 needs to build supplementary stub code for constructors to work. On
5920 multi-libbed systems, @samp{gcc -shared} must select the correct support
5921 libraries to link against. Failing to supply the correct flags may lead
5922 to subtle defects. Supplying them in cases where they are not necessary
5923 is innocuous.}
5924
5925 @item -shared-libgcc
5926 @itemx -static-libgcc
5927 @opindex shared-libgcc
5928 @opindex static-libgcc
5929 On systems that provide @file{libgcc} as a shared library, these options
5930 force the use of either the shared or static version respectively.
5931 If no shared version of @file{libgcc} was built when the compiler was
5932 configured, these options have no effect.
5933
5934 There are several situations in which an application should use the
5935 shared @file{libgcc} instead of the static version. The most common
5936 of these is when the application wishes to throw and catch exceptions
5937 across different shared libraries. In that case, each of the libraries
5938 as well as the application itself should use the shared @file{libgcc}.
5939
5940 Therefore, the G++ and GCJ drivers automatically add
5941 @option{-shared-libgcc} whenever you build a shared library or a main
5942 executable, because C++ and Java programs typically use exceptions, so
5943 this is the right thing to do.
5944
5945 If, instead, you use the GCC driver to create shared libraries, you may
5946 find that they will not always be linked with the shared @file{libgcc}.
5947 If GCC finds, at its configuration time, that you have a non-GNU linker
5948 or a GNU linker that does not support option @option{--eh-frame-hdr},
5949 it will link the shared version of @file{libgcc} into shared libraries
5950 by default. Otherwise, it will take advantage of the linker and optimize
5951 away the linking with the shared version of @file{libgcc}, linking with
5952 the static version of libgcc by default. This allows exceptions to
5953 propagate through such shared libraries, without incurring relocation
5954 costs at library load time.
5955
5956 However, if a library or main executable is supposed to throw or catch
5957 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5958 for the languages used in the program, or using the option
5959 @option{-shared-libgcc}, such that it is linked with the shared
5960 @file{libgcc}.
5961
5962 @item -symbolic
5963 @opindex symbolic
5964 Bind references to global symbols when building a shared object. Warn
5965 about any unresolved references (unless overridden by the link editor
5966 option @samp{-Xlinker -z -Xlinker defs}). Only a few systems support
5967 this option.
5968
5969 @item -Xlinker @var{option}
5970 @opindex Xlinker
5971 Pass @var{option} as an option to the linker. You can use this to
5972 supply system-specific linker options which GCC does not know how to
5973 recognize.
5974
5975 If you want to pass an option that takes an argument, you must use
5976 @option{-Xlinker} twice, once for the option and once for the argument.
5977 For example, to pass @option{-assert definitions}, you must write
5978 @samp{-Xlinker -assert -Xlinker definitions}. It does not work to write
5979 @option{-Xlinker "-assert definitions"}, because this passes the entire
5980 string as a single argument, which is not what the linker expects.
5981
5982 @item -Wl,@var{option}
5983 @opindex Wl
5984 Pass @var{option} as an option to the linker. If @var{option} contains
5985 commas, it is split into multiple options at the commas.
5986
5987 @item -u @var{symbol}
5988 @opindex u
5989 Pretend the symbol @var{symbol} is undefined, to force linking of
5990 library modules to define it. You can use @option{-u} multiple times with
5991 different symbols to force loading of additional library modules.
5992 @end table
5993
5994 @node Directory Options
5995 @section Options for Directory Search
5996 @cindex directory options
5997 @cindex options, directory search
5998 @cindex search path
5999
6000 These options specify directories to search for header files, for
6001 libraries and for parts of the compiler:
6002
6003 @table @gcctabopt
6004 @item -I@var{dir}
6005 @opindex I
6006 Add the directory @var{dir} to the head of the list of directories to be
6007 searched for header files. This can be used to override a system header
6008 file, substituting your own version, since these directories are
6009 searched before the system header file directories. However, you should
6010 not use this option to add directories that contain vendor-supplied
6011 system header files (use @option{-isystem} for that). If you use more than
6012 one @option{-I} option, the directories are scanned in left-to-right
6013 order; the standard system directories come after.
6014
6015 If a standard system include directory, or a directory specified with
6016 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6017 option will be ignored. The directory will still be searched but as a
6018 system directory at its normal position in the system include chain.
6019 This is to ensure that GCC's procedure to fix buggy system headers and
6020 the ordering for the include_next directive are not inadvertently changed.
6021 If you really need to change the search order for system directories,
6022 use the @option{-nostdinc} and/or @option{-isystem} options.
6023
6024 @item -iquote@var{dir}
6025 @opindex iquote
6026 Add the directory @var{dir} to the head of the list of directories to
6027 be searched for header files only for the case of @samp{#include
6028 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6029 otherwise just like @option{-I}.
6030
6031 @item -L@var{dir}
6032 @opindex L
6033 Add directory @var{dir} to the list of directories to be searched
6034 for @option{-l}.
6035
6036 @item -B@var{prefix}
6037 @opindex B
6038 This option specifies where to find the executables, libraries,
6039 include files, and data files of the compiler itself.
6040
6041 The compiler driver program runs one or more of the subprograms
6042 @file{cpp}, @file{cc1}, @file{as} and @file{ld}. It tries
6043 @var{prefix} as a prefix for each program it tries to run, both with and
6044 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6045
6046 For each subprogram to be run, the compiler driver first tries the
6047 @option{-B} prefix, if any. If that name is not found, or if @option{-B}
6048 was not specified, the driver tries two standard prefixes, which are
6049 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}. If neither of
6050 those results in a file name that is found, the unmodified program
6051 name is searched for using the directories specified in your
6052 @env{PATH} environment variable.
6053
6054 The compiler will check to see if the path provided by the @option{-B}
6055 refers to a directory, and if necessary it will add a directory
6056 separator character at the end of the path.
6057
6058 @option{-B} prefixes that effectively specify directory names also apply
6059 to libraries in the linker, because the compiler translates these
6060 options into @option{-L} options for the linker. They also apply to
6061 includes files in the preprocessor, because the compiler translates these
6062 options into @option{-isystem} options for the preprocessor. In this case,
6063 the compiler appends @samp{include} to the prefix.
6064
6065 The run-time support file @file{libgcc.a} can also be searched for using
6066 the @option{-B} prefix, if needed. If it is not found there, the two
6067 standard prefixes above are tried, and that is all. The file is left
6068 out of the link if it is not found by those means.
6069
6070 Another way to specify a prefix much like the @option{-B} prefix is to use
6071 the environment variable @env{GCC_EXEC_PREFIX}. @xref{Environment
6072 Variables}.
6073
6074 As a special kludge, if the path provided by @option{-B} is
6075 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6076 9, then it will be replaced by @file{[dir/]include}. This is to help
6077 with boot-strapping the compiler.
6078
6079 @item -specs=@var{file}
6080 @opindex specs
6081 Process @var{file} after the compiler reads in the standard @file{specs}
6082 file, in order to override the defaults that the @file{gcc} driver
6083 program uses when determining what switches to pass to @file{cc1},
6084 @file{cc1plus}, @file{as}, @file{ld}, etc. More than one
6085 @option{-specs=@var{file}} can be specified on the command line, and they
6086 are processed in order, from left to right.
6087
6088 @item -I-
6089 @opindex I-
6090 This option has been deprecated. Please use @option{-iquote} instead for
6091 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6092 Any directories you specify with @option{-I} options before the @option{-I-}
6093 option are searched only for the case of @samp{#include "@var{file}"};
6094 they are not searched for @samp{#include <@var{file}>}.
6095
6096 If additional directories are specified with @option{-I} options after
6097 the @option{-I-}, these directories are searched for all @samp{#include}
6098 directives. (Ordinarily @emph{all} @option{-I} directories are used
6099 this way.)
6100
6101 In addition, the @option{-I-} option inhibits the use of the current
6102 directory (where the current input file came from) as the first search
6103 directory for @samp{#include "@var{file}"}. There is no way to
6104 override this effect of @option{-I-}. With @option{-I.} you can specify
6105 searching the directory which was current when the compiler was
6106 invoked. That is not exactly the same as what the preprocessor does
6107 by default, but it is often satisfactory.
6108
6109 @option{-I-} does not inhibit the use of the standard system directories
6110 for header files. Thus, @option{-I-} and @option{-nostdinc} are
6111 independent.
6112 @end table
6113
6114 @c man end
6115
6116 @node Spec Files
6117 @section Specifying subprocesses and the switches to pass to them
6118 @cindex Spec Files
6119
6120 @command{gcc} is a driver program. It performs its job by invoking a
6121 sequence of other programs to do the work of compiling, assembling and
6122 linking. GCC interprets its command-line parameters and uses these to
6123 deduce which programs it should invoke, and which command-line options
6124 it ought to place on their command lines. This behavior is controlled
6125 by @dfn{spec strings}. In most cases there is one spec string for each
6126 program that GCC can invoke, but a few programs have multiple spec
6127 strings to control their behavior. The spec strings built into GCC can
6128 be overridden by using the @option{-specs=} command-line switch to specify
6129 a spec file.
6130
6131 @dfn{Spec files} are plaintext files that are used to construct spec
6132 strings. They consist of a sequence of directives separated by blank
6133 lines. The type of directive is determined by the first non-whitespace
6134 character on the line and it can be one of the following:
6135
6136 @table @code
6137 @item %@var{command}
6138 Issues a @var{command} to the spec file processor. The commands that can
6139 appear here are:
6140
6141 @table @code
6142 @item %include <@var{file}>
6143 @cindex %include
6144 Search for @var{file} and insert its text at the current point in the
6145 specs file.
6146
6147 @item %include_noerr <@var{file}>
6148 @cindex %include_noerr
6149 Just like @samp{%include}, but do not generate an error message if the include
6150 file cannot be found.
6151
6152 @item %rename @var{old_name} @var{new_name}
6153 @cindex %rename
6154 Rename the spec string @var{old_name} to @var{new_name}.
6155
6156 @end table
6157
6158 @item *[@var{spec_name}]:
6159 This tells the compiler to create, override or delete the named spec
6160 string. All lines after this directive up to the next directive or
6161 blank line are considered to be the text for the spec string. If this
6162 results in an empty string then the spec will be deleted. (Or, if the
6163 spec did not exist, then nothing will happened.) Otherwise, if the spec
6164 does not currently exist a new spec will be created. If the spec does
6165 exist then its contents will be overridden by the text of this
6166 directive, unless the first character of that text is the @samp{+}
6167 character, in which case the text will be appended to the spec.
6168
6169 @item [@var{suffix}]:
6170 Creates a new @samp{[@var{suffix}] spec} pair. All lines after this directive
6171 and up to the next directive or blank line are considered to make up the
6172 spec string for the indicated suffix. When the compiler encounters an
6173 input file with the named suffix, it will processes the spec string in
6174 order to work out how to compile that file. For example:
6175
6176 @smallexample
6177 .ZZ:
6178 z-compile -input %i
6179 @end smallexample
6180
6181 This says that any input file whose name ends in @samp{.ZZ} should be
6182 passed to the program @samp{z-compile}, which should be invoked with the
6183 command-line switch @option{-input} and with the result of performing the
6184 @samp{%i} substitution. (See below.)
6185
6186 As an alternative to providing a spec string, the text that follows a
6187 suffix directive can be one of the following:
6188
6189 @table @code
6190 @item @@@var{language}
6191 This says that the suffix is an alias for a known @var{language}. This is
6192 similar to using the @option{-x} command-line switch to GCC to specify a
6193 language explicitly. For example:
6194
6195 @smallexample
6196 .ZZ:
6197 @@c++
6198 @end smallexample
6199
6200 Says that .ZZ files are, in fact, C++ source files.
6201
6202 @item #@var{name}
6203 This causes an error messages saying:
6204
6205 @smallexample
6206 @var{name} compiler not installed on this system.
6207 @end smallexample
6208 @end table
6209
6210 GCC already has an extensive list of suffixes built into it.
6211 This directive will add an entry to the end of the list of suffixes, but
6212 since the list is searched from the end backwards, it is effectively
6213 possible to override earlier entries using this technique.
6214
6215 @end table
6216
6217 GCC has the following spec strings built into it. Spec files can
6218 override these strings or create their own. Note that individual
6219 targets can also add their own spec strings to this list.
6220
6221 @smallexample
6222 asm Options to pass to the assembler
6223 asm_final Options to pass to the assembler post-processor
6224 cpp Options to pass to the C preprocessor
6225 cc1 Options to pass to the C compiler
6226 cc1plus Options to pass to the C++ compiler
6227 endfile Object files to include at the end of the link
6228 link Options to pass to the linker
6229 lib Libraries to include on the command line to the linker
6230 libgcc Decides which GCC support library to pass to the linker
6231 linker Sets the name of the linker
6232 predefines Defines to be passed to the C preprocessor
6233 signed_char Defines to pass to CPP to say whether @code{char} is signed
6234 by default
6235 startfile Object files to include at the start of the link
6236 @end smallexample
6237
6238 Here is a small example of a spec file:
6239
6240 @smallexample
6241 %rename lib old_lib
6242
6243 *lib:
6244 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6245 @end smallexample
6246
6247 This example renames the spec called @samp{lib} to @samp{old_lib} and
6248 then overrides the previous definition of @samp{lib} with a new one.
6249 The new definition adds in some extra command-line options before
6250 including the text of the old definition.
6251
6252 @dfn{Spec strings} are a list of command-line options to be passed to their
6253 corresponding program. In addition, the spec strings can contain
6254 @samp{%}-prefixed sequences to substitute variable text or to
6255 conditionally insert text into the command line. Using these constructs
6256 it is possible to generate quite complex command lines.
6257
6258 Here is a table of all defined @samp{%}-sequences for spec
6259 strings. Note that spaces are not generated automatically around the
6260 results of expanding these sequences. Therefore you can concatenate them
6261 together or combine them with constant text in a single argument.
6262
6263 @table @code
6264 @item %%
6265 Substitute one @samp{%} into the program name or argument.
6266
6267 @item %i
6268 Substitute the name of the input file being processed.
6269
6270 @item %b
6271 Substitute the basename of the input file being processed.
6272 This is the substring up to (and not including) the last period
6273 and not including the directory.
6274
6275 @item %B
6276 This is the same as @samp{%b}, but include the file suffix (text after
6277 the last period).
6278
6279 @item %d
6280 Marks the argument containing or following the @samp{%d} as a
6281 temporary file name, so that that file will be deleted if GCC exits
6282 successfully. Unlike @samp{%g}, this contributes no text to the
6283 argument.
6284
6285 @item %g@var{suffix}
6286 Substitute a file name that has suffix @var{suffix} and is chosen
6287 once per compilation, and mark the argument in the same way as
6288 @samp{%d}. To reduce exposure to denial-of-service attacks, the file
6289 name is now chosen in a way that is hard to predict even when previously
6290 chosen file names are known. For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6291 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}. @var{suffix} matches
6292 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6293 treated exactly as if @samp{%O} had been preprocessed. Previously, @samp{%g}
6294 was simply substituted with a file name chosen once per compilation,
6295 without regard to any appended suffix (which was therefore treated
6296 just like ordinary text), making such attacks more likely to succeed.
6297
6298 @item %u@var{suffix}
6299 Like @samp{%g}, but generates a new temporary file name even if
6300 @samp{%u@var{suffix}} was already seen.
6301
6302 @item %U@var{suffix}
6303 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6304 new one if there is no such last file name. In the absence of any
6305 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6306 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6307 would involve the generation of two distinct file names, one
6308 for each @samp{%g.s} and another for each @samp{%U.s}. Previously, @samp{%U} was
6309 simply substituted with a file name chosen for the previous @samp{%u},
6310 without regard to any appended suffix.
6311
6312 @item %j@var{suffix}
6313 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6314 writable, and if save-temps is off; otherwise, substitute the name
6315 of a temporary file, just like @samp{%u}. This temporary file is not
6316 meant for communication between processes, but rather as a junk
6317 disposal mechanism.
6318
6319 @item %|@var{suffix}
6320 @itemx %m@var{suffix}
6321 Like @samp{%g}, except if @option{-pipe} is in effect. In that case
6322 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6323 all. These are the two most common ways to instruct a program that it
6324 should read from standard input or write to standard output. If you
6325 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6326 construct: see for example @file{f/lang-specs.h}.
6327
6328 @item %.@var{SUFFIX}
6329 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6330 when it is subsequently output with @samp{%*}. @var{SUFFIX} is
6331 terminated by the next space or %.
6332
6333 @item %w
6334 Marks the argument containing or following the @samp{%w} as the
6335 designated output file of this compilation. This puts the argument
6336 into the sequence of arguments that @samp{%o} will substitute later.
6337
6338 @item %o
6339 Substitutes the names of all the output files, with spaces
6340 automatically placed around them. You should write spaces
6341 around the @samp{%o} as well or the results are undefined.
6342 @samp{%o} is for use in the specs for running the linker.
6343 Input files whose names have no recognized suffix are not compiled
6344 at all, but they are included among the output files, so they will
6345 be linked.
6346
6347 @item %O
6348 Substitutes the suffix for object files. Note that this is
6349 handled specially when it immediately follows @samp{%g, %u, or %U},
6350 because of the need for those to form complete file names. The
6351 handling is such that @samp{%O} is treated exactly as if it had already
6352 been substituted, except that @samp{%g, %u, and %U} do not currently
6353 support additional @var{suffix} characters following @samp{%O} as they would
6354 following, for example, @samp{.o}.
6355
6356 @item %p
6357 Substitutes the standard macro predefinitions for the
6358 current target machine. Use this when running @code{cpp}.
6359
6360 @item %P
6361 Like @samp{%p}, but puts @samp{__} before and after the name of each
6362 predefined macro, except for macros that start with @samp{__} or with
6363 @samp{_@var{L}}, where @var{L} is an uppercase letter. This is for ISO
6364 C@.
6365
6366 @item %I
6367 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6368 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6369 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6370 as necessary.
6371
6372 @item %s
6373 Current argument is the name of a library or startup file of some sort.
6374 Search for that file in a standard list of directories and substitute
6375 the full name found.
6376
6377 @item %e@var{str}
6378 Print @var{str} as an error message. @var{str} is terminated by a newline.
6379 Use this when inconsistent options are detected.
6380
6381 @item %(@var{name})
6382 Substitute the contents of spec string @var{name} at this point.
6383
6384 @item %[@var{name}]
6385 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6386
6387 @item %x@{@var{option}@}
6388 Accumulate an option for @samp{%X}.
6389
6390 @item %X
6391 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6392 spec string.
6393
6394 @item %Y
6395 Output the accumulated assembler options specified by @option{-Wa}.
6396
6397 @item %Z
6398 Output the accumulated preprocessor options specified by @option{-Wp}.
6399
6400 @item %a
6401 Process the @code{asm} spec. This is used to compute the
6402 switches to be passed to the assembler.
6403
6404 @item %A
6405 Process the @code{asm_final} spec. This is a spec string for
6406 passing switches to an assembler post-processor, if such a program is
6407 needed.
6408
6409 @item %l
6410 Process the @code{link} spec. This is the spec for computing the
6411 command line passed to the linker. Typically it will make use of the
6412 @samp{%L %G %S %D and %E} sequences.
6413
6414 @item %D
6415 Dump out a @option{-L} option for each directory that GCC believes might
6416 contain startup files. If the target supports multilibs then the
6417 current multilib directory will be prepended to each of these paths.
6418
6419 @item %L
6420 Process the @code{lib} spec. This is a spec string for deciding which
6421 libraries should be included on the command line to the linker.
6422
6423 @item %G
6424 Process the @code{libgcc} spec. This is a spec string for deciding
6425 which GCC support library should be included on the command line to the linker.
6426
6427 @item %S
6428 Process the @code{startfile} spec. This is a spec for deciding which
6429 object files should be the first ones passed to the linker. Typically
6430 this might be a file named @file{crt0.o}.
6431
6432 @item %E
6433 Process the @code{endfile} spec. This is a spec string that specifies
6434 the last object files that will be passed to the linker.
6435
6436 @item %C
6437 Process the @code{cpp} spec. This is used to construct the arguments
6438 to be passed to the C preprocessor.
6439
6440 @item %1
6441 Process the @code{cc1} spec. This is used to construct the options to be
6442 passed to the actual C compiler (@samp{cc1}).
6443
6444 @item %2
6445 Process the @code{cc1plus} spec. This is used to construct the options to be
6446 passed to the actual C++ compiler (@samp{cc1plus}).
6447
6448 @item %*
6449 Substitute the variable part of a matched option. See below.
6450 Note that each comma in the substituted string is replaced by
6451 a single space.
6452
6453 @item %<@code{S}
6454 Remove all occurrences of @code{-S} from the command line. Note---this
6455 command is position dependent. @samp{%} commands in the spec string
6456 before this one will see @code{-S}, @samp{%} commands in the spec string
6457 after this one will not.
6458
6459 @item %:@var{function}(@var{args})
6460 Call the named function @var{function}, passing it @var{args}.
6461 @var{args} is first processed as a nested spec string, then split
6462 into an argument vector in the usual fashion. The function returns
6463 a string which is processed as if it had appeared literally as part
6464 of the current spec.
6465
6466 The following built-in spec functions are provided:
6467
6468 @table @code
6469 @item @code{if-exists}
6470 The @code{if-exists} spec function takes one argument, an absolute
6471 pathname to a file. If the file exists, @code{if-exists} returns the
6472 pathname. Here is a small example of its usage:
6473
6474 @smallexample
6475 *startfile:
6476 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6477 @end smallexample
6478
6479 @item @code{if-exists-else}
6480 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6481 spec function, except that it takes two arguments. The first argument is
6482 an absolute pathname to a file. If the file exists, @code{if-exists-else}
6483 returns the pathname. If it does not exist, it returns the second argument.
6484 This way, @code{if-exists-else} can be used to select one file or another,
6485 based on the existence of the first. Here is a small example of its usage:
6486
6487 @smallexample
6488 *startfile:
6489 crt0%O%s %:if-exists(crti%O%s) \
6490 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6491 @end smallexample
6492
6493 @item @code{replace-outfile}
6494 The @code{replace-outfile} spec function takes two arguments. It looks for the
6495 first argument in the outfiles array and replaces it with the second argument. Here
6496 is a small example of its usage:
6497
6498 @smallexample
6499 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6500 @end smallexample
6501
6502 @end table
6503
6504 @item %@{@code{S}@}
6505 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6506 If that switch was not specified, this substitutes nothing. Note that
6507 the leading dash is omitted when specifying this option, and it is
6508 automatically inserted if the substitution is performed. Thus the spec
6509 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6510 and would output the command line option @option{-foo}.
6511
6512 @item %W@{@code{S}@}
6513 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6514 deleted on failure.
6515
6516 @item %@{@code{S}*@}
6517 Substitutes all the switches specified to GCC whose names start
6518 with @code{-S}, but which also take an argument. This is used for
6519 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6520 GCC considers @option{-o foo} as being
6521 one switch whose names starts with @samp{o}. %@{o*@} would substitute this
6522 text, including the space. Thus two arguments would be generated.
6523
6524 @item %@{@code{S}*&@code{T}*@}
6525 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6526 (the order of @code{S} and @code{T} in the spec is not significant).
6527 There can be any number of ampersand-separated variables; for each the
6528 wild card is optional. Useful for CPP as @samp{%@{D*&U*&A*@}}.
6529
6530 @item %@{@code{S}:@code{X}@}
6531 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6532
6533 @item %@{!@code{S}:@code{X}@}
6534 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6535
6536 @item %@{@code{S}*:@code{X}@}
6537 Substitutes @code{X} if one or more switches whose names start with
6538 @code{-S} are specified to GCC@. Normally @code{X} is substituted only
6539 once, no matter how many such switches appeared. However, if @code{%*}
6540 appears somewhere in @code{X}, then @code{X} will be substituted once
6541 for each matching switch, with the @code{%*} replaced by the part of
6542 that switch that matched the @code{*}.
6543
6544 @item %@{.@code{S}:@code{X}@}
6545 Substitutes @code{X}, if processing a file with suffix @code{S}.
6546
6547 @item %@{!.@code{S}:@code{X}@}
6548 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6549
6550 @item %@{@code{S}|@code{P}:@code{X}@}
6551 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6552 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6553 although they have a stronger binding than the @samp{|}. If @code{%*}
6554 appears in @code{X}, all of the alternatives must be starred, and only
6555 the first matching alternative is substituted.
6556
6557 For example, a spec string like this:
6558
6559 @smallexample
6560 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6561 @end smallexample
6562
6563 will output the following command-line options from the following input
6564 command-line options:
6565
6566 @smallexample
6567 fred.c -foo -baz
6568 jim.d -bar -boggle
6569 -d fred.c -foo -baz -boggle
6570 -d jim.d -bar -baz -boggle
6571 @end smallexample
6572
6573 @item %@{S:X; T:Y; :D@}
6574
6575 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6576 given to GCC, substitutes @code{Y}; else substitutes @code{D}. There can
6577 be as many clauses as you need. This may be combined with @code{.},
6578 @code{!}, @code{|}, and @code{*} as needed.
6579
6580
6581 @end table
6582
6583 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6584 construct may contain other nested @samp{%} constructs or spaces, or
6585 even newlines. They are processed as usual, as described above.
6586 Trailing white space in @code{X} is ignored. White space may also
6587 appear anywhere on the left side of the colon in these constructs,
6588 except between @code{.} or @code{*} and the corresponding word.
6589
6590 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6591 handled specifically in these constructs. If another value of
6592 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6593 @option{-W} switch is found later in the command line, the earlier
6594 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6595 just one letter, which passes all matching options.
6596
6597 The character @samp{|} at the beginning of the predicate text is used to
6598 indicate that a command should be piped to the following command, but
6599 only if @option{-pipe} is specified.
6600
6601 It is built into GCC which switches take arguments and which do not.
6602 (You might think it would be useful to generalize this to allow each
6603 compiler's spec to say which switches take arguments. But this cannot
6604 be done in a consistent fashion. GCC cannot even decide which input
6605 files have been specified without knowing which switches take arguments,
6606 and it must know which input files to compile in order to tell which
6607 compilers to run).
6608
6609 GCC also knows implicitly that arguments starting in @option{-l} are to be
6610 treated as compiler output files, and passed to the linker in their
6611 proper position among the other output files.
6612
6613 @c man begin OPTIONS
6614
6615 @node Target Options
6616 @section Specifying Target Machine and Compiler Version
6617 @cindex target options
6618 @cindex cross compiling
6619 @cindex specifying machine version
6620 @cindex specifying compiler version and target machine
6621 @cindex compiler version, specifying
6622 @cindex target machine, specifying
6623
6624 The usual way to run GCC is to run the executable called @file{gcc}, or
6625 @file{<machine>-gcc} when cross-compiling, or
6626 @file{<machine>-gcc-<version>} to run a version other than the one that
6627 was installed last. Sometimes this is inconvenient, so GCC provides
6628 options that will switch to another cross-compiler or version.
6629
6630 @table @gcctabopt
6631 @item -b @var{machine}
6632 @opindex b
6633 The argument @var{machine} specifies the target machine for compilation.
6634
6635 The value to use for @var{machine} is the same as was specified as the
6636 machine type when configuring GCC as a cross-compiler. For
6637 example, if a cross-compiler was configured with @samp{configure
6638 i386v}, meaning to compile for an 80386 running System V, then you
6639 would specify @option{-b i386v} to run that cross compiler.
6640
6641 @item -V @var{version}
6642 @opindex V
6643 The argument @var{version} specifies which version of GCC to run.
6644 This is useful when multiple versions are installed. For example,
6645 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6646 @end table
6647
6648 The @option{-V} and @option{-b} options work by running the
6649 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6650 use them if you can just run that directly.
6651
6652 @node Submodel Options
6653 @section Hardware Models and Configurations
6654 @cindex submodel options
6655 @cindex specifying hardware config
6656 @cindex hardware models and configurations, specifying
6657 @cindex machine dependent options
6658
6659 Earlier we discussed the standard option @option{-b} which chooses among
6660 different installed compilers for completely different target
6661 machines, such as VAX vs.@: 68000 vs.@: 80386.
6662
6663 In addition, each of these target machine types can have its own
6664 special options, starting with @samp{-m}, to choose among various
6665 hardware models or configurations---for example, 68010 vs 68020,
6666 floating coprocessor or none. A single installed version of the
6667 compiler can compile for any model or configuration, according to the
6668 options specified.
6669
6670 Some configurations of the compiler also support additional special
6671 options, usually for compatibility with other compilers on the same
6672 platform.
6673
6674 These options are defined by the macro @code{TARGET_SWITCHES} in the
6675 machine description. The default for the options is also defined by
6676 that macro, which enables you to change the defaults.
6677
6678 @c This list is ordered alphanumerically by subsection name.
6679 @c It should be the same order and spelling as these options are listed
6680 @c in Machine Dependent Options
6681
6682 @menu
6683 * ARC Options::
6684 * ARM Options::
6685 * AVR Options::
6686 * CRIS Options::
6687 * Darwin Options::
6688 * DEC Alpha Options::
6689 * DEC Alpha/VMS Options::
6690 * FRV Options::
6691 * H8/300 Options::
6692 * HPPA Options::
6693 * i386 and x86-64 Options::
6694 * IA-64 Options::
6695 * M32R/D Options::
6696 * M680x0 Options::
6697 * M68hc1x Options::
6698 * MCore Options::
6699 * MIPS Options::
6700 * MMIX Options::
6701 * MN10300 Options::
6702 * NS32K Options::
6703 * PDP-11 Options::
6704 * PowerPC Options::
6705 * RS/6000 and PowerPC Options::
6706 * S/390 and zSeries Options::
6707 * SH Options::
6708 * SPARC Options::
6709 * System V Options::
6710 * TMS320C3x/C4x Options::
6711 * V850 Options::
6712 * VAX Options::
6713 * x86-64 Options::
6714 * Xstormy16 Options::
6715 * Xtensa Options::
6716 * zSeries Options::
6717 @end menu
6718
6719 @node ARC Options
6720 @subsection ARC Options
6721 @cindex ARC Options
6722
6723 These options are defined for ARC implementations:
6724
6725 @table @gcctabopt
6726 @item -EL
6727 @opindex EL
6728 Compile code for little endian mode. This is the default.
6729
6730 @item -EB
6731 @opindex EB
6732 Compile code for big endian mode.
6733
6734 @item -mmangle-cpu
6735 @opindex mmangle-cpu
6736 Prepend the name of the cpu to all public symbol names.
6737 In multiple-processor systems, there are many ARC variants with different
6738 instruction and register set characteristics. This flag prevents code
6739 compiled for one cpu to be linked with code compiled for another.
6740 No facility exists for handling variants that are ``almost identical''.
6741 This is an all or nothing option.
6742
6743 @item -mcpu=@var{cpu}
6744 @opindex mcpu
6745 Compile code for ARC variant @var{cpu}.
6746 Which variants are supported depend on the configuration.
6747 All variants support @option{-mcpu=base}, this is the default.
6748
6749 @item -mtext=@var{text-section}
6750 @itemx -mdata=@var{data-section}
6751 @itemx -mrodata=@var{readonly-data-section}
6752 @opindex mtext
6753 @opindex mdata
6754 @opindex mrodata
6755 Put functions, data, and readonly data in @var{text-section},
6756 @var{data-section}, and @var{readonly-data-section} respectively
6757 by default. This can be overridden with the @code{section} attribute.
6758 @xref{Variable Attributes}.
6759
6760 @end table
6761
6762 @node ARM Options
6763 @subsection ARM Options
6764 @cindex ARM options
6765
6766 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6767 architectures:
6768
6769 @table @gcctabopt
6770 @item -mabi=@var{name}
6771 @opindex mabi
6772 Generate code for the specified ABI@. Permissible values are: @samp{apcs-gnu},
6773 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
6774
6775 @item -mapcs-frame
6776 @opindex mapcs-frame
6777 Generate a stack frame that is compliant with the ARM Procedure Call
6778 Standard for all functions, even if this is not strictly necessary for
6779 correct execution of the code. Specifying @option{-fomit-frame-pointer}
6780 with this option will cause the stack frames not to be generated for
6781 leaf functions. The default is @option{-mno-apcs-frame}.
6782
6783 @item -mapcs
6784 @opindex mapcs
6785 This is a synonym for @option{-mapcs-frame}.
6786
6787 @ignore
6788 @c not currently implemented
6789 @item -mapcs-stack-check
6790 @opindex mapcs-stack-check
6791 Generate code to check the amount of stack space available upon entry to
6792 every function (that actually uses some stack space). If there is
6793 insufficient space available then either the function
6794 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6795 called, depending upon the amount of stack space required. The run time
6796 system is required to provide these functions. The default is
6797 @option{-mno-apcs-stack-check}, since this produces smaller code.
6798
6799 @c not currently implemented
6800 @item -mapcs-float
6801 @opindex mapcs-float
6802 Pass floating point arguments using the float point registers. This is
6803 one of the variants of the APCS@. This option is recommended if the
6804 target hardware has a floating point unit or if a lot of floating point
6805 arithmetic is going to be performed by the code. The default is
6806 @option{-mno-apcs-float}, since integer only code is slightly increased in
6807 size if @option{-mapcs-float} is used.
6808
6809 @c not currently implemented
6810 @item -mapcs-reentrant
6811 @opindex mapcs-reentrant
6812 Generate reentrant, position independent code. The default is
6813 @option{-mno-apcs-reentrant}.
6814 @end ignore
6815
6816 @item -mthumb-interwork
6817 @opindex mthumb-interwork
6818 Generate code which supports calling between the ARM and Thumb
6819 instruction sets. Without this option the two instruction sets cannot
6820 be reliably used inside one program. The default is
6821 @option{-mno-thumb-interwork}, since slightly larger code is generated
6822 when @option{-mthumb-interwork} is specified.
6823
6824 @item -mno-sched-prolog
6825 @opindex mno-sched-prolog
6826 Prevent the reordering of instructions in the function prolog, or the
6827 merging of those instruction with the instructions in the function's
6828 body. This means that all functions will start with a recognizable set
6829 of instructions (or in fact one of a choice from a small set of
6830 different function prologues), and this information can be used to
6831 locate the start if functions inside an executable piece of code. The
6832 default is @option{-msched-prolog}.
6833
6834 @item -mhard-float
6835 @opindex mhard-float
6836 Generate output containing floating point instructions. This is the
6837 default.
6838
6839 @item -msoft-float
6840 @opindex msoft-float
6841 Generate output containing library calls for floating point.
6842 @strong{Warning:} the requisite libraries are not available for all ARM
6843 targets. Normally the facilities of the machine's usual C compiler are
6844 used, but this cannot be done directly in cross-compilation. You must make
6845 your own arrangements to provide suitable library functions for
6846 cross-compilation.
6847
6848 @option{-msoft-float} changes the calling convention in the output file;
6849 therefore, it is only useful if you compile @emph{all} of a program with
6850 this option. In particular, you need to compile @file{libgcc.a}, the
6851 library that comes with GCC, with @option{-msoft-float} in order for
6852 this to work.
6853
6854 @item -mfloat-abi=@var{name}
6855 @opindex mfloat-abi
6856 Specifies which ABI to use for floating point values. Permissible values
6857 are: @samp{soft}, @samp{softfp} and @samp{hard}.
6858
6859 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
6860 and @option{-mhard-float} respectively. @samp{softfp} allows the generation
6861 of floating point instructions, but still uses the soft-float calling
6862 conventions.
6863
6864 @item -mlittle-endian
6865 @opindex mlittle-endian
6866 Generate code for a processor running in little-endian mode. This is
6867 the default for all standard configurations.
6868
6869 @item -mbig-endian
6870 @opindex mbig-endian
6871 Generate code for a processor running in big-endian mode; the default is
6872 to compile code for a little-endian processor.
6873
6874 @item -mwords-little-endian
6875 @opindex mwords-little-endian
6876 This option only applies when generating code for big-endian processors.
6877 Generate code for a little-endian word order but a big-endian byte
6878 order. That is, a byte order of the form @samp{32107654}. Note: this
6879 option should only be used if you require compatibility with code for
6880 big-endian ARM processors generated by versions of the compiler prior to
6881 2.8.
6882
6883 @item -mcpu=@var{name}
6884 @opindex mcpu
6885 This specifies the name of the target ARM processor. GCC uses this name
6886 to determine what kind of instructions it can emit when generating
6887 assembly code. Permissible names are: @samp{arm2}, @samp{arm250},
6888 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6889 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6890 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6891 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6892 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
6893 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6894 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6895 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
6896 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
6897 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
6898 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
6899 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
6900 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
6901 @samp{ep9312}.
6902
6903 @itemx -mtune=@var{name}
6904 @opindex mtune
6905 This option is very similar to the @option{-mcpu=} option, except that
6906 instead of specifying the actual target processor type, and hence
6907 restricting which instructions can be used, it specifies that GCC should
6908 tune the performance of the code as if the target were of the type
6909 specified in this option, but still choosing the instructions that it
6910 will generate based on the cpu specified by a @option{-mcpu=} option.
6911 For some ARM implementations better performance can be obtained by using
6912 this option.
6913
6914 @item -march=@var{name}
6915 @opindex march
6916 This specifies the name of the target ARM architecture. GCC uses this
6917 name to determine what kind of instructions it can emit when generating
6918 assembly code. This option can be used in conjunction with or instead
6919 of the @option{-mcpu=} option. Permissible names are: @samp{armv2},
6920 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6921 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
6922 @samp{iwmmxt}, @samp{ep9312}.
6923
6924 @item -mfpu=@var{name}
6925 @itemx -mfpe=@var{number}
6926 @itemx -mfp=@var{number}
6927 @opindex mfpu
6928 @opindex mfpe
6929 @opindex mfp
6930 This specifies what floating point hardware (or hardware emulation) is
6931 available on the target. Permissible names are: @samp{fpa}, @samp{fpe2},
6932 @samp{fpe3}, @samp{maverick}, @samp{vfp}. @option{-mfp} and @option{-mfpe}
6933 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
6934 with older versions of GCC@.
6935
6936 If @option{-msoft-float} is specified this specifies the format of
6937 floating point values.
6938
6939 @item -mstructure-size-boundary=@var{n}
6940 @opindex mstructure-size-boundary
6941 The size of all structures and unions will be rounded up to a multiple
6942 of the number of bits set by this option. Permissible values are 8, 32
6943 and 64. The default value varies for different toolchains. For the COFF
6944 targeted toolchain the default value is 8. A value of 64 is only allowed
6945 if the underlying ABI supports it.
6946
6947 Specifying the larger number can produce faster, more efficient code, but
6948 can also increase the size of the program. Different values are potentially
6949 incompatible. Code compiled with one value cannot necessarily expect to
6950 work with code or libraries compiled with another value, if they exchange
6951 information using structures or unions.
6952
6953 @item -mabort-on-noreturn
6954 @opindex mabort-on-noreturn
6955 Generate a call to the function @code{abort} at the end of a
6956 @code{noreturn} function. It will be executed if the function tries to
6957 return.
6958
6959 @item -mlong-calls
6960 @itemx -mno-long-calls
6961 @opindex mlong-calls
6962 @opindex mno-long-calls
6963 Tells the compiler to perform function calls by first loading the
6964 address of the function into a register and then performing a subroutine
6965 call on this register. This switch is needed if the target function
6966 will lie outside of the 64 megabyte addressing range of the offset based
6967 version of subroutine call instruction.
6968
6969 Even if this switch is enabled, not all function calls will be turned
6970 into long calls. The heuristic is that static functions, functions
6971 which have the @samp{short-call} attribute, functions that are inside
6972 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6973 definitions have already been compiled within the current compilation
6974 unit, will not be turned into long calls. The exception to this rule is
6975 that weak function definitions, functions with the @samp{long-call}
6976 attribute or the @samp{section} attribute, and functions that are within
6977 the scope of a @samp{#pragma long_calls} directive, will always be
6978 turned into long calls.
6979
6980 This feature is not enabled by default. Specifying
6981 @option{-mno-long-calls} will restore the default behavior, as will
6982 placing the function calls within the scope of a @samp{#pragma
6983 long_calls_off} directive. Note these switches have no effect on how
6984 the compiler generates code to handle function calls via function
6985 pointers.
6986
6987 @item -mnop-fun-dllimport
6988 @opindex mnop-fun-dllimport
6989 Disable support for the @code{dllimport} attribute.
6990
6991 @item -msingle-pic-base
6992 @opindex msingle-pic-base
6993 Treat the register used for PIC addressing as read-only, rather than
6994 loading it in the prologue for each function. The run-time system is
6995 responsible for initializing this register with an appropriate value
6996 before execution begins.
6997
6998 @item -mpic-register=@var{reg}
6999 @opindex mpic-register
7000 Specify the register to be used for PIC addressing. The default is R10
7001 unless stack-checking is enabled, when R9 is used.
7002
7003 @item -mcirrus-fix-invalid-insns
7004 @opindex mcirrus-fix-invalid-insns
7005 @opindex mno-cirrus-fix-invalid-insns
7006 Insert NOPs into the instruction stream to in order to work around
7007 problems with invalid Maverick instruction combinations. This option
7008 is only valid if the @option{-mcpu=ep9312} option has been used to
7009 enable generation of instructions for the Cirrus Maverick floating
7010 point co-processor. This option is not enabled by default, since the
7011 problem is only present in older Maverick implementations. The default
7012 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7013 switch.
7014
7015 @item -mpoke-function-name
7016 @opindex mpoke-function-name
7017 Write the name of each function into the text section, directly
7018 preceding the function prologue. The generated code is similar to this:
7019
7020 @smallexample
7021 t0
7022 .ascii "arm_poke_function_name", 0
7023 .align
7024 t1
7025 .word 0xff000000 + (t1 - t0)
7026 arm_poke_function_name
7027 mov ip, sp
7028 stmfd sp!, @{fp, ip, lr, pc@}
7029 sub fp, ip, #4
7030 @end smallexample
7031
7032 When performing a stack backtrace, code can inspect the value of
7033 @code{pc} stored at @code{fp + 0}. If the trace function then looks at
7034 location @code{pc - 12} and the top 8 bits are set, then we know that
7035 there is a function name embedded immediately preceding this location
7036 and has length @code{((pc[-3]) & 0xff000000)}.
7037
7038 @item -mthumb
7039 @opindex mthumb
7040 Generate code for the 16-bit Thumb instruction set. The default is to
7041 use the 32-bit ARM instruction set.
7042
7043 @item -mtpcs-frame
7044 @opindex mtpcs-frame
7045 Generate a stack frame that is compliant with the Thumb Procedure Call
7046 Standard for all non-leaf functions. (A leaf function is one that does
7047 not call any other functions.) The default is @option{-mno-tpcs-frame}.
7048
7049 @item -mtpcs-leaf-frame
7050 @opindex mtpcs-leaf-frame
7051 Generate a stack frame that is compliant with the Thumb Procedure Call
7052 Standard for all leaf functions. (A leaf function is one that does
7053 not call any other functions.) The default is @option{-mno-apcs-leaf-frame}.
7054
7055 @item -mcallee-super-interworking
7056 @opindex mcallee-super-interworking
7057 Gives all externally visible functions in the file being compiled an ARM
7058 instruction set header which switches to Thumb mode before executing the
7059 rest of the function. This allows these functions to be called from
7060 non-interworking code.
7061
7062 @item -mcaller-super-interworking
7063 @opindex mcaller-super-interworking
7064 Allows calls via function pointers (including virtual functions) to
7065 execute correctly regardless of whether the target code has been
7066 compiled for interworking or not. There is a small overhead in the cost
7067 of executing a function pointer if this option is enabled.
7068
7069 @end table
7070
7071 @node AVR Options
7072 @subsection AVR Options
7073 @cindex AVR Options
7074
7075 These options are defined for AVR implementations:
7076
7077 @table @gcctabopt
7078 @item -mmcu=@var{mcu}
7079 @opindex mmcu
7080 Specify ATMEL AVR instruction set or MCU type.
7081
7082 Instruction set avr1 is for the minimal AVR core, not supported by the C
7083 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7084 attiny11, attiny12, attiny15, attiny28).
7085
7086 Instruction set avr2 (default) is for the classic AVR core with up to
7087 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7088 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7089 at90c8534, at90s8535).
7090
7091 Instruction set avr3 is for the classic AVR core with up to 128K program
7092 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7093
7094 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7095 memory space (MCU types: atmega8, atmega83, atmega85).
7096
7097 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7098 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7099 atmega64, atmega128, at43usb355, at94k).
7100
7101 @item -msize
7102 @opindex msize
7103 Output instruction sizes to the asm file.
7104
7105 @item -minit-stack=@var{N}
7106 @opindex minit-stack
7107 Specify the initial stack address, which may be a symbol or numeric value,
7108 @samp{__stack} is the default.
7109
7110 @item -mno-interrupts
7111 @opindex mno-interrupts
7112 Generated code is not compatible with hardware interrupts.
7113 Code size will be smaller.
7114
7115 @item -mcall-prologues
7116 @opindex mcall-prologues
7117 Functions prologues/epilogues expanded as call to appropriate
7118 subroutines. Code size will be smaller.
7119
7120 @item -mno-tablejump
7121 @opindex mno-tablejump
7122 Do not generate tablejump insns which sometimes increase code size.
7123
7124 @item -mtiny-stack
7125 @opindex mtiny-stack
7126 Change only the low 8 bits of the stack pointer.
7127
7128 @item -mint8
7129 @opindex mint8
7130 Assume int to be 8 bit integer. This affects the sizes of all types: A
7131 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7132 and long long will be 4 bytes. Please note that this option does not
7133 comply to the C standards, but it will provide you with smaller code
7134 size.
7135 @end table
7136
7137 @node CRIS Options
7138 @subsection CRIS Options
7139 @cindex CRIS Options
7140
7141 These options are defined specifically for the CRIS ports.
7142
7143 @table @gcctabopt
7144 @item -march=@var{architecture-type}
7145 @itemx -mcpu=@var{architecture-type}
7146 @opindex march
7147 @opindex mcpu
7148 Generate code for the specified architecture. The choices for
7149 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7150 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7151 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7152 @samp{v10}.
7153
7154 @item -mtune=@var{architecture-type}
7155 @opindex mtune
7156 Tune to @var{architecture-type} everything applicable about the generated
7157 code, except for the ABI and the set of available instructions. The
7158 choices for @var{architecture-type} are the same as for
7159 @option{-march=@var{architecture-type}}.
7160
7161 @item -mmax-stack-frame=@var{n}
7162 @opindex mmax-stack-frame
7163 Warn when the stack frame of a function exceeds @var{n} bytes.
7164
7165 @item -melinux-stacksize=@var{n}
7166 @opindex melinux-stacksize
7167 Only available with the @samp{cris-axis-aout} target. Arranges for
7168 indications in the program to the kernel loader that the stack of the
7169 program should be set to @var{n} bytes.
7170
7171 @item -metrax4
7172 @itemx -metrax100
7173 @opindex metrax4
7174 @opindex metrax100
7175 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7176 @option{-march=v3} and @option{-march=v8} respectively.
7177
7178 @item -mmul-bug-workaround
7179 @itemx -mno-mul-bug-workaround
7180 @opindex mmul-bug-workaround
7181 @opindex mno-mul-bug-workaround
7182 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7183 models where it applies. This option is active by default.
7184
7185 @item -mpdebug
7186 @opindex mpdebug
7187 Enable CRIS-specific verbose debug-related information in the assembly
7188 code. This option also has the effect to turn off the @samp{#NO_APP}
7189 formatted-code indicator to the assembler at the beginning of the
7190 assembly file.
7191
7192 @item -mcc-init
7193 @opindex mcc-init
7194 Do not use condition-code results from previous instruction; always emit
7195 compare and test instructions before use of condition codes.
7196
7197 @item -mno-side-effects
7198 @opindex mno-side-effects
7199 Do not emit instructions with side-effects in addressing modes other than
7200 post-increment.
7201
7202 @item -mstack-align
7203 @itemx -mno-stack-align
7204 @itemx -mdata-align
7205 @itemx -mno-data-align
7206 @itemx -mconst-align
7207 @itemx -mno-const-align
7208 @opindex mstack-align
7209 @opindex mno-stack-align
7210 @opindex mdata-align
7211 @opindex mno-data-align
7212 @opindex mconst-align
7213 @opindex mno-const-align
7214 These options (no-options) arranges (eliminate arrangements) for the
7215 stack-frame, individual data and constants to be aligned for the maximum
7216 single data access size for the chosen CPU model. The default is to
7217 arrange for 32-bit alignment. ABI details such as structure layout are
7218 not affected by these options.
7219
7220 @item -m32-bit
7221 @itemx -m16-bit
7222 @itemx -m8-bit
7223 @opindex m32-bit
7224 @opindex m16-bit
7225 @opindex m8-bit
7226 Similar to the stack- data- and const-align options above, these options
7227 arrange for stack-frame, writable data and constants to all be 32-bit,
7228 16-bit or 8-bit aligned. The default is 32-bit alignment.
7229
7230 @item -mno-prologue-epilogue
7231 @itemx -mprologue-epilogue
7232 @opindex mno-prologue-epilogue
7233 @opindex mprologue-epilogue
7234 With @option{-mno-prologue-epilogue}, the normal function prologue and
7235 epilogue that sets up the stack-frame are omitted and no return
7236 instructions or return sequences are generated in the code. Use this
7237 option only together with visual inspection of the compiled code: no
7238 warnings or errors are generated when call-saved registers must be saved,
7239 or storage for local variable needs to be allocated.
7240
7241 @item -mno-gotplt
7242 @itemx -mgotplt
7243 @opindex mno-gotplt
7244 @opindex mgotplt
7245 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7246 instruction sequences that load addresses for functions from the PLT part
7247 of the GOT rather than (traditional on other architectures) calls to the
7248 PLT@. The default is @option{-mgotplt}.
7249
7250 @item -maout
7251 @opindex maout
7252 Legacy no-op option only recognized with the cris-axis-aout target.
7253
7254 @item -melf
7255 @opindex melf
7256 Legacy no-op option only recognized with the cris-axis-elf and
7257 cris-axis-linux-gnu targets.
7258
7259 @item -melinux
7260 @opindex melinux
7261 Only recognized with the cris-axis-aout target, where it selects a
7262 GNU/linux-like multilib, include files and instruction set for
7263 @option{-march=v8}.
7264
7265 @item -mlinux
7266 @opindex mlinux
7267 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7268
7269 @item -sim
7270 @opindex sim
7271 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7272 to link with input-output functions from a simulator library. Code,
7273 initialized data and zero-initialized data are allocated consecutively.
7274
7275 @item -sim2
7276 @opindex sim2
7277 Like @option{-sim}, but pass linker options to locate initialized data at
7278 0x40000000 and zero-initialized data at 0x80000000.
7279 @end table
7280
7281 @node Darwin Options
7282 @subsection Darwin Options
7283 @cindex Darwin options
7284
7285 These options are defined for all architectures running the Darwin operating
7286 system.
7287
7288 FSF GCC on Darwin does not create ``fat'' object files; it will create
7289 an object file for the single architecture that it was built to
7290 target. Apple's GCC on Darwin does create ``fat'' files if multiple
7291 @option{-arch} options are used; it does so by running the compiler or
7292 linker multiple times and joining the results together with
7293 @file{lipo}.
7294
7295 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7296 @samp{i686}) is determined by the flags that specify the ISA
7297 that GCC is targetting, like @option{-mcpu} or @option{-march}. The
7298 @option{-force_cpusubtype_ALL} option can be used to override this.
7299
7300 The Darwin tools vary in their behaviour when presented with an ISA
7301 mismatch. The assembler, @file{as}, will only permit instructions to
7302 be used that are valid for the subtype of the file it is generating,
7303 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7304 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7305 and print an error if asked to create a shared library with a less
7306 restrictive subtype than its input files (for instance, trying to put
7307 a @samp{ppc970} object file in a @samp{ppc7400} library). The linker
7308 for executables, @file{ld}, will quietly give the executable the most
7309 restrictive subtype of any of its input files.
7310
7311 @table @gcctabopt
7312 @item -F@var{dir}
7313 @opindex F
7314 Add the framework directory @var{dir} to the head of the list of
7315 directories to be searched for header files. These directories are
7316 interleaved with those specified by @option{-I} options and are
7317 scanned in a left-to-right order.
7318
7319 A framework directory is a directory with frameworks in it. A
7320 framework is a directory with a @samp{"Headers"} and/or
7321 @samp{"PrivateHeaders"} directory contained directly in it that ends
7322 in @samp{".framework"}. The name of a framework is the name of this
7323 directory excluding the @samp{".framework"}. Headers associated with
7324 the framework are found in one of those two directories, with
7325 @samp{"Headers"} being searched first. A subframework is a framework
7326 directory that is in a framework's @samp{"Frameworks"} directory.
7327 Includes of subframework headers can only appear in a header of a
7328 framework that contains the subframework, or in a sibling subframework
7329 header. Two subframeworks are siblings if they occur in the same
7330 framework. A subframework should not have the same name as a
7331 framework, a warning will be issued if this is violated. Currently a
7332 subframework cannot have subframeworks, in the future, the mechanism
7333 may be extended to support this. The standard frameworks can be found
7334 in @samp{"/System/Library/Frameworks"} and
7335 @samp{"/Library/Frameworks"}. An example include looks like
7336 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7337 the name of the framework and header.h is found in the
7338 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7339
7340 @item -gused
7341 @opindex -gused
7342 Emit debugging information for symbols that are used. For STABS
7343 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7344 This is by default ON@.
7345
7346 @item -gfull
7347 @opindex -gfull
7348 Emit debugging information for all symbols and types.
7349
7350 @item -mone-byte-bool
7351 @opindex -mone-byte-bool
7352 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7353 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7354 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7355 option has no effect on x86.
7356
7357 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7358 to generate code that is not binary compatible with code generated
7359 without that switch. Using this switch may require recompiling all
7360 other modules in a program, including system libraries. Use this
7361 switch to conform to a non-default data model.
7362
7363 @item -mfix-and-continue
7364 @itemx -ffix-and-continue
7365 @itemx -findirect-data
7366 @opindex mfix-and-continue
7367 @opindex ffix-and-continue
7368 @opindex findirect-data
7369 Generate code suitable for fast turn around development. Needed to
7370 enable gdb to dynamically load @code{.o} files into already running
7371 programs. @option{-findirect-data} and @option{-ffix-and-continue}
7372 are provided for backwards compatibility.
7373
7374 @item -all_load
7375 @opindex all_load
7376 Loads all members of static archive libraries.
7377 See man ld(1) for more information.
7378
7379 @item -arch_errors_fatal
7380 @opindex arch_errors_fatal
7381 Cause the errors having to do with files that have the wrong architecture
7382 to be fatal.
7383
7384 @item -bind_at_load
7385 @opindex bind_at_load
7386 Causes the output file to be marked such that the dynamic linker will
7387 bind all undefined references when the file is loaded or launched.
7388
7389 @item -bundle
7390 @opindex bundle
7391 Produce a Mach-o bundle format file.
7392 See man ld(1) for more information.
7393
7394 @item -bundle_loader @var{executable}
7395 @opindex bundle_loader
7396 This option specifies the @var{executable} that will be loading the build
7397 output file being linked. See man ld(1) for more information.
7398
7399 @item -dynamiclib
7400 @opindex -dynamiclib
7401 When passed this option, GCC will produce a dynamic library instead of
7402 an executable when linking, using the Darwin @file{libtool} command.
7403
7404 @item -force_cpusubtype_ALL
7405 @opindex -force_cpusubtype_ALL
7406 This causes GCC's output file to have the @var{ALL} subtype, instead of
7407 one controlled by the @option{-mcpu} or @option{-march} option.
7408
7409 @item -allowable_client @var{client_name}
7410 @itemx -client_name
7411 @itemx -compatibility_version
7412 @itemx -current_version
7413 @itemx -dead_strip
7414 @itemx -dependency-file
7415 @itemx -dylib_file
7416 @itemx -dylinker_install_name
7417 @itemx -dynamic
7418 @itemx -exported_symbols_list
7419 @itemx -filelist
7420 @itemx -flat_namespace
7421 @itemx -force_flat_namespace
7422 @itemx -headerpad_max_install_names
7423 @itemx -image_base
7424 @itemx -init
7425 @itemx -install_name
7426 @itemx -keep_private_externs
7427 @itemx -multi_module
7428 @itemx -multiply_defined
7429 @itemx -multiply_defined_unused
7430 @itemx -noall_load
7431 @itemx -no_dead_strip_inits_and_terms
7432 @itemx -nofixprebinding
7433 @itemx -nomultidefs
7434 @itemx -noprebind
7435 @itemx -noseglinkedit
7436 @itemx -pagezero_size
7437 @itemx -prebind
7438 @itemx -prebind_all_twolevel_modules
7439 @itemx -private_bundle
7440 @itemx -read_only_relocs
7441 @itemx -sectalign
7442 @itemx -sectobjectsymbols
7443 @itemx -whyload
7444 @itemx -seg1addr
7445 @itemx -sectcreate
7446 @itemx -sectobjectsymbols
7447 @itemx -sectorder
7448 @itemx -segaddr
7449 @itemx -segs_read_only_addr
7450 @itemx -segs_read_write_addr
7451 @itemx -seg_addr_table
7452 @itemx -seg_addr_table_filename
7453 @itemx -seglinkedit
7454 @itemx -segprot
7455 @itemx -segs_read_only_addr
7456 @itemx -segs_read_write_addr
7457 @itemx -single_module
7458 @itemx -static
7459 @itemx -sub_library
7460 @itemx -sub_umbrella
7461 @itemx -twolevel_namespace
7462 @itemx -umbrella
7463 @itemx -undefined
7464 @itemx -unexported_symbols_list
7465 @itemx -weak_reference_mismatches
7466 @itemx -whatsloaded
7467
7468 @opindex allowable_client
7469 @opindex client_name
7470 @opindex compatibility_version
7471 @opindex current_version
7472 @opindex dead_strip
7473 @opindex dependency-file
7474 @opindex dylib_file
7475 @opindex dylinker_install_name
7476 @opindex dynamic
7477 @opindex exported_symbols_list
7478 @opindex filelist
7479 @opindex flat_namespace
7480 @opindex force_flat_namespace
7481 @opindex headerpad_max_install_names
7482 @opindex image_base
7483 @opindex init
7484 @opindex install_name
7485 @opindex keep_private_externs
7486 @opindex multi_module
7487 @opindex multiply_defined
7488 @opindex multiply_defined_unused
7489 @opindex noall_load
7490 @opindex no_dead_strip_inits_and_terms
7491 @opindex nofixprebinding
7492 @opindex nomultidefs
7493 @opindex noprebind
7494 @opindex noseglinkedit
7495 @opindex pagezero_size
7496 @opindex prebind
7497 @opindex prebind_all_twolevel_modules
7498 @opindex private_bundle
7499 @opindex read_only_relocs
7500 @opindex sectalign
7501 @opindex sectobjectsymbols
7502 @opindex whyload
7503 @opindex seg1addr
7504 @opindex sectcreate
7505 @opindex sectobjectsymbols
7506 @opindex sectorder
7507 @opindex segaddr
7508 @opindex segs_read_only_addr
7509 @opindex segs_read_write_addr
7510 @opindex seg_addr_table
7511 @opindex seg_addr_table_filename
7512 @opindex seglinkedit
7513 @opindex segprot
7514 @opindex segs_read_only_addr
7515 @opindex segs_read_write_addr
7516 @opindex single_module
7517 @opindex static
7518 @opindex sub_library
7519 @opindex sub_umbrella
7520 @opindex twolevel_namespace
7521 @opindex umbrella
7522 @opindex undefined
7523 @opindex unexported_symbols_list
7524 @opindex weak_reference_mismatches
7525 @opindex whatsloaded
7526
7527 These options are passed to the Darwin linker. The Darwin linker man page
7528 describes them in detail.
7529 @end table
7530
7531 @node DEC Alpha Options
7532 @subsection DEC Alpha Options
7533
7534 These @samp{-m} options are defined for the DEC Alpha implementations:
7535
7536 @table @gcctabopt
7537 @item -mno-soft-float
7538 @itemx -msoft-float
7539 @opindex mno-soft-float
7540 @opindex msoft-float
7541 Use (do not use) the hardware floating-point instructions for
7542 floating-point operations. When @option{-msoft-float} is specified,
7543 functions in @file{libgcc.a} will be used to perform floating-point
7544 operations. Unless they are replaced by routines that emulate the
7545 floating-point operations, or compiled in such a way as to call such
7546 emulations routines, these routines will issue floating-point
7547 operations. If you are compiling for an Alpha without floating-point
7548 operations, you must ensure that the library is built so as not to call
7549 them.
7550
7551 Note that Alpha implementations without floating-point operations are
7552 required to have floating-point registers.
7553
7554 @item -mfp-reg
7555 @itemx -mno-fp-regs
7556 @opindex mfp-reg
7557 @opindex mno-fp-regs
7558 Generate code that uses (does not use) the floating-point register set.
7559 @option{-mno-fp-regs} implies @option{-msoft-float}. If the floating-point
7560 register set is not used, floating point operands are passed in integer
7561 registers as if they were integers and floating-point results are passed
7562 in @code{$0} instead of @code{$f0}. This is a non-standard calling sequence,
7563 so any function with a floating-point argument or return value called by code
7564 compiled with @option{-mno-fp-regs} must also be compiled with that
7565 option.
7566
7567 A typical use of this option is building a kernel that does not use,
7568 and hence need not save and restore, any floating-point registers.
7569
7570 @item -mieee
7571 @opindex mieee
7572 The Alpha architecture implements floating-point hardware optimized for
7573 maximum performance. It is mostly compliant with the IEEE floating
7574 point standard. However, for full compliance, software assistance is
7575 required. This option generates code fully IEEE compliant code
7576 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7577 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7578 defined during compilation. The resulting code is less efficient but is
7579 able to correctly support denormalized numbers and exceptional IEEE
7580 values such as not-a-number and plus/minus infinity. Other Alpha
7581 compilers call this option @option{-ieee_with_no_inexact}.
7582
7583 @item -mieee-with-inexact
7584 @opindex mieee-with-inexact
7585 This is like @option{-mieee} except the generated code also maintains
7586 the IEEE @var{inexact-flag}. Turning on this option causes the
7587 generated code to implement fully-compliant IEEE math. In addition to
7588 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7589 macro. On some Alpha implementations the resulting code may execute
7590 significantly slower than the code generated by default. Since there is
7591 very little code that depends on the @var{inexact-flag}, you should
7592 normally not specify this option. Other Alpha compilers call this
7593 option @option{-ieee_with_inexact}.
7594
7595 @item -mfp-trap-mode=@var{trap-mode}
7596 @opindex mfp-trap-mode
7597 This option controls what floating-point related traps are enabled.
7598 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7599 The trap mode can be set to one of four values:
7600
7601 @table @samp
7602 @item n
7603 This is the default (normal) setting. The only traps that are enabled
7604 are the ones that cannot be disabled in software (e.g., division by zero
7605 trap).
7606
7607 @item u
7608 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7609 as well.
7610
7611 @item su
7612 Like @samp{su}, but the instructions are marked to be safe for software
7613 completion (see Alpha architecture manual for details).
7614
7615 @item sui
7616 Like @samp{su}, but inexact traps are enabled as well.
7617 @end table
7618
7619 @item -mfp-rounding-mode=@var{rounding-mode}
7620 @opindex mfp-rounding-mode
7621 Selects the IEEE rounding mode. Other Alpha compilers call this option
7622 @option{-fprm @var{rounding-mode}}. The @var{rounding-mode} can be one
7623 of:
7624
7625 @table @samp
7626 @item n
7627 Normal IEEE rounding mode. Floating point numbers are rounded towards
7628 the nearest machine number or towards the even machine number in case
7629 of a tie.
7630
7631 @item m
7632 Round towards minus infinity.
7633
7634 @item c
7635 Chopped rounding mode. Floating point numbers are rounded towards zero.
7636
7637 @item d
7638 Dynamic rounding mode. A field in the floating point control register
7639 (@var{fpcr}, see Alpha architecture reference manual) controls the
7640 rounding mode in effect. The C library initializes this register for
7641 rounding towards plus infinity. Thus, unless your program modifies the
7642 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7643 @end table
7644
7645 @item -mtrap-precision=@var{trap-precision}
7646 @opindex mtrap-precision
7647 In the Alpha architecture, floating point traps are imprecise. This
7648 means without software assistance it is impossible to recover from a
7649 floating trap and program execution normally needs to be terminated.
7650 GCC can generate code that can assist operating system trap handlers
7651 in determining the exact location that caused a floating point trap.
7652 Depending on the requirements of an application, different levels of
7653 precisions can be selected:
7654
7655 @table @samp
7656 @item p
7657 Program precision. This option is the default and means a trap handler
7658 can only identify which program caused a floating point exception.
7659
7660 @item f
7661 Function precision. The trap handler can determine the function that
7662 caused a floating point exception.
7663
7664 @item i
7665 Instruction precision. The trap handler can determine the exact
7666 instruction that caused a floating point exception.
7667 @end table
7668
7669 Other Alpha compilers provide the equivalent options called
7670 @option{-scope_safe} and @option{-resumption_safe}.
7671
7672 @item -mieee-conformant
7673 @opindex mieee-conformant
7674 This option marks the generated code as IEEE conformant. You must not
7675 use this option unless you also specify @option{-mtrap-precision=i} and either
7676 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}. Its only effect
7677 is to emit the line @samp{.eflag 48} in the function prologue of the
7678 generated assembly file. Under DEC Unix, this has the effect that
7679 IEEE-conformant math library routines will be linked in.
7680
7681 @item -mbuild-constants
7682 @opindex mbuild-constants
7683 Normally GCC examines a 32- or 64-bit integer constant to
7684 see if it can construct it from smaller constants in two or three
7685 instructions. If it cannot, it will output the constant as a literal and
7686 generate code to load it from the data segment at runtime.
7687
7688 Use this option to require GCC to construct @emph{all} integer constants
7689 using code, even if it takes more instructions (the maximum is six).
7690
7691 You would typically use this option to build a shared library dynamic
7692 loader. Itself a shared library, it must relocate itself in memory
7693 before it can find the variables and constants in its own data segment.
7694
7695 @item -malpha-as
7696 @itemx -mgas
7697 @opindex malpha-as
7698 @opindex mgas
7699 Select whether to generate code to be assembled by the vendor-supplied
7700 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
7701
7702 @item -mbwx
7703 @itemx -mno-bwx
7704 @itemx -mcix
7705 @itemx -mno-cix
7706 @itemx -mfix
7707 @itemx -mno-fix
7708 @itemx -mmax
7709 @itemx -mno-max
7710 @opindex mbwx
7711 @opindex mno-bwx
7712 @opindex mcix
7713 @opindex mno-cix
7714 @opindex mfix
7715 @opindex mno-fix
7716 @opindex mmax
7717 @opindex mno-max
7718 Indicate whether GCC should generate code to use the optional BWX,
7719 CIX, FIX and MAX instruction sets. The default is to use the instruction
7720 sets supported by the CPU type specified via @option{-mcpu=} option or that
7721 of the CPU on which GCC was built if none was specified.
7722
7723 @item -mfloat-vax
7724 @itemx -mfloat-ieee
7725 @opindex mfloat-vax
7726 @opindex mfloat-ieee
7727 Generate code that uses (does not use) VAX F and G floating point
7728 arithmetic instead of IEEE single and double precision.
7729
7730 @item -mexplicit-relocs
7731 @itemx -mno-explicit-relocs
7732 @opindex mexplicit-relocs
7733 @opindex mno-explicit-relocs
7734 Older Alpha assemblers provided no way to generate symbol relocations
7735 except via assembler macros. Use of these macros does not allow
7736 optimal instruction scheduling. GNU binutils as of version 2.12
7737 supports a new syntax that allows the compiler to explicitly mark
7738 which relocations should apply to which instructions. This option
7739 is mostly useful for debugging, as GCC detects the capabilities of
7740 the assembler when it is built and sets the default accordingly.
7741
7742 @item -msmall-data
7743 @itemx -mlarge-data
7744 @opindex msmall-data
7745 @opindex mlarge-data
7746 When @option{-mexplicit-relocs} is in effect, static data is
7747 accessed via @dfn{gp-relative} relocations. When @option{-msmall-data}
7748 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
7749 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
7750 16-bit relocations off of the @code{$gp} register. This limits the
7751 size of the small data area to 64KB, but allows the variables to be
7752 directly accessed via a single instruction.
7753
7754 The default is @option{-mlarge-data}. With this option the data area
7755 is limited to just below 2GB@. Programs that require more than 2GB of
7756 data must use @code{malloc} or @code{mmap} to allocate the data in the
7757 heap instead of in the program's data segment.
7758
7759 When generating code for shared libraries, @option{-fpic} implies
7760 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
7761
7762 @item -msmall-text
7763 @itemx -mlarge-text
7764 @opindex msmall-text
7765 @opindex mlarge-text
7766 When @option{-msmall-text} is used, the compiler assumes that the
7767 code of the entire program (or shared library) fits in 4MB, and is
7768 thus reachable with a branch instruction. When @option{-msmall-data}
7769 is used, the compiler can assume that all local symbols share the
7770 same @code{$gp} value, and thus reduce the number of instructions
7771 required for a function call from 4 to 1.
7772
7773 The default is @option{-mlarge-text}.
7774
7775 @item -mcpu=@var{cpu_type}
7776 @opindex mcpu
7777 Set the instruction set and instruction scheduling parameters for
7778 machine type @var{cpu_type}. You can specify either the @samp{EV}
7779 style name or the corresponding chip number. GCC supports scheduling
7780 parameters for the EV4, EV5 and EV6 family of processors and will
7781 choose the default values for the instruction set from the processor
7782 you specify. If you do not specify a processor type, GCC will default
7783 to the processor on which the compiler was built.
7784
7785 Supported values for @var{cpu_type} are
7786
7787 @table @samp
7788 @item ev4
7789 @itemx ev45
7790 @itemx 21064
7791 Schedules as an EV4 and has no instruction set extensions.
7792
7793 @item ev5
7794 @itemx 21164
7795 Schedules as an EV5 and has no instruction set extensions.
7796
7797 @item ev56
7798 @itemx 21164a
7799 Schedules as an EV5 and supports the BWX extension.
7800
7801 @item pca56
7802 @itemx 21164pc
7803 @itemx 21164PC
7804 Schedules as an EV5 and supports the BWX and MAX extensions.
7805
7806 @item ev6
7807 @itemx 21264
7808 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
7809
7810 @item ev67
7811 @itemx 21264a
7812 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
7813 @end table
7814
7815 @item -mtune=@var{cpu_type}
7816 @opindex mtune
7817 Set only the instruction scheduling parameters for machine type
7818 @var{cpu_type}. The instruction set is not changed.
7819
7820 @item -mmemory-latency=@var{time}
7821 @opindex mmemory-latency
7822 Sets the latency the scheduler should assume for typical memory
7823 references as seen by the application. This number is highly
7824 dependent on the memory access patterns used by the application
7825 and the size of the external cache on the machine.
7826
7827 Valid options for @var{time} are
7828
7829 @table @samp
7830 @item @var{number}
7831 A decimal number representing clock cycles.
7832
7833 @item L1
7834 @itemx L2
7835 @itemx L3
7836 @itemx main
7837 The compiler contains estimates of the number of clock cycles for
7838 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
7839 (also called Dcache, Scache, and Bcache), as well as to main memory.
7840 Note that L3 is only valid for EV5.
7841
7842 @end table
7843 @end table
7844
7845 @node DEC Alpha/VMS Options
7846 @subsection DEC Alpha/VMS Options
7847
7848 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
7849
7850 @table @gcctabopt
7851 @item -mvms-return-codes
7852 @opindex mvms-return-codes
7853 Return VMS condition codes from main. The default is to return POSIX
7854 style condition (e.g.@ error) codes.
7855 @end table
7856
7857 @node FRV Options
7858 @subsection FRV Options
7859 @cindex FRV Options
7860
7861 @table @gcctabopt
7862 @item -mgpr-32
7863 @opindex mgpr-32
7864
7865 Only use the first 32 general purpose registers.
7866
7867 @item -mgpr-64
7868 @opindex mgpr-64
7869
7870 Use all 64 general purpose registers.
7871
7872 @item -mfpr-32
7873 @opindex mfpr-32
7874
7875 Use only the first 32 floating point registers.
7876
7877 @item -mfpr-64
7878 @opindex mfpr-64
7879
7880 Use all 64 floating point registers
7881
7882 @item -mhard-float
7883 @opindex mhard-float
7884
7885 Use hardware instructions for floating point operations.
7886
7887 @item -msoft-float
7888 @opindex msoft-float
7889
7890 Use library routines for floating point operations.
7891
7892 @item -malloc-cc
7893 @opindex malloc-cc
7894
7895 Dynamically allocate condition code registers.
7896
7897 @item -mfixed-cc
7898 @opindex mfixed-cc
7899
7900 Do not try to dynamically allocate condition code registers, only
7901 use @code{icc0} and @code{fcc0}.
7902
7903 @item -mdword
7904 @opindex mdword
7905
7906 Change ABI to use double word insns.
7907
7908 @item -mno-dword
7909 @opindex mno-dword
7910
7911 Do not use double word instructions.
7912
7913 @item -mdouble
7914 @opindex mdouble
7915
7916 Use floating point double instructions.
7917
7918 @item -mno-double
7919 @opindex mno-double
7920
7921 Do not use floating point double instructions.
7922
7923 @item -mmedia
7924 @opindex mmedia
7925
7926 Use media instructions.
7927
7928 @item -mno-media
7929 @opindex mno-media
7930
7931 Do not use media instructions.
7932
7933 @item -mmuladd
7934 @opindex mmuladd
7935
7936 Use multiply and add/subtract instructions.
7937
7938 @item -mno-muladd
7939 @opindex mno-muladd
7940
7941 Do not use multiply and add/subtract instructions.
7942
7943 @item -mfdpic
7944 @opindex mfdpic
7945
7946 Select the FDPIC ABI, that uses function descriptors to represent
7947 pointers to functions. Without any PIC/PIE-related options, it
7948 implies @option{-fPIE}. With @option{-fpic} or @option{-fpie}, it
7949 assumes GOT entries and small data are within a 12-bit range from the
7950 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
7951 are computed with 32 bits.
7952
7953 @item -minline-plt
7954 @opindex minline-plt
7955
7956 Enable inlining of PLT entries in function calls to functions that are
7957 not known to bind locally. It has no effect without @option{-mfdpic}.
7958 It's enabled by default if optimizing for speed and compiling for
7959 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
7960 optimization option such as @option{-O3} or above is present in the
7961 command line.
7962
7963 @item -mTLS
7964 @opindex TLS
7965
7966 Assume a large TLS segment when generating thread-local code.
7967
7968 @item -mtls
7969 @opindex tls
7970
7971 Do not assume a large TLS segment when generating thread-local code.
7972
7973 @item -mgprel-ro
7974 @opindex mgprel-ro
7975
7976 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
7977 that is known to be in read-only sections. It's enabled by default,
7978 except for @option{-fpic} or @option{-fpie}: even though it may help
7979 make the global offset table smaller, it trades 1 instruction for 4.
7980 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
7981 one of which may be shared by multiple symbols, and it avoids the need
7982 for a GOT entry for the referenced symbol, so it's more likely to be a
7983 win. If it is not, @option{-mno-gprel-ro} can be used to disable it.
7984
7985 @item -multilib-library-pic
7986 @opindex multilib-library-pic
7987
7988 Link with the (library, not FD) pic libraries. It's implied by
7989 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
7990 @option{-fpic} without @option{-mfdpic}. You should never have to use
7991 it explicitly.
7992
7993 @item -mlinked-fp
7994 @opindex mlinked-fp
7995
7996 Follow the EABI requirement of always creating a frame pointer whenever
7997 a stack frame is allocated. This option is enabled by default and can
7998 be disabled with @option{-mno-linked-fp}.
7999
8000 @item -mlong-calls
8001 @opindex mlong-calls
8002
8003 Use indirect addressing to call functions outside the current
8004 compilation unit. This allows the functions to be placed anywhere
8005 within the 32-bit address space.
8006
8007 @item -malign-labels
8008 @opindex malign-labels
8009
8010 Try to align labels to an 8-byte boundary by inserting nops into the
8011 previous packet. This option only has an effect when VLIW packing
8012 is enabled. It doesn't create new packets; it merely adds nops to
8013 existing ones.
8014
8015 @item -mlibrary-pic
8016 @opindex mlibrary-pic
8017
8018 Generate position-independent EABI code.
8019
8020 @item -macc-4
8021 @opindex macc-4
8022
8023 Use only the first four media accumulator registers.
8024
8025 @item -macc-8
8026 @opindex macc-8
8027
8028 Use all eight media accumulator registers.
8029
8030 @item -mpack
8031 @opindex mpack
8032
8033 Pack VLIW instructions.
8034
8035 @item -mno-pack
8036 @opindex mno-pack
8037
8038 Do not pack VLIW instructions.
8039
8040 @item -mno-eflags
8041 @opindex mno-eflags
8042
8043 Do not mark ABI switches in e_flags.
8044
8045 @item -mcond-move
8046 @opindex mcond-move
8047
8048 Enable the use of conditional-move instructions (default).
8049
8050 This switch is mainly for debugging the compiler and will likely be removed
8051 in a future version.
8052
8053 @item -mno-cond-move
8054 @opindex mno-cond-move
8055
8056 Disable the use of conditional-move instructions.
8057
8058 This switch is mainly for debugging the compiler and will likely be removed
8059 in a future version.
8060
8061 @item -mscc
8062 @opindex mscc
8063
8064 Enable the use of conditional set instructions (default).
8065
8066 This switch is mainly for debugging the compiler and will likely be removed
8067 in a future version.
8068
8069 @item -mno-scc
8070 @opindex mno-scc
8071
8072 Disable the use of conditional set instructions.
8073
8074 This switch is mainly for debugging the compiler and will likely be removed
8075 in a future version.
8076
8077 @item -mcond-exec
8078 @opindex mcond-exec
8079
8080 Enable the use of conditional execution (default).
8081
8082 This switch is mainly for debugging the compiler and will likely be removed
8083 in a future version.
8084
8085 @item -mno-cond-exec
8086 @opindex mno-cond-exec
8087
8088 Disable the use of conditional execution.
8089
8090 This switch is mainly for debugging the compiler and will likely be removed
8091 in a future version.
8092
8093 @item -mvliw-branch
8094 @opindex mvliw-branch
8095
8096 Run a pass to pack branches into VLIW instructions (default).
8097
8098 This switch is mainly for debugging the compiler and will likely be removed
8099 in a future version.
8100
8101 @item -mno-vliw-branch
8102 @opindex mno-vliw-branch
8103
8104 Do not run a pass to pack branches into VLIW instructions.
8105
8106 This switch is mainly for debugging the compiler and will likely be removed
8107 in a future version.
8108
8109 @item -mmulti-cond-exec
8110 @opindex mmulti-cond-exec
8111
8112 Enable optimization of @code{&&} and @code{||} in conditional execution
8113 (default).
8114
8115 This switch is mainly for debugging the compiler and will likely be removed
8116 in a future version.
8117
8118 @item -mno-multi-cond-exec
8119 @opindex mno-multi-cond-exec
8120
8121 Disable optimization of @code{&&} and @code{||} in conditional execution.
8122
8123 This switch is mainly for debugging the compiler and will likely be removed
8124 in a future version.
8125
8126 @item -mnested-cond-exec
8127 @opindex mnested-cond-exec
8128
8129 Enable nested conditional execution optimizations (default).
8130
8131 This switch is mainly for debugging the compiler and will likely be removed
8132 in a future version.
8133
8134 @item -mno-nested-cond-exec
8135 @opindex mno-nested-cond-exec
8136
8137 Disable nested conditional execution optimizations.
8138
8139 This switch is mainly for debugging the compiler and will likely be removed
8140 in a future version.
8141
8142 @item -mtomcat-stats
8143 @opindex mtomcat-stats
8144
8145 Cause gas to print out tomcat statistics.
8146
8147 @item -mcpu=@var{cpu}
8148 @opindex mcpu
8149
8150 Select the processor type for which to generate code. Possible values are
8151 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8152 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8153
8154 @end table
8155
8156 @node H8/300 Options
8157 @subsection H8/300 Options
8158
8159 These @samp{-m} options are defined for the H8/300 implementations:
8160
8161 @table @gcctabopt
8162 @item -mrelax
8163 @opindex mrelax
8164 Shorten some address references at link time, when possible; uses the
8165 linker option @option{-relax}. @xref{H8/300,, @code{ld} and the H8/300,
8166 ld, Using ld}, for a fuller description.
8167
8168 @item -mh
8169 @opindex mh
8170 Generate code for the H8/300H@.
8171
8172 @item -ms
8173 @opindex ms
8174 Generate code for the H8S@.
8175
8176 @item -mn
8177 @opindex mn
8178 Generate code for the H8S and H8/300H in the normal mode. This switch
8179 must be used either with @option{-mh} or @option{-ms}.
8180
8181 @item -ms2600
8182 @opindex ms2600
8183 Generate code for the H8S/2600. This switch must be used with @option{-ms}.
8184
8185 @item -mint32
8186 @opindex mint32
8187 Make @code{int} data 32 bits by default.
8188
8189 @item -malign-300
8190 @opindex malign-300
8191 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8192 The default for the H8/300H and H8S is to align longs and floats on 4
8193 byte boundaries.
8194 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8195 This option has no effect on the H8/300.
8196 @end table
8197
8198 @node HPPA Options
8199 @subsection HPPA Options
8200 @cindex HPPA Options
8201
8202 These @samp{-m} options are defined for the HPPA family of computers:
8203
8204 @table @gcctabopt
8205 @item -march=@var{architecture-type}
8206 @opindex march
8207 Generate code for the specified architecture. The choices for
8208 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8209 1.1, and @samp{2.0} for PA 2.0 processors. Refer to
8210 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8211 architecture option for your machine. Code compiled for lower numbered
8212 architectures will run on higher numbered architectures, but not the
8213 other way around.
8214
8215 @item -mpa-risc-1-0
8216 @itemx -mpa-risc-1-1
8217 @itemx -mpa-risc-2-0
8218 @opindex mpa-risc-1-0
8219 @opindex mpa-risc-1-1
8220 @opindex mpa-risc-2-0
8221 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8222
8223 @item -mbig-switch
8224 @opindex mbig-switch
8225 Generate code suitable for big switch tables. Use this option only if
8226 the assembler/linker complain about out of range branches within a switch
8227 table.
8228
8229 @item -mjump-in-delay
8230 @opindex mjump-in-delay
8231 Fill delay slots of function calls with unconditional jump instructions
8232 by modifying the return pointer for the function call to be the target
8233 of the conditional jump.
8234
8235 @item -mdisable-fpregs
8236 @opindex mdisable-fpregs
8237 Prevent floating point registers from being used in any manner. This is
8238 necessary for compiling kernels which perform lazy context switching of
8239 floating point registers. If you use this option and attempt to perform
8240 floating point operations, the compiler will abort.
8241
8242 @item -mdisable-indexing
8243 @opindex mdisable-indexing
8244 Prevent the compiler from using indexing address modes. This avoids some
8245 rather obscure problems when compiling MIG generated code under MACH@.
8246
8247 @item -mno-space-regs
8248 @opindex mno-space-regs
8249 Generate code that assumes the target has no space registers. This allows
8250 GCC to generate faster indirect calls and use unscaled index address modes.
8251
8252 Such code is suitable for level 0 PA systems and kernels.
8253
8254 @item -mfast-indirect-calls
8255 @opindex mfast-indirect-calls
8256 Generate code that assumes calls never cross space boundaries. This
8257 allows GCC to emit code which performs faster indirect calls.
8258
8259 This option will not work in the presence of shared libraries or nested
8260 functions.
8261
8262 @item -mfixed-range=@var{register-range}
8263 @opindex mfixed-range
8264 Generate code treating the given register range as fixed registers.
8265 A fixed register is one that the register allocator can not use. This is
8266 useful when compiling kernel code. A register range is specified as
8267 two registers separated by a dash. Multiple register ranges can be
8268 specified separated by a comma.
8269
8270 @item -mlong-load-store
8271 @opindex mlong-load-store
8272 Generate 3-instruction load and store sequences as sometimes required by
8273 the HP-UX 10 linker. This is equivalent to the @samp{+k} option to
8274 the HP compilers.
8275
8276 @item -mportable-runtime
8277 @opindex mportable-runtime
8278 Use the portable calling conventions proposed by HP for ELF systems.
8279
8280 @item -mgas
8281 @opindex mgas
8282 Enable the use of assembler directives only GAS understands.
8283
8284 @item -mschedule=@var{cpu-type}
8285 @opindex mschedule
8286 Schedule code according to the constraints for the machine type
8287 @var{cpu-type}. The choices for @var{cpu-type} are @samp{700}
8288 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}. Refer
8289 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8290 proper scheduling option for your machine. The default scheduling is
8291 @samp{8000}.
8292
8293 @item -mlinker-opt
8294 @opindex mlinker-opt
8295 Enable the optimization pass in the HP-UX linker. Note this makes symbolic
8296 debugging impossible. It also triggers a bug in the HP-UX 8 and HP-UX 9
8297 linkers in which they give bogus error messages when linking some programs.
8298
8299 @item -msoft-float
8300 @opindex msoft-float
8301 Generate output containing library calls for floating point.
8302 @strong{Warning:} the requisite libraries are not available for all HPPA
8303 targets. Normally the facilities of the machine's usual C compiler are
8304 used, but this cannot be done directly in cross-compilation. You must make
8305 your own arrangements to provide suitable library functions for
8306 cross-compilation. The embedded target @samp{hppa1.1-*-pro}
8307 does provide software floating point support.
8308
8309 @option{-msoft-float} changes the calling convention in the output file;
8310 therefore, it is only useful if you compile @emph{all} of a program with
8311 this option. In particular, you need to compile @file{libgcc.a}, the
8312 library that comes with GCC, with @option{-msoft-float} in order for
8313 this to work.
8314
8315 @item -msio
8316 @opindex msio
8317 Generate the predefine, @code{_SIO}, for server IO@. The default is
8318 @option{-mwsio}. This generates the predefines, @code{__hp9000s700},
8319 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@. These
8320 options are available under HP-UX and HI-UX@.
8321
8322 @item -mgnu-ld
8323 @opindex gnu-ld
8324 Use GNU ld specific options. This passes @option{-shared} to ld when
8325 building a shared library. It is the default when GCC is configured,
8326 explicitly or implicitly, with the GNU linker. This option does not
8327 have any affect on which ld is called, it only changes what parameters
8328 are passed to that ld. The ld that is called is determined by the
8329 @option{--with-ld} configure option, GCC's program search path, and
8330 finally by the user's @env{PATH}. The linker used by GCC can be printed
8331 using @samp{which `gcc -print-prog-name=ld`}.
8332
8333 @item -mhp-ld
8334 @opindex hp-ld
8335 Use HP ld specific options. This passes @option{-b} to ld when building
8336 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8337 links. It is the default when GCC is configured, explicitly or
8338 implicitly, with the HP linker. This option does not have any affect on
8339 which ld is called, it only changes what parameters are passed to that
8340 ld. The ld that is called is determined by the @option{--with-ld}
8341 configure option, GCC's program search path, and finally by the user's
8342 @env{PATH}. The linker used by GCC can be printed using @samp{which
8343 `gcc -print-prog-name=ld`}.
8344
8345 @item -mlong-calls
8346 @opindex mno-long-calls
8347 Generate code that uses long call sequences. This ensures that a call
8348 is always able to reach linker generated stubs. The default is to generate
8349 long calls only when the distance from the call site to the beginning
8350 of the function or translation unit, as the case may be, exceeds a
8351 predefined limit set by the branch type being used. The limits for
8352 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8353 PA 2.0 and PA 1.X architectures. Sibcalls are always limited at
8354 240,000 bytes.
8355
8356 Distances are measured from the beginning of functions when using the
8357 @option{-ffunction-sections} option, or when using the @option{-mgas}
8358 and @option{-mno-portable-runtime} options together under HP-UX with
8359 the SOM linker.
8360
8361 It is normally not desirable to use this option as it will degrade
8362 performance. However, it may be useful in large applications,
8363 particularly when partial linking is used to build the application.
8364
8365 The types of long calls used depends on the capabilities of the
8366 assembler and linker, and the type of code being generated. The
8367 impact on systems that support long absolute calls, and long pic
8368 symbol-difference or pc-relative calls should be relatively small.
8369 However, an indirect call is used on 32-bit ELF systems in pic code
8370 and it is quite long.
8371
8372 @item -munix=@var{unix-std}
8373 @opindex march
8374 Generate compiler predefines and select a startfile for the specified
8375 UNIX standard. The choices for @var{unix-std} are @samp{93}, @samp{95}
8376 and @samp{98}. @samp{93} is supported on all HP-UX versions. @samp{95}
8377 is available on HP-UX 10.10 and later. @samp{98} is available on HP-UX
8378 11.11 and later. The default values are @samp{93} for HP-UX 10.00,
8379 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8380 and later.
8381
8382 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8383 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8384 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8385 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8386 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8387 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8388
8389 It is @emph{important} to note that this option changes the interfaces
8390 for various library routines. It also affects the operational behavior
8391 of the C library. Thus, @emph{extreme} care is needed in using this
8392 option.
8393
8394 Library code that is intended to operate with more than one UNIX
8395 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8396 as appropriate. Most GNU software doesn't provide this capability.
8397
8398 @item -nolibdld
8399 @opindex nolibdld
8400 Suppress the generation of link options to search libdld.sl when the
8401 @option{-static} option is specified on HP-UX 10 and later.
8402
8403 @item -static
8404 @opindex static
8405 The HP-UX implementation of setlocale in libc has a dependency on
8406 libdld.sl. There isn't an archive version of libdld.sl. Thus,
8407 when the @option{-static} option is specified, special link options
8408 are needed to resolve this dependency.
8409
8410 On HP-UX 10 and later, the GCC driver adds the necessary options to
8411 link with libdld.sl when the @option{-static} option is specified.
8412 This causes the resulting binary to be dynamic. On the 64-bit port,
8413 the linkers generate dynamic binaries by default in any case. The
8414 @option{-nolibdld} option can be used to prevent the GCC driver from
8415 adding these link options.
8416
8417 @item -threads
8418 @opindex threads
8419 Add support for multithreading with the @dfn{dce thread} library
8420 under HP-UX@. This option sets flags for both the preprocessor and
8421 linker.
8422 @end table
8423
8424 @node i386 and x86-64 Options
8425 @subsection Intel 386 and AMD x86-64 Options
8426 @cindex i386 Options
8427 @cindex x86-64 Options
8428 @cindex Intel 386 Options
8429 @cindex AMD x86-64 Options
8430
8431 These @samp{-m} options are defined for the i386 and x86-64 family of
8432 computers:
8433
8434 @table @gcctabopt
8435 @item -mtune=@var{cpu-type}
8436 @opindex mtune
8437 Tune to @var{cpu-type} everything applicable about the generated code, except
8438 for the ABI and the set of available instructions. The choices for
8439 @var{cpu-type} are:
8440 @table @emph
8441 @item i386
8442 Original Intel's i386 CPU@.
8443 @item i486
8444 Intel's i486 CPU@. (No scheduling is implemented for this chip.)
8445 @item i586, pentium
8446 Intel Pentium CPU with no MMX support.
8447 @item pentium-mmx
8448 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8449 @item i686, pentiumpro
8450 Intel PentiumPro CPU@.
8451 @item pentium2
8452 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8453 @item pentium3, pentium3m
8454 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8455 support.
8456 @item pentium-m
8457 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8458 support. Used by Centrino notebooks.
8459 @item pentium4, pentium4m
8460 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8461 @item prescott
8462 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8463 set support.
8464 @item nocona
8465 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8466 SSE2 and SSE3 instruction set support.
8467 @item k6
8468 AMD K6 CPU with MMX instruction set support.
8469 @item k6-2, k6-3
8470 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8471 @item athlon, athlon-tbird
8472 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8473 support.
8474 @item athlon-4, athlon-xp, athlon-mp
8475 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8476 instruction set support.
8477 @item k8, opteron, athlon64, athlon-fx
8478 AMD K8 core based CPUs with x86-64 instruction set support. (This supersets
8479 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8480 @item winchip-c6
8481 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8482 set support.
8483 @item winchip2
8484 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8485 instruction set support.
8486 @item c3
8487 Via C3 CPU with MMX and 3dNOW! instruction set support. (No scheduling is
8488 implemented for this chip.)
8489 @item c3-2
8490 Via C3-2 CPU with MMX and SSE instruction set support. (No scheduling is
8491 implemented for this chip.)
8492 @end table
8493
8494 While picking a specific @var{cpu-type} will schedule things appropriately
8495 for that particular chip, the compiler will not generate any code that
8496 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8497 being used.
8498
8499 @item -march=@var{cpu-type}
8500 @opindex march
8501 Generate instructions for the machine type @var{cpu-type}. The choices
8502 for @var{cpu-type} are the same as for @option{-mtune}. Moreover,
8503 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8504
8505 @item -mcpu=@var{cpu-type}
8506 @opindex mcpu
8507 A deprecated synonym for @option{-mtune}.
8508
8509 @item -m386
8510 @itemx -m486
8511 @itemx -mpentium
8512 @itemx -mpentiumpro
8513 @opindex m386
8514 @opindex m486
8515 @opindex mpentium
8516 @opindex mpentiumpro
8517 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8518 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8519 These synonyms are deprecated.
8520
8521 @item -mfpmath=@var{unit}
8522 @opindex march
8523 Generate floating point arithmetics for selected unit @var{unit}. The choices
8524 for @var{unit} are:
8525
8526 @table @samp
8527 @item 387
8528 Use the standard 387 floating point coprocessor present majority of chips and
8529 emulated otherwise. Code compiled with this option will run almost everywhere.
8530 The temporary results are computed in 80bit precision instead of precision
8531 specified by the type resulting in slightly different results compared to most
8532 of other chips. See @option{-ffloat-store} for more detailed description.
8533
8534 This is the default choice for i386 compiler.
8535
8536 @item sse
8537 Use scalar floating point instructions present in the SSE instruction set.
8538 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8539 by Athlon-4, Athlon-xp and Athlon-mp chips. The earlier version of SSE
8540 instruction set supports only single precision arithmetics, thus the double and
8541 extended precision arithmetics is still done using 387. Later version, present
8542 only in Pentium4 and the future AMD x86-64 chips supports double precision
8543 arithmetics too.
8544
8545 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
8546 or @option{-msse2} switches to enable SSE extensions and make this option
8547 effective. For the x86-64 compiler, these extensions are enabled by default.
8548
8549 The resulting code should be considerably faster in the majority of cases and avoid
8550 the numerical instability problems of 387 code, but may break some existing
8551 code that expects temporaries to be 80bit.
8552
8553 This is the default choice for the x86-64 compiler.
8554
8555 @item sse,387
8556 Attempt to utilize both instruction sets at once. This effectively double the
8557 amount of available registers and on chips with separate execution units for
8558 387 and SSE the execution resources too. Use this option with care, as it is
8559 still experimental, because the GCC register allocator does not model separate
8560 functional units well resulting in instable performance.
8561 @end table
8562
8563 @item -masm=@var{dialect}
8564 @opindex masm=@var{dialect}
8565 Output asm instructions using selected @var{dialect}. Supported choices are
8566 @samp{intel} or @samp{att} (the default one).
8567
8568 @item -mieee-fp
8569 @itemx -mno-ieee-fp
8570 @opindex mieee-fp
8571 @opindex mno-ieee-fp
8572 Control whether or not the compiler uses IEEE floating point
8573 comparisons. These handle correctly the case where the result of a
8574 comparison is unordered.
8575
8576 @item -msoft-float
8577 @opindex msoft-float
8578 Generate output containing library calls for floating point.
8579 @strong{Warning:} the requisite libraries are not part of GCC@.
8580 Normally the facilities of the machine's usual C compiler are used, but
8581 this can't be done directly in cross-compilation. You must make your
8582 own arrangements to provide suitable library functions for
8583 cross-compilation.
8584
8585 On machines where a function returns floating point results in the 80387
8586 register stack, some floating point opcodes may be emitted even if
8587 @option{-msoft-float} is used.
8588
8589 @item -mno-fp-ret-in-387
8590 @opindex mno-fp-ret-in-387
8591 Do not use the FPU registers for return values of functions.
8592
8593 The usual calling convention has functions return values of types
8594 @code{float} and @code{double} in an FPU register, even if there
8595 is no FPU@. The idea is that the operating system should emulate
8596 an FPU@.
8597
8598 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8599 in ordinary CPU registers instead.
8600
8601 @item -mno-fancy-math-387
8602 @opindex mno-fancy-math-387
8603 Some 387 emulators do not support the @code{sin}, @code{cos} and
8604 @code{sqrt} instructions for the 387. Specify this option to avoid
8605 generating those instructions. This option is the default on FreeBSD,
8606 OpenBSD and NetBSD@. This option is overridden when @option{-march}
8607 indicates that the target cpu will always have an FPU and so the
8608 instruction will not need emulation. As of revision 2.6.1, these
8609 instructions are not generated unless you also use the
8610 @option{-funsafe-math-optimizations} switch.
8611
8612 @item -malign-double
8613 @itemx -mno-align-double
8614 @opindex malign-double
8615 @opindex mno-align-double
8616 Control whether GCC aligns @code{double}, @code{long double}, and
8617 @code{long long} variables on a two word boundary or a one word
8618 boundary. Aligning @code{double} variables on a two word boundary will
8619 produce code that runs somewhat faster on a @samp{Pentium} at the
8620 expense of more memory.
8621
8622 @strong{Warning:} if you use the @option{-malign-double} switch,
8623 structures containing the above types will be aligned differently than
8624 the published application binary interface specifications for the 386
8625 and will not be binary compatible with structures in code compiled
8626 without that switch.
8627
8628 @item -m96bit-long-double
8629 @itemx -m128bit-long-double
8630 @opindex m96bit-long-double
8631 @opindex m128bit-long-double
8632 These switches control the size of @code{long double} type. The i386
8633 application binary interface specifies the size to be 96 bits,
8634 so @option{-m96bit-long-double} is the default in 32 bit mode.
8635
8636 Modern architectures (Pentium and newer) would prefer @code{long double}
8637 to be aligned to an 8 or 16 byte boundary. In arrays or structures
8638 conforming to the ABI, this would not be possible. So specifying a
8639 @option{-m128bit-long-double} will align @code{long double}
8640 to a 16 byte boundary by padding the @code{long double} with an additional
8641 32 bit zero.
8642
8643 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8644 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8645
8646 Notice that neither of these options enable any extra precision over the x87
8647 standard of 80 bits for a @code{long double}.
8648
8649 @strong{Warning:} if you override the default value for your target ABI, the
8650 structures and arrays containing @code{long double} variables will change
8651 their size as well as function calling convention for function taking
8652 @code{long double} will be modified. Hence they will not be binary
8653 compatible with arrays or structures in code compiled without that switch.
8654
8655
8656 @item -msvr3-shlib
8657 @itemx -mno-svr3-shlib
8658 @opindex msvr3-shlib
8659 @opindex mno-svr3-shlib
8660 Control whether GCC places uninitialized local variables into the
8661 @code{bss} or @code{data} segments. @option{-msvr3-shlib} places them
8662 into @code{bss}. These options are meaningful only on System V Release 3.
8663
8664 @item -mrtd
8665 @opindex mrtd
8666 Use a different function-calling convention, in which functions that
8667 take a fixed number of arguments return with the @code{ret} @var{num}
8668 instruction, which pops their arguments while returning. This saves one
8669 instruction in the caller since there is no need to pop the arguments
8670 there.
8671
8672 You can specify that an individual function is called with this calling
8673 sequence with the function attribute @samp{stdcall}. You can also
8674 override the @option{-mrtd} option by using the function attribute
8675 @samp{cdecl}. @xref{Function Attributes}.
8676
8677 @strong{Warning:} this calling convention is incompatible with the one
8678 normally used on Unix, so you cannot use it if you need to call
8679 libraries compiled with the Unix compiler.
8680
8681 Also, you must provide function prototypes for all functions that
8682 take variable numbers of arguments (including @code{printf});
8683 otherwise incorrect code will be generated for calls to those
8684 functions.
8685
8686 In addition, seriously incorrect code will result if you call a
8687 function with too many arguments. (Normally, extra arguments are
8688 harmlessly ignored.)
8689
8690 @item -mregparm=@var{num}
8691 @opindex mregparm
8692 Control how many registers are used to pass integer arguments. By
8693 default, no registers are used to pass arguments, and at most 3
8694 registers can be used. You can control this behavior for a specific
8695 function by using the function attribute @samp{regparm}.
8696 @xref{Function Attributes}.
8697
8698 @strong{Warning:} if you use this switch, and
8699 @var{num} is nonzero, then you must build all modules with the same
8700 value, including any libraries. This includes the system libraries and
8701 startup modules.
8702
8703 @item -mpreferred-stack-boundary=@var{num}
8704 @opindex mpreferred-stack-boundary
8705 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8706 byte boundary. If @option{-mpreferred-stack-boundary} is not specified,
8707 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8708 size (@option{-Os}), in which case the default is the minimum correct
8709 alignment (4 bytes for x86, and 8 bytes for x86-64).
8710
8711 On Pentium and PentiumPro, @code{double} and @code{long double} values
8712 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8713 suffer significant run time performance penalties. On Pentium III, the
8714 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8715 penalties if it is not 16 byte aligned.
8716
8717 To ensure proper alignment of this values on the stack, the stack boundary
8718 must be as aligned as that required by any value stored on the stack.
8719 Further, every function must be generated such that it keeps the stack
8720 aligned. Thus calling a function compiled with a higher preferred
8721 stack boundary from a function compiled with a lower preferred stack
8722 boundary will most likely misalign the stack. It is recommended that
8723 libraries that use callbacks always use the default setting.
8724
8725 This extra alignment does consume extra stack space, and generally
8726 increases code size. Code that is sensitive to stack space usage, such
8727 as embedded systems and operating system kernels, may want to reduce the
8728 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8729
8730 @item -mmmx
8731 @itemx -mno-mmx
8732 @item -msse
8733 @itemx -mno-sse
8734 @item -msse2
8735 @itemx -mno-sse2
8736 @item -msse3
8737 @itemx -mno-sse3
8738 @item -m3dnow
8739 @itemx -mno-3dnow
8740 @opindex mmmx
8741 @opindex mno-mmx
8742 @opindex msse
8743 @opindex mno-sse
8744 @opindex m3dnow
8745 @opindex mno-3dnow
8746 These switches enable or disable the use of built-in functions that allow
8747 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
8748 instruction set.
8749
8750 @xref{X86 Built-in Functions}, for details of the functions enabled
8751 and disabled by these switches.
8752
8753 To have SSE/SSE2 instructions generated automatically from floating-point
8754 code, see @option{-mfpmath=sse}.
8755
8756 @item -mpush-args
8757 @itemx -mno-push-args
8758 @opindex mpush-args
8759 @opindex mno-push-args
8760 Use PUSH operations to store outgoing parameters. This method is shorter
8761 and usually equally fast as method using SUB/MOV operations and is enabled
8762 by default. In some cases disabling it may improve performance because of
8763 improved scheduling and reduced dependencies.
8764
8765 @item -maccumulate-outgoing-args
8766 @opindex maccumulate-outgoing-args
8767 If enabled, the maximum amount of space required for outgoing arguments will be
8768 computed in the function prologue. This is faster on most modern CPUs
8769 because of reduced dependencies, improved scheduling and reduced stack usage
8770 when preferred stack boundary is not equal to 2. The drawback is a notable
8771 increase in code size. This switch implies @option{-mno-push-args}.
8772
8773 @item -mthreads
8774 @opindex mthreads
8775 Support thread-safe exception handling on @samp{Mingw32}. Code that relies
8776 on thread-safe exception handling must compile and link all code with the
8777 @option{-mthreads} option. When compiling, @option{-mthreads} defines
8778 @option{-D_MT}; when linking, it links in a special thread helper library
8779 @option{-lmingwthrd} which cleans up per thread exception handling data.
8780
8781 @item -mno-align-stringops
8782 @opindex mno-align-stringops
8783 Do not align destination of inlined string operations. This switch reduces
8784 code size and improves performance in case the destination is already aligned,
8785 but GCC doesn't know about it.
8786
8787 @item -minline-all-stringops
8788 @opindex minline-all-stringops
8789 By default GCC inlines string operations only when destination is known to be
8790 aligned at least to 4 byte boundary. This enables more inlining, increase code
8791 size, but may improve performance of code that depends on fast memcpy, strlen
8792 and memset for short lengths.
8793
8794 @item -momit-leaf-frame-pointer
8795 @opindex momit-leaf-frame-pointer
8796 Don't keep the frame pointer in a register for leaf functions. This
8797 avoids the instructions to save, set up and restore frame pointers and
8798 makes an extra register available in leaf functions. The option
8799 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8800 which might make debugging harder.
8801
8802 @item -mtls-direct-seg-refs
8803 @itemx -mno-tls-direct-seg-refs
8804 @opindex mtls-direct-seg-refs
8805 Controls whether TLS variables may be accessed with offsets from the
8806 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8807 or whether the thread base pointer must be added. Whether or not this
8808 is legal depends on the operating system, and whether it maps the
8809 segment to cover the entire TLS area.
8810
8811 For systems that use GNU libc, the default is on.
8812 @end table
8813
8814 These @samp{-m} switches are supported in addition to the above
8815 on AMD x86-64 processors in 64-bit environments.
8816
8817 @table @gcctabopt
8818 @item -m32
8819 @itemx -m64
8820 @opindex m32
8821 @opindex m64
8822 Generate code for a 32-bit or 64-bit environment.
8823 The 32-bit environment sets int, long and pointer to 32 bits and
8824 generates code that runs on any i386 system.
8825 The 64-bit environment sets int to 32 bits and long and pointer
8826 to 64 bits and generates code for AMD's x86-64 architecture.
8827
8828 @item -mno-red-zone
8829 @opindex no-red-zone
8830 Do not use a so called red zone for x86-64 code. The red zone is mandated
8831 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8832 stack pointer that will not be modified by signal or interrupt handlers
8833 and therefore can be used for temporary data without adjusting the stack
8834 pointer. The flag @option{-mno-red-zone} disables this red zone.
8835
8836 @item -mcmodel=small
8837 @opindex mcmodel=small
8838 Generate code for the small code model: the program and its symbols must
8839 be linked in the lower 2 GB of the address space. Pointers are 64 bits.
8840 Programs can be statically or dynamically linked. This is the default
8841 code model.
8842
8843 @item -mcmodel=kernel
8844 @opindex mcmodel=kernel
8845 Generate code for the kernel code model. The kernel runs in the
8846 negative 2 GB of the address space.
8847 This model has to be used for Linux kernel code.
8848
8849 @item -mcmodel=medium
8850 @opindex mcmodel=medium
8851 Generate code for the medium model: The program is linked in the lower 2
8852 GB of the address space but symbols can be located anywhere in the
8853 address space. Programs can be statically or dynamically linked, but
8854 building of shared libraries are not supported with the medium model.
8855
8856 @item -mcmodel=large
8857 @opindex mcmodel=large
8858 Generate code for the large model: This model makes no assumptions
8859 about addresses and sizes of sections. Currently GCC does not implement
8860 this model.
8861 @end table
8862
8863 @node IA-64 Options
8864 @subsection IA-64 Options
8865 @cindex IA-64 Options
8866
8867 These are the @samp{-m} options defined for the Intel IA-64 architecture.
8868
8869 @table @gcctabopt
8870 @item -mbig-endian
8871 @opindex mbig-endian
8872 Generate code for a big endian target. This is the default for HP-UX@.
8873
8874 @item -mlittle-endian
8875 @opindex mlittle-endian
8876 Generate code for a little endian target. This is the default for AIX5
8877 and GNU/Linux.
8878
8879 @item -mgnu-as
8880 @itemx -mno-gnu-as
8881 @opindex mgnu-as
8882 @opindex mno-gnu-as
8883 Generate (or don't) code for the GNU assembler. This is the default.
8884 @c Also, this is the default if the configure option @option{--with-gnu-as}
8885 @c is used.
8886
8887 @item -mgnu-ld
8888 @itemx -mno-gnu-ld
8889 @opindex mgnu-ld
8890 @opindex mno-gnu-ld
8891 Generate (or don't) code for the GNU linker. This is the default.
8892 @c Also, this is the default if the configure option @option{--with-gnu-ld}
8893 @c is used.
8894
8895 @item -mno-pic
8896 @opindex mno-pic
8897 Generate code that does not use a global pointer register. The result
8898 is not position independent code, and violates the IA-64 ABI@.
8899
8900 @item -mvolatile-asm-stop
8901 @itemx -mno-volatile-asm-stop
8902 @opindex mvolatile-asm-stop
8903 @opindex mno-volatile-asm-stop
8904 Generate (or don't) a stop bit immediately before and after volatile asm
8905 statements.
8906
8907 @item -mregister-names
8908 @itemx -mno-register-names
8909 @opindex mregister-names
8910 @opindex mno-register-names
8911 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
8912 the stacked registers. This may make assembler output more readable.
8913
8914 @item -mno-sdata
8915 @itemx -msdata
8916 @opindex mno-sdata
8917 @opindex msdata
8918 Disable (or enable) optimizations that use the small data section. This may
8919 be useful for working around optimizer bugs.
8920
8921 @item -mconstant-gp
8922 @opindex mconstant-gp
8923 Generate code that uses a single constant global pointer value. This is
8924 useful when compiling kernel code.
8925
8926 @item -mauto-pic
8927 @opindex mauto-pic
8928 Generate code that is self-relocatable. This implies @option{-mconstant-gp}.
8929 This is useful when compiling firmware code.
8930
8931 @item -minline-float-divide-min-latency
8932 @opindex minline-float-divide-min-latency
8933 Generate code for inline divides of floating point values
8934 using the minimum latency algorithm.
8935
8936 @item -minline-float-divide-max-throughput
8937 @opindex minline-float-divide-max-throughput
8938 Generate code for inline divides of floating point values
8939 using the maximum throughput algorithm.
8940
8941 @item -minline-int-divide-min-latency
8942 @opindex minline-int-divide-min-latency
8943 Generate code for inline divides of integer values
8944 using the minimum latency algorithm.
8945
8946 @item -minline-int-divide-max-throughput
8947 @opindex minline-int-divide-max-throughput
8948 Generate code for inline divides of integer values
8949 using the maximum throughput algorithm.
8950
8951 @item -minline-sqrt-min-latency
8952 @opindex minline-sqrt-min-latency
8953 Generate code for inline square roots
8954 using the minimum latency algorithm.
8955
8956 @item -minline-sqrt-max-throughput
8957 @opindex minline-sqrt-max-throughput
8958 Generate code for inline square roots
8959 using the maximum throughput algorithm.
8960
8961 @item -mno-dwarf2-asm
8962 @itemx -mdwarf2-asm
8963 @opindex mno-dwarf2-asm
8964 @opindex mdwarf2-asm
8965 Don't (or do) generate assembler code for the DWARF2 line number debugging
8966 info. This may be useful when not using the GNU assembler.
8967
8968 @item -mearly-stop-bits
8969 @itemx -mno-early-stop-bits
8970 @opindex mearly-stop-bits
8971 @opindex mno-early-stop-bits
8972 Allow stop bits to be placed earlier than immediately preceding the
8973 instruction that triggered the stop bit. This can improve instruction
8974 scheduling, but does not always do so.
8975
8976 @item -mfixed-range=@var{register-range}
8977 @opindex mfixed-range
8978 Generate code treating the given register range as fixed registers.
8979 A fixed register is one that the register allocator can not use. This is
8980 useful when compiling kernel code. A register range is specified as
8981 two registers separated by a dash. Multiple register ranges can be
8982 specified separated by a comma.
8983
8984 @item -mtls-size=@var{tls-size}
8985 @opindex mtls-size
8986 Specify bit size of immediate TLS offsets. Valid values are 14, 22, and
8987 64.
8988
8989 @item -mtune-arch=@var{cpu-type}
8990 @opindex mtune-arch
8991 Tune the instruction scheduling for a particular CPU, Valid values are
8992 itanium, itanium1, merced, itanium2, and mckinley.
8993
8994 @item -mt
8995 @itemx -pthread
8996 @opindex mt
8997 @opindex pthread
8998 Add support for multithreading using the POSIX threads library. This
8999 option sets flags for both the preprocessor and linker. It does
9000 not affect the thread safety of object code produced by the compiler or
9001 that of libraries supplied with it. These are HP-UX specific flags.
9002
9003 @item -milp32
9004 @itemx -mlp64
9005 @opindex milp32
9006 @opindex mlp64
9007 Generate code for a 32-bit or 64-bit environment.
9008 The 32-bit environment sets int, long and pointer to 32 bits.
9009 The 64-bit environment sets int to 32 bits and long and pointer
9010 to 64 bits. These are HP-UX specific flags.
9011
9012 @end table
9013
9014 @node M32R/D Options
9015 @subsection M32R/D Options
9016 @cindex M32R/D options
9017
9018 These @option{-m} options are defined for Renesas M32R/D architectures:
9019
9020 @table @gcctabopt
9021 @item -m32r2
9022 @opindex m32r2
9023 Generate code for the M32R/2@.
9024
9025 @item -m32rx
9026 @opindex m32rx
9027 Generate code for the M32R/X@.
9028
9029 @item -m32r
9030 @opindex m32r
9031 Generate code for the M32R@. This is the default.
9032
9033 @item -mmodel=small
9034 @opindex mmodel=small
9035 Assume all objects live in the lower 16MB of memory (so that their addresses
9036 can be loaded with the @code{ld24} instruction), and assume all subroutines
9037 are reachable with the @code{bl} instruction.
9038 This is the default.
9039
9040 The addressability of a particular object can be set with the
9041 @code{model} attribute.
9042
9043 @item -mmodel=medium
9044 @opindex mmodel=medium
9045 Assume objects may be anywhere in the 32-bit address space (the compiler
9046 will generate @code{seth/add3} instructions to load their addresses), and
9047 assume all subroutines are reachable with the @code{bl} instruction.
9048
9049 @item -mmodel=large
9050 @opindex mmodel=large
9051 Assume objects may be anywhere in the 32-bit address space (the compiler
9052 will generate @code{seth/add3} instructions to load their addresses), and
9053 assume subroutines may not be reachable with the @code{bl} instruction
9054 (the compiler will generate the much slower @code{seth/add3/jl}
9055 instruction sequence).
9056
9057 @item -msdata=none
9058 @opindex msdata=none
9059 Disable use of the small data area. Variables will be put into
9060 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9061 @code{section} attribute has been specified).
9062 This is the default.
9063
9064 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9065 Objects may be explicitly put in the small data area with the
9066 @code{section} attribute using one of these sections.
9067
9068 @item -msdata=sdata
9069 @opindex msdata=sdata
9070 Put small global and static data in the small data area, but do not
9071 generate special code to reference them.
9072
9073 @item -msdata=use
9074 @opindex msdata=use
9075 Put small global and static data in the small data area, and generate
9076 special instructions to reference them.
9077
9078 @item -G @var{num}
9079 @opindex G
9080 @cindex smaller data references
9081 Put global and static objects less than or equal to @var{num} bytes
9082 into the small data or bss sections instead of the normal data or bss
9083 sections. The default value of @var{num} is 8.
9084 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9085 for this option to have any effect.
9086
9087 All modules should be compiled with the same @option{-G @var{num}} value.
9088 Compiling with different values of @var{num} may or may not work; if it
9089 doesn't the linker will give an error message---incorrect code will not be
9090 generated.
9091
9092 @item -mdebug
9093 @opindex mdebug
9094 Makes the M32R specific code in the compiler display some statistics
9095 that might help in debugging programs.
9096
9097 @item -malign-loops
9098 @opindex malign-loops
9099 Align all loops to a 32-byte boundary.
9100
9101 @item -mno-align-loops
9102 @opindex mno-align-loops
9103 Do not enforce a 32-byte alignment for loops. This is the default.
9104
9105 @item -missue-rate=@var{number}
9106 @opindex missue-rate=@var{number}
9107 Issue @var{number} instructions per cycle. @var{number} can only be 1
9108 or 2.
9109
9110 @item -mbranch-cost=@var{number}
9111 @opindex mbranch-cost=@var{number}
9112 @var{number} can only be 1 or 2. If it is 1 then branches will be
9113 preferred over conditional code, if it is 2, then the opposite will
9114 apply.
9115
9116 @item -mflush-trap=@var{number}
9117 @opindex mflush-trap=@var{number}
9118 Specifies the trap number to use to flush the cache. The default is
9119 12. Valid numbers are between 0 and 15 inclusive.
9120
9121 @item -mno-flush-trap
9122 @opindex mno-flush-trap
9123 Specifies that the cache cannot be flushed by using a trap.
9124
9125 @item -mflush-func=@var{name}
9126 @opindex mflush-func=@var{name}
9127 Specifies the name of the operating system function to call to flush
9128 the cache. The default is @emph{_flush_cache}, but a function call
9129 will only be used if a trap is not available.
9130
9131 @item -mno-flush-func
9132 @opindex mno-flush-func
9133 Indicates that there is no OS function for flushing the cache.
9134
9135 @end table
9136
9137 @node M680x0 Options
9138 @subsection M680x0 Options
9139 @cindex M680x0 options
9140
9141 These are the @samp{-m} options defined for the 68000 series. The default
9142 values for these options depends on which style of 68000 was selected when
9143 the compiler was configured; the defaults for the most common choices are
9144 given below.
9145
9146 @table @gcctabopt
9147 @item -m68000
9148 @itemx -mc68000
9149 @opindex m68000
9150 @opindex mc68000
9151 Generate output for a 68000. This is the default
9152 when the compiler is configured for 68000-based systems.
9153
9154 Use this option for microcontrollers with a 68000 or EC000 core,
9155 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9156
9157 @item -m68020
9158 @itemx -mc68020
9159 @opindex m68020
9160 @opindex mc68020
9161 Generate output for a 68020. This is the default
9162 when the compiler is configured for 68020-based systems.
9163
9164 @item -m68881
9165 @opindex m68881
9166 Generate output containing 68881 instructions for floating point.
9167 This is the default for most 68020 systems unless @option{--nfp} was
9168 specified when the compiler was configured.
9169
9170 @item -m68030
9171 @opindex m68030
9172 Generate output for a 68030. This is the default when the compiler is
9173 configured for 68030-based systems.
9174
9175 @item -m68040
9176 @opindex m68040
9177 Generate output for a 68040. This is the default when the compiler is
9178 configured for 68040-based systems.
9179
9180 This option inhibits the use of 68881/68882 instructions that have to be
9181 emulated by software on the 68040. Use this option if your 68040 does not
9182 have code to emulate those instructions.
9183
9184 @item -m68060
9185 @opindex m68060
9186 Generate output for a 68060. This is the default when the compiler is
9187 configured for 68060-based systems.
9188
9189 This option inhibits the use of 68020 and 68881/68882 instructions that
9190 have to be emulated by software on the 68060. Use this option if your 68060
9191 does not have code to emulate those instructions.
9192
9193 @item -mcpu32
9194 @opindex mcpu32
9195 Generate output for a CPU32. This is the default
9196 when the compiler is configured for CPU32-based systems.
9197
9198 Use this option for microcontrollers with a
9199 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9200 68336, 68340, 68341, 68349 and 68360.
9201
9202 @item -m5200
9203 @opindex m5200
9204 Generate output for a 520X ``coldfire'' family cpu. This is the default
9205 when the compiler is configured for 520X-based systems.
9206
9207 Use this option for microcontroller with a 5200 core, including
9208 the MCF5202, MCF5203, MCF5204 and MCF5202.
9209
9210
9211 @item -m68020-40
9212 @opindex m68020-40
9213 Generate output for a 68040, without using any of the new instructions.
9214 This results in code which can run relatively efficiently on either a
9215 68020/68881 or a 68030 or a 68040. The generated code does use the
9216 68881 instructions that are emulated on the 68040.
9217
9218 @item -m68020-60
9219 @opindex m68020-60
9220 Generate output for a 68060, without using any of the new instructions.
9221 This results in code which can run relatively efficiently on either a
9222 68020/68881 or a 68030 or a 68040. The generated code does use the
9223 68881 instructions that are emulated on the 68060.
9224
9225 @item -msoft-float
9226 @opindex msoft-float
9227 Generate output containing library calls for floating point.
9228 @strong{Warning:} the requisite libraries are not available for all m68k
9229 targets. Normally the facilities of the machine's usual C compiler are
9230 used, but this can't be done directly in cross-compilation. You must
9231 make your own arrangements to provide suitable library functions for
9232 cross-compilation. The embedded targets @samp{m68k-*-aout} and
9233 @samp{m68k-*-coff} do provide software floating point support.
9234
9235 @item -mshort
9236 @opindex mshort
9237 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9238 Additionally, parameters passed on the stack are also aligned to a
9239 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9240
9241 @item -mnobitfield
9242 @opindex mnobitfield
9243 Do not use the bit-field instructions. The @option{-m68000}, @option{-mcpu32}
9244 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9245
9246 @item -mbitfield
9247 @opindex mbitfield
9248 Do use the bit-field instructions. The @option{-m68020} option implies
9249 @option{-mbitfield}. This is the default if you use a configuration
9250 designed for a 68020.
9251
9252 @item -mrtd
9253 @opindex mrtd
9254 Use a different function-calling convention, in which functions
9255 that take a fixed number of arguments return with the @code{rtd}
9256 instruction, which pops their arguments while returning. This
9257 saves one instruction in the caller since there is no need to pop
9258 the arguments there.
9259
9260 This calling convention is incompatible with the one normally
9261 used on Unix, so you cannot use it if you need to call libraries
9262 compiled with the Unix compiler.
9263
9264 Also, you must provide function prototypes for all functions that
9265 take variable numbers of arguments (including @code{printf});
9266 otherwise incorrect code will be generated for calls to those
9267 functions.
9268
9269 In addition, seriously incorrect code will result if you call a
9270 function with too many arguments. (Normally, extra arguments are
9271 harmlessly ignored.)
9272
9273 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9274 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9275
9276 @item -malign-int
9277 @itemx -mno-align-int
9278 @opindex malign-int
9279 @opindex mno-align-int
9280 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9281 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9282 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9283 Aligning variables on 32-bit boundaries produces code that runs somewhat
9284 faster on processors with 32-bit busses at the expense of more memory.
9285
9286 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9287 align structures containing the above types differently than
9288 most published application binary interface specifications for the m68k.
9289
9290 @item -mpcrel
9291 @opindex mpcrel
9292 Use the pc-relative addressing mode of the 68000 directly, instead of
9293 using a global offset table. At present, this option implies @option{-fpic},
9294 allowing at most a 16-bit offset for pc-relative addressing. @option{-fPIC} is
9295 not presently supported with @option{-mpcrel}, though this could be supported for
9296 68020 and higher processors.
9297
9298 @item -mno-strict-align
9299 @itemx -mstrict-align
9300 @opindex mno-strict-align
9301 @opindex mstrict-align
9302 Do not (do) assume that unaligned memory references will be handled by
9303 the system.
9304
9305 @item -msep-data
9306 Generate code that allows the data segment to be located in a different
9307 area of memory from the text segment. This allows for execute in place in
9308 an environment without virtual memory management. This option implies
9309 @option{-fPIC}.
9310
9311 @item -mno-sep-data
9312 Generate code that assumes that the data segment follows the text segment.
9313 This is the default.
9314
9315 @item -mid-shared-library
9316 Generate code that supports shared libraries via the library ID method.
9317 This allows for execute in place and shared libraries in an environment
9318 without virtual memory management. This option implies @option{-fPIC}.
9319
9320 @item -mno-id-shared-library
9321 Generate code that doesn't assume ID based shared libraries are being used.
9322 This is the default.
9323
9324 @item -mshared-library-id=n
9325 Specified the identification number of the ID based shared library being
9326 compiled. Specifying a value of 0 will generate more compact code, specifying
9327 other values will force the allocation of that number to the current
9328 library but is no more space or time efficient than omitting this option.
9329
9330 @end table
9331
9332 @node M68hc1x Options
9333 @subsection M68hc1x Options
9334 @cindex M68hc1x options
9335
9336 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9337 microcontrollers. The default values for these options depends on
9338 which style of microcontroller was selected when the compiler was configured;
9339 the defaults for the most common choices are given below.
9340
9341 @table @gcctabopt
9342 @item -m6811
9343 @itemx -m68hc11
9344 @opindex m6811
9345 @opindex m68hc11
9346 Generate output for a 68HC11. This is the default
9347 when the compiler is configured for 68HC11-based systems.
9348
9349 @item -m6812
9350 @itemx -m68hc12
9351 @opindex m6812
9352 @opindex m68hc12
9353 Generate output for a 68HC12. This is the default
9354 when the compiler is configured for 68HC12-based systems.
9355
9356 @item -m68S12
9357 @itemx -m68hcs12
9358 @opindex m68S12
9359 @opindex m68hcs12
9360 Generate output for a 68HCS12.
9361
9362 @item -mauto-incdec
9363 @opindex mauto-incdec
9364 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9365 addressing modes.
9366
9367 @item -minmax
9368 @itemx -nominmax
9369 @opindex minmax
9370 @opindex mnominmax
9371 Enable the use of 68HC12 min and max instructions.
9372
9373 @item -mlong-calls
9374 @itemx -mno-long-calls
9375 @opindex mlong-calls
9376 @opindex mno-long-calls
9377 Treat all calls as being far away (near). If calls are assumed to be
9378 far away, the compiler will use the @code{call} instruction to
9379 call a function and the @code{rtc} instruction for returning.
9380
9381 @item -mshort
9382 @opindex mshort
9383 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9384
9385 @item -msoft-reg-count=@var{count}
9386 @opindex msoft-reg-count
9387 Specify the number of pseudo-soft registers which are used for the
9388 code generation. The maximum number is 32. Using more pseudo-soft
9389 register may or may not result in better code depending on the program.
9390 The default is 4 for 68HC11 and 2 for 68HC12.
9391
9392 @end table
9393
9394 @node MCore Options
9395 @subsection MCore Options
9396 @cindex MCore options
9397
9398 These are the @samp{-m} options defined for the Motorola M*Core
9399 processors.
9400
9401 @table @gcctabopt
9402
9403 @item -mhardlit
9404 @itemx -mno-hardlit
9405 @opindex mhardlit
9406 @opindex mno-hardlit
9407 Inline constants into the code stream if it can be done in two
9408 instructions or less.
9409
9410 @item -mdiv
9411 @itemx -mno-div
9412 @opindex mdiv
9413 @opindex mno-div
9414 Use the divide instruction. (Enabled by default).
9415
9416 @item -mrelax-immediate
9417 @itemx -mno-relax-immediate
9418 @opindex mrelax-immediate
9419 @opindex mno-relax-immediate
9420 Allow arbitrary sized immediates in bit operations.
9421
9422 @item -mwide-bitfields
9423 @itemx -mno-wide-bitfields
9424 @opindex mwide-bitfields
9425 @opindex mno-wide-bitfields
9426 Always treat bit-fields as int-sized.
9427
9428 @item -m4byte-functions
9429 @itemx -mno-4byte-functions
9430 @opindex m4byte-functions
9431 @opindex mno-4byte-functions
9432 Force all functions to be aligned to a four byte boundary.
9433
9434 @item -mcallgraph-data
9435 @itemx -mno-callgraph-data
9436 @opindex mcallgraph-data
9437 @opindex mno-callgraph-data
9438 Emit callgraph information.
9439
9440 @item -mslow-bytes
9441 @itemx -mno-slow-bytes
9442 @opindex mslow-bytes
9443 @opindex mno-slow-bytes
9444 Prefer word access when reading byte quantities.
9445
9446 @item -mlittle-endian
9447 @itemx -mbig-endian
9448 @opindex mlittle-endian
9449 @opindex mbig-endian
9450 Generate code for a little endian target.
9451
9452 @item -m210
9453 @itemx -m340
9454 @opindex m210
9455 @opindex m340
9456 Generate code for the 210 processor.
9457 @end table
9458
9459 @node MIPS Options
9460 @subsection MIPS Options
9461 @cindex MIPS options
9462
9463 @table @gcctabopt
9464
9465 @item -EB
9466 @opindex EB
9467 Generate big-endian code.
9468
9469 @item -EL
9470 @opindex EL
9471 Generate little-endian code. This is the default for @samp{mips*el-*-*}
9472 configurations.
9473
9474 @item -march=@var{arch}
9475 @opindex march
9476 Generate code that will run on @var{arch}, which can be the name of a
9477 generic MIPS ISA, or the name of a particular processor.
9478 The ISA names are:
9479 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9480 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9481 The processor names are:
9482 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
9483 @samp{m4k},
9484 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9485 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
9486 @samp{rm9000},
9487 @samp{orion},
9488 @samp{sb1},
9489 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9490 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9491 The special value @samp{from-abi} selects the
9492 most compatible architecture for the selected ABI (that is,
9493 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9494
9495 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9496 (for example, @samp{-march=r2k}). Prefixes are optional, and
9497 @samp{vr} may be written @samp{r}.
9498
9499 GCC defines two macros based on the value of this option. The first
9500 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9501 a string. The second has the form @samp{_MIPS_ARCH_@var{foo}},
9502 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9503 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9504 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9505
9506 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9507 above. In other words, it will have the full prefix and will not
9508 abbreviate @samp{000} as @samp{k}. In the case of @samp{from-abi},
9509 the macro names the resolved architecture (either @samp{"mips1"} or
9510 @samp{"mips3"}). It names the default architecture when no
9511 @option{-march} option is given.
9512
9513 @item -mtune=@var{arch}
9514 @opindex mtune
9515 Optimize for @var{arch}. Among other things, this option controls
9516 the way instructions are scheduled, and the perceived cost of arithmetic
9517 operations. The list of @var{arch} values is the same as for
9518 @option{-march}.
9519
9520 When this option is not used, GCC will optimize for the processor
9521 specified by @option{-march}. By using @option{-march} and
9522 @option{-mtune} together, it is possible to generate code that will
9523 run on a family of processors, but optimize the code for one
9524 particular member of that family.
9525
9526 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
9527 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
9528 @samp{-march} ones described above.
9529
9530 @item -mips1
9531 @opindex mips1
9532 Equivalent to @samp{-march=mips1}.
9533
9534 @item -mips2
9535 @opindex mips2
9536 Equivalent to @samp{-march=mips2}.
9537
9538 @item -mips3
9539 @opindex mips3
9540 Equivalent to @samp{-march=mips3}.
9541
9542 @item -mips4
9543 @opindex mips4
9544 Equivalent to @samp{-march=mips4}.
9545
9546 @item -mips32
9547 @opindex mips32
9548 Equivalent to @samp{-march=mips32}.
9549
9550 @item -mips32r2
9551 @opindex mips32r2
9552 Equivalent to @samp{-march=mips32r2}.
9553
9554 @item -mips64
9555 @opindex mips64
9556 Equivalent to @samp{-march=mips64}.
9557
9558 @item -mips16
9559 @itemx -mno-mips16
9560 @opindex mips16
9561 @opindex mno-mips16
9562 Use (do not use) the MIPS16 ISA@.
9563
9564 @item -mabi=32
9565 @itemx -mabi=o64
9566 @itemx -mabi=n32
9567 @itemx -mabi=64
9568 @itemx -mabi=eabi
9569 @opindex mabi=32
9570 @opindex mabi=o64
9571 @opindex mabi=n32
9572 @opindex mabi=64
9573 @opindex mabi=eabi
9574 Generate code for the given ABI@.
9575
9576 Note that the EABI has a 32-bit and a 64-bit variant. GCC normally
9577 generates 64-bit code when you select a 64-bit architecture, but you
9578 can use @option{-mgp32} to get 32-bit code instead.
9579
9580 For information about the O64 ABI, see
9581 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
9582
9583 @item -mabicalls
9584 @itemx -mno-abicalls
9585 @opindex mabicalls
9586 @opindex mno-abicalls
9587 Generate (do not generate) SVR4-style position-independent code.
9588 @option{-mabicalls} is the default for SVR4-based systems.
9589
9590 @item -mxgot
9591 @itemx -mno-xgot
9592 @opindex mxgot
9593 @opindex mno-xgot
9594 Lift (do not lift) the usual restrictions on the size of the global
9595 offset table.
9596
9597 GCC normally uses a single instruction to load values from the GOT@.
9598 While this is relatively efficient, it will only work if the GOT
9599 is smaller than about 64k. Anything larger will cause the linker
9600 to report an error such as:
9601
9602 @cindex relocation truncated to fit (MIPS)
9603 @smallexample
9604 relocation truncated to fit: R_MIPS_GOT16 foobar
9605 @end smallexample
9606
9607 If this happens, you should recompile your code with @option{-mxgot}.
9608 It should then work with very large GOTs, although it will also be
9609 less efficient, since it will take three instructions to fetch the
9610 value of a global symbol.
9611
9612 Note that some linkers can create multiple GOTs. If you have such a
9613 linker, you should only need to use @option{-mxgot} when a single object
9614 file accesses more than 64k's worth of GOT entries. Very few do.
9615
9616 These options have no effect unless GCC is generating position
9617 independent code.
9618
9619 @item -mgp32
9620 @opindex mgp32
9621 Assume that general-purpose registers are 32 bits wide.
9622
9623 @item -mgp64
9624 @opindex mgp64
9625 Assume that general-purpose registers are 64 bits wide.
9626
9627 @item -mfp32
9628 @opindex mfp32
9629 Assume that floating-point registers are 32 bits wide.
9630
9631 @item -mfp64
9632 @opindex mfp64
9633 Assume that floating-point registers are 64 bits wide.
9634
9635 @item -mhard-float
9636 @opindex mhard-float
9637 Use floating-point coprocessor instructions.
9638
9639 @item -msoft-float
9640 @opindex msoft-float
9641 Do not use floating-point coprocessor instructions. Implement
9642 floating-point calculations using library calls instead.
9643
9644 @item -msingle-float
9645 @opindex msingle-float
9646 Assume that the floating-point coprocessor only supports single-precision
9647 operations.
9648
9649 @itemx -mdouble-float
9650 @opindex mdouble-float
9651 Assume that the floating-point coprocessor supports double-precision
9652 operations. This is the default.
9653
9654 @itemx -mpaired-single
9655 @itemx -mno-paired-single
9656 @opindex mpaired-single
9657 @opindex mno-paired-single
9658 Use (do not use) paired-single floating-point instructions.
9659 @xref{MIPS Paired-Single Support}. This option can only be used
9660 when generating 64-bit code and requires hardware floating-point
9661 support to be enabled.
9662
9663 @itemx -mips3d
9664 @itemx -mno-mips3d
9665 @opindex mips3d
9666 @opindex mno-mips3d
9667 Use (do not use) the MIPS-3D ASE@. @xref{MIPS-3D Built-in Functions}.
9668 The option @option{-mips3d} implies @option{-mpaired-single}.
9669
9670 @item -mint64
9671 @opindex mint64
9672 Force @code{int} and @code{long} types to be 64 bits wide. See
9673 @option{-mlong32} for an explanation of the default and the way
9674 that the pointer size is determined.
9675
9676 This option has been deprecated and will be removed in a future release.
9677
9678 @item -mlong64
9679 @opindex mlong64
9680 Force @code{long} types to be 64 bits wide. See @option{-mlong32} for
9681 an explanation of the default and the way that the pointer size is
9682 determined.
9683
9684 @item -mlong32
9685 @opindex mlong32
9686 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
9687
9688 The default size of @code{int}s, @code{long}s and pointers depends on
9689 the ABI@. All the supported ABIs use 32-bit @code{int}s. The n64 ABI
9690 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
9691 32-bit @code{long}s. Pointers are the same size as @code{long}s,
9692 or the same size as integer registers, whichever is smaller.
9693
9694 @item -msym32
9695 @itemx -mno-sym32
9696 @opindex msym32
9697 @opindex mno-sym32
9698 Assume (do not assume) that all symbols have 32-bit values, regardless
9699 of the selected ABI@. This option is useful in combination with
9700 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
9701 to generate shorter and faster references to symbolic addresses.
9702
9703 @item -G @var{num}
9704 @opindex G
9705 @cindex smaller data references (MIPS)
9706 @cindex gp-relative references (MIPS)
9707 Put global and static items less than or equal to @var{num} bytes into
9708 the small data or bss section instead of the normal data or bss section.
9709 This allows the data to be accessed using a single instruction.
9710
9711 All modules should be compiled with the same @option{-G @var{num}}
9712 value.
9713
9714 @item -membedded-data
9715 @itemx -mno-embedded-data
9716 @opindex membedded-data
9717 @opindex mno-embedded-data
9718 Allocate variables to the read-only data section first if possible, then
9719 next in the small data section if possible, otherwise in data. This gives
9720 slightly slower code than the default, but reduces the amount of RAM required
9721 when executing, and thus may be preferred for some embedded systems.
9722
9723 @item -muninit-const-in-rodata
9724 @itemx -mno-uninit-const-in-rodata
9725 @opindex muninit-const-in-rodata
9726 @opindex mno-uninit-const-in-rodata
9727 Put uninitialized @code{const} variables in the read-only data section.
9728 This option is only meaningful in conjunction with @option{-membedded-data}.
9729
9730 @item -msplit-addresses
9731 @itemx -mno-split-addresses
9732 @opindex msplit-addresses
9733 @opindex mno-split-addresses
9734 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
9735 relocation operators. This option has been superceded by
9736 @option{-mexplicit-relocs} but is retained for backwards compatibility.
9737
9738 @item -mexplicit-relocs
9739 @itemx -mno-explicit-relocs
9740 @opindex mexplicit-relocs
9741 @opindex mno-explicit-relocs
9742 Use (do not use) assembler relocation operators when dealing with symbolic
9743 addresses. The alternative, selected by @option{-mno-explicit-relocs},
9744 is to use assembler macros instead.
9745
9746 @option{-mexplicit-relocs} is the default if GCC was configured
9747 to use an assembler that supports relocation operators.
9748
9749 @item -mcheck-zero-division
9750 @itemx -mno-check-zero-division
9751 @opindex mcheck-zero-division
9752 @opindex mno-check-zero-division
9753 Trap (do not trap) on integer division by zero. The default is
9754 @option{-mcheck-zero-division}.
9755
9756 @item -mdivide-traps
9757 @itemx -mdivide-breaks
9758 @opindex mdivide-traps
9759 @opindex mdivide-breaks
9760 MIPS systems check for division by zero by generating either a
9761 conditional trap or a break instruction. Using traps results in
9762 smaller code, but is only supported on MIPS II and later. Also, some
9763 versions of the Linux kernel have a bug that prevents trap from
9764 generating the proper signal (@code{SIGFPE}). Use @option{-mdivide-traps} to
9765 allow conditional traps on architectures that support them and
9766 @option{-mdivide-breaks} to force the use of breaks.
9767
9768 The default is usually @option{-mdivide-traps}, but this can be
9769 overridden at configure time using @option{--with-divide=breaks}.
9770 Divide-by-zero checks can be completely disabled using
9771 @option{-mno-check-zero-division}.
9772
9773 @item -mmemcpy
9774 @itemx -mno-memcpy
9775 @opindex mmemcpy
9776 @opindex mno-memcpy
9777 Force (do not force) the use of @code{memcpy()} for non-trivial block
9778 moves. The default is @option{-mno-memcpy}, which allows GCC to inline
9779 most constant-sized copies.
9780
9781 @item -mlong-calls
9782 @itemx -mno-long-calls
9783 @opindex mlong-calls
9784 @opindex mno-long-calls
9785 Disable (do not disable) use of the @code{jal} instruction. Calling
9786 functions using @code{jal} is more efficient but requires the caller
9787 and callee to be in the same 256 megabyte segment.
9788
9789 This option has no effect on abicalls code. The default is
9790 @option{-mno-long-calls}.
9791
9792 @item -mmad
9793 @itemx -mno-mad
9794 @opindex mmad
9795 @opindex mno-mad
9796 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
9797 instructions, as provided by the R4650 ISA@.
9798
9799 @item -mfused-madd
9800 @itemx -mno-fused-madd
9801 @opindex mfused-madd
9802 @opindex mno-fused-madd
9803 Enable (disable) use of the floating point multiply-accumulate
9804 instructions, when they are available. The default is
9805 @option{-mfused-madd}.
9806
9807 When multiply-accumulate instructions are used, the intermediate
9808 product is calculated to infinite precision and is not subject to
9809 the FCSR Flush to Zero bit. This may be undesirable in some
9810 circumstances.
9811
9812 @item -nocpp
9813 @opindex nocpp
9814 Tell the MIPS assembler to not run its preprocessor over user
9815 assembler files (with a @samp{.s} suffix) when assembling them.
9816
9817 @item -mfix-r4000
9818 @itemx -mno-fix-r4000
9819 @opindex mfix-r4000
9820 @opindex mno-fix-r4000
9821 Work around certain R4000 CPU errata:
9822 @itemize @minus
9823 @item
9824 A double-word or a variable shift may give an incorrect result if executed
9825 immediately after starting an integer division.
9826 @item
9827 A double-word or a variable shift may give an incorrect result if executed
9828 while an integer multiplication is in progress.
9829 @item
9830 An integer division may give an incorrect result if started in a delay slot
9831 of a taken branch or a jump.
9832 @end itemize
9833
9834 @item -mfix-r4400
9835 @itemx -mno-fix-r4400
9836 @opindex mfix-r4400
9837 @opindex mno-fix-r4400
9838 Work around certain R4400 CPU errata:
9839 @itemize @minus
9840 @item
9841 A double-word or a variable shift may give an incorrect result if executed
9842 immediately after starting an integer division.
9843 @end itemize
9844
9845 @item -mfix-vr4120
9846 @itemx -mno-fix-vr4120
9847 @opindex mfix-vr4120
9848 Work around certain VR4120 errata:
9849 @itemize @minus
9850 @item
9851 @code{dmultu} does not always produce the correct result.
9852 @item
9853 @code{div} and @code{ddiv} do not always produce the correct result if one
9854 of the operands is negative.
9855 @end itemize
9856 The workarounds for the division errata rely on special functions in
9857 @file{libgcc.a}. At present, these functions are only provided by
9858 the @code{mips64vr*-elf} configurations.
9859
9860 Other VR4120 errata require a nop to be inserted between certain pairs of
9861 instructions. These errata are handled by the assembler, not by GCC itself.
9862
9863 @item -mfix-vr4130
9864 @opindex mfix-vr4130
9865 Work around the VR4130 @code{mflo}/@code{mfhi} errata. The
9866 workarounds are implemented by the assembler rather than by GCC,
9867 although GCC will avoid using @code{mflo} and @code{mfhi} if the
9868 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
9869 instructions are available instead.
9870
9871 @item -mfix-sb1
9872 @itemx -mno-fix-sb1
9873 @opindex mfix-sb1
9874 Work around certain SB-1 CPU core errata.
9875 (This flag currently works around the SB-1 revision 2
9876 ``F1'' and ``F2'' floating point errata.)
9877
9878 @item -mflush-func=@var{func}
9879 @itemx -mno-flush-func
9880 @opindex mflush-func
9881 Specifies the function to call to flush the I and D caches, or to not
9882 call any such function. If called, the function must take the same
9883 arguments as the common @code{_flush_func()}, that is, the address of the
9884 memory range for which the cache is being flushed, the size of the
9885 memory range, and the number 3 (to flush both caches). The default
9886 depends on the target GCC was configured for, but commonly is either
9887 @samp{_flush_func} or @samp{__cpu_flush}.
9888
9889 @item -mbranch-likely
9890 @itemx -mno-branch-likely
9891 @opindex mbranch-likely
9892 @opindex mno-branch-likely
9893 Enable or disable use of Branch Likely instructions, regardless of the
9894 default for the selected architecture. By default, Branch Likely
9895 instructions may be generated if they are supported by the selected
9896 architecture. An exception is for the MIPS32 and MIPS64 architectures
9897 and processors which implement those architectures; for those, Branch
9898 Likely instructions will not be generated by default because the MIPS32
9899 and MIPS64 architectures specifically deprecate their use.
9900
9901 @item -mfp-exceptions
9902 @itemx -mno-fp-exceptions
9903 @opindex mfp-exceptions
9904 Specifies whether FP exceptions are enabled. This affects how we schedule
9905 FP instructions for some processors. The default is that FP exceptions are
9906 enabled.
9907
9908 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
9909 64-bit code, then we can use both FP pipes. Otherwise, we can only use one
9910 FP pipe.
9911
9912 @item -mvr4130-align
9913 @itemx -mno-vr4130-align
9914 @opindex mvr4130-align
9915 The VR4130 pipeline is two-way superscalar, but can only issue two
9916 instructions together if the first one is 8-byte aligned. When this
9917 option is enabled, GCC will align pairs of instructions that it
9918 thinks should execute in parallel.
9919
9920 This option only has an effect when optimizing for the VR4130.
9921 It normally makes code faster, but at the expense of making it bigger.
9922 It is enabled by default at optimization level @option{-O3}.
9923 @end table
9924
9925 @node MMIX Options
9926 @subsection MMIX Options
9927 @cindex MMIX Options
9928
9929 These options are defined for the MMIX:
9930
9931 @table @gcctabopt
9932 @item -mlibfuncs
9933 @itemx -mno-libfuncs
9934 @opindex mlibfuncs
9935 @opindex mno-libfuncs
9936 Specify that intrinsic library functions are being compiled, passing all
9937 values in registers, no matter the size.
9938
9939 @item -mepsilon
9940 @itemx -mno-epsilon
9941 @opindex mepsilon
9942 @opindex mno-epsilon
9943 Generate floating-point comparison instructions that compare with respect
9944 to the @code{rE} epsilon register.
9945
9946 @item -mabi=mmixware
9947 @itemx -mabi=gnu
9948 @opindex mabi-mmixware
9949 @opindex mabi=gnu
9950 Generate code that passes function parameters and return values that (in
9951 the called function) are seen as registers @code{$0} and up, as opposed to
9952 the GNU ABI which uses global registers @code{$231} and up.
9953
9954 @item -mzero-extend
9955 @itemx -mno-zero-extend
9956 @opindex mzero-extend
9957 @opindex mno-zero-extend
9958 When reading data from memory in sizes shorter than 64 bits, use (do not
9959 use) zero-extending load instructions by default, rather than
9960 sign-extending ones.
9961
9962 @item -mknuthdiv
9963 @itemx -mno-knuthdiv
9964 @opindex mknuthdiv
9965 @opindex mno-knuthdiv
9966 Make the result of a division yielding a remainder have the same sign as
9967 the divisor. With the default, @option{-mno-knuthdiv}, the sign of the
9968 remainder follows the sign of the dividend. Both methods are
9969 arithmetically valid, the latter being almost exclusively used.
9970
9971 @item -mtoplevel-symbols
9972 @itemx -mno-toplevel-symbols
9973 @opindex mtoplevel-symbols
9974 @opindex mno-toplevel-symbols
9975 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
9976 code can be used with the @code{PREFIX} assembly directive.
9977
9978 @item -melf
9979 @opindex melf
9980 Generate an executable in the ELF format, rather than the default
9981 @samp{mmo} format used by the @command{mmix} simulator.
9982
9983 @item -mbranch-predict
9984 @itemx -mno-branch-predict
9985 @opindex mbranch-predict
9986 @opindex mno-branch-predict
9987 Use (do not use) the probable-branch instructions, when static branch
9988 prediction indicates a probable branch.
9989
9990 @item -mbase-addresses
9991 @itemx -mno-base-addresses
9992 @opindex mbase-addresses
9993 @opindex mno-base-addresses
9994 Generate (do not generate) code that uses @emph{base addresses}. Using a
9995 base address automatically generates a request (handled by the assembler
9996 and the linker) for a constant to be set up in a global register. The
9997 register is used for one or more base address requests within the range 0
9998 to 255 from the value held in the register. The generally leads to short
9999 and fast code, but the number of different data items that can be
10000 addressed is limited. This means that a program that uses lots of static
10001 data may require @option{-mno-base-addresses}.
10002
10003 @item -msingle-exit
10004 @itemx -mno-single-exit
10005 @opindex msingle-exit
10006 @opindex mno-single-exit
10007 Force (do not force) generated code to have a single exit point in each
10008 function.
10009 @end table
10010
10011 @node MN10300 Options
10012 @subsection MN10300 Options
10013 @cindex MN10300 options
10014
10015 These @option{-m} options are defined for Matsushita MN10300 architectures:
10016
10017 @table @gcctabopt
10018 @item -mmult-bug
10019 @opindex mmult-bug
10020 Generate code to avoid bugs in the multiply instructions for the MN10300
10021 processors. This is the default.
10022
10023 @item -mno-mult-bug
10024 @opindex mno-mult-bug
10025 Do not generate code to avoid bugs in the multiply instructions for the
10026 MN10300 processors.
10027
10028 @item -mam33
10029 @opindex mam33
10030 Generate code which uses features specific to the AM33 processor.
10031
10032 @item -mno-am33
10033 @opindex mno-am33
10034 Do not generate code which uses features specific to the AM33 processor. This
10035 is the default.
10036
10037 @item -mno-crt0
10038 @opindex mno-crt0
10039 Do not link in the C run-time initialization object file.
10040
10041 @item -mrelax
10042 @opindex mrelax
10043 Indicate to the linker that it should perform a relaxation optimization pass
10044 to shorten branches, calls and absolute memory addresses. This option only
10045 has an effect when used on the command line for the final link step.
10046
10047 This option makes symbolic debugging impossible.
10048 @end table
10049
10050 @node NS32K Options
10051 @subsection NS32K Options
10052 @cindex NS32K options
10053
10054 These are the @samp{-m} options defined for the 32000 series. The default
10055 values for these options depends on which style of 32000 was selected when
10056 the compiler was configured; the defaults for the most common choices are
10057 given below.
10058
10059 @table @gcctabopt
10060 @item -m32032
10061 @itemx -m32032
10062 @opindex m32032
10063 @opindex m32032
10064 Generate output for a 32032. This is the default
10065 when the compiler is configured for 32032 and 32016 based systems.
10066
10067 @item -m32332
10068 @itemx -m32332
10069 @opindex m32332
10070 @opindex m32332
10071 Generate output for a 32332. This is the default
10072 when the compiler is configured for 32332-based systems.
10073
10074 @item -m32532
10075 @itemx -m32532
10076 @opindex m32532
10077 @opindex m32532
10078 Generate output for a 32532. This is the default
10079 when the compiler is configured for 32532-based systems.
10080
10081 @item -m32081
10082 @opindex m32081
10083 Generate output containing 32081 instructions for floating point.
10084 This is the default for all systems.
10085
10086 @item -m32381
10087 @opindex m32381
10088 Generate output containing 32381 instructions for floating point. This
10089 also implies @option{-m32081}. The 32381 is only compatible with the 32332
10090 and 32532 cpus. This is the default for the pc532-netbsd configuration.
10091
10092 @item -mmulti-add
10093 @opindex mmulti-add
10094 Try and generate multiply-add floating point instructions @code{polyF}
10095 and @code{dotF}. This option is only available if the @option{-m32381}
10096 option is in effect. Using these instructions requires changes to
10097 register allocation which generally has a negative impact on
10098 performance. This option should only be enabled when compiling code
10099 particularly likely to make heavy use of multiply-add instructions.
10100
10101 @item -mnomulti-add
10102 @opindex mnomulti-add
10103 Do not try and generate multiply-add floating point instructions
10104 @code{polyF} and @code{dotF}. This is the default on all platforms.
10105
10106 @item -msoft-float
10107 @opindex msoft-float
10108 Generate output containing library calls for floating point.
10109 @strong{Warning:} the requisite libraries may not be available.
10110
10111 @item -mieee-compare
10112 @itemx -mno-ieee-compare
10113 @opindex mieee-compare
10114 @opindex mno-ieee-compare
10115 Control whether or not the compiler uses IEEE floating point
10116 comparisons. These handle correctly the case where the result of a
10117 comparison is unordered.
10118 @strong{Warning:} the requisite kernel support may not be available.
10119
10120 @item -mnobitfield
10121 @opindex mnobitfield
10122 Do not use the bit-field instructions. On some machines it is faster to
10123 use shifting and masking operations. This is the default for the pc532.
10124
10125 @item -mbitfield
10126 @opindex mbitfield
10127 Do use the bit-field instructions. This is the default for all platforms
10128 except the pc532.
10129
10130 @item -mrtd
10131 @opindex mrtd
10132 Use a different function-calling convention, in which functions
10133 that take a fixed number of arguments return pop their
10134 arguments on return with the @code{ret} instruction.
10135
10136 This calling convention is incompatible with the one normally
10137 used on Unix, so you cannot use it if you need to call libraries
10138 compiled with the Unix compiler.
10139
10140 Also, you must provide function prototypes for all functions that
10141 take variable numbers of arguments (including @code{printf});
10142 otherwise incorrect code will be generated for calls to those
10143 functions.
10144
10145 In addition, seriously incorrect code will result if you call a
10146 function with too many arguments. (Normally, extra arguments are
10147 harmlessly ignored.)
10148
10149 This option takes its name from the 680x0 @code{rtd} instruction.
10150
10151
10152 @item -mregparam
10153 @opindex mregparam
10154 Use a different function-calling convention where the first two arguments
10155 are passed in registers.
10156
10157 This calling convention is incompatible with the one normally
10158 used on Unix, so you cannot use it if you need to call libraries
10159 compiled with the Unix compiler.
10160
10161 @item -mnoregparam
10162 @opindex mnoregparam
10163 Do not pass any arguments in registers. This is the default for all
10164 targets.
10165
10166 @item -msb
10167 @opindex msb
10168 It is OK to use the sb as an index register which is always loaded with
10169 zero. This is the default for the pc532-netbsd target.
10170
10171 @item -mnosb
10172 @opindex mnosb
10173 The sb register is not available for use or has not been initialized to
10174 zero by the run time system. This is the default for all targets except
10175 the pc532-netbsd. It is also implied whenever @option{-mhimem} or
10176 @option{-fpic} is set.
10177
10178 @item -mhimem
10179 @opindex mhimem
10180 Many ns32000 series addressing modes use displacements of up to 512MB@.
10181 If an address is above 512MB then displacements from zero can not be used.
10182 This option causes code to be generated which can be loaded above 512MB@.
10183 This may be useful for operating systems or ROM code.
10184
10185 @item -mnohimem
10186 @opindex mnohimem
10187 Assume code will be loaded in the first 512MB of virtual address space.
10188 This is the default for all platforms.
10189
10190 @end table
10191
10192 @node PDP-11 Options
10193 @subsection PDP-11 Options
10194 @cindex PDP-11 Options
10195
10196 These options are defined for the PDP-11:
10197
10198 @table @gcctabopt
10199 @item -mfpu
10200 @opindex mfpu
10201 Use hardware FPP floating point. This is the default. (FIS floating
10202 point on the PDP-11/40 is not supported.)
10203
10204 @item -msoft-float
10205 @opindex msoft-float
10206 Do not use hardware floating point.
10207
10208 @item -mac0
10209 @opindex mac0
10210 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10211
10212 @item -mno-ac0
10213 @opindex mno-ac0
10214 Return floating-point results in memory. This is the default.
10215
10216 @item -m40
10217 @opindex m40
10218 Generate code for a PDP-11/40.
10219
10220 @item -m45
10221 @opindex m45
10222 Generate code for a PDP-11/45. This is the default.
10223
10224 @item -m10
10225 @opindex m10
10226 Generate code for a PDP-11/10.
10227
10228 @item -mbcopy-builtin
10229 @opindex bcopy-builtin
10230 Use inline @code{movmemhi} patterns for copying memory. This is the
10231 default.
10232
10233 @item -mbcopy
10234 @opindex mbcopy
10235 Do not use inline @code{movmemhi} patterns for copying memory.
10236
10237 @item -mint16
10238 @itemx -mno-int32
10239 @opindex mint16
10240 @opindex mno-int32
10241 Use 16-bit @code{int}. This is the default.
10242
10243 @item -mint32
10244 @itemx -mno-int16
10245 @opindex mint32
10246 @opindex mno-int16
10247 Use 32-bit @code{int}.
10248
10249 @item -mfloat64
10250 @itemx -mno-float32
10251 @opindex mfloat64
10252 @opindex mno-float32
10253 Use 64-bit @code{float}. This is the default.
10254
10255 @item -mfloat32
10256 @itemx -mno-float64
10257 @opindex mfloat32
10258 @opindex mno-float64
10259 Use 32-bit @code{float}.
10260
10261 @item -mabshi
10262 @opindex mabshi
10263 Use @code{abshi2} pattern. This is the default.
10264
10265 @item -mno-abshi
10266 @opindex mno-abshi
10267 Do not use @code{abshi2} pattern.
10268
10269 @item -mbranch-expensive
10270 @opindex mbranch-expensive
10271 Pretend that branches are expensive. This is for experimenting with
10272 code generation only.
10273
10274 @item -mbranch-cheap
10275 @opindex mbranch-cheap
10276 Do not pretend that branches are expensive. This is the default.
10277
10278 @item -msplit
10279 @opindex msplit
10280 Generate code for a system with split I&D@.
10281
10282 @item -mno-split
10283 @opindex mno-split
10284 Generate code for a system without split I&D@. This is the default.
10285
10286 @item -munix-asm
10287 @opindex munix-asm
10288 Use Unix assembler syntax. This is the default when configured for
10289 @samp{pdp11-*-bsd}.
10290
10291 @item -mdec-asm
10292 @opindex mdec-asm
10293 Use DEC assembler syntax. This is the default when configured for any
10294 PDP-11 target other than @samp{pdp11-*-bsd}.
10295 @end table
10296
10297 @node PowerPC Options
10298 @subsection PowerPC Options
10299 @cindex PowerPC options
10300
10301 These are listed under @xref{RS/6000 and PowerPC Options}.
10302
10303 @node RS/6000 and PowerPC Options
10304 @subsection IBM RS/6000 and PowerPC Options
10305 @cindex RS/6000 and PowerPC Options
10306 @cindex IBM RS/6000 and PowerPC Options
10307
10308 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10309 @table @gcctabopt
10310 @item -mpower
10311 @itemx -mno-power
10312 @itemx -mpower2
10313 @itemx -mno-power2
10314 @itemx -mpowerpc
10315 @itemx -mno-powerpc
10316 @itemx -mpowerpc-gpopt
10317 @itemx -mno-powerpc-gpopt
10318 @itemx -mpowerpc-gfxopt
10319 @itemx -mno-powerpc-gfxopt
10320 @itemx -mpowerpc64
10321 @itemx -mno-powerpc64
10322 @opindex mpower
10323 @opindex mno-power
10324 @opindex mpower2
10325 @opindex mno-power2
10326 @opindex mpowerpc
10327 @opindex mno-powerpc
10328 @opindex mpowerpc-gpopt
10329 @opindex mno-powerpc-gpopt
10330 @opindex mpowerpc-gfxopt
10331 @opindex mno-powerpc-gfxopt
10332 @opindex mpowerpc64
10333 @opindex mno-powerpc64
10334 GCC supports two related instruction set architectures for the
10335 RS/6000 and PowerPC@. The @dfn{POWER} instruction set are those
10336 instructions supported by the @samp{rios} chip set used in the original
10337 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10338 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
10339 the IBM 4xx microprocessors.
10340
10341 Neither architecture is a subset of the other. However there is a
10342 large common subset of instructions supported by both. An MQ
10343 register is included in processors supporting the POWER architecture.
10344
10345 You use these options to specify which instructions are available on the
10346 processor you are using. The default value of these options is
10347 determined when configuring GCC@. Specifying the
10348 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10349 options. We recommend you use the @option{-mcpu=@var{cpu_type}} option
10350 rather than the options listed above.
10351
10352 The @option{-mpower} option allows GCC to generate instructions that
10353 are found only in the POWER architecture and to use the MQ register.
10354 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10355 to generate instructions that are present in the POWER2 architecture but
10356 not the original POWER architecture.
10357
10358 The @option{-mpowerpc} option allows GCC to generate instructions that
10359 are found only in the 32-bit subset of the PowerPC architecture.
10360 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10361 GCC to use the optional PowerPC architecture instructions in the
10362 General Purpose group, including floating-point square root. Specifying
10363 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10364 use the optional PowerPC architecture instructions in the Graphics
10365 group, including floating-point select.
10366
10367 The @option{-mpowerpc64} option allows GCC to generate the additional
10368 64-bit instructions that are found in the full PowerPC64 architecture
10369 and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to
10370 @option{-mno-powerpc64}.
10371
10372 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10373 will use only the instructions in the common subset of both
10374 architectures plus some special AIX common-mode calls, and will not use
10375 the MQ register. Specifying both @option{-mpower} and @option{-mpowerpc}
10376 permits GCC to use any instruction from either architecture and to
10377 allow use of the MQ register; specify this for the Motorola MPC601.
10378
10379 @item -mnew-mnemonics
10380 @itemx -mold-mnemonics
10381 @opindex mnew-mnemonics
10382 @opindex mold-mnemonics
10383 Select which mnemonics to use in the generated assembler code. With
10384 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10385 the PowerPC architecture. With @option{-mold-mnemonics} it uses the
10386 assembler mnemonics defined for the POWER architecture. Instructions
10387 defined in only one architecture have only one mnemonic; GCC uses that
10388 mnemonic irrespective of which of these options is specified.
10389
10390 GCC defaults to the mnemonics appropriate for the architecture in
10391 use. Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10392 value of these option. Unless you are building a cross-compiler, you
10393 should normally not specify either @option{-mnew-mnemonics} or
10394 @option{-mold-mnemonics}, but should instead accept the default.
10395
10396 @item -mcpu=@var{cpu_type}
10397 @opindex mcpu
10398 Set architecture type, register usage, choice of mnemonics, and
10399 instruction scheduling parameters for machine type @var{cpu_type}.
10400 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10401 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10402 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10403 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10404 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10405 @samp{860}, @samp{970}, @samp{8540}, @samp{common}, @samp{ec603e}, @samp{G3},
10406 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10407 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
10408 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64a}.
10409
10410 @option{-mcpu=common} selects a completely generic processor. Code
10411 generated under this option will run on any POWER or PowerPC processor.
10412 GCC will use only the instructions in the common subset of both
10413 architectures, and will not use the MQ register. GCC assumes a generic
10414 processor model for scheduling purposes.
10415
10416 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10417 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10418 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10419 types, with an appropriate, generic processor model assumed for
10420 scheduling purposes.
10421
10422 The other options specify a specific processor. Code generated under
10423 those options will run best on that processor, and may not run at all on
10424 others.
10425
10426 The @option{-mcpu} options automatically enable or disable the
10427 following options: @option{-maltivec}, @option{-mhard-float},
10428 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10429 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10430 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10431 @option{-mstring}. The particular options set for any particular CPU
10432 will vary between compiler versions, depending on what setting seems
10433 to produce optimal code for that CPU; it doesn't necessarily reflect
10434 the actual hardware's capabilities. If you wish to set an individual
10435 option to a particular value, you may specify it after the
10436 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10437
10438 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10439 not enabled or disabled by the @option{-mcpu} option at present, since
10440 AIX does not have full support for these options. You may still
10441 enable or disable them individually if you're sure it'll work in your
10442 environment.
10443
10444 @item -mtune=@var{cpu_type}
10445 @opindex mtune
10446 Set the instruction scheduling parameters for machine type
10447 @var{cpu_type}, but do not set the architecture type, register usage, or
10448 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would. The same
10449 values for @var{cpu_type} are used for @option{-mtune} as for
10450 @option{-mcpu}. If both are specified, the code generated will use the
10451 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10452 scheduling parameters set by @option{-mtune}.
10453
10454 @item -maltivec
10455 @itemx -mno-altivec
10456 @opindex maltivec
10457 @opindex mno-altivec
10458 Generate code that uses (does not use) AltiVec instructions, and also
10459 enable the use of built-in functions that allow more direct access to
10460 the AltiVec instruction set. You may also need to set
10461 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10462 enhancements.
10463
10464 @item -mabi=spe
10465 @opindex mabi=spe
10466 Extend the current ABI with SPE ABI extensions. This does not change
10467 the default ABI, instead it adds the SPE ABI extensions to the current
10468 ABI@.
10469
10470 @item -mabi=no-spe
10471 @opindex mabi=no-spe
10472 Disable Booke SPE ABI extensions for the current ABI@.
10473
10474 @item -misel=@var{yes/no}
10475 @itemx -misel
10476 @opindex misel
10477 This switch enables or disables the generation of ISEL instructions.
10478
10479 @item -mspe=@var{yes/no}
10480 @itemx -mspe
10481 @opindex mspe
10482 This switch enables or disables the generation of SPE simd
10483 instructions.
10484
10485 @item -mfloat-gprs=@var{yes/single/double/no}
10486 @itemx -mfloat-gprs
10487 @opindex mfloat-gprs
10488 This switch enables or disables the generation of floating point
10489 operations on the general purpose registers for architectures that
10490 support it.
10491
10492 The argument @var{yes} or @var{single} enables the use of
10493 single-precision floating point operations.
10494
10495 The argument @var{double} enables the use of single and
10496 double-precision floating point operations.
10497
10498 The argument @var{no} disables floating point operations on the
10499 general purpose registers.
10500
10501 This option is currently only available on the MPC854x.
10502
10503 @item -m32
10504 @itemx -m64
10505 @opindex m32
10506 @opindex m64
10507 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10508 targets (including GNU/Linux). The 32-bit environment sets int, long
10509 and pointer to 32 bits and generates code that runs on any PowerPC
10510 variant. The 64-bit environment sets int to 32 bits and long and
10511 pointer to 64 bits, and generates code for PowerPC64, as for
10512 @option{-mpowerpc64}.
10513
10514 @item -mfull-toc
10515 @itemx -mno-fp-in-toc
10516 @itemx -mno-sum-in-toc
10517 @itemx -mminimal-toc
10518 @opindex mfull-toc
10519 @opindex mno-fp-in-toc
10520 @opindex mno-sum-in-toc
10521 @opindex mminimal-toc
10522 Modify generation of the TOC (Table Of Contents), which is created for
10523 every executable file. The @option{-mfull-toc} option is selected by
10524 default. In that case, GCC will allocate at least one TOC entry for
10525 each unique non-automatic variable reference in your program. GCC
10526 will also place floating-point constants in the TOC@. However, only
10527 16,384 entries are available in the TOC@.
10528
10529 If you receive a linker error message that saying you have overflowed
10530 the available TOC space, you can reduce the amount of TOC space used
10531 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10532 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10533 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10534 generate code to calculate the sum of an address and a constant at
10535 run-time instead of putting that sum into the TOC@. You may specify one
10536 or both of these options. Each causes GCC to produce very slightly
10537 slower and larger code at the expense of conserving TOC space.
10538
10539 If you still run out of space in the TOC even when you specify both of
10540 these options, specify @option{-mminimal-toc} instead. This option causes
10541 GCC to make only one TOC entry for every file. When you specify this
10542 option, GCC will produce code that is slower and larger but which
10543 uses extremely little TOC space. You may wish to use this option
10544 only on files that contain less frequently executed code.
10545
10546 @item -maix64
10547 @itemx -maix32
10548 @opindex maix64
10549 @opindex maix32
10550 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10551 @code{long} type, and the infrastructure needed to support them.
10552 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10553 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10554 implies @option{-mno-powerpc64}. GCC defaults to @option{-maix32}.
10555
10556 @item -mxl-compat
10557 @itemx -mno-xl-compat
10558 @opindex mxl-compat
10559 @opindex mno-xl-compat
10560 Produce code that conforms more closely to IBM XLC semantics when using
10561 AIX-compatible ABI. Pass floating-point arguments to prototyped
10562 functions beyond the register save area (RSA) on the stack in addition
10563 to argument FPRs. Do not assume that most significant double in 128
10564 bit long double value is properly rounded when comparing values.
10565
10566 The AIX calling convention was extended but not initially documented to
10567 handle an obscure K&R C case of calling a function that takes the
10568 address of its arguments with fewer arguments than declared. AIX XL
10569 compilers access floating point arguments which do not fit in the
10570 RSA from the stack when a subroutine is compiled without
10571 optimization. Because always storing floating-point arguments on the
10572 stack is inefficient and rarely needed, this option is not enabled by
10573 default and only is necessary when calling subroutines compiled by AIX
10574 XL compilers without optimization.
10575
10576 @item -mpe
10577 @opindex mpe
10578 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@. Link an
10579 application written to use message passing with special startup code to
10580 enable the application to run. The system must have PE installed in the
10581 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10582 must be overridden with the @option{-specs=} option to specify the
10583 appropriate directory location. The Parallel Environment does not
10584 support threads, so the @option{-mpe} option and the @option{-pthread}
10585 option are incompatible.
10586
10587 @item -malign-natural
10588 @itemx -malign-power
10589 @opindex malign-natural
10590 @opindex malign-power
10591 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
10592 @option{-malign-natural} overrides the ABI-defined alignment of larger
10593 types, such as floating-point doubles, on their natural size-based boundary.
10594 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10595 alignment rules. GCC defaults to the standard alignment defined in the ABI@.
10596
10597 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
10598 is not supported.
10599
10600 @item -msoft-float
10601 @itemx -mhard-float
10602 @opindex msoft-float
10603 @opindex mhard-float
10604 Generate code that does not use (uses) the floating-point register set.
10605 Software floating point emulation is provided if you use the
10606 @option{-msoft-float} option, and pass the option to GCC when linking.
10607
10608 @item -mmultiple
10609 @itemx -mno-multiple
10610 @opindex mmultiple
10611 @opindex mno-multiple
10612 Generate code that uses (does not use) the load multiple word
10613 instructions and the store multiple word instructions. These
10614 instructions are generated by default on POWER systems, and not
10615 generated on PowerPC systems. Do not use @option{-mmultiple} on little
10616 endian PowerPC systems, since those instructions do not work when the
10617 processor is in little endian mode. The exceptions are PPC740 and
10618 PPC750 which permit the instructions usage in little endian mode.
10619
10620 @item -mstring
10621 @itemx -mno-string
10622 @opindex mstring
10623 @opindex mno-string
10624 Generate code that uses (does not use) the load string instructions
10625 and the store string word instructions to save multiple registers and
10626 do small block moves. These instructions are generated by default on
10627 POWER systems, and not generated on PowerPC systems. Do not use
10628 @option{-mstring} on little endian PowerPC systems, since those
10629 instructions do not work when the processor is in little endian mode.
10630 The exceptions are PPC740 and PPC750 which permit the instructions
10631 usage in little endian mode.
10632
10633 @item -mupdate
10634 @itemx -mno-update
10635 @opindex mupdate
10636 @opindex mno-update
10637 Generate code that uses (does not use) the load or store instructions
10638 that update the base register to the address of the calculated memory
10639 location. These instructions are generated by default. If you use
10640 @option{-mno-update}, there is a small window between the time that the
10641 stack pointer is updated and the address of the previous frame is
10642 stored, which means code that walks the stack frame across interrupts or
10643 signals may get corrupted data.
10644
10645 @item -mfused-madd
10646 @itemx -mno-fused-madd
10647 @opindex mfused-madd
10648 @opindex mno-fused-madd
10649 Generate code that uses (does not use) the floating point multiply and
10650 accumulate instructions. These instructions are generated by default if
10651 hardware floating is used.
10652
10653 @item -mno-bit-align
10654 @itemx -mbit-align
10655 @opindex mno-bit-align
10656 @opindex mbit-align
10657 On System V.4 and embedded PowerPC systems do not (do) force structures
10658 and unions that contain bit-fields to be aligned to the base type of the
10659 bit-field.
10660
10661 For example, by default a structure containing nothing but 8
10662 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
10663 boundary and have a size of 4 bytes. By using @option{-mno-bit-align},
10664 the structure would be aligned to a 1 byte boundary and be one byte in
10665 size.
10666
10667 @item -mno-strict-align
10668 @itemx -mstrict-align
10669 @opindex mno-strict-align
10670 @opindex mstrict-align
10671 On System V.4 and embedded PowerPC systems do not (do) assume that
10672 unaligned memory references will be handled by the system.
10673
10674 @item -mrelocatable
10675 @itemx -mno-relocatable
10676 @opindex mrelocatable
10677 @opindex mno-relocatable
10678 On embedded PowerPC systems generate code that allows (does not allow)
10679 the program to be relocated to a different address at runtime. If you
10680 use @option{-mrelocatable} on any module, all objects linked together must
10681 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
10682
10683 @item -mrelocatable-lib
10684 @itemx -mno-relocatable-lib
10685 @opindex mrelocatable-lib
10686 @opindex mno-relocatable-lib
10687 On embedded PowerPC systems generate code that allows (does not allow)
10688 the program to be relocated to a different address at runtime. Modules
10689 compiled with @option{-mrelocatable-lib} can be linked with either modules
10690 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
10691 with modules compiled with the @option{-mrelocatable} options.
10692
10693 @item -mno-toc
10694 @itemx -mtoc
10695 @opindex mno-toc
10696 @opindex mtoc
10697 On System V.4 and embedded PowerPC systems do not (do) assume that
10698 register 2 contains a pointer to a global area pointing to the addresses
10699 used in the program.
10700
10701 @item -mlittle
10702 @itemx -mlittle-endian
10703 @opindex mlittle
10704 @opindex mlittle-endian
10705 On System V.4 and embedded PowerPC systems compile code for the
10706 processor in little endian mode. The @option{-mlittle-endian} option is
10707 the same as @option{-mlittle}.
10708
10709 @item -mbig
10710 @itemx -mbig-endian
10711 @opindex mbig
10712 @opindex mbig-endian
10713 On System V.4 and embedded PowerPC systems compile code for the
10714 processor in big endian mode. The @option{-mbig-endian} option is
10715 the same as @option{-mbig}.
10716
10717 @item -mdynamic-no-pic
10718 @opindex mdynamic-no-pic
10719 On Darwin and Mac OS X systems, compile code so that it is not
10720 relocatable, but that its external references are relocatable. The
10721 resulting code is suitable for applications, but not shared
10722 libraries.
10723
10724 @item -mprioritize-restricted-insns=@var{priority}
10725 @opindex mprioritize-restricted-insns
10726 This option controls the priority that is assigned to
10727 dispatch-slot restricted instructions during the second scheduling
10728 pass. The argument @var{priority} takes the value @var{0/1/2} to assign
10729 @var{no/highest/second-highest} priority to dispatch slot restricted
10730 instructions.
10731
10732 @item -msched-costly-dep=@var{dependence_type}
10733 @opindex msched-costly-dep
10734 This option controls which dependences are considered costly
10735 by the target during instruction scheduling. The argument
10736 @var{dependence_type} takes one of the following values:
10737 @var{no}: no dependence is costly,
10738 @var{all}: all dependences are costly,
10739 @var{true_store_to_load}: a true dependence from store to load is costly,
10740 @var{store_to_load}: any dependence from store to load is costly,
10741 @var{number}: any dependence which latency >= @var{number} is costly.
10742
10743 @item -minsert-sched-nops=@var{scheme}
10744 @opindex minsert-sched-nops
10745 This option controls which nop insertion scheme will be used during
10746 the second scheduling pass. The argument @var{scheme} takes one of the
10747 following values:
10748 @var{no}: Don't insert nops.
10749 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
10750 according to the scheduler's grouping.
10751 @var{regroup_exact}: Insert nops to force costly dependent insns into
10752 separate groups. Insert exactly as many nops as needed to force an insn
10753 to a new group, according to the estimated processor grouping.
10754 @var{number}: Insert nops to force costly dependent insns into
10755 separate groups. Insert @var{number} nops to force an insn to a new group.
10756
10757 @item -mcall-sysv
10758 @opindex mcall-sysv
10759 On System V.4 and embedded PowerPC systems compile code using calling
10760 conventions that adheres to the March 1995 draft of the System V
10761 Application Binary Interface, PowerPC processor supplement. This is the
10762 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
10763
10764 @item -mcall-sysv-eabi
10765 @opindex mcall-sysv-eabi
10766 Specify both @option{-mcall-sysv} and @option{-meabi} options.
10767
10768 @item -mcall-sysv-noeabi
10769 @opindex mcall-sysv-noeabi
10770 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
10771
10772 @item -mcall-solaris
10773 @opindex mcall-solaris
10774 On System V.4 and embedded PowerPC systems compile code for the Solaris
10775 operating system.
10776
10777 @item -mcall-linux
10778 @opindex mcall-linux
10779 On System V.4 and embedded PowerPC systems compile code for the
10780 Linux-based GNU system.
10781
10782 @item -mcall-gnu
10783 @opindex mcall-gnu
10784 On System V.4 and embedded PowerPC systems compile code for the
10785 Hurd-based GNU system.
10786
10787 @item -mcall-netbsd
10788 @opindex mcall-netbsd
10789 On System V.4 and embedded PowerPC systems compile code for the
10790 NetBSD operating system.
10791
10792 @item -maix-struct-return
10793 @opindex maix-struct-return
10794 Return all structures in memory (as specified by the AIX ABI)@.
10795
10796 @item -msvr4-struct-return
10797 @opindex msvr4-struct-return
10798 Return structures smaller than 8 bytes in registers (as specified by the
10799 SVR4 ABI)@.
10800
10801 @item -mabi=altivec
10802 @opindex mabi=altivec
10803 Extend the current ABI with AltiVec ABI extensions. This does not
10804 change the default ABI, instead it adds the AltiVec ABI extensions to
10805 the current ABI@.
10806
10807 @item -mabi=no-altivec
10808 @opindex mabi=no-altivec
10809 Disable AltiVec ABI extensions for the current ABI@.
10810
10811 @item -mprototype
10812 @itemx -mno-prototype
10813 @opindex mprototype
10814 @opindex mno-prototype
10815 On System V.4 and embedded PowerPC systems assume that all calls to
10816 variable argument functions are properly prototyped. Otherwise, the
10817 compiler must insert an instruction before every non prototyped call to
10818 set or clear bit 6 of the condition code register (@var{CR}) to
10819 indicate whether floating point values were passed in the floating point
10820 registers in case the function takes a variable arguments. With
10821 @option{-mprototype}, only calls to prototyped variable argument functions
10822 will set or clear the bit.
10823
10824 @item -msim
10825 @opindex msim
10826 On embedded PowerPC systems, assume that the startup module is called
10827 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
10828 @file{libc.a}. This is the default for @samp{powerpc-*-eabisim}.
10829 configurations.
10830
10831 @item -mmvme
10832 @opindex mmvme
10833 On embedded PowerPC systems, assume that the startup module is called
10834 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
10835 @file{libc.a}.
10836
10837 @item -mads
10838 @opindex mads
10839 On embedded PowerPC systems, assume that the startup module is called
10840 @file{crt0.o} and the standard C libraries are @file{libads.a} and
10841 @file{libc.a}.
10842
10843 @item -myellowknife
10844 @opindex myellowknife
10845 On embedded PowerPC systems, assume that the startup module is called
10846 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
10847 @file{libc.a}.
10848
10849 @item -mvxworks
10850 @opindex mvxworks
10851 On System V.4 and embedded PowerPC systems, specify that you are
10852 compiling for a VxWorks system.
10853
10854 @item -mwindiss
10855 @opindex mwindiss
10856 Specify that you are compiling for the WindISS simulation environment.
10857
10858 @item -memb
10859 @opindex memb
10860 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
10861 header to indicate that @samp{eabi} extended relocations are used.
10862
10863 @item -meabi
10864 @itemx -mno-eabi
10865 @opindex meabi
10866 @opindex mno-eabi
10867 On System V.4 and embedded PowerPC systems do (do not) adhere to the
10868 Embedded Applications Binary Interface (eabi) which is a set of
10869 modifications to the System V.4 specifications. Selecting @option{-meabi}
10870 means that the stack is aligned to an 8 byte boundary, a function
10871 @code{__eabi} is called to from @code{main} to set up the eabi
10872 environment, and the @option{-msdata} option can use both @code{r2} and
10873 @code{r13} to point to two separate small data areas. Selecting
10874 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
10875 do not call an initialization function from @code{main}, and the
10876 @option{-msdata} option will only use @code{r13} to point to a single
10877 small data area. The @option{-meabi} option is on by default if you
10878 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
10879
10880 @item -msdata=eabi
10881 @opindex msdata=eabi
10882 On System V.4 and embedded PowerPC systems, put small initialized
10883 @code{const} global and static data in the @samp{.sdata2} section, which
10884 is pointed to by register @code{r2}. Put small initialized
10885 non-@code{const} global and static data in the @samp{.sdata} section,
10886 which is pointed to by register @code{r13}. Put small uninitialized
10887 global and static data in the @samp{.sbss} section, which is adjacent to
10888 the @samp{.sdata} section. The @option{-msdata=eabi} option is
10889 incompatible with the @option{-mrelocatable} option. The
10890 @option{-msdata=eabi} option also sets the @option{-memb} option.
10891
10892 @item -msdata=sysv
10893 @opindex msdata=sysv
10894 On System V.4 and embedded PowerPC systems, put small global and static
10895 data in the @samp{.sdata} section, which is pointed to by register
10896 @code{r13}. Put small uninitialized global and static data in the
10897 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
10898 The @option{-msdata=sysv} option is incompatible with the
10899 @option{-mrelocatable} option.
10900
10901 @item -msdata=default
10902 @itemx -msdata
10903 @opindex msdata=default
10904 @opindex msdata
10905 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
10906 compile code the same as @option{-msdata=eabi}, otherwise compile code the
10907 same as @option{-msdata=sysv}.
10908
10909 @item -msdata-data
10910 @opindex msdata-data
10911 On System V.4 and embedded PowerPC systems, put small global and static
10912 data in the @samp{.sdata} section. Put small uninitialized global and
10913 static data in the @samp{.sbss} section. Do not use register @code{r13}
10914 to address small data however. This is the default behavior unless
10915 other @option{-msdata} options are used.
10916
10917 @item -msdata=none
10918 @itemx -mno-sdata
10919 @opindex msdata=none
10920 @opindex mno-sdata
10921 On embedded PowerPC systems, put all initialized global and static data
10922 in the @samp{.data} section, and all uninitialized data in the
10923 @samp{.bss} section.
10924
10925 @item -G @var{num}
10926 @opindex G
10927 @cindex smaller data references (PowerPC)
10928 @cindex .sdata/.sdata2 references (PowerPC)
10929 On embedded PowerPC systems, put global and static items less than or
10930 equal to @var{num} bytes into the small data or bss sections instead of
10931 the normal data or bss section. By default, @var{num} is 8. The
10932 @option{-G @var{num}} switch is also passed to the linker.
10933 All modules should be compiled with the same @option{-G @var{num}} value.
10934
10935 @item -mregnames
10936 @itemx -mno-regnames
10937 @opindex mregnames
10938 @opindex mno-regnames
10939 On System V.4 and embedded PowerPC systems do (do not) emit register
10940 names in the assembly language output using symbolic forms.
10941
10942 @item -mlongcall
10943 @itemx -mno-longcall
10944 @opindex mlongcall
10945 @opindex mno-longcall
10946 Default to making all function calls indirectly, using a register, so
10947 that functions which reside further than 32 megabytes (33,554,432
10948 bytes) from the current location can be called. This setting can be
10949 overridden by the @code{shortcall} function attribute, or by
10950 @code{#pragma longcall(0)}.
10951
10952 Some linkers are capable of detecting out-of-range calls and generating
10953 glue code on the fly. On these systems, long calls are unnecessary and
10954 generate slower code. As of this writing, the AIX linker can do this,
10955 as can the GNU linker for PowerPC/64. It is planned to add this feature
10956 to the GNU linker for 32-bit PowerPC systems as well.
10957
10958 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
10959 callee, L42'', plus a ``branch island'' (glue code). The two target
10960 addresses represent the callee and the ``branch island''. The
10961 Darwin/PPC linker will prefer the first address and generate a ``bl
10962 callee'' if the PPC ``bl'' instruction will reach the callee directly;
10963 otherwise, the linker will generate ``bl L42'' to call the ``branch
10964 island''. The ``branch island'' is appended to the body of the
10965 calling function; it computes the full 32-bit address of the callee
10966 and jumps to it.
10967
10968 On Mach-O (Darwin) systems, this option directs the compiler emit to
10969 the glue for every direct call, and the Darwin linker decides whether
10970 to use or discard it.
10971
10972 In the future, we may cause GCC to ignore all longcall specifications
10973 when the linker is known to generate glue.
10974
10975 @item -pthread
10976 @opindex pthread
10977 Adds support for multithreading with the @dfn{pthreads} library.
10978 This option sets flags for both the preprocessor and linker.
10979
10980 @end table
10981
10982 @node S/390 and zSeries Options
10983 @subsection S/390 and zSeries Options
10984 @cindex S/390 and zSeries Options
10985
10986 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10987
10988 @table @gcctabopt
10989 @item -mhard-float
10990 @itemx -msoft-float
10991 @opindex mhard-float
10992 @opindex msoft-float
10993 Use (do not use) the hardware floating-point instructions and registers
10994 for floating-point operations. When @option{-msoft-float} is specified,
10995 functions in @file{libgcc.a} will be used to perform floating-point
10996 operations. When @option{-mhard-float} is specified, the compiler
10997 generates IEEE floating-point instructions. This is the default.
10998
10999 @item -mbackchain
11000 @itemx -mno-backchain
11001 @opindex mbackchain
11002 @opindex mno-backchain
11003 Store (do not store) the address of the caller's frame as backchain pointer
11004 into the callee's stack frame.
11005 A backchain may be needed to allow debugging using tools that do not understand
11006 DWARF-2 call frame information.
11007 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11008 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11009 the backchain is placed into the topmost word of the 96/160 byte register
11010 save area.
11011
11012 In general, code compiled with @option{-mbackchain} is call-compatible with
11013 code compiled with @option{-mmo-backchain}; however, use of the backchain
11014 for debugging purposes usually requires that the whole binary is built with
11015 @option{-mbackchain}. Note that the combination of @option{-mbackchain},
11016 @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
11017 to build a linux kernel use @option{-msoft-float}.
11018
11019 The default is to not maintain the backchain.
11020
11021 @item -mpacked-stack
11022 @item -mno-packed-stack
11023 @opindex mpacked-stack
11024 @opindex mno-packed-stack
11025 Use (do not use) the packed stack layout. When @option{-mno-packed-stack} is
11026 specified, the compiler uses the all fields of the 96/160 byte register save
11027 area only for their default purpose; unused fields still take up stack space.
11028 When @option{-mpacked-stack} is specified, register save slots are densely
11029 packed at the top of the register save area; unused space is reused for other
11030 purposes, allowing for more efficient use of the available stack space.
11031 However, when @option{-mbackchain} is also in effect, the topmost word of
11032 the save area is always used to store the backchain, and the return address
11033 register is always saved two words below the backchain.
11034
11035 As long as the stack frame backchain is not used, code generated with
11036 @option{-mpacked-stack} is call-compatible with code generated with
11037 @option{-mno-packed-stack}. Note that some non-FSF releases of GCC 2.95 for
11038 S/390 or zSeries generated code that uses the stack frame backchain at run
11039 time, not just for debugging purposes. Such code is not call-compatible
11040 with code compiled with @option{-mpacked-stack}. Also, note that the
11041 combination of @option{-mbackchain},
11042 @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
11043 to build a linux kernel use @option{-msoft-float}.
11044
11045 The default is to not use the packed stack layout.
11046
11047 @item -msmall-exec
11048 @itemx -mno-small-exec
11049 @opindex msmall-exec
11050 @opindex mno-small-exec
11051 Generate (or do not generate) code using the @code{bras} instruction
11052 to do subroutine calls.
11053 This only works reliably if the total executable size does not
11054 exceed 64k. The default is to use the @code{basr} instruction instead,
11055 which does not have this limitation.
11056
11057 @item -m64
11058 @itemx -m31
11059 @opindex m64
11060 @opindex m31
11061 When @option{-m31} is specified, generate code compliant to the
11062 GNU/Linux for S/390 ABI@. When @option{-m64} is specified, generate
11063 code compliant to the GNU/Linux for zSeries ABI@. This allows GCC in
11064 particular to generate 64-bit instructions. For the @samp{s390}
11065 targets, the default is @option{-m31}, while the @samp{s390x}
11066 targets default to @option{-m64}.
11067
11068 @item -mzarch
11069 @itemx -mesa
11070 @opindex mzarch
11071 @opindex mesa
11072 When @option{-mzarch} is specified, generate code using the
11073 instructions available on z/Architecture.
11074 When @option{-mesa} is specified, generate code using the
11075 instructions available on ESA/390. Note that @option{-mesa} is
11076 not possible with @option{-m64}.
11077 When generating code compliant to the GNU/Linux for S/390 ABI,
11078 the default is @option{-mesa}. When generating code compliant
11079 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11080
11081 @item -mmvcle
11082 @itemx -mno-mvcle
11083 @opindex mmvcle
11084 @opindex mno-mvcle
11085 Generate (or do not generate) code using the @code{mvcle} instruction
11086 to perform block moves. When @option{-mno-mvcle} is specified,
11087 use a @code{mvc} loop instead. This is the default.
11088
11089 @item -mdebug
11090 @itemx -mno-debug
11091 @opindex mdebug
11092 @opindex mno-debug
11093 Print (or do not print) additional debug information when compiling.
11094 The default is to not print debug information.
11095
11096 @item -march=@var{cpu-type}
11097 @opindex march
11098 Generate code that will run on @var{cpu-type}, which is the name of a system
11099 representing a certain processor type. Possible values for
11100 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11101 When generating code using the instructions available on z/Architecture,
11102 the default is @option{-march=z900}. Otherwise, the default is
11103 @option{-march=g5}.
11104
11105 @item -mtune=@var{cpu-type}
11106 @opindex mtune
11107 Tune to @var{cpu-type} everything applicable about the generated code,
11108 except for the ABI and the set of available instructions.
11109 The list of @var{cpu-type} values is the same as for @option{-march}.
11110 The default is the value used for @option{-march}.
11111
11112 @item -mtpf-trace
11113 @itemx -mno-tpf-trace
11114 @opindex mtpf-trace
11115 @opindex mno-tpf-trace
11116 Generate code that adds (does not add) in TPF OS specific branches to trace
11117 routines in the operating system. This option is off by default, even
11118 when compiling for the TPF OS@.
11119
11120 @item -mfused-madd
11121 @itemx -mno-fused-madd
11122 @opindex mfused-madd
11123 @opindex mno-fused-madd
11124 Generate code that uses (does not use) the floating point multiply and
11125 accumulate instructions. These instructions are generated by default if
11126 hardware floating point is used.
11127
11128 @item -mwarn-framesize=@var{framesize}
11129 @opindex mwarn-framesize
11130 Emit a warning if the current function exceeds the given frame size. Because
11131 this is a compile time check it doesn't need to be a real problem when the program
11132 runs. It is intended to identify functions which most probably cause
11133 a stack overflow. It is useful to be used in an environment with limited stack
11134 size e.g.@: the linux kernel.
11135
11136 @item -mwarn-dynamicstack
11137 @opindex mwarn-dynamicstack
11138 Emit a warning if the function calls alloca or uses dynamically
11139 sized arrays. This is generally a bad idea with a limited stack size.
11140
11141 @item -mstack-guard=@var{stack-guard}
11142 @item -mstack-size=@var{stack-size}
11143 @opindex mstack-guard
11144 @opindex mstack-size
11145 These arguments always have to be used in conjunction. If they are present the s390
11146 back end emits additional instructions in the function prologue which trigger a trap
11147 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11148 (remember that the stack on s390 grows downward). These options are intended to
11149 be used to help debugging stack overflow problems. The additionally emitted code
11150 cause only little overhead and hence can also be used in production like systems
11151 without greater performance degradation. The given values have to be exact
11152 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
11153 In order to be efficient the extra code makes the assumption that the stack starts
11154 at an address aligned to the value given by @var{stack-size}.
11155 @end table
11156
11157 @node SH Options
11158 @subsection SH Options
11159
11160 These @samp{-m} options are defined for the SH implementations:
11161
11162 @table @gcctabopt
11163 @item -m1
11164 @opindex m1
11165 Generate code for the SH1.
11166
11167 @item -m2
11168 @opindex m2
11169 Generate code for the SH2.
11170
11171 @item -m2e
11172 Generate code for the SH2e.
11173
11174 @item -m3
11175 @opindex m3
11176 Generate code for the SH3.
11177
11178 @item -m3e
11179 @opindex m3e
11180 Generate code for the SH3e.
11181
11182 @item -m4-nofpu
11183 @opindex m4-nofpu
11184 Generate code for the SH4 without a floating-point unit.
11185
11186 @item -m4-single-only
11187 @opindex m4-single-only
11188 Generate code for the SH4 with a floating-point unit that only
11189 supports single-precision arithmetic.
11190
11191 @item -m4-single
11192 @opindex m4-single
11193 Generate code for the SH4 assuming the floating-point unit is in
11194 single-precision mode by default.
11195
11196 @item -m4
11197 @opindex m4
11198 Generate code for the SH4.
11199
11200 @item -m4a-nofpu
11201 @opindex m4a-nofpu
11202 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11203 floating-point unit is not used.
11204
11205 @item -m4a-single-only
11206 @opindex m4a-single-only
11207 Generate code for the SH4a, in such a way that no double-precision
11208 floating point operations are used.
11209
11210 @item -m4a-single
11211 @opindex m4a-single
11212 Generate code for the SH4a assuming the floating-point unit is in
11213 single-precision mode by default.
11214
11215 @item -m4a
11216 @opindex m4a
11217 Generate code for the SH4a.
11218
11219 @item -m4al
11220 @opindex m4al
11221 Same as @option{-m4a-nofpu}, except that it implicitly passes
11222 @option{-dsp} to the assembler. GCC doesn't generate any DSP
11223 instructions at the moment.
11224
11225 @item -mb
11226 @opindex mb
11227 Compile code for the processor in big endian mode.
11228
11229 @item -ml
11230 @opindex ml
11231 Compile code for the processor in little endian mode.
11232
11233 @item -mdalign
11234 @opindex mdalign
11235 Align doubles at 64-bit boundaries. Note that this changes the calling
11236 conventions, and thus some functions from the standard C library will
11237 not work unless you recompile it first with @option{-mdalign}.
11238
11239 @item -mrelax
11240 @opindex mrelax
11241 Shorten some address references at link time, when possible; uses the
11242 linker option @option{-relax}.
11243
11244 @item -mbigtable
11245 @opindex mbigtable
11246 Use 32-bit offsets in @code{switch} tables. The default is to use
11247 16-bit offsets.
11248
11249 @item -mfmovd
11250 @opindex mfmovd
11251 Enable the use of the instruction @code{fmovd}.
11252
11253 @item -mhitachi
11254 @opindex mhitachi
11255 Comply with the calling conventions defined by Renesas.
11256
11257 @item -mrenesas
11258 @opindex mhitachi
11259 Comply with the calling conventions defined by Renesas.
11260
11261 @item -mno-renesas
11262 @opindex mhitachi
11263 Comply with the calling conventions defined for GCC before the Renesas
11264 conventions were available. This option is the default for all
11265 targets of the SH toolchain except for @samp{sh-symbianelf}.
11266
11267 @item -mnomacsave
11268 @opindex mnomacsave
11269 Mark the @code{MAC} register as call-clobbered, even if
11270 @option{-mhitachi} is given.
11271
11272 @item -mieee
11273 @opindex mieee
11274 Increase IEEE-compliance of floating-point code.
11275
11276 @item -misize
11277 @opindex misize
11278 Dump instruction size and location in the assembly code.
11279
11280 @item -mpadstruct
11281 @opindex mpadstruct
11282 This option is deprecated. It pads structures to multiple of 4 bytes,
11283 which is incompatible with the SH ABI@.
11284
11285 @item -mspace
11286 @opindex mspace
11287 Optimize for space instead of speed. Implied by @option{-Os}.
11288
11289 @item -mprefergot
11290 @opindex mprefergot
11291 When generating position-independent code, emit function calls using
11292 the Global Offset Table instead of the Procedure Linkage Table.
11293
11294 @item -musermode
11295 @opindex musermode
11296 Generate a library function call to invalidate instruction cache
11297 entries, after fixing up a trampoline. This library function call
11298 doesn't assume it can write to the whole memory address space. This
11299 is the default when the target is @code{sh-*-linux*}.
11300 @end table
11301
11302 @node SPARC Options
11303 @subsection SPARC Options
11304 @cindex SPARC options
11305
11306 These @samp{-m} options are supported on the SPARC:
11307
11308 @table @gcctabopt
11309 @item -mno-app-regs
11310 @itemx -mapp-regs
11311 @opindex mno-app-regs
11312 @opindex mapp-regs
11313 Specify @option{-mapp-regs} to generate output using the global registers
11314 2 through 4, which the SPARC SVR4 ABI reserves for applications. This
11315 is the default.
11316
11317 To be fully SVR4 ABI compliant at the cost of some performance loss,
11318 specify @option{-mno-app-regs}. You should compile libraries and system
11319 software with this option.
11320
11321 @item -mfpu
11322 @itemx -mhard-float
11323 @opindex mfpu
11324 @opindex mhard-float
11325 Generate output containing floating point instructions. This is the
11326 default.
11327
11328 @item -mno-fpu
11329 @itemx -msoft-float
11330 @opindex mno-fpu
11331 @opindex msoft-float
11332 Generate output containing library calls for floating point.
11333 @strong{Warning:} the requisite libraries are not available for all SPARC
11334 targets. Normally the facilities of the machine's usual C compiler are
11335 used, but this cannot be done directly in cross-compilation. You must make
11336 your own arrangements to provide suitable library functions for
11337 cross-compilation. The embedded targets @samp{sparc-*-aout} and
11338 @samp{sparclite-*-*} do provide software floating point support.
11339
11340 @option{-msoft-float} changes the calling convention in the output file;
11341 therefore, it is only useful if you compile @emph{all} of a program with
11342 this option. In particular, you need to compile @file{libgcc.a}, the
11343 library that comes with GCC, with @option{-msoft-float} in order for
11344 this to work.
11345
11346 @item -mhard-quad-float
11347 @opindex mhard-quad-float
11348 Generate output containing quad-word (long double) floating point
11349 instructions.
11350
11351 @item -msoft-quad-float
11352 @opindex msoft-quad-float
11353 Generate output containing library calls for quad-word (long double)
11354 floating point instructions. The functions called are those specified
11355 in the SPARC ABI@. This is the default.
11356
11357 As of this writing, there are no SPARC implementations that have hardware
11358 support for the quad-word floating point instructions. They all invoke
11359 a trap handler for one of these instructions, and then the trap handler
11360 emulates the effect of the instruction. Because of the trap handler overhead,
11361 this is much slower than calling the ABI library routines. Thus the
11362 @option{-msoft-quad-float} option is the default.
11363
11364 @item -mno-unaligned-doubles
11365 @itemx -munaligned-doubles
11366 @opindex mno-unaligned-doubles
11367 @opindex munaligned-doubles
11368 Assume that doubles have 8 byte alignment. This is the default.
11369
11370 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
11371 alignment only if they are contained in another type, or if they have an
11372 absolute address. Otherwise, it assumes they have 4 byte alignment.
11373 Specifying this option avoids some rare compatibility problems with code
11374 generated by other compilers. It is not the default because it results
11375 in a performance loss, especially for floating point code.
11376
11377 @item -mno-faster-structs
11378 @itemx -mfaster-structs
11379 @opindex mno-faster-structs
11380 @opindex mfaster-structs
11381 With @option{-mfaster-structs}, the compiler assumes that structures
11382 should have 8 byte alignment. This enables the use of pairs of
11383 @code{ldd} and @code{std} instructions for copies in structure
11384 assignment, in place of twice as many @code{ld} and @code{st} pairs.
11385 However, the use of this changed alignment directly violates the SPARC
11386 ABI@. Thus, it's intended only for use on targets where the developer
11387 acknowledges that their resulting code will not be directly in line with
11388 the rules of the ABI@.
11389
11390 @item -mimpure-text
11391 @opindex mimpure-text
11392 @option{-mimpure-text}, used in addition to @option{-shared}, tells
11393 the compiler to not pass @option{-z text} to the linker when linking a
11394 shared object. Using this option, you can link position-dependent
11395 code into a shared object.
11396
11397 @option{-mimpure-text} suppresses the ``relocations remain against
11398 allocatable but non-writable sections'' linker error message.
11399 However, the necessary relocations will trigger copy-on-write, and the
11400 shared object is not actually shared across processes. Instead of
11401 using @option{-mimpure-text}, you should compile all source code with
11402 @option{-fpic} or @option{-fPIC}.
11403
11404 This option is only available on SunOS and Solaris.
11405
11406 @item -mcpu=@var{cpu_type}
11407 @opindex mcpu
11408 Set the instruction set, register set, and instruction scheduling parameters
11409 for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
11410 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
11411 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
11412 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
11413 @samp{ultrasparc3}.
11414
11415 Default instruction scheduling parameters are used for values that select
11416 an architecture and not an implementation. These are @samp{v7}, @samp{v8},
11417 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
11418
11419 Here is a list of each supported architecture and their supported
11420 implementations.
11421
11422 @smallexample
11423 v7: cypress
11424 v8: supersparc, hypersparc
11425 sparclite: f930, f934, sparclite86x
11426 sparclet: tsc701
11427 v9: ultrasparc, ultrasparc3
11428 @end smallexample
11429
11430 By default (unless configured otherwise), GCC generates code for the V7
11431 variant of the SPARC architecture. With @option{-mcpu=cypress}, the compiler
11432 additionally optimizes it for the Cypress CY7C602 chip, as used in the
11433 SPARCStation/SPARCServer 3xx series. This is also appropriate for the older
11434 SPARCStation 1, 2, IPX etc.
11435
11436 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
11437 architecture. The only difference from V7 code is that the compiler emits
11438 the integer multiply and integer divide instructions which exist in SPARC-V8
11439 but not in SPARC-V7. With @option{-mcpu=supersparc}, the compiler additionally
11440 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
11441 2000 series.
11442
11443 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
11444 the SPARC architecture. This adds the integer multiply, integer divide step
11445 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
11446 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
11447 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@. With
11448 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
11449 MB86934 chip, which is the more recent SPARClite with FPU@.
11450
11451 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
11452 the SPARC architecture. This adds the integer multiply, multiply/accumulate,
11453 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
11454 but not in SPARC-V7. With @option{-mcpu=tsc701}, the compiler additionally
11455 optimizes it for the TEMIC SPARClet chip.
11456
11457 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
11458 architecture. This adds 64-bit integer and floating-point move instructions,
11459 3 additional floating-point condition code registers and conditional move
11460 instructions. With @option{-mcpu=ultrasparc}, the compiler additionally
11461 optimizes it for the Sun UltraSPARC I/II chips. With
11462 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
11463 Sun UltraSPARC III chip.
11464
11465 @item -mtune=@var{cpu_type}
11466 @opindex mtune
11467 Set the instruction scheduling parameters for machine type
11468 @var{cpu_type}, but do not set the instruction set or register set that the
11469 option @option{-mcpu=@var{cpu_type}} would.
11470
11471 The same values for @option{-mcpu=@var{cpu_type}} can be used for
11472 @option{-mtune=@var{cpu_type}}, but the only useful values are those
11473 that select a particular cpu implementation. Those are @samp{cypress},
11474 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
11475 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
11476 @samp{ultrasparc3}.
11477
11478 @item -mv8plus
11479 @itemx -mno-v8plus
11480 @opindex mv8plus
11481 @opindex mno-v8plus
11482 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@. The
11483 difference from the V8 ABI is that the global and out registers are
11484 considered 64-bit wide. This is enabled by default on Solaris in 32-bit
11485 mode for all SPARC-V9 processors.
11486
11487 @item -mvis
11488 @itemx -mno-vis
11489 @opindex mvis
11490 @opindex mno-vis
11491 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
11492 Visual Instruction Set extensions. The default is @option{-mno-vis}.
11493 @end table
11494
11495 These @samp{-m} options are supported in addition to the above
11496 on SPARC-V9 processors in 64-bit environments:
11497
11498 @table @gcctabopt
11499 @item -mlittle-endian
11500 @opindex mlittle-endian
11501 Generate code for a processor running in little-endian mode. It is only
11502 available for a few configurations and most notably not on Solaris.
11503
11504 @item -m32
11505 @itemx -m64
11506 @opindex m32
11507 @opindex m64
11508 Generate code for a 32-bit or 64-bit environment.
11509 The 32-bit environment sets int, long and pointer to 32 bits.
11510 The 64-bit environment sets int to 32 bits and long and pointer
11511 to 64 bits.
11512
11513 @item -mcmodel=medlow
11514 @opindex mcmodel=medlow
11515 Generate code for the Medium/Low code model: 64-bit addresses, programs
11516 must be linked in the low 32 bits of memory. Programs can be statically
11517 or dynamically linked.
11518
11519 @item -mcmodel=medmid
11520 @opindex mcmodel=medmid
11521 Generate code for the Medium/Middle code model: 64-bit addresses, programs
11522 must be linked in the low 44 bits of memory, the text and data segments must
11523 be less than 2GB in size and the data segment must be located within 2GB of
11524 the text segment.
11525
11526 @item -mcmodel=medany
11527 @opindex mcmodel=medany
11528 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
11529 may be linked anywhere in memory, the text and data segments must be less
11530 than 2GB in size and the data segment must be located within 2GB of the
11531 text segment.
11532
11533 @item -mcmodel=embmedany
11534 @opindex mcmodel=embmedany
11535 Generate code for the Medium/Anywhere code model for embedded systems:
11536 64-bit addresses, the text and data segments must be less than 2GB in
11537 size, both starting anywhere in memory (determined at link time). The
11538 global register %g4 points to the base of the data segment. Programs
11539 are statically linked and PIC is not supported.
11540
11541 @item -mstack-bias
11542 @itemx -mno-stack-bias
11543 @opindex mstack-bias
11544 @opindex mno-stack-bias
11545 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
11546 frame pointer if present, are offset by @minus{}2047 which must be added back
11547 when making stack frame references. This is the default in 64-bit mode.
11548 Otherwise, assume no such offset is present.
11549 @end table
11550
11551 These switches are supported in addition to the above on Solaris:
11552
11553 @table @gcctabopt
11554 @item -threads
11555 @opindex threads
11556 Add support for multithreading using the Solaris threads library. This
11557 option sets flags for both the preprocessor and linker. This option does
11558 not affect the thread safety of object code produced by the compiler or
11559 that of libraries supplied with it.
11560
11561 @item -pthreads
11562 @opindex pthreads
11563 Add support for multithreading using the POSIX threads library. This
11564 option sets flags for both the preprocessor and linker. This option does
11565 not affect the thread safety of object code produced by the compiler or
11566 that of libraries supplied with it.
11567 @end table
11568
11569 @node System V Options
11570 @subsection Options for System V
11571
11572 These additional options are available on System V Release 4 for
11573 compatibility with other compilers on those systems:
11574
11575 @table @gcctabopt
11576 @item -G
11577 @opindex G
11578 Create a shared object.
11579 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
11580
11581 @item -Qy
11582 @opindex Qy
11583 Identify the versions of each tool used by the compiler, in a
11584 @code{.ident} assembler directive in the output.
11585
11586 @item -Qn
11587 @opindex Qn
11588 Refrain from adding @code{.ident} directives to the output file (this is
11589 the default).
11590
11591 @item -YP,@var{dirs}
11592 @opindex YP
11593 Search the directories @var{dirs}, and no others, for libraries
11594 specified with @option{-l}.
11595
11596 @item -Ym,@var{dir}
11597 @opindex Ym
11598 Look in the directory @var{dir} to find the M4 preprocessor.
11599 The assembler uses this option.
11600 @c This is supposed to go with a -Yd for predefined M4 macro files, but
11601 @c the generic assembler that comes with Solaris takes just -Ym.
11602 @end table
11603
11604 @node TMS320C3x/C4x Options
11605 @subsection TMS320C3x/C4x Options
11606 @cindex TMS320C3x/C4x Options
11607
11608 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
11609
11610 @table @gcctabopt
11611
11612 @item -mcpu=@var{cpu_type}
11613 @opindex mcpu
11614 Set the instruction set, register set, and instruction scheduling
11615 parameters for machine type @var{cpu_type}. Supported values for
11616 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
11617 @samp{c44}. The default is @samp{c40} to generate code for the
11618 TMS320C40.
11619
11620 @item -mbig-memory
11621 @itemx -mbig
11622 @itemx -msmall-memory
11623 @itemx -msmall
11624 @opindex mbig-memory
11625 @opindex mbig
11626 @opindex msmall-memory
11627 @opindex msmall
11628 Generates code for the big or small memory model. The small memory
11629 model assumed that all data fits into one 64K word page. At run-time
11630 the data page (DP) register must be set to point to the 64K page
11631 containing the .bss and .data program sections. The big memory model is
11632 the default and requires reloading of the DP register for every direct
11633 memory access.
11634
11635 @item -mbk
11636 @itemx -mno-bk
11637 @opindex mbk
11638 @opindex mno-bk
11639 Allow (disallow) allocation of general integer operands into the block
11640 count register BK@.
11641
11642 @item -mdb
11643 @itemx -mno-db
11644 @opindex mdb
11645 @opindex mno-db
11646 Enable (disable) generation of code using decrement and branch,
11647 DBcond(D), instructions. This is enabled by default for the C4x. To be
11648 on the safe side, this is disabled for the C3x, since the maximum
11649 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
11650 @math{2^{23}} times on the C3x?). Note that GCC will try to reverse a loop so
11651 that it can utilize the decrement and branch instruction, but will give
11652 up if there is more than one memory reference in the loop. Thus a loop
11653 where the loop counter is decremented can generate slightly more
11654 efficient code, in cases where the RPTB instruction cannot be utilized.
11655
11656 @item -mdp-isr-reload
11657 @itemx -mparanoid
11658 @opindex mdp-isr-reload
11659 @opindex mparanoid
11660 Force the DP register to be saved on entry to an interrupt service
11661 routine (ISR), reloaded to point to the data section, and restored on
11662 exit from the ISR@. This should not be required unless someone has
11663 violated the small memory model by modifying the DP register, say within
11664 an object library.
11665
11666 @item -mmpyi
11667 @itemx -mno-mpyi
11668 @opindex mmpyi
11669 @opindex mno-mpyi
11670 For the C3x use the 24-bit MPYI instruction for integer multiplies
11671 instead of a library call to guarantee 32-bit results. Note that if one
11672 of the operands is a constant, then the multiplication will be performed
11673 using shifts and adds. If the @option{-mmpyi} option is not specified for the C3x,
11674 then squaring operations are performed inline instead of a library call.
11675
11676 @item -mfast-fix
11677 @itemx -mno-fast-fix
11678 @opindex mfast-fix
11679 @opindex mno-fast-fix
11680 The C3x/C4x FIX instruction to convert a floating point value to an
11681 integer value chooses the nearest integer less than or equal to the
11682 floating point value rather than to the nearest integer. Thus if the
11683 floating point number is negative, the result will be incorrectly
11684 truncated an additional code is necessary to detect and correct this
11685 case. This option can be used to disable generation of the additional
11686 code required to correct the result.
11687
11688 @item -mrptb
11689 @itemx -mno-rptb
11690 @opindex mrptb
11691 @opindex mno-rptb
11692 Enable (disable) generation of repeat block sequences using the RPTB
11693 instruction for zero overhead looping. The RPTB construct is only used
11694 for innermost loops that do not call functions or jump across the loop
11695 boundaries. There is no advantage having nested RPTB loops due to the
11696 overhead required to save and restore the RC, RS, and RE registers.
11697 This is enabled by default with @option{-O2}.
11698
11699 @item -mrpts=@var{count}
11700 @itemx -mno-rpts
11701 @opindex mrpts
11702 @opindex mno-rpts
11703 Enable (disable) the use of the single instruction repeat instruction
11704 RPTS@. If a repeat block contains a single instruction, and the loop
11705 count can be guaranteed to be less than the value @var{count}, GCC will
11706 emit a RPTS instruction instead of a RPTB@. If no value is specified,
11707 then a RPTS will be emitted even if the loop count cannot be determined
11708 at compile time. Note that the repeated instruction following RPTS does
11709 not have to be reloaded from memory each iteration, thus freeing up the
11710 CPU buses for operands. However, since interrupts are blocked by this
11711 instruction, it is disabled by default.
11712
11713 @item -mloop-unsigned
11714 @itemx -mno-loop-unsigned
11715 @opindex mloop-unsigned
11716 @opindex mno-loop-unsigned
11717 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
11718 is @math{2^{31} + 1} since these instructions test if the iteration count is
11719 negative to terminate the loop. If the iteration count is unsigned
11720 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
11721 exceeded. This switch allows an unsigned iteration count.
11722
11723 @item -mti
11724 @opindex mti
11725 Try to emit an assembler syntax that the TI assembler (asm30) is happy
11726 with. This also enforces compatibility with the API employed by the TI
11727 C3x C compiler. For example, long doubles are passed as structures
11728 rather than in floating point registers.
11729
11730 @item -mregparm
11731 @itemx -mmemparm
11732 @opindex mregparm
11733 @opindex mmemparm
11734 Generate code that uses registers (stack) for passing arguments to functions.
11735 By default, arguments are passed in registers where possible rather
11736 than by pushing arguments on to the stack.
11737
11738 @item -mparallel-insns
11739 @itemx -mno-parallel-insns
11740 @opindex mparallel-insns
11741 @opindex mno-parallel-insns
11742 Allow the generation of parallel instructions. This is enabled by
11743 default with @option{-O2}.
11744
11745 @item -mparallel-mpy
11746 @itemx -mno-parallel-mpy
11747 @opindex mparallel-mpy
11748 @opindex mno-parallel-mpy
11749 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
11750 provided @option{-mparallel-insns} is also specified. These instructions have
11751 tight register constraints which can pessimize the code generation
11752 of large functions.
11753
11754 @end table
11755
11756 @node V850 Options
11757 @subsection V850 Options
11758 @cindex V850 Options
11759
11760 These @samp{-m} options are defined for V850 implementations:
11761
11762 @table @gcctabopt
11763 @item -mlong-calls
11764 @itemx -mno-long-calls
11765 @opindex mlong-calls
11766 @opindex mno-long-calls
11767 Treat all calls as being far away (near). If calls are assumed to be
11768 far away, the compiler will always load the functions address up into a
11769 register, and call indirect through the pointer.
11770
11771 @item -mno-ep
11772 @itemx -mep
11773 @opindex mno-ep
11774 @opindex mep
11775 Do not optimize (do optimize) basic blocks that use the same index
11776 pointer 4 or more times to copy pointer into the @code{ep} register, and
11777 use the shorter @code{sld} and @code{sst} instructions. The @option{-mep}
11778 option is on by default if you optimize.
11779
11780 @item -mno-prolog-function
11781 @itemx -mprolog-function
11782 @opindex mno-prolog-function
11783 @opindex mprolog-function
11784 Do not use (do use) external functions to save and restore registers
11785 at the prologue and epilogue of a function. The external functions
11786 are slower, but use less code space if more than one function saves
11787 the same number of registers. The @option{-mprolog-function} option
11788 is on by default if you optimize.
11789
11790 @item -mspace
11791 @opindex mspace
11792 Try to make the code as small as possible. At present, this just turns
11793 on the @option{-mep} and @option{-mprolog-function} options.
11794
11795 @item -mtda=@var{n}
11796 @opindex mtda
11797 Put static or global variables whose size is @var{n} bytes or less into
11798 the tiny data area that register @code{ep} points to. The tiny data
11799 area can hold up to 256 bytes in total (128 bytes for byte references).
11800
11801 @item -msda=@var{n}
11802 @opindex msda
11803 Put static or global variables whose size is @var{n} bytes or less into
11804 the small data area that register @code{gp} points to. The small data
11805 area can hold up to 64 kilobytes.
11806
11807 @item -mzda=@var{n}
11808 @opindex mzda
11809 Put static or global variables whose size is @var{n} bytes or less into
11810 the first 32 kilobytes of memory.
11811
11812 @item -mv850
11813 @opindex mv850
11814 Specify that the target processor is the V850.
11815
11816 @item -mbig-switch
11817 @opindex mbig-switch
11818 Generate code suitable for big switch tables. Use this option only if
11819 the assembler/linker complain about out of range branches within a switch
11820 table.
11821
11822 @item -mapp-regs
11823 @opindex mapp-regs
11824 This option will cause r2 and r5 to be used in the code generated by
11825 the compiler. This setting is the default.
11826
11827 @item -mno-app-regs
11828 @opindex mno-app-regs
11829 This option will cause r2 and r5 to be treated as fixed registers.
11830
11831 @item -mv850e1
11832 @opindex mv850e1
11833 Specify that the target processor is the V850E1. The preprocessor
11834 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
11835 this option is used.
11836
11837 @item -mv850e
11838 @opindex mv850e
11839 Specify that the target processor is the V850E@. The preprocessor
11840 constant @samp{__v850e__} will be defined if this option is used.
11841
11842 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
11843 are defined then a default target processor will be chosen and the
11844 relevant @samp{__v850*__} preprocessor constant will be defined.
11845
11846 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
11847 defined, regardless of which processor variant is the target.
11848
11849 @item -mdisable-callt
11850 @opindex mdisable-callt
11851 This option will suppress generation of the CALLT instruction for the
11852 v850e and v850e1 flavors of the v850 architecture. The default is
11853 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
11854
11855 @end table
11856
11857 @node VAX Options
11858 @subsection VAX Options
11859 @cindex VAX options
11860
11861 These @samp{-m} options are defined for the VAX:
11862
11863 @table @gcctabopt
11864 @item -munix
11865 @opindex munix
11866 Do not output certain jump instructions (@code{aobleq} and so on)
11867 that the Unix assembler for the VAX cannot handle across long
11868 ranges.
11869
11870 @item -mgnu
11871 @opindex mgnu
11872 Do output those jump instructions, on the assumption that you
11873 will assemble with the GNU assembler.
11874
11875 @item -mg
11876 @opindex mg
11877 Output code for g-format floating point numbers instead of d-format.
11878 @end table
11879
11880 @node x86-64 Options
11881 @subsection x86-64 Options
11882 @cindex x86-64 options
11883
11884 These are listed under @xref{i386 and x86-64 Options}.
11885
11886 @node Xstormy16 Options
11887 @subsection Xstormy16 Options
11888 @cindex Xstormy16 Options
11889
11890 These options are defined for Xstormy16:
11891
11892 @table @gcctabopt
11893 @item -msim
11894 @opindex msim
11895 Choose startup files and linker script suitable for the simulator.
11896 @end table
11897
11898 @node Xtensa Options
11899 @subsection Xtensa Options
11900 @cindex Xtensa Options
11901
11902 These options are supported for Xtensa targets:
11903
11904 @table @gcctabopt
11905 @item -mconst16
11906 @itemx -mno-const16
11907 @opindex mconst16
11908 @opindex mno-const16
11909 Enable or disable use of @code{CONST16} instructions for loading
11910 constant values. The @code{CONST16} instruction is currently not a
11911 standard option from Tensilica. When enabled, @code{CONST16}
11912 instructions are always used in place of the standard @code{L32R}
11913 instructions. The use of @code{CONST16} is enabled by default only if
11914 the @code{L32R} instruction is not available.
11915
11916 @item -mfused-madd
11917 @itemx -mno-fused-madd
11918 @opindex mfused-madd
11919 @opindex mno-fused-madd
11920 Enable or disable use of fused multiply/add and multiply/subtract
11921 instructions in the floating-point option. This has no effect if the
11922 floating-point option is not also enabled. Disabling fused multiply/add
11923 and multiply/subtract instructions forces the compiler to use separate
11924 instructions for the multiply and add/subtract operations. This may be
11925 desirable in some cases where strict IEEE 754-compliant results are
11926 required: the fused multiply add/subtract instructions do not round the
11927 intermediate result, thereby producing results with @emph{more} bits of
11928 precision than specified by the IEEE standard. Disabling fused multiply
11929 add/subtract instructions also ensures that the program output is not
11930 sensitive to the compiler's ability to combine multiply and add/subtract
11931 operations.
11932
11933 @item -mtext-section-literals
11934 @itemx -mno-text-section-literals
11935 @opindex mtext-section-literals
11936 @opindex mno-text-section-literals
11937 Control the treatment of literal pools. The default is
11938 @option{-mno-text-section-literals}, which places literals in a separate
11939 section in the output file. This allows the literal pool to be placed
11940 in a data RAM/ROM, and it also allows the linker to combine literal
11941 pools from separate object files to remove redundant literals and
11942 improve code size. With @option{-mtext-section-literals}, the literals
11943 are interspersed in the text section in order to keep them as close as
11944 possible to their references. This may be necessary for large assembly
11945 files.
11946
11947 @item -mtarget-align
11948 @itemx -mno-target-align
11949 @opindex mtarget-align
11950 @opindex mno-target-align
11951 When this option is enabled, GCC instructs the assembler to
11952 automatically align instructions to reduce branch penalties at the
11953 expense of some code density. The assembler attempts to widen density
11954 instructions to align branch targets and the instructions following call
11955 instructions. If there are not enough preceding safe density
11956 instructions to align a target, no widening will be performed. The
11957 default is @option{-mtarget-align}. These options do not affect the
11958 treatment of auto-aligned instructions like @code{LOOP}, which the
11959 assembler will always align, either by widening density instructions or
11960 by inserting no-op instructions.
11961
11962 @item -mlongcalls
11963 @itemx -mno-longcalls
11964 @opindex mlongcalls
11965 @opindex mno-longcalls
11966 When this option is enabled, GCC instructs the assembler to translate
11967 direct calls to indirect calls unless it can determine that the target
11968 of a direct call is in the range allowed by the call instruction. This
11969 translation typically occurs for calls to functions in other source
11970 files. Specifically, the assembler translates a direct @code{CALL}
11971 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
11972 The default is @option{-mno-longcalls}. This option should be used in
11973 programs where the call target can potentially be out of range. This
11974 option is implemented in the assembler, not the compiler, so the
11975 assembly code generated by GCC will still show direct call
11976 instructions---look at the disassembled object code to see the actual
11977 instructions. Note that the assembler will use an indirect call for
11978 every cross-file call, not just those that really will be out of range.
11979 @end table
11980
11981 @node zSeries Options
11982 @subsection zSeries Options
11983 @cindex zSeries options
11984
11985 These are listed under @xref{S/390 and zSeries Options}.
11986
11987 @node Code Gen Options
11988 @section Options for Code Generation Conventions
11989 @cindex code generation conventions
11990 @cindex options, code generation
11991 @cindex run-time options
11992
11993 These machine-independent options control the interface conventions
11994 used in code generation.
11995
11996 Most of them have both positive and negative forms; the negative form
11997 of @option{-ffoo} would be @option{-fno-foo}. In the table below, only
11998 one of the forms is listed---the one which is not the default. You
11999 can figure out the other form by either removing @samp{no-} or adding
12000 it.
12001
12002 @table @gcctabopt
12003 @item -fbounds-check
12004 @opindex fbounds-check
12005 For front-ends that support it, generate additional code to check that
12006 indices used to access arrays are within the declared range. This is
12007 currently only supported by the Java and Fortran 77 front-ends, where
12008 this option defaults to true and false respectively.
12009
12010 @item -ftrapv
12011 @opindex ftrapv
12012 This option generates traps for signed overflow on addition, subtraction,
12013 multiplication operations.
12014
12015 @item -fwrapv
12016 @opindex fwrapv
12017 This option instructs the compiler to assume that signed arithmetic
12018 overflow of addition, subtraction and multiplication wraps around
12019 using twos-complement representation. This flag enables some optimizations
12020 and disables other. This option is enabled by default for the Java
12021 front-end, as required by the Java language specification.
12022
12023 @item -fexceptions
12024 @opindex fexceptions
12025 Enable exception handling. Generates extra code needed to propagate
12026 exceptions. For some targets, this implies GCC will generate frame
12027 unwind information for all functions, which can produce significant data
12028 size overhead, although it does not affect execution. If you do not
12029 specify this option, GCC will enable it by default for languages like
12030 C++ which normally require exception handling, and disable it for
12031 languages like C that do not normally require it. However, you may need
12032 to enable this option when compiling C code that needs to interoperate
12033 properly with exception handlers written in C++. You may also wish to
12034 disable this option if you are compiling older C++ programs that don't
12035 use exception handling.
12036
12037 @item -fnon-call-exceptions
12038 @opindex fnon-call-exceptions
12039 Generate code that allows trapping instructions to throw exceptions.
12040 Note that this requires platform-specific runtime support that does
12041 not exist everywhere. Moreover, it only allows @emph{trapping}
12042 instructions to throw exceptions, i.e.@: memory references or floating
12043 point instructions. It does not allow exceptions to be thrown from
12044 arbitrary signal handlers such as @code{SIGALRM}.
12045
12046 @item -funwind-tables
12047 @opindex funwind-tables
12048 Similar to @option{-fexceptions}, except that it will just generate any needed
12049 static data, but will not affect the generated code in any other way.
12050 You will normally not enable this option; instead, a language processor
12051 that needs this handling would enable it on your behalf.
12052
12053 @item -fasynchronous-unwind-tables
12054 @opindex fasynchronous-unwind-tables
12055 Generate unwind table in dwarf2 format, if supported by target machine. The
12056 table is exact at each instruction boundary, so it can be used for stack
12057 unwinding from asynchronous events (such as debugger or garbage collector).
12058
12059 @item -fpcc-struct-return
12060 @opindex fpcc-struct-return
12061 Return ``short'' @code{struct} and @code{union} values in memory like
12062 longer ones, rather than in registers. This convention is less
12063 efficient, but it has the advantage of allowing intercallability between
12064 GCC-compiled files and files compiled with other compilers, particularly
12065 the Portable C Compiler (pcc).
12066
12067 The precise convention for returning structures in memory depends
12068 on the target configuration macros.
12069
12070 Short structures and unions are those whose size and alignment match
12071 that of some integer type.
12072
12073 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12074 switch is not binary compatible with code compiled with the
12075 @option{-freg-struct-return} switch.
12076 Use it to conform to a non-default application binary interface.
12077
12078 @item -freg-struct-return
12079 @opindex freg-struct-return
12080 Return @code{struct} and @code{union} values in registers when possible.
12081 This is more efficient for small structures than
12082 @option{-fpcc-struct-return}.
12083
12084 If you specify neither @option{-fpcc-struct-return} nor
12085 @option{-freg-struct-return}, GCC defaults to whichever convention is
12086 standard for the target. If there is no standard convention, GCC
12087 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12088 the principal compiler. In those cases, we can choose the standard, and
12089 we chose the more efficient register return alternative.
12090
12091 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12092 switch is not binary compatible with code compiled with the
12093 @option{-fpcc-struct-return} switch.
12094 Use it to conform to a non-default application binary interface.
12095
12096 @item -fshort-enums
12097 @opindex fshort-enums
12098 Allocate to an @code{enum} type only as many bytes as it needs for the
12099 declared range of possible values. Specifically, the @code{enum} type
12100 will be equivalent to the smallest integer type which has enough room.
12101
12102 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12103 code that is not binary compatible with code generated without that switch.
12104 Use it to conform to a non-default application binary interface.
12105
12106 @item -fshort-double
12107 @opindex fshort-double
12108 Use the same size for @code{double} as for @code{float}.
12109
12110 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12111 code that is not binary compatible with code generated without that switch.
12112 Use it to conform to a non-default application binary interface.
12113
12114 @item -fshort-wchar
12115 @opindex fshort-wchar
12116 Override the underlying type for @samp{wchar_t} to be @samp{short
12117 unsigned int} instead of the default for the target. This option is
12118 useful for building programs to run under WINE@.
12119
12120 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12121 code that is not binary compatible with code generated without that switch.
12122 Use it to conform to a non-default application binary interface.
12123
12124 @item -fshared-data
12125 @opindex fshared-data
12126 Requests that the data and non-@code{const} variables of this
12127 compilation be shared data rather than private data. The distinction
12128 makes sense only on certain operating systems, where shared data is
12129 shared between processes running the same program, while private data
12130 exists in one copy per process.
12131
12132 @item -fno-common
12133 @opindex fno-common
12134 In C, allocate even uninitialized global variables in the data section of the
12135 object file, rather than generating them as common blocks. This has the
12136 effect that if the same variable is declared (without @code{extern}) in
12137 two different compilations, you will get an error when you link them.
12138 The only reason this might be useful is if you wish to verify that the
12139 program will work on other systems which always work this way.
12140
12141 @item -fno-ident
12142 @opindex fno-ident
12143 Ignore the @samp{#ident} directive.
12144
12145 @item -finhibit-size-directive
12146 @opindex finhibit-size-directive
12147 Don't output a @code{.size} assembler directive, or anything else that
12148 would cause trouble if the function is split in the middle, and the
12149 two halves are placed at locations far apart in memory. This option is
12150 used when compiling @file{crtstuff.c}; you should not need to use it
12151 for anything else.
12152
12153 @item -fverbose-asm
12154 @opindex fverbose-asm
12155 Put extra commentary information in the generated assembly code to
12156 make it more readable. This option is generally only of use to those
12157 who actually need to read the generated assembly code (perhaps while
12158 debugging the compiler itself).
12159
12160 @option{-fno-verbose-asm}, the default, causes the
12161 extra information to be omitted and is useful when comparing two assembler
12162 files.
12163
12164 @item -fpic
12165 @opindex fpic
12166 @cindex global offset table
12167 @cindex PIC
12168 Generate position-independent code (PIC) suitable for use in a shared
12169 library, if supported for the target machine. Such code accesses all
12170 constant addresses through a global offset table (GOT)@. The dynamic
12171 loader resolves the GOT entries when the program starts (the dynamic
12172 loader is not part of GCC; it is part of the operating system). If
12173 the GOT size for the linked executable exceeds a machine-specific
12174 maximum size, you get an error message from the linker indicating that
12175 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12176 instead. (These maximums are 8k on the SPARC and 32k
12177 on the m68k and RS/6000. The 386 has no such limit.)
12178
12179 Position-independent code requires special support, and therefore works
12180 only on certain machines. For the 386, GCC supports PIC for System V
12181 but not for the Sun 386i. Code generated for the IBM RS/6000 is always
12182 position-independent.
12183
12184 @item -fPIC
12185 @opindex fPIC
12186 If supported for the target machine, emit position-independent code,
12187 suitable for dynamic linking and avoiding any limit on the size of the
12188 global offset table. This option makes a difference on the m68k,
12189 PowerPC and SPARC@.
12190
12191 Position-independent code requires special support, and therefore works
12192 only on certain machines.
12193
12194 @item -fpie
12195 @itemx -fPIE
12196 @opindex fpie
12197 @opindex fPIE
12198 These options are similar to @option{-fpic} and @option{-fPIC}, but
12199 generated position independent code can be only linked into executables.
12200 Usually these options are used when @option{-pie} GCC option will be
12201 used during linking.
12202
12203 @item -ffixed-@var{reg}
12204 @opindex ffixed
12205 Treat the register named @var{reg} as a fixed register; generated code
12206 should never refer to it (except perhaps as a stack pointer, frame
12207 pointer or in some other fixed role).
12208
12209 @var{reg} must be the name of a register. The register names accepted
12210 are machine-specific and are defined in the @code{REGISTER_NAMES}
12211 macro in the machine description macro file.
12212
12213 This flag does not have a negative form, because it specifies a
12214 three-way choice.
12215
12216 @item -fcall-used-@var{reg}
12217 @opindex fcall-used
12218 Treat the register named @var{reg} as an allocable register that is
12219 clobbered by function calls. It may be allocated for temporaries or
12220 variables that do not live across a call. Functions compiled this way
12221 will not save and restore the register @var{reg}.
12222
12223 It is an error to used this flag with the frame pointer or stack pointer.
12224 Use of this flag for other registers that have fixed pervasive roles in
12225 the machine's execution model will produce disastrous results.
12226
12227 This flag does not have a negative form, because it specifies a
12228 three-way choice.
12229
12230 @item -fcall-saved-@var{reg}
12231 @opindex fcall-saved
12232 Treat the register named @var{reg} as an allocable register saved by
12233 functions. It may be allocated even for temporaries or variables that
12234 live across a call. Functions compiled this way will save and restore
12235 the register @var{reg} if they use it.
12236
12237 It is an error to used this flag with the frame pointer or stack pointer.
12238 Use of this flag for other registers that have fixed pervasive roles in
12239 the machine's execution model will produce disastrous results.
12240
12241 A different sort of disaster will result from the use of this flag for
12242 a register in which function values may be returned.
12243
12244 This flag does not have a negative form, because it specifies a
12245 three-way choice.
12246
12247 @item -fpack-struct[=@var{n}]
12248 @opindex fpack-struct
12249 Without a value specified, pack all structure members together without
12250 holes. When a value is specified (which must be a small power of two), pack
12251 structure members according to this value, representing the maximum
12252 alignment (that is, objects with default alignment requirements larger than
12253 this will be output potentially unaligned at the next fitting location.
12254
12255 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12256 code that is not binary compatible with code generated without that switch.
12257 Additionally, it makes the code suboptimal.
12258 Use it to conform to a non-default application binary interface.
12259
12260 @item -finstrument-functions
12261 @opindex finstrument-functions
12262 Generate instrumentation calls for entry and exit to functions. Just
12263 after function entry and just before function exit, the following
12264 profiling functions will be called with the address of the current
12265 function and its call site. (On some platforms,
12266 @code{__builtin_return_address} does not work beyond the current
12267 function, so the call site information may not be available to the
12268 profiling functions otherwise.)
12269
12270 @smallexample
12271 void __cyg_profile_func_enter (void *this_fn,
12272 void *call_site);
12273 void __cyg_profile_func_exit (void *this_fn,
12274 void *call_site);
12275 @end smallexample
12276
12277 The first argument is the address of the start of the current function,
12278 which may be looked up exactly in the symbol table.
12279
12280 This instrumentation is also done for functions expanded inline in other
12281 functions. The profiling calls will indicate where, conceptually, the
12282 inline function is entered and exited. This means that addressable
12283 versions of such functions must be available. If all your uses of a
12284 function are expanded inline, this may mean an additional expansion of
12285 code size. If you use @samp{extern inline} in your C code, an
12286 addressable version of such functions must be provided. (This is
12287 normally the case anyways, but if you get lucky and the optimizer always
12288 expands the functions inline, you might have gotten away without
12289 providing static copies.)
12290
12291 A function may be given the attribute @code{no_instrument_function}, in
12292 which case this instrumentation will not be done. This can be used, for
12293 example, for the profiling functions listed above, high-priority
12294 interrupt routines, and any functions from which the profiling functions
12295 cannot safely be called (perhaps signal handlers, if the profiling
12296 routines generate output or allocate memory).
12297
12298 @item -fstack-check
12299 @opindex fstack-check
12300 Generate code to verify that you do not go beyond the boundary of the
12301 stack. You should specify this flag if you are running in an
12302 environment with multiple threads, but only rarely need to specify it in
12303 a single-threaded environment since stack overflow is automatically
12304 detected on nearly all systems if there is only one stack.
12305
12306 Note that this switch does not actually cause checking to be done; the
12307 operating system must do that. The switch causes generation of code
12308 to ensure that the operating system sees the stack being extended.
12309
12310 @item -fstack-limit-register=@var{reg}
12311 @itemx -fstack-limit-symbol=@var{sym}
12312 @itemx -fno-stack-limit
12313 @opindex fstack-limit-register
12314 @opindex fstack-limit-symbol
12315 @opindex fno-stack-limit
12316 Generate code to ensure that the stack does not grow beyond a certain value,
12317 either the value of a register or the address of a symbol. If the stack
12318 would grow beyond the value, a signal is raised. For most targets,
12319 the signal is raised before the stack overruns the boundary, so
12320 it is possible to catch the signal without taking special precautions.
12321
12322 For instance, if the stack starts at absolute address @samp{0x80000000}
12323 and grows downwards, you can use the flags
12324 @option{-fstack-limit-symbol=__stack_limit} and
12325 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12326 of 128KB@. Note that this may only work with the GNU linker.
12327
12328 @cindex aliasing of parameters
12329 @cindex parameters, aliased
12330 @item -fargument-alias
12331 @itemx -fargument-noalias
12332 @itemx -fargument-noalias-global
12333 @opindex fargument-alias
12334 @opindex fargument-noalias
12335 @opindex fargument-noalias-global
12336 Specify the possible relationships among parameters and between
12337 parameters and global data.
12338
12339 @option{-fargument-alias} specifies that arguments (parameters) may
12340 alias each other and may alias global storage.@*
12341 @option{-fargument-noalias} specifies that arguments do not alias
12342 each other, but may alias global storage.@*
12343 @option{-fargument-noalias-global} specifies that arguments do not
12344 alias each other and do not alias global storage.
12345
12346 Each language will automatically use whatever option is required by
12347 the language standard. You should not need to use these options yourself.
12348
12349 @item -fleading-underscore
12350 @opindex fleading-underscore
12351 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12352 change the way C symbols are represented in the object file. One use
12353 is to help link with legacy assembly code.
12354
12355 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12356 generate code that is not binary compatible with code generated without that
12357 switch. Use it to conform to a non-default application binary interface.
12358 Not all targets provide complete support for this switch.
12359
12360 @item -ftls-model=@var{model}
12361 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12362 The @var{model} argument should be one of @code{global-dynamic},
12363 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
12364
12365 The default without @option{-fpic} is @code{initial-exec}; with
12366 @option{-fpic} the default is @code{global-dynamic}.
12367
12368 @item -fvisibility=@var{default|internal|hidden|protected}
12369 @opindex fvisibility
12370 Set the default ELF image symbol visibility to the specified option---all
12371 symbols will be marked with this unless overridden within the code.
12372 Using this feature can very substantially improve linking and
12373 load times of shared object libraries, produce more optimized
12374 code, provide near-perfect API export and prevent symbol clashes.
12375 It is @strong{strongly} recommended that you use this in any shared objects
12376 you distribute.
12377
12378 Despite the nomenclature, @code{default} always means public ie;
12379 available to be linked against from outside the shared object.
12380 @code{protected} and @code{internal} are pretty useless in real-world
12381 usage so the only other commonly used option will be @code{hidden}.
12382 The default if @option{-fvisibility} isn't specified is
12383 @code{default}, i.e., make every
12384 symbol public---this causes the same behavior as previous versions of
12385 GCC@.
12386
12387 A good explanation of the benefits offered by ensuring ELF
12388 symbols have the correct visibility is given by ``How To Write
12389 Shared Libraries'' by Ulrich Drepper (which can be found at
12390 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
12391 solution made possible by this option to marking things hidden when
12392 the default is public is to make the default hidden and mark things
12393 public. This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
12394 and @code{__attribute__ ((visibility("default")))} instead of
12395 @code{__declspec(dllexport)} you get almost identical semantics with
12396 identical syntax. This is a great boon to those working with
12397 cross-platform projects.
12398
12399 For those adding visibility support to existing code, you may find
12400 @samp{#pragma GCC visibility} of use. This works by you enclosing
12401 the declarations you wish to set visibility for with (for example)
12402 @samp{#pragma GCC visibility push(hidden)} and
12403 @samp{#pragma GCC visibility pop}. These can be nested up to sixteen
12404 times. Bear in mind that symbol visibility should be viewed @strong{as
12405 part of the API interface contract} and thus all new code should
12406 always specify visibility when it is not the default ie; declarations
12407 only for use within the local DSO should @strong{always} be marked explicitly
12408 as hidden as so to avoid PLT indirection overheads---making this
12409 abundantly clear also aids readability and self-documentation of the code.
12410 Note that due to ISO C++ specification requirements, operator new and
12411 operator delete must always be of default visibility.
12412
12413 An overview of these techniques, their benefits and how to use them
12414 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
12415
12416 @end table
12417
12418 @c man end
12419
12420 @node Environment Variables
12421 @section Environment Variables Affecting GCC
12422 @cindex environment variables
12423
12424 @c man begin ENVIRONMENT
12425 This section describes several environment variables that affect how GCC
12426 operates. Some of them work by specifying directories or prefixes to use
12427 when searching for various kinds of files. Some are used to specify other
12428 aspects of the compilation environment.
12429
12430 Note that you can also specify places to search using options such as
12431 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}). These
12432 take precedence over places specified using environment variables, which
12433 in turn take precedence over those specified by the configuration of GCC@.
12434 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
12435 GNU Compiler Collection (GCC) Internals}.
12436
12437 @table @env
12438 @item LANG
12439 @itemx LC_CTYPE
12440 @c @itemx LC_COLLATE
12441 @itemx LC_MESSAGES
12442 @c @itemx LC_MONETARY
12443 @c @itemx LC_NUMERIC
12444 @c @itemx LC_TIME
12445 @itemx LC_ALL
12446 @findex LANG
12447 @findex LC_CTYPE
12448 @c @findex LC_COLLATE
12449 @findex LC_MESSAGES
12450 @c @findex LC_MONETARY
12451 @c @findex LC_NUMERIC
12452 @c @findex LC_TIME
12453 @findex LC_ALL
12454 @cindex locale
12455 These environment variables control the way that GCC uses
12456 localization information that allow GCC to work with different
12457 national conventions. GCC inspects the locale categories
12458 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
12459 so. These locale categories can be set to any value supported by your
12460 installation. A typical value is @samp{en_GB.UTF-8} for English in the United
12461 Kingdom encoded in UTF-8.
12462
12463 The @env{LC_CTYPE} environment variable specifies character
12464 classification. GCC uses it to determine the character boundaries in
12465 a string; this is needed for some multibyte encodings that contain quote
12466 and escape characters that would otherwise be interpreted as a string
12467 end or escape.
12468
12469 The @env{LC_MESSAGES} environment variable specifies the language to
12470 use in diagnostic messages.
12471
12472 If the @env{LC_ALL} environment variable is set, it overrides the value
12473 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
12474 and @env{LC_MESSAGES} default to the value of the @env{LANG}
12475 environment variable. If none of these variables are set, GCC
12476 defaults to traditional C English behavior.
12477
12478 @item TMPDIR
12479 @findex TMPDIR
12480 If @env{TMPDIR} is set, it specifies the directory to use for temporary
12481 files. GCC uses temporary files to hold the output of one stage of
12482 compilation which is to be used as input to the next stage: for example,
12483 the output of the preprocessor, which is the input to the compiler
12484 proper.
12485
12486 @item GCC_EXEC_PREFIX
12487 @findex GCC_EXEC_PREFIX
12488 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
12489 names of the subprograms executed by the compiler. No slash is added
12490 when this prefix is combined with the name of a subprogram, but you can
12491 specify a prefix that ends with a slash if you wish.
12492
12493 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
12494 an appropriate prefix to use based on the pathname it was invoked with.
12495
12496 If GCC cannot find the subprogram using the specified prefix, it
12497 tries looking in the usual places for the subprogram.
12498
12499 The default value of @env{GCC_EXEC_PREFIX} is
12500 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
12501 of @code{prefix} when you ran the @file{configure} script.
12502
12503 Other prefixes specified with @option{-B} take precedence over this prefix.
12504
12505 This prefix is also used for finding files such as @file{crt0.o} that are
12506 used for linking.
12507
12508 In addition, the prefix is used in an unusual way in finding the
12509 directories to search for header files. For each of the standard
12510 directories whose name normally begins with @samp{/usr/local/lib/gcc}
12511 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
12512 replacing that beginning with the specified prefix to produce an
12513 alternate directory name. Thus, with @option{-Bfoo/}, GCC will search
12514 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
12515 These alternate directories are searched first; the standard directories
12516 come next.
12517
12518 @item COMPILER_PATH
12519 @findex COMPILER_PATH
12520 The value of @env{COMPILER_PATH} is a colon-separated list of
12521 directories, much like @env{PATH}. GCC tries the directories thus
12522 specified when searching for subprograms, if it can't find the
12523 subprograms using @env{GCC_EXEC_PREFIX}.
12524
12525 @item LIBRARY_PATH
12526 @findex LIBRARY_PATH
12527 The value of @env{LIBRARY_PATH} is a colon-separated list of
12528 directories, much like @env{PATH}. When configured as a native compiler,
12529 GCC tries the directories thus specified when searching for special
12530 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}. Linking
12531 using GCC also uses these directories when searching for ordinary
12532 libraries for the @option{-l} option (but directories specified with
12533 @option{-L} come first).
12534
12535 @item LANG
12536 @findex LANG
12537 @cindex locale definition
12538 This variable is used to pass locale information to the compiler. One way in
12539 which this information is used is to determine the character set to be used
12540 when character literals, string literals and comments are parsed in C and C++.
12541 When the compiler is configured to allow multibyte characters,
12542 the following values for @env{LANG} are recognized:
12543
12544 @table @samp
12545 @item C-JIS
12546 Recognize JIS characters.
12547 @item C-SJIS
12548 Recognize SJIS characters.
12549 @item C-EUCJP
12550 Recognize EUCJP characters.
12551 @end table
12552
12553 If @env{LANG} is not defined, or if it has some other value, then the
12554 compiler will use mblen and mbtowc as defined by the default locale to
12555 recognize and translate multibyte characters.
12556 @end table
12557
12558 @noindent
12559 Some additional environments variables affect the behavior of the
12560 preprocessor.
12561
12562 @include cppenv.texi
12563
12564 @c man end
12565
12566 @node Precompiled Headers
12567 @section Using Precompiled Headers
12568 @cindex precompiled headers
12569 @cindex speed of compilation
12570
12571 Often large projects have many header files that are included in every
12572 source file. The time the compiler takes to process these header files
12573 over and over again can account for nearly all of the time required to
12574 build the project. To make builds faster, GCC allows users to
12575 `precompile' a header file; then, if builds can use the precompiled
12576 header file they will be much faster.
12577
12578 @strong{Caution:} There are a few known situations where GCC will
12579 crash when trying to use a precompiled header. If you have trouble
12580 with a precompiled header, you should remove the precompiled header
12581 and compile without it. In addition, please use GCC's on-line
12582 defect-tracking system to report any problems you encounter with
12583 precompiled headers. @xref{Bugs}.
12584
12585 To create a precompiled header file, simply compile it as you would any
12586 other file, if necessary using the @option{-x} option to make the driver
12587 treat it as a C or C++ header file. You will probably want to use a
12588 tool like @command{make} to keep the precompiled header up-to-date when
12589 the headers it contains change.
12590
12591 A precompiled header file will be searched for when @code{#include} is
12592 seen in the compilation. As it searches for the included file
12593 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
12594 compiler looks for a precompiled header in each directory just before it
12595 looks for the include file in that directory. The name searched for is
12596 the name specified in the @code{#include} with @samp{.gch} appended. If
12597 the precompiled header file can't be used, it is ignored.
12598
12599 For instance, if you have @code{#include "all.h"}, and you have
12600 @file{all.h.gch} in the same directory as @file{all.h}, then the
12601 precompiled header file will be used if possible, and the original
12602 header will be used otherwise.
12603
12604 Alternatively, you might decide to put the precompiled header file in a
12605 directory and use @option{-I} to ensure that directory is searched
12606 before (or instead of) the directory containing the original header.
12607 Then, if you want to check that the precompiled header file is always
12608 used, you can put a file of the same name as the original header in this
12609 directory containing an @code{#error} command.
12610
12611 This also works with @option{-include}. So yet another way to use
12612 precompiled headers, good for projects not designed with precompiled
12613 header files in mind, is to simply take most of the header files used by
12614 a project, include them from another header file, precompile that header
12615 file, and @option{-include} the precompiled header. If the header files
12616 have guards against multiple inclusion, they will be skipped because
12617 they've already been included (in the precompiled header).
12618
12619 If you need to precompile the same header file for different
12620 languages, targets, or compiler options, you can instead make a
12621 @emph{directory} named like @file{all.h.gch}, and put each precompiled
12622 header in the directory, perhaps using @option{-o}. It doesn't matter
12623 what you call the files in the directory, every precompiled header in
12624 the directory will be considered. The first precompiled header
12625 encountered in the directory that is valid for this compilation will
12626 be used; they're searched in no particular order.
12627
12628 There are many other possibilities, limited only by your imagination,
12629 good sense, and the constraints of your build system.
12630
12631 A precompiled header file can be used only when these conditions apply:
12632
12633 @itemize
12634 @item
12635 Only one precompiled header can be used in a particular compilation.
12636
12637 @item
12638 A precompiled header can't be used once the first C token is seen. You
12639 can have preprocessor directives before a precompiled header; you can
12640 even include a precompiled header from inside another header, so long as
12641 there are no C tokens before the @code{#include}.
12642
12643 @item
12644 The precompiled header file must be produced for the same language as
12645 the current compilation. You can't use a C precompiled header for a C++
12646 compilation.
12647
12648 @item
12649 The precompiled header file must be produced by the same compiler
12650 version and configuration as the current compilation is using.
12651 The easiest way to guarantee this is to use the same compiler binary
12652 for creating and using precompiled headers.
12653
12654 @item
12655 Any macros defined before the precompiled header is included must
12656 either be defined in the same way as when the precompiled header was
12657 generated, or must not affect the precompiled header, which usually
12658 means that the they don't appear in the precompiled header at all.
12659
12660 The @option{-D} option is one way to define a macro before a
12661 precompiled header is included; using a @code{#define} can also do it.
12662 There are also some options that define macros implicitly, like
12663 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
12664 defined this way.
12665
12666 @item If debugging information is output when using the precompiled
12667 header, using @option{-g} or similar, the same kind of debugging information
12668 must have been output when building the precompiled header. However,
12669 a precompiled header built using @option{-g} can be used in a compilation
12670 when no debugging information is being output.
12671
12672 @item The same @option{-m} options must generally be used when building
12673 and using the precompiled header. @xref{Submodel Options},
12674 for any cases where this rule is relaxed.
12675
12676 @item Each of the following options must be the same when building and using
12677 the precompiled header:
12678
12679 @gccoptlist{-fexceptions -funit-at-a-time}
12680
12681 @item
12682 Some other command-line options starting with @option{-f},
12683 @option{-p}, or @option{-O} must be defined in the same way as when
12684 the precompiled header was generated. At present, it's not clear
12685 which options are safe to change and which are not; the safest choice
12686 is to use exactly the same options when generating and using the
12687 precompiled header. The following are known to be safe:
12688
12689 @gccoptlist{-fpreprocessed -pedantic-errors}
12690
12691 @end itemize
12692
12693 For all of these except the last, the compiler will automatically
12694 ignore the precompiled header if the conditions aren't met. If you
12695 find an option combination that doesn't work and doesn't cause the
12696 precompiled header to be ignored, please consider filing a bug report,
12697 see @ref{Bugs}.
12698
12699 If you do use differing options when generating and using the
12700 precompiled header, the actual behavior will be a mixture of the
12701 behavior for the options. For instance, if you use @option{-g} to
12702 generate the precompiled header but not when using it, you may or may
12703 not get debugging information for routines in the precompiled header.
12704
12705 @node Running Protoize
12706 @section Running Protoize
12707
12708 The program @code{protoize} is an optional part of GCC@. You can use
12709 it to add prototypes to a program, thus converting the program to ISO
12710 C in one respect. The companion program @code{unprotoize} does the
12711 reverse: it removes argument types from any prototypes that are found.
12712
12713 When you run these programs, you must specify a set of source files as
12714 command line arguments. The conversion programs start out by compiling
12715 these files to see what functions they define. The information gathered
12716 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
12717
12718 After scanning comes actual conversion. The specified files are all
12719 eligible to be converted; any files they include (whether sources or
12720 just headers) are eligible as well.
12721
12722 But not all the eligible files are converted. By default,
12723 @code{protoize} and @code{unprotoize} convert only source and header
12724 files in the current directory. You can specify additional directories
12725 whose files should be converted with the @option{-d @var{directory}}
12726 option. You can also specify particular files to exclude with the
12727 @option{-x @var{file}} option. A file is converted if it is eligible, its
12728 directory name matches one of the specified directory names, and its
12729 name within the directory has not been excluded.
12730
12731 Basic conversion with @code{protoize} consists of rewriting most
12732 function definitions and function declarations to specify the types of
12733 the arguments. The only ones not rewritten are those for varargs
12734 functions.
12735
12736 @code{protoize} optionally inserts prototype declarations at the
12737 beginning of the source file, to make them available for any calls that
12738 precede the function's definition. Or it can insert prototype
12739 declarations with block scope in the blocks where undeclared functions
12740 are called.
12741
12742 Basic conversion with @code{unprotoize} consists of rewriting most
12743 function declarations to remove any argument types, and rewriting
12744 function definitions to the old-style pre-ISO form.
12745
12746 Both conversion programs print a warning for any function declaration or
12747 definition that they can't convert. You can suppress these warnings
12748 with @option{-q}.
12749
12750 The output from @code{protoize} or @code{unprotoize} replaces the
12751 original source file. The original file is renamed to a name ending
12752 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
12753 without the original @samp{.c} suffix). If the @samp{.save} (@samp{.sav}
12754 for DOS) file already exists, then the source file is simply discarded.
12755
12756 @code{protoize} and @code{unprotoize} both depend on GCC itself to
12757 scan the program and collect information about the functions it uses.
12758 So neither of these programs will work until GCC is installed.
12759
12760 Here is a table of the options you can use with @code{protoize} and
12761 @code{unprotoize}. Each option works with both programs unless
12762 otherwise stated.
12763
12764 @table @code
12765 @item -B @var{directory}
12766 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
12767 usual directory (normally @file{/usr/local/lib}). This file contains
12768 prototype information about standard system functions. This option
12769 applies only to @code{protoize}.
12770
12771 @item -c @var{compilation-options}
12772 Use @var{compilation-options} as the options when running @command{gcc} to
12773 produce the @samp{.X} files. The special option @option{-aux-info} is
12774 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
12775
12776 Note that the compilation options must be given as a single argument to
12777 @code{protoize} or @code{unprotoize}. If you want to specify several
12778 @command{gcc} options, you must quote the entire set of compilation options
12779 to make them a single word in the shell.
12780
12781 There are certain @command{gcc} arguments that you cannot use, because they
12782 would produce the wrong kind of output. These include @option{-g},
12783 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
12784 the @var{compilation-options}, they are ignored.
12785
12786 @item -C
12787 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
12788 systems) instead of @samp{.c}. This is convenient if you are converting
12789 a C program to C++. This option applies only to @code{protoize}.
12790
12791 @item -g
12792 Add explicit global declarations. This means inserting explicit
12793 declarations at the beginning of each source file for each function
12794 that is called in the file and was not declared. These declarations
12795 precede the first function definition that contains a call to an
12796 undeclared function. This option applies only to @code{protoize}.
12797
12798 @item -i @var{string}
12799 Indent old-style parameter declarations with the string @var{string}.
12800 This option applies only to @code{protoize}.
12801
12802 @code{unprotoize} converts prototyped function definitions to old-style
12803 function definitions, where the arguments are declared between the
12804 argument list and the initial @samp{@{}. By default, @code{unprotoize}
12805 uses five spaces as the indentation. If you want to indent with just
12806 one space instead, use @option{-i " "}.
12807
12808 @item -k
12809 Keep the @samp{.X} files. Normally, they are deleted after conversion
12810 is finished.
12811
12812 @item -l
12813 Add explicit local declarations. @code{protoize} with @option{-l} inserts
12814 a prototype declaration for each function in each block which calls the
12815 function without any declaration. This option applies only to
12816 @code{protoize}.
12817
12818 @item -n
12819 Make no real changes. This mode just prints information about the conversions
12820 that would have been done without @option{-n}.
12821
12822 @item -N
12823 Make no @samp{.save} files. The original files are simply deleted.
12824 Use this option with caution.
12825
12826 @item -p @var{program}
12827 Use the program @var{program} as the compiler. Normally, the name
12828 @file{gcc} is used.
12829
12830 @item -q
12831 Work quietly. Most warnings are suppressed.
12832
12833 @item -v
12834 Print the version number, just like @option{-v} for @command{gcc}.
12835 @end table
12836
12837 If you need special compiler options to compile one of your program's
12838 source files, then you should generate that file's @samp{.X} file
12839 specially, by running @command{gcc} on that source file with the
12840 appropriate options and the option @option{-aux-info}. Then run
12841 @code{protoize} on the entire set of files. @code{protoize} will use
12842 the existing @samp{.X} file because it is newer than the source file.
12843 For example:
12844
12845 @smallexample
12846 gcc -Dfoo=bar file1.c -aux-info file1.X
12847 protoize *.c
12848 @end smallexample
12849
12850 @noindent
12851 You need to include the special files along with the rest in the
12852 @code{protoize} command, even though their @samp{.X} files already
12853 exist, because otherwise they won't get converted.
12854
12855 @xref{Protoize Caveats}, for more information on how to use
12856 @code{protoize} successfully.