Using The GNU Compiler Collection: Richard M. Stallman and The GCC Developer Community
Using The GNU Compiler Collection: Richard M. Stallman and The GCC Developer Community
(GCC)
Short Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1 Programming Languages Supported by GCC . . . . . . . . . . . . . . . 3
2 Language Standards Supported by GCC . . . . . . . . . . . . . . . . . . 5
3 GCC Command Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
4 C Implementation-Defined Behavior . . . . . . . . . . . . . . . . . . . . 517
5 C++ Implementation-Defined Behavior . . . . . . . . . . . . . . . . . 527
6 Extensions to the C Language Family . . . . . . . . . . . . . . . . . . . 529
7 Extensions to the C++ Language . . . . . . . . . . . . . . . . . . . . . . 887
8 GNU Objective-C Features . . . . . . . . . . . . . . . . . . . . . . . . . . . 901
9 Binary Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
10 gcov—a Test Coverage Program . . . . . . . . . . . . . . . . . . . . . . . 921
11 gcov-tool—an Offline Gcda Profile Processing Tool . . . . . . . 941
12 gcov-dump—an Offline Gcda and Gcno Profile Dump Tool . . 945
13 lto-dump—Tool for dumping LTO object files. . . . . . . . . . . . 947
14 Known Causes of Trouble with GCC . . . . . . . . . . . . . . . . . . . . 949
15 Reporting Bugs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965
16 How To Get Help with GCC . . . . . . . . . . . . . . . . . . . . . . . . . . 967
17 Contributing to GCC Development . . . . . . . . . . . . . . . . . . . . . 969
Funding Free Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971
The GNU Project and GNU/Linux . . . . . . . . . . . . . . . . . . . . . . . . . 973
GNU General Public License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 975
GNU Free Documentation License . . . . . . . . . . . . . . . . . . . . . . . . . 987
Contributors to GCC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
Option Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1013
Keyword Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1041
iii
Table of Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Introduction
This manual documents how to use the GNU compilers, as well as their features and incom-
patibilities, and how to report bugs. It corresponds to the compilers (GCC) version 13.0.0.
The internals of the GNU compilers, including how to port them to new targets and some
information about how to write front ends for new languages, are documented in a separate
manual. See Section “Introduction” in GNU Compiler Collection (GCC) Internals.
Chapter 1: Programming Languages Supported by GCC 3
2.1 C Language
The original ANSI C standard (X3.159-1989) was ratified in 1989 and published in 1990.
This standard was ratified as an ISO standard (ISO/IEC 9899:1990) later in 1990. There
were no technical differences between these publications, although the sections of the ANSI
standard were renumbered and became clauses in the ISO standard. The ANSI standard,
but not the ISO standard, also came with a Rationale document. This standard, in both
its forms, is commonly known as C89, or occasionally as C90, from the dates of ratifi-
cation. To select this standard in GCC, use one of the options ‘-ansi’, ‘-std=c90’ or
‘-std=iso9899:1990’; to obtain all the diagnostics required by the standard, you should
also specify ‘-pedantic’ (or ‘-pedantic-errors’ if you want them to be errors rather than
warnings). See Section 3.4 [Options Controlling C Dialect], page 44.
Errors in the 1990 ISO C standard were corrected in two Technical Corrigenda published
in 1994 and 1996. GCC does not support the uncorrected version.
An amendment to the 1990 standard was published in 1995. This amendment added
digraphs and __STDC_VERSION__ to the language, but otherwise concerned the library. This
amendment is commonly known as AMD1; the amended standard is sometimes known as
C94 or C95. To select this standard in GCC, use the option ‘-std=iso9899:199409’ (with,
as for other standard versions, ‘-pedantic’ to receive all required diagnostics).
A new edition of the ISO C standard was published in 1999 as ISO/IEC 9899:1999, and
is commonly known as C99. (While in development, drafts of this standard version were
referred to as C9X.) GCC has substantially complete support for this standard version;
see https: / /gcc .gnu .org /c99status .html for details. To select this standard, use
‘-std=c99’ or ‘-std=iso9899:1999’.
Errors in the 1999 ISO C standard were corrected in three Technical Corrigenda published
in 2001, 2004 and 2007. GCC does not support the uncorrected version.
A fourth version of the C standard, known as C11, was published in 2011 as ISO/IEC
9899:2011. (While in development, drafts of this standard version were referred to as C1X.)
GCC has substantially complete support for this standard, enabled with ‘-std=c11’ or
‘-std=iso9899:2011’. A version with corrections integrated was prepared in 2017 and pub-
lished in 2018 as ISO/IEC 9899:2018; it is known as C17 and is supported with ‘-std=c17’
or ‘-std=iso9899:2017’; the corrections are also applied with ‘-std=c11’, and the only
difference between the options is the value of __STDC_VERSION__.
A further version of the C standard, known as C2X, is under development; experimental
and incomplete support for this is enabled with ‘-std=c2x’.
By default, GCC provides some extensions to the C language that, on rare occasions con-
flict with the C standard. See Chapter 6 [Extensions to the C Language Family], page 529.
Some features that are part of the C99 standard are accepted as extensions in C90 mode,
and some features that are part of the C11 standard are accepted as extensions in C90 and
C99 modes. Use of the ‘-std’ options listed above disables these extensions where they
6 Using the GNU Compiler Collection (GCC)
conflict with the C standard version selected. You may also select an extended version of
the C language explicitly with ‘-std=gnu90’ (for C90 with GNU extensions), ‘-std=gnu99’
(for C99 with GNU extensions) or ‘-std=gnu11’ (for C11 with GNU extensions).
The default, if no C language dialect options are given, is ‘-std=gnu17’.
The ISO C standard defines (in clause 4) two classes of conforming implementation. A
conforming hosted implementation supports the whole standard including all the library
facilities; a conforming freestanding implementation is only required to provide certain
library facilities: those in <float.h>, <limits.h>, <stdarg.h>, and <stddef.h>; since
AMD1, also those in <iso646.h>; since C99, also those in <stdbool.h> and <stdint.h>;
and since C11, also those in <stdalign.h> and <stdnoreturn.h>. In addition, complex
types, added in C99, are not required for freestanding implementations.
The standard also defines two environments for programs, a freestanding environment,
required of all implementations and which may not have library facilities beyond those
required of freestanding implementations, where the handling of program startup and ter-
mination are implementation-defined; and a hosted environment, which is not required,
in which all the library facilities are provided and startup is through a function int main
(void) or int main (int, char *[]). An OS kernel is an example of a program running
in a freestanding environment; a program using the facilities of an operating system is an
example of a program running in a hosted environment.
GCC aims towards being usable as a conforming freestanding implementation, or as the
compiler for a conforming hosted implementation. By default, it acts as the compiler for a
hosted implementation, defining __STDC_HOSTED__ as 1 and presuming that when the names
of ISO C functions are used, they have the semantics defined in the standard. To make it act
as a conforming freestanding implementation for a freestanding environment, use the option
‘-ffreestanding’; it then defines __STDC_HOSTED__ to 0 and does not make assumptions
about the meanings of function names from the standard library, with exceptions noted
below. To build an OS kernel, you may well still need to make your own arrangements for
linking and startup. See Section 3.4 [Options Controlling C Dialect], page 44.
GCC does not provide the library facilities required only of hosted implementations, nor
yet all the facilities required by C99 of freestanding implementations on all platforms. To
use the facilities of a hosted environment, you need to find them elsewhere (for example, in
the GNU C library). See Section 14.5 [Standard Libraries], page 954.
Most of the compiler support routines used by GCC are present in ‘libgcc’, but there
are a few exceptions. GCC requires the freestanding environment provide memcpy, memmove,
memset and memcmp. Finally, if __builtin_trap is used, and the target does not implement
the trap pattern, then GCC emits a call to abort.
For references to Technical Corrigenda, Rationale documents and information concerning
the history of C that is available online, see https://gcc.gnu.org/readings.html
standards are referred to as C++98 and C++03, respectively. GCC implements the majority
of C++98 (export is a notable exception) and most of the changes in C++03. To select
this standard in GCC, use one of the options ‘-ansi’, ‘-std=c++98’, or ‘-std=c++03’; to
obtain all the diagnostics required by the standard, you should also specify ‘-pedantic’ (or
‘-pedantic-errors’ if you want them to be errors rather than warnings).
A revised ISO C++ standard was published in 2011 as ISO/IEC 14882:2011, and is referred
to as C++11; before its publication it was commonly referred to as C++0x. C++11 contains
several changes to the C++ language, all of which have been implemented in GCC. For
details see https://gcc.gnu.org/projects/cxx-status.html#cxx11. To select this
standard in GCC, use the option ‘-std=c++11’.
Another revised ISO C++ standard was published in 2014 as ISO/IEC 14882:2014, and is
referred to as C++14; before its publication it was sometimes referred to as C++1y. C++14
contains several further changes to the C++ language, all of which have been implemented
in GCC. For details see https://gcc.gnu.org/projects/cxx-status.html#cxx14. To
select this standard in GCC, use the option ‘-std=c++14’.
The C++ language was further revised in 2017 and ISO/IEC 14882:2017 was published.
This is referred to as C++17, and before publication was often referred to as C++1z. GCC
supports all the changes in that specification. For further details see https://gcc.gnu.
org/projects/cxx-status.html#cxx17. Use the option ‘-std=c++17’ to select this vari-
ant of C++.
Another revised ISO C++ standard was published in 2020 as ISO/IEC 14882:2020, and
is referred to as C++20; before its publication it was sometimes referred to as C++2a. GCC
supports most of the changes in the new specification. For further details see https://
gcc.gnu.org/projects/cxx-status.html#cxx20. To select this standard in GCC, use
the option ‘-std=c++20’.
More information about the C++ standards is available on the ISO C++ committee’s web
site at http://www.open-std.org/jtc1/sc22/wg21/.
To obtain all the diagnostics required by any of the standard versions described above
you should specify ‘-pedantic’ or ‘-pedantic-errors’, otherwise GCC will allow some
non-ISO C++ features as extensions. See Section 3.8 [Warning Options], page 90.
By default, GCC also provides some additional extensions to the C++ language that
on rare occasions conflict with the C++ standard. See Section 3.5 [C++ Dialect Options],
page 51. Use of the ‘-std’ options listed above disables these extensions where they they
conflict with the C++ standard version selected. You may also select an extended version
of the C++ language explicitly with ‘-std=gnu++98’ (for C++98 with GNU extensions), or
‘-std=gnu++11’ (for C++11 with GNU extensions), or ‘-std=gnu++14’ (for C++14 with GNU
extensions), or ‘-std=gnu++17’ (for C++17 with GNU extensions), or ‘-std=gnu++20’ (for
C++20 with GNU extensions).
The default, if no C++ language dialect options are given, is ‘-std=gnu++17’.
(only for Objective-C), method attributes and the @optional and @required keywords in
protocols. GCC supports Objective-C++ and features available in Objective-C are also
available in Objective-C++.
GCC by default uses the GNU Objective-C runtime library, which is part of GCC and
is not the same as the Apple/NeXT Objective-C runtime library used on Apple systems.
There are a number of differences documented in this manual. The options ‘-fgnu-runtime’
and ‘-fnext-runtime’ allow you to switch between producing output that works with the
GNU Objective-C runtime library and output that works with the Apple/NeXT Objective-
C runtime library.
There is no formal written standard for Objective-C or Objective-C++. The author-
itative manual on traditional Objective-C (1.0) is “Object-Oriented Programming and
the Objective-C Language”: http: / / www . gnustep . org / resources / documentation /
ObjectivCBook.pdf is the original NeXTstep document.
The Objective-C exception and synchronization syntax (that is, the keywords @try,
@throw, @catch, @finally and @synchronized) is supported by GCC and is enabled with
the option ‘-fobjc-exceptions’. The syntax is briefly documented in this manual and in
the Objective-C 2.0 manuals from Apple.
The Objective-C 2.0 language extensions and features are automatically enabled;
they include properties (via the @property, @synthesize and @dynamic keywords),
fast enumeration (not available in Objective-C++), attributes for methods (such as
deprecated, noreturn, sentinel, format), the unused attribute for method arguments,
the @package keyword for instance variables and the @optional and @required keywords
in protocols. You can disable all these Objective-C 2.0 language extensions with the
option ‘-fobjc-std=objc1’, which causes the compiler to recognize the same Objective-C
language syntax recognized by GCC 4.0, and to produce an error if one of the new features
is used.
GCC has currently no support for non-fragile instance variables.
The authoritative manual on Objective-C 2.0 is available from Apple:
• https: / / developer . apple . com / library / archive / documentation / Cocoa /
Conceptual/ProgrammingWithObjectiveC/Introduction/Introduction.html
For more information concerning the history of Objective-C that is available online, see
https://gcc.gnu.org/readings.html
2.4 Go Language
As of the GCC 4.7.1 release, GCC supports the Go 1 language standard, described at
https://golang.org/doc/go1.
2.5 D language
GCC supports the D 2.0 programming language. The D language itself is currently de-
fined by its reference implementation and supporting language specification, described at
https://dlang.org/spec/spec.html.
Chapter 2: Language Standards Supported by GCC 9
Overall Options
See Section 3.2 [Options Controlling the Kind of Output], page 33.
-c -S -E -o file
-dumpbase dumpbase -dumpbase-ext auxdropsuf
-dumpdir dumppfx -x language
-v -### --help[=class[,...]] --target-help --version
-pass-exit-codes -pipe -specs=file -wrapper
@file -ffile-prefix-map=old=new
-fplugin=file -fplugin-arg-name=arg
-fdump-ada-spec[-slim] -fada-spec-parent=unit -fdump-go-spec=file
C Language Options
See Section 3.4 [Options Controlling C Dialect], page 44.
-ansi -std=standard -aux-info filename
-fallow-parameterless-variadic-functions -fno-asm
-fno-builtin -fno-builtin-function -fcond-mismatch
-ffreestanding -fgimple -fgnu-tm -fgnu89-inline -fhosted
-flax-vector-conversions -fms-extensions
-foffload=arg -foffload-options=arg
-fopenacc -fopenacc-dim=geom
-fopenmp -fopenmp-simd
-fpermitted-flt-eval-methods=standard
-fplan9-extensions -fsigned-bitfields -funsigned-bitfields
-fsigned-char -funsigned-char -fsso-struct=endianness
C++ Language Options
See Section 3.5 [Options Controlling C++ Dialect], page 51.
-fabi-version=n -fno-access-control
-faligned-new=n -fargs-in-order=n -fchar8_t -fcheck-new
-fconstexpr-depth=n -fconstexpr-cache-depth=n
-fconstexpr-loop-limit=n -fconstexpr-ops-limit=n
-fno-elide-constructors
-fno-enforce-eh-specs
-fno-gnu-keywords
-fno-implicit-templates
-fno-implicit-inline-templates
-fno-implement-inlines
-fmodule-header[=kind] -fmodule-only -fmodules-ts
-fmodule-implicit-inline
-fno-module-lazy
-fmodule-mapper=specification
-fmodule-version-ignore
-fms-extensions
-fnew-inheriting-ctors
-fnew-ttp-matching
-fno-nonansi-builtins -fnothrow-opt -fno-operator-names
-fno-optional-diags -fpermissive
-fno-pretty-templates
-fno-rtti -fsized-deallocation
-ftemplate-backtrace-limit=n
-ftemplate-depth=n
-fno-threadsafe-statics -fuse-cxa-atexit
-fno-weak -nostdinc++
-fvisibility-inlines-hidden
-fvisibility-ms-compat
-fext-numeric-literals
-flang-info-include-translate[=header]
-flang-info-include-translate-not
Chapter 3: GCC Command Options 13
-flang-info-module-cmi[=module]
-stdlib=libstdc++,libc++
-Wabi-tag -Wcatch-value -Wcatch-value=n
-Wno-class-conversion -Wclass-memaccess
-Wcomma-subscript -Wconditionally-supported
-Wno-conversion-null -Wctad-maybe-unsupported
-Wctor-dtor-privacy -Wno-delete-incomplete
-Wdelete-non-virtual-dtor -Wno-deprecated-array-compare
-Wdeprecated-copy -Wdeprecated-copy-dtor
-Wno-deprecated-enum-enum-conversion -Wno-deprecated-enum-float-conversion
-Weffc++ -Wno-exceptions -Wextra-semi -Wno-inaccessible-base
-Wno-inherited-variadic-ctor -Wno-init-list-lifetime
-Winvalid-imported-macros
-Wno-invalid-offsetof -Wno-literal-suffix
-Wmismatched-new-delete -Wmismatched-tags
-Wmultiple-inheritance -Wnamespaces -Wnarrowing
-Wnoexcept -Wnoexcept-type -Wnon-virtual-dtor
-Wpessimizing-move -Wno-placement-new -Wplacement-new=n
-Wrange-loop-construct -Wredundant-move -Wredundant-tags
-Wreorder -Wregister
-Wstrict-null-sentinel -Wno-subobject-linkage -Wtemplates
-Wno-non-template-friend -Wold-style-cast
-Woverloaded-virtual -Wno-pmf-conversions -Wsign-promo
-Wsized-deallocation -Wsuggest-final-methods
-Wsuggest-final-types -Wsuggest-override
-Wno-terminate -Wuseless-cast -Wno-vexing-parse
-Wvirtual-inheritance
-Wno-virtual-move-assign -Wvolatile -Wzero-as-null-pointer-constant
-fdiagnostics-urls=[auto|never|always]
-fdiagnostics-format=[text|sarif-stderr|sarif-file|json|json-stderr|json-
file]
-fno-diagnostics-show-option -fno-diagnostics-show-caret
-fno-diagnostics-show-labels -fno-diagnostics-show-line-numbers
-fno-diagnostics-show-cwe
-fno-diagnostics-show-rule
-fdiagnostics-minimum-margin-width=width
-fdiagnostics-parseable-fixits -fdiagnostics-generate-patch
-fdiagnostics-show-template-tree -fno-elide-type
-fdiagnostics-path-format=[none|separate-events|inline-events]
-fdiagnostics-show-path-depths
-fno-show-column
-fdiagnostics-column-unit=[display|byte]
-fdiagnostics-column-origin=origin
-fdiagnostics-escape-format=[unicode|bytes]
Warning Options
See Section 3.8 [Options to Request or Suppress Warnings], page 90.
-fsyntax-only -fmax-errors=n -Wpedantic
-pedantic-errors
-w -Wextra -Wall -Wabi=n
-Waddress -Wno-address-of-packed-member -Waggregate-return
-Walloc-size-larger-than=byte-size -Walloc-zero
-Walloca -Walloca-larger-than=byte-size
-Wno-aggressive-loop-optimizations
-Warith-conversion
-Warray-bounds -Warray-bounds=n -Warray-compare
-Wno-attributes -Wattribute-alias=n -Wno-attribute-alias
-Wno-attribute-warning
-Wbidi-chars=[none|unpaired|any|ucn]
-Wbool-compare -Wbool-operation
-Wno-builtin-declaration-mismatch
-Wno-builtin-macro-redefined -Wc90-c99-compat -Wc99-c11-compat
-Wc11-c2x-compat
-Wc++-compat -Wc++11-compat -Wc++14-compat -Wc++17-compat
-Wc++20-compat
-Wno-c++11-extensions -Wno-c++14-extensions -Wno-c++17-extensions
-Wno-c++20-extensions -Wno-c++23-extensions
-Wcast-align -Wcast-align=strict -Wcast-function-type -Wcast-qual
-Wchar-subscripts
-Wclobbered -Wcomment
-Wconversion -Wno-coverage-mismatch -Wno-cpp
-Wdangling-else -Wdangling-pointer -Wdangling-pointer=n
-Wdate-time
-Wno-deprecated -Wno-deprecated-declarations -Wno-designated-init
-Wdisabled-optimization
-Wno-discarded-array-qualifiers -Wno-discarded-qualifiers
-Wno-div-by-zero -Wdouble-promotion
-Wduplicated-branches -Wduplicated-cond
-Wempty-body -Wno-endif-labels -Wenum-compare -Wenum-conversion
-Wenum-int-mismatch
-Werror -Werror=* -Wexpansion-to-defined -Wfatal-errors
-Wfloat-conversion -Wfloat-equal -Wformat -Wformat=2
-Wno-format-contains-nul -Wno-format-extra-args
-Wformat-nonliteral -Wformat-overflow=n
-Wformat-security -Wformat-signedness -Wformat-truncation=n
-Wformat-y2k -Wframe-address
Chapter 3: GCC Command Options 15
-Wframe-larger-than=byte-size -Wno-free-nonheap-object
-Wno-if-not-aligned -Wno-ignored-attributes
-Wignored-qualifiers -Wno-incompatible-pointer-types
-Wimplicit -Wimplicit-fallthrough -Wimplicit-fallthrough=n
-Wno-implicit-function-declaration -Wno-implicit-int
-Winfinite-recursion
-Winit-self -Winline -Wno-int-conversion -Wint-in-bool-context
-Wno-int-to-pointer-cast -Wno-invalid-memory-model
-Winvalid-pch -Wjump-misses-init -Wlarger-than=byte-size
-Wlogical-not-parentheses -Wlogical-op -Wlong-long
-Wno-lto-type-mismatch -Wmain -Wmaybe-uninitialized
-Wmemset-elt-size -Wmemset-transposed-args
-Wmisleading-indentation -Wmissing-attributes -Wmissing-braces
-Wmissing-field-initializers -Wmissing-format-attribute
-Wmissing-include-dirs -Wmissing-noreturn -Wno-missing-profile
-Wno-multichar -Wmultistatement-macros -Wnonnull -Wnonnull-compare
-Wnormalized=[none|id|nfc|nfkc]
-Wnull-dereference -Wno-odr
-Wopenacc-parallelism
-Wopenmp-simd
-Wno-overflow -Woverlength-strings -Wno-override-init-side-effects
-Wpacked -Wno-packed-bitfield-compat -Wpacked-not-aligned -Wpadded
-Wparentheses -Wno-pedantic-ms-format
-Wpointer-arith -Wno-pointer-compare -Wno-pointer-to-int-cast
-Wno-pragmas -Wno-prio-ctor-dtor -Wredundant-decls
-Wrestrict -Wno-return-local-addr -Wreturn-type
-Wno-scalar-storage-order -Wsequence-point
-Wshadow -Wshadow=global -Wshadow=local -Wshadow=compatible-local
-Wno-shadow-ivar
-Wno-shift-count-negative -Wno-shift-count-overflow -Wshift-negative-value
-Wno-shift-overflow -Wshift-overflow=n
-Wsign-compare -Wsign-conversion
-Wno-sizeof-array-argument
-Wsizeof-array-div
-Wsizeof-pointer-div -Wsizeof-pointer-memaccess
-Wstack-protector -Wstack-usage=byte-size -Wstrict-aliasing
-Wstrict-aliasing=n -Wstrict-overflow -Wstrict-overflow=n
-Wstring-compare
-Wno-stringop-overflow -Wno-stringop-overread
-Wno-stringop-truncation
-Wsuggest-attribute=[pure|const|noreturn|format|malloc]
-Wswitch -Wno-switch-bool -Wswitch-default -Wswitch-enum
-Wno-switch-outside-range -Wno-switch-unreachable -Wsync-nand
-Wsystem-headers -Wtautological-compare -Wtrampolines -Wtrigraphs
-Wtrivial-auto-var-init -Wtsan -Wtype-limits -Wundef
-Wuninitialized -Wunknown-pragmas
-Wunsuffixed-float-constants -Wunused
-Wunused-but-set-parameter -Wunused-but-set-variable
-Wunused-const-variable -Wunused-const-variable=n
-Wunused-function -Wunused-label -Wunused-local-typedefs
-Wunused-macros
-Wunused-parameter -Wno-unused-result
-Wunused-value -Wunused-variable
-Wno-varargs -Wvariadic-macros
-Wvector-operation-performance
-Wvla -Wvla-larger-than=byte-size -Wno-vla-larger-than
-Wvolatile-register-var -Wwrite-strings
-Wzero-length-bounds
16 Using the GNU Compiler Collection (GCC)
Debugging Options
See Section 3.10 [Options for Debugging Your Program], page 156.
-g -glevel -gdwarf -gdwarf-version
-gbtf -gctf -gctflevel
-ggdb -grecord-gcc-switches -gno-record-gcc-switches
-gstabs -gstabs+ -gstrict-dwarf -gno-strict-dwarf
-gas-loc-support -gno-as-loc-support
-gas-locview-support -gno-as-locview-support
-gcolumn-info -gno-column-info -gdwarf32 -gdwarf64
-gstatement-frontiers -gno-statement-frontiers
-gvariable-location-views -gno-variable-location-views
-ginternal-reset-location-views -gno-internal-reset-location-views
-ginline-points -gno-inline-points
-gvms -gxcoff -gxcoff+ -gz[=type]
-gsplit-dwarf -gdescribe-dies -gno-describe-dies
-fdebug-prefix-map=old=new -fdebug-types-section
-fno-eliminate-unused-debug-types
-femit-struct-debug-baseonly -femit-struct-debug-reduced
-femit-struct-debug-detailed[=spec-list]
-fno-eliminate-unused-debug-symbols -femit-class-debug-always
-fno-merge-debug-strings -fno-dwarf2-cfi-asm
-fvar-tracking -fvar-tracking-assignments
Optimization Options
See Section 3.11 [Options that Control Optimization], page 163.
-faggressive-loop-optimizations
-falign-functions[=n[:m:[n2[:m2]]]]
-falign-jumps[=n[:m:[n2[:m2]]]]
-falign-labels[=n[:m:[n2[:m2]]]]
-falign-loops[=n[:m:[n2[:m2]]]]
-fno-allocation-dce -fallow-store-data-races
-fassociative-math -fauto-profile -fauto-profile[=path]
-fauto-inc-dec -fbranch-probabilities
-fcaller-saves
-fcombine-stack-adjustments -fconserve-stack
-fcompare-elim -fcprop-registers -fcrossjumping
-fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules
-fcx-limited-range
-fdata-sections -fdce -fdelayed-branch
-fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively
-fdevirtualize-at-ltrans -fdse
-fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects
-ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=style
-ffinite-loops
-fforward-propagate -ffp-contract=style -ffunction-sections
-fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity
-fgcse-sm -fhoist-adjacent-loads -fif-conversion
-fif-conversion2 -findirect-inlining
-finline-functions -finline-functions-called-once -finline-limit=n
-finline-small-functions -fipa-modref -fipa-cp -fipa-cp-clone
-fipa-bit-cp -fipa-vrp -fipa-pta -fipa-profile -fipa-pure-const
18 Using the GNU Compiler Collection (GCC)
-fipa-reference -fipa-reference-addressable
-fipa-stack-alignment -fipa-icf -fira-algorithm=algorithm
-flive-patching=level
-fira-region=region -fira-hoist-pressure
-fira-loop-pressure -fno-ira-share-save-slots
-fno-ira-share-spill-slots
-fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute
-fivopts -fkeep-inline-functions -fkeep-static-functions
-fkeep-static-consts -flimit-function-alignment -flive-range-shrinkage
-floop-block -floop-interchange -floop-strip-mine
-floop-unroll-and-jam -floop-nest-optimize
-floop-parallelize-all -flra-remat -flto -flto-compression-level
-flto-partition=alg -fmerge-all-constants
-fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves
-fmove-loop-invariants -fmove-loop-stores -fno-branch-count-reg
-fno-defer-pop -fno-fp-int-builtin-inexact -fno-function-cse
-fno-guess-branch-probability -fno-inline -fno-math-errno -fno-peephole
-fno-peephole2 -fno-printf-return-value -fno-sched-interblock
-fno-sched-spec -fno-signed-zeros
-fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss
-fomit-frame-pointer -foptimize-sibling-calls
-fpartial-inlining -fpeel-loops -fpredictive-commoning
-fprefetch-loop-arrays
-fprofile-correction
-fprofile-use -fprofile-use=path -fprofile-partial-training
-fprofile-values -fprofile-reorder-functions
-freciprocal-math -free -frename-registers -freorder-blocks
-freorder-blocks-algorithm=algorithm
-freorder-blocks-and-partition -freorder-functions
-frerun-cse-after-loop -freschedule-modulo-scheduled-loops
-frounding-math -fsave-optimization-record
-fsched2-use-superblocks -fsched-pressure
-fsched-spec-load -fsched-spec-load-dangerous
-fsched-stalled-insns-dep[=n] -fsched-stalled-insns[=n]
-fsched-group-heuristic -fsched-critical-path-heuristic
-fsched-spec-insn-heuristic -fsched-rank-heuristic
-fsched-last-insn-heuristic -fsched-dep-count-heuristic
-fschedule-fusion
-fschedule-insns -fschedule-insns2 -fsection-anchors
-fselective-scheduling -fselective-scheduling2
-fsel-sched-pipelining -fsel-sched-pipelining-outer-loops
-fsemantic-interposition -fshrink-wrap -fshrink-wrap-separate
-fsignaling-nans
-fsingle-precision-constant -fsplit-ivs-in-unroller -fsplit-loops
-fsplit-paths
-fsplit-wide-types -fsplit-wide-types-early -fssa-backprop -fssa-phiopt
-fstdarg-opt -fstore-merging -fstrict-aliasing -fipa-strict-aliasing
-fthread-jumps -ftracer -ftree-bit-ccp
-ftree-builtin-call-dce -ftree-ccp -ftree-ch
-ftree-coalesce-vars -ftree-copy-prop -ftree-dce -ftree-dominator-opts
-ftree-dse -ftree-forwprop -ftree-fre -fcode-hoisting
-ftree-loop-if-convert -ftree-loop-im
-ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns
-ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize
-ftree-loop-vectorize
-ftree-parallelize-loops=n -ftree-pre -ftree-partial-pre -ftree-pta
-ftree-reassoc -ftree-scev-cprop -ftree-sink -ftree-slsr -ftree-sra
-ftree-switch-conversion -ftree-tail-merge
Chapter 3: GCC Command Options 19
-fprofile-prefix-map=old=new
Preprocessor Options
See Section 3.13 [Options Controlling the Preprocessor], page 254.
-Aquestion=answer
-A-question[=answer]
-C -CC -Dmacro[=defn]
-dD -dI -dM -dN -dU
-fdebug-cpp -fdirectives-only -fdollars-in-identifiers
-fexec-charset=charset -fextended-identifiers
-finput-charset=charset -flarge-source-files
-fmacro-prefix-map=old=new -fmax-include-depth=depth
-fno-canonical-system-headers -fpch-deps -fpch-preprocess
-fpreprocessed -ftabstop=width -ftrack-macro-expansion
-fwide-exec-charset=charset -fworking-directory
-H -imacros file -include file
-M -MD -MF -MG -MM -MMD -MP -MQ -MT -Mno-modules
-no-integrated-cpp -P -pthread -remap
-traditional -traditional-cpp -trigraphs
-Umacro -undef
-Wp,option -Xpreprocessor option
Assembler Options
See Section 3.14 [Passing Options to the Assembler], page 261.
20 Using the GNU Compiler Collection (GCC)
Linker Options
See Section 3.15 [Options for Linking], page 262.
object-file-name -fuse-ld=linker -llibrary
-nostartfiles -nodefaultlibs -nolibc -nostdlib -nostdlib++
-e entry --entry=entry
-pie -pthread -r -rdynamic
-s -static -static-pie -static-libgcc -static-libstdc++
-static-libasan -static-libtsan -static-liblsan -static-libubsan
-shared -shared-libgcc -symbolic
-T script -Wl,option -Xlinker option
-u symbol -z keyword
Directory Options
See Section 3.16 [Options for Directory Search], page 267.
-Bprefix -Idir -I-
-idirafter dir
-imacros file -imultilib dir
-iplugindir=dir -iprefix file
-iquote dir -isysroot dir -isystem dir
-iwithprefix dir -iwithprefixbefore dir
-Ldir -no-canonical-prefixes --no-sysroot-suffix
-nostdinc -nostdinc++ --sysroot=dir
Developer Options
See Section 3.18 [GCC Developer Options], page 281.
-dletters -dumpspecs -dumpmachine -dumpversion
-dumpfullversion -fcallgraph-info[=su,da] -fchecking -fchecking=n -fdbg-cnt-
list
-fdbg-cnt=counter-value-list
-fdisable-ipa-pass_name
-fdisable-rtl-pass_name
-fdisable-rtl-pass-name=range-list
-fdisable-tree-pass_name
-fdisable-tree-pass-name=range-list
-fdump-debug -fdump-earlydebug
-fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links
Chapter 3: GCC Command Options 21
-fdump-final-insns[=file]
-fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline
-fdump-lang-all
-fdump-lang-switch
-fdump-lang-switch-options
-fdump-lang-switch-options=filename
-fdump-passes
-fdump-rtl-pass -fdump-rtl-pass=filename
-fdump-statistics
-fdump-tree-all
-fdump-tree-switch
-fdump-tree-switch-options
-fdump-tree-switch-options=filename
-fcompare-debug[=opts] -fcompare-debug-second
-fenable-kind-pass
-fenable-kind-pass=range-list
-fira-verbose=n
-flto-report -flto-report-wpa -fmem-report-wpa
-fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report
-fopt-info -fopt-info-options[=file]
-fprofile-report
-frandom-seed=string -fsched-verbose=n
-fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose
-fstats -fstack-usage -ftime-report -ftime-report-details
-fvar-tracking-assignments-toggle -gtoggle
-print-file-name=library -print-libgcc-file-name
-print-multi-directory -print-multi-lib -print-multi-os-directory
-print-prog-name=program -print-search-dirs -Q
-print-sysroot -print-sysroot-headers-suffix
-save-temps -save-temps=cwd -save-temps=obj -time[=file]
Machine-Dependent Options
See Section 3.19 [Machine-Dependent Options], page 297.
AArch64 Options
-mabi=name -mbig-endian -mlittle-endian
-mgeneral-regs-only
-mcmodel=tiny -mcmodel=small -mcmodel=large
-mstrict-align -mno-strict-align
-momit-leaf-frame-pointer
-mtls-dialect=desc -mtls-dialect=traditional
-mtls-size=size
-mfix-cortex-a53-835769 -mfix-cortex-a53-843419
-mlow-precision-recip-sqrt -mlow-precision-sqrt -mlow-precision-div
-mpc-relative-literal-loads
-msign-return-address=scope
-mbranch-protection=none|standard|pac-ret[+leaf +b-key]|bti
-mharden-sls=opts
-march=name -mcpu=name -mtune=name
-moverride=string -mverbose-cost-dump
-mstack-protector-guard=guard -mstack-protector-guard-reg=sysreg
-mstack-protector-guard-offset=offset -mtrack-speculation
-moutline-atomics
Adapteva Epiphany Options
-mhalf-reg-file -mprefer-short-insn-regs
-mbranch-cost=num -mcmove -mnops=num -msoft-cmpsf
-msplit-lohi -mpost-inc -mpost-modify -mstack-offset=num
-mround-nearest -mlong-calls -mshort-calls -msmall16
22 Using the GNU Compiler Collection (GCC)
-mverbose-cost-dump
-mpure-code
-mcmse
-mfix-cmse-cve-2021-35465
-mstack-protector-guard=guard -mstack-protector-guard-offset=offset
-mfdpic
AVR Options
-mmcu=mcu -mabsdata -maccumulate-args
-mbranch-cost=cost
-mcall-prologues -mgas-isr-prologues -mint8
-mdouble=bits -mlong-double=bits
-mn_flash=size -mno-interrupts
-mmain-is-OS_task -mrelax -mrmw -mstrict-X -mtiny-stack
-mfract-convert-truncate
-mshort-calls -nodevicelib -nodevicespecs
-Waddr-space-convert -Wmisspelled-isr
Blackfin Options
-mcpu=cpu[-sirevision]
-msim -momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer
-mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly
-mlow-64k -mno-low64k -mstack-check-l1 -mid-shared-library
-mno-id-shared-library -mshared-library-id=n
-mleaf-id-shared-library -mno-leaf-id-shared-library
-msep-data -mno-sep-data -mlong-calls -mno-long-calls
-mfast-fp -minline-plt -mmulticore -mcorea -mcoreb -msdram
-micplb
C6X Options
-mbig-endian -mlittle-endian -march=cpu
-msim -msdata=sdata-type
CRIS Options
-mcpu=cpu -march=cpu -mtune=cpu -mmax-stack-frame=n
-metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects
-mstack-align -mdata-align -mconst-align
-m32-bit -m16-bit -m8-bit -mno-prologue-epilogue
-melf -maout -sim -sim2
-mmul-bug-workaround -mno-mul-bug-workaround
CR16 Options
-mmac
-mcr16cplus -mcr16c
-msim -mint32 -mbit-ops -mdata-model=model
C-SKY Options
-march=arch -mcpu=cpu
-mbig-endian -EB -mlittle-endian -EL
-mhard-float -msoft-float -mfpu=fpu -mdouble-float -mfdivdu
-mfloat-abi=name
-melrw -mistack -mmp -mcp -mcache -msecurity -mtrust
-mdsp -medsp -mvdsp
-mdiv -msmart -mhigh-registers -manchor
-mpushpop -mmultiple-stld -mconstpool -mstack-size -mccrt
-mbranch-cost=n -mcse-cc -msched-prolog -msim
Darwin Options
-all_load -allowable_client -arch -arch_errors_fatal
-arch_only -bind_at_load -bundle -bundle_loader
24 Using the GNU Compiler Collection (GCC)
-mno-nested-cond-exec -mtomcat-stats
-mTLS -mtls
-mcpu=cpu
GNU/Linux Options
-mglibc -muclibc -mmusl -mbionic -mandroid
-tno-android-cc -tno-android-ld
H8/300 Options
-mrelax -mh -ms -mn -mexr -mno-exr -mint32 -malign-300
HPPA Options
-march=architecture-type
-mcaller-copies -mdisable-fpregs -mdisable-indexing
-mfast-indirect-calls -mgas -mgnu-ld -mhp-ld
-mfixed-range=register-range
-mjump-in-delay -mlinker-opt -mlong-calls
-mlong-load-store -mno-disable-fpregs
-mno-disable-indexing -mno-fast-indirect-calls -mno-gas
-mno-jump-in-delay -mno-long-load-store
-mno-portable-runtime -mno-soft-float
-mno-space-regs -msoft-float -mpa-risc-1-0
-mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime
-mschedule=cpu-type -mspace-regs -msio -mwsio
-munix=unix-std -nolibdld -static -threads
IA-64 Options
-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic
-mvolatile-asm-stop -mregister-names -msdata -mno-sdata
-mconstant-gp -mauto-pic -mfused-madd
-minline-float-divide-min-latency
-minline-float-divide-max-throughput
-mno-inline-float-divide
-minline-int-divide-min-latency
-minline-int-divide-max-throughput
-mno-inline-int-divide
-minline-sqrt-min-latency -minline-sqrt-max-throughput
-mno-inline-sqrt
-mdwarf2-asm -mearly-stop-bits
-mfixed-range=register-range -mtls-size=tls-size
-mtune=cpu-type -milp32 -mlp64
-msched-br-data-spec -msched-ar-data-spec -msched-control-spec
-msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec
-msched-spec-ldc -msched-spec-control-ldc
-msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns
-msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path
-msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost
-msched-max-memory-insns-hard-limit -msched-max-memory-insns=max-insns
LM32 Options
-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled
-msign-extend-enabled -muser-enabled
LoongArch Options
-march=cpu-type -mtune=cpu-type -mabi=base-abi-type
-mfpu=fpu-type -msoft-float -msingle-float -mdouble-float
-mbranch-cost=n -mcheck-zero-division -mno-check-zero-division
-mcond-move-int -mno-cond-move-int
-mcond-move-float -mno-cond-move-float
-memcpy -mno-memcpy -mstrict-align -mno-strict-align
26 Using the GNU Compiler Collection (GCC)
-mmax-inline-memcpy-size=n
-mcmodel=code-model
M32R/D Options
-m32r2 -m32rx -m32r
-mdebug
-malign-loops -mno-align-loops
-missue-rate=number
-mbranch-cost=number
-mmodel=code-size-model-type
-msdata=sdata-type
-mno-flush-func -mflush-func=name
-mno-flush-trap -mflush-trap=number
-G num
M32C Options
-mcpu=cpu -msim -memregs=number
M680x0 Options
-march=arch -mcpu=cpu -mtune=tune
-m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040
-m68060 -mcpu32 -m5200 -m5206e -m528x -m5307 -m5407
-mcfv4e -mbitfield -mno-bitfield -mc68000 -mc68020
-mnobitfield -mrtd -mno-rtd -mdiv -mno-div -mshort
-mno-short -mhard-float -m68881 -msoft-float -mpcrel
-malign-int -mstrict-align -msep-data -mno-sep-data
-mshared-library-id=n -mid-shared-library -mno-id-shared-library
-mxgot -mno-xgot -mlong-jump-table-offsets
MCore Options
-mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates
-mno-relax-immediates -mwide-bitfields -mno-wide-bitfields
-m4byte-functions -mno-4byte-functions -mcallgraph-data
-mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim
-mlittle-endian -mbig-endian -m210 -m340 -mstack-increment
MeP Options
-mabsdiff -mall-opts -maverage -mbased=n -mbitops
-mc=n -mclip -mconfig=name -mcop -mcop32 -mcop64 -mivc2
-mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax
-mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf
-mtiny=n
MicroBlaze Options
-msoft-float -mhard-float -msmall-divides -mcpu=cpu
-mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift
-mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss
-mxl-multiply-high -mxl-float-convert -mxl-float-sqrt
-mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-app-model
-mpic-data-is-text-relative
MIPS Options
-EL -EB -march=arch -mtune=arch
-mips1 -mips2 -mips3 -mips4 -mips32 -mips32r2 -mips32r3 -mips32r5
-mips32r6 -mips64 -mips64r2 -mips64r3 -mips64r5 -mips64r6
-mips16 -mno-mips16 -mflip-mips16
-minterlink-compressed -mno-interlink-compressed
-minterlink-mips16 -mno-interlink-mips16
-mabi=abi -mabicalls -mno-abicalls
-mshared -mno-shared -mplt -mno-plt -mxgot -mno-xgot
Chapter 3: GCC Command Options 27
-mreturn-pointer-on-d0
-mno-crt0 -mrelax -mliw -msetlb
Moxie Options
-meb -mel -mmul.x -mno-crt0
MSP430 Options
-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax
-mwarn-mcu
-mcode-region= -mdata-region=
-msilicon-errata= -msilicon-errata-warn=
-mhwmult= -minrt -mtiny-printf -mmax-inline-shift=
NDS32 Options
-mbig-endian -mlittle-endian
-mreduced-regs -mfull-regs
-mcmov -mno-cmov
-mext-perf -mno-ext-perf
-mext-perf2 -mno-ext-perf2
-mext-string -mno-ext-string
-mv3push -mno-v3push
-m16bit -mno-16bit
-misr-vector-size=num
-mcache-block-size=num
-march=arch
-mcmodel=code-model
-mctor-dtor -mrelax
Nios II Options
-G num -mgpopt=option -mgpopt -mno-gpopt
-mgprel-sec=regexp -mr0rel-sec=regexp
-mel -meb
-mno-bypass-cache -mbypass-cache
-mno-cache-volatile -mcache-volatile
-mno-fast-sw-div -mfast-sw-div
-mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div
-mcustom-insn=N -mno-custom-insn
-mcustom-fpu-cfg=name
-mhal -msmallc -msys-crt0=name -msys-lib=name
-march=arch -mbmx -mno-bmx -mcdx -mno-cdx
Nvidia PTX Options
-m64 -mmainkernel -moptimize
OpenRISC Options
-mboard=name -mnewlib -mhard-mul -mhard-div
-msoft-mul -msoft-div
-msoft-float -mhard-float -mdouble-float -munordered-float
-mcmov -mror -mrori -msext -msfimm -mshftimm
-mcmodel=code-model
PDP-11 Options
-mfpu -msoft-float -mac0 -mno-ac0 -m40 -m45 -m10
-mint32 -mno-int16 -mint16 -mno-int32
-msplit -munix-asm -mdec-asm -mgnu-asm -mlra
picoChip Options
-mae=ae_type -mvliw-lookahead=N
-msymbol-as-address -mno-inefficient-warnings
PowerPC Options See RS/6000 and PowerPC Options.
Chapter 3: GCC Command Options 29
PRU Options
-mmcu=mcu -minrt -mno-relax -mloop
-mabi=variant
RISC-V Options
-mbranch-cost=N-instruction
-mplt -mno-plt
-mabi=ABI-string
-mfdiv -mno-fdiv
-mdiv -mno-div
-misa-spec=ISA-spec-string
-march=ISA-string
-mtune=processor-string
-mpreferred-stack-boundary=num
-msmall-data-limit=N-bytes
-msave-restore -mno-save-restore
-mshorten-memrefs -mno-shorten-memrefs
-mstrict-align -mno-strict-align
-mcmodel=medlow -mcmodel=medany
-mexplicit-relocs -mno-explicit-relocs
-mrelax -mno-relax
-mriscv-attribute -mmo-riscv-attribute
-malign-data=type
-mbig-endian -mlittle-endian
-mstack-protector-guard=guard -mstack-protector-guard-reg=reg
-mstack-protector-guard-offset=offset
RL78 Options
-msim -mmul=none -mmul=g13 -mmul=g14 -mallregs
-mcpu=g10 -mcpu=g13 -mcpu=g14 -mg10 -mg13 -mg14
-m64bit-doubles -m32bit-doubles -msave-mduc-in-interrupts
RS/6000 and PowerPC Options
-mcpu=cpu-type
-mtune=cpu-type
-mcmodel=code-model
-mpowerpc64
-maltivec -mno-altivec
-mpowerpc-gpopt -mno-powerpc-gpopt
-mpowerpc-gfxopt -mno-powerpc-gfxopt
-mmfcrf -mno-mfcrf -mpopcntb -mno-popcntb -mpopcntd -mno-popcntd
-mfprnd -mno-fprnd
-mcmpb -mno-cmpb -mhard-dfp -mno-hard-dfp
-mfull-toc -mminimal-toc -mno-fp-in-toc -mno-sum-in-toc
-m64 -m32 -mxl-compat -mno-xl-compat -mpe
-malign-power -malign-natural
-msoft-float -mhard-float -mmultiple -mno-multiple
-mupdate -mno-update
-mavoid-indexed-addresses -mno-avoid-indexed-addresses
-mfused-madd -mno-fused-madd -mbit-align -mno-bit-align
-mstrict-align -mno-strict-align -mrelocatable
-mno-relocatable -mrelocatable-lib -mno-relocatable-lib
-mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian
-mdynamic-no-pic -mswdiv -msingle-pic-base
-mprioritize-restricted-insns=priority
-msched-costly-dep=dependence_type
-minsert-sched-nops=scheme
-mcall-aixdesc -mcall-eabi -mcall-freebsd
30 Using the GNU Compiler Collection (GCC)
-minline-stringops-dynamically -mstringop-strategy=alg
-mkl -mwidekl
-mmemcpy-strategy=strategy -mmemset-strategy=strategy
-mpush-args -maccumulate-outgoing-args -m128bit-long-double
-m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128
-mregparm=num -msseregparm
-mveclibabi=type -mvect8-ret-in-mem
-mpc32 -mpc64 -mpc80 -mstackrealign
-momit-leaf-frame-pointer -mno-red-zone -mno-tls-direct-seg-refs
-mcmodel=code-model -mabi=name -maddress-mode=mode
-m32 -m64 -mx32 -m16 -miamcu -mlarge-data-threshold=num
-msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv
-minstrument-return=type -mfentry-name=name -mfentry-section=name
-mavx256-split-unaligned-load -mavx256-split-unaligned-store
-malign-data=type -mstack-protector-guard=guard
-mstack-protector-guard-reg=reg
-mstack-protector-guard-offset=offset
-mstack-protector-guard-symbol=symbol
-mgeneral-regs-only -mcall-ms2sysv-xlogues -mrelax-cmpxchg-loop
-mindirect-branch=choice -mfunction-return=choice
-mindirect-branch-register -mharden-sls=choice
-mindirect-branch-cs-prefix -mneeded -mno-direct-extern-access
x86 Windows Options
-mconsole -mcygwin -mno-cygwin -mdll
-mnop-fun-dllimport -mthread
-municode -mwin32 -mwindows -fno-set-stack-executable
Xstormy16 Options
-msim
Xtensa Options
-mconst16 -mno-const16
-mfused-madd -mno-fused-madd
-mforce-no-pic
-mserialize-volatile -mno-serialize-volatile
-mtext-section-literals -mno-text-section-literals
-mauto-litpools -mno-auto-litpools
-mtarget-align -mno-target-align
-mlongcalls -mno-longcalls
-mabi=abi-type
-mextra-l32r-costs=cycles
zSeries Options See S/390 and zSeries Options.
file.m Objective-C source code. Note that you must link with the ‘libobjc’ library
to make an Objective-C program work.
file.mi Objective-C source code that should not be preprocessed.
file.mm
file.M Objective-C++ source code. Note that you must link with the ‘libobjc’ library
to make an Objective-C++ program work. Note that ‘.M’ refers to a literal
capital M.
file.mii Objective-C++ source code that should not be preprocessed.
file.h C, C++, Objective-C or Objective-C++ header file to be turned into a precom-
piled header (default), or C, C++ header file to be turned into an Ada spec (via
the ‘-fdump-ada-spec’ switch).
file.cc
file.cp
file.cxx
file.cpp
file.CPP
file.c++
file.C C++ source code that must be preprocessed. Note that in ‘.cxx’, the last two
letters must both be literally ‘x’. Likewise, ‘.C’ refers to a literal capital C.
file.mm
file.M Objective-C++ source code that must be preprocessed.
file.mii Objective-C++ source code that should not be preprocessed.
file.hh
file.H
file.hp
file.hxx
file.hpp
file.HPP
file.h++
file.tcc C++ header file to be turned into a precompiled header or Ada spec.
file.f
file.for
file.ftn Fixed form Fortran source code that should not be preprocessed.
file.F
file.FOR
file.fpp
file.FPP
file.FTN Fixed form Fortran source code that must be preprocessed (with the traditional
preprocessor).
file.f90
file.f95
file.f03
file.f08 Free form Fortran source code that should not be preprocessed.
Chapter 3: GCC Command Options 35
file.F90
file.F95
file.F03
file.F08 Free form Fortran source code that must be preprocessed (with the traditional
preprocessor).
file.go Go source code.
file.d D source code.
file.di D interface file.
file.dd D documentation code (Ddoc).
file.ads Ada source code file that contains a library unit declaration (a declaration of a
package, subprogram, or generic, or a generic instantiation), or a library unit
renaming declaration (a package, generic, or subprogram renaming declaration).
Such files are also called specs.
file.adb Ada source code file containing a library unit body (a subprogram or package
body). Such files are also called bodies.
file.s Assembler code.
file.S
file.sx Assembler code that must be preprocessed.
other An object file to be fed straight into linking. Any file name with no recognized
suffix is treated this way.
You can specify the input language explicitly with the ‘-x’ option:
-x language
Specify explicitly the language for the following input files (rather than letting
the compiler choose a default based on the file name suffix). This option applies
to all following input files until the next ‘-x’ option. Possible values for language
are:
c c-header cpp-output
c++ c++-header c++-system-header c++-user-header c++-cpp-output
objective-c objective-c-header objective-c-cpp-output
objective-c++ objective-c++-header objective-c++-cpp-output
assembler assembler-with-cpp
ada
d
f77 f77-cpp-input f95 f95-cpp-input
go
-x none Turn off any specification of a language, so that subsequent files are handled
according to their file name suffixes (as they are if ‘-x’ has not been used at
all).
If you only want some of the stages of compilation, you can use ‘-x’ (or filename suffixes)
to tell gcc where to start, and one of the options ‘-c’, ‘-S’, or ‘-E’ to say where gcc is to
stop. Note that some combinations (for example, ‘-x cpp-output -E’) instruct gcc to do
nothing at all.
36 Using the GNU Compiler Collection (GCC)
-c Compile or assemble the source files, but do not link. The linking stage simply
is not done. The ultimate output is in the form of an object file for each source
file.
By default, the object file name for a source file is made by replacing the suffix
‘.c’, ‘.i’, ‘.s’, etc., with ‘.o’.
Unrecognized input files, not requiring compilation or assembly, are ignored.
-S Stop after the stage of compilation proper; do not assemble. The output is in
the form of an assembler code file for each non-assembler input file specified.
By default, the assembler file name for a source file is made by replacing the
suffix ‘.c’, ‘.i’, etc., with ‘.s’.
Input files that don’t require compilation are ignored.
-E Stop after the preprocessing stage; do not run the compiler proper. The output
is in the form of preprocessed source code, which is sent to the standard output.
Input files that don’t require preprocessing are ignored.
-o file Place the primary output in file file. This applies to whatever sort of output is
being produced, whether it be an executable file, an object file, an assembler
file or preprocessed C code.
If ‘-o’ is not specified, the default is to put an executable file in ‘a.out’, the
object file for ‘source.suffix’ in ‘source.o’, its assembler file in ‘source.s’, a
precompiled header file in ‘source.suffix.gch’, and all preprocessed C source
on standard output.
Though ‘-o’ names only the primary output, it also affects the naming of aux-
iliary and dump outputs. See the examples below. Unless overridden, both
auxiliary outputs and dump outputs are placed in the same directory as the
primary output. In auxiliary outputs, the suffix of the input file is replaced
with that of the auxiliary output file type; in dump outputs, the suffix of the
dump file is appended to the input file suffix. In compilation commands, the
base name of both auxiliary and dump outputs is that of the primary output;
in compile and link commands, the primary output name, minus the executable
suffix, is combined with the input file name. If both share the same base name,
disregarding the suffix, the result of the combination is that base name, other-
wise, they are concatenated, separated by a dash.
gcc -c foo.c ...
will use ‘foo.o’ as the primary output, and place aux outputs and dumps
next to it, e.g., aux file ‘foo.dwo’ for ‘-gsplit-dwarf’, and dump file
‘foo.c.???r.final’ for ‘-fdump-rtl-final’.
If a non-linker output file is explicitly specified, aux and dump files by default
take the same base name:
gcc -c foo.c -o dir/foobar.o ...
will name aux outputs ‘dir/foobar.*’ and dump outputs ‘dir/foobar.c.*’.
A linker output will instead prefix aux and dump outputs:
gcc foo.c bar.c -o dir/foobar ...
Chapter 3: GCC Command Options 37
An empty string specified as dumpbase avoids the influence of the output base-
name in the naming of auxiliary and dump outputs during compilation, com-
puting default values :
gcc -c foo.c -o dir/foobar.o -dumpbase ’’ ...
will name aux outputs ‘dir/foo.*’ and dump outputs ‘dir/foo.c.*’. Note
how their basenames are taken from the input name, but the directory still
defaults to that of the output.
The empty-string dumpbase does not prevent the use of the output basename
for outputs during linking:
gcc foo.c bar.c -o dir/foobar -dumpbase ’’ -flto ...
The compilation of the source files will name auxiliary outputs ‘dir/foo.*’
and ‘dir/bar.*’, and dump outputs ‘dir/foo.c.*’ and ‘dir/bar.c.*’. LTO
recompilation during linking will use ‘dir/foobar.’ as the prefix for dumps
and auxiliary files.
-dumpbase-ext auxdropsuf
When forming the name of an auxiliary (but not a dump) output file, drop trail-
ing auxdropsuf from dumpbase before appending any suffixes. If not specified,
this option defaults to the suffix of a default dumpbase, i.e., the suffix of the
input file when ‘-dumpbase’ is not present in the command line, or dumpbase
is combined with dumppfx.
gcc foo.c -c -o dir/foo.o -dumpbase x-foo.c -dumpbase-ext .c ...
creates ‘dir/foo.o’ as the main output, and generates auxiliary outputs in
‘dir/x-foo.*’, taking the location of the primary output, and dropping the ‘.c’
suffix from the dumpbase. Dump outputs retain the suffix: ‘dir/x-foo.c.*’.
This option is disregarded if it does not match the suffix of a specified dumpbase,
except as an alternative to the executable suffix when appending the linker
output base name to dumppfx, as specified below:
gcc foo.c bar.c -o main.out -dumpbase-ext .out ...
creates ‘main.out’ as the primary output, and avoids overwriting the auxiliary
and dump outputs by using the executable name minus auxdropsuf as a prefix,
creating auxiliary outputs named ‘main-foo.*’ and ‘main-bar.*’ and dump
outputs named ‘main-foo.c.*’ and ‘main-bar.c.*’.
-dumpdir dumppfx
When forming the name of an auxiliary or dump output file, use dumppfx as a
prefix:
gcc -dumpdir pfx- -c foo.c ...
creates ‘foo.o’ as the primary output, and auxiliary outputs named
‘pfx-foo.*’, combining the given dumppfx with the default dumpbase derived
from the default primary output, derived in turn from the input name. Dump
outputs also take the input name suffix: ‘pfx-foo.c.*’.
If dumppfx is to be used as a directory name, it must end with a directory
separator:
gcc -dumpdir dir/ -c foo.c -o obj/bar.o ...
creates ‘obj/bar.o’ as the primary output, and auxiliary outputs named
‘dir/bar.*’, combining the given dumppfx with the default dumpbase derived
Chapter 3: GCC Command Options 39
from the primary output name. Dump outputs also take the input name
suffix: ‘dir/bar.c.*’.
It defaults to the location of the output file, unless the output file is a special file
like /dev/null. Options ‘-save-temps=cwd’ and ‘-save-temps=obj’ override
this default, just like an explicit ‘-dumpdir’ option. In case multiple such
options are given, the last one prevails:
gcc -dumpdir pfx- -c foo.c -save-temps=obj ...
outputs ‘foo.o’, with auxiliary outputs named ‘foo.*’ because
‘-save-temps=*’ overrides the dumppfx given by the earlier ‘-dumpdir’
option. It does not matter that ‘=obj’ is the default for ‘-save-temps’, nor
that the output directory is implicitly the current directory. Dump outputs
are named ‘foo.c.*’.
When compiling from multiple input files, if ‘-dumpbase’ is specified, dumpbase,
minus a auxdropsuf suffix, and a dash are appended to (or override, if contain-
ing any directory components) an explicit or defaulted dumppfx, so that each
of the multiple compilations gets differently-named aux and dump outputs.
gcc foo.c bar.c -c -dumpdir dir/pfx- -dumpbase main ...
outputs auxiliary dumps to ‘dir/pfx-main-foo.*’ and ‘dir/pfx-main-bar.*’,
appending dumpbase- to dumppfx. Dump outputs retain the input file suffix:
‘dir/pfx-main-foo.c.*’ and ‘dir/pfx-main-bar.c.*’, respectively. Contrast
with the single-input compilation:
gcc foo.c -c -dumpdir dir/pfx- -dumpbase main ...
that, applying ‘-dumpbase’ to a single source, does not compute and append
a separate dumpbase per input file. Its auxiliary and dump outputs go in
‘dir/pfx-main.*’.
When compiling and then linking from multiple input files, a defaulted or ex-
plicitly specified dumppfx also undergoes the dumpbase- transformation above
(e.g. the compilation of ‘foo.c’ and ‘bar.c’ above, but without ‘-c’). If nei-
ther ‘-dumpdir’ nor ‘-dumpbase’ are given, the linker output base name, minus
auxdropsuf, if specified, or the executable suffix otherwise, plus a dash is ap-
pended to the default dumppfx instead. Note, however, that unlike earlier cases
of linking:
gcc foo.c bar.c -dumpdir dir/pfx- -o main ...
does not append the output name ‘main’ to dumppfx, because ‘-dumpdir’ is ex-
plicitly specified. The goal is that the explicitly-specified dumppfx may contain
the specified output name as part of the prefix, if desired; only an explicitly-
specified ‘-dumpbase’ would be combined with it, in order to avoid simply
discarding a meaningful option.
When compiling and then linking from a single input file, the linker output
base name will only be appended to the default dumppfx as above if it does
not share the base name with the single input file name. This has been covered
in single-input linking cases above, but not with an explicit ‘-dumpdir’ that
inhibits the combination, even if overridden by ‘-save-temps=*’:
gcc foo.c -dumpdir alt/pfx- -o dir/main.exe -save-temps=cwd ...
40 Using the GNU Compiler Collection (GCC)
Auxiliary outputs are named ‘foo.*’, and dump outputs ‘foo.c.*’, in the
current working directory as ultimately requested by ‘-save-temps=cwd’.
Summing it all up for an intuitive though slightly imprecise data flow:
the primary output name is broken into a directory part and a basename
part; dumppfx is set to the former, unless overridden by ‘-dumpdir’ or
‘-save-temps=*’, and dumpbase is set to the latter, unless overriden by
‘-dumpbase’. If there are multiple inputs or linking, this dumpbase may be
combined with dumppfx and taken from each input file. Auxiliary output
names for each input are formed by combining dumppfx, dumpbase minus
suffix, and the auxiliary output suffix; dump output names are only different
in that the suffix from dumpbase is retained.
When it comes to auxiliary and dump outputs created during LTO recompi-
lation, a combination of dumppfx and dumpbase, as given or as derived from
the linker output name but not from inputs, even in cases in which this com-
bination would not otherwise be used as such, is passed down with a trailing
period replacing the compiler-added dash, if any, as a ‘-dumpdir’ option to
lto-wrapper; being involved in linking, this program does not normally get
any ‘-dumpbase’ and ‘-dumpbase-ext’, and it ignores them.
When running sub-compilers, lto-wrapper appends LTO stage names to the
received dumppfx, ensures it contains a directory component so that it overrides
any ‘-dumpdir’, and passes that as ‘-dumpbase’ to sub-compilers.
-v Print (on standard error output) the commands executed to run the stages of
compilation. Also print the version number of the compiler driver program and
of the preprocessor and the compiler proper.
-### Like ‘-v’ except the commands are not executed and arguments are quoted
unless they contain only alphanumeric characters or ./-_. This is useful for
shell scripts to capture the driver-generated command lines.
--help Print (on the standard output) a description of the command-line options under-
stood by gcc. If the ‘-v’ option is also specified then ‘--help’ is also passed on
to the various processes invoked by gcc, so that they can display the command-
line options they accept. If the ‘-Wextra’ option has also been specified (prior to
the ‘--help’ option), then command-line options that have no documentation
associated with them are also displayed.
--target-help
Print (on the standard output) a description of target-specific command-line
options for each tool. For some targets extra target-specific information may
also be printed.
--help={class|[^]qualifier}[,...]
Print (on the standard output) a description of the command-line options un-
derstood by the compiler that fit into all specified classes and qualifiers. These
are the supported classes:
‘optimizers’
Display all of the optimization options supported by the compiler.
Chapter 3: GCC Command Options 41
‘warnings’
Display all of the options controlling warning messages produced
by the compiler.
‘target’ Display target-specific options. Unlike the ‘--target-help’ option
however, target-specific options of the linker and assembler are not
displayed. This is because those tools do not currently support the
extended ‘--help=’ syntax.
‘params’ Display the values recognized by the ‘--param’ option.
language Display the options supported for language, where language is the
name of one of the languages supported in this version of GCC. If
an option is supported by all languages, one needs to select ‘common’
class.
‘common’ Display the options that are common to all languages.
These are the supported qualifiers:
‘undocumented’
Display only those options that are undocumented.
‘joined’ Display options taking an argument that appears after an equal sign
in the same continuous piece of text, such as: ‘--help=target’.
‘separate’
Display options taking an argument that appears as a separate word
following the original option, such as: ‘-o output-file’.
Thus for example to display all the undocumented target-specific switches sup-
ported by the compiler, use:
--help=target,undocumented
The sense of a qualifier can be inverted by prefixing it with the ‘^’ character,
so for example to display all binary warning options (i.e., ones that are either
on or off and that do not take an argument) that have a description, use:
--help=warnings,^joined,^undocumented
The argument to ‘--help=’ should not consist solely of inverted qualifiers.
Combining several classes is possible, although this usually restricts the output
so much that there is nothing to display. One case where it does work, however,
is when one of the classes is target. For example, to display all the target-specific
optimization options, use:
--help=target,optimizers
The ‘--help=’ option can be repeated on the command line. Each successive
use displays its requested class of options, skipping those that have already been
displayed. If ‘--help’ is also specified anywhere on the command line then this
takes precedence over any ‘--help=’ option.
If the ‘-Q’ option appears on the command line before the ‘--help=’ option, then
the descriptive text displayed by ‘--help=’ is changed. Instead of describing
the displayed options, an indication is given as to whether the option is enabled,
42 Using the GNU Compiler Collection (GCC)
disabled or set to a specific value (assuming that the compiler knows this at the
point where the ‘--help=’ option is used).
Here is a truncated example from the ARM port of gcc:
% gcc -Q -mabi=2 --help=target -c
The following options are target specific:
-mabi= 2
-mabort-on-noreturn [disabled]
-mapcs [disabled]
The output is sensitive to the effects of previous command-line options, so for
example it is possible to find out which optimizations are enabled at ‘-O2’ by
using:
-Q -O2 --help=optimizers
Alternatively you can discover which binary optimizations are enabled by ‘-O3’
by using:
gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
diff /tmp/O2-opts /tmp/O3-opts | grep enabled
--version
Display the version number and copyrights of the invoked GCC.
-pass-exit-codes
Normally the gcc program exits with the code of 1 if any phase of the compiler
returns a non-success return code. If you specify ‘-pass-exit-codes’, the gcc
program instead returns with the numerically highest error produced by any
phase returning an error indication. The C, C++, and Fortran front ends return
4 if an internal compiler error is encountered.
-pipe Use pipes rather than temporary files for communication between the various
stages of compilation. This fails to work on some systems where the assembler
is unable to read from a pipe; but the GNU assembler has no trouble.
-specs=file
Process file after the compiler reads in the standard ‘specs’ file, in order to
override the defaults which the gcc driver program uses when determining what
switches to pass to cc1, cc1plus, as, ld, etc. More than one ‘-specs=file’
can be specified on the command line, and they are processed in order, from
left to right. See Section 3.20 [Spec Files], page 496, for information about the
format of the file.
-wrapper Invoke all subcommands under a wrapper program. The name of the wrapper
program and its parameters are passed as a comma separated list.
gcc -c t.c -wrapper gdb,--args
This invokes all subprograms of gcc under ‘gdb --args’, thus the invocation of
cc1 is ‘gdb --args cc1 ...’.
-ffile-prefix-map=old=new
When compiling files residing in directory ‘old’, record any references to
them in the result of the compilation as if the files resided in directory
‘new’ instead. Specifying this option is equivalent to specifying all the
individual ‘-f*-prefix-map’ options. This can be used to make reproducible
Chapter 3: GCC Command Options 43
meaningful for C and related languages; or options that are meaningful only for C++ pro-
grams. See Section 3.4 [Options Controlling C Dialect], page 44, for explanations of options
for languages related to C. See Section 3.5 [Options Controlling C++ Dialect], page 51, for
explanations of options that are meaningful only for C++ programs.
all features supported by the compiler are enabled, even when those features
change the meaning of the base standard. As a result, some strict-conforming
programs may be rejected. The particular standard is used by ‘-Wpedantic’ to
identify which features are GNU extensions given that version of the standard.
For example ‘-std=gnu90 -Wpedantic’ warns about C++ style ‘//’ comments,
while ‘-std=gnu99 -Wpedantic’ does not.
A value for this option must be provided; possible values are
‘c90’
‘c89’
‘iso9899:1990’
Support all ISO C90 programs (certain GNU extensions that con-
flict with ISO C90 are disabled). Same as ‘-ansi’ for C code.
‘iso9899:199409’
ISO C90 as modified in amendment 1.
‘c99’
‘c9x’
‘iso9899:1999’
‘iso9899:199x’
ISO C99. This standard is substantially completely supported,
modulo bugs and floating-point issues (mainly but not entirely
relating to optional C99 features from Annexes F and G). See
https://gcc.gnu.org/c99status.html for more information.
The names ‘c9x’ and ‘iso9899:199x’ are deprecated.
‘c11’
‘c1x’
‘iso9899:2011’
ISO C11, the 2011 revision of the ISO C standard. This standard is
substantially completely supported, modulo bugs, floating-point is-
sues (mainly but not entirely relating to optional C11 features from
Annexes F and G) and the optional Annexes K (Bounds-checking
interfaces) and L (Analyzability). The name ‘c1x’ is deprecated.
‘c17’
‘c18’
‘iso9899:2017’
‘iso9899:2018’
ISO C17, the 2017 revision of the ISO C standard (published in
2018). This standard is same as C11 except for corrections of de-
fects (all of which are also applied with ‘-std=c11’) and a new value
of __STDC_VERSION__, and so is supported to the same extent as
C11.
‘c2x’ The next version of the ISO C standard, still under development.
The support for this version is experimental and incomplete.
‘gnu90’
‘gnu89’ GNU dialect of ISO C90 (including some C99 features).
46 Using the GNU Compiler Collection (GCC)
‘gnu99’
‘gnu9x’ GNU dialect of ISO C99. The name ‘gnu9x’ is deprecated.
‘gnu11’
‘gnu1x’ GNU dialect of ISO C11. The name ‘gnu1x’ is deprecated.
‘gnu17’
‘gnu18’ GNU dialect of ISO C17. This is the default for C code.
‘gnu2x’ The next version of the ISO C standard, still under development,
plus GNU extensions. The support for this version is experimental
and incomplete.
‘c++98’
‘c++03’ The 1998 ISO C++ standard plus the 2003 technical corrigendum
and some additional defect reports. Same as ‘-ansi’ for C++ code.
‘gnu++98’
‘gnu++03’ GNU dialect of ‘-std=c++98’.
‘c++11’
‘c++0x’ The 2011 ISO C++ standard plus amendments. The name ‘c++0x’
is deprecated.
‘gnu++11’
‘gnu++0x’ GNU dialect of ‘-std=c++11’. The name ‘gnu++0x’ is deprecated.
‘c++14’
‘c++1y’ The 2014 ISO C++ standard plus amendments. The name ‘c++1y’
is deprecated.
‘gnu++14’
‘gnu++1y’ GNU dialect of ‘-std=c++14’. The name ‘gnu++1y’ is deprecated.
‘c++17’
‘c++1z’ The 2017 ISO C++ standard plus amendments. The name ‘c++1z’
is deprecated.
‘gnu++17’
‘gnu++1z’ GNU dialect of ‘-std=c++17’. This is the default for C++ code.
The name ‘gnu++1z’ is deprecated.
‘c++20’
‘c++2a’ The 2020 ISO C++ standard plus amendments. Support is experi-
mental, and could change in incompatible ways in future releases.
The name ‘c++2a’ is deprecated.
‘gnu++20’
‘gnu++2a’ GNU dialect of ‘-std=c++20’. Support is experimental, and could
change in incompatible ways in future releases. The name ‘gnu++2a’
is deprecated.
‘c++2b’
‘c++23’ The next revision of the ISO C++ standard, planned for 2023. Sup-
port is highly experimental, and will almost certainly change in
incompatible ways in future releases.
Chapter 3: GCC Command Options 47
‘gnu++2b’
‘gnu++23’ GNU dialect of ‘-std=c++2b’. Support is highly experimental, and
will almost certainly change in incompatible ways in future releases.
-aux-info filename
Output to the given filename prototyped declarations for all functions declared
and/or defined in a translation unit, including those in header files. This option
is silently ignored in any language other than C.
Besides declarations, the file indicates, in comments, the origin of each declara-
tion (source file and line), whether the declaration was implicit, prototyped or
unprototyped (‘I’, ‘N’ for new or ‘O’ for old, respectively, in the first character
after the line number and the colon), and whether it came from a declaration
or a definition (‘C’ or ‘F’, respectively, in the following character). In the case
of function definitions, a K&R-style list of arguments followed by their decla-
rations is also provided, inside comments, after the declaration.
-fallow-parameterless-variadic-functions
Accept variadic functions without named parameters.
Although it is possible to define such a function, this is not very useful as it
is not possible to read the arguments. This is only supported for C as this
construct is allowed by C++.
-fno-asm Do not recognize asm, inline or typeof as a keyword, so that code can use
these words as identifiers. You can use the keywords __asm__, __inline__ and
__typeof__ instead. In C, ‘-ansi’ implies ‘-fno-asm’.
In C++, inline is a standard keyword and is not affected by this switch. You
may want to use the ‘-fno-gnu-keywords’ flag instead, which disables typeof
but not asm and inline. In C99 mode (‘-std=c99’ or ‘-std=gnu99’), this
switch only affects the asm and typeof keywords, since inline is a standard
keyword in ISO C99.
-fno-builtin
-fno-builtin-function
Don’t recognize built-in functions that do not begin with ‘__builtin_’ as prefix.
See Section 6.59 [Other built-in functions provided by GCC], page 728, for
details of the functions affected, including those which are not built-in functions
when ‘-ansi’ or ‘-std’ options for strict ISO C conformance are used because
they do not have an ISO standard meaning.
GCC normally generates special code to handle certain built-in functions more
efficiently; for instance, calls to alloca may become single instructions which
adjust the stack directly, and calls to memcpy may become inline copy loops.
The resulting code is often both smaller and faster, but since the function
calls no longer appear as such, you cannot set a breakpoint on those calls,
nor can you change the behavior of the functions by linking with a different
library. In addition, when a function is recognized as a built-in function, GCC
may use information about that function to warn about problems with calls to
that function, or to generate more efficient code, even if the resulting code still
contains calls to that function. For example, warnings are given with ‘-Wformat’
48 Using the GNU Compiler Collection (GCC)
for bad calls to printf when printf is built in and strlen is known not to
modify global memory.
With the ‘-fno-builtin-function’ option only the built-in function function
is disabled. function must not begin with ‘__builtin_’. If a function is named
that is not built-in in this version of GCC, this option is ignored. There is
no corresponding ‘-fbuiltin-function’ option; if you wish to enable built-in
functions selectively when using ‘-fno-builtin’ or ‘-ffreestanding’, you may
define macros such as:
#define abs(n) __builtin_abs ((n))
#define strcpy(d, s) __builtin_strcpy ((d), (s))
-fcond-mismatch
Allow conditional expressions with mismatched types in the second and third
arguments. The value of such an expression is void. This option is not supported
for C++.
-ffreestanding
Assert that compilation targets a freestanding environment. This implies
‘-fno-builtin’. A freestanding environment is one in which the standard
library may not exist, and program startup may not necessarily be at
main. The most obvious example is an OS kernel. This is equivalent to
‘-fno-hosted’.
See Chapter 2 [Language Standards Supported by GCC], page 5, for details of
freestanding and hosted environments.
-fgimple
Enable parsing of function definitions marked with __GIMPLE. This is an ex-
perimental feature that allows unit testing of GIMPLE passes.
-fgnu-tm When the option ‘-fgnu-tm’ is specified, the compiler generates code for the
Linux variant of Intel’s current Transactional Memory ABI specification doc-
ument (Revision 1.1, May 6 2009). This is an experimental feature whose
interface may change in future versions of GCC, as the official specification
changes. Please note that not all architectures are supported for this feature.
For more information on GCC’s support for transactional memory, See Section
“The GNU Transactional Memory Library” in GNU Transactional Memory
Library.
Note that the transactional memory feature is not supported with non-call
exceptions (‘-fnon-call-exceptions’).
-fgnu89-inline
The option ‘-fgnu89-inline’ tells GCC to use the traditional GNU semantics
for inline functions when in C99 mode. See Section 6.45 [An Inline Func-
tion is As Fast As a Macro], page 653. Using this option is roughly equiva-
lent to adding the gnu_inline function attribute to all inline functions (see
Section 6.33 [Function Attributes], page 556).
The option ‘-fno-gnu89-inline’ explicitly tells GCC to use the C99 semantics
for inline when in C99 or gnu99 mode (i.e., it specifies the default behavior).
This option is not supported in ‘-std=c90’ or ‘-std=gnu90’ mode.
Chapter 3: GCC Command Options 49
-foffload-options=-lgfortran -foffload-options=-lm
-foffload-options="-lgfortran -lm" -foffload-options=nvptx-none=-latomic
-foffload-options=amdgcn-amdhsa=-march=gfx906 -foffload-options=-lm
-fopenacc
Enable handling of OpenACC directives #pragma acc in C/C++ and !$acc
in Fortran. When ‘-fopenacc’ is specified, the compiler generates acceler-
ated code according to the OpenACC Application Programming Interface v2.6
https://www.openacc.org. This option implies ‘-pthread’, and thus is only
supported on targets that have support for ‘-pthread’.
-fopenacc-dim=geom
Specify default compute dimensions for parallel offload regions that do not
explicitly specify. The geom value is a triple of ’:’-separated sizes, in order
’gang’, ’worker’ and, ’vector’. A size can be omitted, to use a target-specific
default value.
-fopenmp Enable handling of OpenMP directives #pragma omp in C/C++ and !$omp
in Fortran. When ‘-fopenmp’ is specified, the compiler generates parallel
code according to the OpenMP Application Program Interface v4.5
https://www.openmp.org. This option implies ‘-pthread’, and thus is only
supported on targets that have support for ‘-pthread’. ‘-fopenmp’ implies
‘-fopenmp-simd’.
-fopenmp-simd
Enable handling of OpenMP’s SIMD directives with #pragma omp in C/C++
and !$omp in Fortran. Other OpenMP directives are ignored.
-fpermitted-flt-eval-methods=style
ISO/IEC TS 18661-3 defines new permissible values for FLT_EVAL_METHOD that
indicate that operations and constants with a semantic type that is an inter-
change or extended format should be evaluated to the precision and range of
that type. These new values are a superset of those permitted under C99/C11,
which does not specify the meaning of other positive values of FLT_EVAL_
METHOD. As such, code conforming to C11 may not have been written expecting
the possibility of the new values.
‘-fpermitted-flt-eval-methods’ specifies whether the compiler should allow
only the values of FLT_EVAL_METHOD specified in C99/C11, or the extended set
of values specified in ISO/IEC TS 18661-3.
style is either c11 or ts-18661-3 as appropriate.
The default when in a standards compliant mode (‘-std=c11’ or similar) is
‘-fpermitted-flt-eval-methods=c11’. The default when in a GNU dialect
(‘-std=gnu11’ or similar) is ‘-fpermitted-flt-eval-methods=ts-18661-3’.
-fplan9-extensions
Accept some non-standard constructs used in Plan 9 code.
This enables ‘-fms-extensions’, permits passing pointers to structures with
anonymous fields to functions that expect pointers to elements of the type of
the field, and permits referring to anonymous fields declared using a typedef.
Chapter 3: GCC Command Options 51
See Section 6.63 [Unnamed struct/union fields within structs/unions], page 881,
for details. This is only supported for C, not C++.
-fsigned-bitfields
-funsigned-bitfields
-fno-signed-bitfields
-fno-unsigned-bitfields
These options control whether a bit-field is signed or unsigned, when the dec-
laration does not use either signed or unsigned. By default, such a bit-field is
signed, because this is consistent: the basic integer types such as int are signed
types.
-fsigned-char
Let the type char be signed, like signed char.
Note that this is equivalent to ‘-fno-unsigned-char’, which is the negative
form of ‘-funsigned-char’. Likewise, the option ‘-fno-signed-char’ is equiv-
alent to ‘-funsigned-char’.
-funsigned-char
Let the type char be unsigned, like unsigned char.
Each kind of machine has a default for what char should be. It is either like
unsigned char by default or like signed char by default.
Ideally, a portable program should always use signed char or unsigned char
when it depends on the signedness of an object. But many programs have been
written to use plain char and expect it to be signed, or expect it to be unsigned,
depending on the machines they were written for. This option, and its inverse,
let you make such a program work with the opposite default.
The type char is always a distinct type from each of signed char or unsigned
char, even though its behavior is always just like one of those two.
-fsso-struct=endianness
Set the default scalar storage order of structures and unions to the specified en-
dianness. The accepted values are ‘big-endian’, ‘little-endian’ and ‘native’
for the native endianness of the target (the default). This option is not sup-
ported for C++.
Warning: the ‘-fsso-struct’ switch causes GCC to generate code that is not
binary compatible with code generated without it if the specified endianness is
not the native endianness of the target.
Here is a list of options that are only for compiling C++ programs:
-fabi-version=n
Use version n of the C++ ABI. The default is version 0.
Version 0 refers to the version conforming most closely to the C++ ABI spec-
ification. Therefore, the ABI obtained using version 0 will change in different
versions of G++ as ABI bugs are fixed.
Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
Version 2 is the version of the C++ ABI that first appeared in G++ 3.4, and was
the default through G++ 4.9.
Version 3 corrects an error in mangling a constant address as a template argu-
ment.
Version 4, which first appeared in G++ 4.5, implements a standard mangling
for vector types.
Version 5, which first appeared in G++ 4.6, corrects the mangling of attribute
const/volatile on function pointer types, decltype of a plain decl, and use of a
function parameter in the declaration of another parameter.
Version 6, which first appeared in G++ 4.7, corrects the promotion behav-
ior of C++11 scoped enums and the mangling of template argument packs,
const/static cast, prefix ++ and –, and a class scope function used as a tem-
plate argument.
Version 7, which first appeared in G++ 4.8, that treats nullptr t as a builtin
type and corrects the mangling of lambdas in default argument scope.
Version 8, which first appeared in G++ 4.9, corrects the substitution behavior
of function types with function-cv-qualifiers.
Version 9, which first appeared in G++ 5.2, corrects the alignment of nullptr_t.
Version 10, which first appeared in G++ 6.1, adds mangling of attributes that
affect type identity, such as ia32 calling convention attributes (e.g. ‘stdcall’).
Version 11, which first appeared in G++ 7, corrects the mangling of sizeof... ex-
pressions and operator names. For multiple entities with the same name within
a function, that are declared in different scopes, the mangling now changes start-
ing with the twelfth occurrence. It also implies ‘-fnew-inheriting-ctors’.
Version 12, which first appeared in G++ 8, corrects the calling conventions for
empty classes on the x86 64 target and for classes with only deleted copy/move
constructors. It accidentally changes the calling convention for classes with a
deleted copy constructor and a trivial move constructor.
Version 13, which first appeared in G++ 8.2, fixes the accidental change in
version 12.
Version 14, which first appeared in G++ 10, corrects the mangling of the nullptr
expression.
Version 15, which first appeared in G++ 11, changes the mangling of __alignof_
_ to be distinct from that of alignof, and dependent operator names.
See also ‘-Wabi’.
Chapter 3: GCC Command Options 53
-fabi-compat-version=n
On targets that support strong aliases, G++ works around mangling changes by
creating an alias with the correct mangled name when defining a symbol with
an incorrect mangled name. This switch specifies which ABI version to use for
the alias.
With ‘-fabi-version=0’ (the default), this defaults to 11 (GCC 7 compatibil-
ity). If another ABI version is explicitly selected, this defaults to 0. For com-
patibility with GCC versions 3.2 through 4.9, use ‘-fabi-compat-version=2’.
If this option is not provided but ‘-Wabi=n’ is, that version is used for com-
patibility aliases. If this option is provided along with ‘-Wabi’ (without the
version), the version from this option is used for the warning.
-fno-access-control
Turn off all access checking. This switch is mainly useful for working around
bugs in the access control code.
-faligned-new
Enable support for C++17 new of types that require more alignment than
void* ::operator new(std::size_t) provides. A numeric argument such as
-faligned-new=32 can be used to specify how much alignment (in bytes) is
provided by that function, but few users will need to override the default of
alignof(std::max_align_t).
This flag is enabled by default for ‘-std=c++17’.
-fchar8_t
-fno-char8_t
Enable support for char8_t as adopted for C++20. This includes the addition
of a new char8_t fundamental type, changes to the types of UTF-8 string and
character literals, new signatures for user-defined literals, associated standard
library updates, and new __cpp_char8_t and __cpp_lib_char8_t feature test
macros.
This option enables functions to be overloaded for ordinary and UTF-8 strings:
int f(const char *); // #1
int f(const char8_t *); // #2
int v1 = f("text"); // Calls #1
int v2 = f(u8"text"); // Calls #2
and introduces new signatures for user-defined literals:
int operator""_udl1(char8_t);
int v3 = u8’x’_udl1;
int operator""_udl2(const char8_t*, std::size_t);
int v4 = u8"text"_udl2;
template<typename T, T...> int operator""_udl3();
int v5 = u8"text"_udl3;
The change to the types of UTF-8 string and character literals introduces in-
compatibilities with ISO C++11 and later standards. For example, the following
code is well-formed under ISO C++11, but is ill-formed when ‘-fchar8_t’ is
specified.
char ca[] = u8"xx"; // error: char-array initialized from wide
// string
54 Using the GNU Compiler Collection (GCC)
-fcheck-new
Check that the pointer returned by operator new is non-null before attempting
to modify the storage allocated. This check is normally unnecessary because
the C++ standard specifies that operator new only returns 0 if it is declared
throw(), in which case the compiler always checks the return value even without
this option. In all other cases, when operator new has a non-empty exception
specification, memory exhaustion is signalled by throwing std::bad_alloc.
See also ‘new (nothrow)’.
-fconcepts
-fconcepts-ts
Below ‘-std=c++20’, ‘-fconcepts’ enables support for the C++ Extensions for
Concepts Technical Specification, ISO 19217 (2015).
With ‘-std=c++20’ and above, Concepts are part of the language standard, so
‘-fconcepts’ defaults to on. But the standard specification of Concepts differs
significantly from the TS, so some constructs that were allowed in the TS but
didn’t make it into the standard can still be enabled by ‘-fconcepts-ts’.
-fconstexpr-depth=n
Set the maximum nested evaluation depth for C++11 constexpr functions to
n. A limit is needed to detect endless recursion during constant expression
evaluation. The minimum specified by the standard is 512.
-fconstexpr-cache-depth=n
Set the maximum level of nested evaluation depth for C++11 constexpr func-
tions that will be cached to n. This is a heuristic that trades off compilation
speed (when the cache avoids repeated calculations) against memory consump-
tion (when the cache grows very large from highly recursive evaluations). The
default is 8. Very few users are likely to want to adjust it, but if your code does
heavy constexpr calculations you might want to experiment to find which value
works best for you.
-fconstexpr-fp-except
Annex F of the C standard specifies that IEC559 floating point exceptions
encountered at compile time should not stop compilation. C++ compilers have
historically not followed this guidance, instead treating floating point division
by zero as non-constant even though it has a well defined value. This flag tells
the compiler to give Annex F priority over other rules saying that a particular
operation is undefined.
constexpr float inf = 1./0.; // OK with -fconstexpr-fp-except
Chapter 3: GCC Command Options 55
-fconstexpr-loop-limit=n
Set the maximum number of iterations for a loop in C++14 constexpr functions
to n. A limit is needed to detect infinite loops during constant expression
evaluation. The default is 262144 (1<<18).
-fconstexpr-ops-limit=n
Set the maximum number of operations during a single constexpr evaluation.
Even when number of iterations of a single loop is limited with the above limit,
if there are several nested loops and each of them has many iterations but
still smaller than the above limit, or if in a body of some loop or even outside
of a loop too many expressions need to be evaluated, the resulting constexpr
evaluation might take too long. The default is 33554432 (1<<25).
-fcoroutines
Enable support for the C++ coroutines extension (experimental).
-fno-elide-constructors
The C++ standard allows an implementation to omit creating a temporary that
is only used to initialize another object of the same type. Specifying this option
disables that optimization, and forces G++ to call the copy constructor in all
cases. This option also causes G++ to call trivial member functions which
otherwise would be expanded inline.
In C++17, the compiler is required to omit these temporaries, but this option
still affects trivial member functions.
-fno-enforce-eh-specs
Don’t generate code to check for violation of exception specifications at run
time. This option violates the C++ standard, but may be useful for reducing
code size in production builds, much like defining NDEBUG. This does not give
user code permission to throw exceptions in violation of the exception specifi-
cations; the compiler still optimizes based on the specifications, so throwing an
unexpected exception results in undefined behavior at run time.
-fextern-tls-init
-fno-extern-tls-init
The C++11 and OpenMP standards allow thread_local and threadprivate
variables to have dynamic (runtime) initialization. To support this, any use of
such a variable goes through a wrapper function that performs any necessary
initialization. When the use and definition of the variable are in the same
translation unit, this overhead can be optimized away, but when the use is in a
different translation unit there is significant overhead even if the variable doesn’t
actually need dynamic initialization. If the programmer can be sure that no
use of the variable in a non-defining TU needs to trigger dynamic initialization
(either because the variable is statically initialized, or a use of the variable in
the defining TU will be executed before any uses in another TU), they can avoid
this overhead with the ‘-fno-extern-tls-init’ option.
On targets that support symbol aliases, the default is ‘-fextern-tls-init’.
On targets that do not support symbol aliases, the default is
‘-fno-extern-tls-init’.
56 Using the GNU Compiler Collection (GCC)
-ffold-simple-inlines
-fno-fold-simple-inlines
Permit the C++ frontend to fold calls to std::move, std::forward,
std::addressof and std::as_const. In contrast to inlining, this means no
debug information will be generated for such calls. Since these functions are
rarely interesting to debug, this flag is enabled by default unless ‘-fno-inline’
is active.
-fno-gnu-keywords
Do not recognize typeof as a keyword, so that code can use this word as an
identifier. You can use the keyword __typeof__ instead. This option is implied
by the strict ISO C++ dialects: ‘-ansi’, ‘-std=c++98’, ‘-std=c++11’, etc.
-fimplicit-constexpr
Make inline functions implicitly constexpr, if they satisfy the requirements for a
constexpr function. This option can be used in C++14 mode or later. This can
result in initialization changing from dynamic to static and other optimizations.
-fno-implicit-templates
Never emit code for non-inline templates that are instantiated implicitly (i.e.
by use); only emit code for explicit instantiations. If you use this option, you
must take care to structure your code to include all the necessary explicit in-
stantiations to avoid getting undefined symbols at link time. See Section 7.5
[Template Instantiation], page 890, for more information.
-fno-implicit-inline-templates
Don’t emit code for implicit instantiations of inline templates, either. The
default is to handle inlines differently so that compiles with and without opti-
mization need the same set of explicit instantiations.
-fno-implement-inlines
To save space, do not emit out-of-line copies of inline functions controlled by
#pragma implementation. This causes linker errors if these functions are not
inlined everywhere they are called.
-fmodules-ts
-fno-modules-ts
Enable support for C++20 modules (see Section 3.23 [C++ Modules], page 510).
The ‘-fno-modules-ts’ is usually not needed, as that is the default. Even
though this is a C++20 feature, it is not currently implicitly enabled by selecting
that standard version.
-fmodule-header
-fmodule-header=user
-fmodule-header=system
Compile a header file to create an importable header unit.
-fmodule-implicit-inline
Member functions defined in their class definitions are not implicitly inline for
modular code. This is different to traditional C++ behavior, for good reasons.
However, it may result in a difficulty during code porting. This option makes
Chapter 3: GCC Command Options 57
-fno-optional-diags
Disable diagnostics that the standard says a compiler does not need to issue.
Currently, the only such diagnostic issued by G++ is the one for a name having
multiple meanings within a class.
-fpermissive
Downgrade some diagnostics about nonconformant code from errors to warn-
ings. Thus, using ‘-fpermissive’ allows some nonconforming code to compile.
-fno-pretty-templates
When an error message refers to a specialization of a function template, the com-
piler normally prints the signature of the template followed by the template ar-
guments and any typedefs or typenames in the signature (e.g. void f(T) [with
T = int] rather than void f(int)) so that it’s clear which template is involved.
When an error message refers to a specialization of a class template, the com-
piler omits any template arguments that match the default template arguments
for that template. If either of these behaviors make it harder to understand
the error message rather than easier, you can use ‘-fno-pretty-templates’ to
disable them.
-fno-rtti
Disable generation of information about every class with virtual functions
for use by the C++ run-time type identification features (dynamic_cast and
typeid). If you don’t use those parts of the language, you can save some space
by using this flag. Note that exception handling uses the same information,
but G++ generates it as needed. The dynamic_cast operator can still be used
for casts that do not require run-time type information, i.e. casts to void * or
to unambiguous base classes.
Mixing code compiled with ‘-frtti’ with that compiled with ‘-fno-rtti’ may
not work. For example, programs may fail to link if a class compiled with
‘-fno-rtti’ is used as a base for a class compiled with ‘-frtti’.
-fsized-deallocation
Enable the built-in global declarations
void operator delete (void *, std::size_t) noexcept;
void operator delete[] (void *, std::size_t) noexcept;
as introduced in C++14. This is useful for user-defined replacement dealloca-
tion functions that, for example, use the size of the object to make deallo-
cation faster. Enabled by default under ‘-std=c++14’ and above. The flag
‘-Wsized-deallocation’ warns about places that might want to add a defini-
tion.
-fstrict-enums
Allow the compiler to optimize using the assumption that a value of enumerated
type can only be one of the values of the enumeration (as defined in the C++
standard; basically, a value that can be represented in the minimum number
of bits needed to represent all the enumerators). This assumption may not be
valid if the program uses a cast to convert an arbitrary integer value to the
enumerated type.
Chapter 3: GCC Command Options 59
-fstrong-eval-order
Evaluate member access, array subscripting, and shift expressions in left-to-
right order, and evaluate assignment in right-to-left order, as adopted for C++17.
Enabled by default with ‘-std=c++17’. ‘-fstrong-eval-order=some’ enables
just the ordering of member access and shift expressions, and is the default
without ‘-std=c++17’.
-ftemplate-backtrace-limit=n
Set the maximum number of template instantiation notes for a single warning
or error to n. The default value is 10.
-ftemplate-depth=n
Set the maximum instantiation depth for template classes to n. A limit on
the template instantiation depth is needed to detect endless recursions during
template class instantiation. ANSI/ISO C++ conforming programs must not
rely on a maximum depth greater than 17 (changed to 1024 in C++11). The
default value is 900, as the compiler can run out of stack space before hitting
1024 in some situations.
-fno-threadsafe-statics
Do not emit the extra code to use the routines specified in the C++ ABI for
thread-safe initialization of local statics. You can use this option to reduce code
size slightly in code that doesn’t need to be thread-safe.
-fuse-cxa-atexit
Register destructors for objects with static storage duration with the __cxa_
atexit function rather than the atexit function. This option is required for
fully standards-compliant handling of static destructors, but only works if your
C library supports __cxa_atexit.
-fno-use-cxa-get-exception-ptr
Don’t use the __cxa_get_exception_ptr runtime routine. This causes
std::uncaught_exception to be incorrect, but is necessary if the runtime
routine is not available.
-fvisibility-inlines-hidden
This switch declares that the user does not attempt to compare pointers to
inline functions or methods where the addresses of the two functions are taken
in different shared objects.
The effect of this is that GCC may, effectively, mark inline methods with __
attribute__ ((visibility ("hidden"))) so that they do not appear in the
export table of a DSO and do not require a PLT indirection when used within
the DSO. Enabling this option can have a dramatic effect on load and link
times of a DSO as it massively reduces the size of the dynamic export table
when the library makes heavy use of templates.
The behavior of this switch is not quite the same as marking the methods as
hidden directly, because it does not affect static variables local to the function
or cause the compiler to deduce that the function is defined in only one shared
object.
60 Using the GNU Compiler Collection (GCC)
You may mark a method as having a visibility explicitly to negate the effect of
the switch for that method. For example, if you do want to compare pointers
to a particular inline method, you might mark it as having default visibility.
Marking the enclosing class with explicit visibility has no effect.
Explicitly instantiated inline methods are unaffected by this option as their link-
age might otherwise cross a shared library boundary. See Section 7.5 [Template
Instantiation], page 890.
-fvisibility-ms-compat
This flag attempts to use visibility settings to make GCC’s C++ linkage model
compatible with that of Microsoft Visual Studio.
The flag makes these changes to GCC’s linkage model:
1. It sets the default visibility to hidden, like ‘-fvisibility=hidden’.
2. Types, but not their members, are not hidden by default.
3. The One Definition Rule is relaxed for types without explicit visibility
specifications that are defined in more than one shared object: those dec-
larations are permitted if they are permitted when this option is not used.
-fno-weak
Do not use weak symbol support, even if it is provided by the linker. By
default, G++ uses weak symbols if they are available. This option exists only
for testing, and should not be used by end-users; it results in inferior code and
has no benefits. This option may be removed in a future release of G++.
-nostdinc++
Do not search for header files in the standard directories specific to C++, but do
still search the other standard directories. (This option is used when building
the C++ library.)
Chapter 3: GCC Command Options 61
-flang-info-include-translate
-flang-info-include-translate-not
-flang-info-include-translate=header
Inform of include translation events. The first will note accepted include trans-
lations, the second will note declined include translations. The header form
will inform of include translations relating to that specific header. If header is
of the form "user" or <system> it will be resolved to a specific user or system
header using the include path.
-flang-info-module-cmi
-flang-info-module-cmi=module
Inform of Compiled Module Interface pathnames. The first will note all read
CMI pathnames. The module form will not reading a specific module’s CMI.
module may be a named module or a header-unit (the latter indicated by either
being a pathname containing directory separators or enclosed in <> or "").
-stdlib=libstdc++,libc++
When G++ is configured to support this option, it allows specification of alter-
nate C++ runtime libraries. Two options are available: libstdc++ (the default,
native C++ runtime for G++) and libc++ which is the C++ runtime installed on
some operating systems (e.g. Darwin versions from Darwin11 onwards). The
option switches G++ to use the headers from the specified library and to emit
-lstdc++ or -lc++ respectively, when a C++ runtime is required for linking.
In addition, these warning options have meanings only for C++ programs:
-Wabi-tag (C++ and Objective-C++ only)
Warn when a type with an ABI tag is used in a context that does not have
that ABI tag. See Section 7.7 [C++ Attributes], page 893 for more information
about ABI tags.
-Wcomma-subscript (C++ and Objective-C++ only)
Warn about uses of a comma expression within a subscripting expression. This
usage was deprecated in C++20 and is going to be removed in C++23. However,
a comma expression wrapped in ( ) is not deprecated. Example:
void f(int *a, int b, int c) {
a[b,c]; // deprecated in C++20, invalid in C++23
a[(b,c)]; // OK
}
In C++23 it is valid to have comma separated expressions in a subscript when
an overloaded subscript operator is found and supports the right number and
types of arguments. G++ will accept the formerly valid syntax for code that
is not valid in C++23 but used to be valid but deprecated in C++20 with a
pedantic warning that can be disabled with ‘-Wno-comma-subscript’.
Enabled by default with ‘-std=c++20’ unless ‘-Wno-deprecated’, and with
‘-std=c++23’ regardless of ‘-Wno-deprecated’.
-Wctad-maybe-unsupported (C++ and Objective-C++ only)
Warn when performing class template argument deduction (CTAD) on a type
with no explicitly written deduction guides. This warning will point out cases
62 Using the GNU Compiler Collection (GCC)
where CTAD succeeded only because the compiler synthesized the implicit de-
duction guides, which might not be what the programmer intended. Certain
style guides allow CTAD only on types that specifically "opt-in"; i.e., on types
that are designed to support CTAD. This warning can be suppressed with the
following pattern:
struct allow_ctad_t; // any name works
template <typename T> struct S {
S(T) { }
};
S(allow_ctad_t) -> S<void>; // guide with incomplete parameter type will never be considered
int main() {
int64_t i64 = 123;
printf("My int64: %" PRId64"\n", i64);
}
In this case, PRId64 is treated as a separate preprocessing token.
64 Using the GNU Compiler Collection (GCC)
This option also controls warnings when a user-defined literal operator is de-
clared with a literal suffix identifier that doesn’t begin with an underscore.
Literal suffix identifiers that don’t begin with an underscore are reserved for
future standardization.
These warnings are enabled by default.
-Wno-narrowing (C++ and Objective-C++ only)
For C++11 and later standards, narrowing conversions are diagnosed by default,
as required by the standard. A narrowing conversion from a constant produces
an error, and a narrowing conversion from a non-constant produces a warning,
but ‘-Wno-narrowing’ suppresses the diagnostic. Note that this does not affect
the meaning of well-formed code; narrowing conversions are still considered
ill-formed in SFINAE contexts.
With ‘-Wnarrowing’ in C++98, warn when a narrowing conversion prohibited
by C++11 occurs within ‘{ }’, e.g.
int i = { 2.2 }; // error: narrowing from double to int
This flag is included in ‘-Wall’ and ‘-Wc++11-compat’.
-Wnoexcept (C++ and Objective-C++ only)
Warn when a noexcept-expression evaluates to false because of a call to a func-
tion that does not have a non-throwing exception specification (i.e. throw() or
noexcept) but is known by the compiler to never throw an exception.
-Wnoexcept-type (C++ and Objective-C++ only)
Warn if the C++17 feature making noexcept part of a function type changes
the mangled name of a symbol relative to C++14. Enabled by ‘-Wabi’ and
‘-Wc++17-compat’.
As an example:
template <class T> void f(T t) { t(); };
void g() noexcept;
void h() { f(g); }
In C++14, f calls f<void(*)()>, but in C++17 it calls f<void(*)()noexcept>.
-Wclass-memaccess (C++ and Objective-C++ only)
Warn when the destination of a call to a raw memory function such as memset
or memcpy is an object of class type, and when writing into such an object might
bypass the class non-trivial or deleted constructor or copy assignment, violate
const-correctness or encapsulation, or corrupt virtual table pointers. Modifying
the representation of such objects may violate invariants maintained by member
functions of the class. For example, the call to memset below is undefined
because it modifies a non-trivial class object and is, therefore, diagnosed. The
safe way to either initialize or clear the storage of objects of such types is by
using the appropriate constructor or assignment operator, if one is available.
std::string str = "abc";
memset (&str, 0, sizeof str);
The ‘-Wclass-memaccess’ option is enabled by ‘-Wall’. Explicitly casting the
pointer to the class object to void * or to a type that can be safely accessed
by the raw memory function suppresses the warning.
Chapter 3: GCC Command Options 65
T fn(T t)
{
...
return std::move (t);
}
Here, the std::move call is redundant. Because G++ implements Core Issue
1579, another example is:
struct T { // convertible to U
...
};
struct U {
...
};
U fn()
{
T t;
...
return std::move (t);
}
In this example, copy elision isn’t applicable because the type of the expression
being returned and the function return type differ, yet G++ treats the return
value as if it were designated by an rvalue.
This warning is enabled by ‘-Wextra’.
-Wrange-loop-construct (C++ and Objective-C++ only)
This warning warns when a C++ range-based for-loop is creating an unnecessary
copy. This can happen when the range declaration is not a reference, but
probably should be. For example:
struct S { char arr[128]; };
void fn () {
S arr[5];
for (const auto x : arr) { ... }
}
It does not warn when the type being copied is a trivially-copyable type whose
size is less than 64 bytes.
This warning also warns when a loop variable in a range-based for-loop is ini-
tialized with a value of a different type resulting in a copy. For example:
void fn() {
int arr[10];
for (const double &x : arr) { ... }
}
In the example above, in every iteration of the loop a temporary value of type
double is created and destroyed, to which the reference const double & is
bound.
This warning is enabled by ‘-Wall’.
-Wredundant-tags (C++ and Objective-C++ only)
Warn about redundant class-key and enum-key in references to class types and
enumerated types in contexts where the key can be eliminated without causing
an ambiguity. For example:
struct foo;
Chapter 3: GCC Command Options 67
struct B: public A {
void f(int); // does not override
};
the A class version of f is hidden in B, and code like:
B* b;
b->f();
fails to compile.
The optional level suffix controls the behavior when all the declarations in the
derived class override virtual functions in the base class, even if not all of the
base functions are overridden:
struct C {
virtual void f();
virtual void f(int);
};
struct D: public C {
void f(int); // does override
}
This pattern is less likely to be a mistake; if D is only used virtually, the user
might have decided that the base class semantics for some of the overloads are
fine.
At level 1, this case does not warn; at level 2, it does. ‘-Woverloaded-virtual’
by itself selects level 2. Level 1 is included in ‘-Wall’.
-Wno-pmf-conversions (C++ and Objective-C++ only)
Disable the diagnostic for converting a bound pointer to member function to a
plain pointer.
-Wsign-promo (C++ and Objective-C++ only)
Warn when overload resolution chooses a promotion from unsigned or enumer-
ated type to a signed type, over a conversion to an unsigned type of the same
size. Previous versions of G++ tried to preserve unsignedness, but the standard
mandates the current behavior.
Chapter 3: GCC Command Options 69
-Wvirtual-inheritance
Warn when a class is defined with a virtual direct base class. Some coding rules
disallow multiple inheritance, and this may be used to enforce that rule. The
warning is inactive inside a system header file, such as the STL, so one can still
use the STL. One may also define classes that indirectly use virtual inheritance.
-Wno-virtual-move-assign
Suppress warnings about inheriting from a virtual base with a non-trivial C++11
move assignment operator. This is dangerous because if the virtual base is
reachable along more than one path, it is moved multiple times, which can
mean both objects end up in the moved-from state. If the move assignment
operator is written to avoid moving from a moved-from object, this warning
can be disabled.
-Wnamespaces
Warn when a namespace definition is opened. Some coding rules disallow
namespaces, and this may be used to enforce that rule. The warning is in-
active inside a system header file, such as the STL, so one can still use the STL.
One may also use using directives and qualified names.
-Wplacement-new=2
At this level, in addition to diagnosing all the same constructs as
at level 1, a diagnostic is also issued for placement new expressions
72 Using the GNU Compiler Collection (GCC)
-Wcatch-value
-Wcatch-value=n (C++ and Objective-C++ only)
Warn about catch handlers that do not catch via reference. With
‘-Wcatch-value=1’ (or ‘-Wcatch-value’ for short) warn about polymorphic
class types that are caught by value. With ‘-Wcatch-value=2’ warn about all
class types that are caught by value. With ‘-Wcatch-value=3’ warn about all
types that are not caught by reference. ‘-Wcatch-value’ is enabled by ‘-Wall’.
-Wconditionally-supported (C++ and Objective-C++ only)
Warn for conditionally-supported (C++11 [intro.defs]) constructs.
-Wno-delete-incomplete (C++ and Objective-C++ only)
Do not warn when deleting a pointer to incomplete type, which may cause
undefined behavior at runtime. This warning is enabled by default.
-Wextra-semi (C++, Objective-C++ only)
Warn about redundant semicolons after in-class function definitions.
-Wno-inaccessible-base (C++, Objective-C++ only)
This option controls warnings when a base class is inaccessible in a class derived
from it due to ambiguity. The warning is enabled by default. Note that the
warning for ambiguous virtual bases is enabled by the ‘-Wextra’ option.
struct A { int a; };
struct B : A { };
struct C : B, A { };
-Wno-inherited-variadic-ctor
Suppress warnings about use of C++11 inheriting constructors when the base
class inherited from has a C variadic constructor; the warning is on by default
because the ellipsis is not inherited.
-Wno-invalid-offsetof (C++ and Objective-C++ only)
Suppress warnings from applying the offsetof macro to a non-POD type.
According to the 2014 ISO C++ standard, applying offsetof to a non-standard-
layout type is undefined. In existing C++ implementations, however, offsetof
typically gives meaningful results. This flag is for users who are aware that
they are writing nonportable code and who have deliberately chosen to ignore
the warning about it.
The restrictions on offsetof may be relaxed in a future version of the C++
standard.
Chapter 3: GCC Command Options 73
are not diagnosed. For example, the second call to free in the fol-
lowing function is diagnosed at this level:
struct A { int refcount; void *data; };
-Wuse-after-free=3
At level 3, the warning also diagnoses uses of indeterminate pointers
in equality expressions. All uses of indeterminate pointers are un-
defined but equality tests sometimes appear after calls to realloc
as an attempt to determine whether the call resulted in relocating
the object to a different address. They are diagnosed at a separate
level to aid legacy code gradually transition to safe alternatives.
For example, the equality test in the function below is diagnosed
at this level:
void adjust_pointers (int**, int);
In this example, ‘-fgnu-runtime’ is an option meant only for Objective-C and Objective-
C++ programs; you can use the other options with any language supported by GCC.
Note that since Objective-C is an extension of the C language, Objective-C compila-
tions may also use options specific to the C front-end (e.g., ‘-Wtraditional’). Similarly,
Objective-C++ compilations may use C++-specific options (e.g., ‘-Wabi’).
Here is a list of options that are only for compiling Objective-C and Objective-C++
programs:
-fconstant-string-class=class-name
Use class-name as the name of the class to instantiate for each literal string
specified with the syntax @"...". The default class name is NXConstantString
if the GNU runtime is being used, and NSConstantString if the NeXT runtime
is being used (see below). The ‘-fconstant-cfstrings’ option, if also present,
overrides the ‘-fconstant-string-class’ setting and cause @"..." literals to
be laid out as constant CoreFoundation strings.
-fgnu-runtime
Generate object code compatible with the standard GNU Objective-C runtime.
This is the default for most types of systems.
-fnext-runtime
Generate output compatible with the NeXT runtime. This is the default for
NeXT-based systems, including Darwin and Mac OS X. The macro __NEXT_
RUNTIME__ is predefined if (and only if) this option is used.
-fno-nil-receivers
Assume that all Objective-C message dispatches ([receiver message:arg]) in
this translation unit ensure that the receiver is not nil. This allows for more
efficient entry points in the runtime to be used. This option is only available in
conjunction with the NeXT runtime and ABI version 0 or 1.
-fobjc-abi-version=n
Use version n of the Objective-C ABI for the selected runtime. This option is
currently supported only for the NeXT runtime. In that case, Version 0 is the
traditional (32-bit) ABI without support for properties and other Objective-
C 2.0 additions. Version 1 is the traditional (32-bit) ABI with support for
properties and other Objective-C 2.0 additions. Version 2 is the modern (64-bit)
ABI. If nothing is specified, the default is Version 0 on 32-bit target machines,
and Version 2 on 64-bit target machines.
-fobjc-call-cxx-cdtors
For each Objective-C class, check if any of its instance variables is a C++ ob-
ject with a non-trivial default constructor. If so, synthesize a special - (id)
.cxx_construct instance method which runs non-trivial default constructors
on any such instance variables, in order, and then return self. Similarly, check
if any instance variable is a C++ object with a non-trivial destructor, and if
so, synthesize a special - (void) .cxx_destruct method which runs all such
default destructors, in reverse order.
The - (id) .cxx_construct and - (void) .cxx_destruct methods thusly
generated only operate on instance variables declared in the current
76 Using the GNU Compiler Collection (GCC)
-print-objc-runtime-info
Generate C header describing the largest structure that is passed by value, if
any.
-fmessage-length=n
Try to format error messages so that they fit on lines of about n characters. If
n is zero, then no line-wrapping is done; each error message appears on a single
line. This is the default for all front ends.
Note - this option also affects the display of the ‘#error’ and ‘#warning’ pre-
processor directives, and the ‘deprecated’ function/type/variable attribute.
It does not however affect the ‘pragma GCC warning’ and ‘pragma GCC error’
pragmas.
Chapter 3: GCC Command Options 79
-fdiagnostics-plain-output
This option requests that diagnostic output look as plain as possible,
which may be useful when running dejagnu or other utilities that need to
parse diagnostics output and prefer that it remain more stable over time.
‘-fdiagnostics-plain-output’ is currently equivalent to the following
options:
-fno-diagnostics-show-caret
-fno-diagnostics-show-line-numbers
-fdiagnostics-color=never
-fdiagnostics-urls=never
-fdiagnostics-path-format=separate-events
In the future, if GCC changes the default appearance of its diagnostics, the
corresponding option to disable the new behavior will be added to this list.
-fdiagnostics-show-location=once
Only meaningful in line-wrapping mode. Instructs the diagnostic messages re-
porter to emit source location information once; that is, in case the message
is too long to fit on a single physical line and has to be wrapped, the source
location won’t be emitted (as prefix) again, over and over, in subsequent con-
tinuation lines. This is the default behavior.
-fdiagnostics-show-location=every-line
Only meaningful in line-wrapping mode. Instructs the diagnostic messages
reporter to emit the same source location information (as prefix) for physical
lines that result from the process of breaking a message which is too long to fit
on a single line.
-fdiagnostics-color[=WHEN]
-fno-diagnostics-color
Use color in diagnostics. WHEN is ‘never’, ‘always’, or ‘auto’. The default
depends on how the compiler has been configured, it can be any of the above
WHEN options or also ‘never’ if GCC_COLORS environment variable isn’t present
in the environment, and ‘auto’ otherwise. ‘auto’ makes GCC use color only
when the standard error is a terminal, and when not executing in an emacs shell.
The forms ‘-fdiagnostics-color’ and ‘-fno-diagnostics-color’ are aliases
for ‘-fdiagnostics-color=always’ and ‘-fdiagnostics-color=never’, re-
spectively.
The colors are defined by the environment variable GCC_COLORS. Its value is
a colon-separated list of capabilities and Select Graphic Rendition (SGR) sub-
strings. SGR commands are interpreted by the terminal or terminal emulator.
(See the section in the documentation of your text terminal for permitted values
and their meanings as character attributes.) These substring values are integers
in decimal representation and can be concatenated with semicolons. Common
values to concatenate include ‘1’ for bold, ‘4’ for underline, ‘5’ for blink, ‘7’ for
inverse, ‘39’ for default foreground color, ‘30’ to ‘37’ for foreground colors, ‘90’
to ‘97’ for 16-color mode foreground colors, ‘38;5;0’ to ‘38;5;255’ for 88-color
and 256-color modes foreground colors, ‘49’ for default background color, ‘40’
to ‘47’ for background colors, ‘100’ to ‘107’ for 16-color mode background col-
80 Using the GNU Compiler Collection (GCC)
ors, and ‘48;5;0’ to ‘48;5;255’ for 88-color and 256-color modes background
colors.
The default GCC_COLORS is
error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
quote=01:path=01;36:fixit-insert=32:fixit-delete=31:\
diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
type-diff=01;32:fnname=01;32:targs=35
where ‘01;31’ is bold red, ‘01;35’ is bold magenta, ‘01;36’ is bold cyan, ‘32’
is green, ‘34’ is blue, ‘01’ is bold, and ‘31’ is red. Setting GCC_COLORS to the
empty string disables colors. Supported capabilities are as follows.
error= SGR substring for error: markers.
warning= SGR substring for warning: markers.
note= SGR substring for note: markers.
path= SGR substring for colorizing paths of control-flow events as printed
via ‘-fdiagnostics-path-format=’, such as the identifiers of indi-
vidual events and lines indicating interprocedural calls and returns.
range1= SGR substring for first additional range.
range2= SGR substring for second additional range.
locus= SGR substring for location information, ‘file:line’ or
‘file:line:column’ etc.
quote= SGR substring for information printed within quotes.
fnname= SGR substring for names of C++ functions.
targs= SGR substring for C++ function template parameter bindings.
fixit-insert=
SGR substring for fix-it hints suggesting text to be inserted or
replaced.
fixit-delete=
SGR substring for fix-it hints suggesting text to be deleted.
diff-filename=
SGR substring for filename headers within generated patches.
diff-hunk=
SGR substring for the starts of hunks within generated patches.
diff-delete=
SGR substring for deleted lines within generated patches.
diff-insert=
SGR substring for inserted lines within generated patches.
type-diff=
SGR substring for highlighting mismatching types within template
arguments in the C++ frontend.
Chapter 3: GCC Command Options 81
-fdiagnostics-urls[=WHEN]
Use escape sequences to embed URLs in diagnostics. For example, when
‘-fdiagnostics-show-option’ emits text showing the command-line option
controlling a diagnostic, embed a URL for documentation of that option.
WHEN is ‘never’, ‘always’, or ‘auto’. ‘auto’ makes GCC use URL escape
sequences only when the standard error is a terminal, and when not executing
in an emacs shell or any graphical terminal which is known to be incompatible
with this feature, see below.
The default depends on how the compiler has been configured. It can be any
of the above WHEN options.
GCC can also be configured (via the ‘--with-diagnostics-urls=auto-if-env’
configure-time option) so that the default is affected by environment variables.
Under such a configuration, GCC defaults to using ‘auto’ if either GCC_URLS
or TERM_URLS environment variables are present and non-empty in the
environment of the compiler, or ‘never’ if neither are.
However, even with ‘-fdiagnostics-urls=always’ the behavior is dependent
on those environment variables: If GCC_URLS is set to empty or ‘no’, do not
embed URLs in diagnostics. If set to ‘st’, URLs use ST escape sequences. If
set to ‘bel’, the default, URLs use BEL escape sequences. Any other non-empty
value enables the feature. If GCC_URLS is not set, use TERM_URLS as a fallback.
Note: ST is an ANSI escape sequence, string terminator ‘ESC \’, BEL is an
ASCII character, CTRL-G that usually sounds like a beep.
At this time GCC tries to detect also a few terminals that are known to not
implement the URL feature, and have bugs or at least had bugs in some versions
that are still in use, where the URL escapes are likely to misbehave, i.e. print
garbage on the screen. That list is currently xfce4-terminal, certain known to
be buggy gnome-terminal versions, the linux console, and mingw. This check
can be skipped with the ‘-fdiagnostics-urls=always’.
-fno-diagnostics-show-option
By default, each diagnostic emitted includes text indicating the command-line
option that directly controls the diagnostic (if such an option is known to the
diagnostic machinery). Specifying the ‘-fno-diagnostics-show-option’ flag
suppresses that behavior.
-fno-diagnostics-show-caret
By default, each diagnostic emitted includes the original source line and a caret
‘^’ indicating the column. This option suppresses this information. The source
line is truncated to n characters, if the ‘-fmessage-length=n’ option is given.
When the output is done to the terminal, the width is limited to the width
given by the COLUMNS environment variable or, if not set, to the terminal width.
-fno-diagnostics-show-labels
By default, when printing source code (via ‘-fdiagnostics-show-caret’), di-
agnostics can label ranges of source code with pertinent information, such as
the types of expressions:
printf ("foo %s bar", long_i + long_j);
~^ ~~~~~~~~~~~~~~~
82 Using the GNU Compiler Collection (GCC)
| |
char * long int
This option suppresses the printing of these labels (in the example above, the
vertical bars and the “char *” and “long int” text).
-fno-diagnostics-show-cwe
Diagnostic messages can optionally have an associated CWE identifier. GCC
itself only provides such metadata for some of the ‘-fanalyzer’ diagnostics.
GCC plugins may also provide diagnostics with such metadata. By default, if
this information is present, it will be printed with the diagnostic. This option
suppresses the printing of this metadata.
-fno-diagnostics-show-rules
Diagnostic messages can optionally have rules associated with them, such as
from a coding standard, or a specification. GCC itself does not do this for
any of its diagnostics, but plugins may do so. By default, if this information
is present, it will be printed with the diagnostic. This option suppresses the
printing of this metadata.
-fno-diagnostics-show-line-numbers
By default, when printing source code (via ‘-fdiagnostics-show-caret’), a
left margin is printed, showing line numbers. This option suppresses this left
margin.
-fdiagnostics-minimum-margin-width=width
This option controls the minimum width of the left margin printed by
‘-fdiagnostics-show-line-numbers’. It defaults to 6.
-fdiagnostics-parseable-fixits
Emit fix-it hints in a machine-parseable format, suitable for consumption by
IDEs. For each fix-it, a line will be printed after the relevant diagnostic, starting
with the string “fix-it:”. For example:
fix-it:"test.c":{45:3-45:21}:"gtk_widget_show_all"
The location is expressed as a half-open range, expressed as a count of bytes,
starting at byte 1 for the initial column. In the above example, bytes 3 through
20 of line 45 of “test.c” are to be replaced with the given string:
00000000011111111112222222222
12345678901234567890123456789
gtk_widget_showall (dlg);
^^^^^^^^^^^^^^^^^^
gtk_widget_show_all
The filename and replacement string escape backslash as “\\", tab as “\t”,
newline as “\n”, double quotes as “\"”, non-printable characters as octal (e.g.
vertical tab as “\013”).
An empty replacement string indicates that the given range is to be removed.
An empty range (e.g. “45:3-45:3”) indicates that the string is to be inserted at
the given position.
-fdiagnostics-generate-patch
Print fix-it hints to stderr in unified diff format, after any diagnostics are
printed. For example:
Chapter 3: GCC Command Options 83
--- test.c
+++ test.c
@ -42,5 +42,5 @
The diff may or may not be colorized, following the same rules as for diagnostics
(see ‘-fdiagnostics-color’).
-fdiagnostics-show-template-tree
In the C++ frontend, when printing diagnostics showing mismatching template
types, such as:
could not convert ’std::map<int, std::vector<double> >()’
from ’map<[...],vector<double>>’ to ’map<[...],vector<float>>
the ‘-fdiagnostics-show-template-tree’ flag enables printing a tree-like
structure showing the common and differing parts of the types, such as:
map<
[...],
vector<
[double != float]>>
The parts that differ are highlighted with color (“double” and “float” in this
case).
-fno-elide-type
By default when the C++ frontend prints diagnostics showing mismatching tem-
plate types, common parts of the types are printed as “[...]” to simplify the
error message. For example:
could not convert ’std::map<int, std::vector<double> >()’
from ’map<[...],vector<double>>’ to ’map<[...],vector<float>>
Specifying the ‘-fno-elide-type’ flag suppresses that behavior. This flag also
affects the output of the ‘-fdiagnostics-show-template-tree’ flag.
-fdiagnostics-path-format=KIND
Specify how to print paths of control-flow events for diagnostics that have such
a path associated with them.
KIND is ‘none’, ‘separate-events’, or ‘inline-events’, the default.
‘none’ means to not print diagnostic paths.
‘separate-events’ means to print a separate “note” diagnostic for each event
within the diagnostic. For example:
test.c:29:5: error: passing NULL as argument 1 to ’PyList_Append’ which re-
quires a non-NULL parameter
test.c:25:10: note: (1) when ’PyList_New’ fails, returning NULL
test.c:27:3: note: (2) when ’i < count’
test.c:29:5: note: (3) when calling ’PyList_Append’, passing NULL from (1) as ar-
gument 1
84 Using the GNU Compiler Collection (GCC)
‘inline-events’ means to print the events “inline” within the source code.
This view attempts to consolidate the events into runs of sufficiently-close
events, printing them as labelled ranges within the source.
For example, the same events as above might be printed as:
’test’: events 1-3
|
| 25 | list = PyList_New(0);
| | ^~~~~~~~~~~~~
| | |
| | (1) when ’PyList_New’ fails, returning NULL
| 26 |
| 27 | for (i = 0; i < count; i++) {
| | ~~~
| | |
| | (2) when ’i < count’
| 28 | item = PyLong_FromLong(random());
| 29 | PyList_Append(list, item);
| | ~~~~~~~~~~~~~~~~~~~~~~~~~
| | |
| | (3) when calling ’PyList_Append’, passing NULL from (1) as ar-
gument 1
|
Interprocedural control flow is shown by grouping the events by stack frame, and
using indentation to show how stack frames are nested, pushed, and popped.
For example:
’test’: events 1-2
|
| 133 | {
| | ^
| | |
| | (1) entering ’test’
| 134 | boxed_int *obj = make_boxed_int (i);
| | ~~~~~~~~~~~~~~~~~~
| | |
| | (2) calling ’make_boxed_int’
|
+--> ’make_boxed_int’: events 3-4
|
| 120 | {
| | ^
| | |
| | (3) entering ’make_boxed_int’
| 121 | boxed_int *result = (boxed_int *)wrapped_malloc (sizeof (boxed_int));
| | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| | |
| | (4) calling ’wrapped_malloc’
|
+--> ’wrapped_malloc’: events 5-6
|
| 7 | {
| | ^
| | |
| | (5) entering ’wrapped_malloc’
| 8 | return malloc (size);
| | ~~~~~~~~~~~~~
| | |
Chapter 3: GCC Command Options 85
-fdiagnostics-show-path-depths
This option provides additional information when printing control-flow paths
associated with a diagnostic.
If this is option is provided then the stack depth will be printed for each run
of events within ‘-fdiagnostics-path-format=inline-events’. If provided
with ‘-fdiagnostics-path-format=separate-events’, then the stack depth
and function declaration will be appended when printing each event.
This is intended for use by GCC developers and plugin developers when debug-
ging diagnostics that report interprocedural control flow.
-fno-show-column
Do not print column numbers in diagnostics. This may be necessary if diag-
nostics are being scanned by a program that does not understand the column
numbers, such as dejagnu.
-fdiagnostics-column-unit=UNIT
Select the units for the column number. This affects traditional diagnostics
(in the absence of ‘-fno-show-column’), as well as JSON format diagnostics if
requested.
The default UNIT, ‘display’, considers the number of display columns occupied
by each character. This may be larger than the number of bytes required to
encode the character, in the case of tab characters, or it may be smaller, in
the case of multibyte characters. For example, the character “GREEK SMALL
LETTER PI (U+03C0)” occupies one display column, and its UTF-8 encoding
requires two bytes; the character “SLIGHTLY SMILING FACE (U+1F642)”
occupies two display columns, and its UTF-8 encoding requires four bytes.
Setting UNIT to ‘byte’ changes the column number to the raw byte count in
all cases, as was traditionally output by GCC prior to version 11.1.0.
-fdiagnostics-column-origin=ORIGIN
Select the origin for column numbers, i.e. the column number assigned to the
first column. The default value of 1 corresponds to traditional GCC behavior
and to the GNU style guide. Some utilities may perform better with an origin
of 0; any non-negative value may be specified.
-fdiagnostics-escape-format=FORMAT
When GCC prints pertinent source lines for a diagnostic it normally attempts
to print the source bytes directly. However, some diagnostics relate to encoding
86 Using the GNU Compiler Collection (GCC)
issues in the source file, such as malformed UTF-8, or issues with Unicode
normalization. These diagnostics are flagged so that GCC will escape bytes
that are not printable ASCII when printing their pertinent source lines.
This option controls how such bytes should be escaped.
The default FORMAT, ‘unicode’ displays Unicode characters that are not
printable ASCII in the form ‘<U+XXXX>’, and bytes that do not correspond
to a Unicode character validly-encoded in UTF-8-encoded will be displayed as
hexadecimal in the form ‘<XX>’.
For example, a source line containing the string ‘before’ followed by the Uni-
code character U+03C0 (“GREEK SMALL LETTER PI”, with UTF-8 encoding
0xCF 0x80) followed by the byte 0xBF (a stray UTF-8 trailing byte), followed
by the string ‘after’ will be printed for such a diagnostic as:
before<U+03C0><BF>after
Setting FORMAT to ‘bytes’ will display all non-printable-ASCII bytes in the
form ‘<XX>’, thus showing the underlying encoding of non-ASCII Unicode char-
acters. For the example above, the following will be printed:
before<CF><80><BF>after
-fdiagnostics-format=FORMAT
Select a different format for printing diagnostics. FORMAT is ‘text’,
‘sarif-stderr’, ‘sarif-file’, ‘json’, ‘json-stderr’, or ‘json-file’.
The default is ‘text’.
The ‘sarif-stderr’ and ‘sarif-file’ formats both emit diagnostics in SARIF
Version 2.1.0 format, either to stderr, or to a file named ‘source.sarif’, re-
spectively.
The ‘json’ format is a synonym for ‘json-stderr’. The ‘json-stderr’ and
‘json-file’ formats are identical, apart from where the JSON is emitted to -
with the former, the JSON is emitted to stderr, whereas with ‘json-file’ it is
written to ‘source.gcc.json’.
The emitted JSON consists of a top-level JSON array containing JSON ob-
jects representing the diagnostics. The JSON is emitted as one line, without
formatting; the examples below have been formatted for clarity.
Diagnostics can have child diagnostics. For example, this error and note:
misleading-indentation.c:15:3: warning: this ’if’ clause does not
guard... [-Wmisleading-indentation]
15 | if (flag)
| ^~
misleading-indentation.c:17:5: note: ...this statement, but the latter
is misleadingly indented as if it were guarded by the ’if’
17 | y = 2;
| ^
might be printed in JSON form (after formatting) like this:
[
{
"kind": "warning",
"locations": [
{
"caret": {
Chapter 3: GCC Command Options 87
"display-column": 3,
"byte-column": 3,
"column": 3,
"file": "misleading-indentation.c",
"line": 15
},
"finish": {
"display-column": 4,
"byte-column": 4,
"column": 4,
"file": "misleading-indentation.c",
"line": 15
}
}
],
"message": "this \u2018if\u2019 clause does not guard...",
"option": "-Wmisleading-indentation",
"option_url": "https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html#index-
Wmisleading-indentation",
"children": [
{
"kind": "note",
"locations": [
{
"caret": {
"display-column": 5,
"byte-column": 5,
"column": 5,
"file": "misleading-indentation.c",
"line": 17
}
}
],
"escape-source": false,
"message": "...this statement, but the latter is ..."
}
]
"escape-source": false,
"column-origin": 1,
}
]
where the note is a child of the warning.
A diagnostic has a kind. If this is warning, then there is an option key
describing the command-line option controlling the warning.
A diagnostic can contain zero or more locations. Each location has an optional
label string and up to three positions within it: a caret position and optional
start and finish positions. A position is described by a file name, a line
number, and three numbers indicating a column position:
• display-column counts display columns, accounting for tabs and multi-
byte characters.
• byte-column counts raw bytes.
• column is equal to one of the previous two, as dictated by the
‘-fdiagnostics-column-unit’ option.
88 Using the GNU Compiler Collection (GCC)
| color
might be printed in JSON form as:
{
"children": [],
"fixits": [
{
"next": {
"column": 21,
"file": "demo.c",
"line": 8
},
"start": {
"column": 15,
"file": "demo.c",
"line": 8
},
"string": "color"
}
],
"kind": "error",
"locations": [
{
"caret": {
"column": 15,
"file": "demo.c",
"line": 8
},
"finish": {
"column": 20,
"file": "demo.c",
"line": 8
}
}
],
"escape-source": false,
"message": "\u2018struct s\u2019 has no member named ..."
}
where the fix-it hint suggests replacing the text from start up to but not
including next with string’s value. Deletions are expressed via an empty
value for string, insertions by having start equal next.
If the diagnostic has a path of control-flow events associated with it, it has
a path array of objects representing the events. Each event object has a
description string, a location object, along with a function string and a
depth number for representing interprocedural paths. The function represents
the current function at that event, and the depth represents the stack depth
relative to some baseline: the higher, the more frames are within the stack.
For example, the intraprocedural example shown for ‘-fdiagnostics-path-format=’
might have this JSON for its path:
"path": [
{
"depth": 0,
"description": "when ’PyList_New’ fails, returning NULL",
"function": "test",
"location": {
90 Using the GNU Compiler Collection (GCC)
"column": 10,
"file": "test.c",
"line": 25
}
},
{
"depth": 0,
"description": "when ’i < count’",
"function": "test",
"location": {
"column": 3,
"file": "test.c",
"line": 27
}
},
{
"depth": 0,
"description": "when calling ’PyList_Append’, passing NULL from (1) as ar-
gument 1",
"function": "test",
"location": {
"column": 5,
"file": "test.c",
"line": 29
}
}
]
Diagnostics have a boolean attribute escape-source, hinting whether non-
ASCII bytes should be escaped when printing the pertinent lines of source code
(true for diagnostics involving source encoding issues).
the required version of ISO C). However, without this option, certain GNU
extensions and traditional C and C++ features are supported as well. With this
option, they are rejected.
‘-Wpedantic’ does not cause warning messages for use of the alternate keywords
whose names begin and end with ‘__’. This alternate format can also be used to
disable warnings for non-ISO ‘__intN’ types, i.e. ‘__intN__’. Pedantic warn-
ings are also disabled in the expression that follows __extension__. However,
only system header files should use these escape routes; application programs
should avoid them. See Section 6.48 [Alternate Keywords], page 710.
Some users try to use ‘-Wpedantic’ to check programs for strict ISO C con-
formance. They soon find that it does not do quite what they want: it finds
some non-ISO practices, but not all—only those for which ISO C requires a
diagnostic, and some others for which diagnostics have been added.
A feature to report any failure to conform to ISO C might be useful in some
instances, but would require considerable additional work and would be quite
different from ‘-Wpedantic’. We don’t have plans to support such a feature in
the near future.
Where the standard specified with ‘-std’ represents a GNU extended dialect
of C, such as ‘gnu90’ or ‘gnu99’, there is a corresponding base standard, the
version of ISO C on which the GNU extended dialect is based. Warnings from
‘-Wpedantic’ are given where they are required by the base standard. (It
does not make sense for such warnings to be given only for features not in the
specified GNU C dialect, since by definition the GNU dialects of C include
all features the compiler supports with the given option, and there would be
nothing to warn about.)
-pedantic-errors
Give an error whenever the base standard (see ‘-Wpedantic’) requires a diag-
nostic, in some cases where there is undefined behavior at compile-time and in
some other cases that do not prevent compilation of programs that are valid
according to the standard. This is not equivalent to ‘-Werror=pedantic’, since
there are errors enabled by this option and not enabled by the latter and vice
versa.
-Wall This enables all the warnings about constructions that some users consider
questionable, and that are easy to avoid (or modify to prevent the warning),
even in conjunction with macros. This also enables some language-specific
warnings described in Section 3.5 [C++ Dialect Options], page 51 and Section 3.6
[Objective-C and Objective-C++ Dialect Options], page 74.
‘-Wall’ turns on the following warning flags:
-Waddress
-Warray-bounds=1 (only with ‘-O2’)
-Warray-compare
-Warray-parameter=2 (C and Objective-C only)
-Wbool-compare
-Wbool-operation
-Wc++11-compat -Wc++14-compat
-Wcatch-value (C++ and Objective-C++ only)
Chapter 3: GCC Command Options 93
-Wchar-subscripts
-Wcomment
-Wdangling-pointer=2
-Wduplicate-decl-specifier (C and Objective-C only)
-Wenum-compare (in C/ObjC; this is on by default in C++)
-Wenum-int-mismatch (C and Objective-C only)
-Wformat
-Wformat-overflow
-Wformat-truncation
-Wint-in-bool-context
-Wimplicit (C and Objective-C only)
-Wimplicit-int (C and Objective-C only)
-Wimplicit-function-declaration (C and Objective-C only)
-Winit-self (only for C++)
-Wlogical-not-parentheses
-Wmain (only for C/ObjC and unless ‘-ffreestanding’)
-Wmaybe-uninitialized
-Wmemset-elt-size
-Wmemset-transposed-args
-Wmisleading-indentation (only for C/C++)
-Wmismatched-dealloc
-Wmismatched-new-delete (only for C/C++)
-Wmissing-attributes
-Wmissing-braces (only for C/ObjC)
-Wmultistatement-macros
-Wnarrowing (only for C++)
-Wnonnull
-Wnonnull-compare
-Wopenmp-simd
-Wparentheses
-Wpessimizing-move (only for C++)
-Wpointer-sign
-Wrange-loop-construct (only for C++)
-Wreorder
-Wrestrict
-Wreturn-type
-Wsequence-point
-Wsign-compare (only in C++)
-Wsizeof-array-div
-Wsizeof-pointer-div
-Wsizeof-pointer-memaccess
-Wstrict-aliasing
-Wstrict-overflow=1
-Wswitch
-Wtautological-compare
-Wtrigraphs
-Wuninitialized
-Wunknown-pragmas
-Wunused-function
-Wunused-label
-Wunused-value
-Wunused-variable
-Wuse-after-free=3
-Wvla-parameter (C and Objective-C only)
-Wvolatile-register-var
-Wzero-length-bounds
Note that some warning flags are not implied by ‘-Wall’. Some of them warn
about constructions that users generally do not consider questionable, but which
94 Using the GNU Compiler Collection (GCC)
occasionally you might wish to check for; others warn about constructions that
are necessary or hard to avoid in some cases, and there is no simple way to mod-
ify the code to suppress the warning. Some of them are enabled by ‘-Wextra’
but many of them must be enabled individually.
-Wextra This enables some extra warning flags that are not enabled by ‘-Wall’. (This
option used to be called ‘-W’. The older name is still supported, but the newer
name is more descriptive.)
-Wclobbered
-Wcast-function-type
-Wdeprecated-copy (C++ only)
-Wempty-body
-Wenum-conversion (C only)
-Wignored-qualifiers
-Wimplicit-fallthrough=3
-Wmissing-field-initializers
-Wmissing-parameter-type (C only)
-Wold-style-declaration (C only)
-Woverride-init
-Wsign-compare (C only)
-Wstring-compare
-Wredundant-move (only for C++)
-Wtype-limits
-Wuninitialized
-Wshift-negative-value (in C++11 to C++17 and in C99 and newer)
-Wunused-parameter (only with ‘-Wunused’ or ‘-Wall’)
-Wunused-but-set-parameter (only with ‘-Wunused’ or ‘-Wall’)
The option ‘-Wextra’ also prints warning messages for the following cases:
• A pointer is compared against integer zero with <, <=, >, or >=.
• (C++ only) An enumerator and a non-enumerator both appear in a condi-
tional expression.
• (C++ only) Ambiguous virtual bases.
• (C++ only) Subscripting an array that has been declared register.
• (C++ only) Taking the address of a variable that has been declared
register.
• (C++ only) A base class is not initialized in the copy constructor of a derived
class.
-Wabi (C, Objective-C, C++ and Objective-C++ only)
Warn about code affected by ABI changes. This includes code that may not
be compatible with the vendor-neutral C++ ABI as well as the psABI for the
particular target.
Since G++ now defaults to updating the ABI with each major release, normally
‘-Wabi’ warns only about C++ ABI compatibility problems if there is a check
added later in a release series for an ABI issue discovered since the initial
release. ‘-Wabi’ warns about more things if an older ABI version is selected
(with ‘-fabi-version=n’).
‘-Wabi’ can also be used with an explicit version number to warn about C++
ABI compatibility with a particular ‘-fabi-version’ level, e.g. ‘-Wabi=2’ to
warn about changes relative to ‘-fabi-version=2’.
Chapter 3: GCC Command Options 95
the compiler performs the entire computation with double because the floating-
point literal is a double.
-Wformat
-Wformat=n
Check calls to printf and scanf, etc., to make sure that the arguments supplied
have types appropriate to the format string specified, and that the conversions
specified in the format string make sense. This includes standard functions, and
others specified by format attributes (see Section 6.33 [Function Attributes],
page 556), in the printf, scanf, strftime and strfmon (an X/Open exten-
sion, not in the C standard) families (or other target-specific families). Which
functions are checked without format attributes having been specified depends
on the standard version selected, and such checks of functions without the at-
tribute specified are disabled by ‘-ffreestanding’ or ‘-fno-builtin’.
The formats are checked against the format features supported by GNU libc
version 2.2. These include all ISO C90 and C99 features, as well as features
from the Single Unix Specification and some BSD and GNU extensions. Other
library implementations may not support all these features; GCC does not sup-
port warning about features that go beyond a particular library’s limitations.
However, if ‘-Wpedantic’ is used with ‘-Wformat’, warnings are given about
format features not in the selected standard version (but not for strfmon for-
mats, since those are not in any version of the C standard). See Section 3.4
[Options Controlling C Dialect], page 44.
-Wformat=1
-Wformat Option ‘-Wformat’ is equivalent to ‘-Wformat=1’, and
‘-Wno-format’ is equivalent to ‘-Wformat=0’. Since ‘-Wformat’
also checks for null format arguments for several functions,
‘-Wformat’ also implies ‘-Wnonnull’. Some aspects of this
level of format checking can be disabled by the options:
‘-Wno-format-contains-nul’, ‘-Wno-format-extra-args’, and
‘-Wno-format-zero-length’. ‘-Wformat’ is enabled by ‘-Wall’.
-Wformat=2
Enable ‘-Wformat’ plus additional format checks. Currently equiv-
alent to ‘-Wformat -Wformat-nonliteral -Wformat-security
-Wformat-y2k’.
98 Using the GNU Compiler Collection (GCC)
-Wno-format-contains-nul
If ‘-Wformat’ is specified, do not warn about format strings that contain NUL
bytes.
-Wno-format-extra-args
If ‘-Wformat’ is specified, do not warn about excess arguments to a printf
or scanf format function. The C standard specifies that such arguments are
ignored.
Where the unused arguments lie between used arguments that are specified
with ‘$’ operand number specifications, normally warnings are still given, since
the implementation could not know what type to pass to va_arg to skip the
unused arguments. However, in the case of scanf formats, this option sup-
presses the warning if the unused arguments are all pointers, since the Single
Unix Specification says that such unused arguments are allowed.
-Wformat-overflow
-Wformat-overflow=level
Warn about calls to formatted input/output functions such as sprintf and
vsprintf that might overflow the destination buffer. When the exact number
of bytes written by a format directive cannot be determined at compile-time
it is estimated based on heuristics that depend on the level argument and
on optimization. While enabling optimization will in most cases improve the
accuracy of the warning, it may also result in false positives.
-Wformat-overflow
-Wformat-overflow=1
Level 1 of ‘-Wformat-overflow’ enabled by ‘-Wformat’ employs a
conservative approach that warns only about calls that most likely
overflow the buffer. At this level, numeric arguments to format di-
rectives with unknown values are assumed to have the value of one,
and strings of unknown length to be empty. Numeric arguments
that are known to be bounded to a subrange of their type, or string
arguments whose output is bounded either by their directive’s pre-
cision or by a finite set of string literals, are assumed to take on the
value within the range that results in the most bytes on output. For
example, the call to sprintf below is diagnosed because even with
both a and b equal to zero, the terminating NUL character (’\0’)
appended by the function to the destination buffer will be written
past its end. Increasing the size of the buffer by a single byte is
sufficient to avoid the warning, though it may not be sufficient to
avoid the overflow.
void f (int a, int b)
{
char buf [13];
sprintf (buf, "a = %i, b = %i\n", a, b);
}
-Wformat-overflow=2
Level 2 warns also about calls that might overflow the destination
buffer given an argument of sufficient length or magnitude. At level
Chapter 3: GCC Command Options 99
-Wno-format-zero-length
If ‘-Wformat’ is specified, do not warn about zero-length formats. The C stan-
dard specifies that zero-length formats are allowed.
-Wformat-nonliteral
If ‘-Wformat’ is specified, also warn if the format string is not a string literal and
so cannot be checked, unless the format function takes its format arguments as
a va_list.
-Wformat-security
If ‘-Wformat’ is specified, also warn about uses of format functions that repre-
sent possible security problems. At present, this warns about calls to printf
and scanf functions where the format string is not a string literal and there
are no format arguments, as in printf (foo);. This may be a security hole
if the format string came from untrusted input and contains ‘%n’. (This is
currently a subset of what ‘-Wformat-nonliteral’ warns about, but in fu-
ture warnings may be added to ‘-Wformat-security’ that are not included in
‘-Wformat-nonliteral’.)
100 Using the GNU Compiler Collection (GCC)
-Wformat-signedness
If ‘-Wformat’ is specified, also warn if the format string requires an unsigned
argument and the argument is signed and vice versa.
-Wformat-truncation
-Wformat-truncation=level
Warn about calls to formatted input/output functions such as snprintf and
vsnprintf that might result in output truncation. When the exact number
of bytes written by a format directive cannot be determined at compile-time
it is estimated based on heuristics that depend on the level argument and
on optimization. While enabling optimization will in most cases improve the
accuracy of the warning, it may also result in false positives. Except as noted
otherwise, the option uses the same logic ‘-Wformat-overflow’.
-Wformat-truncation
-Wformat-truncation=1
Level 1 of ‘-Wformat-truncation’ enabled by ‘-Wformat’ employs
a conservative approach that warns only about calls to bounded
functions whose return value is unused and that will most likely
result in output truncation.
-Wformat-truncation=2
Level 2 warns also about calls to bounded functions whose return
value is used and that might result in truncation given an argument
of sufficient length or magnitude.
-Wformat-y2k
If ‘-Wformat’ is specified, also warn about strftime formats that may yield
only a two-digit year.
-Wnonnull
Warn about passing a null pointer for arguments marked as requiring a non-null
value by the nonnull function attribute.
‘-Wnonnull’ is included in ‘-Wall’ and ‘-Wformat’. It can be disabled with the
‘-Wno-nonnull’ option.
-Wnonnull-compare
Warn when comparing an argument marked with the nonnull function at-
tribute against null inside the function.
‘-Wnonnull-compare’ is included in ‘-Wall’. It can be disabled with the
‘-Wno-nonnull-compare’ option.
-Wnull-dereference
Warn if the compiler detects paths that trigger erroneous or undefined be-
havior due to dereferencing a null pointer. This option is only active when
‘-fdelete-null-pointer-checks’ is active, which is enabled by optimizations
in most targets. The precision of the warnings depends on the optimization
options used.
Chapter 3: GCC Command Options 101
-Winfinite-recursion
Warn about infinitely recursive calls. The warning is effective at all optimization
levels but requires optimization in order to detect infinite recursion in calls
between two or more functions. ‘-Winfinite-recursion’ is included in ‘-Wall’.
-Winit-self (C, C++, Objective-C and Objective-C++ only)
Warn about uninitialized variables that are initialized with themselves. Note
this option can only be used with the ‘-Wuninitialized’ option.
For example, GCC warns about i being uninitialized in the following snippet
only when ‘-Winit-self’ has been specified:
int f()
{
int i = i;
return i;
}
This warning is enabled by ‘-Wall’ in C++.
-Wno-implicit-int (C and Objective-C only)
This option controls warnings when a declaration does not specify a type. This
warning is enabled by default in C99 and later dialects of C, and also by ‘-Wall’.
-Wno-implicit-function-declaration (C and Objective-C only)
This option controls warnings when a function is used before being declared.
This warning is enabled by default in C99 and later dialects of C, and also by
‘-Wall’. The warning is made into an error by ‘-pedantic-errors’.
-Wimplicit (C and Objective-C only)
Same as ‘-Wimplicit-int’ and ‘-Wimplicit-function-declaration’. This
warning is enabled by ‘-Wall’.
-Wimplicit-fallthrough
‘-Wimplicit-fallthrough’ is the same as ‘-Wimplicit-fallthrough=3’ and
‘-Wno-implicit-fallthrough’ is the same as ‘-Wimplicit-fallthrough=0’.
-Wimplicit-fallthrough=n
Warn when a switch case falls through. For example:
switch (cond)
{
case 1:
a = 1;
break;
case 2:
a = 2;
case 3:
a = 3;
break;
}
This warning does not warn when the last statement of a case cannot fall
through, e.g. when there is a return statement or a call to function declared with
the noreturn attribute. ‘-Wimplicit-fallthrough=’ also takes into account
control flow statements, such as ifs, and only warns when appropriate. E.g.
102 Using the GNU Compiler Collection (GCC)
switch (cond)
{
case 1:
if (i > 3) {
bar (5);
break;
} else if (i < 1) {
bar (0);
} else
return;
default:
...
}
Since there are occasions where a switch case fall through is desirable, GCC
provides an attribute, __attribute__ ((fallthrough)), that is to be used
along with a null statement to suppress this warning that would normally occur:
switch (cond)
{
case 1:
bar (0);
__attribute__ ((fallthrough));
default:
...
}
C++17 provides a standard way to suppress the ‘-Wimplicit-fallthrough’
warning using [[fallthrough]]; instead of the GNU attribute. In C++11 or
C++14 users can use [[gnu::fallthrough]];, which is a GNU extension. In-
stead of these attributes, it is also possible to add a fallthrough comment to
silence the warning. The whole body of the C or C++ style comment should
match the given regular expressions listed below. The option argument n spec-
ifies what kind of comments are accepted:
• ‘-Wimplicit-fallthrough=0’ disables the warning altogether.
• ‘-Wimplicit-fallthrough=1’ matches .* regular expression, any com-
ment is used as fallthrough comment.
• ‘-Wimplicit-fallthrough=2’ case insensitively matches .*falls?[ \t-
]*thr(ough|u).* regular expression.
• ‘-Wimplicit-fallthrough=3’ case sensitively matches one of the following
regular expressions:
• -fallthrough
• @fallthrough@
• lint -fallthrough[ \t]*
• [ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?
FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?
• [ \t.!]*(Else,? |Intentional(ly)? )?
Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?
• [ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?
fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?
Chapter 3: GCC Command Options 103
template <>
void* __attribute__ ((malloc)) // missing alloc_size
allocate<void> (size_t);
-Wmissing-braces
Warn if an aggregate or union initializer is not fully bracketed. In the following
example, the initializer for a is not fully bracketed, but that for b is fully
bracketed.
int a[2][2] = { 0, 1, 2, 3 };
int b[2][2] = { { 0, 1 }, { 2, 3 } };
This warning is enabled by ‘-Wall’.
-Wmissing-include-dirs (C, C++, Objective-C, Objective-C++ and Fortran only)
Warn if a user-supplied include directory does not exist. This opions is dis-
abled by default for C, C++, Objective-C and Objective-C++. For Fortran, it is
partially enabled by default by warning for -I and -J, only.
-Wno-missing-profile
This option controls warnings if feedback profiles are missing when using the
‘-fprofile-use’ option. This option diagnoses those cases where a new func-
tion or a new file is added between compiling with ‘-fprofile-generate’ and
with ‘-fprofile-use’, without regenerating the profiles. In these cases, the
profile feedback data files do not contain any profile feedback information for
the newly added function or file respectively. Also, in the case when profile
count data (.gcda) files are removed, GCC cannot use any profile feedback in-
formation. In all these cases, warnings are issued to inform you that a profile
generation step is due. Ignoring the warning can result in poorly optimized
code. ‘-Wno-missing-profile’ can be used to disable the warning, but this is
not recommended and should be done only when non-existent profile data is
justified.
-Wmismatched-dealloc
Warn for calls to deallocation functions with pointer arguments returned from
from allocations functions for which the former isn’t a suitable deallocator.
A pair of functions can be associated as matching allocators and deallocators
by use of attribute malloc. Unless disabled by the ‘-fno-builtin’ option
the standard functions calloc, malloc, realloc, and free, as well as the
corresponding forms of C++ operator new and operator delete are implicitly
associated as matching allocators and deallocators. In the following example
mydealloc is the deallocator for pointers returned from myalloc.
void mydealloc (void*);
void f (void)
{
void *p = myalloc (32);
106 Using the GNU Compiler Collection (GCC)
// ...use p...
free (p); // warning: not a matching deallocator for myalloc
mydealloc (p); // ok
}
In C++, the related option ‘-Wmismatched-new-delete’ diagnoses mismatches
involving either operator new or operator delete.
Option ‘-Wmismatched-dealloc’ is included in ‘-Wall’.
-Wmultistatement-macros
Warn about unsafe multiple statement macros that appear to be guarded by a
clause such as if, else, for, switch, or while, in which only the first statement
is actually guarded after the macro is expanded.
For example:
#define DOIT x++; y++
if (c)
DOIT;
will increment y unconditionally, not just when c holds. The can usually be
fixed by wrapping the macro in a do-while loop:
#define DOIT do { x++; y++; } while (0)
if (c)
DOIT;
This warning is enabled by ‘-Wall’ in C and C++.
-Wparentheses
Warn if parentheses are omitted in certain contexts, such as when there is an
assignment in a context where a truth value is expected, or when operators are
nested whose precedence people often get confused about.
Also warn if a comparison like x<=y<=z appears; this is equivalent to (x<=y ? 1
: 0) <= z, which is a different interpretation from that of ordinary mathemat-
ical notation.
Also warn for dangerous uses of the GNU extension to ?: with omitted middle
operand. When the condition in the ?: operator is a boolean expression, the
omitted value is always 1. Often programmers expect it to be a value computed
inside the conditional expression instead.
For C++ this also warns for some cases of unnecessary parentheses in declara-
tions, which can indicate an attempt at a function call instead of a declaration:
{
// Declares a local variable called mymutex.
std::unique_lock<std::mutex> (mymutex);
// User meant std::unique_lock<std::mutex> lock (mymutex);
}
This warning is enabled by ‘-Wall’.
-Wsequence-point
Warn about code that may have undefined semantics because of violations of
sequence point rules in the C and C++ standards.
The C and C++ standards define the order in which expressions in a C/C++
program are evaluated in terms of sequence points, which represent a partial
ordering between the execution of parts of the program: those executed before
Chapter 3: GCC Command Options 107
the sequence point, and those executed after it. These occur after the evalua-
tion of a full expression (one which is not part of a larger expression), after the
evaluation of the first operand of a &&, ||, ? : or , (comma) operator, before a
function is called (but after the evaluation of its arguments and the expression
denoting the called function), and in certain other places. Other than as ex-
pressed by the sequence point rules, the order of evaluation of subexpressions
of an expression is not specified. All these rules describe only a partial order
rather than a total order, since, for example, if two functions are called within
one expression with no sequence point between them, the order in which the
functions are called is not specified. However, the standards committee have
ruled that function calls do not overlap.
It is not specified when between sequence points modifications to the values of
objects take effect. Programs whose behavior depends on this have undefined
behavior; the C and C++ standards specify that “Between the previous and
next sequence point an object shall have its stored value modified at most once
by the evaluation of an expression. Furthermore, the prior value shall be read
only to determine the value to be stored.”. If a program breaks these rules, the
results on any particular implementation are entirely unpredictable.
Examples of code with undefined behavior are a = a++;, a[n] = b[n++] and
a[i++] = i;. Some more complicated cases are not diagnosed by this option,
and it may give an occasional false positive result, but in general it has been
found fairly effective at detecting this sort of problem in programs.
The C++17 standard will define the order of evaluation of operands in more
cases: in particular it requires that the right-hand side of an assignment be
evaluated before the left-hand side, so the above examples are no longer unde-
fined. But this option will still warn about them, to help people avoid writing
code that is undefined in C and earlier revisions of C++.
The standard is worded confusingly, therefore there is some debate over the
precise meaning of the sequence point rules in subtle cases. Links to discussions
of the problem, including proposed formal definitions, may be found on the GCC
readings page, at https://gcc.gnu.org/readings.html.
This warning is enabled by ‘-Wall’ for C and C++.
-Wno-return-local-addr
Do not warn about returning a pointer (or in C++, a reference) to a variable
that goes out of scope after the function returns.
-Wreturn-type
Warn whenever a function is defined with a return type that defaults to int.
Also warn about any return statement with no return value in a function whose
return type is not void (falling off the end of the function body is considered
returning without a value).
For C only, warn about a return statement with an expression in a function
whose return type is void, unless the expression type is also void. As a GNU
extension, the latter case is accepted without a warning unless ‘-Wpedantic’ is
used. Attempting to use the return value of a non-void function other than
108 Using the GNU Compiler Collection (GCC)
main that flows off the end by reaching the closing curly brace that terminates
the function is undefined.
Unlike in C, in C++, flowing off the end of a non-void function other than main
results in undefined behavior even when the value of the function is not used.
This warning is enabled by default in C++ and by ‘-Wall’ otherwise.
-Wno-shift-count-negative
Controls warnings if a shift count is negative. This warning is enabled by
default.
-Wno-shift-count-overflow
Controls warnings if a shift count is greater than or equal to the bit width of
the type. This warning is enabled by default.
-Wshift-negative-value
Warn if left shifting a negative value. This warning is enabled by ‘-Wextra’ in
C99 (and newer) and C++11 to C++17 modes.
-Wno-shift-overflow
-Wshift-overflow=n
These options control warnings about left shift overflows.
-Wshift-overflow=1
This is the warning level of ‘-Wshift-overflow’ and is enabled by
default in C99 and C++11 modes (and newer). This warning level
does not warn about left-shifting 1 into the sign bit. (However, in
C, such an overflow is still rejected in contexts where an integer
constant expression is required.) No warning is emitted in C++20
mode (and newer), as signed left shifts always wrap.
-Wshift-overflow=2
This warning level also warns about left-shifting 1 into the sign bit,
unless C++14 mode (or newer) is active.
-Wswitch Warn whenever a switch statement has an index of enumerated type and lacks
a case for one or more of the named codes of that enumeration. (The presence
of a default label prevents this warning.) case labels outside the enumeration
range also provoke warnings when this option is used (even if there is a default
label). This warning is enabled by ‘-Wall’.
-Wswitch-default
Warn whenever a switch statement does not have a default case.
-Wswitch-enum
Warn whenever a switch statement has an index of enumerated type and lacks
a case for one or more of the named codes of that enumeration. case labels
outside the enumeration range also provoke warnings when this option is used.
The only difference between ‘-Wswitch’ and this option is that this option gives
a warning about an omitted enumeration code even if there is a default label.
-Wno-switch-bool
Do not warn when a switch statement has an index of boolean type and the
case values are outside the range of a boolean type. It is possible to suppress
Chapter 3: GCC Command Options 109
this warning by casting the controlling expression to a type other than bool.
For example:
switch ((int) (a == 4))
{
...
}
This warning is enabled by default for C and C++ programs.
-Wno-switch-outside-range
This option controls warnings when a switch case has a value that is outside
of its respective type range. This warning is enabled by default for C and C++
programs.
-Wno-switch-unreachable
Do not warn when a switch statement contains statements between the con-
trolling expression and the first case label, which will never be executed. For
example:
switch (cond)
{
i = 15;
...
case 5:
...
}
‘-Wswitch-unreachable’ does not warn if the statement between the control-
ling expression and the first case label is just a declaration:
switch (cond)
{
int i;
...
case 5:
i = 5;
...
}
This warning is enabled by default for C and C++ programs.
-Wsync-nand (C and C++ only)
Warn when __sync_fetch_and_nand and __sync_nand_and_fetch built-in
functions are used. These functions changed semantics in GCC 4.4.
-Wtrivial-auto-var-init
Warn when -ftrivial-auto-var-init cannot initialize the automatic vari-
able. A common situation is an automatic variable that is declared between
the controlling expression and the first case label of a switch statement.
-Wunused-but-set-parameter
Warn whenever a function parameter is assigned to, but otherwise unused (aside
from its declaration).
To suppress this warning use the unused attribute (see Section 6.34 [Variable
Attributes], page 622).
This warning is also enabled by ‘-Wunused’ together with ‘-Wextra’.
110 Using the GNU Compiler Collection (GCC)
-Wunused-but-set-variable
Warn whenever a local variable is assigned to, but otherwise unused (aside from
its declaration). This warning is enabled by ‘-Wall’.
To suppress this warning use the unused attribute (see Section 6.34 [Variable
Attributes], page 622).
This warning is also enabled by ‘-Wunused’, which is enabled by ‘-Wall’.
-Wunused-function
Warn whenever a static function is declared but not defined or a non-inline
static function is unused. This warning is enabled by ‘-Wall’.
-Wunused-label
Warn whenever a label is declared but not used. This warning is enabled by
‘-Wall’.
To suppress this warning use the unused attribute (see Section 6.34 [Variable
Attributes], page 622).
-Wunused-local-typedefs (C, Objective-C, C++ and Objective-C++ only)
Warn when a typedef locally defined in a function is not used. This warning is
enabled by ‘-Wall’.
-Wunused-parameter
Warn whenever a function parameter is unused aside from its declaration.
To suppress this warning use the unused attribute (see Section 6.34 [Variable
Attributes], page 622).
-Wno-unused-result
Do not warn if a caller of a function marked with attribute warn_unused_
result (see Section 6.33 [Function Attributes], page 556) does not use its return
value. The default is ‘-Wunused-result’.
-Wunused-variable
Warn whenever a local or static variable is unused aside from its declaration.
This option implies ‘-Wunused-const-variable=1’ for C, but not for C++. This
warning is enabled by ‘-Wall’.
To suppress this warning use the unused attribute (see Section 6.34 [Variable
Attributes], page 622).
-Wunused-const-variable
-Wunused-const-variable=n
Warn whenever a constant static variable is unused aside from its declaration.
‘-Wunused-const-variable=1’ is enabled by ‘-Wunused-variable’ for C, but
not for C++. In C this declares variable storage, but in C++ this is not an error
since const variables take the place of #defines.
To suppress this warning use the unused attribute (see Section 6.34 [Variable
Attributes], page 622).
-Wunused-const-variable=1
This is the warning level that is enabled by ‘-Wunused-variable’
for C. It warns only about unused static const variables defined
Chapter 3: GCC Command Options 111
in the main compilation unit, but not about static const variables
declared in any header included.
-Wunused-const-variable=2
This warning level also warns for unused constant static variables
in headers (excluding system headers). This is the warning level
of ‘-Wunused-const-variable’ and must be explicitly requested
since in C++ this isn’t an error and in C it might be harder to clean
up all headers included.
-Wunused-value
Warn whenever a statement computes a result that is explicitly not used. To
suppress this warning cast the unused expression to void. This includes an
expression-statement or the left-hand side of a comma expression that contains
no side effects. For example, an expression such as x[i,j] causes a warning,
while x[(void)i,j] does not.
This warning is enabled by ‘-Wall’.
-Wunused All the above ‘-Wunused’ options combined.
In order to get a warning about an unused function parameter, you must either
specify ‘-Wextra -Wunused’ (note that ‘-Wall’ implies ‘-Wunused’), or sepa-
rately specify ‘-Wunused-parameter’.
-Wuninitialized
Warn if an object with automatic or allocated storage duration is used without
having been initialized. In C++, also warn if a non-static reference or non-static
const member appears in a class without constructors.
In addition, passing a pointer (or in C++, a reference) to an uninitialized object
to a const-qualified argument of a built-in function known to read the object
is also diagnosed by this warning. (‘-Wmaybe-uninitialized’ is issued for
ordinary functions.)
If you want to warn about code that uses the uninitialized value of the variable
in its own initializer, use the ‘-Winit-self’ option.
These warnings occur for individual uninitialized elements of structure, union
or array variables as well as for variables that are uninitialized as a whole.
They do not occur for variables or elements declared volatile. Because these
warnings depend on optimization, the exact variables or elements for which
there are warnings depend on the precise optimization options and version of
GCC used.
Note that there may be no warning about a variable that is used only to compute
a value that itself is never used, because such computations may be deleted by
data flow analysis before the warnings are printed.
In C++, this warning also warns about using uninitialized objects in member-
initializer-lists. For example, GCC warns about b being uninitialized in the
following snippet:
struct A {
int a;
int b;
112 Using the GNU Compiler Collection (GCC)
A() : a(b) { }
};
-Wno-invalid-memory-model
This option controls warnings for invocations of Section 6.55 [ atomic Builtins],
page 719, Section 6.54 [ sync Builtins], page 717, and the C11 atomic generic
functions with a memory consistency argument that is either invalid for the
operation or outside the range of values of the memory_order enumeration. For
example, since the __atomic_store and __atomic_store_n built-ins are only
defined for the relaxed, release, and sequentially consistent memory orders the
following code is diagnosed:
void store (int *i)
{
__atomic_store_n (i, 0, memory_order_consume);
}
‘-Winvalid-memory-model’ is enabled by default.
-Wmaybe-uninitialized
For an object with automatic or allocated storage duration, if there exists a
path from the function entry to a use of the object that is initialized, but there
exist some other paths for which the object is not initialized, the compiler emits
a warning if it cannot prove the uninitialized paths are not executed at run time.
In addition, passing a pointer (or in C++, a reference) to an uninitialized ob-
ject to a const-qualified function argument is also diagnosed by this warning.
(‘-Wuninitialized’ is issued for built-in functions known to read the object.)
Annotating the function with attribute access (none) indicates that the argu-
ment isn’t used to access the object and avoids the warning (see Section 6.33.1
[Common Function Attributes], page 557).
These warnings are only possible in optimizing compilation, because otherwise
GCC does not keep track of the state of variables.
These warnings are made optional because GCC may not be able to determine
when the code is correct in spite of appearing to have an error. Here is one
example of how this can happen:
{
int x;
switch (y)
{
case 1: x = 1;
break;
case 2: x = 4;
break;
case 3: x = 5;
}
foo (x);
}
If the value of y is always 1, 2 or 3, then x is always initialized, but GCC doesn’t
know this. To suppress the warning, you need to provide a default case with
assert(0) or similar code.
This option also warns when a non-volatile automatic variable might be changed
by a call to longjmp. The compiler sees only the calls to setjmp. It cannot
Chapter 3: GCC Command Options 113
know where longjmp will be called; in fact, a signal handler could call it at any
point in the code. As a result, you may get a warning even when there is in fact
no problem because longjmp cannot in fact be called at the place that would
cause a problem.
Some spurious warnings can be avoided if you declare all the functions you
use that never return as noreturn. See Section 6.33 [Function Attributes],
page 556.
This warning is enabled by ‘-Wall’ or ‘-Wextra’.
-Wunknown-pragmas
Warn when a #pragma directive is encountered that is not understood by GCC.
If this command-line option is used, warnings are even issued for unknown
pragmas in system header files. This is not the case if the warnings are only
enabled by the ‘-Wall’ command-line option.
-Wno-pragmas
Do not warn about misuses of pragmas, such as incorrect parameters, invalid
syntax, or conflicts between pragmas. See also ‘-Wunknown-pragmas’.
-Wno-prio-ctor-dtor
Do not warn if a priority from 0 to 100 is used for constructor or destructor.
The use of constructor and destructor attributes allow you to assign a priority
to the constructor/destructor to control its order of execution before main is
called or after it returns. The priority values must be greater than 100 as the
compiler reserves priority values between 0–100 for the implementation.
-Wstrict-aliasing
This option is only active when ‘-fstrict-aliasing’ is active. It warns about
code that might break the strict aliasing rules that the compiler is using for
optimization. The warning does not catch all cases, but does attempt to
catch the more common pitfalls. It is included in ‘-Wall’. It is equivalent
to ‘-Wstrict-aliasing=3’
-Wstrict-aliasing=n
This option is only active when ‘-fstrict-aliasing’ is active. It warns about
code that might break the strict aliasing rules that the compiler is using for op-
timization. Higher levels correspond to higher accuracy (fewer false positives).
Higher levels also correspond to more effort, similar to the way ‘-O’ works.
‘-Wstrict-aliasing’ is equivalent to ‘-Wstrict-aliasing=3’.
Level 1: Most aggressive, quick, least accurate. Possibly useful when higher
levels do not warn but ‘-fstrict-aliasing’ still breaks the code, as it has very
few false negatives. However, it has many false positives. Warns for all pointer
conversions between possibly incompatible types, even if never dereferenced.
Runs in the front end only.
Level 2: Aggressive, quick, not too precise. May still have many false positives
(not as many as level 1 though), and few false negatives (but possibly more
than level 1). Unlike level 1, it only warns when an address is taken. Warns
about incomplete types. Runs in the front end only.
114 Using the GNU Compiler Collection (GCC)
Level 3 (default for ‘-Wstrict-aliasing’): Should have very few false positives
and few false negatives. Slightly slower than levels 1 or 2 when optimization
is enabled. Takes care of the common pun+dereference pattern in the front
end: *(int*)&some_float. If optimization is enabled, it also runs in the back
end, where it deals with multiple statement cases using flow-sensitive points-to
information. Only warns when the converted pointer is dereferenced. Does not
warn about incomplete types.
-Wstrict-overflow
-Wstrict-overflow=n
This option is only active when signed overflow is undefined. It warns about
cases where the compiler optimizes based on the assumption that signed over-
flow does not occur. Note that it does not warn about all cases where the code
might overflow: it only warns about cases where the compiler implements some
optimization. Thus this warning depends on the optimization level.
An optimization that assumes that signed overflow does not occur is perfectly
safe if the values of the variables involved are such that overflow never does, in
fact, occur. Therefore this warning can easily give a false positive: a warning
about code that is not actually a problem. To help focus on important issues,
several warning levels are defined. No warnings are issued for the use of unde-
fined signed overflow when estimating how many iterations a loop requires, in
particular when determining whether a loop will be executed at all.
-Wstrict-overflow=1
Warn about cases that are both questionable and easy to avoid.
For example the compiler simplifies x + 1 > x to 1. This level of
‘-Wstrict-overflow’ is enabled by ‘-Wall’; higher levels are not,
and must be explicitly requested.
-Wstrict-overflow=2
Also warn about other cases where a comparison is simplified to a
constant. For example: abs (x) >= 0. This can only be simplified
when signed integer overflow is undefined, because abs (INT_MIN)
overflows to INT_MIN, which is less than zero. ‘-Wstrict-overflow’
(with no level) is the same as ‘-Wstrict-overflow=2’.
-Wstrict-overflow=3
Also warn about other cases where a comparison is simplified. For
example: x + 1 > 1 is simplified to x > 0.
-Wstrict-overflow=4
Also warn about other simplifications not covered by the above
cases. For example: (x * 10) / 5 is simplified to x * 2.
-Wstrict-overflow=5
Also warn about cases where the compiler reduces the magnitude
of a constant involved in a comparison. For example: x + 2 > y is
simplified to x + 1 >= y. This is reported only at the highest warn-
ing level because this simplification applies to many comparisons,
so this warning level gives a very large number of false positives.
Chapter 3: GCC Command Options 115
-Wstring-compare
Warn for calls to strcmp and strncmp whose result is determined to be either
zero or non-zero in tests for such equality owing to the length of one argument
being greater than the size of the array the other argument is stored in (or the
bound in the case of strncmp). Such calls could be mistakes. For example,
the call to strcmp below is diagnosed because its result is necessarily non-zero
irrespective of the contents of the array a.
extern char a[4];
void f (char *d)
{
strcpy (d, "string");
...
if (0 == strcmp (a, d)) // cannot be true
puts ("a and d are the same");
}
-Wno-stringop-overflow
-Wstringop-overflow
-Wstringop-overflow=type
Warn for calls to string manipulation functions such as memcpy and strcpy
that are determined to overflow the destination buffer. The optional argument
is one greater than the type of Object Size Checking to perform to determine
the size of the destination. See Section 6.58 [Object Size Checking], page 726.
The argument is meaningful only for functions that operate on character arrays
but not for raw memory functions like memcpy which always make use of Object
Size type-0. The option also warns for calls that specify a size in excess of the
largest possible object or at most SIZE_MAX / 2 bytes. The option produces
the best results with optimization enabled but can detect a small subset of
simple buffer overflows even without optimization in calls to the GCC built-in
functions like __builtin_memcpy that correspond to the standard functions. In
any case, the option warns about just a subset of buffer overflows detected by
the corresponding overflow checking built-ins. For example, the option issues a
warning for the strcpy call below because it copies at least 5 characters (the
string "blue" including the terminating NUL) into the buffer of size 4.
enum Color { blue, purple, yellow };
const char* f (enum Color clr)
{
static char buf [4];
const char *str;
switch (clr)
{
case blue: str = "blue"; break;
case purple: str = "purple"; break;
case yellow: str = "yellow"; break;
}
-Wstringop-overflow
-Wstringop-overflow=1
The ‘-Wstringop-overflow=1’ option uses type-zero Object Size
Checking to determine the sizes of destination objects. At this set-
ting the option does not warn for writes past the end of subobjects
of larger objects accessed by pointers unless the size of the largest
surrounding object is known. When the destination may be one
of several objects it is assumed to be the largest one of them. On
Linux systems, when optimization is enabled at this setting the op-
tion warns for the same code as when the _FORTIFY_SOURCE macro
is defined to a non-zero value.
-Wstringop-overflow=2
The ‘-Wstringop-overflow=2’ option uses type-one Object Size
Checking to determine the sizes of destination objects. At this set-
ting the option warns about overflows when writing to members of
the largest complete objects whose exact size is known. However, it
does not warn for excessive writes to the same members of unknown
objects referenced by pointers since they may point to arrays con-
taining unknown numbers of elements. This is the default setting
of the option.
-Wstringop-overflow=3
The ‘-Wstringop-overflow=3’ option uses type-two Object Size
Checking to determine the sizes of destination objects. At this
setting the option warns about overflowing the smallest object or
data member. This is the most restrictive setting of the option that
may result in warnings for safe code.
-Wstringop-overflow=4
The ‘-Wstringop-overflow=4’ option uses type-three Object Size
Checking to determine the sizes of destination objects. At this
setting the option warns about overflowing any data members, and
when the destination is one of several objects it uses the size of the
largest of them to decide whether to issue a warning. Similarly to
‘-Wstringop-overflow=3’ this setting of the option may result in
warnings for benign code.
-Wno-stringop-overread
Warn for calls to string manipulation functions such as memchr, or strcpy that
are determined to read past the end of the source sequence.
Option ‘-Wstringop-overread’ is enabled by default.
-Wno-stringop-truncation
Do not warn for calls to bounded string manipulation functions such as strncat,
strncpy, and stpncpy that may either truncate the copied string or leave the
destination unchanged.
In the following example, the call to strncat specifies a bound that is less
than the length of the source string. As a result, the copy of the source will
Chapter 3: GCC Command Options 117
be truncated and so the call is diagnosed. To avoid the warning use bufsize -
strlen (buf) - 1) as the bound.
void append (char *buf, size_t bufsize)
{
strncat (buf, ".txt", 3);
}
As another example, the following call to strncpy results in copying to d just
the characters preceding the terminating NUL, without appending the NUL
to the end. Assuming the result of strncpy is necessarily a NUL-terminated
string is a common mistake, and so the call is diagnosed. To avoid the warning
when the result is not expected to be NUL-terminated, call memcpy instead.
void copy (char *d, const char *s)
{
strncpy (d, s, strlen (s));
}
In the following example, the call to strncpy specifies the size of the destination
buffer as the bound. If the length of the source string is equal to or greater
than this size the result of the copy will not be NUL-terminated. Therefore,
the call is also diagnosed. To avoid the warning, specify sizeof buf - 1 as the
bound and set the last element of the buffer to NUL.
void copy (const char *s)
{
char buf[80];
strncpy (buf, s, sizeof buf);
...
}
In situations where a character array is intended to store a sequence of bytes
with no terminating NUL such an array may be annotated with attribute
nonstring to avoid this warning. Such arrays, however, are not suitable
arguments to functions that expect NUL-terminated strings. To help detect
accidental misuses of such arrays GCC issues warnings unless it can prove that
the use is safe. See Section 6.34.1 [Common Variable Attributes], page 622.
-Wsuggest-attribute=[pure|const|noreturn|format|cold|malloc]
Warn for cases where adding an attribute may be beneficial. The attributes
currently supported are listed below.
-Wsuggest-attribute=pure
-Wsuggest-attribute=const
-Wsuggest-attribute=noreturn
-Wmissing-noreturn
-Wsuggest-attribute=malloc
Warn about functions that might be candidates for attributes pure,
const or noreturn or malloc. The compiler only warns for func-
tions visible in other compilation units or (in the case of pure and
const) if it cannot prove that the function returns normally. A
function returns normally if it doesn’t contain an infinite loop or
return abnormally by throwing, calling abort or trapping. This
analysis requires option ‘-fipa-pure-const’, which is enabled by
118 Using the GNU Compiler Collection (GCC)
-Warith-conversion
Do warn about implicit conversions from arithmetic operations even when
conversion of the operands to the same type cannot change their values.
This affects warnings from ‘-Wconversion’, ‘-Wfloat-conversion’, and
‘-Wsign-conversion’.
void f (char c, int i)
{
c = c + i; // warns with ‘-Wconversion’
c = c + 1; // only warns with ‘-Warith-conversion’
}
-Warray-bounds
-Warray-bounds=n
Warn about out of bounds subscripts or offsets into arrays. This warning is
enabled by ‘-Wall’. It is more effective when ‘-ftree-vrp’ is active (the de-
fault for ‘-O2’ and above) but a subset of instances are issued even without
optimization.
-Warray-bounds=1
This is the default warning level of ‘-Warray-bounds’ and is enabled
by ‘-Wall’; higher levels are not, and must be explicitly requested.
-Warray-bounds=2
This warning level also warns about out of bounds accesses to trail-
ing struct members of one-element array types (see Section 6.18
[Zero Length], page 548) and about the intermediate results of
pointer arithmetic that may yield out of bounds values. This warn-
ing level may give a larger number of false positives and is deacti-
vated by default.
-Warray-compare
Warn about equality and relational comparisons between two operands of array
type. This comparison was deprecated in C++20. For example:
int arr1[5];
int arr2[5];
bool same = arr1 == arr2;
‘-Warray-compare’ is enabled by ‘-Wall’.
-Warray-parameter
-Warray-parameter=n
Warn about redeclarations of functions involving arguments of array or pointer
types of inconsistent kinds or forms, and enable the detection of out-of-bounds
accesses to such parameters by warnings such as ‘-Warray-bounds’.
If the first function declaration uses the array form the bound specified in
the array is assumed to be the minimum number of elements expected to be
provided in calls to the function and the maximum number of elements ac-
cessed by it. Failing to provide arguments of sufficient size or accessing more
than the maximum number of elements may be diagnosed by warnings such as
‘-Warray-bounds’. At level 1 the warning diagnoses inconsistencies involving
array parameters declared using the T[static N] form.
Chapter 3: GCC Command Options 121
For example, the warning triggers for the following redeclarations because the
first one allows an array of any size to be passed to f while the second one with
the keyword static specifies that the array argument must have at least four
elements.
void f (int[static 4]);
void f (int[]); // warning (inconsistent array form)
void g (void)
{
int *p = (int *)malloc (4);
f (p); // warning (array too small)
...
}
At level 2 the warning also triggers for redeclarations involving any other in-
consistency in array or pointer argument forms denoting array sizes. Pointers
and arrays of unspecified bound are considered equivalent and do not trigger a
warning.
void g (int*);
void g (int[]); // no warning
void g (int[8]); // warning (inconsistent array bound)
-Wattribute-alias=n
-Wno-attribute-alias
Warn about declarations using the alias and similar attributes whose target is
incompatible with the type of the alias. See Section 6.33 [Declaring Attributes
of Functions], page 556.
-Wattribute-alias=1
The default warning level of the ‘-Wattribute-alias’ option diag-
noses incompatibilities between the type of the alias declaration and
that of its target. Such incompatibilities are typically indicative of
bugs.
-Wattribute-alias=2
At this level ‘-Wattribute-alias’ also diagnoses cases where the
attributes of the alias declaration are more restrictive than the at-
tributes applied to its target. These mismatches can potentially
result in incorrect code generation. In other cases they may be be-
nign and could be resolved simply by adding the missing attribute
to the target. For comparison, see the ‘-Wmissing-attributes’
option, which controls diagnostics when the alias declaration is less
restrictive than the target, rather than more restrictive.
Attributes considered include alloc_align, alloc_size, cold,
const, hot, leaf, malloc, nonnull, noreturn, nothrow, pure,
returns_nonnull, and returns_twice.
122 Using the GNU Compiler Collection (GCC)
-Wduplicated-cond
Warn about duplicated conditions in an if-else-if chain. For instance, warn for
the following code:
Chapter 3: GCC Command Options 123
-Wsystem-headers
Print warning messages for constructs found in system header files. Warnings
from system headers are normally suppressed, on the assumption that they
usually do not indicate real problems and would only make the compiler output
harder to read. Using this command-line option tells GCC to emit warnings
from system headers as if they occurred in user code. However, note that using
‘-Wall’ in conjunction with this option does not warn about unknown pragmas
in system headers—for that, ‘-Wunknown-pragmas’ must also be used.
-Wtautological-compare
Warn if a self-comparison always evaluates to true or false. This warning detects
various mistakes such as:
int i = 1;
...
if (i > i) { ... }
This warning also warns about bitwise comparisons that always evaluate to true
or false, for instance:
if ((a & 16) == 10) { ... }
will always be false.
This warning is enabled by ‘-Wall’.
-Wtrampolines
Warn about trampolines generated for pointers to nested functions. A tram-
poline is a small piece of data or code that is created at run time on the stack
when the address of a nested function is taken, and is used to call the nested
function indirectly. For some targets, it is made up of data only and thus re-
quires no special treatment. But, for most targets, it is made up of code and
thus requires the stack to be made executable in order for the program to work
properly.
-Wfloat-equal
Warn if floating-point values are used in equality comparisons.
The idea behind this is that sometimes it is convenient (for the programmer)
to consider floating-point values as approximations to infinitely precise real
numbers. If you are doing this, then you need to compute (by analyzing the
code, or in some other way) the maximum or likely maximum error that the
computation introduces, and allow for it when performing comparisons (and
when producing output, but that’s a different problem). In particular, instead
of testing for equality, you should check to see whether the two values have
ranges that overlap; and this is done with the relational operators, so equality
comparisons are probably mistaken.
-Wtraditional (C and Objective-C only)
Warn about certain constructs that behave differently in traditional and ISO
C. Also warn about ISO C constructs that have no traditional C equivalent,
and/or problematic constructs that should be avoided.
• Macro parameters that appear within string literals in the macro body. In
traditional C macro replacement takes place within string literals, but in
ISO C it does not.
Chapter 3: GCC Command Options 125
other, type checking is expected to catch that and emit an error or warning.
Use of this flag instead of ‘-Wshadow=local’ can possibly reduce the number
of warnings triggered by intentional shadowing. Note that this also means that
shadowing const char *i by char *i does not emit a warning.
This warning is also enabled by ‘-Wshadow=local’.
-Wlarger-than=byte-size
Warn whenever an object is defined whose size exceeds byte-size.
‘-Wlarger-than=’‘PTRDIFF_MAX’ is enabled by default. Warnings controlled
by the option can be disabled either by specifying byte-size of ‘SIZE_MAX’ or
more or by ‘-Wno-larger-than’.
Also warn for calls to bounded functions such as memchr or strnlen that specify
a bound greater than the largest possible object, which is ‘PTRDIFF_MAX’ bytes
by default. These warnings can only be disabled by ‘-Wno-larger-than’.
-Wno-larger-than
Disable ‘-Wlarger-than=’ warnings. The option is equivalent to
‘-Wlarger-than=’‘SIZE_MAX’ or larger.
-Wframe-larger-than=byte-size
Warn if the size of a function frame exceeds byte-size. The computation done
to determine the stack frame size is approximate and not conservative. The
actual requirements may be somewhat greater than byte-size even if you do
not get a warning. In addition, any space allocated via alloca, variable-length
arrays, or related constructs is not included by the compiler when determining
whether or not to issue a warning. ‘-Wframe-larger-than=’‘PTRDIFF_MAX’ is
enabled by default. Warnings controlled by the option can be disabled either by
specifying byte-size of ‘SIZE_MAX’ or more or by ‘-Wno-frame-larger-than’.
-Wno-frame-larger-than
Disable ‘-Wframe-larger-than=’ warnings. The option is equivalent to
‘-Wframe-larger-than=’‘SIZE_MAX’ or larger.
-Wfree-nonheap-object
Warn when attempting to deallocate an object that was either not allocated
on the heap, or by using a pointer that was not returned from a prior call to
the corresponding allocation function. For example, because the call to stpcpy
returns a pointer to the terminating nul character and not to the beginning of
the object, the call to free below is diagnosed.
void f (char *p)
{
p = stpcpy (p, "abc");
// ...
free (p); // warning
}
‘-Wfree-nonheap-object’ is included in ‘-Wall’.
-Wstack-usage=byte-size
Warn if the stack usage of a function might exceed byte-size. The computation
done to determine the stack usage is conservative. Any space allocated via
128 Using the GNU Compiler Collection (GCC)
-Wtype-limits
Warn if a comparison is always true or always false due to the limited range of
the data type, but do not warn for constant expressions. For example, warn if
an unsigned variable is compared against zero with < or >=. This warning is
also enabled by ‘-Wextra’.
-Wabsolute-value (C and Objective-C only)
Warn for calls to standard functions that compute the absolute value of an
argument when a more appropriate standard function is available. For example,
calling abs(3.14) triggers the warning because the appropriate function to call
to compute the absolute value of a double argument is fabs. The option also
triggers warnings when the argument in a call to such a function has an unsigned
type. This warning can be suppressed with an explicit type cast and it is also
enabled by ‘-Wextra’.
-Wcomment
-Wcomments
Warn whenever a comment-start sequence ‘/*’ appears in a ‘/*’ comment, or
whenever a backslash-newline appears in a ‘//’ comment. This warning is
enabled by ‘-Wall’.
-Wtrigraphs
Warn if any trigraphs are encountered that might change the meaning of the
program. Trigraphs within comments are not warned about, except those that
would form escaped newlines.
This option is implied by ‘-Wall’. If ‘-Wall’ is not given, this option
is still enabled unless trigraphs are enabled. To get trigraph conversion
without warnings, but get the other ‘-Wall’ warnings, use ‘-trigraphs -Wall
-Wno-trigraphs’.
-Wundef Warn if an undefined identifier is evaluated in an #if directive. Such identifiers
are replaced with zero.
-Wexpansion-to-defined
Warn whenever ‘defined’ is encountered in the expansion of a macro (including
the case where the macro is expanded by an ‘#if’ directive). Such usage is not
portable. This warning is also enabled by ‘-Wpedantic’ and ‘-Wextra’.
-Wunused-macros
Warn about macros defined in the main file that are unused. A macro is used
if it is expanded or tested for existence at least once. The preprocessor also
warns if the macro has not been used at the time it is redefined or undefined.
Built-in macros, macros defined on the command line, and macros defined in
include files are not warned about.
Note: If a macro is actually used, but only used in skipped conditional blocks,
then the preprocessor reports it as unused. To avoid the warning in such a case,
you might improve the scope of the macro’s definition by, for example, moving
it into the first skipped block. Alternatively, you could provide a dummy use
with something like:
130 Using the GNU Compiler Collection (GCC)
-Wno-endif-labels
Do not warn whenever an #else or an #endif are followed by text. This
sometimes happens in older programs with code of the form
#if FOO
...
#else FOO
...
#endif FOO
The second and third FOO should be in comments. This warning is on by default.
-Wbad-function-cast (C and Objective-C only)
Warn when a function call is cast to a non-matching type. For example, warn
if a call to a function returning an integer type is cast to a pointer type.
-Wc90-c99-compat (C and Objective-C only)
Warn about features not present in ISO C90, but present in ISO C99. For
instance, warn about use of variable length arrays, long long type, bool type,
compound literals, designated initializers, and so on. This option is independent
of the standards mode. Warnings are disabled in the expression that follows
__extension__.
-Wc99-c11-compat (C and Objective-C only)
Warn about features not present in ISO C99, but present in ISO C11. For in-
stance, warn about use of anonymous structures and unions, _Atomic type qual-
ifier, _Thread_local storage-class specifier, _Alignas specifier, Alignof opera-
tor, _Generic keyword, and so on. This option is independent of the standards
mode. Warnings are disabled in the expression that follows __extension__.
-Wc11-c2x-compat (C and Objective-C only)
Warn about features not present in ISO C11, but present in ISO C2X. For
instance, warn about omitting the string in _Static_assert, use of ‘[[]]’
syntax for attributes, use of decimal floating-point types, and so on. This
option is independent of the standards mode. Warnings are disabled in the
expression that follows __extension__.
-Wc++-compat (C and Objective-C only)
Warn about ISO C constructs that are outside of the common subset of ISO C
and ISO C++, e.g. request for implicit conversion from void * to a pointer to
non-void type.
-Wc++11-compat (C++ and Objective-C++ only)
Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords in ISO C++
2011. This warning turns on ‘-Wnarrowing’ and is enabled by ‘-Wall’.
-Wc++14-compat (C++ and Objective-C++ only)
Warn about C++ constructs whose meaning differs between ISO C++ 2011 and
ISO C++ 2014. This warning is enabled by ‘-Wall’.
Chapter 3: GCC Command Options 131
-Wcast-function-type
Warn when a function pointer is cast to an incompatible function pointer. In
a cast involving function types with a variable argument list only the types of
initial arguments that are provided are considered. Any parameter of pointer-
type matches any other pointer-type. Any benign differences in integral types
are ignored, like int vs. long on ILP32 targets. Likewise type qualifiers are
ignored. The function type void (*) (void) is special and matches everything,
which can be used to suppress this warning. In a cast involving pointer to
member types this warning warns whenever the type cast is changing the pointer
to member type. This warning is enabled by ‘-Wextra’.
-Wwrite-strings
When compiling C, give string constants the type const char[length] so that
copying the address of one into a non-const char * pointer produces a warning.
These warnings help you find at compile time code that can try to write into
a string constant, but only if you have been very careful about using const in
declarations and prototypes. Otherwise, it is just a nuisance. This is why we
did not make ‘-Wall’ request these warnings.
When compiling C++, warn about the deprecated conversion from string literals
to char *. This warning is enabled by default for C++ programs.
-Wclobbered
Warn for variables that might be changed by longjmp or vfork. This warning
is also enabled by ‘-Wextra’.
-Wconversion
Warn for implicit conversions that may alter a value. This includes conversions
between real and integer, like abs (x) when x is double; conversions between
signed and unsigned, like unsigned ui = -1; and conversions to smaller types,
like sqrtf (M_PI). Do not warn for explicit casts like abs ((int) x) and ui
= (unsigned) -1, or if the value is not changed by the conversion like in abs
(2.0). Warnings about conversions between signed and unsigned integers can
be disabled by using ‘-Wno-sign-conversion’.
For C++, also warn for confusing overload resolution for user-defined conver-
sions; and conversions that never use a type conversion operator: conversions
to void, the same type, a base class or a reference to them. Warnings about
conversions between signed and unsigned integers are disabled by default in
C++ unless ‘-Wsign-conversion’ is explicitly enabled.
Warnings about conversion from arithmetic on a small type back to that type
are only given with ‘-Warith-conversion’.
-Wdangling-else
Warn about constructions where there may be confusion to which if statement
an else branch belongs. Here is an example of such a case:
Chapter 3: GCC Command Options 133
{
if (a)
if (b)
foo ();
else
bar ();
}
-Wdangling-pointer
-Wdangling-pointer=n
Warn about uses of pointers (or C++ references) to objects with automatic
storage duration after their lifetime has ended. This includes local variables
declared in nested blocks, compound literals and other unnamed temporary
objects. In addition, warn about storing the address of such objects in es-
caped pointers. The warning is enabled at all optimization levels but may yield
different results with optimization than without.
-Wdangling-pointer=1
At level 1 the warning diagnoses only unconditional uses of dangling
pointers. For example
int f (int c1, int c2, x)
{
char *p = strchr ((char[]){ c1, c2 }, c3);
return p ? *p : ’x’; // warning: dangling pointer to a com-
pound literal
}
In the following function the store of the address of the local variable
x in the escaped pointer *p also triggers the warning.
void g (int **p)
{
int x = 7;
*p = &x; // warning: storing the address of a local variable in *p
}
134 Using the GNU Compiler Collection (GCC)
-Wdangling-pointer=2
At level 2, in addition to unconditional uses the warning also diag-
noses conditional uses of dangling pointers.
For example, because the array a in the following function is out of
scope when the pointer s that was set to point is used, the warning
triggers at this level.
void f (char *s)
{
if (!s)
{
char a[12] = "tmpname";
s = a;
}
strcat (s, ".tmp"); // warning: dangling pointer to a may be used
...
}
been initialized. This only warns about variables that are initialized when they
are declared. This warning is only supported for C and Objective-C; in C++
this sort of branch is an error in any case.
‘-Wjump-misses-init’ is included in ‘-Wc++-compat’. It can be disabled with
the ‘-Wno-jump-misses-init’ option.
-Wsign-compare
Warn when a comparison between signed and unsigned values could produce
an incorrect result when the signed value is converted to unsigned. In C++, this
warning is also enabled by ‘-Wall’. In C, it is also enabled by ‘-Wextra’.
-Wsign-conversion
Warn for implicit conversions that may change the sign of an integer value, like
assigning a signed integer expression to an unsigned integer variable. An explicit
cast silences the warning. In C, this option is enabled also by ‘-Wconversion’.
-Wfloat-conversion
Warn for implicit conversions that reduce the precision of a real value. This
includes conversions from real to integer, and from higher precision real to lower
precision real values. This option is also enabled by ‘-Wconversion’.
-Wno-scalar-storage-order
Do not warn on suspicious constructs involving reverse scalar storage order.
-Wsizeof-array-div
Warn about divisions of two sizeof operators when the first one is applied to an
array and the divisor does not equal the size of the array element. In such a
case, the computation will not yield the number of elements in the array, which
is likely what the user intended. This warning warns e.g. about
int fn ()
{
int arr[10];
return sizeof (arr) / sizeof (short);
}
This warning is enabled by ‘-Wall’.
-Wsizeof-pointer-div
Warn for suspicious divisions of two sizeof expressions that divide the pointer
size by the element size, which is the usual way to compute the array size but
won’t work out correctly with pointers. This warning warns e.g. about sizeof
(ptr) / sizeof (ptr[0]) if ptr is not an array, but a pointer. This warning
is enabled by ‘-Wall’.
-Wsizeof-pointer-memaccess
Warn for suspicious length parameters to certain string and memory built-
in functions if the argument uses sizeof. This warning triggers for example
for memset (ptr, 0, sizeof (ptr)); if ptr is not an array, but a pointer,
and suggests a possible fix, or about memcpy (&foo, ptr, sizeof (&foo));.
‘-Wsizeof-pointer-memaccess’ also warns about calls to bounded string copy
functions like strncat or strncpy that specify as the bound a sizeof expres-
sion of the source array. For example, in the following function the call to
136 Using the GNU Compiler Collection (GCC)
strncat specifies the size of the source string as the bound. That is almost
certainly a mistake and so the call is diagnosed.
void make_file (const char *name)
{
char path[PATH_MAX];
strncpy (path, name, sizeof path - 1);
strncat (path, ".text", sizeof ".text");
...
}
The ‘-Wsizeof-pointer-memaccess’ option is enabled by ‘-Wall’.
-Wno-sizeof-array-argument
Do not warn when the sizeof operator is applied to a parameter that is declared
as an array in a function definition. This warning is enabled by default for C
and C++ programs.
-Wmemset-elt-size
Warn for suspicious calls to the memset built-in function, if the first argument
references an array, and the third argument is a number equal to the number
of elements, but not equal to the size of the array in memory. This indicates
that the user has omitted a multiplication by the element size. This warning is
enabled by ‘-Wall’.
-Wmemset-transposed-args
Warn for suspicious calls to the memset built-in function where the second
argument is not zero and the third argument is zero. For example, the call
memset (buf, sizeof buf, 0) is diagnosed because memset (buf, 0, sizeof
buf) was meant instead. The diagnostic is only emitted if the third argument is
a literal zero. Otherwise, if it is an expression that is folded to zero, or a cast of
zero to some type, it is far less likely that the arguments have been mistakenly
transposed and no warning is emitted. This warning is enabled by ‘-Wall’.
-Waddress
Warn about suspicious uses of address expressions. These include comparing
the address of a function or a declared object to the null pointer constant such
as in
void f (void);
void g (void)
{
if (!f) // warning: expression evaluates to false
abort ();
}
comparisons of a pointer to a string literal, such as in
void f (const char *x)
{
if (x == "abc") // warning: expression evaluates to false
puts ("equal");
}
and tests of the results of pointer addition or subtraction for equality to null,
such as in
void f (const int *p, int i)
{
Chapter 3: GCC Command Options 137
return p + i == NULL;
}
Such uses typically indicate a programmer error: the address of most functions
and objects necessarily evaluates to true (the exception are weak symbols), so
their use in a conditional might indicate missing parentheses in a function call
or a missing dereference in an array expression. The subset of the warning for
object pointers can be suppressed by casting the pointer operand to an integer
type such as intptr_t or uintptr_t. Comparisons against string literals result
in unspecified behavior and are not portable, and suggest the intent was to call
strcmp. The warning is suppressed if the suspicious expression is the result of
macro expansion. ‘-Waddress’ warning is enabled by ‘-Wall’.
-Wno-address-of-packed-member
Do not warn when the address of packed member of struct or union is taken,
which usually results in an unaligned pointer value. This is enabled by default.
-Wlogical-op
Warn about suspicious uses of logical operators in expressions. This includes
using logical operators in contexts where a bit-wise operator is likely to be
expected. Also warns when the operands of a logical operator are the same:
extern int a;
if (a < 0 && a < 0) { ... }
-Wlogical-not-parentheses
Warn about logical not used on the left hand side operand of a comparison.
This option does not warn if the right operand is considered to be a boolean
expression. Its purpose is to detect suspicious code like the following:
int a;
...
if (!a > 1) { ... }
It is possible to suppress the warning by wrapping the LHS into parentheses:
if ((!a) > 1) { ... }
This warning is enabled by ‘-Wall’.
-Waggregate-return
Warn if any functions that return structures or unions are defined or called. (In
languages where you can return an array, this also elicits a warning.)
-Wno-aggressive-loop-optimizations
Warn if in a loop with constant number of iterations the compiler detects un-
defined behavior in some statement during one or more of the iterations.
-Wno-attributes
Do not warn if an unexpected __attribute__ is used, such as unrecognized
attributes, function attributes applied to variables, etc. This does not stop
errors for incorrect use of supported attributes.
Additionally, using ‘-Wno-attributes=’, it is possible to suppress warnings
about unknown scoped attributes (in C++11 and C2X). For example,
‘-Wno-attributes=vendor::attr’ disables warning about the following
declaration:
138 Using the GNU Compiler Collection (GCC)
-Wno-builtin-macro-redefined
Do not warn if certain built-in macros are redefined. This suppresses warn-
ings for redefinition of __TIMESTAMP__, __TIME__, __DATE__, __FILE__, and
__BASE_FILE__.
-Wstrict-prototypes (C and Objective-C only)
Warn if a function is declared or defined without specifying the argument types.
(An old-style function definition is permitted without a warning if preceded by
a declaration that specifies the argument types.)
-Wold-style-declaration (C and Objective-C only)
Warn for obsolescent usages, according to the C Standard, in a declaration. For
example, warn if storage-class specifiers like static are not the first things in
a declaration. This warning is also enabled by ‘-Wextra’.
-Wold-style-definition (C and Objective-C only)
Warn if an old-style function definition is used. A warning is given even if there
is a previous prototype. A definition using ‘()’ is not considered an old-style
definition in C2X mode, because it is equivalent to ‘(void)’ in that case, but
is considered an old-style definition for older standards.
-Wmissing-parameter-type (C and Objective-C only)
A function parameter is declared without a type specifier in K&R-style func-
tions:
Chapter 3: GCC Command Options 139
void foo(bar) { }
This warning is also enabled by ‘-Wextra’.
-Wmissing-prototypes (C and Objective-C only)
Warn if a global function is defined without a previous prototype declara-
tion. This warning is issued even if the definition itself provides a proto-
type. Use this option to detect global functions that do not have a match-
ing prototype declaration in a header file. This option is not valid for C++
because all function declarations provide prototypes and a non-matching dec-
laration declares an overload rather than conflict with an earlier declaration.
Use ‘-Wmissing-declarations’ to detect missing declarations in C++.
-Wmissing-declarations
Warn if a global function is defined without a previous declaration. Do so even if
the definition itself provides a prototype. Use this option to detect global func-
tions that are not declared in header files. In C, no warnings are issued for func-
tions with previous non-prototype declarations; use ‘-Wmissing-prototypes’
to detect missing prototypes. In C++, no warnings are issued for function tem-
plates, or for inline functions, or for functions in anonymous namespaces.
-Wmissing-field-initializers
Warn if a structure’s initializer has some fields missing. For example, the fol-
lowing code causes such a warning, because x.h is implicitly zero:
struct s { int f, g, h; };
struct s x = { 3, 4 };
This option does not warn about designated initializers, so the following mod-
ification does not trigger a warning:
struct s { int f, g, h; };
struct s x = { .f = 3, .g = 4 };
In C this option does not warn about the universal zero initializer ‘{ 0 }’:
struct s { int f, g, h; };
struct s x = { 0 };
Likewise, in C++ this option does not warn about the empty { } initializer, for
example:
struct s { int f, g, h; };
s x = { };
This warning is included in ‘-Wextra’. To get other ‘-Wextra’ warnings without
this one, use ‘-Wextra -Wno-missing-field-initializers’.
-Wno-missing-requires
By default, the compiler warns about a concept-id appearing as a C++20 simple-
requirement:
bool satisfied = requires { C<T> };
Here ‘satisfied’ will be true if ‘C<T>’ is a valid expression, which it is for all
T. Presumably the user meant to write
bool satisfied = requires { requires C<T> };
so ‘satisfied’ is only true if concept ‘C’ is satisfied for type ‘T’.
This warning can be disabled with ‘-Wno-missing-requires’.
140 Using the GNU Compiler Collection (GCC)
-Wno-missing-template-keyword
The member access tokens ., -> and :: must be followed by the template
keyword if the parent object is dependent and the member being named is a
template.
template <class X>
void DoStuff (X x)
{
x.template DoSomeOtherStuff<X>(); // Good.
x.DoMoreStuff<X>(); // Warning, x is dependent.
}
In rare cases it is possible to get false positives. To silence this, wrap the
expression in parentheses. For example, the following is treated as a template,
even where m and N are integers:
void NotATemplate (my_class t)
{
int N = 5;
Some characters in ISO 10646 have distinct meanings but look identical in some
fonts or display methodologies, especially once formatting has been applied. For
instance \u207F, “SUPERSCRIPT LATIN SMALL LETTER N”, displays just
like a regular n that has been placed in a superscript. ISO 10646 defines the
NFKC normalization scheme to convert all these into a standard form as well,
and GCC warns if your code is not in NFKC if you use ‘-Wnormalized=nfkc’.
This warning is comparable to warning about every identifier that contains the
letter O because it might be confused with the digit 0, and so is not the default,
but may be useful as a local coding convention if the programming environment
cannot be fixed to display these characters distinctly.
-Wno-attribute-warning
Do not warn about usage of functions (see Section 6.33 [Function Attributes],
page 556) declared with warning attribute. By default, this warning is
enabled. ‘-Wno-attribute-warning’ can be used to disable the warning or
‘-Wno-error=attribute-warning’ can be used to disable the error when
compiled with ‘-Werror’ flag.
-Wno-deprecated
Do not warn about usage of deprecated features. See Section 7.11 [Deprecated
Features], page 898.
-Wno-deprecated-declarations
Do not warn about uses of functions (see Section 6.33 [Function Attributes],
page 556), variables (see Section 6.34 [Variable Attributes], page 622), and types
(see Section 6.35 [Type Attributes], page 636) marked as deprecated by using
the deprecated attribute.
-Wno-overflow
Do not warn about compile-time overflow in constant expressions.
-Wno-odr Warn about One Definition Rule violations during link-time optimization. En-
abled by default.
-Wopenacc-parallelism
Warn about potentially suboptimal choices related to OpenACC parallelism.
-Wopenmp-simd
Warn if the vectorizer cost model overrides the OpenMP simd directive set by
user. The ‘-fsimd-cost-model=unlimited’ option can be used to relax the
cost model.
-Woverride-init (C and Objective-C only)
Warn if an initialized field without side effects is overridden when using desig-
nated initializers (see Section 6.29 [Designated Initializers], page 553).
This warning is included in ‘-Wextra’. To get other ‘-Wextra’ warnings without
this one, use ‘-Wextra -Wno-override-init’.
-Wno-override-init-side-effects (C and Objective-C only)
Do not warn if an initialized field with side effects is overridden when using
designated initializers (see Section 6.29 [Designated Initializers], page 553). This
warning is enabled by default.
142 Using the GNU Compiler Collection (GCC)
-Wpacked Warn if a structure is given the packed attribute, but the packed attribute has no
effect on the layout or size of the structure. Such structures may be mis-aligned
for little benefit. For instance, in this code, the variable f.x in struct bar is
misaligned even though struct bar does not itself have the packed attribute:
struct foo {
int x;
char a, b, c, d;
} __attribute__((packed));
struct bar {
char z;
struct foo f;
};
-Wnopacked-bitfield-compat
The 4.1, 4.2 and 4.3 series of GCC ignore the packed attribute on bit-fields of
type char. This was fixed in GCC 4.4 but the change can lead to differences
in the structure layout. GCC informs you when the offset of such a field has
changed in GCC 4.4. For example there is no longer a 4-bit padding between
field a and b in this structure:
struct foo
{
char a:4;
char b:8;
} __attribute__ ((packed));
This warning is enabled by default. Use ‘-Wno-packed-bitfield-compat’ to
disable this warning.
-Wpacked-not-aligned (C, C++, Objective-C and Objective-C++ only)
Warn if a structure field with explicitly specified alignment in a packed struct
or union is misaligned. For example, a warning will be issued on struct S, like,
warning: alignment 1 of ’struct S’ is less than 8, in this code:
struct __attribute__ ((aligned (8))) S8 { char a[8]; };
struct __attribute__ ((packed)) S {
struct S8 s8;
};
This warning is enabled by ‘-Wall’.
-Wpadded Warn if padding is included in a structure, either to align an element of the
structure or to align the whole structure. Sometimes when this happens it is
possible to rearrange the fields of the structure to reduce the padding and so
make the structure smaller.
-Wredundant-decls
Warn if anything is declared more than once in the same scope, even in cases
where multiple declaration is valid and changes nothing.
-Wrestrict
Warn when an object referenced by a restrict-qualified parameter (or, in
C++, a __restrict-qualified parameter) is aliased by another argument, or
when copies between such objects overlap. For example, the call to the strcpy
function below attempts to truncate the string by replacing its initial characters
with the last four. However, because the call writes the terminating NUL into
a[4], the copies overlap and the call is diagnosed.
Chapter 3: GCC Command Options 143
-Wno-vla-larger-than
Disable ‘-Wvla-larger-than=’ warnings. The option is equivalent to
‘-Wvla-larger-than=’‘SIZE_MAX’ or larger.
-Wvla-parameter
Warn about redeclarations of functions involving arguments of Variable Length
Array types of inconsistent kinds or forms, and enable the detection of out-of-
bounds accesses to such parameters by warnings such as ‘-Warray-bounds’.
If the first function declaration uses the VLA form the bound specified in the
array is assumed to be the minimum number of elements expected to be pro-
vided in calls to the function and the maximum number of elements accessed
by it. Failing to provide arguments of sufficient size or accessing more than the
maximum number of elements may be diagnosed.
For example, the warning triggers for the following redeclarations because the
first one allows an array of any size to be passed to f while the second one
specifies that the array argument must have at least n elements. In addition,
calling f with the associated VLA bound parameter in excess of the actual VLA
bound triggers a warning as well.
void f (int n, int[n]);
void f (int, int[]); // warning: argument 2 previously declared as a VLA
void g (int n)
{
if (n > 4)
return;
int a[n];
f (sizeof a, a); // warning: access to a by f may be out of bounds
...
}
-Wvolatile-register-var
Warn if a register variable is declared volatile. The volatile modifier does not
inhibit all optimizations that may eliminate reads and/or writes to register
variables. This warning is enabled by ‘-Wall’.
-Wdisabled-optimization
Warn if a requested optimization pass is disabled. This warning does not gen-
erally indicate that there is anything wrong with your code; it merely indicates
that GCC’s optimizers are unable to handle the code effectively. Often, the
problem is that your code is too big or too complex; GCC refuses to optimize
programs when the optimization itself is likely to take inordinate amounts of
time.
146 Using the GNU Compiler Collection (GCC)
-Wanalyzer-allocation-size
-Wanalyzer-double-fclose
-Wanalyzer-double-free
-Wanalyzer-exposure-through-output-file
-Wanalyzer-fd-access-mode-mismatch
Chapter 3: GCC Command Options 147
-Wanalyzer-fd-double-close
-Wanalyzer-fd-leak
-Wanalyzer-fd-use-after-close
-Wanalyzer-fd-use-without-check
-Wanalyzer-file-leak
-Wanalyzer-free-of-non-heap
-Wanalyzer-malloc-leak
-Wanalyzer-mismatching-deallocation
-Wanalyzer-null-argument
-Wanalyzer-null-dereference
-Wanalyzer-possible-null-argument
-Wanalyzer-possible-null-dereference
-Wanalyzer-shift-count-negative
-Wanalyzer-shift-count-overflow
-Wanalyzer-stale-setjmp-buffer
-Wanalyzer-unsafe-call-within-signal-handler
-Wanalyzer-use-after-free
-Wanalyzer-use-of-pointer-in-stale-stack-frame
-Wanalyzer-use-of-uninitialized-value
-Wanalyzer-va-arg-type-mismatch
-Wanalyzer-va-list-exhausted
-Wanalyzer-va-list-leak
-Wanalyzer-va-list-use-after-va-end
-Wanalyzer-write-to-const
-Wanalyzer-write-to-string-literal
This option is only available if GCC was configured with analyzer support
enabled.
-Wanalyzer-too-complex
If ‘-fanalyzer’ is enabled, the analyzer uses various heuristics to attempt to
explore the control flow and data flow in the program, but these can be defeated
by sufficiently complicated code.
By default, the analysis silently stops if the code is too complicated
for the analyzer to fully explore and it reaches an internal limit. The
‘-Wanalyzer-too-complex’ option warns if this occurs.
-Wno-analyzer-allocation-size
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-allocation-size’ to disable it.
This diagnostic warns for paths through the code in which a pointer to a buffer
is assigned to point at a buffer with a size that is not a multiple of sizeof
(*pointer).
See CWE-131: Incorrect Calculation of Buffer Size.
-Wno-analyzer-double-fclose
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-double-fclose’ to disable it.
This diagnostic warns for paths through the code in which a FILE * can have
fclose called on it more than once.
-Wno-analyzer-double-free
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-double-free’ to disable it.
148 Using the GNU Compiler Collection (GCC)
This diagnostic warns for paths through the code in which a pointer can have a
deallocator called on it more than once, either free, or a deallocator referenced
by attribute malloc.
-Wno-analyzer-exposure-through-output-file
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-exposure-through-output-file’ to disable it.
This diagnostic warns for paths through the code in which a security-sensitive
value is written to an output file (such as writing a password to a log file).
-Wno-analyzer-fd-access-mode-mismatch
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-fd-access-mode-mismatch’ to disable it.
This diagnostic warns for paths through code in which a read on a write-only
file descriptor is attempted, or vice versa
-Wno-analyzer-fd-double-close
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-fd-double-close’ to disable it.
This diagnostic warns for paths through code in which a file descriptor can be
closed more than once.
-Wno-analyzer-fd-leak
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-fd-leak’ to disable it.
This diagnostic warns for paths through code in which an open file descriptor
is leaked.
-Wno-analyzer-fd-use-after-close
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-fd-use-after-close’ to disable it.
This diagnostic warns for paths through code in which a read or write is called
on a closed file descriptor.
-Wno-analyzer-fd-use-without-check
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-fd-use-without-check’ to disable it.
This diagnostic warns for paths through code in which a file descriptor is used
without being checked for validity.
-Wno-analyzer-file-leak
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-file-leak’ to disable it.
This diagnostic warns for paths through the code in which a <stdio.h> FILE
* stream object is leaked.
-Wno-analyzer-free-of-non-heap
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-free-of-non-heap’ to disable it.
This diagnostic warns for paths through the code in which free is called on a
non-heap pointer (e.g. an on-stack buffer, or a global).
Chapter 3: GCC Command Options 149
-Wno-analyzer-malloc-leak
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-malloc-leak’ to disable it.
This diagnostic warns for paths through the code in which a pointer allocated
via an allocator is leaked: either malloc, or a function marked with attribute
malloc.
-Wno-analyzer-mismatching-deallocation
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-mismatching-deallocation’ to disable it.
This diagnostic warns for paths through the code in which the wrong deal-
location function is called on a pointer value, based on which function was
used to allocate the pointer value. The diagnostic will warn about mismatches
between free, scalar delete and vector delete[], and those marked as allo-
cator/deallocator pairs using attribute malloc.
-Wno-analyzer-possible-null-argument
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-possible-null-argument’ to disable it.
This diagnostic warns for paths through the code in which a possibly-NULL
value is passed to a function argument marked with __attribute__
((nonnull)) as requiring a non-NULL value.
-Wno-analyzer-possible-null-dereference
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-possible-null-dereference’ to disable it.
This diagnostic warns for paths through the code in which a possibly-NULL
value is dereferenced.
-Wno-analyzer-null-argument
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-null-argument’ to disable it.
This diagnostic warns for paths through the code in which a value known
to be NULL is passed to a function argument marked with __attribute__
((nonnull)) as requiring a non-NULL value.
-Wno-analyzer-null-dereference
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-null-dereference’ to disable it.
This diagnostic warns for paths through the code in which a value known to be
NULL is dereferenced.
-Wno-analyzer-shift-count-negative
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-shift-count-negative’ to disable it.
This diagnostic warns for paths through the code in which a shift is attempted
with a negative count. It is analogous to the ‘-Wshift-count-negative’ di-
agnostic implemented in the C/C++ front ends, but is implemented based on
analyzing interprocedural paths, rather than merely parsing the syntax tree.
150 Using the GNU Compiler Collection (GCC)
However, the analyzer does not prioritize detection of such paths, so false neg-
atives are more likely relative to other warnings.
-Wno-analyzer-shift-count-overflow
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-shift-count-overflow’ to disable it.
This diagnostic warns for paths through the code in which a shift is attempted
with a count greater than or equal to the precision of the operand’s type.
It is analogous to the ‘-Wshift-count-overflow’ diagnostic implemented in
the C/C++ front ends, but is implemented based on analyzing interprocedural
paths, rather than merely parsing the syntax tree. However, the analyzer does
not prioritize detection of such paths, so false negatives are more likely relative
to other warnings.
-Wno-analyzer-stale-setjmp-buffer
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-stale-setjmp-buffer’ to disable it.
This diagnostic warns for paths through the code in which longjmp is called to
rewind to a jmp_buf relating to a setjmp call in a function that has returned.
When setjmp is called on a jmp_buf to record a rewind location, it records the
stack frame. The stack frame becomes invalid when the function containing the
setjmp call returns. Attempting to rewind to it via longjmp would reference a
stack frame that no longer exists, and likely lead to a crash (or worse).
-Wno-analyzer-tainted-allocation-size
This warning requires both ‘-fanalyzer’ and ‘-fanalyzer-checker=taint’ to
enable it; use ‘-Wno-analyzer-tainted-allocation-size’ to disable it.
This diagnostic warns for paths through the code in which a value that could
be under an attacker’s control is used as the size of an allocation without being
sanitized, so that an attacker could inject an excessively large allocation and
potentially cause a denial of service attack.
See CWE-789: Memory Allocation with Excessive Size Value.
-Wno-analyzer-tainted-array-index
This warning requires both ‘-fanalyzer’ and ‘-fanalyzer-checker=taint’ to
enable it; use ‘-Wno-analyzer-tainted-array-index’ to disable it.
This diagnostic warns for paths through the code in which a value that could
be under an attacker’s control is used as the index of an array access without
being sanitized, so that an attacker could inject an out-of-bounds access.
See CWE-129: Improper Validation of Array Index.
-Wno-analyzer-tainted-divisor
This warning requires both ‘-fanalyzer’ and ‘-fanalyzer-checker=taint’ to
enable it; use ‘-Wno-analyzer-tainted-divisor’ to disable it.
This diagnostic warns for paths through the code in which a value that could
be under an attacker’s control is used as the divisor in a division or modulus
operation without being sanitized, so that an attacker could inject a division-
by-zero.
Chapter 3: GCC Command Options 151
-Wno-analyzer-tainted-offset
This warning requires both ‘-fanalyzer’ and ‘-fanalyzer-checker=taint’ to
enable it; use ‘-Wno-analyzer-tainted-offset’ to disable it.
This diagnostic warns for paths through the code in which a value that could be
under an attacker’s control is used as a pointer offset without being sanitized,
so that an attacker could inject an out-of-bounds access.
See CWE-823: Use of Out-of-range Pointer Offset.
-Wno-analyzer-tainted-size
This warning requires both ‘-fanalyzer’ and ‘-fanalyzer-checker=taint’ to
enable it; use ‘-Wno-analyzer-tainted-size’ to disable it.
This diagnostic warns for paths through the code in which a value that could
be under an attacker’s control is used as the size of an operation such as memset
without being sanitized, so that an attacker could inject an out-of-bounds ac-
cess.
-Wno-analyzer-unsafe-call-within-signal-handler
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-unsafe-call-within-signal-handler’ to disable
it.
This diagnostic warns for paths through the code in which a function known to
be async-signal-unsafe (such as fprintf) is called from a signal handler.
-Wno-analyzer-use-after-free
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-use-after-free’ to disable it.
This diagnostic warns for paths through the code in which a pointer is used
after a deallocator is called on it: either free, or a deallocator referenced by
attribute malloc.
-Wno-analyzer-use-of-pointer-in-stale-stack-frame
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-use-of-pointer-in-stale-stack-frame’ to disable
it.
This diagnostic warns for paths through the code in which a pointer is derefer-
enced that points to a variable in a stale stack frame.
-Wno-analyzer-va-arg-type-mismatch
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-va-arg-type-mismatch’ to disable it.
This diagnostic warns for interprocedural paths through the code for which
the analyzer detects an attempt to use va_arg to extract a value passed to a
variadic call, but uses a type that does not match that of the expression passed
to the call.
-Wno-analyzer-va-list-exhausted
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-va-list-exhausted’ to disable it.
152 Using the GNU Compiler Collection (GCC)
This diagnostic warns for interprocedural paths through the code for which the
analyzer detects an attempt to use va_arg to access the next value passed to a
variadic call, but all of the values in the va_list have already been consumed.
-Wno-analyzer-va-list-leak
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-va-list-leak’ to disable it.
This diagnostic warns for interprocedural paths through the code for which
the analyzer detects that va_start or va_copy has been called on a va_list
without a corresponding call to va_end.
-Wno-analyzer-va-list-use-after-va-end
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-va-list-use-after-va-end’ to disable it.
This diagnostic warns for interprocedural paths through the code for which the
analyzer detects an attempt to use a va_list after va_end has been called on
it. va_list.
-Wno-analyzer-write-to-const
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-write-to-const’ to disable it.
This diagnostic warns for paths through the code in which the analyzer detects
an attempt to write through a pointer to a const object. However, the analyzer
does not prioritize detection of such paths, so false negatives are more likely
relative to other warnings.
-Wno-analyzer-write-to-string-literal
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-write-to-string-literal’ to disable it.
This diagnostic warns for paths through the code in which the analyzer detects
an attempt to write through a pointer to a string literal. However, the analyzer
does not prioritize detection of such paths, so false negatives are more likely
relative to other warnings.
-Wno-analyzer-use-of-uninitialized-value
This warning requires ‘-fanalyzer’, which enables it; use
‘-Wno-analyzer-use-of-uninitialized-value’ to disable it.
This diagnostic warns for paths through the code in which an uninitialized value
is used.
Pertinent parameters for controlling the exploration are: ‘--param analyzer-bb-explosion-factor=value’,
‘--param analyzer-max-enodes-per-program-point=value’, ‘--param analyzer-max-recursion-depth=va
and ‘--param analyzer-min-snodes-for-call-summary=value’.
The following options control the analyzer.
-fanalyzer-call-summaries
Simplify interprocedural analysis by computing the effect of certain calls, rather
than exploring all paths through the function from callsite to each possible
return.
Chapter 3: GCC Command Options 153
If enabled, call summaries are only used for functions with more than
one call site, and that are sufficiently complicated (as per ‘--param
analyzer-min-snodes-for-call-summary=value’).
-fanalyzer-checker=name
Restrict the analyzer to run just the named checker, and enable it.
Some checkers are disabled by default (even with ‘-fanalyzer’), such as the
taint checker that implements ‘-Wanalyzer-tainted-array-index’, and this
option is required to enable them.
Note: currently, ‘-fanalyzer-checker=taint’ disables the following warnings
from ‘-fanalyzer’:
-Wanalyzer-double-fclose
-Wanalyzer-double-free
-Wanalyzer-exposure-through-output-file
-Wanalyzer-file-leak
-Wanalyzer-free-of-non-heap
-Wanalyzer-malloc-leak
-Wanalyzer-mismatching-deallocation
-Wanalyzer-null-argument
-Wanalyzer-null-dereference
-Wanalyzer-possible-null-argument
-Wanalyzer-possible-null-dereference
-Wanalyzer-unsafe-call-within-signal-handler
-Wanalyzer-use-after-free
-Wanalyzer-va-list-leak
-Wanalyzer-va-list-use-after-va-end
-fno-analyzer-feasibility
This option is intended for analyzer developers.
By default the analyzer verifies that there is a feasible control flow path for each
diagnostic it emits: that the conditions that hold are not mutually exclusive.
Diagnostics for which no feasible path can be found are rejected. This filtering
can be suppressed with ‘-fno-analyzer-feasibility’, for debugging issues in
this code.
-fanalyzer-fine-grained
This option is intended for analyzer developers.
Internally the analyzer builds an “exploded graph” that combines control flow
graphs with data flow information.
By default, an edge in this graph can contain the effects of a run of multi-
ple statements within a basic block. With ‘-fanalyzer-fine-grained’, each
statement gets its own edge.
-fanalyzer-show-duplicate-count
This option is intended for analyzer developers: if multiple diagnostics have
been detected as being duplicates of each other, it emits a note when report-
ing the best diagnostic, giving the number of additional diagnostics that were
suppressed by the deduplication logic.
-fno-analyzer-state-merge
This option is intended for analyzer developers.
154 Using the GNU Compiler Collection (GCC)
‘2’ As per the previous level, but also show events relating to control
flow that are significant to triggering the issue (e.g. “true path
taken” at a conditional).
This level is the default.
‘3’ As per the previous level, but show all control flow events, not just
significant ones.
‘4’ This level is intended for analyzer developers; it adds various other
events intended for debugging the analyzer.
-fdump-analyzer
Dump internal details about what the analyzer is doing to
‘file.analyzer.txt’. This option is overridden by ‘-fdump-analyzer-stderr’.
-fdump-analyzer-stderr
Dump internal details about what the analyzer is doing to stderr. This option
overrides ‘-fdump-analyzer’.
-fdump-analyzer-callgraph
Dump a representation of the call graph suitable for viewing with GraphViz to
‘file.callgraph.dot’.
-fdump-analyzer-exploded-graph
Dump a representation of the “exploded graph” suitable for viewing with
GraphViz to ‘file.eg.dot’. Nodes are color-coded based on state-machine
states to emphasize state changes.
-fdump-analyzer-exploded-nodes
Emit diagnostics showing where nodes in the “exploded graph” are in relation
to the program source.
-fdump-analyzer-exploded-nodes-2
Dump a textual representation of the “exploded graph” to ‘file.eg.txt’.
-fdump-analyzer-exploded-nodes-3
Dump a textual representation of the “exploded graph” to one dump file per
node, to ‘file.eg-id.txt’. This is typically a large number of dump files.
-fdump-analyzer-exploded-paths
Dump a textual representation of the “exploded path” for each diagnostic to
‘file.idx.kind.epath.txt’.
-fdump-analyzer-feasibility
Dump internal details about the analyzer’s search for feasible paths. The details
are written in a form suitable for viewing with GraphViz to filenames of the
form ‘file.*.fg.dot’, ‘file.*.tg.dot’, and ‘file.*.fpath.txt’.
-fdump-analyzer-json
Dump a compressed JSON representation of analyzer internals to
‘file.analyzer.json.gz’. The precise format is subject to change.
-fdump-analyzer-state-purge
As per ‘-fdump-analyzer-supergraph’, dump a representation of the “super-
graph” suitable for viewing with GraphViz, but annotate the graph with in-
156 Using the GNU Compiler Collection (GCC)
formation on what state will be purged at each node. The graph is written to
‘file.state-purge.dot’.
-fdump-analyzer-supergraph
Dump representations of the “supergraph” suitable for viewing with GraphViz
to ‘file.supergraph.dot’ and to ‘file.supergraph-eg.dot’. These show
all of the control flow graphs in the program, with interprocedural edges for
calls and returns. The second dump contains annotations showing nodes in the
“exploded graph” and diagnostics associated with them.
-fdump-analyzer-untracked
Emit custom warnings with internal details intended for analyzer developers.
Note that with DWARF Version 2, some ports require and always use some
non-conflicting DWARF 3 extensions in the unwind tables.
Version 4 may require GDB 7.0 and ‘-fvar-tracking-assignments’ for max-
imum benefit. Version 5 requires GDB 8.0 or higher.
GCC no longer supports DWARF Version 1, which is substantially different
than Version 2 and later. For historical reasons, some other DWARF-related
options such as ‘-fno-dwarf2-cfi-asm’) retain a reference to DWARF Version
2 in their names, but apply to all currently-supported versions of DWARF.
-gbtf Request BTF debug information. BTF is the default debugging format for the
eBPF target. On other targets, like x86, BTF debug information can be gen-
erated along with DWARF debug information when both of the debug formats
are enabled explicitly via their respective command line options.
-gctf
-gctflevel
Request CTF debug information and use level to specify how much CTF debug
information should be produced. If ‘-gctf’ is specified without a value for level,
the default level of CTF debug information is 2.
CTF debug information can be generated along with DWARF debug informa-
tion when both of the debug formats are enabled explicitly via their respective
command line options.
Level 0 produces no CTF debug information at all. Thus, ‘-gctf0’ negates
‘-gctf’.
Level 1 produces CTF information for tracebacks only. This includes callsite
information, but does not include type information.
Level 2 produces type information for entities (functions, data objects etc.) at
file-scope or global-scope only.
-gstabs Produce debugging information in stabs format (if that is supported), without
GDB extensions. This is the format used by DBX on most BSD systems.
On MIPS, Alpha and System V Release 4 systems this option produces stabs
debugging output that is not understood by DBX. On System V Release 4
systems this option requires the GNU assembler.
-gstabs+ Produce debugging information in stabs format (if that is supported), using
GNU extensions understood only by the GNU debugger (GDB). The use of
these extensions is likely to make other debuggers crash or refuse to read the
program.
-gxcoff Produce debugging information in XCOFF format (if that is supported). This
is the format used by the DBX debugger on IBM RS/6000 systems.
-gxcoff+ Produce debugging information in XCOFF format (if that is supported), using
GNU extensions understood only by the GNU debugger (GDB). The use of
these extensions is likely to make other debuggers crash or refuse to read the
program, and may cause assemblers other than the GNU assembler (GAS) to
fail with an error.
158 Using the GNU Compiler Collection (GCC)
-gvms Produce debugging information in Alpha/VMS debug format (if that is sup-
ported). This is the format used by DEBUG on Alpha/VMS systems.
-glevel
-ggdblevel
-gstabslevel
-gxcofflevel
-gvmslevel
Request debugging information and also use level to specify how much infor-
mation. The default level is 2.
Level 0 produces no debug information at all. Thus, ‘-g0’ negates ‘-g’.
Level 1 produces minimal information, enough for making backtraces in parts
of the program that you don’t plan to debug. This includes descriptions of
functions and external variables, and line number tables, but no information
about local variables.
Level 3 includes extra information, such as all the macro definitions present in
the program. Some debuggers support macro expansion when you use ‘-g3’.
If you use multiple ‘-g’ options, with or without level numbers, the last such
option is the one that is effective.
‘-gdwarf’ does not accept a concatenated debug level, to avoid confusion with
‘-gdwarf-level’. Instead use an additional ‘-glevel’ option to change the
debug level for DWARF.
-fno-eliminate-unused-debug-symbols
By default, no debug information is produced for symbols that are not actually
used. Use this option if you want debug information for all symbols.
-femit-class-debug-always
Instead of emitting debugging information for a C++ class in only one object file,
emit it in all object files using the class. This option should be used only with
debuggers that are unable to handle the way GCC normally emits debugging
information for classes because using this option increases the size of debugging
information by as much as a factor of two.
-fno-merge-debug-strings
Direct the linker to not merge together strings in the debugging information
that are identical in different object files. Merging is not supported by all
assemblers or linkers. Merging decreases the size of the debug information in
the output file at the cost of increasing link processing time. Merging is enabled
by default.
-fdebug-prefix-map=old=new
When compiling files residing in directory ‘old’, record debugging information
describing them as if the files resided in directory ‘new’ instead. This can be
used to replace a build-time path with an install-time path in the debug info.
It can also be used to change an absolute path to a relative path by using ‘.’ for
new. This can give more reproducible builds, which are location independent,
but may require an extra command to tell GDB where to find the source files.
See also ‘-ffile-prefix-map’.
Chapter 3: GCC Command Options 159
-fvar-tracking
Run variable tracking pass. It computes where variables are stored at each posi-
tion in code. Better debugging information is then generated (if the debugging
information format supports this information).
It is enabled by default when compiling with optimization (‘-Os’, ‘-O’, ‘-O2’,
. . . ), debugging information (‘-g’) and the debug info format supports it.
-fvar-tracking-assignments
Annotate assignments to user variables early in the compilation and attempt to
carry the annotations over throughout the compilation all the way to the end, in
an attempt to improve debug information while optimizing. Use of ‘-gdwarf-4’
is recommended along with it.
It can be enabled even if var-tracking is disabled, in which case annotations
are created and maintained, but discarded at the end. By default, this flag is
enabled together with ‘-fvar-tracking’, except when selective scheduling is
enabled.
-gsplit-dwarf
If DWARF debugging information is enabled, separate as much debugging in-
formation as possible into a separate output file with the extension ‘.dwo’. This
option allows the build system to avoid linking files with debug information.
To be useful, this option requires a debugger capable of reading ‘.dwo’ files.
-gdwarf32
-gdwarf64
If DWARF debugging information is enabled, the ‘-gdwarf32’ selects the 32-bit
DWARF format and the ‘-gdwarf64’ selects the 64-bit DWARF format. The
default is target specific, on most targets it is ‘-gdwarf32’ though. The 32-bit
DWARF format is smaller, but can’t support more than 2GiB of debug infor-
mation in any of the DWARF debug information sections. The 64-bit DWARF
format allows larger debug information and might not be well supported by all
consumers yet.
-gdescribe-dies
Add description attributes to some DWARF DIEs that have no name attribute,
such as artificial variables, external references and call site parameter DIEs.
-gpubnames
Generate DWARF .debug_pubnames and .debug_pubtypes sections.
-ggnu-pubnames
Generate .debug_pubnames and .debug_pubtypes sections in a format suitable
for conversion into a GDB index. This option is only useful with a linker that
can produce GDB index version 7.
-fdebug-types-section
When using DWARF Version 4 or higher, type DIEs can be put into their own
.debug_types section instead of making them part of the .debug_info section.
It is more efficient to put them in a separate comdat section since the linker
can then remove duplicates. But not all DWARF consumers support .debug_
160 Using the GNU Compiler Collection (GCC)
types sections yet and on some objects .debug_types produces larger instead
of smaller debugging information.
-grecord-gcc-switches
-gno-record-gcc-switches
This switch causes the command-line options used to invoke the compiler that
may affect code generation to be appended to the DW AT producer attribute
in DWARF debugging information. The options are concatenated with spaces
separating them from each other and from the compiler version. It is enabled by
default. See also ‘-frecord-gcc-switches’ for another way of storing compiler
options into the object file.
-gstrict-dwarf
Disallow using extensions of later DWARF standard version than selected with
‘-gdwarf-version’. On most targets using non-conflicting DWARF extensions
from later standard versions is allowed.
-gno-strict-dwarf
Allow using extensions of later DWARF standard version than selected with
‘-gdwarf-version’.
-gas-loc-support
Inform the compiler that the assembler supports .loc directives. It may then
use them for the assembler to generate DWARF2+ line number tables.
This is generally desirable, because assembler-generated line-number tables are
a lot more compact than those the compiler can generate itself.
This option will be enabled by default if, at GCC configure time, the assembler
was found to support such directives.
-gno-as-loc-support
Force GCC to generate DWARF2+ line number tables internally, if DWARF2+
line number tables are to be generated.
-gas-locview-support
Inform the compiler that the assembler supports view assignment and reset
assertion checking in .loc directives.
This option will be enabled by default if, at GCC configure time, the assembler
was found to support them.
-gno-as-locview-support
Force GCC to assign view numbers internally, if ‘-gvariable-location-views’
are explicitly requested.
-gcolumn-info
-gno-column-info
Emit location column information into DWARF debugging information, rather
than just file and line. This option is enabled by default.
-gstatement-frontiers
-gno-statement-frontiers
This option causes GCC to create markers in the internal representation at
the beginning of statements, and to keep them roughly in place throughout
Chapter 3: GCC Command Options 161
compilation, using them to guide the output of is_stmt markers in the line
number table. This is enabled by default when compiling with optimization
(‘-Os’, ‘-O1’, ‘-O2’, . . . ), and outputting DWARF 2 debug information at the
normal level.
-gvariable-location-views
-gvariable-location-views=incompat5
-gno-variable-location-views
Augment variable location lists with progressive view numbers implied from the
line number table. This enables debug information consumers to inspect state
at certain points of the program, even if no instructions associated with the
corresponding source locations are present at that point. If the assembler lacks
support for view numbers in line number tables, this will cause the compiler to
emit the line number table, which generally makes them somewhat less com-
pact. The augmented line number tables and location lists are fully backward-
compatible, so they can be consumed by debug information consumers that are
not aware of these augmentations, but they won’t derive any benefit from them
either.
This is enabled by default when outputting DWARF 2 debug infor-
mation at the normal level, as long as there is assembler support,
‘-fvar-tracking-assignments’ is enabled and ‘-gstrict-dwarf’ is
not. When assembler support is not available, this may still be enabled,
but it will force GCC to output internal line number tables, and if
‘-ginternal-reset-location-views’ is not enabled, that will most certainly
lead to silently mismatching location views.
There is a proposed representation for view numbers that is not backward
compatible with the location list format introduced in DWARF 5, that can be
enabled with ‘-gvariable-location-views=incompat5’. This option may be
removed in the future, is only provided as a reference implementation of the
proposed representation. Debug information consumers are not expected to
support this extended format, and they would be rendered unable to decode
location lists using it.
-ginternal-reset-location-views
-gno-internal-reset-location-views
Attempt to determine location views that can be omitted from location view
lists. This requires the compiler to have very accurate insn length estimates,
which isn’t always the case, and it may cause incorrect view lists to be generated
silently when using an assembler that does not support location view lists. The
GNU assembler will flag any such error as a view number mismatch. This is
only enabled on ports that define a reliable estimation function.
-ginline-points
-gno-inline-points
Generate extended debug information for inlined functions. Location view
tracking markers are inserted at inlined entry points, so that address and view
numbers can be computed and output in debug information. This can be en-
abled independently of location views, in which case the view numbers won’t
162 Using the GNU Compiler Collection (GCC)
be output, but it can only be enabled along with statement frontiers, and it is
only enabled by default if location views are enabled.
-gz[=type]
Produce compressed debug sections in DWARF format, if that is supported. If
type is not given, the default type depends on the capabilities of the assembler
and linker used. type may be one of ‘none’ (don’t compress debug sections),
‘zlib’ (use zlib compression in ELF gABI format), or ‘zlib-gnu’ (use zlib
compression in traditional GNU format). If the linker doesn’t support writing
compressed debug sections, the option is rejected. Otherwise, if the assembler
does not support them, ‘-gz’ is silently ignored when producing object files.
-femit-struct-debug-baseonly
Emit debug information for struct-like types only when the base name of the
compilation source file matches the base name of file in which the struct is
defined.
This option substantially reduces the size of debugging information,
but at significant potential loss in type information to the debugger.
See ‘-femit-struct-debug-reduced’ for a less aggressive option. See
‘-femit-struct-debug-detailed’ for more detailed control.
This option works only with DWARF debug output.
-femit-struct-debug-reduced
Emit debug information for struct-like types only when the base name of the
compilation source file matches the base name of file in which the type is defined,
unless the struct is a template or defined in a system header.
This option significantly reduces the size of debugging information,
with some potential loss in type information to the debugger. See
‘-femit-struct-debug-baseonly’ for a more aggressive option. See
‘-femit-struct-debug-detailed’ for more detailed control.
This option works only with DWARF debug output.
-femit-struct-debug-detailed[=spec-list]
Specify the struct-like types for which the compiler generates debug informa-
tion. The intent is to reduce duplicate struct debug information between dif-
ferent object files within the same program.
This option is a detailed version of ‘-femit-struct-debug-reduced’ and
‘-femit-struct-debug-baseonly’, which serves for most needs.
A specification has the syntax
[‘dir:’|‘ind:’][‘ord:’|‘gen:’](‘any’|‘sys’|‘base’|‘none’)
The optional first word limits the specification to structs that are used directly
(‘dir:’) or used indirectly (‘ind:’). A struct type is used directly when it is
the type of a variable, member. Indirect uses arise through pointers to structs.
That is, when use of an incomplete struct is valid, the use is indirect. An
example is ‘struct one direct; struct two * indirect;’.
The optional second word limits the specification to ordinary structs (‘ord:’) or
generic structs (‘gen:’). Generic structs are a bit complicated to explain. For
Chapter 3: GCC Command Options 163
Depending on the target and how GCC was configured, a slightly different set of opti-
mizations may be enabled at each ‘-O’ level than those listed here. You can invoke GCC
with ‘-Q --help=optimizers’ to find out the exact set of optimizations that are enabled
at each level. See Section 3.2 [Overall Options], page 33, for examples.
-O
-O1 Optimize. Optimizing compilation takes somewhat more time, and a lot more
memory for a large function.
With ‘-O’, the compiler tries to reduce code size and execution time, without
performing any optimizations that take a great deal of compilation time.
‘-O’ turns on the following optimization flags:
-fauto-inc-dec
-fbranch-count-reg
-fcombine-stack-adjustments
-fcompare-elim
-fcprop-registers
-fdce
-fdefer-pop
-fdelayed-branch
-fdse
-fforward-propagate
-fguess-branch-probability
-fif-conversion
-fif-conversion2
-finline-functions-called-once
-fipa-modref
-fipa-profile
-fipa-pure-const
-fipa-reference
-fipa-reference-addressable
-fmerge-constants
-fmove-loop-invariants
-fmove-loop-stores
-fomit-frame-pointer
-freorder-blocks
-fshrink-wrap
-fshrink-wrap-separate
-fsplit-wide-types
-fssa-backprop
-fssa-phiopt
-ftree-bit-ccp
-ftree-ccp
-ftree-ch
-ftree-coalesce-vars
-ftree-copy-prop
-ftree-dce
-ftree-dominator-opts
-ftree-dse
-ftree-forwprop
-ftree-fre
-ftree-phiprop
-ftree-pta
-ftree-scev-cprop
-ftree-sink
-ftree-slsr
-ftree-sra
Chapter 3: GCC Command Options 165
-ftree-ter
-funit-at-a-time
-O2 Optimize even more. GCC performs nearly all supported optimizations that do
not involve a space-speed tradeoff. As compared to ‘-O’, this option increases
both compilation time and the performance of the generated code.
‘-O2’ turns on all optimization flags specified by ‘-O1’. It also turns on the
following optimization flags:
-falign-functions -falign-jumps
-falign-labels -falign-loops
-fcaller-saves
-fcode-hoisting
-fcrossjumping
-fcse-follow-jumps -fcse-skip-blocks
-fdelete-null-pointer-checks
-fdevirtualize -fdevirtualize-speculatively
-fexpensive-optimizations
-ffinite-loops
-fgcse -fgcse-lm
-fhoist-adjacent-loads
-finline-functions
-finline-small-functions
-findirect-inlining
-fipa-bit-cp -fipa-cp -fipa-icf
-fipa-ra -fipa-sra -fipa-vrp
-fisolate-erroneous-paths-dereference
-flra-remat
-foptimize-sibling-calls
-foptimize-strlen
-fpartial-inlining
-fpeephole2
-freorder-blocks-algorithm=stc
-freorder-blocks-and-partition -freorder-functions
-frerun-cse-after-loop
-fschedule-insns -fschedule-insns2
-fsched-interblock -fsched-spec
-fstore-merging
-fstrict-aliasing
-fthread-jumps
-ftree-builtin-call-dce
-ftree-loop-vectorize
-ftree-pre
-ftree-slp-vectorize
-ftree-switch-conversion -ftree-tail-merge
-ftree-vrp
-fvect-cost-model=very-cheap
Please note the warning under ‘-fgcse’ about invoking ‘-O2’ on programs that
use computed gotos.
-O3 Optimize yet more. ‘-O3’ turns on all optimizations specified by ‘-O2’ and also
turns on the following optimization flags:
-fgcse-after-reload
-fipa-cp-clone -floop-interchange
-floop-unroll-and-jam
-fpeel-loops
-fpredictive-commoning
166 Using the GNU Compiler Collection (GCC)
-fsplit-loops
-fsplit-paths
-ftree-loop-distribution
-ftree-partial-pre
-funswitch-loops
-fvect-cost-model=dynamic
-fversion-loops-for-strides
-O0 Reduce compilation time and make debugging produce the expected results.
This is the default.
-Os Optimize for size. ‘-Os’ enables all ‘-O2’ optimizations except those that often
increase code size:
-falign-functions -falign-jumps
-falign-labels -falign-loops
-fprefetch-loop-arrays -freorder-blocks-algorithm=stc
It also enables ‘-finline-functions’, causes the compiler to tune for code
size rather than execution speed, and performs further optimizations designed
to reduce code size.
-Ofast Disregard strict standards compliance. ‘-Ofast’ enables all ‘-O3’ optimiza-
tions. It also enables optimizations that are not valid for all standard-compliant
programs. It turns on ‘-ffast-math’, ‘-fallow-store-data-races’ and the
Fortran-specific ‘-fstack-arrays’, unless ‘-fmax-stack-var-size’ is speci-
fied, and ‘-fno-protect-parens’. It turns off ‘-fsemantic-interposition’.
-Og Optimize debugging experience. ‘-Og’ should be the optimization level of choice
for the standard edit-compile-debug cycle, offering a reasonable level of opti-
mization while maintaining fast compilation and a good debugging experience.
It is a better choice than ‘-O0’ for producing debuggable code because some
compiler passes that collect debug information are disabled at ‘-O0’.
Like ‘-O0’, ‘-Og’ completely disables a number of optimization passes so that
individual options controlling them have no effect. Otherwise ‘-Og’ enables all
‘-O1’ optimization flags except for those that may interfere with debugging:
-fbranch-count-reg -fdelayed-branch
-fdse -fif-conversion -fif-conversion2
-finline-functions-called-once
-fmove-loop-invariants -fmove-loop-stores -fssa-phiopt
-ftree-bit-ccp -ftree-dse -ftree-pta -ftree-sra
-Oz Optimize aggressively for size rather than speed. This may increase the number
of instructions executed if those instructions require fewer bytes to encode. ‘-Oz’
behaves similarly to ‘-Os’ including enabling most ‘-O2’ optimizations.
If you use multiple ‘-O’ options, with or without level numbers, the last such option is
the one that is effective.
Options of the form ‘-fflag’ specify machine-independent flags. Most flags have both
positive and negative forms; the negative form of ‘-ffoo’ is ‘-fno-foo’. In the table below,
only one of the forms is listed—the one you typically use. You can figure out the other form
by either removing ‘no-’ or adding it.
The following options control specific optimizations. They are either activated by ‘-O’
options or are related to ones that are. You can use the following flags in the rare cases
when “fine-tuning” of optimizations to be performed is desired.
Chapter 3: GCC Command Options 167
-fno-defer-pop
For machines that must pop arguments after a function call, always pop
the arguments as soon as each function returns. At levels ‘-O1’ and higher,
‘-fdefer-pop’ is the default; this allows the compiler to let arguments
accumulate on the stack for several function calls and pop them all at once.
-fforward-propagate
Perform a forward propagation pass on RTL. The pass tries to combine two
instructions and checks if the result can be simplified. If loop unrolling is active,
two passes are performed and the second is scheduled after loop unrolling.
This option is enabled by default at optimization levels ‘-O1’, ‘-O2’, ‘-O3’, ‘-Os’.
-ffp-contract=style
‘-ffp-contract=off’ disables floating-point expression contraction.
‘-ffp-contract=fast’ enables floating-point expression contraction such as
forming of fused multiply-add operations if the target has native support for
them. ‘-ffp-contract=on’ enables floating-point expression contraction if
allowed by the language standard. This is currently not implemented and
treated equal to ‘-ffp-contract=off’.
The default is ‘-ffp-contract=fast’.
-fomit-frame-pointer
Omit the frame pointer in functions that don’t need one. This avoids the
instructions to save, set up and restore the frame pointer; on many targets it
also makes an extra register available.
On some targets this flag has no effect because the standard calling sequence
always uses a frame pointer, so it cannot be omitted.
Note that ‘-fno-omit-frame-pointer’ doesn’t guarantee the frame pointer is
used in all functions. Several targets always omit the frame pointer in leaf
functions.
Enabled by default at ‘-O1’ and higher.
-foptimize-sibling-calls
Optimize sibling and tail recursive calls.
Enabled at levels ‘-O2’, ‘-O3’, ‘-Os’.
-foptimize-strlen
Optimize various standard C string functions (e.g. strlen, strchr or strcpy)
and their _FORTIFY_SOURCE counterparts into faster alternatives.
Enabled at levels ‘-O2’, ‘-O3’.
-fno-inline
Do not expand any functions inline apart from those marked with the always_
inline attribute. This is the default when not optimizing.
Single functions can be exempted from inlining by marking them with the
noinline attribute.
-finline-small-functions
Integrate functions into their callers when their body is smaller than expected
function call code (so overall size of program gets smaller). The compiler heuris-
168 Using the GNU Compiler Collection (GCC)
tically decides which functions are simple enough to be worth integrating in this
way. This inlining applies to all functions, even those not declared inline.
Enabled at levels ‘-O2’, ‘-O3’, ‘-Os’.
-findirect-inlining
Inline also indirect calls that are discovered to be known at compile time thanks
to previous inlining. This option has any effect only when inlining itself is turned
on by the ‘-finline-functions’ or ‘-finline-small-functions’ options.
Enabled at levels ‘-O2’, ‘-O3’, ‘-Os’.
-finline-functions
Consider all functions for inlining, even if they are not declared inline. The
compiler heuristically decides which functions are worth integrating in this way.
If all calls to a given function are integrated, and the function is declared
static, then the function is normally not output as assembler code in its own
right.
Enabled at levels ‘-O2’, ‘-O3’, ‘-Os’. Also enabled by ‘-fprofile-use’ and
‘-fauto-profile’.
-finline-functions-called-once
Consider all static functions called once for inlining into their caller even if
they are not marked inline. If a call to a given function is integrated, then
the function is not output as assembler code in its own right.
Enabled at levels ‘-O1’, ‘-O2’, ‘-O3’ and ‘-Os’, but not ‘-Og’.
-fearly-inlining
Inline functions marked by always_inline and functions whose body
seems smaller than the function call overhead early before doing
‘-fprofile-generate’ instrumentation and real inlining pass. Doing so makes
profiling significantly cheaper and usually inlining faster on programs having
large chains of nested wrapper functions.
Enabled by default.
-fipa-sra
Perform interprocedural scalar replacement of aggregates, removal of unused
parameters and replacement of parameters passed by reference by parameters
passed by value.
Enabled at levels ‘-O2’, ‘-O3’ and ‘-Os’.
-finline-limit=n
By default, GCC limits the size of functions that can be inlined. This flag
allows coarse control of this limit. n is the size of functions that can be inlined
in number of pseudo instructions.
Inlining is actually controlled by a number of parameters, which may be spec-
ified individually by using ‘--param name=value’. The ‘-finline-limit=n’
option sets some of these parameters as follows:
max-inline-insns-single
is set to n/2.
Chapter 3: GCC Command Options 169
max-inline-insns-auto
is set to n/2.
-fno-keep-inline-dllexport
This is a more fine-grained version of ‘-fkeep-inline-functions’, which ap-
plies only to functions that are declared using the dllexport attribute or de-
clspec. See Section 6.33 [Declaring Attributes of Functions], page 556.
-fkeep-inline-functions
In C, emit static functions that are declared inline into the object file, even
if the function has been inlined into all of its callers. This switch does not affect
functions using the extern inline extension in GNU C90. In C++, emit any
and all inline functions into the object file.
-fkeep-static-functions
Emit static functions into the object file, even if the function is never used.
-fkeep-static-consts
Emit variables declared static const when optimization isn’t turned on, even
if the variables aren’t referenced.
GCC enables this option by default. If you want to force the compiler to check
if a variable is referenced, regardless of whether or not optimization is turned
on, use the ‘-fno-keep-static-consts’ option.
-fmerge-constants
Attempt to merge identical constants (string constants and floating-point con-
stants) across compilation units.
This option is the default for optimized compilation if the assembler and linker
support it. Use ‘-fno-merge-constants’ to inhibit this behavior.
Enabled at levels ‘-O1’, ‘-O2’, ‘-O3’, ‘-Os’.
-fmerge-all-constants
Attempt to merge identical constants and identical variables.
This option implies ‘-fmerge-constants’. In addition to ‘-fmerge-constants’
this considers e.g. even constant initialized arrays or initialized constant vari-
ables with integral or floating-point types. Languages like C or C++ require each
variable, including multiple instances of the same variable in recursive calls, to
have distinct locations, so using this option results in non-conforming behavior.
170 Using the GNU Compiler Collection (GCC)
-fmodulo-sched
Perform swing modulo scheduling immediately before the first scheduling pass.
This pass looks at innermost loops and reorders their instructions by overlap-
ping different iterations.
-fmodulo-sched-allow-regmoves
Perform more aggressive SMS-based modulo scheduling with register moves
allowed. By setting this flag certain anti-dependences edges are deleted, which
triggers the generation of reg-moves based on the life-range analysis. This
option is effective only with ‘-fmodulo-sched’ enabled.
-fno-branch-count-reg
Disable the optimization pass that scans for opportunities to use “decrement
and branch” instructions on a count register instead of instruction sequences
that decrement a register, compare it against zero, and then branch based upon
the result. This option is only meaningful on architectures that support such
instructions, which include x86, PowerPC, IA-64 and S/390. Note that the
‘-fno-branch-count-reg’ option doesn’t remove the decrement and branch
instructions from the generated instruction stream introduced by other opti-
mization passes.
The default is ‘-fbranch-count-reg’ at ‘-O1’ and higher, except for ‘-Og’.
-fno-function-cse
Do not put function addresses in registers; make each instruction that calls a
constant function contain the function’s address explicitly.
This option results in less efficient code, but some strange hacks that alter the
assembler output may be confused by the optimizations performed when this
option is not used.
The default is ‘-ffunction-cse’
-fno-zero-initialized-in-bss
If the target supports a BSS section, GCC by default puts variables that are
initialized to zero into BSS. This can save space in the resulting code.
This option turns off this behavior because some programs explicitly rely on
variables going to the data section—e.g., so that the resulting executable can
find the beginning of that section and/or make assumptions based on that.
The default is ‘-fzero-initialized-in-bss’.
-fthread-jumps
Perform optimizations that check to see if a jump branches to a location where
another comparison subsumed by the first is found. If so, the first branch is
redirected to either the destination of the second branch or a point immediately
following it, depending on whether the condition is known to be true or false.
Enabled at levels ‘-O1’, ‘-O2’, ‘-O3’, ‘-Os’.
-fsplit-wide-types
When using a type that occupies multiple registers, such as long long on a
32-bit system, split the registers apart and allocate them independently. This
Chapter 3: GCC Command Options 171
normally generates better code for those types, but may make debugging more
difficult.
Enabled at levels ‘-O1’, ‘-O2’, ‘-O3’, ‘-Os’.
-fsplit-wide-types-early
Fully split wide types early, instead of very late. This option has no effect unless
‘-fsplit-wide-types’ is turned on.
This is the default on some targets.
-fcse-follow-jumps
In common subexpression elimination (CSE), scan through jump instructions
when the target of the jump is not reached by any other path. For example,
when CSE encounters an if statement with an else clause, CSE follows the
jump when the condition tested is false.
Enabled at levels ‘-O2’, ‘-O3’, ‘-Os’.
-fcse-skip-blocks
This is similar to ‘-fcse-follow-jumps’, but causes CSE to follow jumps that
conditionally skip over blocks. When CSE encounters a simple if statement
with no else clause, ‘-fcse-skip-blocks’ causes CSE to follow the jump around
the body of the if.
Enabled at levels ‘-O2’, ‘-O3’, ‘-Os’.
-frerun-cse-after-loop
Re-run common subexpression elimination after loop optimizations are per-
formed.
Enabled at levels ‘-O2’, ‘-O3’, ‘-Os’.
-fgcse Perform a global common subexpression elimination pass. This pass also per-
forms global constant and copy propagation.
Note: When compiling a program using computed gotos, a GCC extension,
you may get better run-time performance if you disable the global common
subexpression elimination pass by adding ‘-fno-gcse’ to the command line.
Enabled at levels ‘-O2’, ‘-O3’, ‘-Os’.
-fgcse-lm
When ‘-fgcse-lm’ is enabled, global common subexpression elimination at-
tempts to move loads that are only killed by stores into themselves. This
allows a loop containing a load/store sequence to be changed to a load outside
the loop, and a copy/store within the loop.
Enabled by default when ‘-fgcse’ is enabled.
-fgcse-sm
When ‘-fgcse-sm’ is enabled, a store motion pass is run after global common
subexpression elimination. This pass attempts to move stores out of loops.
When used in conjunction with ‘-fgcse-lm’, loops containing a load/store se-
quence can be changed to a load before the loop and a store after the loop.
Not enabled at any optimization level.
172 Using the GNU Compiler Collection (GCC)
-fgcse-las
When ‘-fgcse-las’ is enabled, the global common subexpression elimination
pass eliminates redundant loads that come after stores to the same memory
location (both partial and full redundancies).
Not enabled at any optimization level.
-fgcse-after-reload
When ‘-fgcse-after-reload’ is enabled, a redundant load elimination pass
is performed after reload. The purpose of this pass is to clean up redundant
spilling.
Enabled by ‘-O3’, ‘-fprofile-use’ and ‘-fauto-profile’.
-faggressive-loop-optimizations
This option tells the loop optimizer to use language constraints to derive bounds
for the number of iterations of a loop. This assumes that loop code does not
invoke undefined behavior by for example causing signed integer overflows or
out-of-bound array accesses. The bounds for the number of iterations of a loop
are used to guide loop unrolling and peeling and loop exit test optimizations.
This option is enabled by default.
-funconstrained-commons
This option tells the compiler that variables declared in common blocks (e.g.
Fortran) may later be overridden with longer trailing arrays. This prevents
certain optimizations that depend on knowing the array bounds.
-fcrossjumping
Perform cross-jumping transformation. This transformation unifies equivalent
code and saves code size. The resulting code may or may not perform better
than without cross-jumping.
Enabled at levels ‘-O2’, ‘-O3’, ‘-Os’.
-fauto-inc-dec
Combine increments or decrements of addresses with memory accesses. This
pass is always skipped on architectures that do not have instructions to support
this. Enabled by default at ‘-O1’ and higher on architectures that support this.
-fdce Perform dead code elimination (DCE) on RTL. Enabled by default at ‘-O1’
and higher.
-fdse Perform dead store elimination (DSE) on RTL. Enabled by default at ‘-O1’
and higher.
-fif-conversion
Attempt to transform conditional jumps into branch-less equivalents. This
includes use of conditional moves, min, max, set flags and abs instructions, and
some tricks doable by standard arithmetics. The use of conditional execution
on chips where it is available is controlled by ‘-fif-conversion2’.
Enabled at levels ‘-O1’, ‘-O2’, ‘-O3’, ‘-Os’, but not with ‘-Og’.
-fif-conversion2
Use conditional execution (where available) to transform conditional jumps into
branch-less equivalents.
Chapter 3: GCC Command Options 173
Enabled at levels ‘-O1’, ‘-O2’, ‘-O3’, ‘-Os’, but not with ‘-Og’.
-fdeclone-ctor-dtor
The C++ ABI requires multiple entry points for constructors and destructors:
one for a base subobject, one for a complete object, and one for a virtual
destructor that calls operator delete afterwards. For a hierarchy with virtual
bases, the base and complete variants are clones, which means two copies of the
function. With this option, the base and complete variants are changed to be
thunks that call a common implementation.
Enabled by ‘-Os’.
-fdelete-null-pointer-checks
Assume that programs cannot safely dereference null pointers, and that no code
or data element resides at address zero. This option enables simple constant
folding optimizations at all optimization levels. In addition, other optimization
passes in GCC use this flag to control global dataflow analyses that eliminate
useless checks for null pointers; these assume that a memory access to address
zero always results in a trap, so that if a pointer is checked after it has already
been dereferenced, it cannot be null.
Note however that in some environments this assumption is not true.
Use ‘-fno-delete-null-pointer-checks’ to disable this optimization for
programs that depend on that behavior.
This option is enabled by default on most targets. On Nios II ELF, it defaults
to off. On AVR, CR16, and MSP430, this option is completely disabled.
Passes that use the dataflow information are enabled independently at different
optimization levels.
-fdevirtualize
Attempt to convert calls to virtual functions to direct calls. This is
done both within a procedure and interprocedurally as part of indirect
inlining (‘-findirect-inlining’) and interprocedural constant propagation
(‘-fipa-cp’). Enabled at levels ‘-O2’, ‘-O3’, ‘-Os’.
-fdevirtualize-speculatively
Attempt to convert calls to virtual functions to speculative direct calls. Based
on the analysis of the type inheritance graph, determine for a given call the
set of likely targets. If the set is small, preferably of size 1, change the call
into a conditional deciding between direct and indirect calls. The speculative
calls enable more optimizations, such as inlining. When they seem useless after
further optimization, they are converted back into original form.
-fdevirtualize-at-ltrans
Stream extra information needed for aggressive devirtualization when running
the link-time optimizer in local transformation mode. This option enables more
devirtualization but significantly increases the size of streamed data. For this
reason it is disabled by default.
-fexpensive-optimizations
Perform a number of minor optimizations that are relatively expensive.
Enabled at levels ‘-O2’, ‘-O3’, ‘-Os’.
174 Using the GNU Compiler Collection (GCC)
-fno-lifetime-dse
In C++ the value of an object is only affected by changes within its lifetime:
when the constructor begins, the object has an indeterminate value, and
any changes during the lifetime of the object are dead when the object is
destroyed. Normally dead store elimination will take advantage of this; if your
code relies on the value of the object storage persisting beyond the lifetime
of the object, you can use this flag to disable this optimization. To preserve
stores before the constructor starts (e.g. because your operator new clears
the object storage) but still treat the object as dead after the destructor,
you can use ‘-flifetime-dse=1’. The default behavior can be explicitly
selected with ‘-flifetime-dse=2’. ‘-flifetime-dse=0’ is equivalent to
‘-fno-lifetime-dse’.
-flive-range-shrinkage
Attempt to decrease register pressure through register live range shrinkage.
This is helpful for fast processors with small or moderate size register sets.
-fira-algorithm=algorithm
Use the specified coloring algorithm for the integrated register allocator. The
algorithm argument can be ‘priority’, which specifies Chow’s priority coloring,
or ‘CB’, which specifies Chaitin-Briggs coloring. Chaitin-Briggs coloring is not
implemented for all architectures, but for those targets that do support it, it is
the default because it generates better code.
-fira-region=region
Use specified regions for the integrated register allocator. The region argument
should be one of the following:
‘all’ Use all loops as register allocation regions. This can give the best
results for machines with a small and/or irregular register set.
‘mixed’ Use all loops except for loops with small register pressure as the
regions. This value usually gives the best results in most cases and
for most architectures, and is enabled by default when compiling
with optimization for speed (‘-O’, ‘-O2’, . . . ).
‘one’ Use all functions as a single region. This typically results in the
smallest code size, and is enabled by default for ‘-Os’ or ‘-O0’.
-fira-hoist-pressure
Use IRA to evaluate register pressure in the code hoisting pass for decisions to
hoist expressions. This option usually results in smaller code, but it can slow
the compiler down.
This option is enabled at level ‘-Os’ for all targets.
Chapter 3: GCC Command Options 175
-fira-loop-pressure
Use IRA to evaluate register pressure in loops for decisions to move loop in-
variants. This option usually results in generation of faster and smaller code on
machines with large register files (>= 32 registers), but it can slow the compiler
down.
This option is enabled at level ‘-O3’ for some targets.
-fno-ira-share-save-slots
Disable sharing of stack slots used for saving call-used hard registers living
through a call. Each hard register gets a separate stack slot, and as a result
function stack frames are larger.
-fno-ira-share-spill-slots
Disable sharing of stack slots allocated for pseudo-registers. Each pseudo-
register that does not get a hard register gets a separate stack slot, and as
a result function stack frames are larger.
-flra-remat
Enable CFG-sensitive rematerialization in LRA. Instead of loading values of
spilled pseudos, LRA tries to rematerialize (recalculate) values if it is profitable.
Enabled at levels ‘-O2’, ‘-O3’, ‘-Os’.
-fdelayed-branch
If supported for the target machine, attempt to reorder instructions to exploit
instruction slots available after delayed branch instructions.
Enabled at levels ‘-O1’, ‘-O2’, ‘-O3’, ‘-Os’, but not at ‘-Og’.
-fschedule-insns
If supported for the target machine, attempt to reorder instructions to eliminate
execution stalls due to required data being unavailable. This helps machines
that have slow floating point or memory load instructions by allowing other
instructions to be issued until the result of the load or floating-point instruction
is required.
Enabled at levels ‘-O2’, ‘-O3’.
-fschedule-insns2
Similar to ‘-fschedule-insns’, but requests an additional pass of instruction
scheduling after register allocation has been done. This is especially useful on
machines with a relatively small number of registers and where memory load
instructions take more than one cycle.
Enabled at levels ‘-O2’, ‘-O3’, ‘-Os’.
-fno-sched-interblock
Disable instruction scheduling across basic blocks, which is normally enabled
when scheduling before register allocation, i.e. with ‘-fschedule-insns’ or at
‘-O2’ or higher.
-fno-sched-spec
Disable speculative motion of non-load instructions, which is normally enabled
when scheduling before register allocation, i.e. with ‘-fschedule-insns’ or at
‘-O2’ or higher.
176 Using the GNU Compiler Collection (GCC)
-fsched-pressure
Enable register pressure sensitive insn scheduling before register allocation.
This only makes sense when scheduling before register allocation is enabled,
i.e. with ‘-fschedule-insns’ or at ‘-O2’ or higher. Usage of this option can
improve the generated code and decrease its size by preventing register pressure
increase above the number of available hard registers and subsequent spills in
register allocation.
-fsched-spec-load
Allow speculative motion of some load instructions. This only makes sense
when scheduling before register allocation, i.e. with ‘-fschedule-insns’ or at
‘-O2’ or higher.
-fsched-spec-load-dangerous
Allow speculative motion of more load instructions. This only makes sense
when scheduling before register allocation, i.e. with ‘-fschedule-insns’ or at
‘-O2’ or higher.
-fsched-stalled-insns
-fsched-stalled-insns=n
Define how many insns (if any) can be moved prematurely from the queue
of stalled insns into the ready list during the second scheduling pass.
‘-fno-sched-stalled-insns’ means that no insns are moved prematurely,
‘-fsched-stalled-insns=0’ means there is no limit on how many queued
insns can be moved prematurely. ‘-fsched-stalled-insns’ without a value
is equivalent to ‘-fsched-stalled-insns=1’.
-fsched-stalled-insns-dep
-fsched-stalled-insns-dep=n
Define how many insn groups (cycles) are examined for a depen-
dency on a stalled insn that is a candidate for premature removal
from the queue of stalled insns. This has an effect only during
the second scheduling pass, and only if ‘-fsched-stalled-insns’
is used. ‘-fno-sched-stalled-insns-dep’ is equivalent to
‘-fsched-stalled-insns-dep=0’. ‘-fsched-stalled-insns-dep’
without a value is equivalent to ‘-fsched-stalled-insns-dep=1’.
-fsched2-use-superblocks
When scheduling after register allocation, use superblock scheduling. This al-
lows motion across basic block boundaries, resulting in faster schedules. This
option is experimental, as not all machine descriptions used by GCC model the
CPU closely enough to avoid unreliable results from the algorithm.
This only makes sense when scheduling after register allocation, i.e. with
‘-fschedule-insns2’ or at ‘-O2’ or higher.
-fsched-group-heuristic
Enable the group heuristic in the scheduler. This heuristic favors the instruction
that belongs to a schedule group. This is enabled by default when scheduling
is enabled, i.e. with ‘-fschedule-insns’ or ‘-fschedule-insns2’ or at ‘-O2’
or higher.
Chapter 3: GCC Command Options 177
-fsched-critical-path-heuristic
Enable the critical-path heuristic in the scheduler. This heuristic favors in-
structions on the critical path. This is enabled by default when scheduling is
enabled, i.e. with ‘-fschedule-insns’ or ‘-fschedule-insns2’ or at ‘-O2’ or
higher.
-fsched-spec-insn-heuristic
Enable the speculative instruction heuristic in the scheduler. This heuristic
favors speculative instructions with greater dependency weakness. This is en-
abled by default when scheduling is enabled, i.e. with ‘-fschedule-insns’ or
‘-fschedule-insns2’ or at ‘-O2’ or higher.
-fsched-rank-heuristic
Enable the rank heuristic in the scheduler. This heuristic favors the instruc-
tion belonging to a basic block with greater size or frequency. This is en-
abled by default when scheduling is enabled, i.e. with ‘-fschedule-insns’ or
‘-fschedule-insns2’ or at ‘-O2’ or higher.
-fsched-last-insn-heuristic
Enable the last-instruction heuristic in the scheduler. This heuristic favors the
instruction that is less dependent on the last instruction scheduled. This is
enabled by default when scheduling is enabled, i.e. with ‘-fschedule-insns’
or ‘-fschedule-insns2’ or at ‘-O2’ or higher.
-fsched-dep-count-heuristic
Enable the dependent-count heuristic in the scheduler. This heuristic favors
the instruction that has more instructions depending on it. This is enabled
by default when scheduling is enabled, i.e. with ‘-fschedule-insns’ or
‘-fschedule-insns2’ or at ‘-O2’ or higher.
-freschedule-modulo-scheduled-loops
Modulo scheduling is performed before traditional scheduling. If a loop is mod-
ulo scheduled, later scheduling passes may change its schedule. Use this option
to control that behavior.
-fselective-scheduling
Schedule instructions using selective scheduling algorithm. Selective scheduling
runs instead of the first scheduler pass.
-fselective-scheduling2
Schedule instructions using selective scheduling algorithm. Selective scheduling
runs instead of the second scheduler pass.
-fsel-sched-pipelining
Enable software pipelining of innermost loops during selective scheduling.
This option has no effect unless one of ‘-fselective-scheduling’ or
‘-fselective-scheduling2’ is turned on.
-fsel-sched-pipelining-outer-loops
When pipelining loops during selective scheduling, also pipeline outer loops.
This option has no effect unless ‘-fsel-sched-pipelining’ is turned on.
178 Using the GNU Compiler Collection (GCC)
-fsemantic-interposition
Some object formats, like ELF, allow interposing of symbols by the dynamic
linker. This means that for symbols exported from the DSO, the compiler can-
not perform interprocedural propagation, inlining and other optimizations in
anticipation that the function or variable in question may change. While this
feature is useful, for example, to rewrite memory allocation functions by a de-
bugging implementation, it is expensive in the terms of code quality. With
‘-fno-semantic-interposition’ the compiler assumes that if interposition
happens for functions the overwriting function will have precisely the same
semantics (and side effects). Similarly if interposition happens for variables,
the constructor of the variable will be the same. The flag has no effect for
functions explicitly declared inline (where it is never allowed for interposition
to change semantics) and for symbols explicitly declared weak.
-fshrink-wrap
Emit function prologues only before parts of the function that need it, rather
than at the top of the function. This flag is enabled by default at ‘-O’ and
higher.
-fshrink-wrap-separate
Shrink-wrap separate parts of the prologue and epilogue separately, so that
those parts are only executed when needed. This option is on by default, but
has no effect unless ‘-fshrink-wrap’ is also turned on and the target supports
this.
-fcaller-saves
Enable allocation of values to registers that are clobbered by function calls, by
emitting extra instructions to save and restore the registers around such calls.
Such allocation is done only when it seems to result in better code.
This option is always enabled by default on certain machines, usually those
which have no call-preserved registers to use instead.
Enabled at levels ‘-O2’, ‘-O3’, ‘-Os’.
-fcombine-stack-adjustments
Tracks stack adjustments (pushes and pops) and stack memory references and
then tries to find ways to combine them.
Enabled by default at ‘-O1’ and higher.
-fipa-ra Use caller save registers for allocation if those registers are not used by any called
function. In that case it is not necessary to save and restore them around calls.
This is only possible if called functions are part of same compilation unit as
current function and they are compiled before it.
Enabled at levels ‘-O2’, ‘-O3’, ‘-Os’, however the option is disabled if generated
code will be instrumented for profiling (‘-p’, or ‘-pg’) or if callee’s register usage
cannot be known exactly (this happens on targets that do not expose prologues
and epilogues in RTL).
-fconserve-stack
Attempt to minimize stack usage. The compiler attempts to use less stack
space, even if that makes the program slower. This option implies setting the
Chapter 3: GCC Command Options 179
-fipa-reference-addressable
Discover read-only, write-only and non-addressable static variables. Enabled
by default at ‘-O1’ and higher.
-fipa-stack-alignment
Reduce stack alignment on call sites if possible. Enabled by default.
-fipa-pta
Perform interprocedural pointer analysis and interprocedural modification and
reference analysis. This option can cause excessive memory and compile-time
usage on large compilation units. It is not enabled by default at any optimiza-
tion level.
-fipa-profile
Perform interprocedural profile propagation. The functions called only from
cold functions are marked as cold. Also functions executed once (such as cold,
noreturn, static constructors or destructors) are identified. Cold functions and
loop less parts of functions executed once are then optimized for size. Enabled
by default at ‘-O1’ and higher.
-fipa-modref
Perform interprocedural mod/ref analysis. This optimization analyzes the side
effects of functions (memory locations that are modified or referenced) and
enables better optimization across the function call boundary. This flag is
enabled by default at ‘-O1’ and higher.
-fipa-cp Perform interprocedural constant propagation. This optimization analyzes the
program to determine when values passed to functions are constants and then
optimizes accordingly. This optimization can substantially increase perfor-
mance if the application has constants passed to functions. This flag is enabled
by default at ‘-O2’, ‘-Os’ and ‘-O3’. It is also enabled by ‘-fprofile-use’ and
‘-fauto-profile’.
-fipa-cp-clone
Perform function cloning to make interprocedural constant propagation
stronger. When enabled, interprocedural constant propagation performs
function cloning when externally visible function can be called with
constant arguments. Because this optimization can create multiple
copies of functions, it may significantly increase code size (see ‘--param
ipa-cp-unit-growth=value’). This flag is enabled by default at ‘-O3’. It is
also enabled by ‘-fprofile-use’ and ‘-fauto-profile’.
-fipa-bit-cp
When enabled, perform interprocedural bitwise constant propagation. This flag
is enabled by default at ‘-O2’ and by ‘-fprofile-use’ and ‘-fauto-profile’.
It requires that ‘-fipa-cp’ is enabled.
-fipa-vrp
When enabled, perform interprocedural propagation of value ranges. This flag
is enabled by default at ‘-O2’. It requires that ‘-fipa-cp’ is enabled.
Chapter 3: GCC Command Options 181
-fipa-icf
Perform Identical Code Folding for functions and read-only variables. The
optimization reduces code size and may disturb unwind stacks by replacing a
function by equivalent one with a different name. The optimization works more
effectively with link-time optimization enabled.
Although the behavior is similar to the Gold Linker’s ICF optimization, GCC
ICF works on different levels and thus the optimizations are not same - there
are equivalences that are found only by GCC and equivalences found only by
Gold.
This flag is enabled by default at ‘-O2’ and ‘-Os’.
-flive-patching=level
Control GCC’s optimizations to produce output suitable for live-patching.
If the compiler’s optimization uses a function’s body or information extracted
from its body to optimize/change another function, the latter is called an im-
pacted function of the former. If a function is patched, its impacted functions
should be patched too.
The impacted functions are determined by the compiler’s interprocedural op-
timizations. For example, a caller is impacted when inlining a function into
its caller, cloning a function and changing its caller to call this new clone, or
extracting a function’s pureness/constness information to optimize its direct or
indirect callers, etc.
Usually, the more IPA optimizations enabled, the larger the number of impacted
functions for each function. In order to control the number of impacted func-
tions and more easily compute the list of impacted function, IPA optimizations
can be partially enabled at two different levels.
The level argument should be one of the following:
‘inline-clone’
Only enable inlining and cloning optimizations, which includes in-
lining, cloning, interprocedural scalar replacement of aggregates
and partial inlining. As a result, when patching a function, all
its callers and its clones’ callers are impacted, therefore need to be
patched as well.
‘-flive-patching=inline-clone’ disables the following optimiza-
tion flags:
-fwhole-program -fipa-pta -fipa-reference -fipa-ra
-fipa-icf -fipa-icf-functions -fipa-icf-variables
-fipa-bit-cp -fipa-vrp -fipa-pure-const -fipa-reference-addressable
-fipa-stack-alignment -fipa-modref
‘inline-only-static’
Only enable inlining of static functions. As a result, when patching
a static function, all its callers are impacted and so need to be
patched as well.
In addition to all the flags that ‘-flive-patching=inline-clone’
disables, ‘-flive-patching=inline-only-static’ disables the
following additional optimization flags:
182 Using the GNU Compiler Collection (GCC)
This flag is enabled by default at ‘-O2’ and higher. The compilation time in
this pass can be limited using ‘max-tail-merge-comparisons’ parameter and
‘max-tail-merge-iterations’ parameter.
-ftree-dce
Perform dead code elimination (DCE) on trees. This flag is enabled by default
at ‘-O1’ and higher.
-ftree-builtin-call-dce
Perform conditional dead code elimination (DCE) for calls to built-in functions
that may set errno but are otherwise free of side effects. This flag is enabled
by default at ‘-O2’ and higher if ‘-Os’ is not also specified.
-ffinite-loops
Assume that a loop with an exit will eventually take the exit and not loop
indefinitely. This allows the compiler to remove loops that otherwise have no
side-effects, not considering eventual endless looping as such.
This option is enabled by default at ‘-O2’ for C++ with -std=c++11 or higher.
-ftree-dominator-opts
Perform a variety of simple scalar cleanups (constant/copy propagation, redun-
dancy elimination, range propagation and expression simplification) based on a
dominator tree traversal. This also performs jump threading (to reduce jumps
to jumps). This flag is enabled by default at ‘-O1’ and higher.
-ftree-dse
Perform dead store elimination (DSE) on trees. A dead store is a store into a
memory location that is later overwritten by another store without any inter-
vening loads. In this case the earlier store can be deleted. This flag is enabled
by default at ‘-O1’ and higher.
-ftree-ch
Perform loop header copying on trees. This is beneficial since it increases ef-
fectiveness of code motion optimizations. It also saves one jump. This flag
is enabled by default at ‘-O1’ and higher. It is not enabled for ‘-Os’, since it
usually increases code size.
-ftree-loop-optimize
Perform loop optimizations on trees. This flag is enabled by default at ‘-O1’
and higher.
-ftree-loop-linear
-floop-strip-mine
-floop-block
Perform loop nest optimizations. Same as ‘-floop-nest-optimize’. To use
this code transformation, GCC has to be configured with ‘--with-isl’ to en-
able the Graphite loop transformation infrastructure.
-fgraphite-identity
Enable the identity transformation for graphite. For every SCoP we gener-
ate the polyhedral representation and transform it back to gimple. Using
‘-fgraphite-identity’ we can check the costs or benefits of the GIMPLE
184 Using the GNU Compiler Collection (GCC)
DO I = 1, N
A(I) = 0
B(I) = A(I) + I
ENDDO
is transformed to
DO I = 1, N
A(I) = 0
ENDDO
DO I = 1, N
B(I) = A(I) + I
ENDDO
and the initialization loop is transformed into a call to memset zero. This
flag is enabled by default at ‘-O3’. It is also enabled by ‘-fprofile-use’ and
‘-fauto-profile’.
-floop-interchange
Perform loop interchange outside of graphite. This flag can improve cache per-
formance on loop nest and allow further loop optimizations, like vectorization,
to take place. For example, the loop
for (int i = 0; i < N; i++)
for (int j = 0; j < N; j++)
for (int k = 0; k < N; k++)
c[i][j] = c[i][j] + a[i][k]*b[k][j];
is transformed to
for (int i = 0; i < N; i++)
for (int k = 0; k < N; k++)
for (int j = 0; j < N; j++)
c[i][j] = c[i][j] + a[i][k]*b[k][j];
-floop-unroll-and-jam
Apply unroll and jam transformations on feasible loops. In a loop nest this un-
rolls the outer loop by some factor and fuses the resulting multiple inner loops.
This flag is enabled by default at ‘-O3’. It is also enabled by ‘-fprofile-use’
and ‘-fauto-profile’.
-ftree-loop-im
Perform loop invariant motion on trees. This pass moves only invariants that
are hard to handle at RTL level (function calls, operations that expand to non-
trivial sequences of insns). With ‘-funswitch-loops’ it also moves operands
of conditions that are invariant out of the loop, so that we can use just trivial
invariantness analysis in loop unswitching. The pass also includes store motion.
-ftree-loop-ivcanon
Create a canonical counter for number of iterations in loops for which deter-
mining number of iterations requires complicated analysis. Later optimizations
then may determine the number easily. Useful especially in connection with
unrolling.
186 Using the GNU Compiler Collection (GCC)
-ftree-scev-cprop
Perform final value replacement. If a variable is modified in a loop in such a
way that its value when exiting the loop can be determined using only its initial
value and the number of loop iterations, replace uses of the final value by such a
computation, provided it is sufficiently cheap. This reduces data dependencies
and may allow further simplifications. Enabled by default at ‘-O1’ and higher.
-fivopts Perform induction variable optimizations (strength reduction, induction vari-
able merging and induction variable elimination) on trees.
-ftree-parallelize-loops=n
Parallelize loops, i.e., split their iteration space to run in n threads. This is
only possible for loops whose iterations are independent and can be arbitrarily
reordered. The optimization is only profitable on multiprocessor machines, for
loops that are CPU-intensive, rather than constrained e.g. by memory band-
width. This option implies ‘-pthread’, and thus is only supported on targets
that have support for ‘-pthread’.
-ftree-pta
Perform function-local points-to analysis on trees. This flag is enabled by de-
fault at ‘-O1’ and higher, except for ‘-Og’.
-ftree-sra
Perform scalar replacement of aggregates. This pass replaces structure refer-
ences with scalars to prevent committing structures to memory too early. This
flag is enabled by default at ‘-O1’ and higher, except for ‘-Og’.
-fstore-merging
Perform merging of narrow stores to consecutive memory addresses. This pass
merges contiguous stores of immediate values narrower than a word into fewer
wider stores to reduce the number of instructions. This is enabled by default
at ‘-O2’ and higher as well as ‘-Os’.
-ftree-ter
Perform temporary expression replacement during the SSA->normal phase. Sin-
gle use/single def temporaries are replaced at their use location with their defin-
ing expression. This results in non-GIMPLE code, but gives the expanders
much more complex trees to work on resulting in better RTL generation. This
is enabled by default at ‘-O1’ and higher.
-ftree-slsr
Perform straight-line strength reduction on trees. This recognizes related ex-
pressions involving multiplications and replaces them by less expensive calcu-
lations when possible. This is enabled by default at ‘-O1’ and higher.
-ftree-vectorize
Perform vectorization on trees. This flag enables ‘-ftree-loop-vectorize’
and ‘-ftree-slp-vectorize’ if not explicitly specified.
-ftree-loop-vectorize
Perform loop vectorization on trees. This flag is enabled by default at ‘-O2’
and by ‘-ftree-vectorize’, ‘-fprofile-use’, and ‘-fauto-profile’.
Chapter 3: GCC Command Options 187
-ftree-slp-vectorize
Perform basic block vectorization on trees. This flag is enabled by default at
‘-O2’ and by ‘-ftree-vectorize’, ‘-fprofile-use’, and ‘-fauto-profile’.
-ftrivial-auto-var-init=choice
Initialize automatic variables with either a pattern or with zeroes to increase
the security and predictability of a program by preventing uninitialized
memory disclosure and use. GCC still considers an automatic variable
that doesn’t have an explicit initializer as uninitialized, ‘-Wuninitialized’
and ‘-Wanalyzer-use-of-uninitialized-value’ will still report warning
messages on such automatic variables. With this option, GCC will also
initialize any padding of automatic variables that have structure or union types
to zeroes. However, the current implementation cannot initialize automatic
variables that are declared between the controlling expression and the first
case of a switch statement. Using ‘-Wtrivial-auto-var-init’ to report all
such cases.
The three values of choice are:
• ‘uninitialized’ doesn’t initialize any automatic variables. This is C and
C++’s default.
• ‘pattern’ Initialize automatic variables with values which will likely trans-
form logic bugs into crashes down the line, are easily recognized in a crash
dump and without being values that programmers can rely on for useful
program semantics. The current value is byte-repeatable pattern with byte
"0xFE". The values used for pattern initialization might be changed in the
future.
• ‘zero’ Initialize automatic variables with zeroes.
The default is ‘uninitialized’.
You can control this behavior for a specific variable by using the variable at-
tribute uninitialized (see Section 6.34 [Variable Attributes], page 622).
-fvect-cost-model=model
Alter the cost model used for vectorization. The model argument should be
one of ‘unlimited’, ‘dynamic’, ‘cheap’ or ‘very-cheap’. With the ‘unlimited’
model the vectorized code-path is assumed to be profitable while with the
‘dynamic’ model a runtime check guards the vectorized code-path to enable
it only for iteration counts that will likely execute faster than when executing
the original scalar loop. The ‘cheap’ model disables vectorization of loops where
doing so would be cost prohibitive for example due to required runtime checks
for data dependence or alignment but otherwise is equal to the ‘dynamic’ model.
The ‘very-cheap’ model only allows vectorization if the vector code would en-
tirely replace the scalar code that is being vectorized. For example, if each
iteration of a vectorized loop would only be able to handle exactly four itera-
tions of the scalar loop, the ‘very-cheap’ model would only allow vectorization
if the scalar iteration count is known to be a multiple of four.
The default cost model depends on other optimization flags and is either
‘dynamic’ or ‘cheap’.
188 Using the GNU Compiler Collection (GCC)
-fsimd-cost-model=model
Alter the cost model used for vectorization of loops marked with the
OpenMP simd directive. The model argument should be one of ‘unlimited’,
‘dynamic’, ‘cheap’. All values of model have the same meaning as
described in ‘-fvect-cost-model’ and by default a cost model defined with
‘-fvect-cost-model’ is used.
-ftree-vrp
Perform Value Range Propagation on trees. This is similar to the constant prop-
agation pass, but instead of values, ranges of values are propagated. This allows
the optimizers to remove unnecessary range checks like array bound checks and
null pointer checks. This is enabled by default at ‘-O2’ and higher. Null pointer
check elimination is only done if ‘-fdelete-null-pointer-checks’ is enabled.
-fsplit-paths
Split paths leading to loop backedges. This can improve dead code elimination
and common subexpression elimination. This is enabled by default at ‘-O3’ and
above.
-fsplit-ivs-in-unroller
Enables expression of values of induction variables in later iterations of the
unrolled loop using the value in the first iteration. This breaks long dependency
chains, thus improving efficiency of the scheduling passes.
A combination of ‘-fweb’ and CSE is often sufficient to obtain the same effect.
However, that is not reliable in cases where the loop body is more complicated
than a single basic block. It also does not work at all on some architectures
due to restrictions in the CSE pass.
This optimization is enabled by default.
-fvariable-expansion-in-unroller
With this option, the compiler creates multiple copies of some local variables
when unrolling a loop, which can result in superior code.
This optimization is enabled by default for PowerPC targets, but disabled by
default otherwise.
-fpartial-inlining
Inline parts of functions. This option has any effect only when inlining itself
is turned on by the ‘-finline-functions’ or ‘-finline-small-functions’
options.
Enabled at levels ‘-O2’, ‘-O3’, ‘-Os’.
-fpredictive-commoning
Perform predictive commoning optimization, i.e., reusing computations (espe-
cially memory loads and stores) performed in previous iterations of loops.
This option is enabled at level ‘-O3’. It is also enabled by ‘-fprofile-use’ and
‘-fauto-profile’.
-fprefetch-loop-arrays
If supported by the target machine, generate instructions to prefetch memory
to improve the performance of loops that access large arrays.
Chapter 3: GCC Command Options 189
This option may generate better or worse code; results are highly dependent on
the structure of loops within the source code.
Disabled at level ‘-Os’.
-fno-printf-return-value
Do not substitute constants for known return value of formatted output func-
tions such as sprintf, snprintf, vsprintf, and vsnprintf (but not printf
of fprintf). This transformation allows GCC to optimize or even eliminate
branches based on the known return value of these functions called with ar-
guments that are either constant, or whose values are known to be in a range
that makes determining the exact return value possible. For example, when
‘-fprintf-return-value’ is in effect, both the branch and the body of the if
statement (but not the call to snprint) can be optimized away when i is a
32-bit or smaller integer because the return value is guaranteed to be at most
8.
char buf[9];
if (snprintf (buf, "%08x", i) >= sizeof buf)
...
The ‘-fprintf-return-value’ option relies on other optimizations and
yields best results with ‘-O2’ and above. It works in tandem with
the ‘-Wformat-overflow’ and ‘-Wformat-truncation’ options. The
‘-fprintf-return-value’ option is enabled by default.
-fno-peephole
-fno-peephole2
Disable any machine-specific peephole optimizations. The difference between
‘-fno-peephole’ and ‘-fno-peephole2’ is in how they are implemented in the
compiler; some targets use one, some use the other, a few use both.
‘-fpeephole’ is enabled by default. ‘-fpeephole2’ enabled at levels ‘-O2’,
‘-O3’, ‘-Os’.
-fno-guess-branch-probability
Do not guess branch probabilities using heuristics.
GCC uses heuristics to guess branch probabilities if they are not provided
by profiling feedback (‘-fprofile-arcs’). These heuristics are based on the
control flow graph. If some branch probabilities are specified by __builtin_
expect, then the heuristics are used to guess branch probabilities for the rest
of the control flow graph, taking the __builtin_expect info into account. The
interactions between the heuristics and __builtin_expect can be complex,
and in some cases, it may be useful to disable the heuristics so that the effects
of __builtin_expect are easier to understand.
It is also possible to specify expected probability of the expression with __
builtin_expect_with_probability built-in function.
The default is ‘-fguess-branch-probability’ at levels ‘-O’, ‘-O2’, ‘-O3’, ‘-Os’.
-freorder-blocks
Reorder basic blocks in the compiled function in order to reduce number of
taken branches and improve code locality.
190 Using the GNU Compiler Collection (GCC)
int f() {
union a_union t;
Chapter 3: GCC Command Options 191
t.d = 3.0;
return t.i;
}
The practice of reading from a different union member than the one
most recently written to (called “type-punning”) is common. Even with
‘-fstrict-aliasing’, type-punning is allowed, provided the memory is
accessed through the union type. So, the code above works as expected. See
Section 4.9 [Structures unions enumerations and bit-fields implementation],
page 521. However, this code might not:
int f() {
union a_union t;
int* ip;
t.d = 3.0;
ip = &t.i;
return *ip;
}
Similarly, access by taking the address, casting the resulting pointer and deref-
erencing the result has undefined behavior, even if the cast uses a union type,
e.g.:
int f() {
double d = 3.0;
return ((union a_union *) &d)->i;
}
The ‘-fstrict-aliasing’ option is enabled at levels ‘-O2’, ‘-O3’, ‘-Os’.
-fipa-strict-aliasing
Controls whether rules of ‘-fstrict-aliasing’ are applied across function
boundaries. Note that if multiple functions gets inlined into a single func-
tion the memory accesses are no longer considered to be crossing a function
boundary.
The ‘-fipa-strict-aliasing’ option is enabled by default and is effective only
in combination with ‘-fstrict-aliasing’.
-falign-functions
-falign-functions=n
-falign-functions=n:m
-falign-functions=n:m:n2
-falign-functions=n:m:n2:m2
Align the start of functions to the next power-of-two greater than or equal to
n, skipping up to m-1 bytes. This ensures that at least the first m bytes of
the function can be fetched by the CPU without crossing an n-byte alignment
boundary.
If m is not specified, it defaults to n.
Examples: ‘-falign-functions=32’ aligns functions to the next 32-byte
boundary, ‘-falign-functions=24’ aligns to the next 32-byte boundary only
if this can be done by skipping 23 bytes or less, ‘-falign-functions=32:7’
aligns to the next 32-byte boundary only if this can be done by skipping 6
bytes or less.
192 Using the GNU Compiler Collection (GCC)
The second pair of n2:m2 values allows you to specify a secondary alignment:
‘-falign-functions=64:7:32:3’ aligns to the next 64-byte boundary if this
can be done by skipping 6 bytes or less, otherwise aligns to the next 32-byte
boundary if this can be done by skipping 2 bytes or less. If m2 is not specified,
it defaults to n2.
Some assemblers only support this flag when n is a power of two; in that case,
it is rounded up.
‘-fno-align-functions’ and ‘-falign-functions=1’ are equivalent and mean
that functions are not aligned.
If n is not specified or is zero, use a machine-dependent default. The maximum
allowed n option value is 65536.
Enabled at levels ‘-O2’, ‘-O3’.
-flimit-function-alignment
If this option is enabled, the compiler tries to avoid unnecessarily overaligning
functions. It attempts to instruct the assembler to align by the amount speci-
fied by ‘-falign-functions’, but not to skip more bytes than the size of the
function.
-falign-labels
-falign-labels=n
-falign-labels=n:m
-falign-labels=n:m:n2
-falign-labels=n:m:n2:m2
Align all branch targets to a power-of-two boundary.
Parameters of this option are analogous to the ‘-falign-functions’ option.
‘-fno-align-labels’ and ‘-falign-labels=1’ are equivalent and mean that
labels are not aligned.
If ‘-falign-loops’ or ‘-falign-jumps’ are applicable and are greater than this
value, then their values are used instead.
If n is not specified or is zero, use a machine-dependent default which is very
likely to be ‘1’, meaning no alignment. The maximum allowed n option value
is 65536.
Enabled at levels ‘-O2’, ‘-O3’.
-falign-loops
-falign-loops=n
-falign-loops=n:m
-falign-loops=n:m:n2
-falign-loops=n:m:n2:m2
Align loops to a power-of-two boundary. If the loops are executed many times,
this makes up for any execution of the dummy padding instructions.
If ‘-falign-labels’ is greater than this value, then its value is used instead.
Parameters of this option are analogous to the ‘-falign-functions’ option.
‘-fno-align-loops’ and ‘-falign-loops=1’ are equivalent and mean that
loops are not aligned. The maximum allowed n option value is 65536.
Chapter 3: GCC Command Options 193
-funreachable-traps
With this option, the compiler turns calls to __builtin_unreachable into
traps, instead of using them for optimization. This also affects any such calls
implicitly generated by the compiler.
This option has the same effect as ‘-fsanitize=unreachable
-fsanitize-trap=unreachable’, but does not affect the values of
those options. If ‘-fsanitize=unreachable’ is enabled, that option takes
priority over this one.
This option is enabled by default at ‘-O0’ and ‘-Og’.
-fweb Constructs webs as commonly used for register allocation purposes and assign
each web individual pseudo register. This allows the register allocation pass
to operate on pseudos directly, but also strengthens several other optimization
passes, such as CSE, loop optimizer and trivial dead code remover. It can,
however, make debugging impossible, since variables no longer stay in a “home
register”.
Enabled by default with ‘-funroll-loops’.
-fwhole-program
Assume that the current compilation unit represents the whole program being
compiled. All public functions and variables with the exception of main and
those merged by attribute externally_visible become static functions and
in effect are optimized more aggressively by interprocedural optimizers.
This option should not be used in combination with ‘-flto’. Instead relying
on a linker plugin should provide safer and more precise information.
-flto[=n]
This option runs the standard link-time optimizer. When invoked with source
code, it generates GIMPLE (one of GCC’s internal representations) and writes
it to special ELF sections in the object file. When the object files are linked
together, all the function bodies are read from these ELF sections and instan-
tiated as if they had been part of the same translation unit.
To use the link-time optimizer, ‘-flto’ and optimization options should be
specified at compile time and during the final link. It is recommended that you
compile all the files participating in the same link with the same options and
also specify those options at link time. For example:
gcc -c -O2 -flto foo.c
gcc -c -O2 -flto bar.c
gcc -o myprog -flto -O2 foo.o bar.o
The first two invocations to GCC save a bytecode representation of GIMPLE
into special ELF sections inside ‘foo.o’ and ‘bar.o’. The final invocation reads
the GIMPLE bytecode from ‘foo.o’ and ‘bar.o’, merges the two files into a
single internal image, and compiles the result as usual. Since both ‘foo.o’
and ‘bar.o’ are merged into a single image, this causes all the interprocedural
analyses and optimizations in GCC to work across the two files as if they were a
single one. This means, for example, that the inliner is able to inline functions
in ‘bar.o’ into functions in ‘foo.o’ and vice-versa.
Another (simpler) way to enable link-time optimization is:
Chapter 3: GCC Command Options 195
The following options ‘-fPIC’, ‘-fpic’, ‘-fpie’ and ‘-fPIE’ are combined based
on the following scheme:
‘-fPIC’ + ‘-fpic’ = ‘-fpic’
‘-fPIC’ + ‘-fno-pic’ = ‘-fno-pic’
‘-fpic/-fPIC’ + (no option) = (no option)
‘-fPIC’ + ‘-fPIE’ = ‘-fPIE’
‘-fpic’ + ‘-fPIE’ = ‘-fpie’
‘-fPIC/-fpic’ + ‘-fpie’ = ‘-fpie’
Certain ABI-changing flags are required to match in all compilation units, and
trying to override this at link time with a conflicting value is ignored. This
includes options such as ‘-freg-struct-return’ and ‘-fpcc-struct-return’.
Other options such as ‘-ffp-contract’, ‘-fno-strict-overflow’, ‘-fwrapv’,
‘-fno-trapv’ or ‘-fno-strict-aliasing’ are passed through to the
link stage and merged conservatively for conflicting translation units.
Specifically ‘-fno-strict-overflow’, ‘-fwrapv’ and ‘-fno-trapv’ take
precedence; and for example ‘-ffp-contract=off’ takes precedence over
‘-ffp-contract=fast’. You can override them at link time.
Diagnostic options such as ‘-Wstringop-overflow’ are passed through to the
link stage and their setting matches that of the compile-step at function granu-
larity. Note that this matters only for diagnostics emitted during optimization.
Note that code transforms such as inlining can lead to warnings being enabled
or disabled for regions if code not consistent with the setting at compile time.
When you need to pass options to the assembler via ‘-Wa’ or ‘-Xassembler’
make sure to either compile such translation units with ‘-fno-lto’ or con-
sistently use the same assembler options on all translation units. You can
alternatively also specify assembler options at LTO link time.
To enable debug info generation you need to supply ‘-g’ at compile time. If
any of the input files at link time were built with debug info generation enabled
the link will enable debug info generation as well. Any elaborate debug info
settings like the dwarf level ‘-gdwarf-5’ need to be explicitly repeated at the
linker command line and mixing different settings in different translation units
is discouraged.
If LTO encounters objects with C linkage declared with incompatible types in
separate translation units to be linked together (undefined behavior according
to ISO C99 6.2.7), a non-fatal diagnostic may be issued. The behavior is still
undefined at run time. Similar diagnostics may be raised for other languages.
Another feature of LTO is that it is possible to apply interprocedural optimiza-
tions on files written in different languages:
gcc -c -flto foo.c
g++ -c -flto bar.cc
gfortran -c -flto baz.f90
g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
Notice that the final link is done with g++ to get the C++ runtime libraries and
‘-lgfortran’ is added to get the Fortran runtime libraries. In general, when
mixing languages in LTO mode, you should use the same link command options
as when mixing languages in a regular (non-LTO) compilation.
Chapter 3: GCC Command Options 197
If object files containing GIMPLE bytecode are stored in a library archive, say
‘libfoo.a’, it is possible to extract and use them in an LTO link if you are
using a linker with plugin support. To create static libraries suitable for LTO,
use gcc-ar and gcc-ranlib instead of ar and ranlib; to show the symbols
of object files with GIMPLE bytecode, use gcc-nm. Those commands require
that ar, ranlib and nm have been compiled with plugin support. At link time,
use the flag ‘-fuse-linker-plugin’ to ensure that the library participates in
the LTO optimization process:
gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
With the linker plugin enabled, the linker extracts the needed GIMPLE files
from ‘libfoo.a’ and passes them on to the running GCC to make them part
of the aggregated GIMPLE image to be optimized.
If you are not using a linker with plugin support and/or do not enable the linker
plugin, then the objects inside ‘libfoo.a’ are extracted and linked as usual,
but they do not participate in the LTO optimization process. In order to make
a static library suitable for both LTO optimization and usual linkage, compile
its object files with ‘-flto’ ‘-ffat-lto-objects’.
Link-time optimizations do not require the presence of the whole program to
operate. If the program does not require any symbols to be exported, it is pos-
sible to combine ‘-flto’ and ‘-fwhole-program’ to allow the interprocedural
optimizers to use more aggressive assumptions which may lead to improved op-
timization opportunities. Use of ‘-fwhole-program’ is not needed when linker
plugin is active (see ‘-fuse-linker-plugin’).
The current implementation of LTO makes no attempt to generate bytecode
that is portable between different types of hosts. The bytecode files are ver-
sioned and there is a strict version check, so bytecode files generated in one
version of GCC do not work with an older or newer version of GCC.
Link-time optimization does not work well with generation of debugging infor-
mation on systems other than those using a combination of ELF and DWARF.
If you specify the optional n, the optimization and code generation done at link
time is executed in parallel using n parallel jobs by utilizing an installed make
program. The environment variable MAKE may be used to override the program
used.
You can also specify ‘-flto=jobserver’ to use GNU make’s job server mode to
determine the number of parallel jobs. This is useful when the Makefile calling
GCC is already executing in parallel. You must prepend a ‘+’ to the command
recipe in the parent Makefile for this to work. This option likely only works if
MAKE is GNU make. Even without the option value, GCC tries to automatically
detect a running GNU make’s job server.
Use ‘-flto=auto’ to use GNU make’s job server, if available, or otherwise fall
back to autodetection of the number of CPU threads present in your system.
-flto-partition=alg
Specify the partitioning algorithm used by the link-time optimizer. The value
is either ‘1to1’ to specify a partitioning mirroring the original source files or
198 Using the GNU Compiler Collection (GCC)
-ffloat-store
Do not store floating-point variables in registers, and inhibit other options that
might change whether a floating-point value is taken from a register or memory.
This option prevents undesirable excess precision on machines such as the 68000
where the floating registers (of the 68881) keep more precision than a double
is supposed to have. Similarly for the x86 architecture. For most programs,
the excess precision does only good, but a few programs rely on the precise
definition of IEEE floating point. Use ‘-ffloat-store’ for such programs, after
modifying them to store all pertinent intermediate computations into variables.
Chapter 3: GCC Command Options 201
-fexcess-precision=style
This option allows further control over excess precision on machines where
floating-point operations occur in a format with more precision or range
than the IEEE standard and interchange floating-point types. By default,
‘-fexcess-precision=fast’ is in effect; this means that operations may
be carried out in a wider precision than the types specified in the source
if that would result in faster code, and it is unpredictable when rounding
to the types specified in the source code takes place. When compiling C, if
‘-fexcess-precision=standard’ is specified then excess precision follows
the rules specified in ISO C99; in particular, both casts and assignments
cause values to be rounded to their semantic types (whereas ‘-ffloat-store’
only affects assignments). This option is enabled by default for C if a strict
conformance option such as ‘-std=c99’ is used. ‘-ffast-math’ enables
‘-fexcess-precision=fast’ by default regardless of whether a strict
conformance option is used.
‘-fexcess-precision=standard’ is not implemented for languages other than
C. On the x86, it has no effect if ‘-mfpmath=sse’ or ‘-mfpmath=sse+387’ is
specified; in the former case, IEEE semantics apply without excess precision,
and in the latter, rounding is unpredictable.
-ffast-math
Sets the options ‘-fno-math-errno’, ‘-funsafe-math-optimizations’,
‘-ffinite-math-only’, ‘-fno-rounding-math’, ‘-fno-signaling-nans’,
‘-fcx-limited-range’ and ‘-fexcess-precision=fast’.
This option causes the preprocessor macro __FAST_MATH__ to be defined.
This option is not turned on by any ‘-O’ option besides ‘-Ofast’ since it can
result in incorrect output for programs that depend on an exact implementation
of IEEE or ISO rules/specifications for math functions. It may, however, yield
faster code for programs that do not require the guarantees of these specifica-
tions.
-fno-math-errno
Do not set errno after calling math functions that are executed with a single
instruction, e.g., sqrt. A program that relies on IEEE exceptions for math
error handling may want to use this flag for speed while maintaining IEEE
arithmetic compatibility.
This option is not turned on by any ‘-O’ option since it can result in incorrect
output for programs that depend on an exact implementation of IEEE or ISO
rules/specifications for math functions. It may, however, yield faster code for
programs that do not require the guarantees of these specifications.
The default is ‘-fmath-errno’.
On Darwin systems, the math library never sets errno. There is therefore
no reason for the compiler to consider the possibility that it might, and
‘-fno-math-errno’ is the default.
-funsafe-math-optimizations
Allow optimizations for floating-point arithmetic that (a) assume that argu-
ments and results are valid and (b) may violate IEEE or ANSI standards.
202 Using the GNU Compiler Collection (GCC)
When used at link time, it may include libraries or startup files that change the
default FPU control word or other similar optimizations.
This option is not turned on by any ‘-O’ option since it can result in incor-
rect output for programs that depend on an exact implementation of IEEE
or ISO rules/specifications for math functions. It may, however, yield faster
code for programs that do not require the guarantees of these specifications.
Enables ‘-fno-signed-zeros’, ‘-fno-trapping-math’, ‘-fassociative-math’
and ‘-freciprocal-math’.
The default is ‘-fno-unsafe-math-optimizations’.
-fassociative-math
Allow re-association of operands in series of floating-point operations. This vi-
olates the ISO C and C++ language standard by possibly changing computation
result. NOTE: re-ordering may change the sign of zero as well as ignore NaNs
and inhibit or create underflow or overflow (and thus cannot be used on code
that relies on rounding behavior like (x + 2**52) - 2**52. May also reorder
floating-point comparisons and thus may not be used when ordered compar-
isons are required. This option requires that both ‘-fno-signed-zeros’ and
‘-fno-trapping-math’ be in effect. Moreover, it doesn’t make much sense with
‘-frounding-math’. For Fortran the option is automatically enabled when both
‘-fno-signed-zeros’ and ‘-fno-trapping-math’ are in effect.
The default is ‘-fno-associative-math’.
-freciprocal-math
Allow the reciprocal of a value to be used instead of dividing by the value if
this enables optimizations. For example x / y can be replaced with x * (1/y),
which is useful if (1/y) is subject to common subexpression elimination. Note
that this loses precision and increases the number of flops operating on the
value.
The default is ‘-fno-reciprocal-math’.
-ffinite-math-only
Allow optimizations for floating-point arithmetic that assume that arguments
and results are not NaNs or +-Infs.
This option is not turned on by any ‘-O’ option since it can result in incorrect
output for programs that depend on an exact implementation of IEEE or ISO
rules/specifications for math functions. It may, however, yield faster code for
programs that do not require the guarantees of these specifications.
The default is ‘-fno-finite-math-only’.
-fno-signed-zeros
Allow optimizations for floating-point arithmetic that ignore the signedness of
zero. IEEE arithmetic specifies the behavior of distinct +0.0 and −0.0 values,
which then prohibits simplification of expressions such as x+0.0 or 0.0*x (even
with ‘-ffinite-math-only’). This option implies that the sign of a zero result
isn’t significant.
The default is ‘-fsigned-zeros’.
Chapter 3: GCC Command Options 203
-fno-trapping-math
Compile code assuming that floating-point operations cannot generate user-
visible traps. These traps include division by zero, overflow, underflow, inexact
result and invalid operation. This option requires that ‘-fno-signaling-nans’
be in effect. Setting this option may allow faster code if one relies on “non-stop”
IEEE arithmetic, for example.
This option should never be turned on by any ‘-O’ option since it can result
in incorrect output for programs that depend on an exact implementation of
IEEE or ISO rules/specifications for math functions.
The default is ‘-ftrapping-math’.
-frounding-math
Disable transformations and optimizations that assume default floating-point
rounding behavior. This is round-to-zero for all floating point to integer con-
versions, and round-to-nearest for all other arithmetic truncations. This option
should be specified for programs that change the FP rounding mode dynami-
cally, or that may be executed with a non-default rounding mode. This option
disables constant folding of floating-point expressions at compile time (which
may be affected by rounding mode) and arithmetic transformations that are
unsafe in the presence of sign-dependent rounding modes.
The default is ‘-fno-rounding-math’.
This option is experimental and does not currently guarantee to disable all GCC
optimizations that are affected by rounding mode. Future versions of GCC may
provide finer control of this setting using C99’s FENV_ACCESS pragma. This
command-line option will be used to specify the default state for FENV_ACCESS.
-fsignaling-nans
Compile code assuming that IEEE signaling NaNs may generate user-visible
traps during floating-point operations. Setting this option disables optimiza-
tions that may change the number of exceptions visible with signaling NaNs.
This option implies ‘-ftrapping-math’.
This option causes the preprocessor macro __SUPPORT_SNAN__ to be defined.
The default is ‘-fno-signaling-nans’.
This option is experimental and does not currently guarantee to disable all
GCC optimizations that affect signaling NaN behavior.
-fno-fp-int-builtin-inexact
Do not allow the built-in functions ceil, floor, round and trunc, and their
float and long double variants, to generate code that raises the “inexact”
floating-point exception for noninteger arguments. ISO C99 and C11 allow
these functions to raise the “inexact” exception, but ISO/IEC TS 18661-1:2014,
the C bindings to IEEE 754-2008, as integrated into ISO C2X, does not allow
these functions to do so.
The default is ‘-ffp-int-builtin-inexact’, allowing the exception to be
raised, unless C2X or a later C standard is selected. This option does nothing
unless ‘-ftrapping-math’ is in effect.
204 Using the GNU Compiler Collection (GCC)
The names of specific parameters, and the meaning of the values, are tied to
the internals of the compiler, and are subject to change without notice in future
releases.
In order to get minimal, maximal and default value of a parameter, one can use
‘--help=param -Q’ options.
In each case, the value is an integer. The following choices of name are recog-
nized for all targets:
predictable-branch-outcome
When branch is predicted to be taken with probability lower than
this threshold (in percent), then it is considered well predictable.
max-rtl-if-conversion-insns
RTL if-conversion tries to remove conditional branches around a
block and replace them with conditionally executed instructions.
This parameter gives the maximum number of instructions in a
block which should be considered for if-conversion. The compiler
will also use other heuristics to decide whether if-conversion is likely
to be profitable.
max-rtl-if-conversion-predictable-cost
RTL if-conversion will try to remove conditional branches around
a block and replace them with conditionally executed instructions.
These parameters give the maximum permissible cost for the
sequence that would be generated by if-conversion depending on
whether the branch is statically determined to be predictable or
not. The units for this parameter are the same as those for the
GCC internal seq cost metric. The compiler will try to provide a
reasonable default for this parameter using the BRANCH COST
target macro.
max-crossjump-edges
The maximum number of incoming edges to consider for cross-
jumping. The algorithm used by ‘-fcrossjumping’ is O(N 2 ) in
the number of edges incoming to each block. Increasing values
mean more aggressive optimization, making the compilation time
increase with probably small improvement in executable size.
min-crossjump-insns
The minimum number of instructions that must be matched at the
end of two blocks before cross-jumping is performed on them. This
value is ignored in the case where all instructions in the block being
cross-jumped from are matched.
max-grow-copy-bb-insns
The maximum code size expansion factor when copying basic blocks
instead of jumping. The expansion is relative to a jump instruction.
max-goto-duplication-insns
The maximum number of instructions to duplicate to a block that
jumps to a computed goto. To avoid O(N 2 ) behavior in a number
Chapter 3: GCC Command Options 209
max-inline-insns-single
Several parameters control the tree inliner used in GCC. This num-
ber sets the maximum number of instructions (counted in GCC’s
internal representation) in a single function that the tree inliner
considers for inlining. This only affects functions declared inline
and methods implemented in a class declaration (C++).
max-inline-insns-auto
When you use ‘-finline-functions’ (included in ‘-O3’), a lot of
functions that would otherwise not be considered for inlining by the
compiler are investigated. To those functions, a different (more re-
strictive) limit compared to functions declared inline can be applied
(‘--param max-inline-insns-auto’).
max-inline-insns-small
This is bound applied to calls which are considered relevant with
‘-finline-small-functions’.
max-inline-insns-size
This is bound applied to calls which are optimized for size. Small
growth may be desirable to anticipate optimization oppurtunities
exposed by inlining.
uninlined-function-insns
Number of instructions accounted by inliner for function overhead
such as function prologue and epilogue.
uninlined-function-time
Extra time accounted by inliner for function overhead such as time
needed to execute function prologue and epilogue.
inline-heuristics-hint-percent
The scale (in percents) applied to ‘inline-insns-single’,
‘inline-insns-single-O2’, ‘inline-insns-auto’ when inline
heuristics hints that inlining is very profitable (will enable later
optimizations).
uninlined-thunk-insns
uninlined-thunk-time
Same as ‘--param uninlined-function-insns’ and ‘--param
uninlined-function-time’ but applied to function thunks.
inline-min-speedup
When estimated performance improvement of caller + callee run-
time exceeds this threshold (in percent), the function can be inlined
regardless of the limit on ‘--param max-inline-insns-single’
and ‘--param max-inline-insns-auto’.
large-function-insns
The limit specifying really large functions. For functions larger
than this limit after inlining, inlining is constrained by ‘--param
large-function-growth’. This parameter is useful primarily to
Chapter 3: GCC Command Options 211
large-function-growth
Specifies maximal growth of large function caused by inlining in
percents. For example, parameter value 100 limits large function
growth to 2.0 times the original size.
large-unit-insns
The limit specifying large translation unit. Growth caused by
inlining of units larger than this limit is limited by ‘--param
inline-unit-growth’. For small units this might be too tight.
For example, consider a unit consisting of function A that is
inline and B that just calls A three times. If B is small relative
to A, the growth of unit is 300\% and yet such inlining is
very sane. For very large units consisting of small inlineable
functions, however, the overall unit growth limit is needed to avoid
exponential explosion of code size. Thus for smaller units, the
size is increased to ‘--param large-unit-insns’ before applying
‘--param inline-unit-growth’.
lazy-modules
Maximum number of concurrently open C++ module files when lazy
loading.
inline-unit-growth
Specifies maximal overall growth of the compilation unit caused by
inlining. For example, parameter value 20 limits unit growth to 1.2
times the original size. Cold functions (either marked cold via an
attribute or by profile feedback) are not accounted into the unit
size.
ipa-cp-unit-growth
Specifies maximal overall growth of the compilation unit caused
by interprocedural constant propagation. For example, parameter
value 10 limits unit growth to 1.1 times the original size.
ipa-cp-large-unit-insns
The size of translation unit that IPA-CP pass considers large.
large-stack-frame
The limit specifying large stack frames. While inlining the algo-
rithm is trying to not grow past this limit too much.
large-stack-frame-growth
Specifies maximal growth of large stack frames caused by inlining
in percents. For example, parameter value 1000 limits large stack
frame growth to 11 times the original size.
212 Using the GNU Compiler Collection (GCC)
max-inline-insns-recursive
max-inline-insns-recursive-auto
Specifies the maximum number of instructions an out-of-line copy of
a self-recursive inline function can grow into by performing recursive
inlining.
‘--param max-inline-insns-recursive’ applies to functions de-
clared inline. For functions not declared inline, recursive inlin-
ing happens only when ‘-finline-functions’ (included in ‘-O3’)
is enabled; ‘--param max-inline-insns-recursive-auto’ applies
instead.
max-inline-recursive-depth
max-inline-recursive-depth-auto
Specifies the maximum recursion depth used for recursive inlining.
‘--param max-inline-recursive-depth’ applies to functions de-
clared inline. For functions not declared inline, recursive inlin-
ing happens only when ‘-finline-functions’ (included in ‘-O3’)
is enabled; ‘--param max-inline-recursive-depth-auto’ applies
instead.
min-inline-recursive-probability
Recursive inlining is profitable only for function having deep re-
cursion in average and can hurt for function having little recursion
depth by increasing the prologue size or complexity of function
body to other optimizers.
When profile feedback is available (see ‘-fprofile-generate’) the
actual recursion depth can be guessed from the probability that
function recurses via a given call expression. This parameter limits
inlining only to call expressions whose probability exceeds the given
threshold (in percents).
early-inlining-insns
Specify growth that the early inliner can make. In effect it increases
the amount of inlining for code having a large abstraction penalty.
max-early-inliner-iterations
Limit of iterations of the early inliner. This basically bounds the
number of nested indirect calls the early inliner can resolve. Deeper
chains are still handled by late inlining.
comdat-sharing-probability
Probability (in percent) that C++ inline function with comdat vis-
ibility are shared across multiple compilation units.
modref-max-bases
modref-max-refs
modref-max-accesses
Specifies the maximal number of base pointers, references and ac-
cesses stored for a single function by mod/ref analysis.
Chapter 3: GCC Command Options 213
modref-max-tests
Specifies the maxmal number of tests alias oracle can perform to dis-
ambiguate memory locations using the mod/ref information. This
parameter ought to be bigger than ‘--param modref-max-bases’
and ‘--param modref-max-refs’.
modref-max-depth
Specifies the maximum depth of DFS walk used by modref escape
analysis. Setting to 0 disables the analysis completely.
modref-max-escape-points
Specifies the maximum number of escape points tracked by modref
per SSA-name.
modref-max-adjustments
Specifies the maximum number the access range is enlarged during
modref dataflow analysis.
profile-func-internal-id
A parameter to control whether to use function internal id in profile
database lookup. If the value is 0, the compiler uses an id that
is based on function assembler name and filename, which makes
old profile data more tolerant to source changes such as function
reordering etc.
min-vect-loop-bound
The minimum number of iterations under which loops are not vec-
torized when ‘-ftree-vectorize’ is used. The number of itera-
tions after vectorization needs to be greater than the value specified
by this option to allow vectorization.
gcse-cost-distance-ratio
Scaling factor in calculation of maximum distance an expression can
be moved by GCSE optimizations. This is currently supported only
in the code hoisting pass. The bigger the ratio, the more aggres-
sive code hoisting is with simple expressions, i.e., the expressions
that have cost less than ‘gcse-unrestricted-cost’. Specifying 0
disables hoisting of simple expressions.
gcse-unrestricted-cost
Cost, roughly measured as the cost of a single typical machine
instruction, at which GCSE optimizations do not constrain the dis-
tance an expression can travel. This is currently supported only
in the code hoisting pass. The lesser the cost, the more aggres-
sive code hoisting is. Specifying 0 allows all expressions to travel
unrestricted distances.
max-hoist-depth
The depth of search in the dominator tree for expressions to hoist.
This is used to avoid quadratic behavior in hoisting algorithm. The
value of 0 does not limit on the search, but may slow down compi-
lation of huge functions.
214 Using the GNU Compiler Collection (GCC)
max-tail-merge-comparisons
The maximum amount of similar bbs to compare a bb with. This
is used to avoid quadratic behavior in tree tail merging.
max-tail-merge-iterations
The maximum amount of iterations of the pass over the function.
This is used to limit compilation time in tree tail merging.
store-merging-allow-unaligned
Allow the store merging pass to introduce unaligned stores if it is
legal to do so.
max-stores-to-merge
The maximum number of stores to attempt to merge into wider
stores in the store merging pass.
max-store-chains-to-track
The maximum number of store chains to track at the same time in
the attempt to merge them into wider stores in the store merging
pass.
max-stores-to-track
The maximum number of stores to track at the same time in the
attemt to to merge them into wider stores in the store merging
pass.
max-unrolled-insns
The maximum number of instructions that a loop may have to be
unrolled. If a loop is unrolled, this parameter also determines how
many times the loop code is unrolled.
max-average-unrolled-insns
The maximum number of instructions biased by probabilities of
their execution that a loop may have to be unrolled. If a loop is
unrolled, this parameter also determines how many times the loop
code is unrolled.
max-unroll-times
The maximum number of unrollings of a single loop.
max-peeled-insns
The maximum number of instructions that a loop may have to be
peeled. If a loop is peeled, this parameter also determines how
many times the loop code is peeled.
max-peel-times
The maximum number of peelings of a single loop.
max-peel-branches
The maximum number of branches on the hot path through the
peeled sequence.
max-completely-peeled-insns
The maximum number of insns of a completely peeled loop.
Chapter 3: GCC Command Options 215
max-completely-peel-times
The maximum number of iterations of a loop to be suitable for
complete peeling.
max-completely-peel-loop-nest-depth
The maximum depth of a loop nest suitable for complete peeling.
max-unswitch-insns
The maximum number of insns of an unswitched loop.
lim-expensive
The minimum cost of an expensive expression in the loop invariant
motion.
min-loop-cond-split-prob
When FDO profile information is available, ‘min-loop-cond-split-prob’
specifies minimum threshold for probability of semi-invariant
condition statement to trigger loop split.
iv-consider-all-candidates-bound
Bound on number of candidates for induction variables, below
which all candidates are considered for each use in induction
variable optimizations. If there are more candidates than this,
only the most relevant ones are considered to avoid quadratic time
complexity.
iv-max-considered-uses
The induction variable optimizations give up on loops that contain
more induction variable uses.
iv-always-prune-cand-set-bound
If the number of candidates in the set is smaller than this value,
always try to remove unnecessary ivs from the set when adding a
new one.
avg-loop-niter
Average number of iterations of a loop.
dse-max-object-size
Maximum size (in bytes) of objects tracked bytewise by dead store
elimination. Larger values may result in larger compilation times.
dse-max-alias-queries-per-store
Maximum number of queries into the alias oracle per store. Larger
values result in larger compilation times and may result in more
removed dead stores.
scev-max-expr-size
Bound on size of expressions used in the scalar evolutions analyzer.
Large expressions slow the analyzer.
scev-max-expr-complexity
Bound on the complexity of the expressions in the scalar evolutions
analyzer. Complex expressions slow the analyzer.
216 Using the GNU Compiler Collection (GCC)
max-tree-if-conversion-phi-args
Maximum number of arguments in a PHI supported by TREE if
conversion unless the loop is marked with simd pragma.
vect-max-version-for-alignment-checks
The maximum number of run-time checks that can be performed
when doing loop versioning for alignment in the vectorizer.
vect-max-version-for-alias-checks
The maximum number of run-time checks that can be performed
when doing loop versioning for alias in the vectorizer.
vect-max-peeling-for-alignment
The maximum number of loop peels to enhance access alignment
for vectorizer. Value -1 means no limit.
max-iterations-to-track
The maximum number of iterations of a loop the brute-force algo-
rithm for analysis of the number of iterations of the loop tries to
evaluate.
hot-bb-count-fraction
The denominator n of fraction 1/n of the maximal execution count
of a basic block in the entire program that a basic block needs to
at least have in order to be considered hot. The default is 10000,
which means that a basic block is considered hot if its execution
count is greater than 1/10000 of the maximal execution count. 0
means that it is never considered hot. Used in non-LTO mode.
hot-bb-count-ws-permille
The number of most executed permilles, ranging from 0 to 1000, of
the profiled execution of the entire program to which the execution
count of a basic block must be part of in order to be considered hot.
The default is 990, which means that a basic block is considered
hot if its execution count contributes to the upper 990 permilles,
or 99.0%, of the profiled execution of the entire program. 0 means
that it is never considered hot. Used in LTO mode.
hot-bb-frequency-fraction
The denominator n of fraction 1/n of the execution frequency of the
entry block of a function that a basic block of this function needs
to at least have in order to be considered hot. The default is 1000,
which means that a basic block is considered hot in a function if
it is executed more frequently than 1/1000 of the frequency of the
entry block of the function. 0 means that it is never considered hot.
unlikely-bb-count-fraction
The denominator n of fraction 1/n of the number of profiled runs
of the entire program below which the execution count of a basic
block must be in order for the basic block to be considered unlikely
executed. The default is 20, which means that a basic block is
Chapter 3: GCC Command Options 217
max-reload-search-insns
The maximum number of instruction reload should look backward
for equivalent register. Increasing values mean more aggressive op-
timization, making the compilation time increase with probably
slightly better performance.
max-cselib-memory-locations
The maximum number of memory locations cselib should take into
account. Increasing values mean more aggressive optimization,
making the compilation time increase with probably slightly better
performance.
max-sched-ready-insns
The maximum number of instructions ready to be issued the sched-
uler should consider at any given time during the first scheduling
pass. Increasing values mean more thorough searches, making the
compilation time increase with probably little benefit.
max-sched-region-blocks
The maximum number of blocks in a region to be considered for
interblock scheduling.
max-pipeline-region-blocks
The maximum number of blocks in a region to be considered for
pipelining in the selective scheduler.
max-sched-region-insns
The maximum number of insns in a region to be considered for
interblock scheduling.
max-pipeline-region-insns
The maximum number of insns in a region to be considered for
pipelining in the selective scheduler.
min-spec-prob
The minimum probability (in percents) of reaching a source block
for interblock speculative scheduling.
max-sched-extend-regions-iters
The maximum number of iterations through CFG to extend regions.
A value of 0 disables region extensions.
220 Using the GNU Compiler Collection (GCC)
max-sched-insn-conflict-delay
The maximum conflict delay for an insn to be considered for spec-
ulative motion.
sched-spec-prob-cutoff
The minimal probability of speculation success (in percents), so
that speculative insns are scheduled.
sched-state-edge-prob-cutoff
The minimum probability an edge must have for the scheduler to
save its state across it.
sched-mem-true-dep-cost
Minimal distance (in CPU cycles) between store and load targeting
same memory locations.
selsched-max-lookahead
The maximum size of the lookahead window of selective scheduling.
It is a depth of search for available instructions.
selsched-max-sched-times
The maximum number of times that an instruction is scheduled
during selective scheduling. This is the limit on the number of
iterations through which the instruction may be pipelined.
selsched-insns-to-rename
The maximum number of best instructions in the ready list that
are considered for renaming in the selective scheduler.
sms-min-sc
The minimum value of stage count that swing modulo scheduler
generates.
max-last-value-rtl
The maximum size measured as number of RTLs that can be
recorded in an expression in combiner for a pseudo register as last
known value of that register.
max-combine-insns
The maximum number of instructions the RTL combiner tries to
combine.
integer-share-limit
Small integer constants can use a shared data structure, reducing
the compiler’s memory usage and increasing its speed. This sets
the maximum value of a shared integer constant.
ssp-buffer-size
The minimum size of buffers (i.e. arrays) that receive stack smash-
ing protection when ‘-fstack-protector’ is used.
min-size-for-stack-sharing
The minimum size of variables taking part in stack slot sharing
when not optimizing.
Chapter 3: GCC Command Options 221
max-jump-thread-duplication-stmts
Maximum number of statements allowed in a block that needs to
be duplicated when threading jumps.
max-fields-for-field-sensitive
Maximum number of fields in a structure treated in a field sensitive
manner during pointer analysis.
prefetch-latency
Estimate on average number of instructions that are executed be-
fore prefetch finishes. The distance prefetched ahead is propor-
tional to this constant. Increasing this number may also lead to
less streams being prefetched (see ‘simultaneous-prefetches’).
simultaneous-prefetches
Maximum number of prefetches that can run at the same time.
l1-cache-line-size
The size of cache line in L1 data cache, in bytes.
l1-cache-size
The size of L1 data cache, in kilobytes.
l2-cache-size
The size of L2 data cache, in kilobytes.
prefetch-dynamic-strides
Whether the loop array prefetch pass should issue software prefetch
hints for strides that are non-constant. In some cases this may be
beneficial, though the fact the stride is non-constant may make it
hard to predict when there is clear benefit to issuing these hints.
Set to 1 if the prefetch hints should be issued for non-
constant strides. Set to 0 if prefetch hints should be issued
only for strides that are known to be constant and below
‘prefetch-minimum-stride’.
prefetch-minimum-stride
Minimum constant stride, in bytes, to start using prefetch hints for.
If the stride is less than this threshold, prefetch hints will not be
issued.
This setting is useful for processors that have hardware prefetchers,
in which case there may be conflicts between the hardware prefetch-
ers and the software prefetchers. If the hardware prefetchers have a
maximum stride they can handle, it should be used here to improve
the use of software prefetchers.
A value of -1 means we don’t have a threshold and therefore prefetch
hints can be issued for any constant stride.
This setting is only useful for strides that are known and constant.
222 Using the GNU Compiler Collection (GCC)
destructive-interference-size
constructive-interference-size
The values for the C++17 variables std::hardware_destructive_
interference_size and std::hardware_constructive_
interference_size. The destructive interference size is
the minimum recommended offset between two independent
concurrently-accessed objects; the constructive interference size is
the maximum recommended size of contiguous memory accessed
together. Typically both will be the size of an L1 cache line for
the target, in bytes. For a generic target covering a range of L1
cache line sizes, typically the constructive interference size will be
the small end of the range and the destructive size will be the
large end.
The destructive interference size is intended to be used for layout,
and thus has ABI impact. The default value is not expected to
be stable, and on some targets varies with ‘-mtune’, so use of this
variable in a context where ABI stability is important, such as the
public interface of a library, is strongly discouraged; if it is used in
that context, users can stabilize the value using this option.
The constructive interference size is less sensitive, as it is typically
only used in a ‘static_assert’ to make sure that a type fits within
a cache line.
See also ‘-Winterference-size’.
loop-interchange-max-num-stmts
The maximum number of stmts in a loop to be interchanged.
loop-interchange-stride-ratio
The minimum ratio between stride of two loops for interchange to
be profitable.
min-insn-to-prefetch-ratio
The minimum ratio between the number of instructions and the
number of prefetches to enable prefetching in a loop.
prefetch-min-insn-to-mem-ratio
The minimum ratio between the number of instructions and the
number of memory references to enable prefetching in a loop.
use-canonical-types
Whether the compiler should use the “canonical” type system.
Should always be 1, which uses a more efficient internal mecha-
nism for comparing types in C++ and Objective-C++. However, if
bugs in the canonical type system are causing compilation failures,
set this value to 0 to disable canonical types.
switch-conversion-max-branch-ratio
Switch initialization conversion refuses to create arrays that are big-
ger than ‘switch-conversion-max-branch-ratio’ times the num-
ber of branches in the switch.
Chapter 3: GCC Command Options 223
max-partial-antic-length
Maximum length of the partial antic set computed during the tree
partial redundancy elimination optimization (‘-ftree-pre’) when
optimizing at ‘-O3’ and above. For some sorts of source code the en-
hanced partial redundancy elimination optimization can run away,
consuming all of the memory available on the host machine. This
parameter sets a limit on the length of the sets that are computed,
which prevents the runaway behavior. Setting a value of 0 for this
parameter allows an unlimited set length.
rpo-vn-max-loop-depth
Maximum loop depth that is value-numbered optimistically. When
the limit hits the innermost rpo-vn-max-loop-depth loops and the
outermost loop in the loop nest are value-numbered optimistically
and the remaining ones not.
sccvn-max-alias-queries-per-access
Maximum number of alias-oracle queries we perform when looking
for redundancies for loads and stores. If this limit is hit the search
is aborted and the load or store is not considered redundant. The
number of queries is algorithmically limited to the number of stores
on all paths from the load to the function entry.
ira-max-loops-num
IRA uses regional register allocation by default. If a function con-
tains more loops than the number given by this parameter, only at
most the given number of the most frequently-executed loops form
regions for regional register allocation.
ira-max-conflict-table-size
Although IRA uses a sophisticated algorithm to compress the con-
flict table, the table can still require excessive amounts of memory
for huge functions. If the conflict table for a function could be more
than the size in MB given by this parameter, the register alloca-
tor instead uses a faster, simpler, and lower-quality algorithm that
does not require building a pseudo-register conflict table.
ira-loop-reserved-regs
IRA can be used to evaluate more accurate register pressure in
loops for decisions to move loop invariants (see ‘-O3’). The number
of available registers reserved for some other purposes is given by
this parameter. Default of the parameter is the best found from
numerous experiments.
ira-consider-dup-in-all-alts
Make IRA to consider matching constraint (duplicated operand
number) heavily in all available alternatives for preferred register
class. If it is set as zero, it means IRA only respects the match-
ing constraint when it’s in the only available alternative with an
appropriate register class. Otherwise, it means IRA will check all
224 Using the GNU Compiler Collection (GCC)
lra-inheritance-ebb-probability-cutoff
LRA tries to reuse values reloaded in registers in subsequent in-
sns. This optimization is called inheritance. EBB is used as a
region to do this optimization. The parameter defines a minimal
fall-through edge probability in percentage used to add BB to inher-
itance EBB in LRA. The default value was chosen from numerous
runs of SPEC2000 on x86-64.
loop-invariant-max-bbs-in-loop
Loop invariant motion can be very expensive, both in compilation
time and in amount of needed compile-time memory, with very
large loops. Loops with more basic blocks than this parameter
won’t have loop invariant motion optimization performed on them.
loop-max-datarefs-for-datadeps
Building data dependencies is expensive for very large loops. This
parameter limits the number of data references in loops that are
considered for data dependence analysis. These large loops are no
handled by the optimizations using loop data dependencies.
max-vartrack-size
Sets a maximum number of hash table slots to use during variable
tracking dataflow analysis of any function. If this limit is exceeded
with variable tracking at assignments enabled, analysis for that
function is retried without it, after removing all debug insns from
the function. If the limit is exceeded even without debug insns, var
tracking analysis is completely disabled for the function. Setting
the parameter to zero makes it unlimited.
max-vartrack-expr-depth
Sets a maximum number of recursion levels when attempting to
map variable names or debug temporaries to value expressions.
This trades compilation time for more complete debug information.
If this is set too low, value expressions that are available and could
be represented in debug information may end up not being used;
setting this higher may enable the compiler to find more complex
debug expressions, but compile time and memory use may grow.
max-debug-marker-count
Sets a threshold on the number of debug markers (e.g. begin stmt
markers) to avoid complexity explosion at inlining or expanding to
RTL. If a function has more such gimple stmts than the set limit,
such stmts will be dropped from the inlined copy of a function, and
from its RTL expansion.
Chapter 3: GCC Command Options 225
min-nondebug-insn-uid
Use uids starting at this parameter for nondebug insns. The range
below the parameter is reserved exclusively for debug insns created
by ‘-fvar-tracking-assignments’, but debug insns may get (non-
overlapping) uids above it if the reserved range is exhausted.
ipa-sra-ptr-growth-factor
IPA-SRA replaces a pointer to an aggregate with one or more
new parameters only when their cumulative size is less or equal
to ‘ipa-sra-ptr-growth-factor’ times the size of the original
pointer parameter.
ipa-sra-max-replacements
Maximum pieces of an aggregate that IPA-SRA tracks. As a conse-
quence, it is also the maximum number of replacements of a formal
parameter.
sra-max-scalarization-size-Ospeed
sra-max-scalarization-size-Osize
The two Scalar Reduction of Aggregates passes (SRA and
IPA-SRA) aim to replace scalar parts of aggregates with
uses of independent scalar variables. These parameters
control the maximum size, in storage units, of aggregate
which is considered for replacement when compiling for
speed (‘sra-max-scalarization-size-Ospeed’) or size
(‘sra-max-scalarization-size-Osize’) respectively.
sra-max-propagations
The maximum number of artificial accesses that Scalar Replace-
ment of Aggregates (SRA) will track, per one local variable, in
order to facilitate copy propagation.
tm-max-aggregate-size
When making copies of thread-local variables in a transaction, this
parameter specifies the size in bytes after which variables are saved
with the logging functions as opposed to save/restore code sequence
pairs. This option only applies when using ‘-fgnu-tm’.
graphite-max-nb-scop-params
To avoid exponential effects in the Graphite loop transforms, the
number of parameters in a Static Control Part (SCoP) is bounded.
A value of zero can be used to lift the bound. A variable whose
value is unknown at compilation time and defined outside a SCoP
is a parameter of the SCoP.
loop-block-tile-size
Loop blocking or strip mining transforms, enabled with
‘-floop-block’ or ‘-floop-strip-mine’, strip mine each loop in
the loop nest by a given number of iterations. The strip length
can be changed using the ‘loop-block-tile-size’ parameter.
226 Using the GNU Compiler Collection (GCC)
ipa-jump-function-lookups
Specifies number of statements visited during jump function offset
discovery.
ipa-cp-value-list-size
IPA-CP attempts to track all possible values and types passed to a
function’s parameter in order to propagate them and perform devir-
tualization. ‘ipa-cp-value-list-size’ is the maximum number
of values and types it stores per one formal parameter of a function.
ipa-cp-eval-threshold
IPA-CP calculates its own score of cloning profitability heuristics
and performs those cloning opportunities with scores that exceed
‘ipa-cp-eval-threshold’.
ipa-cp-max-recursive-depth
Maximum depth of recursive cloning for self-recursive function.
ipa-cp-min-recursive-probability
Recursive cloning only when the probability of call being executed
exceeds the parameter.
ipa-cp-profile-count-base
When using ‘-fprofile-use’ option, IPA-CP will consider the
measured execution count of a call graph edge at this percentage
position in their histogram as the basis for its heuristics calculation.
ipa-cp-recursive-freq-factor
The number of times interprocedural copy propagation expects re-
cursive functions to call themselves.
ipa-cp-recursion-penalty
Percentage penalty the recursive functions will receive when they
are evaluated for cloning.
ipa-cp-single-call-penalty
Percentage penalty functions containing a single call to another
function will receive when they are evaluated for cloning.
ipa-max-agg-items
IPA-CP is also capable to propagate a number of scalar values
passed in an aggregate. ‘ipa-max-agg-items’ controls the maxi-
mum number of such values per one parameter.
ipa-cp-loop-hint-bonus
When IPA-CP determines that a cloning candidate would make
the number of iterations of a loop known, it adds a bonus of
‘ipa-cp-loop-hint-bonus’ to the profitability score of the
candidate.
ipa-max-loop-predicates
The maximum number of different predicates IPA will use to de-
scribe when loops in a function have known properties.
Chapter 3: GCC Command Options 227
ipa-max-aa-steps
During its analysis of function bodies, IPA-CP employs alias
analysis in order to track values pointed to by function parameters.
In order not spend too much time analyzing huge functions, it
gives up and consider all memory clobbered after examining
‘ipa-max-aa-steps’ statements modifying memory.
ipa-max-switch-predicate-bounds
Maximal number of boundary endpoints of case ranges of switch
statement. For switch exceeding this limit, IPA-CP will not con-
struct cloning cost predicate, which is used to estimate cloning
benefit, for default case of the switch statement.
ipa-max-param-expr-ops
IPA-CP will analyze conditional statement that references some
function parameter to estimate benefit for cloning upon certain
constant value. But if number of operations in a parameter expres-
sion exceeds ‘ipa-max-param-expr-ops’, the expression is treated
as complicated one, and is not handled by IPA analysis.
lto-partitions
Specify desired number of partitions produced during WHOPR
compilation. The number of partitions should exceed the number
of CPUs used for compilation.
lto-min-partition
Size of minimal partition for WHOPR (in estimated instructions).
This prevents expenses of splitting very small programs into too
many partitions.
lto-max-partition
Size of max partition for WHOPR (in estimated instructions). to
provide an upper bound for individual size of partition. Meant to
be used only with balanced partitioning.
lto-max-streaming-parallelism
Maximal number of parallel processes used for LTO streaming.
cxx-max-namespaces-for-diagnostic-help
The maximum number of namespaces to consult for suggestions
when C++ name lookup fails for an identifier.
sink-frequency-threshold
The maximum relative execution frequency (in percents) of the tar-
get block relative to a statement’s original block to allow statement
sinking of a statement. Larger numbers result in more aggressive
statement sinking. A small positive adjustment is applied for state-
ments with memory operands as those are even more profitable so
sink.
228 Using the GNU Compiler Collection (GCC)
max-stores-to-sink
The maximum number of conditional store pairs that can be
sunk. Set to 0 if either vectorization (‘-ftree-vectorize’) or
if-conversion (‘-ftree-loop-if-convert’) is disabled.
case-values-threshold
The smallest number of different values for which it is best to use
a jump-table instead of a tree of conditional branches. If the value
is 0, use the default for the machine.
jump-table-max-growth-ratio-for-size
The maximum code size growth ratio when expanding into a jump
table (in percent). The parameter is used when optimizing for size.
jump-table-max-growth-ratio-for-speed
The maximum code size growth ratio when expanding into a jump
table (in percent). The parameter is used when optimizing for
speed.
tree-reassoc-width
Set the maximum number of instructions executed in parallel in re-
associated tree. This parameter overrides target dependent heuris-
tics used by default if has non zero value.
sched-pressure-algorithm
Choose between the two available implementations of
‘-fsched-pressure’. Algorithm 1 is the original implementation
and is the more likely to prevent instructions from being reordered.
Algorithm 2 was designed to be a compromise between the
relatively conservative approach taken by algorithm 1 and the
rather aggressive approach taken by the default scheduler. It relies
more heavily on having a regular register file and accurate register
pressure classes. See ‘haifa-sched.cc’ in the GCC sources for
more details.
The default choice depends on the target.
max-slsr-cand-scan
Set the maximum number of existing candidates that are consid-
ered when seeking a basis for a new straight-line strength reduction
candidate.
asan-globals
Enable buffer overflow detection for global objects. This
kind of protection is enabled by default if you are using
‘-fsanitize=address’ option. To disable global objects
protection use ‘--param asan-globals=0’.
asan-stack
Enable buffer overflow detection for stack objects. This kind of
protection is enabled by default when using ‘-fsanitize=address’.
To disable stack protection use ‘--param asan-stack=0’ option.
Chapter 3: GCC Command Options 229
asan-instrument-reads
Enable buffer overflow detection for memory reads. This
kind of protection is enabled by default when using
‘-fsanitize=address’. To disable memory reads protection use
‘--param asan-instrument-reads=0’.
asan-instrument-writes
Enable buffer overflow detection for memory writes. This
kind of protection is enabled by default when using
‘-fsanitize=address’. To disable memory writes protection use
‘--param asan-instrument-writes=0’ option.
asan-memintrin
Enable detection for built-in functions. This kind of protection is
enabled by default when using ‘-fsanitize=address’. To disable
built-in functions protection use ‘--param asan-memintrin=0’.
asan-use-after-return
Enable detection of use-after-return. This kind of protection is
enabled by default when using the ‘-fsanitize=address’ option.
To disable it use ‘--param asan-use-after-return=0’.
Note: By default the check is disabled at run time. To enable it, add
detect_stack_use_after_return=1 to the environment variable
ASAN_OPTIONS.
asan-instrumentation-with-call-threshold
If number of memory accesses in function being instrumented
is greater or equal to this number, use callbacks instead
of inline checks. E.g. to disable inline code use ‘--param
asan-instrumentation-with-call-threshold=0’.
hwasan-instrument-stack
Enable hwasan instrumentation of statically sized stack-allocated
variables. This kind of instrumentation is enabled by default when
using ‘-fsanitize=hwaddress’ and disabled by default when using
‘-fsanitize=kernel-hwaddress’. To disable stack instrumenta-
tion use ‘--param hwasan-instrument-stack=0’, and to enable it
use ‘--param hwasan-instrument-stack=1’.
hwasan-random-frame-tag
When using stack instrumentation, decide tags for stack variables
using a deterministic sequence beginning at a random tag for
each frame. With this parameter unset tags are chosen using
the same sequence but beginning from 1. This is enabled
by default for ‘-fsanitize=hwaddress’ and unavailable for
‘-fsanitize=kernel-hwaddress’. To disable it use ‘--param
hwasan-random-frame-tag=0’.
hwasan-instrument-allocas
Enable hwasan instrumentation of dynamically sized stack-
allocated variables. This kind of instrumentation is enabled
230 Using the GNU Compiler Collection (GCC)
parloops-min-per-thread
The minimum number of iterations per thread of an innermost
parallelized loop for which the parallelized variant is preferred over
the single threaded one. Note that for a parallelized loop nest the
minimum number of iterations of the outermost loop per thread is
two.
max-ssa-name-query-depth
Maximum depth of recursion when querying properties of SSA
names in things like fold routines. One level of recursion corre-
sponds to following a use-def chain.
max-speculative-devirt-maydefs
The maximum number of may-defs we analyze when looking for a
must-def specifying the dynamic type of an object that invokes a
virtual call we may be able to devirtualize speculatively.
max-vrp-switch-assertions
The maximum number of assertions to add along the default edge
of a switch statement during VRP.
evrp-sparse-threshold
Maximum number of basic blocks before EVRP uses a sparse cache.
vrp1-mode
Specifies the mode VRP pass 1 should operate in.
vrp2-mode
Specifies the mode VRP pass 2 should operate in.
ranger-debug
Specifies the type of debug output to be issued for ranges.
evrp-switch-limit
Specifies the maximum number of switch cases before EVRP ig-
nores a switch.
unroll-jam-min-percent
The minimum percentage of memory references that must be opti-
mized away for the unroll-and-jam transformation to be considered
profitable.
unroll-jam-max-unroll
The maximum number of times the outer loop should be unrolled
by the unroll-and-jam transformation.
max-rtl-if-conversion-unpredictable-cost
Maximum permissible cost for the sequence that would be gener-
ated by the RTL if-conversion pass for a branch that is considered
unpredictable.
max-variable-expansions-in-unroller
If ‘-fvariable-expansion-in-unroller’ is used, the maximum
number of times that an individual variable will be expanded during
loop unrolling.
232 Using the GNU Compiler Collection (GCC)
partial-inlining-entry-probability
Maximum probability of the entry BB of split region (in percent
relative to entry BB of the function) to make partial inlining hap-
pen.
max-tracked-strlens
Maximum number of strings for which strlen optimization pass will
track string lengths.
gcse-after-reload-partial-fraction
The threshold ratio for performing partial redundancy elimination
after reload.
gcse-after-reload-critical-fraction
The threshold ratio of critical edges execution count that permit
performing redundancy elimination after reload.
max-loop-header-insns
The maximum number of insns in loop header duplicated by the
copy loop headers pass.
vect-epilogues-nomask
Enable loop epilogue vectorization using smaller vector size.
vect-partial-vector-usage
Controls when the loop vectorizer considers using partial vector
loads and stores as an alternative to falling back to scalar code. 0
stops the vectorizer from ever using partial vector loads and stores.
1 allows partial vector loads and stores if vectorization removes
the need for the code to iterate. 2 allows partial vector loads and
stores in all loops. The parameter only has an effect on targets that
support partial vector loads and stores.
vect-inner-loop-cost-factor
The maximum factor which the loop vectorizer applies to the cost
of statements in an inner loop relative to the loop being vectorized.
The factor applied is the maximum of the estimated number of
iterations of the inner loop and this parameter. The default value
of this parameter is 50.
vect-induction-float
Enable loop vectorization of floating point inductions.
avoid-fma-max-bits
Maximum number of bits for which we avoid creating FMAs.
sms-loop-average-count-threshold
A threshold on the average loop count considered by the swing
modulo scheduler.
sms-dfa-history
The number of cycles the swing modulo scheduler considers when
checking conflicts using DFA.
Chapter 3: GCC Command Options 233
graphite-allow-codegen-errors
Whether codegen errors should be ICEs when ‘-fchecking’.
sms-max-ii-factor
A factor for tuning the upper bound that swing modulo scheduler
uses for scheduling a loop.
lra-max-considered-reload-pseudos
The max number of reload pseudos which are considered during
spilling a non-reload pseudo.
max-pow-sqrt-depth
Maximum depth of sqrt chains to use when synthesizing exponen-
tiation by a real constant.
max-dse-active-local-stores
Maximum number of active local stores in RTL dead store elimi-
nation.
asan-instrument-allocas
Enable asan allocas/VLAs protection.
max-iterations-computation-cost
Bound on the cost of an expression to compute the number of iter-
ations.
max-isl-operations
Maximum number of isl operations, 0 means unlimited.
graphite-max-arrays-per-scop
Maximum number of arrays per scop.
max-vartrack-reverse-op-size
Max. size of loc list for which reverse ops should be added.
fsm-scale-path-stmts
Scale factor to apply to the number of statements in a threading
path when comparing to the number of (scaled) blocks.
uninit-control-dep-attempts
Maximum number of nested calls to search for control dependencies
during uninitialized variable analysis.
fsm-scale-path-blocks
Scale factor to apply to the number of blocks in a threading path
when comparing to the number of (scaled) statements.
sched-autopref-queue-depth
Hardware autoprefetcher scheduler model control flag. Number of
lookahead cycles the model looks into; at ’ ’ only enable instruction
sorting heuristic.
loop-versioning-max-inner-insns
The maximum number of instructions that an inner loop can have
before the loop versioning pass considers it too big to copy.
234 Using the GNU Compiler Collection (GCC)
loop-versioning-max-outer-insns
The maximum number of instructions that an outer loop can have
before the loop versioning pass considers it too big to copy, dis-
counting any instructions in inner loops that directly benefit from
versioning.
ssa-name-def-chain-limit
The maximum number of SSA NAME assignments to follow in
determining a property of a variable such as its value. This limits
the number of iterations or recursive calls GCC performs when
optimizing certain statements or when determining their validity
prior to issuing diagnostics.
store-merging-max-size
Maximum size of a single store merging region in bytes.
hash-table-verification-limit
The number of elements for which hash table verification is done
for each searched element.
max-find-base-term-values
Maximum number of VALUEs handled during a single
find base term call.
analyzer-max-enodes-per-program-point
The maximum number of exploded nodes per program point within
the analyzer, before terminating analysis of that point.
analyzer-max-constraints
The maximum number of constraints per state.
analyzer-min-snodes-for-call-summary
The minimum number of supernodes within a function for the an-
alyzer to consider summarizing its effects at call sites.
analyzer-max-enodes-for-full-dump
The maximum depth of exploded nodes that should appear in a
dot dump before switching to a less verbose format.
analyzer-max-recursion-depth
The maximum number of times a callsite can appear in a call stack
within the analyzer, before terminating analysis of a call that would
recurse deeper.
analyzer-max-svalue-depth
The maximum depth of a symbolic value, before approximating the
value as unknown.
analyzer-max-infeasible-edges
The maximum number of infeasible edges to reject before declaring
a diagnostic as infeasible.
gimple-fe-computed-hot-bb-threshold
The number of executions of a basic block which is considered hot.
The parameter is used only in GIMPLE FE.
Chapter 3: GCC Command Options 235
analyzer-bb-explosion-factor
The maximum number of ’after supernode’ exploded nodes within
the analyzer per supernode, before terminating analysis.
ranger-logical-depth
Maximum depth of logical expression evaluation ranger will look
through when evaluating outgoing edge ranges.
relation-block-limit
Maximum number of relations the oracle will register in a basic
block.
min-pagesize
Minimum page size for warning purposes.
openacc-kernels
Specify mode of OpenACC ‘kernels’ constructs handling. With
‘--param=openacc-kernels=decompose’, OpenACC ‘kernels’ con-
structs are decomposed into parts, a sequence of compute con-
structs, each then handled individually. This is work in progress.
With ‘--param=openacc-kernels=parloops’, OpenACC ‘kernels’
constructs are handled by the ‘parloops’ pass, en bloc. This is the
current default.
openacc-privatization
Specify mode of OpenACC privatization diagnostics for
‘-fopt-info-omp-note’ and applicable ‘-fdump-tree-*-details’.
With ‘--param=openacc-privatization=quiet’,
don’t diagnose. This is the current default. With
‘--param=openacc-privatization=noisy’, do diagnose.
The following choices of name are available on AArch64 targets:
aarch64-sve-compare-costs
When vectorizing for SVE, consider using “unpacked” vectors for
smaller elements and use the cost model to pick the cheapest ap-
proach. Also use the cost model to choose between SVE and Ad-
vanced SIMD vectorization.
Using unpacked vectors includes storing smaller elements in larger
containers and accessing elements with extending loads and trun-
cating stores.
aarch64-float-recp-precision
The number of Newton iterations for calculating the reciprocal for
float type. The precision of division is proportional to this param
when division approximation is enabled. The default value is 1.
aarch64-double-recp-precision
The number of Newton iterations for calculating the reciprocal for
double type. The precision of division is propotional to this param
when division approximation is enabled. The default value is 2.
236 Using the GNU Compiler Collection (GCC)
aarch64-autovec-preference
Force an ISA selection strategy for auto-vectorization. Accepts
values from 0 to 4, inclusive.
‘0’ Use the default heuristics.
‘1’ Use only Advanced SIMD for auto-vectorization.
‘2’ Use only SVE for auto-vectorization.
‘3’ Use both Advanced SIMD and SVE. Prefer Advanced
SIMD when the costs are deemed equal.
‘4’ Use both Advanced SIMD and SVE. Prefer SVE when
the costs are deemed equal.
The default value is 0.
aarch64-loop-vect-issue-rate-niters
The tuning for some AArch64 CPUs tries to take both latencies
and issue rates into account when deciding whether a loop should
be vectorized using SVE, vectorized using Advanced SIMD, or not
vectorized at all. If this parameter is set to n, GCC will not use
this heuristic for loops that are known to execute in fewer than n
Advanced SIMD iterations.
aarch64-vect-unroll-limit
The vectorizer will use available tuning information to determine
whether it would be beneficial to unroll the main vectorized loop
and by how much. This parameter set’s the upper bound of how
much the vectorizer will unroll the main loop. The default value is
four.
The following choices of name are available on i386 and x86 64 targets:
x86-stlf-window-ninsns
Instructions number above which STFL stall penalty can be com-
pensated.
compiling the source files you want data about, and you must also use it when
linking.
You can use the function attribute no_instrument_function to suppress
profiling of individual functions when compiling with these options. See
Section 6.33.1 [Common Function Attributes], page 557.
-fprofile-arcs
Add code so that program flow arcs are instrumented. During execution the
program records how many times each branch and call is executed and how
many times it is taken or returns. On targets that support constructors with
priority support, profiling properly handles constructors, destructors and C++
constructors (and destructors) of classes which are used as a type of a global
variable.
When the compiled program exits it saves this data to a file called
‘auxname.gcda’ for each source file. The data may be used for profile-directed
optimizations (‘-fbranch-probabilities’), or for test coverage analysis
(‘-ftest-coverage’). Each object file’s auxname is generated from the name
of the output file, if explicitly specified and it is not the final executable,
otherwise it is the basename of the source file. In both cases any suffix is
removed (e.g. ‘foo.gcda’ for input file ‘dir/foo.c’, or ‘dir/foo.gcda’ for
output file specified as ‘-o dir/foo.o’).
Note that if a command line directly links source files, the corresponding .gcda
files will be prefixed with the unsuffixed name of the output file. E.g. gcc a.c
b.c -o binary would generate ‘binary-a.gcda’ and ‘binary-b.gcda’ files.
See Section 10.5 [Cross-profiling], page 933.
--coverage
This option is used to compile and link code instrumented for coverage analysis.
The option is a synonym for ‘-fprofile-arcs’ ‘-ftest-coverage’ (when com-
piling) and ‘-lgcov’ (when linking). See the documentation for those options
for more details.
• Compile the source files with ‘-fprofile-arcs’ plus optimization and
code generation options. For test coverage analysis, use the additional
‘-ftest-coverage’ option. You do not need to profile every source file in
a program.
• Compile the source files additionally with ‘-fprofile-abs-path’ to create
absolute path names in the ‘.gcno’ files. This allows gcov to find the
correct sources in projects where compilations occur with different working
directories.
• Link your object files with ‘-lgcov’ or ‘-fprofile-arcs’ (the latter implies
the former).
• Run the program on a representative workload to generate the arc profile
information. This may be repeated any number of times. You can run
concurrent instances of your program, and provided that the file system
supports locking, the data files will be correctly updated. Unless a strict
ISO C dialect option is in effect, fork calls are detected and correctly
handled without double counting.
238 Using the GNU Compiler Collection (GCC)
Moreover, an object file can be recompiled multiple times and the corre-
sponding ‘.gcda’ file merges as long as the source file and the compiler
options are unchanged.
• For profile-directed optimizations, compile the source files again
with the same optimization and code generation options plus
‘-fbranch-probabilities’ (see Section 3.11 [Options that Control
Optimization], page 163).
• For test coverage analysis, use gcov to produce human readable information
from the ‘.gcno’ and ‘.gcda’ files. Refer to the gcov documentation for
further information.
With ‘-fprofile-arcs’, for each function of your program GCC creates a
program flow graph, then finds a spanning tree for the graph. Only arcs that
are not on the spanning tree have to be instrumented: the compiler adds code
to count the number of times that these arcs are executed. When an arc is
the only exit or only entrance to a block, the instrumentation code can be
added to the block; otherwise, a new basic block must be created to hold the
instrumentation code.
-ftest-coverage
Produce a notes file that the gcov code-coverage utility (see Chapter 10 [gcov—
a Test Coverage Program], page 921) can use to show program coverage. Each
source file’s note file is called ‘auxname.gcno’. Refer to the ‘-fprofile-arcs’
option above for a description of auxname and instructions on how to generate
test coverage data. Coverage data matches the source files more closely if you
do not optimize.
-fprofile-abs-path
Automatically convert relative source file names to absolute path names in the
‘.gcno’ files. This allows gcov to find the correct sources in projects where
compilations occur with different working directories.
-fprofile-dir=path
Set the directory to search for the profile data files in to path. This
option affects only the profile data generated by ‘-fprofile-generate’,
‘-ftest-coverage’, ‘-fprofile-arcs’ and used by ‘-fprofile-use’ and
‘-fbranch-probabilities’ and its related options. Both absolute and
relative paths can be used. By default, GCC uses the current directory as
path, thus the profile data file appears in the same directory as the object file.
In order to prevent the file name clashing, if the object file name is not an
absolute path, we mangle the absolute path of the ‘sourcename.gcda’ file and
use it as the file name of a ‘.gcda’ file. See details about the file naming in
‘-fprofile-arcs’. See similar option ‘-fprofile-note’.
When an executable is run in a massive parallel environment, it is recommended
to save profile to different folders. That can be done with variables in path that
are exported during run-time:
%p process ID.
%q{VAR} value of environment variable VAR
Chapter 3: GCC Command Options 239
-fprofile-generate
-fprofile-generate=path
Enable options usually used for instrumenting application to produce profile
useful for later recompilation with profile feedback based optimization. You
must use ‘-fprofile-generate’ both when compiling and when linking your
program.
The following options are enabled: ‘-fprofile-arcs’, ‘-fprofile-values’,
‘-finline-functions’, and ‘-fipa-bit-cp’.
If path is specified, GCC looks at the path to find the profile feedback data
files. See ‘-fprofile-dir’.
To optimize the program based on the collected profile information, use
‘-fprofile-use’. See Section 3.11 [Optimize Options], page 163, for more
information.
-fprofile-info-section
-fprofile-info-section=name
Register the profile information in the specified section instead of using a con-
structor/destructor. The section name is name if it is specified, otherwise the
section name defaults to .gcov_info. A pointer to the profile information
generated by ‘-fprofile-arcs’ is placed in the specified section for each trans-
lation unit. This option disables the profile information registration through
a constructor and it disables the profile information processing through a de-
structor. This option is not intended to be used in hosted environments such
as GNU/Linux. It targets freestanding environments (for example embedded
systems) with limited resources which do not support constructors/destructors
or the C library file I/O.
The linker could collect the input sections in a continuous memory block and
define start and end symbols. A GNU linker script example which defines a
linker output section follows:
.gcov_info :
{
PROVIDE (__gcov_info_start = .);
KEEP (*(.gcov_info))
PROVIDE (__gcov_info_end = .);
}
The program could dump the profiling information registered in this linker set
for example like this:
#include <gcov.h>
#include <stdio.h>
#include <stdlib.h>
static void
dump (const void *d, unsigned n, void *arg)
{
const unsigned char *c = d;
static void
filename (const char *f, void *arg)
{
__gcov_filename_to_gcfn (f, dump, arg );
}
static void *
allocate (unsigned length, void *arg)
{
return malloc (length);
}
static void
dump_gcov_info (void)
{
const struct gcov_info *const *info = __gcov_info_start;
const struct gcov_info *const *end = __gcov_info_end;
int
main (void)
{
dump_gcov_info ();
return 0;
}
The merge-stream subcommand of gcov-tool may be used to deserialize the
data stream generated by the __gcov_filename_to_gcfn and __gcov_info_
to_gcda functions and merge the profile information into ‘.gcda’ files on the
host filesystem.
-fprofile-note=path
If path is specified, GCC saves ‘.gcno’ file into path location. If you combine
the option with multiple source files, the ‘.gcno’ file will be overwritten.
-fprofile-prefix-path=path
This option can be used in combination with ‘profile-generate=’profile dir
and ‘profile-use=’profile dir to inform GCC where is the base directory of
built source tree. By default profile dir will contain files with mangled ab-
solute paths of all object files in the built project. This is not desirable
when directory used to build the instrumented binary differs from the direc-
tory used to build the binary optimized with profile feedback because the
profile data will not be found during the optimized build. In such setups
Chapter 3: GCC Command Options 241
-fsanitize=pointer-compare
Instrument comparison operation (<, <=, >, >=) with pointer operands.
The option must be combined with either ‘-fsanitize=kernel-address’
or ‘-fsanitize=address’ The option cannot be combined with
‘-fsanitize=thread’. Note: By default the check is disabled at run time.
To enable it, add detect_invalid_pointer_pairs=2 to the environment
variable ASAN_OPTIONS. Using detect_invalid_pointer_pairs=1 detects
invalid operation only when both pointers are non-null.
-fsanitize=pointer-subtract
Instrument subtraction with pointer operands. The option must be combined
with either ‘-fsanitize=kernel-address’ or ‘-fsanitize=address’ The op-
tion cannot be combined with ‘-fsanitize=thread’. Note: By default the
check is disabled at run time. To enable it, add detect_invalid_pointer_
pairs=2 to the environment variable ASAN_OPTIONS. Using detect_invalid_
pointer_pairs=1 detects invalid operation only when both pointers are non-
null.
-fsanitize=shadow-call-stack
Enable ShadowCallStack, a security enhancement mechanism used to protect
programs against return address overwrites (e.g. stack buffer overflows.) It
works by saving a function’s return address to a separately allocated shadow
call stack in the function prologue and restoring the return address from the
shadow call stack in the function epilogue. Instrumentation only occurs in
functions that need to save the return address to the stack.
Currently it only supports the aarch64 platform. It is specifically designed for
linux kernels that enable the CONFIG SHADOW CALL STACK option. For
the user space programs, runtime support is not currently provided in libc and
libgcc. Users who want to use this feature in user space need to provide their
own support for the runtime. It should be noted that this may cause the ABI
rules to be broken.
On aarch64, the instrumentation makes use of the platform register x18. This
generally means that any code that may run on the same thread as code com-
piled with ShadowCallStack must be compiled with the flag ‘-ffixed-x18’,
otherwise functions compiled without ‘-ffixed-x18’ might clobber x18 and so
corrupt the shadow stack pointer.
Also, because there is no userspace runtime support, code compiled with Shad-
owCallStack cannot use exception handling. Use ‘-fno-exceptions’ to turn
off exceptions.
See https://clang.llvm.org/docs/ShadowCallStack.html for more details.
-fsanitize=thread
Enable ThreadSanitizer, a fast data race detector. Memory access instructions
are instrumented to detect data race bugs. See https: / / github . com /
google/sanitizers/wiki#threadsanitizer for more details. The run-time
behavior can be influenced using the TSAN_OPTIONS environment variable; see
https: / / github . com / google / sanitizers / wiki / ThreadSanitizerFlags
244 Using the GNU Compiler Collection (GCC)
-fsanitize=null
This option enables pointer checking. Particularly, the application
built with this option turned on will issue an error message when
it tries to dereference a NULL pointer, or if a reference (possibly
an rvalue reference) is bound to a NULL pointer, or if a method is
invoked on an object pointed by a NULL pointer.
-fsanitize=return
This option enables return statement checking. Programs built
with this option turned on will issue an error message when the
end of a non-void function is reached without actually returning a
value. This option works in C++ only.
-fsanitize=signed-integer-overflow
This option enables signed integer overflow checking. We check that
the result of +, *, and both unary and binary - does not overflow
in the signed arithmetics. This also detects INT_MIN / -1 signed
division. Note, integer promotion rules must be taken into account.
That is, the following is not an overflow:
signed char a = SCHAR_MAX;
a++;
-fsanitize=bounds
This option enables instrumentation of array bounds. Various out
of bounds accesses are detected. Flexible array members, flexible
array member-like arrays, and initializers of variables with static
storage are not instrumented.
-fsanitize=bounds-strict
This option enables strict instrumentation of array bounds. Most
out of bounds accesses are detected, including flexible array mem-
bers and flexible array member-like arrays. Initializers of variables
with static storage are not instrumented.
-fsanitize=alignment
This option enables checking of alignment of pointers when they are
dereferenced, or when a reference is bound to insufficiently aligned
target, or when a method or constructor is invoked on insufficiently
aligned object.
-fsanitize=object-size
This option enables instrumentation of memory references using the
__builtin_object_size function. Various out of bounds pointer
accesses are detected.
-fsanitize=float-divide-by-zero
Detect floating-point division by zero. Unlike other similar
options, ‘-fsanitize=float-divide-by-zero’ is not enabled by
‘-fsanitize=undefined’, since floating-point division by zero can
be a legitimate way of obtaining infinities and NaNs.
246 Using the GNU Compiler Collection (GCC)
-fsanitize=float-cast-overflow
This option enables floating-point type to integer conversion check-
ing. We check that the result of the conversion does not overflow.
Unlike other similar options, ‘-fsanitize=float-cast-overflow’
is not enabled by ‘-fsanitize=undefined’. This option does not
work well with FE_INVALID exceptions enabled.
-fsanitize=nonnull-attribute
This option enables instrumentation of calls, checking whether null
values are not passed to arguments marked as requiring a non-null
value by the nonnull function attribute.
-fsanitize=returns-nonnull-attribute
This option enables instrumentation of return statements in func-
tions marked with returns_nonnull function attribute, to detect
returning of null values from such functions.
-fsanitize=bool
This option enables instrumentation of loads from bool. If a value
other than 0/1 is loaded, a run-time error is issued.
-fsanitize=enum
This option enables instrumentation of loads from an enum type.
If a value outside the range of values for the enum type is loaded,
a run-time error is issued.
-fsanitize=vptr
This option enables instrumentation of C++ member function calls,
member accesses and some conversions between pointers to base
and derived classes, to verify the referenced object has the correct
dynamic type.
-fsanitize=pointer-overflow
This option enables instrumentation of pointer arithmetics. If the
pointer arithmetics overflows, a run-time error is issued.
-fsanitize=builtin
This option enables instrumentation of arguments to selected
builtin functions. If an invalid value is passed to such arguments,
a run-time error is issued. E.g. passing 0 as the argument to
__builtin_ctz or __builtin_clz invokes undefined behavior
and is diagnosed by this option.
-fno-sanitize=all
This option disables all previously enabled sanitizers. ‘-fsanitize=all’ is not
allowed, as some sanitizers cannot be used together.
Chapter 3: GCC Command Options 247
-fasan-shadow-offset=number
This option forces GCC to use custom shadow offset in AddressSanitizer checks.
It is useful for experimenting with different shadow memory layouts in Kernel
AddressSanitizer.
-fsanitize-sections=s1,s2,...
Sanitize global variables in selected user-defined sections. si may contain wild-
cards.
-fsanitize-recover[=opts]
‘-fsanitize-recover=’ controls error recovery mode for sanitizers mentioned
in comma-separated list of opts. Enabling this option for a sanitizer component
causes it to attempt to continue running the program as if no error happened.
This means multiple runtime errors can be reported in a single program run,
and the exit code of the program may indicate success even when errors have
been reported. The ‘-fno-sanitize-recover=’ option can be used to alter
this behavior: only the first detected error is reported and program then exits
with a non-zero exit code.
Currently this feature only works for ‘-fsanitize=undefined’ (and its
suboptions except for ‘-fsanitize=unreachable’ and ‘-fsanitize=return’),
‘-fsanitize=float-cast-overflow’, ‘-fsanitize=float-divide-by-zero’,
‘-fsanitize=bounds-strict’, ‘-fsanitize=kernel-address’ and
‘-fsanitize=address’. For these sanitizers error recovery is turned on by
default, except ‘-fsanitize=address’, for which this feature is experimental.
‘-fsanitize-recover=all’ and ‘-fno-sanitize-recover=all’ is also
accepted, the former enables recovery for all sanitizers that support it, the
latter disables recovery for all sanitizers that support it.
Even if a recovery mode is turned on the compiler side, it needs to be also
enabled on the runtime library side, otherwise the failures are still fatal. The
runtime library defaults to halt_on_error=0 for ThreadSanitizer and Unde-
finedBehaviorSanitizer, while default value for AddressSanitizer is halt_on_
error=1. This can be overridden through setting the halt_on_error flag in
the corresponding environment variable.
Syntax without an explicit opts parameter is deprecated. It is equivalent to
specifying an opts list of:
undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
-fsanitize-address-use-after-scope
Enable sanitization of local variables to detect use-after-scope bugs. The option
sets ‘-fstack-reuse’ to ‘none’.
-fsanitize-trap[=opts]
The ‘-fsanitize-trap=’ option instructs the compiler to report for sanitiz-
ers mentioned in comma-separated list of opts undefined behavior using __
builtin_trap rather than a libubsan library routine. If this option is enabled
for certain sanitizer, it takes precedence over the ‘-fsanitizer-recover=’
for that sanitizer, __builtin_trap will be emitted and be fatal regardless of
whether recovery is enabled or disabled using ‘-fsanitize-recover=’.
248 Using the GNU Compiler Collection (GCC)
The advantage of this is that the libubsan library is not needed and is not
linked in, so this is usable even in freestanding environments.
Currently this feature works with ‘-fsanitize=undefined’ (and its subop-
tions except for ‘-fsanitize=vptr’), ‘-fsanitize=float-cast-overflow’,
‘-fsanitize=float-divide-by-zero’ and ‘-fsanitize=bounds-strict’.
-fsanitize-trap=all can be also specified, which enables it
for undefined suboptions, ‘-fsanitize=float-cast-overflow’,
‘-fsanitize=float-divide-by-zero’ and ‘-fsanitize=bounds-strict’.
If -fsanitize-trap=undefined or -fsanitize-trap=all is used and
-fsanitize=vptr is enabled on the command line, the instrumentation
is silently ignored as the instrumentation always needs libubsan support,
‘-fsanitize-trap=vptr’ is not allowed.
-fsanitize-undefined-trap-on-error
The ‘-fsanitize-undefined-trap-on-error’ option is deprecated equivalent
of ‘-fsanitize-trap=all’.
-fsanitize-coverage=trace-pc
Enable coverage-guided fuzzing code instrumentation. Inserts a call to __
sanitizer_cov_trace_pc into every basic block.
-fsanitize-coverage=trace-cmp
Enable dataflow guided fuzzing code instrumentation. Inserts a call
to __sanitizer_cov_trace_cmp1, __sanitizer_cov_trace_cmp2,
__sanitizer_cov_trace_cmp4 or __sanitizer_cov_trace_cmp8 for integral
comparison with both operands variable or __sanitizer_cov_trace_
const_cmp1, __sanitizer_cov_trace_const_cmp2, __sanitizer_cov_
trace_const_cmp4 or __sanitizer_cov_trace_const_cmp8 for integral
comparison with one operand constant, __sanitizer_cov_trace_cmpf
or __sanitizer_cov_trace_cmpd for float or double comparisons and
__sanitizer_cov_trace_switch for switch statements.
-fcf-protection=[full|branch|return|none|check]
Enable code instrumentation of control-flow transfers to increase program se-
curity by checking that target addresses of control-flow transfer instructions
(such as indirect function call, function return, indirect jump) are valid. This
prevents diverting the flow of control to an unexpected target. This is intended
to protect against such threats as Return-oriented Programming (ROP), and
similarly call/jmp-oriented programming (COP/JOP).
The value branch tells the compiler to implement checking of validity of control-
flow transfer at the point of indirect branch instructions, i.e. call/jmp instruc-
tions. The value return implements checking of validity at the point of return-
ing from a function. The value full is an alias for specifying both branch and
return. The value none turns off instrumentation.
The value check is used for the final link with link-time optimization (LTO). An
error is issued if LTO object files are compiled with different ‘-fcf-protection’
values. The value check is ignored at the compile time.
Chapter 3: GCC Command Options 249
The macro __CET__ is defined when ‘-fcf-protection’ is used. The first bit
of __CET__ is set to 1 for the value branch and the second bit of __CET__ is set
to 1 for the return.
You can also use the nocf_check attribute to identify which functions and calls
should be skipped from instrumentation (see Section 6.33 [Function Attributes],
page 556).
Currently the x86 GNU/Linux target provides an implementation based on Intel
Control-flow Enforcement Technology (CET) which works for i686 processor or
newer.
-fharden-compares
For every logical test that survives gimple optimizations and is not the condition
in a conditional branch (for example, conditions tested for conditional moves,
or to store in boolean variables), emit extra code to compute and verify the
reversed condition, and to call __builtin_trap if the results do not match.
Use with ‘-fharden-conditional-branches’ to cover all conditionals.
-fharden-conditional-branches
For every non-vectorized conditional branch that survives gimple optimizations,
emit extra code to compute and verify the reversed condition, and to call __
builtin_trap if the result is unexpected. Use with ‘-fharden-compares’ to
cover all conditionals.
-fstack-protector
Emit extra code to check for buffer overflows, such as stack smashing attacks.
This is done by adding a guard variable to functions with vulnerable objects.
This includes functions that call alloca, and functions with buffers larger than
or equal to 8 bytes. The guards are initialized when a function is entered and
then checked when the function exits. If a guard check fails, an error message
is printed and the program exits. Only variables that are actually allocated
on the stack are considered, optimized away variables or variables allocated in
registers don’t count.
-fstack-protector-all
Like ‘-fstack-protector’ except that all functions are protected.
-fstack-protector-strong
Like ‘-fstack-protector’ but includes additional functions to be protected —
those that have local array definitions, or have references to local frame ad-
dresses. Only variables that are actually allocated on the stack are considered,
optimized away variables or variables allocated in registers don’t count.
-fstack-protector-explicit
Like ‘-fstack-protector’ but only protects those functions which have the
stack_protect attribute.
-fstack-check
Generate code to verify that you do not go beyond the boundary of the stack.
You should specify this flag if you are running in an environment with multiple
threads, but you only rarely need to specify it in a single-threaded environment
250 Using the GNU Compiler Collection (GCC)
-fvtv-counts
This is a debugging flag. When used in conjunction with
‘-fvtable-verify=std’ or ‘-fvtable-verify=preinit’, this causes
the compiler to keep track of the total number of virtual calls it encounters
and the number of verifications it inserts. It also counts the number of calls to
certain run-time library functions that it inserts and logs this information for
each compilation unit. The compiler writes this information to a file named
‘vtv_count_data.log’ in the directory named by the environment variable
VTV_LOGS_DIR if that is defined or the current working directory otherwise. It
also counts the size of the vtable pointer sets for each class, and writes this
information to ‘vtv_class_set_sizes.log’ in the same directory.
Note: This feature appends data to the log files. To get fresh log files, be sure
to delete any existing ones.
-finstrument-functions
Generate instrumentation calls for entry and exit to functions. Just after func-
tion entry and just before function exit, the following profiling functions are
called with the address of the current function and its call site. (On some plat-
forms, __builtin_return_address does not work beyond the current function,
so the call site information may not be available to the profiling functions oth-
erwise.)
void __cyg_profile_func_enter (void *this_fn,
void *call_site);
void __cyg_profile_func_exit (void *this_fn,
void *call_site);
The first argument is the address of the start of the current function, which
may be looked up exactly in the symbol table.
This instrumentation is also done for functions expanded inline in other func-
tions. The profiling calls indicate where, conceptually, the inline function is
entered and exited. This means that addressable versions of such functions
must be available. If all your uses of a function are expanded inline, this may
mean an additional expansion of code size. If you use extern inline in your
C code, an addressable version of such functions must be provided. (This is
normally the case anyway, but if you get lucky and the optimizer always ex-
pands the functions inline, you might have gotten away without providing static
copies.)
A function may be given the attribute no_instrument_function, in which case
this instrumentation is not done. This can be used, for example, for the profiling
functions listed above, high-priority interrupt routines, and any functions from
which the profiling functions cannot safely be called (perhaps signal handlers, if
the profiling routines generate output or allocate memory). See Section 6.33.1
[Common Function Attributes], page 557.
-finstrument-functions-once
This is similar to ‘-finstrument-functions’, but the profiling functions are
called only once per instrumented function, i.e. the first profiling function
is called after the first entry into the instrumented function and the second
profiling function is called before the exit corresponding to this first entry.
Chapter 3: GCC Command Options 253
The definition of once for the purpose of this option is a little vague because
the implementation is not protected against data races. As a result, the imple-
mentation only guarantees that the profiling functions are called at least once
per process and at most once per thread, but the calls are always paired, that
is to say, if a thread calls the first function, then it will call the second function,
unless it never reaches the exit of the instrumented function.
-finstrument-functions-exclude-file-list=file,file,...
Set the list of functions that are excluded from instrumentation (see the de-
scription of ‘-finstrument-functions’). If the file that contains a function
definition matches with one of file, then that function is not instrumented. The
match is done on substrings: if the file parameter is a substring of the file name,
it is considered to be a match.
For example:
-finstrument-functions-exclude-file-list=/bits/stl,include/sys
excludes any inline function defined in files whose pathnames contain
‘/bits/stl’ or ‘include/sys’.
If, for some reason, you want to include letter ‘,’ in one of sym, write ‘\,’. For
example, ‘-finstrument-functions-exclude-file-list=’\,\,tmp’’ (note
the single quote surrounding the option).
-finstrument-functions-exclude-function-list=sym,sym,...
This is similar to ‘-finstrument-functions-exclude-file-list’, but this
option sets the list of function names to be excluded from instrumentation.
The function name to be matched is its user-visible name, such as
vector<int> blah(const vector<int> &), not the internal mangled name
(e.g., _Z4blahRSt6vectorIiSaIiEE). The match is done on substrings: if the
sym parameter is a substring of the function name, it is considered to be
a match. For C99 and C++ extended identifiers, the function name must be
given in UTF-8, not using universal character names.
-fpatchable-function-entry=N[,M]
Generate N NOPs right at the beginning of each function, with the function
entry point before the M th NOP. If M is omitted, it defaults to 0 so the func-
tion entry points to the address just at the first NOP. The NOP instructions
reserve extra space which can be used to patch in any desired instrumenta-
tion at run time, provided that the code segment is writable. The amount of
space is controllable indirectly via the number of NOPs; the NOP instruction
used corresponds to the instruction emitted by the internal GCC back-end in-
terface gen_nop. This behavior is target-specific and may also depend on the
architecture variant and/or other compilation options.
For run-time identification, the starting addresses of these areas, which corre-
spond to their respective function entries minus M, are additionally collected
in the __patchable_function_entries section of the resulting binary.
Note that the value of __attribute__ ((patchable_function_
entry (N,M))) takes precedence over command-line option
‘-fpatchable-function-entry=N,M’. This can be used to increase
254 Using the GNU Compiler Collection (GCC)
-D name=definition
The contents of definition are tokenized and processed as if they appeared dur-
ing translation phase three in a ‘#define’ directive. In particular, the definition
is truncated by embedded newline characters.
If you are invoking the preprocessor from a shell or shell-like program you may
need to use the shell’s quoting syntax to protect characters such as spaces that
have a meaning in the shell syntax.
If you wish to define a function-like macro on the command line, write its
argument list with surrounding parentheses before the equals sign (if any).
Parentheses are meaningful to most shells, so you should quote the option.
With sh and csh, ‘-D’name(args...)=definition’’ works.
‘-D’ and ‘-U’ options are processed in the order they are given on the command
line. All ‘-imacros file’ and ‘-include file’ options are processed after all
‘-D’ and ‘-U’ options.
-U name Cancel any previous definition of name, either built in or provided with a ‘-D’
option.
-include file
Process file as if #include "file" appeared as the first line of the primary
source file. However, the first directory searched for file is the preprocessor’s
working directory instead of the directory containing the main source file. If
not found there, it is searched for in the remainder of the #include "..."
search chain as normal.
If multiple ‘-include’ options are given, the files are included in the order they
appear on the command line.
Chapter 3: GCC Command Options 255
-imacros file
Exactly like ‘-include’, except that any output produced by scanning file is
thrown away. Macros it defines remain defined. This allows you to acquire all
the macros from a header without also processing its declarations.
All files specified by ‘-imacros’ are processed before all files specified by
‘-include’.
-undef Do not predefine any system-specific or GCC-specific macros. The standard
predefined macros remain defined.
-pthread Define additional macros required for using the POSIX threads library. You
should use this option consistently for both compilation and linking. This
option is supported on GNU/Linux targets, most other Unix derivatives, and
also on x86 Cygwin and MinGW targets.
-M Instead of outputting the result of preprocessing, output a rule suitable for make
describing the dependencies of the main source file. The preprocessor outputs
one make rule containing the object file name for that source file, a colon, and
the names of all the included files, including those coming from ‘-include’ or
‘-imacros’ command-line options.
Unless specified explicitly (with ‘-MT’ or ‘-MQ’), the object file name consists of
the name of the source file with any suffix replaced with object file suffix and
with any leading directory parts removed. If there are many included files then
the rule is split into several lines using ‘\’-newline. The rule has no commands.
This option does not suppress the preprocessor’s debug output, such as ‘-dM’.
To avoid mixing such debug output with the dependency rules you should ex-
plicitly specify the dependency output file with ‘-MF’, or use an environment
variable like DEPENDENCIES_OUTPUT (see Section 3.21 [Environment Variables],
page 505). Debug output is still sent to the regular output stream as normal.
Passing ‘-M’ to the driver implies ‘-E’, and suppresses warnings with an implicit
‘-w’.
-MM Like ‘-M’ but do not mention header files that are found in system header
directories, nor header files that are included, directly or indirectly, from such
a header.
This implies that the choice of angle brackets or double quotes in an ‘#include’
directive does not in itself determine whether that header appears in ‘-MM’
dependency output.
-MF file When used with ‘-M’ or ‘-MM’, specifies a file to write the dependencies to. If
no ‘-MF’ switch is given the preprocessor sends the rules to the same place it
would send preprocessed output.
When used with the driver options ‘-MD’ or ‘-MMD’, ‘-MF’ overrides the default
dependency output file.
If file is ‘-’, then the dependencies are written to ‘stdout’.
-MG In conjunction with an option such as ‘-M’ requesting dependency generation,
‘-MG’ assumes missing header files are generated files and adds them to the
dependency list without raising an error. The dependency filename is taken
256 Using the GNU Compiler Collection (GCC)
directly from the #include directive without prepending any path. ‘-MG’ also
suppresses preprocessed output, as a missing header file renders this useless.
This feature is used in automatic updating of makefiles.
-Mno-modules
Disable dependency generation for compiled module interfaces.
-MP This option instructs CPP to add a phony target for each dependency other
than the main file, causing each to depend on nothing. These dummy rules
work around errors make gives if you remove header files without updating the
‘Makefile’ to match.
This is typical output:
test.o: test.c test.h
test.h:
-MT target
Change the target of the rule emitted by dependency generation. By default
CPP takes the name of the main input file, deletes any directory components
and any file suffix such as ‘.c’, and appends the platform’s usual object suffix.
The result is the target.
An ‘-MT’ option sets the target to be exactly the string you specify. If you want
multiple targets, you can specify them as a single argument to ‘-MT’, or use
multiple ‘-MT’ options.
For example, ‘-MT ’$(objpfx)foo.o’’ might give
$(objpfx)foo.o: foo.c
-MQ target
Same as ‘-MT’, but it quotes any characters which are special to Make.
‘-MQ ’$(objpfx)foo.o’’ gives
$$(objpfx)foo.o: foo.c
The default target is automatically quoted, as if it were given with ‘-MQ’.
-MD ‘-MD’ is equivalent to ‘-M -MF file’, except that ‘-E’ is not implied. The driver
determines file based on whether an ‘-o’ option is given. If it is, the driver uses
its argument but with a suffix of ‘.d’, otherwise it takes the name of the input
file, removes any directory components and suffix, and applies a ‘.d’ suffix.
If ‘-MD’ is used in conjunction with ‘-E’, any ‘-o’ switch is understood to specify
the dependency output file (see [-MF], page 255), but if used without ‘-E’, each
‘-o’ is understood to specify a target object file.
Since ‘-E’ is not implied, ‘-MD’ can be used to generate a dependency output
file as a side effect of the compilation process.
-MMD Like ‘-MD’ except mention only user header files, not system header files.
-fpreprocessed
Indicate to the preprocessor that the input file has already been preprocessed.
This suppresses things like macro expansion, trigraph conversion, escaped new-
line splicing, and processing of most directives. The preprocessor still recognizes
and removes comments, so that you can pass a file preprocessed with ‘-C’ to the
Chapter 3: GCC Command Options 257
tokens locations completely. This value is the most memory hungry. When this
option is given no argument, the default parameter value is ‘2’.
Note that -ftrack-macro-expansion=2 is activated by default.
-fmacro-prefix-map=old=new
When preprocessing files residing in directory ‘old’, expand the __FILE__ and
__BASE_FILE__ macros as if the files resided in directory ‘new’ instead. This
can be used to change an absolute path to a relative path by using ‘.’ for
new which can result in more reproducible builds that are location indepen-
dent. This option also affects __builtin_FILE() during compilation. See also
‘-ffile-prefix-map’.
-fexec-charset=charset
Set the execution character set, used for string and character constants. The
default is UTF-8. charset can be any encoding supported by the system’s iconv
library routine.
-fwide-exec-charset=charset
Set the wide execution character set, used for wide string and character con-
stants. The default is UTF-32 or UTF-16, whichever corresponds to the width
of wchar_t. As with ‘-fexec-charset’, charset can be any encoding supported
by the system’s iconv library routine; however, you will have problems with
encodings that do not fit exactly in wchar_t.
-finput-charset=charset
Set the input character set, used for translation from the character set of the
input file to the source character set used by GCC. If the locale does not specify,
or GCC cannot get this information from the locale, the default is UTF-8. This
can be overridden by either the locale or this command-line option. Currently
the command-line option takes precedence if there’s a conflict. charset can be
any encoding supported by the system’s iconv library routine.
-fpch-deps
When using precompiled headers (see Section 3.22 [Precompiled Headers],
page 509), this flag causes the dependency-output flags to also list the
files from the precompiled header’s dependencies. If not specified, only the
precompiled header are listed and not the files that were used to create it,
because those files are not consulted when a precompiled header is used.
-fpch-preprocess
This option allows use of a precompiled header (see Section 3.22 [Precompiled
Headers], page 509) together with ‘-E’. It inserts a special #pragma, #pragma
GCC pch_preprocess "filename" in the output to mark the place where the
precompiled header was found, and its filename. When ‘-fpreprocessed’ is in
use, GCC recognizes this #pragma and loads the PCH.
This option is off by default, because the resulting preprocessed output is only
really suitable as input to GCC. It is switched on by ‘-save-temps’.
You should not write this #pragma in your own code, but it is safe to edit the
filename if the PCH file is available in a different location. The filename may
be absolute or it may be relative to GCC’s current directory.
Chapter 3: GCC Command Options 259
-fworking-directory
Enable generation of linemarkers in the preprocessor output that let the com-
piler know the current working directory at the time of preprocessing. When
this option is enabled, the preprocessor emits, after the initial linemarker, a
second linemarker with the current working directory followed by two slashes.
GCC uses this directory, when it’s present in the preprocessed input, as the di-
rectory emitted as the current working directory in some debugging information
formats. This option is implicitly enabled if debugging information is enabled,
but this can be inhibited with the negated form ‘-fno-working-directory’.
If the ‘-P’ flag is present in the command line, this option has no effect, since
no #line directives are emitted whatsoever.
-A predicate=answer
Make an assertion with the predicate predicate and answer answer. This form
is preferred to the older form ‘-A predicate(answer)’, which is still supported,
because it does not use shell special characters.
-A -predicate=answer
Cancel an assertion with the predicate predicate and answer answer.
-C Do not discard comments. All comments are passed through to the output file,
except for comments in processed directives, which are deleted along with the
directive.
You should be prepared for side effects when using ‘-C’; it causes the prepro-
cessor to treat comments as tokens in their own right. For example, comments
appearing at the start of what would be a directive line have the effect of turn-
ing that line into an ordinary source line, since the first token on the line is no
longer a ‘#’.
-CC Do not discard comments, including during macro expansion. This is like ‘-C’,
except that comments contained within macros are also passed through to the
output file where the macro is expanded.
In addition to the side effects of the ‘-C’ option, the ‘-CC’ option causes all
C++-style comments inside a macro to be converted to C-style comments. This
is to prevent later use of that macro from inadvertently commenting out the
remainder of the source line.
The ‘-CC’ option is generally used to support lint comments.
-P Inhibit generation of linemarkers in the output from the preprocessor. This
might be useful when running the preprocessor on something that is not C code,
and will be sent to a program which might be confused by the linemarkers.
-traditional
-traditional-cpp
Try to imitate the behavior of pre-standard C preprocessors, as opposed to ISO
C preprocessors. See the GNU CPP manual for details.
Note that GCC does not otherwise attempt to emulate a pre-standard C com-
piler, and these options are only supported with the ‘-E’ switch, or when in-
voking CPP explicitly.
260 Using the GNU Compiler Collection (GCC)
-trigraphs
Support ISO C trigraphs. These are three-character sequences, all starting with
‘??’, that are defined by ISO C to stand for single characters. For example, ‘??/’
stands for ‘\’, so ‘’??/n’’ is a character constant for a newline.
The nine trigraphs and their replacements are
Trigraph: ??( ??) ??< ??> ??= ??/ ??’ ??! ??-
Replacement: [ ] { } # \ ^ | ~
By default, GCC ignores trigraphs, but in standard-conforming modes it con-
verts them. See the ‘-std’ and ‘-ansi’ options.
-remap Enable special code to work around file systems which only permit very short
file names, such as MS-DOS.
-H Print the name of each header file used, in addition to other normal activities.
Each name is indented to show how deep in the ‘#include’ stack it is. Precom-
piled header files are also printed, even if they are found to be invalid; an invalid
precompiled header file is printed with ‘...x’ and a valid one with ‘...!’ .
-dletters
Says to make debugging dumps during compilation as specified by letters. The
flags documented here are those relevant to the preprocessor. Other letters
are interpreted by the compiler proper, or reserved for future versions of GCC,
and so are silently ignored. If you specify letters whose behavior conflicts, the
result is undefined. See Section 3.18 [Developer Options], page 281, for more
information.
-dM Instead of the normal output, generate a list of ‘#define’ directives
for all the macros defined during the execution of the preprocessor,
including predefined macros. This gives you a way of finding out
what is predefined in your version of the preprocessor. Assuming
you have no file ‘foo.h’, the command
touch foo.h; cpp -dM foo.h
shows all the predefined macros.
If you use ‘-dM’ without the ‘-E’ option, ‘-dM’ is interpreted as a
synonym for ‘-fdump-rtl-mach’. See Section “Developer Options”
in gcc.
-dD Like ‘-dM’ except in two respects: it does not include the predefined
macros, and it outputs both the ‘#define’ directives and the result
of preprocessing. Both kinds of output go to the standard output
file.
-dN Like ‘-dD’, but emit only the macro names, not their expansions.
-dI Output ‘#include’ directives in addition to the result of prepro-
cessing.
-dU Like ‘-dD’ except that only macros that are expanded, or whose de-
finedness is tested in preprocessor directives, are output; the output
is delayed until the use or test of the macro; and ‘#undef’ directives
are also output for macros tested but undefined at the time.
Chapter 3: GCC Command Options 261
-fdebug-cpp
This option is only useful for debugging GCC. When used from CPP or with
‘-E’, it dumps debugging information about location maps. Every token in the
output is preceded by the dump of the map its location belongs to.
When used from GCC without ‘-E’, this option has no effect.
-Wp,option
You can use ‘-Wp,option’ to bypass the compiler driver and pass option directly
through to the preprocessor. If option contains commas, it is split into multiple
options at the commas. However, many options are modified, translated or
interpreted by the compiler driver before being passed to the preprocessor,
and ‘-Wp’ forcibly bypasses this phase. The preprocessor’s direct interface is
undocumented and subject to change, so whenever possible you should avoid
using ‘-Wp’ and let the driver handle the options instead.
-Xpreprocessor option
Pass option as an option to the preprocessor. You can use this to supply
system-specific preprocessor options that GCC does not recognize.
If you want to pass an option that takes an argument, you must use
‘-Xpreprocessor’ twice, once for the option and once for the argument.
-no-integrated-cpp
Perform preprocessing as a separate pass before compilation. By default, GCC
performs preprocessing as an integrated part of input tokenization and parsing.
If this option is provided, the appropriate language front end (cc1, cc1plus,
or cc1obj for C, C++, and Objective-C, respectively) is instead invoked twice,
once for preprocessing only and once for actual compilation of the preprocessed
input. This option may be useful in conjunction with the ‘-B’ or ‘-wrapper’
options to specify an alternate preprocessor or perform additional processing of
the program source between normal preprocessing and compilation.
-flarge-source-files
Adjust GCC to expect large source files, at the expense of slower compilation
and higher memory usage.
Specifically, GCC normally tracks both column numbers and line numbers
within source files and it normally prints both of these numbers in diagnos-
tics. However, once it has processed a certain number of source lines, it stops
tracking column numbers and only tracks line numbers. This means that diag-
nostics for later lines do not include column numbers. It also means that op-
tions like ‘-Wmisleading-indentation’ cease to work at that point, although
the compiler prints a note if this happens. Passing ‘-flarge-source-files’
significantly increases the number of source lines that GCC can process before
it stops tracking columns.
-Wa,option
Pass option as an option to the assembler. If option contains commas, it is split
into multiple options at the commas.
-Xassembler option
Pass option as an option to the assembler. You can use this to supply system-
specific assembler options that GCC does not recognize.
If you want to pass an option that takes an argument, you must use
‘-Xassembler’ twice, once for the option and once for the argument.
Finally ‘nolto-rel’ configures the compiler for incremental linking where code
generation is forced, a final binary is produced, and the intermediate code for
later link-time optimization is stripped. When multiple object files are linked to-
gether the resulting code is better optimized than with link-time optimizations
disabled (for example, cross-module inlining happens), but most of benefits of
whole program optimizations are lost.
During the incremental link (by ‘-r’) the linker plugin defaults to ‘rel’. With
current interfaces to GNU Binutils it is however not possible to incrementally
link LTO objects and non-LTO objects into a single mixed object file. If any
of object files in incremental link cannot be used for link-time optimization,
the linker plugin issues a warning and uses ‘nolto-rel’. To maintain whole
program optimization, it is recommended to link such objects into static library
instead. Alternatively it is possible to use H.J. Lu’s binutils with support for
mixed objects.
-fuse-ld=bfd
Use the bfd linker instead of the default linker.
-fuse-ld=gold
Use the gold linker instead of the default linker.
-fuse-ld=lld
Use the LLVM lld linker instead of the default linker.
-fuse-ld=mold
Use the Modern Linker (mold) instead of the default linker.
-llibrary
-l library
Search the library named library when linking. (The second alternative with
the library as a separate argument is only for POSIX compliance and is not
recommended.)
The ‘-l’ option is passed directly to the linker by GCC. Refer to your linker
documentation for exact details. The general description below applies to the
GNU linker.
The linker searches a standard list of directories for the library. The directories
searched include several standard system directories plus any that you specify
with ‘-L’.
Static libraries are archives of object files, and have file names like
‘liblibrary.a’. Some targets also support shared libraries, which typically
have names like ‘liblibrary.so’. If both static and shared libraries are
found, the linker gives preference to linking with the shared library unless the
‘-static’ option is used.
It makes a difference where in the command you write this option; the linker
searches and processes libraries and object files in the order they are speci-
fied. Thus, ‘foo.o -lz bar.o’ searches library ‘z’ after file ‘foo.o’ but before
‘bar.o’. If ‘bar.o’ refers to functions in ‘z’, those functions may not be loaded.
-lobjc You need this special case of the ‘-l’ option in order to link an Objective-C or
Objective-C++ program.
264 Using the GNU Compiler Collection (GCC)
-nostartfiles
Do not use the standard system startup files when linking. The standard system
libraries are used normally, unless ‘-nostdlib’, ‘-nolibc’, or ‘-nodefaultlibs’
is used.
-nodefaultlibs
Do not use the standard system libraries when linking. Only the libraries you
specify are passed to the linker, and options specifying linkage of the system
libraries, such as ‘-static-libgcc’ or ‘-shared-libgcc’, are ignored. The
standard startup files are used normally, unless ‘-nostartfiles’ is used.
The compiler may generate calls to memcmp, memset, memcpy and memmove.
These entries are usually resolved by entries in libc. These entry points should
be supplied through some other mechanism when this option is specified.
-nolibc Do not use the C library or system libraries tightly coupled with it when link-
ing. Still link with the startup files, ‘libgcc’ or toolchain provided language
support libraries such as ‘libgnat’, ‘libgfortran’ or ‘libstdc++’ unless op-
tions preventing their inclusion are used as well. This typically removes ‘-lc’
from the link command line, as well as system libraries that normally go with it
and become meaningless when absence of a C library is assumed, for example
‘-lpthread’ or ‘-lm’ in some configurations. This is intended for bare-board
targets when there is indeed no C library available.
-nostdlib
Do not use the standard system startup files or libraries when linking. No
startup files and only the libraries you specify are passed to the linker, and
options specifying linkage of the system libraries, such as ‘-static-libgcc’ or
‘-shared-libgcc’, are ignored.
The compiler may generate calls to memcmp, memset, memcpy and memmove.
These entries are usually resolved by entries in libc. These entry points should
be supplied through some other mechanism when this option is specified.
One of the standard libraries bypassed by ‘-nostdlib’ and ‘-nodefaultlibs’
is ‘libgcc.a’, a library of internal subroutines which GCC uses to overcome
shortcomings of particular machines, or special needs for some languages. (See
Section “Interfacing to GCC Output” in GNU Compiler Collection (GCC) In-
ternals, for more discussion of ‘libgcc.a’.) In most cases, you need ‘libgcc.a’
even when you want to avoid other standard libraries. In other words, when you
specify ‘-nostdlib’ or ‘-nodefaultlibs’ you should usually specify ‘-lgcc’ as
well. This ensures that you have no unresolved references to internal GCC
library subroutines. (An example of such an internal subroutine is __main,
used to ensure C++ constructors are called; see Section “collect2” in GNU
Compiler Collection (GCC) Internals.)
-nostdlib++
Do not implicitly link with standard C++ libraries.
-e entry
--entry=entry
Specify that the program entry point is entry. The argument is interpreted by
the linker; the GNU linker accepts either a symbol name or an address.
Chapter 3: GCC Command Options 265
the ‘-static’ option is not used, then this links against the shared version of
‘libstdc++’. That is normally fine. However, it is sometimes useful to freeze
the version of ‘libstdc++’ used by the program without going all the way to
a fully static link. The ‘-static-libstdc++’ option directs the g++ driver to
link ‘libstdc++’ statically, without necessarily linking other libraries statically.
-symbolic
Bind references to global symbols when building a shared object. Warn about
any unresolved references (unless overridden by the link editor option ‘-Xlinker
-z -Xlinker defs’). Only a few systems support this option.
-T script Use script as the linker script. This option is supported by most systems using
the GNU linker. On some targets, such as bare-board targets without an oper-
ating system, the ‘-T’ option may be required when linking to avoid references
to undefined symbols.
-Xlinker option
Pass option as an option to the linker. You can use this to supply system-specific
linker options that GCC does not recognize.
If you want to pass an option that takes a separate argument, you must use
‘-Xlinker’ twice, once for the option and once for the argument. For example,
to pass ‘-assert definitions’, you must write ‘-Xlinker -assert -Xlinker
definitions’. It does not work to write ‘-Xlinker "-assert definitions"’,
because this passes the entire string as a single argument, which is not what
the linker expects.
When using the GNU linker, it is usually more convenient to pass arguments to
linker options using the ‘option=value’ syntax than as separate arguments. For
example, you can specify ‘-Xlinker -Map=output.map’ rather than ‘-Xlinker
-Map -Xlinker output.map’. Other linkers may not support this syntax for
command-line options.
-Wl,option
Pass option as an option to the linker. If option contains commas, it is split into
multiple options at the commas. You can use this syntax to pass an argument
to the option. For example, ‘-Wl,-Map,output.map’ passes ‘-Map output.map’
to the linker. When using the GNU linker, you can also get the same effect
with ‘-Wl,-Map=output.map’.
-u symbol Pretend the symbol symbol is undefined, to force linking of library modules
to define it. You can use ‘-u’ multiple times with different symbols to force
loading of additional library modules.
-z keyword
‘-z’ is passed directly on to the linker along with the keyword keyword. See
the section in the documentation of your linker for permitted values and their
meanings.
-I dir
-iquote dir
-isystem dir
-idirafter dir
Add the directory dir to the list of directories to be searched for header files dur-
ing preprocessing. If dir begins with ‘=’ or $SYSROOT, then the ‘=’ or $SYSROOT
is replaced by the sysroot prefix; see ‘--sysroot’ and ‘-isysroot’.
Directories specified with ‘-iquote’ apply only to the quote form of the
directive, #include "file". Directories specified with ‘-I’, ‘-isystem’,
or ‘-idirafter’ apply to lookup for both the #include "file" and
#include <file> directives.
You can specify any number or combination of these options on the command
line to search for header files in several directories. The lookup order is as
follows:
1. For the quote form of the include directive, the directory of the current file
is searched first.
2. For the quote form of the include directive, the directories specified by
‘-iquote’ options are searched in left-to-right order, as they appear on the
command line.
3. Directories specified with ‘-I’ options are scanned in left-to-right order.
4. Directories specified with ‘-isystem’ options are scanned in left-to-right
order.
5. Standard system directories are scanned.
6. Directories specified with ‘-idirafter’ options are scanned in left-to-right
order.
You can use ‘-I’ to override a system header file, substituting your own ver-
sion, since these directories are searched before the standard system header file
directories. However, you should not use this option to add directories that
contain vendor-supplied system header files; use ‘-isystem’ for that.
The ‘-isystem’ and ‘-idirafter’ options also mark the directory as a system
directory, so that it gets the same special treatment that is applied to the
standard system directories.
If a standard system include directory, or a directory specified with ‘-isystem’,
is also specified with ‘-I’, the ‘-I’ option is ignored. The directory is still
searched but as a system directory at its normal position in the system include
chain. This is to ensure that GCC’s procedure to fix buggy system headers and
the ordering for the #include_next directive are not inadvertently changed.
If you really need to change the search order for system directories, use the
‘-nostdinc’ and/or ‘-isystem’ options.
-I- Split the include path. This option has been deprecated. Please use ‘-iquote’
instead for ‘-I’ directories before the ‘-I-’ and remove the ‘-I-’ option.
Any directories specified with ‘-I’ options before ‘-I-’ are searched only
for headers requested with #include "file"; they are not searched for
Chapter 3: GCC Command Options 269
#include <file>. If additional directories are specified with ‘-I’ options after
the ‘-I-’, those directories are searched for all ‘#include’ directives.
In addition, ‘-I-’ inhibits the use of the directory of the current file directory
as the first search directory for #include "file". There is no way to override
this effect of ‘-I-’.
-iprefix prefix
Specify prefix as the prefix for subsequent ‘-iwithprefix’ options. If the prefix
represents a directory, you should include the final ‘/’.
-iwithprefix dir
-iwithprefixbefore dir
Append dir to the prefix specified previously with ‘-iprefix’, and add the
resulting directory to the include search path. ‘-iwithprefixbefore’ puts it
in the same place ‘-I’ would; ‘-iwithprefix’ puts it where ‘-idirafter’ would.
-isysroot dir
This option is like the ‘--sysroot’ option, but applies only to header files
(except for Darwin targets, where it applies to both header files and libraries).
See the ‘--sysroot’ option for more information.
-imultilib dir
Use dir as a subdirectory of the directory containing target-specific C++ headers.
-nostdinc
Do not search the standard system directories for header files. Only the directo-
ries explicitly specified with ‘-I’, ‘-iquote’, ‘-isystem’, and/or ‘-idirafter’
options (and the directory of the current file, if appropriate) are searched.
-nostdinc++
Do not search for header files in the C++-specific standard directories, but do
still search the other standard directories. (This option is used when building
the C++ library.)
-iplugindir=dir
Set the directory to search for plugins that are passed by ‘-fplugin=name’
instead of ‘-fplugin=path/name.so’. This option is not meant to be used by
the user, but only passed by the driver.
-Ldir Add directory dir to the list of directories to be searched for ‘-l’.
-Bprefix This option specifies where to find the executables, libraries, include files, and
data files of the compiler itself.
The compiler driver program runs one or more of the subprograms cpp, cc1,
as and ld. It tries prefix as a prefix for each program it tries to run, both
with and without ‘machine/version/’ for the corresponding target machine
and compiler version.
For each subprogram to be run, the compiler driver first tries the ‘-B’ prefix, if
any. If that name is not found, or if ‘-B’ is not specified, the driver tries two
standard prefixes, ‘/usr/lib/gcc/’ and ‘/usr/local/lib/gcc/’. If neither of
those results in a file name that is found, the unmodified program name is
searched for using the directories specified in your PATH environment variable.
270 Using the GNU Compiler Collection (GCC)
The compiler checks to see if the path provided by ‘-B’ refers to a directory,
and if necessary it adds a directory separator character at the end of the path.
‘-B’ prefixes that effectively specify directory names also apply to libraries in
the linker, because the compiler translates these options into ‘-L’ options for
the linker. They also apply to include files in the preprocessor, because the
compiler translates these options into ‘-isystem’ options for the preprocessor.
In this case, the compiler appends ‘include’ to the prefix.
The runtime support file ‘libgcc.a’ can also be searched for using the ‘-B’
prefix, if needed. If it is not found there, the two standard prefixes above are
tried, and that is all. The file is left out of the link if it is not found by those
means.
Another way to specify a prefix much like the ‘-B’ prefix is to use the envi-
ronment variable GCC_EXEC_PREFIX. See Section 3.21 [Environment Variables],
page 505.
As a special kludge, if the path provided by ‘-B’ is ‘[dir/]stageN/’, where N
is a number in the range 0 to 9, then it is replaced by ‘[dir/]include’. This
is to help with boot-strapping the compiler.
-no-canonical-prefixes
Do not expand any symbolic links, resolve references to ‘/../’ or ‘/./’, or make
the path absolute when generating a relative prefix.
--sysroot=dir
Use dir as the logical root directory for headers and libraries. For example, if
the compiler normally searches for headers in ‘/usr/include’ and libraries in
‘/usr/lib’, it instead searches ‘dir/usr/include’ and ‘dir/usr/lib’.
If you use both this option and the ‘-isysroot’ option, then the ‘--sysroot’
option applies to libraries, but the ‘-isysroot’ option applies to header files.
The GNU linker (beginning with version 2.16) has the necessary support for
this option. If your linker does not support this option, the header file aspect
of ‘--sysroot’ still works, but the library aspect does not.
--no-sysroot-suffix
For some targets, a suffix is added to the root directory specified with
‘--sysroot’, depending on the other options used, so that headers may for ex-
ample be found in ‘dir/suffix/usr/include’ instead of ‘dir/usr/include’.
This option disables the addition of such a suffix.
or ‘none’. ‘all’ enables stack reuse for all local variables and temporaries,
‘named_vars’ enables the reuse only for user defined local variables with names,
and ‘none’ disables stack reuse completely. The default value is ‘all’. The op-
tion is needed when the program extends the lifetime of a scoped local variable
or a compiler generated temporary beyond the end point defined by the lan-
guage. When a lifetime of a variable ends, and if the variable lives in memory,
the optimizing compiler has the freedom to reuse its stack space with other
temporaries or scoped local variables whose live range does not overlap with
it. Legacy code extending local lifetime is likely to break with the stack reuse
optimization.
For example,
int *p;
{
int local1;
p = &local1;
local1 = 10;
....
}
{
int local2;
local2 = 20;
...
}
}
Another example:
struct A
{
A(int k) : i(k), j(k) { }
int i;
int j;
};
A *ap;
void bar()
{
foo(A(10)); // temp object’s lifetime ends when foo returns
{
A a(20);
....
}
ap->i+= 10; // ap references out of scope temp whose space
// is reused with a. What is the value of ap->i?
272 Using the GNU Compiler Collection (GCC)
-fverbose-asm
Put extra commentary information in the generated assembly code to make it
more readable. This option is generally only of use to those who actually need
to read the generated assembly code (perhaps while debugging the compiler
itself).
‘-fno-verbose-asm’, the default, causes the extra information to be omitted
and is useful when comparing two assembler files.
The added comments include:
• information on the compiler version and command-line options,
• the source code lines associated with the assembly instructions, in the form
FILENAME:LINENUMBER:CONTENT OF LINE,
• hints on which high-level expressions correspond to the various assembly
instruction operands.
For example, given this C source file:
int test (int n)
{
int i;
int total = 0;
return total;
}
compiling to (x86 64) assembly via ‘-S’ and emitting the result direct to stdout
via ‘-o’ ‘-’
gcc -S test.c -fverbose-asm -Os -o -
gives output similar to this:
.file "test.c"
# GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
[...snip...]
# options passed:
[...snip...]
.text
.globl test
.type test, @function
test:
.LFB0:
.cfi_startproc
# test.c:4: int total = 0;
xorl %eax, %eax # <retval>
# test.c:6: for (i = 0; i < n; i++)
xorl %edx, %edx # i
.L2:
# test.c:6: for (i = 0; i < n; i++)
cmpl %edi, %edx # n, i
jge .L5 #,
# test.c:7: total += i * i;
movl %edx, %ecx # i, tmp92
imull %edx, %ecx # i, tmp92
276 Using the GNU Compiler Collection (GCC)
‘-fpie’ and ‘-fPIE’ both define the macros __pie__ and __PIE__. The macros
have the value 1 for ‘-fpie’ and 2 for ‘-fPIE’.
-fno-plt Do not use the PLT for external function calls in position-independent code.
Instead, load the callee address at call sites from the GOT and branch to it.
This leads to more efficient code by eliminating PLT stubs and exposing GOT
loads to optimizations. On architectures such as 32-bit x86 where PLT stubs
expect the GOT pointer in a specific register, this gives more register allocation
freedom to the compiler. Lazy binding requires use of the PLT; with ‘-fno-plt’
all external symbols are resolved at load time.
Alternatively, the function attribute noplt can be used to avoid calls through
the PLT for specific external functions.
In position-dependent code, a few targets also convert calls to functions that
are marked to not use the PLT to use the GOT instead.
-fno-jump-tables
Do not use jump tables for switch statements even where it would be more effi-
cient than other code generation strategies. This option is of use in conjunction
with ‘-fpic’ or ‘-fPIC’ for building code that forms part of a dynamic linker
and cannot reference the address of a jump table. On some targets, jump tables
do not require a GOT and this option is not needed.
-fno-bit-tests
Do not use bit tests for switch statements even where it would be more efficient
than other code generation strategies.
-ffixed-reg
Treat the register named reg as a fixed register; generated code should never
refer to it (except perhaps as a stack pointer, frame pointer or in some other
fixed role).
reg must be the name of a register. The register names accepted are machine-
specific and are defined in the REGISTER_NAMES macro in the machine descrip-
tion macro file.
This flag does not have a negative form, because it specifies a three-way choice.
-fcall-used-reg
Treat the register named reg as an allocable register that is clobbered by func-
tion calls. It may be allocated for temporaries or variables that do not live
across a call. Functions compiled this way do not save and restore the register
reg.
It is an error to use this flag with the frame pointer or stack pointer. Use of this
flag for other registers that have fixed pervasive roles in the machine’s execution
model produces disastrous results.
This flag does not have a negative form, because it specifies a three-way choice.
-fcall-saved-reg
Treat the register named reg as an allocable register saved by functions. It may
be allocated even for temporaries or variables that live across a call. Functions
compiled this way save and restore the register reg if they use it.
278 Using the GNU Compiler Collection (GCC)
It is an error to use this flag with the frame pointer or stack pointer. Use of this
flag for other registers that have fixed pervasive roles in the machine’s execution
model produces disastrous results.
A different sort of disaster results from the use of this flag for a register in which
function values may be returned.
This flag does not have a negative form, because it specifies a three-way choice.
-fpack-struct[=n]
Without a value specified, pack all structure members together without holes.
When a value is specified (which must be a small power of two), pack structure
members according to this value, representing the maximum alignment (that
is, objects with default alignment requirements larger than this are output
potentially unaligned at the next fitting location.
Warning: the ‘-fpack-struct’ switch causes GCC to generate code that is
not binary compatible with code generated without that switch. Additionally,
it makes the code suboptimal. Use it to conform to a non-default application
binary interface.
-fleading-underscore
This option and its counterpart, ‘-fno-leading-underscore’, forcibly change
the way C symbols are represented in the object file. One use is to help link
with legacy assembly code.
Warning: the ‘-fleading-underscore’ switch causes GCC to generate code
that is not binary compatible with code generated without that switch. Use it
to conform to a non-default application binary interface. Not all targets provide
complete support for this switch.
-ftls-model=model
Alter the thread-local storage model to be used (see Section 6.64 [Thread-
Local], page 882). The model argument should be one of ‘global-dynamic’,
‘local-dynamic’, ‘initial-exec’ or ‘local-exec’. Note that the choice is
subject to optimization: the compiler may use a more efficient model for sym-
bols not visible outside of the translation unit, or if ‘-fpic’ is not given on the
command line.
The default without ‘-fpic’ is ‘initial-exec’; with ‘-fpic’ the default is
‘global-dynamic’.
-ftrampolines
For targets that normally need trampolines for nested functions, always gener-
ate them instead of using descriptors. Otherwise, for targets that do not need
them, like for example HP-PA or IA-64, do nothing.
A trampoline is a small piece of code that is created at run time on the stack
when the address of a nested function is taken, and is used to call the nested
function indirectly. Therefore, it requires the stack to be made executable in
order for the program to work properly.
‘-fno-trampolines’ is enabled by default on a language by language basis
to let the compiler avoid generating them, if it computes that this is safe,
and replace them with descriptors. Descriptors are made up of data only, but
Chapter 3: GCC Command Options 279
the generated code must be prepared to deal with them. As of this writing,
‘-fno-trampolines’ is enabled by default only for Ada.
Moreover, code compiled with ‘-ftrampolines’ and code compiled with
‘-fno-trampolines’ are not binary compatible if nested functions are
present. This option must therefore be used on a program-wide basis and be
manipulated with extreme care.
For languages other than Ada, the -ftrampolines and -fno-trampolines op-
tions currently have no effect, and trampolines are always generated on plat-
forms that need them for nested functions.
-fvisibility=[default|internal|hidden|protected]
Set the default ELF image symbol visibility to the specified option—all symbols
are marked with this unless overridden within the code. Using this feature can
very substantially improve linking and load times of shared object libraries,
produce more optimized code, provide near-perfect API export and prevent
symbol clashes. It is strongly recommended that you use this in any shared
objects you distribute.
Despite the nomenclature, ‘default’ always means public; i.e., available to be
linked against from outside the shared object. ‘protected’ and ‘internal’ are
pretty useless in real-world usage so the only other commonly used option is
‘hidden’. The default if ‘-fvisibility’ isn’t specified is ‘default’, i.e., make
every symbol public.
A good explanation of the benefits offered by ensuring ELF symbols have
the correct visibility is given by “How To Write Shared Libraries” by Ulrich
Drepper (which can be found at https://www.akkadia.org/drepper/)—
however a superior solution made possible by this option to marking things
hidden when the default is public is to make the default hidden and
mark things public. This is the norm with DLLs on Windows and with
‘-fvisibility=hidden’ and __attribute__ ((visibility("default")))
instead of __declspec(dllexport) you get almost identical semantics with
identical syntax. This is a great boon to those working with cross-platform
projects.
For those adding visibility support to existing code, you may find #pragma GCC
visibility of use. This works by you enclosing the declarations you wish
to set visibility for with (for example) #pragma GCC visibility push(hidden)
and #pragma GCC visibility pop. Bear in mind that symbol visibility should
be viewed as part of the API interface contract and thus all new code should
always specify visibility when it is not the default; i.e., declarations only for
use within the local DSO should always be marked explicitly as hidden as so
to avoid PLT indirection overheads—making this abundantly clear also aids
readability and self-documentation of the code. Note that due to ISO C++
specification requirements, operator new and operator delete must always
be of default visibility.
Be aware that headers from outside your project, in particular system head-
ers and headers from any other library you use, may not be expecting to be
280 Using the GNU Compiler Collection (GCC)
compiled with visibility other than the default. You may need to explicitly say
#pragma GCC visibility push(default) before including any such headers.
extern declarations are not affected by ‘-fvisibility’, so a lot of code can be
recompiled with ‘-fvisibility=hidden’ with no modifications. However, this
means that calls to extern functions with no explicit visibility use the PLT, so
it is more effective to use __attribute ((visibility)) and/or #pragma GCC
visibility to tell the compiler which extern declarations should be treated
as hidden.
Note that ‘-fvisibility’ does affect C++ vague linkage entities. This means
that, for instance, an exception class that is be thrown between DSOs must
be explicitly marked with default visibility so that the ‘type_info’ nodes are
unified between the DSOs.
An overview of these techniques, their benefits and how to use them is at
https://gcc.gnu.org/wiki/Visibility.
-fstrict-volatile-bitfields
This option should be used if accesses to volatile bit-fields (or other structure
fields, although the compiler usually honors those types anyway) should use a
single access of the width of the field’s type, aligned to a natural alignment if
possible. For example, targets with memory-mapped peripheral registers might
require all such accesses to be 16 bits wide; with this flag you can declare
all peripheral bit-fields as unsigned short (assuming short is 16 bits on these
targets) to force GCC to use 16-bit accesses instead of, perhaps, a more efficient
32-bit access.
If this option is disabled, the compiler uses the most efficient instruction. In
the previous example, that might be a 32-bit load instruction, even though
that accesses bytes that do not contain any portion of the bit-field, or memory-
mapped registers unrelated to the one being updated.
In some cases, such as when the packed attribute is applied to a structure
field, it may not be possible to access the field with a single read or write that
is correctly aligned for the target machine. In this case GCC falls back to
generating multiple accesses rather than code that will fault or truncate the
result at run time.
Note: Due to restrictions of the C/C++11 memory model, write accesses are not
allowed to touch non bit-field members. It is therefore recommended to define
all bits of the field’s type as bit-field members.
The default value of this option is determined by the application binary interface
for the target processor.
-fsync-libcalls
This option controls whether any out-of-line instance of the __sync family of
functions may be used to implement the C++11 __atomic family of functions.
The default value of this option is enabled, thus the only useful form of the
option is ‘-fno-sync-libcalls’. This option is used in the implementation of
the ‘libatomic’ runtime library.
Chapter 3: GCC Command Options 281
-fdump-rtl-alignments
Dump after branch alignments have been computed.
-fdump-rtl-asmcons
Dump after fixing rtl statements that have unsatisfied in/out con-
straints.
-fdump-rtl-auto_inc_dec
Dump after auto-inc-dec discovery. This pass is only run on archi-
tectures that have auto inc or auto dec instructions.
-fdump-rtl-barriers
Dump after cleaning up the barrier instructions.
-fdump-rtl-bbpart
Dump after partitioning hot and cold basic blocks.
-fdump-rtl-bbro
Dump after block reordering.
-fdump-rtl-btl1
-fdump-rtl-btl2
‘-fdump-rtl-btl1’ and ‘-fdump-rtl-btl2’ enable dumping after
the two branch target load optimization passes.
-fdump-rtl-bypass
Dump after jump bypassing and control flow optimizations.
-fdump-rtl-combine
Dump after the RTL instruction combination pass.
-fdump-rtl-compgotos
Dump after duplicating the computed gotos.
-fdump-rtl-ce1
-fdump-rtl-ce2
-fdump-rtl-ce3
‘-fdump-rtl-ce1’, ‘-fdump-rtl-ce2’, and ‘-fdump-rtl-ce3’ en-
able dumping after the three if conversion passes.
-fdump-rtl-cprop_hardreg
Dump after hard register copy propagation.
-fdump-rtl-csa
Dump after combining stack adjustments.
-fdump-rtl-cse1
-fdump-rtl-cse2
‘-fdump-rtl-cse1’ and ‘-fdump-rtl-cse2’ enable dumping after
the two common subexpression elimination passes.
-fdump-rtl-dce
Dump after the standalone dead code elimination passes.
-fdump-rtl-dbr
Dump after delayed branch scheduling.
Chapter 3: GCC Command Options 283
-fdump-rtl-dce1
-fdump-rtl-dce2
‘-fdump-rtl-dce1’ and ‘-fdump-rtl-dce2’ enable dumping after
the two dead store elimination passes.
-fdump-rtl-eh
Dump after finalization of EH handling code.
-fdump-rtl-eh_ranges
Dump after conversion of EH handling range regions.
-fdump-rtl-expand
Dump after RTL generation.
-fdump-rtl-fwprop1
-fdump-rtl-fwprop2
‘-fdump-rtl-fwprop1’ and ‘-fdump-rtl-fwprop2’ enable dump-
ing after the two forward propagation passes.
-fdump-rtl-gcse1
-fdump-rtl-gcse2
‘-fdump-rtl-gcse1’ and ‘-fdump-rtl-gcse2’ enable dumping af-
ter global common subexpression elimination.
-fdump-rtl-init-regs
Dump after the initialization of the registers.
-fdump-rtl-initvals
Dump after the computation of the initial value sets.
-fdump-rtl-into_cfglayout
Dump after converting to cfglayout mode.
-fdump-rtl-ira
Dump after iterated register allocation.
-fdump-rtl-jump
Dump after the second jump optimization.
-fdump-rtl-loop2
‘-fdump-rtl-loop2’ enables dumping after the rtl loop optimiza-
tion passes.
-fdump-rtl-mach
Dump after performing the machine dependent reorganization pass,
if that pass exists.
-fdump-rtl-mode_sw
Dump after removing redundant mode switches.
-fdump-rtl-rnreg
Dump after register renumbering.
-fdump-rtl-outof_cfglayout
Dump after converting from cfglayout mode.
284 Using the GNU Compiler Collection (GCC)
-fdump-rtl-peephole2
Dump after the peephole pass.
-fdump-rtl-postreload
Dump after post-reload optimizations.
-fdump-rtl-pro_and_epilogue
Dump after generating the function prologues and epilogues.
-fdump-rtl-sched1
-fdump-rtl-sched2
‘-fdump-rtl-sched1’ and ‘-fdump-rtl-sched2’ enable dumping
after the basic block scheduling passes.
-fdump-rtl-ree
Dump after sign/zero extension elimination.
-fdump-rtl-seqabstr
Dump after common sequence discovery.
-fdump-rtl-shorten
Dump after shortening branches.
-fdump-rtl-sibling
Dump after sibling call optimizations.
-fdump-rtl-split1
-fdump-rtl-split2
-fdump-rtl-split3
-fdump-rtl-split4
-fdump-rtl-split5
These options enable dumping after five rounds of instruction split-
ting.
-fdump-rtl-sms
Dump after modulo scheduling. This pass is only run on some
architectures.
-fdump-rtl-stack
Dump after conversion from GCC’s “flat register file” registers to
the x87’s stack-like registers. This pass is only run on x86 variants.
-fdump-rtl-subreg1
-fdump-rtl-subreg2
‘-fdump-rtl-subreg1’ and ‘-fdump-rtl-subreg2’ enable dump-
ing after the two subreg expansion passes.
-fdump-rtl-unshare
Dump after all rtl has been unshared.
-fdump-rtl-vartrack
Dump after variable tracking.
-fdump-rtl-vregs
Dump after converting virtual registers to hard registers.
Chapter 3: GCC Command Options 285
-fdump-rtl-web
Dump after live range splitting.
-fdump-rtl-regclass
-fdump-rtl-subregs_of_mode_init
-fdump-rtl-subregs_of_mode_finish
-fdump-rtl-dfinit
-fdump-rtl-dfinish
These dumps are defined but always produce empty files.
-da
-fdump-rtl-all
Produce all the dumps listed above.
-dA Annotate the assembler output with miscellaneous debugging in-
formation.
-dD Dump all macro definitions, at the end of preprocessing, in addition
to normal output.
-dH Produce a core dump whenever an error occurs.
-dp Annotate the assembler output with a comment indicating which
pattern and alternative is used. The length and cost of each in-
struction are also printed.
-dP Dump the RTL in the assembler output as a comment before each
instruction. Also turns on ‘-dp’ annotation.
-dx Just generate RTL for a function instead of compiling it. Usually
used with ‘-fdump-rtl-expand’.
-fdump-debug
Dump debugging information generated during the debug generation phase.
-fdump-earlydebug
Dump debugging information generated during the early debug generation
phase.
-fdump-noaddr
When doing debugging dumps, suppress address output. This makes it more
feasible to use diff on debugging dumps for compiler invocations with different
compiler binaries and/or different text / bss / data / heap / stack / dso start
locations.
-freport-bug
Collect and dump debug information into a temporary file if an internal compiler
error (ICE) occurs.
-fdump-unnumbered
When doing debugging dumps, suppress instruction numbers and address out-
put. This makes it more feasible to use diff on debugging dumps for compiler
invocations with different options, in particular with and without ‘-g’.
286 Using the GNU Compiler Collection (GCC)
-fdump-unnumbered-links
When doing debugging dumps (see ‘-d’ option above), suppress instruction
numbers for the links to the previous and next instructions in a sequence.
-fdump-ipa-switch
-fdump-ipa-switch-options
Control the dumping at various stages of inter-procedural analysis language tree
to a file. The file name is generated by appending a switch specific suffix to the
source file name, and the file is created in the same directory as the output file.
The following dumps are possible:
‘all’ Enables all inter-procedural analysis dumps.
‘cgraph’ Dumps information about call-graph optimization, unused function
removal, and inlining decisions.
‘inline’ Dump after function inlining.
Additionally, the options ‘-optimized’, ‘-missed’, ‘-note’, and ‘-all’ can
be provided, with the same meaning as for ‘-fopt-info’, defaulting to
‘-optimized’.
For example, ‘-fdump-ipa-inline-optimized-missed’ will emit information
on callsites that were inlined, along with callsites that were not inlined.
By default, the dump will contain messages about successful optimizations
(equivalent to ‘-optimized’) together with low-level details about the analysis.
-fdump-lang
Dump language-specific information. The file name is made by appending
‘.lang’ to the source file name.
-fdump-lang-all
-fdump-lang-switch
-fdump-lang-switch-options
-fdump-lang-switch-options=filename
Control the dumping of language-specific information. The options and file-
name portions behave as described in the ‘-fdump-tree’ option. The following
switch values are accepted:
‘all’
Enable all language-specific dumps.
‘class’ Dump class hierarchy information. Virtual table information is
emitted unless ’‘slim’’ is specified. This option is applicable to
C++ only.
‘module’ Dump module information. Options ‘lineno’ (locations), ‘graph’
(reachability), ‘blocks’ (clusters), ‘uid’ (serialization), ‘alias’
(mergeable), ‘asmname’ (Elrond), ‘eh’ (mapper) & ‘vops’ (macros)
may provide additional information. This option is applicable to
C++ only.
‘raw’ Dump the raw internal tree data. This option is applicable to C++
only.
Chapter 3: GCC Command Options 287
-fdump-passes
Print on ‘stderr’ the list of optimization passes that are turned on and off by
the current command-line options.
-fdump-statistics-option
Enable and control dumping of pass statistics in a separate file. The file name
is generated by appending a suffix ending in ‘.statistics’ to the source file
name, and the file is created in the same directory as the output file. If the
‘-option’ form is used, ‘-stats’ causes counters to be summed over the whole
compilation unit while ‘-details’ dumps every event as the passes generate
them. The default with no option is to sum counters for each function compiled.
-fdump-tree-all
-fdump-tree-switch
-fdump-tree-switch-options
-fdump-tree-switch-options=filename
Control the dumping at various stages of processing the intermediate language
tree to a file. If the ‘-options’ form is used, options is a list of ‘-’ separated
options which control the details of the dump. Not all options are applicable
to all dumps; those that are not meaningful are ignored. The following options
are available
‘address’ Print the address of each node. Usually this is not meaningful as it
changes according to the environment and source file. Its primary
use is for tying up a dump file with a debug environment.
‘asmname’ If DECL_ASSEMBLER_NAME has been set for a given decl, use that
in the dump instead of DECL_NAME. Its primary use is ease of use
working backward from mangled names in the assembly file.
‘slim’ When dumping front-end intermediate representations, inhibit
dumping of members of a scope or body of a function merely
because that scope has been reached. Only dump such items when
they are directly reachable by some other path.
When dumping pretty-printed trees, this option inhibits dumping
the bodies of control structures.
When dumping RTL, print the RTL in slim (condensed) form in-
stead of the default LISP-like representation.
‘raw’ Print a raw representation of the tree. By default, trees are pretty-
printed into a C-like representation.
‘details’ Enable more detailed dumps (not honored by every dump option).
Also include information from the optimization passes.
‘stats’ Enable dumping various statistics about the pass (not honored by
every dump option).
‘blocks’ Enable showing basic block boundaries (disabled in raw dumps).
‘graph’ For each of the other indicated dump files (‘-fdump-rtl-pass’),
dump a representation of the control flow graph suitable for viewing
288 Using the GNU Compiler Collection (GCC)
-fopt-info
-fopt-info-options
-fopt-info-options=filename
Controls optimization dumps from various optimization passes. If the
‘-options’ form is used, options is a list of ‘-’ separated option keywords to
select the dump details and optimizations.
The options can be divided into three groups:
1. options describing what kinds of messages should be emitted,
2. options describing the verbosity of the dump, and
3. options describing which optimizations should be included.
The options from each group can be freely mixed as they are non-overlapping.
However, in case of any conflicts, the later options override the earlier options
on the command line.
The following options control which kinds of messages should be emitted:
‘optimized’
Print information when an optimization is successfully applied. It
is up to a pass to decide which information is relevant. For example,
the vectorizer passes print the source location of loops which are
successfully vectorized.
‘missed’ Print information about missed optimizations. Individual passes
control which information to include in the output.
‘note’ Print verbose information about optimizations, such as certain
transformations, more detailed messages about decisions etc.
‘all’ Print detailed optimization information. This includes
‘optimized’, ‘missed’, and ‘note’.
The following option controls the dump verbosity:
‘internals’
By default, only “high-level” messages are emitted. This option
enables additional, more detailed, messages, which are likely to
only be of interest to GCC developers.
One or more of the following option keywords can be used to describe a group
of optimizations:
‘ipa’ Enable dumps from all interprocedural optimizations.
‘loop’ Enable dumps from all loop optimizations.
‘inline’ Enable dumps from all inlining optimizations.
‘omp’ Enable dumps from all OMP (Offloading and Multi Processing)
optimizations.
‘vec’ Enable dumps from all vectorization optimizations.
‘optall’ Enable dumps from all optimizations. This is a superset of the
optimization groups listed above.
290 Using the GNU Compiler Collection (GCC)
Additionally, some messages are logically nested within other messages, reflect-
ing implementation details of the optimization passes.
-fsched-verbose=n
On targets that use instruction scheduling, this option controls the amount of
debugging output the scheduler prints to the dump files.
For n greater than zero, ‘-fsched-verbose’ outputs the same information as
‘-fdump-rtl-sched1’ and ‘-fdump-rtl-sched2’. For n greater than one, it also
output basic block probabilities, detailed ready list information and unit/insn
info. For n greater than two, it includes RTL at abort point, control-flow and
regions info. And for n over four, ‘-fsched-verbose’ also includes dependence
info.
-fenable-kind-pass
-fdisable-kind-pass=range-list
This is a set of options that are used to explicitly disable/enable optimization
passes. These options are intended for use for debugging GCC. Compiler users
should use regular options for enabling/disabling passes instead.
-fdisable-ipa-pass
Disable IPA pass pass. pass is the pass name. If the same pass
is statically invoked in the compiler multiple times, the pass name
should be appended with a sequential number starting from 1.
-fdisable-rtl-pass
-fdisable-rtl-pass=range-list
Disable RTL pass pass. pass is the pass name. If the same pass is
statically invoked in the compiler multiple times, the pass name
should be appended with a sequential number starting from 1.
range-list is a comma-separated list of function ranges or assem-
bler names. Each range is a number pair separated by a colon.
The range is inclusive in both ends. If the range is trivial, the
number pair can be simplified as a single number. If the function’s
call graph node’s uid falls within one of the specified ranges, the
pass is disabled for that function. The uid is shown in the function
header of a dump file, and the pass names can be dumped by using
option ‘-fdump-passes’.
292 Using the GNU Compiler Collection (GCC)
-fdisable-tree-pass
-fdisable-tree-pass=range-list
Disable tree pass pass. See ‘-fdisable-rtl’ for the description of
option arguments.
-fenable-ipa-pass
Enable IPA pass pass. pass is the pass name. If the same pass
is statically invoked in the compiler multiple times, the pass name
should be appended with a sequential number starting from 1.
-fenable-rtl-pass
-fenable-rtl-pass=range-list
Enable RTL pass pass. See ‘-fdisable-rtl’ for option argument
description and examples.
-fenable-tree-pass
-fenable-tree-pass=range-list
Enable tree pass pass. See ‘-fdisable-rtl’ for the description of
option arguments.
Here are some examples showing uses of these options.
-fchecking
-fchecking=n
Enable internal consistency checking. The default depends on the compiler
configuration. ‘-fchecking=2’ enables further internal consistency checking
that might affect code generation.
-frandom-seed=string
This option provides a seed that GCC uses in place of random numbers in
generating certain symbol names that have to be different in every compiled
file. It is also used to place unique stamps in coverage data files and the object
files that produce them. You can use the ‘-frandom-seed’ option to produce
reproducibly identical object files.
The string can either be a number (decimal, octal or hex) or an arbitrary string
(in which case it’s converted to a number by computing CRC32).
The string should be different for every file you compile.
Chapter 3: GCC Command Options 293
-save-temps
Store the usual “temporary” intermediate files permanently; name them as
auxiliary output files, as specified described under ‘-dumpbase’ and ‘-dumpdir’.
When used in combination with the ‘-x’ command-line option, ‘-save-temps’ is
sensible enough to avoid overwriting an input source file with the same extension
as an intermediate file. The corresponding intermediate file may be obtained
by renaming the source file before using ‘-save-temps’.
-save-temps=cwd
Equivalent to ‘-save-temps -dumpdir ./’.
-save-temps=obj
Equivalent to ‘-save-temps -dumpdir ‘outdir/’’, where ‘outdir/’ is the di-
rectory of the output file specified after the ‘-o’ option, including any directory
separators. If the ‘-o’ option is not used, the ‘-save-temps=obj’ switch behaves
like ‘-save-temps=cwd’.
-time[=file]
Report the CPU time taken by each subprocess in the compilation sequence.
For C source files, this is the compiler proper and assembler (plus the linker if
linking is done).
Without the specification of an output file, the output looks like this:
# cc1 0.12 0.01
# as 0.00 0.01
The first number on each line is the “user time”, that is time spent executing
the program itself. The second number is “system time”, time spent executing
operating system routines on behalf of the program. Both numbers are in
seconds.
With the specification of an output file, the output is appended to the named
file, and it looks like this:
0.12 0.01 cc1 options
0.00 0.01 as options
The “user time” and the “system time” are moved before the program name,
and the options passed to the program are displayed, so that one can later tell
what file was being compiled, and with which options.
-fdump-final-insns[=file]
Dump the final internal representation (RTL) to file. If the optional argument
is omitted (or if file is .), the name of the dump file is determined by appending
.gkd to the dump base name, see ‘-dumpbase’.
-fcompare-debug[=opts]
If no error occurs during compilation, run the compiler a second time, adding
opts and ‘-fcompare-debug-second’ to the arguments passed to the second
compilation. Dump the final internal representation in both compilations, and
print an error if they differ.
If the equal sign is omitted, the default ‘-gtoggle’ is used.
The environment variable GCC_COMPARE_DEBUG, if defined, non-empty and
nonzero, implicitly enables ‘-fcompare-debug’. If GCC_COMPARE_DEBUG is
294 Using the GNU Compiler Collection (GCC)
defined to a string starting with a dash, then it is used for opts, otherwise the
default ‘-gtoggle’ is used.
‘-fcompare-debug=’, with the equal sign but without opts, is equivalent to
‘-fno-compare-debug’, which disables the dumping of the final representation
and the second compilation, preventing even GCC_COMPARE_DEBUG from taking
effect.
To verify full coverage during ‘-fcompare-debug’ testing, set GCC_COMPARE_
DEBUG to say ‘-fcompare-debug-not-overridden’, which GCC rejects as
an invalid option in any actual compilation (rather than preprocessing,
assembly or linking). To get just a warning, setting GCC_COMPARE_DEBUG to
‘-w%n-fcompare-debug not overridden’ will do.
-fcompare-debug-second
This option is implicitly passed to the compiler for the second compilation
requested by ‘-fcompare-debug’, along with options to silence warnings, and
omitting other options that would cause the compiler to produce output to files
or to standard output as a side effect. Dump files and preserved temporary files
are renamed so as to contain the .gk additional extension during the second
compilation, to avoid overwriting those generated by the first.
When this option is passed to the compiler driver, it causes the first compilation
to be skipped, which makes it useful for little other than debugging the compiler
proper.
-gtoggle Turn off generation of debug info, if leaving out this option generates it, or turn
it on at level 2 otherwise. The position of this argument in the command line
does not matter; it takes effect after all other options are processed, and it does
so only once, no matter how many times it is given. This is mainly intended to
be used with ‘-fcompare-debug’.
-fvar-tracking-assignments-toggle
Toggle ‘-fvar-tracking-assignments’, in the same way that ‘-gtoggle’ tog-
gles ‘-g’.
-Q Makes the compiler print out each function name as it is compiled, and print
some statistics about each pass when it finishes.
-ftime-report
Makes the compiler print some statistics about the time consumed by each pass
when it finishes.
-ftime-report-details
Record the time consumed by infrastructure parts separately for each pass.
-fira-verbose=n
Control the verbosity of the dump file for the integrated register allocator. The
default value is 5. If the value n is greater or equal to 10, the dump output is
sent to stderr using the same format as n minus 10.
-flto-report
Prints a report with internal details on the workings of the link-time optimizer.
The contents of this report vary from version to version. It is meant to be useful
to GCC developers when processing object files in LTO mode (via ‘-flto’).
Chapter 3: GCC Command Options 295
Disabled by default.
-flto-report-wpa
Like ‘-flto-report’, but only print for the WPA phase of link-time optimiza-
tion.
-fmem-report
Makes the compiler print some statistics about permanent memory allocation
when it finishes.
-fmem-report-wpa
Makes the compiler print some statistics about permanent memory allocation
for the WPA phase only.
-fpre-ipa-mem-report
-fpost-ipa-mem-report
Makes the compiler print some statistics about permanent memory allocation
before or after interprocedural optimization.
-fprofile-report
Makes the compiler print some statistics about consistency of the (estimated)
profile and effect of individual passes.
-fstack-usage
Makes the compiler output stack usage information for the program, on a per-
function basis. The filename for the dump is made by appending ‘.su’ to the
auxname. auxname is generated from the name of the output file, if explicitly
specified and it is not an executable, otherwise it is the basename of the source
file. An entry is made up of three fields:
• The name of the function.
• A number of bytes.
• One or more qualifiers: static, dynamic, bounded.
The qualifier static means that the function manipulates the stack statically: a
fixed number of bytes are allocated for the frame on function entry and released
on function exit; no stack adjustments are otherwise made in the function. The
second field is this fixed number of bytes.
The qualifier dynamic means that the function manipulates the stack dynami-
cally: in addition to the static allocation described above, stack adjustments are
made in the body of the function, for example to push/pop arguments around
function calls. If the qualifier bounded is also present, the amount of these ad-
justments is bounded at compile time and the second field is an upper bound of
the total amount of stack used by the function. If it is not present, the amount
of these adjustments is not bounded at compile time and the second field only
represents the bounded part.
-fstats Emit statistics about front-end processing at the end of the compilation. This
option is supported only by the C++ front end, and the information is generally
only useful to the G++ development team.
-fdbg-cnt-list
Print the name and the counter upper bound for all debug counters.
296 Using the GNU Compiler Collection (GCC)
-fdbg-cnt=counter-value-list
Set the internal debug counter lower and upper bound. counter-value-list is
a comma-separated list of name:lower bound1-upper bound1 [:lower bound2-
upper bound2...] tuples which sets the name of the counter and list of closed
intervals. The lower bound is optional and is zero initialized if not set. For
example, with ‘-fdbg-cnt=dce:2-4:10-11,tail_call:10’, dbg_cnt(dce) re-
turns true only for second, third, fourth, tenth and eleventh invocation. For
dbg_cnt(tail_call) true is returned for first 10 invocations.
-print-file-name=library
Print the full absolute name of the library file library that would be used when
linking—and don’t do anything else. With this option, GCC does not compile
or link anything; it just prints the file name.
-print-multi-directory
Print the directory name corresponding to the multilib selected by any other
switches present in the command line. This directory is supposed to exist in
GCC_EXEC_PREFIX.
-print-multi-lib
Print the mapping from multilib directory names to compiler switches that
enable them. The directory name is separated from the switches by ‘;’, and
each switch starts with an ‘@’ instead of the ‘-’, without spaces between multiple
switches. This is supposed to ease shell processing.
-print-multi-os-directory
Print the path to OS libraries for the selected multilib, relative to some ‘lib’
subdirectory. If OS libraries are present in the ‘lib’ subdirectory and no mul-
tilibs are used, this is usually just ‘.’, if OS libraries are present in ‘libsuffix’
sibling directories this prints e.g. ‘../lib64’, ‘../lib’ or ‘../lib32’, or if
OS libraries are present in ‘lib/subdir’ subdirectories it prints e.g. ‘amd64’,
‘sparcv9’ or ‘ev6’.
-print-multiarch
Print the path to OS libraries for the selected multiarch, relative to some ‘lib’
subdirectory.
-print-prog-name=program
Like ‘-print-file-name’, but searches for a program such as cpp.
-print-libgcc-file-name
Same as ‘-print-file-name=libgcc.a’.
This is useful when you use ‘-nostdlib’ or ‘-nodefaultlibs’ but you do want
to link with ‘libgcc.a’. You can do:
gcc -nostdlib files... ‘gcc -print-libgcc-file-name‘
-print-search-dirs
Print the name of the configured installation directory and a list of program
and library directories gcc searches—and don’t do anything else.
This is useful when gcc prints the error message ‘installation problem,
cannot exec cpp0: No such file or directory’. To resolve this you either
Chapter 3: GCC Command Options 297
need to put ‘cpp0’ and the other compiler components where gcc expects to
find them, or you can set the environment variable GCC_EXEC_PREFIX to the di-
rectory where you installed them. Don’t forget the trailing ‘/’. See Section 3.21
[Environment Variables], page 505.
-print-sysroot
Print the target sysroot directory that is used during compilation. This is the
target sysroot specified either at configure time or using the ‘--sysroot’ option,
possibly with an extra suffix that depends on compilation options. If no target
sysroot is specified, the option prints nothing.
-print-sysroot-headers-suffix
Print the suffix added to the target sysroot when searching for headers, or
give an error if the compiler is not configured with such a suffix—and don’t do
anything else.
-dumpmachine
Print the compiler’s target machine (for example, ‘i686-pc-linux-gnu’)—and
don’t do anything else.
-dumpversion
Print the compiler version (for example, 3.0, 6.3.0 or 7)—and don’t do any-
thing else. This is the compiler version used in filesystem paths and specs.
Depending on how the compiler has been configured it can be just a single
number (major version), two numbers separated by a dot (major and minor
version) or three numbers separated by dots (major, minor and patchlevel ver-
sion).
-dumpfullversion
Print the full compiler version—and don’t do anything else. The output is
always three numbers separated by dots, major, minor and patchlevel version.
-dumpspecs
Print the compiler’s built-in specs—and don’t do anything else. (This is used
when GCC itself is being built.) See Section 3.20 [Spec Files], page 496.
for SysV-like data model where int is 32 bits, but long int and pointers are 64
bits.
The default depends on the specific target configuration. Note that the LP64
and ILP32 ABIs are not link-compatible; you must compile your entire program
with the same ABI, and link with a compatible set of libraries.
-mbig-endian
Generate big-endian code. This is the default when GCC is configured for an
‘aarch64_be-*-*’ target.
-mgeneral-regs-only
Generate code which uses only the general-purpose registers. This will prevent
the compiler from using floating-point and Advanced SIMD registers but will
not impose any restrictions on the assembler.
-mlittle-endian
Generate little-endian code. This is the default when GCC is configured for an
‘aarch64-*-*’ but not an ‘aarch64_be-*-*’ target.
-mcmodel=tiny
Generate code for the tiny code model. The program and its statically defined
symbols must be within 1MB of each other. Programs can be statically or
dynamically linked.
-mcmodel=small
Generate code for the small code model. The program and its statically defined
symbols must be within 4GB of each other. Programs can be statically or
dynamically linked. This is the default code model.
-mcmodel=large
Generate code for the large code model. This makes no assumptions about
addresses and sizes of sections. Programs can be statically linked only. The
‘-mcmodel=large’ option is incompatible with ‘-mabi=ilp32’, ‘-fpic’ and
‘-fPIC’.
-mstrict-align
-mno-strict-align
Avoid or allow generating memory accesses that may not be aligned on a natural
object boundary as described in the architecture specification.
-momit-leaf-frame-pointer
-mno-omit-leaf-frame-pointer
Omit or keep the frame pointer in leaf functions. The former behavior is the
default.
-mstack-protector-guard=guard
-mstack-protector-guard-reg=reg
-mstack-protector-guard-offset=offset
Generate stack protection code using canary at guard. Supported locations are
‘global’ for a global canary or ‘sysreg’ for a canary in an appropriate system
register.
Chapter 3: GCC Command Options 299
-mtrack-speculation
-mno-track-speculation
Enable or disable generation of additional code to track speculative execution
through conditional branches. The tracking state can then be used by the com-
piler when expanding calls to __builtin_speculation_safe_copy to permit
a more efficient code sequence to be generated.
-moutline-atomics
-mno-outline-atomics
Enable or disable calls to out-of-line helpers to implement atomic operations.
These helpers will, at runtime, determine if the LSE instructions from
ARMv8.1-A can be used; if not, they will use the load/store-exclusive
instructions that are present in the base ARMv8.0 ISA.
This option is only applicable when compiling for the base ARMv8.0
instruction set. If using a later revision, e.g. ‘-march=armv8.1-a’ or
‘-march=armv8-a+lse’, the ARMv8.1-Atomics instructions will be used
directly. The same applies when using ‘-mcpu=’ when the selected cpu supports
the ‘lse’ feature. This option is on by default.
-march=name
Specify the name of the target architecture and, optionally, one or more feature
modifiers. This option has the form ‘-march=arch{+[no]feature}*’.
The table below summarizes the permissible values for arch and the features
that they enable by default:
-mtune=name
Specify the name of the target processor for which GCC should tune
the performance of the code. Permissible values for this option are:
‘generic’, ‘cortex-a35’, ‘cortex-a53’, ‘cortex-a55’, ‘cortex-a57’,
‘cortex-a72’, ‘cortex-a73’, ‘cortex-a75’, ‘cortex-a76’, ‘cortex-a76ae’,
‘cortex-a77’, ‘cortex-a65’, ‘cortex-a65ae’, ‘cortex-a34’, ‘cortex-a78’,
‘cortex-a78ae’, ‘cortex-a78c’, ‘ares’, ‘exynos-m1’, ‘emag’, ‘falkor’,
‘neoverse-512tvb’, ‘neoverse-e1’, ‘neoverse-n1’, ‘neoverse-n2’,
‘neoverse-v1’, ‘qdf24xx’, ‘saphira’, ‘phecda’, ‘xgene1’, ‘vulcan’,
‘octeontx’, ‘octeontx81’, ‘octeontx83’, ‘octeontx2’, ‘octeontx2t98’,
‘octeontx2t96’ ‘octeontx2t93’, ‘octeontx2f95’, ‘octeontx2f95n’,
‘octeontx2f95mm’, ‘a64fx’, ‘thunderx’, ‘thunderxt88’, ‘thunderxt88p1’,
‘thunderxt81’, ‘tsv110’, ‘thunderxt83’, ‘thunderx2t99’, ‘thunderx3t110’,
‘zeus’, ‘cortex-a57.cortex-a53’, ‘cortex-a72.cortex-a53’,
‘cortex-a73.cortex-a35’, ‘cortex-a73.cortex-a53’, ‘cortex-a75.cortex-a55’,
‘cortex-a76.cortex-a55’, ‘cortex-r82’, ‘cortex-x1’, ‘cortex-x2’,
‘cortex-a510’, ‘cortex-a710’, ‘ampere1’, ‘native’.
The values ‘cortex-a57.cortex-a53’, ‘cortex-a72.cortex-a53’,
‘cortex-a73.cortex-a35’, ‘cortex-a73.cortex-a53’, ‘cortex-a75.cortex-a55’,
‘cortex-a76.cortex-a55’ specify that GCC should tune for a big.LITTLE
system.
The value ‘neoverse-512tvb’ specifies that GCC should tune for Neoverse cores
that (a) implement SVE and (b) have a total vector bandwidth of 512 bits per
cycle. In other words, the option tells GCC to tune for Neoverse cores that can
execute 4 128-bit Advanced SIMD arithmetic instructions a cycle and that can
execute an equivalent number of SVE arithmetic instructions per cycle (2 for
256-bit SVE, 4 for 128-bit SVE). This is more general than tuning for a specific
core like Neoverse V1 but is more specific than the default tuning described
below.
Additionally on native AArch64 GNU/Linux systems the value ‘native’ tunes
performance to the host system. This option has no effect if the compiler is
unable to recognize the processor of the host system.
Where none of ‘-mtune=’, ‘-mcpu=’ or ‘-march=’ are specified, the code is tuned
to perform well across a range of target processors.
This option cannot be suffixed by feature modifiers.
-mcpu=name
Specify the name of the target processor, optionally suffixed by one or more
feature modifiers. This option has the form ‘-mcpu=cpu{+[no]feature}*’, where
the permissible values for cpu are the same as those available for ‘-mtune’. The
permissible values for feature are documented in the sub-section on [‘-march’
and ‘-mcpu’ Feature Modifiers], page 303. Where conflicting feature modifiers
are specified, the right-most feature is used.
GCC uses name to determine what kind of instructions it can emit when gen-
erating assembly code (as if by ‘-march’) and to determine the target processor
for which to tune for performance (as if by ‘-mtune’). Where this option is used
302 Using the GNU Compiler Collection (GCC)
‘blr’
In addition, ‘-mharden-sls=all’ enables all SLS hardening while
‘-mharden-sls=none’ disables all SLS hardening.
-msve-vector-bits=bits
Specify the number of bits in an SVE vector register. This option only has an
effect when SVE is enabled.
GCC supports two forms of SVE code generation: “vector-length agnostic”
output that works with any size of vector register and “vector-length specific”
output that allows GCC to make assumptions about the vector length when it is
useful for optimization reasons. The possible values of ‘bits’ are: ‘scalable’,
‘128’, ‘256’, ‘512’, ‘1024’ and ‘2048’. Specifying ‘scalable’ selects vector-
length agnostic output. At present ‘-msve-vector-bits=128’ also generates
vector-length agnostic output for big-endian targets. All other values generate
vector-length specific code. The behavior of these values may change in future
releases and no value except ‘scalable’ should be relied on for producing code
that is portable across different hardware SVE vector lengths.
The default is ‘-msve-vector-bits=scalable’, which produces vector-length
agnostic code.
‘rcpc’ Enable the RcPc extension. This does not change code generation from GCC,
but is passed on to the assembler, enabling inline asm statements to use in-
structions from the RcPc extension.
‘dotprod’ Enable the Dot Product extension. This also enables Advanced SIMD instruc-
tions.
‘aes’ Enable the Armv8-a aes and pmull crypto extension. This also enables Ad-
vanced SIMD instructions.
‘sha2’ Enable the Armv8-a sha2 crypto extension. This also enables Advanced SIMD
instructions.
‘sha3’ Enable the sha512 and sha3 crypto extension. This also enables Advanced
SIMD instructions. Use of this option with architectures prior to Armv8.2-A is
not supported.
‘sm4’ Enable the sm3 and sm4 crypto extension. This also enables Advanced SIMD
instructions. Use of this option with architectures prior to Armv8.2-A is not
supported.
‘profile’ Enable the Statistical Profiling extension. This option is only to enable the
extension at the assembler level and does not affect code generation.
‘rng’ Enable the Armv8.5-a Random Number instructions. This option is only to
enable the extension at the assembler level and does not affect code generation.
‘memtag’ Enable the Armv8.5-a Memory Tagging Extensions. Use of this option with
architectures prior to Armv8.5-A is not supported.
‘sb’ Enable the Armv8-a Speculation Barrier instruction. This option is only to
enable the extension at the assembler level and does not affect code generation.
This option is enabled by default for ‘-march=armv8.5-a’.
‘ssbs’ Enable the Armv8-a Speculative Store Bypass Safe instruction. This option is
only to enable the extension at the assembler level and does not affect code
generation. This option is enabled by default for ‘-march=armv8.5-a’.
‘predres’ Enable the Armv8-a Execution and Data Prediction Restriction instructions.
This option is only to enable the extension at the assembler level and does not af-
fect code generation. This option is enabled by default for ‘-march=armv8.5-a’.
‘sve2’ Enable the Armv8-a Scalable Vector Extension 2. This also enables SVE in-
structions.
‘sve2-bitperm’
Enable SVE2 bitperm instructions. This also enables SVE2 instructions.
‘sve2-sm4’
Enable SVE2 sm4 instructions. This also enables SVE2 instructions.
‘sve2-aes’
Enable SVE2 aes instructions. This also enables SVE2 instructions.
‘sve2-sha3’
Enable SVE2 sha3 instructions. This also enables SVE2 instructions.
Chapter 3: GCC Command Options 305
-mno-soft-cmpsf
For single-precision floating-point comparisons, emit an fsub instruction and
test the flags. This is faster than a software comparison, but can get incorrect re-
sults in the presence of NaNs, or when two different small numbers are compared
such that their difference is calculated as zero. The default is ‘-msoft-cmpsf’,
which uses slower, but IEEE-compliant, software comparisons.
-mstack-offset=num
Set the offset between the top of the stack and the stack pointer. E.g., a value
of 8 means that the eight bytes in the range sp+0...sp+7 can be used by leaf
functions without stack allocation. Values other than ‘8’ or ‘16’ are untested
and unlikely to work. Note also that this option changes the ABI; compiling
a program with a different stack offset than the libraries have been compiled
with generally does not work. This option can be useful if you want to evaluate
if a different stack offset would give you better code, but to actually use a
different stack offset to build working programs, it is recommended to configure
the toolchain with the appropriate ‘--with-stack-offset=num’ option.
-mno-round-nearest
Make the scheduler assume that the rounding mode has been set to truncating.
The default is ‘-mround-nearest’.
-mlong-calls
If not otherwise specified by an attribute, assume all calls might be beyond the
offset range of the b / bl instructions, and therefore load the function address
into a register before performing a (otherwise direct) call. This is the default.
-mshort-calls
If not otherwise specified by an attribute, assume all direct calls are in the range
of the b / bl instructions, so use these instructions for direct calls. The default
is ‘-mlong-calls’.
-msmall16
Assume addresses can be loaded as 16-bit unsigned values. This does not apply
to function addresses for which ‘-mlong-calls’ semantics are in effect.
-mfp-mode=mode
Set the prevailing mode of the floating-point unit. This determines the floating-
point mode that is provided and expected at function call and return time.
Making this mode match the mode you predominantly need at function start can
make your programs smaller and faster by avoiding unnecessary mode switches.
mode can be set to one the following values:
‘caller’ Any mode at function entry is valid, and retained or restored when
the function returns, and when it calls other functions. This mode
is useful for compiling libraries or other compilation units you might
want to incorporate into different programs with different prevail-
ing FPU modes, and the convenience of being able to use a single
object file outweighs the size and speed overhead for any extra
mode switching that might be needed, compared with what would
be needed with a more specific choice of prevailing FPU mode.
Chapter 3: GCC Command Options 307
‘truncate’
This is the mode used for floating-point calculations with truncating
(i.e. round towards zero) rounding mode. That includes conversion
from floating point to integer.
‘round-nearest’
This is the mode used for floating-point calculations with round-
to-nearest-or-even rounding mode.
‘int’ This is the mode used to perform integer calculations in the FPU,
e.g. integer multiply, or integer multiply-and-accumulate.
The default is ‘-mfp-mode=caller’
-mno-split-lohi
-mno-postinc
-mno-postmodify
Code generation tweaks that disable, respectively, splitting of 32-bit loads, gen-
eration of post-increment addresses, and generation of post-modify addresses.
The defaults are ‘msplit-lohi’, ‘-mpost-inc’, and ‘-mpost-modify’.
-mnovect-double
Change the preferred SIMD mode to SImode. The default is ‘-mvect-double’,
which uses DImode as preferred SIMD mode.
-max-vect-align=num
The maximum alignment for SIMD vector mode types. num may be 4 or 8.
The default is 8. Note that this is an ABI change, even though many library
function interfaces are unaffected if they don’t use SIMD vector modes in places
that affect size and/or alignment of relevant types.
-msplit-vecmove-early
Split vector moves into single word moves before reload. In theory this can give
better register allocation, but so far the reverse seems to be generally the case.
-m1reg-reg
Specify a register to hold the constant −1, which makes loading small negative
constants and certain bitmasks faster. Allowable values for reg are ‘r43’ and
‘r63’, which specify use of that register as a fixed register, and ‘none’, which
means that no register is used for this purpose. The default is ‘-m1reg-none’.
‘em4_dmips’
Compile for ARC EM4 DMIPS CPU.
‘em4_fpus’
Compile for ARC EM4 DMIPS CPU with the single-precision
floating-point extension.
‘em4_fpuda’
Compile for ARC EM4 DMIPS CPU with single-precision floating-
point and double assist instructions.
‘hs’ Compile for ARC HS CPU with no hardware extensions except the
atomic instructions.
‘hs34’ Compile for ARC HS34 CPU.
‘hs38’ Compile for ARC HS38 CPU.
‘hs38_linux’
Compile for ARC HS38 CPU with all hardware extensions on.
‘arc600_norm’
Compile for ARC 600 CPU with norm instructions enabled.
‘arc600_mul32x16’
Compile for ARC 600 CPU with norm and 32x16-bit multiply in-
structions enabled.
‘arc600_mul64’
Compile for ARC 600 CPU with norm and mul64-family instruc-
tions enabled.
‘arc601_norm’
Compile for ARC 601 CPU with norm instructions enabled.
‘arc601_mul32x16’
Compile for ARC 601 CPU with norm and 32x16-bit multiply in-
structions enabled.
‘arc601_mul64’
Compile for ARC 601 CPU with norm and mul64-family instruc-
tions enabled.
‘nps400’ Compile for ARC 700 on NPS400 chip.
‘em_mini’ Compile for ARC EM minimalist configuration featuring reduced
register set.
-mdpfp
-mdpfp-compact
Generate double-precision FPX instructions, tuned for the compact implemen-
tation.
-mdpfp-fast
Generate double-precision FPX instructions, tuned for the fast implementation.
310 Using the GNU Compiler Collection (GCC)
-mno-dpfp-lrsr
Disable lr and sr instructions from using FPX extension aux registers.
-mea Generate extended arithmetic instructions. Currently only divaw, adds, subs,
and sat16 are supported. Only valid for ‘-mcpu=ARC700’.
-mno-mpy Do not generate mpy-family instructions for ARC700. This option is deprecated.
-mmul32x16
Generate 32x16-bit multiply and multiply-accumulate instructions.
-mmul64 Generate mul64 and mulu64 instructions. Only valid for ‘-mcpu=ARC600’.
-mnorm Generate norm instructions. This is the default if ‘-mcpu=ARC700’ is in effect.
-mspfp
-mspfp-compact
Generate single-precision FPX instructions, tuned for the compact implemen-
tation.
-mspfp-fast
Generate single-precision FPX instructions, tuned for the fast implementation.
-msimd Enable generation of ARC SIMD instructions via target-specific builtins. Only
valid for ‘-mcpu=ARC700’.
-msoft-float
This option ignored; it is provided for compatibility purposes only. Software
floating-point code is emitted by default, and this default can overridden by
FPX options; ‘-mspfp’, ‘-mspfp-compact’, or ‘-mspfp-fast’ for single preci-
sion, and ‘-mdpfp’, ‘-mdpfp-compact’, or ‘-mdpfp-fast’ for double precision.
-mswap Generate swap instructions.
-matomic This enables use of the locked load/store conditional extension to implement
atomic memory built-in functions. Not available for ARC 6xx or ARC EM
cores.
-mdiv-rem
Enable div and rem instructions for ARCv2 cores.
-mcode-density
Enable code density instructions for ARC EM. This option is on by default for
ARC HS.
-mll64 Enable double load/store operations for ARC HS cores.
-mtp-regno=regno
Specify thread pointer register number.
-mmpy-option=multo
Compile ARCv2 code with a multiplier design option. You can specify the
option using either a string or numeric value for multo. ‘wlh1’ is the default
value. The recognized values are:
‘0’
‘none’ No multiplier available.
Chapter 3: GCC Command Options 311
‘1’
‘w’ 16x16 multiplier, fully pipelined. The following instructions are
enabled: mpyw and mpyuw.
‘2’
‘wlh1’ 32x32 multiplier, fully pipelined (1 stage). The following instruc-
tions are additionally enabled: mpy, mpyu, mpym, mpymu, and mpy_s.
‘3’
‘wlh2’ 32x32 multiplier, fully pipelined (2 stages). The following instruc-
tions are additionally enabled: mpy, mpyu, mpym, mpymu, and mpy_s.
‘4’
‘wlh3’ Two 16x16 multipliers, blocking, sequential. The following instruc-
tions are additionally enabled: mpy, mpyu, mpym, mpymu, and mpy_s.
‘5’
‘wlh4’ One 16x16 multiplier, blocking, sequential. The following instruc-
tions are additionally enabled: mpy, mpyu, mpym, mpymu, and mpy_s.
‘6’
‘wlh5’ One 32x4 multiplier, blocking, sequential. The following instruc-
tions are additionally enabled: mpy, mpyu, mpym, mpymu, and mpy_s.
‘7’
‘plus_dmpy’
ARC HS SIMD support.
‘8’
‘plus_macd’
ARC HS SIMD support.
‘9’
‘plus_qmacw’
ARC HS SIMD support.
This option is only available for ARCv2 cores.
-mfpu=fpu
Enables support for specific floating-point hardware extensions for ARCv2
cores. Supported values for fpu are:
‘fpus’ Enables support for single-precision floating-point hardware exten-
sions.
‘fpud’ Enables support for double-precision floating-point hardware exten-
sions. The single-precision floating-point extension is also enabled.
Not available for ARC EM.
‘fpuda’ Enables support for double-precision floating-point hardware
extensions using double-precision assist instructions. The
single-precision floating-point extension is also enabled. This
option is only available for ARC EM.
312 Using the GNU Compiler Collection (GCC)
‘fpuda_div’
Enables support for double-precision floating-point hardware
extensions using double-precision assist instructions. The
single-precision floating-point, square-root, and divide extensions
are also enabled. This option is only available for ARC EM.
‘fpuda_fma’
Enables support for double-precision floating-point hardware
extensions using double-precision assist instructions. The
single-precision floating-point and fused multiply and add
hardware extensions are also enabled. This option is only available
for ARC EM.
‘fpuda_all’
Enables support for double-precision floating-point hardware exten-
sions using double-precision assist instructions. All single-precision
floating-point hardware extensions are also enabled. This option is
only available for ARC EM.
‘fpus_div’
Enables support for single-precision floating-point, square-root and
divide hardware extensions.
‘fpud_div’
Enables support for double-precision floating-point, square-root
and divide hardware extensions. This option includes option
‘fpus_div’. Not available for ARC EM.
‘fpus_fma’
Enables support for single-precision floating-point and fused mul-
tiply and add hardware extensions.
‘fpud_fma’
Enables support for double-precision floating-point and fused mul-
tiply and add hardware extensions. This option includes option
‘fpus_fma’. Not available for ARC EM.
‘fpus_all’
Enables support for all single-precision floating-point hardware ex-
tensions.
‘fpud_all’
Enables support for all single- and double-precision floating-point
hardware extensions. Not available for ARC EM.
-mirq-ctrl-saved=register-range, blink, lp_count
Specifies general-purposes registers that the processor automatically
saves/restores on interrupt entry and exit. register-range is specified as two
registers separated by a dash. The register range always starts with r0, the
upper limit is fp register. blink and lp count are optional. This option is only
valid for ARC EM and ARC HS cores.
Chapter 3: GCC Command Options 313
-mrgf-banked-regs=number
Specifies the number of registers replicated in second register bank on entry
to fast interrupt. Fast interrupts are interrupts with the highest priority level
P0. These interrupts save only PC and STATUS32 registers to avoid memory
transactions during interrupt entry and exit sequences. Use this option when
you are using fast interrupts in an ARC V2 family processor. Permitted values
are 4, 8, 16, and 32.
-mlpc-width=width
Specify the width of the lp_count register. Valid values for width are 8, 16, 20,
24, 28 and 32 bits. The default width is fixed to 32 bits. If the width is less than
32, the compiler does not attempt to transform loops in your program to use
the zero-delay loop mechanism unless it is known that the lp_count register
can hold the required loop-counter value. Depending on the width specified,
the compiler and run-time library might continue to use the loop mechanism for
various needs. This option defines macro __ARC_LPC_WIDTH__ with the value
of width.
-mrf16 This option instructs the compiler to generate code for a 16-entry register file.
This option defines the __ARC_RF16__ preprocessor macro.
-mbranch-index
Enable use of bi or bih instructions to implement jump tables.
The following options are passed through to the assembler, and also define preprocessor
macro symbols.
-mdsp-packa
Passed down to the assembler to enable the DSP Pack A extensions. Also sets
the preprocessor symbol __Xdsp_packa. This option is deprecated.
-mdvbf Passed down to the assembler to enable the dual Viterbi butterfly extension.
Also sets the preprocessor symbol __Xdvbf. This option is deprecated.
-mlock Passed down to the assembler to enable the locked load/store conditional ex-
tension. Also sets the preprocessor symbol __Xlock.
-mmac-d16
Passed down to the assembler. Also sets the preprocessor symbol __Xxmac_d16.
This option is deprecated.
-mmac-24 Passed down to the assembler. Also sets the preprocessor symbol __Xxmac_24.
This option is deprecated.
-mrtsc Passed down to the assembler to enable the 64-bit time-stamp counter exten-
sion instruction. Also sets the preprocessor symbol __Xrtsc. This option is
deprecated.
-mswape Passed down to the assembler to enable the swap byte ordering extension in-
struction. Also sets the preprocessor symbol __Xswape.
-mtelephony
Passed down to the assembler to enable dual- and single-operand instructions
for telephony. Also sets the preprocessor symbol __Xtelephony. This option is
deprecated.
314 Using the GNU Compiler Collection (GCC)
-mxy Passed down to the assembler to enable the XY memory extension. Also sets
the preprocessor symbol __Xxy.
The following options control how the assembly code is annotated:
-misize Annotate assembler instructions with estimated addresses.
-mannotate-align
Explain what alignment considerations lead to the decision to make an instruc-
tion short or long.
The following options are passed through to the linker:
-marclinux
Passed through to the linker, to specify use of the arclinux emulation. This
option is enabled by default in tool chains built for arc-linux-uclibc and
arceb-linux-uclibc targets when profiling is not requested.
-marclinux_prof
Passed through to the linker, to specify use of the arclinux_prof emulation.
This option is enabled by default in tool chains built for arc-linux-uclibc
and arceb-linux-uclibc targets when profiling is requested.
The following options control the semantics of generated code:
-mlong-calls
Generate calls as register indirect calls, thus providing access to the full 32-bit
address range.
-mmedium-calls
Don’t use less than 25-bit addressing range for calls, which is the offset avail-
able for an unconditional branch-and-link instruction. Conditional execution
of function calls is suppressed, to allow use of the 25-bit range, rather than
the 21-bit range with conditional branch-and-link. This is the default for tool
chains built for arc-linux-uclibc and arceb-linux-uclibc targets.
-G num Put definitions of externally-visible data in a small data section if that data
is no bigger than num bytes. The default value of num is 4 for any ARC
configuration, or 8 when we have double load/store operations.
-mno-sdata
Do not generate sdata references. This is the default for tool chains built for
arc-linux-uclibc and arceb-linux-uclibc targets.
-mvolatile-cache
Use ordinarily cached memory accesses for volatile references. This is the de-
fault.
-mno-volatile-cache
Enable cache bypass for volatile references.
The following options fine tune code generation:
-malign-call
Does nothing. Preserved for backward compatibility.
Chapter 3: GCC Command Options 315
-mauto-modify-reg
Enable the use of pre/post modify with register displacement.
-mbbit-peephole
Enable bbit peephole2.
-mno-brcc
This option disables a target-specific pass in ‘arc_reorg’ to generate compare-
and-branch (brcc) instructions. It has no effect on generation of these instruc-
tions driven by the combiner pass.
-mcase-vector-pcrel
Use PC-relative switch case tables to enable case table shortening. This is the
default for ‘-Os’.
-mcompact-casesi
Enable compact casesi pattern. This is the default for ‘-Os’, and only available
for ARCv1 cores. This option is deprecated.
-mno-cond-exec
Disable the ARCompact-specific pass to generate conditional execution instruc-
tions.
Due to delay slot scheduling and interactions between operand numbers, literal
sizes, instruction lengths, and the support for conditional execution, the target-
independent pass to generate conditional execution is often lacking, so the ARC
port has kept a special pass around that tries to find more conditional execution
generation opportunities after register allocation, branch shortening, and delay
slot scheduling have been done. This pass generally, but not always, improves
performance and code size, at the cost of extra compilation time, which is why
there is an option to switch it off. If you have a problem with call instructions
exceeding their allowable offset range because they are conditionalized, you
should consider using ‘-mmedium-calls’ instead.
-mearly-cbranchsi
Enable pre-reload use of the cbranchsi pattern.
-mexpand-adddi
Expand adddi3 and subdi3 at RTL generation time into add.f, adc etc. This
option is deprecated.
-mindexed-loads
Enable the use of indexed loads. This can be problematic because some opti-
mizers then assume that indexed stores exist, which is not the case.
-mlra Enable Local Register Allocation. This is still experimental for ARC, so by
default the compiler uses standard reload (i.e. ‘-mno-lra’).
-mlra-priority-none
Don’t indicate any priority for target registers.
-mlra-priority-compact
Indicate target register priority for r0..r3 / r12..r15.
316 Using the GNU Compiler Collection (GCC)
-mlra-priority-noncompact
Reduce target register priority for r0..r3 / r12..r15.
-mmillicode
When optimizing for size (using ‘-Os’), prologues and epilogues that have to
save or restore a large number of registers are often shortened by using call
to a special function in libgcc; this is referred to as a millicode call. As these
calls can pose performance issues, and/or cause linking issues when linking
in a nonstandard way, this option is provided to turn on or off millicode call
generation.
-mcode-density-frame
This option enable the compiler to emit enter and leave instructions. These
instructions are only valid for CPUs with code-density feature.
-mmixed-code
Does nothing. Preserved for backward compatibility.
-mq-class
Ths option is deprecated. Enable ‘q’ instruction alternatives. This is the default
for ‘-Os’.
-mRcq Enable ‘Rcq’ constraint handling. Most short code generation depends on this.
This is the default.
-mRcw Enable ‘Rcw’ constraint handling. Most ccfsm condexec mostly depends on this.
This is the default.
-msize-level=level
Fine-tune size optimization with regards to instruction lengths and alignment.
The recognized values for level are:
‘0’ No size optimization. This level is deprecated and treated like ‘1’.
‘1’ Short instructions are used opportunistically.
‘2’ In addition, alignment of loops and of code after barriers are
dropped.
‘3’ In addition, optional data alignment is dropped, and the option
‘Os’ is enabled.
This defaults to ‘3’ when ‘-Os’ is in effect. Otherwise, the behavior when this
is not set is equivalent to level ‘1’.
-mtune=cpu
Set instruction scheduling parameters for cpu, overriding any implied by
‘-mcpu=’.
Supported values for cpu are
‘ARC600’ Tune for ARC600 CPU.
‘ARC601’ Tune for ARC601 CPU.
‘ARC700’ Tune for ARC700 CPU with standard multiplier block.
Chapter 3: GCC Command Options 317
‘ARC700-xmac’
Tune for ARC700 CPU with XMAC block.
‘ARC725D’ Tune for ARC725D CPU.
‘ARC750D’ Tune for ARC750D CPU.
-mmultcost=num
Cost to assume for a multiply instruction, with ‘4’ being equal to a normal
instruction.
-munalign-prob-threshold=probability
Does nothing. Preserved for backward compatibility.
The following options are maintained for backward compatibility, but are now deprecated
and will be removed in a future release:
-margonaut
Obsolete FPX.
-mbig-endian
-EB Compile code for big-endian targets. Use of these options is now deprecated.
Big-endian code is supported by configuring GCC to build arceb-elf32 and
arceb-linux-uclibc targets, for which big endian is the default.
-mlittle-endian
-EL Compile code for little-endian targets. Use of these options is now deprecated.
Little-endian code is supported by configuring GCC to build arc-elf32 and
arc-linux-uclibc targets, for which little endian is the default.
-mbarrel_shifter
Replaced by ‘-mbarrel-shifter’.
-mdpfp_compact
Replaced by ‘-mdpfp-compact’.
-mdpfp_fast
Replaced by ‘-mdpfp-fast’.
-mdsp_packa
Replaced by ‘-mdsp-packa’.
-mEA Replaced by ‘-mea’.
-mmac_24 Replaced by ‘-mmac-24’.
-mmac_d16
Replaced by ‘-mmac-d16’.
-mspfp_compact
Replaced by ‘-mspfp-compact’.
-mspfp_fast
Replaced by ‘-mspfp-fast’.
-mtune=cpu
Values ‘arc600’, ‘arc601’, ‘arc700’ and ‘arc700-xmac’ for cpu are replaced by
‘ARC600’, ‘ARC601’, ‘ARC700’ and ‘ARC700-xmac’ respectively.
318 Using the GNU Compiler Collection (GCC)
-multcost=num
Replaced by ‘-mmultcost’.
-mlittle-endian
Generate code for a processor running in little-endian mode. This is the default
for all standard configurations.
-mbig-endian
Generate code for a processor running in big-endian mode; the default is to
compile code for a little-endian processor.
-mbe8
-mbe32 When linking a big-endian image select between BE8 and BE32 formats. The
option has no effect for little-endian images and is ignored. The default is de-
pendent on the selected target architecture. For ARMv6 and later architectures
the default is BE8, for older architectures the default is BE32. BE32 format
has been deprecated by ARM.
-march=name[+extension...]
This specifies the name of the target ARM architecture. GCC uses this name
to determine what kind of instructions it can emit when generating assembly
code. This option can be used in conjunction with or instead of the ‘-mcpu=’
option.
Permissible names are: ‘armv4t’, ‘armv5t’, ‘armv5te’, ‘armv6’, ‘armv6j’,
‘armv6k’, ‘armv6kz’, ‘armv6t2’, ‘armv6z’, ‘armv6zk’, ‘armv7’, ‘armv7-a’,
‘armv7ve’, ‘armv8-a’, ‘armv8.1-a’, ‘armv8.2-a’, ‘armv8.3-a’, ‘armv8.4-a’,
‘armv8.5-a’, ‘armv8.6-a’, ‘armv9-a’, ‘armv7-r’, ‘armv8-r’, ‘armv6-m’,
‘armv6s-m’, ‘armv7-m’, ‘armv7e-m’, ‘armv8-m.base’, ‘armv8-m.main’,
‘armv8.1-m.main’, ‘armv9-a’, ‘iwmmxt’ and ‘iwmmxt2’.
Additionally, the following architectures, which lack support for the Thumb
execution state, are recognized but support is deprecated: ‘armv4’.
Many of the architectures support extensions. These can be added by append-
ing ‘+extension’ to the architecture name. Extension options are processed in
order and capabilities accumulate. An extension will also enable any necessary
base extensions upon which it depends. For example, the ‘+crypto’ extension
will always enable the ‘+simd’ extension. The exception to the additive con-
struction is for extensions that are prefixed with ‘+no...’: these extensions
disable the specified option and any other extensions that may depend on the
presence of that extension.
For example, ‘-march=armv7-a+simd+nofp+vfpv4’ is equivalent to writing
‘-march=armv7-a+vfpv4’ since the ‘+simd’ option is entirely disabled by the
‘+nofp’ option that follows it.
Most extension names are generically named, but have an effect that is depen-
dent upon the architecture to which it is applied. For example, the ‘+simd’
option can be applied to both ‘armv7-a’ and ‘armv8-a’ architectures, but will
enable the original ARMv7-A Advanced SIMD (Neon) extensions for ‘armv7-a’
and the ARMv8-A variant for ‘armv8-a’.
The table below lists the supported extensions for each architecture. Architec-
tures not mentioned do not support any extensions.
320 Using the GNU Compiler Collection (GCC)
‘armv5te’
‘armv6’
‘armv6j’
‘armv6k’
‘armv6kz’
‘armv6t2’
‘armv6z’
‘armv6zk’
‘+fp’ The VFPv2 floating-point instructions. The extension
‘+vfpv2’ can be used as an alias for this extension.
‘+nofp’ Disable the floating-point instructions.
‘armv7’ The common subset of the ARMv7-A, ARMv7-R and ARMv7-M
architectures.
‘+fp’ The VFPv3 floating-point instructions, with 16 double-
precision registers. The extension ‘+vfpv3-d16’ can be
used as an alias for this extension. Note that floating-
point is not supported by the base ARMv7-M architec-
ture, but is compatible with both the ARMv7-A and
ARMv7-R architectures.
‘+nofp’ Disable the floating-point instructions.
‘armv7-a’
‘+mp’ The multiprocessing extension.
‘+sec’ The security extension.
‘+fp’ The VFPv3 floating-point instructions, with 16 double-
precision registers. The extension ‘+vfpv3-d16’ can be
used as an alias for this extension.
‘+simd’ The Advanced SIMD (Neon) v1 and the VFPv3
floating-point instructions. The extensions ‘+neon’
and ‘+neon-vfpv3’ can be used as aliases for this
extension.
‘+vfpv3’ The VFPv3 floating-point instructions, with 32 double-
precision registers.
‘+vfpv3-d16-fp16’
The VFPv3 floating-point instructions, with 16 double-
precision registers and the half-precision floating-point
conversion operations.
‘+vfpv3-fp16’
The VFPv3 floating-point instructions, with 32 double-
precision registers and the half-precision floating-point
conversion operations.
Chapter 3: GCC Command Options 321
‘+vfpv4-d16’
The VFPv4 floating-point instructions, with 16 double-
precision registers.
‘+vfpv4’ The VFPv4 floating-point instructions, with 32 double-
precision registers.
‘+neon-fp16’
The Advanced SIMD (Neon) v1 and the VFPv3
floating-point instructions, with the half-precision
floating-point conversion operations.
‘+neon-vfpv4’
The Advanced SIMD (Neon) v2 and the VFPv4
floating-point instructions.
‘+nosimd’ Disable the Advanced SIMD instructions (does not dis-
able floating point).
‘+nofp’ Disable the floating-point and Advanced SIMD instruc-
tions.
‘armv7ve’ The extended version of the ARMv7-A architecture with support
for virtualization.
‘+fp’ The VFPv4 floating-point instructions, with 16 double-
precision registers. The extension ‘+vfpv4-d16’ can be
used as an alias for this extension.
‘+simd’ The Advanced SIMD (Neon) v2 and the VFPv4
floating-point instructions. The extension
‘+neon-vfpv4’ can be used as an alias for this
extension.
‘+vfpv3-d16’
The VFPv3 floating-point instructions, with 16 double-
precision registers.
‘+vfpv3’ The VFPv3 floating-point instructions, with 32 double-
precision registers.
‘+vfpv3-d16-fp16’
The VFPv3 floating-point instructions, with 16 double-
precision registers and the half-precision floating-point
conversion operations.
‘+vfpv3-fp16’
The VFPv3 floating-point instructions, with 32 double-
precision registers and the half-precision floating-point
conversion operations.
‘+vfpv4-d16’
The VFPv4 floating-point instructions, with 16 double-
precision registers.
322 Using the GNU Compiler Collection (GCC)
‘armv8.2-a’
‘armv8.3-a’
‘+fp16’ The half-precision floating-point data processing
instructions. This also enables the Advanced SIMD
and floating-point instructions.
‘+fp16fml’
The half-precision floating-point fmla extension. This
also enables the half-precision floating-point extension
and Advanced SIMD and floating-point instructions.
‘+simd’ The ARMv8.1-A Advanced SIMD and floating-point
instructions.
‘+crypto’ The cryptographic instructions. This also enables the
Advanced SIMD and floating-point instructions.
‘+dotprod’
Enable the Dot Product extension. This also enables
Advanced SIMD instructions.
‘+nocrypto’
Disable the cryptographic extension.
‘+nofp’ Disable the floating-point, Advanced SIMD and cryp-
tographic instructions.
‘+sb’ Speculation Barrier Instruction.
‘+predres’
Execution and Data Prediction Restriction
Instructions.
‘+i8mm’ 8-bit Integer Matrix Multiply instructions. This
also enables Advanced SIMD and floating-point
instructions.
‘+bf16’ Brain half-precision floating-point instructions. This
also enables Advanced SIMD and floating-point
instructions.
‘armv8.4-a’
‘+fp16’ The half-precision floating-point data processing
instructions. This also enables the Advanced SIMD
and floating-point instructions as well as the Dot
Product extension and the half-precision floating-point
fmla extension.
‘+simd’ The ARMv8.3-A Advanced SIMD and floating-point
instructions as well as the Dot Product extension.
‘+crypto’ The cryptographic instructions. This also enables the
Advanced SIMD and floating-point instructions as well
as the Dot Product extension.
324 Using the GNU Compiler Collection (GCC)
‘+nocrypto’
Disable the cryptographic extension.
‘+nofp’ Disable the floating-point, Advanced SIMD and cryp-
tographic instructions.
‘+sb’ Speculation Barrier Instruction.
‘+predres’
Execution and Data Prediction Restriction
Instructions.
‘+i8mm’ 8-bit Integer Matrix Multiply instructions. This
also enables Advanced SIMD and floating-point
instructions.
‘+bf16’ Brain half-precision floating-point instructions. This
also enables Advanced SIMD and floating-point
instructions.
‘armv8.5-a’
‘+fp16’ The half-precision floating-point data processing
instructions. This also enables the Advanced SIMD
and floating-point instructions as well as the Dot
Product extension and the half-precision floating-point
fmla extension.
‘+simd’ The ARMv8.3-A Advanced SIMD and floating-point
instructions as well as the Dot Product extension.
‘+crypto’ The cryptographic instructions. This also enables the
Advanced SIMD and floating-point instructions as well
as the Dot Product extension.
‘+nocrypto’
Disable the cryptographic extension.
‘+nofp’ Disable the floating-point, Advanced SIMD and cryp-
tographic instructions.
‘+i8mm’ 8-bit Integer Matrix Multiply instructions. This
also enables Advanced SIMD and floating-point
instructions.
‘+bf16’ Brain half-precision floating-point instructions. This
also enables Advanced SIMD and floating-point
instructions.
‘armv8.6-a’
‘+fp16’ The half-precision floating-point data processing
instructions. This also enables the Advanced SIMD
and floating-point instructions as well as the Dot
Product extension and the half-precision floating-point
fmla extension.
Chapter 3: GCC Command Options 325
‘armv8.1-m.main’
‘+dsp’ The DSP instructions.
‘+mve’ The M-Profile Vector Extension (MVE) integer instruc-
tions.
‘+mve.fp’ The M-Profile Vector Extension (MVE) integer and
single precision floating-point instructions.
‘+fp’ The single-precision floating-point instructions.
‘+fp.dp’ The single- and double-precision floating-point instruc-
tions.
‘+nofp’ Disable the floating-point extension.
‘+cdecp0, +cdecp1, ... , +cdecp7’
Enable the Custom Datapath Extension (CDE) on se-
lected coprocessors according to the numbers given in
the options in the range 0 to 7.
‘armv8-m.main’
‘+dsp’ The DSP instructions.
‘+nodsp’ Disable the DSP extension.
‘+fp’ The single-precision floating-point instructions.
‘+fp.dp’ The single- and double-precision floating-point instruc-
tions.
‘+nofp’ Disable the floating-point extension.
‘+cdecp0, +cdecp1, ... , +cdecp7’
Enable the Custom Datapath Extension (CDE) on se-
lected coprocessors according to the numbers given in
the options in the range 0 to 7.
‘armv8-r’
‘+crc’ The Cyclic Redundancy Check (CRC) instructions.
‘+fp.sp’ The single-precision FPv5 floating-point instructions.
‘+simd’ The ARMv8-A Advanced SIMD and floating-point in-
structions.
‘+crypto’ The cryptographic instructions.
‘+nocrypto’
Disable the cryptographic instructions.
‘+nofp’ Disable the floating-point, Advanced SIMD and cryp-
tographic instructions.
‘-march=native’ causes the compiler to auto-detect the architecture of the build
computer. At present, this feature is only supported on GNU/Linux, and not
all architectures are recognized. If the auto-detect is unsuccessful the option
has no effect.
Chapter 3: GCC Command Options 327
-mtune=name
This option specifies the name of the target ARM processor for which
GCC should tune the performance of the code. For some ARM imple-
mentations better performance can be obtained by using this option.
Permissible names are: ‘arm7tdmi’, ‘arm7tdmi-s’, ‘arm710t’, ‘arm720t’,
‘arm740t’, ‘strongarm’, ‘strongarm110’, ‘strongarm1100’, ‘strongarm1110’,
‘arm8’, ‘arm810’, ‘arm9’, ‘arm9e’, ‘arm920’, ‘arm920t’, ‘arm922t’,
‘arm946e-s’, ‘arm966e-s’, ‘arm968e-s’, ‘arm926ej-s’, ‘arm940t’, ‘arm9tdmi’,
‘arm10tdmi’, ‘arm1020t’, ‘arm1026ej-s’, ‘arm10e’, ‘arm1020e’, ‘arm1022e’,
‘arm1136j-s’, ‘arm1136jf-s’, ‘mpcore’, ‘mpcorenovfp’, ‘arm1156t2-s’,
‘arm1156t2f-s’, ‘arm1176jz-s’, ‘arm1176jzf-s’, ‘generic-armv7-a’,
‘cortex-a5’, ‘cortex-a7’, ‘cortex-a8’, ‘cortex-a9’, ‘cortex-a12’,
‘cortex-a15’, ‘cortex-a17’, ‘cortex-a32’, ‘cortex-a35’, ‘cortex-a53’,
‘cortex-a55’, ‘cortex-a57’, ‘cortex-a72’, ‘cortex-a73’, ‘cortex-a75’,
‘cortex-a76’, ‘cortex-a76ae’, ‘cortex-a77’, ‘cortex-a78’, ‘cortex-a78ae’,
‘cortex-a78c’, ‘cortex-a710’, ‘ares’, ‘cortex-r4’, ‘cortex-r4f’,
‘cortex-r5’, ‘cortex-r7’, ‘cortex-r8’, ‘cortex-r52’, ‘cortex-r52plus’,
‘cortex-m0’, ‘cortex-m0plus’, ‘cortex-m1’, ‘cortex-m3’, ‘cortex-m4’,
‘cortex-m7’, ‘cortex-m23’, ‘cortex-m33’, ‘cortex-m35p’, ‘cortex-m55’,
‘cortex-x1’, ‘cortex-m1.small-multiply’, ‘cortex-m0.small-multiply’,
‘cortex-m0plus.small-multiply’, ‘exynos-m1’, ‘marvell-pj4’,
‘neoverse-n1’, ‘neoverse-n2’, ‘neoverse-v1’, ‘xscale’, ‘iwmmxt’, ‘iwmmxt2’,
‘ep9312’, ‘fa526’, ‘fa626’, ‘fa606te’, ‘fa626te’, ‘fmp626’, ‘fa726te’,
‘star-mc1’, ‘xgene1’.
Additionally, this option can specify that GCC should tune the
performance of the code for a big.LITTLE system. Permissible
names are: ‘cortex-a15.cortex-a7’, ‘cortex-a17.cortex-a7’,
‘cortex-a57.cortex-a53’, ‘cortex-a72.cortex-a53’, ‘cortex-a72.cortex-a35’,
‘cortex-a73.cortex-a53’, ‘cortex-a75.cortex-a55’, ‘cortex-a76.cortex-a55’.
‘-mtune=generic-arch’ specifies that GCC should tune the performance for a
blend of processors within architecture arch. The aim is to generate code that
run well on the current most popular processors, balancing between optimiza-
tions that benefit some CPUs in the range, and avoiding performance pitfalls
of other CPUs. The effects of this option may change in future GCC versions
as CPU models come and go.
‘-mtune’ permits the same extension options as ‘-mcpu’, but the extension op-
tions do not affect the tuning of the generated code.
‘-mtune=native’ causes the compiler to auto-detect the CPU of the build com-
puter. At present, this feature is only supported on GNU/Linux, and not all
architectures are recognized. If the auto-detect is unsuccessful the option has
no effect.
-mcpu=name[+extension...]
This specifies the name of the target ARM processor. GCC uses this name to
derive the name of the target ARM architecture (as if specified by ‘-march’) and
the ARM processor type for which to tune for performance (as if specified by
328 Using the GNU Compiler Collection (GCC)
arm_poke_function_name
mov ip, sp
stmfd sp!, {fp, ip, lr, pc}
sub fp, ip, #4
When performing a stack backtrace, code can inspect the value of pc stored at
fp + 0. If the trace function then looks at location pc - 12 and the top 8 bits
are set, then we know that there is a function name embedded immediately
preceding this location and has length ((pc[-3]) & 0xff000000).
-mthumb
-marm
Select between generating code that executes in ARM and Thumb states.
The default for most configurations is to generate code that executes in
ARM state, but the default can be changed by configuring GCC with the
‘--with-mode=’state configure option.
You can also override the ARM and Thumb mode for each function by using the
target("thumb") and target("arm") function attributes (see Section 6.33.5
[ARM Function Attributes], page 587) or pragmas (see Section 6.62.16 [Function
Specific Option Pragmas], page 880).
-mflip-thumb
Switch ARM/Thumb modes on alternating functions. This option is provided
for regression testing of mixed Thumb/ARM code generation, and is not in-
tended for ordinary use in compiling code.
-mtpcs-frame
Generate a stack frame that is compliant with the Thumb Procedure Call Stan-
dard for all non-leaf functions. (A leaf function is one that does not call any
other functions.) The default is ‘-mno-tpcs-frame’.
-mtpcs-leaf-frame
Generate a stack frame that is compliant with the Thumb Procedure Call Stan-
dard for all leaf functions. (A leaf function is one that does not call any other
functions.) The default is ‘-mno-apcs-leaf-frame’.
-mcallee-super-interworking
Gives all externally visible functions in the file being compiled an ARM in-
struction set header which switches to Thumb mode before executing the rest
of the function. This allows these functions to be called from non-interworking
code. This option is not valid in AAPCS configurations because interworking
is enabled by default.
-mcaller-super-interworking
Allows calls via function pointers (including virtual functions) to execute cor-
rectly regardless of whether the target code has been compiled for interworking
or not. There is a small overhead in the cost of executing a function pointer
if this option is enabled. This option is not valid in AAPCS configurations
because interworking is enabled by default.
-mtp=name
Specify the access model for the thread local storage pointer. The valid models
are ‘soft’, which generates calls to __aeabi_read_tp, ‘cp15’, which fetches the
332 Using the GNU Compiler Collection (GCC)
thread pointer from cp15 directly (supported in the arm6k architecture), and
‘auto’, which uses the best available method for the selected processor. The
default setting is ‘auto’.
-mtls-dialect=dialect
Specify the dialect to use for accessing thread local storage. Two dialects are
supported—‘gnu’ and ‘gnu2’. The ‘gnu’ dialect selects the original GNU scheme
for supporting local and global dynamic TLS models. The ‘gnu2’ dialect selects
the GNU descriptor scheme, which provides better performance for shared li-
braries. The GNU descriptor scheme is compatible with the original scheme,
but does require new assembler, linker and library support. Initial and local
exec TLS models are unaffected by this option and always use the original
scheme.
-mword-relocations
Only generate absolute relocations on word-sized values (i.e. R ARM ABS32).
This is enabled by default on targets (uClinux, SymbianOS) where the runtime
loader imposes this restriction, and when ‘-fpic’ or ‘-fPIC’ is specified. This
option conflicts with ‘-mslow-flash-data’.
-mfix-cortex-m3-ldrd
Some Cortex-M3 cores can cause data corruption when ldrd instructions
with overlapping destination and base registers are used. This option
avoids generating these instructions. This option is enabled by default when
‘-mcpu=cortex-m3’ is specified.
-mfix-cortex-a57-aes-1742098
-mno-fix-cortex-a57-aes-1742098
-mfix-cortex-a72-aes-1655431
-mno-fix-cortex-a72-aes-1655431
Enable (disable) mitigation for an erratum on Cortex-A57 and Cortex-A72 that
affects the AES cryptographic instructions. This option is enabled by default
when either ‘-mcpu=cortex-a57’ or ‘-mcpu=cortex-a72’ is specified.
-munaligned-access
-mno-unaligned-access
Enables (or disables) reading and writing of 16- and 32- bit values from ad-
dresses that are not 16- or 32- bit aligned. By default unaligned access is
disabled for all pre-ARMv6, all ARMv6-M and for ARMv8-M Baseline archi-
tectures, and enabled for all other architectures. If unaligned access is not
enabled then words in packed data structures are accessed a byte at a time.
The ARM attribute Tag_CPU_unaligned_access is set in the generated object
file to either true or false, depending upon the setting of this option. If unaligned
access is enabled then the preprocessor symbol __ARM_FEATURE_UNALIGNED is
also defined.
-mneon-for-64bits
This option is deprecated and has no effect.
Chapter 3: GCC Command Options 333
-mslow-flash-data
Assume loading data from flash is slower than fetching instruction. Therefore
literal load is minimized for better performance. This option is only supported
when compiling for ARMv7 M-profile and off by default. It conflicts with
‘-mword-relocations’.
-masm-syntax-unified
Assume inline assembler is using unified asm syntax. The default is currently off
which implies divided syntax. This option has no impact on Thumb2. However,
this may change in future releases of GCC. Divided syntax should be considered
deprecated.
-mrestrict-it
Restricts generation of IT blocks to conform to the rules of ARMv8-A. IT blocks
can only contain a single 16-bit instruction from a select set of instructions. This
option is on by default for ARMv8-A Thumb mode.
-mprint-tune-info
Print CPU tuning information as comment in assembler file. This is an option
used only for regression testing of the compiler and not intended for ordinary
use in compiling code. This option is disabled by default.
-mverbose-cost-dump
Enable verbose cost model dumping in the debug dump files. This option is
provided for use in debugging the compiler.
-mpure-code
Do not allow constant data to be placed in code sections. Additionally, when
compiling for ELF object format give all text sections the ELF processor-specific
section attribute SHF_ARM_PURECODE. This option is only available when gen-
erating non-pic code for M-profile targets.
-mcmse Generate secure code as per the "ARMv8-M Security Extensions: Require-
ments on Development Tools Engineering Specification", which can be found
on https://developer.arm.com/documentation/ecm0359818/latest/.
-mfix-cmse-cve-2021-35465
Mitigate against a potential security issue with the VLLDM instruction in some
M-profile devices when using CMSE (CVE-2021-365465). This option is enabled
by default when the option ‘-mcpu=’ is used with cortex-m33, cortex-m35p,
cortex-m55 or star-mc1. The option ‘-mno-fix-cmse-cve-2021-35465’ can
be used to disable the mitigation.
-mstack-protector-guard=guard
-mstack-protector-guard-offset=offset
Generate stack protection code using canary at guard. Supported locations
are ‘global’ for a global canary or ‘tls’ for a canary accessible via the TLS
register. The option ‘-mstack-protector-guard-offset=’ is for use with
‘-fstack-protector-guard=tls’ and not for use in user-land code.
334 Using the GNU Compiler Collection (GCC)
-mfdpic
-mno-fdpic
Select the FDPIC ABI, which uses 64-bit function descriptors to represent
pointers to functions. When the compiler is configured for arm-*-
uclinuxfdpiceabi targets, this option is on by default and implies ‘-fPIE’
if none of the PIC/PIE-related options is provided. On other targets, it only
enables the FDPIC-specific code generation features, and the user should
explicitly provide the PIC/PIE-related options as needed.
Note that static linking is not supported because it would still involve the
dynamic linker when the program self-relocates. If such behavior is acceptable,
use -static and -Wl,-dynamic-linker options.
The opposite ‘-mno-fdpic’ option is useful (and required) to build the Linux
kernel using the same (arm-*-uclinuxfdpiceabi) toolchain as the one used to
build the userland programs.
avrxmega3
“XMEGA” devices with up to 64 KiB of combined program
memory and RAM, and with program memory visible in the RAM
address space.
mcu = attiny202, attiny204, attiny212, attiny214,
attiny402, attiny404, attiny406, attiny412, attiny414,
attiny416, attiny417, attiny804, attiny806, attiny807,
attiny814, attiny816, attiny817, attiny1604, attiny1606,
attiny1607, attiny1614, attiny1616, attiny1617, attiny3214,
attiny3216, attiny3217, atmega808, atmega809, atmega1608,
atmega1609, atmega3208, atmega3209, atmega4808, atmega4809,
avr32da28, avr32da32, avr32da48, avr32db28, avr32db32,
avr32db48.
avrxmega4
“XMEGA” devices with more than 64 KiB and up to 128 KiB of
program memory.
mcu = atxmega64a3, atxmega64a3u, atxmega64a4u,
atxmega64b1, atxmega64b3, atxmega64c3, atxmega64d3,
atxmega64d4, avr128da28, avr128da32, avr128da48,
avr128da64, avr128db28, avr128db32, avr128db48, avr128db64.
avrxmega5
“XMEGA” devices with more than 64 KiB and up to 128 KiB of
program memory and more than 64 KiB of RAM.
mcu = atxmega64a1, atxmega64a1u.
avrxmega6
“XMEGA” devices with more than 128 KiB of program memory.
mcu = atxmega128a3, atxmega128a3u, atxmega128b1,
atxmega128b3, atxmega128c3, atxmega128d3, atxmega128d4,
atxmega192a3, atxmega192a3u, atxmega192c3, atxmega192d3,
atxmega256a3, atxmega256a3b, atxmega256a3bu,
atxmega256a3u, atxmega256c3, atxmega256d3, atxmega384c3,
atxmega384d3.
avrxmega7
“XMEGA” devices with more than 128 KiB of program memory
and more than 64 KiB of RAM.
mcu = atxmega128a1, atxmega128a1u, atxmega128a4u.
avr1 This ISA is implemented by the minimal AVR core and supported
for assembler only.
mcu = attiny11, attiny12, attiny15, attiny28, at90s1200.
-mabsdata
Assume that all data in static storage can be accessed by LDS / STS instruc-
tions. This option has only an effect on reduced Tiny devices like ATtiny40.
See also the absdata Section 6.34.3 [AVR Variable Attributes], page 630.
-maccumulate-args
Accumulate outgoing function arguments and acquire/release the needed stack
space for outgoing function arguments once in function prologue/epilogue.
Without this option, outgoing arguments are pushed before calling a function
and popped afterwards.
Popping the arguments after the function call can be expensive on AVR so
that accumulating the stack space might lead to smaller executables because
arguments need not be removed from the stack after such a function call.
This option can lead to reduced code size for functions that perform several
calls to functions that get their arguments on the stack like calls to printf-like
functions.
-mbranch-cost=cost
Set the branch costs for conditional branch instructions to cost. Reasonable
values for cost are small, non-negative integers. The default branch cost is 0.
-mcall-prologues
Functions prologues/epilogues are expanded as calls to appropriate subroutines.
Code size is smaller.
-mdouble=bits
-mlong-double=bits
Set the size (in bits) of the double or long double type, respectively. Possible
values for bits are 32 and 64. Whether or not a specific value for bits is allowed
depends on the --with-double= and --with-long-double= configure options,
and the same applies for the default values of the options.
-mgas-isr-prologues
Interrupt service routines (ISRs) may use the __gcc_isr pseudo instruction
supported by GNU Binutils. If this option is on, the feature can still be dis-
abled for individual ISRs by means of the Section 6.33.6 [no_gccisr], page 589
function attribute. This feature is activated per default if optimization is on
(but not with ‘-Og’, see Section 3.11 [Optimize Options], page 163), and if GNU
Binutils support PR21683.
-mint8 Assume int to be 8-bit integer. This affects the sizes of all types: a char is 1
byte, an int is 1 byte, a long is 2 bytes, and long long is 4 bytes. Please note
that this option does not conform to the C standards, but it results in smaller
code size.
338 Using the GNU Compiler Collection (GCC)
-mmain-is-OS_task
Do not save registers in main. The effect is the same like attaching attribute
Section 6.33.6 [OS_task], page 589 to main. It is activated per default if opti-
mization is on.
-mn-flash=num
Assume that the flash memory has a size of num times 64 KiB.
-mno-interrupts
Generated code is not compatible with hardware interrupts. Code size is
smaller.
-mrelax Try to replace CALL resp. JMP instruction by the shorter RCALL resp. RJMP in-
struction if applicable. Setting ‘-mrelax’ just adds the ‘--mlink-relax’ option
to the assembler’s command line and the ‘--relax’ option to the linker’s com-
mand line.
Jump relaxing is performed by the linker because jump offsets are not known
before code is located. Therefore, the assembler code generated by the compiler
is the same, but the instructions in the executable may differ from instructions
in the assembler code.
Relaxing must be turned on if linker stubs are needed, see the section on EIND
and linker stubs below.
-mrmw Assume that the device supports the Read-Modify-Write instructions XCH, LAC,
LAS and LAT.
-mshort-calls
Assume that RJMP and RCALL can target the whole program memory.
This option is used internally for multilib selection. It is not an optimization
option, and you don’t need to set it by hand.
-msp8 Treat the stack pointer register as an 8-bit register, i.e. assume the high byte of
the stack pointer is zero. In general, you don’t need to set this option by hand.
This option is used internally by the compiler to select and build multilibs
for architectures avr2 and avr25. These architectures mix devices with and
without SPH. For any setting other than ‘-mmcu=avr2’ or ‘-mmcu=avr25’ the
compiler driver adds or removes this option from the compiler proper’s com-
mand line, because the compiler then knows if the device or architecture has
an 8-bit stack pointer and thus no SPH register or not.
-mstrict-X
Use address register X in a way proposed by the hardware. This means that X
is only used in indirect, post-increment or pre-decrement addressing.
Without this option, the X register may be used in the same way as Y or Z which
then is emulated by additional instructions. For example, loading a value with
X+const addressing with a small non-negative const < 64 to a register Rn is
performed as
adiw r26, const ; X += const
ld Rn, X ; Rn = *X
sbiw r26, const ; X -= const
Chapter 3: GCC Command Options 339
-mtiny-stack
Only change the lower 8 bits of the stack pointer.
-mfract-convert-truncate
Allow to use truncation instead of rounding towards zero for fractional fixed-
point types.
-nodevicelib
Don’t link against AVR-LibC’s device specific library lib<mcu>.a.
-nodevicespecs
Don’t add ‘-specs=device-specs/specs-mcu’ to the compiler driver’s com-
mand line. The user takes responsibility for supplying the sub-processes like
compiler proper, assembler and linker with appropriate command line options.
This means that the user has to supply her private device specs file by means of
‘-specs=path-to-specs-file’. There is no more need for option ‘-mmcu=mcu’.
This option can also serve as a replacement for the older way of specifying
custom device-specs files that needed ‘-B some-path’ to point to a directory
which contains a folder named device-specs which contains a specs file named
specs-mcu, where mcu was specified by ‘-mmcu=mcu’.
-Waddr-space-convert
Warn about conversions between address spaces in the case where the resulting
address space is not contained in the incoming address space.
-Wmisspelled-isr
Warn if the ISR is misspelled, i.e. without vector prefix. Enabled by default.
3.19.6.1 EIND and Devices with More Than 128 Ki Bytes of Flash
Pointers in the implementation are 16 bits wide. The address of a function or label is
represented as word address so that indirect jumps and calls can target any code address
in the range of 64 Ki words.
In order to facilitate indirect jump on devices with more than 128 Ki bytes of program
memory space, there is a special function register called EIND that serves as most significant
part of the target address when EICALL or EIJMP instructions are used.
Indirect jumps and calls on these devices are handled as follows by the compiler and are
subject to some limitations:
• The compiler never sets EIND.
• The compiler uses EIND implicitly in EICALL/EIJMP instructions or might read EIND
directly in order to emulate an indirect call/jump by means of a RET instruction.
• The compiler assumes that EIND never changes during the startup code or during the
application. In particular, EIND is not saved/restored in function or interrupt service
routine prologue/epilogue.
• For indirect calls to functions and computed goto, the linker generates stubs. Stubs are
jump pads sometimes also called trampolines. Thus, the indirect call/jump jumps to
such a stub. The stub contains a direct jump to the desired address.
• Linker relaxation must be turned on so that the linker generates the stubs correctly
in all situations. See the compiler option ‘-mrelax’ and the linker option ‘--relax’.
340 Using the GNU Compiler Collection (GCC)
There are corner cases where the linker is supposed to generate stubs but aborts without
relaxation and without a helpful error message.
• The default linker script is arranged for code with EIND = 0. If code is supposed to
work for a setup with EIND != 0, a custom linker script has to be used in order to place
the sections whose name start with .trampolines into the segment where EIND points
to.
• The startup code from libgcc never sets EIND. Notice that startup code is a blend
of code from libgcc and AVR-LibC. For the impact of AVR-LibC on EIND, see the
AVR-LibC user manual.
• It is legitimate for user-specific startup code to set up EIND early, for example by means
of initialization code located in section .init3. Such code runs prior to general startup
code that initializes RAM and calls constructors, but after the bit of startup code from
AVR-LibC that sets EIND to the segment where the vector table is located.
#include <avr/io.h>
static void
__attribute__((section(".init3"),naked,used,no_instrument_function))
init3_set_eind (void)
{
__asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
"out %i0,r24" :: "n" (&EIND) : "r24","memory");
}
The __trampolines_start symbol is defined in the linker script.
• Stubs are generated automatically by the linker if the following two conditions are met:
− The address of a label is taken by means of the gs modifier (short for generate
stubs) like so:
LDI r24, lo8(gs(func))
LDI r25, hi8(gs(func))
− The final location of that label is in a code segment outside the segment where the
stubs are located.
• The compiler emits such gs modifiers for code labels in the following situations:
− Taking address of a function or code label.
− Computed goto.
− If prologue-save function is used, see ‘-mcall-prologues’ command-line option.
− Switch/case dispatch tables. If you do not want such dispatch tables you can
specify the ‘-fno-jump-tables’ command-line option.
− C and C++ constructors/destructors called during startup/shutdown.
− If the tools hit a gs() modifier explained above.
• Jumping to non-symbolic addresses like so is not supported:
int main (void)
{
/* Call function at word address 0x2 */
return ((int(*)(void)) 0x2)();
Chapter 3: GCC Command Options 341
}
Instead, a stub has to be set up, i.e. the function has to be called through a symbol
(func_4 in the example):
int main (void)
{
extern int func_4 (void);
__AVR_HAVE_8BIT_SP__
__AVR_HAVE_16BIT_SP__
The stack pointer (SP) register is treated as 8-bit respectively 16-bit register
by the compiler. The definition of these macros is affected by ‘-mtiny-stack’.
__AVR_HAVE_SPH__
__AVR_SP8__
The device has the SPH (high part of stack pointer) special function register
or has an 8-bit stack pointer, respectively. The definition of these macros is
affected by ‘-mmcu=’ and in the cases of ‘-mmcu=avr2’ and ‘-mmcu=avr25’ also
by ‘-msp8’.
__AVR_HAVE_RAMPD__
__AVR_HAVE_RAMPX__
__AVR_HAVE_RAMPY__
__AVR_HAVE_RAMPZ__
The device has the RAMPD, RAMPX, RAMPY, RAMPZ special function register, re-
spectively.
__NO_INTERRUPTS__
This macro reflects the ‘-mno-interrupts’ command-line option.
__AVR_ERRATA_SKIP__
__AVR_ERRATA_SKIP_JMP_CALL__
Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit instructions
because of a hardware erratum. Skip instructions are SBRS, SBRC, SBIS, SBIC
and CPSE. The second macro is only defined if __AVR_HAVE_JMP_CALL__ is also
set.
__AVR_ISA_RMW__
The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
__AVR_SFR_OFFSET__=offset
Instructions that can address I/O special function registers directly like IN, OUT,
SBI, etc. may use a different address as if addressed by an instruction to access
RAM like LD or STS. This offset depends on the device architecture and has to
be subtracted from the RAM address in order to get the respective I/O address.
__AVR_SHORT_CALLS__
The ‘-mshort-calls’ command line option is set.
__AVR_PM_BASE_ADDRESS__=addr
Some devices support reading from flash memory by means of LD* instructions.
The flash memory is seen in the data address space at an offset of __AVR_PM_
BASE_ADDRESS__. If this macro is not defined, this feature is not available. If
defined, the address space is linear and there is no need to put .rodata into
RAM. This is handled by the default linker description file, and is currently
available for avrtiny and avrxmega3. Even more convenient, there is no need
to use address spaces like __flash or features like attribute progmem and pgm_
read_*.
344 Using the GNU Compiler Collection (GCC)
__WITH_AVRLIBC__
The compiler is configured to be used together with AVR-Libc. See the
‘--with-avrlibc’ configure option.
__HAVE_DOUBLE_MULTILIB__
Defined if ‘-mdouble=’ acts as a multilib option.
__HAVE_DOUBLE32__
__HAVE_DOUBLE64__
Defined if the compiler supports 32-bit double resp. 64-bit double. The actual
layout is specified by option ‘-mdouble=’.
__DEFAULT_DOUBLE__
The size in bits of double if ‘-mdouble=’ is not set. To test the layout of double
in a program, use the built-in macro __SIZEOF_DOUBLE__.
__HAVE_LONG_DOUBLE32__
__HAVE_LONG_DOUBLE64__
__HAVE_LONG_DOUBLE_MULTILIB__
__DEFAULT_LONG_DOUBLE__
Same as above, but for long double instead of double.
__WITH_DOUBLE_COMPARISON__
Reflects the --with-double-comparison={tristate|bool|libf7}
configure option and is defined to 2 or 3.
__WITH_LIBF7_LIBGCC__
__WITH_LIBF7_MATH__
__WITH_LIBF7_MATH_SYMBOLS__
Reflects the --with-libf7={libgcc|math|math-symbols} configure option.
-mno-leaf-id-shared-library
Do not assume that the code being compiled won’t link against any ID shared
libraries. Slower code is generated for jump and call insns.
-mshared-library-id=n
Specifies the identification number of the ID-based shared library being com-
piled. Specifying a value of 0 generates more compact code; specifying other
values forces the allocation of that number to the current library but is no more
space- or time-efficient than omitting this option.
-msep-data
Generate code that allows the data segment to be located in a different area of
memory from the text segment. This allows for execute in place in an environ-
ment without virtual memory management by eliminating relocations against
the text section.
-mno-sep-data
Generate code that assumes that the data segment follows the text segment.
This is the default.
-mlong-calls
-mno-long-calls
Tells the compiler to perform function calls by first loading the address of the
function into a register and then performing a subroutine call on this register.
This switch is needed if the target function lies outside of the 24-bit addressing
range of the offset-based version of subroutine call instruction.
This feature is not enabled by default. Specifying ‘-mno-long-calls’ restores
the default behavior. Note these switches have no effect on how the compiler
generates code to handle function calls via function pointers.
-mfast-fp
Link with the fast floating-point library. This library relaxes some of the
IEEE floating-point standard’s rules for checking inputs against Not-a-Number
(NAN), in the interest of performance.
-minline-plt
Enable inlining of PLT entries in function calls to functions that are not known
to bind locally. It has no effect without ‘-mfdpic’.
-mmulticore
Build a standalone application for multicore Blackfin processors. This
option causes proper start files and link scripts supporting multicore to be
used, and defines the macro __BFIN_MULTICORE. It can only be used with
‘-mcpu=bf561[-sirevision]’.
This option can be used with ‘-mcorea’ or ‘-mcoreb’, which selects the one-
application-per-core programming model. Without ‘-mcorea’ or ‘-mcoreb’, the
single-application/dual-core programming model is used. In this model, the
main function of Core B should be named as coreb_main.
If this option is not used, the single-core application programming model is
used.
Chapter 3: GCC Command Options 347
-mcorea Build a standalone application for Core A of BF561 when using the one-
application-per-core programming model. Proper start files and link scripts
are used to support Core A, and the macro __BFIN_COREA is defined. This
option can only be used in conjunction with ‘-mmulticore’.
-mcoreb Build a standalone application for Core B of BF561 when using the
one-application-per-core programming model. Proper start files and link
scripts are used to support Core B, and the macro __BFIN_COREB is defined.
When this option is used, coreb_main should be used instead of main. This
option can only be used in conjunction with ‘-mmulticore’.
-msdram Build a standalone application for SDRAM. Proper start files and link scripts
are used to put the application into SDRAM, and the macro __BFIN_SDRAM is
defined. The loader should initialize SDRAM before loading the application.
-micplb Assume that ICPLBs are enabled at run time. This has an effect on certain
anomaly workarounds. For Linux targets, the default is to assume ICPLBs are
enabled; for standalone applications the default is off.
-mbig-endian
Generate code for a big-endian target.
-mlittle-endian
Generate code for a little-endian target. This is the default.
-msim Choose startup files and linker script suitable for the simulator.
-msdata=default
Put small global and static data in the .neardata section, which is pointed
to by register B14. Put small uninitialized global and static data in the .bss
section, which is adjacent to the .neardata section. Put small read-only data
into the .rodata section. The corresponding sections used for large pieces of
data are .fardata, .far and .const.
-msdata=all
Put all data, not just small objects, into the sections reserved for small data,
and use addressing relative to the B14 register to access them.
-msdata=none
Make no use of the sections reserved for small data, and use absolute addresses
to access all data. Put all initialized global and static data in the .fardata
section, and all uninitialized data in the .far section. Put all constant data
into the .const section.
348 Using the GNU Compiler Collection (GCC)
-march=architecture-type
-mcpu=architecture-type
Generate code for the specified architecture. The choices for architecture-
type are ‘v3’, ‘v8’ and ‘v10’ for respectively ETRAX 4, ETRAX 100, and
ETRAX 100 LX. Default is ‘v0’.
-mtune=architecture-type
Tune to architecture-type everything applicable about the generated code,
except for the ABI and the set of available instructions. The choices for
architecture-type are the same as for ‘-march=architecture-type’.
-mmax-stack-frame=n
Warn when the stack frame of a function exceeds n bytes.
-metrax4
-metrax100
The options ‘-metrax4’ and ‘-metrax100’ are synonyms for ‘-march=v3’ and
‘-march=v8’ respectively.
-mmul-bug-workaround
-mno-mul-bug-workaround
Work around a bug in the muls and mulu instructions for CPU models where
it applies. This option is disabled by default.
-mpdebug Enable CRIS-specific verbose debug-related information in the assembly code.
This option also has the effect of turning off the ‘#NO_APP’ formatted-code
indicator to the assembler at the beginning of the assembly file.
-mcc-init
Do not use condition-code results from previous instruction; always emit com-
pare and test instructions before use of condition codes.
-mno-side-effects
Do not emit instructions with side effects in addressing modes other than post-
increment.
-mstack-align
-mno-stack-align
-mdata-align
-mno-data-align
-mconst-align
-mno-const-align
These options (‘no-’ options) arrange (eliminate arrangements) for the stack
frame, individual data and constants to be aligned for the maximum single
data access size for the chosen CPU model. The default is to arrange for 32-
bit alignment. ABI details such as structure layout are not affected by these
options.
Chapter 3: GCC Command Options 349
-m32-bit
-m16-bit
-m8-bit Similar to the stack- data- and const-align options above, these options arrange
for stack frame, writable data and constants to all be 32-bit, 16-bit or 8-bit
aligned. The default is 32-bit alignment.
-mno-prologue-epilogue
-mprologue-epilogue
With ‘-mno-prologue-epilogue’, the normal function prologue and epilogue
which set up the stack frame are omitted and no return instructions or return
sequences are generated in the code. Use this option only together with visual
inspection of the compiled code: no warnings or errors are generated when
call-saved registers must be saved, or storage for local variables needs to be
allocated.
-melf Legacy no-op option.
-sim This option arranges to link with input-output functions from a simulator li-
brary. Code, initialized data and zero-initialized data are allocated consecu-
tively.
-sim2 Like ‘-sim’, but pass linker options to locate initialized data at 0x40000000 and
zero-initialized data at 0x80000000.
-mcpu=cpu
Specify the C-SKY target processor. Valid values for cpu are: ‘ck801’,
‘ck801t’, ‘ck802’, ‘ck802t’, ‘ck802j’, ‘ck803’, ‘ck803h’, ‘ck803t’, ‘ck803ht’,
‘ck803f’, ‘ck803fh’, ‘ck803e’, ‘ck803eh’, ‘ck803et’, ‘ck803eht’, ‘ck803ef’,
‘ck803efh’, ‘ck803ft’, ‘ck803eft’, ‘ck803efht’, ‘ck803r1’, ‘ck803hr1’,
‘ck803tr1’, ‘ck803htr1’, ‘ck803fr1’, ‘ck803fhr1’, ‘ck803er1’, ‘ck803ehr1’,
‘ck803etr1’, ‘ck803ehtr1’, ‘ck803efr1’, ‘ck803efhr1’, ‘ck803ftr1’,
‘ck803eftr1’, ‘ck803efhtr1’, ‘ck803s’, ‘ck803st’, ‘ck803se’, ‘ck803sf’,
‘ck803sef’, ‘ck803seft’, ‘ck807e’, ‘ck807ef’, ‘ck807’, ‘ck807f’, ‘ck810e’,
‘ck810et’, ‘ck810ef’, ‘ck810eft’, ‘ck810’, ‘ck810v’, ‘ck810f’, ‘ck810t’,
‘ck810fv’, ‘ck810tv’, ‘ck810ft’, and ‘ck810ftv’.
-mbig-endian
-EB
-mlittle-endian
-EL
Select big- or little-endian code. The default is little-endian.
-mfloat-abi=name
Specifies which floating-point ABI to use. Permissible values are: ‘soft’,
‘softfp’ and ‘hard’.
Specifying ‘soft’ causes GCC to generate output containing library calls for
floating-point operations. ‘softfp’ allows the generation of code using hard-
ware floating-point instructions, but still uses the soft-float calling conventions.
‘hard’ allows generation of floating-point instructions and uses FPU-specific
calling conventions.
The default depends on the specific target configuration. Note that the hard-
float and soft-float ABIs are not link-compatible; you must compile your entire
program with the same ABI, and link with a compatible set of libraries.
-mhard-float
-msoft-float
Select hardware or software floating-point implementations. The default is soft
float.
-mdouble-float
-mno-double-float
When ‘-mhard-float’ is in effect, enable generation of double-precision float
instructions. This is the default except when compiling for CK803.
-mfdivdu
-mno-fdivdu
When ‘-mhard-float’ is in effect, enable generation of frecipd, fsqrtd, and
fdivd instructions. This is the default except when compiling for CK803.
-mfpu=fpu
Select the floating-point processor. This option can only be used
with ‘-mhard-float’. Values for fpu are ‘fpv2_sf’ (equivalent to
‘-mno-double-float -mno-fdivdu’), ‘fpv2’ (‘-mdouble-float -mno-divdu’),
and ‘fpv2_divd’ (‘-mdouble-float -mdivdu’).
Chapter 3: GCC Command Options 351
-melrw
-mno-elrw
Enable the extended lrw instruction. This option defaults to on for CK801 and
off otherwise.
-mistack
-mno-istack
Enable interrupt stack instructions; the default is off.
The ‘-mistack’ option is required to handle the interrupt and isr function
attributes (see Section 6.33.10 [C-SKY Function Attributes], page 592).
-mmp Enable multiprocessor instructions; the default is off.
-mcp Enable coprocessor instructions; the default is off.
-mcache Enable coprocessor instructions; the default is off.
-msecurity
Enable C-SKY security instructions; the default is off.
-mtrust Enable C-SKY trust instructions; the default is off.
-mdsp
-medsp
-mvdsp Enable C-SKY DSP, Enhanced DSP, or Vector DSP instructions, respectively.
All of these options default to off.
-mdiv
-mno-div Generate divide instructions. Default is off.
-msmart
-mno-smart
Generate code for Smart Mode, using only registers numbered 0-7 to allow use of
16-bit instructions. This option is ignored for CK801 where this is the required
behavior, and it defaults to on for CK802. For other targets, the default is off.
-mhigh-registers
-mno-high-registers
Generate code using the high registers numbered 16-31. This option is not
supported on CK801, CK802, or CK803, and is enabled by default for other
processors.
-manchor
-mno-anchor
Generate code using global anchor symbol addresses.
-mpushpop
-mno-pushpop
Generate code using push and pop instructions. This option defaults to on.
-mmultiple-stld
-mstm
-mno-multiple-stld
-mno-stm Generate code using stm and ldm instructions. This option isn’t supported on
CK801 but is enabled by default on other processors.
352 Using the GNU Compiler Collection (GCC)
-mconstpool
-mno-constpool
Create constant pools in the compiler instead of deferring it to the assembler.
This option is the default and required for correct code generation on CK801
and CK802, and is optional on other processors.
-mstack-size
-mno-stack-size
Emit .stack_size directives for each function in the assembly output. This
option defaults to off.
-mccrt
-mno-ccrt
Generate code for the C-SKY compiler runtime instead of libgcc. This option
defaults to off.
-mbranch-cost=n
Set the branch costs to roughly n instructions. The default is 1.
-msched-prolog
-mno-sched-prolog
Permit scheduling of function prologue and epilogue sequences. Using this
option can result in code that is not compliant with the C-SKY V2 ABI prologue
requirements and that cannot be debugged or backtraced. It is disabled by
default.
-msim Links the library libsemi.a which is in compatible with simulator. Applicable
to ELF compiler only.
switch may require recompiling all other modules in a program, including sys-
tem libraries. Use this switch to conform to a non-default data model.
-mfix-and-continue
-ffix-and-continue
-findirect-data
Generate code suitable for fast turnaround development, such as to
allow GDB to dynamically load ‘.o’ files into already-running programs.
‘-findirect-data’ and ‘-ffix-and-continue’ are provided for backwards
compatibility.
-all_load
Loads all members of static archive libraries. See man ld(1) for more informa-
tion.
-arch_errors_fatal
Cause the errors having to do with files that have the wrong architecture to be
fatal.
-bind_at_load
Causes the output file to be marked such that the dynamic linker will bind all
undefined references when the file is loaded or launched.
-bundle Produce a Mach-o bundle format file. See man ld(1) for more information.
-bundle_loader executable
This option specifies the executable that will load the build output file being
linked. See man ld(1) for more information.
-dynamiclib
When passed this option, GCC produces a dynamic library instead of an exe-
cutable when linking, using the Darwin ‘libtool’ command.
-force_cpusubtype_ALL
This causes GCC’s output file to have the ‘ALL’ subtype, instead of one con-
trolled by the ‘-mcpu’ or ‘-march’ option.
-allowable_client client_name
-client_name
-compatibility_version
-current_version
-dead_strip
-dependency-file
-dylib_file
-dylinker_install_name
-dynamic
-exported_symbols_list
-filelist
Chapter 3: GCC Command Options 355
-flat_namespace
-force_flat_namespace
-headerpad_max_install_names
-image_base
-init
-install_name
-keep_private_externs
-multi_module
-multiply_defined
-multiply_defined_unused
-noall_load
-no_dead_strip_inits_and_terms
-nofixprebinding
-nomultidefs
-noprebind
-noseglinkedit
-pagezero_size
-prebind
-prebind_all_twolevel_modules
-private_bundle
-read_only_relocs
-sectalign
-sectobjectsymbols
-whyload
-seg1addr
-sectcreate
-sectobjectsymbols
-sectorder
-segaddr
-segs_read_only_addr
-segs_read_write_addr
-seg_addr_table
-seg_addr_table_filename
-seglinkedit
-segprot
-segs_read_only_addr
-segs_read_write_addr
-single_module
-static
-sub_library
356 Using the GNU Compiler Collection (GCC)
-sub_umbrella
-twolevel_namespace
-umbrella
-undefined
-unexported_symbols_list
-weak_reference_mismatches
-whatsloaded
These options are passed to the Darwin linker. The Darwin linker man page
describes them in detail.
-mno-soft-float
-msoft-float
Use (do not use) the hardware floating-point instructions for floating-point op-
erations. When ‘-msoft-float’ is specified, functions in ‘libgcc.a’ are used
to perform floating-point operations. Unless they are replaced by routines that
emulate the floating-point operations, or compiled in such a way as to call such
emulations routines, these routines issue floating-point operations. If you are
compiling for an Alpha without floating-point operations, you must ensure that
the library is built so as not to call them.
Note that Alpha implementations without floating-point operations are required
to have floating-point registers.
-mfp-reg
-mno-fp-regs
Generate code that uses (does not use) the floating-point register set.
‘-mno-fp-regs’ implies ‘-msoft-float’. If the floating-point register set is
not used, floating-point operands are passed in integer registers as if they were
integers and floating-point results are passed in $0 instead of $f0. This is a
non-standard calling sequence, so any function with a floating-point argument
or return value called by code compiled with ‘-mno-fp-regs’ must also be
compiled with that option.
A typical use of this option is building a kernel that does not use, and hence
need not save and restore, any floating-point registers.
-mieee The Alpha architecture implements floating-point hardware optimized for max-
imum performance. It is mostly compliant with the IEEE floating-point stan-
dard. However, for full compliance, software assistance is required. This option
generates code fully IEEE-compliant code except that the inexact-flag is not
maintained (see below). If this option is turned on, the preprocessor macro
_IEEE_FP is defined during compilation. The resulting code is less efficient but
is able to correctly support denormalized numbers and exceptional IEEE values
such as not-a-number and plus/minus infinity. Other Alpha compilers call this
option ‘-ieee_with_no_inexact’.
Chapter 3: GCC Command Options 357
-mieee-with-inexact
This is like ‘-mieee’ except the generated code also maintains the IEEE inexact-
flag. Turning on this option causes the generated code to implement fully-
compliant IEEE math. In addition to _IEEE_FP, _IEEE_FP_EXACT is defined as
a preprocessor macro. On some Alpha implementations the resulting code may
execute significantly slower than the code generated by default. Since there is
very little code that depends on the inexact-flag, you should normally not spec-
ify this option. Other Alpha compilers call this option ‘-ieee_with_inexact’.
-mfp-trap-mode=trap-mode
This option controls what floating-point related traps are enabled. Other Alpha
compilers call this option ‘-fptm trap-mode’. The trap mode can be set to one
of four values:
‘n’ This is the default (normal) setting. The only traps that are en-
abled are the ones that cannot be disabled in software (e.g., division
by zero trap).
‘u’ In addition to the traps enabled by ‘n’, underflow traps are enabled
as well.
‘su’ Like ‘u’, but the instructions are marked to be safe for software
completion (see Alpha architecture manual for details).
‘sui’ Like ‘su’, but inexact traps are enabled as well.
-mfp-rounding-mode=rounding-mode
Selects the IEEE rounding mode. Other Alpha compilers call this option ‘-fprm
rounding-mode’. The rounding-mode can be one of:
‘n’ Normal IEEE rounding mode. Floating-point numbers are rounded
towards the nearest machine number or towards the even machine
number in case of a tie.
‘m’ Round towards minus infinity.
‘c’ Chopped rounding mode. Floating-point numbers are rounded to-
wards zero.
‘d’ Dynamic rounding mode. A field in the floating-point control reg-
ister (fpcr, see Alpha architecture reference manual) controls the
rounding mode in effect. The C library initializes this register for
rounding towards plus infinity. Thus, unless your program modifies
the fpcr, ‘d’ corresponds to round towards plus infinity.
-mtrap-precision=trap-precision
In the Alpha architecture, floating-point traps are imprecise. This means with-
out software assistance it is impossible to recover from a floating trap and
program execution normally needs to be terminated. GCC can generate code
that can assist operating system trap handlers in determining the exact loca-
tion that caused a floating-point trap. Depending on the requirements of an
application, different levels of precisions can be selected:
358 Using the GNU Compiler Collection (GCC)
‘p’ Program precision. This option is the default and means a trap
handler can only identify which program caused a floating-point
exception.
‘f’ Function precision. The trap handler can determine the function
that caused a floating-point exception.
‘i’ Instruction precision. The trap handler can determine the exact
instruction that caused a floating-point exception.
Other Alpha compilers provide the equivalent options called ‘-scope_safe’ and
‘-resumption_safe’.
-mieee-conformant
This option marks the generated code as IEEE conformant. You must not
use this option unless you also specify ‘-mtrap-precision=i’ and either
‘-mfp-trap-mode=su’ or ‘-mfp-trap-mode=sui’. Its only effect is to emit the
line ‘.eflag 48’ in the function prologue of the generated assembly file.
-mbuild-constants
Normally GCC examines a 32- or 64-bit integer constant to see if it can construct
it from smaller constants in two or three instructions. If it cannot, it outputs
the constant as a literal and generates code to load it from the data segment
at run time.
Use this option to require GCC to construct all integer constants using code,
even if it takes more instructions (the maximum is six).
You typically use this option to build a shared library dynamic loader. Itself a
shared library, it must relocate itself in memory before it can find the variables
and constants in its own data segment.
-mbwx
-mno-bwx
-mcix
-mno-cix
-mfix
-mno-fix
-mmax
-mno-max Indicate whether GCC should generate code to use the optional BWX, CIX, FIX
and MAX instruction sets. The default is to use the instruction sets supported
by the CPU type specified via ‘-mcpu=’ option or that of the CPU on which
GCC was built if none is specified.
-mfloat-vax
-mfloat-ieee
Generate code that uses (does not use) VAX F and G floating-point arithmetic
instead of IEEE single and double precision.
-mexplicit-relocs
-mno-explicit-relocs
Older Alpha assemblers provided no way to generate symbol relocations except
via assembler macros. Use of these macros does not allow optimal instruction
Chapter 3: GCC Command Options 359
scheduling. GNU binutils as of version 2.12 supports a new syntax that al-
lows the compiler to explicitly mark which relocations should apply to which
instructions. This option is mostly useful for debugging, as GCC detects the
capabilities of the assembler when it is built and sets the default accordingly.
-msmall-data
-mlarge-data
When ‘-mexplicit-relocs’ is in effect, static data is accessed via gp-relative
relocations. When ‘-msmall-data’ is used, objects 8 bytes long or smaller are
placed in a small data area (the .sdata and .sbss sections) and are accessed
via 16-bit relocations off of the $gp register. This limits the size of the small
data area to 64KB, but allows the variables to be directly accessed via a single
instruction.
The default is ‘-mlarge-data’. With this option the data area is limited to just
below 2GB. Programs that require more than 2GB of data must use malloc or
mmap to allocate the data in the heap instead of in the program’s data segment.
When generating code for shared libraries, ‘-fpic’ implies ‘-msmall-data’ and
‘-fPIC’ implies ‘-mlarge-data’.
-msmall-text
-mlarge-text
When ‘-msmall-text’ is used, the compiler assumes that the code of the entire
program (or shared library) fits in 4MB, and is thus reachable with a branch in-
struction. When ‘-msmall-data’ is used, the compiler can assume that all local
symbols share the same $gp value, and thus reduce the number of instructions
required for a function call from 4 to 1.
The default is ‘-mlarge-text’.
-mcpu=cpu_type
Set the instruction set and instruction scheduling parameters for machine type
cpu type. You can specify either the ‘EV’ style name or the corresponding chip
number. GCC supports scheduling parameters for the EV4, EV5 and EV6
family of processors and chooses the default values for the instruction set from
the processor you specify. If you do not specify a processor type, GCC defaults
to the processor on which the compiler was built.
Supported values for cpu type are
‘ev4’
‘ev45’
‘21064’ Schedules as an EV4 and has no instruction set extensions.
‘ev5’
‘21164’ Schedules as an EV5 and has no instruction set extensions.
‘ev56’
‘21164a’ Schedules as an EV5 and supports the BWX extension.
‘pca56’
‘21164pc’
‘21164PC’ Schedules as an EV5 and supports the BWX and MAX extensions.
360 Using the GNU Compiler Collection (GCC)
‘ev6’
‘21264’ Schedules as an EV6 and supports the BWX, FIX, and MAX ex-
tensions.
‘ev67’
‘21264a’ Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX
extensions.
Native toolchains also support the value ‘native’, which selects the best ar-
chitecture option for the host processor. ‘-mcpu=native’ has no effect if GCC
does not recognize the processor.
-mtune=cpu_type
Set only the instruction scheduling parameters for machine type cpu type. The
instruction set is not changed.
Native toolchains also support the value ‘native’, which selects the best archi-
tecture option for the host processor. ‘-mtune=native’ has no effect if GCC
does not recognize the processor.
-mmemory-latency=time
Sets the latency the scheduler should assume for typical memory references
as seen by the application. This number is highly dependent on the memory
access patterns used by the application and the size of the external cache on
the machine.
Valid options for time are
‘number’ A decimal number representing clock cycles.
‘L1’
‘L2’
‘L3’
‘main’ The compiler contains estimates of the number of clock cycles for
“typical” EV4 & EV5 hardware for the Level 1, 2 & 3 caches (also
called Dcache, Scache, and Bcache), as well as to main memory.
Note that L3 is only valid for EV5.
-mbig-endian
Generate code for a big-endian target.
-mlittle-endian
Generate code for a little-endian target. This is the default.
-mjmp32 Enable 32-bit jump instructions. Enabled for CPU v3 and above.
-malu32 Enable 32-bit ALU instructions. Enabled for CPU v3 and above.
-mcpu=version
This specifies which version of the eBPF ISA to target. Newer versions may
not be supported by all kernels. The default is ‘v3’.
Supported values for version are:
‘v1’ The first stable eBPF ISA with no special features or extensions.
-mco-re Enable BPF Compile Once - Run Everywhere (CO-RE) support. Requires and
is implied by ‘-gbtf’.
-mno-co-re
Disable BPF Compile Once - Run Everywhere (CO-RE) support. BPF CO-RE
support is enabled by default when generating BTF debug information for the
BPF target.
-mxbpf Generate code for an expanded version of BPF, which relaxes some of the
restrictions imposed by the BPF architecture:
− Save and restore callee-saved registers at function entry and exit, respec-
tively.
-msmall-model
Use the small address space model. This can produce smaller code, but it does
assume that all symbolic values and addresses fit into a 20-bit range.
-mno-lsim
Assume that runtime support has been provided and so there is no need to
include the simulator library (‘libsim.a’) on the linker command line.
362 Using the GNU Compiler Collection (GCC)
-mno-double
Do not use floating-point double instructions.
-mmedia
Use media instructions.
-mno-media
Do not use media instructions.
-mmuladd
Use multiply and add/subtract instructions.
-mno-muladd
Do not use multiply and add/subtract instructions.
-mfdpic
Select the FDPIC ABI, which uses function descriptors to represent pointers
to functions. Without any PIC/PIE-related options, it implies ‘-fPIE’. With
‘-fpic’ or ‘-fpie’, it assumes GOT entries and small data are within a 12-bit
range from the GOT base address; with ‘-fPIC’ or ‘-fPIE’, GOT offsets are
computed with 32 bits. With a ‘bfin-elf’ target, this option implies ‘-msim’.
-minline-plt
Enable inlining of PLT entries in function calls to functions that are not known
to bind locally. It has no effect without ‘-mfdpic’. It’s enabled by default if
optimizing for speed and compiling for shared libraries (i.e., ‘-fPIC’ or ‘-fpic’),
or when an optimization option such as ‘-O3’ or above is present in the command
line.
-mTLS
Assume a large TLS segment when generating thread-local code.
-mtls
Do not assume a large TLS segment when generating thread-local code.
-mgprel-ro
Enable the use of GPREL relocations in the FDPIC ABI for data that is known to
be in read-only sections. It’s enabled by default, except for ‘-fpic’ or ‘-fpie’:
even though it may help make the global offset table smaller, it trades 1 in-
struction for 4. With ‘-fPIC’ or ‘-fPIE’, it trades 3 instructions for 4, one of
which may be shared by multiple symbols, and it avoids the need for a GOT
entry for the referenced symbol, so it’s more likely to be a win. If it is not,
‘-mno-gprel-ro’ can be used to disable it.
-multilib-library-pic
Link with the (library, not FD) pic libraries. It’s implied by ‘-mlibrary-pic’,
as well as by ‘-fPIC’ and ‘-fpic’ without ‘-mfdpic’. You should never have to
use it explicitly.
-mlinked-fp
Follow the EABI requirement of always creating a frame pointer whenever a
stack frame is allocated. This option is enabled by default and can be disabled
with ‘-mno-linked-fp’.
364 Using the GNU Compiler Collection (GCC)
-mlong-calls
Use indirect addressing to call functions outside the current compilation unit.
This allows the functions to be placed anywhere within the 32-bit address space.
-malign-labels
Try to align labels to an 8-byte boundary by inserting NOPs into the previous
packet. This option only has an effect when VLIW packing is enabled. It
doesn’t create new packets; it merely adds NOPs to existing ones.
-mlibrary-pic
Generate position-independent EABI code.
-macc-4
Use only the first four media accumulator registers.
-macc-8
Use all eight media accumulator registers.
-mpack
Pack VLIW instructions.
-mno-pack
Do not pack VLIW instructions.
-mno-eflags
Do not mark ABI switches in e flags.
-mcond-move
Enable the use of conditional-move instructions (default).
This switch is mainly for debugging the compiler and will likely be removed in
a future version.
-mno-cond-move
Disable the use of conditional-move instructions.
This switch is mainly for debugging the compiler and will likely be removed in
a future version.
-mscc
Enable the use of conditional set instructions (default).
This switch is mainly for debugging the compiler and will likely be removed in
a future version.
-mno-scc
Disable the use of conditional set instructions.
This switch is mainly for debugging the compiler and will likely be removed in
a future version.
-mcond-exec
Enable the use of conditional execution (default).
This switch is mainly for debugging the compiler and will likely be removed in
a future version.
Chapter 3: GCC Command Options 365
-mno-cond-exec
Disable the use of conditional execution.
This switch is mainly for debugging the compiler and will likely be removed in
a future version.
-mvliw-branch
Run a pass to pack branches into VLIW instructions (default).
This switch is mainly for debugging the compiler and will likely be removed in
a future version.
-mno-vliw-branch
Do not run a pass to pack branches into VLIW instructions.
This switch is mainly for debugging the compiler and will likely be removed in
a future version.
-mmulti-cond-exec
Enable optimization of && and || in conditional execution (default).
This switch is mainly for debugging the compiler and will likely be removed in
a future version.
-mno-multi-cond-exec
Disable optimization of && and || in conditional execution.
This switch is mainly for debugging the compiler and will likely be removed in
a future version.
-mnested-cond-exec
Enable nested conditional execution optimizations (default).
This switch is mainly for debugging the compiler and will likely be removed in
a future version.
-mno-nested-cond-exec
Disable nested conditional execution optimizations.
This switch is mainly for debugging the compiler and will likely be removed in
a future version.
-moptimize-membar
This switch removes redundant membar instructions from the compiler-
generated code. It is enabled by default.
-mno-optimize-membar
This switch disables the automatic removal of redundant membar instructions
from the generated code.
-mtomcat-stats
Cause gas to print out tomcat statistics.
-mcpu=cpu
Select the processor type for which to generate code. Possible values are ‘frv’,
‘fr550’, ‘tomcat’, ‘fr500’, ‘fr450’, ‘fr405’, ‘fr400’, ‘fr300’ and ‘simple’.
366 Using the GNU Compiler Collection (GCC)
-mlong-load-store
Generate 3-instruction load and store sequences as sometimes required by the
HP-UX 10 linker. This is equivalent to the ‘+k’ option to the HP compilers.
-mportable-runtime
Use the portable calling conventions proposed by HP for ELF systems.
-mgas Enable the use of assembler directives only GAS understands.
-mschedule=cpu-type
Schedule code according to the constraints for the machine type cpu-type. The
choices for cpu-type are ‘700’ ‘7100’, ‘7100LC’, ‘7200’, ‘7300’ and ‘8000’. Refer
to ‘/usr/lib/sched.models’ on an HP-UX system to determine the proper
scheduling option for your machine. The default scheduling is ‘8000’.
-mlinker-opt
Enable the optimization pass in the HP-UX linker. Note this makes symbolic
debugging impossible. It also triggers a bug in the HP-UX 8 and HP-UX 9
linkers in which they give bogus error messages when linking some programs.
-msoft-float
Generate output containing library calls for floating point. Warning: the req-
uisite libraries are not available for all HPPA targets. Normally the facilities of
the machine’s usual C compiler are used, but this cannot be done directly in
cross-compilation. You must make your own arrangements to provide suitable
library functions for cross-compilation.
‘-msoft-float’ changes the calling convention in the output file; therefore, it
is only useful if you compile all of a program with this option. In particu-
lar, you need to compile ‘libgcc.a’, the library that comes with GCC, with
‘-msoft-float’ in order for this to work.
-msio Generate the predefine, _SIO, for server IO. The default is ‘-mwsio’. This gen-
erates the predefines, __hp9000s700, __hp9000s700__ and _WSIO, for worksta-
tion IO. These options are available under HP-UX and HI-UX.
-mgnu-ld Use options specific to GNU ld. This passes ‘-shared’ to ld when building a
shared library. It is the default when GCC is configured, explicitly or implic-
itly, with the GNU linker. This option does not affect which ld is called; it
only changes what parameters are passed to that ld. The ld that is called is
determined by the ‘--with-ld’ configure option, GCC’s program search path,
and finally by the user’s PATH. The linker used by GCC can be printed us-
ing ‘which ‘gcc -print-prog-name=ld‘’. This option is only available on the
64-bit HP-UX GCC, i.e. configured with ‘hppa*64*-*-hpux*’.
-mhp-ld Use options specific to HP ld. This passes ‘-b’ to ld when building a shared
library and passes ‘+Accept TypeMismatch’ to ld on all links. It is the default
when GCC is configured, explicitly or implicitly, with the HP linker. This op-
tion does not affect which ld is called; it only changes what parameters are
passed to that ld. The ld that is called is determined by the ‘--with-ld’ con-
figure option, GCC’s program search path, and finally by the user’s PATH. The
linker used by GCC can be printed using ‘which ‘gcc -print-prog-name=ld‘’.
Chapter 3: GCC Command Options 369
This option is only available on the 64-bit HP-UX GCC, i.e. configured with
‘hppa*64*-*-hpux*’.
-mlong-calls
Generate code that uses long call sequences. This ensures that a call is always
able to reach linker generated stubs. The default is to generate long calls
only when the distance from the call site to the beginning of the function or
translation unit, as the case may be, exceeds a predefined limit set by the
branch type being used. The limits for normal calls are 7,600,000 and 240,000
bytes, respectively for the PA 2.0 and PA 1.X architectures. Sibcalls are always
limited at 240,000 bytes.
Distances are measured from the beginning of functions when using
the ‘-ffunction-sections’ option, or when using the ‘-mgas’ and
‘-mno-portable-runtime’ options together under HP-UX with the SOM
linker.
It is normally not desirable to use this option as it degrades performance. How-
ever, it may be useful in large applications, particularly when partial linking is
used to build the application.
The types of long calls used depends on the capabilities of the assembler and
linker, and the type of code being generated. The impact on systems that
support long absolute calls, and long pic symbol-difference or pc-relative calls
should be relatively small. However, an indirect call is used on 32-bit ELF
systems in pic code and it is quite long.
-munix=unix-std
Generate compiler predefines and select a startfile for the specified UNIX stan-
dard. The choices for unix-std are ‘93’, ‘95’ and ‘98’. ‘93’ is supported on all
HP-UX versions. ‘95’ is available on HP-UX 10.10 and later. ‘98’ is available
on HP-UX 11.11 and later. The default values are ‘93’ for HP-UX 10.00, ‘95’
for HP-UX 10.10 though to 11.00, and ‘98’ for HP-UX 11.11 and later.
‘-munix=93’ provides the same predefines as GCC 3.3 and 3.4. ‘-munix=95’
provides additional predefines for XOPEN_UNIX and _XOPEN_SOURCE_EXTENDED,
and the startfile ‘unix95.o’. ‘-munix=98’ provides additional predefines for
_XOPEN_UNIX, _XOPEN_SOURCE_EXTENDED, _INCLUDE__STDC_A1_SOURCE and _
INCLUDE_XOPEN_SOURCE_500, and the startfile ‘unix98.o’.
It is important to note that this option changes the interfaces for various library
routines. It also affects the operational behavior of the C library. Thus, extreme
care is needed in using this option.
Library code that is intended to operate with more than one UNIX standard
must test, set and restore the variable __xpg4_extended_mask as appropriate.
Most GNU software doesn’t provide this capability.
-nolibdld
Suppress the generation of link options to search libdld.sl when the ‘-static’
option is specified on HP-UX 10 and later.
370 Using the GNU Compiler Collection (GCC)
-minline-float-divide-min-latency
Generate code for inline divides of floating-point values using the minimum
latency algorithm.
-minline-float-divide-max-throughput
Generate code for inline divides of floating-point values using the maximum
throughput algorithm.
-mno-inline-float-divide
Do not generate inline code for divides of floating-point values.
-minline-int-divide-min-latency
Generate code for inline divides of integer values using the minimum latency
algorithm.
-minline-int-divide-max-throughput
Generate code for inline divides of integer values using the maximum through-
put algorithm.
-mno-inline-int-divide
Do not generate inline code for divides of integer values.
-minline-sqrt-min-latency
Generate code for inline square roots using the minimum latency algorithm.
-minline-sqrt-max-throughput
Generate code for inline square roots using the maximum throughput algorithm.
-mno-inline-sqrt
Do not generate inline code for sqrt.
-mfused-madd
-mno-fused-madd
Do (don’t) generate code that uses the fused multiply/add or multiply/subtract
instructions. The default is to use these instructions.
-mno-dwarf2-asm
-mdwarf2-asm
Don’t (or do) generate assembler code for the DWARF line number debugging
info. This may be useful when not using the GNU assembler.
-mearly-stop-bits
-mno-early-stop-bits
Allow stop bits to be placed earlier than immediately preceding the instruction
that triggered the stop bit. This can improve instruction scheduling, but does
not always do so.
-mfixed-range=register-range
Generate code treating the given register range as fixed registers. A fixed regis-
ter is one that the register allocator cannot use. This is useful when compiling
kernel code. A register range is specified as two registers separated by a dash.
Multiple register ranges can be specified separated by a comma.
-mtls-size=tls-size
Specify bit size of immediate TLS offsets. Valid values are 14, 22, and 64.
372 Using the GNU Compiler Collection (GCC)
-mtune=cpu-type
Tune the instruction scheduling for a particular CPU, Valid values are
‘itanium’, ‘itanium1’, ‘merced’, ‘itanium2’, and ‘mckinley’.
-milp32
-mlp64 Generate code for a 32-bit or 64-bit environment. The 32-bit environment sets
int, long and pointer to 32 bits. The 64-bit environment sets int to 32 bits and
long and pointer to 64 bits. These are HP-UX specific flags.
-mno-sched-br-data-spec
-msched-br-data-spec
(Dis/En)able data speculative scheduling before reload. This results in gen-
eration of ld.a instructions and the corresponding check instructions (ld.c /
chk.a). The default setting is disabled.
-msched-ar-data-spec
-mno-sched-ar-data-spec
(En/Dis)able data speculative scheduling after reload. This results in gener-
ation of ld.a instructions and the corresponding check instructions (ld.c /
chk.a). The default setting is enabled.
-mno-sched-control-spec
-msched-control-spec
(Dis/En)able control speculative scheduling. This feature is available only dur-
ing region scheduling (i.e. before reload). This results in generation of the
ld.s instructions and the corresponding check instructions chk.s. The default
setting is disabled.
-msched-br-in-data-spec
-mno-sched-br-in-data-spec
(En/Dis)able speculative scheduling of the instructions that are dependent
on the data speculative loads before reload. This is effective only with
‘-msched-br-data-spec’ enabled. The default setting is enabled.
-msched-ar-in-data-spec
-mno-sched-ar-in-data-spec
(En/Dis)able speculative scheduling of the instructions that are dependent
on the data speculative loads after reload. This is effective only with
‘-msched-ar-data-spec’ enabled. The default setting is enabled.
-msched-in-control-spec
-mno-sched-in-control-spec
(En/Dis)able speculative scheduling of the instructions that are de-
pendent on the control speculative loads. This is effective only with
‘-msched-control-spec’ enabled. The default setting is enabled.
-mno-sched-prefer-non-data-spec-insns
-msched-prefer-non-data-spec-insns
If enabled, data-speculative instructions are chosen for schedule only if there
are no other choices at the moment. This makes the use of the data speculation
much more conservative. The default setting is disabled.
Chapter 3: GCC Command Options 373
-mno-sched-prefer-non-control-spec-insns
-msched-prefer-non-control-spec-insns
If enabled, control-speculative instructions are chosen for schedule only if there
are no other choices at the moment. This makes the use of the control specu-
lation much more conservative. The default setting is disabled.
-mno-sched-count-spec-in-critical-path
-msched-count-spec-in-critical-path
If enabled, speculative dependencies are considered during computation of the
instructions priorities. This makes the use of the speculation a bit more con-
servative. The default setting is disabled.
-msched-spec-ldc
Use a simple data speculation check. This option is on by default.
-msched-control-spec-ldc
Use a simple check for control speculation. This option is on by default.
-msched-stop-bits-after-every-cycle
Place a stop bit after every cycle when scheduling. This option is on by default.
-msched-fp-mem-deps-zero-cost
Assume that floating-point stores and loads are not likely to cause a conflict
when placed into the same instruction group. This option is disabled by default.
-msel-sched-dont-check-control-spec
Generate checks for control speculation in selective scheduling. This flag is
disabled by default.
-msched-max-memory-insns=max-insns
Limit on the number of memory insns per instruction group, giving lower prior-
ity to subsequent memory insns attempting to schedule in the same instruction
group. Frequently useful to prevent cache bank conflicts. The default value is
1.
-msched-max-memory-insns-hard-limit
Makes the limit specified by ‘msched-max-memory-insns’ a hard limit, disal-
lowing more than that number in an instruction group. Otherwise, the limit
is “soft”, meaning that non-memory operations are preferred when the limit is
reached, but memory operations may still be scheduled.
-msign-extend-enabled
Enable sign extend instructions.
-muser-enabled
Enable user-defined instructions.
‘32’ Allow the use of hardware floating-point instructions for 32-bit op-
erations.
‘none’
‘0’ Prevent the use of hardware floating-point instructions.
-msoft-float
Force ‘-mfpu=none’ and prevents the use of floating-point registers for param-
eter passing. This option may change the target ABI.
-msingle-float
Force ‘-mfpu=32’ and allow the use of 32-bit floating-point registers for param-
eter passing. This option may change the target ABI.
-mdouble-float
Force ‘-mfpu=64’ and allow the use of 32/64-bit floating-point registers for
parameter passing. This option may change the target ABI.
-mbranch-cost=n
Set the cost of branches to roughly n instructions.
-mcheck-zero-division
-mno-check-zero-divison
Trap (do not trap) on integer division by zero. The default is
‘-mcheck-zero-division’ for ‘-O0’ or ‘-Og’, and ‘-mno-check-zero-division’
for other optimization levels.
-mcond-move-int
-mno-cond-move-int
Conditional moves for integral data in general-purpose registers are enabled
(disabled). The default is ‘-mcond-move-int’.
-mcond-move-float
-mno-cond-move-float
Conditional moves for floating-point registers are enabled (disabled). The de-
fault is ‘-mcond-move-float’.
-mmemcpy
-mno-memcpy
Force (do not force) the use of memcpy for non-trivial block moves. The default is
‘-mno-memcpy’, which allows GCC to inline most constant-sized copies. Setting
optimization level to ‘-Os’ also forces the use of memcpy, but ‘-mno-memcpy’
may override this behavior if explicitly specified, regardless of the order these
options on the command line.
-mstrict-align
-mno-strict-align
Avoid or allow generating memory accesses that may not be aligned on a natural
object boundary as described in the architecture specification. The default is
‘-mno-strict-align’.
-msmall-data-limit=number
Put global and static data smaller than number bytes into a special section (on
some targets). The default value is 0.
376 Using the GNU Compiler Collection (GCC)
-mmax-inline-memcpy-size=n
Inline all block moves (such as calls to memcpy or structure copies) less than or
equal to n bytes. The default value of n is 1024.
-mcmodel=code-model
Set the code model to one of:
‘tiny-static’
• local symbol and global strong symbol: The data section must
be within +/-2MiB addressing space. The text section must be
within +/-128MiB addressing space.
• global weak symbol: The got table must be within +/-2GiB
addressing space.
‘tiny’
• local symbol: The data section must be within +/-2MiB ad-
dressing space. The text section must be within +/-128MiB
addressing space.
• global symbol: The got table must be within +/-2GiB address-
ing space.
‘normal’
• local symbol: The data section must be within +/-2GiB ad-
dressing space. The text section must be within +/-128MiB
addressing space.
• global symbol: The got table must be within +/-2GiB address-
ing space.
‘large’
• local symbol: The data section must be within +/-2GiB ad-
dressing space. The text section must be within +/-128GiB
addressing space.
• global symbol: The got table must be within +/-2GiB address-
ing space.
‘extreme(Not implemented yet)’
• local symbol: The data and text section must be within +/-
8EiB addressing space.
• global symbol: The data got table must be within +/-8EiB
addressing space.
The default code model is normal.
-msim Specifies that the program will be run on the simulator. This causes an alternate
runtime library to be linked in which supports, for example, file I/O. You must
not use this option when generating programs that will run on real hardware;
you must provide your own runtime library for whatever I/O functions are
needed.
-memregs=number
Specifies the number of memory-based pseudo-registers GCC uses during code
generation. These pseudo-registers are used like real registers, so there is a
tradeoff between GCC’s ability to fit the code into available registers, and the
performance penalty of using memory instead of registers. Note that all modules
in a program must be compiled with the same value for this option. Because
of that, you must not use this option with GCC’s default runtime libraries.
-msdata=use
Put small global and static data in the small data area, and generate special
instructions to reference them.
-G num Put global and static objects less than or equal to num bytes into the small
data or BSS sections instead of the normal data or BSS sections. The default
value of num is 8. The ‘-msdata’ option must be set to one of ‘sdata’ or ‘use’
for this option to have any effect.
All modules should be compiled with the same ‘-G num’ value. Compiling with
different values of num may or may not work; if it doesn’t the linker gives an
error message—incorrect code is not generated.
-mdebug Makes the M32R-specific code in the compiler display some statistics that might
help in debugging programs.
-malign-loops
Align all loops to a 32-byte boundary.
-mno-align-loops
Do not enforce a 32-byte alignment for loops. This is the default.
-missue-rate=number
Issue number instructions per cycle. number can only be 1 or 2.
-mbranch-cost=number
number can only be 1 or 2. If it is 1 then branches are preferred over conditional
code, if it is 2, then the opposite applies.
-mflush-trap=number
Specifies the trap number to use to flush the cache. The default is 12. Valid
numbers are between 0 and 15 inclusive.
-mno-flush-trap
Specifies that the cache cannot be flushed by using a trap.
-mflush-func=name
Specifies the name of the operating system function to call to flush the cache.
The default is ‘_flush_cache’, but a function call is only used if a trap is not
available.
-mno-flush-func
Indicates that there is no OS function for flushing the cache.
-mcpu=cpu
Generate code for a specific M680x0 or ColdFire processor. The M680x0 cpus
are: ‘68000’, ‘68010’, ‘68020’, ‘68030’, ‘68040’, ‘68060’, ‘68302’, ‘68332’ and
‘cpu32’. The ColdFire cpus are given by the table below, which also classifies
the CPUs into families:
-mtune=tune
Tune the code for a particular microarchitecture within the constraints set by
‘-march’ and ‘-mcpu’. The M680x0 microarchitectures are: ‘68000’, ‘68010’,
‘68020’, ‘68030’, ‘68040’, ‘68060’ and ‘cpu32’. The ColdFire microarchitectures
are: ‘cfv1’, ‘cfv2’, ‘cfv3’, ‘cfv4’ and ‘cfv4e’.
You can also use ‘-mtune=68020-40’ for code that needs to run relatively well
on 68020, 68030 and 68040 targets. ‘-mtune=68020-60’ is similar but includes
68060 targets as well. These two options select the same tuning decisions as
‘-m68020-40’ and ‘-m68020-60’ respectively.
GCC defines the macros __mcarch and __mcarch__ when tuning for 680x0
architecture arch. It also defines mcarch unless either ‘-ansi’ or a non-GNU
‘-std’ option is used. If GCC is tuning for a range of architectures, as selected
by ‘-mtune=68020-40’ or ‘-mtune=68020-60’, it defines the macros for every
architecture in the range.
GCC also defines the macro __muarch__ when tuning for ColdFire microarchi-
tecture uarch, where uarch is one of the arguments given above.
-m68000
-mc68000 Generate output for a 68000. This is the default when the compiler is configured
for 68000-based systems. It is equivalent to ‘-march=68000’.
Use this option for microcontrollers with a 68000 or EC000 core, including the
68008, 68302, 68306, 68307, 68322, 68328 and 68356.
-m68010 Generate output for a 68010. This is the default when the compiler is configured
for 68010-based systems. It is equivalent to ‘-march=68010’.
-m68020
-mc68020 Generate output for a 68020. This is the default when the compiler is configured
for 68020-based systems. It is equivalent to ‘-march=68020’.
-m68030 Generate output for a 68030. This is the default when the compiler is configured
for 68030-based systems. It is equivalent to ‘-march=68030’.
-m68040 Generate output for a 68040. This is the default when the compiler is configured
for 68040-based systems. It is equivalent to ‘-march=68040’.
This option inhibits the use of 68881/68882 instructions that have to be em-
ulated by software on the 68040. Use this option if your 68040 does not have
code to emulate those instructions.
-m68060 Generate output for a 68060. This is the default when the compiler is configured
for 68060-based systems. It is equivalent to ‘-march=68060’.
This option inhibits the use of 68020 and 68881/68882 instructions that have
to be emulated by software on the 68060. Use this option if your 68060 does
not have code to emulate those instructions.
-mcpu32 Generate output for a CPU32. This is the default when the compiler is config-
ured for CPU32-based systems. It is equivalent to ‘-march=cpu32’.
Use this option for microcontrollers with a CPU32 or CPU32+ core, including
the 68330, 68331, 68332, 68333, 68334, 68336, 68340, 68341, 68349 and 68360.
Chapter 3: GCC Command Options 381
-m5200 Generate output for a 520X ColdFire CPU. This is the default when the com-
piler is configured for 520X-based systems. It is equivalent to ‘-mcpu=5206’,
and is now deprecated in favor of that option.
Use this option for microcontroller with a 5200 core, including the MCF5202,
MCF5203, MCF5204 and MCF5206.
-m5206e Generate output for a 5206e ColdFire CPU. The option is now deprecated in
favor of the equivalent ‘-mcpu=5206e’.
-m528x Generate output for a member of the ColdFire 528X family. The option is now
deprecated in favor of the equivalent ‘-mcpu=528x’.
-m5307 Generate output for a ColdFire 5307 CPU. The option is now deprecated in
favor of the equivalent ‘-mcpu=5307’.
-m5407 Generate output for a ColdFire 5407 CPU. The option is now deprecated in
favor of the equivalent ‘-mcpu=5407’.
-mcfv4e Generate output for a ColdFire V4e family CPU (e.g. 547x/548x). This in-
cludes use of hardware floating-point instructions. The option is equivalent to
‘-mcpu=547x’, and is now deprecated in favor of that option.
-m68020-40
Generate output for a 68040, without using any of the new instructions. This
results in code that can run relatively efficiently on either a 68020/68881 or a
68030 or a 68040. The generated code does use the 68881 instructions that are
emulated on the 68040.
The option is equivalent to ‘-march=68020’ ‘-mtune=68020-40’.
-m68020-60
Generate output for a 68060, without using any of the new instructions. This
results in code that can run relatively efficiently on either a 68020/68881 or a
68030 or a 68040. The generated code does use the 68881 instructions that are
emulated on the 68060.
The option is equivalent to ‘-march=68020’ ‘-mtune=68020-60’.
-mhard-float
-m68881 Generate floating-point instructions. This is the default for 68020 and above,
and for ColdFire devices that have an FPU. It defines the macro __HAVE_
68881__ on M680x0 targets and __mcffpu__ on ColdFire targets.
-msoft-float
Do not generate floating-point instructions; use library calls instead. This is the
default for 68000, 68010, and 68832 targets. It is also the default for ColdFire
devices that have no FPU.
-mdiv
-mno-div Generate (do not generate) ColdFire hardware divide and remainder instruc-
tions. If ‘-march’ is used without ‘-mcpu’, the default is “on” for ColdFire ar-
chitectures and “off” for M680x0 architectures. Otherwise, the default is taken
from the target CPU (either the default CPU, or the one specified by ‘-mcpu’).
For example, the default is “off” for ‘-mcpu=5206’ and “on” for ‘-mcpu=5206e’.
382 Using the GNU Compiler Collection (GCC)
-mno-strict-align
-mstrict-align
Do not (do) assume that unaligned memory references are handled by the sys-
tem.
-msep-data
Generate code that allows the data segment to be located in a different area of
memory from the text segment. This allows for execute-in-place in an environ-
ment without virtual memory management. This option implies ‘-fPIC’.
-mno-sep-data
Generate code that assumes that the data segment follows the text segment.
This is the default.
-mid-shared-library
Generate code that supports shared libraries via the library ID method. This
allows for execute-in-place and shared libraries in an environment without vir-
tual memory management. This option implies ‘-fPIC’.
-mno-id-shared-library
Generate code that doesn’t assume ID-based shared libraries are being used.
This is the default.
-mshared-library-id=n
Specifies the identification number of the ID-based shared library being com-
piled. Specifying a value of 0 generates more compact code; specifying other
values forces the allocation of that number to the current library, but is no more
space- or time-efficient than omitting this option.
-mxgot
-mno-xgot
When generating position-independent code for ColdFire, generate code that
works if the GOT has more than 8192 entries. This code is larger and slower
than code generated without this option. On M680x0 processors, this option is
not needed; ‘-fPIC’ suffices.
GCC normally uses a single instruction to load values from the GOT. While
this is relatively efficient, it only works if the GOT is smaller than about 64k.
Anything larger causes the linker to report an error such as:
relocation truncated to fit: R_68K_GOT16O foobar
If this happens, you should recompile your code with ‘-mxgot’. It should then
work with very large GOTs. However, code generated with ‘-mxgot’ is less
efficient, since it takes 4 instructions to fetch the value of a global symbol.
Note that some linkers, including newer versions of the GNU linker, can create
multiple GOTs and sort GOT entries. If you have such a linker, you should
only need to use ‘-mxgot’ when compiling a single object file that accesses more
than 8192 GOT entries. Very few do.
These options have no effect unless GCC is generating position-independent
code.
-mlong-jump-table-offsets
Use 32-bit offsets in switch tables. The default is to use 16-bit offsets.
384 Using the GNU Compiler Collection (GCC)
-mall-opts
Enables all the optional instructions—average, multiply, divide, bit operations,
leading zero, absolute difference, min/max, clip, and saturation.
-maverage
Enables the ave instruction, which computes the average of two registers.
-mbased=n
Variables of size n bytes or smaller are placed in the .based section by default.
Based variables use the $tp register as a base register, and there is a 128-byte
limit to the .based section.
-mbitops Enables the bit operation instructions—bit test (btstm), set (bsetm), clear
(bclrm), invert (bnotm), and test-and-set (tas).
-mc=name Selects which section constant data is placed in. name may be ‘tiny’, ‘near’,
or ‘far’.
-mclip Enables the clip instruction. Note that ‘-mclip’ is not useful unless you also
provide ‘-mminmax’.
-mconfig=name
Selects one of the built-in core configurations. Each MeP chip has one or more
modules in it; each module has a core CPU and a variety of coprocessors,
optional instructions, and peripherals. The MeP-Integrator tool, not part of
GCC, provides these configurations through this option; using this option is
the same as using all the corresponding command-line options. The default
configuration is ‘default’.
-mcop Enables the coprocessor instructions. By default, this is a 32-bit coprocessor.
Note that the coprocessor is normally enabled via the ‘-mconfig=’ option.
-mcop32 Enables the 32-bit coprocessor’s instructions.
-mcop64 Enables the 64-bit coprocessor’s instructions.
-mivc2 Enables IVC2 scheduling. IVC2 is a 64-bit VLIW coprocessor.
-mdc Causes constant variables to be placed in the .near section.
-mdiv Enables the div and divu instructions.
-meb Generate big-endian code.
-mel Generate little-endian code.
-mio-volatile
Tells the compiler that any variable marked with the io attribute is to be
considered volatile.
-ml Causes variables to be assigned to the .far section by default.
-mleadz Enables the leadz (leading zero) instruction.
-mm Causes variables to be assigned to the .near section by default.
-mminmax Enables the min and max instructions.
386 Using the GNU Compiler Collection (GCC)
-mxl-pattern-compare
Use pattern compare instructions.
-msmall-divides
Use table lookup optimization for small signed integer divisions.
-mxl-stack-check
This option is deprecated. Use ‘-fstack-check’ instead.
-mxl-gp-opt
Use GP-relative .sdata/.sbss sections.
-mxl-multiply-high
Use multiply high instructions for high part of 32x32 multiply.
-mxl-float-convert
Use hardware floating-point conversion instructions.
-mxl-float-sqrt
Use hardware floating-point square root instruction.
-mbig-endian
Generate code for a big-endian target.
-mlittle-endian
Generate code for a little-endian target.
-mxl-reorder
Use reorder instructions (swap and byte reversed load/store).
-mxl-mode-app-model
Select application model app-model. Valid models are
‘executable’
normal executable (default), uses startup code ‘crt0.o’.
‘xmdstub’ for use with Xilinx Microprocessor Debugger (XMD) based soft-
ware intrusive debug agent called xmdstub. This uses startup file
‘crt1.o’ and sets the start address of the program to 0x800.
‘bootstrap’
for applications that are loaded using a bootloader. This model uses
startup file ‘crt2.o’ which does not contain a processor reset vector
handler. This is suitable for transferring control on a processor reset
to the bootloader rather than the application.
‘novectors’
for applications that do not require any of the MicroBlaze vectors.
This option may be useful for applications running within a moni-
toring application. This model uses ‘crt3.o’ as a startup file.
Option ‘-xl-mode-app-model’ is a deprecated alias for ‘-mxl-mode-app-
model’.
-mpic-data-is-text-relative
Assume that the displacement between the text and data segments is fixed at
static link time. This allows data to be referenced by offset from start of text
address instead of GOT since PC-relative addressing is not supported.
388 Using the GNU Compiler Collection (GCC)
-EL Generate little-endian code. This is the default for ‘mips*el-*-*’ configura-
tions.
-march=arch
Generate code that runs on arch, which can be the name of a generic MIPS
ISA, or the name of a particular processor. The ISA names are: ‘mips1’,
‘mips2’, ‘mips3’, ‘mips4’, ‘mips32’, ‘mips32r2’, ‘mips32r3’, ‘mips32r5’,
‘mips32r6’, ‘mips64’, ‘mips64r2’, ‘mips64r3’, ‘mips64r5’ and ‘mips64r6’.
The processor names are: ‘4kc’, ‘4km’, ‘4kp’, ‘4ksc’, ‘4kec’, ‘4kem’, ‘4kep’,
‘4ksd’, ‘5kc’, ‘5kf’, ‘20kc’, ‘24kc’, ‘24kf2_1’, ‘24kf1_1’, ‘24kec’, ‘24kef2_1’,
‘24kef1_1’, ‘34kc’, ‘34kf2_1’, ‘34kf1_1’, ‘34kn’, ‘74kc’, ‘74kf2_1’, ‘74kf1_1’,
‘74kf3_2’, ‘1004kc’, ‘1004kf2_1’, ‘1004kf1_1’, ‘i6400’, ‘i6500’, ‘interaptiv’,
‘loongson2e’, ‘loongson2f’, ‘loongson3a’, ‘gs464’, ‘gs464e’, ‘gs264e’, ‘m4k’,
‘m14k’, ‘m14kc’, ‘m14ke’, ‘m14kec’, ‘m5100’, ‘m5101’, ‘octeon’, ‘octeon+’,
‘octeon2’, ‘octeon3’, ‘orion’, ‘p5600’, ‘p6600’, ‘r2000’, ‘r3000’, ‘r3900’,
‘r4000’, ‘r4400’, ‘r4600’, ‘r4650’, ‘r4700’, ‘r5900’, ‘r6000’, ‘r8000’, ‘rm7000’,
‘rm9000’, ‘r10000’, ‘r12000’, ‘r14000’, ‘r16000’, ‘sb1’, ‘sr71000’, ‘vr4100’,
‘vr4111’, ‘vr4120’, ‘vr4130’, ‘vr4300’, ‘vr5000’, ‘vr5400’, ‘vr5500’, ‘xlr’ and
‘xlp’. The special value ‘from-abi’ selects the most compatible architecture
for the selected ABI (that is, ‘mips1’ for 32-bit ABIs and ‘mips3’ for 64-bit
ABIs).
The native Linux/GNU toolchain also supports the value ‘native’, which selects
the best architecture option for the host processor. ‘-march=native’ has no
effect if GCC does not recognize the processor.
In processor names, a final ‘000’ can be abbreviated as ‘k’ (for example,
‘-march=r2k’). Prefixes are optional, and ‘vr’ may be written ‘r’.
Names of the form ‘nf2_1’ refer to processors with FPUs clocked at half the rate
of the core, names of the form ‘nf1_1’ refer to processors with FPUs clocked at
the same rate as the core, and names of the form ‘nf3_2’ refer to processors with
FPUs clocked a ratio of 3:2 with respect to the core. For compatibility reasons,
‘nf’ is accepted as a synonym for ‘nf2_1’ while ‘nx’ and ‘bfx’ are accepted as
synonyms for ‘nf1_1’.
GCC defines two macros based on the value of this option. The first is _MIPS_
ARCH, which gives the name of target architecture, as a string. The second
has the form _MIPS_ARCH_foo, where foo is the capitalized value of _MIPS_
ARCH. For example, ‘-march=r2000’ sets _MIPS_ARCH to "r2000" and defines
the macro _MIPS_ARCH_R2000.
Note that the _MIPS_ARCH macro uses the processor names given above. In
other words, it has the full prefix and does not abbreviate ‘000’ as ‘k’. In the
case of ‘from-abi’, the macro names the resolved architecture (either "mips1"
or "mips3"). It names the default architecture when no ‘-march’ option is
given.
Chapter 3: GCC Command Options 389
-mtune=arch
Optimize for arch. Among other things, this option controls the way instruc-
tions are scheduled, and the perceived cost of arithmetic operations. The list
of arch values is the same as for ‘-march’.
When this option is not used, GCC optimizes for the processor specified by
‘-march’. By using ‘-march’ and ‘-mtune’ together, it is possible to generate
code that runs on a family of processors, but optimize the code for one particular
member of that family.
‘-mtune’ defines the macros _MIPS_TUNE and _MIPS_TUNE_foo, which work in
the same way as the ‘-march’ ones described above.
-mips1 Equivalent to ‘-march=mips1’.
-mips2 Equivalent to ‘-march=mips2’.
-mips3 Equivalent to ‘-march=mips3’.
-mips4 Equivalent to ‘-march=mips4’.
-mips32 Equivalent to ‘-march=mips32’.
-mips32r3
Equivalent to ‘-march=mips32r3’.
-mips32r5
Equivalent to ‘-march=mips32r5’.
-mips32r6
Equivalent to ‘-march=mips32r6’.
-mips64 Equivalent to ‘-march=mips64’.
-mips64r2
Equivalent to ‘-march=mips64r2’.
-mips64r3
Equivalent to ‘-march=mips64r3’.
-mips64r5
Equivalent to ‘-march=mips64r5’.
-mips64r6
Equivalent to ‘-march=mips64r6’.
-mips16
-mno-mips16
Generate (do not generate) MIPS16 code. If GCC is targeting a MIPS32 or
MIPS64 architecture, it makes use of the MIPS16e ASE.
MIPS16 code generation can also be controlled on a per-function basis by means
of mips16 and nomips16 attributes. See Section 6.33 [Function Attributes],
page 556, for more information.
-mflip-mips16
Generate MIPS16 code on alternating functions. This option is provided for
regression testing of mixed MIPS16/non-MIPS16 code generation, and is not
intended for ordinary use in compiling user code.
390 Using the GNU Compiler Collection (GCC)
-minterlink-compressed
-mno-interlink-compressed
Require (do not require) that code using the standard (uncompressed) MIPS
ISA be link-compatible with MIPS16 and microMIPS code, and vice versa.
For example, code using the standard ISA encoding cannot jump directly to
MIPS16 or microMIPS code; it must either use a call or an indirect jump.
‘-minterlink-compressed’ therefore disables direct jumps unless GCC knows
that the target of the jump is not compressed.
-minterlink-mips16
-mno-interlink-mips16
Aliases of ‘-minterlink-compressed’ and ‘-mno-interlink-compressed’.
These options predate the microMIPS ASE and are retained for backwards
compatibility.
-mabi=32
-mabi=o64
-mabi=n32
-mabi=64
-mabi=eabi
Generate code for the given ABI.
Note that the EABI has a 32-bit and a 64-bit variant. GCC normally generates
64-bit code when you select a 64-bit architecture, but you can use ‘-mgp32’ to
get 32-bit code instead.
For information about the O64 ABI, see https://gcc.gnu.org/projects/
mipso64-abi.html.
GCC supports a variant of the o32 ABI in which floating-point registers are
64 rather than 32 bits wide. You can select this combination with ‘-mabi=32’
‘-mfp64’. This ABI relies on the mthc1 and mfhc1 instructions and is therefore
only supported for MIPS32R2, MIPS32R3 and MIPS32R5 processors.
The register assignments for arguments and return values remain the same, but
each scalar value is passed in a single 64-bit register rather than a pair of 32-bit
registers. For example, scalar floating-point values are returned in ‘$f0’ only,
not a ‘$f0’/‘$f1’ pair. The set of call-saved registers also remains the same in
that the even-numbered double-precision registers are saved.
Two additional variants of the o32 ABI are supported to enable a transition from
32-bit to 64-bit registers. These are FPXX (‘-mfpxx’) and FP64A (‘-mfp64’
‘-mno-odd-spreg’). The FPXX extension mandates that all code must execute
correctly when run using 32-bit or 64-bit registers. The code can be interlinked
with either FP32 or FP64, but not both. The FP64A extension is similar to the
FP64 extension but forbids the use of odd-numbered single-precision registers.
This can be used in conjunction with the FRE mode of FPUs in MIPS32R5
processors and allows both FP32 and FP64A code to interlink and run in the
same process without changing FPU modes.
Chapter 3: GCC Command Options 391
-mabicalls
-mno-abicalls
Generate (do not generate) code that is suitable for SVR4-style dynamic ob-
jects. ‘-mabicalls’ is the default for SVR4-based systems.
-mshared
-mno-shared
Generate (do not generate) code that is fully position-independent, and that can
therefore be linked into shared libraries. This option only affects ‘-mabicalls’.
All ‘-mabicalls’ code has traditionally been position-independent, regardless of
options like ‘-fPIC’ and ‘-fpic’. However, as an extension, the GNU toolchain
allows executables to use absolute accesses for locally-binding symbols. It can
also use shorter GP initialization sequences and generate direct calls to locally-
defined functions. This mode is selected by ‘-mno-shared’.
‘-mno-shared’ depends on binutils 2.16 or higher and generates objects that
can only be linked by the GNU linker. However, the option does not affect the
ABI of the final executable; it only affects the ABI of relocatable objects. Using
‘-mno-shared’ generally makes executables both smaller and quicker.
‘-mshared’ is the default.
-mplt
-mno-plt Assume (do not assume) that the static and dynamic linkers support PLTs and
copy relocations. This option only affects ‘-mno-shared -mabicalls’. For the
n64 ABI, this option has no effect without ‘-msym32’.
You can make ‘-mplt’ the default by configuring GCC with ‘--with-mips-plt’.
The default is ‘-mno-plt’ otherwise.
-mxgot
-mno-xgot
Lift (do not lift) the usual restrictions on the size of the global offset table.
GCC normally uses a single instruction to load values from the GOT. While
this is relatively efficient, it only works if the GOT is smaller than about 64k.
Anything larger causes the linker to report an error such as:
relocation truncated to fit: R_MIPS_GOT16 foobar
If this happens, you should recompile your code with ‘-mxgot’. This works with
very large GOTs, although the code is also less efficient, since it takes three
instructions to fetch the value of a global symbol.
Note that some linkers can create multiple GOTs. If you have such a linker,
you should only need to use ‘-mxgot’ when a single object file accesses more
than 64k’s worth of GOT entries. Very few do.
These options have no effect unless GCC is generating position independent
code.
-mgp32 Assume that general-purpose registers are 32 bits wide.
-mgp64 Assume that general-purpose registers are 64 bits wide.
-mfp32 Assume that floating-point registers are 32 bits wide.
392 Using the GNU Compiler Collection (GCC)
The ‘-mnan=legacy’ option selects the legacy encoding. In this case quiet NaNs
(qNaNs) are denoted by the first bit of their trailing significand field being 0,
whereas signaling NaNs (sNaNs) are denoted by the first bit of their trailing
significand field being 1.
The ‘-mnan=2008’ option selects the IEEE 754-2008 encoding. In this case
qNaNs are denoted by the first bit of their trailing significand field being 1,
whereas sNaNs are denoted by the first bit of their trailing significand field
being 0.
The default is ‘-mnan=legacy’ unless GCC has been configured with
‘--with-nan=2008’.
-mllsc
-mno-llsc
Use (do not use) ‘ll’, ‘sc’, and ‘sync’ instructions to implement atomic memory
built-in functions. When neither option is specified, GCC uses the instructions
if the target architecture supports them.
‘-mllsc’ is useful if the runtime environment can emulate the instructions and
‘-mno-llsc’ can be useful when compiling for nonstandard ISAs. You can
make either option the default by configuring GCC with ‘--with-llsc’ and
‘--without-llsc’ respectively. ‘--with-llsc’ is the default for some configu-
rations; see the installation documentation for details.
-mdsp
-mno-dsp Use (do not use) revision 1 of the MIPS DSP ASE. See Section 6.60.14 [MIPS
DSP Built-in Functions], page 763. This option defines the preprocessor macro
__mips_dsp. It also defines __mips_dsp_rev to 1.
-mdspr2
-mno-dspr2
Use (do not use) revision 2 of the MIPS DSP ASE. See Section 6.60.14 [MIPS
DSP Built-in Functions], page 763. This option defines the preprocessor macros
__mips_dsp and __mips_dspr2. It also defines __mips_dsp_rev to 2.
-msmartmips
-mno-smartmips
Use (do not use) the MIPS SmartMIPS ASE.
-mpaired-single
-mno-paired-single
Use (do not use) paired-single floating-point instructions. See Section 6.60.15
[MIPS Paired-Single Support], page 768. This option requires hardware
floating-point support to be enabled.
-mdmx
-mno-mdmx
Use (do not use) MIPS Digital Media Extension instructions. This option can
only be used when generating 64-bit code and requires hardware floating-point
support to be enabled.
394 Using the GNU Compiler Collection (GCC)
-mips3d
-mno-mips3d
Use (do not use) the MIPS-3D ASE. See Section 6.60.16.3 [MIPS-3D Built-in
Functions], page 772. The option ‘-mips3d’ implies ‘-mpaired-single’.
-mmicromips
-mno-micromips
Generate (do not generate) microMIPS code.
MicroMIPS code generation can also be controlled on a per-function basis by
means of micromips and nomicromips attributes. See Section 6.33 [Function
Attributes], page 556, for more information.
-mmt
-mno-mt Use (do not use) MT Multithreading instructions.
-mmcu
-mno-mcu Use (do not use) the MIPS MCU ASE instructions.
-meva
-mno-eva Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
-mvirt
-mno-virt
Use (do not use) the MIPS Virtualization (VZ) instructions.
-mxpa
-mno-xpa Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
-mcrc
-mno-crc Use (do not use) the MIPS Cyclic Redundancy Check (CRC) instructions.
-mginv
-mno-ginv
Use (do not use) the MIPS Global INValidate (GINV) instructions.
-mloongson-mmi
-mno-loongson-mmi
Use (do not use) the MIPS Loongson MultiMedia extensions Instructions
(MMI).
-mloongson-ext
-mno-loongson-ext
Use (do not use) the MIPS Loongson EXTensions (EXT) instructions.
-mloongson-ext2
-mno-loongson-ext2
Use (do not use) the MIPS Loongson EXTensions r2 (EXT2) instructions.
-mlong64 Force long types to be 64 bits wide. See ‘-mlong32’ for an explanation of the
default and the way that the pointer size is determined.
-mlong32 Force long, int, and pointer types to be 32 bits wide.
The default size of ints, longs and pointers depends on the ABI. All the
supported ABIs use 32-bit ints. The n64 ABI uses 64-bit longs, as does the
Chapter 3: GCC Command Options 395
64-bit EABI; the others use 32-bit longs. Pointers are the same size as longs,
or the same size as integer registers, whichever is smaller.
-msym32
-mno-sym32
Assume (do not assume) that all symbols have 32-bit values, regardless of
the selected ABI. This option is useful in combination with ‘-mabi=64’ and
‘-mno-abicalls’ because it allows GCC to generate shorter and faster refer-
ences to symbolic addresses.
-G num Put definitions of externally-visible data in a small data section if that data is
no bigger than num bytes. GCC can then generate more efficient accesses to
the data; see ‘-mgpopt’ for details.
The default ‘-G’ option depends on the configuration.
-mlocal-sdata
-mno-local-sdata
Extend (do not extend) the ‘-G’ behavior to local data too, such as to static
variables in C. ‘-mlocal-sdata’ is the default for all configurations.
If the linker complains that an application is using too much small data,
you might want to try rebuilding the less performance-critical parts with
‘-mno-local-sdata’. You might also want to build large libraries with
‘-mno-local-sdata’, so that the libraries leave more room for the main
program.
-mextern-sdata
-mno-extern-sdata
Assume (do not assume) that externally-defined data is in a small data section
if the size of that data is within the ‘-G’ limit. ‘-mextern-sdata’ is the default
for all configurations.
If you compile a module Mod with ‘-mextern-sdata’ ‘-G num’ ‘-mgpopt’, and
Mod references a variable Var that is no bigger than num bytes, you must make
sure that Var is placed in a small data section. If Var is defined by another
module, you must either compile that module with a high-enough ‘-G’ setting
or attach a section attribute to Var’s definition. If Var is common, you must
link the application with a high-enough ‘-G’ setting.
The easiest way of satisfying these restrictions is to compile and link every
module with the same ‘-G’ option. However, you may wish to build a library
that supports several different small data limits. You can do this by compil-
ing the library with the highest supported ‘-G’ setting and additionally us-
ing ‘-mno-extern-sdata’ to stop the library from making assumptions about
externally-defined data.
-mgpopt
-mno-gpopt
Use (do not use) GP-relative accesses for symbols that are known to be in a
small data section; see ‘-G’, ‘-mlocal-sdata’ and ‘-mextern-sdata’. ‘-mgpopt’
is the default for all configurations.
396 Using the GNU Compiler Collection (GCC)
‘-mno-gpopt’ is useful for cases where the $gp register might not hold the value
of _gp. For example, if the code is part of a library that might be used in a
boot monitor, programs that call boot monitor routines pass an unknown value
in $gp. (In such situations, the boot monitor itself is usually compiled with
‘-G0’.)
‘-mno-gpopt’ implies ‘-mno-local-sdata’ and ‘-mno-extern-sdata’.
-membedded-data
-mno-embedded-data
Allocate variables to the read-only data section first if possible, then next in the
small data section if possible, otherwise in data. This gives slightly slower code
than the default, but reduces the amount of RAM required when executing,
and thus may be preferred for some embedded systems.
-muninit-const-in-rodata
-mno-uninit-const-in-rodata
Put uninitialized const variables in the read-only data section. This option is
only meaningful in conjunction with ‘-membedded-data’.
-mcode-readable=setting
Specify whether GCC may generate code that reads from executable sections.
There are three possible settings:
-mcode-readable=yes
Instructions may freely access executable sections. This is the de-
fault setting.
-mcode-readable=pcrel
MIPS16 PC-relative load instructions can access executable sec-
tions, but other instructions must not do so. This option is useful
on 4KSc and 4KSd processors when the code TLBs have the Read
Inhibit bit set. It is also useful on processors that can be configured
to have a dual instruction/data SRAM interface and that, like the
M4K, automatically redirect PC-relative loads to the instruction
RAM.
-mcode-readable=no
Instructions must not access executable sections. This option can
be useful on targets that are configured to have a dual instruc-
tion/data SRAM interface but that (unlike the M4K) do not auto-
matically redirect PC-relative loads to the instruction RAM.
-msplit-addresses
-mno-split-addresses
Enable (disable) use of the %hi() and %lo() assembler relocation operators.
This option has been superseded by ‘-mexplicit-relocs’ but is retained for
backwards compatibility.
Chapter 3: GCC Command Options 397
-mexplicit-relocs
-mno-explicit-relocs
Use (do not use) assembler relocation operators when dealing with symbolic
addresses. The alternative, selected by ‘-mno-explicit-relocs’, is to use as-
sembler macros instead.
‘-mexplicit-relocs’ is the default if GCC was configured to use an assembler
that supports relocation operators.
-mcheck-zero-division
-mno-check-zero-division
Trap (do not trap) on integer division by zero.
The default is ‘-mcheck-zero-division’.
-mdivide-traps
-mdivide-breaks
MIPS systems check for division by zero by generating either a conditional
trap or a break instruction. Using traps results in smaller code, but is only
supported on MIPS II and later. Also, some versions of the Linux kernel have
a bug that prevents trap from generating the proper signal (SIGFPE). Use
‘-mdivide-traps’ to allow conditional traps on architectures that support them
and ‘-mdivide-breaks’ to force the use of breaks.
The default is usually ‘-mdivide-traps’, but this can be overridden at configure
time using ‘--with-divide=breaks’. Divide-by-zero checks can be completely
disabled using ‘-mno-check-zero-division’.
-mload-store-pairs
-mno-load-store-pairs
Enable (disable) an optimization that pairs consecutive load or store instruc-
tions to enable load/store bonding. This option is enabled by default but only
takes effect when the selected architecture is known to support bonding.
-munaligned-access
-mno-unaligned-access
Enable (disable) direct unaligned access for MIPS Release 6. MIPSr6 re-
quires load/store unaligned-access support, by hardware or trap&emulate. So
‘-mno-unaligned-access’ may be needed by kernel.
-mmemcpy
-mno-memcpy
Force (do not force) the use of memcpy for non-trivial block moves. The default
is ‘-mno-memcpy’, which allows GCC to inline most constant-sized copies.
-mlong-calls
-mno-long-calls
Disable (do not disable) use of the jal instruction. Calling functions using
jal is more efficient but requires the caller and callee to be in the same 256
megabyte segment.
This option has no effect on abicalls code. The default is ‘-mno-long-calls’.
398 Using the GNU Compiler Collection (GCC)
-mmad
-mno-mad Enable (disable) use of the mad, madu and mul instructions, as provided by the
R4650 ISA.
-mimadd
-mno-imadd
Enable (disable) use of the madd and msub integer instructions. The default
is ‘-mimadd’ on architectures that support madd and msub except for the 74k
architecture where it was found to generate slower code.
-mfused-madd
-mno-fused-madd
Enable (disable) use of the floating-point multiply-accumulate instructions,
when they are available. The default is ‘-mfused-madd’.
On the R8000 CPU when multiply-accumulate instructions are used, the in-
termediate product is calculated to infinite precision and is not subject to the
FCSR Flush to Zero bit. This may be undesirable in some circumstances. On
other processors the result is numerically identical to the equivalent computa-
tion using separate multiply, add, subtract and negate instructions.
-nocpp Tell the MIPS assembler to not run its preprocessor over user assembler files
(with a ‘.s’ suffix) when assembling them.
-mfix-24k
-mno-fix-24k
Work around the 24K E48 (lost data on stores during refill) errata. The
workarounds are implemented by the assembler rather than by GCC.
-mfix-r4000
-mno-fix-r4000
Work around certain R4000 CPU errata:
− A double-word or a variable shift may give an incorrect result if executed
immediately after starting an integer division.
− A double-word or a variable shift may give an incorrect result if executed
while an integer multiplication is in progress.
− An integer division may give an incorrect result if started in a delay slot of
a taken branch or a jump.
-mfix-r4400
-mno-fix-r4400
Work around certain R4400 CPU errata:
− A double-word or a variable shift may give an incorrect result if executed
immediately after starting an integer division.
-mfix-r10000
-mno-fix-r10000
Work around certain R10000 errata:
− ll/sc sequences may not behave atomically on revisions prior to 3.0. They
may deadlock on revisions 2.6 and earlier.
Chapter 3: GCC Command Options 399
This option can only be used if the target architecture supports branch-likely
instructions. ‘-mfix-r10000’ is the default when ‘-march=r10000’ is used;
‘-mno-fix-r10000’ is the default otherwise.
-mfix-r5900
-mno-fix-r5900
Do not attempt to schedule the preceding instruction into the delay slot of a
branch instruction placed at the end of a short loop of six instructions or fewer
and always schedule a nop instruction there instead. The short loop bug under
certain conditions causes loops to execute only once or twice, due to a hardware
bug in the R5900 chip. The workaround is implemented by the assembler rather
than by GCC.
-mfix-rm7000
-mno-fix-rm7000
Work around the RM7000 dmult/dmultu errata. The workarounds are imple-
mented by the assembler rather than by GCC.
-mfix-vr4120
-mno-fix-vr4120
Work around certain VR4120 errata:
− dmultu does not always produce the correct result.
− div and ddiv do not always produce the correct result if one of the operands
is negative.
The workarounds for the division errata rely on special functions in ‘libgcc.a’.
At present, these functions are only provided by the mips64vr*-elf configura-
tions.
Other VR4120 errata require a NOP to be inserted between certain pairs of
instructions. These errata are handled by the assembler, not by GCC itself.
-mfix-vr4130
Work around the VR4130 mflo/mfhi errata. The workarounds are implemented
by the assembler rather than by GCC, although GCC avoids using mflo and
mfhi if the VR4130 macc, macchi, dmacc and dmacchi instructions are available
instead.
-mfix-sb1
-mno-fix-sb1
Work around certain SB-1 CPU core errata. (This flag currently works around
the SB-1 revision 2 “F1” and “F2” floating-point errata.)
-mr10k-cache-barrier=setting
Specify whether GCC should insert cache barriers to avoid the side effects of
speculation on R10K processors.
In common with many processors, the R10K tries to predict the outcome of
a conditional branch and speculatively executes instructions from the “taken”
branch. It later aborts these instructions if the predicted outcome is wrong.
However, on the R10K, even aborted instructions can have side effects.
400 Using the GNU Compiler Collection (GCC)
This problem only affects kernel stores and, depending on the system, kernel
loads. As an example, a speculatively-executed store may load the target mem-
ory into cache and mark the cache line as dirty, even if the store itself is later
aborted. If a DMA operation writes to the same area of memory before the
“dirty” line is flushed, the cached data overwrites the DMA-ed data. See the
R10K processor manual for a full description, including other potential prob-
lems.
One workaround is to insert cache barrier instructions before every memory
access that might be speculatively executed and that might have side effects
even if aborted. ‘-mr10k-cache-barrier=setting’ controls GCC’s implemen-
tation of this workaround. It assumes that aborted accesses to any byte in the
following regions does not have side effects:
1. the memory occupied by the current function’s stack frame;
2. the memory occupied by an incoming stack argument;
3. the memory occupied by an object with a link-time-constant address.
It is the kernel’s responsibility to ensure that speculative accesses to these
regions are indeed safe.
If the input program contains a function declaration such as:
void foo (void);
then the implementation of foo must allow j foo and jal foo to be executed
speculatively. GCC honors this restriction for functions it compiles itself. It
expects non-GCC functions (such as hand-written assembly code) to do the
same.
The option has three forms:
-mr10k-cache-barrier=load-store
Insert a cache barrier before a load or store that might be specula-
tively executed and that might have side effects even if aborted.
-mr10k-cache-barrier=store
Insert a cache barrier before a store that might be speculatively
executed and that might have side effects even if aborted.
-mr10k-cache-barrier=none
Disable the insertion of cache barriers. This is the default setting.
-mflush-func=func
-mno-flush-func
Specifies the function to call to flush the I and D caches, or to not call any
such function. If called, the function must take the same arguments as the
common _flush_func, that is, the address of the memory range for which the
cache is being flushed, the size of the memory range, and the number 3 (to flush
both caches). The default depends on the target GCC was configured for, but
commonly is either _flush_func or __cpu_flush.
mbranch-cost=num
Set the cost of branches to roughly num “simple” instructions. This cost is only
a heuristic and is not guaranteed to produce consistent results across releases.
Chapter 3: GCC Command Options 401
A zero cost redundantly selects the default, which is based on the ‘-mtune’
setting.
-mbranch-likely
-mno-branch-likely
Enable or disable use of Branch Likely instructions, regardless of the default
for the selected architecture. By default, Branch Likely instructions may be
generated if they are supported by the selected architecture. An exception
is for the MIPS32 and MIPS64 architectures and processors that implement
those architectures; for those, Branch Likely instructions are not be generated
by default because the MIPS32 and MIPS64 architectures specifically deprecate
their use.
-mcompact-branches=never
-mcompact-branches=optimal
-mcompact-branches=always
These options control which form of branches will be generated. The default is
‘-mcompact-branches=optimal’.
The ‘-mcompact-branches=never’ option ensures that compact branch instruc-
tions will never be generated.
The ‘-mcompact-branches=always’ option ensures that a compact branch in-
struction will be generated if available. If a compact branch instruction is not
available, a delay slot form of the branch will be used instead.
This option is supported from MIPS Release 6 onwards.
The ‘-mcompact-branches=optimal’ option will cause a delay slot branch to
be used if one is available in the current ISA and the delay slot is successfully
filled. If the delay slot is not filled, a compact branch will be chosen if one is
available.
-mfp-exceptions
-mno-fp-exceptions
Specifies whether FP exceptions are enabled. This affects how FP instructions
are scheduled for some processors. The default is that FP exceptions are en-
abled.
For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
64-bit code, then we can use both FP pipes. Otherwise, we can only use one
FP pipe.
-mvr4130-align
-mno-vr4130-align
The VR4130 pipeline is two-way superscalar, but can only issue two instructions
together if the first one is 8-byte aligned. When this option is enabled, GCC
aligns pairs of instructions that it thinks should execute in parallel.
This option only has an effect when optimizing for the VR4130. It normally
makes code faster, but at the expense of making it bigger. It is enabled by
default at optimization level ‘-O3’.
402 Using the GNU Compiler Collection (GCC)
-msynci
-mno-synci
Enable (disable) generation of synci instructions on architectures that sup-
port it. The synci instructions (if enabled) are generated when __builtin__
_clear_cache is compiled.
This option defaults to ‘-mno-synci’, but the default can be overridden by
configuring GCC with ‘--with-synci’.
When compiling code for single processor systems, it is generally safe to use
synci. However, on many multi-core (SMP) systems, it does not invalidate the
instruction caches on all cores and may lead to undefined behavior.
-mrelax-pic-calls
-mno-relax-pic-calls
Try to turn PIC calls that are normally dispatched via register $25 into direct
calls. This is only possible if the linker can resolve the destination at link time
and if the destination is within range for a direct call.
‘-mrelax-pic-calls’ is the default if GCC was configured to use an
assembler and a linker that support the .reloc assembly directive and
‘-mexplicit-relocs’ is in effect. With ‘-mno-explicit-relocs’, this
optimization can be performed by the assembler and the linker alone without
help from the compiler.
-mmcount-ra-address
-mno-mcount-ra-address
Emit (do not emit) code that allows _mcount to modify the calling function’s
return address. When enabled, this option extends the usual _mcount interface
with a new ra-address parameter, which has type intptr_t * and is passed in
register $12. _mcount can then modify the return address by doing both of the
following:
• Returning the new address in register $31.
• Storing the new address in *ra-address, if ra-address is nonnull.
-mframe-header-opt
-mno-frame-header-opt
Enable (disable) frame header optimization in the o32 ABI. When using the o32
ABI, calling functions will allocate 16 bytes on the stack for the called function
to write out register arguments. When enabled, this optimization will suppress
the allocation of the frame header if it can be determined that it is unused.
This optimization is off by default at all optimization levels.
-mlxc1-sxc1
-mno-lxc1-sxc1
When applicable, enable (disable) the generation of lwxc1, swxc1, ldxc1, sdxc1
instructions. Enabled by default.
Chapter 3: GCC Command Options 403
-mmadd4
-mno-madd4
When applicable, enable (disable) the generation of 4-operand madd.s, madd.d
and related instructions. Enabled by default.
for a constant to be set up in a global register. The register is used for one or
more base address requests within the range 0 to 255 from the value held in the
register. The generally leads to short and fast code, but the number of different
data items that can be addressed is limited. This means that a program that
uses lots of static data may require ‘-mno-base-addresses’.
-msingle-exit
-mno-single-exit
Force (do not force) generated code to have a single exit point in each function.
-mno-liw Do not allow the compiler to generate Long Instruction Word instructions. This
option defines the preprocessor macro __NO_LIW__.
-msetlb Allow the compiler to generate the SETLB and Lcc instructions if the target
is the ‘AM33’ or later. This is the default. This option defines the preprocessor
macro __SETLB__.
-mno-setlb
Do not allow the compiler to generate SETLB or Lcc instructions. This option
defines the preprocessor macro __NO_SETLB__.
-msilicon-errata-warn=
This option passes on a request to the assembler to enable warning messages
when a silicon errata might need to be applied.
-mwarn-devices-csv
-mno-warn-devices-csv
Warn if ‘devices.csv’ is not found or there are problem parsing it (default:
on).
-misr-vector-size=num
Specify the size of each interrupt vector, which must be 4 or 16.
-mcache-block-size=num
Specify the size of each cache block, which must be a power of 2 between 4 and
512.
-march=arch
Specify the name of the target architecture.
-mcmodel=code-model
Set the code model to one of
‘small’ All the data and read-only data segments must be within 512KB
addressing space. The text segment must be within 16MB address-
ing space.
‘medium’ The data segment must be within 512KB while the read-only data
segment can be within 4GB addressing space. The text segment
should be still within 16MB addressing space.
‘large’ All the text and data segments can be within 4GB addressing space.
-mctor-dtor
Enable constructor/destructor feature.
-mrelax Guide linker to relax instructions.
program must fit in 64K of memory and you must use an appropri-
ate linker script to allocate them within the addressable range of
the global pointer.
‘all’ Generate GP-relative addresses for function pointers as well as data
pointers. If you use this option, the entire text, data, and BSS
segments of your program must fit in 64K of memory and you
must use an appropriate linker script to allocate them within the
addressable range of the global pointer.
‘-mgpopt’ is equivalent to ‘-mgpopt=local’, and ‘-mno-gpopt’ is equivalent to
‘-mgpopt=none’.
The default is ‘-mgpopt’ except when ‘-fpic’ or ‘-fPIC’ is specified to generate
position-independent code. Note that the Nios II ABI does not permit GP-
relative accesses from shared libraries.
You may need to specify ‘-mno-gpopt’ explicitly when building programs that
include large amounts of small data, including large GOT data sections. In this
case, the 16-bit offset for GP-relative addressing may not be large enough to
allow access to the entire small data section.
-mgprel-sec=regexp
This option specifies additional section names that can be accessed via GP-
relative addressing. It is most useful in conjunction with section attributes
on variable declarations (see Section 6.34.1 [Common Variable Attributes],
page 622) and a custom linker script. The regexp is a POSIX Extended Regular
Expression.
This option does not affect the behavior of the ‘-G’ option, and the specified
sections are in addition to the standard .sdata and .sbss small-data sections
that are recognized by ‘-mgpopt’.
-mr0rel-sec=regexp
This option specifies names of sections that can be accessed via a 16-bit offset
from r0; that is, in the low 32K or high 32K of the 32-bit address space. It is
most useful in conjunction with section attributes on variable declarations (see
Section 6.34.1 [Common Variable Attributes], page 622) and a custom linker
script. The regexp is a POSIX Extended Regular Expression.
In contrast to the use of GP-relative addressing for small data, zero-based
addressing is never generated by default and there are no conventional section
names used in standard linker scripts for sections in the low or high areas of
memory.
-mel
-meb Generate little-endian (default) or big-endian (experimental) code, respectively.
-march=arch
This specifies the name of the target Nios II architecture. GCC uses this name
to determine what kind of instructions it can emit when generating assembly
code. Permissible names are: ‘r1’, ‘r2’.
The preprocessor macro __nios2_arch__ is available to programs, with value
1 or 2, indicating the targeted ISA level.
Chapter 3: GCC Command Options 411
-mbypass-cache
-mno-bypass-cache
Force all load and store instructions to always bypass cache by using I/O vari-
ants of the instructions. The default is not to bypass the cache.
-mno-cache-volatile
-mcache-volatile
Volatile memory access bypass the cache using the I/O variants of the load and
store instructions. The default is not to bypass the cache.
-mno-fast-sw-div
-mfast-sw-div
Do not use table-based fast divide for small numbers. The default is to use the
fast divide at ‘-O3’ and above.
-mno-hw-mul
-mhw-mul
-mno-hw-mulx
-mhw-mulx
-mno-hw-div
-mhw-div Enable or disable emitting mul, mulx and div family of instructions by the
compiler. The default is to emit mul and not emit div and mulx.
-mbmx
-mno-bmx
-mcdx
-mno-cdx Enable or disable generation of Nios II R2 BMX (bit manipulation) and
CDX (code density) instructions. Enabling these instructions also requires
‘-march=r2’. Since these instructions are optional extensions to the R2
architecture, the default is not to emit them.
-mcustom-insn=N
-mno-custom-insn
Each ‘-mcustom-insn=N’ option enables use of a custom instruction
with encoding N when generating code that uses insn. For example,
‘-mcustom-fadds=253’ generates custom instruction 253 for single-precision
floating-point add operations instead of the default behavior of using a library
call.
The following values of insn are supported. Except as otherwise noted, floating-
point operations are expected to be implemented with normal IEEE 754 seman-
tics and correspond directly to the C operators or the equivalent GCC built-in
functions (see Section 6.59 [Other Builtins], page 728).
Single-precision floating point:
‘fadds’, ‘fsubs’, ‘fdivs’, ‘fmuls’
Binary arithmetic operations.
‘fnegs’ Unary negation.
‘fabss’ Unary absolute value.
412 Using the GNU Compiler Collection (GCC)
In addition, all of the following transfer instructions for internal registers X and
Y must be provided to use any of the double-precision floating-point instruc-
tions. Custom instructions taking two double-precision source operands expect
the first operand in the 64-bit register X. The other operand (or only operand
of a unary operation) is given to the custom arithmetic instruction with the
least significant half in source register src1 and the most significant half in src2.
A custom instruction that returns a double-precision result returns the most
significant 32 bits in the destination register and the other half in 32-bit register
Y. GCC automatically generates the necessary code sequences to write register
X and/or read register Y when double-precision floating-point instructions are
used.
‘fwrx’ Write src1 into the least significant half of X and src2 into the most
significant half of X.
‘fwry’ Write src1 into Y.
‘frdxhi’, ‘frdxlo’
Read the most or least (respectively) significant half of X and store
it in dest.
‘frdy’ Read the value of Y and store it into dest.
Note that you can gain more local control over generation of Nios II custom in-
structions by using the target("custom-insn=N") and target("no-custom-
insn") function attributes (see Section 6.33 [Function Attributes], page 556)
or pragmas (see Section 6.62.16 [Function Specific Option Pragmas], page 880).
-mcustom-fpu-cfg=name
This option enables a predefined, named set of custom instruction encodings
(see ‘-mcustom-insn’ above). Currently, the following sets are defined:
‘-mcustom-fpu-cfg=60-1’ is equivalent to:
-mcustom-fmuls=252
-mcustom-fadds=253
-mcustom-fsubs=254
-fsingle-precision-constant
‘-mcustom-fpu-cfg=60-2’ is equivalent to:
-mcustom-fmuls=252
-mcustom-fadds=253
-mcustom-fsubs=254
-mcustom-fdivs=255
-fsingle-precision-constant
‘-mcustom-fpu-cfg=72-3’ is equivalent to:
-mcustom-floatus=243
-mcustom-fixsi=244
-mcustom-floatis=245
-mcustom-fcmpgts=246
-mcustom-fcmples=249
-mcustom-fcmpeqs=250
-mcustom-fcmpnes=251
-mcustom-fmuls=252
-mcustom-fadds=253
-mcustom-fsubs=254
414 Using the GNU Compiler Collection (GCC)
-mcustom-fdivs=255
-fsingle-precision-constant
These additional ‘-m’ options are available for the Altera Nios II ELF (bare-metal) target:
-mhal Link with HAL BSP. This suppresses linking with the GCC-provided C run-
time startup and termination code, and is typically used in conjunction with
‘-msys-crt0=’ to specify the location of the alternate startup code provided by
the HAL BSP.
-msmallc Link with a limited version of the C library, ‘-lsmallc’, rather than Newlib.
-msys-crt0=startfile
startfile is the file name of the startfile (crt0) to use when linking. This option
is only useful in conjunction with ‘-mhal’.
Chapter 3: GCC Command Options 415
-msys-lib=systemlib
systemlib is the library name of the library that provides low-level system calls
required by the C library, e.g. read and write. This option is typically used to
link with a library provided by a HAL BSP.
-muniform-simt
Switch to code generation variant that allows to execute all threads in each
warp, while maintaining memory state and side effects as if only one thread in
each warp was active outside of OpenMP SIMD regions. All atomic operations
and calls to runtime (malloc, free, vprintf) are conditionally executed (iff current
lane index equals the master lane index), and the register being assigned is
copied via a shuffle instruction from the master lane. Outside of SIMD regions
lane 0 is the master; inside, each thread sees itself as the master. Shared
memory array int __nvptx_uni[] stores all-zeros or all-ones bitmasks for each
warp, indicating current mode (0 outside of SIMD regions). Each thread can
bitwise-and the bitmask at position tid.y with current lane index to compute
the master lane index.
-mgomp Generate code for use in OpenMP offloading: enables ‘-msoft-stack’ and
‘-muniform-simt’ options, and selects corresponding multilib variant.
-msplit Target has split instruction and data space. Implies -m45.
-munix-asm
Use Unix assembler syntax.
-mdec-asm
Use DEC assembler syntax.
-mgnu-asm
Use GNU assembler syntax. This is the default.
-mlra Use the new LRA register allocator. By default, the old “reload” allocator is
used.
-mabi=ABI-string
Specify integer and floating-point calling convention. ABI-string contains two
parts: the size of integer types and the registers used for floating-point types.
For example ‘-march=rv64ifd -mabi=lp64d’ means that ‘long’ and pointers
are 64-bit (implicitly defining ‘int’ to be 32-bit), and that floating-point values
up to 64 bits wide are passed in F registers. Contrast this with ‘-march=rv64ifd
-mabi=lp64f’, which still allows the compiler to generate code that uses the
F and D extensions but only allows floating-point values up to 32 bits long to
be passed in registers; or ‘-march=rv64ifd -mabi=lp64’, in which no floating-
point arguments will be passed in registers.
The default for this argument is system dependent, users who want a spe-
cific calling convention should specify one explicitly. The valid calling con-
ventions are: ‘ilp32’, ‘ilp32f’, ‘ilp32d’, ‘lp64’, ‘lp64f’, and ‘lp64d’. Some
calling conventions are impossible to implement on some ISAs: for example,
‘-march=rv32if -mabi=ilp32d’ is invalid because the ABI requires 64-bit val-
ues be passed in F registers, but F registers are only 32 bits wide. There is also
the ‘ilp32e’ ABI that can only be used with the ‘rv32e’ architecture. This
ABI is not well specified at present, and is subject to change.
-mfdiv
-mno-fdiv
Do or don’t use hardware floating-point divide and square root instructions.
This requires the F or D extensions for floating-point registers. The default is
to use them if the specified architecture has these instructions.
-mdiv
-mno-div Do or don’t use hardware instructions for integer division. This requires the
M extension. The default is to use them if the specified architecture has these
instructions.
-misa-spec=ISA-spec-string
Specify the version of the RISC-V Unprivileged (formerly User-Level) ISA spec-
ification to produce code conforming to. The possibilities for ISA-spec-string
are:
2.2 Produce code conforming to version 2.2.
20190608 Produce code conforming to version 20190608.
20191213 Produce code conforming to version 20191213.
The default is ‘-misa-spec=20191213’ unless GCC has been configured with
‘--with-isa-spec=’ specifying a different default version.
-march=ISA-string
Generate code for given RISC-V ISA (e.g. ‘rv64im’). ISA strings must be
lower-case. Examples include ‘rv64i’, ‘rv32g’, ‘rv32e’, and ‘rv32imaf’.
When ‘-march=’ is not specified, use the setting from ‘-mcpu’.
If both ‘-march’ and ‘-mcpu=’ are not specified, the default for this argument
is system dependent, users who want a specific architecture extensions should
specify one explicitly.
Chapter 3: GCC Command Options 421
-mcpu=processor-string
Use architecture of and optimize the output for the given processor, specified
by particular CPU name. Permissible values for this option are: ‘sifive-e20’,
‘sifive-e21’, ‘sifive-e24’, ‘sifive-e31’, ‘sifive-e34’, ‘sifive-e76’,
‘sifive-s21’, ‘sifive-s51’, ‘sifive-s54’, ‘sifive-s76’, ‘sifive-u54’, and
‘sifive-u74’.
-mtune=processor-string
Optimize the output for the given processor, specified by microarchitecture
or particular CPU name. Permissible values for this option are: ‘rocket’,
‘sifive-3-series’, ‘sifive-5-series’, ‘sifive-7-series’, ‘thead-c906’,
‘size’, and all valid options for ‘-mcpu=’.
When ‘-mtune=’ is not specified, use the setting from ‘-mcpu’, the default is
‘rocket’ if both are not specified.
The ‘size’ choice is not intended for use by end-users. This is used when ‘-Os’
is specified. It overrides the instruction cost info provided by ‘-mtune=’, but
does not override the pipeline info. This helps reduce code size while still giving
good performance.
-mpreferred-stack-boundary=num
Attempt to keep the stack boundary aligned to a 2 raised to num byte boundary.
If ‘-mpreferred-stack-boundary’ is not specified, the default is 4 (16 bytes or
128-bits).
Warning: If you use this switch, then you must build all modules with the same
value, including any libraries. This includes the system libraries and startup
modules.
-msmall-data-limit=n
Put global and static data smaller than n bytes into a special section (on some
targets).
-msave-restore
-mno-save-restore
Do or don’t use smaller but slower prologue and epilogue code that uses library
function calls. The default is to use fast inline prologues and epilogues.
-mshorten-memrefs
-mno-shorten-memrefs
Do or do not attempt to make more use of compressed load/store instructions
by replacing a load/store of ’base register + large offset’ with a new load/store
of ’new base + small offset’. If the new base gets stored in a compressed register,
then the new load/store can be compressed. Currently targets 32-bit integer
load/stores only.
-mstrict-align
-mno-strict-align
Do not or do generate unaligned memory accesses. The default is set depending
on whether the processor we are optimizing for supports fast unaligned access
or not.
422 Using the GNU Compiler Collection (GCC)
-mcmodel=medlow
Generate code for the medium-low code model. The program and its statically
defined symbols must lie within a single 2 GiB address range and must lie
between absolute addresses −2 GiB and +2 GiB. Programs can be statically or
dynamically linked. This is the default code model.
-mcmodel=medany
Generate code for the medium-any code model. The program and its statically
defined symbols must be within any single 2 GiB address range. Programs can
be statically or dynamically linked.
The code generated by the medium-any code model is position-independent, but
is not guaranteed to function correctly when linked into position-independent
executables or libraries.
-mexplicit-relocs
-mno-exlicit-relocs
Use or do not use assembler relocation operators when dealing with symbolic
addresses. The alternative is to use assembler macros instead, which may limit
optimization.
-mrelax
-mno-relax
Take advantage of linker relaxations to reduce the number of instructions re-
quired to materialize symbol addresses. The default is to take advantage of
linker relaxations.
-memit-attribute
-mno-emit-attribute
Emit (do not emit) RISC-V attribute to record extra information into ELF
objects. This feature requires at least binutils 2.32.
-malign-data=type
Control how GCC aligns variables and constants of array, structure, or union
types. Supported values for type are ‘xlen’ which uses x register width as the
alignment value, and ‘natural’ which uses natural alignment. ‘xlen’ is the
default.
-mbig-endian
Generate big-endian code. This is the default when GCC is configured for a
‘riscv64be-*-*’ or ‘riscv32be-*-*’ target.
-mlittle-endian
Generate little-endian code. This is the default when GCC is configured
for a ‘riscv64-*-*’ or ‘riscv32-*-*’ but not a ‘riscv64be-*-*’ or
‘riscv32be-*-*’ target.
-mstack-protector-guard=guard
-mstack-protector-guard-reg=reg
-mstack-protector-guard-offset=offset
Generate stack protection code using canary at guard. Supported locations are
‘global’ for a global canary or ‘tls’ for per-thread canary in the TLS block.
Chapter 3: GCC Command Options 423
-mg10
-mg13
-mg14
-mrl78 These are aliases for the corresponding ‘-mcpu=’ option. They are provided for
backwards compatibility.
-mallregs
Allow the compiler to use all of the available registers. By default registers
r24..r31 are reserved for use in interrupt handlers. With this option enabled
these registers can be used in ordinary functions as well.
-m64bit-doubles
-m32bit-doubles
Make the double data type be 64 bits (‘-m64bit-doubles’) or 32 bits
(‘-m32bit-doubles’) in size. The default is ‘-m32bit-doubles’.
-msave-mduc-in-interrupts
-mno-save-mduc-in-interrupts
Specifies that interrupt handler functions should preserve the MDUC registers.
This is only necessary if normal code might use the MDUC registers, for example
because it performs multiplication and division operations. The default is to
ignore the MDUC registers as this makes the interrupt handlers faster. The
target option -mg13 needs to be passed for this to work as this feature is only
available on the G13 target (S2 core). The MDUC registers will only be saved if
the interrupt handler performs a multiplication or division operation or it calls
another function.
-msecure-plt
Generate code that allows ld and ld.so to build executables and shared li-
braries with non-executable .plt and .got sections. This is a PowerPC 32-bit
SYSV ABI option.
-mbss-plt
Generate code that uses a BSS .plt section that ld.so fills in, and requires
.plt and .got sections that are both writable and executable. This is a Pow-
erPC 32-bit SYSV ABI option.
-misel
-mno-isel
This switch enables or disables the generation of ISEL instructions.
-mvsx
-mno-vsx Generate code that uses (does not use) vector/scalar (VSX) instructions, and
also enable the use of built-in functions that allow more direct access to the
VSX instruction set.
-mcrypto
-mno-crypto
Enable the use (disable) of the built-in functions that allow direct access to
the cryptographic instructions that were added in version 2.07 of the PowerPC
ISA.
-mhtm
-mno-htm Enable (disable) the use of the built-in functions that allow direct access to
the Hardware Transactional Memory (HTM) instructions that were added in
version 2.07 of the PowerPC ISA.
-mpower8-fusion
-mno-power8-fusion
Generate code that keeps (does not keeps) some integer operations adjacent so
that the instructions can be fused together on power8 and later processors.
-mpower8-vector
-mno-power8-vector
Generate code that uses (does not use) the vector and scalar instructions that
were added in version 2.07 of the PowerPC ISA. Also enable the use of built-in
functions that allow more direct access to the vector instructions.
-mquad-memory
-mno-quad-memory
Generate code that uses (does not use) the non-atomic quad word memory
instructions. The ‘-mquad-memory’ option requires use of 64-bit mode.
-mquad-memory-atomic
-mno-quad-memory-atomic
Generate code that uses (does not use) the atomic quad word memory instruc-
tions. The ‘-mquad-memory-atomic’ option requires use of 64-bit mode.
428 Using the GNU Compiler Collection (GCC)
-mfloat128
-mno-float128
Enable/disable the float128 keyword for IEEE 128-bit floating point and use
either software emulation for IEEE 128-bit floating point or hardware instruc-
tions.
The VSX instruction set (‘-mvsx’) must be enabled to use the IEEE 128-bit
floating point support. The IEEE 128-bit floating point is only supported on
Linux.
The default for ‘-mfloat128’ is enabled on PowerPC Linux systems using the
VSX instruction set, and disabled on other systems.
If you use the ISA 3.0 instruction set (‘-mpower9-vector’ or ‘-mcpu=power9’)
on a 64-bit system, the IEEE 128-bit floating point support will also enable the
generation of ISA 3.0 IEEE 128-bit floating point instructions. Otherwise, if
you do not specify to generate ISA 3.0 instructions or you are targeting a 32-
bit big endian system, IEEE 128-bit floating point will be done with software
emulation.
-mfloat128-hardware
-mno-float128-hardware
Enable/disable using ISA 3.0 hardware instructions to support the float128
data type.
The default for ‘-mfloat128-hardware’ is enabled on PowerPC Linux systems
using the ISA 3.0 instruction set, and disabled on other systems.
-m32
-m64 Generate code for 32-bit or 64-bit environments of Darwin and SVR4 targets
(including GNU/Linux). The 32-bit environment sets int, long and pointer
to 32 bits and generates code that runs on any PowerPC variant. The 64-bit
environment sets int to 32 bits and long and pointer to 64 bits, and generates
code for PowerPC64, as for ‘-mpowerpc64’.
-mfull-toc
-mno-fp-in-toc
-mno-sum-in-toc
-mminimal-toc
Modify generation of the TOC (Table Of Contents), which is created for every
executable file. The ‘-mfull-toc’ option is selected by default. In that case,
GCC allocates at least one TOC entry for each unique non-automatic variable
reference in your program. GCC also places floating-point constants in the
TOC. However, only 16,384 entries are available in the TOC.
If you receive a linker error message that saying you have overflowed the avail-
able TOC space, you can reduce the amount of TOC space used with the
‘-mno-fp-in-toc’ and ‘-mno-sum-in-toc’ options. ‘-mno-fp-in-toc’ prevents
GCC from putting floating-point constants in the TOC and ‘-mno-sum-in-toc’
forces GCC to generate code to calculate the sum of an address and a constant
at run time instead of putting that sum into the TOC. You may specify one
or both of these options. Each causes GCC to produce very slightly slower and
larger code at the expense of conserving TOC space.
Chapter 3: GCC Command Options 429
If you still run out of space in the TOC even when you specify both of these
options, specify ‘-mminimal-toc’ instead. This option causes GCC to make
only one TOC entry for every file. When you specify this option, GCC produces
code that is slower and larger but which uses extremely little TOC space. You
may wish to use this option only on files that contain less frequently-executed
code.
-maix64
-maix32 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit long
type, and the infrastructure needed to support them. Specifying ‘-maix64’
implies ‘-mpowerpc64’, while ‘-maix32’ disables the 64-bit ABI and implies
‘-mno-powerpc64’. GCC defaults to ‘-maix32’.
-mxl-compat
-mno-xl-compat
Produce code that conforms more closely to IBM XL compiler semantics when
using AIX-compatible ABI. Pass floating-point arguments to prototyped func-
tions beyond the register save area (RSA) on the stack in addition to argument
FPRs. Do not assume that most significant double in 128-bit long double value
is properly rounded when comparing values and converting to double. Use XL
symbol names for long double support routines.
The AIX calling convention was extended but not initially documented to han-
dle an obscure K&R C case of calling a function that takes the address of
its arguments with fewer arguments than declared. IBM XL compilers access
floating-point arguments that do not fit in the RSA from the stack when a
subroutine is compiled without optimization. Because always storing floating-
point arguments on the stack is inefficient and rarely needed, this option is not
enabled by default and only is necessary when calling subroutines compiled by
IBM XL compilers without optimization.
-malign-natural
-malign-power
On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
‘-malign-natural’ overrides the ABI-defined alignment of larger types, such
as floating-point doubles, on their natural size-based boundary. The option
‘-malign-power’ instructs GCC to follow the ABI-specified alignment rules.
GCC defaults to the standard alignment defined in the ABI.
On 64-bit Darwin, natural alignment is the default, and ‘-malign-power’ is not
supported.
430 Using the GNU Compiler Collection (GCC)
-msoft-float
-mhard-float
Generate code that does not use (uses) the floating-point register set. Software
floating-point emulation is provided if you use the ‘-msoft-float’ option, and
pass the option to GCC when linking.
-mmultiple
-mno-multiple
Generate code that uses (does not use) the load multiple word instructions
and the store multiple word instructions. These instructions are generated by
default on POWER systems, and not generated on PowerPC systems. Do not
use ‘-mmultiple’ on little-endian PowerPC systems, since those instructions
do not work when the processor is in little-endian mode. The exceptions are
PPC740 and PPC750 which permit these instructions in little-endian mode.
-mupdate
-mno-update
Generate code that uses (does not use) the load or store instructions that update
the base register to the address of the calculated memory location. These
instructions are generated by default. If you use ‘-mno-update’, there is a small
window between the time that the stack pointer is updated and the address of
the previous frame is stored, which means code that walks the stack frame
across interrupts or signals may get corrupted data.
-mavoid-indexed-addresses
-mno-avoid-indexed-addresses
Generate code that tries to avoid (not avoid) the use of indexed load or store
instructions. These instructions can incur a performance penalty on Power6
processors in certain situations, such as when stepping through large arrays
that cross a 16M boundary. This option is enabled by default when targeting
Power6 and disabled otherwise.
-mfused-madd
-mno-fused-madd
Generate code that uses (does not use) the floating-point multiply and ac-
cumulate instructions. These instructions are generated by default if hard-
ware floating point is used. The machine-dependent ‘-mfused-madd’ option is
now mapped to the machine-independent ‘-ffp-contract=fast’ option, and
‘-mno-fused-madd’ is mapped to ‘-ffp-contract=off’.
-mmulhw
-mno-mulhw
Generate code that uses (does not use) the half-word multiply and multiply-
accumulate instructions on the IBM 405, 440, 464 and 476 processors. These
instructions are generated by default when targeting those processors.
-mdlmzb
-mno-dlmzb
Generate code that uses (does not use) the string-search ‘dlmzb’ instruction on
the IBM 405, 440, 464 and 476 processors. This instruction is generated by
default when targeting those processors.
Chapter 3: GCC Command Options 431
-mno-bit-align
-mbit-align
On System V.4 and embedded PowerPC systems do not (do) force structures
and unions that contain bit-fields to be aligned to the base type of the bit-field.
For example, by default a structure containing nothing but 8 unsigned bit-
fields of length 1 is aligned to a 4-byte boundary and has a size of 4 bytes. By
using ‘-mno-bit-align’, the structure is aligned to a 1-byte boundary and is 1
byte in size.
-mno-strict-align
-mstrict-align
On System V.4 and embedded PowerPC systems do not (do) assume that un-
aligned memory references are handled by the system.
-mrelocatable
-mno-relocatable
Generate code that allows (does not allow) a static executable to be relocated
to a different address at run time. A simple embedded PowerPC system loader
should relocate the entire contents of .got2 and 4-byte locations listed in the
.fixup section, a table of 32-bit addresses generated by this option. For this
to work, all objects linked together must be compiled with ‘-mrelocatable’
or ‘-mrelocatable-lib’. ‘-mrelocatable’ code aligns the stack to an 8-byte
boundary.
-mrelocatable-lib
-mno-relocatable-lib
Like ‘-mrelocatable’, ‘-mrelocatable-lib’ generates a .fixup section to al-
low static executables to be relocated at run time, but ‘-mrelocatable-lib’
does not use the smaller stack alignment of ‘-mrelocatable’. Objects com-
piled with ‘-mrelocatable-lib’ may be linked with objects compiled with any
combination of the ‘-mrelocatable’ options.
-mno-toc
-mtoc On System V.4 and embedded PowerPC systems do not (do) assume that reg-
ister 2 contains a pointer to a global area pointing to the addresses used in the
program.
-mlittle
-mlittle-endian
On System V.4 and embedded PowerPC systems compile code for the processor
in little-endian mode. The ‘-mlittle-endian’ option is the same as ‘-mlittle’.
-mbig
-mbig-endian
On System V.4 and embedded PowerPC systems compile code for the processor
in big-endian mode. The ‘-mbig-endian’ option is the same as ‘-mbig’.
-mdynamic-no-pic
On Darwin and Mac OS X systems, compile code so that it is not relocatable,
but that its external references are relocatable. The resulting code is suitable
for applications, but not shared libraries.
432 Using the GNU Compiler Collection (GCC)
-msingle-pic-base
Treat the register used for PIC addressing as read-only, rather than loading
it in the prologue for each function. The runtime system is responsible for
initializing this register with an appropriate value before execution begins.
-mprioritize-restricted-insns=priority
This option controls the priority that is assigned to dispatch-slot restricted
instructions during the second scheduling pass. The argument priority takes
the value ‘0’, ‘1’, or ‘2’ to assign no, highest, or second-highest (respectively)
priority to dispatch-slot restricted instructions.
-msched-costly-dep=dependence_type
This option controls which dependences are considered costly by the target
during instruction scheduling. The argument dependence type takes one of the
following values:
‘no’ No dependence is costly.
‘all’ All dependences are costly.
‘true_store_to_load’
A true dependence from store to load is costly.
‘store_to_load’
Any dependence from store to load is costly.
number Any dependence for which the latency is greater than or equal to
number is costly.
-minsert-sched-nops=scheme
This option controls which NOP insertion scheme is used during the second
scheduling pass. The argument scheme takes one of the following values:
‘no’ Don’t insert NOPs.
‘pad’ Pad with NOPs any dispatch group that has vacant issue slots,
according to the scheduler’s grouping.
‘regroup_exact’
Insert NOPs to force costly dependent insns into separate groups.
Insert exactly as many NOPs as needed to force an insn to a new
group, according to the estimated processor grouping.
number Insert NOPs to force costly dependent insns into separate groups.
Insert number NOPs to force an insn to a new group.
-mcall-sysv
On System V.4 and embedded PowerPC systems compile code using calling
conventions that adhere to the March 1995 draft of the System V Application
Binary Interface, PowerPC processor supplement. This is the default unless
you configured GCC using ‘powerpc-*-eabiaix’.
-mcall-sysv-eabi
-mcall-eabi
Specify both ‘-mcall-sysv’ and ‘-meabi’ options.
Chapter 3: GCC Command Options 433
-mcall-sysv-noeabi
Specify both ‘-mcall-sysv’ and ‘-mno-eabi’ options.
-mcall-aixdesc
On System V.4 and embedded PowerPC systems compile code for the AIX
operating system.
-mcall-linux
On System V.4 and embedded PowerPC systems compile code for the Linux-
based GNU system.
-mcall-freebsd
On System V.4 and embedded PowerPC systems compile code for the FreeBSD
operating system.
-mcall-netbsd
On System V.4 and embedded PowerPC systems compile code for the NetBSD
operating system.
-mcall-openbsd
On System V.4 and embedded PowerPC systems compile code for the OpenBSD
operating system.
-mtraceback=traceback_type
Select the type of traceback table. Valid values for traceback type are ‘full’,
‘part’, and ‘no’.
-maix-struct-return
Return all structures in memory (as specified by the AIX ABI).
-msvr4-struct-return
Return structures smaller than 8 bytes in registers (as specified by the SVR4
ABI).
-mabi=abi-type
Extend the current ABI with a particular extension, or remove such
extension. Valid values are: ‘altivec’, ‘no-altivec’, ‘ibmlongdouble’,
‘ieeelongdouble’, ‘elfv1’, ‘elfv2’, and for AIX: ‘vec-extabi’,
‘vec-default’.
-mabi=ibmlongdouble
Change the current ABI to use IBM extended-precision long double. This is
not likely to work if your system defaults to using IEEE extended-precision long
double. If you change the long double type from IEEE extended-precision, the
compiler will issue a warning unless you use the ‘-Wno-psabi’ option. Requires
‘-mlong-double-128’ to be enabled.
-mabi=ieeelongdouble
Change the current ABI to use IEEE extended-precision long double. This is
not likely to work if your system defaults to using IBM extended-precision long
double. If you change the long double type from IBM extended-precision, the
compiler will issue a warning unless you use the ‘-Wno-psabi’ option. Requires
‘-mlong-double-128’ to be enabled.
434 Using the GNU Compiler Collection (GCC)
-mabi=elfv1
Change the current ABI to use the ELFv1 ABI. This is the default ABI for
big-endian PowerPC 64-bit Linux. Overriding the default ABI requires special
system support and is likely to fail in spectacular ways.
-mabi=elfv2
Change the current ABI to use the ELFv2 ABI. This is the default ABI for
little-endian PowerPC 64-bit Linux. Overriding the default ABI requires special
system support and is likely to fail in spectacular ways.
-mgnu-attribute
-mno-gnu-attribute
Emit .gnu attribute assembly directives to set tag/value pairs in a
.gnu.attributes section that specify ABI variations in function parameters or
return values.
-mprototype
-mno-prototype
On System V.4 and embedded PowerPC systems assume that all calls to vari-
able argument functions are properly prototyped. Otherwise, the compiler must
insert an instruction before every non-prototyped call to set or clear bit 6 of the
condition code register (CR) to indicate whether floating-point values are passed
in the floating-point registers in case the function takes variable arguments.
With ‘-mprototype’, only calls to prototyped variable argument functions set
or clear the bit.
-msim On embedded PowerPC systems, assume that the startup module is called
‘sim-crt0.o’ and that the standard C libraries are ‘libsim.a’ and ‘libc.a’.
This is the default for ‘powerpc-*-eabisim’ configurations.
-mmvme On embedded PowerPC systems, assume that the startup module is called
‘crt0.o’ and the standard C libraries are ‘libmvme.a’ and ‘libc.a’.
-mads On embedded PowerPC systems, assume that the startup module is called
‘crt0.o’ and the standard C libraries are ‘libads.a’ and ‘libc.a’.
-myellowknife
On embedded PowerPC systems, assume that the startup module is called
‘crt0.o’ and the standard C libraries are ‘libyk.a’ and ‘libc.a’.
-mvxworks
On System V.4 and embedded PowerPC systems, specify that you are compiling
for a VxWorks system.
-memb On embedded PowerPC systems, set the PPC_EMB bit in the ELF flags header
to indicate that ‘eabi’ extended relocations are used.
-meabi
-mno-eabi
On System V.4 and embedded PowerPC systems do (do not) adhere to the
Embedded Applications Binary Interface (EABI), which is a set of modifications
to the System V.4 specifications. Selecting ‘-meabi’ means that the stack is
Chapter 3: GCC Command Options 435
expansion (non-loop and loop) of block compare is disabled. The default value
is target-specific.
-mblock-compare-inline-loop-limit=num
Generate an inline expansion using loop code for all block compares that are
less than or equal to num bytes, but greater than the limit for non-loop inline
block compare expansion. If the block length is not constant, at most num
bytes will be compared before memcmp is called to compare the remainder of the
block. The default value is target-specific.
-mstring-compare-inline-limit=num
Compare at most num string bytes with inline code. If the difference or end of
string is not found at the end of the inline compare a call to strcmp or strncmp
will take care of the rest of the comparison. The default is 64 bytes.
-G num On embedded PowerPC systems, put global and static items less than or equal
to num bytes into the small data or BSS sections instead of the normal data or
BSS section. By default, num is 8. The ‘-G num’ switch is also passed to the
linker. All modules should be compiled with the same ‘-G num’ value.
-mregnames
-mno-regnames
On System V.4 and embedded PowerPC systems do (do not) emit register
names in the assembly language output using symbolic forms.
-mlongcall
-mno-longcall
By default assume that all calls are far away so that a longer and more expensive
calling sequence is required. This is required for calls farther than 32 megabytes
(33,554,432 bytes) from the current location. A short call is generated if the
compiler knows the call cannot be that far away. This setting can be overridden
by the shortcall function attribute, or by #pragma longcall(0).
Some linkers are capable of detecting out-of-range calls and generating glue
code on the fly. On these systems, long calls are unnecessary and generate
slower code. As of this writing, the AIX linker can do this, as can the GNU
linker for PowerPC/64. It is planned to add this feature to the GNU linker for
32-bit PowerPC systems as well.
On PowerPC64 ELFv2 and 32-bit PowerPC systems with newer GNU linkers,
GCC can generate long calls using an inline PLT call sequence (see ‘-mpltseq’).
PowerPC with ‘-mbss-plt’ and PowerPC64 ELFv1 (big-endian) do not support
inline PLT calls.
On Darwin/PPC systems, #pragma longcall generates jbsr callee, L42,
plus a branch island (glue code). The two target addresses represent the callee
and the branch island. The Darwin/PPC linker prefers the first address and
generates a bl callee if the PPC bl instruction reaches the callee directly;
otherwise, the linker generates bl L42 to call the branch island. The branch
island is appended to the body of the calling function; it computes the full
32-bit address of the callee and jumps to it.
Chapter 3: GCC Command Options 437
On Mach-O (Darwin) systems, this option directs the compiler emit to the glue
for every direct call, and the Darwin linker decides whether to use or discard
it.
In the future, GCC may ignore all longcall specifications when the linker is
known to generate glue.
-mpltseq
-mno-pltseq
Implement (do not implement) -fno-plt and long calls using an inline PLT call
sequence that supports lazy linking and long calls to functions in dlopen’d
shared libraries. Inline PLT calls are only supported on PowerPC64 ELFv2
and 32-bit PowerPC systems with newer GNU linkers, and are enabled by
default if the support is detected when configuring GCC, and, in the case of
32-bit PowerPC, if GCC is configured with ‘--enable-secureplt’. ‘-mpltseq’
code and ‘-mbss-plt’ 32-bit PowerPC relocatable objects may not be linked
together.
-mtls-markers
-mno-tls-markers
Mark (do not mark) calls to __tls_get_addr with a relocation specifying the
function argument. The relocation allows the linker to reliably associate func-
tion call with argument setup instructions for TLS optimization, which in turn
allows GCC to better schedule the sequence.
-mrecip
-mno-recip
This option enables use of the reciprocal estimate and reciprocal square
root estimate instructions with additional Newton-Raphson steps to increase
precision instead of doing a divide or square root and divide for floating-point
arguments. You should use the ‘-ffast-math’ option when using ‘-mrecip’
(or at least ‘-funsafe-math-optimizations’, ‘-ffinite-math-only’,
‘-freciprocal-math’ and ‘-fno-trapping-math’). Note that while the
throughput of the sequence is generally higher than the throughput of the
non-reciprocal instruction, the precision of the sequence can be decreased by
up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994) for reciprocal square
roots.
-mrecip=opt
This option controls which reciprocal estimate instructions may be used. opt
is a comma-separated list of options, which may be preceded by a ! to invert
the option:
‘all’ Enable all estimate instructions.
‘default’ Enable the default instructions, equivalent to ‘-mrecip’.
‘none’ Disable all estimate instructions, equivalent to ‘-mno-recip’.
‘div’ Enable the reciprocal approximation instructions for both single
and double precision.
‘divf’ Enable the single-precision reciprocal approximation instructions.
438 Using the GNU Compiler Collection (GCC)
pointer points to a 3-word descriptor giving the function address, TOC value to
be loaded in register r2, and static chain value to be loaded in register r11. The
‘-mpointers-to-nested-functions’ is on by default. You cannot call through
pointers to nested functions or pointers to functions compiled in other languages
that use the static chain if you use ‘-mno-pointers-to-nested-functions’.
-msave-toc-indirect
-mno-save-toc-indirect
Generate (do not generate) code to save the TOC value in the reserved stack
location in the function prologue if the function calls through a pointer on AIX
and 64-bit Linux systems. If the TOC value is not saved in the prologue, it is
saved just before the call through the pointer. The ‘-mno-save-toc-indirect’
option is the default.
-mcompat-align-parm
-mno-compat-align-parm
Generate (do not generate) code to pass structure parameters with a maximum
alignment of 64 bits, for compatibility with older versions of GCC.
Older versions of GCC (prior to 4.9.0) incorrectly did not align a structure
parameter on a 128-bit boundary when that structure contained a member
requiring 128-bit alignment. This is corrected in more recent versions of GCC.
This option may be used to generate code that is compatible with functions
compiled with older versions of GCC.
The ‘-mno-compat-align-parm’ option is the default.
-mstack-protector-guard=guard
-mstack-protector-guard-reg=reg
-mstack-protector-guard-offset=offset
-mstack-protector-guard-symbol=symbol
Generate stack protection code using canary at guard. Supported locations are
‘global’ for global canary or ‘tls’ for per-thread canary in the TLS block (the
default with GNU libc version 2.4 or later).
With the latter choice the options ‘-mstack-protector-guard-reg=reg’ and
‘-mstack-protector-guard-offset=offset’ furthermore specify which regis-
ter to use as base register for reading the canary, and from what offset from
that base register. The default for those is as specified in the relevant ABI.
‘-mstack-protector-guard-symbol=symbol’ overrides the offset with a sym-
bol reference to a canary in the TLS block.
-mpcrel
-mno-pcrel
Generate (do not generate) pc-relative addressing. The ‘-mpcrel’ option re-
quires that the medium code model (‘-mcmodel=medium’) and prefixed address-
ing (‘-mprefixed’) options are enabled.
-mprefixed
-mno-prefixed
Generate (do not generate) addressing modes using prefixed load and store in-
structions. The ‘-mprefixed’ option requires that the option ‘-mcpu=power10’
(or later) is enabled.
440 Using the GNU Compiler Collection (GCC)
-mmma
-mno-mma Generate (do not generate) the MMA instructions. The ‘-mma’ option requires
that the option ‘-mcpu=power10’ (or later) is enabled.
-mrop-protect
-mno-rop-protect
Generate (do not generate) ROP protection instructions when the target proces-
sor supports them. Currently this option disables the shrink-wrap optimization
(‘-fshrink-wrap’).
-mprivileged
-mno-privileged
Generate (do not generate) code that will run in privileged state.
-mblock-ops-unaligned-vsx
-mno-block-ops-unaligned-vsx
Generate (do not generate) unaligned vsx loads and stores for inline expansion
of memcpy and memmove.
3.19.46 RX Options
These command-line options are defined for RX targets:
-m64bit-doubles
-m32bit-doubles
Make the double data type be 64 bits (‘-m64bit-doubles’) or 32 bits
(‘-m32bit-doubles’) in size. The default is ‘-m32bit-doubles’. Note RX
floating-point hardware only works on 32-bit values, which is why the default
is ‘-m32bit-doubles’.
-fpu
-nofpu Enables (‘-fpu’) or disables (‘-nofpu’) the use of RX floating-point hardware.
The default is enabled for the RX600 series and disabled for the RX200 series.
Floating-point instructions are only generated for 32-bit floating-point values,
however, so the FPU hardware is not used for doubles if the ‘-m64bit-doubles’
option is used.
Note If the ‘-fpu’ option is enabled then ‘-funsafe-math-optimizations’ is
also enabled automatically. This is because the RX FPU instructions are them-
selves unsafe.
-mcpu=name
Selects the type of RX CPU to be targeted. Currently three types are sup-
ported, the generic ‘RX600’ and ‘RX200’ series hardware and the specific ‘RX610’
CPU. The default is ‘RX600’.
The only difference between ‘RX600’ and ‘RX610’ is that the ‘RX610’ does not
support the MVTIPL instruction.
The ‘RX200’ series does not have a hardware floating-point unit and so ‘-nofpu’
is enabled by default when this type is selected.
Chapter 3: GCC Command Options 441
-mbig-endian-data
-mlittle-endian-data
Store data (but not code) in the big-endian format. The default is
‘-mlittle-endian-data’, i.e. to store data in the little-endian format.
-msmall-data-limit=N
Specifies the maximum size in bytes of global and static variables which can be
placed into the small data area. Using the small data area can lead to smaller
and faster code, but the size of area is limited and it is up to the programmer to
ensure that the area does not overflow. Also when the small data area is used
one of the RX’s registers (usually r13) is reserved for use pointing to this area,
so it is no longer available for use by the compiler. This could result in slower
and/or larger code if variables are pushed onto the stack instead of being held
in this register.
Note, common variables (variables that have not been initialized) and constants
are not placed into the small data area as they are assigned to other sections
in the output executable.
The default value is zero, which disables this feature. Note, this feature is not
enabled by default with higher optimization levels (‘-O2’ etc) because of the
potentially detrimental effects of reserving a register. It is up to the programmer
to experiment and discover whether this feature is of benefit to their program.
See the description of the ‘-mpid’ option for a description of how the actual
register to hold the small data area pointer is chosen.
-msim
-mno-sim Use the simulator runtime. The default is to use the libgloss board-specific
runtime.
-mas100-syntax
-mno-as100-syntax
When generating assembler output use a syntax that is compatible with Rene-
sas’s AS100 assembler. This syntax can also be handled by the GAS assembler,
but it has some restrictions so it is not generated by default.
-mmax-constant-size=N
Specifies the maximum size, in bytes, of a constant that can be used as an
operand in a RX instruction. Although the RX instruction set does allow
constants of up to 4 bytes in length to be used in instructions, a longer value
equates to a longer instruction. Thus in some circumstances it can be beneficial
to restrict the size of constants that are used in instructions. Constants that
are too big are instead placed into a constant pool and referenced via register
indirection.
The value N can be between 0 and 4. A value of 0 (the default) or 4 means
that constants of any size are allowed.
-mrelax Enable linker relaxation. Linker relaxation is a process whereby the linker
attempts to reduce the size of a program by finding shorter versions of various
instructions. Disabled by default.
442 Using the GNU Compiler Collection (GCC)
-mint-register=N
Specify the number of registers to reserve for fast interrupt handler functions.
The value N can be between 0 and 4. A value of 1 means that register r13 is
reserved for the exclusive use of fast interrupt handlers. A value of 2 reserves
r13 and r12. A value of 3 reserves r13, r12 and r11, and a value of 4 reserves
r13 through r10. A value of 0, the default, does not reserve any registers.
-msave-acc-in-interrupts
Specifies that interrupt handler functions should preserve the accumulator reg-
ister. This is only necessary if normal code might use the accumulator register,
for example because it performs 64-bit multiplications. The default is to ignore
the accumulator as this makes the interrupt handlers faster.
-mpid
-mno-pid Enables the generation of position independent data. When enabled any access
to constant data is done via an offset from a base address held in a register.
This allows the location of constant data to be determined at run time with-
out requiring the executable to be relocated, which is a benefit to embedded
applications with tight memory constraints. Data that can be modified is not
affected by this option.
Note, using this feature reserves a register, usually r13, for the constant data
base address. This can result in slower and/or larger code, especially in com-
plicated functions.
The actual register chosen to hold the constant data base address depends upon
whether the ‘-msmall-data-limit’ and/or the ‘-mint-register’ command-
line options are enabled. Starting with register r13 and proceeding downwards,
registers are allocated first to satisfy the requirements of ‘-mint-register’,
then ‘-mpid’ and finally ‘-msmall-data-limit’. Thus it is possible for the
small data area register to be r8 if both ‘-mint-register=4’ and ‘-mpid’ are
specified on the command line.
By default this feature is not enabled. The default can be restored via the
‘-mno-pid’ command-line option.
-mno-warn-multiple-fast-interrupts
-mwarn-multiple-fast-interrupts
Prevents GCC from issuing a warning message if it finds more than one fast
interrupt handler when it is compiling a file. The default is to issue a warning
for each extra fast interrupt handler found, as the RX only supports one such
interrupt.
-mallow-string-insns
-mno-allow-string-insns
Enables or disables the use of the string manipulation instructions SMOVF,
SCMPU, SMOVB, SMOVU, SUNTIL SWHILE and also the RMPA instruction. These
instructions may prefetch data, which is not safe to do if accessing an I/O
register. (See section 12.2.7 of the RX62N Group User’s Manual for more in-
formation).
The default is to allow these instructions, but it is not possible for GCC to
reliably detect all circumstances where a string instruction might be used to
Chapter 3: GCC Command Options 443
generating code compliant to the GNU/Linux for S/390 ABI, the default is
‘-mesa’. When generating code compliant to the GNU/Linux for zSeries ABI,
the default is ‘-mzarch’.
-mhtm
-mno-htm The ‘-mhtm’ option enables a set of builtins making use of instructions available
with the transactional execution facility introduced with the IBM zEnterprise
EC12 machine generation Section 6.60.30 [S/390 System z Built-in Functions],
page 838. ‘-mhtm’ is enabled by default when using ‘-march=zEC12’.
-mvx
-mno-vx When ‘-mvx’ is specified, generate code using the instructions available with the
vector extension facility introduced with the IBM z13 machine generation. This
option changes the ABI for some vector type values with regard to alignment
and calling conventions. In case vector type values are being used in an ABI-
relevant context a GAS ‘.gnu_attribute’ command will be added to mark the
resulting binary with the ABI used. ‘-mvx’ is enabled by default when using
‘-march=z13’.
-mzvector
-mno-zvector
The ‘-mzvector’ option enables vector language extensions and builtins using
instructions available with the vector extension facility introduced with the
IBM z13 machine generation. This option adds support for ‘vector’ to be
used as a keyword to define vector type variables and arguments. ‘vector’
is only available when GNU extensions are enabled. It will not be expanded
when requesting strict standard compliance e.g. with ‘-std=c99’. In addition
to the GCC low-level builtins ‘-mzvector’ enables a set of builtins added for
compatibility with AltiVec-style implementations like Power and Cell. In order
to make use of these builtins the header file ‘vecintrin.h’ needs to be included.
‘-mzvector’ is disabled by default.
-mmvcle
-mno-mvcle
Generate (or do not generate) code using the mvcle instruction to perform
block moves. When ‘-mno-mvcle’ is specified, use a mvc loop instead. This is
the default unless optimizing for size.
-mdebug
-mno-debug
Print (or do not print) additional debug information when compiling. The
default is to not print debug information.
-march=cpu-type
Generate code that runs on cpu-type, which is the name of a system
representing a certain processor type. Possible values for cpu-type are
‘z900’/‘arch5’, ‘z990’/‘arch6’, ‘z9-109’, ‘z9-ec’/‘arch7’, ‘z10’/‘arch8’,
‘z196’/‘arch9’, ‘zEC12’, ‘z13’/‘arch11’, ‘z14’/‘arch12’, ‘z15’/‘arch13’,
‘z16’/‘arch14’, and ‘native’.
The default is ‘-march=z900’.
446 Using the GNU Compiler Collection (GCC)
Specifying ‘native’ as cpu type can be used to select the best architecture
option for the host processor. ‘-march=native’ has no effect if GCC does not
recognize the processor.
-mtune=cpu-type
Tune to cpu-type everything applicable about the generated code, except for
the ABI and the set of available instructions. The list of cpu-type values is the
same as for ‘-march’. The default is the value used for ‘-march’.
-mtpf-trace
-mno-tpf-trace
Generate code that adds (does not add) in TPF OS specific branches to trace
routines in the operating system. This option is off by default, even when
compiling for the TPF OS.
-mtpf-trace-skip
-mno-tpf-trace-skip
Generate code that changes (does not change) the default branch targets en-
abled by ‘-mtpf-trace’ to point to specialized trace routines providing the
ability of selectively skipping function trace entries for the TPF OS. This op-
tion is off by default, even when compiling for the TPF OS and specifying
‘-mtpf-trace’.
-mfused-madd
-mno-fused-madd
Generate code that uses (does not use) the floating-point multiply and accu-
mulate instructions. These instructions are generated by default if hardware
floating point is used.
-mwarn-framesize=framesize
Emit a warning if the current function exceeds the given frame size. Because
this is a compile-time check it doesn’t need to be a real problem when the
program runs. It is intended to identify functions that most probably cause a
stack overflow. It is useful to be used in an environment with limited stack size
e.g. the linux kernel.
-mwarn-dynamicstack
Emit a warning if the function calls alloca or uses dynamically-sized arrays.
This is generally a bad idea with a limited stack size.
-mstack-guard=stack-guard
-mstack-size=stack-size
If these options are provided the S/390 back end emits additional instructions
in the function prologue that trigger a trap if the stack size is stack-guard bytes
above the stack-size (remember that the stack on S/390 grows downward).
If the stack-guard option is omitted the smallest power of 2 larger than the
frame size of the compiled function is chosen. These options are intended to
be used to help debugging stack overflow problems. The additionally emitted
code causes only little overhead and hence can also be used in production-like
systems without greater performance degradation. The given values have to be
exact powers of 2 and stack-size has to be greater than stack-guard without
Chapter 3: GCC Command Options 447
exceeding 64k. In order to be efficient the extra code makes the assumption
that the stack starts at an address aligned to the value given by stack-size. The
stack-guard option can only be used in conjunction with stack-size.
-mhotpatch=pre-halfwords,post-halfwords
If the hotpatch option is enabled, a “hot-patching” function prologue is gener-
ated for all functions in the compilation unit. The funtion label is prepended
with the given number of two-byte NOP instructions (pre-halfwords, maximum
1000000). After the label, 2 * post-halfwords bytes are appended, using the
largest NOP like instructions the architecture allows (maximum 1000000).
If both arguments are zero, hotpatching is disabled.
This option can be overridden for individual functions with the hotpatch at-
tribute.
3.19.49 SH Options
These ‘-m’ options are defined for the SH implementations:
-m1 Generate code for the SH1.
-m2 Generate code for the SH2.
-m2e Generate code for the SH2e.
-m2a-nofpu
Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
that the floating-point unit is not used.
-m2a-single-only
Generate code for the SH2a-FPU, in such a way that no double-precision
floating-point operations are used.
448 Using the GNU Compiler Collection (GCC)
-m2a-single
Generate code for the SH2a-FPU assuming the floating-point unit is in single-
precision mode by default.
-m2a Generate code for the SH2a-FPU assuming the floating-point unit is in double-
precision mode by default.
-m3 Generate code for the SH3.
-m3e Generate code for the SH3e.
-m4-nofpu
Generate code for the SH4 without a floating-point unit.
-m4-single-only
Generate code for the SH4 with a floating-point unit that only supports single-
precision arithmetic.
-m4-single
Generate code for the SH4 assuming the floating-point unit is in single-precision
mode by default.
-m4 Generate code for the SH4.
-m4-100 Generate code for SH4-100.
-m4-100-nofpu
Generate code for SH4-100 in such a way that the floating-point unit is not
used.
-m4-100-single
Generate code for SH4-100 assuming the floating-point unit is in single-precision
mode by default.
-m4-100-single-only
Generate code for SH4-100 in such a way that no double-precision floating-point
operations are used.
-m4-200 Generate code for SH4-200.
-m4-200-nofpu
Generate code for SH4-200 without in such a way that the floating-point unit
is not used.
-m4-200-single
Generate code for SH4-200 assuming the floating-point unit is in single-precision
mode by default.
-m4-200-single-only
Generate code for SH4-200 in such a way that no double-precision floating-point
operations are used.
-m4-300 Generate code for SH4-300.
-m4-300-nofpu
Generate code for SH4-300 without in such a way that the floating-point unit
is not used.
Chapter 3: GCC Command Options 449
-m4-300-single
Generate code for SH4-300 in such a way that no double-precision floating-point
operations are used.
-m4-300-single-only
Generate code for SH4-300 in such a way that no double-precision floating-point
operations are used.
-m4-340 Generate code for SH4-340 (no MMU, no FPU).
-m4-500 Generate code for SH4-500 (no FPU). Passes ‘-isa=sh4-nofpu’ to the assem-
bler.
-m4a-nofpu
Generate code for the SH4al-dsp, or for a SH4a in such a way that the floating-
point unit is not used.
-m4a-single-only
Generate code for the SH4a, in such a way that no double-precision floating-
point operations are used.
-m4a-single
Generate code for the SH4a assuming the floating-point unit is in
single-precision mode by default.
-m4a Generate code for the SH4a.
-m4al Same as ‘-m4a-nofpu’, except that it implicitly passes ‘-dsp’ to the assembler.
GCC doesn’t generate any DSP instructions at the moment.
-mb Compile code for the processor in big-endian mode.
-ml Compile code for the processor in little-endian mode.
-mdalign Align doubles at 64-bit boundaries. Note that this changes the calling conven-
tions, and thus some functions from the standard C library do not work unless
you recompile it first with ‘-mdalign’.
-mrelax Shorten some address references at link time, when possible; uses the linker
option ‘-relax’.
-mbigtable
Use 32-bit offsets in switch tables. The default is to use 16-bit offsets.
-mbitops Enable the use of bit manipulation instructions on SH2A.
-mfmovd Enable the use of the instruction fmovd. Check ‘-mdalign’ for alignment con-
straints.
-mrenesas
Comply with the calling conventions defined by Renesas.
-mno-renesas
Comply with the calling conventions defined for GCC before the Renesas con-
ventions were available. This option is the default for all targets of the SH
toolchain.
450 Using the GNU Compiler Collection (GCC)
-mnomacsave
Mark the MAC register as call-clobbered, even if ‘-mrenesas’ is given.
-mieee
-mno-ieee
Control the IEEE compliance of floating-point comparisons, which affects the
handling of cases where the result of a comparison is unordered. By default
‘-mieee’ is implicitly enabled. If ‘-ffinite-math-only’ is enabled ‘-mno-ieee’
is implicitly set, which results in faster floating-point greater-equal and less-
equal comparisons. The implicit settings can be overridden by specifying either
‘-mieee’ or ‘-mno-ieee’.
-minline-ic_invalidate
Inline code to invalidate instruction cache entries after setting up nested func-
tion trampolines. This option has no effect if ‘-musermode’ is in effect and the
selected code generation option (e.g. ‘-m4’) does not allow the use of the icbi
instruction. If the selected code generation option does not allow the use of
the icbi instruction, and ‘-musermode’ is not in effect, the inlined code ma-
nipulates the instruction cache address array directly with an associative write.
This not only requires privileged mode at run time, but it also fails if the cache
line had been mapped via the TLB and has become unmapped.
-misize Dump instruction size and location in the assembly code.
-mpadstruct
This option is deprecated. It pads structures to multiple of 4 bytes, which is
incompatible with the SH ABI.
-matomic-model=model
Sets the model of atomic operations and additional parameters as a comma
separated list. For details on the atomic built-in functions see Section 6.55
[ atomic Builtins], page 719. The following models and parameters are sup-
ported:
‘none’ Disable compiler generated atomic sequences and emit library calls
for atomic operations. This is the default if the target is not sh*-
*-linux*.
‘soft-gusa’
Generate GNU/Linux compatible gUSA software atomic sequences
for the atomic built-in functions. The generated atomic sequences
require additional support from the interrupt/exception handling
code of the system and are only suitable for SH3* and SH4* single-
core systems. This option is enabled by default when the target
is sh*-*-linux* and SH3* or SH4*. When the target is SH4A,
this option also partially utilizes the hardware atomic instructions
movli.l and movco.l to create more efficient code, unless ‘strict’
is specified.
‘soft-tcb’
Generate software atomic sequences that use a variable in the
thread control block. This is a variation of the gUSA sequences
Chapter 3: GCC Command Options 451
would not work in user mode. ‘-musermode’ is the default when the target is
sh*-*-linux*. If the target is SH1* or SH2* ‘-musermode’ has no effect, since
there is no user mode.
-multcost=number
Set the cost to assume for a multiply insn.
-mdiv=strategy
Set the division strategy to be used for integer division operations. strategy
can be one of:
‘call-div1’
Calls a library function that uses the single-step division instruc-
tion div1 to perform the operation. Division by zero calculates an
unspecified result and does not trap. This is the default except for
SH4, SH2A and SHcompact.
‘call-fp’ Calls a library function that performs the operation in double pre-
cision floating point. Division by zero causes a floating-point ex-
ception. This is the default for SHcompact with FPU. Specifying
this for targets that do not have a double precision FPU defaults
to call-div1.
‘call-table’
Calls a library function that uses a lookup table for small divisors
and the div1 instruction with case distinction for larger divisors.
Division by zero calculates an unspecified result and does not trap.
This is the default for SH4. Specifying this for targets that do not
have dynamic shift instructions defaults to call-div1.
When a division strategy has not been specified the default strategy is selected
based on the current target. For SH2A the default strategy is to use the divs
and divu instructions instead of library function calls.
-maccumulate-outgoing-args
Reserve space once for outgoing arguments in the function prologue rather than
around each call. Generally beneficial for performance and size. Also needed
for unwinding to avoid changing the stack frame around conditional code.
-mdivsi3_libfunc=name
Set the name of the library function used for 32-bit signed division to name.
This only affects the name used in the ‘call’ division strategies, and the com-
piler still expects the same sets of input/output/clobbered registers as if this
option were not present.
-mfixed-range=register-range
Generate code treating the given register range as fixed registers. A fixed regis-
ter is one that the register allocator cannot use. This is useful when compiling
kernel code. A register range is specified as two registers separated by a dash.
Multiple register ranges can be specified separated by a comma.
Chapter 3: GCC Command Options 453
-mbranch-cost=num
Assume num to be the cost for a branch instruction. Higher numbers make the
compiler try to generate more branch-free code if possible. If not specified the
value is selected depending on the processor type that is being compiled for.
-mzdcbranch
-mno-zdcbranch
Assume (do not assume) that zero displacement conditional branch instruc-
tions bt and bf are fast. If ‘-mzdcbranch’ is specified, the compiler prefers
zero displacement branch code sequences. This is enabled by default when
generating code for SH4 and SH4A. It can be explicitly disabled by specifying
‘-mno-zdcbranch’.
-mcbranch-force-delay-slot
Force the usage of delay slots for conditional branches, which stuffs the delay
slot with a nop if a suitable instruction cannot be found. By default this option
is disabled. It can be enabled to work around hardware bugs as found in the
original SH7055.
-mfused-madd
-mno-fused-madd
Generate code that uses (does not use) the floating-point multiply and ac-
cumulate instructions. These instructions are generated by default if hard-
ware floating point is used. The machine-dependent ‘-mfused-madd’ option is
now mapped to the machine-independent ‘-ffp-contract=fast’ option, and
‘-mno-fused-madd’ is mapped to ‘-ffp-contract=off’.
-mfsca
-mno-fsca
Allow or disallow the compiler to emit the fsca instruction for sine and co-
sine approximations. The option ‘-mfsca’ must be used in combination with
‘-funsafe-math-optimizations’. It is enabled by default when generating
code for SH4A. Using ‘-mno-fsca’ disables sine and cosine approximations even
if ‘-funsafe-math-optimizations’ is in effect.
-mfsrra
-mno-fsrra
Allow or disallow the compiler to emit the fsrra instruction for reciprocal
square root approximations. The option ‘-mfsrra’ must be used in combina-
tion with ‘-funsafe-math-optimizations’ and ‘-ffinite-math-only’. It is
enabled by default when generating code for SH4A. Using ‘-mno-fsrra’ disables
reciprocal square root approximations even if ‘-funsafe-math-optimizations’
and ‘-ffinite-math-only’ are in effect.
-mpretend-cmove
Prefer zero-displacement conditional branches for conditional move instruction
patterns. This can result in faster code on the SH4 processor.
-mno-fpu
-msoft-float
Generate output containing library calls for floating point. Warning: the req-
uisite libraries are not available for all SPARC targets. Normally the facilities
of the machine’s usual C compiler are used, but this cannot be done directly in
cross-compilation. You must make your own arrangements to provide suitable
library functions for cross-compilation. The embedded targets ‘sparc-*-aout’
and ‘sparclite-*-*’ do provide software floating-point support.
‘-msoft-float’ changes the calling convention in the output file; therefore, it
is only useful if you compile all of a program with this option. In particu-
lar, you need to compile ‘libgcc.a’, the library that comes with GCC, with
‘-msoft-float’ in order for this to work.
-mhard-quad-float
Generate output containing quad-word (long double) floating-point instruc-
tions.
-msoft-quad-float
Generate output containing library calls for quad-word (long double) floating-
point instructions. The functions called are those specified in the SPARC ABI.
This is the default.
As of this writing, there are no SPARC implementations that have hardware
support for the quad-word floating-point instructions. They all invoke a trap
handler for one of these instructions, and then the trap handler emulates the
effect of the instruction. Because of the trap handler overhead, this is much
slower than calling the ABI library routines. Thus the ‘-msoft-quad-float’
option is the default.
-mno-unaligned-doubles
-munaligned-doubles
Assume that doubles have 8-byte alignment. This is the default.
With ‘-munaligned-doubles’, GCC assumes that doubles have 8-byte align-
ment only if they are contained in another type, or if they have an absolute
address. Otherwise, it assumes they have 4-byte alignment. Specifying this
option avoids some rare compatibility problems with code generated by other
compilers. It is not the default because it results in a performance loss, espe-
cially for floating-point code.
-muser-mode
-mno-user-mode
Do not generate code that can only run in supervisor mode. This is relevant
only for the casa instruction emitted for the LEON3 processor. This is the
default.
-mfaster-structs
-mno-faster-structs
With ‘-mfaster-structs’, the compiler assumes that structures should have
8-byte alignment. This enables the use of pairs of ldd and std instructions
for copies in structure assignment, in place of twice as many ld and st pairs.
456 Using the GNU Compiler Collection (GCC)
However, the use of this changed alignment directly violates the SPARC ABI.
Thus, it’s intended only for use on targets where the developer acknowledges
that their resulting code is not directly in line with the rules of the ABI.
-mstd-struct-return
-mno-std-struct-return
With ‘-mstd-struct-return’, the compiler generates checking code in func-
tions returning structures or unions to detect size mismatches between the two
sides of function calls, as per the 32-bit ABI.
The default is ‘-mno-std-struct-return’. This option has no effect in 64-bit
mode.
-mlra
-mno-lra Enable Local Register Allocation. This is the default for SPARC since GCC 7
so ‘-mno-lra’ needs to be passed to get old Reload.
-mcpu=cpu_type
Set the instruction set, register set, and instruction scheduling parameters for
machine type cpu type. Supported values for cpu type are ‘v7’, ‘cypress’,
‘v8’, ‘supersparc’, ‘hypersparc’, ‘leon’, ‘leon3’, ‘leon3v7’, ‘leon5’,
‘sparclite’, ‘f930’, ‘f934’, ‘sparclite86x’, ‘sparclet’, ‘tsc701’, ‘v9’,
‘ultrasparc’, ‘ultrasparc3’, ‘niagara’, ‘niagara2’, ‘niagara3’, ‘niagara4’,
‘niagara7’ and ‘m8’.
Native Solaris and GNU/Linux toolchains also support the value
‘native’, which selects the best architecture option for the host processor.
‘-mcpu=native’ has no effect if GCC does not recognize the processor.
Default instruction scheduling parameters are used for values that select an
architecture and not an implementation. These are ‘v7’, ‘v8’, ‘sparclite’,
‘sparclet’, ‘v9’.
Here is a list of each supported architecture and their supported implementa-
tions.
v7 cypress, leon3v7
v8 supersparc, hypersparc, leon, leon3, leon5
sparclite f930, f934, sparclite86x
sparclet tsc701
v9 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4, nia-
gara7, m8
By default (unless configured otherwise), GCC generates code for the V7 vari-
ant of the SPARC architecture. With ‘-mcpu=cypress’, the compiler addition-
ally optimizes it for the Cypress CY7C602 chip, as used in the SPARCSta-
tion/SPARCServer 3xx series. This is also appropriate for the older SPARC-
Station 1, 2, IPX etc.
With ‘-mcpu=v8’, GCC generates code for the V8 variant of the SPARC archi-
tecture. The only difference from V7 code is that the compiler emits the integer
multiply and integer divide instructions which exist in SPARC-V8 but not in
Chapter 3: GCC Command Options 457
-mvis
-mno-vis With ‘-mvis’, GCC generates code that takes advantage of the UltraSPARC
Visual Instruction Set extensions. The default is ‘-mno-vis’.
-mvis2
-mno-vis2
With ‘-mvis2’, GCC generates code that takes advantage of version 2.0 of the
UltraSPARC Visual Instruction Set extensions. The default is ‘-mvis2’ when
targeting a cpu that supports such instructions, such as UltraSPARC-III and
later. Setting ‘-mvis2’ also sets ‘-mvis’.
-mvis3
-mno-vis3
With ‘-mvis3’, GCC generates code that takes advantage of version 3.0 of the
UltraSPARC Visual Instruction Set extensions. The default is ‘-mvis3’ when
targeting a cpu that supports such instructions, such as niagara-3 and later.
Setting ‘-mvis3’ also sets ‘-mvis2’ and ‘-mvis’.
-mvis4
-mno-vis4
With ‘-mvis4’, GCC generates code that takes advantage of version 4.0 of the
UltraSPARC Visual Instruction Set extensions. The default is ‘-mvis4’ when
targeting a cpu that supports such instructions, such as niagara-7 and later.
Setting ‘-mvis4’ also sets ‘-mvis3’, ‘-mvis2’ and ‘-mvis’.
-mvis4b
-mno-vis4b
With ‘-mvis4b’, GCC generates code that takes advantage of version 4.0 of
the UltraSPARC Visual Instruction Set extensions, plus the additional VIS
instructions introduced in the Oracle SPARC Architecture 2017. The default
is ‘-mvis4b’ when targeting a cpu that supports such instructions, such as m8
and later. Setting ‘-mvis4b’ also sets ‘-mvis4’, ‘-mvis3’, ‘-mvis2’ and ‘-mvis’.
-mcbcond
-mno-cbcond
With ‘-mcbcond’, GCC generates code that takes advantage of the
UltraSPARC Compare-and-Branch-on-Condition instructions. The default is
‘-mcbcond’ when targeting a CPU that supports such instructions, such as
Niagara-4 and later.
-mfmaf
-mno-fmaf
With ‘-mfmaf’, GCC generates code that takes advantage of the UltraSPARC
Fused Multiply-Add Floating-point instructions. The default is ‘-mfmaf’ when
targeting a CPU that supports such instructions, such as Niagara-3 and later.
-mfsmuld
-mno-fsmuld
With ‘-mfsmuld’, GCC generates code that takes advantage of the
Floating-point Multiply Single to Double (FsMULd) instruction. The default
Chapter 3: GCC Command Options 459
‘embmedany’
The Medium/Anywhere code model for embedded systems: 64-bit
addresses, the text and data segments must be less than 2GB in
size, both starting anywhere in memory (determined at link time).
The global register %g4 points to the base of the data segment.
Programs are statically linked and PIC is not supported.
-mmemory-model=mem-model
Set the memory model in force on the processor to one of
‘default’ The default memory model for the processor and operating system.
‘rmo’ Relaxed Memory Order
‘pso’ Partial Store Order
‘tso’ Total Store Order
‘sc’ Sequential Consistency
These memory models are formally defined in Appendix D of the SPARC-V9
architecture manual, as set in the processor’s PSTATE.MM field.
-mstack-bias
-mno-stack-bias
With ‘-mstack-bias’, GCC assumes that the stack pointer, and frame pointer
if present, are offset by −2047 which must be added back when making stack
frame references. This is the default in 64-bit mode. Otherwise, assume no
such offset is present.
-mno-ep
-mep Do not optimize (do optimize) basic blocks that use the same index pointer 4
or more times to copy pointer into the ep register, and use the shorter sld and
sst instructions. The ‘-mep’ option is on by default if you optimize.
-mno-prolog-function
-mprolog-function
Do not use (do use) external functions to save and restore registers at the
prologue and epilogue of a function. The external functions are slower, but use
less code space if more than one function saves the same number of registers.
The ‘-mprolog-function’ option is on by default if you optimize.
-mspace Try to make the code as small as possible. At present, this just turns on the
‘-mep’ and ‘-mprolog-function’ options.
-mtda=n Put static or global variables whose size is n bytes or less into the tiny data
area that register ep points to. The tiny data area can hold up to 256 bytes in
total (128 bytes for byte references).
-msda=n Put static or global variables whose size is n bytes or less into the small data
area that register gp points to. The small data area can hold up to 64 kilobytes.
-mzda=n Put static or global variables whose size is n bytes or less into the first 32
kilobytes of memory.
-mv850 Specify that the target processor is the V850.
-mv850e3v5
Specify that the target processor is the V850E3V5. The preprocessor constant
__v850e3v5__ is defined if this option is used.
-mv850e2v4
Specify that the target processor is the V850E3V5. This is an alias for the
‘-mv850e3v5’ option.
-mv850e2v3
Specify that the target processor is the V850E2V3. The preprocessor constant
__v850e2v3__ is defined if this option is used.
-mv850e2 Specify that the target processor is the V850E2. The preprocessor constant
__v850e2__ is defined if this option is used.
-mv850e1 Specify that the target processor is the V850E1. The preprocessor constants
__v850e1__ and __v850e__ are defined if this option is used.
-mv850es Specify that the target processor is the V850ES. This is an alias for the
‘-mv850e1’ option.
-mv850e Specify that the target processor is the V850E. The preprocessor constant
__v850e__ is defined if this option is used.
If neither ‘-mv850’ nor ‘-mv850e’ nor ‘-mv850e1’ nor ‘-mv850e2’ nor
‘-mv850e2v3’ nor ‘-mv850e3v5’ are defined then a default target processor is
chosen and the relevant ‘__v850*__’ preprocessor constant is defined.
The preprocessor constants __v850 and __v851__ are always defined, regardless
of which processor variant is the target.
462 Using the GNU Compiler Collection (GCC)
-mdisable-callt
-mno-disable-callt
This option suppresses generation of the CALLT instruction for the v850e,
v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850 architecture.
This option is enabled by default when the RH850 ABI is in use (see
‘-mrh850-abi’), and disabled by default when the GCC ABI is in use. If
CALLT instructions are being generated then the C preprocessor symbol
__V850_CALLT__ is defined.
-mrelax
-mno-relax
Pass on (or do not pass on) the ‘-mrelax’ command-line option to the assembler.
-mlong-jumps
-mno-long-jumps
Disable (or re-enable) the generation of PC-relative jump instructions.
-msoft-float
-mhard-float
Disable (or re-enable) the generation of hardware floating point instructions.
This option is only significant when the target architecture is ‘V850E2V3’ or
higher. If hardware floating point instructions are being generated then the C
preprocessor symbol __FPU_OK__ is defined, otherwise the symbol __NO_FPU__
is defined.
-mloop Enables the use of the e3v5 LOOP instruction. The use of this instruction is
not enabled by default when the e3v5 architecture is selected because its use is
still experimental.
-mrh850-abi
-mghs Enables support for the RH850 version of the V850 ABI. This is the default.
With this version of the ABI the following rules apply:
• Integer sized structures and unions are returned via a memory pointer
rather than a register.
• Large structures and unions (more than 8 bytes in size) are passed by value.
• Functions are aligned to 16-bit boundaries.
• The ‘-m8byte-align’ command-line option is supported.
• The ‘-mdisable-callt’ command-line option is enabled by default. The
‘-mno-disable-callt’ command-line option is not supported.
When this version of the ABI is enabled the C preprocessor symbol __V850_
RH850_ABI__ is defined.
-mgcc-abi
Enables support for the old GCC version of the V850 ABI. With this version
of the ABI the following rules apply:
• Integer sized structures and unions are returned in register r10.
• Large structures and unions (more than 8 bytes in size) are passed by
reference.
Chapter 3: GCC Command Options 463
-mfpu
-mhard-float
Generate code containing floating-point instructions. This is the default.
-mno-fpu
-msoft-float
Generate code containing library calls for floating-point.
‘-msoft-float’ changes the calling convention in the output file; therefore, it
is only useful if you compile all of a program with this option. In particu-
lar, you need to compile ‘libgcc.a’, the library that comes with GCC, with
‘-msoft-float’ in order for this to work.
-mcpu=cpu_type
Set the instruction set, register set, and instruction scheduling parameters for
machine type cpu type. Supported values for cpu type are ‘mcm’, ‘gr5’ and
‘gr6’.
‘mcm’ is a synonym of ‘gr5’ present for backward compatibility.
By default (unless configured otherwise), GCC generates code for the GR5
variant of the Visium architecture.
With ‘-mcpu=gr6’, GCC generates code for the GR6 variant of the Visium
architecture. The only difference from GR5 code is that the compiler will
generate block move instructions.
-mtune=cpu_type
Set the instruction scheduling parameters for machine type cpu type, but do
not set the instruction set or register set that the option ‘-mcpu=cpu_type’
would.
-msv-mode
Generate code for the supervisor mode, where there are no restrictions on the
access to general registers. This is the default.
-muser-mode
Generate code for the user mode, where the access to some general registers is
forbidden: on the GR5, registers r24 to r31 cannot be accessed in this mode;
on the GR6, only registers r29 to r31 are affected.
-mpointer-size=size
Set the default size of pointers. Possible options for size are ‘32’ or ‘short’ for
32 bit pointers, ‘64’ or ‘long’ for 64 bit pointers, and ‘no’ for supporting only
32 bit pointers. The later option disables pragma pointer_size.
‘x86-64-v2’
‘x86-64-v3’
‘x86-64-v4’
These choices for cpu-type select the corresponding micro-
architecture level from the x86-64 psABI. On ABIs other than the
x86-64 psABI they select the same CPU features as the x86-64
psABI documents for the particular micro-architecture level.
Since these cpu-type values do not have a corresponding ‘-mtune’
setting, using ‘-march’ with these values enables generic tuning.
Specific tuning can be enabled using the ‘-mtune=other-cpu-type’
option with an appropriate other-cpu-type value.
‘i386’ Original Intel i386 CPU.
‘i486’ Intel i486 CPU. (No scheduling is implemented for this chip.)
‘i586’
‘pentium’ Intel Pentium CPU with no MMX support.
‘lakemont’
Intel Lakemont MCU, based on Intel Pentium CPU.
‘pentium-mmx’
Intel Pentium MMX CPU, based on Pentium core with MMX in-
struction set support.
‘pentiumpro’
Intel Pentium Pro CPU.
‘i686’ When used with ‘-march’, the Pentium Pro instruction set is used,
so the code runs on all i686 family chips. When used with ‘-mtune’,
it has the same meaning as ‘generic’.
‘pentium2’
Intel Pentium II CPU, based on Pentium Pro core with MMX and
FXSR instruction set support.
‘pentium3’
‘pentium3m’
Intel Pentium III CPU, based on Pentium Pro core with MMX,
FXSR and SSE instruction set support.
‘pentium-m’
Intel Pentium M; low-power version of Intel Pentium III CPU with
MMX, SSE, SSE2 and FXSR instruction set support. Used by
Centrino notebooks.
‘pentium4’
‘pentium4m’
Intel Pentium 4 CPU with MMX, SSE, SSE2 and FXSR instruction
set support.
‘prescott’
Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2,
SSE3 and FXSR instruction set support.
Chapter 3: GCC Command Options 467
‘cannonlake’
Intel Cannonlake Server CPU with 64-bit extensions, MOVBE,
MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT,
CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE,
RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE,
HLE, RDSEED, ADCX, PREFETCHW, AES, CLFLUSHOPT,
XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW,
AVX512DQ, AVX512CD, PKU, AVX512VBMI, AVX512IFMA
and SHA instruction set support.
‘icelake-client’
Intel Icelake Client CPU with 64-bit extensions, MOVBE, MMX,
SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16,
SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND,
F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RD-
SEED, ADCX, PREFETCHW, AES, CLFLUSHOPT, XSAVEC,
XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, AVX512DQ,
AVX512CD, PKU, AVX512VBMI, AVX512IFMA, SHA,
AVX512VNNI, GFNI, VAES, AVX512VBMI2 , VPCLMULQDQ,
AVX512BITALG, RDPID and AVX512VPOPCNTDQ instruction
set support.
‘icelake-server’
Intel Icelake Server CPU with 64-bit extensions, MOVBE,
MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT,
CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE,
RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE,
HLE, RDSEED, ADCX, PREFETCHW, AES, CLFLUSHOPT,
XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW,
AVX512DQ, AVX512CD, PKU, AVX512VBMI, AVX512IFMA,
SHA, AVX512VNNI, GFNI, VAES, AVX512VBMI2 , VP-
CLMULQDQ, AVX512BITALG, RDPID, AVX512VPOPCNTDQ,
PCONFIG, WBNOINVD and CLWB instruction set support.
‘cascadelake’
Intel Cascadelake CPU with 64-bit extensions, MOVBE, MMX,
SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16,
SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND,
F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE,
RDSEED, ADCX, PREFETCHW, AES, CLFLUSHOPT,
XSAVEC, XSAVES, SGX, AVX512F, CLWB, AVX512VL,
AVX512BW, AVX512DQ, AVX512CD and AVX512VNNI
instruction set support.
‘cooperlake’
Intel cooperlake CPU with 64-bit extensions, MOVBE, MMX,
SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16,
SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND,
F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE,
470 Using the GNU Compiler Collection (GCC)
‘winchip2’
IDT WinChip 2 CPU, dealt in same way as i486 with additional
MMX and 3DNow! instruction set support.
‘c3’ VIA C3 CPU with MMX and 3DNow! instruction set support. (No
scheduling is implemented for this chip.)
‘c3-2’ VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction
set support. (No scheduling is implemented for this chip.)
‘c7’ VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction
set support. (No scheduling is implemented for this chip.)
‘samuel-2’
VIA Eden Samuel 2 CPU with MMX and 3DNow! instruction set
support. (No scheduling is implemented for this chip.)
‘nehemiah’
VIA Eden Nehemiah CPU with MMX and SSE instruction set sup-
port. (No scheduling is implemented for this chip.)
‘esther’ VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruc-
tion set support. (No scheduling is implemented for this chip.)
‘eden-x2’ VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 in-
struction set support. (No scheduling is implemented for this chip.)
‘eden-x4’ VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3,
SSE4.1, SSE4.2, AVX and AVX2 instruction set support. (No
scheduling is implemented for this chip.)
‘nano’ Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and
SSSE3 instruction set support. (No scheduling is implemented for
this chip.)
‘nano-1000’
VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and
SSSE3 instruction set support. (No scheduling is implemented for
this chip.)
‘nano-2000’
VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and
SSSE3 instruction set support. (No scheduling is implemented for
this chip.)
‘nano-3000’
VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3
and SSE4.1 instruction set support. (No scheduling is implemented
for this chip.)
‘nano-x2’ VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3,
SSSE3 and SSE4.1 instruction set support. (No scheduling is im-
plemented for this chip.)
474 Using the GNU Compiler Collection (GCC)
‘nano-x4’ VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3,
SSSE3 and SSE4.1 instruction set support. (No scheduling is im-
plemented for this chip.)
‘lujiazui’
ZHAOXIN lujiazui CPU with x86-64, MOVBE, MMX, SSE, SSE2,
SSE3, SSSE3, SSE4.1, SSE4.2, AVX, POPCNT, AES, PCLMUL,
RDRND, XSAVE, XSAVEOPT, FSGSBASE, CX16, ABM, BMI,
BMI2, F16C, FXSR, RDSEED instruction set support.
‘geode’ AMD Geode embedded processor with MMX and 3DNow! instruc-
tion set support.
-mtune=cpu-type
Tune to cpu-type everything applicable about the generated code, except for
the ABI and the set of available instructions. While picking a specific cpu-type
schedules things appropriately for that particular chip, the compiler does not
generate any code that cannot run on the default machine type unless you use
a ‘-march=cpu-type’ option. For example, if GCC is configured for i686-pc-
linux-gnu then ‘-mtune=pentium4’ generates code that is tuned for Pentium 4
but still runs on i686 machines.
The choices for cpu-type are the same as for ‘-march’. In addition, ‘-mtune’
supports 2 extra choices for cpu-type:
‘generic’ Produce code optimized for the most common IA32/AMD64/
EM64T processors. If you know the CPU on which your code will
run, then you should use the corresponding ‘-mtune’ or ‘-march’
option instead of ‘-mtune=generic’. But, if you do not know
exactly what CPU users of your application will have, then you
should use this option.
As new processors are deployed in the marketplace, the behavior of
this option will change. Therefore, if you upgrade to a newer version
of GCC, code generation controlled by this option will change to
reflect the processors that are most common at the time that version
of GCC is released.
There is no ‘-march=generic’ option because ‘-march’ indicates
the instruction set the compiler can use, and there is no generic
instruction set applicable to all processors. In contrast, ‘-mtune’
indicates the processor (or, in this case, collection of processors) for
which the code is optimized.
‘intel’ Produce code optimized for the most current Intel processors, which
are Haswell and Silvermont for this version of GCC. If you know
the CPU on which your code will run, then you should use the cor-
responding ‘-mtune’ or ‘-march’ option instead of ‘-mtune=intel’.
But, if you want your application performs better on both Haswell
and Silvermont, then you should use this option.
As new Intel processors are deployed in the marketplace, the be-
havior of this option will change. Therefore, if you upgrade to a
Chapter 3: GCC Command Options 475
-m96bit-long-double
-m128bit-long-double
These switches control the size of long double type. The x86-32 application
binary interface specifies the size to be 96 bits, so ‘-m96bit-long-double’ is
the default in 32-bit mode.
Modern architectures (Pentium and newer) prefer long double to be aligned
to an 8- or 16-byte boundary. In arrays or structures conforming to the ABI,
this is not possible. So specifying ‘-m128bit-long-double’ aligns long double
to a 16-byte boundary by padding the long double with an additional 32-bit
zero.
In the x86-64 compiler, ‘-m128bit-long-double’ is the default choice as its
ABI specifies that long double is aligned on 16-byte boundary.
Notice that neither of these options enable any extra precision over the x87
standard of 80 bits for a long double.
Warning: if you override the default value for your target ABI, this changes
the size of structures and arrays containing long double variables, as well as
modifying the function calling convention for functions taking long double.
Hence they are not binary-compatible with code compiled without that switch.
-mlong-double-64
-mlong-double-80
-mlong-double-128
These switches control the size of long double type. A size of 64 bits makes the
long double type equivalent to the double type. This is the default for 32-bit
Bionic C library. A size of 128 bits makes the long double type equivalent to
the __float128 type. This is the default for 64-bit Bionic C library.
Warning: if you override the default value for your target ABI, this changes
the size of structures and arrays containing long double variables, as well as
modifying the function calling convention for functions taking long double.
Hence they are not binary-compatible with code compiled without that switch.
-malign-data=type
Control how GCC aligns variables. Supported values for type are ‘compat’
uses increased alignment value compatible uses GCC 4.8 and earlier, ‘abi’ uses
alignment value as specified by the psABI, and ‘cacheline’ uses increased
alignment value to match the cache line size. ‘compat’ is the default.
478 Using the GNU Compiler Collection (GCC)
-mlarge-data-threshold=threshold
When ‘-mcmodel=medium’ is specified, data objects larger than threshold are
placed in the large data section. This value must be the same across all objects
linked into the binary, and defaults to 65535.
-mrtd Use a different function-calling convention, in which functions that take a fixed
number of arguments return with the ret num instruction, which pops their
arguments while returning. This saves one instruction in the caller since there
is no need to pop the arguments there.
You can specify that an individual function is called with this calling sequence
with the function attribute stdcall. You can also override the ‘-mrtd’ option
by using the function attribute cdecl. See Section 6.33 [Function Attributes],
page 556.
Warning: this calling convention is incompatible with the one normally used on
Unix, so you cannot use it if you need to call libraries compiled with the Unix
compiler.
Also, you must provide function prototypes for all functions that take variable
numbers of arguments (including printf); otherwise incorrect code is generated
for calls to those functions.
In addition, seriously incorrect code results if you call a function with too many
arguments. (Normally, extra arguments are harmlessly ignored.)
-mregparm=num
Control how many registers are used to pass integer arguments. By default, no
registers are used to pass arguments, and at most 3 registers can be used. You
can control this behavior for a specific function by using the function attribute
regparm. See Section 6.33 [Function Attributes], page 556.
Warning: if you use this switch, and num is nonzero, then you must build all
modules with the same value, including any libraries. This includes the system
libraries and startup modules.
-msseregparm
Use SSE register passing conventions for float and double arguments and return
values. You can control this behavior for a specific function by using the func-
tion attribute sseregparm. See Section 6.33 [Function Attributes], page 556.
Warning: if you use this switch then you must build all modules with the same
value, including any libraries. This includes the system libraries and startup
modules.
-mvect8-ret-in-mem
Return 8-byte vectors in memory instead of MMX registers. This is the de-
fault on VxWorks to match the ABI of the Sun Studio compilers until version
12. Only use this option if you need to remain compatible with existing code
produced by those previous compiler versions or older versions of GCC.
-mpc32
-mpc64
-mpc80
Chapter 3: GCC Command Options 479
-mstackrealign
Realign the stack at entry. On the x86, the ‘-mstackrealign’ option generates
an alternate prologue and epilogue that realigns the run-time stack if necessary.
This supports mixing legacy codes that keep 4-byte stack alignment with mod-
ern codes that keep 16-byte stack alignment for SSE compatibility. See also the
attribute force_align_arg_pointer, applicable to individual functions.
-mpreferred-stack-boundary=num
Attempt to keep the stack boundary aligned to a 2 raised to num byte boundary.
If ‘-mpreferred-stack-boundary’ is not specified, the default is 4 (16 bytes or
128 bits).
Warning: When generating code for the x86-64 architecture with SSE exten-
sions disabled, ‘-mpreferred-stack-boundary=3’ can be used to keep the stack
boundary aligned to 8 byte boundary. Since x86-64 ABI require 16 byte stack
alignment, this is ABI incompatible and intended to be used in controlled envi-
ronment where stack space is important limitation. This option leads to wrong
code when functions compiled with 16 byte stack alignment (such as functions
from a standard library) are called with misaligned stack. In this case, SSE
instructions may lead to misaligned memory access traps. In addition, variable
arguments are handled incorrectly for 16 byte aligned objects (including x87
long double and int128), leading to wrong results. You must build all modules
with ‘-mpreferred-stack-boundary=3’, including any libraries. This includes
the system libraries and startup modules.
-mincoming-stack-boundary=num
Assume the incoming stack is aligned to a 2 raised to num byte boundary.
If ‘-mincoming-stack-boundary’ is not specified, the one specified by
‘-mpreferred-stack-boundary’ is used.
On Pentium and Pentium Pro, double and long double values should be
aligned to an 8-byte boundary (see ‘-malign-double’) or suffer significant run
time performance penalties. On Pentium III, the Streaming SIMD Extension
(SSE) data type __m128 may not work properly if it is not 16-byte aligned.
480 Using the GNU Compiler Collection (GCC)
To ensure proper alignment of this values on the stack, the stack boundary
must be as aligned as that required by any value stored on the stack. Further,
every function must be generated such that it keeps the stack aligned. Thus
calling a function compiled with a higher preferred stack boundary from a
function compiled with a lower preferred stack boundary most likely misaligns
the stack. It is recommended that libraries that use callbacks always use the
default setting.
This extra alignment does consume extra stack space, and generally increases
code size. Code that is sensitive to stack space usage, such as embedded systems
and operating system kernels, may want to reduce the preferred alignment to
‘-mpreferred-stack-boundary=2’.
-mmmx
-msse
-msse2
-msse3
-mssse3
-msse4
-msse4a
-msse4.1
-msse4.2
-mavx
-mavx2
-mavx512f
-mavx512pf
-mavx512er
-mavx512cd
-mavx512vl
-mavx512bw
-mavx512dq
-mavx512ifma
-mavx512vbmi
-msha
-maes
-mpclmul
-mclflushopt
-mclwb
-mfsgsbase
-mptwrite
-mrdrnd
-mf16c
-mfma
-mpconfig
-mwbnoinvd
-mfma4
-mprfchw
-mrdpid
-mprefetchwt1
-mrdseed
-msgx
-mxop
Chapter 3: GCC Command Options 481
-mlwp
-m3dnow
-m3dnowa
-mpopcnt
-mabm
-madx
-mbmi
-mbmi2
-mlzcnt
-mfxsr
-mxsave
-mxsaveopt
-mxsavec
-mxsaves
-mrtm
-mhle
-mtbm
-mmwaitx
-mclzero
-mpku
-mavx512vbmi2
-mavx512bf16
-mavx512fp16
-mgfni
-mvaes
-mwaitpkg
-mvpclmulqdq
-mavx512bitalg
-mmovdiri
-mmovdir64b
-menqcmd
-muintr
-mtsxldtrk
-mavx512vpopcntdq
-mavx512vp2intersect
-mavx5124fmaps
-mavx512vnni
-mavxvnni
-mavx5124vnniw
-mcldemote
-mserialize
-mamx-tile
-mamx-int8
-mamx-bf16
-mhreset
-mkl
-mwidekl These switches enable the use of instructions in the MMX, SSE, SSE2,
SSE3, SSSE3, SSE4, SSE4A, SSE4.1, SSE4.2, AVX, AVX2, AVX512F,
AVX512PF, AVX512ER, AVX512CD, AVX512VL, AVX512BW, AVX512DQ,
AVX512IFMA, AVX512VBMI, SHA, AES, PCLMUL, CLFLUSHOPT,
CLWB, FSGSBASE, PTWRITE, RDRND, F16C, FMA, PCONFIG,
482 Using the GNU Compiler Collection (GCC)
direction mode when string instructions are used. This option can be enabled
by default on 32-bit x86 targets by configuring GCC with the ‘--enable-cld’
configure option. Generation of cld instructions can be suppressed with the
‘-mno-cld’ compiler option in this case.
-mvzeroupper
This option instructs GCC to emit a vzeroupper instruction before a transfer of
control flow out of the function to minimize the AVX to SSE transition penalty
as well as remove unnecessary zeroupper intrinsics.
-mprefer-avx128
This option instructs GCC to use 128-bit AVX instructions instead of 256-bit
AVX instructions in the auto-vectorizer.
-mprefer-vector-width=opt
This option instructs GCC to use opt-bit vector width in instructions instead
of default on the selected platform.
-mmove-max=bits
This option instructs GCC to set the maximum number of bits can be moved
from memory to memory efficiently to bits. The valid bits are 128, 256 and
512.
-mstore-max=bits
This option instructs GCC to set the maximum number of bits can be stored
to memory efficiently to bits. The valid bits are 128, 256 and 512.
‘none’ No extra limitations applied to GCC other than defined by the
selected platform.
‘128’ Prefer 128-bit vector width for instructions.
‘256’ Prefer 256-bit vector width for instructions.
‘512’ Prefer 512-bit vector width for instructions.
-mcx16 This option enables GCC to generate CMPXCHG16B instructions in 64-bit code
to implement compare-and-exchange operations on 16-byte aligned 128-bit ob-
jects. This is useful for atomic updates of data structures exceeding one machine
word in size. The compiler uses this instruction to implement Section 6.54
[ sync Builtins], page 717. However, for Section 6.55 [ atomic Builtins],
page 719 operating on 128-bit integers, a library call is always used.
-msahf This option enables generation of SAHF instructions in 64-bit code. Early Intel
Pentium 4 CPUs with Intel 64 support, prior to the introduction of Pentium
4 G1 step in December 2005, lacked the LAHF and SAHF instructions which are
supported by AMD64. These are load and store instructions, respectively, for
certain status flags. In 64-bit mode, the SAHF instruction is used to optimize
fmod, drem, and remainder built-in functions; see Section 6.59 [Other Builtins],
page 728 for details.
-mmovbe This option enables use of the movbe instruction to implement __builtin_
bswap32 and __builtin_bswap64.
484 Using the GNU Compiler Collection (GCC)
-mshstk The ‘-mshstk’ option enables shadow stack built-in functions from x86 Control-
flow Enforcement Technology (CET).
-mcrc32 This option enables built-in functions __builtin_ia32_crc32qi, __builtin_
ia32_crc32hi, __builtin_ia32_crc32si and __builtin_ia32_crc32di to
generate the crc32 machine instruction.
-mmwait This option enables built-in functions __builtin_ia32_monitor, and
__builtin_ia32_mwait to generate the monitor and mwait machine
instructions.
-mrecip This option enables use of RCPSS and RSQRTSS instructions (and their
vectorized variants RCPPS and RSQRTPS) with an additional Newton-Raphson
step to increase precision instead of DIVSS and SQRTSS (and their vectorized
variants) for single-precision floating-point arguments. These instructions are
generated only when ‘-funsafe-math-optimizations’ is enabled together
with ‘-ffinite-math-only’ and ‘-fno-trapping-math’. Note that while the
throughput of the sequence is higher than the throughput of the non-reciprocal
instruction, the precision of the sequence can be decreased by up to 2 ulp (i.e.
the inverse of 1.0 equals 0.99999994).
Note that GCC implements 1.0f/sqrtf(x) in terms of RSQRTSS (or RSQRTPS)
already with ‘-ffast-math’ (or the above option combination), and doesn’t
need ‘-mrecip’.
Also note that GCC emits the above sequence with additional Newton-Raphson
step for vectorized single-float division and vectorized sqrtf(x) already with
‘-ffast-math’ (or the above option combination), and doesn’t need ‘-mrecip’.
-mrecip=opt
This option controls which reciprocal estimate instructions may be used. opt
is a comma-separated list of options, which may be preceded by a ‘!’ to invert
the option:
‘all’ Enable all estimate instructions.
‘default’ Enable the default instructions, equivalent to ‘-mrecip’.
‘none’ Disable all estimate instructions, equivalent to ‘-mno-recip’.
‘div’ Enable the approximation for scalar division.
‘vec-div’ Enable the approximation for vectorized division.
‘sqrt’ Enable the approximation for scalar square root.
‘vec-sqrt’
Enable the approximation for vectorized square root.
So, for example, ‘-mrecip=all,!sqrt’ enables all of the reciprocal approxima-
tions, except for square root.
-mveclibabi=type
Specifies the ABI type to use for vectorizing intrinsics using an external li-
brary. Supported values for type are ‘svml’ for the Intel short vector math
library and ‘acml’ for the AMD math core library. To use this option, both
Chapter 3: GCC Command Options 485
-mtls-dialect=type
Generate code to access thread-local storage using the ‘gnu’ or ‘gnu2’ conven-
tions. ‘gnu’ is the conservative default; ‘gnu2’ is more efficient, but it may add
compile- and run-time requirements that cannot be satisfied on all systems.
-mpush-args
-mno-push-args
Use PUSH operations to store outgoing parameters. This method is shorter
and usually equally fast as method using SUB/MOV operations and is enabled
by default. In some cases disabling it may improve performance because of
improved scheduling and reduced dependencies.
-maccumulate-outgoing-args
If enabled, the maximum amount of space required for outgoing arguments
is computed in the function prologue. This is faster on most modern CPUs
because of reduced dependencies, improved scheduling and reduced stack usage
when the preferred stack boundary is not equal to 2. The drawback is a notable
increase in code size. This switch implies ‘-mno-push-args’.
-mthreads
Support thread-safe exception handling on MinGW. Programs that rely
on thread-safe exception handling must compile and link all code with the
‘-mthreads’ option. When compiling, ‘-mthreads’ defines ‘-D_MT’; when
linking, it links in a special thread helper library ‘-lmingwthrd’ which cleans
up per-thread exception-handling data.
-mms-bitfields
-mno-ms-bitfields
Enable/disable bit-field layout compatible with the native Microsoft Windows
compiler.
If packed is used on a structure, or if bit-fields are used, it may be that the
Microsoft ABI lays out the structure differently than the way GCC normally
does. Particularly when moving packed data between functions compiled with
GCC and the native Microsoft compiler (either via function call or as data in
a file), it may be necessary to access either format.
This option is enabled by default for Microsoft Windows targets. This behav-
ior can also be controlled locally by use of variable or type attributes. For
more information, see Section 6.34.15 [x86 Variable Attributes], page 636 and
Section 6.35.7 [x86 Type Attributes], page 645.
The Microsoft structure layout algorithm is fairly simple with the exception of
the bit-field packing. The padding and alignment of members of structures and
whether a bit-field can straddle a storage-unit boundary are determine by these
rules:
1. Structure members are stored sequentially in the order in which they are
declared: the first member has the lowest memory address and the last
member the highest.
2. Every data object has an alignment requirement. The alignment require-
ment for all data except structures, unions, and arrays is either the size of
Chapter 3: GCC Command Options 487
the object or the current packing size (specified with either the aligned
attribute or the pack pragma), whichever is less. For structures, unions,
and arrays, the alignment requirement is the largest alignment requirement
of its members. Every object is allocated an offset so that:
offset % alignment_requirement == 0
3. Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
unit if the integral types are the same size and if the next bit-field fits into
the current allocation unit without crossing the boundary imposed by the
common alignment requirements of the bit-fields.
MSVC interprets zero-length bit-fields in the following ways:
1. If a zero-length bit-field is inserted between two bit-fields that are normally
coalesced, the bit-fields are not coalesced.
For example:
struct
{
unsigned long bf_1 : 12;
unsigned long : 0;
unsigned long bf_2 : 12;
} t1;
The size of t1 is 8 bytes with the zero-length bit-field. If the zero-length
bit-field were removed, t1’s size would be 4 bytes.
2. If a zero-length bit-field is inserted after a bit-field, foo, and the alignment
of the zero-length bit-field is greater than the member that follows it, bar,
bar is aligned as the type of the zero-length bit-field.
For example:
struct
{
char foo : 4;
short : 0;
char bar;
} t2;
struct
{
char foo : 4;
short : 0;
double bar;
} t3;
For t2, bar is placed at offset 2, rather than offset 1. Accordingly, the size
of t2 is 4. For t3, the zero-length bit-field does not affect the alignment of
bar or, as a result, the size of the structure.
Taking this into account, it is important to note the following:
1. If a zero-length bit-field follows a normal bit-field, the type of the zero-
length bit-field may affect the alignment of the structure as whole. For
example, t2 has a size of 4 bytes, since the zero-length bit-field follows
a normal bit-field, and is of type short.
2. Even if a zero-length bit-field is not followed by a normal bit-field, it
may still affect the alignment of the structure:
488 Using the GNU Compiler Collection (GCC)
struct
{
char foo : 6;
long : 0;
} t4;
Here, t4 takes up 4 bytes.
3. Zero-length bit-fields following non-bit-field members are ignored:
struct
{
char foo;
long : 0;
char bar;
} t5;
Here, t5 takes up 2 bytes.
-mno-align-stringops
Do not align the destination of inlined string operations. This switch reduces
code size and improves performance in case the destination is already aligned,
but GCC doesn’t know about it.
-minline-all-stringops
By default GCC inlines string operations only when the destination is known to
be aligned to least a 4-byte boundary. This enables more inlining and increases
code size, but may improve performance of code that depends on fast memcpy
and memset for short lengths. The option enables inline expansion of strlen
for all pointer alignments.
-minline-stringops-dynamically
For string operations of unknown size, use run-time checks with inline code for
small blocks and a library call for large blocks.
-mstringop-strategy=alg
Override the internal decision heuristic for the particular algorithm to use for
inlining string operations. The allowed values for alg are:
‘rep_byte’
‘rep_4byte’
‘rep_8byte’
Expand using i386 rep prefix of the specified size.
‘byte_loop’
‘loop’
‘unrolled_loop’
Expand into an inline loop.
‘libcall’ Always use a library call.
-mmemcpy-strategy=strategy
Override the internal decision heuristic to decide if __builtin_memcpy
should be inlined and what inline algorithm to use when the expected
size of the copy operation is known. strategy is a comma-separated list of
alg:max size:dest align triplets. alg is specified in ‘-mstringop-strategy’,
max size specifies the max byte size with which inline algorithm alg is allowed.
Chapter 3: GCC Command Options 489
For the last triplet, the max size must be -1. The max size of the triplets in
the list must be specified in increasing order. The minimal byte size for alg is
0 for the first triplet and max_size + 1 of the preceding range.
-mmemset-strategy=strategy
The option is similar to ‘-mmemcpy-strategy=’ except that it is to control __
builtin_memset expansion.
-momit-leaf-frame-pointer
Don’t keep the frame pointer in a register for leaf functions. This avoids the in-
structions to save, set up, and restore frame pointers and makes an extra register
available in leaf functions. The option ‘-fomit-leaf-frame-pointer’ removes
the frame pointer for leaf functions, which might make debugging harder.
-mtls-direct-seg-refs
-mno-tls-direct-seg-refs
Controls whether TLS variables may be accessed with offsets from the TLS
segment register (%gs for 32-bit, %fs for 64-bit), or whether the thread base
pointer must be added. Whether or not this is valid depends on the operating
system, and whether it maps the segment to cover the entire TLS area.
For systems that use the GNU C Library, the default is on.
-msse2avx
-mno-sse2avx
Specify that the assembler should encode SSE instructions with VEX prefix.
The option ‘-mavx’ turns this on by default.
-mfentry
-mno-fentry
If profiling is active (‘-pg’), put the profiling counter call before the prologue.
Note: On x86 architectures the attribute ms_hook_prologue isn’t possible at
the moment for ‘-mfentry’ and ‘-pg’.
-mrecord-mcount
-mno-record-mcount
If profiling is active (‘-pg’), generate a mcount loc section that contains point-
ers to each profiling call. This is useful for automatically patching and out calls.
-mnop-mcount
-mno-nop-mcount
If profiling is active (‘-pg’), generate the calls to the profiling functions as NOPs.
This is useful when they should be patched in later dynamically. This is likely
only useful together with ‘-mrecord-mcount’.
-minstrument-return=type
Instrument function exit in -pg -mfentry instrumented functions with call to
specified function. This only instruments true returns ending with ret, but not
sibling calls ending with jump. Valid types are none to not instrument, call to
generate a call to return , or nop5 to generate a 5 byte nop.
-mrecord-return
-mno-record-return
Generate a return loc section pointing to all return instrumentation code.
490 Using the GNU Compiler Collection (GCC)
-mfentry-name=name
Set name of fentry symbol called at function entry for -pg -mfentry func-
tions.
-mfentry-section=name
Set name of section to record -mrecord-mcount calls (default mcount loc).
-mskip-rax-setup
-mno-skip-rax-setup
When generating code for the x86-64 architecture with SSE extensions disabled,
‘-mskip-rax-setup’ can be used to skip setting up RAX register when there
are no variable arguments passed in vector registers.
Warning: Since RAX register is used to avoid unnecessarily saving vector reg-
isters on stack when passing variable arguments, the impacts of this option are
callees may waste some stack space, misbehave or jump to a random location.
GCC 4.4 or newer don’t have those issues, regardless the RAX register value.
-m8bit-idiv
-mno-8bit-idiv
On some processors, like Intel Atom, 8-bit unsigned integer divide is much faster
than 32-bit/64-bit integer divide. This option generates a run-time check. If
both dividend and divisor are within range of 0 to 255, 8-bit unsigned integer
divide is used instead of 32-bit/64-bit integer divide.
-mavx256-split-unaligned-load
-mavx256-split-unaligned-store
Split 32-byte AVX unaligned load and store.
-mstack-protector-guard=guard
-mstack-protector-guard-reg=reg
-mstack-protector-guard-offset=offset
Generate stack protection code using canary at guard. Supported locations
are ‘global’ for global canary or ‘tls’ for per-thread canary in the TLS block
(the default). This option has effect only when ‘-fstack-protector’ or
‘-fstack-protector-all’ is specified.
With the latter choice the options ‘-mstack-protector-guard-reg=reg’ and
‘-mstack-protector-guard-offset=offset’ furthermore specify which seg-
ment register (%fs or %gs) to use as base register for reading the canary, and
from what offset from that base register. The default for those is as specified
in the relevant ABI.
-mgeneral-regs-only
Generate code that uses only the general-purpose registers. This prevents the
compiler from using floating-point, vector, mask and bound registers.
-mrelax-cmpxchg-loop
Relax cmpxchg loop by emitting an early load and compare before cmpxchg,
execute pause if load value is not expected. This reduces excessive cachline
bouncing when and works for all atomic logic fetch builtins that generates
compare and swap loop.
Chapter 3: GCC Command Options 491
-mindirect-branch=choice
Convert indirect call and jump with choice. The default is ‘keep’, which keeps
indirect call and jump unmodified. ‘thunk’ converts indirect call and jump
to call and return thunk. ‘thunk-inline’ converts indirect call and jump to
inlined call and return thunk. ‘thunk-extern’ converts indirect call and jump
to external call and return thunk provided in a separate object file. You can
control this behavior for a specific function by using the function attribute
indirect_branch. See Section 6.33 [Function Attributes], page 556.
Note that ‘-mcmodel=large’ is incompatible with ‘-mindirect-branch=thunk’
and ‘-mindirect-branch=thunk-extern’ since the thunk function may not be
reachable in the large code model.
Note that ‘-mindirect-branch=thunk-extern’ is compatible with
‘-fcf-protection=branch’ since the external thunk can be made to enable
control-flow check.
-mfunction-return=choice
Convert function return with choice. The default is ‘keep’, which keeps func-
tion return unmodified. ‘thunk’ converts function return to call and return
thunk. ‘thunk-inline’ converts function return to inlined call and return
thunk. ‘thunk-extern’ converts function return to external call and return
thunk provided in a separate object file. You can control this behavior for
a specific function by using the function attribute function_return. See
Section 6.33 [Function Attributes], page 556.
Note that ‘-mindirect-return=thunk-extern’ is compatible with
‘-fcf-protection=branch’ since the external thunk can be made to enable
control-flow check.
Note that ‘-mcmodel=large’ is incompatible with ‘-mfunction-return=thunk’
and ‘-mfunction-return=thunk-extern’ since the thunk function may not be
reachable in the large code model.
-mindirect-branch-register
Force indirect call and jump via register.
-mharden-sls=choice
Generate code to mitigate against straight line speculation (SLS) with choice.
The default is ‘none’ which disables all SLS hardening. ‘return’ enables SLS
hardening for function returns. ‘indirect-jmp’ enables SLS hardening for in-
direct jumps. ‘all’ enables all SLS hardening.
-mindirect-branch-cs-prefix
Add CS prefix to call and jmp to indirect thunk with branch target in r8-r15
registers so that the call and jmp instruction length is 6 bytes to allow them
to be replaced with ‘lfence; call *%r8-r15’ or ‘lfence; jmp *%r8-r15’ at
run-time.
These ‘-m’ switches are supported in addition to the above on x86-64 processors in 64-bit
environments.
492 Using the GNU Compiler Collection (GCC)
-m32
-m64
-mx32
-m16
-miamcu Generate code for a 16-bit, 32-bit or 64-bit environment. The ‘-m32’ option
sets int, long, and pointer types to 32 bits, and generates code that runs on
any i386 system.
The ‘-m64’ option sets int to 32 bits and long and pointer types to 64 bits, and
generates code for the x86-64 architecture. For Darwin only the ‘-m64’ option
also turns off the ‘-fno-pic’ and ‘-mdynamic-no-pic’ options.
The ‘-mx32’ option sets int, long, and pointer types to 32 bits, and generates
code for the x86-64 architecture.
The ‘-m16’ option is the same as ‘-m32’, except for that it outputs the
.code16gcc assembly directive at the beginning of the assembly output so
that the binary can run in 16-bit mode.
The ‘-miamcu’ option generates code which conforms to Intel MCU psABI. It
requires the ‘-m32’ option to be turned on.
-mno-red-zone
Do not use a so-called “red zone” for x86-64 code. The red zone is mandated by
the x86-64 ABI; it is a 128-byte area beyond the location of the stack pointer
that is not modified by signal or interrupt handlers and therefore can be used for
temporary data without adjusting the stack pointer. The flag ‘-mno-red-zone’
disables this red zone.
-mcmodel=small
Generate code for the small code model: the program and its symbols must be
linked in the lower 2 GB of the address space. Pointers are 64 bits. Programs
can be statically or dynamically linked. This is the default code model.
-mcmodel=kernel
Generate code for the kernel code model. The kernel runs in the negative 2 GB
of the address space. This model has to be used for Linux kernel code.
-mcmodel=medium
Generate code for the medium model: the program is linked in the lower 2 GB
of the address space. Small symbols are also placed there. Symbols with sizes
larger than ‘-mlarge-data-threshold’ are put into large data or BSS sections
and can be located above 2GB. Programs can be statically or dynamically
linked.
-mcmodel=large
Generate code for the large model. This model makes no assumptions about
addresses and sizes of sections.
-maddress-mode=long
Generate code for long address mode. This is only supported for 64-bit and
x32 environments. It is the default address mode for 64-bit environments.
Chapter 3: GCC Command Options 493
-maddress-mode=short
Generate code for short address mode. This is only supported for 32-bit and x32
environments. It is the default address mode for 32-bit and x32 environments.
-mneeded
-mno-needed
Emit GNU PROPERTY X86 ISA 1 NEEDED GNU property for Linux target
to indicate the micro-architecture ISA level required to execute the binary.
-mno-direct-extern-access
Without ‘-fpic’ nor ‘-fPIC’, always use the GOT pointer to access external
symbols. With ‘-fpic’ or ‘-fPIC’, treat access to protected symbols as local
symbols. The default is ‘-mdirect-extern-access’.
Warning: shared libraries compiled with ‘-mno-direct-extern-access’ and
executable compiled with ‘-mdirect-extern-access’ may not be binary com-
patible if protected symbols are used in shared libraries and executable.
-fno-set-stack-executable
This option is available for MinGW targets. It specifies that the executable flag
for the stack used by nested functions isn’t set. This is necessary for binaries
running in kernel mode of Microsoft Windows, as there the User32 API, which
is used to set executable privileges, isn’t available.
-fwritable-relocated-rdata
This option is available for MinGW and Cygwin targets. It specifies that
relocated-data in read-only section is put into the .data section. This is a
necessary for older runtimes not supporting modification of .rdata sections for
pseudo-relocation.
-mpe-aligned-commons
This option is available for Cygwin and MinGW targets. It specifies that the
GNU extension to the PE file format that permits the correct alignment of
COMMON variables should be used when generating code. It is enabled by
default if GCC detects that the target assembler found during configuration
supports the feature.
See also under Section 3.19.58 [x86 Options], page 465 for standard options.
-mserialize-volatile
-mno-serialize-volatile
When this option is enabled, GCC inserts MEMW instructions before volatile
memory references to guarantee sequential consistency. The default is
‘-mserialize-volatile’. Use ‘-mno-serialize-volatile’ to omit the MEMW
instructions.
-mforce-no-pic
For targets, like GNU/Linux, where all user-mode Xtensa code must be
position-independent code (PIC), this option disables PIC for compiling kernel
code.
-mtext-section-literals
-mno-text-section-literals
These options control the treatment of literal pools. The default is
‘-mno-text-section-literals’, which places literals in a separate section
in the output file. This allows the literal pool to be placed in a data
RAM/ROM, and it also allows the linker to combine literal pools from
separate object files to remove redundant literals and improve code size. With
‘-mtext-section-literals’, the literals are interspersed in the text section
in order to keep them as close as possible to their references. This may be
necessary for large assembly files. Literals for each function are placed right
before that function.
-mauto-litpools
-mno-auto-litpools
These options control the treatment of literal pools. The default is
‘-mno-auto-litpools’, which places literals in a separate section in the output
file unless ‘-mtext-section-literals’ is used. With ‘-mauto-litpools’ the
literals are interspersed in the text section by the assembler. Compiler does
not produce explicit .literal directives and loads literals into registers with
MOVI instructions instead of L32R to let the assembler do relaxation and place
literals as necessary. This option allows assembler to create several literal
pools per function and assemble very big functions, which may not be possible
with ‘-mtext-section-literals’.
-mtarget-align
-mno-target-align
When this option is enabled, GCC instructs the assembler to automatically align
instructions to reduce branch penalties at the expense of some code density. The
assembler attempts to widen density instructions to align branch targets and the
instructions following call instructions. If there are not enough preceding safe
density instructions to align a target, no widening is performed. The default is
‘-mtarget-align’. These options do not affect the treatment of auto-aligned
instructions like LOOP, which the assembler always aligns, either by widening
density instructions or by inserting NOP instructions.
496 Using the GNU Compiler Collection (GCC)
-mlongcalls
-mno-longcalls
When this option is enabled, GCC instructs the assembler to translate direct
calls to indirect calls unless it can determine that the target of a direct call is
in the range allowed by the call instruction. This translation typically occurs
for calls to functions in other source files. Specifically, the assembler translates
a direct CALL instruction into an L32R followed by a CALLX instruction. The
default is ‘-mno-longcalls’. This option should be used in programs where the
call target can potentially be out of range. This option is implemented in the
assembler, not the compiler, so the assembly code generated by GCC still shows
direct call instructions—look at the disassembled object code to see the actual
instructions. Note that the assembler uses an indirect call for every cross-file
call, not just those that really are out of range.
-mabi=name
Generate code for the specified ABI. Permissible values are: ‘call0’,
‘windowed’. Default ABI is chosen by the Xtensa core configuration.
-mabi=call0
When this option is enabled function parameters are passed in registers a2
through a7, registers a12 through a15 are caller-saved, and register a15 may
be used as a frame pointer. When this version of the ABI is enabled the C
preprocessor symbol __XTENSA_CALL0_ABI__ is defined.
-mabi=windowed
When this option is enabled function parameters are passed in registers a10
through a15, and called function rotates register window by 8 registers on entry
so that its arguments are found in registers a2 through a7. Register a7 may
be used as a frame pointer. Register window is rotated 8 registers back upon
return. When this version of the ABI is enabled the C preprocessor symbol
__XTENSA_WINDOWED_ABI__ is defined.
-mextra-l32r-costs=n
Specify an extra cost of instruction RAM/ROM access for L32R instructions,
in clock cycles. This affects, when optimizing for speed, whether loading a
constant from literal pool using L32R or synthesizing the constant from a small
one with a couple of arithmetic instructions. The default value is 0.
programs have multiple spec strings to control their behavior. The spec strings built into
GCC can be overridden by using the ‘-specs=’ command-line switch to specify a spec file.
Spec files are plain-text files that are used to construct spec strings. They consist of a
sequence of directives separated by blank lines. The type of directive is determined by the
first non-whitespace character on the line, which can be one of the following:
%command Issues a command to the spec file processor. The commands that can appear
here are:
%include <file>
Search for file and insert its text at the current point in the specs
file.
%include_noerr <file>
Just like ‘%include’, but do not generate an error message if the
include file cannot be found.
%rename old_name new_name
Rename the spec string old name to new name.
*[spec_name]:
This tells the compiler to create, override or delete the named spec string. All
lines after this directive up to the next directive or blank line are considered to
be the text for the spec string. If this results in an empty string then the spec
is deleted. (Or, if the spec did not exist, then nothing happens.) Otherwise, if
the spec does not currently exist a new spec is created. If the spec does exist
then its contents are overridden by the text of this directive, unless the first
character of that text is the ‘+’ character, in which case the text is appended
to the spec.
[suffix]:
Creates a new ‘[suffix] spec’ pair. All lines after this directive and up to the
next directive or blank line are considered to make up the spec string for the
indicated suffix. When the compiler encounters an input file with the named
suffix, it processes the spec string in order to work out how to compile that file.
For example:
.ZZ:
z-compile -input %i
This says that any input file whose name ends in ‘.ZZ’ should be passed to the
program ‘z-compile’, which should be invoked with the command-line switch
‘-input’ and with the result of performing the ‘%i’ substitution. (See below.)
As an alternative to providing a spec string, the text following a suffix directive
can be one of the following:
@language
This says that the suffix is an alias for a known language. This is
similar to using the ‘-x’ command-line switch to GCC to specify a
language explicitly. For example:
.ZZ:
@c++
Says that .ZZ files are, in fact, C++ source files.
498 Using the GNU Compiler Collection (GCC)
GCC already has an extensive list of suffixes built into it. This directive adds
an entry to the end of the list of suffixes, but since the list is searched from
the end backwards, it is effectively possible to override earlier entries using this
technique.
GCC has the following spec strings built into it. Spec files can override these strings or
create their own. Note that individual targets can also add their own spec strings to this
list.
asm Options to pass to the assembler
asm_final Options to pass to the assembler post-processor
cpp Options to pass to the C preprocessor
cc1 Options to pass to the C compiler
cc1plus Options to pass to the C++ compiler
endfile Object files to include at the end of the link
link Options to pass to the linker
lib Libraries to include on the command line to the linker
libgcc Decides which GCC support library to pass to the linker
linker Sets the name of the linker
predefines Defines to be passed to the C preprocessor
signed_char Defines to pass to CPP to say whether char is signed
by default
startfile Object files to include at the start of the link
Here is a small example of a spec file:
%rename lib old_lib
*lib:
--start-group -lgcc -lc -leval1 --end-group %(old_lib)
This example renames the spec called ‘lib’ to ‘old_lib’ and then overrides the previous
definition of ‘lib’ with a new one. The new definition adds in some extra command-line
options before including the text of the old definition.
Spec strings are a list of command-line options to be passed to their corresponding pro-
gram. In addition, the spec strings can contain ‘%’-prefixed sequences to substitute variable
text or to conditionally insert text into the command line. Using these constructs it is
possible to generate quite complex command lines.
Here is a table of all defined ‘%’-sequences for spec strings. Note that spaces are not
generated automatically around the results of expanding these sequences. Therefore you
can concatenate them together or combine them with constant text in a single argument.
%% Substitute one ‘%’ into the program name or argument.
%" Substitute an empty argument.
%i Substitute the name of the input file being processed.
%b Substitute the basename for outputs related with the input file being processed.
This is often the substring up to (and not including) the last period and not
including the directory but, unless %w is active, it expands to the basename
for auxiliary outputs, which may be influenced by an explicit output name, and
by various other options that control how auxiliary outputs are named.
Chapter 3: GCC Command Options 499
%B This is the same as ‘%b’, but include the file suffix (text after the last period).
Without %w, it expands to the basename for dump outputs.
%d Marks the argument containing or following the ‘%d’ as a temporary file name,
so that that file is deleted if GCC exits successfully. Unlike ‘%g’, this contributes
no text to the argument.
%gsuffix Substitute a file name that has suffix suffix and is chosen once per compilation,
and mark the argument in the same way as ‘%d’. To reduce exposure to denial-
of-service attacks, the file name is now chosen in a way that is hard to predict
even when previously chosen file names are known. For example, ‘%g.s ...
%g.o ... %g.s’ might turn into ‘ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s’. suffix
matches the regexp ‘[.A-Za-z]*’ or the special string ‘%O’, which is treated
exactly as if ‘%O’ had been preprocessed. Previously, ‘%g’ was simply substituted
with a file name chosen once per compilation, without regard to any appended
suffix (which was therefore treated just like ordinary text), making such attacks
more likely to succeed.
%usuffix Like ‘%g’, but generates a new temporary file name each time it appears instead
of once per compilation.
%Usuffix Substitutes the last file name generated with ‘%usuffix’, generating a new
one if there is no such last file name. In the absence of any ‘%usuffix’, this
is just like ‘%gsuffix’, except they don’t share the same suffix space, so ‘%g.s
... %U.s ... %g.s ... %U.s’ involves the generation of two distinct file names,
one for each ‘%g.s’ and another for each ‘%U.s’. Previously, ‘%U’ was simply
substituted with a file name chosen for the previous ‘%u’, without regard to any
appended suffix.
%jsuffix Substitutes the name of the HOST_BIT_BUCKET, if any, and if it is writable, and
if ‘-save-temps’ is not used; otherwise, substitute the name of a temporary
file, just like ‘%u’. This temporary file is not meant for communication between
processes, but rather as a junk disposal mechanism.
%|suffix
%msuffix Like ‘%g’, except if ‘-pipe’ is in effect. In that case ‘%|’ substitutes a single
dash and ‘%m’ substitutes nothing at all. These are the two most common
ways to instruct a program that it should read from standard input or write
to standard output. If you need something more elaborate you can use an
‘%{pipe:X}’ construct: see for example ‘gcc/fortran/lang-specs.h’.
%.SUFFIX Substitutes .SUFFIX for the suffixes of a matched switch’s args when it is
subsequently output with ‘%*’. SUFFIX is terminated by the next space or %.
%w Marks the argument containing or following the ‘%w’ as the designated output
file of this compilation. This puts the argument into the sequence of arguments
that ‘%o’ substitutes.
%V Indicates that this compilation produces no output file.
%o Substitutes the names of all the output files, with spaces automatically placed
around them. You should write spaces around the ‘%o’ as well or the results are
500 Using the GNU Compiler Collection (GCC)
undefined. ‘%o’ is for use in the specs for running the linker. Input files whose
names have no recognized suffix are not compiled at all, but they are included
among the output files, so they are linked.
%O Substitutes the suffix for object files. Note that this is handled specially when
it immediately follows ‘%g, %u, or %U’, because of the need for those to form
complete file names. The handling is such that ‘%O’ is treated exactly as if it
had already been substituted, except that ‘%g, %u, and %U’ do not currently
support additional suffix characters following ‘%O’ as they do following, for
example, ‘.o’.
%I Substitute any of ‘-iprefix’ (made from GCC_EXEC_PREFIX), ‘-isysroot’
(made from TARGET_SYSTEM_ROOT), ‘-isystem’ (made from COMPILER_PATH
and ‘-B’ options) and ‘-imultilib’ as necessary.
%s Current argument is the name of a library or startup file of some sort. Search
for that file in a standard list of directories and substitute the full name found.
The current working directory is included in the list of directories scanned.
%T Current argument is the name of a linker script. Search for that file in the
current list of directories to scan for libraries. If the file is located insert a
‘--script’ option into the command line followed by the full path name found.
If the file is not found then generate an error message. Note: the current
working directory is not searched.
%estr Print str as an error message. str is terminated by a newline. Use this when
inconsistent options are detected.
%nstr Print str as a notice. str is terminated by a newline.
%(name) Substitute the contents of spec string name at this point.
%x{option}
Accumulate an option for ‘%X’.
%X Output the accumulated linker options specified by a ‘%x’ spec string.
%Y Output the accumulated assembler options specified by ‘-Wa’.
%Z Output the accumulated preprocessor options specified by ‘-Wp’.
%M Output multilib_os_dir.
%R Output the concatenation of target_system_root and target_sysroot_
suffix.
%a Process the asm spec. This is used to compute the switches to be passed to the
assembler.
%A Process the asm_final spec. This is a spec string for passing switches to an
assembler post-processor, if such a program is needed.
%l Process the link spec. This is the spec for computing the command line passed
to the linker. Typically it makes use of the ‘%L %G %S %D and %E’ sequences.
%D Dump out a ‘-L’ option for each directory that GCC believes might contain
startup files. If the target supports multilibs then the current multilib directory
is prepended to each of these paths.
Chapter 3: GCC Command Options 501
%L Process the lib spec. This is a spec string for deciding which libraries are
included on the command line to the linker.
%G Process the libgcc spec. This is a spec string for deciding which GCC support
library is included on the command line to the linker.
%S Process the startfile spec. This is a spec for deciding which object files are
the first ones passed to the linker. Typically this might be a file named ‘crt0.o’.
%E Process the endfile spec. This is a spec string that specifies the last object
files that are passed to the linker.
%C Process the cpp spec. This is used to construct the arguments to be passed to
the C preprocessor.
%1 Process the cc1 spec. This is used to construct the options to be passed to the
actual C compiler (cc1).
%2 Process the cc1plus spec. This is used to construct the options to be passed
to the actual C++ compiler (cc1plus).
%* Substitute the variable part of a matched option. See below. Note that each
comma in the substituted string is replaced by a single space.
%<S Remove all occurrences of -S from the command line. Note—this command is
position dependent. ‘%’ commands in the spec string before this one see -S, ‘%’
commands in the spec string after this one do not.
%<S* Similar to ‘%<S’, but match all switches beginning with -S.
%>S Similar to ‘%<S’, but keep -S in the GCC command line.
%:function(args)
Call the named function function, passing it args. args is first processed as a
nested spec string, then split into an argument vector in the usual fashion. The
function returns a string which is processed as if it had appeared literally as
part of the current spec.
The following built-in spec functions are provided:
getenv The getenv spec function takes two arguments: an environment
variable name and a string. If the environment variable is not
defined, a fatal error is issued. Otherwise, the return value is the
value of the environment variable concatenated with the string. For
example, if TOPDIR is defined as ‘/path/to/top’, then:
%:getenv(TOPDIR /include)
expands to ‘/path/to/top/include’.
if-exists
The if-exists spec function takes one argument, an absolute
pathname to a file. If the file exists, if-exists returns the path-
name. Here is a small example of its usage:
*startfile:
crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
502 Using the GNU Compiler Collection (GCC)
if-exists-else
The if-exists-else spec function is similar to the if-exists spec
function, except that it takes two arguments. The first argument is
an absolute pathname to a file. If the file exists, if-exists-else
returns the pathname. If it does not exist, it returns the second
argument. This way, if-exists-else can be used to select one
file or another, based on the existence of the first. Here is a small
example of its usage:
*startfile:
crt0%O%s %:if-exists(crti%O%s) \
%:if-exists-else(crtbeginT%O%s crtbegin%O%s)
if-exists-then-else
The if-exists-then-else spec function takes at least two argu-
ments and an optional third one. The first argument is an absolute
pathname to a file. If the file exists, the function returns the second
argument. If the file does not exist, the function returns the third
argument if there is one, or NULL otherwise. This can be used to
expand one text, or optionally another, based on the existence of a
file. Here is a small example of its usage:
-l%:if-exists-then-else(%:getenv(VSB_DIR rtnet.h) rtnet net)
replace-outfile
The replace-outfile spec function takes two arguments. It looks
for the first argument in the outfiles array and replaces it with the
second argument. Here is a small example of its usage:
%{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)}
remove-outfile
The remove-outfile spec function takes one argument. It looks
for the first argument in the outfiles array and removes it. Here is
a small example its usage:
%:remove-outfile(-lm)
version-compare
The version-compare spec function takes four or five arguments
of the following form:
<comparison-op> <arg1> [<arg2>] <switch> <result>
It returns result if the comparison evaluates to true, and NULL
if it doesn’t. The supported comparison-op values are:
>= True if switch is a later (or same) version than arg1
!> Opposite of >=
< True if switch is an earlier version than arg1
Chapter 3: GCC Command Options 503
pass-through-libs
The pass-through-libs spec function takes any number of argu-
ments. It finds any ‘-l’ options and any non-options ending in
‘.a’ (which it assumes are the names of linker input library archive
files) and returns a result containing all the found arguments each
prepended by ‘-plugin-opt=-pass-through=’ and joined by spa-
ces. This list is intended to be passed to the LTO linker plugin.
%:pass-through-libs(%G %L %G)
print-asm-header
The print-asm-header function takes no arguments and simply
prints a banner like:
Assembler options
=================
debug-level-gt
The debug-level-gt spec function takes one argument and returns
"" (the empty string) if debug_info_level is greater than the
specified number, and NULL otherwise.
%{%:debug-level-gt(0):%{gdwarf*:--gdwarf2}}
%{S} Substitutes the -S switch, if that switch is given to GCC. If that switch is
not specified, this substitutes nothing. Note that the leading dash is omitted
504 Using the GNU Compiler Collection (GCC)
%{%:function(args):X}
Call function named function with args args. If the function returns non-NULL,
then X is substituted, if it returns NULL, it isn’t substituted.
The switch matching text S in a ‘%{S}’, ‘%{S:X}’ or similar construct can use a backslash
to ignore the special meaning of the character following it, thus allowing literal matching
of a character that is otherwise specially treated. For example, ‘%{std=iso9899\:1999:X}’
substitutes X if the ‘-std=iso9899:1999’ option is given.
The conditional text X in a ‘%{S:X}’ or similar construct may contain other nested ‘%’
constructs or spaces, or even newlines. They are processed as usual, as described above.
Trailing white space in X is ignored. White space may also appear anywhere on the left side
of the colon in these constructs, except between . or * and the corresponding word.
The ‘-O’, ‘-f’, ‘-m’, and ‘-W’ switches are handled specifically in these constructs. If
another value of ‘-O’ or the negated form of a ‘-f’, ‘-m’, or ‘-W’ switch is found later in
the command line, the earlier switch value is ignored, except with {S*} where S is just one
letter, which passes all matching options.
The character ‘|’ at the beginning of the predicate text is used to indicate that a command
should be piped to the following command, but only if ‘-pipe’ is specified.
It is built into GCC which switches take arguments and which do not. (You might think
it would be useful to generalize this to allow each compiler’s spec to say which switches
take arguments. But this cannot be done in a consistent fashion. GCC cannot even decide
which input files have been specified without knowing which switches take arguments, and
it must know which input files to compile in order to tell which compilers to run).
GCC also knows implicitly that arguments starting in ‘-l’ are to be treated as compiler
output files, and passed to the linker in their proper position among the other output files.
LANG
LC_CTYPE
LC_MESSAGES
LC_ALL These environment variables control the way that GCC uses localization infor-
mation which allows GCC to work with different national conventions. GCC
inspects the locale categories LC_CTYPE and LC_MESSAGES if it has been config-
ured to do so. These locale categories can be set to any value supported by
your installation. A typical value is ‘en_GB.UTF-8’ for English in the United
Kingdom encoded in UTF-8.
The LC_CTYPE environment variable specifies character classification. GCC uses
it to determine the character boundaries in a string; this is needed for some
multibyte encodings that contain quote and escape characters that are otherwise
interpreted as a string end or escape.
The LC_MESSAGES environment variable specifies the language to use in diag-
nostic messages.
If the LC_ALL environment variable is set, it overrides the value of LC_CTYPE and
LC_MESSAGES; otherwise, LC_CTYPE and LC_MESSAGES default to the value of the
LANG environment variable. If none of these variables are set, GCC defaults to
traditional C English behavior.
TMPDIR If TMPDIR is set, it specifies the directory to use for temporary files. GCC uses
temporary files to hold the output of one stage of compilation which is to be
used as input to the next stage: for example, the output of the preprocessor,
which is the input to the compiler proper.
GCC_COMPARE_DEBUG
Setting GCC_COMPARE_DEBUG is nearly equivalent to passing ‘-fcompare-debug’
to the compiler driver. See the documentation of this option for more details.
GCC_EXEC_PREFIX
If GCC_EXEC_PREFIX is set, it specifies a prefix to use in the names of the
subprograms executed by the compiler. No slash is added when this prefix is
combined with the name of a subprogram, but you can specify a prefix that
ends with a slash if you wish.
If GCC_EXEC_PREFIX is not set, GCC attempts to figure out an appropriate
prefix to use based on the pathname it is invoked with.
If GCC cannot find the subprogram using the specified prefix, it tries looking
in the usual places for the subprogram.
The default value of GCC_EXEC_PREFIX is ‘prefix/lib/gcc/’ where prefix is
the prefix to the installed compiler. In many cases prefix is the value of prefix
when you ran the ‘configure’ script.
Other prefixes specified with ‘-B’ take precedence over this prefix.
This prefix is also used for finding files such as ‘crt0.o’ that are used for linking.
In addition, the prefix is used in an unusual way in finding the directories
to search for header files. For each of the standard directories whose name
normally begins with ‘/usr/local/lib/gcc’ (more precisely, with the value of
GCC_INCLUDE_DIR), GCC tries replacing that beginning with the specified prefix
Chapter 3: GCC Command Options 507
CPATH
C_INCLUDE_PATH
CPLUS_INCLUDE_PATH
OBJC_INCLUDE_PATH
Each variable’s value is a list of directories separated by a special character,
much like PATH, in which to look for header files. The special character, PATH_
SEPARATOR, is target-dependent and determined at GCC build time. For Mi-
crosoft Windows-based targets it is a semicolon, and for almost all other targets
it is a colon.
CPATH specifies a list of directories to be searched as if specified with ‘-I’, but
after any paths given with ‘-I’ options on the command line. This environment
variable is used regardless of which language is being preprocessed.
The remaining environment variables apply only when preprocessing the par-
ticular language indicated. Each specifies a list of directories to be searched as
if specified with ‘-isystem’, but after any paths given with ‘-isystem’ options
on the command line.
In all these variables, an empty element instructs the compiler to search its
current working directory. Empty elements can appear at the beginning or end
of a path. For instance, if the value of CPATH is :/special/include, that has
the same effect as ‘-I. -I/special/include’.
DEPENDENCIES_OUTPUT
If this variable is set, its value specifies how to output dependencies for Make
based on the non-system header files processed by the compiler. System header
files are ignored in the dependency output.
The value of DEPENDENCIES_OUTPUT can be just a file name, in which case the
Make rules are written to that file, guessing the target name from the source
file name. Or the value can have the form ‘file target’, in which case the
rules are written to file file using target as the target name.
In other words, this environment variable is equivalent to combining the options
‘-MM’ and ‘-MF’ (see Section 3.13 [Preprocessor Options], page 254), with an
optional ‘-MT’ switch too.
SUNPRO_DEPENDENCIES
This variable is the same as DEPENDENCIES_OUTPUT (see above), except that
system header files are not ignored, so it implies ‘-M’ rather than ‘-MM’. However,
the dependence on the main input file is omitted. See Section 3.13 [Preprocessor
Options], page 254.
SOURCE_DATE_EPOCH
If this variable is set, its value specifies a UNIX timestamp to be used in re-
placement of the current date and time in the __DATE__ and __TIME__ macros,
so that the embedded timestamps become reproducible.
The value of SOURCE_DATE_EPOCH must be a UNIX timestamp, defined as the
number of seconds (excluding leap seconds) since 01 Jan 1970 00:00:00 repre-
sented in ASCII; identical to the output of date +%s on GNU/Linux and other
systems that support the %s extension in the date command.
Chapter 3: GCC Command Options 509
The value should be a known timestamp such as the last modification time of
the source or package and it should be set by the build process.
• The precompiled header file must be produced for the same language as the current
compilation. You cannot use a C precompiled header for a C++ compilation.
• The precompiled header file must have been produced by the same compiler binary as
the current compilation is using.
• Any macros defined before the precompiled header is included must either be defined
in the same way as when the precompiled header was generated, or must not affect the
precompiled header, which usually means that they don’t appear in the precompiled
header at all.
The ‘-D’ option is one way to define a macro before a precompiled header is included;
using a #define can also do it. There are also some options that define macros im-
plicitly, like ‘-O’ and ‘-Wdeprecated’; the same rule applies to macros defined this
way.
• If debugging information is output when using the precompiled header, using ‘-g’ or
similar, the same kind of debugging information must have been output when building
the precompiled header. However, a precompiled header built using ‘-g’ can be used
in a compilation when no debugging information is being output.
• The same ‘-m’ options must generally be used when building and using the precompiled
header. See Section 3.19 [Submodel Options], page 297, for any cases where this rule
is relaxed.
• Each of the following options must be the same when building and using the precom-
piled header:
-fexceptions
• Some other command-line options starting with ‘-f’, ‘-p’, or ‘-O’ must be defined in
the same way as when the precompiled header was generated. At present, it’s not clear
which options are safe to change and which are not; the safest choice is to use exactly
the same options when generating and using the precompiled header. The following
are known to be safe:
-fmessage-length= -fpreprocessed -fsched-interblock
-fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
-fsched-verbose=number -fschedule-insns -fvisibility=
-pedantic-errors
• Address space layout randomization (ASLR) can lead to not binary identical PCH files.
If you rely on stable PCH file contents disable ASLR when generating PCH files.
For all of these except the last, the compiler automatically ignores the precompiled header
if the conditions aren’t met. If you find an option combination that doesn’t work and
doesn’t cause the precompiled header to be ignored, please consider filing a bug report, see
Chapter 15 [Bugs], page 965.
If you do use differing options when generating and using the precompiled header, the
actual behavior is a mixture of the behavior for the options. For instance, if you use ‘-g’ to
generate the precompiled header but not when using it, you may or may not get debugging
information for routines in the precompiled header.
The “Merging Modules” paper https://wg21.link/p1103, provides the easiest to read set
of changes to the standard, although it does not capture later changes.
G++’s modules support is not complete. Other than bugs, the known missing pieces are:
Private Module Fragment
The Private Module Fragment is recognized, but an error is emitted.
Partition definition visibility rules
Entities may be defined in implementation partitions, and those definitions are
not available outside of the module. This is not implemented, and the definitions
are available to extra-module use.
Textual merging of reachable GM entities
Entities may be multiply defined across different header-units. These must
be de-duplicated, and this is implemented across imports, or when an import
redefines a textually-defined entity. However the reverse is not implemented—
textually redefining an entity that has been defined in an imported header-unit.
A redefinition error is emitted.
Translation-Unit local referencing rules
Papers p1815 (https://wg21.link/p1815) and p2003 (https://wg21.link/
p2003) add limitations on which entities an exported region may reference (for
instance, the entities an exported template definition may reference). These
are not fully implemented.
Standard Library Header Units
The Standard Library is not provided as importable header units. If you want
to import such units, you must explicitly build them first. If you do not do this
with care, you may have multiple declarations, which the module machinery
must merge—compiler resource usage can be affected by how you partition
header files into header units.
Modular compilation is not enabled with just the ‘-std=c++20’ option. You must explic-
itly enable it with the ‘-fmodules-ts’ option. It is independent of the language version
selected, although in pre-C++20 versions, it is of course an extension.
No new source file suffixes are required or supported. If you wish to use a non-standard
suffix (see Section 3.2 [Overall Options], page 33), you also need to provide a ‘-x c++’ option
too.2
Compiling a module interface unit produces an additional output (to the assembly or
object file), called a Compiled Module Interface (CMI). This encodes the exported declara-
tions of the module. Importing a module reads in the CMI. The import graph is a Directed
Acyclic Graph (DAG). You must build imports before the importer.
Header files may themselves be compiled to header units, which are a transitional ability
aiming at faster compilation. The ‘-fmodule-header’ option is used to enable this, and
implies the ‘-fmodules-ts’ option. These CMIs are named by the fully resolved underlying
header file, and thus may be a complete pathname containing subdirectories. If the header
2
Some users like to distinguish module interface files with a new suffix, such as naming the source
module.cppm, which involves teaching all tools about the new suffix. A different scheme, such as naming
module-m.cpp would be less invasive.
512 Using the GNU Compiler Collection (GCC)
file is found at an absolute pathname, the CMI location is still relative to a CMI root
directory.
As header files often have no suffix, you commonly have to specify a ‘-x’ option to tell the
compiler the source is a header file. You may use ‘-x c++-header’, ‘-x c++-user-header’
or ‘-x c++-system-header’. When used in conjunction with ‘-fmodules-ts’, these all
imply an appropriate ‘-fmodule-header’ option. The latter two variants use the user or
system include path to search for the file specified. This allows you to, for instance, compile
standard library header files as header units, without needing to know exactly where they
are installed. Specifying the language as one of these variants also inhibits output of the
object file, as header files have no associated object file.
The ‘-fmodule-only’ option disables generation of the associated object file for compiling
a module interface. Only the CMI is generated. This option is implied when using the
‘-fmodule-header’ option.
The ‘-flang-info-include-translate’ and ‘-flang-info-include-translate-not’
options notes whether include translation occurs or not. With no argument, the first will
note all include translation. The second will note all non-translations of include files not
known to intentionally be textual. With an argument, queries about include translation of
a header files with that particular trailing pathname are noted. You may repeat this form
to cover several different header files. This option may be helpful in determining whether
include translation is happening—if it is working correctly, it behaves as if it isn’t there at
all.
The ‘-flang-info-module-cmi’ option can be used to determine where the compiler
is reading a CMI from. Without the option, the compiler is silent when such a read is
successful. This option has an optional argument, which will restrict the notification to just
the set of named modules or header units specified.
The ‘-Winvalid-imported-macros’ option causes all imported macros to be resolved at
the end of compilation. Without this, imported macros are only resolved when expanded
or (re)defined. This option detects conflicting import definitions for all macros.
For details of the ‘-fmodule-mapper’ family of options, see Section 3.23.1 [C++ Module
Mapper], page 512.
=socket[?ident]
A local domain socket. If your host lacks local domain sockets, this form is
non-functional.
|program[?ident] [args...]
A program to spawn, and communicate with on its stdin/stdout streams. Your
PATH environment variable is searched for the program. Arguments are sepa-
rated by space characters, (it is not possible for one of the arguments delivered
to the program to contain a space). An exception is if program begins with @.
In that case program (sans @) is looked for in the compiler’s internal binary
directory. Thus the sample mapper-server can be specified with @g++-mapper-
server.
<>[?ident]
<>inout[?ident]
<in>out[?ident]
Named pipes or file descriptors to communicate over. The first form, ‘<>’,
communicates over stdin and stdout. The other forms allow you to specify a
file descriptor or name a pipe. A numeric value is interpreted as a file descriptor,
otherwise named pipe is opened. The second form specifies a bidirectional pipe
and the last form allows specifying two independent pipes. Using file descriptors
directly in this manner is fragile in general, as it can require the cooperation
of intermediate processes. In particular using stdin & stdout is fraught with
danger as other compiler options might also cause the compiler to read stdin
or write stdout, and it can have unfortunate interactions with signal delivery
from the terminal.
file[?ident]
A mapping file consisting of space-separated module-name, filename pairs, one
per line. Only the mappings for the direct imports and any module export
name need be provided. If other mappings are provided, they override those
stored in any imported CMI files. A repository root may be specified in the
mapping file by using ‘$root’ as the module name in the first active line. Use
of this option will disable any default module->CMI name mapping.
As shown, an optional ident may suffix the first word of the option, indicated by a ‘?’
prefix. The value is used in the initial handshake with the module server, or to specify a
prefix on mapping file lines. In the server case, the main source file name is used if no ident
is specified. In the file case, all non-blank lines are significant, unless a value is specified, in
which case only lines beginning with ident are significant. The ident must be separated by
whitespace from the module name. Be aware that ‘<’, ‘>’, ‘?’, and ‘|’ characters are often
significant to the shell, and therefore may need quoting.
The mapper is connected to or loaded lazily, when the first module mapping is required.
The networking protocols are only supported on hosts that provide networking. If no
mapper is specified a default is provided.
A project-specific mapper is expected to be provided by the build system that invokes the
compiler. It is not expected that a general-purpose server is provided for all compilations.
As such, the server will know the build configuration, the compiler it invoked, and the
514 Using the GNU Compiler Collection (GCC)
do not observe the CMI during its creation. This is unlike object file writing, which may
be observed by an external process.
CMIs are read in lazily, if the host OS provides mmap functionality. Generally blocks
are read when name lookup or template instantiation occurs. To inhibit this, the
‘-fno-module-lazy’ option may be used.
The ‘--param lazy-modules=n’ parameter controls the limit on the number of concur-
rently open module files during lazy loading. Should more modules be imported, an LRU
algorithm is used to determine which files to close—until that file is needed again. This
limit may be exceeded with deep module dependency hierarchies. With large code bases
there may be more imports than the process limit of file descriptors. By default, the limit
is a few less than the per-process file descriptor hard limit, if that is determinable.3
GCC CMIs use ELF32 as an architecture-neutral encapsulation mechanism. You may
use readelf to inspect them, although section contents are largely undecipherable. There
is a section named .gnu.c++.README, which contains human-readable text. Other than the
first line, each line consists of tag: value tuples.
> readelf -p.gnu.c++.README gcm.cache/foo.gcm
3
Where applicable the soft limit is incremented as needed towards the hard limit.
4
The precise contents of this output may change.
Chapter 4: C Implementation-Defined Behavior 517
4 C Implementation-Defined Behavior
A conforming implementation of ISO C is required to document its choice of behavior in
each of the areas that are designated “implementation defined”. The following lists all such
areas, along with the section numbers from the ISO/IEC 9899:1990, ISO/IEC 9899:1999
and ISO/IEC 9899:2011 standards. Some areas are only implementation-defined in one
version of the standard.
Some choices depend on the externally determined ABI for the platform (including stan-
dard character encodings) which GCC follows; these are listed as “determined by ABI”
below. See Chapter 9 [Binary Compatibility], page 917, and https: / /gcc .gnu .org /
readings.html. Some choices are documented in the preprocessor manual. See Section
“Implementation-defined behavior” in The C Preprocessor. Some choices are made by
the library and operating system (or other environment when compiling for a freestanding
environment); refer to their documentation for details.
4.1 Translation
• How a diagnostic is identified (C90 3.7, C99 and C11 3.10, C90, C99 and C11 5.1.1.3).
Diagnostics consist of all the output sent to stderr by GCC.
• Whether each nonempty sequence of white-space characters other than new-line is
retained or replaced by one space character in translation phase 3 (C90, C99 and C11
5.1.1.2).
See Section “Implementation-defined behavior” in The C Preprocessor.
4.2 Environment
The behavior of most of these points are dependent on the implementation of the C library,
and are not defined by GCC itself.
• The mapping between physical source file multibyte characters and the source character
set in translation phase 1 (C90, C99 and C11 5.1.1.2).
See Section “Implementation-defined behavior” in The C Preprocessor.
4.3 Identifiers
• Which additional multibyte characters may appear in identifiers and their correspon-
dence to universal character names (C99 and C11 6.4.2).
See Section “Implementation-defined behavior” in The C Preprocessor.
• The number of significant initial characters in an identifier (C90 6.1.2, C90, C99 and
C11 5.2.4.1, C99 and C11 6.4.2).
For internal names, all characters are significant. For external names, the number of
significant characters are defined by the linker; for almost all targets, all characters are
significant.
• Whether case distinctions are significant in an identifier with external linkage (C90
6.1.2).
This is a property of the linker. C99 and C11 require that case distinctions are always
significant in identifiers with external linkage and systems without this property are
not supported by GCC.
518 Using the GNU Compiler Collection (GCC)
4.4 Characters
• The number of bits in a byte (C90 3.4, C99 and C11 3.6).
Determined by ABI.
• The values of the members of the execution character set (C90, C99 and C11 5.2.1).
Determined by ABI.
• The unique value of the member of the execution character set produced for each of
the standard alphabetic escape sequences (C90, C99 and C11 5.2.2).
Determined by ABI.
• The value of a char object into which has been stored any character other than a
member of the basic execution character set (C90 6.1.2.5, C99 and C11 6.2.5).
Determined by ABI.
• Which of signed char or unsigned char has the same range, representation, and be-
havior as “plain” char (C90 6.1.2.5, C90 6.2.1.1, C99 and C11 6.2.5, C99 and C11
6.3.1.1).
Determined by ABI. The options ‘-funsigned-char’ and ‘-fsigned-char’ change the
default. See Section 3.4 [Options Controlling C Dialect], page 44.
• The mapping of members of the source character set (in character constants and string
literals) to members of the execution character set (C90 6.1.3.4, C99 and C11 6.4.4.4,
C90, C99 and C11 5.1.1.2).
Determined by ABI.
• The value of an integer character constant containing more than one character or
containing a character or escape sequence that does not map to a single-byte execution
character (C90 6.1.3.4, C99 and C11 6.4.4.4).
See Section “Implementation-defined behavior” in The C Preprocessor.
• The value of a wide character constant containing more than one multibyte character or
a single multibyte character that maps to multiple members of the extended execution
character set, or containing a multibyte character or escape sequence not represented
in the extended execution character set (C90 6.1.3.4, C99 and C11 6.4.4.4).
See Section “Implementation-defined behavior” in The C Preprocessor.
• The current locale used to convert a wide character constant consisting of a single
multibyte character that maps to a member of the extended execution character set
into a corresponding wide character code (C90 6.1.3.4, C99 and C11 6.4.4.4).
See Section “Implementation-defined behavior” in The C Preprocessor.
• Whether differently-prefixed wide string literal tokens can be concatenated and, if so,
the treatment of the resulting multibyte character sequence (C11 6.4.5).
Such tokens may not be concatenated.
• The current locale used to convert a wide string literal into corresponding wide char-
acter codes (C90 6.1.4, C99 and C11 6.4.5).
See Section “Implementation-defined behavior” in The C Preprocessor.
• The value of a string literal containing a multibyte character or escape sequence not
represented in the execution character set (C90 6.1.4, C99 and C11 6.4.5).
See Section “Implementation-defined behavior” in The C Preprocessor.
Chapter 4: C Implementation-Defined Behavior 519
• The encoding of any of wchar_t, char16_t, and char32_t where the corresponding
standard encoding macro (__STDC_ISO_10646__, __STDC_UTF_16__, or __STDC_UTF_
32__) is not defined (C11 6.10.8.2).
See Section “Implementation-defined behavior” in The C Preprocessor. char16_t and
char32_t literals are always encoded in UTF-16 and UTF-32 respectively.
4.5 Integers
• Any extended integer types that exist in the implementation (C99 and C11 6.2.5).
GCC does not support any extended integer types.
• Whether signed integer types are represented using sign and magnitude, two’s comple-
ment, or one’s complement, and whether the extraordinary value is a trap representa-
tion or an ordinary value (C99 and C11 6.2.6.2).
GCC supports only two’s complement integer types, and all bit patterns are ordinary
values.
• The rank of any extended integer type relative to another extended integer type with
the same precision (C99 and C11 6.3.1.1).
GCC does not support any extended integer types.
• The result of, or the signal raised by, converting an integer to a signed integer type
when the value cannot be represented in an object of that type (C90 6.2.1.2, C99 and
C11 6.3.1.3).
For conversion to a type of width N , the value is reduced modulo 2N to be within range
of the type; no signal is raised.
• The results of some bitwise operations on signed integers (C90 6.3, C99 and C11 6.5).
Bitwise operators act on the representation of the value including both the sign and
value bits, where the sign bit is considered immediately above the highest-value value
bit. Signed ‘>>’ acts on negative numbers by sign extension.
As an extension to the C language, GCC does not use the latitude given in C99 and C11
only to treat certain aspects of signed ‘<<’ as undefined. However, ‘-fsanitize=shift’
(and ‘-fsanitize=undefined’) will diagnose such cases. They are also diagnosed where
constant expressions are required.
• The sign of the remainder on integer division (C90 6.3.5).
GCC always follows the C99 and C11 requirement that the result of division is truncated
towards zero.
A cast from pointer to integer discards most-significant bits if the pointer representation
is larger than the integer type, sign-extends1 if the pointer representation is smaller
than the integer type, otherwise the bits are unchanged.
A cast from integer to pointer discards most-significant bits if the pointer representation
is smaller than the integer type, extends according to the signedness of the integer type
if the pointer representation is larger than the integer type, otherwise the bits are
unchanged.
When casting from pointer to integer and back again, the resulting pointer must ref-
erence the same object as the original pointer, otherwise the behavior is undefined.
That is, one may not use integer arithmetic to avoid the undefined behavior of pointer
arithmetic as proscribed in C99 and C11 6.5.6/8.
• The size of the result of subtracting two pointers to elements of the same array (C90
6.3.6, C99 and C11 6.5.6).
The value is as specified in the standard and the type is determined by the ABI.
4.8 Hints
• The extent to which suggestions made by using the register storage-class specifier
are effective (C90 6.5.1, C99 and C11 6.7.1).
The register specifier affects code generation only in these ways:
• When used as part of the register variable extension, see Section 6.47.5 [Explicit
Register Variables], page 707.
• When ‘-O0’ is in use, the compiler allocates distinct stack memory for all variables
that do not have the register storage-class specifier; if register is specified, the
variable may have a shorter lifespan than the code would indicate and may never
be placed in memory.
• On some rare x86 targets, setjmp doesn’t save the registers in all circumstances.
In those cases, GCC doesn’t allocate any variables in registers unless they are
marked register.
• The extent to which suggestions made by using the inline function specifier are effective
(C99 and C11 6.7.4).
GCC will not inline any functions if the ‘-fno-inline’ option is used or if ‘-O0’ is
used. Otherwise, GCC may still be unable to inline a function for many reasons; the
‘-Winline’ option may be used to determine if a function has not been inlined and why
not.
4.10 Qualifiers
• What constitutes an access to an object that has volatile-qualified type (C90 6.5.3, C99
and C11 6.7.3).
Such an object is normally accessed by pointers and used for accessing hardware. In
most expressions, it is intuitively obvious what is a read and what is a write. For
example
volatile int *dst = somevalue;
volatile int *src = someothervalue;
*dst = *src;
will cause a read of the volatile object pointed to by src and store the value into the
volatile object pointed to by dst. There is no guarantee that these reads and writes
are atomic, especially for objects larger than int.
However, if the volatile storage is not being modified, and the value of the volatile
storage is not used, then the situation is less obvious. For example
volatile int *src = somevalue;
*src;
According to the C standard, such an expression is an rvalue whose type is the unqual-
ified version of its original type, i.e. int. Whether GCC interprets this as a read of the
Chapter 4: C Implementation-Defined Behavior 523
volatile object being pointed to or only as a request to evaluate the expression for its
side effects depends on this type.
If it is a scalar type, or on most targets an aggregate type whose only member object
is of a scalar type, or a union type whose member objects are of scalar types, the
expression is interpreted by GCC as a read of the volatile object; in the other cases,
the expression is only evaluated for its side effects.
When an object of an aggregate type, with the same size and alignment as a scalar
type S, is the subject of a volatile access by an assignment expression or an atomic
function, the access to it is performed as if the object’s declared type were volatile
S.
4.11 Declarators
• The maximum number of declarators that may modify an arithmetic, structure or
union type (C90 6.5.4).
GCC is only limited by available memory.
4.12 Statements
• The maximum number of case values in a switch statement (C90 6.6.4.2).
GCC is only limited by available memory.
• Whether the ‘#’ operator inserts a ‘\’ character before the ‘\’ character that begins
a universal character name in a character constant or string literal (C99 and C11
6.10.3.2).
• The behavior on each recognized non-STDC #pragma directive (C90 6.8.6, C99 and C11
6.10.6).
See Section “Pragmas” in The C Preprocessor, for details of pragmas accepted by GCC
on all targets. See Section 6.62 [Pragmas Accepted by GCC], page 873, for details of
target-specific pragmas.
• The definitions for __DATE__ and __TIME__ when respectively, the date and time of
translation are not available (C90 6.8.8, C99 6.10.8, C11 6.10.8.1).
4.15 Architecture
• The values or expressions assigned to the macros specified in the headers <float.h>,
<limits.h>, and <stdint.h> (C90, C99 and C11 5.2.4.2, C99 7.18.2, C99 7.18.3, C11
7.20.2, C11 7.20.3).
Determined by ABI.
• The result of attempting to indirectly access an object with automatic or thread storage
duration from a thread other than the one with which it is associated (C11 6.2.4).
Such accesses are supported, subject to the same requirements for synchronization for
concurrent accesses as for concurrent accesses to any object.
• The number, order, and encoding of bytes in any object (when not explicitly specified
in this International Standard) (C99 and C11 6.2.6.1).
Determined by ABI.
• Whether any extended alignments are supported and the contexts in which they are
supported (C11 6.2.8).
Extended alignments up to 228 (bytes) are supported for objects of automatic storage
duration. Alignments supported for objects of static and thread storage duration are
determined by the ABI.
• Valid alignment values other than those returned by an Alignof expression for funda-
mental types, if any (C11 6.2.8).
Valid alignments are powers of 2 up to and including 228 .
• The value of the result of the sizeof and _Alignof operators (C90 6.3.3.4, C99 and
C11 6.5.3.4).
Determined by ABI.
Chapter 4: C Implementation-Defined Behavior 525
#define maxint3(a, b, c) \
({int _a = (a), _b = (b), _c = (c); maxint (maxint (_a, _b), _c); })
Embedded statements are not allowed in constant expressions, such as the value of an
enumeration constant, the width of a bit-field, or the initial value of a static variable.
If you don’t know the type of the operand, you can still do this, but you must use typeof
or __auto_type (see Section 6.7 [Typeof], page 537).
In G++, the result value of a statement expression undergoes array and function pointer
decay, and is returned by value to the enclosing expression. For instance, if A is a class,
then
A a;
({a;}).Foo ()
constructs a temporary A object to hold the result of the statement expression, and that is
used to invoke Foo. Therefore the this pointer observed by Foo is not the address of a.
In a statement expression, any temporaries created within a statement are destroyed at
that statement’s end. This makes statement expressions inside macros slightly different
from function calls. In the latter case temporaries introduced during argument evaluation
are destroyed at the end of the statement that includes the function call. In the statement
expression case they are destroyed during the statement expression. For instance,
#define macro(a) ({__typeof__(a) b = (a); b + 3; })
template<typename T> T function(T a) { T b = a; return b + 3; }
void foo ()
{
macro (X ());
function (X ());
}
has different places where temporaries are destroyed. For the macro case, the temporary
X is destroyed just after the initialization of b. In the function case that temporary is
destroyed when the function returns.
These considerations mean that it is probably a bad idea to use statement expressions of
this form in header files that are designed to work with C++. (Note that some versions of
the GNU C Library contained header files using statement expressions that lead to precisely
this bug.)
Jumping into a statement expression with goto or using a switch statement outside the
statement expression with a case or default label inside the statement expression is not
permitted. Jumping into a statement expression with a computed goto (see Section 6.3
[Labels as Values], page 532) has undefined behavior. Jumping out of a statement expres-
sion is permitted, but if the statement expression is part of a larger expression then it is
unspecified which other subexpressions of that expression have been evaluated except where
the language definition requires certain subexpressions to be evaluated before or after the
statement expression. A break or continue statement inside of a statement expression
used in while, do or for loop or switch statement condition or for statement init or in-
crement expressions jumps to an outer loop or switch statement if any (otherwise it is an
error), rather than to the loop or switch statement in whose condition or init or increment
expression it appears. In any case, as with a function call, the evaluation of a statement
Chapter 6: Extensions to the C Language Family 531
expression is not interleaved with the evaluation of other parts of the containing expression.
For example,
foo (), (({ bar1 (); goto a; 0; }) + bar2 ()), baz();
calls foo and bar1 and does not call baz but may or may not call bar2. If bar2 is called,
it is called after foo and before bar1.
value = -1; \
found: \
value; \
})
Local label declarations also make the labels they declare visible to nested functions, if
there are any. See Section 6.4 [Nested Functions], page 533, for details.
The nested function can access all the variables of the containing function that are visible
at the point of its definition. This is called lexical scoping. For example, here we show a
nested function which uses an inherited variable named offset:
bar (int *array, int offset, int size)
{
int access (int *array, int index)
{ return array[index + offset]; }
int i;
/* . . . */
for (i = 0; i < size; i++)
/* . . . */ access (array, i) /* . . . */
}
Nested function definitions are permitted within functions in the places where variable
definitions are allowed; that is, in any block, mixed with the other declarations and state-
ments in the block.
It is possible to call the nested function from outside the scope of its name by storing its
address or passing the address to another function:
hack (int *array, int size)
{
void store (int index, int value)
{ array[index] = value; }
GCC implements taking the address of a nested function using a technique called tram-
polines. This technique was described in Lexical Closures for C++ (Thomas M. Breuel,
USENIX C++ Conference Proceedings, October 17-21, 1988).
A nested function can jump to a label inherited from a containing function, provided
the label is explicitly declared in the containing function (see Section 6.2 [Local Labels],
page 531). Such a jump returns instantly to the containing function, exiting the nested
function that did the goto and any intermediate functions as well. Here is an example:
bar (int *array, int offset, int size)
{
__label__ failure;
int access (int *array, int index)
{
if (index > size)
goto failure;
return array[index + offset];
}
int i;
/* . . . */
for (i = 0; i < size; i++)
/* . . . */ access (array, i) /* . . . */
/* . . . */
return 0;
A nested function always has no linkage. Declaring one with extern or static is erro-
neous. If you need to declare the nested function before its definition, use auto (which is
otherwise meaningless for function declarations).
bar (int *array, int offset, int size)
{
__label__ failure;
auto int access (int *, int);
/* . . . */
int access (int *array, int index)
{
if (index > size)
goto failure;
return array[index + offset];
}
/* . . . */
}
The built-in versions of these functions use GCC’s normal mechanisms to save and restore
registers using the stack on function entry and exit. The jump buffer argument buf holds
only the information needed to restore the stack frame, rather than the entire set of saved
register values.
An important caveat is that GCC arranges to save and restore only those registers known
to the specific architecture variant being compiled for. This can make __builtin_setjmp
and __builtin_longjmp more efficient than their library counterparts in some cases, but
it can also cause incorrect and mysterious behavior when mixing with code that uses the
full register set.
You should declare the jump buffer argument buf to the built-in functions as:
#include <stdint.h>
intptr_t buf[5];
if (__builtin_constant_p (oflag))
Chapter 6: Extensions to the C Language Family 537
{
if ((oflag & O_CREAT) != 0 && __builtin_va_arg_pack_len () < 1)
{
warn_open_missing_mode ();
return __open_2 (path, oflag);
}
return open (path, oflag, __builtin_va_arg_pack ());
}
if (__builtin_va_arg_pack_len () < 1)
return __open_2 (path, oflag);
GCC can handle both implicit and explicit casts between the _Complex types and other
_Complex types as casting both the real and imaginary parts to the scalar type. GCC can
handle implicit and explicit casts from a scalar type to a _Complex type and where the
imaginary part will be considered zero. The C front-end can handle implicit and explicit
casts from a _Complex type to a scalar type where the imaginary part will be ignored. In
C++ code, this cast is considered illformed and G++ will error out.
GCC provides a built-in function __builtin_complex will can be used to construct a
complex value.
GCC has a few extensions which can be used to extract the real and the imaginary part
of the complex-valued expression. Note these expressions are lvalues if the exp is an lvalue.
These expressions operands have the type of a complex type which might get prompoted
to a complex type from a scalar type. E.g. __real__ (int)x is the same as casting to
_Complex int before __real__ is done.
Expression Description
__real__ exp Extract the real part of exp.
__imag__ exp Extract the imaginary part of exp.
For values of floating point, you should use the ISO C99 functions, declared in
<complex.h> and also provided as built-in functions by GCC.
target architecture. These types are not supported when compiling C++. Constants with
these types use suffixes fn or Fn and fnx or Fnx. These type names can be used together
with _Complex to declare complex types.
As an extension, GNU C and GNU C++ support additional floating types, which are not
supported by all targets.
• __float128 is available on i386, x86 64, IA-64, and hppa HP-UX, as well as on Pow-
erPC GNU/Linux targets that enable the vector scalar (VSX) instruction set. __
float128 supports the 128-bit floating type. On i386, x86 64, PowerPC, and IA-64
other than HP-UX, __float128 is an alias for _Float128. On hppa and IA-64 HP-UX,
__float128 is an alias for long double.
• __float80 is available on the i386, x86 64, and IA-64 targets, and supports the 80-bit
(XFmode) floating type. It is an alias for the type name _Float64x on these targets.
• __ibm128 is available on PowerPC targets, and provides access to the IBM extended
double format which is the current format used for long double. When long double
transitions to __float128 on PowerPC in the future, __ibm128 will remain for use in
conversions between the two types.
Support for these additional types includes the arithmetic operators: add, subtract, mul-
tiply, divide; unary arithmetic operators; relational operators; equality operators; and con-
versions to and from integer and other floating types. Use a suffix ‘w’ or ‘W’ in a literal
constant of type __float80 or type __ibm128. Use a suffix ‘q’ or ‘Q’ for _float128.
In order to use _Float128, __float128, and __ibm128 on PowerPC Linux systems, you
must use the ‘-mfloat128’ option. It is expected in future versions of GCC that _Float128
and __float128 will be enabled automatically.
The _Float128 type is supported on all systems where __float128 is supported or
where long double has the IEEE binary128 format. The _Float64x type is supported
on all systems where __float128 is supported. The _Float32 type is supported on all
systems supporting IEEE binary32; the _Float64 and _Float32x types are supported on all
systems supporting IEEE binary64. The _Float16 type is supported on AArch64 systems
by default, on ARM systems when the IEEE format for 16-bit floating-point types is selected
with ‘-mfp16-format=ieee’ and, for both C and C++, on x86 systems with SSE2 enabled.
GCC does not currently support _Float128x on any systems.
On the i386, x86 64, IA-64, and HP-UX targets, you can declare complex types using
the corresponding internal complex type, XCmode for __float80 type and TCmode for __
float128 type:
typedef _Complex float __attribute__((mode(TC))) _Complex128;
typedef _Complex float __attribute__((mode(XC))) _Complex80;
On the PowerPC Linux VSX targets, you can declare complex types using the corre-
sponding internal complex type, KCmode for __float128 type and ICmode for __ibm128
type:
typedef _Complex float __attribute__((mode(KC))) _Complex_float128;
typedef _Complex float __attribute__((mode(IC))) _Complex_ibm128;
enable this type explicitly with the ‘-mfp16-format’ command-line option in order to use it.
On x86 targets with SSE2 enabled, GCC supports half-precision (16-bit) floating point via
the _Float16 type. For C++, x86 provides a builtin type named _Float16 which contains
same data format as C.
ARM targets support two incompatible representations for half-precision floating-point
values. You must choose one of the representations and use it consistently in your program.
Specifying ‘-mfp16-format=ieee’ selects the IEEE 754-2008 format. This format can
represent normalized values in the range of 2−14 to 65504. There are 11 bits of significand
precision, approximately 3 decimal digits.
Specifying ‘-mfp16-format=alternative’ selects the ARM alternative format. This rep-
resentation is similar to the IEEE format, but does not support infinities or NaNs. Instead,
the range of exponents is extended, so that this format can represent normalized values in
the range of 2−14 to 131008.
The GCC port for AArch64 only supports the IEEE 754-2008 format, and does not
require use of the ‘-mfp16-format’ command-line option.
The __fp16 type may only be used as an argument to intrinsics defined in <arm_fp16.h>,
or as a storage format. For purposes of arithmetic and other operations, __fp16 values in
C or C++ expressions are automatically promoted to float.
The ARM target provides hardware support for conversions between __fp16 and float
values as an extension to VFP and NEON (Advanced SIMD), and from ARMv8-A provides
hardware support for conversions between __fp16 and double values. GCC generates
code using these hardware instructions if you compile with options to select an FPU that
provides them; for example, ‘-mfpu=neon-fp16 -mfloat-abi=softfp’, in addition to the
‘-mfp16-format’ option to select a half-precision format.
Language-level support for the __fp16 data type is independent of whether GCC gen-
erates code using hardware floating-point instructions. In cases where hardware support
is not specified, GCC implements conversions between __fp16 and other types as library
calls.
It is recommended that portable code use the _Float16 type defined by ISO/IEC TS
18661-3:2015. See Section 6.12 [Floating Types], page 540.
On x86 targets with SSE2 enabled, without ‘-mavx512fp16’, all operations will be emu-
lated by software emulation and the float instructions. The default behavior for FLT_EVAL_
METHOD is to keep the intermediate result of the operation as 32-bit precision. This may
lead to inconsistent behavior between software emulation and AVX512-FP16 instructions.
Using ‘-fexcess-precision=16’ will force round back after each operation.
Using ‘-mavx512fp16’ will generate AVX512-FP16 instructions instead of software em-
ulation. The default behavior of FLT_EVAL_METHOD is to round after each operation. The
same is true with ‘-fexcess-precision=standard’ and ‘-mfpmath=sse’. If there is no
‘-mfpmath=sse’, ‘-fexcess-precision=standard’ alone does the same thing as before, It
is useful for code that does not have _Float16 and runs on the x87 FPU.
technical report changes. Calling conventions for any target might also change. Not all
targets support decimal floating types.
The decimal floating types are _Decimal32, _Decimal64, and _Decimal128. They use a
radix of ten, unlike the floating types float, double, and long double whose radix is not
specified by the C standard but is usually two.
Support for decimal floating types includes the arithmetic operators add, subtract, mul-
tiply, divide; unary arithmetic operators; relational operators; equality operators; and con-
versions to and from integer and other floating types. Use a suffix ‘df’ or ‘DF’ in a literal
constant of type _Decimal32, ‘dd’ or ‘DD’ for _Decimal64, and ‘dl’ or ‘DL’ for _Decimal128.
GCC support of decimal float as specified by the draft technical report is incomplete:
• When the value of a decimal floating type cannot be represented in the integer type to
which it is being converted, the result is undefined rather than the result value specified
by the draft technical report.
• GCC does not provide the C library functionality associated with ‘math.h’, ‘fenv.h’,
‘stdio.h’, ‘stdlib.h’, and ‘wchar.h’, which must come from a separate C library
implementation. Because of this the GNU C compiler does not define macro __STDC_
DEC_FP__ to indicate that the implementation conforms to the technical report.
Types _Decimal32, _Decimal64, and _Decimal128 are supported by the DWARF debug
information format.
_Accum, _Sat short _Accum, _Sat _Accum, _Sat long _Accum, _Sat long long _Accum,
_Sat unsigned short _Accum, _Sat unsigned _Accum, _Sat unsigned long _Accum, _Sat
unsigned long long _Accum.
Fixed-point data values contain fractional and optional integral parts. The format of
fixed-point data varies and depends on the target machine.
Support for fixed-point types includes:
• prefix and postfix increment and decrement operators (++, --)
• unary arithmetic operators (+, -, !)
• binary arithmetic operators (+, -, *, /)
• binary shift operators (<<, >>)
• relational operators (<, <=, >=, >)
• equality operators (==, !=)
• assignment operators (+=, -=, *=, /=, <<=, >>=)
• conversions to and from integer, floating-point, or fixed-point types
GCC support of fixed-point types as specified by the draft technical report is incomplete:
• Pragmas to control overflow and rounding behaviors are not implemented.
return **p;
}
int i = 1;
For each named address space supported by avr-gcc there is an equally named but uppercase
built-in macro defined. The purpose is to facilitate testing if respective address space
support is available or not:
#ifdef __FLASH
const __flash int var = 1;
Notice that attribute Section 6.34.3 [progmem], page 630 locates data in flash but accesses
to these data read from generic address space, i.e. from RAM, so that you need special
accessors like pgm_read_byte from AVR-LibC together with attribute progmem.
Limitations and caveats
• Reading across the 64 KiB section boundary of the __flash or __flashN address spaces
shows undefined behavior. The only address space that supports reading across the
64 KiB flash segment boundaries is __memx.
• If you use one of the __flashN address spaces you must arrange your linker script to
locate the .progmemN.data sections according to your needs.
• Any data or pointers to the non-generic address spaces must be qualified as const,
i.e. as read-only data. This still applies if the data in one of these address spaces like
software version number or calibration lookup table are intended to be changed after
load time by, say, a boot loader. In this case the right qualification is const volatile
Chapter 6: Extensions to the C Language Family 547
so that the compiler must not optimize away known values or insert them as immediates
into operands of instructions.
• The following code initializes a variable pfoo located in static storage with a 24-bit
address:
extern const __memx char foo;
const __memx void *pfoo = &foo;
• On the reduced Tiny devices like ATtiny40, no address spaces are supported. Just
use vanilla C / C++ code without overhead as outlined above. Attribute progmem is
supported but works differently, see Section 6.34.3 [AVR Variable Attributes], page 630.
__seg_fs
__seg_gs The object is accessed with the respective segment override prefix.
The respective segment base must be set via some method specific to the op-
erating system. Rather than require an expensive system call to retrieve the
segment base, these address spaces are not considered to be subspaces of the
generic (flat) address space. This means that explicit casts are required to con-
vert pointers between these address spaces and the generic address space. In
practice the application should cast to uintptr_t and apply the segment base
offset that it installed previously.
The preprocessor symbols __SEG_FS and __SEG_GS are defined when these ad-
dress spaces are supported.
548 Using the GNU Compiler Collection (GCC)
struct f2 {
struct f1 f1; int data[3];
} f2 = { { 1 }, { 2, 3, 4 } };
The convenience of this extension is that f1 has the desired type, eliminating the need to
consistently refer to f2.f1.
This has symmetry with normal static arrays, in that an array of unknown size is also
written with [].
Of course, this extension only makes sense if the extra data comes at the end of a top-level
object, as otherwise we would be overwriting data at subsequent offsets. To avoid undue
complication and confusion with initialization of deeply nested arrays, we simply disallow
any non-empty initialization except when the structure is the top-level object. For example:
struct foo { int x; int y[]; };
struct bar { struct foo z; };
GNU CPP has two further variadic macro extensions, and permits them to be used with
either of the above forms of macro definition.
In standard C, you are not allowed to leave the variable argument out entirely; but you
are allowed to pass an empty argument. For example, this invocation is invalid in ISO C,
because there is no comma after the string:
debug ("A message")
GNU CPP permits you to completely omit the variable arguments in this way. In the
above examples, the compiler would complain, though since the expansion of the macro still
has the extra comma after the format string.
To help solve this problem, CPP behaves specially for variable arguments used with the
token paste operator, ‘##’. If instead you write
#define debug(format, ...) fprintf (stderr, format, ## __VA_ARGS__)
and if the variable arguments are omitted or empty, the ‘##’ operator causes the preprocessor
to remove the comma before it. If you do provide some variable arguments in your macro
invocation, GNU CPP does not complain about the paste operation and instead places the
variable arguments after the comma. Just like any other pasted macro argument, these
arguments are not macro expanded.
A consequence of this is that sizeof is also allowed on void and on function types, and
returns 1.
The option ‘-Wpointer-arith’ requests a warning if these extensions are used.
In ISO C99 you can give the elements in any order, specifying the array indices or structure
field names they apply to, and GNU C allows this as an extension in C90 mode as well.
This extension is not implemented in GNU C++.
To specify an array index, write ‘[index] =’ before the element value. For example,
int a[6] = { [4] = 29, [2] = 15 };
is equivalent to
int a[6] = { 0, 0, 15, 0, 29, 0 };
The index values must be constant expressions, even if the array being initialized is auto-
matic.
An alternative syntax for this that has been obsolete since GCC 2.5 but GCC still accepts
is to write ‘[index]’ before the element value, with no ‘=’.
To initialize a range of elements to the same value, write ‘[first ... last] = value’.
This is a GNU extension. For example,
int widths[] = { [0 ... 9] = 1, [10 ... 99] = 2, [100] = 3 };
If the value in it has side effects, the side effects happen only once, not for each initialized
field by the range initializer.
Note that the length of the array is the highest value specified plus one.
In a structure initializer, specify the name of a field to initialize with ‘.fieldname =’
before the element value. For example, given the following structure,
struct point { int x, y; };
the following initialization
struct point p = { .y = yvalue, .x = xvalue };
is equivalent to
struct point p = { xvalue, yvalue };
Another syntax that has the same meaning, obsolete since GCC 2.5, is ‘fieldname:’, as
shown here:
struct point p = { y: yvalue, x: xvalue };
Omitted fields are implicitly initialized the same as for objects that have static storage
duration.
The ‘[index]’ or ‘.fieldname’ is known as a designator. You can also use a designator
(or the obsolete colon syntax) when initializing a union, to specify which element of the
union should be used. For example,
union foo { int i; double d; };
union foo f = { .d = 4 };
converts 4 to a double to store it in the union using the second element. By contrast,
casting 4 to type union foo stores it into the union as the integer i, since it is an integer.
See Section 6.31 [Cast to Union], page 555.
You can combine this technique of naming elements with ordinary C initialization of
successive elements. Each initializer element that does not have a designator applies to the
next consecutive element of the array or structure. For example,
int a[6] = { [1] = v1, v2, [4] = v4 };
is equivalent to
Chapter 6: Extensions to the C Language Family 555
z = (union foo) x;
z = (union foo) y;
are shorthand equivalents of these
z = (union foo) { .i = x };
z = (union foo) { .d = y };
However, (union foo) FLT_MAX; is not a valid cast because the union has no member of
type float.
Using the cast as the right-hand side of an assignment to a variable of union type is
equivalent to storing in a member of the union with the same type
union foo u;
/* . . . */
u = (union foo) x ≡ u.i = x
u = (union foo) y ≡ u.d = y
You can also use the union cast as a function argument:
void hack (union foo);
/* . . . */
hack ((union foo) x);
See Section 6.39 [Attribute Syntax], page 648, for the exact rules on attribute syntax and
placement. Compatible attribute specifications on distinct declarations of the same function
are merged. An attribute specification that is not compatible with attributes already applied
to a declaration of the same function is ignored with a warning.
Some function attributes take one or more arguments that refer to the function’s param-
eters by their positions within the function parameter list. Such attribute arguments are
referred to as positional arguments. Unless specified otherwise, positional arguments that
specify properties of parameters with pointer types can also specify the same properties
of the implicit C++ this argument in non-static member functions, and of parameters of
reference to a pointer type. For ordinary functions, position one refers to the first parameter
on the list. In C++ non-static member functions, position one refers to the implicit this
pointer. The same restrictions and effects apply to function attributes used with ordinary
functions or C++ member functions.
GCC also supports attributes on variable declarations (see Section 6.34 [Variable At-
tributes], page 622), labels (see Section 6.36 [Label Attributes], page 646), enumerators (see
Section 6.37 [Enumerator Attributes], page 647), statements (see Section 6.38 [Statement
Attributes], page 647), types (see Section 6.35 [Type Attributes], page 636), and on field
declarations (for tainted_args).
There is some overlap between the purposes of attributes and pragmas (see Section 6.62
[Pragmas Accepted by GCC], page 873). It has been found convenient to use __attribute_
_ to achieve a natural attachment of attributes to their corresponding declarations, whereas
#pragma is of use for compatibility with other compilers or constructs that do not naturally
form part of the grammar.
In addition to the attributes documented here, GCC plugins may provide their own
attributes.
The read_write access mode applies to arguments of pointer types without the
const qualifier. It specifies that the pointer to which it applies is used to both
read and write the referenced object. Unless the argument specifying the size
of the access denoted by size-index is zero, the object referenced by the pointer
must be initialized. An example of the use of the read_write access mode is
the first argument to the strcat function.
__attribute__ ((access (read_write, 1), access (read_only, 2))) char* strcat (char*, const ch
The access mode none specifies that the pointer to which it applies is not used
to access the referenced object at all. Unless the pointer is null the pointed-
to object must exist and have at least the size as denoted by the size-index
argument. When the optional size-index argument is omitted for an argument
of void* type the actual pointer agument is ignored. The referenced object
need not be initialized. The mode is intended to be used as a means to help
validate the expected object size, for example in functions that call __builtin_
object_size. See Section 6.58 [Object Size Checking], page 726.
Note that the access attribute merely specifies how an object referenced by
the pointer argument can be accessed; it does not imply that an access will
happen. Also, the access attribute does not imply the attribute nonnull; it
may be appropriate to add both attributes at the declaration of a function that
unconditionally manipulates a buffer via a pointer argument. See the nonnull
attribute for more information and caveats.
Chapter 6: Extensions to the C Language Family 559
alias ("target")
The alias attribute causes the declaration to be emitted as an alias for another
symbol, which must have been previously declared with the same type, and for
variables, also the same size and alignment. Declaring an alias with a different
type than the target is undefined and may be diagnosed. As an example, the
following declarations:
void __f () { /* Do something. */; }
void f () __attribute__ ((weak, alias ("__f")));
define ‘f’ to be a weak alias for ‘__f’. In C++, the mangled name for the target
must be used. It is an error if ‘__f’ is not defined in the same translation unit.
This attribute requires assembler and object file support, and may not be avail-
able on all targets.
aligned
aligned (alignment)
The aligned attribute specifies a minimum alignment for the first instruction
of the function, measured in bytes. When specified, alignment must be an
integer constant power of 2. Specifying no alignment argument implies the ideal
alignment for the target. The __alignof__ operator can be used to determine
what that is (see Section 6.44 [Alignment], page 652). The attribute has no
effect when a definition for the function is not provided in the same translation
unit.
The attribute cannot be used to decrease the alignment of a function previously
declared with a more restrictive alignment; only to increase it. Attempts to do
otherwise are diagnosed. Some targets specify a minimum default alignment for
functions that is greater than 1. On such targets, specifying a less restrictive
alignment is silently ignored. Using the attribute overrides the effect of the
‘-falign-functions’ (see Section 3.11 [Optimize Options], page 163) option
for this function.
Note that the effectiveness of aligned attributes may be limited by inherent
limitations in the system linker and/or object file format. On some systems, the
linker is only able to arrange for functions to be aligned up to a certain maximum
alignment. (For some linkers, the maximum supported alignment may be very
very small.) See your linker documentation for further information.
The aligned attribute can also be used for variables and fields (see Section 6.34
[Variable Attributes], page 622.)
alloc_align (position)
The alloc_align attribute may be applied to a function that returns a pointer
and takes at least one argument of an integer or enumerated type. It indicates
that the returned pointer is aligned on a boundary given by the function ar-
gument at position. Meaningful alignments are powers of 2 greater than one.
GCC uses this information to improve pointer alignment analysis.
The function parameter denoting the allocated alignment is specified by one
constant integer argument whose number is the argument of the attribute. Ar-
gument numbering starts at one.
For instance,
560 Using the GNU Compiler Collection (GCC)
declares that my_alloc1 returns 16-byte aligned pointers and that my_alloc2
returns a pointer whose value modulo 32 is equal to 8.
cold The cold attribute on functions is used to inform the compiler that the function
is unlikely to be executed. The function is optimized for size rather than speed
and on many targets it is placed into a special subsection of the text section
so all cold functions appear close together, improving code locality of non-cold
parts of program. The paths leading to calls of cold functions within code are
marked as unlikely by the branch prediction mechanism. It is thus useful to
mark functions used to handle unlikely conditions, such as perror, as cold to
improve optimization of hot functions that do call marked functions in rare
occasions.
When profile feedback is available, via ‘-fprofile-use’, cold functions are
automatically detected and this attribute is ignored.
const Calls to functions whose return value is not affected by changes to the observable
state of the program and that have no observable effects on such state other
than to return a value may lend themselves to optimizations such as common
subexpression elimination. Declaring such functions with the const attribute
allows GCC to avoid emitting some calls in repeated invocations of the function
with the same argument values.
For example,
int square (int) __attribute__ ((const));
tells GCC that subsequent calls to function square with the same argument
value can be replaced by the result of the first call regardless of the statements
in between.
The const attribute prohibits a function from reading objects that affect its
return value between successive invocations. However, functions declared with
the attribute can safely read objects that do not change their return value, such
as non-volatile constants.
The const attribute imposes greater restrictions on a function’s definition than
the similar pure attribute. Declaring the same function with both the const
and the pure attribute is diagnosed. Because a const function cannot have any
observable side effects it does not make sense for it to return void. Declaring
such a function is diagnosed.
Note that a function that has pointer arguments and examines the data pointed
to must not be declared const if the pointed-to data might change between
successive invocations of the function. In general, since a function cannot dis-
tinguish data that might change from data that cannot, const functions should
never take pointer or, in C++, reference arguments. Likewise, a function that
calls a non-const function usually must not be const itself.
constructor
destructor
constructor (priority)
destructor (priority)
The constructor attribute causes the function to be called automatically be-
fore execution enters main (). Similarly, the destructor attribute causes the
562 Using the GNU Compiler Collection (GCC)
copy
copy (function)
The copy attribute applies the set of attributes with which function has been
declared to the declaration of the function to which the attribute is applied. The
attribute is designed for libraries that define aliases or function resolvers that
are expected to specify the same set of attributes as their targets. The copy
attribute can be used with functions, variables, or types. However, the kind of
symbol to which the attribute is applied (either function or variable) must match
the kind of symbol to which the argument refers. The copy attribute copies
only syntactic and semantic attributes but not attributes that affect a symbol’s
linkage or visibility such as alias, visibility, or weak. The deprecated
and target_clones attribute are also not copied. See Section 6.35.1 [Common
Type Attributes], page 637. See Section 6.34.1 [Common Variable Attributes],
page 622.
For example, the StrongAlias macro below makes use of the alias and copy
attributes to define an alias named alloc for function allocate declared with
attributes alloc size, malloc, and nothrow. Thanks to the __typeof__ operator
the alias has the same type as the target function. As a result of the copy
attribute the alias also shares the same attributes as the target.
#define StrongAlias(TargetFunc, AliasDecl) \
extern __typeof__ (TargetFunc) AliasDecl \
__attribute__ ((alias (#TargetFunc), copy (TargetFunc)));
deprecated
deprecated (msg)
The deprecated attribute results in a warning if the function is used anywhere
in the source file. This is useful when identifying functions that are expected
to be removed in a future version of a program. The warning also includes the
location of the declaration of the deprecated function, to enable users to easily
find further information about why the function is deprecated, or what they
should do instead. Note that the warnings only occurs for uses:
int old_fn () __attribute__ ((deprecated));
int old_fn ();
int (*fn_ptr)() = old_fn;
results in a warning on line 3 but not line 2. The optional msg argument, which
must be a string, is printed in the warning if present.
The deprecated attribute can also be used for variables and types (see
Section 6.34 [Variable Attributes], page 622, see Section 6.35 [Type Attributes],
page 636.)
The message attached to the attribute is affected by the setting of the
‘-fmessage-length’ option.
unavailable
unavailable (msg)
The unavailable attribute results in an error if the function is used anywhere
in the source file. This is useful when identifying functions that have been
removed from a particular variation of an interface. Other than emitting an
error rather than a warning, the unavailable attribute behaves in the same
manner as deprecated.
The unavailable attribute can also be used for variables and types (see
Section 6.34 [Variable Attributes], page 622, see Section 6.35 [Type Attributes],
page 636.)
error ("message")
warning ("message")
If the error or warning attribute is used on a function declaration and a call to
such a function is not eliminated through dead code elimination or other opti-
mizations, an error or warning (respectively) that includes message is diagnosed.
This is useful for compile-time checking, especially together with __builtin_
constant_p and inline functions where checking the inline function arguments
is not possible through extern char [(condition) ? 1 : -1]; tricks.
While it is possible to leave the function undefined and thus invoke a link failure
(to define the function with a message in .gnu.warning* section), when using
these attributes the problem is diagnosed earlier and with exact location of
the call even in presence of inline functions or when not emitting debugging
information.
externally_visible
This attribute, attached to a global variable or function, nullifies the effect
of the ‘-fwhole-program’ command-line option, so the object remains visible
outside the current compilation unit.
564 Using the GNU Compiler Collection (GCC)
to modify the header file ‘stdio.h’. In C99 mode, the functions snprintf,
vsnprintf, vscanf, vfscanf and vsscanf are also checked. Except in strictly
conforming C standard modes, the X/Open function strfmon is also checked
as are printf_unlocked and fprintf_unlocked. See Section 3.4 [Options
Controlling C Dialect], page 44.
For Objective-C dialects, NSString (or __NSString__) is recognized in the
same context. Declarations including these format attributes are parsed for
correct syntax, however the result of checking of such format strings is not yet
defined, and is not carried out by this version of the compiler.
The target may also provide additional types of format checks. See Section 6.61
[Format Checks Specific to Particular Target Machines], page 872.
format_arg (string-index)
The format_arg attribute specifies that a function takes one or more format
strings for a printf, scanf, strftime or strfmon style function and modifies it
(for example, to translate it into another language), so the result can be passed
to a printf, scanf, strftime or strfmon style function (with the remaining
arguments to the format function the same as they would have been for the
unmodified string). Multiple format_arg attributes may be applied to the
same function, each designating a distinct parameter as a format string. For
example, the declaration:
extern char *
my_dgettext (char *my_domain, const char *my_format)
__attribute__ ((format_arg (2)));
causes the compiler to check the arguments in calls to a printf, scanf,
strftime or strfmon type function, whose format string argument is a
call to the my_dgettext function, for consistency with the format string
argument my_format. If the format_arg attribute had not been specified, all
the compiler could tell in such calls to format functions would be that the
format string argument is not constant; this would generate a warning when
‘-Wformat-nonliteral’ is used, but the calls could not be checked without
the attribute.
In calls to a function declared with more than one format_arg attribute, each
with a distinct argument value, the corresponding actual function arguments are
checked against all format strings designated by the attributes. This capability
is designed to support the GNU ngettext family of functions.
The parameter string-index specifies which argument is the format string argu-
ment (starting from one). Since non-static C++ methods have an implicit this
argument, the arguments of such methods should be counted from two.
The format_arg attribute allows you to identify your own functions that modify
format strings, so that GCC can check the calls to printf, scanf, strftime or
strfmon type function whose operands are a call to one of your own function.
The compiler always treats gettext, dgettext, and dcgettext in this manner
except when strict ISO C support is requested by ‘-ansi’ or an appropriate
‘-std’ option, or ‘-ffreestanding’ or ‘-fno-builtin’ is used. See Section 3.4
[Options Controlling C Dialect], page 44.
566 Using the GNU Compiler Collection (GCC)
S::Func* S::resolver ()
{
int (S::*pimpl) (int)
= getenv ("DEBUG") ? &S::debug_impl : &S::optimized_impl;
Independently, the form of the attribute with one or two arguments associates
deallocator as a suitable deallocation function for pointers returned from the
malloc-like function. ptr-index denotes the positional argument to which when
the pointer is passed in calls to deallocator has the effect of deallocating it.
Using the attribute with no arguments is designed to improve optimization by
relying on the aliasing property it implies. Functions like malloc and calloc
have this property because they return a pointer to uninitialized or zeroed-
out, newly obtained storage. However, functions like realloc do not have this
property, as they may return pointers to storage containing pointers to existing
objects. Additionally, since all such functions are assumed to return null only
infrequently, callers can be optimized based on that assumption.
Associating a function with a deallocator helps detect calls to mismatched al-
location and deallocation functions and diagnose them under the control of
options such as ‘-Wmismatched-dealloc’. It also makes it possible to diag-
nose attempts to deallocate objects that were not allocated dynamically, by
‘-Wfree-nonheap-object’. To indicate that an allocation function both satisi-
fies the nonaliasing property and has a deallocator associated with it, both the
plain form of the attribute and the one with the deallocator argument must be
used. The same function can be both an allocator and a deallocator. Since in-
lining one of the associated functions but not the other could result in apparent
mismatches, this form of attribute malloc is not accepted on inline functions.
For the same reason, using the attribute prevents both the allocation and deal-
location functions from being expanded inline.
For example, besides stating that the functions return pointers that do not
alias any others, the following declarations make fclose a suitable deallocator
for pointers returned from all functions except popen, and pclose as the only
suitable deallocator for pointers returned from popen. The deallocator functions
must be declared before they can be referenced in the attribute.
int fclose (FILE*);
int pclose (FILE*);
no_sanitize_address
no_address_safety_analysis
The no_sanitize_address attribute on functions is used to inform the com-
piler that it should not instrument memory accesses in the function when
compiling with the ‘-fsanitize=address’ option. The no_address_safety_
analysis is a deprecated alias of the no_sanitize_address attribute, new
code should use no_sanitize_address.
no_sanitize_thread
The no_sanitize_thread attribute on functions is used to inform the compiler
that it should not instrument memory accesses in the function when compiling
with the ‘-fsanitize=thread’ option.
no_sanitize_undefined
The no_sanitize_undefined attribute on functions is used to inform the com-
piler that it should not check for undefined behavior in the function when com-
piling with the ‘-fsanitize=undefined’ option.
no_sanitize_coverage
The no_sanitize_coverage attribute on functions is used to inform the
compiler that it should not do coverage-guided fuzzing code instrumentation
(‘-fsanitize-coverage’).
no_split_stack
If ‘-fsplit-stack’ is given, functions have a small prologue which decides
whether to split the stack. Functions with the no_split_stack attribute do
not have that prologue, and thus may run with only a small amount of stack
space available.
no_stack_limit
This attribute locally overrides the ‘-fstack-limit-register’ and
‘-fstack-limit-symbol’ command-line options; it has the effect of disabling
stack limit checking in the function it applies to.
noclone This function attribute prevents a function from being considered for cloning—a
mechanism that produces specialized copies of functions and which is (currently)
performed by interprocedural constant propagation.
noinline This function attribute prevents a function from being considered for inlining.
If the function does not have side effects, there are optimizations other than
inlining that cause function calls to be optimized away, although the function
call is live. To keep such calls from being optimized away, put
asm ("");
(see Section 6.47.2 [Extended Asm], page 657) in the called function, to serve
as a special side effect.
noipa Disable interprocedural optimizations between the function with this attribute
and its callers, as if the body of the function is not available when optimizing
572 Using the GNU Compiler Collection (GCC)
callers and the callers are unavailable when optimizing the body. This attribute
implies noinline, noclone and no_icf attributes. However, this attribute is
not equivalent to a combination of other attributes, because its purpose is to
suppress existing and future optimizations employing interprocedural analysis,
including those that do not have an attribute suitable for disabling them in-
dividually. This attribute is supported mainly for the purpose of testing the
compiler.
nonnull
nonnull (arg-index, ...)
The nonnull attribute may be applied to a function that takes at least one
argument of a pointer type. It indicates that the referenced arguments must be
non-null pointers. For instance, the declaration:
extern void *
my_memcpy (void *dest, const void *src, size_t len)
__attribute__((nonnull (1, 2)));
informs the compiler that, in calls to my_memcpy, arguments dest and src must
be non-null.
The attribute has an effect both on functions calls and function definitions.
For function calls:
• If the compiler determines that a null pointer is passed in an argument slot
marked as non-null, and the ‘-Wnonnull’ option is enabled, a warning is
issued. See Section 3.8 [Warning Options], page 90.
• The ‘-fisolate-erroneous-paths-attribute’ option can be specified to
have GCC transform calls with null arguments to non-null functions into
traps. See Section 3.11 [Optimize Options], page 163.
• The compiler may also perform optimizations based on the knowledge
that certain function arguments cannot be null. These optimizations can
be disabled by the ‘-fno-delete-null-pointer-checks’ option. See
Section 3.11 [Optimize Options], page 163.
For function definitions:
• If the compiler determines that a function parameter that is marked with
nonnull is compared with null, and ‘-Wnonnull-compare’ option is enabled,
a warning is issued. See Section 3.8 [Warning Options], page 90.
• The compiler may also perform optimizations based on the knowledge that
nonnul parameters cannot be null. This can currently not be disabled
other than by removing the nonnull attribute.
If no arg-index is given to the nonnull attribute, all pointer arguments are
marked as non-null. To illustrate, the following declaration is equivalent to the
previous example:
extern void *
my_memcpy (void *dest, const void *src, size_t len)
__attribute__((nonnull));
noplt The noplt attribute is the counterpart to option ‘-fno-plt’. Calls to functions
marked with this attribute in position-independent code do not use the PLT.
Chapter 6: Extensions to the C Language Family 573
int
main (/* . . . */)
{
/* . . . */
foo ();
/* . . . */
}
The noplt attribute on function foo tells the compiler to assume that the
function foo is externally defined and that the call to foo must avoid the PLT
in position-independent code.
In position-dependent code, a few targets also convert calls to functions that
are marked to not use the PLT to use the GOT instead.
noreturn A few standard library functions, such as abort and exit, cannot return. GCC
knows this automatically. Some programs define their own functions that never
return. You can declare them noreturn to tell the compiler this fact. For
example,
void fatal () __attribute__ ((noreturn));
void
fatal (/* . . . */)
{
/* . . . */ /* Print error message. */ /* . . . */
exit (1);
}
The noreturn keyword tells the compiler to assume that fatal cannot return.
It can then optimize without regard to what would happen if fatal ever did
return. This makes slightly better code. More importantly, it helps avoid
spurious warnings of uninitialized variables.
The noreturn keyword does not affect the exceptional path when that applies:
a noreturn-marked function may still return to the caller by throwing an ex-
ception or calling longjmp.
In order to preserve backtraces, GCC will never turn calls to noreturn functions
into tail calls.
Do not assume that registers saved by the calling function are restored before
calling the noreturn function.
It does not make sense for a noreturn function to have a return type other
than void.
nothrow The nothrow attribute is used to inform the compiler that a function cannot
throw an exception. For example, most functions in the standard C library can
be guaranteed not to throw an exception with the notable exceptions of qsort
and bsearch that take function pointer arguments.
optimize (level, ...)
optimize (string, ...)
The optimize attribute is used to specify that a function is to be compiled
with different optimization options than specified on the command line. The
574 Using the GNU Compiler Collection (GCC)
tells GCC that subsequent calls to the function hash with the same string can
be replaced by the result of the first call provided the state of the program
observable by hash, including the contents of the array itself, does not change
in between. Even though hash takes a non-const pointer argument it must
not modify the array it points to, or any other object whose value the rest
of the program may depend on. However, the caller may safely change the
contents of the array between successive calls to the function (doing so disables
the optimization). The restriction also applies to member objects referenced by
the this pointer in C++ non-static member functions.
Some common examples of pure functions are strlen or memcmp. Interest-
ing non-pure functions are functions with infinite loops or those depending on
volatile memory or other system resource, that may change between consecutive
calls (such as the standard C feof function in a multithreading environment).
The pure attribute imposes similar but looser restrictions on a function’s defini-
tion than the const attribute: pure allows the function to read any non-volatile
memory, even if it changes in between successive invocations of the function.
Declaring the same function with both the pure and the const attribute is
diagnosed. Because a pure function cannot have any observable side effects
it does not make sense for such a function to return void. Declaring such a
function is diagnosed.
returns_nonnull
The returns_nonnull attribute specifies that the function return value should
be a non-null pointer. For instance, the declaration:
extern void *
mymalloc (size_t len) __attribute__((returns_nonnull));
lets the compiler optimize callers based on the knowledge that the return value
will never be null.
returns_twice
The returns_twice attribute tells the compiler that a function may return
more than one time. The compiler ensures that all registers are dead before
calling such a function and emits a warning about the variables that may be
clobbered after the second return from the function. Examples of such functions
are setjmp and vfork. The longjmp-like counterpart of such function, if any,
might need to be marked with the noreturn attribute.
section ("section-name")
Normally, the compiler places the code it generates in the text section. Some-
times, however, you need additional sections, or you need certain particular
functions to appear in special sections. The section attribute specifies that a
function lives in a particular section. For example, the declaration:
extern void foobar (void) __attribute__ ((section ("bar")));
puts the function foobar in the bar section.
Some file formats do not support arbitrary sections so the section attribute
is not available on all platforms. If you need to map the entire contents of a
module to a particular section, consider using the facilities of the linker instead.
576 Using the GNU Compiler Collection (GCC)
sentinel
sentinel (position)
This function attribute indicates that an argument in a call to the function
is expected to be an explicit NULL. The attribute is only valid on variadic
functions. By default, the sentinel is expected to be the last argument of the
function call. If the optional position argument is specified to the attribute, the
sentinel must be located at position counting backwards from the end of the
argument list.
__attribute__ ((sentinel))
is equivalent to
__attribute__ ((sentinel(0)))
The attribute is automatically set with a position of 0 for the built-in functions
execl and execlp. The built-in function execle has the attribute set with a
position of 1.
A valid NULL in this context is defined as zero with any object pointer type.
If your system defines the NULL macro with an integer type then you need to
add an explicit cast. During installation GCC replaces the system <stddef.h>
header with a copy that redefines NULL appropriately.
The warnings for missing or incorrect sentinels are enabled with ‘-Wformat’.
simd
simd("mask")
This attribute enables creation of one or more function versions that can process
multiple arguments using SIMD instructions from a single invocation. Speci-
fying this attribute allows compiler to assume that such versions are available
at link time (provided in the same or another translation unit). Generated
versions are target-dependent and described in the corresponding Vector ABI
document. For x86 64 target this document can be found here.
The optional argument mask may have the value notinbranch or inbranch,
and instructs the compiler to generate non-masked or masked clones corre-
spondingly. By default, all clones are generated.
If the attribute is specified and #pragma omp declare simd is present on a
declaration and the ‘-fopenmp’ or ‘-fopenmp-simd’ switch is specified, then
the attribute is ignored.
stack_protect
This attribute adds stack protection code to the function if
flags ‘-fstack-protector’, ‘-fstack-protector-strong’ or
‘-fstack-protector-explicit’ are set.
no_stack_protector
This attribute prevents stack protection code for the function.
target (string, ...)
Multiple target back ends implement the target attribute to specify that a
function is to be compiled with different target options than specified on the
command line. The original target command-line options are ignored. One
or more strings can be provided as arguments. Each string consists of one or
Chapter 6: Extensions to the C Language Family 577
If you have an older release of binutils, then symbol alias needs to be used:
__attribute__ ((__symver__ ("foo@VERS_2")))
int foo_v1 (void)
{
return 0;
}
unused This attribute, attached to a function, means that the function is meant to be
possibly unused. GCC does not produce a warning for this function.
used This attribute, attached to a function, means that code must be emitted for the
function even if it appears that the function is not referenced. This is useful,
for example, when the function is referenced only in inline assembly.
When applied to a member function of a C++ class template, the attribute also
means that the function is instantiated if the class itself is instantiated.
retain For ELF targets that support the GNU or FreeBSD OSABIs, this attribute
will save the function from linker garbage collection. To support this behavior,
functions that have not been placed in specific sections (e.g. by the section
attribute, or the -ffunction-sections option), will be placed in new, unique
sections.
This additional functionality requires Binutils version 2.36 or later.
visibility ("visibility_type")
This attribute affects the linkage of the declaration to which it is attached. It
can be applied to variables (see Section 6.34.1 [Common Variable Attributes],
page 622) and types (see Section 6.35.1 [Common Type Attributes], page 637)
as well as functions.
There are four supported visibility type values: default, hidden, protected or
internal visibility.
void __attribute__ ((visibility ("protected")))
f () { /* Do something. */; }
int i __attribute__ ((visibility ("hidden")));
The possible values of visibility type correspond to the visibility settings in the
ELF gABI.
default Default visibility is the normal case for the object file format. This
value is available for the visibility attribute to override other options
that may change the assumed visibility of entities.
On ELF, default visibility means that the declaration is visible to
other modules and, in shared libraries, means that the declared
entity may be overridden.
On Darwin, default visibility means that the declaration is visible
to other modules.
Default visibility corresponds to “external linkage” in the language.
hidden Hidden visibility indicates that the entity declared has a new form
of linkage, which we call “hidden linkage”. Two declarations of an
object with hidden linkage refer to the same object if they are in
the same shared object.
internal Internal visibility is like hidden visibility, but with additional pro-
cessor specific semantics. Unless otherwise specified by the psABI,
GCC defines internal visibility to mean that a function is never
called from another module. Compare this with hidden functions
which, while they cannot be referenced directly by other modules,
580 Using the GNU Compiler Collection (GCC)
weakref
weakref ("target")
The weakref attribute marks a declaration as a weak reference. Without ar-
guments, it should be accompanied by an alias attribute naming the target
symbol. Alternatively, target may be given as an argument to weakref itself,
naming the target definition of the alias. The target must have the same type
as the declaration. In addition, if it designates a variable it must also have the
same size and alignment as the declaration. In either form of the declaration
weakref implicitly marks the declared symbol as weak. Without a target given
as an argument to weakref or to alias, weakref is equivalent to weak (in that
case the declaration may be extern).
/* Given the declaration: */
extern int y (void);
/* the following... */
static int x (void) __attribute__ ((weakref ("y")));
/* is equivalent to... */
static int x (void) __attribute__ ((weakref, alias ("y")));
all-gpr-arg
zeros all call-used general purpose registers that pass arguments.
Of this list, ‘used-arg’, ‘used-gpr-arg’, ‘all-arg’, and ‘all-gpr-arg’ are
mainly used for ROP mitigation.
The default for the attribute is controlled by ‘-fzero-call-used-regs’.
tune= Specifies the core for which to tune the performance of this function. The behav-
ior and permissible arguments are the same as for the ‘-mtune=’ command-line
option.
cpu= Specifies the core for which to tune the performance of this function and also
whose architectural features to use. The behavior and valid arguments are the
same as for the ‘-mcpu=’ command-line option.
sign-return-address
Select the function scope on which return address signing will be applied. The
behavior and permissible arguments are the same as for the command-line op-
tion ‘-msign-return-address=’. The default value is none. This attribute is
deprecated. The branch-protection attribute should be used instead.
branch-protection
Select the function scope on which branch protection will be applied. The be-
havior and permissible arguments are the same as for the command-line option
‘-mbranch-protection=’. The default value is none.
outline-atomics
Enable or disable calls to out-of-line helpers to implement atomic
operations. This corresponds to the behavior of the command line options
‘-moutline-atomics’ and ‘-mno-outline-atomics’.
The above target attributes can be specified as follows:
__attribute__((target("attr-string")))
int
f (int a)
{
return a + 5;
}
where attr-string is one of the attribute strings specified above.
Additionally, the architectural extension string may be specified on its own. This can
be used to turn on and off particular architectural extensions without having to specify a
particular architecture version or core. Example:
__attribute__((target("+crc+nocrypto")))
int
foo (int a)
{
return a + 5;
}
In this example target("+crc+nocrypto") enables the crc extension and disables the
crypto extension for the function foo without modifying an existing ‘-march=’ or ‘-mcpu’
option.
Multiple target function attributes can be specified by separating them with a comma.
For example:
__attribute__((target("arch=armv8-a+crc+crypto,tune=cortex-a53")))
int
foo (int a)
{
return a + 5;
}
Chapter 6: Extensions to the C Language Family 585
is valid and compiles function foo for ARMv8-A with crc and crypto extensions and
tunes it for cortex-a53.
kernarg_segment_ptr
Set enable_sgpr_kernarg_segment_ptr flag. Always on (required
to locate the kernel arguments, "kernargs").
dispatch_id
Set enable_sgpr_dispatch_id flag.
flat_scratch_init
Set enable_sgpr_flat_scratch_init flag.
private_segment_size
Set enable_sgpr_private_segment_size flag.
grid_workgroup_count_X
Set enable_sgpr_grid_workgroup_count_x flag. Always on (re-
quired to use OpenACC/OpenMP).
grid_workgroup_count_Y
Set enable_sgpr_grid_workgroup_count_y flag.
grid_workgroup_count_Z
Set enable_sgpr_grid_workgroup_count_z flag.
workgroup_id_X
Set enable_sgpr_workgroup_id_x flag.
workgroup_id_Y
Set enable_sgpr_workgroup_id_y flag.
workgroup_id_Z
Set enable_sgpr_workgroup_id_z flag.
workgroup_info
Set enable_sgpr_workgroup_info flag.
private_segment_wave_offset
Set enable_sgpr_private_segment_wave_byte_offset flag. Al-
ways on (required to locate the stack).
work_item_id_X
Set enable_vgpr_workitem_id parameter. Always on (can’t be
disabled).
work_item_id_Y
Set enable_vgpr_workitem_id parameter. Always on (required to
enable vectorization.)
work_item_id_Z
Set enable_vgpr_workitem_id parameter. Always on (required to
use OpenACC/OpenMP).
interrupt
Use this attribute to indicate that the specified function is an interrupt handler.
The compiler generates function entry and exit sequences suitable for use in an
interrupt handler when this attribute is present.
On the ARC, you must specify the kind of interrupt to be handled in a param-
eter to the interrupt attribute like this:
void f () __attribute__ ((interrupt ("ilink1")));
Permissible values for this parameter are: ilink1 and ilink2 for ARCv1 ar-
chitecture, and ilink and firq for ARCv2 architecture.
long_call
medium_call
short_call
These attributes specify how a particular function is called. These attributes
override the ‘-mlong-calls’ and ‘-mmedium-calls’ (see Section 3.19.4 [ARC
Options], page 308) command-line switches and #pragma long_calls settings.
For ARC, a function marked with the long_call attribute is always called
using register-indirect jump-and-link instructions, thereby enabling the called
function to be placed anywhere within the 32-bit address space. A function
marked with the medium_call attribute will always be close enough to be called
with an unconditional branch-and-link instruction, which has a 25-bit offset
from the call site. A function marked with the short_call attribute will always
be close enough to be called with a conditional branch-and-link instruction,
which has a 21-bit offset from the call site.
jli_always
Forces a particular function to be called using jli instruction. The jli instruc-
tion makes use of a table stored into .jlitab section, which holds the location
of the functions which are addressed using this instruction.
jli_fixed
Identical like the above one, but the location of the function in the jli table is
known and given as an attribute parameter.
secure_call
This attribute allows one to mark secure-code functions that are callable from
normal mode. The location of the secure call function into the sjli table needs
to be passed as argument.
naked This attribute allows the compiler to construct the requisite function decla-
ration, while allowing the body of the function to be assembly code. The
specified function will not have prologue/epilogue sequences generated by the
compiler. Only basic asm statements can safely be included in naked functions
(see Section 6.47.1 [Basic Asm], page 656). While using extended asm or a mix-
ture of basic asm and C code may appear to work, they cannot be depended
upon to work reliably and are not supported.
general-regs-only
Indicates that no floating-point or Advanced SIMD registers should be used
when generating code for this function. If the function explicitly uses floating-
point code, then the compiler gives an error. This is the same behavior as that
of the command-line option ‘-mgeneral-regs-only’.
interrupt
Use this attribute to indicate that the specified function is an interrupt handler.
The compiler generates function entry and exit sequences suitable for use in an
interrupt handler when this attribute is present.
You can specify the kind of interrupt to be handled by adding an optional
parameter to the interrupt attribute like this:
void f () __attribute__ ((interrupt ("IRQ")));
Permissible values for this parameter are: IRQ, FIQ, SWI, ABORT and UNDEF.
On ARMv7-M the interrupt type is ignored, and the attribute means the func-
tion may be called with a word-aligned stack pointer.
isr Use this attribute on ARM to write Interrupt Service Routines. This is an alias
to the interrupt attribute above.
long_call
short_call
These attributes specify how a particular function is called. These attributes
override the ‘-mlong-calls’ (see Section 3.19.5 [ARM Options], page 318)
command-line switch and #pragma long_calls settings. For ARM, the long_
call attribute indicates that the function might be far away from the call site
and require a different (more expensive) calling sequence. The short_call at-
tribute always places the offset to the function from the call site into the ‘BL’
instruction directly.
naked This attribute allows the compiler to construct the requisite function decla-
ration, while allowing the body of the function to be assembly code. The
specified function will not have prologue/epilogue sequences generated by the
compiler. Only basic asm statements can safely be included in naked functions
(see Section 6.47.1 [Basic Asm], page 656). While using extended asm or a mix-
ture of basic asm and C code may appear to work, they cannot be depended
upon to work reliably and are not supported.
pcs
The pcs attribute can be used to control the calling convention used for a
function on ARM. The attribute takes an argument that specifies the calling
convention to use.
When compiling using the AAPCS ABI (or a variant of it) then valid values for
the argument are "aapcs" and "aapcs-vfp". In order to use a variant other
than "aapcs" then the compiler must be permitted to use the appropriate co-
processor registers (i.e., the VFP registers must be available in order to use
"aapcs-vfp"). For example,
/* Argument passed in r0, and result returned in r0+r1. */
double f2d (float) __attribute__((pcs("aapcs")));
Chapter 6: Extensions to the C Language Family 589
Variadic functions always use the "aapcs" calling convention and the compiler
rejects attempts to specify an alternative.
target (options)
As discussed in Section 6.33.1 [Common Function Attributes], page 557, this
attribute allows specification of target-specific compilation options.
On ARM, the following options are allowed:
‘thumb’ Force code generation in the Thumb (T16/T32) ISA, depending on
the architecture level.
‘arm’ Force code generation in the ARM (A32) ISA.
Functions from different modes can be inlined in the caller’s mode.
‘fpu=’ Specifies the fpu for which to tune the performance of this function.
The behavior and permissible arguments are the same as for the
‘-mfpu=’ command-line option.
‘arch=’ Specifies the architecture version and architectural extensions to
use for this function. The behavior and permissible arguments are
the same as for the ‘-march=’ command-line option.
The above target attributes can be specified as follows:
__attribute__((target("arch=armv8-a+crc")))
int
f (int a)
{
return a + 5;
}
Additionally, the architectural extension string may be specified on
its own. This can be used to turn on and off particular architec-
tural extensions without having to specify a particular architecture
version or core. Example:
__attribute__((target("+crc+nocrypto")))
int
foo (int a)
{
return a + 5;
}
In this example target("+crc+nocrypto") enables the crc exten-
sion and disables the crypto extension for the function foo without
modifying an existing ‘-march=’ or ‘-mcpu’ option.
attribute that does not insert a SEI instruction. If both signal and interrupt
are specified for the same function, signal is silently ignored.
naked This attribute allows the compiler to construct the requisite function decla-
ration, while allowing the body of the function to be assembly code. The
specified function will not have prologue/epilogue sequences generated by the
compiler. Only basic asm statements can safely be included in naked functions
(see Section 6.47.1 [Basic Asm], page 656). While using extended asm or a mix-
ture of basic asm and C code may appear to work, they cannot be depended
upon to work reliably and are not supported.
no_gccisr
Do not use __gcc_isr pseudo instructions in a function with the interrupt or
signal attribute aka. interrupt service routine (ISR). Use this attribute if the
preamble of the ISR prologue should always read
push __zero_reg__
push __tmp_reg__
in __tmp_reg__, __SREG__
push __tmp_reg__
clr __zero_reg__
and accordingly for the postamble of the epilogue — no matter whether the
mentioned registers are actually used in the ISR or not. Situations where you
might want to use this attribute include:
• Code that (effectively) clobbers bits of SREG other than the I-flag by writing
to the memory location of SREG.
• Code that uses inline assembler to jump to a different function which ex-
pects (parts of) the prologue code as outlined above to be present.
To disable __gcc_isr generation for the whole compilation unit, there is option
‘-mno-gas-isr-prologues’, see Section 3.19.6 [AVR Options], page 334.
OS_main
OS_task On AVR, functions with the OS_main or OS_task attribute do not save/restore
any call-saved register in their prologue/epilogue.
The OS_main attribute can be used when there is guarantee that interrupts are
disabled at the time when the function is entered. This saves resources when
the stack pointer has to be changed to set up a frame for local variables.
The OS_task attribute can be used when there is no guarantee that interrupts
are disabled at that time when the function is entered like for, e.g. task functions
in a multi-threading operating system. In that case, changing the stack pointer
register is guarded by save/clear/restore of the global interrupt enable flag.
The differences to the naked function attribute are:
• naked functions do not have a return instruction whereas OS_main and
OS_task functions have a RET or RETI return instruction.
• naked functions do not set up a frame for local variables or a frame pointer
whereas OS_main and OS_task do this as needed.
Chapter 6: Extensions to the C Language Family 591
signal Use this attribute on the AVR to indicate that the specified function is an
interrupt handler. The compiler generates function entry and exit sequences
suitable for use in an interrupt handler when this attribute is present.
See also the interrupt function attribute.
The AVR hardware globally disables interrupts when an interrupt is executed.
Interrupt handler functions defined with the signal attribute do not re-enable
interrupts. It is save to enable interrupts in a signal handler. This “save” only
applies to the code generated by the compiler and not to the IRQ layout of the
application which is responsibility of the application.
If both signal and interrupt are specified for the same function, signal is
silently ignored.
exception_handler
Use this attribute on the Blackfin to indicate that the specified function is an
exception handler. The compiler generates function entry and exit sequences
suitable for use in an exception handler when this attribute is present.
interrupt_handler
Use this attribute to indicate that the specified function is an interrupt handler.
The compiler generates function entry and exit sequences suitable for use in an
interrupt handler when this attribute is present.
kspisusp When used together with interrupt_handler, exception_handler or nmi_
handler, code is generated to load the stack pointer from the USP register in
the function prologue.
l1_text This attribute specifies a function to be placed into L1 Instruction SRAM.
The function is put into a specific section named .l1.text. With ‘-mfdpic’,
function calls with a such function as the callee or caller uses inlined PLT.
l2 This attribute specifies a function to be placed into L2 SRAM. The function
is put into a specific section named .l2.text. With ‘-mfdpic’, callers of such
functions use an inlined PLT.
longcall
shortcall
The longcall attribute indicates that the function might be far away from
the call site and require a different (more expensive) calling sequence. The
shortcall attribute indicates that the function is always close enough for the
shorter calling sequence to be used. These attributes override the ‘-mlongcall’
switch.
nesting Use this attribute together with interrupt_handler, exception_handler or
nmi_handler to indicate that the function entry code should enable nested
interrupts or exceptions.
592 Using the GNU Compiler Collection (GCC)
nmi_handler
Use this attribute on the Blackfin to indicate that the specified function is an
NMI handler. The compiler generates function entry and exit sequences suitable
for use in an NMI handler when this attribute is present.
saveall Use this attribute to indicate that all registers except the stack pointer should
be saved in the prologue regardless of whether they are used or not.
forwarder_section
This attribute modifies the behavior of an interrupt handler. The interrupt
handler may be in external memory which cannot be reached by a branch
instruction, so generate a local memory trampoline to transfer control. The
single parameter identifies the section where the trampoline is placed.
interrupt
Use this attribute to indicate that the specified function is an interrupt handler.
The compiler generates function entry and exit sequences suitable for use in an
interrupt handler when this attribute is present. It may also generate a special
section with code to initialize the interrupt vector table.
On Epiphany targets one or more optional parameters can be added like this:
void __attribute__ ((interrupt ("dma0, dma1"))) universal_dma_handler ();
Permissible values for these parameters are: reset, software_exception,
page_miss, timer0, timer1, message, dma0, dma1, wand and swi. Multiple
parameters indicate that multiple entries in the interrupt vector table should
be initialized for this function, i.e. for each parameter name, a jump to the
function is emitted in the section ivt entry name. The parameter(s) may be
omitted entirely, in which case no interrupt vector table entry is provided.
Note that interrupts are enabled inside the function unless the disinterrupt
attribute is also specified.
The following examples are all valid uses of these attributes on Epiphany tar-
gets:
void __attribute__ ((interrupt)) universal_handler ();
void __attribute__ ((interrupt ("dma1"))) dma1_handler ();
void __attribute__ ((interrupt ("dma0, dma1")))
universal_dma_handler ();
void __attribute__ ((interrupt ("timer0"), disinterrupt))
fast_timer_handler ();
void __attribute__ ((interrupt ("dma0, dma1"),
forwarder_section ("tramp")))
external_dma_handler ();
long_call
short_call
These attributes specify how a particular function is called. These attributes
override the ‘-mlong-calls’ (see Section 3.19.2 [Adapteva Epiphany Options],
page 305) command-line switch and #pragma long_calls settings.
function_vector
Use this attribute on the H8/300, H8/300H, and H8S to indicate that the spec-
ified function should be called through the function vector. Calling a function
through the function vector reduces code size; however, the function vector
has a limited size (maximum 128 entries on the H8/300 and 64 entries on the
H8/300H and H8S) and shares space with the interrupt vector.
594 Using the GNU Compiler Collection (GCC)
interrupt_handler
Use this attribute on the H8/300, H8/300H, and H8S to indicate that the
specified function is an interrupt handler. The compiler generates function
entry and exit sequences suitable for use in an interrupt handler when this
attribute is present.
saveall Use this attribute on the H8/300, H8/300H, and H8S to indicate that all reg-
isters except the stack pointer should be saved in the prologue regardless of
whether they are used or not.
routines should get mapped within the address range 0x0F0000 to 0x0FFFFF
(for M16C) and 0xFF0000 to 0xFFFFFF (for M32C).
In the following example 2 bytes are saved for each call to function foo.
void foo (void) __attribute__((function_vector(0x18)));
void foo (void)
{
}
If functions are defined in one file and are called in another file, then be sure
to write this declaration in both files.
This attribute is ignored for R8C target.
interrupt
Use this attribute to indicate that the specified function is an interrupt handler.
The compiler generates function entry and exit sequences suitable for use in an
interrupt handler when this attribute is present.
interrupt
Use this attribute to indicate that the specified function is an interrupt handler.
The compiler generates function entry and exit sequences suitable for use in an
interrupt handler when this attribute is present.
model (model-name)
On the M32R/D, use this attribute to set the addressability of an object, and of
the code generated for a function. The identifier model-name is one of small,
medium, or large, representing each of the code models.
Small model objects live in the lower 16MB of memory (so that their addresses
can be loaded with the ld24 instruction), and are callable with the bl instruc-
tion.
Medium model objects may live anywhere in the 32-bit address space (the
compiler generates seth/add3 instructions to load their addresses), and are
callable with the bl instruction.
Large model objects may live anywhere in the 32-bit address space (the com-
piler generates seth/add3 instructions to load their addresses), and may not
be reachable with the bl instruction (the compiler generates the much slower
seth/add3/jl instruction sequence).
interrupt
interrupt_handler
Use this attribute to indicate that the specified function is an interrupt handler.
The compiler generates function entry and exit sequences suitable for use in an
interrupt handler when this attribute is present. Either name may be used.
interrupt_thread
Use this attribute on fido, a subarchitecture of the m68k, to indicate that the
specified function is an interrupt handler that is designed to run as a thread.
The compiler omits generate prologue/epilogue sequences and replaces the re-
turn instruction with a sleep instruction. This attribute is available only on
fido.
save_volatiles
Use this attribute to indicate that the function is an interrupt handler. All
volatile registers (in addition to non-volatile registers) are saved in the function
prologue. If the function is a leaf function, only volatiles used by the function
are saved. A normal function return is generated instead of a return from
interrupt.
break_handler
Use this attribute to indicate that the specified function is a break handler.
The compiler generates function entry and exit sequences suitable for use in an
break handler when this attribute is present. The return from break_handler
is done through the rtbd instead of rtsd.
void f () __attribute__ ((break_handler));
interrupt_handler
fast_interrupt
These attributes indicate that the specified function is an interrupt handler.
Use the fast_interrupt attribute to indicate handlers used in low-latency
interrupt mode, and interrupt_handler for interrupts that do not use low-
latency handlers. In both cases, GCC emits appropriate prologue code and
generates a return from the handler using rtid instead of rtsd.
dllimport
On Microsoft Windows and Symbian OS targets, the dllimport attribute
causes the compiler to reference a function or variable via a global pointer
to a pointer that is set up by the DLL exporting the symbol. The attribute
implies extern. On Microsoft Windows targets, the pointer name is formed by
combining _imp__ and the function or variable name.
You can use __declspec(dllimport) as a synonym for __attribute__
((dllimport)) for compatibility with other compilers.
On systems that support the visibility attribute, this attribute also implies
“default” visibility. It is an error to explicitly specify any other visibility.
Currently, the attribute is ignored for inlined functions. If the attribute is ap-
plied to a symbol definition, an error is reported. If a symbol previously declared
dllimport is later defined, the attribute is ignored in subsequent references,
and a warning is emitted. The attribute is also overridden by a subsequent
declaration as dllexport.
When applied to C++ classes, the attribute marks non-inlined member functions
and static data members as imports. However, the attribute is ignored for
virtual methods to allow creation of vtables using thunks.
On the SH Symbian OS target the dllimport attribute also has another affect—
it can cause the vtable and run-time type information for a class to be exported.
This happens when the class has a dllimported constructor or a non-inline, non-
pure virtual function and, for either of those two conditions, the class also has
an inline constructor or destructor and has a key function that is defined in the
current translation unit.
For Microsoft Windows targets the use of the dllimport attribute on functions
is not necessary, but provides a small performance benefit by eliminating a
thunk in the DLL. The use of the dllimport attribute on imported variables
can be avoided by passing the ‘--enable-auto-import’ switch to the GNU
linker. As with functions, using the attribute for a variable eliminates a thunk
in the DLL.
One drawback to using this attribute is that a pointer to a variable marked
as dllimport cannot be used as a constant address. However, a pointer to a
function with the dllimport attribute can be used as a constant initializer;
in this case, the address of a stub function in the import lib is referenced.
On Microsoft Windows targets, the attribute can be disabled for functions by
setting the ‘-mnop-fun-dllimport’ flag.
controller (EIC) mode is in use, this can be explicitly set using eic. When
interrupts are non-masked then the requested Interrupt Priority Level
(IPL) is copied to the current IPL which has the effect of only enabling
higher priority interrupts. To use vectored interrupt mode use the argument
vector=[sw0|sw1|hw0|hw1|hw2|hw3|hw4|hw5], this will change the behavior
of the non-masked interrupt support and GCC will arrange to mask all
interrupts from sw0 up to and including the specified interrupt vector.
You can use the following attributes to modify the behavior of an interrupt
handler:
use_shadow_register_set
Assume that the handler uses a shadow register set, instead of the
main general-purpose registers. An optional argument intstack is
supported to indicate that the shadow register set contains a valid
stack pointer.
keep_interrupts_masked
Keep interrupts masked for the whole function. Without this at-
tribute, GCC tries to reenable interrupts for as much of the function
as it can.
use_debug_exception_return
Return using the deret instruction. Interrupt handlers that don’t
have this attribute return using eret instead.
You can use any combination of these attributes, as shown below:
void __attribute__ ((interrupt)) v0 ();
void __attribute__ ((interrupt, use_shadow_register_set)) v1 ();
void __attribute__ ((interrupt, keep_interrupts_masked)) v2 ();
void __attribute__ ((interrupt, use_debug_exception_return)) v3 ();
void __attribute__ ((interrupt, use_shadow_register_set,
keep_interrupts_masked)) v4 ();
void __attribute__ ((interrupt, use_shadow_register_set,
use_debug_exception_return)) v5 ();
void __attribute__ ((interrupt, keep_interrupts_masked,
use_debug_exception_return)) v6 ();
void __attribute__ ((interrupt, use_shadow_register_set,
keep_interrupts_masked,
use_debug_exception_return)) v7 ();
void __attribute__ ((interrupt("eic"))) v8 ();
void __attribute__ ((interrupt("vector=hw3"))) v9 ();
long_call
short_call
near
far These attributes specify how a particular function is called on MIPS. The
attributes override the ‘-mlong-calls’ (see Section 3.19.30 [MIPS Options],
page 388) command-line switch. The long_call and far attributes are syn-
onyms, and cause the compiler to always call the function by first loading
its address into a register, and then using the contents of that register. The
short_call and near attributes are synonyms, and have the opposite effect;
they specify that non-PIC calls should be made using the more efficient jal
instruction.
600 Using the GNU Compiler Collection (GCC)
mips16
nomips16
On MIPS targets, you can use the mips16 and nomips16 function attributes to
locally select or turn off MIPS16 code generation. A function with the mips16
attribute is emitted as MIPS16 code, while MIPS16 code generation is dis-
abled for functions with the nomips16 attribute. These attributes override the
‘-mips16’ and ‘-mno-mips16’ options on the command line (see Section 3.19.30
[MIPS Options], page 388).
When compiling files containing mixed MIPS16 and non-MIPS16 code, the pre-
processor symbol __mips16 reflects the setting on the command line, not that
within individual functions. Mixed MIPS16 and non-MIPS16 code may inter-
act badly with some GCC extensions such as __builtin_apply (see Section 6.6
[Constructing Calls], page 535).
micromips, MIPS
nomicromips, MIPS
On MIPS targets, you can use the micromips and nomicromips function at-
tributes to locally select or turn off microMIPS code generation. A function with
the micromips attribute is emitted as microMIPS code, while microMIPS code
generation is disabled for functions with the nomicromips attribute. These
attributes override the ‘-mmicromips’ and ‘-mno-micromips’ options on the
command line (see Section 3.19.30 [MIPS Options], page 388).
When compiling files containing mixed microMIPS and non-microMIPS code,
the preprocessor symbol __mips_micromips reflects the setting on the com-
mand line, not that within individual functions. Mixed microMIPS and non-
microMIPS code may interact badly with some GCC extensions such as __
builtin_apply (see Section 6.6 [Constructing Calls], page 535).
nocompression
On MIPS targets, you can use the nocompression function attribute to locally
turn off MIPS16 and microMIPS code generation. This attribute overrides the
‘-mips16’ and ‘-mmicromips’ options on the command line (see Section 3.19.30
[MIPS Options], page 388).
You can provide an argument to the interrupt attribute which specifies a name
or number. If the argument is a number it indicates the slot in the interrupt
vector table (0 - 31) to which this handler should be assigned. If the argument
is a name it is treated as a symbolic name for the vector slot. These names
should match up with appropriate entries in the linker script. By default the
names watchdog for vector 26, nmi for vector 30 and reset for vector 31 are
recognized.
naked This attribute allows the compiler to construct the requisite function decla-
ration, while allowing the body of the function to be assembly code. The
specified function will not have prologue/epilogue sequences generated by the
compiler. Only basic asm statements can safely be included in naked functions
(see Section 6.47.1 [Basic Asm], page 656). While using extended asm or a mix-
ture of basic asm and C code may appear to work, they cannot be depended
upon to work reliably and are not supported.
reentrant
Reentrant functions disable interrupts upon entry and enable them upon exit.
Reentrant functions cannot also have the naked or critical attributes. They
can have the interrupt attribute.
wakeup This attribute only applies to interrupt functions. It is silently ignored if ap-
plied to a non-interrupt function. A wakeup interrupt function will rouse the
processor from any low-power state that it might be in when the function exits.
lower
upper
either On the MSP430 target these attributes can be used to specify whether the
function or variable should be placed into low memory, high memory, or the
placement should be left to the linker to decide. The attributes are only signif-
icant if compiling for the MSP430X architecture in the large memory model.
The attributes work in conjunction with a linker script that has been augmented
to specify where to place sections with a .lower and a .upper prefix. So,
for example, as well as placing the .data section, the script also specifies the
placement of a .lower.data and a .upper.data section. The intention is that
lower sections are placed into a small but easier to access memory region and
the upper sections are placed into a larger, but slower to access, region.
The either attribute is special. It tells the linker to place the object into the
corresponding lower section if there is room for it. If there is insufficient room
then the object is placed into the corresponding upper section instead. Note
that the placement algorithm is not very sophisticated. It does not attempt to
find an optimal packing of the lower sections. It just makes one pass over the
objects and does the best that it can. Using the ‘-ffunction-sections’ and
‘-fdata-sections’ command-line options can help the packing, however, since
they produce smaller, easier to pack regions.
exception
Use this attribute on the NDS32 target to indicate that the specified function
is an exception handler. The compiler will generate corresponding sections for
use in an exception handler.
interrupt
On NDS32 target, this attribute indicates that the specified function is an
interrupt handler. The compiler generates corresponding sections for use in an
interrupt handler. You can use the following attributes to modify the behavior:
nested This interrupt service routine is interruptible.
not_nested
This interrupt service routine is not interruptible.
nested_ready
This interrupt service routine is interruptible after PSW.GIE (global
interrupt enable) is set. This allows interrupt service routine to
finish some short critical code before enabling interrupts.
save_all The system will help save all registers into stack before entering
interrupt handler.
partial_save
The system will help save caller registers into stack before entering
interrupt handler.
naked This attribute allows the compiler to construct the requisite function decla-
ration, while allowing the body of the function to be assembly code. The
specified function will not have prologue/epilogue sequences generated by the
compiler. Only basic asm statements can safely be included in naked functions
(see Section 6.47.1 [Basic Asm], page 656). While using extended asm or a mix-
ture of basic asm and C code may appear to work, they cannot be depended
upon to work reliably and are not supported.
reset Use this attribute on the NDS32 target to indicate that the specified function
is a reset handler. The compiler will generate corresponding sections for use in
a reset handler. You can use the following attributes to provide extra exception
handling:
nmi Provide a user-defined function to handle NMI exception.
warm Provide a user-defined function to handle warm reset exception.
‘custom-insn=N’
‘no-custom-insn’
Each ‘custom-insn=N’ attribute locally enables use of a custom
instruction with encoding N when generating code that uses
insn. Similarly, ‘no-custom-insn’ locally inhibits use of the
custom instruction insn. These target attributes correspond to
the ‘-mcustom-insn=N’ and ‘-mno-custom-insn’ command-line
options, and support the same set of insn keywords. See
Section 3.19.36 [Nios II Options], page 409, for more information.
‘custom-fpu-cfg=name’
This attribute corresponds to the ‘-mcustom-fpu-cfg=name’
command-line option, to select a predefined set of custom
instructions named name. See Section 3.19.36 [Nios II Options],
page 409, for more information.
kernel This attribute indicates that the corresponding function should be compiled
as a kernel function, which can be invoked from the host via the CUDA RT
library. By default functions are only callable only from other PTX functions.
Kernel functions must have void return type.
longcall
shortcall
The longcall attribute indicates that the function might be far away from
the call site and require a different (more expensive) calling sequence. The
shortcall attribute indicates that the function is always close enough for
the shorter calling sequence to be used. These attributes override both the
‘-mlongcall’ switch and the #pragma longcall setting.
See Section 3.19.45 [RS/6000 and PowerPC Options], page 424, for more infor-
mation on whether long calls are necessary.
target (options)
As discussed in Section 6.33.1 [Common Function Attributes], page 557, this
attribute allows specification of target-specific compilation options.
On the PowerPC, the following options are allowed:
‘altivec’
‘no-altivec’
Generate code that uses (does not use) AltiVec instructions.
In 32-bit code, you cannot enable AltiVec instructions unless
‘-mabi=altivec’ is used on the command line.
604 Using the GNU Compiler Collection (GCC)
‘cmpb’
‘no-cmpb’ Generate code that uses (does not use) the compare bytes instruc-
tion implemented on the POWER6 processor and other processors
that support the PowerPC V2.05 architecture.
‘dlmzb’
‘no-dlmzb’
Generate code that uses (does not use) the string-search ‘dlmzb’
instruction on the IBM 405, 440, 464 and 476 processors. This
instruction is generated by default when targeting those processors.
‘fprnd’
‘no-fprnd’
Generate code that uses (does not use) the FP round to integer
instructions implemented on the POWER5+ processor and other
processors that support the PowerPC V2.03 architecture.
‘hard-dfp’
‘no-hard-dfp’
Generate code that uses (does not use) the decimal floating-point
instructions implemented on some POWER processors.
‘isel’
‘no-isel’ Generate code that uses (does not use) ISEL instruction.
‘mfcrf’
‘no-mfcrf’
Generate code that uses (does not use) the move from condition
register field instruction implemented on the POWER4 processor
and other processors that support the PowerPC V2.01 architecture.
‘mulhw’
‘no-mulhw’
Generate code that uses (does not use) the half-word multiply and
multiply-accumulate instructions on the IBM 405, 440, 464 and
476 processors. These instructions are generated by default when
targeting those processors.
‘multiple’
‘no-multiple’
Generate code that uses (does not use) the load multiple word
instructions and the store multiple word instructions.
‘update’
‘no-update’
Generate code that uses (does not use) the load or store instruc-
tions that update the base register to the address of the calculated
memory location.
‘popcntb’
‘no-popcntb’
Generate code that uses (does not use) the popcount and double-
precision FP reciprocal estimate instruction implemented on the
Chapter 6: Extensions to the C Language Family 605
‘paired’
‘no-paired’
Generate code that uses (does not use) the generation of PAIRED
simd instructions.
‘longcall’
‘no-longcall’
Generate code that assumes (does not assume) that all calls are far
away so that a longer more expensive calling sequence is required.
‘cpu=CPU’ Specify the architecture to generate code for when compiling the
function. If you select the target("cpu=power7") attribute when
generating 32-bit code, VSX and AltiVec instructions are not gen-
erated unless you use the ‘-mabi=altivec’ option on the command
line.
‘tune=TUNE’
Specify the architecture to tune for when compiling the function.
If you do not specify the target("tune=TUNE") attribute and you
do specify the target("cpu=CPU") attribute, compilation tunes for
the CPU architecture, and not the default tuning specified on the
command line.
On the PowerPC, the inliner does not inline a function that has different target
options than the caller, unless the callee has a subset of the target options of
the caller.
interrupt
brk_interrupt
These attributes indicate that the specified function is an interrupt handler.
The compiler generates function entry and exit sequences suitable for use in an
interrupt handler when this attribute is present.
Use brk_interrupt instead of interrupt for handlers intended to be used with
the BRK opcode (i.e. those that must end with RETB instead of RETI).
naked This attribute allows the compiler to construct the requisite function decla-
ration, while allowing the body of the function to be assembly code. The
specified function will not have prologue/epilogue sequences generated by the
compiler. Only basic asm statements can safely be included in naked functions
(see Section 6.47.1 [Basic Asm], page 656). While using extended asm or a mix-
ture of basic asm and C code may appear to work, they cannot be depended
upon to work reliably and are not supported.
naked This attribute allows the compiler to construct the requisite function decla-
ration, while allowing the body of the function to be assembly code. The
specified function will not have prologue/epilogue sequences generated by the
compiler. Only basic asm statements can safely be included in naked functions
(see Section 6.47.1 [Basic Asm], page 656). While using extended asm or a mix-
ture of basic asm and C code may appear to work, they cannot be depended
upon to work reliably and are not supported.
608 Using the GNU Compiler Collection (GCC)
vector This RX attribute is similar to the interrupt attribute, including its parame-
ters, but does not make the function an interrupt-handler type function (i.e. it
retains the normal C function calling ABI). See the interrupt attribute for a
description of its arguments.
hotpatch (halfwords-before-function-label,halfwords-after-function-label)
On S/390 System z targets, you can use this function attribute to make GCC
generate a “hot-patching” function prologue. If the ‘-mhotpatch=’ command-
line option is used at the same time, the hotpatch attribute takes precedence.
The first of the two arguments specifies the number of halfwords to be added
before the function label. A second argument can be used to specify the number
of halfwords to be added after the function label. For both arguments the
maximum allowed value is 1000000.
target (options)
As discussed in Section 6.33.1 [Common Function Attributes], page 557, this
attribute allows specification of target-specific compilation options.
‘arch=’
‘tune=’
‘stack-guard=’
‘stack-size=’
‘branch-cost=’
‘warn-framesize=’
‘backchain’
‘no-backchain’
‘hard-dfp’
‘no-hard-dfp’
‘hard-float’
‘soft-float’
‘htm’
‘no-htm’
‘vx’
‘no-vx’
Chapter 6: Extensions to the C Language Family 609
‘packed-stack’
‘no-packed-stack’
‘small-exec’
‘no-small-exec’
‘mvcle’
‘no-mvcle’
‘warn-dynamicstack’
‘no-warn-dynamicstack’
The options work exactly like the S/390 specific command line options (without
the prefix ‘-m’) except that they do not change any feature macros. For example,
target("no-vx")
does not undefine the __VEC__ macro.
trap_exit
Use this attribute on the SH for an interrupt_handler to return using trapa
instead of rte. This attribute expects an integer argument specifying the trap
number to be used.
trapa_handler
On SH targets this function attribute is similar to interrupt_handler but it
does not save and restore all registers.
fastcall On x86-32 targets, the fastcall attribute causes the compiler to pass the first
argument (if of integral type) in the register ECX and the second argument (if
of integral type) in the register EDX. Subsequent and other typed arguments
are passed on the stack. The called function pops the arguments off the stack.
If the number of arguments is variable all arguments are pushed on the stack.
thiscall On x86-32 targets, the thiscall attribute causes the compiler to pass the first
argument (if of integral type) in the register ECX. Subsequent and other typed
arguments are passed on the stack. The called function pops the arguments
off the stack. If the number of arguments is variable all arguments are pushed
on the stack. The thiscall attribute is intended for C++ non-static member
functions. As a GCC extension, this calling convention can be used for C
functions and for static member methods.
ms_abi
sysv_abi
On 32-bit and 64-bit x86 targets, you can use an ABI attribute to indicate
which calling convention should be used for a function. The ms_abi attribute
tells the compiler to use the Microsoft ABI, while the sysv_abi attribute tells
the compiler to use the System V ELF ABI, which is used on GNU/Linux
and other systems. The default is to use the Microsoft ABI when targeting
Windows. On all other systems, the default is the System V ELF ABI.
Note, the ms_abi attribute for Microsoft Windows 64-bit targets currently re-
quires the ‘-maccumulate-outgoing-args’ option.
callee_pop_aggregate_return (number)
On x86-32 targets, you can use this attribute to control how aggregates are
returned in memory. If the caller is responsible for popping the hidden pointer
together with the rest of the arguments, specify number equal to zero. If callee
is responsible for popping the hidden pointer, specify number equal to one.
The default x86-32 ABI assumes that the callee pops the stack for hidden
pointer. However, on x86-32 Microsoft Windows targets, the compiler assumes
that the caller pops the stack for hidden pointer.
ms_hook_prologue
On 32-bit and 64-bit x86 targets, you can use this function attribute to make
GCC generate the “hot-patching” function prologue used in Win32 API func-
tions in Microsoft Windows XP Service Pack 2 and newer.
naked This attribute allows the compiler to construct the requisite function decla-
ration, while allowing the body of the function to be assembly code. The
specified function will not have prologue/epilogue sequences generated by the
compiler. Only basic asm statements can safely be included in naked functions
(see Section 6.47.1 [Basic Asm], page 656). While using extended asm or a mix-
ture of basic asm and C code may appear to work, they cannot be depended
upon to work reliably and are not supported.
regparm (number)
On x86-32 targets, the regparm attribute causes the compiler to pass arguments
number one to number if they are of integral type in registers EAX, EDX,
612 Using the GNU Compiler Collection (GCC)
and ECX instead of on the stack. Functions that take a variable number of
arguments continue to be passed all of their arguments on the stack.
Beware that on some ELF systems this attribute is unsuitable for global func-
tions in shared libraries with lazy binding (which is the default). Lazy binding
sends the first call via resolving code in the loader, which might assume EAX,
EDX and ECX can be clobbered, as per the standard calling conventions. So-
laris 8 is affected by this. Systems with the GNU C Library version 2.1 or
higher and FreeBSD are believed to be safe since the loaders there save EAX,
EDX and ECX. (Lazy binding can be disabled with the linker or the loader if
desired, to avoid the problem.)
sseregparm
On x86-32 targets with SSE support, the sseregparm attribute causes the com-
piler to pass up to 3 floating-point arguments in SSE registers instead of on the
stack. Functions that take a variable number of arguments continue to pass all
of their floating-point arguments on the stack.
force_align_arg_pointer
On x86 targets, the force_align_arg_pointer attribute may be applied to
individual function definitions, generating an alternate prologue and epilogue
that realigns the run-time stack if necessary. This supports mixing legacy codes
that run with a 4-byte aligned stack with modern codes that keep a 16-byte
stack for SSE compatibility.
stdcall On x86-32 targets, the stdcall attribute causes the compiler to assume that
the called function pops off the stack space used to pass arguments, unless it
takes a variable number of arguments.
no_caller_saved_registers
Use this attribute to indicate that the specified function has no caller-saved
registers. That is, all registers are callee-saved. For example, this attribute
can be used for a function called from an interrupt handler. The compiler
generates proper function entry and exit sequences to save and restore any
modified registers, except for the EFLAGS register. Since GCC doesn’t preserve
SSE, MMX nor x87 states, the GCC option ‘-mgeneral-regs-only’ should be
used to compile functions with no_caller_saved_registers attribute.
interrupt
Use this attribute to indicate that the specified function is an interrupt han-
dler or an exception handler (depending on parameters passed to the function,
explained further). The compiler generates function entry and exit sequences
suitable for use in an interrupt handler when this attribute is present. The IRET
instruction, instead of the RET instruction, is used to return from interrupt han-
dlers. All registers, except for the EFLAGS register which is restored by the
IRET instruction, are preserved by the compiler. Since GCC doesn’t preserve
SSE, MMX nor x87 states, the GCC option ‘-mgeneral-regs-only’ should be
used to compile interrupt and exception handlers.
Any interruptible-without-stack-switch code must be compiled with
‘-mno-red-zone’ since interrupt handlers can and will, because of the
hardware design, touch the red zone.
Chapter 6: Extensions to the C Language Family 613
__attribute__ ((interrupt))
void
f (struct interrupt_frame *frame)
{
}
and you must define struct interrupt_frame as described in the processor’s
manual.
Exception handlers differ from interrupt handlers because the system pushes an
error code on the stack. An exception handler declaration is similar to that for
an interrupt handler, but with a different mandatory function signature. The
compiler arranges to pop the error code off the stack before the IRET instruction.
#ifdef __x86_64__
typedef unsigned long long int uword_t;
#else
typedef unsigned int uword_t;
#endif
struct interrupt_frame;
__attribute__ ((interrupt))
void
f (struct interrupt_frame *frame, uword_t error_code)
{
...
}
Exception handlers should only be used for exceptions that push an error code;
you should use an interrupt handler in other cases. The system will crash if the
wrong kind of handler is used.
target (options)
As discussed in Section 6.33.1 [Common Function Attributes], page 557, this
attribute allows specification of target-specific compilation options.
On the x86, the following options are allowed:
‘3dnow’
‘no-3dnow’
Enable/disable the generation of the 3DNow! instructions.
‘3dnowa’
‘no-3dnowa’
Enable/disable the generation of the enhanced 3DNow! instruc-
tions.
‘abm’
‘no-abm’ Enable/disable the generation of the advanced bit instructions.
‘adx’
‘no-adx’ Enable/disable the generation of the ADX instructions.
‘aes’
‘no-aes’ Enable/disable the generation of the AES instructions.
614 Using the GNU Compiler Collection (GCC)
‘avx’
‘no-avx’ Enable/disable the generation of the AVX instructions.
‘avx2’
‘no-avx2’ Enable/disable the generation of the AVX2 instructions.
‘avx5124fmaps’
‘no-avx5124fmaps’
Enable/disable the generation of the AVX5124FMAPS
instructions.
‘avx5124vnniw’
‘no-avx5124vnniw’
Enable/disable the generation of the AVX5124VNNIW instruc-
tions.
‘avx512bitalg’
‘no-avx512bitalg’
Enable/disable the generation of the AVX512BITALG instructions.
‘avx512bw’
‘no-avx512bw’
Enable/disable the generation of the AVX512BW instructions.
‘avx512cd’
‘no-avx512cd’
Enable/disable the generation of the AVX512CD instructions.
‘avx512dq’
‘no-avx512dq’
Enable/disable the generation of the AVX512DQ instructions.
‘avx512er’
‘no-avx512er’
Enable/disable the generation of the AVX512ER instructions.
‘avx512f’
‘no-avx512f’
Enable/disable the generation of the AVX512F instructions.
‘avx512ifma’
‘no-avx512ifma’
Enable/disable the generation of the AVX512IFMA instructions.
‘avx512pf’
‘no-avx512pf’
Enable/disable the generation of the AVX512PF instructions.
‘avx512vbmi’
‘no-avx512vbmi’
Enable/disable the generation of the AVX512VBMI instructions.
‘avx512vbmi2’
‘no-avx512vbmi2’
Enable/disable the generation of the AVX512VBMI2 instructions.
Chapter 6: Extensions to the C Language Family 615
‘avx512vl’
‘no-avx512vl’
Enable/disable the generation of the AVX512VL instructions.
‘avx512vnni’
‘no-avx512vnni’
Enable/disable the generation of the AVX512VNNI instructions.
‘avx512vpopcntdq’
‘no-avx512vpopcntdq’
Enable/disable the generation of the AVX512VPOPCNTDQ in-
structions.
‘bmi’
‘no-bmi’ Enable/disable the generation of the BMI instructions.
‘bmi2’
‘no-bmi2’ Enable/disable the generation of the BMI2 instructions.
‘cldemote’
‘no-cldemote’
Enable/disable the generation of the CLDEMOTE instructions.
‘clflushopt’
‘no-clflushopt’
Enable/disable the generation of the CLFLUSHOPT instructions.
‘clwb’
‘no-clwb’ Enable/disable the generation of the CLWB instructions.
‘clzero’
‘no-clzero’
Enable/disable the generation of the CLZERO instructions.
‘crc32’
‘no-crc32’
Enable/disable the generation of the CRC32 instructions.
‘cx16’
‘no-cx16’ Enable/disable the generation of the CMPXCHG16B instructions.
‘default’ See Section 7.8 [Function Multiversioning], page 894, where it is
used to specify the default function version.
‘f16c’
‘no-f16c’ Enable/disable the generation of the F16C instructions.
‘fma’
‘no-fma’ Enable/disable the generation of the FMA instructions.
‘fma4’
‘no-fma4’ Enable/disable the generation of the FMA4 instructions.
‘fsgsbase’
‘no-fsgsbase’
Enable/disable the generation of the FSGSBASE instructions.
616 Using the GNU Compiler Collection (GCC)
‘fxsr’
‘no-fxsr’ Enable/disable the generation of the FXSR instructions.
‘gfni’
‘no-gfni’ Enable/disable the generation of the GFNI instructions.
‘hle’
‘no-hle’ Enable/disable the generation of the HLE instruction prefixes.
‘lwp’
‘no-lwp’ Enable/disable the generation of the LWP instructions.
‘lzcnt’
‘no-lzcnt’
Enable/disable the generation of the LZCNT instructions.
‘mmx’
‘no-mmx’ Enable/disable the generation of the MMX instructions.
‘movbe’
‘no-movbe’
Enable/disable the generation of the MOVBE instructions.
‘movdir64b’
‘no-movdir64b’
Enable/disable the generation of the MOVDIR64B instructions.
‘movdiri’
‘no-movdiri’
Enable/disable the generation of the MOVDIRI instructions.
‘mwait’
‘no-mwait’
Enable/disable the generation of the MWAIT and MONITOR in-
structions.
‘mwaitx’
‘no-mwaitx’
Enable/disable the generation of the MWAITX instructions.
‘pclmul’
‘no-pclmul’
Enable/disable the generation of the PCLMUL instructions.
‘pconfig’
‘no-pconfig’
Enable/disable the generation of the PCONFIG instructions.
‘pku’
‘no-pku’ Enable/disable the generation of the PKU instructions.
‘popcnt’
‘no-popcnt’
Enable/disable the generation of the POPCNT instruction.
Chapter 6: Extensions to the C Language Family 617
‘prefetchwt1’
‘no-prefetchwt1’
Enable/disable the generation of the PREFETCHWT1 instruc-
tions.
‘prfchw’
‘no-prfchw’
Enable/disable the generation of the PREFETCHW instruction.
‘ptwrite’
‘no-ptwrite’
Enable/disable the generation of the PTWRITE instructions.
‘rdpid’
‘no-rdpid’
Enable/disable the generation of the RDPID instructions.
‘rdrnd’
‘no-rdrnd’
Enable/disable the generation of the RDRND instructions.
‘rdseed’
‘no-rdseed’
Enable/disable the generation of the RDSEED instructions.
‘rtm’
‘no-rtm’ Enable/disable the generation of the RTM instructions.
‘sahf’
‘no-sahf’ Enable/disable the generation of the SAHF instructions.
‘sgx’
‘no-sgx’ Enable/disable the generation of the SGX instructions.
‘sha’
‘no-sha’ Enable/disable the generation of the SHA instructions.
‘shstk’
‘no-shstk’
Enable/disable the shadow stack built-in functions from CET.
‘sse’
‘no-sse’ Enable/disable the generation of the SSE instructions.
‘sse2’
‘no-sse2’ Enable/disable the generation of the SSE2 instructions.
‘sse3’
‘no-sse3’ Enable/disable the generation of the SSE3 instructions.
‘sse4’
‘no-sse4’ Enable/disable the generation of the SSE4 instructions (both
SSE4.1 and SSE4.2).
618 Using the GNU Compiler Collection (GCC)
‘sse4.1’
‘no-sse4.1’
Enable/disable the generation of the SSE4.1 instructions.
‘sse4.2’
‘no-sse4.2’
Enable/disable the generation of the SSE4.2 instructions.
‘sse4a’
‘no-sse4a’
Enable/disable the generation of the SSE4A instructions.
‘ssse3’
‘no-ssse3’
Enable/disable the generation of the SSSE3 instructions.
‘tbm’
‘no-tbm’ Enable/disable the generation of the TBM instructions.
‘vaes’
‘no-vaes’ Enable/disable the generation of the VAES instructions.
‘vpclmulqdq’
‘no-vpclmulqdq’
Enable/disable the generation of the VPCLMULQDQ instructions.
‘waitpkg’
‘no-waitpkg’
Enable/disable the generation of the WAITPKG instructions.
‘wbnoinvd’
‘no-wbnoinvd’
Enable/disable the generation of the WBNOINVD instructions.
‘xop’
‘no-xop’ Enable/disable the generation of the XOP instructions.
‘xsave’
‘no-xsave’
Enable/disable the generation of the XSAVE instructions.
‘xsavec’
‘no-xsavec’
Enable/disable the generation of the XSAVEC instructions.
‘xsaveopt’
‘no-xsaveopt’
Enable/disable the generation of the XSAVEOPT instructions.
‘xsaves’
‘no-xsaves’
Enable/disable the generation of the XSAVES instructions.
‘amx-tile’
‘no-amx-tile’
Enable/disable the generation of the AMX-TILE instructions.
Chapter 6: Extensions to the C Language Family 619
‘amx-int8’
‘no-amx-int8’
Enable/disable the generation of the AMX-INT8 instructions.
‘amx-bf16’
‘no-amx-bf16’
Enable/disable the generation of the AMX-BF16 instructions.
‘uintr’
‘no-uintr’
Enable/disable the generation of the UINTR instructions.
‘hreset’
‘no-hreset’
Enable/disable the generation of the HRESET instruction.
‘kl’
‘no-kl’ Enable/disable the generation of the KEYLOCKER instructions.
‘widekl’
‘no-widekl’
Enable/disable the generation of the WIDEKL instructions.
‘avxvnni’
‘no-avxvnni’
Enable/disable the generation of the AVXVNNI instructions.
‘cld’
‘no-cld’ Enable/disable the generation of the CLD before string moves.
‘fancy-math-387’
‘no-fancy-math-387’
Enable/disable the generation of the sin, cos, and sqrt instruc-
tions on the 387 floating-point unit.
‘ieee-fp’
‘no-ieee-fp’
Enable/disable the generation of floating point that depends on
IEEE arithmetic.
‘inline-all-stringops’
‘no-inline-all-stringops’
Enable/disable inlining of string operations.
‘inline-stringops-dynamically’
‘no-inline-stringops-dynamically’
Enable/disable the generation of the inline code to do small string
operations and calling the library routines for large operations.
‘align-stringops’
‘no-align-stringops’
Do/do not align destination of inlined string operations.
620 Using the GNU Compiler Collection (GCC)
‘recip’
‘no-recip’
Enable/disable the generation of RCPSS, RCPPS, RSQRTSS and
RSQRTPS instructions followed an additional Newton-Raphson
step instead of doing a floating-point division.
‘general-regs-only’
Generate code which uses only the general registers.
‘arch=ARCH’
Specify the architecture to generate code for in compiling the func-
tion.
‘tune=TUNE’
Specify the architecture to tune for in compiling the function.
‘fpmath=FPMATH’
Specify which floating-point unit to use. You must
specify the target("fpmath=sse,387") option as
target("fpmath=sse+387") because the comma would
separate different options.
‘prefer-vector-width=OPT’
On x86 targets, the prefer-vector-width attribute informs the
compiler to use OPT-bit vector width in instructions instead of the
default on the selected platform.
Valid OPT values are:
‘none’ No extra limitations applied to GCC other than defined
by the selected platform.
‘128’ Prefer 128-bit vector width for instructions.
‘256’ Prefer 256-bit vector width for instructions.
‘512’ Prefer 512-bit vector width for instructions.
On the x86, the inliner does not inline a function that has different
target options than the caller, unless the callee has a subset of the
target options of the caller. For example a function declared with
target("sse3") can inline a function with target("sse2"), since
-msse3 implies -msse2.
indirect_branch("choice")
On x86 targets, the indirect_branch attribute causes the compiler to con-
vert indirect call and jump with choice. ‘keep’ keeps indirect call and jump
unmodified. ‘thunk’ converts indirect call and jump to call and return thunk.
‘thunk-inline’ converts indirect call and jump to inlined call and return thunk.
‘thunk-extern’ converts indirect call and jump to external call and return
thunk provided in a separate object file.
function_return("choice")
On x86 targets, the function_return attribute causes the compiler to convert
function return with choice. ‘keep’ keeps function return unmodified. ‘thunk’
Chapter 6: Extensions to the C Language Family 621
nocf_check
The nocf_check attribute on a function is used to inform the compiler that
the function’s prologue should not be instrumented when compiled with the
‘-fcf-protection=branch’ option. The compiler assumes that the function’s
address is a valid target for a control-flow transfer.
The nocf_check attribute on a type of pointer to function is used to inform
the compiler that a call through the pointer should not be instrumented when
compiled with the ‘-fcf-protection=branch’ option. The compiler assumes
that the function’s address from the pointer is a valid target for a control-flow
transfer. A direct function call through a function name is assumed to be a safe
call thus direct calls are not instrumented by the compiler.
The nocf_check attribute is applied to an object’s type. In case of assignment
of a function address or a function pointer to another pointer, the attribute is
not carried over from the right-hand object’s type; the type of left-hand object
stays unchanged. The compiler checks for nocf_check attribute mismatch and
reports a warning in case of mismatch.
{
int foo (void) __attribute__(nocf_check);
void (*foo1)(void) __attribute__(nocf_check);
void (*foo2)(void);
return 0;
}
cf_check
622 Using the GNU Compiler Collection (GCC)
interrupt
Use this attribute to indicate that the specified function is an interrupt handler.
The compiler generates function entry and exit sequences suitable for use in an
interrupt handler when this attribute is present.
alias ("target")
The alias variable attribute causes the declaration to be emitted as an alias
for another symbol known as an alias target. Except for top-level qualifiers the
alias target must have the same type as the alias. For instance, the following
int var_target;
extern int __attribute__ ((alias ("var_target"))) var_alias;
defines var_alias to be an alias for the var_target variable.
It is an error if the alias target is not defined in the same translation unit as
the alias.
Note that in the absence of the attribute GCC assumes that distinct declara-
tions with external linkage denote distinct objects. Using both the alias and the
alias target to access the same object is undefined in a translation unit without
a declaration of the alias with the attribute.
This attribute requires assembler and object file support, and may not be avail-
able on all targets.
aligned
aligned (alignment)
The aligned attribute specifies a minimum alignment for the variable or struc-
ture field, measured in bytes. When specified, alignment must be an integer
constant power of 2. Specifying no alignment argument implies the maximum
alignment for the target, which is often, but by no means always, 8 or 16 bytes.
For example, the declaration:
int x __attribute__ ((aligned (16))) = 0;
causes the compiler to allocate the global variable x on a 16-byte boundary. On
a 68040, this could be used in conjunction with an asm expression to access the
move16 instruction which requires 16-byte aligned operands.
You can also specify the alignment of structure fields. For example, to create a
double-word aligned int pair, you could write:
struct foo { int x[2] __attribute__ ((aligned (8))); };
This is an alternative to creating a union with a double member, which forces
the union to be double-word aligned.
As in the preceding examples, you can explicitly specify the alignment (in bytes)
that you wish the compiler to use for a given variable or structure field. Al-
ternatively, you can leave out the alignment factor and just ask the compiler
to align a variable or field to the default alignment for the target architecture
you are compiling for. The default alignment is sufficient for all scalar types,
but may not be enough for all vector types on a target that supports vector
operations. The default alignment is fixed for a particular target ABI.
GCC also provides a target specific macro __BIGGEST_ALIGNMENT__, which is
the largest alignment ever used for any data type on the target machine you
are compiling for. For example, you could write:
short array[3] __attribute__ ((aligned (__BIGGEST_ALIGNMENT__)));
The compiler automatically sets the alignment for the declared variable or field
to __BIGGEST_ALIGNMENT__. Doing this can often make copy operations more
624 Using the GNU Compiler Collection (GCC)
efficient, because the compiler can use whatever instructions copy the biggest
chunks of memory when performing copies to or from the variables or fields that
you have aligned this way. Note that the value of __BIGGEST_ALIGNMENT__ may
change depending on command-line options.
When used on a struct, or struct member, the aligned attribute can only in-
crease the alignment; in order to decrease it, the packed attribute must be
specified as well. When used as part of a typedef, the aligned attribute can
both increase and decrease alignment, and specifying the packed attribute gen-
erates a warning.
Note that the effectiveness of aligned attributes for static variables may be
limited by inherent limitations in the system linker and/or object file format.
On some systems, the linker is only able to arrange for variables to be aligned up
to a certain maximum alignment. (For some linkers, the maximum supported
alignment may be very very small.) If your linker is only able to align variables
up to a maximum of 8-byte alignment, then specifying aligned(16) in an _
_attribute__ still only provides you with 8-byte alignment. See your linker
documentation for further information.
Stack variables are not affected by linker restrictions; GCC can properly align
them on any target.
The aligned attribute can also be used for functions (see Section 6.33.1 [Com-
mon Function Attributes], page 557.)
warn_if_not_aligned (alignment)
This attribute specifies a threshold for the structure field, measured in bytes.
If the structure field is aligned below the threshold, a warning will be issued.
For example, the declaration:
struct foo
{
int i1;
int i2;
unsigned long long x __attribute__ ((warn_if_not_aligned (16)));
};
alloc_size (position)
alloc_size (position-1, position-2)
The alloc_size variable attribute may be applied to the declaration of a
pointer to a function that returns a pointer and takes at least one argument
of an integer type. It indicates that the returned pointer points to an object
whose size is given by the function argument at position, or by the product
of the arguments at position-1 and position-2. Meaningful sizes are positive
values less than PTRDIFF_MAX. Other sizes are diagnosed when detected. GCC
uses this information to improve the results of __builtin_object_size.
For instance, the following declarations
typedef __attribute__ ((alloc_size (1, 2))) void*
(*calloc_ptr) (size_t, size_t);
typedef __attribute__ ((alloc_size (1))) void*
(*malloc_ptr) (size_t);
specify that calloc_ptr is a pointer of a function that, like the standard C
function calloc, returns an object whose size is given by the product of argu-
ments 1 and 2, and similarly, that malloc_ptr, like the standard C function
malloc, returns an object whose size is given by argument 1 to the function.
cleanup (cleanup_function)
The cleanup attribute runs a function when the variable goes out of scope.
This attribute can only be applied to auto function scope variables; it may not
be applied to parameters or variables with static storage duration. The function
must take one parameter, a pointer to a type compatible with the variable. The
return value of the function (if any) is ignored.
If ‘-fexceptions’ is enabled, then cleanup function is run during the stack
unwinding that happens during the processing of the exception. Note that the
cleanup attribute does not allow the exception to be caught, only to perform
an action. It is undefined what happens if cleanup function does not return
normally.
common
nocommon The common attribute requests GCC to place a variable in “common” storage.
The nocommon attribute requests the opposite—to allocate space for it directly.
These attributes override the default chosen by the ‘-fno-common’ and
‘-fcommon’ flags respectively.
copy
copy (variable)
The copy attribute applies the set of attributes with which variable has been
declared to the declaration of the variable to which the attribute is applied. The
attribute is designed for libraries that define aliases that are expected to specify
the same set of attributes as the aliased symbols. The copy attribute can be
used with variables, functions or types. However, the kind of symbol to which
the attribute is applied (either varible or function) must match the kind of
symbol to which the argument refers. The copy attribute copies only syntactic
and semantic attributes but not attributes that affect a symbol’s linkage or
visibility such as alias, visibility, or weak. The deprecated attribute is
626 Using the GNU Compiler Collection (GCC)
also not copied. See Section 6.33.1 [Common Function Attributes], page 557.
See Section 6.35.1 [Common Type Attributes], page 637.
deprecated
deprecated (msg)
The deprecated attribute results in a warning if the variable is used anywhere
in the source file. This is useful when identifying variables that are expected
to be removed in a future version of a program. The warning also includes the
location of the declaration of the deprecated variable, to enable users to easily
find further information about why the variable is deprecated, or what they
should do instead. Note that the warning only occurs for uses:
extern int old_var __attribute__ ((deprecated));
extern int old_var;
int new_fn () { return old_var; }
results in a warning on line 3 but not line 2. The optional msg argument, which
must be a string, is printed in the warning if present.
The deprecated attribute can also be used for functions and types (see
Section 6.33.1 [Common Function Attributes], page 557, see Section 6.35.1
[Common Type Attributes], page 637).
The message attached to the attribute is affected by the setting of the
‘-fmessage-length’ option.
unavailable
unavailable (msg)
The unavailable attribute indicates that the variable so marked is not avail-
able, if it is used anywhere in the source file. It behaves in the same manner
as the deprecated attribute except that the compiler will emit an error rather
than a warning.
It is expected that items marked as deprecated will eventually be withdrawn
from interfaces, and then become unavailable. This attribute allows for marking
them appropriately.
The unavailable attribute can also be used for functions and types (see
Section 6.33.1 [Common Function Attributes], page 557, see Section 6.35.1
[Common Type Attributes], page 637).
mode (mode)
This attribute specifies the data type for the declaration—whichever type corre-
sponds to the mode mode. This in effect lets you request an integer or floating-
point type according to its width.
See Section “Machine Modes” in GNU Compiler Collection (GCC) Internals, for
a list of the possible keywords for mode. You may also specify a mode of byte
or __byte__ to indicate the mode corresponding to a one-byte integer, word or
__word__ for the mode of a one-word integer, and pointer or __pointer__ for
the mode used to represent pointers.
nonstring
The nonstring variable attribute specifies that an object or member declara-
tion with type array of char, signed char, or unsigned char, or pointer to
Chapter 6: Extensions to the C Language Family 627
such a type is intended to store character arrays that do not necessarily contain
a terminating NUL. This is useful in detecting uses of such arrays or pointers
with functions that expect NUL-terminated strings, and to avoid warnings when
such an array or pointer is used as an argument to a bounded string manipula-
tion function such as strncpy. For example, without the attribute, GCC will
issue a warning for the strncpy call below because it may truncate the copy
without appending the terminating NUL character. Using the attribute makes
it possible to suppress the warning. However, when the array is declared with
the attribute the call to strlen is diagnosed because when the array doesn’t
contain a NUL-terminated string the call is undefined. To copy, compare, of
search non-string character arrays use the memcpy, memcmp, memchr, and other
functions that operate on arrays of bytes. In addition, calling strnlen and
strndup with such arrays is safe provided a suitable bound is specified, and not
diagnosed.
struct Data
{
char name [32] __attribute__ ((nonstring));
};
packed The packed attribute specifies that a structure member should have the smallest
possible alignment—one bit for a bit-field and one byte otherwise, unless a larger
value is specified with the aligned attribute. The attribute does not apply to
non-member objects.
For example in the structure below, the member array x is packed so that it
immediately follows a with no intervening padding:
struct foo
{
char a;
int x[2] __attribute__ ((packed));
};
Note: The 4.1, 4.2 and 4.3 series of GCC ignore the packed attribute on
bit-fields of type char. This has been fixed in GCC 4.4 but the change
can lead to differences in the structure layout. See the documentation of
‘-Wpacked-bitfield-compat’ for more information.
section ("section-name")
Normally, the compiler places the objects it generates in sections like data and
bss. Sometimes, however, you need additional sections, or you need certain
particular variables to appear in special sections, for example to map to special
hardware. The section attribute specifies that a variable (or function) lives
in a particular section. For example, this small program uses several specific
section names:
struct duart a __attribute__ ((section ("DUART_A"))) = { 0 };
struct duart b __attribute__ ((section ("DUART_B"))) = { 0 };
628 Using the GNU Compiler Collection (GCC)
main()
{
/* Initialize stack pointer */
init_sp (stack + sizeof (stack));
uninitialized
This attribute, attached to a variable with automatic storage, means that the
variable should not be automatically initialized by the compiler when the option
-ftrivial-auto-var-init presents.
With the option -ftrivial-auto-var-init, all the automatic variables that
do not have explicit initializers will be initialized by the compiler. These ad-
ditional compiler initializations might incur run-time overhead, sometimes dra-
matically. This attribute can be used to mark some variables to be excluded
from such automatical initialization in order to reduce runtime overhead.
This attribute has no effect when the option -ftrivial-auto-var-init does
not present.
vector_size (bytes)
This attribute specifies the vector size for the type of the declared variable,
measured in bytes. The type to which it applies is known as the base type. The
bytes argument must be a positive power-of-two multiple of the base type size.
For example, the declaration:
int foo __attribute__ ((vector_size (16)));
causes the compiler to set the mode for foo, to be 16 bytes, divided into int
sized units. Assuming a 32-bit int, foo’s type is a vector of four units of four
bytes each, and the corresponding mode of foo is V4SI. See Section 6.52 [Vector
Extensions], page 713, for details of manipulating vector variables.
This attribute is only applicable to integral and floating scalars, although ar-
rays, pointers, and function return values are allowed in conjunction with this
construct.
Aggregates with this attribute are invalid, even if they are of the same size as
a corresponding scalar. For example, the declaration:
struct S { int a; };
struct S __attribute__ ((vector_size (16))) foo;
is invalid even if the size of the structure is the same as the size of the int.
visibility ("visibility_type")
This attribute affects the linkage of the declaration to which it is attached.
The visibility attribute is described in Section 6.33.1 [Common Function
Attributes], page 557.
weak The weak attribute is described in Section 6.33.1 [Common Function
Attributes], page 557.
noinit Any data with the noinit attribute will not be initialized by the C runtime
startup code, or the program loader. Not initializing data in this way can reduce
program startup times.
This attribute is specific to ELF targets and relies on the linker script to place
sections with the .noinit prefix in the right location.
persistent
Any data with the persistent attribute will not be initialized by the C runtime
startup code, but will be initialized by the program loader. This enables the
value of the variable to ‘persist’ between processor resets.
630 Using the GNU Compiler Collection (GCC)
This attribute is specific to ELF targets and relies on the linker script to place
the sections with the .persistent prefix in the right location. Specifically,
some type of non-volatile, writeable memory is required.
objc_nullability (nullability kind) (Objective-C and Objective-C++ only)
This attribute applies to pointer variables only. It allows marking the pointer
with one of four possible values describing the conditions under which the
pointer might have a nil value. In most cases, the attribute is intended to
be an internal representation for property and method nullability (specified by
language keywords); it is not recommended to use it directly.
When nullability kind is "unspecified" or 0, nothing is known about the
conditions in which the pointer might be nil. Making this state specific serves
to avoid false positives in diagnostics.
When nullability kind is "nonnull" or 1, the pointer has no meaning if it is
nil and thus the compiler is free to emit diagnostics if it can be determined
that the value will be nil.
When nullability kind is "nullable" or 2, the pointer might be nil and carry
meaning as such.
When nullability kind is "resettable" or 3 (used only in the context of prop-
erty attribute lists) this describes the case in which a property setter may take
the value nil (which perhaps causes the property to be reset in some manner
to a default) but for which the property getter will never validly return nil.
}
AVR is a Harvard architecture processor and data and read-only
data normally resides in the data memory (RAM).
See also the [AVR Named Address Spaces], page 545 section for an
alternate way to locate and access data in flash memory.
• AVR cores with flash memory visible in the RAM address range:
On such devices, there is no need for attribute progmem or [__
flash], page 545 qualifier at all. Just use standard C / C++. The
compiler will generate LD* instructions. As flash memory is visible
in the RAM address range, and the default linker script does not
locate .rodata in RAM, no special features are needed in order
not to waste RAM for read-only data or to read from flash. You
might even get slightly better performance by avoiding progmem
and __flash. This applies to devices from families avrtiny and
avrxmega3, see Section 3.19.6 [AVR Options], page 334 for an over-
view.
• Reduced AVR Tiny cores like ATtiny40:
The compiler adds 0x4000 to the addresses of objects and declara-
tions in progmem and locates the objects in flash memory, namely
in section .progmem.data. The offset is needed because the flash
memory is visible in the RAM address space starting at address
0x4000.
Data in progmem can be accessed by means of ordinary C code, no
special functions or macros are needed.
/* var is located in flash memory */
extern const int var[2] __attribute__((progmem));
io_low
io_low (addr)
This is like the io attribute, but additionally it informs the compiler that the
object lies in the lower half of the I/O area, allowing the use of cbi, sbi, sbic
and sbis instructions.
address
address (addr)
Variables with the address attribute are used to address memory-mapped pe-
ripherals that may lie outside the io address range.
volatile int porta __attribute__((address (0x600)));
absdata Variables in static storage and with the absdata attribute can be accessed by
the LDS and STS instructions which take absolute addresses.
• This attribute is only supported for the reduced AVR Tiny core like AT-
tiny40.
• You must make sure that respective data is located in the address range
0x40. . . 0xbf accessible by LDS and STS. One way to achieve this as an
appropriate linker description file.
• If the location does not fit the address range of LDS and STS, there is
currently (Binutils 2.26) just an unspecific warning like
module.cc:(.text+0x1c): warning: internal error: out
of range error
See also the ‘-mabsdata’ Section 3.19.6 [AVR Options], page 334.
You must use GAS and GLD from GNU binutils version 2.7 or later for this
attribute to work correctly.
tiny_data
Use this attribute on the H8/300H and H8S to indicate that the specified vari-
able should be placed into the tiny data section. The compiler generates more
efficient code for loads and stores on data in the tiny data section. Note the
tiny data area is limited to slightly under 32KB of data.
far Variables with the far attribute are addressed using a full 32-bit address. Since
this covers the entire memory space, this allows modules to make no assump-
tions about where variables might be stored.
io
io (addr) Variables with the io attribute are used to address memory-mapped peripher-
als. If an address is specified, the variable is assigned that address, else it is
not assigned an address (it is assumed some other module assigns an address).
Example:
int timer_count __attribute__((io(0x123)));
cb
cb (addr) Variables with the cb attribute are used to access the control bus, using special
instructions. addr indicates the control bus address. Example:
int cpu_clock __attribute__((cb(0x123)));
int
main()
{
Chapter 6: Extensions to the C Language Family 635
In the example above, if the size of each short is 2 bytes, then the size of the
entire struct S type is 6 bytes. The smallest power of two that is greater than
or equal to that is 8, so the compiler sets the alignment for the entire struct
S type to 8 bytes.
Note that although you can ask the compiler to select a time-efficient alignment
for a given type and then declare only individual stand-alone objects of that
type, the compiler’s ability to select a time-efficient alignment is primarily useful
only when you plan to create arrays of variables having the relevant (efficiently
aligned) type. If you declare or use arrays of variables of an efficiently-aligned
type, then it is likely that your program also does pointer arithmetic (or sub-
scripting, which amounts to the same thing) on pointers to the relevant type,
and the code that the compiler generates for these pointer arithmetic operations
is often more efficient for efficiently-aligned types than for other types.
Note that the effectiveness of aligned attributes may be limited by inherent
limitations in your linker. On many systems, the linker is only able to arrange
for variables to be aligned up to a certain maximum alignment. (For some
linkers, the maximum supported alignment may be very very small.) If your
linker is only able to align variables up to a maximum of 8-byte alignment, then
specifying aligned (16) in an __attribute__ still only provides you with 8-
byte alignment. See your linker documentation for further information.
When used on a struct, or struct member, the aligned attribute can only in-
crease the alignment; in order to decrease it, the packed attribute must be
specified as well. When used as part of a typedef, the aligned attribute can
both increase and decrease alignment, and specifying the packed attribute gen-
erates a warning.
warn_if_not_aligned (alignment)
This attribute specifies a threshold for the structure field, measured in bytes.
If the structure field is aligned below the threshold, a warning will be issued.
For example, the declaration:
typedef unsigned long long __u64
__attribute__((aligned (4), warn_if_not_aligned (8)));
struct foo
{
int i1;
int i2;
__u64 x;
};
causes the compiler to issue an warning on struct foo, like ‘warning:
alignment 4 of ’struct foo’ is less than 8’. It is used to define struct
foo in such a way that struct foo has the same layout and the structure field
x has the same alignment when __u64 is aligned at either 4 or 8 bytes. Align
struct foo to 8 bytes:
struct __attribute__ ((aligned (8))) foo
{
int i1;
int i2;
__u64 x;
Chapter 6: Extensions to the C Language Family 639
};
silences the warning. The compiler also issues a warning, like ‘warning: ’x’
offset 12 in ’struct foo’ isn’t aligned to 8’, when the structure field has
the misaligned offset:
struct __attribute__ ((aligned (8))) foo
{
int i1;
int i2;
int i3;
__u64 x;
};
This warning can be disabled by ‘-Wno-if-not-aligned’.
alloc_size (position)
alloc_size (position-1, position-2)
The alloc_size type attribute may be applied to the definition of a type
of a function that returns a pointer and takes at least one argument of an
integer type. It indicates that the returned pointer points to an object whose
size is given by the function argument at position-1, or by the product of the
arguments at position-1 and position-2. Meaningful sizes are positive values
less than PTRDIFF_MAX. Other sizes are disagnosed when detected. GCC uses
this information to improve the results of __builtin_object_size.
For instance, the following declarations
typedef __attribute__ ((alloc_size (1, 2))) void*
calloc_type (size_t, size_t);
typedef __attribute__ ((alloc_size (1))) void*
malloc_type (size_t);
specify that calloc_type is a type of a function that, like the standard C func-
tion calloc, returns an object whose size is given by the product of arguments
1 and 2, and that malloc_type, like the standard C function malloc, returns
an object whose size is given by argument 1 to the function.
copy
copy (expression)
The copy attribute applies the set of attributes with which the type of the ex-
pression has been declared to the declaration of the type to which the attribute
is applied. The attribute is designed for libraries that define aliases that are
expected to specify the same set of attributes as the aliased symbols. The copy
attribute can be used with types, variables, or functions. However, the kind of
symbol to which the attribute is applied (either varible or function) must match
the kind of symbol to which the argument refers. The copy attribute copies
only syntactic and semantic attributes but not attributes that affect a symbol’s
linkage or visibility such as alias, visibility, or weak. The deprecated at-
tribute is also not copied. See Section 6.33.1 [Common Function Attributes],
page 557. See Section 6.34.1 [Common Variable Attributes], page 622.
For example, suppose struct A below is defined in some third party library
header to have the alignment requirement N and to force a warning whenever
a variable of the type is not so aligned due to attribute packed. Specifying
the copy attribute on the definition on the unrelated struct B has the effect of
640 Using the GNU Compiler Collection (GCC)
copying all relevant attributes from the type referenced by the pointer expres-
sion to struct B.
struct __attribute__ ((aligned (N), warn_if_not_aligned (N)))
A { /* . . . */ };
struct __attribute__ ((copy ( (struct A *)0)) B { /* . . . */ };
deprecated
deprecated (msg)
The deprecated attribute results in a warning if the type is used anywhere in
the source file. This is useful when identifying types that are expected to be
removed in a future version of a program. If possible, the warning also includes
the location of the declaration of the deprecated type, to enable users to easily
find further information about why the type is deprecated, or what they should
do instead. Note that the warnings only occur for uses and then only if the type
is being applied to an identifier that itself is not being declared as deprecated.
typedef int T1 __attribute__ ((deprecated));
T1 x;
typedef T1 T2;
T2 y;
typedef T1 T3 __attribute__ ((deprecated));
T3 z __attribute__ ((deprecated));
results in a warning on line 2 and 3 but not lines 4, 5, or 6. No warning
is issued for line 4 because T2 is not explicitly deprecated. Line 5 has no
warning because T3 is explicitly deprecated. Similarly for line 6. The optional
msg argument, which must be a string, is printed in the warning if present.
Control characters in the string will be replaced with escape sequences, and if
the ‘-fmessage-length’ option is set to 0 (its default value) then any newline
characters will be ignored.
The deprecated attribute can also be used for functions and variables (see
Section 6.33 [Function Attributes], page 556, see Section 6.34 [Variable At-
tributes], page 622.)
The message attached to the attribute is affected by the setting of the
‘-fmessage-length’ option.
unavailable
unavailable (msg)
The unavailable attribute behaves in the same manner as the deprecated
one, but emits an error rather than a warning. It is used to indicate that a
(perhaps previously deprecated) type is no longer usable.
The unavailable attribute can also be used for functions and variables (see
Section 6.33 [Function Attributes], page 556, see Section 6.34 [Variable At-
tributes], page 622.)
designated_init
This attribute may only be applied to structure types. It indicates that any ini-
tialization of an object of this type must use designated initializers rather than
positional initializers. The intent of this attribute is to allow the programmer
to indicate that a structure’s layout may change, and that therefore relying on
positional initialization will result in future breakage.
Chapter 6: Extensions to the C Language Family 641
int
main (void)
{
int a = 0x12345678;
short_a *b = (short_a *) &a;
b[1] = 0;
if (a == 0x12345678)
abort();
exit(0);
}
If you replaced short_a with short in the variable declaration, the above pro-
gram would abort when compiled with ‘-fstrict-aliasing’, which is on by
default at ‘-O2’ or above.
mode (mode)
This attribute specifies the data type for the declaration—whichever type corre-
sponds to the mode mode. This in effect lets you request an integer or floating-
point type according to its width.
See Section “Machine Modes” in GNU Compiler Collection (GCC) Internals, for
a list of the possible keywords for mode. You may also specify a mode of byte
or __byte__ to indicate the mode corresponding to a one-byte integer, word or
__word__ for the mode of a one-word integer, and pointer or __pointer__ for
the mode used to represent pointers.
packed This attribute, attached to a struct, union, or C++ class type definition,
specifies that each of its members (other than zero-width bit-fields) is placed
to minimize the memory required. This is equivalent to specifying the packed
attribute on each of the members.
When attached to an enum definition, the packed attribute indicates that the
smallest integral type should be used. Specifying the ‘-fshort-enums’ flag on
the command line is equivalent to specifying the packed attribute on all enum
definitions.
642 Using the GNU Compiler Collection (GCC)
distinct types that assign a different storage order to it, then the behavior is
undefined.
transparent_union
This attribute, attached to a union type definition, indicates that any function
parameter having that union type causes calls to that function to be treated in
a special way.
First, the argument corresponding to a transparent union type can be of any
type in the union; no cast is required. Also, if the union contains a pointer type,
the corresponding argument can be a null pointer constant or a void pointer
expression; and if the union contains a void pointer type, the corresponding
argument can be any pointer expression. If the union member type is a pointer,
qualifiers like const on the referenced type must be respected, just as with
normal pointer conversions.
Second, the argument is passed to the function using the calling conventions of
the first member of the transparent union, not the calling conventions of the
union itself. All members of the union must have the same machine represen-
tation; this is necessary for this argument passing to work properly.
Transparent unions are designed for library functions that have multiple inter-
faces for compatibility reasons. For example, suppose the wait function must
accept either a value of type int * to comply with POSIX, or a value of type
union wait * to comply with the 4.1BSD interface. If wait’s parameter were
void *, wait would accept both kinds of arguments, but it would also accept
any other pointer type and this would make argument type checking less useful.
Instead, <sys/wait.h> might define the interface as follows:
typedef union __attribute__ ((__transparent_union__))
{
int *__ip;
union wait *__up;
} wait_status_ptr_t;
unused When attached to a type (including a union or a struct), this attribute means
that variables of that type are meant to appear possibly unused. GCC does not
produce a warning for any variables of that type, even if the variable appears to
do nothing. This is often the case with lock or thread classes, which are usually
defined and then not referenced, but contain constructors and destructors that
have nontrivial bookkeeping functions.
644 Using the GNU Compiler Collection (GCC)
vector_size (bytes)
This attribute specifies the vector size for the type, measured in bytes. The
type to which it applies is known as the base type. The bytes argument must
be a positive power-of-two multiple of the base type size. For example, the
following declarations:
typedef __attribute__ ((vector_size (32))) int int_vec32_t ;
typedef __attribute__ ((vector_size (32))) int* int_vec32_ptr_t;
typedef __attribute__ ((vector_size (32))) int int_vec32_arr3_t[3];
visibility
In C++, attribute visibility (see Section 6.33 [Function Attributes], page 556)
can also be applied to class, struct, union and enum types. Unlike other type
attributes, the attribute must appear between the initial keyword and the name
of the type; it cannot appear after the body of the type.
Note that the type visibility is applied to vague linkage entities associated with
the class (vtable, typeinfo node, etc.). In particular, if a class is thrown as
an exception in one shared object and caught in another, the class must have
default visibility. Otherwise the two shared objects are unable to use the same
typeinfo node and exception handling will break.
To specify multiple attributes, separate them by commas within the double parentheses:
for example, ‘__attribute__ ((aligned (16), packed))’.
__declspec(dllexport)
C::C() {}
In this code, C::C is exported from the current DLL, but the virtual table for C is not
exported. (You can use __attribute__ instead of __declspec if you prefer, but most
Symbian OS code uses __declspec.)
These attributes mainly are intended to support the __vector, __pixel, and __bool
AltiVec keywords.
ms_struct
gcc_struct
If packed is used on a structure, or if bit-fields are used it may be that the
Microsoft ABI packs them differently than GCC normally packs them. Par-
ticularly when moving packed data between functions compiled with GCC and
the native Microsoft compiler (either via function call or as data in a file), it
may be necessary to access either format.
The ms_struct and gcc_struct attributes correspond to the ‘-mms-bitfields’
and ‘-mno-ms-bitfields’ command-line options, respectively; see
Section 3.19.58 [x86 Options], page 465, for details of how structure layout
is affected. See Section 6.34.15 [x86 Variable Attributes], page 636, for
information about the corresponding attributes on variables.
/* This branch (the fall-through from the asm) is less commonly used */
ErrorHandling:
__attribute__((cold, unused)); /* Semi-colon is required here */
printf("error\n");
return 0;
NoError:
printf("no error\n");
return 1;
unused This feature is intended for program-generated code that may contain unused
labels, but which is compiled with ‘-Wall’. It is not normally appropriate to
use in it human-written code, though it could be useful in cases where the code
that jumps to the label is contained within an #ifdef conditional.
hot The hot attribute on a label is used to inform the compiler that the path
following the label is more likely than paths that are not so annotated. This
attribute is used in cases where __builtin_expect cannot be used, for instance
with computed goto or asm goto.
cold The cold attribute on labels is used to inform the compiler that the path
following the label is unlikely to be executed. This attribute is used in cases
where __builtin_expect cannot be used, for instance with computed goto or
asm goto.
Chapter 6: Extensions to the C Language Family 647
int
fn (void)
{
return oldval;
}
deprecated
The deprecated attribute results in a warning if the enumerator is used any-
where in the source file. This is useful when identifying enumerators that are
expected to be removed in a future version of a program. The warning also
includes the location of the declaration of the deprecated enumerator, to enable
users to easily find further information about why the enumerator is deprecated,
or what they should do instead. Note that the warnings only occurs for uses.
unavailable
The unavailable attribute results in an error if the enumerator is used any-
where in the source file. In other respects it behaves in the same manner as the
deprecated attribute.
fallthrough
The fallthrough attribute with a null statement serves as a fallthrough state-
ment. It hints to the compiler that a statement that falls through to another
case label, or user-defined label in a switch statement is intentional and thus
the ‘-Wimplicit-fallthrough’ warning must not trigger. The fallthrough at-
tribute may appear at most once in each attribute list, and may not be mixed
with other attributes. It can only be used in a switch statement (the compiler
will issue an error otherwise), after a preceding statement and before a logically
succeeding case label, or user-defined label.
An attribute specifier list is a sequence of one or more attribute specifiers, not separated
by any other tokens.
You may optionally specify attribute names with ‘__’ preceding and following the name.
This allows you to use them in header files without being concerned about a possible macro
of the same name. For example, you may use the attribute name __noreturn__ instead of
noreturn.
Label Attributes
In GNU C, an attribute specifier list may appear after the colon following a label, other than
a case or default label. GNU C++ only permits attributes on labels if the attribute specifier
is immediately followed by a semicolon (i.e., the label applies to an empty statement). If
the semicolon is missing, C++ label attributes are ambiguous, as it is permissible for a
declaration, which could begin with an attribute list, to be labelled in C++. Declarations
cannot be labelled in C90 or C99, so the ambiguity does not arise there.
Enumerator Attributes
In GNU C, an attribute specifier list may appear as part of an enumerator. The attribute
goes after the enumeration constant, before =, if present. The optional attribute in the
enumerator appertains to the enumeration constant. It is not possible to place the attribute
after the constant expression, if present.
Statement Attributes
In GNU C, an attribute specifier list may appear as part of a null statement. The attribute
goes before the semicolon.
Type Attributes
An attribute specifier list may appear as part of a struct, union or enum specifier. It may
go either immediately after the struct, union or enum keyword, or after the closing brace.
The former syntax is preferred. Where attribute specifiers follow the closing brace, they
are considered to relate to the structure, union or enumerated type defined, not to any
enclosing declaration the type specifier appears in, and the type defined is not complete
until after the attribute specifiers.
definition cannot begin with an attribute specifier, because such an attribute applies to the
function instead by syntax described below (which, however, is not yet implemented in this
case). In some other cases, attribute specifiers are permitted by this grammar but not yet
supported by the compiler. All attribute specifiers in this place relate to the declaration as
a whole. In the obsolescent usage where a type of int is implied by the absence of type
specifiers, such a list of specifiers and qualifiers may be an attribute specifier list with no
other specifiers or qualifiers.
At present, the first parameter in a function prototype must have some type specifier that
is not an attribute specifier; this resolves an ambiguity in the interpretation of void f(int
(__attribute__((foo)) x)), but is subject to change. At present, if the parentheses of a
function declarator contain only attributes then those attributes are ignored, rather than
yielding an error or warning or implying a single parameter of type int, but this is subject
to change.
An attribute specifier list may appear immediately before a declarator (other than the
first) in a comma-separated list of declarators in a declaration of more than one identifier
using a single list of specifiers and qualifiers. Such attribute specifiers apply only to the
identifier before whose declarator they appear. For example, in
__attribute__((noreturn)) void d0 (void),
__attribute__((format(printf, 1, 2))) d1 (const char *, ...),
d2 (void);
the noreturn attribute applies to all the functions declared; the format attribute only
applies to d1.
An attribute specifier list may appear immediately before the comma, = or semicolon
terminating the declaration of an identifier other than a function definition. Such attribute
specifiers apply to the declared object or function. Where an assembler name for an object
or function is specified (see Section 6.47.4 [Asm Labels], page 707), the attribute must follow
the asm specification.
An attribute specifier list may, in future, be permitted to appear after the declarator in
a function definition (before any old-style parameter declarations or the function body).
Attribute specifiers may be mixed with type qualifiers appearing inside the [] of a pa-
rameter array declarator, in the C99 construct by which such qualifiers are applied to the
pointer to which the array is implicitly converted. Such attribute specifiers apply to the
pointer, not to the array, but at present this is not implemented and they are ignored.
An attribute specifier list may appear at the start of a nested declarator. At present,
there are some limitations in this usage: the attributes correctly apply to the declarator,
but for most individual attributes the semantics this implies are not implemented. When
attribute specifiers follow the * of a pointer declarator, they may be mixed with any type
qualifiers present. The following describes the formal semantics of this syntax. It makes
the most sense if you are familiar with the formal specification of declarators in the ISO C
standard.
Consider (as in C99 subclause 6.7.5 paragraph 4) a declaration T D1, where T contains
declaration specifiers that specify a type Type (such as int) and D1 is a declarator that
contains an identifier ident. The type specified for ident for derived declarators whose type
does not include an attribute specifier is as in the ISO C standard.
Chapter 6: Extensions to the C Language Family 651
Suppose the type uid_t happens to be short. ISO C does not allow this example,
because subword arguments in old-style non-prototype definitions are promoted. Therefore
in this example the function definition’s argument is really an int, which does not match
the prototype argument type of short.
This restriction of ISO C makes it hard to write code that is portable to traditional C
compilers, because the programmer does not know whether the uid_t type is short, int,
or long. Therefore, in cases like these GNU C allows a prototype to override a later old-
style definition. More precisely, in GNU C, a function prototype argument type overrides
the argument type specified by a later old-style definition if the former type is the same as
the latter type before promotion. Thus in GNU C the above example is equivalent to the
following:
int isroot (uid_t);
int
isroot (uid_t x)
{
return x == 0;
}
GNU C++ does not support old-style function definitions, so this extension is irrelevant.
Some machines never actually require alignment; they allow references to any data type
even at an odd address. For these machines, __alignof__ reports the smallest alignment
that GCC gives the data type, usually as mandated by the target ABI.
If the operand of __alignof__ is an lvalue rather than a type, its value is the required
alignment for its type, taking into account any minimum alignment specified by attribute
aligned (see Section 6.34.1 [Common Variable Attributes], page 622). For example, after
this declaration:
struct foo { int x; char y; } foo1;
the value of __alignof__ (foo1.y) is 1, even though its actual alignment is probably 2 or
4, the same as __alignof__ (int). It is an error to ask for the alignment of an incomplete
type other than void.
If the operand of the __alignof__ expression is a function, the expression evaluates to the
alignment of the function which may be specified by attribute aligned (see Section 6.33.1
[Common Function Attributes], page 557).
When a function is both inline and static, if all calls to the function are integrated into
the caller, and the function’s address is never used, then the function’s own assembler code is
never referenced. In this case, GCC does not actually output assembler code for the function,
unless you specify the option ‘-fkeep-inline-functions’. If there is a nonintegrated call,
then the function is compiled to assembler code as usual. The function must also be compiled
as usual if the program refers to its address, because that cannot be inlined.
Note that certain usages in a function definition can make it unsuitable for inline substitu-
tion. Among these usages are: variadic functions, use of alloca, use of computed goto (see
Section 6.3 [Labels as Values], page 532), use of nonlocal goto, use of nested functions, use
of setjmp, use of __builtin_longjmp and use of __builtin_return or __builtin_apply_
args. Using ‘-Winline’ warns when a function marked inline could not be substituted,
and gives the reason for the failure.
As required by ISO C++, GCC considers member functions defined within the body of a
class to be marked inline even if they are not explicitly declared with the inline keyword.
You can override this with ‘-fno-default-inline’; see Section 3.5 [Options Controlling
C++ Dialect], page 51.
GCC does not inline any functions when not optimizing unless you specify the
‘always_inline’ attribute for the function, like this:
/* Prototype. */
inline void foo (const char) __attribute__((always_inline));
The remainder of this section is specific to GNU C90 inlining.
When an inline function is not static, then the compiler must assume that there may be
calls from other source files; since a global symbol can be defined only once in any program,
the function must not be defined in the other source files, so the calls therein cannot be
integrated. Therefore, a non-static inline function is always compiled on its own in the
usual fashion.
If you specify both inline and extern in the function definition, then the definition is
used only for inlining. In no case is the function compiled on its own, not even if you refer
to its address explicitly. Such an address becomes an external reference, as if you had only
declared the function, and had not defined it.
This combination of inline and extern has almost the effect of a macro. The way to use
it is to put a function definition in a header file with these keywords, and put another copy
of the definition (lacking inline and extern) in a library file. The definition in the header
file causes most calls to the function to be inlined. If any uses of the function remain, they
refer to the single copy in the library.
sequence point. The use of volatile does not allow you to violate the restriction on updating
objects multiple times between two sequence points.
Accesses to non-volatile objects are not ordered with respect to volatile accesses. You
cannot use a volatile object as a memory barrier to order a sequence of writes to non-volatile
memory. For instance:
int *ptr = something;
volatile int vobj;
*ptr = something;
vobj = 1;
Unless *ptr and vobj can be aliased, it is not guaranteed that the write to *ptr occurs by
the time the update of vobj happens. If you need this guarantee, you must use a stronger
memory barrier such as:
int *ptr = something;
volatile int vobj;
*ptr = something;
asm volatile ("" : : : "memory");
vobj = 1;
A scalar volatile object is read when it is accessed in a void context:
volatile int *src = somevalue;
*src;
Such expressions are rvalues, and GCC implements this as a read of the volatile object
being pointed to.
Assignments are also expressions and have an rvalue. However when assigning to a scalar
volatile, the volatile object is not reread, regardless of whether the assignment expression’s
rvalue is used or not. If the assignment’s rvalue is used, the value is that assigned to the
volatile object. For instance, there is no read of vobj in all the following cases:
int obj;
volatile int vobj;
vobj = something;
obj = vobj = something;
obj ? vobj = onething : vobj = anotherthing;
obj = (something, vobj = anotherthing);
If you need to read the volatile object after an assignment has occurred, you must use a
separate expression with an intervening sequence point.
As bit-fields are not individually addressable, volatile bit-fields may be implicitly read
when written to, or when adjacent bit-fields are accessed. Bit-field operations may be
optimized such that adjacent bit-fields are only partially accessed, if they straddle a storage
unit boundary. For these reasons it is unwise to use volatile bit-fields to access hardware.
Qualifiers
volatile The optional volatile qualifier has no effect. All basic asm blocks are implicitly
volatile.
inline If you use the inline qualifier, then for inlining purposes the size of the asm
statement is taken as the smallest size possible (see Section 6.47.6 [Size of an
asm], page 710).
Parameters
AssemblerInstructions
This is a literal string that specifies the assembler code. The string can contain
any instructions recognized by the assembler, including directives. GCC does
not parse the assembler instructions themselves and does not know what they
mean or even whether they are valid assembler input.
You may place multiple assembler instructions together in a single asm string,
separated by the characters normally used in assembly code for the system. A
combination that works in most places is a newline to break the line, plus a
tab character (written as ‘\n\t’). Some assemblers allow semicolons as a line
separator. However, note that some assembler dialects use semicolons to start
a comment.
Remarks
Using extended asm (see Section 6.47.2 [Extended Asm], page 657) typically produces
smaller, safer, and more efficient code, and in most cases it is a better solution than basic
asm. However, there are two situations where only basic asm can be used:
• Extended asm statements have to be inside a C function, so to write inline assembly
language at file scope (“top-level”), outside of C functions, you must use basic asm. You
can use this technique to emit assembler directives, define assembly language macros
that can be invoked elsewhere in the file, or write entire functions in assembly language.
Basic asm statements outside of functions may not use any qualifiers.
• Functions declared with the naked attribute also require basic asm (see Section 6.33
[Function Attributes], page 556).
Safely accessing C data and calling functions from basic asm is more complex than it may
appear. To access C data, it is better to use extended asm.
Do not expect a sequence of asm statements to remain perfectly consecutive after compila-
tion. If certain instructions need to remain consecutive in the output, put them in a single
Chapter 6: Extensions to the C Language Family 657
multi-instruction asm statement. Note that GCC’s optimizers can move asm statements
relative to other code, including across jumps.
asm statements may not perform jumps into other asm statements. GCC does not know
about these jumps, and therefore cannot take account of them when deciding how to opti-
mize. Jumps from asm to C labels are only supported in extended asm.
Under certain circumstances, GCC may duplicate (or remove duplicates of) your assem-
bly code when optimizing. This can lead to unexpected duplicate symbol errors during
compilation if your assembly code defines symbols or labels.
Warning: The C standards do not specify semantics for asm, making it a potential source
of incompatibilities between compilers. These incompatibilities may not produce compiler
warnings/errors.
GCC does not parse basic asm’s AssemblerInstructions, which means there is no way to
communicate to the compiler what is happening inside them. GCC has no visibility of
symbols in the asm and may discard them as unreferenced. It also does not know about
side effects of the assembler code, such as modifications to memory or registers. Unlike
some compilers, GCC assumes that no changes to general purpose registers occur. This
assumption may change in a future release.
To avoid complications from future changes to the semantics and the compatibility issues
between compilers, consider replacing basic asm with extended asm. See How to convert
from basic asm to extended asm for information about how to perform this conversion.
The compiler copies the assembler instructions in a basic asm verbatim to the assembly
language output file, without processing dialects or any of the ‘%’ operators that are available
with extended asm. This results in minor differences between basic asm strings and extended
asm templates. For example, to refer to registers you might use ‘%eax’ in basic asm and
‘%%eax’ in extended asm.
On targets such as x86 that support multiple assembler dialects, all basic asm blocks
use the assembler dialect specified by the ‘-masm’ command-line option (see Section 3.19.58
[x86 Options], page 465). Basic asm provides no mechanism to provide different assembler
strings for different dialects.
For basic asm with non-empty assembler string GCC assumes the assembler block does
not change any general purpose registers, but it may read or write any globally accessible
variable.
Here is an example of basic asm for i386:
/* Note that this code will not compile with -masm=intel */
#define DebugBreak() asm("int $3")
[ : Clobbers ] ])
Qualifiers
volatile The typical use of extended asm statements is to manipulate input values to
produce output values. However, your asm statements may also produce side
effects. If so, you may need to use the volatile qualifier to disable certain
optimizations. See [Volatile], page 659.
inline If you use the inline qualifier, then for inlining purposes the size of the asm
statement is taken as the smallest size possible (see Section 6.47.6 [Size of an
asm], page 710).
goto This qualifier informs the compiler that the asm statement may perform a jump
to one of the labels listed in the GotoLabels. See [GotoLabels], page 671.
Parameters
AssemblerTemplate
This is a literal string that is the template for the assembler code. It is a
combination of fixed text and tokens that refer to the input, output, and goto
parameters. See [AssemblerTemplate], page 661.
OutputOperands
A comma-separated list of the C variables modified by the instructions in
the AssemblerTemplate. An empty list is permitted. See [OutputOperands],
page 662.
InputOperands
A comma-separated list of C expressions read by the instructions in the
AssemblerTemplate. An empty list is permitted. See [InputOperands],
page 667.
Clobbers A comma-separated list of registers or other values changed by the
AssemblerTemplate, beyond those listed as outputs. An empty list is
permitted. See [Clobbers and Scratch Registers], page 668.
GotoLabels
When you are using the goto form of asm, this section contains the list of
all C labels to which the code in the AssemblerTemplate may jump. See
[GotoLabels], page 671.
Chapter 6: Extensions to the C Language Family 659
asm statements may not perform jumps into other asm statements, only to the
listed GotoLabels. GCC’s optimizers do not know about other jumps; therefore
they cannot take account of them when deciding how to optimize.
The total number of input + output + goto operands is limited to 30.
Remarks
The asm statement allows you to include assembly instructions directly within C code.
This may help you to maximize performance in time-sensitive code or to access assembly
instructions that are not readily available to C programs.
Note that extended asm statements must be inside a function. Only basic asm may be
outside functions (see Section 6.47.1 [Basic Asm], page 656). Functions declared with the
naked attribute also require basic asm (see Section 6.33 [Function Attributes], page 556).
While the uses of asm are many and varied, it may help to think of an asm statement as
a series of low-level instructions that convert input parameters to output parameters. So a
simple (if not particularly useful) example for i386 using asm might look like this:
int src = 1;
int dst;
printf("%d\n", dst);
This code copies src to dst and add 1 to dst.
6.47.2.1 Volatile
GCC’s optimizers sometimes discard asm statements if they determine there is no need for
the output variables. Also, the optimizers may move code out of loops if they believe that
the code will always return the same result (i.e. none of its input values change between
calls). Using the volatile qualifier disables these optimizations. asm statements that have
no output operands and asm goto statements, are implicitly volatile.
This i386 code demonstrates a case that does not use (or require) the volatile quali-
fier. If it is performing assertion checking, this code uses asm to perform the validation.
Otherwise, dwRes is unreferenced by any code. As a result, the optimizers can discard the
asm statement, which in turn removes the need for the entire DoCheck routine. By omitting
the volatile qualifier when it isn’t needed you allow the optimizers to produce the most
efficient code possible.
void DoCheck(uint32_t dwSomeValue)
{
uint32_t dwRes;
: "r" (dwSomeValue)
: "cc");
// Do other work...
:
: "rdx");
Since GCC does not parse the assembler template, it has no visibility of any symbols it
references. This may result in GCC discarding those symbols as unreferenced unless they
are also listed as input, output, or goto operands.
return old;
Operands are separated by commas. Each operand has this format:
[ [asmSymbolicName] ] constraint (cvariablename)
asmSymbolicName
Specifies a symbolic name for the operand. Reference the name in the assembler
template by enclosing it in square brackets (i.e. ‘%[Value]’). The scope of the
name is the asm statement that contains the definition. Any valid C variable
name is acceptable, including names already defined in the surrounding code.
No two operands within the same asm statement can use the same symbolic
name.
When not using an asmSymbolicName, use the (zero-based) position of the
operand in the list of operands in the assembler template. For example if there
are three output operands, use ‘%0’ in the template to refer to the first, ‘%1’ for
the second, and ‘%2’ for the third.
constraint A string constant specifying constraints on the placement of the operand; See
Section 6.47.3 [Constraints], page 677, for details.
Output constraints must begin with either ‘=’ (a variable overwriting an exist-
ing value) or ‘+’ (when reading and writing). When using ‘=’, do not assume
the location contains the existing value on entry to the asm, except when the
operand is tied to an input; see [Input Operands], page 667.
After the prefix, there must be one or more additional constraints (see
Section 6.47.3 [Constraints], page 677) that describe where the value resides.
Common constraints include ‘r’ for register and ‘m’ for memory. When you list
more than one possible location (for example, "=rm"), the compiler chooses
the most efficient one based on the current context. If you list as many
alternates as the asm statement allows, you permit the optimizers to produce
the best possible code. If you must use a specific register, but your Machine
Constraints do not provide sufficient control to select the specific register you
want, local register variables may provide a solution (see Section 6.47.5.2
[Local Register Variables], page 709).
664 Using the GNU Compiler Collection (GCC)
cvariablename
Specifies a C lvalue expression to hold the output, typically a variable name.
The enclosing parentheses are a required part of the syntax.
When the compiler selects the registers to use to represent the output operands, it does
not use any of the clobbered registers (see [Clobbers and Scratch Registers], page 668).
Output operand expressions must be lvalues. The compiler cannot check whether the
operands have data types that are reasonable for the instruction being executed. For output
expressions that are not directly addressable (for example a bit-field), the constraint must
allow a register. In that case, GCC uses the register as the output of the asm, and then
stores that register into the output.
Operands using the ‘+’ constraint modifier count as two operands (that is, both as input
and output) towards the total maximum of 30 operands per asm statement.
Use the ‘&’ constraint modifier (see Section 6.47.3.3 [Modifiers], page 680) on all output
operands that must not overlap an input. Otherwise, GCC may allocate the output operand
in the same register as an unrelated input operand, on the assumption that the assembler
code consumes its inputs before producing outputs. This assumption may be false if the
assembler code actually consists of more than one instruction.
The same problem can occur if one output parameter (a) allows a register constraint
and another output parameter (b) allows a memory constraint. The code generated by
GCC to access the memory address in b can contain registers which might be shared by a,
and GCC considers those registers to be inputs to the asm. As above, GCC assumes that
such input registers are consumed before any outputs are written. This assumption may
result in incorrect behavior if the asm statement writes to a before using b. Combining the
‘&’ modifier with the register constraint on a ensures that modifying a does not affect the
address referenced by b. Otherwise, the location of b is undefined if a is modified before
using b.
asm supports operand modifiers on operands (for example ‘%k2’ instead of simply ‘%2’).
Typically these qualifiers are hardware dependent. The list of supported modifiers for x86
is found at [x86Operandmodifiers], page 673.
If the C code that follows the asm makes no use of any of the output operands, use
volatile for the asm statement to prevent the optimizers from discarding the asm statement
as unneeded (see [Volatile], page 659).
This code makes no use of the optional asmSymbolicName. Therefore it references the
first output operand as %0 (were there a second, it would be %1, etc). The number of the
first input operand is one greater than that of the last output operand. In this i386 example,
that makes Mask referenced as %1:
uint32_t Mask = 1234;
uint32_t Index;
to pick the register to use, which can result in more efficient code. This may not be possible
if an assembler instruction requires a specific register.
The following i386 example uses the asmSymbolicName syntax. It produces the same
result as the code above, but some may consider it more readable or more maintainable
since reordering index numbers is not necessary when adding or removing operands. The
names aIndex and aMask are only used in this example to emphasize which names get used
where. It is acceptable to reuse the names Index and Mask.
uint32_t Mask = 1234;
uint32_t Index;
na
nae
nb
nbe
nc
ne
ng
nge
nl
nle
no
np
ns
nz “not” flag, or inverted versions of those above
cexpression
This is the C variable or expression being passed to the asm statement as input.
The enclosing parentheses are a required part of the syntax.
When the compiler selects the registers to use to represent the input operands, it does
not use any of the clobbered registers (see [Clobbers and Scratch Registers], page 668).
If there are no output operands but there are input operands, place two consecutive colons
where the output operands would go:
__asm__ ("some instructions"
: /* No outputs. */
: "r" (Offset / 8));
Warning: Do not modify the contents of input-only operands (except for inputs tied
to outputs). The compiler assumes that on exit from the asm statement these operands
contain the same values as they had before executing the statement. It is not possible
to use clobbers to inform the compiler that the values in these inputs are changing. One
common work-around is to tie the changing input variable to an output variable that never
gets used. Note, however, that if the code that follows the asm statement makes no use
of any of the output operands, the GCC optimizers may discard the asm statement as
unneeded (see [Volatile], page 659).
asm supports operand modifiers on operands (for example ‘%k2’ instead of simply ‘%2’).
Typically these qualifiers are hardware dependent. The list of supported modifiers for x86
is found at [x86Operandmodifiers], page 673.
In this example using the fictitious combine instruction, the constraint "0" for input
operand 1 says that it must occupy the same location as output operand 0. Only input
operands may use numbers in constraints, and they must each refer to an output operand.
Only a number (or the symbolic assembler name) in the constraint can guarantee that one
operand is in the same place as another. The mere fact that foo is the value of both operands
is not enough to guarantee that they are in the same place in the generated assembler code.
asm ("combine %2, %0"
: "=r" (foo)
: "0" (foo), "g" (bar));
Here is an example using symbolic names.
asm ("cmoveq %1, %2, %[result]"
: [result] "=r"(result)
: "r" (test), "r" (new), "[result]" (old));
listing that register in the clobber list. Variables declared to live in specific registers (see
Section 6.47.5 [Explicit Register Variables], page 707) and used as asm input or output
operands must have no part mentioned in the clobber description. In particular, there is
no way to specify that input operands get modified without also specifying them as output
operands.
When the compiler selects which registers to use to represent input and output operands,
it does not use any of the clobbered registers. As a result, clobbered registers are available
for any use in the assembler code.
Another restriction is that the clobber list should not contain the stack pointer register.
This is because the compiler requires the value of the stack pointer to be the same after
an asm statement as it was on entry to the statement. However, previous versions of GCC
did not enforce this rule and allowed the stack pointer to appear in the list, with unclear
semantics. This behavior is deprecated and listing the stack pointer may become an error
in future versions of GCC.
Here is a realistic example for the VAX showing the use of clobbered registers:
asm volatile ("movc3 %0, %1, %2"
: /* No outputs. */
: "g" (from), "g" (to), "g" (count)
: "r0", "r1", "r2", "r3", "r4", "r5", "memory");
Also, there are two special clobber arguments:
"cc" The "cc" clobber indicates that the assembler code modifies the flags register.
On some machines, GCC represents the condition codes as a specific hardware
register; "cc" serves to name this register. On other machines, condition code
handling is different, and specifying "cc" has no effect. But it is valid no matter
what the target.
"memory" The "memory" clobber tells the compiler that the assembly code performs mem-
ory reads or writes to items other than those listed in the input and output
operands (for example, accessing the memory pointed to by one of the input
parameters). To ensure memory contains correct values, GCC may need to
flush specific register values to memory before executing the asm. Further, the
compiler does not assume that any values read from memory before an asm re-
main unchanged after that asm; it reloads them as needed. Using the "memory"
clobber effectively forms a read/write memory barrier for the compiler.
Note that this clobber does not prevent the processor from doing speculative
reads past the asm statement. To prevent that, you need processor-specific
fence instructions.
Flushing registers to memory has performance implications and may be an issue for time-
sensitive code. You can provide better information to GCC to avoid this, as shown in the
following examples. At a minimum, aliasing rules allow GCC to know what memory doesn’t
need to be flushed.
Here is a fictitious sum of squares instruction, that takes two pointers to floating point
values in memory and produces a floating point register output. Notice that x, and y both
appear twice in the asm parameters, once to specify memory accessed, and once to specify
a base register used by the asm. You won’t normally be wasting a register by doing this as
670 Using the GNU Compiler Collection (GCC)
GCC can use the same register for both purposes. However, it would be foolish to use both
%1 and %3 for x in this asm and expect them to be the same. In fact, %3 may well not be a
register. It might be a symbolic memory reference to the object pointed to by x.
asm ("sumsq %0, %1, %2"
: "+f" (result)
: "r" (x), "r" (y), "m" (*x), "m" (*y));
Here is a fictitious *z++ = *x++ * *y++ instruction. Notice that the x, y and z pointer
registers must be specified as input/output because the asm modifies them.
asm ("vecmul %0, %1, %2"
: "+r" (z), "+r" (x), "+r" (y), "=m" (*z)
: "m" (*x), "m" (*y));
An x86 example where the string memory argument is of unknown length.
asm("repne scasb"
: "=c" (count), "+D" (p)
: "m" (*(const char (*)[]) p), "0" (-1), "a" (0));
If you know the above will only be reading a ten byte array then you could instead use
a memory input like: "m" (*(const char (*)[10]) p).
Here is an example of a PowerPC vector scale implemented in assembly, complete with
vector and condition code clobbers, and some initialized offset registers that are unchanged
by the asm.
void
dscal (size_t n, double *x, double alpha)
{
asm ("/* lots of asm here */"
: "+m" (*(double (*)[n]) x), "+&r" (n), "+b" (x)
: "d" (alpha), "b" (32), "b" (48), "b" (64),
"b" (80), "b" (96), "b" (112)
: "cr0",
"vs32","vs33","vs34","vs35","vs36","vs37","vs38","vs39",
"vs40","vs41","vs42","vs43","vs44","vs45","vs46","vs47");
}
Rather than allocating fixed registers via clobbers to provide scratch registers for an asm
statement, an alternative is to define a variable and make it an early-clobber output as with
a2 and a3 in the example below. This gives the compiler register allocator more freedom.
You can also define a variable and make it an output tied to an input as with a0 and a1,
tied respectively to ap and lda. Of course, with tied outputs your asm can’t use the input
value after modifying the output register since they are one and the same register. What’s
more, if you omit the early-clobber on the output, it is possible that GCC might allocate
the same register to another of the inputs if GCC could prove they had the same value on
entry to the asm. This is why a1 has an early-clobber. Its tied input, lda might conceivably
be known to have the value 16 and without an early-clobber share the same register as %11.
On the other hand, ap can’t be the same as any of the other inputs, so an early-clobber
on a0 is not needed. It is also not desirable in this case. An early-clobber on a0 would
cause GCC to allocate a separate register for the "m" (*(const double (*)[]) ap) input.
Note that tying an input to an output is the way to set up an initialized temporary register
modified by an asm statement. An input not tied to an output is assumed by GCC to be
unchanged, for example "b" (16) below sets up %11 to 16, and GCC might use that register
in following code if the value 16 happened to be needed. You can even use a normal asm
output for a scratch if all inputs that might share the same register are consumed before
Chapter 6: Extensions to the C Language Family 671
the scratch is used. The VSX registers clobbered by the asm statement could have used this
technique except for GCC’s limit on the number of asm parameters.
static void
dgemv_kernel_4x4 (long n, const double *ap, long lda,
const double *x, double *y, double alpha)
{
double *a0;
double *a1;
double *a2;
double *a3;
__asm__
(
/* lots of asm here */
"#n=%1 ap=%8=%12 lda=%13 x=%7=%10 y=%0=%2 alpha=%9 o16=%11\n"
"#a0=%3 a1=%4 a2=%5 a3=%6"
:
"+m" (*(double (*)[n]) y),
"+&r" (n), // 1
"+b" (y), // 2
"=b" (a0), // 3
"=&b" (a1), // 4
"=&b" (a2), // 5
"=&b" (a3) // 6
:
"m" (*(const double (*)[n]) x),
"m" (*(const double (*)[]) ap),
"d" (alpha), // 9
"r" (x), // 10
"b" (16), // 11
"3" (ap), // 12
"4" (lda) // 13
:
"cr0",
"vs32","vs33","vs34","vs35","vs36","vs37",
"vs40","vs41","vs42","vs43","vs44","vs45","vs46","vs47"
);
}
and output one. With this modifier you will have the correct values on all possible paths
from the asm goto.
To reference a label in the assembler template, prefix it with ‘%l’ (lowercase ‘L’) followed
by its (zero-based) position in GotoLabels plus the number of input and output operands.
Output operand with constraint modifier ‘+’ is counted as two operands because it is con-
sidered as one output and one input operand. For example, if the asm has three inputs,
one output operand with constraint modifier ‘+’ and one output operand with constraint
modifier ‘=’ and references two labels, refer to the first label as ‘%l6’ and the second as
‘%l7’).
Alternately, you can reference labels using the actual C label name enclosed in brackets.
For example, to reference a label named carry, you can use ‘%l[carry]’. The label must
still be listed in the GotoLabels section when using this approach. It is better to use the
named references for labels as in this case you can avoid counting input and output operands
and special treatment of output operands with constraint modifier ‘+’.
Here is an example of asm goto for i386:
asm goto (
"btl %1, %0\n\t"
"jc %l2"
: /* No outputs. */
: "r" (p1), "r" (p2)
: "cc"
: carry);
return 0;
carry:
return 1;
The following example shows an asm goto that uses a memory clobber.
int frob(int x)
{
int y;
asm goto ("frob %%r5, %1; jc %l[error]; mov (%2), %%r5"
: /* No outputs. */
: "r"(x), "r"(&y)
: "r5", "memory"
: error);
return y;
error:
return -1;
}
The following example shows an asm goto that uses an output.
int foo(int count)
{
asm goto ("dec %0; jb %l[stop]"
: "+r" (count)
Chapter 6: Extensions to the C Language Family 673
:
:
: stop);
return count;
stop:
return 0;
}
The following artificial example shows an asm goto that sets up an output only on one
path inside the asm goto. Usage of constraint modifier = instead of + would be wrong as
factor is used on all paths from the asm goto.
int foo(int inp)
{
int factor = 0;
asm goto ("cmp %1, 10; jb %l[lab]; mov 2, %0"
: "+r" (factor)
: "r" (inp)
:
: lab);
lab:
return inp * factor; /* return 2 * inp or 0 if inp < 10 */
}
top:
With no modifiers, this is what the output from the operands would be for the ‘att’ and
‘intel’ dialects of assembler:
To prevent this from happening, if any input operand uses the ‘f’ constraint, all output
register constraints must use the ‘&’ early-clobber modifier.
The example above is correctly written as:
asm ("foo" : "=&t" (a) : "f" (b));
3. Some operands need to be in particular places on the stack. All output operands fall
in this category—GCC has no other way to know which registers the outputs appear
in unless you indicate this in the constraints.
Output operands must specifically indicate which register an output appears in after
an asm. ‘=f’ is not allowed: the operand constraints must select a class with a single
register.
4. Output operands may not be “inserted” between existing stack registers. Since no 387
opcode uses a read/write operand, all output operands are dead before the asm, and are
pushed by the asm. It makes no sense to push anywhere but the top of the reg-stack.
Output operands must start at the top of the reg-stack: output operands may not
“skip” a register.
5. Some asm statements may need extra stack space for internal calculations. This can
be guaranteed by clobbering stack registers unrelated to the inputs and outputs.
This asm takes one input, which is internally popped, and produces two outputs.
asm ("fsincos" : "=t" (cos), "=u" (sin) : "0" (inp));
This asm takes two inputs, which are popped by the fyl2xp1 opcode, and replaces them
with one output. The st(1) clobber is necessary for the compiler to know that fyl2xp1
pops both inputs.
asm ("fyl2xp1" : "=t" (result) : "0" (x), "u" (y) : "st(1)");
Modifier Description
A Select low 16-bits of the constant/register/memory operand.
B Select high 16-bits of the constant/register/memory operand.
C Select bits 32-47 of the constant/register/memory operand.
D Select bits 48-63 of the constant/register/memory operand.
H Equivalent to B (for backwards compatibility).
I Print the inverse (logical NOT) of the constant value.
J Print an integer without a # prefix.
L Equivalent to A (for backwards compatibility).
O Offset of the current frame from the top of the stack.
Q Use the A instruction postfix.
R Inverse of condition code, for unsigned comparisons.
W Subtract 16 from the constant value.
X Use the X instruction postfix.
Y Subtract 4 from the constant value.
Z Subtract 1 from the constant value.
b Append .B, .W or .A to the instruction, depending on the mode.
Chapter 6: Extensions to the C Language Family 677
‘g’ Any register, memory or immediate integer operand is allowed, except for reg-
isters that are not general registers.
‘X’ Any operand whatsoever is allowed.
‘0’, ‘1’, ‘2’, . . . ‘9’
An operand that matches the specified operand number is allowed. If a digit
is used together with letters within the same alternative, the digit should come
last.
This number is allowed to be more than a single digit. If multiple digits are en-
countered consecutively, they are interpreted as a single decimal integer. There
is scant chance for ambiguity, since to-date it has never been desirable that
‘10’ be interpreted as matching either operand 1 or operand 0. Should this be
desired, one can use multiple alternatives instead.
This is called a matching constraint and what it really means is that the assem-
bler has only a single operand that fills two roles which asm distinguishes. For
example, an add instruction uses two input operands and an output operand,
but on most CISC machines an add instruction really has only two operands,
one of them an input-output operand:
addl #35,r12
Matching constraints are used in these circumstances. More precisely, the two
operands that match must include one input-only operand and one output-only
operand. Moreover, the digit must be a smaller number than the number of
the operand that uses it in the constraint.
‘p’ An operand that is a valid memory address is allowed. This is for “load address”
and “push address” instructions.
‘p’ in the constraint must be accompanied by address_operand as the predicate
in the match_operand. This predicate interprets the mode specified in the
match_operand as the mode of the memory reference for which the address
would be valid.
other-letters
Other letters can be defined in machine-dependent fashion to stand for par-
ticular classes of registers or other arbitrary operand types. ‘d’, ‘a’ and ‘f’
are defined on the 68000/68020 to stand for data, address and floating point
registers.
So the first alternative for the 68000’s logical-or could be written as "+m" (output)
: "ir" (input). The second could be "+r" (output): "irm" (input). However, the
fact that two memory locations cannot be used in a single instruction prevents simply
using "+rm" (output) : "irm" (input). Using multi-alternatives, this might be written
as "+m,r" (output) : "ir,irm" (input). This describes all the available alternatives to
the compiler, allowing it to choose the most efficient one for the current conditions.
There is no way within the template to determine which alternative was chosen. However
you may be able to wrap your asm statements with builtins such as __builtin_constant_p
to achieve the desired results.
GCC can only handle one commutative pair in an asm; if you use more, the
compiler may fail. Note that you need not use the modifier if the two alterna-
tives are strictly identical; this would only waste time in the reload pass.
Ush The high part (bits 12 and upwards) of the pc-relative address of a
symbol within 4GB of the instruction
Q A memory address which uses a single base register with no offset
Ump A memory address suitable for a load/store pair instruction in SI,
DI, SF and DF modes
AMD GCN —‘config/gcn/constraints.md’
I Immediate integer in the range −16 to 64
J Immediate 16-bit signed integer
Kf Immediate constant −1
L Immediate 15-bit unsigned integer
A Immediate constant that can be inlined in an instruction encod-
ing: integer −16..64, or float 0.0, +/−0.5, +/−1.0, +/−2.0, +/−4.0,
1.0/(2.0*PI)
B Immediate 32-bit signed integer that can be attached to an instruc-
tion encoding
C Immediate 32-bit integer in range −16..4294967295 (i.e. 32-bit un-
signed integer or ‘A’ constraint)
DA Immediate 64-bit constant that can be split into two ‘A’ constants
DB Immediate 64-bit constant that can be split into two ‘B’ constants
U Any unspec
Y Any symbol_ref or label_ref
v VGPR register
Sg SGPR register
SD SGPR registers valid for instruction destinations, including VCC,
M0 and EXEC
SS SGPR registers valid for instruction sources, including VCC, M0,
EXEC and SCC
Sm SGPR registers valid as a source for scalar memory instructions
(excludes M0 and EXEC)
Sv SGPR registers valid as a source or destination for vector instruc-
tions (excludes EXEC)
ca All condition registers: SCC, VCCZ, EXECZ
cs Scalar condition register: SCC
cV Vector condition register: VCC, VCC LO, VCC HI
e EXEC register (EXEC LO and EXEC HI)
RB Memory operand with address space suitable for buffer_* instruc-
tions
Chapter 6: Extensions to the C Language Family 683
y HI and LO registers.
l LO register.
h HI register.
v Vector registers.
z Stack pointer register (SP).
Q A memory address which uses a base register with a short offset or
with a index register with its scale.
W A memory address which uses a base register with a index register
with its scale.
Epiphany—‘config/epiphany/constraints.md’
U16 An unsigned 16-bit constant.
K An unsigned 5-bit constant.
L A signed 11-bit constant.
Cm1 A signed 11-bit constant added to −1. Can only match when the
‘-m1reg-reg’ option is active.
Cl1 Left-shift of −1, i.e., a bit mask with a block of leading ones, the
rest being a block of trailing zeroes. Can only match when the
‘-m1reg-reg’ option is active.
Cr1 Right-shift of −1, i.e., a bit mask with a trailing block of ones, the
rest being zeroes. Or to put it another way, one less than a power
of two. Can only match when the ‘-m1reg-reg’ option is active.
Cal Constant for arithmetic/logical operations. This is like i, except
that for position independent code, no symbols / expressions need-
ing relocations are allowed.
Csy Symbolic constant for call/jump instruction.
Rcs The register class usable in short insns. This is a register class
constraint, and can thus drive register allocation. This constraint
won’t match unless ‘-mprefer-short-insn-regs’ is in effect.
Rsc The the register class of registers that can be used to hold a sibcall
call address. I.e., a caller-saved register.
Rct Core control register class.
Rgs The register group usable in short insns. This constraint does not
use a register class, so that it only passively matches suitable reg-
isters, and doesn’t drive register allocation.
Rra Matches the return address if it can be replaced with the link reg-
ister.
Rcc Matches the integer condition code register.
Sra Matches the return address if it is in a stack slot.
688 Using the GNU Compiler Collection (GCC)
Cfm Matches control register values to switch fp mode, which are en-
capsulated in UNSPEC_FP_MODE.
FRV—‘config/frv/frv.h’
a Register in the class ACC_REGS (acc0 to acc7).
b Register in the class EVEN_ACC_REGS (acc0 to acc7).
c Register in the class CC_REGS (fcc0 to fcc3 and icc0 to icc3).
d Register in the class GPR_REGS (gr0 to gr63).
e Register in the class EVEN_REGS (gr0 to gr63). Odd registers are
excluded not in the class but through the use of a machine mode
larger than 4 bytes.
f Register in the class FPR_REGS (fr0 to fr63).
h Register in the class FEVEN_REGS (fr0 to fr63). Odd registers are
excluded not in the class but through the use of a machine mode
larger than 4 bytes.
l Register in the class LR_REG (the lr register).
q Register in the class QUAD_REGS (gr2 to gr63). Register numbers
not divisible by 4 are excluded not in the class but through the use
of a machine mode larger than 8 bytes.
t Register in the class ICC_REGS (icc0 to icc3).
u Register in the class FCC_REGS (fcc0 to fcc3).
v Register in the class ICR_REGS (cc4 to cc7).
w Register in the class FCR_REGS (cc0 to cc3).
x Register in the class QUAD_FPR_REGS (fr0 to fr63). Register num-
bers not divisible by 4 are excluded not in the class but through
the use of a machine mode larger than 8 bytes.
z Register in the class SPR_REGS (lcr and lr).
A Register in the class QUAD_ACC_REGS (acc0 to acc7).
B Register in the class ACCG_REGS (accg0 to accg7).
C Register in the class CR_REGS (cc0 to cc7).
G Floating point constant zero
I 6-bit signed integer constant
J 10-bit signed integer constant
L 16-bit signed integer constant
M 16-bit unsigned integer constant
N 12-bit signed integer constant that is negative—i.e. in the range of
−2048 to −1
Chapter 6: Extensions to the C Language Family 689
O Constant zero
P 12-bit signed integer constant that is greater than zero—i.e. in the
range of 1 to 2047.
FT32—‘config/ft32/constraints.md’
A An absolute address
B An offset address
W A register indirect memory operand
e An offset address.
f An offset address.
O The constant zero or one
I A 16-bit signed constant (−32768 . . . 32767)
w A bitfield mask suitable for bext or bins
x An inverted bitfield mask suitable for bext or bins
L A 16-bit unsigned constant, multiple of 4 (0 . . . 65532)
S A 20-bit signed constant (−524288 . . . 524287)
b A constant for a bitfield width (1 . . . 16)
KA A 10-bit signed constant (−512 . . . 511)
Hewlett-Packard PA-RISC—‘config/pa/pa.h’
a General register 1
f Floating point register
q Shift amount register
x Floating point register (deprecated)
y Upper floating point register (32-bit), floating point register (64-
bit)
Z Any register
I Signed 11-bit integer constant
J Signed 14-bit integer constant
K Integer constant that can be deposited with a zdepi instruction
L Signed 5-bit integer constant
M Integer constant 0
N Integer constant that can be loaded with a ldil instruction
O Integer constant whose value plus one is a power of 2
P Integer constant that can be used for and operations in depi and
extru instructions
690 Using the GNU Compiler Collection (GCC)
S Integer constant 31
U Integer constant 63
G Floating-point constant 0.0
A A lo_sum data-linkage-table memory operand
Q A memory operand that can be used as the destination operand of
an integer store instruction
R A scaled or unscaled indexed memory operand
T A memory operand for floating-point loads and stores
W A register indirect memory operand
Intel IA-64—‘config/ia64/ia64.h’
a General register r0 to r3 for addl instruction
b Branch register
c Predicate register (‘c’ as in “conditional”)
d Application register residing in M-unit
e Application register residing in I-unit
f Floating-point register
m Memory operand. If used together with ‘<’ or ‘>’, the operand can
have postincrement and postdecrement which require printing with
‘%Pn’ on IA-64.
G Floating-point constant 0.0 or 1.0
I 14-bit signed integer constant
J 22-bit signed integer constant
K 8-bit signed integer constant for logical instructions
L 8-bit adjusted signed integer constant for compare pseudo-ops
M 6-bit unsigned integer constant for shift counts
N 9-bit signed integer constant for load and store postincrements
O The constant zero
P 0 or −1 for dep instruction
Q Non-volatile memory for floating-point loads and stores
R Integer constant in the range 1 to 4 for shladd instruction
S Memory operand except postincrement and postdecrement. This
is now roughly the same as ‘m’ when not used together with ‘<’ or
‘>’.
Chapter 6: Extensions to the C Language Family 691
M32C—‘config/m32c/m32c.cc’
Rsp
Rfb
Rsb ‘$sp’, ‘$fb’, ‘$sb’.
Rcr Any control register, when they’re 16 bits wide (nothing if control
registers are 24 bits wide)
Rcl Any control register, when they’re 24 bits wide.
R0w
R1w
R2w
R3w $r0, $r1, $r2, $r3.
R02 $r0 or $r2, or $r2r0 for 32 bit values.
R13 $r1 or $r3, or $r3r1 for 32 bit values.
Rdi A register that can hold a 64 bit value.
Rhl $r0 or $r1 (registers with addressable high/low bytes)
R23 $r2 or $r3
Raa Address registers
Raw Address registers when they’re 16 bits wide.
Ral Address registers when they’re 24 bits wide.
Rqi Registers that can hold QI values.
Rad Registers that can be used with displacements ($a0, $a1, $sb).
Rsi Registers that can hold 32 bit values.
Rhi Registers that can hold 16 bit values.
Rhc Registers chat can hold 16 bit values, including all control registers.
Rra $r0 through R1, plus $a0 and $a1.
Rfl The flags register.
Rmm The memory-based pseudo-registers $mem0 through $mem15.
Rpi Registers that can hold pointers (16 bit registers for r8c, m16c; 24
bit registers for m32cm, m32c).
Rpa Matches multiple registers in a PARALLEL to form a larger regis-
ter. Used to match function return values.
Is3 −8 . . . 7
IS1 −128 . . . 127
IS2 −32768 . . . 32767
IU2 0 . . . 65535
692 Using the GNU Compiler Collection (GCC)
In4 −8 . . . −1 or 1 . . . 8
In5 −16 . . . −1 or 1 . . . 16
In6 −32 . . . −1 or 1 . . . 32
IM2 −65536 . . . −1
Ilb An 8 bit value with exactly one bit set.
Ilw A 16 bit value with exactly one bit set.
Sd The common src/dest memory addressing modes.
Sa Memory addressed using $a0 or $a1.
Si Memory addressed with immediate addresses.
Ss Memory addressed using the stack pointer ($sp).
Sf Memory addressed using the frame base register ($fb).
Ss Memory addressed using the small base register ($sb).
S1 $r1h
LoongArch—‘config/loongarch/constraints.md’
f A floating-point register (if available).
k A memory operand whose address is formed by a base register and
(optionally scaled) index register.
l A signed 16-bit constant.
m A memory operand whose address is formed by a base register
and offset that is suitable for use in instructions with the same
addressing mode as st.w and ld.w.
I A signed 12-bit constant (for arithmetic instructions).
K An unsigned 12-bit constant (for logic instructions).
ZB An address that is held in a general-purpose register. The offset is
zero.
ZC A memory operand whose address is formed by a base register
and offset that is suitable for use in instructions with the same
addressing mode as ll.w and sc.w.
MicroBlaze—‘config/microblaze/constraints.md’
d A general register (r0 to r31).
z A status register (rmsr, $fcc1 to $fcc7).
MIPS—‘config/mips/constraints.md’
d A general-purpose register. This is equivalent to r unless generating
MIPS16 code, in which case the MIPS16 register set is used.
f A floating-point register (if available).
Chapter 6: Extensions to the C Language Family 693
Xstormy16—‘config/stormy16/stormy16.h’
a Register r0.
b Register r1.
c Register r2.
d Register r8.
e Registers r0 through r7.
t Registers r0 and r1.
y The carry register.
z Registers r8 and r9.
I A constant between 0 and 3 inclusive.
J A constant that has exactly one bit set.
K A constant that has exactly one bit clear.
L A constant between 0 and 255 inclusive.
M A constant between −255 and 0 inclusive.
N A constant between −3 and 0 inclusive.
O A constant between 1 and 4 inclusive.
P A constant between −4 and −1 inclusive.
Q A memory reference that is a stack push.
R A memory reference that is a stack pop.
S A memory reference that refers to a constant address of known
value.
T The register indicated by Rx (not implemented yet).
U A constant that is not between 2 and 15 inclusive.
Z The constant 0.
Xtensa—‘config/xtensa/constraints.md’
a General-purpose 32-bit register
b One-bit boolean register
A MAC16 40-bit accumulator register
I Signed 12-bit integer constant, for use in MOVI instructions
J Signed 8-bit integer constant, for use in ADDI instructions
K Integer constant valid for BccI instructions
L Unsigned constant valid for BccUI instructions
Chapter 6: Extensions to the C Language Family 707
Registers are a scarce resource on most systems and allowing the compiler to manage
their usage usually results in the best code. However, under special circumstances it can
make sense to reserve some globally. For example this may be useful in programs such as
programming language interpreters that have a couple of global variables that are accessed
very often.
After defining a global register variable, for the current compilation unit:
• If the register is a call-saved register, call ABI is affected: the register will not be
restored in function epilogue sequences after the variable has been assigned. Therefore,
functions cannot safely return to callers that assume standard ABI.
• Conversely, if the register is a call-clobbered register, making calls to functions that
use standard ABI may lose contents of the variable. Such calls may be created by
the compiler even if none are evident in the original program, for example when libgcc
functions are used to make up for unavailable instructions.
• Accesses to the variable may be optimized as usual and the register remains available
for allocation and use in any computations, provided that observable values of the
variable are not affected.
• If the variable is referenced in inline assembly, the type of access must be provided to
the compiler via constraints (see Section 6.47.3 [Constraints], page 677). Accesses from
basic asms are not supported.
Note that these points only apply to code that is compiled with the definition. The
behavior of code that is merely linked in (for example code from libraries) is not affected.
If you want to recompile source files that do not actually use your global register variable
so they do not use the specified register for any other purpose, you need not actually add
the global register declaration to their source code. It suffices to specify the compiler option
‘-ffixed-reg’ (see Section 3.17 [Code Gen Options], page 270) to reserve the register.
the system library routines may temporarily use the register for other things. Furthermore,
since the register is not reserved exclusively for the variable, accessing it from handlers of
asynchronous signals may observe unrelated temporary values residing in the register.
On most machines, longjmp restores to each global register variable the value it had at
the time of the setjmp. On some machines, however, longjmp does not change the value
of global register variables. To be portable, the function that called setjmp should make
other arrangements to save the values of the global register variables, and to restore them
in a longjmp. This way, the same thing happens regardless of what longjmp does.
#ifndef __GNUC__
#define __asm__ asm
#endif
‘-pedantic’ and other options cause warnings for many GNU C extensions. You can pre-
vent such warnings within one expression by writing __extension__ before the expression.
__extension__ has no effect aside from this.
class a {
public:
void sub (int i)
{
printf ("__FUNCTION__ = %s\n", __FUNCTION__);
printf ("__PRETTY_FUNCTION__ = %s\n", __PRETTY_FUNCTION__);
}
};
int
main (void)
712 Using the GNU Compiler Collection (GCC)
{
a ax;
ax.sub (0);
return 0;
}
gives this output:
__FUNCTION__ = sub
__PRETTY_FUNCTION__ = void a::sub(int)
These identifiers are variables, not preprocessor macros, and may not be used to initialize
char arrays or be concatenated with string literals.
type V4SI and your architecture does not allow for this specific SIMD type, GCC produces
code that uses 4 SIs.
The types defined in this manner can be used with a subset of normal C operations.
Currently, GCC allows using the following operators on these types: +, -, *, /, unary
minus, ^, |, &, ~, %.
The operations behave like C++ valarrays. Addition is defined as the addition of the
corresponding elements of the operands. For example, in the code below, each of the 4
elements in a is added to the corresponding 4 elements in b and the resulting vector is
stored in c.
typedef int v4si __attribute__ ((vector_size (16)));
v4si a, b, c;
c = a + b;
Subtraction, multiplication, division, and the logical operations operate in a similar man-
ner. Likewise, the result of using the unary minus or complement operators on a vector type
is a vector whose elements are the negative or complemented values of the corresponding
elements in the operand.
It is possible to use shifting operators <<, >> on integer-type vectors. The operation is
defined as following: {a0, a1, ..., an} >> {b0, b1, ..., bn} == {a0 >> b0, a1 >> b1,
..., an >> bn}. Vector operands must have the same number of elements.
For convenience, it is allowed to use a binary vector operation where one operand is a
scalar. In that case the compiler transforms the scalar operand into a vector where each
element is the scalar from the operation. The transformation happens only if the scalar
could be safely converted to the vector-element type. Consider the following code.
typedef int v4si __attribute__ ((vector_size (16)));
v4si a, b, c;
long l;
a = b + 1; /* a = b + {1,1,1,1}; */
a = 2 * b; /* a = {2,2,2,2} * b; */
v4si a = {1,2,3,4};
v4si b = {3,2,1,4};
Chapter 6: Extensions to the C Language Family 715
v4si c;
v4si a = {1,2,3,4};
v4si b = {5,6,7,8};
v4si mask1 = {0,1,1,3};
v4si mask2 = {0,4,2,5};
v4si res;
same element type as vec1 and vec2 but that has an element count equal to the number of
indices specified.
The index arguments are a list of integers that specify the elements indices of the first two
vectors that should be extracted and returned in a new vector. These element indices are
numbered sequentially starting with the first vector, continuing into the second vector. An
index of -1 can be used to indicate that the corresponding element in the returned vector is
a don’t care and can be freely chosen to optimized the generated code sequence performing
the shuffle operation.
Consider the following example,
typedef int v4si __attribute__ ((vector_size (16)));
typedef int v8si __attribute__ ((vector_size (32)));
v8si a = {1,-2,3,-4,5,-6,7,-8};
v4si b = __builtin_shufflevector (a, a, 0, 2, 4, 6); /* b is {1,3,5,7} */
v4si c = {-2,-4,-6,-8};
v8si d = __builtin_shufflevector (c, b, 4, 0, 5, 1, 6, 2, 7, 3); /* d is a */
Vector conversion is available using the __builtin_convertvector (vec, vectype)
function. vec must be an expression with integral or floating vector type and vectype an
integral or floating vector type with the same number of elements. The result has vectype
type and value of a C cast of every element of vec to the element type of vectype.
Consider the following example,
typedef int v4si __attribute__ ((vector_size (16)));
typedef float v4sf __attribute__ ((vector_size (16)));
typedef double v4df __attribute__ ((vector_size (32)));
typedef unsigned long long v4di __attribute__ ((vector_size (32)));
v4si a = {1,-2,3,-4};
v4sf b = {1.5f,-2.5f,3.f,7.f};
v4di c = {1ULL,5ULL,0ULL,10ULL};
v4sf d = __builtin_convertvector (a, v4sf); /* d is {1.f,-2.f,3.f,-4.f} */
/* Equivalent of:
v4sf d = { (float)a[0], (float)a[1], (float)a[2], (float)a[3] }; */
v4df e = __builtin_convertvector (a, v4df); /* e is {1.,-2.,3.,-4.} */
v4df f = __builtin_convertvector (b, v4df); /* f is {1.5,-2.5,3.,7.} */
v4si g = __builtin_convertvector (f, v4si); /* g is {1,-2,3,7} */
v4si h = __builtin_convertvector (c, v4si); /* h is {1,5,0,10} */
Sometimes it is desirable to write code using a mix of generic vector operations (for clarity)
and machine-specific vector intrinsics (to access vector instructions that are not exposed
via generic built-ins). On x86, intrinsic functions for integer vectors typically use the same
vector type __m128i irrespective of how they interpret the vector, making it necessary to
cast their arguments and return values from/to other vector types. In C, you can make use
of a union type:
#include <immintrin.h>
typedef union {
__m128i mm;
u8x16 u8;
u32x4 u32;
Chapter 6: Extensions to the C Language Family 717
} v128;
for variables that can be used with both built-in operators and x86 intrinsics:
v128 x, y = { 0 };
memcpy (&x, ptr, sizeof x);
y.u8 += 0x80;
x.mm = _mm_adds_epu8 (x.mm, y.mm);
x.u32 &= 0xffffff;
offsetof_member_designator:
identifier
| offsetof_member_designator "." identifier
| offsetof_member_designator "[" expr "]"
This extension is sufficient such that
#define offsetof(type, member) __builtin_offsetof (type, member)
is a suitable definition of the offsetof macro. In C++, type may be dependent. In either
case, member may consist of a single identifier, or a sequence of member accesses and array
references.
In most cases, these built-in functions are considered a full barrier. That is, no memory
operand is moved across the operation, either forward or backward. Further, instructions
are issued as necessary to prevent the processor from speculating loads across the operation
and from queuing stores after the operation.
All of the routines are described in the Intel documentation to take “an optional list
of variables protected by the memory barrier”. It’s not clear what is meant by that; it
could mean that only the listed variables are protected, or it could mean a list of additional
variables to be protected. The list is ignored by GCC which treats it as empty. GCC
interprets an empty list as meaning that all globally accessible variables should be protected.
The object pointed to by the first argument must be of integer or pointer type.
It must not be a boolean type.
Note: GCC 4.4 and later implement __sync_fetch_and_nand as *ptr = ~(tmp
& value) instead of *ptr = ~tmp & value.
built-in function if the specific data type size makes that possible; otherwise, an external call
is left to be resolved at run time. This external call is the same format with the addition of
a ‘size_t’ parameter inserted as the first parameter indicating the size of the object being
pointed to. All objects must be the same size.
There are 6 different memory orders that can be specified. These map to the C++11
memory orders with the same names, see the C++11 standard or the GCC wiki on atomic
synchronization for detailed definitions. Individual targets may also support additional
memory orders for use on specific architectures. Refer to the target documentation for
details of these.
An atomic operation can both constrain code motion and be mapped to hardware instruc-
tions for synchronization between threads (e.g., a fence). To which extent this happens is
controlled by the memory orders, which are listed here in approximately ascending order
of strength. The description of each memory order is only meant to roughly illustrate the
effects and is not a specification; see the C++11 memory model for precise semantics.
__ATOMIC_RELAXED
Implies no inter-thread ordering constraints.
__ATOMIC_CONSUME
This is currently implemented using the stronger __ATOMIC_ACQUIRE memory
order because of a deficiency in C++11’s semantics for memory_order_consume.
__ATOMIC_ACQUIRE
Creates an inter-thread happens-before constraint from the release (or stronger)
semantic store to this acquire load. Can prevent hoisting of code to before the
operation.
__ATOMIC_RELEASE
Creates an inter-thread happens-before constraint to acquire (or stronger) se-
mantic loads that read from this release store. Can prevent sinking of code to
after the operation.
__ATOMIC_ACQ_REL
Combines the effects of both __ATOMIC_ACQUIRE and __ATOMIC_RELEASE.
__ATOMIC_SEQ_CST
Enforces total ordering with all other __ATOMIC_SEQ_CST operations.
Note that in the C++11 memory model, fences (e.g., ‘__atomic_thread_fence’) take ef-
fect in combination with other atomic operations on specific memory locations (e.g., atomic
loads); operations on specific memory locations do not necessarily affect other operations
in the same way.
Target architectures are encouraged to provide their own patterns for each of the atomic
built-in functions. If no target is provided, the original non-memory model set of ‘__sync’
atomic built-in functions are used, along with any required synchronization fences surround-
ing it in order to achieve the proper behavior. Execution in this case is subject to the same
restrictions as those built-in functions.
If there is no pattern or mechanism to provide a lock-free instruction sequence, a call is
made to an external routine with the same parameters to be resolved at run time.
Chapter 6: Extensions to the C Language Family 721
When implementing patterns for these built-in functions, the memory order parameter
can be ignored as long as the pattern implements the most restrictive __ATOMIC_SEQ_CST
memory order. Any of the other memory orders execute correctly with this memory order
but they may not execute as efficiently as they could with a more appropriate implementa-
tion of the relaxed requirements.
Note that the C++11 standard allows for the memory order parameter to be determined
at run time rather than at compile time. These built-in functions map any run-time value
to __ATOMIC_SEQ_CST rather than invoke a runtime library call or inline a switch statement.
This is standard compliant, safe, and the simplest approach for now.
The memory order parameter is a signed int, but only the lower 16 bits are reserved for
the memory order. The remainder of the signed int is reserved for target use and should be
0. Use of the predefined atomic values ensures proper usage.
void __atomic_load (type *ptr, type *ret, int memorder) [Built-in Function]
This is the generic version of an atomic load. It returns the contents of *ptr in *ret.
void __atomic_store_n (type *ptr, type val, int memorder) [Built-in Function]
This built-in function implements an atomic store operation. It writes val into *ptr.
The valid memory order variants are __ATOMIC_RELAXED, __ATOMIC_SEQ_CST, and
__ATOMIC_RELEASE.
void __atomic_store (type *ptr, type *val, int memorder) [Built-in Function]
This is the generic version of an atomic store. It stores the value of *val into *ptr.
void __atomic_exchange (type *ptr, type *val, type *ret, int [Built-in Function]
memorder)
This is the generic version of an atomic exchange. It stores the contents of *val into
*ptr. The original value of *ptr is copied into *ret.
weak is true for weak compare exchange, which may fail spuriously, and false for
the strong variation, which never fails spuriously. Many targets only offer the strong
variation and ignore the parameter. When in doubt, use the strong variation.
If desired is written into *ptr then true is returned and memory is affected according
to the memory order specified by success memorder. There are no restrictions on what
memory order can be used here.
Otherwise, false is returned and memory is affected according to failure memorder.
This memory order cannot be __ATOMIC_RELEASE nor __ATOMIC_ACQ_REL. It also
cannot be a stronger order than that specified by success memorder.
bool __atomic_compare_exchange (type *ptr, type [Built-in Function]
*expected, type *desired, bool weak, int success memorder, int
failure memorder)
This built-in function implements the generic version of __atomic_compare_
exchange. The function is virtually identical to __atomic_compare_exchange_n,
except the desired value is also a pointer.
type __atomic_add_fetch (type *ptr, type val, int memorder) [Built-in Function]
type __atomic_sub_fetch (type *ptr, type val, int memorder) [Built-in Function]
type __atomic_and_fetch (type *ptr, type val, int memorder) [Built-in Function]
type __atomic_xor_fetch (type *ptr, type val, int memorder) [Built-in Function]
type __atomic_or_fetch (type *ptr, type val, int memorder) [Built-in Function]
type __atomic_nand_fetch (type *ptr, type val, int [Built-in Function]
memorder)
These built-in functions perform the operation suggested by the name, and return
the result of the operation. Operations on pointer arguments are performed as if the
operands were of the uintptr_t type. That is, they are not scaled by the size of the
type to which the pointer points.
{ *ptr op= val; return *ptr; }
{ *ptr = ~(*ptr & val); return *ptr; } // nand
The object pointed to by the first argument must be of integer or pointer type. It
must not be a boolean type. All memory orders are valid.
type __atomic_fetch_add (type *ptr, type val, int memorder) [Built-in Function]
type __atomic_fetch_sub (type *ptr, type val, int memorder) [Built-in Function]
type __atomic_fetch_and (type *ptr, type val, int memorder) [Built-in Function]
type __atomic_fetch_xor (type *ptr, type val, int memorder) [Built-in Function]
type __atomic_fetch_or (type *ptr, type val, int memorder) [Built-in Function]
type __atomic_fetch_nand (type *ptr, type val, int [Built-in Function]
memorder)
These built-in functions perform the operation suggested by the name, and return
the value that had previously been in *ptr. Operations on pointer arguments are
performed as if the operands were of the uintptr_t type. That is, they are not
scaled by the size of the type to which the pointer points.
{ tmp = *ptr; *ptr op= val; return tmp; }
{ tmp = *ptr; *ptr = ~(*ptr & val); return tmp; } // nand
The same constraints on arguments apply as for the corresponding __atomic_op_
fetch built-in functions. All memory orders are valid.
Chapter 6: Extensions to the C Language Family 723
enum {
A = INT_MAX, B = 3,
C = INT_ADD_OVERFLOW_P (A, B) ? 0 : A + B,
D = __builtin_add_overflow_p (1, SCHAR_MAX, (signed char) 0)
};
The compiler will attempt to use hardware instructions to implement these built-in
functions where possible, like conditional jump on overflow after addition, conditional
jump on carry etc.
726 Using the GNU Compiler Collection (GCC)
int lockvar;
pointer points to. The second bit determines if maximum or minimum of remaining
bytes is computed.
struct V { char buf1[10]; int b; char buf2[10]; } var;
char *p = &var.buf1[1], *q = &var.b;
char *volatile p;
char buf[10];
/* It is unknown what object p points to, so this is optimized
into plain memcpy - no checking is possible. */
memcpy (p, "abcde", n);
/* Destination is known and length too. It is known at compile
time there will be no overflow. */
memcpy (&buf[5], "abcde", 5);
/* Destination is known, but the length is not known at compile time.
This will result in __memcpy_chk call that can check for overflow
at run time. */
memcpy (&buf[5], "abcde", n);
/* Destination is known and it is known at compile time there will
728 Using the GNU Compiler Collection (GCC)
The ISO C90 functions abort, abs, acos, asin, atan2, atan, calloc, ceil, cosh,
cos, exit, exp, fabs, floor, fmod, fprintf, fputs, free, frexp, fscanf, isalnum,
isalpha, iscntrl, isdigit, isgraph, islower, isprint, ispunct, isspace, isupper,
isxdigit, tolower, toupper, labs, ldexp, log10, log, malloc, memchr, memcmp, memcpy,
memset, modf, pow, printf, putchar, puts, realloc, scanf, sinh, sin, snprintf,
sprintf, sqrt, sscanf, strcat, strchr, strcmp, strcpy, strcspn, strlen, strncat,
strncmp, strncpy, strpbrk, strrchr, strspn, strstr, tanh, tan, vfprintf, vprintf
and vsprintf are all recognized as built-in functions unless ‘-fno-builtin’ is specified (or
‘-fno-builtin-function’ is specified for an individual function). All of these functions
have corresponding versions prefixed with __builtin_.
GCC provides built-in versions of the ISO C99 floating-point comparison macros that
avoid raising exceptions for unordered operands. They have the same names as the stan-
dard macros ( isgreater, isgreaterequal, isless, islessequal, islessgreater, and
isunordered) , with __builtin_ prefixed. We intend for a library implementor to be able
to simply #define each standard macro to its built-in equivalent. In the same fashion,
GCC provides fpclassify, isfinite, isinf_sign, isnormal and signbit built-ins used
with __builtin_ prefixed. The isinf and isnan built-in functions appear both with and
without the __builtin_ prefix.
GCC provides built-in versions of the ISO C99 floating-point rounding and exceptions
handling functions fegetround, feclearexcept and feraiseexcept. They may not be
available for all targets, and because they need close interaction with libc internal values,
they may not be available for all target libcs, but in all cases they will gracefully fallback to
libc calls. These built-in functions appear both with and without the __builtin_ prefix.
void *__builtin_alloca (size t size) [Built-in Function]
The __builtin_alloca function must be called at block scope. The function allocates
an object size bytes large on the stack of the calling function. The object is aligned on
the default stack alignment boundary for the target determined by the __BIGGEST_
ALIGNMENT__ macro. The __builtin_alloca function returns a pointer to the first
byte of the allocated object. The lifetime of the allocated object ends just before
the calling function returns to its caller. This is so even when __builtin_alloca is
called within a nested block.
For example, the following function allocates eight objects of n bytes each on the
stack, storing a pointer to each in consecutive elements of the array a. It then passes
the array to function g which can safely use the storage pointed to by each of the
array elements.
void f (unsigned n)
{
void *a [8];
for (int i = 0; i != 8; ++i)
a [i] = __builtin_alloca (n);
time. Since C99 Variable Length Arrays offer similar functionality under a portable,
more convenient, and safer interface they are recommended instead, in both C99 and
C++ programs where GCC provides them as an extension. See Section 6.20 [Variable
Length], page 549, for details.
The built-in function can be used where a variable appears to be used in a safe way,
but the CPU, due to speculative execution may temporarily ignore the bounds checks.
Consider, for example, the following function:
int array[500];
int f (unsigned untrusted_index)
{
if (untrusted_index < 500)
return array[untrusted_index];
return 0;
}
If the function is called repeatedly with untrusted_index less than the limit of 500,
then a branch predictor will learn that the block of code that returns a value stored
in array will be executed. If the function is subsequently called with an out-of-range
value it will still try to execute that block of code first until the CPU determines
that the prediction was incorrect (the CPU will unwind any incorrect operations at
that point). However, depending on how the result of the function is used, it might
be possible to leave traces in the cache that can reveal what was stored at the out-
of-bounds location. The built-in function can be used to provide some protection
against leaking data in this way by changing the code to:
int array[500];
int f (unsigned untrusted_index)
{
if (untrusted_index < 500)
return array[__builtin_speculation_safe_value (untrusted_index)];
return 0;
}
The built-in function will either cause execution to stall until the conditional branch
has been fully resolved, or it may permit speculative execution to continue, but using
0 instead of untrusted_value if that exceeds the limit.
If accessing any memory location is potentially unsafe when speculative execution is
incorrect, then the code can be rewritten as
int array[500];
int f (unsigned untrusted_index)
{
if (untrusted_index < 500)
return *__builtin_speculation_safe_value (&array[untrusted_index], NULL);
return 0;
}
which will cause a NULL pointer to be used for the unsafe case.
int __builtin_types_compatible_p (type1, type2) [Built-in Function]
You can use the built-in function __builtin_types_compatible_p to determine
whether two types are the same.
This built-in function returns 1 if the unqualified versions of the types type1 and
type2 (which are types, not expressions) are compatible, 0 otherwise. The result of
this built-in function can be used in integer constant expressions.
This built-in function ignores top level qualifiers (e.g., const, volatile). For exam-
ple, int is equivalent to const int.
The type int[] and int[5] are compatible. On the other hand, int and char * are
not compatible, even if the size of their types, on the particular architecture are the
734 Using the GNU Compiler Collection (GCC)
same. Also, the amount of pointer indirection is taken into account when determining
similarity. Consequently, short * is not similar to short **. Furthermore, two types
that are typedefed are considered compatible if their underlying types are compatible.
An enum type is not considered to be compatible with another enum type even if both
are compatible with the same integer type; this is what the C standard specifies. For
example, enum {foo, bar} is not similar to enum {hot, dog}.
You typically use this function in code whose execution varies depending on the
arguments’ types. For example:
#define foo(x) \
({ \
typeof (x) tmp = (x); \
if (__builtin_types_compatible_p (typeof (x), long double)) \
tmp = foo_long_double (tmp); \
else if (__builtin_types_compatible_p (typeof (x), double)) \
tmp = foo_double (tmp); \
else if (__builtin_types_compatible_p (typeof (x), float)) \
tmp = foo_float (tmp); \
else \
abort (); \
tmp; \
})
Note: This construct is only available for C.
int g (int c)
{
if (c)
{
return 1;
}
else
{
function_that_never_returns ();
__builtin_unreachable ();
}
}
Chapter 6: Extensions to the C Language Family 739
int __builtin_fpclassify (int, int, int, int, int, ...) [Built-in Function]
This built-in implements the C99 fpclassify functionality. The first five int arguments
should be the target library’s notion of the possible FP classes and are used for return
values. They must be constant values and they must appear in this order: FP_NAN,
FP_INFINITE, FP_NORMAL, FP_SUBNORMAL and FP_ZERO. The ellipsis is for exactly one
floating-point value to classify. GCC treats the last argument as type-generic, which
means it does not do default promotion from float to double.
returns. The letter before the n is the return type or void if absent. The n represents the
first parameter to all the custom instructions, the custom instruction number. The two
letters after the n represent the up to two parameters to the function.
The letters represent the following data types:
<no letter>
void for return type and no parameter for parameter types.
i int for return type and parameter type
f float for return type and parameter type
p void * for return type and parameter type
And the function names are:
void __builtin_custom_n (void);
void __builtin_custom_ni (int);
void __builtin_custom_nf (float);
void __builtin_custom_np (void *);
void __builtin_custom_nii (int, int);
void __builtin_custom_nif (int, float);
void __builtin_custom_nip (int, void *);
void __builtin_custom_nfi (float, int);
void __builtin_custom_nff (float, float);
void __builtin_custom_nfp (float, void *);
void __builtin_custom_npi (void *, int);
void __builtin_custom_npf (void *, float);
void __builtin_custom_npp (void *, void *);
int __builtin_custom_in (void);
int __builtin_custom_ini (int);
int __builtin_custom_inf (float);
int __builtin_custom_inp (void *);
int __builtin_custom_inii (int, int);
int __builtin_custom_inif (int, float);
int __builtin_custom_inip (int, void *);
int __builtin_custom_infi (float, int);
int __builtin_custom_inff (float, float);
int __builtin_custom_infp (float, void *);
int __builtin_custom_inpi (void *, int);
int __builtin_custom_inpf (void *, float);
int __builtin_custom_inpp (void *, void *);
float __builtin_custom_fn (void);
float __builtin_custom_fni (int);
float __builtin_custom_fnf (float);
float __builtin_custom_fnp (void *);
float __builtin_custom_fnii (int, int);
float __builtin_custom_fnif (int, float);
float __builtin_custom_fnip (int, void *);
float __builtin_custom_fnfi (float, int);
748 Using the GNU Compiler Collection (GCC)
The following take two int arguments, the second of which which must be a 8-bit compile
time constant. They return a __v8hi result:
__v8hi __builtin_arc_vmovaw (int, const int);
__v8hi __builtin_arc_vmovw (int, const int);
__v8hi __builtin_arc_vmovzw (int, const int);
The following take a single __v8hi argument and return a __v8hi result:
__v8hi __builtin_arc_vabsaw (__v8hi);
__v8hi __builtin_arc_vabsw (__v8hi);
__v8hi __builtin_arc_vaddsuw (__v8hi);
__v8hi __builtin_arc_vexch1 (__v8hi);
__v8hi __builtin_arc_vexch2 (__v8hi);
__v8hi __builtin_arc_vexch4 (__v8hi);
__v8hi __builtin_arc_vsignw (__v8hi);
__v8hi __builtin_arc_vupbaw (__v8hi);
__v8hi __builtin_arc_vupbw (__v8hi);
__v8hi __builtin_arc_vupsbaw (__v8hi);
__v8hi __builtin_arc_vupsbw (__v8hi);
The following take two int arguments and return no result:
void __builtin_arc_vdirun (int, int);
void __builtin_arc_vdorun (int, int);
The following take two int arguments and return no result. The first argument must a
3-bit compile time constant indicating one of the DR0-DR7 DMA setup channels:
void __builtin_arc_vdiwr (const int, int);
void __builtin_arc_vdowr (const int, int);
The following take an int argument and return no result:
void __builtin_arc_vendrec (int);
void __builtin_arc_vrec (int);
void __builtin_arc_vrecrun (int);
void __builtin_arc_vrun (int);
The following take a __v8hi argument and two int arguments and return a __v8hi
result. The second argument must be a 3-bit compile time constants, indicating one the
registers I0-I7, and the third argument must be an 8-bit compile time constant.
Note: Although the equivalent hardware instructions do not take an SIMD register as an
operand, these builtins overwrite the relevant bits of the __v8hi register provided as the
first argument with the value loaded from the [Ib, u8] location in the SDM.
__v8hi __builtin_arc_vld32 (__v8hi, const int, const int);
__v8hi __builtin_arc_vld32wh (__v8hi, const int, const int);
__v8hi __builtin_arc_vld32wl (__v8hi, const int, const int);
__v8hi __builtin_arc_vld64 (__v8hi, const int, const int);
The following take two int arguments and return a __v8hi result. The first argument
must be a 3-bit compile time constants, indicating one the registers I0-I7, and the second
argument must be an 8-bit compile time constant.
__v8hi __builtin_arc_vld128 (const int, const int);
__v8hi __builtin_arc_vld64w (const int, const int);
754 Using the GNU Compiler Collection (GCC)
The following take a __v8hi argument and two int arguments and return no result. The
second argument must be a 3-bit compile time constants, indicating one the registers I0-I7,
and the third argument must be an 8-bit compile time constant.
void __builtin_arc_vst128 (__v8hi, const int, const int);
void __builtin_arc_vst64 (__v8hi, const int, const int);
The following take a __v8hi argument and three int arguments and return no result.
The second argument must be a 3-bit compile-time constant, identifying the 16-bit sub-
register to be stored, the third argument must be a 3-bit compile time constants, indicating
one the registers I0-I7, and the fourth argument must be an 8-bit compile time constant.
void __builtin_arc_vst16_n (__v8hi, const int, const int, const int);
void __builtin_arc_vst32_n (__v8hi, const int, const int, const int);
Currently, ARM and AArch64 back ends do not support ACLE 2.0 fully. Both back ends
support CRC32 intrinsics and the ARM back end supports the Coprocessor intrinsics, all
from ‘arm_acle.h’. The ARM back end’s 16-bit floating-point Advanced SIMD intrinsics
currently comply to ACLE v1.1. AArch64’s back end does not have support for 16-bit
floating point Advanced SIMD intrinsics yet.
See Section 3.19.5 [ARM Options], page 318 and Section 3.19.1 [AArch64 Options],
page 297 for more information on the availability of extensions.
As part of the Security Extensions GCC implements two new function attributes: cmse_
nonsecure_entry and cmse_nonsecure_call.
As part of the Security Extensions GCC implements the intrinsics below. FPTR is used
here to mean any function pointer type.
There are many more AVR-specific built-in functions that are used to implement the
ISO/IEC TR 18037 “Embedded C” fixed-point functions of section 7.18a.6. You don’t need
to use these built-ins directly. Instead, use the declarations as supplied by the stdfix.h
header with GNU-C99:
#include <stdfix.h>
Manual (V6), Fujitsu Semiconductor. The two exceptions are __MDUNPACKH and __MBTOHE,
the GCC forms of which pass 128-bit values by pointer rather than by value.
Most of the functions are named after specific FR-V instructions. Such functions are said
to be “directly mapped” and are summarized here in tabular form.
The SCOUNT and POS bits of the DSP control register are global. The WRDSP,
EXTPDP, EXTPDPV and MTHLIP instructions modify the SCOUNT and POS bits. Dur-
ing optimization, the compiler does not delete these instructions and it does not delete calls
to functions containing these instructions.
At present, GCC only provides support for operations on 32-bit vectors. The vector type
associated with 8-bit integer data is usually called v4i8, the vector type associated with
Q7 is usually called v4q7, the vector type associated with 16-bit integer data is usually
called v2i16, and the vector type associated with Q15 is usually called v2q15. They can
be defined in C as follows:
typedef signed char v4i8 __attribute__ ((vector_size(4)));
typedef signed char v4q7 __attribute__ ((vector_size(4)));
typedef short v2i16 __attribute__ ((vector_size(4)));
typedef short v2q15 __attribute__ ((vector_size(4)));
v4i8, v4q7, v2i16 and v2q15 values are initialized in the same way as aggregates. For
example:
v4i8 a = {1, 2, 3, 4};
v4i8 b;
b = (v4i8) {5, 6, 7, 8};
The following built-in functions map directly to a particular MIPS DSP REV 2 instruc-
tion. Please refer to the architecture specification for details on what each instruction does.
v4q7 __builtin_mips_absq_s_qb (v4q7);
v2i16 __builtin_mips_addu_ph (v2i16, v2i16);
v2i16 __builtin_mips_addu_s_ph (v2i16, v2i16);
v4i8 __builtin_mips_adduh_qb (v4i8, v4i8);
v4i8 __builtin_mips_adduh_r_qb (v4i8, v4i8);
i32 __builtin_mips_append (i32, i32, imm0_31);
i32 __builtin_mips_balign (i32, i32, imm0_3);
i32 __builtin_mips_cmpgdu_eq_qb (v4i8, v4i8);
i32 __builtin_mips_cmpgdu_lt_qb (v4i8, v4i8);
i32 __builtin_mips_cmpgdu_le_qb (v4i8, v4i8);
a64 __builtin_mips_dpa_w_ph (a64, v2i16, v2i16);
a64 __builtin_mips_dps_w_ph (a64, v2i16, v2i16);
v2i16 __builtin_mips_mul_ph (v2i16, v2i16);
v2i16 __builtin_mips_mul_s_ph (v2i16, v2i16);
q31 __builtin_mips_mulq_rs_w (q31, q31);
v2q15 __builtin_mips_mulq_s_ph (v2q15, v2q15);
q31 __builtin_mips_mulq_s_w (q31, q31);
a64 __builtin_mips_mulsa_w_ph (a64, v2i16, v2i16);
v4i8 __builtin_mips_precr_qb_ph (v2i16, v2i16);
v2i16 __builtin_mips_precr_sra_ph_w (i32, i32, imm0_31);
v2i16 __builtin_mips_precr_sra_r_ph_w (i32, i32, imm0_31);
i32 __builtin_mips_prepend (i32, i32, imm0_31);
v4i8 __builtin_mips_shra_qb (v4i8, imm0_7);
v4i8 __builtin_mips_shra_r_qb (v4i8, imm0_7);
v4i8 __builtin_mips_shra_qb (v4i8, i32);
v4i8 __builtin_mips_shra_r_qb (v4i8, i32);
v2i16 __builtin_mips_shrl_ph (v2i16, imm0_15);
v2i16 __builtin_mips_shrl_ph (v2i16, i32);
v2i16 __builtin_mips_subu_ph (v2i16, v2i16);
v2i16 __builtin_mips_subu_s_ph (v2i16, v2i16);
v4i8 __builtin_mips_subuh_qb (v4i8, v4i8);
v4i8 __builtin_mips_subuh_r_qb (v4i8, v4i8);
v2q15 __builtin_mips_addqh_ph (v2q15, v2q15);
v2q15 __builtin_mips_addqh_r_ph (v2q15, v2q15);
q31 __builtin_mips_addqh_w (q31, q31);
q31 __builtin_mips_addqh_r_w (q31, q31);
v2q15 __builtin_mips_subqh_ph (v2q15, v2q15);
v2q15 __builtin_mips_subqh_r_ph (v2q15, v2q15);
q31 __builtin_mips_subqh_w (q31, q31);
q31 __builtin_mips_subqh_r_w (q31, q31);
768 Using the GNU Compiler Collection (GCC)
Note that the multiply-accumulate instructions can be disabled using the command-line
option -mno-fused-madd.
These functions compare a and b using c.cond.ps and return either the upper
or lower half of the result. For example:
v2sf a, b;
if (__builtin_mips_upper_c_eq_ps (a, b))
upper_halves_are_equal ();
else
upper_halves_are_unequal ();
The following built-in functions are also available on all PowerPC processors:
uint64_t __builtin_ppc_get_timebase ();
unsigned long __builtin_ppc_mftb ();
double __builtin_unpack_ibm128 (__ibm128, int);
__ibm128 __builtin_pack_ibm128 (double, double);
Chapter 6: Extensions to the C Language Family 793
double __builtin_mffsl(void);
vector signed int128 vsx xl sext (signed long long, signed short *)
vector signed int128 vsx xl sext (signed long long, signed int *)
vector signed int128 vsx xl sext (signed long long, signed long long *)
vector unsigned int128 vsx xl zext (signed long long, unsigned char *)
vector unsigned int128 vsx xl zext (signed long long, unsigned short *)
vector unsigned int128 vsx xl zext (signed long long, unsigned int *)
vector unsigned int128 vsx xl zext (signed long long, unsigned long long *)
Load (and sign extend) to an int128 vector, as if implemented by the ISA 3.1 lxvrbx,
lxvrhx, lxvrwx, and lxvrdx instructions.
void vec xst trunc (vector signed int128, signed long long, signed char *)
void vec xst trunc (vector signed int128, signed long long, signed short *)
void vec xst trunc (vector signed int128, signed long long, signed int *)
void vec xst trunc (vector signed int128, signed long long, signed long long *)
Chapter 6: Extensions to the C Language Family 799
void vec xst trunc (vector unsigned int128, signed long long, unsigned char *)
void vec xst trunc (vector unsigned int128, signed long long, unsigned short *)
void vec xst trunc (vector unsigned int128, signed long long, unsigned int *)
void vec xst trunc (vector unsigned int128, signed long long, unsigned long long *)
Truncate and store the rightmost element of a vector, as if implemented by the ISA 3.1
stxvrbx, stxvrhx, stxvrwx, and stxvrdx instructions.
operations, only the generic names are shown here, although the specific operations can also
be used.
Arguments that are documented as const int require literal integral values within the
range required for that operation.
Only functions excluded from the PVIPR are listed here.
void vec_dss (const int);
vector signed char vec_vaddsbs (vector bool char, vector signed char);
vector signed char vec_vaddsbs (vector signed char, vector bool char);
vector signed char vec_vaddsbs (vector signed char, vector signed char);
vector signed short vec_vaddshs (vector bool short, vector signed short);
vector signed short vec_vaddshs (vector signed short, vector bool short);
vector signed short vec_vaddshs (vector signed short, vector signed short);
vector signed int vec_vaddsws (vector bool int, vector signed int);
vector signed int vec_vaddsws (vector signed int, vector bool int);
vector signed int vec_vaddsws (vector signed int, vector signed int);
vector signed char vec_vaddubm (vector bool char, vector signed char);
vector signed char vec_vaddubm (vector signed char, vector bool char);
vector signed char vec_vaddubm (vector signed char, vector signed char);
vector unsigned char vec_vaddubm (vector bool char, vector unsigned char);
vector unsigned char vec_vaddubm (vector unsigned char, vector bool char);
vector unsigned char vec_vaddubm (vector unsigned char, vector unsigned char);
vector unsigned char vec_vaddubs (vector bool char, vector unsigned char);
vector unsigned char vec_vaddubs (vector unsigned char, vector bool char);
vector unsigned char vec_vaddubs (vector unsigned char, vector unsigned char);
vector signed short vec_vadduhm (vector bool short, vector signed short);
vector signed short vec_vadduhm (vector signed short, vector bool short);
vector signed short vec_vadduhm (vector signed short, vector signed short);
vector unsigned short vec_vadduhm (vector bool short, vector unsigned short);
vector unsigned short vec_vadduhm (vector unsigned short, vector bool short);
vector unsigned short vec_vadduhm (vector unsigned short, vector unsigned short);
vector unsigned short vec_vadduhs (vector bool short, vector unsigned short);
vector unsigned short vec_vadduhs (vector unsigned short, vector bool short);
vector unsigned short vec_vadduhs (vector unsigned short, vector unsigned short);
vector signed int vec_vadduwm (vector bool int, vector signed int);
vector signed int vec_vadduwm (vector signed int, vector bool int);
vector signed int vec_vadduwm (vector signed int, vector signed int);
vector unsigned int vec_vadduwm (vector bool int, vector unsigned int);
vector unsigned int vec_vadduwm (vector unsigned int, vector bool int);
vector unsigned int vec_vadduwm (vector unsigned int, vector unsigned int);
vector unsigned int vec_vadduws (vector bool int, vector unsigned int);
Chapter 6: Extensions to the C Language Family 805
vector unsigned int vec_vadduws (vector unsigned int, vector bool int);
vector unsigned int vec_vadduws (vector unsigned int, vector unsigned int);
vector signed char vec_vavgsb (vector signed char, vector signed char);
vector signed short vec_vavgsh (vector signed short, vector signed short);
vector signed int vec_vavgsw (vector signed int, vector signed int);
vector unsigned char vec_vavgub (vector unsigned char, vector unsigned char);
vector unsigned short vec_vavguh (vector unsigned short, vector unsigned short);
vector unsigned int vec_vavguw (vector unsigned int, vector unsigned int);
vector bool char vec_vcmpequb (vector signed char, vector signed char);
vector bool char vec_vcmpequb (vector unsigned char, vector unsigned char);
vector bool short vec_vcmpequh (vector signed short, vector signed short);
vector bool short vec_vcmpequh (vector unsigned short, vector unsigned short);
vector bool int vec_vcmpequw (vector signed int, vector signed int);
vector bool int vec_vcmpequw (vector unsigned int, vector unsigned int);
vector bool char vec_vcmpgtsb (vector signed char, vector signed char);
vector bool short vec_vcmpgtsh (vector signed short, vector signed short);
vector bool int vec_vcmpgtsw (vector signed int, vector signed int);
vector bool char vec_vcmpgtub (vector unsigned char, vector unsigned char);
vector bool short vec_vcmpgtuh (vector unsigned short, vector unsigned short);
vector bool int vec_vcmpgtuw (vector unsigned int, vector unsigned int);
vector signed char vec_vmaxsb (vector bool char, vector signed char);
vector signed char vec_vmaxsb (vector signed char, vector bool char);
vector signed char vec_vmaxsb (vector signed char, vector signed char);
vector signed short vec_vmaxsh (vector bool short, vector signed short);
vector signed short vec_vmaxsh (vector signed short, vector bool short);
vector signed short vec_vmaxsh (vector signed short, vector signed short);
vector signed int vec_vmaxsw (vector bool int, vector signed int);
vector signed int vec_vmaxsw (vector signed int, vector bool int);
vector signed int vec_vmaxsw (vector signed int, vector signed int);
806 Using the GNU Compiler Collection (GCC)
vector unsigned char vec_vmaxub (vector bool char, vector unsigned char);
vector unsigned char vec_vmaxub (vector unsigned char, vector bool char);
vector unsigned char vec_vmaxub (vector unsigned char, vector unsigned char);
vector unsigned short vec_vmaxuh (vector bool short, vector unsigned short);
vector unsigned short vec_vmaxuh (vector unsigned short, vector bool short);
vector unsigned short vec_vmaxuh (vector unsigned short, vector unsigned short);
vector unsigned int vec_vmaxuw (vector bool int, vector unsigned int);
vector unsigned int vec_vmaxuw (vector unsigned int, vector bool int);
vector unsigned int vec_vmaxuw (vector unsigned int, vector unsigned int);
vector signed char vec_vminsb (vector bool char, vector signed char);
vector signed char vec_vminsb (vector signed char, vector bool char);
vector signed char vec_vminsb (vector signed char, vector signed char);
vector signed short vec_vminsh (vector bool short, vector signed short);
vector signed short vec_vminsh (vector signed short, vector bool short);
vector signed short vec_vminsh (vector signed short, vector signed short);
vector signed int vec_vminsw (vector bool int, vector signed int);
vector signed int vec_vminsw (vector signed int, vector bool int);
vector signed int vec_vminsw (vector signed int, vector signed int);
vector unsigned char vec_vminub (vector bool char, vector unsigned char);
vector unsigned char vec_vminub (vector unsigned char, vector bool char);
vector unsigned char vec_vminub (vector unsigned char, vector unsigned char);
vector unsigned short vec_vminuh (vector bool short, vector unsigned short);
vector unsigned short vec_vminuh (vector unsigned short, vector bool short);
vector unsigned short vec_vminuh (vector unsigned short, vector unsigned short);
vector unsigned int vec_vminuw (vector bool int, vector unsigned int);
vector unsigned int vec_vminuw (vector unsigned int, vector bool int);
vector unsigned int vec_vminuw (vector unsigned int, vector unsigned int);
vector bool char vec_vmrghb (vector bool char, vector bool char);
vector signed char vec_vmrghb (vector signed char, vector signed char);
vector unsigned char vec_vmrghb (vector unsigned char, vector unsigned char);
vector bool short vec_vmrghh (vector bool short, vector bool short);
vector signed short vec_vmrghh (vector signed short, vector signed short);
vector unsigned short vec_vmrghh (vector unsigned short, vector unsigned short);
vector pixel vec_vmrghh (vector pixel, vector pixel);
vector bool char vec_vmrglb (vector bool char, vector bool char);
vector signed char vec_vmrglb (vector signed char, vector signed char);
vector unsigned char vec_vmrglb (vector unsigned char, vector unsigned char);
vector bool short vec_vmrglh (vector bool short, vector bool short);
vector signed short vec_vmrglh (vector signed short, vector signed short);
Chapter 6: Extensions to the C Language Family 807
vector unsigned short vec_vmrglh (vector unsigned short, vector unsigned short);
vector pixel vec_vmrglh (vector pixel, vector pixel);
vector signed int vec_vmsummbm (vector signed char, vector unsigned char,
vector signed int);
vector signed int vec_vmsumshm (vector signed short, vector signed short,
vector signed int);
vector signed int vec_vmsumshs (vector signed short, vector signed short,
vector signed int);
vector unsigned int vec_vmsumubm (vector unsigned char, vector unsigned char,
vector unsigned int);
vector unsigned int vec_vmsumuhm (vector unsigned short, vector unsigned short,
vector unsigned int);
vector unsigned int vec_vmsumuhs (vector unsigned short, vector unsigned short,
vector unsigned int);
vector signed short vec_vmulesb (vector signed char, vector signed char);
vector signed int vec_vmulesh (vector signed short, vector signed short);
vector unsigned short vec_vmuleub (vector unsigned char, vector unsigned char);
vector unsigned int vec_vmuleuh (vector unsigned short, vector unsigned short);
vector signed short vec_vmulosb (vector signed char, vector signed char);
vector signed int vec_vmulosh (vector signed short, vector signed short);
vector unsigned short vec_vmuloub (vector unsigned char, vector unsigned char);
vector unsigned int vec_vmulouh (vector unsigned short, vector unsigned short);
vector signed char vec_vpkshss (vector signed short, vector signed short);
vector unsigned char vec_vpkshus (vector signed short, vector signed short);
vector signed short vec_vpkswss (vector signed int, vector signed int);
vector unsigned short vec_vpkswus (vector signed int, vector signed int);
vector bool char vec_vpkuhum (vector bool short, vector bool short);
vector signed char vec_vpkuhum (vector signed short, vector signed short);
vector unsigned char vec_vpkuhum (vector unsigned short, vector unsigned short);
vector unsigned char vec_vpkuhus (vector unsigned short, vector unsigned short);
vector bool short vec_vpkuwum (vector bool int, vector bool int);
vector signed short vec_vpkuwum (vector signed int, vector signed int);
808 Using the GNU Compiler Collection (GCC)
vector unsigned short vec_vpkuwum (vector unsigned int, vector unsigned int);
vector unsigned short vec_vpkuwus (vector unsigned int, vector unsigned int);
vector signed char vec_vrlb (vector signed char, vector unsigned char);
vector unsigned char vec_vrlb (vector unsigned char, vector unsigned char);
vector signed short vec_vrlh (vector signed short, vector unsigned short);
vector unsigned short vec_vrlh (vector unsigned short, vector unsigned short);
vector signed int vec_vrlw (vector signed int, vector unsigned int);
vector unsigned int vec_vrlw (vector unsigned int, vector unsigned int);
vector signed char vec_vslb (vector signed char, vector unsigned char);
vector unsigned char vec_vslb (vector unsigned char, vector unsigned char);
vector signed short vec_vslh (vector signed short, vector unsigned short);
vector unsigned short vec_vslh (vector unsigned short, vector unsigned short);
vector signed int vec_vslw (vector signed int, vector unsigned int);
vector unsigned int vec_vslw (vector unsigned int, vector unsigned int);
vector signed char vec_vsrab (vector signed char, vector unsigned char);
vector unsigned char vec_vsrab (vector unsigned char, vector unsigned char);
vector signed short vec_vsrah (vector signed short, vector unsigned short);
vector unsigned short vec_vsrah (vector unsigned short, vector unsigned short);
vector signed int vec_vsraw (vector signed int, vector unsigned int);
vector unsigned int vec_vsraw (vector unsigned int, vector unsigned int);
vector signed char vec_vsrb (vector signed char, vector unsigned char);
vector unsigned char vec_vsrb (vector unsigned char, vector unsigned char);
vector signed short vec_vsrh (vector signed short, vector unsigned short);
vector unsigned short vec_vsrh (vector unsigned short, vector unsigned short);
vector signed int vec_vsrw (vector signed int, vector unsigned int);
vector unsigned int vec_vsrw (vector unsigned int, vector unsigned int);
vector signed char vec_vsubsbs (vector bool char, vector signed char);
vector signed char vec_vsubsbs (vector signed char, vector bool char);
Chapter 6: Extensions to the C Language Family 809
vector signed char vec_vsubsbs (vector signed char, vector signed char);
vector signed short vec_vsubshs (vector bool short, vector signed short);
vector signed short vec_vsubshs (vector signed short, vector bool short);
vector signed short vec_vsubshs (vector signed short, vector signed short);
vector signed int vec_vsubsws (vector bool int, vector signed int);
vector signed int vec_vsubsws (vector signed int, vector bool int);
vector signed int vec_vsubsws (vector signed int, vector signed int);
vector signed char vec_vsububm (vector bool char, vector signed char);
vector signed char vec_vsububm (vector signed char, vector bool char);
vector signed char vec_vsububm (vector signed char, vector signed char);
vector unsigned char vec_vsububm (vector bool char, vector unsigned char);
vector unsigned char vec_vsububm (vector unsigned char, vector bool char);
vector unsigned char vec_vsububm (vector unsigned char, vector unsigned char);
vector unsigned char vec_vsububs (vector bool char, vector unsigned char);
vector unsigned char vec_vsububs (vector unsigned char, vector bool char);
vector unsigned char vec_vsububs (vector unsigned char, vector unsigned char);
vector signed short vec_vsubuhm (vector bool short, vector signed short);
vector signed short vec_vsubuhm (vector signed short, vector bool short);
vector signed short vec_vsubuhm (vector signed short, vector signed short);
vector unsigned short vec_vsubuhm (vector bool short, vector unsigned short);
vector unsigned short vec_vsubuhm (vector unsigned short, vector bool short);
vector unsigned short vec_vsubuhm (vector unsigned short, vector unsigned short);
vector unsigned short vec_vsubuhs (vector bool short, vector unsigned short);
vector unsigned short vec_vsubuhs (vector unsigned short, vector bool short);
vector unsigned short vec_vsubuhs (vector unsigned short, vector unsigned short);
vector signed int vec_vsubuwm (vector bool int, vector signed int);
vector signed int vec_vsubuwm (vector signed int, vector bool int);
vector signed int vec_vsubuwm (vector signed int, vector signed int);
vector unsigned int vec_vsubuwm (vector bool int, vector unsigned int);
vector unsigned int vec_vsubuwm (vector unsigned int, vector bool int);
vector unsigned int vec_vsubuwm (vector unsigned int, vector unsigned int);
vector unsigned int vec_vsubuws (vector bool int, vector unsigned int);
vector unsigned int vec_vsubuws (vector unsigned int, vector bool int);
vector unsigned int vec_vsubuws (vector unsigned int, vector unsigned int);
vector signed int vec_vsum4sbs (vector signed char, vector signed int);
vector signed int vec_vsum4shs (vector signed short, vector signed int);
vector unsigned int vec_vsum4ubs (vector unsigned char, vector unsigned int);
vector bool char vec_vsx_ld (int, const vector bool char *);
vector signed char vec_vsx_ld (int, const vector signed char *);
vector signed char vec_vsx_ld (int, const signed char *);
vector unsigned char vec_vsx_ld (int, const vector unsigned char *);
vector unsigned char vec_vsx_ld (int, const unsigned char *);
vector long long vec_vmaxsd (vector long long, vector long long);
vector long long vec_vminsd (vector long long, vector long long);
vector unsigned long long vec_vminud (vector long long, vector long long);
vector long long vec_vrld (vector long long, vector unsigned long long);
vector unsigned long long vec_vrld (vector unsigned long long,
vector unsigned long long);
vector long long vec_vsld (vector long long, vector unsigned long long);
vector long long vec_vsld (vector unsigned long long,
vector unsigned long long);
vector long long vec_vsrad (vector long long, vector unsigned long long);
vector unsigned long long vec_vsrad (vector unsigned long long,
vector unsigned long long);
vector long long vec_vsrd (vector long long, vector unsigned long long);
vector unsigned long long char vec_vsrd (vector unsigned long long,
vector unsigned long long);
vector long long vec_vsubudm (vector long long, vector long long);
vector long long vec_vsubudm (vector bool long long, vector long long);
vector long long vec_vsubudm (vector long long, vector bool long long);
vector unsigned long long vec_vsubudm (vector unsigned long long,
814 Using the GNU Compiler Collection (GCC)
int __builtin_bcdadd_eq (vector unsigned char, vector unsigned char, const int);
int __builtin_bcdadd_gt (vector __int128, vector __int128, const int);
int __builtin_bcdadd_gt (vector unsigned char, vector unsigned char, const int);
int __builtin_bcdadd_ov (vector __int128, vector __int128, const int);
int __builtin_bcdadd_ov (vector unsigned char, vector unsigned char, const int);
signed char vec_xlx (unsigned int index, vector signed char data);
unsigned char vec_xlx (unsigned int index, vector unsigned char data);
signed short vec_xlx (unsigned int index, vector signed short data);
unsigned short vec_xlx (unsigned int index, vector unsigned short data);
signed int vec_xlx (unsigned int index, vector signed int data);
unsigned int vec_xlx (unsigned int index, vector unsigned int data);
float vec_xlx (unsigned int index, vector float data);
signed char vec_xrx (unsigned int index, vector signed char data);
unsigned char vec_xrx (unsigned int index, vector unsigned char data);
signed short vec_xrx (unsigned int index, vector signed short data);
unsigned short vec_xrx (unsigned int index, vector unsigned short data);
signed int vec_xrx (unsigned int index, vector signed int data);
unsigned int vec_xrx (unsigned int index, vector unsigned int data);
float vec_xrx (unsigned int index, vector float data);
The vec_all_nez, vec_any_eqz, and vec_cmpnez perform pairwise comparisons between
the elements at the same positions within their two vector arguments. The vec_all_nez
function returns a non-zero value if and only if all pairwise comparisons are not equal and
no element of either vector argument contains a zero. The vec_any_eqz function returns
a non-zero value if and only if at least one pairwise comparison is equal or if at least one
element of either vector argument contains a zero. The vec_cmpnez function returns a
vector of the same type as its two arguments, within which each element consists of all ones
to denote that either the corresponding elements of the incoming arguments are not equal
or that at least one of the corresponding elements contains zero. Otherwise, the element of
the returned vector contains all zeros.
The vec_xlx and vec_xrx functions extract the single element selected by the index
argument from the vector represented by the data argument. The index argument always
specifies a byte offset, regardless of the size of the vector element. With vec_xlx, index is
the offset of the first byte of the element to be extracted. With vec_xrx, index represents
the last byte of the element to be extracted, measured from the right end of the vector. In
other words, the last byte of the element to be extracted is found at position (15 - index).
There is no requirement that index be a multiple of the vector element size. However, if
the size of the vector element added to index is greater than 15, the content of the returned
value is undefined.
The following functions are also available if the ISA 3.0 instruction set additions
(‘-mcpu=power9’) are available.
Only functions excluded from the PVIPR are listed here.
vector long long vec_vctz (vector long long);
vector unsigned long long vec_vctz (vector unsigned long long);
vector int vec_vctz (vector int);
vector unsigned int vec_vctz (vector int);
vector short vec_vctz (vector short);
vector unsigned short vec_vctz (vector unsigned short);
vector signed char vec_vctz (vector signed char);
vector unsigned char vec_vctz (vector unsigned char);
vec extractl (vector unsigned long long, vector unsigned long long, unsigned int);
Extract an element from two concatenated vectors starting at the given byte index in
natural-endian order, and place it zero-extended in doubleword 1 of the result according
to natural element order. If the byte index is out of range for the data type, the intrinsic
will be rejected. For little-endian, this output will match the placement by the hardware
instruction, i.e., dword[0] in RTL notation. For big-endian, an additional instruction is
needed to move it from the "left" doubleword to the "right" one. For little-endian, semantics
matching the vextdubvrx, vextduhvrx, vextduwvrx instruction will be generated, while
for big-endian, semantics matching the vextdubvlx, vextduhvlx, vextduwvlx instructions
will be generated. Note that some fairly anomalous results can be generated if the byte
index is not aligned on an element boundary for the element being extracted. This is a
limitation of the bi-endian vector programming model is consistent with the limitation on
vec_perm.
vector unsigned long long int
vec extracth (vector unsigned char, vector unsigned char, unsigned int);
vector unsigned long long int
vec extracth (vector unsigned short, vector unsigned short,
unsigned int);
vector unsigned long long int
vec extracth (vector unsigned int, vector unsigned int, unsigned int);
vector unsigned long long int
vec extracth (vector unsigned long long, vector unsigned long long,
unsigned int);
Extract an element from two concatenated vectors starting at the given byte index. The
index is based on big endian order for a little endian system. Similarly, the index is based
on little endian order for a big endian system. The extraced elements are zero-extended and
put in doubleword 1 according to natural element order. If the byte index is out of range
for the data type, the intrinsic will be rejected. For little-endian, this output will match the
placement by the hardware instruction (vextdubvrx, vextduhvrx, vextduwvrx, vextddvrx)
i.e., dword[0] in RTL notation. For big-endian, an additional instruction is needed to move
it from the "left" doubleword to the "right" one. For little-endian, semantics matching
the vextdubvlx, vextduhvlx, vextduwvlx instructions will be generated, while for big-
endian, semantics matching the vextdubvrx, vextduhvrx, vextduwvrx instructions will be
generated. Note that some fairly anomalous results can be generated if the byte index is
not aligned on the element boundary for the element being extracted. This is a limitation
of the bi-endian vector programming model consistent with the limitation on vec_perm.
vector unsigned long long int
vec pdep (vector unsigned long long int, vector unsigned long long int);
Perform a vector parallel bits deposit operation, as if implemented by the vpdepd instruc-
tion.
Vector Insert
vector unsigned char
vec insertl (unsigned char, vector unsigned char, unsigned int);
vector unsigned short
vec insertl (unsigned short, vector unsigned short, unsigned int);
vector unsigned int
vec insertl (unsigned int, vector unsigned int, unsigned int);
vector unsigned long long
vec insertl (unsigned long long, vector unsigned long long,
822 Using the GNU Compiler Collection (GCC)
unsigned int);
vector unsigned char
vec insertl (vector unsigned char, vector unsigned char, unsigned int;
vector unsigned short
vec insertl (vector unsigned short, vector unsigned short,
unsigned int);
vector unsigned int
vec insertl (vector unsigned int, vector unsigned int, unsigned int);
Let src be the first argument, when the first argument is a scalar, or the rightmost element
of the left doubleword of the first argument, when the first argument is a vector. Insert
the source into the destination at the position given by the third argument, using natural
element order in the second argument. The rest of the second argument is unchanged. If
the byte index is greater than 14 for halfwords, greater than 12 for words, or greater than
8 for doublewords the result is undefined. For little-endian, the generated code will be
semantically equivalent to vins[bhwd]rx instructions. Similarly for big-endian it will be
semantically equivalent to vins[bhwd]lx. Note that some fairly anomalous results can be
generated if the byte index is not aligned on an element boundary for the type of element
being inserted.
vector unsigned char
vec inserth (unsigned char, vector unsigned char, unsigned int);
vector unsigned short
vec inserth (unsigned short, vector unsigned short, unsigned int);
vector unsigned int
vec inserth (unsigned int, vector unsigned int, unsigned int);
vector unsigned long long
vec inserth (unsigned long long, vector unsigned long long,
unsigned int);
vector unsigned char
vec inserth (vector unsigned char, vector unsigned char, unsigned int);
vector unsigned short
vec inserth (vector unsigned short, vector unsigned short,
unsigned int);
vector unsigned int
vec inserth (vector unsigned int, vector unsigned int, unsigned int);
Let src be the first argument, when the first argument is a scalar, or the rightmost
element of the first argument, when the first argument is a vector. Insert src into the
second argument at the position identified by the third argument, using opposite element
order in the second argument, and leaving the rest of the second argument unchanged. If
the byte index is greater than 14 for halfwords, 12 for words, or 8 for doublewords, the
intrinsic will be rejected. Note that the underlying hardware instruction uses the same
register for the second argument and the result. For little-endian, the code generation will
be semantically equivalent to vins[bhwd]lx, while for big-endian it will be semantically
equivalent to vins[bhwd]rx. Note that some fairly anomalous results can be generated if
the byte index is not aligned on an element boundary for the sort of element being inserted.
vector signed char vec srdb (vector signed char, vector signed char,
const unsigned int);
vector unsigned char vec srdb (vector unsigned char, vector unsigned char,
const unsigned int);
vector signed short vec srdb (vector signed short, vector signed short,
const unsigned int);
vector unsigned short vec srdb (vector unsigned short, vector unsigned short,
const unsigned int);
vector signed int vec srdb (vector signed int, vector signed int,
const unsigned int);
vector unsigned int vec srdb (vector unsigned int, vector unsigned int,
const unsigned int);
vector signed long long vec srdb (vector signed long long,
vector signed long long, const unsigned int);
vector unsigned long long vec srdb (vector unsigned long long,
vector unsigned long long, const unsigned int);
Shift the combined input vectors right by the amount specified by the low-order three
bits of the third argument, and return the remaining 128 bits. Code using this built-in must
be endian-aware.
Vector Splat
vector signed int vec splati (const signed int);
vector float vec splati (const float);
Splat a 32-bit immediate into a vector of words.
vector double vec splatid (const float);
Convert a single precision floating-point value to double-precision and splat the result to
a vector of double-precision floats.
vector signed int vec splati ins (vector signed int,
const unsigned int, const signed int);
vector unsigned int vec splati ins (vector unsigned int,
const unsigned int, const unsigned int);
vector float vec splati ins (vector float, const unsigned int,
const float);
Argument 2 must be either 0 or 1. Splat the value of argument 3 into the word identified
by argument 2 of each doubleword of argument 1 and return the result. The other words
of argument 1 are unchanged.
Vector Blend Variable
vector signed char vec blendv (vector signed char, vector signed char,
vector unsigned char);
vector unsigned char vec blendv (vector unsigned char,
vector unsigned char, vector unsigned char);
vector signed short vec blendv (vector signed short,
vector signed short, vector unsigned short);
vector unsigned short vec blendv (vector unsigned short,
vector unsigned short, vector unsigned short);
vector signed int vec blendv (vector signed int, vector signed int,
vector unsigned int);
vector unsigned int vec blendv (vector unsigned int,
vector unsigned int, vector unsigned int);
vector signed long long vec blendv (vector signed long long,
vector signed long long, vector unsigned long long);
vector unsigned long long vec blendv (vector unsigned long long,
vector unsigned long long, vector unsigned long long);
vector float vec blendv (vector float, vector float,
Chapter 6: Extensions to the C Language Family 825
order 64 bits of the 128-bit product are placed into doubleword element i of the vector
returned.
vector unsigned long long
vec mul (vector unsigned long long a, vector unsigned long long b);
vector signed long long
vec mul (vector signed long long a, vector signed long long b);
For each integer value i from 0 to 1, do the following. The integer value in doubleword
element i of a is multiplied by the integer value in doubleword element i of b. The low-order
64 bits of the 128-bit product are placed into doubleword element i of the vector returned.
vector signed int
vec div (vector signed int a, vector signed int b);
vector unsigned int
vec div (vector unsigned int a, vector unsigned int b);
For each integer value i from 0 to 3, do the following. The integer in word element i of
a is divided by the integer in word element i of b. The unique integer quotient is placed
into the word element i of the vector returned. If an attempt is made to perform any of
the divisions <anything> 0 then the quotient is undefined.
vector signed long long
vec div (vector signed long long a, vector signed long long b);
vector unsigned long long
vec div (vector unsigned long long a, vector unsigned long long b);
For each integer value i from 0 to 1, do the following. The integer in doubleword element
i of a is divided by the integer in doubleword element i of b. The unique integer quotient
is placed into the doubleword element i of the vector returned. If an attempt is made to
perform any of the divisions 0x8000 0000 0000 0000 -1 or <anything> 0 then the quotient
is undefined.
vector signed int
vec dive (vector signed int a, vector signed int b);
vector unsigned int
vec dive (vector unsigned int a, vector unsigned int b);
For each integer value i from 0 to 3, do the following. The integer in word element i of
a is shifted left by 32 bits, then divided by the integer in word element i of b. The unique
integer quotient is placed into the word element i of the vector returned. If the quotient
cannot be represented in 32 bits, or if an attempt is made to perform any of the divisions
<anything> 0 then the quotient is undefined.
vector signed long long
vec dive (vector signed long long a, vector signed long long b);
vector unsigned long long
vec dive (vector unsigned long long a, vector unsigned long long b);
For each integer value i from 0 to 1, do the following. The integer in doubleword element
i of a is shifted left by 64 bits, then divided by the integer in doubleword element i of b.
The unique integer quotient is placed into the doubleword element i of the vector returned.
If the quotient cannot be represented in 64 bits, or if an attempt is made to perform
<anything> 0 then the quotient is undefined.
vector signed int
vec mod (vector signed int a, vector signed int b);
vector unsigned int
vec mod (vector unsigned int a, vector unsigned int b);
828 Using the GNU Compiler Collection (GCC)
For each integer value i from 0 to 3, do the following. The integer in word element i of
a is divided by the integer in word element i of b. The unique integer remainder is placed
into the word element i of the vector returned. If an attempt is made to perform any of
the divisions 0x8000 0000 -1 or <anything> 0 then the remainder is undefined.
vector signed long long
vec mod (vector signed long long a, vector signed long long b);
vector unsigned long long
vec mod (vector unsigned long long a, vector unsigned long long b);
For each integer value i from 0 to 1, do the following. The integer in doubleword element
i of a is divided by the integer in doubleword element i of b. The unique integer remainder
is placed into the doubleword element i of the vector returned. If an attempt is made to
perform <anything> 0 then the remainder is undefined.
Generate PCV from specified Mask size, as if implemented by the xxgenpcvbm,
xxgenpcvhm, xxgenpcvwm instructions, where immediate value is either 0, 1, 2 or 3.
vector unsigned int128 vec rl (vector unsigned int128 A,
vector unsigned __int128 B);
vector signed int128 vec rl (vector signed int128 A,
vector unsigned __int128 B);
Result value: Each element of R is obtained by rotating the corresponding element of A
left by the number of bits specified by the corresponding element of B.
vector unsigned int128 vec rlmi (vector unsigned int128,
vector unsigned __int128,
vector unsigned __int128);
vector signed int128 vec rlmi (vector signed int128,
vector signed __int128,
vector unsigned __int128);
Returns the result of rotating the first input and inserting it under mask into the second
input. The first bit in the mask, the last bit in the mask are obtained from the two 7-bit
fields bits [108:115] and bits [117:123] respectively of the second input. The shift is obtained
from the third input in the 7-bit field [125:131] where all bits counted from zero at the left.
vector unsigned int128 vec rlnm (vector unsigned int128,
vector unsigned __int128,
vector unsigned __int128);
vector signed int128 vec rlnm (vector signed int128,
vector unsigned __int128,
vector unsigned __int128);
Returns the result of rotating the first input and ANDing it with a mask. The first bit in
the mask and the last bit in the mask are obtained from the two 7-bit fields bits [117:123]
and bits [125:131] respectively of the second input. The shift is obtained from the third
input in the 7-bit field bits [125:131] where all bits counted from zero at the left.
vector unsigned int128 vec sl(vector unsigned int128 A, vector unsigned int128 B);
vector signed int128 vec sl(vector signed int128 A, vector unsigned int128 B);
Result value: Each element of R is obtained by shifting the corresponding element of A
left by the number of bits specified by the corresponding element of B.
vector unsigned int128 vec sr(vector unsigned int128 A, vector unsigned int128 B);
vector signed int128 vec sr(vector signed int128 A, vector unsigned int128 B);
Result value: Each element of R is obtained by shifting the corresponding element of A
right by the number of bits specified by the corresponding element of B.
Chapter 6: Extensions to the C Language Family 829
vector unsigned int128 vec sra(vector unsigned int128 A, vector unsigned int128 B);
vector signed int128 vec sra(vector signed int128 A, vector unsigned int128 B);
Result value: Each element of R is obtained by arithmetic shifting the corresponding
element of A right by the number of bits specified by the corresponding element of B.
vector unsigned int128 vec mule (vector unsigned long long,
vector unsigned long long);
vector signed int128 vec mule (vector signed long long,
vector signed long long);
Returns a vector containing a 128-bit integer result of multiplying the even doubleword
elements of the two inputs.
vector unsigned int128 vec mulo (vector unsigned long long,
vector unsigned long long);
vector signed int128 vec mulo (vector signed long long,
vector signed long long);
Returns a vector containing a 128-bit integer result of multiplying the odd doubleword
elements of the two inputs.
vector unsigned int128 vec div (vector unsigned int128,
vector unsigned __int128);
vector signed int128 vec div (vector signed int128,
vector signed __int128);
Returns the result of dividing the first operand by the second operand. An attempt to
divide any value by zero or to divide the most negative signed 128-bit integer by negative
one results in an undefined value.
vector unsigned int128 vec dive (vector unsigned int128,
vector unsigned __int128);
vector signed int128 vec dive (vector signed int128,
vector signed __int128);
The result is produced by shifting the first input left by 128 bits and dividing by the
second. If an attempt is made to divide by zero or the result is larger than 128 bits, the
result is undefined.
vector unsigned int128 vec mod (vector unsigned int128,
vector unsigned __int128);
vector signed int128 vec mod (vector signed int128,
vector signed __int128);
The result is the modulo result of dividing the first input by the second input.
The following builtins perform 128-bit vector comparisons. The vec_all_xx, vec_any_
xx, and vec_cmpxx, where xx is one of the operations eq, ne, gt, lt, ge, le perform
pairwise comparisons between the elements at the same positions within their two vector
arguments. The vec_all_xxfunction returns a non-zero value if and only if all pairwise
comparisons are true. The vec_any_xx function returns a non-zero value if and only if at
least one pairwise comparison is true. The vec_cmpxxfunction returns a vector of the same
type as its two arguments, within which each element consists of all ones to denote that
specified logical comparison of the corresponding elements was true. Otherwise, the element
of the returned vector contains all zeros.
vector bool __int128 vec_cmpeq (vector signed __int128, vector signed __int128);
vector bool __int128 vec_cmpeq (vector unsigned __int128, vector unsigned __int128);
vector bool __int128 vec_cmpne (vector signed __int128, vector signed __int128);
vector bool __int128 vec_cmpne (vector unsigned __int128, vector unsigned __int128);
vector bool __int128 vec_cmpgt (vector signed __int128, vector signed __int128);
830 Using the GNU Compiler Collection (GCC)
vector bool __int128 vec_cmpgt (vector unsigned __int128, vector unsigned __int128);
vector bool __int128 vec_cmplt (vector signed __int128, vector signed __int128);
vector bool __int128 vec_cmplt (vector unsigned __int128, vector unsigned __int128);
vector bool __int128 vec_cmpge (vector signed __int128, vector signed __int128);
vector bool __int128 vec_cmpge (vector unsigned __int128, vector unsigned __int128);
vector bool __int128 vec_cmple (vector signed __int128, vector signed __int128);
vector bool __int128 vec_cmple (vector unsigned __int128, vector unsigned __int128);
which does not take any input arguments. Refer to the ISA manual for a description of
each instruction’s operands.
unsigned int __builtin_tbegin (unsigned int);
unsigned int __builtin_tend (unsigned int);
#include <htmintrin.h>
while (1)
{
if (__builtin_tbegin (0))
{
/* Transaction State Initiated. */
if (is_locked (lock))
__builtin_tabort (0);
... transaction code...
__builtin_tend (0);
break;
}
else
{
/* Transaction State Failed. Use locks if the transaction
failure is "persistent" or we’ve tried too many times. */
if (num_retries-- <= 0
|| _TEXASRU_FAILURE_PERSISTENT (__builtin_get_texasru ()))
{
acquire_lock (lock);
... non transactional fallback path...
release_lock (lock);
break;
}
}
}
One final built-in function has been added that returns the value of the 2-bit Transaction
State field of the Machine Status Register (MSR) as stored in CR0.
unsigned long __builtin_ttest (void)
This built-in can be used to determine the current transaction state using the following
code example:
#include <htmintrin.h>
if (tx_state == _HTM_TRANSACTIONAL)
{
/* Code to use in transactional state. */
}
else if (tx_state == _HTM_NONTRANSACTIONAL)
{
/* Code to use in non-transactional state. */
}
else if (tx_state == _HTM_SUSPENDED)
{
/* Code to use in transaction suspended state. */
}
between PowerPC and S/390, allowing users to write one HTM source implementation that
can be compiled and executed on either system.
Using these common set of HTM inline functions, we can create a more portable version
of the HTM example in the previous section that will work on either PowerPC or S/390:
#include <htmxlintrin.h>
while (1)
{
if (__TM_begin (TM_buff) == _HTM_TBEGIN_STARTED)
{
/* Transaction State Initiated. */
if (is_locked (lock))
__TM_abort ();
... transaction code...
__TM_end ();
break;
}
else
{
/* Transaction State Failed. Use locks if the transaction
failure is "persistent" or we’ve tried too many times. */
if (num_retries-- <= 0
|| __TM_is_failure_persistent (TM_buff))
{
acquire_lock (lock);
... non transactional fallback path...
release_lock (lock);
break;
}
}
}
834 Using the GNU Compiler Collection (GCC)
#include <amo.h>
of all FPRs. The compiler will generate code which saves and restores the FPRs. For
soft-float code it is recommended to used the *_nofloat variant. In order to prevent
a TDB from being written it is required to pass a constant zero value as parameter.
Passing a zero value through a variable is not sufficient. Although modifications of
access registers inside the transaction will not trigger an transaction abort it is not
supported to actually modify them. Access registers do not get saved when entering
a transaction. They will have undefined state when reaching the abort code.
Macros for the possible return codes of tbegin are defined in the htmintrin.h header file:
_HTM_TBEGIN_STARTED
tbegin has been executed as part of normal processing. The transaction body
is supposed to be executed.
_HTM_TBEGIN_INDETERMINATE
The transaction was aborted due to an indeterminate condition which might
be persistent.
_HTM_TBEGIN_TRANSIENT
The transaction aborted due to a transient failure. The transaction should be
re-executed in that case.
_HTM_TBEGIN_PERSISTENT
The transaction aborted due to a persistent failure. Re-execution under same
circumstances will not be productive.
_HTM_FIRST_USER_ABORT_CODE [Macro]
The _HTM_FIRST_USER_ABORT_CODE defined in htmintrin.h specifies the first abort
code which can be used for __builtin_tabort. Values below this threshold are
reserved for machine use.
When you use the ‘-mvis4’ switch, the VIS version 4.0 built-in functions also become
available:
v8qi __builtin_vis_fpadd8 (v8qi, v8qi);
v8qi __builtin_vis_fpadds8 (v8qi, v8qi);
v8qi __builtin_vis_fpaddus8 (v8qi, v8qi);
v4hi __builtin_vis_fpaddus16 (v4hi, v4hi);
‘westmere’
Intel Core i7 Westmere CPU.
‘sandybridge’
Intel Core i7 Sandy Bridge CPU.
‘ivybridge’
Intel Core i7 Ivy Bridge CPU.
‘haswell’ Intel Core i7 Haswell CPU.
‘broadwell’
Intel Core i7 Broadwell CPU.
‘skylake’ Intel Core i7 Skylake CPU.
‘skylake-avx512’
Intel Core i7 Skylake AVX512 CPU.
‘cannonlake’
Intel Core i7 Cannon Lake CPU.
‘icelake-client’
Intel Core i7 Ice Lake Client CPU.
‘icelake-server’
Intel Core i7 Ice Lake Server CPU.
‘cascadelake’
Intel Core i7 Cascadelake CPU.
‘tigerlake’
Intel Core i7 Tigerlake CPU.
‘cooperlake’
Intel Core i7 Cooperlake CPU.
‘sapphirerapids’
Intel Core i7 sapphirerapids CPU.
‘alderlake’
Intel Core i7 Alderlake CPU.
‘rocketlake’
Intel Core i7 Rocketlake CPU.
‘bonnell’ Intel Atom Bonnell CPU.
‘silvermont’
Intel Atom Silvermont CPU.
‘goldmont’
Intel Atom Goldmont CPU.
‘goldmont-plus’
Intel Atom Goldmont Plus CPU.
‘tremont’ Intel Atom Tremont CPU.
848 Using the GNU Compiler Collection (GCC)
if (__builtin_cpu_is ("corei7"))
{
do_corei7 (); // Core i7 specific implementation.
}
else
{
do_generic (); // Generic implementation.
}
‘avx512cd’
AVX512CD instructions.
‘avx512er’
AVX512ER instructions.
‘avx512pf’
AVX512PF instructions.
‘avx512vbmi’
AVX512VBMI instructions.
‘avx512ifma’
AVX512IFMA instructions.
‘avx5124vnniw’
AVX5124VNNIW instructions.
‘avx5124fmaps’
AVX5124FMAPS instructions.
‘avx512vpopcntdq’
AVX512VPOPCNTDQ instructions.
‘avx512vbmi2’
AVX512VBMI2 instructions.
‘gfni’ GFNI instructions.
‘vpclmulqdq’
VPCLMULQDQ instructions.
‘avx512vnni’
AVX512VNNI instructions.
‘avx512bitalg’
AVX512BITALG instructions.
Here is an example:
if (__builtin_cpu_supports ("popcnt"))
{
asm("popcnt %1,%0" : "=r"(count) : "rm"(n) : "cc");
}
else
{
count = generic_countbits (n); //generic implementation.
}
The following built-in functions are made available by ‘-mmmx’. All of them generate the
machine instruction that is part of the name.
v8qi __builtin_ia32_paddb (v8qi, v8qi);
v4hi __builtin_ia32_paddw (v4hi, v4hi);
v2si __builtin_ia32_paddd (v2si, v2si);
v8qi __builtin_ia32_psubb (v8qi, v8qi);
v4hi __builtin_ia32_psubw (v4hi, v4hi);
v2si __builtin_ia32_psubd (v2si, v2si);
v8qi __builtin_ia32_paddsb (v8qi, v8qi);
Chapter 6: Extensions to the C Language Family 851
The following built-in functions are made available either with ‘-msse’, or with
‘-m3dnowa’. All of them generate the machine instruction that is part of the name.
v4hi __builtin_ia32_pmulhuw (v4hi, v4hi);
v8qi __builtin_ia32_pavgb (v8qi, v8qi);
v4hi __builtin_ia32_pavgw (v4hi, v4hi);
v1di __builtin_ia32_psadbw (v8qi, v8qi);
v8qi __builtin_ia32_pmaxub (v8qi, v8qi);
v4hi __builtin_ia32_pmaxsw (v4hi, v4hi);
v8qi __builtin_ia32_pminub (v8qi, v8qi);
v4hi __builtin_ia32_pminsw (v4hi, v4hi);
int __builtin_ia32_pmovmskb (v8qi);
void __builtin_ia32_maskmovq (v8qi, v8qi, char *);
852 Using the GNU Compiler Collection (GCC)
The following built-in functions are available when ‘-msse’ is used. All of them generate
the machine instruction that is part of the name.
int __builtin_ia32_comieq (v4sf, v4sf);
int __builtin_ia32_comineq (v4sf, v4sf);
int __builtin_ia32_comilt (v4sf, v4sf);
int __builtin_ia32_comile (v4sf, v4sf);
int __builtin_ia32_comigt (v4sf, v4sf);
int __builtin_ia32_comige (v4sf, v4sf);
int __builtin_ia32_ucomieq (v4sf, v4sf);
int __builtin_ia32_ucomineq (v4sf, v4sf);
int __builtin_ia32_ucomilt (v4sf, v4sf);
int __builtin_ia32_ucomile (v4sf, v4sf);
int __builtin_ia32_ucomigt (v4sf, v4sf);
int __builtin_ia32_ucomige (v4sf, v4sf);
v4sf __builtin_ia32_addps (v4sf, v4sf);
v4sf __builtin_ia32_subps (v4sf, v4sf);
v4sf __builtin_ia32_mulps (v4sf, v4sf);
v4sf __builtin_ia32_divps (v4sf, v4sf);
v4sf __builtin_ia32_addss (v4sf, v4sf);
v4sf __builtin_ia32_subss (v4sf, v4sf);
v4sf __builtin_ia32_mulss (v4sf, v4sf);
v4sf __builtin_ia32_divss (v4sf, v4sf);
v4sf __builtin_ia32_cmpeqps (v4sf, v4sf);
v4sf __builtin_ia32_cmpltps (v4sf, v4sf);
v4sf __builtin_ia32_cmpleps (v4sf, v4sf);
v4sf __builtin_ia32_cmpgtps (v4sf, v4sf);
v4sf __builtin_ia32_cmpgeps (v4sf, v4sf);
v4sf __builtin_ia32_cmpunordps (v4sf, v4sf);
v4sf __builtin_ia32_cmpneqps (v4sf, v4sf);
v4sf __builtin_ia32_cmpnltps (v4sf, v4sf);
v4sf __builtin_ia32_cmpnleps (v4sf, v4sf);
v4sf __builtin_ia32_cmpngtps (v4sf, v4sf);
v4sf __builtin_ia32_cmpngeps (v4sf, v4sf);
v4sf __builtin_ia32_cmpordps (v4sf, v4sf);
v4sf __builtin_ia32_cmpeqss (v4sf, v4sf);
v4sf __builtin_ia32_cmpltss (v4sf, v4sf);
v4sf __builtin_ia32_cmpless (v4sf, v4sf);
v4sf __builtin_ia32_cmpunordss (v4sf, v4sf);
v4sf __builtin_ia32_cmpneqss (v4sf, v4sf);
v4sf __builtin_ia32_cmpnltss (v4sf, v4sf);
v4sf __builtin_ia32_cmpnless (v4sf, v4sf);
v4sf __builtin_ia32_cmpordss (v4sf, v4sf);
v4sf __builtin_ia32_maxps (v4sf, v4sf);
v4sf __builtin_ia32_maxss (v4sf, v4sf);
v4sf __builtin_ia32_minps (v4sf, v4sf);
v4sf __builtin_ia32_minss (v4sf, v4sf);
v4sf __builtin_ia32_andps (v4sf, v4sf);
v4sf __builtin_ia32_andnps (v4sf, v4sf);
v4sf __builtin_ia32_orps (v4sf, v4sf);
v4sf __builtin_ia32_xorps (v4sf, v4sf);
v4sf __builtin_ia32_movss (v4sf, v4sf);
v4sf __builtin_ia32_movhlps (v4sf, v4sf);
v4sf __builtin_ia32_movlhps (v4sf, v4sf);
v4sf __builtin_ia32_unpckhps (v4sf, v4sf);
v4sf __builtin_ia32_unpcklps (v4sf, v4sf);
Chapter 6: Extensions to the C Language Family 853
The following built-in functions are available when ‘-msse3’ is used. All of them generate
the machine instruction that is part of the name.
v2df __builtin_ia32_addsubpd (v2df, v2df);
v4sf __builtin_ia32_addsubps (v4sf, v4sf);
v2df __builtin_ia32_haddpd (v2df, v2df);
v4sf __builtin_ia32_haddps (v4sf, v4sf);
v2df __builtin_ia32_hsubpd (v2df, v2df);
v4sf __builtin_ia32_hsubps (v4sf, v4sf);
v16qi __builtin_ia32_lddqu (char const *);
void __builtin_ia32_monitor (void *, unsigned int, unsigned int);
v4sf __builtin_ia32_movshdup (v4sf);
v4sf __builtin_ia32_movsldup (v4sf);
void __builtin_ia32_mwait (unsigned int, unsigned int);
The following built-in functions are available when ‘-mssse3’ is used. All of them generate
the machine instruction that is part of the name.
v2si __builtin_ia32_phaddd (v2si, v2si);
v4hi __builtin_ia32_phaddw (v4hi, v4hi);
v4hi __builtin_ia32_phaddsw (v4hi, v4hi);
v2si __builtin_ia32_phsubd (v2si, v2si);
v4hi __builtin_ia32_phsubw (v4hi, v4hi);
v4hi __builtin_ia32_phsubsw (v4hi, v4hi);
v4hi __builtin_ia32_pmaddubsw (v8qi, v8qi);
v4hi __builtin_ia32_pmulhrsw (v4hi, v4hi);
v8qi __builtin_ia32_pshufb (v8qi, v8qi);
v8qi __builtin_ia32_psignb (v8qi, v8qi);
v2si __builtin_ia32_psignd (v2si, v2si);
v4hi __builtin_ia32_psignw (v4hi, v4hi);
v1di __builtin_ia32_palignr (v1di, v1di, int);
v8qi __builtin_ia32_pabsb (v8qi);
v2si __builtin_ia32_pabsd (v2si);
v4hi __builtin_ia32_pabsw (v4hi);
The following built-in functions are available when ‘-mssse3’ is used. All of them generate
the machine instruction that is part of the name.
Chapter 6: Extensions to the C Language Family 857
The following built-in functions are available when ‘-msse4.1’ is used. All of them
generate the machine instruction that is part of the name.
v2df __builtin_ia32_blendpd (v2df, v2df, const int);
v4sf __builtin_ia32_blendps (v4sf, v4sf, const int);
v2df __builtin_ia32_blendvpd (v2df, v2df, v2df);
v4sf __builtin_ia32_blendvps (v4sf, v4sf, v4sf);
v2df __builtin_ia32_dppd (v2df, v2df, const int);
v4sf __builtin_ia32_dpps (v4sf, v4sf, const int);
v4sf __builtin_ia32_insertps128 (v4sf, v4sf, const int);
v2di __builtin_ia32_movntdqa (v2di *);
v16qi __builtin_ia32_mpsadbw128 (v16qi, v16qi, const int);
v8hi __builtin_ia32_packusdw128 (v4si, v4si);
v16qi __builtin_ia32_pblendvb128 (v16qi, v16qi, v16qi);
v8hi __builtin_ia32_pblendw128 (v8hi, v8hi, const int);
v2di __builtin_ia32_pcmpeqq (v2di, v2di);
v8hi __builtin_ia32_phminposuw128 (v8hi);
v16qi __builtin_ia32_pmaxsb128 (v16qi, v16qi);
v4si __builtin_ia32_pmaxsd128 (v4si, v4si);
v4si __builtin_ia32_pmaxud128 (v4si, v4si);
v8hi __builtin_ia32_pmaxuw128 (v8hi, v8hi);
v16qi __builtin_ia32_pminsb128 (v16qi, v16qi);
v4si __builtin_ia32_pminsd128 (v4si, v4si);
v4si __builtin_ia32_pminud128 (v4si, v4si);
v8hi __builtin_ia32_pminuw128 (v8hi, v8hi);
v4si __builtin_ia32_pmovsxbd128 (v16qi);
v2di __builtin_ia32_pmovsxbq128 (v16qi);
v8hi __builtin_ia32_pmovsxbw128 (v16qi);
v2di __builtin_ia32_pmovsxdq128 (v4si);
v4si __builtin_ia32_pmovsxwd128 (v8hi);
v2di __builtin_ia32_pmovsxwq128 (v8hi);
v4si __builtin_ia32_pmovzxbd128 (v16qi);
v2di __builtin_ia32_pmovzxbq128 (v16qi);
v8hi __builtin_ia32_pmovzxbw128 (v16qi);
v2di __builtin_ia32_pmovzxdq128 (v4si);
v4si __builtin_ia32_pmovzxwd128 (v8hi);
v2di __builtin_ia32_pmovzxwq128 (v8hi);
v2di __builtin_ia32_pmuldq128 (v4si, v4si);
v4si __builtin_ia32_pmulld128 (v4si, v4si);
int __builtin_ia32_ptestc128 (v2di, v2di);
int __builtin_ia32_ptestnzc128 (v2di, v2di);
int __builtin_ia32_ptestz128 (v2di, v2di);
858 Using the GNU Compiler Collection (GCC)
The following built-in functions are available when ‘-mavx2’ is used. All of them generate
the machine instruction that is part of the name.
v32qi __builtin_ia32_mpsadbw256 (v32qi,v32qi,int);
v32qi __builtin_ia32_pabsb256 (v32qi);
v16hi __builtin_ia32_pabsw256 (v16hi);
v8si __builtin_ia32_pabsd256 (v8si);
v16hi __builtin_ia32_packssdw256 (v8si,v8si);
v32qi __builtin_ia32_packsswb256 (v16hi,v16hi);
v16hi __builtin_ia32_packusdw256 (v8si,v8si);
v32qi __builtin_ia32_packuswb256 (v16hi,v16hi);
v32qi __builtin_ia32_paddb256 (v32qi,v32qi);
v16hi __builtin_ia32_paddw256 (v16hi,v16hi);
v8si __builtin_ia32_paddd256 (v8si,v8si);
v4di __builtin_ia32_paddq256 (v4di,v4di);
v32qi __builtin_ia32_paddsb256 (v32qi,v32qi);
v16hi __builtin_ia32_paddsw256 (v16hi,v16hi);
v32qi __builtin_ia32_paddusb256 (v32qi,v32qi);
v16hi __builtin_ia32_paddusw256 (v16hi,v16hi);
v4di __builtin_ia32_palignr256 (v4di,v4di,int);
v4di __builtin_ia32_andsi256 (v4di,v4di);
v4di __builtin_ia32_andnotsi256 (v4di,v4di);
v32qi __builtin_ia32_pavgb256 (v32qi,v32qi);
862 Using the GNU Compiler Collection (GCC)
The following built-in functions are available when ‘-mfma4’ is used. All of them generate
the machine instruction that is part of the name.
v2df __builtin_ia32_vfmaddpd (v2df, v2df, v2df);
v4sf __builtin_ia32_vfmaddps (v4sf, v4sf, v4sf);
v2df __builtin_ia32_vfmaddsd (v2df, v2df, v2df);
v4sf __builtin_ia32_vfmaddss (v4sf, v4sf, v4sf);
v2df __builtin_ia32_vfmsubpd (v2df, v2df, v2df);
v4sf __builtin_ia32_vfmsubps (v4sf, v4sf, v4sf);
v2df __builtin_ia32_vfmsubsd (v2df, v2df, v2df);
v4sf __builtin_ia32_vfmsubss (v4sf, v4sf, v4sf);
v2df __builtin_ia32_vfnmaddpd (v2df, v2df, v2df);
v4sf __builtin_ia32_vfnmaddps (v4sf, v4sf, v4sf);
v2df __builtin_ia32_vfnmaddsd (v2df, v2df, v2df);
v4sf __builtin_ia32_vfnmaddss (v4sf, v4sf, v4sf);
v2df __builtin_ia32_vfnmsubpd (v2df, v2df, v2df);
v4sf __builtin_ia32_vfnmsubps (v4sf, v4sf, v4sf);
v2df __builtin_ia32_vfnmsubsd (v2df, v2df, v2df);
v4sf __builtin_ia32_vfnmsubss (v4sf, v4sf, v4sf);
v2df __builtin_ia32_vfmaddsubpd (v2df, v2df, v2df);
v4sf __builtin_ia32_vfmaddsubps (v4sf, v4sf, v4sf);
v2df __builtin_ia32_vfmsubaddpd (v2df, v2df, v2df);
v4sf __builtin_ia32_vfmsubaddps (v4sf, v4sf, v4sf);
v4df __builtin_ia32_vfmaddpd256 (v4df, v4df, v4df);
v8sf __builtin_ia32_vfmaddps256 (v8sf, v8sf, v8sf);
v4df __builtin_ia32_vfmsubpd256 (v4df, v4df, v4df);
v8sf __builtin_ia32_vfmsubps256 (v8sf, v8sf, v8sf);
v4df __builtin_ia32_vfnmaddpd256 (v4df, v4df, v4df);
868 Using the GNU Compiler Collection (GCC)
_XABORT_CAPACITY
Transaction abort due to the transaction using too much memory.
_XABORT_DEBUG
Transaction abort due to a debug trap.
_XABORT_NESTED
Transaction abort in an inner nested transaction.
Here is an example showing handling for _XABORT_RETRY and a fallback path for other
failures:
#include <immintrin.h>
Note that, in most cases, the transactional and non-transactional code must synchronize
together to ensure consistency.
872 Using the GNU Compiler Collection (GCC)
GCC also offers a simple mechanism for printing messages during compilation.
#pragma message string
Prints string as a compiler message on compilation. The message is informa-
tional only, and is neither a compilation warning nor an error. Newlines can be
included in the string by using the ‘\n’ escape sequence.
#pragma message "Compiling " __FILE__ "..."
Chapter 6: Extensions to the C Language Family 879
#pragma pop_macro("macro_name")
This pragma sets the value of the macro named as macro name to the value
on top of the stack for this macro. If the stack for macro name is empty, the
value of the macro remains unchanged.
For example:
#define X 1
#pragma push_macro("X")
#undef X
#define X -1
#pragma pop_macro("X")
int x [X];
struct {
int a;
struct {
int a;
};
} foo;
it is ambiguous which a is being referred to with ‘foo.a’. The compiler gives errors for such
constructs.
Unless ‘-fms-extensions’ is used, the unnamed field must be a structure or union defini-
tion without a tag (for example, ‘struct { int a; };’). If ‘-fms-extensions’ is used, the
field may also be a definition with a tag such as ‘struct foo { int a; };’, a reference to
a previously defined structure or union such as ‘struct foo;’, or a reference to a typedef
name for a previously defined structure or union type.
The option ‘-fplan9-extensions’ enables ‘-fms-extensions’ as well as two other ex-
tensions. First, a pointer to a structure is automatically converted to a pointer to an
anonymous field for assignments and function calls. For example:
struct s1 { int a; };
struct s2 { struct s1; };
extern void f1 (struct s1 *);
void f2 (struct s2 *p) { f1 (p); }
In the call to f1 inside f2, the pointer p is converted into a pointer to the anonymous field.
Second, when the type of an anonymous field is a typedef for a struct or union, code
may refer to the field using the name of the typedef.
typedef struct { int a; } s1;
struct s2 { s1; };
s1 f1 (struct s2 *p) { return p->s1; }
These usages are only permitted when they are not ambiguous.
A local variable or class data member declared both static and __thread
gives the variable or member thread storage duration.
• [basic.stc.static]
Change paragraph 1
All objects that have neither thread storage duration, dynamic storage
duration nor are local [. . . ].
• [dcl.stc]
Add __thread to the list in paragraph 1.
Change paragraph 1
With the exception of __thread, at most one storage-class-specifier shall
appear in a given decl-specifier-seq. The __thread specifier may be used
alone, or immediately following the extern or static specifiers. [. . . ]
Add after paragraph 5
The __thread specifier can be applied only to the names of objects and to
anonymous unions.
• [class.mem]
Add after paragraph 6
Non-static members shall not be __thread.
type_info objects
C++ requires information about types to be written out in order to implement
‘dynamic_cast’, ‘typeid’ and exception handling. For polymorphic classes
(classes with virtual functions), the ‘type_info’ object is written out along
with the vtable so that ‘dynamic_cast’ can determine the dynamic type of a
class object at run time. For all other types, we write out the ‘type_info’
object when it is used: when applying ‘typeid’ to an expression, throwing an
object, or referring to a type in a catch clause or exception specification.
Template Instantiations
Most everything in this section also applies to template instantiations, but there
are other options as well. See Section 7.5 [Where’s the Template?], page 890.
When used with GNU ld version 2.8 or later on an ELF system such as GNU/Linux or
Solaris 2, or on Microsoft Windows, duplicate copies of these constructs will be discarded
at link time. This is known as COMDAT support.
On targets that don’t support COMDAT, but do support weak symbols, GCC uses them.
This way one copy overrides all the others, but the unused copies still take up space in the
executable.
For targets that do not support either COMDAT or weak symbols, most entities with
vague linkage are emitted as local symbols to avoid duplicate definition errors from the
linker. This does not happen for local statics in inlines, however, as having multiple copies
almost certainly breaks things.
See Section 7.4 [Declarations and Definitions in One Header], page 889, for another way
to control placement of these constructs.
The second form of this directive is useful for the case where you have multiple
headers with the same name in different directories. If you use this form, you
must specify the same string to ‘#pragma implementation’.
#pragma implementation
#pragma implementation "objects.h"
Use this pragma in a main input file, when you want full output from included
header files to be generated (and made globally visible). The included header
file, in turn, should use ‘#pragma interface’. Backup copies of inline member
functions, debugging information, and the internal tables used to implement
virtual functions are all generated in implementation files.
If you use ‘#pragma implementation’ with no argument, it applies to an
include file with the same basename1 as your source file. For example, in
‘allclass.cc’, giving just ‘#pragma implementation’ by itself is equivalent
to ‘#pragma implementation "allclass.h"’.
Use the string argument if you want a single implementation file to include code
from multiple header files. (You must also use ‘#include’ to include the header
file; ‘#pragma implementation’ only specifies how to use the file—it doesn’t
actually include it.)
There is no way to split up the contents of a single header file into multiple
implementation files.
‘#pragma implementation’ and ‘#pragma interface’ also have an effect on function in-
lining.
If you define a class in a header file marked with ‘#pragma interface’, the effect on
an inline function defined in that class is similar to an explicit extern declaration—the
compiler emits no code at all to define an independent version of the function. Its definition
is used only for inlining with its callers.
Conversely, when you include the same header file in a main source file that declares it
as ‘#pragma implementation’, the compiler emits code for the function itself; this defines
a version of the function that can be found via pointers (or by callers compiled without
inlining). If all calls to the function can be inlined, you can avoid emitting the function by
compiling with ‘-fno-implement-inlines’. If any calls are not inlined, you will get linker
errors.
stances in each translation unit that uses them, and the linker collapses them
together. The advantage of this model is that the linker only has to consider
the object files themselves; there is no external complexity to worry about. The
disadvantage is that compilation time is increased because the template code
is being compiled repeatedly. Code written for this model tends to include
definitions of all templates in the header file, since they must be seen to be
instantiated.
Cfront model
The AT&T C++ translator, Cfront, solved the template instantiation problem
by creating the notion of a template repository, an automatically maintained
place where template instances are stored. A more modern version of the repos-
itory works as follows: As individual object files are built, the compiler places
any template definitions and instantiations encountered in the repository. At
link time, the link wrapper adds in the objects in the repository and compiles
any needed instances that were not previously emitted. The advantages of this
model are more optimal compilation speed and the ability to use the system
linker; to implement the Borland model a compiler vendor also needs to replace
the linker. The disadvantages are vastly increased complexity, and thus poten-
tial for error; for some code this can be just as transparent, but in practice
it can been very difficult to build multiple programs in one directory and one
program in multiple directories. Code written for this model tends to separate
definitions of non-inline member templates into a separate file, which should be
compiled separately.
G++ implements the Borland model on targets where the linker supports it, including
ELF targets (such as GNU/Linux), Mac OS X and Microsoft Windows. Otherwise G++
implements neither automatic model.
You have the following options for dealing with template instantiations:
1. Do nothing. Code written for the Borland model works fine, but each translation
unit contains instances of each of the templates it uses. The duplicate instances will
be discarded by the linker, but in a large program, this can lead to an unacceptable
amount of code duplication in object files or shared libraries.
Duplicate instances of a template can be avoided by defining an explicit instantiation
in one object file, and preventing the compiler from doing implicit instantiations in
any other object files by using an explicit instantiation declaration, using the extern
template syntax:
extern template int max (int, int);
This syntax is defined in the C++ 2011 standard, but has been supported by G++ and
other compilers since well before 2011.
Explicit instantiations can be used for the largest or most frequently duplicated in-
stances, without having to know exactly which other instances are used in the rest
of the program. You can scatter the explicit instantiations throughout your program,
perhaps putting them in the translation units where the instances are used or the
translation units that define the templates themselves; you can put all of the explicit
instantiations you need into one big file; or you can create small files like
#include "Foo.h"
892 Using the GNU Compiler Collection (GCC)
#include "Foo.cc"
fptr p = (fptr)(a.*fp);
For PMF constants (i.e. expressions of the form ‘&Klasse::Member’), no object is needed
to obtain the address of the function. They can be converted to function pointers directly:
fptr p1 = (fptr)(&A::foo);
You must specify ‘-Wno-pmf-conversions’ to use this extension.
return 3;
}
int main ()
{
int (*p)() = &foo;
assert ((*p) () == foo ());
return 0;
}
In the above example, four versions of function foo are created. The first version of foo
with the target attribute "default" is the default version. This version gets executed when
no other target specific version qualifies for execution on a particular platform. A new
version of foo is created by using the same function signature but with a different target
string. Function foo is called or a pointer to it is taken just like a regular function. GCC
takes care of doing the dispatching to call the right version at runtime. Refer to the GCC
wiki on Function Multiversioning for more details.
__has_nothrow_assign (type)
If type is const-qualified or is a reference type then the trait is false. Oth-
erwise if __has_trivial_assign (type) is true then the trait is true, else if
type is a cv-qualified class or union type with copy assignment operators that
are known not to throw an exception then the trait is true, else it is false.
Requires: type shall be a complete type, (possibly cv-qualified) void, or an
array of unknown bound.
__has_nothrow_copy (type)
If __has_trivial_copy (type) is true then the trait is true, else if type is
a cv-qualified class or union type with copy constructors that are known not
to throw an exception then the trait is true, else it is false. Requires: type
shall be a complete type, (possibly cv-qualified) void, or an array of unknown
bound.
__has_nothrow_constructor (type)
If __has_trivial_constructor (type) is true then the trait is true, else if
type is a cv class or union type (or array thereof) with a default constructor
that is known not to throw an exception then the trait is true, else it is false.
Requires: type shall be a complete type, (possibly cv-qualified) void, or an
array of unknown bound.
__has_trivial_assign (type)
If type is const- qualified or is a reference type then the trait is false. Oth-
erwise if __is_trivial (type) is true then the trait is true, else if type is
a cv-qualified class or union type with a trivial copy assignment ([class.copy])
then the trait is true, else it is false. Requires: type shall be a complete type,
(possibly cv-qualified) void, or an array of unknown bound.
896 Using the GNU Compiler Collection (GCC)
__has_trivial_copy (type)
If __is_trivial (type) is true or type is a reference type then the trait is
true, else if type is a cv class or union type with a trivial copy constructor
([class.copy]) then the trait is true, else it is false. Requires: type shall be a
complete type, (possibly cv-qualified) void, or an array of unknown bound.
__has_trivial_constructor (type)
If __is_trivial (type) is true then the trait is true, else if type is a cv-
qualified class or union type (or array thereof) with a trivial default constructor
([class.ctor]) then the trait is true, else it is false. Requires: type shall be a
complete type, (possibly cv-qualified) void, or an array of unknown bound.
__has_trivial_destructor (type)
If __is_trivial (type) is true or type is a reference type then the trait is
true, else if type is a cv class or union type (or array thereof) with a trivial
destructor ([class.dtor]) then the trait is true, else it is false. Requires: type
shall be a complete type, (possibly cv-qualified) void, or an array of unknown
bound.
__has_virtual_destructor (type)
If type is a class type with a virtual destructor ([class.dtor]) then the trait
is true, else it is false. Requires: type shall be a complete type, (possibly
cv-qualified) void, or an array of unknown bound.
__is_abstract (type)
If type is an abstract class ([class.abstract]) then the trait is true, else it is
false. Requires: type shall be a complete type, (possibly cv-qualified) void,
or an array of unknown bound.
__is_base_of (base_type, derived_type)
If base_type is a base class of derived_type ([class.derived]) then the trait
is true, otherwise it is false. Top-level cv-qualifications of base_type and
derived_type are ignored. For the purposes of this trait, a class type is con-
sidered is own base. Requires: if __is_class (base_type) and __is_class
(derived_type) are true and base_type and derived_type are not the same
type (disregarding cv-qualifiers), derived_type shall be a complete type. A
diagnostic is produced if this requirement is not met.
__is_class (type)
If type is a cv-qualified class type, and not a union type ([basic.compound])
the trait is true, else it is false.
__is_empty (type)
If __is_class (type) is false then the trait is false. Otherwise type is
considered empty if and only if: type has no non-static data members, or
all non-static data members, if any, are bit-fields of length 0, and type has
no virtual members, and type has no virtual base classes, and type has no
base classes base_type for which __is_empty (base_type) is false. Requires:
type shall be a complete type, (possibly cv-qualified) void, or an array of
unknown bound.
Chapter 7: Extensions to the C++ Language 897
__is_enum (type)
If type is a cv enumeration type ([basic.compound]) the trait is true, else it is
false.
__is_literal_type (type)
If type is a literal type ([basic.types]) the trait is true, else it is false. Requires:
type shall be a complete type, (possibly cv-qualified) void, or an array of
unknown bound.
__is_pod (type)
If type is a cv POD type ([basic.types]) then the trait is true, else it is false.
Requires: type shall be a complete type, (possibly cv-qualified) void, or an
array of unknown bound.
__is_polymorphic (type)
If type is a polymorphic class ([class.virtual]) then the trait is true, else it is
false. Requires: type shall be a complete type, (possibly cv-qualified) void,
or an array of unknown bound.
__is_standard_layout (type)
If type is a standard-layout type ([basic.types]) the trait is true, else it is
false. Requires: type shall be a complete type, (possibly cv-qualified) void,
or an array of unknown bound.
__is_trivial (type)
If type is a trivial type ([basic.types]) the trait is true, else it is false. Re-
quires: type shall be a complete type, (possibly cv-qualified) void, or an array
of unknown bound.
__is_union (type)
If type is a cv union type ([basic.compound]) the trait is true, else it is false.
__underlying_type (type)
The underlying type of type. Requires: type shall be an enumeration type
([dcl.enum]).
__integer_pack (length)
When used as the pattern of a pack expansion within a template definition,
expands to a template argument pack containing integers from 0 to length-1.
This is provided for efficient implementation of std::make_integer_sequence.
In order to allow compilation of C++ written to such drafts, G++ contains some backwards
compatibilities. All such backwards compatibility features are liable to disappear in future
versions of G++. They should be considered deprecated. See Section 7.11 [Deprecated
Features], page 898.
Implicit C language
Old C system header files did not contain an extern "C" {...} scope to set the
language. On such systems, all system header files are implicitly scoped inside
a C language scope. Such headers must correctly prototype function argument
types, there is no leeway for () to indicate an unspecified set of arguments.
Chapter 8: GNU Objective-C Features 901
• ‘objc/thr.h’: this header declares a public runtime API threading layer that is only
provided by the GNU Objective-C runtime. It declares functions such as objc_mutex_
lock(), which provide a platform-independent set of threading functions.
The header files contain detailed documentation for each function in the GNU Objective-
C runtime API.
@implementation FileStream
+ (void)initialize
{
Stdin = [[FileStream new] initWithFd:0];
Stdout = [[FileStream new] initWithFd:1];
Stderr = [[FileStream new] initWithFd:2];
}
In this example, the initialization of Stdin, Stdout and Stderr in +initialize occurs
too late. The programmer can send a message to one of these objects before the variables
are actually initialized, thus sending messages to the nil object. The +initialize method
which actually initializes the global variables is not invoked until the first message is sent
Chapter 8: GNU Objective-C Features 903
to the class object. The solution would require these variables to be initialized just before
entering main.
The correct solution of the above problem is to use the +load method instead of
+initialize:
@implementation FileStream
+ (void)load
{
Stdin = [[FileStream new] initWithFd:0];
Stdout = [[FileStream new] initWithFd:1];
Stderr = [[FileStream new] initWithFd:2];
}
The +load is a method that is not overridden by categories. If a class and a category of
it both implement +load, both methods are invoked. This allows some additional initial-
izations to be performed in a category.
This mechanism is not intended to be a replacement for +initialize. You should be
aware of its limitations when you decide to use it instead of +initialize.
class is invoked even if +load was not invoked. Note if you explicitly call +load on a class,
+initialize will be called first. To avoid possible problems try to implement only one of
these methods.
The +load method is also invoked when a bundle is dynamically loaded into your running
program. This happens automatically without any intervening operation from you. When
you write bundles and you need to write +load you can safely create and send messages to
objects whose classes already exist in the running program. The same restrictions as above
apply to classes defined in bundle.
The encoding of bit-fields has changed to allow bit-fields to be properly handled by the
runtime functions that compute sizes and alignments of types that contain bit-fields. The
previous encoding contained only the size of the bit-field. Using only this information it is
not possible to reliably compute the size occupied by the bit-field. This is very important
in the presence of the Boehm’s garbage collector because the objects are allocated using
the typed memory facility available in this collector. The typed memory allocation requires
information about where the pointers are located inside the object.
The position in the bit-field is the position, counting in bits, of the bit closest to the
beginning of the structure.
The non-atomic types are encoded as follows:
pointers ‘^’ followed by the pointed type.
arrays ‘[’ followed by the number of elements in the array followed by the
type of the elements followed by ‘]’
structures ‘{’ followed by the name of the structure (or ‘?’ if the structure is
unnamed), the ‘=’ sign, the type of the members and by ‘}’
unions ‘(’ followed by the name of the structure (or ‘?’ if the union is un-
named), the ‘=’ sign, the type of the members followed by ‘)’
vectors ‘![’ followed by the vector size (the number of bytes composing the
vector) followed by a comma, followed by the alignment (in bytes) of
the vector, followed by the type of the elements followed by ‘]’
Here are some types and their encodings, as they are generated by the compiler on an
i386 machine:
struct { {?=i[3f]b128i3b131i2c}
int i;
float f[3];
int a:3;
int b:2;
char c;
}
In addition to the types the compiler also encodes the type specifiers. The table below
describes the encoding of the current Objective-C type specifiers:
Specifier Encoding
const r
in n
inout N
906 Using the GNU Compiler Collection (GCC)
out o
bycopy O
byref R
oneway V
The type specifiers are encoded just before the type. Unlike types however, the type
specifiers are only encoded when they appear in method argument types.
Note how const interacts with pointers:
const int* is a pointer to a const int, and so is encoded as ^ri. int* const, instead,
is a const pointer to an int, and so is encoded as r^i.
Finally, there is a complication when encoding const char * versus char * const. Be-
cause char * is encoded as * and not as ^c, there is no way to express the fact that r applies
to the pointer or to the pointee.
Hence, it is assumed as a convention that r* means const char * (since it is what is
most often meant), and there is no way to encode char *const. char *const would simply
be encoded as *, and the const is lost.
8.3.2 @encode
GNU Objective-C supports the @encode syntax that allows you to create a type encoding
from a C/Objective-C type. For example, @encode(int) is compiled by the compiler into
"i".
Chapter 8: GNU Objective-C Features 907
@encode does not support type qualifiers other than const. For example, @encode(const
char*) is valid and is compiled into "r*", while @encode(bycopy char *) is invalid and
will cause a compilation error.
requires precise information on where pointers are located inside objects. This information
is computed once per class, immediately after the class has been initialized.
There is a new runtime function class_ivar_set_gcinvisible() which can be used to
declare a so-called weak pointer reference. Such a pointer is basically hidden for the garbage
collector; this can be useful in certain situations, especially when you want to keep track
of the allocated objects, yet allow them to be collected. This kind of pointers can only be
members of objects, you cannot declare a global pointer as a weak reference. Every type
which is a pointer type can be declared a weak pointer, including id, Class and SEL.
Here is an example of how to use this feature. Suppose you want to implement a class
whose instances hold a weak pointer reference; the following class does this:
- initWithPointer:(const void*)p;
- (const void*)weakPointer;
@end
@implementation WeakPointer
+ (void)initialize
{
if (self == objc_lookUpClass ("WeakPointer"))
class_ivar_set_gcinvisible (self, "weakPointer", YES);
}
- initWithPointer:(const void*)p
{
weakPointer = p;
return self;
}
- (const void*)weakPointer
{
return weakPointer;
}
@end
Weak pointers are supported through a new type character specifier represented by the
‘!’ character. The class_ivar_set_gcinvisible() function adds or removes this specifier
to the string type description of the instance variable named as argument.
The constant string objects are by default instances of the NXConstantString class which
is provided by the GNU Objective-C runtime. To get the definition of this class you must
include the ‘objc/NXConstStr.h’ header file.
User defined libraries may want to implement their own constant string class. To be able
to support them, the GNU Objective-C compiler provides a new command line options
‘-fconstant-string-class=class-name’. The provided class should adhere to a strict
structure, the same as NXConstantString’s structure:
@interface MyConstantStringClass
{
Class isa;
char *c_string;
unsigned int len;
}
@end
NXConstantString inherits from Object; user class libraries may choose to inherit the
customized constant string class from a different class than Object. There is no requirement
in the methods the constant string class has to implement, but the final ivar layout of the
class must be the compatible with the given structure.
When the compiler creates the statically allocated constant string object, the c_string
field will be filled by the compiler with the string; the length field will be filled by the
compiler with the string length; the isa pointer will be filled with NULL by the compiler,
and it will later be fixed up automatically at runtime by the GNU Objective-C runtime
library to point to the class which was set by the ‘-fconstant-string-class’ option when
the object file is loaded (if you wonder how it works behind the scenes, the name of the
class to use, and the list of static objects to fixup, are stored by the compiler in the object
file in a place where the GNU runtime library will find them at runtime).
As a result, when a file is compiled with the ‘-fconstant-string-class’ option, all the
constant string objects will be instances of the class specified as argument to this option. It
is possible to have multiple compilation units referring to different constant string classes,
neither the compiler nor the linker impose any restrictions in doing this.
8.6 compatibility_alias
The keyword @compatibility_alias allows you to define a class name as equivalent to
another class name. For example:
@compatibility_alias WOApplication GSWApplication;
tells the compiler that each time it encounters WOApplication as a class name, it
should replace it with GSWApplication (that is, WOApplication is just an alias for
GSWApplication).
There are some constraints on how this can be used—
• WOApplication (the alias) must not be an existing class;
• GSWApplication (the real class) must be an existing class.
910 Using the GNU Compiler Collection (GCC)
8.7 Exceptions
GNU Objective-C provides exception support built into the language, as in the following
example:
@try {
...
@throw expr;
...
}
@catch (AnObjCClass *exc) {
...
@throw expr;
...
@throw;
...
}
@catch (AnotherClass *exc) {
...
}
@catch (id allOthers) {
...
}
@finally {
...
@throw expr;
...
}
• As mentioned above, the new exceptions do not support handling types other than
Objective-C objects. Furthermore, when used from Objective-C++, the Objective-C
exception model does not interoperate with C++ exceptions at this time. This means
you cannot @throw an exception from Objective-C and catch it in C++, or vice versa
(i.e., throw ... @catch).
8.8 Synchronization
GNU Objective-C provides support for synchronized blocks:
@synchronized (ObjCClass *guard) {
...
}
Upon entering the @synchronized block, a thread of execution shall first check whether
a lock has been placed on the corresponding guard object by another thread. If it has, the
current thread shall wait until the other thread relinquishes its lock. Once guard becomes
available, the current thread will place its own lock on it, execute the code contained in the
@synchronized block, and finally relinquish the lock (thereby making guard available to
other threads).
Unlike Java, Objective-C does not allow for entire methods to be marked @synchronized.
Note that throwing exceptions out of @synchronized blocks is allowed, and will cause the
guarding object to be unlocked properly.
Because of the interactions between synchronization and exception handling, you can only
use @synchronized when compiling with exceptions enabled, that is with the command line
option ‘-fobjc-exceptions’.
{
id object;
for (object in array)
{
/* Do something with ’object’ */
}
}
but can save some typing.
Note that the option ‘-std=c99’ is not required to allow this syntax in Objective-C.
• statements must not make any changes to the collection object; if they do, it is a hard
error and the fast enumeration terminates by invoking objc_enumerationMutation, a
runtime function that normally aborts the program but which can be customized by
Foundation libraries via objc_set_mutation_handler to do something different, such
as raising an exception.
Finally, note how we declared the len argument and the return value to be of type
unsigned long. They could also be declared to be of type unsigned int and everything
would still work.
in the case of a class method. If the class implements it, the runtime invokes it, passing
as argument the selector of the original method, and if it returns YES, the runtime tries the
lookup again, which could now succeed if a matching method was added dynamically by
+resolveInstanceMethod: or +resolveClassMethod:.
This allows classes to dynamically register methods (by adding them to the class us-
ing class_addMethod) when they are first called. To do so, a class should implement
+resolveInstanceMethod: (or, depending on the case, +resolveClassMethod:) and have
it recognize the selectors of methods that can be registered dynamically at runtime, regis-
ter them, and return YES. It should return NO for methods that it does not dynamically
registered at runtime.
If +resolveInstanceMethod: (or +resolveClassMethod:) is not implemented or returns
NO, the runtime then tries the forwarding hook.
Support for +resolveInstanceMethod: and resolveClassMethod: was added to the
GNU Objective-C runtime in GCC version 4.6.
Chapter 8: GNU Objective-C Features 915
9 Binary Compatibility
Binary compatibility encompasses several related concepts:
application binary interface (ABI)
The set of runtime conventions followed by all of the tools that deal with bi-
nary representations of a program, including compilers, assemblers, linkers, and
language runtime support. Some ABIs are formal with a written specification,
possibly designed by multiple interested parties. Others are simply the way
things are actually done by a particular set of tools.
ABI conformance
A compiler conforms to an ABI if it generates code that follows all of the
specifications enumerated by that ABI. A library conforms to an ABI if it is
implemented according to that ABI. An application conforms to an ABI if it
is built using tools that conform to that ABI and does not contain source code
that specifically changes behavior specified by the ABI.
calling conventions
Calling conventions are a subset of an ABI that specify of how arguments are
passed and function results are returned.
interoperability
Different sets of tools are interoperable if they generate files that can be used
in the same program. The set of tools includes compilers, assemblers, linkers,
libraries, header files, startup files, and debuggers. Binaries produced by dif-
ferent sets of tools are not interoperable unless they implement the same ABI.
This applies to different versions of the same tools as well as tools from different
vendors.
intercallability
Whether a function in a binary built by one set of tools can call a function in
a binary built by a different set of tools is a subset of interoperability.
implementation-defined features
Language standards include lists of implementation-defined features whose be-
havior can vary from one implementation to another. Some of these features
are normally covered by a platform’s ABI and others are not. The features
that are not covered by an ABI generally affect how a program behaves, but
not intercallability.
compatibility
Conformance to the same ABI and the same behavior of implementation-defined
features are both relevant for compatibility.
The application binary interface implemented by a C or C++ compiler affects code gen-
eration and runtime support for:
• size and alignment of data types
• layout of structured types
• calling conventions
918 Using the GNU Compiler Collection (GCC)
The most straightforward way to link a program to use a particular C++ library is to
use a C++ driver that specifies that C++ library by default. The g++ driver, for example,
tells the linker where to find GCC’s C++ library (‘libstdc++’) plus the other libraries and
startup files it needs, in the proper order.
If a program must use a different C++ library and it’s not possible to do the final link
using a C++ driver that uses that library by default, it is necessary to tell g++ the location
and name of that library. It might also be necessary to specify different startup files and
other runtime support libraries, and to suppress the use of GCC’s support libraries with
one or more of the options ‘-nostdlib’, ‘-nostartfiles’, and ‘-nodefaultlibs’.
Chapter 10: gcov—a Test Coverage Program 921
-a
--all-blocks
Write individual execution counts for every basic block. Normally gcov outputs
execution counts only for the main blocks of a line. With this option you can
determine if blocks within a single line are not being executed.
-b
--branch-probabilities
Write branch frequencies to the output file, and write branch summary info to
the standard output. This option allows you to see how often each branch in
your program was taken. Unconditional branches will not be shown, unless the
‘-u’ option is given.
-c
--branch-counts
Write branch frequencies as the number of branches taken, rather than the
percentage of branches taken.
-d
--display-progress
Display the progress on the standard output.
-f
--function-summaries
Output summaries for each function in addition to the file level summary.
-h
--help Display help about using gcov (on the standard output), and exit without doing
any further processing.
-j
--json-format
Output gcov file in an easy-to-parse JSON intermediate format which does not
require source code for generation. The JSON file is compressed with gzip
compression algorithm and the files have ‘.gcov.json.gz’ extension.
Structure of the JSON is following:
{
"current_working_directory": "foo/bar",
"data_file": "a.out",
"format_version": "1",
"gcc_version": "11.1.1 20210510"
"files": ["$file"]
}
Fields of the root element have following semantics:
• current working directory: working directory where a compilation unit
was compiled
• data file: name of the data file (GCDA)
• format version: semantic version of the format
• gcc version: version of the GCC compiler
Each file has the following form:
Chapter 10: gcov—a Test Coverage Program 923
{
"file": "a.c",
"functions": ["$function"],
"lines": ["$line"]
}
Fields of the file element have following semantics:
• file name: name of the source file
Each function has the following form:
{
"blocks": 2,
"blocks_executed": 2,
"demangled_name": "foo",
"end_column": 1,
"end_line": 4,
"execution_count": 1,
"name": "foo",
"start_column": 5,
"start_line": 1
}
Fields of the function element have following semantics:
• blocks: number of blocks that are in the function
• blocks executed: number of executed blocks of the function
• demangled name: demangled name of the function
• end column: column in the source file where the function ends
• end line: line in the source file where the function ends
• execution count: number of executions of the function
• name: name of the function
• start column: column in the source file where the function begins
• start line: line in the source file where the function begins
Note that line numbers and column numbers number from 1. In the current
implementation, start line and start column do not include any template pa-
rameters and the leading return type but that this is likely to be fixed in the
future.
Each line has the following form:
{
"branches": ["$branch"],
"count": 2,
"line_number": 15,
"unexecuted_block": false,
"function_name": "foo",
}
Branches are present only with -b option. Fields of the line element have
following semantics:
• count: number of executions of the line
• line number: line number
• unexecuted block: flag whether the line contains an unexecuted block (not
all statements on the line are executed)
924 Using the GNU Compiler Collection (GCC)
• function name: a name of a function this line belongs to (for a line with
an inlined statements can be not set)
Each branch has the following form:
{
"count": 11,
"fallthrough": true,
"throw": false
}
Fields of the branch element have following semantics:
• count: number of executions of the branch
• fallthrough: true when the branch is a fall through branch
• throw: true when the branch is an exceptional branch
-H
--human-readable
Write counts in human readable format (like 24.6k).
-k
--use-colors
Use colors for lines of code that have zero coverage. We use red color for non-
exceptional lines and cyan for exceptional. Same colors are used for basic blocks
with ‘-a’ option.
-l
--long-file-names
Create long file names for included source files. For example, if the header
file ‘x.h’ contains code, and was included in the file ‘a.c’, then running gcov
on the file ‘a.c’ will produce an output file called ‘a.c##x.h.gcov’ instead of
‘x.h.gcov’. This can be useful if ‘x.h’ is included in multiple source files and
you want to see the individual contributions. If you use the ‘-p’ option, both
the including and included file names will be complete path names.
-m
--demangled-names
Display demangled function names in output. The default is to show mangled
function names.
-n
--no-output
Do not create the gcov output file.
-o directory|file
--object-directory directory
--object-file file
Specify either the directory containing the gcov data files, or the object path
name. The ‘.gcno’, and ‘.gcda’ data files are searched for using this option. If
a directory is specified, the data files are in that directory and named after the
input file name, without its extension. If a file is specified here, the data files
are named after that file, without its extension.
Chapter 10: gcov—a Test Coverage Program 925
-p
--preserve-paths
Preserve complete path information in the names of generated ‘.gcov’ files.
Without this option, just the filename component is used. With this option, all
directories are used, with ‘/’ characters translated to ‘#’ characters, ‘.’ directory
components removed and unremoveable ‘..’ components renamed to ‘^’. This
is useful if sourcefiles are in several different directories.
-q
--use-hotness-colors
Emit perf-like colored output for hot lines. Legend of the color scale is printed
at the very beginning of the output file.
-r
--relative-only
Only output information about source files with a relative pathname (after
source prefix elision). Absolute paths are usually system header files and cov-
erage of any inline functions therein is normally uninteresting.
-s directory
--source-prefix directory
A prefix for source file names to remove when generating the output coverage
files. This option is useful when building in a separate directory, and the path-
name to the source directory is not wanted when determining the output file
names. Note that this prefix detection is applied before determining whether
the source file is absolute.
-t
--stdout Output to standard output instead of output files.
-u
--unconditional-branches
When branch probabilities are given, include those of unconditional branches.
Unconditional branches are normally not interesting.
-v
--version
Display the gcov version number (on the standard output), and exit without
doing any further processing.
-w
--verbose
Print verbose informations related to basic blocks and arcs.
-x
--hash-filenames
When using –preserve-paths, gcov uses the full pathname of the source
files to create an output filename. This can lead to long filenames that
can overflow filesystem limits. This option creates names of the form
‘source-file##md5.gcov’, where the source-file component is the final
filename part and the md5 component is calculated from the full mangled
926 Using the GNU Compiler Collection (GCC)
name that would have been used otherwise. The option is an alternative to
the –preserve-paths on systems which have a filesystem limit.
gcov should be run with the current directory the same as that when you invoked the
compiler. Otherwise it will not be able to locate the source files. gcov produces files called
‘mangledname.gcov’ in the current directory. These contain the coverage information of
the source file they correspond to. One ‘.gcov’ file is produced for each source (or header)
file containing code, which was compiled to produce the data files. The mangledname part
of the output file name is usually simply the source file name, but can be something more
complicated if the ‘-l’ or ‘-p’ options are given. Refer to those options for details.
If you invoke gcov with multiple input files, the contributions from each input file are
summed. Typically you would invoke it with the same list of files as the final link of your
executable.
The ‘.gcov’ files contain the ‘:’ separated fields along with program source code. The
format is
execution_count:line_number:source line text
Additional block information may succeed each line, when requested by command line
option. The execution count is ‘-’ for lines containing no code. Unexecuted lines are
marked ‘#####’ or ‘=====’, depending on whether they are reachable by non-exceptional
paths or only exceptional paths such as C++ exception handlers, respectively. Given the
‘-a’ option, unexecuted blocks are marked ‘$$$$$’ or ‘%%%%%’, depending on whether a basic
block is reachable via non-exceptional or exceptional paths. Executed basic blocks having a
statement with zero execution count end with ‘*’ character and are colored with magenta
color with the ‘-k’ option. This functionality is not supported in Ada.
Note that GCC can completely remove the bodies of functions that are not needed – for
instance if they are inlined everywhere. Such functions are marked with ‘-’, which can be
confusing. Use the ‘-fkeep-inline-functions’ and ‘-fkeep-static-functions’ options
to retain these functions and allow gcov to properly show their execution count.
Some lines of information at the start have line number of zero. These preamble lines
are of the form
-:0:tag:value
The ordering and number of these preamble lines will be augmented as gcov development
progresses — do not rely on them remaining unchanged. Use tag to locate a particular
preamble line.
The additional block information is of the form
tag information
The information is human readable, but designed to be simple enough for machine parsing
too.
When printing percentages, 0% and 100% are only printed when the values are exactly
0% and 100% respectively. Other values which would conventionally be rounded to 0% or
100% are instead printed as the nearest non-boundary value.
When using gcov, you must first compile your program with a special GCC option
‘--coverage’. This tells the compiler to generate additional information needed by gcov
(basically a flow graph of the program) and also includes additional code in the object files
Chapter 10: gcov—a Test Coverage Program 927
for generating the extra profiling information needed by gcov. These additional files are
placed in the directory where the object file is located.
Running the program will cause profile output to be generated. For each source file
compiled with ‘-fprofile-arcs’, an accompanying ‘.gcda’ file will be placed in the object
file directory.
Running gcov with your program’s source file names as arguments will now produce a
listing of the code along with frequency of execution for each line. For example, if your
program is called ‘tmp.cpp’, this is what you see when you use the basic gcov facility:
$ g++ --coverage tmp.cpp -c
$ g++ --coverage tmp.o
$ a.out
$ gcov tmp.cpp -m
File ’tmp.cpp’
Lines executed:92.86% of 14
Creating ’tmp.cpp.gcov’
The file ‘tmp.cpp.gcov’ contains output from gcov. Here is a sample:
-: 0:Source:tmp.cpp
-: 0:Working directory:/home/gcc/testcase
-: 0:Graph:tmp.gcno
-: 0:Data:tmp.gcda
-: 0:Runs:1
-: 0:Programs:1
-: 1:#include <stdio.h>
-: 2:
-: 3:template<class T>
-: 4:class Foo
-: 5:{
-: 6: public:
1*: 7: Foo(): b (1000) {}
------------------
Foo<char>::Foo():
#####: 7: Foo(): b (1000) {}
------------------
Foo<int>::Foo():
1: 7: Foo(): b (1000) {}
------------------
2*: 8: void inc () { b++; }
------------------
Foo<char>::inc():
#####: 8: void inc () { b++; }
------------------
Foo<int>::inc():
2: 8: void inc () { b++; }
------------------
-: 9:
-: 10: private:
-: 11: int b;
-: 12:};
-: 13:
-: 14:template class Foo<int>;
-: 15:template class Foo<char>;
-: 16:
-: 17:int
1: 18:main (void)
-: 19:{
928 Using the GNU Compiler Collection (GCC)
-: 13:
-: 14:template class Foo<int>;
-: 15:template class Foo<char>;
-: 16:
-: 17:int
1: 18:main (void)
-: 19:{
-: 20: int i, total;
1: 21: Foo<int> counter;
1: 21-block 0
-: 22:
1: 23: counter.inc();
1: 23-block 0
1: 24: counter.inc();
1: 24-block 0
1: 25: total = 0;
-: 26:
11: 27: for (i = 0; i < 10; i++)
1: 27-block 0
11: 27-block 1
10: 28: total += i;
10: 28-block 0
-: 29:
1*: 30: int v = total > 100 ? 1 : 2;
1: 30-block 0
%%%%%: 30-block 1
1: 30-block 2
-: 31:
1: 32: if (total != 45)
1: 32-block 0
#####: 33: printf ("Failure\n");
%%%%%: 33-block 0
-: 34: else
1: 35: printf ("Success\n");
1: 35-block 0
1: 36: return 0;
1: 36-block 0
-: 37:}
In this mode, each basic block is only shown on one line – the last line of the block.
A multi-line block will only contribute to the execution count of that last line, and other
lines will not be shown to contain code, unless previous blocks end on those lines. The
total execution count of a line is shown and subsequent lines show the execution counts for
individual blocks that end on that line. After each block, the branch and call counts of the
block will be shown, if the ‘-b’ option is given.
Because of the way GCC instruments calls, a call count can be shown after a line with
no individual blocks. As you can see, line 33 contains a basic block that was not executed.
When you use the ‘-b’ option, your output looks like this:
-: 0:Source:tmp.cpp
-: 0:Working directory:/home/gcc/testcase
-: 0:Graph:tmp.gcno
-: 0:Data:tmp.gcda
-: 0:Runs:1
-: 0:Programs:1
-: 1:#include <stdio.h>
-: 2:
930 Using the GNU Compiler Collection (GCC)
-: 3:template<class T>
-: 4:class Foo
-: 5:{
-: 6: public:
1*: 7: Foo(): b (1000) {}
------------------
Foo<char>::Foo():
function Foo<char>::Foo() called 0 returned 0% blocks executed 0%
#####: 7: Foo(): b (1000) {}
------------------
Foo<int>::Foo():
function Foo<int>::Foo() called 1 returned 100% blocks executed 100%
1: 7: Foo(): b (1000) {}
------------------
2*: 8: void inc () { b++; }
------------------
Foo<char>::inc():
function Foo<char>::inc() called 0 returned 0% blocks executed 0%
#####: 8: void inc () { b++; }
------------------
Foo<int>::inc():
function Foo<int>::inc() called 2 returned 100% blocks executed 100%
2: 8: void inc () { b++; }
------------------
-: 9:
-: 10: private:
-: 11: int b;
-: 12:};
-: 13:
-: 14:template class Foo<int>;
-: 15:template class Foo<char>;
-: 16:
-: 17:int
function main called 1 returned 100% blocks executed 81%
1: 18:main (void)
-: 19:{
-: 20: int i, total;
1: 21: Foo<int> counter;
call 0 returned 100%
branch 1 taken 100% (fallthrough)
branch 2 taken 0% (throw)
-: 22:
1: 23: counter.inc();
call 0 returned 100%
branch 1 taken 100% (fallthrough)
branch 2 taken 0% (throw)
1: 24: counter.inc();
call 0 returned 100%
branch 1 taken 100% (fallthrough)
branch 2 taken 0% (throw)
1: 25: total = 0;
-: 26:
11: 27: for (i = 0; i < 10; i++)
branch 0 taken 91% (fallthrough)
branch 1 taken 9%
10: 28: total += i;
-: 29:
1*: 30: int v = total > 100 ? 1 : 2;
Chapter 10: gcov—a Test Coverage Program 931
should not compile with optimization at the same time. On some machines the optimizer
can eliminate some simple code lines by combining them with other lines. For example,
code like this:
if (a != b)
c = 1;
else
c = 0;
can be compiled into one instruction on some machines. In this case, there is no way for
gcov to calculate separate execution counts for each line because there isn’t separate code
for each line. Hence the gcov output looks like this if you compiled the program with
optimization:
100: 12:if (a != b)
100: 13: c = 1;
100: 14:else
100: 15: c = 0;
The output shows that this block of code, combined by optimization, executed 100 times.
In one sense this result is correct, because there was only one instruction representing all
four of these lines. However, the output does not indicate how many times the result was
0 and how many times the result was 1.
Inlineable functions can create unexpected line counts. Line counts are shown for the
source code of the inlineable function, but what is shown depends on where the function is
inlined, or if it is not inlined at all.
If the function is not inlined, the compiler must emit an out of line copy of the function, in
any object file that needs it. If ‘fileA.o’ and ‘fileB.o’ both contain out of line bodies of a
particular inlineable function, they will also both contain coverage counts for that function.
When ‘fileA.o’ and ‘fileB.o’ are linked together, the linker will, on many systems, select
one of those out of line bodies for all calls to that function, and remove or ignore the other.
Unfortunately, it will not remove the coverage counters for the unused function body. Hence
when instrumented, all but one use of that function will show zero counts.
If the function is inlined in several places, the block structure in each location might not
be the same. For instance, a condition might now be calculable at compile time in some
instances. Because the coverage of all the uses of the inline function will be shown for the
same source lines, the line counts themselves might seem inconsistent.
Long-running applications can use the __gcov_reset and __gcov_dump facilities to re-
strict profile collection to the program region of interest. Calling __gcov_reset(void) will
clear all run-time profile counters to zero, and calling __gcov_dump(void) will cause the
profile information collected at that point to be dumped to ‘.gcda’ output files. Instru-
mented applications use a static destructor with priority 99 to invoke the __gcov_dump
function. Thus __gcov_dump is executed after all user defined static destructors, as well as
handlers registered with atexit.
If an executable loads a dynamic shared object via dlopen functionality,
‘-Wl,--dynamic-list-data’ is needed to dump all profile data.
Profiling run-time library reports various errors related to profile manipulation and pro-
file saving. Errors are printed into standard error output or ‘GCOV_ERROR_FILE’ file, if
environment variable is used. In order to terminate immediately after an errors occurs set
‘GCOV_EXIT_AT_ERROR’ environment variable. That can help users to find profile clashing
which leads to a misleading profile.
Chapter 10: gcov—a Test Coverage Program 933
freestanding environments (for example embedded systems) with limited resources. In par-
ticular, systems or test cases which do not support constructors/destructors or the C library
file I/O. In this section, the target system runs your application instrumented for profiling
or test coverage. You develop and analyze your application on the host system. We now
provide an overview how profiling and test coverage can be obtained in this scenario followed
by a tutorial which can be exercised on the host system. Finally, some system initialization
caveats are listed.
10.6.1 Overview
For an application instrumented for profiling or test coverage, the compiler generates some
global data structures which are updated by instrumentation code while the application
runs. These data structures are called the gcov information. Normally, when the applica-
tion exits, the gcov information is stored to ‘.gcda’ files. There is one file per translation
unit instrumented for profiling or test coverage. The function __gcov_exit(), which stores
the gcov information to a file, is called by a global destructor function for each translation
unit instrumented for profiling or test coverage. It runs at process exit. In a global con-
structor function, the __gcov_init() function is called to register the gcov information of
a translation unit in a global list. In some situations, this procedure does not work. Firstly,
if you want to profile the global constructor or exit processing of an operating system, the
compiler generated functions may conflict with the test objectives. Secondly, you may want
to test early parts of the system initialization or abnormal program behaviour which do not
allow a global constructor or exit processing. Thirdly, you need a filesystem to store the
files.
The ‘-fprofile-info-section’ GCC option enables you to use profiling and test cover-
age in freestanding environments. This option disables the use of global constructors and
destructors for the gcov information. Instead, a pointer to the gcov information is stored in
a special linker input section for each translation unit which is compiled with this option.
By default, the section name is .gcov_info. The gcov information is statically initialized.
The pointers to the gcov information from all translation units of an executable can be
collected by the linker in a contiguous memory block. For the GNU linker, the below linker
script output section definition can be used to achieve this:
.gcov_info :
{
PROVIDE (__gcov_info_start = .);
KEEP (*(.gcov_info))
PROVIDE (__gcov_info_end = .);
}
The linker will provide two global symbols, __gcov_info_start and __gcov_info_end,
which define the start and end of the array of pointers to gcov information blocks, respec-
tively. The KEEP () directive is required to prevent a garbage collection of the pointers.
They are not directly referenced by anything in the executable. The section may be placed
in a read-only memory area.
In order to transfer the profiling and test coverage data from the target to the host
system, the application has to provide a function to produce a reliable in order byte stream
from the target to the host. The byte stream may be compressed and encoded using
error detection and correction codes to meet application-specific requirements. The GCC
provided ‘libgcov’ target library provides two functions, __gcov_info_to_gcda() and __
Chapter 10: gcov—a Test Coverage Program 935
10.6.2 Tutorial
This tutorial should be exercised on the host system. We will build a program instrumented
for test coverage. The program runs an application and dumps the gcov information to
‘stderr’ encoded as a printable character stream. The application simply decodes such
character streams from ‘stdin’ and writes the decoded character stream to ‘stdout’ (warn-
ing: this is binary data). The decoded character stream is consumed by the merge-stream
subcommand of the gcov-tool to create or update the ‘.gcda’ files.
To get started, create an empty directory. Change into the new directory. Then you will
create the following three files in this directory
1. ‘app.h’ - a header file included by ‘app.c’ and ‘main.c’,
2. ‘app.c’ - a source file which contains an example application, and
3. ‘main.c’ - a source file which contains the program main function and code to dump
the gcov information.
Firstly, create the header file ‘app.h’ with the following content:
static const unsigned char a = ’a’;
#include <stdio.h>
void
application (void)
{
int first = 1;
int i;
unsigned char c;
936 Using the GNU Compiler Collection (GCC)
if (can_decode (x))
{
if (first)
c = x - a;
else
fputc (c + 16 * (x - a), stdout);
first = !first;
}
else
first = 1;
}
}
Thirdly, create the source file ‘main.c’ with the following content:
#include "app.h"
#include <gcov.h>
#include <stdio.h>
#include <stdlib.h>
/* The start and end symbols are provided by the linker script. We use the
array notation to avoid issues with a potential small-data area. */
/* This function shall produce a reliable in order byte stream to transfer the
gcov information from the target to the host system. */
static void
dump (const void *d, unsigned n, void *arg)
{
(void)arg;
const unsigned char *c = d;
unsigned char buf[2];
static void
filename (const char *f, void *arg)
{
__gcov_filename_to_gcfn (f, dump, arg);
}
static void *
allocate (unsigned length, void *arg)
{
(void)arg;
return malloc (length);
}
static void
dump_gcov_info (void)
{
const struct gcov_info *const *info = __gcov_info_start;
const struct gcov_info *const *end = __gcov_info_end;
/* The main() function just runs the application and then dumps the gcov
information to stderr. */
int
main (void)
{
application ();
dump_gcov_info ();
return 0;
}
If we compile ‘app.c’ with test coverage and no extra profiling options, then a global
constructor (_sub_I_00100_0 here, it may have a different name in your environment) and
destructor (_sub_D_00100_1) is used to register and dump the gcov information, respec-
tively. We also see undefined references to __gcov_init and __gcov_exit:
$ gcc --coverage -c app.c
$ nm app.o
0000000000000000 r a
0000000000000030 T application
0000000000000000 t can_decode
U fgetc
U fputc
0000000000000000 b __gcov0.application
0000000000000038 b __gcov0.can_decode
0000000000000000 d __gcov_.application
00000000000000c0 d __gcov_.can_decode
U __gcov_exit
U __gcov_init
U __gcov_merge_add
U stdin
U stdout
938 Using the GNU Compiler Collection (GCC)
0000000000000161 t _sub_D_00100_1
0000000000000151 t _sub_I_00100_0
Compile ‘app.c’ and ‘main.c’ with test coverage and ‘-fprofile-info-section’. Now, a
read-only pointer size object is present in the .gcov_info section and there are no undefined
references to __gcov_init and __gcov_exit:
$ gcc --coverage -fprofile-info-section -c main.c
$ gcc --coverage -fprofile-info-section -c app.c
$ objdump -h app.o
Sections:
Idx Name Size VMA LMA File off Algn
0 .text 00000151 0000000000000000 0000000000000000 00000040 2**0
CONTENTS, ALLOC, LOAD, RELOC, READONLY, CODE
1 .data 00000100 0000000000000000 0000000000000000 000001a0 2**5
CONTENTS, ALLOC, LOAD, RELOC, DATA
2 .bss 00000040 0000000000000000 0000000000000000 000002a0 2**5
ALLOC
3 .rodata 0000003c 0000000000000000 0000000000000000 000002a0 2**3
CONTENTS, ALLOC, LOAD, READONLY, DATA
4 .gcov_info 00000008 0000000000000000 0000000000000000 000002e0 2**3
CONTENTS, ALLOC, LOAD, RELOC, READONLY, DATA
5 .comment 0000004e 0000000000000000 0000000000000000 000002e8 2**0
CONTENTS, READONLY
6 .note.GNU-stack 00000000 0000000000000000 0000000000000000 00000336 2**0
CONTENTS, READONLY
7 .eh_frame 00000058 0000000000000000 0000000000000000 00000338 2**3
CONTENTS, ALLOC, LOAD, RELOC, READONLY, DATA
We have to customize the program link procedure so that all the .gcov_info linker input
sections are placed in a contiguous memory block with a begin and end symbol. Firstly, get
the default linker script using the following commands (we assume a GNU linker):
$ ld --verbose | sed ’1,/^===/d’ | sed ’/^===/d’ > linkcmds
Secondly, open the file ‘linkcmds’ with a text editor and place the linker output sec-
tion definition from the overview after the .rodata section definition. Link the program
executable using the customized linker script:
$ gcc --coverage main.o app.o -T linkcmds -Wl,-Map,app.map
In the linker map file ‘app.map’, we see that the linker placed the read-only pointer
size objects of our objects files ‘main.o’ and ‘app.o’ into a contiguous memory block and
provided the symbols __gcov_info_start and __gcov_info_end:
$ grep -C 1 "\.gcov_info" app.map
(second run). Run gcov to produce a report for ‘app.c’. We see that the first run with
nothing to decode results in a partially covered application:
$ rm -f app.gcda main.gcda
$ echo "" | ./a.out 2>gcda-0.txt
$ ./a.out <gcda-0.txt 2>gcda-1.txt | gcov-tool merge-stream
$ gcov -bc app.c
File ’app.c’
Lines executed:69.23% of 13
Branches executed:66.67% of 6
Taken at least once:50.00% of 6
Calls executed:66.67% of 3
Creating ’app.c.gcov’
Lines executed:69.23% of 13
Run the program to decode ‘gcda-1.txt’ and send it to the gcov-tool using the merge-
stream subcommand to update the ‘.gcda’ files. Run gcov to produce a report for ‘app.c’.
Since the second run decoded the gcov information of the first run, we have now a fully
covered application:
$ ./a.out <gcda-1.txt 2>gcda-2.txt | gcov-tool merge-stream
$ gcov -bc app.c
File ’app.c’
Lines executed:100.00% of 13
Branches executed:100.00% of 6
Taken at least once:100.00% of 6
Calls executed:100.00% of 3
Creating ’app.c.gcov’
Lines executed:100.00% of 13
-v
--version
Display the gcov-tool version number (on the standard output), and exit
without doing any further processing.
merge Merge two profile directories.
-o directory
--output directory
Set the output profile directory. Default output directory name is
merged profile.
-v
--verbose
Set the verbose mode.
-w w1,w2
--weight w1,w2
Set the merge weights of the directory1 and directory2, respectively.
The default weights are 1 for both.
merge-stream
Collect profiles with associated filenames from a gcfn and gcda data stream.
Read the stream from the file specified by file or from ‘stdin’. Merge the profiles
with associated profiles in the host filesystem. Apply the optional weights while
merging profiles.
For the generation of a gcfn and gcda data stream on the target system, please
have a look at the __gcov_filename_to_gcfn() and __gcov_info_to_gcda()
functions declared in #include <gcov.h>.
-v
--verbose
Set the verbose mode.
-w w1,w2
--weight w1,w2
Set the merge weights of the profiles from the gcfn and gcda data
stream and the associated profiles in the host filesystem, respec-
tively. The default weights are 1 for both.
rewrite Read the specified profile directory and rewrite to a new directory.
-n long_long_value
--normalize <long_long_value>
Normalize the profile. The specified value is the max counter value
in the new profile.
-o directory
--output directory
Set the output profile directory. Default output name is
rewrite profile.
Chapter 11: gcov-tool—an Offline Gcda Profile Processing Tool 943
-s float_or_simple-frac_value
--scale float_or_simple-frac_value
Scale the profile counters. The specified value can be in floating
point value, or simple fraction value form, such 1, 2, 2/3, and 5/3.
-v
--verbose
Set the verbose mode.
overlap Compute the overlap score between the two specified profile directories. The
overlap score is computed based on the arc profiles. It is defined as the sum
of min (p1 counter[i] / p1 sum all, p2 counter[i] / p2 sum all), for all arc
counter i, where p1 counter[i] and p2 counter[i] are two matched counters and
p1 sum all and p2 sum all are the sum of counter values in profile 1 and profile
2, respectively.
-f
--function
Print function level overlap score.
-F
--fullname
Print full gcda filename.
-h
--hotonly
Only print info for hot objects/functions.
-o
--object Print object level overlap score.
-t float
--hot_threshold <float>
Set the threshold for hot counter value.
-v
--verbose
Set the verbose mode.
Chapter 12: gcov-dump—an Offline Gcda and Gcno Profile Dump Tool 945
14.2 Interoperation
This section lists various difficulties encountered in using GCC together with other compilers
or with the assemblers, linkers, libraries and debuggers on certain systems.
• On many platforms, GCC supports a different ABI for C++ than do other compilers, so
the object files compiled by GCC cannot be used with object files generated by another
C++ compiler.
An area where the difference is most apparent is name mangling. The use of different
name mangling is intentional, to protect you from more subtle problems. Compilers
differ as to many internal details of C++ implementation, including: how class instances
are laid out, how multiple inheritance is implemented, and how virtual function calls
are handled. If the name encoding were made the same, your programs would link
against libraries provided from other compilers—but the programs would then crash
when run. Incompatible libraries are then detected at link time, rather than at run
time.
• On some BSD systems, including some versions of Ultrix, use of profiling causes static
variable destructors (currently used only in C++) not to be run.
• On a SPARC, GCC aligns all values of type double on an 8-byte boundary, and it
expects every double to be so aligned. The Sun compiler usually gives double values
8-byte alignment, with one exception: function arguments of type double may not be
aligned.
As a result, if a function compiled with Sun CC takes the address of an argument
of type double and passes this pointer of type double * to a function compiled with
GCC, dereferencing the pointer may cause a fatal signal.
One way to solve this problem is to compile your entire program with GCC. Another
solution is to modify the function that is compiled with Sun CC to copy the argument
into a local variable; local variables are always properly aligned. A third solution is to
modify the function that uses the pointer to dereference it via the following function
access_double instead of directly with ‘*’:
950 Using the GNU Compiler Collection (GCC)
inline double
access_double (double *unaligned_ptr)
{
union d2i { double d; int i[2]; };
u.i[0] = p->i[0];
u.i[1] = p->i[1];
return u.d;
}
Storing into the pointer can be done likewise with the same union.
• On Solaris, the malloc function in the ‘libmalloc.a’ library may allocate memory
that is only 4 byte aligned. Since GCC on the SPARC assumes that doubles are 8 byte
aligned, this may result in a fatal signal if doubles are stored in memory allocated by
the ‘libmalloc.a’ library.
The solution is to not use the ‘libmalloc.a’ library. Use instead malloc and related
functions from ‘libc.a’; they do not have this problem.
• On the HP PA machine, ADB sometimes fails to work on functions compiled with
GCC. Specifically, it fails to work on functions that use alloca or variable-size arrays.
This is because GCC doesn’t generate HP-UX unwind descriptors for such functions.
It may even be impossible to generate them.
• Debugging (‘-g’) is not supported on the HP PA machine, unless you use the prelimi-
nary GNU tools.
• Taking the address of a label may generate errors from the HP-UX PA assembler. GAS
for the PA does not have this problem.
• Using floating point parameters for indirect calls to static functions will not work when
using the HP assembler. There simply is no way for GCC to specify what registers hold
arguments for static functions when using the HP assembler. GAS for the PA does not
have this problem.
• In extremely rare cases involving some very large functions you may receive errors from
the HP linker complaining about an out of bounds unconditional branch offset. This
used to occur more often in previous versions of GCC, but is now exceptionally rare.
If you should run into it, you can work around by making your function smaller.
• GCC compiled code sometimes emits warnings from the HP-UX assembler of the form:
(warning) Use of GR3 when
frame >= 8192 may cause conflict.
These warnings are harmless and can be safely ignored.
• In extremely rare cases involving some very large functions you may receive errors from
the AIX Assembler complaining about a displacement that is too large. If you should
run into it, you can work around by making your function smaller.
• The ‘libstdc++.a’ library in GCC relies on the SVR4 dynamic linker semantics which
merges global symbols between libraries and applications, especially necessary for C++
streams functionality. This is not the default behavior of AIX shared libraries and
dynamic linking. ‘libstdc++.a’ is built on AIX with “runtime-linking” enabled so
Chapter 14: Known Causes of Trouble with GCC 951
that symbol merging can occur. To utilize this feature, the application linked with
‘libstdc++.a’ must include the ‘-Wl,-brtl’ flag on the link line. G++ cannot impose
this because this option may interfere with the semantics of the user program and users
may not always use ‘g++’ to link his or her application. Applications are not required to
use the ‘-Wl,-brtl’ flag on the link line—the rest of the ‘libstdc++.a’ library which
is not dependent on the symbol merging semantics will continue to function correctly.
• An application can interpose its own definition of functions for functions invoked by
‘libstdc++.a’ with “runtime-linking” enabled on AIX. To accomplish this the appli-
cation must be linked with “runtime-linking” option and the functions explicitly must
be exported by the application (‘-Wl,-brtl,-bE:exportfile’).
• AIX on the RS/6000 provides support (NLS) for environments outside of the United
States. Compilers and assemblers use NLS to support locale-specific representations
of various objects including floating-point numbers (‘.’ vs ‘,’ for separating decimal
fractions). There have been problems reported where the library linked with GCC does
not produce the same floating-point formats that the assembler accepts. If you have
this problem, set the LANG environment variable to ‘C’ or ‘En_US’.
• Even if you specify ‘-fdollars-in-identifiers’, you cannot successfully use ‘$’ in
identifiers on the RS/6000 due to a restriction in the IBM assembler. GAS supports
these identifiers.
foo ()
{
int a, b;
a = fun1 ();
if (setjmp (j))
return a;
a = fun2 ();
/* longjmp (j) may occur in fun3. */
return a + fun3 ();
}
Here a may or may not be restored to its first value when the longjmp occurs. If a is
allocated in a register, then its first value is restored; otherwise, it keeps the last value
stored in it.
If you use the ‘-W’ option with the ‘-O’ option, you will get a warning when GCC thinks
such a problem might be possible.
• Programs that use preprocessing directives in the middle of macro arguments do not
work with GCC. For example, a program like this will not work:
foobar (
#define luser
hack)
ISO C does not permit such a construct.
• K&R compilers allow comments to cross over an inclusion boundary (i.e. started in an
include file and ended in the including file).
• Declarations of external variables and functions within a block apply only to the block
containing the declaration. In other words, they have the same scope as any other
declaration in the same place.
In some other C compilers, an extern declaration affects all the rest of the file even if
it happens within a block.
• In traditional C, you can combine long, etc., with a typedef name, as shown here:
typedef int foo;
typedef long foo bar;
In ISO C, this is not allowed: long and other type modifiers require an explicit int.
• PCC allows typedef names to be used as function parameters.
• Traditional C allows the following erroneous pair of declarations to appear together in
a given scope:
typedef int foo;
typedef foo foo;
• GCC treats all characters of identifiers as significant. According to K&R-1 (2.2), “No
more than the first eight characters are significant, although more may be used.”. Also
according to K&R-1 (2.2), “An identifier is a sequence of letters and digits; the first
character must be a letter. The underscore counts as a letter.”, but GCC also allows
dollar signs in identifiers.
• PCC allows whitespace in the middle of compound assignment operators such as ‘+=’.
GCC, following the ISO standard, does not allow this.
Chapter 14: Known Causes of Trouble with GCC 953
what is meant is an operator and two values, the ISO C standard specifically requires
that this be treated as erroneous.
A preprocessing token is a preprocessing number if it begins with a digit and is followed
by letters, underscores, digits, periods and ‘e+’, ‘e-’, ‘E+’, ‘E-’, ‘p+’, ‘p-’, ‘P+’, or ‘P-’
character sequences. (In strict C90 mode, the sequences ‘p+’, ‘p-’, ‘P+’ and ‘P-’ cannot
appear in preprocessing numbers.)
To make the above program fragment valid, place whitespace in front of the minus
sign. This whitespace will end the preprocessing number.
X/Open compatibility for GNU/Linux and HURD-based GNU systems; no recent version
of it supports other systems, though some very old versions did. Version 2.2 of the GNU
C library includes nearly complete C99 support. You could also ask your operating system
vendor if newer libraries are available.
• On 68000 and x86 systems, for instance, you can get paradoxical results if you test
the precise values of floating point numbers. For example, you can find that a floating
point value which is not a NaN is not equal to itself. This results from the fact that
the floating point registers hold a few more bits of precision than fit in a double in
memory. Compiled code moves values between memory and floating point registers at
its convenience, and moving them into memory truncates them.
You can partially avoid this problem by using the ‘-ffloat-store’ option (see
Section 3.11 [Optimize Options], page 163).
• On AIX and other platforms without weak symbol support, templates need to be in-
stantiated explicitly and symbols for static members of templates will not be generated.
• On AIX, GCC scans object files and library archives for static constructors and de-
structors when linking an application before the linker prunes unreferenced symbols.
This is necessary to prevent the AIX linker from mistakenly assuming that static con-
structor or destructor are unused and removing them before the scanning can occur.
All static constructors and destructors found will be referenced even though the mod-
ules in which they occur may not be used by the program. This may lead to both
increased executable size and unexpected symbol references.
This declaration only establishes that the class Foo has an int named Foo::bar, and a
member function named Foo::method. But you still need to define both method and bar
elsewhere. According to the ISO standard, you must supply an initializer in one (and only
one) source file, such as:
int Foo::bar = 0;
Other C++ compilers may not correctly implement the standard behavior. As a result,
when you switch to g++ from one of these compilers, you may discover that a program
that appeared to work correctly in fact does not conform to the standard: g++ reports as
undefined symbols any static data members that lack definitions.
Chapter 14: Known Causes of Trouble with GCC 957
struct A {
template <typename T>
void f () {
foo (1); // 1
int i = N; // 2
T t;
t.bar(); // 3
foo (t); // 4
}
access i in a dependent context, by either using this->i (remember that this is of type
Derived<T>*, so is obviously dependent), or using Base<T>::i. Alternatively, Base<T>::i
might be brought into scope by a using-declaration.
Another, similar example involves calling member functions of a base class:
template <typename T> struct Base {
int f();
};
void
f ()
{
const char *p = strfunc().c_str();
Chapter 14: Known Causes of Trouble with GCC 959
...
charfunc (p);
...
charfunc (p);
}
In this situation, it may seem reasonable to save a pointer to the C string returned by
the c_str member function and use that rather than call c_str repeatedly. However, the
temporary string created by the call to strfunc is destroyed after p is initialized, at which
point p is left pointing to freed memory.
Code like this may run successfully under some other compilers, particularly obsolete
cfront-based compilers that delete temporaries along with normal local variables. How-
ever, the GNU C++ behavior is standard-conforming, so if your program depends on late
destruction of temporaries it is not portable.
The safe way to write such code is to give the temporary a name, which forces it to
remain until the end of the scope of the name. For example:
const string& tmp = strfunc ();
charfunc (tmp.c_str ());
more than once when the implicit copy-assignment for Derived objects is invoked (as it is
inside ‘func’ in the example).
G++ implements the “intuitive” algorithm for copy-assignment: assign all direct bases,
then assign all members. In that algorithm, the virtual base subobject can be encountered
more than once. In the example, copying proceeds in the following order: ‘name’ (via
strdup), ‘val’, ‘name’ again, and ‘bval’.
If application code relies on copy-assignment, a user-defined copy-assignment operator
removes any uncertainties. With such an operator, the application can define whether and
how the virtual base subobject is assigned.
The GNU C compiler supports both dialects; you can specify the signed dialect with
‘-fsigned-bitfields’ and the unsigned dialect with ‘-funsigned-bitfields’. How-
ever, this leaves open the question of which dialect to use by default.
Currently, the preferred dialect makes plain bit-fields signed, because this is simplest.
Since int is the same as signed int in every other context, it is cleanest for them to
be the same in bit-fields as well.
Some computer manufacturers have published Application Binary Interface standards
which specify that plain bit-fields should be unsigned. It is a mistake, however, to say
anything about this issue in an ABI. This is because the handling of plain bit-fields
distinguishes two dialects of C. Both dialects are meaningful on every type of machine.
Whether a particular object file was compiled using signed bit-fields or unsigned is of
no concern to other object files, even if they access the same bit-fields in the same data
structures.
A given program is written in one or the other of these two dialects. The program
stands a chance to work on most any machine if it is compiled with the proper dialect.
It is unlikely to work at all if compiled with the wrong dialect.
Many users appreciate the GNU C compiler because it provides an environment that is
uniform across machines. These users would be inconvenienced if the compiler treated
plain bit-fields differently on certain machines.
Occasionally users write programs intended only for a particular machine type. On
these occasions, the users would benefit if the GNU C compiler were to support by
default the same dialect as the other compilers on that machine. But such applications
are rare. And users writing a program to run on more than one type of machine cannot
possibly benefit from this kind of compatibility.
This is why GCC does and will treat plain bit-fields in the same fashion on all types
of machines (by default).
There are some arguments for making bit-fields unsigned by default on all machines.
If, for example, this becomes a universal de facto standard, it would make sense for
GCC to go along with it. This is something to be considered in the future.
(Of course, users strongly concerned about portability should indicate explicitly in each
bit-field whether it is signed or not. In this way, they write programs which have the
same meaning in both C dialects.)
• Undefining __STDC__ when ‘-ansi’ is not used.
Currently, GCC defines __STDC__ unconditionally. This provides good results in prac-
tice.
Programmers normally use conditionals on __STDC__ to ask whether it is safe to use
certain features of ISO C, such as function prototypes or ISO token concatenation.
Since plain gcc supports all the features of ISO C, the correct answer to these questions
is “yes”.
Some users try to use __STDC__ to check for the availability of certain library facilities.
This is actually incorrect usage in an ISO C program, because the ISO C standard says
that a conforming freestanding implementation should define __STDC__ even though it
does not have the library facilities. ‘gcc -ansi -pedantic’ is a conforming freestanding
implementation, and it is therefore required to define __STDC__, even though it does
not come with an ISO C library.
962 Using the GNU Compiler Collection (GCC)
Sometimes people say that defining __STDC__ in a compiler that does not completely
conform to the ISO C standard somehow violates the standard. This is illogical. The
standard is a standard for compilers that claim to support ISO C, such as ‘gcc -ansi’—
not for other compilers such as plain gcc. Whatever the ISO C standard says is
relevant to the design of plain gcc without ‘-ansi’ only for pragmatic reasons, not as
a requirement.
GCC normally defines __STDC__ to be 1, and in addition defines __STRICT_ANSI__ if
you specify the ‘-ansi’ option, or a ‘-std’ option for strict conformance to some version
of ISO C. On some hosts, system include files use a different convention, where __STDC_
_ is normally 0, but is 1 if the user specifies strict conformance to the C Standard. GCC
follows the host convention when processing system include files, but when processing
user files it follows the usual GNU C convention.
• Undefining __STDC__ in C++.
Programs written to compile with C++-to-C translators get the value of __STDC__ that
goes with the C compiler that is subsequently used. These programs must test __STDC_
_ to determine what kind of C preprocessor that compiler uses: whether they should
concatenate tokens in the ISO C fashion or in the traditional fashion.
These programs work properly with GNU C++ if __STDC__ is defined. They would not
work otherwise.
In addition, many header files are written to provide prototypes in ISO C but not in
traditional C. Many of these header files can work without change in C++ provided
__STDC__ is defined. If __STDC__ is not defined, they will all fail, and will all need to
be changed to test explicitly for C++ as well.
• Deleting “empty” loops.
Historically, GCC has not deleted “empty” loops under the assumption that the most
likely reason you would put one in a program is to have a delay, so deleting them will
not make real programs run any faster.
However, the rationale here is that optimization of a nonempty loop cannot produce an
empty one. This held for carefully written C compiled with less powerful optimizers but
is not always the case for carefully written C++ or with more powerful optimizers. Thus
GCC will remove operations from loops whenever it can determine those operations
are not externally visible (apart from the time taken to execute them, of course). In
case the loop can be proved to be finite, GCC will also remove the loop itself.
Be aware of this when performing timing tests, for instance the following loop can be
completely removed, provided some_expression can provably not change any global
state.
{
int sum = 0;
int ix;
It is never safe to depend on the order of evaluation of side effects. For example, a
function call like this may very well behave differently from one compiler to another:
void func (int, int);
int i = 2;
func (i++, i++);
There is no guarantee (in either the C or the C++ standard language definitions) that the
increments will be evaluated in any particular order. Either increment might happen
first. func might get the arguments ‘2, 3’, or it might get ‘3, 2’, or even ‘2, 2’.
• Making certain warnings into errors by default.
Some ISO C testsuites report failure when the compiler does not produce an error
message for a certain program.
ISO C requires a “diagnostic” message for certain kinds of invalid programs, but a
warning is defined by GCC to count as a diagnostic. If GCC produces a warning but
not an error, that is correct ISO C support. If testsuites call this “failure”, they should
be run with the GCC option ‘-pedantic-errors’, which will turn these warnings into
errors.
15 Reporting Bugs
Your bug reports play an essential role in making GCC reliable.
When you encounter a problem, the first thing to do is to see if it is already known. See
Chapter 14 [Trouble], page 949. If it isn’t known, then you should report the problem.
Preamble
The GNU General Public License is a free, copyleft license for software and other kinds of
works.
The licenses for most software and other practical works are designed to take away your
freedom to share and change the works. By contrast, the GNU General Public License is
intended to guarantee your freedom to share and change all versions of a program–to make
sure it remains free software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to any other work
released this way by its authors. You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General
Public Licenses are designed to make sure that you have the freedom to distribute copies
of free software (and charge for them if you wish), that you receive source code or can get
it if you want it, that you can change the software or use pieces of it in new free programs,
and that you know you can do these things.
To protect your rights, we need to prevent others from denying you these rights or asking
you to surrender the rights. Therefore, you have certain responsibilities if you distribute
copies of the software, or if you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether gratis or for a fee, you
must pass on to the recipients the same freedoms that you received. You must make sure
that they, too, receive or can get the source code. And you must show them these terms so
they know their rights.
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright
on the software, and (2) offer you this License giving you legal permission to copy, distribute
and/or modify it.
For the developers’ and authors’ protection, the GPL clearly explains that there is no
warranty for this free software. For both users’ and authors’ sake, the GPL requires that
modified versions be marked as changed, so that their problems will not be attributed
erroneously to authors of previous versions.
Some devices are designed to deny users access to install or run modified versions of the
software inside them, although the manufacturer can do so. This is fundamentally incom-
patible with the aim of protecting users’ freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to use, which is pre-
cisely where it is most unacceptable. Therefore, we have designed this version of the GPL
to prohibit the practice for those products. If such problems arise substantially in other
domains, we stand ready to extend this provision to those domains in future versions of the
GPL, as needed to protect the freedom of users.
976 Using the GNU Compiler Collection (GCC)
Finally, every program is threatened constantly by software patents. States should not
allow patents to restrict development and use of software on general-purpose computers, but
in those that do, we wish to avoid the special danger that patents applied to a free program
could make it effectively proprietary. To prevent this, the GPL assures that patents cannot
be used to render the program non-free.
The precise terms and conditions for copying, distribution and modification follow.
The “System Libraries” of an executable work include anything, other than the work as
a whole, that (a) is included in the normal form of packaging a Major Component, but
which is not part of that Major Component, and (b) serves only to enable use of the
work with that Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A “Major Component”,
in this context, means a major essential component (kernel, window system, and so
on) of the specific operating system (if any) on which the executable work runs, or a
compiler used to produce the work, or an object code interpreter used to run it.
The “Corresponding Source” for a work in object code form means all the source code
needed to generate, install, and (for an executable work) run the object code and to
modify the work, including scripts to control those activities. However, it does not
include the work’s System Libraries, or general-purpose tools or generally available
free programs which are used unmodified in performing those activities but which are
not part of the work. For example, Corresponding Source includes interface definition
files associated with source files for the work, and the source code for shared libraries
and dynamically linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those subprograms
and other parts of the work.
The Corresponding Source need not include anything that users can regenerate auto-
matically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of copyright on the
Program, and are irrevocable provided the stated conditions are met. This License ex-
plicitly affirms your unlimited permission to run the unmodified Program. The output
from running a covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your rights of fair use
or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not convey, without
conditions so long as your license otherwise remains in force. You may convey covered
works to others for the sole purpose of having them make modifications exclusively
for you, or provide you with facilities for running those works, provided that you
comply with the terms of this License in conveying all material for which you do not
control copyright. Those thus making or running the covered works for you must do
so exclusively on your behalf, under your direction and control, on terms that prohibit
them from making any copies of your copyrighted material outside their relationship
with you.
Conveying under any other circumstances is permitted solely under the conditions
stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
3. Protecting Users’ Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological measure under
any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty
adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention
of such measures.
978 Using the GNU Compiler Collection (GCC)
When you convey a covered work, you waive any legal power to forbid circumvention of
technological measures to the extent such circumvention is effected by exercising rights
under this License with respect to the covered work, and you disclaim any intention
to limit operation or modification of the work as a means of enforcing, against the
work’s users, your or third parties’ legal rights to forbid circumvention of technological
measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program’s source code as you receive it, in any
medium, provided that you conspicuously and appropriately publish on each copy an
appropriate copyright notice; keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code; keep intact all
notices of the absence of any warranty; and give all recipients a copy of this License
along with the Program.
You may charge any price or no price for each copy that you convey, and you may offer
support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to produce it from
the Program, in the form of source code under the terms of section 4, provided that
you also meet all of these conditions:
a. The work must carry prominent notices stating that you modified it, and giving a
relevant date.
b. The work must carry prominent notices stating that it is released under this Li-
cense and any conditions added under section 7. This requirement modifies the
requirement in section 4 to “keep intact all notices”.
c. You must license the entire work, as a whole, under this License to anyone who
comes into possession of a copy. This License will therefore apply, along with any
applicable section 7 additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no permission to license
the work in any other way, but it does not invalidate such permission if you have
separately received it.
d. If the work has interactive user interfaces, each must display Appropriate Legal
Notices; however, if the Program has interactive interfaces that do not display
Appropriate Legal Notices, your work need not make them do so.
A compilation of a covered work with other separate and independent works, which
are not by their nature extensions of the covered work, and which are not combined
with it such as to form a larger program, in or on a volume of a storage or distribution
medium, is called an “aggregate” if the compilation and its resulting copyright are
not used to limit the access or legal rights of the compilation’s users beyond what the
individual works permit. Inclusion of a covered work in an aggregate does not cause
this License to apply to the other parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms of sections 4 and
5, provided that you also convey the machine-readable Corresponding Source under
the terms of this License, in one of these ways:
GNU General Public License 979
a. Convey the object code in, or embodied in, a physical product (including a phys-
ical distribution medium), accompanied by the Corresponding Source fixed on a
durable physical medium customarily used for software interchange.
b. Convey the object code in, or embodied in, a physical product (including a physi-
cal distribution medium), accompanied by a written offer, valid for at least three
years and valid for as long as you offer spare parts or customer support for that
product model, to give anyone who possesses the object code either (1) a copy of
the Corresponding Source for all the software in the product that is covered by this
License, on a durable physical medium customarily used for software interchange,
for a price no more than your reasonable cost of physically performing this con-
veying of source, or (2) access to copy the Corresponding Source from a network
server at no charge.
c. Convey individual copies of the object code with a copy of the written offer to
provide the Corresponding Source. This alternative is allowed only occasionally
and noncommercially, and only if you received the object code with such an offer,
in accord with subsection 6b.
d. Convey the object code by offering access from a designated place (gratis or for
a charge), and offer equivalent access to the Corresponding Source in the same
way through the same place at no further charge. You need not require recipients
to copy the Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source may be on
a different server (operated by you or a third party) that supports equivalent
copying facilities, provided you maintain clear directions next to the object code
saying where to find the Corresponding Source. Regardless of what server hosts
the Corresponding Source, you remain obligated to ensure that it is available for
as long as needed to satisfy these requirements.
e. Convey the object code using peer-to-peer transmission, provided you inform other
peers where the object code and Corresponding Source of the work are being offered
to the general public at no charge under subsection 6d.
A separable portion of the object code, whose source code is excluded from the Cor-
responding Source as a System Library, need not be included in conveying the object
code work.
A “User Product” is either (1) a “consumer product”, which means any tangible per-
sonal property which is normally used for personal, family, or household purposes, or
(2) anything designed or sold for incorporation into a dwelling. In determining whether
a product is a consumer product, doubtful cases shall be resolved in favor of coverage.
For a particular product received by a particular user, “normally used” refers to a
typical or common use of that class of product, regardless of the status of the par-
ticular user or of the way in which the particular user actually uses, or expects or is
expected to use, the product. A product is a consumer product regardless of whether
the product has substantial commercial, industrial or non-consumer uses, unless such
uses represent the only significant mode of use of the product.
“Installation Information” for a User Product means any methods, procedures, autho-
rization keys, or other information required to install and execute modified versions of a
covered work in that User Product from a modified version of its Corresponding Source.
980 Using the GNU Compiler Collection (GCC)
The information must suffice to ensure that the continued functioning of the modified
object code is in no case prevented or interfered with solely because modification has
been made.
If you convey an object code work under this section in, or with, or specifically for
use in, a User Product, and the conveying occurs as part of a transaction in which
the right of possession and use of the User Product is transferred to the recipient in
perpetuity or for a fixed term (regardless of how the transaction is characterized),
the Corresponding Source conveyed under this section must be accompanied by the
Installation Information. But this requirement does not apply if neither you nor any
third party retains the ability to install modified object code on the User Product (for
example, the work has been installed in ROM).
The requirement to provide Installation Information does not include a requirement
to continue to provide support service, warranty, or updates for a work that has been
modified or installed by the recipient, or for the User Product in which it has been
modified or installed. Access to a network may be denied when the modification itself
materially and adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided, in accord with
this section must be in a format that is publicly documented (and with an implementa-
tion available to the public in source code form), and must require no special password
or key for unpacking, reading or copying.
7. Additional Terms.
“Additional permissions” are terms that supplement the terms of this License by mak-
ing exceptions from one or more of its conditions. Additional permissions that are
applicable to the entire Program shall be treated as though they were included in this
License, to the extent that they are valid under applicable law. If additional permis-
sions apply only to part of the Program, that part may be used separately under those
permissions, but the entire Program remains governed by this License without regard
to the additional permissions.
When you convey a copy of a covered work, you may at your option remove any
additional permissions from that copy, or from any part of it. (Additional permissions
may be written to require their own removal in certain cases when you modify the
work.) You may place additional permissions on material, added by you to a covered
work, for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you add to a covered
work, you may (if authorized by the copyright holders of that material) supplement
the terms of this License with terms:
a. Disclaiming warranty or limiting liability differently from the terms of sections 15
and 16 of this License; or
b. Requiring preservation of specified reasonable legal notices or author attributions
in that material or in the Appropriate Legal Notices displayed by works containing
it; or
c. Prohibiting misrepresentation of the origin of that material, or requiring that mod-
ified versions of such material be marked in reasonable ways as different from the
original version; or
GNU General Public License 981
d. Limiting the use for publicity purposes of names of licensors or authors of the
material; or
e. Declining to grant rights under trademark law for use of some trade names, trade-
marks, or service marks; or
f. Requiring indemnification of licensors and authors of that material by anyone who
conveys the material (or modified versions of it) with contractual assumptions
of liability to the recipient, for any liability that these contractual assumptions
directly impose on those licensors and authors.
All other non-permissive additional terms are considered “further restrictions” within
the meaning of section 10. If the Program as you received it, or any part of it, con-
tains a notice stating that it is governed by this License along with a term that is a
further restriction, you may remove that term. If a license document contains a further
restriction but permits relicensing or conveying under this License, you may add to a
covered work material governed by the terms of that license document, provided that
the further restriction does not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you must place, in the
relevant source files, a statement of the additional terms that apply to those files, or a
notice indicating where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the form of a sep-
arately written license, or stated as exceptions; the above requirements apply either
way.
8. Termination.
You may not propagate or modify a covered work except as expressly provided un-
der this License. Any attempt otherwise to propagate or modify it is void, and will
automatically terminate your rights under this License (including any patent licenses
granted under the third paragraph of section 11).
However, if you cease all violation of this License, then your license from a particular
copyright holder is reinstated (a) provisionally, unless and until the copyright holder
explicitly and finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means prior to 60 days
after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if
the copyright holder notifies you of the violation by some reasonable means, this is the
first time you have received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after your receipt of the
notice.
Termination of your rights under this section does not terminate the licenses of parties
who have received copies or rights from you under this License. If your rights have
been terminated and not permanently reinstated, you do not qualify to receive new
licenses for the same material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or run a copy of the
Program. Ancillary propagation of a covered work occurring solely as a consequence of
using peer-to-peer transmission to receive a copy likewise does not require acceptance.
982 Using the GNU Compiler Collection (GCC)
However, nothing other than this License grants you permission to propagate or modify
any covered work. These actions infringe copyright if you do not accept this License.
Therefore, by modifying or propagating a covered work, you indicate your acceptance
of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically receives a license
from the original licensors, to run, modify and propagate that work, subject to this
License. You are not responsible for enforcing compliance by third parties with this
License.
An “entity transaction” is a transaction transferring control of an organization, or
substantially all assets of one, or subdividing an organization, or merging organizations.
If propagation of a covered work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever licenses to the work
the party’s predecessor in interest had or could give under the previous paragraph, plus
a right to possession of the Corresponding Source of the work from the predecessor in
interest, if the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the rights granted or
affirmed under this License. For example, you may not impose a license fee, royalty, or
other charge for exercise of rights granted under this License, and you may not initiate
litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent
claim is infringed by making, using, selling, offering for sale, or importing the Program
or any portion of it.
11. Patents.
A “contributor” is a copyright holder who authorizes use under this License of the
Program or a work on which the Program is based. The work thus licensed is called
the contributor’s “contributor version”.
A contributor’s “essential patent claims” are all patent claims owned or controlled by
the contributor, whether already acquired or hereafter acquired, that would be infringed
by some manner, permitted by this License, of making, using, or selling its contributor
version, but do not include claims that would be infringed only as a consequence of
further modification of the contributor version. For purposes of this definition, “con-
trol” includes the right to grant patent sublicenses in a manner consistent with the
requirements of this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license
under the contributor’s essential patent claims, to make, use, sell, offer for sale, import
and otherwise run, modify and propagate the contents of its contributor version.
In the following three paragraphs, a “patent license” is any express agreement or com-
mitment, however denominated, not to enforce a patent (such as an express permission
to practice a patent or covenant not to sue for patent infringement). To “grant” such
a patent license to a party means to make such an agreement or commitment not to
enforce a patent against the party.
If you convey a covered work, knowingly relying on a patent license, and the Corre-
sponding Source of the work is not available for anyone to copy, free of charge and under
the terms of this License, through a publicly available network server or other readily
accessible means, then you must either (1) cause the Corresponding Source to be so
GNU General Public License 983
available, or (2) arrange to deprive yourself of the benefit of the patent license for this
particular work, or (3) arrange, in a manner consistent with the requirements of this
License, to extend the patent license to downstream recipients. “Knowingly relying”
means you have actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient’s use of the covered work in a country,
would infringe one or more identifiable patents in that country that you have reason
to believe are valid.
If, pursuant to or in connection with a single transaction or arrangement, you convey,
or propagate by procuring conveyance of, a covered work, and grant a patent license
to some of the parties receiving the covered work authorizing them to use, propagate,
modify or convey a specific copy of the covered work, then the patent license you grant
is automatically extended to all recipients of the covered work and works based on it.
A patent license is “discriminatory” if it does not include within the scope of its cover-
age, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the
rights that are specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is in the business of
distributing software, under which you make payment to the third party based on the
extent of your activity of conveying the work, and under which the third party grants,
to any of the parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work conveyed by you (or
copies made from those copies), or (b) primarily for and in connection with specific
products or compilations that contain the covered work, unless you entered into that
arrangement, or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting any implied license or
other defenses to infringement that may otherwise be available to you under applicable
patent law.
12. No Surrender of Others’ Freedom.
If conditions are imposed on you (whether by court order, agreement or otherwise) that
contradict the conditions of this License, they do not excuse you from the conditions
of this License. If you cannot convey a covered work so as to satisfy simultaneously
your obligations under this License and any other pertinent obligations, then as a
consequence you may not convey it at all. For example, if you agree to terms that
obligate you to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this License would
be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have permission to link or
combine any covered work with a work licensed under version 3 of the GNU Affero
General Public License into a single combined work, and to convey the resulting work.
The terms of this License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License, section 13,
concerning interaction through a network will apply to the combination as such.
14. Revised Versions of this License.
984 Using the GNU Compiler Collection (GCC)
The Free Software Foundation may publish revised and/or new versions of the GNU
General Public License from time to time. Such new versions will be similar in spirit
to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies that
a certain numbered version of the GNU General Public License “or any later version”
applies to it, you have the option of following the terms and conditions either of that
numbered version or of any later version published by the Free Software Foundation.
If the Program does not specify a version number of the GNU General Public License,
you may choose any version ever published by the Free Software Foundation.
If the Program specifies that a proxy can decide which future versions of the GNU
General Public License can be used, that proxy’s public statement of acceptance of a
version permanently authorizes you to choose that version for the Program.
Later license versions may give you additional or different permissions. However, no
additional obligations are imposed on any author or copyright holder as a result of your
choosing to follow a later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PER-
MITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN
WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE
THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EX-
PRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE
OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFEC-
TIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO
MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, IN-
CIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR
INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO
LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUS-
TAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR
OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAM-
AGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided above cannot be given
local legal effect according to their terms, reviewing courts shall apply local law that
most closely approximates an absolute waiver of all civil liability in connection with
the Program, unless a warranty or assumption of liability accompanies a copy of the
Program in return for a fee.
GNU General Public License 985
You should have received a copy of the GNU General Public License
along with this program. If not, see https://www.gnu.org/licenses/.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short notice like this when it
starts in an interactive mode:
program Copyright (C) year name of author
This program comes with ABSOLUTELY NO WARRANTY; for details type ‘show w’.
This is free software, and you are welcome to redistribute it
under certain conditions; type ‘show c’ for details.
The hypothetical commands ‘show w’ and ‘show c’ should show the appropriate parts of
the General Public License. Of course, your program’s commands might be different; for a
GUI interface, you would use an “about box”.
You should also get your employer (if you work as a programmer) or school, if any, to
sign a “copyright disclaimer” for the program, if necessary. For more information on this,
and how to apply and follow the GNU GPL, see https://www.gnu.org/licenses/.
The GNU General Public License does not permit incorporating your program into pro-
prietary programs. If your program is a subroutine library, you may consider it more useful
to permit linking proprietary applications with the library. If this is what you want to do,
use the GNU Lesser General Public License instead of this License. But first, please read
https://www.gnu.org/licenses/why-not-lgpl.html.
GNU Free Documentation License 987
under this License. If a section does not fit the above definition of Secondary then it is
not allowed to be designated as Invariant. The Document may contain zero Invariant
Sections. If the Document does not identify any Invariant Sections then there are none.
The “Cover Texts” are certain short passages of text that are listed, as Front-Cover
Texts or Back-Cover Texts, in the notice that says that the Document is released under
this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may
be at most 25 words.
A “Transparent” copy of the Document means a machine-readable copy, represented
in a format whose specification is available to the general public, that is suitable for
revising the document straightforwardly with generic text editors or (for images com-
posed of pixels) generic paint programs or (for drawings) some widely available drawing
editor, and that is suitable for input to text formatters or for automatic translation to
a variety of formats suitable for input to text formatters. A copy made in an otherwise
Transparent file format whose markup, or absence of markup, has been arranged to
thwart or discourage subsequent modification by readers is not Transparent. An image
format is not Transparent if used for any substantial amount of text. A copy that is
not “Transparent” is called “Opaque”.
Examples of suitable formats for Transparent copies include plain ascii without
markup, Texinfo input format, LaTEX input format, SGML or XML using a publicly
available DTD, and standard-conforming simple HTML, PostScript or PDF designed
for human modification. Examples of transparent image formats include PNG, XCF
and JPG. Opaque formats include proprietary formats that can be read and edited
only by proprietary word processors, SGML or XML for which the DTD and/or
processing tools are not generally available, and the machine-generated HTML,
PostScript or PDF produced by some word processors for output purposes only.
The “Title Page” means, for a printed book, the title page itself, plus such following
pages as are needed to hold, legibly, the material this License requires to appear in the
title page. For works in formats which do not have any title page as such, “Title Page”
means the text near the most prominent appearance of the work’s title, preceding the
beginning of the body of the text.
The “publisher” means any person or entity that distributes copies of the Document
to the public.
A section “Entitled XYZ” means a named subunit of the Document whose title either
is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in
another language. (Here XYZ stands for a specific section name mentioned below, such
as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve
the Title” of such a section when you modify the Document means that it remains a
section “Entitled XYZ” according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that
this License applies to the Document. These Warranty Disclaimers are considered to
be included by reference in this License, but only as regards disclaiming warranties:
any other implication that these Warranty Disclaimers may have is void and has no
effect on the meaning of this License.
2. VERBATIM COPYING
GNU Free Documentation License 989
You may copy and distribute the Document in any medium, either commercially or
noncommercially, provided that this License, the copyright notices, and the license
notice saying this License applies to the Document are reproduced in all copies, and
that you add no other conditions whatsoever to those of this License. You may not use
technical measures to obstruct or control the reading or further copying of the copies
you make or distribute. However, you may accept compensation in exchange for copies.
If you distribute a large enough number of copies you must also follow the conditions
in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly
display copies.
3. COPYING IN QUANTITY
If you publish printed copies (or copies in media that commonly have printed covers) of
the Document, numbering more than 100, and the Document’s license notice requires
Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all
these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
the back cover. Both covers must also clearly and legibly identify you as the publisher
of these copies. The front cover must present the full title with all words of the title
equally prominent and visible. You may add other material on the covers in addition.
Copying with changes limited to the covers, as long as they preserve the title of the
Document and satisfy these conditions, can be treated as verbatim copying in other
respects.
If the required texts for either cover are too voluminous to fit legibly, you should put
the first ones listed (as many as fit reasonably) on the actual cover, and continue the
rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100,
you must either include a machine-readable Transparent copy along with each Opaque
copy, or state in or with each Opaque copy a computer-network location from which
the general network-using public has access to download using public-standard network
protocols a complete Transparent copy of the Document, free of added material. If
you use the latter option, you must take reasonably prudent steps, when you begin
distribution of Opaque copies in quantity, to ensure that this Transparent copy will
remain thus accessible at the stated location until at least one year after the last time
you distribute an Opaque copy (directly or through your agents or retailers) of that
edition to the public.
It is requested, but not required, that you contact the authors of the Document well
before redistributing any large number of copies, to give them a chance to provide you
with an updated version of the Document.
4. MODIFICATIONS
You may copy and distribute a Modified Version of the Document under the conditions
of sections 2 and 3 above, provided that you release the Modified Version under precisely
this License, with the Modified Version filling the role of the Document, thus licensing
distribution and modification of the Modified Version to whoever possesses a copy of
it. In addition, you must do these things in the Modified Version:
A. Use in the Title Page (and on the covers, if any) a title distinct from that of the
Document, and from those of previous versions (which should, if there were any,
990 Using the GNU Compiler Collection (GCC)
be listed in the History section of the Document). You may use the same title as
a previous version if the original publisher of that version gives permission.
B. List on the Title Page, as authors, one or more persons or entities responsible for
authorship of the modifications in the Modified Version, together with at least five
of the principal authors of the Document (all of its principal authors, if it has fewer
than five), unless they release you from this requirement.
C. State on the Title page the name of the publisher of the Modified Version, as the
publisher.
D. Preserve all the copyright notices of the Document.
E. Add an appropriate copyright notice for your modifications adjacent to the other
copyright notices.
F. Include, immediately after the copyright notices, a license notice giving the public
permission to use the Modified Version under the terms of this License, in the form
shown in the Addendum below.
G. Preserve in that license notice the full lists of Invariant Sections and required Cover
Texts given in the Document’s license notice.
H. Include an unaltered copy of this License.
I. Preserve the section Entitled “History”, Preserve its Title, and add to it an item
stating at least the title, year, new authors, and publisher of the Modified Version
as given on the Title Page. If there is no section Entitled “History” in the Docu-
ment, create one stating the title, year, authors, and publisher of the Document
as given on its Title Page, then add an item describing the Modified Version as
stated in the previous sentence.
J. Preserve the network location, if any, given in the Document for public access to
a Transparent copy of the Document, and likewise the network locations given in
the Document for previous versions it was based on. These may be placed in the
“History” section. You may omit a network location for a work that was published
at least four years before the Document itself, or if the original publisher of the
version it refers to gives permission.
K. For any section Entitled “Acknowledgements” or “Dedications”, Preserve the Title
of the section, and preserve in the section all the substance and tone of each of the
contributor acknowledgements and/or dedications given therein.
L. Preserve all the Invariant Sections of the Document, unaltered in their text and
in their titles. Section numbers or the equivalent are not considered part of the
section titles.
M. Delete any section Entitled “Endorsements”. Such a section may not be included
in the Modified Version.
N. Do not retitle any existing section to be Entitled “Endorsements” or to conflict in
title with any Invariant Section.
O. Preserve any Warranty Disclaimers.
If the Modified Version includes new front-matter sections or appendices that qualify
as Secondary Sections and contain no material copied from the Document, you may at
your option designate some or all of these sections as invariant. To do this, add their
GNU Free Documentation License 991
titles to the list of Invariant Sections in the Modified Version’s license notice. These
titles must be distinct from any other section titles.
You may add a section Entitled “Endorsements”, provided it contains nothing but
endorsements of your Modified Version by various parties—for example, statements of
peer review or that the text has been approved by an organization as the authoritative
definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up
to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified
Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be
added by (or through arrangements made by) any one entity. If the Document already
includes a cover text for the same cover, previously added by you or by arrangement
made by the same entity you are acting on behalf of, you may not add another; but
you may replace the old one, on explicit permission from the previous publisher that
added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission
to use their names for publicity for or to assert or imply endorsement of any Modified
Version.
5. COMBINING DOCUMENTS
You may combine the Document with other documents released under this License,
under the terms defined in section 4 above for modified versions, provided that you
include in the combination all of the Invariant Sections of all of the original documents,
unmodified, and list them all as Invariant Sections of your combined work in its license
notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical
Invariant Sections may be replaced with a single copy. If there are multiple Invariant
Sections with the same name but different contents, make the title of each such section
unique by adding at the end of it, in parentheses, the name of the original author or
publisher of that section if known, or else a unique number. Make the same adjustment
to the section titles in the list of Invariant Sections in the license notice of the combined
work.
In the combination, you must combine any sections Entitled “History” in the vari-
ous original documents, forming one section Entitled “History”; likewise combine any
sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You
must delete all sections Entitled “Endorsements.”
6. COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other documents released
under this License, and replace the individual copies of this License in the various
documents with a single copy that is included in the collection, provided that you
follow the rules of this License for verbatim copying of each of the documents in all
other respects.
You may extract a single document from such a collection, and distribute it individu-
ally under this License, provided you insert a copy of this License into the extracted
document, and follow this License in all other respects regarding verbatim copying of
that document.
992 Using the GNU Compiler Collection (GCC)
Contributors to GCC
The GCC project would like to thank its many contributors. Without them the project
would not have been nearly as successful as it has been. Any omissions in this list are
accidental. Feel free to contact [email protected] or [email protected] if you have been
left out or some of your contributions are not listed. Please keep this list in alphabetical
order.
• Analog Devices helped implement the support for complex data types and iterators.
• John David Anglin for threading-related fixes and improvements to libstdc++-v3, and
the HP-UX port.
• James van Artsdalen wrote the code that makes efficient use of the Intel 80387 register
stack.
• Abramo and Roberto Bagnara for the SysV68 Motorola 3300 Delta Series port.
• Alasdair Baird for various bug fixes.
• Giovanni Bajo for analyzing lots of complicated C++ problem reports.
• Peter Barada for his work to improve code generation for new ColdFire cores.
• Gerald Baumgartner added the signature extension to the C++ front end.
• Godmar Back for his Java improvements and encouragement.
• Scott Bambrough for help porting the Java compiler.
• Wolfgang Bangerth for processing tons of bug reports.
• Jon Beniston for his Microsoft Windows port of Java and port to Lattice Mico32.
• Daniel Berlin for better DWARF 2 support, faster/better optimizations, improved alias
analysis, plus migrating GCC to Bugzilla.
• Geoff Berry for his Java object serialization work and various patches.
• David Binderman tests weekly snapshots of GCC trunk against Fedora Rawhide for
several architectures.
• Laurynas Biveinis for memory management work and DJGPP port fixes.
• Uros Bizjak for the implementation of x87 math built-in functions and for various
middle end and i386 back end improvements and bug fixes.
• Eric Blake for helping to make GCJ and libgcj conform to the specifications.
• Janne Blomqvist for contributions to GNU Fortran.
• Hans-J. Boehm for his garbage collector, IA-64 libffi port, and other Java work.
• Segher Boessenkool for helping maintain the PowerPC port and the instruction com-
biner plus various contributions to the middle end.
• Neil Booth for work on cpplib, lang hooks, debug hooks and other miscellaneous clean-
ups.
• Steven Bosscher for integrating the GNU Fortran front end into GCC and for con-
tributing to the tree-ssa branch.
• Eric Botcazou for fixing middle- and backend bugs left and right.
• Per Bothner for his direction via the steering committee and various improvements
to the infrastructure for supporting new languages. Chill front end implementation.
996 Using the GNU Compiler Collection (GCC)
Initial implementations of cpplib, fix-header, config.guess, libio, and past C++ library
(libg++) maintainer. Dreaming up, designing and implementing much of GCJ.
• Devon Bowen helped port GCC to the Tahoe.
• Don Bowman for mips-vxworks contributions.
• James Bowman for the FT32 port.
• Dave Brolley for work on cpplib and Chill.
• Paul Brook for work on the ARM architecture and maintaining GNU Fortran.
• Robert Brown implemented the support for Encore 32000 systems.
• Christian Bruel for improvements to local store elimination.
• Herman A.J. ten Brugge for various fixes.
• Joerg Brunsmann for Java compiler hacking and help with the GCJ FAQ.
• Joe Buck for his direction via the steering committee from its creation to 2013.
• Iain Buclaw for the D frontend.
• Craig Burley for leadership of the G77 Fortran effort.
• Tobias Burnus for contributions to GNU Fortran.
• Stephan Buys for contributing Doxygen notes for libstdc++.
• Paolo Carlini for libstdc++ work: lots of efficiency improvements to the C++ strings,
streambufs and formatted I/O, hard detective work on the frustrating localization
issues, and keeping up with the problem reports.
• John Carr for his alias work, SPARC hacking, infrastructure improvements, previous
contributions to the steering committee, loop optimizations, etc.
• Stephane Carrez for 68HC11 and 68HC12 ports.
• Steve Chamberlain for support for the Renesas SH and H8 processors and the PicoJava
processor, and for GCJ config fixes.
• Glenn Chambers for help with the GCJ FAQ.
• John-Marc Chandonia for various libgcj patches.
• Denis Chertykov for contributing and maintaining the AVR port, the first GCC port
for an 8-bit architecture.
• Kito Cheng for his work on the RISC-V port, including bringing up the test suite and
maintenance.
• Scott Christley for his Objective-C contributions.
• Eric Christopher for his Java porting help and clean-ups.
• Branko Cibej for more warning contributions.
• The GNU Classpath project for all of their merged runtime code.
• Nick Clifton for arm, mcore, fr30, v850, m32r, msp430 rx work, ‘--help’, and other
random hacking.
• Michael Cook for libstdc++ cleanup patches to reduce warnings.
• R. Kelley Cook for making GCC buildable from a read-only directory as well as other
miscellaneous build process and documentation clean-ups.
• Ralf Corsepius for SH testing and minor bug fixing.
Contributors to GCC 997
• Ben Elliston for his work to move the Objective-C runtime into its own subdirectory
and for his work on autoconf.
• Revital Eres for work on the PowerPC 750CL port.
• Marc Espie for OpenBSD support.
• Doug Evans for much of the global optimization framework, arc, m32r, and SPARC
work.
• Christopher Faylor for his work on the Cygwin port and for caring and feeding the
gcc.gnu.org box and saving its users tons of spam.
• Fred Fish for BeOS support and Ada fixes.
• Ivan Fontes Garcia for the Portuguese translation of the GCJ FAQ.
• Peter Gerwinski for various bug fixes and the Pascal front end.
• Kaveh R. Ghazi for his direction via the steering committee, amazing work to make
‘-W -Wall -W* -Werror’ useful, and testing GCC on a plethora of platforms. Kaveh
extends his gratitude to the CAIP Center at Rutgers University for providing him with
computing resources to work on Free Software from the late 1980s to 2010.
• John Gilmore for a donation to the FSF earmarked improving GNU Java.
• Judy Goldberg for c++ contributions.
• Torbjorn Granlund for various fixes and the c-torture testsuite, multiply- and divide-
by-constant optimization, improved long long support, improved leaf function register
allocation, and his direction via the steering committee.
• Jonny Grant for improvements to collect2’s ‘--help’ documentation.
• Anthony Green for his ‘-Os’ contributions, the moxie port, and Java front end work.
• Stu Grossman for gdb hacking, allowing GCJ developers to debug Java code.
• Michael K. Gschwind contributed the port to the PDP-11.
• Richard Biener for his ongoing middle-end contributions and bug fixes and for release
management.
• Ron Guilmette implemented the protoize and unprotoize tools, the support for
DWARF 1 symbolic debugging information, and much of the support for System V
Release 4. He has also worked heavily on the Intel 386 and 860 support.
• Sumanth Gundapaneni for contributing the CR16 port.
• Mostafa Hagog for Swing Modulo Scheduling (SMS) and post reload GCSE.
• Bruno Haible for improvements in the runtime overhead for EH, new warnings and
assorted bug fixes.
• Andrew Haley for his amazing Java compiler and library efforts.
• Chris Hanson assisted in making GCC work on HP-UX for the 9000 series 300.
• Michael Hayes for various thankless work he’s done trying to get the c30/c40 ports
functional. Lots of loop and unroll improvements and fixes.
• Dara Hazeghi for wading through myriads of target-specific bug reports.
• Kate Hedstrom for staking the G77 folks with an initial testsuite.
• Richard Henderson for his ongoing SPARC, alpha, ia32, and ia64 work, loop opts, and
generally fixing lots of old problems we’ve ignored for years, flow rewrite and lots of
further stuff, including reviewing tons of patches.
Contributors to GCC 999
• Aldy Hernandez for working on the PowerPC port, SIMD support, and various fixes.
• Nobuyuki Hikichi of Software Research Associates, Tokyo, contributed the support for
the Sony NEWS machine.
• Kazu Hirata for caring and feeding the Renesas H8/300 port and various fixes.
• Katherine Holcomb for work on GNU Fortran.
• Manfred Hollstein for his ongoing work to keep the m88k alive, lots of testing and bug
fixing, particularly of GCC configury code.
• Steve Holmgren for MachTen patches.
• Mat Hostetter for work on the TILE-Gx and TILEPro ports.
• Jan Hubicka for his x86 port improvements.
• Falk Hueffner for working on C and optimization bug reports.
• Bernardo Innocenti for his m68k work, including merging of ColdFire improvements
and uClinux support.
• Christian Iseli for various bug fixes.
• Kamil Iskra for general m68k hacking.
• Lee Iverson for random fixes and MIPS testing.
• Balaji V. Iyer for Cilk+ development and merging.
• Andreas Jaeger for testing and benchmarking of GCC and various bug fixes.
• Martin Jambor for his work on inter-procedural optimizations, the switch conversion
pass, and scalar replacement of aggregates.
• Jakub Jelinek for his SPARC work and sibling call optimizations as well as lots of bug
fixes and test cases, and for improving the Java build system.
• Janis Johnson for ia64 testing and fixes, her quality improvement sidetracks, and web
page maintenance.
• Kean Johnston for SCO OpenServer support and various fixes.
• Tim Josling for the sample language treelang based originally on Richard Kenner’s
“toy” language.
• Nicolai Josuttis for additional libstdc++ documentation.
• Klaus Kaempf for his ongoing work to make alpha-vms a viable target.
• Steven G. Kargl for work on GNU Fortran.
• David Kashtan of SRI adapted GCC to VMS.
• Ryszard Kabatek for many, many libstdc++ bug fixes and optimizations of strings,
especially member functions, and for auto ptr fixes.
• Geoffrey Keating for his ongoing work to make the PPC work for GNU/Linux and his
automatic regression tester.
• Brendan Kehoe for his ongoing work with G++ and for a lot of early work in just about
every part of libstdc++.
• Oliver M. Kellogg of Deutsche Aerospace contributed the port to the MIL-STD-1750A.
• Richard Kenner of the New York University Ultracomputer Research Laboratory wrote
the machine descriptions for the AMD 29000, the DEC Alpha, the IBM RT PC, and
the IBM RS/6000 as well as the support for instruction attributes. He also made
1000 Using the GNU Compiler Collection (GCC)
• Martin von Löwis for internal consistency checking infrastructure, various C++ improve-
ments including namespace support, and tons of assistance with libstdc++/compiler
merges.
• H.J. Lu for his previous contributions to the steering committee, many x86 bug reports,
prototype patches, and keeping the GNU/Linux ports working.
• Greg McGary for random fixes and (someday) bounded pointers.
• Andrew MacLeod for his ongoing work in building a real EH system, various code
generation improvements, work on the global optimizer, etc.
• Vladimir Makarov for hacking some ugly i960 problems, PowerPC hacking improve-
ments to compile-time performance, overall knowledge and direction in the area of
instruction scheduling, design and implementation of the automaton based instruction
scheduler and design and implementation of the integrated and local register allocators.
• David Malcolm for his work on improving GCC diagnostics, JIT, self-tests and unit
testing.
• Bob Manson for his behind the scenes work on dejagnu.
• John Marino for contributing the DragonFly BSD port.
• Philip Martin for lots of libstdc++ string and vector iterator fixes and improvements,
and string clean up and testsuites.
• Michael Matz for his work on dominance tree discovery, the x86-64 port, link-time
optimization framework and general optimization improvements.
• All of the Mauve project contributors for Java test code.
• Bryce McKinlay for numerous GCJ and libgcj fixes and improvements.
• Adam Megacz for his work on the Microsoft Windows port of GCJ.
• Michael Meissner for LRS framework, ia32, m32r, v850, m88k, MIPS, powerpc, haifa,
ECOFF debug support, and other assorted hacking.
• Jason Merrill for his direction via the steering committee and leading the G++ effort.
• Martin Michlmayr for testing GCC on several architectures using the entire Debian
archive.
• David Miller for his direction via the steering committee, lots of SPARC work, im-
provements in jump.cc and interfacing with the Linux kernel developers.
• Gary Miller ported GCC to Charles River Data Systems machines.
• Alfred Minarik for libstdc++ string and ios bug fixes, and turning the entire libstdc++
testsuite namespace-compatible.
• Mark Mitchell for his direction via the steering committee, mountains of C++ work,
load/store hoisting out of loops, alias analysis improvements, ISO C restrict support,
and serving as release manager from 2000 to 2011.
• Alan Modra for various GNU/Linux bits and testing.
• Toon Moene for his direction via the steering committee, Fortran maintenance, and his
ongoing work to make us make Fortran run fast.
• Jason Molenda for major help in the care and feeding of all the services on the
gcc.gnu.org (formerly egcs.cygnus.com) machine—mail, web services, ftp services, etc
etc. Doing all this work on scrap paper and the backs of envelopes would have been. . .
difficult.
1002 Using the GNU Compiler Collection (GCC)
• Catherine Moore for fixing various ugly problems we have sent her way, including the
haifa bug which was killing the Alpha & PowerPC Linux kernels.
• Mike Moreton for his various Java patches.
• David Mosberger-Tang for various Alpha improvements, and for the initial IA-64 port.
• Stephen Moshier contributed the floating point emulator that assists in cross-
compilation and permits support for floating point numbers wider than 64 bits and
for ISO C99 support.
• Bill Moyer for his behind the scenes work on various issues.
• Philippe De Muyter for his work on the m68k port.
• Joseph S. Myers for his work on the PDP-11 port, format checking and ISO C99
support, and continuous emphasis on (and contributions to) documentation.
• Nathan Myers for his work on libstdc++-v3: architecture and authorship through the
first three snapshots, including implementation of locale infrastructure, string, shadow
C headers, and the initial project documentation (DESIGN, CHECKLIST, and so
forth). Later, more work on MT-safe string and shadow headers.
• Felix Natter for documentation on porting libstdc++.
• Nathanael Nerode for cleaning up the configuration/build process.
• NeXT, Inc. donated the front end that supports the Objective-C language.
• Hans-Peter Nilsson for the CRIS and MMIX ports, improvements to the search engine
setup, various documentation fixes and other small fixes.
• Geoff Noer for his work on getting cygwin native builds working.
• Vegard Nossum for running automated regression testing of GCC and reporting nu-
merous bugs.
• Diego Novillo for his work on Tree SSA, OpenMP, SPEC performance tracking web
pages, GIMPLE tuples, and assorted fixes.
• David O’Brien for the FreeBSD/alpha, FreeBSD/AMD x86-64, FreeBSD/ARM,
FreeBSD/PowerPC, and FreeBSD/SPARC64 ports and related infrastructure
improvements.
• Alexandre Oliva for various build infrastructure improvements, scripts and amazing
testing work, including keeping libtool issues sane and happy.
• Stefan Olsson for work on mt alloc.
• Melissa O’Neill for various NeXT fixes.
• Rainer Orth for random MIPS work, including improvements to GCC’s o32 ABI sup-
port, improvements to dejagnu’s MIPS support, Java configuration clean-ups and port-
ing work, and maintaining the IRIX, Solaris 2, and Tru64 UNIX ports.
• Steven Pemberton for his contribution of ‘enquire’ which allowed GCC to determine
various properties of the floating point unit and generate ‘float.h’ in older versions
of GCC.
• Hartmut Penner for work on the s390 port.
• Paul Petersen wrote the machine description for the Alliant FX/8.
• Alexandre Petit-Bianco for implementing much of the Java compiler and continued
Java maintainership.
Contributors to GCC 1003
• Gerhard Steinmetz for running automated regression testing of GCC and reporting
numerous bugs.
• Nigel Stephens for various mips16 related fixes/improvements.
• Jonathan Stone wrote the machine description for the Pyramid computer.
• Graham Stott for various infrastructure improvements.
• John Stracke for his Java HTTP protocol fixes.
• Mike Stump for his Elxsi port, G++ contributions over the years and more recently his
vxworks contributions
• Jeff Sturm for Java porting help, bug fixes, and encouragement.
• Zhendong Su for running automated regression testing of GCC and reporting numerous
bugs.
• Chengnian Sun for running automated regression testing of GCC and reporting numer-
ous bugs.
• Shigeya Suzuki for this fixes for the bsdi platforms.
• Ian Lance Taylor for the Go frontend, the initial mips16 and mips64 support, general
configury hacking, fixincludes, etc.
• Holger Teutsch provided the support for the Clipper CPU.
• Gary Thomas for his ongoing work to make the PPC work for GNU/Linux.
• Paul Thomas for contributions to GNU Fortran.
• Philipp Thomas for random bug fixes throughout the compiler
• Jason Thorpe for thread support in libstdc++ on NetBSD.
• Kresten Krab Thorup wrote the run time support for the Objective-C language and
the fantastic Java bytecode interpreter.
• Michael Tiemann for random bug fixes, the first instruction scheduler, initial C++
support, function integration, NS32k, SPARC and M88k machine description work,
delay slot scheduling.
• Andreas Tobler for his work porting libgcj to Darwin.
• Teemu Torma for thread safe exception handling support.
• Leonard Tower wrote parts of the parser, RTL generator, and RTL definitions, and of
the VAX machine description.
• Daniel Towner and Hariharan Sandanagobalane contributed and maintain the picoChip
port.
• Tom Tromey for internationalization support and for his many Java contributions and
libgcj maintainership.
• Lassi Tuura for improvements to config.guess to determine HP processor types.
• Petter Urkedal for libstdc++ CXXFLAGS, math, and algorithms fixes.
• Andy Vaught for the design and initial implementation of the GNU Fortran front end.
• Brent Verner for work with the libstdc++ cshadow files and their associated configure
steps.
• Todd Vierling for contributions for NetBSD ports.
• Andrew Waterman for contributing the RISC-V port, as well as maintaining it.
1006 Using the GNU Compiler Collection (GCC)
• Jonathan Wakely for contributing libstdc++ Doxygen notes and XHTML guidance and
maintaining libstdc++.
• Dean Wakerley for converting the install documentation from HTML to texinfo in time
for GCC 3.0.
• Krister Walfridsson for random bug fixes.
• Feng Wang for contributions to GNU Fortran.
• Stephen M. Webb for time and effort on making libstdc++ shadow files work with the
tricky Solaris 8+ headers, and for pushing the build-time header tree. Also, for starting
and driving the <regex> effort.
• John Wehle for various improvements for the x86 code generator, related infrastructure
improvements to help x86 code generation, value range propagation and other work,
WE32k port.
• Ulrich Weigand for work on the s390 port.
• Janus Weil for contributions to GNU Fortran.
• Zack Weinberg for major work on cpplib and various other bug fixes.
• Matt Welsh for help with Linux Threads support in GCJ.
• Urban Widmark for help fixing java.io.
• Mark Wielaard for new Java library code and his work integrating with Classpath.
• Dale Wiles helped port GCC to the Tahoe.
• Bob Wilson from Tensilica, Inc. for the Xtensa port.
• Jim Wilson for his direction via the steering committee, tackling hard problems in
various places that nobody else wanted to work on, strength reduction and other loop
optimizations.
• Paul Woegerer and Tal Agmon for the CRX port.
• Carlo Wood for various fixes.
• Tom Wood for work on the m88k port.
• Chung-Ju Wu for his work on the Andes NDS32 port.
• Canqun Yang for work on GNU Fortran.
• Masanobu Yuhara of Fujitsu Laboratories implemented the machine description for the
Tron architecture (specifically, the Gmicro).
• Kevin Zachmann helped port GCC to the Tahoe.
• Ayal Zaks for Swing Modulo Scheduling (SMS).
• Qirun Zhang for running automated regression testing of GCC and reporting numerous
bugs.
• Xiaoqiang Zhang for work on GNU Fortran.
• Gilles Zunino for help porting Java to Irix.
The following people are recognized for their contributions to GNAT, the Ada front end
of GCC:
• Bernard Banner
• Romain Berrendonner
Contributors to GCC 1007
• Geert Bosch
• Emmanuel Briot
• Joel Brobecker
• Ben Brosgol
• Vincent Celier
• Arnaud Charlet
• Chien Chieng
• Cyrille Comar
• Cyrille Crozes
• Robert Dewar
• Gary Dismukes
• Robert Duff
• Ed Falis
• Ramon Fernandez
• Sam Figueroa
• Vasiliy Fofanov
• Michael Friess
• Franco Gasperoni
• Ted Giering
• Matthew Gingell
• Laurent Guerby
• Jerome Guitton
• Olivier Hainque
• Jerome Hugues
• Hristian Kirtchev
• Jerome Lambourg
• Bruno Leclerc
• Albert Lee
• Sean McNeil
• Javier Miranda
• Laurent Nana
• Pascal Obry
• Dong-Ik Oh
• Laurent Pautet
• Brett Porter
• Thomas Quinot
• Nicolas Roche
• Pat Rogers
• Jose Ruiz
1008 Using the GNU Compiler Collection (GCC)
• Douglas Rupp
• Sergey Rybin
• Gail Schenker
• Ed Schonberg
• Nicolas Setton
• Samuel Tardieu
The following people are recognized for their contributions of new features, bug reports,
testing and integration of classpath/libgcj for GCC version 4.1:
• Lillian Angel for JTree implementation and lots Free Swing additions and bug fixes.
• Wolfgang Baer for GapContent bug fixes.
• Anthony Balkissoon for JList, Free Swing 1.5 updates and mouse event fixes, lots of
Free Swing work including JTable editing.
• Stuart Ballard for RMI constant fixes.
• Goffredo Baroncelli for HTTPURLConnection fixes.
• Gary Benson for MessageFormat fixes.
• Daniel Bonniot for Serialization fixes.
• Chris Burdess for lots of gnu.xml and http protocol fixes, StAX and DOM xml:id support.
• Ka-Hing Cheung for TreePath and TreeSelection fixes.
• Archie Cobbs for build fixes, VM interface updates, URLClassLoader updates.
• Kelley Cook for build fixes.
• Martin Cordova for Suggestions for better SocketTimeoutException.
• David Daney for BitSet bug fixes, HttpURLConnection rewrite and improvements.
• Thomas Fitzsimmons for lots of upgrades to the gtk+ AWT and Cairo 2D support.
Lots of imageio framework additions, lots of AWT and Free Swing bug fixes.
• Jeroen Frijters for ClassLoader and nio cleanups, serialization fixes, better Proxy
support, bug fixes and IKVM integration.
• Santiago Gala for AccessControlContext fixes.
• Nicolas Geoffray for VMClassLoader and AccessController improvements.
• David Gilbert for basic and metal icon and plaf support and lots of documenting,
Lots of Free Swing and metal theme additions. MetalIconFactory implementation.
• Anthony Green for MIDI framework, ALSA and DSSI providers.
• Andrew Haley for Serialization and URLClassLoader fixes, gcj build speedups.
• Kim Ho for JFileChooser implementation.
• Andrew John Hughes for Locale and net fixes, URI RFC2986 updates, Serialization
fixes, Properties XML support and generic branch work, VMIntegration guide update.
• Bastiaan Huisman for TimeZone bug fixing.
• Andreas Jaeger for mprec updates.
• Paul Jenner for better ‘-Werror’ support.
• Ito Kazumitsu for NetworkInterface implementation and updates.
Contributors to GCC 1009
• Roman Kennke for BoxLayout, GrayFilter and SplitPane, plus bug fixes all over.
Lots of Free Swing work including styled text.
• Simon Kitching for String cleanups and optimization suggestions.
• Michael Koch for configuration fixes, Locale updates, bug and build fixes.
• Guilhem Lavaux for configuration, thread and channel fixes and Kaffe integration. JCL
native Pointer updates. Logger bug fixes.
• David Lichteblau for JCL support library global/local reference cleanups.
• Aaron Luchko for JDWP updates and documentation fixes.
• Ziga Mahkovec for Graphics2D upgraded to Cairo 0.5 and new regex features.
• Sven de Marothy for BMP imageio support, CSS and TextLayout fixes. GtkImage
rewrite, 2D, awt, free swing and date/time fixes and implementing the Qt4 peers.
• Casey Marshall for crypto algorithm fixes, FileChannel lock, SystemLogger and
FileHandler rotate implementations, NIO FileChannel.map support, security and
policy updates.
• Bryce McKinlay for RMI work.
• Audrius Meskauskas for lots of Free Corba, RMI and HTML work plus testing and
documenting.
• Kalle Olavi Niemitalo for build fixes.
• Rainer Orth for build fixes.
• Andrew Overholt for File locking fixes.
• Ingo Proetel for Image, Logger and URLClassLoader updates.
• Olga Rodimina for MenuSelectionManager implementation.
• Jan Roehrich for BasicTreeUI and JTree fixes.
• Julian Scheid for documentation updates and gjdoc support.
• Christian Schlichtherle for zip fixes and cleanups.
• Robert Schuster for documentation updates and beans fixes, TreeNode enumerations
and ActionCommand and various fixes, XML and URL, AWT and Free Swing bug fixes.
• Keith Seitz for lots of JDWP work.
• Christian Thalinger for 64-bit cleanups, Configuration and VM interface fixes and
CACAO integration, fdlibm updates.
• Gael Thomas for VMClassLoader boot packages support suggestions.
• Andreas Tobler for Darwin and Solaris testing and fixing, Qt4 support for Darwin/OS
X, Graphics2D support, gtk+ updates.
• Dalibor Topic for better DEBUG support, build cleanups and Kaffe integration. Qt4
build infrastructure, SHA1PRNG and GdkPixbugDecoder updates.
• Tom Tromey for Eclipse integration, generics work, lots of bug fixes and gcj integration
including coordinating The Big Merge.
• Mark Wielaard for bug fixes, packaging and release management, Clipboard imple-
mentation, system call interrupts and network timeouts and GdkPixpufDecoder fixes.
In addition to the above, all of which also contributed time and energy in testing GCC,
we would like to thank the following for their contributions to testing:
1010 Using the GNU Compiler Collection (GCC)
• Michael Abd-El-Malek
• Thomas Arend
• Bonzo Armstrong
• Steven Ashe
• Chris Baldwin
• David Billinghurst
• Jim Blandy
• Stephane Bortzmeyer
• Horst von Brand
• Frank Braun
• Rodney Brown
• Sidney Cadot
• Bradford Castalia
• Robert Clark
• Jonathan Corbet
• Ralph Doncaster
• Richard Emberson
• Levente Farkas
• Graham Fawcett
• Mark Fernyhough
• Robert A. French
• Jörgen Freyh
• Mark K. Gardner
• Charles-Antoine Gauthier
• Yung Shing Gene
• David Gilbert
• Simon Gornall
• Fred Gray
• John Griffin
• Patrik Hagglund
• Phil Hargett
• Amancio Hasty
• Takafumi Hayashi
• Bryan W. Headley
• Kevin B. Hendricks
• Joep Jansen
• Christian Joensson
• Michel Kern
• David Kidd
Contributors to GCC 1011
• Tobias Kuipers
• Anand Krishnaswamy
• A. O. V. Le Blanc
• llewelly
• Damon Love
• Brad Lucier
• Matthias Klose
• Martin Knoblauch
• Rick Lutowski
• Jesse Macnish
• Stefan Morrell
• Anon A. Mous
• Matthias Mueller
• Pekka Nikander
• Rick Niles
• Jon Olson
• Magnus Persson
• Chris Pollard
• Richard Polton
• Derk Reefman
• David Rees
• Paul Reilly
• Tom Reilly
• Torsten Rueger
• Danny Sadinoff
• Marc Schifer
• Erik Schnetter
• Wayne K. Schroll
• David Schuler
• Vin Shelton
• Tim Souder
• Adam Sulmicki
• Bill Thorson
• George Talbot
• Pedro A. M. Vazquez
• Gregory Warnes
• Ian Watson
• David E. Young
• And many others
1012 Using the GNU Compiler Collection (GCC)
And finally we’d like to thank everyone who uses the compiler, provides feedback and
generally reminds us why we’re doing this work in the first place.
Option Index 1013
Option Index
GCC’s command line options are indexed here without any initial ‘-’ or ‘--’. Where an
option has both positive and negative forms (such as ‘-foption’ and ‘-fno-option’), rele-
vant entries in the manual are indexed under the most appropriate form; it may sometimes
be useful to look up both forms.
# current_version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
### . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 C . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
- D
-finstrument-functions-once . . . . . . . . . . . . . . . 252 d . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260, 281
-march . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374 da . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
-mbranch-cost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375 dA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
-mcheck-zero-division . . . . . . . . . . . . . . . . . . . . . . 375 dD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260, 285
-mcond-move-float . . . . . . . . . . . . . . . . . . . . . . . . . . 375 dead_strip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
-mcond-move-int . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375 dependency-file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
-mdouble-float . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375 dH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
-mmax-inline-memcpy-size . . . . . . . . . . . . . . . . . . 376 dI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
-mmemcpy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375 dM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
-msingle-float . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375 dN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
-msmall-data-limit . . . . . . . . . . . . . . . . . . . . . . . . . 375 dp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
-mstrict-align . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375 dP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
dump-analyzer-exploded-nodes . . . . . . . . . . . . . . 155
dump-analyzer-exploded-nodes-2 . . . . . . . . . . . 155
8 dump-analyzer-exploded-nodes-3 . . . . . . . . . . . 155
80387 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476 dump-analyzer-feasibility . . . . . . . . . . . . . . . . . 155
dumpbase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
dumpbase-ext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
A dumpdir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
all_load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354 dumpfullversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
allowable_client. . . . . . . . . . . . . . . . . . . . . . . . . . . . 356 dumpmachine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
analyzer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 dumpspecs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
ansi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5, 44, 728, 961 dumpversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
arch_errors_fatal . . . . . . . . . . . . . . . . . . . . . . . . . . 354 dU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
aux-info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 dx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 dylib_file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
dylinker_install_name . . . . . . . . . . . . . . . . . . . . . . 356
dynamic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
B dynamiclib . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
Bdynamic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465 D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
bind_at_load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
block-ops-unaligned-vsx . . . . . . . . . . . . . . . . . . . 440 E
Bstatic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
bundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354 e............................................. 264
bundle_loader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354 entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
B............................................. 269 exported_symbols_list . . . . . . . . . . . . . . . . . . . . . . 356
E . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36, 262
EB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317, 350, 388
C EL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317, 350, 388
c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36, 262
CC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
client_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356 F
compatibility_version . . . . . . . . . . . . . . . . . . . . . . 356 fabi-compat-version . . . . . . . . . . . . . . . . . . . . . . . . . 53
coverage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237 fabi-version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
1014 Using the GNU Compiler Collection (GCC)
nostdlib . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 S
nostdlib++ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
save-temps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
O save-temps=cwd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
save-temps=obj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
o . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 sectalign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 sectcreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
O0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 sectobjectsymbols . . . . . . . . . . . . . . . . . . . . . . . . . . 356
O1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 sectorder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
O2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 seg_addr_table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
O3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 seg_addr_table_filename . . . . . . . . . . . . . . . . . . . 356
Ofast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 seg1addr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
Og . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 segaddr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
Os . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 seglinkedit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
Oz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 segprot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
segs_read_only_addr . . . . . . . . . . . . . . . . . . . . . . . . 356
P segs_read_write_addr . . . . . . . . . . . . . . . . . . . . . . . 356
shared . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
p . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236, 570 shared-libgcc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
pagezero_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356 short-calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
param . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 sim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
pass-exit-codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 sim2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
pedantic . . . . . . . . . . . . . . . . . . . . . 5, 91, 529, 711, 963 single_module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
pedantic-errors. . . . . . . . . . . . . . . . . . . . . . . 5, 92, 963 specs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
pg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236, 570 static. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265, 356, 370
pie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265 static-libasan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
pipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 static-libgcc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
plt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419 static-liblsan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
prebind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356 static-libstdc++. . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
prebind_all_twolevel_modules . . . . . . . . . . . . . . 356 static-libtsan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
print-file-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296 static-libubsan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
print-libgcc-file-name . . . . . . . . . . . . . . . . . . . . . 296 static-pie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
print-multi-directory . . . . . . . . . . . . . . . . . . . . . . 296 std . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5, 44, 728, 961
print-multi-lib . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296 stdlib . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
print-multi-os-directory . . . . . . . . . . . . . . . . . . 296 sub_library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
print-multiarch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296 sub_umbrella . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
print-objc-runtime-info . . . . . . . . . . . . . . . . . . . . . 78 symbolic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
print-prog-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296 sysroot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
print-search-dirs . . . . . . . . . . . . . . . . . . . . . . . . . . 296 S . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36, 262
print-sysroot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
print-sysroot-headers-suffix . . . . . . . . . . . . . . 297
private_bundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356 T
pthread . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255, 265
target-help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
pthreads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
threads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
P . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
tno-android-cc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
Q tno-android-ld . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
traditional. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259, 951
Q . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
traditional-cpp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Qn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
trigraphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Qy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
twolevel_namespace . . . . . . . . . . . . . . . . . . . . . . . . . 356
T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
R
r............................................. 265 U
rdynamic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265 u . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
read_only_relocs. . . . . . . . . . . . . . . . . . . . . . . . . . . . 356 umbrella . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
remap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260 undef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
1034 Using the GNU Compiler Collection (GCC)
Keyword Index
# /
#pragma . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
#pragma implementation . . . . . . . . . . . . . . . . . . . . . 890
#pragma implementation, implied . . . . . . . . . . . . 890
#pragma interface . . . . . . . . . . . . . . . . . . . . . . . . . . . 889 <
‘<’ in constraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
$ =
$ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
‘=’ in constraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
% >
‘%’ in constraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
‘>’ in constraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
%include . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
%include_noerr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
%rename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497 ?
?: extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
& ?: side effect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
‘&’ in constraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
D
Darwin options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352 E
dcgettext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728 ‘E’ in constraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
dd integer suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542 earlyclobber operand . . . . . . . . . . . . . . . . . . . . . . . . . 680
DD integer suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542 eBPF Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
deallocating variable length arrays . . . . . . . . . . . . 549 eight-bit data on the H8/300, H8/300H, and H8S
debug dump options . . . . . . . . . . . . . . . . . . . . . . . . . . 281 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
debugging GCC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281 eightbit_data variable attribute, H8/300 . . . . 632
debugging information options . . . . . . . . . . . . . . . . 156 EIND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
decimal floating types . . . . . . . . . . . . . . . . . . . . . . . . 542 either function attribute, MSP430 . . . . . . . . . . . 601
declaration scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952 either variable attribute, MSP430 . . . . . . . . . . . 635
declarations inside expressions . . . . . . . . . . . . . . . . 529 empty structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
declarations, mixed with code. . . . . . . . . . . . . . . . . 556 Enumerator Attributes . . . . . . . . . . . . . . . . . . . . . . . 647
declaring attributes of functions . . . . . . . . . . . . . . 556 environment variables . . . . . . . . . . . . . . . . . . . . . . . . 505
declaring static data in C++ . . . . . . . . . . . . . . . . . . 956 erf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
defining static data in C++ . . . . . . . . . . . . . . . . . . . . 956 erfc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
dependencies for make as output . . . . . . . . . . . . . . 508 erfcf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
dependencies, make . . . . . . . . . . . . . . . . . . . . . . . . . . . 255 erfcl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
DEPENDENCIES_OUTPUT . . . . . . . . . . . . . . . . . . . . . . . . 508 erff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
dependent name lookup . . . . . . . . . . . . . . . . . . . . . . 957 erfl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
deprecated enumerator attribute . . . . . . . . . . . . . 647 error function attribute . . . . . . . . . . . . . . . . . . . . . . 563
deprecated function attribute . . . . . . . . . . . . . . . . 563 error GCC_COLORS capability . . . . . . . . . . . . . . . . . . . 80
deprecated type attribute . . . . . . . . . . . . . . . . . . . . 640 error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 963
deprecated variable attribute . . . . . . . . . . . . . . . . 626 escaped newlines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
designated initializers . . . . . . . . . . . . . . . . . . . . . . . . . 553 exception function attribute . . . . . . . . . . . . . . . . . 602
designated_init type attribute . . . . . . . . . . . . . . 640 exception handler functions, Blackfin . . . . . . . . . 591
1048 Using the GNU Compiler Collection (GCC)
functions that are passed arguments in registers on hardware models and configurations, specifying
x86-32 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
functions that behave like malloc . . . . . . . . . . . . . 568 hex floats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
functions that have no side effects . . . . . . . . 561, 574 highlight, color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
functions that never return . . . . . . . . . . . . . . . . . . . 573 hk fixed-suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
functions that pop the argument stack on x86-32 HK fixed-suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610, 611, 612 hosted environment . . . . . . . . . . . . . . . . . . . . . . 5, 48, 49
functions that return more than once . . . . . . . . . 575 hosted implementation . . . . . . . . . . . . . . . . . . . . . . . . . . 5
functions with non-null pointer arguments . . . . 572 hot function attribute . . . . . . . . . . . . . . . . . . . . . . . . 566
functions with printf, scanf, strftime or hot label attribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
strfmon style arguments . . . . . . . . . . . . . . . . . 564 hotpatch function attribute, S/390 . . . . . . . . . . . 608
HPPA Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
hr fixed-suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
G HR fixed-suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
‘g’ in constraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678 hypot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
g++ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 hypotf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
hypotl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
‘G’ in constraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
G++ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
gamma . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
gamma_r . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
I
gammaf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728 ‘i’ in constraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
gammaf_r . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728 ‘I’ in constraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
gammal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728 IA-64 Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
gammal_r . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728 IBM RS/6000 and PowerPC Options . . . . . . . . . 424
gcc_struct type attribute, PowerPC . . . . . . . . . 645 identifier names, dollar signs in . . . . . . . . . . . . . . . 652
gcc_struct type attribute, x86 . . . . . . . . . . . . . . . 646 identifiers, names in assembler code . . . . . . . . . . . 707
gcc_struct variable attribute, PowerPC . . . . . . 635 ifunc function attribute . . . . . . . . . . . . . . . . . . . . . . 566
gcc_struct variable attribute, x86 . . . . . . . . . . . . 636 ilogb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
GCC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 ilogbf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
GCC command options . . . . . . . . . . . . . . . . . . . . . . . . 11 ilogbl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
GCC_COLORS environment variable . . . . . . . . . . . . . . 79 imaxabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
GCC_COMPARE_DEBUG . . . . . . . . . . . . . . . . . . . . . . . . . . 506 implementation-defined behavior, C language
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517
GCC_EXEC_PREFIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
implementation-defined behavior, C++ language
GCC_EXTRA_DIAGNOSTIC_OUTPUT . . . . . . . . . . . . . . . 507
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
GCC_URLS environment variable . . . . . . . . . . . . . . . . 81
implied #pragma implementation . . . . . . . . . . . . . 890
gcov . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
incompatibilities of GCC . . . . . . . . . . . . . . . . . . . . . 951
general-regs-only function attribute, AArch64
increment operators . . . . . . . . . . . . . . . . . . . . . . . . . . 965
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
general-regs-only function attribute, ARM
indirect calls, ARC . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
indirect calls, ARM . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
gettext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
indirect calls, Blackfin . . . . . . . . . . . . . . . . . . . . . . . . 591
global offset table . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
indirect calls, Epiphany . . . . . . . . . . . . . . . . . . . . . . . 593
global register after longjmp . . . . . . . . . . . . . . . . . . 709
indirect calls, MIPS . . . . . . . . . . . . . . . . . . . . . . . . . . 599
global register variables . . . . . . . . . . . . . . . . . . . . . . . 707
indirect calls, PowerPC . . . . . . . . . . . . . . . . . . . . . . . 603
GNAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
indirect functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
gnu_inline function attribute . . . . . . . . . . . . . . . . 566
indirect_branch function attribute, x86. . . . . . 620
GNU C Compiler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 indirect_return function attribute, x86. . . . . . 622
GNU Compiler Collection . . . . . . . . . . . . . . . . . . . . . . . 3 init_priority variable attribute . . . . . . . . . . . . . 893
Go . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 initializations in expressions . . . . . . . . . . . . . . . . . . 552
goto with computed label . . . . . . . . . . . . . . . . . . . . . 532 initializers with labeled elements . . . . . . . . . . . . . . 553
gprof . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 initializers, non-constant . . . . . . . . . . . . . . . . . . . . . . 552
grouping options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 inline assembly language . . . . . . . . . . . . . . . . . . . . . . 655
inline automatic for C++ member fns . . . . . . . . 654
inline functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
H inline functions, omission of. . . . . . . . . . . . . . . . . . . 653
‘H’ in constraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678 inlining and C++ pragmas . . . . . . . . . . . . . . . . . . . . 890
half-precision floating point . . . . . . . . . . . . . . . . . . . 541 installation trouble . . . . . . . . . . . . . . . . . . . . . . . . . . . 949
1050 Using the GNU Compiler Collection (GCC)
R S
r fixed-suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543 ‘s’ in constraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
‘r’ in constraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678 S/390 and zSeries Options . . . . . . . . . . . . . . . . . . . . 443
R fixed-suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543 saddr variable attribute, RL78. . . . . . . . . . . . . . . . 635
RAMPD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341 save all registers on the Blackfin . . . . . . . . . . . . . . 592
RAMPX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341 save all registers on the H8/300, H8/300H, and
RAMPY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341 H8S . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
RAMPZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341 save_all function attribute, NDS32 . . . . . . . . . . 602
range1 GCC_COLORS capability. . . . . . . . . . . . . . . . . . 80 save_volatiles function attribute, MicroBlaze
range2 GCC_COLORS capability. . . . . . . . . . . . . . . . . . 80 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597
ranges in case statements . . . . . . . . . . . . . . . . . . . . . 555 saveall function attribute, Blackfin . . . . . . . . . . 592
read-only strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951 saveall function attribute, H8/300 . . . . . . . . . . . 594
realloc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728 scalar_storage_order type attribute . . . . . . . . 642
reentrant function attribute, MSP430 . . . . . . . . 601 scalb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
register variable after longjmp . . . . . . . . . . . . . . . . 709 scalbf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
registers for local variables . . . . . . . . . . . . . . . . . . . . 709 scalbl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
registers in constraints . . . . . . . . . . . . . . . . . . . . . . . . 678 scalbln . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
registers, global allocation . . . . . . . . . . . . . . . . . . . . 707 scalblnf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
registers, global variables in. . . . . . . . . . . . . . . . . . . 707 scalbn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
regparm function attribute, x86 . . . . . . . . . . . . . . . 611 scalbnf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
relocation truncated to fit (ColdFire) . . . . . . . . . 383 scanf, and constant strings . . . . . . . . . . . . . . . . . . . 951
relocation truncated to fit (MIPS) . . . . . . . . . . . . 391 scanfnl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
remainder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728 scope of a variable length array . . . . . . . . . . . . . . . 549
Keyword Index 1055
system headers, warnings from . . . . . . . . . . . . . . . . 124 target("bmi") function attribute, x86 . . . . . . . . 615
sysv_abi function attribute, x86 . . . . . . . . . . . . . . 611 target("bmi2") function attribute, x86 . . . . . . . 615
target("cld") function attribute, x86 . . . . . . . . 619
target("cldemote") function attribute, x86 . . 615
T target("clflushopt") function attribute, x86
tainted_args function attribute . . . . . . . . . . . . . . 578 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
tan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728 target("clwb") function attribute, x86 . . . . . . . 615
tanf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728 target("clzero") function attribute, x86 . . . . 615
tanh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728 target("cmpb") function attribute, PowerPC
tanhf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
tanhl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728 target("cpu=CPU") function attribute, PowerPC
tanl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
target function attribute . . . . . . 576, 589, 602, 603, target("crc32") function attribute, x86. . . . . . 615
608, 613 target("custom-fpu-cfg=name") function
target machine, specifying . . . . . . . . . . . . . . . . . . . . . 11 attribute, Nios II. . . . . . . . . . . . . . . . . . . . . . . . . 603
target("3dnow") function attribute, x86. . . . . . 613 target("custom-insn=N") function attribute, Nios
target("3dnowa") function attribute, x86 . . . . 613 II . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
target("abm") function attribute, x86 . . . . . . . . 613 target("cx16") function attribute, x86 . . . . . . . 615
target("adx") function attribute, x86 . . . . . . . . 613 target("default") function attribute, x86 . . . 615
target("aes") function attribute, x86 . . . . . . . . 613 target("dlmzb") function attribute, PowerPC
target("align-stringops") function attribute, . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
x86 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619 target("f16c") function attribute, x86 . . . . . . . 615
target("altivec") function attribute, PowerPC target("fancy-math-387") function attribute,
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603 x86 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
target("amx-bf16") function attribute, x86 . . 619 target("fma") function attribute, x86 . . . . . . . . 615
target("amx-int8") function attribute, x86 . . 619 target("fma4") function attribute, x86 . . . . . . . 615
target("amx-tile") function attribute, x86 . . 618 target("fpmath=FPMATH") function attribute, x86
target("arch=ARCH") function attribute, x86 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620 target("fprnd") function attribute, PowerPC
target("arm") function attribute, ARM . . . . . . 589 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
target("avoid-indexed-addresses") function target("fpu=") function attribute, ARM . . . . . 589
attribute, PowerPC . . . . . . . . . . . . . . . . . . . . . . 605 target("friz") function attribute, PowerPC
target("avx") function attribute, x86 . . . . . . . . 614 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
target("avx2") function attribute, x86 . . . . . . . 614 target("fsgsbase") function attribute, x86 . . 615
target("avx5124fmaps") function attribute, x86 target("fxsr") function attribute, x86 . . . . . . . 616
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614 target("general-regs-only") function attribute,
target("avx5124vnniw") function attribute, x86 x86 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614 target("gfni") function attribute, x86 . . . . . . . 616
target("avx512bitalg") function attribute, x86 target("hard-dfp") function attribute, PowerPC
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
target("avx512bw") function attribute, x86 . . 614 target("hle") function attribute, x86 . . . . . . . . 616
target("avx512cd") function attribute, x86 . . 614 target("hreset") function attribute, x86 . . . . 619
target("avx512dq") function attribute, x86 . . 614 target("ieee-fp") function attribute, x86 . . . 619
target("avx512er") function attribute, x86 . . 614 target("inline-all-stringops") function
target("avx512f") function attribute, x86 . . . 614 attribute, x86 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
target("avx512ifma") function attribute, x86 target("inline-stringops-dynamically")
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614 function attribute, x86 . . . . . . . . . . . . . . . . . . . 619
target("avx512pf") function attribute, x86 . . 614 target("isel") function attribute, PowerPC
target("avx512vbmi") function attribute, x86 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614 target("kl") function attribute, x86 . . . . . . . . . 619
target("avx512vbmi2") function attribute, x86 target("longcall") function attribute, PowerPC
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
target("avx512vl") function attribute, x86 . . 615 target("lwp") function attribute, x86 . . . . . . . . 616
target("avx512vnni") function attribute, x86 target("lzcnt") function attribute, x86. . . . . . 616
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615 target("mfcrf") function attribute, PowerPC
target("avx512vpopcntdq") function attribute, . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
x86 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615 target("mmx") function attribute, x86 . . . . . . . . 616
target("avxvnni") function attribute, x86 . . . 619 target("movbe") function attribute, x86. . . . . . 616
Keyword Index 1057
W Y
w floating point suffix . . . . . . . . . . . . . . . . . . . . . . . . . 540 y0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
W floating point suffix . . . . . . . . . . . . . . . . . . . . . . . . . 540 y0f . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
wakeup function attribute, MSP430 . . . . . . . . . . . 601 y0l . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
warm function attribute, NDS32 . . . . . . . . . . . . . . . 602 y1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
warn_if_not_aligned type attribute. . . . . . . . . . 638 y1f . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
warn_if_not_aligned variable attribute . . . . . . 624 y1l . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
warn_unused type attribute . . . . . . . . . . . . . . . . . . . 894 yn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
warn_unused_result function attribute . . . . . . . 580 ynf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
warning for comparison of signed and unsigned ynl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
warning for overloaded virtual function . . . . . . . . 68
warning for reordering of member initializers . . . 65 Z
warning for unknown pragmas . . . . . . . . . . . . . . . . 113 zda variable attribute, V850 . . . . . . . . . . . . . . . . . . 636
warning function attribute. . . . . . . . . . . . . . . . . . . . 563 zero-length arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
warning GCC_COLORS capability . . . . . . . . . . . . . . . . 80 zero-size structures . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
warning messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 zero_call_used_regs function attribute . . . . . . 582
warnings from system headers . . . . . . . . . . . . . . . . 124 zSeries options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496