Copyright © 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with the Invariant Sections being “GNU General Public License” and “Funding Free Software”, the Front-Cover texts being (a) (see below), and with the Back-Cover Texts being (b) (see below). A copy of the license is included in the section entitled “GNU Free Documentation License”.
(a) The FSF's Front-Cover Text is:
A GNU Manual
(b) The FSF's Back-Cover Text is:
You have freedom to copy and modify this GNU Manual, like GNU software. Copies published by the Free Software Foundation raise funds for GNU development.
typeof
void
- and Function-Pointers
asm
Operands
enum
Types
This manual documents how to use the GNU compilers, as well as their features and incompatibilities, and how to report bugs. It corresponds to GCC version 3.4.6. 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 Introduction.
GCC stands for “GNU Compiler Collection”. GCC is an integrated distribution of compilers for several major programming languages. These languages currently include C, C++, Objective-C, Java, Fortran, and Ada.
The abbreviation GCC has multiple meanings in common use. The current official meaning is “GNU Compiler Collection”, which refers generically to the complete suite of tools. The name historically stood for “GNU C Compiler”, and this usage is still common when the emphasis is on compiling C programs. Finally, the name is also used when speaking of the language-independent component of GCC: code shared among the compilers for all supported languages.
The language-independent component of GCC includes the majority of the optimizers, as well as the “back ends” that generate machine code for various processors.
The part of a compiler that is specific to a particular language is called the “front end”. In addition to the front ends that are integrated components of GCC, there are several other front ends that are maintained separately. These support languages such as Pascal, Mercury, and COBOL. To use these, they must be built together with GCC proper.
Most of the compilers for languages other than C have their own names. The C++ compiler is G++, the Ada compiler is GNAT, and so on. When we talk about compiling one of those languages, we might refer to that compiler by its own name, or as GCC. Either is correct.
Historically, compilers for many languages, including C++ and Fortran, have been implemented as “preprocessors” which emit another high level language such as C. None of the compilers included in GCC are implemented this way; they all generate machine code directly. This sort of preprocessor should not be confused with the C preprocessor, which is an integral feature of the C, C++, and Objective-C languages.
For each language compiled by GCC for which there is a standard, GCC attempts to follow one or more versions of that standard, possibly with some exceptions, and possibly with some extensions.
GCC supports three versions of the C standard, although support for the most recent version is not yet complete.
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. This standard, in both its forms, is commonly known as C89, or occasionally as C90, from the dates of ratification. The ANSI standard, but not the ISO standard, also came with a Rationale document. To select this standard in GCC, use one of the options -ansi, -std=c89 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 Options Controlling C Dialect.
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. GCC has incomplete support for this standard version; see http://gcc.gnu.org/gcc-3.4/c99status.html for details. To select this standard, use -std=c99 or -std=iso9899:1999. (While in development, drafts of this standard version were referred to as C9X.)
Errors in the 1999 ISO C standard were corrected in a Technical Corrigendum published in 2001. GCC does not support the uncorrected version.
By default, GCC provides some extensions to the C language that on rare occasions conflict with the C standard. See Extensions to the C Language Family. Use of the -std options listed above will disable these extensions where they conflict with the C standard version selected. You may also select an extended version of the C language explicitly with -std=gnu89 (for C89 with GNU extensions) or -std=gnu99 (for C99 with GNU extensions). The default, if no C language dialect options are given, is -std=gnu89; this will change to -std=gnu99 in some future release when the C99 support is complete. Some features that are part of the C99 standard are accepted as extensions in C89 mode.
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>
; and in C99, also those in <stdbool.h>
and
<stdint.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 termination 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 would be a freestanding environment; a
program using the facilities of an operating system would normally be
in a hosted implementation.
GCC aims towards being usable as a conforming freestanding
implementation, or as the compiler for a conforming hosted
implementation. By default, it will act 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 will then define
__STDC_HOSTED__
to 0
and 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 Options Controlling C Dialect.
GCC does not provide the library facilities required only of hosted implementations, nor yet all the facilities required by C99 of freestanding implementations; to use the facilities of a hosted environment, you will need to find them elsewhere (for example, in the GNU C library). See Standard Libraries.
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
. Some older ports of GCC are
configured to use the BSD bcopy
, bzero
and bcmp
functions instead, but this is deprecated for new ports.
Finally, if __builtin_trap
is used, and the target does
not implement the trap
pattern, then GCC will emit a call
to abort
.
For references to Technical Corrigenda, Rationale documents and information concerning the history of C that is available online, see http://gcc.gnu.org/readings.html
There is no formal written standard for Objective-C. The most authoritative manual is “Object-Oriented Programming and the Objective-C Language”, available at a number of web sites
There is no standard for treelang, which is a sample language front end for GCC. Its only purpose is as a sample for people wishing to write a new language for GCC. The language is documented in gcc/treelang/treelang.texi which can be turned into info or HTML format.
See GNAT Reference Manual, for information on standard conformance and compatibility of the Ada compiler.
See The GNU Fortran Language, for details of the Fortran language supported by GCC.
See Compatibility with the Java Platform, for details of compatibility between gcj and the Java Platform.
When you invoke GCC, it normally does preprocessing, compilation, assembly and linking. The “overall options” allow you to stop this process at an intermediate stage. For example, the -c option says not to run the linker. Then the output consists of object files output by the assembler.
Other options are passed on to one stage of processing. Some options control the preprocessor and others the compiler itself. Yet other options control the assembler and linker; most of these are not documented here, since you rarely need to use any of them.
Most of the command line options that you can use with GCC are useful for C programs; when an option is only useful with another language (usually C++), the explanation says so explicitly. If the description for a particular option does not mention a source language, you can use that option with all supported languages.
See Compiling C++ Programs, for a summary of special options for compiling C++ programs.
The gcc program accepts options and file names as operands. Many options have multi-letter names; therefore multiple single-letter options may not be grouped: -dr is very different from `-d -r'.
You can mix options and other arguments. For the most part, the order you use doesn't matter. Order does matter when you use several options of the same kind; for example, if you specify -L more than once, the directories are searched in the order specified.
Many options have long names starting with `-f' or with `-W'—for example, -fforce-mem, -fstrength-reduce, -Wformat and so on. Most of these have both positive and negative forms; the negative form of -ffoo would be -fno-foo. This manual documents only one of these two forms, whichever one is not the default.
See Option Index, for an index to GCC's options.
Here is a summary of all the options, grouped by type. Explanations are in the following sections.
-c -S -E -o file -pipe -pass-exit-codes -x language -v -### --help --target-help --version
-ansi -std=standard -aux-info filename -fno-asm -fno-builtin -fno-builtin-function -fhosted -ffreestanding -fms-extensions -trigraphs -no-integrated-cpp -traditional -traditional-cpp -fallow-single-precision -fcond-mismatch -fsigned-bitfields -fsigned-char -funsigned-bitfields -funsigned-char -fwritable-strings
-fabi-version=n -fno-access-control -fcheck-new -fconserve-space -fno-const-strings -fno-elide-constructors -fno-enforce-eh-specs -ffor-scope -fno-for-scope -fno-gnu-keywords -fno-implicit-templates -fno-implicit-inline-templates -fno-implement-inlines -fms-extensions -fno-nonansi-builtins -fno-operator-names -fno-optional-diags -fpermissive -frepo -fno-rtti -fstats -ftemplate-depth-n -fuse-cxa-atexit -fno-weak -nostdinc++ -fno-default-inline -Wabi -Wctor-dtor-privacy -Wnon-virtual-dtor -Wreorder -Weffc++ -Wno-deprecated -Wno-non-template-friend -Wold-style-cast -Woverloaded-virtual -Wno-pmf-conversions -Wsign-promo
-fconstant-string-class=class-name -fgnu-runtime -fnext-runtime -fno-nil-receivers -fobjc-exceptions -freplace-objc-classes -fzero-link -gen-decls -Wno-protocol -Wselector -Wundeclared-selector
-fmessage-length=n -fdiagnostics-show-location=[once|every-line]
-fsyntax-only -pedantic -pedantic-errors -w -Wextra -Wall -Waggregate-return -Wbounded -Wcast-align -Wcast-qual -Wchar-subscripts -Wcomment -Wconversion -Wno-deprecated-declarations -Wdisabled-optimization -Wno-div-by-zero -Wendif-labels -Werror -Werror-maybe-reset -Werror-implicit-function-declaration -Wfloat-equal -Wformat -Wformat=2 -Wno-format-extra-args -Wformat-nonliteral -Wformat-security -Wformat-y2k -Wimplicit -Wimplicit-function-declaration -Wimplicit-int -Wimport -Wno-import -Winit-self -Winline -Wno-invalid-offsetof -Winvalid-pch -Wlarger-than-len -Wlong-long -Wmain -Wmissing-braces -Wmissing-field-initializers -Wmissing-format-attribute -Wmissing-noreturn -Wno-multichar -Wnonnull -Wpacked -Wpadded -Wparentheses -Wpointer-arith -Wredundant-decls -Wreturn-type -Wsequence-point -Wshadow -Wsign-compare -Wstack-larger-than-len -Wstack-protector -Wstrict-aliasing -Wswitch -Wswitch-default -Wswitch-enum -Wsystem-headers -Wtrampolines -Wtrigraphs -Wundef -Wuninitialized -Wunknown-pragmas -Wunreachable-code -Wunused -Wunused-function -Wunused-label -Wunused-parameter -Wunused-value -Wunused-variable -Wwrite-strings
-Wbad-function-cast -Wmissing-declarations -Wmissing-prototypes -Wnested-externs -Wold-style-definition -Wstrict-prototypes -Wtraditional -Wdeclaration-after-statement
-dletters -dumpspecs -dumpmachine -dumpversion -fdump-unnumbered -fdump-translation-unit[-n] -fdump-class-hierarchy[-n] -fdump-tree-original[-n] -fdump-tree-optimized[-n] -fdump-tree-inlined[-n] -feliminate-dwarf2-dups -feliminate-unused-debug-types -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs -frandom-seed=string -fsched-verbose=n -ftest-coverage -ftime-report -g -glevel -gcoff -gdwarf-2 -ggdb -gstabs -gstabs+ -gvms -gxcoff -gxcoff+ -p -pg -print-file-name=library -print-libgcc-file-name -print-multi-directory -print-multi-lib -print-prog-name=program -print-search-dirs -Q -save-temps -time
-falign-functions=n -falign-jumps=n -falign-labels=n -falign-loops=n -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize -fbranch-target-load-optimize2 -fcaller-saves -fcprop-registers -fcse-follow-jumps -fcse-skip-blocks -fdata-sections -fdelayed-branch -fdelete-null-pointer-checks -fexpensive-optimizations -ffast-math -ffloat-store -fforce-addr -fforce-mem -ffunction-sections -fgcse -fgcse-lm -fgcse-sm -fgcse-las -floop-optimize -fcrossjumping -fif-conversion -fif-conversion2 -finline-functions -finline-limit=n -fkeep-inline-functions -fkeep-static-consts -fmerge-constants -fmerge-all-constants -fmove-all-movables -fnew-ra -fno-branch-count-reg -fno-default-inline -fno-defer-pop -fno-function-cse -fno-guess-branch-probability -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 -funsafe-math-optimizations -ffinite-math-only -fno-trapping-math -fno-zero-initialized-in-bss -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls -fprefetch-loop-arrays -fprofile-generate -fprofile-use -freduce-all-givs -fregmove -frename-registers -freorder-blocks -freorder-functions -frerun-cse-after-loop -frerun-loop-opt -frounding-math -fschedule-insns -fschedule-insns2 -fno-sched-interblock -fno-sched-spec -fsched-spec-load -fsched-spec-load-dangerous -fsched-stalled-insns=n -sched-stalled-insns-dep=n -fsched2-use-superblocks -fsched2-use-traces -fsignaling-nans -fsingle-precision-constant -fstrength-reduce -fstrict-aliasing -ftracer -fthread-jumps -funroll-all-loops -funroll-loops -fpeel-loops -funswitch-loops -fold-unroll-loops -fold-unroll-all-loops --param name=value -O -O0 -O1 -O2 -O3 -Os
-Aquestion=answer -A-question[=answer] -C -dD -dI -dM -dN -Dmacro[=defn] -E -H -idirafter dir -include file -imacros file -iprefix file -iwithprefix dir -iwithprefixbefore dir -isystem dir -M -MM -MF -MG -MP -MQ -MT -nostdinc -P -fworking-directory -remap -trigraphs -undef -Umacro -Wp,option -Xpreprocessor option
-Wa,option -Xassembler option
object-file-name -llibrary -nostartfiles -nodefaultlibs -nostdlib -pie -s -static -static-libgcc -shared -shared-libgcc -symbolic -Wl,option -Xlinker option -u symbol
-Bprefix -Idir -I- -Ldir -specs=file
-V version -b machine
M680x0 Options
-m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 -m68060 -mcpu32 -m5200 -m68881 -mbitfield -mc68000 -mc68020 -mnobitfield -mrtd -mshort -msoft-float -mpcrel -malign-int -mstrict-align -msep-data -mno-sep-data -mshared-library-id=n -mid-shared-library -mno-id-shared-library
M68hc1x Options
-m6811 -m6812 -m68hc11 -m68hc12 -m68hcs12 -mauto-incdec -minmax -mlong-calls -mshort -msoft-reg-count=count
VAX Options
-mg -mgnu -munix
SPARC Options
-mcpu=cpu-type -mtune=cpu-type -mcmodel=code-model -m32 -m64 -mapp-regs -mno-app-regs -mfaster-structs -mno-faster-structs -mflat -mno-flat -mfpu -mno-fpu -mhard-float -msoft-float -mhard-quad-float -msoft-quad-float -mimpure-text -mno-impure-text -mlittle-endian -mstack-bias -mno-stack-bias -munaligned-doubles -mno-unaligned-doubles -mv8plus -mno-v8plus -mvis -mno-vis -mcypress -mf930 -mf934 -msparclite -msupersparc -mv8 -threads -pthreads
ARM Options
-mapcs-frame -mno-apcs-frame -mapcs-26 -mapcs-32 -mapcs-stack-check -mno-apcs-stack-check -mapcs-float -mno-apcs-float -mapcs-reentrant -mno-apcs-reentrant -msched-prolog -mno-sched-prolog -mlittle-endian -mbig-endian -mwords-little-endian -malignment-traps -mno-alignment-traps -msoft-float -mhard-float -mfpe -mthumb-interwork -mno-thumb-interwork -mcpu=name -march=name -mfpe=name -mstructure-size-boundary=n -mabort-on-noreturn -mlong-calls -mno-long-calls -msingle-pic-base -mno-single-pic-base -mpic-register=reg -mnop-fun-dllimport -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns -mpoke-function-name -mthumb -marm -mtpcs-frame -mtpcs-leaf-frame -mcaller-super-interworking -mcallee-super-interworking
MN10300 Options
-mmult-bug -mno-mult-bug -mam33 -mno-am33 -mam33-2 -mno-am33-2 -mno-crt0 -mrelax
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
RS/6000 and PowerPC Options
-mcpu=cpu-type -mtune=cpu-type -mpower -mno-power -mpower2 -mno-power2 -mpowerpc -mpowerpc64 -mno-powerpc -maltivec -mno-altivec -mpowerpc-gpopt -mno-powerpc-gpopt -mpowerpc-gfxopt -mno-powerpc-gfxopt -mnew-mnemonics -mold-mnemonics -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 -mstring -mno-string -mupdate -mno-update -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 -mprioritize-restricted-insns=priority -msched-costly-dep=dependence_type -minsert-sched-nops=scheme -mcall-sysv -mcall-netbsd -maix-struct-return -msvr4-struct-return -mabi=altivec -mabi=no-altivec -mabi=spe -mabi=no-spe -misel=yes -misel=no -mspe=yes -mspe=no -mfloat-gprs=yes -mfloat-gprs=no -mprototype -mno-prototype -msim -mmvme -mads -myellowknife -memb -msdata -msdata=opt -mvxworks -mwindiss -G num -pthread
Darwin Options
-all_load -allowable_client -arch -arch_errors_fatal -arch_only -bind_at_load -bundle -bundle_loader -client_name -compatibility_version -current_version -dependency-file -dylib_file -dylinker_install_name -dynamic -dynamiclib -exported_symbols_list -filelist -flat_namespace -force_cpusubtype_ALL -force_flat_namespace -headerpad_max_install_names -image_base -init -install_name -keep_private_externs -multi_module -multiply_defined -multiply_defined_unused -noall_load -nofixprebinding -nomultidefs -noprebind -noseglinkedit -pagezero_size -prebind -prebind_all_twolevel_modules -private_bundle -read_only_relocs -sectalign -sectobjectsymbols -whyload -seg1addr -sectcreate -sectobjectsymbols -sectorder -seg_addr_table -seg_addr_table_filename -seglinkedit -segprot -segs_read_only_addr -segs_read_write_addr -single_module -static -sub_library -sub_umbrella -twolevel_namespace -umbrella -undefined -unexported_symbols_list -weak_reference_mismatches -whatsloaded
MIPS Options
-EL -EB -march=arch -mtune=arch -mips1 -mips2 -mips3 -mips4 -mips32 -mips32r2 -mips64 -mips16 -mno-mips16 -mabi=abi -mabicalls -mno-abicalls -mxgot -mno-xgot -membedded-pic -mno-embedded-pic -mgp32 -mgp64 -mfp32 -mfp64 -mhard-float -msoft-float -msingle-float -mdouble-float -mint64 -mlong64 -mlong32 -Gnum -membedded-data -mno-embedded-data -muninit-const-in-rodata -mno-uninit-const-in-rodata -msplit-addresses -mno-split-addresses -mexplicit-relocs -mno-explicit-relocs -mrnames -mno-rnames -mcheck-zero-division -mno-check-zero-division -mmemcpy -mno-memcpy -mlong-calls -mno-long-calls -mmad -mno-mad -mfused-madd -mno-fused-madd -nocpp -mfix-sb1 -mno-fix-sb1 -mflush-func=func -mno-flush-func -mbranch-likely -mno-branch-likely
i386 and x86-64 Options
-mtune=cpu-type -march=cpu-type -mfpmath=unit -masm=dialect -mno-fancy-math-387 -mno-fp-ret-in-387 -msoft-float -msvr3-shlib -mno-wide-multiply -mrtd -malign-double -mpreferred-stack-boundary=num -mmmx -msse -msse2 -msse3 -m3dnow -mthreads -mno-align-stringops -minline-all-stringops -mpush-args -maccumulate-outgoing-args -m128bit-long-double -m96bit-long-double -mregparm=num -momit-leaf-frame-pointer -mno-red-zone -mno-tls-direct-seg-refs -mcmodel=code-model -m32 -m64
HPPA Options
-march=architecture-type -mbig-switch -mdisable-fpregs -mdisable-indexing -mfast-indirect-calls -mgas -mgnu-ld -mhp-ld -mjump-in-delay -mlinker-opt -mlong-calls -mlong-load-store -mno-big-switch -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 -nolibdld -static -threads
Intel 960 Options
-mcpu-type -masm-compat -mclean-linkage -mcode-align -mcomplex-addr -mleaf-procedures -mic-compat -mic2.0-compat -mic3.0-compat -mintel-asm -mno-clean-linkage -mno-code-align -mno-complex-addr -mno-leaf-procedures -mno-old-align -mno-strict-align -mno-tail-call -mnumerics -mold-align -msoft-float -mstrict-align -mtail-call
DEC Alpha Options
-mno-fp-regs -msoft-float -malpha-as -mgas -mieee -mieee-with-inexact -mieee-conformant -mfp-trap-mode=mode -mfp-rounding-mode=mode -mtrap-precision=mode -mbuild-constants -mcpu=cpu-type -mtune=cpu-type -mbwx -mmax -mfix -mcix -mfloat-vax -mfloat-ieee -mexplicit-relocs -msmall-data -mlarge-data -msmall-text -mlarge-text -mmemory-latency=time
DEC Alpha/VMS Options
-mvms-return-codes
H8/300 Options
-mrelax -mh -ms -mn -mint32 -malign-300
SH Options
-m1 -m2 -m2e -m3 -m3e -m4-nofpu -m4-single-only -m4-single -m4 -m5-64media -m5-64media-nofpu -m5-32media -m5-32media-nofpu -m5-compact -m5-compact-nofpu -mb -ml -mdalign -mrelax -mbigtable -mfmovd -mhitachi -mnomacsave -mieee -misize -mpadstruct -mspace -mprefergot -musermode
System V Options
-Qy -Qn -YP,paths -Ym,dir
ARC Options
-EB -EL -mmangle-cpu -mcpu=cpu -mtext=text-section -mdata=data-section -mrodata=readonly-data-section
TMS320C3x/C4x Options
-mcpu=cpu -mbig -msmall -mregparm -mmemparm -mfast-fix -mmpyi -mbk -mti -mdp-isr-reload -mrpts=count -mrptb -mdb -mloop-unsigned -mparallel-insns -mparallel-mpy -mpreserve-float
V850 Options
-mlong-calls -mno-long-calls -mep -mno-ep -mprolog-function -mno-prolog-function -mspace -mtda=n -msda=n -mzda=n -mapp-regs -mno-app-regs -mdisable-callt -mno-disable-callt -mv850e1 -mv850e -mv850 -mbig-switch
NS32K Options
-m32032 -m32332 -m32532 -m32081 -m32381 -mmult-add -mnomult-add -msoft-float -mrtd -mnortd -mregparam -mnoregparam -msb -mnosb -mbitfield -mnobitfield -mhimem -mnohimem
AVR Options
-mmcu=mcu -msize -minit-stack=n -mno-interrupts -mcall-prologues -mno-tablejump -mtiny-stack
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
MMIX Options
-mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols -melf -mbranch-predict -mno-branch-predict -mbase-addresses -mno-base-addresses -msingle-exit -mno-single-exit
IA-64 Options
-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic -mvolatile-asm-stop -mb-step -mregister-names -mno-sdata -mconstant-gp -mauto-pic -minline-float-divide-min-latency -minline-float-divide-max-throughput -minline-int-divide-min-latency -minline-int-divide-max-throughput -minline-sqrt-min-latency -minline-sqrt-max-throughput -mno-dwarf2-asm -mearly-stop-bits -mfixed-range=register-range -mtls-size=tls-size -mtune=cpu-type -mt -pthread -milp32 -mlp64
D30V Options
-mextmem -mextmemory -monchip -mno-asm-optimize -masm-optimize -mbranch-cost=n -mcond-exec=n
S/390 and zSeries Options
-mtune=cpu-type -march=cpu-type -mhard-float -msoft-float -mbackchain -mno-backchain -msmall-exec -mno-small-exec -mmvcle -mno-mvcle -m64 -m31 -mdebug -mno-debug -mesa -mzarch -mfused-madd -mno-fused-madd
CRIS Options
-mcpu=cpu -march=cpu -mtune=cpu -mmax-stack-frame=n -melinux-stacksize=n -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects -mstack-align -mdata-align -mconst-align -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt -melf -maout -melinux -mlinux -sim -sim2 -mmul-bug-workaround -mno-mul-bug-workaround
PDP-11 Options
-mfpu -msoft-float -mac0 -mno-ac0 -m40 -m45 -m10 -mbcopy -mbcopy-builtin -mint32 -mno-int16 -mint16 -mno-int32 -mfloat32 -mno-float64 -mfloat64 -mno-float32 -mabshi -mno-abshi -mbranch-expensive -mbranch-cheap -msplit -mno-split -munix-asm -mdec-asm
Xstormy16 Options
-msim
Xtensa Options
-mconst16 -mno-const16 -mfused-madd -mno-fused-madd -mtext-section-literals -mno-text-section-literals -mtarget-align -mno-target-align -mlongcalls -mno-longcalls
FRV Options
-mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 -mhard-float -msoft-float -malloc-cc -mfixed-cc -mdword -mno-dword -mdouble -mno-double -mmedia -mno-media -mmuladd -mno-muladd -mlibrary-pic -macc-4 -macc-8 -mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move -mscc -mno-scc -mcond-exec -mno-cond-exec -mvliw-branch -mno-vliw-branch -mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec -mno-nested-cond-exec -mtomcat-stats -mcpu=cpu
-fcall-saved-reg -fcall-used-reg -ffixed-reg -fexceptions -fnon-call-exceptions -funwind-tables -fasynchronous-unwind-tables -finhibit-size-directive -finstrument-functions -fno-common -fident -fno-ident -fpcc-struct-return -fpic -fPIC -fpie -fPIE -freg-struct-return -fshared-data -fshort-enums -fshort-double -fshort-wchar -fverbose-asm -fpack-struct -fstack-check -fstack-limit-register=reg -fstack-limit-symbol=sym -fstack-protector -fstack-protector-all -fargument-alias -fargument-noalias -fargument-noalias-global -fleading-underscore -ftls-model=model -ftrampolines -ftrapv -fwrapv -fbounds-check
Compilation can involve up to four stages: preprocessing, compilation proper, assembly and linking, always in that order. GCC is capable of preprocessing and compiling several files either into several assembler input files, or into one assembler input file; then each assembler input file produces an object file, and linking combines all the object files (those newly compiled, and those specified as input) into an executable file.
For any given input file, the file name suffix determines what kind of compilation is done:
.c
.i
.ii
.m
.mi
.h
.cc
.cp
.cxx
.cpp
.CPP
.c++
.C
.hh
.H
.f
.for
.FOR
.F
.fpp
.FPP
.r
See Options Controlling the Kind of Output, for more details of the handling of
Fortran input files.
.ads
.adb
.s
.S
You can specify the input language explicitly with the -x option:
-x
languagec c-header cpp-output c++ c++-header c++-cpp-output objective-c objective-c-header objc-cpp-output assembler assembler-with-cpp ada f77 f77-cpp-input ratfor java treelang
-x none
-pass-exit-codes
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.
-c
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
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
Input files which don't require preprocessing are ignored.
-o
fileIf you specify -o when compiling more than one input file, or you are producing an executable file as output, all the source files on the command line will be compiled at once.
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, and
all preprocessed C source on standard output.
-v
-###
-pipe
--help
--target-help
--version
C++ source files conventionally use one of the suffixes `.C', `.cc', `.cpp', `.CPP', `.c++', `.cp', or `.cxx'; C++ header files often use `.hh' or `.H'; and preprocessed C++ files use the suffix `.ii'. GCC recognizes files with these names and compiles them as C++ programs even if you call the compiler the same way as for compiling C programs (usually with the name gcc).
However, C++ programs often require class libraries as well as a compiler that understands the C++ language—and under some circumstances, you might want to compile programs or header files from standard input, or otherwise without a suffix that flags them as C++ programs. You might also like to precompile a C header file with a `.h' extension to be used in C++ compilations. g++ is a program that calls GCC with the default language set to C++, and automatically specifies linking against the C++ library. On many systems, g++ is also installed with the name c++.
When you compile C++ programs, you may specify many of the same command-line options that you use for compiling programs in any language; or command-line options meaningful for C and related languages; or options that are meaningful only for C++ programs. See Options Controlling C Dialect, for explanations of options for languages related to C. See Options Controlling C++ Dialect, for explanations of options that are meaningful only for C++ programs.
The following options control the dialect of C (or languages derived from C, such as C++ and Objective-C) that the compiler accepts:
-ansi
This turns off certain features of GCC that are incompatible with ISO
C90 (when compiling C code), or of standard C++ (when compiling C++ code),
such as the asm
and typeof
keywords, and
predefined macros such as unix
and vax
that identify the
type of system you are using. It also enables the undesirable and
rarely used ISO trigraph feature. For the C compiler,
it disables recognition of C++ style `//' comments as well as
the inline
keyword.
The alternate keywords __asm__
, __extension__
,
__inline__
and __typeof__
continue to work despite
-ansi. You would not want to use them in an ISO C program, of
course, but it is useful to put them in header files that might be included
in compilations done with -ansi. Alternate predefined macros
such as __unix__
and __vax__
are also available, with or
without -ansi.
The -ansi option does not cause non-ISO programs to be rejected gratuitously. For that, -pedantic is required in addition to -ansi. See Warning Options.
The macro __STRICT_ANSI__
is predefined when the -ansi
option is used. Some header files may notice this macro and refrain
from declaring certain functions or defining certain macros that the
ISO standard doesn't call for; this is to avoid interfering with any
programs that might use these names for other things.
Functions which would normally be built in but do not have semantics
defined by ISO C (such as alloca
and ffs
) are not built-in
functions with -ansi is used. See Other built-in functions provided by GCC, for details of the functions
affected.
-std=
Even when this option is not specified, you can still use some of the
features of newer standards in so far as they do not conflict with
previous C standards. For example, you may use __restrict__
even
when -std=c99 is not specified.
The -std options specifying some version of ISO C have the same
effects as -ansi, except that features that were not in ISO C90
but are in the specified version (for example, `//' comments and
the inline
keyword in ISO C99) are not disabled.
See Language Standards Supported by GCC, for details of
these standard versions.
-aux-info
filenameBesides declarations, the file indicates, in comments, the origin of
each declaration (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 declarations is also provided, inside
comments, after the declaration.
-fno-asm
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. -ansi implies -fno-asm.
In C++, this switch only affects the typeof
keyword, since
asm
and inline
are standard keywords. You may want to
use the -fno-gnu-keywords flag instead, which has the same
effect. 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-
functionGCC normally generates special code to handle certain built-in functions
more efficiently; for instance, calls to alloca
may become single
instructions that 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.
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 this 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))
-fhosted
main
has a return
type of int
. Examples are nearly everything except a kernel.
This is equivalent to -fno-freestanding.
-ffreestanding
main
. The most obvious example is an OS kernel.
This is equivalent to -fno-hosted.
See Language Standards Supported by GCC, for details of
freestanding and hosted environments.
-fms-extensions
-trigraphs
-no-integrated-cpp
The semantics of this option will change if "cc1", "cc1plus", and "cc1obj" are merged.
-traditional
-traditional-cpp
-fcond-mismatch
-funsigned-char
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.
-fsigned-char
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 equivalent to -funsigned-char.
-fsigned-bitfields
-funsigned-bitfields
-fno-signed-bitfields
-fno-unsigned-bitfields
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.
-fwritable-strings
Writing into string constants is a very bad idea; “constants” should be constant.
This option is deprecated.
This section describes the command-line options that are only meaningful
for C++ programs; but you can also use most of the GNU compiler options
regardless of what language your program is in. For example, you
might compile a file firstClass.C
like this:
g++ -g -frepo -O -c firstClass.C
In this example, only -frepo is an option meant only for C++ programs; you can use the other options with any language supported by GCC.
Here is a list of options that are only for compiling C++ programs:
-fabi-version=
nThe default is version 2.
-fno-access-control
-fcheck-new
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
will only return 0
if it is declared
`throw()', in which case the compiler will always check 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)'.
-fconserve-space
main()
has
completed, you may have an object that is being destroyed twice because
two definitions were merged.
This option is no longer useful on most targets, now that support has
been added for putting variables into BSS without making them common.
-fno-const-strings
char *
instead of type const
char *
. By default, G++ uses type const char *
as required by
the standard. Even if you use -fno-const-strings, you cannot
actually modify the value of a string constant, unless you also use
-fwritable-strings.
This option might be removed in a future release of G++. For maximum
portability, you should structure your code so that it works with
string constants that have type const char *
.
-fno-elide-constructors
-fno-enforce-eh-specs
-ffor-scope
-fno-for-scope
The default if neither flag is given to follow the standard,
but to allow and give a warning for old-style code that would
otherwise be invalid, or have different behavior.
-fno-gnu-keywords
typeof
as a keyword, so that code can use this
word as an identifier. You can use the keyword __typeof__
instead.
-ansi implies -fno-gnu-keywords.
-fno-implicit-templates
-fno-implicit-inline-templates
-fno-implement-inlines
-fms-extensions
-fno-nonansi-builtins
ffs
, alloca
, _exit
,
index
, bzero
, conjf
, and other related functions.
-fno-operator-names
and
, bitand
,
bitor
, compl
, not
, or
and xor
as
synonyms as keywords.
-fno-optional-diags
-fpermissive
-frepo
-fno-rtti
-fstats
-ftemplate-depth-
n-fuse-cxa-atexit
__cxa_atexit
function rather than the atexit
function.
This option is required for fully standards-compliant handling of static
destructors, but will only work if your C library supports
__cxa_atexit
.
-fno-weak
-nostdinc++
In addition, these optimization, warning, and code generation options have meanings only for C++ programs:
-fno-default-inline
-Wabi
(C++ only)You should rewrite your code to avoid these warnings if you are concerned about the fact that code generated by G++ may not be binary compatible with code generated by other compilers.
The known incompatibilities at this point include:
struct A { virtual void f(); int f1 : 1; }; struct B : public A { int f2 : 1; };
In this case, G++ will place B::f2
into the same byte
asA::f1
; other compilers will not. You can avoid this problem
by explicitly padding A
so that its size is a multiple of the
byte size on your platform; that will cause G++ and other compilers to
layout B
identically.
struct A { virtual void f(); char c1; }; struct B { B(); char c2; }; struct C : public A, public virtual B {};
In this case, G++ will not place B
into the tail-padding for
A
; other compilers will. You can avoid this problem by
explicitly padding A
so that its size is a multiple of its
alignment (ignoring virtual base classes); that will cause G++ and other
compilers to layout C
identically.
union U { int i : 4096; };
Assuming that an int
does not have 4096 bits, G++ will make the
union too small by the number of bits in an int
.
struct A {}; struct B { A a; virtual void f (); }; struct C : public B, public A {};
G++ will place the A
base class of C
at a nonzero offset;
it should be placed at offset zero. G++ mistakenly believes that the
A
data member of B
is already at offset zero.
typename
or
template template parameters can be mangled incorrectly.
template <typename Q> void f(typename Q::X) {} template <template <typename> class Q> void f(typename Q<int>::X) {}
Instantiations of these templates may be mangled incorrectly.
-Wctor-dtor-privacy
(C++ only)-Wnon-virtual-dtor
(C++ only)-Wreorder
(C++ only)struct A { int i; int j; A(): j (0), i (1) { } };
The compiler will rearrange the member initializers for `i' and `j' to match the declaration order of the members, emitting a warning to that effect. This warning is enabled by -Wall.
The following -W... options are not affected by -Wall.
-Weffc++
(C++ only)operator=
return a reference to *this
.
Also warn about violations of the following style guidelines from Scott Meyers' More Effective C++ book:
&&
, ||
, or ,
.
When selecting this option, be aware that the standard library
headers do not obey all of these guidelines; use `grep -v'
to filter out those warnings.
-Wno-deprecated
(C++ only)-Wno-non-template-friend
(C++ only)-Wold-style-cast
(C++ only)-Woverloaded-virtual
(C++ only)struct A { virtual void f(); }; struct B: public A { void f(int); };
the A
class version of f
is hidden in B
, and code
like:
B* b; b->f();
will fail to compile.
-Wno-pmf-conversions
(C++ only)-Wsign-promo
(C++ only)struct A { operator int (); A& operator = (int); }; main () { A a,b; a = b; }
In this example, G++ will synthesize a default `A& operator = (const A&);', while cfront will use the user-defined `operator ='.
(NOTE: This manual does not describe the Objective-C language itself. See http://gcc.gnu.org/readings.html for references.)
This section describes the command-line options that are only meaningful
for Objective-C programs, but you can also use most of the GNU compiler
options regardless of what language your program is in. For example,
you might compile a file some_class.m
like this:
gcc -g -fgnu-runtime -O -c some_class.m
In this example, -fgnu-runtime is an option meant only for Objective-C programs; you can use the other options with any language supported by GCC.
Here is a list of options that are only for compiling Objective-C programs:
-fconstant-string-class=
class-name@"..."
. 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, will override the
-fconstant-string-class setting and cause @"..."
literals
to be laid out as constant CoreFoundation strings.
-fgnu-runtime
-fnext-runtime
__NEXT_RUNTIME__
is predefined if (and only if) this option is
used.
-fno-nil-receivers
[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. Currently, this option is only available in conjunction with
the NeXT runtime on Mac OS X 10.3 and later.
-fobjc-exceptions
@try { ... @throw expr; ... } @catch (AnObjCClass *exc) { ... @throw expr; ... @throw; ... } @catch (AnotherClass *exc) { ... } @catch (id allOthers) { ... } @finally { ... @throw expr; ... }
The @throw
statement may appear anywhere in an Objective-C or
Objective-C++ program; when used inside of a @catch
block, the
@throw
may appear without an argument (as shown above), in which case
the object caught by the @catch
will be rethrown.
Note that only (pointers to) Objective-C objects may be thrown and
caught using this scheme. When an object is thrown, it will be caught
by the nearest @catch
clause capable of handling objects of that type,
analogously to how catch
blocks work in C++ and Java. A
@catch(id ...)
clause (as shown above) may also be provided to catch
any and all Objective-C exceptions not caught by previous @catch
clauses (if any).
The @finally
clause, if present, will be executed upon exit from the
immediately preceding @try ... @catch
section. This will happen
regardless of whether any exceptions are thrown, caught or rethrown
inside the @try ... @catch
section, analogously to the behavior
of the finally
clause in Java.
There are several caveats to using the new exception mechanism:
NS_HANDLER
-style
idioms provided by the NSException
class, the new
exceptions can only be used on Mac OS X 10.3 (Panther) and later
systems, due to additional functionality needed in the (NeXT) Objective-C
runtime.
@throw
an exception
from Objective-C and catch
it in C++, or vice versa
(i.e., throw ... @catch
).
The -fobjc-exceptions switch also enables the use of synchronization blocks for thread-safe execution:
@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.
-freplace-objc-classes
-fzero-link
objc_getClass("...")
(when the name of the class is known at
compile time) with static class references that get initialized at load time,
which improves run-time performance. Specifying the -fzero-link flag
suppresses this behavior and causes calls to objc_getClass("...")
to be retained. This is useful in Zero-Link debugging mode, since it allows
for individual class implementations to be modified during program execution.
-gen-decls
-Wno-protocol
-Wno-protocol
option, then
methods inherited from the superclass are considered to be implemented,
and no warning is issued for them.
-Wselector
@selector(...)
expression, and a corresponding method for that selector has been found
during compilation. Because these checks scan the method table only at
the end of compilation, these warnings are not produced if the final
stage of compilation is not reached, for example because an error is
found during compilation, or because the -fsyntax-only
option is
being used.
-Wundeclared-selector
@selector(...)
expression referring to an
undeclared selector is found. A selector is considered undeclared if no
method with that name has been declared before the
@selector(...)
expression, either explicitly in an
@interface
or @protocol
declaration, or implicitly in
an @implementation
section. This option always performs its
checks as soon as a @selector(...)
expression is found,
while -Wselector
only performs its checks in the final stage of
compilation. This also enforces the coding style convention
that methods and selectors must be declared before being used.
-print-objc-runtime-info
Traditionally, diagnostic messages have been formatted irrespective of the output device's aspect (e.g. its width, ...). The options described below can be used to control the diagnostic messages formatting algorithm, e.g. how many characters per line, how often source location information should be reported. Right now, only the C++ front end can honor these options. However it is expected, in the near future, that the remaining front ends would be able to digest them correctly.
-fmessage-length=
n-fdiagnostics-show-location=once
-fdiagnostics-show-location=every-line
Warnings are diagnostic messages that report constructions which are not inherently erroneous but which are risky or suggest there may have been an error.
You can request many specific warnings with options beginning `-W', for example -Wimplicit to request warnings on implicit declarations. Each of these specific warning options also has a negative form beginning `-Wno-' to turn off warnings; for example, -Wno-implicit. This manual lists only one of the two forms, whichever is not the default.
The following options control the amount and kinds of warnings produced by GCC; for further, language-specific options also refer to C++ Dialect Options and Objective-C Dialect Options.
-fsyntax-only
-pedantic
Valid ISO C and ISO C++ programs should compile properly with or without this option (though a rare few will require -ansi or a -std option specifying 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.
-pedantic does not cause warning messages for use of the
alternate keywords whose names begin and end with `__'. Pedantic
warnings 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 Alternate Keywords.
Some users try to use -pedantic to check programs for strict ISO C conformance. 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 -pedantic. 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 `gnu89' or `gnu99', there is a
corresponding base standard, the version of ISO C on which the GNU
extended dialect is based. Warnings from -pedantic are given
where they are required by the base standard. (It would 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
-w
-Wno-import
-Wchar-subscripts
char
. This is a common cause
of error, as programmers often forget that this type is signed on some
machines.
-Wcomment
-Wformat
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 Function Attributes), in the printf
,
scanf
, strftime
and strfmon
(an X/Open extension,
not in the C standard) families.
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 support warning about features that go beyond a
particular library's limitations. However, if -pedantic is used
with -Wformat, warnings will be given about format features not
in the selected standard version (but not for strfmon
formats,
since those are not in any version of the C standard). See Options Controlling C Dialect.
Since -Wformat also checks for null format arguments for several functions, -Wformat also implies -Wnonnull.
-Wformat is included in -Wall. For more control over some
aspects of format checking, the options -Wformat-y2k,
-Wno-format-extra-args, -Wno-format-zero-length,
-Wformat-nonliteral, -Wformat-security, and
-Wformat=2 are available, but are not included in -Wall.
-Wformat-y2k
strftime
formats which may yield only a two-digit year.
-Wno-format-extra-args
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 will suppress the
warning if the unused arguments are all pointers, since the Single
Unix Specification says that such unused arguments are allowed.
-Wno-format-zero-length
-Wformat-nonliteral
va_list
.
-Wformat-security
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 future warnings may be added to -Wformat-security that are not
included in -Wformat-nonliteral.)
-Wformat=2
-Wnonnull
nonnull
function attribute.
-Wnonnull is included in -Wall and -Wformat. It
can be disabled with the -Wno-nonnull option.
-Winit-self
(C, C++, and Objective-C only)For example, GCC will warn about i
being uninitialized in the
following snippet only when -Winit-self has been specified:
int f() { int i = i; return i; }
-Wimplicit-int
-Wimplicit-function-declaration
-Werror-implicit-function-declaration
-Wimplicit
-Wmain
-Wmissing-braces
int a[2][2] = { 0, 1, 2, 3 }; int b[2][2] = { { 0, 1 }, { 2, 3 } };
-Wparentheses
Also warn about constructions where there may be confusion to which
if
statement an else
branch belongs. Here is an example of
such a case:
{ if (a) if (b) foo (); else bar (); }
In C, every else
branch belongs to the innermost possible if
statement, which in this example is if (b)
. This is often not
what the programmer expected, as illustrated in the above example by
indentation the programmer chose. When there is the potential for this
confusion, GCC will issue a warning when this flag is specified.
To eliminate the warning, add explicit braces around the innermost
if
statement so there is no way the else
could belong to
the enclosing if
. The resulting code would look like this:
{ if (a) { if (b) foo (); else bar (); } }
-Wsequence-point
The C standard defines the order in which expressions in a 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 the sequence point, and those executed after it. These occur
after the evaluation 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 expressed 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 standard specifies 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 present implementation of this option only works for C programs. A future implementation may also work for C++ programs.
The C 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
http://gcc.gnu.org/readings.html.
-Wreturn-type
int
. Also warn about any return
statement with no
return-value in a function whose return-type is not void
.
For C++, a function without return type always produces a diagnostic
message, even when -Wno-return-type is specified. The only
exceptions are `main' and functions defined in system headers.
-Wswitch
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.
-Wswitch-default
switch
statement does not have a default
case.
-Wswitch-enum
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.
-Wtrigraphs
-Wunused-function
-Wunused-label
To suppress this warning use the `unused' attribute
(see Variable Attributes).
-Wunused-parameter
To suppress this warning use the `unused' attribute
(see Variable Attributes).
-Wunused-variable
To suppress this warning use the `unused' attribute
(see Variable Attributes).
-Wunused-value
To suppress this warning cast the expression to `void'.
-Wunused
In order to get a warning about an unused function parameter, you must
either specify `-Wextra -Wunused' (note that `-Wall' implies
`-Wunused'), or separately specify -Wunused-parameter.
-Wuninitialized
setjmp
call.
These warnings are possible only in optimizing compilation, because they require data flow information that is computed only when optimizing. If you don't specify -O, you simply won't get these warnings.
If you want to warn about code which uses the uninitialized value of the variable in its own initializer, use the -Winit-self option.
These warnings occur only for variables that are candidates for
register allocation. Therefore, they do not occur for a variable that
is declared volatile
, or whose address is taken, or whose size
is other than 1, 2, 4 or 8 bytes. Also, they do not occur for
structures, unions or arrays, even when they are in registers.
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.
These warnings are made optional because GCC is not smart enough to see all the reasons why the code might be correct despite 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. Here is
another common case:
{ int save_y; if (change_y) save_y = y, y = new_y; ... if (change_y) y = save_y; }
This has no bug because save_y
is used only if it is set.
This option also warns when a non-volatile automatic variable might be
changed by a call to longjmp
. These warnings as well are possible
only in optimizing compilation.
The compiler sees only the calls to setjmp
. It cannot 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 which would cause a problem.
Some spurious warnings can be avoided if you declare all the functions
you use that never return as noreturn
. See Function Attributes.
-Wunknown-pragmas
-Wstrict-aliasing
-Wall
The following -W... options are not implied by -Wall. Some of them warn about constructions that users generally do not consider questionable, but which 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 modify the code to suppress the warning.
-Wextra
foo (a) { if (a > 0) return a; }
static
are not the first things in
a declaration. According to the C Standard, this usage is obsolescent.
const
.
Such a type qualifier has no effect, since the value returned by a
function is not an lvalue. (But don't warn about the GNU extension of
volatile void
return types. That extension will be warned about
if -pedantic is specified.)
void foo(bar) { }
-Wno-div-by-zero
-Wsystem-headers
-Wfloat-equal
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
would 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 only)<limits.h>
.
Use of these macros in user code might normally lead to spurious
warnings, however GCC's integrated preprocessor has enough context to
avoid warning in these cases.
switch
statement has an operand of type long
.
static
function declaration follows a static
one.
This construct is not accepted by some traditional C compilers.
__STDC__
to avoid missing
initializer warnings and relies on default initialization to zero in the
traditional C case.
PARAMS
and
VPARAMS
. This warning is also bypassed for nested functions
because that feature is already a GCC extension and thus not relevant to
traditional C compatibility.
-Wdeclaration-after-statement
(C only)-Wundef
-Wendif-labels
-Wshadow
-Wlarger-than-
len-Wpointer-arith
void
. GNU C assigns these types a size of 1, for
convenience in calculations with void *
pointers and pointers
to functions.
-Wbad-function-cast
(C only)int malloc()
is cast to anything *
.
-Wbounded
It only works with statically allocated fixed-size buffers. Since it is applied at compile-time, dynamically allocated memory buffers and non-constant arguments are ignored.
If -Wbounded is specified together with -Wformat,
additional checks are performed on sscanf(3) format strings.
The `%s' fields are checked for incorrect bound lengths by
checking the size of the buffer associated with the format argument.
-Wcast-qual
const char *
is cast
to an ordinary char *
.
-Wcast-align
char *
is cast to
an int *
on machines where integers can only be accessed at
two- or four-byte boundaries.
-Wwrite-strings
const
char[
length]
so that
copying the address of one into a non-const
char *
pointer will get a warning; when compiling C++, warn about the
deprecated conversion from string constants to char *
.
These warnings will 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 will just be a nuisance;
this is why we did not make -Wall request these warnings.
-Wconversion
Also, warn if a negative integer constant expression is implicitly
converted to an unsigned type. For example, warn about the assignment
x = -1
if x
is unsigned. But do not warn about explicit
casts like (unsigned) -1
.
-Wsign-compare
-Waggregate-return
-Wstrict-prototypes
(C only)-Wold-style-definition
(C only)-Wmissing-prototypes
(C only)-Wmissing-declarations
(C only)-Wmissing-field-initializers
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 modification would not trigger a warning:
struct s { int f, g, h; }; struct s x = { .f = 3, .g = 4 };
This warning is included in -Wextra. To get other -Wextra
warnings without this one, use `-Wextra -Wno-missing-field-initializers'.
-Wmissing-noreturn
noreturn
.
Note these are only possible candidates, not absolute ones. Care should
be taken to manually verify functions actually do not ever return before
adding the noreturn
attribute, otherwise subtle code generation
bugs could be introduced. You will not get a warning for main
in
hosted C environments.
-Wmissing-format-attribute
format
attributes. Note these are only possible
candidates, not absolute ones. GCC will guess that format
attributes might be appropriate for any function that calls a function
like vprintf
or vscanf
, but this might not always be the
case, and some functions for which format
attributes are
appropriate may not be detected. This option has no effect unless
-Wformat is enabled (possibly by -Wall).
-Wno-multichar
-Wno-deprecated-declarations
deprecated
attribute.
(see Function Attributes, see Variable Attributes,
see Type Attributes.)
-Wpacked
f.x
in struct bar
will be 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; };
-Wpadded
-Wredundant-decls
-Wnested-externs
(C only)extern
declaration is encountered within a function.
-Wunreachable-code
This option is intended to warn when the compiler detects that at least a whole line of source code will never be executed, because some condition is never satisfied or because it is after a procedure that never returns.
It is possible for this option to produce a warning even though there are circumstances under which part of the affected line can be executed, so care should be taken when removing apparently-unreachable code.
For instance, when a function is inlined, a warning may mean that the line is unreachable in only one inlined copy of the function.
This option is not made part of -Wall because in a debugging
version of a program there is often substantial code which checks
correct functioning of the program and is, hopefully, unreachable
because the program does work. Another common use of unreachable
code is to provide behavior which is selectable at compile-time.
-Winline
The compiler uses a variety of heuristics to determine whether or not
to inline a function. For example, the compiler takes into account
the size of the function being inlined and the the amount of inlining
that has already been done in the current function. Therefore,
seemingly insignificant changes in the source program can cause the
warnings produced by -Winline to appear or disappear.
-Wno-invalid-offsetof
(C++ only)The restrictions on `offsetof' may be relaxed in a future version
of the C++ standard.
-Winvalid-pch
-Wlong-long
-Wdisabled-optimization
-Wstack-larger-than-
len-Wstack-protector
-Wtrampolines
-Werror
-Werror-maybe-reset
-fhonour-copts
GCC has various special options that are used for debugging either your program or GCC:
-g
On most systems that use stabs format, -g enables use of extra debugging information that only GDB can use; this extra information makes debugging work better in GDB but will probably make other debuggers crash or refuse to read the program. If you want to control for certain whether to generate the extra information, use -gstabs+, -gstabs, -gxcoff+, -gxcoff, or -gvms (see below).
Unlike most other C compilers, GCC allows you to use -g with -O. The shortcuts taken by optimized code may occasionally produce surprising results: some variables you declared may not exist at all; flow of control may briefly move where you did not expect it; some statements may not be executed because they compute constant results or their values were already at hand; some statements may execute in different places because they were moved out of loops.
Nevertheless it proves possible to debug optimized output. This makes it reasonable to use the optimizer for programs that might have bugs.
The following options are useful when GCC is generated with the
capability for more than one debugging format.
-ggdb
-gstabs
-feliminate-unused-debug-symbols
-gstabs+
-gcoff
-gxcoff
-gxcoff+
-gdwarf-2
-gvms
-g
level-ggdb
level-gstabs
level-gcoff
level-gxcoff
level-gvms
levelLevel 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, but no information about local variables and no line numbers.
Level 3 includes extra information, such as all the macro definitions present in the program. Some debuggers support macro expansion when you use -g3.
Note that in order to avoid confusion between DWARF1 debug level 2,
and DWARF2 -gdwarf-2 does not accept a concatenated debug
level. Instead use an additional -glevel option to
change the debug level for DWARF2.
-feliminate-dwarf2-dups
-p
-pg
-Q
-ftime-report
-fmem-report
-fprofile-arcs
fork
calls are detected and correctly handled (double counting
will not happen).
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
-d
lettersADDRESSOF
codes, to file.07.addressof.
-fdump-unnumbered
-fdump-translation-unit
(C and C++ only)-fdump-translation-unit-
options (C and C++ only)-fdump-class-hierarchy
(C++ only)-fdump-class-hierarchy-
options (C++ only)-fdump-tree-
switch (C++ only)-fdump-tree-
switch-
options (C++ only)The following tree dumps are possible:
-frandom-seed=
stringThe string should be different for every file you compile.
-fsched-verbose=
nFor n greater than zero, -fsched-verbose outputs the
same information as -dRS. 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.
-save-temps
-time
# 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.
-print-file-name=
library-print-multi-directory
-print-multi-lib
-print-prog-name=
program-print-libgcc-file-name
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
This is useful when gcc prints the error message
`installation problem, cannot exec cpp0: No such file or directory'.
To resolve this you either 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 directory where you installed them.
Don't forget the trailing '/'.
See Environment Variables.
-dumpmachine
-dumpversion
-dumpspecs
-feliminate-unused-debug-types
These options control various sorts of optimizations.
Without any optimization option, the compiler's goal is to reduce the cost of compilation and to make debugging produce the expected results. Statements are independent: if you stop the program with a breakpoint between statements, you can then assign a new value to any variable or change the program counter to any other statement in the function and get exactly the results you would expect from the source code.
Turning on optimization flags makes the compiler attempt to improve the performance and/or code size at the expense of compilation time and possibly the ability to debug the program.
The compiler performs optimization based on the knowledge it has of the program. Using the -funit-at-a-time flag will allow the compiler to consider information gained from later functions in the file when compiling a function. Compiling multiple files at once to a single output file (and using -funit-at-a-time) will allow the compiler to use information gained from all of the files when compiling each of them.
Not all optimizations are controlled directly by a flag. Only optimizations that have a flag are listed.
-O
-O1
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:
-fdefer-pop -fmerge-constants -fthread-jumps -floop-optimize -fif-conversion -fif-conversion2 -fdelayed-branch -fguess-branch-probability -fcprop-registers
-O also turns on -fomit-frame-pointer on machines
where doing so does not interfere with debugging.
-O2
In MirOS, some security-tradeoff optimisations are not enabled at this level.
-O2 turns on all optimization flags specified by -O. It also turns on the following optimization flags:
-fforce-mem -foptimize-sibling-calls -fstrength-reduce -fcse-follow-jumps -fcse-skip-blocks -frerun-cse-after-loop -frerun-loop-opt -fgcse -fgcse-lm -fgcse-sm -fgcse-las -fexpensive-optimizations -fregmove -fschedule-insns -fschedule-insns2 -fsched-interblock -fsched-spec -fcaller-saves -fpeephole2 -freorder-blocks -freorder-functions -funit-at-a-time -falign-functions -falign-jumps -falign-loops -falign-labels -fcrossjumping
Please note the warning under -fgcse about
invoking -O2 on programs that use computed gotos.
-O3
-O0
-Os
-Os disables the following optimization flags:
-falign-functions -falign-jumps -falign-loops -falign-labels -freorder-blocks -fprefetch-loop-arrays
If you use multiple -O options, with or without level numbers, the last such option is the one that is effective.
FSF releases default to -fident instead of -fno-ident like MirOS releases; furthermore, they enable trampolines by default instead of requiring -ftrampolines, do not have stack protection, bounds checking, stack frame size limit warnings; the optimisation options -fdelete-null-pointer-checks and -fstrict-aliasing are enabled at -O2 and -Os already in FSF versions instead of at -O3 only like in MirOS versions.
Options of the form -fflag specify machine-independent flags. Most flags have both positive and negative forms; the negative form of -ffoo would be -fno-foo. In the table below, only one of the forms is listed—the one you typically will 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.
-fno-default-inline
-fno-defer-pop
Disabled at levels -O, -O2, -O3, -Os.
-fforce-mem
Enabled at levels -O2, -O3, -Os.
-fforce-addr
-fomit-frame-pointer
On some machines, such as the VAX, this flag has no effect, because
the standard calling sequence automatically handles the frame pointer
and nothing is saved by pretending it doesn't exist. The
machine-description macro FRAME_POINTER_REQUIRED
controls
whether a target machine supports this flag. See Register Usage.
Enabled at levels -O, -O2, -O3, -Os.
-foptimize-sibling-calls
Enabled at levels -O2, -O3, -Os.
-fno-inline
inline
keyword. Normally this option
is used to keep the compiler from expanding any functions inline.
Note that if you are not optimizing, no functions can be expanded inline.
-finline-functions
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 level -O3.
-finline-limit=
nInlining is actually controlled by a number of parameters, which may be specified individually by using --param name=value. The -finline-limit=n option sets some of these parameters as follows:
max-inline-insns-single
max-inline-insns-auto
min-inline-insns
max-inline-insns-rtl
See below for a documentation of the individual parameters controlling inlining.
Note: pseudo instruction represents, in this particular context, an
abstract measurement of function's size. In no way, it represents a count
of assembly instructions and as such its exact meaning might change from one
release to an another.
-fkeep-inline-functions
static
, nevertheless output a separate run-time
callable version of the function. This switch does not affect
extern inline
functions.
-fkeep-static-consts
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 the variable was referenced, regardless of whether or not
optimization is turned on, use the -fno-keep-static-consts option.
-fmerge-constants
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 -O, -O2, -O3, -Os.
-fmerge-all-constants
This option implies -fmerge-constants. In addition to
-fmerge-constants this considers e.g. even constant initialized
arrays or initialized constant variables with integral or floating point
types. Languages like C or C++ require each non-automatic variable to
have distinct location, so using this option will result in non-conforming
behavior.
-fnew-ra
-fno-branch-count-reg
The default is -fbranch-count-reg, enabled when
-fstrength-reduce is enabled.
-fno-function-cse
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
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.
-fstrength-reduce
Enabled at levels -O2, -O3, -Os.
-fthread-jumps
Enabled at levels -O, -O2, -O3, -Os.
-fcse-follow-jumps
if
statement with an
else
clause, CSE will follow the jump when the condition
tested is false.
Enabled at levels -O2, -O3, -Os.
-fcse-skip-blocks
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
Enabled at levels -O2, -O3, -Os.
-frerun-loop-opt
Enabled at levels -O2, -O3, -Os.
-fgcse
Note: When compiling a program using computed gotos, a GCC extension, you may get better runtime 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
Enabled by default when gcse is enabled.
-fgcse-sm
Enabled by default when gcse is enabled.
-fgcse-las
Enabled by default when gcse is enabled.
-floop-optimize
Enabled at levels -O, -O2, -O3, -Os.
-fcrossjumping
Enabled at levels -O, -O2, -O3, -Os.
-fif-conversion
if-conversion2
.
Enabled at levels -O, -O2, -O3, -Os.
-fif-conversion2
Enabled at levels -O, -O2, -O3, -Os.
-fdelete-null-pointer-checks
In some environments, this assumption is not true, and programs can safely dereference null pointers. Use -fno-delete-null-pointer-checks to disable this optimization for programs which depend on that behavior.
Enabled at level -O3.
-fexpensive-optimizations
Enabled at levels -O2, -O3, -Os.
-foptimize-register-move
-fregmove
Note -fregmove and -foptimize-register-move are the same optimization.
Enabled at levels -O2, -O3, -Os.
-fdelayed-branch
Enabled at levels -O, -O2, -O3, -Os.
-fschedule-insns
Enabled at levels -O2, -O3, -Os.
-fschedule-insns2
Enabled at levels -O2, -O3, -Os.
-fno-sched-interblock
-fno-sched-spec
-fsched-spec-load
-fsched-spec-load-dangerous
-fsched-stalled-insns=
n-fsched-stalled-insns-dep=
n-fsched2-use-superblocks
This only makes sense when scheduling after register allocation, i.e. with
-fschedule-insns2 or at -O2 or higher.
-fsched2-use-traces
This mode should produce faster but significantly longer programs. Also
without -fbranch-probabilities
the traces constructed may not match the
reality and hurt the performance. This only makes
sense when scheduling after register allocation, i.e. with
-fschedule-insns2 or at -O2 or higher.
-fcaller-saves
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.
-fmove-all-movables
-freduce-all-givs
Note: When compiling programs written in Fortran, -fmove-all-movables and -freduce-all-givs are enabled by default when you use the optimizer.
These options may generate better or worse code; results are highly dependent on the structure of loops within the source code.
These two options are intended to be removed someday, once they have helped determine the efficacy of various approaches to improving loop optimizations.
Please contact gcc@gcc.gnu.org, and describe how use of
these options affects the performance of your production code.
Examples of code that runs slower when these options are
enabled are very valuable.
-fno-peephole
-fno-peephole2
-fpeephole is enabled by default.
-fpeephole2 enabled at levels -O2, -O3, -Os.
-fno-guess-branch-probability
Sometimes GCC will opt to use a randomized model to guess branch probabilities, when none are available from either profiling feedback (-fprofile-arcs) or `__builtin_expect'. This means that different runs of the compiler on the same program may produce different object code.
In a hard real-time system, people don't want different runs of the compiler to produce code that has different behavior; minimizing non-determinism is of paramount import. This switch allows users to reduce non-determinism, possibly at the expense of inferior optimization.
The default is -fguess-branch-probability at levels
-O, -O2, -O3, -Os.
-freorder-blocks
Enabled at levels -O2, -O3.
-freorder-functions
.text.hot
for most frequently executed functions and
.text.unlikely
for unlikely executed functions. Reordering is done by
the linker so object file format must support named sections and linker must
place them in a reasonable way.
Also profile feedback must be available in to make this option effective. See -fprofile-arcs for details.
Enabled at levels -O2, -O3, -Os.
-fstrict-aliasing
unsigned int
can alias an int
, but not a
void*
or a double
. A character type may alias any other
type.
Pay special attention to code like this:
union a_union { int i; double d; }; int f() { a_union t; 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 will work as expected. However, this code might not:
int f() { a_union t; int* ip; t.d = 3.0; ip = &t.i; return *ip; }
Every language that wishes to perform language-specific alias analysis
should define a function that computes, given an tree
node, an alias set for the node. Nodes in different alias sets are not
allowed to alias. For an example, see the C front-end function
c_get_alias_set
.
Enabled at level -O3.
-falign-functions
-falign-functions=
n-fno-align-functions and -falign-functions=1 are equivalent and mean that functions will not be aligned.
Some assemblers only support this flag when n is a power of two; in that case, it is rounded up.
If n is not specified or is zero, use a machine-dependent default.
Enabled at levels -O2, -O3.
-falign-labels
-falign-labels=
n-fno-align-labels and -falign-labels=1 are equivalent and mean that labels will not be 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.
Enabled at levels -O2, -O3.
-falign-loops
-falign-loops=
n-fno-align-loops and -falign-loops=1 are equivalent and mean that loops will not be aligned.
If n is not specified or is zero, use a machine-dependent default.
Enabled at levels -O2, -O3.
-falign-jumps
-falign-jumps=
n-fno-align-jumps and -falign-jumps=1 are equivalent and mean that loops will not be aligned.
If n is not specified or is zero, use a machine-dependent default.
Enabled at levels -O2, -O3.
-frename-registers
-fweb
Enabled at level -O3.
-fno-cprop-registers
Disabled at levels -O, -O2, -O3, -Os.
-fprofile-generate
-fprofile-generate
both when
compiling and when linking your program.
The following options are enabled: -fprofile-arcs
, -fprofile-values
, -fvpt
.
-fprofile-use
The following options are enabled: -fbranch-probabilities
,
-fvpt
, -funroll-loops
, -fpeel-loops
, -ftracer
.
The following options control compiler behavior regarding floating point arithmetic. These options trade off between speed and correctness. All must be specifically enabled.
-ffloat-store
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.
-ffast-math
This option causes the preprocessor macro __FAST_MATH__
to be defined.
This option should never be turned on by any -O option since
it can result in incorrect output for programs which depend on
an exact implementation of IEEE or ISO rules/specifications for
math functions.
-fno-math-errno
This option should never be turned on by any -O option since it can result in incorrect output for programs which depend on an exact implementation of IEEE or ISO rules/specifications for math functions.
The default is -fmath-errno.
-funsafe-math-optimizations
This option should never be turned on by any -O option since it can result in incorrect output for programs which depend on an exact implementation of IEEE or ISO rules/specifications for math functions.
The default is -fno-unsafe-math-optimizations.
-ffinite-math-only
This option should never be turned on by any -O option since it can result in incorrect output for programs which depend on an exact implementation of IEEE or ISO rules/specifications.
The default is -fno-finite-math-only.
-fno-trapping-math
This option should never be turned on by any -O option since it can result in incorrect output for programs which depend on an exact implementation of IEEE or ISO rules/specifications for math functions.
The default is -ftrapping-math.
-frounding-math
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
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.
-fsingle-precision-constant
The following options control optimizations that may improve performance, but are not enabled by any -O options. This section includes experimental options that may produce broken code.
-fbranch-probabilities
With -fbranch-probabilities, GCC puts a
`REG_BR_PROB' note on each `JUMP_INSN' and `CALL_INSN'.
These can be used to improve optimization. Currently, they are only
used in one place: in reorg.c, instead of guessing which path a
branch is mostly to take, the `REG_BR_PROB' values are used to
exactly determine which path is taken more often.
-fprofile-values
With -fbranch-probabilities, it reads back the data gathered
from profiling values of expressions and adds `REG_VALUE_PROFILE'
notes to instructions for their later usage in optimizations.
-fvpt
With -fbranch-probabilities, it reads back the data gathered
and actually performs the optimizations based on them.
Currently the optimizations include specialization of division operation
using the knowledge about the value of the denominator.
-fnew-ra
-ftracer
-funit-at-a-time
-funroll-loops
-funroll-all-loops
-fpeel-loops
-funswitch-loops
-fold-unroll-loops
-fold-unroll-all-loops
-fprefetch-loop-arrays
Disabled at level -Os.
-ffunction-sections
-fdata-sections
Use these options on systems where the linker can perform optimizations to improve locality of reference in the instruction space. Most systems using the ELF object format and SPARC processors running Solaris 2 have linkers with such optimizations. AIX may have these optimizations in the future.
Only use these options when there are significant benefits from doing
so. When you specify these options, the assembler and linker will
create larger object and executable files and will also be slower.
You will not be able to use gprof
on all systems if you
specify this option and you may have problems with debugging if
you specify both this option and -g.
-fbranch-target-load-optimize
-fbranch-target-load-optimize2
--param
name=
valueThe 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 each case, the value is an integer. The allowable choices for name are given in the following table:
max-crossjump-edges
max-delay-slot-insn-search
max-delay-slot-live-search
max-gcse-memory
max-gcse-passes
max-pending-list-length
max-inline-insns-single
max-inline-insns-auto
large-function-insns
large-function-growth
inline-unit-growth
max-inline-insns-rtl
max-unrolled-insns
max-average-unrolled-insns
max-unroll-times
max-peeled-insns
max-peel-times
max-completely-peeled-insns
max-completely-peel-times
max-unswitch-insns
max-unswitch-level
hot-bb-count-fraction
hot-bb-frequency-fraction
tracer-dynamic-coverage
tracer-dynamic-coverage-feedback
The tracer-dynamic-coverage-feedback is used only when profile
feedback is available. The real profiles (as opposed to statically estimated
ones) are much less balanced allowing the threshold to be larger value.
tracer-max-code-growth
tracer-min-branch-ratio
tracer-min-branch-ratio
tracer-min-branch-ratio-feedback
Similarly to tracer-dynamic-coverage two values are present, one for
compilation for profile feedback and one for compilation without. The value
for compilation with profile feedback needs to be more conservative (higher) in
order to make tracer effective.
max-cse-path-length
max-last-value-rtl
ggc-min-expand
The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
RAM >= 1GB. If getrlimit
is available, the notion of "RAM" is
the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS. If
GCC is not able to calculate RAM on a particular platform, the lower
bound of 30% is used. Setting this parameter and
ggc-min-heapsize to zero causes a full collection to occur at
every opportunity. This is extremely slow, but can be useful for
debugging.
ggc-min-heapsize
The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
upper bound of 131072 (128 megabytes). If getrlimit
is
available, the notion of "RAM" is the smallest of actual RAM,
RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS. If GCC is not able to calculate
RAM on a particular platform, the lower bound is used. Setting this
parameter very large effectively disables garbage collection. Setting
this parameter and ggc-min-expand to zero causes a full
collection to occur at every opportunity.
max-reload-search-insns
max-cselib-memory-location
reorder-blocks-duplicate
reorder-blocks-duplicate-feedback
The reorder-block-duplicate-feedback is used only when profile feedback is available and may be set to higher values than reorder-block-duplicate since information about the hot spots is more accurate.
These options control the C preprocessor, which is run on each C source file before actual compilation.
If you use the -E option, nothing is done except preprocessing. Some of these options make sense only together with -E because they cause the preprocessor output to be unsuitable for actual compilation.
-Wp,
option-Xpreprocessor
optionIf you want to pass an option that takes an argument, you must use -Xpreprocessor twice, once for the option and once for the argument.
-D
name1
.
-D
name=
definitionIf 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 will need to 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-undef
-I
dir-o
file-Wall
#if
expressions. Note that many of the
preprocessor's warnings are on by default and have no options to
control them.
-Wcomment
-Wcomments
-Wtrigraphs
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'.
-Wtraditional
-Wimport
-Wundef
-Wunused-macros
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 CPP will report 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:
#if defined the_macro_causing_the_warning #endif
-Wendif-labels
#if FOO ... #else FOO ... #endif FOO
The second and third FOO
should be in comments, but often are not
in older programs. This warning is on by default.
-Werror
-Werror-maybe-reset
-Wsystem-headers
-w
-pedantic
-pedantic-errors
-M
Unless specified explicitly (with -MT or -MQ), the object file name consists of the basename of the source file with any suffix replaced with object file suffix. 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 explicitly specify the dependency output file with -MF, or use an environment variable like DEPENDENCIES_OUTPUT (see Environment Variables). Debug output will still be sent to the regular output stream as normal.
Passing -M to the driver implies -E, and suppresses
warnings with an implicit -w.
-MM
This implies that the choice of angle brackets or double quotes in an `#include' directive does not in itself determine whether that header will appear in -MM dependency output. This is a slight change in semantics from GCC versions 3.0 and earlier.
-MF
fileWhen used with the driver options -MD or -MMD,
-MF overrides the default dependency output file.
-MG
#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.
-MP
This is typical output:
test.o: test.c test.h test.h:
-MT
targetAn -MT option will set 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$$(objpfx)foo.o: foo.c
The default target is automatically quoted, as if it were given with
-MQ.
-MD
If -MD is used in conjunction with -E, any -o switch is understood to specify the dependency output file (but see -MF), 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
-fpch-deps
-x c
-x c++
-x objective-c
-x assembler-with-cpp
Note: Previous versions of cpp accepted a -lang option
which selected both the language and the standards conformance level.
This option has been removed, because it conflicts with the -l
option.
-std=
standard-ansi
standard may be one of:
iso9899:1990
c89
The -ansi option is equivalent to -std=c89.
iso9899:199409
iso9899:1999
c99
iso9899:199x
c9x
gnu89
gnu99
gnu9x
c++98
gnu++98
-I-
#include "
file"
; they are not searched for
#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"
.
-nostdinc
-nostdinc++
-include
file#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.
-imacros
fileAll files specified by -imacros are processed before all files
specified by -include.
-idirafter
dir-iprefix
prefix-iwithprefix
dir-iwithprefixbefore
dir-isystem
dir-fdollars-in-identifiers
-fpreprocessed
-fpreprocessed is implicit if the input file has one of the
extensions `.i', `.ii' or `.mi'. These are the
extensions that GCC uses for preprocessed files created by
-save-temps.
-ftabstop=
width-fexec-charset=
charseticonv
library routine.
-fwide-exec-charset=
charsetwchar_t
. As with
-ftarget-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=
charseticonv
library routine.
-fworking-directory
#line
directives are emitted whatsoever.
-fno-show-column
-A
predicate=
answer-A -
predicate=
answer-dCHARS
touch foo.h; cpp -dM foo.h
will show all the predefined macros.
-P
-C
You should be prepared for side effects when using -C; it
causes the preprocessor 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 turning that line into an ordinary
source line, since the first token on the line is no longer a `#'.
-CC
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.
-traditional-cpp
-trigraphs
The nine trigraphs and their replacements are
Trigraph: ??( ??) ??< ??> ??= ??/ ??' ??! ??- Replacement: [ ] { } # \ ^ | ~
-remap
--help
--target-help
-v
-H
-version
--version
You can pass options to the assembler.
-Wa,
option-Xassembler
optionIf you want to pass an option that takes an argument, you must use -Xassembler twice, once for the option and once for the argument.
These options come into play when the compiler links object files into an executable output file. They are meaningless if the compiler is not doing a link step.
-c
-S
-E
-l
library-l
libraryIt 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 specified. 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.
The linker searches a standard list of directories for the library, which is actually a file named liblibrary.a. The linker then uses this file as if it had been specified precisely by name.
The directories searched include several standard system directories plus any that you specify with -L.
Normally the files found this way are library files—archive files
whose members are object files. The linker handles an archive file by
scanning through it for members which define symbols that have so far
been referenced but not defined. But if the file that is found is an
ordinary object file, it is linked in the usual fashion. The only
difference between using an -l option and specifying a file name
is that -l surrounds library with `lib' and `.a'
and searches several directories.
-lobjc
-nostartfiles
-nodefaultlibs
-nostdlib
One of the standard libraries bypassed by -nostdlib and
-nodefaultlibs is libgcc.a, a library of internal subroutines
that GCC uses to overcome shortcomings of particular machines, or special
needs for some languages.
(See Interfacing to GCC Output,
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. (For example, `__main', used to ensure C++
constructors will be called; see collect2
.)
-pie
-s
-static
-shared
-shared-libgcc
-static-libgcc
There are several situations in which an application should use the shared libgcc instead of the static version. The most common of these is when the application wishes to throw and catch exceptions across different shared libraries. In that case, each of the libraries as well as the application itself should use the shared libgcc.
Therefore, the G++ and GCJ drivers automatically add -shared-libgcc whenever you build a shared library or a main executable, because C++ and Java programs typically use exceptions, so this is the right thing to do.
If, instead, you use the GCC driver to create shared libraries, you may find that they will not always be linked with the shared libgcc. If GCC finds, at its configuration time, that you have a non-GNU linker or a GNU linker that does not support option --eh-frame-hdr, it will link the shared version of libgcc into shared libraries by default. Otherwise, it will take advantage of the linker and optimize away the linking with the shared version of libgcc, linking with the static version of libgcc by default. This allows exceptions to propagate through such shared libraries, without incurring relocation costs at library load time.
However, if a library or main executable is supposed to throw or catch
exceptions, you must link it using the G++ or GCJ driver, as appropriate
for the languages used in the program, or using the option
-shared-libgcc, such that it is linked with the shared
libgcc.
-symbolic
-Xlinker
optionIf you want to pass an option that takes an 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.
-Wl,
option-u
symbolThese options specify directories to search for header files, for libraries and for parts of the compiler:
-I
dirIf a standard system include directory, or a directory specified with
-isystem, is also specified with -I, the -I
option will be ignored. The directory will still be 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-
If additional directories are specified with -I options after the -I-, these directories are searched for all `#include' directives. (Ordinarily all -I directories are used this way.)
In addition, the -I- option inhibits the use of the current directory (where the current input file came from) as the first search directory for `#include "file"'. There is no way to override this effect of -I-. With -I. you can specify searching the directory which was current when the compiler was invoked. That is not exactly the same as what the preprocessor does by default, but it is often satisfactory.
-I- does not inhibit the use of the standard system directories
for header files. Thus, -I- and -nostdinc are
independent.
-L
dir-B
prefixThe 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/' (see Target Options).
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 was not specified, the driver tries two standard prefixes, which are /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.
The compiler will check to see if the path provided by the -B refers to a directory, and if necessary it will add 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 includes 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 run-time 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 environment variable GCC_EXEC_PREFIX. See Environment Variables.
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 will be replaced by [dir/]include. This is to help
with boot-strapping the compiler.
-specs=
filegcc is a driver program. It performs its job by invoking a sequence of other programs to do the work of compiling, assembling and linking. GCC interprets its command-line parameters and uses these to deduce which programs it should invoke, and which command-line options it ought to place on their command lines. This behavior is controlled by spec strings. In most cases there is one spec string for each program that GCC can invoke, but a few 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 plaintext 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 and it can be one of the following:
%
command%include <
file>
%include_noerr <
file>
%rename
old_name new_name*[
spec_name]:
[
suffix]:
.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 that follows a suffix directive can be one of the following:
@
language.ZZ: @c++
Says that .ZZ files are, in fact, C++ source files.
#
namename compiler not installed on this system.
GCC already has an extensive list of suffixes built into it. This directive will add 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 program. 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.
%%
%i
%b
%B
%d
%g
suffix%u
suffix%U
suffix%j
suffixHOST_BIT_BUCKET
, if any, and if it is
writable, and if save-temps is off; 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%m
suffixX
}'
construct: see for example f/lang-specs.h.
%.
SUFFIX%w
%o
%O
%p
cpp
.
%P
%I
%s
%e
str%(
name)
%[
name]
%x{
option}
%X
%Y
%Z
%a
asm
spec. This is used to compute the
switches to be passed to the assembler.
%A
asm_final
spec. This is a spec string for
passing switches to an assembler post-processor, if such a program is
needed.
%l
link
spec. This is the spec for computing the
command line passed to the linker. Typically it will make use of the
`%L %G %S %D and %E' sequences.
%D
%M
%L
lib
spec. This is a spec string for deciding which
libraries should be included on the command line to the linker.
%G
libgcc
spec. This is a spec string for deciding
which GCC support library should be included on the command line to the linker.
%S
startfile
spec. This is a spec for deciding which
object files should be the first ones passed to the linker. Typically
this might be a file named crt0.o.
%E
endfile
spec. This is a spec string that specifies
the last object files that will be passed to the linker.
%C
cpp
spec. This is used to construct the arguments
to be passed to the C preprocessor.
%c
signed_char
spec. This is intended to be used
to tell cpp whether a char is signed. It typically has the definition:
%{funsigned-char:-D__CHAR_UNSIGNED__}
%1
cc1
spec. This is used to construct the options to be
passed to the actual C compiler (`cc1').
%2
cc1plus
spec. This is used to construct the options to be
passed to the actual C++ compiler (`cc1plus').
%*
%<S
-S
from the command line. Note—this
command is position dependent. `%' commands in the spec string
before this one will see -S
, `%' commands in the spec string
after this one will not.
%:
function(
args)
The following built-in spec functions are provided:
if-exists
if-exists
spec function takes one argument, an absolute
pathname to a file. If the file exists, if-exists
returns the
pathname. Here is a small example of its usage:
*startfile: crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
if-exists-else
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)
%{S}
-S
switch, if that switch was given to GCC.
If that switch was not specified, this substitutes nothing. Note that
the leading dash is omitted when specifying this option, and it is
automatically inserted if the substitution is performed. Thus the spec
string `%{foo}' would match the command-line option -foo
and would output the command line option -foo.
%W{S}
S
} but mark last argument supplied within as a file to be
deleted on failure.
%{S*}
-S
, but which also take an argument. This is used for
switches like -o, -D, -I, etc.
GCC considers -o foo as being
one switch whose names starts with `o'. %{o*} would substitute this
text, including the space. Thus two arguments would be generated.
%{S*&T*}
S
*}, but preserve order of S
and T
options
(the order of S
and T
in the spec is not significant).
There can be any number of ampersand-separated variables; for each the
wild card is optional. Useful for CPP as `%{D*&U*&A*}'.
%{S:X}
X
, if the `-S' switch was given to GCC.
%{!S:X}
X
, if the `-S' switch was not given to GCC.
%{S*:X}
X
if one or more switches whose names start with
-S
are specified to GCC. Normally X
is substituted only
once, no matter how many such switches appeared. However, if %*
appears somewhere in X
, then X
will be substituted once
for each matching switch, with the %*
replaced by the part of
that switch that matched the *
.
%{.S:X}
X
, if processing a file with suffix S
.
%{!.S:X}
X
, if not processing a file with suffix S
.
%{S|P:X}
X
if either -S
or -P
was given to GCC.
This may be combined with `!', `.', and *
sequences as well,
although they have a stronger binding than the `|'. If %*
appears in X
, all of the alternatives must be starred, and only
the first matching alternative is substituted.
For example, a spec string like this:
%{.c:-foo} %{!.c:-bar} %{.c|d:-baz} %{!.c|d:-boggle}
will output the following command-line options from the following input command-line options:
fred.c -foo -baz jim.d -bar -boggle -d fred.c -foo -baz -boggle -d jim.d -bar -baz -boggle
%{S:X; T:Y; :D}
S
was given to GCC, substitutes X
; else if T
was
given to GCC, substitutes Y
; else substitutes D
. There can
be as many clauses as you need. This may be combined with .
,
!
, |
, and *
as needed.
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.
The usual way to run GCC is to run the executable called gcc, or <machine>-gcc when cross-compiling, or <machine>-gcc-<version> to run a version other than the one that was installed last. Sometimes this is inconvenient, so GCC provides options that will switch to another cross-compiler or version.
-b
machineThe value to use for machine is the same as was specified as the
machine type when configuring GCC as a cross-compiler. For
example, if a cross-compiler was configured with `configure
i386v', meaning to compile for an 80386 running System V, then you
would specify -b i386v to run that cross compiler.
-V
versionThe -V and -b options work by running the <machine>-gcc-<version> executable, so there's no real reason to use them if you can just run that directly.
Earlier we discussed the standard option -b which chooses among different installed compilers for completely different target machines, such as VAX vs. 68000 vs. 80386.
In addition, each of these target machine types can have its own special options, starting with `-m', to choose among various hardware models or configurations—for example, 68010 vs 68020, floating coprocessor or none. A single installed version of the compiler can compile for any model or configuration, according to the options specified.
Some configurations of the compiler also support additional special options, usually for compatibility with other compilers on the same platform.
These options are defined by the macro TARGET_SWITCHES
in the
machine description. The default for the options is also defined by
that macro, which enables you to change the defaults.
These are the `-m' options defined for the 68000 series. The default values for these options depends on which style of 68000 was selected when the compiler was configured; the defaults for the most common choices are given below.
-m68000
-mc68000
Use this option for microcontrollers with a 68000 or EC000 core,
including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
-m68020
-mc68020
-m68881
-m68030
-m68040
This option inhibits the use of 68881/68882 instructions that have to be
emulated by software on the 68040. Use this option if your 68040 does not
have code to emulate those instructions.
-m68060
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
Use this option for microcontrollers with a
CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
68336, 68340, 68341, 68349 and 68360.
-m5200
Use this option for microcontroller with a 5200 core, including
the MCF5202, MCF5203, MCF5204 and MCF5202.
-m68020-40
-m68020-60
-msoft-float
-mshort
int
to be 16 bits wide, like short int
.
-mnobitfield
-mbitfield
-mrtd
rtd
instruction, which pops their arguments while returning. This
saves one instruction in the caller since there is no need to pop
the arguments there.
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 will be generated for calls to those
functions.
In addition, seriously incorrect code will result if you call a function with too many arguments. (Normally, extra arguments are harmlessly ignored.)
The rtd
instruction is supported by the 68010, 68020, 68030,
68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
-malign-int
-mno-align-int
int
, long
, long long
,
float
, double
, and long double
variables on a 32-bit
boundary (-malign-int) or a 16-bit boundary (-mno-align-int).
Aligning variables on 32-bit boundaries produces code that runs somewhat
faster on processors with 32-bit busses at the expense of more memory.
Warning: if you use the -malign-int switch, GCC will
align structures containing the above types differently than
most published application binary interface specifications for the m68k.
-mpcrel
-mno-strict-align
-mstrict-align
-msep-data
-mno-sep-data
-mid-shared-library
-mno-id-shared-library
-mshared-library-id=n
These are the `-m' options defined for the 68hc11 and 68hc12 microcontrollers. The default values for these options depends on which style of microcontroller was selected when the compiler was configured; the defaults for the most common choices are given below.
-m6811
-m68hc11
-m6812
-m68hc12
-m68S12
-m68hcs12
-mauto-incdec
-minmax
-nominmax
-mlong-calls
-mno-long-calls
call
instruction to
call a function and the rtc
instruction for returning.
-mshort
int
to be 16 bits wide, like short int
.
-msoft-reg-count=
countThese `-m' options are defined for the VAX:
-munix
aobleq
and so on)
that the Unix assembler for the VAX cannot handle across long
ranges.
-mgnu
-mg
These `-m' options are supported on the SPARC:
-mno-app-regs
-mapp-regs
To be fully SVR4 ABI compliant at the cost of some performance loss,
specify -mno-app-regs. You should compile libraries and system
software with this option.
-mfpu
-mhard-float
-mno-fpu
-msoft-float
-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 particular, you need to compile libgcc.a, the
library that comes with GCC, with -msoft-float in order for
this to work.
-mhard-quad-float
-msoft-quad-float
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-flat
-mflat
With -mno-flat (the default), the compiler emits save/restore instructions (except for leaf functions) and is the normal mode of operation.
These options are deprecated and will be deleted in a future GCC release.
-mno-unaligned-doubles
-munaligned-doubles
With -munaligned-doubles, GCC assumes that doubles have 8 byte
alignment 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, especially for floating point code.
-mno-faster-structs
-mfaster-structs
ldd
and std
instructions for copies in structure
assignment, in place of twice as many ld
and st
pairs.
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 will not be directly in line with
the rules of the ABI.
-mimpure-text
-mimpure-text suppresses the “relocations remain against allocatable but non-writable sections” linker error message. However, the necessary relocations will trigger copy-on-write, and the shared object is not actually shared across processes. Instead of using -mimpure-text, you should compile all source code with -fpic or -fPIC.
This option is only available on SunOS and Solaris.
-mv8
-msparclite
-mcypress
-msupersparc
-mf930
-mf934
-mcpu=
cpu_typeDefault 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 implementations.
v7: cypress v8: supersparc, hypersparc sparclite: f930, f934, sparclite86x sparclet: tsc701 v9: ultrasparc, ultrasparc3
By default (unless configured otherwise), GCC generates code for the V7 variant of the SPARC architecture. With -mcpu=cypress, the compiler additionally optimizes it for the Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series. This is also appropriate for the older SPARCStation 1, 2, IPX etc.
With -mcpu=v8, GCC generates code for the V8 variant of the SPARC architecture. 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 SPARC-V7. With -mcpu=supersparc, the compiler additionally optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and 2000 series.
With -mcpu=sparclite, GCC generates code for the SPARClite variant of
the SPARC architecture. This adds the integer multiply, integer divide step
and scan (ffs
) instructions which exist in SPARClite but not in SPARC-V7.
With -mcpu=f930, the compiler additionally optimizes it for the
Fujitsu MB86930 chip, which is the original SPARClite, with no FPU. With
-mcpu=f934, the compiler additionally optimizes it for the Fujitsu
MB86934 chip, which is the more recent SPARClite with FPU.
With -mcpu=sparclet, GCC generates code for the SPARClet variant of
the SPARC architecture. This adds the integer multiply, multiply/accumulate,
integer divide step and scan (ffs
) instructions which exist in SPARClet
but not in SPARC-V7. With -mcpu=tsc701, the compiler additionally
optimizes it for the TEMIC SPARClet chip.
With -mcpu=v9, GCC generates code for the V9 variant of the SPARC
architecture. This adds 64-bit integer and floating-point move instructions,
3 additional floating-point condition code registers and conditional move
instructions. With -mcpu=ultrasparc, the compiler additionally
optimizes it for the Sun UltraSPARC I/II chips. With
-mcpu=ultrasparc3, the compiler additionally optimizes it for the
Sun UltraSPARC III chip.
-mtune=
cpu_typeThe same values for -mcpu=cpu_type can be used for
-mtune=cpu_type, but the only useful values are those
that select a particular cpu implementation. Those are `cypress',
`supersparc', `hypersparc', `f930', `f934',
`sparclite86x', `tsc701', `ultrasparc', and
`ultrasparc3'.
-mv8plus
-mno-v8plus
-mvis
-mno-vis
These `-m' options are supported in addition to the above on SPARC-V9 processors in 64-bit environments:
-mlittle-endian
-m32
-m64
-mcmodel=medlow
-mcmodel=medmid
-mcmodel=medany
-mcmodel=embmedany
-mstack-bias
-mno-stack-bias
These switches are supported in addition to the above on Solaris:
-threads
-pthreads
These `-m' options are defined for Advanced RISC Machines (ARM) architectures:
-mapcs-frame
-mapcs
-mapcs-26
This option is deprecated. Future releases of the GCC will only support
generating code that runs in apcs-32 mode.
-mapcs-32
This flag is deprecated. Future releases of GCC will make this flag
unconditional.
-mthumb-interwork
-mno-sched-prolog
-mhard-float
-msoft-float
-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 particular, you need to compile libgcc.a, the
library that comes with GCC, with -msoft-float in order for
this to work.
-mlittle-endian
-mbig-endian
-mwords-little-endian
-malignment-traps
This option has no effect when compiling for ARM architecture 4 or later,
since these processors have instructions to directly access half-word
objects in memory.
-mno-alignment-traps
Note that you cannot use this option to access unaligned word objects, since the processor will only fetch one 32-bit aligned object from memory.
The default setting is -malignment-traps, since this produces code that will also run on processors implementing ARM architecture version 6 or later.
This option is deprecated and will be removed in the next release of GCC.
-mcpu=
name-mtune=
name-march=
name-mfpe=
number-mfp=
number-mstructure-size-boundary=
n-mabort-on-noreturn
abort
at the end of a
noreturn
function. It will be executed if the function tries to
return.
-mlong-calls
-mno-long-calls
Even if this switch is enabled, not all function calls will be turned into long calls. The heuristic is that static functions, functions which have the `short-call' attribute, functions that are inside the scope of a `#pragma no_long_calls' directive and functions whose definitions have already been compiled within the current compilation unit, will not be turned into long calls. The exception to this rule is that weak function definitions, functions with the `long-call' attribute or the `section' attribute, and functions that are within the scope of a `#pragma long_calls' directive, will always be turned into long calls.
This feature is not enabled by default. Specifying
-mno-long-calls will restore the default behavior, as will
placing the function calls within the scope of a `#pragma
long_calls_off' directive. Note these switches have no effect on how
the compiler generates code to handle function calls via function
pointers.
-mnop-fun-dllimport
dllimport
attribute.
-msingle-pic-base
-mpic-register=
reg-mcirrus-fix-invalid-insns
-mpoke-function-name
t0 .ascii "arm_poke_function_name", 0 .align t1 .word 0xff000000 + (t1 - t0) 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
-mtpcs-frame
-mtpcs-leaf-frame
-mcallee-super-interworking
-mcaller-super-interworking
These -m options are defined for Matsushita MN10300 architectures:
-mmult-bug
-mno-mult-bug
-mam33
-mno-am33
-mno-crt0
-mrelax
This option makes symbolic debugging impossible.
These -m options are defined for Renesas M32R/D architectures:
-m32r2
-m32rx
-m32r
-mmodel=small
ld24
instruction), and assume all subroutines
are reachable with the bl
instruction.
This is the default.
The addressability of a particular object can be set with the
model
attribute.
-mmodel=medium
seth/add3
instructions to load their addresses), and
assume all subroutines are reachable with the bl
instruction.
-mmodel=large
seth/add3
instructions to load their addresses), and
assume subroutines may not be reachable with the bl
instruction
(the compiler will generate the much slower seth/add3/jl
instruction sequence).
-msdata=none
section
attribute has been specified).
This is the default.
The small data area consists of sections `.sdata' and `.sbss'.
Objects may be explicitly put in the small data area with the
section
attribute using one of these sections.
-msdata=sdata
-msdata=use
-G
numAll 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 will give an error message—incorrect code will not be
generated.
-mdebug
-malign-loops
-mno-align-loops
-missue-rate=
number-mbranch-cost=
number-mflush-trap=
number-mno-flush-trap
-mflush-func=
name-mno-flush-func
These `-m' options are defined for the IBM RS/6000 and PowerPC:
-mpower
-mno-power
-mpower2
-mno-power2
-mpowerpc
-mno-powerpc
-mpowerpc-gpopt
-mno-powerpc-gpopt
-mpowerpc-gfxopt
-mno-powerpc-gfxopt
-mpowerpc64
-mno-powerpc64
Neither architecture is a subset of the other. However there is a large common subset of instructions supported by both. An MQ register is included in processors supporting the POWER architecture.
You use these options to specify which instructions are available on the processor you are using. The default value of these options is determined when configuring GCC. Specifying the -mcpu=cpu_type overrides the specification of these options. We recommend you use the -mcpu=cpu_type option rather than the options listed above.
The -mpower option allows GCC to generate instructions that are found only in the POWER architecture and to use the MQ register. Specifying -mpower2 implies -power and also allows GCC to generate instructions that are present in the POWER2 architecture but not the original POWER architecture.
The -mpowerpc option allows GCC to generate instructions that are found only in the 32-bit subset of the PowerPC architecture. Specifying -mpowerpc-gpopt implies -mpowerpc and also allows GCC to use the optional PowerPC architecture instructions in the General Purpose group, including floating-point square root. Specifying -mpowerpc-gfxopt implies -mpowerpc and also allows GCC to use the optional PowerPC architecture instructions in the Graphics group, including floating-point select.
The -mpowerpc64 option allows GCC to generate the additional 64-bit instructions that are found in the full PowerPC64 architecture and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to -mno-powerpc64.
If you specify both -mno-power and -mno-powerpc, GCC
will use only the instructions in the common subset of both
architectures plus some special AIX common-mode calls, and will not use
the MQ register. Specifying both -mpower and -mpowerpc
permits GCC to use any instruction from either architecture and to
allow use of the MQ register; specify this for the Motorola MPC601.
-mnew-mnemonics
-mold-mnemonics
GCC defaults to the mnemonics appropriate for the architecture in
use. Specifying -mcpu=cpu_type sometimes overrides the
value of these option. Unless you are building a cross-compiler, you
should normally not specify either -mnew-mnemonics or
-mold-mnemonics, but should instead accept the default.
-mcpu=
cpu_type-mcpu=common selects a completely generic processor. Code generated under this option will run on any POWER or PowerPC processor. GCC will use only the instructions in the common subset of both architectures, and will not use the MQ register. GCC assumes a generic processor model for scheduling purposes.
-mcpu=power, -mcpu=power2, -mcpu=powerpc, and -mcpu=powerpc64 specify generic POWER, POWER2, pure 32-bit PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine types, with an appropriate, generic processor model assumed for scheduling purposes.
The other options specify a specific processor. Code generated under those options will run best on that processor, and may not run at all on others.
The -mcpu options automatically enable or disable the following options: -maltivec, -mhard-float, -mmfcrf, -mmultiple, -mnew-mnemonics, -mpower, -mpower2, -mpowerpc64, -mpowerpc-gpopt, -mpowerpc-gfxopt, -mstring. The particular options set for any particular CPU will vary between compiler versions, depending on what setting seems to produce optimal code for that CPU; it doesn't necessarily reflect the actual hardware's capabilities. If you wish to set an individual option to a particular value, you may specify it after the -mcpu option, like `-mcpu=970 -mno-altivec'.
On AIX, the -maltivec and -mpowerpc64 options are
not enabled or disabled by the -mcpu option at present, since
AIX does not have full support for these options. You may still
enable or disable them individually if you're sure it'll work in your
environment.
-mtune=
cpu_type-maltivec
-mno-altivec
-mabi=spe
-mabi=no-spe
-misel=
yes/no-misel
-mspe=
yes/no-mspe
-mfloat-gprs=
yes/no-mfloat-gprs
-mfull-toc
-mno-fp-in-toc
-mno-sum-in-toc
-mminimal-toc
If you receive a linker error message that saying you have overflowed the available 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.
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 will produce 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
long
type, and the infrastructure needed to support them.
Specifying -maix64 implies -mpowerpc64 and
-mpowerpc, while -maix32 disables the 64-bit ABI and
implies -mno-powerpc64. GCC defaults to -maix32.
-mxl-compat
-mno-xl-compat
The AIX calling convention was extended but not initially documented to
handle an obscure K&R C case of calling a function that takes the
address of its arguments with fewer arguments than declared. AIX XL
compilers access floating point arguments which 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 AIX
XL compilers without optimization.
-mpe
-malign-natural
-malign-power
-msoft-float
-mhard-float
-mmultiple
-mno-multiple
-mstring
-mno-string
-mupdate
-mno-update
-mfused-madd
-mno-fused-madd
-mno-bit-align
-mbit-align
For example, by default a structure containing nothing but 8
unsigned
bit-fields of length 1 would be aligned to a 4 byte
boundary and have a size of 4 bytes. By using -mno-bit-align,
the structure would be aligned to a 1 byte boundary and be one byte in
size.
-mno-strict-align
-mstrict-align
-mrelocatable
-mno-relocatable
-mrelocatable-lib
-mno-relocatable-lib
-mno-toc
-mtoc
-mlittle
-mlittle-endian
-mbig
-mbig-endian
-mdynamic-no-pic
-mprioritize-restricted-insns=
priority-msched-costly-dep=
dependence_type-minsert-sched-nops=
scheme-mcall-sysv
-mcall-sysv-eabi
-mcall-sysv-noeabi
-mcall-solaris
-mcall-linux
-mcall-gnu
-mcall-netbsd
-maix-struct-return
-msvr4-struct-return
-mabi=altivec
-mabi=no-altivec
-mprototype
-mno-prototype
-msim
-mmvme
-mads
-myellowknife
-mvxworks
-mwindiss
-memb
-meabi
-mno-eabi
__eabi
is called to from main
to set up the eabi
environment, and the -msdata option can use both r2
and
r13
to point to two separate small data areas. Selecting
-mno-eabi means that the stack is aligned to a 16 byte boundary,
do not call an initialization function from main
, and the
-msdata option will only use r13
to point to a single
small data area. The -meabi option is on by default if you
configured GCC using one of the `powerpc*-*-eabi*' options.
-msdata=eabi
const
global and static data in the `.sdata2' section, which
is pointed to by register r2
. Put small initialized
non-const
global and static data in the `.sdata' section,
which is pointed to by register r13
. Put small uninitialized
global and static data in the `.sbss' section, which is adjacent to
the `.sdata' section. The -msdata=eabi option is
incompatible with the -mrelocatable option. The
-msdata=eabi option also sets the -memb option.
-msdata=sysv
r13
. Put small uninitialized global and static data in the
`.sbss' section, which is adjacent to the `.sdata' section.
The -msdata=sysv option is incompatible with the
-mrelocatable option.
-msdata=default
-msdata
-msdata-data
r13
to address small data however. This is the default behavior unless
other -msdata options are used.
-msdata=none
-mno-sdata
-G
num-mregnames
-mno-regnames
-mlongcall
-mno-longcall
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 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, we may cause GCC to ignore all longcall specifications
when the linker is known to generate glue.
-pthread
Use this on MirOS to compile and link threaded code, isolating the program from operating system details.
These options are defined for all architectures running the Darwin operating system. They are useful for compatibility with other Mac OS compilers.
-all_load
-arch_errors_fatal
-bind_at_load
-bundle
-bundle_loader
executable-allowable_client
client_name-arch_only
-client_name
-compatibility_version
-current_version
-dependency-file
-dylib_file
-dylinker_install_name
-dynamic
-dynamiclib
-exported_symbols_list
-filelist
-flat_namespace
-force_cpusubtype_ALL
-force_flat_namespace
-headerpad_max_install_names
-image_base
-init
-install_name
-keep_private_externs
-multi_module
-multiply_defined
-multiply_defined_unused
-noall_load
-nofixprebinding
-nomultidefs
-noprebind
-noseglinkedit
-pagezero_size
-prebind
-prebind_all_twolevel_modules
-private_bundle
-read_only_relocs
-sectalign
-sectobjectsymbols
-whyload
-seg1addr
-sectcreate
-sectobjectsymbols
-sectorder
-seg_addr_table
-seg_addr_table_filename
-seglinkedit
-segprot
-segs_read_only_addr
-segs_read_write_addr
-single_module
-static
-sub_library
-sub_umbrella
-twolevel_namespace
-umbrella
-undefined
-unexported_symbols_list
-weak_reference_mismatches
-whatsloaded
-EB
-EL
-march=
archIn processor names, a final `000' can be abbreviated as `k' (for example, `-march=r2k'). Prefixes are optional, and `vr' may be written `r'.
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' will set `_MIPS_ARCH' to `"r2000"' and define the macro `_MIPS_ARCH_R2000'.
Note that the `_MIPS_ARCH' macro uses the processor names given
above. In other words, it will have the full prefix and will 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.
-mtune=
archWhen this option is not used, GCC will optimize for the processor specified by -march. By using -march and -mtune together, it is possible to generate code that will run 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
-mips2
-mips3
-mips4
-mips32
-mips32r2
-mips64
-mips16
-mno-mips16
-mabi=32
-mabi=o64
-mabi=n32
-mabi=64
-mabi=eabi
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.
-mabicalls
-mno-abicalls
-mxgot
-mno-xgot
GCC normally uses a single instruction to load values from the GOT. While this is relatively efficient, it will only work if the GOT is smaller than about 64k. Anything larger will cause 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. It should then work with very large GOTs, although it will also be less efficient, since it will take 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.
-membedded-pic
-mno-embedded-pic
-mgp32
-mgp64
-mfp32
-mfp64
-mhard-float
-msoft-float
-msingle-float
-mdouble-float
-mint64
int
and long
types to be 64 bits wide. See
-mlong32 for an explanation of the default and the way
that the pointer size is determined.
-mlong64
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
long
, int
, and pointer types to be 32 bits wide.
The default size of int
s, long
s and pointers depends on
the ABI. All the supported ABIs use 32-bit int
s. The n64 ABI
uses 64-bit long
s, as does the 64-bit EABI; the others use
32-bit long
s. Pointers are the same size as long
s,
or the same size as integer registers, whichever is smaller.
-G
numAll modules should be compiled with the same -G num
value.
-membedded-data
-mno-embedded-data
-muninit-const-in-rodata
-mno-uninit-const-in-rodata
const
variables in the read-only data section.
This option is only meaningful in conjunction with -membedded-data.
-msplit-addresses
-mno-split-addresses
%hi()
and %lo()
assembler
relocation operators. This option has been superceded by
-mexplicit-relocs but is retained for backwards compatibility.
-mexplicit-relocs
-mno-explicit-relocs
-mexplicit-relocs is usually the default if GCC was configured to use an assembler that supports relocation operators. However, there are two exceptions:
-mrnames
-mno-rnames
-mcheck-zero-division
-mno-check-zero-division
-mmemcpy
-mno-memcpy
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
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.
-mmad
-mno-mad
mad
, madu
and mul
instructions, as provided by the R4650 ISA.
-mfused-madd
-mno-fused-madd
When multiply-accumulate instructions are used, the intermediate
product is calculated to infinite precision and is not subject to
the FCSR Flush to Zero bit. This may be undesirable in some
circumstances.
-nocpp
-mfix-sb1
-mno-fix-sb1
-mflush-func=
func-mno-flush-func
_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-likely
-mno-branch-likely
These `-m' options are defined for the i386 and x86-64 family of computers:
-mtune=
cpu-typeWhile picking a specific cpu-type will schedule things appropriately
for that particular chip, the compiler will not generate any code that
does not run on the i386 without the -march=cpu-type option
being used.
-march=
cpu-type-mcpu=
cpu-type-m386
-m486
-mpentium
-mpentiumpro
-mfpmath=
unitThis is the default choice for i386 compiler.
For i387 you need to use -march=cpu-type, -msse or -msse2 switches to enable SSE extensions and make this option effective. For x86-64 compiler, these extensions are enabled by default.
The resulting code should be considerably faster in the majority of cases and avoid the numerical instability problems of 387 code, but may break some existing code that expects temporaries to be 80bit.
This is the default choice for the x86-64 compiler.
-masm=
dialect-mieee-fp
-mno-ieee-fp
-msoft-float
On machines where a function returns floating point results in the 80387
register stack, some floating point opcodes may be emitted even if
-msoft-float is used.
-mno-fp-ret-in-387
The usual calling convention has functions return values of types
float
and double
in an FPU register, even if there
is no FPU. The idea is that the operating system should emulate
an FPU.
The option -mno-fp-ret-in-387 causes such values to be returned
in ordinary CPU registers instead.
-mno-fancy-math-387
sin
, cos
and
sqrt
instructions for the 387. Specify this option to avoid
generating those instructions. This option is the default on FreeBSD,
OpenBSD and NetBSD. This option is overridden when -march
indicates that the target cpu will always have an FPU and so the
instruction will not need emulation. As of revision 2.6.1, these
instructions are not generated unless you also use the
-funsafe-math-optimizations switch.
-malign-double
-mno-align-double
double
, long double
, and
long long
variables on a two word boundary or a one word
boundary. Aligning double
variables on a two word boundary will
produce code that runs somewhat faster on a `Pentium' at the
expense of more memory.
Warning: if you use the -malign-double switch,
structures containing the above types will be aligned differently than
the published application binary interface specifications for the 386
and will not be binary compatible with structures in code compiled
without that switch.
-m96bit-long-double
-m128bit-long-double
long double
type. The i386
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) would prefer long double
to be aligned to an 8 or 16 byte boundary. In arrays or structures
conforming to the ABI, this would not be possible. So specifying a
-m128bit-long-double will align 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 to be 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, the
structures and arrays containing long double
variables will change
their size as well as function calling convention for function taking
long double
will be modified. Hence they will not be binary
compatible with arrays or structures in code compiled without that switch.
-msvr3-shlib
-mno-svr3-shlib
bss
or data
segments. -msvr3-shlib places them
into bss
. These options are meaningful only on System V Release 3.
-mrtd
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 Function Attributes.
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 will be generated for calls to those
functions.
In addition, seriously incorrect code will result if you call a
function with too many arguments. (Normally, extra arguments are
harmlessly ignored.)
-mregparm=
numWarning: 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.
-mpreferred-stack-boundary=
numOn Pentium and PentiumPro, 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
suffers similar
penalties if it is not 16 byte aligned.
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 will most likely misalign 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
-mno-mmx
-msse
-mno-sse
-msse2
-mno-sse2
-msse3
-mno-sse3
-m3dnow
-mno-3dnow
See X86 Built-in Functions, for details of the functions enabled and disabled by these switches.
To have SSE/SSE2 instructions generated automatically from floating-point
code, see -mfpmath=sse.
-mpush-args
-mno-push-args
-maccumulate-outgoing-args
-mthreads
-mno-align-stringops
-minline-all-stringops
-momit-leaf-frame-pointer
-mtls-direct-seg-refs
-mno-tls-direct-seg-refs
%gs
for 32-bit, %fs
for 64-bit),
or whether the thread base pointer must be added. Whether or not this
is legal depends on the operating system, and whether it maps the
segment to cover the entire TLS area.
For systems that use GNU libc, the default is on.
These `-m' switches are supported in addition to the above on AMD x86-64 processors in 64-bit environments.
-m32
-m64
-mno-red-zone
-mcmodel=small
-mcmodel=kernel
-mcmodel=medium
-mcmodel=large
These `-m' options are defined for the HPPA family of computers:
-march=
architecture-typePA 2.0 support currently requires gas snapshot 19990413 or later. The
next release of binutils (current is 2.9.1) will probably contain PA 2.0
support.
-mpa-risc-1-0
-mpa-risc-1-1
-mpa-risc-2-0
-mbig-switch
-mjump-in-delay
-mdisable-fpregs
-mdisable-indexing
-mno-space-regs
Such code is suitable for level 0 PA systems and kernels.
-mfast-indirect-calls
This option will not work in the presence of shared libraries or nested
functions.
-mlong-load-store
-mportable-runtime
-mgas
-mschedule=
cpu-type-mlinker-opt
-msoft-float
-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 particular, you need to compile libgcc.a, the
library that comes with GCC, with -msoft-float in order for
this to work.
-msio
_SIO
, for server IO. The default is
-mwsio. This generates the predefines, __hp9000s700
,
__hp9000s700__
and _WSIO
, for workstation IO. These
options are available under HP-UX and HI-UX.
-mgnu-ld
-mhp-ld
-mlong-calls
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 will degrade performance. However, 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.
-nolibdld
-static
On HP-UX 10 and later, the GCC driver adds the necessary options to
link with libdld.sl when the -static option is specified.
This causes the resulting binary to be dynamic. On the 64-bit port,
the linkers generate dynamic binaries by default in any case. The
-nolibdld option can be used to prevent the GCC driver from
adding these link options.
-threads
These `-m' options are defined for the Intel 960 implementations:
-m
cpu-type-mnumerics
-msoft-float
-mleaf-procedures
-mno-leaf-procedures
bal
instruction as well as call
. This will result in more
efficient code for explicit calls when the bal
instruction can be
substituted by the assembler or linker, but less efficient code in other
cases, such as calls via function pointers, or using a linker that doesn't
support this optimization.
-mtail-call
-mno-tail-call
-mcomplex-addr
-mno-complex-addr
-mcode-align
-mno-code-align
-mic-compat
-mic2.0-compat
-mic3.0-compat
-masm-compat
-mintel-asm
-mstrict-align
-mno-strict-align
-mold-align
-mlong-double-64
These `-m' options are defined for the DEC Alpha implementations:
-mno-soft-float
-msoft-float
Note that Alpha implementations without floating-point operations are
required to have floating-point registers.
-mfp-reg
-mno-fp-regs
$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
_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.
-mieee-with-inexact
_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 specify this option. Other Alpha compilers call this
option -ieee_with_inexact.
-mfp-trap-mode=
trap-mode-mfp-rounding-mode=
rounding-mode-mtrap-precision=
trap-precisionOther Alpha compilers provide the equivalent options called
-scope_safe and -resumption_safe.
-mieee-conformant
-mbuild-constants
Use this option to require GCC to construct all integer constants using code, even if it takes more instructions (the maximum is six).
You would 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.
-malpha-as
-mgas
-mbwx
-mno-bwx
-mcix
-mno-cix
-mfix
-mno-fix
-mmax
-mno-max
-mfloat-vax
-mfloat-ieee
-mexplicit-relocs
-mno-explicit-relocs
-msmall-data
-mlarge-data
.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
$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_typeSupported values for cpu_type are
-mtune=
cpu_type-mmemory-latency=
timeValid options for time are
These `-m' options are defined for the DEC Alpha/VMS implementations:
-mvms-return-codes
These `-m' options are defined for the H8/300 implementations:
-mrelax
ld
and the H8/300, for a fuller description.
-mh
-ms
-mn
-ms2600
-mint32
int
data 32 bits by default.
-malign-300
These `-m' options are defined for the SH implementations:
-m1
-m2
-m2e
-m3
-m3e
-m4-nofpu
-m4-single-only
-m4-single
-m4
-mb
-ml
-mdalign
-mrelax
-mbigtable
switch
tables. The default is to use
16-bit offsets.
-mfmovd
fmovd
.
-mhitachi
-mnomacsave
MAC
register as call-clobbered, even if
-mhitachi is given.
-mieee
-misize
-mpadstruct
-mspace
-mprefergot
-musermode
sh-*-linux*
.
These additional options are available on System V Release 4 for compatibility with other compilers on those systems:
-G
-Qy
.ident
assembler directive in the output.
-Qn
.ident
directives to the output file (this is
the default).
-YP,
dirs-Ym,
dirThese `-m' options are defined for TMS320C3x/C4x implementations:
-mcpu=
cpu_type-mbig-memory
-mbig
-msmall-memory
-msmall
-mbk
-mno-bk
-mdb
-mno-db
-mdp-isr-reload
-mparanoid
-mmpyi
-mno-mpyi
-mfast-fix
-mno-fast-fix
-mrptb
-mno-rptb
-mrpts=
count-mno-rpts
-mloop-unsigned
-mno-loop-unsigned
-mti
-mregparm
-mmemparm
-mparallel-insns
-mno-parallel-insns
-mparallel-mpy
-mno-parallel-mpy
These `-m' options are defined for V850 implementations:
-mlong-calls
-mno-long-calls
-mno-ep
-mep
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
-mspace
-mtda=
nep
points to. The tiny data
area can hold up to 256 bytes in total (128 bytes for byte references).
-msda=
ngp
points to. The small data
area can hold up to 64 kilobytes.
-mzda=
n-mv850
-mbig-switch
-mapp-regs
-mno-app-regs
-mv850e1
-mv850e
If neither -mv850 nor -mv850e nor -mv850e1 are defined then a default target processor will be chosen and the relevant `__v850*__' preprocessor constant will be defined.
The preprocessor constants `__v850' and `__v851__' are always
defined, regardless of which processor variant is the target.
-mdisable-callt
These options are defined for ARC implementations:
-EL
-EB
-mmangle-cpu
-mcpu=
cpu-mtext=
text-section-mdata=
data-section-mrodata=
readonly-data-sectionsection
attribute.
See Variable Attributes.
These are the `-m' options defined for the 32000 series. The default values for these options depends on which style of 32000 was selected when the compiler was configured; the defaults for the most common choices are given below.
-m32032
-m32032
-m32332
-m32332
-m32532
-m32532
-m32081
-m32381
-mmulti-add
polyF
and dotF
. This option is only available if the -m32381
option is in effect. Using these instructions requires changes to
register allocation which generally has a negative impact on
performance. This option should only be enabled when compiling code
particularly likely to make heavy use of multiply-add instructions.
-mnomulti-add
polyF
and dotF
. This is the default on all platforms.
-msoft-float
-mieee-compare
-mno-ieee-compare
-mnobitfield
-mbitfield
-mrtd
ret
instruction.
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 will be generated for calls to those
functions.
In addition, seriously incorrect code will result if you call a function with too many arguments. (Normally, extra arguments are harmlessly ignored.)
This option takes its name from the 680x0 rtd
instruction.
-mregparam
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.
-mnoregparam
-msb
-mnosb
-mhimem
-mnohimem
These options are defined for AVR implementations:
-mmcu=
mcuInstruction set avr1 is for the minimal AVR core, not supported by the C compiler, only for assembler programs (MCU types: at90s1200, attiny10, attiny11, attiny12, attiny15, attiny28).
Instruction set avr2 (default) is for the classic AVR core with up to 8K program memory space (MCU types: at90s2313, at90s2323, attiny22, at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515, at90c8534, at90s8535).
Instruction set avr3 is for the classic AVR core with up to 128K program memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
Instruction set avr4 is for the enhanced AVR core with up to 8K program memory space (MCU types: atmega8, atmega83, atmega85).
Instruction set avr5 is for the enhanced AVR core with up to 128K program
memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
atmega64, atmega128, at43usb355, at94k).
-msize
-minit-stack=
N-mno-interrupts
-mcall-prologues
-mno-tablejump
-mtiny-stack
These are the `-m' options defined for the Motorola M*Core processors.
-mhardlit
-mno-hardlit
-mdiv
-mno-div
-mrelax-immediate
-mno-relax-immediate
-mwide-bitfields
-mno-wide-bitfields
-m4byte-functions
-mno-4byte-functions
-mcallgraph-data
-mno-callgraph-data
-mslow-bytes
-mno-slow-bytes
-mlittle-endian
-mbig-endian
-m210
-m340
These are the `-m' options defined for the Intel IA-64 architecture.
-mbig-endian
-mlittle-endian
-mgnu-as
-mno-gnu-as
-mgnu-ld
-mno-gnu-ld
-mno-pic
-mvolatile-asm-stop
-mno-volatile-asm-stop
-mb-step
-mregister-names
-mno-register-names
-mno-sdata
-msdata
-mconstant-gp
-mauto-pic
-minline-float-divide-min-latency
-minline-float-divide-max-throughput
-minline-int-divide-min-latency
-minline-int-divide-max-throughput
-minline-sqrt-min-latency
-minline-sqrt-max-throughput
-mno-dwarf2-asm
-mdwarf2-asm
-mearly-stop-bits
-mno-early-stop-bits
-mfixed-range=
register-range-mtls-size=
tls-size-mtune=
cpu-type-mt
-pthread
-milp32
-mlp64
These `-m' options are defined for D30V implementations:
-mextmem
0x80000000
.
-mextmemory
-monchip
0x0
. Also link `.data', `.bss',
`.strings', `.rodata', `.rodata1', `.data1' sections
into onchip data memory, which starts at location 0x20000000
.
-mno-asm-optimize
-masm-optimize
-mbranch-cost=
n-mcond-exec=
nThese are the `-m' options defined for the S/390 and zSeries architecture.
-mhard-float
-msoft-float
-mbackchain
-mno-backchain
-msmall-exec
-mno-small-exec
bras
instruction
to do subroutine calls.
This only works reliably if the total executable size does not
exceed 64k. The default is to use the basr
instruction instead,
which does not have this limitation.
-m64
-m31
-mzarch
-mesa
-mmvcle
-mno-mvcle
mvcle
instruction
to perform block moves. When -mno-mvcle is specified,
use a mvc
loop instead. This is the default.
-mdebug
-mno-debug
-march=
cpu-type-mtune=
cpu-type-mfused-madd
-mno-fused-madd
These options are defined specifically for the CRIS ports.
-march=
architecture-type-mcpu=
architecture-type-mtune=
architecture-type-mmax-stack-frame=
n-melinux-stacksize=
n-metrax4
-metrax100
-mmul-bug-workaround
-mno-mul-bug-workaround
muls
and mulu
instructions for CPU
models where it applies. This option is active by default.
-mpdebug
-mcc-init
-mno-side-effects
-mstack-align
-mno-stack-align
-mdata-align
-mno-data-align
-mconst-align
-mno-const-align
-m32-bit
-m16-bit
-m8-bit
-mno-prologue-epilogue
-mprologue-epilogue
-mno-gotplt
-mgotplt
-maout
-melf
-melinux
-mlinux
-sim
-sim2
These options are defined for the MMIX:
-mlibfuncs
-mno-libfuncs
-mepsilon
-mno-epsilon
rE
epsilon register.
-mabi=mmixware
-mabi=gnu
$0
and up, as opposed to
the GNU ABI which uses global registers $231
and up.
-mzero-extend
-mno-zero-extend
-mknuthdiv
-mno-knuthdiv
-mtoplevel-symbols
-mno-toplevel-symbols
PREFIX
assembly directive.
-melf
-mbranch-predict
-mno-branch-predict
-mbase-addresses
-mno-base-addresses
-msingle-exit
-mno-single-exit
These options are defined for the PDP-11:
-mfpu
-msoft-float
-mac0
-mno-ac0
-m40
-m45
-m10
-mbcopy-builtin
movstrhi
patterns for copying memory. This is the
default.
-mbcopy
movstrhi
patterns for copying memory.
-mint16
-mno-int32
int
. This is the default.
-mint32
-mno-int16
int
.
-mfloat64
-mno-float32
float
. This is the default.
-mfloat32
-mno-float64
float
.
-mabshi
abshi2
pattern. This is the default.
-mno-abshi
abshi2
pattern.
-mbranch-expensive
-mbranch-cheap
-msplit
-mno-split
-munix-asm
-mdec-asm
These options are defined for Xstormy16:
-msim
-mgpr-32
-mgpr-64
-mfpr-32
-mfpr-64
-mhard-float
-msoft-float
-malloc-cc
-mfixed-cc
icc0
and fcc0
.
-mdword
-mno-dword
-mdouble
-mno-double
-mmedia
-mno-media
-mmuladd
-mno-muladd
-mlibrary-pic
-macc-4
-macc-8
-mpack
-mno-pack
-mno-eflags
-mcond-move
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-mno-cond-move
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-mscc
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-mno-scc
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-mcond-exec
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-mno-cond-exec
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-mvliw-branch
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-mno-vliw-branch
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-mmulti-cond-exec
&&
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
&&
and ||
in conditional execution.
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-mnested-cond-exec
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-mno-nested-cond-exec
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-mtomcat-stats
-mcpu=
cpuThese options are supported for Xtensa targets:
-mconst16
-mno-const16
CONST16
instructions for loading
constant values. The CONST16
instruction is currently not a
standard option from Tensilica. When enabled, CONST16
instructions are always used in place of the standard L32R
instructions. The use of CONST16
is enabled by default only if
the L32R
instruction is not available.
-mfused-madd
-mno-fused-madd
-mtext-section-literals
-mno-text-section-literals
-mtarget-align
-mno-target-align
LOOP
, which the
assembler will always align, either by widening density instructions or
by inserting no-op instructions.
-mlongcalls
-mno-longcalls
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 will still show direct call
instructions—look at the disassembled object code to see the actual
instructions. Note that the assembler will use an indirect call for
every cross-file call, not just those that really will be out of range.
These machine-independent options control the interface conventions used in code generation.
Most of them have both positive and negative forms; the negative form of -ffoo would be -fno-foo. In the table below, only one of the forms is listed—the one which is not the default. You can figure out the other form by either removing `no-' or adding it.
-fbounds-check
-ftrapv
-fwrapv
-fexceptions
-fnon-call-exceptions
SIGALRM
.
-funwind-tables
-fasynchronous-unwind-tables
-fpcc-struct-return
struct
and union
values in memory like
longer ones, rather than in registers. This convention is less
efficient, but it has the advantage of allowing intercallability between
GCC-compiled files and files compiled with other compilers, particularly
the Portable C Compiler (pcc).
The precise convention for returning structures in memory depends on the target configuration macros.
Short structures and unions are those whose size and alignment match that of some integer type.
Warning: code compiled with the -fpcc-struct-return
switch is not binary compatible with code compiled with the
-freg-struct-return switch.
Use it to conform to a non-default application binary interface.
-freg-struct-return
struct
and union
values in registers when possible.
This is more efficient for small structures than
-fpcc-struct-return.
If you specify neither -fpcc-struct-return nor -freg-struct-return, GCC defaults to whichever convention is standard for the target. If there is no standard convention, GCC defaults to -fpcc-struct-return, except on targets where GCC is the principal compiler. In those cases, we can choose the standard, and we chose the more efficient register return alternative.
Warning: code compiled with the -freg-struct-return
switch is not binary compatible with code compiled with the
-fpcc-struct-return switch.
Use it to conform to a non-default application binary interface.
-fshort-enums
enum
type only as many bytes as it needs for the
declared range of possible values. Specifically, the enum
type
will be equivalent to the smallest integer type which has enough room.
Warning: the -fshort-enums 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.
-fshort-double
double
as for float
.
Warning: the -fshort-double 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.
-fshort-wchar
Warning: the -fshort-wchar 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.
-fshared-data
const
variables of this
compilation be shared data rather than private data. The distinction
makes sense only on certain operating systems, where shared data is
shared between processes running the same program, while private data
exists in one copy per process.
-fno-common
extern
) in
two different compilations, you will get an error when you link them.
The only reason this might be useful is if you wish to verify that the
program will work on other systems which always work this way.
-fident
-fno-ident
-finhibit-size-directive
.size
assembler directive, or anything else that
would cause trouble if the function is split in the middle, and the
two halves are placed at locations far apart in memory. This option is
used when compiling crtstuff.c; you should not need to use it
for anything else.
-fverbose-asm
-fno-verbose-asm, the default, causes the
extra information to be omitted and is useful when comparing two assembler
files.
-fpic
Position-independent code requires special support, and therefore works
only on certain machines. For the 386, GCC supports PIC for System V
but not for the Sun 386i. Code generated for the IBM RS/6000 is always
position-independent.
-fPIC
Position-independent code requires special support, and therefore works
only on certain machines.
-fpie
-fPIE
-ffixed-
regreg 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 description macro file.
This flag does not have a negative form, because it specifies a
three-way choice.
-fcall-used-
regIt is an error to used 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 will produce disastrous results.
This flag does not have a negative form, because it specifies a
three-way choice.
-fcall-saved-
regIt is an error to used 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 will produce disastrous results.
A different sort of disaster will result 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
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.
-finstrument-functions
__builtin_return_address
does not work beyond the current
function, so the call site information may not be available to the
profiling functions otherwise.)
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 currently disables function inlining. This restriction is expected to be removed in future releases.
A function may be given the attribute no_instrument_function
, in
which case this instrumentation will not be 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).
-fstack-check
Note that this switch does not actually cause checking to be done; the
operating system must do that. The switch causes generation of code
to ensure that the operating system sees the stack being extended.
-fstack-limit-register=
reg-fstack-limit-symbol=
sym-fno-stack-limit
For instance, if the stack starts at absolute address `0x80000000'
and grows downwards, you can use the flags
-fstack-limit-symbol=__stack_limit and
-Wl,--defsym,__stack_limit=0x7ffe0000 to enforce a stack limit
of 128KB. Note that this may only work with the GNU linker.
-fstack-protector
-fstack-protector-all
Stack consistency checks at run time are added by this extension as well, in order to detect stack overflows, and it will attempt to report the problem in the system logs by calling syslog(3) with a LOG_CRIT priority message: "stack overflow in function XXX", and abort the faulting process.
Note that the stack protector relies on some support code in libc. Stand-alone programs not linked against libc must either provide their own support bits, or disable SSP.
On MirOS, stack-protector-all is the default.
The ProPolice home page is at
http://researchweb.watson.ibm.com/trl/projects/security/ssp/.
-ftrampolines
On most MirOS architectures, trampoline code marks the smallest possible area around the trampoline stub executable using mprotect(2), since the stack area is by default non-executable.
-fargument-alias
-fargument-noalias
-fargument-noalias-global
-fargument-alias specifies that arguments (parameters) may
alias each other and may alias global storage.
-fargument-noalias specifies that arguments do not alias
each other, but may alias global storage.
-fargument-noalias-global specifies that arguments do not
alias each other and do not alias global storage.
Each language will automatically use whatever option is required by
the language standard. You should not need to use these options yourself.
-fleading-underscore
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=
modelglobal-dynamic
,
local-dynamic
, initial-exec
or local-exec
.
The default without -fpic is initial-exec
; with
-fpic the default is global-dynamic
.
This section describes several environment variables that affect how GCC operates. Some of them work by specifying directories or prefixes to use when searching for various kinds of files. Some are used to specify other aspects of the compilation environment.
Note that you can also specify places to search using options such as -B, -I and -L (see Directory Options). These take precedence over places specified using environment variables, which in turn take precedence over those specified by the configuration of GCC. See Controlling the Compilation Driver gcc.
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 would otherwise be interpreted as a string end or escape.
The LC_MESSAGES environment variable specifies the language to use in diagnostic 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.
If GCC_EXEC_PREFIX is not set, GCC will attempt to figure out an appropriate prefix to use based on the pathname it was 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 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 to produce an
alternate directory name. Thus, with -Bfoo/, GCC will search
foo/bar where it would normally search /usr/local/lib/bar.
These alternate directories are searched first; the standard directories
come next.
If LANG is not defined, or if it has some other value, then the compiler will use mblen and mbtowc as defined by the default locale to recognize and translate multibyte characters.
Some additional environments variables affect the behavior of the preprocessor.
PATH_SEPARATOR
, is target-dependent and
determined at GCC build time. For Microsoft 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 particular 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'.
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 Preprocessor Options),
with an optional -MT switch too.
Often large projects have many header files that are included in every source file. The time the compiler takes to process these header files over and over again can account for nearly all of the time required to build the project. To make builds faster, GCC allows users to `precompile' a header file; then, if builds can use the precompiled header file they will be much faster.
Caution: There are a few known situations where GCC will crash when trying to use a precompiled header. If you have trouble with a precompiled header, you should remove the precompiled header and compile without it. In addition, please use GCC's on-line defect-tracking system to report any problems you encounter with precompiled headers. See Bugs.
To create a precompiled header file, simply compile it as you would any other file, if necessary using the -x option to make the driver treat it as a C or C++ header file. You will probably want to use a tool like make to keep the precompiled header up-to-date when the headers it contains change.
A precompiled header file will be searched for when #include
is
seen in the compilation. As it searches for the included file
(see Search Path) the
compiler looks for a precompiled header in each directory just before it
looks for the include file in that directory. The name searched for is
the name specified in the #include
with `.gch' appended. If
the precompiled header file can't be used, it is ignored.
For instance, if you have #include "all.h"
, and you have
all.h.gch in the same directory as all.h, then the
precompiled header file will be used if possible, and the original
header will be used otherwise.
Alternatively, you might decide to put the precompiled header file in a
directory and use -I to ensure that directory is searched
before (or instead of) the directory containing the original header.
Then, if you want to check that the precompiled header file is always
used, you can put a file of the same name as the original header in this
directory containing an #error
command.
This also works with -include. So yet another way to use precompiled headers, good for projects not designed with precompiled header files in mind, is to simply take most of the header files used by a project, include them from another header file, precompile that header file, and -include the precompiled header. If the header files have guards against multiple inclusion, they will be skipped because they've already been included (in the precompiled header).
If you need to precompile the same header file for different languages, targets, or compiler options, you can instead make a directory named like all.h.gch, and put each precompiled header in the directory. (It doesn't matter what you call the files in the directory, every precompiled header in the directory will be considered.) The first precompiled header encountered in the directory that is valid for this compilation will be used; they're searched in no particular order.
There are many other possibilities, limited only by your imagination, good sense, and the constraints of your build system.
A precompiled header file can be used only when these conditions apply:
#include
.
For all of these but the last, the compiler will automatically ignore the precompiled header if the conditions aren't met. For the last item, some option changes will cause the precompiled header to be rejected, but not all incompatible option combinations have yet been found. If you find a new incompatible combination, please consider filing a bug report, see Bugs.
The program protoize
is an optional part of GCC. You can use
it to add prototypes to a program, thus converting the program to ISO
C in one respect. The companion program unprotoize
does the
reverse: it removes argument types from any prototypes that are found.
When you run these programs, you must specify a set of source files as command line arguments. The conversion programs start out by compiling these files to see what functions they define. The information gathered about a file foo is saved in a file named foo.X.
After scanning comes actual conversion. The specified files are all eligible to be converted; any files they include (whether sources or just headers) are eligible as well.
But not all the eligible files are converted. By default,
protoize
and unprotoize
convert only source and header
files in the current directory. You can specify additional directories
whose files should be converted with the -d directory
option. You can also specify particular files to exclude with the
-x file option. A file is converted if it is eligible, its
directory name matches one of the specified directory names, and its
name within the directory has not been excluded.
Basic conversion with protoize
consists of rewriting most
function definitions and function declarations to specify the types of
the arguments. The only ones not rewritten are those for varargs
functions.
protoize
optionally inserts prototype declarations at the
beginning of the source file, to make them available for any calls that
precede the function's definition. Or it can insert prototype
declarations with block scope in the blocks where undeclared functions
are called.
Basic conversion with unprotoize
consists of rewriting most
function declarations to remove any argument types, and rewriting
function definitions to the old-style pre-ISO form.
Both conversion programs print a warning for any function declaration or definition that they can't convert. You can suppress these warnings with -q.
The output from protoize
or unprotoize
replaces the
original source file. The original file is renamed to a name ending
with `.save' (for DOS, the saved filename ends in `.sav'
without the original `.c' suffix). If the `.save' (`.sav'
for DOS) file already exists, then the source file is simply discarded.
protoize
and unprotoize
both depend on GCC itself to
scan the program and collect information about the functions it uses.
So neither of these programs will work until GCC is installed.
Here is a table of the options you can use with protoize
and
unprotoize
. Each option works with both programs unless
otherwise stated.
-B
directoryprotoize
.
-c
compilation-optionsNote that the compilation options must be given as a single argument to
protoize
or unprotoize
. If you want to specify several
gcc options, you must quote the entire set of compilation options
to make them a single word in the shell.
There are certain gcc arguments that you cannot use, because they
would produce the wrong kind of output. These include -g,
-O, -c, -S, and -o If you include these in
the compilation-options, they are ignored.
-C
protoize
.
-g
protoize
.
-i
stringprotoize
.
unprotoize
converts prototyped function definitions to old-style
function definitions, where the arguments are declared between the
argument list and the initial `{'. By default, unprotoize
uses five spaces as the indentation. If you want to indent with just
one space instead, use -i " ".
-k
-l
protoize
with -l inserts
a prototype declaration for each function in each block which calls the
function without any declaration. This option applies only to
protoize
.
-n
-N
-p
program-q
-v
If you need special compiler options to compile one of your program's
source files, then you should generate that file's `.X' file
specially, by running gcc on that source file with the
appropriate options and the option -aux-info. Then run
protoize
on the entire set of files. protoize
will use
the existing `.X' file because it is newer than the source file.
For example:
gcc -Dfoo=bar file1.c -aux-info file1.X protoize *.c
You need to include the special files along with the rest in the
protoize
command, even though their `.X' files already
exist, because otherwise they won't get converted.
See Protoize Caveats, for more information on how to use
protoize
successfully.
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 number from the ISO/IEC 9899:1999 standard.
Diagnostics consist of all the output sent to stderr by GCC.
The behavior of these points are dependent on the implementation of the C library, and are not defined by GCC itself.
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.
char
object into which has been stored any
character other than a member of the basic execution character set (6.2.5).
signed char
or unsigned char
has the same range,
representation, and behavior as “plain” char
(6.2.5, 6.3.1.1).
GCC supports only two's complement integer types, and all bit patterns are ordinary values.
<math.h>
and <complex.h>
that return floating-point
results (5.2.4.2.2).
FLT_ROUNDS
(5.2.4.2.2).
FLT_EVAL_METHOD
(5.2.4.2.2).
FP_CONTRACT
pragma (6.5).
FENV_ACCESS
pragma (7.6.1).
FP_CONTRACT
pragma (7.12.2).
A cast from pointer to integer discards most-significant bits if the pointer representation is larger than the integer type, sign-extends2 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 reference 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 6.5.6/8.
register
storage-class specifier are effective (6.7.1).
The register
specifier affects code generation only in these ways:
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.
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
.
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.
signed int
bit-field or as an unsigned int
bit-field (6.7.2, 6.7.2.1).
_Bool
, signed int
,
and unsigned int
(6.7.2.1).
#include
directive are combined into a header
name (6.10.2).
#include
processing (6.10.2).
GCC imposes a limit of 200 nested #include
s.
STDC #pragma
directive (6.10.6).
__DATE__
and __TIME__
when
respectively, the date and time of translation are not available (6.10.8).
If the date and time are not available, __DATE__
expands to
"??? ?? ????"
and __TIME__
expands to
"??:??:??"
.
The behavior of these points are dependent on the implementation of the C library, and are not defined by GCC itself.
<float.h>
, <limits.h>
, and <stdint.h>
(5.2.4.2, 7.18.2, 7.18.3).
The behavior of these points are dependent on the implementation of the C library, and are not defined by GCC itself.
GNU C provides several language features not found in ISO standard C.
(The -pedantic option directs GCC to print a warning message if
any of these features is used.) To test for the availability of these
features in conditional compilation, check for a predefined macro
__GNUC__
, which is always defined under GCC.
These extensions are available in C and Objective-C. Most of them are also available in C++. See Extensions to the C++ Language, for extensions that apply only to C++.
Some features that are in ISO C99 but not C89 or C++ are also, as extensions, accepted by GCC in C89 mode and in C++.
A compound statement enclosed in parentheses may appear as an expression in GNU C. This allows you to use loops, switches, and local variables within an expression.
Recall that a compound statement is a sequence of statements surrounded by braces; in this construct, parentheses go around the braces. For example:
({ int y = foo (); int z; if (y > 0) z = y; else z = - y; z; })
is a valid (though slightly more complex than necessary) expression
for the absolute value of foo ()
.
The last thing in the compound statement should be an expression
followed by a semicolon; the value of this subexpression serves as the
value of the entire construct. (If you use some other kind of statement
last within the braces, the construct has type void
, and thus
effectively no value.)
This feature is especially useful in making macro definitions “safe” (so that they evaluate each operand exactly once). For example, the “maximum” function is commonly defined as a macro in standard C as follows:
#define max(a,b) ((a) > (b) ? (a) : (b))
But this definition computes either a or b twice, with bad
results if the operand has side effects. In GNU C, if you know the
type of the operands (here taken as int
), you can define
the macro safely as follows:
#define maxint(a,b) \ ({int _a = (a), _b = (b); _a > _b ? _a : _b; })
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
(see Typeof).
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 ()
will construct a temporary A
object to hold the result of the
statement expression, and that will be used to invoke Foo
.
Therefore the this
pointer observed by Foo
will not be the
address of a
.
Any temporaries created within a statement within a statement expression will be destroyed at the statement's end. This makes statement expressions inside macros slightly different from function calls. In the latter case temporaries introduced during argument evaluation will be destroyed at the end of the statement that includes the function call. In the statement expression case they will be 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 ()); }
will have different places where temporaries are destroyed. For the
macro
case, the temporary X
will be destroyed just after
the initialization of b
. In the function
case that
temporary will be 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-expression that lead to precisely this bug.)
GCC allows you to declare local labels in any nested block
scope. A local label is just like an ordinary label, but you can
only reference it (with a goto
statement, or by taking its
address) within the block in which it was declared.
A local label declaration looks like this:
__label__ label;
or
__label__ label1, label2, /* ... */;
Local label declarations must come at the beginning of the block, before any ordinary declarations or statements.
The label declaration defines the label name, but does not define
the label itself. You must do this in the usual way, with
label:
, within the statements of the statement expression.
The local label feature is useful for complex macros. If a macro
contains nested loops, a goto
can be useful for breaking out of
them. However, an ordinary label whose scope is the whole function
cannot be used: if the macro can be expanded several times in one
function, the label will be multiply defined in that function. A
local label avoids this problem. For example:
#define SEARCH(value, array, target) \ do { \ __label__ found; \ typeof (target) _SEARCH_target = (target); \ typeof (*(array)) *_SEARCH_array = (array); \ int i, j; \ int value; \ for (i = 0; i < max; i++) \ for (j = 0; j < max; j++) \ if (_SEARCH_array[i][j] == _SEARCH_target) \ { (value) = i; goto found; } \ (value) = -1; \ found:; \ } while (0)
This could also be written using a statement-expression:
#define SEARCH(array, target) \ ({ \ __label__ found; \ typeof (target) _SEARCH_target = (target); \ typeof (*(array)) *_SEARCH_array = (array); \ int i, j; \ int value; \ for (i = 0; i < max; i++) \ for (j = 0; j < max; j++) \ if (_SEARCH_array[i][j] == _SEARCH_target) \ { value = i; goto found; } \ value = -1; \ found: \ value; \ })
Local label declarations also make the labels they declare visible to nested functions, if there are any. See Nested Functions, for details.
You can get the address of a label defined in the current function
(or a containing function) with the unary operator `&&'. The
value has type void *
. This value is a constant and can be used
wherever a constant of that type is valid. For example:
void *ptr;
/* ... */
ptr = &&foo;
To use these values, you need to be able to jump to one. This is done
with the computed goto statement3, goto *
exp;
. For example,
goto *ptr;
Any expression of type void *
is allowed.
One way of using these constants is in initializing a static array that will serve as a jump table:
static void *array[] = { &&foo, &&bar, &&hack };
Then you can select a label with indexing, like this:
goto *array[i];
Note that this does not check whether the subscript is in bounds—array indexing in C never does that.
Such an array of label values serves a purpose much like that of the
switch
statement. The switch
statement is cleaner, so
use that rather than an array unless the problem does not fit a
switch
statement very well.
Another use of label values is in an interpreter for threaded code. The labels within the interpreter function can be stored in the threaded code for super-fast dispatching.
You may not use this mechanism to jump to code in a different function. If you do that, totally unpredictable things will happen. The best way to avoid this is to store the label address only in automatic variables and never pass it as an argument.
An alternate way to write the above example is
static const int array[] = { &&foo - &&foo, &&bar - &&foo, &&hack - &&foo }; goto *(&&foo + array[i]);
This is more friendly to code living in shared libraries, as it reduces the number of dynamic relocations that are needed, and by consequence, allows the data to be read-only.
A nested function is a function defined inside another function.
(Nested functions are not supported for GNU C++.) The nested function's
name is local to the block where it is defined. For example, here we
define a nested function named square
, and call it twice:
foo (double a, double b) { double square (double z) { return z * z; } return square (a) + square (b); }
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, before the first statement 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; } intermediate (store, size); }
Here, the function intermediate
receives the address of
store
as an argument. If intermediate
calls store
,
the arguments given to store
are used to store into array
.
But this technique works only so long as the containing function
(hack
, in this example) does not exit.
If you try to call the nested function through its address after the containing function has exited, all hell will break loose. If you try to call it after a containing scope level has exited, and if it refers to some of the variables that are no longer in scope, you may be lucky, but it's not wise to take the risk. If, however, the nested function does not refer to anything that has gone out of scope, you should be safe.
GCC implements taking the address of a nested function using a technique called trampolines. A paper describing them is available as
http://people.debian.org/~aaronl/Usenix88-lexic.pdf.
A nested function can jump to a label inherited from a containing
function, provided the label was explicitly declared in the containing
function (see Local Labels). Such a jump returns instantly to the
containing function, exiting the nested function which 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;
/* Control comes here from access
if it detects an error. */
failure:
return -1;
}
A nested function always has internal linkage. Declaring one with
extern
is erroneous. 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]; } /* ... */ }
Using the built-in functions described below, you can record the arguments a function received, and call another function with the same arguments, without knowing the number or types of the arguments.
You can also record the return value of that function call, and later return that value, without knowing what data type the function tried to return (as long as your caller expects that data type).
However, these built-in functions may interact badly with some sophisticated features or other extensions of the language. It is, therefore, not recommended to use them outside very simple functions acting as mere forwarders for their arguments.
This built-in function returns a pointer to data describing how to perform a call with the same arguments as were passed to the current function.
The function saves the arg pointer register, structure value address, and all registers that might be used to pass arguments to a function into a block of memory allocated on the stack. Then it returns the address of that block.
This built-in function invokes function with a copy of the parameters described by arguments and size.
The value of arguments should be the value returned by
__builtin_apply_args
. The argument size specifies the size of the stack argument data, in bytes.This function returns a pointer to data describing how to return whatever value was returned by function. The data is saved in a block of memory allocated on the stack.
It is not always simple to compute the proper value for size. The value is used by
__builtin_apply
to compute the amount of data that should be pushed on the stack and copied from the incoming argument area.
This built-in function returns the value described by result from the containing function. You should specify, for result, a value returned by
__builtin_apply
.
typeof
Another way to refer to the type of an expression is with typeof
.
The syntax of using of this keyword looks like sizeof
, but the
construct acts semantically like a type name defined with typedef
.
There are two ways of writing the argument to typeof
: with an
expression or with a type. Here is an example with an expression:
typeof (x[0](1))
This assumes that x
is an array of pointers to functions;
the type described is that of the values of the functions.
Here is an example with a typename as the argument:
typeof (int *)
Here the type described is that of pointers to int
.
If you are writing a header file that must work when included in ISO C
programs, write __typeof__
instead of typeof
.
See Alternate Keywords.
A typeof
-construct can be used anywhere a typedef name could be
used. For example, you can use it in a declaration, in a cast, or inside
of sizeof
or typeof
.
typeof
is often useful in conjunction with the
statements-within-expressions feature. Here is how the two together can
be used to define a safe “maximum” macro that operates on any
arithmetic type and evaluates each of its arguments exactly once:
#define max(a,b) \ ({ typeof (a) _a = (a); \ typeof (b) _b = (b); \ _a > _b ? _a : _b; })
The reason for using names that start with underscores for the local
variables is to avoid conflicts with variable names that occur within the
expressions that are substituted for a
and b
. Eventually we
hope to design a new form of declaration syntax that allows you to declare
variables whose scopes start only after their initializers; this will be a
more reliable way to prevent such conflicts.
Some more examples of the use of typeof
:
y
with the type of what x
points to.
typeof (*x) y;
y
as an array of such values.
typeof (*x) y[4];
y
as an array of pointers to characters:
typeof (typeof (char *)[4]) y;
It is equivalent to the following traditional C declaration:
char *y[4];
To see the meaning of the declaration using typeof
, and why it
might be a useful way to write, rewrite it with these macros:
#define pointer(T) typeof(T *) #define array(T, N) typeof(T [N])
Now the declaration can be rewritten this way:
array (pointer (char), 4) y;
Thus, array (pointer (char), 4)
is the type of arrays of 4
pointers to char
.
Compatibility Note: In addition to typeof
, GCC 2 supported
a more limited extension which permitted one to write
typedef T = expr;
with the effect of declaring T to have the type of the expression
expr. This extension does not work with GCC 3 (versions between
3.0 and 3.2 will crash; 3.2.1 and later give an error). Code which
relies on it should be rewritten to use typeof
:
typedef typeof(expr) T;
This will work with all versions of GCC.
Compound expressions, conditional expressions and casts are allowed as lvalues provided their operands are lvalues. This means that you can take their addresses or store values into them. All these extensions are deprecated.
Standard C++ allows compound expressions and conditional expressions as lvalues, and permits casts to reference type, so use of this extension is not supported for C++ code.
For example, a compound expression can be assigned, provided the last expression in the sequence is an lvalue. These two expressions are equivalent:
(a, b) += 5 a, (b += 5)
Similarly, the address of the compound expression can be taken. These two expressions are equivalent:
&(a, b) a, &b
A conditional expression is a valid lvalue if its type is not void and the true and false branches are both valid lvalues. For example, these two expressions are equivalent:
(a ? b : c) = 5 (a ? b = 5 : (c = 5))
A cast is a valid lvalue if its operand is an lvalue. This extension
is deprecated. A simple
assignment whose left-hand side is a cast works by converting the
right-hand side first to the specified type, then to the type of the
inner left-hand side expression. After this is stored, the value is
converted back to the specified type to become the value of the
assignment. Thus, if a
has type char *
, the following two
expressions are equivalent:
(int)a = 5 (int)(a = (char *)(int)5)
An assignment-with-arithmetic operation such as `+=' applied to a cast performs the arithmetic using the type resulting from the cast, and then continues as in the previous case. Therefore, these two expressions are equivalent:
(int)a += 5 (int)(a = (char *)(int) ((int)a + 5))
You cannot take the address of an lvalue cast, because the use of its
address would not work out coherently. Suppose that &(int)f
were
permitted, where f
has type float
. Then the following
statement would try to store an integer bit-pattern where a floating
point number belongs:
*&(int)f = 1;
This is quite different from what (int)f = 1
would do—that
would convert 1 to floating point and store it. Rather than cause this
inconsistency, we think it is better to prohibit use of `&' on a cast.
If you really do want an int *
pointer with the address of
f
, you can simply write (int *)&f
.
The middle operand in a conditional expression may be omitted. Then if the first operand is nonzero, its value is the value of the conditional expression.
Therefore, the expression
x ? : y
has the value of x
if that is nonzero; otherwise, the value of
y
.
This example is perfectly equivalent to
x ? x : y
In this simple case, the ability to omit the middle operand is not especially useful. When it becomes useful is when the first operand does, or may (if it is a macro argument), contain a side effect. Then repeating the operand in the middle would perform the side effect twice. Omitting the middle operand uses the value already computed without the undesirable effects of recomputing it.
ISO C99 supports data types for integers that are at least 64 bits wide,
and as an extension GCC supports them in C89 mode and in C++.
Simply write long long int
for a signed integer, or
unsigned long long int
for an unsigned integer. To make an
integer constant of type long long int
, add the suffix `LL'
to the integer. To make an integer constant of type unsigned long
long int
, add the suffix `ULL' to the integer.
You can use these types in arithmetic like any other integer types. Addition, subtraction, and bitwise boolean operations on these types are open-coded on all types of machines. Multiplication is open-coded if the machine supports fullword-to-doubleword a widening multiply instruction. Division and shifts are open-coded only on machines that provide special support. The operations that are not open-coded use special library routines that come with GCC.
There may be pitfalls when you use long long
types for function
arguments, unless you declare function prototypes. If a function
expects type int
for its argument, and you pass a value of type
long long int
, confusion will result because the caller and the
subroutine will disagree about the number of bytes for the argument.
Likewise, if the function expects long long int
and you pass
int
. The best way to avoid such problems is to use prototypes.
ISO C99 supports complex floating data types, and as an extension GCC
supports them in C89 mode and in C++, and supports complex integer data
types which are not part of ISO C99. You can declare complex types
using the keyword _Complex
. As an extension, the older GNU
keyword __complex__
is also supported.
For example, `_Complex double x;' declares x
as a
variable whose real part and imaginary part are both of type
double
. `_Complex short int y;' declares y
to
have real and imaginary parts of type short int
; this is not
likely to be useful, but it shows that the set of complex types is
complete.
To write a constant with a complex data type, use the suffix `i' or
`j' (either one; they are equivalent). For example, 2.5fi
has type _Complex float
and 3i
has type
_Complex int
. Such a constant always has a pure imaginary
value, but you can form any complex value you like by adding one to a
real constant. This is a GNU extension; if you have an ISO C99
conforming C library (such as GNU libc), and want to construct complex
constants of floating type, you should include <complex.h>
and
use the macros I
or _Complex_I
instead.
To extract the real part of a complex-valued expression exp, write
__real__
exp. Likewise, use __imag__
to
extract the imaginary part. This is a GNU extension; for values of
floating type, you should use the ISO C99 functions crealf
,
creal
, creall
, cimagf
, cimag
and
cimagl
, declared in <complex.h>
and also provided as
built-in functions by GCC.
The operator `~' performs complex conjugation when used on a value
with a complex type. This is a GNU extension; for values of
floating type, you should use the ISO C99 functions conjf
,
conj
and conjl
, declared in <complex.h>
and also
provided as built-in functions by GCC.
GCC can allocate complex automatic variables in a noncontiguous
fashion; it's even possible for the real part to be in a register while
the imaginary part is on the stack (or vice-versa). Only the DWARF2
debug info format can represent this, so use of DWARF2 is recommended.
If you are using the stabs debug info format, GCC describes a noncontiguous
complex variable as if it were two separate variables of noncomplex type.
If the variable's actual name is foo
, the two fictitious
variables are named foo$real
and foo$imag
. You can
examine and set these two fictitious variables with your debugger.
ISO C99 supports floating-point numbers written not only in the usual
decimal notation, such as 1.55e1
, but also numbers such as
0x1.fp3
written in hexadecimal format. As a GNU extension, GCC
supports this in C89 mode (except in some cases when strictly
conforming) and in C++. In that format the
`0x' hex introducer and the `p' or `P' exponent field are
mandatory. The exponent is a decimal number that indicates the power of
2 by which the significant part will be multiplied. Thus `0x1.f' is
1 15/16,
`p3' multiplies it by 8, and the value of 0x1.fp3
is the same as 1.55e1
.
Unlike for floating-point numbers in the decimal notation the exponent
is always required in the hexadecimal notation. Otherwise the compiler
would not be able to resolve the ambiguity of, e.g., 0x1.f
. This
could mean 1.0f
or 1.9375
since `f' is also the
extension for floating-point constants of type float
.
Zero-length arrays are allowed in GNU C. They are very useful as the last element of a structure which is really a header for a variable-length object:
struct line { int length; char contents[0]; }; struct line *thisline = (struct line *) malloc (sizeof (struct line) + this_length); thisline->length = this_length;
In ISO C90, you would have to give contents
a length of 1, which
means either you waste space or complicate the argument to malloc
.
In ISO C99, you would use a flexible array member, which is slightly different in syntax and semantics:
contents[]
without
the 0
.
sizeof
operator may not be applied. As a quirk of the original implementation
of zero-length arrays, sizeof
evaluates to zero.
struct
that is otherwise non-empty.
GCC versions before 3.0 allowed zero-length arrays to be statically initialized, as if they were flexible arrays. In addition to those cases that were useful, it also allowed initializations in situations that would corrupt later data. Non-empty initialization of zero-length arrays is now treated like any case where there are more initializer elements than the array holds, in that a suitable warning about "excess elements in array" is given, and the excess elements (all of them, in this case) are ignored.
Instead GCC allows static initialization of flexible array members.
This is equivalent to defining a new structure containing the original
structure followed by an array of sufficient size to contain the data.
I.e. in the following, f1
is constructed as if it were declared
like f2
.
struct f1 { int x; int y[]; } f1 = { 1, { 2, 3, 4 } }; 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; }; struct foo a = { 1, { 2, 3, 4 } }; // Valid. struct bar b = { { 1, { 2, 3, 4 } } }; // Invalid. struct bar c = { { 1, { } } }; // Valid. struct foo d[1] = { { 1 { 2, 3, 4 } } }; // Invalid.
GCC permits a C structure to have no members:
struct empty { };
The structure will have size zero. In C++, empty structures are part
of the language. G++ treats empty structures as if they had a single
member of type char
.
Variable-length automatic arrays are allowed in ISO C99, and as an extension GCC accepts them in C89 mode and in C++. (However, GCC's implementation of variable-length arrays does not yet conform in detail to the ISO C99 standard.) These arrays are declared like any other automatic arrays, but with a length that is not a constant expression. The storage is allocated at the point of declaration and deallocated when the brace-level is exited. For example:
FILE * concat_fopen (char *s1, char *s2, char *mode) { char str[strlen (s1) + strlen (s2) + 1]; strcpy (str, s1); strcat (str, s2); return fopen (str, mode); }
Jumping or breaking out of the scope of the array name deallocates the storage. Jumping into the scope is not allowed; you get an error message for it.
You can use the function alloca
to get an effect much like
variable-length arrays. The function alloca
is available in
many other C implementations (but not in all). On the other hand,
variable-length arrays are more elegant.
There are other differences between these two methods. Space allocated
with alloca
exists until the containing function returns.
The space for a variable-length array is deallocated as soon as the array
name's scope ends. (If you use both variable-length arrays and
alloca
in the same function, deallocation of a variable-length array
will also deallocate anything more recently allocated with alloca
.)
You can also use variable-length arrays as arguments to functions:
struct entry
tester (int len, char data[len][len])
{
/* ... */
}
The length of an array is computed once when the storage is allocated
and is remembered for the scope of the array in case you access it with
sizeof
.
If you want to pass the array first and the length afterward, you can use a forward declaration in the parameter list—another GNU extension.
struct entry
tester (int len; char data[len][len], int len)
{
/* ... */
}
The `int len' before the semicolon is a parameter forward
declaration, and it serves the purpose of making the name len
known when the declaration of data
is parsed.
You can write any number of such parameter forward declarations in the parameter list. They can be separated by commas or semicolons, but the last one must end with a semicolon, which is followed by the “real” parameter declarations. Each forward declaration must match a “real” declaration in parameter name and data type. ISO C99 does not support parameter forward declarations.
In the ISO C standard of 1999, a macro can be declared to accept a variable number of arguments much as a function can. The syntax for defining the macro is similar to that of a function. Here is an example:
#define debug(format, ...) fprintf (stderr, format, __VA_ARGS__)
Here `...' is a variable argument. In the invocation of
such a macro, it represents the zero or more tokens until the closing
parenthesis that ends the invocation, including any commas. This set of
tokens replaces the identifier __VA_ARGS__
in the macro body
wherever it appears. See the CPP manual for more information.
GCC has long supported variadic macros, and used a different syntax that allowed you to give a name to the variable arguments just like any other argument. Here is an example:
#define debug(format, args...) fprintf (stderr, format, args)
This is in all ways equivalent to the ISO C example above, but arguably more readable and descriptive.
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.
Recently, the preprocessor has relaxed its treatment of escaped newlines. Previously, the newline had to immediately follow a backslash. The current implementation allows whitespace in the form of spaces, horizontal and vertical tabs, and form feeds between the backslash and the subsequent newline. The preprocessor issues a warning, but treats it as a valid escaped newline and combines the two lines to form a single logical line. This works within comments and tokens, as well as between tokens. Comments are not treated as whitespace for the purposes of this relaxation, since they have not yet been replaced with spaces.
In ISO C99, arrays that are not lvalues still decay to pointers, and may be subscripted, although they may not be modified or used after the next sequence point and the unary `&' operator may not be applied to them. As an extension, GCC allows such arrays to be subscripted in C89 mode, though otherwise they do not decay to pointers outside C99 mode. For example, this is valid in GNU C though not valid in C89:
struct foo {int a[4];}; struct foo f(); bar (int index) { return f().a[index]; }
void
- and Function-Pointers
In GNU C, addition and subtraction operations are supported on pointers to
void
and on pointers to functions. This is done by treating the
size of a void
or of a function as 1.
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.
As in standard C++ and ISO C99, the elements of an aggregate initializer for an automatic variable are not required to be constant expressions in GNU C. Here is an example of an initializer with run-time varying elements:
foo (float f, float g)
{
float beat_freqs[2] = { f-g, f+g };
/* ... */
}
ISO C99 supports compound literals. A compound literal looks like a cast containing an initializer. Its value is an object of the type specified in the cast, containing the elements specified in the initializer; it is an lvalue. As an extension, GCC supports compound literals in C89 mode and in C++.
Usually, the specified type is a structure. Assume that
struct foo
and structure
are declared as shown:
struct foo {int a; char b[2];} structure;
Here is an example of constructing a struct foo
with a compound literal:
structure = ((struct foo) {x + y, 'a', 0});
This is equivalent to writing the following:
{ struct foo temp = {x + y, 'a', 0}; structure = temp; }
You can also construct an array. If all the elements of the compound literal are (made up of) simple constant expressions, suitable for use in initializers of objects of static storage duration, then the compound literal can be coerced to a pointer to its first element and used in such an initializer, as shown here:
char **foo = (char *[]) { "x", "y", "z" };
Compound literals for scalar types and union types are is also allowed, but then the compound literal is equivalent to a cast.
As a GNU extension, GCC allows initialization of objects with static storage duration by compound literals (which is not possible in ISO C99, because the initializer is not a constant). It is handled as if the object was initialized only with the bracket enclosed list if compound literal's and object types match. The initializer list of the compound literal must be constant. If the object being initialized has array type of unknown size, the size is determined by compound literal size.
static struct foo x = (struct foo) {1, 'a', 'b'}; static int y[] = (int []) {1, 2, 3}; static int z[] = (int [3]) {1};
The above lines are equivalent to the following:
static struct foo x = {1, 'a', 'b'}; static int y[] = {1, 2, 3}; static int z[] = {1, 0, 0};
Standard C89 requires the elements of an initializer to appear in a fixed order, the same as the order of the elements in the array or structure being initialized.
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 C89 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 automatic.
An alternative syntax for this which 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 will 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 which has the same meaning, obsolete since GCC 2.5, is `fieldname:', as shown here:
struct point p = { y: yvalue, x: xvalue };
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 };
will convert 4 to a double
to store it in the union using
the second element. By contrast, casting 4 to type union foo
would store it into the union as the integer i
, since it is
an integer. (See Cast to Union.)
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
int a[6] = { 0, v1, v2, 0, v4, 0 };
Labeling the elements of an array initializer is especially useful
when the indices are characters or belong to an enum
type.
For example:
int whitespace[256] = { [' '] = 1, ['\t'] = 1, ['\h'] = 1, ['\f'] = 1, ['\n'] = 1, ['\r'] = 1 };
You can also write a series of `.fieldname' and `[index]' designators before an `=' to specify a nested subobject to initialize; the list is taken relative to the subobject corresponding to the closest surrounding brace pair. For example, with the `struct point' declaration above:
struct point ptarray[10] = { [2].y = yv2, [2].x = xv2, [0].x = xv0 };
If the same field is initialized multiple times, it will have value from the last initialization. If any such overridden initialization has side-effect, it is unspecified whether the side-effect happens or not. Currently, GCC will discard them and issue a warning.
You can specify a range of consecutive values in a single case
label,
like this:
case low ... high:
This has the same effect as the proper number of individual case
labels, one for each integer value from low to high, inclusive.
This feature is especially useful for ranges of ASCII character codes:
case 'A' ... 'Z':
Be careful: Write spaces around the ...
, for otherwise
it may be parsed wrong when you use it with integer values. For example,
write this:
case 1 ... 5:
rather than this:
case 1...5:
A cast to union type is similar to other casts, except that the type
specified is a union type. You can specify the type either with
union
tag or with a typedef name. A cast to union is actually
a constructor though, not a cast, and hence does not yield an lvalue like
normal casts. (See Compound Literals.)
The types that may be cast to the union type are those of the members of the union. Thus, given the following union and variables:
union foo { int i; double d; }; int x; double y;
both x
and y
can be cast to type union foo
.
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:
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);
ISO C99 and ISO C++ allow declarations and code to be freely mixed within compound statements. As an extension, GCC also allows this in C89 mode. For example, you could do:
int i;
/* ... */
i++;
int j = i + 2;
Each identifier is visible from where it is declared until the end of the enclosing block.
In GNU C, you declare certain things about functions called in your program which help the compiler optimize function calls and check your code more carefully.
The keyword __attribute__
allows you to specify special
attributes when making a declaration. This keyword is followed by an
attribute specification inside double parentheses. The following
attributes are currently defined for functions on all targets:
noreturn
, noinline
, always_inline
,
pure
, const
, nothrow
,
format
, format_arg
, no_instrument_function
,
section
, constructor
, destructor
, used
,
unused
, deprecated
, weak
, malloc
,
bounded
, sentinel
,
alias
, warn_unused_result
and nonnull
. Several other
attributes are defined for functions on particular target systems. Other
attributes, including section
are supported for variables declarations
(see Variable Attributes) and for types (see Type Attributes).
You may also specify attributes with `__' preceding and following
each keyword. 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 __noreturn__
instead of noreturn
.
See Attribute Syntax, for details of the exact syntax for using attributes.
noreturn
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 exception.
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
.
The attribute noreturn
is not implemented in GCC versions
earlier than 2.5. An alternative way to declare that a function does
not return, which works in the current version and in some older
versions, is as follows:
typedef void voidfn (); volatile voidfn fatal;
This approach does not work in GNU C++.
noinline
always_inline
pure
pure
. For example,
int square (int) __attribute__ ((pure));
says that the hypothetical function square
is safe to call
fewer times than the program says.
Some of common examples of pure functions are strlen
or memcmp
.
Interesting non-pure functions are functions with infinite loops or those
depending on volatile memory or other system resource, that may change between
two consecutive calls (such as feof
in a multithreading environment).
The attribute pure
is not implemented in GCC versions earlier
than 2.96.
const
pure
attribute above, since function is not
allowed to read global memory.
Note that a function that has pointer arguments and examines the data
pointed to must not be declared const
. Likewise, a
function that calls a non-const
function usually must not be
const
. It does not make sense for a const
function to
return void
.
The attribute const
is not implemented in GCC versions earlier
than 2.5. An alternative way to declare that a function has no side
effects, which works in the current version and in some older versions,
is as follows:
typedef int intfn (); extern const intfn square;
This approach does not work in GNU C++ from 2.6.0 on, since the language specifies that the `const' must be attached to the return value.
nothrow
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. The nothrow
attribute is not
implemented in GCC versions earlier than 3.2.
format (
archetype,
string-index,
first-to-check)
format
attribute specifies that a function takes printf
,
kprintf
, scanf
, syslog
, strftime
or
strfmon
style arguments which should be type-checked against a
format string. The kprintf
and syslog
formats are
MirOS extensions. For example, the declaration:
extern int my_printf (void *my_object, const char *my_format, ...) __attribute__ ((format (printf, 2, 3)));
causes the compiler to check the arguments in calls to my_printf
for consistency with the printf
style format string argument
my_format
.
The parameter archetype determines how the format string is
interpreted, and should be printf
, kprintf
, scanf
,
syslog
, strftime
or strfmon
. (You can also use __printf__
,
__scanf__
, __strftime__
or __strfmon__
.) The
parameter string-index specifies which argument is the format
string argument (starting from 1), while first-to-check is the
number of the first argument to check against the format string. For
functions where the arguments are not available to be checked (such as
vprintf
), specify the third parameter as zero. In this case the
compiler only checks the format string for consistency. For
strftime
formats, the third parameter is required to be zero.
Since non-static C++ methods have an implicit this
argument, the
arguments of such methods should be counted from two, not one, when
giving values for string-index and first-to-check.
In the example above, the format string (my_format
) is the second
argument of the function my_print
, and the arguments to check
start with the third argument, so the correct parameters for the format
attribute are 2 and 3.
The syslog
format attribute is based upon the printf
format attribute and designed to better match the definition of syslog(3)
and silence erroneous warnings when used with -pedantic.
The kprintf
format attribute is also based upon the printf
format attribute but supports the extra format arguments `%b',
`%r' and `%z' used in the BSD kernel.
The format
attribute allows you to identify your own functions
which take format strings as arguments, so that GCC can check the
calls to these functions for errors. The compiler always (unless
-ffreestanding is used) checks formats
for the standard library functions printf
, fprintf
,
sprintf
, scanf
, fscanf
, sscanf
, strftime
,
vprintf
, vfprintf
and vsprintf
whenever such
warnings are requested (using -Wformat), so there is no need 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 Options Controlling C Dialect.
format_arg (
string-index)
format_arg
attribute specifies that a function takes a format
string 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). 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.
The parameter string-index specifies which argument is the format
string argument (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 which 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 is used. See Options Controlling C Dialect.
nonnull (
arg-index, ...)
nonnull
attribute specifies that some function parameters should
be non-null pointers. For instance, the declaration:
extern void * my_memcpy (void *dest, const void *src, size_t len) __attribute__((nonnull (1, 2)));
causes the compiler to check that, in calls to my_memcpy
,
arguments dest and src are non-null. 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. The compiler may also choose to make optimizations based
on the knowledge that certain function arguments will not be null.
If no argument index list 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));
The printf
format attribute does not imply nonnull
for the
format to allow for correct format checking on the err(3) function family.
sentinel (
arg-index, ...)
sentinel
attribute can be used to mark varargs functions
that need a NULL pointer to mark argument termination, such as execl(3).
This exposes latent bugs for 64-bit architectures, where a terminating 0
will expand to a 32-bit int, not to a full-fledged 64-bit pointer.
int execl(const char *, const char *, ...) __attribute__((sentinel));
bounded (
arg-index, ...)
bounded
attribute is used together with the -Wbounded
to activate the Bounds Checker. It is used to type-check functions whose
parameters pass fixed-length buffers and their sizes.
The syntax for normal buffers is:
__attribute__((__bounded__(__buffer__, buffer, length)))
where buffer contains the parameter number (starting from 1) of the pointer to the buffer, and length contains the parameter number of the buffer length argument.
A warning will be emitted if the length argument is a constant larger than the actual size of the buffer. If the buffer is not a statically declared array of fixed length, no warnings will be generated.
void *memcpy(void *, const void *, size_t) __attribute__((__bounded__(__buffer__, 1, 3))) __attribute__((__bounded__(__buffer__, 2, 3)));
For checking strings, just use __string__ instead of __buffer__:
__attribute__((__bounded__(__string__, buffer, length)))
In addition to the checks described above, this also tests if the length argument was wrongly derived from a sizeof(void *) operation. strlcpy(3) is a good example of a string function with this check:
size_t strlcpy(char *, const char *, size_t) __attribute__((__bounded__(__string__, 1, 3)));
Some functions specify the length as two arguments: the number of elements and the size of each element. In this case, use the __size__ attribute:
__attribute__((__bounded__(__size__, buffer, nmemb, size)))
where buffer contains the parameter number of the pointer to the buffer, nmemb contains the parameter number of the number of members, and size has the parameter number of the size of each element. The type checks performed by __size__ are the same as the __buffer__ attribute.
size_t fread(void *, size_t, size_t, FILE *) __attribute__((__bounded__(__size__, 1, 3, 2)));
If a function accepts a buffer parameter and specifies that it has to be of a minimum length, the __minbytes__ attribute can be used:
__attribute__((__bounded__(__minbytes__, buffer, minsize)))
where buffer contains the parameter number of the pointer to the buffer, and minsize specifies the minimum number of bytes that the buffer should be.
char *ctime_r(const time_t *, char *) __attribute__((__bounded__(__minbytes__, 2, 26)));
no_instrument_function
section ("
section-name")
text
section.
Sometimes, 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.
constructor
destructor
constructor
attribute causes the function to be called
automatically before execution enters main ()
. Similarly, the
destructor
attribute causes the function to be called
automatically after main ()
has completed or exit ()
has
been called. Functions with these attributes are useful for
initializing data that will be used implicitly during the execution of
the program.
These attributes are not currently implemented for Objective-C.
unused
used
deprecated
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 deprecated
attribute can also be used for variables and
types (see Variable Attributes, see Type Attributes.)
warn_unused_result
warn_unused_result
attribute causes a warning to be emitted
if a caller of the function with this attribute does not use its
return value. This is useful for functions where not checking
the result is either a security problem or always a bug, such as
realloc
.
int fn () __attribute__ ((warn_unused_result)); int foo () { if (fn () < 0) return -1; fn (); return 0; }
results in warning on line 5.
weak
weak
attribute causes the declaration to be emitted as a weak
symbol rather than a global. This is primarily useful in defining
library functions which can be overridden in user code, though it can
also be used with non-function declarations. Weak symbols are supported
for ELF targets, and also for a.out targets when using the GNU assembler
and linker.
malloc
malloc
attribute is used to tell the compiler that a function
may be treated as if any non-NULL
pointer it returns cannot
alias any other pointer valid when the function returns.
This will often improve optimization.
Standard functions with this property include malloc
and
calloc
. realloc
-like functions have this property as
long as the old pointer is never referred to (including comparing it
to the new pointer) after the function returns a non-NULL
value.
alias ("
target")
alias
attribute causes the declaration to be emitted as an
alias for another symbol, which must be specified. For instance,
void __f () { /* Do something. */; }
void f () __attribute__ ((weak, alias ("__f")));
declares `f' to be a weak alias for `__f'. In C++, the mangled name for the target must be used.
Not all target machines support this attribute.
visibility ("
visibility_type")
visibility
attribute on ELF targets causes the declaration
to be emitted with default, hidden, protected or internal visibility.
void __attribute__ ((visibility ("protected")))
f () { /* Do something. */; }
int i __attribute__ ((visibility ("hidden")));
See the ELF gABI for complete details, but the short story is:
Not all ELF targets support this attribute.
regparm (
number)
regparm
attribute causes the compiler to
pass up to number integer arguments in registers EAX,
EDX, and ECX instead of on the stack. Functions that take a
variable number of arguments will continue to be passed all of their
arguments on the stack.
Beware that on some ELF systems this attribute is unsuitable for
global functions in shared libraries with lazy binding (which is the
default). Lazy binding will send 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. Solaris 8 is affected by this.
GNU systems with GLIBC 2.1 or higher, and FreeBSD, are believed to be
safe since the loaders there save all registers. (Lazy binding can be
disabled with the linker or the loader if desired, to avoid the
problem.)
stdcall
stdcall
attribute causes the compiler to
assume that the called function will pop off the stack space used to
pass arguments, unless it takes a variable number of arguments.
fastcall
fastcall
attribute causes the compiler to
pass the first two arguments in the registers ECX and EDX. Subsequent
arguments are passed on the stack. The called function will pop the
arguments off the stack. If the number of arguments is variable all
arguments are pushed on the stack.
cdecl
cdecl
attribute causes the compiler to
assume that the calling function will pop off the stack space used to
pass arguments. This is
useful to override the effects of the -mrtd switch.
longcall/shortcall
longcall
attribute causes the
compiler to always call this function via a pointer, just as it would if
the -mlongcall option had been specified. The shortcall
attribute causes the compiler not to do this. These attributes override
both the -mlongcall switch and the #pragma longcall
setting.
See RS/6000 and PowerPC Options, for more information on whether long
calls are necessary.
long_call/short_call
#pragma long_calls
settings. The
long_call
attribute causes 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
attribute always places
the offset to the function from the call site into the `BL'
instruction directly.
function_vector
You must use GAS and GLD from GNU binutils version 2.7 or later for
this attribute to work correctly.
interrupt
Note, interrupt handlers for the m68k, H8/300, H8/300H, H8S, and SH processors
can be specified via the interrupt_handler
attribute.
Note, on the AVR, interrupts will be enabled inside the function.
Note, for the ARM, 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.
interrupt_handler
sp_switch
interrupt_handler
function should switch to an alternate stack. It expects a string
argument that names a global variable holding the address of the
alternate stack.
void *alt_stack; void f () __attribute__ ((interrupt_handler, sp_switch ("alt_stack")));
trap_exit
interrupt_handler
to return using
trapa
instead of rte
. This attribute expects an integer
argument specifying the trap number to be used.
eightbit_data
You must use GAS and GLD from GNU binutils version 2.7 or later for
this attribute to work correctly.
tiny_data
saveall
signal
naked
model (
model-name)
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
instruction.
Medium model objects may live anywhere in the 32-bit address space (the
compiler will generate 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
compiler will generate seth/add3
instructions to load their addresses),
and may not be reachable with the bl
instruction (the compiler will
generate the much slower seth/add3/jl
instruction sequence).
On IA-64, use this attribute to set the addressability of an object.
At present, the only supported identifier for model-name is
small
, indicating addressability via “small” (22-bit)
addresses (so that their addresses can be loaded with the addl
instruction). Caveat: such addressing is by definition not position
independent and hence this attribute must not be used for objects
defined by shared libraries.
far
far
attribute causes the compiler to
use a calling convention that takes care of switching memory banks when
entering and leaving a function. This calling convention is also the
default when using the -mlong-calls option.
On 68HC12 the compiler will use the call
and rtc
instructions
to call and return from a function.
On 68HC11 the compiler will generate a sequence of instructions
to invoke a board-specific routine to switch the memory bank and call the
real function. The board-specific routine simulates a call
.
At the end of a function, it will jump to a board-specific routine
instead of using rts
. The board-specific return routine simulates
the rtc
.
near
near
attribute causes the compiler to
use the normal calling convention based on jsr
and rts
.
This attribute can be used to cancel the effect of the -mlong-calls
option.
dllimport
dllimport
attribute causes the compiler
to reference a function or variable via a global pointer to a pointer
that is set up by the Microsoft Windows dll library. The pointer name is formed by
combining _imp__
and the function or variable name. The attribute
implies extern
storage.
Currently, the attribute is ignored for inlined functions. If the
attribute is applied 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 cygwin, mingw and arm-pe targets, __declspec(dllimport)
is
recognized as a synonym for __attribute__ ((dllimport))
for
compatibility with other Microsoft Windows compilers.
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 was
required on older versions of GNU ld, but can now be avoided by passing
the --enable-auto-import switch to ld. 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 function or
variable marked as dllimport cannot be used as a constant address. The
attribute can be disabled for functions by setting the
-mnop-fun-dllimport flag.
dllexport
dllexport
attribute causes the compiler to
provide a global pointer to a pointer in a dll, so that it can be
referenced with the dllimport
attribute. The pointer name is
formed by combining _imp__
and the function or variable name.
Currently, the dllexport
attribute is ignored for inlined
functions, but export can be forced by using the
-fkeep-inline-functions flag. The attribute is also ignored for
undefined symbols.
When applied to C++ classes. the attribute marks defined non-inlined member functions and static data members as exports. Static consts initialized in-class are not marked unless they are also defined out-of-class.
On cygwin, mingw and arm-pe targets, __declspec(dllexport)
is
recognized as a synonym for __attribute__ ((dllexport))
for
compatibility with other Microsoft Windows compilers.
Alternative methods for including the symbol in the dll's export table
are to use a .def file with an EXPORTS
section or, with GNU ld,
using the --export-all linker flag.
You can specify multiple attributes in a declaration by separating them by commas within the double parentheses or by immediately following an attribute declaration with another attribute declaration.
Some people object to the __attribute__
feature, suggesting that
ISO C's #pragma
should be used instead. At the time
__attribute__
was designed, there were two reasons for not doing
this.
#pragma
commands from a macro.
#pragma
might mean in another
compiler.
These two reasons applied to almost any application that might have been
proposed for #pragma
. It was basically a mistake to use
#pragma
for anything.
The ISO C99 standard includes _Pragma
, which now allows pragmas
to be generated from macros. In addition, a #pragma GCC
namespace is now in use for GCC-specific pragmas. However, it has been
found convenient to use __attribute__
to achieve a natural
attachment of attributes to their corresponding declarations, whereas
#pragma GCC
is of use for constructs that do not naturally form
part of the grammar. See Miscellaneous Preprocessing Directives.
This section describes the syntax with which __attribute__
may be
used, and the constructs to which attribute specifiers bind, for the C
language. Some details may vary for C++ and Objective-C. Because of
infelicities in the grammar for attributes, some forms described here
may not be successfully parsed in all cases.
There are some problems with the semantics of attributes in C++. For
example, there are no manglings for attributes, although they may affect
code generation, so problems may arise when attributed types are used in
conjunction with templates or overloading. Similarly, typeid
does not distinguish between types with different attributes. Support
for attributes in C++ may be restricted in future to attributes on
declarations only, but not on nested declarators.
See Function Attributes, for details of the semantics of attributes applying to functions. See Variable Attributes, for details of the semantics of attributes applying to variables. See Type Attributes, for details of the semantics of attributes applying to structure, union and enumerated types.
An attribute specifier is of the form
__attribute__ ((
attribute-list))
. An attribute list
is a possibly empty comma-separated sequence of attributes, where
each attribute is one of the following:
unused
, or a reserved
word such as const
).
mode
attributes use this form.
format
attributes use this form.
format_arg
attributes use this form with the list being a single
integer constant expression, and alias
attributes use this form
with the list being a single string constant.
An attribute specifier list is a sequence of one or more attribute specifiers, not separated by any other tokens.
In GNU C, an attribute specifier list may appear after the colon following a
label, other than a case
or default
label. The only
attribute it makes sense to use after a label is unused
. This
feature is intended for code generated by programs which contains labels
that may be unused but which is compiled with -Wall. It would
not normally be 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. GNU C++ does not permit
such placement of attribute lists, 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.
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. It is ignored if the content of the structure, union
or enumerated type is not defined in the specifier in which the
attribute specifier list is used—that is, in usages such as
struct __attribute__((foo)) bar
with no following opening brace.
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.
Otherwise, an attribute specifier appears as part of a declaration, counting declarations of unnamed parameters and type names, and relates to that declaration (which may be nested in another declaration, for example in the case of a parameter declaration), or to a particular declarator within a declaration. Where an attribute specifier is applied to a parameter declared as a function or an array, it should apply to the function or array rather than the pointer to which the parameter is implicitly converted, but this is not yet correctly implemented.
Any list of specifiers and qualifiers at the start of a declaration may
contain attribute specifiers, whether or not such a list may in that
context contain storage class specifiers. (Some attributes, however,
are essentially in the nature of storage class specifiers, and only make
sense where storage class specifiers may be used; for example,
section
.) There is one necessary limitation to this syntax: the
first old-style parameter declaration in a function 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.
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. At present, such attribute specifiers apply
to the declared object or function, but in future they may attach to the
outermost adjacent declarator. In simple cases there is no difference,
but, for example, in
void (****f)(void) __attribute__((noreturn));
at present the noreturn
attribute applies to f
, which
causes a warning since f
is not a function, but in future it may
apply to the function ****f
. The precise semantics of what
attributes in such cases will apply to are not yet specified. Where an
assembler name for an object or function is specified (see Asm Labels), at present the attribute must follow the asm
specification; in future, attributes before the asm
specification
may apply to the adjacent declarator, and those after it to the declared
object or function.
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 parameter 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 will make 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.
If D1
has the form (
attribute-specifier-list D )
,
and the declaration T D
specifies the type
“derived-declarator-type-list Type” for ident, then
T D1
specifies the type “derived-declarator-type-list
attribute-specifier-list Type” for ident.
If D1
has the form *
type-qualifier-and-attribute-specifier-list D
, and the
declaration T D
specifies the type
“derived-declarator-type-list Type” for ident, then
T D1
specifies the type “derived-declarator-type-list
type-qualifier-and-attribute-specifier-list Type” for
ident.
For example,
void (__attribute__((noreturn)) ****f) (void);
specifies the type “pointer to pointer to pointer to pointer to
non-returning function returning void
”. As another example,
char *__attribute__((aligned(8))) *f;
specifies the type “pointer to 8-byte-aligned pointer to char
”.
Note again that this does not work with most attributes; for example,
the usage of `aligned' and `noreturn' attributes given above
is not yet supported.
For compatibility with existing code written for compiler versions that did not implement attributes on nested declarators, some laxity is allowed in the placing of attributes. If an attribute that only applies to types is applied to a declaration, it will be treated as applying to the type of that declaration. If an attribute that only applies to declarations is applied to the type of a declaration, it will be treated as applying to that declaration; and, for compatibility with code placing the attributes immediately before the identifier declared, such an attribute applied to a function return type will be treated as applying to the function type, and such an attribute applied to an array element type will be treated as applying to the array type. If an attribute that only applies to function types is applied to a pointer-to-function type, it will be treated as applying to the pointer target type; if such an attribute is applied to a function return type that is not a pointer-to-function type, it will be treated as applying to the function type.
GNU C extends ISO C to allow a function prototype to override a later old-style non-prototype definition. Consider the following example:
/* Use prototypes unless the compiler is old-fashioned. */ #ifdef __STDC__ #define P(x) x #else #define P(x) () #endif /* Prototype function declaration. */ int isroot P((uid_t)); /* Old-style function definition. */ int isroot (x) /* ??? lossage here ??? */ uid_t x; { return x == 0; }
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.
In GNU C, you may use C++ style comments, which start with `//' and continue until the end of the line. Many other C implementations allow such comments, and they are included in the 1999 C standard. However, C++ style comments are not recognized if you specify an -std option specifying a version of ISO C before C99, or -ansi (equivalent to -std=c89).
In GNU C, you may normally use dollar signs in identifier names. This is because many traditional C implementations allow such identifiers. However, dollar signs in identifiers are not supported on a few target machines, typically because the target assembler does not allow them.
You can use the sequence `\e' in a string or character constant to stand for the ASCII character <ESC>.
The keyword __alignof__
allows you to inquire about how an object
is aligned, or the minimum alignment usually required by a type. Its
syntax is just like sizeof
.
For example, if the target machine requires a double
value to be
aligned on an 8-byte boundary, then __alignof__ (double)
is 8.
This is true on many RISC machines. On more traditional machine
designs, __alignof__ (double)
is 4 or even 2.
Some machines never actually require alignment; they allow reference to any
data type even at an odd address. For these machines, __alignof__
reports the recommended alignment of a type.
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 with GCC's __attribute__
extension (see Variable Attributes). 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.
The keyword __attribute__
allows you to specify special
attributes of variables or structure fields. This keyword is followed
by an attribute specification inside double parentheses. Some
attributes are currently defined generically for variables.
Other attributes are defined for variables on particular target
systems. Other attributes are available for functions
(see Function Attributes) and for types (see Type Attributes).
Other front ends might define more attributes
(see Extensions to the C++ Language).
You may also specify attributes with `__' preceding and following
each keyword. 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 __aligned__
instead of aligned
.
See Attribute Syntax, for details of the exact syntax for using attributes.
aligned (
alignment)
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
that 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. Alternatively, you can leave out the alignment factor and just ask the compiler to align a variable or field to the maximum useful alignment for the target machine you are compiling for. For example, you could write:
short array[3] __attribute__ ((aligned));
Whenever you leave out the alignment factor in an aligned
attribute
specification, the compiler automatically sets the alignment for the declared
variable or field to the largest alignment which is ever used for any data
type on the target machine you are compiling for. Doing this can often make
copy operations more 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.
The aligned
attribute can only increase the alignment; but you
can decrease it by specifying packed
as well. See below.
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__
will still only provide you with 8 byte
alignment. See your linker documentation for further information.
cleanup (
cleanup_function)
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
will be 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
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.
deprecated
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 deprecated
attribute can also be used for functions and
types (see Function Attributes, see Type Attributes.)
mode (
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
packed
attribute specifies that a variable or structure field
should have the smallest possible alignment—one byte for a variable,
and one bit for a field, unless you specify a larger value with the
aligned
attribute.
Here is a structure in which the field x
is packed, so that it
immediately follows a
:
struct foo { char a; int x[2] __attribute__ ((packed)); };
section ("
section-name")
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 }; char stack[10000] __attribute__ ((section ("STACK"))) = { 0 }; int init_data __attribute__ ((section ("INITDATA"))) = 0; main() { /* Initialize stack pointer */ init_sp (stack + sizeof (stack)); /* Initialize initialized data */ memcpy (&init_data, &data, &edata - &data); /* Turn on the serial ports */ init_duart (&a); init_duart (&b); }
Use the section
attribute with an initialized definition
of a global variable, as shown in the example. GCC issues
a warning and otherwise ignores the section
attribute in
uninitialized variable declarations.
You may only use the section
attribute with a fully initialized
global definition because of the way linkers work. The linker requires
each object be defined once, with the exception that uninitialized
variables tentatively go in the common
(or bss
) section
and can be multiply “defined”. You can force a variable to be
initialized with the -fno-common flag or the nocommon
attribute.
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.
shared
shared
and marking the section
shareable:
int foo __attribute__((section ("shared"), shared)) = 0; int main() { /* Read and write foo. All running copies see the same value. */ return 0; }
You may only use the shared
attribute along with section
attribute with a fully initialized global definition because of the way
linkers work. See section
attribute for more information.
The shared
attribute is only available on Microsoft Windows.
tls_model ("
tls_model")
tls_model
attribute sets thread-local storage model
(see Thread-Local) of a particular __thread
variable,
overriding -ftls-model=
command line switch on a per-variable
basis.
The tls_model argument should be one of global-dynamic
,
local-dynamic
, initial-exec
or local-exec
.
Not all targets support this attribute.
transparent_union
typedef
for a union data type; then it
applies to all function parameters with that type.
unused
vector_size (
bytes)
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 (a vector of
4 units of 4 bytes), the corresponding mode of foo
will be V4SI.
This attribute is only applicable to integral and float scalars, although arrays, 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
.
weak
weak
attribute is described in See Function Attributes.
dllimport
dllimport
attribute is described in See Function Attributes.
dlexport
dllexport
attribute is described in See Function Attributes.
One attribute is currently defined for the M32R/D.
model (
model-name)
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).
Medium and large model objects may live anywhere in the 32-bit address space
(the compiler will generate seth/add3
instructions to load their
addresses).
Two attributes are currently defined for i386 configurations:
ms_struct
and gcc_struct
ms_struct
gcc_struct
packed
is used on a structure, or if bit-fields are used
it may be that the Microsoft ABI packs them differently
than GCC would normally pack them. 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.
Currently -m[no-]ms-bitfields is provided for the Microsoft Windows X86 compilers to match the native Microsoft compiler.
The keyword __attribute__
allows you to specify special
attributes of struct
and union
types when you define such
types. This keyword is followed by an attribute specification inside
double parentheses. Six attributes are currently defined for types:
aligned
, packed
, transparent_union
, unused
,
deprecated
and may_alias
. Other attributes are defined for
functions (see Function Attributes) and for variables
(see Variable Attributes).
You may also specify any one of these attributes with `__'
preceding and following its keyword. This allows you to use these
attributes in header files without being concerned about a possible
macro of the same name. For example, you may use __aligned__
instead of aligned
.
You may specify the aligned
and transparent_union
attributes either in a typedef
declaration or just past the
closing curly brace of a complete enum, struct or union type
definition and the packed
attribute only past the closing
brace of a definition.
You may also specify attributes between the enum, struct or union tag and the name of the type rather than after the closing brace.
See Attribute Syntax, for details of the exact syntax for using attributes.
aligned (
alignment)
struct S { short f[3]; } __attribute__ ((aligned (8))); typedef int more_aligned_int __attribute__ ((aligned (8)));
force the compiler to insure (as far as it can) that each variable whose
type is struct S
or more_aligned_int
will be allocated and
aligned at least on a 8-byte boundary. On a SPARC, having all
variables of type struct S
aligned to 8-byte boundaries allows
the compiler to use the ldd
and std
(doubleword load and
store) instructions when copying one variable of type struct S
to
another, thus improving run-time efficiency.
Note that the alignment of any given struct
or union
type
is required by the ISO C standard to be at least a perfect multiple of
the lowest common multiple of the alignments of all of the members of
the struct
or union
in question. This means that you can
effectively adjust the alignment of a struct
or union
type by attaching an aligned
attribute to any one of the members
of such a type, but the notation illustrated in the example above is a
more obvious, intuitive, and readable way to request the compiler to
adjust the alignment of an entire struct
or union
type.
As in the preceding example, you can explicitly specify the alignment
(in bytes) that you wish the compiler to use for a given struct
or union
type. Alternatively, you can leave out the alignment factor
and just ask the compiler to align a type to the maximum
useful alignment for the target machine you are compiling for. For
example, you could write:
struct S { short f[3]; } __attribute__ ((aligned));
Whenever you leave out the alignment factor in an aligned
attribute specification, the compiler automatically sets the alignment
for the type to the largest alignment which is ever used for any data
type on the target machine you are compiling for. Doing this can often
make copy operations more efficient, because the compiler can use
whatever instructions copy the biggest chunks of memory when performing
copies to or from the variables which have types that you have aligned
this way.
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 which 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 will also be doing pointer arithmetic (or subscripting, which amounts to the same thing) on pointers to the relevant type, and the code that the compiler generates for these pointer arithmetic operations will often be more efficient for efficiently-aligned types than for other types.
The aligned
attribute can only increase the alignment; but you
can decrease it by specifying packed
as well. See below.
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__
will still only provide you with 8 byte
alignment. See your linker documentation for further information.
packed
struct
or union
type
definition, specifies that each member of the structure or union is
placed to minimize the memory required. When attached to an enum
definition, it indicates that the smallest integral type should be used.
Specifying this attribute for struct
and union
types is
equivalent to specifying the packed
attribute on each of the
structure or union members. Specifying the -fshort-enums
flag on the line is equivalent to specifying the packed
attribute on all enum
definitions.
In the following example struct my_packed_struct
's members are
packed closely together, but the internal layout of its s
member
is not packed – to do that, struct my_unpacked_struct
would need to
be packed too.
struct my_unpacked_struct { char c; int i; }; struct my_packed_struct __attribute__ ((__packed__)) { char c; int i; struct my_unpacked_struct s; };
You may only specify this attribute on the definition of a enum
,
struct
or union
, not on a typedef
which does not
also define the enumerated type, structure or union.
transparent_union
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 representation; this is necessary for this argument passing to work properly.
Transparent unions are designed for library functions that have multiple
interfaces 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 { int *__ip; union wait *__up; } wait_status_ptr_t __attribute__ ((__transparent_union__)); pid_t wait (wait_status_ptr_t);
This interface allows either int *
or union wait *
arguments to be passed, using the int *
calling convention.
The program can call wait
with arguments of either type:
int w1 () { int w; return wait (&w); } int w2 () { union wait w; return wait (&w); }
With this interface, wait
's implementation might look like this:
pid_t wait (wait_status_ptr_t p) { return waitpid (-1, p.__ip, 0); }
unused
union
or a struct
),
this attribute means that variables of that type are meant to appear
possibly unused. GCC will 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.
deprecated
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 deprecated
attribute can also be used for functions and
variables (see Function Attributes, see Variable Attributes.)
may_alias
char
type. See
-fstrict-aliasing for more information on aliasing issues.
Example of use:
typedef short __attribute__((__may_alias__)) short_a; 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 program would abort when compiled with
-fstrict-aliasing, which is on by default at -O3 or
above in MirOS GCC versions.
Two attributes are currently defined for i386 configurations:
ms_struct
and gcc_struct
ms_struct
gcc_struct
packed
is used on a structure, or if bit-fields are used
it may be that the Microsoft ABI packs them differently
than GCC would normally pack them. 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.
Currently -m[no-]ms-bitfields is provided for the Microsoft Windows X86 compilers to match the native Microsoft compiler.
To specify multiple attributes, separate them by commas within the double parentheses: for example, `__attribute__ ((aligned (16), packed))'.
By declaring a function inline
, you can direct GCC to
integrate that function's code into the code for its callers. This
makes execution faster by eliminating the function-call overhead; in
addition, if any of the actual argument values are constant, their known
values may permit simplifications at compile time so that not all of the
inline function's code needs to be included. The effect on code size is
less predictable; object code may be larger or smaller with function
inlining, depending on the particular case. Inlining of functions is an
optimization and it really “works” only in optimizing compilation. If
you don't use -O, no function is really inline.
Inline functions are included in the ISO C99 standard, but there are currently substantial differences between what GCC implements and what the ISO C99 standard requires.
To declare a function inline, use the inline
keyword in its
declaration, like this:
inline int inc (int *a) { (*a)++; }
(If you are writing a header file to be included in ISO C programs, write
__inline__
instead of inline
. See Alternate Keywords.)
You can also make all “simple enough” functions inline with the option
-finline-functions.
Note that certain usages in a function definition can make it unsuitable
for inline substitution. Among these usages are: use of varargs, use of
alloca, use of variable sized data types (see Variable Length),
use of computed goto (see Labels as Values), use of nonlocal goto,
and nested functions (see Nested Functions). Using -Winline
will warn when a function marked inline
could not be substituted,
and will give the reason for the failure.
Note that in C and Objective-C, unlike C++, the inline
keyword
does not affect the linkage of the function.
GCC automatically inlines member functions defined within the class
body of C++ programs even if they are not explicitly declared
inline
. (You can override this with -fno-default-inline;
see Options Controlling C++ Dialect.)
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.
Some calls cannot be integrated for various reasons (in particular,
calls that precede the function's definition cannot be integrated, and
neither can recursive calls within the definition). 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 can't be inlined.
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 will cause most calls to the function
to be inlined. If any uses of the function remain, they will refer to
the single copy in the library.
Since GCC eventually will implement ISO C99 semantics for
inline functions, it is best to use static inline
only
to guarantee compatibility. (The
existing semantics will remain available when -std=gnu89 is
specified, but eventually the default will be -std=gnu99 and
that will implement the C99 semantics, though it does not do so yet.)
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));
In an assembler instruction using asm
, you can specify the
operands of the instruction using C expressions. This means you need not
guess which registers or memory locations will contain the data you want
to use.
You must specify an assembler instruction template much like what appears in a machine description, plus an operand constraint string for each operand.
For example, here is how to use the 68881's fsinx
instruction:
asm ("fsinx %1,%0" : "=f" (result) : "f" (angle));
Here angle
is the C expression for the input operand while
result
is that of the output operand. Each has `"f"' as its
operand constraint, saying that a floating point register is required.
The `=' in `=f' indicates that the operand is an output; all
output operands' constraints must use `='. The constraints use the
same language used in the machine description (see Constraints).
Each operand is described by an operand-constraint string followed by the C expression in parentheses. A colon separates the assembler template from the first output operand and another separates the last output operand from the first input, if any. Commas separate the operands within each group. The total number of operands is currently limited to 30; this limitation may be lifted in some future version of GCC.
If there are no output operands but there are input operands, you must place two consecutive colons surrounding the place where the output operands would go.
As of GCC version 3.1, it is also possible to specify input and output
operands using symbolic names which can be referenced within the
assembler code. These names are specified inside square brackets
preceding the constraint string, and can be referenced inside the
assembler code using %[
name]
instead of a percentage sign
followed by the operand number. Using named operands the above example
could look like:
asm ("fsinx %[angle],%[output]" : [output] "=f" (result) : [angle] "f" (angle));
Note that the symbolic operand names have no relation whatsoever to other C identifiers. You may use any name you like, even those of existing C symbols, but you must ensure that no two operands within the same assembler construct use the same symbolic name.
Output operand expressions must be lvalues; the compiler can check this.
The input operands need not be lvalues. The compiler cannot check
whether the operands have data types that are reasonable for the
instruction being executed. It does not parse the assembler instruction
template and does not know what it means or even whether it is valid
assembler input. The extended asm
feature is most often used for
machine instructions the compiler itself does not know exist. If
the output expression cannot be directly addressed (for example, it is a
bit-field), your constraint must allow a register. In that case, GCC
will use the register as the output of the asm
, and then store
that register into the output.
The ordinary output operands must be write-only; GCC will assume that the values in these operands before the instruction are dead and need not be generated. Extended asm supports input-output or read-write operands. Use the constraint character `+' to indicate such an operand and list it with the output operands. You should only use read-write operands when the constraints for the operand (or the operand in which only some of the bits are to be changed) allow a register.
You may, as an alternative, logically split its function into two
separate operands, one input operand and one write-only output
operand. The connection between them is expressed by constraints
which say they need to be in the same location when the instruction
executes. You can use the same C expression for both operands, or
different expressions. For example, here we write the (fictitious)
`combine' instruction with bar
as its read-only source
operand and foo
as its read-write destination:
asm ("combine %2,%0" : "=r" (foo) : "0" (foo), "g" (bar));
The constraint `"0"' for operand 1 says that it must occupy the same location as operand 0. A number in constraint is allowed only in an input operand and it must refer to an output operand.
Only a number in the constraint can guarantee that one operand will be in
the same place as another. The mere fact that foo
is the value
of both operands is not enough to guarantee that they will be in the
same place in the generated assembler code. The following would not
work reliably:
asm ("combine %2,%0" : "=r" (foo) : "r" (foo), "g" (bar));
Various optimizations or reloading could cause operands 0 and 1 to be in
different registers; GCC knows no reason not to do so. For example, the
compiler might find a copy of the value of foo
in one register and
use it for operand 1, but generate the output operand 0 in a different
register (copying it afterward to foo
's own address). Of course,
since the register for operand 1 is not even mentioned in the assembler
code, the result will not work, but GCC can't tell that.
As of GCC version 3.1, one may write [
name]
instead of
the operand number for a matching constraint. For example:
asm ("cmoveq %1,%2,%[result]" : [result] "=r"(result) : "r" (test), "r"(new), "[result]"(old));
Some instructions clobber specific hard registers. To describe this, write a third colon after the input operands, followed by the names of the clobbered hard registers (given as strings). Here is a realistic example for the VAX:
asm volatile ("movc3 %0,%1,%2" : /* no outputs */ : "g" (from), "g" (to), "g" (count) : "r0", "r1", "r2", "r3", "r4", "r5");
You may not write a clobber description in a way that overlaps with an
input or output operand. For example, you may not have an operand
describing a register class with one member if you mention that register
in the clobber list. Variables declared to live in specific registers
(see Explicit Reg Vars), and used as asm input or output operands must
have no part mentioned in the clobber description.
There is no way for you to specify that an input
operand is modified without also specifying it as an output
operand. Note that if all the output operands you specify are for this
purpose (and hence unused), you will then also need to specify
volatile
for the asm
construct, as described below, to
prevent GCC from deleting the asm
statement as unused.
If you refer to a particular hardware register from the assembler code, you will probably have to list the register after the third colon to tell the compiler the register's value is modified. In some assemblers, the register names begin with `%'; to produce one `%' in the assembler code, you must write `%%' in the input.
If your assembler instruction can alter the condition code register, add `cc' to the list of clobbered registers. GCC on some machines represents the condition codes as a specific hardware register; `cc' serves to name this register. On other machines, the condition code is handled differently, and specifying `cc' has no effect. But it is valid no matter what the machine.
If your assembler instructions access memory in an unpredictable
fashion, add `memory' to the list of clobbered registers. This
will cause GCC to not keep memory values cached in registers across the
assembler instruction and not optimize stores or loads to that memory.
You will also want to add the volatile
keyword if the memory
affected is not listed in the inputs or outputs of the asm
, as
the `memory' clobber does not count as a side-effect of the
asm
. If you know how large the accessed memory is, you can add
it as input or output but if this is not known, you should add
`memory'. As an example, if you access ten bytes of a string, you
can use a memory input like:
{"m"( ({ struct { char x[10]; } *p = (void *)ptr ; *p; }) )}.
Note that in the following example the memory input is necessary,
otherwise GCC might optimize the store to x
away:
int foo () { int x = 42; int *y = &x; int result; asm ("magic stuff accessing an 'int' pointed to by '%1'" "=&d" (r) : "a" (y), "m" (*y)); return result; }
You can put multiple assembler instructions together in a single
asm
template, 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 to move to the instruction field
(written as `\n\t'). Sometimes semicolons can be used, if the
assembler allows semicolons as a line-breaking character. Note that some
assembler dialects use semicolons to start a comment.
The input operands are guaranteed not to use any of the clobbered
registers, and neither will the output operands' addresses, so you can
read and write the clobbered registers as many times as you like. Here
is an example of multiple instructions in a template; it assumes the
subroutine _foo
accepts arguments in registers 9 and 10:
asm ("movl %0,r9\n\tmovl %1,r10\n\tcall _foo" : /* no outputs */ : "g" (from), "g" (to) : "r9", "r10");
Unless an output operand has the `&' constraint modifier, GCC may allocate it in the same register as an unrelated input operand, on the assumption the inputs are consumed before the outputs are produced. This assumption may be false if the assembler code actually consists of more than one instruction. In such a case, use `&' for each output operand that may not overlap an input. See Modifiers.
If you want to test the condition code produced by an assembler
instruction, you must include a branch and a label in the asm
construct, as follows:
asm ("clr %0\n\tfrob %1\n\tbeq 0f\n\tmov #1,%0\n0:" : "g" (result) : "g" (input));
This assumes your assembler supports local labels, as the GNU assembler and most Unix assemblers do.
Speaking of labels, jumps from one asm
to another are not
supported. The compiler's optimizers do not know about these jumps, and
therefore they cannot take account of them when deciding how to
optimize.
Usually the most convenient way to use these asm
instructions is to
encapsulate them in macros that look like functions. For example,
#define sin(x) \ ({ double __value, __arg = (x); \ asm ("fsinx %1,%0": "=f" (__value): "f" (__arg)); \ __value; })
Here the variable __arg
is used to make sure that the instruction
operates on a proper double
value, and to accept only those
arguments x
which can convert automatically to a double
.
Another way to make sure the instruction operates on the correct data
type is to use a cast in the asm
. This is different from using a
variable __arg
in that it converts more different types. For
example, if the desired type were int
, casting the argument to
int
would accept a pointer with no complaint, while assigning the
argument to an int
variable named __arg
would warn about
using a pointer unless the caller explicitly casts it.
If an asm
has output operands, GCC assumes for optimization
purposes the instruction has no side effects except to change the output
operands. This does not mean instructions with a side effect cannot be
used, but you must be careful, because the compiler may eliminate them
if the output operands aren't used, or move them out of loops, or
replace two with one if they constitute a common subexpression. Also,
if your instruction does have a side effect on a variable that otherwise
appears not to change, the old value of the variable may be reused later
if it happens to be found in a register.
You can prevent an asm
instruction from being deleted, moved
significantly, or combined, by writing the keyword volatile
after
the asm
. For example:
#define get_and_set_priority(new) \ ({ int __old; \ asm volatile ("get_and_set_priority %0, %1" \ : "=g" (__old) : "g" (new)); \ __old; })
If you write an asm
instruction with no outputs, GCC will know
the instruction has side-effects and will not delete the instruction or
move it outside of loops.
The volatile
keyword indicates that the instruction has
important side-effects. GCC will not delete a volatile asm
if
it is reachable. (The instruction can still be deleted if GCC can
prove that control-flow will never reach the location of the
instruction.) In addition, GCC will not reschedule instructions
across a volatile asm
instruction. For example:
*(volatile int *)addr = foo; asm volatile ("eieio" : : );
Assume addr
contains the address of a memory mapped device
register. The PowerPC eieio
instruction (Enforce In-order
Execution of I/O) tells the CPU to make sure that the store to that
device register happens before it issues any other I/O.
Note that even a volatile asm
instruction can be moved in ways
that appear insignificant to the compiler, such as across jump
instructions. You can't expect a sequence of volatile asm
instructions to remain perfectly consecutive. If you want consecutive
output, use a single asm
. Also, GCC will perform some
optimizations across a volatile asm
instruction; GCC does not
“forget everything” when it encounters a volatile asm
instruction the way some other compilers do.
An asm
instruction without any operands or clobbers (an “old
style” asm
) will be treated identically to a volatile
asm
instruction.
It is a natural idea to look for a way to give access to the condition code left by the assembler instruction. However, when we attempted to implement this, we found no way to make it work reliably. The problem is that output operands might need reloading, which would result in additional following “store” instructions. On most machines, these instructions would alter the condition code before there was time to test it. This problem doesn't arise for ordinary “test” and “compare” instructions because they don't have any output operands.
For reasons similar to those described above, it is not possible to give an assembler instruction access to the condition code left by previous instructions.
If you are writing a header file that should be includable in ISO C
programs, write __asm__
instead of asm
. See Alternate Keywords.
asm
Some targets require that GCC track the size of each instruction used in
order to generate correct code. Because the final length of an
asm
is only known by the assembler, GCC must make an estimate as
to how big it will be. The estimate is formed by counting the number of
statements in the pattern of the asm
and multiplying that by the
length of the longest instruction on that processor. Statements in the
asm
are identified by newline characters and whatever statement
separator characters are supported by the assembler; on most processors
this is the `;
' character.
Normally, GCC's estimate is perfectly adequate to ensure that correct code is generated, but it is possible to confuse the compiler if you use pseudo instructions or assembler macros that expand into multiple real instructions or if you use assembler directives that expand to more space in the object file than would be needed for a single instruction. If this happens then the assembler will produce a diagnostic saying that a label is unreachable.
There are several rules on the usage of stack-like regs in asm_operands insns. These rules apply only to the operands that are stack-like regs:
An input reg that is implicitly popped by the asm must be explicitly clobbered, unless it is constrained to match an output operand.
All implicitly popped input regs must be closer to the top of the reg-stack than any input that is not implicitly popped.
It is possible that if an input dies in an insn, reload might use the input reg for an output reload. Consider this example:
asm ("foo" : "=t" (a) : "f" (b));
This asm says that input B is not popped by the asm, and that the asm pushes a result onto the reg-stack, i.e., the stack is one deeper after the asm than it was before. But, it is possible that reload will think that it can use the same reg for both the input and the output, if input B dies in this insn.
If any input operand uses the f
constraint, all output reg
constraints must use the &
earlyclobber.
The asm above would be written as
asm ("foo" : "=&t" (a) : "f" (b));
Output operands must specifically indicate which reg an output
appears in after an asm. =f
is not allowed: the operand
constraints must select a class with a single reg.
Output operands must start at the top of the reg-stack: output operands may not “skip” a reg.
Here are a couple of reasonable asms to want to write. 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 user must code the st(1)
clobber for reg-stack.c to know that fyl2xp1
pops both inputs.
asm ("fyl2xp1" : "=t" (result) : "0" (x), "u" (y) : "st(1)");
asm
Operands
Here are specific details on what constraint letters you can use with
asm
operands.
Constraints can say whether
an operand may be in a register, and which kinds of register; whether the
operand can be a memory reference, and which kinds of address; whether the
operand may be an immediate constant, and which possible values it may
have. Constraints can also require two operands to match.
The simplest kind of constraint is a string full of letters, each of which describes one kind of operand that is permitted. Here are the letters that are allowed:
For example, an address which is constant is offsettable; so is an address that is the sum of a register and a constant (as long as a slightly larger constant is also within the range of address-offsets supported by the machine); but an autoincrement or autodecrement address is not offsettable. More complicated indirect/indexed addresses may or may not be offsettable depending on the other addressing modes that the machine supports.
Note that in an output operand which can be matched by another operand, the constraint letter `o' is valid only when accompanied by both `<' (if the target machine has predecrement addressing) and `>' (if the target machine has preincrement addressing).
const_double
) is
allowed, but only if the target floating point format is the same as
that of the host machine (on which the compiler is running).
const_double
or
const_vector
) is allowed.
This might appear strange; if an insn allows a constant operand with a value not known at compile time, it certainly must allow any known value. So why use `s' instead of `i'? Sometimes it allows better code to be generated.
For example, on the 68000 in a fullword instruction it is possible to use an immediate operand; but if the immediate value is between −128 and 127, better code results from loading the value into a register and using the register. This is because the load into the register can be done with a `moveq' instruction. We arrange for this to happen by defining the letter `K' to mean “any integer outside the range −128 to 127”, and then specifying `Ks' in the operand constraints.
This number is allowed to be more than a single digit. If multiple digits are encountered 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 assembler 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' 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.
Sometimes a single instruction has multiple alternative sets of possible operands. For example, on the 68000, a logical-or instruction can combine register or an immediate value into memory, or it can combine any kind of operand into a register; but it cannot combine one memory location into another.
These constraints are represented as multiple alternatives. An alternative can be described by a series of letters for each operand. The overall constraint for an operand is made from the letters for this operand from the first alternative, a comma, the letters for this operand from the second alternative, a comma, and so on until the last alternative.
If all the operands fit any one alternative, the instruction is valid. Otherwise, for each alternative, the compiler counts how many instructions must be added to copy the operands so that that alternative applies. The alternative requiring the least copying is chosen. If two alternatives need the same amount of copying, the one that comes first is chosen. These choices can be altered with the `?' and `!' characters:
?
!
Here are constraint modifier characters.
When the compiler fixes up the operands to satisfy the constraints, it needs to know which operands are inputs to the instruction and which are outputs from it. `=' identifies an output; `+' identifies an operand that is both input and output; all other operands are assumed to be input only.
If you specify `=' or `+' in a constraint, you put it in the first character of the constraint string.
`&' applies only to the alternative in which it is written. In constraints with multiple alternatives, sometimes one alternative requires `&' while others do not. See, for example, the `movdf' insn of the 68000.
An input operand can be tied to an earlyclobber operand if its only use as an input occurs before the early result is written. Adding alternatives of this form often allows GCC to produce better code when only some of the inputs can be affected by the earlyclobber. See, for example, the `mulsi3' insn of the ARM.
`&' does not obviate the need to write `='.
Whenever possible, you should use the general-purpose constraint letters
in asm
arguments, since they will convey meaning more readily to
people reading your code. Failing that, use the constraint letters
that usually have very similar meanings across architectures. The most
commonly used constraints are `m' and `r' (for memory and
general-purpose registers respectively; see Simple Constraints), and
`I', usually the letter indicating the most common
immediate-constant format.
For each machine architecture, the
config/machine/machine.h file defines additional
constraints. These constraints are used by the compiler itself for
instruction generation, as well as for asm
statements; therefore,
some of the constraints are not particularly interesting for asm
.
The constraints are defined through these macros:
REG_CLASS_FROM_LETTER
CONST_OK_FOR_LETTER_P
CONST_DOUBLE_OK_FOR_LETTER_P
EXTRA_CONSTRAINT
Inspecting these macro definitions in the compiler source for your machine is the best way to be certain you have the right constraints. However, here is a summary of the machine-dependent constraints available on some particular machines.
f
F
G
I
J
K
L
M
Q
asm
statements)
R
S
l
a
d
w
e
b
q
t
x
y
z
I
J
K
L
M
N
O
P
G
b
f
v
h
q
c
l
x
y
z
I
J
SImode
constants)
K
L
M
N
O
P
G
Q
asm
statements)
R
S
T
U
q
b
, c
, or d
register for the i386.
For x86-64 it is equivalent to `r' class. (for 8-bit instructions that
do not use upper halves)
Q
b
, c
, or d
register. (for 8-bit instructions,
that do use upper halves)
R
r
class in i386 mode.
(for non-8-bit registers used together with 8-bit upper halves in a single
instruction)
A
f
t
u
a
b
c
C
d
D
S
x
y
I
J
K
L
M
lea
instruction)
N
out
instruction)
Z
0xffffffff
or symbolic reference known to fit specified range.
(for using immediates in zero extending 32-bit to 64-bit x86-64 instructions)
e
G
f
fp0
to fp3
)
l
r0
to r15
)
b
g0
to g15
)
d
I
J
K
G
H
a
r0
to r3
for addl
instruction
b
c
d
e
f
m
G
I
J
K
L
M
N
O
P
dep
instruction
Q
R
shladd
instruction
S
a
ACC_REGS
(acc0
to acc7
).
b
EVEN_ACC_REGS
(acc0
to acc7
).
c
CC_REGS
(fcc0
to fcc3
and
icc0
to icc3
).
d
GPR_REGS
(gr0
to gr63
).
e
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
FPR_REGS
(fr0
to fr63
).
h
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
LR_REG
(the lr
register).
q
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
ICC_REGS
(icc0
to icc3
).
u
FCC_REGS
(fcc0
to fcc3
).
v
ICR_REGS
(cc4
to cc7
).
w
FCR_REGS
(cc0
to cc3
).
x
QUAD_FPR_REGS
(fr0
to fr63
).
Register numbers not divisible by 4 are excluded not in the class but through
the use of a machine mode larger than 8 bytes.
z
SPR_REGS
(lcr
and lr
).
A
QUAD_ACC_REGS
(acc0
to acc7
).
B
ACCG_REGS
(accg0
to accg7
).
C
CR_REGS
(cc0
to cc7
).
G
I
J
L
M
N
O
P
a
f
j
k
b
y
z
q
c
d
u
R
QImode
, since we
can't access extra bytes
S
T
I
J
K
L
M
N
O
P
d
f
h
l
x
y
z
I
J
K
L
lui
)
M
N
O
P
G
Q
asm
statements)
R
asm
statements)
S
asm
statements)
a
d
f
I
J
K
L
M
G
a
b
d
q
t
u
w
x
y
z
A
B
D
L
M
N
O
P
f
e
c
d
b
h
I
J
K
sethi
instruction)
L
movcc
instructions
M
movrcc
instructions
N
SImode
O
G
H
Q
R
S
T
U
W
a
b
c
f
k
q
t
u
v
x
y
z
G
H
I
J
K
L
M
N
O
Q
R
S
T
U
a
d
f
I
J
K
L
(0..4095)
(-524288..524287)
M
N
0..9:
H,Q:
D,S,H:
0,F:
Q
R
S
T
U
W
Y
a
b
c
d
e
t
y
z
I
J
K
L
M
N
O
P
Q
R
S
T
U
Z
a
b
A
I
J
K
L
You can specify the name to be used in the assembler code for a C
function or variable by writing the asm
(or __asm__
)
keyword after the declarator as follows:
int foo asm ("myfoo") = 2;
This specifies that the name to be used for the variable foo
in
the assembler code should be `myfoo' rather than the usual
`_foo'.
On systems where an underscore is normally prepended to the name of a C function or variable, this feature allows you to define names for the linker that do not start with an underscore.
It does not make sense to use this feature with a non-static local variable since such variables do not have assembler names. If you are trying to put the variable in a particular register, see Explicit Reg Vars. GCC presently accepts such code with a warning, but will probably be changed to issue an error, rather than a warning, in the future.
You cannot use asm
in this way in a function definition; but
you can get the same effect by writing a declaration for the function
before its definition and putting asm
there, like this:
extern func () asm ("FUNC");
func (x, y)
int x, y;
/* ... */
It is up to you to make sure that the assembler names you choose do not conflict with any other assembler symbols. Also, you must not use a register name; that would produce completely invalid assembler code. GCC does not as yet have the ability to store static variables in registers. Perhaps that will be added.
GNU C allows you to put a few global variables into specified hardware registers. You can also specify the register in which an ordinary register variable should be allocated.
These local variables are sometimes convenient for use with the extended
asm
feature (see Extended Asm), if you want to write one
output of the assembler instruction directly into a particular register.
(This will work provided the register you specify fits the constraints
specified for that operand in the asm
.)
You can define a global register variable in GNU C like this:
register int *foo asm ("a5");
Here a5
is the name of the register which should be used. Choose a
register which is normally saved and restored by function calls on your
machine, so that library routines will not clobber it.
Naturally the register name is cpu-dependent, so you would need to
conditionalize your program according to cpu type. The register
a5
would be a good choice on a 68000 for a variable of pointer
type. On machines with register windows, be sure to choose a “global”
register that is not affected magically by the function call mechanism.
In addition, operating systems on one type of cpu may differ in how they
name the registers; then you would need additional conditionals. For
example, some 68000 operating systems call this register %a5
.
Eventually there may be a way of asking the compiler to choose a register automatically, but first we need to figure out how it should choose and how to enable you to guide the choice. No solution is evident.
Defining a global register variable in a certain register reserves that register entirely for this use, at least within the current compilation. The register will not be allocated for any other purpose in the functions in the current compilation. The register will not be saved and restored by these functions. Stores into this register are never deleted even if they would appear to be dead, but references may be deleted or moved or simplified.
It is not safe to access the global register variables from signal handlers, or from more than one thread of control, because the system library routines may temporarily use the register for other things (unless you recompile them specially for the task at hand).
It is not safe for one function that uses a global register variable to
call another such function foo
by way of a third function
lose
that was compiled without knowledge of this variable (i.e. in a
different source file in which the variable wasn't declared). This is
because lose
might save the register and put some other value there.
For example, you can't expect a global register variable to be available in
the comparison-function that you pass to qsort
, since qsort
might have put something else in that register. (If you are prepared to
recompile qsort
with the same global register variable, you can
solve this problem.)
If you want to recompile qsort
or other source files which do not
actually use your global register variable, so that they will not use that
register for any other purpose, then it suffices to specify the compiler
option -ffixed-reg. You need not actually add a global
register declaration to their source code.
A function which can alter the value of a global register variable cannot safely be called from a function compiled without this variable, because it could clobber the value the caller expects to find there on return. Therefore, the function which is the entry point into the part of the program that uses the global register variable must explicitly save and restore the value which belongs to its caller.
On most machines, longjmp
will restore to each global register
variable the value it had at the time of the setjmp
. On some
machines, however, longjmp
will 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 will happen regardless of what longjmp
does.
All global register variable declarations must precede all function definitions. If such a declaration could appear after function definitions, the declaration would be too late to prevent the register from being used for other purposes in the preceding functions.
Global register variables may not have initial values, because an executable file has no means to supply initial contents for a register.
On the SPARC, there are reports that g3 ... g7 are suitable
registers, but certain library functions, such as getwd
, as well
as the subroutines for division and remainder, modify g3 and g4. g1 and
g2 are local temporaries.
On the 68000, a2 ... a5 should be suitable, as should d2 ... d7. Of course, it will not do to use more than a few of those.
You can define a local register variable with a specified register like this:
register int *foo asm ("a5");
Here a5
is the name of the register which should be used. Note
that this is the same syntax used for defining global register
variables, but for a local variable it would appear within a function.
Naturally the register name is cpu-dependent, but this is not a problem, since specific registers are most often useful with explicit assembler instructions (see Extended Asm). Both of these things generally require that you conditionalize your program according to cpu type.
In addition, operating systems on one type of cpu may differ in how they
name the registers; then you would need additional conditionals. For
example, some 68000 operating systems call this register %a5
.
Defining such a register variable does not reserve the register; it remains available for other uses in places where flow control determines the variable's value is not live. However, these registers are made unavailable for use in the reload pass; excessive use of this feature leaves the compiler too few available registers to compile certain functions.
This option does not guarantee that GCC will generate code that has
this variable in the register you specify at all times. You may not
code an explicit reference to this register in an asm
statement
and assume it will always refer to this variable.
Stores into local register variables may be deleted when they appear to be dead according to dataflow analysis. References to local register variables may be deleted or moved or simplified.
-ansi and the various -std options disable certain
keywords. This causes trouble when you want to use GNU C extensions, or
a general-purpose header file that should be usable by all programs,
including ISO C programs. The keywords asm
, typeof
and
inline
are not available in programs compiled with
-ansi or -std (although inline
can be used in a
program compiled with -std=c99). The ISO C99 keyword
restrict
is only available when -std=gnu99 (which will
eventually be the default) or -std=c99 (or the equivalent
-std=iso9899:1999) is used.
The way to solve these problems is to put `__' at the beginning and
end of each problematical keyword. For example, use __asm__
instead of asm
, and __inline__
instead of inline
.
Other C compilers won't accept these alternative keywords; if you want to compile with another compiler, you can define the alternate keywords as macros to replace them with the customary keywords. It looks like this:
#ifndef __GNUC__ #define __asm__ asm #endif
-pedantic and other options cause warnings for many GNU C extensions.
You can
prevent such warnings within one expression by writing
__extension__
before the expression. __extension__
has no
effect aside from this.
enum
TypesYou can define an enum
tag without specifying its possible values.
This results in an incomplete type, much like what you get if you write
struct foo
without describing the elements. A later declaration
which does specify the possible values completes the type.
You can't allocate variables or storage using the type while it is incomplete. However, you can work with pointers to that type.
This extension may not be very useful, but it makes the handling of
enum
more consistent with the way struct
and union
are handled.
This extension is not supported by GNU C++.
GCC provides three magic variables which hold the name of the current
function, as a string. The first of these is __func__
, which
is part of the C99 standard:
The identifier__func__
is implicitly declared by the translator as if, immediately following the opening brace of each function definition, the declarationstatic const char __func__[] = "function-name";appeared, where function-name is the name of the lexically-enclosing function. This name is the unadorned name of the function.
__FUNCTION__
is another name for __func__
. Older
versions of GCC recognize only this name. However, it is not
standardized. For maximum portability, we recommend you use
__func__
, but provide a fallback definition with the
preprocessor:
#if __STDC_VERSION__ < 199901L # if __GNUC__ >= 2 # define __func__ __FUNCTION__ # else # define __func__ "<unknown>" # endif #endif
In C, __PRETTY_FUNCTION__
is yet another name for
__func__
. However, in C++, __PRETTY_FUNCTION__
contains
the type signature of the function as well as its bare name. For
example, this program:
extern "C" { extern int printf (char *, ...); } class a { public: void sub (int i) { printf ("__FUNCTION__ = %s\n", __FUNCTION__); printf ("__PRETTY_FUNCTION__ = %s\n", __PRETTY_FUNCTION__); } }; int main (void) { a ax; ax.sub (0); return 0; }
gives this output:
__FUNCTION__ = sub __PRETTY_FUNCTION__ = void a::sub(int)
These identifiers are not preprocessor macros. In GCC 3.3 and
earlier, in C only, __FUNCTION__
and __PRETTY_FUNCTION__
were treated as string literals; they could be used to initialize
char
arrays, and they could be concatenated with other string
literals. GCC 3.4 and later treat them as variables, like
__func__
. In C++, __FUNCTION__
and
__PRETTY_FUNCTION__
have always been variables.
These functions may be used to get information about the callers of a function.
This function returns the return address of the current function, or of one of its callers. The level argument is number of frames to scan up the call stack. A value of
0
yields the return address of the current function, a value of1
yields the return address of the caller of the current function, and so forth. When inlining the expected behavior is that the function will return the address of the function that will be returned to. To work around this behavior use thenoinline
function attribute.The level argument must be a constant integer.
On some machines it may be impossible to determine the return address of any function other than the current one; in such cases, or when the top of the stack has been reached, this function will return
0
or a random value. In addition,__builtin_frame_address
may be used to determine if the top of the stack has been reached.This function should only be used with a nonzero argument for debugging purposes.
This function is similar to
__builtin_return_address
, but it returns the address of the function frame rather than the return address of the function. Calling__builtin_frame_address
with a value of0
yields the frame address of the current function, a value of1
yields the frame address of the caller of the current function, and so forth.The frame is the area on the stack which holds local variables and saved registers. The frame address is normally the address of the first word pushed on to the stack by the function. However, the exact definition depends upon the processor and the calling convention. If the processor has a dedicated frame pointer register, and the function has a frame, then
__builtin_frame_address
will return the value of the frame pointer register.On some machines it may be impossible to determine the frame address of any function other than the current one; in such cases, or when the top of the stack has been reached, this function will return
0
if the first frame pointer is properly initialized by the startup code.This function should only be used with a nonzero argument for debugging purposes.
On some targets, the instruction set contains SIMD vector instructions that operate on multiple values contained in one large register at the same time. For example, on the i386 the MMX, 3Dnow! and SSE extensions can be used this way.
The first step in using these extensions is to provide the necessary data
types. This should be done using an appropriate typedef
:
typedef int v4si __attribute__ ((mode(V4SI)));
The base type int
is effectively ignored by the compiler, the
actual properties of the new type v4si
are defined by the
__attribute__
. It defines the machine mode to be used; for vector
types these have the form V
nB; n should be the
number of elements in the vector, and B should be the base mode of the
individual elements. The following can be used as base modes:
QI
HI
SI
DI
SF
DF
Specifying a combination that is not valid for the current architecture
will cause GCC to synthesize the instructions using a narrower mode.
For example, if you specify a variable of type V4SI
and your
architecture does not allow for this specific SIMD type, GCC will
produce code that uses 4 SIs
.
The types defined in this manner can be used with a subset of normal C
operations. Currently, GCC will allow 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 will be
added to the corresponding 4 elements in b and the resulting
vector will be stored in c.
typedef int v4si __attribute__ ((mode(V4SI))); v4si a, b, c; c = a + b;
Subtraction, multiplication, division, and the logical operations operate in a similar manner. 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.
You can declare variables and use them in function calls and returns, as well as in assignments and some casts. You can specify a vector type as a return type for a function. Vector types can also be used as function arguments. It is possible to cast from one vector type to another, provided they are of the same size (in fact, you can also cast vectors to and from other datatypes of the same size).
You cannot operate between vectors of different lengths or different signedness without a cast.
A port that supports hardware vector operations, usually provides a set of built-in functions that can be used to operate on vectors. For example, a function to add two vectors and multiply the result by a third could look like this:
v4si f (v4si a, v4si b, v4si c) { v4si tmp = __builtin_addv4si (a, b); return __builtin_mulv4si (tmp, c); }
GCC provides a large number of built-in functions other than the ones mentioned above. Some of these are for internal use in the processing of exceptions or variable-length argument lists and will not be documented here because they may change from time to time; we do not recommend general use of these functions.
The remaining functions are provided for optimization purposes.
GCC includes built-in versions of many of the functions in the standard
C library. The versions prefixed with __builtin_
will always be
treated as having the same meaning as the C library function even if you
specify the -fno-builtin option. (see C Dialect Options)
Many of these functions are only optimized in certain cases; if they are
not optimized in a particular case, a call to the library function will
be emitted.
Outside strict ISO C mode (-ansi, -std=c89 or
-std=c99), the functions
_exit
, alloca
, bcmp
, bzero
,
dcgettext
, dgettext
, dremf
, dreml
,
drem
, exp10f
, exp10l
, exp10
, ffsll
,
ffsl
, ffs
, fprintf_unlocked
, fputs_unlocked
,
gammaf
, gammal
, gamma
, gettext
,
index
, j0f
, j0l
, j0
, j1f
, j1l
,
j1
, jnf
, jnl
, jn
, mempcpy
,
pow10f
, pow10l
, pow10
, printf_unlocked
,
rindex
, scalbf
, scalbl
, scalb
,
significandf
, significandl
, significand
,
sincosf
, sincosl
, sincos
, stpcpy
,
strdup
, strfmon
, y0f
, y0l
, y0
,
y1f
, y1l
, y1
, ynf
, ynl
and yn
may be handled as built-in functions.
All these functions have corresponding versions
prefixed with __builtin_
, which may be used even in strict C89
mode.
The ISO C99 functions
_Exit
, acoshf
, acoshl
, acosh
, asinhf
,
asinhl
, asinh
, atanhf
, atanhl
, atanh
,
cabsf
, cabsl
, cabs
, cacosf
, cacoshf
,
cacoshl
, cacosh
, cacosl
, cacos
,
cargf
, cargl
, carg
, casinf
, casinhf
,
casinhl
, casinh
, casinl
, casin
,
catanf
, catanhf
, catanhl
, catanh
,
catanl
, catan
, cbrtf
, cbrtl
, cbrt
,
ccosf
, ccoshf
, ccoshl
, ccosh
, ccosl
,
ccos
, cexpf
, cexpl
, cexp
, cimagf
,
cimagl
, cimag
,
conjf
, conjl
, conj
, copysignf
,
copysignl
, copysign
, cpowf
, cpowl
,
cpow
, cprojf
, cprojl
, cproj
, crealf
,
creall
, creal
, csinf
, csinhf
, csinhl
,
csinh
, csinl
, csin
, csqrtf
, csqrtl
,
csqrt
, ctanf
, ctanhf
, ctanhl
, ctanh
,
ctanl
, ctan
, erfcf
, erfcl
, erfc
,
erff
, erfl
, erf
, exp2f
, exp2l
,
exp2
, expm1f
, expm1l
, expm1
, fdimf
,
fdiml
, fdim
, fmaf
, fmal
, fmaxf
,
fmaxl
, fmax
, fma
, fminf
, fminl
,
fmin
, hypotf
, hypotl
, hypot
, ilogbf
,
ilogbl
, ilogb
, imaxabs
, lgammaf
,
lgammal
, lgamma
, llabs
, llrintf
,
llrintl
, llrint
, llroundf
, llroundl
,
llround
, log1pf
, log1pl
, log1p
,
log2f
, log2l
, log2
, logbf
, logbl
,
logb
, lrintf
, lrintl
, lrint
, lroundf
,
lroundl
, lround
, nearbyintf
, nearbyintl
,
nearbyint
, nextafterf
, nextafterl
,
nextafter
, nexttowardf
, nexttowardl
,
nexttoward
, remainderf
, remainderl
,
remainder
, remquof
, remquol
, remquo
,
rintf
, rintl
, rint
, roundf
, roundl
,
round
, scalblnf
, scalblnl
, scalbln
,
scalbnf
, scalbnl
, scalbn
, snprintf
,
tgammaf
, tgammal
, tgamma
, truncf
,
truncl
, trunc
, vfscanf
, vscanf
,
vsnprintf
and vsscanf
are handled as built-in functions
except in strict ISO C90 mode (-ansi or -std=c89).
There are also built-in versions of the ISO C99 functions
acosf
, acosl
, asinf
, asinl
, atan2f
,
atan2l
, atanf
, atanl
, ceilf
, ceill
,
cosf
, coshf
, coshl
, cosl
, expf
,
expl
, fabsf
, fabsl
, floorf
, floorl
,
fmodf
, fmodl
, frexpf
, frexpl
, ldexpf
,
ldexpl
, log10f
, log10l
, logf
, logl
,
modfl
, modf
, powf
, powl
, sinf
,
sinhf
, sinhl
, sinl
, sqrtf
, sqrtl
,
tanf
, tanhf
, tanhl
and tanl
that are recognized in any mode since ISO C90 reserves these names for
the purpose to which ISO C99 puts them. All these functions have
corresponding versions prefixed with __builtin_
.
The ISO C90 functions
abort
, abs
, acos
, asin
, atan2
,
atan
, calloc
, ceil
, cosh
, cos
,
exit
, exp
, fabs
, floor
, fmod
,
fprintf
, fputs
, frexp
, fscanf
, labs
,
ldexp
, log10
, log
, malloc
, memcmp
,
memcpy
, memset
, modf
, pow
, printf
,
putchar
, puts
, 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 standard 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.
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 example,int
is equivalent toconst int
.The type
int[]
andint[5]
are compatible. On the other hand,int
andchar *
are not compatible, even if the size of their types, on the particular architecture are the same. Also, the amount of pointer indirection is taken into account when determining similarity. Consequently,short *
is not similar toshort **
. 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 anotherenum
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 toenum {hot, dog}
.You would typically use this function in code whose execution varies depending on the arguments' types. For example:
#define foo(x) \ ({ \ typeof (x) tmp; \ 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.
You can use the built-in function
__builtin_choose_expr
to evaluate code depending on the value of a constant expression. This built-in function returns exp1 if const_exp, which is a constant expression that must be able to be determined at compile time, is nonzero. Otherwise it returns 0.This built-in function is analogous to the `? :' operator in C, except that the expression returned has its type unaltered by promotion rules. Also, the built-in function does not evaluate the expression that was not chosen. For example, if const_exp evaluates to true, exp2 is not evaluated even if it has side-effects.
This built-in function can return an lvalue if the chosen argument is an lvalue.
If exp1 is returned, the return type is the same as exp1's type. Similarly, if exp2 is returned, its return type is the same as exp2.
Example:
#define foo(x) \ __builtin_choose_expr ( \ __builtin_types_compatible_p (typeof (x), double), \ foo_double (x), \ __builtin_choose_expr ( \ __builtin_types_compatible_p (typeof (x), float), \ foo_float (x), \ /* The void expression results in a compile-time error \ when assigning the result to something. */ \ (void)0))Note: This construct is only available for C. Furthermore, the unused expression (exp1 or exp2 depending on the value of const_exp) may still generate syntax errors. This may change in future revisions.
You can use the built-in function
__builtin_constant_p
to determine if a value is known to be constant at compile-time and hence that GCC can perform constant-folding on expressions involving that value. The argument of the function is the value to test. The function returns the integer 1 if the argument is known to be a compile-time constant and 0 if it is not known to be a compile-time constant. A return of 0 does not indicate that the value is not a constant, but merely that GCC cannot prove it is a constant with the specified value of the -O option.You would typically use this function in an embedded application where memory was a critical resource. If you have some complex calculation, you may want it to be folded if it involves constants, but need to call a function if it does not. For example:
#define Scale_Value(X) \ (__builtin_constant_p (X) \ ? ((X) * SCALE + OFFSET) : Scale (X))You may use this built-in function in either a macro or an inline function. However, if you use it in an inlined function and pass an argument of the function as the argument to the built-in, GCC will never return 1 when you call the inline function with a string constant or compound literal (see Compound Literals) and will not return 1 when you pass a constant numeric value to the inline function unless you specify the -O option.
You may also use
__builtin_constant_p
in initializers for static data. For instance, you can writestatic const int table[] = { __builtin_constant_p (EXPRESSION) ? (EXPRESSION) : -1, /* ... */ };
This is an acceptable initializer even if EXPRESSION is not a constant expression. GCC must be more conservative about evaluating the built-in in this case, because it has no opportunity to perform optimization.
Previous versions of GCC did not accept this built-in in data initializers. The earliest version where it is completely safe is 3.0.1.
You may use
__builtin_expect
to provide the compiler with branch prediction information. In general, you should prefer to use actual profile feedback for this (-fprofile-arcs), as programmers are notoriously bad at predicting how their programs actually perform. However, there are applications in which this data is hard to collect.The return value is the value of exp, which should be an integral expression. The value of c must be a compile-time constant. The semantics of the built-in are that it is expected that exp == c. For example:
if (__builtin_expect (x, 0)) foo ();would indicate that we do not expect to call
foo
, since we expectx
to be zero. Since you are limited to integral expressions for exp, you should use constructions such asif (__builtin_expect (ptr != NULL, 1)) error ();when testing pointer or floating-point values.
This function is used to minimize cache-miss latency by moving data into a cache before it is accessed. You can insert calls to
__builtin_prefetch
into code for which you know addresses of data in memory that is likely to be accessed soon. If the target supports them, data prefetch instructions will be generated. If the prefetch is done early enough before the access then the data will be in the cache by the time it is accessed.The value of addr is the address of the memory to prefetch. There are two optional arguments, rw and locality. The value of rw is a compile-time constant one or zero; one means that the prefetch is preparing for a write to the memory address and zero, the default, means that the prefetch is preparing for a read. The value locality must be a compile-time constant integer between zero and three. A value of zero means that the data has no temporal locality, so it need not be left in the cache after the access. A value of three means that the data has a high degree of temporal locality and should be left in all levels of cache possible. Values of one and two mean, respectively, a low or moderate degree of temporal locality. The default is three.
for (i = 0; i < n; i++) { a[i] = a[i] + b[i]; __builtin_prefetch (&a[i+j], 1, 1); __builtin_prefetch (&b[i+j], 0, 1); /* ... */ }
Data prefetch does not generate faults if addr is invalid, but the address expression itself must be valid. For example, a prefetch of
p->next
will not fault ifp->next
is not a valid address, but evaluation will fault ifp
is not a valid address.If the target does not support data prefetch, the address expression is evaluated if it includes side effects but no other code is generated and GCC does not issue a warning.
Returns a positive infinity, if supported by the floating-point format, else
DBL_MAX
. This function is suitable for implementing the ISO C macroHUGE_VAL
.
Similar to
__builtin_huge_val
, except the return type isfloat
.
Similar to
__builtin_huge_val
, except the return type islong double
.
Similar to
__builtin_huge_val
, except a warning is generated if the target floating-point format does not support infinities. This function is suitable for implementing the ISO C99 macroINFINITY
.
Similar to
__builtin_inf
, except the return type isfloat
.
Similar to
__builtin_inf
, except the return type islong double
.
This is an implementation of the ISO C99 function
nan
.Since ISO C99 defines this function in terms of
strtod
, which we do not implement, a description of the parsing is in order. The string is parsed as bystrtol
; that is, the base is recognized by leading `0' or `0x' prefixes. The number parsed is placed in the significand such that the least significant bit of the number is at the least significant bit of the significand. The number is truncated to fit the significand field provided. The significand is forced to be a quiet NaN.This function, if given a string literal, is evaluated early enough that it is considered a compile-time constant.
Similar to
__builtin_nan
, except the return type isfloat
.
Similar to
__builtin_nan
, except the return type islong double
.
Similar to
__builtin_nan
, except the significand is forced to be a signaling NaN. Thenans
function is proposed by WG14 N965.
Similar to
__builtin_nans
, except the return type isfloat
.
Similar to
__builtin_nans
, except the return type islong double
.
Returns one plus the index of the least significant 1-bit of x, or if x is zero, returns zero.
Returns the number of leading 0-bits in x, starting at the most significant bit position. If x is 0, the result is undefined.
Returns the number of trailing 0-bits in x, starting at the least significant bit position. If x is 0, the result is undefined.
Returns the parity of x, i.e. the number of 1-bits in x modulo 2.
Similar to
__builtin_ffs
, except the argument type isunsigned long
.
Similar to
__builtin_clz
, except the argument type isunsigned long
.
Similar to
__builtin_ctz
, except the argument type isunsigned long
.
Similar to
__builtin_popcount
, except the argument type isunsigned long
.
Similar to
__builtin_parity
, except the argument type isunsigned long
.
Similar to
__builtin_ffs
, except the argument type isunsigned long long
.
Similar to
__builtin_clz
, except the argument type isunsigned long long
.
Similar to
__builtin_ctz
, except the argument type isunsigned long long
.
Similar to
__builtin_popcount
, except the argument type isunsigned long long
.
Similar to
__builtin_parity
, except the argument type isunsigned long long
.
On some target machines, GCC supports many built-in functions specific to those machines. Generally these generate calls to specific machine instructions, but allow the compiler to schedule those calls.
These built-in functions are available for the Alpha family of processors, depending on the command-line switches used.
The following built-in functions are always available. They all generate the machine instruction that is part of the name.
long __builtin_alpha_implver (void) long __builtin_alpha_rpcc (void) long __builtin_alpha_amask (long) long __builtin_alpha_cmpbge (long, long) long __builtin_alpha_extbl (long, long) long __builtin_alpha_extwl (long, long) long __builtin_alpha_extll (long, long) long __builtin_alpha_extql (long, long) long __builtin_alpha_extwh (long, long) long __builtin_alpha_extlh (long, long) long __builtin_alpha_extqh (long, long) long __builtin_alpha_insbl (long, long) long __builtin_alpha_inswl (long, long) long __builtin_alpha_insll (long, long) long __builtin_alpha_insql (long, long) long __builtin_alpha_inswh (long, long) long __builtin_alpha_inslh (long, long) long __builtin_alpha_insqh (long, long) long __builtin_alpha_mskbl (long, long) long __builtin_alpha_mskwl (long, long) long __builtin_alpha_mskll (long, long) long __builtin_alpha_mskql (long, long) long __builtin_alpha_mskwh (long, long) long __builtin_alpha_msklh (long, long) long __builtin_alpha_mskqh (long, long) long __builtin_alpha_umulh (long, long) long __builtin_alpha_zap (long, long) long __builtin_alpha_zapnot (long, long)
The following built-in functions are always with -mmax
or -mcpu=cpu where cpu is pca56
or
later. They all generate the machine instruction that is part
of the name.
long __builtin_alpha_pklb (long) long __builtin_alpha_pkwb (long) long __builtin_alpha_unpkbl (long) long __builtin_alpha_unpkbw (long) long __builtin_alpha_minub8 (long, long) long __builtin_alpha_minsb8 (long, long) long __builtin_alpha_minuw4 (long, long) long __builtin_alpha_minsw4 (long, long) long __builtin_alpha_maxub8 (long, long) long __builtin_alpha_maxsb8 (long, long) long __builtin_alpha_maxuw4 (long, long) long __builtin_alpha_maxsw4 (long, long) long __builtin_alpha_perr (long, long)
The following built-in functions are always with -mcix
or -mcpu=cpu where cpu is ev67
or
later. They all generate the machine instruction that is part
of the name.
long __builtin_alpha_cttz (long) long __builtin_alpha_ctlz (long) long __builtin_alpha_ctpop (long)
The following builtins are available on systems that use the OSF/1
PALcode. Normally they invoke the rduniq
and wruniq
PAL calls, but when invoked with -mtls-kernel, they invoke
rdval
and wrval
.
void *__builtin_thread_pointer (void) void __builtin_set_thread_pointer (void *)
These built-in functions are available for the ARM family of processors, when the -mcpu=iwmmxt switch is used:
typedef int v2si __attribute__ ((vector_size (8))); typedef short v4hi __attribute__ ((vector_size (8))); typedef char v8qi __attribute__ ((vector_size (8))); int __builtin_arm_getwcx (int) void __builtin_arm_setwcx (int, int) int __builtin_arm_textrmsb (v8qi, int) int __builtin_arm_textrmsh (v4hi, int) int __builtin_arm_textrmsw (v2si, int) int __builtin_arm_textrmub (v8qi, int) int __builtin_arm_textrmuh (v4hi, int) int __builtin_arm_textrmuw (v2si, int) v8qi __builtin_arm_tinsrb (v8qi, int) v4hi __builtin_arm_tinsrh (v4hi, int) v2si __builtin_arm_tinsrw (v2si, int) long long __builtin_arm_tmia (long long, int, int) long long __builtin_arm_tmiabb (long long, int, int) long long __builtin_arm_tmiabt (long long, int, int) long long __builtin_arm_tmiaph (long long, int, int) long long __builtin_arm_tmiatb (long long, int, int) long long __builtin_arm_tmiatt (long long, int, int) int __builtin_arm_tmovmskb (v8qi) int __builtin_arm_tmovmskh (v4hi) int __builtin_arm_tmovmskw (v2si) long long __builtin_arm_waccb (v8qi) long long __builtin_arm_wacch (v4hi) long long __builtin_arm_waccw (v2si) v8qi __builtin_arm_waddb (v8qi, v8qi) v8qi __builtin_arm_waddbss (v8qi, v8qi) v8qi __builtin_arm_waddbus (v8qi, v8qi) v4hi __builtin_arm_waddh (v4hi, v4hi) v4hi __builtin_arm_waddhss (v4hi, v4hi) v4hi __builtin_arm_waddhus (v4hi, v4hi) v2si __builtin_arm_waddw (v2si, v2si) v2si __builtin_arm_waddwss (v2si, v2si) v2si __builtin_arm_waddwus (v2si, v2si) v8qi __builtin_arm_walign (v8qi, v8qi, int) long long __builtin_arm_wand(long long, long long) long long __builtin_arm_wandn (long long, long long) v8qi __builtin_arm_wavg2b (v8qi, v8qi) v8qi __builtin_arm_wavg2br (v8qi, v8qi) v4hi __builtin_arm_wavg2h (v4hi, v4hi) v4hi __builtin_arm_wavg2hr (v4hi, v4hi) v8qi __builtin_arm_wcmpeqb (v8qi, v8qi) v4hi __builtin_arm_wcmpeqh (v4hi, v4hi) v2si __builtin_arm_wcmpeqw (v2si, v2si) v8qi __builtin_arm_wcmpgtsb (v8qi, v8qi) v4hi __builtin_arm_wcmpgtsh (v4hi, v4hi) v2si __builtin_arm_wcmpgtsw (v2si, v2si) v8qi __builtin_arm_wcmpgtub (v8qi, v8qi) v4hi __builtin_arm_wcmpgtuh (v4hi, v4hi) v2si __builtin_arm_wcmpgtuw (v2si, v2si) long long __builtin_arm_wmacs (long long, v4hi, v4hi) long long __builtin_arm_wmacsz (v4hi, v4hi) long long __builtin_arm_wmacu (long long, v4hi, v4hi) long long __builtin_arm_wmacuz (v4hi, v4hi) v4hi __builtin_arm_wmadds (v4hi, v4hi) v4hi __builtin_arm_wmaddu (v4hi, v4hi) v8qi __builtin_arm_wmaxsb (v8qi, v8qi) v4hi __builtin_arm_wmaxsh (v4hi, v4hi) v2si __builtin_arm_wmaxsw (v2si, v2si) v8qi __builtin_arm_wmaxub (v8qi, v8qi) v4hi __builtin_arm_wmaxuh (v4hi, v4hi) v2si __builtin_arm_wmaxuw (v2si, v2si) v8qi __builtin_arm_wminsb (v8qi, v8qi) v4hi __builtin_arm_wminsh (v4hi, v4hi) v2si __builtin_arm_wminsw (v2si, v2si) v8qi __builtin_arm_wminub (v8qi, v8qi) v4hi __builtin_arm_wminuh (v4hi, v4hi) v2si __builtin_arm_wminuw (v2si, v2si) v4hi __builtin_arm_wmulsm (v4hi, v4hi) v4hi __builtin_arm_wmulul (v4hi, v4hi) v4hi __builtin_arm_wmulum (v4hi, v4hi) long long __builtin_arm_wor (long long, long long) v2si __builtin_arm_wpackdss (long long, long long) v2si __builtin_arm_wpackdus (long long, long long) v8qi __builtin_arm_wpackhss (v4hi, v4hi) v8qi __builtin_arm_wpackhus (v4hi, v4hi) v4hi __builtin_arm_wpackwss (v2si, v2si) v4hi __builtin_arm_wpackwus (v2si, v2si) long long __builtin_arm_wrord (long long, long long) long long __builtin_arm_wrordi (long long, int) v4hi __builtin_arm_wrorh (v4hi, long long) v4hi __builtin_arm_wrorhi (v4hi, int) v2si __builtin_arm_wrorw (v2si, long long) v2si __builtin_arm_wrorwi (v2si, int) v2si __builtin_arm_wsadb (v8qi, v8qi) v2si __builtin_arm_wsadbz (v8qi, v8qi) v2si __builtin_arm_wsadh (v4hi, v4hi) v2si __builtin_arm_wsadhz (v4hi, v4hi) v4hi __builtin_arm_wshufh (v4hi, int) long long __builtin_arm_wslld (long long, long long) long long __builtin_arm_wslldi (long long, int) v4hi __builtin_arm_wsllh (v4hi, long long) v4hi __builtin_arm_wsllhi (v4hi, int) v2si __builtin_arm_wsllw (v2si, long long) v2si __builtin_arm_wsllwi (v2si, int) long long __builtin_arm_wsrad (long long, long long) long long __builtin_arm_wsradi (long long, int) v4hi __builtin_arm_wsrah (v4hi, long long) v4hi __builtin_arm_wsrahi (v4hi, int) v2si __builtin_arm_wsraw (v2si, long long) v2si __builtin_arm_wsrawi (v2si, int) long long __builtin_arm_wsrld (long long, long long) long long __builtin_arm_wsrldi (long long, int) v4hi __builtin_arm_wsrlh (v4hi, long long) v4hi __builtin_arm_wsrlhi (v4hi, int) v2si __builtin_arm_wsrlw (v2si, long long) v2si __builtin_arm_wsrlwi (v2si, int) v8qi __builtin_arm_wsubb (v8qi, v8qi) v8qi __builtin_arm_wsubbss (v8qi, v8qi) v8qi __builtin_arm_wsubbus (v8qi, v8qi) v4hi __builtin_arm_wsubh (v4hi, v4hi) v4hi __builtin_arm_wsubhss (v4hi, v4hi) v4hi __builtin_arm_wsubhus (v4hi, v4hi) v2si __builtin_arm_wsubw (v2si, v2si) v2si __builtin_arm_wsubwss (v2si, v2si) v2si __builtin_arm_wsubwus (v2si, v2si) v4hi __builtin_arm_wunpckehsb (v8qi) v2si __builtin_arm_wunpckehsh (v4hi) long long __builtin_arm_wunpckehsw (v2si) v4hi __builtin_arm_wunpckehub (v8qi) v2si __builtin_arm_wunpckehuh (v4hi) long long __builtin_arm_wunpckehuw (v2si) v4hi __builtin_arm_wunpckelsb (v8qi) v2si __builtin_arm_wunpckelsh (v4hi) long long __builtin_arm_wunpckelsw (v2si) v4hi __builtin_arm_wunpckelub (v8qi) v2si __builtin_arm_wunpckeluh (v4hi) long long __builtin_arm_wunpckeluw (v2si) v8qi __builtin_arm_wunpckihb (v8qi, v8qi) v4hi __builtin_arm_wunpckihh (v4hi, v4hi) v2si __builtin_arm_wunpckihw (v2si, v2si) v8qi __builtin_arm_wunpckilb (v8qi, v8qi) v4hi __builtin_arm_wunpckilh (v4hi, v4hi) v2si __builtin_arm_wunpckilw (v2si, v2si) long long __builtin_arm_wxor (long long, long long) long long __builtin_arm_wzero ()
These built-in functions are available for the i386 and x86-64 family of computers, depending on the command-line switches used.
The following machine modes are available for use with MMX built-in functions
(see Vector Extensions): V2SI
for a vector of two 32-bit integers,
V4HI
for a vector of four 16-bit integers, and V8QI
for a
vector of eight 8-bit integers. Some of the built-in functions operate on
MMX registers as a whole 64-bit entity, these use DI
as their mode.
If 3Dnow extensions are enabled, V2SF
is used as a mode for a vector
of two 32-bit floating point values.
If SSE extensions are enabled, V4SF
is used for a vector of four 32-bit
floating point values. Some instructions use a vector of four 32-bit
integers, these use V4SI
. Finally, some instructions operate on an
entire vector register, interpreting it as a 128-bit integer, these use mode
TI
.
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) v4hi __builtin_ia32_paddsw (v4hi, v4hi) v8qi __builtin_ia32_psubsb (v8qi, v8qi) v4hi __builtin_ia32_psubsw (v4hi, v4hi) v8qi __builtin_ia32_paddusb (v8qi, v8qi) v4hi __builtin_ia32_paddusw (v4hi, v4hi) v8qi __builtin_ia32_psubusb (v8qi, v8qi) v4hi __builtin_ia32_psubusw (v4hi, v4hi) v4hi __builtin_ia32_pmullw (v4hi, v4hi) v4hi __builtin_ia32_pmulhw (v4hi, v4hi) di __builtin_ia32_pand (di, di) di __builtin_ia32_pandn (di,di) di __builtin_ia32_por (di, di) di __builtin_ia32_pxor (di, di) v8qi __builtin_ia32_pcmpeqb (v8qi, v8qi) v4hi __builtin_ia32_pcmpeqw (v4hi, v4hi) v2si __builtin_ia32_pcmpeqd (v2si, v2si) v8qi __builtin_ia32_pcmpgtb (v8qi, v8qi) v4hi __builtin_ia32_pcmpgtw (v4hi, v4hi) v2si __builtin_ia32_pcmpgtd (v2si, v2si) v8qi __builtin_ia32_punpckhbw (v8qi, v8qi) v4hi __builtin_ia32_punpckhwd (v4hi, v4hi) v2si __builtin_ia32_punpckhdq (v2si, v2si) v8qi __builtin_ia32_punpcklbw (v8qi, v8qi) v4hi __builtin_ia32_punpcklwd (v4hi, v4hi) v2si __builtin_ia32_punpckldq (v2si, v2si) v8qi __builtin_ia32_packsswb (v4hi, v4hi) v4hi __builtin_ia32_packssdw (v2si, v2si) v8qi __builtin_ia32_packuswb (v4hi, v4hi)
The following built-in functions are made available either with -msse, or with a combination of -m3dnow and -march=athlon. 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) v4hi __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_pextrw (v4hi, int) v4hi __builtin_ia32_pinsrw (v4hi, int, int) int __builtin_ia32_pmovmskb (v8qi) void __builtin_ia32_maskmovq (v8qi, v8qi, char *) void __builtin_ia32_movntq (di *, di) void __builtin_ia32_sfence (void)
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) v4si __builtin_ia32_cmpeqps (v4sf, v4sf) v4si __builtin_ia32_cmpltps (v4sf, v4sf) v4si __builtin_ia32_cmpleps (v4sf, v4sf) v4si __builtin_ia32_cmpgtps (v4sf, v4sf) v4si __builtin_ia32_cmpgeps (v4sf, v4sf) v4si __builtin_ia32_cmpunordps (v4sf, v4sf) v4si __builtin_ia32_cmpneqps (v4sf, v4sf) v4si __builtin_ia32_cmpnltps (v4sf, v4sf) v4si __builtin_ia32_cmpnleps (v4sf, v4sf) v4si __builtin_ia32_cmpngtps (v4sf, v4sf) v4si __builtin_ia32_cmpngeps (v4sf, v4sf) v4si __builtin_ia32_cmpordps (v4sf, v4sf) v4si __builtin_ia32_cmpeqss (v4sf, v4sf) v4si __builtin_ia32_cmpltss (v4sf, v4sf) v4si __builtin_ia32_cmpless (v4sf, v4sf) v4si __builtin_ia32_cmpunordss (v4sf, v4sf) v4si __builtin_ia32_cmpneqss (v4sf, v4sf) v4si __builtin_ia32_cmpnlts (v4sf, v4sf) v4si __builtin_ia32_cmpnless (v4sf, v4sf) v4si __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) v4sf __builtin_ia32_cvtpi2ps (v4sf, v2si) v4sf __builtin_ia32_cvtsi2ss (v4sf, int) v2si __builtin_ia32_cvtps2pi (v4sf) int __builtin_ia32_cvtss2si (v4sf) v2si __builtin_ia32_cvttps2pi (v4sf) int __builtin_ia32_cvttss2si (v4sf) v4sf __builtin_ia32_rcpps (v4sf) v4sf __builtin_ia32_rsqrtps (v4sf) v4sf __builtin_ia32_sqrtps (v4sf) v4sf __builtin_ia32_rcpss (v4sf) v4sf __builtin_ia32_rsqrtss (v4sf) v4sf __builtin_ia32_sqrtss (v4sf) v4sf __builtin_ia32_shufps (v4sf, v4sf, int) void __builtin_ia32_movntps (float *, v4sf) int __builtin_ia32_movmskps (v4sf)
The following built-in functions are available when -msse is used.
v4sf __builtin_ia32_loadaps (float *)
movaps
machine instruction as a load from memory.
void __builtin_ia32_storeaps (float *, v4sf)
movaps
machine instruction as a store to memory.
v4sf __builtin_ia32_loadups (float *)
movups
machine instruction as a load from memory.
void __builtin_ia32_storeups (float *, v4sf)
movups
machine instruction as a store to memory.
v4sf __builtin_ia32_loadsss (float *)
movss
machine instruction as a load from memory.
void __builtin_ia32_storess (float *, v4sf)
movss
machine instruction as a store to memory.
v4sf __builtin_ia32_loadhps (v4sf, v2si *)
movhps
machine instruction as a load from memory.
v4sf __builtin_ia32_loadlps (v4sf, v2si *)
movlps
machine instruction as a load from memory
void __builtin_ia32_storehps (v4sf, v2si *)
movhps
machine instruction as a store to memory.
void __builtin_ia32_storelps (v4sf, v2si *)
movlps
machine instruction as a store to memory.
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) v2df __builtin_ia32_addsubps (v2df, v2df) v2df __builtin_ia32_haddpd (v2df, v2df) v2df __builtin_ia32_haddps (v2df, v2df) v2df __builtin_ia32_hsubpd (v2df, v2df) v2df __builtin_ia32_hsubps (v2df, v2df) v16qi __builtin_ia32_lddqu (char const *) void __builtin_ia32_monitor (void *, unsigned int, unsigned int) v2df __builtin_ia32_movddup (v2df) 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 -msse3 is used.
v2df __builtin_ia32_loadddup (double const *)
movddup
machine instruction as a load from memory.
The following built-in functions are available when -m3dnow is used. All of them generate the machine instruction that is part of the name.
void __builtin_ia32_femms (void) v8qi __builtin_ia32_pavgusb (v8qi, v8qi) v2si __builtin_ia32_pf2id (v2sf) v2sf __builtin_ia32_pfacc (v2sf, v2sf) v2sf __builtin_ia32_pfadd (v2sf, v2sf) v2si __builtin_ia32_pfcmpeq (v2sf, v2sf) v2si __builtin_ia32_pfcmpge (v2sf, v2sf) v2si __builtin_ia32_pfcmpgt (v2sf, v2sf) v2sf __builtin_ia32_pfmax (v2sf, v2sf) v2sf __builtin_ia32_pfmin (v2sf, v2sf) v2sf __builtin_ia32_pfmul (v2sf, v2sf) v2sf __builtin_ia32_pfrcp (v2sf) v2sf __builtin_ia32_pfrcpit1 (v2sf, v2sf) v2sf __builtin_ia32_pfrcpit2 (v2sf, v2sf) v2sf __builtin_ia32_pfrsqrt (v2sf) v2sf __builtin_ia32_pfrsqrtit1 (v2sf, v2sf) v2sf __builtin_ia32_pfsub (v2sf, v2sf) v2sf __builtin_ia32_pfsubr (v2sf, v2sf) v2sf __builtin_ia32_pi2fd (v2si) v4hi __builtin_ia32_pmulhrw (v4hi, v4hi)
The following built-in functions are available when both -m3dnow and -march=athlon are used. All of them generate the machine instruction that is part of the name.
v2si __builtin_ia32_pf2iw (v2sf) v2sf __builtin_ia32_pfnacc (v2sf, v2sf) v2sf __builtin_ia32_pfpnacc (v2sf, v2sf) v2sf __builtin_ia32_pi2fw (v2si) v2sf __builtin_ia32_pswapdsf (v2sf) v2si __builtin_ia32_pswapdsi (v2si)
GCC provides an interface for the PowerPC family of processors to access
the AltiVec operations described in Motorola's AltiVec Programming
Interface Manual. The interface is made available by including
<altivec.h>
and using -maltivec and
-mabi=altivec. The interface supports the following vector
types.
vector unsigned char vector signed char vector bool char vector unsigned short vector signed short vector bool short vector pixel vector unsigned int vector signed int vector bool int vector float
GCC's implementation of the high-level language interface available from C and C++ code differs from Motorola's documentation in several ways.
signed
or unsigned
is omitted, the vector type defaults
to signed
for vector int
or vector short
and to
unsigned
for vector char
.
__vector
,
__pixel
, and __bool
. Macros vector,
pixel
, and bool
are defined in <altivec.h>
and can
be undefined.
typedef
name as the type specifier for a
vector type.
vec_add ((vector signed int){1, 2, 3, 4}, foo);
Since vec_add
is a macro, the vector constant in the example
is treated as four separate arguments. Wrap the entire argument in
parentheses for this to work.
Note: Only the <altivec.h>
interface is supported.
Internally, GCC uses built-in functions to achieve the functionality in
the aforementioned header file, but they are not supported and are
subject to change without notice.
The following interfaces are supported for the generic and specific AltiVec operations and the AltiVec predicates. In cases where there is a direct mapping between generic and specific 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.
vector signed char vec_abs (vector signed char); vector signed short vec_abs (vector signed short); vector signed int vec_abs (vector signed int); vector float vec_abs (vector float); vector signed char vec_abss (vector signed char); vector signed short vec_abss (vector signed short); vector signed int vec_abss (vector signed int); vector signed char vec_add (vector bool char, vector signed char); vector signed char vec_add (vector signed char, vector bool char); vector signed char vec_add (vector signed char, vector signed char); vector unsigned char vec_add (vector bool char, vector unsigned char); vector unsigned char vec_add (vector unsigned char, vector bool char); vector unsigned char vec_add (vector unsigned char, vector unsigned char); vector signed short vec_add (vector bool short, vector signed short); vector signed short vec_add (vector signed short, vector bool short); vector signed short vec_add (vector signed short, vector signed short); vector unsigned short vec_add (vector bool short, vector unsigned short); vector unsigned short vec_add (vector unsigned short, vector bool short); vector unsigned short vec_add (vector unsigned short, vector unsigned short); vector signed int vec_add (vector bool int, vector signed int); vector signed int vec_add (vector signed int, vector bool int); vector signed int vec_add (vector signed int, vector signed int); vector unsigned int vec_add (vector bool int, vector unsigned int); vector unsigned int vec_add (vector unsigned int, vector bool int); vector unsigned int vec_add (vector unsigned int, vector unsigned int); vector float vec_add (vector float, vector float); vector float vec_vaddfp (vector float, vector float); 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 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 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 int vec_addc (vector unsigned int, vector unsigned int); vector unsigned char vec_adds (vector bool char, vector unsigned char); vector unsigned char vec_adds (vector unsigned char, vector bool char); vector unsigned char vec_adds (vector unsigned char, vector unsigned char); vector signed char vec_adds (vector bool char, vector signed char); vector signed char vec_adds (vector signed char, vector bool char); vector signed char vec_adds (vector signed char, vector signed char); vector unsigned short vec_adds (vector bool short, vector unsigned short); vector unsigned short vec_adds (vector unsigned short, vector bool short); vector unsigned short vec_adds (vector unsigned short, vector unsigned short); vector signed short vec_adds (vector bool short, vector signed short); vector signed short vec_adds (vector signed short, vector bool short); vector signed short vec_adds (vector signed short, vector signed short); vector unsigned int vec_adds (vector bool int, vector unsigned int); vector unsigned int vec_adds (vector unsigned int, vector bool int); vector unsigned int vec_adds (vector unsigned int, vector unsigned int); vector signed int vec_adds (vector bool int, vector signed int); vector signed int vec_adds (vector signed int, vector bool int); vector signed int vec_adds (vector signed int, vector signed int); 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 unsigned int vec_vadduws (vector bool int, vector unsigned int); vector unsigned int vec_vadduws (vector unsigned int, vector bool int); vector unsigned int vec_vadduws (vector unsigned int, vector unsigned int); 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 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 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 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 float vec_and (vector float, vector float); vector float vec_and (vector float, vector bool int); vector float vec_and (vector bool int, vector float); vector bool int vec_and (vector bool int, vector bool int); vector signed int vec_and (vector bool int, vector signed int); vector signed int vec_and (vector signed int, vector bool int); vector signed int vec_and (vector signed int, vector signed int); vector unsigned int vec_and (vector bool int, vector unsigned int); vector unsigned int vec_and (vector unsigned int, vector bool int); vector unsigned int vec_and (vector unsigned int, vector unsigned int); vector bool short vec_and (vector bool short, vector bool short); vector signed short vec_and (vector bool short, vector signed short); vector signed short vec_and (vector signed short, vector bool short); vector signed short vec_and (vector signed short, vector signed short); vector unsigned short vec_and (vector bool short, vector unsigned short); vector unsigned short vec_and (vector unsigned short, vector bool short); vector unsigned short vec_and (vector unsigned short, vector unsigned short); vector signed char vec_and (vector bool char, vector signed char); vector bool char vec_and (vector bool char, vector bool char); vector signed char vec_and (vector signed char, vector bool char); vector signed char vec_and (vector signed char, vector signed char); vector unsigned char vec_and (vector bool char, vector unsigned char); vector unsigned char vec_and (vector unsigned char, vector bool char); vector unsigned char vec_and (vector unsigned char, vector unsigned char); vector float vec_andc (vector float, vector float); vector float vec_andc (vector float, vector bool int); vector float vec_andc (vector bool int, vector float); vector bool int vec_andc (vector bool int, vector bool int); vector signed int vec_andc (vector bool int, vector signed int); vector signed int vec_andc (vector signed int, vector bool int); vector signed int vec_andc (vector signed int, vector signed int); vector unsigned int vec_andc (vector bool int, vector unsigned int); vector unsigned int vec_andc (vector unsigned int, vector bool int); vector unsigned int vec_andc (vector unsigned int, vector unsigned int); vector bool short vec_andc (vector bool short, vector bool short); vector signed short vec_andc (vector bool short, vector signed short); vector signed short vec_andc (vector signed short, vector bool short); vector signed short vec_andc (vector signed short, vector signed short); vector unsigned short vec_andc (vector bool short, vector unsigned short); vector unsigned short vec_andc (vector unsigned short, vector bool short); vector unsigned short vec_andc (vector unsigned short, vector unsigned short); vector signed char vec_andc (vector bool char, vector signed char); vector bool char vec_andc (vector bool char, vector bool char); vector signed char vec_andc (vector signed char, vector bool char); vector signed char vec_andc (vector signed char, vector signed char); vector unsigned char vec_andc (vector bool char, vector unsigned char); vector unsigned char vec_andc (vector unsigned char, vector bool char); vector unsigned char vec_andc (vector unsigned char, vector unsigned char); vector unsigned char vec_avg (vector unsigned char, vector unsigned char); vector signed char vec_avg (vector signed char, vector signed char); vector unsigned short vec_avg (vector unsigned short, vector unsigned short); vector signed short vec_avg (vector signed short, vector signed short); vector unsigned int vec_avg (vector unsigned int, vector unsigned int); vector signed int vec_avg (vector signed int, vector signed int); vector signed int vec_vavgsw (vector signed int, vector signed int); vector unsigned int vec_vavguw (vector unsigned int, vector unsigned int); vector signed short vec_vavgsh (vector signed short, vector signed short); vector unsigned short vec_vavguh (vector unsigned short, vector unsigned short); vector signed char vec_vavgsb (vector signed char, vector signed char); vector unsigned char vec_vavgub (vector unsigned char, vector unsigned char); vector float vec_ceil (vector float); vector signed int vec_cmpb (vector float, vector float); vector bool char vec_cmpeq (vector signed char, vector signed char); vector bool char vec_cmpeq (vector unsigned char, vector unsigned char); vector bool short vec_cmpeq (vector signed short, vector signed short); vector bool short vec_cmpeq (vector unsigned short, vector unsigned short); vector bool int vec_cmpeq (vector signed int, vector signed int); vector bool int vec_cmpeq (vector unsigned int, vector unsigned int); vector bool int vec_cmpeq (vector float, vector float); vector bool int vec_vcmpeqfp (vector float, vector float); vector bool int vec_vcmpequw (vector signed int, vector signed int); vector bool int vec_vcmpequw (vector unsigned int, vector unsigned int); vector bool short vec_vcmpequh (vector signed short, vector signed short); vector bool short vec_vcmpequh (vector unsigned short, vector unsigned short); vector bool char vec_vcmpequb (vector signed char, vector signed char); vector bool char vec_vcmpequb (vector unsigned char, vector unsigned char); vector bool int vec_cmpge (vector float, vector float); vector bool char vec_cmpgt (vector unsigned char, vector unsigned char); vector bool char vec_cmpgt (vector signed char, vector signed char); vector bool short vec_cmpgt (vector unsigned short, vector unsigned short); vector bool short vec_cmpgt (vector signed short, vector signed short); vector bool int vec_cmpgt (vector unsigned int, vector unsigned int); vector bool int vec_cmpgt (vector signed int, vector signed int); vector bool int vec_cmpgt (vector float, vector float); vector bool int vec_vcmpgtfp (vector float, vector float); vector bool int vec_vcmpgtsw (vector signed int, vector signed int); vector bool int vec_vcmpgtuw (vector unsigned int, vector unsigned int); vector bool short vec_vcmpgtsh (vector signed short, vector signed short); vector bool short vec_vcmpgtuh (vector unsigned short, vector unsigned short); vector bool char vec_vcmpgtsb (vector signed char, vector signed char); vector bool char vec_vcmpgtub (vector unsigned char, vector unsigned char); vector bool int vec_cmple (vector float, vector float); vector bool char vec_cmplt (vector unsigned char, vector unsigned char); vector bool char vec_cmplt (vector signed char, vector signed char); vector bool short vec_cmplt (vector unsigned short, vector unsigned short); vector bool short vec_cmplt (vector signed short, vector signed short); vector bool int vec_cmplt (vector unsigned int, vector unsigned int); vector bool int vec_cmplt (vector signed int, vector signed int); vector bool int vec_cmplt (vector float, vector float); vector float vec_ctf (vector unsigned int, const int); vector float vec_ctf (vector signed int, const int); vector float vec_vcfsx (vector signed int, const int); vector float vec_vcfux (vector unsigned int, const int); vector signed int vec_cts (vector float, const int); vector unsigned int vec_ctu (vector float, const int); void vec_dss (const int); void vec_dssall (void); void vec_dst (const vector unsigned char *, int, const int); void vec_dst (const vector signed char *, int, const int); void vec_dst (const vector bool char *, int, const int); void vec_dst (const vector unsigned short *, int, const int); void vec_dst (const vector signed short *, int, const int); void vec_dst (const vector bool short *, int, const int); void vec_dst (const vector pixel *, int, const int); void vec_dst (const vector unsigned int *, int, const int); void vec_dst (const vector signed int *, int, const int); void vec_dst (const vector bool int *, int, const int); void vec_dst (const vector float *, int, const int); void vec_dst (const unsigned char *, int, const int); void vec_dst (const signed char *, int, const int); void vec_dst (const unsigned short *, int, const int); void vec_dst (const short *, int, const int); void vec_dst (const unsigned int *, int, const int); void vec_dst (const int *, int, const int); void vec_dst (const unsigned long *, int, const int); void vec_dst (const long *, int, const int); void vec_dst (const float *, int, const int); void vec_dstst (const vector unsigned char *, int, const int); void vec_dstst (const vector signed char *, int, const int); void vec_dstst (const vector bool char *, int, const int); void vec_dstst (const vector unsigned short *, int, const int); void vec_dstst (const vector signed short *, int, const int); void vec_dstst (const vector bool short *, int, const int); void vec_dstst (const vector pixel *, int, const int); void vec_dstst (const vector unsigned int *, int, const int); void vec_dstst (const vector signed int *, int, const int); void vec_dstst (const vector bool int *, int, const int); void vec_dstst (const vector float *, int, const int); void vec_dstst (const unsigned char *, int, const int); void vec_dstst (const signed char *, int, const int); void vec_dstst (const unsigned short *, int, const int); void vec_dstst (const short *, int, const int); void vec_dstst (const unsigned int *, int, const int); void vec_dstst (const int *, int, const int); void vec_dstst (const unsigned long *, int, const int); void vec_dstst (const long *, int, const int); void vec_dstst (const float *, int, const int); void vec_dststt (const vector unsigned char *, int, const int); void vec_dststt (const vector signed char *, int, const int); void vec_dststt (const vector bool char *, int, const int); void vec_dststt (const vector unsigned short *, int, const int); void vec_dststt (const vector signed short *, int, const int); void vec_dststt (const vector bool short *, int, const int); void vec_dststt (const vector pixel *, int, const int); void vec_dststt (const vector unsigned int *, int, const int); void vec_dststt (const vector signed int *, int, const int); void vec_dststt (const vector bool int *, int, const int); void vec_dststt (const vector float *, int, const int); void vec_dststt (const unsigned char *, int, const int); void vec_dststt (const signed char *, int, const int); void vec_dststt (const unsigned short *, int, const int); void vec_dststt (const short *, int, const int); void vec_dststt (const unsigned int *, int, const int); void vec_dststt (const int *, int, const int); void vec_dststt (const unsigned long *, int, const int); void vec_dststt (const long *, int, const int); void vec_dststt (const float *, int, const int); void vec_dstt (const vector unsigned char *, int, const int); void vec_dstt (const vector signed char *, int, const int); void vec_dstt (const vector bool char *, int, const int); void vec_dstt (const vector unsigned short *, int, const int); void vec_dstt (const vector signed short *, int, const int); void vec_dstt (const vector bool short *, int, const int); void vec_dstt (const vector pixel *, int, const int); void vec_dstt (const vector unsigned int *, int, const int); void vec_dstt (const vector signed int *, int, const int); void vec_dstt (const vector bool int *, int, const int); void vec_dstt (const vector float *, int, const int); void vec_dstt (const unsigned char *, int, const int); void vec_dstt (const signed char *, int, const int); void vec_dstt (const unsigned short *, int, const int); void vec_dstt (const short *, int, const int); void vec_dstt (const unsigned int *, int, const int); void vec_dstt (const int *, int, const int); void vec_dstt (const unsigned long *, int, const int); void vec_dstt (const long *, int, const int); void vec_dstt (const float *, int, const int); vector float vec_expte (vector float); vector float vec_floor (vector float); vector float vec_ld (int, const vector float *); vector float vec_ld (int, const float *); vector bool int vec_ld (int, const vector bool int *); vector signed int vec_ld (int, const vector signed int *); vector signed int vec_ld (int, const int *); vector signed int vec_ld (int, const long *); vector unsigned int vec_ld (int, const vector unsigned int *); vector unsigned int vec_ld (int, const unsigned int *); vector unsigned int vec_ld (int, const unsigned long *); vector bool short vec_ld (int, const vector bool short *); vector pixel vec_ld (int, const vector pixel *); vector signed short vec_ld (int, const vector signed short *); vector signed short vec_ld (int, const short *); vector unsigned short vec_ld (int, const vector unsigned short *); vector unsigned short vec_ld (int, const unsigned short *); vector bool char vec_ld (int, const vector bool char *); vector signed char vec_ld (int, const vector signed char *); vector signed char vec_ld (int, const signed char *); vector unsigned char vec_ld (int, const vector unsigned char *); vector unsigned char vec_ld (int, const unsigned char *); vector signed char vec_lde (int, const signed char *); vector unsigned char vec_lde (int, const unsigned char *); vector signed short vec_lde (int, const short *); vector unsigned short vec_lde (int, const unsigned short *); vector float vec_lde (int, const float *); vector signed int vec_lde (int, const int *); vector unsigned int vec_lde (int, const unsigned int *); vector signed int vec_lde (int, const long *); vector unsigned int vec_lde (int, const unsigned long *); vector float vec_lvewx (int, float *); vector signed int vec_lvewx (int, int *); vector unsigned int vec_lvewx (int, unsigned int *); vector signed int vec_lvewx (int, long *); vector unsigned int vec_lvewx (int, unsigned long *); vector signed short vec_lvehx (int, short *); vector unsigned short vec_lvehx (int, unsigned short *); vector signed char vec_lvebx (int, char *); vector unsigned char vec_lvebx (int, unsigned char *); vector float vec_ldl (int, const vector float *); vector float vec_ldl (int, const float *); vector bool int vec_ldl (int, const vector bool int *); vector signed int vec_ldl (int, const vector signed int *); vector signed int vec_ldl (int, const int *); vector signed int vec_ldl (int, const long *); vector unsigned int vec_ldl (int, const vector unsigned int *); vector unsigned int vec_ldl (int, const unsigned int *); vector unsigned int vec_ldl (int, const unsigned long *); vector bool short vec_ldl (int, const vector bool short *); vector pixel vec_ldl (int, const vector pixel *); vector signed short vec_ldl (int, const vector signed short *); vector signed short vec_ldl (int, const short *); vector unsigned short vec_ldl (int, const vector unsigned short *); vector unsigned short vec_ldl (int, const unsigned short *); vector bool char vec_ldl (int, const vector bool char *); vector signed char vec_ldl (int, const vector signed char *); vector signed char vec_ldl (int, const signed char *); vector unsigned char vec_ldl (int, const vector unsigned char *); vector unsigned char vec_ldl (int, const unsigned char *); vector float vec_loge (vector float); vector unsigned char vec_lvsl (int, const volatile unsigned char *); vector unsigned char vec_lvsl (int, const volatile signed char *); vector unsigned char vec_lvsl (int, const volatile unsigned short *); vector unsigned char vec_lvsl (int, const volatile short *); vector unsigned char vec_lvsl (int, const volatile unsigned int *); vector unsigned char vec_lvsl (int, const volatile int *); vector unsigned char vec_lvsl (int, const volatile unsigned long *); vector unsigned char vec_lvsl (int, const volatile long *); vector unsigned char vec_lvsl (int, const volatile float *); vector unsigned char vec_lvsr (int, const volatile unsigned char *); vector unsigned char vec_lvsr (int, const volatile signed char *); vector unsigned char vec_lvsr (int, const volatile unsigned short *); vector unsigned char vec_lvsr (int, const volatile short *); vector unsigned char vec_lvsr (int, const volatile unsigned int *); vector unsigned char vec_lvsr (int, const volatile int *); vector unsigned char vec_lvsr (int, const volatile unsigned long *); vector unsigned char vec_lvsr (int, const volatile long *); vector unsigned char vec_lvsr (int, const volatile float *); vector float vec_madd (vector float, vector float, vector float); vector signed short vec_madds (vector signed short, vector signed short, vector signed short); vector unsigned char vec_max (vector bool char, vector unsigned char); vector unsigned char vec_max (vector unsigned char, vector bool char); vector unsigned char vec_max (vector unsigned char, vector unsigned char); vector signed char vec_max (vector bool char, vector signed char); vector signed char vec_max (vector signed char, vector bool char); vector signed char vec_max (vector signed char, vector signed char); vector unsigned short vec_max (vector bool short, vector unsigned short); vector unsigned short vec_max (vector unsigned short, vector bool short); vector unsigned short vec_max (vector unsigned short, vector unsigned short); vector signed short vec_max (vector bool short, vector signed short); vector signed short vec_max (vector signed short, vector bool short); vector signed short vec_max (vector signed short, vector signed short); vector unsigned int vec_max (vector bool int, vector unsigned int); vector unsigned int vec_max (vector unsigned int, vector bool int); vector unsigned int vec_max (vector unsigned int, vector unsigned int); vector signed int vec_max (vector bool int, vector signed int); vector signed int vec_max (vector signed int, vector bool int); vector signed int vec_max (vector signed int, vector signed int); vector float vec_max (vector float, vector float); vector float vec_vmaxfp (vector float, vector float); 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); 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 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 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 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 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 bool char vec_mergeh (vector bool char, vector bool char); vector signed char vec_mergeh (vector signed char, vector signed char); vector unsigned char vec_mergeh (vector unsigned char, vector unsigned char); vector bool short vec_mergeh (vector bool short, vector bool short); vector pixel vec_mergeh (vector pixel, vector pixel); vector signed short vec_mergeh (vector signed short, vector signed short); vector unsigned short vec_mergeh (vector unsigned short, vector unsigned short); vector float vec_mergeh (vector float, vector float); vector bool int vec_mergeh (vector bool int, vector bool int); vector signed int vec_mergeh (vector signed int, vector signed int); vector unsigned int vec_mergeh (vector unsigned int, vector unsigned int); vector float vec_vmrghw (vector float, vector float); vector bool int vec_vmrghw (vector bool int, vector bool int); vector signed int vec_vmrghw (vector signed int, vector signed int); vector unsigned int vec_vmrghw (vector unsigned int, vector unsigned int); 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_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 char vec_mergel (vector bool char, vector bool char); vector signed char vec_mergel (vector signed char, vector signed char); vector unsigned char vec_mergel (vector unsigned char, vector unsigned char); vector bool short vec_mergel (vector bool short, vector bool short); vector pixel vec_mergel (vector pixel, vector pixel); vector signed short vec_mergel (vector signed short, vector signed short); vector unsigned short vec_mergel (vector unsigned short, vector unsigned short); vector float vec_mergel (vector float, vector float); vector bool int vec_mergel (vector bool int, vector bool int); vector signed int vec_mergel (vector signed int, vector signed int); vector unsigned int vec_mergel (vector unsigned int, vector unsigned int); vector float vec_vmrglw (vector float, vector float); vector signed int vec_vmrglw (vector signed int, vector signed int); vector unsigned int vec_vmrglw (vector unsigned int, vector unsigned int); vector bool int vec_vmrglw (vector bool int, vector bool int); vector bool short vec_vmrglh (vector bool short, vector bool short); vector signed short vec_vmrglh (vector signed short, vector signed short); vector unsigned short vec_vmrglh (vector unsigned short, vector unsigned short); vector pixel vec_vmrglh (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 unsigned short vec_mfvscr (void); vector unsigned char vec_min (vector bool char, vector unsigned char); vector unsigned char vec_min (vector unsigned char, vector bool char); vector unsigned char vec_min (vector unsigned char, vector unsigned char); vector signed char vec_min (vector bool char, vector signed char); vector signed char vec_min (vector signed char, vector bool char); vector signed char vec_min (vector signed char, vector signed char); vector unsigned short vec_min (vector bool short, vector unsigned short); vector unsigned short vec_min (vector unsigned short, vector bool short); vector unsigned short vec_min (vector unsigned short, vector unsigned short); vector signed short vec_min (vector bool short, vector signed short); vector signed short vec_min (vector signed short, vector bool short); vector signed short vec_min (vector signed short, vector signed short); vector unsigned int vec_min (vector bool int, vector unsigned int); vector unsigned int vec_min (vector unsigned int, vector bool int); vector unsigned int vec_min (vector unsigned int, vector unsigned int); vector signed int vec_min (vector bool int, vector signed int); vector signed int vec_min (vector signed int, vector bool int); vector signed int vec_min (vector signed int, vector signed int); vector float vec_min (vector float, vector float); vector float vec_vminfp (vector float, vector float); 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 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 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 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 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 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 signed short vec_mladd (vector signed short, vector signed short, vector signed short); vector signed short vec_mladd (vector signed short, vector unsigned short, vector unsigned short); vector signed short vec_mladd (vector unsigned short, vector signed short, vector signed short); vector unsigned short vec_mladd (vector unsigned short, vector unsigned short, vector unsigned short); vector signed short vec_mradds (vector signed short, vector signed short, vector signed short); vector unsigned int vec_msum (vector unsigned char, vector unsigned char, vector unsigned int); vector signed int vec_msum (vector signed char, vector unsigned char, vector signed int); vector unsigned int vec_msum (vector unsigned short, vector unsigned short, vector unsigned int); vector signed int vec_msum (vector signed short, vector signed short, vector signed int); vector signed int vec_vmsumshm (vector signed short, vector signed short, vector signed int); vector unsigned int vec_vmsumuhm (vector unsigned short, vector unsigned short, vector unsigned int); vector signed int vec_vmsummbm (vector signed char, vector unsigned char, vector signed int); vector unsigned int vec_vmsumubm (vector unsigned char, vector unsigned char, vector unsigned int); vector unsigned int vec_msums (vector unsigned short, vector unsigned short, vector unsigned int); vector signed int vec_msums (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_vmsumuhs (vector unsigned short, vector unsigned short, vector unsigned int); void vec_mtvscr (vector signed int); void vec_mtvscr (vector unsigned int); void vec_mtvscr (vector bool int); void vec_mtvscr (vector signed short); void vec_mtvscr (vector unsigned short); void vec_mtvscr (vector bool short); void vec_mtvscr (vector pixel); void vec_mtvscr (vector signed char); void vec_mtvscr (vector unsigned char); void vec_mtvscr (vector bool char); vec