libgcov.c (create_file_directory): New function.
[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 -Wstrict-null-sentinel @gol
189 -Wno-non-template-friend -Wold-style-cast @gol
190 -Woverloaded-virtual -Wno-pmf-conversions @gol
191 -Wsign-promo}
192
193 @item Objective-C and Objective-C++ Language Options
194 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
195 Objective-C and Objective-C++ Dialects}.
196 @gccoptlist{
197 -fconstant-string-class=@var{class-name} @gol
198 -fgnu-runtime -fnext-runtime @gol
199 -fno-nil-receivers @gol
200 -fobjc-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{]}} @gol
210 -fdiagnostics-show-options
211
212 @item Warning Options
213 @xref{Warning Options,,Options to Request or Suppress Warnings}.
214 @gccoptlist{-fsyntax-only -pedantic -pedantic-errors @gol
215 -w -Wextra -Wall -Waggregate-return @gol
216 -Wcast-align -Wcast-qual -Wchar-subscripts -Wcomment @gol
217 -Wconversion -Wno-deprecated-declarations @gol
218 -Wdisabled-optimization -Wno-div-by-zero -Wno-endif-labels @gol
219 -Werror -Werror-implicit-function-declaration @gol
220 -Wfatal-errors -Wfloat-equal -Wformat -Wformat=2 @gol
221 -Wno-format-extra-args -Wformat-nonliteral @gol
222 -Wformat-security -Wformat-y2k @gol
223 -Wimplicit -Wimplicit-function-declaration -Wimplicit-int @gol
224 -Wimport -Wno-import -Winit-self -Winline @gol
225 -Wno-int-to-pointer-cast @gol
226 -Wno-invalid-offsetof -Winvalid-pch @gol
227 -Wlarger-than-@var{len} -Wlong-long @gol
228 -Wmain -Wmissing-braces -Wmissing-field-initializers @gol
229 -Wmissing-format-attribute -Wmissing-include-dirs @gol
230 -Wmissing-noreturn @gol
231 -Wno-multichar -Wnonnull -Wpacked -Wpadded @gol
232 -Wparentheses -Wpointer-arith -Wno-pointer-to-int-cast @gol
233 -Wredundant-decls @gol
234 -Wreturn-type -Wsequence-point -Wshadow @gol
235 -Wsign-compare -Wstrict-aliasing -Wstrict-aliasing=2 @gol
236 -Wswitch -Wswitch-default -Wswitch-enum @gol
237 -Wsystem-headers -Wtrigraphs -Wundef -Wuninitialized @gol
238 -Wunknown-pragmas -Wunreachable-code @gol
239 -Wunused -Wunused-function -Wunused-label -Wunused-parameter @gol
240 -Wunused-value -Wunused-variable -Wwrite-strings @gol
241 -Wvariadic-macros}
242
243 @item C-only Warning Options
244 @gccoptlist{-Wbad-function-cast -Wmissing-declarations @gol
245 -Wmissing-prototypes -Wnested-externs -Wold-style-definition @gol
246 -Wstrict-prototypes -Wtraditional @gol
247 -Wdeclaration-after-statement -Wno-pointer-sign}
248
249 @item Debugging Options
250 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
251 @gccoptlist{-d@var{letters} -dumpspecs -dumpmachine -dumpversion @gol
252 -fdump-unnumbered -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
253 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
254 -fdump-ipa-all -fdump-ipa-cgraph @gol
255 -fdump-tree-all @gol
256 -fdump-tree-original@r{[}-@var{n}@r{]} @gol
257 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
258 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
259 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
260 -fdump-tree-ch @gol
261 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
262 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
263 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
264 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
266 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
267 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
268 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
269 -fdump-tree-nrv -fdump-tree-vect @gol
270 -fdump-tree-sink @gol
271 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
272 -fdump-tree-salias @gol
273 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
274 -ftree-vectorizer-verbose=@var{n} @gol
275 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
276 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
277 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs -ftree-based-profiling @gol
278 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
279 -ftest-coverage -ftime-report -fvar-tracking @gol
280 -g -g@var{level} -gcoff -gdwarf-2 @gol
281 -ggdb -gstabs -gstabs+ -gvms -gxcoff -gxcoff+ @gol
282 -p -pg -print-file-name=@var{library} -print-libgcc-file-name @gol
283 -print-multi-directory -print-multi-lib @gol
284 -print-prog-name=@var{program} -print-search-dirs -Q @gol
285 -save-temps -time}
286
287 @item Optimization Options
288 @xref{Optimize Options,,Options that Control Optimization}.
289 @gccoptlist{-falign-functions=@var{n} -falign-jumps=@var{n} @gol
290 -falign-labels=@var{n} -falign-loops=@var{n} @gol
291 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
292 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
293 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
294 -fcaller-saves -fcprop-registers -fcse-follow-jumps @gol
295 -fcse-skip-blocks -fcx-limited-range -fdata-sections @gol
296 -fdelayed-branch -fdelete-null-pointer-checks @gol
297 -fexpensive-optimizations -ffast-math -ffloat-store @gol
298 -fforce-addr -fforce-mem -ffunction-sections @gol
299 -fgcse -fgcse-lm -fgcse-sm -fgcse-las -fgcse-after-reload @gol
300 -floop-optimize -fcrossjumping -fif-conversion -fif-conversion2 @gol
301 -finline-functions -finline-limit=@var{n} -fkeep-inline-functions @gol
302 -fkeep-static-consts -fmerge-constants -fmerge-all-constants @gol
303 -fmodulo-sched -fno-branch-count-reg @gol
304 -fno-default-inline -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
305 -fno-function-cse -fno-guess-branch-probability @gol
306 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
307 -funsafe-math-optimizations -ffinite-math-only @gol
308 -fno-trapping-math -fno-zero-initialized-in-bss @gol
309 -fomit-frame-pointer -foptimize-register-move @gol
310 -foptimize-sibling-calls -fprefetch-loop-arrays @gol
311 -fprofile-generate -fprofile-use @gol
312 -fregmove -frename-registers @gol
313 -freorder-blocks -freorder-blocks-and-partition -freorder-functions @gol
314 -frerun-cse-after-loop -frerun-loop-opt @gol
315 -frounding-math -fschedule-insns -fschedule-insns2 @gol
316 -fno-sched-interblock -fno-sched-spec -fsched-spec-load @gol
317 -fsched-spec-load-dangerous @gol
318 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
319 -fsched2-use-superblocks @gol
320 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
321 -fsignaling-nans -fsingle-precision-constant -fspeculative-prefetching @gol
322 -fstrength-reduce -fstrict-aliasing -ftracer -fthread-jumps @gol
323 -funroll-all-loops -funroll-loops -fpeel-loops @gol
324 -fsplit-ivs-in-unroller -funswitch-loops @gol
325 -fvariable-expansion-in-unroller @gol
326 -ftree-pre -ftree-ccp -ftree-dce -ftree-loop-optimize @gol
327 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
328 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
329 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
330 -ftree-salias -fweb @gol
331 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop @gol
332 --param @var{name}=@var{value}
333 -O -O0 -O1 -O2 -O3 -Os}
334
335 @item Preprocessor Options
336 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
337 @gccoptlist{-A@var{question}=@var{answer} @gol
338 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
339 -C -dD -dI -dM -dN @gol
340 -D@var{macro}@r{[}=@var{defn}@r{]} -E -H @gol
341 -idirafter @var{dir} @gol
342 -include @var{file} -imacros @var{file} @gol
343 -iprefix @var{file} -iwithprefix @var{dir} @gol
344 -iwithprefixbefore @var{dir} -isystem @var{dir} @gol
345 -M -MM -MF -MG -MP -MQ -MT -nostdinc @gol
346 -P -fworking-directory -remap @gol
347 -trigraphs -undef -U@var{macro} -Wp,@var{option} @gol
348 -Xpreprocessor @var{option}}
349
350 @item Assembler Option
351 @xref{Assembler Options,,Passing Options to the Assembler}.
352 @gccoptlist{-Wa,@var{option} -Xassembler @var{option}}
353
354 @item Linker Options
355 @xref{Link Options,,Options for Linking}.
356 @gccoptlist{@var{object-file-name} -l@var{library} @gol
357 -nostartfiles -nodefaultlibs -nostdlib -pie @gol
358 -s -static -static-libgcc -shared -shared-libgcc -symbolic @gol
359 -Wl,@var{option} -Xlinker @var{option} @gol
360 -u @var{symbol}}
361
362 @item Directory Options
363 @xref{Directory Options,,Options for Directory Search}.
364 @gccoptlist{-B@var{prefix} -I@var{dir} -iquote@var{dir} -L@var{dir} -specs=@var{file} -I-}
365
366 @item Target Options
367 @c I wrote this xref this way to avoid overfull hbox. -- rms
368 @xref{Target Options}.
369 @gccoptlist{-V @var{version} -b @var{machine}}
370
371 @item Machine Dependent Options
372 @xref{Submodel Options,,Hardware Models and Configurations}.
373 @c This list is ordered alphanumerically by subsection name.
374 @c Try and put the significant identifier (CPU or system) first,
375 @c so users have a clue at guessing where the ones they want will be.
376
377 @emph{ARC Options}
378 @gccoptlist{-EB -EL @gol
379 -mmangle-cpu -mcpu=@var{cpu} -mtext=@var{text-section} @gol
380 -mdata=@var{data-section} -mrodata=@var{readonly-data-section}}
381
382 @emph{ARM Options}
383 @gccoptlist{-mapcs-frame -mno-apcs-frame @gol
384 -mabi=@var{name} @gol
385 -mapcs-stack-check -mno-apcs-stack-check @gol
386 -mapcs-float -mno-apcs-float @gol
387 -mapcs-reentrant -mno-apcs-reentrant @gol
388 -msched-prolog -mno-sched-prolog @gol
389 -mlittle-endian -mbig-endian -mwords-little-endian @gol
390 -mfloat-abi=@var{name} -msoft-float -mhard-float -mfpe @gol
391 -mthumb-interwork -mno-thumb-interwork @gol
392 -mcpu=@var{name} -march=@var{name} -mfpu=@var{name} @gol
393 -mstructure-size-boundary=@var{n} @gol
394 -mabort-on-noreturn @gol
395 -mlong-calls -mno-long-calls @gol
396 -msingle-pic-base -mno-single-pic-base @gol
397 -mpic-register=@var{reg} @gol
398 -mnop-fun-dllimport @gol
399 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
400 -mpoke-function-name @gol
401 -mthumb -marm @gol
402 -mtpcs-frame -mtpcs-leaf-frame @gol
403 -mcaller-super-interworking -mcallee-super-interworking}
404
405 @emph{AVR Options}
406 @gccoptlist{-mmcu=@var{mcu} -msize -minit-stack=@var{n} -mno-interrupts @gol
407 -mcall-prologues -mno-tablejump -mtiny-stack -mint8}
408
409 @emph{Blackfin Options}
410 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer -mcsync @gol
411 -mno-csync -mlow-64k -mno-low64k -mid-shared-library @gol
412 -mno-id-shared-library -mshared-library-id=@var{n} @gol}
413
414 @emph{CRIS Options}
415 @gccoptlist{-mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
416 -mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
417 -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
418 -mstack-align -mdata-align -mconst-align @gol
419 -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
420 -melf -maout -melinux -mlinux -sim -sim2 @gol
421 -mmul-bug-workaround -mno-mul-bug-workaround}
422
423 @emph{Darwin Options}
424 @gccoptlist{-all_load -allowable_client -arch -arch_errors_fatal @gol
425 -arch_only -bind_at_load -bundle -bundle_loader @gol
426 -client_name -compatibility_version -current_version @gol
427 -dead_strip @gol
428 -dependency-file -dylib_file -dylinker_install_name @gol
429 -dynamic -dynamiclib -exported_symbols_list @gol
430 -filelist -flat_namespace -force_cpusubtype_ALL @gol
431 -force_flat_namespace -headerpad_max_install_names @gol
432 -image_base -init -install_name -keep_private_externs @gol
433 -multi_module -multiply_defined -multiply_defined_unused @gol
434 -noall_load -no_dead_strip_inits_and_terms @gol
435 -nofixprebinding -nomultidefs -noprebind -noseglinkedit @gol
436 -pagezero_size -prebind -prebind_all_twolevel_modules @gol
437 -private_bundle -read_only_relocs -sectalign @gol
438 -sectobjectsymbols -whyload -seg1addr @gol
439 -sectcreate -sectobjectsymbols -sectorder @gol
440 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
441 -seg_addr_table -seg_addr_table_filename -seglinkedit @gol
442 -segprot -segs_read_only_addr -segs_read_write_addr @gol
443 -single_module -static -sub_library -sub_umbrella @gol
444 -twolevel_namespace -umbrella -undefined @gol
445 -unexported_symbols_list -weak_reference_mismatches @gol
446 -whatsloaded -F -gused -gfull -mone-byte-bool}
447
448 @emph{DEC Alpha Options}
449 @gccoptlist{-mno-fp-regs -msoft-float -malpha-as -mgas @gol
450 -mieee -mieee-with-inexact -mieee-conformant @gol
451 -mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode} @gol
452 -mtrap-precision=@var{mode} -mbuild-constants @gol
453 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} @gol
454 -mbwx -mmax -mfix -mcix @gol
455 -mfloat-vax -mfloat-ieee @gol
456 -mexplicit-relocs -msmall-data -mlarge-data @gol
457 -msmall-text -mlarge-text @gol
458 -mmemory-latency=@var{time}}
459
460 @emph{DEC Alpha/VMS Options}
461 @gccoptlist{-mvms-return-codes}
462
463 @emph{FRV Options}
464 @gccoptlist{-mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 @gol
465 -mhard-float -msoft-float @gol
466 -malloc-cc -mfixed-cc -mdword -mno-dword @gol
467 -mdouble -mno-double @gol
468 -mmedia -mno-media -mmuladd -mno-muladd @gol
469 -mfdpic -minline-plt -mgprel-ro -multilib-library-pic @gol
470 -mlinked-fp -mlong-calls -malign-labels @gol
471 -mlibrary-pic -macc-4 -macc-8 @gol
472 -mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move @gol
473 -mscc -mno-scc -mcond-exec -mno-cond-exec @gol
474 -mvliw-branch -mno-vliw-branch @gol
475 -mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec @gol
476 -mno-nested-cond-exec -mtomcat-stats @gol
477 -mTLS -mtls @gol
478 -mcpu=@var{cpu}}
479
480 @emph{H8/300 Options}
481 @gccoptlist{-mrelax -mh -ms -mn -mint32 -malign-300}
482
483 @emph{HPPA Options}
484 @gccoptlist{-march=@var{architecture-type} @gol
485 -mbig-switch -mdisable-fpregs -mdisable-indexing @gol
486 -mfast-indirect-calls -mgas -mgnu-ld -mhp-ld @gol
487 -mfixed-range=@var{register-range} @gol
488 -mjump-in-delay -mlinker-opt -mlong-calls @gol
489 -mlong-load-store -mno-big-switch -mno-disable-fpregs @gol
490 -mno-disable-indexing -mno-fast-indirect-calls -mno-gas @gol
491 -mno-jump-in-delay -mno-long-load-store @gol
492 -mno-portable-runtime -mno-soft-float @gol
493 -mno-space-regs -msoft-float -mpa-risc-1-0 @gol
494 -mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime @gol
495 -mschedule=@var{cpu-type} -mspace-regs -msio -mwsio @gol
496 -munix=@var{unix-std} -nolibdld -static -threads}
497
498 @emph{i386 and x86-64 Options}
499 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
500 -mfpmath=@var{unit} @gol
501 -masm=@var{dialect} -mno-fancy-math-387 @gol
502 -mno-fp-ret-in-387 -msoft-float -msvr3-shlib @gol
503 -mno-wide-multiply -mrtd -malign-double @gol
504 -mpreferred-stack-boundary=@var{num} @gol
505 -mmmx -msse -msse2 -msse3 -m3dnow @gol
506 -mthreads -mno-align-stringops -minline-all-stringops @gol
507 -mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
508 -m96bit-long-double -mregparm=@var{num} -momit-leaf-frame-pointer @gol
509 -mno-red-zone -mno-tls-direct-seg-refs @gol
510 -mcmodel=@var{code-model} @gol
511 -m32 -m64}
512
513 @emph{IA-64 Options}
514 @gccoptlist{-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
515 -mvolatile-asm-stop -mregister-names -mno-sdata @gol
516 -mconstant-gp -mauto-pic -minline-float-divide-min-latency @gol
517 -minline-float-divide-max-throughput @gol
518 -minline-int-divide-min-latency @gol
519 -minline-int-divide-max-throughput @gol
520 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
521 -mno-dwarf2-asm -mearly-stop-bits @gol
522 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
523 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
524
525 @emph{M32R/D Options}
526 @gccoptlist{-m32r2 -m32rx -m32r @gol
527 -mdebug @gol
528 -malign-loops -mno-align-loops @gol
529 -missue-rate=@var{number} @gol
530 -mbranch-cost=@var{number} @gol
531 -mmodel=@var{code-size-model-type} @gol
532 -msdata=@var{sdata-type} @gol
533 -mno-flush-func -mflush-func=@var{name} @gol
534 -mno-flush-trap -mflush-trap=@var{number} @gol
535 -G @var{num}}
536
537 @emph{M680x0 Options}
538 @gccoptlist{-m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 @gol
539 -m68060 -mcpu32 -m5200 -m68881 -mbitfield -mc68000 -mc68020 @gol
540 -mnobitfield -mrtd -mshort -msoft-float -mpcrel @gol
541 -malign-int -mstrict-align -msep-data -mno-sep-data @gol
542 -mshared-library-id=n -mid-shared-library -mno-id-shared-library}
543
544 @emph{M68hc1x Options}
545 @gccoptlist{-m6811 -m6812 -m68hc11 -m68hc12 -m68hcs12 @gol
546 -mauto-incdec -minmax -mlong-calls -mshort @gol
547 -msoft-reg-count=@var{count}}
548
549 @emph{MCore Options}
550 @gccoptlist{-mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates @gol
551 -mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
552 -m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
553 -mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
554 -mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
555
556 @emph{MIPS Options}
557 @gccoptlist{-EL -EB -march=@var{arch} -mtune=@var{arch} @gol
558 -mips1 -mips2 -mips3 -mips4 -mips32 -mips32r2 -mips64 @gol
559 -mips16 -mno-mips16 -mabi=@var{abi} -mabicalls -mno-abicalls @gol
560 -mxgot -mno-xgot -mgp32 -mgp64 -mfp32 -mfp64 @gol
561 -mhard-float -msoft-float -msingle-float -mdouble-float @gol
562 -mpaired-single -mips3d @gol
563 -mlong64 -mlong32 -msym32 -mno-sym32 @gol
564 -G@var{num} -membedded-data -mno-embedded-data @gol
565 -muninit-const-in-rodata -mno-uninit-const-in-rodata @gol
566 -msplit-addresses -mno-split-addresses @gol
567 -mexplicit-relocs -mno-explicit-relocs @gol
568 -mcheck-zero-division -mno-check-zero-division @gol
569 -mdivide-traps -mdivide-breaks @gol
570 -mmemcpy -mno-memcpy -mlong-calls -mno-long-calls @gol
571 -mmad -mno-mad -mfused-madd -mno-fused-madd -nocpp @gol
572 -mfix-r4000 -mno-fix-r4000 -mfix-r4400 -mno-fix-r4400 @gol
573 -mfix-vr4120 -mno-fix-vr4120 -mfix-vr4130 @gol
574 -mfix-sb1 -mno-fix-sb1 @gol
575 -mflush-func=@var{func} -mno-flush-func @gol
576 -mbranch-likely -mno-branch-likely @gol
577 -mfp-exceptions -mno-fp-exceptions @gol
578 -mvr4130-align -mno-vr4130-align}
579
580 @emph{MMIX Options}
581 @gccoptlist{-mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
582 -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
583 -melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
584 -mno-base-addresses -msingle-exit -mno-single-exit}
585
586 @emph{MN10300 Options}
587 @gccoptlist{-mmult-bug -mno-mult-bug @gol
588 -mam33 -mno-am33 @gol
589 -mam33-2 -mno-am33-2 @gol
590 -mno-crt0 -mrelax}
591
592 @emph{NS32K Options}
593 @gccoptlist{-m32032 -m32332 -m32532 -m32081 -m32381 @gol
594 -mmult-add -mnomult-add -msoft-float -mrtd -mnortd @gol
595 -mregparam -mnoregparam -msb -mnosb @gol
596 -mbitfield -mnobitfield -mhimem -mnohimem}
597
598 @emph{PDP-11 Options}
599 @gccoptlist{-mfpu -msoft-float -mac0 -mno-ac0 -m40 -m45 -m10 @gol
600 -mbcopy -mbcopy-builtin -mint32 -mno-int16 @gol
601 -mint16 -mno-int32 -mfloat32 -mno-float64 @gol
602 -mfloat64 -mno-float32 -mabshi -mno-abshi @gol
603 -mbranch-expensive -mbranch-cheap @gol
604 -msplit -mno-split -munix-asm -mdec-asm}
605
606 @emph{PowerPC Options}
607 See RS/6000 and PowerPC Options.
608
609 @emph{RS/6000 and PowerPC Options}
610 @gccoptlist{-mcpu=@var{cpu-type} @gol
611 -mtune=@var{cpu-type} @gol
612 -mpower -mno-power -mpower2 -mno-power2 @gol
613 -mpowerpc -mpowerpc64 -mno-powerpc @gol
614 -maltivec -mno-altivec @gol
615 -mpowerpc-gpopt -mno-powerpc-gpopt @gol
616 -mpowerpc-gfxopt -mno-powerpc-gfxopt @gol
617 -mnew-mnemonics -mold-mnemonics @gol
618 -mfull-toc -mminimal-toc -mno-fp-in-toc -mno-sum-in-toc @gol
619 -m64 -m32 -mxl-compat -mno-xl-compat -mpe @gol
620 -malign-power -malign-natural @gol
621 -msoft-float -mhard-float -mmultiple -mno-multiple @gol
622 -mstring -mno-string -mupdate -mno-update @gol
623 -mfused-madd -mno-fused-madd -mbit-align -mno-bit-align @gol
624 -mstrict-align -mno-strict-align -mrelocatable @gol
625 -mno-relocatable -mrelocatable-lib -mno-relocatable-lib @gol
626 -mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian @gol
627 -mdynamic-no-pic @gol
628 -mprioritize-restricted-insns=@var{priority} @gol
629 -msched-costly-dep=@var{dependence_type} @gol
630 -minsert-sched-nops=@var{scheme} @gol
631 -mcall-sysv -mcall-netbsd @gol
632 -maix-struct-return -msvr4-struct-return @gol
633 -mabi=@var{abi-type} @gol
634 -misel -mno-isel @gol
635 -misel=yes -misel=no @gol
636 -mspe -mno-spe @gol
637 -mspe=yes -mspe=no @gol
638 -mvrsave -mno-vrsave @gol
639 -mfloat-gprs=yes -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
640 -mprototype -mno-prototype @gol
641 -msim -mmvme -mads -myellowknife -memb -msdata @gol
642 -msdata=@var{opt} -mvxworks -mwindiss -G @var{num} -pthread}
643
644 @emph{S/390 and zSeries Options}
645 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
646 -mhard-float -msoft-float -mbackchain -mno-backchain @gol
647 -mpacked-stack -mno-packed-stack @gol
648 -msmall-exec -mno-small-exec -mmvcle -mno-mvcle @gol
649 -m64 -m31 -mdebug -mno-debug -mesa -mzarch @gol
650 -mtpf-trace -mno-tpf-trace -mfused-madd -mno-fused-madd @gol
651 -mwarn-framesize -mwarn-dynamicstack -mstack-size -mstack-guard}
652
653 @emph{SH Options}
654 @gccoptlist{-m1 -m2 -m2e -m3 -m3e @gol
655 -m4-nofpu -m4-single-only -m4-single -m4 @gol
656 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
657 -m5-64media -m5-64media-nofpu @gol
658 -m5-32media -m5-32media-nofpu @gol
659 -m5-compact -m5-compact-nofpu @gol
660 -mb -ml -mdalign -mrelax @gol
661 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
662 -mieee -misize -mpadstruct -mspace @gol
663 -mprefergot -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
664 -mdivsi3_libfunc=@var{name} @gol
665 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
666 -minvalid-symbols}
667
668 @emph{SPARC Options}
669 @gccoptlist{-mcpu=@var{cpu-type} @gol
670 -mtune=@var{cpu-type} @gol
671 -mcmodel=@var{code-model} @gol
672 -m32 -m64 -mapp-regs -mno-app-regs @gol
673 -mfaster-structs -mno-faster-structs @gol
674 -mfpu -mno-fpu -mhard-float -msoft-float @gol
675 -mhard-quad-float -msoft-quad-float @gol
676 -mimpure-text -mno-impure-text -mlittle-endian @gol
677 -mstack-bias -mno-stack-bias @gol
678 -munaligned-doubles -mno-unaligned-doubles @gol
679 -mv8plus -mno-v8plus -mvis -mno-vis
680 -threads -pthreads}
681
682 @emph{System V Options}
683 @gccoptlist{-Qy -Qn -YP,@var{paths} -Ym,@var{dir}}
684
685 @emph{TMS320C3x/C4x Options}
686 @gccoptlist{-mcpu=@var{cpu} -mbig -msmall -mregparm -mmemparm @gol
687 -mfast-fix -mmpyi -mbk -mti -mdp-isr-reload @gol
688 -mrpts=@var{count} -mrptb -mdb -mloop-unsigned @gol
689 -mparallel-insns -mparallel-mpy -mpreserve-float}
690
691 @emph{V850 Options}
692 @gccoptlist{-mlong-calls -mno-long-calls -mep -mno-ep @gol
693 -mprolog-function -mno-prolog-function -mspace @gol
694 -mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
695 -mapp-regs -mno-app-regs @gol
696 -mdisable-callt -mno-disable-callt @gol
697 -mv850e1 @gol
698 -mv850e @gol
699 -mv850 -mbig-switch}
700
701 @emph{VAX Options}
702 @gccoptlist{-mg -mgnu -munix}
703
704 @emph{x86-64 Options}
705 See i386 and x86-64 Options.
706
707 @emph{Xstormy16 Options}
708 @gccoptlist{-msim}
709
710 @emph{Xtensa Options}
711 @gccoptlist{-mconst16 -mno-const16 @gol
712 -mfused-madd -mno-fused-madd @gol
713 -mtext-section-literals -mno-text-section-literals @gol
714 -mtarget-align -mno-target-align @gol
715 -mlongcalls -mno-longcalls}
716
717 @emph{zSeries Options}
718 See S/390 and zSeries Options.
719
720 @item Code Generation Options
721 @xref{Code Gen Options,,Options for Code Generation Conventions}.
722 @gccoptlist{-fcall-saved-@var{reg} -fcall-used-@var{reg} @gol
723 -ffixed-@var{reg} -fexceptions @gol
724 -fnon-call-exceptions -funwind-tables @gol
725 -fasynchronous-unwind-tables @gol
726 -finhibit-size-directive -finstrument-functions @gol
727 -fno-common -fno-ident @gol
728 -fpcc-struct-return -fpic -fPIC -fpie -fPIE @gol
729 -freg-struct-return -fshared-data -fshort-enums @gol
730 -fshort-double -fshort-wchar @gol
731 -fverbose-asm -fpack-struct[=@var{n}] -fstack-check @gol
732 -fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym} @gol
733 -fargument-alias -fargument-noalias @gol
734 -fargument-noalias-global -fleading-underscore @gol
735 -ftls-model=@var{model} @gol
736 -ftrapv -fwrapv -fbounds-check @gol
737 -fvisibility}
738 @end table
739
740 @menu
741 * Overall Options:: Controlling the kind of output:
742 an executable, object files, assembler files,
743 or preprocessed source.
744 * C Dialect Options:: Controlling the variant of C language compiled.
745 * C++ Dialect Options:: Variations on C++.
746 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
747 and Objective-C++.
748 * Language Independent Options:: Controlling how diagnostics should be
749 formatted.
750 * Warning Options:: How picky should the compiler be?
751 * Debugging Options:: Symbol tables, measurements, and debugging dumps.
752 * Optimize Options:: How much optimization?
753 * Preprocessor Options:: Controlling header files and macro definitions.
754 Also, getting dependency information for Make.
755 * Assembler Options:: Passing options to the assembler.
756 * Link Options:: Specifying libraries and so on.
757 * Directory Options:: Where to find header files and libraries.
758 Where to find the compiler executable files.
759 * Spec Files:: How to pass switches to sub-processes.
760 * Target Options:: Running a cross-compiler, or an old version of GCC.
761 @end menu
762
763 @node Overall Options
764 @section Options Controlling the Kind of Output
765
766 Compilation can involve up to four stages: preprocessing, compilation
767 proper, assembly and linking, always in that order. GCC is capable of
768 preprocessing and compiling several files either into several
769 assembler input files, or into one assembler input file; then each
770 assembler input file produces an object file, and linking combines all
771 the object files (those newly compiled, and those specified as input)
772 into an executable file.
773
774 @cindex file name suffix
775 For any given input file, the file name suffix determines what kind of
776 compilation is done:
777
778 @table @gcctabopt
779 @item @var{file}.c
780 C source code which must be preprocessed.
781
782 @item @var{file}.i
783 C source code which should not be preprocessed.
784
785 @item @var{file}.ii
786 C++ source code which should not be preprocessed.
787
788 @item @var{file}.m
789 Objective-C source code. Note that you must link with the @file{libobjc}
790 library to make an Objective-C program work.
791
792 @item @var{file}.mi
793 Objective-C source code which should not be preprocessed.
794
795 @item @var{file}.mm
796 @itemx @var{file}.M
797 Objective-C++ source code. Note that you must link with the @file{libobjc}
798 library to make an Objective-C++ program work. Note that @samp{.M} refers
799 to a literal capital M@.
800
801 @item @var{file}.mii
802 Objective-C++ source code which should not be preprocessed.
803
804 @item @var{file}.h
805 C, C++, Objective-C or Objective-C++ header file to be turned into a
806 precompiled header.
807
808 @item @var{file}.cc
809 @itemx @var{file}.cp
810 @itemx @var{file}.cxx
811 @itemx @var{file}.cpp
812 @itemx @var{file}.CPP
813 @itemx @var{file}.c++
814 @itemx @var{file}.C
815 C++ source code which must be preprocessed. Note that in @samp{.cxx},
816 the last two letters must both be literally @samp{x}. Likewise,
817 @samp{.C} refers to a literal capital C@.
818
819 @item @var{file}.hh
820 @itemx @var{file}.H
821 C++ header file to be turned into a precompiled header.
822
823 @item @var{file}.f
824 @itemx @var{file}.for
825 @itemx @var{file}.FOR
826 Fortran source code which should not be preprocessed.
827
828 @item @var{file}.F
829 @itemx @var{file}.fpp
830 @itemx @var{file}.FPP
831 Fortran source code which must be preprocessed (with the traditional
832 preprocessor).
833
834 @item @var{file}.r
835 Fortran source code which must be preprocessed with a RATFOR
836 preprocessor (not included with GCC)@.
837
838 @item @var{file}.f90
839 @itemx @var{file}.f95
840 Fortran 90/95 source code which should not be preprocessed.
841
842 @c FIXME: Descriptions of Java file types.
843 @c @var{file}.java
844 @c @var{file}.class
845 @c @var{file}.zip
846 @c @var{file}.jar
847
848 @item @var{file}.ads
849 Ada source code file which contains a library unit declaration (a
850 declaration of a package, subprogram, or generic, or a generic
851 instantiation), or a library unit renaming declaration (a package,
852 generic, or subprogram renaming declaration). Such files are also
853 called @dfn{specs}.
854
855 @itemx @var{file}.adb
856 Ada source code file containing a library unit body (a subprogram or
857 package body). Such files are also called @dfn{bodies}.
858
859 @c GCC also knows about some suffixes for languages not yet included:
860 @c Pascal:
861 @c @var{file}.p
862 @c @var{file}.pas
863
864 @item @var{file}.s
865 Assembler code.
866
867 @item @var{file}.S
868 Assembler code which must be preprocessed.
869
870 @item @var{other}
871 An object file to be fed straight into linking.
872 Any file name with no recognized suffix is treated this way.
873 @end table
874
875 @opindex x
876 You can specify the input language explicitly with the @option{-x} option:
877
878 @table @gcctabopt
879 @item -x @var{language}
880 Specify explicitly the @var{language} for the following input files
881 (rather than letting the compiler choose a default based on the file
882 name suffix). This option applies to all following input files until
883 the next @option{-x} option. Possible values for @var{language} are:
884 @smallexample
885 c c-header c-cpp-output
886 c++ c++-header c++-cpp-output
887 objective-c objective-c-header objective-c-cpp-output
888 objective-c++ objective-c++-header objective-c++-cpp-output
889 assembler assembler-with-cpp
890 ada
891 f77 f77-cpp-input ratfor
892 f95
893 java
894 treelang
895 @end smallexample
896
897 @item -x none
898 Turn off any specification of a language, so that subsequent files are
899 handled according to their file name suffixes (as they are if @option{-x}
900 has not been used at all).
901
902 @item -pass-exit-codes
903 @opindex pass-exit-codes
904 Normally the @command{gcc} program will exit with the code of 1 if any
905 phase of the compiler returns a non-success return code. If you specify
906 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
907 numerically highest error produced by any phase that returned an error
908 indication.
909 @end table
910
911 If you only want some of the stages of compilation, you can use
912 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
913 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
914 @command{gcc} is to stop. Note that some combinations (for example,
915 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
916
917 @table @gcctabopt
918 @item -c
919 @opindex c
920 Compile or assemble the source files, but do not link. The linking
921 stage simply is not done. The ultimate output is in the form of an
922 object file for each source file.
923
924 By default, the object file name for a source file is made by replacing
925 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
926
927 Unrecognized input files, not requiring compilation or assembly, are
928 ignored.
929
930 @item -S
931 @opindex S
932 Stop after the stage of compilation proper; do not assemble. The output
933 is in the form of an assembler code file for each non-assembler input
934 file specified.
935
936 By default, the assembler file name for a source file is made by
937 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
938
939 Input files that don't require compilation are ignored.
940
941 @item -E
942 @opindex E
943 Stop after the preprocessing stage; do not run the compiler proper. The
944 output is in the form of preprocessed source code, which is sent to the
945 standard output.
946
947 Input files which don't require preprocessing are ignored.
948
949 @cindex output file option
950 @item -o @var{file}
951 @opindex o
952 Place output in file @var{file}. This applies regardless to whatever
953 sort of output is being produced, whether it be an executable file,
954 an object file, an assembler file or preprocessed C code.
955
956 If @option{-o} is not specified, the default is to put an executable
957 file in @file{a.out}, the object file for
958 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
959 assembler file in @file{@var{source}.s}, a precompiled header file in
960 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
961 standard output.
962
963 @item -v
964 @opindex v
965 Print (on standard error output) the commands executed to run the stages
966 of compilation. Also print the version number of the compiler driver
967 program and of the preprocessor and the compiler proper.
968
969 @item -###
970 @opindex ###
971 Like @option{-v} except the commands are not executed and all command
972 arguments are quoted. This is useful for shell scripts to capture the
973 driver-generated command lines.
974
975 @item -pipe
976 @opindex pipe
977 Use pipes rather than temporary files for communication between the
978 various stages of compilation. This fails to work on some systems where
979 the assembler is unable to read from a pipe; but the GNU assembler has
980 no trouble.
981
982 @item -combine
983 @opindex combine
984 If you are compiling multiple source files, this option tells the driver
985 to pass all the source files to the compiler at once (for those
986 languages for which the compiler can handle this). This will allow
987 intermodule analysis (IMA) to be performed by the compiler. Currently the only
988 language for which this is supported is C@. If you pass source files for
989 multiple languages to the driver, using this option, the driver will invoke
990 the compiler(s) that support IMA once each, passing each compiler all the
991 source files appropriate for it. For those languages that do not support
992 IMA this option will be ignored, and the compiler will be invoked once for
993 each source file in that language. If you use this option in conjunction
994 with @option{-save-temps}, the compiler will generate multiple
995 pre-processed files
996 (one for each source file), but only one (combined) @file{.o} or
997 @file{.s} file.
998
999 @item --help
1000 @opindex help
1001 Print (on the standard output) a description of the command line options
1002 understood by @command{gcc}. If the @option{-v} option is also specified
1003 then @option{--help} will also be passed on to the various processes
1004 invoked by @command{gcc}, so that they can display the command line options
1005 they accept. If the @option{-Wextra} option is also specified then command
1006 line options which have no documentation associated with them will also
1007 be displayed.
1008
1009 @item --target-help
1010 @opindex target-help
1011 Print (on the standard output) a description of target specific command
1012 line options for each tool.
1013
1014 @item --version
1015 @opindex version
1016 Display the version number and copyrights of the invoked GCC@.
1017 @end table
1018
1019 @node Invoking G++
1020 @section Compiling C++ Programs
1021
1022 @cindex suffixes for C++ source
1023 @cindex C++ source file suffixes
1024 C++ source files conventionally use one of the suffixes @samp{.C},
1025 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1026 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1027 preprocessed C++ files use the suffix @samp{.ii}. GCC recognizes
1028 files with these names and compiles them as C++ programs even if you
1029 call the compiler the same way as for compiling C programs (usually
1030 with the name @command{gcc}).
1031
1032 @findex g++
1033 @findex c++
1034 However, C++ programs often require class libraries as well as a
1035 compiler that understands the C++ language---and under some
1036 circumstances, you might want to compile programs or header files from
1037 standard input, or otherwise without a suffix that flags them as C++
1038 programs. You might also like to precompile a C header file with a
1039 @samp{.h} extension to be used in C++ compilations. @command{g++} is a
1040 program that calls GCC with the default language set to C++, and
1041 automatically specifies linking against the C++ library. On many
1042 systems, @command{g++} is also installed with the name @command{c++}.
1043
1044 @cindex invoking @command{g++}
1045 When you compile C++ programs, you may specify many of the same
1046 command-line options that you use for compiling programs in any
1047 language; or command-line options meaningful for C and related
1048 languages; or options that are meaningful only for C++ programs.
1049 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1050 explanations of options for languages related to C@.
1051 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1052 explanations of options that are meaningful only for C++ programs.
1053
1054 @node C Dialect Options
1055 @section Options Controlling C Dialect
1056 @cindex dialect options
1057 @cindex language dialect options
1058 @cindex options, dialect
1059
1060 The following options control the dialect of C (or languages derived
1061 from C, such as C++, Objective-C and Objective-C++) that the compiler
1062 accepts:
1063
1064 @table @gcctabopt
1065 @cindex ANSI support
1066 @cindex ISO support
1067 @item -ansi
1068 @opindex ansi
1069 In C mode, support all ISO C90 programs. In C++ mode,
1070 remove GNU extensions that conflict with ISO C++.
1071
1072 This turns off certain features of GCC that are incompatible with ISO
1073 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1074 such as the @code{asm} and @code{typeof} keywords, and
1075 predefined macros such as @code{unix} and @code{vax} that identify the
1076 type of system you are using. It also enables the undesirable and
1077 rarely used ISO trigraph feature. For the C compiler,
1078 it disables recognition of C++ style @samp{//} comments as well as
1079 the @code{inline} keyword.
1080
1081 The alternate keywords @code{__asm__}, @code{__extension__},
1082 @code{__inline__} and @code{__typeof__} continue to work despite
1083 @option{-ansi}. You would not want to use them in an ISO C program, of
1084 course, but it is useful to put them in header files that might be included
1085 in compilations done with @option{-ansi}. Alternate predefined macros
1086 such as @code{__unix__} and @code{__vax__} are also available, with or
1087 without @option{-ansi}.
1088
1089 The @option{-ansi} option does not cause non-ISO programs to be
1090 rejected gratuitously. For that, @option{-pedantic} is required in
1091 addition to @option{-ansi}. @xref{Warning Options}.
1092
1093 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1094 option is used. Some header files may notice this macro and refrain
1095 from declaring certain functions or defining certain macros that the
1096 ISO standard doesn't call for; this is to avoid interfering with any
1097 programs that might use these names for other things.
1098
1099 Functions which would normally be built in but do not have semantics
1100 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1101 functions with @option{-ansi} is used. @xref{Other Builtins,,Other
1102 built-in functions provided by GCC}, for details of the functions
1103 affected.
1104
1105 @item -std=
1106 @opindex std
1107 Determine the language standard. This option is currently only
1108 supported when compiling C or C++. A value for this option must be
1109 provided; possible values are
1110
1111 @table @samp
1112 @item c89
1113 @itemx iso9899:1990
1114 ISO C90 (same as @option{-ansi}).
1115
1116 @item iso9899:199409
1117 ISO C90 as modified in amendment 1.
1118
1119 @item c99
1120 @itemx c9x
1121 @itemx iso9899:1999
1122 @itemx iso9899:199x
1123 ISO C99. Note that this standard is not yet fully supported; see
1124 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information. The
1125 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1126
1127 @item gnu89
1128 Default, ISO C90 plus GNU extensions (including some C99 features).
1129
1130 @item gnu99
1131 @itemx gnu9x
1132 ISO C99 plus GNU extensions. When ISO C99 is fully implemented in GCC,
1133 this will become the default. The name @samp{gnu9x} is deprecated.
1134
1135 @item c++98
1136 The 1998 ISO C++ standard plus amendments.
1137
1138 @item gnu++98
1139 The same as @option{-std=c++98} plus GNU extensions. This is the
1140 default for C++ code.
1141 @end table
1142
1143 Even when this option is not specified, you can still use some of the
1144 features of newer standards in so far as they do not conflict with
1145 previous C standards. For example, you may use @code{__restrict__} even
1146 when @option{-std=c99} is not specified.
1147
1148 The @option{-std} options specifying some version of ISO C have the same
1149 effects as @option{-ansi}, except that features that were not in ISO C90
1150 but are in the specified version (for example, @samp{//} comments and
1151 the @code{inline} keyword in ISO C99) are not disabled.
1152
1153 @xref{Standards,,Language Standards Supported by GCC}, for details of
1154 these standard versions.
1155
1156 @item -aux-info @var{filename}
1157 @opindex aux-info
1158 Output to the given filename prototyped declarations for all functions
1159 declared and/or defined in a translation unit, including those in header
1160 files. This option is silently ignored in any language other than C@.
1161
1162 Besides declarations, the file indicates, in comments, the origin of
1163 each declaration (source file and line), whether the declaration was
1164 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1165 @samp{O} for old, respectively, in the first character after the line
1166 number and the colon), and whether it came from a declaration or a
1167 definition (@samp{C} or @samp{F}, respectively, in the following
1168 character). In the case of function definitions, a K&R-style list of
1169 arguments followed by their declarations is also provided, inside
1170 comments, after the declaration.
1171
1172 @item -fno-asm
1173 @opindex fno-asm
1174 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1175 keyword, so that code can use these words as identifiers. You can use
1176 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1177 instead. @option{-ansi} implies @option{-fno-asm}.
1178
1179 In C++, this switch only affects the @code{typeof} keyword, since
1180 @code{asm} and @code{inline} are standard keywords. You may want to
1181 use the @option{-fno-gnu-keywords} flag instead, which has the same
1182 effect. In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1183 switch only affects the @code{asm} and @code{typeof} keywords, since
1184 @code{inline} is a standard keyword in ISO C99.
1185
1186 @item -fno-builtin
1187 @itemx -fno-builtin-@var{function}
1188 @opindex fno-builtin
1189 @cindex built-in functions
1190 Don't recognize built-in functions that do not begin with
1191 @samp{__builtin_} as prefix. @xref{Other Builtins,,Other built-in
1192 functions provided by GCC}, for details of the functions affected,
1193 including those which are not built-in functions when @option{-ansi} or
1194 @option{-std} options for strict ISO C conformance are used because they
1195 do not have an ISO standard meaning.
1196
1197 GCC normally generates special code to handle certain built-in functions
1198 more efficiently; for instance, calls to @code{alloca} may become single
1199 instructions that adjust the stack directly, and calls to @code{memcpy}
1200 may become inline copy loops. The resulting code is often both smaller
1201 and faster, but since the function calls no longer appear as such, you
1202 cannot set a breakpoint on those calls, nor can you change the behavior
1203 of the functions by linking with a different library. In addition,
1204 when a function is recognized as a built-in function, GCC may use
1205 information about that function to warn about problems with calls to
1206 that function, or to generate more efficient code, even if the
1207 resulting code still contains calls to that function. For example,
1208 warnings are given with @option{-Wformat} for bad calls to
1209 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1210 known not to modify global memory.
1211
1212 With the @option{-fno-builtin-@var{function}} option
1213 only the built-in function @var{function} is
1214 disabled. @var{function} must not begin with @samp{__builtin_}. If a
1215 function is named this is not built-in in this version of GCC, this
1216 option is ignored. There is no corresponding
1217 @option{-fbuiltin-@var{function}} option; if you wish to enable
1218 built-in functions selectively when using @option{-fno-builtin} or
1219 @option{-ffreestanding}, you may define macros such as:
1220
1221 @smallexample
1222 #define abs(n) __builtin_abs ((n))
1223 #define strcpy(d, s) __builtin_strcpy ((d), (s))
1224 @end smallexample
1225
1226 @item -fhosted
1227 @opindex fhosted
1228 @cindex hosted environment
1229
1230 Assert that compilation takes place in a hosted environment. This implies
1231 @option{-fbuiltin}. A hosted environment is one in which the
1232 entire standard library is available, and in which @code{main} has a return
1233 type of @code{int}. Examples are nearly everything except a kernel.
1234 This is equivalent to @option{-fno-freestanding}.
1235
1236 @item -ffreestanding
1237 @opindex ffreestanding
1238 @cindex hosted environment
1239
1240 Assert that compilation takes place in a freestanding environment. This
1241 implies @option{-fno-builtin}. A freestanding environment
1242 is one in which the standard library may not exist, and program startup may
1243 not necessarily be at @code{main}. The most obvious example is an OS kernel.
1244 This is equivalent to @option{-fno-hosted}.
1245
1246 @xref{Standards,,Language Standards Supported by GCC}, for details of
1247 freestanding and hosted environments.
1248
1249 @item -fms-extensions
1250 @opindex fms-extensions
1251 Accept some non-standard constructs used in Microsoft header files.
1252
1253 Some cases of unnamed fields in structures and unions are only
1254 accepted with this option. @xref{Unnamed Fields,,Unnamed struct/union
1255 fields within structs/unions}, for details.
1256
1257 @item -trigraphs
1258 @opindex trigraphs
1259 Support ISO C trigraphs. The @option{-ansi} option (and @option{-std}
1260 options for strict ISO C conformance) implies @option{-trigraphs}.
1261
1262 @item -no-integrated-cpp
1263 @opindex no-integrated-cpp
1264 Performs a compilation in two passes: preprocessing and compiling. This
1265 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1266 @option{-B} option. The user supplied compilation step can then add in
1267 an additional preprocessing step after normal preprocessing but before
1268 compiling. The default is to use the integrated cpp (internal cpp)
1269
1270 The semantics of this option will change if "cc1", "cc1plus", and
1271 "cc1obj" are merged.
1272
1273 @cindex traditional C language
1274 @cindex C language, traditional
1275 @item -traditional
1276 @itemx -traditional-cpp
1277 @opindex traditional-cpp
1278 @opindex traditional
1279 Formerly, these options caused GCC to attempt to emulate a pre-standard
1280 C compiler. They are now only supported with the @option{-E} switch.
1281 The preprocessor continues to support a pre-standard mode. See the GNU
1282 CPP manual for details.
1283
1284 @item -fcond-mismatch
1285 @opindex fcond-mismatch
1286 Allow conditional expressions with mismatched types in the second and
1287 third arguments. The value of such an expression is void. This option
1288 is not supported for C++.
1289
1290 @item -funsigned-char
1291 @opindex funsigned-char
1292 Let the type @code{char} be unsigned, like @code{unsigned char}.
1293
1294 Each kind of machine has a default for what @code{char} should
1295 be. It is either like @code{unsigned char} by default or like
1296 @code{signed char} by default.
1297
1298 Ideally, a portable program should always use @code{signed char} or
1299 @code{unsigned char} when it depends on the signedness of an object.
1300 But many programs have been written to use plain @code{char} and
1301 expect it to be signed, or expect it to be unsigned, depending on the
1302 machines they were written for. This option, and its inverse, let you
1303 make such a program work with the opposite default.
1304
1305 The type @code{char} is always a distinct type from each of
1306 @code{signed char} or @code{unsigned char}, even though its behavior
1307 is always just like one of those two.
1308
1309 @item -fsigned-char
1310 @opindex fsigned-char
1311 Let the type @code{char} be signed, like @code{signed char}.
1312
1313 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1314 the negative form of @option{-funsigned-char}. Likewise, the option
1315 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1316
1317 @item -fsigned-bitfields
1318 @itemx -funsigned-bitfields
1319 @itemx -fno-signed-bitfields
1320 @itemx -fno-unsigned-bitfields
1321 @opindex fsigned-bitfields
1322 @opindex funsigned-bitfields
1323 @opindex fno-signed-bitfields
1324 @opindex fno-unsigned-bitfields
1325 These options control whether a bit-field is signed or unsigned, when the
1326 declaration does not use either @code{signed} or @code{unsigned}. By
1327 default, such a bit-field is signed, because this is consistent: the
1328 basic integer types such as @code{int} are signed types.
1329 @end table
1330
1331 @node C++ Dialect Options
1332 @section Options Controlling C++ Dialect
1333
1334 @cindex compiler options, C++
1335 @cindex C++ options, command line
1336 @cindex options, C++
1337 This section describes the command-line options that are only meaningful
1338 for C++ programs; but you can also use most of the GNU compiler options
1339 regardless of what language your program is in. For example, you
1340 might compile a file @code{firstClass.C} like this:
1341
1342 @smallexample
1343 g++ -g -frepo -O -c firstClass.C
1344 @end smallexample
1345
1346 @noindent
1347 In this example, only @option{-frepo} is an option meant
1348 only for C++ programs; you can use the other options with any
1349 language supported by GCC@.
1350
1351 Here is a list of options that are @emph{only} for compiling C++ programs:
1352
1353 @table @gcctabopt
1354
1355 @item -fabi-version=@var{n}
1356 @opindex fabi-version
1357 Use version @var{n} of the C++ ABI@. Version 2 is the version of the
1358 C++ ABI that first appeared in G++ 3.4. Version 1 is the version of
1359 the C++ ABI that first appeared in G++ 3.2. Version 0 will always be
1360 the version that conforms most closely to the C++ ABI specification.
1361 Therefore, the ABI obtained using version 0 will change as ABI bugs
1362 are fixed.
1363
1364 The default is version 2.
1365
1366 @item -fno-access-control
1367 @opindex fno-access-control
1368 Turn off all access checking. This switch is mainly useful for working
1369 around bugs in the access control code.
1370
1371 @item -fcheck-new
1372 @opindex fcheck-new
1373 Check that the pointer returned by @code{operator new} is non-null
1374 before attempting to modify the storage allocated. This check is
1375 normally unnecessary because the C++ standard specifies that
1376 @code{operator new} will only return @code{0} if it is declared
1377 @samp{throw()}, in which case the compiler will always check the
1378 return value even without this option. In all other cases, when
1379 @code{operator new} has a non-empty exception specification, memory
1380 exhaustion is signalled by throwing @code{std::bad_alloc}. See also
1381 @samp{new (nothrow)}.
1382
1383 @item -fconserve-space
1384 @opindex fconserve-space
1385 Put uninitialized or runtime-initialized global variables into the
1386 common segment, as C does. This saves space in the executable at the
1387 cost of not diagnosing duplicate definitions. If you compile with this
1388 flag and your program mysteriously crashes after @code{main()} has
1389 completed, you may have an object that is being destroyed twice because
1390 two definitions were merged.
1391
1392 This option is no longer useful on most targets, now that support has
1393 been added for putting variables into BSS without making them common.
1394
1395 @item -fno-const-strings
1396 @opindex fno-const-strings
1397 Give string constants type @code{char *} instead of type @code{const
1398 char *}. By default, G++ uses type @code{const char *} as required by
1399 the standard. Even if you use @option{-fno-const-strings}, you cannot
1400 actually modify the value of a string constant.
1401
1402 This option might be removed in a future release of G++. For maximum
1403 portability, you should structure your code so that it works with
1404 string constants that have type @code{const char *}.
1405
1406 @item -fno-elide-constructors
1407 @opindex fno-elide-constructors
1408 The C++ standard allows an implementation to omit creating a temporary
1409 which is only used to initialize another object of the same type.
1410 Specifying this option disables that optimization, and forces G++ to
1411 call the copy constructor in all cases.
1412
1413 @item -fno-enforce-eh-specs
1414 @opindex fno-enforce-eh-specs
1415 Don't check for violation of exception specifications at runtime. This
1416 option violates the C++ standard, but may be useful for reducing code
1417 size in production builds, much like defining @samp{NDEBUG}. The compiler
1418 will still optimize based on the exception specifications.
1419
1420 @item -ffor-scope
1421 @itemx -fno-for-scope
1422 @opindex ffor-scope
1423 @opindex fno-for-scope
1424 If @option{-ffor-scope} is specified, the scope of variables declared in
1425 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1426 as specified by the C++ standard.
1427 If @option{-fno-for-scope} is specified, the scope of variables declared in
1428 a @i{for-init-statement} extends to the end of the enclosing scope,
1429 as was the case in old versions of G++, and other (traditional)
1430 implementations of C++.
1431
1432 The default if neither flag is given to follow the standard,
1433 but to allow and give a warning for old-style code that would
1434 otherwise be invalid, or have different behavior.
1435
1436 @item -fno-gnu-keywords
1437 @opindex fno-gnu-keywords
1438 Do not recognize @code{typeof} as a keyword, so that code can use this
1439 word as an identifier. You can use the keyword @code{__typeof__} instead.
1440 @option{-ansi} implies @option{-fno-gnu-keywords}.
1441
1442 @item -fno-implicit-templates
1443 @opindex fno-implicit-templates
1444 Never emit code for non-inline templates which are instantiated
1445 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1446 @xref{Template Instantiation}, for more information.
1447
1448 @item -fno-implicit-inline-templates
1449 @opindex fno-implicit-inline-templates
1450 Don't emit code for implicit instantiations of inline templates, either.
1451 The default is to handle inlines differently so that compiles with and
1452 without optimization will need the same set of explicit instantiations.
1453
1454 @item -fno-implement-inlines
1455 @opindex fno-implement-inlines
1456 To save space, do not emit out-of-line copies of inline functions
1457 controlled by @samp{#pragma implementation}. This will cause linker
1458 errors if these functions are not inlined everywhere they are called.
1459
1460 @item -fms-extensions
1461 @opindex fms-extensions
1462 Disable pedantic warnings about constructs used in MFC, such as implicit
1463 int and getting a pointer to member function via non-standard syntax.
1464
1465 @item -fno-nonansi-builtins
1466 @opindex fno-nonansi-builtins
1467 Disable built-in declarations of functions that are not mandated by
1468 ANSI/ISO C@. These include @code{ffs}, @code{alloca}, @code{_exit},
1469 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1470
1471 @item -fno-operator-names
1472 @opindex fno-operator-names
1473 Do not treat the operator name keywords @code{and}, @code{bitand},
1474 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1475 synonyms as keywords.
1476
1477 @item -fno-optional-diags
1478 @opindex fno-optional-diags
1479 Disable diagnostics that the standard says a compiler does not need to
1480 issue. Currently, the only such diagnostic issued by G++ is the one for
1481 a name having multiple meanings within a class.
1482
1483 @item -fpermissive
1484 @opindex fpermissive
1485 Downgrade some diagnostics about nonconformant code from errors to
1486 warnings. Thus, using @option{-fpermissive} will allow some
1487 nonconforming code to compile.
1488
1489 @item -frepo
1490 @opindex frepo
1491 Enable automatic template instantiation at link time. This option also
1492 implies @option{-fno-implicit-templates}. @xref{Template
1493 Instantiation}, for more information.
1494
1495 @item -fno-rtti
1496 @opindex fno-rtti
1497 Disable generation of information about every class with virtual
1498 functions for use by the C++ runtime type identification features
1499 (@samp{dynamic_cast} and @samp{typeid}). If you don't use those parts
1500 of the language, you can save some space by using this flag. Note that
1501 exception handling uses the same information, but it will generate it as
1502 needed.
1503
1504 @item -fstats
1505 @opindex fstats
1506 Emit statistics about front-end processing at the end of the compilation.
1507 This information is generally only useful to the G++ development team.
1508
1509 @item -ftemplate-depth-@var{n}
1510 @opindex ftemplate-depth
1511 Set the maximum instantiation depth for template classes to @var{n}.
1512 A limit on the template instantiation depth is needed to detect
1513 endless recursions during template class instantiation. ANSI/ISO C++
1514 conforming programs must not rely on a maximum depth greater than 17.
1515
1516 @item -fno-threadsafe-statics
1517 @opindex fno-threadsafe-statics
1518 Do not emit the extra code to use the routines specified in the C++
1519 ABI for thread-safe initialization of local statics. You can use this
1520 option to reduce code size slightly in code that doesn't need to be
1521 thread-safe.
1522
1523 @item -fuse-cxa-atexit
1524 @opindex fuse-cxa-atexit
1525 Register destructors for objects with static storage duration with the
1526 @code{__cxa_atexit} function rather than the @code{atexit} function.
1527 This option is required for fully standards-compliant handling of static
1528 destructors, but will only work if your C library supports
1529 @code{__cxa_atexit}.
1530
1531 @item -fvisibility-inlines-hidden
1532 @opindex fvisibility-inlines-hidden
1533 Causes all inlined methods to be marked with
1534 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1535 appear in the export table of a DSO and do not require a PLT indirection
1536 when used within the DSO@. Enabling this option can have a dramatic effect
1537 on load and link times of a DSO as it massively reduces the size of the
1538 dynamic export table when the library makes heavy use of templates. While
1539 it can cause bloating through duplication of code within each DSO where
1540 it is used, often the wastage is less than the considerable space occupied
1541 by a long symbol name in the export table which is typical when using
1542 templates and namespaces. For even more savings, combine with the
1543 @option{-fvisibility=hidden} switch.
1544
1545 @item -fno-weak
1546 @opindex fno-weak
1547 Do not use weak symbol support, even if it is provided by the linker.
1548 By default, G++ will use weak symbols if they are available. This
1549 option exists only for testing, and should not be used by end-users;
1550 it will result in inferior code and has no benefits. This option may
1551 be removed in a future release of G++.
1552
1553 @item -nostdinc++
1554 @opindex nostdinc++
1555 Do not search for header files in the standard directories specific to
1556 C++, but do still search the other standard directories. (This option
1557 is used when building the C++ library.)
1558 @end table
1559
1560 In addition, these optimization, warning, and code generation options
1561 have meanings only for C++ programs:
1562
1563 @table @gcctabopt
1564 @item -fno-default-inline
1565 @opindex fno-default-inline
1566 Do not assume @samp{inline} for functions defined inside a class scope.
1567 @xref{Optimize Options,,Options That Control Optimization}. Note that these
1568 functions will have linkage like inline functions; they just won't be
1569 inlined by default.
1570
1571 @item -Wabi @r{(C++ only)}
1572 @opindex Wabi
1573 Warn when G++ generates code that is probably not compatible with the
1574 vendor-neutral C++ ABI@. Although an effort has been made to warn about
1575 all such cases, there are probably some cases that are not warned about,
1576 even though G++ is generating incompatible code. There may also be
1577 cases where warnings are emitted even though the code that is generated
1578 will be compatible.
1579
1580 You should rewrite your code to avoid these warnings if you are
1581 concerned about the fact that code generated by G++ may not be binary
1582 compatible with code generated by other compilers.
1583
1584 The known incompatibilities at this point include:
1585
1586 @itemize @bullet
1587
1588 @item
1589 Incorrect handling of tail-padding for bit-fields. G++ may attempt to
1590 pack data into the same byte as a base class. For example:
1591
1592 @smallexample
1593 struct A @{ virtual void f(); int f1 : 1; @};
1594 struct B : public A @{ int f2 : 1; @};
1595 @end smallexample
1596
1597 @noindent
1598 In this case, G++ will place @code{B::f2} into the same byte
1599 as@code{A::f1}; other compilers will not. You can avoid this problem
1600 by explicitly padding @code{A} so that its size is a multiple of the
1601 byte size on your platform; that will cause G++ and other compilers to
1602 layout @code{B} identically.
1603
1604 @item
1605 Incorrect handling of tail-padding for virtual bases. G++ does not use
1606 tail padding when laying out virtual bases. For example:
1607
1608 @smallexample
1609 struct A @{ virtual void f(); char c1; @};
1610 struct B @{ B(); char c2; @};
1611 struct C : public A, public virtual B @{@};
1612 @end smallexample
1613
1614 @noindent
1615 In this case, G++ will not place @code{B} into the tail-padding for
1616 @code{A}; other compilers will. You can avoid this problem by
1617 explicitly padding @code{A} so that its size is a multiple of its
1618 alignment (ignoring virtual base classes); that will cause G++ and other
1619 compilers to layout @code{C} identically.
1620
1621 @item
1622 Incorrect handling of bit-fields with declared widths greater than that
1623 of their underlying types, when the bit-fields appear in a union. For
1624 example:
1625
1626 @smallexample
1627 union U @{ int i : 4096; @};
1628 @end smallexample
1629
1630 @noindent
1631 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1632 union too small by the number of bits in an @code{int}.
1633
1634 @item
1635 Empty classes can be placed at incorrect offsets. For example:
1636
1637 @smallexample
1638 struct A @{@};
1639
1640 struct B @{
1641 A a;
1642 virtual void f ();
1643 @};
1644
1645 struct C : public B, public A @{@};
1646 @end smallexample
1647
1648 @noindent
1649 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1650 it should be placed at offset zero. G++ mistakenly believes that the
1651 @code{A} data member of @code{B} is already at offset zero.
1652
1653 @item
1654 Names of template functions whose types involve @code{typename} or
1655 template template parameters can be mangled incorrectly.
1656
1657 @smallexample
1658 template <typename Q>
1659 void f(typename Q::X) @{@}
1660
1661 template <template <typename> class Q>
1662 void f(typename Q<int>::X) @{@}
1663 @end smallexample
1664
1665 @noindent
1666 Instantiations of these templates may be mangled incorrectly.
1667
1668 @end itemize
1669
1670 @item -Wctor-dtor-privacy @r{(C++ only)}
1671 @opindex Wctor-dtor-privacy
1672 Warn when a class seems unusable because all the constructors or
1673 destructors in that class are private, and it has neither friends nor
1674 public static member functions.
1675
1676 @item -Wnon-virtual-dtor @r{(C++ only)}
1677 @opindex Wnon-virtual-dtor
1678 Warn when a class appears to be polymorphic, thereby requiring a virtual
1679 destructor, yet it declares a non-virtual one.
1680 This warning is enabled by @option{-Wall}.
1681
1682 @item -Wreorder @r{(C++ only)}
1683 @opindex Wreorder
1684 @cindex reordering, warning
1685 @cindex warning for reordering of member initializers
1686 Warn when the order of member initializers given in the code does not
1687 match the order in which they must be executed. For instance:
1688
1689 @smallexample
1690 struct A @{
1691 int i;
1692 int j;
1693 A(): j (0), i (1) @{ @}
1694 @};
1695 @end smallexample
1696
1697 The compiler will rearrange the member initializers for @samp{i}
1698 and @samp{j} to match the declaration order of the members, emitting
1699 a warning to that effect. This warning is enabled by @option{-Wall}.
1700 @end table
1701
1702 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1703
1704 @table @gcctabopt
1705 @item -Weffc++ @r{(C++ only)}
1706 @opindex Weffc++
1707 Warn about violations of the following style guidelines from Scott Meyers'
1708 @cite{Effective C++} book:
1709
1710 @itemize @bullet
1711 @item
1712 Item 11: Define a copy constructor and an assignment operator for classes
1713 with dynamically allocated memory.
1714
1715 @item
1716 Item 12: Prefer initialization to assignment in constructors.
1717
1718 @item
1719 Item 14: Make destructors virtual in base classes.
1720
1721 @item
1722 Item 15: Have @code{operator=} return a reference to @code{*this}.
1723
1724 @item
1725 Item 23: Don't try to return a reference when you must return an object.
1726
1727 @end itemize
1728
1729 Also warn about violations of the following style guidelines from
1730 Scott Meyers' @cite{More Effective C++} book:
1731
1732 @itemize @bullet
1733 @item
1734 Item 6: Distinguish between prefix and postfix forms of increment and
1735 decrement operators.
1736
1737 @item
1738 Item 7: Never overload @code{&&}, @code{||}, or @code{,}.
1739
1740 @end itemize
1741
1742 When selecting this option, be aware that the standard library
1743 headers do not obey all of these guidelines; use @samp{grep -v}
1744 to filter out those warnings.
1745
1746 @item -Wno-deprecated @r{(C++ only)}
1747 @opindex Wno-deprecated
1748 Do not warn about usage of deprecated features. @xref{Deprecated Features}.
1749
1750 @item -Wstrict-null-sentinel @r{(C++ only)}
1751 @opindex Wstrict-null-sentinel
1752 Warn also about the use of an uncasted @code{NULL} as sentinel. When
1753 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1754 to @code{__null}. Although it is a null pointer constant not a null pointer,
1755 it is guaranteed to of the same size as a pointer. But this use is
1756 not portable across different compilers.
1757
1758 @item -Wno-non-template-friend @r{(C++ only)}
1759 @opindex Wno-non-template-friend
1760 Disable warnings when non-templatized friend functions are declared
1761 within a template. Since the advent of explicit template specification
1762 support in G++, if the name of the friend is an unqualified-id (i.e.,
1763 @samp{friend foo(int)}), the C++ language specification demands that the
1764 friend declare or define an ordinary, nontemplate function. (Section
1765 14.5.3). Before G++ implemented explicit specification, unqualified-ids
1766 could be interpreted as a particular specialization of a templatized
1767 function. Because this non-conforming behavior is no longer the default
1768 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1769 check existing code for potential trouble spots and is on by default.
1770 This new compiler behavior can be turned off with
1771 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1772 but disables the helpful warning.
1773
1774 @item -Wold-style-cast @r{(C++ only)}
1775 @opindex Wold-style-cast
1776 Warn if an old-style (C-style) cast to a non-void type is used within
1777 a C++ program. The new-style casts (@samp{static_cast},
1778 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1779 unintended effects and much easier to search for.
1780
1781 @item -Woverloaded-virtual @r{(C++ only)}
1782 @opindex Woverloaded-virtual
1783 @cindex overloaded virtual fn, warning
1784 @cindex warning for overloaded virtual fn
1785 Warn when a function declaration hides virtual functions from a
1786 base class. For example, in:
1787
1788 @smallexample
1789 struct A @{
1790 virtual void f();
1791 @};
1792
1793 struct B: public A @{
1794 void f(int);
1795 @};
1796 @end smallexample
1797
1798 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1799 like:
1800
1801 @smallexample
1802 B* b;
1803 b->f();
1804 @end smallexample
1805
1806 will fail to compile.
1807
1808 @item -Wno-pmf-conversions @r{(C++ only)}
1809 @opindex Wno-pmf-conversions
1810 Disable the diagnostic for converting a bound pointer to member function
1811 to a plain pointer.
1812
1813 @item -Wsign-promo @r{(C++ only)}
1814 @opindex Wsign-promo
1815 Warn when overload resolution chooses a promotion from unsigned or
1816 enumerated type to a signed type, over a conversion to an unsigned type of
1817 the same size. Previous versions of G++ would try to preserve
1818 unsignedness, but the standard mandates the current behavior.
1819
1820 @smallexample
1821 struct A @{
1822 operator int ();
1823 A& operator = (int);
1824 @};
1825
1826 main ()
1827 @{
1828 A a,b;
1829 a = b;
1830 @}
1831 @end smallexample
1832
1833 In this example, G++ will synthesize a default @samp{A& operator =
1834 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1835 @end table
1836
1837 @node Objective-C and Objective-C++ Dialect Options
1838 @section Options Controlling Objective-C and Objective-C++ Dialects
1839
1840 @cindex compiler options, Objective-C and Objective-C++
1841 @cindex Objective-C and Objective-C++ options, command line
1842 @cindex options, Objective-C and Objective-C++
1843 (NOTE: This manual does not describe the Objective-C and Objective-C++
1844 languages themselves. See @xref{Standards,,Language Standards
1845 Supported by GCC}, for references.)
1846
1847 This section describes the command-line options that are only meaningful
1848 for Objective-C and Objective-C++ programs, but you can also use most of
1849 the language-independent GNU compiler options.
1850 For example, you might compile a file @code{some_class.m} like this:
1851
1852 @smallexample
1853 gcc -g -fgnu-runtime -O -c some_class.m
1854 @end smallexample
1855
1856 @noindent
1857 In this example, @option{-fgnu-runtime} is an option meant only for
1858 Objective-C and Objective-C++ programs; you can use the other options with
1859 any language supported by GCC@.
1860
1861 Note that since Objective-C is an extension of the C language, Objective-C
1862 compilations may also use options specific to the C front-end (e.g.,
1863 @option{-Wtraditional}). Similarly, Objective-C++ compilations may use
1864 C++-specific options (e.g., @option{-Wabi}).
1865
1866 Here is a list of options that are @emph{only} for compiling Objective-C
1867 and Objective-C++ programs:
1868
1869 @table @gcctabopt
1870 @item -fconstant-string-class=@var{class-name}
1871 @opindex fconstant-string-class
1872 Use @var{class-name} as the name of the class to instantiate for each
1873 literal string specified with the syntax @code{@@"@dots{}"}. The default
1874 class name is @code{NXConstantString} if the GNU runtime is being used, and
1875 @code{NSConstantString} if the NeXT runtime is being used (see below). The
1876 @option{-fconstant-cfstrings} option, if also present, will override the
1877 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1878 to be laid out as constant CoreFoundation strings.
1879
1880 @item -fgnu-runtime
1881 @opindex fgnu-runtime
1882 Generate object code compatible with the standard GNU Objective-C
1883 runtime. This is the default for most types of systems.
1884
1885 @item -fnext-runtime
1886 @opindex fnext-runtime
1887 Generate output compatible with the NeXT runtime. This is the default
1888 for NeXT-based systems, including Darwin and Mac OS X@. The macro
1889 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1890 used.
1891
1892 @item -fno-nil-receivers
1893 @opindex fno-nil-receivers
1894 Assume that all Objective-C message dispatches (e.g.,
1895 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1896 is not @code{nil}. This allows for more efficient entry points in the runtime
1897 to be used. Currently, this option is only available in conjunction with
1898 the NeXT runtime on Mac OS X 10.3 and later.
1899
1900 @item -fobjc-exceptions
1901 @opindex fobjc-exceptions
1902 Enable syntactic support for structured exception handling in Objective-C,
1903 similar to what is offered by C++ and Java. Currently, this option is only
1904 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1905
1906 @smallexample
1907 @@try @{
1908 @dots{}
1909 @@throw expr;
1910 @dots{}
1911 @}
1912 @@catch (AnObjCClass *exc) @{
1913 @dots{}
1914 @@throw expr;
1915 @dots{}
1916 @@throw;
1917 @dots{}
1918 @}
1919 @@catch (AnotherClass *exc) @{
1920 @dots{}
1921 @}
1922 @@catch (id allOthers) @{
1923 @dots{}
1924 @}
1925 @@finally @{
1926 @dots{}
1927 @@throw expr;
1928 @dots{}
1929 @}
1930 @end smallexample
1931
1932 The @code{@@throw} statement may appear anywhere in an Objective-C or
1933 Objective-C++ program; when used inside of a @code{@@catch} block, the
1934 @code{@@throw} may appear without an argument (as shown above), in which case
1935 the object caught by the @code{@@catch} will be rethrown.
1936
1937 Note that only (pointers to) Objective-C objects may be thrown and
1938 caught using this scheme. When an object is thrown, it will be caught
1939 by the nearest @code{@@catch} clause capable of handling objects of that type,
1940 analogously to how @code{catch} blocks work in C++ and Java. A
1941 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1942 any and all Objective-C exceptions not caught by previous @code{@@catch}
1943 clauses (if any).
1944
1945 The @code{@@finally} clause, if present, will be executed upon exit from the
1946 immediately preceding @code{@@try @dots{} @@catch} section. This will happen
1947 regardless of whether any exceptions are thrown, caught or rethrown
1948 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1949 of the @code{finally} clause in Java.
1950
1951 There are several caveats to using the new exception mechanism:
1952
1953 @itemize @bullet
1954 @item
1955 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1956 idioms provided by the @code{NSException} class, the new
1957 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1958 systems, due to additional functionality needed in the (NeXT) Objective-C
1959 runtime.
1960
1961 @item
1962 As mentioned above, the new exceptions do not support handling
1963 types other than Objective-C objects. Furthermore, when used from
1964 Objective-C++, the Objective-C exception model does not interoperate with C++
1965 exceptions at this time. This means you cannot @code{@@throw} an exception
1966 from Objective-C and @code{catch} it in C++, or vice versa
1967 (i.e., @code{throw @dots{} @@catch}).
1968 @end itemize
1969
1970 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1971 blocks for thread-safe execution:
1972
1973 @smallexample
1974 @@synchronized (ObjCClass *guard) @{
1975 @dots{}
1976 @}
1977 @end smallexample
1978
1979 Upon entering the @code{@@synchronized} block, a thread of execution shall
1980 first check whether a lock has been placed on the corresponding @code{guard}
1981 object by another thread. If it has, the current thread shall wait until
1982 the other thread relinquishes its lock. Once @code{guard} becomes available,
1983 the current thread will place its own lock on it, execute the code contained in
1984 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1985 making @code{guard} available to other threads).
1986
1987 Unlike Java, Objective-C does not allow for entire methods to be marked
1988 @code{@@synchronized}. Note that throwing exceptions out of
1989 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1990 to be unlocked properly.
1991
1992 @item -freplace-objc-classes
1993 @opindex freplace-objc-classes
1994 Emit a special marker instructing @command{ld(1)} not to statically link in
1995 the resulting object file, and allow @command{dyld(1)} to load it in at
1996 run time instead. This is used in conjunction with the Fix-and-Continue
1997 debugging mode, where the object file in question may be recompiled and
1998 dynamically reloaded in the course of program execution, without the need
1999 to restart the program itself. Currently, Fix-and-Continue functionality
2000 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2001 and later.
2002
2003 @item -fzero-link
2004 @opindex fzero-link
2005 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2006 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2007 compile time) with static class references that get initialized at load time,
2008 which improves run-time performance. Specifying the @option{-fzero-link} flag
2009 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2010 to be retained. This is useful in Zero-Link debugging mode, since it allows
2011 for individual class implementations to be modified during program execution.
2012
2013 @item -gen-decls
2014 @opindex gen-decls
2015 Dump interface declarations for all classes seen in the source file to a
2016 file named @file{@var{sourcename}.decl}.
2017
2018 @item -Wno-protocol
2019 @opindex Wno-protocol
2020 If a class is declared to implement a protocol, a warning is issued for
2021 every method in the protocol that is not implemented by the class. The
2022 default behavior is to issue a warning for every method not explicitly
2023 implemented in the class, even if a method implementation is inherited
2024 from the superclass. If you use the @option{-Wno-protocol} option, then
2025 methods inherited from the superclass are considered to be implemented,
2026 and no warning is issued for them.
2027
2028 @item -Wselector
2029 @opindex Wselector
2030 Warn if multiple methods of different types for the same selector are
2031 found during compilation. The check is performed on the list of methods
2032 in the final stage of compilation. Additionally, a check is performed
2033 for each selector appearing in a @code{@@selector(@dots{})}
2034 expression, and a corresponding method for that selector has been found
2035 during compilation. Because these checks scan the method table only at
2036 the end of compilation, these warnings are not produced if the final
2037 stage of compilation is not reached, for example because an error is
2038 found during compilation, or because the @option{-fsyntax-only} option is
2039 being used.
2040
2041 @item -Wundeclared-selector
2042 @opindex Wundeclared-selector
2043 Warn if a @code{@@selector(@dots{})} expression referring to an
2044 undeclared selector is found. A selector is considered undeclared if no
2045 method with that name has been declared before the
2046 @code{@@selector(@dots{})} expression, either explicitly in an
2047 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2048 an @code{@@implementation} section. This option always performs its
2049 checks as soon as a @code{@@selector(@dots{})} expression is found,
2050 while @option{-Wselector} only performs its checks in the final stage of
2051 compilation. This also enforces the coding style convention
2052 that methods and selectors must be declared before being used.
2053
2054 @item -print-objc-runtime-info
2055 @opindex print-objc-runtime-info
2056 Generate C header describing the largest structure that is passed by
2057 value, if any.
2058
2059 @end table
2060
2061 @node Language Independent Options
2062 @section Options to Control Diagnostic Messages Formatting
2063 @cindex options to control diagnostics formatting
2064 @cindex diagnostic messages
2065 @cindex message formatting
2066
2067 Traditionally, diagnostic messages have been formatted irrespective of
2068 the output device's aspect (e.g.@: its width, @dots{}). The options described
2069 below can be used to control the diagnostic messages formatting
2070 algorithm, e.g.@: how many characters per line, how often source location
2071 information should be reported. Right now, only the C++ front end can
2072 honor these options. However it is expected, in the near future, that
2073 the remaining front ends would be able to digest them correctly.
2074
2075 @table @gcctabopt
2076 @item -fmessage-length=@var{n}
2077 @opindex fmessage-length
2078 Try to format error messages so that they fit on lines of about @var{n}
2079 characters. The default is 72 characters for @command{g++} and 0 for the rest of
2080 the front ends supported by GCC@. If @var{n} is zero, then no
2081 line-wrapping will be done; each error message will appear on a single
2082 line.
2083
2084 @opindex fdiagnostics-show-location
2085 @item -fdiagnostics-show-location=once
2086 Only meaningful in line-wrapping mode. Instructs the diagnostic messages
2087 reporter to emit @emph{once} source location information; that is, in
2088 case the message is too long to fit on a single physical line and has to
2089 be wrapped, the source location won't be emitted (as prefix) again,
2090 over and over, in subsequent continuation lines. This is the default
2091 behavior.
2092
2093 @item -fdiagnostics-show-location=every-line
2094 Only meaningful in line-wrapping mode. Instructs the diagnostic
2095 messages reporter to emit the same source location information (as
2096 prefix) for physical lines that result from the process of breaking
2097 a message which is too long to fit on a single line.
2098
2099 @item -fdiagnostics-show-options
2100 @opindex fdiagnostics-show-options
2101 This option instructs the diagnostic machinery to add text to each
2102 diagnostic emitted, which indicates which command line option directly
2103 controls that diagnostic, when such an option is known to the
2104 diagnostic machinery.
2105
2106 @end table
2107
2108 @node Warning Options
2109 @section Options to Request or Suppress Warnings
2110 @cindex options to control warnings
2111 @cindex warning messages
2112 @cindex messages, warning
2113 @cindex suppressing warnings
2114
2115 Warnings are diagnostic messages that report constructions which
2116 are not inherently erroneous but which are risky or suggest there
2117 may have been an error.
2118
2119 You can request many specific warnings with options beginning @samp{-W},
2120 for example @option{-Wimplicit} to request warnings on implicit
2121 declarations. Each of these specific warning options also has a
2122 negative form beginning @samp{-Wno-} to turn off warnings;
2123 for example, @option{-Wno-implicit}. This manual lists only one of the
2124 two forms, whichever is not the default.
2125
2126 The following options control the amount and kinds of warnings produced
2127 by GCC; for further, language-specific options also refer to
2128 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2129 Options}.
2130
2131 @table @gcctabopt
2132 @cindex syntax checking
2133 @item -fsyntax-only
2134 @opindex fsyntax-only
2135 Check the code for syntax errors, but don't do anything beyond that.
2136
2137 @item -pedantic
2138 @opindex pedantic
2139 Issue all the warnings demanded by strict ISO C and ISO C++;
2140 reject all programs that use forbidden extensions, and some other
2141 programs that do not follow ISO C and ISO C++. For ISO C, follows the
2142 version of the ISO C standard specified by any @option{-std} option used.
2143
2144 Valid ISO C and ISO C++ programs should compile properly with or without
2145 this option (though a rare few will require @option{-ansi} or a
2146 @option{-std} option specifying the required version of ISO C)@. However,
2147 without this option, certain GNU extensions and traditional C and C++
2148 features are supported as well. With this option, they are rejected.
2149
2150 @option{-pedantic} does not cause warning messages for use of the
2151 alternate keywords whose names begin and end with @samp{__}. Pedantic
2152 warnings are also disabled in the expression that follows
2153 @code{__extension__}. However, only system header files should use
2154 these escape routes; application programs should avoid them.
2155 @xref{Alternate Keywords}.
2156
2157 Some users try to use @option{-pedantic} to check programs for strict ISO
2158 C conformance. They soon find that it does not do quite what they want:
2159 it finds some non-ISO practices, but not all---only those for which
2160 ISO C @emph{requires} a diagnostic, and some others for which
2161 diagnostics have been added.
2162
2163 A feature to report any failure to conform to ISO C might be useful in
2164 some instances, but would require considerable additional work and would
2165 be quite different from @option{-pedantic}. We don't have plans to
2166 support such a feature in the near future.
2167
2168 Where the standard specified with @option{-std} represents a GNU
2169 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2170 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2171 extended dialect is based. Warnings from @option{-pedantic} are given
2172 where they are required by the base standard. (It would not make sense
2173 for such warnings to be given only for features not in the specified GNU
2174 C dialect, since by definition the GNU dialects of C include all
2175 features the compiler supports with the given option, and there would be
2176 nothing to warn about.)
2177
2178 @item -pedantic-errors
2179 @opindex pedantic-errors
2180 Like @option{-pedantic}, except that errors are produced rather than
2181 warnings.
2182
2183 @item -w
2184 @opindex w
2185 Inhibit all warning messages.
2186
2187 @item -Wno-import
2188 @opindex Wno-import
2189 Inhibit warning messages about the use of @samp{#import}.
2190
2191 @item -Wchar-subscripts
2192 @opindex Wchar-subscripts
2193 Warn if an array subscript has type @code{char}. This is a common cause
2194 of error, as programmers often forget that this type is signed on some
2195 machines.
2196 This warning is enabled by @option{-Wall}.
2197
2198 @item -Wcomment
2199 @opindex Wcomment
2200 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2201 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2202 This warning is enabled by @option{-Wall}.
2203
2204 @item -Wfatal-errors
2205 @opindex Wfatal-errors
2206 This option causes the compiler to abort compilation on the first error
2207 occurred rather than trying to keep going and printing further error
2208 messages.
2209
2210 @item -Wformat
2211 @opindex Wformat
2212 @opindex ffreestanding
2213 @opindex fno-builtin
2214 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2215 the arguments supplied have types appropriate to the format string
2216 specified, and that the conversions specified in the format string make
2217 sense. This includes standard functions, and others specified by format
2218 attributes (@pxref{Function Attributes}), in the @code{printf},
2219 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2220 not in the C standard) families (or other target-specific families).
2221 Which functions are checked without format attributes having been
2222 specified depends on the standard version selected, and such checks of
2223 functions without the attribute specified are disabled by
2224 @option{-ffreestanding} or @option{-fno-builtin}.
2225
2226 The formats are checked against the format features supported by GNU
2227 libc version 2.2. These include all ISO C90 and C99 features, as well
2228 as features from the Single Unix Specification and some BSD and GNU
2229 extensions. Other library implementations may not support all these
2230 features; GCC does not support warning about features that go beyond a
2231 particular library's limitations. However, if @option{-pedantic} is used
2232 with @option{-Wformat}, warnings will be given about format features not
2233 in the selected standard version (but not for @code{strfmon} formats,
2234 since those are not in any version of the C standard). @xref{C Dialect
2235 Options,,Options Controlling C Dialect}.
2236
2237 Since @option{-Wformat} also checks for null format arguments for
2238 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2239
2240 @option{-Wformat} is included in @option{-Wall}. For more control over some
2241 aspects of format checking, the options @option{-Wformat-y2k},
2242 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2243 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2244 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2245
2246 @item -Wformat-y2k
2247 @opindex Wformat-y2k
2248 If @option{-Wformat} is specified, also warn about @code{strftime}
2249 formats which may yield only a two-digit year.
2250
2251 @item -Wno-format-extra-args
2252 @opindex Wno-format-extra-args
2253 If @option{-Wformat} is specified, do not warn about excess arguments to a
2254 @code{printf} or @code{scanf} format function. The C standard specifies
2255 that such arguments are ignored.
2256
2257 Where the unused arguments lie between used arguments that are
2258 specified with @samp{$} operand number specifications, normally
2259 warnings are still given, since the implementation could not know what
2260 type to pass to @code{va_arg} to skip the unused arguments. However,
2261 in the case of @code{scanf} formats, this option will suppress the
2262 warning if the unused arguments are all pointers, since the Single
2263 Unix Specification says that such unused arguments are allowed.
2264
2265 @item -Wno-format-zero-length
2266 @opindex Wno-format-zero-length
2267 If @option{-Wformat} is specified, do not warn about zero-length formats.
2268 The C standard specifies that zero-length formats are allowed.
2269
2270 @item -Wformat-nonliteral
2271 @opindex Wformat-nonliteral
2272 If @option{-Wformat} is specified, also warn if the format string is not a
2273 string literal and so cannot be checked, unless the format function
2274 takes its format arguments as a @code{va_list}.
2275
2276 @item -Wformat-security
2277 @opindex Wformat-security
2278 If @option{-Wformat} is specified, also warn about uses of format
2279 functions that represent possible security problems. At present, this
2280 warns about calls to @code{printf} and @code{scanf} functions where the
2281 format string is not a string literal and there are no format arguments,
2282 as in @code{printf (foo);}. This may be a security hole if the format
2283 string came from untrusted input and contains @samp{%n}. (This is
2284 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2285 in future warnings may be added to @option{-Wformat-security} that are not
2286 included in @option{-Wformat-nonliteral}.)
2287
2288 @item -Wformat=2
2289 @opindex Wformat=2
2290 Enable @option{-Wformat} plus format checks not included in
2291 @option{-Wformat}. Currently equivalent to @samp{-Wformat
2292 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2293
2294 @item -Wnonnull
2295 @opindex Wnonnull
2296 Warn about passing a null pointer for arguments marked as
2297 requiring a non-null value by the @code{nonnull} function attribute.
2298
2299 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}. It
2300 can be disabled with the @option{-Wno-nonnull} option.
2301
2302 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2303 @opindex Winit-self
2304 Warn about uninitialized variables which are initialized with themselves.
2305 Note this option can only be used with the @option{-Wuninitialized} option,
2306 which in turn only works with @option{-O1} and above.
2307
2308 For example, GCC will warn about @code{i} being uninitialized in the
2309 following snippet only when @option{-Winit-self} has been specified:
2310 @smallexample
2311 @group
2312 int f()
2313 @{
2314 int i = i;
2315 return i;
2316 @}
2317 @end group
2318 @end smallexample
2319
2320 @item -Wimplicit-int
2321 @opindex Wimplicit-int
2322 Warn when a declaration does not specify a type.
2323 This warning is enabled by @option{-Wall}.
2324
2325 @item -Wimplicit-function-declaration
2326 @itemx -Werror-implicit-function-declaration
2327 @opindex Wimplicit-function-declaration
2328 @opindex Werror-implicit-function-declaration
2329 Give a warning (or error) whenever a function is used before being
2330 declared. The form @option{-Wno-error-implicit-function-declaration}
2331 is not supported.
2332 This warning is enabled by @option{-Wall} (as a warning, not an error).
2333
2334 @item -Wimplicit
2335 @opindex Wimplicit
2336 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2337 This warning is enabled by @option{-Wall}.
2338
2339 @item -Wmain
2340 @opindex Wmain
2341 Warn if the type of @samp{main} is suspicious. @samp{main} should be a
2342 function with external linkage, returning int, taking either zero
2343 arguments, two, or three arguments of appropriate types.
2344 This warning is enabled by @option{-Wall}.
2345
2346 @item -Wmissing-braces
2347 @opindex Wmissing-braces
2348 Warn if an aggregate or union initializer is not fully bracketed. In
2349 the following example, the initializer for @samp{a} is not fully
2350 bracketed, but that for @samp{b} is fully bracketed.
2351
2352 @smallexample
2353 int a[2][2] = @{ 0, 1, 2, 3 @};
2354 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2355 @end smallexample
2356
2357 This warning is enabled by @option{-Wall}.
2358
2359 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2360 @opindex Wmissing-include-dirs
2361 Warn if a user-supplied include directory does not exist.
2362
2363 @item -Wparentheses
2364 @opindex Wparentheses
2365 Warn if parentheses are omitted in certain contexts, such
2366 as when there is an assignment in a context where a truth value
2367 is expected, or when operators are nested whose precedence people
2368 often get confused about. Only the warning for an assignment used as
2369 a truth value is supported when compiling C++; the other warnings are
2370 only supported when compiling C@.
2371
2372 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2373 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2374 interpretation from that of ordinary mathematical notation.
2375
2376 Also warn about constructions where there may be confusion to which
2377 @code{if} statement an @code{else} branch belongs. Here is an example of
2378 such a case:
2379
2380 @smallexample
2381 @group
2382 @{
2383 if (a)
2384 if (b)
2385 foo ();
2386 else
2387 bar ();
2388 @}
2389 @end group
2390 @end smallexample
2391
2392 In C, every @code{else} branch belongs to the innermost possible @code{if}
2393 statement, which in this example is @code{if (b)}. This is often not
2394 what the programmer expected, as illustrated in the above example by
2395 indentation the programmer chose. When there is the potential for this
2396 confusion, GCC will issue a warning when this flag is specified.
2397 To eliminate the warning, add explicit braces around the innermost
2398 @code{if} statement so there is no way the @code{else} could belong to
2399 the enclosing @code{if}. The resulting code would look like this:
2400
2401 @smallexample
2402 @group
2403 @{
2404 if (a)
2405 @{
2406 if (b)
2407 foo ();
2408 else
2409 bar ();
2410 @}
2411 @}
2412 @end group
2413 @end smallexample
2414
2415 This warning is enabled by @option{-Wall}.
2416
2417 @item -Wsequence-point
2418 @opindex Wsequence-point
2419 Warn about code that may have undefined semantics because of violations
2420 of sequence point rules in the C standard.
2421
2422 The C standard defines the order in which expressions in a C program are
2423 evaluated in terms of @dfn{sequence points}, which represent a partial
2424 ordering between the execution of parts of the program: those executed
2425 before the sequence point, and those executed after it. These occur
2426 after the evaluation of a full expression (one which is not part of a
2427 larger expression), after the evaluation of the first operand of a
2428 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2429 function is called (but after the evaluation of its arguments and the
2430 expression denoting the called function), and in certain other places.
2431 Other than as expressed by the sequence point rules, the order of
2432 evaluation of subexpressions of an expression is not specified. All
2433 these rules describe only a partial order rather than a total order,
2434 since, for example, if two functions are called within one expression
2435 with no sequence point between them, the order in which the functions
2436 are called is not specified. However, the standards committee have
2437 ruled that function calls do not overlap.
2438
2439 It is not specified when between sequence points modifications to the
2440 values of objects take effect. Programs whose behavior depends on this
2441 have undefined behavior; the C standard specifies that ``Between the
2442 previous and next sequence point an object shall have its stored value
2443 modified at most once by the evaluation of an expression. Furthermore,
2444 the prior value shall be read only to determine the value to be
2445 stored.''. If a program breaks these rules, the results on any
2446 particular implementation are entirely unpredictable.
2447
2448 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2449 = b[n++]} and @code{a[i++] = i;}. Some more complicated cases are not
2450 diagnosed by this option, and it may give an occasional false positive
2451 result, but in general it has been found fairly effective at detecting
2452 this sort of problem in programs.
2453
2454 The present implementation of this option only works for C programs. A
2455 future implementation may also work for C++ programs.
2456
2457 The C standard is worded confusingly, therefore there is some debate
2458 over the precise meaning of the sequence point rules in subtle cases.
2459 Links to discussions of the problem, including proposed formal
2460 definitions, may be found on the GCC readings page, at
2461 @w{@uref{http://gcc.gnu.org/readings.html}}.
2462
2463 This warning is enabled by @option{-Wall}.
2464
2465 @item -Wreturn-type
2466 @opindex Wreturn-type
2467 Warn whenever a function is defined with a return-type that defaults to
2468 @code{int}. Also warn about any @code{return} statement with no
2469 return-value in a function whose return-type is not @code{void}.
2470
2471 For C, also warn if the return type of a function has a type qualifier
2472 such as @code{const}. Such a type qualifier has no effect, since the
2473 value returned by a function is not an lvalue. ISO C prohibits
2474 qualified @code{void} return types on function definitions, so such
2475 return types always receive a warning even without this option.
2476
2477 For C++, a function without return type always produces a diagnostic
2478 message, even when @option{-Wno-return-type} is specified. The only
2479 exceptions are @samp{main} and functions defined in system headers.
2480
2481 This warning is enabled by @option{-Wall}.
2482
2483 @item -Wswitch
2484 @opindex Wswitch
2485 Warn whenever a @code{switch} statement has an index of enumerated type
2486 and lacks a @code{case} for one or more of the named codes of that
2487 enumeration. (The presence of a @code{default} label prevents this
2488 warning.) @code{case} labels outside the enumeration range also
2489 provoke warnings when this option is used.
2490 This warning is enabled by @option{-Wall}.
2491
2492 @item -Wswitch-default
2493 @opindex Wswitch-switch
2494 Warn whenever a @code{switch} statement does not have a @code{default}
2495 case.
2496
2497 @item -Wswitch-enum
2498 @opindex Wswitch-enum
2499 Warn whenever a @code{switch} statement has an index of enumerated type
2500 and lacks a @code{case} for one or more of the named codes of that
2501 enumeration. @code{case} labels outside the enumeration range also
2502 provoke warnings when this option is used.
2503
2504 @item -Wtrigraphs
2505 @opindex Wtrigraphs
2506 Warn if any trigraphs are encountered that might change the meaning of
2507 the program (trigraphs within comments are not warned about).
2508 This warning is enabled by @option{-Wall}.
2509
2510 @item -Wunused-function
2511 @opindex Wunused-function
2512 Warn whenever a static function is declared but not defined or a
2513 non\-inline static function is unused.
2514 This warning is enabled by @option{-Wall}.
2515
2516 @item -Wunused-label
2517 @opindex Wunused-label
2518 Warn whenever a label is declared but not used.
2519 This warning is enabled by @option{-Wall}.
2520
2521 To suppress this warning use the @samp{unused} attribute
2522 (@pxref{Variable Attributes}).
2523
2524 @item -Wunused-parameter
2525 @opindex Wunused-parameter
2526 Warn whenever a function parameter is unused aside from its declaration.
2527
2528 To suppress this warning use the @samp{unused} attribute
2529 (@pxref{Variable Attributes}).
2530
2531 @item -Wunused-variable
2532 @opindex Wunused-variable
2533 Warn whenever a local variable or non-constant static variable is unused
2534 aside from its declaration
2535 This warning is enabled by @option{-Wall}.
2536
2537 To suppress this warning use the @samp{unused} attribute
2538 (@pxref{Variable Attributes}).
2539
2540 @item -Wunused-value
2541 @opindex Wunused-value
2542 Warn whenever a statement computes a result that is explicitly not used.
2543 This warning is enabled by @option{-Wall}.
2544
2545 To suppress this warning cast the expression to @samp{void}.
2546
2547 @item -Wunused
2548 @opindex Wunused
2549 All the above @option{-Wunused} options combined.
2550
2551 In order to get a warning about an unused function parameter, you must
2552 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2553 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2554
2555 @item -Wuninitialized
2556 @opindex Wuninitialized
2557 Warn if an automatic variable is used without first being initialized or
2558 if a variable may be clobbered by a @code{setjmp} call.
2559
2560 These warnings are possible only in optimizing compilation,
2561 because they require data flow information that is computed only
2562 when optimizing. If you don't specify @option{-O}, you simply won't
2563 get these warnings.
2564
2565 If you want to warn about code which uses the uninitialized value of the
2566 variable in its own initializer, use the @option{-Winit-self} option.
2567
2568 These warnings occur for individual uninitialized or clobbered
2569 elements of structure, union or array variables as well as for
2570 variables which are uninitialized or clobbered as a whole. They do
2571 not occur for variables or elements declared @code{volatile}. Because
2572 these warnings depend on optimization, the exact variables or elements
2573 for which there are warnings will depend on the precise optimization
2574 options and version of GCC used.
2575
2576 Note that there may be no warning about a variable that is used only
2577 to compute a value that itself is never used, because such
2578 computations may be deleted by data flow analysis before the warnings
2579 are printed.
2580
2581 These warnings are made optional because GCC is not smart
2582 enough to see all the reasons why the code might be correct
2583 despite appearing to have an error. Here is one example of how
2584 this can happen:
2585
2586 @smallexample
2587 @group
2588 @{
2589 int x;
2590 switch (y)
2591 @{
2592 case 1: x = 1;
2593 break;
2594 case 2: x = 4;
2595 break;
2596 case 3: x = 5;
2597 @}
2598 foo (x);
2599 @}
2600 @end group
2601 @end smallexample
2602
2603 @noindent
2604 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2605 always initialized, but GCC doesn't know this. Here is
2606 another common case:
2607
2608 @smallexample
2609 @{
2610 int save_y;
2611 if (change_y) save_y = y, y = new_y;
2612 @dots{}
2613 if (change_y) y = save_y;
2614 @}
2615 @end smallexample
2616
2617 @noindent
2618 This has no bug because @code{save_y} is used only if it is set.
2619
2620 @cindex @code{longjmp} warnings
2621 This option also warns when a non-volatile automatic variable might be
2622 changed by a call to @code{longjmp}. These warnings as well are possible
2623 only in optimizing compilation.
2624
2625 The compiler sees only the calls to @code{setjmp}. It cannot know
2626 where @code{longjmp} will be called; in fact, a signal handler could
2627 call it at any point in the code. As a result, you may get a warning
2628 even when there is in fact no problem because @code{longjmp} cannot
2629 in fact be called at the place which would cause a problem.
2630
2631 Some spurious warnings can be avoided if you declare all the functions
2632 you use that never return as @code{noreturn}. @xref{Function
2633 Attributes}.
2634
2635 This warning is enabled by @option{-Wall}.
2636
2637 @item -Wunknown-pragmas
2638 @opindex Wunknown-pragmas
2639 @cindex warning for unknown pragmas
2640 @cindex unknown pragmas, warning
2641 @cindex pragmas, warning of unknown
2642 Warn when a #pragma directive is encountered which is not understood by
2643 GCC@. If this command line option is used, warnings will even be issued
2644 for unknown pragmas in system header files. This is not the case if
2645 the warnings were only enabled by the @option{-Wall} command line option.
2646
2647 @item -Wstrict-aliasing
2648 @opindex Wstrict-aliasing
2649 This option is only active when @option{-fstrict-aliasing} is active.
2650 It warns about code which might break the strict aliasing rules that the
2651 compiler is using for optimization. The warning does not catch all
2652 cases, but does attempt to catch the more common pitfalls. It is
2653 included in @option{-Wall}.
2654
2655 @item -Wstrict-aliasing=2
2656 @opindex Wstrict-aliasing=2
2657 This option is only active when @option{-fstrict-aliasing} is active.
2658 It warns about all code which might break the strict aliasing rules that the
2659 compiler is using for optimization. This warning catches all cases, but
2660 it will also give a warning for some ambiguous cases that are safe.
2661
2662 @item -Wall
2663 @opindex Wall
2664 All of the above @samp{-W} options combined. This enables all the
2665 warnings about constructions that some users consider questionable, and
2666 that are easy to avoid (or modify to prevent the warning), even in
2667 conjunction with macros. This also enables some language-specific
2668 warnings described in @ref{C++ Dialect Options} and
2669 @ref{Objective-C and Objective-C++ Dialect Options}.
2670 @end table
2671
2672 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2673 Some of them warn about constructions that users generally do not
2674 consider questionable, but which occasionally you might wish to check
2675 for; others warn about constructions that are necessary or hard to avoid
2676 in some cases, and there is no simple way to modify the code to suppress
2677 the warning.
2678
2679 @table @gcctabopt
2680 @item -Wextra
2681 @opindex W
2682 @opindex Wextra
2683 (This option used to be called @option{-W}. The older name is still
2684 supported, but the newer name is more descriptive.) Print extra warning
2685 messages for these events:
2686
2687 @itemize @bullet
2688 @item
2689 A function can return either with or without a value. (Falling
2690 off the end of the function body is considered returning without
2691 a value.) For example, this function would evoke such a
2692 warning:
2693
2694 @smallexample
2695 @group
2696 foo (a)
2697 @{
2698 if (a > 0)
2699 return a;
2700 @}
2701 @end group
2702 @end smallexample
2703
2704 @item
2705 An expression-statement or the left-hand side of a comma expression
2706 contains no side effects.
2707 To suppress the warning, cast the unused expression to void.
2708 For example, an expression such as @samp{x[i,j]} will cause a warning,
2709 but @samp{x[(void)i,j]} will not.
2710
2711 @item
2712 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2713
2714 @item
2715 Storage-class specifiers like @code{static} are not the first things in
2716 a declaration. According to the C Standard, this usage is obsolescent.
2717
2718 @item
2719 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2720 arguments.
2721
2722 @item
2723 A comparison between signed and unsigned values could produce an
2724 incorrect result when the signed value is converted to unsigned.
2725 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2726
2727 @item
2728 An aggregate has an initializer which does not initialize all members.
2729 This warning can be independently controlled by
2730 @option{-Wmissing-field-initializers}.
2731
2732 @item
2733 A function parameter is declared without a type specifier in K&R-style
2734 functions:
2735
2736 @smallexample
2737 void foo(bar) @{ @}
2738 @end smallexample
2739
2740 @item
2741 An empty body occurs in an @samp{if} or @samp{else} statement.
2742
2743 @item
2744 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2745 @samp{>}, or @samp{>=}.
2746
2747 @item
2748 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2749
2750 @item
2751 Any of several floating-point events that often indicate errors, such as
2752 overflow, underflow, loss of precision, etc.
2753
2754 @item @r{(C++ only)}
2755 An enumerator and a non-enumerator both appear in a conditional expression.
2756
2757 @item @r{(C++ only)}
2758 A non-static reference or non-static @samp{const} member appears in a
2759 class without constructors.
2760
2761 @item @r{(C++ only)}
2762 Ambiguous virtual bases.
2763
2764 @item @r{(C++ only)}
2765 Subscripting an array which has been declared @samp{register}.
2766
2767 @item @r{(C++ only)}
2768 Taking the address of a variable which has been declared @samp{register}.
2769
2770 @item @r{(C++ only)}
2771 A base class is not initialized in a derived class' copy constructor.
2772 @end itemize
2773
2774 @item -Wno-div-by-zero
2775 @opindex Wno-div-by-zero
2776 @opindex Wdiv-by-zero
2777 Do not warn about compile-time integer division by zero. Floating point
2778 division by zero is not warned about, as it can be a legitimate way of
2779 obtaining infinities and NaNs.
2780
2781 @item -Wsystem-headers
2782 @opindex Wsystem-headers
2783 @cindex warnings from system headers
2784 @cindex system headers, warnings from
2785 Print warning messages for constructs found in system header files.
2786 Warnings from system headers are normally suppressed, on the assumption
2787 that they usually do not indicate real problems and would only make the
2788 compiler output harder to read. Using this command line option tells
2789 GCC to emit warnings from system headers as if they occurred in user
2790 code. However, note that using @option{-Wall} in conjunction with this
2791 option will @emph{not} warn about unknown pragmas in system
2792 headers---for that, @option{-Wunknown-pragmas} must also be used.
2793
2794 @item -Wfloat-equal
2795 @opindex Wfloat-equal
2796 Warn if floating point values are used in equality comparisons.
2797
2798 The idea behind this is that sometimes it is convenient (for the
2799 programmer) to consider floating-point values as approximations to
2800 infinitely precise real numbers. If you are doing this, then you need
2801 to compute (by analyzing the code, or in some other way) the maximum or
2802 likely maximum error that the computation introduces, and allow for it
2803 when performing comparisons (and when producing output, but that's a
2804 different problem). In particular, instead of testing for equality, you
2805 would check to see whether the two values have ranges that overlap; and
2806 this is done with the relational operators, so equality comparisons are
2807 probably mistaken.
2808
2809 @item -Wtraditional @r{(C only)}
2810 @opindex Wtraditional
2811 Warn about certain constructs that behave differently in traditional and
2812 ISO C@. Also warn about ISO C constructs that have no traditional C
2813 equivalent, and/or problematic constructs which should be avoided.
2814
2815 @itemize @bullet
2816 @item
2817 Macro parameters that appear within string literals in the macro body.
2818 In traditional C macro replacement takes place within string literals,
2819 but does not in ISO C@.
2820
2821 @item
2822 In traditional C, some preprocessor directives did not exist.
2823 Traditional preprocessors would only consider a line to be a directive
2824 if the @samp{#} appeared in column 1 on the line. Therefore
2825 @option{-Wtraditional} warns about directives that traditional C
2826 understands but would ignore because the @samp{#} does not appear as the
2827 first character on the line. It also suggests you hide directives like
2828 @samp{#pragma} not understood by traditional C by indenting them. Some
2829 traditional implementations would not recognize @samp{#elif}, so it
2830 suggests avoiding it altogether.
2831
2832 @item
2833 A function-like macro that appears without arguments.
2834
2835 @item
2836 The unary plus operator.
2837
2838 @item
2839 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2840 constant suffixes. (Traditional C does support the @samp{L} suffix on integer
2841 constants.) Note, these suffixes appear in macros defined in the system
2842 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2843 Use of these macros in user code might normally lead to spurious
2844 warnings, however GCC's integrated preprocessor has enough context to
2845 avoid warning in these cases.
2846
2847 @item
2848 A function declared external in one block and then used after the end of
2849 the block.
2850
2851 @item
2852 A @code{switch} statement has an operand of type @code{long}.
2853
2854 @item
2855 A non-@code{static} function declaration follows a @code{static} one.
2856 This construct is not accepted by some traditional C compilers.
2857
2858 @item
2859 The ISO type of an integer constant has a different width or
2860 signedness from its traditional type. This warning is only issued if
2861 the base of the constant is ten. I.e.@: hexadecimal or octal values, which
2862 typically represent bit patterns, are not warned about.
2863
2864 @item
2865 Usage of ISO string concatenation is detected.
2866
2867 @item
2868 Initialization of automatic aggregates.
2869
2870 @item
2871 Identifier conflicts with labels. Traditional C lacks a separate
2872 namespace for labels.
2873
2874 @item
2875 Initialization of unions. If the initializer is zero, the warning is
2876 omitted. This is done under the assumption that the zero initializer in
2877 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2878 initializer warnings and relies on default initialization to zero in the
2879 traditional C case.
2880
2881 @item
2882 Conversions by prototypes between fixed/floating point values and vice
2883 versa. The absence of these prototypes when compiling with traditional
2884 C would cause serious problems. This is a subset of the possible
2885 conversion warnings, for the full set use @option{-Wconversion}.
2886
2887 @item
2888 Use of ISO C style function definitions. This warning intentionally is
2889 @emph{not} issued for prototype declarations or variadic functions
2890 because these ISO C features will appear in your code when using
2891 libiberty's traditional C compatibility macros, @code{PARAMS} and
2892 @code{VPARAMS}. This warning is also bypassed for nested functions
2893 because that feature is already a GCC extension and thus not relevant to
2894 traditional C compatibility.
2895 @end itemize
2896
2897 @item -Wdeclaration-after-statement @r{(C only)}
2898 @opindex Wdeclaration-after-statement
2899 Warn when a declaration is found after a statement in a block. This
2900 construct, known from C++, was introduced with ISO C99 and is by default
2901 allowed in GCC@. It is not supported by ISO C90 and was not supported by
2902 GCC versions before GCC 3.0. @xref{Mixed Declarations}.
2903
2904 @item -Wundef
2905 @opindex Wundef
2906 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2907
2908 @item -Wno-endif-labels
2909 @opindex Wno-endif-labels
2910 @opindex Wendif-labels
2911 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2912
2913 @item -Wshadow
2914 @opindex Wshadow
2915 Warn whenever a local variable shadows another local variable, parameter or
2916 global variable or whenever a built-in function is shadowed.
2917
2918 @item -Wlarger-than-@var{len}
2919 @opindex Wlarger-than
2920 Warn whenever an object of larger than @var{len} bytes is defined.
2921
2922 @item -Wpointer-arith
2923 @opindex Wpointer-arith
2924 Warn about anything that depends on the ``size of'' a function type or
2925 of @code{void}. GNU C assigns these types a size of 1, for
2926 convenience in calculations with @code{void *} pointers and pointers
2927 to functions.
2928
2929 @item -Wbad-function-cast @r{(C only)}
2930 @opindex Wbad-function-cast
2931 Warn whenever a function call is cast to a non-matching type.
2932 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2933
2934 @item -Wcast-qual
2935 @opindex Wcast-qual
2936 Warn whenever a pointer is cast so as to remove a type qualifier from
2937 the target type. For example, warn if a @code{const char *} is cast
2938 to an ordinary @code{char *}.
2939
2940 @item -Wcast-align
2941 @opindex Wcast-align
2942 Warn whenever a pointer is cast such that the required alignment of the
2943 target is increased. For example, warn if a @code{char *} is cast to
2944 an @code{int *} on machines where integers can only be accessed at
2945 two- or four-byte boundaries.
2946
2947 @item -Wwrite-strings
2948 @opindex Wwrite-strings
2949 When compiling C, give string constants the type @code{const
2950 char[@var{length}]} so that
2951 copying the address of one into a non-@code{const} @code{char *}
2952 pointer will get a warning; when compiling C++, warn about the
2953 deprecated conversion from string constants to @code{char *}.
2954 These warnings will help you find at
2955 compile time code that can try to write into a string constant, but
2956 only if you have been very careful about using @code{const} in
2957 declarations and prototypes. Otherwise, it will just be a nuisance;
2958 this is why we did not make @option{-Wall} request these warnings.
2959
2960 @item -Wconversion
2961 @opindex Wconversion
2962 Warn if a prototype causes a type conversion that is different from what
2963 would happen to the same argument in the absence of a prototype. This
2964 includes conversions of fixed point to floating and vice versa, and
2965 conversions changing the width or signedness of a fixed point argument
2966 except when the same as the default promotion.
2967
2968 Also, warn if a negative integer constant expression is implicitly
2969 converted to an unsigned type. For example, warn about the assignment
2970 @code{x = -1} if @code{x} is unsigned. But do not warn about explicit
2971 casts like @code{(unsigned) -1}.
2972
2973 @item -Wsign-compare
2974 @opindex Wsign-compare
2975 @cindex warning for comparison of signed and unsigned values
2976 @cindex comparison of signed and unsigned values, warning
2977 @cindex signed and unsigned values, comparison warning
2978 Warn when a comparison between signed and unsigned values could produce
2979 an incorrect result when the signed value is converted to unsigned.
2980 This warning is also enabled by @option{-Wextra}; to get the other warnings
2981 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2982
2983 @item -Waggregate-return
2984 @opindex Waggregate-return
2985 Warn if any functions that return structures or unions are defined or
2986 called. (In languages where you can return an array, this also elicits
2987 a warning.)
2988
2989 @item -Wstrict-prototypes @r{(C only)}
2990 @opindex Wstrict-prototypes
2991 Warn if a function is declared or defined without specifying the
2992 argument types. (An old-style function definition is permitted without
2993 a warning if preceded by a declaration which specifies the argument
2994 types.)
2995
2996 @item -Wold-style-definition @r{(C only)}
2997 @opindex Wold-style-definition
2998 Warn if an old-style function definition is used. A warning is given
2999 even if there is a previous prototype.
3000
3001 @item -Wmissing-prototypes @r{(C only)}
3002 @opindex Wmissing-prototypes
3003 Warn if a global function is defined without a previous prototype
3004 declaration. This warning is issued even if the definition itself
3005 provides a prototype. The aim is to detect global functions that fail
3006 to be declared in header files.
3007
3008 @item -Wmissing-declarations @r{(C only)}
3009 @opindex Wmissing-declarations
3010 Warn if a global function is defined without a previous declaration.
3011 Do so even if the definition itself provides a prototype.
3012 Use this option to detect global functions that are not declared in
3013 header files.
3014
3015 @item -Wmissing-field-initializers
3016 @opindex Wmissing-field-initializers
3017 @opindex W
3018 @opindex Wextra
3019 Warn if a structure's initializer has some fields missing. For
3020 example, the following code would cause such a warning, because
3021 @code{x.h} is implicitly zero:
3022
3023 @smallexample
3024 struct s @{ int f, g, h; @};
3025 struct s x = @{ 3, 4 @};
3026 @end smallexample
3027
3028 This option does not warn about designated initializers, so the following
3029 modification would not trigger a warning:
3030
3031 @smallexample
3032 struct s @{ int f, g, h; @};
3033 struct s x = @{ .f = 3, .g = 4 @};
3034 @end smallexample
3035
3036 This warning is included in @option{-Wextra}. To get other @option{-Wextra}
3037 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3038
3039 @item -Wmissing-noreturn
3040 @opindex Wmissing-noreturn
3041 Warn about functions which might be candidates for attribute @code{noreturn}.
3042 Note these are only possible candidates, not absolute ones. Care should
3043 be taken to manually verify functions actually do not ever return before
3044 adding the @code{noreturn} attribute, otherwise subtle code generation
3045 bugs could be introduced. You will not get a warning for @code{main} in
3046 hosted C environments.
3047
3048 @item -Wmissing-format-attribute
3049 @opindex Wmissing-format-attribute
3050 @opindex Wformat
3051 If @option{-Wformat} is enabled, also warn about functions which might be
3052 candidates for @code{format} attributes. Note these are only possible
3053 candidates, not absolute ones. GCC will guess that @code{format}
3054 attributes might be appropriate for any function that calls a function
3055 like @code{vprintf} or @code{vscanf}, but this might not always be the
3056 case, and some functions for which @code{format} attributes are
3057 appropriate may not be detected. This option has no effect unless
3058 @option{-Wformat} is enabled (possibly by @option{-Wall}).
3059
3060 @item -Wno-multichar
3061 @opindex Wno-multichar
3062 @opindex Wmultichar
3063 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3064 Usually they indicate a typo in the user's code, as they have
3065 implementation-defined values, and should not be used in portable code.
3066
3067 @item -Wnormalized=<none|id|nfc|nfkc>
3068 @opindex Wnormalized
3069 @cindex NFC
3070 @cindex NFKC
3071 @cindex character set, input normalization
3072 In ISO C and ISO C++, two identifiers are different if they are
3073 different sequences of characters. However, sometimes when characters
3074 outside the basic ASCII character set are used, you can have two
3075 different character sequences that look the same. To avoid confusion,
3076 the ISO 10646 standard sets out some @dfn{normalization rules} which
3077 when applied ensure that two sequences that look the same are turned into
3078 the same sequence. GCC can warn you if you are using identifiers which
3079 have not been normalized; this option controls that warning.
3080
3081 There are four levels of warning that GCC supports. The default is
3082 @option{-Wnormalized=nfc}, which warns about any identifier which is
3083 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}. NFC is the
3084 recommended form for most uses.
3085
3086 Unfortunately, there are some characters which ISO C and ISO C++ allow
3087 in identifiers that when turned into NFC aren't allowable as
3088 identifiers. That is, there's no way to use these symbols in portable
3089 ISO C or C++ and have all your identifiers in NFC.
3090 @option{-Wnormalized=id} suppresses the warning for these characters.
3091 It is hoped that future versions of the standards involved will correct
3092 this, which is why this option is not the default.
3093
3094 You can switch the warning off for all characters by writing
3095 @option{-Wnormalized=none}. You would only want to do this if you
3096 were using some other normalization scheme (like ``D''), because
3097 otherwise you can easily create bugs that are literally impossible to see.
3098
3099 Some characters in ISO 10646 have distinct meanings but look identical
3100 in some fonts or display methodologies, especially once formatting has
3101 been applied. For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3102 LETTER N'', will display just like a regular @code{n} which has been
3103 placed in a superscript. ISO 10646 defines the @dfn{NFKC}
3104 normalisation scheme to convert all these into a standard form as
3105 well, and GCC will warn if your code is not in NFKC if you use
3106 @option{-Wnormalized=nfkc}. This warning is comparable to warning
3107 about every identifier that contains the letter O because it might be
3108 confused with the digit 0, and so is not the default, but may be
3109 useful as a local coding convention if the programming environment is
3110 unable to be fixed to display these characters distinctly.
3111
3112 @item -Wno-deprecated-declarations
3113 @opindex Wno-deprecated-declarations
3114 Do not warn about uses of functions, variables, and types marked as
3115 deprecated by using the @code{deprecated} attribute.
3116 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3117 @pxref{Type Attributes}.)
3118
3119 @item -Wpacked
3120 @opindex Wpacked
3121 Warn if a structure is given the packed attribute, but the packed
3122 attribute has no effect on the layout or size of the structure.
3123 Such structures may be mis-aligned for little benefit. For
3124 instance, in this code, the variable @code{f.x} in @code{struct bar}
3125 will be misaligned even though @code{struct bar} does not itself
3126 have the packed attribute:
3127
3128 @smallexample
3129 @group
3130 struct foo @{
3131 int x;
3132 char a, b, c, d;
3133 @} __attribute__((packed));
3134 struct bar @{
3135 char z;
3136 struct foo f;
3137 @};
3138 @end group
3139 @end smallexample
3140
3141 @item -Wpadded
3142 @opindex Wpadded
3143 Warn if padding is included in a structure, either to align an element
3144 of the structure or to align the whole structure. Sometimes when this
3145 happens it is possible to rearrange the fields of the structure to
3146 reduce the padding and so make the structure smaller.
3147
3148 @item -Wredundant-decls
3149 @opindex Wredundant-decls
3150 Warn if anything is declared more than once in the same scope, even in
3151 cases where multiple declaration is valid and changes nothing.
3152
3153 @item -Wnested-externs @r{(C only)}
3154 @opindex Wnested-externs
3155 Warn if an @code{extern} declaration is encountered within a function.
3156
3157 @item -Wunreachable-code
3158 @opindex Wunreachable-code
3159 Warn if the compiler detects that code will never be executed.
3160
3161 This option is intended to warn when the compiler detects that at
3162 least a whole line of source code will never be executed, because
3163 some condition is never satisfied or because it is after a
3164 procedure that never returns.
3165
3166 It is possible for this option to produce a warning even though there
3167 are circumstances under which part of the affected line can be executed,
3168 so care should be taken when removing apparently-unreachable code.
3169
3170 For instance, when a function is inlined, a warning may mean that the
3171 line is unreachable in only one inlined copy of the function.
3172
3173 This option is not made part of @option{-Wall} because in a debugging
3174 version of a program there is often substantial code which checks
3175 correct functioning of the program and is, hopefully, unreachable
3176 because the program does work. Another common use of unreachable
3177 code is to provide behavior which is selectable at compile-time.
3178
3179 @item -Winline
3180 @opindex Winline
3181 Warn if a function can not be inlined and it was declared as inline.
3182 Even with this option, the compiler will not warn about failures to
3183 inline functions declared in system headers.
3184
3185 The compiler uses a variety of heuristics to determine whether or not
3186 to inline a function. For example, the compiler takes into account
3187 the size of the function being inlined and the amount of inlining
3188 that has already been done in the current function. Therefore,
3189 seemingly insignificant changes in the source program can cause the
3190 warnings produced by @option{-Winline} to appear or disappear.
3191
3192 @item -Wno-invalid-offsetof @r{(C++ only)}
3193 @opindex Wno-invalid-offsetof
3194 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3195 type. According to the 1998 ISO C++ standard, applying @samp{offsetof}
3196 to a non-POD type is undefined. In existing C++ implementations,
3197 however, @samp{offsetof} typically gives meaningful results even when
3198 applied to certain kinds of non-POD types. (Such as a simple
3199 @samp{struct} that fails to be a POD type only by virtue of having a
3200 constructor.) This flag is for users who are aware that they are
3201 writing nonportable code and who have deliberately chosen to ignore the
3202 warning about it.
3203
3204 The restrictions on @samp{offsetof} may be relaxed in a future version
3205 of the C++ standard.
3206
3207 @item -Wno-int-to-pointer-cast @r{(C only)}
3208 @opindex Wno-int-to-pointer-cast
3209 Suppress warnings from casts to pointer type of an integer of a
3210 different size.
3211
3212 @item -Wno-pointer-to-int-cast @r{(C only)}
3213 @opindex Wno-pointer-to-int-cast
3214 Suppress warnings from casts from a pointer to an integer type of a
3215 different size.
3216
3217 @item -Winvalid-pch
3218 @opindex Winvalid-pch
3219 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3220 the search path but can't be used.
3221
3222 @item -Wlong-long
3223 @opindex Wlong-long
3224 @opindex Wno-long-long
3225 Warn if @samp{long long} type is used. This is default. To inhibit
3226 the warning messages, use @option{-Wno-long-long}. Flags
3227 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3228 only when @option{-pedantic} flag is used.
3229
3230 @item -Wvariadic-macros
3231 @opindex Wvariadic-macros
3232 @opindex Wno-variadic-macros
3233 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3234 alternate syntax when in pedantic ISO C99 mode. This is default.
3235 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3236
3237 @item -Wdisabled-optimization
3238 @opindex Wdisabled-optimization
3239 Warn if a requested optimization pass is disabled. This warning does
3240 not generally indicate that there is anything wrong with your code; it
3241 merely indicates that GCC's optimizers were unable to handle the code
3242 effectively. Often, the problem is that your code is too big or too
3243 complex; GCC will refuse to optimize programs when the optimization
3244 itself is likely to take inordinate amounts of time.
3245
3246 @item -Wno-pointer-sign
3247 @opindex Wno-pointer-sign
3248 Don't warn for pointer argument passing or assignment with different signedness.
3249 Only useful in the negative form since this warning is enabled by default.
3250 This option is only supported for C and Objective-C@.
3251
3252 @item -Werror
3253 @opindex Werror
3254 Make all warnings into errors.
3255 @end table
3256
3257 @node Debugging Options
3258 @section Options for Debugging Your Program or GCC
3259 @cindex options, debugging
3260 @cindex debugging information options
3261
3262 GCC has various special options that are used for debugging
3263 either your program or GCC:
3264
3265 @table @gcctabopt
3266 @item -g
3267 @opindex g
3268 Produce debugging information in the operating system's native format
3269 (stabs, COFF, XCOFF, or DWARF 2)@. GDB can work with this debugging
3270 information.
3271
3272 On most systems that use stabs format, @option{-g} enables use of extra
3273 debugging information that only GDB can use; this extra information
3274 makes debugging work better in GDB but will probably make other debuggers
3275 crash or
3276 refuse to read the program. If you want to control for certain whether
3277 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3278 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3279
3280 GCC allows you to use @option{-g} with
3281 @option{-O}. The shortcuts taken by optimized code may occasionally
3282 produce surprising results: some variables you declared may not exist
3283 at all; flow of control may briefly move where you did not expect it;
3284 some statements may not be executed because they compute constant
3285 results or their values were already at hand; some statements may
3286 execute in different places because they were moved out of loops.
3287
3288 Nevertheless it proves possible to debug optimized output. This makes
3289 it reasonable to use the optimizer for programs that might have bugs.
3290
3291 The following options are useful when GCC is generated with the
3292 capability for more than one debugging format.
3293
3294 @item -ggdb
3295 @opindex ggdb
3296 Produce debugging information for use by GDB@. This means to use the
3297 most expressive format available (DWARF 2, stabs, or the native format
3298 if neither of those are supported), including GDB extensions if at all
3299 possible.
3300
3301 @item -gstabs
3302 @opindex gstabs
3303 Produce debugging information in stabs format (if that is supported),
3304 without GDB extensions. This is the format used by DBX on most BSD
3305 systems. On MIPS, Alpha and System V Release 4 systems this option
3306 produces stabs debugging output which is not understood by DBX or SDB@.
3307 On System V Release 4 systems this option requires the GNU assembler.
3308
3309 @item -feliminate-unused-debug-symbols
3310 @opindex feliminate-unused-debug-symbols
3311 Produce debugging information in stabs format (if that is supported),
3312 for only symbols that are actually used.
3313
3314 @item -gstabs+
3315 @opindex gstabs+
3316 Produce debugging information in stabs format (if that is supported),
3317 using GNU extensions understood only by the GNU debugger (GDB)@. The
3318 use of these extensions is likely to make other debuggers crash or
3319 refuse to read the program.
3320
3321 @item -gcoff
3322 @opindex gcoff
3323 Produce debugging information in COFF format (if that is supported).
3324 This is the format used by SDB on most System V systems prior to
3325 System V Release 4.
3326
3327 @item -gxcoff
3328 @opindex gxcoff
3329 Produce debugging information in XCOFF format (if that is supported).
3330 This is the format used by the DBX debugger on IBM RS/6000 systems.
3331
3332 @item -gxcoff+
3333 @opindex gxcoff+
3334 Produce debugging information in XCOFF format (if that is supported),
3335 using GNU extensions understood only by the GNU debugger (GDB)@. The
3336 use of these extensions is likely to make other debuggers crash or
3337 refuse to read the program, and may cause assemblers other than the GNU
3338 assembler (GAS) to fail with an error.
3339
3340 @item -gdwarf-2
3341 @opindex gdwarf-2
3342 Produce debugging information in DWARF version 2 format (if that is
3343 supported). This is the format used by DBX on IRIX 6. With this
3344 option, GCC uses features of DWARF version 3 when they are useful;
3345 version 3 is upward compatible with version 2, but may still cause
3346 problems for older debuggers.
3347
3348 @item -gvms
3349 @opindex gvms
3350 Produce debugging information in VMS debug format (if that is
3351 supported). This is the format used by DEBUG on VMS systems.
3352
3353 @item -g@var{level}
3354 @itemx -ggdb@var{level}
3355 @itemx -gstabs@var{level}
3356 @itemx -gcoff@var{level}
3357 @itemx -gxcoff@var{level}
3358 @itemx -gvms@var{level}
3359 Request debugging information and also use @var{level} to specify how
3360 much information. The default level is 2.
3361
3362 Level 1 produces minimal information, enough for making backtraces in
3363 parts of the program that you don't plan to debug. This includes
3364 descriptions of functions and external variables, but no information
3365 about local variables and no line numbers.
3366
3367 Level 3 includes extra information, such as all the macro definitions
3368 present in the program. Some debuggers support macro expansion when
3369 you use @option{-g3}.
3370
3371 @option{-gdwarf-2} does not accept a concatenated debug level, because
3372 GCC used to support an option @option{-gdwarf} that meant to generate
3373 debug information in version 1 of the DWARF format (which is very
3374 different from version 2), and it would have been too confusing. That
3375 debug format is long obsolete, but the option cannot be changed now.
3376 Instead use an additional @option{-g@var{level}} option to change the
3377 debug level for DWARF2.
3378
3379 @item -feliminate-dwarf2-dups
3380 @opindex feliminate-dwarf2-dups
3381 Compress DWARF2 debugging information by eliminating duplicated
3382 information about each symbol. This option only makes sense when
3383 generating DWARF2 debugging information with @option{-gdwarf-2}.
3384
3385 @cindex @command{prof}
3386 @item -p
3387 @opindex p
3388 Generate extra code to write profile information suitable for the
3389 analysis program @command{prof}. You must use this option when compiling
3390 the source files you want data about, and you must also use it when
3391 linking.
3392
3393 @cindex @command{gprof}
3394 @item -pg
3395 @opindex pg
3396 Generate extra code to write profile information suitable for the
3397 analysis program @command{gprof}. You must use this option when compiling
3398 the source files you want data about, and you must also use it when
3399 linking.
3400
3401 @item -Q
3402 @opindex Q
3403 Makes the compiler print out each function name as it is compiled, and
3404 print some statistics about each pass when it finishes.
3405
3406 @item -ftime-report
3407 @opindex ftime-report
3408 Makes the compiler print some statistics about the time consumed by each
3409 pass when it finishes.
3410
3411 @item -fmem-report
3412 @opindex fmem-report
3413 Makes the compiler print some statistics about permanent memory
3414 allocation when it finishes.
3415
3416 @item -fprofile-arcs
3417 @opindex fprofile-arcs
3418 Add code so that program flow @dfn{arcs} are instrumented. During
3419 execution the program records how many times each branch and call is
3420 executed and how many times it is taken or returns. When the compiled
3421 program exits it saves this data to a file called
3422 @file{@var{auxname}.gcda} for each source file. The data may be used for
3423 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3424 test coverage analysis (@option{-ftest-coverage}). Each object file's
3425 @var{auxname} is generated from the name of the output file, if
3426 explicitly specified and it is not the final executable, otherwise it is
3427 the basename of the source file. In both cases any suffix is removed
3428 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3429 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3430 @xref{Cross-profiling}.
3431
3432 @cindex @command{gcov}
3433 @item --coverage
3434 @opindex coverage
3435
3436 This option is used to compile and link code instrumented for coverage
3437 analysis. The option is a synonym for @option{-fprofile-arcs}
3438 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3439 linking). See the documentation for those options for more details.
3440
3441 @itemize
3442
3443 @item
3444 Compile the source files with @option{-fprofile-arcs} plus optimization
3445 and code generation options. For test coverage analysis, use the
3446 additional @option{-ftest-coverage} option. You do not need to profile
3447 every source file in a program.
3448
3449 @item
3450 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3451 (the latter implies the former).
3452
3453 @item
3454 Run the program on a representative workload to generate the arc profile
3455 information. This may be repeated any number of times. You can run
3456 concurrent instances of your program, and provided that the file system
3457 supports locking, the data files will be correctly updated. Also
3458 @code{fork} calls are detected and correctly handled (double counting
3459 will not happen).
3460
3461 @item
3462 For profile-directed optimizations, compile the source files again with
3463 the same optimization and code generation options plus
3464 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3465 Control Optimization}).
3466
3467 @item
3468 For test coverage analysis, use @command{gcov} to produce human readable
3469 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3470 @command{gcov} documentation for further information.
3471
3472 @end itemize
3473
3474 With @option{-fprofile-arcs}, for each function of your program GCC
3475 creates a program flow graph, then finds a spanning tree for the graph.
3476 Only arcs that are not on the spanning tree have to be instrumented: the
3477 compiler adds code to count the number of times that these arcs are
3478 executed. When an arc is the only exit or only entrance to a block, the
3479 instrumentation code can be added to the block; otherwise, a new basic
3480 block must be created to hold the instrumentation code.
3481
3482 @item -ftree-based-profiling
3483 @opindex ftree-based-profiling
3484 This option is used in addition to @option{-fprofile-arcs} or
3485 @option{-fbranch-probabilities} to control whether those optimizations
3486 are performed on a tree-based or rtl-based internal representation.
3487 If you use this option when compiling with @option{-fprofile-arcs},
3488 you must also use it when compiling later with @option{-fbranch-probabilities}.
3489 Currently the tree-based optimization is in an early stage of
3490 development, and this option is recommended only for those people
3491 working on improving it.
3492
3493 @need 2000
3494 @item -ftest-coverage
3495 @opindex ftest-coverage
3496 Produce a notes file that the @command{gcov} code-coverage utility
3497 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3498 show program coverage. Each source file's note file is called
3499 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3500 above for a description of @var{auxname} and instructions on how to
3501 generate test coverage data. Coverage data will match the source files
3502 more closely, if you do not optimize.
3503
3504 @item -d@var{letters}
3505 @item -fdump-rtl-@var{pass}
3506 @opindex d
3507 Says to make debugging dumps during compilation at times specified by
3508 @var{letters}. This is used for debugging the RTL-based passes of the
3509 compiler. The file names for most of the dumps are made by appending a
3510 pass number and a word to the @var{dumpname}. @var{dumpname} is generated
3511 from the name of the output file, if explicitly specified and it is not
3512 an executable, otherwise it is the basename of the source file.
3513
3514 Most debug dumps can be enabled either passing a letter to the @option{-d}
3515 option, or with a long @option{-fdump-rtl} switch; here are the possible
3516 letters for use in @var{letters} and @var{pass}, and their meanings:
3517
3518 @table @gcctabopt
3519 @item -dA
3520 @opindex dA
3521 Annotate the assembler output with miscellaneous debugging information.
3522
3523 @item -db
3524 @itemx -fdump-rtl-bp
3525 @opindex db
3526 @opindex fdump-rtl-bp
3527 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3528
3529 @item -dB
3530 @itemx -fdump-rtl-bbro
3531 @opindex dB
3532 @opindex fdump-rtl-bbro
3533 Dump after block reordering, to @file{@var{file}.30.bbro}.
3534
3535 @item -dc
3536 @itemx -fdump-rtl-combine
3537 @opindex dc
3538 @opindex fdump-rtl-combine
3539 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3540
3541 @item -dC
3542 @itemx -fdump-rtl-ce1
3543 @itemx -fdump-rtl-ce2
3544 @opindex dC
3545 @opindex fdump-rtl-ce1
3546 @opindex fdump-rtl-ce2
3547 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3548 first if conversion, to the file @file{@var{file}.11.ce1}. @option{-dC}
3549 and @option{-fdump-rtl-ce2} enable dumping after the second if
3550 conversion, to the file @file{@var{file}.18.ce2}.
3551
3552 @item -dd
3553 @itemx -fdump-rtl-btl
3554 @itemx -fdump-rtl-dbr
3555 @opindex dd
3556 @opindex fdump-rtl-btl
3557 @opindex fdump-rtl-dbr
3558 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3559 target load optimization, to @file{@var{file}.31.btl}. @option{-dd}
3560 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3561 scheduling, to @file{@var{file}.36.dbr}.
3562
3563 @item -dD
3564 @opindex dD
3565 Dump all macro definitions, at the end of preprocessing, in addition to
3566 normal output.
3567
3568 @item -dE
3569 @itemx -fdump-rtl-ce3
3570 @opindex dE
3571 @opindex fdump-rtl-ce3
3572 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3573
3574 @item -df
3575 @itemx -fdump-rtl-cfg
3576 @itemx -fdump-rtl-life
3577 @opindex df
3578 @opindex fdump-rtl-cfg
3579 @opindex fdump-rtl-life
3580 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3581 and data flow analysis, to @file{@var{file}.08.cfg}. @option{-df}
3582 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3583 to @file{@var{file}.16.life}.
3584
3585 @item -dg
3586 @itemx -fdump-rtl-greg
3587 @opindex dg
3588 @opindex fdump-rtl-greg
3589 Dump after global register allocation, to @file{@var{file}.23.greg}.
3590
3591 @item -dG
3592 @itemx -fdump-rtl-gcse
3593 @itemx -fdump-rtl-bypass
3594 @opindex dG
3595 @opindex fdump-rtl-gcse
3596 @opindex fdump-rtl-bypass
3597 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3598 @file{@var{file}.05.gcse}. @option{-dG} and @option{-fdump-rtl-bypass}
3599 enable dumping after jump bypassing and control flow optimizations, to
3600 @file{@var{file}.07.bypass}.
3601
3602 @item -dh
3603 @itemx -fdump-rtl-eh
3604 @opindex dh
3605 @opindex fdump-rtl-eh
3606 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3607
3608 @item -di
3609 @itemx -fdump-rtl-sibling
3610 @opindex di
3611 @opindex fdump-rtl-sibling
3612 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3613
3614 @item -dj
3615 @itemx -fdump-rtl-jump
3616 @opindex dj
3617 @opindex fdump-rtl-jump
3618 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3619
3620 @item -dk
3621 @itemx -fdump-rtl-stack
3622 @opindex dk
3623 @opindex fdump-rtl-stack
3624 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3625
3626 @item -dl
3627 @itemx -fdump-rtl-lreg
3628 @opindex dl
3629 @opindex fdump-rtl-lreg
3630 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3631
3632 @item -dL
3633 @itemx -fdump-rtl-loop
3634 @itemx -fdump-rtl-loop2
3635 @opindex dL
3636 @opindex fdump-rtl-loop
3637 @opindex fdump-rtl-loop2
3638 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3639 loop optimization pass, to @file{@var{file}.06.loop}. @option{-dL} and
3640 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3641 @file{@var{file}.13.loop2}.
3642
3643 @item -dm
3644 @itemx -fdump-rtl-sms
3645 @opindex dm
3646 @opindex fdump-rtl-sms
3647 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3648
3649 @item -dM
3650 @itemx -fdump-rtl-mach
3651 @opindex dM
3652 @opindex fdump-rtl-mach
3653 Dump after performing the machine dependent reorganization pass, to
3654 @file{@var{file}.35.mach}.
3655
3656 @item -dn
3657 @itemx -fdump-rtl-rnreg
3658 @opindex dn
3659 @opindex fdump-rtl-rnreg
3660 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3661
3662 @item -dN
3663 @itemx -fdump-rtl-regmove
3664 @opindex dN
3665 @opindex fdump-rtl-regmove
3666 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3667
3668 @item -do
3669 @itemx -fdump-rtl-postreload
3670 @opindex do
3671 @opindex fdump-rtl-postreload
3672 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3673
3674 @item -dr
3675 @itemx -fdump-rtl-expand
3676 @opindex dr
3677 @opindex fdump-rtl-expand
3678 Dump after RTL generation, to @file{@var{file}.00.expand}.
3679
3680 @item -dR
3681 @itemx -fdump-rtl-sched2
3682 @opindex dR
3683 @opindex fdump-rtl-sched2
3684 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3685
3686 @item -ds
3687 @itemx -fdump-rtl-cse
3688 @opindex ds
3689 @opindex fdump-rtl-cse
3690 Dump after CSE (including the jump optimization that sometimes follows
3691 CSE), to @file{@var{file}.04.cse}.
3692
3693 @item -dS
3694 @itemx -fdump-rtl-sched
3695 @opindex dS
3696 @opindex fdump-rtl-sched
3697 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3698
3699 @item -dt
3700 @itemx -fdump-rtl-cse2
3701 @opindex dt
3702 @opindex fdump-rtl-cse2
3703 Dump after the second CSE pass (including the jump optimization that
3704 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3705
3706 @item -dT
3707 @itemx -fdump-rtl-tracer
3708 @opindex dT
3709 @opindex fdump-rtl-tracer
3710 Dump after running tracer, to @file{@var{file}.12.tracer}.
3711
3712 @item -dV
3713 @itemx -fdump-rtl-vpt
3714 @itemx -fdump-rtl-vartrack
3715 @opindex dV
3716 @opindex fdump-rtl-vpt
3717 @opindex fdump-rtl-vartrack
3718 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3719 profile transformations, to @file{@var{file}.10.vpt}. @option{-dV}
3720 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3721 to @file{@var{file}.34.vartrack}.
3722
3723 @item -dw
3724 @itemx -fdump-rtl-flow2
3725 @opindex dw
3726 @opindex fdump-rtl-flow2
3727 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3728
3729 @item -dz
3730 @itemx -fdump-rtl-peephole2
3731 @opindex dz
3732 @opindex fdump-rtl-peephole2
3733 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3734
3735 @item -dZ
3736 @itemx -fdump-rtl-web
3737 @opindex dZ
3738 @opindex fdump-rtl-web
3739 Dump after live range splitting, to @file{@var{file}.14.web}.
3740
3741 @item -da
3742 @itemx -fdump-rtl-all
3743 @opindex da
3744 @opindex fdump-rtl-all
3745 Produce all the dumps listed above.
3746
3747 @item -dH
3748 @opindex dH
3749 Produce a core dump whenever an error occurs.
3750
3751 @item -dm
3752 @opindex dm
3753 Print statistics on memory usage, at the end of the run, to
3754 standard error.
3755
3756 @item -dp
3757 @opindex dp
3758 Annotate the assembler output with a comment indicating which
3759 pattern and alternative was used. The length of each instruction is
3760 also printed.
3761
3762 @item -dP
3763 @opindex dP
3764 Dump the RTL in the assembler output as a comment before each instruction.
3765 Also turns on @option{-dp} annotation.
3766
3767 @item -dv
3768 @opindex dv
3769 For each of the other indicated dump files (either with @option{-d} or
3770 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3771 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3772
3773 @item -dx
3774 @opindex dx
3775 Just generate RTL for a function instead of compiling it. Usually used
3776 with @samp{r} (@option{-fdump-rtl-expand}).
3777
3778 @item -dy
3779 @opindex dy
3780 Dump debugging information during parsing, to standard error.
3781 @end table
3782
3783 @item -fdump-unnumbered
3784 @opindex fdump-unnumbered
3785 When doing debugging dumps (see @option{-d} option above), suppress instruction
3786 numbers and line number note output. This makes it more feasible to
3787 use diff on debugging dumps for compiler invocations with different
3788 options, in particular with and without @option{-g}.
3789
3790 @item -fdump-translation-unit @r{(C and C++ only)}
3791 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3792 @opindex fdump-translation-unit
3793 Dump a representation of the tree structure for the entire translation
3794 unit to a file. The file name is made by appending @file{.tu} to the
3795 source file name. If the @samp{-@var{options}} form is used, @var{options}
3796 controls the details of the dump as described for the
3797 @option{-fdump-tree} options.
3798
3799 @item -fdump-class-hierarchy @r{(C++ only)}
3800 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3801 @opindex fdump-class-hierarchy
3802 Dump a representation of each class's hierarchy and virtual function
3803 table layout to a file. The file name is made by appending @file{.class}
3804 to the source file name. If the @samp{-@var{options}} form is used,
3805 @var{options} controls the details of the dump as described for the
3806 @option{-fdump-tree} options.
3807
3808 @item -fdump-ipa-@var{switch}
3809 @opindex fdump-ipa
3810 Control the dumping at various stages of inter-procedural analysis
3811 language tree to a file. The file name is generated by appending a switch
3812 specific suffix to the source file name. The following dumps are possible:
3813
3814 @table @samp
3815 @item all
3816 Enables all inter-procedural analysis dumps; currently the only produced
3817 dump is the @samp{cgraph} dump.
3818
3819 @item cgraph
3820 Dumps information about call-graph optimization, unused function removal,
3821 and inlining decisions.
3822 @end table
3823
3824 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3825 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3826 @opindex fdump-tree
3827 Control the dumping at various stages of processing the intermediate
3828 language tree to a file. The file name is generated by appending a switch
3829 specific suffix to the source file name. If the @samp{-@var{options}}
3830 form is used, @var{options} is a list of @samp{-} separated options that
3831 control the details of the dump. Not all options are applicable to all
3832 dumps, those which are not meaningful will be ignored. The following
3833 options are available
3834
3835 @table @samp
3836 @item address
3837 Print the address of each node. Usually this is not meaningful as it
3838 changes according to the environment and source file. Its primary use
3839 is for tying up a dump file with a debug environment.
3840 @item slim
3841 Inhibit dumping of members of a scope or body of a function merely
3842 because that scope has been reached. Only dump such items when they
3843 are directly reachable by some other path. When dumping pretty-printed
3844 trees, this option inhibits dumping the bodies of control structures.
3845 @item raw
3846 Print a raw representation of the tree. By default, trees are
3847 pretty-printed into a C-like representation.
3848 @item details
3849 Enable more detailed dumps (not honored by every dump option).
3850 @item stats
3851 Enable dumping various statistics about the pass (not honored by every dump
3852 option).
3853 @item blocks
3854 Enable showing basic block boundaries (disabled in raw dumps).
3855 @item vops
3856 Enable showing virtual operands for every statement.
3857 @item lineno
3858 Enable showing line numbers for statements.
3859 @item uid
3860 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3861 @item all
3862 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3863 @end table
3864
3865 The following tree dumps are possible:
3866 @table @samp
3867
3868 @item original
3869 Dump before any tree based optimization, to @file{@var{file}.original}.
3870
3871 @item optimized
3872 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3873
3874 @item inlined
3875 Dump after function inlining, to @file{@var{file}.inlined}.
3876
3877 @item gimple
3878 @opindex fdump-tree-gimple
3879 Dump each function before and after the gimplification pass to a file. The
3880 file name is made by appending @file{.gimple} to the source file name.
3881
3882 @item cfg
3883 @opindex fdump-tree-cfg
3884 Dump the control flow graph of each function to a file. The file name is
3885 made by appending @file{.cfg} to the source file name.
3886
3887 @item vcg
3888 @opindex fdump-tree-vcg
3889 Dump the control flow graph of each function to a file in VCG format. The
3890 file name is made by appending @file{.vcg} to the source file name. Note
3891 that if the file contains more than one function, the generated file cannot
3892 be used directly by VCG@. You will need to cut and paste each function's
3893 graph into its own separate file first.
3894
3895 @item ch
3896 @opindex fdump-tree-ch
3897 Dump each function after copying loop headers. The file name is made by
3898 appending @file{.ch} to the source file name.
3899
3900 @item ssa
3901 @opindex fdump-tree-ssa
3902 Dump SSA related information to a file. The file name is made by appending
3903 @file{.ssa} to the source file name.
3904
3905 @item salias
3906 @opindex fdump-tree-salias
3907 Dump structure aliasing variable information to a file. This file name
3908 is made by appending @file{.salias} to the source file name.
3909
3910 @item alias
3911 @opindex fdump-tree-alias
3912 Dump aliasing information for each function. The file name is made by
3913 appending @file{.alias} to the source file name.
3914
3915 @item ccp
3916 @opindex fdump-tree-ccp
3917 Dump each function after CCP@. The file name is made by appending
3918 @file{.ccp} to the source file name.
3919
3920 @item storeccp
3921 @opindex fdump-tree-storeccp
3922 Dump each function after STORE-CCP. The file name is made by appending
3923 @file{.storeccp} to the source file name.
3924
3925 @item pre
3926 @opindex fdump-tree-pre
3927 Dump trees after partial redundancy elimination. The file name is made
3928 by appending @file{.pre} to the source file name.
3929
3930 @item fre
3931 @opindex fdump-tree-fre
3932 Dump trees after full redundancy elimination. The file name is made
3933 by appending @file{.fre} to the source file name.
3934
3935 @item copyprop
3936 @opindex fdump-tree-copyprop
3937 Dump trees after copy propagation. The file name is made
3938 by appending @file{.copyprop} to the source file name.
3939
3940 @item store_copyprop
3941 @opindex fdump-tree-store_copyprop
3942 Dump trees after store copy-propagation. The file name is made
3943 by appending @file{.store_copyprop} to the source file name.
3944
3945 @item dce
3946 @opindex fdump-tree-dce
3947 Dump each function after dead code elimination. The file name is made by
3948 appending @file{.dce} to the source file name.
3949
3950 @item mudflap
3951 @opindex fdump-tree-mudflap
3952 Dump each function after adding mudflap instrumentation. The file name is
3953 made by appending @file{.mudflap} to the source file name.
3954
3955 @item sra
3956 @opindex fdump-tree-sra
3957 Dump each function after performing scalar replacement of aggregates. The
3958 file name is made by appending @file{.sra} to the source file name.
3959
3960 @item sink
3961 @opindex fdump-tree-sink
3962 Dump each function after performing code sinking. The file name is made
3963 by appending @file{.sink} to the source file name.
3964
3965 @item dom
3966 @opindex fdump-tree-dom
3967 Dump each function after applying dominator tree optimizations. The file
3968 name is made by appending @file{.dom} to the source file name.
3969
3970 @item dse
3971 @opindex fdump-tree-dse
3972 Dump each function after applying dead store elimination. The file
3973 name is made by appending @file{.dse} to the source file name.
3974
3975 @item phiopt
3976 @opindex fdump-tree-phiopt
3977 Dump each function after optimizing PHI nodes into straightline code. The file
3978 name is made by appending @file{.phiopt} to the source file name.
3979
3980 @item forwprop
3981 @opindex fdump-tree-forwprop
3982 Dump each function after forward propagating single use variables. The file
3983 name is made by appending @file{.forwprop} to the source file name.
3984
3985 @item copyrename
3986 @opindex fdump-tree-copyrename
3987 Dump each function after applying the copy rename optimization. The file
3988 name is made by appending @file{.copyrename} to the source file name.
3989
3990 @item nrv
3991 @opindex fdump-tree-nrv
3992 Dump each function after applying the named return value optimization on
3993 generic trees. The file name is made by appending @file{.nrv} to the source
3994 file name.
3995
3996 @item vect
3997 @opindex fdump-tree-vect
3998 Dump each function after applying vectorization of loops. The file name is
3999 made by appending @file{.vect} to the source file name.
4000
4001 @item all
4002 @opindex fdump-tree-all
4003 Enable all the available tree dumps with the flags provided in this option.
4004 @end table
4005
4006 @item -ftree-vectorizer-verbose=@var{n}
4007 @opindex ftree-vectorizer-verbose
4008 This option controls the amount of debugging output the vectorizer prints.
4009 This information is written to standard error, unless @option{-fdump-tree-all}
4010 or @option{-fdump-tree-vect} is specified, in which case it is output to the
4011 usual dump listing file, @file{.vect}.
4012
4013 @item -frandom-seed=@var{string}
4014 @opindex frandom-string
4015 This option provides a seed that GCC uses when it would otherwise use
4016 random numbers. It is used to generate certain symbol names
4017 that have to be different in every compiled file. It is also used to
4018 place unique stamps in coverage data files and the object files that
4019 produce them. You can use the @option{-frandom-seed} option to produce
4020 reproducibly identical object files.
4021
4022 The @var{string} should be different for every file you compile.
4023
4024 @item -fsched-verbose=@var{n}
4025 @opindex fsched-verbose
4026 On targets that use instruction scheduling, this option controls the
4027 amount of debugging output the scheduler prints. This information is
4028 written to standard error, unless @option{-dS} or @option{-dR} is
4029 specified, in which case it is output to the usual dump
4030 listing file, @file{.sched} or @file{.sched2} respectively. However
4031 for @var{n} greater than nine, the output is always printed to standard
4032 error.
4033
4034 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4035 same information as @option{-dRS}. For @var{n} greater than one, it
4036 also output basic block probabilities, detailed ready list information
4037 and unit/insn info. For @var{n} greater than two, it includes RTL
4038 at abort point, control-flow and regions info. And for @var{n} over
4039 four, @option{-fsched-verbose} also includes dependence info.
4040
4041 @item -save-temps
4042 @opindex save-temps
4043 Store the usual ``temporary'' intermediate files permanently; place them
4044 in the current directory and name them based on the source file. Thus,
4045 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4046 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}. This creates a
4047 preprocessed @file{foo.i} output file even though the compiler now
4048 normally uses an integrated preprocessor.
4049
4050 When used in combination with the @option{-x} command line option,
4051 @option{-save-temps} is sensible enough to avoid over writing an
4052 input source file with the same extension as an intermediate file.
4053 The corresponding intermediate file may be obtained by renaming the
4054 source file before using @option{-save-temps}.
4055
4056 @item -time
4057 @opindex time
4058 Report the CPU time taken by each subprocess in the compilation
4059 sequence. For C source files, this is the compiler proper and assembler
4060 (plus the linker if linking is done). The output looks like this:
4061
4062 @smallexample
4063 # cc1 0.12 0.01
4064 # as 0.00 0.01
4065 @end smallexample
4066
4067 The first number on each line is the ``user time'', that is time spent
4068 executing the program itself. The second number is ``system time'',
4069 time spent executing operating system routines on behalf of the program.
4070 Both numbers are in seconds.
4071
4072 @item -fvar-tracking
4073 @opindex fvar-tracking
4074 Run variable tracking pass. It computes where variables are stored at each
4075 position in code. Better debugging information is then generated
4076 (if the debugging information format supports this information).
4077
4078 It is enabled by default when compiling with optimization (@option{-Os},
4079 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4080 the debug info format supports it.
4081
4082 @item -print-file-name=@var{library}
4083 @opindex print-file-name
4084 Print the full absolute name of the library file @var{library} that
4085 would be used when linking---and don't do anything else. With this
4086 option, GCC does not compile or link anything; it just prints the
4087 file name.
4088
4089 @item -print-multi-directory
4090 @opindex print-multi-directory
4091 Print the directory name corresponding to the multilib selected by any
4092 other switches present in the command line. This directory is supposed
4093 to exist in @env{GCC_EXEC_PREFIX}.
4094
4095 @item -print-multi-lib
4096 @opindex print-multi-lib
4097 Print the mapping from multilib directory names to compiler switches
4098 that enable them. The directory name is separated from the switches by
4099 @samp{;}, and each switch starts with an @samp{@@} instead of the
4100 @samp{-}, without spaces between multiple switches. This is supposed to
4101 ease shell-processing.
4102
4103 @item -print-prog-name=@var{program}
4104 @opindex print-prog-name
4105 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4106
4107 @item -print-libgcc-file-name
4108 @opindex print-libgcc-file-name
4109 Same as @option{-print-file-name=libgcc.a}.
4110
4111 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4112 but you do want to link with @file{libgcc.a}. You can do
4113
4114 @smallexample
4115 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4116 @end smallexample
4117
4118 @item -print-search-dirs
4119 @opindex print-search-dirs
4120 Print the name of the configured installation directory and a list of
4121 program and library directories @command{gcc} will search---and don't do anything else.
4122
4123 This is useful when @command{gcc} prints the error message
4124 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4125 To resolve this you either need to put @file{cpp0} and the other compiler
4126 components where @command{gcc} expects to find them, or you can set the environment
4127 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4128 Don't forget the trailing @samp{/}.
4129 @xref{Environment Variables}.
4130
4131 @item -dumpmachine
4132 @opindex dumpmachine
4133 Print the compiler's target machine (for example,
4134 @samp{i686-pc-linux-gnu})---and don't do anything else.
4135
4136 @item -dumpversion
4137 @opindex dumpversion
4138 Print the compiler version (for example, @samp{3.0})---and don't do
4139 anything else.
4140
4141 @item -dumpspecs
4142 @opindex dumpspecs
4143 Print the compiler's built-in specs---and don't do anything else. (This
4144 is used when GCC itself is being built.) @xref{Spec Files}.
4145
4146 @item -feliminate-unused-debug-types
4147 @opindex feliminate-unused-debug-types
4148 Normally, when producing DWARF2 output, GCC will emit debugging
4149 information for all types declared in a compilation
4150 unit, regardless of whether or not they are actually used
4151 in that compilation unit. Sometimes this is useful, such as
4152 if, in the debugger, you want to cast a value to a type that is
4153 not actually used in your program (but is declared). More often,
4154 however, this results in a significant amount of wasted space.
4155 With this option, GCC will avoid producing debug symbol output
4156 for types that are nowhere used in the source file being compiled.
4157 @end table
4158
4159 @node Optimize Options
4160 @section Options That Control Optimization
4161 @cindex optimize options
4162 @cindex options, optimization
4163
4164 These options control various sorts of optimizations.
4165
4166 Without any optimization option, the compiler's goal is to reduce the
4167 cost of compilation and to make debugging produce the expected
4168 results. Statements are independent: if you stop the program with a
4169 breakpoint between statements, you can then assign a new value to any
4170 variable or change the program counter to any other statement in the
4171 function and get exactly the results you would expect from the source
4172 code.
4173
4174 Turning on optimization flags makes the compiler attempt to improve
4175 the performance and/or code size at the expense of compilation time
4176 and possibly the ability to debug the program.
4177
4178 The compiler performs optimization based on the knowledge it has of
4179 the program. Optimization levels @option{-O2} and above, in
4180 particular, enable @emph{unit-at-a-time} mode, which allows the
4181 compiler to consider information gained from later functions in
4182 the file when compiling a function. Compiling multiple files at
4183 once to a single output file in @emph{unit-at-a-time} mode allows
4184 the compiler to use information gained from all of the files when
4185 compiling each of them.
4186
4187 Not all optimizations are controlled directly by a flag. Only
4188 optimizations that have a flag are listed.
4189
4190 @table @gcctabopt
4191 @item -O
4192 @itemx -O1
4193 @opindex O
4194 @opindex O1
4195 Optimize. Optimizing compilation takes somewhat more time, and a lot
4196 more memory for a large function.
4197
4198 With @option{-O}, the compiler tries to reduce code size and execution
4199 time, without performing any optimizations that take a great deal of
4200 compilation time.
4201
4202 @option{-O} turns on the following optimization flags:
4203 @gccoptlist{-fdefer-pop @gol
4204 -fdelayed-branch @gol
4205 -fguess-branch-probability @gol
4206 -fcprop-registers @gol
4207 -floop-optimize @gol
4208 -fif-conversion @gol
4209 -fif-conversion2 @gol
4210 -ftree-ccp @gol
4211 -ftree-dce @gol
4212 -ftree-dominator-opts @gol
4213 -ftree-dse @gol
4214 -ftree-ter @gol
4215 -ftree-lrs @gol
4216 -ftree-sra @gol
4217 -ftree-copyrename @gol
4218 -ftree-fre @gol
4219 -ftree-ch @gol
4220 -fmerge-constants}
4221
4222 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4223 where doing so does not interfere with debugging.
4224
4225 @item -O2
4226 @opindex O2
4227 Optimize even more. GCC performs nearly all supported optimizations
4228 that do not involve a space-speed tradeoff. The compiler does not
4229 perform loop unrolling or function inlining when you specify @option{-O2}.
4230 As compared to @option{-O}, this option increases both compilation time
4231 and the performance of the generated code.
4232
4233 @option{-O2} turns on all optimization flags specified by @option{-O}. It
4234 also turns on the following optimization flags:
4235 @gccoptlist{-fthread-jumps @gol
4236 -fcrossjumping @gol
4237 -foptimize-sibling-calls @gol
4238 -fcse-follow-jumps -fcse-skip-blocks @gol
4239 -fgcse -fgcse-lm @gol
4240 -fexpensive-optimizations @gol
4241 -fstrength-reduce @gol
4242 -frerun-cse-after-loop -frerun-loop-opt @gol
4243 -fcaller-saves @gol
4244 -fforce-mem @gol
4245 -fpeephole2 @gol
4246 -fschedule-insns -fschedule-insns2 @gol
4247 -fsched-interblock -fsched-spec @gol
4248 -fregmove @gol
4249 -fstrict-aliasing @gol
4250 -fdelete-null-pointer-checks @gol
4251 -freorder-blocks -freorder-functions @gol
4252 -funit-at-a-time @gol
4253 -falign-functions -falign-jumps @gol
4254 -falign-loops -falign-labels @gol
4255 -ftree-pre}
4256
4257 Please note the warning under @option{-fgcse} about
4258 invoking @option{-O2} on programs that use computed gotos.
4259
4260 @item -O3
4261 @opindex O3
4262 Optimize yet more. @option{-O3} turns on all optimizations specified by
4263 @option{-O2} and also turns on the @option{-finline-functions},
4264 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4265
4266 @item -O0
4267 @opindex O0
4268 Do not optimize. This is the default.
4269
4270 @item -Os
4271 @opindex Os
4272 Optimize for size. @option{-Os} enables all @option{-O2} optimizations that
4273 do not typically increase code size. It also performs further
4274 optimizations designed to reduce code size.
4275
4276 @option{-Os} disables the following optimization flags:
4277 @gccoptlist{-falign-functions -falign-jumps -falign-loops @gol
4278 -falign-labels -freorder-blocks -freorder-blocks-and-partition -fprefetch-loop-arrays}
4279
4280 If you use multiple @option{-O} options, with or without level numbers,
4281 the last such option is the one that is effective.
4282 @end table
4283
4284 Options of the form @option{-f@var{flag}} specify machine-independent
4285 flags. Most flags have both positive and negative forms; the negative
4286 form of @option{-ffoo} would be @option{-fno-foo}. In the table
4287 below, only one of the forms is listed---the one you typically will
4288 use. You can figure out the other form by either removing @samp{no-}
4289 or adding it.
4290
4291 The following options control specific optimizations. They are either
4292 activated by @option{-O} options or are related to ones that are. You
4293 can use the following flags in the rare cases when ``fine-tuning'' of
4294 optimizations to be performed is desired.
4295
4296 @table @gcctabopt
4297 @item -fno-default-inline
4298 @opindex fno-default-inline
4299 Do not make member functions inline by default merely because they are
4300 defined inside the class scope (C++ only). Otherwise, when you specify
4301 @w{@option{-O}}, member functions defined inside class scope are compiled
4302 inline by default; i.e., you don't need to add @samp{inline} in front of
4303 the member function name.
4304
4305 @item -fno-defer-pop
4306 @opindex fno-defer-pop
4307 Always pop the arguments to each function call as soon as that function
4308 returns. For machines which must pop arguments after a function call,
4309 the compiler normally lets arguments accumulate on the stack for several
4310 function calls and pops them all at once.
4311
4312 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4313
4314 @item -fforce-mem
4315 @opindex fforce-mem
4316 Force memory operands to be copied into registers before doing
4317 arithmetic on them. This produces better code by making all memory
4318 references potential common subexpressions. When they are not common
4319 subexpressions, instruction combination should eliminate the separate
4320 register-load.
4321
4322 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4323
4324 @item -fforce-addr
4325 @opindex fforce-addr
4326 Force memory address constants to be copied into registers before
4327 doing arithmetic on them. This may produce better code just as
4328 @option{-fforce-mem} may.
4329
4330 @item -fomit-frame-pointer
4331 @opindex fomit-frame-pointer
4332 Don't keep the frame pointer in a register for functions that
4333 don't need one. This avoids the instructions to save, set up and
4334 restore frame pointers; it also makes an extra register available
4335 in many functions. @strong{It also makes debugging impossible on
4336 some machines.}
4337
4338 On some machines, such as the VAX, this flag has no effect, because
4339 the standard calling sequence automatically handles the frame pointer
4340 and nothing is saved by pretending it doesn't exist. The
4341 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4342 whether a target machine supports this flag. @xref{Registers,,Register
4343 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4344
4345 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4346
4347 @item -foptimize-sibling-calls
4348 @opindex foptimize-sibling-calls
4349 Optimize sibling and tail recursive calls.
4350
4351 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4352
4353 @item -fno-inline
4354 @opindex fno-inline
4355 Don't pay attention to the @code{inline} keyword. Normally this option
4356 is used to keep the compiler from expanding any functions inline.
4357 Note that if you are not optimizing, no functions can be expanded inline.
4358
4359 @item -finline-functions
4360 @opindex finline-functions
4361 Integrate all simple functions into their callers. The compiler
4362 heuristically decides which functions are simple enough to be worth
4363 integrating in this way.
4364
4365 If all calls to a given function are integrated, and the function is
4366 declared @code{static}, then the function is normally not output as
4367 assembler code in its own right.
4368
4369 Enabled at level @option{-O3}.
4370
4371 @item -finline-limit=@var{n}
4372 @opindex finline-limit
4373 By default, GCC limits the size of functions that can be inlined. This flag
4374 allows the control of this limit for functions that are explicitly marked as
4375 inline (i.e., marked with the inline keyword or defined within the class
4376 definition in c++). @var{n} is the size of functions that can be inlined in
4377 number of pseudo instructions (not counting parameter handling). The default
4378 value of @var{n} is 600.
4379 Increasing this value can result in more inlined code at
4380 the cost of compilation time and memory consumption. Decreasing usually makes
4381 the compilation faster and less code will be inlined (which presumably
4382 means slower programs). This option is particularly useful for programs that
4383 use inlining heavily such as those based on recursive templates with C++.
4384
4385 Inlining is actually controlled by a number of parameters, which may be
4386 specified individually by using @option{--param @var{name}=@var{value}}.
4387 The @option{-finline-limit=@var{n}} option sets some of these parameters
4388 as follows:
4389
4390 @table @gcctabopt
4391 @item max-inline-insns-single
4392 is set to @var{n}/2.
4393 @item max-inline-insns-auto
4394 is set to @var{n}/2.
4395 @item min-inline-insns
4396 is set to 130 or @var{n}/4, whichever is smaller.
4397 @item max-inline-insns-rtl
4398 is set to @var{n}.
4399 @end table
4400
4401 See below for a documentation of the individual
4402 parameters controlling inlining.
4403
4404 @emph{Note:} pseudo instruction represents, in this particular context, an
4405 abstract measurement of function's size. In no way, it represents a count
4406 of assembly instructions and as such its exact meaning might change from one
4407 release to an another.
4408
4409 @item -fkeep-inline-functions
4410 @opindex fkeep-inline-functions
4411 In C, emit @code{static} functions that are declared @code{inline}
4412 into the object file, even if the function has been inlined into all
4413 of its callers. This switch does not affect functions using the
4414 @code{extern inline} extension in GNU C@. In C++, emit any and all
4415 inline functions into the object file.
4416
4417 @item -fkeep-static-consts
4418 @opindex fkeep-static-consts
4419 Emit variables declared @code{static const} when optimization isn't turned
4420 on, even if the variables aren't referenced.
4421
4422 GCC enables this option by default. If you want to force the compiler to
4423 check if the variable was referenced, regardless of whether or not
4424 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4425
4426 @item -fmerge-constants
4427 Attempt to merge identical constants (string constants and floating point
4428 constants) across compilation units.
4429
4430 This option is the default for optimized compilation if the assembler and
4431 linker support it. Use @option{-fno-merge-constants} to inhibit this
4432 behavior.
4433
4434 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4435
4436 @item -fmerge-all-constants
4437 Attempt to merge identical constants and identical variables.
4438
4439 This option implies @option{-fmerge-constants}. In addition to
4440 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4441 arrays or initialized constant variables with integral or floating point
4442 types. Languages like C or C++ require each non-automatic variable to
4443 have distinct location, so using this option will result in non-conforming
4444 behavior.
4445
4446 @item -fmodulo-sched
4447 @opindex fmodulo-sched
4448 Perform swing modulo scheduling immediately before the first scheduling
4449 pass. This pass looks at innermost loops and reorders their
4450 instructions by overlapping different iterations.
4451
4452 @item -fno-branch-count-reg
4453 @opindex fno-branch-count-reg
4454 Do not use ``decrement and branch'' instructions on a count register,
4455 but instead generate a sequence of instructions that decrement a
4456 register, compare it against zero, then branch based upon the result.
4457 This option is only meaningful on architectures that support such
4458 instructions, which include x86, PowerPC, IA-64 and S/390.
4459
4460 The default is @option{-fbranch-count-reg}, enabled when
4461 @option{-fstrength-reduce} is enabled.
4462
4463 @item -fno-function-cse
4464 @opindex fno-function-cse
4465 Do not put function addresses in registers; make each instruction that
4466 calls a constant function contain the function's address explicitly.
4467
4468 This option results in less efficient code, but some strange hacks
4469 that alter the assembler output may be confused by the optimizations
4470 performed when this option is not used.
4471
4472 The default is @option{-ffunction-cse}
4473
4474 @item -fno-zero-initialized-in-bss
4475 @opindex fno-zero-initialized-in-bss
4476 If the target supports a BSS section, GCC by default puts variables that
4477 are initialized to zero into BSS@. This can save space in the resulting
4478 code.
4479
4480 This option turns off this behavior because some programs explicitly
4481 rely on variables going to the data section. E.g., so that the
4482 resulting executable can find the beginning of that section and/or make
4483 assumptions based on that.
4484
4485 The default is @option{-fzero-initialized-in-bss}.
4486
4487 @item -fbounds-check
4488 @opindex fbounds-check
4489 For front-ends that support it, generate additional code to check that
4490 indices used to access arrays are within the declared range. This is
4491 currently only supported by the Java and Fortran front-ends, where
4492 this option defaults to true and false respectively.
4493
4494 @item -fmudflap -fmudflapth -fmudflapir
4495 @opindex fmudflap
4496 @opindex fmudflapth
4497 @opindex fmudflapir
4498 @cindex bounds checking
4499 @cindex mudflap
4500 For front-ends that support it (C and C++), instrument all risky
4501 pointer/array dereferencing operations, some standard library
4502 string/heap functions, and some other associated constructs with
4503 range/validity tests. Modules so instrumented should be immune to
4504 buffer overflows, invalid heap use, and some other classes of C/C++
4505 programming errors. The instrumentation relies on a separate runtime
4506 library (@file{libmudflap}), which will be linked into a program if
4507 @option{-fmudflap} is given at link time. Run-time behavior of the
4508 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4509 environment variable. See @code{env MUDFLAP_OPTIONS=-help a.out}
4510 for its options.
4511
4512 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4513 link if your program is multi-threaded. Use @option{-fmudflapir}, in
4514 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4515 instrumentation should ignore pointer reads. This produces less
4516 instrumentation (and therefore faster execution) and still provides
4517 some protection against outright memory corrupting writes, but allows
4518 erroneously read data to propagate within a program.
4519
4520 @item -fstrength-reduce
4521 @opindex fstrength-reduce
4522 Perform the optimizations of loop strength reduction and
4523 elimination of iteration variables.
4524
4525 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4526
4527 @item -fthread-jumps
4528 @opindex fthread-jumps
4529 Perform optimizations where we check to see if a jump branches to a
4530 location where another comparison subsumed by the first is found. If
4531 so, the first branch is redirected to either the destination of the
4532 second branch or a point immediately following it, depending on whether
4533 the condition is known to be true or false.
4534
4535 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4536
4537 @item -fcse-follow-jumps
4538 @opindex fcse-follow-jumps
4539 In common subexpression elimination, scan through jump instructions
4540 when the target of the jump is not reached by any other path. For
4541 example, when CSE encounters an @code{if} statement with an
4542 @code{else} clause, CSE will follow the jump when the condition
4543 tested is false.
4544
4545 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4546
4547 @item -fcse-skip-blocks
4548 @opindex fcse-skip-blocks
4549 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4550 follow jumps which conditionally skip over blocks. When CSE
4551 encounters a simple @code{if} statement with no else clause,
4552 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4553 body of the @code{if}.
4554
4555 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4556
4557 @item -frerun-cse-after-loop
4558 @opindex frerun-cse-after-loop
4559 Re-run common subexpression elimination after loop optimizations has been
4560 performed.
4561
4562 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4563
4564 @item -frerun-loop-opt
4565 @opindex frerun-loop-opt
4566 Run the loop optimizer twice.
4567
4568 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4569
4570 @item -fgcse
4571 @opindex fgcse
4572 Perform a global common subexpression elimination pass.
4573 This pass also performs global constant and copy propagation.
4574
4575 @emph{Note:} When compiling a program using computed gotos, a GCC
4576 extension, you may get better runtime performance if you disable
4577 the global common subexpression elimination pass by adding
4578 @option{-fno-gcse} to the command line.
4579
4580 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4581
4582 @item -fgcse-lm
4583 @opindex fgcse-lm
4584 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4585 attempt to move loads which are only killed by stores into themselves. This
4586 allows a loop containing a load/store sequence to be changed to a load outside
4587 the loop, and a copy/store within the loop.
4588
4589 Enabled by default when gcse is enabled.
4590
4591 @item -fgcse-sm
4592 @opindex fgcse-sm
4593 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4594 global common subexpression elimination. This pass will attempt to move
4595 stores out of loops. When used in conjunction with @option{-fgcse-lm},
4596 loops containing a load/store sequence can be changed to a load before
4597 the loop and a store after the loop.
4598
4599 Not enabled at any optimization level.
4600
4601 @item -fgcse-las
4602 @opindex fgcse-las
4603 When @option{-fgcse-las} is enabled, the global common subexpression
4604 elimination pass eliminates redundant loads that come after stores to the
4605 same memory location (both partial and full redundancies).
4606
4607 Not enabled at any optimization level.
4608
4609 @item -fgcse-after-reload
4610 @opindex fgcse-after-reload
4611 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4612 pass is performed after reload. The purpose of this pass is to cleanup
4613 redundant spilling.
4614
4615 @item -floop-optimize
4616 @opindex floop-optimize
4617 Perform loop optimizations: move constant expressions out of loops, simplify
4618 exit test conditions and optionally do strength-reduction as well.
4619
4620 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4621
4622 @item -floop-optimize2
4623 @opindex floop-optimize2
4624 Perform loop optimizations using the new loop optimizer. The optimizations
4625 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4626 by separate flags.
4627
4628 @item -fcrossjumping
4629 @opindex crossjumping
4630 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
4631 resulting code may or may not perform better than without cross-jumping.
4632
4633 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4634
4635 @item -fif-conversion
4636 @opindex if-conversion
4637 Attempt to transform conditional jumps into branch-less equivalents. This
4638 include use of conditional moves, min, max, set flags and abs instructions, and
4639 some tricks doable by standard arithmetics. The use of conditional execution
4640 on chips where it is available is controlled by @code{if-conversion2}.
4641
4642 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4643
4644 @item -fif-conversion2
4645 @opindex if-conversion2
4646 Use conditional execution (where available) to transform conditional jumps into
4647 branch-less equivalents.
4648
4649 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4650
4651 @item -fdelete-null-pointer-checks
4652 @opindex fdelete-null-pointer-checks
4653 Use global dataflow analysis to identify and eliminate useless checks
4654 for null pointers. The compiler assumes that dereferencing a null
4655 pointer would have halted the program. If a pointer is checked after
4656 it has already been dereferenced, it cannot be null.
4657
4658 In some environments, this assumption is not true, and programs can
4659 safely dereference null pointers. Use
4660 @option{-fno-delete-null-pointer-checks} to disable this optimization
4661 for programs which depend on that behavior.
4662
4663 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4664
4665 @item -fexpensive-optimizations
4666 @opindex fexpensive-optimizations
4667 Perform a number of minor optimizations that are relatively expensive.
4668
4669 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4670
4671 @item -foptimize-register-move
4672 @itemx -fregmove
4673 @opindex foptimize-register-move
4674 @opindex fregmove
4675 Attempt to reassign register numbers in move instructions and as
4676 operands of other simple instructions in order to maximize the amount of
4677 register tying. This is especially helpful on machines with two-operand
4678 instructions.
4679
4680 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4681 optimization.
4682
4683 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4684
4685 @item -fdelayed-branch
4686 @opindex fdelayed-branch
4687 If supported for the target machine, attempt to reorder instructions
4688 to exploit instruction slots available after delayed branch
4689 instructions.
4690
4691 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4692
4693 @item -fschedule-insns
4694 @opindex fschedule-insns
4695 If supported for the target machine, attempt to reorder instructions to
4696 eliminate execution stalls due to required data being unavailable. This
4697 helps machines that have slow floating point or memory load instructions
4698 by allowing other instructions to be issued until the result of the load
4699 or floating point instruction is required.
4700
4701 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4702
4703 @item -fschedule-insns2
4704 @opindex fschedule-insns2
4705 Similar to @option{-fschedule-insns}, but requests an additional pass of
4706 instruction scheduling after register allocation has been done. This is
4707 especially useful on machines with a relatively small number of
4708 registers and where memory load instructions take more than one cycle.
4709
4710 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4711
4712 @item -fno-sched-interblock
4713 @opindex fno-sched-interblock
4714 Don't schedule instructions across basic blocks. This is normally
4715 enabled by default when scheduling before register allocation, i.e.@:
4716 with @option{-fschedule-insns} or at @option{-O2} or higher.
4717
4718 @item -fno-sched-spec
4719 @opindex fno-sched-spec
4720 Don't allow speculative motion of non-load instructions. This is normally
4721 enabled by default when scheduling before register allocation, i.e.@:
4722 with @option{-fschedule-insns} or at @option{-O2} or higher.
4723
4724 @item -fsched-spec-load
4725 @opindex fsched-spec-load
4726 Allow speculative motion of some load instructions. This only makes
4727 sense when scheduling before register allocation, i.e.@: with
4728 @option{-fschedule-insns} or at @option{-O2} or higher.
4729
4730 @item -fsched-spec-load-dangerous
4731 @opindex fsched-spec-load-dangerous
4732 Allow speculative motion of more load instructions. This only makes
4733 sense when scheduling before register allocation, i.e.@: with
4734 @option{-fschedule-insns} or at @option{-O2} or higher.
4735
4736 @item -fsched-stalled-insns=@var{n}
4737 @opindex fsched-stalled-insns
4738 Define how many insns (if any) can be moved prematurely from the queue
4739 of stalled insns into the ready list, during the second scheduling pass.
4740
4741 @item -fsched-stalled-insns-dep=@var{n}
4742 @opindex fsched-stalled-insns-dep
4743 Define how many insn groups (cycles) will be examined for a dependency
4744 on a stalled insn that is candidate for premature removal from the queue
4745 of stalled insns. Has an effect only during the second scheduling pass,
4746 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4747
4748 @item -fsched2-use-superblocks
4749 @opindex fsched2-use-superblocks
4750 When scheduling after register allocation, do use superblock scheduling
4751 algorithm. Superblock scheduling allows motion across basic block boundaries
4752 resulting on faster schedules. This option is experimental, as not all machine
4753 descriptions used by GCC model the CPU closely enough to avoid unreliable
4754 results from the algorithm.
4755
4756 This only makes sense when scheduling after register allocation, i.e.@: with
4757 @option{-fschedule-insns2} or at @option{-O2} or higher.
4758
4759 @item -fsched2-use-traces
4760 @opindex fsched2-use-traces
4761 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4762 allocation and additionally perform code duplication in order to increase the
4763 size of superblocks using tracer pass. See @option{-ftracer} for details on
4764 trace formation.
4765
4766 This mode should produce faster but significantly longer programs. Also
4767 without @option{-fbranch-probabilities} the traces constructed may not
4768 match the reality and hurt the performance. This only makes
4769 sense when scheduling after register allocation, i.e.@: with
4770 @option{-fschedule-insns2} or at @option{-O2} or higher.
4771
4772 @item -freschedule-modulo-scheduled-loops
4773 @opindex fscheduling-in-modulo-scheduled-loops
4774 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4775 we may want to prevent the later scheduling passes from changing its schedule, we use this
4776 option to control that.
4777
4778 @item -fcaller-saves
4779 @opindex fcaller-saves
4780 Enable values to be allocated in registers that will be clobbered by
4781 function calls, by emitting extra instructions to save and restore the
4782 registers around such calls. Such allocation is done only when it
4783 seems to result in better code than would otherwise be produced.
4784
4785 This option is always enabled by default on certain machines, usually
4786 those which have no call-preserved registers to use instead.
4787
4788 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4789
4790 @item -ftree-pre
4791 Perform Partial Redundancy Elimination (PRE) on trees. This flag is
4792 enabled by default at @option{-O2} and @option{-O3}.
4793
4794 @item -ftree-fre
4795 Perform Full Redundancy Elimination (FRE) on trees. The difference
4796 between FRE and PRE is that FRE only considers expressions
4797 that are computed on all paths leading to the redundant computation.
4798 This analysis faster than PRE, though it exposes fewer redundancies.
4799 This flag is enabled by default at @option{-O} and higher.
4800
4801 @item -ftree-copy-prop
4802 Perform copy propagation on trees. This pass eliminates unnecessary
4803 copy operations. This flag is enabled by default at @option{-O} and
4804 higher.
4805
4806 @item -ftree-store-copy-prop
4807 Perform copy propagation of memory loads and stores. This pass
4808 eliminates unnecessary copy operations in memory references
4809 (structures, global variables, arrays, etc). This flag is enabled by
4810 default at @option{-O2} and higher.
4811
4812 @item -ftree-salias
4813 Perform structural alias analysis on trees. This flag
4814 is enabled by default at @option{-O} and higher.
4815
4816 @item -ftree-sink
4817 Perform forward store motion on trees. This flag is
4818 enabled by default at @option{-O} and higher.
4819
4820 @item -ftree-ccp
4821 Perform sparse conditional constant propagation (CCP) on trees. This
4822 pass only operates on local scalar variables and is enabled by default
4823 at @option{-O} and higher.
4824
4825 @item -ftree-store-ccp
4826 Perform sparse conditional constant propagation (CCP) on trees. This
4827 pass operates on both local scalar variables and memory stores and
4828 loads (global variables, structures, arrays, etc). This flag is
4829 enabled by default at @option{-O2} and higher.
4830
4831 @item -ftree-dce
4832 Perform dead code elimination (DCE) on trees. This flag is enabled by
4833 default at @option{-O} and higher.
4834
4835 @item -ftree-dominator-opts
4836 Perform dead code elimination (DCE) on trees. This flag is enabled by
4837 default at @option{-O} and higher.
4838
4839 @item -ftree-ch
4840 Perform loop header copying on trees. This is beneficial since it increases
4841 effectiveness of code motion optimizations. It also saves one jump. This flag
4842 is enabled by default at @option{-O} and higher. It is not enabled
4843 for @option{-Os}, since it usually increases code size.
4844
4845 @item -ftree-loop-optimize
4846 Perform loop optimizations on trees. This flag is enabled by default
4847 at @option{-O} and higher.
4848
4849 @item -ftree-loop-linear
4850 Perform linear loop transformations on tree. This flag can improve cache
4851 performance and allow further loop optimizations to take place.
4852
4853 @item -ftree-loop-im
4854 Perform loop invariant motion on trees. This pass moves only invariants that
4855 would be hard to handle at RTL level (function calls, operations that expand to
4856 nontrivial sequences of insns). With @option{-funswitch-loops} it also moves
4857 operands of conditions that are invariant out of the loop, so that we can use
4858 just trivial invariantness analysis in loop unswitching. The pass also includes
4859 store motion.
4860
4861 @item -ftree-loop-ivcanon
4862 Create a canonical counter for number of iterations in the loop for that
4863 determining number of iterations requires complicated analysis. Later
4864 optimizations then may determine the number easily. Useful especially
4865 in connection with unrolling.
4866
4867 @item -fivopts
4868 Perform induction variable optimizations (strength reduction, induction
4869 variable merging and induction variable elimination) on trees.
4870
4871 @item -ftree-sra
4872 Perform scalar replacement of aggregates. This pass replaces structure
4873 references with scalars to prevent committing structures to memory too
4874 early. This flag is enabled by default at @option{-O} and higher.
4875
4876 @item -ftree-copyrename
4877 Perform copy renaming on trees. This pass attempts to rename compiler
4878 temporaries to other variables at copy locations, usually resulting in
4879 variable names which more closely resemble the original variables. This flag
4880 is enabled by default at @option{-O} and higher.
4881
4882 @item -ftree-ter
4883 Perform temporary expression replacement during the SSA->normal phase. Single
4884 use/single def temporaries are replaced at their use location with their
4885 defining expression. This results in non-GIMPLE code, but gives the expanders
4886 much more complex trees to work on resulting in better RTL generation. This is
4887 enabled by default at @option{-O} and higher.
4888
4889 @item -ftree-lrs
4890 Perform live range splitting during the SSA->normal phase. Distinct live
4891 ranges of a variable are split into unique variables, allowing for better
4892 optimization later. This is enabled by default at @option{-O} and higher.
4893
4894 @item -ftree-vectorize
4895 Perform loop vectorization on trees.
4896
4897 @item -ftracer
4898 @opindex ftracer
4899 Perform tail duplication to enlarge superblock size. This transformation
4900 simplifies the control flow of the function allowing other optimizations to do
4901 better job.
4902
4903 @item -funroll-loops
4904 @opindex funroll-loops
4905 Unroll loops whose number of iterations can be determined at compile
4906 time or upon entry to the loop. @option{-funroll-loops} implies both
4907 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}. This
4908 option makes code larger, and may or may not make it run faster.
4909
4910 @item -funroll-all-loops
4911 @opindex funroll-all-loops
4912 Unroll all loops, even if their number of iterations is uncertain when
4913 the loop is entered. This usually makes programs run more slowly.
4914 @option{-funroll-all-loops} implies the same options as
4915 @option{-funroll-loops},
4916
4917 @item -fsplit-ivs-in-unroller
4918 @opindex -fsplit-ivs-in-unroller
4919 Enables expressing of values of induction variables in later iterations
4920 of the unrolled loop using the value in the first iteration. This breaks
4921 long dependency chains, thus improving efficiency of the scheduling passes
4922 (for best results, @option{-fweb} should be used as well).
4923
4924 Combination of @option{-fweb} and CSE is often sufficient to obtain the
4925 same effect. However in cases the loop body is more complicated than
4926 a single basic block, this is not reliable. It also does not work at all
4927 on some of the architectures due to restrictions in the CSE pass.
4928
4929 This optimization is enabled by default.
4930
4931 @item -fvariable-expansion-in-unroller
4932 @opindex -fvariable-expansion-in-unroller
4933 With this option, the compiler will create multiple copies of some
4934 local variables when unrolling a loop which can result in superior code.
4935
4936 @item -fprefetch-loop-arrays
4937 @opindex fprefetch-loop-arrays
4938 If supported by the target machine, generate instructions to prefetch
4939 memory to improve the performance of loops that access large arrays.
4940
4941 These options may generate better or worse code; results are highly
4942 dependent on the structure of loops within the source code.
4943
4944 @item -fno-peephole
4945 @itemx -fno-peephole2
4946 @opindex fno-peephole
4947 @opindex fno-peephole2
4948 Disable any machine-specific peephole optimizations. The difference
4949 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4950 are implemented in the compiler; some targets use one, some use the
4951 other, a few use both.
4952
4953 @option{-fpeephole} is enabled by default.
4954 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4955
4956 @item -fno-guess-branch-probability
4957 @opindex fno-guess-branch-probability
4958 Do not guess branch probabilities using heuristics.
4959
4960 GCC will use heuristics to guess branch probabilities if they are
4961 not provided by profiling feedback (@option{-fprofile-arcs}). These
4962 heuristics are based on the control flow graph. If some branch probabilities
4963 are specified by @samp{__builtin_expect}, then the heuristics will be
4964 used to guess branch probabilities for the rest of the control flow graph,
4965 taking the @samp{__builtin_expect} info into account. The interactions
4966 between the heuristics and @samp{__builtin_expect} can be complex, and in
4967 some cases, it may be useful to disable the heuristics so that the effects
4968 of @samp{__builtin_expect} are easier to understand.
4969
4970 The default is @option{-fguess-branch-probability} at levels
4971 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4972
4973 @item -freorder-blocks
4974 @opindex freorder-blocks
4975 Reorder basic blocks in the compiled function in order to reduce number of
4976 taken branches and improve code locality.
4977
4978 Enabled at levels @option{-O2}, @option{-O3}.
4979
4980 @item -freorder-blocks-and-partition
4981 @opindex freorder-blocks-and-partition
4982 In addition to reordering basic blocks in the compiled function, in order
4983 to reduce number of taken branches, partitions hot and cold basic blocks
4984 into separate sections of the assembly and .o files, to improve
4985 paging and cache locality performance.
4986
4987 This optimization is automatically turned off in the presence of
4988 exception handling, for linkonce sections, for functions with a user-defined
4989 section attribute and on any architecture that does not support named
4990 sections.
4991
4992 @item -freorder-functions
4993 @opindex freorder-functions
4994 Reorder functions in the object file in order to
4995 improve code locality. This is implemented by using special
4996 subsections @code{.text.hot} for most frequently executed functions and
4997 @code{.text.unlikely} for unlikely executed functions. Reordering is done by
4998 the linker so object file format must support named sections and linker must
4999 place them in a reasonable way.
5000
5001 Also profile feedback must be available in to make this option effective. See
5002 @option{-fprofile-arcs} for details.
5003
5004 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5005
5006 @item -fstrict-aliasing
5007 @opindex fstrict-aliasing
5008 Allows the compiler to assume the strictest aliasing rules applicable to
5009 the language being compiled. For C (and C++), this activates
5010 optimizations based on the type of expressions. In particular, an
5011 object of one type is assumed never to reside at the same address as an
5012 object of a different type, unless the types are almost the same. For
5013 example, an @code{unsigned int} can alias an @code{int}, but not a
5014 @code{void*} or a @code{double}. A character type may alias any other
5015 type.
5016
5017 Pay special attention to code like this:
5018 @smallexample
5019 union a_union @{
5020 int i;
5021 double d;
5022 @};
5023
5024 int f() @{
5025 a_union t;
5026 t.d = 3.0;
5027 return t.i;
5028 @}
5029 @end smallexample
5030 The practice of reading from a different union member than the one most
5031 recently written to (called ``type-punning'') is common. Even with
5032 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5033 is accessed through the union type. So, the code above will work as
5034 expected. However, this code might not:
5035 @smallexample
5036 int f() @{
5037 a_union t;
5038 int* ip;
5039 t.d = 3.0;
5040 ip = &t.i;
5041 return *ip;
5042 @}
5043 @end smallexample
5044
5045 Every language that wishes to perform language-specific alias analysis
5046 should define a function that computes, given an @code{tree}
5047 node, an alias set for the node. Nodes in different alias sets are not
5048 allowed to alias. For an example, see the C front-end function
5049 @code{c_get_alias_set}.
5050
5051 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5052
5053 @item -falign-functions
5054 @itemx -falign-functions=@var{n}
5055 @opindex falign-functions
5056 Align the start of functions to the next power-of-two greater than
5057 @var{n}, skipping up to @var{n} bytes. For instance,
5058 @option{-falign-functions=32} aligns functions to the next 32-byte
5059 boundary, but @option{-falign-functions=24} would align to the next
5060 32-byte boundary only if this can be done by skipping 23 bytes or less.
5061
5062 @option{-fno-align-functions} and @option{-falign-functions=1} are
5063 equivalent and mean that functions will not be aligned.
5064
5065 Some assemblers only support this flag when @var{n} is a power of two;
5066 in that case, it is rounded up.
5067
5068 If @var{n} is not specified or is zero, use a machine-dependent default.
5069
5070 Enabled at levels @option{-O2}, @option{-O3}.
5071
5072 @item -falign-labels
5073 @itemx -falign-labels=@var{n}
5074 @opindex falign-labels
5075 Align all branch targets to a power-of-two boundary, skipping up to
5076 @var{n} bytes like @option{-falign-functions}. This option can easily
5077 make code slower, because it must insert dummy operations for when the
5078 branch target is reached in the usual flow of the code.
5079
5080 @option{-fno-align-labels} and @option{-falign-labels=1} are
5081 equivalent and mean that labels will not be aligned.
5082
5083 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5084 are greater than this value, then their values are used instead.
5085
5086 If @var{n} is not specified or is zero, use a machine-dependent default
5087 which is very likely to be @samp{1}, meaning no alignment.
5088
5089 Enabled at levels @option{-O2}, @option{-O3}.
5090
5091 @item -falign-loops
5092 @itemx -falign-loops=@var{n}
5093 @opindex falign-loops
5094 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5095 like @option{-falign-functions}. The hope is that the loop will be
5096 executed many times, which will make up for any execution of the dummy
5097 operations.
5098
5099 @option{-fno-align-loops} and @option{-falign-loops=1} are
5100 equivalent and mean that loops will not be aligned.
5101
5102 If @var{n} is not specified or is zero, use a machine-dependent default.
5103
5104 Enabled at levels @option{-O2}, @option{-O3}.
5105
5106 @item -falign-jumps
5107 @itemx -falign-jumps=@var{n}
5108 @opindex falign-jumps
5109 Align branch targets to a power-of-two boundary, for branch targets
5110 where the targets can only be reached by jumping, skipping up to @var{n}
5111 bytes like @option{-falign-functions}. In this case, no dummy operations
5112 need be executed.
5113
5114 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5115 equivalent and mean that loops will not be aligned.
5116
5117 If @var{n} is not specified or is zero, use a machine-dependent default.
5118
5119 Enabled at levels @option{-O2}, @option{-O3}.
5120
5121 @item -funit-at-a-time
5122 @opindex funit-at-a-time
5123 Parse the whole compilation unit before starting to produce code.
5124 This allows some extra optimizations to take place but consumes
5125 more memory (in general). There are some compatibility issues
5126 with @emph{unit-at-at-time} mode:
5127 @itemize @bullet
5128 @item
5129 enabling @emph{unit-at-a-time} mode may change the order
5130 in which functions, variables, and top-level @code{asm} statements
5131 are emitted, and will likely break code relying on some particular
5132 ordering. The majority of such top-level @code{asm} statements,
5133 though, can be replaced by @code{section} attributes.
5134
5135 @item
5136 @emph{unit-at-a-time} mode removes unreferenced static variables
5137 and functions are removed. This may result in undefined references
5138 when an @code{asm} statement refers directly to variables or functions
5139 that are otherwise unused. In that case either the variable/function
5140 shall be listed as an operand of the @code{asm} statement operand or,
5141 in the case of top-level @code{asm} statements the attribute @code{used}
5142 shall be used on the declaration.
5143
5144 @item
5145 Static functions now can use non-standard passing conventions that
5146 may break @code{asm} statements calling functions directly. Again,
5147 attribute @code{used} will prevent this behavior.
5148 @end itemize
5149
5150 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5151 but this scheme may not be supported by future releases of GCC@.
5152
5153 Enabled at levels @option{-O2}, @option{-O3}.
5154
5155 @item -fweb
5156 @opindex fweb
5157 Constructs webs as commonly used for register allocation purposes and assign
5158 each web individual pseudo register. This allows the register allocation pass
5159 to operate on pseudos directly, but also strengthens several other optimization
5160 passes, such as CSE, loop optimizer and trivial dead code remover. It can,
5161 however, make debugging impossible, since variables will no longer stay in a
5162 ``home register''.
5163
5164 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os},
5165 on targets where the default format for debugging information supports
5166 variable tracking.
5167
5168 @item -fno-cprop-registers
5169 @opindex fno-cprop-registers
5170 After register allocation and post-register allocation instruction splitting,
5171 we perform a copy-propagation pass to try to reduce scheduling dependencies
5172 and occasionally eliminate the copy.
5173
5174 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5175
5176 @item -fprofile-generate
5177 @opindex fprofile-generate
5178
5179 Enable options usually used for instrumenting application to produce
5180 profile useful for later recompilation with profile feedback based
5181 optimization. You must use @option{-fprofile-generate} both when
5182 compiling and when linking your program.
5183
5184 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5185
5186 @item -fprofile-use
5187 @opindex fprofile-use
5188 Enable profile feedback directed optimizations, and optimizations
5189 generally profitable only with profile feedback available.
5190
5191 The following options are enabled: @code{-fbranch-probabilities},
5192 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
5193
5194 @end table
5195
5196 The following options control compiler behavior regarding floating
5197 point arithmetic. These options trade off between speed and
5198 correctness. All must be specifically enabled.
5199
5200 @table @gcctabopt
5201 @item -ffloat-store
5202 @opindex ffloat-store
5203 Do not store floating point variables in registers, and inhibit other
5204 options that might change whether a floating point value is taken from a
5205 register or memory.
5206
5207 @cindex floating point precision
5208 This option prevents undesirable excess precision on machines such as
5209 the 68000 where the floating registers (of the 68881) keep more
5210 precision than a @code{double} is supposed to have. Similarly for the
5211 x86 architecture. For most programs, the excess precision does only
5212 good, but a few programs rely on the precise definition of IEEE floating
5213 point. Use @option{-ffloat-store} for such programs, after modifying
5214 them to store all pertinent intermediate computations into variables.
5215
5216 @item -ffast-math
5217 @opindex ffast-math
5218 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5219 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5220 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5221 and @option{fcx-limited-range}.
5222
5223 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5224
5225 This option should never be turned on by any @option{-O} option since
5226 it can result in incorrect output for programs which depend on
5227 an exact implementation of IEEE or ISO rules/specifications for
5228 math functions.
5229
5230 @item -fno-math-errno
5231 @opindex fno-math-errno
5232 Do not set ERRNO after calling math functions that are executed
5233 with a single instruction, e.g., sqrt. A program that relies on
5234 IEEE exceptions for math error handling may want to use this flag
5235 for speed while maintaining IEEE arithmetic compatibility.
5236
5237 This option should never be turned on by any @option{-O} option since
5238 it can result in incorrect output for programs which depend on
5239 an exact implementation of IEEE or ISO rules/specifications for
5240 math functions.
5241
5242 The default is @option{-fmath-errno}.
5243
5244 @item -funsafe-math-optimizations
5245 @opindex funsafe-math-optimizations
5246 Allow optimizations for floating-point arithmetic that (a) assume
5247 that arguments and results are valid and (b) may violate IEEE or
5248 ANSI standards. When used at link-time, it may include libraries
5249 or startup files that change the default FPU control word or other
5250 similar optimizations.
5251
5252 This option should never be turned on by any @option{-O} option since
5253 it can result in incorrect output for programs which depend on
5254 an exact implementation of IEEE or ISO rules/specifications for
5255 math functions.
5256
5257 The default is @option{-fno-unsafe-math-optimizations}.
5258
5259 @item -ffinite-math-only
5260 @opindex ffinite-math-only
5261 Allow optimizations for floating-point arithmetic that assume
5262 that arguments and results are not NaNs or +-Infs.
5263
5264 This option should never be turned on by any @option{-O} option since
5265 it can result in incorrect output for programs which depend on
5266 an exact implementation of IEEE or ISO rules/specifications.
5267
5268 The default is @option{-fno-finite-math-only}.
5269
5270 @item -fno-trapping-math
5271 @opindex fno-trapping-math
5272 Compile code assuming that floating-point operations cannot generate
5273 user-visible traps. These traps include division by zero, overflow,
5274 underflow, inexact result and invalid operation. This option implies
5275 @option{-fno-signaling-nans}. Setting this option may allow faster
5276 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5277
5278 This option should never be turned on by any @option{-O} option since
5279 it can result in incorrect output for programs which depend on
5280 an exact implementation of IEEE or ISO rules/specifications for
5281 math functions.
5282
5283 The default is @option{-ftrapping-math}.
5284
5285 @item -frounding-math
5286 @opindex frounding-math
5287 Disable transformations and optimizations that assume default floating
5288 point rounding behavior. This is round-to-zero for all floating point
5289 to integer conversions, and round-to-nearest for all other arithmetic
5290 truncations. This option should be specified for programs that change
5291 the FP rounding mode dynamically, or that may be executed with a
5292 non-default rounding mode. This option disables constant folding of
5293 floating point expressions at compile-time (which may be affected by
5294 rounding mode) and arithmetic transformations that are unsafe in the
5295 presence of sign-dependent rounding modes.
5296
5297 The default is @option{-fno-rounding-math}.
5298
5299 This option is experimental and does not currently guarantee to
5300 disable all GCC optimizations that are affected by rounding mode.
5301 Future versions of GCC may provide finer control of this setting
5302 using C99's @code{FENV_ACCESS} pragma. This command line option
5303 will be used to specify the default state for @code{FENV_ACCESS}.
5304
5305 @item -fsignaling-nans
5306 @opindex fsignaling-nans
5307 Compile code assuming that IEEE signaling NaNs may generate user-visible
5308 traps during floating-point operations. Setting this option disables
5309 optimizations that may change the number of exceptions visible with
5310 signaling NaNs. This option implies @option{-ftrapping-math}.
5311
5312 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5313 be defined.
5314
5315 The default is @option{-fno-signaling-nans}.
5316
5317 This option is experimental and does not currently guarantee to
5318 disable all GCC optimizations that affect signaling NaN behavior.
5319
5320 @item -fsingle-precision-constant
5321 @opindex fsingle-precision-constant
5322 Treat floating point constant as single precision constant instead of
5323 implicitly converting it to double precision constant.
5324
5325 @item -fcx-limited-range
5326 @itemx -fno-cx-limited-range
5327 @opindex fcx-limited-range
5328 @opindex fno-cx-limited-range
5329 When enabled, this option states that a range reduction step is not
5330 needed when performing complex division. The default is
5331 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5332
5333 This option controls the default setting of the ISO C99
5334 @code{CX_LIMITED_RANGE} pragma. Nevertheless, the option applies to
5335 all languages.
5336
5337 @end table
5338
5339 The following options control optimizations that may improve
5340 performance, but are not enabled by any @option{-O} options. This
5341 section includes experimental options that may produce broken code.
5342
5343 @table @gcctabopt
5344 @item -fbranch-probabilities
5345 @opindex fbranch-probabilities
5346 After running a program compiled with @option{-fprofile-arcs}
5347 (@pxref{Debugging Options,, Options for Debugging Your Program or
5348 @command{gcc}}), you can compile it a second time using
5349 @option{-fbranch-probabilities}, to improve optimizations based on
5350 the number of times each branch was taken. When the program
5351 compiled with @option{-fprofile-arcs} exits it saves arc execution
5352 counts to a file called @file{@var{sourcename}.gcda} for each source
5353 file The information in this data file is very dependent on the
5354 structure of the generated code, so you must use the same source code
5355 and the same optimization options for both compilations.
5356
5357 With @option{-fbranch-probabilities}, GCC puts a
5358 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5359 These can be used to improve optimization. Currently, they are only
5360 used in one place: in @file{reorg.c}, instead of guessing which path a
5361 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5362 exactly determine which path is taken more often.
5363
5364 @item -fprofile-values
5365 @opindex fprofile-values
5366 If combined with @option{-fprofile-arcs}, it adds code so that some
5367 data about values of expressions in the program is gathered.
5368
5369 With @option{-fbranch-probabilities}, it reads back the data gathered
5370 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5371 notes to instructions for their later usage in optimizations.
5372
5373 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5374
5375 @item -fvpt
5376 @opindex fvpt
5377 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5378 a code to gather information about values of expressions.
5379
5380 With @option{-fbranch-probabilities}, it reads back the data gathered
5381 and actually performs the optimizations based on them.
5382 Currently the optimizations include specialization of division operation
5383 using the knowledge about the value of the denominator.
5384
5385 @item -fspeculative-prefetching
5386 @opindex fspeculative-prefetching
5387 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5388 a code to gather information about addresses of memory references in the
5389 program.
5390
5391 With @option{-fbranch-probabilities}, it reads back the data gathered
5392 and issues prefetch instructions according to them. In addition to the opportunities
5393 noticed by @option{-fprefetch-loop-arrays}, it also notices more complicated
5394 memory access patterns---for example accesses to the data stored in linked
5395 list whose elements are usually allocated sequentially.
5396
5397 In order to prevent issuing double prefetches, usage of
5398 @option{-fspeculative-prefetching} implies @option{-fno-prefetch-loop-arrays}.
5399
5400 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5401
5402 @item -frename-registers
5403 @opindex frename-registers
5404 Attempt to avoid false dependencies in scheduled code by making use
5405 of registers left over after register allocation. This optimization
5406 will most benefit processors with lots of registers. Depending on the
5407 debug information format adopted by the target, however, it can
5408 make debugging impossible, since variables will no longer stay in
5409 a ``home register''.
5410
5411 Not enabled by default at any level because it has known bugs.
5412
5413 @item -ftracer
5414 @opindex ftracer
5415 Perform tail duplication to enlarge superblock size. This transformation
5416 simplifies the control flow of the function allowing other optimizations to do
5417 better job.
5418
5419 Enabled with @option{-fprofile-use}.
5420
5421 @item -funroll-loops
5422 @opindex funroll-loops
5423 Unroll loops whose number of iterations can be determined at compile time or
5424 upon entry to the loop. @option{-funroll-loops} implies
5425 @option{-frerun-cse-after-loop}. It also turns on complete loop peeling
5426 (i.e.@: complete removal of loops with small constant number of iterations).
5427 This option makes code larger, and may or may not make it run faster.
5428
5429 Enabled with @option{-fprofile-use}.
5430
5431 @item -funroll-all-loops
5432 @opindex funroll-all-loops
5433 Unroll all loops, even if their number of iterations is uncertain when
5434 the loop is entered. This usually makes programs run more slowly.
5435 @option{-funroll-all-loops} implies the same options as
5436 @option{-funroll-loops}.
5437
5438 @item -fpeel-loops
5439 @opindex fpeel-loops
5440 Peels the loops for that there is enough information that they do not
5441 roll much (from profile feedback). It also turns on complete loop peeling
5442 (i.e.@: complete removal of loops with small constant number of iterations).
5443
5444 Enabled with @option{-fprofile-use}.
5445
5446 @item -fmove-loop-invariants
5447 @opindex fmove-loop-invariants
5448 Enables the loop invariant motion pass in the new loop optimizer. Enabled
5449 at level @option{-O1}
5450
5451 @item -funswitch-loops
5452 @opindex funswitch-loops
5453 Move branches with loop invariant conditions out of the loop, with duplicates
5454 of the loop on both branches (modified according to result of the condition).
5455
5456 @item -fprefetch-loop-arrays
5457 @opindex fprefetch-loop-arrays
5458 If supported by the target machine, generate instructions to prefetch
5459 memory to improve the performance of loops that access large arrays.
5460
5461 Disabled at level @option{-Os}.
5462
5463 @item -ffunction-sections
5464 @itemx -fdata-sections
5465 @opindex ffunction-sections
5466 @opindex fdata-sections
5467 Place each function or data item into its own section in the output
5468 file if the target supports arbitrary sections. The name of the
5469 function or the name of the data item determines the section's name
5470 in the output file.
5471
5472 Use these options on systems where the linker can perform optimizations
5473 to improve locality of reference in the instruction space. Most systems
5474 using the ELF object format and SPARC processors running Solaris 2 have
5475 linkers with such optimizations. AIX may have these optimizations in
5476 the future.
5477
5478 Only use these options when there are significant benefits from doing
5479 so. When you specify these options, the assembler and linker will
5480 create larger object and executable files and will also be slower.
5481 You will not be able to use @code{gprof} on all systems if you
5482 specify this option and you may have problems with debugging if
5483 you specify both this option and @option{-g}.
5484
5485 @item -fbranch-target-load-optimize
5486 @opindex fbranch-target-load-optimize
5487 Perform branch target register load optimization before prologue / epilogue
5488 threading.
5489 The use of target registers can typically be exposed only during reload,
5490 thus hoisting loads out of loops and doing inter-block scheduling needs
5491 a separate optimization pass.
5492
5493 @item -fbranch-target-load-optimize2
5494 @opindex fbranch-target-load-optimize2
5495 Perform branch target register load optimization after prologue / epilogue
5496 threading.
5497
5498 @item -fbtr-bb-exclusive
5499 @opindex fbtr-bb-exclusive
5500 When performing branch target register load optimization, don't reuse
5501 branch target registers in within any basic block.
5502
5503 @item --param @var{name}=@var{value}
5504 @opindex param
5505 In some places, GCC uses various constants to control the amount of
5506 optimization that is done. For example, GCC will not inline functions
5507 that contain more that a certain number of instructions. You can
5508 control some of these constants on the command-line using the
5509 @option{--param} option.
5510
5511 The names of specific parameters, and the meaning of the values, are
5512 tied to the internals of the compiler, and are subject to change
5513 without notice in future releases.
5514
5515 In each case, the @var{value} is an integer. The allowable choices for
5516 @var{name} are given in the following table:
5517
5518 @table @gcctabopt
5519 @item salias-max-implicit-fields
5520 The maximum number of fields in a variable without direct
5521 structure accesses for which structure aliasing will consider trying
5522 to track each field. The default is 5
5523
5524 @item sra-max-structure-size
5525 The maximum structure size, in bytes, at which the scalar replacement
5526 of aggregates (SRA) optimization will perform block copies. The
5527 default value, 0, implies that GCC will select the most appropriate
5528 size itself.
5529
5530 @item sra-field-structure-ratio
5531 The threshold ratio (as a percentage) between instantiated fields and
5532 the complete structure size. We say that if the ratio of the number
5533 of bytes in instantiated fields to the number of bytes in the complete
5534 structure exceeds this parameter, then block copies are not used. The
5535 default is 75.
5536
5537 @item max-crossjump-edges
5538 The maximum number of incoming edges to consider for crossjumping.
5539 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5540 the number of edges incoming to each block. Increasing values mean
5541 more aggressive optimization, making the compile time increase with
5542 probably small improvement in executable size.
5543
5544 @item min-crossjump-insns
5545 The minimum number of instructions which must be matched at the end
5546 of two blocks before crossjumping will be performed on them. This
5547 value is ignored in the case where all instructions in the block being
5548 crossjumped from are matched. The default value is 5.
5549
5550 @item max-goto-duplication-insns
5551 The maximum number of instructions to duplicate to a block that jumps
5552 to a computed goto. To avoid @math{O(N^2)} behavior in a number of
5553 passes, GCC factors computed gotos early in the compilation process,
5554 and unfactors them as late as possible. Only computed jumps at the
5555 end of a basic blocks with no more than max-goto-duplication-insns are
5556 unfactored. The default value is 8.
5557
5558 @item max-delay-slot-insn-search
5559 The maximum number of instructions to consider when looking for an
5560 instruction to fill a delay slot. If more than this arbitrary number of
5561 instructions is searched, the time savings from filling the delay slot
5562 will be minimal so stop searching. Increasing values mean more
5563 aggressive optimization, making the compile time increase with probably
5564 small improvement in executable run time.
5565
5566 @item max-delay-slot-live-search
5567 When trying to fill delay slots, the maximum number of instructions to
5568 consider when searching for a block with valid live register
5569 information. Increasing this arbitrarily chosen value means more
5570 aggressive optimization, increasing the compile time. This parameter
5571 should be removed when the delay slot code is rewritten to maintain the
5572 control-flow graph.
5573
5574 @item max-gcse-memory
5575 The approximate maximum amount of memory that will be allocated in
5576 order to perform the global common subexpression elimination
5577 optimization. If more memory than specified is required, the
5578 optimization will not be done.
5579
5580 @item max-gcse-passes
5581 The maximum number of passes of GCSE to run. The default is 1.
5582
5583 @item max-pending-list-length
5584 The maximum number of pending dependencies scheduling will allow
5585 before flushing the current state and starting over. Large functions
5586 with few branches or calls can create excessively large lists which
5587 needlessly consume memory and resources.
5588
5589 @item max-inline-insns-single
5590 Several parameters control the tree inliner used in gcc.
5591 This number sets the maximum number of instructions (counted in GCC's
5592 internal representation) in a single function that the tree inliner
5593 will consider for inlining. This only affects functions declared
5594 inline and methods implemented in a class declaration (C++).
5595 The default value is 450.
5596
5597 @item max-inline-insns-auto
5598 When you use @option{-finline-functions} (included in @option{-O3}),
5599 a lot of functions that would otherwise not be considered for inlining
5600 by the compiler will be investigated. To those functions, a different
5601 (more restrictive) limit compared to functions declared inline can
5602 be applied.
5603 The default value is 90.
5604
5605 @item large-function-insns
5606 The limit specifying really large functions. For functions larger than this
5607 limit after inlining inlining is constrained by
5608 @option{--param large-function-growth}. This parameter is useful primarily
5609 to avoid extreme compilation time caused by non-linear algorithms used by the
5610 backend.
5611 This parameter is ignored when @option{-funit-at-a-time} is not used.
5612 The default value is 2700.
5613
5614 @item large-function-growth
5615 Specifies maximal growth of large function caused by inlining in percents.
5616 This parameter is ignored when @option{-funit-at-a-time} is not used.
5617 The default value is 100 which limits large function growth to 2.0 times
5618 the original size.
5619
5620 @item inline-unit-growth
5621 Specifies maximal overall growth of the compilation unit caused by inlining.
5622 This parameter is ignored when @option{-funit-at-a-time} is not used.
5623 The default value is 50 which limits unit growth to 1.5 times the original
5624 size.
5625
5626 @item max-inline-insns-recursive
5627 @itemx max-inline-insns-recursive-auto
5628 Specifies maximum number of instructions out-of-line copy of self recursive inline
5629 function can grow into by performing recursive inlining.
5630
5631 For functions declared inline @option{--param max-inline-insns-recursive} is
5632 taken into acount. For function not declared inline, recursive inlining
5633 happens only when @option{-finline-functions} (included in @option{-O3}) is
5634 enabled and @option{--param max-inline-insns-recursive-auto} is used. The
5635 default value is 450.
5636
5637 @item max-inline-recursive-depth
5638 @itemx max-inline-recursive-depth-auto
5639 Specifies maximum recursion depth used by the recursive inlining.
5640
5641 For functions declared inline @option{--param max-inline-recursive-depth} is
5642 taken into acount. For function not declared inline, recursive inlining
5643 happens only when @option{-finline-functions} (included in @option{-O3}) is
5644 enabled and @option{--param max-inline-recursive-depth-auto} is used. The
5645 default value is 450.
5646
5647 @item inline-call-cost
5648 Specify cost of call instruction relative to simple arithmetics operations
5649 (having cost of 1). Increasing this cost disqualifies inlining of non-leaf
5650 functions and at the same time increases size of leaf function that is believed to
5651 reduce function size by being inlined. In effect it increases amount of
5652 inlining for code having large abstraction penalty (many functions that just
5653 pass the arguments to other functions) and decrease inlining for code with low
5654 abstraction penalty. The default value is 16.
5655
5656 @item max-unrolled-insns
5657 The maximum number of instructions that a loop should have if that loop
5658 is unrolled, and if the loop is unrolled, it determines how many times
5659 the loop code is unrolled.
5660
5661 @item max-average-unrolled-insns
5662 The maximum number of instructions biased by probabilities of their execution
5663 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5664 it determines how many times the loop code is unrolled.
5665
5666 @item max-unroll-times
5667 The maximum number of unrollings of a single loop.
5668
5669 @item max-peeled-insns
5670 The maximum number of instructions that a loop should have if that loop
5671 is peeled, and if the loop is peeled, it determines how many times
5672 the loop code is peeled.
5673
5674 @item max-peel-times
5675 The maximum number of peelings of a single loop.
5676
5677 @item max-completely-peeled-insns
5678 The maximum number of insns of a completely peeled loop.
5679
5680 @item max-completely-peel-times
5681 The maximum number of iterations of a loop to be suitable for complete peeling.
5682
5683 @item max-unswitch-insns
5684 The maximum number of insns of an unswitched loop.
5685
5686 @item max-unswitch-level
5687 The maximum number of branches unswitched in a single loop.
5688
5689 @item lim-expensive
5690 The minimum cost of an expensive expression in the loop invariant motion.
5691
5692 @item iv-consider-all-candidates-bound
5693 Bound on number of candidates for induction variables below that
5694 all candidates are considered for each use in induction variable
5695 optimizations. Only the most relevant candidates are considered
5696 if there are more candidates, to avoid quadratic time complexity.
5697
5698 @item iv-max-considered-uses
5699 The induction variable optimizations give up on loops that contain more
5700 induction variable uses.
5701
5702 @item iv-always-prune-cand-set-bound
5703 If number of candidates in the set is smaller than this value,
5704 we always try to remove unnecessary ivs from the set during its
5705 optimization when a new iv is added to the set.
5706
5707 @item scev-max-expr-size
5708 Bound on size of expressions used in the scalar evolutions analyzer.
5709 Large expressions slow the analyzer.
5710
5711 @item max-iterations-to-track
5712
5713 The maximum number of iterations of a loop the brute force algorithm
5714 for analysis of # of iterations of the loop tries to evaluate.
5715
5716 @item hot-bb-count-fraction
5717 Select fraction of the maximal count of repetitions of basic block in program
5718 given basic block needs to have to be considered hot.
5719
5720 @item hot-bb-frequency-fraction
5721 Select fraction of the maximal frequency of executions of basic block in
5722 function given basic block needs to have to be considered hot
5723
5724 @item tracer-dynamic-coverage
5725 @itemx tracer-dynamic-coverage-feedback
5726
5727 This value is used to limit superblock formation once the given percentage of
5728 executed instructions is covered. This limits unnecessary code size
5729 expansion.
5730
5731 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5732 feedback is available. The real profiles (as opposed to statically estimated
5733 ones) are much less balanced allowing the threshold to be larger value.
5734
5735 @item tracer-max-code-growth
5736 Stop tail duplication once code growth has reached given percentage. This is
5737 rather hokey argument, as most of the duplicates will be eliminated later in
5738 cross jumping, so it may be set to much higher values than is the desired code
5739 growth.
5740
5741 @item tracer-min-branch-ratio
5742
5743 Stop reverse growth when the reverse probability of best edge is less than this
5744 threshold (in percent).
5745
5746 @item tracer-min-branch-ratio
5747 @itemx tracer-min-branch-ratio-feedback
5748
5749 Stop forward growth if the best edge do have probability lower than this
5750 threshold.
5751
5752 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5753 compilation for profile feedback and one for compilation without. The value
5754 for compilation with profile feedback needs to be more conservative (higher) in
5755 order to make tracer effective.
5756
5757 @item max-cse-path-length
5758
5759 Maximum number of basic blocks on path that cse considers. The default is 10.
5760
5761 @item global-var-threshold
5762
5763 Counts the number of function calls (@var{n}) and the number of
5764 call-clobbered variables (@var{v}). If @var{n}x@var{v} is larger than this limit, a
5765 single artificial variable will be created to represent all the
5766 call-clobbered variables at function call sites. This artificial
5767 variable will then be made to alias every call-clobbered variable.
5768 (done as @code{int * size_t} on the host machine; beware overflow).
5769
5770 @item max-aliased-vops
5771
5772 Maximum number of virtual operands allowed to represent aliases
5773 before triggering the alias grouping heuristic. Alias grouping
5774 reduces compile times and memory consumption needed for aliasing at
5775 the expense of precision loss in alias information.
5776
5777 @item ggc-min-expand
5778
5779 GCC uses a garbage collector to manage its own memory allocation. This
5780 parameter specifies the minimum percentage by which the garbage
5781 collector's heap should be allowed to expand between collections.
5782 Tuning this may improve compilation speed; it has no effect on code
5783 generation.
5784
5785 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5786 RAM >= 1GB@. If @code{getrlimit} is available, the notion of "RAM" is
5787 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}. If
5788 GCC is not able to calculate RAM on a particular platform, the lower
5789 bound of 30% is used. Setting this parameter and
5790 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5791 every opportunity. This is extremely slow, but can be useful for
5792 debugging.
5793
5794 @item ggc-min-heapsize
5795
5796 Minimum size of the garbage collector's heap before it begins bothering
5797 to collect garbage. The first collection occurs after the heap expands
5798 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}. Again,
5799 tuning this may improve compilation speed, and has no effect on code
5800 generation.
5801
5802 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5803 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5804 with a lower bound of 4096 (four megabytes) and an upper bound of
5805 131072 (128 megabytes). If GCC is not able to calculate RAM on a
5806 particular platform, the lower bound is used. Setting this parameter
5807 very large effectively disables garbage collection. Setting this
5808 parameter and @option{ggc-min-expand} to zero causes a full collection
5809 to occur at every opportunity.
5810
5811 @item max-reload-search-insns
5812 The maximum number of instruction reload should look backward for equivalent
5813 register. Increasing values mean more aggressive optimization, making the
5814 compile time increase with probably slightly better performance. The default
5815 value is 100.
5816
5817 @item max-cselib-memory-location
5818 The maximum number of memory locations cselib should take into acount.
5819 Increasing values mean more aggressive optimization, making the compile time
5820 increase with probably slightly better performance. The default value is 500.
5821
5822 @item reorder-blocks-duplicate
5823 @itemx reorder-blocks-duplicate-feedback
5824
5825 Used by basic block reordering pass to decide whether to use unconditional
5826 branch or duplicate the code on its destination. Code is duplicated when its
5827 estimated size is smaller than this value multiplied by the estimated size of
5828 unconditional jump in the hot spots of the program.
5829
5830 The @option{reorder-block-duplicate-feedback} is used only when profile
5831 feedback is available and may be set to higher values than
5832 @option{reorder-block-duplicate} since information about the hot spots is more
5833 accurate.
5834
5835 @item max-sched-region-blocks
5836 The maximum number of blocks in a region to be considered for
5837 interblock scheduling. The default value is 10.
5838
5839 @item max-sched-region-insns
5840 The maximum number of insns in a region to be considered for
5841 interblock scheduling. The default value is 100.
5842
5843 @item max-last-value-rtl
5844
5845 The maximum size measured as number of RTLs that can be recorded in an expression
5846 in combiner for a pseudo register as last known value of that register. The default
5847 is 10000.
5848
5849 @item integer-share-limit
5850 Small integer constants can use a shared data structure, reducing the
5851 compiler's memory usage and increasing its speed. This sets the maximum
5852 value of a shared integer constant's. The default value is 256.
5853
5854 @item min-virtual-mappings
5855 Specifies the minimum number of virtual mappings in the incremental
5856 SSA updater that should be registered to trigger the virtual mappings
5857 heuristic defined by virtual-mappings-ratio. The default value is
5858 100.
5859
5860 @item virtual-mappings-ratio
5861 If the number of virtual mappings is virtual-mappings-ratio bigger
5862 than the number of virtual symbols to be updated, then the incremental
5863 SSA updater switches to a full update for those symbols. The default
5864 ratio is 3.
5865
5866 @end table
5867 @end table
5868
5869 @node Preprocessor Options
5870 @section Options Controlling the Preprocessor
5871 @cindex preprocessor options
5872 @cindex options, preprocessor
5873
5874 These options control the C preprocessor, which is run on each C source
5875 file before actual compilation.
5876
5877 If you use the @option{-E} option, nothing is done except preprocessing.
5878 Some of these options make sense only together with @option{-E} because
5879 they cause the preprocessor output to be unsuitable for actual
5880 compilation.
5881
5882 @table @gcctabopt
5883 @opindex Wp
5884 You can use @option{-Wp,@var{option}} to bypass the compiler driver
5885 and pass @var{option} directly through to the preprocessor. If
5886 @var{option} contains commas, it is split into multiple options at the
5887 commas. However, many options are modified, translated or interpreted
5888 by the compiler driver before being passed to the preprocessor, and
5889 @option{-Wp} forcibly bypasses this phase. The preprocessor's direct
5890 interface is undocumented and subject to change, so whenever possible
5891 you should avoid using @option{-Wp} and let the driver handle the
5892 options instead.
5893
5894 @item -Xpreprocessor @var{option}
5895 @opindex preprocessor
5896 Pass @var{option} as an option to the preprocessor. You can use this to
5897 supply system-specific preprocessor options which GCC does not know how to
5898 recognize.
5899
5900 If you want to pass an option that takes an argument, you must use
5901 @option{-Xpreprocessor} twice, once for the option and once for the argument.
5902 @end table
5903
5904 @include cppopts.texi
5905
5906 @node Assembler Options
5907 @section Passing Options to the Assembler
5908
5909 @c prevent bad page break with this line
5910 You can pass options to the assembler.
5911
5912 @table @gcctabopt
5913 @item -Wa,@var{option}
5914 @opindex Wa
5915 Pass @var{option} as an option to the assembler. If @var{option}
5916 contains commas, it is split into multiple options at the commas.
5917
5918 @item -Xassembler @var{option}
5919 @opindex Xassembler
5920 Pass @var{option} as an option to the assembler. You can use this to
5921 supply system-specific assembler options which GCC does not know how to
5922 recognize.
5923
5924 If you want to pass an option that takes an argument, you must use
5925 @option{-Xassembler} twice, once for the option and once for the argument.
5926
5927 @end table
5928
5929 @node Link Options
5930 @section Options for Linking
5931 @cindex link options
5932 @cindex options, linking
5933
5934 These options come into play when the compiler links object files into
5935 an executable output file. They are meaningless if the compiler is
5936 not doing a link step.
5937
5938 @table @gcctabopt
5939 @cindex file names
5940 @item @var{object-file-name}
5941 A file name that does not end in a special recognized suffix is
5942 considered to name an object file or library. (Object files are
5943 distinguished from libraries by the linker according to the file
5944 contents.) If linking is done, these object files are used as input
5945 to the linker.
5946
5947 @item -c
5948 @itemx -S
5949 @itemx -E
5950 @opindex c
5951 @opindex S
5952 @opindex E
5953 If any of these options is used, then the linker is not run, and
5954 object file names should not be used as arguments. @xref{Overall
5955 Options}.
5956
5957 @cindex Libraries
5958 @item -l@var{library}
5959 @itemx -l @var{library}
5960 @opindex l
5961 Search the library named @var{library} when linking. (The second
5962 alternative with the library as a separate argument is only for
5963 POSIX compliance and is not recommended.)
5964
5965 It makes a difference where in the command you write this option; the
5966 linker searches and processes libraries and object files in the order they
5967 are specified. Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
5968 after file @file{foo.o} but before @file{bar.o}. If @file{bar.o} refers
5969 to functions in @samp{z}, those functions may not be loaded.
5970
5971 The linker searches a standard list of directories for the library,
5972 which is actually a file named @file{lib@var{library}.a}. The linker
5973 then uses this file as if it had been specified precisely by name.
5974
5975 The directories searched include several standard system directories
5976 plus any that you specify with @option{-L}.
5977
5978 Normally the files found this way are library files---archive files
5979 whose members are object files. The linker handles an archive file by
5980 scanning through it for members which define symbols that have so far
5981 been referenced but not defined. But if the file that is found is an
5982 ordinary object file, it is linked in the usual fashion. The only
5983 difference between using an @option{-l} option and specifying a file name
5984 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5985 and searches several directories.
5986
5987 @item -lobjc
5988 @opindex lobjc
5989 You need this special case of the @option{-l} option in order to
5990 link an Objective-C or Objective-C++ program.
5991
5992 @item -nostartfiles
5993 @opindex nostartfiles
5994 Do not use the standard system startup files when linking.
5995 The standard system libraries are used normally, unless @option{-nostdlib}
5996 or @option{-nodefaultlibs} is used.
5997
5998 @item -nodefaultlibs
5999 @opindex nodefaultlibs
6000 Do not use the standard system libraries when linking.
6001 Only the libraries you specify will be passed to the linker.
6002 The standard startup files are used normally, unless @option{-nostartfiles}
6003 is used. The compiler may generate calls to @code{memcmp},
6004 @code{memset}, @code{memcpy} and @code{memmove}.
6005 These entries are usually resolved by entries in
6006 libc. These entry points should be supplied through some other
6007 mechanism when this option is specified.
6008
6009 @item -nostdlib
6010 @opindex nostdlib
6011 Do not use the standard system startup files or libraries when linking.
6012 No startup files and only the libraries you specify will be passed to
6013 the linker. The compiler may generate calls to @code{memcmp}, @code{memset},
6014 @code{memcpy} and @code{memmove}.
6015 These entries are usually resolved by entries in
6016 libc. These entry points should be supplied through some other
6017 mechanism when this option is specified.
6018
6019 @cindex @option{-lgcc}, use with @option{-nostdlib}
6020 @cindex @option{-nostdlib} and unresolved references
6021 @cindex unresolved references and @option{-nostdlib}
6022 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6023 @cindex @option{-nodefaultlibs} and unresolved references
6024 @cindex unresolved references and @option{-nodefaultlibs}
6025 One of the standard libraries bypassed by @option{-nostdlib} and
6026 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6027 that GCC uses to overcome shortcomings of particular machines, or special
6028 needs for some languages.
6029 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6030 Collection (GCC) Internals},
6031 for more discussion of @file{libgcc.a}.)
6032 In most cases, you need @file{libgcc.a} even when you want to avoid
6033 other standard libraries. In other words, when you specify @option{-nostdlib}
6034 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6035 This ensures that you have no unresolved references to internal GCC
6036 library subroutines. (For example, @samp{__main}, used to ensure C++
6037 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6038 GNU Compiler Collection (GCC) Internals}.)
6039
6040 @item -pie
6041 @opindex pie
6042 Produce a position independent executable on targets which support it.
6043 For predictable results, you must also specify the same set of options
6044 that were used to generate code (@option{-fpie}, @option{-fPIE},
6045 or model suboptions) when you specify this option.
6046
6047 @item -s
6048 @opindex s
6049 Remove all symbol table and relocation information from the executable.
6050
6051 @item -static
6052 @opindex static
6053 On systems that support dynamic linking, this prevents linking with the shared
6054 libraries. On other systems, this option has no effect.
6055
6056 @item -shared
6057 @opindex shared
6058 Produce a shared object which can then be linked with other objects to
6059 form an executable. Not all systems support this option. For predictable
6060 results, you must also specify the same set of options that were used to
6061 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6062 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6063 needs to build supplementary stub code for constructors to work. On
6064 multi-libbed systems, @samp{gcc -shared} must select the correct support
6065 libraries to link against. Failing to supply the correct flags may lead
6066 to subtle defects. Supplying them in cases where they are not necessary
6067 is innocuous.}
6068
6069 @item -shared-libgcc
6070 @itemx -static-libgcc
6071 @opindex shared-libgcc
6072 @opindex static-libgcc
6073 On systems that provide @file{libgcc} as a shared library, these options
6074 force the use of either the shared or static version respectively.
6075 If no shared version of @file{libgcc} was built when the compiler was
6076 configured, these options have no effect.
6077
6078 There are several situations in which an application should use the
6079 shared @file{libgcc} instead of the static version. The most common
6080 of these is when the application wishes to throw and catch exceptions
6081 across different shared libraries. In that case, each of the libraries
6082 as well as the application itself should use the shared @file{libgcc}.
6083
6084 Therefore, the G++ and GCJ drivers automatically add
6085 @option{-shared-libgcc} whenever you build a shared library or a main
6086 executable, because C++ and Java programs typically use exceptions, so
6087 this is the right thing to do.
6088
6089 If, instead, you use the GCC driver to create shared libraries, you may
6090 find that they will not always be linked with the shared @file{libgcc}.
6091 If GCC finds, at its configuration time, that you have a non-GNU linker
6092 or a GNU linker that does not support option @option{--eh-frame-hdr},
6093 it will link the shared version of @file{libgcc} into shared libraries
6094 by default. Otherwise, it will take advantage of the linker and optimize
6095 away the linking with the shared version of @file{libgcc}, linking with
6096 the static version of libgcc by default. This allows exceptions to
6097 propagate through such shared libraries, without incurring relocation
6098 costs at library load time.
6099
6100 However, if a library or main executable is supposed to throw or catch
6101 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6102 for the languages used in the program, or using the option
6103 @option{-shared-libgcc}, such that it is linked with the shared
6104 @file{libgcc}.
6105
6106 @item -symbolic
6107 @opindex symbolic
6108 Bind references to global symbols when building a shared object. Warn
6109 about any unresolved references (unless overridden by the link editor
6110 option @samp{-Xlinker -z -Xlinker defs}). Only a few systems support
6111 this option.
6112
6113 @item -Xlinker @var{option}
6114 @opindex Xlinker
6115 Pass @var{option} as an option to the linker. You can use this to
6116 supply system-specific linker options which GCC does not know how to
6117 recognize.
6118
6119 If you want to pass an option that takes an argument, you must use
6120 @option{-Xlinker} twice, once for the option and once for the argument.
6121 For example, to pass @option{-assert definitions}, you must write
6122 @samp{-Xlinker -assert -Xlinker definitions}. It does not work to write
6123 @option{-Xlinker "-assert definitions"}, because this passes the entire
6124 string as a single argument, which is not what the linker expects.
6125
6126 @item -Wl,@var{option}
6127 @opindex Wl
6128 Pass @var{option} as an option to the linker. If @var{option} contains
6129 commas, it is split into multiple options at the commas.
6130
6131 @item -u @var{symbol}
6132 @opindex u
6133 Pretend the symbol @var{symbol} is undefined, to force linking of
6134 library modules to define it. You can use @option{-u} multiple times with
6135 different symbols to force loading of additional library modules.
6136 @end table
6137
6138 @node Directory Options
6139 @section Options for Directory Search
6140 @cindex directory options
6141 @cindex options, directory search
6142 @cindex search path
6143
6144 These options specify directories to search for header files, for
6145 libraries and for parts of the compiler:
6146
6147 @table @gcctabopt
6148 @item -I@var{dir}
6149 @opindex I
6150 Add the directory @var{dir} to the head of the list of directories to be
6151 searched for header files. This can be used to override a system header
6152 file, substituting your own version, since these directories are
6153 searched before the system header file directories. However, you should
6154 not use this option to add directories that contain vendor-supplied
6155 system header files (use @option{-isystem} for that). If you use more than
6156 one @option{-I} option, the directories are scanned in left-to-right
6157 order; the standard system directories come after.
6158
6159 If a standard system include directory, or a directory specified with
6160 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6161 option will be ignored. The directory will still be searched but as a
6162 system directory at its normal position in the system include chain.
6163 This is to ensure that GCC's procedure to fix buggy system headers and
6164 the ordering for the include_next directive are not inadvertently changed.
6165 If you really need to change the search order for system directories,
6166 use the @option{-nostdinc} and/or @option{-isystem} options.
6167
6168 @item -iquote@var{dir}
6169 @opindex iquote
6170 Add the directory @var{dir} to the head of the list of directories to
6171 be searched for header files only for the case of @samp{#include
6172 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6173 otherwise just like @option{-I}.
6174
6175 @item -L@var{dir}
6176 @opindex L
6177 Add directory @var{dir} to the list of directories to be searched
6178 for @option{-l}.
6179
6180 @item -B@var{prefix}
6181 @opindex B
6182 This option specifies where to find the executables, libraries,
6183 include files, and data files of the compiler itself.
6184
6185 The compiler driver program runs one or more of the subprograms
6186 @file{cpp}, @file{cc1}, @file{as} and @file{ld}. It tries
6187 @var{prefix} as a prefix for each program it tries to run, both with and
6188 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6189
6190 For each subprogram to be run, the compiler driver first tries the
6191 @option{-B} prefix, if any. If that name is not found, or if @option{-B}
6192 was not specified, the driver tries two standard prefixes, which are
6193 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}. If neither of
6194 those results in a file name that is found, the unmodified program
6195 name is searched for using the directories specified in your
6196 @env{PATH} environment variable.
6197
6198 The compiler will check to see if the path provided by the @option{-B}
6199 refers to a directory, and if necessary it will add a directory
6200 separator character at the end of the path.
6201
6202 @option{-B} prefixes that effectively specify directory names also apply
6203 to libraries in the linker, because the compiler translates these
6204 options into @option{-L} options for the linker. They also apply to
6205 includes files in the preprocessor, because the compiler translates these
6206 options into @option{-isystem} options for the preprocessor. In this case,
6207 the compiler appends @samp{include} to the prefix.
6208
6209 The run-time support file @file{libgcc.a} can also be searched for using
6210 the @option{-B} prefix, if needed. If it is not found there, the two
6211 standard prefixes above are tried, and that is all. The file is left
6212 out of the link if it is not found by those means.
6213
6214 Another way to specify a prefix much like the @option{-B} prefix is to use
6215 the environment variable @env{GCC_EXEC_PREFIX}. @xref{Environment
6216 Variables}.
6217
6218 As a special kludge, if the path provided by @option{-B} is
6219 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6220 9, then it will be replaced by @file{[dir/]include}. This is to help
6221 with boot-strapping the compiler.
6222
6223 @item -specs=@var{file}
6224 @opindex specs
6225 Process @var{file} after the compiler reads in the standard @file{specs}
6226 file, in order to override the defaults that the @file{gcc} driver
6227 program uses when determining what switches to pass to @file{cc1},
6228 @file{cc1plus}, @file{as}, @file{ld}, etc. More than one
6229 @option{-specs=@var{file}} can be specified on the command line, and they
6230 are processed in order, from left to right.
6231
6232 @item -I-
6233 @opindex I-
6234 This option has been deprecated. Please use @option{-iquote} instead for
6235 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6236 Any directories you specify with @option{-I} options before the @option{-I-}
6237 option are searched only for the case of @samp{#include "@var{file}"};
6238 they are not searched for @samp{#include <@var{file}>}.
6239
6240 If additional directories are specified with @option{-I} options after
6241 the @option{-I-}, these directories are searched for all @samp{#include}
6242 directives. (Ordinarily @emph{all} @option{-I} directories are used
6243 this way.)
6244
6245 In addition, the @option{-I-} option inhibits the use of the current
6246 directory (where the current input file came from) as the first search
6247 directory for @samp{#include "@var{file}"}. There is no way to
6248 override this effect of @option{-I-}. With @option{-I.} you can specify
6249 searching the directory which was current when the compiler was
6250 invoked. That is not exactly the same as what the preprocessor does
6251 by default, but it is often satisfactory.
6252
6253 @option{-I-} does not inhibit the use of the standard system directories
6254 for header files. Thus, @option{-I-} and @option{-nostdinc} are
6255 independent.
6256 @end table
6257
6258 @c man end
6259
6260 @node Spec Files
6261 @section Specifying subprocesses and the switches to pass to them
6262 @cindex Spec Files
6263
6264 @command{gcc} is a driver program. It performs its job by invoking a
6265 sequence of other programs to do the work of compiling, assembling and
6266 linking. GCC interprets its command-line parameters and uses these to
6267 deduce which programs it should invoke, and which command-line options
6268 it ought to place on their command lines. This behavior is controlled
6269 by @dfn{spec strings}. In most cases there is one spec string for each
6270 program that GCC can invoke, but a few programs have multiple spec
6271 strings to control their behavior. The spec strings built into GCC can
6272 be overridden by using the @option{-specs=} command-line switch to specify
6273 a spec file.
6274
6275 @dfn{Spec files} are plaintext files that are used to construct spec
6276 strings. They consist of a sequence of directives separated by blank
6277 lines. The type of directive is determined by the first non-whitespace
6278 character on the line and it can be one of the following:
6279
6280 @table @code
6281 @item %@var{command}
6282 Issues a @var{command} to the spec file processor. The commands that can
6283 appear here are:
6284
6285 @table @code
6286 @item %include <@var{file}>
6287 @cindex %include
6288 Search for @var{file} and insert its text at the current point in the
6289 specs file.
6290
6291 @item %include_noerr <@var{file}>
6292 @cindex %include_noerr
6293 Just like @samp{%include}, but do not generate an error message if the include
6294 file cannot be found.
6295
6296 @item %rename @var{old_name} @var{new_name}
6297 @cindex %rename
6298 Rename the spec string @var{old_name} to @var{new_name}.
6299
6300 @end table
6301
6302 @item *[@var{spec_name}]:
6303 This tells the compiler to create, override or delete the named spec
6304 string. All lines after this directive up to the next directive or
6305 blank line are considered to be the text for the spec string. If this
6306 results in an empty string then the spec will be deleted. (Or, if the
6307 spec did not exist, then nothing will happened.) Otherwise, if the spec
6308 does not currently exist a new spec will be created. If the spec does
6309 exist then its contents will be overridden by the text of this
6310 directive, unless the first character of that text is the @samp{+}
6311 character, in which case the text will be appended to the spec.
6312
6313 @item [@var{suffix}]:
6314 Creates a new @samp{[@var{suffix}] spec} pair. All lines after this directive
6315 and up to the next directive or blank line are considered to make up the
6316 spec string for the indicated suffix. When the compiler encounters an
6317 input file with the named suffix, it will processes the spec string in
6318 order to work out how to compile that file. For example:
6319
6320 @smallexample
6321 .ZZ:
6322 z-compile -input %i
6323 @end smallexample
6324
6325 This says that any input file whose name ends in @samp{.ZZ} should be
6326 passed to the program @samp{z-compile}, which should be invoked with the
6327 command-line switch @option{-input} and with the result of performing the
6328 @samp{%i} substitution. (See below.)
6329
6330 As an alternative to providing a spec string, the text that follows a
6331 suffix directive can be one of the following:
6332
6333 @table @code
6334 @item @@@var{language}
6335 This says that the suffix is an alias for a known @var{language}. This is
6336 similar to using the @option{-x} command-line switch to GCC to specify a
6337 language explicitly. For example:
6338
6339 @smallexample
6340 .ZZ:
6341 @@c++
6342 @end smallexample
6343
6344 Says that .ZZ files are, in fact, C++ source files.
6345
6346 @item #@var{name}
6347 This causes an error messages saying:
6348
6349 @smallexample
6350 @var{name} compiler not installed on this system.
6351 @end smallexample
6352 @end table
6353
6354 GCC already has an extensive list of suffixes built into it.
6355 This directive will add an entry to the end of the list of suffixes, but
6356 since the list is searched from the end backwards, it is effectively
6357 possible to override earlier entries using this technique.
6358
6359 @end table
6360
6361 GCC has the following spec strings built into it. Spec files can
6362 override these strings or create their own. Note that individual
6363 targets can also add their own spec strings to this list.
6364
6365 @smallexample
6366 asm Options to pass to the assembler
6367 asm_final Options to pass to the assembler post-processor
6368 cpp Options to pass to the C preprocessor
6369 cc1 Options to pass to the C compiler
6370 cc1plus Options to pass to the C++ compiler
6371 endfile Object files to include at the end of the link
6372 link Options to pass to the linker
6373 lib Libraries to include on the command line to the linker
6374 libgcc Decides which GCC support library to pass to the linker
6375 linker Sets the name of the linker
6376 predefines Defines to be passed to the C preprocessor
6377 signed_char Defines to pass to CPP to say whether @code{char} is signed
6378 by default
6379 startfile Object files to include at the start of the link
6380 @end smallexample
6381
6382 Here is a small example of a spec file:
6383
6384 @smallexample
6385 %rename lib old_lib
6386
6387 *lib:
6388 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6389 @end smallexample
6390
6391 This example renames the spec called @samp{lib} to @samp{old_lib} and
6392 then overrides the previous definition of @samp{lib} with a new one.
6393 The new definition adds in some extra command-line options before
6394 including the text of the old definition.
6395
6396 @dfn{Spec strings} are a list of command-line options to be passed to their
6397 corresponding program. In addition, the spec strings can contain
6398 @samp{%}-prefixed sequences to substitute variable text or to
6399 conditionally insert text into the command line. Using these constructs
6400 it is possible to generate quite complex command lines.
6401
6402 Here is a table of all defined @samp{%}-sequences for spec
6403 strings. Note that spaces are not generated automatically around the
6404 results of expanding these sequences. Therefore you can concatenate them
6405 together or combine them with constant text in a single argument.
6406
6407 @table @code
6408 @item %%
6409 Substitute one @samp{%} into the program name or argument.
6410
6411 @item %i
6412 Substitute the name of the input file being processed.
6413
6414 @item %b
6415 Substitute the basename of the input file being processed.
6416 This is the substring up to (and not including) the last period
6417 and not including the directory.
6418
6419 @item %B
6420 This is the same as @samp{%b}, but include the file suffix (text after
6421 the last period).
6422
6423 @item %d
6424 Marks the argument containing or following the @samp{%d} as a
6425 temporary file name, so that that file will be deleted if GCC exits
6426 successfully. Unlike @samp{%g}, this contributes no text to the
6427 argument.
6428
6429 @item %g@var{suffix}
6430 Substitute a file name that has suffix @var{suffix} and is chosen
6431 once per compilation, and mark the argument in the same way as
6432 @samp{%d}. To reduce exposure to denial-of-service attacks, the file
6433 name is now chosen in a way that is hard to predict even when previously
6434 chosen file names are known. For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6435 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}. @var{suffix} matches
6436 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6437 treated exactly as if @samp{%O} had been preprocessed. Previously, @samp{%g}
6438 was simply substituted with a file name chosen once per compilation,
6439 without regard to any appended suffix (which was therefore treated
6440 just like ordinary text), making such attacks more likely to succeed.
6441
6442 @item %u@var{suffix}
6443 Like @samp{%g}, but generates a new temporary file name even if
6444 @samp{%u@var{suffix}} was already seen.
6445
6446 @item %U@var{suffix}
6447 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6448 new one if there is no such last file name. In the absence of any
6449 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6450 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6451 would involve the generation of two distinct file names, one
6452 for each @samp{%g.s} and another for each @samp{%U.s}. Previously, @samp{%U} was
6453 simply substituted with a file name chosen for the previous @samp{%u},
6454 without regard to any appended suffix.
6455
6456 @item %j@var{suffix}
6457 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6458 writable, and if save-temps is off; otherwise, substitute the name
6459 of a temporary file, just like @samp{%u}. This temporary file is not
6460 meant for communication between processes, but rather as a junk
6461 disposal mechanism.
6462
6463 @item %|@var{suffix}
6464 @itemx %m@var{suffix}
6465 Like @samp{%g}, except if @option{-pipe} is in effect. In that case
6466 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6467 all. These are the two most common ways to instruct a program that it
6468 should read from standard input or write to standard output. If you
6469 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6470 construct: see for example @file{f/lang-specs.h}.
6471
6472 @item %.@var{SUFFIX}
6473 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6474 when it is subsequently output with @samp{%*}. @var{SUFFIX} is
6475 terminated by the next space or %.
6476
6477 @item %w
6478 Marks the argument containing or following the @samp{%w} as the
6479 designated output file of this compilation. This puts the argument
6480 into the sequence of arguments that @samp{%o} will substitute later.
6481
6482 @item %o
6483 Substitutes the names of all the output files, with spaces
6484 automatically placed around them. You should write spaces
6485 around the @samp{%o} as well or the results are undefined.
6486 @samp{%o} is for use in the specs for running the linker.
6487 Input files whose names have no recognized suffix are not compiled
6488 at all, but they are included among the output files, so they will
6489 be linked.
6490
6491 @item %O
6492 Substitutes the suffix for object files. Note that this is
6493 handled specially when it immediately follows @samp{%g, %u, or %U},
6494 because of the need for those to form complete file names. The
6495 handling is such that @samp{%O} is treated exactly as if it had already
6496 been substituted, except that @samp{%g, %u, and %U} do not currently
6497 support additional @var{suffix} characters following @samp{%O} as they would
6498 following, for example, @samp{.o}.
6499
6500 @item %p
6501 Substitutes the standard macro predefinitions for the
6502 current target machine. Use this when running @code{cpp}.
6503
6504 @item %P
6505 Like @samp{%p}, but puts @samp{__} before and after the name of each
6506 predefined macro, except for macros that start with @samp{__} or with
6507 @samp{_@var{L}}, where @var{L} is an uppercase letter. This is for ISO
6508 C@.
6509
6510 @item %I
6511 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6512 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6513 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6514 as necessary.
6515
6516 @item %s
6517 Current argument is the name of a library or startup file of some sort.
6518 Search for that file in a standard list of directories and substitute
6519 the full name found.
6520
6521 @item %e@var{str}
6522 Print @var{str} as an error message. @var{str} is terminated by a newline.
6523 Use this when inconsistent options are detected.
6524
6525 @item %(@var{name})
6526 Substitute the contents of spec string @var{name} at this point.
6527
6528 @item %[@var{name}]
6529 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6530
6531 @item %x@{@var{option}@}
6532 Accumulate an option for @samp{%X}.
6533
6534 @item %X
6535 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6536 spec string.
6537
6538 @item %Y
6539 Output the accumulated assembler options specified by @option{-Wa}.
6540
6541 @item %Z
6542 Output the accumulated preprocessor options specified by @option{-Wp}.
6543
6544 @item %a
6545 Process the @code{asm} spec. This is used to compute the
6546 switches to be passed to the assembler.
6547
6548 @item %A
6549 Process the @code{asm_final} spec. This is a spec string for
6550 passing switches to an assembler post-processor, if such a program is
6551 needed.
6552
6553 @item %l
6554 Process the @code{link} spec. This is the spec for computing the
6555 command line passed to the linker. Typically it will make use of the
6556 @samp{%L %G %S %D and %E} sequences.
6557
6558 @item %D
6559 Dump out a @option{-L} option for each directory that GCC believes might
6560 contain startup files. If the target supports multilibs then the
6561 current multilib directory will be prepended to each of these paths.
6562
6563 @item %L
6564 Process the @code{lib} spec. This is a spec string for deciding which
6565 libraries should be included on the command line to the linker.
6566
6567 @item %G
6568 Process the @code{libgcc} spec. This is a spec string for deciding
6569 which GCC support library should be included on the command line to the linker.
6570
6571 @item %S
6572 Process the @code{startfile} spec. This is a spec for deciding which
6573 object files should be the first ones passed to the linker. Typically
6574 this might be a file named @file{crt0.o}.
6575
6576 @item %E
6577 Process the @code{endfile} spec. This is a spec string that specifies
6578 the last object files that will be passed to the linker.
6579
6580 @item %C
6581 Process the @code{cpp} spec. This is used to construct the arguments
6582 to be passed to the C preprocessor.
6583
6584 @item %1
6585 Process the @code{cc1} spec. This is used to construct the options to be
6586 passed to the actual C compiler (@samp{cc1}).
6587
6588 @item %2
6589 Process the @code{cc1plus} spec. This is used to construct the options to be
6590 passed to the actual C++ compiler (@samp{cc1plus}).
6591
6592 @item %*
6593 Substitute the variable part of a matched option. See below.
6594 Note that each comma in the substituted string is replaced by
6595 a single space.
6596
6597 @item %<@code{S}
6598 Remove all occurrences of @code{-S} from the command line. Note---this
6599 command is position dependent. @samp{%} commands in the spec string
6600 before this one will see @code{-S}, @samp{%} commands in the spec string
6601 after this one will not.
6602
6603 @item %:@var{function}(@var{args})
6604 Call the named function @var{function}, passing it @var{args}.
6605 @var{args} is first processed as a nested spec string, then split
6606 into an argument vector in the usual fashion. The function returns
6607 a string which is processed as if it had appeared literally as part
6608 of the current spec.
6609
6610 The following built-in spec functions are provided:
6611
6612 @table @code
6613 @item @code{if-exists}
6614 The @code{if-exists} spec function takes one argument, an absolute
6615 pathname to a file. If the file exists, @code{if-exists} returns the
6616 pathname. Here is a small example of its usage:
6617
6618 @smallexample
6619 *startfile:
6620 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6621 @end smallexample
6622
6623 @item @code{if-exists-else}
6624 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6625 spec function, except that it takes two arguments. The first argument is
6626 an absolute pathname to a file. If the file exists, @code{if-exists-else}
6627 returns the pathname. If it does not exist, it returns the second argument.
6628 This way, @code{if-exists-else} can be used to select one file or another,
6629 based on the existence of the first. Here is a small example of its usage:
6630
6631 @smallexample
6632 *startfile:
6633 crt0%O%s %:if-exists(crti%O%s) \
6634 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6635 @end smallexample
6636
6637 @item @code{replace-outfile}
6638 The @code{replace-outfile} spec function takes two arguments. It looks for the
6639 first argument in the outfiles array and replaces it with the second argument. Here
6640 is a small example of its usage:
6641
6642 @smallexample
6643 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6644 @end smallexample
6645
6646 @end table
6647
6648 @item %@{@code{S}@}
6649 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6650 If that switch was not specified, this substitutes nothing. Note that
6651 the leading dash is omitted when specifying this option, and it is
6652 automatically inserted if the substitution is performed. Thus the spec
6653 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6654 and would output the command line option @option{-foo}.
6655
6656 @item %W@{@code{S}@}
6657 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6658 deleted on failure.
6659
6660 @item %@{@code{S}*@}
6661 Substitutes all the switches specified to GCC whose names start
6662 with @code{-S}, but which also take an argument. This is used for
6663 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6664 GCC considers @option{-o foo} as being
6665 one switch whose names starts with @samp{o}. %@{o*@} would substitute this
6666 text, including the space. Thus two arguments would be generated.
6667
6668 @item %@{@code{S}*&@code{T}*@}
6669 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6670 (the order of @code{S} and @code{T} in the spec is not significant).
6671 There can be any number of ampersand-separated variables; for each the
6672 wild card is optional. Useful for CPP as @samp{%@{D*&U*&A*@}}.
6673
6674 @item %@{@code{S}:@code{X}@}
6675 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6676
6677 @item %@{!@code{S}:@code{X}@}
6678 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6679
6680 @item %@{@code{S}*:@code{X}@}
6681 Substitutes @code{X} if one or more switches whose names start with
6682 @code{-S} are specified to GCC@. Normally @code{X} is substituted only
6683 once, no matter how many such switches appeared. However, if @code{%*}
6684 appears somewhere in @code{X}, then @code{X} will be substituted once
6685 for each matching switch, with the @code{%*} replaced by the part of
6686 that switch that matched the @code{*}.
6687
6688 @item %@{.@code{S}:@code{X}@}
6689 Substitutes @code{X}, if processing a file with suffix @code{S}.
6690
6691 @item %@{!.@code{S}:@code{X}@}
6692 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6693
6694 @item %@{@code{S}|@code{P}:@code{X}@}
6695 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6696 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6697 although they have a stronger binding than the @samp{|}. If @code{%*}
6698 appears in @code{X}, all of the alternatives must be starred, and only
6699 the first matching alternative is substituted.
6700
6701 For example, a spec string like this:
6702
6703 @smallexample
6704 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6705 @end smallexample
6706
6707 will output the following command-line options from the following input
6708 command-line options:
6709
6710 @smallexample
6711 fred.c -foo -baz
6712 jim.d -bar -boggle
6713 -d fred.c -foo -baz -boggle
6714 -d jim.d -bar -baz -boggle
6715 @end smallexample
6716
6717 @item %@{S:X; T:Y; :D@}
6718
6719 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6720 given to GCC, substitutes @code{Y}; else substitutes @code{D}. There can
6721 be as many clauses as you need. This may be combined with @code{.},
6722 @code{!}, @code{|}, and @code{*} as needed.
6723
6724
6725 @end table
6726
6727 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6728 construct may contain other nested @samp{%} constructs or spaces, or
6729 even newlines. They are processed as usual, as described above.
6730 Trailing white space in @code{X} is ignored. White space may also
6731 appear anywhere on the left side of the colon in these constructs,
6732 except between @code{.} or @code{*} and the corresponding word.
6733
6734 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6735 handled specifically in these constructs. If another value of
6736 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6737 @option{-W} switch is found later in the command line, the earlier
6738 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6739 just one letter, which passes all matching options.
6740
6741 The character @samp{|} at the beginning of the predicate text is used to
6742 indicate that a command should be piped to the following command, but
6743 only if @option{-pipe} is specified.
6744
6745 It is built into GCC which switches take arguments and which do not.
6746 (You might think it would be useful to generalize this to allow each
6747 compiler's spec to say which switches take arguments. But this cannot
6748 be done in a consistent fashion. GCC cannot even decide which input
6749 files have been specified without knowing which switches take arguments,
6750 and it must know which input files to compile in order to tell which
6751 compilers to run).
6752
6753 GCC also knows implicitly that arguments starting in @option{-l} are to be
6754 treated as compiler output files, and passed to the linker in their
6755 proper position among the other output files.
6756
6757 @c man begin OPTIONS
6758
6759 @node Target Options
6760 @section Specifying Target Machine and Compiler Version
6761 @cindex target options
6762 @cindex cross compiling
6763 @cindex specifying machine version
6764 @cindex specifying compiler version and target machine
6765 @cindex compiler version, specifying
6766 @cindex target machine, specifying
6767
6768 The usual way to run GCC is to run the executable called @file{gcc}, or
6769 @file{<machine>-gcc} when cross-compiling, or
6770 @file{<machine>-gcc-<version>} to run a version other than the one that
6771 was installed last. Sometimes this is inconvenient, so GCC provides
6772 options that will switch to another cross-compiler or version.
6773
6774 @table @gcctabopt
6775 @item -b @var{machine}
6776 @opindex b
6777 The argument @var{machine} specifies the target machine for compilation.
6778
6779 The value to use for @var{machine} is the same as was specified as the
6780 machine type when configuring GCC as a cross-compiler. For
6781 example, if a cross-compiler was configured with @samp{configure
6782 i386v}, meaning to compile for an 80386 running System V, then you
6783 would specify @option{-b i386v} to run that cross compiler.
6784
6785 @item -V @var{version}
6786 @opindex V
6787 The argument @var{version} specifies which version of GCC to run.
6788 This is useful when multiple versions are installed. For example,
6789 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6790 @end table
6791
6792 The @option{-V} and @option{-b} options work by running the
6793 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6794 use them if you can just run that directly.
6795
6796 @node Submodel Options
6797 @section Hardware Models and Configurations
6798 @cindex submodel options
6799 @cindex specifying hardware config
6800 @cindex hardware models and configurations, specifying
6801 @cindex machine dependent options
6802
6803 Earlier we discussed the standard option @option{-b} which chooses among
6804 different installed compilers for completely different target
6805 machines, such as VAX vs.@: 68000 vs.@: 80386.
6806
6807 In addition, each of these target machine types can have its own
6808 special options, starting with @samp{-m}, to choose among various
6809 hardware models or configurations---for example, 68010 vs 68020,
6810 floating coprocessor or none. A single installed version of the
6811 compiler can compile for any model or configuration, according to the
6812 options specified.
6813
6814 Some configurations of the compiler also support additional special
6815 options, usually for compatibility with other compilers on the same
6816 platform.
6817
6818 These options are defined by the macro @code{TARGET_SWITCHES} in the
6819 machine description. The default for the options is also defined by
6820 that macro, which enables you to change the defaults.
6821
6822 @c This list is ordered alphanumerically by subsection name.
6823 @c It should be the same order and spelling as these options are listed
6824 @c in Machine Dependent Options
6825
6826 @menu
6827 * ARC Options::
6828 * ARM Options::
6829 * AVR Options::
6830 * Blackfin Options::
6831 * CRIS Options::
6832 * Darwin Options::
6833 * DEC Alpha Options::
6834 * DEC Alpha/VMS Options::
6835 * FRV Options::
6836 * H8/300 Options::
6837 * HPPA Options::
6838 * i386 and x86-64 Options::
6839 * IA-64 Options::
6840 * M32R/D Options::
6841 * M680x0 Options::
6842 * M68hc1x Options::
6843 * MCore Options::
6844 * MIPS Options::
6845 * MMIX Options::
6846 * MN10300 Options::
6847 * NS32K Options::
6848 * PDP-11 Options::
6849 * PowerPC Options::
6850 * RS/6000 and PowerPC Options::
6851 * S/390 and zSeries Options::
6852 * SH Options::
6853 * SPARC Options::
6854 * System V Options::
6855 * TMS320C3x/C4x Options::
6856 * V850 Options::
6857 * VAX Options::
6858 * x86-64 Options::
6859 * Xstormy16 Options::
6860 * Xtensa Options::
6861 * zSeries Options::
6862 @end menu
6863
6864 @node ARC Options
6865 @subsection ARC Options
6866 @cindex ARC Options
6867
6868 These options are defined for ARC implementations:
6869
6870 @table @gcctabopt
6871 @item -EL
6872 @opindex EL
6873 Compile code for little endian mode. This is the default.
6874
6875 @item -EB
6876 @opindex EB
6877 Compile code for big endian mode.
6878
6879 @item -mmangle-cpu
6880 @opindex mmangle-cpu
6881 Prepend the name of the cpu to all public symbol names.
6882 In multiple-processor systems, there are many ARC variants with different
6883 instruction and register set characteristics. This flag prevents code
6884 compiled for one cpu to be linked with code compiled for another.
6885 No facility exists for handling variants that are ``almost identical''.
6886 This is an all or nothing option.
6887
6888 @item -mcpu=@var{cpu}
6889 @opindex mcpu
6890 Compile code for ARC variant @var{cpu}.
6891 Which variants are supported depend on the configuration.
6892 All variants support @option{-mcpu=base}, this is the default.
6893
6894 @item -mtext=@var{text-section}
6895 @itemx -mdata=@var{data-section}
6896 @itemx -mrodata=@var{readonly-data-section}
6897 @opindex mtext
6898 @opindex mdata
6899 @opindex mrodata
6900 Put functions, data, and readonly data in @var{text-section},
6901 @var{data-section}, and @var{readonly-data-section} respectively
6902 by default. This can be overridden with the @code{section} attribute.
6903 @xref{Variable Attributes}.
6904
6905 @end table
6906
6907 @node ARM Options
6908 @subsection ARM Options
6909 @cindex ARM options
6910
6911 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6912 architectures:
6913
6914 @table @gcctabopt
6915 @item -mabi=@var{name}
6916 @opindex mabi
6917 Generate code for the specified ABI@. Permissible values are: @samp{apcs-gnu},
6918 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
6919
6920 @item -mapcs-frame
6921 @opindex mapcs-frame
6922 Generate a stack frame that is compliant with the ARM Procedure Call
6923 Standard for all functions, even if this is not strictly necessary for
6924 correct execution of the code. Specifying @option{-fomit-frame-pointer}
6925 with this option will cause the stack frames not to be generated for
6926 leaf functions. The default is @option{-mno-apcs-frame}.
6927
6928 @item -mapcs
6929 @opindex mapcs
6930 This is a synonym for @option{-mapcs-frame}.
6931
6932 @ignore
6933 @c not currently implemented
6934 @item -mapcs-stack-check
6935 @opindex mapcs-stack-check
6936 Generate code to check the amount of stack space available upon entry to
6937 every function (that actually uses some stack space). If there is
6938 insufficient space available then either the function
6939 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6940 called, depending upon the amount of stack space required. The run time
6941 system is required to provide these functions. The default is
6942 @option{-mno-apcs-stack-check}, since this produces smaller code.
6943
6944 @c not currently implemented
6945 @item -mapcs-float
6946 @opindex mapcs-float
6947 Pass floating point arguments using the float point registers. This is
6948 one of the variants of the APCS@. This option is recommended if the
6949 target hardware has a floating point unit or if a lot of floating point
6950 arithmetic is going to be performed by the code. The default is
6951 @option{-mno-apcs-float}, since integer only code is slightly increased in
6952 size if @option{-mapcs-float} is used.
6953
6954 @c not currently implemented
6955 @item -mapcs-reentrant
6956 @opindex mapcs-reentrant
6957 Generate reentrant, position independent code. The default is
6958 @option{-mno-apcs-reentrant}.
6959 @end ignore
6960
6961 @item -mthumb-interwork
6962 @opindex mthumb-interwork
6963 Generate code which supports calling between the ARM and Thumb
6964 instruction sets. Without this option the two instruction sets cannot
6965 be reliably used inside one program. The default is
6966 @option{-mno-thumb-interwork}, since slightly larger code is generated
6967 when @option{-mthumb-interwork} is specified.
6968
6969 @item -mno-sched-prolog
6970 @opindex mno-sched-prolog
6971 Prevent the reordering of instructions in the function prolog, or the
6972 merging of those instruction with the instructions in the function's
6973 body. This means that all functions will start with a recognizable set
6974 of instructions (or in fact one of a choice from a small set of
6975 different function prologues), and this information can be used to
6976 locate the start if functions inside an executable piece of code. The
6977 default is @option{-msched-prolog}.
6978
6979 @item -mhard-float
6980 @opindex mhard-float
6981 Generate output containing floating point instructions. This is the
6982 default.
6983
6984 @item -msoft-float
6985 @opindex msoft-float
6986 Generate output containing library calls for floating point.
6987 @strong{Warning:} the requisite libraries are not available for all ARM
6988 targets. Normally the facilities of the machine's usual C compiler are
6989 used, but this cannot be done directly in cross-compilation. You must make
6990 your own arrangements to provide suitable library functions for
6991 cross-compilation.
6992
6993 @option{-msoft-float} changes the calling convention in the output file;
6994 therefore, it is only useful if you compile @emph{all} of a program with
6995 this option. In particular, you need to compile @file{libgcc.a}, the
6996 library that comes with GCC, with @option{-msoft-float} in order for
6997 this to work.
6998
6999 @item -mfloat-abi=@var{name}
7000 @opindex mfloat-abi
7001 Specifies which ABI to use for floating point values. Permissible values
7002 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7003
7004 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7005 and @option{-mhard-float} respectively. @samp{softfp} allows the generation
7006 of floating point instructions, but still uses the soft-float calling
7007 conventions.
7008
7009 @item -mlittle-endian
7010 @opindex mlittle-endian
7011 Generate code for a processor running in little-endian mode. This is
7012 the default for all standard configurations.
7013
7014 @item -mbig-endian
7015 @opindex mbig-endian
7016 Generate code for a processor running in big-endian mode; the default is
7017 to compile code for a little-endian processor.
7018
7019 @item -mwords-little-endian
7020 @opindex mwords-little-endian
7021 This option only applies when generating code for big-endian processors.
7022 Generate code for a little-endian word order but a big-endian byte
7023 order. That is, a byte order of the form @samp{32107654}. Note: this
7024 option should only be used if you require compatibility with code for
7025 big-endian ARM processors generated by versions of the compiler prior to
7026 2.8.
7027
7028 @item -mcpu=@var{name}
7029 @opindex mcpu
7030 This specifies the name of the target ARM processor. GCC uses this name
7031 to determine what kind of instructions it can emit when generating
7032 assembly code. Permissible names are: @samp{arm2}, @samp{arm250},
7033 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7034 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7035 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7036 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7037 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7038 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7039 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7040 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7041 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7042 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7043 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7044 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7045 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7046 @samp{ep9312}.
7047
7048 @itemx -mtune=@var{name}
7049 @opindex mtune
7050 This option is very similar to the @option{-mcpu=} option, except that
7051 instead of specifying the actual target processor type, and hence
7052 restricting which instructions can be used, it specifies that GCC should
7053 tune the performance of the code as if the target were of the type
7054 specified in this option, but still choosing the instructions that it
7055 will generate based on the cpu specified by a @option{-mcpu=} option.
7056 For some ARM implementations better performance can be obtained by using
7057 this option.
7058
7059 @item -march=@var{name}
7060 @opindex march
7061 This specifies the name of the target ARM architecture. GCC uses this
7062 name to determine what kind of instructions it can emit when generating
7063 assembly code. This option can be used in conjunction with or instead
7064 of the @option{-mcpu=} option. Permissible names are: @samp{armv2},
7065 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7066 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7067 @samp{iwmmxt}, @samp{ep9312}.
7068
7069 @item -mfpu=@var{name}
7070 @itemx -mfpe=@var{number}
7071 @itemx -mfp=@var{number}
7072 @opindex mfpu
7073 @opindex mfpe
7074 @opindex mfp
7075 This specifies what floating point hardware (or hardware emulation) is
7076 available on the target. Permissible names are: @samp{fpa}, @samp{fpe2},
7077 @samp{fpe3}, @samp{maverick}, @samp{vfp}. @option{-mfp} and @option{-mfpe}
7078 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7079 with older versions of GCC@.
7080
7081 If @option{-msoft-float} is specified this specifies the format of
7082 floating point values.
7083
7084 @item -mstructure-size-boundary=@var{n}
7085 @opindex mstructure-size-boundary
7086 The size of all structures and unions will be rounded up to a multiple
7087 of the number of bits set by this option. Permissible values are 8, 32
7088 and 64. The default value varies for different toolchains. For the COFF
7089 targeted toolchain the default value is 8. A value of 64 is only allowed
7090 if the underlying ABI supports it.
7091
7092 Specifying the larger number can produce faster, more efficient code, but
7093 can also increase the size of the program. Different values are potentially
7094 incompatible. Code compiled with one value cannot necessarily expect to
7095 work with code or libraries compiled with another value, if they exchange
7096 information using structures or unions.
7097
7098 @item -mabort-on-noreturn
7099 @opindex mabort-on-noreturn
7100 Generate a call to the function @code{abort} at the end of a
7101 @code{noreturn} function. It will be executed if the function tries to
7102 return.
7103
7104 @item -mlong-calls
7105 @itemx -mno-long-calls
7106 @opindex mlong-calls
7107 @opindex mno-long-calls
7108 Tells the compiler to perform function calls by first loading the
7109 address of the function into a register and then performing a subroutine
7110 call on this register. This switch is needed if the target function
7111 will lie outside of the 64 megabyte addressing range of the offset based
7112 version of subroutine call instruction.
7113
7114 Even if this switch is enabled, not all function calls will be turned
7115 into long calls. The heuristic is that static functions, functions
7116 which have the @samp{short-call} attribute, functions that are inside
7117 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7118 definitions have already been compiled within the current compilation
7119 unit, will not be turned into long calls. The exception to this rule is
7120 that weak function definitions, functions with the @samp{long-call}
7121 attribute or the @samp{section} attribute, and functions that are within
7122 the scope of a @samp{#pragma long_calls} directive, will always be
7123 turned into long calls.
7124
7125 This feature is not enabled by default. Specifying
7126 @option{-mno-long-calls} will restore the default behavior, as will
7127 placing the function calls within the scope of a @samp{#pragma
7128 long_calls_off} directive. Note these switches have no effect on how
7129 the compiler generates code to handle function calls via function
7130 pointers.
7131
7132 @item -mnop-fun-dllimport
7133 @opindex mnop-fun-dllimport
7134 Disable support for the @code{dllimport} attribute.
7135
7136 @item -msingle-pic-base
7137 @opindex msingle-pic-base
7138 Treat the register used for PIC addressing as read-only, rather than
7139 loading it in the prologue for each function. The run-time system is
7140 responsible for initializing this register with an appropriate value
7141 before execution begins.
7142
7143 @item -mpic-register=@var{reg}
7144 @opindex mpic-register
7145 Specify the register to be used for PIC addressing. The default is R10
7146 unless stack-checking is enabled, when R9 is used.
7147
7148 @item -mcirrus-fix-invalid-insns
7149 @opindex mcirrus-fix-invalid-insns
7150 @opindex mno-cirrus-fix-invalid-insns
7151 Insert NOPs into the instruction stream to in order to work around
7152 problems with invalid Maverick instruction combinations. This option
7153 is only valid if the @option{-mcpu=ep9312} option has been used to
7154 enable generation of instructions for the Cirrus Maverick floating
7155 point co-processor. This option is not enabled by default, since the
7156 problem is only present in older Maverick implementations. The default
7157 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7158 switch.
7159
7160 @item -mpoke-function-name
7161 @opindex mpoke-function-name
7162 Write the name of each function into the text section, directly
7163 preceding the function prologue. The generated code is similar to this:
7164
7165 @smallexample
7166 t0
7167 .ascii "arm_poke_function_name", 0
7168 .align
7169 t1
7170 .word 0xff000000 + (t1 - t0)
7171 arm_poke_function_name
7172 mov ip, sp
7173 stmfd sp!, @{fp, ip, lr, pc@}
7174 sub fp, ip, #4
7175 @end smallexample
7176
7177 When performing a stack backtrace, code can inspect the value of
7178 @code{pc} stored at @code{fp + 0}. If the trace function then looks at
7179 location @code{pc - 12} and the top 8 bits are set, then we know that
7180 there is a function name embedded immediately preceding this location
7181 and has length @code{((pc[-3]) & 0xff000000)}.
7182
7183 @item -mthumb
7184 @opindex mthumb
7185 Generate code for the 16-bit Thumb instruction set. The default is to
7186 use the 32-bit ARM instruction set.
7187
7188 @item -mtpcs-frame
7189 @opindex mtpcs-frame
7190 Generate a stack frame that is compliant with the Thumb Procedure Call
7191 Standard for all non-leaf functions. (A leaf function is one that does
7192 not call any other functions.) The default is @option{-mno-tpcs-frame}.
7193
7194 @item -mtpcs-leaf-frame
7195 @opindex mtpcs-leaf-frame
7196 Generate a stack frame that is compliant with the Thumb Procedure Call
7197 Standard for all leaf functions. (A leaf function is one that does
7198 not call any other functions.) The default is @option{-mno-apcs-leaf-frame}.
7199
7200 @item -mcallee-super-interworking
7201 @opindex mcallee-super-interworking
7202 Gives all externally visible functions in the file being compiled an ARM
7203 instruction set header which switches to Thumb mode before executing the
7204 rest of the function. This allows these functions to be called from
7205 non-interworking code.
7206
7207 @item -mcaller-super-interworking
7208 @opindex mcaller-super-interworking
7209 Allows calls via function pointers (including virtual functions) to
7210 execute correctly regardless of whether the target code has been
7211 compiled for interworking or not. There is a small overhead in the cost
7212 of executing a function pointer if this option is enabled.
7213
7214 @end table
7215
7216 @node AVR Options
7217 @subsection AVR Options
7218 @cindex AVR Options
7219
7220 These options are defined for AVR implementations:
7221
7222 @table @gcctabopt
7223 @item -mmcu=@var{mcu}
7224 @opindex mmcu
7225 Specify ATMEL AVR instruction set or MCU type.
7226
7227 Instruction set avr1 is for the minimal AVR core, not supported by the C
7228 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7229 attiny11, attiny12, attiny15, attiny28).
7230
7231 Instruction set avr2 (default) is for the classic AVR core with up to
7232 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7233 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7234 at90c8534, at90s8535).
7235
7236 Instruction set avr3 is for the classic AVR core with up to 128K program
7237 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7238
7239 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7240 memory space (MCU types: atmega8, atmega83, atmega85).
7241
7242 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7243 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7244 atmega64, atmega128, at43usb355, at94k).
7245
7246 @item -msize
7247 @opindex msize
7248 Output instruction sizes to the asm file.
7249
7250 @item -minit-stack=@var{N}
7251 @opindex minit-stack
7252 Specify the initial stack address, which may be a symbol or numeric value,
7253 @samp{__stack} is the default.
7254
7255 @item -mno-interrupts
7256 @opindex mno-interrupts
7257 Generated code is not compatible with hardware interrupts.
7258 Code size will be smaller.
7259
7260 @item -mcall-prologues
7261 @opindex mcall-prologues
7262 Functions prologues/epilogues expanded as call to appropriate
7263 subroutines. Code size will be smaller.
7264
7265 @item -mno-tablejump
7266 @opindex mno-tablejump
7267 Do not generate tablejump insns which sometimes increase code size.
7268
7269 @item -mtiny-stack
7270 @opindex mtiny-stack
7271 Change only the low 8 bits of the stack pointer.
7272
7273 @item -mint8
7274 @opindex mint8
7275 Assume int to be 8 bit integer. This affects the sizes of all types: A
7276 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7277 and long long will be 4 bytes. Please note that this option does not
7278 comply to the C standards, but it will provide you with smaller code
7279 size.
7280 @end table
7281
7282 @node Blackfin Options
7283 @subsection Blackfin Options
7284 @cindex Blackfin Options
7285
7286 @table @gcctabopt
7287 @item -momit-leaf-frame-pointer
7288 @opindex momit-leaf-frame-pointer
7289 Don't keep the frame pointer in a register for leaf functions. This
7290 avoids the instructions to save, set up and restore frame pointers and
7291 makes an extra register available in leaf functions. The option
7292 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7293 which might make debugging harder.
7294
7295 @item -mcsync
7296 @opindex mcsync
7297 When enabled, the compiler will ensure that the generated code does not
7298 contain speculative loads after jump instructions. This option is enabled
7299 by default.
7300
7301 @item -mno-csync
7302 @opindex mno-csync
7303 Don't generate extra code to prevent speculative loads from occurring.
7304
7305 @item -mlow-64k
7306 @opindex mlow-64k
7307 When enabled, the compiler is free to take advantage of the knowledge that
7308 the entire program fits into the low 64k of memory.
7309
7310 @item -mno-low-64k
7311 @opindex mno-low-64k
7312 Assume that the program is arbitrarily large. This is the default.
7313
7314 @item -mid-shared-library
7315 @opindex mid-shared-library
7316 Generate code that supports shared libraries via the library ID method.
7317 This allows for execute in place and shared libraries in an environment
7318 without virtual memory management. This option implies @option{-fPIC}.
7319
7320 @item -mno-id-shared-library
7321 @opindex mno-id-shared-library
7322 Generate code that doesn't assume ID based shared libraries are being used.
7323 This is the default.
7324
7325 @item -mshared-library-id=n
7326 @opindex mshared-library-id
7327 Specified the identification number of the ID based shared library being
7328 compiled. Specifying a value of 0 will generate more compact code, specifying
7329 other values will force the allocation of that number to the current
7330 library but is no more space or time efficient than omitting this option.
7331 @end table
7332
7333 @node CRIS Options
7334 @subsection CRIS Options
7335 @cindex CRIS Options
7336
7337 These options are defined specifically for the CRIS ports.
7338
7339 @table @gcctabopt
7340 @item -march=@var{architecture-type}
7341 @itemx -mcpu=@var{architecture-type}
7342 @opindex march
7343 @opindex mcpu
7344 Generate code for the specified architecture. The choices for
7345 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7346 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7347 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7348 @samp{v10}.
7349
7350 @item -mtune=@var{architecture-type}
7351 @opindex mtune
7352 Tune to @var{architecture-type} everything applicable about the generated
7353 code, except for the ABI and the set of available instructions. The
7354 choices for @var{architecture-type} are the same as for
7355 @option{-march=@var{architecture-type}}.
7356
7357 @item -mmax-stack-frame=@var{n}
7358 @opindex mmax-stack-frame
7359 Warn when the stack frame of a function exceeds @var{n} bytes.
7360
7361 @item -melinux-stacksize=@var{n}
7362 @opindex melinux-stacksize
7363 Only available with the @samp{cris-axis-aout} target. Arranges for
7364 indications in the program to the kernel loader that the stack of the
7365 program should be set to @var{n} bytes.
7366
7367 @item -metrax4
7368 @itemx -metrax100
7369 @opindex metrax4
7370 @opindex metrax100
7371 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7372 @option{-march=v3} and @option{-march=v8} respectively.
7373
7374 @item -mmul-bug-workaround
7375 @itemx -mno-mul-bug-workaround
7376 @opindex mmul-bug-workaround
7377 @opindex mno-mul-bug-workaround
7378 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7379 models where it applies. This option is active by default.
7380
7381 @item -mpdebug
7382 @opindex mpdebug
7383 Enable CRIS-specific verbose debug-related information in the assembly
7384 code. This option also has the effect to turn off the @samp{#NO_APP}
7385 formatted-code indicator to the assembler at the beginning of the
7386 assembly file.
7387
7388 @item -mcc-init
7389 @opindex mcc-init
7390 Do not use condition-code results from previous instruction; always emit
7391 compare and test instructions before use of condition codes.
7392
7393 @item -mno-side-effects
7394 @opindex mno-side-effects
7395 Do not emit instructions with side-effects in addressing modes other than
7396 post-increment.
7397
7398 @item -mstack-align
7399 @itemx -mno-stack-align
7400 @itemx -mdata-align
7401 @itemx -mno-data-align
7402 @itemx -mconst-align
7403 @itemx -mno-const-align
7404 @opindex mstack-align
7405 @opindex mno-stack-align
7406 @opindex mdata-align
7407 @opindex mno-data-align
7408 @opindex mconst-align
7409 @opindex mno-const-align
7410 These options (no-options) arranges (eliminate arrangements) for the
7411 stack-frame, individual data and constants to be aligned for the maximum
7412 single data access size for the chosen CPU model. The default is to
7413 arrange for 32-bit alignment. ABI details such as structure layout are
7414 not affected by these options.
7415
7416 @item -m32-bit
7417 @itemx -m16-bit
7418 @itemx -m8-bit
7419 @opindex m32-bit
7420 @opindex m16-bit
7421 @opindex m8-bit
7422 Similar to the stack- data- and const-align options above, these options
7423 arrange for stack-frame, writable data and constants to all be 32-bit,
7424 16-bit or 8-bit aligned. The default is 32-bit alignment.
7425
7426 @item -mno-prologue-epilogue
7427 @itemx -mprologue-epilogue
7428 @opindex mno-prologue-epilogue
7429 @opindex mprologue-epilogue
7430 With @option{-mno-prologue-epilogue}, the normal function prologue and
7431 epilogue that sets up the stack-frame are omitted and no return
7432 instructions or return sequences are generated in the code. Use this
7433 option only together with visual inspection of the compiled code: no
7434 warnings or errors are generated when call-saved registers must be saved,
7435 or storage for local variable needs to be allocated.
7436
7437 @item -mno-gotplt
7438 @itemx -mgotplt
7439 @opindex mno-gotplt
7440 @opindex mgotplt
7441 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7442 instruction sequences that load addresses for functions from the PLT part
7443 of the GOT rather than (traditional on other architectures) calls to the
7444 PLT@. The default is @option{-mgotplt}.
7445
7446 @item -maout
7447 @opindex maout
7448 Legacy no-op option only recognized with the cris-axis-aout target.
7449
7450 @item -melf
7451 @opindex melf
7452 Legacy no-op option only recognized with the cris-axis-elf and
7453 cris-axis-linux-gnu targets.
7454
7455 @item -melinux
7456 @opindex melinux
7457 Only recognized with the cris-axis-aout target, where it selects a
7458 GNU/linux-like multilib, include files and instruction set for
7459 @option{-march=v8}.
7460
7461 @item -mlinux
7462 @opindex mlinux
7463 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7464
7465 @item -sim
7466 @opindex sim
7467 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7468 to link with input-output functions from a simulator library. Code,
7469 initialized data and zero-initialized data are allocated consecutively.
7470
7471 @item -sim2
7472 @opindex sim2
7473 Like @option{-sim}, but pass linker options to locate initialized data at
7474 0x40000000 and zero-initialized data at 0x80000000.
7475 @end table
7476
7477 @node Darwin Options
7478 @subsection Darwin Options
7479 @cindex Darwin options
7480
7481 These options are defined for all architectures running the Darwin operating
7482 system.
7483
7484 FSF GCC on Darwin does not create ``fat'' object files; it will create
7485 an object file for the single architecture that it was built to
7486 target. Apple's GCC on Darwin does create ``fat'' files if multiple
7487 @option{-arch} options are used; it does so by running the compiler or
7488 linker multiple times and joining the results together with
7489 @file{lipo}.
7490
7491 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7492 @samp{i686}) is determined by the flags that specify the ISA
7493 that GCC is targetting, like @option{-mcpu} or @option{-march}. The
7494 @option{-force_cpusubtype_ALL} option can be used to override this.
7495
7496 The Darwin tools vary in their behavior when presented with an ISA
7497 mismatch. The assembler, @file{as}, will only permit instructions to
7498 be used that are valid for the subtype of the file it is generating,
7499 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7500 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7501 and print an error if asked to create a shared library with a less
7502 restrictive subtype than its input files (for instance, trying to put
7503 a @samp{ppc970} object file in a @samp{ppc7400} library). The linker
7504 for executables, @file{ld}, will quietly give the executable the most
7505 restrictive subtype of any of its input files.
7506
7507 @table @gcctabopt
7508 @item -F@var{dir}
7509 @opindex F
7510 Add the framework directory @var{dir} to the head of the list of
7511 directories to be searched for header files. These directories are
7512 interleaved with those specified by @option{-I} options and are
7513 scanned in a left-to-right order.
7514
7515 A framework directory is a directory with frameworks in it. A
7516 framework is a directory with a @samp{"Headers"} and/or
7517 @samp{"PrivateHeaders"} directory contained directly in it that ends
7518 in @samp{".framework"}. The name of a framework is the name of this
7519 directory excluding the @samp{".framework"}. Headers associated with
7520 the framework are found in one of those two directories, with
7521 @samp{"Headers"} being searched first. A subframework is a framework
7522 directory that is in a framework's @samp{"Frameworks"} directory.
7523 Includes of subframework headers can only appear in a header of a
7524 framework that contains the subframework, or in a sibling subframework
7525 header. Two subframeworks are siblings if they occur in the same
7526 framework. A subframework should not have the same name as a
7527 framework, a warning will be issued if this is violated. Currently a
7528 subframework cannot have subframeworks, in the future, the mechanism
7529 may be extended to support this. The standard frameworks can be found
7530 in @samp{"/System/Library/Frameworks"} and
7531 @samp{"/Library/Frameworks"}. An example include looks like
7532 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7533 the name of the framework and header.h is found in the
7534 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7535
7536 @item -gused
7537 @opindex -gused
7538 Emit debugging information for symbols that are used. For STABS
7539 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7540 This is by default ON@.
7541
7542 @item -gfull
7543 @opindex -gfull
7544 Emit debugging information for all symbols and types.
7545
7546 @item -mone-byte-bool
7547 @opindex -mone-byte-bool
7548 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7549 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7550 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7551 option has no effect on x86.
7552
7553 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7554 to generate code that is not binary compatible with code generated
7555 without that switch. Using this switch may require recompiling all
7556 other modules in a program, including system libraries. Use this
7557 switch to conform to a non-default data model.
7558
7559 @item -mfix-and-continue
7560 @itemx -ffix-and-continue
7561 @itemx -findirect-data
7562 @opindex mfix-and-continue
7563 @opindex ffix-and-continue
7564 @opindex findirect-data
7565 Generate code suitable for fast turn around development. Needed to
7566 enable gdb to dynamically load @code{.o} files into already running
7567 programs. @option{-findirect-data} and @option{-ffix-and-continue}
7568 are provided for backwards compatibility.
7569
7570 @item -all_load
7571 @opindex all_load
7572 Loads all members of static archive libraries.
7573 See man ld(1) for more information.
7574
7575 @item -arch_errors_fatal
7576 @opindex arch_errors_fatal
7577 Cause the errors having to do with files that have the wrong architecture
7578 to be fatal.
7579
7580 @item -bind_at_load
7581 @opindex bind_at_load
7582 Causes the output file to be marked such that the dynamic linker will
7583 bind all undefined references when the file is loaded or launched.
7584
7585 @item -bundle
7586 @opindex bundle
7587 Produce a Mach-o bundle format file.
7588 See man ld(1) for more information.
7589
7590 @item -bundle_loader @var{executable}
7591 @opindex bundle_loader
7592 This option specifies the @var{executable} that will be loading the build
7593 output file being linked. See man ld(1) for more information.
7594
7595 @item -dynamiclib
7596 @opindex -dynamiclib
7597 When passed this option, GCC will produce a dynamic library instead of
7598 an executable when linking, using the Darwin @file{libtool} command.
7599
7600 @item -force_cpusubtype_ALL
7601 @opindex -force_cpusubtype_ALL
7602 This causes GCC's output file to have the @var{ALL} subtype, instead of
7603 one controlled by the @option{-mcpu} or @option{-march} option.
7604
7605 @item -allowable_client @var{client_name}
7606 @itemx -client_name
7607 @itemx -compatibility_version
7608 @itemx -current_version
7609 @itemx -dead_strip
7610 @itemx -dependency-file
7611 @itemx -dylib_file
7612 @itemx -dylinker_install_name
7613 @itemx -dynamic
7614 @itemx -exported_symbols_list
7615 @itemx -filelist
7616 @itemx -flat_namespace
7617 @itemx -force_flat_namespace
7618 @itemx -headerpad_max_install_names
7619 @itemx -image_base
7620 @itemx -init
7621 @itemx -install_name
7622 @itemx -keep_private_externs
7623 @itemx -multi_module
7624 @itemx -multiply_defined
7625 @itemx -multiply_defined_unused
7626 @itemx -noall_load
7627 @itemx -no_dead_strip_inits_and_terms
7628 @itemx -nofixprebinding
7629 @itemx -nomultidefs
7630 @itemx -noprebind
7631 @itemx -noseglinkedit
7632 @itemx -pagezero_size
7633 @itemx -prebind
7634 @itemx -prebind_all_twolevel_modules
7635 @itemx -private_bundle
7636 @itemx -read_only_relocs
7637 @itemx -sectalign
7638 @itemx -sectobjectsymbols
7639 @itemx -whyload
7640 @itemx -seg1addr
7641 @itemx -sectcreate
7642 @itemx -sectobjectsymbols
7643 @itemx -sectorder
7644 @itemx -segaddr
7645 @itemx -segs_read_only_addr
7646 @itemx -segs_read_write_addr
7647 @itemx -seg_addr_table
7648 @itemx -seg_addr_table_filename
7649 @itemx -seglinkedit
7650 @itemx -segprot
7651 @itemx -segs_read_only_addr
7652 @itemx -segs_read_write_addr
7653 @itemx -single_module
7654 @itemx -static
7655 @itemx -sub_library
7656 @itemx -sub_umbrella
7657 @itemx -twolevel_namespace
7658 @itemx -umbrella
7659 @itemx -undefined
7660 @itemx -unexported_symbols_list
7661 @itemx -weak_reference_mismatches
7662 @itemx -whatsloaded
7663
7664 @opindex allowable_client
7665 @opindex client_name
7666 @opindex compatibility_version
7667 @opindex current_version
7668 @opindex dead_strip
7669 @opindex dependency-file
7670 @opindex dylib_file
7671 @opindex dylinker_install_name
7672 @opindex dynamic
7673 @opindex exported_symbols_list
7674 @opindex filelist
7675 @opindex flat_namespace
7676 @opindex force_flat_namespace
7677 @opindex headerpad_max_install_names
7678 @opindex image_base
7679 @opindex init
7680 @opindex install_name
7681 @opindex keep_private_externs
7682 @opindex multi_module
7683 @opindex multiply_defined
7684 @opindex multiply_defined_unused
7685 @opindex noall_load
7686 @opindex no_dead_strip_inits_and_terms
7687 @opindex nofixprebinding
7688 @opindex nomultidefs
7689 @opindex noprebind
7690 @opindex noseglinkedit
7691 @opindex pagezero_size
7692 @opindex prebind
7693 @opindex prebind_all_twolevel_modules
7694 @opindex private_bundle
7695 @opindex read_only_relocs
7696 @opindex sectalign
7697 @opindex sectobjectsymbols
7698 @opindex whyload
7699 @opindex seg1addr
7700 @opindex sectcreate
7701 @opindex sectobjectsymbols
7702 @opindex sectorder
7703 @opindex segaddr
7704 @opindex segs_read_only_addr
7705 @opindex segs_read_write_addr
7706 @opindex seg_addr_table
7707 @opindex seg_addr_table_filename
7708 @opindex seglinkedit
7709 @opindex segprot
7710 @opindex segs_read_only_addr
7711 @opindex segs_read_write_addr
7712 @opindex single_module
7713 @opindex static
7714 @opindex sub_library
7715 @opindex sub_umbrella
7716 @opindex twolevel_namespace
7717 @opindex umbrella
7718 @opindex undefined
7719 @opindex unexported_symbols_list
7720 @opindex weak_reference_mismatches
7721 @opindex whatsloaded
7722
7723 These options are passed to the Darwin linker. The Darwin linker man page
7724 describes them in detail.
7725 @end table
7726
7727 @node DEC Alpha Options
7728 @subsection DEC Alpha Options
7729
7730 These @samp{-m} options are defined for the DEC Alpha implementations:
7731
7732 @table @gcctabopt
7733 @item -mno-soft-float
7734 @itemx -msoft-float
7735 @opindex mno-soft-float
7736 @opindex msoft-float
7737 Use (do not use) the hardware floating-point instructions for
7738 floating-point operations. When @option{-msoft-float} is specified,
7739 functions in @file{libgcc.a} will be used to perform floating-point
7740 operations. Unless they are replaced by routines that emulate the
7741 floating-point operations, or compiled in such a way as to call such
7742 emulations routines, these routines will issue floating-point
7743 operations. If you are compiling for an Alpha without floating-point
7744 operations, you must ensure that the library is built so as not to call
7745 them.
7746
7747 Note that Alpha implementations without floating-point operations are
7748 required to have floating-point registers.
7749
7750 @item -mfp-reg
7751 @itemx -mno-fp-regs
7752 @opindex mfp-reg
7753 @opindex mno-fp-regs
7754 Generate code that uses (does not use) the floating-point register set.
7755 @option{-mno-fp-regs} implies @option{-msoft-float}. If the floating-point
7756 register set is not used, floating point operands are passed in integer
7757 registers as if they were integers and floating-point results are passed
7758 in @code{$0} instead of @code{$f0}. This is a non-standard calling sequence,
7759 so any function with a floating-point argument or return value called by code
7760 compiled with @option{-mno-fp-regs} must also be compiled with that
7761 option.
7762
7763 A typical use of this option is building a kernel that does not use,
7764 and hence need not save and restore, any floating-point registers.
7765
7766 @item -mieee
7767 @opindex mieee
7768 The Alpha architecture implements floating-point hardware optimized for
7769 maximum performance. It is mostly compliant with the IEEE floating
7770 point standard. However, for full compliance, software assistance is
7771 required. This option generates code fully IEEE compliant code
7772 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7773 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7774 defined during compilation. The resulting code is less efficient but is
7775 able to correctly support denormalized numbers and exceptional IEEE
7776 values such as not-a-number and plus/minus infinity. Other Alpha
7777 compilers call this option @option{-ieee_with_no_inexact}.
7778
7779 @item -mieee-with-inexact
7780 @opindex mieee-with-inexact
7781 This is like @option{-mieee} except the generated code also maintains
7782 the IEEE @var{inexact-flag}. Turning on this option causes the
7783 generated code to implement fully-compliant IEEE math. In addition to
7784 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7785 macro. On some Alpha implementations the resulting code may execute
7786 significantly slower than the code generated by default. Since there is
7787 very little code that depends on the @var{inexact-flag}, you should
7788 normally not specify this option. Other Alpha compilers call this
7789 option @option{-ieee_with_inexact}.
7790
7791 @item -mfp-trap-mode=@var{trap-mode}
7792 @opindex mfp-trap-mode
7793 This option controls what floating-point related traps are enabled.
7794 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7795 The trap mode can be set to one of four values:
7796
7797 @table @samp
7798 @item n
7799 This is the default (normal) setting. The only traps that are enabled
7800 are the ones that cannot be disabled in software (e.g., division by zero
7801 trap).
7802
7803 @item u
7804 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7805 as well.
7806
7807 @item su
7808 Like @samp{su}, but the instructions are marked to be safe for software
7809 completion (see Alpha architecture manual for details).
7810
7811 @item sui
7812 Like @samp{su}, but inexact traps are enabled as well.
7813 @end table
7814
7815 @item -mfp-rounding-mode=@var{rounding-mode}
7816 @opindex mfp-rounding-mode
7817 Selects the IEEE rounding mode. Other Alpha compilers call this option
7818 @option{-fprm @var{rounding-mode}}. The @var{rounding-mode} can be one
7819 of:
7820
7821 @table @samp
7822 @item n
7823 Normal IEEE rounding mode. Floating point numbers are rounded towards
7824 the nearest machine number or towards the even machine number in case
7825 of a tie.
7826
7827 @item m
7828 Round towards minus infinity.
7829
7830 @item c
7831 Chopped rounding mode. Floating point numbers are rounded towards zero.
7832
7833 @item d
7834 Dynamic rounding mode. A field in the floating point control register
7835 (@var{fpcr}, see Alpha architecture reference manual) controls the
7836 rounding mode in effect. The C library initializes this register for
7837 rounding towards plus infinity. Thus, unless your program modifies the
7838 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7839 @end table
7840
7841 @item -mtrap-precision=@var{trap-precision}
7842 @opindex mtrap-precision
7843 In the Alpha architecture, floating point traps are imprecise. This
7844 means without software assistance it is impossible to recover from a
7845 floating trap and program execution normally needs to be terminated.
7846 GCC can generate code that can assist operating system trap handlers
7847 in determining the exact location that caused a floating point trap.
7848 Depending on the requirements of an application, different levels of
7849 precisions can be selected:
7850
7851 @table @samp
7852 @item p
7853 Program precision. This option is the default and means a trap handler
7854 can only identify which program caused a floating point exception.
7855
7856 @item f
7857 Function precision. The trap handler can determine the function that
7858 caused a floating point exception.
7859
7860 @item i
7861 Instruction precision. The trap handler can determine the exact
7862 instruction that caused a floating point exception.
7863 @end table
7864
7865 Other Alpha compilers provide the equivalent options called
7866 @option{-scope_safe} and @option{-resumption_safe}.
7867
7868 @item -mieee-conformant
7869 @opindex mieee-conformant
7870 This option marks the generated code as IEEE conformant. You must not
7871 use this option unless you also specify @option{-mtrap-precision=i} and either
7872 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}. Its only effect
7873 is to emit the line @samp{.eflag 48} in the function prologue of the
7874 generated assembly file. Under DEC Unix, this has the effect that
7875 IEEE-conformant math library routines will be linked in.
7876
7877 @item -mbuild-constants
7878 @opindex mbuild-constants
7879 Normally GCC examines a 32- or 64-bit integer constant to
7880 see if it can construct it from smaller constants in two or three
7881 instructions. If it cannot, it will output the constant as a literal and
7882 generate code to load it from the data segment at runtime.
7883
7884 Use this option to require GCC to construct @emph{all} integer constants
7885 using code, even if it takes more instructions (the maximum is six).
7886
7887 You would typically use this option to build a shared library dynamic
7888 loader. Itself a shared library, it must relocate itself in memory
7889 before it can find the variables and constants in its own data segment.
7890
7891 @item -malpha-as
7892 @itemx -mgas
7893 @opindex malpha-as
7894 @opindex mgas
7895 Select whether to generate code to be assembled by the vendor-supplied
7896 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
7897
7898 @item -mbwx
7899 @itemx -mno-bwx
7900 @itemx -mcix
7901 @itemx -mno-cix
7902 @itemx -mfix
7903 @itemx -mno-fix
7904 @itemx -mmax
7905 @itemx -mno-max
7906 @opindex mbwx
7907 @opindex mno-bwx
7908 @opindex mcix
7909 @opindex mno-cix
7910 @opindex mfix
7911 @opindex mno-fix
7912 @opindex mmax
7913 @opindex mno-max
7914 Indicate whether GCC should generate code to use the optional BWX,
7915 CIX, FIX and MAX instruction sets. The default is to use the instruction
7916 sets supported by the CPU type specified via @option{-mcpu=} option or that
7917 of the CPU on which GCC was built if none was specified.
7918
7919 @item -mfloat-vax
7920 @itemx -mfloat-ieee
7921 @opindex mfloat-vax
7922 @opindex mfloat-ieee
7923 Generate code that uses (does not use) VAX F and G floating point
7924 arithmetic instead of IEEE single and double precision.
7925
7926 @item -mexplicit-relocs
7927 @itemx -mno-explicit-relocs
7928 @opindex mexplicit-relocs
7929 @opindex mno-explicit-relocs
7930 Older Alpha assemblers provided no way to generate symbol relocations
7931 except via assembler macros. Use of these macros does not allow
7932 optimal instruction scheduling. GNU binutils as of version 2.12
7933 supports a new syntax that allows the compiler to explicitly mark
7934 which relocations should apply to which instructions. This option
7935 is mostly useful for debugging, as GCC detects the capabilities of
7936 the assembler when it is built and sets the default accordingly.
7937
7938 @item -msmall-data
7939 @itemx -mlarge-data
7940 @opindex msmall-data
7941 @opindex mlarge-data
7942 When @option{-mexplicit-relocs} is in effect, static data is
7943 accessed via @dfn{gp-relative} relocations. When @option{-msmall-data}
7944 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
7945 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
7946 16-bit relocations off of the @code{$gp} register. This limits the
7947 size of the small data area to 64KB, but allows the variables to be
7948 directly accessed via a single instruction.
7949
7950 The default is @option{-mlarge-data}. With this option the data area
7951 is limited to just below 2GB@. Programs that require more than 2GB of
7952 data must use @code{malloc} or @code{mmap} to allocate the data in the
7953 heap instead of in the program's data segment.
7954
7955 When generating code for shared libraries, @option{-fpic} implies
7956 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
7957
7958 @item -msmall-text
7959 @itemx -mlarge-text
7960 @opindex msmall-text
7961 @opindex mlarge-text
7962 When @option{-msmall-text} is used, the compiler assumes that the
7963 code of the entire program (or shared library) fits in 4MB, and is
7964 thus reachable with a branch instruction. When @option{-msmall-data}
7965 is used, the compiler can assume that all local symbols share the
7966 same @code{$gp} value, and thus reduce the number of instructions
7967 required for a function call from 4 to 1.
7968
7969 The default is @option{-mlarge-text}.
7970
7971 @item -mcpu=@var{cpu_type}
7972 @opindex mcpu
7973 Set the instruction set and instruction scheduling parameters for
7974 machine type @var{cpu_type}. You can specify either the @samp{EV}
7975 style name or the corresponding chip number. GCC supports scheduling
7976 parameters for the EV4, EV5 and EV6 family of processors and will
7977 choose the default values for the instruction set from the processor
7978 you specify. If you do not specify a processor type, GCC will default
7979 to the processor on which the compiler was built.
7980
7981 Supported values for @var{cpu_type} are
7982
7983 @table @samp
7984 @item ev4
7985 @itemx ev45
7986 @itemx 21064
7987 Schedules as an EV4 and has no instruction set extensions.
7988
7989 @item ev5
7990 @itemx 21164
7991 Schedules as an EV5 and has no instruction set extensions.
7992
7993 @item ev56
7994 @itemx 21164a
7995 Schedules as an EV5 and supports the BWX extension.
7996
7997 @item pca56
7998 @itemx 21164pc
7999 @itemx 21164PC
8000 Schedules as an EV5 and supports the BWX and MAX extensions.
8001
8002 @item ev6
8003 @itemx 21264
8004 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8005
8006 @item ev67
8007 @itemx 21264a
8008 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8009 @end table
8010
8011 @item -mtune=@var{cpu_type}
8012 @opindex mtune
8013 Set only the instruction scheduling parameters for machine type
8014 @var{cpu_type}. The instruction set is not changed.
8015
8016 @item -mmemory-latency=@var{time}
8017 @opindex mmemory-latency
8018 Sets the latency the scheduler should assume for typical memory
8019 references as seen by the application. This number is highly
8020 dependent on the memory access patterns used by the application
8021 and the size of the external cache on the machine.
8022
8023 Valid options for @var{time} are
8024
8025 @table @samp
8026 @item @var{number}
8027 A decimal number representing clock cycles.
8028
8029 @item L1
8030 @itemx L2
8031 @itemx L3
8032 @itemx main
8033 The compiler contains estimates of the number of clock cycles for
8034 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8035 (also called Dcache, Scache, and Bcache), as well as to main memory.
8036 Note that L3 is only valid for EV5.
8037
8038 @end table
8039 @end table
8040
8041 @node DEC Alpha/VMS Options
8042 @subsection DEC Alpha/VMS Options
8043
8044 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8045
8046 @table @gcctabopt
8047 @item -mvms-return-codes
8048 @opindex mvms-return-codes
8049 Return VMS condition codes from main. The default is to return POSIX
8050 style condition (e.g.@ error) codes.
8051 @end table
8052
8053 @node FRV Options
8054 @subsection FRV Options
8055 @cindex FRV Options
8056
8057 @table @gcctabopt
8058 @item -mgpr-32
8059 @opindex mgpr-32
8060
8061 Only use the first 32 general purpose registers.
8062
8063 @item -mgpr-64
8064 @opindex mgpr-64
8065
8066 Use all 64 general purpose registers.
8067
8068 @item -mfpr-32
8069 @opindex mfpr-32
8070
8071 Use only the first 32 floating point registers.
8072
8073 @item -mfpr-64
8074 @opindex mfpr-64
8075
8076 Use all 64 floating point registers
8077
8078 @item -mhard-float
8079 @opindex mhard-float
8080
8081 Use hardware instructions for floating point operations.
8082
8083 @item -msoft-float
8084 @opindex msoft-float
8085
8086 Use library routines for floating point operations.
8087
8088 @item -malloc-cc
8089 @opindex malloc-cc
8090
8091 Dynamically allocate condition code registers.
8092
8093 @item -mfixed-cc
8094 @opindex mfixed-cc
8095
8096 Do not try to dynamically allocate condition code registers, only
8097 use @code{icc0} and @code{fcc0}.
8098
8099 @item -mdword
8100 @opindex mdword
8101
8102 Change ABI to use double word insns.
8103
8104 @item -mno-dword
8105 @opindex mno-dword
8106
8107 Do not use double word instructions.
8108
8109 @item -mdouble
8110 @opindex mdouble
8111
8112 Use floating point double instructions.
8113
8114 @item -mno-double
8115 @opindex mno-double
8116
8117 Do not use floating point double instructions.
8118
8119 @item -mmedia
8120 @opindex mmedia
8121
8122 Use media instructions.
8123
8124 @item -mno-media
8125 @opindex mno-media
8126
8127 Do not use media instructions.
8128
8129 @item -mmuladd
8130 @opindex mmuladd
8131
8132 Use multiply and add/subtract instructions.
8133
8134 @item -mno-muladd
8135 @opindex mno-muladd
8136
8137 Do not use multiply and add/subtract instructions.
8138
8139 @item -mfdpic
8140 @opindex mfdpic
8141
8142 Select the FDPIC ABI, that uses function descriptors to represent
8143 pointers to functions. Without any PIC/PIE-related options, it
8144 implies @option{-fPIE}. With @option{-fpic} or @option{-fpie}, it
8145 assumes GOT entries and small data are within a 12-bit range from the
8146 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8147 are computed with 32 bits.
8148
8149 @item -minline-plt
8150 @opindex minline-plt
8151
8152 Enable inlining of PLT entries in function calls to functions that are
8153 not known to bind locally. It has no effect without @option{-mfdpic}.
8154 It's enabled by default if optimizing for speed and compiling for
8155 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8156 optimization option such as @option{-O3} or above is present in the
8157 command line.
8158
8159 @item -mTLS
8160 @opindex TLS
8161
8162 Assume a large TLS segment when generating thread-local code.
8163
8164 @item -mtls
8165 @opindex tls
8166
8167 Do not assume a large TLS segment when generating thread-local code.
8168
8169 @item -mgprel-ro
8170 @opindex mgprel-ro
8171
8172 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8173 that is known to be in read-only sections. It's enabled by default,
8174 except for @option{-fpic} or @option{-fpie}: even though it may help
8175 make the global offset table smaller, it trades 1 instruction for 4.
8176 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8177 one of which may be shared by multiple symbols, and it avoids the need
8178 for a GOT entry for the referenced symbol, so it's more likely to be a
8179 win. If it is not, @option{-mno-gprel-ro} can be used to disable it.
8180
8181 @item -multilib-library-pic
8182 @opindex multilib-library-pic
8183
8184 Link with the (library, not FD) pic libraries. It's implied by
8185 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8186 @option{-fpic} without @option{-mfdpic}. You should never have to use
8187 it explicitly.
8188
8189 @item -mlinked-fp
8190 @opindex mlinked-fp
8191
8192 Follow the EABI requirement of always creating a frame pointer whenever
8193 a stack frame is allocated. This option is enabled by default and can
8194 be disabled with @option{-mno-linked-fp}.
8195
8196 @item -mlong-calls
8197 @opindex mlong-calls
8198
8199 Use indirect addressing to call functions outside the current
8200 compilation unit. This allows the functions to be placed anywhere
8201 within the 32-bit address space.
8202
8203 @item -malign-labels
8204 @opindex malign-labels
8205
8206 Try to align labels to an 8-byte boundary by inserting nops into the
8207 previous packet. This option only has an effect when VLIW packing
8208 is enabled. It doesn't create new packets; it merely adds nops to
8209 existing ones.
8210
8211 @item -mlibrary-pic
8212 @opindex mlibrary-pic
8213
8214 Generate position-independent EABI code.
8215
8216 @item -macc-4
8217 @opindex macc-4
8218
8219 Use only the first four media accumulator registers.
8220
8221 @item -macc-8
8222 @opindex macc-8
8223
8224 Use all eight media accumulator registers.
8225
8226 @item -mpack
8227 @opindex mpack
8228
8229 Pack VLIW instructions.
8230
8231 @item -mno-pack
8232 @opindex mno-pack
8233
8234 Do not pack VLIW instructions.
8235
8236 @item -mno-eflags
8237 @opindex mno-eflags
8238
8239 Do not mark ABI switches in e_flags.
8240
8241 @item -mcond-move
8242 @opindex mcond-move
8243
8244 Enable the use of conditional-move instructions (default).
8245
8246 This switch is mainly for debugging the compiler and will likely be removed
8247 in a future version.
8248
8249 @item -mno-cond-move
8250 @opindex mno-cond-move
8251
8252 Disable the use of conditional-move instructions.
8253
8254 This switch is mainly for debugging the compiler and will likely be removed
8255 in a future version.
8256
8257 @item -mscc
8258 @opindex mscc
8259
8260 Enable the use of conditional set instructions (default).
8261
8262 This switch is mainly for debugging the compiler and will likely be removed
8263 in a future version.
8264
8265 @item -mno-scc
8266 @opindex mno-scc
8267
8268 Disable the use of conditional set instructions.
8269
8270 This switch is mainly for debugging the compiler and will likely be removed
8271 in a future version.
8272
8273 @item -mcond-exec
8274 @opindex mcond-exec
8275
8276 Enable the use of conditional execution (default).
8277
8278 This switch is mainly for debugging the compiler and will likely be removed
8279 in a future version.
8280
8281 @item -mno-cond-exec
8282 @opindex mno-cond-exec
8283
8284 Disable the use of conditional execution.
8285
8286 This switch is mainly for debugging the compiler and will likely be removed
8287 in a future version.
8288
8289 @item -mvliw-branch
8290 @opindex mvliw-branch
8291
8292 Run a pass to pack branches into VLIW instructions (default).
8293
8294 This switch is mainly for debugging the compiler and will likely be removed
8295 in a future version.
8296
8297 @item -mno-vliw-branch
8298 @opindex mno-vliw-branch
8299
8300 Do not run a pass to pack branches into VLIW instructions.
8301
8302 This switch is mainly for debugging the compiler and will likely be removed
8303 in a future version.
8304
8305 @item -mmulti-cond-exec
8306 @opindex mmulti-cond-exec
8307
8308 Enable optimization of @code{&&} and @code{||} in conditional execution
8309 (default).
8310
8311 This switch is mainly for debugging the compiler and will likely be removed
8312 in a future version.
8313
8314 @item -mno-multi-cond-exec
8315 @opindex mno-multi-cond-exec
8316
8317 Disable optimization of @code{&&} and @code{||} in conditional execution.
8318
8319 This switch is mainly for debugging the compiler and will likely be removed
8320 in a future version.
8321
8322 @item -mnested-cond-exec
8323 @opindex mnested-cond-exec
8324
8325 Enable nested conditional execution optimizations (default).
8326
8327 This switch is mainly for debugging the compiler and will likely be removed
8328 in a future version.
8329
8330 @item -mno-nested-cond-exec
8331 @opindex mno-nested-cond-exec
8332
8333 Disable nested conditional execution optimizations.
8334
8335 This switch is mainly for debugging the compiler and will likely be removed
8336 in a future version.
8337
8338 @item -mtomcat-stats
8339 @opindex mtomcat-stats
8340
8341 Cause gas to print out tomcat statistics.
8342
8343 @item -mcpu=@var{cpu}
8344 @opindex mcpu
8345
8346 Select the processor type for which to generate code. Possible values are
8347 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8348 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8349
8350 @end table
8351
8352 @node H8/300 Options
8353 @subsection H8/300 Options
8354
8355 These @samp{-m} options are defined for the H8/300 implementations:
8356
8357 @table @gcctabopt
8358 @item -mrelax
8359 @opindex mrelax
8360 Shorten some address references at link time, when possible; uses the
8361 linker option @option{-relax}. @xref{H8/300,, @code{ld} and the H8/300,
8362 ld, Using ld}, for a fuller description.
8363
8364 @item -mh
8365 @opindex mh
8366 Generate code for the H8/300H@.
8367
8368 @item -ms
8369 @opindex ms
8370 Generate code for the H8S@.
8371
8372 @item -mn
8373 @opindex mn
8374 Generate code for the H8S and H8/300H in the normal mode. This switch
8375 must be used either with @option{-mh} or @option{-ms}.
8376
8377 @item -ms2600
8378 @opindex ms2600
8379 Generate code for the H8S/2600. This switch must be used with @option{-ms}.
8380
8381 @item -mint32
8382 @opindex mint32
8383 Make @code{int} data 32 bits by default.
8384
8385 @item -malign-300
8386 @opindex malign-300
8387 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8388 The default for the H8/300H and H8S is to align longs and floats on 4
8389 byte boundaries.
8390 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8391 This option has no effect on the H8/300.
8392 @end table
8393
8394 @node HPPA Options
8395 @subsection HPPA Options
8396 @cindex HPPA Options
8397
8398 These @samp{-m} options are defined for the HPPA family of computers:
8399
8400 @table @gcctabopt
8401 @item -march=@var{architecture-type}
8402 @opindex march
8403 Generate code for the specified architecture. The choices for
8404 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8405 1.1, and @samp{2.0} for PA 2.0 processors. Refer to
8406 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8407 architecture option for your machine. Code compiled for lower numbered
8408 architectures will run on higher numbered architectures, but not the
8409 other way around.
8410
8411 @item -mpa-risc-1-0
8412 @itemx -mpa-risc-1-1
8413 @itemx -mpa-risc-2-0
8414 @opindex mpa-risc-1-0
8415 @opindex mpa-risc-1-1
8416 @opindex mpa-risc-2-0
8417 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8418
8419 @item -mbig-switch
8420 @opindex mbig-switch
8421 Generate code suitable for big switch tables. Use this option only if
8422 the assembler/linker complain about out of range branches within a switch
8423 table.
8424
8425 @item -mjump-in-delay
8426 @opindex mjump-in-delay
8427 Fill delay slots of function calls with unconditional jump instructions
8428 by modifying the return pointer for the function call to be the target
8429 of the conditional jump.
8430
8431 @item -mdisable-fpregs
8432 @opindex mdisable-fpregs
8433 Prevent floating point registers from being used in any manner. This is
8434 necessary for compiling kernels which perform lazy context switching of
8435 floating point registers. If you use this option and attempt to perform
8436 floating point operations, the compiler will abort.
8437
8438 @item -mdisable-indexing
8439 @opindex mdisable-indexing
8440 Prevent the compiler from using indexing address modes. This avoids some
8441 rather obscure problems when compiling MIG generated code under MACH@.
8442
8443 @item -mno-space-regs
8444 @opindex mno-space-regs
8445 Generate code that assumes the target has no space registers. This allows
8446 GCC to generate faster indirect calls and use unscaled index address modes.
8447
8448 Such code is suitable for level 0 PA systems and kernels.
8449
8450 @item -mfast-indirect-calls
8451 @opindex mfast-indirect-calls
8452 Generate code that assumes calls never cross space boundaries. This
8453 allows GCC to emit code which performs faster indirect calls.
8454
8455 This option will not work in the presence of shared libraries or nested
8456 functions.
8457
8458 @item -mfixed-range=@var{register-range}
8459 @opindex mfixed-range
8460 Generate code treating the given register range as fixed registers.
8461 A fixed register is one that the register allocator can not use. This is
8462 useful when compiling kernel code. A register range is specified as
8463 two registers separated by a dash. Multiple register ranges can be
8464 specified separated by a comma.
8465
8466 @item -mlong-load-store
8467 @opindex mlong-load-store
8468 Generate 3-instruction load and store sequences as sometimes required by
8469 the HP-UX 10 linker. This is equivalent to the @samp{+k} option to
8470 the HP compilers.
8471
8472 @item -mportable-runtime
8473 @opindex mportable-runtime
8474 Use the portable calling conventions proposed by HP for ELF systems.
8475
8476 @item -mgas
8477 @opindex mgas
8478 Enable the use of assembler directives only GAS understands.
8479
8480 @item -mschedule=@var{cpu-type}
8481 @opindex mschedule
8482 Schedule code according to the constraints for the machine type
8483 @var{cpu-type}. The choices for @var{cpu-type} are @samp{700}
8484 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}. Refer
8485 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8486 proper scheduling option for your machine. The default scheduling is
8487 @samp{8000}.
8488
8489 @item -mlinker-opt
8490 @opindex mlinker-opt
8491 Enable the optimization pass in the HP-UX linker. Note this makes symbolic
8492 debugging impossible. It also triggers a bug in the HP-UX 8 and HP-UX 9
8493 linkers in which they give bogus error messages when linking some programs.
8494
8495 @item -msoft-float
8496 @opindex msoft-float
8497 Generate output containing library calls for floating point.
8498 @strong{Warning:} the requisite libraries are not available for all HPPA
8499 targets. Normally the facilities of the machine's usual C compiler are
8500 used, but this cannot be done directly in cross-compilation. You must make
8501 your own arrangements to provide suitable library functions for
8502 cross-compilation. The embedded target @samp{hppa1.1-*-pro}
8503 does provide software floating point support.
8504
8505 @option{-msoft-float} changes the calling convention in the output file;
8506 therefore, it is only useful if you compile @emph{all} of a program with
8507 this option. In particular, you need to compile @file{libgcc.a}, the
8508 library that comes with GCC, with @option{-msoft-float} in order for
8509 this to work.
8510
8511 @item -msio
8512 @opindex msio
8513 Generate the predefine, @code{_SIO}, for server IO@. The default is
8514 @option{-mwsio}. This generates the predefines, @code{__hp9000s700},
8515 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@. These
8516 options are available under HP-UX and HI-UX@.
8517
8518 @item -mgnu-ld
8519 @opindex gnu-ld
8520 Use GNU ld specific options. This passes @option{-shared} to ld when
8521 building a shared library. It is the default when GCC is configured,
8522 explicitly or implicitly, with the GNU linker. This option does not
8523 have any affect on which ld is called, it only changes what parameters
8524 are passed to that ld. The ld that is called is determined by the
8525 @option{--with-ld} configure option, GCC's program search path, and
8526 finally by the user's @env{PATH}. The linker used by GCC can be printed
8527 using @samp{which `gcc -print-prog-name=ld`}.
8528
8529 @item -mhp-ld
8530 @opindex hp-ld
8531 Use HP ld specific options. This passes @option{-b} to ld when building
8532 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8533 links. It is the default when GCC is configured, explicitly or
8534 implicitly, with the HP linker. This option does not have any affect on
8535 which ld is called, it only changes what parameters are passed to that
8536 ld. The ld that is called is determined by the @option{--with-ld}
8537 configure option, GCC's program search path, and finally by the user's
8538 @env{PATH}. The linker used by GCC can be printed using @samp{which
8539 `gcc -print-prog-name=ld`}.
8540
8541 @item -mlong-calls
8542 @opindex mno-long-calls
8543 Generate code that uses long call sequences. This ensures that a call
8544 is always able to reach linker generated stubs. The default is to generate
8545 long calls only when the distance from the call site to the beginning
8546 of the function or translation unit, as the case may be, exceeds a
8547 predefined limit set by the branch type being used. The limits for
8548 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8549 PA 2.0 and PA 1.X architectures. Sibcalls are always limited at
8550 240,000 bytes.
8551
8552 Distances are measured from the beginning of functions when using the
8553 @option{-ffunction-sections} option, or when using the @option{-mgas}
8554 and @option{-mno-portable-runtime} options together under HP-UX with
8555 the SOM linker.
8556
8557 It is normally not desirable to use this option as it will degrade
8558 performance. However, it may be useful in large applications,
8559 particularly when partial linking is used to build the application.
8560
8561 The types of long calls used depends on the capabilities of the
8562 assembler and linker, and the type of code being generated. The
8563 impact on systems that support long absolute calls, and long pic
8564 symbol-difference or pc-relative calls should be relatively small.
8565 However, an indirect call is used on 32-bit ELF systems in pic code
8566 and it is quite long.
8567
8568 @item -munix=@var{unix-std}
8569 @opindex march
8570 Generate compiler predefines and select a startfile for the specified
8571 UNIX standard. The choices for @var{unix-std} are @samp{93}, @samp{95}
8572 and @samp{98}. @samp{93} is supported on all HP-UX versions. @samp{95}
8573 is available on HP-UX 10.10 and later. @samp{98} is available on HP-UX
8574 11.11 and later. The default values are @samp{93} for HP-UX 10.00,
8575 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8576 and later.
8577
8578 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8579 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8580 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8581 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8582 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8583 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8584
8585 It is @emph{important} to note that this option changes the interfaces
8586 for various library routines. It also affects the operational behavior
8587 of the C library. Thus, @emph{extreme} care is needed in using this
8588 option.
8589
8590 Library code that is intended to operate with more than one UNIX
8591 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8592 as appropriate. Most GNU software doesn't provide this capability.
8593
8594 @item -nolibdld
8595 @opindex nolibdld
8596 Suppress the generation of link options to search libdld.sl when the
8597 @option{-static} option is specified on HP-UX 10 and later.
8598
8599 @item -static
8600 @opindex static
8601 The HP-UX implementation of setlocale in libc has a dependency on
8602 libdld.sl. There isn't an archive version of libdld.sl. Thus,
8603 when the @option{-static} option is specified, special link options
8604 are needed to resolve this dependency.
8605
8606 On HP-UX 10 and later, the GCC driver adds the necessary options to
8607 link with libdld.sl when the @option{-static} option is specified.
8608 This causes the resulting binary to be dynamic. On the 64-bit port,
8609 the linkers generate dynamic binaries by default in any case. The
8610 @option{-nolibdld} option can be used to prevent the GCC driver from
8611 adding these link options.
8612
8613 @item -threads
8614 @opindex threads
8615 Add support for multithreading with the @dfn{dce thread} library
8616 under HP-UX@. This option sets flags for both the preprocessor and
8617 linker.
8618 @end table
8619
8620 @node i386 and x86-64 Options
8621 @subsection Intel 386 and AMD x86-64 Options
8622 @cindex i386 Options
8623 @cindex x86-64 Options
8624 @cindex Intel 386 Options
8625 @cindex AMD x86-64 Options
8626
8627 These @samp{-m} options are defined for the i386 and x86-64 family of
8628 computers:
8629
8630 @table @gcctabopt
8631 @item -mtune=@var{cpu-type}
8632 @opindex mtune
8633 Tune to @var{cpu-type} everything applicable about the generated code, except
8634 for the ABI and the set of available instructions. The choices for
8635 @var{cpu-type} are:
8636 @table @emph
8637 @item i386
8638 Original Intel's i386 CPU@.
8639 @item i486
8640 Intel's i486 CPU@. (No scheduling is implemented for this chip.)
8641 @item i586, pentium
8642 Intel Pentium CPU with no MMX support.
8643 @item pentium-mmx
8644 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8645 @item i686, pentiumpro
8646 Intel PentiumPro CPU@.
8647 @item pentium2
8648 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8649 @item pentium3, pentium3m
8650 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8651 support.
8652 @item pentium-m
8653 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8654 support. Used by Centrino notebooks.
8655 @item pentium4, pentium4m
8656 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8657 @item prescott
8658 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8659 set support.
8660 @item nocona
8661 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8662 SSE2 and SSE3 instruction set support.
8663 @item k6
8664 AMD K6 CPU with MMX instruction set support.
8665 @item k6-2, k6-3
8666 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8667 @item athlon, athlon-tbird
8668 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8669 support.
8670 @item athlon-4, athlon-xp, athlon-mp
8671 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8672 instruction set support.
8673 @item k8, opteron, athlon64, athlon-fx
8674 AMD K8 core based CPUs with x86-64 instruction set support. (This supersets
8675 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8676 @item winchip-c6
8677 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8678 set support.
8679 @item winchip2
8680 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8681 instruction set support.
8682 @item c3
8683 Via C3 CPU with MMX and 3dNOW! instruction set support. (No scheduling is
8684 implemented for this chip.)
8685 @item c3-2
8686 Via C3-2 CPU with MMX and SSE instruction set support. (No scheduling is
8687 implemented for this chip.)
8688 @end table
8689
8690 While picking a specific @var{cpu-type} will schedule things appropriately
8691 for that particular chip, the compiler will not generate any code that
8692 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8693 being used.
8694
8695 @item -march=@var{cpu-type}
8696 @opindex march
8697 Generate instructions for the machine type @var{cpu-type}. The choices
8698 for @var{cpu-type} are the same as for @option{-mtune}. Moreover,
8699 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8700
8701 @item -mcpu=@var{cpu-type}
8702 @opindex mcpu
8703 A deprecated synonym for @option{-mtune}.
8704
8705 @item -m386
8706 @itemx -m486
8707 @itemx -mpentium
8708 @itemx -mpentiumpro
8709 @opindex m386
8710 @opindex m486
8711 @opindex mpentium
8712 @opindex mpentiumpro
8713 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8714 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8715 These synonyms are deprecated.
8716
8717 @item -mfpmath=@var{unit}
8718 @opindex march
8719 Generate floating point arithmetics for selected unit @var{unit}. The choices
8720 for @var{unit} are:
8721
8722 @table @samp
8723 @item 387
8724 Use the standard 387 floating point coprocessor present majority of chips and
8725 emulated otherwise. Code compiled with this option will run almost everywhere.
8726 The temporary results are computed in 80bit precision instead of precision
8727 specified by the type resulting in slightly different results compared to most
8728 of other chips. See @option{-ffloat-store} for more detailed description.
8729
8730 This is the default choice for i386 compiler.
8731
8732 @item sse
8733 Use scalar floating point instructions present in the SSE instruction set.
8734 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8735 by Athlon-4, Athlon-xp and Athlon-mp chips. The earlier version of SSE
8736 instruction set supports only single precision arithmetics, thus the double and
8737 extended precision arithmetics is still done using 387. Later version, present
8738 only in Pentium4 and the future AMD x86-64 chips supports double precision
8739 arithmetics too.
8740
8741 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
8742 or @option{-msse2} switches to enable SSE extensions and make this option
8743 effective. For the x86-64 compiler, these extensions are enabled by default.
8744
8745 The resulting code should be considerably faster in the majority of cases and avoid
8746 the numerical instability problems of 387 code, but may break some existing
8747 code that expects temporaries to be 80bit.
8748
8749 This is the default choice for the x86-64 compiler.
8750
8751 @item sse,387
8752 Attempt to utilize both instruction sets at once. This effectively double the
8753 amount of available registers and on chips with separate execution units for
8754 387 and SSE the execution resources too. Use this option with care, as it is
8755 still experimental, because the GCC register allocator does not model separate
8756 functional units well resulting in instable performance.
8757 @end table
8758
8759 @item -masm=@var{dialect}
8760 @opindex masm=@var{dialect}
8761 Output asm instructions using selected @var{dialect}. Supported choices are
8762 @samp{intel} or @samp{att} (the default one).
8763
8764 @item -mieee-fp
8765 @itemx -mno-ieee-fp
8766 @opindex mieee-fp
8767 @opindex mno-ieee-fp
8768 Control whether or not the compiler uses IEEE floating point
8769 comparisons. These handle correctly the case where the result of a
8770 comparison is unordered.
8771
8772 @item -msoft-float
8773 @opindex msoft-float
8774 Generate output containing library calls for floating point.
8775 @strong{Warning:} the requisite libraries are not part of GCC@.
8776 Normally the facilities of the machine's usual C compiler are used, but
8777 this can't be done directly in cross-compilation. You must make your
8778 own arrangements to provide suitable library functions for
8779 cross-compilation.
8780
8781 On machines where a function returns floating point results in the 80387
8782 register stack, some floating point opcodes may be emitted even if
8783 @option{-msoft-float} is used.
8784
8785 @item -mno-fp-ret-in-387
8786 @opindex mno-fp-ret-in-387
8787 Do not use the FPU registers for return values of functions.
8788
8789 The usual calling convention has functions return values of types
8790 @code{float} and @code{double} in an FPU register, even if there
8791 is no FPU@. The idea is that the operating system should emulate
8792 an FPU@.
8793
8794 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8795 in ordinary CPU registers instead.
8796
8797 @item -mno-fancy-math-387
8798 @opindex mno-fancy-math-387
8799 Some 387 emulators do not support the @code{sin}, @code{cos} and
8800 @code{sqrt} instructions for the 387. Specify this option to avoid
8801 generating those instructions. This option is the default on FreeBSD,
8802 OpenBSD and NetBSD@. This option is overridden when @option{-march}
8803 indicates that the target cpu will always have an FPU and so the
8804 instruction will not need emulation. As of revision 2.6.1, these
8805 instructions are not generated unless you also use the
8806 @option{-funsafe-math-optimizations} switch.
8807
8808 @item -malign-double
8809 @itemx -mno-align-double
8810 @opindex malign-double
8811 @opindex mno-align-double
8812 Control whether GCC aligns @code{double}, @code{long double}, and
8813 @code{long long} variables on a two word boundary or a one word
8814 boundary. Aligning @code{double} variables on a two word boundary will
8815 produce code that runs somewhat faster on a @samp{Pentium} at the
8816 expense of more memory.
8817
8818 @strong{Warning:} if you use the @option{-malign-double} switch,
8819 structures containing the above types will be aligned differently than
8820 the published application binary interface specifications for the 386
8821 and will not be binary compatible with structures in code compiled
8822 without that switch.
8823
8824 @item -m96bit-long-double
8825 @itemx -m128bit-long-double
8826 @opindex m96bit-long-double
8827 @opindex m128bit-long-double
8828 These switches control the size of @code{long double} type. The i386
8829 application binary interface specifies the size to be 96 bits,
8830 so @option{-m96bit-long-double} is the default in 32 bit mode.
8831
8832 Modern architectures (Pentium and newer) would prefer @code{long double}
8833 to be aligned to an 8 or 16 byte boundary. In arrays or structures
8834 conforming to the ABI, this would not be possible. So specifying a
8835 @option{-m128bit-long-double} will align @code{long double}
8836 to a 16 byte boundary by padding the @code{long double} with an additional
8837 32 bit zero.
8838
8839 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8840 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8841
8842 Notice that neither of these options enable any extra precision over the x87
8843 standard of 80 bits for a @code{long double}.
8844
8845 @strong{Warning:} if you override the default value for your target ABI, the
8846 structures and arrays containing @code{long double} variables will change
8847 their size as well as function calling convention for function taking
8848 @code{long double} will be modified. Hence they will not be binary
8849 compatible with arrays or structures in code compiled without that switch.
8850
8851
8852 @item -msvr3-shlib
8853 @itemx -mno-svr3-shlib
8854 @opindex msvr3-shlib
8855 @opindex mno-svr3-shlib
8856 Control whether GCC places uninitialized local variables into the
8857 @code{bss} or @code{data} segments. @option{-msvr3-shlib} places them
8858 into @code{bss}. These options are meaningful only on System V Release 3.
8859
8860 @item -mrtd
8861 @opindex mrtd
8862 Use a different function-calling convention, in which functions that
8863 take a fixed number of arguments return with the @code{ret} @var{num}
8864 instruction, which pops their arguments while returning. This saves one
8865 instruction in the caller since there is no need to pop the arguments
8866 there.
8867
8868 You can specify that an individual function is called with this calling
8869 sequence with the function attribute @samp{stdcall}. You can also
8870 override the @option{-mrtd} option by using the function attribute
8871 @samp{cdecl}. @xref{Function Attributes}.
8872
8873 @strong{Warning:} this calling convention is incompatible with the one
8874 normally used on Unix, so you cannot use it if you need to call
8875 libraries compiled with the Unix compiler.
8876
8877 Also, you must provide function prototypes for all functions that
8878 take variable numbers of arguments (including @code{printf});
8879 otherwise incorrect code will be generated for calls to those
8880 functions.
8881
8882 In addition, seriously incorrect code will result if you call a
8883 function with too many arguments. (Normally, extra arguments are
8884 harmlessly ignored.)
8885
8886 @item -mregparm=@var{num}
8887 @opindex mregparm
8888 Control how many registers are used to pass integer arguments. By
8889 default, no registers are used to pass arguments, and at most 3
8890 registers can be used. You can control this behavior for a specific
8891 function by using the function attribute @samp{regparm}.
8892 @xref{Function Attributes}.
8893
8894 @strong{Warning:} if you use this switch, and
8895 @var{num} is nonzero, then you must build all modules with the same
8896 value, including any libraries. This includes the system libraries and
8897 startup modules.
8898
8899 @item -mpreferred-stack-boundary=@var{num}
8900 @opindex mpreferred-stack-boundary
8901 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8902 byte boundary. If @option{-mpreferred-stack-boundary} is not specified,
8903 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8904 size (@option{-Os}), in which case the default is the minimum correct
8905 alignment (4 bytes for x86, and 8 bytes for x86-64).
8906
8907 On Pentium and PentiumPro, @code{double} and @code{long double} values
8908 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8909 suffer significant run time performance penalties. On Pentium III, the
8910 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8911 penalties if it is not 16 byte aligned.
8912
8913 To ensure proper alignment of this values on the stack, the stack boundary
8914 must be as aligned as that required by any value stored on the stack.
8915 Further, every function must be generated such that it keeps the stack
8916 aligned. Thus calling a function compiled with a higher preferred
8917 stack boundary from a function compiled with a lower preferred stack
8918 boundary will most likely misalign the stack. It is recommended that
8919 libraries that use callbacks always use the default setting.
8920
8921 This extra alignment does consume extra stack space, and generally
8922 increases code size. Code that is sensitive to stack space usage, such
8923 as embedded systems and operating system kernels, may want to reduce the
8924 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8925
8926 @item -mmmx
8927 @itemx -mno-mmx
8928 @item -msse
8929 @itemx -mno-sse
8930 @item -msse2
8931 @itemx -mno-sse2
8932 @item -msse3
8933 @itemx -mno-sse3
8934 @item -m3dnow
8935 @itemx -mno-3dnow
8936 @opindex mmmx
8937 @opindex mno-mmx
8938 @opindex msse
8939 @opindex mno-sse
8940 @opindex m3dnow
8941 @opindex mno-3dnow
8942 These switches enable or disable the use of built-in functions that allow
8943 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
8944 instruction set.
8945
8946 @xref{X86 Built-in Functions}, for details of the functions enabled
8947 and disabled by these switches.
8948
8949 To have SSE/SSE2 instructions generated automatically from floating-point
8950 code, see @option{-mfpmath=sse}.
8951
8952 @item -mpush-args
8953 @itemx -mno-push-args
8954 @opindex mpush-args
8955 @opindex mno-push-args
8956 Use PUSH operations to store outgoing parameters. This method is shorter
8957 and usually equally fast as method using SUB/MOV operations and is enabled
8958 by default. In some cases disabling it may improve performance because of
8959 improved scheduling and reduced dependencies.
8960
8961 @item -maccumulate-outgoing-args
8962 @opindex maccumulate-outgoing-args
8963 If enabled, the maximum amount of space required for outgoing arguments will be
8964 computed in the function prologue. This is faster on most modern CPUs
8965 because of reduced dependencies, improved scheduling and reduced stack usage
8966 when preferred stack boundary is not equal to 2. The drawback is a notable
8967 increase in code size. This switch implies @option{-mno-push-args}.
8968
8969 @item -mthreads
8970 @opindex mthreads
8971 Support thread-safe exception handling on @samp{Mingw32}. Code that relies
8972 on thread-safe exception handling must compile and link all code with the
8973 @option{-mthreads} option. When compiling, @option{-mthreads} defines
8974 @option{-D_MT}; when linking, it links in a special thread helper library
8975 @option{-lmingwthrd} which cleans up per thread exception handling data.
8976
8977 @item -mno-align-stringops
8978 @opindex mno-align-stringops
8979 Do not align destination of inlined string operations. This switch reduces
8980 code size and improves performance in case the destination is already aligned,
8981 but GCC doesn't know about it.
8982
8983 @item -minline-all-stringops
8984 @opindex minline-all-stringops
8985 By default GCC inlines string operations only when destination is known to be
8986 aligned at least to 4 byte boundary. This enables more inlining, increase code
8987 size, but may improve performance of code that depends on fast memcpy, strlen
8988 and memset for short lengths.
8989
8990 @item -momit-leaf-frame-pointer
8991 @opindex momit-leaf-frame-pointer
8992 Don't keep the frame pointer in a register for leaf functions. This
8993 avoids the instructions to save, set up and restore frame pointers and
8994 makes an extra register available in leaf functions. The option
8995 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8996 which might make debugging harder.
8997
8998 @item -mtls-direct-seg-refs
8999 @itemx -mno-tls-direct-seg-refs
9000 @opindex mtls-direct-seg-refs
9001 Controls whether TLS variables may be accessed with offsets from the
9002 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9003 or whether the thread base pointer must be added. Whether or not this
9004 is legal depends on the operating system, and whether it maps the
9005 segment to cover the entire TLS area.
9006
9007 For systems that use GNU libc, the default is on.
9008 @end table
9009
9010 These @samp{-m} switches are supported in addition to the above
9011 on AMD x86-64 processors in 64-bit environments.
9012
9013 @table @gcctabopt
9014 @item -m32
9015 @itemx -m64
9016 @opindex m32
9017 @opindex m64
9018 Generate code for a 32-bit or 64-bit environment.
9019 The 32-bit environment sets int, long and pointer to 32 bits and
9020 generates code that runs on any i386 system.
9021 The 64-bit environment sets int to 32 bits and long and pointer
9022 to 64 bits and generates code for AMD's x86-64 architecture.
9023
9024 @item -mno-red-zone
9025 @opindex no-red-zone
9026 Do not use a so called red zone for x86-64 code. The red zone is mandated
9027 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9028 stack pointer that will not be modified by signal or interrupt handlers
9029 and therefore can be used for temporary data without adjusting the stack
9030 pointer. The flag @option{-mno-red-zone} disables this red zone.
9031
9032 @item -mcmodel=small
9033 @opindex mcmodel=small
9034 Generate code for the small code model: the program and its symbols must
9035 be linked in the lower 2 GB of the address space. Pointers are 64 bits.
9036 Programs can be statically or dynamically linked. This is the default
9037 code model.
9038
9039 @item -mcmodel=kernel
9040 @opindex mcmodel=kernel
9041 Generate code for the kernel code model. The kernel runs in the
9042 negative 2 GB of the address space.
9043 This model has to be used for Linux kernel code.
9044
9045 @item -mcmodel=medium
9046 @opindex mcmodel=medium
9047 Generate code for the medium model: The program is linked in the lower 2
9048 GB of the address space but symbols can be located anywhere in the
9049 address space. Programs can be statically or dynamically linked, but
9050 building of shared libraries are not supported with the medium model.
9051
9052 @item -mcmodel=large
9053 @opindex mcmodel=large
9054 Generate code for the large model: This model makes no assumptions
9055 about addresses and sizes of sections. Currently GCC does not implement
9056 this model.
9057 @end table
9058
9059 @node IA-64 Options
9060 @subsection IA-64 Options
9061 @cindex IA-64 Options
9062
9063 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9064
9065 @table @gcctabopt
9066 @item -mbig-endian
9067 @opindex mbig-endian
9068 Generate code for a big endian target. This is the default for HP-UX@.
9069
9070 @item -mlittle-endian
9071 @opindex mlittle-endian
9072 Generate code for a little endian target. This is the default for AIX5
9073 and GNU/Linux.
9074
9075 @item -mgnu-as
9076 @itemx -mno-gnu-as
9077 @opindex mgnu-as
9078 @opindex mno-gnu-as
9079 Generate (or don't) code for the GNU assembler. This is the default.
9080 @c Also, this is the default if the configure option @option{--with-gnu-as}
9081 @c is used.
9082
9083 @item -mgnu-ld
9084 @itemx -mno-gnu-ld
9085 @opindex mgnu-ld
9086 @opindex mno-gnu-ld
9087 Generate (or don't) code for the GNU linker. This is the default.
9088 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9089 @c is used.
9090
9091 @item -mno-pic
9092 @opindex mno-pic
9093 Generate code that does not use a global pointer register. The result
9094 is not position independent code, and violates the IA-64 ABI@.
9095
9096 @item -mvolatile-asm-stop
9097 @itemx -mno-volatile-asm-stop
9098 @opindex mvolatile-asm-stop
9099 @opindex mno-volatile-asm-stop
9100 Generate (or don't) a stop bit immediately before and after volatile asm
9101 statements.
9102
9103 @item -mregister-names
9104 @itemx -mno-register-names
9105 @opindex mregister-names
9106 @opindex mno-register-names
9107 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9108 the stacked registers. This may make assembler output more readable.
9109
9110 @item -mno-sdata
9111 @itemx -msdata
9112 @opindex mno-sdata
9113 @opindex msdata
9114 Disable (or enable) optimizations that use the small data section. This may
9115 be useful for working around optimizer bugs.
9116
9117 @item -mconstant-gp
9118 @opindex mconstant-gp
9119 Generate code that uses a single constant global pointer value. This is
9120 useful when compiling kernel code.
9121
9122 @item -mauto-pic
9123 @opindex mauto-pic
9124 Generate code that is self-relocatable. This implies @option{-mconstant-gp}.
9125 This is useful when compiling firmware code.
9126
9127 @item -minline-float-divide-min-latency
9128 @opindex minline-float-divide-min-latency
9129 Generate code for inline divides of floating point values
9130 using the minimum latency algorithm.
9131
9132 @item -minline-float-divide-max-throughput
9133 @opindex minline-float-divide-max-throughput
9134 Generate code for inline divides of floating point values
9135 using the maximum throughput algorithm.
9136
9137 @item -minline-int-divide-min-latency
9138 @opindex minline-int-divide-min-latency
9139 Generate code for inline divides of integer values
9140 using the minimum latency algorithm.
9141
9142 @item -minline-int-divide-max-throughput
9143 @opindex minline-int-divide-max-throughput
9144 Generate code for inline divides of integer values
9145 using the maximum throughput algorithm.
9146
9147 @item -minline-sqrt-min-latency
9148 @opindex minline-sqrt-min-latency
9149 Generate code for inline square roots
9150 using the minimum latency algorithm.
9151
9152 @item -minline-sqrt-max-throughput
9153 @opindex minline-sqrt-max-throughput
9154 Generate code for inline square roots
9155 using the maximum throughput algorithm.
9156
9157 @item -mno-dwarf2-asm
9158 @itemx -mdwarf2-asm
9159 @opindex mno-dwarf2-asm
9160 @opindex mdwarf2-asm
9161 Don't (or do) generate assembler code for the DWARF2 line number debugging
9162 info. This may be useful when not using the GNU assembler.
9163
9164 @item -mearly-stop-bits
9165 @itemx -mno-early-stop-bits
9166 @opindex mearly-stop-bits
9167 @opindex mno-early-stop-bits
9168 Allow stop bits to be placed earlier than immediately preceding the
9169 instruction that triggered the stop bit. This can improve instruction
9170 scheduling, but does not always do so.
9171
9172 @item -mfixed-range=@var{register-range}
9173 @opindex mfixed-range
9174 Generate code treating the given register range as fixed registers.
9175 A fixed register is one that the register allocator can not use. This is
9176 useful when compiling kernel code. A register range is specified as
9177 two registers separated by a dash. Multiple register ranges can be
9178 specified separated by a comma.
9179
9180 @item -mtls-size=@var{tls-size}
9181 @opindex mtls-size
9182 Specify bit size of immediate TLS offsets. Valid values are 14, 22, and
9183 64.
9184
9185 @item -mtune-arch=@var{cpu-type}
9186 @opindex mtune-arch
9187 Tune the instruction scheduling for a particular CPU, Valid values are
9188 itanium, itanium1, merced, itanium2, and mckinley.
9189
9190 @item -mt
9191 @itemx -pthread
9192 @opindex mt
9193 @opindex pthread
9194 Add support for multithreading using the POSIX threads library. This
9195 option sets flags for both the preprocessor and linker. It does
9196 not affect the thread safety of object code produced by the compiler or
9197 that of libraries supplied with it. These are HP-UX specific flags.
9198
9199 @item -milp32
9200 @itemx -mlp64
9201 @opindex milp32
9202 @opindex mlp64
9203 Generate code for a 32-bit or 64-bit environment.
9204 The 32-bit environment sets int, long and pointer to 32 bits.
9205 The 64-bit environment sets int to 32 bits and long and pointer
9206 to 64 bits. These are HP-UX specific flags.
9207
9208 @end table
9209
9210 @node M32R/D Options
9211 @subsection M32R/D Options
9212 @cindex M32R/D options
9213
9214 These @option{-m} options are defined for Renesas M32R/D architectures:
9215
9216 @table @gcctabopt
9217 @item -m32r2
9218 @opindex m32r2
9219 Generate code for the M32R/2@.
9220
9221 @item -m32rx
9222 @opindex m32rx
9223 Generate code for the M32R/X@.
9224
9225 @item -m32r
9226 @opindex m32r
9227 Generate code for the M32R@. This is the default.
9228
9229 @item -mmodel=small
9230 @opindex mmodel=small
9231 Assume all objects live in the lower 16MB of memory (so that their addresses
9232 can be loaded with the @code{ld24} instruction), and assume all subroutines
9233 are reachable with the @code{bl} instruction.
9234 This is the default.
9235
9236 The addressability of a particular object can be set with the
9237 @code{model} attribute.
9238
9239 @item -mmodel=medium
9240 @opindex mmodel=medium
9241 Assume objects may be anywhere in the 32-bit address space (the compiler
9242 will generate @code{seth/add3} instructions to load their addresses), and
9243 assume all subroutines are reachable with the @code{bl} instruction.
9244
9245 @item -mmodel=large
9246 @opindex mmodel=large
9247 Assume objects may be anywhere in the 32-bit address space (the compiler
9248 will generate @code{seth/add3} instructions to load their addresses), and
9249 assume subroutines may not be reachable with the @code{bl} instruction
9250 (the compiler will generate the much slower @code{seth/add3/jl}
9251 instruction sequence).
9252
9253 @item -msdata=none
9254 @opindex msdata=none
9255 Disable use of the small data area. Variables will be put into
9256 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9257 @code{section} attribute has been specified).
9258 This is the default.
9259
9260 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9261 Objects may be explicitly put in the small data area with the
9262 @code{section} attribute using one of these sections.
9263
9264 @item -msdata=sdata
9265 @opindex msdata=sdata
9266 Put small global and static data in the small data area, but do not
9267 generate special code to reference them.
9268
9269 @item -msdata=use
9270 @opindex msdata=use
9271 Put small global and static data in the small data area, and generate
9272 special instructions to reference them.
9273
9274 @item -G @var{num}
9275 @opindex G
9276 @cindex smaller data references
9277 Put global and static objects less than or equal to @var{num} bytes
9278 into the small data or bss sections instead of the normal data or bss
9279 sections. The default value of @var{num} is 8.
9280 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9281 for this option to have any effect.
9282
9283 All modules should be compiled with the same @option{-G @var{num}} value.
9284 Compiling with different values of @var{num} may or may not work; if it
9285 doesn't the linker will give an error message---incorrect code will not be
9286 generated.
9287
9288 @item -mdebug
9289 @opindex mdebug
9290 Makes the M32R specific code in the compiler display some statistics
9291 that might help in debugging programs.
9292
9293 @item -malign-loops
9294 @opindex malign-loops
9295 Align all loops to a 32-byte boundary.
9296
9297 @item -mno-align-loops
9298 @opindex mno-align-loops
9299 Do not enforce a 32-byte alignment for loops. This is the default.
9300
9301 @item -missue-rate=@var{number}
9302 @opindex missue-rate=@var{number}
9303 Issue @var{number} instructions per cycle. @var{number} can only be 1
9304 or 2.
9305
9306 @item -mbranch-cost=@var{number}
9307 @opindex mbranch-cost=@var{number}
9308 @var{number} can only be 1 or 2. If it is 1 then branches will be
9309 preferred over conditional code, if it is 2, then the opposite will
9310 apply.
9311
9312 @item -mflush-trap=@var{number}
9313 @opindex mflush-trap=@var{number}
9314 Specifies the trap number to use to flush the cache. The default is
9315 12. Valid numbers are between 0 and 15 inclusive.
9316
9317 @item -mno-flush-trap
9318 @opindex mno-flush-trap
9319 Specifies that the cache cannot be flushed by using a trap.
9320
9321 @item -mflush-func=@var{name}
9322 @opindex mflush-func=@var{name}
9323 Specifies the name of the operating system function to call to flush
9324 the cache. The default is @emph{_flush_cache}, but a function call
9325 will only be used if a trap is not available.
9326
9327 @item -mno-flush-func
9328 @opindex mno-flush-func
9329 Indicates that there is no OS function for flushing the cache.
9330
9331 @end table
9332
9333 @node M680x0 Options
9334 @subsection M680x0 Options
9335 @cindex M680x0 options
9336
9337 These are the @samp{-m} options defined for the 68000 series. The default
9338 values for these options depends on which style of 68000 was selected when
9339 the compiler was configured; the defaults for the most common choices are
9340 given below.
9341
9342 @table @gcctabopt
9343 @item -m68000
9344 @itemx -mc68000
9345 @opindex m68000
9346 @opindex mc68000
9347 Generate output for a 68000. This is the default
9348 when the compiler is configured for 68000-based systems.
9349
9350 Use this option for microcontrollers with a 68000 or EC000 core,
9351 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9352
9353 @item -m68020
9354 @itemx -mc68020
9355 @opindex m68020
9356 @opindex mc68020
9357 Generate output for a 68020. This is the default
9358 when the compiler is configured for 68020-based systems.
9359
9360 @item -m68881
9361 @opindex m68881
9362 Generate output containing 68881 instructions for floating point.
9363 This is the default for most 68020 systems unless @option{--nfp} was
9364 specified when the compiler was configured.
9365
9366 @item -m68030
9367 @opindex m68030
9368 Generate output for a 68030. This is the default when the compiler is
9369 configured for 68030-based systems.
9370
9371 @item -m68040
9372 @opindex m68040
9373 Generate output for a 68040. This is the default when the compiler is
9374 configured for 68040-based systems.
9375
9376 This option inhibits the use of 68881/68882 instructions that have to be
9377 emulated by software on the 68040. Use this option if your 68040 does not
9378 have code to emulate those instructions.
9379
9380 @item -m68060
9381 @opindex m68060
9382 Generate output for a 68060. This is the default when the compiler is
9383 configured for 68060-based systems.
9384
9385 This option inhibits the use of 68020 and 68881/68882 instructions that
9386 have to be emulated by software on the 68060. Use this option if your 68060
9387 does not have code to emulate those instructions.
9388
9389 @item -mcpu32
9390 @opindex mcpu32
9391 Generate output for a CPU32. This is the default
9392 when the compiler is configured for CPU32-based systems.
9393
9394 Use this option for microcontrollers with a
9395 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9396 68336, 68340, 68341, 68349 and 68360.
9397
9398 @item -m5200
9399 @opindex m5200
9400 Generate output for a 520X ``coldfire'' family cpu. This is the default
9401 when the compiler is configured for 520X-based systems.
9402
9403 Use this option for microcontroller with a 5200 core, including
9404 the MCF5202, MCF5203, MCF5204 and MCF5202.
9405
9406
9407 @item -m68020-40
9408 @opindex m68020-40
9409 Generate output for a 68040, without using any of the new instructions.
9410 This results in code which can run relatively efficiently on either a
9411 68020/68881 or a 68030 or a 68040. The generated code does use the
9412 68881 instructions that are emulated on the 68040.
9413
9414 @item -m68020-60
9415 @opindex m68020-60
9416 Generate output for a 68060, without using any of the new instructions.
9417 This results in code which can run relatively efficiently on either a
9418 68020/68881 or a 68030 or a 68040. The generated code does use the
9419 68881 instructions that are emulated on the 68060.
9420
9421 @item -msoft-float
9422 @opindex msoft-float
9423 Generate output containing library calls for floating point.
9424 @strong{Warning:} the requisite libraries are not available for all m68k
9425 targets. Normally the facilities of the machine's usual C compiler are
9426 used, but this can't be done directly in cross-compilation. You must
9427 make your own arrangements to provide suitable library functions for
9428 cross-compilation. The embedded targets @samp{m68k-*-aout} and
9429 @samp{m68k-*-coff} do provide software floating point support.
9430
9431 @item -mshort
9432 @opindex mshort
9433 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9434 Additionally, parameters passed on the stack are also aligned to a
9435 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9436
9437 @item -mnobitfield
9438 @opindex mnobitfield
9439 Do not use the bit-field instructions. The @option{-m68000}, @option{-mcpu32}
9440 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9441
9442 @item -mbitfield
9443 @opindex mbitfield
9444 Do use the bit-field instructions. The @option{-m68020} option implies
9445 @option{-mbitfield}. This is the default if you use a configuration
9446 designed for a 68020.
9447
9448 @item -mrtd
9449 @opindex mrtd
9450 Use a different function-calling convention, in which functions
9451 that take a fixed number of arguments return with the @code{rtd}
9452 instruction, which pops their arguments while returning. This
9453 saves one instruction in the caller since there is no need to pop
9454 the arguments there.
9455
9456 This calling convention is incompatible with the one normally
9457 used on Unix, so you cannot use it if you need to call libraries
9458 compiled with the Unix compiler.
9459
9460 Also, you must provide function prototypes for all functions that
9461 take variable numbers of arguments (including @code{printf});
9462 otherwise incorrect code will be generated for calls to those
9463 functions.
9464
9465 In addition, seriously incorrect code will result if you call a
9466 function with too many arguments. (Normally, extra arguments are
9467 harmlessly ignored.)
9468
9469 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9470 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9471
9472 @item -malign-int
9473 @itemx -mno-align-int
9474 @opindex malign-int
9475 @opindex mno-align-int
9476 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9477 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9478 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9479 Aligning variables on 32-bit boundaries produces code that runs somewhat
9480 faster on processors with 32-bit busses at the expense of more memory.
9481
9482 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9483 align structures containing the above types differently than
9484 most published application binary interface specifications for the m68k.
9485
9486 @item -mpcrel
9487 @opindex mpcrel
9488 Use the pc-relative addressing mode of the 68000 directly, instead of
9489 using a global offset table. At present, this option implies @option{-fpic},
9490 allowing at most a 16-bit offset for pc-relative addressing. @option{-fPIC} is
9491 not presently supported with @option{-mpcrel}, though this could be supported for
9492 68020 and higher processors.
9493
9494 @item -mno-strict-align
9495 @itemx -mstrict-align
9496 @opindex mno-strict-align
9497 @opindex mstrict-align
9498 Do not (do) assume that unaligned memory references will be handled by
9499 the system.
9500
9501 @item -msep-data
9502 Generate code that allows the data segment to be located in a different
9503 area of memory from the text segment. This allows for execute in place in
9504 an environment without virtual memory management. This option implies
9505 @option{-fPIC}.
9506
9507 @item -mno-sep-data
9508 Generate code that assumes that the data segment follows the text segment.
9509 This is the default.
9510
9511 @item -mid-shared-library
9512 Generate code that supports shared libraries via the library ID method.
9513 This allows for execute in place and shared libraries in an environment
9514 without virtual memory management. This option implies @option{-fPIC}.
9515
9516 @item -mno-id-shared-library
9517 Generate code that doesn't assume ID based shared libraries are being used.
9518 This is the default.
9519
9520 @item -mshared-library-id=n
9521 Specified the identification number of the ID based shared library being
9522 compiled. Specifying a value of 0 will generate more compact code, specifying
9523 other values will force the allocation of that number to the current
9524 library but is no more space or time efficient than omitting this option.
9525
9526 @end table
9527
9528 @node M68hc1x Options
9529 @subsection M68hc1x Options
9530 @cindex M68hc1x options
9531
9532 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9533 microcontrollers. The default values for these options depends on
9534 which style of microcontroller was selected when the compiler was configured;
9535 the defaults for the most common choices are given below.
9536
9537 @table @gcctabopt
9538 @item -m6811
9539 @itemx -m68hc11
9540 @opindex m6811
9541 @opindex m68hc11
9542 Generate output for a 68HC11. This is the default
9543 when the compiler is configured for 68HC11-based systems.
9544
9545 @item -m6812
9546 @itemx -m68hc12
9547 @opindex m6812
9548 @opindex m68hc12
9549 Generate output for a 68HC12. This is the default
9550 when the compiler is configured for 68HC12-based systems.
9551
9552 @item -m68S12
9553 @itemx -m68hcs12
9554 @opindex m68S12
9555 @opindex m68hcs12
9556 Generate output for a 68HCS12.
9557
9558 @item -mauto-incdec
9559 @opindex mauto-incdec
9560 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9561 addressing modes.
9562
9563 @item -minmax
9564 @itemx -nominmax
9565 @opindex minmax
9566 @opindex mnominmax
9567 Enable the use of 68HC12 min and max instructions.
9568
9569 @item -mlong-calls
9570 @itemx -mno-long-calls
9571 @opindex mlong-calls
9572 @opindex mno-long-calls
9573 Treat all calls as being far away (near). If calls are assumed to be
9574 far away, the compiler will use the @code{call} instruction to
9575 call a function and the @code{rtc} instruction for returning.
9576
9577 @item -mshort
9578 @opindex mshort
9579 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9580
9581 @item -msoft-reg-count=@var{count}
9582 @opindex msoft-reg-count
9583 Specify the number of pseudo-soft registers which are used for the
9584 code generation. The maximum number is 32. Using more pseudo-soft
9585 register may or may not result in better code depending on the program.
9586 The default is 4 for 68HC11 and 2 for 68HC12.
9587
9588 @end table
9589
9590 @node MCore Options
9591 @subsection MCore Options
9592 @cindex MCore options
9593
9594 These are the @samp{-m} options defined for the Motorola M*Core
9595 processors.
9596
9597 @table @gcctabopt
9598
9599 @item -mhardlit
9600 @itemx -mno-hardlit
9601 @opindex mhardlit
9602 @opindex mno-hardlit
9603 Inline constants into the code stream if it can be done in two
9604 instructions or less.
9605
9606 @item -mdiv
9607 @itemx -mno-div
9608 @opindex mdiv
9609 @opindex mno-div
9610 Use the divide instruction. (Enabled by default).
9611
9612 @item -mrelax-immediate
9613 @itemx -mno-relax-immediate
9614 @opindex mrelax-immediate
9615 @opindex mno-relax-immediate
9616 Allow arbitrary sized immediates in bit operations.
9617
9618 @item -mwide-bitfields
9619 @itemx -mno-wide-bitfields
9620 @opindex mwide-bitfields
9621 @opindex mno-wide-bitfields
9622 Always treat bit-fields as int-sized.
9623
9624 @item -m4byte-functions
9625 @itemx -mno-4byte-functions
9626 @opindex m4byte-functions
9627 @opindex mno-4byte-functions
9628 Force all functions to be aligned to a four byte boundary.
9629
9630 @item -mcallgraph-data
9631 @itemx -mno-callgraph-data
9632 @opindex mcallgraph-data
9633 @opindex mno-callgraph-data
9634 Emit callgraph information.
9635
9636 @item -mslow-bytes
9637 @itemx -mno-slow-bytes
9638 @opindex mslow-bytes
9639 @opindex mno-slow-bytes
9640 Prefer word access when reading byte quantities.
9641
9642 @item -mlittle-endian
9643 @itemx -mbig-endian
9644 @opindex mlittle-endian
9645 @opindex mbig-endian
9646 Generate code for a little endian target.
9647
9648 @item -m210
9649 @itemx -m340
9650 @opindex m210
9651 @opindex m340
9652 Generate code for the 210 processor.
9653 @end table
9654
9655 @node MIPS Options
9656 @subsection MIPS Options
9657 @cindex MIPS options
9658
9659 @table @gcctabopt
9660
9661 @item -EB
9662 @opindex EB
9663 Generate big-endian code.
9664
9665 @item -EL
9666 @opindex EL
9667 Generate little-endian code. This is the default for @samp{mips*el-*-*}
9668 configurations.
9669
9670 @item -march=@var{arch}
9671 @opindex march
9672 Generate code that will run on @var{arch}, which can be the name of a
9673 generic MIPS ISA, or the name of a particular processor.
9674 The ISA names are:
9675 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9676 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9677 The processor names are:
9678 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
9679 @samp{m4k},
9680 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9681 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
9682 @samp{rm9000},
9683 @samp{orion},
9684 @samp{sb1},
9685 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9686 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9687 The special value @samp{from-abi} selects the
9688 most compatible architecture for the selected ABI (that is,
9689 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9690
9691 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9692 (for example, @samp{-march=r2k}). Prefixes are optional, and
9693 @samp{vr} may be written @samp{r}.
9694
9695 GCC defines two macros based on the value of this option. The first
9696 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9697 a string. The second has the form @samp{_MIPS_ARCH_@var{foo}},
9698 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9699 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9700 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9701
9702 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9703 above. In other words, it will have the full prefix and will not
9704 abbreviate @samp{000} as @samp{k}. In the case of @samp{from-abi},
9705 the macro names the resolved architecture (either @samp{"mips1"} or
9706 @samp{"mips3"}). It names the default architecture when no
9707 @option{-march} option is given.
9708
9709 @item -mtune=@var{arch}
9710 @opindex mtune
9711 Optimize for @var{arch}. Among other things, this option controls
9712 the way instructions are scheduled, and the perceived cost of arithmetic
9713 operations. The list of @var{arch} values is the same as for
9714 @option{-march}.
9715
9716 When this option is not used, GCC will optimize for the processor
9717 specified by @option{-march}. By using @option{-march} and
9718 @option{-mtune} together, it is possible to generate code that will
9719 run on a family of processors, but optimize the code for one
9720 particular member of that family.
9721
9722 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
9723 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
9724 @samp{-march} ones described above.
9725
9726 @item -mips1
9727 @opindex mips1
9728 Equivalent to @samp{-march=mips1}.
9729
9730 @item -mips2
9731 @opindex mips2
9732 Equivalent to @samp{-march=mips2}.
9733
9734 @item -mips3
9735 @opindex mips3
9736 Equivalent to @samp{-march=mips3}.
9737
9738 @item -mips4
9739 @opindex mips4
9740 Equivalent to @samp{-march=mips4}.
9741
9742 @item -mips32
9743 @opindex mips32
9744 Equivalent to @samp{-march=mips32}.
9745
9746 @item -mips32r2
9747 @opindex mips32r2
9748 Equivalent to @samp{-march=mips32r2}.
9749
9750 @item -mips64
9751 @opindex mips64
9752 Equivalent to @samp{-march=mips64}.
9753
9754 @item -mips16
9755 @itemx -mno-mips16
9756 @opindex mips16
9757 @opindex mno-mips16
9758 Use (do not use) the MIPS16 ISA@.
9759
9760 @item -mabi=32
9761 @itemx -mabi=o64
9762 @itemx -mabi=n32
9763 @itemx -mabi=64
9764 @itemx -mabi=eabi
9765 @opindex mabi=32
9766 @opindex mabi=o64
9767 @opindex mabi=n32
9768 @opindex mabi=64
9769 @opindex mabi=eabi
9770 Generate code for the given ABI@.
9771
9772 Note that the EABI has a 32-bit and a 64-bit variant. GCC normally
9773 generates 64-bit code when you select a 64-bit architecture, but you
9774 can use @option{-mgp32} to get 32-bit code instead.
9775
9776 For information about the O64 ABI, see
9777 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
9778
9779 @item -mabicalls
9780 @itemx -mno-abicalls
9781 @opindex mabicalls
9782 @opindex mno-abicalls
9783 Generate (do not generate) SVR4-style position-independent code.
9784 @option{-mabicalls} is the default for SVR4-based systems.
9785
9786 @item -mxgot
9787 @itemx -mno-xgot
9788 @opindex mxgot
9789 @opindex mno-xgot
9790 Lift (do not lift) the usual restrictions on the size of the global
9791 offset table.
9792
9793 GCC normally uses a single instruction to load values from the GOT@.
9794 While this is relatively efficient, it will only work if the GOT
9795 is smaller than about 64k. Anything larger will cause the linker
9796 to report an error such as:
9797
9798 @cindex relocation truncated to fit (MIPS)
9799 @smallexample
9800 relocation truncated to fit: R_MIPS_GOT16 foobar
9801 @end smallexample
9802
9803 If this happens, you should recompile your code with @option{-mxgot}.
9804 It should then work with very large GOTs, although it will also be
9805 less efficient, since it will take three instructions to fetch the
9806 value of a global symbol.
9807
9808 Note that some linkers can create multiple GOTs. If you have such a
9809 linker, you should only need to use @option{-mxgot} when a single object
9810 file accesses more than 64k's worth of GOT entries. Very few do.
9811
9812 These options have no effect unless GCC is generating position
9813 independent code.
9814
9815 @item -mgp32
9816 @opindex mgp32
9817 Assume that general-purpose registers are 32 bits wide.
9818
9819 @item -mgp64
9820 @opindex mgp64
9821 Assume that general-purpose registers are 64 bits wide.
9822
9823 @item -mfp32
9824 @opindex mfp32
9825 Assume that floating-point registers are 32 bits wide.
9826
9827 @item -mfp64
9828 @opindex mfp64
9829 Assume that floating-point registers are 64 bits wide.
9830
9831 @item -mhard-float
9832 @opindex mhard-float
9833 Use floating-point coprocessor instructions.
9834
9835 @item -msoft-float
9836 @opindex msoft-float
9837 Do not use floating-point coprocessor instructions. Implement
9838 floating-point calculations using library calls instead.
9839
9840 @item -msingle-float
9841 @opindex msingle-float
9842 Assume that the floating-point coprocessor only supports single-precision
9843 operations.
9844
9845 @itemx -mdouble-float
9846 @opindex mdouble-float
9847 Assume that the floating-point coprocessor supports double-precision
9848 operations. This is the default.
9849
9850 @itemx -mpaired-single
9851 @itemx -mno-paired-single
9852 @opindex mpaired-single
9853 @opindex mno-paired-single
9854 Use (do not use) paired-single floating-point instructions.
9855 @xref{MIPS Paired-Single Support}. This option can only be used
9856 when generating 64-bit code and requires hardware floating-point
9857 support to be enabled.
9858
9859 @itemx -mips3d
9860 @itemx -mno-mips3d
9861 @opindex mips3d
9862 @opindex mno-mips3d
9863 Use (do not use) the MIPS-3D ASE@. @xref{MIPS-3D Built-in Functions}.
9864 The option @option{-mips3d} implies @option{-mpaired-single}.
9865
9866 @item -mlong64
9867 @opindex mlong64
9868 Force @code{long} types to be 64 bits wide. See @option{-mlong32} for
9869 an explanation of the default and the way that the pointer size is
9870 determined.
9871
9872 @item -mlong32
9873 @opindex mlong32
9874 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
9875
9876 The default size of @code{int}s, @code{long}s and pointers depends on
9877 the ABI@. All the supported ABIs use 32-bit @code{int}s. The n64 ABI
9878 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
9879 32-bit @code{long}s. Pointers are the same size as @code{long}s,
9880 or the same size as integer registers, whichever is smaller.
9881
9882 @item -msym32
9883 @itemx -mno-sym32
9884 @opindex msym32
9885 @opindex mno-sym32
9886 Assume (do not assume) that all symbols have 32-bit values, regardless
9887 of the selected ABI@. This option is useful in combination with
9888 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
9889 to generate shorter and faster references to symbolic addresses.
9890
9891 @item -G @var{num}
9892 @opindex G
9893 @cindex smaller data references (MIPS)
9894 @cindex gp-relative references (MIPS)
9895 Put global and static items less than or equal to @var{num} bytes into
9896 the small data or bss section instead of the normal data or bss section.
9897 This allows the data to be accessed using a single instruction.
9898
9899 All modules should be compiled with the same @option{-G @var{num}}
9900 value.
9901
9902 @item -membedded-data
9903 @itemx -mno-embedded-data
9904 @opindex membedded-data
9905 @opindex mno-embedded-data
9906 Allocate variables to the read-only data section first if possible, then
9907 next in the small data section if possible, otherwise in data. This gives
9908 slightly slower code than the default, but reduces the amount of RAM required
9909 when executing, and thus may be preferred for some embedded systems.
9910
9911 @item -muninit-const-in-rodata
9912 @itemx -mno-uninit-const-in-rodata
9913 @opindex muninit-const-in-rodata
9914 @opindex mno-uninit-const-in-rodata
9915 Put uninitialized @code{const} variables in the read-only data section.
9916 This option is only meaningful in conjunction with @option{-membedded-data}.
9917
9918 @item -msplit-addresses
9919 @itemx -mno-split-addresses
9920 @opindex msplit-addresses
9921 @opindex mno-split-addresses
9922 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
9923 relocation operators. This option has been superseded by
9924 @option{-mexplicit-relocs} but is retained for backwards compatibility.
9925
9926 @item -mexplicit-relocs
9927 @itemx -mno-explicit-relocs
9928 @opindex mexplicit-relocs
9929 @opindex mno-explicit-relocs
9930 Use (do not use) assembler relocation operators when dealing with symbolic
9931 addresses. The alternative, selected by @option{-mno-explicit-relocs},
9932 is to use assembler macros instead.
9933
9934 @option{-mexplicit-relocs} is the default if GCC was configured
9935 to use an assembler that supports relocation operators.
9936
9937 @item -mcheck-zero-division
9938 @itemx -mno-check-zero-division
9939 @opindex mcheck-zero-division
9940 @opindex mno-check-zero-division
9941 Trap (do not trap) on integer division by zero. The default is
9942 @option{-mcheck-zero-division}.
9943
9944 @item -mdivide-traps
9945 @itemx -mdivide-breaks
9946 @opindex mdivide-traps
9947 @opindex mdivide-breaks
9948 MIPS systems check for division by zero by generating either a
9949 conditional trap or a break instruction. Using traps results in
9950 smaller code, but is only supported on MIPS II and later. Also, some
9951 versions of the Linux kernel have a bug that prevents trap from
9952 generating the proper signal (@code{SIGFPE}). Use @option{-mdivide-traps} to
9953 allow conditional traps on architectures that support them and
9954 @option{-mdivide-breaks} to force the use of breaks.
9955
9956 The default is usually @option{-mdivide-traps}, but this can be
9957 overridden at configure time using @option{--with-divide=breaks}.
9958 Divide-by-zero checks can be completely disabled using
9959 @option{-mno-check-zero-division}.
9960
9961 @item -mmemcpy
9962 @itemx -mno-memcpy
9963 @opindex mmemcpy
9964 @opindex mno-memcpy
9965 Force (do not force) the use of @code{memcpy()} for non-trivial block
9966 moves. The default is @option{-mno-memcpy}, which allows GCC to inline
9967 most constant-sized copies.
9968
9969 @item -mlong-calls
9970 @itemx -mno-long-calls
9971 @opindex mlong-calls
9972 @opindex mno-long-calls
9973 Disable (do not disable) use of the @code{jal} instruction. Calling
9974 functions using @code{jal} is more efficient but requires the caller
9975 and callee to be in the same 256 megabyte segment.
9976
9977 This option has no effect on abicalls code. The default is
9978 @option{-mno-long-calls}.
9979
9980 @item -mmad
9981 @itemx -mno-mad
9982 @opindex mmad
9983 @opindex mno-mad
9984 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
9985 instructions, as provided by the R4650 ISA@.
9986
9987 @item -mfused-madd
9988 @itemx -mno-fused-madd
9989 @opindex mfused-madd
9990 @opindex mno-fused-madd
9991 Enable (disable) use of the floating point multiply-accumulate
9992 instructions, when they are available. The default is
9993 @option{-mfused-madd}.
9994
9995 When multiply-accumulate instructions are used, the intermediate
9996 product is calculated to infinite precision and is not subject to
9997 the FCSR Flush to Zero bit. This may be undesirable in some
9998 circumstances.
9999
10000 @item -nocpp
10001 @opindex nocpp
10002 Tell the MIPS assembler to not run its preprocessor over user
10003 assembler files (with a @samp{.s} suffix) when assembling them.
10004
10005 @item -mfix-r4000
10006 @itemx -mno-fix-r4000
10007 @opindex mfix-r4000
10008 @opindex mno-fix-r4000
10009 Work around certain R4000 CPU errata:
10010 @itemize @minus
10011 @item
10012 A double-word or a variable shift may give an incorrect result if executed
10013 immediately after starting an integer division.
10014 @item
10015 A double-word or a variable shift may give an incorrect result if executed
10016 while an integer multiplication is in progress.
10017 @item
10018 An integer division may give an incorrect result if started in a delay slot
10019 of a taken branch or a jump.
10020 @end itemize
10021
10022 @item -mfix-r4400
10023 @itemx -mno-fix-r4400
10024 @opindex mfix-r4400
10025 @opindex mno-fix-r4400
10026 Work around certain R4400 CPU errata:
10027 @itemize @minus
10028 @item
10029 A double-word or a variable shift may give an incorrect result if executed
10030 immediately after starting an integer division.
10031 @end itemize
10032
10033 @item -mfix-vr4120
10034 @itemx -mno-fix-vr4120
10035 @opindex mfix-vr4120
10036 Work around certain VR4120 errata:
10037 @itemize @minus
10038 @item
10039 @code{dmultu} does not always produce the correct result.
10040 @item
10041 @code{div} and @code{ddiv} do not always produce the correct result if one
10042 of the operands is negative.
10043 @end itemize
10044 The workarounds for the division errata rely on special functions in
10045 @file{libgcc.a}. At present, these functions are only provided by
10046 the @code{mips64vr*-elf} configurations.
10047
10048 Other VR4120 errata require a nop to be inserted between certain pairs of
10049 instructions. These errata are handled by the assembler, not by GCC itself.
10050
10051 @item -mfix-vr4130
10052 @opindex mfix-vr4130
10053 Work around the VR4130 @code{mflo}/@code{mfhi} errata. The
10054 workarounds are implemented by the assembler rather than by GCC,
10055 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10056 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10057 instructions are available instead.
10058
10059 @item -mfix-sb1
10060 @itemx -mno-fix-sb1
10061 @opindex mfix-sb1
10062 Work around certain SB-1 CPU core errata.
10063 (This flag currently works around the SB-1 revision 2
10064 ``F1'' and ``F2'' floating point errata.)
10065
10066 @item -mflush-func=@var{func}
10067 @itemx -mno-flush-func
10068 @opindex mflush-func
10069 Specifies the function to call to flush the I and D caches, or to not
10070 call any such function. If called, the function must take the same
10071 arguments as the common @code{_flush_func()}, that is, the address of the
10072 memory range for which the cache is being flushed, the size of the
10073 memory range, and the number 3 (to flush both caches). The default
10074 depends on the target GCC was configured for, but commonly is either
10075 @samp{_flush_func} or @samp{__cpu_flush}.
10076
10077 @item -mbranch-likely
10078 @itemx -mno-branch-likely
10079 @opindex mbranch-likely
10080 @opindex mno-branch-likely
10081 Enable or disable use of Branch Likely instructions, regardless of the
10082 default for the selected architecture. By default, Branch Likely
10083 instructions may be generated if they are supported by the selected
10084 architecture. An exception is for the MIPS32 and MIPS64 architectures
10085 and processors which implement those architectures; for those, Branch
10086 Likely instructions will not be generated by default because the MIPS32
10087 and MIPS64 architectures specifically deprecate their use.
10088
10089 @item -mfp-exceptions
10090 @itemx -mno-fp-exceptions
10091 @opindex mfp-exceptions
10092 Specifies whether FP exceptions are enabled. This affects how we schedule
10093 FP instructions for some processors. The default is that FP exceptions are
10094 enabled.
10095
10096 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10097 64-bit code, then we can use both FP pipes. Otherwise, we can only use one
10098 FP pipe.
10099
10100 @item -mvr4130-align
10101 @itemx -mno-vr4130-align
10102 @opindex mvr4130-align
10103 The VR4130 pipeline is two-way superscalar, but can only issue two
10104 instructions together if the first one is 8-byte aligned. When this
10105 option is enabled, GCC will align pairs of instructions that it
10106 thinks should execute in parallel.
10107
10108 This option only has an effect when optimizing for the VR4130.
10109 It normally makes code faster, but at the expense of making it bigger.
10110 It is enabled by default at optimization level @option{-O3}.
10111 @end table
10112
10113 @node MMIX Options
10114 @subsection MMIX Options
10115 @cindex MMIX Options
10116
10117 These options are defined for the MMIX:
10118
10119 @table @gcctabopt
10120 @item -mlibfuncs
10121 @itemx -mno-libfuncs
10122 @opindex mlibfuncs
10123 @opindex mno-libfuncs
10124 Specify that intrinsic library functions are being compiled, passing all
10125 values in registers, no matter the size.
10126
10127 @item -mepsilon
10128 @itemx -mno-epsilon
10129 @opindex mepsilon
10130 @opindex mno-epsilon
10131 Generate floating-point comparison instructions that compare with respect
10132 to the @code{rE} epsilon register.
10133
10134 @item -mabi=mmixware
10135 @itemx -mabi=gnu
10136 @opindex mabi-mmixware
10137 @opindex mabi=gnu
10138 Generate code that passes function parameters and return values that (in
10139 the called function) are seen as registers @code{$0} and up, as opposed to
10140 the GNU ABI which uses global registers @code{$231} and up.
10141
10142 @item -mzero-extend
10143 @itemx -mno-zero-extend
10144 @opindex mzero-extend
10145 @opindex mno-zero-extend
10146 When reading data from memory in sizes shorter than 64 bits, use (do not
10147 use) zero-extending load instructions by default, rather than
10148 sign-extending ones.
10149
10150 @item -mknuthdiv
10151 @itemx -mno-knuthdiv
10152 @opindex mknuthdiv
10153 @opindex mno-knuthdiv
10154 Make the result of a division yielding a remainder have the same sign as
10155 the divisor. With the default, @option{-mno-knuthdiv}, the sign of the
10156 remainder follows the sign of the dividend. Both methods are
10157 arithmetically valid, the latter being almost exclusively used.
10158
10159 @item -mtoplevel-symbols
10160 @itemx -mno-toplevel-symbols
10161 @opindex mtoplevel-symbols
10162 @opindex mno-toplevel-symbols
10163 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10164 code can be used with the @code{PREFIX} assembly directive.
10165
10166 @item -melf
10167 @opindex melf
10168 Generate an executable in the ELF format, rather than the default
10169 @samp{mmo} format used by the @command{mmix} simulator.
10170
10171 @item -mbranch-predict
10172 @itemx -mno-branch-predict
10173 @opindex mbranch-predict
10174 @opindex mno-branch-predict
10175 Use (do not use) the probable-branch instructions, when static branch
10176 prediction indicates a probable branch.
10177
10178 @item -mbase-addresses
10179 @itemx -mno-base-addresses
10180 @opindex mbase-addresses
10181 @opindex mno-base-addresses
10182 Generate (do not generate) code that uses @emph{base addresses}. Using a
10183 base address automatically generates a request (handled by the assembler
10184 and the linker) for a constant to be set up in a global register. The
10185 register is used for one or more base address requests within the range 0
10186 to 255 from the value held in the register. The generally leads to short
10187 and fast code, but the number of different data items that can be
10188 addressed is limited. This means that a program that uses lots of static
10189 data may require @option{-mno-base-addresses}.
10190
10191 @item -msingle-exit
10192 @itemx -mno-single-exit
10193 @opindex msingle-exit
10194 @opindex mno-single-exit
10195 Force (do not force) generated code to have a single exit point in each
10196 function.
10197 @end table
10198
10199 @node MN10300 Options
10200 @subsection MN10300 Options
10201 @cindex MN10300 options
10202
10203 These @option{-m} options are defined for Matsushita MN10300 architectures:
10204
10205 @table @gcctabopt
10206 @item -mmult-bug
10207 @opindex mmult-bug
10208 Generate code to avoid bugs in the multiply instructions for the MN10300
10209 processors. This is the default.
10210
10211 @item -mno-mult-bug
10212 @opindex mno-mult-bug
10213 Do not generate code to avoid bugs in the multiply instructions for the
10214 MN10300 processors.
10215
10216 @item -mam33
10217 @opindex mam33
10218 Generate code which uses features specific to the AM33 processor.
10219
10220 @item -mno-am33
10221 @opindex mno-am33
10222 Do not generate code which uses features specific to the AM33 processor. This
10223 is the default.
10224
10225 @item -mno-crt0
10226 @opindex mno-crt0
10227 Do not link in the C run-time initialization object file.
10228
10229 @item -mrelax
10230 @opindex mrelax
10231 Indicate to the linker that it should perform a relaxation optimization pass
10232 to shorten branches, calls and absolute memory addresses. This option only
10233 has an effect when used on the command line for the final link step.
10234
10235 This option makes symbolic debugging impossible.
10236 @end table
10237
10238 @node NS32K Options
10239 @subsection NS32K Options
10240 @cindex NS32K options
10241
10242 These are the @samp{-m} options defined for the 32000 series. The default
10243 values for these options depends on which style of 32000 was selected when
10244 the compiler was configured; the defaults for the most common choices are
10245 given below.
10246
10247 @table @gcctabopt
10248 @item -m32032
10249 @itemx -m32032
10250 @opindex m32032
10251 @opindex m32032
10252 Generate output for a 32032. This is the default
10253 when the compiler is configured for 32032 and 32016 based systems.
10254
10255 @item -m32332
10256 @itemx -m32332
10257 @opindex m32332
10258 @opindex m32332
10259 Generate output for a 32332. This is the default
10260 when the compiler is configured for 32332-based systems.
10261
10262 @item -m32532
10263 @itemx -m32532
10264 @opindex m32532
10265 @opindex m32532
10266 Generate output for a 32532. This is the default
10267 when the compiler is configured for 32532-based systems.
10268
10269 @item -m32081
10270 @opindex m32081
10271 Generate output containing 32081 instructions for floating point.
10272 This is the default for all systems.
10273
10274 @item -m32381
10275 @opindex m32381
10276 Generate output containing 32381 instructions for floating point. This
10277 also implies @option{-m32081}. The 32381 is only compatible with the 32332
10278 and 32532 cpus. This is the default for the pc532-netbsd configuration.
10279
10280 @item -mmulti-add
10281 @opindex mmulti-add
10282 Try and generate multiply-add floating point instructions @code{polyF}
10283 and @code{dotF}. This option is only available if the @option{-m32381}
10284 option is in effect. Using these instructions requires changes to
10285 register allocation which generally has a negative impact on
10286 performance. This option should only be enabled when compiling code
10287 particularly likely to make heavy use of multiply-add instructions.
10288
10289 @item -mnomulti-add
10290 @opindex mnomulti-add
10291 Do not try and generate multiply-add floating point instructions
10292 @code{polyF} and @code{dotF}. This is the default on all platforms.
10293
10294 @item -msoft-float
10295 @opindex msoft-float
10296 Generate output containing library calls for floating point.
10297 @strong{Warning:} the requisite libraries may not be available.
10298
10299 @item -mieee-compare
10300 @itemx -mno-ieee-compare
10301 @opindex mieee-compare
10302 @opindex mno-ieee-compare
10303 Control whether or not the compiler uses IEEE floating point
10304 comparisons. These handle correctly the case where the result of a
10305 comparison is unordered.
10306 @strong{Warning:} the requisite kernel support may not be available.
10307
10308 @item -mnobitfield
10309 @opindex mnobitfield
10310 Do not use the bit-field instructions. On some machines it is faster to
10311 use shifting and masking operations. This is the default for the pc532.
10312
10313 @item -mbitfield
10314 @opindex mbitfield
10315 Do use the bit-field instructions. This is the default for all platforms
10316 except the pc532.
10317
10318 @item -mrtd
10319 @opindex mrtd
10320 Use a different function-calling convention, in which functions
10321 that take a fixed number of arguments return pop their
10322 arguments on return with the @code{ret} instruction.
10323
10324 This calling convention is incompatible with the one normally
10325 used on Unix, so you cannot use it if you need to call libraries
10326 compiled with the Unix compiler.
10327
10328 Also, you must provide function prototypes for all functions that
10329 take variable numbers of arguments (including @code{printf});
10330 otherwise incorrect code will be generated for calls to those
10331 functions.
10332
10333 In addition, seriously incorrect code will result if you call a
10334 function with too many arguments. (Normally, extra arguments are
10335 harmlessly ignored.)
10336
10337 This option takes its name from the 680x0 @code{rtd} instruction.
10338
10339
10340 @item -mregparam
10341 @opindex mregparam
10342 Use a different function-calling convention where the first two arguments
10343 are passed in registers.
10344
10345 This calling convention is incompatible with the one normally
10346 used on Unix, so you cannot use it if you need to call libraries
10347 compiled with the Unix compiler.
10348
10349 @item -mnoregparam
10350 @opindex mnoregparam
10351 Do not pass any arguments in registers. This is the default for all
10352 targets.
10353
10354 @item -msb
10355 @opindex msb
10356 It is OK to use the sb as an index register which is always loaded with
10357 zero. This is the default for the pc532-netbsd target.
10358
10359 @item -mnosb
10360 @opindex mnosb
10361 The sb register is not available for use or has not been initialized to
10362 zero by the run time system. This is the default for all targets except
10363 the pc532-netbsd. It is also implied whenever @option{-mhimem} or
10364 @option{-fpic} is set.
10365
10366 @item -mhimem
10367 @opindex mhimem
10368 Many ns32000 series addressing modes use displacements of up to 512MB@.
10369 If an address is above 512MB then displacements from zero can not be used.
10370 This option causes code to be generated which can be loaded above 512MB@.
10371 This may be useful for operating systems or ROM code.
10372
10373 @item -mnohimem
10374 @opindex mnohimem
10375 Assume code will be loaded in the first 512MB of virtual address space.
10376 This is the default for all platforms.
10377
10378 @end table
10379
10380 @node PDP-11 Options
10381 @subsection PDP-11 Options
10382 @cindex PDP-11 Options
10383
10384 These options are defined for the PDP-11:
10385
10386 @table @gcctabopt
10387 @item -mfpu
10388 @opindex mfpu
10389 Use hardware FPP floating point. This is the default. (FIS floating
10390 point on the PDP-11/40 is not supported.)
10391
10392 @item -msoft-float
10393 @opindex msoft-float
10394 Do not use hardware floating point.
10395
10396 @item -mac0
10397 @opindex mac0
10398 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10399
10400 @item -mno-ac0
10401 @opindex mno-ac0
10402 Return floating-point results in memory. This is the default.
10403
10404 @item -m40
10405 @opindex m40
10406 Generate code for a PDP-11/40.
10407
10408 @item -m45
10409 @opindex m45
10410 Generate code for a PDP-11/45. This is the default.
10411
10412 @item -m10
10413 @opindex m10
10414 Generate code for a PDP-11/10.
10415
10416 @item -mbcopy-builtin
10417 @opindex bcopy-builtin
10418 Use inline @code{movmemhi} patterns for copying memory. This is the
10419 default.
10420
10421 @item -mbcopy
10422 @opindex mbcopy
10423 Do not use inline @code{movmemhi} patterns for copying memory.
10424
10425 @item -mint16
10426 @itemx -mno-int32
10427 @opindex mint16
10428 @opindex mno-int32
10429 Use 16-bit @code{int}. This is the default.
10430
10431 @item -mint32
10432 @itemx -mno-int16
10433 @opindex mint32
10434 @opindex mno-int16
10435 Use 32-bit @code{int}.
10436
10437 @item -mfloat64
10438 @itemx -mno-float32
10439 @opindex mfloat64
10440 @opindex mno-float32
10441 Use 64-bit @code{float}. This is the default.
10442
10443 @item -mfloat32
10444 @itemx -mno-float64
10445 @opindex mfloat32
10446 @opindex mno-float64
10447 Use 32-bit @code{float}.
10448
10449 @item -mabshi
10450 @opindex mabshi
10451 Use @code{abshi2} pattern. This is the default.
10452
10453 @item -mno-abshi
10454 @opindex mno-abshi
10455 Do not use @code{abshi2} pattern.
10456
10457 @item -mbranch-expensive
10458 @opindex mbranch-expensive
10459 Pretend that branches are expensive. This is for experimenting with
10460 code generation only.
10461
10462 @item -mbranch-cheap
10463 @opindex mbranch-cheap
10464 Do not pretend that branches are expensive. This is the default.
10465
10466 @item -msplit
10467 @opindex msplit
10468 Generate code for a system with split I&D@.
10469
10470 @item -mno-split
10471 @opindex mno-split
10472 Generate code for a system without split I&D@. This is the default.
10473
10474 @item -munix-asm
10475 @opindex munix-asm
10476 Use Unix assembler syntax. This is the default when configured for
10477 @samp{pdp11-*-bsd}.
10478
10479 @item -mdec-asm
10480 @opindex mdec-asm
10481 Use DEC assembler syntax. This is the default when configured for any
10482 PDP-11 target other than @samp{pdp11-*-bsd}.
10483 @end table
10484
10485 @node PowerPC Options
10486 @subsection PowerPC Options
10487 @cindex PowerPC options
10488
10489 These are listed under @xref{RS/6000 and PowerPC Options}.
10490
10491 @node RS/6000 and PowerPC Options
10492 @subsection IBM RS/6000 and PowerPC Options
10493 @cindex RS/6000 and PowerPC Options
10494 @cindex IBM RS/6000 and PowerPC Options
10495
10496 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10497 @table @gcctabopt
10498 @item -mpower
10499 @itemx -mno-power
10500 @itemx -mpower2
10501 @itemx -mno-power2
10502 @itemx -mpowerpc
10503 @itemx -mno-powerpc
10504 @itemx -mpowerpc-gpopt
10505 @itemx -mno-powerpc-gpopt
10506 @itemx -mpowerpc-gfxopt
10507 @itemx -mno-powerpc-gfxopt
10508 @itemx -mpowerpc64
10509 @itemx -mno-powerpc64
10510 @opindex mpower
10511 @opindex mno-power
10512 @opindex mpower2
10513 @opindex mno-power2
10514 @opindex mpowerpc
10515 @opindex mno-powerpc
10516 @opindex mpowerpc-gpopt
10517 @opindex mno-powerpc-gpopt
10518 @opindex mpowerpc-gfxopt
10519 @opindex mno-powerpc-gfxopt
10520 @opindex mpowerpc64
10521 @opindex mno-powerpc64
10522 GCC supports two related instruction set architectures for the
10523 RS/6000 and PowerPC@. The @dfn{POWER} instruction set are those
10524 instructions supported by the @samp{rios} chip set used in the original
10525 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10526 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
10527 the IBM 4xx microprocessors.
10528
10529 Neither architecture is a subset of the other. However there is a
10530 large common subset of instructions supported by both. An MQ
10531 register is included in processors supporting the POWER architecture.
10532
10533 You use these options to specify which instructions are available on the
10534 processor you are using. The default value of these options is
10535 determined when configuring GCC@. Specifying the
10536 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10537 options. We recommend you use the @option{-mcpu=@var{cpu_type}} option
10538 rather than the options listed above.
10539
10540 The @option{-mpower} option allows GCC to generate instructions that
10541 are found only in the POWER architecture and to use the MQ register.
10542 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10543 to generate instructions that are present in the POWER2 architecture but
10544 not the original POWER architecture.
10545
10546 The @option{-mpowerpc} option allows GCC to generate instructions that
10547 are found only in the 32-bit subset of the PowerPC architecture.
10548 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10549 GCC to use the optional PowerPC architecture instructions in the
10550 General Purpose group, including floating-point square root. Specifying
10551 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10552 use the optional PowerPC architecture instructions in the Graphics
10553 group, including floating-point select.
10554
10555 The @option{-mpowerpc64} option allows GCC to generate the additional
10556 64-bit instructions that are found in the full PowerPC64 architecture
10557 and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to
10558 @option{-mno-powerpc64}.
10559
10560 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10561 will use only the instructions in the common subset of both
10562 architectures plus some special AIX common-mode calls, and will not use
10563 the MQ register. Specifying both @option{-mpower} and @option{-mpowerpc}
10564 permits GCC to use any instruction from either architecture and to
10565 allow use of the MQ register; specify this for the Motorola MPC601.
10566
10567 @item -mnew-mnemonics
10568 @itemx -mold-mnemonics
10569 @opindex mnew-mnemonics
10570 @opindex mold-mnemonics
10571 Select which mnemonics to use in the generated assembler code. With
10572 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10573 the PowerPC architecture. With @option{-mold-mnemonics} it uses the
10574 assembler mnemonics defined for the POWER architecture. Instructions
10575 defined in only one architecture have only one mnemonic; GCC uses that
10576 mnemonic irrespective of which of these options is specified.
10577
10578 GCC defaults to the mnemonics appropriate for the architecture in
10579 use. Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10580 value of these option. Unless you are building a cross-compiler, you
10581 should normally not specify either @option{-mnew-mnemonics} or
10582 @option{-mold-mnemonics}, but should instead accept the default.
10583
10584 @item -mcpu=@var{cpu_type}
10585 @opindex mcpu
10586 Set architecture type, register usage, choice of mnemonics, and
10587 instruction scheduling parameters for machine type @var{cpu_type}.
10588 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10589 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10590 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10591 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10592 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10593 @samp{860}, @samp{970}, @samp{8540}, @samp{common}, @samp{ec603e}, @samp{G3},
10594 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10595 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
10596 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
10597
10598 @option{-mcpu=common} selects a completely generic processor. Code
10599 generated under this option will run on any POWER or PowerPC processor.
10600 GCC will use only the instructions in the common subset of both
10601 architectures, and will not use the MQ register. GCC assumes a generic
10602 processor model for scheduling purposes.
10603
10604 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10605 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10606 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10607 types, with an appropriate, generic processor model assumed for
10608 scheduling purposes.
10609
10610 The other options specify a specific processor. Code generated under
10611 those options will run best on that processor, and may not run at all on
10612 others.
10613
10614 The @option{-mcpu} options automatically enable or disable the
10615 following options: @option{-maltivec}, @option{-mhard-float},
10616 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10617 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10618 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10619 @option{-mstring}. The particular options set for any particular CPU
10620 will vary between compiler versions, depending on what setting seems
10621 to produce optimal code for that CPU; it doesn't necessarily reflect
10622 the actual hardware's capabilities. If you wish to set an individual
10623 option to a particular value, you may specify it after the
10624 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10625
10626 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10627 not enabled or disabled by the @option{-mcpu} option at present, since
10628 AIX does not have full support for these options. You may still
10629 enable or disable them individually if you're sure it'll work in your
10630 environment.
10631
10632 @item -mtune=@var{cpu_type}
10633 @opindex mtune
10634 Set the instruction scheduling parameters for machine type
10635 @var{cpu_type}, but do not set the architecture type, register usage, or
10636 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would. The same
10637 values for @var{cpu_type} are used for @option{-mtune} as for
10638 @option{-mcpu}. If both are specified, the code generated will use the
10639 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10640 scheduling parameters set by @option{-mtune}.
10641
10642 @item -maltivec
10643 @itemx -mno-altivec
10644 @opindex maltivec
10645 @opindex mno-altivec
10646 Generate code that uses (does not use) AltiVec instructions, and also
10647 enable the use of built-in functions that allow more direct access to
10648 the AltiVec instruction set. You may also need to set
10649 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10650 enhancements.
10651
10652 @item -mvrsave
10653 @item -mno-vrsave
10654 @opindex mvrsave
10655 @opindex mno-vrsave
10656 Generate VRSAVE instructions when generating AltiVec code.
10657
10658 @item -mabi=spe
10659 @opindex mabi=spe
10660 Extend the current ABI with SPE ABI extensions. This does not change
10661 the default ABI, instead it adds the SPE ABI extensions to the current
10662 ABI@.
10663
10664 @item -mabi=no-spe
10665 @opindex mabi=no-spe
10666 Disable Booke SPE ABI extensions for the current ABI@.
10667
10668 @item -misel
10669 @itemx -mno-isel
10670 @opindex misel
10671 @opindex mno-isel
10672 This switch enables or disables the generation of ISEL instructions.
10673
10674 @item -misel=@var{yes/no}
10675 This switch has been deprecated. Use @option{-misel} and
10676 @option{-mno-isel} instead.
10677
10678 @item -mspe
10679 @itemx -mno-isel
10680 @opindex mspe
10681 @opindex mno-spe
10682 This switch enables or disables the generation of SPE simd
10683 instructions.
10684
10685 @item -mspe=@var{yes/no}
10686 This option has been deprecated. Use @option{-mspe} and
10687 @option{-mno-spe} instead.
10688
10689 @item -mfloat-gprs=@var{yes/single/double/no}
10690 @itemx -mfloat-gprs
10691 @opindex mfloat-gprs
10692 This switch enables or disables the generation of floating point
10693 operations on the general purpose registers for architectures that
10694 support it.
10695
10696 The argument @var{yes} or @var{single} enables the use of
10697 single-precision floating point operations.
10698
10699 The argument @var{double} enables the use of single and
10700 double-precision floating point operations.
10701
10702 The argument @var{no} disables floating point operations on the
10703 general purpose registers.
10704
10705 This option is currently only available on the MPC854x.
10706
10707 @item -m32
10708 @itemx -m64
10709 @opindex m32
10710 @opindex m64
10711 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10712 targets (including GNU/Linux). The 32-bit environment sets int, long
10713 and pointer to 32 bits and generates code that runs on any PowerPC
10714 variant. The 64-bit environment sets int to 32 bits and long and
10715 pointer to 64 bits, and generates code for PowerPC64, as for
10716 @option{-mpowerpc64}.
10717
10718 @item -mfull-toc
10719 @itemx -mno-fp-in-toc
10720 @itemx -mno-sum-in-toc
10721 @itemx -mminimal-toc
10722 @opindex mfull-toc
10723 @opindex mno-fp-in-toc
10724 @opindex mno-sum-in-toc
10725 @opindex mminimal-toc
10726 Modify generation of the TOC (Table Of Contents), which is created for
10727 every executable file. The @option{-mfull-toc} option is selected by
10728 default. In that case, GCC will allocate at least one TOC entry for
10729 each unique non-automatic variable reference in your program. GCC
10730 will also place floating-point constants in the TOC@. However, only
10731 16,384 entries are available in the TOC@.
10732
10733 If you receive a linker error message that saying you have overflowed
10734 the available TOC space, you can reduce the amount of TOC space used
10735 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10736 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10737 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10738 generate code to calculate the sum of an address and a constant at
10739 run-time instead of putting that sum into the TOC@. You may specify one
10740 or both of these options. Each causes GCC to produce very slightly
10741 slower and larger code at the expense of conserving TOC space.
10742
10743 If you still run out of space in the TOC even when you specify both of
10744 these options, specify @option{-mminimal-toc} instead. This option causes
10745 GCC to make only one TOC entry for every file. When you specify this
10746 option, GCC will produce code that is slower and larger but which
10747 uses extremely little TOC space. You may wish to use this option
10748 only on files that contain less frequently executed code.
10749
10750 @item -maix64
10751 @itemx -maix32
10752 @opindex maix64
10753 @opindex maix32
10754 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10755 @code{long} type, and the infrastructure needed to support them.
10756 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10757 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10758 implies @option{-mno-powerpc64}. GCC defaults to @option{-maix32}.
10759
10760 @item -mxl-compat
10761 @itemx -mno-xl-compat
10762 @opindex mxl-compat
10763 @opindex mno-xl-compat
10764 Produce code that conforms more closely to IBM XLC semantics when using
10765 AIX-compatible ABI. Pass floating-point arguments to prototyped
10766 functions beyond the register save area (RSA) on the stack in addition
10767 to argument FPRs. Do not assume that most significant double in 128
10768 bit long double value is properly rounded when comparing values.
10769
10770 The AIX calling convention was extended but not initially documented to
10771 handle an obscure K&R C case of calling a function that takes the
10772 address of its arguments with fewer arguments than declared. AIX XL
10773 compilers access floating point arguments which do not fit in the
10774 RSA from the stack when a subroutine is compiled without
10775 optimization. Because always storing floating-point arguments on the
10776 stack is inefficient and rarely needed, this option is not enabled by
10777 default and only is necessary when calling subroutines compiled by AIX
10778 XL compilers without optimization.
10779
10780 @item -mpe
10781 @opindex mpe
10782 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@. Link an
10783 application written to use message passing with special startup code to
10784 enable the application to run. The system must have PE installed in the
10785 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10786 must be overridden with the @option{-specs=} option to specify the
10787 appropriate directory location. The Parallel Environment does not
10788 support threads, so the @option{-mpe} option and the @option{-pthread}
10789 option are incompatible.
10790
10791 @item -malign-natural
10792 @itemx -malign-power
10793 @opindex malign-natural
10794 @opindex malign-power
10795 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
10796 @option{-malign-natural} overrides the ABI-defined alignment of larger
10797 types, such as floating-point doubles, on their natural size-based boundary.
10798 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10799 alignment rules. GCC defaults to the standard alignment defined in the ABI@.
10800
10801 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
10802 is not supported.
10803
10804 @item -msoft-float
10805 @itemx -mhard-float
10806 @opindex msoft-float
10807 @opindex mhard-float
10808 Generate code that does not use (uses) the floating-point register set.
10809 Software floating point emulation is provided if you use the
10810 @option{-msoft-float} option, and pass the option to GCC when linking.
10811
10812 @item -mmultiple
10813 @itemx -mno-multiple
10814 @opindex mmultiple
10815 @opindex mno-multiple
10816 Generate code that uses (does not use) the load multiple word
10817 instructions and the store multiple word instructions. These
10818 instructions are generated by default on POWER systems, and not
10819 generated on PowerPC systems. Do not use @option{-mmultiple} on little
10820 endian PowerPC systems, since those instructions do not work when the
10821 processor is in little endian mode. The exceptions are PPC740 and
10822 PPC750 which permit the instructions usage in little endian mode.
10823
10824 @item -mstring
10825 @itemx -mno-string
10826 @opindex mstring
10827 @opindex mno-string
10828 Generate code that uses (does not use) the load string instructions
10829 and the store string word instructions to save multiple registers and
10830 do small block moves. These instructions are generated by default on
10831 POWER systems, and not generated on PowerPC systems. Do not use
10832 @option{-mstring} on little endian PowerPC systems, since those
10833 instructions do not work when the processor is in little endian mode.
10834 The exceptions are PPC740 and PPC750 which permit the instructions
10835 usage in little endian mode.
10836
10837 @item -mupdate
10838 @itemx -mno-update
10839 @opindex mupdate
10840 @opindex mno-update
10841 Generate code that uses (does not use) the load or store instructions
10842 that update the base register to the address of the calculated memory
10843 location. These instructions are generated by default. If you use
10844 @option{-mno-update}, there is a small window between the time that the
10845 stack pointer is updated and the address of the previous frame is
10846 stored, which means code that walks the stack frame across interrupts or
10847 signals may get corrupted data.
10848
10849 @item -mfused-madd
10850 @itemx -mno-fused-madd
10851 @opindex mfused-madd
10852 @opindex mno-fused-madd
10853 Generate code that uses (does not use) the floating point multiply and
10854 accumulate instructions. These instructions are generated by default if
10855 hardware floating is used.
10856
10857 @item -mno-bit-align
10858 @itemx -mbit-align
10859 @opindex mno-bit-align
10860 @opindex mbit-align
10861 On System V.4 and embedded PowerPC systems do not (do) force structures
10862 and unions that contain bit-fields to be aligned to the base type of the
10863 bit-field.
10864
10865 For example, by default a structure containing nothing but 8
10866 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
10867 boundary and have a size of 4 bytes. By using @option{-mno-bit-align},
10868 the structure would be aligned to a 1 byte boundary and be one byte in
10869 size.
10870
10871 @item -mno-strict-align
10872 @itemx -mstrict-align
10873 @opindex mno-strict-align
10874 @opindex mstrict-align
10875 On System V.4 and embedded PowerPC systems do not (do) assume that
10876 unaligned memory references will be handled by the system.
10877
10878 @item -mrelocatable
10879 @itemx -mno-relocatable
10880 @opindex mrelocatable
10881 @opindex mno-relocatable
10882 On embedded PowerPC systems generate code that allows (does not allow)
10883 the program to be relocated to a different address at runtime. If you
10884 use @option{-mrelocatable} on any module, all objects linked together must
10885 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
10886
10887 @item -mrelocatable-lib
10888 @itemx -mno-relocatable-lib
10889 @opindex mrelocatable-lib
10890 @opindex mno-relocatable-lib
10891 On embedded PowerPC systems generate code that allows (does not allow)
10892 the program to be relocated to a different address at runtime. Modules
10893 compiled with @option{-mrelocatable-lib} can be linked with either modules
10894 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
10895 with modules compiled with the @option{-mrelocatable} options.
10896
10897 @item -mno-toc
10898 @itemx -mtoc
10899 @opindex mno-toc
10900 @opindex mtoc
10901 On System V.4 and embedded PowerPC systems do not (do) assume that
10902 register 2 contains a pointer to a global area pointing to the addresses
10903 used in the program.
10904
10905 @item -mlittle
10906 @itemx -mlittle-endian
10907 @opindex mlittle
10908 @opindex mlittle-endian
10909 On System V.4 and embedded PowerPC systems compile code for the
10910 processor in little endian mode. The @option{-mlittle-endian} option is
10911 the same as @option{-mlittle}.
10912
10913 @item -mbig
10914 @itemx -mbig-endian
10915 @opindex mbig
10916 @opindex mbig-endian
10917 On System V.4 and embedded PowerPC systems compile code for the
10918 processor in big endian mode. The @option{-mbig-endian} option is
10919 the same as @option{-mbig}.
10920
10921 @item -mdynamic-no-pic
10922 @opindex mdynamic-no-pic
10923 On Darwin and Mac OS X systems, compile code so that it is not
10924 relocatable, but that its external references are relocatable. The
10925 resulting code is suitable for applications, but not shared
10926 libraries.
10927
10928 @item -mprioritize-restricted-insns=@var{priority}
10929 @opindex mprioritize-restricted-insns
10930 This option controls the priority that is assigned to
10931 dispatch-slot restricted instructions during the second scheduling
10932 pass. The argument @var{priority} takes the value @var{0/1/2} to assign
10933 @var{no/highest/second-highest} priority to dispatch slot restricted
10934 instructions.
10935
10936 @item -msched-costly-dep=@var{dependence_type}
10937 @opindex msched-costly-dep
10938 This option controls which dependences are considered costly
10939 by the target during instruction scheduling. The argument
10940 @var{dependence_type} takes one of the following values:
10941 @var{no}: no dependence is costly,
10942 @var{all}: all dependences are costly,
10943 @var{true_store_to_load}: a true dependence from store to load is costly,
10944 @var{store_to_load}: any dependence from store to load is costly,
10945 @var{number}: any dependence which latency >= @var{number} is costly.
10946
10947 @item -minsert-sched-nops=@var{scheme}
10948 @opindex minsert-sched-nops
10949 This option controls which nop insertion scheme will be used during
10950 the second scheduling pass. The argument @var{scheme} takes one of the
10951 following values:
10952 @var{no}: Don't insert nops.
10953 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
10954 according to the scheduler's grouping.
10955 @var{regroup_exact}: Insert nops to force costly dependent insns into
10956 separate groups. Insert exactly as many nops as needed to force an insn
10957 to a new group, according to the estimated processor grouping.
10958 @var{number}: Insert nops to force costly dependent insns into
10959 separate groups. Insert @var{number} nops to force an insn to a new group.
10960
10961 @item -mcall-sysv
10962 @opindex mcall-sysv
10963 On System V.4 and embedded PowerPC systems compile code using calling
10964 conventions that adheres to the March 1995 draft of the System V
10965 Application Binary Interface, PowerPC processor supplement. This is the
10966 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
10967
10968 @item -mcall-sysv-eabi
10969 @opindex mcall-sysv-eabi
10970 Specify both @option{-mcall-sysv} and @option{-meabi} options.
10971
10972 @item -mcall-sysv-noeabi
10973 @opindex mcall-sysv-noeabi
10974 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
10975
10976 @item -mcall-solaris
10977 @opindex mcall-solaris
10978 On System V.4 and embedded PowerPC systems compile code for the Solaris
10979 operating system.
10980
10981 @item -mcall-linux
10982 @opindex mcall-linux
10983 On System V.4 and embedded PowerPC systems compile code for the
10984 Linux-based GNU system.
10985
10986 @item -mcall-gnu
10987 @opindex mcall-gnu
10988 On System V.4 and embedded PowerPC systems compile code for the
10989 Hurd-based GNU system.
10990
10991 @item -mcall-netbsd
10992 @opindex mcall-netbsd
10993 On System V.4 and embedded PowerPC systems compile code for the
10994 NetBSD operating system.
10995
10996 @item -maix-struct-return
10997 @opindex maix-struct-return
10998 Return all structures in memory (as specified by the AIX ABI)@.
10999
11000 @item -msvr4-struct-return
11001 @opindex msvr4-struct-return
11002 Return structures smaller than 8 bytes in registers (as specified by the
11003 SVR4 ABI)@.
11004
11005 @item -mabi=@var{abi-type}
11006 @opindex mabi
11007 Extend the current ABI with a particular extension, or remove such extension.
11008 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11009 @var{no-spe}@.
11010
11011 @item -mprototype
11012 @itemx -mno-prototype
11013 @opindex mprototype
11014 @opindex mno-prototype
11015 On System V.4 and embedded PowerPC systems assume that all calls to
11016 variable argument functions are properly prototyped. Otherwise, the
11017 compiler must insert an instruction before every non prototyped call to
11018 set or clear bit 6 of the condition code register (@var{CR}) to
11019 indicate whether floating point values were passed in the floating point
11020 registers in case the function takes a variable arguments. With
11021 @option{-mprototype}, only calls to prototyped variable argument functions
11022 will set or clear the bit.
11023
11024 @item -msim
11025 @opindex msim
11026 On embedded PowerPC systems, assume that the startup module is called
11027 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11028 @file{libc.a}. This is the default for @samp{powerpc-*-eabisim}.
11029 configurations.
11030
11031 @item -mmvme
11032 @opindex mmvme
11033 On embedded PowerPC systems, assume that the startup module is called
11034 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11035 @file{libc.a}.
11036
11037 @item -mads
11038 @opindex mads
11039 On embedded PowerPC systems, assume that the startup module is called
11040 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11041 @file{libc.a}.
11042
11043 @item -myellowknife
11044 @opindex myellowknife
11045 On embedded PowerPC systems, assume that the startup module is called
11046 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11047 @file{libc.a}.
11048
11049 @item -mvxworks
11050 @opindex mvxworks
11051 On System V.4 and embedded PowerPC systems, specify that you are
11052 compiling for a VxWorks system.
11053
11054 @item -mwindiss
11055 @opindex mwindiss
11056 Specify that you are compiling for the WindISS simulation environment.
11057
11058 @item -memb
11059 @opindex memb
11060 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11061 header to indicate that @samp{eabi} extended relocations are used.
11062
11063 @item -meabi
11064 @itemx -mno-eabi
11065 @opindex meabi
11066 @opindex mno-eabi
11067 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11068 Embedded Applications Binary Interface (eabi) which is a set of
11069 modifications to the System V.4 specifications. Selecting @option{-meabi}
11070 means that the stack is aligned to an 8 byte boundary, a function
11071 @code{__eabi} is called to from @code{main} to set up the eabi
11072 environment, and the @option{-msdata} option can use both @code{r2} and
11073 @code{r13} to point to two separate small data areas. Selecting
11074 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11075 do not call an initialization function from @code{main}, and the
11076 @option{-msdata} option will only use @code{r13} to point to a single
11077 small data area. The @option{-meabi} option is on by default if you
11078 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11079
11080 @item -msdata=eabi
11081 @opindex msdata=eabi
11082 On System V.4 and embedded PowerPC systems, put small initialized
11083 @code{const} global and static data in the @samp{.sdata2} section, which
11084 is pointed to by register @code{r2}. Put small initialized
11085 non-@code{const} global and static data in the @samp{.sdata} section,
11086 which is pointed to by register @code{r13}. Put small uninitialized
11087 global and static data in the @samp{.sbss} section, which is adjacent to
11088 the @samp{.sdata} section. The @option{-msdata=eabi} option is
11089 incompatible with the @option{-mrelocatable} option. The
11090 @option{-msdata=eabi} option also sets the @option{-memb} option.
11091
11092 @item -msdata=sysv
11093 @opindex msdata=sysv
11094 On System V.4 and embedded PowerPC systems, put small global and static
11095 data in the @samp{.sdata} section, which is pointed to by register
11096 @code{r13}. Put small uninitialized global and static data in the
11097 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11098 The @option{-msdata=sysv} option is incompatible with the
11099 @option{-mrelocatable} option.
11100
11101 @item -msdata=default
11102 @itemx -msdata
11103 @opindex msdata=default
11104 @opindex msdata
11105 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11106 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11107 same as @option{-msdata=sysv}.
11108
11109 @item -msdata-data
11110 @opindex msdata-data
11111 On System V.4 and embedded PowerPC systems, put small global and static
11112 data in the @samp{.sdata} section. Put small uninitialized global and
11113 static data in the @samp{.sbss} section. Do not use register @code{r13}
11114 to address small data however. This is the default behavior unless
11115 other @option{-msdata} options are used.
11116
11117 @item -msdata=none
11118 @itemx -mno-sdata
11119 @opindex msdata=none
11120 @opindex mno-sdata
11121 On embedded PowerPC systems, put all initialized global and static data
11122 in the @samp{.data} section, and all uninitialized data in the
11123 @samp{.bss} section.
11124
11125 @item -G @var{num}
11126 @opindex G
11127 @cindex smaller data references (PowerPC)
11128 @cindex .sdata/.sdata2 references (PowerPC)
11129 On embedded PowerPC systems, put global and static items less than or
11130 equal to @var{num} bytes into the small data or bss sections instead of
11131 the normal data or bss section. By default, @var{num} is 8. The
11132 @option{-G @var{num}} switch is also passed to the linker.
11133 All modules should be compiled with the same @option{-G @var{num}} value.
11134
11135 @item -mregnames
11136 @itemx -mno-regnames
11137 @opindex mregnames
11138 @opindex mno-regnames
11139 On System V.4 and embedded PowerPC systems do (do not) emit register
11140 names in the assembly language output using symbolic forms.
11141
11142 @item -mlongcall
11143 @itemx -mno-longcall
11144 @opindex mlongcall
11145 @opindex mno-longcall
11146 Default to making all function calls indirectly, using a register, so
11147 that functions which reside further than 32 megabytes (33,554,432
11148 bytes) from the current location can be called. This setting can be
11149 overridden by the @code{shortcall} function attribute, or by
11150 @code{#pragma longcall(0)}.
11151
11152 Some linkers are capable of detecting out-of-range calls and generating
11153 glue code on the fly. On these systems, long calls are unnecessary and
11154 generate slower code. As of this writing, the AIX linker can do this,
11155 as can the GNU linker for PowerPC/64. It is planned to add this feature
11156 to the GNU linker for 32-bit PowerPC systems as well.
11157
11158 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11159 callee, L42'', plus a ``branch island'' (glue code). The two target
11160 addresses represent the callee and the ``branch island''. The
11161 Darwin/PPC linker will prefer the first address and generate a ``bl
11162 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11163 otherwise, the linker will generate ``bl L42'' to call the ``branch
11164 island''. The ``branch island'' is appended to the body of the
11165 calling function; it computes the full 32-bit address of the callee
11166 and jumps to it.
11167
11168 On Mach-O (Darwin) systems, this option directs the compiler emit to
11169 the glue for every direct call, and the Darwin linker decides whether
11170 to use or discard it.
11171
11172 In the future, we may cause GCC to ignore all longcall specifications
11173 when the linker is known to generate glue.
11174
11175 @item -pthread
11176 @opindex pthread
11177 Adds support for multithreading with the @dfn{pthreads} library.
11178 This option sets flags for both the preprocessor and linker.
11179
11180 @end table
11181
11182 @node S/390 and zSeries Options
11183 @subsection S/390 and zSeries Options
11184 @cindex S/390 and zSeries Options
11185
11186 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11187
11188 @table @gcctabopt
11189 @item -mhard-float
11190 @itemx -msoft-float
11191 @opindex mhard-float
11192 @opindex msoft-float
11193 Use (do not use) the hardware floating-point instructions and registers
11194 for floating-point operations. When @option{-msoft-float} is specified,
11195 functions in @file{libgcc.a} will be used to perform floating-point
11196 operations. When @option{-mhard-float} is specified, the compiler
11197 generates IEEE floating-point instructions. This is the default.
11198
11199 @item -mbackchain
11200 @itemx -mno-backchain
11201 @opindex mbackchain
11202 @opindex mno-backchain
11203 Store (do not store) the address of the caller's frame as backchain pointer
11204 into the callee's stack frame.
11205 A backchain may be needed to allow debugging using tools that do not understand
11206 DWARF-2 call frame information.
11207 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11208 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11209 the backchain is placed into the topmost word of the 96/160 byte register
11210 save area.
11211
11212 In general, code compiled with @option{-mbackchain} is call-compatible with
11213 code compiled with @option{-mmo-backchain}; however, use of the backchain
11214 for debugging purposes usually requires that the whole binary is built with
11215 @option{-mbackchain}. Note that the combination of @option{-mbackchain},
11216 @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
11217 to build a linux kernel use @option{-msoft-float}.
11218
11219 The default is to not maintain the backchain.
11220
11221 @item -mpacked-stack
11222 @item -mno-packed-stack
11223 @opindex mpacked-stack
11224 @opindex mno-packed-stack
11225 Use (do not use) the packed stack layout. When @option{-mno-packed-stack} is
11226 specified, the compiler uses the all fields of the 96/160 byte register save
11227 area only for their default purpose; unused fields still take up stack space.
11228 When @option{-mpacked-stack} is specified, register save slots are densely
11229 packed at the top of the register save area; unused space is reused for other
11230 purposes, allowing for more efficient use of the available stack space.
11231 However, when @option{-mbackchain} is also in effect, the topmost word of
11232 the save area is always used to store the backchain, and the return address
11233 register is always saved two words below the backchain.
11234
11235 As long as the stack frame backchain is not used, code generated with
11236 @option{-mpacked-stack} is call-compatible with code generated with
11237 @option{-mno-packed-stack}. Note that some non-FSF releases of GCC 2.95 for
11238 S/390 or zSeries generated code that uses the stack frame backchain at run
11239 time, not just for debugging purposes. Such code is not call-compatible
11240 with code compiled with @option{-mpacked-stack}. Also, note that the
11241 combination of @option{-mbackchain},
11242 @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
11243 to build a linux kernel use @option{-msoft-float}.
11244
11245 The default is to not use the packed stack layout.
11246
11247 @item -msmall-exec
11248 @itemx -mno-small-exec
11249 @opindex msmall-exec
11250 @opindex mno-small-exec
11251 Generate (or do not generate) code using the @code{bras} instruction
11252 to do subroutine calls.
11253 This only works reliably if the total executable size does not
11254 exceed 64k. The default is to use the @code{basr} instruction instead,
11255 which does not have this limitation.
11256
11257 @item -m64
11258 @itemx -m31
11259 @opindex m64
11260 @opindex m31
11261 When @option{-m31} is specified, generate code compliant to the
11262 GNU/Linux for S/390 ABI@. When @option{-m64} is specified, generate
11263 code compliant to the GNU/Linux for zSeries ABI@. This allows GCC in
11264 particular to generate 64-bit instructions. For the @samp{s390}
11265 targets, the default is @option{-m31}, while the @samp{s390x}
11266 targets default to @option{-m64}.
11267
11268 @item -mzarch
11269 @itemx -mesa
11270 @opindex mzarch
11271 @opindex mesa
11272 When @option{-mzarch} is specified, generate code using the
11273 instructions available on z/Architecture.
11274 When @option{-mesa} is specified, generate code using the
11275 instructions available on ESA/390. Note that @option{-mesa} is
11276 not possible with @option{-m64}.
11277 When generating code compliant to the GNU/Linux for S/390 ABI,
11278 the default is @option{-mesa}. When generating code compliant
11279 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11280
11281 @item -mmvcle
11282 @itemx -mno-mvcle
11283 @opindex mmvcle
11284 @opindex mno-mvcle
11285 Generate (or do not generate) code using the @code{mvcle} instruction
11286 to perform block moves. When @option{-mno-mvcle} is specified,
11287 use a @code{mvc} loop instead. This is the default.
11288
11289 @item -mdebug
11290 @itemx -mno-debug
11291 @opindex mdebug
11292 @opindex mno-debug
11293 Print (or do not print) additional debug information when compiling.
11294 The default is to not print debug information.
11295
11296 @item -march=@var{cpu-type}
11297 @opindex march
11298 Generate code that will run on @var{cpu-type}, which is the name of a system
11299 representing a certain processor type. Possible values for
11300 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11301 When generating code using the instructions available on z/Architecture,
11302 the default is @option{-march=z900}. Otherwise, the default is
11303 @option{-march=g5}.
11304
11305 @item -mtune=@var{cpu-type}
11306 @opindex mtune
11307 Tune to @var{cpu-type} everything applicable about the generated code,
11308 except for the ABI and the set of available instructions.
11309 The list of @var{cpu-type} values is the same as for @option{-march}.
11310 The default is the value used for @option{-march}.
11311
11312 @item -mtpf-trace
11313 @itemx -mno-tpf-trace
11314 @opindex mtpf-trace
11315 @opindex mno-tpf-trace
11316 Generate code that adds (does not add) in TPF OS specific branches to trace
11317 routines in the operating system. This option is off by default, even
11318 when compiling for the TPF OS@.
11319
11320 @item -mfused-madd
11321 @itemx -mno-fused-madd
11322 @opindex mfused-madd
11323 @opindex mno-fused-madd
11324 Generate code that uses (does not use) the floating point multiply and
11325 accumulate instructions. These instructions are generated by default if
11326 hardware floating point is used.
11327
11328 @item -mwarn-framesize=@var{framesize}
11329 @opindex mwarn-framesize
11330 Emit a warning if the current function exceeds the given frame size. Because
11331 this is a compile time check it doesn't need to be a real problem when the program
11332 runs. It is intended to identify functions which most probably cause
11333 a stack overflow. It is useful to be used in an environment with limited stack
11334 size e.g.@: the linux kernel.
11335
11336 @item -mwarn-dynamicstack
11337 @opindex mwarn-dynamicstack
11338 Emit a warning if the function calls alloca or uses dynamically
11339 sized arrays. This is generally a bad idea with a limited stack size.
11340
11341 @item -mstack-guard=@var{stack-guard}
11342 @item -mstack-size=@var{stack-size}
11343 @opindex mstack-guard
11344 @opindex mstack-size
11345 These arguments always have to be used in conjunction. If they are present the s390
11346 back end emits additional instructions in the function prologue which trigger a trap
11347 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11348 (remember that the stack on s390 grows downward). These options are intended to
11349 be used to help debugging stack overflow problems. The additionally emitted code
11350 cause only little overhead and hence can also be used in production like systems
11351 without greater performance degradation. The given values have to be exact
11352 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
11353 In order to be efficient the extra code makes the assumption that the stack starts
11354 at an address aligned to the value given by @var{stack-size}.
11355 @end table
11356
11357 @node SH Options
11358 @subsection SH Options
11359
11360 These @samp{-m} options are defined for the SH implementations:
11361
11362 @table @gcctabopt
11363 @item -m1
11364 @opindex m1
11365 Generate code for the SH1.
11366
11367 @item -m2
11368 @opindex m2
11369 Generate code for the SH2.
11370
11371 @item -m2e
11372 Generate code for the SH2e.
11373
11374 @item -m3
11375 @opindex m3
11376 Generate code for the SH3.
11377
11378 @item -m3e
11379 @opindex m3e
11380 Generate code for the SH3e.
11381
11382 @item -m4-nofpu
11383 @opindex m4-nofpu
11384 Generate code for the SH4 without a floating-point unit.
11385
11386 @item -m4-single-only
11387 @opindex m4-single-only
11388 Generate code for the SH4 with a floating-point unit that only
11389 supports single-precision arithmetic.
11390
11391 @item -m4-single
11392 @opindex m4-single
11393 Generate code for the SH4 assuming the floating-point unit is in
11394 single-precision mode by default.
11395
11396 @item -m4
11397 @opindex m4
11398 Generate code for the SH4.
11399
11400 @item -m4a-nofpu
11401 @opindex m4a-nofpu
11402 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11403 floating-point unit is not used.
11404
11405 @item -m4a-single-only
11406 @opindex m4a-single-only
11407 Generate code for the SH4a, in such a way that no double-precision
11408 floating point operations are used.
11409
11410 @item -m4a-single
11411 @opindex m4a-single
11412 Generate code for the SH4a assuming the floating-point unit is in
11413 single-precision mode by default.
11414
11415 @item -m4a
11416 @opindex m4a
11417 Generate code for the SH4a.
11418
11419 @item -m4al
11420 @opindex m4al
11421 Same as @option{-m4a-nofpu}, except that it implicitly passes
11422 @option{-dsp} to the assembler. GCC doesn't generate any DSP
11423 instructions at the moment.
11424
11425 @item -mb
11426 @opindex mb
11427 Compile code for the processor in big endian mode.
11428
11429 @item -ml
11430 @opindex ml
11431 Compile code for the processor in little endian mode.
11432
11433 @item -mdalign
11434 @opindex mdalign
11435 Align doubles at 64-bit boundaries. Note that this changes the calling
11436 conventions, and thus some functions from the standard C library will
11437 not work unless you recompile it first with @option{-mdalign}.
11438
11439 @item -mrelax
11440 @opindex mrelax
11441 Shorten some address references at link time, when possible; uses the
11442 linker option @option{-relax}.
11443
11444 @item -mbigtable
11445 @opindex mbigtable
11446 Use 32-bit offsets in @code{switch} tables. The default is to use
11447 16-bit offsets.
11448
11449 @item -mfmovd
11450 @opindex mfmovd
11451 Enable the use of the instruction @code{fmovd}.
11452
11453 @item -mhitachi
11454 @opindex mhitachi
11455 Comply with the calling conventions defined by Renesas.
11456
11457 @item -mrenesas
11458 @opindex mhitachi
11459 Comply with the calling conventions defined by Renesas.
11460
11461 @item -mno-renesas
11462 @opindex mhitachi
11463 Comply with the calling conventions defined for GCC before the Renesas
11464 conventions were available. This option is the default for all
11465 targets of the SH toolchain except for @samp{sh-symbianelf}.
11466
11467 @item -mnomacsave
11468 @opindex mnomacsave
11469 Mark the @code{MAC} register as call-clobbered, even if
11470 @option{-mhitachi} is given.
11471
11472 @item -mieee
11473 @opindex mieee
11474 Increase IEEE-compliance of floating-point code.
11475 At the moment, this is equivalent to @option{-fno-finite-math-only}.
11476 When generating 16 bit SH opcodes, getting IEEE-conforming results for
11477 comparisons of NANs / infinities incurs extra overhead in every
11478 floating point comparison, therefore the default is set to
11479 @option{-ffinite-math-only}.
11480
11481 @item -misize
11482 @opindex misize
11483 Dump instruction size and location in the assembly code.
11484
11485 @item -mpadstruct
11486 @opindex mpadstruct
11487 This option is deprecated. It pads structures to multiple of 4 bytes,
11488 which is incompatible with the SH ABI@.
11489
11490 @item -mspace
11491 @opindex mspace
11492 Optimize for space instead of speed. Implied by @option{-Os}.
11493
11494 @item -mprefergot
11495 @opindex mprefergot
11496 When generating position-independent code, emit function calls using
11497 the Global Offset Table instead of the Procedure Linkage Table.
11498
11499 @item -musermode
11500 @opindex musermode
11501 Generate a library function call to invalidate instruction cache
11502 entries, after fixing up a trampoline. This library function call
11503 doesn't assume it can write to the whole memory address space. This
11504 is the default when the target is @code{sh-*-linux*}.
11505
11506 @item -multcost=@var{number}
11507 @opindex multcost=@var{number}
11508 Set the cost to assume for a multiply insn.
11509
11510 @item -mdiv=@var{strategy}
11511 @opindex mdiv=@var{strategy}
11512 Set the division strategy to use for SHmedia code. @var{strategy} must be
11513 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
11514 inv:call2, inv:fp .
11515 "fp" performs the operation in floating point. This has a very high latency,
11516 but needs only a few instructions, so it might be a good choice if
11517 your code has enough easily exploitable ILP to allow the compiler to
11518 schedule the floating point instructions together with other instructions.
11519 Division by zero causes a floating point exception.
11520 "inv" uses integer operations to calculate the inverse of the divisor,
11521 and then multiplies the dividend with the inverse. This strategy allows
11522 cse and hoisting of the inverse calculation. Division by zero calculates
11523 an unspecified result, but does not trap.
11524 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
11525 have been found, or if the entire operation has been hoisted to the same
11526 place, the last stages of the inverse calculation are intertwined with the
11527 final multiply to reduce the overall latency, at the expense of using a few
11528 more instructions, and thus offering fewer scheduling opportunities with
11529 other code.
11530 "call" calls a library function that usually implements the inv:minlat
11531 strategy.
11532 This gives high code density for m5-*media-nofpu compilations.
11533 "call2" uses a different entry point of the same library function, where it
11534 assumes that a pointer to a lookup table has already been set up, which
11535 exposes the pointer load to cse / code hoisting optimizations.
11536 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
11537 code generation, but if the code stays unoptimized, revert to the "call",
11538 "call2", or "fp" strategies, respectively. Note that the
11539 potentially-trapping side effect of division by zero is carried by a
11540 separate instruction, so it is possible that all the integer instructions
11541 are hoisted out, but the marker for the side effect stays where it is.
11542 A recombination to fp operations or a call is not possible in that case.
11543 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy. In the case
11544 that the inverse calculation was nor separated from the multiply, they speed
11545 up division where the dividend fits into 20 bits (plus sign where applicable),
11546 by inserting a test to skip a number of operations in this case; this test
11547 slows down the case of larger dividends. inv20u assumes the case of a such
11548 a small dividend to be unlikely, and inv20l assumes it to be likely.
11549
11550 @item -mdivsi3_libfunc=@var{name}
11551 @opindex mdivsi3_libfunc=@var{name}
11552 Set the name of the library function used for 32 bit signed division to
11553 @var{name}. This only affect the name used in the call and inv:call
11554 division strategies, and the compiler will still expect the same
11555 sets of input/output/clobbered registers as if this option was not present.
11556
11557 @item -madjust-unroll
11558 @opindex madjust-unroll
11559 Throttle unrolling to avoid thrashing target registers.
11560 This option only has an effect if the gcc code base supports the
11561 TARGET_ADJUST_UNROLL_MAX target hook.
11562
11563 @item -mindexed-addressing
11564 @opindex mindexed-addressing
11565 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
11566 This is only safe if the hardware and/or OS implement 32 bit wrap-around
11567 semantics for the indexed addressing mode. The architecture allows the
11568 implementation of processors with 64 bit MMU, which the OS could use to
11569 get 32 bit addressing, but since no current hardware implementation supports
11570 this or any other way to make the indexed addressing mode safe to use in
11571 the 32 bit ABI, the default is -mno-indexed-addressing.
11572
11573 @item -mgettrcost=@var{number}
11574 @opindex mgettrcost=@var{number}
11575 Set the cost assumed for the gettr instruction to @var{number}.
11576 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
11577
11578 @item -mpt-fixed
11579 @opindex mpt-fixed
11580 Assume pt* instructions won't trap. This will generally generate better
11581 scheduled code, but is unsafe on current hardware. The current architecture
11582 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
11583 This has the unintentional effect of making it unsafe to schedule ptabs /
11584 ptrel before a branch, or hoist it out of a loop. For example,
11585 __do_global_ctors, a part of libgcc that runs constructors at program
11586 startup, calls functions in a list which is delimited by -1. With the
11587 -mpt-fixed option, the ptabs will be done before testing against -1.
11588 That means that all the constructors will be run a bit quicker, but when
11589 the loop comes to the end of the list, the program crashes because ptabs
11590 loads -1 into a target register. Since this option is unsafe for any
11591 hardware implementing the current architecture specification, the default
11592 is -mno-pt-fixed. Unless the user specifies a specific cost with
11593 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
11594 this deters register allocation using target registers for storing
11595 ordinary integers.
11596
11597 @item -minvalid-symbols
11598 @opindex minvalid-symbols
11599 Assume symbols might be invalid. Ordinary function symbols generated by
11600 the compiler will always be valid to load with movi/shori/ptabs or
11601 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
11602 to generate symbols that will cause ptabs / ptrel to trap.
11603 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
11604 It will then prevent cross-basic-block cse, hoisting and most scheduling
11605 of symbol loads. The default is @option{-mno-invalid-symbols}.
11606 @end table
11607
11608 @node SPARC Options
11609 @subsection SPARC Options
11610 @cindex SPARC options
11611
11612 These @samp{-m} options are supported on the SPARC:
11613
11614 @table @gcctabopt
11615 @item -mno-app-regs
11616 @itemx -mapp-regs
11617 @opindex mno-app-regs
11618 @opindex mapp-regs
11619 Specify @option{-mapp-regs} to generate output using the global registers
11620 2 through 4, which the SPARC SVR4 ABI reserves for applications. This
11621 is the default, except on Solaris.
11622
11623 To be fully SVR4 ABI compliant at the cost of some performance loss,
11624 specify @option{-mno-app-regs}. You should compile libraries and system
11625 software with this option.
11626
11627 @item -mfpu
11628 @itemx -mhard-float
11629 @opindex mfpu
11630 @opindex mhard-float
11631 Generate output containing floating point instructions. This is the
11632 default.
11633
11634 @item -mno-fpu
11635 @itemx -msoft-float
11636 @opindex mno-fpu
11637 @opindex msoft-float
11638 Generate output containing library calls for floating point.
11639 @strong{Warning:} the requisite libraries are not available for all SPARC
11640 targets. Normally the facilities of the machine's usual C compiler are
11641 used, but this cannot be done directly in cross-compilation. You must make
11642 your own arrangements to provide suitable library functions for
11643 cross-compilation. The embedded targets @samp{sparc-*-aout} and
11644 @samp{sparclite-*-*} do provide software floating point support.
11645
11646 @option{-msoft-float} changes the calling convention in the output file;
11647 therefore, it is only useful if you compile @emph{all} of a program with
11648 this option. In particular, you need to compile @file{libgcc.a}, the
11649 library that comes with GCC, with @option{-msoft-float} in order for
11650 this to work.
11651
11652 @item -mhard-quad-float
11653 @opindex mhard-quad-float
11654 Generate output containing quad-word (long double) floating point
11655 instructions.
11656
11657 @item -msoft-quad-float
11658 @opindex msoft-quad-float
11659 Generate output containing library calls for quad-word (long double)
11660 floating point instructions. The functions called are those specified
11661 in the SPARC ABI@. This is the default.
11662
11663 As of this writing, there are no SPARC implementations that have hardware
11664 support for the quad-word floating point instructions. They all invoke
11665 a trap handler for one of these instructions, and then the trap handler
11666 emulates the effect of the instruction. Because of the trap handler overhead,
11667 this is much slower than calling the ABI library routines. Thus the
11668 @option{-msoft-quad-float} option is the default.
11669
11670 @item -mno-unaligned-doubles
11671 @itemx -munaligned-doubles
11672 @opindex mno-unaligned-doubles
11673 @opindex munaligned-doubles
11674 Assume that doubles have 8 byte alignment. This is the default.
11675
11676 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
11677 alignment only if they are contained in another type, or if they have an
11678 absolute address. Otherwise, it assumes they have 4 byte alignment.
11679 Specifying this option avoids some rare compatibility problems with code
11680 generated by other compilers. It is not the default because it results
11681 in a performance loss, especially for floating point code.
11682
11683 @item -mno-faster-structs
11684 @itemx -mfaster-structs
11685 @opindex mno-faster-structs
11686 @opindex mfaster-structs
11687 With @option{-mfaster-structs}, the compiler assumes that structures
11688 should have 8 byte alignment. This enables the use of pairs of
11689 @code{ldd} and @code{std} instructions for copies in structure
11690 assignment, in place of twice as many @code{ld} and @code{st} pairs.
11691 However, the use of this changed alignment directly violates the SPARC
11692 ABI@. Thus, it's intended only for use on targets where the developer
11693 acknowledges that their resulting code will not be directly in line with
11694 the rules of the ABI@.
11695
11696 @item -mimpure-text
11697 @opindex mimpure-text
11698 @option{-mimpure-text}, used in addition to @option{-shared}, tells
11699 the compiler to not pass @option{-z text} to the linker when linking a
11700 shared object. Using this option, you can link position-dependent
11701 code into a shared object.
11702
11703 @option{-mimpure-text} suppresses the ``relocations remain against
11704 allocatable but non-writable sections'' linker error message.
11705 However, the necessary relocations will trigger copy-on-write, and the
11706 shared object is not actually shared across processes. Instead of
11707 using @option{-mimpure-text}, you should compile all source code with
11708 @option{-fpic} or @option{-fPIC}.
11709
11710 This option is only available on SunOS and Solaris.
11711
11712 @item -mcpu=@var{cpu_type}
11713 @opindex mcpu
11714 Set the instruction set, register set, and instruction scheduling parameters
11715 for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
11716 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
11717 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
11718 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
11719 @samp{ultrasparc3}.
11720
11721 Default instruction scheduling parameters are used for values that select
11722 an architecture and not an implementation. These are @samp{v7}, @samp{v8},
11723 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
11724
11725 Here is a list of each supported architecture and their supported
11726 implementations.
11727
11728 @smallexample
11729 v7: cypress
11730 v8: supersparc, hypersparc
11731 sparclite: f930, f934, sparclite86x
11732 sparclet: tsc701
11733 v9: ultrasparc, ultrasparc3
11734 @end smallexample
11735
11736 By default (unless configured otherwise), GCC generates code for the V7
11737 variant of the SPARC architecture. With @option{-mcpu=cypress}, the compiler
11738 additionally optimizes it for the Cypress CY7C602 chip, as used in the
11739 SPARCStation/SPARCServer 3xx series. This is also appropriate for the older
11740 SPARCStation 1, 2, IPX etc.
11741
11742 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
11743 architecture. The only difference from V7 code is that the compiler emits
11744 the integer multiply and integer divide instructions which exist in SPARC-V8
11745 but not in SPARC-V7. With @option{-mcpu=supersparc}, the compiler additionally
11746 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
11747 2000 series.
11748
11749 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
11750 the SPARC architecture. This adds the integer multiply, integer divide step
11751 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
11752 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
11753 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@. With
11754 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
11755 MB86934 chip, which is the more recent SPARClite with FPU@.
11756
11757 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
11758 the SPARC architecture. This adds the integer multiply, multiply/accumulate,
11759 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
11760 but not in SPARC-V7. With @option{-mcpu=tsc701}, the compiler additionally
11761 optimizes it for the TEMIC SPARClet chip.
11762
11763 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
11764 architecture. This adds 64-bit integer and floating-point move instructions,
11765 3 additional floating-point condition code registers and conditional move
11766 instructions. With @option{-mcpu=ultrasparc}, the compiler additionally
11767 optimizes it for the Sun UltraSPARC I/II chips. With
11768 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
11769 Sun UltraSPARC III chip.
11770
11771 @item -mtune=@var{cpu_type}
11772 @opindex mtune
11773 Set the instruction scheduling parameters for machine type
11774 @var{cpu_type}, but do not set the instruction set or register set that the
11775 option @option{-mcpu=@var{cpu_type}} would.
11776
11777 The same values for @option{-mcpu=@var{cpu_type}} can be used for
11778 @option{-mtune=@var{cpu_type}}, but the only useful values are those
11779 that select a particular cpu implementation. Those are @samp{cypress},
11780 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
11781 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
11782 @samp{ultrasparc3}.
11783
11784 @item -mv8plus
11785 @itemx -mno-v8plus
11786 @opindex mv8plus
11787 @opindex mno-v8plus
11788 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@. The
11789 difference from the V8 ABI is that the global and out registers are
11790 considered 64-bit wide. This is enabled by default on Solaris in 32-bit
11791 mode for all SPARC-V9 processors.
11792
11793 @item -mvis
11794 @itemx -mno-vis
11795 @opindex mvis
11796 @opindex mno-vis
11797 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
11798 Visual Instruction Set extensions. The default is @option{-mno-vis}.
11799 @end table
11800
11801 These @samp{-m} options are supported in addition to the above
11802 on SPARC-V9 processors in 64-bit environments:
11803
11804 @table @gcctabopt
11805 @item -mlittle-endian
11806 @opindex mlittle-endian
11807 Generate code for a processor running in little-endian mode. It is only
11808 available for a few configurations and most notably not on Solaris and Linux.
11809
11810 @item -m32
11811 @itemx -m64
11812 @opindex m32
11813 @opindex m64
11814 Generate code for a 32-bit or 64-bit environment.
11815 The 32-bit environment sets int, long and pointer to 32 bits.
11816 The 64-bit environment sets int to 32 bits and long and pointer
11817 to 64 bits.
11818
11819 @item -mcmodel=medlow
11820 @opindex mcmodel=medlow
11821 Generate code for the Medium/Low code model: 64-bit addresses, programs
11822 must be linked in the low 32 bits of memory. Programs can be statically
11823 or dynamically linked.
11824
11825 @item -mcmodel=medmid
11826 @opindex mcmodel=medmid
11827 Generate code for the Medium/Middle code model: 64-bit addresses, programs
11828 must be linked in the low 44 bits of memory, the text and data segments must
11829 be less than 2GB in size and the data segment must be located within 2GB of
11830 the text segment.
11831
11832 @item -mcmodel=medany
11833 @opindex mcmodel=medany
11834 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
11835 may be linked anywhere in memory, the text and data segments must be less
11836 than 2GB in size and the data segment must be located within 2GB of the
11837 text segment.
11838
11839 @item -mcmodel=embmedany
11840 @opindex mcmodel=embmedany
11841 Generate code for the Medium/Anywhere code model for embedded systems:
11842 64-bit addresses, the text and data segments must be less than 2GB in
11843 size, both starting anywhere in memory (determined at link time). The
11844 global register %g4 points to the base of the data segment. Programs
11845 are statically linked and PIC is not supported.
11846
11847 @item -mstack-bias
11848 @itemx -mno-stack-bias
11849 @opindex mstack-bias
11850 @opindex mno-stack-bias
11851 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
11852 frame pointer if present, are offset by @minus{}2047 which must be added back
11853 when making stack frame references. This is the default in 64-bit mode.
11854 Otherwise, assume no such offset is present.
11855 @end table
11856
11857 These switches are supported in addition to the above on Solaris:
11858
11859 @table @gcctabopt
11860 @item -threads
11861 @opindex threads
11862 Add support for multithreading using the Solaris threads library. This
11863 option sets flags for both the preprocessor and linker. This option does
11864 not affect the thread safety of object code produced by the compiler or
11865 that of libraries supplied with it.
11866
11867 @item -pthreads
11868 @opindex pthreads
11869 Add support for multithreading using the POSIX threads library. This
11870 option sets flags for both the preprocessor and linker. This option does
11871 not affect the thread safety of object code produced by the compiler or
11872 that of libraries supplied with it.
11873 @end table
11874
11875 @node System V Options
11876 @subsection Options for System V
11877
11878 These additional options are available on System V Release 4 for
11879 compatibility with other compilers on those systems:
11880
11881 @table @gcctabopt
11882 @item -G
11883 @opindex G
11884 Create a shared object.
11885 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
11886
11887 @item -Qy
11888 @opindex Qy
11889 Identify the versions of each tool used by the compiler, in a
11890 @code{.ident} assembler directive in the output.
11891
11892 @item -Qn
11893 @opindex Qn
11894 Refrain from adding @code{.ident} directives to the output file (this is
11895 the default).
11896
11897 @item -YP,@var{dirs}
11898 @opindex YP
11899 Search the directories @var{dirs}, and no others, for libraries
11900 specified with @option{-l}.
11901
11902 @item -Ym,@var{dir}
11903 @opindex Ym
11904 Look in the directory @var{dir} to find the M4 preprocessor.
11905 The assembler uses this option.
11906 @c This is supposed to go with a -Yd for predefined M4 macro files, but
11907 @c the generic assembler that comes with Solaris takes just -Ym.
11908 @end table
11909
11910 @node TMS320C3x/C4x Options
11911 @subsection TMS320C3x/C4x Options
11912 @cindex TMS320C3x/C4x Options
11913
11914 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
11915
11916 @table @gcctabopt
11917
11918 @item -mcpu=@var{cpu_type}
11919 @opindex mcpu
11920 Set the instruction set, register set, and instruction scheduling
11921 parameters for machine type @var{cpu_type}. Supported values for
11922 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
11923 @samp{c44}. The default is @samp{c40} to generate code for the
11924 TMS320C40.
11925
11926 @item -mbig-memory
11927 @itemx -mbig
11928 @itemx -msmall-memory
11929 @itemx -msmall
11930 @opindex mbig-memory
11931 @opindex mbig
11932 @opindex msmall-memory
11933 @opindex msmall
11934 Generates code for the big or small memory model. The small memory
11935 model assumed that all data fits into one 64K word page. At run-time
11936 the data page (DP) register must be set to point to the 64K page
11937 containing the .bss and .data program sections. The big memory model is
11938 the default and requires reloading of the DP register for every direct
11939 memory access.
11940
11941 @item -mbk
11942 @itemx -mno-bk
11943 @opindex mbk
11944 @opindex mno-bk
11945 Allow (disallow) allocation of general integer operands into the block
11946 count register BK@.
11947
11948 @item -mdb
11949 @itemx -mno-db
11950 @opindex mdb
11951 @opindex mno-db
11952 Enable (disable) generation of code using decrement and branch,
11953 DBcond(D), instructions. This is enabled by default for the C4x. To be
11954 on the safe side, this is disabled for the C3x, since the maximum
11955 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
11956 @math{2^{23}} times on the C3x?). Note that GCC will try to reverse a loop so
11957 that it can utilize the decrement and branch instruction, but will give
11958 up if there is more than one memory reference in the loop. Thus a loop
11959 where the loop counter is decremented can generate slightly more
11960 efficient code, in cases where the RPTB instruction cannot be utilized.
11961
11962 @item -mdp-isr-reload
11963 @itemx -mparanoid
11964 @opindex mdp-isr-reload
11965 @opindex mparanoid
11966 Force the DP register to be saved on entry to an interrupt service
11967 routine (ISR), reloaded to point to the data section, and restored on
11968 exit from the ISR@. This should not be required unless someone has
11969 violated the small memory model by modifying the DP register, say within
11970 an object library.
11971
11972 @item -mmpyi
11973 @itemx -mno-mpyi
11974 @opindex mmpyi
11975 @opindex mno-mpyi
11976 For the C3x use the 24-bit MPYI instruction for integer multiplies
11977 instead of a library call to guarantee 32-bit results. Note that if one
11978 of the operands is a constant, then the multiplication will be performed
11979 using shifts and adds. If the @option{-mmpyi} option is not specified for the C3x,
11980 then squaring operations are performed inline instead of a library call.
11981
11982 @item -mfast-fix
11983 @itemx -mno-fast-fix
11984 @opindex mfast-fix
11985 @opindex mno-fast-fix
11986 The C3x/C4x FIX instruction to convert a floating point value to an
11987 integer value chooses the nearest integer less than or equal to the
11988 floating point value rather than to the nearest integer. Thus if the
11989 floating point number is negative, the result will be incorrectly
11990 truncated an additional code is necessary to detect and correct this
11991 case. This option can be used to disable generation of the additional
11992 code required to correct the result.
11993
11994 @item -mrptb
11995 @itemx -mno-rptb
11996 @opindex mrptb
11997 @opindex mno-rptb
11998 Enable (disable) generation of repeat block sequences using the RPTB
11999 instruction for zero overhead looping. The RPTB construct is only used
12000 for innermost loops that do not call functions or jump across the loop
12001 boundaries. There is no advantage having nested RPTB loops due to the
12002 overhead required to save and restore the RC, RS, and RE registers.
12003 This is enabled by default with @option{-O2}.
12004
12005 @item -mrpts=@var{count}
12006 @itemx -mno-rpts
12007 @opindex mrpts
12008 @opindex mno-rpts
12009 Enable (disable) the use of the single instruction repeat instruction
12010 RPTS@. If a repeat block contains a single instruction, and the loop
12011 count can be guaranteed to be less than the value @var{count}, GCC will
12012 emit a RPTS instruction instead of a RPTB@. If no value is specified,
12013 then a RPTS will be emitted even if the loop count cannot be determined
12014 at compile time. Note that the repeated instruction following RPTS does
12015 not have to be reloaded from memory each iteration, thus freeing up the
12016 CPU buses for operands. However, since interrupts are blocked by this
12017 instruction, it is disabled by default.
12018
12019 @item -mloop-unsigned
12020 @itemx -mno-loop-unsigned
12021 @opindex mloop-unsigned
12022 @opindex mno-loop-unsigned
12023 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12024 is @math{2^{31} + 1} since these instructions test if the iteration count is
12025 negative to terminate the loop. If the iteration count is unsigned
12026 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12027 exceeded. This switch allows an unsigned iteration count.
12028
12029 @item -mti
12030 @opindex mti
12031 Try to emit an assembler syntax that the TI assembler (asm30) is happy
12032 with. This also enforces compatibility with the API employed by the TI
12033 C3x C compiler. For example, long doubles are passed as structures
12034 rather than in floating point registers.
12035
12036 @item -mregparm
12037 @itemx -mmemparm
12038 @opindex mregparm
12039 @opindex mmemparm
12040 Generate code that uses registers (stack) for passing arguments to functions.
12041 By default, arguments are passed in registers where possible rather
12042 than by pushing arguments on to the stack.
12043
12044 @item -mparallel-insns
12045 @itemx -mno-parallel-insns
12046 @opindex mparallel-insns
12047 @opindex mno-parallel-insns
12048 Allow the generation of parallel instructions. This is enabled by
12049 default with @option{-O2}.
12050
12051 @item -mparallel-mpy
12052 @itemx -mno-parallel-mpy
12053 @opindex mparallel-mpy
12054 @opindex mno-parallel-mpy
12055 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12056 provided @option{-mparallel-insns} is also specified. These instructions have
12057 tight register constraints which can pessimize the code generation
12058 of large functions.
12059
12060 @end table
12061
12062 @node V850 Options
12063 @subsection V850 Options
12064 @cindex V850 Options
12065
12066 These @samp{-m} options are defined for V850 implementations:
12067
12068 @table @gcctabopt
12069 @item -mlong-calls
12070 @itemx -mno-long-calls
12071 @opindex mlong-calls
12072 @opindex mno-long-calls
12073 Treat all calls as being far away (near). If calls are assumed to be
12074 far away, the compiler will always load the functions address up into a
12075 register, and call indirect through the pointer.
12076
12077 @item -mno-ep
12078 @itemx -mep
12079 @opindex mno-ep
12080 @opindex mep
12081 Do not optimize (do optimize) basic blocks that use the same index
12082 pointer 4 or more times to copy pointer into the @code{ep} register, and
12083 use the shorter @code{sld} and @code{sst} instructions. The @option{-mep}
12084 option is on by default if you optimize.
12085
12086 @item -mno-prolog-function
12087 @itemx -mprolog-function
12088 @opindex mno-prolog-function
12089 @opindex mprolog-function
12090 Do not use (do use) external functions to save and restore registers
12091 at the prologue and epilogue of a function. The external functions
12092 are slower, but use less code space if more than one function saves
12093 the same number of registers. The @option{-mprolog-function} option
12094 is on by default if you optimize.
12095
12096 @item -mspace
12097 @opindex mspace
12098 Try to make the code as small as possible. At present, this just turns
12099 on the @option{-mep} and @option{-mprolog-function} options.
12100
12101 @item -mtda=@var{n}
12102 @opindex mtda
12103 Put static or global variables whose size is @var{n} bytes or less into
12104 the tiny data area that register @code{ep} points to. The tiny data
12105 area can hold up to 256 bytes in total (128 bytes for byte references).
12106
12107 @item -msda=@var{n}
12108 @opindex msda
12109 Put static or global variables whose size is @var{n} bytes or less into
12110 the small data area that register @code{gp} points to. The small data
12111 area can hold up to 64 kilobytes.
12112
12113 @item -mzda=@var{n}
12114 @opindex mzda
12115 Put static or global variables whose size is @var{n} bytes or less into
12116 the first 32 kilobytes of memory.
12117
12118 @item -mv850
12119 @opindex mv850
12120 Specify that the target processor is the V850.
12121
12122 @item -mbig-switch
12123 @opindex mbig-switch
12124 Generate code suitable for big switch tables. Use this option only if
12125 the assembler/linker complain about out of range branches within a switch
12126 table.
12127
12128 @item -mapp-regs
12129 @opindex mapp-regs
12130 This option will cause r2 and r5 to be used in the code generated by
12131 the compiler. This setting is the default.
12132
12133 @item -mno-app-regs
12134 @opindex mno-app-regs
12135 This option will cause r2 and r5 to be treated as fixed registers.
12136
12137 @item -mv850e1
12138 @opindex mv850e1
12139 Specify that the target processor is the V850E1. The preprocessor
12140 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12141 this option is used.
12142
12143 @item -mv850e
12144 @opindex mv850e
12145 Specify that the target processor is the V850E@. The preprocessor
12146 constant @samp{__v850e__} will be defined if this option is used.
12147
12148 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12149 are defined then a default target processor will be chosen and the
12150 relevant @samp{__v850*__} preprocessor constant will be defined.
12151
12152 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12153 defined, regardless of which processor variant is the target.
12154
12155 @item -mdisable-callt
12156 @opindex mdisable-callt
12157 This option will suppress generation of the CALLT instruction for the
12158 v850e and v850e1 flavors of the v850 architecture. The default is
12159 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
12160
12161 @end table
12162
12163 @node VAX Options
12164 @subsection VAX Options
12165 @cindex VAX options
12166
12167 These @samp{-m} options are defined for the VAX:
12168
12169 @table @gcctabopt
12170 @item -munix
12171 @opindex munix
12172 Do not output certain jump instructions (@code{aobleq} and so on)
12173 that the Unix assembler for the VAX cannot handle across long
12174 ranges.
12175
12176 @item -mgnu
12177 @opindex mgnu
12178 Do output those jump instructions, on the assumption that you
12179 will assemble with the GNU assembler.
12180
12181 @item -mg
12182 @opindex mg
12183 Output code for g-format floating point numbers instead of d-format.
12184 @end table
12185
12186 @node x86-64 Options
12187 @subsection x86-64 Options
12188 @cindex x86-64 options
12189
12190 These are listed under @xref{i386 and x86-64 Options}.
12191
12192 @node Xstormy16 Options
12193 @subsection Xstormy16 Options
12194 @cindex Xstormy16 Options
12195
12196 These options are defined for Xstormy16:
12197
12198 @table @gcctabopt
12199 @item -msim
12200 @opindex msim
12201 Choose startup files and linker script suitable for the simulator.
12202 @end table
12203
12204 @node Xtensa Options
12205 @subsection Xtensa Options
12206 @cindex Xtensa Options
12207
12208 These options are supported for Xtensa targets:
12209
12210 @table @gcctabopt
12211 @item -mconst16
12212 @itemx -mno-const16
12213 @opindex mconst16
12214 @opindex mno-const16
12215 Enable or disable use of @code{CONST16} instructions for loading
12216 constant values. The @code{CONST16} instruction is currently not a
12217 standard option from Tensilica. When enabled, @code{CONST16}
12218 instructions are always used in place of the standard @code{L32R}
12219 instructions. The use of @code{CONST16} is enabled by default only if
12220 the @code{L32R} instruction is not available.
12221
12222 @item -mfused-madd
12223 @itemx -mno-fused-madd
12224 @opindex mfused-madd
12225 @opindex mno-fused-madd
12226 Enable or disable use of fused multiply/add and multiply/subtract
12227 instructions in the floating-point option. This has no effect if the
12228 floating-point option is not also enabled. Disabling fused multiply/add
12229 and multiply/subtract instructions forces the compiler to use separate
12230 instructions for the multiply and add/subtract operations. This may be
12231 desirable in some cases where strict IEEE 754-compliant results are
12232 required: the fused multiply add/subtract instructions do not round the
12233 intermediate result, thereby producing results with @emph{more} bits of
12234 precision than specified by the IEEE standard. Disabling fused multiply
12235 add/subtract instructions also ensures that the program output is not
12236 sensitive to the compiler's ability to combine multiply and add/subtract
12237 operations.
12238
12239 @item -mtext-section-literals
12240 @itemx -mno-text-section-literals
12241 @opindex mtext-section-literals
12242 @opindex mno-text-section-literals
12243 Control the treatment of literal pools. The default is
12244 @option{-mno-text-section-literals}, which places literals in a separate
12245 section in the output file. This allows the literal pool to be placed
12246 in a data RAM/ROM, and it also allows the linker to combine literal
12247 pools from separate object files to remove redundant literals and
12248 improve code size. With @option{-mtext-section-literals}, the literals
12249 are interspersed in the text section in order to keep them as close as
12250 possible to their references. This may be necessary for large assembly
12251 files.
12252
12253 @item -mtarget-align
12254 @itemx -mno-target-align
12255 @opindex mtarget-align
12256 @opindex mno-target-align
12257 When this option is enabled, GCC instructs the assembler to
12258 automatically align instructions to reduce branch penalties at the
12259 expense of some code density. The assembler attempts to widen density
12260 instructions to align branch targets and the instructions following call
12261 instructions. If there are not enough preceding safe density
12262 instructions to align a target, no widening will be performed. The
12263 default is @option{-mtarget-align}. These options do not affect the
12264 treatment of auto-aligned instructions like @code{LOOP}, which the
12265 assembler will always align, either by widening density instructions or
12266 by inserting no-op instructions.
12267
12268 @item -mlongcalls
12269 @itemx -mno-longcalls
12270 @opindex mlongcalls
12271 @opindex mno-longcalls
12272 When this option is enabled, GCC instructs the assembler to translate
12273 direct calls to indirect calls unless it can determine that the target
12274 of a direct call is in the range allowed by the call instruction. This
12275 translation typically occurs for calls to functions in other source
12276 files. Specifically, the assembler translates a direct @code{CALL}
12277 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12278 The default is @option{-mno-longcalls}. This option should be used in
12279 programs where the call target can potentially be out of range. This
12280 option is implemented in the assembler, not the compiler, so the
12281 assembly code generated by GCC will still show direct call
12282 instructions---look at the disassembled object code to see the actual
12283 instructions. Note that the assembler will use an indirect call for
12284 every cross-file call, not just those that really will be out of range.
12285 @end table
12286
12287 @node zSeries Options
12288 @subsection zSeries Options
12289 @cindex zSeries options
12290
12291 These are listed under @xref{S/390 and zSeries Options}.
12292
12293 @node Code Gen Options
12294 @section Options for Code Generation Conventions
12295 @cindex code generation conventions
12296 @cindex options, code generation
12297 @cindex run-time options
12298
12299 These machine-independent options control the interface conventions
12300 used in code generation.
12301
12302 Most of them have both positive and negative forms; the negative form
12303 of @option{-ffoo} would be @option{-fno-foo}. In the table below, only
12304 one of the forms is listed---the one which is not the default. You
12305 can figure out the other form by either removing @samp{no-} or adding
12306 it.
12307
12308 @table @gcctabopt
12309 @item -fbounds-check
12310 @opindex fbounds-check
12311 For front-ends that support it, generate additional code to check that
12312 indices used to access arrays are within the declared range. This is
12313 currently only supported by the Java and Fortran 77 front-ends, where
12314 this option defaults to true and false respectively.
12315
12316 @item -ftrapv
12317 @opindex ftrapv
12318 This option generates traps for signed overflow on addition, subtraction,
12319 multiplication operations.
12320
12321 @item -fwrapv
12322 @opindex fwrapv
12323 This option instructs the compiler to assume that signed arithmetic
12324 overflow of addition, subtraction and multiplication wraps around
12325 using twos-complement representation. This flag enables some optimizations
12326 and disables other. This option is enabled by default for the Java
12327 front-end, as required by the Java language specification.
12328
12329 @item -fexceptions
12330 @opindex fexceptions
12331 Enable exception handling. Generates extra code needed to propagate
12332 exceptions. For some targets, this implies GCC will generate frame
12333 unwind information for all functions, which can produce significant data
12334 size overhead, although it does not affect execution. If you do not
12335 specify this option, GCC will enable it by default for languages like
12336 C++ which normally require exception handling, and disable it for
12337 languages like C that do not normally require it. However, you may need
12338 to enable this option when compiling C code that needs to interoperate
12339 properly with exception handlers written in C++. You may also wish to
12340 disable this option if you are compiling older C++ programs that don't
12341 use exception handling.
12342
12343 @item -fnon-call-exceptions
12344 @opindex fnon-call-exceptions
12345 Generate code that allows trapping instructions to throw exceptions.
12346 Note that this requires platform-specific runtime support that does
12347 not exist everywhere. Moreover, it only allows @emph{trapping}
12348 instructions to throw exceptions, i.e.@: memory references or floating
12349 point instructions. It does not allow exceptions to be thrown from
12350 arbitrary signal handlers such as @code{SIGALRM}.
12351
12352 @item -funwind-tables
12353 @opindex funwind-tables
12354 Similar to @option{-fexceptions}, except that it will just generate any needed
12355 static data, but will not affect the generated code in any other way.
12356 You will normally not enable this option; instead, a language processor
12357 that needs this handling would enable it on your behalf.
12358
12359 @item -fasynchronous-unwind-tables
12360 @opindex fasynchronous-unwind-tables
12361 Generate unwind table in dwarf2 format, if supported by target machine. The
12362 table is exact at each instruction boundary, so it can be used for stack
12363 unwinding from asynchronous events (such as debugger or garbage collector).
12364
12365 @item -fpcc-struct-return
12366 @opindex fpcc-struct-return
12367 Return ``short'' @code{struct} and @code{union} values in memory like
12368 longer ones, rather than in registers. This convention is less
12369 efficient, but it has the advantage of allowing intercallability between
12370 GCC-compiled files and files compiled with other compilers, particularly
12371 the Portable C Compiler (pcc).
12372
12373 The precise convention for returning structures in memory depends
12374 on the target configuration macros.
12375
12376 Short structures and unions are those whose size and alignment match
12377 that of some integer type.
12378
12379 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12380 switch is not binary compatible with code compiled with the
12381 @option{-freg-struct-return} switch.
12382 Use it to conform to a non-default application binary interface.
12383
12384 @item -freg-struct-return
12385 @opindex freg-struct-return
12386 Return @code{struct} and @code{union} values in registers when possible.
12387 This is more efficient for small structures than
12388 @option{-fpcc-struct-return}.
12389
12390 If you specify neither @option{-fpcc-struct-return} nor
12391 @option{-freg-struct-return}, GCC defaults to whichever convention is
12392 standard for the target. If there is no standard convention, GCC
12393 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12394 the principal compiler. In those cases, we can choose the standard, and
12395 we chose the more efficient register return alternative.
12396
12397 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12398 switch is not binary compatible with code compiled with the
12399 @option{-fpcc-struct-return} switch.
12400 Use it to conform to a non-default application binary interface.
12401
12402 @item -fshort-enums
12403 @opindex fshort-enums
12404 Allocate to an @code{enum} type only as many bytes as it needs for the
12405 declared range of possible values. Specifically, the @code{enum} type
12406 will be equivalent to the smallest integer type which has enough room.
12407
12408 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12409 code that is not binary compatible with code generated without that switch.
12410 Use it to conform to a non-default application binary interface.
12411
12412 @item -fshort-double
12413 @opindex fshort-double
12414 Use the same size for @code{double} as for @code{float}.
12415
12416 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12417 code that is not binary compatible with code generated without that switch.
12418 Use it to conform to a non-default application binary interface.
12419
12420 @item -fshort-wchar
12421 @opindex fshort-wchar
12422 Override the underlying type for @samp{wchar_t} to be @samp{short
12423 unsigned int} instead of the default for the target. This option is
12424 useful for building programs to run under WINE@.
12425
12426 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12427 code that is not binary compatible with code generated without that switch.
12428 Use it to conform to a non-default application binary interface.
12429
12430 @item -fshared-data
12431 @opindex fshared-data
12432 Requests that the data and non-@code{const} variables of this
12433 compilation be shared data rather than private data. The distinction
12434 makes sense only on certain operating systems, where shared data is
12435 shared between processes running the same program, while private data
12436 exists in one copy per process.
12437
12438 @item -fno-common
12439 @opindex fno-common
12440 In C, allocate even uninitialized global variables in the data section of the
12441 object file, rather than generating them as common blocks. This has the
12442 effect that if the same variable is declared (without @code{extern}) in
12443 two different compilations, you will get an error when you link them.
12444 The only reason this might be useful is if you wish to verify that the
12445 program will work on other systems which always work this way.
12446
12447 @item -fno-ident
12448 @opindex fno-ident
12449 Ignore the @samp{#ident} directive.
12450
12451 @item -finhibit-size-directive
12452 @opindex finhibit-size-directive
12453 Don't output a @code{.size} assembler directive, or anything else that
12454 would cause trouble if the function is split in the middle, and the
12455 two halves are placed at locations far apart in memory. This option is
12456 used when compiling @file{crtstuff.c}; you should not need to use it
12457 for anything else.
12458
12459 @item -fverbose-asm
12460 @opindex fverbose-asm
12461 Put extra commentary information in the generated assembly code to
12462 make it more readable. This option is generally only of use to those
12463 who actually need to read the generated assembly code (perhaps while
12464 debugging the compiler itself).
12465
12466 @option{-fno-verbose-asm}, the default, causes the
12467 extra information to be omitted and is useful when comparing two assembler
12468 files.
12469
12470 @item -fpic
12471 @opindex fpic
12472 @cindex global offset table
12473 @cindex PIC
12474 Generate position-independent code (PIC) suitable for use in a shared
12475 library, if supported for the target machine. Such code accesses all
12476 constant addresses through a global offset table (GOT)@. The dynamic
12477 loader resolves the GOT entries when the program starts (the dynamic
12478 loader is not part of GCC; it is part of the operating system). If
12479 the GOT size for the linked executable exceeds a machine-specific
12480 maximum size, you get an error message from the linker indicating that
12481 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12482 instead. (These maximums are 8k on the SPARC and 32k
12483 on the m68k and RS/6000. The 386 has no such limit.)
12484
12485 Position-independent code requires special support, and therefore works
12486 only on certain machines. For the 386, GCC supports PIC for System V
12487 but not for the Sun 386i. Code generated for the IBM RS/6000 is always
12488 position-independent.
12489
12490 @item -fPIC
12491 @opindex fPIC
12492 If supported for the target machine, emit position-independent code,
12493 suitable for dynamic linking and avoiding any limit on the size of the
12494 global offset table. This option makes a difference on the m68k,
12495 PowerPC and SPARC@.
12496
12497 Position-independent code requires special support, and therefore works
12498 only on certain machines.
12499
12500 @item -fpie
12501 @itemx -fPIE
12502 @opindex fpie
12503 @opindex fPIE
12504 These options are similar to @option{-fpic} and @option{-fPIC}, but
12505 generated position independent code can be only linked into executables.
12506 Usually these options are used when @option{-pie} GCC option will be
12507 used during linking.
12508
12509 @item -ffixed-@var{reg}
12510 @opindex ffixed
12511 Treat the register named @var{reg} as a fixed register; generated code
12512 should never refer to it (except perhaps as a stack pointer, frame
12513 pointer or in some other fixed role).
12514
12515 @var{reg} must be the name of a register. The register names accepted
12516 are machine-specific and are defined in the @code{REGISTER_NAMES}
12517 macro in the machine description macro file.
12518
12519 This flag does not have a negative form, because it specifies a
12520 three-way choice.
12521
12522 @item -fcall-used-@var{reg}
12523 @opindex fcall-used
12524 Treat the register named @var{reg} as an allocable register that is
12525 clobbered by function calls. It may be allocated for temporaries or
12526 variables that do not live across a call. Functions compiled this way
12527 will not save and restore the register @var{reg}.
12528
12529 It is an error to used this flag with the frame pointer or stack pointer.
12530 Use of this flag for other registers that have fixed pervasive roles in
12531 the machine's execution model will produce disastrous results.
12532
12533 This flag does not have a negative form, because it specifies a
12534 three-way choice.
12535
12536 @item -fcall-saved-@var{reg}
12537 @opindex fcall-saved
12538 Treat the register named @var{reg} as an allocable register saved by
12539 functions. It may be allocated even for temporaries or variables that
12540 live across a call. Functions compiled this way will save and restore
12541 the register @var{reg} if they use it.
12542
12543 It is an error to used this flag with the frame pointer or stack pointer.
12544 Use of this flag for other registers that have fixed pervasive roles in
12545 the machine's execution model will produce disastrous results.
12546
12547 A different sort of disaster will result from the use of this flag for
12548 a register in which function values may be returned.
12549
12550 This flag does not have a negative form, because it specifies a
12551 three-way choice.
12552
12553 @item -fpack-struct[=@var{n}]
12554 @opindex fpack-struct
12555 Without a value specified, pack all structure members together without
12556 holes. When a value is specified (which must be a small power of two), pack
12557 structure members according to this value, representing the maximum
12558 alignment (that is, objects with default alignment requirements larger than
12559 this will be output potentially unaligned at the next fitting location.
12560
12561 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12562 code that is not binary compatible with code generated without that switch.
12563 Additionally, it makes the code suboptimal.
12564 Use it to conform to a non-default application binary interface.
12565
12566 @item -finstrument-functions
12567 @opindex finstrument-functions
12568 Generate instrumentation calls for entry and exit to functions. Just
12569 after function entry and just before function exit, the following
12570 profiling functions will be called with the address of the current
12571 function and its call site. (On some platforms,
12572 @code{__builtin_return_address} does not work beyond the current
12573 function, so the call site information may not be available to the
12574 profiling functions otherwise.)
12575
12576 @smallexample
12577 void __cyg_profile_func_enter (void *this_fn,
12578 void *call_site);
12579 void __cyg_profile_func_exit (void *this_fn,
12580 void *call_site);
12581 @end smallexample
12582
12583 The first argument is the address of the start of the current function,
12584 which may be looked up exactly in the symbol table.
12585
12586 This instrumentation is also done for functions expanded inline in other
12587 functions. The profiling calls will indicate where, conceptually, the
12588 inline function is entered and exited. This means that addressable
12589 versions of such functions must be available. If all your uses of a
12590 function are expanded inline, this may mean an additional expansion of
12591 code size. If you use @samp{extern inline} in your C code, an
12592 addressable version of such functions must be provided. (This is
12593 normally the case anyways, but if you get lucky and the optimizer always
12594 expands the functions inline, you might have gotten away without
12595 providing static copies.)
12596
12597 A function may be given the attribute @code{no_instrument_function}, in
12598 which case this instrumentation will not be done. This can be used, for
12599 example, for the profiling functions listed above, high-priority
12600 interrupt routines, and any functions from which the profiling functions
12601 cannot safely be called (perhaps signal handlers, if the profiling
12602 routines generate output or allocate memory).
12603
12604 @item -fstack-check
12605 @opindex fstack-check
12606 Generate code to verify that you do not go beyond the boundary of the
12607 stack. You should specify this flag if you are running in an
12608 environment with multiple threads, but only rarely need to specify it in
12609 a single-threaded environment since stack overflow is automatically
12610 detected on nearly all systems if there is only one stack.
12611
12612 Note that this switch does not actually cause checking to be done; the
12613 operating system must do that. The switch causes generation of code
12614 to ensure that the operating system sees the stack being extended.
12615
12616 @item -fstack-limit-register=@var{reg}
12617 @itemx -fstack-limit-symbol=@var{sym}
12618 @itemx -fno-stack-limit
12619 @opindex fstack-limit-register
12620 @opindex fstack-limit-symbol
12621 @opindex fno-stack-limit
12622 Generate code to ensure that the stack does not grow beyond a certain value,
12623 either the value of a register or the address of a symbol. If the stack
12624 would grow beyond the value, a signal is raised. For most targets,
12625 the signal is raised before the stack overruns the boundary, so
12626 it is possible to catch the signal without taking special precautions.
12627
12628 For instance, if the stack starts at absolute address @samp{0x80000000}
12629 and grows downwards, you can use the flags
12630 @option{-fstack-limit-symbol=__stack_limit} and
12631 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12632 of 128KB@. Note that this may only work with the GNU linker.
12633
12634 @cindex aliasing of parameters
12635 @cindex parameters, aliased
12636 @item -fargument-alias
12637 @itemx -fargument-noalias
12638 @itemx -fargument-noalias-global
12639 @opindex fargument-alias
12640 @opindex fargument-noalias
12641 @opindex fargument-noalias-global
12642 Specify the possible relationships among parameters and between
12643 parameters and global data.
12644
12645 @option{-fargument-alias} specifies that arguments (parameters) may
12646 alias each other and may alias global storage.@*
12647 @option{-fargument-noalias} specifies that arguments do not alias
12648 each other, but may alias global storage.@*
12649 @option{-fargument-noalias-global} specifies that arguments do not
12650 alias each other and do not alias global storage.
12651
12652 Each language will automatically use whatever option is required by
12653 the language standard. You should not need to use these options yourself.
12654
12655 @item -fleading-underscore
12656 @opindex fleading-underscore
12657 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12658 change the way C symbols are represented in the object file. One use
12659 is to help link with legacy assembly code.
12660
12661 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12662 generate code that is not binary compatible with code generated without that
12663 switch. Use it to conform to a non-default application binary interface.
12664 Not all targets provide complete support for this switch.
12665
12666 @item -ftls-model=@var{model}
12667 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12668 The @var{model} argument should be one of @code{global-dynamic},
12669 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
12670
12671 The default without @option{-fpic} is @code{initial-exec}; with
12672 @option{-fpic} the default is @code{global-dynamic}.
12673
12674 @item -fvisibility=@var{default|internal|hidden|protected}
12675 @opindex fvisibility
12676 Set the default ELF image symbol visibility to the specified option---all
12677 symbols will be marked with this unless overridden within the code.
12678 Using this feature can very substantially improve linking and
12679 load times of shared object libraries, produce more optimized
12680 code, provide near-perfect API export and prevent symbol clashes.
12681 It is @strong{strongly} recommended that you use this in any shared objects
12682 you distribute.
12683
12684 Despite the nomenclature, @code{default} always means public ie;
12685 available to be linked against from outside the shared object.
12686 @code{protected} and @code{internal} are pretty useless in real-world
12687 usage so the only other commonly used option will be @code{hidden}.
12688 The default if @option{-fvisibility} isn't specified is
12689 @code{default}, i.e., make every
12690 symbol public---this causes the same behavior as previous versions of
12691 GCC@.
12692
12693 A good explanation of the benefits offered by ensuring ELF
12694 symbols have the correct visibility is given by ``How To Write
12695 Shared Libraries'' by Ulrich Drepper (which can be found at
12696 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
12697 solution made possible by this option to marking things hidden when
12698 the default is public is to make the default hidden and mark things
12699 public. This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
12700 and @code{__attribute__ ((visibility("default")))} instead of
12701 @code{__declspec(dllexport)} you get almost identical semantics with
12702 identical syntax. This is a great boon to those working with
12703 cross-platform projects.
12704
12705 For those adding visibility support to existing code, you may find
12706 @samp{#pragma GCC visibility} of use. This works by you enclosing
12707 the declarations you wish to set visibility for with (for example)
12708 @samp{#pragma GCC visibility push(hidden)} and
12709 @samp{#pragma GCC visibility pop}. These can be nested up to sixteen
12710 times. Bear in mind that symbol visibility should be viewed @strong{as
12711 part of the API interface contract} and thus all new code should
12712 always specify visibility when it is not the default ie; declarations
12713 only for use within the local DSO should @strong{always} be marked explicitly
12714 as hidden as so to avoid PLT indirection overheads---making this
12715 abundantly clear also aids readability and self-documentation of the code.
12716 Note that due to ISO C++ specification requirements, operator new and
12717 operator delete must always be of default visibility.
12718
12719 An overview of these techniques, their benefits and how to use them
12720 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
12721
12722 @end table
12723
12724 @c man end
12725
12726 @node Environment Variables
12727 @section Environment Variables Affecting GCC
12728 @cindex environment variables
12729
12730 @c man begin ENVIRONMENT
12731 This section describes several environment variables that affect how GCC
12732 operates. Some of them work by specifying directories or prefixes to use
12733 when searching for various kinds of files. Some are used to specify other
12734 aspects of the compilation environment.
12735
12736 Note that you can also specify places to search using options such as
12737 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}). These
12738 take precedence over places specified using environment variables, which
12739 in turn take precedence over those specified by the configuration of GCC@.
12740 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
12741 GNU Compiler Collection (GCC) Internals}.
12742
12743 @table @env
12744 @item LANG
12745 @itemx LC_CTYPE
12746 @c @itemx LC_COLLATE
12747 @itemx LC_MESSAGES
12748 @c @itemx LC_MONETARY
12749 @c @itemx LC_NUMERIC
12750 @c @itemx LC_TIME
12751 @itemx LC_ALL
12752 @findex LANG
12753 @findex LC_CTYPE
12754 @c @findex LC_COLLATE
12755 @findex LC_MESSAGES
12756 @c @findex LC_MONETARY
12757 @c @findex LC_NUMERIC
12758 @c @findex LC_TIME
12759 @findex LC_ALL
12760 @cindex locale
12761 These environment variables control the way that GCC uses
12762 localization information that allow GCC to work with different
12763 national conventions. GCC inspects the locale categories
12764 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
12765 so. These locale categories can be set to any value supported by your
12766 installation. A typical value is @samp{en_GB.UTF-8} for English in the United
12767 Kingdom encoded in UTF-8.
12768
12769 The @env{LC_CTYPE} environment variable specifies character
12770 classification. GCC uses it to determine the character boundaries in
12771 a string; this is needed for some multibyte encodings that contain quote
12772 and escape characters that would otherwise be interpreted as a string
12773 end or escape.
12774
12775 The @env{LC_MESSAGES} environment variable specifies the language to
12776 use in diagnostic messages.
12777
12778 If the @env{LC_ALL} environment variable is set, it overrides the value
12779 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
12780 and @env{LC_MESSAGES} default to the value of the @env{LANG}
12781 environment variable. If none of these variables are set, GCC
12782 defaults to traditional C English behavior.
12783
12784 @item TMPDIR
12785 @findex TMPDIR
12786 If @env{TMPDIR} is set, it specifies the directory to use for temporary
12787 files. GCC uses temporary files to hold the output of one stage of
12788 compilation which is to be used as input to the next stage: for example,
12789 the output of the preprocessor, which is the input to the compiler
12790 proper.
12791
12792 @item GCC_EXEC_PREFIX
12793 @findex GCC_EXEC_PREFIX
12794 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
12795 names of the subprograms executed by the compiler. No slash is added
12796 when this prefix is combined with the name of a subprogram, but you can
12797 specify a prefix that ends with a slash if you wish.
12798
12799 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
12800 an appropriate prefix to use based on the pathname it was invoked with.
12801
12802 If GCC cannot find the subprogram using the specified prefix, it
12803 tries looking in the usual places for the subprogram.
12804
12805 The default value of @env{GCC_EXEC_PREFIX} is
12806 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
12807 of @code{prefix} when you ran the @file{configure} script.
12808
12809 Other prefixes specified with @option{-B} take precedence over this prefix.
12810
12811 This prefix is also used for finding files such as @file{crt0.o} that are
12812 used for linking.
12813
12814 In addition, the prefix is used in an unusual way in finding the
12815 directories to search for header files. For each of the standard
12816 directories whose name normally begins with @samp{/usr/local/lib/gcc}
12817 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
12818 replacing that beginning with the specified prefix to produce an
12819 alternate directory name. Thus, with @option{-Bfoo/}, GCC will search
12820 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
12821 These alternate directories are searched first; the standard directories
12822 come next.
12823
12824 @item COMPILER_PATH
12825 @findex COMPILER_PATH
12826 The value of @env{COMPILER_PATH} is a colon-separated list of
12827 directories, much like @env{PATH}. GCC tries the directories thus
12828 specified when searching for subprograms, if it can't find the
12829 subprograms using @env{GCC_EXEC_PREFIX}.
12830
12831 @item LIBRARY_PATH
12832 @findex LIBRARY_PATH
12833 The value of @env{LIBRARY_PATH} is a colon-separated list of
12834 directories, much like @env{PATH}. When configured as a native compiler,
12835 GCC tries the directories thus specified when searching for special
12836 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}. Linking
12837 using GCC also uses these directories when searching for ordinary
12838 libraries for the @option{-l} option (but directories specified with
12839 @option{-L} come first).
12840
12841 @item LANG
12842 @findex LANG
12843 @cindex locale definition
12844 This variable is used to pass locale information to the compiler. One way in
12845 which this information is used is to determine the character set to be used
12846 when character literals, string literals and comments are parsed in C and C++.
12847 When the compiler is configured to allow multibyte characters,
12848 the following values for @env{LANG} are recognized:
12849
12850 @table @samp
12851 @item C-JIS
12852 Recognize JIS characters.
12853 @item C-SJIS
12854 Recognize SJIS characters.
12855 @item C-EUCJP
12856 Recognize EUCJP characters.
12857 @end table
12858
12859 If @env{LANG} is not defined, or if it has some other value, then the
12860 compiler will use mblen and mbtowc as defined by the default locale to
12861 recognize and translate multibyte characters.
12862 @end table
12863
12864 @noindent
12865 Some additional environments variables affect the behavior of the
12866 preprocessor.
12867
12868 @include cppenv.texi
12869
12870 @c man end
12871
12872 @node Precompiled Headers
12873 @section Using Precompiled Headers
12874 @cindex precompiled headers
12875 @cindex speed of compilation
12876
12877 Often large projects have many header files that are included in every
12878 source file. The time the compiler takes to process these header files
12879 over and over again can account for nearly all of the time required to
12880 build the project. To make builds faster, GCC allows users to
12881 `precompile' a header file; then, if builds can use the precompiled
12882 header file they will be much faster.
12883
12884 @strong{Caution:} There are a few known situations where GCC will
12885 crash when trying to use a precompiled header. If you have trouble
12886 with a precompiled header, you should remove the precompiled header
12887 and compile without it. In addition, please use GCC's on-line
12888 defect-tracking system to report any problems you encounter with
12889 precompiled headers. @xref{Bugs}.
12890
12891 To create a precompiled header file, simply compile it as you would any
12892 other file, if necessary using the @option{-x} option to make the driver
12893 treat it as a C or C++ header file. You will probably want to use a
12894 tool like @command{make} to keep the precompiled header up-to-date when
12895 the headers it contains change.
12896
12897 A precompiled header file will be searched for when @code{#include} is
12898 seen in the compilation. As it searches for the included file
12899 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
12900 compiler looks for a precompiled header in each directory just before it
12901 looks for the include file in that directory. The name searched for is
12902 the name specified in the @code{#include} with @samp{.gch} appended. If
12903 the precompiled header file can't be used, it is ignored.
12904
12905 For instance, if you have @code{#include "all.h"}, and you have
12906 @file{all.h.gch} in the same directory as @file{all.h}, then the
12907 precompiled header file will be used if possible, and the original
12908 header will be used otherwise.
12909
12910 Alternatively, you might decide to put the precompiled header file in a
12911 directory and use @option{-I} to ensure that directory is searched
12912 before (or instead of) the directory containing the original header.
12913 Then, if you want to check that the precompiled header file is always
12914 used, you can put a file of the same name as the original header in this
12915 directory containing an @code{#error} command.
12916
12917 This also works with @option{-include}. So yet another way to use
12918 precompiled headers, good for projects not designed with precompiled
12919 header files in mind, is to simply take most of the header files used by
12920 a project, include them from another header file, precompile that header
12921 file, and @option{-include} the precompiled header. If the header files
12922 have guards against multiple inclusion, they will be skipped because
12923 they've already been included (in the precompiled header).
12924
12925 If you need to precompile the same header file for different
12926 languages, targets, or compiler options, you can instead make a
12927 @emph{directory} named like @file{all.h.gch}, and put each precompiled
12928 header in the directory, perhaps using @option{-o}. It doesn't matter
12929 what you call the files in the directory, every precompiled header in
12930 the directory will be considered. The first precompiled header
12931 encountered in the directory that is valid for this compilation will
12932 be used; they're searched in no particular order.
12933
12934 There are many other possibilities, limited only by your imagination,
12935 good sense, and the constraints of your build system.
12936
12937 A precompiled header file can be used only when these conditions apply:
12938
12939 @itemize
12940 @item
12941 Only one precompiled header can be used in a particular compilation.
12942
12943 @item
12944 A precompiled header can't be used once the first C token is seen. You
12945 can have preprocessor directives before a precompiled header; you can
12946 even include a precompiled header from inside another header, so long as
12947 there are no C tokens before the @code{#include}.
12948
12949 @item
12950 The precompiled header file must be produced for the same language as
12951 the current compilation. You can't use a C precompiled header for a C++
12952 compilation.
12953
12954 @item
12955 The precompiled header file must be produced by the same compiler
12956 version and configuration as the current compilation is using.
12957 The easiest way to guarantee this is to use the same compiler binary
12958 for creating and using precompiled headers.
12959
12960 @item
12961 Any macros defined before the precompiled header is included must
12962 either be defined in the same way as when the precompiled header was
12963 generated, or must not affect the precompiled header, which usually
12964 means that they don't appear in the precompiled header at all.
12965
12966 The @option{-D} option is one way to define a macro before a
12967 precompiled header is included; using a @code{#define} can also do it.
12968 There are also some options that define macros implicitly, like
12969 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
12970 defined this way.
12971
12972 @item If debugging information is output when using the precompiled
12973 header, using @option{-g} or similar, the same kind of debugging information
12974 must have been output when building the precompiled header. However,
12975 a precompiled header built using @option{-g} can be used in a compilation
12976 when no debugging information is being output.
12977
12978 @item The same @option{-m} options must generally be used when building
12979 and using the precompiled header. @xref{Submodel Options},
12980 for any cases where this rule is relaxed.
12981
12982 @item Each of the following options must be the same when building and using
12983 the precompiled header:
12984
12985 @gccoptlist{-fexceptions -funit-at-a-time}
12986
12987 @item
12988 Some other command-line options starting with @option{-f},
12989 @option{-p}, or @option{-O} must be defined in the same way as when
12990 the precompiled header was generated. At present, it's not clear
12991 which options are safe to change and which are not; the safest choice
12992 is to use exactly the same options when generating and using the
12993 precompiled header. The following are known to be safe:
12994
12995 @gccoptlist{-fpreprocessed -pedantic-errors}
12996
12997 @end itemize
12998
12999 For all of these except the last, the compiler will automatically
13000 ignore the precompiled header if the conditions aren't met. If you
13001 find an option combination that doesn't work and doesn't cause the
13002 precompiled header to be ignored, please consider filing a bug report,
13003 see @ref{Bugs}.
13004
13005 If you do use differing options when generating and using the
13006 precompiled header, the actual behavior will be a mixture of the
13007 behavior for the options. For instance, if you use @option{-g} to
13008 generate the precompiled header but not when using it, you may or may
13009 not get debugging information for routines in the precompiled header.
13010
13011 @node Running Protoize
13012 @section Running Protoize
13013
13014 The program @code{protoize} is an optional part of GCC@. You can use
13015 it to add prototypes to a program, thus converting the program to ISO
13016 C in one respect. The companion program @code{unprotoize} does the
13017 reverse: it removes argument types from any prototypes that are found.
13018
13019 When you run these programs, you must specify a set of source files as
13020 command line arguments. The conversion programs start out by compiling
13021 these files to see what functions they define. The information gathered
13022 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13023
13024 After scanning comes actual conversion. The specified files are all
13025 eligible to be converted; any files they include (whether sources or
13026 just headers) are eligible as well.
13027
13028 But not all the eligible files are converted. By default,
13029 @code{protoize} and @code{unprotoize} convert only source and header
13030 files in the current directory. You can specify additional directories
13031 whose files should be converted with the @option{-d @var{directory}}
13032 option. You can also specify particular files to exclude with the
13033 @option{-x @var{file}} option. A file is converted if it is eligible, its
13034 directory name matches one of the specified directory names, and its
13035 name within the directory has not been excluded.
13036
13037 Basic conversion with @code{protoize} consists of rewriting most
13038 function definitions and function declarations to specify the types of
13039 the arguments. The only ones not rewritten are those for varargs
13040 functions.
13041
13042 @code{protoize} optionally inserts prototype declarations at the
13043 beginning of the source file, to make them available for any calls that
13044 precede the function's definition. Or it can insert prototype
13045 declarations with block scope in the blocks where undeclared functions
13046 are called.
13047
13048 Basic conversion with @code{unprotoize} consists of rewriting most
13049 function declarations to remove any argument types, and rewriting
13050 function definitions to the old-style pre-ISO form.
13051
13052 Both conversion programs print a warning for any function declaration or
13053 definition that they can't convert. You can suppress these warnings
13054 with @option{-q}.
13055
13056 The output from @code{protoize} or @code{unprotoize} replaces the
13057 original source file. The original file is renamed to a name ending
13058 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
13059 without the original @samp{.c} suffix). If the @samp{.save} (@samp{.sav}
13060 for DOS) file already exists, then the source file is simply discarded.
13061
13062 @code{protoize} and @code{unprotoize} both depend on GCC itself to
13063 scan the program and collect information about the functions it uses.
13064 So neither of these programs will work until GCC is installed.
13065
13066 Here is a table of the options you can use with @code{protoize} and
13067 @code{unprotoize}. Each option works with both programs unless
13068 otherwise stated.
13069
13070 @table @code
13071 @item -B @var{directory}
13072 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13073 usual directory (normally @file{/usr/local/lib}). This file contains
13074 prototype information about standard system functions. This option
13075 applies only to @code{protoize}.
13076
13077 @item -c @var{compilation-options}
13078 Use @var{compilation-options} as the options when running @command{gcc} to
13079 produce the @samp{.X} files. The special option @option{-aux-info} is
13080 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
13081
13082 Note that the compilation options must be given as a single argument to
13083 @code{protoize} or @code{unprotoize}. If you want to specify several
13084 @command{gcc} options, you must quote the entire set of compilation options
13085 to make them a single word in the shell.
13086
13087 There are certain @command{gcc} arguments that you cannot use, because they
13088 would produce the wrong kind of output. These include @option{-g},
13089 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
13090 the @var{compilation-options}, they are ignored.
13091
13092 @item -C
13093 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
13094 systems) instead of @samp{.c}. This is convenient if you are converting
13095 a C program to C++. This option applies only to @code{protoize}.
13096
13097 @item -g
13098 Add explicit global declarations. This means inserting explicit
13099 declarations at the beginning of each source file for each function
13100 that is called in the file and was not declared. These declarations
13101 precede the first function definition that contains a call to an
13102 undeclared function. This option applies only to @code{protoize}.
13103
13104 @item -i @var{string}
13105 Indent old-style parameter declarations with the string @var{string}.
13106 This option applies only to @code{protoize}.
13107
13108 @code{unprotoize} converts prototyped function definitions to old-style
13109 function definitions, where the arguments are declared between the
13110 argument list and the initial @samp{@{}. By default, @code{unprotoize}
13111 uses five spaces as the indentation. If you want to indent with just
13112 one space instead, use @option{-i " "}.
13113
13114 @item -k
13115 Keep the @samp{.X} files. Normally, they are deleted after conversion
13116 is finished.
13117
13118 @item -l
13119 Add explicit local declarations. @code{protoize} with @option{-l} inserts
13120 a prototype declaration for each function in each block which calls the
13121 function without any declaration. This option applies only to
13122 @code{protoize}.
13123
13124 @item -n
13125 Make no real changes. This mode just prints information about the conversions
13126 that would have been done without @option{-n}.
13127
13128 @item -N
13129 Make no @samp{.save} files. The original files are simply deleted.
13130 Use this option with caution.
13131
13132 @item -p @var{program}
13133 Use the program @var{program} as the compiler. Normally, the name
13134 @file{gcc} is used.
13135
13136 @item -q
13137 Work quietly. Most warnings are suppressed.
13138
13139 @item -v
13140 Print the version number, just like @option{-v} for @command{gcc}.
13141 @end table
13142
13143 If you need special compiler options to compile one of your program's
13144 source files, then you should generate that file's @samp{.X} file
13145 specially, by running @command{gcc} on that source file with the
13146 appropriate options and the option @option{-aux-info}. Then run
13147 @code{protoize} on the entire set of files. @code{protoize} will use
13148 the existing @samp{.X} file because it is newer than the source file.
13149 For example:
13150
13151 @smallexample
13152 gcc -Dfoo=bar file1.c -aux-info file1.X
13153 protoize *.c
13154 @end smallexample
13155
13156 @noindent
13157 You need to include the special files along with the rest in the
13158 @code{protoize} command, even though their @samp{.X} files already
13159 exist, because otherwise they won't get converted.
13160
13161 @xref{Protoize Caveats}, for more information on how to use
13162 @code{protoize} successfully.