1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
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.
19 (a) The FSF's Front-Cover Text is:
23 (b) The FSF's Back-Cover Text is:
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.
29 @c Set file name and title for the man page.
31 @settitle GNU project C and C++ compiler
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{}
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}.
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), g77(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{g77}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}. Use of the @command{gccbug}
53 script to report bugs is recommended.
56 See the Info entry for @command{gcc}, or
57 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
58 for contributors to GCC@.
63 @chapter GCC Command Options
64 @cindex GCC command options
65 @cindex command options
66 @cindex options, GCC command
68 @c man begin DESCRIPTION
69 When you invoke GCC, it normally does preprocessing, compilation,
70 assembly and linking. The ``overall options'' allow you to stop this
71 process at an intermediate stage. For example, the @option{-c} option
72 says not to run the linker. Then the output consists of object files
73 output by the assembler.
75 Other options are passed on to one stage of processing. Some options
76 control the preprocessor and others the compiler itself. Yet other
77 options control the assembler and linker; most of these are not
78 documented here, since you rarely need to use any of them.
80 @cindex C compilation options
81 Most of the command line options that you can use with GCC are useful
82 for C programs; when an option is only useful with another language
83 (usually C++), the explanation says so explicitly. If the description
84 for a particular option does not mention a source language, you can use
85 that option with all supported languages.
87 @cindex C++ compilation options
88 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
89 options for compiling C++ programs.
91 @cindex grouping options
92 @cindex options, grouping
93 The @command{gcc} program accepts options and file names as operands. Many
94 options have multi-letter names; therefore multiple single-letter options
95 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
98 @cindex order of options
99 @cindex options, order
100 You can mix options and other arguments. For the most part, the order
101 you use doesn't matter. Order does matter when you use several options
102 of the same kind; for example, if you specify @option{-L} more than once,
103 the directories are searched in the order specified.
105 Many options have long names starting with @samp{-f} or with
106 @samp{-W}---for example, @option{-fforce-mem},
107 @option{-fstrength-reduce}, @option{-Wformat} and so on. Most of
108 these have both positive and negative forms; the negative form of
109 @option{-ffoo} would be @option{-fno-foo}. This manual documents
110 only one of these two forms, whichever one is not the default.
114 @xref{Option Index}, for an index to GCC's options.
117 * Option Summary:: Brief list of all options, without explanations.
118 * Overall Options:: Controlling the kind of output:
119 an executable, object files, assembler files,
120 or preprocessed source.
121 * Invoking G++:: Compiling C++ programs.
122 * C Dialect Options:: Controlling the variant of C language compiled.
123 * C++ Dialect Options:: Variations on C++.
124 * Objective-C Dialect Options:: Variations on Objective-C.
125 * Language Independent Options:: Controlling how diagnostics should be
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
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.
150 @section Option Summary
152 Here is a summary of all the options, grouped by type. Explanations are
153 in the following sections.
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c -S -E -o @var{file} -pipe -pass-exit-codes @gol
159 -x @var{language} -v -### --help --target-help --version}
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 @gol
172 @item C++ Language Options
173 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
174 @gccoptlist{-fabi-version=@var{n} -fno-access-control -fcheck-new @gol
175 -fconserve-space -fno-const-strings @gol
176 -fno-elide-constructors @gol
177 -fno-enforce-eh-specs @gol
178 -ffor-scope -fno-for-scope -fno-gnu-keywords @gol
179 -fno-implicit-templates @gol
180 -fno-implicit-inline-templates @gol
181 -fno-implement-inlines -fms-extensions @gol
182 -fno-nonansi-builtins -fno-operator-names @gol
183 -fno-optional-diags -fpermissive @gol
184 -frepo -fno-rtti -fstats -ftemplate-depth-@var{n} @gol
185 -fuse-cxa-atexit -fno-weak -nostdinc++ @gol
186 -fno-default-inline -Wabi -Wctor-dtor-privacy @gol
187 -Wnon-virtual-dtor -Wreorder @gol
188 -Weffc++ -Wno-deprecated @gol
189 -Wno-non-template-friend -Wold-style-cast @gol
190 -Woverloaded-virtual -Wno-pmf-conversions @gol
191 -Wsign-promo -Wsynth}
193 @item Objective-C Language Options
194 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
196 -fconstant-string-class=@var{class-name} @gol
197 -fgnu-runtime -fnext-runtime @gol
198 -fno-nil-receivers @gol
199 -fobjc-exceptions @gol
200 -freplace-objc-classes @gol
203 -Wno-protocol -Wselector -Wundeclared-selector}
205 @item Language Independent Options
206 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
207 @gccoptlist{-fmessage-length=@var{n} @gol
208 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
210 @item Warning Options
211 @xref{Warning Options,,Options to Request or Suppress Warnings}.
212 @gccoptlist{-fsyntax-only -pedantic -pedantic-errors @gol
213 -w -Wextra -Wall -Waggregate-return @gol
214 -Wcast-align -Wcast-qual -Wchar-subscripts -Wcomment @gol
215 -Wconversion -Wno-deprecated-declarations @gol
216 -Wdisabled-optimization -Wno-div-by-zero -Wendif-labels @gol
217 -Werror -Werror-implicit-function-declaration @gol
218 -Wfloat-equal -Wformat -Wformat=2 @gol
219 -Wno-format-extra-args -Wformat-nonliteral @gol
220 -Wformat-security -Wformat-y2k @gol
221 -Wimplicit -Wimplicit-function-declaration -Wimplicit-int @gol
222 -Wimport -Wno-import -Winit-self -Winline @gol
223 -Wno-invalid-offsetof -Winvalid-pch @gol
224 -Wlarger-than-@var{len} -Wlong-long @gol
225 -Wmain -Wmissing-braces @gol
226 -Wmissing-format-attribute -Wmissing-noreturn @gol
227 -Wno-multichar -Wnonnull -Wpacked -Wpadded @gol
228 -Wparentheses -Wpointer-arith -Wredundant-decls @gol
229 -Wreturn-type -Wsequence-point -Wshadow @gol
230 -Wsign-compare -Wstrict-aliasing @gol
231 -Wswitch -Wswitch-default -Wswitch-enum @gol
232 -Wsystem-headers -Wtrigraphs -Wundef -Wuninitialized @gol
233 -Wunknown-pragmas -Wunreachable-code @gol
234 -Wunused -Wunused-function -Wunused-label -Wunused-parameter @gol
235 -Wunused-value -Wunused-variable -Wwrite-strings}
237 @item C-only Warning Options
238 @gccoptlist{-Wbad-function-cast -Wmissing-declarations @gol
239 -Wmissing-prototypes -Wnested-externs -Wold-style-definition @gol
240 -Wstrict-prototypes -Wtraditional @gol
241 -Wdeclaration-after-statement}
243 @item Debugging Options
244 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
245 @gccoptlist{-d@var{letters} -dumpspecs -dumpmachine -dumpversion @gol
246 -fdump-unnumbered -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
247 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
248 -fdump-tree-original@r{[}-@var{n}@r{]} @gol
249 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
250 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
251 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
252 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
253 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
254 -ftest-coverage -ftime-report -fvar-tracking @gol
255 -g -g@var{level} -gcoff -gdwarf-2 @gol
256 -ggdb -gstabs -gstabs+ -gvms -gxcoff -gxcoff+ @gol
257 -p -pg -print-file-name=@var{library} -print-libgcc-file-name @gol
258 -print-multi-directory -print-multi-lib @gol
259 -print-prog-name=@var{program} -print-search-dirs -Q @gol
262 @item Optimization Options
263 @xref{Optimize Options,,Options that Control Optimization}.
264 @gccoptlist{-falign-functions=@var{n} -falign-jumps=@var{n} @gol
265 -falign-labels=@var{n} -falign-loops=@var{n} @gol
266 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
267 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
268 -fcaller-saves -fcprop-registers @gol
269 -fcse-follow-jumps -fcse-skip-blocks -fdata-sections @gol
270 -fdelayed-branch -fdelete-null-pointer-checks @gol
271 -fexpensive-optimizations -ffast-math -ffloat-store @gol
272 -fforce-addr -fforce-mem -ffunction-sections @gol
273 -fgcse -fgcse-lm -fgcse-sm -fgcse-las -floop-optimize @gol
274 -fcrossjumping -fif-conversion -fif-conversion2 @gol
275 -finline-functions -finline-limit=@var{n} -fkeep-inline-functions @gol
276 -fkeep-static-consts -fmerge-constants -fmerge-all-constants @gol
277 -fmove-all-movables -fnew-ra -fno-branch-count-reg @gol
278 -fno-default-inline -fno-defer-pop @gol
279 -fno-function-cse -fno-guess-branch-probability @gol
280 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
281 -funsafe-math-optimizations -ffinite-math-only @gol
282 -fno-trapping-math -fno-zero-initialized-in-bss @gol
283 -fomit-frame-pointer -foptimize-register-move @gol
284 -foptimize-sibling-calls -fprefetch-loop-arrays @gol
285 -fprofile-generate -fprofile-use @gol
286 -freduce-all-givs -fregmove -frename-registers @gol
287 -freorder-blocks -freorder-functions @gol
288 -frerun-cse-after-loop -frerun-loop-opt @gol
289 -frounding-math -fschedule-insns -fschedule-insns2 @gol
290 -fno-sched-interblock -fno-sched-spec -fsched-spec-load @gol
291 -fsched-spec-load-dangerous @gol
292 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
293 -fsched2-use-superblocks @gol
294 -fsched2-use-traces -fsignaling-nans @gol
295 -fsingle-precision-constant @gol
296 -fstrength-reduce -fstrict-aliasing -ftracer -fthread-jumps @gol
297 -funroll-all-loops -funroll-loops -fpeel-loops @gol
298 -funswitch-loops -fold-unroll-loops -fold-unroll-all-loops @gol
299 --param @var{name}=@var{value}
300 -O -O0 -O1 -O2 -O3 -Os}
302 @item Preprocessor Options
303 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
304 @gccoptlist{-A@var{question}=@var{answer} @gol
305 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
306 -C -dD -dI -dM -dN @gol
307 -D@var{macro}@r{[}=@var{defn}@r{]} -E -H @gol
308 -idirafter @var{dir} @gol
309 -include @var{file} -imacros @var{file} @gol
310 -iprefix @var{file} -iwithprefix @var{dir} @gol
311 -iwithprefixbefore @var{dir} -isystem @var{dir} @gol
312 -M -MM -MF -MG -MP -MQ -MT -nostdinc @gol
313 -P -fworking-directory -remap @gol
314 -trigraphs -undef -U@var{macro} -Wp,@var{option} @gol
315 -Xpreprocessor @var{option}}
317 @item Assembler Option
318 @xref{Assembler Options,,Passing Options to the Assembler}.
319 @gccoptlist{-Wa,@var{option} -Xassembler @var{option}}
322 @xref{Link Options,,Options for Linking}.
323 @gccoptlist{@var{object-file-name} -l@var{library} @gol
324 -nostartfiles -nodefaultlibs -nostdlib -pie @gol
325 -s -static -static-libgcc -shared -shared-libgcc -symbolic @gol
326 -Wl,@var{option} -Xlinker @var{option} @gol
329 @item Directory Options
330 @xref{Directory Options,,Options for Directory Search}.
331 @gccoptlist{-B@var{prefix} -I@var{dir} -I- -L@var{dir} -specs=@var{file}}
334 @c I wrote this xref this way to avoid overfull hbox. -- rms
335 @xref{Target Options}.
336 @gccoptlist{-V @var{version} -b @var{machine}}
338 @item Machine Dependent Options
339 @xref{Submodel Options,,Hardware Models and Configurations}.
341 @emph{M680x0 Options}
342 @gccoptlist{-m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 @gol
343 -m68060 -mcpu32 -m5200 -m68881 -mbitfield -mc68000 -mc68020 @gol
344 -mnobitfield -mrtd -mshort -msoft-float -mpcrel @gol
345 -malign-int -mstrict-align -msep-data -mno-sep-data @gol
346 -mshared-library-id=n -mid-shared-library -mno-id-shared-library}
348 @emph{M68hc1x Options}
349 @gccoptlist{-m6811 -m6812 -m68hc11 -m68hc12 -m68hcs12 @gol
350 -mauto-incdec -minmax -mlong-calls -mshort @gol
351 -msoft-reg-count=@var{count}}
354 @gccoptlist{-mg -mgnu -munix}
357 @gccoptlist{-mcpu=@var{cpu-type} @gol
358 -mtune=@var{cpu-type} @gol
359 -mcmodel=@var{code-model} @gol
360 -m32 -m64 -mapp-regs -mno-app-regs @gol
361 -mfaster-structs -mno-faster-structs @gol
362 -mfpu -mno-fpu -mhard-float -msoft-float @gol
363 -mhard-quad-float -msoft-quad-float @gol
364 -mimpure-text -mno-impure-text -mlittle-endian @gol
365 -mstack-bias -mno-stack-bias @gol
366 -munaligned-doubles -mno-unaligned-doubles @gol
367 -mv8plus -mno-v8plus -mvis -mno-vis}
370 @gccoptlist{-mapcs-frame -mno-apcs-frame @gol
371 -mapcs-26 -mapcs-32 @gol
372 -mapcs-stack-check -mno-apcs-stack-check @gol
373 -mapcs-float -mno-apcs-float @gol
374 -mapcs-reentrant -mno-apcs-reentrant @gol
375 -msched-prolog -mno-sched-prolog @gol
376 -mlittle-endian -mbig-endian -mwords-little-endian @gol
377 -malignment-traps -mno-alignment-traps @gol
378 -mfloat-abi=@var{name} soft-float -mhard-float -mfpe @gol
379 -mthumb-interwork -mno-thumb-interwork @gol
380 -mcpu=@var{name} -march=@var{name} -mfpu=@var{name} @gol
381 -mstructure-size-boundary=@var{n} @gol
382 -mabort-on-noreturn @gol
383 -mlong-calls -mno-long-calls @gol
384 -msingle-pic-base -mno-single-pic-base @gol
385 -mpic-register=@var{reg} @gol
386 -mnop-fun-dllimport @gol
387 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
388 -mpoke-function-name @gol
390 -mtpcs-frame -mtpcs-leaf-frame @gol
391 -mcaller-super-interworking -mcallee-super-interworking}
393 @emph{MN10300 Options}
394 @gccoptlist{-mmult-bug -mno-mult-bug @gol
395 -mam33 -mno-am33 @gol
396 -mam33-2 -mno-am33-2 @gol
399 @emph{M32R/D Options}
400 @gccoptlist{-m32r2 -m32rx -m32r @gol
402 -malign-loops -mno-align-loops @gol
403 -missue-rate=@var{number} @gol
404 -mbranch-cost=@var{number} @gol
405 -mmodel=@var{code-size-model-type} @gol
406 -msdata=@var{sdata-type} @gol
407 -mno-flush-func -mflush-func=@var{name} @gol
408 -mno-flush-trap -mflush-trap=@var{number} @gol
411 @emph{RS/6000 and PowerPC Options}
412 @gccoptlist{-mcpu=@var{cpu-type} @gol
413 -mtune=@var{cpu-type} @gol
414 -mpower -mno-power -mpower2 -mno-power2 @gol
415 -mpowerpc -mpowerpc64 -mno-powerpc @gol
416 -maltivec -mno-altivec @gol
417 -mpowerpc-gpopt -mno-powerpc-gpopt @gol
418 -mpowerpc-gfxopt -mno-powerpc-gfxopt @gol
419 -mnew-mnemonics -mold-mnemonics @gol
420 -mfull-toc -mminimal-toc -mno-fp-in-toc -mno-sum-in-toc @gol
421 -m64 -m32 -mxl-call -mno-xl-call -mpe @gol
422 -malign-power -malign-natural @gol
423 -msoft-float -mhard-float -mmultiple -mno-multiple @gol
424 -mstring -mno-string -mupdate -mno-update @gol
425 -mfused-madd -mno-fused-madd -mbit-align -mno-bit-align @gol
426 -mstrict-align -mno-strict-align -mrelocatable @gol
427 -mno-relocatable -mrelocatable-lib -mno-relocatable-lib @gol
428 -mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian @gol
429 -mdynamic-no-pic @gol
430 -mprioritize-restricted-insns=@var{priority} @gol
431 -msched-costly-dep=@var{dependence_type} @gol
432 -minsert-sched-nops=@var{scheme} @gol
433 -mcall-sysv -mcall-netbsd @gol
434 -maix-struct-return -msvr4-struct-return @gol
435 -mabi=altivec -mabi=no-altivec @gol
436 -mabi=spe -mabi=no-spe @gol
437 -misel=yes -misel=no @gol
438 -mspe=yes -mspe=no @gol
439 -mfloat-gprs=yes -mfloat-gprs=no @gol
440 -mprototype -mno-prototype @gol
441 -msim -mmvme -mads -myellowknife -memb -msdata @gol
442 -msdata=@var{opt} -mvxworks -mwindiss -G @var{num} -pthread}
444 @emph{Darwin Options}
445 @gccoptlist{-all_load -allowable_client -arch -arch_errors_fatal @gol
446 -arch_only -bind_at_load -bundle -bundle_loader @gol
447 -client_name -compatibility_version -current_version @gol
448 -dependency-file -dylib_file -dylinker_install_name @gol
449 -dynamic -dynamiclib -exported_symbols_list @gol
450 -filelist -flat_namespace -force_cpusubtype_ALL @gol
451 -force_flat_namespace -headerpad_max_install_names @gol
452 -image_base -init -install_name -keep_private_externs @gol
453 -multi_module -multiply_defined -multiply_defined_unused @gol
454 -noall_load -nofixprebinding -nomultidefs -noprebind -noseglinkedit @gol
455 -pagezero_size -prebind -prebind_all_twolevel_modules @gol
456 -private_bundle -read_only_relocs -sectalign @gol
457 -sectobjectsymbols -whyload -seg1addr @gol
458 -sectcreate -sectobjectsymbols -sectorder @gol
459 -seg_addr_table -seg_addr_table_filename -seglinkedit @gol
460 -segprot -segs_read_only_addr -segs_read_write_addr @gol
461 -single_module -static -sub_library -sub_umbrella @gol
462 -twolevel_namespace -umbrella -undefined @gol
463 -unexported_symbols_list -weak_reference_mismatches @gol
467 @gccoptlist{-EL -EB -march=@var{arch} -mtune=@var{arch} @gol
468 -mips1 -mips2 -mips3 -mips4 -mips32 -mips32r2 -mips64 @gol
469 -mips16 -mno-mips16 -mabi=@var{abi} -mabicalls -mno-abicalls @gol
470 -mxgot -mno-xgot -membedded-pic -mno-embedded-pic @gol
471 -mgp32 -mgp64 -mfp32 -mfp64 -mhard-float -msoft-float @gol
472 -msingle-float -mdouble-float -mint64 -mlong64 -mlong32 @gol
473 -G@var{num} -membedded-data -mno-embedded-data @gol
474 -muninit-const-in-rodata -mno-uninit-const-in-rodata @gol
475 -msplit-addresses -mno-split-addresses @gol
476 -mexplicit-relocs -mno-explicit-relocs @gol
477 -mrnames -mno-rnames @gol
478 -mcheck-zero-division -mno-check-zero-division @gol
479 -mmemcpy -mno-memcpy -mlong-calls -mno-long-calls @gol
480 -mmad -mno-mad -mfused-madd -mno-fused-madd -nocpp @gol
481 -mfix-sb1 -mno-fix-sb1 -mflush-func=@var{func} @gol
482 -mno-flush-func -mbranch-likely -mno-branch-likely}
484 @emph{i386 and x86-64 Options}
485 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
486 -mfpmath=@var{unit} @gol
487 -masm=@var{dialect} -mno-fancy-math-387 @gol
488 -mno-fp-ret-in-387 -msoft-float -msvr3-shlib @gol
489 -mno-wide-multiply -mrtd -malign-double @gol
490 -mpreferred-stack-boundary=@var{num} @gol
491 -mmmx -msse -msse2 -mpni -m3dnow @gol
492 -mthreads -mno-align-stringops -minline-all-stringops @gol
493 -mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
494 -m96bit-long-double -mregparm=@var{num} -momit-leaf-frame-pointer @gol
495 -mno-red-zone -mno-tls-direct-seg-refs @gol
496 -mcmodel=@var{code-model} @gol
500 @gccoptlist{-march=@var{architecture-type} @gol
501 -mbig-switch -mdisable-fpregs -mdisable-indexing @gol
502 -mfast-indirect-calls -mgas -mgnu-ld -mhp-ld @gol
503 -mjump-in-delay -mlinker-opt -mlong-calls @gol
504 -mlong-load-store -mno-big-switch -mno-disable-fpregs @gol
505 -mno-disable-indexing -mno-fast-indirect-calls -mno-gas @gol
506 -mno-jump-in-delay -mno-long-load-store @gol
507 -mno-portable-runtime -mno-soft-float @gol
508 -mno-space-regs -msoft-float -mpa-risc-1-0 @gol
509 -mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime @gol
510 -mschedule=@var{cpu-type} -mspace-regs -msio -mwsio @gol
511 -nolibdld -static -threads}
513 @emph{DEC Alpha Options}
514 @gccoptlist{-mno-fp-regs -msoft-float -malpha-as -mgas @gol
515 -mieee -mieee-with-inexact -mieee-conformant @gol
516 -mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode} @gol
517 -mtrap-precision=@var{mode} -mbuild-constants @gol
518 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} @gol
519 -mbwx -mmax -mfix -mcix @gol
520 -mfloat-vax -mfloat-ieee @gol
521 -mexplicit-relocs -msmall-data -mlarge-data @gol
522 -msmall-text -mlarge-text @gol
523 -mmemory-latency=@var{time}}
525 @emph{DEC Alpha/VMS Options}
526 @gccoptlist{-mvms-return-codes}
528 @emph{H8/300 Options}
529 @gccoptlist{-mrelax -mh -ms -mn -mint32 -malign-300}
532 @gccoptlist{-m1 -m2 -m2e -m3 -m3e @gol
533 -m4-nofpu -m4-single-only -m4-single -m4 @gol
534 -m5-64media -m5-64media-nofpu @gol
535 -m5-32media -m5-32media-nofpu @gol
536 -m5-compact -m5-compact-nofpu @gol
537 -mb -ml -mdalign -mrelax @gol
538 -mbigtable -mfmovd -mhitachi -mnomacsave @gol
539 -mieee -misize -mpadstruct -mspace @gol
540 -mprefergot -musermode}
542 @emph{System V Options}
543 @gccoptlist{-Qy -Qn -YP,@var{paths} -Ym,@var{dir}}
546 @gccoptlist{-EB -EL @gol
547 -mmangle-cpu -mcpu=@var{cpu} -mtext=@var{text-section} @gol
548 -mdata=@var{data-section} -mrodata=@var{readonly-data-section}}
550 @emph{TMS320C3x/C4x Options}
551 @gccoptlist{-mcpu=@var{cpu} -mbig -msmall -mregparm -mmemparm @gol
552 -mfast-fix -mmpyi -mbk -mti -mdp-isr-reload @gol
553 -mrpts=@var{count} -mrptb -mdb -mloop-unsigned @gol
554 -mparallel-insns -mparallel-mpy -mpreserve-float}
557 @gccoptlist{-mlong-calls -mno-long-calls -mep -mno-ep @gol
558 -mprolog-function -mno-prolog-function -mspace @gol
559 -mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
560 -mapp-regs -mno-app-regs @gol
561 -mdisable-callt -mno-disable-callt @gol
567 @gccoptlist{-m32032 -m32332 -m32532 -m32081 -m32381 @gol
568 -mmult-add -mnomult-add -msoft-float -mrtd -mnortd @gol
569 -mregparam -mnoregparam -msb -mnosb @gol
570 -mbitfield -mnobitfield -mhimem -mnohimem}
573 @gccoptlist{-mmcu=@var{mcu} -msize -minit-stack=@var{n} -mno-interrupts @gol
574 -mcall-prologues -mno-tablejump -mtiny-stack}
577 @gccoptlist{-mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates @gol
578 -mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
579 -m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
580 -mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
581 -mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
584 @gccoptlist{-mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
585 -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
586 -melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
587 -mno-base-addresses -msingle-exit -mno-single-exit}
590 @gccoptlist{-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
591 -mvolatile-asm-stop -mb-step -mregister-names -mno-sdata @gol
592 -mconstant-gp -mauto-pic -minline-float-divide-min-latency @gol
593 -minline-float-divide-max-throughput @gol
594 -minline-int-divide-min-latency @gol
595 -minline-int-divide-max-throughput -mno-dwarf2-asm @gol
596 -mfixed-range=@var{register-range}}
598 @emph{S/390 and zSeries Options}
599 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
600 -mhard-float -msoft-float -mbackchain -mno-backchain @gol
601 -msmall-exec -mno-small-exec -mmvcle -mno-mvcle @gol
602 -m64 -m31 -mdebug -mno-debug -mesa -mzarch -mfused-madd -mno-fused-madd}
605 @gccoptlist{-mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
606 -mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
607 -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
608 -mstack-align -mdata-align -mconst-align @gol
609 -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
610 -melf -maout -melinux -mlinux -sim -sim2}
612 @emph{PDP-11 Options}
613 @gccoptlist{-mfpu -msoft-float -mac0 -mno-ac0 -m40 -m45 -m10 @gol
614 -mbcopy -mbcopy-builtin -mint32 -mno-int16 @gol
615 -mint16 -mno-int32 -mfloat32 -mno-float64 @gol
616 -mfloat64 -mno-float32 -mabshi -mno-abshi @gol
617 -mbranch-expensive -mbranch-cheap @gol
618 -msplit -mno-split -munix-asm -mdec-asm}
620 @emph{Xstormy16 Options}
623 @emph{Xtensa Options}
624 @gccoptlist{-mconst16 -mno-const16 @gol
625 -mfused-madd -mno-fused-madd @gol
626 -mtext-section-literals -mno-text-section-literals @gol
627 -mtarget-align -mno-target-align @gol
628 -mlongcalls -mno-longcalls}
631 @gccoptlist{-mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 @gol
632 -mhard-float -msoft-float @gol
633 -malloc-cc -mfixed-cc -mdword -mno-dword @gol
634 -mdouble -mno-double @gol
635 -mmedia -mno-media -mmuladd -mno-muladd @gol
636 -mlibrary-pic -macc-4 -macc-8 @gol
637 -mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move @gol
638 -mscc -mno-scc -mcond-exec -mno-cond-exec @gol
639 -mvliw-branch -mno-vliw-branch @gol
640 -mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec @gol
641 -mno-nested-cond-exec -mtomcat-stats @gol
644 @item Code Generation Options
645 @xref{Code Gen Options,,Options for Code Generation Conventions}.
646 @gccoptlist{-fcall-saved-@var{reg} -fcall-used-@var{reg} @gol
647 -ffixed-@var{reg} -fexceptions @gol
648 -fnon-call-exceptions -funwind-tables @gol
649 -fasynchronous-unwind-tables @gol
650 -finhibit-size-directive -finstrument-functions @gol
651 -fno-common -fno-ident @gol
652 -fpcc-struct-return -fpic -fPIC -fpie -fPIE @gol
653 -freg-struct-return -fshared-data -fshort-enums @gol
654 -fshort-double -fshort-wchar @gol
655 -fverbose-asm -fpack-struct -fstack-check @gol
656 -fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym} @gol
657 -fargument-alias -fargument-noalias @gol
658 -fargument-noalias-global -fleading-underscore @gol
659 -ftls-model=@var{model} @gol
660 -ftrapv -fwrapv -fbounds-check}
664 * Overall Options:: Controlling the kind of output:
665 an executable, object files, assembler files,
666 or preprocessed source.
667 * C Dialect Options:: Controlling the variant of C language compiled.
668 * C++ Dialect Options:: Variations on C++.
669 * Objective-C Dialect Options:: Variations on Objective-C.
670 * Language Independent Options:: Controlling how diagnostics should be
672 * Warning Options:: How picky should the compiler be?
673 * Debugging Options:: Symbol tables, measurements, and debugging dumps.
674 * Optimize Options:: How much optimization?
675 * Preprocessor Options:: Controlling header files and macro definitions.
676 Also, getting dependency information for Make.
677 * Assembler Options:: Passing options to the assembler.
678 * Link Options:: Specifying libraries and so on.
679 * Directory Options:: Where to find header files and libraries.
680 Where to find the compiler executable files.
681 * Spec Files:: How to pass switches to sub-processes.
682 * Target Options:: Running a cross-compiler, or an old version of GCC.
685 @node Overall Options
686 @section Options Controlling the Kind of Output
688 Compilation can involve up to four stages: preprocessing, compilation
689 proper, assembly and linking, always in that order. GCC is capable of
690 preprocessing and compiling several files either into several
691 assembler input files, or into one assembler input file; then each
692 assembler input file produces an object file, and linking combines all
693 the object files (those newly compiled, and those specified as input)
694 into an executable file.
696 @cindex file name suffix
697 For any given input file, the file name suffix determines what kind of
702 C source code which must be preprocessed.
705 C source code which should not be preprocessed.
708 C++ source code which should not be preprocessed.
711 Objective-C source code. Note that you must link with the library
712 @file{libobjc.a} to make an Objective-C program work.
715 Objective-C source code which should not be preprocessed.
718 C or C++ header file to be turned into a precompiled header.
722 @itemx @var{file}.cxx
723 @itemx @var{file}.cpp
724 @itemx @var{file}.CPP
725 @itemx @var{file}.c++
727 C++ source code which must be preprocessed. Note that in @samp{.cxx},
728 the last two letters must both be literally @samp{x}. Likewise,
729 @samp{.C} refers to a literal capital C@.
733 C++ header file to be turned into a precompiled header.
736 @itemx @var{file}.for
737 @itemx @var{file}.FOR
738 Fortran source code which should not be preprocessed.
741 @itemx @var{file}.fpp
742 @itemx @var{file}.FPP
743 Fortran source code which must be preprocessed (with the traditional
747 Fortran source code which must be preprocessed with a RATFOR
748 preprocessor (not included with GCC)@.
750 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
751 Using and Porting GNU Fortran}, for more details of the handling of
754 @c FIXME: Descriptions of Java file types.
761 Ada source code file which contains a library unit declaration (a
762 declaration of a package, subprogram, or generic, or a generic
763 instantiation), or a library unit renaming declaration (a package,
764 generic, or subprogram renaming declaration). Such files are also
767 @itemx @var{file}.adb
768 Ada source code file containing a library unit body (a subprogram or
769 package body). Such files are also called @dfn{bodies}.
771 @c GCC also knows about some suffixes for languages not yet included:
780 Assembler code which must be preprocessed.
783 An object file to be fed straight into linking.
784 Any file name with no recognized suffix is treated this way.
788 You can specify the input language explicitly with the @option{-x} option:
791 @item -x @var{language}
792 Specify explicitly the @var{language} for the following input files
793 (rather than letting the compiler choose a default based on the file
794 name suffix). This option applies to all following input files until
795 the next @option{-x} option. Possible values for @var{language} are:
797 c c-header cpp-output
798 c++ c++-header c++-cpp-output
799 objective-c objective-c-header objc-cpp-output
800 assembler assembler-with-cpp
802 f77 f77-cpp-input ratfor
808 Turn off any specification of a language, so that subsequent files are
809 handled according to their file name suffixes (as they are if @option{-x}
810 has not been used at all).
812 @item -pass-exit-codes
813 @opindex pass-exit-codes
814 Normally the @command{gcc} program will exit with the code of 1 if any
815 phase of the compiler returns a non-success return code. If you specify
816 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
817 numerically highest error produced by any phase that returned an error
821 If you only want some of the stages of compilation, you can use
822 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
823 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
824 @command{gcc} is to stop. Note that some combinations (for example,
825 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
830 Compile or assemble the source files, but do not link. The linking
831 stage simply is not done. The ultimate output is in the form of an
832 object file for each source file.
834 By default, the object file name for a source file is made by replacing
835 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
837 Unrecognized input files, not requiring compilation or assembly, are
842 Stop after the stage of compilation proper; do not assemble. The output
843 is in the form of an assembler code file for each non-assembler input
846 By default, the assembler file name for a source file is made by
847 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
849 Input files that don't require compilation are ignored.
853 Stop after the preprocessing stage; do not run the compiler proper. The
854 output is in the form of preprocessed source code, which is sent to the
857 Input files which don't require preprocessing are ignored.
859 @cindex output file option
862 Place output in file @var{file}. This applies regardless to whatever
863 sort of output is being produced, whether it be an executable file,
864 an object file, an assembler file or preprocessed C code.
866 If you specify @option{-o} when compiling more than one input file, or
867 you are producing an executable file as output, all the source files
868 on the command line will be compiled at once.
870 If @option{-o} is not specified, the default is to put an executable file
871 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
872 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
873 all preprocessed C source on standard output.
877 Print (on standard error output) the commands executed to run the stages
878 of compilation. Also print the version number of the compiler driver
879 program and of the preprocessor and the compiler proper.
883 Like @option{-v} except the commands are not executed and all command
884 arguments are quoted. This is useful for shell scripts to capture the
885 driver-generated command lines.
889 Use pipes rather than temporary files for communication between the
890 various stages of compilation. This fails to work on some systems where
891 the assembler is unable to read from a pipe; but the GNU assembler has
896 Print (on the standard output) a description of the command line options
897 understood by @command{gcc}. If the @option{-v} option is also specified
898 then @option{--help} will also be passed on to the various processes
899 invoked by @command{gcc}, so that they can display the command line options
900 they accept. If the @option{-Wextra} option is also specified then command
901 line options which have no documentation associated with them will also
906 Print (on the standard output) a description of target specific command
907 line options for each tool.
911 Display the version number and copyrights of the invoked GCC.
915 @section Compiling C++ Programs
917 @cindex suffixes for C++ source
918 @cindex C++ source file suffixes
919 C++ source files conventionally use one of the suffixes @samp{.C},
920 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
921 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
922 preprocessed C++ files use the suffix @samp{.ii}. GCC recognizes
923 files with these names and compiles them as C++ programs even if you
924 call the compiler the same way as for compiling C programs (usually
925 with the name @command{gcc}).
929 However, C++ programs often require class libraries as well as a
930 compiler that understands the C++ language---and under some
931 circumstances, you might want to compile programs or header files from
932 standard input, or otherwise without a suffix that flags them as C++
933 programs. You might also like to precompile a C header file with a
934 @samp{.h} extension to be used in C++ compilations. @command{g++} is a
935 program that calls GCC with the default language set to C++, and
936 automatically specifies linking against the C++ library. On many
937 systems, @command{g++} is also installed with the name @command{c++}.
939 @cindex invoking @command{g++}
940 When you compile C++ programs, you may specify many of the same
941 command-line options that you use for compiling programs in any
942 language; or command-line options meaningful for C and related
943 languages; or options that are meaningful only for C++ programs.
944 @xref{C Dialect Options,,Options Controlling C Dialect}, for
945 explanations of options for languages related to C@.
946 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
947 explanations of options that are meaningful only for C++ programs.
949 @node C Dialect Options
950 @section Options Controlling C Dialect
951 @cindex dialect options
952 @cindex language dialect options
953 @cindex options, dialect
955 The following options control the dialect of C (or languages derived
956 from C, such as C++ and Objective-C) that the compiler accepts:
963 In C mode, support all ISO C90 programs. In C++ mode,
964 remove GNU extensions that conflict with ISO C++.
966 This turns off certain features of GCC that are incompatible with ISO
967 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
968 such as the @code{asm} and @code{typeof} keywords, and
969 predefined macros such as @code{unix} and @code{vax} that identify the
970 type of system you are using. It also enables the undesirable and
971 rarely used ISO trigraph feature. For the C compiler,
972 it disables recognition of C++ style @samp{//} comments as well as
973 the @code{inline} keyword.
975 The alternate keywords @code{__asm__}, @code{__extension__},
976 @code{__inline__} and @code{__typeof__} continue to work despite
977 @option{-ansi}. You would not want to use them in an ISO C program, of
978 course, but it is useful to put them in header files that might be included
979 in compilations done with @option{-ansi}. Alternate predefined macros
980 such as @code{__unix__} and @code{__vax__} are also available, with or
981 without @option{-ansi}.
983 The @option{-ansi} option does not cause non-ISO programs to be
984 rejected gratuitously. For that, @option{-pedantic} is required in
985 addition to @option{-ansi}. @xref{Warning Options}.
987 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
988 option is used. Some header files may notice this macro and refrain
989 from declaring certain functions or defining certain macros that the
990 ISO standard doesn't call for; this is to avoid interfering with any
991 programs that might use these names for other things.
993 Functions which would normally be built in but do not have semantics
994 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
995 functions with @option{-ansi} is used. @xref{Other Builtins,,Other
996 built-in functions provided by GCC}, for details of the functions
1001 Determine the language standard. This option is currently only
1002 supported when compiling C or C++. A value for this option must be
1003 provided; possible values are
1008 ISO C90 (same as @option{-ansi}).
1010 @item iso9899:199409
1011 ISO C90 as modified in amendment 1.
1017 ISO C99. Note that this standard is not yet fully supported; see
1018 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information. The
1019 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1022 Default, ISO C90 plus GNU extensions (including some C99 features).
1026 ISO C99 plus GNU extensions. When ISO C99 is fully implemented in GCC,
1027 this will become the default. The name @samp{gnu9x} is deprecated.
1030 The 1998 ISO C++ standard plus amendments.
1033 The same as @option{-std=c++98} plus GNU extensions. This is the
1034 default for C++ code.
1037 Even when this option is not specified, you can still use some of the
1038 features of newer standards in so far as they do not conflict with
1039 previous C standards. For example, you may use @code{__restrict__} even
1040 when @option{-std=c99} is not specified.
1042 The @option{-std} options specifying some version of ISO C have the same
1043 effects as @option{-ansi}, except that features that were not in ISO C90
1044 but are in the specified version (for example, @samp{//} comments and
1045 the @code{inline} keyword in ISO C99) are not disabled.
1047 @xref{Standards,,Language Standards Supported by GCC}, for details of
1048 these standard versions.
1050 @item -aux-info @var{filename}
1052 Output to the given filename prototyped declarations for all functions
1053 declared and/or defined in a translation unit, including those in header
1054 files. This option is silently ignored in any language other than C@.
1056 Besides declarations, the file indicates, in comments, the origin of
1057 each declaration (source file and line), whether the declaration was
1058 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1059 @samp{O} for old, respectively, in the first character after the line
1060 number and the colon), and whether it came from a declaration or a
1061 definition (@samp{C} or @samp{F}, respectively, in the following
1062 character). In the case of function definitions, a K&R-style list of
1063 arguments followed by their declarations is also provided, inside
1064 comments, after the declaration.
1068 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1069 keyword, so that code can use these words as identifiers. You can use
1070 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1071 instead. @option{-ansi} implies @option{-fno-asm}.
1073 In C++, this switch only affects the @code{typeof} keyword, since
1074 @code{asm} and @code{inline} are standard keywords. You may want to
1075 use the @option{-fno-gnu-keywords} flag instead, which has the same
1076 effect. In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1077 switch only affects the @code{asm} and @code{typeof} keywords, since
1078 @code{inline} is a standard keyword in ISO C99.
1081 @itemx -fno-builtin-@var{function}
1082 @opindex fno-builtin
1083 @cindex built-in functions
1084 Don't recognize built-in functions that do not begin with
1085 @samp{__builtin_} as prefix. @xref{Other Builtins,,Other built-in
1086 functions provided by GCC}, for details of the functions affected,
1087 including those which are not built-in functions when @option{-ansi} or
1088 @option{-std} options for strict ISO C conformance are used because they
1089 do not have an ISO standard meaning.
1091 GCC normally generates special code to handle certain built-in functions
1092 more efficiently; for instance, calls to @code{alloca} may become single
1093 instructions that adjust the stack directly, and calls to @code{memcpy}
1094 may become inline copy loops. The resulting code is often both smaller
1095 and faster, but since the function calls no longer appear as such, you
1096 cannot set a breakpoint on those calls, nor can you change the behavior
1097 of the functions by linking with a different library.
1099 With the @option{-fno-builtin-@var{function}} option
1100 only the built-in function @var{function} is
1101 disabled. @var{function} must not begin with @samp{__builtin_}. If a
1102 function is named this is not built-in in this version of GCC, this
1103 option is ignored. There is no corresponding
1104 @option{-fbuiltin-@var{function}} option; if you wish to enable
1105 built-in functions selectively when using @option{-fno-builtin} or
1106 @option{-ffreestanding}, you may define macros such as:
1109 #define abs(n) __builtin_abs ((n))
1110 #define strcpy(d, s) __builtin_strcpy ((d), (s))
1115 @cindex hosted environment
1117 Assert that compilation takes place in a hosted environment. This implies
1118 @option{-fbuiltin}. A hosted environment is one in which the
1119 entire standard library is available, and in which @code{main} has a return
1120 type of @code{int}. Examples are nearly everything except a kernel.
1121 This is equivalent to @option{-fno-freestanding}.
1123 @item -ffreestanding
1124 @opindex ffreestanding
1125 @cindex hosted environment
1127 Assert that compilation takes place in a freestanding environment. This
1128 implies @option{-fno-builtin}. A freestanding environment
1129 is one in which the standard library may not exist, and program startup may
1130 not necessarily be at @code{main}. The most obvious example is an OS kernel.
1131 This is equivalent to @option{-fno-hosted}.
1133 @xref{Standards,,Language Standards Supported by GCC}, for details of
1134 freestanding and hosted environments.
1136 @item -fms-extensions
1137 @opindex fms-extensions
1138 Accept some non-standard constructs used in Microsoft header files.
1142 Support ISO C trigraphs. The @option{-ansi} option (and @option{-std}
1143 options for strict ISO C conformance) implies @option{-trigraphs}.
1145 @item -no-integrated-cpp
1146 @opindex no-integrated-cpp
1147 Performs a compilation in two passes: preprocessing and compiling. This
1148 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1149 @option{-B} option. The user supplied compilation step can then add in
1150 an additional preprocessing step after normal preprocessing but before
1151 compiling. The default is to use the integrated cpp (internal cpp)
1153 The semantics of this option will change if "cc1", "cc1plus", and
1154 "cc1obj" are merged.
1156 @cindex traditional C language
1157 @cindex C language, traditional
1159 @itemx -traditional-cpp
1160 @opindex traditional-cpp
1161 @opindex traditional
1162 Formerly, these options caused GCC to attempt to emulate a pre-standard
1163 C compiler. They are now only supported with the @option{-E} switch.
1164 The preprocessor continues to support a pre-standard mode. See the GNU
1165 CPP manual for details.
1167 @item -fcond-mismatch
1168 @opindex fcond-mismatch
1169 Allow conditional expressions with mismatched types in the second and
1170 third arguments. The value of such an expression is void. This option
1171 is not supported for C++.
1173 @item -funsigned-char
1174 @opindex funsigned-char
1175 Let the type @code{char} be unsigned, like @code{unsigned char}.
1177 Each kind of machine has a default for what @code{char} should
1178 be. It is either like @code{unsigned char} by default or like
1179 @code{signed char} by default.
1181 Ideally, a portable program should always use @code{signed char} or
1182 @code{unsigned char} when it depends on the signedness of an object.
1183 But many programs have been written to use plain @code{char} and
1184 expect it to be signed, or expect it to be unsigned, depending on the
1185 machines they were written for. This option, and its inverse, let you
1186 make such a program work with the opposite default.
1188 The type @code{char} is always a distinct type from each of
1189 @code{signed char} or @code{unsigned char}, even though its behavior
1190 is always just like one of those two.
1193 @opindex fsigned-char
1194 Let the type @code{char} be signed, like @code{signed char}.
1196 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1197 the negative form of @option{-funsigned-char}. Likewise, the option
1198 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1200 @item -fsigned-bitfields
1201 @itemx -funsigned-bitfields
1202 @itemx -fno-signed-bitfields
1203 @itemx -fno-unsigned-bitfields
1204 @opindex fsigned-bitfields
1205 @opindex funsigned-bitfields
1206 @opindex fno-signed-bitfields
1207 @opindex fno-unsigned-bitfields
1208 These options control whether a bit-field is signed or unsigned, when the
1209 declaration does not use either @code{signed} or @code{unsigned}. By
1210 default, such a bit-field is signed, because this is consistent: the
1211 basic integer types such as @code{int} are signed types.
1213 @item -fwritable-strings
1214 @opindex fwritable-strings
1215 Store string constants in the writable data segment and don't uniquize
1216 them. This is for compatibility with old programs which assume they can
1217 write into string constants.
1219 Writing into string constants is a very bad idea; ``constants'' should
1222 This option is deprecated.
1225 @node C++ Dialect Options
1226 @section Options Controlling C++ Dialect
1228 @cindex compiler options, C++
1229 @cindex C++ options, command line
1230 @cindex options, C++
1231 This section describes the command-line options that are only meaningful
1232 for C++ programs; but you can also use most of the GNU compiler options
1233 regardless of what language your program is in. For example, you
1234 might compile a file @code{firstClass.C} like this:
1237 g++ -g -frepo -O -c firstClass.C
1241 In this example, only @option{-frepo} is an option meant
1242 only for C++ programs; you can use the other options with any
1243 language supported by GCC@.
1245 Here is a list of options that are @emph{only} for compiling C++ programs:
1249 @item -fabi-version=@var{n}
1250 @opindex fabi-version
1251 Use version @var{n} of the C++ ABI. Version 2 is the version of the
1252 C++ ABI that first appeared in G++ 3.4. Version 1 is the version of
1253 the C++ ABI that first appeared in G++ 3.2. Version 0 will always be
1254 the version that conforms most closely to the C++ ABI specification.
1255 Therefore, the ABI obtained using version 0 will change as ABI bugs
1258 The default is version 2.
1260 @item -fno-access-control
1261 @opindex fno-access-control
1262 Turn off all access checking. This switch is mainly useful for working
1263 around bugs in the access control code.
1267 Check that the pointer returned by @code{operator new} is non-null
1268 before attempting to modify the storage allocated. This check is
1269 normally unnecessary because the C++ standard specifies that
1270 @code{operator new} will only return @code{0} if it is declared
1271 @samp{throw()}, in which case the compiler will always check the
1272 return value even without this option. In all other cases, when
1273 @code{operator new} has a non-empty exception specification, memory
1274 exhaustion is signalled by throwing @code{std::bad_alloc}. See also
1275 @samp{new (nothrow)}.
1277 @item -fconserve-space
1278 @opindex fconserve-space
1279 Put uninitialized or runtime-initialized global variables into the
1280 common segment, as C does. This saves space in the executable at the
1281 cost of not diagnosing duplicate definitions. If you compile with this
1282 flag and your program mysteriously crashes after @code{main()} has
1283 completed, you may have an object that is being destroyed twice because
1284 two definitions were merged.
1286 This option is no longer useful on most targets, now that support has
1287 been added for putting variables into BSS without making them common.
1289 @item -fno-const-strings
1290 @opindex fno-const-strings
1291 Give string constants type @code{char *} instead of type @code{const
1292 char *}. By default, G++ uses type @code{const char *} as required by
1293 the standard. Even if you use @option{-fno-const-strings}, you cannot
1294 actually modify the value of a string constant, unless you also use
1295 @option{-fwritable-strings}.
1297 This option might be removed in a future release of G++. For maximum
1298 portability, you should structure your code so that it works with
1299 string constants that have type @code{const char *}.
1301 @item -fno-elide-constructors
1302 @opindex fno-elide-constructors
1303 The C++ standard allows an implementation to omit creating a temporary
1304 which is only used to initialize another object of the same type.
1305 Specifying this option disables that optimization, and forces G++ to
1306 call the copy constructor in all cases.
1308 @item -fno-enforce-eh-specs
1309 @opindex fno-enforce-eh-specs
1310 Don't check for violation of exception specifications at runtime. This
1311 option violates the C++ standard, but may be useful for reducing code
1312 size in production builds, much like defining @samp{NDEBUG}. The compiler
1313 will still optimize based on the exception specifications.
1316 @itemx -fno-for-scope
1318 @opindex fno-for-scope
1319 If @option{-ffor-scope} is specified, the scope of variables declared in
1320 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1321 as specified by the C++ standard.
1322 If @option{-fno-for-scope} is specified, the scope of variables declared in
1323 a @i{for-init-statement} extends to the end of the enclosing scope,
1324 as was the case in old versions of G++, and other (traditional)
1325 implementations of C++.
1327 The default if neither flag is given to follow the standard,
1328 but to allow and give a warning for old-style code that would
1329 otherwise be invalid, or have different behavior.
1331 @item -fno-gnu-keywords
1332 @opindex fno-gnu-keywords
1333 Do not recognize @code{typeof} as a keyword, so that code can use this
1334 word as an identifier. You can use the keyword @code{__typeof__} instead.
1335 @option{-ansi} implies @option{-fno-gnu-keywords}.
1337 @item -fno-implicit-templates
1338 @opindex fno-implicit-templates
1339 Never emit code for non-inline templates which are instantiated
1340 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1341 @xref{Template Instantiation}, for more information.
1343 @item -fno-implicit-inline-templates
1344 @opindex fno-implicit-inline-templates
1345 Don't emit code for implicit instantiations of inline templates, either.
1346 The default is to handle inlines differently so that compiles with and
1347 without optimization will need the same set of explicit instantiations.
1349 @item -fno-implement-inlines
1350 @opindex fno-implement-inlines
1351 To save space, do not emit out-of-line copies of inline functions
1352 controlled by @samp{#pragma implementation}. This will cause linker
1353 errors if these functions are not inlined everywhere they are called.
1355 @item -fms-extensions
1356 @opindex fms-extensions
1357 Disable pedantic warnings about constructs used in MFC, such as implicit
1358 int and getting a pointer to member function via non-standard syntax.
1360 @item -fno-nonansi-builtins
1361 @opindex fno-nonansi-builtins
1362 Disable built-in declarations of functions that are not mandated by
1363 ANSI/ISO C@. These include @code{ffs}, @code{alloca}, @code{_exit},
1364 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1366 @item -fno-operator-names
1367 @opindex fno-operator-names
1368 Do not treat the operator name keywords @code{and}, @code{bitand},
1369 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1370 synonyms as keywords.
1372 @item -fno-optional-diags
1373 @opindex fno-optional-diags
1374 Disable diagnostics that the standard says a compiler does not need to
1375 issue. Currently, the only such diagnostic issued by G++ is the one for
1376 a name having multiple meanings within a class.
1379 @opindex fpermissive
1380 Downgrade some diagnostics about nonconformant code from errors to
1381 warnings. Thus, using @option{-fpermissive} will allow some
1382 nonconforming code to compile.
1386 Enable automatic template instantiation at link time. This option also
1387 implies @option{-fno-implicit-templates}. @xref{Template
1388 Instantiation}, for more information.
1392 Disable generation of information about every class with virtual
1393 functions for use by the C++ runtime type identification features
1394 (@samp{dynamic_cast} and @samp{typeid}). If you don't use those parts
1395 of the language, you can save some space by using this flag. Note that
1396 exception handling uses the same information, but it will generate it as
1401 Emit statistics about front-end processing at the end of the compilation.
1402 This information is generally only useful to the G++ development team.
1404 @item -ftemplate-depth-@var{n}
1405 @opindex ftemplate-depth
1406 Set the maximum instantiation depth for template classes to @var{n}.
1407 A limit on the template instantiation depth is needed to detect
1408 endless recursions during template class instantiation. ANSI/ISO C++
1409 conforming programs must not rely on a maximum depth greater than 17.
1411 @item -fuse-cxa-atexit
1412 @opindex fuse-cxa-atexit
1413 Register destructors for objects with static storage duration with the
1414 @code{__cxa_atexit} function rather than the @code{atexit} function.
1415 This option is required for fully standards-compliant handling of static
1416 destructors, but will only work if your C library supports
1417 @code{__cxa_atexit}.
1421 Do not use weak symbol support, even if it is provided by the linker.
1422 By default, G++ will use weak symbols if they are available. This
1423 option exists only for testing, and should not be used by end-users;
1424 it will result in inferior code and has no benefits. This option may
1425 be removed in a future release of G++.
1429 Do not search for header files in the standard directories specific to
1430 C++, but do still search the other standard directories. (This option
1431 is used when building the C++ library.)
1434 In addition, these optimization, warning, and code generation options
1435 have meanings only for C++ programs:
1438 @item -fno-default-inline
1439 @opindex fno-default-inline
1440 Do not assume @samp{inline} for functions defined inside a class scope.
1441 @xref{Optimize Options,,Options That Control Optimization}. Note that these
1442 functions will have linkage like inline functions; they just won't be
1445 @item -Wabi @r{(C++ only)}
1447 Warn when G++ generates code that is probably not compatible with the
1448 vendor-neutral C++ ABI. Although an effort has been made to warn about
1449 all such cases, there are probably some cases that are not warned about,
1450 even though G++ is generating incompatible code. There may also be
1451 cases where warnings are emitted even though the code that is generated
1454 You should rewrite your code to avoid these warnings if you are
1455 concerned about the fact that code generated by G++ may not be binary
1456 compatible with code generated by other compilers.
1458 The known incompatibilities at this point include:
1463 Incorrect handling of tail-padding for bit-fields. G++ may attempt to
1464 pack data into the same byte as a base class. For example:
1467 struct A @{ virtual void f(); int f1 : 1; @};
1468 struct B : public A @{ int f2 : 1; @};
1472 In this case, G++ will place @code{B::f2} into the same byte
1473 as@code{A::f1}; other compilers will not. You can avoid this problem
1474 by explicitly padding @code{A} so that its size is a multiple of the
1475 byte size on your platform; that will cause G++ and other compilers to
1476 layout @code{B} identically.
1479 Incorrect handling of tail-padding for virtual bases. G++ does not use
1480 tail padding when laying out virtual bases. For example:
1483 struct A @{ virtual void f(); char c1; @};
1484 struct B @{ B(); char c2; @};
1485 struct C : public A, public virtual B @{@};
1489 In this case, G++ will not place @code{B} into the tail-padding for
1490 @code{A}; other compilers will. You can avoid this problem by
1491 explicitly padding @code{A} so that its size is a multiple of its
1492 alignment (ignoring virtual base classes); that will cause G++ and other
1493 compilers to layout @code{C} identically.
1496 Incorrect handling of bit-fields with declared widths greater than that
1497 of their underlying types, when the bit-fields appear in a union. For
1501 union U @{ int i : 4096; @};
1505 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1506 union too small by the number of bits in an @code{int}.
1509 Empty classes can be placed at incorrect offsets. For example:
1519 struct C : public B, public A @{@};
1523 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1524 it should be placed at offset zero. G++ mistakenly believes that the
1525 @code{A} data member of @code{B} is already at offset zero.
1528 Names of template functions whose types involve @code{typename} or
1529 template template parameters can be mangled incorrectly.
1532 template <typename Q>
1533 void f(typename Q::X) @{@}
1535 template <template <typename> class Q>
1536 void f(typename Q<int>::X) @{@}
1540 Instantiations of these templates may be mangled incorrectly.
1544 @item -Wctor-dtor-privacy @r{(C++ only)}
1545 @opindex Wctor-dtor-privacy
1546 Warn when a class seems unusable because all the constructors or
1547 destructors in that class are private, and it has neither friends nor
1548 public static member functions.
1550 @item -Wnon-virtual-dtor @r{(C++ only)}
1551 @opindex Wnon-virtual-dtor
1552 Warn when a class appears to be polymorphic, thereby requiring a virtual
1553 destructor, yet it declares a non-virtual one.
1554 This warning is enabled by @option{-Wall}.
1556 @item -Wreorder @r{(C++ only)}
1558 @cindex reordering, warning
1559 @cindex warning for reordering of member initializers
1560 Warn when the order of member initializers given in the code does not
1561 match the order in which they must be executed. For instance:
1567 A(): j (0), i (1) @{ @}
1571 The compiler will rearrange the member initializers for @samp{i}
1572 and @samp{j} to match the declaration order of the members, emitting
1573 a warning to that effect. This warning is enabled by @option{-Wall}.
1576 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1579 @item -Weffc++ @r{(C++ only)}
1581 Warn about violations of the following style guidelines from Scott Meyers'
1582 @cite{Effective C++} book:
1586 Item 11: Define a copy constructor and an assignment operator for classes
1587 with dynamically allocated memory.
1590 Item 12: Prefer initialization to assignment in constructors.
1593 Item 14: Make destructors virtual in base classes.
1596 Item 15: Have @code{operator=} return a reference to @code{*this}.
1599 Item 23: Don't try to return a reference when you must return an object.
1603 Also warn about violations of the following style guidelines from
1604 Scott Meyers' @cite{More Effective C++} book:
1608 Item 6: Distinguish between prefix and postfix forms of increment and
1609 decrement operators.
1612 Item 7: Never overload @code{&&}, @code{||}, or @code{,}.
1616 When selecting this option, be aware that the standard library
1617 headers do not obey all of these guidelines; use @samp{grep -v}
1618 to filter out those warnings.
1620 @item -Wno-deprecated @r{(C++ only)}
1621 @opindex Wno-deprecated
1622 Do not warn about usage of deprecated features. @xref{Deprecated Features}.
1624 @item -Wno-non-template-friend @r{(C++ only)}
1625 @opindex Wno-non-template-friend
1626 Disable warnings when non-templatized friend functions are declared
1627 within a template. Since the advent of explicit template specification
1628 support in G++, if the name of the friend is an unqualified-id (i.e.,
1629 @samp{friend foo(int)}), the C++ language specification demands that the
1630 friend declare or define an ordinary, nontemplate function. (Section
1631 14.5.3). Before G++ implemented explicit specification, unqualified-ids
1632 could be interpreted as a particular specialization of a templatized
1633 function. Because this non-conforming behavior is no longer the default
1634 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1635 check existing code for potential trouble spots and is on by default.
1636 This new compiler behavior can be turned off with
1637 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1638 but disables the helpful warning.
1640 @item -Wold-style-cast @r{(C++ only)}
1641 @opindex Wold-style-cast
1642 Warn if an old-style (C-style) cast to a non-void type is used within
1643 a C++ program. The new-style casts (@samp{static_cast},
1644 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1645 unintended effects and much easier to search for.
1647 @item -Woverloaded-virtual @r{(C++ only)}
1648 @opindex Woverloaded-virtual
1649 @cindex overloaded virtual fn, warning
1650 @cindex warning for overloaded virtual fn
1651 Warn when a function declaration hides virtual functions from a
1652 base class. For example, in:
1659 struct B: public A @{
1664 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1672 will fail to compile.
1674 @item -Wno-pmf-conversions @r{(C++ only)}
1675 @opindex Wno-pmf-conversions
1676 Disable the diagnostic for converting a bound pointer to member function
1679 @item -Wsign-promo @r{(C++ only)}
1680 @opindex Wsign-promo
1681 Warn when overload resolution chooses a promotion from unsigned or
1682 enumeral type to a signed type, over a conversion to an unsigned type of
1683 the same size. Previous versions of G++ would try to preserve
1684 unsignedness, but the standard mandates the current behavior.
1686 @item -Wsynth @r{(C++ only)}
1688 @cindex warning for synthesized methods
1689 @cindex synthesized methods, warning
1690 Warn when G++'s synthesis behavior does not match that of cfront. For
1696 A& operator = (int);
1706 In this example, G++ will synthesize a default @samp{A& operator =
1707 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1710 @node Objective-C Dialect Options
1711 @section Options Controlling Objective-C Dialect
1713 @cindex compiler options, Objective-C
1714 @cindex Objective-C options, command line
1715 @cindex options, Objective-C
1716 (NOTE: This manual does not describe the Objective-C language itself. See
1717 @w{@uref{http://gcc.gnu.org/readings.html}} for references.)
1719 This section describes the command-line options that are only meaningful
1720 for Objective-C programs, but you can also use most of the GNU compiler
1721 options regardless of what language your program is in. For example,
1722 you might compile a file @code{some_class.m} like this:
1725 gcc -g -fgnu-runtime -O -c some_class.m
1729 In this example, @option{-fgnu-runtime} is an option meant only for
1730 Objective-C programs; you can use the other options with any language
1733 Here is a list of options that are @emph{only} for compiling Objective-C
1737 @item -fconstant-string-class=@var{class-name}
1738 @opindex fconstant-string-class
1739 Use @var{class-name} as the name of the class to instantiate for each
1740 literal string specified with the syntax @code{@@"@dots{}"}. The default
1741 class name is @code{NXConstantString} if the GNU runtime is being used, and
1742 @code{NSConstantString} if the NeXT runtime is being used (see below). The
1743 @option{-fconstant-cfstrings} option, if also present, will override the
1744 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1745 to be laid out as constant CoreFoundation strings.
1748 @opindex fgnu-runtime
1749 Generate object code compatible with the standard GNU Objective-C
1750 runtime. This is the default for most types of systems.
1752 @item -fnext-runtime
1753 @opindex fnext-runtime
1754 Generate output compatible with the NeXT runtime. This is the default
1755 for NeXT-based systems, including Darwin and Mac OS X@. The macro
1756 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1759 @item -fno-nil-receivers
1760 @opindex -fno-nil-receivers
1761 Assume that all Objective-C message dispatches (e.g.,
1762 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1763 is not @code{nil}. This allows for more efficient entry points in the runtime to be
1764 used. Currently, this option is only available in conjunction with
1765 the NeXT runtime on Mac OS X 10.3 and later.
1767 @item -fobjc-exceptions
1768 @opindex -fobjc-exceptions
1769 Enable syntactic support for structured exception handling in Objective-C,
1770 similar to what is offered by C++ and Java. Currently, this option is only
1771 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1779 @@catch (AnObjCClass *exc) @{
1786 @@catch (AnotherClass *exc) @{
1789 @@catch (id allOthers) @{
1799 The @code{@@throw} statement may appear anywhere in an Objective-C or
1800 Objective-C++ program; when used inside of a @code{@@catch} block, the
1801 @code{@@throw} may appear without an argument (as shown above), in which case
1802 the object caught by the @code{@@catch} will be rethrown.
1804 Note that only (pointers to) Objective-C objects may be thrown and
1805 caught using this scheme. When an object is thrown, it will be caught
1806 by the nearest @code{@@catch} clause capable of handling objects of that type,
1807 analogously to how @code{catch} blocks work in C++ and Java. A
1808 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1809 any and all Objective-C exceptions not caught by previous @code{@@catch}
1812 The @code{@@finally} clause, if present, will be executed upon exit from the
1813 immediately preceding @code{@@try @dots{} @@catch} section. This will happen
1814 regardless of whether any exceptions are thrown, caught or rethrown
1815 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1816 of the @code{finally} clause in Java.
1818 There are several caveats to using the new exception mechanism:
1822 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1823 idioms provided by the @code{NSException} class, the new
1824 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1825 systems, due to additional functionality needed in the (NeXT) Objective-C
1829 As mentioned above, the new exceptions do not support handling
1830 types other than Objective-C objects. Furthermore, when used from
1831 Objective-C++, the Objective-C exception model does not interoperate with C++
1832 exceptions at this time. This means you cannot @code{@@throw} an exception
1833 from Objective-C and @code{catch} it in C++, or vice versa
1834 (i.e., @code{throw @dots{} @@catch}).
1837 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1838 blocks for thread-safe execution:
1841 @@synchronized (ObjCClass *guard) @{
1846 Upon entering the @code{@@synchronized} block, a thread of execution shall
1847 first check whether a lock has been placed on the corresponding @code{guard}
1848 object by another thread. If it has, the current thread shall wait until
1849 the other thread relinquishes its lock. Once @code{guard} becomes available,
1850 the current thread will place its own lock on it, execute the code contained in
1851 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1852 making @code{guard} available to other threads).
1854 Unlike Java, Objective-C does not allow for entire methods to be marked
1855 @code{@@synchronized}. Note that throwing exceptions out of
1856 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1857 to be unlocked properly.
1859 @item -freplace-objc-classes
1860 @opindex -freplace-objc-classes
1861 Emit a special marker instructing @command{ld(1)} not to statically link in
1862 the resulting object file, and allow @command{dyld(1)} to load it in at
1863 run time instead. This is used in conjunction with the Fix-and-Continue
1864 debugging mode, where the object file in question may be recompiled and
1865 dynamically reloaded in the course of program execution, without the need
1866 to restart the program itself. Currently, Fix-and-Continue functionality
1867 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1871 @opindex -fzero-link
1872 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1873 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1874 compile time) with static class references that get initialized at load time,
1875 which improves run-time performance. Specifying the @option{-fzero-link} flag
1876 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1877 to be retained. This is useful in Zero-Link debugging mode, since it allows
1878 for individual class implementations to be modified during program execution.
1882 Dump interface declarations for all classes seen in the source file to a
1883 file named @file{@var{sourcename}.decl}.
1886 @opindex Wno-protocol
1887 If a class is declared to implement a protocol, a warning is issued for
1888 every method in the protocol that is not implemented by the class. The
1889 default behavior is to issue a warning for every method not explicitly
1890 implemented in the class, even if a method implementation is inherited
1891 from the superclass. If you use the @code{-Wno-protocol} option, then
1892 methods inherited from the superclass are considered to be implemented,
1893 and no warning is issued for them.
1897 Warn if multiple methods of different types for the same selector are
1898 found during compilation. The check is performed on the list of methods
1899 in the final stage of compilation. Additionally, a check is performed
1900 for each selector appearing in a @code{@@selector(@dots{})}
1901 expression, and a corresponding method for that selector has been found
1902 during compilation. Because these checks scan the method table only at
1903 the end of compilation, these warnings are not produced if the final
1904 stage of compilation is not reached, for example because an error is
1905 found during compilation, or because the @code{-fsyntax-only} option is
1908 @item -Wundeclared-selector
1909 @opindex Wundeclared-selector
1910 Warn if a @code{@@selector(@dots{})} expression referring to an
1911 undeclared selector is found. A selector is considered undeclared if no
1912 method with that name has been declared before the
1913 @code{@@selector(@dots{})} expression, either explicitly in an
1914 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
1915 an @code{@@implementation} section. This option always performs its
1916 checks as soon as a @code{@@selector(@dots{})} expression is found,
1917 while @code{-Wselector} only performs its checks in the final stage of
1918 compilation. This also enforces the coding style convention
1919 that methods and selectors must be declared before being used.
1921 @item -print-objc-runtime-info
1922 @opindex -print-objc-runtime-info
1923 Generate C header describing the largest structure that is passed by
1928 @node Language Independent Options
1929 @section Options to Control Diagnostic Messages Formatting
1930 @cindex options to control diagnostics formatting
1931 @cindex diagnostic messages
1932 @cindex message formatting
1934 Traditionally, diagnostic messages have been formatted irrespective of
1935 the output device's aspect (e.g.@: its width, @dots{}). The options described
1936 below can be used to control the diagnostic messages formatting
1937 algorithm, e.g.@: how many characters per line, how often source location
1938 information should be reported. Right now, only the C++ front end can
1939 honor these options. However it is expected, in the near future, that
1940 the remaining front ends would be able to digest them correctly.
1943 @item -fmessage-length=@var{n}
1944 @opindex fmessage-length
1945 Try to format error messages so that they fit on lines of about @var{n}
1946 characters. The default is 72 characters for @command{g++} and 0 for the rest of
1947 the front ends supported by GCC@. If @var{n} is zero, then no
1948 line-wrapping will be done; each error message will appear on a single
1951 @opindex fdiagnostics-show-location
1952 @item -fdiagnostics-show-location=once
1953 Only meaningful in line-wrapping mode. Instructs the diagnostic messages
1954 reporter to emit @emph{once} source location information; that is, in
1955 case the message is too long to fit on a single physical line and has to
1956 be wrapped, the source location won't be emitted (as prefix) again,
1957 over and over, in subsequent continuation lines. This is the default
1960 @item -fdiagnostics-show-location=every-line
1961 Only meaningful in line-wrapping mode. Instructs the diagnostic
1962 messages reporter to emit the same source location information (as
1963 prefix) for physical lines that result from the process of breaking
1964 a message which is too long to fit on a single line.
1968 @node Warning Options
1969 @section Options to Request or Suppress Warnings
1970 @cindex options to control warnings
1971 @cindex warning messages
1972 @cindex messages, warning
1973 @cindex suppressing warnings
1975 Warnings are diagnostic messages that report constructions which
1976 are not inherently erroneous but which are risky or suggest there
1977 may have been an error.
1979 You can request many specific warnings with options beginning @samp{-W},
1980 for example @option{-Wimplicit} to request warnings on implicit
1981 declarations. Each of these specific warning options also has a
1982 negative form beginning @samp{-Wno-} to turn off warnings;
1983 for example, @option{-Wno-implicit}. This manual lists only one of the
1984 two forms, whichever is not the default.
1986 The following options control the amount and kinds of warnings produced
1987 by GCC; for further, language-specific options also refer to
1988 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
1991 @cindex syntax checking
1993 @opindex fsyntax-only
1994 Check the code for syntax errors, but don't do anything beyond that.
1998 Issue all the warnings demanded by strict ISO C and ISO C++;
1999 reject all programs that use forbidden extensions, and some other
2000 programs that do not follow ISO C and ISO C++. For ISO C, follows the
2001 version of the ISO C standard specified by any @option{-std} option used.
2003 Valid ISO C and ISO C++ programs should compile properly with or without
2004 this option (though a rare few will require @option{-ansi} or a
2005 @option{-std} option specifying the required version of ISO C)@. However,
2006 without this option, certain GNU extensions and traditional C and C++
2007 features are supported as well. With this option, they are rejected.
2009 @option{-pedantic} does not cause warning messages for use of the
2010 alternate keywords whose names begin and end with @samp{__}. Pedantic
2011 warnings are also disabled in the expression that follows
2012 @code{__extension__}. However, only system header files should use
2013 these escape routes; application programs should avoid them.
2014 @xref{Alternate Keywords}.
2016 Some users try to use @option{-pedantic} to check programs for strict ISO
2017 C conformance. They soon find that it does not do quite what they want:
2018 it finds some non-ISO practices, but not all---only those for which
2019 ISO C @emph{requires} a diagnostic, and some others for which
2020 diagnostics have been added.
2022 A feature to report any failure to conform to ISO C might be useful in
2023 some instances, but would require considerable additional work and would
2024 be quite different from @option{-pedantic}. We don't have plans to
2025 support such a feature in the near future.
2027 Where the standard specified with @option{-std} represents a GNU
2028 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2029 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2030 extended dialect is based. Warnings from @option{-pedantic} are given
2031 where they are required by the base standard. (It would not make sense
2032 for such warnings to be given only for features not in the specified GNU
2033 C dialect, since by definition the GNU dialects of C include all
2034 features the compiler supports with the given option, and there would be
2035 nothing to warn about.)
2037 @item -pedantic-errors
2038 @opindex pedantic-errors
2039 Like @option{-pedantic}, except that errors are produced rather than
2044 Inhibit all warning messages.
2048 Inhibit warning messages about the use of @samp{#import}.
2050 @item -Wchar-subscripts
2051 @opindex Wchar-subscripts
2052 Warn if an array subscript has type @code{char}. This is a common cause
2053 of error, as programmers often forget that this type is signed on some
2058 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2059 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2063 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2064 the arguments supplied have types appropriate to the format string
2065 specified, and that the conversions specified in the format string make
2066 sense. This includes standard functions, and others specified by format
2067 attributes (@pxref{Function Attributes}), in the @code{printf},
2068 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2069 not in the C standard) families.
2071 The formats are checked against the format features supported by GNU
2072 libc version 2.2. These include all ISO C90 and C99 features, as well
2073 as features from the Single Unix Specification and some BSD and GNU
2074 extensions. Other library implementations may not support all these
2075 features; GCC does not support warning about features that go beyond a
2076 particular library's limitations. However, if @option{-pedantic} is used
2077 with @option{-Wformat}, warnings will be given about format features not
2078 in the selected standard version (but not for @code{strfmon} formats,
2079 since those are not in any version of the C standard). @xref{C Dialect
2080 Options,,Options Controlling C Dialect}.
2082 Since @option{-Wformat} also checks for null format arguments for
2083 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2085 @option{-Wformat} is included in @option{-Wall}. For more control over some
2086 aspects of format checking, the options @option{-Wformat-y2k},
2087 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2088 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2089 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2092 @opindex Wformat-y2k
2093 If @option{-Wformat} is specified, also warn about @code{strftime}
2094 formats which may yield only a two-digit year.
2096 @item -Wno-format-extra-args
2097 @opindex Wno-format-extra-args
2098 If @option{-Wformat} is specified, do not warn about excess arguments to a
2099 @code{printf} or @code{scanf} format function. The C standard specifies
2100 that such arguments are ignored.
2102 Where the unused arguments lie between used arguments that are
2103 specified with @samp{$} operand number specifications, normally
2104 warnings are still given, since the implementation could not know what
2105 type to pass to @code{va_arg} to skip the unused arguments. However,
2106 in the case of @code{scanf} formats, this option will suppress the
2107 warning if the unused arguments are all pointers, since the Single
2108 Unix Specification says that such unused arguments are allowed.
2110 @item -Wno-format-zero-length
2111 @opindex Wno-format-zero-length
2112 If @option{-Wformat} is specified, do not warn about zero-length formats.
2113 The C standard specifies that zero-length formats are allowed.
2115 @item -Wformat-nonliteral
2116 @opindex Wformat-nonliteral
2117 If @option{-Wformat} is specified, also warn if the format string is not a
2118 string literal and so cannot be checked, unless the format function
2119 takes its format arguments as a @code{va_list}.
2121 @item -Wformat-security
2122 @opindex Wformat-security
2123 If @option{-Wformat} is specified, also warn about uses of format
2124 functions that represent possible security problems. At present, this
2125 warns about calls to @code{printf} and @code{scanf} functions where the
2126 format string is not a string literal and there are no format arguments,
2127 as in @code{printf (foo);}. This may be a security hole if the format
2128 string came from untrusted input and contains @samp{%n}. (This is
2129 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2130 in future warnings may be added to @option{-Wformat-security} that are not
2131 included in @option{-Wformat-nonliteral}.)
2135 Enable @option{-Wformat} plus format checks not included in
2136 @option{-Wformat}. Currently equivalent to @samp{-Wformat
2137 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2141 Warn about passing a null pointer for arguments marked as
2142 requiring a non-null value by the @code{nonnull} function attribute.
2144 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}. It
2145 can be disabled with the @option{-Wno-nonnull} option.
2147 @item -Winit-self @r{(C, C++, and Objective-C only)}
2149 Warn about uninitialized variables which are initialized with themselves.
2150 Note this option can only be used with the @option{-Wuninitialized} option,
2151 which in turn only works with @option{-O1} and above.
2153 For example, GCC will warn about @code{i} being uninitialized in the
2154 following snippet only when @option{-Winit-self} has been specified:
2165 @item -Wimplicit-int
2166 @opindex Wimplicit-int
2167 Warn when a declaration does not specify a type.
2169 @item -Wimplicit-function-declaration
2170 @itemx -Werror-implicit-function-declaration
2171 @opindex Wimplicit-function-declaration
2172 @opindex Werror-implicit-function-declaration
2173 Give a warning (or error) whenever a function is used before being
2178 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2182 Warn if the type of @samp{main} is suspicious. @samp{main} should be a
2183 function with external linkage, returning int, taking either zero
2184 arguments, two, or three arguments of appropriate types.
2186 @item -Wmissing-braces
2187 @opindex Wmissing-braces
2188 Warn if an aggregate or union initializer is not fully bracketed. In
2189 the following example, the initializer for @samp{a} is not fully
2190 bracketed, but that for @samp{b} is fully bracketed.
2193 int a[2][2] = @{ 0, 1, 2, 3 @};
2194 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2198 @opindex Wparentheses
2199 Warn if parentheses are omitted in certain contexts, such
2200 as when there is an assignment in a context where a truth value
2201 is expected, or when operators are nested whose precedence people
2202 often get confused about.
2204 Also warn about constructions where there may be confusion to which
2205 @code{if} statement an @code{else} branch belongs. Here is an example of
2220 In C, every @code{else} branch belongs to the innermost possible @code{if}
2221 statement, which in this example is @code{if (b)}. This is often not
2222 what the programmer expected, as illustrated in the above example by
2223 indentation the programmer chose. When there is the potential for this
2224 confusion, GCC will issue a warning when this flag is specified.
2225 To eliminate the warning, add explicit braces around the innermost
2226 @code{if} statement so there is no way the @code{else} could belong to
2227 the enclosing @code{if}. The resulting code would look like this:
2243 @item -Wsequence-point
2244 @opindex Wsequence-point
2245 Warn about code that may have undefined semantics because of violations
2246 of sequence point rules in the C standard.
2248 The C standard defines the order in which expressions in a C program are
2249 evaluated in terms of @dfn{sequence points}, which represent a partial
2250 ordering between the execution of parts of the program: those executed
2251 before the sequence point, and those executed after it. These occur
2252 after the evaluation of a full expression (one which is not part of a
2253 larger expression), after the evaluation of the first operand of a
2254 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2255 function is called (but after the evaluation of its arguments and the
2256 expression denoting the called function), and in certain other places.
2257 Other than as expressed by the sequence point rules, the order of
2258 evaluation of subexpressions of an expression is not specified. All
2259 these rules describe only a partial order rather than a total order,
2260 since, for example, if two functions are called within one expression
2261 with no sequence point between them, the order in which the functions
2262 are called is not specified. However, the standards committee have
2263 ruled that function calls do not overlap.
2265 It is not specified when between sequence points modifications to the
2266 values of objects take effect. Programs whose behavior depends on this
2267 have undefined behavior; the C standard specifies that ``Between the
2268 previous and next sequence point an object shall have its stored value
2269 modified at most once by the evaluation of an expression. Furthermore,
2270 the prior value shall be read only to determine the value to be
2271 stored.''. If a program breaks these rules, the results on any
2272 particular implementation are entirely unpredictable.
2274 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2275 = b[n++]} and @code{a[i++] = i;}. Some more complicated cases are not
2276 diagnosed by this option, and it may give an occasional false positive
2277 result, but in general it has been found fairly effective at detecting
2278 this sort of problem in programs.
2280 The present implementation of this option only works for C programs. A
2281 future implementation may also work for C++ programs.
2283 The C standard is worded confusingly, therefore there is some debate
2284 over the precise meaning of the sequence point rules in subtle cases.
2285 Links to discussions of the problem, including proposed formal
2286 definitions, may be found on our readings page, at
2287 @w{@uref{http://gcc.gnu.org/readings.html}}.
2290 @opindex Wreturn-type
2291 Warn whenever a function is defined with a return-type that defaults to
2292 @code{int}. Also warn about any @code{return} statement with no
2293 return-value in a function whose return-type is not @code{void}.
2295 For C++, a function without return type always produces a diagnostic
2296 message, even when @option{-Wno-return-type} is specified. The only
2297 exceptions are @samp{main} and functions defined in system headers.
2301 Warn whenever a @code{switch} statement has an index of enumeral type
2302 and lacks a @code{case} for one or more of the named codes of that
2303 enumeration. (The presence of a @code{default} label prevents this
2304 warning.) @code{case} labels outside the enumeration range also
2305 provoke warnings when this option is used.
2307 @item -Wswitch-default
2308 @opindex Wswitch-switch
2309 Warn whenever a @code{switch} statement does not have a @code{default}
2313 @opindex Wswitch-enum
2314 Warn whenever a @code{switch} statement has an index of enumeral type
2315 and lacks a @code{case} for one or more of the named codes of that
2316 enumeration. @code{case} labels outside the enumeration range also
2317 provoke warnings when this option is used.
2321 Warn if any trigraphs are encountered that might change the meaning of
2322 the program (trigraphs within comments are not warned about).
2324 @item -Wunused-function
2325 @opindex Wunused-function
2326 Warn whenever a static function is declared but not defined or a
2327 non\-inline static function is unused.
2329 @item -Wunused-label
2330 @opindex Wunused-label
2331 Warn whenever a label is declared but not used.
2333 To suppress this warning use the @samp{unused} attribute
2334 (@pxref{Variable Attributes}).
2336 @item -Wunused-parameter
2337 @opindex Wunused-parameter
2338 Warn whenever a function parameter is unused aside from its declaration.
2340 To suppress this warning use the @samp{unused} attribute
2341 (@pxref{Variable Attributes}).
2343 @item -Wunused-variable
2344 @opindex Wunused-variable
2345 Warn whenever a local variable or non-constant static variable is unused
2346 aside from its declaration
2348 To suppress this warning use the @samp{unused} attribute
2349 (@pxref{Variable Attributes}).
2351 @item -Wunused-value
2352 @opindex Wunused-value
2353 Warn whenever a statement computes a result that is explicitly not used.
2355 To suppress this warning cast the expression to @samp{void}.
2359 All the above @option{-Wunused} options combined.
2361 In order to get a warning about an unused function parameter, you must
2362 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2363 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2365 @item -Wuninitialized
2366 @opindex Wuninitialized
2367 Warn if an automatic variable is used without first being initialized or
2368 if a variable may be clobbered by a @code{setjmp} call.
2370 These warnings are possible only in optimizing compilation,
2371 because they require data flow information that is computed only
2372 when optimizing. If you don't specify @option{-O}, you simply won't
2375 If you want to warn about code which uses the uninitialized value of the
2376 variable in its own initializer, use the @option{-Winit-self} option.
2378 These warnings occur only for variables that are candidates for
2379 register allocation. Therefore, they do not occur for a variable that
2380 is declared @code{volatile}, or whose address is taken, or whose size
2381 is other than 1, 2, 4 or 8 bytes. Also, they do not occur for
2382 structures, unions or arrays, even when they are in registers.
2384 Note that there may be no warning about a variable that is used only
2385 to compute a value that itself is never used, because such
2386 computations may be deleted by data flow analysis before the warnings
2389 These warnings are made optional because GCC is not smart
2390 enough to see all the reasons why the code might be correct
2391 despite appearing to have an error. Here is one example of how
2412 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2413 always initialized, but GCC doesn't know this. Here is
2414 another common case:
2419 if (change_y) save_y = y, y = new_y;
2421 if (change_y) y = save_y;
2426 This has no bug because @code{save_y} is used only if it is set.
2428 @cindex @code{longjmp} warnings
2429 This option also warns when a non-volatile automatic variable might be
2430 changed by a call to @code{longjmp}. These warnings as well are possible
2431 only in optimizing compilation.
2433 The compiler sees only the calls to @code{setjmp}. It cannot know
2434 where @code{longjmp} will be called; in fact, a signal handler could
2435 call it at any point in the code. As a result, you may get a warning
2436 even when there is in fact no problem because @code{longjmp} cannot
2437 in fact be called at the place which would cause a problem.
2439 Some spurious warnings can be avoided if you declare all the functions
2440 you use that never return as @code{noreturn}. @xref{Function
2443 @item -Wunknown-pragmas
2444 @opindex Wunknown-pragmas
2445 @cindex warning for unknown pragmas
2446 @cindex unknown pragmas, warning
2447 @cindex pragmas, warning of unknown
2448 Warn when a #pragma directive is encountered which is not understood by
2449 GCC@. If this command line option is used, warnings will even be issued
2450 for unknown pragmas in system header files. This is not the case if
2451 the warnings were only enabled by the @option{-Wall} command line option.
2453 @item -Wstrict-aliasing
2454 @opindex Wstrict-aliasing
2455 This option is only active when @option{-fstrict-aliasing} is active.
2456 It warns about code which might break the strict aliasing rules that the
2457 compiler is using for optimization. The warning does not catch all
2458 cases, but does attempt to catch the more common pitfalls. It is
2459 included in @option{-Wall}.
2463 All of the above @samp{-W} options combined. This enables all the
2464 warnings about constructions that some users consider questionable, and
2465 that are easy to avoid (or modify to prevent the warning), even in
2466 conjunction with macros. This also enables some language-specific
2467 warnings described in @ref{C++ Dialect Options} and
2468 @ref{Objective-C Dialect Options}.
2471 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2472 Some of them warn about constructions that users generally do not
2473 consider questionable, but which occasionally you might wish to check
2474 for; others warn about constructions that are necessary or hard to avoid
2475 in some cases, and there is no simple way to modify the code to suppress
2482 (This option used to be called @option{-W}. The older name is still
2483 supported, but the newer name is more descriptive.) Print extra warning
2484 messages for these events:
2488 A function can return either with or without a value. (Falling
2489 off the end of the function body is considered returning without
2490 a value.) For example, this function would evoke such a
2504 An expression-statement or the left-hand side of a comma expression
2505 contains no side effects.
2506 To suppress the warning, cast the unused expression to void.
2507 For example, an expression such as @samp{x[i,j]} will cause a warning,
2508 but @samp{x[(void)i,j]} will not.
2511 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2514 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2515 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2516 that of ordinary mathematical notation.
2519 Storage-class specifiers like @code{static} are not the first things in
2520 a declaration. According to the C Standard, this usage is obsolescent.
2523 The return type of a function has a type qualifier such as @code{const}.
2524 Such a type qualifier has no effect, since the value returned by a
2525 function is not an lvalue. (But don't warn about the GNU extension of
2526 @code{volatile void} return types. That extension will be warned about
2527 if @option{-pedantic} is specified.)
2530 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2534 A comparison between signed and unsigned values could produce an
2535 incorrect result when the signed value is converted to unsigned.
2536 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2539 An aggregate has an initializer which does not initialize all members.
2540 For example, the following code would cause such a warning, because
2541 @code{x.h} would be implicitly initialized to zero:
2544 struct s @{ int f, g, h; @};
2545 struct s x = @{ 3, 4 @};
2549 A function parameter is declared without a type specifier in K&R-style
2557 An empty body occurs in an @samp{if} or @samp{else} statement.
2560 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2561 @samp{>}, or @samp{>=}.
2564 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2567 Any of several floating-point events that often indicate errors, such as
2568 overflow, underflow, loss of precision, etc.
2570 @item @r{(C++ only)}
2571 An enumerator and a non-enumerator both appear in a conditional expression.
2573 @item @r{(C++ only)}
2574 A non-static reference or non-static @samp{const} member appears in a
2575 class without constructors.
2577 @item @r{(C++ only)}
2578 Ambiguous virtual bases.
2580 @item @r{(C++ only)}
2581 Subscripting an array which has been declared @samp{register}.
2583 @item @r{(C++ only)}
2584 Taking the address of a variable which has been declared @samp{register}.
2586 @item @r{(C++ only)}
2587 A base class is not initialized in a derived class' copy constructor.
2590 @item -Wno-div-by-zero
2591 @opindex Wno-div-by-zero
2592 @opindex Wdiv-by-zero
2593 Do not warn about compile-time integer division by zero. Floating point
2594 division by zero is not warned about, as it can be a legitimate way of
2595 obtaining infinities and NaNs.
2597 @item -Wsystem-headers
2598 @opindex Wsystem-headers
2599 @cindex warnings from system headers
2600 @cindex system headers, warnings from
2601 Print warning messages for constructs found in system header files.
2602 Warnings from system headers are normally suppressed, on the assumption
2603 that they usually do not indicate real problems and would only make the
2604 compiler output harder to read. Using this command line option tells
2605 GCC to emit warnings from system headers as if they occurred in user
2606 code. However, note that using @option{-Wall} in conjunction with this
2607 option will @emph{not} warn about unknown pragmas in system
2608 headers---for that, @option{-Wunknown-pragmas} must also be used.
2611 @opindex Wfloat-equal
2612 Warn if floating point values are used in equality comparisons.
2614 The idea behind this is that sometimes it is convenient (for the
2615 programmer) to consider floating-point values as approximations to
2616 infinitely precise real numbers. If you are doing this, then you need
2617 to compute (by analyzing the code, or in some other way) the maximum or
2618 likely maximum error that the computation introduces, and allow for it
2619 when performing comparisons (and when producing output, but that's a
2620 different problem). In particular, instead of testing for equality, you
2621 would check to see whether the two values have ranges that overlap; and
2622 this is done with the relational operators, so equality comparisons are
2625 @item -Wtraditional @r{(C only)}
2626 @opindex Wtraditional
2627 Warn about certain constructs that behave differently in traditional and
2628 ISO C@. Also warn about ISO C constructs that have no traditional C
2629 equivalent, and/or problematic constructs which should be avoided.
2633 Macro parameters that appear within string literals in the macro body.
2634 In traditional C macro replacement takes place within string literals,
2635 but does not in ISO C@.
2638 In traditional C, some preprocessor directives did not exist.
2639 Traditional preprocessors would only consider a line to be a directive
2640 if the @samp{#} appeared in column 1 on the line. Therefore
2641 @option{-Wtraditional} warns about directives that traditional C
2642 understands but would ignore because the @samp{#} does not appear as the
2643 first character on the line. It also suggests you hide directives like
2644 @samp{#pragma} not understood by traditional C by indenting them. Some
2645 traditional implementations would not recognize @samp{#elif}, so it
2646 suggests avoiding it altogether.
2649 A function-like macro that appears without arguments.
2652 The unary plus operator.
2655 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2656 constant suffixes. (Traditional C does support the @samp{L} suffix on integer
2657 constants.) Note, these suffixes appear in macros defined in the system
2658 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2659 Use of these macros in user code might normally lead to spurious
2660 warnings, however gcc's integrated preprocessor has enough context to
2661 avoid warning in these cases.
2664 A function declared external in one block and then used after the end of
2668 A @code{switch} statement has an operand of type @code{long}.
2671 A non-@code{static} function declaration follows a @code{static} one.
2672 This construct is not accepted by some traditional C compilers.
2675 The ISO type of an integer constant has a different width or
2676 signedness from its traditional type. This warning is only issued if
2677 the base of the constant is ten. I.e.@: hexadecimal or octal values, which
2678 typically represent bit patterns, are not warned about.
2681 Usage of ISO string concatenation is detected.
2684 Initialization of automatic aggregates.
2687 Identifier conflicts with labels. Traditional C lacks a separate
2688 namespace for labels.
2691 Initialization of unions. If the initializer is zero, the warning is
2692 omitted. This is done under the assumption that the zero initializer in
2693 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2694 initializer warnings and relies on default initialization to zero in the
2698 Conversions by prototypes between fixed/floating point values and vice
2699 versa. The absence of these prototypes when compiling with traditional
2700 C would cause serious problems. This is a subset of the possible
2701 conversion warnings, for the full set use @option{-Wconversion}.
2704 Use of ISO C style function definitions. This warning intentionally is
2705 @emph{not} issued for prototype declarations or variadic functions
2706 because these ISO C features will appear in your code when using
2707 libiberty's traditional C compatibility macros, @code{PARAMS} and
2708 @code{VPARAMS}. This warning is also bypassed for nested functions
2709 because that feature is already a gcc extension and thus not relevant to
2710 traditional C compatibility.
2713 @item -Wdeclaration-after-statement @r{(C only)}
2714 @opindex Wdeclaration-after-statement
2715 Warn when a declaration is found after a statement in a block. This
2716 construct, known from C++, was introduced with ISO C99 and is by default
2717 allowed in GCC@. It is not supported by ISO C90 and was not supported by
2718 GCC versions before GCC 3.0. @xref{Mixed Declarations}.
2722 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2724 @item -Wendif-labels
2725 @opindex Wendif-labels
2726 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2730 Warn whenever a local variable shadows another local variable, parameter or
2731 global variable or whenever a built-in function is shadowed.
2733 @item -Wlarger-than-@var{len}
2734 @opindex Wlarger-than
2735 Warn whenever an object of larger than @var{len} bytes is defined.
2737 @item -Wpointer-arith
2738 @opindex Wpointer-arith
2739 Warn about anything that depends on the ``size of'' a function type or
2740 of @code{void}. GNU C assigns these types a size of 1, for
2741 convenience in calculations with @code{void *} pointers and pointers
2744 @item -Wbad-function-cast @r{(C only)}
2745 @opindex Wbad-function-cast
2746 Warn whenever a function call is cast to a non-matching type.
2747 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2751 Warn whenever a pointer is cast so as to remove a type qualifier from
2752 the target type. For example, warn if a @code{const char *} is cast
2753 to an ordinary @code{char *}.
2756 @opindex Wcast-align
2757 Warn whenever a pointer is cast such that the required alignment of the
2758 target is increased. For example, warn if a @code{char *} is cast to
2759 an @code{int *} on machines where integers can only be accessed at
2760 two- or four-byte boundaries.
2762 @item -Wwrite-strings
2763 @opindex Wwrite-strings
2764 When compiling C, give string constants the type @code{const
2765 char[@var{length}]} so that
2766 copying the address of one into a non-@code{const} @code{char *}
2767 pointer will get a warning; when compiling C++, warn about the
2768 deprecated conversion from string constants to @code{char *}.
2769 These warnings will help you find at
2770 compile time code that can try to write into a string constant, but
2771 only if you have been very careful about using @code{const} in
2772 declarations and prototypes. Otherwise, it will just be a nuisance;
2773 this is why we did not make @option{-Wall} request these warnings.
2776 @opindex Wconversion
2777 Warn if a prototype causes a type conversion that is different from what
2778 would happen to the same argument in the absence of a prototype. This
2779 includes conversions of fixed point to floating and vice versa, and
2780 conversions changing the width or signedness of a fixed point argument
2781 except when the same as the default promotion.
2783 Also, warn if a negative integer constant expression is implicitly
2784 converted to an unsigned type. For example, warn about the assignment
2785 @code{x = -1} if @code{x} is unsigned. But do not warn about explicit
2786 casts like @code{(unsigned) -1}.
2788 @item -Wsign-compare
2789 @opindex Wsign-compare
2790 @cindex warning for comparison of signed and unsigned values
2791 @cindex comparison of signed and unsigned values, warning
2792 @cindex signed and unsigned values, comparison warning
2793 Warn when a comparison between signed and unsigned values could produce
2794 an incorrect result when the signed value is converted to unsigned.
2795 This warning is also enabled by @option{-Wextra}; to get the other warnings
2796 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2798 @item -Waggregate-return
2799 @opindex Waggregate-return
2800 Warn if any functions that return structures or unions are defined or
2801 called. (In languages where you can return an array, this also elicits
2804 @item -Wstrict-prototypes @r{(C only)}
2805 @opindex Wstrict-prototypes
2806 Warn if a function is declared or defined without specifying the
2807 argument types. (An old-style function definition is permitted without
2808 a warning if preceded by a declaration which specifies the argument
2811 @item -Wold-style-definition @r{(C only)}
2812 @opindex Wold-style-definition
2813 Warn if an old-style function definition is used. A warning is given
2814 even if there is a previous prototype.
2816 @item -Wmissing-prototypes @r{(C only)}
2817 @opindex Wmissing-prototypes
2818 Warn if a global function is defined without a previous prototype
2819 declaration. This warning is issued even if the definition itself
2820 provides a prototype. The aim is to detect global functions that fail
2821 to be declared in header files.
2823 @item -Wmissing-declarations @r{(C only)}
2824 @opindex Wmissing-declarations
2825 Warn if a global function is defined without a previous declaration.
2826 Do so even if the definition itself provides a prototype.
2827 Use this option to detect global functions that are not declared in
2830 @item -Wmissing-noreturn
2831 @opindex Wmissing-noreturn
2832 Warn about functions which might be candidates for attribute @code{noreturn}.
2833 Note these are only possible candidates, not absolute ones. Care should
2834 be taken to manually verify functions actually do not ever return before
2835 adding the @code{noreturn} attribute, otherwise subtle code generation
2836 bugs could be introduced. You will not get a warning for @code{main} in
2837 hosted C environments.
2839 @item -Wmissing-format-attribute
2840 @opindex Wmissing-format-attribute
2842 If @option{-Wformat} is enabled, also warn about functions which might be
2843 candidates for @code{format} attributes. Note these are only possible
2844 candidates, not absolute ones. GCC will guess that @code{format}
2845 attributes might be appropriate for any function that calls a function
2846 like @code{vprintf} or @code{vscanf}, but this might not always be the
2847 case, and some functions for which @code{format} attributes are
2848 appropriate may not be detected. This option has no effect unless
2849 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2851 @item -Wno-multichar
2852 @opindex Wno-multichar
2854 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2855 Usually they indicate a typo in the user's code, as they have
2856 implementation-defined values, and should not be used in portable code.
2858 @item -Wno-deprecated-declarations
2859 @opindex Wno-deprecated-declarations
2860 Do not warn about uses of functions, variables, and types marked as
2861 deprecated by using the @code{deprecated} attribute.
2862 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2863 @pxref{Type Attributes}.)
2867 Warn if a structure is given the packed attribute, but the packed
2868 attribute has no effect on the layout or size of the structure.
2869 Such structures may be mis-aligned for little benefit. For
2870 instance, in this code, the variable @code{f.x} in @code{struct bar}
2871 will be misaligned even though @code{struct bar} does not itself
2872 have the packed attribute:
2879 @} __attribute__((packed));
2889 Warn if padding is included in a structure, either to align an element
2890 of the structure or to align the whole structure. Sometimes when this
2891 happens it is possible to rearrange the fields of the structure to
2892 reduce the padding and so make the structure smaller.
2894 @item -Wredundant-decls
2895 @opindex Wredundant-decls
2896 Warn if anything is declared more than once in the same scope, even in
2897 cases where multiple declaration is valid and changes nothing.
2899 @item -Wnested-externs @r{(C only)}
2900 @opindex Wnested-externs
2901 Warn if an @code{extern} declaration is encountered within a function.
2903 @item -Wunreachable-code
2904 @opindex Wunreachable-code
2905 Warn if the compiler detects that code will never be executed.
2907 This option is intended to warn when the compiler detects that at
2908 least a whole line of source code will never be executed, because
2909 some condition is never satisfied or because it is after a
2910 procedure that never returns.
2912 It is possible for this option to produce a warning even though there
2913 are circumstances under which part of the affected line can be executed,
2914 so care should be taken when removing apparently-unreachable code.
2916 For instance, when a function is inlined, a warning may mean that the
2917 line is unreachable in only one inlined copy of the function.
2919 This option is not made part of @option{-Wall} because in a debugging
2920 version of a program there is often substantial code which checks
2921 correct functioning of the program and is, hopefully, unreachable
2922 because the program does work. Another common use of unreachable
2923 code is to provide behavior which is selectable at compile-time.
2927 Warn if a function can not be inlined and it was declared as inline.
2928 Even with this option, the compiler will not warn about failures to
2929 inline functions declared in system headers.
2931 The compiler uses a variety of heuristics to determine whether or not
2932 to inline a function. For example, the compiler takes into account
2933 the size of the function being inlined and the the amount of inlining
2934 that has already been done in the current function. Therefore,
2935 seemingly insignificant changes in the source program can cause the
2936 warnings produced by @option{-Winline} to appear or disappear.
2938 @item -Wno-invalid-offsetof @r{(C++ only)}
2939 @opindex Wno-invalid-offsetof
2940 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
2941 type. According to the 1998 ISO C++ standard, applying @samp{offsetof}
2942 to a non-POD type is undefined. In existing C++ implementations,
2943 however, @samp{offsetof} typically gives meaningful results even when
2944 applied to certain kinds of non-POD types. (Such as a simple
2945 @samp{struct} that fails to be a POD type only by virtue of having a
2946 constructor.) This flag is for users who are aware that they are
2947 writing nonportable code and who have deliberately chosen to ignore the
2950 The restrictions on @samp{offsetof} may be relaxed in a future version
2951 of the C++ standard.
2954 @opindex Winvalid-pch
2955 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2956 the search path but can't be used.
2960 @opindex Wno-long-long
2961 Warn if @samp{long long} type is used. This is default. To inhibit
2962 the warning messages, use @option{-Wno-long-long}. Flags
2963 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2964 only when @option{-pedantic} flag is used.
2966 @item -Wdisabled-optimization
2967 @opindex Wdisabled-optimization
2968 Warn if a requested optimization pass is disabled. This warning does
2969 not generally indicate that there is anything wrong with your code; it
2970 merely indicates that GCC's optimizers were unable to handle the code
2971 effectively. Often, the problem is that your code is too big or too
2972 complex; GCC will refuse to optimize programs when the optimization
2973 itself is likely to take inordinate amounts of time.
2977 Make all warnings into errors.
2980 @node Debugging Options
2981 @section Options for Debugging Your Program or GCC
2982 @cindex options, debugging
2983 @cindex debugging information options
2985 GCC has various special options that are used for debugging
2986 either your program or GCC:
2991 Produce debugging information in the operating system's native format
2992 (stabs, COFF, XCOFF, or DWARF)@. GDB can work with this debugging
2995 On most systems that use stabs format, @option{-g} enables use of extra
2996 debugging information that only GDB can use; this extra information
2997 makes debugging work better in GDB but will probably make other debuggers
2999 refuse to read the program. If you want to control for certain whether
3000 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3001 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3003 Unlike most other C compilers, GCC allows you to use @option{-g} with
3004 @option{-O}. The shortcuts taken by optimized code may occasionally
3005 produce surprising results: some variables you declared may not exist
3006 at all; flow of control may briefly move where you did not expect it;
3007 some statements may not be executed because they compute constant
3008 results or their values were already at hand; some statements may
3009 execute in different places because they were moved out of loops.
3011 Nevertheless it proves possible to debug optimized output. This makes
3012 it reasonable to use the optimizer for programs that might have bugs.
3014 The following options are useful when GCC is generated with the
3015 capability for more than one debugging format.
3019 Produce debugging information for use by GDB@. This means to use the
3020 most expressive format available (DWARF 2, stabs, or the native format
3021 if neither of those are supported), including GDB extensions if at all
3026 Produce debugging information in stabs format (if that is supported),
3027 without GDB extensions. This is the format used by DBX on most BSD
3028 systems. On MIPS, Alpha and System V Release 4 systems this option
3029 produces stabs debugging output which is not understood by DBX or SDB@.
3030 On System V Release 4 systems this option requires the GNU assembler.
3032 @item -feliminate-unused-debug-symbols
3033 @opindex feliminate-unused-debug-symbols
3034 Produce debugging information in stabs format (if that is supported),
3035 for only symbols that are actually used.
3039 Produce debugging information in stabs format (if that is supported),
3040 using GNU extensions understood only by the GNU debugger (GDB)@. The
3041 use of these extensions is likely to make other debuggers crash or
3042 refuse to read the program.
3046 Produce debugging information in COFF format (if that is supported).
3047 This is the format used by SDB on most System V systems prior to
3052 Produce debugging information in XCOFF format (if that is supported).
3053 This is the format used by the DBX debugger on IBM RS/6000 systems.
3057 Produce debugging information in XCOFF format (if that is supported),
3058 using GNU extensions understood only by the GNU debugger (GDB)@. The
3059 use of these extensions is likely to make other debuggers crash or
3060 refuse to read the program, and may cause assemblers other than the GNU
3061 assembler (GAS) to fail with an error.
3065 Produce debugging information in DWARF version 2 format (if that is
3066 supported). This is the format used by DBX on IRIX 6.
3070 Produce debugging information in VMS debug format (if that is
3071 supported). This is the format used by DEBUG on VMS systems.
3074 @itemx -ggdb@var{level}
3075 @itemx -gstabs@var{level}
3076 @itemx -gcoff@var{level}
3077 @itemx -gxcoff@var{level}
3078 @itemx -gvms@var{level}
3079 Request debugging information and also use @var{level} to specify how
3080 much information. The default level is 2.
3082 Level 1 produces minimal information, enough for making backtraces in
3083 parts of the program that you don't plan to debug. This includes
3084 descriptions of functions and external variables, but no information
3085 about local variables and no line numbers.
3087 Level 3 includes extra information, such as all the macro definitions
3088 present in the program. Some debuggers support macro expansion when
3089 you use @option{-g3}.
3091 Note that in order to avoid confusion between DWARF1 debug level 2,
3092 and DWARF2 @option{-gdwarf-2} does not accept a concatenated debug
3093 level. Instead use an additional @option{-g@var{level}} option to
3094 change the debug level for DWARF2.
3096 @item -feliminate-dwarf2-dups
3097 @opindex feliminate-dwarf2-dups
3098 Compress DWARF2 debugging information by eliminating duplicated
3099 information about each symbol. This option only makes sense when
3100 generating DWARF2 debugging information with @option{-gdwarf-2}.
3102 @cindex @command{prof}
3105 Generate extra code to write profile information suitable for the
3106 analysis program @command{prof}. You must use this option when compiling
3107 the source files you want data about, and you must also use it when
3110 @cindex @command{gprof}
3113 Generate extra code to write profile information suitable for the
3114 analysis program @command{gprof}. You must use this option when compiling
3115 the source files you want data about, and you must also use it when
3120 Makes the compiler print out each function name as it is compiled, and
3121 print some statistics about each pass when it finishes.
3124 @opindex ftime-report
3125 Makes the compiler print some statistics about the time consumed by each
3126 pass when it finishes.
3129 @opindex fmem-report
3130 Makes the compiler print some statistics about permanent memory
3131 allocation when it finishes.
3133 @item -fprofile-arcs
3134 @opindex fprofile-arcs
3135 Add code so that program flow @dfn{arcs} are instrumented. During
3136 execution the program records how many times each branch and call is
3137 executed and how many times it is taken or returns. When the compiled
3138 program exits it saves this data to a file called
3139 @file{@var{auxname}.gcda} for each source file. The data may be used for
3140 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3141 test coverage analysis (@option{-ftest-coverage}). Each object file's
3142 @var{auxname} is generated from the name of the output file, if
3143 explicitly specified and it is not the final executable, otherwise it is
3144 the basename of the source file. In both cases any suffix is removed
3145 (e.g. @file{foo.gcda} for input file @file{dir/foo.c}, or
3146 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3151 Compile the source files with @option{-fprofile-arcs} plus optimization
3152 and code generation options. For test coverage analysis, use the
3153 additional @option{-ftest-coverage} option. You do not need to profile
3154 every source file in a program.
3157 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3158 (the latter implies the former).
3161 Run the program on a representative workload to generate the arc profile
3162 information. This may be repeated any number of times. You can run
3163 concurrent instances of your program, and provided that the file system
3164 supports locking, the data files will be correctly updated. Also
3165 @code{fork} calls are detected and correctly handled (double counting
3169 For profile-directed optimizations, compile the source files again with
3170 the same optimization and code generation options plus
3171 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3172 Control Optimization}).
3175 For test coverage analysis, use @command{gcov} to produce human readable
3176 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3177 @command{gcov} documentation for further information.
3181 With @option{-fprofile-arcs}, for each function of your program GCC
3182 creates a program flow graph, then finds a spanning tree for the graph.
3183 Only arcs that are not on the spanning tree have to be instrumented: the
3184 compiler adds code to count the number of times that these arcs are
3185 executed. When an arc is the only exit or only entrance to a block, the
3186 instrumentation code can be added to the block; otherwise, a new basic
3187 block must be created to hold the instrumentation code.
3190 @item -ftest-coverage
3191 @opindex ftest-coverage
3192 Produce a notes file that the @command{gcov} code-coverage utility
3193 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3194 show program coverage. Each source file's note file is called
3195 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3196 above for a description of @var{auxname} and instructions on how to
3197 generate test coverage data. Coverage data will match the source files
3198 more closely, if you do not optimize.
3200 @item -d@var{letters}
3202 Says to make debugging dumps during compilation at times specified by
3203 @var{letters}. This is used for debugging the compiler. The file names
3204 for most of the dumps are made by appending a pass number and a word to
3205 the @var{dumpname}. @var{dumpname} is generated from the name of the
3206 output file, if explicitly specified and it is not an executable,
3207 otherwise it is the basename of the source file. In both cases any
3208 suffix is removed (e.g. @file{foo.01.rtl} or @file{foo.02.sibling}).
3209 Here are the possible letters for use in @var{letters}, and their
3215 Annotate the assembler output with miscellaneous debugging information.
3218 Dump after computing branch probabilities, to @file{@var{file}.12.bp}.
3221 Dump after block reordering, to @file{@var{file}.31.bbro}.
3224 Dump after instruction combination, to the file @file{@var{file}.20.combine}.
3227 Dump after the first if conversion, to the file @file{@var{file}.14.ce1}.
3228 Also dump after the second if conversion, to the file @file{@var{file}.21.ce2}.
3231 Dump after branch target load optimization, to to @file{@var{file}.32.btl}.
3232 Also dump after delayed branch scheduling, to @file{@var{file}.36.dbr}.
3235 Dump all macro definitions, at the end of preprocessing, in addition to
3239 Dump after the third if conversion, to @file{@var{file}.30.ce3}.
3242 Dump after control and data flow analysis, to @file{@var{file}.11.cfg}.
3243 Also dump after life analysis, to @file{@var{file}.19.life}.
3246 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.07.addressof}.
3249 Dump after global register allocation, to @file{@var{file}.25.greg}.
3252 Dump after GCSE, to @file{@var{file}.08.gcse}.
3253 Also dump after jump bypassing and control flow optimizations, to
3254 @file{@var{file}.10.bypass}.
3257 Dump after finalization of EH handling code, to @file{@var{file}.03.eh}.
3260 Dump after sibling call optimizations, to @file{@var{file}.02.sibling}.
3263 Dump after the first jump optimization, to @file{@var{file}.04.jump}.
3266 Dump after conversion from registers to stack, to @file{@var{file}.34.stack}.
3269 Dump after local register allocation, to @file{@var{file}.24.lreg}.
3272 Dump after loop optimization passes, to @file{@var{file}.09.loop} and
3273 @file{@var{file}.16.loop2}.
3276 Dump after performing the machine dependent reorganization pass, to
3277 @file{@var{file}.35.mach}.
3280 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3283 Dump after the register move pass, to @file{@var{file}.22.regmove}.
3286 Dump after post-reload optimizations, to @file{@var{file}.26.postreload}.
3289 Dump after RTL generation, to @file{@var{file}.01.rtl}.
3292 Dump after the second scheduling pass, to @file{@var{file}.33.sched2}.
3295 Dump after CSE (including the jump optimization that sometimes follows
3296 CSE), to @file{@var{file}.06.cse}.
3299 Dump after the first scheduling pass, to @file{@var{file}.23.sched}.
3302 Dump after the second CSE pass (including the jump optimization that
3303 sometimes follows CSE), to @file{@var{file}.18.cse2}.
3306 Dump after running tracer, to @file{@var{file}.15.tracer}.
3309 Dump after null pointer elimination pass to @file{@var{file}.05.null}.
3312 Dump callgraph and unit-at-a-time optimization @file{@var{file}.00.unit}.
3315 Dump after the value profile transformations, to @file{@var{file}.13.vpt}.
3316 Also dump after variable tracking, to @file{@var{file}.35.vartrack}.
3319 Dump after the second flow pass, to @file{@var{file}.27.flow2}.
3322 Dump after the peephole pass, to @file{@var{file}.28.peephole2}.
3325 Dump after constructing the web, to @file{@var{file}.17.web}.
3328 Produce all the dumps listed above.
3331 Produce a core dump whenever an error occurs.
3334 Print statistics on memory usage, at the end of the run, to
3338 Annotate the assembler output with a comment indicating which
3339 pattern and alternative was used. The length of each instruction is
3343 Dump the RTL in the assembler output as a comment before each instruction.
3344 Also turns on @option{-dp} annotation.
3347 For each of the other indicated dump files (except for
3348 @file{@var{file}.01.rtl}), dump a representation of the control flow graph
3349 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3352 Just generate RTL for a function instead of compiling it. Usually used
3356 Dump debugging information during parsing, to standard error.
3359 @item -fdump-unnumbered
3360 @opindex fdump-unnumbered
3361 When doing debugging dumps (see @option{-d} option above), suppress instruction
3362 numbers and line number note output. This makes it more feasible to
3363 use diff on debugging dumps for compiler invocations with different
3364 options, in particular with and without @option{-g}.
3366 @item -fdump-translation-unit @r{(C and C++ only)}
3367 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3368 @opindex fdump-translation-unit
3369 Dump a representation of the tree structure for the entire translation
3370 unit to a file. The file name is made by appending @file{.tu} to the
3371 source file name. If the @samp{-@var{options}} form is used, @var{options}
3372 controls the details of the dump as described for the
3373 @option{-fdump-tree} options.
3375 @item -fdump-class-hierarchy @r{(C++ only)}
3376 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3377 @opindex fdump-class-hierarchy
3378 Dump a representation of each class's hierarchy and virtual function
3379 table layout to a file. The file name is made by appending @file{.class}
3380 to the source file name. If the @samp{-@var{options}} form is used,
3381 @var{options} controls the details of the dump as described for the
3382 @option{-fdump-tree} options.
3384 @item -fdump-tree-@var{switch} @r{(C++ only)}
3385 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3387 Control the dumping at various stages of processing the intermediate
3388 language tree to a file. The file name is generated by appending a switch
3389 specific suffix to the source file name. If the @samp{-@var{options}}
3390 form is used, @var{options} is a list of @samp{-} separated options that
3391 control the details of the dump. Not all options are applicable to all
3392 dumps, those which are not meaningful will be ignored. The following
3393 options are available
3397 Print the address of each node. Usually this is not meaningful as it
3398 changes according to the environment and source file. Its primary use
3399 is for tying up a dump file with a debug environment.
3401 Inhibit dumping of members of a scope or body of a function merely
3402 because that scope has been reached. Only dump such items when they
3403 are directly reachable by some other path.
3405 Turn on all options.
3408 The following tree dumps are possible:
3411 Dump before any tree based optimization, to @file{@var{file}.original}.
3413 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3415 Dump after function inlining, to @file{@var{file}.inlined}.
3418 @item -frandom-seed=@var{string}
3419 @opindex frandom-string
3420 This option provides a seed that GCC uses when it would otherwise use
3421 random numbers. It is used to generate certain symbol names
3422 that have to be different in every compiled file. It is also used to
3423 place unique stamps in coverage data files and the object files that
3424 produce them. You can use the @option{-frandom-seed} option to produce
3425 reproducibly identical object files.
3427 The @var{string} should be different for every file you compile.
3429 @item -fsched-verbose=@var{n}
3430 @opindex fsched-verbose
3431 On targets that use instruction scheduling, this option controls the
3432 amount of debugging output the scheduler prints. This information is
3433 written to standard error, unless @option{-dS} or @option{-dR} is
3434 specified, in which case it is output to the usual dump
3435 listing file, @file{.sched} or @file{.sched2} respectively. However
3436 for @var{n} greater than nine, the output is always printed to standard
3439 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3440 same information as @option{-dRS}. For @var{n} greater than one, it
3441 also output basic block probabilities, detailed ready list information
3442 and unit/insn info. For @var{n} greater than two, it includes RTL
3443 at abort point, control-flow and regions info. And for @var{n} over
3444 four, @option{-fsched-verbose} also includes dependence info.
3448 Store the usual ``temporary'' intermediate files permanently; place them
3449 in the current directory and name them based on the source file. Thus,
3450 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3451 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}. This creates a
3452 preprocessed @file{foo.i} output file even though the compiler now
3453 normally uses an integrated preprocessor.
3457 Report the CPU time taken by each subprocess in the compilation
3458 sequence. For C source files, this is the compiler proper and assembler
3459 (plus the linker if linking is done). The output looks like this:
3466 The first number on each line is the ``user time,'' that is time spent
3467 executing the program itself. The second number is ``system time,''
3468 time spent executing operating system routines on behalf of the program.
3469 Both numbers are in seconds.
3471 @item -fvar-tracking
3472 @opindex fvar-tracking
3473 Run variable tracking pass. It computes where variables are stored at each
3474 position in code. Better debugging information is then generated
3475 (if the debugging information format supports this information).
3477 It is enabled by default when compiling with optimization (@option{-Os},
3478 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
3479 the debug info format supports it.
3481 @item -print-file-name=@var{library}
3482 @opindex print-file-name
3483 Print the full absolute name of the library file @var{library} that
3484 would be used when linking---and don't do anything else. With this
3485 option, GCC does not compile or link anything; it just prints the
3488 @item -print-multi-directory
3489 @opindex print-multi-directory
3490 Print the directory name corresponding to the multilib selected by any
3491 other switches present in the command line. This directory is supposed
3492 to exist in @env{GCC_EXEC_PREFIX}.
3494 @item -print-multi-lib
3495 @opindex print-multi-lib
3496 Print the mapping from multilib directory names to compiler switches
3497 that enable them. The directory name is separated from the switches by
3498 @samp{;}, and each switch starts with an @samp{@@} instead of the
3499 @samp{-}, without spaces between multiple switches. This is supposed to
3500 ease shell-processing.
3502 @item -print-prog-name=@var{program}
3503 @opindex print-prog-name
3504 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3506 @item -print-libgcc-file-name
3507 @opindex print-libgcc-file-name
3508 Same as @option{-print-file-name=libgcc.a}.
3510 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3511 but you do want to link with @file{libgcc.a}. You can do
3514 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3517 @item -print-search-dirs
3518 @opindex print-search-dirs
3519 Print the name of the configured installation directory and a list of
3520 program and library directories gcc will search---and don't do anything else.
3522 This is useful when gcc prints the error message
3523 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3524 To resolve this you either need to put @file{cpp0} and the other compiler
3525 components where gcc expects to find them, or you can set the environment
3526 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3527 Don't forget the trailing '/'.
3528 @xref{Environment Variables}.
3531 @opindex dumpmachine
3532 Print the compiler's target machine (for example,
3533 @samp{i686-pc-linux-gnu})---and don't do anything else.
3536 @opindex dumpversion
3537 Print the compiler version (for example, @samp{3.0})---and don't do
3542 Print the compiler's built-in specs---and don't do anything else. (This
3543 is used when GCC itself is being built.) @xref{Spec Files}.
3545 @item -feliminate-unused-debug-types
3546 @opindex feliminate-unused-debug-types
3547 Normally, when producing DWARF2 output, GCC will emit debugging
3548 information for all types declared in a compilation
3549 unit, regardless of whether or not they are actually used
3550 in that compilation unit. Sometimes this is useful, such as
3551 if, in the debugger, you want to cast a value to a type that is
3552 not actually used in your program (but is declared). More often,
3553 however, this results in a significant amount of wasted space.
3554 With this option, GCC will avoid producing debug symbol output
3555 for types that are nowhere used in the source file being compiled.
3558 @node Optimize Options
3559 @section Options That Control Optimization
3560 @cindex optimize options
3561 @cindex options, optimization
3563 These options control various sorts of optimizations.
3565 Without any optimization option, the compiler's goal is to reduce the
3566 cost of compilation and to make debugging produce the expected
3567 results. Statements are independent: if you stop the program with a
3568 breakpoint between statements, you can then assign a new value to any
3569 variable or change the program counter to any other statement in the
3570 function and get exactly the results you would expect from the source
3573 Turning on optimization flags makes the compiler attempt to improve
3574 the performance and/or code size at the expense of compilation time
3575 and possibly the ability to debug the program.
3577 The compiler performs optimization based on the knowledge it has of
3578 the program. Using the @option{-funit-at-a-time} flag will allow the
3579 compiler to consider information gained from later functions in the
3580 file when compiling a function. Compiling multiple files at once to a
3581 single output file (and using @option{-funit-at-a-time}) will allow
3582 the compiler to use information gained from all of the files when
3583 compiling each of them.
3585 Not all optimizations are controlled directly by a flag. Only
3586 optimizations that have a flag are listed.
3593 Optimize. Optimizing compilation takes somewhat more time, and a lot
3594 more memory for a large function.
3596 With @option{-O}, the compiler tries to reduce code size and execution
3597 time, without performing any optimizations that take a great deal of
3600 @option{-O} turns on the following optimization flags:
3601 @gccoptlist{-fdefer-pop @gol
3602 -fmerge-constants @gol
3604 -floop-optimize @gol
3605 -fif-conversion @gol
3606 -fif-conversion2 @gol
3607 -fdelayed-branch @gol
3608 -fguess-branch-probability @gol
3611 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3612 where doing so does not interfere with debugging.
3616 Optimize even more. GCC performs nearly all supported optimizations
3617 that do not involve a space-speed tradeoff. The compiler does not
3618 perform loop unrolling or function inlining when you specify @option{-O2}.
3619 As compared to @option{-O}, this option increases both compilation time
3620 and the performance of the generated code.
3622 @option{-O2} turns on all optimization flags specified by @option{-O}. It
3623 also turns on the following optimization flags:
3624 @gccoptlist{-fforce-mem @gol
3625 -foptimize-sibling-calls @gol
3626 -fstrength-reduce @gol
3627 -fcse-follow-jumps -fcse-skip-blocks @gol
3628 -frerun-cse-after-loop -frerun-loop-opt @gol
3629 -fgcse -fgcse-lm -fgcse-sm -fgcse-las @gol
3630 -fdelete-null-pointer-checks @gol
3631 -fexpensive-optimizations @gol
3633 -fschedule-insns -fschedule-insns2 @gol
3634 -fsched-interblock -fsched-spec @gol
3637 -freorder-blocks -freorder-functions @gol
3638 -fstrict-aliasing @gol
3639 -funit-at-a-time @gol
3640 -falign-functions -falign-jumps @gol
3641 -falign-loops -falign-labels @gol
3644 Please note the warning under @option{-fgcse} about
3645 invoking @option{-O2} on programs that use computed gotos.
3649 Optimize yet more. @option{-O3} turns on all optimizations specified by
3650 @option{-O2} and also turns on the @option{-finline-functions},
3651 @option{-fweb} and @option{-frename-registers} options.
3655 Do not optimize. This is the default.
3659 Optimize for size. @option{-Os} enables all @option{-O2} optimizations that
3660 do not typically increase code size. It also performs further
3661 optimizations designed to reduce code size.
3663 @option{-Os} disables the following optimization flags:
3664 @gccoptlist{-falign-functions -falign-jumps -falign-loops @gol
3665 -falign-labels -freorder-blocks -fprefetch-loop-arrays}
3667 If you use multiple @option{-O} options, with or without level numbers,
3668 the last such option is the one that is effective.
3671 Options of the form @option{-f@var{flag}} specify machine-independent
3672 flags. Most flags have both positive and negative forms; the negative
3673 form of @option{-ffoo} would be @option{-fno-foo}. In the table
3674 below, only one of the forms is listed---the one you typically will
3675 use. You can figure out the other form by either removing @samp{no-}
3678 The following options control specific optimizations. They are either
3679 activated by @option{-O} options or are related to ones that are. You
3680 can use the following flags in the rare cases when ``fine-tuning'' of
3681 optimizations to be performed is desired.
3684 @item -fno-default-inline
3685 @opindex fno-default-inline
3686 Do not make member functions inline by default merely because they are
3687 defined inside the class scope (C++ only). Otherwise, when you specify
3688 @w{@option{-O}}, member functions defined inside class scope are compiled
3689 inline by default; i.e., you don't need to add @samp{inline} in front of
3690 the member function name.
3692 @item -fno-defer-pop
3693 @opindex fno-defer-pop
3694 Always pop the arguments to each function call as soon as that function
3695 returns. For machines which must pop arguments after a function call,
3696 the compiler normally lets arguments accumulate on the stack for several
3697 function calls and pops them all at once.
3699 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3703 Force memory operands to be copied into registers before doing
3704 arithmetic on them. This produces better code by making all memory
3705 references potential common subexpressions. When they are not common
3706 subexpressions, instruction combination should eliminate the separate
3709 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3712 @opindex fforce-addr
3713 Force memory address constants to be copied into registers before
3714 doing arithmetic on them. This may produce better code just as
3715 @option{-fforce-mem} may.
3717 @item -fomit-frame-pointer
3718 @opindex fomit-frame-pointer
3719 Don't keep the frame pointer in a register for functions that
3720 don't need one. This avoids the instructions to save, set up and
3721 restore frame pointers; it also makes an extra register available
3722 in many functions. @strong{It also makes debugging impossible on
3725 On some machines, such as the VAX, this flag has no effect, because
3726 the standard calling sequence automatically handles the frame pointer
3727 and nothing is saved by pretending it doesn't exist. The
3728 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3729 whether a target machine supports this flag. @xref{Registers,,Register
3730 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3732 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3734 @item -foptimize-sibling-calls
3735 @opindex foptimize-sibling-calls
3736 Optimize sibling and tail recursive calls.
3738 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3742 Don't pay attention to the @code{inline} keyword. Normally this option
3743 is used to keep the compiler from expanding any functions inline.
3744 Note that if you are not optimizing, no functions can be expanded inline.
3746 @item -finline-functions
3747 @opindex finline-functions
3748 Integrate all simple functions into their callers. The compiler
3749 heuristically decides which functions are simple enough to be worth
3750 integrating in this way.
3752 If all calls to a given function are integrated, and the function is
3753 declared @code{static}, then the function is normally not output as
3754 assembler code in its own right.
3756 Enabled at level @option{-O3}.
3758 @item -finline-limit=@var{n}
3759 @opindex finline-limit
3760 By default, gcc limits the size of functions that can be inlined. This flag
3761 allows the control of this limit for functions that are explicitly marked as
3762 inline (i.e., marked with the inline keyword or defined within the class
3763 definition in c++). @var{n} is the size of functions that can be inlined in
3764 number of pseudo instructions (not counting parameter handling). The default
3765 value of @var{n} is 600.
3766 Increasing this value can result in more inlined code at
3767 the cost of compilation time and memory consumption. Decreasing usually makes
3768 the compilation faster and less code will be inlined (which presumably
3769 means slower programs). This option is particularly useful for programs that
3770 use inlining heavily such as those based on recursive templates with C++.
3772 Inlining is actually controlled by a number of parameters, which may be
3773 specified individually by using @option{--param @var{name}=@var{value}}.
3774 The @option{-finline-limit=@var{n}} option sets some of these parameters
3778 @item max-inline-insns-single
3779 is set to @var{n}/2.
3780 @item max-inline-insns-auto
3781 is set to @var{n}/2.
3782 @item min-inline-insns
3783 is set to 130 or @var{n}/4, whichever is smaller.
3784 @item max-inline-insns-rtl
3788 See below for a documentation of the individual
3789 parameters controlling inlining.
3791 @emph{Note:} pseudo instruction represents, in this particular context, an
3792 abstract measurement of function's size. In no way, it represents a count
3793 of assembly instructions and as such its exact meaning might change from one
3794 release to an another.
3796 @item -fkeep-inline-functions
3797 @opindex fkeep-inline-functions
3798 Even if all calls to a given function are integrated, and the function
3799 is declared @code{static}, nevertheless output a separate run-time
3800 callable version of the function. This switch does not affect
3801 @code{extern inline} functions.
3803 @item -fkeep-static-consts
3804 @opindex fkeep-static-consts
3805 Emit variables declared @code{static const} when optimization isn't turned
3806 on, even if the variables aren't referenced.
3808 GCC enables this option by default. If you want to force the compiler to
3809 check if the variable was referenced, regardless of whether or not
3810 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3812 @item -fmerge-constants
3813 Attempt to merge identical constants (string constants and floating point
3814 constants) across compilation units.
3816 This option is the default for optimized compilation if the assembler and
3817 linker support it. Use @option{-fno-merge-constants} to inhibit this
3820 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3822 @item -fmerge-all-constants
3823 Attempt to merge identical constants and identical variables.
3825 This option implies @option{-fmerge-constants}. In addition to
3826 @option{-fmerge-constants} this considers e.g. even constant initialized
3827 arrays or initialized constant variables with integral or floating point
3828 types. Languages like C or C++ require each non-automatic variable to
3829 have distinct location, so using this option will result in non-conforming
3834 Use a graph coloring register allocator. Currently this option is meant
3835 for testing, so we are interested to hear about miscompilations with
3838 @item -fno-branch-count-reg
3839 @opindex fno-branch-count-reg
3840 Do not use ``decrement and branch'' instructions on a count register,
3841 but instead generate a sequence of instructions that decrement a
3842 register, compare it against zero, then branch based upon the result.
3843 This option is only meaningful on architectures that support such
3844 instructions, which include x86, PowerPC, IA-64 and S/390.
3846 The default is @option{-fbranch-count-reg}, enabled when
3847 @option{-fstrength-reduce} is enabled.
3849 @item -fno-function-cse
3850 @opindex fno-function-cse
3851 Do not put function addresses in registers; make each instruction that
3852 calls a constant function contain the function's address explicitly.
3854 This option results in less efficient code, but some strange hacks
3855 that alter the assembler output may be confused by the optimizations
3856 performed when this option is not used.
3858 The default is @option{-ffunction-cse}
3860 @item -fno-zero-initialized-in-bss
3861 @opindex fno-zero-initialized-in-bss
3862 If the target supports a BSS section, GCC by default puts variables that
3863 are initialized to zero into BSS@. This can save space in the resulting
3866 This option turns off this behavior because some programs explicitly
3867 rely on variables going to the data section. E.g., so that the
3868 resulting executable can find the beginning of that section and/or make
3869 assumptions based on that.
3871 The default is @option{-fzero-initialized-in-bss}.
3873 @item -fstrength-reduce
3874 @opindex fstrength-reduce
3875 Perform the optimizations of loop strength reduction and
3876 elimination of iteration variables.
3878 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3880 @item -fthread-jumps
3881 @opindex fthread-jumps
3882 Perform optimizations where we check to see if a jump branches to a
3883 location where another comparison subsumed by the first is found. If
3884 so, the first branch is redirected to either the destination of the
3885 second branch or a point immediately following it, depending on whether
3886 the condition is known to be true or false.
3888 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3890 @item -fcse-follow-jumps
3891 @opindex fcse-follow-jumps
3892 In common subexpression elimination, scan through jump instructions
3893 when the target of the jump is not reached by any other path. For
3894 example, when CSE encounters an @code{if} statement with an
3895 @code{else} clause, CSE will follow the jump when the condition
3898 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3900 @item -fcse-skip-blocks
3901 @opindex fcse-skip-blocks
3902 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3903 follow jumps which conditionally skip over blocks. When CSE
3904 encounters a simple @code{if} statement with no else clause,
3905 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3906 body of the @code{if}.
3908 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3910 @item -frerun-cse-after-loop
3911 @opindex frerun-cse-after-loop
3912 Re-run common subexpression elimination after loop optimizations has been
3915 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3917 @item -frerun-loop-opt
3918 @opindex frerun-loop-opt
3919 Run the loop optimizer twice.
3921 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3925 Perform a global common subexpression elimination pass.
3926 This pass also performs global constant and copy propagation.
3928 @emph{Note:} When compiling a program using computed gotos, a GCC
3929 extension, you may get better runtime performance if you disable
3930 the global common subexpression elimination pass by adding
3931 @option{-fno-gcse} to the command line.
3933 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3937 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3938 attempt to move loads which are only killed by stores into themselves. This
3939 allows a loop containing a load/store sequence to be changed to a load outside
3940 the loop, and a copy/store within the loop.
3942 Enabled by default when gcse is enabled.
3946 When @option{-fgcse-sm} is enabled, a store motion pass is run after
3947 global common subexpression elimination. This pass will attempt to move
3948 stores out of loops. When used in conjunction with @option{-fgcse-lm},
3949 loops containing a load/store sequence can be changed to a load before
3950 the loop and a store after the loop.
3952 Enabled by default when gcse is enabled.
3956 When @option{-fgcse-las} is enabled, the global common subexpression
3957 elimination pass eliminates redundant loads that come after stores to the
3958 same memory location (both partial and full redundancies).
3960 Enabled by default when gcse is enabled.
3962 @item -floop-optimize
3963 @opindex floop-optimize
3964 Perform loop optimizations: move constant expressions out of loops, simplify
3965 exit test conditions and optionally do strength-reduction and loop unrolling as
3968 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3970 @item -fcrossjumping
3971 @opindex crossjumping
3972 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3973 resulting code may or may not perform better than without cross-jumping.
3975 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3977 @item -fif-conversion
3978 @opindex if-conversion
3979 Attempt to transform conditional jumps into branch-less equivalents. This
3980 include use of conditional moves, min, max, set flags and abs instructions, and
3981 some tricks doable by standard arithmetics. The use of conditional execution
3982 on chips where it is available is controlled by @code{if-conversion2}.
3984 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3986 @item -fif-conversion2
3987 @opindex if-conversion2
3988 Use conditional execution (where available) to transform conditional jumps into
3989 branch-less equivalents.
3991 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3993 @item -fdelete-null-pointer-checks
3994 @opindex fdelete-null-pointer-checks
3995 Use global dataflow analysis to identify and eliminate useless checks
3996 for null pointers. The compiler assumes that dereferencing a null
3997 pointer would have halted the program. If a pointer is checked after
3998 it has already been dereferenced, it cannot be null.
4000 In some environments, this assumption is not true, and programs can
4001 safely dereference null pointers. Use
4002 @option{-fno-delete-null-pointer-checks} to disable this optimization
4003 for programs which depend on that behavior.
4005 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4007 @item -fexpensive-optimizations
4008 @opindex fexpensive-optimizations
4009 Perform a number of minor optimizations that are relatively expensive.
4011 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4013 @item -foptimize-register-move
4015 @opindex foptimize-register-move
4017 Attempt to reassign register numbers in move instructions and as
4018 operands of other simple instructions in order to maximize the amount of
4019 register tying. This is especially helpful on machines with two-operand
4022 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4025 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4027 @item -fdelayed-branch
4028 @opindex fdelayed-branch
4029 If supported for the target machine, attempt to reorder instructions
4030 to exploit instruction slots available after delayed branch
4033 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4035 @item -fschedule-insns
4036 @opindex fschedule-insns
4037 If supported for the target machine, attempt to reorder instructions to
4038 eliminate execution stalls due to required data being unavailable. This
4039 helps machines that have slow floating point or memory load instructions
4040 by allowing other instructions to be issued until the result of the load
4041 or floating point instruction is required.
4043 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4045 @item -fschedule-insns2
4046 @opindex fschedule-insns2
4047 Similar to @option{-fschedule-insns}, but requests an additional pass of
4048 instruction scheduling after register allocation has been done. This is
4049 especially useful on machines with a relatively small number of
4050 registers and where memory load instructions take more than one cycle.
4052 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4054 @item -fno-sched-interblock
4055 @opindex fno-sched-interblock
4056 Don't schedule instructions across basic blocks. This is normally
4057 enabled by default when scheduling before register allocation, i.e.@:
4058 with @option{-fschedule-insns} or at @option{-O2} or higher.
4060 @item -fno-sched-spec
4061 @opindex fno-sched-spec
4062 Don't allow speculative motion of non-load instructions. This is normally
4063 enabled by default when scheduling before register allocation, i.e.@:
4064 with @option{-fschedule-insns} or at @option{-O2} or higher.
4066 @item -fsched-spec-load
4067 @opindex fsched-spec-load
4068 Allow speculative motion of some load instructions. This only makes
4069 sense when scheduling before register allocation, i.e.@: with
4070 @option{-fschedule-insns} or at @option{-O2} or higher.
4072 @item -fsched-spec-load-dangerous
4073 @opindex fsched-spec-load-dangerous
4074 Allow speculative motion of more load instructions. This only makes
4075 sense when scheduling before register allocation, i.e.@: with
4076 @option{-fschedule-insns} or at @option{-O2} or higher.
4078 @item -fsched-stalled-insns=@var{n}
4079 @opindex fsched-stalled-insns
4080 Define how many insns (if any) can be moved prematurely from the queue
4081 of stalled insns into the ready list, during the second scheduling pass.
4083 @item -fsched-stalled-insns-dep=@var{n}
4084 @opindex fsched-stalled-insns-dep
4085 Define how many insn groups (cycles) will be examined for a dependency
4086 on a stalled insn that is candidate for premature removal from the queue
4087 of stalled insns. Has an effect only during the second scheduling pass,
4088 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4090 @item -fsched2-use-superblocks
4091 @opindex fsched2-use-superblocks
4092 When scheduling after register allocation, do use superblock scheduling
4093 algorithm. Superblock scheduling allows motion across basic block boundaries
4094 resulting on faster schedules. This option is experimental, as not all machine
4095 descriptions used by GCC model the CPU closely enough to avoid unreliable
4096 results from the algorithm.
4098 This only makes sense when scheduling after register allocation, i.e.@: with
4099 @option{-fschedule-insns2} or at @option{-O2} or higher.
4101 @item -fsched2-use-traces
4102 @opindex fsched2-use-traces
4103 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4104 allocation and additionally perform code duplication in order to increase the
4105 size of superblocks using tracer pass. See @option{-ftracer} for details on
4108 This mode should produce faster but significantly longer programs. Also
4109 without @code{-fbranch-probabilities} the traces constructed may not match the
4110 reality and hurt the performance. This only makes
4111 sense when scheduling after register allocation, i.e.@: with
4112 @option{-fschedule-insns2} or at @option{-O2} or higher.
4114 @item -fcaller-saves
4115 @opindex fcaller-saves
4116 Enable values to be allocated in registers that will be clobbered by
4117 function calls, by emitting extra instructions to save and restore the
4118 registers around such calls. Such allocation is done only when it
4119 seems to result in better code than would otherwise be produced.
4121 This option is always enabled by default on certain machines, usually
4122 those which have no call-preserved registers to use instead.
4124 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4126 @item -fmove-all-movables
4127 @opindex fmove-all-movables
4128 Forces all invariant computations in loops to be moved
4131 @item -freduce-all-givs
4132 @opindex freduce-all-givs
4133 Forces all general-induction variables in loops to be
4136 @emph{Note:} When compiling programs written in Fortran,
4137 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
4138 by default when you use the optimizer.
4140 These options may generate better or worse code; results are highly
4141 dependent on the structure of loops within the source code.
4143 These two options are intended to be removed someday, once
4144 they have helped determine the efficacy of various
4145 approaches to improving loop optimizations.
4147 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
4148 know how use of these options affects
4149 the performance of your production code.
4150 We're very interested in code that runs @emph{slower}
4151 when these options are @emph{enabled}.
4154 @itemx -fno-peephole2
4155 @opindex fno-peephole
4156 @opindex fno-peephole2
4157 Disable any machine-specific peephole optimizations. The difference
4158 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4159 are implemented in the compiler; some targets use one, some use the
4160 other, a few use both.
4162 @option{-fpeephole} is enabled by default.
4163 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4165 @item -fno-guess-branch-probability
4166 @opindex fno-guess-branch-probability
4167 Do not guess branch probabilities using a randomized model.
4169 Sometimes gcc will opt to use a randomized model to guess branch
4170 probabilities, when none are available from either profiling feedback
4171 (@option{-fprofile-arcs}) or @samp{__builtin_expect}. This means that
4172 different runs of the compiler on the same program may produce different
4175 In a hard real-time system, people don't want different runs of the
4176 compiler to produce code that has different behavior; minimizing
4177 non-determinism is of paramount import. This switch allows users to
4178 reduce non-determinism, possibly at the expense of inferior
4181 The default is @option{-fguess-branch-probability} at levels
4182 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4184 @item -freorder-blocks
4185 @opindex freorder-blocks
4186 Reorder basic blocks in the compiled function in order to reduce number of
4187 taken branches and improve code locality.
4189 Enabled at levels @option{-O2}, @option{-O3}.
4191 @item -freorder-functions
4192 @opindex freorder-functions
4193 Reorder basic blocks in the compiled function in order to reduce number of
4194 taken branches and improve code locality. This is implemented by using special
4195 subsections @code{text.hot} for most frequently executed functions and
4196 @code{text.unlikely} for unlikely executed functions. Reordering is done by
4197 the linker so object file format must support named sections and linker must
4198 place them in a reasonable way.
4200 Also profile feedback must be available in to make this option effective. See
4201 @option{-fprofile-arcs} for details.
4203 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4205 @item -fstrict-aliasing
4206 @opindex fstrict-aliasing
4207 Allows the compiler to assume the strictest aliasing rules applicable to
4208 the language being compiled. For C (and C++), this activates
4209 optimizations based on the type of expressions. In particular, an
4210 object of one type is assumed never to reside at the same address as an
4211 object of a different type, unless the types are almost the same. For
4212 example, an @code{unsigned int} can alias an @code{int}, but not a
4213 @code{void*} or a @code{double}. A character type may alias any other
4216 Pay special attention to code like this:
4229 The practice of reading from a different union member than the one most
4230 recently written to (called ``type-punning'') is common. Even with
4231 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4232 is accessed through the union type. So, the code above will work as
4233 expected. However, this code might not:
4244 Every language that wishes to perform language-specific alias analysis
4245 should define a function that computes, given an @code{tree}
4246 node, an alias set for the node. Nodes in different alias sets are not
4247 allowed to alias. For an example, see the C front-end function
4248 @code{c_get_alias_set}.
4250 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4252 @item -falign-functions
4253 @itemx -falign-functions=@var{n}
4254 @opindex falign-functions
4255 Align the start of functions to the next power-of-two greater than
4256 @var{n}, skipping up to @var{n} bytes. For instance,
4257 @option{-falign-functions=32} aligns functions to the next 32-byte
4258 boundary, but @option{-falign-functions=24} would align to the next
4259 32-byte boundary only if this can be done by skipping 23 bytes or less.
4261 @option{-fno-align-functions} and @option{-falign-functions=1} are
4262 equivalent and mean that functions will not be aligned.
4264 Some assemblers only support this flag when @var{n} is a power of two;
4265 in that case, it is rounded up.
4267 If @var{n} is not specified or is zero, use a machine-dependent default.
4269 Enabled at levels @option{-O2}, @option{-O3}.
4271 @item -falign-labels
4272 @itemx -falign-labels=@var{n}
4273 @opindex falign-labels
4274 Align all branch targets to a power-of-two boundary, skipping up to
4275 @var{n} bytes like @option{-falign-functions}. This option can easily
4276 make code slower, because it must insert dummy operations for when the
4277 branch target is reached in the usual flow of the code.
4279 @option{-fno-align-labels} and @option{-falign-labels=1} are
4280 equivalent and mean that labels will not be aligned.
4282 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4283 are greater than this value, then their values are used instead.
4285 If @var{n} is not specified or is zero, use a machine-dependent default
4286 which is very likely to be @samp{1}, meaning no alignment.
4288 Enabled at levels @option{-O2}, @option{-O3}.
4291 @itemx -falign-loops=@var{n}
4292 @opindex falign-loops
4293 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4294 like @option{-falign-functions}. The hope is that the loop will be
4295 executed many times, which will make up for any execution of the dummy
4298 @option{-fno-align-loops} and @option{-falign-loops=1} are
4299 equivalent and mean that loops will not be aligned.
4301 If @var{n} is not specified or is zero, use a machine-dependent default.
4303 Enabled at levels @option{-O2}, @option{-O3}.
4306 @itemx -falign-jumps=@var{n}
4307 @opindex falign-jumps
4308 Align branch targets to a power-of-two boundary, for branch targets
4309 where the targets can only be reached by jumping, skipping up to @var{n}
4310 bytes like @option{-falign-functions}. In this case, no dummy operations
4313 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4314 equivalent and mean that loops will not be aligned.
4316 If @var{n} is not specified or is zero, use a machine-dependent default.
4318 Enabled at levels @option{-O2}, @option{-O3}.
4320 @item -frename-registers
4321 @opindex frename-registers
4322 Attempt to avoid false dependencies in scheduled code by making use
4323 of registers left over after register allocation. This optimization
4324 will most benefit processors with lots of registers. It can, however,
4325 make debugging impossible, since variables will no longer stay in
4326 a ``home register''.
4330 Constructs webs as commonly used for register allocation purposes and assign
4331 each web individual pseudo register. This allows our register allocation pass
4332 to operate on pseudos directly, but also strengthens several other optimization
4333 passes, such as CSE, loop optimizer and trivial dead code remover. It can,
4334 however, make debugging impossible, since variables will no longer stay in a
4337 Enabled at levels @option{-O3}.
4339 @item -fno-cprop-registers
4340 @opindex fno-cprop-registers
4341 After register allocation and post-register allocation instruction splitting,
4342 we perform a copy-propagation pass to try to reduce scheduling dependencies
4343 and occasionally eliminate the copy.
4345 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4347 @item -fprofile-generate
4348 @opindex fprofile-generate
4349 Enable options usually used for instrumenting application to produce profile usefull
4350 for later recompilation profile feedback based optimization.
4352 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}
4355 @opindex fprofile-use
4356 Enable profile feedback directed optimizations, and optimizations
4357 generally profitable only with profile feedback available.
4359 The following options are enabled: @code{-fbranch-probabilities},
4360 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
4364 The following options control compiler behavior regarding floating
4365 point arithmetic. These options trade off between speed and
4366 correctness. All must be specifically enabled.
4370 @opindex ffloat-store
4371 Do not store floating point variables in registers, and inhibit other
4372 options that might change whether a floating point value is taken from a
4375 @cindex floating point precision
4376 This option prevents undesirable excess precision on machines such as
4377 the 68000 where the floating registers (of the 68881) keep more
4378 precision than a @code{double} is supposed to have. Similarly for the
4379 x86 architecture. For most programs, the excess precision does only
4380 good, but a few programs rely on the precise definition of IEEE floating
4381 point. Use @option{-ffloat-store} for such programs, after modifying
4382 them to store all pertinent intermediate computations into variables.
4386 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4387 @option{-fno-trapping-math}, @option{-ffinite-math-only},
4388 @option{-fno-rounding-math} and @option{-fno-signaling-nans}.
4390 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4392 This option should never be turned on by any @option{-O} option since
4393 it can result in incorrect output for programs which depend on
4394 an exact implementation of IEEE or ISO rules/specifications for
4397 @item -fno-math-errno
4398 @opindex fno-math-errno
4399 Do not set ERRNO after calling math functions that are executed
4400 with a single instruction, e.g., sqrt. A program that relies on
4401 IEEE exceptions for math error handling may want to use this flag
4402 for speed while maintaining IEEE arithmetic compatibility.
4404 This option should never be turned on by any @option{-O} option since
4405 it can result in incorrect output for programs which depend on
4406 an exact implementation of IEEE or ISO rules/specifications for
4409 The default is @option{-fmath-errno}.
4411 @item -funsafe-math-optimizations
4412 @opindex funsafe-math-optimizations
4413 Allow optimizations for floating-point arithmetic that (a) assume
4414 that arguments and results are valid and (b) may violate IEEE or
4415 ANSI standards. When used at link-time, it may include libraries
4416 or startup files that change the default FPU control word or other
4417 similar optimizations.
4419 This option should never be turned on by any @option{-O} option since
4420 it can result in incorrect output for programs which depend on
4421 an exact implementation of IEEE or ISO rules/specifications for
4424 The default is @option{-fno-unsafe-math-optimizations}.
4426 @item -ffinite-math-only
4427 @opindex ffinite-math-only
4428 Allow optimizations for floating-point arithmetic that assume
4429 that arguments and results are not NaNs or +-Infs.
4431 This option should never be turned on by any @option{-O} option since
4432 it can result in incorrect output for programs which depend on
4433 an exact implementation of IEEE or ISO rules/specifications.
4435 The default is @option{-fno-finite-math-only}.
4437 @item -fno-trapping-math
4438 @opindex fno-trapping-math
4439 Compile code assuming that floating-point operations cannot generate
4440 user-visible traps. These traps include division by zero, overflow,
4441 underflow, inexact result and invalid operation. This option implies
4442 @option{-fno-signaling-nans}. Setting this option may allow faster
4443 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4445 This option should never be turned on by any @option{-O} option since
4446 it can result in incorrect output for programs which depend on
4447 an exact implementation of IEEE or ISO rules/specifications for
4450 The default is @option{-ftrapping-math}.
4452 @item -frounding-math
4453 @opindex frounding-math
4454 Disable transformations and optimizations that assume default floating
4455 point rounding behavior. This is round-to-zero for all floating point
4456 to integer conversions, and round-to-nearest for all other arithmetic
4457 truncations. This option should be specified for programs that change
4458 the FP rounding mode dynamically, or that may be executed with a
4459 non-default rounding mode. This option disables constant folding of
4460 floating point expressions at compile-time (which may be affected by
4461 rounding mode) and arithmetic transformations that are unsafe in the
4462 presence of sign-dependent rounding modes.
4464 The default is @option{-fno-rounding-math}.
4466 This option is experimental and does not currently guarantee to
4467 disable all GCC optimizations that are affected by rounding mode.
4468 Future versions of gcc may provide finer control of this setting
4469 using C99's @code{FENV_ACCESS} pragma. This command line option
4470 will be used to specify the default state for @code{FENV_ACCESS}.
4472 @item -fsignaling-nans
4473 @opindex fsignaling-nans
4474 Compile code assuming that IEEE signaling NaNs may generate user-visible
4475 traps during floating-point operations. Setting this option disables
4476 optimizations that may change the number of exceptions visible with
4477 signaling NaNs. This option implies @option{-ftrapping-math}.
4479 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4482 The default is @option{-fno-signaling-nans}.
4484 This option is experimental and does not currently guarantee to
4485 disable all GCC optimizations that affect signaling NaN behavior.
4487 @item -fsingle-precision-constant
4488 @opindex fsingle-precision-constant
4489 Treat floating point constant as single precision constant instead of
4490 implicitly converting it to double precision constant.
4495 The following options control optimizations that may improve
4496 performance, but are not enabled by any @option{-O} options. This
4497 section includes experimental options that may produce broken code.
4500 @item -fbranch-probabilities
4501 @opindex fbranch-probabilities
4502 After running a program compiled with @option{-fprofile-arcs}
4503 (@pxref{Debugging Options,, Options for Debugging Your Program or
4504 @command{gcc}}), you can compile it a second time using
4505 @option{-fbranch-probabilities}, to improve optimizations based on
4506 the number of times each branch was taken. When the program
4507 compiled with @option{-fprofile-arcs} exits it saves arc execution
4508 counts to a file called @file{@var{sourcename}.gcda} for each source
4509 file The information in this data file is very dependent on the
4510 structure of the generated code, so you must use the same source code
4511 and the same optimization options for both compilations.
4513 With @option{-fbranch-probabilities}, GCC puts a
4514 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4515 These can be used to improve optimization. Currently, they are only
4516 used in one place: in @file{reorg.c}, instead of guessing which path a
4517 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4518 exactly determine which path is taken more often.
4520 @item -fprofile-values
4521 @opindex fprofile-values
4522 If combined with @option{-fprofile-arcs}, it adds code so that some
4523 data about values of expressions in the program is gathered.
4525 With @option{-fbranch-probabilities}, it reads back the data gathered
4526 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
4527 notes to instructions for their later usage in optimizations.
4531 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
4532 a code to gather information about values of expressions.
4534 With @option{-fbranch-probabilities}, it reads back the data gathered
4535 and actually performs the optimizations based on them.
4536 Currently the optimizations include specialization of division operation
4537 using the knowledge about the value of the denominator.
4541 Use a graph coloring register allocator. Currently this option is meant
4542 for testing, so we are interested to hear about miscompilations with
4547 Perform tail duplication to enlarge superblock size. This transformation
4548 simplifies the control flow of the function allowing other optimizations to do
4551 @item -funit-at-a-time
4552 @opindex funit-at-a-time
4553 Parse the whole compilation unit before starting to produce code.
4554 This allows some extra optimizations to take place but consumes more
4557 @item -funroll-loops
4558 @opindex funroll-loops
4559 Unroll loops whose number of iterations can be determined at compile time or
4560 upon entry to the loop. @option{-funroll-loops} implies
4561 @option{-frerun-cse-after-loop}. It also turns on complete loop peeling
4562 (i.e. complete removal of loops with small constant number of iterations).
4563 This option makes code larger, and may or may not make it run faster.
4565 @item -funroll-all-loops
4566 @opindex funroll-all-loops
4567 Unroll all loops, even if their number of iterations is uncertain when
4568 the loop is entered. This usually makes programs run more slowly.
4569 @option{-funroll-all-loops} implies the same options as
4570 @option{-funroll-loops}.
4573 @opindex fpeel-loops
4574 Peels the loops for that there is enough information that they do not
4575 roll much (from profile feedback). It also turns on complete loop peeling
4576 (i.e. complete removal of loops with small constant number of iterations).
4578 @item -funswitch-loops
4579 @opindex funswitch-loops
4580 Move branches with loop invariant conditions out of the loop, with duplicates
4581 of the loop on both branches (modified according to result of the condition).
4583 @item -fold-unroll-loops
4584 @opindex fold-unroll-loops
4585 Unroll loops whose number of iterations can be determined at compile
4586 time or upon entry to the loop, using the old loop unroller whose loop
4587 recognition is based on notes from frontend. @option{-fold-unroll-loops} implies
4588 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}. This
4589 option makes code larger, and may or may not make it run faster.
4591 @item -fold-unroll-all-loops
4592 @opindex fold-unroll-all-loops
4593 Unroll all loops, even if their number of iterations is uncertain when
4594 the loop is entered. This is done using the old loop unroller whose loop
4595 recognition is based on notes from frontend. This usually makes programs run more slowly.
4596 @option{-fold-unroll-all-loops} implies the same options as
4597 @option{-fold-unroll-loops}.
4599 @item -funswitch-loops
4600 @opindex funswitch-loops
4601 Move branches with loop invariant conditions out of the loop, with duplicates
4602 of the loop on both branches (modified according to result of the condition).
4604 @item -funswitch-loops
4605 @opindex funswitch-loops
4606 Move branches with loop invariant conditions out of the loop, with duplicates
4607 of the loop on both branches (modified according to result of the condition).
4609 @item -fprefetch-loop-arrays
4610 @opindex fprefetch-loop-arrays
4611 If supported by the target machine, generate instructions to prefetch
4612 memory to improve the performance of loops that access large arrays.
4614 Disabled at level @option{-Os}.
4616 @item -ffunction-sections
4617 @itemx -fdata-sections
4618 @opindex ffunction-sections
4619 @opindex fdata-sections
4620 Place each function or data item into its own section in the output
4621 file if the target supports arbitrary sections. The name of the
4622 function or the name of the data item determines the section's name
4625 Use these options on systems where the linker can perform optimizations
4626 to improve locality of reference in the instruction space. Most systems
4627 using the ELF object format and SPARC processors running Solaris 2 have
4628 linkers with such optimizations. AIX may have these optimizations in
4631 Only use these options when there are significant benefits from doing
4632 so. When you specify these options, the assembler and linker will
4633 create larger object and executable files and will also be slower.
4634 You will not be able to use @code{gprof} on all systems if you
4635 specify this option and you may have problems with debugging if
4636 you specify both this option and @option{-g}.
4638 @item -fbranch-target-load-optimize
4639 @opindex fbranch-target-load-optimize
4640 Perform branch target register load optimization before prologue / epilogue
4642 The use of target registers can typically be exposed only during reload,
4643 thus hoisting loads out of loops and doing inter-block scheduling needs
4644 a separate optimization pass.
4646 @item -fbranch-target-load-optimize2
4647 @opindex fbranch-target-load-optimize2
4648 Perform branch target register load optimization after prologue / epilogue
4651 @item -fbtr-bb-exclusive
4652 @opindex fbtr-bb-exclusive
4653 WHen performing branch target register load optimization, don't reuse
4654 branch target registers in within any basic block.
4656 @item --param @var{name}=@var{value}
4658 In some places, GCC uses various constants to control the amount of
4659 optimization that is done. For example, GCC will not inline functions
4660 that contain more that a certain number of instructions. You can
4661 control some of these constants on the command-line using the
4662 @option{--param} option.
4664 The names of specific parameters, and the meaning of the values, are
4665 tied to the internals of the compiler, and are subject to change
4666 without notice in future releases.
4668 In each case, the @var{value} is an integer. The allowable choices for
4669 @var{name} are given in the following table:
4672 @item max-crossjump-edges
4673 The maximum number of incoming edges to consider for crossjumping.
4674 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
4675 the number of edges incoming to each block. Increasing values mean
4676 more aggressive optimization, making the compile time increase with
4677 probably small improvement in executable size.
4679 @item max-delay-slot-insn-search
4680 The maximum number of instructions to consider when looking for an
4681 instruction to fill a delay slot. If more than this arbitrary number of
4682 instructions is searched, the time savings from filling the delay slot
4683 will be minimal so stop searching. Increasing values mean more
4684 aggressive optimization, making the compile time increase with probably
4685 small improvement in executable run time.
4687 @item max-delay-slot-live-search
4688 When trying to fill delay slots, the maximum number of instructions to
4689 consider when searching for a block with valid live register
4690 information. Increasing this arbitrarily chosen value means more
4691 aggressive optimization, increasing the compile time. This parameter
4692 should be removed when the delay slot code is rewritten to maintain the
4695 @item max-gcse-memory
4696 The approximate maximum amount of memory that will be allocated in
4697 order to perform the global common subexpression elimination
4698 optimization. If more memory than specified is required, the
4699 optimization will not be done.
4701 @item max-gcse-passes
4702 The maximum number of passes of GCSE to run.
4704 @item max-pending-list-length
4705 The maximum number of pending dependencies scheduling will allow
4706 before flushing the current state and starting over. Large functions
4707 with few branches or calls can create excessively large lists which
4708 needlessly consume memory and resources.
4710 @item max-inline-insns-single
4711 Several parameters control the tree inliner used in gcc.
4712 This number sets the maximum number of instructions (counted in gcc's
4713 internal representation) in a single function that the tree inliner
4714 will consider for inlining. This only affects functions declared
4715 inline and methods implemented in a class declaration (C++).
4716 The default value is 500.
4718 @item max-inline-insns-auto
4719 When you use @option{-finline-functions} (included in @option{-O3}),
4720 a lot of functions that would otherwise not be considered for inlining
4721 by the compiler will be investigated. To those functions, a different
4722 (more restrictive) limit compared to functions declared inline can
4724 The default value is 120.
4726 @item large-function-insns
4727 The limit specifying really large functions. For functions greater than this
4728 limit inlining is constrained by @option{--param large-function-growth}.
4729 This parameter is useful primarily to avoid extreme compilation time caused by non-linear
4730 algorithms used by the backend.
4731 This parameter is ignored when @option{-funit-at-a-time} is not used.
4732 The default value is 3000.
4734 @item large-function-growth
4735 Specifies maximal growth of large function caused by inlining in percents.
4736 This parameter is ignored when @option{-funit-at-a-time} is not used.
4737 The default value is 200.
4739 @item inline-unit-growth
4740 Specifies maximal overall growth of the compilation unit caused by inlining.
4741 This parameter is ignored when @option{-funit-at-a-time} is not used.
4742 The default value is 150.
4744 @item max-inline-insns-rtl
4745 For languages that use the RTL inliner (this happens at a later stage
4746 than tree inlining), you can set the maximum allowable size (counted
4747 in RTL instructions) for the RTL inliner with this parameter.
4748 The default value is 600.
4750 @item max-unrolled-insns
4751 The maximum number of instructions that a loop should have if that loop
4752 is unrolled, and if the loop is unrolled, it determines how many times
4753 the loop code is unrolled.
4755 @item max-average-unrolled-insns
4756 The maximum number of instructions biased by probabilities of their execution
4757 that a loop should have if that loop is unrolled, and if the loop is unrolled,
4758 it determines how many times the loop code is unrolled.
4760 @item max-unroll-times
4761 The maximum number of unrollings of a single loop.
4763 @item max-peeled-insns
4764 The maximum number of instructions that a loop should have if that loop
4765 is peeled, and if the loop is peeled, it determines how many times
4766 the loop code is peeled.
4768 @item max-peel-times
4769 The maximum number of peelings of a single loop.
4771 @item max-completely-peeled-insns
4772 The maximum number of insns of a completely peeled loop.
4774 @item max-completely-peel-times
4775 The maximum number of iterations of a loop to be suitable for complete peeling.
4777 @item max-unswitch-insns
4778 The maximum number of insns of an unswitched loop.
4780 @item max-unswitch-level
4781 The maximum number of branches unswitched in a single loop.
4783 @item hot-bb-count-fraction
4784 Select fraction of the maximal count of repetitions of basic block in program
4785 given basic block needs to have to be considered hot.
4787 @item hot-bb-frequency-fraction
4788 Select fraction of the maximal frequency of executions of basic block in
4789 function given basic block needs to have to be considered hot
4791 @item tracer-dynamic-coverage
4792 @itemx tracer-dynamic-coverage-feedback
4794 This value is used to limit superblock formation once the given percentage of
4795 executed instructions is covered. This limits unnecessary code size
4798 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4799 feedback is available. The real profiles (as opposed to statically estimated
4800 ones) are much less balanced allowing the threshold to be larger value.
4802 @item tracer-max-code-growth
4803 Stop tail duplication once code growth has reached given percentage. This is
4804 rather hokey argument, as most of the duplicates will be eliminated later in
4805 cross jumping, so it may be set to much higher values than is the desired code
4808 @item tracer-min-branch-ratio
4810 Stop reverse growth when the reverse probability of best edge is less than this
4811 threshold (in percent).
4813 @item tracer-min-branch-ratio
4814 @itemx tracer-min-branch-ratio-feedback
4816 Stop forward growth if the best edge do have probability lower than this
4819 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4820 compilation for profile feedback and one for compilation without. The value
4821 for compilation with profile feedback needs to be more conservative (higher) in
4822 order to make tracer effective.
4824 @item max-cse-path-length
4826 Maximum number of basic blocks on path that cse considers.
4828 @item ggc-min-expand
4830 GCC uses a garbage collector to manage its own memory allocation. This
4831 parameter specifies the minimum percentage by which the garbage
4832 collector's heap should be allowed to expand between collections.
4833 Tuning this may improve compilation speed; it has no effect on code
4836 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
4837 RAM >= 1GB. If @code{getrlimit} is available, the notion of "RAM" is
4838 the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS. If
4839 GCC is not able to calculate RAM on a particular platform, the lower
4840 bound of 30% is used. Setting this parameter and
4841 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4842 every opportunity. This is extremely slow, but can be useful for
4845 @item ggc-min-heapsize
4847 Minimum size of the garbage collector's heap before it begins bothering
4848 to collect garbage. The first collection occurs after the heap expands
4849 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}. Again,
4850 tuning this may improve compilation speed, and has no effect on code
4853 The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
4854 upper bound of 131072 (128 megabytes). If @code{getrlimit} is
4855 available, the notion of "RAM" is the smallest of actual RAM,
4856 RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS. If GCC is not able to calculate
4857 RAM on a particular platform, the lower bound is used. Setting this
4858 parameter very large effectively disables garbage collection. Setting
4859 this parameter and @option{ggc-min-expand} to zero causes a full
4860 collection to occur at every opportunity.
4862 @item max-reload-search-insns
4863 The maximum number of instruction reload should look backward for equivalent
4864 register. Increasing values mean more aggressive optimization, making the
4865 compile time increase with probably slightly better performance. The default
4868 @item max-cselib-memory-location
4869 The maximum number of memory locations cselib should take into acount.
4870 Increasing values mean more aggressive optimization, making the compile time
4871 increase with probably slightly better performance. The default value is 500.
4873 @item reorder-blocks-duplicate
4874 @itemx reorder-blocks-duplicate-feedback
4876 Used by basic block reordering pass to decide whether to use unconditional
4877 branch or duplicate the code on its destination. Code is duplicated when its
4878 estimated size is smaller than this value multiplied by the estimated size of
4879 unconditional jump in the hot spots of the program.
4881 The @option{reorder-block-duplicate-feedback} is used only when profile
4882 feedback is available and may be set to higher values than
4883 @option{reorder-block-duplicate} since information about the hot spots is more
4888 @node Preprocessor Options
4889 @section Options Controlling the Preprocessor
4890 @cindex preprocessor options
4891 @cindex options, preprocessor
4893 These options control the C preprocessor, which is run on each C source
4894 file before actual compilation.
4896 If you use the @option{-E} option, nothing is done except preprocessing.
4897 Some of these options make sense only together with @option{-E} because
4898 they cause the preprocessor output to be unsuitable for actual
4903 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4904 and pass @var{option} directly through to the preprocessor. If
4905 @var{option} contains commas, it is split into multiple options at the
4906 commas. However, many options are modified, translated or interpreted
4907 by the compiler driver before being passed to the preprocessor, and
4908 @option{-Wp} forcibly bypasses this phase. The preprocessor's direct
4909 interface is undocumented and subject to change, so whenever possible
4910 you should avoid using @option{-Wp} and let the driver handle the
4913 @item -Xpreprocessor @var{option}
4914 @opindex preprocessor
4915 Pass @var{option} as an option to the preprocessor. You can use this to
4916 supply system-specific preprocessor options which GCC does not know how to
4919 If you want to pass an option that takes an argument, you must use
4920 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4923 @include cppopts.texi
4925 @node Assembler Options
4926 @section Passing Options to the Assembler
4928 @c prevent bad page break with this line
4929 You can pass options to the assembler.
4932 @item -Wa,@var{option}
4934 Pass @var{option} as an option to the assembler. If @var{option}
4935 contains commas, it is split into multiple options at the commas.
4937 @item -Xassembler @var{option}
4939 Pass @var{option} as an option to the assembler. You can use this to
4940 supply system-specific assembler options which GCC does not know how to
4943 If you want to pass an option that takes an argument, you must use
4944 @option{-Xassembler} twice, once for the option and once for the argument.
4949 @section Options for Linking
4950 @cindex link options
4951 @cindex options, linking
4953 These options come into play when the compiler links object files into
4954 an executable output file. They are meaningless if the compiler is
4955 not doing a link step.
4959 @item @var{object-file-name}
4960 A file name that does not end in a special recognized suffix is
4961 considered to name an object file or library. (Object files are
4962 distinguished from libraries by the linker according to the file
4963 contents.) If linking is done, these object files are used as input
4972 If any of these options is used, then the linker is not run, and
4973 object file names should not be used as arguments. @xref{Overall
4977 @item -l@var{library}
4978 @itemx -l @var{library}
4980 Search the library named @var{library} when linking. (The second
4981 alternative with the library as a separate argument is only for
4982 POSIX compliance and is not recommended.)
4984 It makes a difference where in the command you write this option; the
4985 linker searches and processes libraries and object files in the order they
4986 are specified. Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4987 after file @file{foo.o} but before @file{bar.o}. If @file{bar.o} refers
4988 to functions in @samp{z}, those functions may not be loaded.
4990 The linker searches a standard list of directories for the library,
4991 which is actually a file named @file{lib@var{library}.a}. The linker
4992 then uses this file as if it had been specified precisely by name.
4994 The directories searched include several standard system directories
4995 plus any that you specify with @option{-L}.
4997 Normally the files found this way are library files---archive files
4998 whose members are object files. The linker handles an archive file by
4999 scanning through it for members which define symbols that have so far
5000 been referenced but not defined. But if the file that is found is an
5001 ordinary object file, it is linked in the usual fashion. The only
5002 difference between using an @option{-l} option and specifying a file name
5003 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5004 and searches several directories.
5008 You need this special case of the @option{-l} option in order to
5009 link an Objective-C program.
5012 @opindex nostartfiles
5013 Do not use the standard system startup files when linking.
5014 The standard system libraries are used normally, unless @option{-nostdlib}
5015 or @option{-nodefaultlibs} is used.
5017 @item -nodefaultlibs
5018 @opindex nodefaultlibs
5019 Do not use the standard system libraries when linking.
5020 Only the libraries you specify will be passed to the linker.
5021 The standard startup files are used normally, unless @option{-nostartfiles}
5022 is used. The compiler may generate calls to memcmp, memset, and memcpy
5023 for System V (and ISO C) environments or to bcopy and bzero for
5024 BSD environments. These entries are usually resolved by entries in
5025 libc. These entry points should be supplied through some other
5026 mechanism when this option is specified.
5030 Do not use the standard system startup files or libraries when linking.
5031 No startup files and only the libraries you specify will be passed to
5032 the linker. The compiler may generate calls to memcmp, memset, and memcpy
5033 for System V (and ISO C) environments or to bcopy and bzero for
5034 BSD environments. These entries are usually resolved by entries in
5035 libc. These entry points should be supplied through some other
5036 mechanism when this option is specified.
5038 @cindex @option{-lgcc}, use with @option{-nostdlib}
5039 @cindex @option{-nostdlib} and unresolved references
5040 @cindex unresolved references and @option{-nostdlib}
5041 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5042 @cindex @option{-nodefaultlibs} and unresolved references
5043 @cindex unresolved references and @option{-nodefaultlibs}
5044 One of the standard libraries bypassed by @option{-nostdlib} and
5045 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5046 that GCC uses to overcome shortcomings of particular machines, or special
5047 needs for some languages.
5048 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5049 Collection (GCC) Internals},
5050 for more discussion of @file{libgcc.a}.)
5051 In most cases, you need @file{libgcc.a} even when you want to avoid
5052 other standard libraries. In other words, when you specify @option{-nostdlib}
5053 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5054 This ensures that you have no unresolved references to internal GCC
5055 library subroutines. (For example, @samp{__main}, used to ensure C++
5056 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5057 GNU Compiler Collection (GCC) Internals}.)
5061 Produce a position independent executable on targets which support it.
5062 For predictable results, you must also specify the same set of options
5063 that were used to generate code (@option{-fpie}, @option{-fPIE},
5064 or model suboptions) when you specify this option.
5068 Remove all symbol table and relocation information from the executable.
5072 On systems that support dynamic linking, this prevents linking with the shared
5073 libraries. On other systems, this option has no effect.
5077 Produce a shared object which can then be linked with other objects to
5078 form an executable. Not all systems support this option. For predictable
5079 results, you must also specify the same set of options that were used to
5080 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5081 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5082 needs to build supplementary stub code for constructors to work. On
5083 multi-libbed systems, @samp{gcc -shared} must select the correct support
5084 libraries to link against. Failing to supply the correct flags may lead
5085 to subtle defects. Supplying them in cases where they are not necessary
5088 @item -shared-libgcc
5089 @itemx -static-libgcc
5090 @opindex shared-libgcc
5091 @opindex static-libgcc
5092 On systems that provide @file{libgcc} as a shared library, these options
5093 force the use of either the shared or static version respectively.
5094 If no shared version of @file{libgcc} was built when the compiler was
5095 configured, these options have no effect.
5097 There are several situations in which an application should use the
5098 shared @file{libgcc} instead of the static version. The most common
5099 of these is when the application wishes to throw and catch exceptions
5100 across different shared libraries. In that case, each of the libraries
5101 as well as the application itself should use the shared @file{libgcc}.
5103 Therefore, the G++ and GCJ drivers automatically add
5104 @option{-shared-libgcc} whenever you build a shared library or a main
5105 executable, because C++ and Java programs typically use exceptions, so
5106 this is the right thing to do.
5108 If, instead, you use the GCC driver to create shared libraries, you may
5109 find that they will not always be linked with the shared @file{libgcc}.
5110 If GCC finds, at its configuration time, that you have a GNU linker that
5111 does not support option @option{--eh-frame-hdr}, it will link the shared
5112 version of @file{libgcc} into shared libraries by default. Otherwise,
5113 it will take advantage of the linker and optimize away the linking with
5114 the shared version of @file{libgcc}, linking with the static version of
5115 libgcc by default. This allows exceptions to propagate through such
5116 shared libraries, without incurring relocation costs at library load
5119 However, if a library or main executable is supposed to throw or catch
5120 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5121 for the languages used in the program, or using the option
5122 @option{-shared-libgcc}, such that it is linked with the shared
5127 Bind references to global symbols when building a shared object. Warn
5128 about any unresolved references (unless overridden by the link editor
5129 option @samp{-Xlinker -z -Xlinker defs}). Only a few systems support
5132 @item -Xlinker @var{option}
5134 Pass @var{option} as an option to the linker. You can use this to
5135 supply system-specific linker options which GCC does not know how to
5138 If you want to pass an option that takes an argument, you must use
5139 @option{-Xlinker} twice, once for the option and once for the argument.
5140 For example, to pass @option{-assert definitions}, you must write
5141 @samp{-Xlinker -assert -Xlinker definitions}. It does not work to write
5142 @option{-Xlinker "-assert definitions"}, because this passes the entire
5143 string as a single argument, which is not what the linker expects.
5145 @item -Wl,@var{option}
5147 Pass @var{option} as an option to the linker. If @var{option} contains
5148 commas, it is split into multiple options at the commas.
5150 @item -u @var{symbol}
5152 Pretend the symbol @var{symbol} is undefined, to force linking of
5153 library modules to define it. You can use @option{-u} multiple times with
5154 different symbols to force loading of additional library modules.
5157 @node Directory Options
5158 @section Options for Directory Search
5159 @cindex directory options
5160 @cindex options, directory search
5163 These options specify directories to search for header files, for
5164 libraries and for parts of the compiler:
5169 Add the directory @var{dir} to the head of the list of directories to be
5170 searched for header files. This can be used to override a system header
5171 file, substituting your own version, since these directories are
5172 searched before the system header file directories. However, you should
5173 not use this option to add directories that contain vendor-supplied
5174 system header files (use @option{-isystem} for that). If you use more than
5175 one @option{-I} option, the directories are scanned in left-to-right
5176 order; the standard system directories come after.
5178 If a standard system include directory, or a directory specified with
5179 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
5180 option will be ignored. The directory will still be searched but as a
5181 system directory at its normal position in the system include chain.
5182 This is to ensure that GCC's procedure to fix buggy system headers and
5183 the ordering for the include_next directive are not inadvertently changed.
5184 If you really need to change the search order for system directories,
5185 use the @option{-nostdinc} and/or @option{-isystem} options.
5189 Any directories you specify with @option{-I} options before the @option{-I-}
5190 option are searched only for the case of @samp{#include "@var{file}"};
5191 they are not searched for @samp{#include <@var{file}>}.
5193 If additional directories are specified with @option{-I} options after
5194 the @option{-I-}, these directories are searched for all @samp{#include}
5195 directives. (Ordinarily @emph{all} @option{-I} directories are used
5198 In addition, the @option{-I-} option inhibits the use of the current
5199 directory (where the current input file came from) as the first search
5200 directory for @samp{#include "@var{file}"}. There is no way to
5201 override this effect of @option{-I-}. With @option{-I.} you can specify
5202 searching the directory which was current when the compiler was
5203 invoked. That is not exactly the same as what the preprocessor does
5204 by default, but it is often satisfactory.
5206 @option{-I-} does not inhibit the use of the standard system directories
5207 for header files. Thus, @option{-I-} and @option{-nostdinc} are
5212 Add directory @var{dir} to the list of directories to be searched
5215 @item -B@var{prefix}
5217 This option specifies where to find the executables, libraries,
5218 include files, and data files of the compiler itself.
5220 The compiler driver program runs one or more of the subprograms
5221 @file{cpp}, @file{cc1}, @file{as} and @file{ld}. It tries
5222 @var{prefix} as a prefix for each program it tries to run, both with and
5223 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5225 For each subprogram to be run, the compiler driver first tries the
5226 @option{-B} prefix, if any. If that name is not found, or if @option{-B}
5227 was not specified, the driver tries two standard prefixes, which are
5228 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}. If neither of
5229 those results in a file name that is found, the unmodified program
5230 name is searched for using the directories specified in your
5231 @env{PATH} environment variable.
5233 The compiler will check to see if the path provided by the @option{-B}
5234 refers to a directory, and if necessary it will add a directory
5235 separator character at the end of the path.
5237 @option{-B} prefixes that effectively specify directory names also apply
5238 to libraries in the linker, because the compiler translates these
5239 options into @option{-L} options for the linker. They also apply to
5240 includes files in the preprocessor, because the compiler translates these
5241 options into @option{-isystem} options for the preprocessor. In this case,
5242 the compiler appends @samp{include} to the prefix.
5244 The run-time support file @file{libgcc.a} can also be searched for using
5245 the @option{-B} prefix, if needed. If it is not found there, the two
5246 standard prefixes above are tried, and that is all. The file is left
5247 out of the link if it is not found by those means.
5249 Another way to specify a prefix much like the @option{-B} prefix is to use
5250 the environment variable @env{GCC_EXEC_PREFIX}. @xref{Environment
5253 As a special kludge, if the path provided by @option{-B} is
5254 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5255 9, then it will be replaced by @file{[dir/]include}. This is to help
5256 with boot-strapping the compiler.
5258 @item -specs=@var{file}
5260 Process @var{file} after the compiler reads in the standard @file{specs}
5261 file, in order to override the defaults that the @file{gcc} driver
5262 program uses when determining what switches to pass to @file{cc1},
5263 @file{cc1plus}, @file{as}, @file{ld}, etc. More than one
5264 @option{-specs=@var{file}} can be specified on the command line, and they
5265 are processed in order, from left to right.
5271 @section Specifying subprocesses and the switches to pass to them
5274 @command{gcc} is a driver program. It performs its job by invoking a
5275 sequence of other programs to do the work of compiling, assembling and
5276 linking. GCC interprets its command-line parameters and uses these to
5277 deduce which programs it should invoke, and which command-line options
5278 it ought to place on their command lines. This behavior is controlled
5279 by @dfn{spec strings}. In most cases there is one spec string for each
5280 program that GCC can invoke, but a few programs have multiple spec
5281 strings to control their behavior. The spec strings built into GCC can
5282 be overridden by using the @option{-specs=} command-line switch to specify
5285 @dfn{Spec files} are plaintext files that are used to construct spec
5286 strings. They consist of a sequence of directives separated by blank
5287 lines. The type of directive is determined by the first non-whitespace
5288 character on the line and it can be one of the following:
5291 @item %@var{command}
5292 Issues a @var{command} to the spec file processor. The commands that can
5296 @item %include <@var{file}>
5298 Search for @var{file} and insert its text at the current point in the
5301 @item %include_noerr <@var{file}>
5302 @cindex %include_noerr
5303 Just like @samp{%include}, but do not generate an error message if the include
5304 file cannot be found.
5306 @item %rename @var{old_name} @var{new_name}
5308 Rename the spec string @var{old_name} to @var{new_name}.
5312 @item *[@var{spec_name}]:
5313 This tells the compiler to create, override or delete the named spec
5314 string. All lines after this directive up to the next directive or
5315 blank line are considered to be the text for the spec string. If this
5316 results in an empty string then the spec will be deleted. (Or, if the
5317 spec did not exist, then nothing will happened.) Otherwise, if the spec
5318 does not currently exist a new spec will be created. If the spec does
5319 exist then its contents will be overridden by the text of this
5320 directive, unless the first character of that text is the @samp{+}
5321 character, in which case the text will be appended to the spec.
5323 @item [@var{suffix}]:
5324 Creates a new @samp{[@var{suffix}] spec} pair. All lines after this directive
5325 and up to the next directive or blank line are considered to make up the
5326 spec string for the indicated suffix. When the compiler encounters an
5327 input file with the named suffix, it will processes the spec string in
5328 order to work out how to compile that file. For example:
5335 This says that any input file whose name ends in @samp{.ZZ} should be
5336 passed to the program @samp{z-compile}, which should be invoked with the
5337 command-line switch @option{-input} and with the result of performing the
5338 @samp{%i} substitution. (See below.)
5340 As an alternative to providing a spec string, the text that follows a
5341 suffix directive can be one of the following:
5344 @item @@@var{language}
5345 This says that the suffix is an alias for a known @var{language}. This is
5346 similar to using the @option{-x} command-line switch to GCC to specify a
5347 language explicitly. For example:
5354 Says that .ZZ files are, in fact, C++ source files.
5357 This causes an error messages saying:
5360 @var{name} compiler not installed on this system.
5364 GCC already has an extensive list of suffixes built into it.
5365 This directive will add an entry to the end of the list of suffixes, but
5366 since the list is searched from the end backwards, it is effectively
5367 possible to override earlier entries using this technique.
5371 GCC has the following spec strings built into it. Spec files can
5372 override these strings or create their own. Note that individual
5373 targets can also add their own spec strings to this list.
5376 asm Options to pass to the assembler
5377 asm_final Options to pass to the assembler post-processor
5378 cpp Options to pass to the C preprocessor
5379 cc1 Options to pass to the C compiler
5380 cc1plus Options to pass to the C++ compiler
5381 endfile Object files to include at the end of the link
5382 link Options to pass to the linker
5383 lib Libraries to include on the command line to the linker
5384 libgcc Decides which GCC support library to pass to the linker
5385 linker Sets the name of the linker
5386 predefines Defines to be passed to the C preprocessor
5387 signed_char Defines to pass to CPP to say whether @code{char} is signed
5389 startfile Object files to include at the start of the link
5392 Here is a small example of a spec file:
5398 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5401 This example renames the spec called @samp{lib} to @samp{old_lib} and
5402 then overrides the previous definition of @samp{lib} with a new one.
5403 The new definition adds in some extra command-line options before
5404 including the text of the old definition.
5406 @dfn{Spec strings} are a list of command-line options to be passed to their
5407 corresponding program. In addition, the spec strings can contain
5408 @samp{%}-prefixed sequences to substitute variable text or to
5409 conditionally insert text into the command line. Using these constructs
5410 it is possible to generate quite complex command lines.
5412 Here is a table of all defined @samp{%}-sequences for spec
5413 strings. Note that spaces are not generated automatically around the
5414 results of expanding these sequences. Therefore you can concatenate them
5415 together or combine them with constant text in a single argument.
5419 Substitute one @samp{%} into the program name or argument.
5422 Substitute the name of the input file being processed.
5425 Substitute the basename of the input file being processed.
5426 This is the substring up to (and not including) the last period
5427 and not including the directory.
5430 This is the same as @samp{%b}, but include the file suffix (text after
5434 Marks the argument containing or following the @samp{%d} as a
5435 temporary file name, so that that file will be deleted if GCC exits
5436 successfully. Unlike @samp{%g}, this contributes no text to the
5439 @item %g@var{suffix}
5440 Substitute a file name that has suffix @var{suffix} and is chosen
5441 once per compilation, and mark the argument in the same way as
5442 @samp{%d}. To reduce exposure to denial-of-service attacks, the file
5443 name is now chosen in a way that is hard to predict even when previously
5444 chosen file names are known. For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5445 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}. @var{suffix} matches
5446 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5447 treated exactly as if @samp{%O} had been preprocessed. Previously, @samp{%g}
5448 was simply substituted with a file name chosen once per compilation,
5449 without regard to any appended suffix (which was therefore treated
5450 just like ordinary text), making such attacks more likely to succeed.
5452 @item %u@var{suffix}
5453 Like @samp{%g}, but generates a new temporary file name even if
5454 @samp{%u@var{suffix}} was already seen.
5456 @item %U@var{suffix}
5457 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5458 new one if there is no such last file name. In the absence of any
5459 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5460 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5461 would involve the generation of two distinct file names, one
5462 for each @samp{%g.s} and another for each @samp{%U.s}. Previously, @samp{%U} was
5463 simply substituted with a file name chosen for the previous @samp{%u},
5464 without regard to any appended suffix.
5466 @item %j@var{suffix}
5467 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5468 writable, and if save-temps is off; otherwise, substitute the name
5469 of a temporary file, just like @samp{%u}. This temporary file is not
5470 meant for communication between processes, but rather as a junk
5473 @item %|@var{suffix}
5474 @itemx %m@var{suffix}
5475 Like @samp{%g}, except if @option{-pipe} is in effect. In that case
5476 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5477 all. These are the two most common ways to instruct a program that it
5478 should read from standard input or write to standard output. If you
5479 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5480 construct: see for example @file{f/lang-specs.h}.
5482 @item %.@var{SUFFIX}
5483 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5484 when it is subsequently output with @samp{%*}. @var{SUFFIX} is
5485 terminated by the next space or %.
5488 Marks the argument containing or following the @samp{%w} as the
5489 designated output file of this compilation. This puts the argument
5490 into the sequence of arguments that @samp{%o} will substitute later.
5493 Substitutes the names of all the output files, with spaces
5494 automatically placed around them. You should write spaces
5495 around the @samp{%o} as well or the results are undefined.
5496 @samp{%o} is for use in the specs for running the linker.
5497 Input files whose names have no recognized suffix are not compiled
5498 at all, but they are included among the output files, so they will
5502 Substitutes the suffix for object files. Note that this is
5503 handled specially when it immediately follows @samp{%g, %u, or %U},
5504 because of the need for those to form complete file names. The
5505 handling is such that @samp{%O} is treated exactly as if it had already
5506 been substituted, except that @samp{%g, %u, and %U} do not currently
5507 support additional @var{suffix} characters following @samp{%O} as they would
5508 following, for example, @samp{.o}.
5511 Substitutes the standard macro predefinitions for the
5512 current target machine. Use this when running @code{cpp}.
5515 Like @samp{%p}, but puts @samp{__} before and after the name of each
5516 predefined macro, except for macros that start with @samp{__} or with
5517 @samp{_@var{L}}, where @var{L} is an uppercase letter. This is for ISO
5521 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
5522 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
5523 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
5527 Current argument is the name of a library or startup file of some sort.
5528 Search for that file in a standard list of directories and substitute
5529 the full name found.
5532 Print @var{str} as an error message. @var{str} is terminated by a newline.
5533 Use this when inconsistent options are detected.
5536 Substitute the contents of spec string @var{name} at this point.
5539 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5541 @item %x@{@var{option}@}
5542 Accumulate an option for @samp{%X}.
5545 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5549 Output the accumulated assembler options specified by @option{-Wa}.
5552 Output the accumulated preprocessor options specified by @option{-Wp}.
5555 Process the @code{asm} spec. This is used to compute the
5556 switches to be passed to the assembler.
5559 Process the @code{asm_final} spec. This is a spec string for
5560 passing switches to an assembler post-processor, if such a program is
5564 Process the @code{link} spec. This is the spec for computing the
5565 command line passed to the linker. Typically it will make use of the
5566 @samp{%L %G %S %D and %E} sequences.
5569 Dump out a @option{-L} option for each directory that GCC believes might
5570 contain startup files. If the target supports multilibs then the
5571 current multilib directory will be prepended to each of these paths.
5574 Output the multilib directory with directory separators replaced with
5575 @samp{_}. If multilib directories are not set, or the multilib directory is
5576 @file{.} then this option emits nothing.
5579 Process the @code{lib} spec. This is a spec string for deciding which
5580 libraries should be included on the command line to the linker.
5583 Process the @code{libgcc} spec. This is a spec string for deciding
5584 which GCC support library should be included on the command line to the linker.
5587 Process the @code{startfile} spec. This is a spec for deciding which
5588 object files should be the first ones passed to the linker. Typically
5589 this might be a file named @file{crt0.o}.
5592 Process the @code{endfile} spec. This is a spec string that specifies
5593 the last object files that will be passed to the linker.
5596 Process the @code{cpp} spec. This is used to construct the arguments
5597 to be passed to the C preprocessor.
5600 Process the @code{signed_char} spec. This is intended to be used
5601 to tell cpp whether a char is signed. It typically has the definition:
5603 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5607 Process the @code{cc1} spec. This is used to construct the options to be
5608 passed to the actual C compiler (@samp{cc1}).
5611 Process the @code{cc1plus} spec. This is used to construct the options to be
5612 passed to the actual C++ compiler (@samp{cc1plus}).
5615 Substitute the variable part of a matched option. See below.
5616 Note that each comma in the substituted string is replaced by
5620 Remove all occurrences of @code{-S} from the command line. Note---this
5621 command is position dependent. @samp{%} commands in the spec string
5622 before this one will see @code{-S}, @samp{%} commands in the spec string
5623 after this one will not.
5625 @item %:@var{function}(@var{args})
5626 Call the named function @var{function}, passing it @var{args}.
5627 @var{args} is first processed as a nested spec string, then split
5628 into an argument vector in the usual fashion. The function returns
5629 a string which is processed as if it had appeared literally as part
5630 of the current spec.
5632 The following built-in spec functions are provided:
5635 @item @code{if-exists}
5636 The @code{if-exists} spec function takes one argument, an absolute
5637 pathname to a file. If the file exists, @code{if-exists} returns the
5638 pathname. Here is a small example of its usage:
5642 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5645 @item @code{if-exists-else}
5646 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5647 spec function, except that it takes two arguments. The first argument is
5648 an absolute pathname to a file. If the file exists, @code{if-exists-else}
5649 returns the pathname. If it does not exist, it returns the second argument.
5650 This way, @code{if-exists-else} can be used to select one file or another,
5651 based on the existence of the first. Here is a small example of its usage:
5655 crt0%O%s %:if-exists(crti%O%s) \
5656 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5661 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5662 If that switch was not specified, this substitutes nothing. Note that
5663 the leading dash is omitted when specifying this option, and it is
5664 automatically inserted if the substitution is performed. Thus the spec
5665 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5666 and would output the command line option @option{-foo}.
5668 @item %W@{@code{S}@}
5669 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5672 @item %@{@code{S}*@}
5673 Substitutes all the switches specified to GCC whose names start
5674 with @code{-S}, but which also take an argument. This is used for
5675 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5676 GCC considers @option{-o foo} as being
5677 one switch whose names starts with @samp{o}. %@{o*@} would substitute this
5678 text, including the space. Thus two arguments would be generated.
5680 @item %@{@code{S}*&@code{T}*@}
5681 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5682 (the order of @code{S} and @code{T} in the spec is not significant).
5683 There can be any number of ampersand-separated variables; for each the
5684 wild card is optional. Useful for CPP as @samp{%@{D*&U*&A*@}}.
5686 @item %@{@code{S}:@code{X}@}
5687 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5689 @item %@{!@code{S}:@code{X}@}
5690 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5692 @item %@{@code{S}*:@code{X}@}
5693 Substitutes @code{X} if one or more switches whose names start with
5694 @code{-S} are specified to GCC@. Normally @code{X} is substituted only
5695 once, no matter how many such switches appeared. However, if @code{%*}
5696 appears somewhere in @code{X}, then @code{X} will be substituted once
5697 for each matching switch, with the @code{%*} replaced by the part of
5698 that switch that matched the @code{*}.
5700 @item %@{.@code{S}:@code{X}@}
5701 Substitutes @code{X}, if processing a file with suffix @code{S}.
5703 @item %@{!.@code{S}:@code{X}@}
5704 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5706 @item %@{@code{S}|@code{P}:@code{X}@}
5707 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5708 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5709 although they have a stronger binding than the @samp{|}. If @code{%*}
5710 appears in @code{X}, all of the alternatives must be starred, and only
5711 the first matching alternative is substituted.
5713 For example, a spec string like this:
5716 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5719 will output the following command-line options from the following input
5720 command-line options:
5725 -d fred.c -foo -baz -boggle
5726 -d jim.d -bar -baz -boggle
5729 @item %@{S:X; T:Y; :D@}
5731 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
5732 given to GCC, substitutes @code{Y}; else substitutes @code{D}. There can
5733 be as many clauses as you need. This may be combined with @code{.},
5734 @code{!}, @code{|}, and @code{*} as needed.
5739 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5740 construct may contain other nested @samp{%} constructs or spaces, or
5741 even newlines. They are processed as usual, as described above.
5742 Trailing white space in @code{X} is ignored. White space may also
5743 appear anywhere on the left side of the colon in these constructs,
5744 except between @code{.} or @code{*} and the corresponding word.
5746 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5747 handled specifically in these constructs. If another value of
5748 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5749 @option{-W} switch is found later in the command line, the earlier
5750 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5751 just one letter, which passes all matching options.
5753 The character @samp{|} at the beginning of the predicate text is used to
5754 indicate that a command should be piped to the following command, but
5755 only if @option{-pipe} is specified.
5757 It is built into GCC which switches take arguments and which do not.
5758 (You might think it would be useful to generalize this to allow each
5759 compiler's spec to say which switches take arguments. But this cannot
5760 be done in a consistent fashion. GCC cannot even decide which input
5761 files have been specified without knowing which switches take arguments,
5762 and it must know which input files to compile in order to tell which
5765 GCC also knows implicitly that arguments starting in @option{-l} are to be
5766 treated as compiler output files, and passed to the linker in their
5767 proper position among the other output files.
5769 @c man begin OPTIONS
5771 @node Target Options
5772 @section Specifying Target Machine and Compiler Version
5773 @cindex target options
5774 @cindex cross compiling
5775 @cindex specifying machine version
5776 @cindex specifying compiler version and target machine
5777 @cindex compiler version, specifying
5778 @cindex target machine, specifying
5780 The usual way to run GCC is to run the executable called @file{gcc}, or
5781 @file{<machine>-gcc} when cross-compiling, or
5782 @file{<machine>-gcc-<version>} to run a version other than the one that
5783 was installed last. Sometimes this is inconvenient, so GCC provides
5784 options that will switch to another cross-compiler or version.
5787 @item -b @var{machine}
5789 The argument @var{machine} specifies the target machine for compilation.
5791 The value to use for @var{machine} is the same as was specified as the
5792 machine type when configuring GCC as a cross-compiler. For
5793 example, if a cross-compiler was configured with @samp{configure
5794 i386v}, meaning to compile for an 80386 running System V, then you
5795 would specify @option{-b i386v} to run that cross compiler.
5797 @item -V @var{version}
5799 The argument @var{version} specifies which version of GCC to run.
5800 This is useful when multiple versions are installed. For example,
5801 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5804 The @option{-V} and @option{-b} options work by running the
5805 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5806 use them if you can just run that directly.
5808 @node Submodel Options
5809 @section Hardware Models and Configurations
5810 @cindex submodel options
5811 @cindex specifying hardware config
5812 @cindex hardware models and configurations, specifying
5813 @cindex machine dependent options
5815 Earlier we discussed the standard option @option{-b} which chooses among
5816 different installed compilers for completely different target
5817 machines, such as VAX vs.@: 68000 vs.@: 80386.
5819 In addition, each of these target machine types can have its own
5820 special options, starting with @samp{-m}, to choose among various
5821 hardware models or configurations---for example, 68010 vs 68020,
5822 floating coprocessor or none. A single installed version of the
5823 compiler can compile for any model or configuration, according to the
5826 Some configurations of the compiler also support additional special
5827 options, usually for compatibility with other compilers on the same
5830 These options are defined by the macro @code{TARGET_SWITCHES} in the
5831 machine description. The default for the options is also defined by
5832 that macro, which enables you to change the defaults.
5842 * RS/6000 and PowerPC Options::
5845 * i386 and x86-64 Options::
5847 * DEC Alpha Options::
5848 * DEC Alpha/VMS Options::
5851 * System V Options::
5852 * TMS320C3x/C4x Options::
5859 * S/390 and zSeries Options::
5863 * Xstormy16 Options::
5868 @node M680x0 Options
5869 @subsection M680x0 Options
5870 @cindex M680x0 options
5872 These are the @samp{-m} options defined for the 68000 series. The default
5873 values for these options depends on which style of 68000 was selected when
5874 the compiler was configured; the defaults for the most common choices are
5882 Generate output for a 68000. This is the default
5883 when the compiler is configured for 68000-based systems.
5885 Use this option for microcontrollers with a 68000 or EC000 core,
5886 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5892 Generate output for a 68020. This is the default
5893 when the compiler is configured for 68020-based systems.
5897 Generate output containing 68881 instructions for floating point.
5898 This is the default for most 68020 systems unless @option{--nfp} was
5899 specified when the compiler was configured.
5903 Generate output for a 68030. This is the default when the compiler is
5904 configured for 68030-based systems.
5908 Generate output for a 68040. This is the default when the compiler is
5909 configured for 68040-based systems.
5911 This option inhibits the use of 68881/68882 instructions that have to be
5912 emulated by software on the 68040. Use this option if your 68040 does not
5913 have code to emulate those instructions.
5917 Generate output for a 68060. This is the default when the compiler is
5918 configured for 68060-based systems.
5920 This option inhibits the use of 68020 and 68881/68882 instructions that
5921 have to be emulated by software on the 68060. Use this option if your 68060
5922 does not have code to emulate those instructions.
5926 Generate output for a CPU32. This is the default
5927 when the compiler is configured for CPU32-based systems.
5929 Use this option for microcontrollers with a
5930 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5931 68336, 68340, 68341, 68349 and 68360.
5935 Generate output for a 520X ``coldfire'' family cpu. This is the default
5936 when the compiler is configured for 520X-based systems.
5938 Use this option for microcontroller with a 5200 core, including
5939 the MCF5202, MCF5203, MCF5204 and MCF5202.
5944 Generate output for a 68040, without using any of the new instructions.
5945 This results in code which can run relatively efficiently on either a
5946 68020/68881 or a 68030 or a 68040. The generated code does use the
5947 68881 instructions that are emulated on the 68040.
5951 Generate output for a 68060, without using any of the new instructions.
5952 This results in code which can run relatively efficiently on either a
5953 68020/68881 or a 68030 or a 68040. The generated code does use the
5954 68881 instructions that are emulated on the 68060.
5957 @opindex msoft-float
5958 Generate output containing library calls for floating point.
5959 @strong{Warning:} the requisite libraries are not available for all m68k
5960 targets. Normally the facilities of the machine's usual C compiler are
5961 used, but this can't be done directly in cross-compilation. You must
5962 make your own arrangements to provide suitable library functions for
5963 cross-compilation. The embedded targets @samp{m68k-*-aout} and
5964 @samp{m68k-*-coff} do provide software floating point support.
5968 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5971 @opindex mnobitfield
5972 Do not use the bit-field instructions. The @option{-m68000}, @option{-mcpu32}
5973 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5977 Do use the bit-field instructions. The @option{-m68020} option implies
5978 @option{-mbitfield}. This is the default if you use a configuration
5979 designed for a 68020.
5983 Use a different function-calling convention, in which functions
5984 that take a fixed number of arguments return with the @code{rtd}
5985 instruction, which pops their arguments while returning. This
5986 saves one instruction in the caller since there is no need to pop
5987 the arguments there.
5989 This calling convention is incompatible with the one normally
5990 used on Unix, so you cannot use it if you need to call libraries
5991 compiled with the Unix compiler.
5993 Also, you must provide function prototypes for all functions that
5994 take variable numbers of arguments (including @code{printf});
5995 otherwise incorrect code will be generated for calls to those
5998 In addition, seriously incorrect code will result if you call a
5999 function with too many arguments. (Normally, extra arguments are
6000 harmlessly ignored.)
6002 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
6003 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
6006 @itemx -mno-align-int
6008 @opindex mno-align-int
6009 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
6010 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
6011 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
6012 Aligning variables on 32-bit boundaries produces code that runs somewhat
6013 faster on processors with 32-bit busses at the expense of more memory.
6015 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
6016 align structures containing the above types differently than
6017 most published application binary interface specifications for the m68k.
6021 Use the pc-relative addressing mode of the 68000 directly, instead of
6022 using a global offset table. At present, this option implies @option{-fpic},
6023 allowing at most a 16-bit offset for pc-relative addressing. @option{-fPIC} is
6024 not presently supported with @option{-mpcrel}, though this could be supported for
6025 68020 and higher processors.
6027 @item -mno-strict-align
6028 @itemx -mstrict-align
6029 @opindex mno-strict-align
6030 @opindex mstrict-align
6031 Do not (do) assume that unaligned memory references will be handled by
6035 Generate code that allows the data segment to be located in a different
6036 area of memory from the text segment. This allows for execute in place in
6037 an environment without virtual memory management. This option implies -fPIC.
6040 Generate code that assumes that the data segment follows the text segment.
6041 This is the default.
6043 @item -mid-shared-library
6044 Generate code that supports shared libraries via the library ID method.
6045 This allows for execute in place and shared libraries in an environment
6046 without virtual memory management. This option implies -fPIC.
6048 @item -mno-id-shared-library
6049 Generate code that doesn't assume ID based shared libraries are being used.
6050 This is the default.
6052 @item -mshared-library-id=n
6053 Specified the identification number of the ID based shared library being
6054 compiled. Specifying a value of 0 will generate more compact code, specifying
6055 other values will force the allocation of that number to the current
6056 library but is no more space or time efficient than omitting this option.
6060 @node M68hc1x Options
6061 @subsection M68hc1x Options
6062 @cindex M68hc1x options
6064 These are the @samp{-m} options defined for the 68hc11 and 68hc12
6065 microcontrollers. The default values for these options depends on
6066 which style of microcontroller was selected when the compiler was configured;
6067 the defaults for the most common choices are given below.
6074 Generate output for a 68HC11. This is the default
6075 when the compiler is configured for 68HC11-based systems.
6081 Generate output for a 68HC12. This is the default
6082 when the compiler is configured for 68HC12-based systems.
6088 Generate output for a 68HCS12.
6091 @opindex mauto-incdec
6092 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
6099 Enable the use of 68HC12 min and max instructions.
6102 @itemx -mno-long-calls
6103 @opindex mlong-calls
6104 @opindex mno-long-calls
6105 Treat all calls as being far away (near). If calls are assumed to be
6106 far away, the compiler will use the @code{call} instruction to
6107 call a function and the @code{rtc} instruction for returning.
6111 Consider type @code{int} to be 16 bits wide, like @code{short int}.
6113 @item -msoft-reg-count=@var{count}
6114 @opindex msoft-reg-count
6115 Specify the number of pseudo-soft registers which are used for the
6116 code generation. The maximum number is 32. Using more pseudo-soft
6117 register may or may not result in better code depending on the program.
6118 The default is 4 for 68HC11 and 2 for 68HC12.
6123 @subsection VAX Options
6126 These @samp{-m} options are defined for the VAX:
6131 Do not output certain jump instructions (@code{aobleq} and so on)
6132 that the Unix assembler for the VAX cannot handle across long
6137 Do output those jump instructions, on the assumption that you
6138 will assemble with the GNU assembler.
6142 Output code for g-format floating point numbers instead of d-format.
6146 @subsection SPARC Options
6147 @cindex SPARC options
6149 These @samp{-m} options are supported on the SPARC:
6154 @opindex mno-app-regs
6156 Specify @option{-mapp-regs} to generate output using the global registers
6157 2 through 4, which the SPARC SVR4 ABI reserves for applications. This
6160 To be fully SVR4 ABI compliant at the cost of some performance loss,
6161 specify @option{-mno-app-regs}. You should compile libraries and system
6162 software with this option.
6167 @opindex mhard-float
6168 Generate output containing floating point instructions. This is the
6174 @opindex msoft-float
6175 Generate output containing library calls for floating point.
6176 @strong{Warning:} the requisite libraries are not available for all SPARC
6177 targets. Normally the facilities of the machine's usual C compiler are
6178 used, but this cannot be done directly in cross-compilation. You must make
6179 your own arrangements to provide suitable library functions for
6180 cross-compilation. The embedded targets @samp{sparc-*-aout} and
6181 @samp{sparclite-*-*} do provide software floating point support.
6183 @option{-msoft-float} changes the calling convention in the output file;
6184 therefore, it is only useful if you compile @emph{all} of a program with
6185 this option. In particular, you need to compile @file{libgcc.a}, the
6186 library that comes with GCC, with @option{-msoft-float} in order for
6189 @item -mhard-quad-float
6190 @opindex mhard-quad-float
6191 Generate output containing quad-word (long double) floating point
6194 @item -msoft-quad-float
6195 @opindex msoft-quad-float
6196 Generate output containing library calls for quad-word (long double)
6197 floating point instructions. The functions called are those specified
6198 in the SPARC ABI@. This is the default.
6200 As of this writing, there are no SPARC implementations that have hardware
6201 support for the quad-word floating point instructions. They all invoke
6202 a trap handler for one of these instructions, and then the trap handler
6203 emulates the effect of the instruction. Because of the trap handler overhead,
6204 this is much slower than calling the ABI library routines. Thus the
6205 @option{-msoft-quad-float} option is the default.
6207 @item -mno-unaligned-doubles
6208 @itemx -munaligned-doubles
6209 @opindex mno-unaligned-doubles
6210 @opindex munaligned-doubles
6211 Assume that doubles have 8 byte alignment. This is the default.
6213 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
6214 alignment only if they are contained in another type, or if they have an
6215 absolute address. Otherwise, it assumes they have 4 byte alignment.
6216 Specifying this option avoids some rare compatibility problems with code
6217 generated by other compilers. It is not the default because it results
6218 in a performance loss, especially for floating point code.
6220 @item -mno-faster-structs
6221 @itemx -mfaster-structs
6222 @opindex mno-faster-structs
6223 @opindex mfaster-structs
6224 With @option{-mfaster-structs}, the compiler assumes that structures
6225 should have 8 byte alignment. This enables the use of pairs of
6226 @code{ldd} and @code{std} instructions for copies in structure
6227 assignment, in place of twice as many @code{ld} and @code{st} pairs.
6228 However, the use of this changed alignment directly violates the SPARC
6229 ABI@. Thus, it's intended only for use on targets where the developer
6230 acknowledges that their resulting code will not be directly in line with
6231 the rules of the ABI@.
6234 @opindex mimpure-text
6235 @option{-mimpure-text}, used in addition to @option{-shared}, tells
6236 the compiler to not pass @option{-z text} to the linker when linking a
6237 shared object. Using this option, you can link position-dependent
6238 code into a shared object.
6240 @option{-mimpure-text} suppresses the ``relocations remain against
6241 allocatable but non-writable sections'' linker error message.
6242 However, the necessary relocations will trigger copy-on-write, and the
6243 shared object is not actually shared across processes. Instead of
6244 using @option{-mimpure-text}, you should compile all source code with
6245 @option{-fpic} or @option{-fPIC}.
6247 This option is only available on SunOS and Solaris.
6249 @item -mcpu=@var{cpu_type}
6251 Set the instruction set, register set, and instruction scheduling parameters
6252 for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
6253 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
6254 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
6255 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
6258 Default instruction scheduling parameters are used for values that select
6259 an architecture and not an implementation. These are @samp{v7}, @samp{v8},
6260 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
6262 Here is a list of each supported architecture and their supported
6267 v8: supersparc, hypersparc
6268 sparclite: f930, f934, sparclite86x
6270 v9: ultrasparc, ultrasparc3
6273 By default (unless configured otherwise), GCC generates code for the V7
6274 variant of the SPARC architecture. With @option{-mcpu=cypress}, the compiler
6275 additionally optimizes it for the Cypress CY7C602 chip, as used in the
6276 SPARCStation/SPARCServer 3xx series. This is also appropriate for the older
6277 SPARCStation 1, 2, IPX etc.
6279 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
6280 architecture. The only difference from V7 code is that the compiler emits
6281 the integer multiply and integer divide instructions which exist in SPARC-V8
6282 but not in SPARC-V7. With @option{-mcpu=supersparc}, the compiler additionally
6283 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
6286 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
6287 the SPARC architecture. This adds the integer multiply, integer divide step
6288 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
6289 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
6290 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU. With
6291 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
6292 MB86934 chip, which is the more recent SPARClite with FPU.
6294 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
6295 the SPARC architecture. This adds the integer multiply, multiply/accumulate,
6296 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
6297 but not in SPARC-V7. With @option{-mcpu=tsc701}, the compiler additionally
6298 optimizes it for the TEMIC SPARClet chip.
6300 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
6301 architecture. This adds 64-bit integer and floating-point move instructions,
6302 3 additional floating-point condition code registers and conditional move
6303 instructions. With @option{-mcpu=ultrasparc}, the compiler additionally
6304 optimizes it for the Sun UltraSPARC I/II chips. With
6305 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
6306 Sun UltraSPARC III chip.
6308 @item -mtune=@var{cpu_type}
6310 Set the instruction scheduling parameters for machine type
6311 @var{cpu_type}, but do not set the instruction set or register set that the
6312 option @option{-mcpu=@var{cpu_type}} would.
6314 The same values for @option{-mcpu=@var{cpu_type}} can be used for
6315 @option{-mtune=@var{cpu_type}}, but the only useful values are those
6316 that select a particular cpu implementation. Those are @samp{cypress},
6317 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
6318 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
6324 @opindex -mno-v8plus
6325 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI. The
6326 difference from the V8 ABI is that the global and out registers are
6327 considered 64-bit wide. This is enabled by default on Solaris in 32-bit
6328 mode for all SPARC-V9 processors.
6334 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
6335 Visual Instruction Set extensions. The default is @option{-mno-vis}.
6338 These @samp{-m} options are supported in addition to the above
6339 on SPARC-V9 processors in 64-bit environments:
6342 @item -mlittle-endian
6343 @opindex mlittle-endian
6344 Generate code for a processor running in little-endian mode. It is only
6345 available for a few configurations and most notably not on Solaris.
6351 Generate code for a 32-bit or 64-bit environment.
6352 The 32-bit environment sets int, long and pointer to 32 bits.
6353 The 64-bit environment sets int to 32 bits and long and pointer
6356 @item -mcmodel=medlow
6357 @opindex mcmodel=medlow
6358 Generate code for the Medium/Low code model: the program must be linked
6359 in the low 32 bits of the address space. Pointers are 64 bits.
6360 Programs can be statically or dynamically linked.
6362 @item -mcmodel=medmid
6363 @opindex mcmodel=medmid
6364 Generate code for the Medium/Middle code model: the program must be linked
6365 in the low 44 bits of the address space, the text segment must be less than
6366 2G bytes, and data segment must be within 2G of the text segment.
6367 Pointers are 64 bits.
6369 @item -mcmodel=medany
6370 @opindex mcmodel=medany
6371 Generate code for the Medium/Anywhere code model: the program may be linked
6372 anywhere in the address space, the text segment must be less than
6373 2G bytes, and data segment must be within 2G of the text segment.
6374 Pointers are 64 bits.
6376 @item -mcmodel=embmedany
6377 @opindex mcmodel=embmedany
6378 Generate code for the Medium/Anywhere code model for embedded systems:
6379 assume a 32-bit text and a 32-bit data segment, both starting anywhere
6380 (determined at link time). Register %g4 points to the base of the
6381 data segment. Pointers are still 64 bits.
6382 Programs are statically linked, PIC is not supported.
6385 @itemx -mno-stack-bias
6386 @opindex mstack-bias
6387 @opindex mno-stack-bias
6388 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
6389 frame pointer if present, are offset by @minus{}2047 which must be added back
6390 when making stack frame references. This is the default in 64-bit mode.
6391 Otherwise, assume no such offset is present.
6395 @subsection ARM Options
6398 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6403 @opindex mapcs-frame
6404 Generate a stack frame that is compliant with the ARM Procedure Call
6405 Standard for all functions, even if this is not strictly necessary for
6406 correct execution of the code. Specifying @option{-fomit-frame-pointer}
6407 with this option will cause the stack frames not to be generated for
6408 leaf functions. The default is @option{-mno-apcs-frame}.
6412 This is a synonym for @option{-mapcs-frame}.
6416 Generate code for a processor running with a 26-bit program counter,
6417 and conforming to the function calling standards for the APCS 26-bit
6418 option. This option replaces the @option{-m2} and @option{-m3} options
6419 of previous releases of the compiler.
6423 Generate code for a processor running with a 32-bit program counter,
6424 and conforming to the function calling standards for the APCS 32-bit
6425 option. This option replaces the @option{-m6} option of previous releases
6429 @c not currently implemented
6430 @item -mapcs-stack-check
6431 @opindex mapcs-stack-check
6432 Generate code to check the amount of stack space available upon entry to
6433 every function (that actually uses some stack space). If there is
6434 insufficient space available then either the function
6435 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6436 called, depending upon the amount of stack space required. The run time
6437 system is required to provide these functions. The default is
6438 @option{-mno-apcs-stack-check}, since this produces smaller code.
6440 @c not currently implemented
6442 @opindex mapcs-float
6443 Pass floating point arguments using the float point registers. This is
6444 one of the variants of the APCS@. This option is recommended if the
6445 target hardware has a floating point unit or if a lot of floating point
6446 arithmetic is going to be performed by the code. The default is
6447 @option{-mno-apcs-float}, since integer only code is slightly increased in
6448 size if @option{-mapcs-float} is used.
6450 @c not currently implemented
6451 @item -mapcs-reentrant
6452 @opindex mapcs-reentrant
6453 Generate reentrant, position independent code. The default is
6454 @option{-mno-apcs-reentrant}.
6457 @item -mthumb-interwork
6458 @opindex mthumb-interwork
6459 Generate code which supports calling between the ARM and Thumb
6460 instruction sets. Without this option the two instruction sets cannot
6461 be reliably used inside one program. The default is
6462 @option{-mno-thumb-interwork}, since slightly larger code is generated
6463 when @option{-mthumb-interwork} is specified.
6465 @item -mno-sched-prolog
6466 @opindex mno-sched-prolog
6467 Prevent the reordering of instructions in the function prolog, or the
6468 merging of those instruction with the instructions in the function's
6469 body. This means that all functions will start with a recognizable set
6470 of instructions (or in fact one of a choice from a small set of
6471 different function prologues), and this information can be used to
6472 locate the start if functions inside an executable piece of code. The
6473 default is @option{-msched-prolog}.
6476 @opindex mhard-float
6477 Generate output containing floating point instructions. This is the
6481 @opindex msoft-float
6482 Generate output containing library calls for floating point.
6483 @strong{Warning:} the requisite libraries are not available for all ARM
6484 targets. Normally the facilities of the machine's usual C compiler are
6485 used, but this cannot be done directly in cross-compilation. You must make
6486 your own arrangements to provide suitable library functions for
6489 @option{-msoft-float} changes the calling convention in the output file;
6490 therefore, it is only useful if you compile @emph{all} of a program with
6491 this option. In particular, you need to compile @file{libgcc.a}, the
6492 library that comes with GCC, with @option{-msoft-float} in order for
6495 @item -mfloat-abi=@var{name}
6497 Specifies which ABI to use for floating point values. Permissible values
6498 are: @samp{soft}, @samp{softfp} and @samp{hard}.
6500 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
6501 and @option{-mhard-float} respectively. @samp{softfp} allows the generation
6502 of floating point instructions, but still uses the soft-float calling
6505 @item -mlittle-endian
6506 @opindex mlittle-endian
6507 Generate code for a processor running in little-endian mode. This is
6508 the default for all standard configurations.
6511 @opindex mbig-endian
6512 Generate code for a processor running in big-endian mode; the default is
6513 to compile code for a little-endian processor.
6515 @item -mwords-little-endian
6516 @opindex mwords-little-endian
6517 This option only applies when generating code for big-endian processors.
6518 Generate code for a little-endian word order but a big-endian byte
6519 order. That is, a byte order of the form @samp{32107654}. Note: this
6520 option should only be used if you require compatibility with code for
6521 big-endian ARM processors generated by versions of the compiler prior to
6524 @item -malignment-traps
6525 @opindex malignment-traps
6526 Generate code that will not trap if the MMU has alignment traps enabled.
6527 On ARM architectures prior to ARMv4, there were no instructions to
6528 access half-word objects stored in memory. However, when reading from
6529 memory a feature of the ARM architecture allows a word load to be used,
6530 even if the address is unaligned, and the processor core will rotate the
6531 data as it is being loaded. This option tells the compiler that such
6532 misaligned accesses will cause a MMU trap and that it should instead
6533 synthesize the access as a series of byte accesses. The compiler can
6534 still use word accesses to load half-word data if it knows that the
6535 address is aligned to a word boundary.
6537 This option is ignored when compiling for ARM architecture 4 or later,
6538 since these processors have instructions to directly access half-word
6541 @item -mno-alignment-traps
6542 @opindex mno-alignment-traps
6543 Generate code that assumes that the MMU will not trap unaligned
6544 accesses. This produces better code when the target instruction set
6545 does not have half-word memory operations (i.e.@: implementations prior to
6548 Note that you cannot use this option to access unaligned word objects,
6549 since the processor will only fetch one 32-bit aligned object from
6552 The default setting for most targets is @option{-mno-alignment-traps}, since
6553 this produces better code when there are no half-word memory
6554 instructions available.
6556 @item -mshort-load-bytes
6557 @itemx -mno-short-load-words
6558 @opindex mshort-load-bytes
6559 @opindex mno-short-load-words
6560 These are deprecated aliases for @option{-malignment-traps}.
6562 @item -mno-short-load-bytes
6563 @itemx -mshort-load-words
6564 @opindex mno-short-load-bytes
6565 @opindex mshort-load-words
6566 This are deprecated aliases for @option{-mno-alignment-traps}.
6568 @item -mcpu=@var{name}
6570 This specifies the name of the target ARM processor. GCC uses this name
6571 to determine what kind of instructions it can emit when generating
6572 assembly code. Permissible names are: @samp{arm2}, @samp{arm250},
6573 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6574 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6575 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6576 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6577 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6578 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6579 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6580 @samp{arm920t}, @samp{arm926ejs}, @samp{arm940t}, @samp{arm9tdmi},
6581 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ejs},
6582 @samp{arm1136js}, @samp{arm1136jfs} ,@samp{xscale}, @samp{iwmmxt},
6585 @itemx -mtune=@var{name}
6587 This option is very similar to the @option{-mcpu=} option, except that
6588 instead of specifying the actual target processor type, and hence
6589 restricting which instructions can be used, it specifies that GCC should
6590 tune the performance of the code as if the target were of the type
6591 specified in this option, but still choosing the instructions that it
6592 will generate based on the cpu specified by a @option{-mcpu=} option.
6593 For some ARM implementations better performance can be obtained by using
6596 @item -march=@var{name}
6598 This specifies the name of the target ARM architecture. GCC uses this
6599 name to determine what kind of instructions it can emit when generating
6600 assembly code. This option can be used in conjunction with or instead
6601 of the @option{-mcpu=} option. Permissible names are: @samp{armv2},
6602 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6603 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
6604 @samp{iwmmxt}, @samp{ep9312}.
6606 @item -mfpu=@var{name}
6607 @itemx -mfpe=@var{number}
6608 @itemx -mfp=@var{number}
6612 This specifies what floating point hardware (or hardware emulation) is
6613 available on the target. Permissible names are: @samp{fpa}, @samp{fpe2},
6614 @samp{fpe3}, @samp{maverick}, @samp{vfp}. @option{-mfp} and @option{-mfpe}
6615 are synonyms for @option{-mpfu}=@samp{fpe}@var{number}, for compatibility
6616 with older versions of GCC@.
6618 If @option{-msoft-float} is specified this specifies the format of
6619 floating point values.
6621 @item -mstructure-size-boundary=@var{n}
6622 @opindex mstructure-size-boundary
6623 The size of all structures and unions will be rounded up to a multiple
6624 of the number of bits set by this option. Permissible values are 8 and
6625 32. The default value varies for different toolchains. For the COFF
6626 targeted toolchain the default value is 8. Specifying the larger number
6627 can produce faster, more efficient code, but can also increase the size
6628 of the program. The two values are potentially incompatible. Code
6629 compiled with one value cannot necessarily expect to work with code or
6630 libraries compiled with the other value, if they exchange information
6631 using structures or unions.
6633 @item -mabort-on-noreturn
6634 @opindex mabort-on-noreturn
6635 Generate a call to the function @code{abort} at the end of a
6636 @code{noreturn} function. It will be executed if the function tries to
6640 @itemx -mno-long-calls
6641 @opindex mlong-calls
6642 @opindex mno-long-calls
6643 Tells the compiler to perform function calls by first loading the
6644 address of the function into a register and then performing a subroutine
6645 call on this register. This switch is needed if the target function
6646 will lie outside of the 64 megabyte addressing range of the offset based
6647 version of subroutine call instruction.
6649 Even if this switch is enabled, not all function calls will be turned
6650 into long calls. The heuristic is that static functions, functions
6651 which have the @samp{short-call} attribute, functions that are inside
6652 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6653 definitions have already been compiled within the current compilation
6654 unit, will not be turned into long calls. The exception to this rule is
6655 that weak function definitions, functions with the @samp{long-call}
6656 attribute or the @samp{section} attribute, and functions that are within
6657 the scope of a @samp{#pragma long_calls} directive, will always be
6658 turned into long calls.
6660 This feature is not enabled by default. Specifying
6661 @option{-mno-long-calls} will restore the default behavior, as will
6662 placing the function calls within the scope of a @samp{#pragma
6663 long_calls_off} directive. Note these switches have no effect on how
6664 the compiler generates code to handle function calls via function
6667 @item -mnop-fun-dllimport
6668 @opindex mnop-fun-dllimport
6669 Disable support for the @code{dllimport} attribute.
6671 @item -msingle-pic-base
6672 @opindex msingle-pic-base
6673 Treat the register used for PIC addressing as read-only, rather than
6674 loading it in the prologue for each function. The run-time system is
6675 responsible for initializing this register with an appropriate value
6676 before execution begins.
6678 @item -mpic-register=@var{reg}
6679 @opindex mpic-register
6680 Specify the register to be used for PIC addressing. The default is R10
6681 unless stack-checking is enabled, when R9 is used.
6683 @item -mcirrus-fix-invalid-insns
6684 @opindex mcirrus-fix-invalid-insns
6685 @opindex mno-cirrus-fix-invalid-insns
6686 Insert NOPs into the instruction stream to in order to work around
6687 problems with invalid Maverick instruction combinations. This option
6688 is only valid if the @option{-mcpu=ep9312} option has been used to
6689 enable generation of instructions for the Cirrus Maverick floating
6690 point co-processor. This option is not enabled by default, since the
6691 problem is only present in older Maverick implementations. The default
6692 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6695 @item -mpoke-function-name
6696 @opindex mpoke-function-name
6697 Write the name of each function into the text section, directly
6698 preceding the function prologue. The generated code is similar to this:
6702 .ascii "arm_poke_function_name", 0
6705 .word 0xff000000 + (t1 - t0)
6706 arm_poke_function_name
6708 stmfd sp!, @{fp, ip, lr, pc@}
6712 When performing a stack backtrace, code can inspect the value of
6713 @code{pc} stored at @code{fp + 0}. If the trace function then looks at
6714 location @code{pc - 12} and the top 8 bits are set, then we know that
6715 there is a function name embedded immediately preceding this location
6716 and has length @code{((pc[-3]) & 0xff000000)}.
6720 Generate code for the 16-bit Thumb instruction set. The default is to
6721 use the 32-bit ARM instruction set.
6724 @opindex mtpcs-frame
6725 Generate a stack frame that is compliant with the Thumb Procedure Call
6726 Standard for all non-leaf functions. (A leaf function is one that does
6727 not call any other functions.) The default is @option{-mno-tpcs-frame}.
6729 @item -mtpcs-leaf-frame
6730 @opindex mtpcs-leaf-frame
6731 Generate a stack frame that is compliant with the Thumb Procedure Call
6732 Standard for all leaf functions. (A leaf function is one that does
6733 not call any other functions.) The default is @option{-mno-apcs-leaf-frame}.
6735 @item -mcallee-super-interworking
6736 @opindex mcallee-super-interworking
6737 Gives all externally visible functions in the file being compiled an ARM
6738 instruction set header which switches to Thumb mode before executing the
6739 rest of the function. This allows these functions to be called from
6740 non-interworking code.
6742 @item -mcaller-super-interworking
6743 @opindex mcaller-super-interworking
6744 Allows calls via function pointers (including virtual functions) to
6745 execute correctly regardless of whether the target code has been
6746 compiled for interworking or not. There is a small overhead in the cost
6747 of executing a function pointer if this option is enabled.
6751 @node MN10300 Options
6752 @subsection MN10300 Options
6753 @cindex MN10300 options
6755 These @option{-m} options are defined for Matsushita MN10300 architectures:
6760 Generate code to avoid bugs in the multiply instructions for the MN10300
6761 processors. This is the default.
6764 @opindex mno-mult-bug
6765 Do not generate code to avoid bugs in the multiply instructions for the
6770 Generate code which uses features specific to the AM33 processor.
6774 Do not generate code which uses features specific to the AM33 processor. This
6779 Do not link in the C run-time initialization object file.
6783 Indicate to the linker that it should perform a relaxation optimization pass
6784 to shorten branches, calls and absolute memory addresses. This option only
6785 has an effect when used on the command line for the final link step.
6787 This option makes symbolic debugging impossible.
6791 @node M32R/D Options
6792 @subsection M32R/D Options
6793 @cindex M32R/D options
6795 These @option{-m} options are defined for Renesas M32R/D architectures:
6800 Generate code for the M32R/2@.
6804 Generate code for the M32R/X@.
6808 Generate code for the M32R@. This is the default.
6811 @opindex mmodel=small
6812 Assume all objects live in the lower 16MB of memory (so that their addresses
6813 can be loaded with the @code{ld24} instruction), and assume all subroutines
6814 are reachable with the @code{bl} instruction.
6815 This is the default.
6817 The addressability of a particular object can be set with the
6818 @code{model} attribute.
6820 @item -mmodel=medium
6821 @opindex mmodel=medium
6822 Assume objects may be anywhere in the 32-bit address space (the compiler
6823 will generate @code{seth/add3} instructions to load their addresses), and
6824 assume all subroutines are reachable with the @code{bl} instruction.
6827 @opindex mmodel=large
6828 Assume objects may be anywhere in the 32-bit address space (the compiler
6829 will generate @code{seth/add3} instructions to load their addresses), and
6830 assume subroutines may not be reachable with the @code{bl} instruction
6831 (the compiler will generate the much slower @code{seth/add3/jl}
6832 instruction sequence).
6835 @opindex msdata=none
6836 Disable use of the small data area. Variables will be put into
6837 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6838 @code{section} attribute has been specified).
6839 This is the default.
6841 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6842 Objects may be explicitly put in the small data area with the
6843 @code{section} attribute using one of these sections.
6846 @opindex msdata=sdata
6847 Put small global and static data in the small data area, but do not
6848 generate special code to reference them.
6852 Put small global and static data in the small data area, and generate
6853 special instructions to reference them.
6857 @cindex smaller data references
6858 Put global and static objects less than or equal to @var{num} bytes
6859 into the small data or bss sections instead of the normal data or bss
6860 sections. The default value of @var{num} is 8.
6861 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6862 for this option to have any effect.
6864 All modules should be compiled with the same @option{-G @var{num}} value.
6865 Compiling with different values of @var{num} may or may not work; if it
6866 doesn't the linker will give an error message---incorrect code will not be
6871 Makes the M32R specific code in the compiler display some statistics
6872 that might help in debugging programs.
6875 @opindex malign-loops
6876 Align all loops to a 32-byte boundary.
6878 @item -mno-align-loops
6879 @opindex mno-align-loops
6880 Do not enforce a 32-byte alignment for loops. This is the default.
6882 @item -missue-rate=@var{number}
6883 @opindex missue-rate=@var{number}
6884 Issue @var{number} instructions per cycle. @var{number} can only be 1
6887 @item -mbranch-cost=@var{number}
6888 @opindex mbranch-cost=@var{number}
6889 @var{number} can only be 1 or 2. If it is 1 then branches will be
6890 preferred over conditional code, if it is 2, then the opposite will
6893 @item -mflush-trap=@var{number}
6894 @opindex mflush-trap=@var{number}
6895 Specifies the trap number to use to flush the cache. The default is
6896 12. Valid numbers are between 0 and 15 inclusive.
6898 @item -mno-flush-trap
6899 @opindex mno-flush-trap
6900 Specifies that the cache cannot be flushed by using a trap.
6902 @item -mflush-func=@var{name}
6903 @opindex mflush-func=@var{name}
6904 Specifies the name of the operating system function to call to flush
6905 the cache. The default is @emph{_flush_cache}, but a function call
6906 will only be used if a trap is not available.
6908 @item -mno-flush-func
6909 @opindex mno-flush-func
6910 Indicates that there is no OS function for flushing the cache.
6914 @node RS/6000 and PowerPC Options
6915 @subsection IBM RS/6000 and PowerPC Options
6916 @cindex RS/6000 and PowerPC Options
6917 @cindex IBM RS/6000 and PowerPC Options
6919 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6927 @itemx -mpowerpc-gpopt
6928 @itemx -mno-powerpc-gpopt
6929 @itemx -mpowerpc-gfxopt
6930 @itemx -mno-powerpc-gfxopt
6932 @itemx -mno-powerpc64
6938 @opindex mno-powerpc
6939 @opindex mpowerpc-gpopt
6940 @opindex mno-powerpc-gpopt
6941 @opindex mpowerpc-gfxopt
6942 @opindex mno-powerpc-gfxopt
6944 @opindex mno-powerpc64
6945 GCC supports two related instruction set architectures for the
6946 RS/6000 and PowerPC@. The @dfn{POWER} instruction set are those
6947 instructions supported by the @samp{rios} chip set used in the original
6948 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6949 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6950 the IBM 4xx microprocessors.
6952 Neither architecture is a subset of the other. However there is a
6953 large common subset of instructions supported by both. An MQ
6954 register is included in processors supporting the POWER architecture.
6956 You use these options to specify which instructions are available on the
6957 processor you are using. The default value of these options is
6958 determined when configuring GCC@. Specifying the
6959 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6960 options. We recommend you use the @option{-mcpu=@var{cpu_type}} option
6961 rather than the options listed above.
6963 The @option{-mpower} option allows GCC to generate instructions that
6964 are found only in the POWER architecture and to use the MQ register.
6965 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6966 to generate instructions that are present in the POWER2 architecture but
6967 not the original POWER architecture.
6969 The @option{-mpowerpc} option allows GCC to generate instructions that
6970 are found only in the 32-bit subset of the PowerPC architecture.
6971 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6972 GCC to use the optional PowerPC architecture instructions in the
6973 General Purpose group, including floating-point square root. Specifying
6974 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6975 use the optional PowerPC architecture instructions in the Graphics
6976 group, including floating-point select.
6978 The @option{-mpowerpc64} option allows GCC to generate the additional
6979 64-bit instructions that are found in the full PowerPC64 architecture
6980 and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to
6981 @option{-mno-powerpc64}.
6983 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6984 will use only the instructions in the common subset of both
6985 architectures plus some special AIX common-mode calls, and will not use
6986 the MQ register. Specifying both @option{-mpower} and @option{-mpowerpc}
6987 permits GCC to use any instruction from either architecture and to
6988 allow use of the MQ register; specify this for the Motorola MPC601.
6990 @item -mnew-mnemonics
6991 @itemx -mold-mnemonics
6992 @opindex mnew-mnemonics
6993 @opindex mold-mnemonics
6994 Select which mnemonics to use in the generated assembler code. With
6995 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6996 the PowerPC architecture. With @option{-mold-mnemonics} it uses the
6997 assembler mnemonics defined for the POWER architecture. Instructions
6998 defined in only one architecture have only one mnemonic; GCC uses that
6999 mnemonic irrespective of which of these options is specified.
7001 GCC defaults to the mnemonics appropriate for the architecture in
7002 use. Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
7003 value of these option. Unless you are building a cross-compiler, you
7004 should normally not specify either @option{-mnew-mnemonics} or
7005 @option{-mold-mnemonics}, but should instead accept the default.
7007 @item -mcpu=@var{cpu_type}
7009 Set architecture type, register usage, choice of mnemonics, and
7010 instruction scheduling parameters for machine type @var{cpu_type}.
7011 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
7012 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
7013 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
7014 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
7015 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
7016 @samp{860}, @samp{970}, @samp{common}, @samp{ec603e}, @samp{G3},
7017 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
7018 @samp{power4}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
7019 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64a}.
7021 @option{-mcpu=common} selects a completely generic processor. Code
7022 generated under this option will run on any POWER or PowerPC processor.
7023 GCC will use only the instructions in the common subset of both
7024 architectures, and will not use the MQ register. GCC assumes a generic
7025 processor model for scheduling purposes.
7027 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
7028 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
7029 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
7030 types, with an appropriate, generic processor model assumed for
7031 scheduling purposes.
7033 The other options specify a specific processor. Code generated under
7034 those options will run best on that processor, and may not run at all on
7037 The @option{-mcpu} options automatically enable or disable the
7038 following options: @option{-maltivec}, @option{-mhard-float},
7039 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
7040 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
7041 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
7042 @option{-mstring}. The particular options set for any particular CPU
7043 will vary between compiler versions, depending on what setting seems
7044 to produce optimal code for that CPU; it doesn't necessarily reflect
7045 the actual hardware's capabilities. If you wish to set an individual
7046 option to a particular value, you may specify it after the
7047 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
7049 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
7050 not enabled or disabled by the @option{-mcpu} option at present, since
7051 AIX does not have full support for these options. You may still
7052 enable or disable them individually if you're sure it'll work in your
7055 @item -mtune=@var{cpu_type}
7057 Set the instruction scheduling parameters for machine type
7058 @var{cpu_type}, but do not set the architecture type, register usage, or
7059 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would. The same
7060 values for @var{cpu_type} are used for @option{-mtune} as for
7061 @option{-mcpu}. If both are specified, the code generated will use the
7062 architecture, registers, and mnemonics set by @option{-mcpu}, but the
7063 scheduling parameters set by @option{-mtune}.
7068 @opindex mno-altivec
7069 These switches enable or disable the use of built-in functions that
7070 allow access to the AltiVec instruction set. You may also need to set
7071 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
7076 Extend the current ABI with SPE ABI extensions. This does not change
7077 the default ABI, instead it adds the SPE ABI extensions to the current
7081 @opindex mabi=no-spe
7082 Disable Booke SPE ABI extensions for the current ABI.
7084 @item -misel=@var{yes/no}
7087 This switch enables or disables the generation of ISEL instructions.
7089 @item -mspe=@var{yes/no}
7092 This switch enables or disables the generation of SPE simd
7095 @item -mfloat-gprs=@var{yes/no}
7097 @opindex mfloat-gprs
7098 This switch enables or disables the generation of floating point
7099 operations on the general purpose registers for architectures that
7100 support it. This option is currently only available on the MPC8540.
7103 @itemx -mno-fp-in-toc
7104 @itemx -mno-sum-in-toc
7105 @itemx -mminimal-toc
7107 @opindex mno-fp-in-toc
7108 @opindex mno-sum-in-toc
7109 @opindex mminimal-toc
7110 Modify generation of the TOC (Table Of Contents), which is created for
7111 every executable file. The @option{-mfull-toc} option is selected by
7112 default. In that case, GCC will allocate at least one TOC entry for
7113 each unique non-automatic variable reference in your program. GCC
7114 will also place floating-point constants in the TOC@. However, only
7115 16,384 entries are available in the TOC@.
7117 If you receive a linker error message that saying you have overflowed
7118 the available TOC space, you can reduce the amount of TOC space used
7119 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
7120 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
7121 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
7122 generate code to calculate the sum of an address and a constant at
7123 run-time instead of putting that sum into the TOC@. You may specify one
7124 or both of these options. Each causes GCC to produce very slightly
7125 slower and larger code at the expense of conserving TOC space.
7127 If you still run out of space in the TOC even when you specify both of
7128 these options, specify @option{-mminimal-toc} instead. This option causes
7129 GCC to make only one TOC entry for every file. When you specify this
7130 option, GCC will produce code that is slower and larger but which
7131 uses extremely little TOC space. You may wish to use this option
7132 only on files that contain less frequently executed code.
7138 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
7139 @code{long} type, and the infrastructure needed to support them.
7140 Specifying @option{-maix64} implies @option{-mpowerpc64} and
7141 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
7142 implies @option{-mno-powerpc64}. GCC defaults to @option{-maix32}.
7147 @opindex mno-xl-call
7148 On AIX, pass floating-point arguments to prototyped functions beyond the
7149 register save area (RSA) on the stack in addition to argument FPRs. The
7150 AIX calling convention was extended but not initially documented to
7151 handle an obscure K&R C case of calling a function that takes the
7152 address of its arguments with fewer arguments than declared. AIX XL
7153 compilers access floating point arguments which do not fit in the
7154 RSA from the stack when a subroutine is compiled without
7155 optimization. Because always storing floating-point arguments on the
7156 stack is inefficient and rarely needed, this option is not enabled by
7157 default and only is necessary when calling subroutines compiled by AIX
7158 XL compilers without optimization.
7162 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@. Link an
7163 application written to use message passing with special startup code to
7164 enable the application to run. The system must have PE installed in the
7165 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
7166 must be overridden with the @option{-specs=} option to specify the
7167 appropriate directory location. The Parallel Environment does not
7168 support threads, so the @option{-mpe} option and the @option{-pthread}
7169 option are incompatible.
7171 @item -malign-natural
7172 @itemx -malign-power
7173 @opindex malign-natural
7174 @opindex malign-power
7175 On AIX, Darwin, and 64-bit PowerPC GNU/Linux, the option
7176 @option{-malign-natural} overrides the ABI-defined alignment of larger
7177 types, such as floating-point doubles, on their natural size-based boundary.
7178 The option @option{-malign-power} instructs GCC to follow the ABI-specified
7179 alignment rules. GCC defaults to the standard alignment defined in the ABI.
7183 @opindex msoft-float
7184 @opindex mhard-float
7185 Generate code that does not use (uses) the floating-point register set.
7186 Software floating point emulation is provided if you use the
7187 @option{-msoft-float} option, and pass the option to GCC when linking.
7190 @itemx -mno-multiple
7192 @opindex mno-multiple
7193 Generate code that uses (does not use) the load multiple word
7194 instructions and the store multiple word instructions. These
7195 instructions are generated by default on POWER systems, and not
7196 generated on PowerPC systems. Do not use @option{-mmultiple} on little
7197 endian PowerPC systems, since those instructions do not work when the
7198 processor is in little endian mode. The exceptions are PPC740 and
7199 PPC750 which permit the instructions usage in little endian mode.
7205 Generate code that uses (does not use) the load string instructions
7206 and the store string word instructions to save multiple registers and
7207 do small block moves. These instructions are generated by default on
7208 POWER systems, and not generated on PowerPC systems. Do not use
7209 @option{-mstring} on little endian PowerPC systems, since those
7210 instructions do not work when the processor is in little endian mode.
7211 The exceptions are PPC740 and PPC750 which permit the instructions
7212 usage in little endian mode.
7218 Generate code that uses (does not use) the load or store instructions
7219 that update the base register to the address of the calculated memory
7220 location. These instructions are generated by default. If you use
7221 @option{-mno-update}, there is a small window between the time that the
7222 stack pointer is updated and the address of the previous frame is
7223 stored, which means code that walks the stack frame across interrupts or
7224 signals may get corrupted data.
7227 @itemx -mno-fused-madd
7228 @opindex mfused-madd
7229 @opindex mno-fused-madd
7230 Generate code that uses (does not use) the floating point multiply and
7231 accumulate instructions. These instructions are generated by default if
7232 hardware floating is used.
7234 @item -mno-bit-align
7236 @opindex mno-bit-align
7238 On System V.4 and embedded PowerPC systems do not (do) force structures
7239 and unions that contain bit-fields to be aligned to the base type of the
7242 For example, by default a structure containing nothing but 8
7243 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7244 boundary and have a size of 4 bytes. By using @option{-mno-bit-align},
7245 the structure would be aligned to a 1 byte boundary and be one byte in
7248 @item -mno-strict-align
7249 @itemx -mstrict-align
7250 @opindex mno-strict-align
7251 @opindex mstrict-align
7252 On System V.4 and embedded PowerPC systems do not (do) assume that
7253 unaligned memory references will be handled by the system.
7256 @itemx -mno-relocatable
7257 @opindex mrelocatable
7258 @opindex mno-relocatable
7259 On embedded PowerPC systems generate code that allows (does not allow)
7260 the program to be relocated to a different address at runtime. If you
7261 use @option{-mrelocatable} on any module, all objects linked together must
7262 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7264 @item -mrelocatable-lib
7265 @itemx -mno-relocatable-lib
7266 @opindex mrelocatable-lib
7267 @opindex mno-relocatable-lib
7268 On embedded PowerPC systems generate code that allows (does not allow)
7269 the program to be relocated to a different address at runtime. Modules
7270 compiled with @option{-mrelocatable-lib} can be linked with either modules
7271 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7272 with modules compiled with the @option{-mrelocatable} options.
7278 On System V.4 and embedded PowerPC systems do not (do) assume that
7279 register 2 contains a pointer to a global area pointing to the addresses
7280 used in the program.
7283 @itemx -mlittle-endian
7285 @opindex mlittle-endian
7286 On System V.4 and embedded PowerPC systems compile code for the
7287 processor in little endian mode. The @option{-mlittle-endian} option is
7288 the same as @option{-mlittle}.
7293 @opindex mbig-endian
7294 On System V.4 and embedded PowerPC systems compile code for the
7295 processor in big endian mode. The @option{-mbig-endian} option is
7296 the same as @option{-mbig}.
7298 @item -mdynamic-no-pic
7299 @opindex mdynamic-no-pic
7300 On Darwin and Mac OS X systems, compile code so that it is not
7301 relocatable, but that its external references are relocatable. The
7302 resulting code is suitable for applications, but not shared
7305 @item -mprioritize-restricted-insns=@var{priority}
7306 @opindex mprioritize-restricted-insns
7307 This option controls the priority that is assigned to
7308 dispatch-slot restricted instructions during the second scheduling
7309 pass. The argument @var{priority} takes the value @var{0/1/2} to assign
7310 @var{no/highest/second-highest} priority to dispatch slot restricted
7313 @item -msched-costly-dep=@var{dependence_type}
7314 @opindex msched-costly-dep
7315 This option controls which dependences are considered costly
7316 by the target during instruction scheduling. The argument
7317 @var{dependence_type} takes one of the following values:
7318 @var{no}: no dependence is costly,
7319 @var{all}: all dependences are costly,
7320 @var{true_store_to_load}: a true dependence from store to load is costly,
7321 @var{store_to_load}: any dependence from store to load is costly,
7322 @var{number}: any dependence which latency >= @var{number} is costly.
7324 @item -minsert-sched-nops=@var{scheme}
7325 @opindex minsert-sched-nops
7326 This option controls which nop insertion scheme will be used during
7327 the second scheduling pass. The argument @var{scheme} takes one of the
7329 @var{no}: Don't insert nops.
7330 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
7331 according to the scheduler's grouping.
7332 @var{regroup_exact}: Insert nops to force costly dependent insns into
7333 separate groups. Insert exactly as many nops as needed to force an insn
7334 to a new group, according to the estimated processor grouping.
7335 @var{number}: Insert nops to force costly dependent insns into
7336 separate groups. Insert @var{number} nops to force an insn to a new group.
7340 On System V.4 and embedded PowerPC systems compile code using calling
7341 conventions that adheres to the March 1995 draft of the System V
7342 Application Binary Interface, PowerPC processor supplement. This is the
7343 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7345 @item -mcall-sysv-eabi
7346 @opindex mcall-sysv-eabi
7347 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7349 @item -mcall-sysv-noeabi
7350 @opindex mcall-sysv-noeabi
7351 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7353 @item -mcall-solaris
7354 @opindex mcall-solaris
7355 On System V.4 and embedded PowerPC systems compile code for the Solaris
7359 @opindex mcall-linux
7360 On System V.4 and embedded PowerPC systems compile code for the
7361 Linux-based GNU system.
7365 On System V.4 and embedded PowerPC systems compile code for the
7366 Hurd-based GNU system.
7369 @opindex mcall-netbsd
7370 On System V.4 and embedded PowerPC systems compile code for the
7371 NetBSD operating system.
7373 @item -maix-struct-return
7374 @opindex maix-struct-return
7375 Return all structures in memory (as specified by the AIX ABI)@.
7377 @item -msvr4-struct-return
7378 @opindex msvr4-struct-return
7379 Return structures smaller than 8 bytes in registers (as specified by the
7383 @opindex mabi=altivec
7384 Extend the current ABI with AltiVec ABI extensions. This does not
7385 change the default ABI, instead it adds the AltiVec ABI extensions to
7388 @item -mabi=no-altivec
7389 @opindex mabi=no-altivec
7390 Disable AltiVec ABI extensions for the current ABI.
7393 @itemx -mno-prototype
7395 @opindex mno-prototype
7396 On System V.4 and embedded PowerPC systems assume that all calls to
7397 variable argument functions are properly prototyped. Otherwise, the
7398 compiler must insert an instruction before every non prototyped call to
7399 set or clear bit 6 of the condition code register (@var{CR}) to
7400 indicate whether floating point values were passed in the floating point
7401 registers in case the function takes a variable arguments. With
7402 @option{-mprototype}, only calls to prototyped variable argument functions
7403 will set or clear the bit.
7407 On embedded PowerPC systems, assume that the startup module is called
7408 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7409 @file{libc.a}. This is the default for @samp{powerpc-*-eabisim}.
7414 On embedded PowerPC systems, assume that the startup module is called
7415 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7420 On embedded PowerPC systems, assume that the startup module is called
7421 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7425 @opindex myellowknife
7426 On embedded PowerPC systems, assume that the startup module is called
7427 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7432 On System V.4 and embedded PowerPC systems, specify that you are
7433 compiling for a VxWorks system.
7437 Specify that you are compiling for the WindISS simulation environment.
7441 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7442 header to indicate that @samp{eabi} extended relocations are used.
7448 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7449 Embedded Applications Binary Interface (eabi) which is a set of
7450 modifications to the System V.4 specifications. Selecting @option{-meabi}
7451 means that the stack is aligned to an 8 byte boundary, a function
7452 @code{__eabi} is called to from @code{main} to set up the eabi
7453 environment, and the @option{-msdata} option can use both @code{r2} and
7454 @code{r13} to point to two separate small data areas. Selecting
7455 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7456 do not call an initialization function from @code{main}, and the
7457 @option{-msdata} option will only use @code{r13} to point to a single
7458 small data area. The @option{-meabi} option is on by default if you
7459 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7462 @opindex msdata=eabi
7463 On System V.4 and embedded PowerPC systems, put small initialized
7464 @code{const} global and static data in the @samp{.sdata2} section, which
7465 is pointed to by register @code{r2}. Put small initialized
7466 non-@code{const} global and static data in the @samp{.sdata} section,
7467 which is pointed to by register @code{r13}. Put small uninitialized
7468 global and static data in the @samp{.sbss} section, which is adjacent to
7469 the @samp{.sdata} section. The @option{-msdata=eabi} option is
7470 incompatible with the @option{-mrelocatable} option. The
7471 @option{-msdata=eabi} option also sets the @option{-memb} option.
7474 @opindex msdata=sysv
7475 On System V.4 and embedded PowerPC systems, put small global and static
7476 data in the @samp{.sdata} section, which is pointed to by register
7477 @code{r13}. Put small uninitialized global and static data in the
7478 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7479 The @option{-msdata=sysv} option is incompatible with the
7480 @option{-mrelocatable} option.
7482 @item -msdata=default
7484 @opindex msdata=default
7486 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7487 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7488 same as @option{-msdata=sysv}.
7491 @opindex msdata-data
7492 On System V.4 and embedded PowerPC systems, put small global and static
7493 data in the @samp{.sdata} section. Put small uninitialized global and
7494 static data in the @samp{.sbss} section. Do not use register @code{r13}
7495 to address small data however. This is the default behavior unless
7496 other @option{-msdata} options are used.
7500 @opindex msdata=none
7502 On embedded PowerPC systems, put all initialized global and static data
7503 in the @samp{.data} section, and all uninitialized data in the
7504 @samp{.bss} section.
7508 @cindex smaller data references (PowerPC)
7509 @cindex .sdata/.sdata2 references (PowerPC)
7510 On embedded PowerPC systems, put global and static items less than or
7511 equal to @var{num} bytes into the small data or bss sections instead of
7512 the normal data or bss section. By default, @var{num} is 8. The
7513 @option{-G @var{num}} switch is also passed to the linker.
7514 All modules should be compiled with the same @option{-G @var{num}} value.
7517 @itemx -mno-regnames
7519 @opindex mno-regnames
7520 On System V.4 and embedded PowerPC systems do (do not) emit register
7521 names in the assembly language output using symbolic forms.
7524 @itemx -mno-longcall
7526 @opindex mno-longcall
7527 Default to making all function calls via pointers, so that functions
7528 which reside further than 64 megabytes (67,108,864 bytes) from the
7529 current location can be called. This setting can be overridden by the
7530 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7532 Some linkers are capable of detecting out-of-range calls and generating
7533 glue code on the fly. On these systems, long calls are unnecessary and
7534 generate slower code. As of this writing, the AIX linker can do this,
7535 as can the GNU linker for PowerPC/64. It is planned to add this feature
7536 to the GNU linker for 32-bit PowerPC systems as well.
7538 On Mach-O (Darwin) systems, this option directs the compiler emit to
7539 the glue for every direct call, and the Darwin linker decides whether
7540 to use or discard it.
7542 In the future, we may cause GCC to ignore all longcall specifications
7543 when the linker is known to generate glue.
7547 Adds support for multithreading with the @dfn{pthreads} library.
7548 This option sets flags for both the preprocessor and linker.
7552 @node Darwin Options
7553 @subsection Darwin Options
7554 @cindex Darwin options
7556 These options are defined for all architectures running the Darwin operating
7557 system. They are useful for compatibility with other Mac OS compilers.
7562 Loads all members of static archive libraries.
7563 See man ld(1) for more information.
7565 @item -arch_errors_fatal
7566 @opindex arch_errors_fatal
7567 Cause the errors having to do with files that have the wrong architecture
7571 @opindex bind_at_load
7572 Causes the output file to be marked such that the dynamic linker will
7573 bind all undefined references when the file is loaded or launched.
7577 Produce a Mach-o bundle format file.
7578 See man ld(1) for more information.
7580 @item -bundle_loader @var{executable}
7581 @opindex bundle_loader
7582 This specifies the @var{executable} that will be loading the build
7583 output file being linked. See man ld(1) for more information.
7585 @item -allowable_client @var{client_name}
7589 @itemx -compatibility_version
7590 @itemx -current_version
7591 @itemx -dependency-file
7593 @itemx -dylinker_install_name
7596 @itemx -exported_symbols_list
7598 @itemx -flat_namespace
7599 @itemx -force_cpusubtype_ALL
7600 @itemx -force_flat_namespace
7601 @itemx -headerpad_max_install_names
7604 @itemx -install_name
7605 @itemx -keep_private_externs
7606 @itemx -multi_module
7607 @itemx -multiply_defined
7608 @itemx -multiply_defined_unused
7610 @itemx -nofixprebinding
7613 @itemx -noseglinkedit
7614 @itemx -pagezero_size
7616 @itemx -prebind_all_twolevel_modules
7617 @itemx -private_bundle
7618 @itemx -read_only_relocs
7620 @itemx -sectobjectsymbols
7624 @itemx -sectobjectsymbols
7626 @itemx -seg_addr_table
7627 @itemx -seg_addr_table_filename
7630 @itemx -segs_read_only_addr
7631 @itemx -segs_read_write_addr
7632 @itemx -single_module
7635 @itemx -sub_umbrella
7636 @itemx -twolevel_namespace
7639 @itemx -unexported_symbols_list
7640 @itemx -weak_reference_mismatches
7643 @opindex allowable_client
7645 @opindex client_name
7646 @opindex compatibility_version
7647 @opindex current_version
7648 @opindex dependency-file
7650 @opindex dylinker_install_name
7653 @opindex exported_symbols_list
7655 @opindex flat_namespace
7656 @opindex force_cpusubtype_ALL
7657 @opindex force_flat_namespace
7658 @opindex headerpad_max_install_names
7661 @opindex install_name
7662 @opindex keep_private_externs
7663 @opindex multi_module
7664 @opindex multiply_defined
7665 @opindex multiply_defined_unused
7667 @opindex nofixprebinding
7668 @opindex nomultidefs
7670 @opindex noseglinkedit
7671 @opindex pagezero_size
7673 @opindex prebind_all_twolevel_modules
7674 @opindex private_bundle
7675 @opindex read_only_relocs
7677 @opindex sectobjectsymbols
7681 @opindex sectobjectsymbols
7683 @opindex seg_addr_table
7684 @opindex seg_addr_table_filename
7685 @opindex seglinkedit
7687 @opindex segs_read_only_addr
7688 @opindex segs_read_write_addr
7689 @opindex single_module
7691 @opindex sub_library
7692 @opindex sub_umbrella
7693 @opindex twolevel_namespace
7696 @opindex unexported_symbols_list
7697 @opindex weak_reference_mismatches
7698 @opindex whatsloaded
7700 These options are available for Darwin linker. Darwin linker man page
7701 describes them in detail.
7706 @subsection MIPS Options
7707 @cindex MIPS options
7713 Generate big-endian code.
7717 Generate little-endian code. This is the default for @samp{mips*el-*-*}
7720 @item -march=@var{arch}
7722 Generate code that will run on @var{arch}, which can be the name of a
7723 generic MIPS ISA, or the name of a particular processor.
7725 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
7726 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
7727 The processor names are:
7728 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7730 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
7731 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
7735 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4300},
7736 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
7737 The special value @samp{from-abi} selects the
7738 most compatible architecture for the selected ABI (that is,
7739 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7741 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7742 (for example, @samp{-march=r2k}). Prefixes are optional, and
7743 @samp{vr} may be written @samp{r}.
7745 GCC defines two macros based on the value of this option. The first
7746 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7747 a string. The second has the form @samp{_MIPS_ARCH_@var{foo}},
7748 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
7749 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7750 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7752 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7753 above. In other words, it will have the full prefix and will not
7754 abbreviate @samp{000} as @samp{k}. In the case of @samp{from-abi},
7755 the macro names the resolved architecture (either @samp{"mips1"} or
7756 @samp{"mips3"}). It names the default architecture when no
7757 @option{-march} option is given.
7759 @item -mtune=@var{arch}
7761 Optimize for @var{arch}. Among other things, this option controls
7762 the way instructions are scheduled, and the perceived cost of arithmetic
7763 operations. The list of @var{arch} values is the same as for
7766 When this option is not used, GCC will optimize for the processor
7767 specified by @option{-march}. By using @option{-march} and
7768 @option{-mtune} together, it is possible to generate code that will
7769 run on a family of processors, but optimize the code for one
7770 particular member of that family.
7772 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7773 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7774 @samp{-march} ones described above.
7778 Equivalent to @samp{-march=mips1}.
7782 Equivalent to @samp{-march=mips2}.
7786 Equivalent to @samp{-march=mips3}.
7790 Equivalent to @samp{-march=mips4}.
7794 Equivalent to @samp{-march=mips32}.
7798 Equivalent to @samp{-march=mips32r2}.
7802 Equivalent to @samp{-march=mips64}.
7808 Use (do not use) the MIPS16 ISA.
7820 Generate code for the given ABI@.
7822 Note that the EABI has a 32-bit and a 64-bit variant. GCC normally
7823 generates 64-bit code when you select a 64-bit architecture, but you
7824 can use @option{-mgp32} to get 32-bit code instead.
7827 @itemx -mno-abicalls
7829 @opindex mno-abicalls
7830 Generate (do not generate) SVR4-style position-independent code.
7831 @option{-mabicalls} is the default for SVR4-based systems.
7837 Lift (do not lift) the usual restrictions on the size of the global
7840 GCC normally uses a single instruction to load values from the GOT.
7841 While this is relatively efficient, it will only work if the GOT
7842 is smaller than about 64k. Anything larger will cause the linker
7843 to report an error such as:
7845 @cindex relocation truncated to fit (MIPS)
7847 relocation truncated to fit: R_MIPS_GOT16 foobar
7850 If this happens, you should recompile your code with @option{-mxgot}.
7851 It should then work with very large GOTs, although it will also be
7852 less efficient, since it will take three instructions to fetch the
7853 value of a global symbol.
7855 Note that some linkers can create multiple GOTs. If you have such a
7856 linker, you should only need to use @option{-mxgot} when a single object
7857 file accesses more than 64k's worth of GOT entries. Very few do.
7859 These options have no effect unless GCC is generating position
7862 @item -membedded-pic
7863 @itemx -mno-embedded-pic
7864 @opindex membedded-pic
7865 @opindex mno-embedded-pic
7866 Generate (do not generate) position-independent code suitable for some
7867 embedded systems. All calls are made using PC relative addresses, and
7868 all data is addressed using the $gp register. No more than 65536
7869 bytes of global data may be used. This requires GNU as and GNU ld,
7870 which do most of the work.
7874 Assume that general-purpose registers are 32 bits wide.
7878 Assume that general-purpose registers are 64 bits wide.
7882 Assume that floating-point registers are 32 bits wide.
7886 Assume that floating-point registers are 64 bits wide.
7889 @opindex mhard-float
7890 Use floating-point coprocessor instructions.
7893 @opindex msoft-float
7894 Do not use floating-point coprocessor instructions. Implement
7895 floating-point calculations using library calls instead.
7897 @item -msingle-float
7898 @opindex msingle-float
7899 Assume that the floating-point coprocessor only supports single-precision
7902 @itemx -mdouble-float
7903 @opindex mdouble-float
7904 Assume that the floating-point coprocessor supports double-precision
7905 operations. This is the default.
7909 Force @code{int} and @code{long} types to be 64 bits wide. See
7910 @option{-mlong32} for an explanation of the default and the way
7911 that the pointer size is determined.
7915 Force @code{long} types to be 64 bits wide. See @option{-mlong32} for
7916 an explanation of the default and the way that the pointer size is
7921 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
7923 The default size of @code{int}s, @code{long}s and pointers depends on
7924 the ABI@. All the supported ABIs use 32-bit @code{int}s. The n64 ABI
7925 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
7926 32-bit @code{long}s. Pointers are the same size as @code{long}s,
7927 or the same size as integer registers, whichever is smaller.
7931 @cindex smaller data references (MIPS)
7932 @cindex gp-relative references (MIPS)
7933 Put global and static items less than or equal to @var{num} bytes into
7934 the small data or bss section instead of the normal data or bss section.
7935 This allows the data to be accessed using a single instruction.
7937 All modules should be compiled with the same @option{-G @var{num}}
7940 @item -membedded-data
7941 @itemx -mno-embedded-data
7942 @opindex membedded-data
7943 @opindex mno-embedded-data
7944 Allocate variables to the read-only data section first if possible, then
7945 next in the small data section if possible, otherwise in data. This gives
7946 slightly slower code than the default, but reduces the amount of RAM required
7947 when executing, and thus may be preferred for some embedded systems.
7949 @item -muninit-const-in-rodata
7950 @itemx -mno-uninit-const-in-rodata
7951 @opindex muninit-const-in-rodata
7952 @opindex mno-uninit-const-in-rodata
7953 Put uninitialized @code{const} variables in the read-only data section.
7954 This option is only meaningful in conjunction with @option{-membedded-data}.
7956 @item -msplit-addresses
7957 @itemx -mno-split-addresses
7958 @opindex msplit-addresses
7959 @opindex mno-split-addresses
7960 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
7961 relocation operators. This option has been superceded by
7962 @option{-mexplicit-relocs} but is retained for backwards compatibility.
7964 @item -mexplicit-relocs
7965 @itemx -mno-explicit-relocs
7966 @opindex mexplicit-relocs
7967 @opindex mno-explicit-relocs
7968 Use (do not use) assembler relocation operators when dealing with symbolic
7969 addresses. The alternative, selected by @option{-mno-explicit-relocs},
7970 is to use assembler macros instead.
7972 @option{-mexplicit-relocs} is usually the default if GCC was
7973 configured to use an assembler that supports relocation operators.
7974 However, there are two exceptions:
7978 GCC is not yet able to generate explicit relocations for the combination
7979 of @option{-mabi=64} and @option{-mno-abicalls}. This will be addressed
7980 in a future release.
7983 The combination of @option{-mabicalls} and @option{-fno-unit-at-a-time}
7984 implies @option{-mno-explicit-relocs} unless explicitly overridden.
7985 This is because, when generating abicalls, the choice of relocation
7986 depends on whether a symbol is local or global. In some rare cases,
7987 GCC will not be able to decide this until the whole compilation unit
7995 Generate (do not generate) code that refers to registers using their
7996 software names. The default is @option{-mno-rnames}, which tells GCC
7997 to use hardware names like @samp{$4} instead of software names like
7998 @samp{a0}. The only assembler known to support @option{-rnames} is
7999 the Algorithmics assembler.
8001 @item -mcheck-zero-division
8002 @itemx -mno-check-zero-division
8003 @opindex mcheck-zero-division
8004 @opindex mno-check-zero-division
8005 Trap (do not trap) on integer division by zero. The default is
8006 @option{-mcheck-zero-division}.
8012 Force (do not force) the use of @code{memcpy()} for non-trivial block
8013 moves. The default is @option{-mno-memcpy}, which allows GCC to inline
8014 most constant-sized copies.
8017 @itemx -mno-long-calls
8018 @opindex mlong-calls
8019 @opindex mno-long-calls
8020 Disable (do not disable) use of the @code{jal} instruction. Calling
8021 functions using @code{jal} is more efficient but requires the caller
8022 and callee to be in the same 256 megabyte segment.
8024 This option has no effect on abicalls code. The default is
8025 @option{-mno-long-calls}.
8031 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
8032 instructions, as provided by the R4650 ISA.
8035 @itemx -mno-fused-madd
8036 @opindex mfused-madd
8037 @opindex mno-fused-madd
8038 Enable (disable) use of the floating point multiply-accumulate
8039 instructions, when they are available. The default is
8040 @option{-mfused-madd}.
8042 When multiply-accumulate instructions are used, the intermediate
8043 product is calculated to infinite precision and is not subject to
8044 the FCSR Flush to Zero bit. This may be undesirable in some
8049 Tell the MIPS assembler to not run its preprocessor over user
8050 assembler files (with a @samp{.s} suffix) when assembling them.
8055 Work around certain SB-1 CPU core errata.
8056 (This flag currently works around the SB-1 revision 2
8057 ``F1'' and ``F2'' floating point errata.)
8059 @item -mflush-func=@var{func}
8060 @itemx -mno-flush-func
8061 @opindex mflush-func
8062 Specifies the function to call to flush the I and D caches, or to not
8063 call any such function. If called, the function must take the same
8064 arguments as the common @code{_flush_func()}, that is, the address of the
8065 memory range for which the cache is being flushed, the size of the
8066 memory range, and the number 3 (to flush both caches). The default
8067 depends on the target gcc was configured for, but commonly is either
8068 @samp{_flush_func} or @samp{__cpu_flush}.
8070 @item -mbranch-likely
8071 @itemx -mno-branch-likely
8072 @opindex mbranch-likely
8073 @opindex mno-branch-likely
8074 Enable or disable use of Branch Likely instructions, regardless of the
8075 default for the selected architecture. By default, Branch Likely
8076 instructions may be generated if they are supported by the selected
8077 architecture. An exception is for the MIPS32 and MIPS64 architectures
8078 and processors which implement those architectures; for those, Branch
8079 Likely instructions will not be generated by default because the MIPS32
8080 and MIPS64 architectures specifically deprecate their use.
8083 @node i386 and x86-64 Options
8084 @subsection Intel 386 and AMD x86-64 Options
8085 @cindex i386 Options
8086 @cindex x86-64 Options
8087 @cindex Intel 386 Options
8088 @cindex AMD x86-64 Options
8090 These @samp{-m} options are defined for the i386 and x86-64 family of
8094 @item -mtune=@var{cpu-type}
8096 Tune to @var{cpu-type} everything applicable about the generated code, except
8097 for the ABI and the set of available instructions. The choices for
8101 Original Intel's i386 CPU.
8103 Intel's i486 CPU. (No scheduling is implemented for this chip.)
8105 Intel Pentium CPU with no MMX support.
8107 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8108 @item i686, pentiumpro
8109 Intel PentiumPro CPU.
8111 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8113 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8116 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8118 AMD K6 CPU with MMX instruction set support.
8120 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8121 @item athlon, athlon-tbird
8122 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8124 @item athlon-4, athlon-xp, athlon-mp
8125 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8126 instruction set support.
8127 @item k8, opteron, athlon64, athlon-fx
8128 AMD K8 core based CPUs with x86-64 instruction set support. (This supersets
8129 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8131 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8134 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8135 instruction set support.
8137 Via C3 CPU with MMX and 3dNOW! instruction set support. (No scheduling is
8138 implemented for this chip.)
8140 Via C3-2 CPU with MMX and SSE instruction set support. (No scheduling is
8141 implemented for this chip.)
8144 While picking a specific @var{cpu-type} will schedule things appropriately
8145 for that particular chip, the compiler will not generate any code that
8146 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8149 @item -march=@var{cpu-type}
8151 Generate instructions for the machine type @var{cpu-type}. The choices
8152 for @var{cpu-type} are the same as for @option{-mtune}. Moreover,
8153 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8155 @item -mcpu=@var{cpu-type}
8157 A deprecated synonym for @option{-mtune}.
8166 @opindex mpentiumpro
8167 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8168 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8169 These synonyms are deprecated.
8171 @item -mfpmath=@var{unit}
8173 Generate floating point arithmetics for selected unit @var{unit}. The choices
8178 Use the standard 387 floating point coprocessor present majority of chips and
8179 emulated otherwise. Code compiled with this option will run almost everywhere.
8180 The temporary results are computed in 80bit precision instead of precision
8181 specified by the type resulting in slightly different results compared to most
8182 of other chips. See @option{-ffloat-store} for more detailed description.
8184 This is the default choice for i386 compiler.
8187 Use scalar floating point instructions present in the SSE instruction set.
8188 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8189 by Athlon-4, Athlon-xp and Athlon-mp chips. The earlier version of SSE
8190 instruction set supports only single precision arithmetics, thus the double and
8191 extended precision arithmetics is still done using 387. Later version, present
8192 only in Pentium4 and the future AMD x86-64 chips supports double precision
8195 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8196 @option{-msse2} switches to enable SSE extensions and make this option
8197 effective. For x86-64 compiler, these extensions are enabled by default.
8199 The resulting code should be considerably faster in the majority of cases and avoid
8200 the numerical instability problems of 387 code, but may break some existing
8201 code that expects temporaries to be 80bit.
8203 This is the default choice for the x86-64 compiler.
8206 Attempt to utilize both instruction sets at once. This effectively double the
8207 amount of available registers and on chips with separate execution units for
8208 387 and SSE the execution resources too. Use this option with care, as it is
8209 still experimental, because the gcc register allocator does not model separate
8210 functional units well resulting in instable performance.
8213 @item -masm=@var{dialect}
8214 @opindex masm=@var{dialect}
8215 Output asm instructions using selected @var{dialect}. Supported choices are
8216 @samp{intel} or @samp{att} (the default one).
8221 @opindex mno-ieee-fp
8222 Control whether or not the compiler uses IEEE floating point
8223 comparisons. These handle correctly the case where the result of a
8224 comparison is unordered.
8227 @opindex msoft-float
8228 Generate output containing library calls for floating point.
8229 @strong{Warning:} the requisite libraries are not part of GCC@.
8230 Normally the facilities of the machine's usual C compiler are used, but
8231 this can't be done directly in cross-compilation. You must make your
8232 own arrangements to provide suitable library functions for
8235 On machines where a function returns floating point results in the 80387
8236 register stack, some floating point opcodes may be emitted even if
8237 @option{-msoft-float} is used.
8239 @item -mno-fp-ret-in-387
8240 @opindex mno-fp-ret-in-387
8241 Do not use the FPU registers for return values of functions.
8243 The usual calling convention has functions return values of types
8244 @code{float} and @code{double} in an FPU register, even if there
8245 is no FPU@. The idea is that the operating system should emulate
8248 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8249 in ordinary CPU registers instead.
8251 @item -mno-fancy-math-387
8252 @opindex mno-fancy-math-387
8253 Some 387 emulators do not support the @code{sin}, @code{cos} and
8254 @code{sqrt} instructions for the 387. Specify this option to avoid
8255 generating those instructions. This option is the default on FreeBSD,
8256 OpenBSD and NetBSD@. This option is overridden when @option{-march}
8257 indicates that the target cpu will always have an FPU and so the
8258 instruction will not need emulation. As of revision 2.6.1, these
8259 instructions are not generated unless you also use the
8260 @option{-funsafe-math-optimizations} switch.
8262 @item -malign-double
8263 @itemx -mno-align-double
8264 @opindex malign-double
8265 @opindex mno-align-double
8266 Control whether GCC aligns @code{double}, @code{long double}, and
8267 @code{long long} variables on a two word boundary or a one word
8268 boundary. Aligning @code{double} variables on a two word boundary will
8269 produce code that runs somewhat faster on a @samp{Pentium} at the
8270 expense of more memory.
8272 @strong{Warning:} if you use the @option{-malign-double} switch,
8273 structures containing the above types will be aligned differently than
8274 the published application binary interface specifications for the 386
8275 and will not be binary compatible with structures in code compiled
8276 without that switch.
8278 @item -m96bit-long-double
8279 @itemx -m128bit-long-double
8280 @opindex m96bit-long-double
8281 @opindex m128bit-long-double
8282 These switches control the size of @code{long double} type. The i386
8283 application binary interface specifies the size to be 96 bits,
8284 so @option{-m96bit-long-double} is the default in 32 bit mode.
8286 Modern architectures (Pentium and newer) would prefer @code{long double}
8287 to be aligned to an 8 or 16 byte boundary. In arrays or structures
8288 conforming to the ABI, this would not be possible. So specifying a
8289 @option{-m128bit-long-double} will align @code{long double}
8290 to a 16 byte boundary by padding the @code{long double} with an additional
8293 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8294 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8296 Notice that neither of these options enable any extra precision over the x87
8297 standard of 80 bits for a @code{long double}.
8299 @strong{Warning:} if you override the default value for your target ABI, the
8300 structures and arrays containing @code{long double} variables will change
8301 their size as well as function calling convention for function taking
8302 @code{long double} will be modified. Hence they will not be binary
8303 compatible with arrays or structures in code compiled without that switch.
8307 @itemx -mno-svr3-shlib
8308 @opindex msvr3-shlib
8309 @opindex mno-svr3-shlib
8310 Control whether GCC places uninitialized local variables into the
8311 @code{bss} or @code{data} segments. @option{-msvr3-shlib} places them
8312 into @code{bss}. These options are meaningful only on System V Release 3.
8316 Use a different function-calling convention, in which functions that
8317 take a fixed number of arguments return with the @code{ret} @var{num}
8318 instruction, which pops their arguments while returning. This saves one
8319 instruction in the caller since there is no need to pop the arguments
8322 You can specify that an individual function is called with this calling
8323 sequence with the function attribute @samp{stdcall}. You can also
8324 override the @option{-mrtd} option by using the function attribute
8325 @samp{cdecl}. @xref{Function Attributes}.
8327 @strong{Warning:} this calling convention is incompatible with the one
8328 normally used on Unix, so you cannot use it if you need to call
8329 libraries compiled with the Unix compiler.
8331 Also, you must provide function prototypes for all functions that
8332 take variable numbers of arguments (including @code{printf});
8333 otherwise incorrect code will be generated for calls to those
8336 In addition, seriously incorrect code will result if you call a
8337 function with too many arguments. (Normally, extra arguments are
8338 harmlessly ignored.)
8340 @item -mregparm=@var{num}
8342 Control how many registers are used to pass integer arguments. By
8343 default, no registers are used to pass arguments, and at most 3
8344 registers can be used. You can control this behavior for a specific
8345 function by using the function attribute @samp{regparm}.
8346 @xref{Function Attributes}.
8348 @strong{Warning:} if you use this switch, and
8349 @var{num} is nonzero, then you must build all modules with the same
8350 value, including any libraries. This includes the system libraries and
8353 @item -mpreferred-stack-boundary=@var{num}
8354 @opindex mpreferred-stack-boundary
8355 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8356 byte boundary. If @option{-mpreferred-stack-boundary} is not specified,
8357 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8358 size (@option{-Os}), in which case the default is the minimum correct
8359 alignment (4 bytes for x86, and 8 bytes for x86-64).
8361 On Pentium and PentiumPro, @code{double} and @code{long double} values
8362 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8363 suffer significant run time performance penalties. On Pentium III, the
8364 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8365 penalties if it is not 16 byte aligned.
8367 To ensure proper alignment of this values on the stack, the stack boundary
8368 must be as aligned as that required by any value stored on the stack.
8369 Further, every function must be generated such that it keeps the stack
8370 aligned. Thus calling a function compiled with a higher preferred
8371 stack boundary from a function compiled with a lower preferred stack
8372 boundary will most likely misalign the stack. It is recommended that
8373 libraries that use callbacks always use the default setting.
8375 This extra alignment does consume extra stack space, and generally
8376 increases code size. Code that is sensitive to stack space usage, such
8377 as embedded systems and operating system kernels, may want to reduce the
8378 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8396 These switches enable or disable the use of built-in functions that allow
8397 direct access to the MMX, SSE, SSE2, PNI and 3Dnow extensions of the
8400 @xref{X86 Built-in Functions}, for details of the functions enabled
8401 and disabled by these switches.
8403 To have SSE/SSE2 instructions generated automatically from floating-point
8404 code, see @option{-mfpmath=sse}.
8407 @itemx -mno-push-args
8409 @opindex mno-push-args
8410 Use PUSH operations to store outgoing parameters. This method is shorter
8411 and usually equally fast as method using SUB/MOV operations and is enabled
8412 by default. In some cases disabling it may improve performance because of
8413 improved scheduling and reduced dependencies.
8415 @item -maccumulate-outgoing-args
8416 @opindex maccumulate-outgoing-args
8417 If enabled, the maximum amount of space required for outgoing arguments will be
8418 computed in the function prologue. This is faster on most modern CPUs
8419 because of reduced dependencies, improved scheduling and reduced stack usage
8420 when preferred stack boundary is not equal to 2. The drawback is a notable
8421 increase in code size. This switch implies @option{-mno-push-args}.
8425 Support thread-safe exception handling on @samp{Mingw32}. Code that relies
8426 on thread-safe exception handling must compile and link all code with the
8427 @option{-mthreads} option. When compiling, @option{-mthreads} defines
8428 @option{-D_MT}; when linking, it links in a special thread helper library
8429 @option{-lmingwthrd} which cleans up per thread exception handling data.
8431 @item -mno-align-stringops
8432 @opindex mno-align-stringops
8433 Do not align destination of inlined string operations. This switch reduces
8434 code size and improves performance in case the destination is already aligned,
8435 but gcc don't know about it.
8437 @item -minline-all-stringops
8438 @opindex minline-all-stringops
8439 By default GCC inlines string operations only when destination is known to be
8440 aligned at least to 4 byte boundary. This enables more inlining, increase code
8441 size, but may improve performance of code that depends on fast memcpy, strlen
8442 and memset for short lengths.
8444 @item -momit-leaf-frame-pointer
8445 @opindex momit-leaf-frame-pointer
8446 Don't keep the frame pointer in a register for leaf functions. This
8447 avoids the instructions to save, set up and restore frame pointers and
8448 makes an extra register available in leaf functions. The option
8449 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8450 which might make debugging harder.
8452 @item -mtls-direct-seg-refs
8453 @itemx -mno-tls-direct-seg-refs
8454 @opindex mtls-direct-seg-refs
8455 Controls whether TLS variables may be accessed with offsets from the
8456 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8457 or whether the thread base pointer must be added. Whether or not this
8458 is legal depends on the operating system, and whether it maps the
8459 segment to cover the entire TLS area.
8461 For systems that use GNU libc, the default is on.
8464 These @samp{-m} switches are supported in addition to the above
8465 on AMD x86-64 processors in 64-bit environments.
8472 Generate code for a 32-bit or 64-bit environment.
8473 The 32-bit environment sets int, long and pointer to 32 bits and
8474 generates code that runs on any i386 system.
8475 The 64-bit environment sets int to 32 bits and long and pointer
8476 to 64 bits and generates code for AMD's x86-64 architecture.
8479 @opindex no-red-zone
8480 Do not use a so called red zone for x86-64 code. The red zone is mandated
8481 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8482 stack pointer that will not be modified by signal or interrupt handlers
8483 and therefore can be used for temporary data without adjusting the stack
8484 pointer. The flag @option{-mno-red-zone} disables this red zone.
8486 @item -mcmodel=small
8487 @opindex mcmodel=small
8488 Generate code for the small code model: the program and its symbols must
8489 be linked in the lower 2 GB of the address space. Pointers are 64 bits.
8490 Programs can be statically or dynamically linked. This is the default
8493 @item -mcmodel=kernel
8494 @opindex mcmodel=kernel
8495 Generate code for the kernel code model. The kernel runs in the
8496 negative 2 GB of the address space.
8497 This model has to be used for Linux kernel code.
8499 @item -mcmodel=medium
8500 @opindex mcmodel=medium
8501 Generate code for the medium model: The program is linked in the lower 2
8502 GB of the address space but symbols can be located anywhere in the
8503 address space. Programs can be statically or dynamically linked, but
8504 building of shared libraries are not supported with the medium model.
8506 @item -mcmodel=large
8507 @opindex mcmodel=large
8508 Generate code for the large model: This model makes no assumptions
8509 about addresses and sizes of sections. Currently GCC does not implement
8514 @subsection HPPA Options
8515 @cindex HPPA Options
8517 These @samp{-m} options are defined for the HPPA family of computers:
8520 @item -march=@var{architecture-type}
8522 Generate code for the specified architecture. The choices for
8523 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8524 1.1, and @samp{2.0} for PA 2.0 processors. Refer to
8525 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8526 architecture option for your machine. Code compiled for lower numbered
8527 architectures will run on higher numbered architectures, but not the
8530 PA 2.0 support currently requires gas snapshot 19990413 or later. The
8531 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8535 @itemx -mpa-risc-1-1
8536 @itemx -mpa-risc-2-0
8537 @opindex mpa-risc-1-0
8538 @opindex mpa-risc-1-1
8539 @opindex mpa-risc-2-0
8540 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8543 @opindex mbig-switch
8544 Generate code suitable for big switch tables. Use this option only if
8545 the assembler/linker complain about out of range branches within a switch
8548 @item -mjump-in-delay
8549 @opindex mjump-in-delay
8550 Fill delay slots of function calls with unconditional jump instructions
8551 by modifying the return pointer for the function call to be the target
8552 of the conditional jump.
8554 @item -mdisable-fpregs
8555 @opindex mdisable-fpregs
8556 Prevent floating point registers from being used in any manner. This is
8557 necessary for compiling kernels which perform lazy context switching of
8558 floating point registers. If you use this option and attempt to perform
8559 floating point operations, the compiler will abort.
8561 @item -mdisable-indexing
8562 @opindex mdisable-indexing
8563 Prevent the compiler from using indexing address modes. This avoids some
8564 rather obscure problems when compiling MIG generated code under MACH@.
8566 @item -mno-space-regs
8567 @opindex mno-space-regs
8568 Generate code that assumes the target has no space registers. This allows
8569 GCC to generate faster indirect calls and use unscaled index address modes.
8571 Such code is suitable for level 0 PA systems and kernels.
8573 @item -mfast-indirect-calls
8574 @opindex mfast-indirect-calls
8575 Generate code that assumes calls never cross space boundaries. This
8576 allows GCC to emit code which performs faster indirect calls.
8578 This option will not work in the presence of shared libraries or nested
8581 @item -mlong-load-store
8582 @opindex mlong-load-store
8583 Generate 3-instruction load and store sequences as sometimes required by
8584 the HP-UX 10 linker. This is equivalent to the @samp{+k} option to
8587 @item -mportable-runtime
8588 @opindex mportable-runtime
8589 Use the portable calling conventions proposed by HP for ELF systems.
8593 Enable the use of assembler directives only GAS understands.
8595 @item -mschedule=@var{cpu-type}
8597 Schedule code according to the constraints for the machine type
8598 @var{cpu-type}. The choices for @var{cpu-type} are @samp{700}
8599 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}. Refer
8600 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8601 proper scheduling option for your machine. The default scheduling is
8605 @opindex mlinker-opt
8606 Enable the optimization pass in the HP-UX linker. Note this makes symbolic
8607 debugging impossible. It also triggers a bug in the HP-UX 8 and HP-UX 9
8608 linkers in which they give bogus error messages when linking some programs.
8611 @opindex msoft-float
8612 Generate output containing library calls for floating point.
8613 @strong{Warning:} the requisite libraries are not available for all HPPA
8614 targets. Normally the facilities of the machine's usual C compiler are
8615 used, but this cannot be done directly in cross-compilation. You must make
8616 your own arrangements to provide suitable library functions for
8617 cross-compilation. The embedded target @samp{hppa1.1-*-pro}
8618 does provide software floating point support.
8620 @option{-msoft-float} changes the calling convention in the output file;
8621 therefore, it is only useful if you compile @emph{all} of a program with
8622 this option. In particular, you need to compile @file{libgcc.a}, the
8623 library that comes with GCC, with @option{-msoft-float} in order for
8628 Generate the predefine, @code{_SIO}, for server IO. The default is
8629 @option{-mwsio}. This generates the predefines, @code{__hp9000s700},
8630 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO. These
8631 options are available under HP-UX and HI-UX.
8635 Use GNU ld specific options. This passes @option{-shared} to ld when
8636 building a shared library. It is the default when GCC is configured,
8637 explicitly or implicitly, with the GNU linker. This option does not
8638 have any affect on which ld is called, it only changes what parameters
8639 are passed to that ld. The ld that is called is determined by the
8640 @option{--with-ld} configure option, gcc's program search path, and
8641 finally by the user's @env{PATH}. The linker used by GCC can be printed
8642 using @samp{which `gcc -print-prog-name=ld`}.
8646 Use HP ld specific options. This passes @option{-b} to ld when building
8647 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8648 links. It is the default when GCC is configured, explicitly or
8649 implicitly, with the HP linker. This option does not have any affect on
8650 which ld is called, it only changes what parameters are passed to that
8651 ld. The ld that is called is determined by the @option{--with-ld}
8652 configure option, gcc's program search path, and finally by the user's
8653 @env{PATH}. The linker used by GCC can be printed using @samp{which
8654 `gcc -print-prog-name=ld`}.
8657 @opindex mno-long-calls
8658 Generate code that uses long call sequences. This ensures that a call
8659 is always able to reach linker generated stubs. The default is to generate
8660 long calls only when the distance from the call site to the beginning
8661 of the function or translation unit, as the case may be, exceeds a
8662 predefined limit set by the branch type being used. The limits for
8663 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8664 PA 2.0 and PA 1.X architectures. Sibcalls are always limited at
8667 Distances are measured from the beginning of functions when using the
8668 @option{-ffunction-sections} option, or when using the @option{-mgas}
8669 and @option{-mno-portable-runtime} options together under HP-UX with
8672 It is normally not desirable to use this option as it will degrade
8673 performance. However, it may be useful in large applications,
8674 particularly when partial linking is used to build the application.
8676 The types of long calls used depends on the capabilities of the
8677 assembler and linker, and the type of code being generated. The
8678 impact on systems that support long absolute calls, and long pic
8679 symbol-difference or pc-relative calls should be relatively small.
8680 However, an indirect call is used on 32-bit ELF systems in pic code
8681 and it is quite long.
8685 Suppress the generation of link options to search libdld.sl when the
8686 @option{-static} option is specified on HP-UX 10 and later.
8690 The HP-UX implementation of setlocale in libc has a dependency on
8691 libdld.sl. There isn't an archive version of libdld.sl. Thus,
8692 when the @option{-static} option is specified, special link options
8693 are needed to resolve this dependency.
8695 On HP-UX 10 and later, the GCC driver adds the necessary options to
8696 link with libdld.sl when the @option{-static} option is specified.
8697 This causes the resulting binary to be dynamic. On the 64-bit port,
8698 the linkers generate dynamic binaries by default in any case. The
8699 @option{-nolibdld} option can be used to prevent the GCC driver from
8700 adding these link options.
8704 Add support for multithreading with the @dfn{dce thread} library
8705 under HP-UX. This option sets flags for both the preprocessor and
8709 @node DEC Alpha Options
8710 @subsection DEC Alpha Options
8712 These @samp{-m} options are defined for the DEC Alpha implementations:
8715 @item -mno-soft-float
8717 @opindex mno-soft-float
8718 @opindex msoft-float
8719 Use (do not use) the hardware floating-point instructions for
8720 floating-point operations. When @option{-msoft-float} is specified,
8721 functions in @file{libgcc.a} will be used to perform floating-point
8722 operations. Unless they are replaced by routines that emulate the
8723 floating-point operations, or compiled in such a way as to call such
8724 emulations routines, these routines will issue floating-point
8725 operations. If you are compiling for an Alpha without floating-point
8726 operations, you must ensure that the library is built so as not to call
8729 Note that Alpha implementations without floating-point operations are
8730 required to have floating-point registers.
8735 @opindex mno-fp-regs
8736 Generate code that uses (does not use) the floating-point register set.
8737 @option{-mno-fp-regs} implies @option{-msoft-float}. If the floating-point
8738 register set is not used, floating point operands are passed in integer
8739 registers as if they were integers and floating-point results are passed
8740 in @code{$0} instead of @code{$f0}. This is a non-standard calling sequence,
8741 so any function with a floating-point argument or return value called by code
8742 compiled with @option{-mno-fp-regs} must also be compiled with that
8745 A typical use of this option is building a kernel that does not use,
8746 and hence need not save and restore, any floating-point registers.
8750 The Alpha architecture implements floating-point hardware optimized for
8751 maximum performance. It is mostly compliant with the IEEE floating
8752 point standard. However, for full compliance, software assistance is
8753 required. This option generates code fully IEEE compliant code
8754 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8755 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8756 defined during compilation. The resulting code is less efficient but is
8757 able to correctly support denormalized numbers and exceptional IEEE
8758 values such as not-a-number and plus/minus infinity. Other Alpha
8759 compilers call this option @option{-ieee_with_no_inexact}.
8761 @item -mieee-with-inexact
8762 @opindex mieee-with-inexact
8763 This is like @option{-mieee} except the generated code also maintains
8764 the IEEE @var{inexact-flag}. Turning on this option causes the
8765 generated code to implement fully-compliant IEEE math. In addition to
8766 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8767 macro. On some Alpha implementations the resulting code may execute
8768 significantly slower than the code generated by default. Since there is
8769 very little code that depends on the @var{inexact-flag}, you should
8770 normally not specify this option. Other Alpha compilers call this
8771 option @option{-ieee_with_inexact}.
8773 @item -mfp-trap-mode=@var{trap-mode}
8774 @opindex mfp-trap-mode
8775 This option controls what floating-point related traps are enabled.
8776 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8777 The trap mode can be set to one of four values:
8781 This is the default (normal) setting. The only traps that are enabled
8782 are the ones that cannot be disabled in software (e.g., division by zero
8786 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8790 Like @samp{su}, but the instructions are marked to be safe for software
8791 completion (see Alpha architecture manual for details).
8794 Like @samp{su}, but inexact traps are enabled as well.
8797 @item -mfp-rounding-mode=@var{rounding-mode}
8798 @opindex mfp-rounding-mode
8799 Selects the IEEE rounding mode. Other Alpha compilers call this option
8800 @option{-fprm @var{rounding-mode}}. The @var{rounding-mode} can be one
8805 Normal IEEE rounding mode. Floating point numbers are rounded towards
8806 the nearest machine number or towards the even machine number in case
8810 Round towards minus infinity.
8813 Chopped rounding mode. Floating point numbers are rounded towards zero.
8816 Dynamic rounding mode. A field in the floating point control register
8817 (@var{fpcr}, see Alpha architecture reference manual) controls the
8818 rounding mode in effect. The C library initializes this register for
8819 rounding towards plus infinity. Thus, unless your program modifies the
8820 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8823 @item -mtrap-precision=@var{trap-precision}
8824 @opindex mtrap-precision
8825 In the Alpha architecture, floating point traps are imprecise. This
8826 means without software assistance it is impossible to recover from a
8827 floating trap and program execution normally needs to be terminated.
8828 GCC can generate code that can assist operating system trap handlers
8829 in determining the exact location that caused a floating point trap.
8830 Depending on the requirements of an application, different levels of
8831 precisions can be selected:
8835 Program precision. This option is the default and means a trap handler
8836 can only identify which program caused a floating point exception.
8839 Function precision. The trap handler can determine the function that
8840 caused a floating point exception.
8843 Instruction precision. The trap handler can determine the exact
8844 instruction that caused a floating point exception.
8847 Other Alpha compilers provide the equivalent options called
8848 @option{-scope_safe} and @option{-resumption_safe}.
8850 @item -mieee-conformant
8851 @opindex mieee-conformant
8852 This option marks the generated code as IEEE conformant. You must not
8853 use this option unless you also specify @option{-mtrap-precision=i} and either
8854 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}. Its only effect
8855 is to emit the line @samp{.eflag 48} in the function prologue of the
8856 generated assembly file. Under DEC Unix, this has the effect that
8857 IEEE-conformant math library routines will be linked in.
8859 @item -mbuild-constants
8860 @opindex mbuild-constants
8861 Normally GCC examines a 32- or 64-bit integer constant to
8862 see if it can construct it from smaller constants in two or three
8863 instructions. If it cannot, it will output the constant as a literal and
8864 generate code to load it from the data segment at runtime.
8866 Use this option to require GCC to construct @emph{all} integer constants
8867 using code, even if it takes more instructions (the maximum is six).
8869 You would typically use this option to build a shared library dynamic
8870 loader. Itself a shared library, it must relocate itself in memory
8871 before it can find the variables and constants in its own data segment.
8877 Select whether to generate code to be assembled by the vendor-supplied
8878 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8896 Indicate whether GCC should generate code to use the optional BWX,
8897 CIX, FIX and MAX instruction sets. The default is to use the instruction
8898 sets supported by the CPU type specified via @option{-mcpu=} option or that
8899 of the CPU on which GCC was built if none was specified.
8904 @opindex mfloat-ieee
8905 Generate code that uses (does not use) VAX F and G floating point
8906 arithmetic instead of IEEE single and double precision.
8908 @item -mexplicit-relocs
8909 @itemx -mno-explicit-relocs
8910 @opindex mexplicit-relocs
8911 @opindex mno-explicit-relocs
8912 Older Alpha assemblers provided no way to generate symbol relocations
8913 except via assembler macros. Use of these macros does not allow
8914 optimal instruction scheduling. GNU binutils as of version 2.12
8915 supports a new syntax that allows the compiler to explicitly mark
8916 which relocations should apply to which instructions. This option
8917 is mostly useful for debugging, as GCC detects the capabilities of
8918 the assembler when it is built and sets the default accordingly.
8922 @opindex msmall-data
8923 @opindex mlarge-data
8924 When @option{-mexplicit-relocs} is in effect, static data is
8925 accessed via @dfn{gp-relative} relocations. When @option{-msmall-data}
8926 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8927 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8928 16-bit relocations off of the @code{$gp} register. This limits the
8929 size of the small data area to 64KB, but allows the variables to be
8930 directly accessed via a single instruction.
8932 The default is @option{-mlarge-data}. With this option the data area
8933 is limited to just below 2GB. Programs that require more than 2GB of
8934 data must use @code{malloc} or @code{mmap} to allocate the data in the
8935 heap instead of in the program's data segment.
8937 When generating code for shared libraries, @option{-fpic} implies
8938 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8942 @opindex msmall-text
8943 @opindex mlarge-text
8944 When @option{-msmall-text} is used, the compiler assumes that the
8945 code of the entire program (or shared library) fits in 4MB, and is
8946 thus reachable with a branch instruction. When @option{-msmall-data}
8947 is used, the compiler can assume that all local symbols share the
8948 same @code{$gp} value, and thus reduce the number of instructions
8949 required for a function call from 4 to 1.
8951 The default is @option{-mlarge-text}.
8953 @item -mcpu=@var{cpu_type}
8955 Set the instruction set and instruction scheduling parameters for
8956 machine type @var{cpu_type}. You can specify either the @samp{EV}
8957 style name or the corresponding chip number. GCC supports scheduling
8958 parameters for the EV4, EV5 and EV6 family of processors and will
8959 choose the default values for the instruction set from the processor
8960 you specify. If you do not specify a processor type, GCC will default
8961 to the processor on which the compiler was built.
8963 Supported values for @var{cpu_type} are
8969 Schedules as an EV4 and has no instruction set extensions.
8973 Schedules as an EV5 and has no instruction set extensions.
8977 Schedules as an EV5 and supports the BWX extension.
8982 Schedules as an EV5 and supports the BWX and MAX extensions.
8986 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8990 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8993 @item -mtune=@var{cpu_type}
8995 Set only the instruction scheduling parameters for machine type
8996 @var{cpu_type}. The instruction set is not changed.
8998 @item -mmemory-latency=@var{time}
8999 @opindex mmemory-latency
9000 Sets the latency the scheduler should assume for typical memory
9001 references as seen by the application. This number is highly
9002 dependent on the memory access patterns used by the application
9003 and the size of the external cache on the machine.
9005 Valid options for @var{time} are
9009 A decimal number representing clock cycles.
9015 The compiler contains estimates of the number of clock cycles for
9016 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9017 (also called Dcache, Scache, and Bcache), as well as to main memory.
9018 Note that L3 is only valid for EV5.
9023 @node DEC Alpha/VMS Options
9024 @subsection DEC Alpha/VMS Options
9026 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9029 @item -mvms-return-codes
9030 @opindex mvms-return-codes
9031 Return VMS condition codes from main. The default is to return POSIX
9032 style condition (e.g.@ error) codes.
9035 @node H8/300 Options
9036 @subsection H8/300 Options
9038 These @samp{-m} options are defined for the H8/300 implementations:
9043 Shorten some address references at link time, when possible; uses the
9044 linker option @option{-relax}. @xref{H8/300,, @code{ld} and the H8/300,
9045 ld, Using ld}, for a fuller description.
9049 Generate code for the H8/300H@.
9053 Generate code for the H8S@.
9057 Generate code for the H8S and H8/300H in the normal mode. This switch
9058 must be used either with -mh or -ms.
9062 Generate code for the H8S/2600. This switch must be used with @option{-ms}.
9066 Make @code{int} data 32 bits by default.
9070 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9071 The default for the H8/300H and H8S is to align longs and floats on 4
9073 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9074 This option has no effect on the H8/300.
9078 @subsection SH Options
9080 These @samp{-m} options are defined for the SH implementations:
9085 Generate code for the SH1.
9089 Generate code for the SH2.
9092 Generate code for the SH2e.
9096 Generate code for the SH3.
9100 Generate code for the SH3e.
9104 Generate code for the SH4 without a floating-point unit.
9106 @item -m4-single-only
9107 @opindex m4-single-only
9108 Generate code for the SH4 with a floating-point unit that only
9109 supports single-precision arithmetic.
9113 Generate code for the SH4 assuming the floating-point unit is in
9114 single-precision mode by default.
9118 Generate code for the SH4.
9122 Compile code for the processor in big endian mode.
9126 Compile code for the processor in little endian mode.
9130 Align doubles at 64-bit boundaries. Note that this changes the calling
9131 conventions, and thus some functions from the standard C library will
9132 not work unless you recompile it first with @option{-mdalign}.
9136 Shorten some address references at link time, when possible; uses the
9137 linker option @option{-relax}.
9141 Use 32-bit offsets in @code{switch} tables. The default is to use
9146 Enable the use of the instruction @code{fmovd}.
9150 Comply with the calling conventions defined by Renesas.
9154 Mark the @code{MAC} register as call-clobbered, even if
9155 @option{-mhitachi} is given.
9159 Increase IEEE-compliance of floating-point code.
9163 Dump instruction size and location in the assembly code.
9167 This option is deprecated. It pads structures to multiple of 4 bytes,
9168 which is incompatible with the SH ABI@.
9172 Optimize for space instead of speed. Implied by @option{-Os}.
9176 When generating position-independent code, emit function calls using
9177 the Global Offset Table instead of the Procedure Linkage Table.
9181 Generate a library function call to invalidate instruction cache
9182 entries, after fixing up a trampoline. This library function call
9183 doesn't assume it can write to the whole memory address space. This
9184 is the default when the target is @code{sh-*-linux*}.
9187 @node System V Options
9188 @subsection Options for System V
9190 These additional options are available on System V Release 4 for
9191 compatibility with other compilers on those systems:
9196 Create a shared object.
9197 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9201 Identify the versions of each tool used by the compiler, in a
9202 @code{.ident} assembler directive in the output.
9206 Refrain from adding @code{.ident} directives to the output file (this is
9209 @item -YP,@var{dirs}
9211 Search the directories @var{dirs}, and no others, for libraries
9212 specified with @option{-l}.
9216 Look in the directory @var{dir} to find the M4 preprocessor.
9217 The assembler uses this option.
9218 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9219 @c the generic assembler that comes with Solaris takes just -Ym.
9222 @node TMS320C3x/C4x Options
9223 @subsection TMS320C3x/C4x Options
9224 @cindex TMS320C3x/C4x Options
9226 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9230 @item -mcpu=@var{cpu_type}
9232 Set the instruction set, register set, and instruction scheduling
9233 parameters for machine type @var{cpu_type}. Supported values for
9234 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9235 @samp{c44}. The default is @samp{c40} to generate code for the
9240 @itemx -msmall-memory
9242 @opindex mbig-memory
9244 @opindex msmall-memory
9246 Generates code for the big or small memory model. The small memory
9247 model assumed that all data fits into one 64K word page. At run-time
9248 the data page (DP) register must be set to point to the 64K page
9249 containing the .bss and .data program sections. The big memory model is
9250 the default and requires reloading of the DP register for every direct
9257 Allow (disallow) allocation of general integer operands into the block
9264 Enable (disable) generation of code using decrement and branch,
9265 DBcond(D), instructions. This is enabled by default for the C4x. To be
9266 on the safe side, this is disabled for the C3x, since the maximum
9267 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9268 @math{2^{23}} times on the C3x?). Note that GCC will try to reverse a loop so
9269 that it can utilize the decrement and branch instruction, but will give
9270 up if there is more than one memory reference in the loop. Thus a loop
9271 where the loop counter is decremented can generate slightly more
9272 efficient code, in cases where the RPTB instruction cannot be utilized.
9274 @item -mdp-isr-reload
9276 @opindex mdp-isr-reload
9278 Force the DP register to be saved on entry to an interrupt service
9279 routine (ISR), reloaded to point to the data section, and restored on
9280 exit from the ISR@. This should not be required unless someone has
9281 violated the small memory model by modifying the DP register, say within
9288 For the C3x use the 24-bit MPYI instruction for integer multiplies
9289 instead of a library call to guarantee 32-bit results. Note that if one
9290 of the operands is a constant, then the multiplication will be performed
9291 using shifts and adds. If the @option{-mmpyi} option is not specified for the C3x,
9292 then squaring operations are performed inline instead of a library call.
9295 @itemx -mno-fast-fix
9297 @opindex mno-fast-fix
9298 The C3x/C4x FIX instruction to convert a floating point value to an
9299 integer value chooses the nearest integer less than or equal to the
9300 floating point value rather than to the nearest integer. Thus if the
9301 floating point number is negative, the result will be incorrectly
9302 truncated an additional code is necessary to detect and correct this
9303 case. This option can be used to disable generation of the additional
9304 code required to correct the result.
9310 Enable (disable) generation of repeat block sequences using the RPTB
9311 instruction for zero overhead looping. The RPTB construct is only used
9312 for innermost loops that do not call functions or jump across the loop
9313 boundaries. There is no advantage having nested RPTB loops due to the
9314 overhead required to save and restore the RC, RS, and RE registers.
9315 This is enabled by default with @option{-O2}.
9317 @item -mrpts=@var{count}
9321 Enable (disable) the use of the single instruction repeat instruction
9322 RPTS@. If a repeat block contains a single instruction, and the loop
9323 count can be guaranteed to be less than the value @var{count}, GCC will
9324 emit a RPTS instruction instead of a RPTB@. If no value is specified,
9325 then a RPTS will be emitted even if the loop count cannot be determined
9326 at compile time. Note that the repeated instruction following RPTS does
9327 not have to be reloaded from memory each iteration, thus freeing up the
9328 CPU buses for operands. However, since interrupts are blocked by this
9329 instruction, it is disabled by default.
9331 @item -mloop-unsigned
9332 @itemx -mno-loop-unsigned
9333 @opindex mloop-unsigned
9334 @opindex mno-loop-unsigned
9335 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9336 is @math{2^{31} + 1} since these instructions test if the iteration count is
9337 negative to terminate the loop. If the iteration count is unsigned
9338 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9339 exceeded. This switch allows an unsigned iteration count.
9343 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9344 with. This also enforces compatibility with the API employed by the TI
9345 C3x C compiler. For example, long doubles are passed as structures
9346 rather than in floating point registers.
9352 Generate code that uses registers (stack) for passing arguments to functions.
9353 By default, arguments are passed in registers where possible rather
9354 than by pushing arguments on to the stack.
9356 @item -mparallel-insns
9357 @itemx -mno-parallel-insns
9358 @opindex mparallel-insns
9359 @opindex mno-parallel-insns
9360 Allow the generation of parallel instructions. This is enabled by
9361 default with @option{-O2}.
9363 @item -mparallel-mpy
9364 @itemx -mno-parallel-mpy
9365 @opindex mparallel-mpy
9366 @opindex mno-parallel-mpy
9367 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9368 provided @option{-mparallel-insns} is also specified. These instructions have
9369 tight register constraints which can pessimize the code generation
9375 @subsection V850 Options
9376 @cindex V850 Options
9378 These @samp{-m} options are defined for V850 implementations:
9382 @itemx -mno-long-calls
9383 @opindex mlong-calls
9384 @opindex mno-long-calls
9385 Treat all calls as being far away (near). If calls are assumed to be
9386 far away, the compiler will always load the functions address up into a
9387 register, and call indirect through the pointer.
9393 Do not optimize (do optimize) basic blocks that use the same index
9394 pointer 4 or more times to copy pointer into the @code{ep} register, and
9395 use the shorter @code{sld} and @code{sst} instructions. The @option{-mep}
9396 option is on by default if you optimize.
9398 @item -mno-prolog-function
9399 @itemx -mprolog-function
9400 @opindex mno-prolog-function
9401 @opindex mprolog-function
9402 Do not use (do use) external functions to save and restore registers
9403 at the prologue and epilogue of a function. The external functions
9404 are slower, but use less code space if more than one function saves
9405 the same number of registers. The @option{-mprolog-function} option
9406 is on by default if you optimize.
9410 Try to make the code as small as possible. At present, this just turns
9411 on the @option{-mep} and @option{-mprolog-function} options.
9415 Put static or global variables whose size is @var{n} bytes or less into
9416 the tiny data area that register @code{ep} points to. The tiny data
9417 area can hold up to 256 bytes in total (128 bytes for byte references).
9421 Put static or global variables whose size is @var{n} bytes or less into
9422 the small data area that register @code{gp} points to. The small data
9423 area can hold up to 64 kilobytes.
9427 Put static or global variables whose size is @var{n} bytes or less into
9428 the first 32 kilobytes of memory.
9432 Specify that the target processor is the V850.
9435 @opindex mbig-switch
9436 Generate code suitable for big switch tables. Use this option only if
9437 the assembler/linker complain about out of range branches within a switch
9442 This option will cause r2 and r5 to be used in the code generated by
9443 the compiler. This setting is the default.
9446 @opindex mno-app-regs
9447 This option will cause r2 and r5 to be treated as fixed registers.
9451 Specify that the target processor is the V850E1. The preprocessor
9452 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
9453 this option is used.
9457 Specify that the target processor is the V850E. The preprocessor
9458 constant @samp{__v850e__} will be defined if this option is used.
9460 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
9461 are defined then a default target processor will be chosen and the
9462 relevant @samp{__v850*__} preprocessor constant will be defined.
9464 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9465 defined, regardless of which processor variant is the target.
9467 @item -mdisable-callt
9468 @opindex mdisable-callt
9469 This option will suppress generation of the CALLT instruction for the
9470 v850e and v850e1 flavors of the v850 architecture. The default is
9471 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9476 @subsection ARC Options
9479 These options are defined for ARC implementations:
9484 Compile code for little endian mode. This is the default.
9488 Compile code for big endian mode.
9491 @opindex mmangle-cpu
9492 Prepend the name of the cpu to all public symbol names.
9493 In multiple-processor systems, there are many ARC variants with different
9494 instruction and register set characteristics. This flag prevents code
9495 compiled for one cpu to be linked with code compiled for another.
9496 No facility exists for handling variants that are ``almost identical''.
9497 This is an all or nothing option.
9499 @item -mcpu=@var{cpu}
9501 Compile code for ARC variant @var{cpu}.
9502 Which variants are supported depend on the configuration.
9503 All variants support @option{-mcpu=base}, this is the default.
9505 @item -mtext=@var{text-section}
9506 @itemx -mdata=@var{data-section}
9507 @itemx -mrodata=@var{readonly-data-section}
9511 Put functions, data, and readonly data in @var{text-section},
9512 @var{data-section}, and @var{readonly-data-section} respectively
9513 by default. This can be overridden with the @code{section} attribute.
9514 @xref{Variable Attributes}.
9519 @subsection NS32K Options
9520 @cindex NS32K options
9522 These are the @samp{-m} options defined for the 32000 series. The default
9523 values for these options depends on which style of 32000 was selected when
9524 the compiler was configured; the defaults for the most common choices are
9532 Generate output for a 32032. This is the default
9533 when the compiler is configured for 32032 and 32016 based systems.
9539 Generate output for a 32332. This is the default
9540 when the compiler is configured for 32332-based systems.
9546 Generate output for a 32532. This is the default
9547 when the compiler is configured for 32532-based systems.
9551 Generate output containing 32081 instructions for floating point.
9552 This is the default for all systems.
9556 Generate output containing 32381 instructions for floating point. This
9557 also implies @option{-m32081}. The 32381 is only compatible with the 32332
9558 and 32532 cpus. This is the default for the pc532-netbsd configuration.
9562 Try and generate multiply-add floating point instructions @code{polyF}
9563 and @code{dotF}. This option is only available if the @option{-m32381}
9564 option is in effect. Using these instructions requires changes to
9565 register allocation which generally has a negative impact on
9566 performance. This option should only be enabled when compiling code
9567 particularly likely to make heavy use of multiply-add instructions.
9570 @opindex mnomulti-add
9571 Do not try and generate multiply-add floating point instructions
9572 @code{polyF} and @code{dotF}. This is the default on all platforms.
9575 @opindex msoft-float
9576 Generate output containing library calls for floating point.
9577 @strong{Warning:} the requisite libraries may not be available.
9579 @item -mieee-compare
9580 @itemx -mno-ieee-compare
9581 @opindex mieee-compare
9582 @opindex mno-ieee-compare
9583 Control whether or not the compiler uses IEEE floating point
9584 comparisons. These handle correctly the case where the result of a
9585 comparison is unordered.
9586 @strong{Warning:} the requisite kernel support may not be available.
9589 @opindex mnobitfield
9590 Do not use the bit-field instructions. On some machines it is faster to
9591 use shifting and masking operations. This is the default for the pc532.
9595 Do use the bit-field instructions. This is the default for all platforms
9600 Use a different function-calling convention, in which functions
9601 that take a fixed number of arguments return pop their
9602 arguments on return with the @code{ret} instruction.
9604 This calling convention is incompatible with the one normally
9605 used on Unix, so you cannot use it if you need to call libraries
9606 compiled with the Unix compiler.
9608 Also, you must provide function prototypes for all functions that
9609 take variable numbers of arguments (including @code{printf});
9610 otherwise incorrect code will be generated for calls to those
9613 In addition, seriously incorrect code will result if you call a
9614 function with too many arguments. (Normally, extra arguments are
9615 harmlessly ignored.)
9617 This option takes its name from the 680x0 @code{rtd} instruction.
9622 Use a different function-calling convention where the first two arguments
9623 are passed in registers.
9625 This calling convention is incompatible with the one normally
9626 used on Unix, so you cannot use it if you need to call libraries
9627 compiled with the Unix compiler.
9630 @opindex mnoregparam
9631 Do not pass any arguments in registers. This is the default for all
9636 It is OK to use the sb as an index register which is always loaded with
9637 zero. This is the default for the pc532-netbsd target.
9641 The sb register is not available for use or has not been initialized to
9642 zero by the run time system. This is the default for all targets except
9643 the pc532-netbsd. It is also implied whenever @option{-mhimem} or
9644 @option{-fpic} is set.
9648 Many ns32000 series addressing modes use displacements of up to 512MB@.
9649 If an address is above 512MB then displacements from zero can not be used.
9650 This option causes code to be generated which can be loaded above 512MB@.
9651 This may be useful for operating systems or ROM code.
9655 Assume code will be loaded in the first 512MB of virtual address space.
9656 This is the default for all platforms.
9662 @subsection AVR Options
9665 These options are defined for AVR implementations:
9668 @item -mmcu=@var{mcu}
9670 Specify ATMEL AVR instruction set or MCU type.
9672 Instruction set avr1 is for the minimal AVR core, not supported by the C
9673 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9674 attiny11, attiny12, attiny15, attiny28).
9676 Instruction set avr2 (default) is for the classic AVR core with up to
9677 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9678 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9679 at90c8534, at90s8535).
9681 Instruction set avr3 is for the classic AVR core with up to 128K program
9682 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9684 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9685 memory space (MCU types: atmega8, atmega83, atmega85).
9687 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9688 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9689 atmega64, atmega128, at43usb355, at94k).
9693 Output instruction sizes to the asm file.
9695 @item -minit-stack=@var{N}
9696 @opindex minit-stack
9697 Specify the initial stack address, which may be a symbol or numeric value,
9698 @samp{__stack} is the default.
9700 @item -mno-interrupts
9701 @opindex mno-interrupts
9702 Generated code is not compatible with hardware interrupts.
9703 Code size will be smaller.
9705 @item -mcall-prologues
9706 @opindex mcall-prologues
9707 Functions prologues/epilogues expanded as call to appropriate
9708 subroutines. Code size will be smaller.
9710 @item -mno-tablejump
9711 @opindex mno-tablejump
9712 Do not generate tablejump insns which sometimes increase code size.
9715 @opindex mtiny-stack
9716 Change only the low 8 bits of the stack pointer.
9720 @subsection MCore Options
9721 @cindex MCore options
9723 These are the @samp{-m} options defined for the Motorola M*Core
9731 @opindex mno-hardlit
9732 Inline constants into the code stream if it can be done in two
9733 instructions or less.
9739 Use the divide instruction. (Enabled by default).
9741 @item -mrelax-immediate
9742 @itemx -mno-relax-immediate
9743 @opindex mrelax-immediate
9744 @opindex mno-relax-immediate
9745 Allow arbitrary sized immediates in bit operations.
9747 @item -mwide-bitfields
9748 @itemx -mno-wide-bitfields
9749 @opindex mwide-bitfields
9750 @opindex mno-wide-bitfields
9751 Always treat bit-fields as int-sized.
9753 @item -m4byte-functions
9754 @itemx -mno-4byte-functions
9755 @opindex m4byte-functions
9756 @opindex mno-4byte-functions
9757 Force all functions to be aligned to a four byte boundary.
9759 @item -mcallgraph-data
9760 @itemx -mno-callgraph-data
9761 @opindex mcallgraph-data
9762 @opindex mno-callgraph-data
9763 Emit callgraph information.
9766 @itemx -mno-slow-bytes
9767 @opindex mslow-bytes
9768 @opindex mno-slow-bytes
9769 Prefer word access when reading byte quantities.
9771 @item -mlittle-endian
9773 @opindex mlittle-endian
9774 @opindex mbig-endian
9775 Generate code for a little endian target.
9781 Generate code for the 210 processor.
9785 @subsection IA-64 Options
9786 @cindex IA-64 Options
9788 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9792 @opindex mbig-endian
9793 Generate code for a big endian target. This is the default for HP-UX@.
9795 @item -mlittle-endian
9796 @opindex mlittle-endian
9797 Generate code for a little endian target. This is the default for AIX5
9804 Generate (or don't) code for the GNU assembler. This is the default.
9805 @c Also, this is the default if the configure option @option{--with-gnu-as}
9812 Generate (or don't) code for the GNU linker. This is the default.
9813 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9818 Generate code that does not use a global pointer register. The result
9819 is not position independent code, and violates the IA-64 ABI@.
9821 @item -mvolatile-asm-stop
9822 @itemx -mno-volatile-asm-stop
9823 @opindex mvolatile-asm-stop
9824 @opindex mno-volatile-asm-stop
9825 Generate (or don't) a stop bit immediately before and after volatile asm
9830 Generate code that works around Itanium B step errata.
9832 @item -mregister-names
9833 @itemx -mno-register-names
9834 @opindex mregister-names
9835 @opindex mno-register-names
9836 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9837 the stacked registers. This may make assembler output more readable.
9843 Disable (or enable) optimizations that use the small data section. This may
9844 be useful for working around optimizer bugs.
9847 @opindex mconstant-gp
9848 Generate code that uses a single constant global pointer value. This is
9849 useful when compiling kernel code.
9853 Generate code that is self-relocatable. This implies @option{-mconstant-gp}.
9854 This is useful when compiling firmware code.
9856 @item -minline-float-divide-min-latency
9857 @opindex minline-float-divide-min-latency
9858 Generate code for inline divides of floating point values
9859 using the minimum latency algorithm.
9861 @item -minline-float-divide-max-throughput
9862 @opindex minline-float-divide-max-throughput
9863 Generate code for inline divides of floating point values
9864 using the maximum throughput algorithm.
9866 @item -minline-int-divide-min-latency
9867 @opindex minline-int-divide-min-latency
9868 Generate code for inline divides of integer values
9869 using the minimum latency algorithm.
9871 @item -minline-int-divide-max-throughput
9872 @opindex minline-int-divide-max-throughput
9873 Generate code for inline divides of integer values
9874 using the maximum throughput algorithm.
9876 @item -mno-dwarf2-asm
9878 @opindex mno-dwarf2-asm
9879 @opindex mdwarf2-asm
9880 Don't (or do) generate assembler code for the DWARF2 line number debugging
9881 info. This may be useful when not using the GNU assembler.
9883 @item -mfixed-range=@var{register-range}
9884 @opindex mfixed-range
9885 Generate code treating the given register range as fixed registers.
9886 A fixed register is one that the register allocator can not use. This is
9887 useful when compiling kernel code. A register range is specified as
9888 two registers separated by a dash. Multiple register ranges can be
9889 specified separated by a comma.
9891 @item -mearly-stop-bits
9892 @itemx -mno-early-stop-bits
9893 @opindex mearly-stop-bits
9894 @opindex mno-early-stop-bits
9895 Allow stop bits to be placed earlier than immediately preceding the
9896 instruction that triggered the stop bit. This can improve instruction
9897 scheduling, but does not always do so.
9900 @node S/390 and zSeries Options
9901 @subsection S/390 and zSeries Options
9902 @cindex S/390 and zSeries Options
9904 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
9909 @opindex mhard-float
9910 @opindex msoft-float
9911 Use (do not use) the hardware floating-point instructions and registers
9912 for floating-point operations. When @option{-msoft-float} is specified,
9913 functions in @file{libgcc.a} will be used to perform floating-point
9914 operations. When @option{-mhard-float} is specified, the compiler
9915 generates IEEE floating-point instructions. This is the default.
9918 @itemx -mno-backchain
9920 @opindex mno-backchain
9921 Generate (or do not generate) code which maintains an explicit
9922 backchain within the stack frame that points to the caller's frame.
9923 This may be needed to allow debugging using tools that do not understand
9924 DWARF-2 call frame information. The default is not to generate the
9928 @itemx -mno-small-exec
9929 @opindex msmall-exec
9930 @opindex mno-small-exec
9931 Generate (or do not generate) code using the @code{bras} instruction
9932 to do subroutine calls.
9933 This only works reliably if the total executable size does not
9934 exceed 64k. The default is to use the @code{basr} instruction instead,
9935 which does not have this limitation.
9941 When @option{-m31} is specified, generate code compliant to the
9942 GNU/Linux for S/390 ABI@. When @option{-m64} is specified, generate
9943 code compliant to the GNU/Linux for zSeries ABI@. This allows GCC in
9944 particular to generate 64-bit instructions. For the @samp{s390}
9945 targets, the default is @option{-m31}, while the @samp{s390x}
9946 targets default to @option{-m64}.
9952 When @option{-mzarch} is specified, generate code using the
9953 instructions available on z/Architecture.
9954 When @option{-mesa} is specified, generate code using the
9955 instructions available on ESA/390. Note that @option{-mesa} is
9956 not possible with @option{-m64}.
9957 When generating code compliant to the GNU/Linux for S/390 ABI,
9958 the default is @option{-mesa}. When generating code compliant
9959 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
9965 Generate (or do not generate) code using the @code{mvcle} instruction
9966 to perform block moves. When @option{-mno-mvcle} is specified,
9967 use a @code{mvc} loop instead. This is the default.
9973 Print (or do not print) additional debug information when compiling.
9974 The default is to not print debug information.
9976 @item -march=@var{cpu-type}
9978 Generate code that will run on @var{cpu-type}, which is the name of a system
9979 representing a certain processor type. Possible values for
9980 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
9981 When generating code using the instructions available on z/Architecture,
9982 the default is @option{-march=z900}. Otherwise, the default is
9985 @item -mtune=@var{cpu-type}
9987 Tune to @var{cpu-type} everything applicable about the generated code,
9988 except for the ABI and the set of available instructions.
9989 The list of @var{cpu-type} values is the same as for @option{-march}.
9990 The default is the value used for @option{-march}.
9993 @itemx -mno-fused-madd
9994 @opindex mfused-madd
9995 @opindex mno-fused-madd
9996 Generate code that uses (does not use) the floating point multiply and
9997 accumulate instructions. These instructions are generated by default if
9998 hardware floating point is used.
10002 @subsection CRIS Options
10003 @cindex CRIS Options
10005 These options are defined specifically for the CRIS ports.
10008 @item -march=@var{architecture-type}
10009 @itemx -mcpu=@var{architecture-type}
10012 Generate code for the specified architecture. The choices for
10013 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10014 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
10015 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10018 @item -mtune=@var{architecture-type}
10020 Tune to @var{architecture-type} everything applicable about the generated
10021 code, except for the ABI and the set of available instructions. The
10022 choices for @var{architecture-type} are the same as for
10023 @option{-march=@var{architecture-type}}.
10025 @item -mmax-stack-frame=@var{n}
10026 @opindex mmax-stack-frame
10027 Warn when the stack frame of a function exceeds @var{n} bytes.
10029 @item -melinux-stacksize=@var{n}
10030 @opindex melinux-stacksize
10031 Only available with the @samp{cris-axis-aout} target. Arranges for
10032 indications in the program to the kernel loader that the stack of the
10033 program should be set to @var{n} bytes.
10039 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10040 @option{-march=v3} and @option{-march=v8} respectively.
10044 Enable CRIS-specific verbose debug-related information in the assembly
10045 code. This option also has the effect to turn off the @samp{#NO_APP}
10046 formatted-code indicator to the assembler at the beginning of the
10051 Do not use condition-code results from previous instruction; always emit
10052 compare and test instructions before use of condition codes.
10054 @item -mno-side-effects
10055 @opindex mno-side-effects
10056 Do not emit instructions with side-effects in addressing modes other than
10059 @item -mstack-align
10060 @itemx -mno-stack-align
10061 @itemx -mdata-align
10062 @itemx -mno-data-align
10063 @itemx -mconst-align
10064 @itemx -mno-const-align
10065 @opindex mstack-align
10066 @opindex mno-stack-align
10067 @opindex mdata-align
10068 @opindex mno-data-align
10069 @opindex mconst-align
10070 @opindex mno-const-align
10071 These options (no-options) arranges (eliminate arrangements) for the
10072 stack-frame, individual data and constants to be aligned for the maximum
10073 single data access size for the chosen CPU model. The default is to
10074 arrange for 32-bit alignment. ABI details such as structure layout are
10075 not affected by these options.
10083 Similar to the stack- data- and const-align options above, these options
10084 arrange for stack-frame, writable data and constants to all be 32-bit,
10085 16-bit or 8-bit aligned. The default is 32-bit alignment.
10087 @item -mno-prologue-epilogue
10088 @itemx -mprologue-epilogue
10089 @opindex mno-prologue-epilogue
10090 @opindex mprologue-epilogue
10091 With @option{-mno-prologue-epilogue}, the normal function prologue and
10092 epilogue that sets up the stack-frame are omitted and no return
10093 instructions or return sequences are generated in the code. Use this
10094 option only together with visual inspection of the compiled code: no
10095 warnings or errors are generated when call-saved registers must be saved,
10096 or storage for local variable needs to be allocated.
10100 @opindex mno-gotplt
10102 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10103 instruction sequences that load addresses for functions from the PLT part
10104 of the GOT rather than (traditional on other architectures) calls to the
10105 PLT. The default is @option{-mgotplt}.
10109 Legacy no-op option only recognized with the cris-axis-aout target.
10113 Legacy no-op option only recognized with the cris-axis-elf and
10114 cris-axis-linux-gnu targets.
10118 Only recognized with the cris-axis-aout target, where it selects a
10119 GNU/linux-like multilib, include files and instruction set for
10120 @option{-march=v8}.
10124 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10128 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
10129 to link with input-output functions from a simulator library. Code,
10130 initialized data and zero-initialized data are allocated consecutively.
10134 Like @option{-sim}, but pass linker options to locate initialized data at
10135 0x40000000 and zero-initialized data at 0x80000000.
10139 @subsection MMIX Options
10140 @cindex MMIX Options
10142 These options are defined for the MMIX:
10146 @itemx -mno-libfuncs
10148 @opindex mno-libfuncs
10149 Specify that intrinsic library functions are being compiled, passing all
10150 values in registers, no matter the size.
10153 @itemx -mno-epsilon
10155 @opindex mno-epsilon
10156 Generate floating-point comparison instructions that compare with respect
10157 to the @code{rE} epsilon register.
10159 @item -mabi=mmixware
10161 @opindex mabi-mmixware
10163 Generate code that passes function parameters and return values that (in
10164 the called function) are seen as registers @code{$0} and up, as opposed to
10165 the GNU ABI which uses global registers @code{$231} and up.
10167 @item -mzero-extend
10168 @itemx -mno-zero-extend
10169 @opindex mzero-extend
10170 @opindex mno-zero-extend
10171 When reading data from memory in sizes shorter than 64 bits, use (do not
10172 use) zero-extending load instructions by default, rather than
10173 sign-extending ones.
10176 @itemx -mno-knuthdiv
10178 @opindex mno-knuthdiv
10179 Make the result of a division yielding a remainder have the same sign as
10180 the divisor. With the default, @option{-mno-knuthdiv}, the sign of the
10181 remainder follows the sign of the dividend. Both methods are
10182 arithmetically valid, the latter being almost exclusively used.
10184 @item -mtoplevel-symbols
10185 @itemx -mno-toplevel-symbols
10186 @opindex mtoplevel-symbols
10187 @opindex mno-toplevel-symbols
10188 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10189 code can be used with the @code{PREFIX} assembly directive.
10193 Generate an executable in the ELF format, rather than the default
10194 @samp{mmo} format used by the @command{mmix} simulator.
10196 @item -mbranch-predict
10197 @itemx -mno-branch-predict
10198 @opindex mbranch-predict
10199 @opindex mno-branch-predict
10200 Use (do not use) the probable-branch instructions, when static branch
10201 prediction indicates a probable branch.
10203 @item -mbase-addresses
10204 @itemx -mno-base-addresses
10205 @opindex mbase-addresses
10206 @opindex mno-base-addresses
10207 Generate (do not generate) code that uses @emph{base addresses}. Using a
10208 base address automatically generates a request (handled by the assembler
10209 and the linker) for a constant to be set up in a global register. The
10210 register is used for one or more base address requests within the range 0
10211 to 255 from the value held in the register. The generally leads to short
10212 and fast code, but the number of different data items that can be
10213 addressed is limited. This means that a program that uses lots of static
10214 data may require @option{-mno-base-addresses}.
10216 @item -msingle-exit
10217 @itemx -mno-single-exit
10218 @opindex msingle-exit
10219 @opindex mno-single-exit
10220 Force (do not force) generated code to have a single exit point in each
10224 @node PDP-11 Options
10225 @subsection PDP-11 Options
10226 @cindex PDP-11 Options
10228 These options are defined for the PDP-11:
10233 Use hardware FPP floating point. This is the default. (FIS floating
10234 point on the PDP-11/40 is not supported.)
10237 @opindex msoft-float
10238 Do not use hardware floating point.
10242 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10246 Return floating-point results in memory. This is the default.
10250 Generate code for a PDP-11/40.
10254 Generate code for a PDP-11/45. This is the default.
10258 Generate code for a PDP-11/10.
10260 @item -mbcopy-builtin
10261 @opindex bcopy-builtin
10262 Use inline @code{movstrhi} patterns for copying memory. This is the
10267 Do not use inline @code{movstrhi} patterns for copying memory.
10273 Use 16-bit @code{int}. This is the default.
10279 Use 32-bit @code{int}.
10282 @itemx -mno-float32
10284 @opindex mno-float32
10285 Use 64-bit @code{float}. This is the default.
10288 @itemx -mno-float64
10290 @opindex mno-float64
10291 Use 32-bit @code{float}.
10295 Use @code{abshi2} pattern. This is the default.
10299 Do not use @code{abshi2} pattern.
10301 @item -mbranch-expensive
10302 @opindex mbranch-expensive
10303 Pretend that branches are expensive. This is for experimenting with
10304 code generation only.
10306 @item -mbranch-cheap
10307 @opindex mbranch-cheap
10308 Do not pretend that branches are expensive. This is the default.
10312 Generate code for a system with split I&D.
10316 Generate code for a system without split I&D. This is the default.
10320 Use Unix assembler syntax. This is the default when configured for
10321 @samp{pdp11-*-bsd}.
10325 Use DEC assembler syntax. This is the default when configured for any
10326 PDP-11 target other than @samp{pdp11-*-bsd}.
10329 @node Xstormy16 Options
10330 @subsection Xstormy16 Options
10331 @cindex Xstormy16 Options
10333 These options are defined for Xstormy16:
10338 Choose startup files and linker script suitable for the simulator.
10342 @subsection FRV Options
10343 @cindex FRV Options
10349 Only use the first 32 general purpose registers.
10354 Use all 64 general purpose registers.
10359 Use only the first 32 floating point registers.
10364 Use all 64 floating point registers
10367 @opindex mhard-float
10369 Use hardware instructions for floating point operations.
10372 @opindex msoft-float
10374 Use library routines for floating point operations.
10379 Dynamically allocate condition code registers.
10384 Do not try to dynamically allocate condition code registers, only
10385 use @code{icc0} and @code{fcc0}.
10390 Change ABI to use double word insns.
10395 Do not use double word instructions.
10400 Use floating point double instructions.
10403 @opindex mno-double
10405 Do not use floating point double instructions.
10410 Use media instructions.
10415 Do not use media instructions.
10420 Use multiply and add/subtract instructions.
10423 @opindex mno-muladd
10425 Do not use multiply and add/subtract instructions.
10427 @item -mlibrary-pic
10428 @opindex mlibrary-pic
10430 Enable PIC support for building libraries
10435 Use only the first four media accumulator registers.
10440 Use all eight media accumulator registers.
10445 Pack VLIW instructions.
10450 Do not pack VLIW instructions.
10453 @opindex mno-eflags
10455 Do not mark ABI switches in e_flags.
10458 @opindex mcond-move
10460 Enable the use of conditional-move instructions (default).
10462 This switch is mainly for debugging the compiler and will likely be removed
10463 in a future version.
10465 @item -mno-cond-move
10466 @opindex mno-cond-move
10468 Disable the use of conditional-move instructions.
10470 This switch is mainly for debugging the compiler and will likely be removed
10471 in a future version.
10476 Enable the use of conditional set instructions (default).
10478 This switch is mainly for debugging the compiler and will likely be removed
10479 in a future version.
10484 Disable the use of conditional set instructions.
10486 This switch is mainly for debugging the compiler and will likely be removed
10487 in a future version.
10490 @opindex mcond-exec
10492 Enable the use of conditional execution (default).
10494 This switch is mainly for debugging the compiler and will likely be removed
10495 in a future version.
10497 @item -mno-cond-exec
10498 @opindex mno-cond-exec
10500 Disable the use of conditional execution.
10502 This switch is mainly for debugging the compiler and will likely be removed
10503 in a future version.
10505 @item -mvliw-branch
10506 @opindex mvliw-branch
10508 Run a pass to pack branches into VLIW instructions (default).
10510 This switch is mainly for debugging the compiler and will likely be removed
10511 in a future version.
10513 @item -mno-vliw-branch
10514 @opindex mno-vliw-branch
10516 Do not run a pass to pack branches into VLIW instructions.
10518 This switch is mainly for debugging the compiler and will likely be removed
10519 in a future version.
10521 @item -mmulti-cond-exec
10522 @opindex mmulti-cond-exec
10524 Enable optimization of @code{&&} and @code{||} in conditional execution
10527 This switch is mainly for debugging the compiler and will likely be removed
10528 in a future version.
10530 @item -mno-multi-cond-exec
10531 @opindex mno-multi-cond-exec
10533 Disable optimization of @code{&&} and @code{||} in conditional execution.
10535 This switch is mainly for debugging the compiler and will likely be removed
10536 in a future version.
10538 @item -mnested-cond-exec
10539 @opindex mnested-cond-exec
10541 Enable nested conditional execution optimizations (default).
10543 This switch is mainly for debugging the compiler and will likely be removed
10544 in a future version.
10546 @item -mno-nested-cond-exec
10547 @opindex mno-nested-cond-exec
10549 Disable nested conditional execution optimizations.
10551 This switch is mainly for debugging the compiler and will likely be removed
10552 in a future version.
10554 @item -mtomcat-stats
10555 @opindex mtomcat-stats
10557 Cause gas to print out tomcat statistics.
10559 @item -mcpu=@var{cpu}
10562 Select the processor type for which to generate code. Possible values are
10563 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
10568 @node Xtensa Options
10569 @subsection Xtensa Options
10570 @cindex Xtensa Options
10572 These options are supported for Xtensa targets:
10576 @itemx -mno-const16
10578 @opindex mno-const16
10579 Enable or disable use of @code{CONST16} instructions for loading
10580 constant values. The @code{CONST16} instruction is currently not a
10581 standard option from Tensilica. When enabled, @code{CONST16}
10582 instructions are always used in place of the standard @code{L32R}
10583 instructions. The use of @code{CONST16} is enabled by default only if
10584 the @code{L32R} instruction is not available.
10587 @itemx -mno-fused-madd
10588 @opindex mfused-madd
10589 @opindex mno-fused-madd
10590 Enable or disable use of fused multiply/add and multiply/subtract
10591 instructions in the floating-point option. This has no effect if the
10592 floating-point option is not also enabled. Disabling fused multiply/add
10593 and multiply/subtract instructions forces the compiler to use separate
10594 instructions for the multiply and add/subtract operations. This may be
10595 desirable in some cases where strict IEEE 754-compliant results are
10596 required: the fused multiply add/subtract instructions do not round the
10597 intermediate result, thereby producing results with @emph{more} bits of
10598 precision than specified by the IEEE standard. Disabling fused multiply
10599 add/subtract instructions also ensures that the program output is not
10600 sensitive to the compiler's ability to combine multiply and add/subtract
10603 @item -mtext-section-literals
10604 @itemx -mno-text-section-literals
10605 @opindex mtext-section-literals
10606 @opindex mno-text-section-literals
10607 Control the treatment of literal pools. The default is
10608 @option{-mno-text-section-literals}, which places literals in a separate
10609 section in the output file. This allows the literal pool to be placed
10610 in a data RAM/ROM, and it also allows the linker to combine literal
10611 pools from separate object files to remove redundant literals and
10612 improve code size. With @option{-mtext-section-literals}, the literals
10613 are interspersed in the text section in order to keep them as close as
10614 possible to their references. This may be necessary for large assembly
10617 @item -mtarget-align
10618 @itemx -mno-target-align
10619 @opindex mtarget-align
10620 @opindex mno-target-align
10621 When this option is enabled, GCC instructs the assembler to
10622 automatically align instructions to reduce branch penalties at the
10623 expense of some code density. The assembler attempts to widen density
10624 instructions to align branch targets and the instructions following call
10625 instructions. If there are not enough preceding safe density
10626 instructions to align a target, no widening will be performed. The
10627 default is @option{-mtarget-align}. These options do not affect the
10628 treatment of auto-aligned instructions like @code{LOOP}, which the
10629 assembler will always align, either by widening density instructions or
10630 by inserting no-op instructions.
10633 @itemx -mno-longcalls
10634 @opindex mlongcalls
10635 @opindex mno-longcalls
10636 When this option is enabled, GCC instructs the assembler to translate
10637 direct calls to indirect calls unless it can determine that the target
10638 of a direct call is in the range allowed by the call instruction. This
10639 translation typically occurs for calls to functions in other source
10640 files. Specifically, the assembler translates a direct @code{CALL}
10641 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
10642 The default is @option{-mno-longcalls}. This option should be used in
10643 programs where the call target can potentially be out of range. This
10644 option is implemented in the assembler, not the compiler, so the
10645 assembly code generated by GCC will still show direct call
10646 instructions---look at the disassembled object code to see the actual
10647 instructions. Note that the assembler will use an indirect call for
10648 every cross-file call, not just those that really will be out of range.
10651 @node Code Gen Options
10652 @section Options for Code Generation Conventions
10653 @cindex code generation conventions
10654 @cindex options, code generation
10655 @cindex run-time options
10657 These machine-independent options control the interface conventions
10658 used in code generation.
10660 Most of them have both positive and negative forms; the negative form
10661 of @option{-ffoo} would be @option{-fno-foo}. In the table below, only
10662 one of the forms is listed---the one which is not the default. You
10663 can figure out the other form by either removing @samp{no-} or adding
10667 @item -fbounds-check
10668 @opindex fbounds-check
10669 For front-ends that support it, generate additional code to check that
10670 indices used to access arrays are within the declared range. This is
10671 currently only supported by the Java and Fortran 77 front-ends, where
10672 this option defaults to true and false respectively.
10676 This option generates traps for signed overflow on addition, subtraction,
10677 multiplication operations.
10681 This option instructs the compiler to assume that signed arithmetic
10682 overflow of addition, subtraction and multiplication wraps around
10683 using twos-complement representation. This flag enables some optimizations
10684 and disables other. This option is enabled by default for the Java
10685 front-end, as required by the Java language specification.
10688 @opindex fexceptions
10689 Enable exception handling. Generates extra code needed to propagate
10690 exceptions. For some targets, this implies GCC will generate frame
10691 unwind information for all functions, which can produce significant data
10692 size overhead, although it does not affect execution. If you do not
10693 specify this option, GCC will enable it by default for languages like
10694 C++ which normally require exception handling, and disable it for
10695 languages like C that do not normally require it. However, you may need
10696 to enable this option when compiling C code that needs to interoperate
10697 properly with exception handlers written in C++. You may also wish to
10698 disable this option if you are compiling older C++ programs that don't
10699 use exception handling.
10701 @item -fnon-call-exceptions
10702 @opindex fnon-call-exceptions
10703 Generate code that allows trapping instructions to throw exceptions.
10704 Note that this requires platform-specific runtime support that does
10705 not exist everywhere. Moreover, it only allows @emph{trapping}
10706 instructions to throw exceptions, i.e.@: memory references or floating
10707 point instructions. It does not allow exceptions to be thrown from
10708 arbitrary signal handlers such as @code{SIGALRM}.
10710 @item -funwind-tables
10711 @opindex funwind-tables
10712 Similar to @option{-fexceptions}, except that it will just generate any needed
10713 static data, but will not affect the generated code in any other way.
10714 You will normally not enable this option; instead, a language processor
10715 that needs this handling would enable it on your behalf.
10717 @item -fasynchronous-unwind-tables
10718 @opindex funwind-tables
10719 Generate unwind table in dwarf2 format, if supported by target machine. The
10720 table is exact at each instruction boundary, so it can be used for stack
10721 unwinding from asynchronous events (such as debugger or garbage collector).
10723 @item -fpcc-struct-return
10724 @opindex fpcc-struct-return
10725 Return ``short'' @code{struct} and @code{union} values in memory like
10726 longer ones, rather than in registers. This convention is less
10727 efficient, but it has the advantage of allowing intercallability between
10728 GCC-compiled files and files compiled with other compilers, particularly
10729 the Portable C Compiler (pcc).
10731 The precise convention for returning structures in memory depends
10732 on the target configuration macros.
10734 Short structures and unions are those whose size and alignment match
10735 that of some integer type.
10737 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
10738 switch is not binary compatible with code compiled with the
10739 @option{-freg-struct-return} switch.
10740 Use it to conform to a non-default application binary interface.
10742 @item -freg-struct-return
10743 @opindex freg-struct-return
10744 Return @code{struct} and @code{union} values in registers when possible.
10745 This is more efficient for small structures than
10746 @option{-fpcc-struct-return}.
10748 If you specify neither @option{-fpcc-struct-return} nor
10749 @option{-freg-struct-return}, GCC defaults to whichever convention is
10750 standard for the target. If there is no standard convention, GCC
10751 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
10752 the principal compiler. In those cases, we can choose the standard, and
10753 we chose the more efficient register return alternative.
10755 @strong{Warning:} code compiled with the @option{-freg-struct-return}
10756 switch is not binary compatible with code compiled with the
10757 @option{-fpcc-struct-return} switch.
10758 Use it to conform to a non-default application binary interface.
10760 @item -fshort-enums
10761 @opindex fshort-enums
10762 Allocate to an @code{enum} type only as many bytes as it needs for the
10763 declared range of possible values. Specifically, the @code{enum} type
10764 will be equivalent to the smallest integer type which has enough room.
10766 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
10767 code that is not binary compatible with code generated without that switch.
10768 Use it to conform to a non-default application binary interface.
10770 @item -fshort-double
10771 @opindex fshort-double
10772 Use the same size for @code{double} as for @code{float}.
10774 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
10775 code that is not binary compatible with code generated without that switch.
10776 Use it to conform to a non-default application binary interface.
10778 @item -fshort-wchar
10779 @opindex fshort-wchar
10780 Override the underlying type for @samp{wchar_t} to be @samp{short
10781 unsigned int} instead of the default for the target. This option is
10782 useful for building programs to run under WINE@.
10784 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
10785 code that is not binary compatible with code generated without that switch.
10786 Use it to conform to a non-default application binary interface.
10788 @item -fshared-data
10789 @opindex fshared-data
10790 Requests that the data and non-@code{const} variables of this
10791 compilation be shared data rather than private data. The distinction
10792 makes sense only on certain operating systems, where shared data is
10793 shared between processes running the same program, while private data
10794 exists in one copy per process.
10797 @opindex fno-common
10798 In C, allocate even uninitialized global variables in the data section of the
10799 object file, rather than generating them as common blocks. This has the
10800 effect that if the same variable is declared (without @code{extern}) in
10801 two different compilations, you will get an error when you link them.
10802 The only reason this might be useful is if you wish to verify that the
10803 program will work on other systems which always work this way.
10807 Ignore the @samp{#ident} directive.
10809 @item -finhibit-size-directive
10810 @opindex finhibit-size-directive
10811 Don't output a @code{.size} assembler directive, or anything else that
10812 would cause trouble if the function is split in the middle, and the
10813 two halves are placed at locations far apart in memory. This option is
10814 used when compiling @file{crtstuff.c}; you should not need to use it
10817 @item -fverbose-asm
10818 @opindex fverbose-asm
10819 Put extra commentary information in the generated assembly code to
10820 make it more readable. This option is generally only of use to those
10821 who actually need to read the generated assembly code (perhaps while
10822 debugging the compiler itself).
10824 @option{-fno-verbose-asm}, the default, causes the
10825 extra information to be omitted and is useful when comparing two assembler
10830 @cindex global offset table
10832 Generate position-independent code (PIC) suitable for use in a shared
10833 library, if supported for the target machine. Such code accesses all
10834 constant addresses through a global offset table (GOT)@. The dynamic
10835 loader resolves the GOT entries when the program starts (the dynamic
10836 loader is not part of GCC; it is part of the operating system). If
10837 the GOT size for the linked executable exceeds a machine-specific
10838 maximum size, you get an error message from the linker indicating that
10839 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
10840 instead. (These maximums are 8k on the SPARC and 32k
10841 on the m68k and RS/6000. The 386 has no such limit.)
10843 Position-independent code requires special support, and therefore works
10844 only on certain machines. For the 386, GCC supports PIC for System V
10845 but not for the Sun 386i. Code generated for the IBM RS/6000 is always
10846 position-independent.
10850 If supported for the target machine, emit position-independent code,
10851 suitable for dynamic linking and avoiding any limit on the size of the
10852 global offset table. This option makes a difference on the m68k
10855 Position-independent code requires special support, and therefore works
10856 only on certain machines.
10862 These options are similar to @option{-fpic} and @option{-fPIC}, but
10863 generated position independent code can be only linked into executables.
10864 Usually these options are used when @option{-pie} GCC option will be
10865 used during linking.
10867 @item -ffixed-@var{reg}
10869 Treat the register named @var{reg} as a fixed register; generated code
10870 should never refer to it (except perhaps as a stack pointer, frame
10871 pointer or in some other fixed role).
10873 @var{reg} must be the name of a register. The register names accepted
10874 are machine-specific and are defined in the @code{REGISTER_NAMES}
10875 macro in the machine description macro file.
10877 This flag does not have a negative form, because it specifies a
10880 @item -fcall-used-@var{reg}
10881 @opindex fcall-used
10882 Treat the register named @var{reg} as an allocable register that is
10883 clobbered by function calls. It may be allocated for temporaries or
10884 variables that do not live across a call. Functions compiled this way
10885 will not save and restore the register @var{reg}.
10887 It is an error to used this flag with the frame pointer or stack pointer.
10888 Use of this flag for other registers that have fixed pervasive roles in
10889 the machine's execution model will produce disastrous results.
10891 This flag does not have a negative form, because it specifies a
10894 @item -fcall-saved-@var{reg}
10895 @opindex fcall-saved
10896 Treat the register named @var{reg} as an allocable register saved by
10897 functions. It may be allocated even for temporaries or variables that
10898 live across a call. Functions compiled this way will save and restore
10899 the register @var{reg} if they use it.
10901 It is an error to used this flag with the frame pointer or stack pointer.
10902 Use of this flag for other registers that have fixed pervasive roles in
10903 the machine's execution model will produce disastrous results.
10905 A different sort of disaster will result from the use of this flag for
10906 a register in which function values may be returned.
10908 This flag does not have a negative form, because it specifies a
10911 @item -fpack-struct
10912 @opindex fpack-struct
10913 Pack all structure members together without holes.
10915 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
10916 code that is not binary compatible with code generated without that switch.
10917 Additionally, it makes the code suboptimal.
10918 Use it to conform to a non-default application binary interface.
10920 @item -finstrument-functions
10921 @opindex finstrument-functions
10922 Generate instrumentation calls for entry and exit to functions. Just
10923 after function entry and just before function exit, the following
10924 profiling functions will be called with the address of the current
10925 function and its call site. (On some platforms,
10926 @code{__builtin_return_address} does not work beyond the current
10927 function, so the call site information may not be available to the
10928 profiling functions otherwise.)
10931 void __cyg_profile_func_enter (void *this_fn,
10933 void __cyg_profile_func_exit (void *this_fn,
10937 The first argument is the address of the start of the current function,
10938 which may be looked up exactly in the symbol table.
10940 This instrumentation is also done for functions expanded inline in other
10941 functions. The profiling calls will indicate where, conceptually, the
10942 inline function is entered and exited. This means that addressable
10943 versions of such functions must be available. If all your uses of a
10944 function are expanded inline, this may mean an additional expansion of
10945 code size. If you use @samp{extern inline} in your C code, an
10946 addressable version of such functions must be provided. (This is
10947 normally the case anyways, but if you get lucky and the optimizer always
10948 expands the functions inline, you might have gotten away without
10949 providing static copies.)
10951 A function may be given the attribute @code{no_instrument_function}, in
10952 which case this instrumentation will not be done. This can be used, for
10953 example, for the profiling functions listed above, high-priority
10954 interrupt routines, and any functions from which the profiling functions
10955 cannot safely be called (perhaps signal handlers, if the profiling
10956 routines generate output or allocate memory).
10958 @item -fstack-check
10959 @opindex fstack-check
10960 Generate code to verify that you do not go beyond the boundary of the
10961 stack. You should specify this flag if you are running in an
10962 environment with multiple threads, but only rarely need to specify it in
10963 a single-threaded environment since stack overflow is automatically
10964 detected on nearly all systems if there is only one stack.
10966 Note that this switch does not actually cause checking to be done; the
10967 operating system must do that. The switch causes generation of code
10968 to ensure that the operating system sees the stack being extended.
10970 @item -fstack-limit-register=@var{reg}
10971 @itemx -fstack-limit-symbol=@var{sym}
10972 @itemx -fno-stack-limit
10973 @opindex fstack-limit-register
10974 @opindex fstack-limit-symbol
10975 @opindex fno-stack-limit
10976 Generate code to ensure that the stack does not grow beyond a certain value,
10977 either the value of a register or the address of a symbol. If the stack
10978 would grow beyond the value, a signal is raised. For most targets,
10979 the signal is raised before the stack overruns the boundary, so
10980 it is possible to catch the signal without taking special precautions.
10982 For instance, if the stack starts at absolute address @samp{0x80000000}
10983 and grows downwards, you can use the flags
10984 @option{-fstack-limit-symbol=__stack_limit} and
10985 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
10986 of 128KB@. Note that this may only work with the GNU linker.
10988 @cindex aliasing of parameters
10989 @cindex parameters, aliased
10990 @item -fargument-alias
10991 @itemx -fargument-noalias
10992 @itemx -fargument-noalias-global
10993 @opindex fargument-alias
10994 @opindex fargument-noalias
10995 @opindex fargument-noalias-global
10996 Specify the possible relationships among parameters and between
10997 parameters and global data.
10999 @option{-fargument-alias} specifies that arguments (parameters) may
11000 alias each other and may alias global storage.@*
11001 @option{-fargument-noalias} specifies that arguments do not alias
11002 each other, but may alias global storage.@*
11003 @option{-fargument-noalias-global} specifies that arguments do not
11004 alias each other and do not alias global storage.
11006 Each language will automatically use whatever option is required by
11007 the language standard. You should not need to use these options yourself.
11009 @item -fleading-underscore
11010 @opindex fleading-underscore
11011 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11012 change the way C symbols are represented in the object file. One use
11013 is to help link with legacy assembly code.
11015 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11016 generate code that is not binary compatible with code generated without that
11017 switch. Use it to conform to a non-default application binary interface.
11018 Not all targets provide complete support for this switch.
11020 @item -ftls-model=@var{model}
11021 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11022 The @var{model} argument should be one of @code{global-dynamic},
11023 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11025 The default without @option{-fpic} is @code{initial-exec}; with
11026 @option{-fpic} the default is @code{global-dynamic}.
11031 @node Environment Variables
11032 @section Environment Variables Affecting GCC
11033 @cindex environment variables
11035 @c man begin ENVIRONMENT
11036 This section describes several environment variables that affect how GCC
11037 operates. Some of them work by specifying directories or prefixes to use
11038 when searching for various kinds of files. Some are used to specify other
11039 aspects of the compilation environment.
11041 Note that you can also specify places to search using options such as
11042 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}). These
11043 take precedence over places specified using environment variables, which
11044 in turn take precedence over those specified by the configuration of GCC@.
11045 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11046 GNU Compiler Collection (GCC) Internals}.
11051 @c @itemx LC_COLLATE
11053 @c @itemx LC_MONETARY
11054 @c @itemx LC_NUMERIC
11059 @c @findex LC_COLLATE
11060 @findex LC_MESSAGES
11061 @c @findex LC_MONETARY
11062 @c @findex LC_NUMERIC
11066 These environment variables control the way that GCC uses
11067 localization information that allow GCC to work with different
11068 national conventions. GCC inspects the locale categories
11069 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11070 so. These locale categories can be set to any value supported by your
11071 installation. A typical value is @samp{en_UK} for English in the United
11074 The @env{LC_CTYPE} environment variable specifies character
11075 classification. GCC uses it to determine the character boundaries in
11076 a string; this is needed for some multibyte encodings that contain quote
11077 and escape characters that would otherwise be interpreted as a string
11080 The @env{LC_MESSAGES} environment variable specifies the language to
11081 use in diagnostic messages.
11083 If the @env{LC_ALL} environment variable is set, it overrides the value
11084 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11085 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11086 environment variable. If none of these variables are set, GCC
11087 defaults to traditional C English behavior.
11091 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11092 files. GCC uses temporary files to hold the output of one stage of
11093 compilation which is to be used as input to the next stage: for example,
11094 the output of the preprocessor, which is the input to the compiler
11097 @item GCC_EXEC_PREFIX
11098 @findex GCC_EXEC_PREFIX
11099 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11100 names of the subprograms executed by the compiler. No slash is added
11101 when this prefix is combined with the name of a subprogram, but you can
11102 specify a prefix that ends with a slash if you wish.
11104 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11105 an appropriate prefix to use based on the pathname it was invoked with.
11107 If GCC cannot find the subprogram using the specified prefix, it
11108 tries looking in the usual places for the subprogram.
11110 The default value of @env{GCC_EXEC_PREFIX} is
11111 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
11112 of @code{prefix} when you ran the @file{configure} script.
11114 Other prefixes specified with @option{-B} take precedence over this prefix.
11116 This prefix is also used for finding files such as @file{crt0.o} that are
11119 In addition, the prefix is used in an unusual way in finding the
11120 directories to search for header files. For each of the standard
11121 directories whose name normally begins with @samp{/usr/local/lib/gcc}
11122 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11123 replacing that beginning with the specified prefix to produce an
11124 alternate directory name. Thus, with @option{-Bfoo/}, GCC will search
11125 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11126 These alternate directories are searched first; the standard directories
11129 @item COMPILER_PATH
11130 @findex COMPILER_PATH
11131 The value of @env{COMPILER_PATH} is a colon-separated list of
11132 directories, much like @env{PATH}. GCC tries the directories thus
11133 specified when searching for subprograms, if it can't find the
11134 subprograms using @env{GCC_EXEC_PREFIX}.
11137 @findex LIBRARY_PATH
11138 The value of @env{LIBRARY_PATH} is a colon-separated list of
11139 directories, much like @env{PATH}. When configured as a native compiler,
11140 GCC tries the directories thus specified when searching for special
11141 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}. Linking
11142 using GCC also uses these directories when searching for ordinary
11143 libraries for the @option{-l} option (but directories specified with
11144 @option{-L} come first).
11148 @cindex locale definition
11149 This variable is used to pass locale information to the compiler. One way in
11150 which this information is used is to determine the character set to be used
11151 when character literals, string literals and comments are parsed in C and C++.
11152 When the compiler is configured to allow multibyte characters,
11153 the following values for @env{LANG} are recognized:
11157 Recognize JIS characters.
11159 Recognize SJIS characters.
11161 Recognize EUCJP characters.
11164 If @env{LANG} is not defined, or if it has some other value, then the
11165 compiler will use mblen and mbtowc as defined by the default locale to
11166 recognize and translate multibyte characters.
11170 Some additional environments variables affect the behavior of the
11173 @include cppenv.texi
11177 @node Precompiled Headers
11178 @section Using Precompiled Headers
11179 @cindex precompiled headers
11180 @cindex speed of compilation
11182 Often large projects have many header files that are included in every
11183 source file. The time the compiler takes to process these header files
11184 over and over again can account for nearly all of the time required to
11185 build the project. To make builds faster, GCC allows users to
11186 `precompile' a header file; then, if builds can use the precompiled
11187 header file they will be much faster.
11189 To create a precompiled header file, simply compile it as you would any
11190 other file, if necessary using the @option{-x} option to make the driver
11191 treat it as a C or C++ header file. You will probably want to use a
11192 tool like @command{make} to keep the precompiled header up-to-date when
11193 the headers it contains change.
11195 A precompiled header file will be searched for when @code{#include} is
11196 seen in the compilation. As it searches for the included file
11197 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
11198 compiler looks for a precompiled header in each directory just before it
11199 looks for the include file in that directory. The name searched for is
11200 the name specified in the @code{#include} with @samp{.gch} appended. If
11201 the precompiled header file can't be used, it is ignored.
11203 For instance, if you have @code{#include "all.h"}, and you have
11204 @file{all.h.gch} in the same directory as @file{all.h}, then the
11205 precompiled header file will be used if possible, and the original
11206 header will be used otherwise.
11208 Alternatively, you might decide to put the precompiled header file in a
11209 directory and use @option{-I} to ensure that directory is searched
11210 before (or instead of) the directory containing the original header.
11211 Then, if you want to check that the precompiled header file is always
11212 used, you can put a file of the same name as the original header in this
11213 directory containing an @code{#error} command.
11215 This also works with @option{-include}. So yet another way to use
11216 precompiled headers, good for projects not designed with precompiled
11217 header files in mind, is to simply take most of the header files used by
11218 a project, include them from another header file, precompile that header
11219 file, and @option{-include} the precompiled header. If the header files
11220 have guards against multiple inclusion, they will be skipped because
11221 they've already been included (in the precompiled header).
11223 If you need to precompile the same header file for different
11224 languages, targets, or compiler options, you can instead make a
11225 @emph{directory} named like @file{all.h.gch}, and put each precompiled
11226 header in the directory. (It doesn't matter what you call the files
11227 in the directory, every precompiled header in the directory will be
11228 considered.) The first precompiled header encountered in the
11229 directory that is valid for this compilation will be used; they're
11230 searched in no particular order.
11232 There are many other possibilities, limited only by your imagination,
11233 good sense, and the constraints of your build system.
11235 A precompiled header file can be used only when these conditions apply:
11239 Only one precompiled header can be used in a particular compilation.
11241 A precompiled header can't be used once the first C token is seen. You
11242 can have preprocessor directives before a precompiled header; you can
11243 even include a precompiled header from inside another header, so long as
11244 there are no C tokens before the @code{#include}.
11246 The precompiled header file must be produced for the same language as
11247 the current compilation. You can't use a C precompiled header for a C++
11250 The precompiled header file must be produced by the same compiler
11251 version and configuration as the current compilation is using.
11252 The easiest way to guarantee this is to use the same compiler binary
11253 for creating and using precompiled headers.
11255 Any macros defined before the precompiled header (including with
11256 @option{-D}) must either be defined in the same way as when the
11257 precompiled header was generated, or must not affect the precompiled
11258 header, which usually means that the they don't appear in the
11259 precompiled header at all.
11261 Certain command-line options must be defined in the same way as when the
11262 precompiled header was generated. At present, it's not clear which
11263 options are safe to change and which are not; the safest choice is to
11264 use exactly the same options when generating and using the precompiled
11268 For all of these but the last, the compiler will automatically ignore
11269 the precompiled header if the conditions aren't met. For the last item,
11270 some option changes will cause the precompiled header to be rejected,
11271 but not all incompatible option combinations have yet been found. If
11272 you find a new incompatible combination, please consider filing a bug
11273 report, see @ref{Bugs}.
11275 @node Running Protoize
11276 @section Running Protoize
11278 The program @code{protoize} is an optional part of GCC@. You can use
11279 it to add prototypes to a program, thus converting the program to ISO
11280 C in one respect. The companion program @code{unprotoize} does the
11281 reverse: it removes argument types from any prototypes that are found.
11283 When you run these programs, you must specify a set of source files as
11284 command line arguments. The conversion programs start out by compiling
11285 these files to see what functions they define. The information gathered
11286 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11288 After scanning comes actual conversion. The specified files are all
11289 eligible to be converted; any files they include (whether sources or
11290 just headers) are eligible as well.
11292 But not all the eligible files are converted. By default,
11293 @code{protoize} and @code{unprotoize} convert only source and header
11294 files in the current directory. You can specify additional directories
11295 whose files should be converted with the @option{-d @var{directory}}
11296 option. You can also specify particular files to exclude with the
11297 @option{-x @var{file}} option. A file is converted if it is eligible, its
11298 directory name matches one of the specified directory names, and its
11299 name within the directory has not been excluded.
11301 Basic conversion with @code{protoize} consists of rewriting most
11302 function definitions and function declarations to specify the types of
11303 the arguments. The only ones not rewritten are those for varargs
11306 @code{protoize} optionally inserts prototype declarations at the
11307 beginning of the source file, to make them available for any calls that
11308 precede the function's definition. Or it can insert prototype
11309 declarations with block scope in the blocks where undeclared functions
11312 Basic conversion with @code{unprotoize} consists of rewriting most
11313 function declarations to remove any argument types, and rewriting
11314 function definitions to the old-style pre-ISO form.
11316 Both conversion programs print a warning for any function declaration or
11317 definition that they can't convert. You can suppress these warnings
11320 The output from @code{protoize} or @code{unprotoize} replaces the
11321 original source file. The original file is renamed to a name ending
11322 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11323 without the original @samp{.c} suffix). If the @samp{.save} (@samp{.sav}
11324 for DOS) file already exists, then the source file is simply discarded.
11326 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11327 scan the program and collect information about the functions it uses.
11328 So neither of these programs will work until GCC is installed.
11330 Here is a table of the options you can use with @code{protoize} and
11331 @code{unprotoize}. Each option works with both programs unless
11335 @item -B @var{directory}
11336 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11337 usual directory (normally @file{/usr/local/lib}). This file contains
11338 prototype information about standard system functions. This option
11339 applies only to @code{protoize}.
11341 @item -c @var{compilation-options}
11342 Use @var{compilation-options} as the options when running @command{gcc} to
11343 produce the @samp{.X} files. The special option @option{-aux-info} is
11344 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11346 Note that the compilation options must be given as a single argument to
11347 @code{protoize} or @code{unprotoize}. If you want to specify several
11348 @command{gcc} options, you must quote the entire set of compilation options
11349 to make them a single word in the shell.
11351 There are certain @command{gcc} arguments that you cannot use, because they
11352 would produce the wrong kind of output. These include @option{-g},
11353 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11354 the @var{compilation-options}, they are ignored.
11357 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11358 systems) instead of @samp{.c}. This is convenient if you are converting
11359 a C program to C++. This option applies only to @code{protoize}.
11362 Add explicit global declarations. This means inserting explicit
11363 declarations at the beginning of each source file for each function
11364 that is called in the file and was not declared. These declarations
11365 precede the first function definition that contains a call to an
11366 undeclared function. This option applies only to @code{protoize}.
11368 @item -i @var{string}
11369 Indent old-style parameter declarations with the string @var{string}.
11370 This option applies only to @code{protoize}.
11372 @code{unprotoize} converts prototyped function definitions to old-style
11373 function definitions, where the arguments are declared between the
11374 argument list and the initial @samp{@{}. By default, @code{unprotoize}
11375 uses five spaces as the indentation. If you want to indent with just
11376 one space instead, use @option{-i " "}.
11379 Keep the @samp{.X} files. Normally, they are deleted after conversion
11383 Add explicit local declarations. @code{protoize} with @option{-l} inserts
11384 a prototype declaration for each function in each block which calls the
11385 function without any declaration. This option applies only to
11389 Make no real changes. This mode just prints information about the conversions
11390 that would have been done without @option{-n}.
11393 Make no @samp{.save} files. The original files are simply deleted.
11394 Use this option with caution.
11396 @item -p @var{program}
11397 Use the program @var{program} as the compiler. Normally, the name
11398 @file{gcc} is used.
11401 Work quietly. Most warnings are suppressed.
11404 Print the version number, just like @option{-v} for @command{gcc}.
11407 If you need special compiler options to compile one of your program's
11408 source files, then you should generate that file's @samp{.X} file
11409 specially, by running @command{gcc} on that source file with the
11410 appropriate options and the option @option{-aux-info}. Then run
11411 @code{protoize} on the entire set of files. @code{protoize} will use
11412 the existing @samp{.X} file because it is newer than the source file.
11416 gcc -Dfoo=bar file1.c -aux-info file1.X
11421 You need to include the special files along with the rest in the
11422 @code{protoize} command, even though their @samp{.X} files already
11423 exist, because otherwise they won't get converted.
11425 @xref{Protoize Caveats}, for more information on how to use
11426 @code{protoize} successfully.