PR target/55897
[official-gcc.git] / gcc / doc / extend.texi
blobcc20ed2b27e07e20f09e0bbb71b0700463eaa574
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1996, 1998, 1999, 2000, 2001,
2 @c 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
3 @c Free Software Foundation, Inc.
5 @c This is part of the GCC manual.
6 @c For copying conditions, see the file gcc.texi.
8 @node C Extensions
9 @chapter Extensions to the C Language Family
10 @cindex extensions, C language
11 @cindex C language extensions
13 @opindex pedantic
14 GNU C provides several language features not found in ISO standard C@.
15 (The @option{-pedantic} option directs GCC to print a warning message if
16 any of these features is used.)  To test for the availability of these
17 features in conditional compilation, check for a predefined macro
18 @code{__GNUC__}, which is always defined under GCC@.
20 These extensions are available in C and Objective-C@.  Most of them are
21 also available in C++.  @xref{C++ Extensions,,Extensions to the
22 C++ Language}, for extensions that apply @emph{only} to C++.
24 Some features that are in ISO C99 but not C90 or C++ are also, as
25 extensions, accepted by GCC in C90 mode and in C++.
27 @menu
28 * Statement Exprs::     Putting statements and declarations inside expressions.
29 * Local Labels::        Labels local to a block.
30 * Labels as Values::    Getting pointers to labels, and computed gotos.
31 * Nested Functions::    As in Algol and Pascal, lexical scoping of functions.
32 * Constructing Calls::  Dispatching a call to another function.
33 * Typeof::              @code{typeof}: referring to the type of an expression.
34 * Conditionals::        Omitting the middle operand of a @samp{?:} expression.
35 * Long Long::           Double-word integers---@code{long long int}.
36 * __int128::                    128-bit integers---@code{__int128}.
37 * Complex::             Data types for complex numbers.
38 * Floating Types::      Additional Floating Types.
39 * Half-Precision::      Half-Precision Floating Point.
40 * Decimal Float::       Decimal Floating Types.
41 * Hex Floats::          Hexadecimal floating-point constants.
42 * Fixed-Point::         Fixed-Point Types.
43 * Named Address Spaces::Named address spaces.
44 * Zero Length::         Zero-length arrays.
45 * Variable Length::     Arrays whose length is computed at run time.
46 * Empty Structures::    Structures with no members.
47 * Variadic Macros::     Macros with a variable number of arguments.
48 * Escaped Newlines::    Slightly looser rules for escaped newlines.
49 * Subscripting::        Any array can be subscripted, even if not an lvalue.
50 * Pointer Arith::       Arithmetic on @code{void}-pointers and function pointers.
51 * Initializers::        Non-constant initializers.
52 * Compound Literals::   Compound literals give structures, unions
53                         or arrays as values.
54 * Designated Inits::    Labeling elements of initializers.
55 * Cast to Union::       Casting to union type from any member of the union.
56 * Case Ranges::         `case 1 ... 9' and such.
57 * Mixed Declarations::  Mixing declarations and code.
58 * Function Attributes:: Declaring that functions have no side effects,
59                         or that they can never return.
60 * Attribute Syntax::    Formal syntax for attributes.
61 * Function Prototypes:: Prototype declarations and old-style definitions.
62 * C++ Comments::        C++ comments are recognized.
63 * Dollar Signs::        Dollar sign is allowed in identifiers.
64 * Character Escapes::   @samp{\e} stands for the character @key{ESC}.
65 * Variable Attributes:: Specifying attributes of variables.
66 * Type Attributes::     Specifying attributes of types.
67 * Alignment::           Inquiring about the alignment of a type or variable.
68 * Inline::              Defining inline functions (as fast as macros).
69 * Volatiles::           What constitutes an access to a volatile object.
70 * Extended Asm::        Assembler instructions with C expressions as operands.
71                         (With them you can define ``built-in'' functions.)
72 * Constraints::         Constraints for asm operands
73 * Asm Labels::          Specifying the assembler name to use for a C symbol.
74 * Explicit Reg Vars::   Defining variables residing in specified registers.
75 * Alternate Keywords::  @code{__const__}, @code{__asm__}, etc., for header files.
76 * Incomplete Enums::    @code{enum foo;}, with details to follow.
77 * Function Names::      Printable strings which are the name of the current
78                         function.
79 * Return Address::      Getting the return or frame address of a function.
80 * Vector Extensions::   Using vector instructions through built-in functions.
81 * Offsetof::            Special syntax for implementing @code{offsetof}.
82 * __sync Builtins::     Legacy built-in functions for atomic memory access.
83 * __atomic Builtins::   Atomic built-in functions with memory model.
84 * Object Size Checking:: Built-in functions for limited buffer overflow
85                         checking.
86 * Other Builtins::      Other built-in functions.
87 * Target Builtins::     Built-in functions specific to particular targets.
88 * Target Format Checks:: Format checks specific to particular targets.
89 * Pragmas::             Pragmas accepted by GCC.
90 * Unnamed Fields::      Unnamed struct/union fields within structs/unions.
91 * Thread-Local::        Per-thread variables.
92 * Binary constants::    Binary constants using the @samp{0b} prefix.
93 @end menu
95 @node Statement Exprs
96 @section Statements and Declarations in Expressions
97 @cindex statements inside expressions
98 @cindex declarations inside expressions
99 @cindex expressions containing statements
100 @cindex macros, statements in expressions
102 @c the above section title wrapped and causes an underfull hbox.. i
103 @c changed it from "within" to "in". --mew 4feb93
104 A compound statement enclosed in parentheses may appear as an expression
105 in GNU C@.  This allows you to use loops, switches, and local variables
106 within an expression.
108 Recall that a compound statement is a sequence of statements surrounded
109 by braces; in this construct, parentheses go around the braces.  For
110 example:
112 @smallexample
113 (@{ int y = foo (); int z;
114    if (y > 0) z = y;
115    else z = - y;
116    z; @})
117 @end smallexample
119 @noindent
120 is a valid (though slightly more complex than necessary) expression
121 for the absolute value of @code{foo ()}.
123 The last thing in the compound statement should be an expression
124 followed by a semicolon; the value of this subexpression serves as the
125 value of the entire construct.  (If you use some other kind of statement
126 last within the braces, the construct has type @code{void}, and thus
127 effectively no value.)
129 This feature is especially useful in making macro definitions ``safe'' (so
130 that they evaluate each operand exactly once).  For example, the
131 ``maximum'' function is commonly defined as a macro in standard C as
132 follows:
134 @smallexample
135 #define max(a,b) ((a) > (b) ? (a) : (b))
136 @end smallexample
138 @noindent
139 @cindex side effects, macro argument
140 But this definition computes either @var{a} or @var{b} twice, with bad
141 results if the operand has side effects.  In GNU C, if you know the
142 type of the operands (here taken as @code{int}), you can define
143 the macro safely as follows:
145 @smallexample
146 #define maxint(a,b) \
147   (@{int _a = (a), _b = (b); _a > _b ? _a : _b; @})
148 @end smallexample
150 Embedded statements are not allowed in constant expressions, such as
151 the value of an enumeration constant, the width of a bit-field, or
152 the initial value of a static variable.
154 If you don't know the type of the operand, you can still do this, but you
155 must use @code{typeof} (@pxref{Typeof}).
157 In G++, the result value of a statement expression undergoes array and
158 function pointer decay, and is returned by value to the enclosing
159 expression.  For instance, if @code{A} is a class, then
161 @smallexample
162         A a;
164         (@{a;@}).Foo ()
165 @end smallexample
167 @noindent
168 constructs a temporary @code{A} object to hold the result of the
169 statement expression, and that is used to invoke @code{Foo}.
170 Therefore the @code{this} pointer observed by @code{Foo} is not the
171 address of @code{a}.
173 In a statement expression, any temporaries created within a statement
174 are destroyed at that statement's end.  This makes statement
175 expressions inside macros slightly different from function calls.  In
176 the latter case temporaries introduced during argument evaluation are
177 destroyed at the end of the statement that includes the function
178 call.  In the statement expression case they are destroyed during
179 the statement expression.  For instance,
181 @smallexample
182 #define macro(a)  (@{__typeof__(a) b = (a); b + 3; @})
183 template<typename T> T function(T a) @{ T b = a; return b + 3; @}
185 void foo ()
187   macro (X ());
188   function (X ());
190 @end smallexample
192 @noindent
193 has different places where temporaries are destroyed.  For the
194 @code{macro} case, the temporary @code{X} is destroyed just after
195 the initialization of @code{b}.  In the @code{function} case that
196 temporary is destroyed when the function returns.
198 These considerations mean that it is probably a bad idea to use
199 statement expressions of this form in header files that are designed to
200 work with C++.  (Note that some versions of the GNU C Library contained
201 header files using statement expressions that lead to precisely this
202 bug.)
204 Jumping into a statement expression with @code{goto} or using a
205 @code{switch} statement outside the statement expression with a
206 @code{case} or @code{default} label inside the statement expression is
207 not permitted.  Jumping into a statement expression with a computed
208 @code{goto} (@pxref{Labels as Values}) has undefined behavior.
209 Jumping out of a statement expression is permitted, but if the
210 statement expression is part of a larger expression then it is
211 unspecified which other subexpressions of that expression have been
212 evaluated except where the language definition requires certain
213 subexpressions to be evaluated before or after the statement
214 expression.  In any case, as with a function call, the evaluation of a
215 statement expression is not interleaved with the evaluation of other
216 parts of the containing expression.  For example,
218 @smallexample
219   foo (), ((@{ bar1 (); goto a; 0; @}) + bar2 ()), baz();
220 @end smallexample
222 @noindent
223 calls @code{foo} and @code{bar1} and does not call @code{baz} but
224 may or may not call @code{bar2}.  If @code{bar2} is called, it is
225 called after @code{foo} and before @code{bar1}.
227 @node Local Labels
228 @section Locally Declared Labels
229 @cindex local labels
230 @cindex macros, local labels
232 GCC allows you to declare @dfn{local labels} in any nested block
233 scope.  A local label is just like an ordinary label, but you can
234 only reference it (with a @code{goto} statement, or by taking its
235 address) within the block in which it is declared.
237 A local label declaration looks like this:
239 @smallexample
240 __label__ @var{label};
241 @end smallexample
243 @noindent
246 @smallexample
247 __label__ @var{label1}, @var{label2}, /* @r{@dots{}} */;
248 @end smallexample
250 Local label declarations must come at the beginning of the block,
251 before any ordinary declarations or statements.
253 The label declaration defines the label @emph{name}, but does not define
254 the label itself.  You must do this in the usual way, with
255 @code{@var{label}:}, within the statements of the statement expression.
257 The local label feature is useful for complex macros.  If a macro
258 contains nested loops, a @code{goto} can be useful for breaking out of
259 them.  However, an ordinary label whose scope is the whole function
260 cannot be used: if the macro can be expanded several times in one
261 function, the label is multiply defined in that function.  A
262 local label avoids this problem.  For example:
264 @smallexample
265 #define SEARCH(value, array, target)              \
266 do @{                                              \
267   __label__ found;                                \
268   typeof (target) _SEARCH_target = (target);      \
269   typeof (*(array)) *_SEARCH_array = (array);     \
270   int i, j;                                       \
271   int value;                                      \
272   for (i = 0; i < max; i++)                       \
273     for (j = 0; j < max; j++)                     \
274       if (_SEARCH_array[i][j] == _SEARCH_target)  \
275         @{ (value) = i; goto found; @}              \
276   (value) = -1;                                   \
277  found:;                                          \
278 @} while (0)
279 @end smallexample
281 This could also be written using a statement expression:
283 @smallexample
284 #define SEARCH(array, target)                     \
285 (@{                                                \
286   __label__ found;                                \
287   typeof (target) _SEARCH_target = (target);      \
288   typeof (*(array)) *_SEARCH_array = (array);     \
289   int i, j;                                       \
290   int value;                                      \
291   for (i = 0; i < max; i++)                       \
292     for (j = 0; j < max; j++)                     \
293       if (_SEARCH_array[i][j] == _SEARCH_target)  \
294         @{ value = i; goto found; @}                \
295   value = -1;                                     \
296  found:                                           \
297   value;                                          \
299 @end smallexample
301 Local label declarations also make the labels they declare visible to
302 nested functions, if there are any.  @xref{Nested Functions}, for details.
304 @node Labels as Values
305 @section Labels as Values
306 @cindex labels as values
307 @cindex computed gotos
308 @cindex goto with computed label
309 @cindex address of a label
311 You can get the address of a label defined in the current function
312 (or a containing function) with the unary operator @samp{&&}.  The
313 value has type @code{void *}.  This value is a constant and can be used
314 wherever a constant of that type is valid.  For example:
316 @smallexample
317 void *ptr;
318 /* @r{@dots{}} */
319 ptr = &&foo;
320 @end smallexample
322 To use these values, you need to be able to jump to one.  This is done
323 with the computed goto statement@footnote{The analogous feature in
324 Fortran is called an assigned goto, but that name seems inappropriate in
325 C, where one can do more than simply store label addresses in label
326 variables.}, @code{goto *@var{exp};}.  For example,
328 @smallexample
329 goto *ptr;
330 @end smallexample
332 @noindent
333 Any expression of type @code{void *} is allowed.
335 One way of using these constants is in initializing a static array that
336 serves as a jump table:
338 @smallexample
339 static void *array[] = @{ &&foo, &&bar, &&hack @};
340 @end smallexample
342 @noindent
343 Then you can select a label with indexing, like this:
345 @smallexample
346 goto *array[i];
347 @end smallexample
349 @noindent
350 Note that this does not check whether the subscript is in bounds---array
351 indexing in C never does that.
353 Such an array of label values serves a purpose much like that of the
354 @code{switch} statement.  The @code{switch} statement is cleaner, so
355 use that rather than an array unless the problem does not fit a
356 @code{switch} statement very well.
358 Another use of label values is in an interpreter for threaded code.
359 The labels within the interpreter function can be stored in the
360 threaded code for super-fast dispatching.
362 You may not use this mechanism to jump to code in a different function.
363 If you do that, totally unpredictable things happen.  The best way to
364 avoid this is to store the label address only in automatic variables and
365 never pass it as an argument.
367 An alternate way to write the above example is
369 @smallexample
370 static const int array[] = @{ &&foo - &&foo, &&bar - &&foo,
371                              &&hack - &&foo @};
372 goto *(&&foo + array[i]);
373 @end smallexample
375 @noindent
376 This is more friendly to code living in shared libraries, as it reduces
377 the number of dynamic relocations that are needed, and by consequence,
378 allows the data to be read-only.
380 The @code{&&foo} expressions for the same label might have different
381 values if the containing function is inlined or cloned.  If a program
382 relies on them being always the same,
383 @code{__attribute__((__noinline__,__noclone__))} should be used to
384 prevent inlining and cloning.  If @code{&&foo} is used in a static
385 variable initializer, inlining and cloning is forbidden.
387 @node Nested Functions
388 @section Nested Functions
389 @cindex nested functions
390 @cindex downward funargs
391 @cindex thunks
393 A @dfn{nested function} is a function defined inside another function.
394 Nested functions are supported as an extension in GNU C, but are not
395 supported by GNU C++.
397 The nested function's name is local to the block where it is defined.
398 For example, here we define a nested function named @code{square}, and
399 call it twice:
401 @smallexample
402 @group
403 foo (double a, double b)
405   double square (double z) @{ return z * z; @}
407   return square (a) + square (b);
409 @end group
410 @end smallexample
412 The nested function can access all the variables of the containing
413 function that are visible at the point of its definition.  This is
414 called @dfn{lexical scoping}.  For example, here we show a nested
415 function which uses an inherited variable named @code{offset}:
417 @smallexample
418 @group
419 bar (int *array, int offset, int size)
421   int access (int *array, int index)
422     @{ return array[index + offset]; @}
423   int i;
424   /* @r{@dots{}} */
425   for (i = 0; i < size; i++)
426     /* @r{@dots{}} */ access (array, i) /* @r{@dots{}} */
428 @end group
429 @end smallexample
431 Nested function definitions are permitted within functions in the places
432 where variable definitions are allowed; that is, in any block, mixed
433 with the other declarations and statements in the block.
435 It is possible to call the nested function from outside the scope of its
436 name by storing its address or passing the address to another function:
438 @smallexample
439 hack (int *array, int size)
441   void store (int index, int value)
442     @{ array[index] = value; @}
444   intermediate (store, size);
446 @end smallexample
448 Here, the function @code{intermediate} receives the address of
449 @code{store} as an argument.  If @code{intermediate} calls @code{store},
450 the arguments given to @code{store} are used to store into @code{array}.
451 But this technique works only so long as the containing function
452 (@code{hack}, in this example) does not exit.
454 If you try to call the nested function through its address after the
455 containing function exits, all hell breaks loose.  If you try
456 to call it after a containing scope level exits, and if it refers
457 to some of the variables that are no longer in scope, you may be lucky,
458 but it's not wise to take the risk.  If, however, the nested function
459 does not refer to anything that has gone out of scope, you should be
460 safe.
462 GCC implements taking the address of a nested function using a technique
463 called @dfn{trampolines}.  This technique was described in
464 @cite{Lexical Closures for C++} (Thomas M. Breuel, USENIX
465 C++ Conference Proceedings, October 17-21, 1988).
467 A nested function can jump to a label inherited from a containing
468 function, provided the label is explicitly declared in the containing
469 function (@pxref{Local Labels}).  Such a jump returns instantly to the
470 containing function, exiting the nested function that did the
471 @code{goto} and any intermediate functions as well.  Here is an example:
473 @smallexample
474 @group
475 bar (int *array, int offset, int size)
477   __label__ failure;
478   int access (int *array, int index)
479     @{
480       if (index > size)
481         goto failure;
482       return array[index + offset];
483     @}
484   int i;
485   /* @r{@dots{}} */
486   for (i = 0; i < size; i++)
487     /* @r{@dots{}} */ access (array, i) /* @r{@dots{}} */
488   /* @r{@dots{}} */
489   return 0;
491  /* @r{Control comes here from @code{access}
492     if it detects an error.}  */
493  failure:
494   return -1;
496 @end group
497 @end smallexample
499 A nested function always has no linkage.  Declaring one with
500 @code{extern} or @code{static} is erroneous.  If you need to declare the nested function
501 before its definition, use @code{auto} (which is otherwise meaningless
502 for function declarations).
504 @smallexample
505 bar (int *array, int offset, int size)
507   __label__ failure;
508   auto int access (int *, int);
509   /* @r{@dots{}} */
510   int access (int *array, int index)
511     @{
512       if (index > size)
513         goto failure;
514       return array[index + offset];
515     @}
516   /* @r{@dots{}} */
518 @end smallexample
520 @node Constructing Calls
521 @section Constructing Function Calls
522 @cindex constructing calls
523 @cindex forwarding calls
525 Using the built-in functions described below, you can record
526 the arguments a function received, and call another function
527 with the same arguments, without knowing the number or types
528 of the arguments.
530 You can also record the return value of that function call,
531 and later return that value, without knowing what data type
532 the function tried to return (as long as your caller expects
533 that data type).
535 However, these built-in functions may interact badly with some
536 sophisticated features or other extensions of the language.  It
537 is, therefore, not recommended to use them outside very simple
538 functions acting as mere forwarders for their arguments.
540 @deftypefn {Built-in Function} {void *} __builtin_apply_args ()
541 This built-in function returns a pointer to data
542 describing how to perform a call with the same arguments as are passed
543 to the current function.
545 The function saves the arg pointer register, structure value address,
546 and all registers that might be used to pass arguments to a function
547 into a block of memory allocated on the stack.  Then it returns the
548 address of that block.
549 @end deftypefn
551 @deftypefn {Built-in Function} {void *} __builtin_apply (void (*@var{function})(), void *@var{arguments}, size_t @var{size})
552 This built-in function invokes @var{function}
553 with a copy of the parameters described by @var{arguments}
554 and @var{size}.
556 The value of @var{arguments} should be the value returned by
557 @code{__builtin_apply_args}.  The argument @var{size} specifies the size
558 of the stack argument data, in bytes.
560 This function returns a pointer to data describing
561 how to return whatever value is returned by @var{function}.  The data
562 is saved in a block of memory allocated on the stack.
564 It is not always simple to compute the proper value for @var{size}.  The
565 value is used by @code{__builtin_apply} to compute the amount of data
566 that should be pushed on the stack and copied from the incoming argument
567 area.
568 @end deftypefn
570 @deftypefn {Built-in Function} {void} __builtin_return (void *@var{result})
571 This built-in function returns the value described by @var{result} from
572 the containing function.  You should specify, for @var{result}, a value
573 returned by @code{__builtin_apply}.
574 @end deftypefn
576 @deftypefn {Built-in Function} {} __builtin_va_arg_pack ()
577 This built-in function represents all anonymous arguments of an inline
578 function.  It can be used only in inline functions that are always
579 inlined, never compiled as a separate function, such as those using
580 @code{__attribute__ ((__always_inline__))} or
581 @code{__attribute__ ((__gnu_inline__))} extern inline functions.
582 It must be only passed as last argument to some other function
583 with variable arguments.  This is useful for writing small wrapper
584 inlines for variable argument functions, when using preprocessor
585 macros is undesirable.  For example:
586 @smallexample
587 extern int myprintf (FILE *f, const char *format, ...);
588 extern inline __attribute__ ((__gnu_inline__)) int
589 myprintf (FILE *f, const char *format, ...)
591   int r = fprintf (f, "myprintf: ");
592   if (r < 0)
593     return r;
594   int s = fprintf (f, format, __builtin_va_arg_pack ());
595   if (s < 0)
596     return s;
597   return r + s;
599 @end smallexample
600 @end deftypefn
602 @deftypefn {Built-in Function} {size_t} __builtin_va_arg_pack_len ()
603 This built-in function returns the number of anonymous arguments of
604 an inline function.  It can be used only in inline functions that
605 are always inlined, never compiled as a separate function, such
606 as those using @code{__attribute__ ((__always_inline__))} or
607 @code{__attribute__ ((__gnu_inline__))} extern inline functions.
608 For example following does link- or run-time checking of open
609 arguments for optimized code:
610 @smallexample
611 #ifdef __OPTIMIZE__
612 extern inline __attribute__((__gnu_inline__)) int
613 myopen (const char *path, int oflag, ...)
615   if (__builtin_va_arg_pack_len () > 1)
616     warn_open_too_many_arguments ();
618   if (__builtin_constant_p (oflag))
619     @{
620       if ((oflag & O_CREAT) != 0 && __builtin_va_arg_pack_len () < 1)
621         @{
622           warn_open_missing_mode ();
623           return __open_2 (path, oflag);
624         @}
625       return open (path, oflag, __builtin_va_arg_pack ());
626     @}
628   if (__builtin_va_arg_pack_len () < 1)
629     return __open_2 (path, oflag);
631   return open (path, oflag, __builtin_va_arg_pack ());
633 #endif
634 @end smallexample
635 @end deftypefn
637 @node Typeof
638 @section Referring to a Type with @code{typeof}
639 @findex typeof
640 @findex sizeof
641 @cindex macros, types of arguments
643 Another way to refer to the type of an expression is with @code{typeof}.
644 The syntax of using of this keyword looks like @code{sizeof}, but the
645 construct acts semantically like a type name defined with @code{typedef}.
647 There are two ways of writing the argument to @code{typeof}: with an
648 expression or with a type.  Here is an example with an expression:
650 @smallexample
651 typeof (x[0](1))
652 @end smallexample
654 @noindent
655 This assumes that @code{x} is an array of pointers to functions;
656 the type described is that of the values of the functions.
658 Here is an example with a typename as the argument:
660 @smallexample
661 typeof (int *)
662 @end smallexample
664 @noindent
665 Here the type described is that of pointers to @code{int}.
667 If you are writing a header file that must work when included in ISO C
668 programs, write @code{__typeof__} instead of @code{typeof}.
669 @xref{Alternate Keywords}.
671 A @code{typeof} construct can be used anywhere a typedef name can be
672 used.  For example, you can use it in a declaration, in a cast, or inside
673 of @code{sizeof} or @code{typeof}.
675 The operand of @code{typeof} is evaluated for its side effects if and
676 only if it is an expression of variably modified type or the name of
677 such a type.
679 @code{typeof} is often useful in conjunction with
680 statement expressions (@pxref{Statement Exprs}).
681 Here is how the two together can
682 be used to define a safe ``maximum'' macro which operates on any
683 arithmetic type and evaluates each of its arguments exactly once:
685 @smallexample
686 #define max(a,b) \
687   (@{ typeof (a) _a = (a); \
688       typeof (b) _b = (b); \
689     _a > _b ? _a : _b; @})
690 @end smallexample
692 @cindex underscores in variables in macros
693 @cindex @samp{_} in variables in macros
694 @cindex local variables in macros
695 @cindex variables, local, in macros
696 @cindex macros, local variables in
698 The reason for using names that start with underscores for the local
699 variables is to avoid conflicts with variable names that occur within the
700 expressions that are substituted for @code{a} and @code{b}.  Eventually we
701 hope to design a new form of declaration syntax that allows you to declare
702 variables whose scopes start only after their initializers; this will be a
703 more reliable way to prevent such conflicts.
705 @noindent
706 Some more examples of the use of @code{typeof}:
708 @itemize @bullet
709 @item
710 This declares @code{y} with the type of what @code{x} points to.
712 @smallexample
713 typeof (*x) y;
714 @end smallexample
716 @item
717 This declares @code{y} as an array of such values.
719 @smallexample
720 typeof (*x) y[4];
721 @end smallexample
723 @item
724 This declares @code{y} as an array of pointers to characters:
726 @smallexample
727 typeof (typeof (char *)[4]) y;
728 @end smallexample
730 @noindent
731 It is equivalent to the following traditional C declaration:
733 @smallexample
734 char *y[4];
735 @end smallexample
737 To see the meaning of the declaration using @code{typeof}, and why it
738 might be a useful way to write, rewrite it with these macros:
740 @smallexample
741 #define pointer(T)  typeof(T *)
742 #define array(T, N) typeof(T [N])
743 @end smallexample
745 @noindent
746 Now the declaration can be rewritten this way:
748 @smallexample
749 array (pointer (char), 4) y;
750 @end smallexample
752 @noindent
753 Thus, @code{array (pointer (char), 4)} is the type of arrays of 4
754 pointers to @code{char}.
755 @end itemize
757 @emph{Compatibility Note:} In addition to @code{typeof}, GCC 2 supported
758 a more limited extension that permitted one to write
760 @smallexample
761 typedef @var{T} = @var{expr};
762 @end smallexample
764 @noindent
765 with the effect of declaring @var{T} to have the type of the expression
766 @var{expr}.  This extension does not work with GCC 3 (versions between
767 3.0 and 3.2 crash; 3.2.1 and later give an error).  Code that
768 relies on it should be rewritten to use @code{typeof}:
770 @smallexample
771 typedef typeof(@var{expr}) @var{T};
772 @end smallexample
774 @noindent
775 This works with all versions of GCC@.
777 @node Conditionals
778 @section Conditionals with Omitted Operands
779 @cindex conditional expressions, extensions
780 @cindex omitted middle-operands
781 @cindex middle-operands, omitted
782 @cindex extensions, @code{?:}
783 @cindex @code{?:} extensions
785 The middle operand in a conditional expression may be omitted.  Then
786 if the first operand is nonzero, its value is the value of the conditional
787 expression.
789 Therefore, the expression
791 @smallexample
792 x ? : y
793 @end smallexample
795 @noindent
796 has the value of @code{x} if that is nonzero; otherwise, the value of
797 @code{y}.
799 This example is perfectly equivalent to
801 @smallexample
802 x ? x : y
803 @end smallexample
805 @cindex side effect in @code{?:}
806 @cindex @code{?:} side effect
807 @noindent
808 In this simple case, the ability to omit the middle operand is not
809 especially useful.  When it becomes useful is when the first operand does,
810 or may (if it is a macro argument), contain a side effect.  Then repeating
811 the operand in the middle would perform the side effect twice.  Omitting
812 the middle operand uses the value already computed without the undesirable
813 effects of recomputing it.
815 @node __int128
816 @section 128-bits integers
817 @cindex @code{__int128} data types
819 As an extension the integer scalar type @code{__int128} is supported for
820 targets having an integer mode wide enough to hold 128 bits.
821 Simply write @code{__int128} for a signed 128-bit integer, or
822 @code{unsigned __int128} for an unsigned 128-bit integer.  There is no
823 support in GCC to express an integer constant of type @code{__int128}
824 for targets having @code{long long} integer less than 128 bits wide.
826 @node Long Long
827 @section Double-Word Integers
828 @cindex @code{long long} data types
829 @cindex double-word arithmetic
830 @cindex multiprecision arithmetic
831 @cindex @code{LL} integer suffix
832 @cindex @code{ULL} integer suffix
834 ISO C99 supports data types for integers that are at least 64 bits wide,
835 and as an extension GCC supports them in C90 mode and in C++.
836 Simply write @code{long long int} for a signed integer, or
837 @code{unsigned long long int} for an unsigned integer.  To make an
838 integer constant of type @code{long long int}, add the suffix @samp{LL}
839 to the integer.  To make an integer constant of type @code{unsigned long
840 long int}, add the suffix @samp{ULL} to the integer.
842 You can use these types in arithmetic like any other integer types.
843 Addition, subtraction, and bitwise boolean operations on these types
844 are open-coded on all types of machines.  Multiplication is open-coded
845 if the machine supports a fullword-to-doubleword widening multiply
846 instruction.  Division and shifts are open-coded only on machines that
847 provide special support.  The operations that are not open-coded use
848 special library routines that come with GCC@.
850 There may be pitfalls when you use @code{long long} types for function
851 arguments without function prototypes.  If a function
852 expects type @code{int} for its argument, and you pass a value of type
853 @code{long long int}, confusion results because the caller and the
854 subroutine disagree about the number of bytes for the argument.
855 Likewise, if the function expects @code{long long int} and you pass
856 @code{int}.  The best way to avoid such problems is to use prototypes.
858 @node Complex
859 @section Complex Numbers
860 @cindex complex numbers
861 @cindex @code{_Complex} keyword
862 @cindex @code{__complex__} keyword
864 ISO C99 supports complex floating data types, and as an extension GCC
865 supports them in C90 mode and in C++.  GCC also supports complex integer data
866 types which are not part of ISO C99.  You can declare complex types
867 using the keyword @code{_Complex}.  As an extension, the older GNU
868 keyword @code{__complex__} is also supported.
870 For example, @samp{_Complex double x;} declares @code{x} as a
871 variable whose real part and imaginary part are both of type
872 @code{double}.  @samp{_Complex short int y;} declares @code{y} to
873 have real and imaginary parts of type @code{short int}; this is not
874 likely to be useful, but it shows that the set of complex types is
875 complete.
877 To write a constant with a complex data type, use the suffix @samp{i} or
878 @samp{j} (either one; they are equivalent).  For example, @code{2.5fi}
879 has type @code{_Complex float} and @code{3i} has type
880 @code{_Complex int}.  Such a constant always has a pure imaginary
881 value, but you can form any complex value you like by adding one to a
882 real constant.  This is a GNU extension; if you have an ISO C99
883 conforming C library (such as the GNU C Library), and want to construct complex
884 constants of floating type, you should include @code{<complex.h>} and
885 use the macros @code{I} or @code{_Complex_I} instead.
887 @cindex @code{__real__} keyword
888 @cindex @code{__imag__} keyword
889 To extract the real part of a complex-valued expression @var{exp}, write
890 @code{__real__ @var{exp}}.  Likewise, use @code{__imag__} to
891 extract the imaginary part.  This is a GNU extension; for values of
892 floating type, you should use the ISO C99 functions @code{crealf},
893 @code{creal}, @code{creall}, @code{cimagf}, @code{cimag} and
894 @code{cimagl}, declared in @code{<complex.h>} and also provided as
895 built-in functions by GCC@.
897 @cindex complex conjugation
898 The operator @samp{~} performs complex conjugation when used on a value
899 with a complex type.  This is a GNU extension; for values of
900 floating type, you should use the ISO C99 functions @code{conjf},
901 @code{conj} and @code{conjl}, declared in @code{<complex.h>} and also
902 provided as built-in functions by GCC@.
904 GCC can allocate complex automatic variables in a noncontiguous
905 fashion; it's even possible for the real part to be in a register while
906 the imaginary part is on the stack (or vice versa).  Only the DWARF 2
907 debug info format can represent this, so use of DWARF 2 is recommended.
908 If you are using the stabs debug info format, GCC describes a noncontiguous
909 complex variable as if it were two separate variables of noncomplex type.
910 If the variable's actual name is @code{foo}, the two fictitious
911 variables are named @code{foo$real} and @code{foo$imag}.  You can
912 examine and set these two fictitious variables with your debugger.
914 @node Floating Types
915 @section Additional Floating Types
916 @cindex additional floating types
917 @cindex @code{__float80} data type
918 @cindex @code{__float128} data type
919 @cindex @code{w} floating point suffix
920 @cindex @code{q} floating point suffix
921 @cindex @code{W} floating point suffix
922 @cindex @code{Q} floating point suffix
924 As an extension, GNU C supports additional floating
925 types, @code{__float80} and @code{__float128} to support 80-bit
926 (@code{XFmode}) and 128-bit (@code{TFmode}) floating types.
927 Support for additional types includes the arithmetic operators:
928 add, subtract, multiply, divide; unary arithmetic operators;
929 relational operators; equality operators; and conversions to and from
930 integer and other floating types.  Use a suffix @samp{w} or @samp{W}
931 in a literal constant of type @code{__float80} and @samp{q} or @samp{Q}
932 for @code{_float128}.  You can declare complex types using the
933 corresponding internal complex type, @code{XCmode} for @code{__float80}
934 type and @code{TCmode} for @code{__float128} type:
936 @smallexample
937 typedef _Complex float __attribute__((mode(TC))) _Complex128;
938 typedef _Complex float __attribute__((mode(XC))) _Complex80;
939 @end smallexample
941 Not all targets support additional floating-point types.  @code{__float80}
942 and @code{__float128} types are supported on i386, x86_64 and IA-64 targets.
943 The @code{__float128} type is supported on hppa HP-UX targets.
945 @node Half-Precision
946 @section Half-Precision Floating Point
947 @cindex half-precision floating point
948 @cindex @code{__fp16} data type
950 On ARM targets, GCC supports half-precision (16-bit) floating point via
951 the @code{__fp16} type.  You must enable this type explicitly
952 with the @option{-mfp16-format} command-line option in order to use it.
954 ARM supports two incompatible representations for half-precision
955 floating-point values.  You must choose one of the representations and
956 use it consistently in your program.
958 Specifying @option{-mfp16-format=ieee} selects the IEEE 754-2008 format.
959 This format can represent normalized values in the range of @math{2^{-14}} to 65504.
960 There are 11 bits of significand precision, approximately 3
961 decimal digits.
963 Specifying @option{-mfp16-format=alternative} selects the ARM
964 alternative format.  This representation is similar to the IEEE
965 format, but does not support infinities or NaNs.  Instead, the range
966 of exponents is extended, so that this format can represent normalized
967 values in the range of @math{2^{-14}} to 131008.
969 The @code{__fp16} type is a storage format only.  For purposes
970 of arithmetic and other operations, @code{__fp16} values in C or C++
971 expressions are automatically promoted to @code{float}.  In addition,
972 you cannot declare a function with a return value or parameters
973 of type @code{__fp16}.
975 Note that conversions from @code{double} to @code{__fp16}
976 involve an intermediate conversion to @code{float}.  Because
977 of rounding, this can sometimes produce a different result than a
978 direct conversion.
980 ARM provides hardware support for conversions between
981 @code{__fp16} and @code{float} values
982 as an extension to VFP and NEON (Advanced SIMD).  GCC generates
983 code using these hardware instructions if you compile with
984 options to select an FPU that provides them;
985 for example, @option{-mfpu=neon-fp16 -mfloat-abi=softfp},
986 in addition to the @option{-mfp16-format} option to select
987 a half-precision format.
989 Language-level support for the @code{__fp16} data type is
990 independent of whether GCC generates code using hardware floating-point
991 instructions.  In cases where hardware support is not specified, GCC
992 implements conversions between @code{__fp16} and @code{float} values
993 as library calls.
995 @node Decimal Float
996 @section Decimal Floating Types
997 @cindex decimal floating types
998 @cindex @code{_Decimal32} data type
999 @cindex @code{_Decimal64} data type
1000 @cindex @code{_Decimal128} data type
1001 @cindex @code{df} integer suffix
1002 @cindex @code{dd} integer suffix
1003 @cindex @code{dl} integer suffix
1004 @cindex @code{DF} integer suffix
1005 @cindex @code{DD} integer suffix
1006 @cindex @code{DL} integer suffix
1008 As an extension, GNU C supports decimal floating types as
1009 defined in the N1312 draft of ISO/IEC WDTR24732.  Support for decimal
1010 floating types in GCC will evolve as the draft technical report changes.
1011 Calling conventions for any target might also change.  Not all targets
1012 support decimal floating types.
1014 The decimal floating types are @code{_Decimal32}, @code{_Decimal64}, and
1015 @code{_Decimal128}.  They use a radix of ten, unlike the floating types
1016 @code{float}, @code{double}, and @code{long double} whose radix is not
1017 specified by the C standard but is usually two.
1019 Support for decimal floating types includes the arithmetic operators
1020 add, subtract, multiply, divide; unary arithmetic operators;
1021 relational operators; equality operators; and conversions to and from
1022 integer and other floating types.  Use a suffix @samp{df} or
1023 @samp{DF} in a literal constant of type @code{_Decimal32}, @samp{dd}
1024 or @samp{DD} for @code{_Decimal64}, and @samp{dl} or @samp{DL} for
1025 @code{_Decimal128}.
1027 GCC support of decimal float as specified by the draft technical report
1028 is incomplete:
1030 @itemize @bullet
1031 @item
1032 When the value of a decimal floating type cannot be represented in the
1033 integer type to which it is being converted, the result is undefined
1034 rather than the result value specified by the draft technical report.
1036 @item
1037 GCC does not provide the C library functionality associated with
1038 @file{math.h}, @file{fenv.h}, @file{stdio.h}, @file{stdlib.h}, and
1039 @file{wchar.h}, which must come from a separate C library implementation.
1040 Because of this the GNU C compiler does not define macro
1041 @code{__STDC_DEC_FP__} to indicate that the implementation conforms to
1042 the technical report.
1043 @end itemize
1045 Types @code{_Decimal32}, @code{_Decimal64}, and @code{_Decimal128}
1046 are supported by the DWARF 2 debug information format.
1048 @node Hex Floats
1049 @section Hex Floats
1050 @cindex hex floats
1052 ISO C99 supports floating-point numbers written not only in the usual
1053 decimal notation, such as @code{1.55e1}, but also numbers such as
1054 @code{0x1.fp3} written in hexadecimal format.  As a GNU extension, GCC
1055 supports this in C90 mode (except in some cases when strictly
1056 conforming) and in C++.  In that format the
1057 @samp{0x} hex introducer and the @samp{p} or @samp{P} exponent field are
1058 mandatory.  The exponent is a decimal number that indicates the power of
1059 2 by which the significant part is multiplied.  Thus @samp{0x1.f} is
1060 @tex
1061 $1 {15\over16}$,
1062 @end tex
1063 @ifnottex
1064 1 15/16,
1065 @end ifnottex
1066 @samp{p3} multiplies it by 8, and the value of @code{0x1.fp3}
1067 is the same as @code{1.55e1}.
1069 Unlike for floating-point numbers in the decimal notation the exponent
1070 is always required in the hexadecimal notation.  Otherwise the compiler
1071 would not be able to resolve the ambiguity of, e.g., @code{0x1.f}.  This
1072 could mean @code{1.0f} or @code{1.9375} since @samp{f} is also the
1073 extension for floating-point constants of type @code{float}.
1075 @node Fixed-Point
1076 @section Fixed-Point Types
1077 @cindex fixed-point types
1078 @cindex @code{_Fract} data type
1079 @cindex @code{_Accum} data type
1080 @cindex @code{_Sat} data type
1081 @cindex @code{hr} fixed-suffix
1082 @cindex @code{r} fixed-suffix
1083 @cindex @code{lr} fixed-suffix
1084 @cindex @code{llr} fixed-suffix
1085 @cindex @code{uhr} fixed-suffix
1086 @cindex @code{ur} fixed-suffix
1087 @cindex @code{ulr} fixed-suffix
1088 @cindex @code{ullr} fixed-suffix
1089 @cindex @code{hk} fixed-suffix
1090 @cindex @code{k} fixed-suffix
1091 @cindex @code{lk} fixed-suffix
1092 @cindex @code{llk} fixed-suffix
1093 @cindex @code{uhk} fixed-suffix
1094 @cindex @code{uk} fixed-suffix
1095 @cindex @code{ulk} fixed-suffix
1096 @cindex @code{ullk} fixed-suffix
1097 @cindex @code{HR} fixed-suffix
1098 @cindex @code{R} fixed-suffix
1099 @cindex @code{LR} fixed-suffix
1100 @cindex @code{LLR} fixed-suffix
1101 @cindex @code{UHR} fixed-suffix
1102 @cindex @code{UR} fixed-suffix
1103 @cindex @code{ULR} fixed-suffix
1104 @cindex @code{ULLR} fixed-suffix
1105 @cindex @code{HK} fixed-suffix
1106 @cindex @code{K} fixed-suffix
1107 @cindex @code{LK} fixed-suffix
1108 @cindex @code{LLK} fixed-suffix
1109 @cindex @code{UHK} fixed-suffix
1110 @cindex @code{UK} fixed-suffix
1111 @cindex @code{ULK} fixed-suffix
1112 @cindex @code{ULLK} fixed-suffix
1114 As an extension, GNU C supports fixed-point types as
1115 defined in the N1169 draft of ISO/IEC DTR 18037.  Support for fixed-point
1116 types in GCC will evolve as the draft technical report changes.
1117 Calling conventions for any target might also change.  Not all targets
1118 support fixed-point types.
1120 The fixed-point types are
1121 @code{short _Fract},
1122 @code{_Fract},
1123 @code{long _Fract},
1124 @code{long long _Fract},
1125 @code{unsigned short _Fract},
1126 @code{unsigned _Fract},
1127 @code{unsigned long _Fract},
1128 @code{unsigned long long _Fract},
1129 @code{_Sat short _Fract},
1130 @code{_Sat _Fract},
1131 @code{_Sat long _Fract},
1132 @code{_Sat long long _Fract},
1133 @code{_Sat unsigned short _Fract},
1134 @code{_Sat unsigned _Fract},
1135 @code{_Sat unsigned long _Fract},
1136 @code{_Sat unsigned long long _Fract},
1137 @code{short _Accum},
1138 @code{_Accum},
1139 @code{long _Accum},
1140 @code{long long _Accum},
1141 @code{unsigned short _Accum},
1142 @code{unsigned _Accum},
1143 @code{unsigned long _Accum},
1144 @code{unsigned long long _Accum},
1145 @code{_Sat short _Accum},
1146 @code{_Sat _Accum},
1147 @code{_Sat long _Accum},
1148 @code{_Sat long long _Accum},
1149 @code{_Sat unsigned short _Accum},
1150 @code{_Sat unsigned _Accum},
1151 @code{_Sat unsigned long _Accum},
1152 @code{_Sat unsigned long long _Accum}.
1154 Fixed-point data values contain fractional and optional integral parts.
1155 The format of fixed-point data varies and depends on the target machine.
1157 Support for fixed-point types includes:
1158 @itemize @bullet
1159 @item
1160 prefix and postfix increment and decrement operators (@code{++}, @code{--})
1161 @item
1162 unary arithmetic operators (@code{+}, @code{-}, @code{!})
1163 @item
1164 binary arithmetic operators (@code{+}, @code{-}, @code{*}, @code{/})
1165 @item
1166 binary shift operators (@code{<<}, @code{>>})
1167 @item
1168 relational operators (@code{<}, @code{<=}, @code{>=}, @code{>})
1169 @item
1170 equality operators (@code{==}, @code{!=})
1171 @item
1172 assignment operators (@code{+=}, @code{-=}, @code{*=}, @code{/=},
1173 @code{<<=}, @code{>>=})
1174 @item
1175 conversions to and from integer, floating-point, or fixed-point types
1176 @end itemize
1178 Use a suffix in a fixed-point literal constant:
1179 @itemize
1180 @item @samp{hr} or @samp{HR} for @code{short _Fract} and
1181 @code{_Sat short _Fract}
1182 @item @samp{r} or @samp{R} for @code{_Fract} and @code{_Sat _Fract}
1183 @item @samp{lr} or @samp{LR} for @code{long _Fract} and
1184 @code{_Sat long _Fract}
1185 @item @samp{llr} or @samp{LLR} for @code{long long _Fract} and
1186 @code{_Sat long long _Fract}
1187 @item @samp{uhr} or @samp{UHR} for @code{unsigned short _Fract} and
1188 @code{_Sat unsigned short _Fract}
1189 @item @samp{ur} or @samp{UR} for @code{unsigned _Fract} and
1190 @code{_Sat unsigned _Fract}
1191 @item @samp{ulr} or @samp{ULR} for @code{unsigned long _Fract} and
1192 @code{_Sat unsigned long _Fract}
1193 @item @samp{ullr} or @samp{ULLR} for @code{unsigned long long _Fract}
1194 and @code{_Sat unsigned long long _Fract}
1195 @item @samp{hk} or @samp{HK} for @code{short _Accum} and
1196 @code{_Sat short _Accum}
1197 @item @samp{k} or @samp{K} for @code{_Accum} and @code{_Sat _Accum}
1198 @item @samp{lk} or @samp{LK} for @code{long _Accum} and
1199 @code{_Sat long _Accum}
1200 @item @samp{llk} or @samp{LLK} for @code{long long _Accum} and
1201 @code{_Sat long long _Accum}
1202 @item @samp{uhk} or @samp{UHK} for @code{unsigned short _Accum} and
1203 @code{_Sat unsigned short _Accum}
1204 @item @samp{uk} or @samp{UK} for @code{unsigned _Accum} and
1205 @code{_Sat unsigned _Accum}
1206 @item @samp{ulk} or @samp{ULK} for @code{unsigned long _Accum} and
1207 @code{_Sat unsigned long _Accum}
1208 @item @samp{ullk} or @samp{ULLK} for @code{unsigned long long _Accum}
1209 and @code{_Sat unsigned long long _Accum}
1210 @end itemize
1212 GCC support of fixed-point types as specified by the draft technical report
1213 is incomplete:
1215 @itemize @bullet
1216 @item
1217 Pragmas to control overflow and rounding behaviors are not implemented.
1218 @end itemize
1220 Fixed-point types are supported by the DWARF 2 debug information format.
1222 @node Named Address Spaces
1223 @section Named Address Spaces
1224 @cindex Named Address Spaces
1226 As an extension, GNU C supports named address spaces as
1227 defined in the N1275 draft of ISO/IEC DTR 18037.  Support for named
1228 address spaces in GCC will evolve as the draft technical report
1229 changes.  Calling conventions for any target might also change.  At
1230 present, only the AVR, SPU, M32C, and RL78 targets support address
1231 spaces other than the generic address space.
1233 Address space identifiers may be used exactly like any other C type
1234 qualifier (e.g., @code{const} or @code{volatile}).  See the N1275
1235 document for more details.
1237 @anchor{AVR Named Address Spaces}
1238 @subsection AVR Named Address Spaces
1240 On the AVR target, there are several address spaces that can be used
1241 in order to put read-only data into the flash memory and access that
1242 data by means of the special instructions @code{LPM} or @code{ELPM}
1243 needed to read from flash.
1245 Per default, any data including read-only data is located in RAM
1246 (the generic address space) so that non-generic address spaces are
1247 needed to locate read-only data in flash memory
1248 @emph{and} to generate the right instructions to access this data
1249 without using (inline) assembler code.
1251 @table @code
1252 @item __flash
1253 @cindex @code{__flash} AVR Named Address Spaces
1254 The @code{__flash} qualifier locates data in the
1255 @code{.progmem.data} section. Data is read using the @code{LPM}
1256 instruction. Pointers to this address space are 16 bits wide.
1258 @item __flash1
1259 @itemx __flash2
1260 @itemx __flash3
1261 @itemx __flash4
1262 @itemx __flash5
1263 @cindex @code{__flash1} AVR Named Address Spaces
1264 @cindex @code{__flash2} AVR Named Address Spaces
1265 @cindex @code{__flash3} AVR Named Address Spaces
1266 @cindex @code{__flash4} AVR Named Address Spaces
1267 @cindex @code{__flash5} AVR Named Address Spaces
1268 These are 16-bit address spaces locating data in section
1269 @code{.progmem@var{N}.data} where @var{N} refers to
1270 address space @code{__flash@var{N}}.
1271 The compiler sets the @code{RAMPZ} segment register appropriately 
1272 before reading data by means of the @code{ELPM} instruction.
1274 @item __memx
1275 @cindex @code{__memx} AVR Named Address Spaces
1276 This is a 24-bit address space that linearizes flash and RAM:
1277 If the high bit of the address is set, data is read from
1278 RAM using the lower two bytes as RAM address.
1279 If the high bit of the address is clear, data is read from flash
1280 with @code{RAMPZ} set according to the high byte of the address.
1281 @xref{AVR Built-in Functions,,@code{__builtin_avr_flash_segment}}.
1283 Objects in this address space are located in @code{.progmemx.data}.
1284 @end table
1286 @b{Example}
1288 @smallexample
1289 char my_read (const __flash char ** p)
1291     /* p is a pointer to RAM that points to a pointer to flash.
1292        The first indirection of p reads that flash pointer
1293        from RAM and the second indirection reads a char from this
1294        flash address.  */
1296     return **p;
1299 /* Locate array[] in flash memory */
1300 const __flash int array[] = @{ 3, 5, 7, 11, 13, 17, 19 @};
1302 int i = 1;
1304 int main (void)
1306    /* Return 17 by reading from flash memory */
1307    return array[array[i]];
1309 @end smallexample
1311 @noindent
1312 For each named address space supported by avr-gcc there is an equally
1313 named but uppercase built-in macro defined. 
1314 The purpose is to facilitate testing if respective address space
1315 support is available or not:
1317 @smallexample
1318 #ifdef __FLASH
1319 const __flash int var = 1;
1321 int read_var (void)
1323     return var;
1325 #else
1326 #include <avr/pgmspace.h> /* From AVR-LibC */
1328 const int var PROGMEM = 1;
1330 int read_var (void)
1332     return (int) pgm_read_word (&var);
1334 #endif /* __FLASH */
1335 @end smallexample
1337 @noindent
1338 Notice that attribute @ref{AVR Variable Attributes,,@code{progmem}}
1339 locates data in flash but
1340 accesses to these data read from generic address space, i.e.@:
1341 from RAM,
1342 so that you need special accessors like @code{pgm_read_byte}
1343 from @w{@uref{http://nongnu.org/avr-libc/user-manual,AVR-LibC}}
1344 together with attribute @code{progmem}.
1346 @noindent
1347 @b{Limitations and caveats}
1349 @itemize
1350 @item
1351 Reading across the 64@tie{}KiB section boundary of
1352 the @code{__flash} or @code{__flash@var{N}} address spaces
1353 shows undefined behavior. The only address space that
1354 supports reading across the 64@tie{}KiB flash segment boundaries is
1355 @code{__memx}.
1357 @item
1358 If you use one of the @code{__flash@var{N}} address spaces
1359 you must arrange your linker script to locate the
1360 @code{.progmem@var{N}.data} sections according to your needs.
1362 @item
1363 Any data or pointers to the non-generic address spaces must
1364 be qualified as @code{const}, i.e.@: as read-only data.
1365 This still applies if the data in one of these address
1366 spaces like software version number or calibration lookup table are intended to
1367 be changed after load time by, say, a boot loader. In this case
1368 the right qualification is @code{const} @code{volatile} so that the compiler
1369 must not optimize away known values or insert them
1370 as immediates into operands of instructions.
1372 @item
1373 The following code initializes a variable @code{pfoo}
1374 located in static storage with a 24-bit address:
1375 @smallexample
1376 extern const __memx char foo;
1377 const __memx void *pfoo = &foo;
1378 @end smallexample
1380 @noindent
1381 Such code requires at least binutils 2.23, see
1382 @w{@uref{http://sourceware.org/PR13503,PR13503}}.
1384 @end itemize
1386 @subsection M32C Named Address Spaces
1387 @cindex @code{__far} M32C Named Address Spaces
1389 On the M32C target, with the R8C and M16C CPU variants, variables
1390 qualified with @code{__far} are accessed using 32-bit addresses in
1391 order to access memory beyond the first 64@tie{}Ki bytes.  If
1392 @code{__far} is used with the M32CM or M32C CPU variants, it has no
1393 effect.
1395 @subsection RL78 Named Address Spaces
1396 @cindex @code{__far} RL78 Named Address Spaces
1398 On the RL78 target, variables qualified with @code{__far} are accessed
1399 with 32-bit pointers (20-bit addresses) rather than the default 16-bit
1400 addresses.  Non-far variables are assumed to appear in the topmost
1401 64@tie{}KiB of the address space.
1403 @subsection SPU Named Address Spaces
1404 @cindex @code{__ea} SPU Named Address Spaces
1406 On the SPU target variables may be declared as
1407 belonging to another address space by qualifying the type with the
1408 @code{__ea} address space identifier:
1410 @smallexample
1411 extern int __ea i;
1412 @end smallexample
1414 @noindent 
1415 The compiler generates special code to access the variable @code{i}.
1416 It may use runtime library
1417 support, or generate special machine instructions to access that address
1418 space.
1420 @node Zero Length
1421 @section Arrays of Length Zero
1422 @cindex arrays of length zero
1423 @cindex zero-length arrays
1424 @cindex length-zero arrays
1425 @cindex flexible array members
1427 Zero-length arrays are allowed in GNU C@.  They are very useful as the
1428 last element of a structure that is really a header for a variable-length
1429 object:
1431 @smallexample
1432 struct line @{
1433   int length;
1434   char contents[0];
1437 struct line *thisline = (struct line *)
1438   malloc (sizeof (struct line) + this_length);
1439 thisline->length = this_length;
1440 @end smallexample
1442 In ISO C90, you would have to give @code{contents} a length of 1, which
1443 means either you waste space or complicate the argument to @code{malloc}.
1445 In ISO C99, you would use a @dfn{flexible array member}, which is
1446 slightly different in syntax and semantics:
1448 @itemize @bullet
1449 @item
1450 Flexible array members are written as @code{contents[]} without
1451 the @code{0}.
1453 @item
1454 Flexible array members have incomplete type, and so the @code{sizeof}
1455 operator may not be applied.  As a quirk of the original implementation
1456 of zero-length arrays, @code{sizeof} evaluates to zero.
1458 @item
1459 Flexible array members may only appear as the last member of a
1460 @code{struct} that is otherwise non-empty.
1462 @item
1463 A structure containing a flexible array member, or a union containing
1464 such a structure (possibly recursively), may not be a member of a
1465 structure or an element of an array.  (However, these uses are
1466 permitted by GCC as extensions.)
1467 @end itemize
1469 GCC versions before 3.0 allowed zero-length arrays to be statically
1470 initialized, as if they were flexible arrays.  In addition to those
1471 cases that were useful, it also allowed initializations in situations
1472 that would corrupt later data.  Non-empty initialization of zero-length
1473 arrays is now treated like any case where there are more initializer
1474 elements than the array holds, in that a suitable warning about ``excess
1475 elements in array'' is given, and the excess elements (all of them, in
1476 this case) are ignored.
1478 Instead GCC allows static initialization of flexible array members.
1479 This is equivalent to defining a new structure containing the original
1480 structure followed by an array of sufficient size to contain the data.
1481 E.g.@: in the following, @code{f1} is constructed as if it were declared
1482 like @code{f2}.
1484 @smallexample
1485 struct f1 @{
1486   int x; int y[];
1487 @} f1 = @{ 1, @{ 2, 3, 4 @} @};
1489 struct f2 @{
1490   struct f1 f1; int data[3];
1491 @} f2 = @{ @{ 1 @}, @{ 2, 3, 4 @} @};
1492 @end smallexample
1494 @noindent
1495 The convenience of this extension is that @code{f1} has the desired
1496 type, eliminating the need to consistently refer to @code{f2.f1}.
1498 This has symmetry with normal static arrays, in that an array of
1499 unknown size is also written with @code{[]}.
1501 Of course, this extension only makes sense if the extra data comes at
1502 the end of a top-level object, as otherwise we would be overwriting
1503 data at subsequent offsets.  To avoid undue complication and confusion
1504 with initialization of deeply nested arrays, we simply disallow any
1505 non-empty initialization except when the structure is the top-level
1506 object.  For example:
1508 @smallexample
1509 struct foo @{ int x; int y[]; @};
1510 struct bar @{ struct foo z; @};
1512 struct foo a = @{ 1, @{ 2, 3, 4 @} @};        // @r{Valid.}
1513 struct bar b = @{ @{ 1, @{ 2, 3, 4 @} @} @};    // @r{Invalid.}
1514 struct bar c = @{ @{ 1, @{ @} @} @};            // @r{Valid.}
1515 struct foo d[1] = @{ @{ 1 @{ 2, 3, 4 @} @} @};  // @r{Invalid.}
1516 @end smallexample
1518 @node Empty Structures
1519 @section Structures With No Members
1520 @cindex empty structures
1521 @cindex zero-size structures
1523 GCC permits a C structure to have no members:
1525 @smallexample
1526 struct empty @{
1528 @end smallexample
1530 The structure has size zero.  In C++, empty structures are part
1531 of the language.  G++ treats empty structures as if they had a single
1532 member of type @code{char}.
1534 @node Variable Length
1535 @section Arrays of Variable Length
1536 @cindex variable-length arrays
1537 @cindex arrays of variable length
1538 @cindex VLAs
1540 Variable-length automatic arrays are allowed in ISO C99, and as an
1541 extension GCC accepts them in C90 mode and in C++.  These arrays are
1542 declared like any other automatic arrays, but with a length that is not
1543 a constant expression.  The storage is allocated at the point of
1544 declaration and deallocated when the block scope containing the declaration
1545 exits.  For
1546 example:
1548 @smallexample
1549 FILE *
1550 concat_fopen (char *s1, char *s2, char *mode)
1552   char str[strlen (s1) + strlen (s2) + 1];
1553   strcpy (str, s1);
1554   strcat (str, s2);
1555   return fopen (str, mode);
1557 @end smallexample
1559 @cindex scope of a variable length array
1560 @cindex variable-length array scope
1561 @cindex deallocating variable length arrays
1562 Jumping or breaking out of the scope of the array name deallocates the
1563 storage.  Jumping into the scope is not allowed; you get an error
1564 message for it.
1566 @cindex @code{alloca} vs variable-length arrays
1567 You can use the function @code{alloca} to get an effect much like
1568 variable-length arrays.  The function @code{alloca} is available in
1569 many other C implementations (but not in all).  On the other hand,
1570 variable-length arrays are more elegant.
1572 There are other differences between these two methods.  Space allocated
1573 with @code{alloca} exists until the containing @emph{function} returns.
1574 The space for a variable-length array is deallocated as soon as the array
1575 name's scope ends.  (If you use both variable-length arrays and
1576 @code{alloca} in the same function, deallocation of a variable-length array
1577 also deallocates anything more recently allocated with @code{alloca}.)
1579 You can also use variable-length arrays as arguments to functions:
1581 @smallexample
1582 struct entry
1583 tester (int len, char data[len][len])
1585   /* @r{@dots{}} */
1587 @end smallexample
1589 The length of an array is computed once when the storage is allocated
1590 and is remembered for the scope of the array in case you access it with
1591 @code{sizeof}.
1593 If you want to pass the array first and the length afterward, you can
1594 use a forward declaration in the parameter list---another GNU extension.
1596 @smallexample
1597 struct entry
1598 tester (int len; char data[len][len], int len)
1600   /* @r{@dots{}} */
1602 @end smallexample
1604 @cindex parameter forward declaration
1605 The @samp{int len} before the semicolon is a @dfn{parameter forward
1606 declaration}, and it serves the purpose of making the name @code{len}
1607 known when the declaration of @code{data} is parsed.
1609 You can write any number of such parameter forward declarations in the
1610 parameter list.  They can be separated by commas or semicolons, but the
1611 last one must end with a semicolon, which is followed by the ``real''
1612 parameter declarations.  Each forward declaration must match a ``real''
1613 declaration in parameter name and data type.  ISO C99 does not support
1614 parameter forward declarations.
1616 @node Variadic Macros
1617 @section Macros with a Variable Number of Arguments.
1618 @cindex variable number of arguments
1619 @cindex macro with variable arguments
1620 @cindex rest argument (in macro)
1621 @cindex variadic macros
1623 In the ISO C standard of 1999, a macro can be declared to accept a
1624 variable number of arguments much as a function can.  The syntax for
1625 defining the macro is similar to that of a function.  Here is an
1626 example:
1628 @smallexample
1629 #define debug(format, ...) fprintf (stderr, format, __VA_ARGS__)
1630 @end smallexample
1632 @noindent
1633 Here @samp{@dots{}} is a @dfn{variable argument}.  In the invocation of
1634 such a macro, it represents the zero or more tokens until the closing
1635 parenthesis that ends the invocation, including any commas.  This set of
1636 tokens replaces the identifier @code{__VA_ARGS__} in the macro body
1637 wherever it appears.  See the CPP manual for more information.
1639 GCC has long supported variadic macros, and used a different syntax that
1640 allowed you to give a name to the variable arguments just like any other
1641 argument.  Here is an example:
1643 @smallexample
1644 #define debug(format, args...) fprintf (stderr, format, args)
1645 @end smallexample
1647 @noindent
1648 This is in all ways equivalent to the ISO C example above, but arguably
1649 more readable and descriptive.
1651 GNU CPP has two further variadic macro extensions, and permits them to
1652 be used with either of the above forms of macro definition.
1654 In standard C, you are not allowed to leave the variable argument out
1655 entirely; but you are allowed to pass an empty argument.  For example,
1656 this invocation is invalid in ISO C, because there is no comma after
1657 the string:
1659 @smallexample
1660 debug ("A message")
1661 @end smallexample
1663 GNU CPP permits you to completely omit the variable arguments in this
1664 way.  In the above examples, the compiler would complain, though since
1665 the expansion of the macro still has the extra comma after the format
1666 string.
1668 To help solve this problem, CPP behaves specially for variable arguments
1669 used with the token paste operator, @samp{##}.  If instead you write
1671 @smallexample
1672 #define debug(format, ...) fprintf (stderr, format, ## __VA_ARGS__)
1673 @end smallexample
1675 @noindent
1676 and if the variable arguments are omitted or empty, the @samp{##}
1677 operator causes the preprocessor to remove the comma before it.  If you
1678 do provide some variable arguments in your macro invocation, GNU CPP
1679 does not complain about the paste operation and instead places the
1680 variable arguments after the comma.  Just like any other pasted macro
1681 argument, these arguments are not macro expanded.
1683 @node Escaped Newlines
1684 @section Slightly Looser Rules for Escaped Newlines
1685 @cindex escaped newlines
1686 @cindex newlines (escaped)
1688 Recently, the preprocessor has relaxed its treatment of escaped
1689 newlines.  Previously, the newline had to immediately follow a
1690 backslash.  The current implementation allows whitespace in the form
1691 of spaces, horizontal and vertical tabs, and form feeds between the
1692 backslash and the subsequent newline.  The preprocessor issues a
1693 warning, but treats it as a valid escaped newline and combines the two
1694 lines to form a single logical line.  This works within comments and
1695 tokens, as well as between tokens.  Comments are @emph{not} treated as
1696 whitespace for the purposes of this relaxation, since they have not
1697 yet been replaced with spaces.
1699 @node Subscripting
1700 @section Non-Lvalue Arrays May Have Subscripts
1701 @cindex subscripting
1702 @cindex arrays, non-lvalue
1704 @cindex subscripting and function values
1705 In ISO C99, arrays that are not lvalues still decay to pointers, and
1706 may be subscripted, although they may not be modified or used after
1707 the next sequence point and the unary @samp{&} operator may not be
1708 applied to them.  As an extension, GNU C allows such arrays to be
1709 subscripted in C90 mode, though otherwise they do not decay to
1710 pointers outside C99 mode.  For example,
1711 this is valid in GNU C though not valid in C90:
1713 @smallexample
1714 @group
1715 struct foo @{int a[4];@};
1717 struct foo f();
1719 bar (int index)
1721   return f().a[index];
1723 @end group
1724 @end smallexample
1726 @node Pointer Arith
1727 @section Arithmetic on @code{void}- and Function-Pointers
1728 @cindex void pointers, arithmetic
1729 @cindex void, size of pointer to
1730 @cindex function pointers, arithmetic
1731 @cindex function, size of pointer to
1733 In GNU C, addition and subtraction operations are supported on pointers to
1734 @code{void} and on pointers to functions.  This is done by treating the
1735 size of a @code{void} or of a function as 1.
1737 A consequence of this is that @code{sizeof} is also allowed on @code{void}
1738 and on function types, and returns 1.
1740 @opindex Wpointer-arith
1741 The option @option{-Wpointer-arith} requests a warning if these extensions
1742 are used.
1744 @node Initializers
1745 @section Non-Constant Initializers
1746 @cindex initializers, non-constant
1747 @cindex non-constant initializers
1749 As in standard C++ and ISO C99, the elements of an aggregate initializer for an
1750 automatic variable are not required to be constant expressions in GNU C@.
1751 Here is an example of an initializer with run-time varying elements:
1753 @smallexample
1754 foo (float f, float g)
1756   float beat_freqs[2] = @{ f-g, f+g @};
1757   /* @r{@dots{}} */
1759 @end smallexample
1761 @node Compound Literals
1762 @section Compound Literals
1763 @cindex constructor expressions
1764 @cindex initializations in expressions
1765 @cindex structures, constructor expression
1766 @cindex expressions, constructor
1767 @cindex compound literals
1768 @c The GNU C name for what C99 calls compound literals was "constructor expressions".
1770 ISO C99 supports compound literals.  A compound literal looks like
1771 a cast containing an initializer.  Its value is an object of the
1772 type specified in the cast, containing the elements specified in
1773 the initializer; it is an lvalue.  As an extension, GCC supports
1774 compound literals in C90 mode and in C++, though the semantics are
1775 somewhat different in C++.
1777 Usually, the specified type is a structure.  Assume that
1778 @code{struct foo} and @code{structure} are declared as shown:
1780 @smallexample
1781 struct foo @{int a; char b[2];@} structure;
1782 @end smallexample
1784 @noindent
1785 Here is an example of constructing a @code{struct foo} with a compound literal:
1787 @smallexample
1788 structure = ((struct foo) @{x + y, 'a', 0@});
1789 @end smallexample
1791 @noindent
1792 This is equivalent to writing the following:
1794 @smallexample
1796   struct foo temp = @{x + y, 'a', 0@};
1797   structure = temp;
1799 @end smallexample
1801 You can also construct an array, though this is dangerous in C++, as
1802 explained below.  If all the elements of the compound literal are
1803 (made up of) simple constant expressions, suitable for use in
1804 initializers of objects of static storage duration, then the compound
1805 literal can be coerced to a pointer to its first element and used in
1806 such an initializer, as shown here:
1808 @smallexample
1809 char **foo = (char *[]) @{ "x", "y", "z" @};
1810 @end smallexample
1812 Compound literals for scalar types and union types are
1813 also allowed, but then the compound literal is equivalent
1814 to a cast.
1816 As a GNU extension, GCC allows initialization of objects with static storage
1817 duration by compound literals (which is not possible in ISO C99, because
1818 the initializer is not a constant).
1819 It is handled as if the object is initialized only with the bracket
1820 enclosed list if the types of the compound literal and the object match.
1821 The initializer list of the compound literal must be constant.
1822 If the object being initialized has array type of unknown size, the size is
1823 determined by compound literal size.
1825 @smallexample
1826 static struct foo x = (struct foo) @{1, 'a', 'b'@};
1827 static int y[] = (int []) @{1, 2, 3@};
1828 static int z[] = (int [3]) @{1@};
1829 @end smallexample
1831 @noindent
1832 The above lines are equivalent to the following:
1833 @smallexample
1834 static struct foo x = @{1, 'a', 'b'@};
1835 static int y[] = @{1, 2, 3@};
1836 static int z[] = @{1, 0, 0@};
1837 @end smallexample
1839 In C, a compound literal designates an unnamed object with static or
1840 automatic storage duration.  In C++, a compound literal designates a
1841 temporary object, which only lives until the end of its
1842 full-expression.  As a result, well-defined C code that takes the
1843 address of a subobject of a compound literal can be undefined in C++.
1844 For instance, if the array compound literal example above appeared
1845 inside a function, any subsequent use of @samp{foo} in C++ has
1846 undefined behavior because the lifetime of the array ends after the
1847 declaration of @samp{foo}.  As a result, the C++ compiler now rejects
1848 the conversion of a temporary array to a pointer.
1850 As an optimization, the C++ compiler sometimes gives array compound
1851 literals longer lifetimes: when the array either appears outside a
1852 function or has const-qualified type.  If @samp{foo} and its
1853 initializer had elements of @samp{char *const} type rather than
1854 @samp{char *}, or if @samp{foo} were a global variable, the array
1855 would have static storage duration.  But it is probably safest just to
1856 avoid the use of array compound literals in code compiled as C++.
1858 @node Designated Inits
1859 @section Designated Initializers
1860 @cindex initializers with labeled elements
1861 @cindex labeled elements in initializers
1862 @cindex case labels in initializers
1863 @cindex designated initializers
1865 Standard C90 requires the elements of an initializer to appear in a fixed
1866 order, the same as the order of the elements in the array or structure
1867 being initialized.
1869 In ISO C99 you can give the elements in any order, specifying the array
1870 indices or structure field names they apply to, and GNU C allows this as
1871 an extension in C90 mode as well.  This extension is not
1872 implemented in GNU C++.
1874 To specify an array index, write
1875 @samp{[@var{index}] =} before the element value.  For example,
1877 @smallexample
1878 int a[6] = @{ [4] = 29, [2] = 15 @};
1879 @end smallexample
1881 @noindent
1882 is equivalent to
1884 @smallexample
1885 int a[6] = @{ 0, 0, 15, 0, 29, 0 @};
1886 @end smallexample
1888 @noindent
1889 The index values must be constant expressions, even if the array being
1890 initialized is automatic.
1892 An alternative syntax for this that has been obsolete since GCC 2.5 but
1893 GCC still accepts is to write @samp{[@var{index}]} before the element
1894 value, with no @samp{=}.
1896 To initialize a range of elements to the same value, write
1897 @samp{[@var{first} ... @var{last}] = @var{value}}.  This is a GNU
1898 extension.  For example,
1900 @smallexample
1901 int widths[] = @{ [0 ... 9] = 1, [10 ... 99] = 2, [100] = 3 @};
1902 @end smallexample
1904 @noindent
1905 If the value in it has side-effects, the side-effects happen only once,
1906 not for each initialized field by the range initializer.
1908 @noindent
1909 Note that the length of the array is the highest value specified
1910 plus one.
1912 In a structure initializer, specify the name of a field to initialize
1913 with @samp{.@var{fieldname} =} before the element value.  For example,
1914 given the following structure,
1916 @smallexample
1917 struct point @{ int x, y; @};
1918 @end smallexample
1920 @noindent
1921 the following initialization
1923 @smallexample
1924 struct point p = @{ .y = yvalue, .x = xvalue @};
1925 @end smallexample
1927 @noindent
1928 is equivalent to
1930 @smallexample
1931 struct point p = @{ xvalue, yvalue @};
1932 @end smallexample
1934 Another syntax that has the same meaning, obsolete since GCC 2.5, is
1935 @samp{@var{fieldname}:}, as shown here:
1937 @smallexample
1938 struct point p = @{ y: yvalue, x: xvalue @};
1939 @end smallexample
1941 @cindex designators
1942 The @samp{[@var{index}]} or @samp{.@var{fieldname}} is known as a
1943 @dfn{designator}.  You can also use a designator (or the obsolete colon
1944 syntax) when initializing a union, to specify which element of the union
1945 should be used.  For example,
1947 @smallexample
1948 union foo @{ int i; double d; @};
1950 union foo f = @{ .d = 4 @};
1951 @end smallexample
1953 @noindent
1954 converts 4 to a @code{double} to store it in the union using
1955 the second element.  By contrast, casting 4 to type @code{union foo}
1956 stores it into the union as the integer @code{i}, since it is
1957 an integer.  (@xref{Cast to Union}.)
1959 You can combine this technique of naming elements with ordinary C
1960 initialization of successive elements.  Each initializer element that
1961 does not have a designator applies to the next consecutive element of the
1962 array or structure.  For example,
1964 @smallexample
1965 int a[6] = @{ [1] = v1, v2, [4] = v4 @};
1966 @end smallexample
1968 @noindent
1969 is equivalent to
1971 @smallexample
1972 int a[6] = @{ 0, v1, v2, 0, v4, 0 @};
1973 @end smallexample
1975 Labeling the elements of an array initializer is especially useful
1976 when the indices are characters or belong to an @code{enum} type.
1977 For example:
1979 @smallexample
1980 int whitespace[256]
1981   = @{ [' '] = 1, ['\t'] = 1, ['\h'] = 1,
1982       ['\f'] = 1, ['\n'] = 1, ['\r'] = 1 @};
1983 @end smallexample
1985 @cindex designator lists
1986 You can also write a series of @samp{.@var{fieldname}} and
1987 @samp{[@var{index}]} designators before an @samp{=} to specify a
1988 nested subobject to initialize; the list is taken relative to the
1989 subobject corresponding to the closest surrounding brace pair.  For
1990 example, with the @samp{struct point} declaration above:
1992 @smallexample
1993 struct point ptarray[10] = @{ [2].y = yv2, [2].x = xv2, [0].x = xv0 @};
1994 @end smallexample
1996 @noindent
1997 If the same field is initialized multiple times, it has the value from
1998 the last initialization.  If any such overridden initialization has
1999 side-effect, it is unspecified whether the side-effect happens or not.
2000 Currently, GCC discards them and issues a warning.
2002 @node Case Ranges
2003 @section Case Ranges
2004 @cindex case ranges
2005 @cindex ranges in case statements
2007 You can specify a range of consecutive values in a single @code{case} label,
2008 like this:
2010 @smallexample
2011 case @var{low} ... @var{high}:
2012 @end smallexample
2014 @noindent
2015 This has the same effect as the proper number of individual @code{case}
2016 labels, one for each integer value from @var{low} to @var{high}, inclusive.
2018 This feature is especially useful for ranges of ASCII character codes:
2020 @smallexample
2021 case 'A' ... 'Z':
2022 @end smallexample
2024 @strong{Be careful:} Write spaces around the @code{...}, for otherwise
2025 it may be parsed wrong when you use it with integer values.  For example,
2026 write this:
2028 @smallexample
2029 case 1 ... 5:
2030 @end smallexample
2032 @noindent
2033 rather than this:
2035 @smallexample
2036 case 1...5:
2037 @end smallexample
2039 @node Cast to Union
2040 @section Cast to a Union Type
2041 @cindex cast to a union
2042 @cindex union, casting to a
2044 A cast to union type is similar to other casts, except that the type
2045 specified is a union type.  You can specify the type either with
2046 @code{union @var{tag}} or with a typedef name.  A cast to union is actually
2047 a constructor, not a cast, and hence does not yield an lvalue like
2048 normal casts.  (@xref{Compound Literals}.)
2050 The types that may be cast to the union type are those of the members
2051 of the union.  Thus, given the following union and variables:
2053 @smallexample
2054 union foo @{ int i; double d; @};
2055 int x;
2056 double y;
2057 @end smallexample
2059 @noindent
2060 both @code{x} and @code{y} can be cast to type @code{union foo}.
2062 Using the cast as the right-hand side of an assignment to a variable of
2063 union type is equivalent to storing in a member of the union:
2065 @smallexample
2066 union foo u;
2067 /* @r{@dots{}} */
2068 u = (union foo) x  @equiv{}  u.i = x
2069 u = (union foo) y  @equiv{}  u.d = y
2070 @end smallexample
2072 You can also use the union cast as a function argument:
2074 @smallexample
2075 void hack (union foo);
2076 /* @r{@dots{}} */
2077 hack ((union foo) x);
2078 @end smallexample
2080 @node Mixed Declarations
2081 @section Mixed Declarations and Code
2082 @cindex mixed declarations and code
2083 @cindex declarations, mixed with code
2084 @cindex code, mixed with declarations
2086 ISO C99 and ISO C++ allow declarations and code to be freely mixed
2087 within compound statements.  As an extension, GNU C also allows this in
2088 C90 mode.  For example, you could do:
2090 @smallexample
2091 int i;
2092 /* @r{@dots{}} */
2093 i++;
2094 int j = i + 2;
2095 @end smallexample
2097 Each identifier is visible from where it is declared until the end of
2098 the enclosing block.
2100 @node Function Attributes
2101 @section Declaring Attributes of Functions
2102 @cindex function attributes
2103 @cindex declaring attributes of functions
2104 @cindex functions that never return
2105 @cindex functions that return more than once
2106 @cindex functions that have no side effects
2107 @cindex functions in arbitrary sections
2108 @cindex functions that behave like malloc
2109 @cindex @code{volatile} applied to function
2110 @cindex @code{const} applied to function
2111 @cindex functions with @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style arguments
2112 @cindex functions with non-null pointer arguments
2113 @cindex functions that are passed arguments in registers on the 386
2114 @cindex functions that pop the argument stack on the 386
2115 @cindex functions that do not pop the argument stack on the 386
2116 @cindex functions that have different compilation options on the 386
2117 @cindex functions that have different optimization options
2118 @cindex functions that are dynamically resolved
2120 In GNU C, you declare certain things about functions called in your program
2121 which help the compiler optimize function calls and check your code more
2122 carefully.
2124 The keyword @code{__attribute__} allows you to specify special
2125 attributes when making a declaration.  This keyword is followed by an
2126 attribute specification inside double parentheses.  The following
2127 attributes are currently defined for functions on all targets:
2128 @code{aligned}, @code{alloc_size}, @code{noreturn},
2129 @code{returns_twice}, @code{noinline}, @code{noclone},
2130 @code{always_inline}, @code{flatten}, @code{pure}, @code{const},
2131 @code{nothrow}, @code{sentinel}, @code{format}, @code{format_arg},
2132 @code{no_instrument_function}, @code{no_split_stack},
2133 @code{section}, @code{constructor},
2134 @code{destructor}, @code{used}, @code{unused}, @code{deprecated},
2135 @code{weak}, @code{malloc}, @code{alias}, @code{ifunc},
2136 @code{warn_unused_result}, @code{nonnull}, @code{gnu_inline},
2137 @code{externally_visible}, @code{hot}, @code{cold}, @code{artificial},
2138 @code{no_address_safety_analysis}, @code{error} and @code{warning}.
2139 Several other attributes are defined for functions on particular
2140 target systems.  Other attributes, including @code{section} are
2141 supported for variables declarations (@pxref{Variable Attributes})
2142 and for types (@pxref{Type Attributes}).
2144 GCC plugins may provide their own attributes.
2146 You may also specify attributes with @samp{__} preceding and following
2147 each keyword.  This allows you to use them in header files without
2148 being concerned about a possible macro of the same name.  For example,
2149 you may use @code{__noreturn__} instead of @code{noreturn}.
2151 @xref{Attribute Syntax}, for details of the exact syntax for using
2152 attributes.
2154 @table @code
2155 @c Keep this table alphabetized by attribute name.  Treat _ as space.
2157 @item alias ("@var{target}")
2158 @cindex @code{alias} attribute
2159 The @code{alias} attribute causes the declaration to be emitted as an
2160 alias for another symbol, which must be specified.  For instance,
2162 @smallexample
2163 void __f () @{ /* @r{Do something.} */; @}
2164 void f () __attribute__ ((weak, alias ("__f")));
2165 @end smallexample
2167 @noindent
2168 defines @samp{f} to be a weak alias for @samp{__f}.  In C++, the
2169 mangled name for the target must be used.  It is an error if @samp{__f}
2170 is not defined in the same translation unit.
2172 Not all target machines support this attribute.
2174 @item aligned (@var{alignment})
2175 @cindex @code{aligned} attribute
2176 This attribute specifies a minimum alignment for the function,
2177 measured in bytes.
2179 You cannot use this attribute to decrease the alignment of a function,
2180 only to increase it.  However, when you explicitly specify a function
2181 alignment this overrides the effect of the
2182 @option{-falign-functions} (@pxref{Optimize Options}) option for this
2183 function.
2185 Note that the effectiveness of @code{aligned} attributes may be
2186 limited by inherent limitations in your linker.  On many systems, the
2187 linker is only able to arrange for functions to be aligned up to a
2188 certain maximum alignment.  (For some linkers, the maximum supported
2189 alignment may be very very small.)  See your linker documentation for
2190 further information.
2192 The @code{aligned} attribute can also be used for variables and fields
2193 (@pxref{Variable Attributes}.)
2195 @item alloc_size
2196 @cindex @code{alloc_size} attribute
2197 The @code{alloc_size} attribute is used to tell the compiler that the
2198 function return value points to memory, where the size is given by
2199 one or two of the functions parameters.  GCC uses this
2200 information to improve the correctness of @code{__builtin_object_size}.
2202 The function parameter(s) denoting the allocated size are specified by
2203 one or two integer arguments supplied to the attribute.  The allocated size
2204 is either the value of the single function argument specified or the product
2205 of the two function arguments specified.  Argument numbering starts at
2206 one.
2208 For instance,
2210 @smallexample
2211 void* my_calloc(size_t, size_t) __attribute__((alloc_size(1,2)))
2212 void my_realloc(void*, size_t) __attribute__((alloc_size(2)))
2213 @end smallexample
2215 @noindent
2216 declares that @code{my_calloc} returns memory of the size given by
2217 the product of parameter 1 and 2 and that @code{my_realloc} returns memory
2218 of the size given by parameter 2.
2220 @item always_inline
2221 @cindex @code{always_inline} function attribute
2222 Generally, functions are not inlined unless optimization is specified.
2223 For functions declared inline, this attribute inlines the function even
2224 if no optimization level is specified.
2226 @item gnu_inline
2227 @cindex @code{gnu_inline} function attribute
2228 This attribute should be used with a function that is also declared
2229 with the @code{inline} keyword.  It directs GCC to treat the function
2230 as if it were defined in gnu90 mode even when compiling in C99 or
2231 gnu99 mode.
2233 If the function is declared @code{extern}, then this definition of the
2234 function is used only for inlining.  In no case is the function
2235 compiled as a standalone function, not even if you take its address
2236 explicitly.  Such an address becomes an external reference, as if you
2237 had only declared the function, and had not defined it.  This has
2238 almost the effect of a macro.  The way to use this is to put a
2239 function definition in a header file with this attribute, and put
2240 another copy of the function, without @code{extern}, in a library
2241 file.  The definition in the header file causes most calls to the
2242 function to be inlined.  If any uses of the function remain, they
2243 refer to the single copy in the library.  Note that the two
2244 definitions of the functions need not be precisely the same, although
2245 if they do not have the same effect your program may behave oddly.
2247 In C, if the function is neither @code{extern} nor @code{static}, then
2248 the function is compiled as a standalone function, as well as being
2249 inlined where possible.
2251 This is how GCC traditionally handled functions declared
2252 @code{inline}.  Since ISO C99 specifies a different semantics for
2253 @code{inline}, this function attribute is provided as a transition
2254 measure and as a useful feature in its own right.  This attribute is
2255 available in GCC 4.1.3 and later.  It is available if either of the
2256 preprocessor macros @code{__GNUC_GNU_INLINE__} or
2257 @code{__GNUC_STDC_INLINE__} are defined.  @xref{Inline,,An Inline
2258 Function is As Fast As a Macro}.
2260 In C++, this attribute does not depend on @code{extern} in any way,
2261 but it still requires the @code{inline} keyword to enable its special
2262 behavior.
2264 @item artificial
2265 @cindex @code{artificial} function attribute
2266 This attribute is useful for small inline wrappers that if possible
2267 should appear during debugging as a unit.  Depending on the debug
2268 info format it either means marking the function as artificial
2269 or using the caller location for all instructions within the inlined
2270 body.
2272 @item bank_switch
2273 @cindex interrupt handler functions
2274 When added to an interrupt handler with the M32C port, causes the
2275 prologue and epilogue to use bank switching to preserve the registers
2276 rather than saving them on the stack.
2278 @item flatten
2279 @cindex @code{flatten} function attribute
2280 Generally, inlining into a function is limited.  For a function marked with
2281 this attribute, every call inside this function is inlined, if possible.
2282 Whether the function itself is considered for inlining depends on its size and
2283 the current inlining parameters.
2285 @item error ("@var{message}")
2286 @cindex @code{error} function attribute
2287 If this attribute is used on a function declaration and a call to such a function
2288 is not eliminated through dead code elimination or other optimizations, an error
2289 that includes @var{message} is diagnosed.  This is useful
2290 for compile-time checking, especially together with @code{__builtin_constant_p}
2291 and inline functions where checking the inline function arguments is not
2292 possible through @code{extern char [(condition) ? 1 : -1];} tricks.
2293 While it is possible to leave the function undefined and thus invoke
2294 a link failure, when using this attribute the problem is diagnosed
2295 earlier and with exact location of the call even in presence of inline
2296 functions or when not emitting debugging information.
2298 @item warning ("@var{message}")
2299 @cindex @code{warning} function attribute
2300 If this attribute is used on a function declaration and a call to such a function
2301 is not eliminated through dead code elimination or other optimizations, a warning
2302 that includes @var{message} is diagnosed.  This is useful
2303 for compile-time checking, especially together with @code{__builtin_constant_p}
2304 and inline functions.  While it is possible to define the function with
2305 a message in @code{.gnu.warning*} section, when using this attribute the problem
2306 is diagnosed earlier and with exact location of the call even in presence
2307 of inline functions or when not emitting debugging information.
2309 @item cdecl
2310 @cindex functions that do pop the argument stack on the 386
2311 @opindex mrtd
2312 On the Intel 386, the @code{cdecl} attribute causes the compiler to
2313 assume that the calling function pops off the stack space used to
2314 pass arguments.  This is
2315 useful to override the effects of the @option{-mrtd} switch.
2317 @item const
2318 @cindex @code{const} function attribute
2319 Many functions do not examine any values except their arguments, and
2320 have no effects except the return value.  Basically this is just slightly
2321 more strict class than the @code{pure} attribute below, since function is not
2322 allowed to read global memory.
2324 @cindex pointer arguments
2325 Note that a function that has pointer arguments and examines the data
2326 pointed to must @emph{not} be declared @code{const}.  Likewise, a
2327 function that calls a non-@code{const} function usually must not be
2328 @code{const}.  It does not make sense for a @code{const} function to
2329 return @code{void}.
2331 The attribute @code{const} is not implemented in GCC versions earlier
2332 than 2.5.  An alternative way to declare that a function has no side
2333 effects, which works in the current version and in some older versions,
2334 is as follows:
2336 @smallexample
2337 typedef int intfn ();
2339 extern const intfn square;
2340 @end smallexample
2342 @noindent
2343 This approach does not work in GNU C++ from 2.6.0 on, since the language
2344 specifies that the @samp{const} must be attached to the return value.
2346 @item constructor
2347 @itemx destructor
2348 @itemx constructor (@var{priority})
2349 @itemx destructor (@var{priority})
2350 @cindex @code{constructor} function attribute
2351 @cindex @code{destructor} function attribute
2352 The @code{constructor} attribute causes the function to be called
2353 automatically before execution enters @code{main ()}.  Similarly, the
2354 @code{destructor} attribute causes the function to be called
2355 automatically after @code{main ()} completes or @code{exit ()} is
2356 called.  Functions with these attributes are useful for
2357 initializing data that is used implicitly during the execution of
2358 the program.
2360 You may provide an optional integer priority to control the order in
2361 which constructor and destructor functions are run.  A constructor
2362 with a smaller priority number runs before a constructor with a larger
2363 priority number; the opposite relationship holds for destructors.  So,
2364 if you have a constructor that allocates a resource and a destructor
2365 that deallocates the same resource, both functions typically have the
2366 same priority.  The priorities for constructor and destructor
2367 functions are the same as those specified for namespace-scope C++
2368 objects (@pxref{C++ Attributes}).
2370 These attributes are not currently implemented for Objective-C@.
2372 @item deprecated
2373 @itemx deprecated (@var{msg})
2374 @cindex @code{deprecated} attribute.
2375 The @code{deprecated} attribute results in a warning if the function
2376 is used anywhere in the source file.  This is useful when identifying
2377 functions that are expected to be removed in a future version of a
2378 program.  The warning also includes the location of the declaration
2379 of the deprecated function, to enable users to easily find further
2380 information about why the function is deprecated, or what they should
2381 do instead.  Note that the warnings only occurs for uses:
2383 @smallexample
2384 int old_fn () __attribute__ ((deprecated));
2385 int old_fn ();
2386 int (*fn_ptr)() = old_fn;
2387 @end smallexample
2389 @noindent
2390 results in a warning on line 3 but not line 2.  The optional @var{msg}
2391 argument, which must be a string, is printed in the warning if
2392 present.
2394 The @code{deprecated} attribute can also be used for variables and
2395 types (@pxref{Variable Attributes}, @pxref{Type Attributes}.)
2397 @item disinterrupt
2398 @cindex @code{disinterrupt} attribute
2399 On Epiphany and MeP targets, this attribute causes the compiler to emit
2400 instructions to disable interrupts for the duration of the given
2401 function.
2403 @item dllexport
2404 @cindex @code{__declspec(dllexport)}
2405 On Microsoft Windows targets and Symbian OS targets the
2406 @code{dllexport} attribute causes the compiler to provide a global
2407 pointer to a pointer in a DLL, so that it can be referenced with the
2408 @code{dllimport} attribute.  On Microsoft Windows targets, the pointer
2409 name is formed by combining @code{_imp__} and the function or variable
2410 name.
2412 You can use @code{__declspec(dllexport)} as a synonym for
2413 @code{__attribute__ ((dllexport))} for compatibility with other
2414 compilers.
2416 On systems that support the @code{visibility} attribute, this
2417 attribute also implies ``default'' visibility.  It is an error to
2418 explicitly specify any other visibility.
2420 In previous versions of GCC, the @code{dllexport} attribute was ignored
2421 for inlined functions, unless the @option{-fkeep-inline-functions} flag
2422 had been used.  The default behavior now is to emit all dllexported
2423 inline functions; however, this can cause object file-size bloat, in
2424 which case the old behavior can be restored by using
2425 @option{-fno-keep-inline-dllexport}.
2427 The attribute is also ignored for undefined symbols.
2429 When applied to C++ classes, the attribute marks defined non-inlined
2430 member functions and static data members as exports.  Static consts
2431 initialized in-class are not marked unless they are also defined
2432 out-of-class.
2434 For Microsoft Windows targets there are alternative methods for
2435 including the symbol in the DLL's export table such as using a
2436 @file{.def} file with an @code{EXPORTS} section or, with GNU ld, using
2437 the @option{--export-all} linker flag.
2439 @item dllimport
2440 @cindex @code{__declspec(dllimport)}
2441 On Microsoft Windows and Symbian OS targets, the @code{dllimport}
2442 attribute causes the compiler to reference a function or variable via
2443 a global pointer to a pointer that is set up by the DLL exporting the
2444 symbol.  The attribute implies @code{extern}.  On Microsoft Windows
2445 targets, the pointer name is formed by combining @code{_imp__} and the
2446 function or variable name.
2448 You can use @code{__declspec(dllimport)} as a synonym for
2449 @code{__attribute__ ((dllimport))} for compatibility with other
2450 compilers.
2452 On systems that support the @code{visibility} attribute, this
2453 attribute also implies ``default'' visibility.  It is an error to
2454 explicitly specify any other visibility.
2456 Currently, the attribute is ignored for inlined functions.  If the
2457 attribute is applied to a symbol @emph{definition}, an error is reported.
2458 If a symbol previously declared @code{dllimport} is later defined, the
2459 attribute is ignored in subsequent references, and a warning is emitted.
2460 The attribute is also overridden by a subsequent declaration as
2461 @code{dllexport}.
2463 When applied to C++ classes, the attribute marks non-inlined
2464 member functions and static data members as imports.  However, the
2465 attribute is ignored for virtual methods to allow creation of vtables
2466 using thunks.
2468 On the SH Symbian OS target the @code{dllimport} attribute also has
2469 another affect---it can cause the vtable and run-time type information
2470 for a class to be exported.  This happens when the class has a
2471 dllimported constructor or a non-inline, non-pure virtual function
2472 and, for either of those two conditions, the class also has an inline
2473 constructor or destructor and has a key function that is defined in
2474 the current translation unit.
2476 For Microsoft Windows targets the use of the @code{dllimport}
2477 attribute on functions is not necessary, but provides a small
2478 performance benefit by eliminating a thunk in the DLL@.  The use of the
2479 @code{dllimport} attribute on imported variables was required on older
2480 versions of the GNU linker, but can now be avoided by passing the
2481 @option{--enable-auto-import} switch to the GNU linker.  As with
2482 functions, using the attribute for a variable eliminates a thunk in
2483 the DLL@.
2485 One drawback to using this attribute is that a pointer to a
2486 @emph{variable} marked as @code{dllimport} cannot be used as a constant
2487 address. However, a pointer to a @emph{function} with the
2488 @code{dllimport} attribute can be used as a constant initializer; in
2489 this case, the address of a stub function in the import lib is
2490 referenced.  On Microsoft Windows targets, the attribute can be disabled
2491 for functions by setting the @option{-mnop-fun-dllimport} flag.
2493 @item eightbit_data
2494 @cindex eight-bit data on the H8/300, H8/300H, and H8S
2495 Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
2496 variable should be placed into the eight-bit data section.
2497 The compiler generates more efficient code for certain operations
2498 on data in the eight-bit data area.  Note the eight-bit data area is limited to
2499 256 bytes of data.
2501 You must use GAS and GLD from GNU binutils version 2.7 or later for
2502 this attribute to work correctly.
2504 @item exception_handler
2505 @cindex exception handler functions on the Blackfin processor
2506 Use this attribute on the Blackfin to indicate that the specified function
2507 is an exception handler.  The compiler generates function entry and
2508 exit sequences suitable for use in an exception handler when this
2509 attribute is present.
2511 @item externally_visible
2512 @cindex @code{externally_visible} attribute.
2513 This attribute, attached to a global variable or function, nullifies
2514 the effect of the @option{-fwhole-program} command-line option, so the
2515 object remains visible outside the current compilation unit.
2517 If @option{-fwhole-program} is used together with @option{-flto} and 
2518 @command{gold} is used as the linker plugin, 
2519 @code{externally_visible} attributes are automatically added to functions 
2520 (not variable yet due to a current @command{gold} issue) 
2521 that are accessed outside of LTO objects according to resolution file
2522 produced by @command{gold}.
2523 For other linkers that cannot generate resolution file,
2524 explicit @code{externally_visible} attributes are still necessary.
2526 @item far
2527 @cindex functions that handle memory bank switching
2528 On 68HC11 and 68HC12 the @code{far} attribute causes the compiler to
2529 use a calling convention that takes care of switching memory banks when
2530 entering and leaving a function.  This calling convention is also the
2531 default when using the @option{-mlong-calls} option.
2533 On 68HC12 the compiler uses the @code{call} and @code{rtc} instructions
2534 to call and return from a function.
2536 On 68HC11 the compiler generates a sequence of instructions
2537 to invoke a board-specific routine to switch the memory bank and call the
2538 real function.  The board-specific routine simulates a @code{call}.
2539 At the end of a function, it jumps to a board-specific routine
2540 instead of using @code{rts}.  The board-specific return routine simulates
2541 the @code{rtc}.
2543 On MeP targets this causes the compiler to use a calling convention
2544 that assumes the called function is too far away for the built-in
2545 addressing modes.
2547 @item fast_interrupt
2548 @cindex interrupt handler functions
2549 Use this attribute on the M32C and RX ports to indicate that the specified
2550 function is a fast interrupt handler.  This is just like the
2551 @code{interrupt} attribute, except that @code{freit} is used to return
2552 instead of @code{reit}.
2554 @item fastcall
2555 @cindex functions that pop the argument stack on the 386
2556 On the Intel 386, the @code{fastcall} attribute causes the compiler to
2557 pass the first argument (if of integral type) in the register ECX and
2558 the second argument (if of integral type) in the register EDX@.  Subsequent
2559 and other typed arguments are passed on the stack.  The called function
2560 pops the arguments off the stack.  If the number of arguments is variable all
2561 arguments are pushed on the stack.
2563 @item thiscall
2564 @cindex functions that pop the argument stack on the 386
2565 On the Intel 386, the @code{thiscall} attribute causes the compiler to
2566 pass the first argument (if of integral type) in the register ECX.
2567 Subsequent and other typed arguments are passed on the stack. The called
2568 function pops the arguments off the stack.
2569 If the number of arguments is variable all arguments are pushed on the
2570 stack.
2571 The @code{thiscall} attribute is intended for C++ non-static member functions.
2572 As a GCC extension, this calling convention can be used for C functions
2573 and for static member methods.
2575 @item format (@var{archetype}, @var{string-index}, @var{first-to-check})
2576 @cindex @code{format} function attribute
2577 @opindex Wformat
2578 The @code{format} attribute specifies that a function takes @code{printf},
2579 @code{scanf}, @code{strftime} or @code{strfmon} style arguments that
2580 should be type-checked against a format string.  For example, the
2581 declaration:
2583 @smallexample
2584 extern int
2585 my_printf (void *my_object, const char *my_format, ...)
2586       __attribute__ ((format (printf, 2, 3)));
2587 @end smallexample
2589 @noindent
2590 causes the compiler to check the arguments in calls to @code{my_printf}
2591 for consistency with the @code{printf} style format string argument
2592 @code{my_format}.
2594 The parameter @var{archetype} determines how the format string is
2595 interpreted, and should be @code{printf}, @code{scanf}, @code{strftime},
2596 @code{gnu_printf}, @code{gnu_scanf}, @code{gnu_strftime} or
2597 @code{strfmon}.  (You can also use @code{__printf__},
2598 @code{__scanf__}, @code{__strftime__} or @code{__strfmon__}.)  On
2599 MinGW targets, @code{ms_printf}, @code{ms_scanf}, and
2600 @code{ms_strftime} are also present.
2601 @var{archetype} values such as @code{printf} refer to the formats accepted
2602 by the system's C runtime library,
2603 while values prefixed with @samp{gnu_} always refer
2604 to the formats accepted by the GNU C Library.  On Microsoft Windows
2605 targets, values prefixed with @samp{ms_} refer to the formats accepted by the
2606 @file{msvcrt.dll} library.
2607 The parameter @var{string-index}
2608 specifies which argument is the format string argument (starting
2609 from 1), while @var{first-to-check} is the number of the first
2610 argument to check against the format string.  For functions
2611 where the arguments are not available to be checked (such as
2612 @code{vprintf}), specify the third parameter as zero.  In this case the
2613 compiler only checks the format string for consistency.  For
2614 @code{strftime} formats, the third parameter is required to be zero.
2615 Since non-static C++ methods have an implicit @code{this} argument, the
2616 arguments of such methods should be counted from two, not one, when
2617 giving values for @var{string-index} and @var{first-to-check}.
2619 In the example above, the format string (@code{my_format}) is the second
2620 argument of the function @code{my_print}, and the arguments to check
2621 start with the third argument, so the correct parameters for the format
2622 attribute are 2 and 3.
2624 @opindex ffreestanding
2625 @opindex fno-builtin
2626 The @code{format} attribute allows you to identify your own functions
2627 that take format strings as arguments, so that GCC can check the
2628 calls to these functions for errors.  The compiler always (unless
2629 @option{-ffreestanding} or @option{-fno-builtin} is used) checks formats
2630 for the standard library functions @code{printf}, @code{fprintf},
2631 @code{sprintf}, @code{scanf}, @code{fscanf}, @code{sscanf}, @code{strftime},
2632 @code{vprintf}, @code{vfprintf} and @code{vsprintf} whenever such
2633 warnings are requested (using @option{-Wformat}), so there is no need to
2634 modify the header file @file{stdio.h}.  In C99 mode, the functions
2635 @code{snprintf}, @code{vsnprintf}, @code{vscanf}, @code{vfscanf} and
2636 @code{vsscanf} are also checked.  Except in strictly conforming C
2637 standard modes, the X/Open function @code{strfmon} is also checked as
2638 are @code{printf_unlocked} and @code{fprintf_unlocked}.
2639 @xref{C Dialect Options,,Options Controlling C Dialect}.
2641 For Objective-C dialects, @code{NSString} (or @code{__NSString__}) is
2642 recognized in the same context.  Declarations including these format attributes
2643 are parsed for correct syntax, however the result of checking of such format
2644 strings is not yet defined, and is not carried out by this version of the
2645 compiler.
2647 The target may also provide additional types of format checks.
2648 @xref{Target Format Checks,,Format Checks Specific to Particular
2649 Target Machines}.
2651 @item format_arg (@var{string-index})
2652 @cindex @code{format_arg} function attribute
2653 @opindex Wformat-nonliteral
2654 The @code{format_arg} attribute specifies that a function takes a format
2655 string for a @code{printf}, @code{scanf}, @code{strftime} or
2656 @code{strfmon} style function and modifies it (for example, to translate
2657 it into another language), so the result can be passed to a
2658 @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style
2659 function (with the remaining arguments to the format function the same
2660 as they would have been for the unmodified string).  For example, the
2661 declaration:
2663 @smallexample
2664 extern char *
2665 my_dgettext (char *my_domain, const char *my_format)
2666       __attribute__ ((format_arg (2)));
2667 @end smallexample
2669 @noindent
2670 causes the compiler to check the arguments in calls to a @code{printf},
2671 @code{scanf}, @code{strftime} or @code{strfmon} type function, whose
2672 format string argument is a call to the @code{my_dgettext} function, for
2673 consistency with the format string argument @code{my_format}.  If the
2674 @code{format_arg} attribute had not been specified, all the compiler
2675 could tell in such calls to format functions would be that the format
2676 string argument is not constant; this would generate a warning when
2677 @option{-Wformat-nonliteral} is used, but the calls could not be checked
2678 without the attribute.
2680 The parameter @var{string-index} specifies which argument is the format
2681 string argument (starting from one).  Since non-static C++ methods have
2682 an implicit @code{this} argument, the arguments of such methods should
2683 be counted from two.
2685 The @code{format_arg} attribute allows you to identify your own
2686 functions that modify format strings, so that GCC can check the
2687 calls to @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon}
2688 type function whose operands are a call to one of your own function.
2689 The compiler always treats @code{gettext}, @code{dgettext}, and
2690 @code{dcgettext} in this manner except when strict ISO C support is
2691 requested by @option{-ansi} or an appropriate @option{-std} option, or
2692 @option{-ffreestanding} or @option{-fno-builtin}
2693 is used.  @xref{C Dialect Options,,Options
2694 Controlling C Dialect}.
2696 For Objective-C dialects, the @code{format-arg} attribute may refer to an
2697 @code{NSString} reference for compatibility with the @code{format} attribute
2698 above.
2700 The target may also allow additional types in @code{format-arg} attributes.
2701 @xref{Target Format Checks,,Format Checks Specific to Particular
2702 Target Machines}.
2704 @item function_vector
2705 @cindex calling functions through the function vector on H8/300, M16C, M32C and SH2A processors
2706 Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
2707 function should be called through the function vector.  Calling a
2708 function through the function vector reduces code size, however;
2709 the function vector has a limited size (maximum 128 entries on the H8/300
2710 and 64 entries on the H8/300H and H8S) and shares space with the interrupt vector.
2712 On SH2A targets, this attribute declares a function to be called using the
2713 TBR relative addressing mode.  The argument to this attribute is the entry
2714 number of the same function in a vector table containing all the TBR
2715 relative addressable functions.  For correct operation the TBR must be setup
2716 accordingly to point to the start of the vector table before any functions with
2717 this attribute are invoked.  Usually a good place to do the initialization is
2718 the startup routine.  The TBR relative vector table can have at max 256 function
2719 entries.  The jumps to these functions are generated using a SH2A specific,
2720 non delayed branch instruction JSR/N @@(disp8,TBR).  You must use GAS and GLD
2721 from GNU binutils version 2.7 or later for this attribute to work correctly.
2723 Please refer the example of M16C target, to see the use of this
2724 attribute while declaring a function,
2726 In an application, for a function being called once, this attribute
2727 saves at least 8 bytes of code; and if other successive calls are being
2728 made to the same function, it saves 2 bytes of code per each of these
2729 calls.
2731 On M16C/M32C targets, the @code{function_vector} attribute declares a
2732 special page subroutine call function. Use of this attribute reduces
2733 the code size by 2 bytes for each call generated to the
2734 subroutine. The argument to the attribute is the vector number entry
2735 from the special page vector table which contains the 16 low-order
2736 bits of the subroutine's entry address. Each vector table has special
2737 page number (18 to 255) that is used in @code{jsrs} instructions.
2738 Jump addresses of the routines are generated by adding 0x0F0000 (in
2739 case of M16C targets) or 0xFF0000 (in case of M32C targets), to the
2740 2-byte addresses set in the vector table. Therefore you need to ensure
2741 that all the special page vector routines should get mapped within the
2742 address range 0x0F0000 to 0x0FFFFF (for M16C) and 0xFF0000 to 0xFFFFFF
2743 (for M32C).
2745 In the following example 2 bytes are saved for each call to
2746 function @code{foo}.
2748 @smallexample
2749 void foo (void) __attribute__((function_vector(0x18)));
2750 void foo (void)
2754 void bar (void)
2756     foo();
2758 @end smallexample
2760 If functions are defined in one file and are called in another file,
2761 then be sure to write this declaration in both files.
2763 This attribute is ignored for R8C target.
2765 @item ifunc ("@var{resolver}")
2766 @cindex @code{ifunc} attribute
2767 The @code{ifunc} attribute is used to mark a function as an indirect
2768 function using the STT_GNU_IFUNC symbol type extension to the ELF
2769 standard.  This allows the resolution of the symbol value to be
2770 determined dynamically at load time, and an optimized version of the
2771 routine can be selected for the particular processor or other system
2772 characteristics determined then.  To use this attribute, first define
2773 the implementation functions available, and a resolver function that
2774 returns a pointer to the selected implementation function.  The
2775 implementation functions' declarations must match the API of the
2776 function being implemented, the resolver's declaration is be a
2777 function returning pointer to void function returning void:
2779 @smallexample
2780 void *my_memcpy (void *dst, const void *src, size_t len)
2782   @dots{}
2785 static void (*resolve_memcpy (void)) (void)
2787   return my_memcpy; // we'll just always select this routine
2789 @end smallexample
2791 @noindent
2792 The exported header file declaring the function the user calls would
2793 contain:
2795 @smallexample
2796 extern void *memcpy (void *, const void *, size_t);
2797 @end smallexample
2799 @noindent
2800 allowing the user to call this as a regular function, unaware of the
2801 implementation.  Finally, the indirect function needs to be defined in
2802 the same translation unit as the resolver function:
2804 @smallexample
2805 void *memcpy (void *, const void *, size_t)
2806      __attribute__ ((ifunc ("resolve_memcpy")));
2807 @end smallexample
2809 Indirect functions cannot be weak, and require a recent binutils (at
2810 least version 2.20.1), and GNU C library (at least version 2.11.1).
2812 @item interrupt
2813 @cindex interrupt handler functions
2814 Use this attribute on the ARM, AVR, CR16, Epiphany, M32C, M32R/D, m68k, MeP, MIPS,
2815 RL78, RX and Xstormy16 ports to indicate that the specified function is an
2816 interrupt handler.  The compiler generates function entry and exit
2817 sequences suitable for use in an interrupt handler when this attribute
2818 is present.  With Epiphany targets it may also generate a special section with
2819 code to initialize the interrupt vector table.
2821 Note, interrupt handlers for the Blackfin, H8/300, H8/300H, H8S, MicroBlaze,
2822 and SH processors can be specified via the @code{interrupt_handler} attribute.
2824 Note, on the AVR, the hardware globally disables interrupts when an
2825 interrupt is executed.  The first instruction of an interrupt handler
2826 declared with this attribute is a @code{SEI} instruction to
2827 re-enable interrupts.  See also the @code{signal} function attribute
2828 that does not insert a @code{SEI} instruction.  If both @code{signal} and
2829 @code{interrupt} are specified for the same function, @code{signal}
2830 is silently ignored.
2832 Note, for the ARM, you can specify the kind of interrupt to be handled by
2833 adding an optional parameter to the interrupt attribute like this:
2835 @smallexample
2836 void f () __attribute__ ((interrupt ("IRQ")));
2837 @end smallexample
2839 @noindent
2840 Permissible values for this parameter are: @code{IRQ}, @code{FIQ},
2841 @code{SWI}, @code{ABORT} and @code{UNDEF}.
2843 On ARMv7-M the interrupt type is ignored, and the attribute means the function
2844 may be called with a word-aligned stack pointer.
2846 On Epiphany targets one or more optional parameters can be added like this:
2848 @smallexample
2849 void __attribute__ ((interrupt ("dma0, dma1"))) universal_dma_handler ();
2850 @end smallexample
2852 Permissible values for these parameters are: @w{@code{reset}},
2853 @w{@code{software_exception}}, @w{@code{page_miss}},
2854 @w{@code{timer0}}, @w{@code{timer1}}, @w{@code{message}},
2855 @w{@code{dma0}}, @w{@code{dma1}}, @w{@code{wand}} and @w{@code{swi}}.
2856 Multiple parameters indicate that multiple entries in the interrupt
2857 vector table should be initialized for this function, i.e.@: for each
2858 parameter @w{@var{name}}, a jump to the function is emitted in
2859 the section @w{ivt_entry_@var{name}}.  The parameter(s) may be omitted
2860 entirely, in which case no interrupt vector table entry is provided.
2862 Note, on Epiphany targets, interrupts are enabled inside the function
2863 unless the @code{disinterrupt} attribute is also specified.
2865 On Epiphany targets, you can also use the following attribute to
2866 modify the behavior of an interrupt handler:
2867 @table @code
2868 @item forwarder_section
2869 @cindex @code{forwarder_section} attribute
2870 The interrupt handler may be in external memory which cannot be
2871 reached by a branch instruction, so generate a local memory trampoline
2872 to transfer control.  The single parameter identifies the section where
2873 the trampoline is placed.
2874 @end table
2876 The following examples are all valid uses of these attributes on
2877 Epiphany targets:
2878 @smallexample
2879 void __attribute__ ((interrupt)) universal_handler ();
2880 void __attribute__ ((interrupt ("dma1"))) dma1_handler ();
2881 void __attribute__ ((interrupt ("dma0, dma1"))) universal_dma_handler ();
2882 void __attribute__ ((interrupt ("timer0"), disinterrupt))
2883   fast_timer_handler ();
2884 void __attribute__ ((interrupt ("dma0, dma1"), forwarder_section ("tramp")))
2885   external_dma_handler ();
2886 @end smallexample
2888 On MIPS targets, you can use the following attributes to modify the behavior
2889 of an interrupt handler:
2890 @table @code
2891 @item use_shadow_register_set
2892 @cindex @code{use_shadow_register_set} attribute
2893 Assume that the handler uses a shadow register set, instead of
2894 the main general-purpose registers.
2896 @item keep_interrupts_masked
2897 @cindex @code{keep_interrupts_masked} attribute
2898 Keep interrupts masked for the whole function.  Without this attribute,
2899 GCC tries to reenable interrupts for as much of the function as it can.
2901 @item use_debug_exception_return
2902 @cindex @code{use_debug_exception_return} attribute
2903 Return using the @code{deret} instruction.  Interrupt handlers that don't
2904 have this attribute return using @code{eret} instead.
2905 @end table
2907 You can use any combination of these attributes, as shown below:
2908 @smallexample
2909 void __attribute__ ((interrupt)) v0 ();
2910 void __attribute__ ((interrupt, use_shadow_register_set)) v1 ();
2911 void __attribute__ ((interrupt, keep_interrupts_masked)) v2 ();
2912 void __attribute__ ((interrupt, use_debug_exception_return)) v3 ();
2913 void __attribute__ ((interrupt, use_shadow_register_set,
2914                      keep_interrupts_masked)) v4 ();
2915 void __attribute__ ((interrupt, use_shadow_register_set,
2916                      use_debug_exception_return)) v5 ();
2917 void __attribute__ ((interrupt, keep_interrupts_masked,
2918                      use_debug_exception_return)) v6 ();
2919 void __attribute__ ((interrupt, use_shadow_register_set,
2920                      keep_interrupts_masked,
2921                      use_debug_exception_return)) v7 ();
2922 @end smallexample
2924 On RL78, use @code{brk_interrupt} instead of @code{interrupt} for
2925 handlers intended to be used with the @code{BRK} opcode (i.e.@: those
2926 that must end with @code{RETB} instead of @code{RETI}).
2928 @item interrupt_handler
2929 @cindex interrupt handler functions on the Blackfin, m68k, H8/300 and SH processors
2930 Use this attribute on the Blackfin, m68k, H8/300, H8/300H, H8S, and SH to
2931 indicate that the specified function is an interrupt handler.  The compiler
2932 generates function entry and exit sequences suitable for use in an
2933 interrupt handler when this attribute is present.
2935 @item interrupt_thread
2936 @cindex interrupt thread functions on fido
2937 Use this attribute on fido, a subarchitecture of the m68k, to indicate
2938 that the specified function is an interrupt handler that is designed
2939 to run as a thread.  The compiler omits generate prologue/epilogue
2940 sequences and replaces the return instruction with a @code{sleep}
2941 instruction.  This attribute is available only on fido.
2943 @item isr
2944 @cindex interrupt service routines on ARM
2945 Use this attribute on ARM to write Interrupt Service Routines. This is an
2946 alias to the @code{interrupt} attribute above.
2948 @item kspisusp
2949 @cindex User stack pointer in interrupts on the Blackfin
2950 When used together with @code{interrupt_handler}, @code{exception_handler}
2951 or @code{nmi_handler}, code is generated to load the stack pointer
2952 from the USP register in the function prologue.
2954 @item l1_text
2955 @cindex @code{l1_text} function attribute
2956 This attribute specifies a function to be placed into L1 Instruction
2957 SRAM@. The function is put into a specific section named @code{.l1.text}.
2958 With @option{-mfdpic}, function calls with a such function as the callee
2959 or caller uses inlined PLT.
2961 @item l2
2962 @cindex @code{l2} function attribute
2963 On the Blackfin, this attribute specifies a function to be placed into L2
2964 SRAM. The function is put into a specific section named
2965 @code{.l1.text}. With @option{-mfdpic}, callers of such functions use
2966 an inlined PLT.
2968 @item leaf
2969 @cindex @code{leaf} function attribute
2970 Calls to external functions with this attribute must return to the current
2971 compilation unit only by return or by exception handling.  In particular, leaf
2972 functions are not allowed to call callback function passed to it from the current
2973 compilation unit or directly call functions exported by the unit or longjmp
2974 into the unit.  Leaf function might still call functions from other compilation
2975 units and thus they are not necessarily leaf in the sense that they contain no
2976 function calls at all.
2978 The attribute is intended for library functions to improve dataflow analysis.
2979 The compiler takes the hint that any data not escaping the current compilation unit can
2980 not be used or modified by the leaf function.  For example, the @code{sin} function
2981 is a leaf function, but @code{qsort} is not.
2983 Note that leaf functions might invoke signals and signal handlers might be
2984 defined in the current compilation unit and use static variables.  The only
2985 compliant way to write such a signal handler is to declare such variables
2986 @code{volatile}.
2988 The attribute has no effect on functions defined within the current compilation
2989 unit.  This is to allow easy merging of multiple compilation units into one,
2990 for example, by using the link-time optimization.  For this reason the
2991 attribute is not allowed on types to annotate indirect calls.
2993 @item long_call/short_call
2994 @cindex indirect calls on ARM
2995 This attribute specifies how a particular function is called on
2996 ARM and Epiphany.  Both attributes override the
2997 @option{-mlong-calls} (@pxref{ARM Options})
2998 command-line switch and @code{#pragma long_calls} settings.  The
2999 @code{long_call} attribute indicates that the function might be far
3000 away from the call site and require a different (more expensive)
3001 calling sequence.   The @code{short_call} attribute always places
3002 the offset to the function from the call site into the @samp{BL}
3003 instruction directly.
3005 @item longcall/shortcall
3006 @cindex functions called via pointer on the RS/6000 and PowerPC
3007 On the Blackfin, RS/6000 and PowerPC, the @code{longcall} attribute
3008 indicates that the function might be far away from the call site and
3009 require a different (more expensive) calling sequence.  The
3010 @code{shortcall} attribute indicates that the function is always close
3011 enough for the shorter calling sequence to be used.  These attributes
3012 override both the @option{-mlongcall} switch and, on the RS/6000 and
3013 PowerPC, the @code{#pragma longcall} setting.
3015 @xref{RS/6000 and PowerPC Options}, for more information on whether long
3016 calls are necessary.
3018 @item long_call/near/far
3019 @cindex indirect calls on MIPS
3020 These attributes specify how a particular function is called on MIPS@.
3021 The attributes override the @option{-mlong-calls} (@pxref{MIPS Options})
3022 command-line switch.  The @code{long_call} and @code{far} attributes are
3023 synonyms, and cause the compiler to always call
3024 the function by first loading its address into a register, and then using
3025 the contents of that register.  The @code{near} attribute has the opposite
3026 effect; it specifies that non-PIC calls should be made using the more
3027 efficient @code{jal} instruction.
3029 @item malloc
3030 @cindex @code{malloc} attribute
3031 The @code{malloc} attribute is used to tell the compiler that a function
3032 may be treated as if any non-@code{NULL} pointer it returns cannot
3033 alias any other pointer valid when the function returns and that the memory
3034 has undefined content.
3035 This often improves optimization.
3036 Standard functions with this property include @code{malloc} and
3037 @code{calloc}.  @code{realloc}-like functions do not have this
3038 property as the memory pointed to does not have undefined content.
3040 @item mips16/nomips16
3041 @cindex @code{mips16} attribute
3042 @cindex @code{nomips16} attribute
3044 On MIPS targets, you can use the @code{mips16} and @code{nomips16}
3045 function attributes to locally select or turn off MIPS16 code generation.
3046 A function with the @code{mips16} attribute is emitted as MIPS16 code,
3047 while MIPS16 code generation is disabled for functions with the
3048 @code{nomips16} attribute.  These attributes override the
3049 @option{-mips16} and @option{-mno-mips16} options on the command line
3050 (@pxref{MIPS Options}).
3052 When compiling files containing mixed MIPS16 and non-MIPS16 code, the
3053 preprocessor symbol @code{__mips16} reflects the setting on the command line,
3054 not that within individual functions.  Mixed MIPS16 and non-MIPS16 code
3055 may interact badly with some GCC extensions such as @code{__builtin_apply}
3056 (@pxref{Constructing Calls}).
3058 @item model (@var{model-name})
3059 @cindex function addressability on the M32R/D
3060 @cindex variable addressability on the IA-64
3062 On the M32R/D, use this attribute to set the addressability of an
3063 object, and of the code generated for a function.  The identifier
3064 @var{model-name} is one of @code{small}, @code{medium}, or
3065 @code{large}, representing each of the code models.
3067 Small model objects live in the lower 16MB of memory (so that their
3068 addresses can be loaded with the @code{ld24} instruction), and are
3069 callable with the @code{bl} instruction.
3071 Medium model objects may live anywhere in the 32-bit address space (the
3072 compiler generates @code{seth/add3} instructions to load their addresses),
3073 and are callable with the @code{bl} instruction.
3075 Large model objects may live anywhere in the 32-bit address space (the
3076 compiler generates @code{seth/add3} instructions to load their addresses),
3077 and may not be reachable with the @code{bl} instruction (the compiler
3078 generates the much slower @code{seth/add3/jl} instruction sequence).
3080 On IA-64, use this attribute to set the addressability of an object.
3081 At present, the only supported identifier for @var{model-name} is
3082 @code{small}, indicating addressability via ``small'' (22-bit)
3083 addresses (so that their addresses can be loaded with the @code{addl}
3084 instruction).  Caveat: such addressing is by definition not position
3085 independent and hence this attribute must not be used for objects
3086 defined by shared libraries.
3088 @item ms_abi/sysv_abi
3089 @cindex @code{ms_abi} attribute
3090 @cindex @code{sysv_abi} attribute
3092 On 32-bit and 64-bit (i?86|x86_64)-*-* targets, you can use an ABI attribute
3093 to indicate which calling convention should be used for a function.  The
3094 @code{ms_abi} attribute tells the compiler to use the Microsoft ABI,
3095 while the @code{sysv_abi} attribute tells the compiler to use the ABI
3096 used on GNU/Linux and other systems.  The default is to use the Microsoft ABI
3097 when targeting Windows.  On all other systems, the default is the x86/AMD ABI.
3099 Note, the @code{ms_abi} attribute for Microsoft Windows 64-bit targets currently
3100 requires the @option{-maccumulate-outgoing-args} option.
3102 @item callee_pop_aggregate_return (@var{number})
3103 @cindex @code{callee_pop_aggregate_return} attribute
3105 On 32-bit i?86-*-* targets, you can use this attribute to control how
3106 aggregates are returned in memory.  If the caller is responsible for
3107 popping the hidden pointer together with the rest of the arguments, specify
3108 @var{number} equal to zero.  If callee is responsible for popping the
3109 hidden pointer, specify @var{number} equal to one.  
3111 The default i386 ABI assumes that the callee pops the
3112 stack for hidden pointer.  However, on 32-bit i386 Microsoft Windows targets,
3113 the compiler assumes that the
3114 caller pops the stack for hidden pointer.
3116 @item ms_hook_prologue
3117 @cindex @code{ms_hook_prologue} attribute
3119 On 32-bit i[34567]86-*-* targets and 64-bit x86_64-*-* targets, you can use
3120 this function attribute to make GCC generate the ``hot-patching'' function
3121 prologue used in Win32 API functions in Microsoft Windows XP Service Pack 2
3122 and newer.
3124 @item naked
3125 @cindex function without a prologue/epilogue code
3126 Use this attribute on the ARM, AVR, MCORE, RX and SPU ports to indicate that
3127 the specified function does not need prologue/epilogue sequences generated by
3128 the compiler.  It is up to the programmer to provide these sequences. The
3129 only statements that can be safely included in naked functions are
3130 @code{asm} statements that do not have operands.  All other statements,
3131 including declarations of local variables, @code{if} statements, and so
3132 forth, should be avoided.  Naked functions should be used to implement the
3133 body of an assembly function, while allowing the compiler to construct
3134 the requisite function declaration for the assembler.
3136 @item near
3137 @cindex functions that do not handle memory bank switching on 68HC11/68HC12
3138 On 68HC11 and 68HC12 the @code{near} attribute causes the compiler to
3139 use the normal calling convention based on @code{jsr} and @code{rts}.
3140 This attribute can be used to cancel the effect of the @option{-mlong-calls}
3141 option.
3143 On MeP targets this attribute causes the compiler to assume the called
3144 function is close enough to use the normal calling convention,
3145 overriding the @option{-mtf} command-line option.
3147 @item nesting
3148 @cindex Allow nesting in an interrupt handler on the Blackfin processor.
3149 Use this attribute together with @code{interrupt_handler},
3150 @code{exception_handler} or @code{nmi_handler} to indicate that the function
3151 entry code should enable nested interrupts or exceptions.
3153 @item nmi_handler
3154 @cindex NMI handler functions on the Blackfin processor
3155 Use this attribute on the Blackfin to indicate that the specified function
3156 is an NMI handler.  The compiler generates function entry and
3157 exit sequences suitable for use in an NMI handler when this
3158 attribute is present.
3160 @item no_instrument_function
3161 @cindex @code{no_instrument_function} function attribute
3162 @opindex finstrument-functions
3163 If @option{-finstrument-functions} is given, profiling function calls are
3164 generated at entry and exit of most user-compiled functions.
3165 Functions with this attribute are not so instrumented.
3167 @item no_split_stack
3168 @cindex @code{no_split_stack} function attribute
3169 @opindex fsplit-stack
3170 If @option{-fsplit-stack} is given, functions have a small
3171 prologue which decides whether to split the stack.  Functions with the
3172 @code{no_split_stack} attribute do not have that prologue, and thus
3173 may run with only a small amount of stack space available.
3175 @item noinline
3176 @cindex @code{noinline} function attribute
3177 This function attribute prevents a function from being considered for
3178 inlining.
3179 @c Don't enumerate the optimizations by name here; we try to be
3180 @c future-compatible with this mechanism.
3181 If the function does not have side-effects, there are optimizations
3182 other than inlining that cause function calls to be optimized away,
3183 although the function call is live.  To keep such calls from being
3184 optimized away, put
3185 @smallexample
3186 asm ("");
3187 @end smallexample
3189 @noindent
3190 (@pxref{Extended Asm}) in the called function, to serve as a special
3191 side-effect.
3193 @item noclone
3194 @cindex @code{noclone} function attribute
3195 This function attribute prevents a function from being considered for
3196 cloning---a mechanism that produces specialized copies of functions
3197 and which is (currently) performed by interprocedural constant
3198 propagation.
3200 @item nonnull (@var{arg-index}, @dots{})
3201 @cindex @code{nonnull} function attribute
3202 The @code{nonnull} attribute specifies that some function parameters should
3203 be non-null pointers.  For instance, the declaration:
3205 @smallexample
3206 extern void *
3207 my_memcpy (void *dest, const void *src, size_t len)
3208         __attribute__((nonnull (1, 2)));
3209 @end smallexample
3211 @noindent
3212 causes the compiler to check that, in calls to @code{my_memcpy},
3213 arguments @var{dest} and @var{src} are non-null.  If the compiler
3214 determines that a null pointer is passed in an argument slot marked
3215 as non-null, and the @option{-Wnonnull} option is enabled, a warning
3216 is issued.  The compiler may also choose to make optimizations based
3217 on the knowledge that certain function arguments will never be null.
3219 If no argument index list is given to the @code{nonnull} attribute,
3220 all pointer arguments are marked as non-null.  To illustrate, the
3221 following declaration is equivalent to the previous example:
3223 @smallexample
3224 extern void *
3225 my_memcpy (void *dest, const void *src, size_t len)
3226         __attribute__((nonnull));
3227 @end smallexample
3229 @item noreturn
3230 @cindex @code{noreturn} function attribute
3231 A few standard library functions, such as @code{abort} and @code{exit},
3232 cannot return.  GCC knows this automatically.  Some programs define
3233 their own functions that never return.  You can declare them
3234 @code{noreturn} to tell the compiler this fact.  For example,
3236 @smallexample
3237 @group
3238 void fatal () __attribute__ ((noreturn));
3240 void
3241 fatal (/* @r{@dots{}} */)
3243   /* @r{@dots{}} */ /* @r{Print error message.} */ /* @r{@dots{}} */
3244   exit (1);
3246 @end group
3247 @end smallexample
3249 The @code{noreturn} keyword tells the compiler to assume that
3250 @code{fatal} cannot return.  It can then optimize without regard to what
3251 would happen if @code{fatal} ever did return.  This makes slightly
3252 better code.  More importantly, it helps avoid spurious warnings of
3253 uninitialized variables.
3255 The @code{noreturn} keyword does not affect the exceptional path when that
3256 applies: a @code{noreturn}-marked function may still return to the caller
3257 by throwing an exception or calling @code{longjmp}.
3259 Do not assume that registers saved by the calling function are
3260 restored before calling the @code{noreturn} function.
3262 It does not make sense for a @code{noreturn} function to have a return
3263 type other than @code{void}.
3265 The attribute @code{noreturn} is not implemented in GCC versions
3266 earlier than 2.5.  An alternative way to declare that a function does
3267 not return, which works in the current version and in some older
3268 versions, is as follows:
3270 @smallexample
3271 typedef void voidfn ();
3273 volatile voidfn fatal;
3274 @end smallexample
3276 @noindent
3277 This approach does not work in GNU C++.
3279 @item nothrow
3280 @cindex @code{nothrow} function attribute
3281 The @code{nothrow} attribute is used to inform the compiler that a
3282 function cannot throw an exception.  For example, most functions in
3283 the standard C library can be guaranteed not to throw an exception
3284 with the notable exceptions of @code{qsort} and @code{bsearch} that
3285 take function pointer arguments.  The @code{nothrow} attribute is not
3286 implemented in GCC versions earlier than 3.3.
3288 @item nosave_low_regs
3289 @cindex @code{nosave_low_regs} attribute
3290 Use this attribute on SH targets to indicate that an @code{interrupt_handler}
3291 function should not save and restore registers R0..R7.  This can be used on SH3*
3292 and SH4* targets that have a second R0..R7 register bank for non-reentrant
3293 interrupt handlers.
3295 @item optimize
3296 @cindex @code{optimize} function attribute
3297 The @code{optimize} attribute is used to specify that a function is to
3298 be compiled with different optimization options than specified on the
3299 command line.  Arguments can either be numbers or strings.  Numbers
3300 are assumed to be an optimization level.  Strings that begin with
3301 @code{O} are assumed to be an optimization option, while other options
3302 are assumed to be used with a @code{-f} prefix.  You can also use the
3303 @samp{#pragma GCC optimize} pragma to set the optimization options
3304 that affect more than one function.
3305 @xref{Function Specific Option Pragmas}, for details about the
3306 @samp{#pragma GCC optimize} pragma.
3308 This can be used for instance to have frequently-executed functions
3309 compiled with more aggressive optimization options that produce faster
3310 and larger code, while other functions can be compiled with less
3311 aggressive options.
3313 @item OS_main/OS_task
3314 @cindex @code{OS_main} AVR function attribute
3315 @cindex @code{OS_task} AVR function attribute
3316 On AVR, functions with the @code{OS_main} or @code{OS_task} attribute
3317 do not save/restore any call-saved register in their prologue/epilogue.
3319 The @code{OS_main} attribute can be used when there @emph{is
3320 guarantee} that interrupts are disabled at the time when the function
3321 is entered.  This saves resources when the stack pointer has to be
3322 changed to set up a frame for local variables.
3324 The @code{OS_task} attribute can be used when there is @emph{no
3325 guarantee} that interrupts are disabled at that time when the function
3326 is entered like for, e@.g@. task functions in a multi-threading operating
3327 system. In that case, changing the stack pointer register is
3328 guarded by save/clear/restore of the global interrupt enable flag.
3330 The differences to the @code{naked} function attribute are:
3331 @itemize @bullet
3332 @item @code{naked} functions do not have a return instruction whereas 
3333 @code{OS_main} and @code{OS_task} functions have a @code{RET} or
3334 @code{RETI} return instruction.
3335 @item @code{naked} functions do not set up a frame for local variables
3336 or a frame pointer whereas @code{OS_main} and @code{OS_task} do this
3337 as needed.
3338 @end itemize
3340 @item pcs
3341 @cindex @code{pcs} function attribute
3343 The @code{pcs} attribute can be used to control the calling convention
3344 used for a function on ARM.  The attribute takes an argument that specifies
3345 the calling convention to use.
3347 When compiling using the AAPCS ABI (or a variant of it) then valid
3348 values for the argument are @code{"aapcs"} and @code{"aapcs-vfp"}.  In
3349 order to use a variant other than @code{"aapcs"} then the compiler must
3350 be permitted to use the appropriate co-processor registers (i.e., the
3351 VFP registers must be available in order to use @code{"aapcs-vfp"}).
3352 For example,
3354 @smallexample
3355 /* Argument passed in r0, and result returned in r0+r1.  */
3356 double f2d (float) __attribute__((pcs("aapcs")));
3357 @end smallexample
3359 Variadic functions always use the @code{"aapcs"} calling convention and
3360 the compiler rejects attempts to specify an alternative.
3362 @item pure
3363 @cindex @code{pure} function attribute
3364 Many functions have no effects except the return value and their
3365 return value depends only on the parameters and/or global variables.
3366 Such a function can be subject
3367 to common subexpression elimination and loop optimization just as an
3368 arithmetic operator would be.  These functions should be declared
3369 with the attribute @code{pure}.  For example,
3371 @smallexample
3372 int square (int) __attribute__ ((pure));
3373 @end smallexample
3375 @noindent
3376 says that the hypothetical function @code{square} is safe to call
3377 fewer times than the program says.
3379 Some of common examples of pure functions are @code{strlen} or @code{memcmp}.
3380 Interesting non-pure functions are functions with infinite loops or those
3381 depending on volatile memory or other system resource, that may change between
3382 two consecutive calls (such as @code{feof} in a multithreading environment).
3384 The attribute @code{pure} is not implemented in GCC versions earlier
3385 than 2.96.
3387 @item hot
3388 @cindex @code{hot} function attribute
3389 The @code{hot} attribute on a function is used to inform the compiler that
3390 the function is a hot spot of the compiled program.  The function is
3391 optimized more aggressively and on many target it is placed into special
3392 subsection of the text section so all hot functions appears close together
3393 improving locality.
3395 When profile feedback is available, via @option{-fprofile-use}, hot functions
3396 are automatically detected and this attribute is ignored.
3398 The @code{hot} attribute on functions is not implemented in GCC versions
3399 earlier than 4.3.
3401 @cindex @code{hot} label attribute
3402 The @code{hot} attribute on a label is used to inform the compiler that
3403 path following the label are more likely than paths that are not so
3404 annotated.  This attribute is used in cases where @code{__builtin_expect}
3405 cannot be used, for instance with computed goto or @code{asm goto}.
3407 The @code{hot} attribute on labels is not implemented in GCC versions
3408 earlier than 4.8.
3410 @item cold
3411 @cindex @code{cold} function attribute
3412 The @code{cold} attribute on functions is used to inform the compiler that
3413 the function is unlikely to be executed.  The function is optimized for
3414 size rather than speed and on many targets it is placed into special
3415 subsection of the text section so all cold functions appears close together
3416 improving code locality of non-cold parts of program.  The paths leading
3417 to call of cold functions within code are marked as unlikely by the branch
3418 prediction mechanism.  It is thus useful to mark functions used to handle
3419 unlikely conditions, such as @code{perror}, as cold to improve optimization
3420 of hot functions that do call marked functions in rare occasions.
3422 When profile feedback is available, via @option{-fprofile-use}, cold functions
3423 are automatically detected and this attribute is ignored.
3425 The @code{cold} attribute on functions is not implemented in GCC versions
3426 earlier than 4.3.
3428 @cindex @code{cold} label attribute
3429 The @code{cold} attribute on labels is used to inform the compiler that
3430 the path following the label is unlikely to be executed.  This attribute
3431 is used in cases where @code{__builtin_expect} cannot be used, for instance
3432 with computed goto or @code{asm goto}.
3434 The @code{cold} attribute on labels is not implemented in GCC versions
3435 earlier than 4.8.
3437 @item no_address_safety_analysis
3438 @cindex @code{no_address_safety_analysis} function attribute
3439 The @code{no_address_safety_analysis} attribute on functions is used
3440 to inform the compiler that it should not instrument memory accesses
3441 in the function when compiling with the @option{-fsanitize=address} option.
3443 @item regparm (@var{number})
3444 @cindex @code{regparm} attribute
3445 @cindex functions that are passed arguments in registers on the 386
3446 On the Intel 386, the @code{regparm} attribute causes the compiler to
3447 pass arguments number one to @var{number} if they are of integral type
3448 in registers EAX, EDX, and ECX instead of on the stack.  Functions that
3449 take a variable number of arguments continue to be passed all of their
3450 arguments on the stack.
3452 Beware that on some ELF systems this attribute is unsuitable for
3453 global functions in shared libraries with lazy binding (which is the
3454 default).  Lazy binding sends the first call via resolving code in
3455 the loader, which might assume EAX, EDX and ECX can be clobbered, as
3456 per the standard calling conventions.  Solaris 8 is affected by this.
3457 Systems with the GNU C Library version 2.1 or higher
3458 and FreeBSD are believed to be
3459 safe since the loaders there save EAX, EDX and ECX.  (Lazy binding can be
3460 disabled with the linker or the loader if desired, to avoid the
3461 problem.)
3463 @item sseregparm
3464 @cindex @code{sseregparm} attribute
3465 On the Intel 386 with SSE support, the @code{sseregparm} attribute
3466 causes the compiler to pass up to 3 floating-point arguments in
3467 SSE registers instead of on the stack.  Functions that take a
3468 variable number of arguments continue to pass all of their
3469 floating-point arguments on the stack.
3471 @item force_align_arg_pointer
3472 @cindex @code{force_align_arg_pointer} attribute
3473 On the Intel x86, the @code{force_align_arg_pointer} attribute may be
3474 applied to individual function definitions, generating an alternate
3475 prologue and epilogue that realigns the run-time stack if necessary.
3476 This supports mixing legacy codes that run with a 4-byte aligned stack
3477 with modern codes that keep a 16-byte stack for SSE compatibility.
3479 @item renesas
3480 @cindex @code{renesas} attribute
3481 On SH targets this attribute specifies that the function or struct follows the
3482 Renesas ABI.
3484 @item resbank
3485 @cindex @code{resbank} attribute
3486 On the SH2A target, this attribute enables the high-speed register
3487 saving and restoration using a register bank for @code{interrupt_handler}
3488 routines.  Saving to the bank is performed automatically after the CPU
3489 accepts an interrupt that uses a register bank.
3491 The nineteen 32-bit registers comprising general register R0 to R14,
3492 control register GBR, and system registers MACH, MACL, and PR and the
3493 vector table address offset are saved into a register bank.  Register
3494 banks are stacked in first-in last-out (FILO) sequence.  Restoration
3495 from the bank is executed by issuing a RESBANK instruction.
3497 @item returns_twice
3498 @cindex @code{returns_twice} attribute
3499 The @code{returns_twice} attribute tells the compiler that a function may
3500 return more than one time.  The compiler ensures that all registers
3501 are dead before calling such a function and emits a warning about
3502 the variables that may be clobbered after the second return from the
3503 function.  Examples of such functions are @code{setjmp} and @code{vfork}.
3504 The @code{longjmp}-like counterpart of such function, if any, might need
3505 to be marked with the @code{noreturn} attribute.
3507 @item saveall
3508 @cindex save all registers on the Blackfin, H8/300, H8/300H, and H8S
3509 Use this attribute on the Blackfin, H8/300, H8/300H, and H8S to indicate that
3510 all registers except the stack pointer should be saved in the prologue
3511 regardless of whether they are used or not.
3513 @item save_volatiles
3514 @cindex save volatile registers on the MicroBlaze
3515 Use this attribute on the MicroBlaze to indicate that the function is
3516 an interrupt handler.  All volatile registers (in addition to non-volatile
3517 registers) are saved in the function prologue.  If the function is a leaf
3518 function, only volatiles used by the function are saved.  A normal function
3519 return is generated instead of a return from interrupt.
3521 @item section ("@var{section-name}")
3522 @cindex @code{section} function attribute
3523 Normally, the compiler places the code it generates in the @code{text} section.
3524 Sometimes, however, you need additional sections, or you need certain
3525 particular functions to appear in special sections.  The @code{section}
3526 attribute specifies that a function lives in a particular section.
3527 For example, the declaration:
3529 @smallexample
3530 extern void foobar (void) __attribute__ ((section ("bar")));
3531 @end smallexample
3533 @noindent
3534 puts the function @code{foobar} in the @code{bar} section.
3536 Some file formats do not support arbitrary sections so the @code{section}
3537 attribute is not available on all platforms.
3538 If you need to map the entire contents of a module to a particular
3539 section, consider using the facilities of the linker instead.
3541 @item sentinel
3542 @cindex @code{sentinel} function attribute
3543 This function attribute ensures that a parameter in a function call is
3544 an explicit @code{NULL}.  The attribute is only valid on variadic
3545 functions.  By default, the sentinel is located at position zero, the
3546 last parameter of the function call.  If an optional integer position
3547 argument P is supplied to the attribute, the sentinel must be located at
3548 position P counting backwards from the end of the argument list.
3550 @smallexample
3551 __attribute__ ((sentinel))
3552 is equivalent to
3553 __attribute__ ((sentinel(0)))
3554 @end smallexample
3556 The attribute is automatically set with a position of 0 for the built-in
3557 functions @code{execl} and @code{execlp}.  The built-in function
3558 @code{execle} has the attribute set with a position of 1.
3560 A valid @code{NULL} in this context is defined as zero with any pointer
3561 type.  If your system defines the @code{NULL} macro with an integer type
3562 then you need to add an explicit cast.  GCC replaces @code{stddef.h}
3563 with a copy that redefines NULL appropriately.
3565 The warnings for missing or incorrect sentinels are enabled with
3566 @option{-Wformat}.
3568 @item short_call
3569 See @code{long_call/short_call}.
3571 @item shortcall
3572 See @code{longcall/shortcall}.
3574 @item signal
3575 @cindex interrupt handler functions on the AVR processors
3576 Use this attribute on the AVR to indicate that the specified
3577 function is an interrupt handler.  The compiler generates function
3578 entry and exit sequences suitable for use in an interrupt handler when this
3579 attribute is present.
3581 See also the @code{interrupt} function attribute. 
3583 The AVR hardware globally disables interrupts when an interrupt is executed.
3584 Interrupt handler functions defined with the @code{signal} attribute
3585 do not re-enable interrupts.  It is save to enable interrupts in a
3586 @code{signal} handler.  This ``save'' only applies to the code
3587 generated by the compiler and not to the IRQ layout of the
3588 application which is responsibility of the application.
3590 If both @code{signal} and @code{interrupt} are specified for the same
3591 function, @code{signal} is silently ignored.
3593 @item sp_switch
3594 @cindex @code{sp_switch} attribute
3595 Use this attribute on the SH to indicate an @code{interrupt_handler}
3596 function should switch to an alternate stack.  It expects a string
3597 argument that names a global variable holding the address of the
3598 alternate stack.
3600 @smallexample
3601 void *alt_stack;
3602 void f () __attribute__ ((interrupt_handler,
3603                           sp_switch ("alt_stack")));
3604 @end smallexample
3606 @item stdcall
3607 @cindex functions that pop the argument stack on the 386
3608 On the Intel 386, the @code{stdcall} attribute causes the compiler to
3609 assume that the called function pops off the stack space used to
3610 pass arguments, unless it takes a variable number of arguments.
3612 @item syscall_linkage
3613 @cindex @code{syscall_linkage} attribute
3614 This attribute is used to modify the IA-64 calling convention by marking
3615 all input registers as live at all function exits.  This makes it possible
3616 to restart a system call after an interrupt without having to save/restore
3617 the input registers.  This also prevents kernel data from leaking into
3618 application code.
3620 @item target
3621 @cindex @code{target} function attribute
3622 The @code{target} attribute is used to specify that a function is to
3623 be compiled with different target options than specified on the
3624 command line.  This can be used for instance to have functions
3625 compiled with a different ISA (instruction set architecture) than the
3626 default.  You can also use the @samp{#pragma GCC target} pragma to set
3627 more than one function to be compiled with specific target options.
3628 @xref{Function Specific Option Pragmas}, for details about the
3629 @samp{#pragma GCC target} pragma.
3631 For instance on a 386, you could compile one function with
3632 @code{target("sse4.1,arch=core2")} and another with
3633 @code{target("sse4a,arch=amdfam10")}.  This is equivalent to
3634 compiling the first function with @option{-msse4.1} and
3635 @option{-march=core2} options, and the second function with
3636 @option{-msse4a} and @option{-march=amdfam10} options.  It is up to the
3637 user to make sure that a function is only invoked on a machine that
3638 supports the particular ISA it is compiled for (for example by using
3639 @code{cpuid} on 386 to determine what feature bits and architecture
3640 family are used).
3642 @smallexample
3643 int core2_func (void) __attribute__ ((__target__ ("arch=core2")));
3644 int sse3_func (void) __attribute__ ((__target__ ("sse3")));
3645 @end smallexample
3647 On the 386, the following options are allowed:
3649 @table @samp
3650 @item abm
3651 @itemx no-abm
3652 @cindex @code{target("abm")} attribute
3653 Enable/disable the generation of the advanced bit instructions.
3655 @item aes
3656 @itemx no-aes
3657 @cindex @code{target("aes")} attribute
3658 Enable/disable the generation of the AES instructions.
3660 @item mmx
3661 @itemx no-mmx
3662 @cindex @code{target("mmx")} attribute
3663 Enable/disable the generation of the MMX instructions.
3665 @item pclmul
3666 @itemx no-pclmul
3667 @cindex @code{target("pclmul")} attribute
3668 Enable/disable the generation of the PCLMUL instructions.
3670 @item popcnt
3671 @itemx no-popcnt
3672 @cindex @code{target("popcnt")} attribute
3673 Enable/disable the generation of the POPCNT instruction.
3675 @item sse
3676 @itemx no-sse
3677 @cindex @code{target("sse")} attribute
3678 Enable/disable the generation of the SSE instructions.
3680 @item sse2
3681 @itemx no-sse2
3682 @cindex @code{target("sse2")} attribute
3683 Enable/disable the generation of the SSE2 instructions.
3685 @item sse3
3686 @itemx no-sse3
3687 @cindex @code{target("sse3")} attribute
3688 Enable/disable the generation of the SSE3 instructions.
3690 @item sse4
3691 @itemx no-sse4
3692 @cindex @code{target("sse4")} attribute
3693 Enable/disable the generation of the SSE4 instructions (both SSE4.1
3694 and SSE4.2).
3696 @item sse4.1
3697 @itemx no-sse4.1
3698 @cindex @code{target("sse4.1")} attribute
3699 Enable/disable the generation of the sse4.1 instructions.
3701 @item sse4.2
3702 @itemx no-sse4.2
3703 @cindex @code{target("sse4.2")} attribute
3704 Enable/disable the generation of the sse4.2 instructions.
3706 @item sse4a
3707 @itemx no-sse4a
3708 @cindex @code{target("sse4a")} attribute
3709 Enable/disable the generation of the SSE4A instructions.
3711 @item fma4
3712 @itemx no-fma4
3713 @cindex @code{target("fma4")} attribute
3714 Enable/disable the generation of the FMA4 instructions.
3716 @item xop
3717 @itemx no-xop
3718 @cindex @code{target("xop")} attribute
3719 Enable/disable the generation of the XOP instructions.
3721 @item lwp
3722 @itemx no-lwp
3723 @cindex @code{target("lwp")} attribute
3724 Enable/disable the generation of the LWP instructions.
3726 @item ssse3
3727 @itemx no-ssse3
3728 @cindex @code{target("ssse3")} attribute
3729 Enable/disable the generation of the SSSE3 instructions.
3731 @item cld
3732 @itemx no-cld
3733 @cindex @code{target("cld")} attribute
3734 Enable/disable the generation of the CLD before string moves.
3736 @item fancy-math-387
3737 @itemx no-fancy-math-387
3738 @cindex @code{target("fancy-math-387")} attribute
3739 Enable/disable the generation of the @code{sin}, @code{cos}, and
3740 @code{sqrt} instructions on the 387 floating-point unit.
3742 @item fused-madd
3743 @itemx no-fused-madd
3744 @cindex @code{target("fused-madd")} attribute
3745 Enable/disable the generation of the fused multiply/add instructions.
3747 @item ieee-fp
3748 @itemx no-ieee-fp
3749 @cindex @code{target("ieee-fp")} attribute
3750 Enable/disable the generation of floating point that depends on IEEE arithmetic.
3752 @item inline-all-stringops
3753 @itemx no-inline-all-stringops
3754 @cindex @code{target("inline-all-stringops")} attribute
3755 Enable/disable inlining of string operations.
3757 @item inline-stringops-dynamically
3758 @itemx no-inline-stringops-dynamically
3759 @cindex @code{target("inline-stringops-dynamically")} attribute
3760 Enable/disable the generation of the inline code to do small string
3761 operations and calling the library routines for large operations.
3763 @item align-stringops
3764 @itemx no-align-stringops
3765 @cindex @code{target("align-stringops")} attribute
3766 Do/do not align destination of inlined string operations.
3768 @item recip
3769 @itemx no-recip
3770 @cindex @code{target("recip")} attribute
3771 Enable/disable the generation of RCPSS, RCPPS, RSQRTSS and RSQRTPS
3772 instructions followed an additional Newton-Raphson step instead of
3773 doing a floating-point division.
3775 @item arch=@var{ARCH}
3776 @cindex @code{target("arch=@var{ARCH}")} attribute
3777 Specify the architecture to generate code for in compiling the function.
3779 @item tune=@var{TUNE}
3780 @cindex @code{target("tune=@var{TUNE}")} attribute
3781 Specify the architecture to tune for in compiling the function.
3783 @item fpmath=@var{FPMATH}
3784 @cindex @code{target("fpmath=@var{FPMATH}")} attribute
3785 Specify which floating-point unit to use.  The
3786 @code{target("fpmath=sse,387")} option must be specified as
3787 @code{target("fpmath=sse+387")} because the comma would separate
3788 different options.
3789 @end table
3791 On the PowerPC, the following options are allowed:
3793 @table @samp
3794 @item altivec
3795 @itemx no-altivec
3796 @cindex @code{target("altivec")} attribute
3797 Generate code that uses (does not use) AltiVec instructions.  In
3798 32-bit code, you cannot enable AltiVec instructions unless
3799 @option{-mabi=altivec} is used on the command line.
3801 @item cmpb
3802 @itemx no-cmpb
3803 @cindex @code{target("cmpb")} attribute
3804 Generate code that uses (does not use) the compare bytes instruction
3805 implemented on the POWER6 processor and other processors that support
3806 the PowerPC V2.05 architecture.
3808 @item dlmzb
3809 @itemx no-dlmzb
3810 @cindex @code{target("dlmzb")} attribute
3811 Generate code that uses (does not use) the string-search @samp{dlmzb}
3812 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
3813 generated by default when targeting those processors.
3815 @item fprnd
3816 @itemx no-fprnd
3817 @cindex @code{target("fprnd")} attribute
3818 Generate code that uses (does not use) the FP round to integer
3819 instructions implemented on the POWER5+ processor and other processors
3820 that support the PowerPC V2.03 architecture.
3822 @item hard-dfp
3823 @itemx no-hard-dfp
3824 @cindex @code{target("hard-dfp")} attribute
3825 Generate code that uses (does not use) the decimal floating-point
3826 instructions implemented on some POWER processors.
3828 @item isel
3829 @itemx no-isel
3830 @cindex @code{target("isel")} attribute
3831 Generate code that uses (does not use) ISEL instruction.
3833 @item mfcrf
3834 @itemx no-mfcrf
3835 @cindex @code{target("mfcrf")} attribute
3836 Generate code that uses (does not use) the move from condition
3837 register field instruction implemented on the POWER4 processor and
3838 other processors that support the PowerPC V2.01 architecture.
3840 @item mfpgpr
3841 @itemx no-mfpgpr
3842 @cindex @code{target("mfpgpr")} attribute
3843 Generate code that uses (does not use) the FP move to/from general
3844 purpose register instructions implemented on the POWER6X processor and
3845 other processors that support the extended PowerPC V2.05 architecture.
3847 @item mulhw
3848 @itemx no-mulhw
3849 @cindex @code{target("mulhw")} attribute
3850 Generate code that uses (does not use) the half-word multiply and
3851 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
3852 These instructions are generated by default when targeting those
3853 processors.
3855 @item multiple
3856 @itemx no-multiple
3857 @cindex @code{target("multiple")} attribute
3858 Generate code that uses (does not use) the load multiple word
3859 instructions and the store multiple word instructions.
3861 @item update
3862 @itemx no-update
3863 @cindex @code{target("update")} attribute
3864 Generate code that uses (does not use) the load or store instructions
3865 that update the base register to the address of the calculated memory
3866 location.
3868 @item popcntb
3869 @itemx no-popcntb
3870 @cindex @code{target("popcntb")} attribute
3871 Generate code that uses (does not use) the popcount and double-precision
3872 FP reciprocal estimate instruction implemented on the POWER5
3873 processor and other processors that support the PowerPC V2.02
3874 architecture.
3876 @item popcntd
3877 @itemx no-popcntd
3878 @cindex @code{target("popcntd")} attribute
3879 Generate code that uses (does not use) the popcount instruction
3880 implemented on the POWER7 processor and other processors that support
3881 the PowerPC V2.06 architecture.
3883 @item powerpc-gfxopt
3884 @itemx no-powerpc-gfxopt
3885 @cindex @code{target("powerpc-gfxopt")} attribute
3886 Generate code that uses (does not use) the optional PowerPC
3887 architecture instructions in the Graphics group, including
3888 floating-point select.
3890 @item powerpc-gpopt
3891 @itemx no-powerpc-gpopt
3892 @cindex @code{target("powerpc-gpopt")} attribute
3893 Generate code that uses (does not use) the optional PowerPC
3894 architecture instructions in the General Purpose group, including
3895 floating-point square root.
3897 @item recip-precision
3898 @itemx no-recip-precision
3899 @cindex @code{target("recip-precision")} attribute
3900 Assume (do not assume) that the reciprocal estimate instructions
3901 provide higher-precision estimates than is mandated by the powerpc
3902 ABI.
3904 @item string
3905 @itemx no-string
3906 @cindex @code{target("string")} attribute
3907 Generate code that uses (does not use) the load string instructions
3908 and the store string word instructions to save multiple registers and
3909 do small block moves.
3911 @item vsx
3912 @itemx no-vsx
3913 @cindex @code{target("vsx")} attribute
3914 Generate code that uses (does not use) vector/scalar (VSX)
3915 instructions, and also enable the use of built-in functions that allow
3916 more direct access to the VSX instruction set.  In 32-bit code, you
3917 cannot enable VSX or AltiVec instructions unless
3918 @option{-mabi=altivec} is used on the command line.
3920 @item friz
3921 @itemx no-friz
3922 @cindex @code{target("friz")} attribute
3923 Generate (do not generate) the @code{friz} instruction when the
3924 @option{-funsafe-math-optimizations} option is used to optimize
3925 rounding a floating-point value to 64-bit integer and back to floating
3926 point.  The @code{friz} instruction does not return the same value if
3927 the floating-point number is too large to fit in an integer.
3929 @item avoid-indexed-addresses
3930 @itemx no-avoid-indexed-addresses
3931 @cindex @code{target("avoid-indexed-addresses")} attribute
3932 Generate code that tries to avoid (not avoid) the use of indexed load
3933 or store instructions.
3935 @item paired
3936 @itemx no-paired
3937 @cindex @code{target("paired")} attribute
3938 Generate code that uses (does not use) the generation of PAIRED simd
3939 instructions.
3941 @item longcall
3942 @itemx no-longcall
3943 @cindex @code{target("longcall")} attribute
3944 Generate code that assumes (does not assume) that all calls are far
3945 away so that a longer more expensive calling sequence is required.
3947 @item cpu=@var{CPU}
3948 @cindex @code{target("cpu=@var{CPU}")} attribute
3949 Specify the architecture to generate code for when compiling the
3950 function.  If you select the @code{target("cpu=power7")} attribute when
3951 generating 32-bit code, VSX and AltiVec instructions are not generated
3952 unless you use the @option{-mabi=altivec} option on the command line.
3954 @item tune=@var{TUNE}
3955 @cindex @code{target("tune=@var{TUNE}")} attribute
3956 Specify the architecture to tune for when compiling the function.  If
3957 you do not specify the @code{target("tune=@var{TUNE}")} attribute and
3958 you do specify the @code{target("cpu=@var{CPU}")} attribute,
3959 compilation tunes for the @var{CPU} architecture, and not the
3960 default tuning specified on the command line.
3961 @end table
3963 On the 386/x86_64 and PowerPC back ends, you can use either multiple
3964 strings to specify multiple options, or you can separate the option
3965 with a comma (@code{,}).
3967 On the 386/x86_64 and PowerPC back ends, the inliner does not inline a
3968 function that has different target options than the caller, unless the
3969 callee has a subset of the target options of the caller.  For example
3970 a function declared with @code{target("sse3")} can inline a function
3971 with @code{target("sse2")}, since @code{-msse3} implies @code{-msse2}.
3973 The @code{target} attribute is not implemented in GCC versions earlier
3974 than 4.4 for the i386/x86_64 and 4.6 for the PowerPC back ends.  It is
3975 not currently implemented for other back ends.
3977 @item tiny_data
3978 @cindex tiny data section on the H8/300H and H8S
3979 Use this attribute on the H8/300H and H8S to indicate that the specified
3980 variable should be placed into the tiny data section.
3981 The compiler generates more efficient code for loads and stores
3982 on data in the tiny data section.  Note the tiny data area is limited to
3983 slightly under 32KB of data.
3985 @item trap_exit
3986 @cindex @code{trap_exit} attribute
3987 Use this attribute on the SH for an @code{interrupt_handler} to return using
3988 @code{trapa} instead of @code{rte}.  This attribute expects an integer
3989 argument specifying the trap number to be used.
3991 @item trapa_handler
3992 @cindex @code{trapa_handler} attribute
3993 On SH targets this function attribute is similar to @code{interrupt_handler}
3994 but it does not save and restore all registers.
3996 @item unused
3997 @cindex @code{unused} attribute.
3998 This attribute, attached to a function, means that the function is meant
3999 to be possibly unused.  GCC does not produce a warning for this
4000 function.
4002 @item used
4003 @cindex @code{used} attribute.
4004 This attribute, attached to a function, means that code must be emitted
4005 for the function even if it appears that the function is not referenced.
4006 This is useful, for example, when the function is referenced only in
4007 inline assembly.
4009 When applied to a member function of a C++ class template, the
4010 attribute also means that the function is instantiated if the
4011 class itself is instantiated.
4013 @item version_id
4014 @cindex @code{version_id} attribute
4015 This IA-64 HP-UX attribute, attached to a global variable or function, renames a
4016 symbol to contain a version string, thus allowing for function level
4017 versioning.  HP-UX system header files may use version level functioning
4018 for some system calls.
4020 @smallexample
4021 extern int foo () __attribute__((version_id ("20040821")));
4022 @end smallexample
4024 @noindent
4025 Calls to @var{foo} are mapped to calls to @var{foo@{20040821@}}.
4027 @item visibility ("@var{visibility_type}")
4028 @cindex @code{visibility} attribute
4029 This attribute affects the linkage of the declaration to which it is attached.
4030 There are four supported @var{visibility_type} values: default,
4031 hidden, protected or internal visibility.
4033 @smallexample
4034 void __attribute__ ((visibility ("protected")))
4035 f () @{ /* @r{Do something.} */; @}
4036 int i __attribute__ ((visibility ("hidden")));
4037 @end smallexample
4039 The possible values of @var{visibility_type} correspond to the
4040 visibility settings in the ELF gABI.
4042 @table @dfn
4043 @c keep this list of visibilities in alphabetical order.
4045 @item default
4046 Default visibility is the normal case for the object file format.
4047 This value is available for the visibility attribute to override other
4048 options that may change the assumed visibility of entities.
4050 On ELF, default visibility means that the declaration is visible to other
4051 modules and, in shared libraries, means that the declared entity may be
4052 overridden.
4054 On Darwin, default visibility means that the declaration is visible to
4055 other modules.
4057 Default visibility corresponds to ``external linkage'' in the language.
4059 @item hidden
4060 Hidden visibility indicates that the entity declared has a new
4061 form of linkage, which we call ``hidden linkage''.  Two
4062 declarations of an object with hidden linkage refer to the same object
4063 if they are in the same shared object.
4065 @item internal
4066 Internal visibility is like hidden visibility, but with additional
4067 processor specific semantics.  Unless otherwise specified by the
4068 psABI, GCC defines internal visibility to mean that a function is
4069 @emph{never} called from another module.  Compare this with hidden
4070 functions which, while they cannot be referenced directly by other
4071 modules, can be referenced indirectly via function pointers.  By
4072 indicating that a function cannot be called from outside the module,
4073 GCC may for instance omit the load of a PIC register since it is known
4074 that the calling function loaded the correct value.
4076 @item protected
4077 Protected visibility is like default visibility except that it
4078 indicates that references within the defining module bind to the
4079 definition in that module.  That is, the declared entity cannot be
4080 overridden by another module.
4082 @end table
4084 All visibilities are supported on many, but not all, ELF targets
4085 (supported when the assembler supports the @samp{.visibility}
4086 pseudo-op).  Default visibility is supported everywhere.  Hidden
4087 visibility is supported on Darwin targets.
4089 The visibility attribute should be applied only to declarations that
4090 would otherwise have external linkage.  The attribute should be applied
4091 consistently, so that the same entity should not be declared with
4092 different settings of the attribute.
4094 In C++, the visibility attribute applies to types as well as functions
4095 and objects, because in C++ types have linkage.  A class must not have
4096 greater visibility than its non-static data member types and bases,
4097 and class members default to the visibility of their class.  Also, a
4098 declaration without explicit visibility is limited to the visibility
4099 of its type.
4101 In C++, you can mark member functions and static member variables of a
4102 class with the visibility attribute.  This is useful if you know a
4103 particular method or static member variable should only be used from
4104 one shared object; then you can mark it hidden while the rest of the
4105 class has default visibility.  Care must be taken to avoid breaking
4106 the One Definition Rule; for example, it is usually not useful to mark
4107 an inline method as hidden without marking the whole class as hidden.
4109 A C++ namespace declaration can also have the visibility attribute.
4110 This attribute applies only to the particular namespace body, not to
4111 other definitions of the same namespace; it is equivalent to using
4112 @samp{#pragma GCC visibility} before and after the namespace
4113 definition (@pxref{Visibility Pragmas}).
4115 In C++, if a template argument has limited visibility, this
4116 restriction is implicitly propagated to the template instantiation.
4117 Otherwise, template instantiations and specializations default to the
4118 visibility of their template.
4120 If both the template and enclosing class have explicit visibility, the
4121 visibility from the template is used.
4123 @item vliw
4124 @cindex @code{vliw} attribute
4125 On MeP, the @code{vliw} attribute tells the compiler to emit
4126 instructions in VLIW mode instead of core mode.  Note that this
4127 attribute is not allowed unless a VLIW coprocessor has been configured
4128 and enabled through command-line options.
4130 @item warn_unused_result
4131 @cindex @code{warn_unused_result} attribute
4132 The @code{warn_unused_result} attribute causes a warning to be emitted
4133 if a caller of the function with this attribute does not use its
4134 return value.  This is useful for functions where not checking
4135 the result is either a security problem or always a bug, such as
4136 @code{realloc}.
4138 @smallexample
4139 int fn () __attribute__ ((warn_unused_result));
4140 int foo ()
4142   if (fn () < 0) return -1;
4143   fn ();
4144   return 0;
4146 @end smallexample
4148 @noindent
4149 results in warning on line 5.
4151 @item weak
4152 @cindex @code{weak} attribute
4153 The @code{weak} attribute causes the declaration to be emitted as a weak
4154 symbol rather than a global.  This is primarily useful in defining
4155 library functions that can be overridden in user code, though it can
4156 also be used with non-function declarations.  Weak symbols are supported
4157 for ELF targets, and also for a.out targets when using the GNU assembler
4158 and linker.
4160 @item weakref
4161 @itemx weakref ("@var{target}")
4162 @cindex @code{weakref} attribute
4163 The @code{weakref} attribute marks a declaration as a weak reference.
4164 Without arguments, it should be accompanied by an @code{alias} attribute
4165 naming the target symbol.  Optionally, the @var{target} may be given as
4166 an argument to @code{weakref} itself.  In either case, @code{weakref}
4167 implicitly marks the declaration as @code{weak}.  Without a
4168 @var{target}, given as an argument to @code{weakref} or to @code{alias},
4169 @code{weakref} is equivalent to @code{weak}.
4171 @smallexample
4172 static int x() __attribute__ ((weakref ("y")));
4173 /* is equivalent to... */
4174 static int x() __attribute__ ((weak, weakref, alias ("y")));
4175 /* and to... */
4176 static int x() __attribute__ ((weakref));
4177 static int x() __attribute__ ((alias ("y")));
4178 @end smallexample
4180 A weak reference is an alias that does not by itself require a
4181 definition to be given for the target symbol.  If the target symbol is
4182 only referenced through weak references, then it becomes a @code{weak}
4183 undefined symbol.  If it is directly referenced, however, then such
4184 strong references prevail, and a definition is required for the
4185 symbol, not necessarily in the same translation unit.
4187 The effect is equivalent to moving all references to the alias to a
4188 separate translation unit, renaming the alias to the aliased symbol,
4189 declaring it as weak, compiling the two separate translation units and
4190 performing a reloadable link on them.
4192 At present, a declaration to which @code{weakref} is attached can
4193 only be @code{static}.
4195 @end table
4197 You can specify multiple attributes in a declaration by separating them
4198 by commas within the double parentheses or by immediately following an
4199 attribute declaration with another attribute declaration.
4201 @cindex @code{#pragma}, reason for not using
4202 @cindex pragma, reason for not using
4203 Some people object to the @code{__attribute__} feature, suggesting that
4204 ISO C's @code{#pragma} should be used instead.  At the time
4205 @code{__attribute__} was designed, there were two reasons for not doing
4206 this.
4208 @enumerate
4209 @item
4210 It is impossible to generate @code{#pragma} commands from a macro.
4212 @item
4213 There is no telling what the same @code{#pragma} might mean in another
4214 compiler.
4215 @end enumerate
4217 These two reasons applied to almost any application that might have been
4218 proposed for @code{#pragma}.  It was basically a mistake to use
4219 @code{#pragma} for @emph{anything}.
4221 The ISO C99 standard includes @code{_Pragma}, which now allows pragmas
4222 to be generated from macros.  In addition, a @code{#pragma GCC}
4223 namespace is now in use for GCC-specific pragmas.  However, it has been
4224 found convenient to use @code{__attribute__} to achieve a natural
4225 attachment of attributes to their corresponding declarations, whereas
4226 @code{#pragma GCC} is of use for constructs that do not naturally form
4227 part of the grammar.  @xref{Pragmas,,Pragmas Accepted by GCC}.
4229 @node Attribute Syntax
4230 @section Attribute Syntax
4231 @cindex attribute syntax
4233 This section describes the syntax with which @code{__attribute__} may be
4234 used, and the constructs to which attribute specifiers bind, for the C
4235 language.  Some details may vary for C++ and Objective-C@.  Because of
4236 infelicities in the grammar for attributes, some forms described here
4237 may not be successfully parsed in all cases.
4239 There are some problems with the semantics of attributes in C++.  For
4240 example, there are no manglings for attributes, although they may affect
4241 code generation, so problems may arise when attributed types are used in
4242 conjunction with templates or overloading.  Similarly, @code{typeid}
4243 does not distinguish between types with different attributes.  Support
4244 for attributes in C++ may be restricted in future to attributes on
4245 declarations only, but not on nested declarators.
4247 @xref{Function Attributes}, for details of the semantics of attributes
4248 applying to functions.  @xref{Variable Attributes}, for details of the
4249 semantics of attributes applying to variables.  @xref{Type Attributes},
4250 for details of the semantics of attributes applying to structure, union
4251 and enumerated types.
4253 An @dfn{attribute specifier} is of the form
4254 @code{__attribute__ ((@var{attribute-list}))}.  An @dfn{attribute list}
4255 is a possibly empty comma-separated sequence of @dfn{attributes}, where
4256 each attribute is one of the following:
4258 @itemize @bullet
4259 @item
4260 Empty.  Empty attributes are ignored.
4262 @item
4263 A word (which may be an identifier such as @code{unused}, or a reserved
4264 word such as @code{const}).
4266 @item
4267 A word, followed by, in parentheses, parameters for the attribute.
4268 These parameters take one of the following forms:
4270 @itemize @bullet
4271 @item
4272 An identifier.  For example, @code{mode} attributes use this form.
4274 @item
4275 An identifier followed by a comma and a non-empty comma-separated list
4276 of expressions.  For example, @code{format} attributes use this form.
4278 @item
4279 A possibly empty comma-separated list of expressions.  For example,
4280 @code{format_arg} attributes use this form with the list being a single
4281 integer constant expression, and @code{alias} attributes use this form
4282 with the list being a single string constant.
4283 @end itemize
4284 @end itemize
4286 An @dfn{attribute specifier list} is a sequence of one or more attribute
4287 specifiers, not separated by any other tokens.
4289 In GNU C, an attribute specifier list may appear after the colon following a
4290 label, other than a @code{case} or @code{default} label.  The only
4291 attribute it makes sense to use after a label is @code{unused}.  This
4292 feature is intended for program-generated code that may contain unused labels,
4293 but which is compiled with @option{-Wall}.  It is
4294 not normally appropriate to use in it human-written code, though it
4295 could be useful in cases where the code that jumps to the label is
4296 contained within an @code{#ifdef} conditional.  GNU C++ only permits
4297 attributes on labels if the attribute specifier is immediately
4298 followed by a semicolon (i.e., the label applies to an empty
4299 statement).  If the semicolon is missing, C++ label attributes are
4300 ambiguous, as it is permissible for a declaration, which could begin
4301 with an attribute list, to be labelled in C++.  Declarations cannot be
4302 labelled in C90 or C99, so the ambiguity does not arise there.
4304 An attribute specifier list may appear as part of a @code{struct},
4305 @code{union} or @code{enum} specifier.  It may go either immediately
4306 after the @code{struct}, @code{union} or @code{enum} keyword, or after
4307 the closing brace.  The former syntax is preferred.
4308 Where attribute specifiers follow the closing brace, they are considered
4309 to relate to the structure, union or enumerated type defined, not to any
4310 enclosing declaration the type specifier appears in, and the type
4311 defined is not complete until after the attribute specifiers.
4312 @c Otherwise, there would be the following problems: a shift/reduce
4313 @c conflict between attributes binding the struct/union/enum and
4314 @c binding to the list of specifiers/qualifiers; and "aligned"
4315 @c attributes could use sizeof for the structure, but the size could be
4316 @c changed later by "packed" attributes.
4318 Otherwise, an attribute specifier appears as part of a declaration,
4319 counting declarations of unnamed parameters and type names, and relates
4320 to that declaration (which may be nested in another declaration, for
4321 example in the case of a parameter declaration), or to a particular declarator
4322 within a declaration.  Where an
4323 attribute specifier is applied to a parameter declared as a function or
4324 an array, it should apply to the function or array rather than the
4325 pointer to which the parameter is implicitly converted, but this is not
4326 yet correctly implemented.
4328 Any list of specifiers and qualifiers at the start of a declaration may
4329 contain attribute specifiers, whether or not such a list may in that
4330 context contain storage class specifiers.  (Some attributes, however,
4331 are essentially in the nature of storage class specifiers, and only make
4332 sense where storage class specifiers may be used; for example,
4333 @code{section}.)  There is one necessary limitation to this syntax: the
4334 first old-style parameter declaration in a function definition cannot
4335 begin with an attribute specifier, because such an attribute applies to
4336 the function instead by syntax described below (which, however, is not
4337 yet implemented in this case).  In some other cases, attribute
4338 specifiers are permitted by this grammar but not yet supported by the
4339 compiler.  All attribute specifiers in this place relate to the
4340 declaration as a whole.  In the obsolescent usage where a type of
4341 @code{int} is implied by the absence of type specifiers, such a list of
4342 specifiers and qualifiers may be an attribute specifier list with no
4343 other specifiers or qualifiers.
4345 At present, the first parameter in a function prototype must have some
4346 type specifier that is not an attribute specifier; this resolves an
4347 ambiguity in the interpretation of @code{void f(int
4348 (__attribute__((foo)) x))}, but is subject to change.  At present, if
4349 the parentheses of a function declarator contain only attributes then
4350 those attributes are ignored, rather than yielding an error or warning
4351 or implying a single parameter of type int, but this is subject to
4352 change.
4354 An attribute specifier list may appear immediately before a declarator
4355 (other than the first) in a comma-separated list of declarators in a
4356 declaration of more than one identifier using a single list of
4357 specifiers and qualifiers.  Such attribute specifiers apply
4358 only to the identifier before whose declarator they appear.  For
4359 example, in
4361 @smallexample
4362 __attribute__((noreturn)) void d0 (void),
4363     __attribute__((format(printf, 1, 2))) d1 (const char *, ...),
4364      d2 (void)
4365 @end smallexample
4367 @noindent
4368 the @code{noreturn} attribute applies to all the functions
4369 declared; the @code{format} attribute only applies to @code{d1}.
4371 An attribute specifier list may appear immediately before the comma,
4372 @code{=} or semicolon terminating the declaration of an identifier other
4373 than a function definition.  Such attribute specifiers apply
4374 to the declared object or function.  Where an
4375 assembler name for an object or function is specified (@pxref{Asm
4376 Labels}), the attribute must follow the @code{asm}
4377 specification.
4379 An attribute specifier list may, in future, be permitted to appear after
4380 the declarator in a function definition (before any old-style parameter
4381 declarations or the function body).
4383 Attribute specifiers may be mixed with type qualifiers appearing inside
4384 the @code{[]} of a parameter array declarator, in the C99 construct by
4385 which such qualifiers are applied to the pointer to which the array is
4386 implicitly converted.  Such attribute specifiers apply to the pointer,
4387 not to the array, but at present this is not implemented and they are
4388 ignored.
4390 An attribute specifier list may appear at the start of a nested
4391 declarator.  At present, there are some limitations in this usage: the
4392 attributes correctly apply to the declarator, but for most individual
4393 attributes the semantics this implies are not implemented.
4394 When attribute specifiers follow the @code{*} of a pointer
4395 declarator, they may be mixed with any type qualifiers present.
4396 The following describes the formal semantics of this syntax.  It makes the
4397 most sense if you are familiar with the formal specification of
4398 declarators in the ISO C standard.
4400 Consider (as in C99 subclause 6.7.5 paragraph 4) a declaration @code{T
4401 D1}, where @code{T} contains declaration specifiers that specify a type
4402 @var{Type} (such as @code{int}) and @code{D1} is a declarator that
4403 contains an identifier @var{ident}.  The type specified for @var{ident}
4404 for derived declarators whose type does not include an attribute
4405 specifier is as in the ISO C standard.
4407 If @code{D1} has the form @code{( @var{attribute-specifier-list} D )},
4408 and the declaration @code{T D} specifies the type
4409 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
4410 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
4411 @var{attribute-specifier-list} @var{Type}'' for @var{ident}.
4413 If @code{D1} has the form @code{*
4414 @var{type-qualifier-and-attribute-specifier-list} D}, and the
4415 declaration @code{T D} specifies the type
4416 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
4417 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
4418 @var{type-qualifier-and-attribute-specifier-list} pointer to @var{Type}'' for
4419 @var{ident}.
4421 For example,
4423 @smallexample
4424 void (__attribute__((noreturn)) ****f) (void);
4425 @end smallexample
4427 @noindent
4428 specifies the type ``pointer to pointer to pointer to pointer to
4429 non-returning function returning @code{void}''.  As another example,
4431 @smallexample
4432 char *__attribute__((aligned(8))) *f;
4433 @end smallexample
4435 @noindent
4436 specifies the type ``pointer to 8-byte-aligned pointer to @code{char}''.
4437 Note again that this does not work with most attributes; for example,
4438 the usage of @samp{aligned} and @samp{noreturn} attributes given above
4439 is not yet supported.
4441 For compatibility with existing code written for compiler versions that
4442 did not implement attributes on nested declarators, some laxity is
4443 allowed in the placing of attributes.  If an attribute that only applies
4444 to types is applied to a declaration, it is treated as applying to
4445 the type of that declaration.  If an attribute that only applies to
4446 declarations is applied to the type of a declaration, it is treated
4447 as applying to that declaration; and, for compatibility with code
4448 placing the attributes immediately before the identifier declared, such
4449 an attribute applied to a function return type is treated as
4450 applying to the function type, and such an attribute applied to an array
4451 element type is treated as applying to the array type.  If an
4452 attribute that only applies to function types is applied to a
4453 pointer-to-function type, it is treated as applying to the pointer
4454 target type; if such an attribute is applied to a function return type
4455 that is not a pointer-to-function type, it is treated as applying
4456 to the function type.
4458 @node Function Prototypes
4459 @section Prototypes and Old-Style Function Definitions
4460 @cindex function prototype declarations
4461 @cindex old-style function definitions
4462 @cindex promotion of formal parameters
4464 GNU C extends ISO C to allow a function prototype to override a later
4465 old-style non-prototype definition.  Consider the following example:
4467 @smallexample
4468 /* @r{Use prototypes unless the compiler is old-fashioned.}  */
4469 #ifdef __STDC__
4470 #define P(x) x
4471 #else
4472 #define P(x) ()
4473 #endif
4475 /* @r{Prototype function declaration.}  */
4476 int isroot P((uid_t));
4478 /* @r{Old-style function definition.}  */
4480 isroot (x)   /* @r{??? lossage here ???} */
4481      uid_t x;
4483   return x == 0;
4485 @end smallexample
4487 Suppose the type @code{uid_t} happens to be @code{short}.  ISO C does
4488 not allow this example, because subword arguments in old-style
4489 non-prototype definitions are promoted.  Therefore in this example the
4490 function definition's argument is really an @code{int}, which does not
4491 match the prototype argument type of @code{short}.
4493 This restriction of ISO C makes it hard to write code that is portable
4494 to traditional C compilers, because the programmer does not know
4495 whether the @code{uid_t} type is @code{short}, @code{int}, or
4496 @code{long}.  Therefore, in cases like these GNU C allows a prototype
4497 to override a later old-style definition.  More precisely, in GNU C, a
4498 function prototype argument type overrides the argument type specified
4499 by a later old-style definition if the former type is the same as the
4500 latter type before promotion.  Thus in GNU C the above example is
4501 equivalent to the following:
4503 @smallexample
4504 int isroot (uid_t);
4507 isroot (uid_t x)
4509   return x == 0;
4511 @end smallexample
4513 @noindent
4514 GNU C++ does not support old-style function definitions, so this
4515 extension is irrelevant.
4517 @node C++ Comments
4518 @section C++ Style Comments
4519 @cindex @code{//}
4520 @cindex C++ comments
4521 @cindex comments, C++ style
4523 In GNU C, you may use C++ style comments, which start with @samp{//} and
4524 continue until the end of the line.  Many other C implementations allow
4525 such comments, and they are included in the 1999 C standard.  However,
4526 C++ style comments are not recognized if you specify an @option{-std}
4527 option specifying a version of ISO C before C99, or @option{-ansi}
4528 (equivalent to @option{-std=c90}).
4530 @node Dollar Signs
4531 @section Dollar Signs in Identifier Names
4532 @cindex $
4533 @cindex dollar signs in identifier names
4534 @cindex identifier names, dollar signs in
4536 In GNU C, you may normally use dollar signs in identifier names.
4537 This is because many traditional C implementations allow such identifiers.
4538 However, dollar signs in identifiers are not supported on a few target
4539 machines, typically because the target assembler does not allow them.
4541 @node Character Escapes
4542 @section The Character @key{ESC} in Constants
4544 You can use the sequence @samp{\e} in a string or character constant to
4545 stand for the ASCII character @key{ESC}.
4547 @node Variable Attributes
4548 @section Specifying Attributes of Variables
4549 @cindex attribute of variables
4550 @cindex variable attributes
4552 The keyword @code{__attribute__} allows you to specify special
4553 attributes of variables or structure fields.  This keyword is followed
4554 by an attribute specification inside double parentheses.  Some
4555 attributes are currently defined generically for variables.
4556 Other attributes are defined for variables on particular target
4557 systems.  Other attributes are available for functions
4558 (@pxref{Function Attributes}) and for types (@pxref{Type Attributes}).
4559 Other front ends might define more attributes
4560 (@pxref{C++ Extensions,,Extensions to the C++ Language}).
4562 You may also specify attributes with @samp{__} preceding and following
4563 each keyword.  This allows you to use them in header files without
4564 being concerned about a possible macro of the same name.  For example,
4565 you may use @code{__aligned__} instead of @code{aligned}.
4567 @xref{Attribute Syntax}, for details of the exact syntax for using
4568 attributes.
4570 @table @code
4571 @cindex @code{aligned} attribute
4572 @item aligned (@var{alignment})
4573 This attribute specifies a minimum alignment for the variable or
4574 structure field, measured in bytes.  For example, the declaration:
4576 @smallexample
4577 int x __attribute__ ((aligned (16))) = 0;
4578 @end smallexample
4580 @noindent
4581 causes the compiler to allocate the global variable @code{x} on a
4582 16-byte boundary.  On a 68040, this could be used in conjunction with
4583 an @code{asm} expression to access the @code{move16} instruction which
4584 requires 16-byte aligned operands.
4586 You can also specify the alignment of structure fields.  For example, to
4587 create a double-word aligned @code{int} pair, you could write:
4589 @smallexample
4590 struct foo @{ int x[2] __attribute__ ((aligned (8))); @};
4591 @end smallexample
4593 @noindent
4594 This is an alternative to creating a union with a @code{double} member,
4595 which forces the union to be double-word aligned.
4597 As in the preceding examples, you can explicitly specify the alignment
4598 (in bytes) that you wish the compiler to use for a given variable or
4599 structure field.  Alternatively, you can leave out the alignment factor
4600 and just ask the compiler to align a variable or field to the
4601 default alignment for the target architecture you are compiling for.
4602 The default alignment is sufficient for all scalar types, but may not be
4603 enough for all vector types on a target that supports vector operations.
4604 The default alignment is fixed for a particular target ABI.
4606 GCC also provides a target specific macro @code{__BIGGEST_ALIGNMENT__},
4607 which is the largest alignment ever used for any data type on the
4608 target machine you are compiling for.  For example, you could write:
4610 @smallexample
4611 short array[3] __attribute__ ((aligned (__BIGGEST_ALIGNMENT__)));
4612 @end smallexample
4614 The compiler automatically sets the alignment for the declared
4615 variable or field to @code{__BIGGEST_ALIGNMENT__}.  Doing this can
4616 often make copy operations more efficient, because the compiler can
4617 use whatever instructions copy the biggest chunks of memory when
4618 performing copies to or from the variables or fields that you have
4619 aligned this way.  Note that the value of @code{__BIGGEST_ALIGNMENT__}
4620 may change depending on command-line options.
4622 When used on a struct, or struct member, the @code{aligned} attribute can
4623 only increase the alignment; in order to decrease it, the @code{packed}
4624 attribute must be specified as well.  When used as part of a typedef, the
4625 @code{aligned} attribute can both increase and decrease alignment, and
4626 specifying the @code{packed} attribute generates a warning.
4628 Note that the effectiveness of @code{aligned} attributes may be limited
4629 by inherent limitations in your linker.  On many systems, the linker is
4630 only able to arrange for variables to be aligned up to a certain maximum
4631 alignment.  (For some linkers, the maximum supported alignment may
4632 be very very small.)  If your linker is only able to align variables
4633 up to a maximum of 8-byte alignment, then specifying @code{aligned(16)}
4634 in an @code{__attribute__} still only provides you with 8-byte
4635 alignment.  See your linker documentation for further information.
4637 The @code{aligned} attribute can also be used for functions
4638 (@pxref{Function Attributes}.)
4640 @item cleanup (@var{cleanup_function})
4641 @cindex @code{cleanup} attribute
4642 The @code{cleanup} attribute runs a function when the variable goes
4643 out of scope.  This attribute can only be applied to auto function
4644 scope variables; it may not be applied to parameters or variables
4645 with static storage duration.  The function must take one parameter,
4646 a pointer to a type compatible with the variable.  The return value
4647 of the function (if any) is ignored.
4649 If @option{-fexceptions} is enabled, then @var{cleanup_function}
4650 is run during the stack unwinding that happens during the
4651 processing of the exception.  Note that the @code{cleanup} attribute
4652 does not allow the exception to be caught, only to perform an action.
4653 It is undefined what happens if @var{cleanup_function} does not
4654 return normally.
4656 @item common
4657 @itemx nocommon
4658 @cindex @code{common} attribute
4659 @cindex @code{nocommon} attribute
4660 @opindex fcommon
4661 @opindex fno-common
4662 The @code{common} attribute requests GCC to place a variable in
4663 ``common'' storage.  The @code{nocommon} attribute requests the
4664 opposite---to allocate space for it directly.
4666 These attributes override the default chosen by the
4667 @option{-fno-common} and @option{-fcommon} flags respectively.
4669 @item deprecated
4670 @itemx deprecated (@var{msg})
4671 @cindex @code{deprecated} attribute
4672 The @code{deprecated} attribute results in a warning if the variable
4673 is used anywhere in the source file.  This is useful when identifying
4674 variables that are expected to be removed in a future version of a
4675 program.  The warning also includes the location of the declaration
4676 of the deprecated variable, to enable users to easily find further
4677 information about why the variable is deprecated, or what they should
4678 do instead.  Note that the warning only occurs for uses:
4680 @smallexample
4681 extern int old_var __attribute__ ((deprecated));
4682 extern int old_var;
4683 int new_fn () @{ return old_var; @}
4684 @end smallexample
4686 @noindent
4687 results in a warning on line 3 but not line 2.  The optional @var{msg}
4688 argument, which must be a string, is printed in the warning if
4689 present.
4691 The @code{deprecated} attribute can also be used for functions and
4692 types (@pxref{Function Attributes}, @pxref{Type Attributes}.)
4694 @item mode (@var{mode})
4695 @cindex @code{mode} attribute
4696 This attribute specifies the data type for the declaration---whichever
4697 type corresponds to the mode @var{mode}.  This in effect lets you
4698 request an integer or floating-point type according to its width.
4700 You may also specify a mode of @code{byte} or @code{__byte__} to
4701 indicate the mode corresponding to a one-byte integer, @code{word} or
4702 @code{__word__} for the mode of a one-word integer, and @code{pointer}
4703 or @code{__pointer__} for the mode used to represent pointers.
4705 @item packed
4706 @cindex @code{packed} attribute
4707 The @code{packed} attribute specifies that a variable or structure field
4708 should have the smallest possible alignment---one byte for a variable,
4709 and one bit for a field, unless you specify a larger value with the
4710 @code{aligned} attribute.
4712 Here is a structure in which the field @code{x} is packed, so that it
4713 immediately follows @code{a}:
4715 @smallexample
4716 struct foo
4718   char a;
4719   int x[2] __attribute__ ((packed));
4721 @end smallexample
4723 @emph{Note:} The 4.1, 4.2 and 4.3 series of GCC ignore the
4724 @code{packed} attribute on bit-fields of type @code{char}.  This has
4725 been fixed in GCC 4.4 but the change can lead to differences in the
4726 structure layout.  See the documentation of
4727 @option{-Wpacked-bitfield-compat} for more information.
4729 @item section ("@var{section-name}")
4730 @cindex @code{section} variable attribute
4731 Normally, the compiler places the objects it generates in sections like
4732 @code{data} and @code{bss}.  Sometimes, however, you need additional sections,
4733 or you need certain particular variables to appear in special sections,
4734 for example to map to special hardware.  The @code{section}
4735 attribute specifies that a variable (or function) lives in a particular
4736 section.  For example, this small program uses several specific section names:
4738 @smallexample
4739 struct duart a __attribute__ ((section ("DUART_A"))) = @{ 0 @};
4740 struct duart b __attribute__ ((section ("DUART_B"))) = @{ 0 @};
4741 char stack[10000] __attribute__ ((section ("STACK"))) = @{ 0 @};
4742 int init_data __attribute__ ((section ("INITDATA")));
4744 main()
4746   /* @r{Initialize stack pointer} */
4747   init_sp (stack + sizeof (stack));
4749   /* @r{Initialize initialized data} */
4750   memcpy (&init_data, &data, &edata - &data);
4752   /* @r{Turn on the serial ports} */
4753   init_duart (&a);
4754   init_duart (&b);
4756 @end smallexample
4758 @noindent
4759 Use the @code{section} attribute with
4760 @emph{global} variables and not @emph{local} variables,
4761 as shown in the example.
4763 You may use the @code{section} attribute with initialized or
4764 uninitialized global variables but the linker requires
4765 each object be defined once, with the exception that uninitialized
4766 variables tentatively go in the @code{common} (or @code{bss}) section
4767 and can be multiply ``defined''.  Using the @code{section} attribute
4768 changes what section the variable goes into and may cause the
4769 linker to issue an error if an uninitialized variable has multiple
4770 definitions.  You can force a variable to be initialized with the
4771 @option{-fno-common} flag or the @code{nocommon} attribute.
4773 Some file formats do not support arbitrary sections so the @code{section}
4774 attribute is not available on all platforms.
4775 If you need to map the entire contents of a module to a particular
4776 section, consider using the facilities of the linker instead.
4778 @item shared
4779 @cindex @code{shared} variable attribute
4780 On Microsoft Windows, in addition to putting variable definitions in a named
4781 section, the section can also be shared among all running copies of an
4782 executable or DLL@.  For example, this small program defines shared data
4783 by putting it in a named section @code{shared} and marking the section
4784 shareable:
4786 @smallexample
4787 int foo __attribute__((section ("shared"), shared)) = 0;
4790 main()
4792   /* @r{Read and write foo.  All running
4793      copies see the same value.}  */
4794   return 0;
4796 @end smallexample
4798 @noindent
4799 You may only use the @code{shared} attribute along with @code{section}
4800 attribute with a fully-initialized global definition because of the way
4801 linkers work.  See @code{section} attribute for more information.
4803 The @code{shared} attribute is only available on Microsoft Windows@.
4805 @item tls_model ("@var{tls_model}")
4806 @cindex @code{tls_model} attribute
4807 The @code{tls_model} attribute sets thread-local storage model
4808 (@pxref{Thread-Local}) of a particular @code{__thread} variable,
4809 overriding @option{-ftls-model=} command-line switch on a per-variable
4810 basis.
4811 The @var{tls_model} argument should be one of @code{global-dynamic},
4812 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
4814 Not all targets support this attribute.
4816 @item unused
4817 This attribute, attached to a variable, means that the variable is meant
4818 to be possibly unused.  GCC does not produce a warning for this
4819 variable.
4821 @item used
4822 This attribute, attached to a variable, means that the variable must be
4823 emitted even if it appears that the variable is not referenced.
4825 When applied to a static data member of a C++ class template, the
4826 attribute also means that the member is instantiated if the
4827 class itself is instantiated.
4829 @item vector_size (@var{bytes})
4830 This attribute specifies the vector size for the variable, measured in
4831 bytes.  For example, the declaration:
4833 @smallexample
4834 int foo __attribute__ ((vector_size (16)));
4835 @end smallexample
4837 @noindent
4838 causes the compiler to set the mode for @code{foo}, to be 16 bytes,
4839 divided into @code{int} sized units.  Assuming a 32-bit int (a vector of
4840 4 units of 4 bytes), the corresponding mode of @code{foo} is V4SI@.
4842 This attribute is only applicable to integral and float scalars,
4843 although arrays, pointers, and function return values are allowed in
4844 conjunction with this construct.
4846 Aggregates with this attribute are invalid, even if they are of the same
4847 size as a corresponding scalar.  For example, the declaration:
4849 @smallexample
4850 struct S @{ int a; @};
4851 struct S  __attribute__ ((vector_size (16))) foo;
4852 @end smallexample
4854 @noindent
4855 is invalid even if the size of the structure is the same as the size of
4856 the @code{int}.
4858 @item selectany
4859 The @code{selectany} attribute causes an initialized global variable to
4860 have link-once semantics.  When multiple definitions of the variable are
4861 encountered by the linker, the first is selected and the remainder are
4862 discarded.  Following usage by the Microsoft compiler, the linker is told
4863 @emph{not} to warn about size or content differences of the multiple
4864 definitions.
4866 Although the primary usage of this attribute is for POD types, the
4867 attribute can also be applied to global C++ objects that are initialized
4868 by a constructor.  In this case, the static initialization and destruction
4869 code for the object is emitted in each translation defining the object,
4870 but the calls to the constructor and destructor are protected by a
4871 link-once guard variable.
4873 The @code{selectany} attribute is only available on Microsoft Windows
4874 targets.  You can use @code{__declspec (selectany)} as a synonym for
4875 @code{__attribute__ ((selectany))} for compatibility with other
4876 compilers.
4878 @item weak
4879 The @code{weak} attribute is described in @ref{Function Attributes}.
4881 @item dllimport
4882 The @code{dllimport} attribute is described in @ref{Function Attributes}.
4884 @item dllexport
4885 The @code{dllexport} attribute is described in @ref{Function Attributes}.
4887 @end table
4889 @anchor{AVR Variable Attributes}
4890 @subsection AVR Variable Attributes
4892 @table @code
4893 @item progmem
4894 @cindex @code{progmem} AVR variable attribute
4895 The @code{progmem} attribute is used on the AVR to place read-only
4896 data in the non-volatile program memory (flash). The @code{progmem}
4897 attribute accomplishes this by putting respective variables into a
4898 section whose name starts with @code{.progmem}.
4900 This attribute works similar to the @code{section} attribute
4901 but adds additional checking. Notice that just like the
4902 @code{section} attribute, @code{progmem} affects the location
4903 of the data but not how this data is accessed.
4905 In order to read data located with the @code{progmem} attribute
4906 (inline) assembler must be used.
4907 @smallexample
4908 /* Use custom macros from @w{@uref{http://nongnu.org/avr-libc/user-manual,AVR-LibC}} */
4909 #include <avr/pgmspace.h> 
4911 /* Locate var in flash memory */
4912 const int var[2] PROGMEM = @{ 1, 2 @};
4914 int read_var (int i)
4916     /* Access var[] by accessor macro from avr/pgmspace.h */
4917     return (int) pgm_read_word (& var[i]);
4919 @end smallexample
4921 AVR is a Harvard architecture processor and data and read-only data
4922 normally resides in the data memory (RAM).
4924 See also the @ref{AVR Named Address Spaces} section for
4925 an alternate way to locate and access data in flash memory.
4926 @end table
4928 @subsection Blackfin Variable Attributes
4930 Three attributes are currently defined for the Blackfin.
4932 @table @code
4933 @item l1_data
4934 @itemx l1_data_A
4935 @itemx l1_data_B
4936 @cindex @code{l1_data} variable attribute
4937 @cindex @code{l1_data_A} variable attribute
4938 @cindex @code{l1_data_B} variable attribute
4939 Use these attributes on the Blackfin to place the variable into L1 Data SRAM.
4940 Variables with @code{l1_data} attribute are put into the specific section
4941 named @code{.l1.data}. Those with @code{l1_data_A} attribute are put into
4942 the specific section named @code{.l1.data.A}. Those with @code{l1_data_B}
4943 attribute are put into the specific section named @code{.l1.data.B}.
4945 @item l2
4946 @cindex @code{l2} variable attribute
4947 Use this attribute on the Blackfin to place the variable into L2 SRAM.
4948 Variables with @code{l2} attribute are put into the specific section
4949 named @code{.l2.data}.
4950 @end table
4952 @subsection M32R/D Variable Attributes
4954 One attribute is currently defined for the M32R/D@.
4956 @table @code
4957 @item model (@var{model-name})
4958 @cindex variable addressability on the M32R/D
4959 Use this attribute on the M32R/D to set the addressability of an object.
4960 The identifier @var{model-name} is one of @code{small}, @code{medium},
4961 or @code{large}, representing each of the code models.
4963 Small model objects live in the lower 16MB of memory (so that their
4964 addresses can be loaded with the @code{ld24} instruction).
4966 Medium and large model objects may live anywhere in the 32-bit address space
4967 (the compiler generates @code{seth/add3} instructions to load their
4968 addresses).
4969 @end table
4971 @anchor{MeP Variable Attributes}
4972 @subsection MeP Variable Attributes
4974 The MeP target has a number of addressing modes and busses.  The
4975 @code{near} space spans the standard memory space's first 16 megabytes
4976 (24 bits).  The @code{far} space spans the entire 32-bit memory space.
4977 The @code{based} space is a 128-byte region in the memory space that
4978 is addressed relative to the @code{$tp} register.  The @code{tiny}
4979 space is a 65536-byte region relative to the @code{$gp} register.  In
4980 addition to these memory regions, the MeP target has a separate 16-bit
4981 control bus which is specified with @code{cb} attributes.
4983 @table @code
4985 @item based
4986 Any variable with the @code{based} attribute is assigned to the
4987 @code{.based} section, and is accessed with relative to the
4988 @code{$tp} register.
4990 @item tiny
4991 Likewise, the @code{tiny} attribute assigned variables to the
4992 @code{.tiny} section, relative to the @code{$gp} register.
4994 @item near
4995 Variables with the @code{near} attribute are assumed to have addresses
4996 that fit in a 24-bit addressing mode.  This is the default for large
4997 variables (@code{-mtiny=4} is the default) but this attribute can
4998 override @code{-mtiny=} for small variables, or override @code{-ml}.
5000 @item far
5001 Variables with the @code{far} attribute are addressed using a full
5002 32-bit address.  Since this covers the entire memory space, this
5003 allows modules to make no assumptions about where variables might be
5004 stored.
5006 @item io
5007 @itemx io (@var{addr})
5008 Variables with the @code{io} attribute are used to address
5009 memory-mapped peripherals.  If an address is specified, the variable
5010 is assigned that address, else it is not assigned an address (it is
5011 assumed some other module assigns an address).  Example:
5013 @smallexample
5014 int timer_count __attribute__((io(0x123)));
5015 @end smallexample
5017 @item cb
5018 @itemx cb (@var{addr})
5019 Variables with the @code{cb} attribute are used to access the control
5020 bus, using special instructions.  @code{addr} indicates the control bus
5021 address.  Example:
5023 @smallexample
5024 int cpu_clock __attribute__((cb(0x123)));
5025 @end smallexample
5027 @end table
5029 @anchor{i386 Variable Attributes}
5030 @subsection i386 Variable Attributes
5032 Two attributes are currently defined for i386 configurations:
5033 @code{ms_struct} and @code{gcc_struct}
5035 @table @code
5036 @item ms_struct
5037 @itemx gcc_struct
5038 @cindex @code{ms_struct} attribute
5039 @cindex @code{gcc_struct} attribute
5041 If @code{packed} is used on a structure, or if bit-fields are used,
5042 it may be that the Microsoft ABI lays out the structure differently
5043 than the way GCC normally does.  Particularly when moving packed
5044 data between functions compiled with GCC and the native Microsoft compiler
5045 (either via function call or as data in a file), it may be necessary to access
5046 either format.
5048 Currently @option{-m[no-]ms-bitfields} is provided for the Microsoft Windows X86
5049 compilers to match the native Microsoft compiler.
5051 The Microsoft structure layout algorithm is fairly simple with the exception
5052 of the bit-field packing.  
5053 The padding and alignment of members of structures and whether a bit-field 
5054 can straddle a storage-unit boundary are determine by these rules:
5056 @enumerate
5057 @item Structure members are stored sequentially in the order in which they are
5058 declared: the first member has the lowest memory address and the last member
5059 the highest.
5061 @item Every data object has an alignment requirement.  The alignment requirement
5062 for all data except structures, unions, and arrays is either the size of the
5063 object or the current packing size (specified with either the
5064 @code{aligned} attribute or the @code{pack} pragma),
5065 whichever is less.  For structures, unions, and arrays,
5066 the alignment requirement is the largest alignment requirement of its members.
5067 Every object is allocated an offset so that:
5069 @smallexample
5070 offset % alignment_requirement == 0
5071 @end smallexample
5073 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
5074 unit if the integral types are the same size and if the next bit-field fits
5075 into the current allocation unit without crossing the boundary imposed by the
5076 common alignment requirements of the bit-fields.
5077 @end enumerate
5079 MSVC interprets zero-length bit-fields in the following ways:
5081 @enumerate
5082 @item If a zero-length bit-field is inserted between two bit-fields that
5083 are normally coalesced, the bit-fields are not coalesced.
5085 For example:
5087 @smallexample
5088 struct
5089  @{
5090    unsigned long bf_1 : 12;
5091    unsigned long : 0;
5092    unsigned long bf_2 : 12;
5093  @} t1;
5094 @end smallexample
5096 @noindent
5097 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
5098 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
5100 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
5101 alignment of the zero-length bit-field is greater than the member that follows it,
5102 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
5104 For example:
5106 @smallexample
5107 struct
5108  @{
5109    char foo : 4;
5110    short : 0;
5111    char bar;
5112  @} t2;
5114 struct
5115  @{
5116    char foo : 4;
5117    short : 0;
5118    double bar;
5119  @} t3;
5120 @end smallexample
5122 @noindent
5123 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
5124 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
5125 bit-field does not affect the alignment of @code{bar} or, as a result, the size
5126 of the structure.
5128 Taking this into account, it is important to note the following:
5130 @enumerate
5131 @item If a zero-length bit-field follows a normal bit-field, the type of the
5132 zero-length bit-field may affect the alignment of the structure as whole. For
5133 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
5134 normal bit-field, and is of type short.
5136 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
5137 still affect the alignment of the structure:
5139 @smallexample
5140 struct
5141  @{
5142    char foo : 6;
5143    long : 0;
5144  @} t4;
5145 @end smallexample
5147 @noindent
5148 Here, @code{t4} takes up 4 bytes.
5149 @end enumerate
5151 @item Zero-length bit-fields following non-bit-field members are ignored:
5153 @smallexample
5154 struct
5155  @{
5156    char foo;
5157    long : 0;
5158    char bar;
5159  @} t5;
5160 @end smallexample
5162 @noindent
5163 Here, @code{t5} takes up 2 bytes.
5164 @end enumerate
5165 @end table
5167 @subsection PowerPC Variable Attributes
5169 Three attributes currently are defined for PowerPC configurations:
5170 @code{altivec}, @code{ms_struct} and @code{gcc_struct}.
5172 For full documentation of the struct attributes please see the
5173 documentation in @ref{i386 Variable Attributes}.
5175 For documentation of @code{altivec} attribute please see the
5176 documentation in @ref{PowerPC Type Attributes}.
5178 @subsection SPU Variable Attributes
5180 The SPU supports the @code{spu_vector} attribute for variables.  For
5181 documentation of this attribute please see the documentation in
5182 @ref{SPU Type Attributes}.
5184 @subsection Xstormy16 Variable Attributes
5186 One attribute is currently defined for xstormy16 configurations:
5187 @code{below100}.
5189 @table @code
5190 @item below100
5191 @cindex @code{below100} attribute
5193 If a variable has the @code{below100} attribute (@code{BELOW100} is
5194 allowed also), GCC places the variable in the first 0x100 bytes of
5195 memory and use special opcodes to access it.  Such variables are
5196 placed in either the @code{.bss_below100} section or the
5197 @code{.data_below100} section.
5199 @end table
5201 @node Type Attributes
5202 @section Specifying Attributes of Types
5203 @cindex attribute of types
5204 @cindex type attributes
5206 The keyword @code{__attribute__} allows you to specify special
5207 attributes of @code{struct} and @code{union} types when you define
5208 such types.  This keyword is followed by an attribute specification
5209 inside double parentheses.  Seven attributes are currently defined for
5210 types: @code{aligned}, @code{packed}, @code{transparent_union},
5211 @code{unused}, @code{deprecated}, @code{visibility}, and
5212 @code{may_alias}.  Other attributes are defined for functions
5213 (@pxref{Function Attributes}) and for variables (@pxref{Variable
5214 Attributes}).
5216 You may also specify any one of these attributes with @samp{__}
5217 preceding and following its keyword.  This allows you to use these
5218 attributes in header files without being concerned about a possible
5219 macro of the same name.  For example, you may use @code{__aligned__}
5220 instead of @code{aligned}.
5222 You may specify type attributes in an enum, struct or union type
5223 declaration or definition, or for other types in a @code{typedef}
5224 declaration.
5226 For an enum, struct or union type, you may specify attributes either
5227 between the enum, struct or union tag and the name of the type, or
5228 just past the closing curly brace of the @emph{definition}.  The
5229 former syntax is preferred.
5231 @xref{Attribute Syntax}, for details of the exact syntax for using
5232 attributes.
5234 @table @code
5235 @cindex @code{aligned} attribute
5236 @item aligned (@var{alignment})
5237 This attribute specifies a minimum alignment (in bytes) for variables
5238 of the specified type.  For example, the declarations:
5240 @smallexample
5241 struct S @{ short f[3]; @} __attribute__ ((aligned (8)));
5242 typedef int more_aligned_int __attribute__ ((aligned (8)));
5243 @end smallexample
5245 @noindent
5246 force the compiler to ensure (as far as it can) that each variable whose
5247 type is @code{struct S} or @code{more_aligned_int} is allocated and
5248 aligned @emph{at least} on a 8-byte boundary.  On a SPARC, having all
5249 variables of type @code{struct S} aligned to 8-byte boundaries allows
5250 the compiler to use the @code{ldd} and @code{std} (doubleword load and
5251 store) instructions when copying one variable of type @code{struct S} to
5252 another, thus improving run-time efficiency.
5254 Note that the alignment of any given @code{struct} or @code{union} type
5255 is required by the ISO C standard to be at least a perfect multiple of
5256 the lowest common multiple of the alignments of all of the members of
5257 the @code{struct} or @code{union} in question.  This means that you @emph{can}
5258 effectively adjust the alignment of a @code{struct} or @code{union}
5259 type by attaching an @code{aligned} attribute to any one of the members
5260 of such a type, but the notation illustrated in the example above is a
5261 more obvious, intuitive, and readable way to request the compiler to
5262 adjust the alignment of an entire @code{struct} or @code{union} type.
5264 As in the preceding example, you can explicitly specify the alignment
5265 (in bytes) that you wish the compiler to use for a given @code{struct}
5266 or @code{union} type.  Alternatively, you can leave out the alignment factor
5267 and just ask the compiler to align a type to the maximum
5268 useful alignment for the target machine you are compiling for.  For
5269 example, you could write:
5271 @smallexample
5272 struct S @{ short f[3]; @} __attribute__ ((aligned));
5273 @end smallexample
5275 Whenever you leave out the alignment factor in an @code{aligned}
5276 attribute specification, the compiler automatically sets the alignment
5277 for the type to the largest alignment that is ever used for any data
5278 type on the target machine you are compiling for.  Doing this can often
5279 make copy operations more efficient, because the compiler can use
5280 whatever instructions copy the biggest chunks of memory when performing
5281 copies to or from the variables that have types that you have aligned
5282 this way.
5284 In the example above, if the size of each @code{short} is 2 bytes, then
5285 the size of the entire @code{struct S} type is 6 bytes.  The smallest
5286 power of two that is greater than or equal to that is 8, so the
5287 compiler sets the alignment for the entire @code{struct S} type to 8
5288 bytes.
5290 Note that although you can ask the compiler to select a time-efficient
5291 alignment for a given type and then declare only individual stand-alone
5292 objects of that type, the compiler's ability to select a time-efficient
5293 alignment is primarily useful only when you plan to create arrays of
5294 variables having the relevant (efficiently aligned) type.  If you
5295 declare or use arrays of variables of an efficiently-aligned type, then
5296 it is likely that your program also does pointer arithmetic (or
5297 subscripting, which amounts to the same thing) on pointers to the
5298 relevant type, and the code that the compiler generates for these
5299 pointer arithmetic operations is often more efficient for
5300 efficiently-aligned types than for other types.
5302 The @code{aligned} attribute can only increase the alignment; but you
5303 can decrease it by specifying @code{packed} as well.  See below.
5305 Note that the effectiveness of @code{aligned} attributes may be limited
5306 by inherent limitations in your linker.  On many systems, the linker is
5307 only able to arrange for variables to be aligned up to a certain maximum
5308 alignment.  (For some linkers, the maximum supported alignment may
5309 be very very small.)  If your linker is only able to align variables
5310 up to a maximum of 8-byte alignment, then specifying @code{aligned(16)}
5311 in an @code{__attribute__} still only provides you with 8-byte
5312 alignment.  See your linker documentation for further information.
5314 @item packed
5315 This attribute, attached to @code{struct} or @code{union} type
5316 definition, specifies that each member (other than zero-width bit-fields)
5317 of the structure or union is placed to minimize the memory required.  When
5318 attached to an @code{enum} definition, it indicates that the smallest
5319 integral type should be used.
5321 @opindex fshort-enums
5322 Specifying this attribute for @code{struct} and @code{union} types is
5323 equivalent to specifying the @code{packed} attribute on each of the
5324 structure or union members.  Specifying the @option{-fshort-enums}
5325 flag on the line is equivalent to specifying the @code{packed}
5326 attribute on all @code{enum} definitions.
5328 In the following example @code{struct my_packed_struct}'s members are
5329 packed closely together, but the internal layout of its @code{s} member
5330 is not packed---to do that, @code{struct my_unpacked_struct} needs to
5331 be packed too.
5333 @smallexample
5334 struct my_unpacked_struct
5335  @{
5336     char c;
5337     int i;
5338  @};
5340 struct __attribute__ ((__packed__)) my_packed_struct
5341   @{
5342      char c;
5343      int  i;
5344      struct my_unpacked_struct s;
5345   @};
5346 @end smallexample
5348 You may only specify this attribute on the definition of an @code{enum},
5349 @code{struct} or @code{union}, not on a @code{typedef} that does not
5350 also define the enumerated type, structure or union.
5352 @item transparent_union
5353 This attribute, attached to a @code{union} type definition, indicates
5354 that any function parameter having that union type causes calls to that
5355 function to be treated in a special way.
5357 First, the argument corresponding to a transparent union type can be of
5358 any type in the union; no cast is required.  Also, if the union contains
5359 a pointer type, the corresponding argument can be a null pointer
5360 constant or a void pointer expression; and if the union contains a void
5361 pointer type, the corresponding argument can be any pointer expression.
5362 If the union member type is a pointer, qualifiers like @code{const} on
5363 the referenced type must be respected, just as with normal pointer
5364 conversions.
5366 Second, the argument is passed to the function using the calling
5367 conventions of the first member of the transparent union, not the calling
5368 conventions of the union itself.  All members of the union must have the
5369 same machine representation; this is necessary for this argument passing
5370 to work properly.
5372 Transparent unions are designed for library functions that have multiple
5373 interfaces for compatibility reasons.  For example, suppose the
5374 @code{wait} function must accept either a value of type @code{int *} to
5375 comply with POSIX, or a value of type @code{union wait *} to comply with
5376 the 4.1BSD interface.  If @code{wait}'s parameter were @code{void *},
5377 @code{wait} would accept both kinds of arguments, but it would also
5378 accept any other pointer type and this would make argument type checking
5379 less useful.  Instead, @code{<sys/wait.h>} might define the interface
5380 as follows:
5382 @smallexample
5383 typedef union __attribute__ ((__transparent_union__))
5384   @{
5385     int *__ip;
5386     union wait *__up;
5387   @} wait_status_ptr_t;
5389 pid_t wait (wait_status_ptr_t);
5390 @end smallexample
5392 @noindent
5393 This interface allows either @code{int *} or @code{union wait *}
5394 arguments to be passed, using the @code{int *} calling convention.
5395 The program can call @code{wait} with arguments of either type:
5397 @smallexample
5398 int w1 () @{ int w; return wait (&w); @}
5399 int w2 () @{ union wait w; return wait (&w); @}
5400 @end smallexample
5402 @noindent
5403 With this interface, @code{wait}'s implementation might look like this:
5405 @smallexample
5406 pid_t wait (wait_status_ptr_t p)
5408   return waitpid (-1, p.__ip, 0);
5410 @end smallexample
5412 @item unused
5413 When attached to a type (including a @code{union} or a @code{struct}),
5414 this attribute means that variables of that type are meant to appear
5415 possibly unused.  GCC does not produce a warning for any variables of
5416 that type, even if the variable appears to do nothing.  This is often
5417 the case with lock or thread classes, which are usually defined and then
5418 not referenced, but contain constructors and destructors that have
5419 nontrivial bookkeeping functions.
5421 @item deprecated
5422 @itemx deprecated (@var{msg})
5423 The @code{deprecated} attribute results in a warning if the type
5424 is used anywhere in the source file.  This is useful when identifying
5425 types that are expected to be removed in a future version of a program.
5426 If possible, the warning also includes the location of the declaration
5427 of the deprecated type, to enable users to easily find further
5428 information about why the type is deprecated, or what they should do
5429 instead.  Note that the warnings only occur for uses and then only
5430 if the type is being applied to an identifier that itself is not being
5431 declared as deprecated.
5433 @smallexample
5434 typedef int T1 __attribute__ ((deprecated));
5435 T1 x;
5436 typedef T1 T2;
5437 T2 y;
5438 typedef T1 T3 __attribute__ ((deprecated));
5439 T3 z __attribute__ ((deprecated));
5440 @end smallexample
5442 @noindent
5443 results in a warning on line 2 and 3 but not lines 4, 5, or 6.  No
5444 warning is issued for line 4 because T2 is not explicitly
5445 deprecated.  Line 5 has no warning because T3 is explicitly
5446 deprecated.  Similarly for line 6.  The optional @var{msg}
5447 argument, which must be a string, is printed in the warning if
5448 present.
5450 The @code{deprecated} attribute can also be used for functions and
5451 variables (@pxref{Function Attributes}, @pxref{Variable Attributes}.)
5453 @item may_alias
5454 Accesses through pointers to types with this attribute are not subject
5455 to type-based alias analysis, but are instead assumed to be able to alias
5456 any other type of objects.
5457 In the context of section 6.5 paragraph 7 of the C99 standard,
5458 an lvalue expression
5459 dereferencing such a pointer is treated like having a character type.
5460 See @option{-fstrict-aliasing} for more information on aliasing issues.
5461 This extension exists to support some vector APIs, in which pointers to
5462 one vector type are permitted to alias pointers to a different vector type.
5464 Note that an object of a type with this attribute does not have any
5465 special semantics.
5467 Example of use:
5469 @smallexample
5470 typedef short __attribute__((__may_alias__)) short_a;
5473 main (void)
5475   int a = 0x12345678;
5476   short_a *b = (short_a *) &a;
5478   b[1] = 0;
5480   if (a == 0x12345678)
5481     abort();
5483   exit(0);
5485 @end smallexample
5487 @noindent
5488 If you replaced @code{short_a} with @code{short} in the variable
5489 declaration, the above program would abort when compiled with
5490 @option{-fstrict-aliasing}, which is on by default at @option{-O2} or
5491 above in recent GCC versions.
5493 @item visibility
5494 In C++, attribute visibility (@pxref{Function Attributes}) can also be
5495 applied to class, struct, union and enum types.  Unlike other type
5496 attributes, the attribute must appear between the initial keyword and
5497 the name of the type; it cannot appear after the body of the type.
5499 Note that the type visibility is applied to vague linkage entities
5500 associated with the class (vtable, typeinfo node, etc.).  In
5501 particular, if a class is thrown as an exception in one shared object
5502 and caught in another, the class must have default visibility.
5503 Otherwise the two shared objects are unable to use the same
5504 typeinfo node and exception handling will break.
5506 @end table
5508 To specify multiple attributes, separate them by commas within the
5509 double parentheses: for example, @samp{__attribute__ ((aligned (16),
5510 packed))}.
5512 @subsection ARM Type Attributes
5514 On those ARM targets that support @code{dllimport} (such as Symbian
5515 OS), you can use the @code{notshared} attribute to indicate that the
5516 virtual table and other similar data for a class should not be
5517 exported from a DLL@.  For example:
5519 @smallexample
5520 class __declspec(notshared) C @{
5521 public:
5522   __declspec(dllimport) C();
5523   virtual void f();
5526 __declspec(dllexport)
5527 C::C() @{@}
5528 @end smallexample
5530 @noindent
5531 In this code, @code{C::C} is exported from the current DLL, but the
5532 virtual table for @code{C} is not exported.  (You can use
5533 @code{__attribute__} instead of @code{__declspec} if you prefer, but
5534 most Symbian OS code uses @code{__declspec}.)
5536 @anchor{MeP Type Attributes}
5537 @subsection MeP Type Attributes
5539 Many of the MeP variable attributes may be applied to types as well.
5540 Specifically, the @code{based}, @code{tiny}, @code{near}, and
5541 @code{far} attributes may be applied to either.  The @code{io} and
5542 @code{cb} attributes may not be applied to types.
5544 @anchor{i386 Type Attributes}
5545 @subsection i386 Type Attributes
5547 Two attributes are currently defined for i386 configurations:
5548 @code{ms_struct} and @code{gcc_struct}.
5550 @table @code
5552 @item ms_struct
5553 @itemx gcc_struct
5554 @cindex @code{ms_struct}
5555 @cindex @code{gcc_struct}
5557 If @code{packed} is used on a structure, or if bit-fields are used
5558 it may be that the Microsoft ABI packs them differently
5559 than GCC normally packs them.  Particularly when moving packed
5560 data between functions compiled with GCC and the native Microsoft compiler
5561 (either via function call or as data in a file), it may be necessary to access
5562 either format.
5564 Currently @option{-m[no-]ms-bitfields} is provided for the Microsoft Windows X86
5565 compilers to match the native Microsoft compiler.
5566 @end table
5568 @anchor{PowerPC Type Attributes}
5569 @subsection PowerPC Type Attributes
5571 Three attributes currently are defined for PowerPC configurations:
5572 @code{altivec}, @code{ms_struct} and @code{gcc_struct}.
5574 For full documentation of the @code{ms_struct} and @code{gcc_struct}
5575 attributes please see the documentation in @ref{i386 Type Attributes}.
5577 The @code{altivec} attribute allows one to declare AltiVec vector data
5578 types supported by the AltiVec Programming Interface Manual.  The
5579 attribute requires an argument to specify one of three vector types:
5580 @code{vector__}, @code{pixel__} (always followed by unsigned short),
5581 and @code{bool__} (always followed by unsigned).
5583 @smallexample
5584 __attribute__((altivec(vector__)))
5585 __attribute__((altivec(pixel__))) unsigned short
5586 __attribute__((altivec(bool__))) unsigned
5587 @end smallexample
5589 These attributes mainly are intended to support the @code{__vector},
5590 @code{__pixel}, and @code{__bool} AltiVec keywords.
5592 @anchor{SPU Type Attributes}
5593 @subsection SPU Type Attributes
5595 The SPU supports the @code{spu_vector} attribute for types.  This attribute
5596 allows one to declare vector data types supported by the Sony/Toshiba/IBM SPU
5597 Language Extensions Specification.  It is intended to support the
5598 @code{__vector} keyword.
5600 @node Alignment
5601 @section Inquiring on Alignment of Types or Variables
5602 @cindex alignment
5603 @cindex type alignment
5604 @cindex variable alignment
5606 The keyword @code{__alignof__} allows you to inquire about how an object
5607 is aligned, or the minimum alignment usually required by a type.  Its
5608 syntax is just like @code{sizeof}.
5610 For example, if the target machine requires a @code{double} value to be
5611 aligned on an 8-byte boundary, then @code{__alignof__ (double)} is 8.
5612 This is true on many RISC machines.  On more traditional machine
5613 designs, @code{__alignof__ (double)} is 4 or even 2.
5615 Some machines never actually require alignment; they allow reference to any
5616 data type even at an odd address.  For these machines, @code{__alignof__}
5617 reports the smallest alignment that GCC gives the data type, usually as
5618 mandated by the target ABI.
5620 If the operand of @code{__alignof__} is an lvalue rather than a type,
5621 its value is the required alignment for its type, taking into account
5622 any minimum alignment specified with GCC's @code{__attribute__}
5623 extension (@pxref{Variable Attributes}).  For example, after this
5624 declaration:
5626 @smallexample
5627 struct foo @{ int x; char y; @} foo1;
5628 @end smallexample
5630 @noindent
5631 the value of @code{__alignof__ (foo1.y)} is 1, even though its actual
5632 alignment is probably 2 or 4, the same as @code{__alignof__ (int)}.
5634 It is an error to ask for the alignment of an incomplete type.
5637 @node Inline
5638 @section An Inline Function is As Fast As a Macro
5639 @cindex inline functions
5640 @cindex integrating function code
5641 @cindex open coding
5642 @cindex macros, inline alternative
5644 By declaring a function inline, you can direct GCC to make
5645 calls to that function faster.  One way GCC can achieve this is to
5646 integrate that function's code into the code for its callers.  This
5647 makes execution faster by eliminating the function-call overhead; in
5648 addition, if any of the actual argument values are constant, their
5649 known values may permit simplifications at compile time so that not
5650 all of the inline function's code needs to be included.  The effect on
5651 code size is less predictable; object code may be larger or smaller
5652 with function inlining, depending on the particular case.  You can
5653 also direct GCC to try to integrate all ``simple enough'' functions
5654 into their callers with the option @option{-finline-functions}.
5656 GCC implements three different semantics of declaring a function
5657 inline.  One is available with @option{-std=gnu89} or
5658 @option{-fgnu89-inline} or when @code{gnu_inline} attribute is present
5659 on all inline declarations, another when
5660 @option{-std=c99}, @option{-std=c11},
5661 @option{-std=gnu99} or @option{-std=gnu11}
5662 (without @option{-fgnu89-inline}), and the third
5663 is used when compiling C++.
5665 To declare a function inline, use the @code{inline} keyword in its
5666 declaration, like this:
5668 @smallexample
5669 static inline int
5670 inc (int *a)
5672   return (*a)++;
5674 @end smallexample
5676 If you are writing a header file to be included in ISO C90 programs, write
5677 @code{__inline__} instead of @code{inline}.  @xref{Alternate Keywords}.
5679 The three types of inlining behave similarly in two important cases:
5680 when the @code{inline} keyword is used on a @code{static} function,
5681 like the example above, and when a function is first declared without
5682 using the @code{inline} keyword and then is defined with
5683 @code{inline}, like this:
5685 @smallexample
5686 extern int inc (int *a);
5687 inline int
5688 inc (int *a)
5690   return (*a)++;
5692 @end smallexample
5694 In both of these common cases, the program behaves the same as if you
5695 had not used the @code{inline} keyword, except for its speed.
5697 @cindex inline functions, omission of
5698 @opindex fkeep-inline-functions
5699 When a function is both inline and @code{static}, if all calls to the
5700 function are integrated into the caller, and the function's address is
5701 never used, then the function's own assembler code is never referenced.
5702 In this case, GCC does not actually output assembler code for the
5703 function, unless you specify the option @option{-fkeep-inline-functions}.
5704 Some calls cannot be integrated for various reasons (in particular,
5705 calls that precede the function's definition cannot be integrated, and
5706 neither can recursive calls within the definition).  If there is a
5707 nonintegrated call, then the function is compiled to assembler code as
5708 usual.  The function must also be compiled as usual if the program
5709 refers to its address, because that can't be inlined.
5711 @opindex Winline
5712 Note that certain usages in a function definition can make it unsuitable
5713 for inline substitution.  Among these usages are: variadic functions, use of
5714 @code{alloca}, use of variable-length data types (@pxref{Variable Length}),
5715 use of computed goto (@pxref{Labels as Values}), use of nonlocal goto,
5716 and nested functions (@pxref{Nested Functions}).  Using @option{-Winline}
5717 warns when a function marked @code{inline} could not be substituted,
5718 and gives the reason for the failure.
5720 @cindex automatic @code{inline} for C++ member fns
5721 @cindex @code{inline} automatic for C++ member fns
5722 @cindex member fns, automatically @code{inline}
5723 @cindex C++ member fns, automatically @code{inline}
5724 @opindex fno-default-inline
5725 As required by ISO C++, GCC considers member functions defined within
5726 the body of a class to be marked inline even if they are
5727 not explicitly declared with the @code{inline} keyword.  You can
5728 override this with @option{-fno-default-inline}; @pxref{C++ Dialect
5729 Options,,Options Controlling C++ Dialect}.
5731 GCC does not inline any functions when not optimizing unless you specify
5732 the @samp{always_inline} attribute for the function, like this:
5734 @smallexample
5735 /* @r{Prototype.}  */
5736 inline void foo (const char) __attribute__((always_inline));
5737 @end smallexample
5739 The remainder of this section is specific to GNU C90 inlining.
5741 @cindex non-static inline function
5742 When an inline function is not @code{static}, then the compiler must assume
5743 that there may be calls from other source files; since a global symbol can
5744 be defined only once in any program, the function must not be defined in
5745 the other source files, so the calls therein cannot be integrated.
5746 Therefore, a non-@code{static} inline function is always compiled on its
5747 own in the usual fashion.
5749 If you specify both @code{inline} and @code{extern} in the function
5750 definition, then the definition is used only for inlining.  In no case
5751 is the function compiled on its own, not even if you refer to its
5752 address explicitly.  Such an address becomes an external reference, as
5753 if you had only declared the function, and had not defined it.
5755 This combination of @code{inline} and @code{extern} has almost the
5756 effect of a macro.  The way to use it is to put a function definition in
5757 a header file with these keywords, and put another copy of the
5758 definition (lacking @code{inline} and @code{extern}) in a library file.
5759 The definition in the header file causes most calls to the function
5760 to be inlined.  If any uses of the function remain, they refer to
5761 the single copy in the library.
5763 @node Volatiles
5764 @section When is a Volatile Object Accessed?
5765 @cindex accessing volatiles
5766 @cindex volatile read
5767 @cindex volatile write
5768 @cindex volatile access
5770 C has the concept of volatile objects.  These are normally accessed by
5771 pointers and used for accessing hardware or inter-thread
5772 communication.  The standard encourages compilers to refrain from
5773 optimizations concerning accesses to volatile objects, but leaves it
5774 implementation defined as to what constitutes a volatile access.  The
5775 minimum requirement is that at a sequence point all previous accesses
5776 to volatile objects have stabilized and no subsequent accesses have
5777 occurred.  Thus an implementation is free to reorder and combine
5778 volatile accesses that occur between sequence points, but cannot do
5779 so for accesses across a sequence point.  The use of volatile does
5780 not allow you to violate the restriction on updating objects multiple
5781 times between two sequence points.
5783 Accesses to non-volatile objects are not ordered with respect to
5784 volatile accesses.  You cannot use a volatile object as a memory
5785 barrier to order a sequence of writes to non-volatile memory.  For
5786 instance:
5788 @smallexample
5789 int *ptr = @var{something};
5790 volatile int vobj;
5791 *ptr = @var{something};
5792 vobj = 1;
5793 @end smallexample
5795 @noindent
5796 Unless @var{*ptr} and @var{vobj} can be aliased, it is not guaranteed
5797 that the write to @var{*ptr} occurs by the time the update
5798 of @var{vobj} happens.  If you need this guarantee, you must use
5799 a stronger memory barrier such as:
5801 @smallexample
5802 int *ptr = @var{something};
5803 volatile int vobj;
5804 *ptr = @var{something};
5805 asm volatile ("" : : : "memory");
5806 vobj = 1;
5807 @end smallexample
5809 A scalar volatile object is read when it is accessed in a void context:
5811 @smallexample
5812 volatile int *src = @var{somevalue};
5813 *src;
5814 @end smallexample
5816 Such expressions are rvalues, and GCC implements this as a
5817 read of the volatile object being pointed to.
5819 Assignments are also expressions and have an rvalue.  However when
5820 assigning to a scalar volatile, the volatile object is not reread,
5821 regardless of whether the assignment expression's rvalue is used or
5822 not.  If the assignment's rvalue is used, the value is that assigned
5823 to the volatile object.  For instance, there is no read of @var{vobj}
5824 in all the following cases:
5826 @smallexample
5827 int obj;
5828 volatile int vobj;
5829 vobj = @var{something};
5830 obj = vobj = @var{something};
5831 obj ? vobj = @var{onething} : vobj = @var{anotherthing};
5832 obj = (@var{something}, vobj = @var{anotherthing});
5833 @end smallexample
5835 If you need to read the volatile object after an assignment has
5836 occurred, you must use a separate expression with an intervening
5837 sequence point.
5839 As bit-fields are not individually addressable, volatile bit-fields may
5840 be implicitly read when written to, or when adjacent bit-fields are
5841 accessed.  Bit-field operations may be optimized such that adjacent
5842 bit-fields are only partially accessed, if they straddle a storage unit
5843 boundary.  For these reasons it is unwise to use volatile bit-fields to
5844 access hardware.
5846 @node Extended Asm
5847 @section Assembler Instructions with C Expression Operands
5848 @cindex extended @code{asm}
5849 @cindex @code{asm} expressions
5850 @cindex assembler instructions
5851 @cindex registers
5853 In an assembler instruction using @code{asm}, you can specify the
5854 operands of the instruction using C expressions.  This means you need not
5855 guess which registers or memory locations contain the data you want
5856 to use.
5858 You must specify an assembler instruction template much like what
5859 appears in a machine description, plus an operand constraint string for
5860 each operand.
5862 For example, here is how to use the 68881's @code{fsinx} instruction:
5864 @smallexample
5865 asm ("fsinx %1,%0" : "=f" (result) : "f" (angle));
5866 @end smallexample
5868 @noindent
5869 Here @code{angle} is the C expression for the input operand while
5870 @code{result} is that of the output operand.  Each has @samp{"f"} as its
5871 operand constraint, saying that a floating-point register is required.
5872 The @samp{=} in @samp{=f} indicates that the operand is an output; all
5873 output operands' constraints must use @samp{=}.  The constraints use the
5874 same language used in the machine description (@pxref{Constraints}).
5876 Each operand is described by an operand-constraint string followed by
5877 the C expression in parentheses.  A colon separates the assembler
5878 template from the first output operand and another separates the last
5879 output operand from the first input, if any.  Commas separate the
5880 operands within each group.  The total number of operands is currently
5881 limited to 30; this limitation may be lifted in some future version of
5882 GCC@.
5884 If there are no output operands but there are input operands, you must
5885 place two consecutive colons surrounding the place where the output
5886 operands would go.
5888 As of GCC version 3.1, it is also possible to specify input and output
5889 operands using symbolic names which can be referenced within the
5890 assembler code.  These names are specified inside square brackets
5891 preceding the constraint string, and can be referenced inside the
5892 assembler code using @code{%[@var{name}]} instead of a percentage sign
5893 followed by the operand number.  Using named operands the above example
5894 could look like:
5896 @smallexample
5897 asm ("fsinx %[angle],%[output]"
5898      : [output] "=f" (result)
5899      : [angle] "f" (angle));
5900 @end smallexample
5902 @noindent
5903 Note that the symbolic operand names have no relation whatsoever to
5904 other C identifiers.  You may use any name you like, even those of
5905 existing C symbols, but you must ensure that no two operands within the same
5906 assembler construct use the same symbolic name.
5908 Output operand expressions must be lvalues; the compiler can check this.
5909 The input operands need not be lvalues.  The compiler cannot check
5910 whether the operands have data types that are reasonable for the
5911 instruction being executed.  It does not parse the assembler instruction
5912 template and does not know what it means or even whether it is valid
5913 assembler input.  The extended @code{asm} feature is most often used for
5914 machine instructions the compiler itself does not know exist.  If
5915 the output expression cannot be directly addressed (for example, it is a
5916 bit-field), your constraint must allow a register.  In that case, GCC
5917 uses the register as the output of the @code{asm}, and then stores
5918 that register into the output.
5920 The ordinary output operands must be write-only; GCC assumes that
5921 the values in these operands before the instruction are dead and need
5922 not be generated.  Extended asm supports input-output or read-write
5923 operands.  Use the constraint character @samp{+} to indicate such an
5924 operand and list it with the output operands.
5926 You may, as an alternative, logically split its function into two
5927 separate operands, one input operand and one write-only output
5928 operand.  The connection between them is expressed by constraints
5929 that say they need to be in the same location when the instruction
5930 executes.  You can use the same C expression for both operands, or
5931 different expressions.  For example, here we write the (fictitious)
5932 @samp{combine} instruction with @code{bar} as its read-only source
5933 operand and @code{foo} as its read-write destination:
5935 @smallexample
5936 asm ("combine %2,%0" : "=r" (foo) : "0" (foo), "g" (bar));
5937 @end smallexample
5939 @noindent
5940 The constraint @samp{"0"} for operand 1 says that it must occupy the
5941 same location as operand 0.  A number in constraint is allowed only in
5942 an input operand and it must refer to an output operand.
5944 Only a number in the constraint can guarantee that one operand is in
5945 the same place as another.  The mere fact that @code{foo} is the value
5946 of both operands is not enough to guarantee that they are in the
5947 same place in the generated assembler code.  The following does not
5948 work reliably:
5950 @smallexample
5951 asm ("combine %2,%0" : "=r" (foo) : "r" (foo), "g" (bar));
5952 @end smallexample
5954 Various optimizations or reloading could cause operands 0 and 1 to be in
5955 different registers; GCC knows no reason not to do so.  For example, the
5956 compiler might find a copy of the value of @code{foo} in one register and
5957 use it for operand 1, but generate the output operand 0 in a different
5958 register (copying it afterward to @code{foo}'s own address).  Of course,
5959 since the register for operand 1 is not even mentioned in the assembler
5960 code, the result will not work, but GCC can't tell that.
5962 As of GCC version 3.1, one may write @code{[@var{name}]} instead of
5963 the operand number for a matching constraint.  For example:
5965 @smallexample
5966 asm ("cmoveq %1,%2,%[result]"
5967      : [result] "=r"(result)
5968      : "r" (test), "r"(new), "[result]"(old));
5969 @end smallexample
5971 Sometimes you need to make an @code{asm} operand be a specific register,
5972 but there's no matching constraint letter for that register @emph{by
5973 itself}.  To force the operand into that register, use a local variable
5974 for the operand and specify the register in the variable declaration.
5975 @xref{Explicit Reg Vars}.  Then for the @code{asm} operand, use any
5976 register constraint letter that matches the register:
5978 @smallexample
5979 register int *p1 asm ("r0") = @dots{};
5980 register int *p2 asm ("r1") = @dots{};
5981 register int *result asm ("r0");
5982 asm ("sysint" : "=r" (result) : "0" (p1), "r" (p2));
5983 @end smallexample
5985 @anchor{Example of asm with clobbered asm reg}
5986 In the above example, beware that a register that is call-clobbered by
5987 the target ABI will be overwritten by any function call in the
5988 assignment, including library calls for arithmetic operators.
5989 Also a register may be clobbered when generating some operations,
5990 like variable shift, memory copy or memory move on x86.
5991 Assuming it is a call-clobbered register, this may happen to @code{r0}
5992 above by the assignment to @code{p2}.  If you have to use such a
5993 register, use temporary variables for expressions between the register
5994 assignment and use:
5996 @smallexample
5997 int t1 = @dots{};
5998 register int *p1 asm ("r0") = @dots{};
5999 register int *p2 asm ("r1") = t1;
6000 register int *result asm ("r0");
6001 asm ("sysint" : "=r" (result) : "0" (p1), "r" (p2));
6002 @end smallexample
6004 Some instructions clobber specific hard registers.  To describe this,
6005 write a third colon after the input operands, followed by the names of
6006 the clobbered hard registers (given as strings).  Here is a realistic
6007 example for the VAX:
6009 @smallexample
6010 asm volatile ("movc3 %0,%1,%2"
6011               : /* @r{no outputs} */
6012               : "g" (from), "g" (to), "g" (count)
6013               : "r0", "r1", "r2", "r3", "r4", "r5");
6014 @end smallexample
6016 You may not write a clobber description in a way that overlaps with an
6017 input or output operand.  For example, you may not have an operand
6018 describing a register class with one member if you mention that register
6019 in the clobber list.  Variables declared to live in specific registers
6020 (@pxref{Explicit Reg Vars}), and used as asm input or output operands must
6021 have no part mentioned in the clobber description.
6022 There is no way for you to specify that an input
6023 operand is modified without also specifying it as an output
6024 operand.  Note that if all the output operands you specify are for this
6025 purpose (and hence unused), you then also need to specify
6026 @code{volatile} for the @code{asm} construct, as described below, to
6027 prevent GCC from deleting the @code{asm} statement as unused.
6029 If you refer to a particular hardware register from the assembler code,
6030 you probably have to list the register after the third colon to
6031 tell the compiler the register's value is modified.  In some assemblers,
6032 the register names begin with @samp{%}; to produce one @samp{%} in the
6033 assembler code, you must write @samp{%%} in the input.
6035 If your assembler instruction can alter the condition code register, add
6036 @samp{cc} to the list of clobbered registers.  GCC on some machines
6037 represents the condition codes as a specific hardware register;
6038 @samp{cc} serves to name this register.  On other machines, the
6039 condition code is handled differently, and specifying @samp{cc} has no
6040 effect.  But it is valid no matter what the machine.
6042 If your assembler instructions access memory in an unpredictable
6043 fashion, add @samp{memory} to the list of clobbered registers.  This
6044 causes GCC to not keep memory values cached in registers across the
6045 assembler instruction and not optimize stores or loads to that memory.
6046 You also should add the @code{volatile} keyword if the memory
6047 affected is not listed in the inputs or outputs of the @code{asm}, as
6048 the @samp{memory} clobber does not count as a side-effect of the
6049 @code{asm}.  If you know how large the accessed memory is, you can add
6050 it as input or output but if this is not known, you should add
6051 @samp{memory}.  As an example, if you access ten bytes of a string, you
6052 can use a memory input like:
6054 @smallexample
6055 @{"m"( (@{ struct @{ char x[10]; @} *p = (void *)ptr ; *p; @}) )@}.
6056 @end smallexample
6058 Note that in the following example the memory input is necessary,
6059 otherwise GCC might optimize the store to @code{x} away:
6060 @smallexample
6061 int foo ()
6063   int x = 42;
6064   int *y = &x;
6065   int result;
6066   asm ("magic stuff accessing an 'int' pointed to by '%1'"
6067         "=&d" (r) : "a" (y), "m" (*y));
6068   return result;
6070 @end smallexample
6072 You can put multiple assembler instructions together in a single
6073 @code{asm} template, separated by the characters normally used in assembly
6074 code for the system.  A combination that works in most places is a newline
6075 to break the line, plus a tab character to move to the instruction field
6076 (written as @samp{\n\t}).  Sometimes semicolons can be used, if the
6077 assembler allows semicolons as a line-breaking character.  Note that some
6078 assembler dialects use semicolons to start a comment.
6079 The input operands are guaranteed not to use any of the clobbered
6080 registers, and neither do the output operands' addresses, so you can
6081 read and write the clobbered registers as many times as you like.  Here
6082 is an example of multiple instructions in a template; it assumes the
6083 subroutine @code{_foo} accepts arguments in registers 9 and 10:
6085 @smallexample
6086 asm ("movl %0,r9\n\tmovl %1,r10\n\tcall _foo"
6087      : /* no outputs */
6088      : "g" (from), "g" (to)
6089      : "r9", "r10");
6090 @end smallexample
6092 Unless an output operand has the @samp{&} constraint modifier, GCC
6093 may allocate it in the same register as an unrelated input operand, on
6094 the assumption the inputs are consumed before the outputs are produced.
6095 This assumption may be false if the assembler code actually consists of
6096 more than one instruction.  In such a case, use @samp{&} for each output
6097 operand that may not overlap an input.  @xref{Modifiers}.
6099 If you want to test the condition code produced by an assembler
6100 instruction, you must include a branch and a label in the @code{asm}
6101 construct, as follows:
6103 @smallexample
6104 asm ("clr %0\n\tfrob %1\n\tbeq 0f\n\tmov #1,%0\n0:"
6105      : "g" (result)
6106      : "g" (input));
6107 @end smallexample
6109 @noindent
6110 This assumes your assembler supports local labels, as the GNU assembler
6111 and most Unix assemblers do.
6113 Speaking of labels, jumps from one @code{asm} to another are not
6114 supported.  The compiler's optimizers do not know about these jumps, and
6115 therefore they cannot take account of them when deciding how to
6116 optimize.  @xref{Extended asm with goto}.
6118 @cindex macros containing @code{asm}
6119 Usually the most convenient way to use these @code{asm} instructions is to
6120 encapsulate them in macros that look like functions.  For example,
6122 @smallexample
6123 #define sin(x)       \
6124 (@{ double __value, __arg = (x);   \
6125    asm ("fsinx %1,%0": "=f" (__value): "f" (__arg));  \
6126    __value; @})
6127 @end smallexample
6129 @noindent
6130 Here the variable @code{__arg} is used to make sure that the instruction
6131 operates on a proper @code{double} value, and to accept only those
6132 arguments @code{x} that can convert automatically to a @code{double}.
6134 Another way to make sure the instruction operates on the correct data
6135 type is to use a cast in the @code{asm}.  This is different from using a
6136 variable @code{__arg} in that it converts more different types.  For
6137 example, if the desired type is @code{int}, casting the argument to
6138 @code{int} accepts a pointer with no complaint, while assigning the
6139 argument to an @code{int} variable named @code{__arg} warns about
6140 using a pointer unless the caller explicitly casts it.
6142 If an @code{asm} has output operands, GCC assumes for optimization
6143 purposes the instruction has no side effects except to change the output
6144 operands.  This does not mean instructions with a side effect cannot be
6145 used, but you must be careful, because the compiler may eliminate them
6146 if the output operands aren't used, or move them out of loops, or
6147 replace two with one if they constitute a common subexpression.  Also,
6148 if your instruction does have a side effect on a variable that otherwise
6149 appears not to change, the old value of the variable may be reused later
6150 if it happens to be found in a register.
6152 You can prevent an @code{asm} instruction from being deleted
6153 by writing the keyword @code{volatile} after
6154 the @code{asm}.  For example:
6156 @smallexample
6157 #define get_and_set_priority(new)              \
6158 (@{ int __old;                                  \
6159    asm volatile ("get_and_set_priority %0, %1" \
6160                  : "=g" (__old) : "g" (new));  \
6161    __old; @})
6162 @end smallexample
6164 @noindent
6165 The @code{volatile} keyword indicates that the instruction has
6166 important side-effects.  GCC does not delete a volatile @code{asm} if
6167 it is reachable.  (The instruction can still be deleted if GCC can
6168 prove that control flow never reaches the location of the
6169 instruction.)  Note that even a volatile @code{asm} instruction
6170 can be moved relative to other code, including across jump
6171 instructions.  For example, on many targets there is a system
6172 register that can be set to control the rounding mode of
6173 floating-point operations.  You might try
6174 setting it with a volatile @code{asm}, like this PowerPC example:
6176 @smallexample
6177        asm volatile("mtfsf 255,%0" : : "f" (fpenv));
6178        sum = x + y;
6179 @end smallexample
6181 @noindent
6182 This does not work reliably, as the compiler may move the addition back
6183 before the volatile @code{asm}.  To make it work you need to add an
6184 artificial dependency to the @code{asm} referencing a variable in the code
6185 you don't want moved, for example:
6187 @smallexample
6188     asm volatile ("mtfsf 255,%1" : "=X"(sum): "f"(fpenv));
6189     sum = x + y;
6190 @end smallexample
6192 Similarly, you can't expect a
6193 sequence of volatile @code{asm} instructions to remain perfectly
6194 consecutive.  If you want consecutive output, use a single @code{asm}.
6195 Also, GCC performs some optimizations across a volatile @code{asm}
6196 instruction; GCC does not ``forget everything'' when it encounters
6197 a volatile @code{asm} instruction the way some other compilers do.
6199 An @code{asm} instruction without any output operands is treated
6200 identically to a volatile @code{asm} instruction.
6202 It is a natural idea to look for a way to give access to the condition
6203 code left by the assembler instruction.  However, when we attempted to
6204 implement this, we found no way to make it work reliably.  The problem
6205 is that output operands might need reloading, which result in
6206 additional following ``store'' instructions.  On most machines, these
6207 instructions alter the condition code before there is time to
6208 test it.  This problem doesn't arise for ordinary ``test'' and
6209 ``compare'' instructions because they don't have any output operands.
6211 For reasons similar to those described above, it is not possible to give
6212 an assembler instruction access to the condition code left by previous
6213 instructions.
6215 @anchor{Extended asm with goto}
6216 As of GCC version 4.5, @code{asm goto} may be used to have the assembly
6217 jump to one or more C labels.  In this form, a fifth section after the
6218 clobber list contains a list of all C labels to which the assembly may jump.
6219 Each label operand is implicitly self-named.  The @code{asm} is also assumed
6220 to fall through to the next statement.
6222 This form of @code{asm} is restricted to not have outputs.  This is due
6223 to a internal restriction in the compiler that control transfer instructions
6224 cannot have outputs.  This restriction on @code{asm goto} may be lifted
6225 in some future version of the compiler.  In the meantime, @code{asm goto}
6226 may include a memory clobber, and so leave outputs in memory.
6228 @smallexample
6229 int frob(int x)
6231   int y;
6232   asm goto ("frob %%r5, %1; jc %l[error]; mov (%2), %%r5"
6233             : : "r"(x), "r"(&y) : "r5", "memory" : error);
6234   return y;
6235  error:
6236   return -1;
6238 @end smallexample
6240 @noindent
6241 In this (inefficient) example, the @code{frob} instruction sets the
6242 carry bit to indicate an error.  The @code{jc} instruction detects
6243 this and branches to the @code{error} label.  Finally, the output
6244 of the @code{frob} instruction (@code{%r5}) is stored into the memory
6245 for variable @code{y}, which is later read by the @code{return} statement.
6247 @smallexample
6248 void doit(void)
6250   int i = 0;
6251   asm goto ("mfsr %%r1, 123; jmp %%r1;"
6252             ".pushsection doit_table;"
6253             ".long %l0, %l1, %l2, %l3;"
6254             ".popsection"
6255             : : : "r1" : label1, label2, label3, label4);
6256   __builtin_unreachable ();
6258  label1:
6259   f1();
6260   return;
6261  label2:
6262   f2();
6263   return;
6264  label3:
6265   i = 1;
6266  label4:
6267   f3(i);
6269 @end smallexample
6271 @noindent
6272 In this (also inefficient) example, the @code{mfsr} instruction reads
6273 an address from some out-of-band machine register, and the following
6274 @code{jmp} instruction branches to that address.  The address read by
6275 the @code{mfsr} instruction is assumed to have been previously set via
6276 some application-specific mechanism to be one of the four values stored
6277 in the @code{doit_table} section.  Finally, the @code{asm} is followed
6278 by a call to @code{__builtin_unreachable} to indicate that the @code{asm}
6279 does not in fact fall through.
6281 @smallexample
6282 #define TRACE1(NUM)                         \
6283   do @{                                      \
6284     asm goto ("0: nop;"                     \
6285               ".pushsection trace_table;"   \
6286               ".long 0b, %l0;"              \
6287               ".popsection"                 \
6288               : : : : trace#NUM);           \
6289     if (0) @{ trace#NUM: trace(); @}          \
6290   @} while (0)
6291 #define TRACE  TRACE1(__COUNTER__)
6292 @end smallexample
6294 @noindent
6295 In this example (which in fact inspired the @code{asm goto} feature)
6296 we want on rare occasions to call the @code{trace} function; on other
6297 occasions we'd like to keep the overhead to the absolute minimum.
6298 The normal code path consists of a single @code{nop} instruction.
6299 However, we record the address of this @code{nop} together with the
6300 address of a label that calls the @code{trace} function.  This allows
6301 the @code{nop} instruction to be patched at run time to be an
6302 unconditional branch to the stored label.  It is assumed that an
6303 optimizing compiler moves the labeled block out of line, to
6304 optimize the fall through path from the @code{asm}.
6306 If you are writing a header file that should be includable in ISO C
6307 programs, write @code{__asm__} instead of @code{asm}.  @xref{Alternate
6308 Keywords}.
6310 @subsection Size of an @code{asm}
6312 Some targets require that GCC track the size of each instruction used in
6313 order to generate correct code.  Because the final length of an
6314 @code{asm} is only known by the assembler, GCC must make an estimate as
6315 to how big it will be.  The estimate is formed by counting the number of
6316 statements in the pattern of the @code{asm} and multiplying that by the
6317 length of the longest instruction on that processor.  Statements in the
6318 @code{asm} are identified by newline characters and whatever statement
6319 separator characters are supported by the assembler; on most processors
6320 this is the @samp{;} character.
6322 Normally, GCC's estimate is perfectly adequate to ensure that correct
6323 code is generated, but it is possible to confuse the compiler if you use
6324 pseudo instructions or assembler macros that expand into multiple real
6325 instructions or if you use assembler directives that expand to more
6326 space in the object file than is needed for a single instruction.
6327 If this happens then the assembler produces a diagnostic saying that
6328 a label is unreachable.
6330 @subsection i386 floating-point asm operands
6332 On i386 targets, there are several rules on the usage of stack-like registers
6333 in the operands of an @code{asm}.  These rules apply only to the operands
6334 that are stack-like registers:
6336 @enumerate
6337 @item
6338 Given a set of input registers that die in an @code{asm}, it is
6339 necessary to know which are implicitly popped by the @code{asm}, and
6340 which must be explicitly popped by GCC@.
6342 An input register that is implicitly popped by the @code{asm} must be
6343 explicitly clobbered, unless it is constrained to match an
6344 output operand.
6346 @item
6347 For any input register that is implicitly popped by an @code{asm}, it is
6348 necessary to know how to adjust the stack to compensate for the pop.
6349 If any non-popped input is closer to the top of the reg-stack than
6350 the implicitly popped register, it would not be possible to know what the
6351 stack looked like---it's not clear how the rest of the stack ``slides
6352 up''.
6354 All implicitly popped input registers must be closer to the top of
6355 the reg-stack than any input that is not implicitly popped.
6357 It is possible that if an input dies in an @code{asm}, the compiler might
6358 use the input register for an output reload.  Consider this example:
6360 @smallexample
6361 asm ("foo" : "=t" (a) : "f" (b));
6362 @end smallexample
6364 @noindent
6365 This code says that input @code{b} is not popped by the @code{asm}, and that
6366 the @code{asm} pushes a result onto the reg-stack, i.e., the stack is one
6367 deeper after the @code{asm} than it was before.  But, it is possible that
6368 reload may think that it can use the same register for both the input and
6369 the output.
6371 To prevent this from happening,
6372 if any input operand uses the @code{f} constraint, all output register
6373 constraints must use the @code{&} early-clobber modifier.
6375 The example above would be correctly written as:
6377 @smallexample
6378 asm ("foo" : "=&t" (a) : "f" (b));
6379 @end smallexample
6381 @item
6382 Some operands need to be in particular places on the stack.  All
6383 output operands fall in this category---GCC has no other way to
6384 know which registers the outputs appear in unless you indicate
6385 this in the constraints.
6387 Output operands must specifically indicate which register an output
6388 appears in after an @code{asm}.  @code{=f} is not allowed: the operand
6389 constraints must select a class with a single register.
6391 @item
6392 Output operands may not be ``inserted'' between existing stack registers.
6393 Since no 387 opcode uses a read/write operand, all output operands
6394 are dead before the @code{asm}, and are pushed by the @code{asm}.
6395 It makes no sense to push anywhere but the top of the reg-stack.
6397 Output operands must start at the top of the reg-stack: output
6398 operands may not ``skip'' a register.
6400 @item
6401 Some @code{asm} statements may need extra stack space for internal
6402 calculations.  This can be guaranteed by clobbering stack registers
6403 unrelated to the inputs and outputs.
6405 @end enumerate
6407 Here are a couple of reasonable @code{asm}s to want to write.  This
6408 @code{asm}
6409 takes one input, which is internally popped, and produces two outputs.
6411 @smallexample
6412 asm ("fsincos" : "=t" (cos), "=u" (sin) : "0" (inp));
6413 @end smallexample
6415 @noindent
6416 This @code{asm} takes two inputs, which are popped by the @code{fyl2xp1} opcode,
6417 and replaces them with one output.  The @code{st(1)} clobber is necessary 
6418 for the compiler to know that @code{fyl2xp1} pops both inputs.
6420 @smallexample
6421 asm ("fyl2xp1" : "=t" (result) : "0" (x), "u" (y) : "st(1)");
6422 @end smallexample
6424 @include md.texi
6426 @node Asm Labels
6427 @section Controlling Names Used in Assembler Code
6428 @cindex assembler names for identifiers
6429 @cindex names used in assembler code
6430 @cindex identifiers, names in assembler code
6432 You can specify the name to be used in the assembler code for a C
6433 function or variable by writing the @code{asm} (or @code{__asm__})
6434 keyword after the declarator as follows:
6436 @smallexample
6437 int foo asm ("myfoo") = 2;
6438 @end smallexample
6440 @noindent
6441 This specifies that the name to be used for the variable @code{foo} in
6442 the assembler code should be @samp{myfoo} rather than the usual
6443 @samp{_foo}.
6445 On systems where an underscore is normally prepended to the name of a C
6446 function or variable, this feature allows you to define names for the
6447 linker that do not start with an underscore.
6449 It does not make sense to use this feature with a non-static local
6450 variable since such variables do not have assembler names.  If you are
6451 trying to put the variable in a particular register, see @ref{Explicit
6452 Reg Vars}.  GCC presently accepts such code with a warning, but will
6453 probably be changed to issue an error, rather than a warning, in the
6454 future.
6456 You cannot use @code{asm} in this way in a function @emph{definition}; but
6457 you can get the same effect by writing a declaration for the function
6458 before its definition and putting @code{asm} there, like this:
6460 @smallexample
6461 extern func () asm ("FUNC");
6463 func (x, y)
6464      int x, y;
6465 /* @r{@dots{}} */
6466 @end smallexample
6468 It is up to you to make sure that the assembler names you choose do not
6469 conflict with any other assembler symbols.  Also, you must not use a
6470 register name; that would produce completely invalid assembler code.  GCC
6471 does not as yet have the ability to store static variables in registers.
6472 Perhaps that will be added.
6474 @node Explicit Reg Vars
6475 @section Variables in Specified Registers
6476 @cindex explicit register variables
6477 @cindex variables in specified registers
6478 @cindex specified registers
6479 @cindex registers, global allocation
6481 GNU C allows you to put a few global variables into specified hardware
6482 registers.  You can also specify the register in which an ordinary
6483 register variable should be allocated.
6485 @itemize @bullet
6486 @item
6487 Global register variables reserve registers throughout the program.
6488 This may be useful in programs such as programming language
6489 interpreters that have a couple of global variables that are accessed
6490 very often.
6492 @item
6493 Local register variables in specific registers do not reserve the
6494 registers, except at the point where they are used as input or output
6495 operands in an @code{asm} statement and the @code{asm} statement itself is
6496 not deleted.  The compiler's data flow analysis is capable of determining
6497 where the specified registers contain live values, and where they are
6498 available for other uses.  Stores into local register variables may be deleted
6499 when they appear to be dead according to dataflow analysis.  References
6500 to local register variables may be deleted or moved or simplified.
6502 These local variables are sometimes convenient for use with the extended
6503 @code{asm} feature (@pxref{Extended Asm}), if you want to write one
6504 output of the assembler instruction directly into a particular register.
6505 (This works provided the register you specify fits the constraints
6506 specified for that operand in the @code{asm}.)
6507 @end itemize
6509 @menu
6510 * Global Reg Vars::
6511 * Local Reg Vars::
6512 @end menu
6514 @node Global Reg Vars
6515 @subsection Defining Global Register Variables
6516 @cindex global register variables
6517 @cindex registers, global variables in
6519 You can define a global register variable in GNU C like this:
6521 @smallexample
6522 register int *foo asm ("a5");
6523 @end smallexample
6525 @noindent
6526 Here @code{a5} is the name of the register that should be used.  Choose a
6527 register that is normally saved and restored by function calls on your
6528 machine, so that library routines will not clobber it.
6530 Naturally the register name is cpu-dependent, so you need to
6531 conditionalize your program according to cpu type.  The register
6532 @code{a5} is a good choice on a 68000 for a variable of pointer
6533 type.  On machines with register windows, be sure to choose a ``global''
6534 register that is not affected magically by the function call mechanism.
6536 In addition, different operating systems on the same CPU may differ in how they
6537 name the registers; then you need additional conditionals.  For
6538 example, some 68000 operating systems call this register @code{%a5}.
6540 Eventually there may be a way of asking the compiler to choose a register
6541 automatically, but first we need to figure out how it should choose and
6542 how to enable you to guide the choice.  No solution is evident.
6544 Defining a global register variable in a certain register reserves that
6545 register entirely for this use, at least within the current compilation.
6546 The register is not allocated for any other purpose in the functions
6547 in the current compilation, and is not saved and restored by
6548 these functions.  Stores into this register are never deleted even if they
6549 appear to be dead, but references may be deleted or moved or
6550 simplified.
6552 It is not safe to access the global register variables from signal
6553 handlers, or from more than one thread of control, because the system
6554 library routines may temporarily use the register for other things (unless
6555 you recompile them specially for the task at hand).
6557 @cindex @code{qsort}, and global register variables
6558 It is not safe for one function that uses a global register variable to
6559 call another such function @code{foo} by way of a third function
6560 @code{lose} that is compiled without knowledge of this variable (i.e.@: in a
6561 different source file in which the variable isn't declared).  This is
6562 because @code{lose} might save the register and put some other value there.
6563 For example, you can't expect a global register variable to be available in
6564 the comparison-function that you pass to @code{qsort}, since @code{qsort}
6565 might have put something else in that register.  (If you are prepared to
6566 recompile @code{qsort} with the same global register variable, you can
6567 solve this problem.)
6569 If you want to recompile @code{qsort} or other source files that do not
6570 actually use your global register variable, so that they do not use that
6571 register for any other purpose, then it suffices to specify the compiler
6572 option @option{-ffixed-@var{reg}}.  You need not actually add a global
6573 register declaration to their source code.
6575 A function that can alter the value of a global register variable cannot
6576 safely be called from a function compiled without this variable, because it
6577 could clobber the value the caller expects to find there on return.
6578 Therefore, the function that is the entry point into the part of the
6579 program that uses the global register variable must explicitly save and
6580 restore the value that belongs to its caller.
6582 @cindex register variable after @code{longjmp}
6583 @cindex global register after @code{longjmp}
6584 @cindex value after @code{longjmp}
6585 @findex longjmp
6586 @findex setjmp
6587 On most machines, @code{longjmp} restores to each global register
6588 variable the value it had at the time of the @code{setjmp}.  On some
6589 machines, however, @code{longjmp} does not change the value of global
6590 register variables.  To be portable, the function that called @code{setjmp}
6591 should make other arrangements to save the values of the global register
6592 variables, and to restore them in a @code{longjmp}.  This way, the same
6593 thing happens regardless of what @code{longjmp} does.
6595 All global register variable declarations must precede all function
6596 definitions.  If such a declaration could appear after function
6597 definitions, the declaration would be too late to prevent the register from
6598 being used for other purposes in the preceding functions.
6600 Global register variables may not have initial values, because an
6601 executable file has no means to supply initial contents for a register.
6603 On the SPARC, there are reports that g3 @dots{} g7 are suitable
6604 registers, but certain library functions, such as @code{getwd}, as well
6605 as the subroutines for division and remainder, modify g3 and g4.  g1 and
6606 g2 are local temporaries.
6608 On the 68000, a2 @dots{} a5 should be suitable, as should d2 @dots{} d7.
6609 Of course, it does not do to use more than a few of those.
6611 @node Local Reg Vars
6612 @subsection Specifying Registers for Local Variables
6613 @cindex local variables, specifying registers
6614 @cindex specifying registers for local variables
6615 @cindex registers for local variables
6617 You can define a local register variable with a specified register
6618 like this:
6620 @smallexample
6621 register int *foo asm ("a5");
6622 @end smallexample
6624 @noindent
6625 Here @code{a5} is the name of the register that should be used.  Note
6626 that this is the same syntax used for defining global register
6627 variables, but for a local variable it appears within a function.
6629 Naturally the register name is cpu-dependent, but this is not a
6630 problem, since specific registers are most often useful with explicit
6631 assembler instructions (@pxref{Extended Asm}).  Both of these things
6632 generally require that you conditionalize your program according to
6633 cpu type.
6635 In addition, operating systems on one type of cpu may differ in how they
6636 name the registers; then you need additional conditionals.  For
6637 example, some 68000 operating systems call this register @code{%a5}.
6639 Defining such a register variable does not reserve the register; it
6640 remains available for other uses in places where flow control determines
6641 the variable's value is not live.
6643 This option does not guarantee that GCC generates code that has
6644 this variable in the register you specify at all times.  You may not
6645 code an explicit reference to this register in the @emph{assembler
6646 instruction template} part of an @code{asm} statement and assume it
6647 always refers to this variable.  However, using the variable as an
6648 @code{asm} @emph{operand} guarantees that the specified register is used
6649 for the operand.
6651 Stores into local register variables may be deleted when they appear to be dead
6652 according to dataflow analysis.  References to local register variables may
6653 be deleted or moved or simplified.
6655 As for global register variables, it's recommended that you choose a
6656 register that is normally saved and restored by function calls on
6657 your machine, so that library routines will not clobber it.  A common
6658 pitfall is to initialize multiple call-clobbered registers with
6659 arbitrary expressions, where a function call or library call for an
6660 arithmetic operator overwrites a register value from a previous
6661 assignment, for example @code{r0} below:
6662 @smallexample
6663 register int *p1 asm ("r0") = @dots{};
6664 register int *p2 asm ("r1") = @dots{};
6665 @end smallexample
6667 @noindent
6668 In those cases, a solution is to use a temporary variable for
6669 each arbitrary expression.   @xref{Example of asm with clobbered asm reg}.
6671 @node Alternate Keywords
6672 @section Alternate Keywords
6673 @cindex alternate keywords
6674 @cindex keywords, alternate
6676 @option{-ansi} and the various @option{-std} options disable certain
6677 keywords.  This causes trouble when you want to use GNU C extensions, or
6678 a general-purpose header file that should be usable by all programs,
6679 including ISO C programs.  The keywords @code{asm}, @code{typeof} and
6680 @code{inline} are not available in programs compiled with
6681 @option{-ansi} or @option{-std} (although @code{inline} can be used in a
6682 program compiled with @option{-std=c99} or @option{-std=c11}).  The
6683 ISO C99 keyword
6684 @code{restrict} is only available when @option{-std=gnu99} (which will
6685 eventually be the default) or @option{-std=c99} (or the equivalent
6686 @option{-std=iso9899:1999}), or an option for a later standard
6687 version, is used.
6689 The way to solve these problems is to put @samp{__} at the beginning and
6690 end of each problematical keyword.  For example, use @code{__asm__}
6691 instead of @code{asm}, and @code{__inline__} instead of @code{inline}.
6693 Other C compilers won't accept these alternative keywords; if you want to
6694 compile with another compiler, you can define the alternate keywords as
6695 macros to replace them with the customary keywords.  It looks like this:
6697 @smallexample
6698 #ifndef __GNUC__
6699 #define __asm__ asm
6700 #endif
6701 @end smallexample
6703 @findex __extension__
6704 @opindex pedantic
6705 @option{-pedantic} and other options cause warnings for many GNU C extensions.
6706 You can
6707 prevent such warnings within one expression by writing
6708 @code{__extension__} before the expression.  @code{__extension__} has no
6709 effect aside from this.
6711 @node Incomplete Enums
6712 @section Incomplete @code{enum} Types
6714 You can define an @code{enum} tag without specifying its possible values.
6715 This results in an incomplete type, much like what you get if you write
6716 @code{struct foo} without describing the elements.  A later declaration
6717 that does specify the possible values completes the type.
6719 You can't allocate variables or storage using the type while it is
6720 incomplete.  However, you can work with pointers to that type.
6722 This extension may not be very useful, but it makes the handling of
6723 @code{enum} more consistent with the way @code{struct} and @code{union}
6724 are handled.
6726 This extension is not supported by GNU C++.
6728 @node Function Names
6729 @section Function Names as Strings
6730 @cindex @code{__func__} identifier
6731 @cindex @code{__FUNCTION__} identifier
6732 @cindex @code{__PRETTY_FUNCTION__} identifier
6734 GCC provides three magic variables that hold the name of the current
6735 function, as a string.  The first of these is @code{__func__}, which
6736 is part of the C99 standard:
6738 The identifier @code{__func__} is implicitly declared by the translator
6739 as if, immediately following the opening brace of each function
6740 definition, the declaration
6742 @smallexample
6743 static const char __func__[] = "function-name";
6744 @end smallexample
6746 @noindent
6747 appeared, where function-name is the name of the lexically-enclosing
6748 function.  This name is the unadorned name of the function.
6750 @code{__FUNCTION__} is another name for @code{__func__}.  Older
6751 versions of GCC recognize only this name.  However, it is not
6752 standardized.  For maximum portability, we recommend you use
6753 @code{__func__}, but provide a fallback definition with the
6754 preprocessor:
6756 @smallexample
6757 #if __STDC_VERSION__ < 199901L
6758 # if __GNUC__ >= 2
6759 #  define __func__ __FUNCTION__
6760 # else
6761 #  define __func__ "<unknown>"
6762 # endif
6763 #endif
6764 @end smallexample
6766 In C, @code{__PRETTY_FUNCTION__} is yet another name for
6767 @code{__func__}.  However, in C++, @code{__PRETTY_FUNCTION__} contains
6768 the type signature of the function as well as its bare name.  For
6769 example, this program:
6771 @smallexample
6772 extern "C" @{
6773 extern int printf (char *, ...);
6776 class a @{
6777  public:
6778   void sub (int i)
6779     @{
6780       printf ("__FUNCTION__ = %s\n", __FUNCTION__);
6781       printf ("__PRETTY_FUNCTION__ = %s\n", __PRETTY_FUNCTION__);
6782     @}
6786 main (void)
6788   a ax;
6789   ax.sub (0);
6790   return 0;
6792 @end smallexample
6794 @noindent
6795 gives this output:
6797 @smallexample
6798 __FUNCTION__ = sub
6799 __PRETTY_FUNCTION__ = void a::sub(int)
6800 @end smallexample
6802 These identifiers are not preprocessor macros.  In GCC 3.3 and
6803 earlier, in C only, @code{__FUNCTION__} and @code{__PRETTY_FUNCTION__}
6804 were treated as string literals; they could be used to initialize
6805 @code{char} arrays, and they could be concatenated with other string
6806 literals.  GCC 3.4 and later treat them as variables, like
6807 @code{__func__}.  In C++, @code{__FUNCTION__} and
6808 @code{__PRETTY_FUNCTION__} have always been variables.
6810 @node Return Address
6811 @section Getting the Return or Frame Address of a Function
6813 These functions may be used to get information about the callers of a
6814 function.
6816 @deftypefn {Built-in Function} {void *} __builtin_return_address (unsigned int @var{level})
6817 This function returns the return address of the current function, or of
6818 one of its callers.  The @var{level} argument is number of frames to
6819 scan up the call stack.  A value of @code{0} yields the return address
6820 of the current function, a value of @code{1} yields the return address
6821 of the caller of the current function, and so forth.  When inlining
6822 the expected behavior is that the function returns the address of
6823 the function that is returned to.  To work around this behavior use
6824 the @code{noinline} function attribute.
6826 The @var{level} argument must be a constant integer.
6828 On some machines it may be impossible to determine the return address of
6829 any function other than the current one; in such cases, or when the top
6830 of the stack has been reached, this function returns @code{0} or a
6831 random value.  In addition, @code{__builtin_frame_address} may be used
6832 to determine if the top of the stack has been reached.
6834 Additional post-processing of the returned value may be needed, see
6835 @code{__builtin_extract_return_addr}.
6837 This function should only be used with a nonzero argument for debugging
6838 purposes.
6839 @end deftypefn
6841 @deftypefn {Built-in Function} {void *} __builtin_extract_return_addr (void *@var{addr})
6842 The address as returned by @code{__builtin_return_address} may have to be fed
6843 through this function to get the actual encoded address.  For example, on the
6844 31-bit S/390 platform the highest bit has to be masked out, or on SPARC
6845 platforms an offset has to be added for the true next instruction to be
6846 executed.
6848 If no fixup is needed, this function simply passes through @var{addr}.
6849 @end deftypefn
6851 @deftypefn {Built-in Function} {void *} __builtin_frob_return_address (void *@var{addr})
6852 This function does the reverse of @code{__builtin_extract_return_addr}.
6853 @end deftypefn
6855 @deftypefn {Built-in Function} {void *} __builtin_frame_address (unsigned int @var{level})
6856 This function is similar to @code{__builtin_return_address}, but it
6857 returns the address of the function frame rather than the return address
6858 of the function.  Calling @code{__builtin_frame_address} with a value of
6859 @code{0} yields the frame address of the current function, a value of
6860 @code{1} yields the frame address of the caller of the current function,
6861 and so forth.
6863 The frame is the area on the stack that holds local variables and saved
6864 registers.  The frame address is normally the address of the first word
6865 pushed on to the stack by the function.  However, the exact definition
6866 depends upon the processor and the calling convention.  If the processor
6867 has a dedicated frame pointer register, and the function has a frame,
6868 then @code{__builtin_frame_address} returns the value of the frame
6869 pointer register.
6871 On some machines it may be impossible to determine the frame address of
6872 any function other than the current one; in such cases, or when the top
6873 of the stack has been reached, this function returns @code{0} if
6874 the first frame pointer is properly initialized by the startup code.
6876 This function should only be used with a nonzero argument for debugging
6877 purposes.
6878 @end deftypefn
6880 @node Vector Extensions
6881 @section Using Vector Instructions through Built-in Functions
6883 On some targets, the instruction set contains SIMD vector instructions which
6884 operate on multiple values contained in one large register at the same time.
6885 For example, on the i386 the MMX, 3DNow!@: and SSE extensions can be used
6886 this way.
6888 The first step in using these extensions is to provide the necessary data
6889 types.  This should be done using an appropriate @code{typedef}:
6891 @smallexample
6892 typedef int v4si __attribute__ ((vector_size (16)));
6893 @end smallexample
6895 @noindent
6896 The @code{int} type specifies the base type, while the attribute specifies
6897 the vector size for the variable, measured in bytes.  For example, the
6898 declaration above causes the compiler to set the mode for the @code{v4si}
6899 type to be 16 bytes wide and divided into @code{int} sized units.  For
6900 a 32-bit @code{int} this means a vector of 4 units of 4 bytes, and the
6901 corresponding mode of @code{foo} is @acronym{V4SI}.
6903 The @code{vector_size} attribute is only applicable to integral and
6904 float scalars, although arrays, pointers, and function return values
6905 are allowed in conjunction with this construct. Only sizes that are
6906 a power of two are currently allowed.
6908 All the basic integer types can be used as base types, both as signed
6909 and as unsigned: @code{char}, @code{short}, @code{int}, @code{long},
6910 @code{long long}.  In addition, @code{float} and @code{double} can be
6911 used to build floating-point vector types.
6913 Specifying a combination that is not valid for the current architecture
6914 causes GCC to synthesize the instructions using a narrower mode.
6915 For example, if you specify a variable of type @code{V4SI} and your
6916 architecture does not allow for this specific SIMD type, GCC
6917 produces code that uses 4 @code{SIs}.
6919 The types defined in this manner can be used with a subset of normal C
6920 operations.  Currently, GCC allows using the following operators
6921 on these types: @code{+, -, *, /, unary minus, ^, |, &, ~, %}@.
6923 The operations behave like C++ @code{valarrays}.  Addition is defined as
6924 the addition of the corresponding elements of the operands.  For
6925 example, in the code below, each of the 4 elements in @var{a} is
6926 added to the corresponding 4 elements in @var{b} and the resulting
6927 vector is stored in @var{c}.
6929 @smallexample
6930 typedef int v4si __attribute__ ((vector_size (16)));
6932 v4si a, b, c;
6934 c = a + b;
6935 @end smallexample
6937 Subtraction, multiplication, division, and the logical operations
6938 operate in a similar manner.  Likewise, the result of using the unary
6939 minus or complement operators on a vector type is a vector whose
6940 elements are the negative or complemented values of the corresponding
6941 elements in the operand.
6943 It is possible to use shifting operators @code{<<}, @code{>>} on
6944 integer-type vectors. The operation is defined as following: @code{@{a0,
6945 a1, @dots{}, an@} >> @{b0, b1, @dots{}, bn@} == @{a0 >> b0, a1 >> b1,
6946 @dots{}, an >> bn@}}@. Vector operands must have the same number of
6947 elements. 
6949 For convenience, it is allowed to use a binary vector operation
6950 where one operand is a scalar. In that case the compiler transforms
6951 the scalar operand into a vector where each element is the scalar from
6952 the operation. The transformation happens only if the scalar could be
6953 safely converted to the vector-element type.
6954 Consider the following code.
6956 @smallexample
6957 typedef int v4si __attribute__ ((vector_size (16)));
6959 v4si a, b, c;
6960 long l;
6962 a = b + 1;    /* a = b + @{1,1,1,1@}; */
6963 a = 2 * b;    /* a = @{2,2,2,2@} * b; */
6965 a = l + a;    /* Error, cannot convert long to int. */
6966 @end smallexample
6968 Vectors can be subscripted as if the vector were an array with
6969 the same number of elements and base type.  Out of bound accesses
6970 invoke undefined behavior at run time.  Warnings for out of bound
6971 accesses for vector subscription can be enabled with
6972 @option{-Warray-bounds}.
6974 Vector comparison is supported with standard comparison
6975 operators: @code{==, !=, <, <=, >, >=}. Comparison operands can be
6976 vector expressions of integer-type or real-type. Comparison between
6977 integer-type vectors and real-type vectors are not supported.  The
6978 result of the comparison is a vector of the same width and number of
6979 elements as the comparison operands with a signed integral element
6980 type.
6982 Vectors are compared element-wise producing 0 when comparison is false
6983 and -1 (constant of the appropriate type where all bits are set)
6984 otherwise. Consider the following example.
6986 @smallexample
6987 typedef int v4si __attribute__ ((vector_size (16)));
6989 v4si a = @{1,2,3,4@};
6990 v4si b = @{3,2,1,4@};
6991 v4si c;
6993 c = a >  b;     /* The result would be @{0, 0,-1, 0@}  */
6994 c = a == b;     /* The result would be @{0,-1, 0,-1@}  */
6995 @end smallexample
6997 Vector shuffling is available using functions
6998 @code{__builtin_shuffle (vec, mask)} and
6999 @code{__builtin_shuffle (vec0, vec1, mask)}.
7000 Both functions construct a permutation of elements from one or two
7001 vectors and return a vector of the same type as the input vector(s).
7002 The @var{mask} is an integral vector with the same width (@var{W})
7003 and element count (@var{N}) as the output vector.
7005 The elements of the input vectors are numbered in memory ordering of
7006 @var{vec0} beginning at 0 and @var{vec1} beginning at @var{N}.  The
7007 elements of @var{mask} are considered modulo @var{N} in the single-operand
7008 case and modulo @math{2*@var{N}} in the two-operand case.
7010 Consider the following example,
7012 @smallexample
7013 typedef int v4si __attribute__ ((vector_size (16)));
7015 v4si a = @{1,2,3,4@};
7016 v4si b = @{5,6,7,8@};
7017 v4si mask1 = @{0,1,1,3@};
7018 v4si mask2 = @{0,4,2,5@};
7019 v4si res;
7021 res = __builtin_shuffle (a, mask1);       /* res is @{1,2,2,4@}  */
7022 res = __builtin_shuffle (a, b, mask2);    /* res is @{1,5,3,6@}  */
7023 @end smallexample
7025 Note that @code{__builtin_shuffle} is intentionally semantically
7026 compatible with the OpenCL @code{shuffle} and @code{shuffle2} functions.
7028 You can declare variables and use them in function calls and returns, as
7029 well as in assignments and some casts.  You can specify a vector type as
7030 a return type for a function.  Vector types can also be used as function
7031 arguments.  It is possible to cast from one vector type to another,
7032 provided they are of the same size (in fact, you can also cast vectors
7033 to and from other datatypes of the same size).
7035 You cannot operate between vectors of different lengths or different
7036 signedness without a cast.
7038 @node Offsetof
7039 @section Offsetof
7040 @findex __builtin_offsetof
7042 GCC implements for both C and C++ a syntactic extension to implement
7043 the @code{offsetof} macro.
7045 @smallexample
7046 primary:
7047         "__builtin_offsetof" "(" @code{typename} "," offsetof_member_designator ")"
7049 offsetof_member_designator:
7050           @code{identifier}
7051         | offsetof_member_designator "." @code{identifier}
7052         | offsetof_member_designator "[" @code{expr} "]"
7053 @end smallexample
7055 This extension is sufficient such that
7057 @smallexample
7058 #define offsetof(@var{type}, @var{member})  __builtin_offsetof (@var{type}, @var{member})
7059 @end smallexample
7061 @noindent
7062 is a suitable definition of the @code{offsetof} macro.  In C++, @var{type}
7063 may be dependent.  In either case, @var{member} may consist of a single
7064 identifier, or a sequence of member accesses and array references.
7066 @node __sync Builtins
7067 @section Legacy __sync Built-in Functions for Atomic Memory Access
7069 The following built-in functions
7070 are intended to be compatible with those described
7071 in the @cite{Intel Itanium Processor-specific Application Binary Interface},
7072 section 7.4.  As such, they depart from the normal GCC practice of using
7073 the @samp{__builtin_} prefix, and further that they are overloaded such that
7074 they work on multiple types.
7076 The definition given in the Intel documentation allows only for the use of
7077 the types @code{int}, @code{long}, @code{long long} as well as their unsigned
7078 counterparts.  GCC allows any integral scalar or pointer type that is
7079 1, 2, 4 or 8 bytes in length.
7081 Not all operations are supported by all target processors.  If a particular
7082 operation cannot be implemented on the target processor, a warning is
7083 generated and a call an external function is generated.  The external
7084 function carries the same name as the built-in version,
7085 with an additional suffix
7086 @samp{_@var{n}} where @var{n} is the size of the data type.
7088 @c ??? Should we have a mechanism to suppress this warning?  This is almost
7089 @c useful for implementing the operation under the control of an external
7090 @c mutex.
7092 In most cases, these built-in functions are considered a @dfn{full barrier}.
7093 That is,
7094 no memory operand is moved across the operation, either forward or
7095 backward.  Further, instructions are issued as necessary to prevent the
7096 processor from speculating loads across the operation and from queuing stores
7097 after the operation.
7099 All of the routines are described in the Intel documentation to take
7100 ``an optional list of variables protected by the memory barrier''.  It's
7101 not clear what is meant by that; it could mean that @emph{only} the
7102 following variables are protected, or it could mean that these variables
7103 should in addition be protected.  At present GCC ignores this list and
7104 protects all variables that are globally accessible.  If in the future
7105 we make some use of this list, an empty list will continue to mean all
7106 globally accessible variables.
7108 @table @code
7109 @item @var{type} __sync_fetch_and_add (@var{type} *ptr, @var{type} value, ...)
7110 @itemx @var{type} __sync_fetch_and_sub (@var{type} *ptr, @var{type} value, ...)
7111 @itemx @var{type} __sync_fetch_and_or (@var{type} *ptr, @var{type} value, ...)
7112 @itemx @var{type} __sync_fetch_and_and (@var{type} *ptr, @var{type} value, ...)
7113 @itemx @var{type} __sync_fetch_and_xor (@var{type} *ptr, @var{type} value, ...)
7114 @itemx @var{type} __sync_fetch_and_nand (@var{type} *ptr, @var{type} value, ...)
7115 @findex __sync_fetch_and_add
7116 @findex __sync_fetch_and_sub
7117 @findex __sync_fetch_and_or
7118 @findex __sync_fetch_and_and
7119 @findex __sync_fetch_and_xor
7120 @findex __sync_fetch_and_nand
7121 These built-in functions perform the operation suggested by the name, and
7122 returns the value that had previously been in memory.  That is,
7124 @smallexample
7125 @{ tmp = *ptr; *ptr @var{op}= value; return tmp; @}
7126 @{ tmp = *ptr; *ptr = ~(tmp & value); return tmp; @}   // nand
7127 @end smallexample
7129 @emph{Note:} GCC 4.4 and later implement @code{__sync_fetch_and_nand}
7130 as @code{*ptr = ~(tmp & value)} instead of @code{*ptr = ~tmp & value}.
7132 @item @var{type} __sync_add_and_fetch (@var{type} *ptr, @var{type} value, ...)
7133 @itemx @var{type} __sync_sub_and_fetch (@var{type} *ptr, @var{type} value, ...)
7134 @itemx @var{type} __sync_or_and_fetch (@var{type} *ptr, @var{type} value, ...)
7135 @itemx @var{type} __sync_and_and_fetch (@var{type} *ptr, @var{type} value, ...)
7136 @itemx @var{type} __sync_xor_and_fetch (@var{type} *ptr, @var{type} value, ...)
7137 @itemx @var{type} __sync_nand_and_fetch (@var{type} *ptr, @var{type} value, ...)
7138 @findex __sync_add_and_fetch
7139 @findex __sync_sub_and_fetch
7140 @findex __sync_or_and_fetch
7141 @findex __sync_and_and_fetch
7142 @findex __sync_xor_and_fetch
7143 @findex __sync_nand_and_fetch
7144 These built-in functions perform the operation suggested by the name, and
7145 return the new value.  That is,
7147 @smallexample
7148 @{ *ptr @var{op}= value; return *ptr; @}
7149 @{ *ptr = ~(*ptr & value); return *ptr; @}   // nand
7150 @end smallexample
7152 @emph{Note:} GCC 4.4 and later implement @code{__sync_nand_and_fetch}
7153 as @code{*ptr = ~(*ptr & value)} instead of
7154 @code{*ptr = ~*ptr & value}.
7156 @item bool __sync_bool_compare_and_swap (@var{type} *ptr, @var{type} oldval, @var{type} newval, ...)
7157 @itemx @var{type} __sync_val_compare_and_swap (@var{type} *ptr, @var{type} oldval, @var{type} newval, ...)
7158 @findex __sync_bool_compare_and_swap
7159 @findex __sync_val_compare_and_swap
7160 These built-in functions perform an atomic compare and swap.
7161 That is, if the current
7162 value of @code{*@var{ptr}} is @var{oldval}, then write @var{newval} into
7163 @code{*@var{ptr}}.
7165 The ``bool'' version returns true if the comparison is successful and
7166 @var{newval} is written.  The ``val'' version returns the contents
7167 of @code{*@var{ptr}} before the operation.
7169 @item __sync_synchronize (...)
7170 @findex __sync_synchronize
7171 This built-in function issues a full memory barrier.
7173 @item @var{type} __sync_lock_test_and_set (@var{type} *ptr, @var{type} value, ...)
7174 @findex __sync_lock_test_and_set
7175 This built-in function, as described by Intel, is not a traditional test-and-set
7176 operation, but rather an atomic exchange operation.  It writes @var{value}
7177 into @code{*@var{ptr}}, and returns the previous contents of
7178 @code{*@var{ptr}}.
7180 Many targets have only minimal support for such locks, and do not support
7181 a full exchange operation.  In this case, a target may support reduced
7182 functionality here by which the @emph{only} valid value to store is the
7183 immediate constant 1.  The exact value actually stored in @code{*@var{ptr}}
7184 is implementation defined.
7186 This built-in function is not a full barrier,
7187 but rather an @dfn{acquire barrier}.
7188 This means that references after the operation cannot move to (or be
7189 speculated to) before the operation, but previous memory stores may not
7190 be globally visible yet, and previous memory loads may not yet be
7191 satisfied.
7193 @item void __sync_lock_release (@var{type} *ptr, ...)
7194 @findex __sync_lock_release
7195 This built-in function releases the lock acquired by
7196 @code{__sync_lock_test_and_set}.
7197 Normally this means writing the constant 0 to @code{*@var{ptr}}.
7199 This built-in function is not a full barrier,
7200 but rather a @dfn{release barrier}.
7201 This means that all previous memory stores are globally visible, and all
7202 previous memory loads have been satisfied, but following memory reads
7203 are not prevented from being speculated to before the barrier.
7204 @end table
7206 @node __atomic Builtins
7207 @section Built-in functions for memory model aware atomic operations
7209 The following built-in functions approximately match the requirements for
7210 C++11 memory model. Many are similar to the @samp{__sync} prefixed built-in
7211 functions, but all also have a memory model parameter.  These are all
7212 identified by being prefixed with @samp{__atomic}, and most are overloaded
7213 such that they work with multiple types.
7215 GCC allows any integral scalar or pointer type that is 1, 2, 4, or 8
7216 bytes in length. 16-byte integral types are also allowed if
7217 @samp{__int128} (@pxref{__int128}) is supported by the architecture.
7219 Target architectures are encouraged to provide their own patterns for
7220 each of these built-in functions.  If no target is provided, the original 
7221 non-memory model set of @samp{__sync} atomic built-in functions are
7222 utilized, along with any required synchronization fences surrounding it in
7223 order to achieve the proper behavior.  Execution in this case is subject
7224 to the same restrictions as those built-in functions.
7226 If there is no pattern or mechanism to provide a lock free instruction
7227 sequence, a call is made to an external routine with the same parameters
7228 to be resolved at run time.
7230 The four non-arithmetic functions (load, store, exchange, and 
7231 compare_exchange) all have a generic version as well.  This generic
7232 version works on any data type.  If the data type size maps to one
7233 of the integral sizes that may have lock free support, the generic
7234 version utilizes the lock free built-in function.  Otherwise an
7235 external call is left to be resolved at run time.  This external call is
7236 the same format with the addition of a @samp{size_t} parameter inserted
7237 as the first parameter indicating the size of the object being pointed to.
7238 All objects must be the same size.
7240 There are 6 different memory models that can be specified.  These map
7241 to the same names in the C++11 standard.  Refer there or to the
7242 @uref{http://gcc.gnu.org/wiki/Atomic/GCCMM/AtomicSync,GCC wiki on
7243 atomic synchronization} for more detailed definitions.  These memory
7244 models integrate both barriers to code motion as well as synchronization
7245 requirements with other threads. These are listed in approximately
7246 ascending order of strength. It is also possible to use target specific
7247 flags for memory model flags, like Hardware Lock Elision.
7249 @table  @code
7250 @item __ATOMIC_RELAXED
7251 No barriers or synchronization.
7252 @item __ATOMIC_CONSUME
7253 Data dependency only for both barrier and synchronization with another
7254 thread.
7255 @item __ATOMIC_ACQUIRE
7256 Barrier to hoisting of code and synchronizes with release (or stronger)
7257 semantic stores from another thread.
7258 @item __ATOMIC_RELEASE
7259 Barrier to sinking of code and synchronizes with acquire (or stronger)
7260 semantic loads from another thread.
7261 @item __ATOMIC_ACQ_REL
7262 Full barrier in both directions and synchronizes with acquire loads and
7263 release stores in another thread.
7264 @item __ATOMIC_SEQ_CST
7265 Full barrier in both directions and synchronizes with acquire loads and
7266 release stores in all threads.
7267 @end table
7269 When implementing patterns for these built-in functions, the memory model
7270 parameter can be ignored as long as the pattern implements the most
7271 restrictive @code{__ATOMIC_SEQ_CST} model.  Any of the other memory models
7272 execute correctly with this memory model but they may not execute as
7273 efficiently as they could with a more appropriate implementation of the
7274 relaxed requirements.
7276 Note that the C++11 standard allows for the memory model parameter to be
7277 determined at run time rather than at compile time.  These built-in
7278 functions map any run-time value to @code{__ATOMIC_SEQ_CST} rather
7279 than invoke a runtime library call or inline a switch statement.  This is
7280 standard compliant, safe, and the simplest approach for now.
7282 The memory model parameter is a signed int, but only the lower 8 bits are
7283 reserved for the memory model.  The remainder of the signed int is reserved
7284 for future use and should be 0.  Use of the predefined atomic values
7285 ensures proper usage.
7287 @deftypefn {Built-in Function} @var{type} __atomic_load_n (@var{type} *ptr, int memmodel)
7288 This built-in function implements an atomic load operation.  It returns the
7289 contents of @code{*@var{ptr}}.
7291 The valid memory model variants are
7292 @code{__ATOMIC_RELAXED}, @code{__ATOMIC_SEQ_CST}, @code{__ATOMIC_ACQUIRE},
7293 and @code{__ATOMIC_CONSUME}.
7295 @end deftypefn
7297 @deftypefn {Built-in Function} void __atomic_load (@var{type} *ptr, @var{type} *ret, int memmodel)
7298 This is the generic version of an atomic load.  It returns the
7299 contents of @code{*@var{ptr}} in @code{*@var{ret}}.
7301 @end deftypefn
7303 @deftypefn {Built-in Function} void __atomic_store_n (@var{type} *ptr, @var{type} val, int memmodel)
7304 This built-in function implements an atomic store operation.  It writes 
7305 @code{@var{val}} into @code{*@var{ptr}}.  
7307 The valid memory model variants are
7308 @code{__ATOMIC_RELAXED}, @code{__ATOMIC_SEQ_CST}, and @code{__ATOMIC_RELEASE}.
7310 @end deftypefn
7312 @deftypefn {Built-in Function} void __atomic_store (@var{type} *ptr, @var{type} *val, int memmodel)
7313 This is the generic version of an atomic store.  It stores the value
7314 of @code{*@var{val}} into @code{*@var{ptr}}.
7316 @end deftypefn
7318 @deftypefn {Built-in Function} @var{type} __atomic_exchange_n (@var{type} *ptr, @var{type} val, int memmodel)
7319 This built-in function implements an atomic exchange operation.  It writes
7320 @var{val} into @code{*@var{ptr}}, and returns the previous contents of
7321 @code{*@var{ptr}}.
7323 The valid memory model variants are
7324 @code{__ATOMIC_RELAXED}, @code{__ATOMIC_SEQ_CST}, @code{__ATOMIC_ACQUIRE},
7325 @code{__ATOMIC_RELEASE}, and @code{__ATOMIC_ACQ_REL}.
7327 @end deftypefn
7329 @deftypefn {Built-in Function} void __atomic_exchange (@var{type} *ptr, @var{type} *val, @var{type} *ret, int memmodel)
7330 This is the generic version of an atomic exchange.  It stores the
7331 contents of @code{*@var{val}} into @code{*@var{ptr}}. The original value
7332 of @code{*@var{ptr}} is copied into @code{*@var{ret}}.
7334 @end deftypefn
7336 @deftypefn {Built-in Function} bool __atomic_compare_exchange_n (@var{type} *ptr, @var{type} *expected, @var{type} desired, bool weak, int success_memmodel, int failure_memmodel)
7337 This built-in function implements an atomic compare and exchange operation.
7338 This compares the contents of @code{*@var{ptr}} with the contents of
7339 @code{*@var{expected}} and if equal, writes @var{desired} into
7340 @code{*@var{ptr}}.  If they are not equal, the current contents of
7341 @code{*@var{ptr}} is written into @code{*@var{expected}}.  @var{weak} is true
7342 for weak compare_exchange, and false for the strong variation.  Many targets 
7343 only offer the strong variation and ignore the parameter.  When in doubt, use
7344 the strong variation.
7346 True is returned if @var{desired} is written into
7347 @code{*@var{ptr}} and the execution is considered to conform to the
7348 memory model specified by @var{success_memmodel}.  There are no
7349 restrictions on what memory model can be used here.
7351 False is returned otherwise, and the execution is considered to conform
7352 to @var{failure_memmodel}. This memory model cannot be
7353 @code{__ATOMIC_RELEASE} nor @code{__ATOMIC_ACQ_REL}.  It also cannot be a
7354 stronger model than that specified by @var{success_memmodel}.
7356 @end deftypefn
7358 @deftypefn {Built-in Function} bool __atomic_compare_exchange (@var{type} *ptr, @var{type} *expected, @var{type} *desired, bool weak, int success_memmodel, int failure_memmodel)
7359 This built-in function implements the generic version of
7360 @code{__atomic_compare_exchange}.  The function is virtually identical to
7361 @code{__atomic_compare_exchange_n}, except the desired value is also a
7362 pointer.
7364 @end deftypefn
7366 @deftypefn {Built-in Function} @var{type} __atomic_add_fetch (@var{type} *ptr, @var{type} val, int memmodel)
7367 @deftypefnx {Built-in Function} @var{type} __atomic_sub_fetch (@var{type} *ptr, @var{type} val, int memmodel)
7368 @deftypefnx {Built-in Function} @var{type} __atomic_and_fetch (@var{type} *ptr, @var{type} val, int memmodel)
7369 @deftypefnx {Built-in Function} @var{type} __atomic_xor_fetch (@var{type} *ptr, @var{type} val, int memmodel)
7370 @deftypefnx {Built-in Function} @var{type} __atomic_or_fetch (@var{type} *ptr, @var{type} val, int memmodel)
7371 @deftypefnx {Built-in Function} @var{type} __atomic_nand_fetch (@var{type} *ptr, @var{type} val, int memmodel)
7372 These built-in functions perform the operation suggested by the name, and
7373 return the result of the operation. That is,
7375 @smallexample
7376 @{ *ptr @var{op}= val; return *ptr; @}
7377 @end smallexample
7379 All memory models are valid.
7381 @end deftypefn
7383 @deftypefn {Built-in Function} @var{type} __atomic_fetch_add (@var{type} *ptr, @var{type} val, int memmodel)
7384 @deftypefnx {Built-in Function} @var{type} __atomic_fetch_sub (@var{type} *ptr, @var{type} val, int memmodel)
7385 @deftypefnx {Built-in Function} @var{type} __atomic_fetch_and (@var{type} *ptr, @var{type} val, int memmodel)
7386 @deftypefnx {Built-in Function} @var{type} __atomic_fetch_xor (@var{type} *ptr, @var{type} val, int memmodel)
7387 @deftypefnx {Built-in Function} @var{type} __atomic_fetch_or (@var{type} *ptr, @var{type} val, int memmodel)
7388 @deftypefnx {Built-in Function} @var{type} __atomic_fetch_nand (@var{type} *ptr, @var{type} val, int memmodel)
7389 These built-in functions perform the operation suggested by the name, and
7390 return the value that had previously been in @code{*@var{ptr}}.  That is,
7392 @smallexample
7393 @{ tmp = *ptr; *ptr @var{op}= val; return tmp; @}
7394 @end smallexample
7396 All memory models are valid.
7398 @end deftypefn
7400 @deftypefn {Built-in Function} bool __atomic_test_and_set (void *ptr, int memmodel)
7402 This built-in function performs an atomic test-and-set operation on
7403 the byte at @code{*@var{ptr}}.  The byte is set to some implementation
7404 defined nonzero ``set'' value and the return value is @code{true} if and only
7405 if the previous contents were ``set''.
7407 All memory models are valid.
7409 @end deftypefn
7411 @deftypefn {Built-in Function} void __atomic_clear (bool *ptr, int memmodel)
7413 This built-in function performs an atomic clear operation on
7414 @code{*@var{ptr}}.  After the operation, @code{*@var{ptr}} contains 0.
7416 The valid memory model variants are
7417 @code{__ATOMIC_RELAXED}, @code{__ATOMIC_SEQ_CST}, and
7418 @code{__ATOMIC_RELEASE}.
7420 @end deftypefn
7422 @deftypefn {Built-in Function} void __atomic_thread_fence (int memmodel)
7424 This built-in function acts as a synchronization fence between threads
7425 based on the specified memory model.
7427 All memory orders are valid.
7429 @end deftypefn
7431 @deftypefn {Built-in Function} void __atomic_signal_fence (int memmodel)
7433 This built-in function acts as a synchronization fence between a thread
7434 and signal handlers based in the same thread.
7436 All memory orders are valid.
7438 @end deftypefn
7440 @deftypefn {Built-in Function} bool __atomic_always_lock_free (size_t size,  void *ptr)
7442 This built-in function returns true if objects of @var{size} bytes always
7443 generate lock free atomic instructions for the target architecture.  
7444 @var{size} must resolve to a compile-time constant and the result also
7445 resolves to a compile-time constant.
7447 @var{ptr} is an optional pointer to the object that may be used to determine
7448 alignment.  A value of 0 indicates typical alignment should be used.  The 
7449 compiler may also ignore this parameter.
7451 @smallexample
7452 if (_atomic_always_lock_free (sizeof (long long), 0))
7453 @end smallexample
7455 @end deftypefn
7457 @deftypefn {Built-in Function} bool __atomic_is_lock_free (size_t size, void *ptr)
7459 This built-in function returns true if objects of @var{size} bytes always
7460 generate lock free atomic instructions for the target architecture.  If
7461 it is not known to be lock free a call is made to a runtime routine named
7462 @code{__atomic_is_lock_free}.
7464 @var{ptr} is an optional pointer to the object that may be used to determine
7465 alignment.  A value of 0 indicates typical alignment should be used.  The 
7466 compiler may also ignore this parameter.
7467 @end deftypefn
7469 @node Object Size Checking
7470 @section Object Size Checking Built-in Functions
7471 @findex __builtin_object_size
7472 @findex __builtin___memcpy_chk
7473 @findex __builtin___mempcpy_chk
7474 @findex __builtin___memmove_chk
7475 @findex __builtin___memset_chk
7476 @findex __builtin___strcpy_chk
7477 @findex __builtin___stpcpy_chk
7478 @findex __builtin___strncpy_chk
7479 @findex __builtin___strcat_chk
7480 @findex __builtin___strncat_chk
7481 @findex __builtin___sprintf_chk
7482 @findex __builtin___snprintf_chk
7483 @findex __builtin___vsprintf_chk
7484 @findex __builtin___vsnprintf_chk
7485 @findex __builtin___printf_chk
7486 @findex __builtin___vprintf_chk
7487 @findex __builtin___fprintf_chk
7488 @findex __builtin___vfprintf_chk
7490 GCC implements a limited buffer overflow protection mechanism
7491 that can prevent some buffer overflow attacks.
7493 @deftypefn {Built-in Function} {size_t} __builtin_object_size (void * @var{ptr}, int @var{type})
7494 is a built-in construct that returns a constant number of bytes from
7495 @var{ptr} to the end of the object @var{ptr} pointer points to
7496 (if known at compile time).  @code{__builtin_object_size} never evaluates
7497 its arguments for side-effects.  If there are any side-effects in them, it
7498 returns @code{(size_t) -1} for @var{type} 0 or 1 and @code{(size_t) 0}
7499 for @var{type} 2 or 3.  If there are multiple objects @var{ptr} can
7500 point to and all of them are known at compile time, the returned number
7501 is the maximum of remaining byte counts in those objects if @var{type} & 2 is
7502 0 and minimum if nonzero.  If it is not possible to determine which objects
7503 @var{ptr} points to at compile time, @code{__builtin_object_size} should
7504 return @code{(size_t) -1} for @var{type} 0 or 1 and @code{(size_t) 0}
7505 for @var{type} 2 or 3.
7507 @var{type} is an integer constant from 0 to 3.  If the least significant
7508 bit is clear, objects are whole variables, if it is set, a closest
7509 surrounding subobject is considered the object a pointer points to.
7510 The second bit determines if maximum or minimum of remaining bytes
7511 is computed.
7513 @smallexample
7514 struct V @{ char buf1[10]; int b; char buf2[10]; @} var;
7515 char *p = &var.buf1[1], *q = &var.b;
7517 /* Here the object p points to is var.  */
7518 assert (__builtin_object_size (p, 0) == sizeof (var) - 1);
7519 /* The subobject p points to is var.buf1.  */
7520 assert (__builtin_object_size (p, 1) == sizeof (var.buf1) - 1);
7521 /* The object q points to is var.  */
7522 assert (__builtin_object_size (q, 0)
7523         == (char *) (&var + 1) - (char *) &var.b);
7524 /* The subobject q points to is var.b.  */
7525 assert (__builtin_object_size (q, 1) == sizeof (var.b));
7526 @end smallexample
7527 @end deftypefn
7529 There are built-in functions added for many common string operation
7530 functions, e.g., for @code{memcpy} @code{__builtin___memcpy_chk}
7531 built-in is provided.  This built-in has an additional last argument,
7532 which is the number of bytes remaining in object the @var{dest}
7533 argument points to or @code{(size_t) -1} if the size is not known.
7535 The built-in functions are optimized into the normal string functions
7536 like @code{memcpy} if the last argument is @code{(size_t) -1} or if
7537 it is known at compile time that the destination object will not
7538 be overflown.  If the compiler can determine at compile time the
7539 object will be always overflown, it issues a warning.
7541 The intended use can be e.g.@:
7543 @smallexample
7544 #undef memcpy
7545 #define bos0(dest) __builtin_object_size (dest, 0)
7546 #define memcpy(dest, src, n) \
7547   __builtin___memcpy_chk (dest, src, n, bos0 (dest))
7549 char *volatile p;
7550 char buf[10];
7551 /* It is unknown what object p points to, so this is optimized
7552    into plain memcpy - no checking is possible.  */
7553 memcpy (p, "abcde", n);
7554 /* Destination is known and length too.  It is known at compile
7555    time there will be no overflow.  */
7556 memcpy (&buf[5], "abcde", 5);
7557 /* Destination is known, but the length is not known at compile time.
7558    This will result in __memcpy_chk call that can check for overflow
7559    at run time.  */
7560 memcpy (&buf[5], "abcde", n);
7561 /* Destination is known and it is known at compile time there will
7562    be overflow.  There will be a warning and __memcpy_chk call that
7563    will abort the program at run time.  */
7564 memcpy (&buf[6], "abcde", 5);
7565 @end smallexample
7567 Such built-in functions are provided for @code{memcpy}, @code{mempcpy},
7568 @code{memmove}, @code{memset}, @code{strcpy}, @code{stpcpy}, @code{strncpy},
7569 @code{strcat} and @code{strncat}.
7571 There are also checking built-in functions for formatted output functions.
7572 @smallexample
7573 int __builtin___sprintf_chk (char *s, int flag, size_t os, const char *fmt, ...);
7574 int __builtin___snprintf_chk (char *s, size_t maxlen, int flag, size_t os,
7575                               const char *fmt, ...);
7576 int __builtin___vsprintf_chk (char *s, int flag, size_t os, const char *fmt,
7577                               va_list ap);
7578 int __builtin___vsnprintf_chk (char *s, size_t maxlen, int flag, size_t os,
7579                                const char *fmt, va_list ap);
7580 @end smallexample
7582 The added @var{flag} argument is passed unchanged to @code{__sprintf_chk}
7583 etc.@: functions and can contain implementation specific flags on what
7584 additional security measures the checking function might take, such as
7585 handling @code{%n} differently.
7587 The @var{os} argument is the object size @var{s} points to, like in the
7588 other built-in functions.  There is a small difference in the behavior
7589 though, if @var{os} is @code{(size_t) -1}, the built-in functions are
7590 optimized into the non-checking functions only if @var{flag} is 0, otherwise
7591 the checking function is called with @var{os} argument set to
7592 @code{(size_t) -1}.
7594 In addition to this, there are checking built-in functions
7595 @code{__builtin___printf_chk}, @code{__builtin___vprintf_chk},
7596 @code{__builtin___fprintf_chk} and @code{__builtin___vfprintf_chk}.
7597 These have just one additional argument, @var{flag}, right before
7598 format string @var{fmt}.  If the compiler is able to optimize them to
7599 @code{fputc} etc.@: functions, it does, otherwise the checking function
7600 is called and the @var{flag} argument passed to it.
7602 @node Other Builtins
7603 @section Other Built-in Functions Provided by GCC
7604 @cindex built-in functions
7605 @findex __builtin_fpclassify
7606 @findex __builtin_isfinite
7607 @findex __builtin_isnormal
7608 @findex __builtin_isgreater
7609 @findex __builtin_isgreaterequal
7610 @findex __builtin_isinf_sign
7611 @findex __builtin_isless
7612 @findex __builtin_islessequal
7613 @findex __builtin_islessgreater
7614 @findex __builtin_isunordered
7615 @findex __builtin_powi
7616 @findex __builtin_powif
7617 @findex __builtin_powil
7618 @findex _Exit
7619 @findex _exit
7620 @findex abort
7621 @findex abs
7622 @findex acos
7623 @findex acosf
7624 @findex acosh
7625 @findex acoshf
7626 @findex acoshl
7627 @findex acosl
7628 @findex alloca
7629 @findex asin
7630 @findex asinf
7631 @findex asinh
7632 @findex asinhf
7633 @findex asinhl
7634 @findex asinl
7635 @findex atan
7636 @findex atan2
7637 @findex atan2f
7638 @findex atan2l
7639 @findex atanf
7640 @findex atanh
7641 @findex atanhf
7642 @findex atanhl
7643 @findex atanl
7644 @findex bcmp
7645 @findex bzero
7646 @findex cabs
7647 @findex cabsf
7648 @findex cabsl
7649 @findex cacos
7650 @findex cacosf
7651 @findex cacosh
7652 @findex cacoshf
7653 @findex cacoshl
7654 @findex cacosl
7655 @findex calloc
7656 @findex carg
7657 @findex cargf
7658 @findex cargl
7659 @findex casin
7660 @findex casinf
7661 @findex casinh
7662 @findex casinhf
7663 @findex casinhl
7664 @findex casinl
7665 @findex catan
7666 @findex catanf
7667 @findex catanh
7668 @findex catanhf
7669 @findex catanhl
7670 @findex catanl
7671 @findex cbrt
7672 @findex cbrtf
7673 @findex cbrtl
7674 @findex ccos
7675 @findex ccosf
7676 @findex ccosh
7677 @findex ccoshf
7678 @findex ccoshl
7679 @findex ccosl
7680 @findex ceil
7681 @findex ceilf
7682 @findex ceill
7683 @findex cexp
7684 @findex cexpf
7685 @findex cexpl
7686 @findex cimag
7687 @findex cimagf
7688 @findex cimagl
7689 @findex clog
7690 @findex clogf
7691 @findex clogl
7692 @findex conj
7693 @findex conjf
7694 @findex conjl
7695 @findex copysign
7696 @findex copysignf
7697 @findex copysignl
7698 @findex cos
7699 @findex cosf
7700 @findex cosh
7701 @findex coshf
7702 @findex coshl
7703 @findex cosl
7704 @findex cpow
7705 @findex cpowf
7706 @findex cpowl
7707 @findex cproj
7708 @findex cprojf
7709 @findex cprojl
7710 @findex creal
7711 @findex crealf
7712 @findex creall
7713 @findex csin
7714 @findex csinf
7715 @findex csinh
7716 @findex csinhf
7717 @findex csinhl
7718 @findex csinl
7719 @findex csqrt
7720 @findex csqrtf
7721 @findex csqrtl
7722 @findex ctan
7723 @findex ctanf
7724 @findex ctanh
7725 @findex ctanhf
7726 @findex ctanhl
7727 @findex ctanl
7728 @findex dcgettext
7729 @findex dgettext
7730 @findex drem
7731 @findex dremf
7732 @findex dreml
7733 @findex erf
7734 @findex erfc
7735 @findex erfcf
7736 @findex erfcl
7737 @findex erff
7738 @findex erfl
7739 @findex exit
7740 @findex exp
7741 @findex exp10
7742 @findex exp10f
7743 @findex exp10l
7744 @findex exp2
7745 @findex exp2f
7746 @findex exp2l
7747 @findex expf
7748 @findex expl
7749 @findex expm1
7750 @findex expm1f
7751 @findex expm1l
7752 @findex fabs
7753 @findex fabsf
7754 @findex fabsl
7755 @findex fdim
7756 @findex fdimf
7757 @findex fdiml
7758 @findex ffs
7759 @findex floor
7760 @findex floorf
7761 @findex floorl
7762 @findex fma
7763 @findex fmaf
7764 @findex fmal
7765 @findex fmax
7766 @findex fmaxf
7767 @findex fmaxl
7768 @findex fmin
7769 @findex fminf
7770 @findex fminl
7771 @findex fmod
7772 @findex fmodf
7773 @findex fmodl
7774 @findex fprintf
7775 @findex fprintf_unlocked
7776 @findex fputs
7777 @findex fputs_unlocked
7778 @findex frexp
7779 @findex frexpf
7780 @findex frexpl
7781 @findex fscanf
7782 @findex gamma
7783 @findex gammaf
7784 @findex gammal
7785 @findex gamma_r
7786 @findex gammaf_r
7787 @findex gammal_r
7788 @findex gettext
7789 @findex hypot
7790 @findex hypotf
7791 @findex hypotl
7792 @findex ilogb
7793 @findex ilogbf
7794 @findex ilogbl
7795 @findex imaxabs
7796 @findex index
7797 @findex isalnum
7798 @findex isalpha
7799 @findex isascii
7800 @findex isblank
7801 @findex iscntrl
7802 @findex isdigit
7803 @findex isgraph
7804 @findex islower
7805 @findex isprint
7806 @findex ispunct
7807 @findex isspace
7808 @findex isupper
7809 @findex iswalnum
7810 @findex iswalpha
7811 @findex iswblank
7812 @findex iswcntrl
7813 @findex iswdigit
7814 @findex iswgraph
7815 @findex iswlower
7816 @findex iswprint
7817 @findex iswpunct
7818 @findex iswspace
7819 @findex iswupper
7820 @findex iswxdigit
7821 @findex isxdigit
7822 @findex j0
7823 @findex j0f
7824 @findex j0l
7825 @findex j1
7826 @findex j1f
7827 @findex j1l
7828 @findex jn
7829 @findex jnf
7830 @findex jnl
7831 @findex labs
7832 @findex ldexp
7833 @findex ldexpf
7834 @findex ldexpl
7835 @findex lgamma
7836 @findex lgammaf
7837 @findex lgammal
7838 @findex lgamma_r
7839 @findex lgammaf_r
7840 @findex lgammal_r
7841 @findex llabs
7842 @findex llrint
7843 @findex llrintf
7844 @findex llrintl
7845 @findex llround
7846 @findex llroundf
7847 @findex llroundl
7848 @findex log
7849 @findex log10
7850 @findex log10f
7851 @findex log10l
7852 @findex log1p
7853 @findex log1pf
7854 @findex log1pl
7855 @findex log2
7856 @findex log2f
7857 @findex log2l
7858 @findex logb
7859 @findex logbf
7860 @findex logbl
7861 @findex logf
7862 @findex logl
7863 @findex lrint
7864 @findex lrintf
7865 @findex lrintl
7866 @findex lround
7867 @findex lroundf
7868 @findex lroundl
7869 @findex malloc
7870 @findex memchr
7871 @findex memcmp
7872 @findex memcpy
7873 @findex mempcpy
7874 @findex memset
7875 @findex modf
7876 @findex modff
7877 @findex modfl
7878 @findex nearbyint
7879 @findex nearbyintf
7880 @findex nearbyintl
7881 @findex nextafter
7882 @findex nextafterf
7883 @findex nextafterl
7884 @findex nexttoward
7885 @findex nexttowardf
7886 @findex nexttowardl
7887 @findex pow
7888 @findex pow10
7889 @findex pow10f
7890 @findex pow10l
7891 @findex powf
7892 @findex powl
7893 @findex printf
7894 @findex printf_unlocked
7895 @findex putchar
7896 @findex puts
7897 @findex remainder
7898 @findex remainderf
7899 @findex remainderl
7900 @findex remquo
7901 @findex remquof
7902 @findex remquol
7903 @findex rindex
7904 @findex rint
7905 @findex rintf
7906 @findex rintl
7907 @findex round
7908 @findex roundf
7909 @findex roundl
7910 @findex scalb
7911 @findex scalbf
7912 @findex scalbl
7913 @findex scalbln
7914 @findex scalblnf
7915 @findex scalblnf
7916 @findex scalbn
7917 @findex scalbnf
7918 @findex scanfnl
7919 @findex signbit
7920 @findex signbitf
7921 @findex signbitl
7922 @findex signbitd32
7923 @findex signbitd64
7924 @findex signbitd128
7925 @findex significand
7926 @findex significandf
7927 @findex significandl
7928 @findex sin
7929 @findex sincos
7930 @findex sincosf
7931 @findex sincosl
7932 @findex sinf
7933 @findex sinh
7934 @findex sinhf
7935 @findex sinhl
7936 @findex sinl
7937 @findex snprintf
7938 @findex sprintf
7939 @findex sqrt
7940 @findex sqrtf
7941 @findex sqrtl
7942 @findex sscanf
7943 @findex stpcpy
7944 @findex stpncpy
7945 @findex strcasecmp
7946 @findex strcat
7947 @findex strchr
7948 @findex strcmp
7949 @findex strcpy
7950 @findex strcspn
7951 @findex strdup
7952 @findex strfmon
7953 @findex strftime
7954 @findex strlen
7955 @findex strncasecmp
7956 @findex strncat
7957 @findex strncmp
7958 @findex strncpy
7959 @findex strndup
7960 @findex strpbrk
7961 @findex strrchr
7962 @findex strspn
7963 @findex strstr
7964 @findex tan
7965 @findex tanf
7966 @findex tanh
7967 @findex tanhf
7968 @findex tanhl
7969 @findex tanl
7970 @findex tgamma
7971 @findex tgammaf
7972 @findex tgammal
7973 @findex toascii
7974 @findex tolower
7975 @findex toupper
7976 @findex towlower
7977 @findex towupper
7978 @findex trunc
7979 @findex truncf
7980 @findex truncl
7981 @findex vfprintf
7982 @findex vfscanf
7983 @findex vprintf
7984 @findex vscanf
7985 @findex vsnprintf
7986 @findex vsprintf
7987 @findex vsscanf
7988 @findex y0
7989 @findex y0f
7990 @findex y0l
7991 @findex y1
7992 @findex y1f
7993 @findex y1l
7994 @findex yn
7995 @findex ynf
7996 @findex ynl
7998 GCC provides a large number of built-in functions other than the ones
7999 mentioned above.  Some of these are for internal use in the processing
8000 of exceptions or variable-length argument lists and are not
8001 documented here because they may change from time to time; we do not
8002 recommend general use of these functions.
8004 The remaining functions are provided for optimization purposes.
8006 @opindex fno-builtin
8007 GCC includes built-in versions of many of the functions in the standard
8008 C library.  The versions prefixed with @code{__builtin_} are always
8009 treated as having the same meaning as the C library function even if you
8010 specify the @option{-fno-builtin} option.  (@pxref{C Dialect Options})
8011 Many of these functions are only optimized in certain cases; if they are
8012 not optimized in a particular case, a call to the library function is
8013 emitted.
8015 @opindex ansi
8016 @opindex std
8017 Outside strict ISO C mode (@option{-ansi}, @option{-std=c90},
8018 @option{-std=c99} or @option{-std=c11}), the functions
8019 @code{_exit}, @code{alloca}, @code{bcmp}, @code{bzero},
8020 @code{dcgettext}, @code{dgettext}, @code{dremf}, @code{dreml},
8021 @code{drem}, @code{exp10f}, @code{exp10l}, @code{exp10}, @code{ffsll},
8022 @code{ffsl}, @code{ffs}, @code{fprintf_unlocked},
8023 @code{fputs_unlocked}, @code{gammaf}, @code{gammal}, @code{gamma},
8024 @code{gammaf_r}, @code{gammal_r}, @code{gamma_r}, @code{gettext},
8025 @code{index}, @code{isascii}, @code{j0f}, @code{j0l}, @code{j0},
8026 @code{j1f}, @code{j1l}, @code{j1}, @code{jnf}, @code{jnl}, @code{jn},
8027 @code{lgammaf_r}, @code{lgammal_r}, @code{lgamma_r}, @code{mempcpy},
8028 @code{pow10f}, @code{pow10l}, @code{pow10}, @code{printf_unlocked},
8029 @code{rindex}, @code{scalbf}, @code{scalbl}, @code{scalb},
8030 @code{signbit}, @code{signbitf}, @code{signbitl}, @code{signbitd32},
8031 @code{signbitd64}, @code{signbitd128}, @code{significandf},
8032 @code{significandl}, @code{significand}, @code{sincosf},
8033 @code{sincosl}, @code{sincos}, @code{stpcpy}, @code{stpncpy},
8034 @code{strcasecmp}, @code{strdup}, @code{strfmon}, @code{strncasecmp},
8035 @code{strndup}, @code{toascii}, @code{y0f}, @code{y0l}, @code{y0},
8036 @code{y1f}, @code{y1l}, @code{y1}, @code{ynf}, @code{ynl} and
8037 @code{yn}
8038 may be handled as built-in functions.
8039 All these functions have corresponding versions
8040 prefixed with @code{__builtin_}, which may be used even in strict C90
8041 mode.
8043 The ISO C99 functions
8044 @code{_Exit}, @code{acoshf}, @code{acoshl}, @code{acosh}, @code{asinhf},
8045 @code{asinhl}, @code{asinh}, @code{atanhf}, @code{atanhl}, @code{atanh},
8046 @code{cabsf}, @code{cabsl}, @code{cabs}, @code{cacosf}, @code{cacoshf},
8047 @code{cacoshl}, @code{cacosh}, @code{cacosl}, @code{cacos},
8048 @code{cargf}, @code{cargl}, @code{carg}, @code{casinf}, @code{casinhf},
8049 @code{casinhl}, @code{casinh}, @code{casinl}, @code{casin},
8050 @code{catanf}, @code{catanhf}, @code{catanhl}, @code{catanh},
8051 @code{catanl}, @code{catan}, @code{cbrtf}, @code{cbrtl}, @code{cbrt},
8052 @code{ccosf}, @code{ccoshf}, @code{ccoshl}, @code{ccosh}, @code{ccosl},
8053 @code{ccos}, @code{cexpf}, @code{cexpl}, @code{cexp}, @code{cimagf},
8054 @code{cimagl}, @code{cimag}, @code{clogf}, @code{clogl}, @code{clog},
8055 @code{conjf}, @code{conjl}, @code{conj}, @code{copysignf}, @code{copysignl},
8056 @code{copysign}, @code{cpowf}, @code{cpowl}, @code{cpow}, @code{cprojf},
8057 @code{cprojl}, @code{cproj}, @code{crealf}, @code{creall}, @code{creal},
8058 @code{csinf}, @code{csinhf}, @code{csinhl}, @code{csinh}, @code{csinl},
8059 @code{csin}, @code{csqrtf}, @code{csqrtl}, @code{csqrt}, @code{ctanf},
8060 @code{ctanhf}, @code{ctanhl}, @code{ctanh}, @code{ctanl}, @code{ctan},
8061 @code{erfcf}, @code{erfcl}, @code{erfc}, @code{erff}, @code{erfl},
8062 @code{erf}, @code{exp2f}, @code{exp2l}, @code{exp2}, @code{expm1f},
8063 @code{expm1l}, @code{expm1}, @code{fdimf}, @code{fdiml}, @code{fdim},
8064 @code{fmaf}, @code{fmal}, @code{fmaxf}, @code{fmaxl}, @code{fmax},
8065 @code{fma}, @code{fminf}, @code{fminl}, @code{fmin}, @code{hypotf},
8066 @code{hypotl}, @code{hypot}, @code{ilogbf}, @code{ilogbl}, @code{ilogb},
8067 @code{imaxabs}, @code{isblank}, @code{iswblank}, @code{lgammaf},
8068 @code{lgammal}, @code{lgamma}, @code{llabs}, @code{llrintf}, @code{llrintl},
8069 @code{llrint}, @code{llroundf}, @code{llroundl}, @code{llround},
8070 @code{log1pf}, @code{log1pl}, @code{log1p}, @code{log2f}, @code{log2l},
8071 @code{log2}, @code{logbf}, @code{logbl}, @code{logb}, @code{lrintf},
8072 @code{lrintl}, @code{lrint}, @code{lroundf}, @code{lroundl},
8073 @code{lround}, @code{nearbyintf}, @code{nearbyintl}, @code{nearbyint},
8074 @code{nextafterf}, @code{nextafterl}, @code{nextafter},
8075 @code{nexttowardf}, @code{nexttowardl}, @code{nexttoward},
8076 @code{remainderf}, @code{remainderl}, @code{remainder}, @code{remquof},
8077 @code{remquol}, @code{remquo}, @code{rintf}, @code{rintl}, @code{rint},
8078 @code{roundf}, @code{roundl}, @code{round}, @code{scalblnf},
8079 @code{scalblnl}, @code{scalbln}, @code{scalbnf}, @code{scalbnl},
8080 @code{scalbn}, @code{snprintf}, @code{tgammaf}, @code{tgammal},
8081 @code{tgamma}, @code{truncf}, @code{truncl}, @code{trunc},
8082 @code{vfscanf}, @code{vscanf}, @code{vsnprintf} and @code{vsscanf}
8083 are handled as built-in functions
8084 except in strict ISO C90 mode (@option{-ansi} or @option{-std=c90}).
8086 There are also built-in versions of the ISO C99 functions
8087 @code{acosf}, @code{acosl}, @code{asinf}, @code{asinl}, @code{atan2f},
8088 @code{atan2l}, @code{atanf}, @code{atanl}, @code{ceilf}, @code{ceill},
8089 @code{cosf}, @code{coshf}, @code{coshl}, @code{cosl}, @code{expf},
8090 @code{expl}, @code{fabsf}, @code{fabsl}, @code{floorf}, @code{floorl},
8091 @code{fmodf}, @code{fmodl}, @code{frexpf}, @code{frexpl}, @code{ldexpf},
8092 @code{ldexpl}, @code{log10f}, @code{log10l}, @code{logf}, @code{logl},
8093 @code{modfl}, @code{modf}, @code{powf}, @code{powl}, @code{sinf},
8094 @code{sinhf}, @code{sinhl}, @code{sinl}, @code{sqrtf}, @code{sqrtl},
8095 @code{tanf}, @code{tanhf}, @code{tanhl} and @code{tanl}
8096 that are recognized in any mode since ISO C90 reserves these names for
8097 the purpose to which ISO C99 puts them.  All these functions have
8098 corresponding versions prefixed with @code{__builtin_}.
8100 The ISO C94 functions
8101 @code{iswalnum}, @code{iswalpha}, @code{iswcntrl}, @code{iswdigit},
8102 @code{iswgraph}, @code{iswlower}, @code{iswprint}, @code{iswpunct},
8103 @code{iswspace}, @code{iswupper}, @code{iswxdigit}, @code{towlower} and
8104 @code{towupper}
8105 are handled as built-in functions
8106 except in strict ISO C90 mode (@option{-ansi} or @option{-std=c90}).
8108 The ISO C90 functions
8109 @code{abort}, @code{abs}, @code{acos}, @code{asin}, @code{atan2},
8110 @code{atan}, @code{calloc}, @code{ceil}, @code{cosh}, @code{cos},
8111 @code{exit}, @code{exp}, @code{fabs}, @code{floor}, @code{fmod},
8112 @code{fprintf}, @code{fputs}, @code{frexp}, @code{fscanf},
8113 @code{isalnum}, @code{isalpha}, @code{iscntrl}, @code{isdigit},
8114 @code{isgraph}, @code{islower}, @code{isprint}, @code{ispunct},
8115 @code{isspace}, @code{isupper}, @code{isxdigit}, @code{tolower},
8116 @code{toupper}, @code{labs}, @code{ldexp}, @code{log10}, @code{log},
8117 @code{malloc}, @code{memchr}, @code{memcmp}, @code{memcpy},
8118 @code{memset}, @code{modf}, @code{pow}, @code{printf}, @code{putchar},
8119 @code{puts}, @code{scanf}, @code{sinh}, @code{sin}, @code{snprintf},
8120 @code{sprintf}, @code{sqrt}, @code{sscanf}, @code{strcat},
8121 @code{strchr}, @code{strcmp}, @code{strcpy}, @code{strcspn},
8122 @code{strlen}, @code{strncat}, @code{strncmp}, @code{strncpy},
8123 @code{strpbrk}, @code{strrchr}, @code{strspn}, @code{strstr},
8124 @code{tanh}, @code{tan}, @code{vfprintf}, @code{vprintf} and @code{vsprintf}
8125 are all recognized as built-in functions unless
8126 @option{-fno-builtin} is specified (or @option{-fno-builtin-@var{function}}
8127 is specified for an individual function).  All of these functions have
8128 corresponding versions prefixed with @code{__builtin_}.
8130 GCC provides built-in versions of the ISO C99 floating-point comparison
8131 macros that avoid raising exceptions for unordered operands.  They have
8132 the same names as the standard macros ( @code{isgreater},
8133 @code{isgreaterequal}, @code{isless}, @code{islessequal},
8134 @code{islessgreater}, and @code{isunordered}) , with @code{__builtin_}
8135 prefixed.  We intend for a library implementor to be able to simply
8136 @code{#define} each standard macro to its built-in equivalent.
8137 In the same fashion, GCC provides @code{fpclassify}, @code{isfinite},
8138 @code{isinf_sign} and @code{isnormal} built-ins used with
8139 @code{__builtin_} prefixed.  The @code{isinf} and @code{isnan}
8140 built-in functions appear both with and without the @code{__builtin_} prefix.
8142 @deftypefn {Built-in Function} int __builtin_types_compatible_p (@var{type1}, @var{type2})
8144 You can use the built-in function @code{__builtin_types_compatible_p} to
8145 determine whether two types are the same.
8147 This built-in function returns 1 if the unqualified versions of the
8148 types @var{type1} and @var{type2} (which are types, not expressions) are
8149 compatible, 0 otherwise.  The result of this built-in function can be
8150 used in integer constant expressions.
8152 This built-in function ignores top level qualifiers (e.g., @code{const},
8153 @code{volatile}).  For example, @code{int} is equivalent to @code{const
8154 int}.
8156 The type @code{int[]} and @code{int[5]} are compatible.  On the other
8157 hand, @code{int} and @code{char *} are not compatible, even if the size
8158 of their types, on the particular architecture are the same.  Also, the
8159 amount of pointer indirection is taken into account when determining
8160 similarity.  Consequently, @code{short *} is not similar to
8161 @code{short **}.  Furthermore, two types that are typedefed are
8162 considered compatible if their underlying types are compatible.
8164 An @code{enum} type is not considered to be compatible with another
8165 @code{enum} type even if both are compatible with the same integer
8166 type; this is what the C standard specifies.
8167 For example, @code{enum @{foo, bar@}} is not similar to
8168 @code{enum @{hot, dog@}}.
8170 You typically use this function in code whose execution varies
8171 depending on the arguments' types.  For example:
8173 @smallexample
8174 #define foo(x)                                                  \
8175   (@{                                                           \
8176     typeof (x) tmp = (x);                                       \
8177     if (__builtin_types_compatible_p (typeof (x), long double)) \
8178       tmp = foo_long_double (tmp);                              \
8179     else if (__builtin_types_compatible_p (typeof (x), double)) \
8180       tmp = foo_double (tmp);                                   \
8181     else if (__builtin_types_compatible_p (typeof (x), float))  \
8182       tmp = foo_float (tmp);                                    \
8183     else                                                        \
8184       abort ();                                                 \
8185     tmp;                                                        \
8186   @})
8187 @end smallexample
8189 @emph{Note:} This construct is only available for C@.
8191 @end deftypefn
8193 @deftypefn {Built-in Function} @var{type} __builtin_choose_expr (@var{const_exp}, @var{exp1}, @var{exp2})
8195 You can use the built-in function @code{__builtin_choose_expr} to
8196 evaluate code depending on the value of a constant expression.  This
8197 built-in function returns @var{exp1} if @var{const_exp}, which is an
8198 integer constant expression, is nonzero.  Otherwise it returns @var{exp2}.
8200 This built-in function is analogous to the @samp{? :} operator in C,
8201 except that the expression returned has its type unaltered by promotion
8202 rules.  Also, the built-in function does not evaluate the expression
8203 that is not chosen.  For example, if @var{const_exp} evaluates to true,
8204 @var{exp2} is not evaluated even if it has side-effects.
8206 This built-in function can return an lvalue if the chosen argument is an
8207 lvalue.
8209 If @var{exp1} is returned, the return type is the same as @var{exp1}'s
8210 type.  Similarly, if @var{exp2} is returned, its return type is the same
8211 as @var{exp2}.
8213 Example:
8215 @smallexample
8216 #define foo(x)                                                    \
8217   __builtin_choose_expr (                                         \
8218     __builtin_types_compatible_p (typeof (x), double),            \
8219     foo_double (x),                                               \
8220     __builtin_choose_expr (                                       \
8221       __builtin_types_compatible_p (typeof (x), float),           \
8222       foo_float (x),                                              \
8223       /* @r{The void expression results in a compile-time error}  \
8224          @r{when assigning the result to something.}  */          \
8225       (void)0))
8226 @end smallexample
8228 @emph{Note:} This construct is only available for C@.  Furthermore, the
8229 unused expression (@var{exp1} or @var{exp2} depending on the value of
8230 @var{const_exp}) may still generate syntax errors.  This may change in
8231 future revisions.
8233 @end deftypefn
8235 @deftypefn {Built-in Function} @var{type} __builtin_complex (@var{real}, @var{imag})
8237 The built-in function @code{__builtin_complex} is provided for use in
8238 implementing the ISO C11 macros @code{CMPLXF}, @code{CMPLX} and
8239 @code{CMPLXL}.  @var{real} and @var{imag} must have the same type, a
8240 real binary floating-point type, and the result has the corresponding
8241 complex type with real and imaginary parts @var{real} and @var{imag}.
8242 Unlike @samp{@var{real} + I * @var{imag}}, this works even when
8243 infinities, NaNs and negative zeros are involved.
8245 @end deftypefn
8247 @deftypefn {Built-in Function} int __builtin_constant_p (@var{exp})
8248 You can use the built-in function @code{__builtin_constant_p} to
8249 determine if a value is known to be constant at compile time and hence
8250 that GCC can perform constant-folding on expressions involving that
8251 value.  The argument of the function is the value to test.  The function
8252 returns the integer 1 if the argument is known to be a compile-time
8253 constant and 0 if it is not known to be a compile-time constant.  A
8254 return of 0 does not indicate that the value is @emph{not} a constant,
8255 but merely that GCC cannot prove it is a constant with the specified
8256 value of the @option{-O} option.
8258 You typically use this function in an embedded application where
8259 memory is a critical resource.  If you have some complex calculation,
8260 you may want it to be folded if it involves constants, but need to call
8261 a function if it does not.  For example:
8263 @smallexample
8264 #define Scale_Value(X)      \
8265   (__builtin_constant_p (X) \
8266   ? ((X) * SCALE + OFFSET) : Scale (X))
8267 @end smallexample
8269 You may use this built-in function in either a macro or an inline
8270 function.  However, if you use it in an inlined function and pass an
8271 argument of the function as the argument to the built-in, GCC 
8272 never returns 1 when you call the inline function with a string constant
8273 or compound literal (@pxref{Compound Literals}) and does not return 1
8274 when you pass a constant numeric value to the inline function unless you
8275 specify the @option{-O} option.
8277 You may also use @code{__builtin_constant_p} in initializers for static
8278 data.  For instance, you can write
8280 @smallexample
8281 static const int table[] = @{
8282    __builtin_constant_p (EXPRESSION) ? (EXPRESSION) : -1,
8283    /* @r{@dots{}} */
8285 @end smallexample
8287 @noindent
8288 This is an acceptable initializer even if @var{EXPRESSION} is not a
8289 constant expression, including the case where
8290 @code{__builtin_constant_p} returns 1 because @var{EXPRESSION} can be
8291 folded to a constant but @var{EXPRESSION} contains operands that are
8292 not otherwise permitted in a static initializer (for example,
8293 @code{0 && foo ()}).  GCC must be more conservative about evaluating the
8294 built-in in this case, because it has no opportunity to perform
8295 optimization.
8297 Previous versions of GCC did not accept this built-in in data
8298 initializers.  The earliest version where it is completely safe is
8299 3.0.1.
8300 @end deftypefn
8302 @deftypefn {Built-in Function} long __builtin_expect (long @var{exp}, long @var{c})
8303 @opindex fprofile-arcs
8304 You may use @code{__builtin_expect} to provide the compiler with
8305 branch prediction information.  In general, you should prefer to
8306 use actual profile feedback for this (@option{-fprofile-arcs}), as
8307 programmers are notoriously bad at predicting how their programs
8308 actually perform.  However, there are applications in which this
8309 data is hard to collect.
8311 The return value is the value of @var{exp}, which should be an integral
8312 expression.  The semantics of the built-in are that it is expected that
8313 @var{exp} == @var{c}.  For example:
8315 @smallexample
8316 if (__builtin_expect (x, 0))
8317   foo ();
8318 @end smallexample
8320 @noindent
8321 indicates that we do not expect to call @code{foo}, since
8322 we expect @code{x} to be zero.  Since you are limited to integral
8323 expressions for @var{exp}, you should use constructions such as
8325 @smallexample
8326 if (__builtin_expect (ptr != NULL, 1))
8327   foo (*ptr);
8328 @end smallexample
8330 @noindent
8331 when testing pointer or floating-point values.
8332 @end deftypefn
8334 @deftypefn {Built-in Function} void __builtin_trap (void)
8335 This function causes the program to exit abnormally.  GCC implements
8336 this function by using a target-dependent mechanism (such as
8337 intentionally executing an illegal instruction) or by calling
8338 @code{abort}.  The mechanism used may vary from release to release so
8339 you should not rely on any particular implementation.
8340 @end deftypefn
8342 @deftypefn {Built-in Function} void __builtin_unreachable (void)
8343 If control flow reaches the point of the @code{__builtin_unreachable},
8344 the program is undefined.  It is useful in situations where the
8345 compiler cannot deduce the unreachability of the code.
8347 One such case is immediately following an @code{asm} statement that
8348 either never terminates, or one that transfers control elsewhere
8349 and never returns.  In this example, without the
8350 @code{__builtin_unreachable}, GCC issues a warning that control
8351 reaches the end of a non-void function.  It also generates code
8352 to return after the @code{asm}.
8354 @smallexample
8355 int f (int c, int v)
8357   if (c)
8358     @{
8359       return v;
8360     @}
8361   else
8362     @{
8363       asm("jmp error_handler");
8364       __builtin_unreachable ();
8365     @}
8367 @end smallexample
8369 @noindent
8370 Because the @code{asm} statement unconditionally transfers control out
8371 of the function, control never reaches the end of the function
8372 body.  The @code{__builtin_unreachable} is in fact unreachable and
8373 communicates this fact to the compiler.
8375 Another use for @code{__builtin_unreachable} is following a call a
8376 function that never returns but that is not declared
8377 @code{__attribute__((noreturn))}, as in this example:
8379 @smallexample
8380 void function_that_never_returns (void);
8382 int g (int c)
8384   if (c)
8385     @{
8386       return 1;
8387     @}
8388   else
8389     @{
8390       function_that_never_returns ();
8391       __builtin_unreachable ();
8392     @}
8394 @end smallexample
8396 @end deftypefn
8398 @deftypefn {Built-in Function} void *__builtin_assume_aligned (const void *@var{exp}, size_t @var{align}, ...)
8399 This function returns its first argument, and allows the compiler
8400 to assume that the returned pointer is at least @var{align} bytes
8401 aligned.  This built-in can have either two or three arguments,
8402 if it has three, the third argument should have integer type, and
8403 if it is nonzero means misalignment offset.  For example:
8405 @smallexample
8406 void *x = __builtin_assume_aligned (arg, 16);
8407 @end smallexample
8409 @noindent
8410 means that the compiler can assume @code{x}, set to @code{arg}, is at least
8411 16-byte aligned, while:
8413 @smallexample
8414 void *x = __builtin_assume_aligned (arg, 32, 8);
8415 @end smallexample
8417 @noindent
8418 means that the compiler can assume for @code{x}, set to @code{arg}, that
8419 @code{(char *) x - 8} is 32-byte aligned.
8420 @end deftypefn
8422 @deftypefn {Built-in Function} int __builtin_LINE ()
8423 This function is the equivalent to the preprocessor @code{__LINE__}
8424 macro and returns the line number of the invocation of the built-in.
8425 @end deftypefn
8427 @deftypefn {Built-in Function} int __builtin_FUNCTION ()
8428 This function is the equivalent to the preprocessor @code{__FUNCTION__}
8429 macro and returns the function name the invocation of the built-in is in.
8430 @end deftypefn
8432 @deftypefn {Built-in Function} int __builtin_FILE ()
8433 This function is the equivalent to the preprocessor @code{__FILE__}
8434 macro and returns the file name the invocation of the built-in is in.
8435 @end deftypefn
8437 @deftypefn {Built-in Function} void __builtin___clear_cache (char *@var{begin}, char *@var{end})
8438 This function is used to flush the processor's instruction cache for
8439 the region of memory between @var{begin} inclusive and @var{end}
8440 exclusive.  Some targets require that the instruction cache be
8441 flushed, after modifying memory containing code, in order to obtain
8442 deterministic behavior.
8444 If the target does not require instruction cache flushes,
8445 @code{__builtin___clear_cache} has no effect.  Otherwise either
8446 instructions are emitted in-line to clear the instruction cache or a
8447 call to the @code{__clear_cache} function in libgcc is made.
8448 @end deftypefn
8450 @deftypefn {Built-in Function} void __builtin_prefetch (const void *@var{addr}, ...)
8451 This function is used to minimize cache-miss latency by moving data into
8452 a cache before it is accessed.
8453 You can insert calls to @code{__builtin_prefetch} into code for which
8454 you know addresses of data in memory that is likely to be accessed soon.
8455 If the target supports them, data prefetch instructions are generated.
8456 If the prefetch is done early enough before the access then the data will
8457 be in the cache by the time it is accessed.
8459 The value of @var{addr} is the address of the memory to prefetch.
8460 There are two optional arguments, @var{rw} and @var{locality}.
8461 The value of @var{rw} is a compile-time constant one or zero; one
8462 means that the prefetch is preparing for a write to the memory address
8463 and zero, the default, means that the prefetch is preparing for a read.
8464 The value @var{locality} must be a compile-time constant integer between
8465 zero and three.  A value of zero means that the data has no temporal
8466 locality, so it need not be left in the cache after the access.  A value
8467 of three means that the data has a high degree of temporal locality and
8468 should be left in all levels of cache possible.  Values of one and two
8469 mean, respectively, a low or moderate degree of temporal locality.  The
8470 default is three.
8472 @smallexample
8473 for (i = 0; i < n; i++)
8474   @{
8475     a[i] = a[i] + b[i];
8476     __builtin_prefetch (&a[i+j], 1, 1);
8477     __builtin_prefetch (&b[i+j], 0, 1);
8478     /* @r{@dots{}} */
8479   @}
8480 @end smallexample
8482 Data prefetch does not generate faults if @var{addr} is invalid, but
8483 the address expression itself must be valid.  For example, a prefetch
8484 of @code{p->next} does not fault if @code{p->next} is not a valid
8485 address, but evaluation faults if @code{p} is not a valid address.
8487 If the target does not support data prefetch, the address expression
8488 is evaluated if it includes side effects but no other code is generated
8489 and GCC does not issue a warning.
8490 @end deftypefn
8492 @deftypefn {Built-in Function} double __builtin_huge_val (void)
8493 Returns a positive infinity, if supported by the floating-point format,
8494 else @code{DBL_MAX}.  This function is suitable for implementing the
8495 ISO C macro @code{HUGE_VAL}.
8496 @end deftypefn
8498 @deftypefn {Built-in Function} float __builtin_huge_valf (void)
8499 Similar to @code{__builtin_huge_val}, except the return type is @code{float}.
8500 @end deftypefn
8502 @deftypefn {Built-in Function} {long double} __builtin_huge_vall (void)
8503 Similar to @code{__builtin_huge_val}, except the return
8504 type is @code{long double}.
8505 @end deftypefn
8507 @deftypefn {Built-in Function} int __builtin_fpclassify (int, int, int, int, int, ...)
8508 This built-in implements the C99 fpclassify functionality.  The first
8509 five int arguments should be the target library's notion of the
8510 possible FP classes and are used for return values.  They must be
8511 constant values and they must appear in this order: @code{FP_NAN},
8512 @code{FP_INFINITE}, @code{FP_NORMAL}, @code{FP_SUBNORMAL} and
8513 @code{FP_ZERO}.  The ellipsis is for exactly one floating-point value
8514 to classify.  GCC treats the last argument as type-generic, which
8515 means it does not do default promotion from float to double.
8516 @end deftypefn
8518 @deftypefn {Built-in Function} double __builtin_inf (void)
8519 Similar to @code{__builtin_huge_val}, except a warning is generated
8520 if the target floating-point format does not support infinities.
8521 @end deftypefn
8523 @deftypefn {Built-in Function} _Decimal32 __builtin_infd32 (void)
8524 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal32}.
8525 @end deftypefn
8527 @deftypefn {Built-in Function} _Decimal64 __builtin_infd64 (void)
8528 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal64}.
8529 @end deftypefn
8531 @deftypefn {Built-in Function} _Decimal128 __builtin_infd128 (void)
8532 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal128}.
8533 @end deftypefn
8535 @deftypefn {Built-in Function} float __builtin_inff (void)
8536 Similar to @code{__builtin_inf}, except the return type is @code{float}.
8537 This function is suitable for implementing the ISO C99 macro @code{INFINITY}.
8538 @end deftypefn
8540 @deftypefn {Built-in Function} {long double} __builtin_infl (void)
8541 Similar to @code{__builtin_inf}, except the return
8542 type is @code{long double}.
8543 @end deftypefn
8545 @deftypefn {Built-in Function} int __builtin_isinf_sign (...)
8546 Similar to @code{isinf}, except the return value is negative for
8547 an argument of @code{-Inf}.  Note while the parameter list is an
8548 ellipsis, this function only accepts exactly one floating-point
8549 argument.  GCC treats this parameter as type-generic, which means it
8550 does not do default promotion from float to double.
8551 @end deftypefn
8553 @deftypefn {Built-in Function} double __builtin_nan (const char *str)
8554 This is an implementation of the ISO C99 function @code{nan}.
8556 Since ISO C99 defines this function in terms of @code{strtod}, which we
8557 do not implement, a description of the parsing is in order.  The string
8558 is parsed as by @code{strtol}; that is, the base is recognized by
8559 leading @samp{0} or @samp{0x} prefixes.  The number parsed is placed
8560 in the significand such that the least significant bit of the number
8561 is at the least significant bit of the significand.  The number is
8562 truncated to fit the significand field provided.  The significand is
8563 forced to be a quiet NaN@.
8565 This function, if given a string literal all of which would have been
8566 consumed by @code{strtol}, is evaluated early enough that it is considered a
8567 compile-time constant.
8568 @end deftypefn
8570 @deftypefn {Built-in Function} _Decimal32 __builtin_nand32 (const char *str)
8571 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal32}.
8572 @end deftypefn
8574 @deftypefn {Built-in Function} _Decimal64 __builtin_nand64 (const char *str)
8575 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal64}.
8576 @end deftypefn
8578 @deftypefn {Built-in Function} _Decimal128 __builtin_nand128 (const char *str)
8579 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal128}.
8580 @end deftypefn
8582 @deftypefn {Built-in Function} float __builtin_nanf (const char *str)
8583 Similar to @code{__builtin_nan}, except the return type is @code{float}.
8584 @end deftypefn
8586 @deftypefn {Built-in Function} {long double} __builtin_nanl (const char *str)
8587 Similar to @code{__builtin_nan}, except the return type is @code{long double}.
8588 @end deftypefn
8590 @deftypefn {Built-in Function} double __builtin_nans (const char *str)
8591 Similar to @code{__builtin_nan}, except the significand is forced
8592 to be a signaling NaN@.  The @code{nans} function is proposed by
8593 @uref{http://www.open-std.org/jtc1/sc22/wg14/www/docs/n965.htm,,WG14 N965}.
8594 @end deftypefn
8596 @deftypefn {Built-in Function} float __builtin_nansf (const char *str)
8597 Similar to @code{__builtin_nans}, except the return type is @code{float}.
8598 @end deftypefn
8600 @deftypefn {Built-in Function} {long double} __builtin_nansl (const char *str)
8601 Similar to @code{__builtin_nans}, except the return type is @code{long double}.
8602 @end deftypefn
8604 @deftypefn {Built-in Function} int __builtin_ffs (unsigned int x)
8605 Returns one plus the index of the least significant 1-bit of @var{x}, or
8606 if @var{x} is zero, returns zero.
8607 @end deftypefn
8609 @deftypefn {Built-in Function} int __builtin_clz (unsigned int x)
8610 Returns the number of leading 0-bits in @var{x}, starting at the most
8611 significant bit position.  If @var{x} is 0, the result is undefined.
8612 @end deftypefn
8614 @deftypefn {Built-in Function} int __builtin_ctz (unsigned int x)
8615 Returns the number of trailing 0-bits in @var{x}, starting at the least
8616 significant bit position.  If @var{x} is 0, the result is undefined.
8617 @end deftypefn
8619 @deftypefn {Built-in Function} int __builtin_clrsb (int x)
8620 Returns the number of leading redundant sign bits in @var{x}, i.e.@: the
8621 number of bits following the most significant bit that are identical
8622 to it.  There are no special cases for 0 or other values. 
8623 @end deftypefn
8625 @deftypefn {Built-in Function} int __builtin_popcount (unsigned int x)
8626 Returns the number of 1-bits in @var{x}.
8627 @end deftypefn
8629 @deftypefn {Built-in Function} int __builtin_parity (unsigned int x)
8630 Returns the parity of @var{x}, i.e.@: the number of 1-bits in @var{x}
8631 modulo 2.
8632 @end deftypefn
8634 @deftypefn {Built-in Function} int __builtin_ffsl (unsigned long)
8635 Similar to @code{__builtin_ffs}, except the argument type is
8636 @code{unsigned long}.
8637 @end deftypefn
8639 @deftypefn {Built-in Function} int __builtin_clzl (unsigned long)
8640 Similar to @code{__builtin_clz}, except the argument type is
8641 @code{unsigned long}.
8642 @end deftypefn
8644 @deftypefn {Built-in Function} int __builtin_ctzl (unsigned long)
8645 Similar to @code{__builtin_ctz}, except the argument type is
8646 @code{unsigned long}.
8647 @end deftypefn
8649 @deftypefn {Built-in Function} int __builtin_clrsbl (long)
8650 Similar to @code{__builtin_clrsb}, except the argument type is
8651 @code{long}.
8652 @end deftypefn
8654 @deftypefn {Built-in Function} int __builtin_popcountl (unsigned long)
8655 Similar to @code{__builtin_popcount}, except the argument type is
8656 @code{unsigned long}.
8657 @end deftypefn
8659 @deftypefn {Built-in Function} int __builtin_parityl (unsigned long)
8660 Similar to @code{__builtin_parity}, except the argument type is
8661 @code{unsigned long}.
8662 @end deftypefn
8664 @deftypefn {Built-in Function} int __builtin_ffsll (unsigned long long)
8665 Similar to @code{__builtin_ffs}, except the argument type is
8666 @code{unsigned long long}.
8667 @end deftypefn
8669 @deftypefn {Built-in Function} int __builtin_clzll (unsigned long long)
8670 Similar to @code{__builtin_clz}, except the argument type is
8671 @code{unsigned long long}.
8672 @end deftypefn
8674 @deftypefn {Built-in Function} int __builtin_ctzll (unsigned long long)
8675 Similar to @code{__builtin_ctz}, except the argument type is
8676 @code{unsigned long long}.
8677 @end deftypefn
8679 @deftypefn {Built-in Function} int __builtin_clrsbll (long long)
8680 Similar to @code{__builtin_clrsb}, except the argument type is
8681 @code{long long}.
8682 @end deftypefn
8684 @deftypefn {Built-in Function} int __builtin_popcountll (unsigned long long)
8685 Similar to @code{__builtin_popcount}, except the argument type is
8686 @code{unsigned long long}.
8687 @end deftypefn
8689 @deftypefn {Built-in Function} int __builtin_parityll (unsigned long long)
8690 Similar to @code{__builtin_parity}, except the argument type is
8691 @code{unsigned long long}.
8692 @end deftypefn
8694 @deftypefn {Built-in Function} double __builtin_powi (double, int)
8695 Returns the first argument raised to the power of the second.  Unlike the
8696 @code{pow} function no guarantees about precision and rounding are made.
8697 @end deftypefn
8699 @deftypefn {Built-in Function} float __builtin_powif (float, int)
8700 Similar to @code{__builtin_powi}, except the argument and return types
8701 are @code{float}.
8702 @end deftypefn
8704 @deftypefn {Built-in Function} {long double} __builtin_powil (long double, int)
8705 Similar to @code{__builtin_powi}, except the argument and return types
8706 are @code{long double}.
8707 @end deftypefn
8709 @deftypefn {Built-in Function} uint16_t __builtin_bswap16 (uint16_t x)
8710 Returns @var{x} with the order of the bytes reversed; for example,
8711 @code{0xaabb} becomes @code{0xbbaa}.  Byte here always means
8712 exactly 8 bits.
8713 @end deftypefn
8715 @deftypefn {Built-in Function} uint32_t __builtin_bswap32 (uint32_t x)
8716 Similar to @code{__builtin_bswap16}, except the argument and return types
8717 are 32 bit.
8718 @end deftypefn
8720 @deftypefn {Built-in Function} uint64_t __builtin_bswap64 (uint64_t x)
8721 Similar to @code{__builtin_bswap32}, except the argument and return types
8722 are 64 bit.
8723 @end deftypefn
8725 @node Target Builtins
8726 @section Built-in Functions Specific to Particular Target Machines
8728 On some target machines, GCC supports many built-in functions specific
8729 to those machines.  Generally these generate calls to specific machine
8730 instructions, but allow the compiler to schedule those calls.
8732 @menu
8733 * Alpha Built-in Functions::
8734 * ARM iWMMXt Built-in Functions::
8735 * ARM NEON Intrinsics::
8736 * AVR Built-in Functions::
8737 * Blackfin Built-in Functions::
8738 * FR-V Built-in Functions::
8739 * X86 Built-in Functions::
8740 * MIPS DSP Built-in Functions::
8741 * MIPS Paired-Single Support::
8742 * MIPS Loongson Built-in Functions::
8743 * Other MIPS Built-in Functions::
8744 * picoChip Built-in Functions::
8745 * PowerPC Built-in Functions::
8746 * PowerPC AltiVec/VSX Built-in Functions::
8747 * RX Built-in Functions::
8748 * SH Built-in Functions::
8749 * SPARC VIS Built-in Functions::
8750 * SPU Built-in Functions::
8751 * TI C6X Built-in Functions::
8752 * TILE-Gx Built-in Functions::
8753 * TILEPro Built-in Functions::
8754 @end menu
8756 @node Alpha Built-in Functions
8757 @subsection Alpha Built-in Functions
8759 These built-in functions are available for the Alpha family of
8760 processors, depending on the command-line switches used.
8762 The following built-in functions are always available.  They
8763 all generate the machine instruction that is part of the name.
8765 @smallexample
8766 long __builtin_alpha_implver (void)
8767 long __builtin_alpha_rpcc (void)
8768 long __builtin_alpha_amask (long)
8769 long __builtin_alpha_cmpbge (long, long)
8770 long __builtin_alpha_extbl (long, long)
8771 long __builtin_alpha_extwl (long, long)
8772 long __builtin_alpha_extll (long, long)
8773 long __builtin_alpha_extql (long, long)
8774 long __builtin_alpha_extwh (long, long)
8775 long __builtin_alpha_extlh (long, long)
8776 long __builtin_alpha_extqh (long, long)
8777 long __builtin_alpha_insbl (long, long)
8778 long __builtin_alpha_inswl (long, long)
8779 long __builtin_alpha_insll (long, long)
8780 long __builtin_alpha_insql (long, long)
8781 long __builtin_alpha_inswh (long, long)
8782 long __builtin_alpha_inslh (long, long)
8783 long __builtin_alpha_insqh (long, long)
8784 long __builtin_alpha_mskbl (long, long)
8785 long __builtin_alpha_mskwl (long, long)
8786 long __builtin_alpha_mskll (long, long)
8787 long __builtin_alpha_mskql (long, long)
8788 long __builtin_alpha_mskwh (long, long)
8789 long __builtin_alpha_msklh (long, long)
8790 long __builtin_alpha_mskqh (long, long)
8791 long __builtin_alpha_umulh (long, long)
8792 long __builtin_alpha_zap (long, long)
8793 long __builtin_alpha_zapnot (long, long)
8794 @end smallexample
8796 The following built-in functions are always with @option{-mmax}
8797 or @option{-mcpu=@var{cpu}} where @var{cpu} is @code{pca56} or
8798 later.  They all generate the machine instruction that is part
8799 of the name.
8801 @smallexample
8802 long __builtin_alpha_pklb (long)
8803 long __builtin_alpha_pkwb (long)
8804 long __builtin_alpha_unpkbl (long)
8805 long __builtin_alpha_unpkbw (long)
8806 long __builtin_alpha_minub8 (long, long)
8807 long __builtin_alpha_minsb8 (long, long)
8808 long __builtin_alpha_minuw4 (long, long)
8809 long __builtin_alpha_minsw4 (long, long)
8810 long __builtin_alpha_maxub8 (long, long)
8811 long __builtin_alpha_maxsb8 (long, long)
8812 long __builtin_alpha_maxuw4 (long, long)
8813 long __builtin_alpha_maxsw4 (long, long)
8814 long __builtin_alpha_perr (long, long)
8815 @end smallexample
8817 The following built-in functions are always with @option{-mcix}
8818 or @option{-mcpu=@var{cpu}} where @var{cpu} is @code{ev67} or
8819 later.  They all generate the machine instruction that is part
8820 of the name.
8822 @smallexample
8823 long __builtin_alpha_cttz (long)
8824 long __builtin_alpha_ctlz (long)
8825 long __builtin_alpha_ctpop (long)
8826 @end smallexample
8828 The following built-in functions are available on systems that use the OSF/1
8829 PALcode.  Normally they invoke the @code{rduniq} and @code{wruniq}
8830 PAL calls, but when invoked with @option{-mtls-kernel}, they invoke
8831 @code{rdval} and @code{wrval}.
8833 @smallexample
8834 void *__builtin_thread_pointer (void)
8835 void __builtin_set_thread_pointer (void *)
8836 @end smallexample
8838 @node ARM iWMMXt Built-in Functions
8839 @subsection ARM iWMMXt Built-in Functions
8841 These built-in functions are available for the ARM family of
8842 processors when the @option{-mcpu=iwmmxt} switch is used:
8844 @smallexample
8845 typedef int v2si __attribute__ ((vector_size (8)));
8846 typedef short v4hi __attribute__ ((vector_size (8)));
8847 typedef char v8qi __attribute__ ((vector_size (8)));
8849 int __builtin_arm_getwcgr0 (void)
8850 void __builtin_arm_setwcgr0 (int)
8851 int __builtin_arm_getwcgr1 (void)
8852 void __builtin_arm_setwcgr1 (int)
8853 int __builtin_arm_getwcgr2 (void)
8854 void __builtin_arm_setwcgr2 (int)
8855 int __builtin_arm_getwcgr3 (void)
8856 void __builtin_arm_setwcgr3 (int)
8857 int __builtin_arm_textrmsb (v8qi, int)
8858 int __builtin_arm_textrmsh (v4hi, int)
8859 int __builtin_arm_textrmsw (v2si, int)
8860 int __builtin_arm_textrmub (v8qi, int)
8861 int __builtin_arm_textrmuh (v4hi, int)
8862 int __builtin_arm_textrmuw (v2si, int)
8863 v8qi __builtin_arm_tinsrb (v8qi, int, int)
8864 v4hi __builtin_arm_tinsrh (v4hi, int, int)
8865 v2si __builtin_arm_tinsrw (v2si, int, int)
8866 long long __builtin_arm_tmia (long long, int, int)
8867 long long __builtin_arm_tmiabb (long long, int, int)
8868 long long __builtin_arm_tmiabt (long long, int, int)
8869 long long __builtin_arm_tmiaph (long long, int, int)
8870 long long __builtin_arm_tmiatb (long long, int, int)
8871 long long __builtin_arm_tmiatt (long long, int, int)
8872 int __builtin_arm_tmovmskb (v8qi)
8873 int __builtin_arm_tmovmskh (v4hi)
8874 int __builtin_arm_tmovmskw (v2si)
8875 long long __builtin_arm_waccb (v8qi)
8876 long long __builtin_arm_wacch (v4hi)
8877 long long __builtin_arm_waccw (v2si)
8878 v8qi __builtin_arm_waddb (v8qi, v8qi)
8879 v8qi __builtin_arm_waddbss (v8qi, v8qi)
8880 v8qi __builtin_arm_waddbus (v8qi, v8qi)
8881 v4hi __builtin_arm_waddh (v4hi, v4hi)
8882 v4hi __builtin_arm_waddhss (v4hi, v4hi)
8883 v4hi __builtin_arm_waddhus (v4hi, v4hi)
8884 v2si __builtin_arm_waddw (v2si, v2si)
8885 v2si __builtin_arm_waddwss (v2si, v2si)
8886 v2si __builtin_arm_waddwus (v2si, v2si)
8887 v8qi __builtin_arm_walign (v8qi, v8qi, int)
8888 long long __builtin_arm_wand(long long, long long)
8889 long long __builtin_arm_wandn (long long, long long)
8890 v8qi __builtin_arm_wavg2b (v8qi, v8qi)
8891 v8qi __builtin_arm_wavg2br (v8qi, v8qi)
8892 v4hi __builtin_arm_wavg2h (v4hi, v4hi)
8893 v4hi __builtin_arm_wavg2hr (v4hi, v4hi)
8894 v8qi __builtin_arm_wcmpeqb (v8qi, v8qi)
8895 v4hi __builtin_arm_wcmpeqh (v4hi, v4hi)
8896 v2si __builtin_arm_wcmpeqw (v2si, v2si)
8897 v8qi __builtin_arm_wcmpgtsb (v8qi, v8qi)
8898 v4hi __builtin_arm_wcmpgtsh (v4hi, v4hi)
8899 v2si __builtin_arm_wcmpgtsw (v2si, v2si)
8900 v8qi __builtin_arm_wcmpgtub (v8qi, v8qi)
8901 v4hi __builtin_arm_wcmpgtuh (v4hi, v4hi)
8902 v2si __builtin_arm_wcmpgtuw (v2si, v2si)
8903 long long __builtin_arm_wmacs (long long, v4hi, v4hi)
8904 long long __builtin_arm_wmacsz (v4hi, v4hi)
8905 long long __builtin_arm_wmacu (long long, v4hi, v4hi)
8906 long long __builtin_arm_wmacuz (v4hi, v4hi)
8907 v4hi __builtin_arm_wmadds (v4hi, v4hi)
8908 v4hi __builtin_arm_wmaddu (v4hi, v4hi)
8909 v8qi __builtin_arm_wmaxsb (v8qi, v8qi)
8910 v4hi __builtin_arm_wmaxsh (v4hi, v4hi)
8911 v2si __builtin_arm_wmaxsw (v2si, v2si)
8912 v8qi __builtin_arm_wmaxub (v8qi, v8qi)
8913 v4hi __builtin_arm_wmaxuh (v4hi, v4hi)
8914 v2si __builtin_arm_wmaxuw (v2si, v2si)
8915 v8qi __builtin_arm_wminsb (v8qi, v8qi)
8916 v4hi __builtin_arm_wminsh (v4hi, v4hi)
8917 v2si __builtin_arm_wminsw (v2si, v2si)
8918 v8qi __builtin_arm_wminub (v8qi, v8qi)
8919 v4hi __builtin_arm_wminuh (v4hi, v4hi)
8920 v2si __builtin_arm_wminuw (v2si, v2si)
8921 v4hi __builtin_arm_wmulsm (v4hi, v4hi)
8922 v4hi __builtin_arm_wmulul (v4hi, v4hi)
8923 v4hi __builtin_arm_wmulum (v4hi, v4hi)
8924 long long __builtin_arm_wor (long long, long long)
8925 v2si __builtin_arm_wpackdss (long long, long long)
8926 v2si __builtin_arm_wpackdus (long long, long long)
8927 v8qi __builtin_arm_wpackhss (v4hi, v4hi)
8928 v8qi __builtin_arm_wpackhus (v4hi, v4hi)
8929 v4hi __builtin_arm_wpackwss (v2si, v2si)
8930 v4hi __builtin_arm_wpackwus (v2si, v2si)
8931 long long __builtin_arm_wrord (long long, long long)
8932 long long __builtin_arm_wrordi (long long, int)
8933 v4hi __builtin_arm_wrorh (v4hi, long long)
8934 v4hi __builtin_arm_wrorhi (v4hi, int)
8935 v2si __builtin_arm_wrorw (v2si, long long)
8936 v2si __builtin_arm_wrorwi (v2si, int)
8937 v2si __builtin_arm_wsadb (v2si, v8qi, v8qi)
8938 v2si __builtin_arm_wsadbz (v8qi, v8qi)
8939 v2si __builtin_arm_wsadh (v2si, v4hi, v4hi)
8940 v2si __builtin_arm_wsadhz (v4hi, v4hi)
8941 v4hi __builtin_arm_wshufh (v4hi, int)
8942 long long __builtin_arm_wslld (long long, long long)
8943 long long __builtin_arm_wslldi (long long, int)
8944 v4hi __builtin_arm_wsllh (v4hi, long long)
8945 v4hi __builtin_arm_wsllhi (v4hi, int)
8946 v2si __builtin_arm_wsllw (v2si, long long)
8947 v2si __builtin_arm_wsllwi (v2si, int)
8948 long long __builtin_arm_wsrad (long long, long long)
8949 long long __builtin_arm_wsradi (long long, int)
8950 v4hi __builtin_arm_wsrah (v4hi, long long)
8951 v4hi __builtin_arm_wsrahi (v4hi, int)
8952 v2si __builtin_arm_wsraw (v2si, long long)
8953 v2si __builtin_arm_wsrawi (v2si, int)
8954 long long __builtin_arm_wsrld (long long, long long)
8955 long long __builtin_arm_wsrldi (long long, int)
8956 v4hi __builtin_arm_wsrlh (v4hi, long long)
8957 v4hi __builtin_arm_wsrlhi (v4hi, int)
8958 v2si __builtin_arm_wsrlw (v2si, long long)
8959 v2si __builtin_arm_wsrlwi (v2si, int)
8960 v8qi __builtin_arm_wsubb (v8qi, v8qi)
8961 v8qi __builtin_arm_wsubbss (v8qi, v8qi)
8962 v8qi __builtin_arm_wsubbus (v8qi, v8qi)
8963 v4hi __builtin_arm_wsubh (v4hi, v4hi)
8964 v4hi __builtin_arm_wsubhss (v4hi, v4hi)
8965 v4hi __builtin_arm_wsubhus (v4hi, v4hi)
8966 v2si __builtin_arm_wsubw (v2si, v2si)
8967 v2si __builtin_arm_wsubwss (v2si, v2si)
8968 v2si __builtin_arm_wsubwus (v2si, v2si)
8969 v4hi __builtin_arm_wunpckehsb (v8qi)
8970 v2si __builtin_arm_wunpckehsh (v4hi)
8971 long long __builtin_arm_wunpckehsw (v2si)
8972 v4hi __builtin_arm_wunpckehub (v8qi)
8973 v2si __builtin_arm_wunpckehuh (v4hi)
8974 long long __builtin_arm_wunpckehuw (v2si)
8975 v4hi __builtin_arm_wunpckelsb (v8qi)
8976 v2si __builtin_arm_wunpckelsh (v4hi)
8977 long long __builtin_arm_wunpckelsw (v2si)
8978 v4hi __builtin_arm_wunpckelub (v8qi)
8979 v2si __builtin_arm_wunpckeluh (v4hi)
8980 long long __builtin_arm_wunpckeluw (v2si)
8981 v8qi __builtin_arm_wunpckihb (v8qi, v8qi)
8982 v4hi __builtin_arm_wunpckihh (v4hi, v4hi)
8983 v2si __builtin_arm_wunpckihw (v2si, v2si)
8984 v8qi __builtin_arm_wunpckilb (v8qi, v8qi)
8985 v4hi __builtin_arm_wunpckilh (v4hi, v4hi)
8986 v2si __builtin_arm_wunpckilw (v2si, v2si)
8987 long long __builtin_arm_wxor (long long, long long)
8988 long long __builtin_arm_wzero ()
8989 @end smallexample
8991 @node ARM NEON Intrinsics
8992 @subsection ARM NEON Intrinsics
8994 These built-in intrinsics for the ARM Advanced SIMD extension are available
8995 when the @option{-mfpu=neon} switch is used:
8997 @include arm-neon-intrinsics.texi
8999 @node AVR Built-in Functions
9000 @subsection AVR Built-in Functions
9002 For each built-in function for AVR, there is an equally named,
9003 uppercase built-in macro defined. That way users can easily query if
9004 or if not a specific built-in is implemented or not. For example, if
9005 @code{__builtin_avr_nop} is available the macro
9006 @code{__BUILTIN_AVR_NOP} is defined to @code{1} and undefined otherwise.
9008 The following built-in functions map to the respective machine
9009 instruction, i.e.@: @code{nop}, @code{sei}, @code{cli}, @code{sleep},
9010 @code{wdr}, @code{swap}, @code{fmul}, @code{fmuls}
9011 resp. @code{fmulsu}. The three @code{fmul*} built-ins are implemented
9012 as library call if no hardware multiplier is available.
9014 @smallexample
9015 void __builtin_avr_nop (void)
9016 void __builtin_avr_sei (void)
9017 void __builtin_avr_cli (void)
9018 void __builtin_avr_sleep (void)
9019 void __builtin_avr_wdr (void)
9020 unsigned char __builtin_avr_swap (unsigned char)
9021 unsigned int __builtin_avr_fmul (unsigned char, unsigned char)
9022 int __builtin_avr_fmuls (char, char)
9023 int __builtin_avr_fmulsu (char, unsigned char)
9024 @end smallexample
9026 In order to delay execution for a specific number of cycles, GCC
9027 implements
9028 @smallexample
9029 void __builtin_avr_delay_cycles (unsigned long ticks)
9030 @end smallexample
9032 @noindent
9033 @code{ticks} is the number of ticks to delay execution. Note that this
9034 built-in does not take into account the effect of interrupts that
9035 might increase delay time. @code{ticks} must be a compile-time
9036 integer constant; delays with a variable number of cycles are not supported.
9038 @smallexample
9039 char __builtin_avr_flash_segment (const __memx void*)
9040 @end smallexample
9042 @noindent
9043 This built-in takes a byte address to the 24-bit
9044 @ref{AVR Named Address Spaces,address space} @code{__memx} and returns
9045 the number of the flash segment (the 64 KiB chunk) where the address
9046 points to.  Counting starts at @code{0}.
9047 If the address does not point to flash memory, return @code{-1}.
9049 @smallexample
9050 unsigned char __builtin_avr_insert_bits (unsigned long map, unsigned char bits, unsigned char val)
9051 @end smallexample
9053 @noindent
9054 Insert bits from @var{bits} into @var{val} and return the resulting
9055 value. The nibbles of @var{map} determine how the insertion is
9056 performed: Let @var{X} be the @var{n}-th nibble of @var{map}
9057 @enumerate
9058 @item If @var{X} is @code{0xf},
9059 then the @var{n}-th bit of @var{val} is returned unaltered.
9061 @item If X is in the range 0@dots{}7,
9062 then the @var{n}-th result bit is set to the @var{X}-th bit of @var{bits}
9064 @item If X is in the range 8@dots{}@code{0xe},
9065 then the @var{n}-th result bit is undefined.
9066 @end enumerate
9068 @noindent
9069 One typical use case for this built-in is adjusting input and
9070 output values to non-contiguous port layouts. Some examples:
9072 @smallexample
9073 // same as val, bits is unused
9074 __builtin_avr_insert_bits (0xffffffff, bits, val)
9075 @end smallexample
9077 @smallexample
9078 // same as bits, val is unused
9079 __builtin_avr_insert_bits (0x76543210, bits, val)
9080 @end smallexample
9082 @smallexample
9083 // same as rotating bits by 4
9084 __builtin_avr_insert_bits (0x32107654, bits, 0)
9085 @end smallexample
9087 @smallexample
9088 // high nibble of result is the high nibble of val
9089 // low nibble of result is the low nibble of bits
9090 __builtin_avr_insert_bits (0xffff3210, bits, val)
9091 @end smallexample
9093 @smallexample
9094 // reverse the bit order of bits
9095 __builtin_avr_insert_bits (0x01234567, bits, 0)
9096 @end smallexample
9098 @node Blackfin Built-in Functions
9099 @subsection Blackfin Built-in Functions
9101 Currently, there are two Blackfin-specific built-in functions.  These are
9102 used for generating @code{CSYNC} and @code{SSYNC} machine insns without
9103 using inline assembly; by using these built-in functions the compiler can
9104 automatically add workarounds for hardware errata involving these
9105 instructions.  These functions are named as follows:
9107 @smallexample
9108 void __builtin_bfin_csync (void)
9109 void __builtin_bfin_ssync (void)
9110 @end smallexample
9112 @node FR-V Built-in Functions
9113 @subsection FR-V Built-in Functions
9115 GCC provides many FR-V-specific built-in functions.  In general,
9116 these functions are intended to be compatible with those described
9117 by @cite{FR-V Family, Softune C/C++ Compiler Manual (V6), Fujitsu
9118 Semiconductor}.  The two exceptions are @code{__MDUNPACKH} and
9119 @code{__MBTOHE}, the GCC forms of which pass 128-bit values by
9120 pointer rather than by value.
9122 Most of the functions are named after specific FR-V instructions.
9123 Such functions are said to be ``directly mapped'' and are summarized
9124 here in tabular form.
9126 @menu
9127 * Argument Types::
9128 * Directly-mapped Integer Functions::
9129 * Directly-mapped Media Functions::
9130 * Raw read/write Functions::
9131 * Other Built-in Functions::
9132 @end menu
9134 @node Argument Types
9135 @subsubsection Argument Types
9137 The arguments to the built-in functions can be divided into three groups:
9138 register numbers, compile-time constants and run-time values.  In order
9139 to make this classification clear at a glance, the arguments and return
9140 values are given the following pseudo types:
9142 @multitable @columnfractions .20 .30 .15 .35
9143 @item Pseudo type @tab Real C type @tab Constant? @tab Description
9144 @item @code{uh} @tab @code{unsigned short} @tab No @tab an unsigned halfword
9145 @item @code{uw1} @tab @code{unsigned int} @tab No @tab an unsigned word
9146 @item @code{sw1} @tab @code{int} @tab No @tab a signed word
9147 @item @code{uw2} @tab @code{unsigned long long} @tab No
9148 @tab an unsigned doubleword
9149 @item @code{sw2} @tab @code{long long} @tab No @tab a signed doubleword
9150 @item @code{const} @tab @code{int} @tab Yes @tab an integer constant
9151 @item @code{acc} @tab @code{int} @tab Yes @tab an ACC register number
9152 @item @code{iacc} @tab @code{int} @tab Yes @tab an IACC register number
9153 @end multitable
9155 These pseudo types are not defined by GCC, they are simply a notational
9156 convenience used in this manual.
9158 Arguments of type @code{uh}, @code{uw1}, @code{sw1}, @code{uw2}
9159 and @code{sw2} are evaluated at run time.  They correspond to
9160 register operands in the underlying FR-V instructions.
9162 @code{const} arguments represent immediate operands in the underlying
9163 FR-V instructions.  They must be compile-time constants.
9165 @code{acc} arguments are evaluated at compile time and specify the number
9166 of an accumulator register.  For example, an @code{acc} argument of 2
9167 selects the ACC2 register.
9169 @code{iacc} arguments are similar to @code{acc} arguments but specify the
9170 number of an IACC register.  See @pxref{Other Built-in Functions}
9171 for more details.
9173 @node Directly-mapped Integer Functions
9174 @subsubsection Directly-mapped Integer Functions
9176 The functions listed below map directly to FR-V I-type instructions.
9178 @multitable @columnfractions .45 .32 .23
9179 @item Function prototype @tab Example usage @tab Assembly output
9180 @item @code{sw1 __ADDSS (sw1, sw1)}
9181 @tab @code{@var{c} = __ADDSS (@var{a}, @var{b})}
9182 @tab @code{ADDSS @var{a},@var{b},@var{c}}
9183 @item @code{sw1 __SCAN (sw1, sw1)}
9184 @tab @code{@var{c} = __SCAN (@var{a}, @var{b})}
9185 @tab @code{SCAN @var{a},@var{b},@var{c}}
9186 @item @code{sw1 __SCUTSS (sw1)}
9187 @tab @code{@var{b} = __SCUTSS (@var{a})}
9188 @tab @code{SCUTSS @var{a},@var{b}}
9189 @item @code{sw1 __SLASS (sw1, sw1)}
9190 @tab @code{@var{c} = __SLASS (@var{a}, @var{b})}
9191 @tab @code{SLASS @var{a},@var{b},@var{c}}
9192 @item @code{void __SMASS (sw1, sw1)}
9193 @tab @code{__SMASS (@var{a}, @var{b})}
9194 @tab @code{SMASS @var{a},@var{b}}
9195 @item @code{void __SMSSS (sw1, sw1)}
9196 @tab @code{__SMSSS (@var{a}, @var{b})}
9197 @tab @code{SMSSS @var{a},@var{b}}
9198 @item @code{void __SMU (sw1, sw1)}
9199 @tab @code{__SMU (@var{a}, @var{b})}
9200 @tab @code{SMU @var{a},@var{b}}
9201 @item @code{sw2 __SMUL (sw1, sw1)}
9202 @tab @code{@var{c} = __SMUL (@var{a}, @var{b})}
9203 @tab @code{SMUL @var{a},@var{b},@var{c}}
9204 @item @code{sw1 __SUBSS (sw1, sw1)}
9205 @tab @code{@var{c} = __SUBSS (@var{a}, @var{b})}
9206 @tab @code{SUBSS @var{a},@var{b},@var{c}}
9207 @item @code{uw2 __UMUL (uw1, uw1)}
9208 @tab @code{@var{c} = __UMUL (@var{a}, @var{b})}
9209 @tab @code{UMUL @var{a},@var{b},@var{c}}
9210 @end multitable
9212 @node Directly-mapped Media Functions
9213 @subsubsection Directly-mapped Media Functions
9215 The functions listed below map directly to FR-V M-type instructions.
9217 @multitable @columnfractions .45 .32 .23
9218 @item Function prototype @tab Example usage @tab Assembly output
9219 @item @code{uw1 __MABSHS (sw1)}
9220 @tab @code{@var{b} = __MABSHS (@var{a})}
9221 @tab @code{MABSHS @var{a},@var{b}}
9222 @item @code{void __MADDACCS (acc, acc)}
9223 @tab @code{__MADDACCS (@var{b}, @var{a})}
9224 @tab @code{MADDACCS @var{a},@var{b}}
9225 @item @code{sw1 __MADDHSS (sw1, sw1)}
9226 @tab @code{@var{c} = __MADDHSS (@var{a}, @var{b})}
9227 @tab @code{MADDHSS @var{a},@var{b},@var{c}}
9228 @item @code{uw1 __MADDHUS (uw1, uw1)}
9229 @tab @code{@var{c} = __MADDHUS (@var{a}, @var{b})}
9230 @tab @code{MADDHUS @var{a},@var{b},@var{c}}
9231 @item @code{uw1 __MAND (uw1, uw1)}
9232 @tab @code{@var{c} = __MAND (@var{a}, @var{b})}
9233 @tab @code{MAND @var{a},@var{b},@var{c}}
9234 @item @code{void __MASACCS (acc, acc)}
9235 @tab @code{__MASACCS (@var{b}, @var{a})}
9236 @tab @code{MASACCS @var{a},@var{b}}
9237 @item @code{uw1 __MAVEH (uw1, uw1)}
9238 @tab @code{@var{c} = __MAVEH (@var{a}, @var{b})}
9239 @tab @code{MAVEH @var{a},@var{b},@var{c}}
9240 @item @code{uw2 __MBTOH (uw1)}
9241 @tab @code{@var{b} = __MBTOH (@var{a})}
9242 @tab @code{MBTOH @var{a},@var{b}}
9243 @item @code{void __MBTOHE (uw1 *, uw1)}
9244 @tab @code{__MBTOHE (&@var{b}, @var{a})}
9245 @tab @code{MBTOHE @var{a},@var{b}}
9246 @item @code{void __MCLRACC (acc)}
9247 @tab @code{__MCLRACC (@var{a})}
9248 @tab @code{MCLRACC @var{a}}
9249 @item @code{void __MCLRACCA (void)}
9250 @tab @code{__MCLRACCA ()}
9251 @tab @code{MCLRACCA}
9252 @item @code{uw1 __Mcop1 (uw1, uw1)}
9253 @tab @code{@var{c} = __Mcop1 (@var{a}, @var{b})}
9254 @tab @code{Mcop1 @var{a},@var{b},@var{c}}
9255 @item @code{uw1 __Mcop2 (uw1, uw1)}
9256 @tab @code{@var{c} = __Mcop2 (@var{a}, @var{b})}
9257 @tab @code{Mcop2 @var{a},@var{b},@var{c}}
9258 @item @code{uw1 __MCPLHI (uw2, const)}
9259 @tab @code{@var{c} = __MCPLHI (@var{a}, @var{b})}
9260 @tab @code{MCPLHI @var{a},#@var{b},@var{c}}
9261 @item @code{uw1 __MCPLI (uw2, const)}
9262 @tab @code{@var{c} = __MCPLI (@var{a}, @var{b})}
9263 @tab @code{MCPLI @var{a},#@var{b},@var{c}}
9264 @item @code{void __MCPXIS (acc, sw1, sw1)}
9265 @tab @code{__MCPXIS (@var{c}, @var{a}, @var{b})}
9266 @tab @code{MCPXIS @var{a},@var{b},@var{c}}
9267 @item @code{void __MCPXIU (acc, uw1, uw1)}
9268 @tab @code{__MCPXIU (@var{c}, @var{a}, @var{b})}
9269 @tab @code{MCPXIU @var{a},@var{b},@var{c}}
9270 @item @code{void __MCPXRS (acc, sw1, sw1)}
9271 @tab @code{__MCPXRS (@var{c}, @var{a}, @var{b})}
9272 @tab @code{MCPXRS @var{a},@var{b},@var{c}}
9273 @item @code{void __MCPXRU (acc, uw1, uw1)}
9274 @tab @code{__MCPXRU (@var{c}, @var{a}, @var{b})}
9275 @tab @code{MCPXRU @var{a},@var{b},@var{c}}
9276 @item @code{uw1 __MCUT (acc, uw1)}
9277 @tab @code{@var{c} = __MCUT (@var{a}, @var{b})}
9278 @tab @code{MCUT @var{a},@var{b},@var{c}}
9279 @item @code{uw1 __MCUTSS (acc, sw1)}
9280 @tab @code{@var{c} = __MCUTSS (@var{a}, @var{b})}
9281 @tab @code{MCUTSS @var{a},@var{b},@var{c}}
9282 @item @code{void __MDADDACCS (acc, acc)}
9283 @tab @code{__MDADDACCS (@var{b}, @var{a})}
9284 @tab @code{MDADDACCS @var{a},@var{b}}
9285 @item @code{void __MDASACCS (acc, acc)}
9286 @tab @code{__MDASACCS (@var{b}, @var{a})}
9287 @tab @code{MDASACCS @var{a},@var{b}}
9288 @item @code{uw2 __MDCUTSSI (acc, const)}
9289 @tab @code{@var{c} = __MDCUTSSI (@var{a}, @var{b})}
9290 @tab @code{MDCUTSSI @var{a},#@var{b},@var{c}}
9291 @item @code{uw2 __MDPACKH (uw2, uw2)}
9292 @tab @code{@var{c} = __MDPACKH (@var{a}, @var{b})}
9293 @tab @code{MDPACKH @var{a},@var{b},@var{c}}
9294 @item @code{uw2 __MDROTLI (uw2, const)}
9295 @tab @code{@var{c} = __MDROTLI (@var{a}, @var{b})}
9296 @tab @code{MDROTLI @var{a},#@var{b},@var{c}}
9297 @item @code{void __MDSUBACCS (acc, acc)}
9298 @tab @code{__MDSUBACCS (@var{b}, @var{a})}
9299 @tab @code{MDSUBACCS @var{a},@var{b}}
9300 @item @code{void __MDUNPACKH (uw1 *, uw2)}
9301 @tab @code{__MDUNPACKH (&@var{b}, @var{a})}
9302 @tab @code{MDUNPACKH @var{a},@var{b}}
9303 @item @code{uw2 __MEXPDHD (uw1, const)}
9304 @tab @code{@var{c} = __MEXPDHD (@var{a}, @var{b})}
9305 @tab @code{MEXPDHD @var{a},#@var{b},@var{c}}
9306 @item @code{uw1 __MEXPDHW (uw1, const)}
9307 @tab @code{@var{c} = __MEXPDHW (@var{a}, @var{b})}
9308 @tab @code{MEXPDHW @var{a},#@var{b},@var{c}}
9309 @item @code{uw1 __MHDSETH (uw1, const)}
9310 @tab @code{@var{c} = __MHDSETH (@var{a}, @var{b})}
9311 @tab @code{MHDSETH @var{a},#@var{b},@var{c}}
9312 @item @code{sw1 __MHDSETS (const)}
9313 @tab @code{@var{b} = __MHDSETS (@var{a})}
9314 @tab @code{MHDSETS #@var{a},@var{b}}
9315 @item @code{uw1 __MHSETHIH (uw1, const)}
9316 @tab @code{@var{b} = __MHSETHIH (@var{b}, @var{a})}
9317 @tab @code{MHSETHIH #@var{a},@var{b}}
9318 @item @code{sw1 __MHSETHIS (sw1, const)}
9319 @tab @code{@var{b} = __MHSETHIS (@var{b}, @var{a})}
9320 @tab @code{MHSETHIS #@var{a},@var{b}}
9321 @item @code{uw1 __MHSETLOH (uw1, const)}
9322 @tab @code{@var{b} = __MHSETLOH (@var{b}, @var{a})}
9323 @tab @code{MHSETLOH #@var{a},@var{b}}
9324 @item @code{sw1 __MHSETLOS (sw1, const)}
9325 @tab @code{@var{b} = __MHSETLOS (@var{b}, @var{a})}
9326 @tab @code{MHSETLOS #@var{a},@var{b}}
9327 @item @code{uw1 __MHTOB (uw2)}
9328 @tab @code{@var{b} = __MHTOB (@var{a})}
9329 @tab @code{MHTOB @var{a},@var{b}}
9330 @item @code{void __MMACHS (acc, sw1, sw1)}
9331 @tab @code{__MMACHS (@var{c}, @var{a}, @var{b})}
9332 @tab @code{MMACHS @var{a},@var{b},@var{c}}
9333 @item @code{void __MMACHU (acc, uw1, uw1)}
9334 @tab @code{__MMACHU (@var{c}, @var{a}, @var{b})}
9335 @tab @code{MMACHU @var{a},@var{b},@var{c}}
9336 @item @code{void __MMRDHS (acc, sw1, sw1)}
9337 @tab @code{__MMRDHS (@var{c}, @var{a}, @var{b})}
9338 @tab @code{MMRDHS @var{a},@var{b},@var{c}}
9339 @item @code{void __MMRDHU (acc, uw1, uw1)}
9340 @tab @code{__MMRDHU (@var{c}, @var{a}, @var{b})}
9341 @tab @code{MMRDHU @var{a},@var{b},@var{c}}
9342 @item @code{void __MMULHS (acc, sw1, sw1)}
9343 @tab @code{__MMULHS (@var{c}, @var{a}, @var{b})}
9344 @tab @code{MMULHS @var{a},@var{b},@var{c}}
9345 @item @code{void __MMULHU (acc, uw1, uw1)}
9346 @tab @code{__MMULHU (@var{c}, @var{a}, @var{b})}
9347 @tab @code{MMULHU @var{a},@var{b},@var{c}}
9348 @item @code{void __MMULXHS (acc, sw1, sw1)}
9349 @tab @code{__MMULXHS (@var{c}, @var{a}, @var{b})}
9350 @tab @code{MMULXHS @var{a},@var{b},@var{c}}
9351 @item @code{void __MMULXHU (acc, uw1, uw1)}
9352 @tab @code{__MMULXHU (@var{c}, @var{a}, @var{b})}
9353 @tab @code{MMULXHU @var{a},@var{b},@var{c}}
9354 @item @code{uw1 __MNOT (uw1)}
9355 @tab @code{@var{b} = __MNOT (@var{a})}
9356 @tab @code{MNOT @var{a},@var{b}}
9357 @item @code{uw1 __MOR (uw1, uw1)}
9358 @tab @code{@var{c} = __MOR (@var{a}, @var{b})}
9359 @tab @code{MOR @var{a},@var{b},@var{c}}
9360 @item @code{uw1 __MPACKH (uh, uh)}
9361 @tab @code{@var{c} = __MPACKH (@var{a}, @var{b})}
9362 @tab @code{MPACKH @var{a},@var{b},@var{c}}
9363 @item @code{sw2 __MQADDHSS (sw2, sw2)}
9364 @tab @code{@var{c} = __MQADDHSS (@var{a}, @var{b})}
9365 @tab @code{MQADDHSS @var{a},@var{b},@var{c}}
9366 @item @code{uw2 __MQADDHUS (uw2, uw2)}
9367 @tab @code{@var{c} = __MQADDHUS (@var{a}, @var{b})}
9368 @tab @code{MQADDHUS @var{a},@var{b},@var{c}}
9369 @item @code{void __MQCPXIS (acc, sw2, sw2)}
9370 @tab @code{__MQCPXIS (@var{c}, @var{a}, @var{b})}
9371 @tab @code{MQCPXIS @var{a},@var{b},@var{c}}
9372 @item @code{void __MQCPXIU (acc, uw2, uw2)}
9373 @tab @code{__MQCPXIU (@var{c}, @var{a}, @var{b})}
9374 @tab @code{MQCPXIU @var{a},@var{b},@var{c}}
9375 @item @code{void __MQCPXRS (acc, sw2, sw2)}
9376 @tab @code{__MQCPXRS (@var{c}, @var{a}, @var{b})}
9377 @tab @code{MQCPXRS @var{a},@var{b},@var{c}}
9378 @item @code{void __MQCPXRU (acc, uw2, uw2)}
9379 @tab @code{__MQCPXRU (@var{c}, @var{a}, @var{b})}
9380 @tab @code{MQCPXRU @var{a},@var{b},@var{c}}
9381 @item @code{sw2 __MQLCLRHS (sw2, sw2)}
9382 @tab @code{@var{c} = __MQLCLRHS (@var{a}, @var{b})}
9383 @tab @code{MQLCLRHS @var{a},@var{b},@var{c}}
9384 @item @code{sw2 __MQLMTHS (sw2, sw2)}
9385 @tab @code{@var{c} = __MQLMTHS (@var{a}, @var{b})}
9386 @tab @code{MQLMTHS @var{a},@var{b},@var{c}}
9387 @item @code{void __MQMACHS (acc, sw2, sw2)}
9388 @tab @code{__MQMACHS (@var{c}, @var{a}, @var{b})}
9389 @tab @code{MQMACHS @var{a},@var{b},@var{c}}
9390 @item @code{void __MQMACHU (acc, uw2, uw2)}
9391 @tab @code{__MQMACHU (@var{c}, @var{a}, @var{b})}
9392 @tab @code{MQMACHU @var{a},@var{b},@var{c}}
9393 @item @code{void __MQMACXHS (acc, sw2, sw2)}
9394 @tab @code{__MQMACXHS (@var{c}, @var{a}, @var{b})}
9395 @tab @code{MQMACXHS @var{a},@var{b},@var{c}}
9396 @item @code{void __MQMULHS (acc, sw2, sw2)}
9397 @tab @code{__MQMULHS (@var{c}, @var{a}, @var{b})}
9398 @tab @code{MQMULHS @var{a},@var{b},@var{c}}
9399 @item @code{void __MQMULHU (acc, uw2, uw2)}
9400 @tab @code{__MQMULHU (@var{c}, @var{a}, @var{b})}
9401 @tab @code{MQMULHU @var{a},@var{b},@var{c}}
9402 @item @code{void __MQMULXHS (acc, sw2, sw2)}
9403 @tab @code{__MQMULXHS (@var{c}, @var{a}, @var{b})}
9404 @tab @code{MQMULXHS @var{a},@var{b},@var{c}}
9405 @item @code{void __MQMULXHU (acc, uw2, uw2)}
9406 @tab @code{__MQMULXHU (@var{c}, @var{a}, @var{b})}
9407 @tab @code{MQMULXHU @var{a},@var{b},@var{c}}
9408 @item @code{sw2 __MQSATHS (sw2, sw2)}
9409 @tab @code{@var{c} = __MQSATHS (@var{a}, @var{b})}
9410 @tab @code{MQSATHS @var{a},@var{b},@var{c}}
9411 @item @code{uw2 __MQSLLHI (uw2, int)}
9412 @tab @code{@var{c} = __MQSLLHI (@var{a}, @var{b})}
9413 @tab @code{MQSLLHI @var{a},@var{b},@var{c}}
9414 @item @code{sw2 __MQSRAHI (sw2, int)}
9415 @tab @code{@var{c} = __MQSRAHI (@var{a}, @var{b})}
9416 @tab @code{MQSRAHI @var{a},@var{b},@var{c}}
9417 @item @code{sw2 __MQSUBHSS (sw2, sw2)}
9418 @tab @code{@var{c} = __MQSUBHSS (@var{a}, @var{b})}
9419 @tab @code{MQSUBHSS @var{a},@var{b},@var{c}}
9420 @item @code{uw2 __MQSUBHUS (uw2, uw2)}
9421 @tab @code{@var{c} = __MQSUBHUS (@var{a}, @var{b})}
9422 @tab @code{MQSUBHUS @var{a},@var{b},@var{c}}
9423 @item @code{void __MQXMACHS (acc, sw2, sw2)}
9424 @tab @code{__MQXMACHS (@var{c}, @var{a}, @var{b})}
9425 @tab @code{MQXMACHS @var{a},@var{b},@var{c}}
9426 @item @code{void __MQXMACXHS (acc, sw2, sw2)}
9427 @tab @code{__MQXMACXHS (@var{c}, @var{a}, @var{b})}
9428 @tab @code{MQXMACXHS @var{a},@var{b},@var{c}}
9429 @item @code{uw1 __MRDACC (acc)}
9430 @tab @code{@var{b} = __MRDACC (@var{a})}
9431 @tab @code{MRDACC @var{a},@var{b}}
9432 @item @code{uw1 __MRDACCG (acc)}
9433 @tab @code{@var{b} = __MRDACCG (@var{a})}
9434 @tab @code{MRDACCG @var{a},@var{b}}
9435 @item @code{uw1 __MROTLI (uw1, const)}
9436 @tab @code{@var{c} = __MROTLI (@var{a}, @var{b})}
9437 @tab @code{MROTLI @var{a},#@var{b},@var{c}}
9438 @item @code{uw1 __MROTRI (uw1, const)}
9439 @tab @code{@var{c} = __MROTRI (@var{a}, @var{b})}
9440 @tab @code{MROTRI @var{a},#@var{b},@var{c}}
9441 @item @code{sw1 __MSATHS (sw1, sw1)}
9442 @tab @code{@var{c} = __MSATHS (@var{a}, @var{b})}
9443 @tab @code{MSATHS @var{a},@var{b},@var{c}}
9444 @item @code{uw1 __MSATHU (uw1, uw1)}
9445 @tab @code{@var{c} = __MSATHU (@var{a}, @var{b})}
9446 @tab @code{MSATHU @var{a},@var{b},@var{c}}
9447 @item @code{uw1 __MSLLHI (uw1, const)}
9448 @tab @code{@var{c} = __MSLLHI (@var{a}, @var{b})}
9449 @tab @code{MSLLHI @var{a},#@var{b},@var{c}}
9450 @item @code{sw1 __MSRAHI (sw1, const)}
9451 @tab @code{@var{c} = __MSRAHI (@var{a}, @var{b})}
9452 @tab @code{MSRAHI @var{a},#@var{b},@var{c}}
9453 @item @code{uw1 __MSRLHI (uw1, const)}
9454 @tab @code{@var{c} = __MSRLHI (@var{a}, @var{b})}
9455 @tab @code{MSRLHI @var{a},#@var{b},@var{c}}
9456 @item @code{void __MSUBACCS (acc, acc)}
9457 @tab @code{__MSUBACCS (@var{b}, @var{a})}
9458 @tab @code{MSUBACCS @var{a},@var{b}}
9459 @item @code{sw1 __MSUBHSS (sw1, sw1)}
9460 @tab @code{@var{c} = __MSUBHSS (@var{a}, @var{b})}
9461 @tab @code{MSUBHSS @var{a},@var{b},@var{c}}
9462 @item @code{uw1 __MSUBHUS (uw1, uw1)}
9463 @tab @code{@var{c} = __MSUBHUS (@var{a}, @var{b})}
9464 @tab @code{MSUBHUS @var{a},@var{b},@var{c}}
9465 @item @code{void __MTRAP (void)}
9466 @tab @code{__MTRAP ()}
9467 @tab @code{MTRAP}
9468 @item @code{uw2 __MUNPACKH (uw1)}
9469 @tab @code{@var{b} = __MUNPACKH (@var{a})}
9470 @tab @code{MUNPACKH @var{a},@var{b}}
9471 @item @code{uw1 __MWCUT (uw2, uw1)}
9472 @tab @code{@var{c} = __MWCUT (@var{a}, @var{b})}
9473 @tab @code{MWCUT @var{a},@var{b},@var{c}}
9474 @item @code{void __MWTACC (acc, uw1)}
9475 @tab @code{__MWTACC (@var{b}, @var{a})}
9476 @tab @code{MWTACC @var{a},@var{b}}
9477 @item @code{void __MWTACCG (acc, uw1)}
9478 @tab @code{__MWTACCG (@var{b}, @var{a})}
9479 @tab @code{MWTACCG @var{a},@var{b}}
9480 @item @code{uw1 __MXOR (uw1, uw1)}
9481 @tab @code{@var{c} = __MXOR (@var{a}, @var{b})}
9482 @tab @code{MXOR @var{a},@var{b},@var{c}}
9483 @end multitable
9485 @node Raw read/write Functions
9486 @subsubsection Raw read/write Functions
9488 This sections describes built-in functions related to read and write
9489 instructions to access memory.  These functions generate
9490 @code{membar} instructions to flush the I/O load and stores where
9491 appropriate, as described in Fujitsu's manual described above.
9493 @table @code
9495 @item unsigned char __builtin_read8 (void *@var{data})
9496 @item unsigned short __builtin_read16 (void *@var{data})
9497 @item unsigned long __builtin_read32 (void *@var{data})
9498 @item unsigned long long __builtin_read64 (void *@var{data})
9500 @item void __builtin_write8 (void *@var{data}, unsigned char @var{datum})
9501 @item void __builtin_write16 (void *@var{data}, unsigned short @var{datum})
9502 @item void __builtin_write32 (void *@var{data}, unsigned long @var{datum})
9503 @item void __builtin_write64 (void *@var{data}, unsigned long long @var{datum})
9504 @end table
9506 @node Other Built-in Functions
9507 @subsubsection Other Built-in Functions
9509 This section describes built-in functions that are not named after
9510 a specific FR-V instruction.
9512 @table @code
9513 @item sw2 __IACCreadll (iacc @var{reg})
9514 Return the full 64-bit value of IACC0@.  The @var{reg} argument is reserved
9515 for future expansion and must be 0.
9517 @item sw1 __IACCreadl (iacc @var{reg})
9518 Return the value of IACC0H if @var{reg} is 0 and IACC0L if @var{reg} is 1.
9519 Other values of @var{reg} are rejected as invalid.
9521 @item void __IACCsetll (iacc @var{reg}, sw2 @var{x})
9522 Set the full 64-bit value of IACC0 to @var{x}.  The @var{reg} argument
9523 is reserved for future expansion and must be 0.
9525 @item void __IACCsetl (iacc @var{reg}, sw1 @var{x})
9526 Set IACC0H to @var{x} if @var{reg} is 0 and IACC0L to @var{x} if @var{reg}
9527 is 1.  Other values of @var{reg} are rejected as invalid.
9529 @item void __data_prefetch0 (const void *@var{x})
9530 Use the @code{dcpl} instruction to load the contents of address @var{x}
9531 into the data cache.
9533 @item void __data_prefetch (const void *@var{x})
9534 Use the @code{nldub} instruction to load the contents of address @var{x}
9535 into the data cache.  The instruction is issued in slot I1@.
9536 @end table
9538 @node X86 Built-in Functions
9539 @subsection X86 Built-in Functions
9541 These built-in functions are available for the i386 and x86-64 family
9542 of computers, depending on the command-line switches used.
9544 If you specify command-line switches such as @option{-msse},
9545 the compiler could use the extended instruction sets even if the built-ins
9546 are not used explicitly in the program.  For this reason, applications
9547 that perform run-time CPU detection must compile separate files for each
9548 supported architecture, using the appropriate flags.  In particular,
9549 the file containing the CPU detection code should be compiled without
9550 these options.
9552 The following machine modes are available for use with MMX built-in functions
9553 (@pxref{Vector Extensions}): @code{V2SI} for a vector of two 32-bit integers,
9554 @code{V4HI} for a vector of four 16-bit integers, and @code{V8QI} for a
9555 vector of eight 8-bit integers.  Some of the built-in functions operate on
9556 MMX registers as a whole 64-bit entity, these use @code{V1DI} as their mode.
9558 If 3DNow!@: extensions are enabled, @code{V2SF} is used as a mode for a vector
9559 of two 32-bit floating-point values.
9561 If SSE extensions are enabled, @code{V4SF} is used for a vector of four 32-bit
9562 floating-point values.  Some instructions use a vector of four 32-bit
9563 integers, these use @code{V4SI}.  Finally, some instructions operate on an
9564 entire vector register, interpreting it as a 128-bit integer, these use mode
9565 @code{TI}.
9567 In 64-bit mode, the x86-64 family of processors uses additional built-in
9568 functions for efficient use of @code{TF} (@code{__float128}) 128-bit
9569 floating point and @code{TC} 128-bit complex floating-point values.
9571 The following floating-point built-in functions are available in 64-bit
9572 mode.  All of them implement the function that is part of the name.
9574 @smallexample
9575 __float128 __builtin_fabsq (__float128)
9576 __float128 __builtin_copysignq (__float128, __float128)
9577 @end smallexample
9579 The following built-in function is always available.
9581 @table @code
9582 @item void __builtin_ia32_pause (void)
9583 Generates the @code{pause} machine instruction with a compiler memory
9584 barrier.
9585 @end table
9587 The following floating-point built-in functions are made available in the
9588 64-bit mode.
9590 @table @code
9591 @item __float128 __builtin_infq (void)
9592 Similar to @code{__builtin_inf}, except the return type is @code{__float128}.
9593 @findex __builtin_infq
9595 @item __float128 __builtin_huge_valq (void)
9596 Similar to @code{__builtin_huge_val}, except the return type is @code{__float128}.
9597 @findex __builtin_huge_valq
9598 @end table
9600 The following built-in functions are always available and can be used to
9601 check the target platform type.
9603 @deftypefn {Built-in Function} void __builtin_cpu_init (void)
9604 This function runs the CPU detection code to check the type of CPU and the
9605 features supported.  This built-in function needs to be invoked along with the built-in functions
9606 to check CPU type and features, @code{__builtin_cpu_is} and
9607 @code{__builtin_cpu_supports}, only when used in a function that is
9608 executed before any constructors are called.  The CPU detection code is
9609 automatically executed in a very high priority constructor.
9611 For example, this function has to be used in @code{ifunc} resolvers that
9612 check for CPU type using the built-in functions @code{__builtin_cpu_is}
9613 and @code{__builtin_cpu_supports}, or in constructors on targets that
9614 don't support constructor priority.
9615 @smallexample
9617 static void (*resolve_memcpy (void)) (void)
9619   // ifunc resolvers fire before constructors, explicitly call the init
9620   // function.
9621   __builtin_cpu_init ();
9622   if (__builtin_cpu_supports ("ssse3"))
9623     return ssse3_memcpy; // super fast memcpy with ssse3 instructions.
9624   else
9625     return default_memcpy;
9628 void *memcpy (void *, const void *, size_t)
9629      __attribute__ ((ifunc ("resolve_memcpy")));
9630 @end smallexample
9632 @end deftypefn
9634 @deftypefn {Built-in Function} int __builtin_cpu_is (const char *@var{cpuname})
9635 This function returns a positive integer if the run-time CPU
9636 is of type @var{cpuname}
9637 and returns @code{0} otherwise. The following CPU names can be detected:
9639 @table @samp
9640 @item intel
9641 Intel CPU.
9643 @item atom
9644 Intel Atom CPU.
9646 @item core2
9647 Intel Core 2 CPU.
9649 @item corei7
9650 Intel Core i7 CPU.
9652 @item nehalem
9653 Intel Core i7 Nehalem CPU.
9655 @item westmere
9656 Intel Core i7 Westmere CPU.
9658 @item sandybridge
9659 Intel Core i7 Sandy Bridge CPU.
9661 @item amd
9662 AMD CPU.
9664 @item amdfam10h
9665 AMD Family 10h CPU.
9667 @item barcelona
9668 AMD Family 10h Barcelona CPU.
9670 @item shanghai
9671 AMD Family 10h Shanghai CPU.
9673 @item istanbul
9674 AMD Family 10h Istanbul CPU.
9676 @item btver1
9677 AMD Family 14h CPU.
9679 @item amdfam15h
9680 AMD Family 15h CPU.
9682 @item bdver1
9683 AMD Family 15h Bulldozer version 1.
9685 @item bdver2
9686 AMD Family 15h Bulldozer version 2.
9688 @item bdver3
9689 AMD Family 15h Bulldozer version 3.
9691 @item btver2
9692 AMD Family 16h CPU.
9693 @end table
9695 Here is an example:
9696 @smallexample
9697 if (__builtin_cpu_is ("corei7"))
9698   @{
9699      do_corei7 (); // Core i7 specific implementation.
9700   @}
9701 else
9702   @{
9703      do_generic (); // Generic implementation.
9704   @}
9705 @end smallexample
9706 @end deftypefn
9708 @deftypefn {Built-in Function} int __builtin_cpu_supports (const char *@var{feature})
9709 This function returns a positive integer if the run-time CPU
9710 supports @var{feature}
9711 and returns @code{0} otherwise. The following features can be detected:
9713 @table @samp
9714 @item cmov
9715 CMOV instruction.
9716 @item mmx
9717 MMX instructions.
9718 @item popcnt
9719 POPCNT instruction.
9720 @item sse
9721 SSE instructions.
9722 @item sse2
9723 SSE2 instructions.
9724 @item sse3
9725 SSE3 instructions.
9726 @item ssse3
9727 SSSE3 instructions.
9728 @item sse4.1
9729 SSE4.1 instructions.
9730 @item sse4.2
9731 SSE4.2 instructions.
9732 @item avx
9733 AVX instructions.
9734 @item avx2
9735 AVX2 instructions.
9736 @end table
9738 Here is an example:
9739 @smallexample
9740 if (__builtin_cpu_supports ("popcnt"))
9741   @{
9742      asm("popcnt %1,%0" : "=r"(count) : "rm"(n) : "cc");
9743   @}
9744 else
9745   @{
9746      count = generic_countbits (n); //generic implementation.
9747   @}
9748 @end smallexample
9749 @end deftypefn
9752 The following built-in functions are made available by @option{-mmmx}.
9753 All of them generate the machine instruction that is part of the name.
9755 @smallexample
9756 v8qi __builtin_ia32_paddb (v8qi, v8qi)
9757 v4hi __builtin_ia32_paddw (v4hi, v4hi)
9758 v2si __builtin_ia32_paddd (v2si, v2si)
9759 v8qi __builtin_ia32_psubb (v8qi, v8qi)
9760 v4hi __builtin_ia32_psubw (v4hi, v4hi)
9761 v2si __builtin_ia32_psubd (v2si, v2si)
9762 v8qi __builtin_ia32_paddsb (v8qi, v8qi)
9763 v4hi __builtin_ia32_paddsw (v4hi, v4hi)
9764 v8qi __builtin_ia32_psubsb (v8qi, v8qi)
9765 v4hi __builtin_ia32_psubsw (v4hi, v4hi)
9766 v8qi __builtin_ia32_paddusb (v8qi, v8qi)
9767 v4hi __builtin_ia32_paddusw (v4hi, v4hi)
9768 v8qi __builtin_ia32_psubusb (v8qi, v8qi)
9769 v4hi __builtin_ia32_psubusw (v4hi, v4hi)
9770 v4hi __builtin_ia32_pmullw (v4hi, v4hi)
9771 v4hi __builtin_ia32_pmulhw (v4hi, v4hi)
9772 di __builtin_ia32_pand (di, di)
9773 di __builtin_ia32_pandn (di,di)
9774 di __builtin_ia32_por (di, di)
9775 di __builtin_ia32_pxor (di, di)
9776 v8qi __builtin_ia32_pcmpeqb (v8qi, v8qi)
9777 v4hi __builtin_ia32_pcmpeqw (v4hi, v4hi)
9778 v2si __builtin_ia32_pcmpeqd (v2si, v2si)
9779 v8qi __builtin_ia32_pcmpgtb (v8qi, v8qi)
9780 v4hi __builtin_ia32_pcmpgtw (v4hi, v4hi)
9781 v2si __builtin_ia32_pcmpgtd (v2si, v2si)
9782 v8qi __builtin_ia32_punpckhbw (v8qi, v8qi)
9783 v4hi __builtin_ia32_punpckhwd (v4hi, v4hi)
9784 v2si __builtin_ia32_punpckhdq (v2si, v2si)
9785 v8qi __builtin_ia32_punpcklbw (v8qi, v8qi)
9786 v4hi __builtin_ia32_punpcklwd (v4hi, v4hi)
9787 v2si __builtin_ia32_punpckldq (v2si, v2si)
9788 v8qi __builtin_ia32_packsswb (v4hi, v4hi)
9789 v4hi __builtin_ia32_packssdw (v2si, v2si)
9790 v8qi __builtin_ia32_packuswb (v4hi, v4hi)
9792 v4hi __builtin_ia32_psllw (v4hi, v4hi)
9793 v2si __builtin_ia32_pslld (v2si, v2si)
9794 v1di __builtin_ia32_psllq (v1di, v1di)
9795 v4hi __builtin_ia32_psrlw (v4hi, v4hi)
9796 v2si __builtin_ia32_psrld (v2si, v2si)
9797 v1di __builtin_ia32_psrlq (v1di, v1di)
9798 v4hi __builtin_ia32_psraw (v4hi, v4hi)
9799 v2si __builtin_ia32_psrad (v2si, v2si)
9800 v4hi __builtin_ia32_psllwi (v4hi, int)
9801 v2si __builtin_ia32_pslldi (v2si, int)
9802 v1di __builtin_ia32_psllqi (v1di, int)
9803 v4hi __builtin_ia32_psrlwi (v4hi, int)
9804 v2si __builtin_ia32_psrldi (v2si, int)
9805 v1di __builtin_ia32_psrlqi (v1di, int)
9806 v4hi __builtin_ia32_psrawi (v4hi, int)
9807 v2si __builtin_ia32_psradi (v2si, int)
9809 @end smallexample
9811 The following built-in functions are made available either with
9812 @option{-msse}, or with a combination of @option{-m3dnow} and
9813 @option{-march=athlon}.  All of them generate the machine
9814 instruction that is part of the name.
9816 @smallexample
9817 v4hi __builtin_ia32_pmulhuw (v4hi, v4hi)
9818 v8qi __builtin_ia32_pavgb (v8qi, v8qi)
9819 v4hi __builtin_ia32_pavgw (v4hi, v4hi)
9820 v1di __builtin_ia32_psadbw (v8qi, v8qi)
9821 v8qi __builtin_ia32_pmaxub (v8qi, v8qi)
9822 v4hi __builtin_ia32_pmaxsw (v4hi, v4hi)
9823 v8qi __builtin_ia32_pminub (v8qi, v8qi)
9824 v4hi __builtin_ia32_pminsw (v4hi, v4hi)
9825 int __builtin_ia32_pextrw (v4hi, int)
9826 v4hi __builtin_ia32_pinsrw (v4hi, int, int)
9827 int __builtin_ia32_pmovmskb (v8qi)
9828 void __builtin_ia32_maskmovq (v8qi, v8qi, char *)
9829 void __builtin_ia32_movntq (di *, di)
9830 void __builtin_ia32_sfence (void)
9831 @end smallexample
9833 The following built-in functions are available when @option{-msse} is used.
9834 All of them generate the machine instruction that is part of the name.
9836 @smallexample
9837 int __builtin_ia32_comieq (v4sf, v4sf)
9838 int __builtin_ia32_comineq (v4sf, v4sf)
9839 int __builtin_ia32_comilt (v4sf, v4sf)
9840 int __builtin_ia32_comile (v4sf, v4sf)
9841 int __builtin_ia32_comigt (v4sf, v4sf)
9842 int __builtin_ia32_comige (v4sf, v4sf)
9843 int __builtin_ia32_ucomieq (v4sf, v4sf)
9844 int __builtin_ia32_ucomineq (v4sf, v4sf)
9845 int __builtin_ia32_ucomilt (v4sf, v4sf)
9846 int __builtin_ia32_ucomile (v4sf, v4sf)
9847 int __builtin_ia32_ucomigt (v4sf, v4sf)
9848 int __builtin_ia32_ucomige (v4sf, v4sf)
9849 v4sf __builtin_ia32_addps (v4sf, v4sf)
9850 v4sf __builtin_ia32_subps (v4sf, v4sf)
9851 v4sf __builtin_ia32_mulps (v4sf, v4sf)
9852 v4sf __builtin_ia32_divps (v4sf, v4sf)
9853 v4sf __builtin_ia32_addss (v4sf, v4sf)
9854 v4sf __builtin_ia32_subss (v4sf, v4sf)
9855 v4sf __builtin_ia32_mulss (v4sf, v4sf)
9856 v4sf __builtin_ia32_divss (v4sf, v4sf)
9857 v4si __builtin_ia32_cmpeqps (v4sf, v4sf)
9858 v4si __builtin_ia32_cmpltps (v4sf, v4sf)
9859 v4si __builtin_ia32_cmpleps (v4sf, v4sf)
9860 v4si __builtin_ia32_cmpgtps (v4sf, v4sf)
9861 v4si __builtin_ia32_cmpgeps (v4sf, v4sf)
9862 v4si __builtin_ia32_cmpunordps (v4sf, v4sf)
9863 v4si __builtin_ia32_cmpneqps (v4sf, v4sf)
9864 v4si __builtin_ia32_cmpnltps (v4sf, v4sf)
9865 v4si __builtin_ia32_cmpnleps (v4sf, v4sf)
9866 v4si __builtin_ia32_cmpngtps (v4sf, v4sf)
9867 v4si __builtin_ia32_cmpngeps (v4sf, v4sf)
9868 v4si __builtin_ia32_cmpordps (v4sf, v4sf)
9869 v4si __builtin_ia32_cmpeqss (v4sf, v4sf)
9870 v4si __builtin_ia32_cmpltss (v4sf, v4sf)
9871 v4si __builtin_ia32_cmpless (v4sf, v4sf)
9872 v4si __builtin_ia32_cmpunordss (v4sf, v4sf)
9873 v4si __builtin_ia32_cmpneqss (v4sf, v4sf)
9874 v4si __builtin_ia32_cmpnlts (v4sf, v4sf)
9875 v4si __builtin_ia32_cmpnless (v4sf, v4sf)
9876 v4si __builtin_ia32_cmpordss (v4sf, v4sf)
9877 v4sf __builtin_ia32_maxps (v4sf, v4sf)
9878 v4sf __builtin_ia32_maxss (v4sf, v4sf)
9879 v4sf __builtin_ia32_minps (v4sf, v4sf)
9880 v4sf __builtin_ia32_minss (v4sf, v4sf)
9881 v4sf __builtin_ia32_andps (v4sf, v4sf)
9882 v4sf __builtin_ia32_andnps (v4sf, v4sf)
9883 v4sf __builtin_ia32_orps (v4sf, v4sf)
9884 v4sf __builtin_ia32_xorps (v4sf, v4sf)
9885 v4sf __builtin_ia32_movss (v4sf, v4sf)
9886 v4sf __builtin_ia32_movhlps (v4sf, v4sf)
9887 v4sf __builtin_ia32_movlhps (v4sf, v4sf)
9888 v4sf __builtin_ia32_unpckhps (v4sf, v4sf)
9889 v4sf __builtin_ia32_unpcklps (v4sf, v4sf)
9890 v4sf __builtin_ia32_cvtpi2ps (v4sf, v2si)
9891 v4sf __builtin_ia32_cvtsi2ss (v4sf, int)
9892 v2si __builtin_ia32_cvtps2pi (v4sf)
9893 int __builtin_ia32_cvtss2si (v4sf)
9894 v2si __builtin_ia32_cvttps2pi (v4sf)
9895 int __builtin_ia32_cvttss2si (v4sf)
9896 v4sf __builtin_ia32_rcpps (v4sf)
9897 v4sf __builtin_ia32_rsqrtps (v4sf)
9898 v4sf __builtin_ia32_sqrtps (v4sf)
9899 v4sf __builtin_ia32_rcpss (v4sf)
9900 v4sf __builtin_ia32_rsqrtss (v4sf)
9901 v4sf __builtin_ia32_sqrtss (v4sf)
9902 v4sf __builtin_ia32_shufps (v4sf, v4sf, int)
9903 void __builtin_ia32_movntps (float *, v4sf)
9904 int __builtin_ia32_movmskps (v4sf)
9905 @end smallexample
9907 The following built-in functions are available when @option{-msse} is used.
9909 @table @code
9910 @item v4sf __builtin_ia32_loadaps (float *)
9911 Generates the @code{movaps} machine instruction as a load from memory.
9912 @item void __builtin_ia32_storeaps (float *, v4sf)
9913 Generates the @code{movaps} machine instruction as a store to memory.
9914 @item v4sf __builtin_ia32_loadups (float *)
9915 Generates the @code{movups} machine instruction as a load from memory.
9916 @item void __builtin_ia32_storeups (float *, v4sf)
9917 Generates the @code{movups} machine instruction as a store to memory.
9918 @item v4sf __builtin_ia32_loadsss (float *)
9919 Generates the @code{movss} machine instruction as a load from memory.
9920 @item void __builtin_ia32_storess (float *, v4sf)
9921 Generates the @code{movss} machine instruction as a store to memory.
9922 @item v4sf __builtin_ia32_loadhps (v4sf, const v2sf *)
9923 Generates the @code{movhps} machine instruction as a load from memory.
9924 @item v4sf __builtin_ia32_loadlps (v4sf, const v2sf *)
9925 Generates the @code{movlps} machine instruction as a load from memory
9926 @item void __builtin_ia32_storehps (v2sf *, v4sf)
9927 Generates the @code{movhps} machine instruction as a store to memory.
9928 @item void __builtin_ia32_storelps (v2sf *, v4sf)
9929 Generates the @code{movlps} machine instruction as a store to memory.
9930 @end table
9932 The following built-in functions are available when @option{-msse2} is used.
9933 All of them generate the machine instruction that is part of the name.
9935 @smallexample
9936 int __builtin_ia32_comisdeq (v2df, v2df)
9937 int __builtin_ia32_comisdlt (v2df, v2df)
9938 int __builtin_ia32_comisdle (v2df, v2df)
9939 int __builtin_ia32_comisdgt (v2df, v2df)
9940 int __builtin_ia32_comisdge (v2df, v2df)
9941 int __builtin_ia32_comisdneq (v2df, v2df)
9942 int __builtin_ia32_ucomisdeq (v2df, v2df)
9943 int __builtin_ia32_ucomisdlt (v2df, v2df)
9944 int __builtin_ia32_ucomisdle (v2df, v2df)
9945 int __builtin_ia32_ucomisdgt (v2df, v2df)
9946 int __builtin_ia32_ucomisdge (v2df, v2df)
9947 int __builtin_ia32_ucomisdneq (v2df, v2df)
9948 v2df __builtin_ia32_cmpeqpd (v2df, v2df)
9949 v2df __builtin_ia32_cmpltpd (v2df, v2df)
9950 v2df __builtin_ia32_cmplepd (v2df, v2df)
9951 v2df __builtin_ia32_cmpgtpd (v2df, v2df)
9952 v2df __builtin_ia32_cmpgepd (v2df, v2df)
9953 v2df __builtin_ia32_cmpunordpd (v2df, v2df)
9954 v2df __builtin_ia32_cmpneqpd (v2df, v2df)
9955 v2df __builtin_ia32_cmpnltpd (v2df, v2df)
9956 v2df __builtin_ia32_cmpnlepd (v2df, v2df)
9957 v2df __builtin_ia32_cmpngtpd (v2df, v2df)
9958 v2df __builtin_ia32_cmpngepd (v2df, v2df)
9959 v2df __builtin_ia32_cmpordpd (v2df, v2df)
9960 v2df __builtin_ia32_cmpeqsd (v2df, v2df)
9961 v2df __builtin_ia32_cmpltsd (v2df, v2df)
9962 v2df __builtin_ia32_cmplesd (v2df, v2df)
9963 v2df __builtin_ia32_cmpunordsd (v2df, v2df)
9964 v2df __builtin_ia32_cmpneqsd (v2df, v2df)
9965 v2df __builtin_ia32_cmpnltsd (v2df, v2df)
9966 v2df __builtin_ia32_cmpnlesd (v2df, v2df)
9967 v2df __builtin_ia32_cmpordsd (v2df, v2df)
9968 v2di __builtin_ia32_paddq (v2di, v2di)
9969 v2di __builtin_ia32_psubq (v2di, v2di)
9970 v2df __builtin_ia32_addpd (v2df, v2df)
9971 v2df __builtin_ia32_subpd (v2df, v2df)
9972 v2df __builtin_ia32_mulpd (v2df, v2df)
9973 v2df __builtin_ia32_divpd (v2df, v2df)
9974 v2df __builtin_ia32_addsd (v2df, v2df)
9975 v2df __builtin_ia32_subsd (v2df, v2df)
9976 v2df __builtin_ia32_mulsd (v2df, v2df)
9977 v2df __builtin_ia32_divsd (v2df, v2df)
9978 v2df __builtin_ia32_minpd (v2df, v2df)
9979 v2df __builtin_ia32_maxpd (v2df, v2df)
9980 v2df __builtin_ia32_minsd (v2df, v2df)
9981 v2df __builtin_ia32_maxsd (v2df, v2df)
9982 v2df __builtin_ia32_andpd (v2df, v2df)
9983 v2df __builtin_ia32_andnpd (v2df, v2df)
9984 v2df __builtin_ia32_orpd (v2df, v2df)
9985 v2df __builtin_ia32_xorpd (v2df, v2df)
9986 v2df __builtin_ia32_movsd (v2df, v2df)
9987 v2df __builtin_ia32_unpckhpd (v2df, v2df)
9988 v2df __builtin_ia32_unpcklpd (v2df, v2df)
9989 v16qi __builtin_ia32_paddb128 (v16qi, v16qi)
9990 v8hi __builtin_ia32_paddw128 (v8hi, v8hi)
9991 v4si __builtin_ia32_paddd128 (v4si, v4si)
9992 v2di __builtin_ia32_paddq128 (v2di, v2di)
9993 v16qi __builtin_ia32_psubb128 (v16qi, v16qi)
9994 v8hi __builtin_ia32_psubw128 (v8hi, v8hi)
9995 v4si __builtin_ia32_psubd128 (v4si, v4si)
9996 v2di __builtin_ia32_psubq128 (v2di, v2di)
9997 v8hi __builtin_ia32_pmullw128 (v8hi, v8hi)
9998 v8hi __builtin_ia32_pmulhw128 (v8hi, v8hi)
9999 v2di __builtin_ia32_pand128 (v2di, v2di)
10000 v2di __builtin_ia32_pandn128 (v2di, v2di)
10001 v2di __builtin_ia32_por128 (v2di, v2di)
10002 v2di __builtin_ia32_pxor128 (v2di, v2di)
10003 v16qi __builtin_ia32_pavgb128 (v16qi, v16qi)
10004 v8hi __builtin_ia32_pavgw128 (v8hi, v8hi)
10005 v16qi __builtin_ia32_pcmpeqb128 (v16qi, v16qi)
10006 v8hi __builtin_ia32_pcmpeqw128 (v8hi, v8hi)
10007 v4si __builtin_ia32_pcmpeqd128 (v4si, v4si)
10008 v16qi __builtin_ia32_pcmpgtb128 (v16qi, v16qi)
10009 v8hi __builtin_ia32_pcmpgtw128 (v8hi, v8hi)
10010 v4si __builtin_ia32_pcmpgtd128 (v4si, v4si)
10011 v16qi __builtin_ia32_pmaxub128 (v16qi, v16qi)
10012 v8hi __builtin_ia32_pmaxsw128 (v8hi, v8hi)
10013 v16qi __builtin_ia32_pminub128 (v16qi, v16qi)
10014 v8hi __builtin_ia32_pminsw128 (v8hi, v8hi)
10015 v16qi __builtin_ia32_punpckhbw128 (v16qi, v16qi)
10016 v8hi __builtin_ia32_punpckhwd128 (v8hi, v8hi)
10017 v4si __builtin_ia32_punpckhdq128 (v4si, v4si)
10018 v2di __builtin_ia32_punpckhqdq128 (v2di, v2di)
10019 v16qi __builtin_ia32_punpcklbw128 (v16qi, v16qi)
10020 v8hi __builtin_ia32_punpcklwd128 (v8hi, v8hi)
10021 v4si __builtin_ia32_punpckldq128 (v4si, v4si)
10022 v2di __builtin_ia32_punpcklqdq128 (v2di, v2di)
10023 v16qi __builtin_ia32_packsswb128 (v8hi, v8hi)
10024 v8hi __builtin_ia32_packssdw128 (v4si, v4si)
10025 v16qi __builtin_ia32_packuswb128 (v8hi, v8hi)
10026 v8hi __builtin_ia32_pmulhuw128 (v8hi, v8hi)
10027 void __builtin_ia32_maskmovdqu (v16qi, v16qi)
10028 v2df __builtin_ia32_loadupd (double *)
10029 void __builtin_ia32_storeupd (double *, v2df)
10030 v2df __builtin_ia32_loadhpd (v2df, double const *)
10031 v2df __builtin_ia32_loadlpd (v2df, double const *)
10032 int __builtin_ia32_movmskpd (v2df)
10033 int __builtin_ia32_pmovmskb128 (v16qi)
10034 void __builtin_ia32_movnti (int *, int)
10035 void __builtin_ia32_movnti64 (long long int *, long long int)
10036 void __builtin_ia32_movntpd (double *, v2df)
10037 void __builtin_ia32_movntdq (v2df *, v2df)
10038 v4si __builtin_ia32_pshufd (v4si, int)
10039 v8hi __builtin_ia32_pshuflw (v8hi, int)
10040 v8hi __builtin_ia32_pshufhw (v8hi, int)
10041 v2di __builtin_ia32_psadbw128 (v16qi, v16qi)
10042 v2df __builtin_ia32_sqrtpd (v2df)
10043 v2df __builtin_ia32_sqrtsd (v2df)
10044 v2df __builtin_ia32_shufpd (v2df, v2df, int)
10045 v2df __builtin_ia32_cvtdq2pd (v4si)
10046 v4sf __builtin_ia32_cvtdq2ps (v4si)
10047 v4si __builtin_ia32_cvtpd2dq (v2df)
10048 v2si __builtin_ia32_cvtpd2pi (v2df)
10049 v4sf __builtin_ia32_cvtpd2ps (v2df)
10050 v4si __builtin_ia32_cvttpd2dq (v2df)
10051 v2si __builtin_ia32_cvttpd2pi (v2df)
10052 v2df __builtin_ia32_cvtpi2pd (v2si)
10053 int __builtin_ia32_cvtsd2si (v2df)
10054 int __builtin_ia32_cvttsd2si (v2df)
10055 long long __builtin_ia32_cvtsd2si64 (v2df)
10056 long long __builtin_ia32_cvttsd2si64 (v2df)
10057 v4si __builtin_ia32_cvtps2dq (v4sf)
10058 v2df __builtin_ia32_cvtps2pd (v4sf)
10059 v4si __builtin_ia32_cvttps2dq (v4sf)
10060 v2df __builtin_ia32_cvtsi2sd (v2df, int)
10061 v2df __builtin_ia32_cvtsi642sd (v2df, long long)
10062 v4sf __builtin_ia32_cvtsd2ss (v4sf, v2df)
10063 v2df __builtin_ia32_cvtss2sd (v2df, v4sf)
10064 void __builtin_ia32_clflush (const void *)
10065 void __builtin_ia32_lfence (void)
10066 void __builtin_ia32_mfence (void)
10067 v16qi __builtin_ia32_loaddqu (const char *)
10068 void __builtin_ia32_storedqu (char *, v16qi)
10069 v1di __builtin_ia32_pmuludq (v2si, v2si)
10070 v2di __builtin_ia32_pmuludq128 (v4si, v4si)
10071 v8hi __builtin_ia32_psllw128 (v8hi, v8hi)
10072 v4si __builtin_ia32_pslld128 (v4si, v4si)
10073 v2di __builtin_ia32_psllq128 (v2di, v2di)
10074 v8hi __builtin_ia32_psrlw128 (v8hi, v8hi)
10075 v4si __builtin_ia32_psrld128 (v4si, v4si)
10076 v2di __builtin_ia32_psrlq128 (v2di, v2di)
10077 v8hi __builtin_ia32_psraw128 (v8hi, v8hi)
10078 v4si __builtin_ia32_psrad128 (v4si, v4si)
10079 v2di __builtin_ia32_pslldqi128 (v2di, int)
10080 v8hi __builtin_ia32_psllwi128 (v8hi, int)
10081 v4si __builtin_ia32_pslldi128 (v4si, int)
10082 v2di __builtin_ia32_psllqi128 (v2di, int)
10083 v2di __builtin_ia32_psrldqi128 (v2di, int)
10084 v8hi __builtin_ia32_psrlwi128 (v8hi, int)
10085 v4si __builtin_ia32_psrldi128 (v4si, int)
10086 v2di __builtin_ia32_psrlqi128 (v2di, int)
10087 v8hi __builtin_ia32_psrawi128 (v8hi, int)
10088 v4si __builtin_ia32_psradi128 (v4si, int)
10089 v4si __builtin_ia32_pmaddwd128 (v8hi, v8hi)
10090 v2di __builtin_ia32_movq128 (v2di)
10091 @end smallexample
10093 The following built-in functions are available when @option{-msse3} is used.
10094 All of them generate the machine instruction that is part of the name.
10096 @smallexample
10097 v2df __builtin_ia32_addsubpd (v2df, v2df)
10098 v4sf __builtin_ia32_addsubps (v4sf, v4sf)
10099 v2df __builtin_ia32_haddpd (v2df, v2df)
10100 v4sf __builtin_ia32_haddps (v4sf, v4sf)
10101 v2df __builtin_ia32_hsubpd (v2df, v2df)
10102 v4sf __builtin_ia32_hsubps (v4sf, v4sf)
10103 v16qi __builtin_ia32_lddqu (char const *)
10104 void __builtin_ia32_monitor (void *, unsigned int, unsigned int)
10105 v2df __builtin_ia32_movddup (v2df)
10106 v4sf __builtin_ia32_movshdup (v4sf)
10107 v4sf __builtin_ia32_movsldup (v4sf)
10108 void __builtin_ia32_mwait (unsigned int, unsigned int)
10109 @end smallexample
10111 The following built-in functions are available when @option{-msse3} is used.
10113 @table @code
10114 @item v2df __builtin_ia32_loadddup (double const *)
10115 Generates the @code{movddup} machine instruction as a load from memory.
10116 @end table
10118 The following built-in functions are available when @option{-mssse3} is used.
10119 All of them generate the machine instruction that is part of the name
10120 with MMX registers.
10122 @smallexample
10123 v2si __builtin_ia32_phaddd (v2si, v2si)
10124 v4hi __builtin_ia32_phaddw (v4hi, v4hi)
10125 v4hi __builtin_ia32_phaddsw (v4hi, v4hi)
10126 v2si __builtin_ia32_phsubd (v2si, v2si)
10127 v4hi __builtin_ia32_phsubw (v4hi, v4hi)
10128 v4hi __builtin_ia32_phsubsw (v4hi, v4hi)
10129 v4hi __builtin_ia32_pmaddubsw (v8qi, v8qi)
10130 v4hi __builtin_ia32_pmulhrsw (v4hi, v4hi)
10131 v8qi __builtin_ia32_pshufb (v8qi, v8qi)
10132 v8qi __builtin_ia32_psignb (v8qi, v8qi)
10133 v2si __builtin_ia32_psignd (v2si, v2si)
10134 v4hi __builtin_ia32_psignw (v4hi, v4hi)
10135 v1di __builtin_ia32_palignr (v1di, v1di, int)
10136 v8qi __builtin_ia32_pabsb (v8qi)
10137 v2si __builtin_ia32_pabsd (v2si)
10138 v4hi __builtin_ia32_pabsw (v4hi)
10139 @end smallexample
10141 The following built-in functions are available when @option{-mssse3} is used.
10142 All of them generate the machine instruction that is part of the name
10143 with SSE registers.
10145 @smallexample
10146 v4si __builtin_ia32_phaddd128 (v4si, v4si)
10147 v8hi __builtin_ia32_phaddw128 (v8hi, v8hi)
10148 v8hi __builtin_ia32_phaddsw128 (v8hi, v8hi)
10149 v4si __builtin_ia32_phsubd128 (v4si, v4si)
10150 v8hi __builtin_ia32_phsubw128 (v8hi, v8hi)
10151 v8hi __builtin_ia32_phsubsw128 (v8hi, v8hi)
10152 v8hi __builtin_ia32_pmaddubsw128 (v16qi, v16qi)
10153 v8hi __builtin_ia32_pmulhrsw128 (v8hi, v8hi)
10154 v16qi __builtin_ia32_pshufb128 (v16qi, v16qi)
10155 v16qi __builtin_ia32_psignb128 (v16qi, v16qi)
10156 v4si __builtin_ia32_psignd128 (v4si, v4si)
10157 v8hi __builtin_ia32_psignw128 (v8hi, v8hi)
10158 v2di __builtin_ia32_palignr128 (v2di, v2di, int)
10159 v16qi __builtin_ia32_pabsb128 (v16qi)
10160 v4si __builtin_ia32_pabsd128 (v4si)
10161 v8hi __builtin_ia32_pabsw128 (v8hi)
10162 @end smallexample
10164 The following built-in functions are available when @option{-msse4.1} is
10165 used.  All of them generate the machine instruction that is part of the
10166 name.
10168 @smallexample
10169 v2df __builtin_ia32_blendpd (v2df, v2df, const int)
10170 v4sf __builtin_ia32_blendps (v4sf, v4sf, const int)
10171 v2df __builtin_ia32_blendvpd (v2df, v2df, v2df)
10172 v4sf __builtin_ia32_blendvps (v4sf, v4sf, v4sf)
10173 v2df __builtin_ia32_dppd (v2df, v2df, const int)
10174 v4sf __builtin_ia32_dpps (v4sf, v4sf, const int)
10175 v4sf __builtin_ia32_insertps128 (v4sf, v4sf, const int)
10176 v2di __builtin_ia32_movntdqa (v2di *);
10177 v16qi __builtin_ia32_mpsadbw128 (v16qi, v16qi, const int)
10178 v8hi __builtin_ia32_packusdw128 (v4si, v4si)
10179 v16qi __builtin_ia32_pblendvb128 (v16qi, v16qi, v16qi)
10180 v8hi __builtin_ia32_pblendw128 (v8hi, v8hi, const int)
10181 v2di __builtin_ia32_pcmpeqq (v2di, v2di)
10182 v8hi __builtin_ia32_phminposuw128 (v8hi)
10183 v16qi __builtin_ia32_pmaxsb128 (v16qi, v16qi)
10184 v4si __builtin_ia32_pmaxsd128 (v4si, v4si)
10185 v4si __builtin_ia32_pmaxud128 (v4si, v4si)
10186 v8hi __builtin_ia32_pmaxuw128 (v8hi, v8hi)
10187 v16qi __builtin_ia32_pminsb128 (v16qi, v16qi)
10188 v4si __builtin_ia32_pminsd128 (v4si, v4si)
10189 v4si __builtin_ia32_pminud128 (v4si, v4si)
10190 v8hi __builtin_ia32_pminuw128 (v8hi, v8hi)
10191 v4si __builtin_ia32_pmovsxbd128 (v16qi)
10192 v2di __builtin_ia32_pmovsxbq128 (v16qi)
10193 v8hi __builtin_ia32_pmovsxbw128 (v16qi)
10194 v2di __builtin_ia32_pmovsxdq128 (v4si)
10195 v4si __builtin_ia32_pmovsxwd128 (v8hi)
10196 v2di __builtin_ia32_pmovsxwq128 (v8hi)
10197 v4si __builtin_ia32_pmovzxbd128 (v16qi)
10198 v2di __builtin_ia32_pmovzxbq128 (v16qi)
10199 v8hi __builtin_ia32_pmovzxbw128 (v16qi)
10200 v2di __builtin_ia32_pmovzxdq128 (v4si)
10201 v4si __builtin_ia32_pmovzxwd128 (v8hi)
10202 v2di __builtin_ia32_pmovzxwq128 (v8hi)
10203 v2di __builtin_ia32_pmuldq128 (v4si, v4si)
10204 v4si __builtin_ia32_pmulld128 (v4si, v4si)
10205 int __builtin_ia32_ptestc128 (v2di, v2di)
10206 int __builtin_ia32_ptestnzc128 (v2di, v2di)
10207 int __builtin_ia32_ptestz128 (v2di, v2di)
10208 v2df __builtin_ia32_roundpd (v2df, const int)
10209 v4sf __builtin_ia32_roundps (v4sf, const int)
10210 v2df __builtin_ia32_roundsd (v2df, v2df, const int)
10211 v4sf __builtin_ia32_roundss (v4sf, v4sf, const int)
10212 @end smallexample
10214 The following built-in functions are available when @option{-msse4.1} is
10215 used.
10217 @table @code
10218 @item v4sf __builtin_ia32_vec_set_v4sf (v4sf, float, const int)
10219 Generates the @code{insertps} machine instruction.
10220 @item int __builtin_ia32_vec_ext_v16qi (v16qi, const int)
10221 Generates the @code{pextrb} machine instruction.
10222 @item v16qi __builtin_ia32_vec_set_v16qi (v16qi, int, const int)
10223 Generates the @code{pinsrb} machine instruction.
10224 @item v4si __builtin_ia32_vec_set_v4si (v4si, int, const int)
10225 Generates the @code{pinsrd} machine instruction.
10226 @item v2di __builtin_ia32_vec_set_v2di (v2di, long long, const int)
10227 Generates the @code{pinsrq} machine instruction in 64bit mode.
10228 @end table
10230 The following built-in functions are changed to generate new SSE4.1
10231 instructions when @option{-msse4.1} is used.
10233 @table @code
10234 @item float __builtin_ia32_vec_ext_v4sf (v4sf, const int)
10235 Generates the @code{extractps} machine instruction.
10236 @item int __builtin_ia32_vec_ext_v4si (v4si, const int)
10237 Generates the @code{pextrd} machine instruction.
10238 @item long long __builtin_ia32_vec_ext_v2di (v2di, const int)
10239 Generates the @code{pextrq} machine instruction in 64bit mode.
10240 @end table
10242 The following built-in functions are available when @option{-msse4.2} is
10243 used.  All of them generate the machine instruction that is part of the
10244 name.
10246 @smallexample
10247 v16qi __builtin_ia32_pcmpestrm128 (v16qi, int, v16qi, int, const int)
10248 int __builtin_ia32_pcmpestri128 (v16qi, int, v16qi, int, const int)
10249 int __builtin_ia32_pcmpestria128 (v16qi, int, v16qi, int, const int)
10250 int __builtin_ia32_pcmpestric128 (v16qi, int, v16qi, int, const int)
10251 int __builtin_ia32_pcmpestrio128 (v16qi, int, v16qi, int, const int)
10252 int __builtin_ia32_pcmpestris128 (v16qi, int, v16qi, int, const int)
10253 int __builtin_ia32_pcmpestriz128 (v16qi, int, v16qi, int, const int)
10254 v16qi __builtin_ia32_pcmpistrm128 (v16qi, v16qi, const int)
10255 int __builtin_ia32_pcmpistri128 (v16qi, v16qi, const int)
10256 int __builtin_ia32_pcmpistria128 (v16qi, v16qi, const int)
10257 int __builtin_ia32_pcmpistric128 (v16qi, v16qi, const int)
10258 int __builtin_ia32_pcmpistrio128 (v16qi, v16qi, const int)
10259 int __builtin_ia32_pcmpistris128 (v16qi, v16qi, const int)
10260 int __builtin_ia32_pcmpistriz128 (v16qi, v16qi, const int)
10261 v2di __builtin_ia32_pcmpgtq (v2di, v2di)
10262 @end smallexample
10264 The following built-in functions are available when @option{-msse4.2} is
10265 used.
10267 @table @code
10268 @item unsigned int __builtin_ia32_crc32qi (unsigned int, unsigned char)
10269 Generates the @code{crc32b} machine instruction.
10270 @item unsigned int __builtin_ia32_crc32hi (unsigned int, unsigned short)
10271 Generates the @code{crc32w} machine instruction.
10272 @item unsigned int __builtin_ia32_crc32si (unsigned int, unsigned int)
10273 Generates the @code{crc32l} machine instruction.
10274 @item unsigned long long __builtin_ia32_crc32di (unsigned long long, unsigned long long)
10275 Generates the @code{crc32q} machine instruction.
10276 @end table
10278 The following built-in functions are changed to generate new SSE4.2
10279 instructions when @option{-msse4.2} is used.
10281 @table @code
10282 @item int __builtin_popcount (unsigned int)
10283 Generates the @code{popcntl} machine instruction.
10284 @item int __builtin_popcountl (unsigned long)
10285 Generates the @code{popcntl} or @code{popcntq} machine instruction,
10286 depending on the size of @code{unsigned long}.
10287 @item int __builtin_popcountll (unsigned long long)
10288 Generates the @code{popcntq} machine instruction.
10289 @end table
10291 The following built-in functions are available when @option{-mavx} is
10292 used. All of them generate the machine instruction that is part of the
10293 name.
10295 @smallexample
10296 v4df __builtin_ia32_addpd256 (v4df,v4df)
10297 v8sf __builtin_ia32_addps256 (v8sf,v8sf)
10298 v4df __builtin_ia32_addsubpd256 (v4df,v4df)
10299 v8sf __builtin_ia32_addsubps256 (v8sf,v8sf)
10300 v4df __builtin_ia32_andnpd256 (v4df,v4df)
10301 v8sf __builtin_ia32_andnps256 (v8sf,v8sf)
10302 v4df __builtin_ia32_andpd256 (v4df,v4df)
10303 v8sf __builtin_ia32_andps256 (v8sf,v8sf)
10304 v4df __builtin_ia32_blendpd256 (v4df,v4df,int)
10305 v8sf __builtin_ia32_blendps256 (v8sf,v8sf,int)
10306 v4df __builtin_ia32_blendvpd256 (v4df,v4df,v4df)
10307 v8sf __builtin_ia32_blendvps256 (v8sf,v8sf,v8sf)
10308 v2df __builtin_ia32_cmppd (v2df,v2df,int)
10309 v4df __builtin_ia32_cmppd256 (v4df,v4df,int)
10310 v4sf __builtin_ia32_cmpps (v4sf,v4sf,int)
10311 v8sf __builtin_ia32_cmpps256 (v8sf,v8sf,int)
10312 v2df __builtin_ia32_cmpsd (v2df,v2df,int)
10313 v4sf __builtin_ia32_cmpss (v4sf,v4sf,int)
10314 v4df __builtin_ia32_cvtdq2pd256 (v4si)
10315 v8sf __builtin_ia32_cvtdq2ps256 (v8si)
10316 v4si __builtin_ia32_cvtpd2dq256 (v4df)
10317 v4sf __builtin_ia32_cvtpd2ps256 (v4df)
10318 v8si __builtin_ia32_cvtps2dq256 (v8sf)
10319 v4df __builtin_ia32_cvtps2pd256 (v4sf)
10320 v4si __builtin_ia32_cvttpd2dq256 (v4df)
10321 v8si __builtin_ia32_cvttps2dq256 (v8sf)
10322 v4df __builtin_ia32_divpd256 (v4df,v4df)
10323 v8sf __builtin_ia32_divps256 (v8sf,v8sf)
10324 v8sf __builtin_ia32_dpps256 (v8sf,v8sf,int)
10325 v4df __builtin_ia32_haddpd256 (v4df,v4df)
10326 v8sf __builtin_ia32_haddps256 (v8sf,v8sf)
10327 v4df __builtin_ia32_hsubpd256 (v4df,v4df)
10328 v8sf __builtin_ia32_hsubps256 (v8sf,v8sf)
10329 v32qi __builtin_ia32_lddqu256 (pcchar)
10330 v32qi __builtin_ia32_loaddqu256 (pcchar)
10331 v4df __builtin_ia32_loadupd256 (pcdouble)
10332 v8sf __builtin_ia32_loadups256 (pcfloat)
10333 v2df __builtin_ia32_maskloadpd (pcv2df,v2df)
10334 v4df __builtin_ia32_maskloadpd256 (pcv4df,v4df)
10335 v4sf __builtin_ia32_maskloadps (pcv4sf,v4sf)
10336 v8sf __builtin_ia32_maskloadps256 (pcv8sf,v8sf)
10337 void __builtin_ia32_maskstorepd (pv2df,v2df,v2df)
10338 void __builtin_ia32_maskstorepd256 (pv4df,v4df,v4df)
10339 void __builtin_ia32_maskstoreps (pv4sf,v4sf,v4sf)
10340 void __builtin_ia32_maskstoreps256 (pv8sf,v8sf,v8sf)
10341 v4df __builtin_ia32_maxpd256 (v4df,v4df)
10342 v8sf __builtin_ia32_maxps256 (v8sf,v8sf)
10343 v4df __builtin_ia32_minpd256 (v4df,v4df)
10344 v8sf __builtin_ia32_minps256 (v8sf,v8sf)
10345 v4df __builtin_ia32_movddup256 (v4df)
10346 int __builtin_ia32_movmskpd256 (v4df)
10347 int __builtin_ia32_movmskps256 (v8sf)
10348 v8sf __builtin_ia32_movshdup256 (v8sf)
10349 v8sf __builtin_ia32_movsldup256 (v8sf)
10350 v4df __builtin_ia32_mulpd256 (v4df,v4df)
10351 v8sf __builtin_ia32_mulps256 (v8sf,v8sf)
10352 v4df __builtin_ia32_orpd256 (v4df,v4df)
10353 v8sf __builtin_ia32_orps256 (v8sf,v8sf)
10354 v2df __builtin_ia32_pd_pd256 (v4df)
10355 v4df __builtin_ia32_pd256_pd (v2df)
10356 v4sf __builtin_ia32_ps_ps256 (v8sf)
10357 v8sf __builtin_ia32_ps256_ps (v4sf)
10358 int __builtin_ia32_ptestc256 (v4di,v4di,ptest)
10359 int __builtin_ia32_ptestnzc256 (v4di,v4di,ptest)
10360 int __builtin_ia32_ptestz256 (v4di,v4di,ptest)
10361 v8sf __builtin_ia32_rcpps256 (v8sf)
10362 v4df __builtin_ia32_roundpd256 (v4df,int)
10363 v8sf __builtin_ia32_roundps256 (v8sf,int)
10364 v8sf __builtin_ia32_rsqrtps_nr256 (v8sf)
10365 v8sf __builtin_ia32_rsqrtps256 (v8sf)
10366 v4df __builtin_ia32_shufpd256 (v4df,v4df,int)
10367 v8sf __builtin_ia32_shufps256 (v8sf,v8sf,int)
10368 v4si __builtin_ia32_si_si256 (v8si)
10369 v8si __builtin_ia32_si256_si (v4si)
10370 v4df __builtin_ia32_sqrtpd256 (v4df)
10371 v8sf __builtin_ia32_sqrtps_nr256 (v8sf)
10372 v8sf __builtin_ia32_sqrtps256 (v8sf)
10373 void __builtin_ia32_storedqu256 (pchar,v32qi)
10374 void __builtin_ia32_storeupd256 (pdouble,v4df)
10375 void __builtin_ia32_storeups256 (pfloat,v8sf)
10376 v4df __builtin_ia32_subpd256 (v4df,v4df)
10377 v8sf __builtin_ia32_subps256 (v8sf,v8sf)
10378 v4df __builtin_ia32_unpckhpd256 (v4df,v4df)
10379 v8sf __builtin_ia32_unpckhps256 (v8sf,v8sf)
10380 v4df __builtin_ia32_unpcklpd256 (v4df,v4df)
10381 v8sf __builtin_ia32_unpcklps256 (v8sf,v8sf)
10382 v4df __builtin_ia32_vbroadcastf128_pd256 (pcv2df)
10383 v8sf __builtin_ia32_vbroadcastf128_ps256 (pcv4sf)
10384 v4df __builtin_ia32_vbroadcastsd256 (pcdouble)
10385 v4sf __builtin_ia32_vbroadcastss (pcfloat)
10386 v8sf __builtin_ia32_vbroadcastss256 (pcfloat)
10387 v2df __builtin_ia32_vextractf128_pd256 (v4df,int)
10388 v4sf __builtin_ia32_vextractf128_ps256 (v8sf,int)
10389 v4si __builtin_ia32_vextractf128_si256 (v8si,int)
10390 v4df __builtin_ia32_vinsertf128_pd256 (v4df,v2df,int)
10391 v8sf __builtin_ia32_vinsertf128_ps256 (v8sf,v4sf,int)
10392 v8si __builtin_ia32_vinsertf128_si256 (v8si,v4si,int)
10393 v4df __builtin_ia32_vperm2f128_pd256 (v4df,v4df,int)
10394 v8sf __builtin_ia32_vperm2f128_ps256 (v8sf,v8sf,int)
10395 v8si __builtin_ia32_vperm2f128_si256 (v8si,v8si,int)
10396 v2df __builtin_ia32_vpermil2pd (v2df,v2df,v2di,int)
10397 v4df __builtin_ia32_vpermil2pd256 (v4df,v4df,v4di,int)
10398 v4sf __builtin_ia32_vpermil2ps (v4sf,v4sf,v4si,int)
10399 v8sf __builtin_ia32_vpermil2ps256 (v8sf,v8sf,v8si,int)
10400 v2df __builtin_ia32_vpermilpd (v2df,int)
10401 v4df __builtin_ia32_vpermilpd256 (v4df,int)
10402 v4sf __builtin_ia32_vpermilps (v4sf,int)
10403 v8sf __builtin_ia32_vpermilps256 (v8sf,int)
10404 v2df __builtin_ia32_vpermilvarpd (v2df,v2di)
10405 v4df __builtin_ia32_vpermilvarpd256 (v4df,v4di)
10406 v4sf __builtin_ia32_vpermilvarps (v4sf,v4si)
10407 v8sf __builtin_ia32_vpermilvarps256 (v8sf,v8si)
10408 int __builtin_ia32_vtestcpd (v2df,v2df,ptest)
10409 int __builtin_ia32_vtestcpd256 (v4df,v4df,ptest)
10410 int __builtin_ia32_vtestcps (v4sf,v4sf,ptest)
10411 int __builtin_ia32_vtestcps256 (v8sf,v8sf,ptest)
10412 int __builtin_ia32_vtestnzcpd (v2df,v2df,ptest)
10413 int __builtin_ia32_vtestnzcpd256 (v4df,v4df,ptest)
10414 int __builtin_ia32_vtestnzcps (v4sf,v4sf,ptest)
10415 int __builtin_ia32_vtestnzcps256 (v8sf,v8sf,ptest)
10416 int __builtin_ia32_vtestzpd (v2df,v2df,ptest)
10417 int __builtin_ia32_vtestzpd256 (v4df,v4df,ptest)
10418 int __builtin_ia32_vtestzps (v4sf,v4sf,ptest)
10419 int __builtin_ia32_vtestzps256 (v8sf,v8sf,ptest)
10420 void __builtin_ia32_vzeroall (void)
10421 void __builtin_ia32_vzeroupper (void)
10422 v4df __builtin_ia32_xorpd256 (v4df,v4df)
10423 v8sf __builtin_ia32_xorps256 (v8sf,v8sf)
10424 @end smallexample
10426 The following built-in functions are available when @option{-mavx2} is
10427 used. All of them generate the machine instruction that is part of the
10428 name.
10430 @smallexample
10431 v32qi __builtin_ia32_mpsadbw256 (v32qi,v32qi,v32qi,int)
10432 v32qi __builtin_ia32_pabsb256 (v32qi)
10433 v16hi __builtin_ia32_pabsw256 (v16hi)
10434 v8si __builtin_ia32_pabsd256 (v8si)
10435 v16hi builtin_ia32_packssdw256 (v8si,v8si)
10436 v32qi __builtin_ia32_packsswb256 (v16hi,v16hi)
10437 v16hi __builtin_ia32_packusdw256 (v8si,v8si)
10438 v32qi __builtin_ia32_packuswb256 (v16hi,v16hi)
10439 v32qi__builtin_ia32_paddb256 (v32qi,v32qi)
10440 v16hi __builtin_ia32_paddw256 (v16hi,v16hi)
10441 v8si __builtin_ia32_paddd256 (v8si,v8si)
10442 v4di __builtin_ia32_paddq256 (v4di,v4di)
10443 v32qi __builtin_ia32_paddsb256 (v32qi,v32qi)
10444 v16hi __builtin_ia32_paddsw256 (v16hi,v16hi)
10445 v32qi __builtin_ia32_paddusb256 (v32qi,v32qi)
10446 v16hi __builtin_ia32_paddusw256 (v16hi,v16hi)
10447 v4di __builtin_ia32_palignr256 (v4di,v4di,int)
10448 v4di __builtin_ia32_andsi256 (v4di,v4di)
10449 v4di __builtin_ia32_andnotsi256 (v4di,v4di)
10450 v32qi__builtin_ia32_pavgb256 (v32qi,v32qi)
10451 v16hi __builtin_ia32_pavgw256 (v16hi,v16hi)
10452 v32qi __builtin_ia32_pblendvb256 (v32qi,v32qi,v32qi)
10453 v16hi __builtin_ia32_pblendw256 (v16hi,v16hi,int)
10454 v32qi __builtin_ia32_pcmpeqb256 (v32qi,v32qi)
10455 v16hi __builtin_ia32_pcmpeqw256 (v16hi,v16hi)
10456 v8si __builtin_ia32_pcmpeqd256 (c8si,v8si)
10457 v4di __builtin_ia32_pcmpeqq256 (v4di,v4di)
10458 v32qi __builtin_ia32_pcmpgtb256 (v32qi,v32qi)
10459 v16hi __builtin_ia32_pcmpgtw256 (16hi,v16hi)
10460 v8si __builtin_ia32_pcmpgtd256 (v8si,v8si)
10461 v4di __builtin_ia32_pcmpgtq256 (v4di,v4di)
10462 v16hi __builtin_ia32_phaddw256 (v16hi,v16hi)
10463 v8si __builtin_ia32_phaddd256 (v8si,v8si)
10464 v16hi __builtin_ia32_phaddsw256 (v16hi,v16hi)
10465 v16hi __builtin_ia32_phsubw256 (v16hi,v16hi)
10466 v8si __builtin_ia32_phsubd256 (v8si,v8si)
10467 v16hi __builtin_ia32_phsubsw256 (v16hi,v16hi)
10468 v32qi __builtin_ia32_pmaddubsw256 (v32qi,v32qi)
10469 v16hi __builtin_ia32_pmaddwd256 (v16hi,v16hi)
10470 v32qi __builtin_ia32_pmaxsb256 (v32qi,v32qi)
10471 v16hi __builtin_ia32_pmaxsw256 (v16hi,v16hi)
10472 v8si __builtin_ia32_pmaxsd256 (v8si,v8si)
10473 v32qi __builtin_ia32_pmaxub256 (v32qi,v32qi)
10474 v16hi __builtin_ia32_pmaxuw256 (v16hi,v16hi)
10475 v8si __builtin_ia32_pmaxud256 (v8si,v8si)
10476 v32qi __builtin_ia32_pminsb256 (v32qi,v32qi)
10477 v16hi __builtin_ia32_pminsw256 (v16hi,v16hi)
10478 v8si __builtin_ia32_pminsd256 (v8si,v8si)
10479 v32qi __builtin_ia32_pminub256 (v32qi,v32qi)
10480 v16hi __builtin_ia32_pminuw256 (v16hi,v16hi)
10481 v8si __builtin_ia32_pminud256 (v8si,v8si)
10482 int __builtin_ia32_pmovmskb256 (v32qi)
10483 v16hi __builtin_ia32_pmovsxbw256 (v16qi)
10484 v8si __builtin_ia32_pmovsxbd256 (v16qi)
10485 v4di __builtin_ia32_pmovsxbq256 (v16qi)
10486 v8si __builtin_ia32_pmovsxwd256 (v8hi)
10487 v4di __builtin_ia32_pmovsxwq256 (v8hi)
10488 v4di __builtin_ia32_pmovsxdq256 (v4si)
10489 v16hi __builtin_ia32_pmovzxbw256 (v16qi)
10490 v8si __builtin_ia32_pmovzxbd256 (v16qi)
10491 v4di __builtin_ia32_pmovzxbq256 (v16qi)
10492 v8si __builtin_ia32_pmovzxwd256 (v8hi)
10493 v4di __builtin_ia32_pmovzxwq256 (v8hi)
10494 v4di __builtin_ia32_pmovzxdq256 (v4si)
10495 v4di __builtin_ia32_pmuldq256 (v8si,v8si)
10496 v16hi __builtin_ia32_pmulhrsw256 (v16hi, v16hi)
10497 v16hi __builtin_ia32_pmulhuw256 (v16hi,v16hi)
10498 v16hi __builtin_ia32_pmulhw256 (v16hi,v16hi)
10499 v16hi __builtin_ia32_pmullw256 (v16hi,v16hi)
10500 v8si __builtin_ia32_pmulld256 (v8si,v8si)
10501 v4di __builtin_ia32_pmuludq256 (v8si,v8si)
10502 v4di __builtin_ia32_por256 (v4di,v4di)
10503 v16hi __builtin_ia32_psadbw256 (v32qi,v32qi)
10504 v32qi __builtin_ia32_pshufb256 (v32qi,v32qi)
10505 v8si __builtin_ia32_pshufd256 (v8si,int)
10506 v16hi __builtin_ia32_pshufhw256 (v16hi,int)
10507 v16hi __builtin_ia32_pshuflw256 (v16hi,int)
10508 v32qi __builtin_ia32_psignb256 (v32qi,v32qi)
10509 v16hi __builtin_ia32_psignw256 (v16hi,v16hi)
10510 v8si __builtin_ia32_psignd256 (v8si,v8si)
10511 v4di __builtin_ia32_pslldqi256 (v4di,int)
10512 v16hi __builtin_ia32_psllwi256 (16hi,int)
10513 v16hi __builtin_ia32_psllw256(v16hi,v8hi)
10514 v8si __builtin_ia32_pslldi256 (v8si,int)
10515 v8si __builtin_ia32_pslld256(v8si,v4si)
10516 v4di __builtin_ia32_psllqi256 (v4di,int)
10517 v4di __builtin_ia32_psllq256(v4di,v2di)
10518 v16hi __builtin_ia32_psrawi256 (v16hi,int)
10519 v16hi __builtin_ia32_psraw256 (v16hi,v8hi)
10520 v8si __builtin_ia32_psradi256 (v8si,int)
10521 v8si __builtin_ia32_psrad256 (v8si,v4si)
10522 v4di __builtin_ia32_psrldqi256 (v4di, int)
10523 v16hi __builtin_ia32_psrlwi256 (v16hi,int)
10524 v16hi __builtin_ia32_psrlw256 (v16hi,v8hi)
10525 v8si __builtin_ia32_psrldi256 (v8si,int)
10526 v8si __builtin_ia32_psrld256 (v8si,v4si)
10527 v4di __builtin_ia32_psrlqi256 (v4di,int)
10528 v4di __builtin_ia32_psrlq256(v4di,v2di)
10529 v32qi __builtin_ia32_psubb256 (v32qi,v32qi)
10530 v32hi __builtin_ia32_psubw256 (v16hi,v16hi)
10531 v8si __builtin_ia32_psubd256 (v8si,v8si)
10532 v4di __builtin_ia32_psubq256 (v4di,v4di)
10533 v32qi __builtin_ia32_psubsb256 (v32qi,v32qi)
10534 v16hi __builtin_ia32_psubsw256 (v16hi,v16hi)
10535 v32qi __builtin_ia32_psubusb256 (v32qi,v32qi)
10536 v16hi __builtin_ia32_psubusw256 (v16hi,v16hi)
10537 v32qi __builtin_ia32_punpckhbw256 (v32qi,v32qi)
10538 v16hi __builtin_ia32_punpckhwd256 (v16hi,v16hi)
10539 v8si __builtin_ia32_punpckhdq256 (v8si,v8si)
10540 v4di __builtin_ia32_punpckhqdq256 (v4di,v4di)
10541 v32qi __builtin_ia32_punpcklbw256 (v32qi,v32qi)
10542 v16hi __builtin_ia32_punpcklwd256 (v16hi,v16hi)
10543 v8si __builtin_ia32_punpckldq256 (v8si,v8si)
10544 v4di __builtin_ia32_punpcklqdq256 (v4di,v4di)
10545 v4di __builtin_ia32_pxor256 (v4di,v4di)
10546 v4di __builtin_ia32_movntdqa256 (pv4di)
10547 v4sf __builtin_ia32_vbroadcastss_ps (v4sf)
10548 v8sf __builtin_ia32_vbroadcastss_ps256 (v4sf)
10549 v4df __builtin_ia32_vbroadcastsd_pd256 (v2df)
10550 v4di __builtin_ia32_vbroadcastsi256 (v2di)
10551 v4si __builtin_ia32_pblendd128 (v4si,v4si)
10552 v8si __builtin_ia32_pblendd256 (v8si,v8si)
10553 v32qi __builtin_ia32_pbroadcastb256 (v16qi)
10554 v16hi __builtin_ia32_pbroadcastw256 (v8hi)
10555 v8si __builtin_ia32_pbroadcastd256 (v4si)
10556 v4di __builtin_ia32_pbroadcastq256 (v2di)
10557 v16qi __builtin_ia32_pbroadcastb128 (v16qi)
10558 v8hi __builtin_ia32_pbroadcastw128 (v8hi)
10559 v4si __builtin_ia32_pbroadcastd128 (v4si)
10560 v2di __builtin_ia32_pbroadcastq128 (v2di)
10561 v8si __builtin_ia32_permvarsi256 (v8si,v8si)
10562 v4df __builtin_ia32_permdf256 (v4df,int)
10563 v8sf __builtin_ia32_permvarsf256 (v8sf,v8sf)
10564 v4di __builtin_ia32_permdi256 (v4di,int)
10565 v4di __builtin_ia32_permti256 (v4di,v4di,int)
10566 v4di __builtin_ia32_extract128i256 (v4di,int)
10567 v4di __builtin_ia32_insert128i256 (v4di,v2di,int)
10568 v8si __builtin_ia32_maskloadd256 (pcv8si,v8si)
10569 v4di __builtin_ia32_maskloadq256 (pcv4di,v4di)
10570 v4si __builtin_ia32_maskloadd (pcv4si,v4si)
10571 v2di __builtin_ia32_maskloadq (pcv2di,v2di)
10572 void __builtin_ia32_maskstored256 (pv8si,v8si,v8si)
10573 void __builtin_ia32_maskstoreq256 (pv4di,v4di,v4di)
10574 void __builtin_ia32_maskstored (pv4si,v4si,v4si)
10575 void __builtin_ia32_maskstoreq (pv2di,v2di,v2di)
10576 v8si __builtin_ia32_psllv8si (v8si,v8si)
10577 v4si __builtin_ia32_psllv4si (v4si,v4si)
10578 v4di __builtin_ia32_psllv4di (v4di,v4di)
10579 v2di __builtin_ia32_psllv2di (v2di,v2di)
10580 v8si __builtin_ia32_psrav8si (v8si,v8si)
10581 v4si __builtin_ia32_psrav4si (v4si,v4si)
10582 v8si __builtin_ia32_psrlv8si (v8si,v8si)
10583 v4si __builtin_ia32_psrlv4si (v4si,v4si)
10584 v4di __builtin_ia32_psrlv4di (v4di,v4di)
10585 v2di __builtin_ia32_psrlv2di (v2di,v2di)
10586 v2df __builtin_ia32_gathersiv2df (v2df, pcdouble,v4si,v2df,int)
10587 v4df __builtin_ia32_gathersiv4df (v4df, pcdouble,v4si,v4df,int)
10588 v2df __builtin_ia32_gatherdiv2df (v2df, pcdouble,v2di,v2df,int)
10589 v4df __builtin_ia32_gatherdiv4df (v4df, pcdouble,v4di,v4df,int)
10590 v4sf __builtin_ia32_gathersiv4sf (v4sf, pcfloat,v4si,v4sf,int)
10591 v8sf __builtin_ia32_gathersiv8sf (v8sf, pcfloat,v8si,v8sf,int)
10592 v4sf __builtin_ia32_gatherdiv4sf (v4sf, pcfloat,v2di,v4sf,int)
10593 v4sf __builtin_ia32_gatherdiv4sf256 (v4sf, pcfloat,v4di,v4sf,int)
10594 v2di __builtin_ia32_gathersiv2di (v2di, pcint64,v4si,v2di,int)
10595 v4di __builtin_ia32_gathersiv4di (v4di, pcint64,v4si,v4di,int)
10596 v2di __builtin_ia32_gatherdiv2di (v2di, pcint64,v2di,v2di,int)
10597 v4di __builtin_ia32_gatherdiv4di (v4di, pcint64,v4di,v4di,int)
10598 v4si __builtin_ia32_gathersiv4si (v4si, pcint,v4si,v4si,int)
10599 v8si __builtin_ia32_gathersiv8si (v8si, pcint,v8si,v8si,int)
10600 v4si __builtin_ia32_gatherdiv4si (v4si, pcint,v2di,v4si,int)
10601 v4si __builtin_ia32_gatherdiv4si256 (v4si, pcint,v4di,v4si,int)
10602 @end smallexample
10604 The following built-in functions are available when @option{-maes} is
10605 used.  All of them generate the machine instruction that is part of the
10606 name.
10608 @smallexample
10609 v2di __builtin_ia32_aesenc128 (v2di, v2di)
10610 v2di __builtin_ia32_aesenclast128 (v2di, v2di)
10611 v2di __builtin_ia32_aesdec128 (v2di, v2di)
10612 v2di __builtin_ia32_aesdeclast128 (v2di, v2di)
10613 v2di __builtin_ia32_aeskeygenassist128 (v2di, const int)
10614 v2di __builtin_ia32_aesimc128 (v2di)
10615 @end smallexample
10617 The following built-in function is available when @option{-mpclmul} is
10618 used.
10620 @table @code
10621 @item v2di __builtin_ia32_pclmulqdq128 (v2di, v2di, const int)
10622 Generates the @code{pclmulqdq} machine instruction.
10623 @end table
10625 The following built-in function is available when @option{-mfsgsbase} is
10626 used.  All of them generate the machine instruction that is part of the
10627 name.
10629 @smallexample
10630 unsigned int __builtin_ia32_rdfsbase32 (void)
10631 unsigned long long __builtin_ia32_rdfsbase64 (void)
10632 unsigned int __builtin_ia32_rdgsbase32 (void)
10633 unsigned long long __builtin_ia32_rdgsbase64 (void)
10634 void _writefsbase_u32 (unsigned int)
10635 void _writefsbase_u64 (unsigned long long)
10636 void _writegsbase_u32 (unsigned int)
10637 void _writegsbase_u64 (unsigned long long)
10638 @end smallexample
10640 The following built-in function is available when @option{-mrdrnd} is
10641 used.  All of them generate the machine instruction that is part of the
10642 name.
10644 @smallexample
10645 unsigned int __builtin_ia32_rdrand16_step (unsigned short *)
10646 unsigned int __builtin_ia32_rdrand32_step (unsigned int *)
10647 unsigned int __builtin_ia32_rdrand64_step (unsigned long long *)
10648 @end smallexample
10650 The following built-in functions are available when @option{-msse4a} is used.
10651 All of them generate the machine instruction that is part of the name.
10653 @smallexample
10654 void __builtin_ia32_movntsd (double *, v2df)
10655 void __builtin_ia32_movntss (float *, v4sf)
10656 v2di __builtin_ia32_extrq  (v2di, v16qi)
10657 v2di __builtin_ia32_extrqi (v2di, const unsigned int, const unsigned int)
10658 v2di __builtin_ia32_insertq (v2di, v2di)
10659 v2di __builtin_ia32_insertqi (v2di, v2di, const unsigned int, const unsigned int)
10660 @end smallexample
10662 The following built-in functions are available when @option{-mxop} is used.
10663 @smallexample
10664 v2df __builtin_ia32_vfrczpd (v2df)
10665 v4sf __builtin_ia32_vfrczps (v4sf)
10666 v2df __builtin_ia32_vfrczsd (v2df, v2df)
10667 v4sf __builtin_ia32_vfrczss (v4sf, v4sf)
10668 v4df __builtin_ia32_vfrczpd256 (v4df)
10669 v8sf __builtin_ia32_vfrczps256 (v8sf)
10670 v2di __builtin_ia32_vpcmov (v2di, v2di, v2di)
10671 v2di __builtin_ia32_vpcmov_v2di (v2di, v2di, v2di)
10672 v4si __builtin_ia32_vpcmov_v4si (v4si, v4si, v4si)
10673 v8hi __builtin_ia32_vpcmov_v8hi (v8hi, v8hi, v8hi)
10674 v16qi __builtin_ia32_vpcmov_v16qi (v16qi, v16qi, v16qi)
10675 v2df __builtin_ia32_vpcmov_v2df (v2df, v2df, v2df)
10676 v4sf __builtin_ia32_vpcmov_v4sf (v4sf, v4sf, v4sf)
10677 v4di __builtin_ia32_vpcmov_v4di256 (v4di, v4di, v4di)
10678 v8si __builtin_ia32_vpcmov_v8si256 (v8si, v8si, v8si)
10679 v16hi __builtin_ia32_vpcmov_v16hi256 (v16hi, v16hi, v16hi)
10680 v32qi __builtin_ia32_vpcmov_v32qi256 (v32qi, v32qi, v32qi)
10681 v4df __builtin_ia32_vpcmov_v4df256 (v4df, v4df, v4df)
10682 v8sf __builtin_ia32_vpcmov_v8sf256 (v8sf, v8sf, v8sf)
10683 v16qi __builtin_ia32_vpcomeqb (v16qi, v16qi)
10684 v8hi __builtin_ia32_vpcomeqw (v8hi, v8hi)
10685 v4si __builtin_ia32_vpcomeqd (v4si, v4si)
10686 v2di __builtin_ia32_vpcomeqq (v2di, v2di)
10687 v16qi __builtin_ia32_vpcomequb (v16qi, v16qi)
10688 v4si __builtin_ia32_vpcomequd (v4si, v4si)
10689 v2di __builtin_ia32_vpcomequq (v2di, v2di)
10690 v8hi __builtin_ia32_vpcomequw (v8hi, v8hi)
10691 v8hi __builtin_ia32_vpcomeqw (v8hi, v8hi)
10692 v16qi __builtin_ia32_vpcomfalseb (v16qi, v16qi)
10693 v4si __builtin_ia32_vpcomfalsed (v4si, v4si)
10694 v2di __builtin_ia32_vpcomfalseq (v2di, v2di)
10695 v16qi __builtin_ia32_vpcomfalseub (v16qi, v16qi)
10696 v4si __builtin_ia32_vpcomfalseud (v4si, v4si)
10697 v2di __builtin_ia32_vpcomfalseuq (v2di, v2di)
10698 v8hi __builtin_ia32_vpcomfalseuw (v8hi, v8hi)
10699 v8hi __builtin_ia32_vpcomfalsew (v8hi, v8hi)
10700 v16qi __builtin_ia32_vpcomgeb (v16qi, v16qi)
10701 v4si __builtin_ia32_vpcomged (v4si, v4si)
10702 v2di __builtin_ia32_vpcomgeq (v2di, v2di)
10703 v16qi __builtin_ia32_vpcomgeub (v16qi, v16qi)
10704 v4si __builtin_ia32_vpcomgeud (v4si, v4si)
10705 v2di __builtin_ia32_vpcomgeuq (v2di, v2di)
10706 v8hi __builtin_ia32_vpcomgeuw (v8hi, v8hi)
10707 v8hi __builtin_ia32_vpcomgew (v8hi, v8hi)
10708 v16qi __builtin_ia32_vpcomgtb (v16qi, v16qi)
10709 v4si __builtin_ia32_vpcomgtd (v4si, v4si)
10710 v2di __builtin_ia32_vpcomgtq (v2di, v2di)
10711 v16qi __builtin_ia32_vpcomgtub (v16qi, v16qi)
10712 v4si __builtin_ia32_vpcomgtud (v4si, v4si)
10713 v2di __builtin_ia32_vpcomgtuq (v2di, v2di)
10714 v8hi __builtin_ia32_vpcomgtuw (v8hi, v8hi)
10715 v8hi __builtin_ia32_vpcomgtw (v8hi, v8hi)
10716 v16qi __builtin_ia32_vpcomleb (v16qi, v16qi)
10717 v4si __builtin_ia32_vpcomled (v4si, v4si)
10718 v2di __builtin_ia32_vpcomleq (v2di, v2di)
10719 v16qi __builtin_ia32_vpcomleub (v16qi, v16qi)
10720 v4si __builtin_ia32_vpcomleud (v4si, v4si)
10721 v2di __builtin_ia32_vpcomleuq (v2di, v2di)
10722 v8hi __builtin_ia32_vpcomleuw (v8hi, v8hi)
10723 v8hi __builtin_ia32_vpcomlew (v8hi, v8hi)
10724 v16qi __builtin_ia32_vpcomltb (v16qi, v16qi)
10725 v4si __builtin_ia32_vpcomltd (v4si, v4si)
10726 v2di __builtin_ia32_vpcomltq (v2di, v2di)
10727 v16qi __builtin_ia32_vpcomltub (v16qi, v16qi)
10728 v4si __builtin_ia32_vpcomltud (v4si, v4si)
10729 v2di __builtin_ia32_vpcomltuq (v2di, v2di)
10730 v8hi __builtin_ia32_vpcomltuw (v8hi, v8hi)
10731 v8hi __builtin_ia32_vpcomltw (v8hi, v8hi)
10732 v16qi __builtin_ia32_vpcomneb (v16qi, v16qi)
10733 v4si __builtin_ia32_vpcomned (v4si, v4si)
10734 v2di __builtin_ia32_vpcomneq (v2di, v2di)
10735 v16qi __builtin_ia32_vpcomneub (v16qi, v16qi)
10736 v4si __builtin_ia32_vpcomneud (v4si, v4si)
10737 v2di __builtin_ia32_vpcomneuq (v2di, v2di)
10738 v8hi __builtin_ia32_vpcomneuw (v8hi, v8hi)
10739 v8hi __builtin_ia32_vpcomnew (v8hi, v8hi)
10740 v16qi __builtin_ia32_vpcomtrueb (v16qi, v16qi)
10741 v4si __builtin_ia32_vpcomtrued (v4si, v4si)
10742 v2di __builtin_ia32_vpcomtrueq (v2di, v2di)
10743 v16qi __builtin_ia32_vpcomtrueub (v16qi, v16qi)
10744 v4si __builtin_ia32_vpcomtrueud (v4si, v4si)
10745 v2di __builtin_ia32_vpcomtrueuq (v2di, v2di)
10746 v8hi __builtin_ia32_vpcomtrueuw (v8hi, v8hi)
10747 v8hi __builtin_ia32_vpcomtruew (v8hi, v8hi)
10748 v4si __builtin_ia32_vphaddbd (v16qi)
10749 v2di __builtin_ia32_vphaddbq (v16qi)
10750 v8hi __builtin_ia32_vphaddbw (v16qi)
10751 v2di __builtin_ia32_vphadddq (v4si)
10752 v4si __builtin_ia32_vphaddubd (v16qi)
10753 v2di __builtin_ia32_vphaddubq (v16qi)
10754 v8hi __builtin_ia32_vphaddubw (v16qi)
10755 v2di __builtin_ia32_vphaddudq (v4si)
10756 v4si __builtin_ia32_vphadduwd (v8hi)
10757 v2di __builtin_ia32_vphadduwq (v8hi)
10758 v4si __builtin_ia32_vphaddwd (v8hi)
10759 v2di __builtin_ia32_vphaddwq (v8hi)
10760 v8hi __builtin_ia32_vphsubbw (v16qi)
10761 v2di __builtin_ia32_vphsubdq (v4si)
10762 v4si __builtin_ia32_vphsubwd (v8hi)
10763 v4si __builtin_ia32_vpmacsdd (v4si, v4si, v4si)
10764 v2di __builtin_ia32_vpmacsdqh (v4si, v4si, v2di)
10765 v2di __builtin_ia32_vpmacsdql (v4si, v4si, v2di)
10766 v4si __builtin_ia32_vpmacssdd (v4si, v4si, v4si)
10767 v2di __builtin_ia32_vpmacssdqh (v4si, v4si, v2di)
10768 v2di __builtin_ia32_vpmacssdql (v4si, v4si, v2di)
10769 v4si __builtin_ia32_vpmacsswd (v8hi, v8hi, v4si)
10770 v8hi __builtin_ia32_vpmacssww (v8hi, v8hi, v8hi)
10771 v4si __builtin_ia32_vpmacswd (v8hi, v8hi, v4si)
10772 v8hi __builtin_ia32_vpmacsww (v8hi, v8hi, v8hi)
10773 v4si __builtin_ia32_vpmadcsswd (v8hi, v8hi, v4si)
10774 v4si __builtin_ia32_vpmadcswd (v8hi, v8hi, v4si)
10775 v16qi __builtin_ia32_vpperm (v16qi, v16qi, v16qi)
10776 v16qi __builtin_ia32_vprotb (v16qi, v16qi)
10777 v4si __builtin_ia32_vprotd (v4si, v4si)
10778 v2di __builtin_ia32_vprotq (v2di, v2di)
10779 v8hi __builtin_ia32_vprotw (v8hi, v8hi)
10780 v16qi __builtin_ia32_vpshab (v16qi, v16qi)
10781 v4si __builtin_ia32_vpshad (v4si, v4si)
10782 v2di __builtin_ia32_vpshaq (v2di, v2di)
10783 v8hi __builtin_ia32_vpshaw (v8hi, v8hi)
10784 v16qi __builtin_ia32_vpshlb (v16qi, v16qi)
10785 v4si __builtin_ia32_vpshld (v4si, v4si)
10786 v2di __builtin_ia32_vpshlq (v2di, v2di)
10787 v8hi __builtin_ia32_vpshlw (v8hi, v8hi)
10788 @end smallexample
10790 The following built-in functions are available when @option{-mfma4} is used.
10791 All of them generate the machine instruction that is part of the name
10792 with MMX registers.
10794 @smallexample
10795 v2df __builtin_ia32_fmaddpd (v2df, v2df, v2df)
10796 v4sf __builtin_ia32_fmaddps (v4sf, v4sf, v4sf)
10797 v2df __builtin_ia32_fmaddsd (v2df, v2df, v2df)
10798 v4sf __builtin_ia32_fmaddss (v4sf, v4sf, v4sf)
10799 v2df __builtin_ia32_fmsubpd (v2df, v2df, v2df)
10800 v4sf __builtin_ia32_fmsubps (v4sf, v4sf, v4sf)
10801 v2df __builtin_ia32_fmsubsd (v2df, v2df, v2df)
10802 v4sf __builtin_ia32_fmsubss (v4sf, v4sf, v4sf)
10803 v2df __builtin_ia32_fnmaddpd (v2df, v2df, v2df)
10804 v4sf __builtin_ia32_fnmaddps (v4sf, v4sf, v4sf)
10805 v2df __builtin_ia32_fnmaddsd (v2df, v2df, v2df)
10806 v4sf __builtin_ia32_fnmaddss (v4sf, v4sf, v4sf)
10807 v2df __builtin_ia32_fnmsubpd (v2df, v2df, v2df)
10808 v4sf __builtin_ia32_fnmsubps (v4sf, v4sf, v4sf)
10809 v2df __builtin_ia32_fnmsubsd (v2df, v2df, v2df)
10810 v4sf __builtin_ia32_fnmsubss (v4sf, v4sf, v4sf)
10811 v2df __builtin_ia32_fmaddsubpd  (v2df, v2df, v2df)
10812 v4sf __builtin_ia32_fmaddsubps  (v4sf, v4sf, v4sf)
10813 v2df __builtin_ia32_fmsubaddpd  (v2df, v2df, v2df)
10814 v4sf __builtin_ia32_fmsubaddps  (v4sf, v4sf, v4sf)
10815 v4df __builtin_ia32_fmaddpd256 (v4df, v4df, v4df)
10816 v8sf __builtin_ia32_fmaddps256 (v8sf, v8sf, v8sf)
10817 v4df __builtin_ia32_fmsubpd256 (v4df, v4df, v4df)
10818 v8sf __builtin_ia32_fmsubps256 (v8sf, v8sf, v8sf)
10819 v4df __builtin_ia32_fnmaddpd256 (v4df, v4df, v4df)
10820 v8sf __builtin_ia32_fnmaddps256 (v8sf, v8sf, v8sf)
10821 v4df __builtin_ia32_fnmsubpd256 (v4df, v4df, v4df)
10822 v8sf __builtin_ia32_fnmsubps256 (v8sf, v8sf, v8sf)
10823 v4df __builtin_ia32_fmaddsubpd256 (v4df, v4df, v4df)
10824 v8sf __builtin_ia32_fmaddsubps256 (v8sf, v8sf, v8sf)
10825 v4df __builtin_ia32_fmsubaddpd256 (v4df, v4df, v4df)
10826 v8sf __builtin_ia32_fmsubaddps256 (v8sf, v8sf, v8sf)
10828 @end smallexample
10830 The following built-in functions are available when @option{-mlwp} is used.
10832 @smallexample
10833 void __builtin_ia32_llwpcb16 (void *);
10834 void __builtin_ia32_llwpcb32 (void *);
10835 void __builtin_ia32_llwpcb64 (void *);
10836 void * __builtin_ia32_llwpcb16 (void);
10837 void * __builtin_ia32_llwpcb32 (void);
10838 void * __builtin_ia32_llwpcb64 (void);
10839 void __builtin_ia32_lwpval16 (unsigned short, unsigned int, unsigned short)
10840 void __builtin_ia32_lwpval32 (unsigned int, unsigned int, unsigned int)
10841 void __builtin_ia32_lwpval64 (unsigned __int64, unsigned int, unsigned int)
10842 unsigned char __builtin_ia32_lwpins16 (unsigned short, unsigned int, unsigned short)
10843 unsigned char __builtin_ia32_lwpins32 (unsigned int, unsigned int, unsigned int)
10844 unsigned char __builtin_ia32_lwpins64 (unsigned __int64, unsigned int, unsigned int)
10845 @end smallexample
10847 The following built-in functions are available when @option{-mbmi} is used.
10848 All of them generate the machine instruction that is part of the name.
10849 @smallexample
10850 unsigned int __builtin_ia32_bextr_u32(unsigned int, unsigned int);
10851 unsigned long long __builtin_ia32_bextr_u64 (unsigned long long, unsigned long long);
10852 @end smallexample
10854 The following built-in functions are available when @option{-mbmi2} is used.
10855 All of them generate the machine instruction that is part of the name.
10856 @smallexample
10857 unsigned int _bzhi_u32 (unsigned int, unsigned int)
10858 unsigned int _pdep_u32 (unsigned int, unsigned int)
10859 unsigned int _pext_u32 (unsigned int, unsigned int)
10860 unsigned long long _bzhi_u64 (unsigned long long, unsigned long long)
10861 unsigned long long _pdep_u64 (unsigned long long, unsigned long long)
10862 unsigned long long _pext_u64 (unsigned long long, unsigned long long)
10863 @end smallexample
10865 The following built-in functions are available when @option{-mlzcnt} is used.
10866 All of them generate the machine instruction that is part of the name.
10867 @smallexample
10868 unsigned short __builtin_ia32_lzcnt_16(unsigned short);
10869 unsigned int __builtin_ia32_lzcnt_u32(unsigned int);
10870 unsigned long long __builtin_ia32_lzcnt_u64 (unsigned long long);
10871 @end smallexample
10873 The following built-in functions are available when @option{-mtbm} is used.
10874 Both of them generate the immediate form of the bextr machine instruction.
10875 @smallexample
10876 unsigned int __builtin_ia32_bextri_u32 (unsigned int, const unsigned int);
10877 unsigned long long __builtin_ia32_bextri_u64 (unsigned long long, const unsigned long long);
10878 @end smallexample
10881 The following built-in functions are available when @option{-m3dnow} is used.
10882 All of them generate the machine instruction that is part of the name.
10884 @smallexample
10885 void __builtin_ia32_femms (void)
10886 v8qi __builtin_ia32_pavgusb (v8qi, v8qi)
10887 v2si __builtin_ia32_pf2id (v2sf)
10888 v2sf __builtin_ia32_pfacc (v2sf, v2sf)
10889 v2sf __builtin_ia32_pfadd (v2sf, v2sf)
10890 v2si __builtin_ia32_pfcmpeq (v2sf, v2sf)
10891 v2si __builtin_ia32_pfcmpge (v2sf, v2sf)
10892 v2si __builtin_ia32_pfcmpgt (v2sf, v2sf)
10893 v2sf __builtin_ia32_pfmax (v2sf, v2sf)
10894 v2sf __builtin_ia32_pfmin (v2sf, v2sf)
10895 v2sf __builtin_ia32_pfmul (v2sf, v2sf)
10896 v2sf __builtin_ia32_pfrcp (v2sf)
10897 v2sf __builtin_ia32_pfrcpit1 (v2sf, v2sf)
10898 v2sf __builtin_ia32_pfrcpit2 (v2sf, v2sf)
10899 v2sf __builtin_ia32_pfrsqrt (v2sf)
10900 v2sf __builtin_ia32_pfrsqrtit1 (v2sf, v2sf)
10901 v2sf __builtin_ia32_pfsub (v2sf, v2sf)
10902 v2sf __builtin_ia32_pfsubr (v2sf, v2sf)
10903 v2sf __builtin_ia32_pi2fd (v2si)
10904 v4hi __builtin_ia32_pmulhrw (v4hi, v4hi)
10905 @end smallexample
10907 The following built-in functions are available when both @option{-m3dnow}
10908 and @option{-march=athlon} are used.  All of them generate the machine
10909 instruction that is part of the name.
10911 @smallexample
10912 v2si __builtin_ia32_pf2iw (v2sf)
10913 v2sf __builtin_ia32_pfnacc (v2sf, v2sf)
10914 v2sf __builtin_ia32_pfpnacc (v2sf, v2sf)
10915 v2sf __builtin_ia32_pi2fw (v2si)
10916 v2sf __builtin_ia32_pswapdsf (v2sf)
10917 v2si __builtin_ia32_pswapdsi (v2si)
10918 @end smallexample
10920 @node MIPS DSP Built-in Functions
10921 @subsection MIPS DSP Built-in Functions
10923 The MIPS DSP Application-Specific Extension (ASE) includes new
10924 instructions that are designed to improve the performance of DSP and
10925 media applications.  It provides instructions that operate on packed
10926 8-bit/16-bit integer data, Q7, Q15 and Q31 fractional data.
10928 GCC supports MIPS DSP operations using both the generic
10929 vector extensions (@pxref{Vector Extensions}) and a collection of
10930 MIPS-specific built-in functions.  Both kinds of support are
10931 enabled by the @option{-mdsp} command-line option.
10933 Revision 2 of the ASE was introduced in the second half of 2006.
10934 This revision adds extra instructions to the original ASE, but is
10935 otherwise backwards-compatible with it.  You can select revision 2
10936 using the command-line option @option{-mdspr2}; this option implies
10937 @option{-mdsp}.
10939 The SCOUNT and POS bits of the DSP control register are global.  The
10940 WRDSP, EXTPDP, EXTPDPV and MTHLIP instructions modify the SCOUNT and
10941 POS bits.  During optimization, the compiler does not delete these
10942 instructions and it does not delete calls to functions containing
10943 these instructions.
10945 At present, GCC only provides support for operations on 32-bit
10946 vectors.  The vector type associated with 8-bit integer data is
10947 usually called @code{v4i8}, the vector type associated with Q7
10948 is usually called @code{v4q7}, the vector type associated with 16-bit
10949 integer data is usually called @code{v2i16}, and the vector type
10950 associated with Q15 is usually called @code{v2q15}.  They can be
10951 defined in C as follows:
10953 @smallexample
10954 typedef signed char v4i8 __attribute__ ((vector_size(4)));
10955 typedef signed char v4q7 __attribute__ ((vector_size(4)));
10956 typedef short v2i16 __attribute__ ((vector_size(4)));
10957 typedef short v2q15 __attribute__ ((vector_size(4)));
10958 @end smallexample
10960 @code{v4i8}, @code{v4q7}, @code{v2i16} and @code{v2q15} values are
10961 initialized in the same way as aggregates.  For example:
10963 @smallexample
10964 v4i8 a = @{1, 2, 3, 4@};
10965 v4i8 b;
10966 b = (v4i8) @{5, 6, 7, 8@};
10968 v2q15 c = @{0x0fcb, 0x3a75@};
10969 v2q15 d;
10970 d = (v2q15) @{0.1234 * 0x1.0p15, 0.4567 * 0x1.0p15@};
10971 @end smallexample
10973 @emph{Note:} The CPU's endianness determines the order in which values
10974 are packed.  On little-endian targets, the first value is the least
10975 significant and the last value is the most significant.  The opposite
10976 order applies to big-endian targets.  For example, the code above
10977 sets the lowest byte of @code{a} to @code{1} on little-endian targets
10978 and @code{4} on big-endian targets.
10980 @emph{Note:} Q7, Q15 and Q31 values must be initialized with their integer
10981 representation.  As shown in this example, the integer representation
10982 of a Q7 value can be obtained by multiplying the fractional value by
10983 @code{0x1.0p7}.  The equivalent for Q15 values is to multiply by
10984 @code{0x1.0p15}.  The equivalent for Q31 values is to multiply by
10985 @code{0x1.0p31}.
10987 The table below lists the @code{v4i8} and @code{v2q15} operations for which
10988 hardware support exists.  @code{a} and @code{b} are @code{v4i8} values,
10989 and @code{c} and @code{d} are @code{v2q15} values.
10991 @multitable @columnfractions .50 .50
10992 @item C code @tab MIPS instruction
10993 @item @code{a + b} @tab @code{addu.qb}
10994 @item @code{c + d} @tab @code{addq.ph}
10995 @item @code{a - b} @tab @code{subu.qb}
10996 @item @code{c - d} @tab @code{subq.ph}
10997 @end multitable
10999 The table below lists the @code{v2i16} operation for which
11000 hardware support exists for the DSP ASE REV 2.  @code{e} and @code{f} are
11001 @code{v2i16} values.
11003 @multitable @columnfractions .50 .50
11004 @item C code @tab MIPS instruction
11005 @item @code{e * f} @tab @code{mul.ph}
11006 @end multitable
11008 It is easier to describe the DSP built-in functions if we first define
11009 the following types:
11011 @smallexample
11012 typedef int q31;
11013 typedef int i32;
11014 typedef unsigned int ui32;
11015 typedef long long a64;
11016 @end smallexample
11018 @code{q31} and @code{i32} are actually the same as @code{int}, but we
11019 use @code{q31} to indicate a Q31 fractional value and @code{i32} to
11020 indicate a 32-bit integer value.  Similarly, @code{a64} is the same as
11021 @code{long long}, but we use @code{a64} to indicate values that are
11022 placed in one of the four DSP accumulators (@code{$ac0},
11023 @code{$ac1}, @code{$ac2} or @code{$ac3}).
11025 Also, some built-in functions prefer or require immediate numbers as
11026 parameters, because the corresponding DSP instructions accept both immediate
11027 numbers and register operands, or accept immediate numbers only.  The
11028 immediate parameters are listed as follows.
11030 @smallexample
11031 imm0_3: 0 to 3.
11032 imm0_7: 0 to 7.
11033 imm0_15: 0 to 15.
11034 imm0_31: 0 to 31.
11035 imm0_63: 0 to 63.
11036 imm0_255: 0 to 255.
11037 imm_n32_31: -32 to 31.
11038 imm_n512_511: -512 to 511.
11039 @end smallexample
11041 The following built-in functions map directly to a particular MIPS DSP
11042 instruction.  Please refer to the architecture specification
11043 for details on what each instruction does.
11045 @smallexample
11046 v2q15 __builtin_mips_addq_ph (v2q15, v2q15)
11047 v2q15 __builtin_mips_addq_s_ph (v2q15, v2q15)
11048 q31 __builtin_mips_addq_s_w (q31, q31)
11049 v4i8 __builtin_mips_addu_qb (v4i8, v4i8)
11050 v4i8 __builtin_mips_addu_s_qb (v4i8, v4i8)
11051 v2q15 __builtin_mips_subq_ph (v2q15, v2q15)
11052 v2q15 __builtin_mips_subq_s_ph (v2q15, v2q15)
11053 q31 __builtin_mips_subq_s_w (q31, q31)
11054 v4i8 __builtin_mips_subu_qb (v4i8, v4i8)
11055 v4i8 __builtin_mips_subu_s_qb (v4i8, v4i8)
11056 i32 __builtin_mips_addsc (i32, i32)
11057 i32 __builtin_mips_addwc (i32, i32)
11058 i32 __builtin_mips_modsub (i32, i32)
11059 i32 __builtin_mips_raddu_w_qb (v4i8)
11060 v2q15 __builtin_mips_absq_s_ph (v2q15)
11061 q31 __builtin_mips_absq_s_w (q31)
11062 v4i8 __builtin_mips_precrq_qb_ph (v2q15, v2q15)
11063 v2q15 __builtin_mips_precrq_ph_w (q31, q31)
11064 v2q15 __builtin_mips_precrq_rs_ph_w (q31, q31)
11065 v4i8 __builtin_mips_precrqu_s_qb_ph (v2q15, v2q15)
11066 q31 __builtin_mips_preceq_w_phl (v2q15)
11067 q31 __builtin_mips_preceq_w_phr (v2q15)
11068 v2q15 __builtin_mips_precequ_ph_qbl (v4i8)
11069 v2q15 __builtin_mips_precequ_ph_qbr (v4i8)
11070 v2q15 __builtin_mips_precequ_ph_qbla (v4i8)
11071 v2q15 __builtin_mips_precequ_ph_qbra (v4i8)
11072 v2q15 __builtin_mips_preceu_ph_qbl (v4i8)
11073 v2q15 __builtin_mips_preceu_ph_qbr (v4i8)
11074 v2q15 __builtin_mips_preceu_ph_qbla (v4i8)
11075 v2q15 __builtin_mips_preceu_ph_qbra (v4i8)
11076 v4i8 __builtin_mips_shll_qb (v4i8, imm0_7)
11077 v4i8 __builtin_mips_shll_qb (v4i8, i32)
11078 v2q15 __builtin_mips_shll_ph (v2q15, imm0_15)
11079 v2q15 __builtin_mips_shll_ph (v2q15, i32)
11080 v2q15 __builtin_mips_shll_s_ph (v2q15, imm0_15)
11081 v2q15 __builtin_mips_shll_s_ph (v2q15, i32)
11082 q31 __builtin_mips_shll_s_w (q31, imm0_31)
11083 q31 __builtin_mips_shll_s_w (q31, i32)
11084 v4i8 __builtin_mips_shrl_qb (v4i8, imm0_7)
11085 v4i8 __builtin_mips_shrl_qb (v4i8, i32)
11086 v2q15 __builtin_mips_shra_ph (v2q15, imm0_15)
11087 v2q15 __builtin_mips_shra_ph (v2q15, i32)
11088 v2q15 __builtin_mips_shra_r_ph (v2q15, imm0_15)
11089 v2q15 __builtin_mips_shra_r_ph (v2q15, i32)
11090 q31 __builtin_mips_shra_r_w (q31, imm0_31)
11091 q31 __builtin_mips_shra_r_w (q31, i32)
11092 v2q15 __builtin_mips_muleu_s_ph_qbl (v4i8, v2q15)
11093 v2q15 __builtin_mips_muleu_s_ph_qbr (v4i8, v2q15)
11094 v2q15 __builtin_mips_mulq_rs_ph (v2q15, v2q15)
11095 q31 __builtin_mips_muleq_s_w_phl (v2q15, v2q15)
11096 q31 __builtin_mips_muleq_s_w_phr (v2q15, v2q15)
11097 a64 __builtin_mips_dpau_h_qbl (a64, v4i8, v4i8)
11098 a64 __builtin_mips_dpau_h_qbr (a64, v4i8, v4i8)
11099 a64 __builtin_mips_dpsu_h_qbl (a64, v4i8, v4i8)
11100 a64 __builtin_mips_dpsu_h_qbr (a64, v4i8, v4i8)
11101 a64 __builtin_mips_dpaq_s_w_ph (a64, v2q15, v2q15)
11102 a64 __builtin_mips_dpaq_sa_l_w (a64, q31, q31)
11103 a64 __builtin_mips_dpsq_s_w_ph (a64, v2q15, v2q15)
11104 a64 __builtin_mips_dpsq_sa_l_w (a64, q31, q31)
11105 a64 __builtin_mips_mulsaq_s_w_ph (a64, v2q15, v2q15)
11106 a64 __builtin_mips_maq_s_w_phl (a64, v2q15, v2q15)
11107 a64 __builtin_mips_maq_s_w_phr (a64, v2q15, v2q15)
11108 a64 __builtin_mips_maq_sa_w_phl (a64, v2q15, v2q15)
11109 a64 __builtin_mips_maq_sa_w_phr (a64, v2q15, v2q15)
11110 i32 __builtin_mips_bitrev (i32)
11111 i32 __builtin_mips_insv (i32, i32)
11112 v4i8 __builtin_mips_repl_qb (imm0_255)
11113 v4i8 __builtin_mips_repl_qb (i32)
11114 v2q15 __builtin_mips_repl_ph (imm_n512_511)
11115 v2q15 __builtin_mips_repl_ph (i32)
11116 void __builtin_mips_cmpu_eq_qb (v4i8, v4i8)
11117 void __builtin_mips_cmpu_lt_qb (v4i8, v4i8)
11118 void __builtin_mips_cmpu_le_qb (v4i8, v4i8)
11119 i32 __builtin_mips_cmpgu_eq_qb (v4i8, v4i8)
11120 i32 __builtin_mips_cmpgu_lt_qb (v4i8, v4i8)
11121 i32 __builtin_mips_cmpgu_le_qb (v4i8, v4i8)
11122 void __builtin_mips_cmp_eq_ph (v2q15, v2q15)
11123 void __builtin_mips_cmp_lt_ph (v2q15, v2q15)
11124 void __builtin_mips_cmp_le_ph (v2q15, v2q15)
11125 v4i8 __builtin_mips_pick_qb (v4i8, v4i8)
11126 v2q15 __builtin_mips_pick_ph (v2q15, v2q15)
11127 v2q15 __builtin_mips_packrl_ph (v2q15, v2q15)
11128 i32 __builtin_mips_extr_w (a64, imm0_31)
11129 i32 __builtin_mips_extr_w (a64, i32)
11130 i32 __builtin_mips_extr_r_w (a64, imm0_31)
11131 i32 __builtin_mips_extr_s_h (a64, i32)
11132 i32 __builtin_mips_extr_rs_w (a64, imm0_31)
11133 i32 __builtin_mips_extr_rs_w (a64, i32)
11134 i32 __builtin_mips_extr_s_h (a64, imm0_31)
11135 i32 __builtin_mips_extr_r_w (a64, i32)
11136 i32 __builtin_mips_extp (a64, imm0_31)
11137 i32 __builtin_mips_extp (a64, i32)
11138 i32 __builtin_mips_extpdp (a64, imm0_31)
11139 i32 __builtin_mips_extpdp (a64, i32)
11140 a64 __builtin_mips_shilo (a64, imm_n32_31)
11141 a64 __builtin_mips_shilo (a64, i32)
11142 a64 __builtin_mips_mthlip (a64, i32)
11143 void __builtin_mips_wrdsp (i32, imm0_63)
11144 i32 __builtin_mips_rddsp (imm0_63)
11145 i32 __builtin_mips_lbux (void *, i32)
11146 i32 __builtin_mips_lhx (void *, i32)
11147 i32 __builtin_mips_lwx (void *, i32)
11148 a64 __builtin_mips_ldx (void *, i32) [MIPS64 only]
11149 i32 __builtin_mips_bposge32 (void)
11150 a64 __builtin_mips_madd (a64, i32, i32);
11151 a64 __builtin_mips_maddu (a64, ui32, ui32);
11152 a64 __builtin_mips_msub (a64, i32, i32);
11153 a64 __builtin_mips_msubu (a64, ui32, ui32);
11154 a64 __builtin_mips_mult (i32, i32);
11155 a64 __builtin_mips_multu (ui32, ui32);
11156 @end smallexample
11158 The following built-in functions map directly to a particular MIPS DSP REV 2
11159 instruction.  Please refer to the architecture specification
11160 for details on what each instruction does.
11162 @smallexample
11163 v4q7 __builtin_mips_absq_s_qb (v4q7);
11164 v2i16 __builtin_mips_addu_ph (v2i16, v2i16);
11165 v2i16 __builtin_mips_addu_s_ph (v2i16, v2i16);
11166 v4i8 __builtin_mips_adduh_qb (v4i8, v4i8);
11167 v4i8 __builtin_mips_adduh_r_qb (v4i8, v4i8);
11168 i32 __builtin_mips_append (i32, i32, imm0_31);
11169 i32 __builtin_mips_balign (i32, i32, imm0_3);
11170 i32 __builtin_mips_cmpgdu_eq_qb (v4i8, v4i8);
11171 i32 __builtin_mips_cmpgdu_lt_qb (v4i8, v4i8);
11172 i32 __builtin_mips_cmpgdu_le_qb (v4i8, v4i8);
11173 a64 __builtin_mips_dpa_w_ph (a64, v2i16, v2i16);
11174 a64 __builtin_mips_dps_w_ph (a64, v2i16, v2i16);
11175 v2i16 __builtin_mips_mul_ph (v2i16, v2i16);
11176 v2i16 __builtin_mips_mul_s_ph (v2i16, v2i16);
11177 q31 __builtin_mips_mulq_rs_w (q31, q31);
11178 v2q15 __builtin_mips_mulq_s_ph (v2q15, v2q15);
11179 q31 __builtin_mips_mulq_s_w (q31, q31);
11180 a64 __builtin_mips_mulsa_w_ph (a64, v2i16, v2i16);
11181 v4i8 __builtin_mips_precr_qb_ph (v2i16, v2i16);
11182 v2i16 __builtin_mips_precr_sra_ph_w (i32, i32, imm0_31);
11183 v2i16 __builtin_mips_precr_sra_r_ph_w (i32, i32, imm0_31);
11184 i32 __builtin_mips_prepend (i32, i32, imm0_31);
11185 v4i8 __builtin_mips_shra_qb (v4i8, imm0_7);
11186 v4i8 __builtin_mips_shra_r_qb (v4i8, imm0_7);
11187 v4i8 __builtin_mips_shra_qb (v4i8, i32);
11188 v4i8 __builtin_mips_shra_r_qb (v4i8, i32);
11189 v2i16 __builtin_mips_shrl_ph (v2i16, imm0_15);
11190 v2i16 __builtin_mips_shrl_ph (v2i16, i32);
11191 v2i16 __builtin_mips_subu_ph (v2i16, v2i16);
11192 v2i16 __builtin_mips_subu_s_ph (v2i16, v2i16);
11193 v4i8 __builtin_mips_subuh_qb (v4i8, v4i8);
11194 v4i8 __builtin_mips_subuh_r_qb (v4i8, v4i8);
11195 v2q15 __builtin_mips_addqh_ph (v2q15, v2q15);
11196 v2q15 __builtin_mips_addqh_r_ph (v2q15, v2q15);
11197 q31 __builtin_mips_addqh_w (q31, q31);
11198 q31 __builtin_mips_addqh_r_w (q31, q31);
11199 v2q15 __builtin_mips_subqh_ph (v2q15, v2q15);
11200 v2q15 __builtin_mips_subqh_r_ph (v2q15, v2q15);
11201 q31 __builtin_mips_subqh_w (q31, q31);
11202 q31 __builtin_mips_subqh_r_w (q31, q31);
11203 a64 __builtin_mips_dpax_w_ph (a64, v2i16, v2i16);
11204 a64 __builtin_mips_dpsx_w_ph (a64, v2i16, v2i16);
11205 a64 __builtin_mips_dpaqx_s_w_ph (a64, v2q15, v2q15);
11206 a64 __builtin_mips_dpaqx_sa_w_ph (a64, v2q15, v2q15);
11207 a64 __builtin_mips_dpsqx_s_w_ph (a64, v2q15, v2q15);
11208 a64 __builtin_mips_dpsqx_sa_w_ph (a64, v2q15, v2q15);
11209 @end smallexample
11212 @node MIPS Paired-Single Support
11213 @subsection MIPS Paired-Single Support
11215 The MIPS64 architecture includes a number of instructions that
11216 operate on pairs of single-precision floating-point values.
11217 Each pair is packed into a 64-bit floating-point register,
11218 with one element being designated the ``upper half'' and
11219 the other being designated the ``lower half''.
11221 GCC supports paired-single operations using both the generic
11222 vector extensions (@pxref{Vector Extensions}) and a collection of
11223 MIPS-specific built-in functions.  Both kinds of support are
11224 enabled by the @option{-mpaired-single} command-line option.
11226 The vector type associated with paired-single values is usually
11227 called @code{v2sf}.  It can be defined in C as follows:
11229 @smallexample
11230 typedef float v2sf __attribute__ ((vector_size (8)));
11231 @end smallexample
11233 @code{v2sf} values are initialized in the same way as aggregates.
11234 For example:
11236 @smallexample
11237 v2sf a = @{1.5, 9.1@};
11238 v2sf b;
11239 float e, f;
11240 b = (v2sf) @{e, f@};
11241 @end smallexample
11243 @emph{Note:} The CPU's endianness determines which value is stored in
11244 the upper half of a register and which value is stored in the lower half.
11245 On little-endian targets, the first value is the lower one and the second
11246 value is the upper one.  The opposite order applies to big-endian targets.
11247 For example, the code above sets the lower half of @code{a} to
11248 @code{1.5} on little-endian targets and @code{9.1} on big-endian targets.
11250 @node MIPS Loongson Built-in Functions
11251 @subsection MIPS Loongson Built-in Functions
11253 GCC provides intrinsics to access the SIMD instructions provided by the
11254 ST Microelectronics Loongson-2E and -2F processors.  These intrinsics,
11255 available after inclusion of the @code{loongson.h} header file,
11256 operate on the following 64-bit vector types:
11258 @itemize
11259 @item @code{uint8x8_t}, a vector of eight unsigned 8-bit integers;
11260 @item @code{uint16x4_t}, a vector of four unsigned 16-bit integers;
11261 @item @code{uint32x2_t}, a vector of two unsigned 32-bit integers;
11262 @item @code{int8x8_t}, a vector of eight signed 8-bit integers;
11263 @item @code{int16x4_t}, a vector of four signed 16-bit integers;
11264 @item @code{int32x2_t}, a vector of two signed 32-bit integers.
11265 @end itemize
11267 The intrinsics provided are listed below; each is named after the
11268 machine instruction to which it corresponds, with suffixes added as
11269 appropriate to distinguish intrinsics that expand to the same machine
11270 instruction yet have different argument types.  Refer to the architecture
11271 documentation for a description of the functionality of each
11272 instruction.
11274 @smallexample
11275 int16x4_t packsswh (int32x2_t s, int32x2_t t);
11276 int8x8_t packsshb (int16x4_t s, int16x4_t t);
11277 uint8x8_t packushb (uint16x4_t s, uint16x4_t t);
11278 uint32x2_t paddw_u (uint32x2_t s, uint32x2_t t);
11279 uint16x4_t paddh_u (uint16x4_t s, uint16x4_t t);
11280 uint8x8_t paddb_u (uint8x8_t s, uint8x8_t t);
11281 int32x2_t paddw_s (int32x2_t s, int32x2_t t);
11282 int16x4_t paddh_s (int16x4_t s, int16x4_t t);
11283 int8x8_t paddb_s (int8x8_t s, int8x8_t t);
11284 uint64_t paddd_u (uint64_t s, uint64_t t);
11285 int64_t paddd_s (int64_t s, int64_t t);
11286 int16x4_t paddsh (int16x4_t s, int16x4_t t);
11287 int8x8_t paddsb (int8x8_t s, int8x8_t t);
11288 uint16x4_t paddush (uint16x4_t s, uint16x4_t t);
11289 uint8x8_t paddusb (uint8x8_t s, uint8x8_t t);
11290 uint64_t pandn_ud (uint64_t s, uint64_t t);
11291 uint32x2_t pandn_uw (uint32x2_t s, uint32x2_t t);
11292 uint16x4_t pandn_uh (uint16x4_t s, uint16x4_t t);
11293 uint8x8_t pandn_ub (uint8x8_t s, uint8x8_t t);
11294 int64_t pandn_sd (int64_t s, int64_t t);
11295 int32x2_t pandn_sw (int32x2_t s, int32x2_t t);
11296 int16x4_t pandn_sh (int16x4_t s, int16x4_t t);
11297 int8x8_t pandn_sb (int8x8_t s, int8x8_t t);
11298 uint16x4_t pavgh (uint16x4_t s, uint16x4_t t);
11299 uint8x8_t pavgb (uint8x8_t s, uint8x8_t t);
11300 uint32x2_t pcmpeqw_u (uint32x2_t s, uint32x2_t t);
11301 uint16x4_t pcmpeqh_u (uint16x4_t s, uint16x4_t t);
11302 uint8x8_t pcmpeqb_u (uint8x8_t s, uint8x8_t t);
11303 int32x2_t pcmpeqw_s (int32x2_t s, int32x2_t t);
11304 int16x4_t pcmpeqh_s (int16x4_t s, int16x4_t t);
11305 int8x8_t pcmpeqb_s (int8x8_t s, int8x8_t t);
11306 uint32x2_t pcmpgtw_u (uint32x2_t s, uint32x2_t t);
11307 uint16x4_t pcmpgth_u (uint16x4_t s, uint16x4_t t);
11308 uint8x8_t pcmpgtb_u (uint8x8_t s, uint8x8_t t);
11309 int32x2_t pcmpgtw_s (int32x2_t s, int32x2_t t);
11310 int16x4_t pcmpgth_s (int16x4_t s, int16x4_t t);
11311 int8x8_t pcmpgtb_s (int8x8_t s, int8x8_t t);
11312 uint16x4_t pextrh_u (uint16x4_t s, int field);
11313 int16x4_t pextrh_s (int16x4_t s, int field);
11314 uint16x4_t pinsrh_0_u (uint16x4_t s, uint16x4_t t);
11315 uint16x4_t pinsrh_1_u (uint16x4_t s, uint16x4_t t);
11316 uint16x4_t pinsrh_2_u (uint16x4_t s, uint16x4_t t);
11317 uint16x4_t pinsrh_3_u (uint16x4_t s, uint16x4_t t);
11318 int16x4_t pinsrh_0_s (int16x4_t s, int16x4_t t);
11319 int16x4_t pinsrh_1_s (int16x4_t s, int16x4_t t);
11320 int16x4_t pinsrh_2_s (int16x4_t s, int16x4_t t);
11321 int16x4_t pinsrh_3_s (int16x4_t s, int16x4_t t);
11322 int32x2_t pmaddhw (int16x4_t s, int16x4_t t);
11323 int16x4_t pmaxsh (int16x4_t s, int16x4_t t);
11324 uint8x8_t pmaxub (uint8x8_t s, uint8x8_t t);
11325 int16x4_t pminsh (int16x4_t s, int16x4_t t);
11326 uint8x8_t pminub (uint8x8_t s, uint8x8_t t);
11327 uint8x8_t pmovmskb_u (uint8x8_t s);
11328 int8x8_t pmovmskb_s (int8x8_t s);
11329 uint16x4_t pmulhuh (uint16x4_t s, uint16x4_t t);
11330 int16x4_t pmulhh (int16x4_t s, int16x4_t t);
11331 int16x4_t pmullh (int16x4_t s, int16x4_t t);
11332 int64_t pmuluw (uint32x2_t s, uint32x2_t t);
11333 uint8x8_t pasubub (uint8x8_t s, uint8x8_t t);
11334 uint16x4_t biadd (uint8x8_t s);
11335 uint16x4_t psadbh (uint8x8_t s, uint8x8_t t);
11336 uint16x4_t pshufh_u (uint16x4_t dest, uint16x4_t s, uint8_t order);
11337 int16x4_t pshufh_s (int16x4_t dest, int16x4_t s, uint8_t order);
11338 uint16x4_t psllh_u (uint16x4_t s, uint8_t amount);
11339 int16x4_t psllh_s (int16x4_t s, uint8_t amount);
11340 uint32x2_t psllw_u (uint32x2_t s, uint8_t amount);
11341 int32x2_t psllw_s (int32x2_t s, uint8_t amount);
11342 uint16x4_t psrlh_u (uint16x4_t s, uint8_t amount);
11343 int16x4_t psrlh_s (int16x4_t s, uint8_t amount);
11344 uint32x2_t psrlw_u (uint32x2_t s, uint8_t amount);
11345 int32x2_t psrlw_s (int32x2_t s, uint8_t amount);
11346 uint16x4_t psrah_u (uint16x4_t s, uint8_t amount);
11347 int16x4_t psrah_s (int16x4_t s, uint8_t amount);
11348 uint32x2_t psraw_u (uint32x2_t s, uint8_t amount);
11349 int32x2_t psraw_s (int32x2_t s, uint8_t amount);
11350 uint32x2_t psubw_u (uint32x2_t s, uint32x2_t t);
11351 uint16x4_t psubh_u (uint16x4_t s, uint16x4_t t);
11352 uint8x8_t psubb_u (uint8x8_t s, uint8x8_t t);
11353 int32x2_t psubw_s (int32x2_t s, int32x2_t t);
11354 int16x4_t psubh_s (int16x4_t s, int16x4_t t);
11355 int8x8_t psubb_s (int8x8_t s, int8x8_t t);
11356 uint64_t psubd_u (uint64_t s, uint64_t t);
11357 int64_t psubd_s (int64_t s, int64_t t);
11358 int16x4_t psubsh (int16x4_t s, int16x4_t t);
11359 int8x8_t psubsb (int8x8_t s, int8x8_t t);
11360 uint16x4_t psubush (uint16x4_t s, uint16x4_t t);
11361 uint8x8_t psubusb (uint8x8_t s, uint8x8_t t);
11362 uint32x2_t punpckhwd_u (uint32x2_t s, uint32x2_t t);
11363 uint16x4_t punpckhhw_u (uint16x4_t s, uint16x4_t t);
11364 uint8x8_t punpckhbh_u (uint8x8_t s, uint8x8_t t);
11365 int32x2_t punpckhwd_s (int32x2_t s, int32x2_t t);
11366 int16x4_t punpckhhw_s (int16x4_t s, int16x4_t t);
11367 int8x8_t punpckhbh_s (int8x8_t s, int8x8_t t);
11368 uint32x2_t punpcklwd_u (uint32x2_t s, uint32x2_t t);
11369 uint16x4_t punpcklhw_u (uint16x4_t s, uint16x4_t t);
11370 uint8x8_t punpcklbh_u (uint8x8_t s, uint8x8_t t);
11371 int32x2_t punpcklwd_s (int32x2_t s, int32x2_t t);
11372 int16x4_t punpcklhw_s (int16x4_t s, int16x4_t t);
11373 int8x8_t punpcklbh_s (int8x8_t s, int8x8_t t);
11374 @end smallexample
11376 @menu
11377 * Paired-Single Arithmetic::
11378 * Paired-Single Built-in Functions::
11379 * MIPS-3D Built-in Functions::
11380 @end menu
11382 @node Paired-Single Arithmetic
11383 @subsubsection Paired-Single Arithmetic
11385 The table below lists the @code{v2sf} operations for which hardware
11386 support exists.  @code{a}, @code{b} and @code{c} are @code{v2sf}
11387 values and @code{x} is an integral value.
11389 @multitable @columnfractions .50 .50
11390 @item C code @tab MIPS instruction
11391 @item @code{a + b} @tab @code{add.ps}
11392 @item @code{a - b} @tab @code{sub.ps}
11393 @item @code{-a} @tab @code{neg.ps}
11394 @item @code{a * b} @tab @code{mul.ps}
11395 @item @code{a * b + c} @tab @code{madd.ps}
11396 @item @code{a * b - c} @tab @code{msub.ps}
11397 @item @code{-(a * b + c)} @tab @code{nmadd.ps}
11398 @item @code{-(a * b - c)} @tab @code{nmsub.ps}
11399 @item @code{x ? a : b} @tab @code{movn.ps}/@code{movz.ps}
11400 @end multitable
11402 Note that the multiply-accumulate instructions can be disabled
11403 using the command-line option @code{-mno-fused-madd}.
11405 @node Paired-Single Built-in Functions
11406 @subsubsection Paired-Single Built-in Functions
11408 The following paired-single functions map directly to a particular
11409 MIPS instruction.  Please refer to the architecture specification
11410 for details on what each instruction does.
11412 @table @code
11413 @item v2sf __builtin_mips_pll_ps (v2sf, v2sf)
11414 Pair lower lower (@code{pll.ps}).
11416 @item v2sf __builtin_mips_pul_ps (v2sf, v2sf)
11417 Pair upper lower (@code{pul.ps}).
11419 @item v2sf __builtin_mips_plu_ps (v2sf, v2sf)
11420 Pair lower upper (@code{plu.ps}).
11422 @item v2sf __builtin_mips_puu_ps (v2sf, v2sf)
11423 Pair upper upper (@code{puu.ps}).
11425 @item v2sf __builtin_mips_cvt_ps_s (float, float)
11426 Convert pair to paired single (@code{cvt.ps.s}).
11428 @item float __builtin_mips_cvt_s_pl (v2sf)
11429 Convert pair lower to single (@code{cvt.s.pl}).
11431 @item float __builtin_mips_cvt_s_pu (v2sf)
11432 Convert pair upper to single (@code{cvt.s.pu}).
11434 @item v2sf __builtin_mips_abs_ps (v2sf)
11435 Absolute value (@code{abs.ps}).
11437 @item v2sf __builtin_mips_alnv_ps (v2sf, v2sf, int)
11438 Align variable (@code{alnv.ps}).
11440 @emph{Note:} The value of the third parameter must be 0 or 4
11441 modulo 8, otherwise the result is unpredictable.  Please read the
11442 instruction description for details.
11443 @end table
11445 The following multi-instruction functions are also available.
11446 In each case, @var{cond} can be any of the 16 floating-point conditions:
11447 @code{f}, @code{un}, @code{eq}, @code{ueq}, @code{olt}, @code{ult},
11448 @code{ole}, @code{ule}, @code{sf}, @code{ngle}, @code{seq}, @code{ngl},
11449 @code{lt}, @code{nge}, @code{le} or @code{ngt}.
11451 @table @code
11452 @item v2sf __builtin_mips_movt_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
11453 @itemx v2sf __builtin_mips_movf_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
11454 Conditional move based on floating-point comparison (@code{c.@var{cond}.ps},
11455 @code{movt.ps}/@code{movf.ps}).
11457 The @code{movt} functions return the value @var{x} computed by:
11459 @smallexample
11460 c.@var{cond}.ps @var{cc},@var{a},@var{b}
11461 mov.ps @var{x},@var{c}
11462 movt.ps @var{x},@var{d},@var{cc}
11463 @end smallexample
11465 The @code{movf} functions are similar but use @code{movf.ps} instead
11466 of @code{movt.ps}.
11468 @item int __builtin_mips_upper_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
11469 @itemx int __builtin_mips_lower_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
11470 Comparison of two paired-single values (@code{c.@var{cond}.ps},
11471 @code{bc1t}/@code{bc1f}).
11473 These functions compare @var{a} and @var{b} using @code{c.@var{cond}.ps}
11474 and return either the upper or lower half of the result.  For example:
11476 @smallexample
11477 v2sf a, b;
11478 if (__builtin_mips_upper_c_eq_ps (a, b))
11479   upper_halves_are_equal ();
11480 else
11481   upper_halves_are_unequal ();
11483 if (__builtin_mips_lower_c_eq_ps (a, b))
11484   lower_halves_are_equal ();
11485 else
11486   lower_halves_are_unequal ();
11487 @end smallexample
11488 @end table
11490 @node MIPS-3D Built-in Functions
11491 @subsubsection MIPS-3D Built-in Functions
11493 The MIPS-3D Application-Specific Extension (ASE) includes additional
11494 paired-single instructions that are designed to improve the performance
11495 of 3D graphics operations.  Support for these instructions is controlled
11496 by the @option{-mips3d} command-line option.
11498 The functions listed below map directly to a particular MIPS-3D
11499 instruction.  Please refer to the architecture specification for
11500 more details on what each instruction does.
11502 @table @code
11503 @item v2sf __builtin_mips_addr_ps (v2sf, v2sf)
11504 Reduction add (@code{addr.ps}).
11506 @item v2sf __builtin_mips_mulr_ps (v2sf, v2sf)
11507 Reduction multiply (@code{mulr.ps}).
11509 @item v2sf __builtin_mips_cvt_pw_ps (v2sf)
11510 Convert paired single to paired word (@code{cvt.pw.ps}).
11512 @item v2sf __builtin_mips_cvt_ps_pw (v2sf)
11513 Convert paired word to paired single (@code{cvt.ps.pw}).
11515 @item float __builtin_mips_recip1_s (float)
11516 @itemx double __builtin_mips_recip1_d (double)
11517 @itemx v2sf __builtin_mips_recip1_ps (v2sf)
11518 Reduced-precision reciprocal (sequence step 1) (@code{recip1.@var{fmt}}).
11520 @item float __builtin_mips_recip2_s (float, float)
11521 @itemx double __builtin_mips_recip2_d (double, double)
11522 @itemx v2sf __builtin_mips_recip2_ps (v2sf, v2sf)
11523 Reduced-precision reciprocal (sequence step 2) (@code{recip2.@var{fmt}}).
11525 @item float __builtin_mips_rsqrt1_s (float)
11526 @itemx double __builtin_mips_rsqrt1_d (double)
11527 @itemx v2sf __builtin_mips_rsqrt1_ps (v2sf)
11528 Reduced-precision reciprocal square root (sequence step 1)
11529 (@code{rsqrt1.@var{fmt}}).
11531 @item float __builtin_mips_rsqrt2_s (float, float)
11532 @itemx double __builtin_mips_rsqrt2_d (double, double)
11533 @itemx v2sf __builtin_mips_rsqrt2_ps (v2sf, v2sf)
11534 Reduced-precision reciprocal square root (sequence step 2)
11535 (@code{rsqrt2.@var{fmt}}).
11536 @end table
11538 The following multi-instruction functions are also available.
11539 In each case, @var{cond} can be any of the 16 floating-point conditions:
11540 @code{f}, @code{un}, @code{eq}, @code{ueq}, @code{olt}, @code{ult},
11541 @code{ole}, @code{ule}, @code{sf}, @code{ngle}, @code{seq},
11542 @code{ngl}, @code{lt}, @code{nge}, @code{le} or @code{ngt}.
11544 @table @code
11545 @item int __builtin_mips_cabs_@var{cond}_s (float @var{a}, float @var{b})
11546 @itemx int __builtin_mips_cabs_@var{cond}_d (double @var{a}, double @var{b})
11547 Absolute comparison of two scalar values (@code{cabs.@var{cond}.@var{fmt}},
11548 @code{bc1t}/@code{bc1f}).
11550 These functions compare @var{a} and @var{b} using @code{cabs.@var{cond}.s}
11551 or @code{cabs.@var{cond}.d} and return the result as a boolean value.
11552 For example:
11554 @smallexample
11555 float a, b;
11556 if (__builtin_mips_cabs_eq_s (a, b))
11557   true ();
11558 else
11559   false ();
11560 @end smallexample
11562 @item int __builtin_mips_upper_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
11563 @itemx int __builtin_mips_lower_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
11564 Absolute comparison of two paired-single values (@code{cabs.@var{cond}.ps},
11565 @code{bc1t}/@code{bc1f}).
11567 These functions compare @var{a} and @var{b} using @code{cabs.@var{cond}.ps}
11568 and return either the upper or lower half of the result.  For example:
11570 @smallexample
11571 v2sf a, b;
11572 if (__builtin_mips_upper_cabs_eq_ps (a, b))
11573   upper_halves_are_equal ();
11574 else
11575   upper_halves_are_unequal ();
11577 if (__builtin_mips_lower_cabs_eq_ps (a, b))
11578   lower_halves_are_equal ();
11579 else
11580   lower_halves_are_unequal ();
11581 @end smallexample
11583 @item v2sf __builtin_mips_movt_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
11584 @itemx v2sf __builtin_mips_movf_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
11585 Conditional move based on absolute comparison (@code{cabs.@var{cond}.ps},
11586 @code{movt.ps}/@code{movf.ps}).
11588 The @code{movt} functions return the value @var{x} computed by:
11590 @smallexample
11591 cabs.@var{cond}.ps @var{cc},@var{a},@var{b}
11592 mov.ps @var{x},@var{c}
11593 movt.ps @var{x},@var{d},@var{cc}
11594 @end smallexample
11596 The @code{movf} functions are similar but use @code{movf.ps} instead
11597 of @code{movt.ps}.
11599 @item int __builtin_mips_any_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
11600 @itemx int __builtin_mips_all_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
11601 @itemx int __builtin_mips_any_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
11602 @itemx int __builtin_mips_all_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
11603 Comparison of two paired-single values
11604 (@code{c.@var{cond}.ps}/@code{cabs.@var{cond}.ps},
11605 @code{bc1any2t}/@code{bc1any2f}).
11607 These functions compare @var{a} and @var{b} using @code{c.@var{cond}.ps}
11608 or @code{cabs.@var{cond}.ps}.  The @code{any} forms return true if either
11609 result is true and the @code{all} forms return true if both results are true.
11610 For example:
11612 @smallexample
11613 v2sf a, b;
11614 if (__builtin_mips_any_c_eq_ps (a, b))
11615   one_is_true ();
11616 else
11617   both_are_false ();
11619 if (__builtin_mips_all_c_eq_ps (a, b))
11620   both_are_true ();
11621 else
11622   one_is_false ();
11623 @end smallexample
11625 @item int __builtin_mips_any_c_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
11626 @itemx int __builtin_mips_all_c_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
11627 @itemx int __builtin_mips_any_cabs_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
11628 @itemx int __builtin_mips_all_cabs_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
11629 Comparison of four paired-single values
11630 (@code{c.@var{cond}.ps}/@code{cabs.@var{cond}.ps},
11631 @code{bc1any4t}/@code{bc1any4f}).
11633 These functions use @code{c.@var{cond}.ps} or @code{cabs.@var{cond}.ps}
11634 to compare @var{a} with @var{b} and to compare @var{c} with @var{d}.
11635 The @code{any} forms return true if any of the four results are true
11636 and the @code{all} forms return true if all four results are true.
11637 For example:
11639 @smallexample
11640 v2sf a, b, c, d;
11641 if (__builtin_mips_any_c_eq_4s (a, b, c, d))
11642   some_are_true ();
11643 else
11644   all_are_false ();
11646 if (__builtin_mips_all_c_eq_4s (a, b, c, d))
11647   all_are_true ();
11648 else
11649   some_are_false ();
11650 @end smallexample
11651 @end table
11653 @node picoChip Built-in Functions
11654 @subsection picoChip Built-in Functions
11656 GCC provides an interface to selected machine instructions from the
11657 picoChip instruction set.
11659 @table @code
11660 @item int __builtin_sbc (int @var{value})
11661 Sign bit count.  Return the number of consecutive bits in @var{value}
11662 that have the same value as the sign bit.  The result is the number of
11663 leading sign bits minus one, giving the number of redundant sign bits in
11664 @var{value}.
11666 @item int __builtin_byteswap (int @var{value})
11667 Byte swap.  Return the result of swapping the upper and lower bytes of
11668 @var{value}.
11670 @item int __builtin_brev (int @var{value})
11671 Bit reversal.  Return the result of reversing the bits in
11672 @var{value}.  Bit 15 is swapped with bit 0, bit 14 is swapped with bit 1,
11673 and so on.
11675 @item int __builtin_adds (int @var{x}, int @var{y})
11676 Saturating addition.  Return the result of adding @var{x} and @var{y},
11677 storing the value 32767 if the result overflows.
11679 @item int __builtin_subs (int @var{x}, int @var{y})
11680 Saturating subtraction.  Return the result of subtracting @var{y} from
11681 @var{x}, storing the value @minus{}32768 if the result overflows.
11683 @item void __builtin_halt (void)
11684 Halt.  The processor stops execution.  This built-in is useful for
11685 implementing assertions.
11687 @end table
11689 @node Other MIPS Built-in Functions
11690 @subsection Other MIPS Built-in Functions
11692 GCC provides other MIPS-specific built-in functions:
11694 @table @code
11695 @item void __builtin_mips_cache (int @var{op}, const volatile void *@var{addr})
11696 Insert a @samp{cache} instruction with operands @var{op} and @var{addr}.
11697 GCC defines the preprocessor macro @code{___GCC_HAVE_BUILTIN_MIPS_CACHE}
11698 when this function is available.
11699 @end table
11701 @node PowerPC Built-in Functions
11702 @subsection PowerPC Built-in Functions
11704 These built-in functions are available for the PowerPC family of
11705 processors:
11706 @smallexample
11707 float __builtin_recipdivf (float, float);
11708 float __builtin_rsqrtf (float);
11709 double __builtin_recipdiv (double, double);
11710 double __builtin_rsqrt (double);
11711 long __builtin_bpermd (long, long);
11712 uint64_t __builtin_ppc_get_timebase ();
11713 unsigned long __builtin_ppc_mftb ();
11714 @end smallexample
11716 The @code{vec_rsqrt}, @code{__builtin_rsqrt}, and
11717 @code{__builtin_rsqrtf} functions generate multiple instructions to
11718 implement the reciprocal sqrt functionality using reciprocal sqrt
11719 estimate instructions.
11721 The @code{__builtin_recipdiv}, and @code{__builtin_recipdivf}
11722 functions generate multiple instructions to implement division using
11723 the reciprocal estimate instructions.
11725 The @code{__builtin_ppc_get_timebase} and @code{__builtin_ppc_mftb}
11726 functions generate instructions to read the Time Base Register.  The
11727 @code{__builtin_ppc_get_timebase} function may generate multiple
11728 instructions and always returns the 64 bits of the Time Base Register.
11729 The @code{__builtin_ppc_mftb} function always generates one instruction and
11730 returns the Time Base Register value as an unsigned long, throwing away
11731 the most significant word on 32-bit environments.
11733 @node PowerPC AltiVec/VSX Built-in Functions
11734 @subsection PowerPC AltiVec Built-in Functions
11736 GCC provides an interface for the PowerPC family of processors to access
11737 the AltiVec operations described in Motorola's AltiVec Programming
11738 Interface Manual.  The interface is made available by including
11739 @code{<altivec.h>} and using @option{-maltivec} and
11740 @option{-mabi=altivec}.  The interface supports the following vector
11741 types.
11743 @smallexample
11744 vector unsigned char
11745 vector signed char
11746 vector bool char
11748 vector unsigned short
11749 vector signed short
11750 vector bool short
11751 vector pixel
11753 vector unsigned int
11754 vector signed int
11755 vector bool int
11756 vector float
11757 @end smallexample
11759 If @option{-mvsx} is used the following additional vector types are
11760 implemented.
11762 @smallexample
11763 vector unsigned long
11764 vector signed long
11765 vector double
11766 @end smallexample
11768 The long types are only implemented for 64-bit code generation, and
11769 the long type is only used in the floating point/integer conversion
11770 instructions.
11772 GCC's implementation of the high-level language interface available from
11773 C and C++ code differs from Motorola's documentation in several ways.
11775 @itemize @bullet
11777 @item
11778 A vector constant is a list of constant expressions within curly braces.
11780 @item
11781 A vector initializer requires no cast if the vector constant is of the
11782 same type as the variable it is initializing.
11784 @item
11785 If @code{signed} or @code{unsigned} is omitted, the signedness of the
11786 vector type is the default signedness of the base type.  The default
11787 varies depending on the operating system, so a portable program should
11788 always specify the signedness.
11790 @item
11791 Compiling with @option{-maltivec} adds keywords @code{__vector},
11792 @code{vector}, @code{__pixel}, @code{pixel}, @code{__bool} and
11793 @code{bool}.  When compiling ISO C, the context-sensitive substitution
11794 of the keywords @code{vector}, @code{pixel} and @code{bool} is
11795 disabled.  To use them, you must include @code{<altivec.h>} instead.
11797 @item
11798 GCC allows using a @code{typedef} name as the type specifier for a
11799 vector type.
11801 @item
11802 For C, overloaded functions are implemented with macros so the following
11803 does not work:
11805 @smallexample
11806   vec_add ((vector signed int)@{1, 2, 3, 4@}, foo);
11807 @end smallexample
11809 @noindent
11810 Since @code{vec_add} is a macro, the vector constant in the example
11811 is treated as four separate arguments.  Wrap the entire argument in
11812 parentheses for this to work.
11813 @end itemize
11815 @emph{Note:} Only the @code{<altivec.h>} interface is supported.
11816 Internally, GCC uses built-in functions to achieve the functionality in
11817 the aforementioned header file, but they are not supported and are
11818 subject to change without notice.
11820 The following interfaces are supported for the generic and specific
11821 AltiVec operations and the AltiVec predicates.  In cases where there
11822 is a direct mapping between generic and specific operations, only the
11823 generic names are shown here, although the specific operations can also
11824 be used.
11826 Arguments that are documented as @code{const int} require literal
11827 integral values within the range required for that operation.
11829 @smallexample
11830 vector signed char vec_abs (vector signed char);
11831 vector signed short vec_abs (vector signed short);
11832 vector signed int vec_abs (vector signed int);
11833 vector float vec_abs (vector float);
11835 vector signed char vec_abss (vector signed char);
11836 vector signed short vec_abss (vector signed short);
11837 vector signed int vec_abss (vector signed int);
11839 vector signed char vec_add (vector bool char, vector signed char);
11840 vector signed char vec_add (vector signed char, vector bool char);
11841 vector signed char vec_add (vector signed char, vector signed char);
11842 vector unsigned char vec_add (vector bool char, vector unsigned char);
11843 vector unsigned char vec_add (vector unsigned char, vector bool char);
11844 vector unsigned char vec_add (vector unsigned char,
11845                               vector unsigned char);
11846 vector signed short vec_add (vector bool short, vector signed short);
11847 vector signed short vec_add (vector signed short, vector bool short);
11848 vector signed short vec_add (vector signed short, vector signed short);
11849 vector unsigned short vec_add (vector bool short,
11850                                vector unsigned short);
11851 vector unsigned short vec_add (vector unsigned short,
11852                                vector bool short);
11853 vector unsigned short vec_add (vector unsigned short,
11854                                vector unsigned short);
11855 vector signed int vec_add (vector bool int, vector signed int);
11856 vector signed int vec_add (vector signed int, vector bool int);
11857 vector signed int vec_add (vector signed int, vector signed int);
11858 vector unsigned int vec_add (vector bool int, vector unsigned int);
11859 vector unsigned int vec_add (vector unsigned int, vector bool int);
11860 vector unsigned int vec_add (vector unsigned int, vector unsigned int);
11861 vector float vec_add (vector float, vector float);
11863 vector float vec_vaddfp (vector float, vector float);
11865 vector signed int vec_vadduwm (vector bool int, vector signed int);
11866 vector signed int vec_vadduwm (vector signed int, vector bool int);
11867 vector signed int vec_vadduwm (vector signed int, vector signed int);
11868 vector unsigned int vec_vadduwm (vector bool int, vector unsigned int);
11869 vector unsigned int vec_vadduwm (vector unsigned int, vector bool int);
11870 vector unsigned int vec_vadduwm (vector unsigned int,
11871                                  vector unsigned int);
11873 vector signed short vec_vadduhm (vector bool short,
11874                                  vector signed short);
11875 vector signed short vec_vadduhm (vector signed short,
11876                                  vector bool short);
11877 vector signed short vec_vadduhm (vector signed short,
11878                                  vector signed short);
11879 vector unsigned short vec_vadduhm (vector bool short,
11880                                    vector unsigned short);
11881 vector unsigned short vec_vadduhm (vector unsigned short,
11882                                    vector bool short);
11883 vector unsigned short vec_vadduhm (vector unsigned short,
11884                                    vector unsigned short);
11886 vector signed char vec_vaddubm (vector bool char, vector signed char);
11887 vector signed char vec_vaddubm (vector signed char, vector bool char);
11888 vector signed char vec_vaddubm (vector signed char, vector signed char);
11889 vector unsigned char vec_vaddubm (vector bool char,
11890                                   vector unsigned char);
11891 vector unsigned char vec_vaddubm (vector unsigned char,
11892                                   vector bool char);
11893 vector unsigned char vec_vaddubm (vector unsigned char,
11894                                   vector unsigned char);
11896 vector unsigned int vec_addc (vector unsigned int, vector unsigned int);
11898 vector unsigned char vec_adds (vector bool char, vector unsigned char);
11899 vector unsigned char vec_adds (vector unsigned char, vector bool char);
11900 vector unsigned char vec_adds (vector unsigned char,
11901                                vector unsigned char);
11902 vector signed char vec_adds (vector bool char, vector signed char);
11903 vector signed char vec_adds (vector signed char, vector bool char);
11904 vector signed char vec_adds (vector signed char, vector signed char);
11905 vector unsigned short vec_adds (vector bool short,
11906                                 vector unsigned short);
11907 vector unsigned short vec_adds (vector unsigned short,
11908                                 vector bool short);
11909 vector unsigned short vec_adds (vector unsigned short,
11910                                 vector unsigned short);
11911 vector signed short vec_adds (vector bool short, vector signed short);
11912 vector signed short vec_adds (vector signed short, vector bool short);
11913 vector signed short vec_adds (vector signed short, vector signed short);
11914 vector unsigned int vec_adds (vector bool int, vector unsigned int);
11915 vector unsigned int vec_adds (vector unsigned int, vector bool int);
11916 vector unsigned int vec_adds (vector unsigned int, vector unsigned int);
11917 vector signed int vec_adds (vector bool int, vector signed int);
11918 vector signed int vec_adds (vector signed int, vector bool int);
11919 vector signed int vec_adds (vector signed int, vector signed int);
11921 vector signed int vec_vaddsws (vector bool int, vector signed int);
11922 vector signed int vec_vaddsws (vector signed int, vector bool int);
11923 vector signed int vec_vaddsws (vector signed int, vector signed int);
11925 vector unsigned int vec_vadduws (vector bool int, vector unsigned int);
11926 vector unsigned int vec_vadduws (vector unsigned int, vector bool int);
11927 vector unsigned int vec_vadduws (vector unsigned int,
11928                                  vector unsigned int);
11930 vector signed short vec_vaddshs (vector bool short,
11931                                  vector signed short);
11932 vector signed short vec_vaddshs (vector signed short,
11933                                  vector bool short);
11934 vector signed short vec_vaddshs (vector signed short,
11935                                  vector signed short);
11937 vector unsigned short vec_vadduhs (vector bool short,
11938                                    vector unsigned short);
11939 vector unsigned short vec_vadduhs (vector unsigned short,
11940                                    vector bool short);
11941 vector unsigned short vec_vadduhs (vector unsigned short,
11942                                    vector unsigned short);
11944 vector signed char vec_vaddsbs (vector bool char, vector signed char);
11945 vector signed char vec_vaddsbs (vector signed char, vector bool char);
11946 vector signed char vec_vaddsbs (vector signed char, vector signed char);
11948 vector unsigned char vec_vaddubs (vector bool char,
11949                                   vector unsigned char);
11950 vector unsigned char vec_vaddubs (vector unsigned char,
11951                                   vector bool char);
11952 vector unsigned char vec_vaddubs (vector unsigned char,
11953                                   vector unsigned char);
11955 vector float vec_and (vector float, vector float);
11956 vector float vec_and (vector float, vector bool int);
11957 vector float vec_and (vector bool int, vector float);
11958 vector bool int vec_and (vector bool int, vector bool int);
11959 vector signed int vec_and (vector bool int, vector signed int);
11960 vector signed int vec_and (vector signed int, vector bool int);
11961 vector signed int vec_and (vector signed int, vector signed int);
11962 vector unsigned int vec_and (vector bool int, vector unsigned int);
11963 vector unsigned int vec_and (vector unsigned int, vector bool int);
11964 vector unsigned int vec_and (vector unsigned int, vector unsigned int);
11965 vector bool short vec_and (vector bool short, vector bool short);
11966 vector signed short vec_and (vector bool short, vector signed short);
11967 vector signed short vec_and (vector signed short, vector bool short);
11968 vector signed short vec_and (vector signed short, vector signed short);
11969 vector unsigned short vec_and (vector bool short,
11970                                vector unsigned short);
11971 vector unsigned short vec_and (vector unsigned short,
11972                                vector bool short);
11973 vector unsigned short vec_and (vector unsigned short,
11974                                vector unsigned short);
11975 vector signed char vec_and (vector bool char, vector signed char);
11976 vector bool char vec_and (vector bool char, vector bool char);
11977 vector signed char vec_and (vector signed char, vector bool char);
11978 vector signed char vec_and (vector signed char, vector signed char);
11979 vector unsigned char vec_and (vector bool char, vector unsigned char);
11980 vector unsigned char vec_and (vector unsigned char, vector bool char);
11981 vector unsigned char vec_and (vector unsigned char,
11982                               vector unsigned char);
11984 vector float vec_andc (vector float, vector float);
11985 vector float vec_andc (vector float, vector bool int);
11986 vector float vec_andc (vector bool int, vector float);
11987 vector bool int vec_andc (vector bool int, vector bool int);
11988 vector signed int vec_andc (vector bool int, vector signed int);
11989 vector signed int vec_andc (vector signed int, vector bool int);
11990 vector signed int vec_andc (vector signed int, vector signed int);
11991 vector unsigned int vec_andc (vector bool int, vector unsigned int);
11992 vector unsigned int vec_andc (vector unsigned int, vector bool int);
11993 vector unsigned int vec_andc (vector unsigned int, vector unsigned int);
11994 vector bool short vec_andc (vector bool short, vector bool short);
11995 vector signed short vec_andc (vector bool short, vector signed short);
11996 vector signed short vec_andc (vector signed short, vector bool short);
11997 vector signed short vec_andc (vector signed short, vector signed short);
11998 vector unsigned short vec_andc (vector bool short,
11999                                 vector unsigned short);
12000 vector unsigned short vec_andc (vector unsigned short,
12001                                 vector bool short);
12002 vector unsigned short vec_andc (vector unsigned short,
12003                                 vector unsigned short);
12004 vector signed char vec_andc (vector bool char, vector signed char);
12005 vector bool char vec_andc (vector bool char, vector bool char);
12006 vector signed char vec_andc (vector signed char, vector bool char);
12007 vector signed char vec_andc (vector signed char, vector signed char);
12008 vector unsigned char vec_andc (vector bool char, vector unsigned char);
12009 vector unsigned char vec_andc (vector unsigned char, vector bool char);
12010 vector unsigned char vec_andc (vector unsigned char,
12011                                vector unsigned char);
12013 vector unsigned char vec_avg (vector unsigned char,
12014                               vector unsigned char);
12015 vector signed char vec_avg (vector signed char, vector signed char);
12016 vector unsigned short vec_avg (vector unsigned short,
12017                                vector unsigned short);
12018 vector signed short vec_avg (vector signed short, vector signed short);
12019 vector unsigned int vec_avg (vector unsigned int, vector unsigned int);
12020 vector signed int vec_avg (vector signed int, vector signed int);
12022 vector signed int vec_vavgsw (vector signed int, vector signed int);
12024 vector unsigned int vec_vavguw (vector unsigned int,
12025                                 vector unsigned int);
12027 vector signed short vec_vavgsh (vector signed short,
12028                                 vector signed short);
12030 vector unsigned short vec_vavguh (vector unsigned short,
12031                                   vector unsigned short);
12033 vector signed char vec_vavgsb (vector signed char, vector signed char);
12035 vector unsigned char vec_vavgub (vector unsigned char,
12036                                  vector unsigned char);
12038 vector float vec_copysign (vector float);
12040 vector float vec_ceil (vector float);
12042 vector signed int vec_cmpb (vector float, vector float);
12044 vector bool char vec_cmpeq (vector signed char, vector signed char);
12045 vector bool char vec_cmpeq (vector unsigned char, vector unsigned char);
12046 vector bool short vec_cmpeq (vector signed short, vector signed short);
12047 vector bool short vec_cmpeq (vector unsigned short,
12048                              vector unsigned short);
12049 vector bool int vec_cmpeq (vector signed int, vector signed int);
12050 vector bool int vec_cmpeq (vector unsigned int, vector unsigned int);
12051 vector bool int vec_cmpeq (vector float, vector float);
12053 vector bool int vec_vcmpeqfp (vector float, vector float);
12055 vector bool int vec_vcmpequw (vector signed int, vector signed int);
12056 vector bool int vec_vcmpequw (vector unsigned int, vector unsigned int);
12058 vector bool short vec_vcmpequh (vector signed short,
12059                                 vector signed short);
12060 vector bool short vec_vcmpequh (vector unsigned short,
12061                                 vector unsigned short);
12063 vector bool char vec_vcmpequb (vector signed char, vector signed char);
12064 vector bool char vec_vcmpequb (vector unsigned char,
12065                                vector unsigned char);
12067 vector bool int vec_cmpge (vector float, vector float);
12069 vector bool char vec_cmpgt (vector unsigned char, vector unsigned char);
12070 vector bool char vec_cmpgt (vector signed char, vector signed char);
12071 vector bool short vec_cmpgt (vector unsigned short,
12072                              vector unsigned short);
12073 vector bool short vec_cmpgt (vector signed short, vector signed short);
12074 vector bool int vec_cmpgt (vector unsigned int, vector unsigned int);
12075 vector bool int vec_cmpgt (vector signed int, vector signed int);
12076 vector bool int vec_cmpgt (vector float, vector float);
12078 vector bool int vec_vcmpgtfp (vector float, vector float);
12080 vector bool int vec_vcmpgtsw (vector signed int, vector signed int);
12082 vector bool int vec_vcmpgtuw (vector unsigned int, vector unsigned int);
12084 vector bool short vec_vcmpgtsh (vector signed short,
12085                                 vector signed short);
12087 vector bool short vec_vcmpgtuh (vector unsigned short,
12088                                 vector unsigned short);
12090 vector bool char vec_vcmpgtsb (vector signed char, vector signed char);
12092 vector bool char vec_vcmpgtub (vector unsigned char,
12093                                vector unsigned char);
12095 vector bool int vec_cmple (vector float, vector float);
12097 vector bool char vec_cmplt (vector unsigned char, vector unsigned char);
12098 vector bool char vec_cmplt (vector signed char, vector signed char);
12099 vector bool short vec_cmplt (vector unsigned short,
12100                              vector unsigned short);
12101 vector bool short vec_cmplt (vector signed short, vector signed short);
12102 vector bool int vec_cmplt (vector unsigned int, vector unsigned int);
12103 vector bool int vec_cmplt (vector signed int, vector signed int);
12104 vector bool int vec_cmplt (vector float, vector float);
12106 vector float vec_ctf (vector unsigned int, const int);
12107 vector float vec_ctf (vector signed int, const int);
12109 vector float vec_vcfsx (vector signed int, const int);
12111 vector float vec_vcfux (vector unsigned int, const int);
12113 vector signed int vec_cts (vector float, const int);
12115 vector unsigned int vec_ctu (vector float, const int);
12117 void vec_dss (const int);
12119 void vec_dssall (void);
12121 void vec_dst (const vector unsigned char *, int, const int);
12122 void vec_dst (const vector signed char *, int, const int);
12123 void vec_dst (const vector bool char *, int, const int);
12124 void vec_dst (const vector unsigned short *, int, const int);
12125 void vec_dst (const vector signed short *, int, const int);
12126 void vec_dst (const vector bool short *, int, const int);
12127 void vec_dst (const vector pixel *, int, const int);
12128 void vec_dst (const vector unsigned int *, int, const int);
12129 void vec_dst (const vector signed int *, int, const int);
12130 void vec_dst (const vector bool int *, int, const int);
12131 void vec_dst (const vector float *, int, const int);
12132 void vec_dst (const unsigned char *, int, const int);
12133 void vec_dst (const signed char *, int, const int);
12134 void vec_dst (const unsigned short *, int, const int);
12135 void vec_dst (const short *, int, const int);
12136 void vec_dst (const unsigned int *, int, const int);
12137 void vec_dst (const int *, int, const int);
12138 void vec_dst (const unsigned long *, int, const int);
12139 void vec_dst (const long *, int, const int);
12140 void vec_dst (const float *, int, const int);
12142 void vec_dstst (const vector unsigned char *, int, const int);
12143 void vec_dstst (const vector signed char *, int, const int);
12144 void vec_dstst (const vector bool char *, int, const int);
12145 void vec_dstst (const vector unsigned short *, int, const int);
12146 void vec_dstst (const vector signed short *, int, const int);
12147 void vec_dstst (const vector bool short *, int, const int);
12148 void vec_dstst (const vector pixel *, int, const int);
12149 void vec_dstst (const vector unsigned int *, int, const int);
12150 void vec_dstst (const vector signed int *, int, const int);
12151 void vec_dstst (const vector bool int *, int, const int);
12152 void vec_dstst (const vector float *, int, const int);
12153 void vec_dstst (const unsigned char *, int, const int);
12154 void vec_dstst (const signed char *, int, const int);
12155 void vec_dstst (const unsigned short *, int, const int);
12156 void vec_dstst (const short *, int, const int);
12157 void vec_dstst (const unsigned int *, int, const int);
12158 void vec_dstst (const int *, int, const int);
12159 void vec_dstst (const unsigned long *, int, const int);
12160 void vec_dstst (const long *, int, const int);
12161 void vec_dstst (const float *, int, const int);
12163 void vec_dststt (const vector unsigned char *, int, const int);
12164 void vec_dststt (const vector signed char *, int, const int);
12165 void vec_dststt (const vector bool char *, int, const int);
12166 void vec_dststt (const vector unsigned short *, int, const int);
12167 void vec_dststt (const vector signed short *, int, const int);
12168 void vec_dststt (const vector bool short *, int, const int);
12169 void vec_dststt (const vector pixel *, int, const int);
12170 void vec_dststt (const vector unsigned int *, int, const int);
12171 void vec_dststt (const vector signed int *, int, const int);
12172 void vec_dststt (const vector bool int *, int, const int);
12173 void vec_dststt (const vector float *, int, const int);
12174 void vec_dststt (const unsigned char *, int, const int);
12175 void vec_dststt (const signed char *, int, const int);
12176 void vec_dststt (const unsigned short *, int, const int);
12177 void vec_dststt (const short *, int, const int);
12178 void vec_dststt (const unsigned int *, int, const int);
12179 void vec_dststt (const int *, int, const int);
12180 void vec_dststt (const unsigned long *, int, const int);
12181 void vec_dststt (const long *, int, const int);
12182 void vec_dststt (const float *, int, const int);
12184 void vec_dstt (const vector unsigned char *, int, const int);
12185 void vec_dstt (const vector signed char *, int, const int);
12186 void vec_dstt (const vector bool char *, int, const int);
12187 void vec_dstt (const vector unsigned short *, int, const int);
12188 void vec_dstt (const vector signed short *, int, const int);
12189 void vec_dstt (const vector bool short *, int, const int);
12190 void vec_dstt (const vector pixel *, int, const int);
12191 void vec_dstt (const vector unsigned int *, int, const int);
12192 void vec_dstt (const vector signed int *, int, const int);
12193 void vec_dstt (const vector bool int *, int, const int);
12194 void vec_dstt (const vector float *, int, const int);
12195 void vec_dstt (const unsigned char *, int, const int);
12196 void vec_dstt (const signed char *, int, const int);
12197 void vec_dstt (const unsigned short *, int, const int);
12198 void vec_dstt (const short *, int, const int);
12199 void vec_dstt (const unsigned int *, int, const int);
12200 void vec_dstt (const int *, int, const int);
12201 void vec_dstt (const unsigned long *, int, const int);
12202 void vec_dstt (const long *, int, const int);
12203 void vec_dstt (const float *, int, const int);
12205 vector float vec_expte (vector float);
12207 vector float vec_floor (vector float);
12209 vector float vec_ld (int, const vector float *);
12210 vector float vec_ld (int, const float *);
12211 vector bool int vec_ld (int, const vector bool int *);
12212 vector signed int vec_ld (int, const vector signed int *);
12213 vector signed int vec_ld (int, const int *);
12214 vector signed int vec_ld (int, const long *);
12215 vector unsigned int vec_ld (int, const vector unsigned int *);
12216 vector unsigned int vec_ld (int, const unsigned int *);
12217 vector unsigned int vec_ld (int, const unsigned long *);
12218 vector bool short vec_ld (int, const vector bool short *);
12219 vector pixel vec_ld (int, const vector pixel *);
12220 vector signed short vec_ld (int, const vector signed short *);
12221 vector signed short vec_ld (int, const short *);
12222 vector unsigned short vec_ld (int, const vector unsigned short *);
12223 vector unsigned short vec_ld (int, const unsigned short *);
12224 vector bool char vec_ld (int, const vector bool char *);
12225 vector signed char vec_ld (int, const vector signed char *);
12226 vector signed char vec_ld (int, const signed char *);
12227 vector unsigned char vec_ld (int, const vector unsigned char *);
12228 vector unsigned char vec_ld (int, const unsigned char *);
12230 vector signed char vec_lde (int, const signed char *);
12231 vector unsigned char vec_lde (int, const unsigned char *);
12232 vector signed short vec_lde (int, const short *);
12233 vector unsigned short vec_lde (int, const unsigned short *);
12234 vector float vec_lde (int, const float *);
12235 vector signed int vec_lde (int, const int *);
12236 vector unsigned int vec_lde (int, const unsigned int *);
12237 vector signed int vec_lde (int, const long *);
12238 vector unsigned int vec_lde (int, const unsigned long *);
12240 vector float vec_lvewx (int, float *);
12241 vector signed int vec_lvewx (int, int *);
12242 vector unsigned int vec_lvewx (int, unsigned int *);
12243 vector signed int vec_lvewx (int, long *);
12244 vector unsigned int vec_lvewx (int, unsigned long *);
12246 vector signed short vec_lvehx (int, short *);
12247 vector unsigned short vec_lvehx (int, unsigned short *);
12249 vector signed char vec_lvebx (int, char *);
12250 vector unsigned char vec_lvebx (int, unsigned char *);
12252 vector float vec_ldl (int, const vector float *);
12253 vector float vec_ldl (int, const float *);
12254 vector bool int vec_ldl (int, const vector bool int *);
12255 vector signed int vec_ldl (int, const vector signed int *);
12256 vector signed int vec_ldl (int, const int *);
12257 vector signed int vec_ldl (int, const long *);
12258 vector unsigned int vec_ldl (int, const vector unsigned int *);
12259 vector unsigned int vec_ldl (int, const unsigned int *);
12260 vector unsigned int vec_ldl (int, const unsigned long *);
12261 vector bool short vec_ldl (int, const vector bool short *);
12262 vector pixel vec_ldl (int, const vector pixel *);
12263 vector signed short vec_ldl (int, const vector signed short *);
12264 vector signed short vec_ldl (int, const short *);
12265 vector unsigned short vec_ldl (int, const vector unsigned short *);
12266 vector unsigned short vec_ldl (int, const unsigned short *);
12267 vector bool char vec_ldl (int, const vector bool char *);
12268 vector signed char vec_ldl (int, const vector signed char *);
12269 vector signed char vec_ldl (int, const signed char *);
12270 vector unsigned char vec_ldl (int, const vector unsigned char *);
12271 vector unsigned char vec_ldl (int, const unsigned char *);
12273 vector float vec_loge (vector float);
12275 vector unsigned char vec_lvsl (int, const volatile unsigned char *);
12276 vector unsigned char vec_lvsl (int, const volatile signed char *);
12277 vector unsigned char vec_lvsl (int, const volatile unsigned short *);
12278 vector unsigned char vec_lvsl (int, const volatile short *);
12279 vector unsigned char vec_lvsl (int, const volatile unsigned int *);
12280 vector unsigned char vec_lvsl (int, const volatile int *);
12281 vector unsigned char vec_lvsl (int, const volatile unsigned long *);
12282 vector unsigned char vec_lvsl (int, const volatile long *);
12283 vector unsigned char vec_lvsl (int, const volatile float *);
12285 vector unsigned char vec_lvsr (int, const volatile unsigned char *);
12286 vector unsigned char vec_lvsr (int, const volatile signed char *);
12287 vector unsigned char vec_lvsr (int, const volatile unsigned short *);
12288 vector unsigned char vec_lvsr (int, const volatile short *);
12289 vector unsigned char vec_lvsr (int, const volatile unsigned int *);
12290 vector unsigned char vec_lvsr (int, const volatile int *);
12291 vector unsigned char vec_lvsr (int, const volatile unsigned long *);
12292 vector unsigned char vec_lvsr (int, const volatile long *);
12293 vector unsigned char vec_lvsr (int, const volatile float *);
12295 vector float vec_madd (vector float, vector float, vector float);
12297 vector signed short vec_madds (vector signed short,
12298                                vector signed short,
12299                                vector signed short);
12301 vector unsigned char vec_max (vector bool char, vector unsigned char);
12302 vector unsigned char vec_max (vector unsigned char, vector bool char);
12303 vector unsigned char vec_max (vector unsigned char,
12304                               vector unsigned char);
12305 vector signed char vec_max (vector bool char, vector signed char);
12306 vector signed char vec_max (vector signed char, vector bool char);
12307 vector signed char vec_max (vector signed char, vector signed char);
12308 vector unsigned short vec_max (vector bool short,
12309                                vector unsigned short);
12310 vector unsigned short vec_max (vector unsigned short,
12311                                vector bool short);
12312 vector unsigned short vec_max (vector unsigned short,
12313                                vector unsigned short);
12314 vector signed short vec_max (vector bool short, vector signed short);
12315 vector signed short vec_max (vector signed short, vector bool short);
12316 vector signed short vec_max (vector signed short, vector signed short);
12317 vector unsigned int vec_max (vector bool int, vector unsigned int);
12318 vector unsigned int vec_max (vector unsigned int, vector bool int);
12319 vector unsigned int vec_max (vector unsigned int, vector unsigned int);
12320 vector signed int vec_max (vector bool int, vector signed int);
12321 vector signed int vec_max (vector signed int, vector bool int);
12322 vector signed int vec_max (vector signed int, vector signed int);
12323 vector float vec_max (vector float, vector float);
12325 vector float vec_vmaxfp (vector float, vector float);
12327 vector signed int vec_vmaxsw (vector bool int, vector signed int);
12328 vector signed int vec_vmaxsw (vector signed int, vector bool int);
12329 vector signed int vec_vmaxsw (vector signed int, vector signed int);
12331 vector unsigned int vec_vmaxuw (vector bool int, vector unsigned int);
12332 vector unsigned int vec_vmaxuw (vector unsigned int, vector bool int);
12333 vector unsigned int vec_vmaxuw (vector unsigned int,
12334                                 vector unsigned int);
12336 vector signed short vec_vmaxsh (vector bool short, vector signed short);
12337 vector signed short vec_vmaxsh (vector signed short, vector bool short);
12338 vector signed short vec_vmaxsh (vector signed short,
12339                                 vector signed short);
12341 vector unsigned short vec_vmaxuh (vector bool short,
12342                                   vector unsigned short);
12343 vector unsigned short vec_vmaxuh (vector unsigned short,
12344                                   vector bool short);
12345 vector unsigned short vec_vmaxuh (vector unsigned short,
12346                                   vector unsigned short);
12348 vector signed char vec_vmaxsb (vector bool char, vector signed char);
12349 vector signed char vec_vmaxsb (vector signed char, vector bool char);
12350 vector signed char vec_vmaxsb (vector signed char, vector signed char);
12352 vector unsigned char vec_vmaxub (vector bool char,
12353                                  vector unsigned char);
12354 vector unsigned char vec_vmaxub (vector unsigned char,
12355                                  vector bool char);
12356 vector unsigned char vec_vmaxub (vector unsigned char,
12357                                  vector unsigned char);
12359 vector bool char vec_mergeh (vector bool char, vector bool char);
12360 vector signed char vec_mergeh (vector signed char, vector signed char);
12361 vector unsigned char vec_mergeh (vector unsigned char,
12362                                  vector unsigned char);
12363 vector bool short vec_mergeh (vector bool short, vector bool short);
12364 vector pixel vec_mergeh (vector pixel, vector pixel);
12365 vector signed short vec_mergeh (vector signed short,
12366                                 vector signed short);
12367 vector unsigned short vec_mergeh (vector unsigned short,
12368                                   vector unsigned short);
12369 vector float vec_mergeh (vector float, vector float);
12370 vector bool int vec_mergeh (vector bool int, vector bool int);
12371 vector signed int vec_mergeh (vector signed int, vector signed int);
12372 vector unsigned int vec_mergeh (vector unsigned int,
12373                                 vector unsigned int);
12375 vector float vec_vmrghw (vector float, vector float);
12376 vector bool int vec_vmrghw (vector bool int, vector bool int);
12377 vector signed int vec_vmrghw (vector signed int, vector signed int);
12378 vector unsigned int vec_vmrghw (vector unsigned int,
12379                                 vector unsigned int);
12381 vector bool short vec_vmrghh (vector bool short, vector bool short);
12382 vector signed short vec_vmrghh (vector signed short,
12383                                 vector signed short);
12384 vector unsigned short vec_vmrghh (vector unsigned short,
12385                                   vector unsigned short);
12386 vector pixel vec_vmrghh (vector pixel, vector pixel);
12388 vector bool char vec_vmrghb (vector bool char, vector bool char);
12389 vector signed char vec_vmrghb (vector signed char, vector signed char);
12390 vector unsigned char vec_vmrghb (vector unsigned char,
12391                                  vector unsigned char);
12393 vector bool char vec_mergel (vector bool char, vector bool char);
12394 vector signed char vec_mergel (vector signed char, vector signed char);
12395 vector unsigned char vec_mergel (vector unsigned char,
12396                                  vector unsigned char);
12397 vector bool short vec_mergel (vector bool short, vector bool short);
12398 vector pixel vec_mergel (vector pixel, vector pixel);
12399 vector signed short vec_mergel (vector signed short,
12400                                 vector signed short);
12401 vector unsigned short vec_mergel (vector unsigned short,
12402                                   vector unsigned short);
12403 vector float vec_mergel (vector float, vector float);
12404 vector bool int vec_mergel (vector bool int, vector bool int);
12405 vector signed int vec_mergel (vector signed int, vector signed int);
12406 vector unsigned int vec_mergel (vector unsigned int,
12407                                 vector unsigned int);
12409 vector float vec_vmrglw (vector float, vector float);
12410 vector signed int vec_vmrglw (vector signed int, vector signed int);
12411 vector unsigned int vec_vmrglw (vector unsigned int,
12412                                 vector unsigned int);
12413 vector bool int vec_vmrglw (vector bool int, vector bool int);
12415 vector bool short vec_vmrglh (vector bool short, vector bool short);
12416 vector signed short vec_vmrglh (vector signed short,
12417                                 vector signed short);
12418 vector unsigned short vec_vmrglh (vector unsigned short,
12419                                   vector unsigned short);
12420 vector pixel vec_vmrglh (vector pixel, vector pixel);
12422 vector bool char vec_vmrglb (vector bool char, vector bool char);
12423 vector signed char vec_vmrglb (vector signed char, vector signed char);
12424 vector unsigned char vec_vmrglb (vector unsigned char,
12425                                  vector unsigned char);
12427 vector unsigned short vec_mfvscr (void);
12429 vector unsigned char vec_min (vector bool char, vector unsigned char);
12430 vector unsigned char vec_min (vector unsigned char, vector bool char);
12431 vector unsigned char vec_min (vector unsigned char,
12432                               vector unsigned char);
12433 vector signed char vec_min (vector bool char, vector signed char);
12434 vector signed char vec_min (vector signed char, vector bool char);
12435 vector signed char vec_min (vector signed char, vector signed char);
12436 vector unsigned short vec_min (vector bool short,
12437                                vector unsigned short);
12438 vector unsigned short vec_min (vector unsigned short,
12439                                vector bool short);
12440 vector unsigned short vec_min (vector unsigned short,
12441                                vector unsigned short);
12442 vector signed short vec_min (vector bool short, vector signed short);
12443 vector signed short vec_min (vector signed short, vector bool short);
12444 vector signed short vec_min (vector signed short, vector signed short);
12445 vector unsigned int vec_min (vector bool int, vector unsigned int);
12446 vector unsigned int vec_min (vector unsigned int, vector bool int);
12447 vector unsigned int vec_min (vector unsigned int, vector unsigned int);
12448 vector signed int vec_min (vector bool int, vector signed int);
12449 vector signed int vec_min (vector signed int, vector bool int);
12450 vector signed int vec_min (vector signed int, vector signed int);
12451 vector float vec_min (vector float, vector float);
12453 vector float vec_vminfp (vector float, vector float);
12455 vector signed int vec_vminsw (vector bool int, vector signed int);
12456 vector signed int vec_vminsw (vector signed int, vector bool int);
12457 vector signed int vec_vminsw (vector signed int, vector signed int);
12459 vector unsigned int vec_vminuw (vector bool int, vector unsigned int);
12460 vector unsigned int vec_vminuw (vector unsigned int, vector bool int);
12461 vector unsigned int vec_vminuw (vector unsigned int,
12462                                 vector unsigned int);
12464 vector signed short vec_vminsh (vector bool short, vector signed short);
12465 vector signed short vec_vminsh (vector signed short, vector bool short);
12466 vector signed short vec_vminsh (vector signed short,
12467                                 vector signed short);
12469 vector unsigned short vec_vminuh (vector bool short,
12470                                   vector unsigned short);
12471 vector unsigned short vec_vminuh (vector unsigned short,
12472                                   vector bool short);
12473 vector unsigned short vec_vminuh (vector unsigned short,
12474                                   vector unsigned short);
12476 vector signed char vec_vminsb (vector bool char, vector signed char);
12477 vector signed char vec_vminsb (vector signed char, vector bool char);
12478 vector signed char vec_vminsb (vector signed char, vector signed char);
12480 vector unsigned char vec_vminub (vector bool char,
12481                                  vector unsigned char);
12482 vector unsigned char vec_vminub (vector unsigned char,
12483                                  vector bool char);
12484 vector unsigned char vec_vminub (vector unsigned char,
12485                                  vector unsigned char);
12487 vector signed short vec_mladd (vector signed short,
12488                                vector signed short,
12489                                vector signed short);
12490 vector signed short vec_mladd (vector signed short,
12491                                vector unsigned short,
12492                                vector unsigned short);
12493 vector signed short vec_mladd (vector unsigned short,
12494                                vector signed short,
12495                                vector signed short);
12496 vector unsigned short vec_mladd (vector unsigned short,
12497                                  vector unsigned short,
12498                                  vector unsigned short);
12500 vector signed short vec_mradds (vector signed short,
12501                                 vector signed short,
12502                                 vector signed short);
12504 vector unsigned int vec_msum (vector unsigned char,
12505                               vector unsigned char,
12506                               vector unsigned int);
12507 vector signed int vec_msum (vector signed char,
12508                             vector unsigned char,
12509                             vector signed int);
12510 vector unsigned int vec_msum (vector unsigned short,
12511                               vector unsigned short,
12512                               vector unsigned int);
12513 vector signed int vec_msum (vector signed short,
12514                             vector signed short,
12515                             vector signed int);
12517 vector signed int vec_vmsumshm (vector signed short,
12518                                 vector signed short,
12519                                 vector signed int);
12521 vector unsigned int vec_vmsumuhm (vector unsigned short,
12522                                   vector unsigned short,
12523                                   vector unsigned int);
12525 vector signed int vec_vmsummbm (vector signed char,
12526                                 vector unsigned char,
12527                                 vector signed int);
12529 vector unsigned int vec_vmsumubm (vector unsigned char,
12530                                   vector unsigned char,
12531                                   vector unsigned int);
12533 vector unsigned int vec_msums (vector unsigned short,
12534                                vector unsigned short,
12535                                vector unsigned int);
12536 vector signed int vec_msums (vector signed short,
12537                              vector signed short,
12538                              vector signed int);
12540 vector signed int vec_vmsumshs (vector signed short,
12541                                 vector signed short,
12542                                 vector signed int);
12544 vector unsigned int vec_vmsumuhs (vector unsigned short,
12545                                   vector unsigned short,
12546                                   vector unsigned int);
12548 void vec_mtvscr (vector signed int);
12549 void vec_mtvscr (vector unsigned int);
12550 void vec_mtvscr (vector bool int);
12551 void vec_mtvscr (vector signed short);
12552 void vec_mtvscr (vector unsigned short);
12553 void vec_mtvscr (vector bool short);
12554 void vec_mtvscr (vector pixel);
12555 void vec_mtvscr (vector signed char);
12556 void vec_mtvscr (vector unsigned char);
12557 void vec_mtvscr (vector bool char);
12559 vector unsigned short vec_mule (vector unsigned char,
12560                                 vector unsigned char);
12561 vector signed short vec_mule (vector signed char,
12562                               vector signed char);
12563 vector unsigned int vec_mule (vector unsigned short,
12564                               vector unsigned short);
12565 vector signed int vec_mule (vector signed short, vector signed short);
12567 vector signed int vec_vmulesh (vector signed short,
12568                                vector signed short);
12570 vector unsigned int vec_vmuleuh (vector unsigned short,
12571                                  vector unsigned short);
12573 vector signed short vec_vmulesb (vector signed char,
12574                                  vector signed char);
12576 vector unsigned short vec_vmuleub (vector unsigned char,
12577                                   vector unsigned char);
12579 vector unsigned short vec_mulo (vector unsigned char,
12580                                 vector unsigned char);
12581 vector signed short vec_mulo (vector signed char, vector signed char);
12582 vector unsigned int vec_mulo (vector unsigned short,
12583                               vector unsigned short);
12584 vector signed int vec_mulo (vector signed short, vector signed short);
12586 vector signed int vec_vmulosh (vector signed short,
12587                                vector signed short);
12589 vector unsigned int vec_vmulouh (vector unsigned short,
12590                                  vector unsigned short);
12592 vector signed short vec_vmulosb (vector signed char,
12593                                  vector signed char);
12595 vector unsigned short vec_vmuloub (vector unsigned char,
12596                                    vector unsigned char);
12598 vector float vec_nmsub (vector float, vector float, vector float);
12600 vector float vec_nor (vector float, vector float);
12601 vector signed int vec_nor (vector signed int, vector signed int);
12602 vector unsigned int vec_nor (vector unsigned int, vector unsigned int);
12603 vector bool int vec_nor (vector bool int, vector bool int);
12604 vector signed short vec_nor (vector signed short, vector signed short);
12605 vector unsigned short vec_nor (vector unsigned short,
12606                                vector unsigned short);
12607 vector bool short vec_nor (vector bool short, vector bool short);
12608 vector signed char vec_nor (vector signed char, vector signed char);
12609 vector unsigned char vec_nor (vector unsigned char,
12610                               vector unsigned char);
12611 vector bool char vec_nor (vector bool char, vector bool char);
12613 vector float vec_or (vector float, vector float);
12614 vector float vec_or (vector float, vector bool int);
12615 vector float vec_or (vector bool int, vector float);
12616 vector bool int vec_or (vector bool int, vector bool int);
12617 vector signed int vec_or (vector bool int, vector signed int);
12618 vector signed int vec_or (vector signed int, vector bool int);
12619 vector signed int vec_or (vector signed int, vector signed int);
12620 vector unsigned int vec_or (vector bool int, vector unsigned int);
12621 vector unsigned int vec_or (vector unsigned int, vector bool int);
12622 vector unsigned int vec_or (vector unsigned int, vector unsigned int);
12623 vector bool short vec_or (vector bool short, vector bool short);
12624 vector signed short vec_or (vector bool short, vector signed short);
12625 vector signed short vec_or (vector signed short, vector bool short);
12626 vector signed short vec_or (vector signed short, vector signed short);
12627 vector unsigned short vec_or (vector bool short, vector unsigned short);
12628 vector unsigned short vec_or (vector unsigned short, vector bool short);
12629 vector unsigned short vec_or (vector unsigned short,
12630                               vector unsigned short);
12631 vector signed char vec_or (vector bool char, vector signed char);
12632 vector bool char vec_or (vector bool char, vector bool char);
12633 vector signed char vec_or (vector signed char, vector bool char);
12634 vector signed char vec_or (vector signed char, vector signed char);
12635 vector unsigned char vec_or (vector bool char, vector unsigned char);
12636 vector unsigned char vec_or (vector unsigned char, vector bool char);
12637 vector unsigned char vec_or (vector unsigned char,
12638                              vector unsigned char);
12640 vector signed char vec_pack (vector signed short, vector signed short);
12641 vector unsigned char vec_pack (vector unsigned short,
12642                                vector unsigned short);
12643 vector bool char vec_pack (vector bool short, vector bool short);
12644 vector signed short vec_pack (vector signed int, vector signed int);
12645 vector unsigned short vec_pack (vector unsigned int,
12646                                 vector unsigned int);
12647 vector bool short vec_pack (vector bool int, vector bool int);
12649 vector bool short vec_vpkuwum (vector bool int, vector bool int);
12650 vector signed short vec_vpkuwum (vector signed int, vector signed int);
12651 vector unsigned short vec_vpkuwum (vector unsigned int,
12652                                    vector unsigned int);
12654 vector bool char vec_vpkuhum (vector bool short, vector bool short);
12655 vector signed char vec_vpkuhum (vector signed short,
12656                                 vector signed short);
12657 vector unsigned char vec_vpkuhum (vector unsigned short,
12658                                   vector unsigned short);
12660 vector pixel vec_packpx (vector unsigned int, vector unsigned int);
12662 vector unsigned char vec_packs (vector unsigned short,
12663                                 vector unsigned short);
12664 vector signed char vec_packs (vector signed short, vector signed short);
12665 vector unsigned short vec_packs (vector unsigned int,
12666                                  vector unsigned int);
12667 vector signed short vec_packs (vector signed int, vector signed int);
12669 vector signed short vec_vpkswss (vector signed int, vector signed int);
12671 vector unsigned short vec_vpkuwus (vector unsigned int,
12672                                    vector unsigned int);
12674 vector signed char vec_vpkshss (vector signed short,
12675                                 vector signed short);
12677 vector unsigned char vec_vpkuhus (vector unsigned short,
12678                                   vector unsigned short);
12680 vector unsigned char vec_packsu (vector unsigned short,
12681                                  vector unsigned short);
12682 vector unsigned char vec_packsu (vector signed short,
12683                                  vector signed short);
12684 vector unsigned short vec_packsu (vector unsigned int,
12685                                   vector unsigned int);
12686 vector unsigned short vec_packsu (vector signed int, vector signed int);
12688 vector unsigned short vec_vpkswus (vector signed int,
12689                                    vector signed int);
12691 vector unsigned char vec_vpkshus (vector signed short,
12692                                   vector signed short);
12694 vector float vec_perm (vector float,
12695                        vector float,
12696                        vector unsigned char);
12697 vector signed int vec_perm (vector signed int,
12698                             vector signed int,
12699                             vector unsigned char);
12700 vector unsigned int vec_perm (vector unsigned int,
12701                               vector unsigned int,
12702                               vector unsigned char);
12703 vector bool int vec_perm (vector bool int,
12704                           vector bool int,
12705                           vector unsigned char);
12706 vector signed short vec_perm (vector signed short,
12707                               vector signed short,
12708                               vector unsigned char);
12709 vector unsigned short vec_perm (vector unsigned short,
12710                                 vector unsigned short,
12711                                 vector unsigned char);
12712 vector bool short vec_perm (vector bool short,
12713                             vector bool short,
12714                             vector unsigned char);
12715 vector pixel vec_perm (vector pixel,
12716                        vector pixel,
12717                        vector unsigned char);
12718 vector signed char vec_perm (vector signed char,
12719                              vector signed char,
12720                              vector unsigned char);
12721 vector unsigned char vec_perm (vector unsigned char,
12722                                vector unsigned char,
12723                                vector unsigned char);
12724 vector bool char vec_perm (vector bool char,
12725                            vector bool char,
12726                            vector unsigned char);
12728 vector float vec_re (vector float);
12730 vector signed char vec_rl (vector signed char,
12731                            vector unsigned char);
12732 vector unsigned char vec_rl (vector unsigned char,
12733                              vector unsigned char);
12734 vector signed short vec_rl (vector signed short, vector unsigned short);
12735 vector unsigned short vec_rl (vector unsigned short,
12736                               vector unsigned short);
12737 vector signed int vec_rl (vector signed int, vector unsigned int);
12738 vector unsigned int vec_rl (vector unsigned int, vector unsigned int);
12740 vector signed int vec_vrlw (vector signed int, vector unsigned int);
12741 vector unsigned int vec_vrlw (vector unsigned int, vector unsigned int);
12743 vector signed short vec_vrlh (vector signed short,
12744                               vector unsigned short);
12745 vector unsigned short vec_vrlh (vector unsigned short,
12746                                 vector unsigned short);
12748 vector signed char vec_vrlb (vector signed char, vector unsigned char);
12749 vector unsigned char vec_vrlb (vector unsigned char,
12750                                vector unsigned char);
12752 vector float vec_round (vector float);
12754 vector float vec_recip (vector float, vector float);
12756 vector float vec_rsqrt (vector float);
12758 vector float vec_rsqrte (vector float);
12760 vector float vec_sel (vector float, vector float, vector bool int);
12761 vector float vec_sel (vector float, vector float, vector unsigned int);
12762 vector signed int vec_sel (vector signed int,
12763                            vector signed int,
12764                            vector bool int);
12765 vector signed int vec_sel (vector signed int,
12766                            vector signed int,
12767                            vector unsigned int);
12768 vector unsigned int vec_sel (vector unsigned int,
12769                              vector unsigned int,
12770                              vector bool int);
12771 vector unsigned int vec_sel (vector unsigned int,
12772                              vector unsigned int,
12773                              vector unsigned int);
12774 vector bool int vec_sel (vector bool int,
12775                          vector bool int,
12776                          vector bool int);
12777 vector bool int vec_sel (vector bool int,
12778                          vector bool int,
12779                          vector unsigned int);
12780 vector signed short vec_sel (vector signed short,
12781                              vector signed short,
12782                              vector bool short);
12783 vector signed short vec_sel (vector signed short,
12784                              vector signed short,
12785                              vector unsigned short);
12786 vector unsigned short vec_sel (vector unsigned short,
12787                                vector unsigned short,
12788                                vector bool short);
12789 vector unsigned short vec_sel (vector unsigned short,
12790                                vector unsigned short,
12791                                vector unsigned short);
12792 vector bool short vec_sel (vector bool short,
12793                            vector bool short,
12794                            vector bool short);
12795 vector bool short vec_sel (vector bool short,
12796                            vector bool short,
12797                            vector unsigned short);
12798 vector signed char vec_sel (vector signed char,
12799                             vector signed char,
12800                             vector bool char);
12801 vector signed char vec_sel (vector signed char,
12802                             vector signed char,
12803                             vector unsigned char);
12804 vector unsigned char vec_sel (vector unsigned char,
12805                               vector unsigned char,
12806                               vector bool char);
12807 vector unsigned char vec_sel (vector unsigned char,
12808                               vector unsigned char,
12809                               vector unsigned char);
12810 vector bool char vec_sel (vector bool char,
12811                           vector bool char,
12812                           vector bool char);
12813 vector bool char vec_sel (vector bool char,
12814                           vector bool char,
12815                           vector unsigned char);
12817 vector signed char vec_sl (vector signed char,
12818                            vector unsigned char);
12819 vector unsigned char vec_sl (vector unsigned char,
12820                              vector unsigned char);
12821 vector signed short vec_sl (vector signed short, vector unsigned short);
12822 vector unsigned short vec_sl (vector unsigned short,
12823                               vector unsigned short);
12824 vector signed int vec_sl (vector signed int, vector unsigned int);
12825 vector unsigned int vec_sl (vector unsigned int, vector unsigned int);
12827 vector signed int vec_vslw (vector signed int, vector unsigned int);
12828 vector unsigned int vec_vslw (vector unsigned int, vector unsigned int);
12830 vector signed short vec_vslh (vector signed short,
12831                               vector unsigned short);
12832 vector unsigned short vec_vslh (vector unsigned short,
12833                                 vector unsigned short);
12835 vector signed char vec_vslb (vector signed char, vector unsigned char);
12836 vector unsigned char vec_vslb (vector unsigned char,
12837                                vector unsigned char);
12839 vector float vec_sld (vector float, vector float, const int);
12840 vector signed int vec_sld (vector signed int,
12841                            vector signed int,
12842                            const int);
12843 vector unsigned int vec_sld (vector unsigned int,
12844                              vector unsigned int,
12845                              const int);
12846 vector bool int vec_sld (vector bool int,
12847                          vector bool int,
12848                          const int);
12849 vector signed short vec_sld (vector signed short,
12850                              vector signed short,
12851                              const int);
12852 vector unsigned short vec_sld (vector unsigned short,
12853                                vector unsigned short,
12854                                const int);
12855 vector bool short vec_sld (vector bool short,
12856                            vector bool short,
12857                            const int);
12858 vector pixel vec_sld (vector pixel,
12859                       vector pixel,
12860                       const int);
12861 vector signed char vec_sld (vector signed char,
12862                             vector signed char,
12863                             const int);
12864 vector unsigned char vec_sld (vector unsigned char,
12865                               vector unsigned char,
12866                               const int);
12867 vector bool char vec_sld (vector bool char,
12868                           vector bool char,
12869                           const int);
12871 vector signed int vec_sll (vector signed int,
12872                            vector unsigned int);
12873 vector signed int vec_sll (vector signed int,
12874                            vector unsigned short);
12875 vector signed int vec_sll (vector signed int,
12876                            vector unsigned char);
12877 vector unsigned int vec_sll (vector unsigned int,
12878                              vector unsigned int);
12879 vector unsigned int vec_sll (vector unsigned int,
12880                              vector unsigned short);
12881 vector unsigned int vec_sll (vector unsigned int,
12882                              vector unsigned char);
12883 vector bool int vec_sll (vector bool int,
12884                          vector unsigned int);
12885 vector bool int vec_sll (vector bool int,
12886                          vector unsigned short);
12887 vector bool int vec_sll (vector bool int,
12888                          vector unsigned char);
12889 vector signed short vec_sll (vector signed short,
12890                              vector unsigned int);
12891 vector signed short vec_sll (vector signed short,
12892                              vector unsigned short);
12893 vector signed short vec_sll (vector signed short,
12894                              vector unsigned char);
12895 vector unsigned short vec_sll (vector unsigned short,
12896                                vector unsigned int);
12897 vector unsigned short vec_sll (vector unsigned short,
12898                                vector unsigned short);
12899 vector unsigned short vec_sll (vector unsigned short,
12900                                vector unsigned char);
12901 vector bool short vec_sll (vector bool short, vector unsigned int);
12902 vector bool short vec_sll (vector bool short, vector unsigned short);
12903 vector bool short vec_sll (vector bool short, vector unsigned char);
12904 vector pixel vec_sll (vector pixel, vector unsigned int);
12905 vector pixel vec_sll (vector pixel, vector unsigned short);
12906 vector pixel vec_sll (vector pixel, vector unsigned char);
12907 vector signed char vec_sll (vector signed char, vector unsigned int);
12908 vector signed char vec_sll (vector signed char, vector unsigned short);
12909 vector signed char vec_sll (vector signed char, vector unsigned char);
12910 vector unsigned char vec_sll (vector unsigned char,
12911                               vector unsigned int);
12912 vector unsigned char vec_sll (vector unsigned char,
12913                               vector unsigned short);
12914 vector unsigned char vec_sll (vector unsigned char,
12915                               vector unsigned char);
12916 vector bool char vec_sll (vector bool char, vector unsigned int);
12917 vector bool char vec_sll (vector bool char, vector unsigned short);
12918 vector bool char vec_sll (vector bool char, vector unsigned char);
12920 vector float vec_slo (vector float, vector signed char);
12921 vector float vec_slo (vector float, vector unsigned char);
12922 vector signed int vec_slo (vector signed int, vector signed char);
12923 vector signed int vec_slo (vector signed int, vector unsigned char);
12924 vector unsigned int vec_slo (vector unsigned int, vector signed char);
12925 vector unsigned int vec_slo (vector unsigned int, vector unsigned char);
12926 vector signed short vec_slo (vector signed short, vector signed char);
12927 vector signed short vec_slo (vector signed short, vector unsigned char);
12928 vector unsigned short vec_slo (vector unsigned short,
12929                                vector signed char);
12930 vector unsigned short vec_slo (vector unsigned short,
12931                                vector unsigned char);
12932 vector pixel vec_slo (vector pixel, vector signed char);
12933 vector pixel vec_slo (vector pixel, vector unsigned char);
12934 vector signed char vec_slo (vector signed char, vector signed char);
12935 vector signed char vec_slo (vector signed char, vector unsigned char);
12936 vector unsigned char vec_slo (vector unsigned char, vector signed char);
12937 vector unsigned char vec_slo (vector unsigned char,
12938                               vector unsigned char);
12940 vector signed char vec_splat (vector signed char, const int);
12941 vector unsigned char vec_splat (vector unsigned char, const int);
12942 vector bool char vec_splat (vector bool char, const int);
12943 vector signed short vec_splat (vector signed short, const int);
12944 vector unsigned short vec_splat (vector unsigned short, const int);
12945 vector bool short vec_splat (vector bool short, const int);
12946 vector pixel vec_splat (vector pixel, const int);
12947 vector float vec_splat (vector float, const int);
12948 vector signed int vec_splat (vector signed int, const int);
12949 vector unsigned int vec_splat (vector unsigned int, const int);
12950 vector bool int vec_splat (vector bool int, const int);
12952 vector float vec_vspltw (vector float, const int);
12953 vector signed int vec_vspltw (vector signed int, const int);
12954 vector unsigned int vec_vspltw (vector unsigned int, const int);
12955 vector bool int vec_vspltw (vector bool int, const int);
12957 vector bool short vec_vsplth (vector bool short, const int);
12958 vector signed short vec_vsplth (vector signed short, const int);
12959 vector unsigned short vec_vsplth (vector unsigned short, const int);
12960 vector pixel vec_vsplth (vector pixel, const int);
12962 vector signed char vec_vspltb (vector signed char, const int);
12963 vector unsigned char vec_vspltb (vector unsigned char, const int);
12964 vector bool char vec_vspltb (vector bool char, const int);
12966 vector signed char vec_splat_s8 (const int);
12968 vector signed short vec_splat_s16 (const int);
12970 vector signed int vec_splat_s32 (const int);
12972 vector unsigned char vec_splat_u8 (const int);
12974 vector unsigned short vec_splat_u16 (const int);
12976 vector unsigned int vec_splat_u32 (const int);
12978 vector signed char vec_sr (vector signed char, vector unsigned char);
12979 vector unsigned char vec_sr (vector unsigned char,
12980                              vector unsigned char);
12981 vector signed short vec_sr (vector signed short,
12982                             vector unsigned short);
12983 vector unsigned short vec_sr (vector unsigned short,
12984                               vector unsigned short);
12985 vector signed int vec_sr (vector signed int, vector unsigned int);
12986 vector unsigned int vec_sr (vector unsigned int, vector unsigned int);
12988 vector signed int vec_vsrw (vector signed int, vector unsigned int);
12989 vector unsigned int vec_vsrw (vector unsigned int, vector unsigned int);
12991 vector signed short vec_vsrh (vector signed short,
12992                               vector unsigned short);
12993 vector unsigned short vec_vsrh (vector unsigned short,
12994                                 vector unsigned short);
12996 vector signed char vec_vsrb (vector signed char, vector unsigned char);
12997 vector unsigned char vec_vsrb (vector unsigned char,
12998                                vector unsigned char);
13000 vector signed char vec_sra (vector signed char, vector unsigned char);
13001 vector unsigned char vec_sra (vector unsigned char,
13002                               vector unsigned char);
13003 vector signed short vec_sra (vector signed short,
13004                              vector unsigned short);
13005 vector unsigned short vec_sra (vector unsigned short,
13006                                vector unsigned short);
13007 vector signed int vec_sra (vector signed int, vector unsigned int);
13008 vector unsigned int vec_sra (vector unsigned int, vector unsigned int);
13010 vector signed int vec_vsraw (vector signed int, vector unsigned int);
13011 vector unsigned int vec_vsraw (vector unsigned int,
13012                                vector unsigned int);
13014 vector signed short vec_vsrah (vector signed short,
13015                                vector unsigned short);
13016 vector unsigned short vec_vsrah (vector unsigned short,
13017                                  vector unsigned short);
13019 vector signed char vec_vsrab (vector signed char, vector unsigned char);
13020 vector unsigned char vec_vsrab (vector unsigned char,
13021                                 vector unsigned char);
13023 vector signed int vec_srl (vector signed int, vector unsigned int);
13024 vector signed int vec_srl (vector signed int, vector unsigned short);
13025 vector signed int vec_srl (vector signed int, vector unsigned char);
13026 vector unsigned int vec_srl (vector unsigned int, vector unsigned int);
13027 vector unsigned int vec_srl (vector unsigned int,
13028                              vector unsigned short);
13029 vector unsigned int vec_srl (vector unsigned int, vector unsigned char);
13030 vector bool int vec_srl (vector bool int, vector unsigned int);
13031 vector bool int vec_srl (vector bool int, vector unsigned short);
13032 vector bool int vec_srl (vector bool int, vector unsigned char);
13033 vector signed short vec_srl (vector signed short, vector unsigned int);
13034 vector signed short vec_srl (vector signed short,
13035                              vector unsigned short);
13036 vector signed short vec_srl (vector signed short, vector unsigned char);
13037 vector unsigned short vec_srl (vector unsigned short,
13038                                vector unsigned int);
13039 vector unsigned short vec_srl (vector unsigned short,
13040                                vector unsigned short);
13041 vector unsigned short vec_srl (vector unsigned short,
13042                                vector unsigned char);
13043 vector bool short vec_srl (vector bool short, vector unsigned int);
13044 vector bool short vec_srl (vector bool short, vector unsigned short);
13045 vector bool short vec_srl (vector bool short, vector unsigned char);
13046 vector pixel vec_srl (vector pixel, vector unsigned int);
13047 vector pixel vec_srl (vector pixel, vector unsigned short);
13048 vector pixel vec_srl (vector pixel, vector unsigned char);
13049 vector signed char vec_srl (vector signed char, vector unsigned int);
13050 vector signed char vec_srl (vector signed char, vector unsigned short);
13051 vector signed char vec_srl (vector signed char, vector unsigned char);
13052 vector unsigned char vec_srl (vector unsigned char,
13053                               vector unsigned int);
13054 vector unsigned char vec_srl (vector unsigned char,
13055                               vector unsigned short);
13056 vector unsigned char vec_srl (vector unsigned char,
13057                               vector unsigned char);
13058 vector bool char vec_srl (vector bool char, vector unsigned int);
13059 vector bool char vec_srl (vector bool char, vector unsigned short);
13060 vector bool char vec_srl (vector bool char, vector unsigned char);
13062 vector float vec_sro (vector float, vector signed char);
13063 vector float vec_sro (vector float, vector unsigned char);
13064 vector signed int vec_sro (vector signed int, vector signed char);
13065 vector signed int vec_sro (vector signed int, vector unsigned char);
13066 vector unsigned int vec_sro (vector unsigned int, vector signed char);
13067 vector unsigned int vec_sro (vector unsigned int, vector unsigned char);
13068 vector signed short vec_sro (vector signed short, vector signed char);
13069 vector signed short vec_sro (vector signed short, vector unsigned char);
13070 vector unsigned short vec_sro (vector unsigned short,
13071                                vector signed char);
13072 vector unsigned short vec_sro (vector unsigned short,
13073                                vector unsigned char);
13074 vector pixel vec_sro (vector pixel, vector signed char);
13075 vector pixel vec_sro (vector pixel, vector unsigned char);
13076 vector signed char vec_sro (vector signed char, vector signed char);
13077 vector signed char vec_sro (vector signed char, vector unsigned char);
13078 vector unsigned char vec_sro (vector unsigned char, vector signed char);
13079 vector unsigned char vec_sro (vector unsigned char,
13080                               vector unsigned char);
13082 void vec_st (vector float, int, vector float *);
13083 void vec_st (vector float, int, float *);
13084 void vec_st (vector signed int, int, vector signed int *);
13085 void vec_st (vector signed int, int, int *);
13086 void vec_st (vector unsigned int, int, vector unsigned int *);
13087 void vec_st (vector unsigned int, int, unsigned int *);
13088 void vec_st (vector bool int, int, vector bool int *);
13089 void vec_st (vector bool int, int, unsigned int *);
13090 void vec_st (vector bool int, int, int *);
13091 void vec_st (vector signed short, int, vector signed short *);
13092 void vec_st (vector signed short, int, short *);
13093 void vec_st (vector unsigned short, int, vector unsigned short *);
13094 void vec_st (vector unsigned short, int, unsigned short *);
13095 void vec_st (vector bool short, int, vector bool short *);
13096 void vec_st (vector bool short, int, unsigned short *);
13097 void vec_st (vector pixel, int, vector pixel *);
13098 void vec_st (vector pixel, int, unsigned short *);
13099 void vec_st (vector pixel, int, short *);
13100 void vec_st (vector bool short, int, short *);
13101 void vec_st (vector signed char, int, vector signed char *);
13102 void vec_st (vector signed char, int, signed char *);
13103 void vec_st (vector unsigned char, int, vector unsigned char *);
13104 void vec_st (vector unsigned char, int, unsigned char *);
13105 void vec_st (vector bool char, int, vector bool char *);
13106 void vec_st (vector bool char, int, unsigned char *);
13107 void vec_st (vector bool char, int, signed char *);
13109 void vec_ste (vector signed char, int, signed char *);
13110 void vec_ste (vector unsigned char, int, unsigned char *);
13111 void vec_ste (vector bool char, int, signed char *);
13112 void vec_ste (vector bool char, int, unsigned char *);
13113 void vec_ste (vector signed short, int, short *);
13114 void vec_ste (vector unsigned short, int, unsigned short *);
13115 void vec_ste (vector bool short, int, short *);
13116 void vec_ste (vector bool short, int, unsigned short *);
13117 void vec_ste (vector pixel, int, short *);
13118 void vec_ste (vector pixel, int, unsigned short *);
13119 void vec_ste (vector float, int, float *);
13120 void vec_ste (vector signed int, int, int *);
13121 void vec_ste (vector unsigned int, int, unsigned int *);
13122 void vec_ste (vector bool int, int, int *);
13123 void vec_ste (vector bool int, int, unsigned int *);
13125 void vec_stvewx (vector float, int, float *);
13126 void vec_stvewx (vector signed int, int, int *);
13127 void vec_stvewx (vector unsigned int, int, unsigned int *);
13128 void vec_stvewx (vector bool int, int, int *);
13129 void vec_stvewx (vector bool int, int, unsigned int *);
13131 void vec_stvehx (vector signed short, int, short *);
13132 void vec_stvehx (vector unsigned short, int, unsigned short *);
13133 void vec_stvehx (vector bool short, int, short *);
13134 void vec_stvehx (vector bool short, int, unsigned short *);
13135 void vec_stvehx (vector pixel, int, short *);
13136 void vec_stvehx (vector pixel, int, unsigned short *);
13138 void vec_stvebx (vector signed char, int, signed char *);
13139 void vec_stvebx (vector unsigned char, int, unsigned char *);
13140 void vec_stvebx (vector bool char, int, signed char *);
13141 void vec_stvebx (vector bool char, int, unsigned char *);
13143 void vec_stl (vector float, int, vector float *);
13144 void vec_stl (vector float, int, float *);
13145 void vec_stl (vector signed int, int, vector signed int *);
13146 void vec_stl (vector signed int, int, int *);
13147 void vec_stl (vector unsigned int, int, vector unsigned int *);
13148 void vec_stl (vector unsigned int, int, unsigned int *);
13149 void vec_stl (vector bool int, int, vector bool int *);
13150 void vec_stl (vector bool int, int, unsigned int *);
13151 void vec_stl (vector bool int, int, int *);
13152 void vec_stl (vector signed short, int, vector signed short *);
13153 void vec_stl (vector signed short, int, short *);
13154 void vec_stl (vector unsigned short, int, vector unsigned short *);
13155 void vec_stl (vector unsigned short, int, unsigned short *);
13156 void vec_stl (vector bool short, int, vector bool short *);
13157 void vec_stl (vector bool short, int, unsigned short *);
13158 void vec_stl (vector bool short, int, short *);
13159 void vec_stl (vector pixel, int, vector pixel *);
13160 void vec_stl (vector pixel, int, unsigned short *);
13161 void vec_stl (vector pixel, int, short *);
13162 void vec_stl (vector signed char, int, vector signed char *);
13163 void vec_stl (vector signed char, int, signed char *);
13164 void vec_stl (vector unsigned char, int, vector unsigned char *);
13165 void vec_stl (vector unsigned char, int, unsigned char *);
13166 void vec_stl (vector bool char, int, vector bool char *);
13167 void vec_stl (vector bool char, int, unsigned char *);
13168 void vec_stl (vector bool char, int, signed char *);
13170 vector signed char vec_sub (vector bool char, vector signed char);
13171 vector signed char vec_sub (vector signed char, vector bool char);
13172 vector signed char vec_sub (vector signed char, vector signed char);
13173 vector unsigned char vec_sub (vector bool char, vector unsigned char);
13174 vector unsigned char vec_sub (vector unsigned char, vector bool char);
13175 vector unsigned char vec_sub (vector unsigned char,
13176                               vector unsigned char);
13177 vector signed short vec_sub (vector bool short, vector signed short);
13178 vector signed short vec_sub (vector signed short, vector bool short);
13179 vector signed short vec_sub (vector signed short, vector signed short);
13180 vector unsigned short vec_sub (vector bool short,
13181                                vector unsigned short);
13182 vector unsigned short vec_sub (vector unsigned short,
13183                                vector bool short);
13184 vector unsigned short vec_sub (vector unsigned short,
13185                                vector unsigned short);
13186 vector signed int vec_sub (vector bool int, vector signed int);
13187 vector signed int vec_sub (vector signed int, vector bool int);
13188 vector signed int vec_sub (vector signed int, vector signed int);
13189 vector unsigned int vec_sub (vector bool int, vector unsigned int);
13190 vector unsigned int vec_sub (vector unsigned int, vector bool int);
13191 vector unsigned int vec_sub (vector unsigned int, vector unsigned int);
13192 vector float vec_sub (vector float, vector float);
13194 vector float vec_vsubfp (vector float, vector float);
13196 vector signed int vec_vsubuwm (vector bool int, vector signed int);
13197 vector signed int vec_vsubuwm (vector signed int, vector bool int);
13198 vector signed int vec_vsubuwm (vector signed int, vector signed int);
13199 vector unsigned int vec_vsubuwm (vector bool int, vector unsigned int);
13200 vector unsigned int vec_vsubuwm (vector unsigned int, vector bool int);
13201 vector unsigned int vec_vsubuwm (vector unsigned int,
13202                                  vector unsigned int);
13204 vector signed short vec_vsubuhm (vector bool short,
13205                                  vector signed short);
13206 vector signed short vec_vsubuhm (vector signed short,
13207                                  vector bool short);
13208 vector signed short vec_vsubuhm (vector signed short,
13209                                  vector signed short);
13210 vector unsigned short vec_vsubuhm (vector bool short,
13211                                    vector unsigned short);
13212 vector unsigned short vec_vsubuhm (vector unsigned short,
13213                                    vector bool short);
13214 vector unsigned short vec_vsubuhm (vector unsigned short,
13215                                    vector unsigned short);
13217 vector signed char vec_vsububm (vector bool char, vector signed char);
13218 vector signed char vec_vsububm (vector signed char, vector bool char);
13219 vector signed char vec_vsububm (vector signed char, vector signed char);
13220 vector unsigned char vec_vsububm (vector bool char,
13221                                   vector unsigned char);
13222 vector unsigned char vec_vsububm (vector unsigned char,
13223                                   vector bool char);
13224 vector unsigned char vec_vsububm (vector unsigned char,
13225                                   vector unsigned char);
13227 vector unsigned int vec_subc (vector unsigned int, vector unsigned int);
13229 vector unsigned char vec_subs (vector bool char, vector unsigned char);
13230 vector unsigned char vec_subs (vector unsigned char, vector bool char);
13231 vector unsigned char vec_subs (vector unsigned char,
13232                                vector unsigned char);
13233 vector signed char vec_subs (vector bool char, vector signed char);
13234 vector signed char vec_subs (vector signed char, vector bool char);
13235 vector signed char vec_subs (vector signed char, vector signed char);
13236 vector unsigned short vec_subs (vector bool short,
13237                                 vector unsigned short);
13238 vector unsigned short vec_subs (vector unsigned short,
13239                                 vector bool short);
13240 vector unsigned short vec_subs (vector unsigned short,
13241                                 vector unsigned short);
13242 vector signed short vec_subs (vector bool short, vector signed short);
13243 vector signed short vec_subs (vector signed short, vector bool short);
13244 vector signed short vec_subs (vector signed short, vector signed short);
13245 vector unsigned int vec_subs (vector bool int, vector unsigned int);
13246 vector unsigned int vec_subs (vector unsigned int, vector bool int);
13247 vector unsigned int vec_subs (vector unsigned int, vector unsigned int);
13248 vector signed int vec_subs (vector bool int, vector signed int);
13249 vector signed int vec_subs (vector signed int, vector bool int);
13250 vector signed int vec_subs (vector signed int, vector signed int);
13252 vector signed int vec_vsubsws (vector bool int, vector signed int);
13253 vector signed int vec_vsubsws (vector signed int, vector bool int);
13254 vector signed int vec_vsubsws (vector signed int, vector signed int);
13256 vector unsigned int vec_vsubuws (vector bool int, vector unsigned int);
13257 vector unsigned int vec_vsubuws (vector unsigned int, vector bool int);
13258 vector unsigned int vec_vsubuws (vector unsigned int,
13259                                  vector unsigned int);
13261 vector signed short vec_vsubshs (vector bool short,
13262                                  vector signed short);
13263 vector signed short vec_vsubshs (vector signed short,
13264                                  vector bool short);
13265 vector signed short vec_vsubshs (vector signed short,
13266                                  vector signed short);
13268 vector unsigned short vec_vsubuhs (vector bool short,
13269                                    vector unsigned short);
13270 vector unsigned short vec_vsubuhs (vector unsigned short,
13271                                    vector bool short);
13272 vector unsigned short vec_vsubuhs (vector unsigned short,
13273                                    vector unsigned short);
13275 vector signed char vec_vsubsbs (vector bool char, vector signed char);
13276 vector signed char vec_vsubsbs (vector signed char, vector bool char);
13277 vector signed char vec_vsubsbs (vector signed char, vector signed char);
13279 vector unsigned char vec_vsububs (vector bool char,
13280                                   vector unsigned char);
13281 vector unsigned char vec_vsububs (vector unsigned char,
13282                                   vector bool char);
13283 vector unsigned char vec_vsububs (vector unsigned char,
13284                                   vector unsigned char);
13286 vector unsigned int vec_sum4s (vector unsigned char,
13287                                vector unsigned int);
13288 vector signed int vec_sum4s (vector signed char, vector signed int);
13289 vector signed int vec_sum4s (vector signed short, vector signed int);
13291 vector signed int vec_vsum4shs (vector signed short, vector signed int);
13293 vector signed int vec_vsum4sbs (vector signed char, vector signed int);
13295 vector unsigned int vec_vsum4ubs (vector unsigned char,
13296                                   vector unsigned int);
13298 vector signed int vec_sum2s (vector signed int, vector signed int);
13300 vector signed int vec_sums (vector signed int, vector signed int);
13302 vector float vec_trunc (vector float);
13304 vector signed short vec_unpackh (vector signed char);
13305 vector bool short vec_unpackh (vector bool char);
13306 vector signed int vec_unpackh (vector signed short);
13307 vector bool int vec_unpackh (vector bool short);
13308 vector unsigned int vec_unpackh (vector pixel);
13310 vector bool int vec_vupkhsh (vector bool short);
13311 vector signed int vec_vupkhsh (vector signed short);
13313 vector unsigned int vec_vupkhpx (vector pixel);
13315 vector bool short vec_vupkhsb (vector bool char);
13316 vector signed short vec_vupkhsb (vector signed char);
13318 vector signed short vec_unpackl (vector signed char);
13319 vector bool short vec_unpackl (vector bool char);
13320 vector unsigned int vec_unpackl (vector pixel);
13321 vector signed int vec_unpackl (vector signed short);
13322 vector bool int vec_unpackl (vector bool short);
13324 vector unsigned int vec_vupklpx (vector pixel);
13326 vector bool int vec_vupklsh (vector bool short);
13327 vector signed int vec_vupklsh (vector signed short);
13329 vector bool short vec_vupklsb (vector bool char);
13330 vector signed short vec_vupklsb (vector signed char);
13332 vector float vec_xor (vector float, vector float);
13333 vector float vec_xor (vector float, vector bool int);
13334 vector float vec_xor (vector bool int, vector float);
13335 vector bool int vec_xor (vector bool int, vector bool int);
13336 vector signed int vec_xor (vector bool int, vector signed int);
13337 vector signed int vec_xor (vector signed int, vector bool int);
13338 vector signed int vec_xor (vector signed int, vector signed int);
13339 vector unsigned int vec_xor (vector bool int, vector unsigned int);
13340 vector unsigned int vec_xor (vector unsigned int, vector bool int);
13341 vector unsigned int vec_xor (vector unsigned int, vector unsigned int);
13342 vector bool short vec_xor (vector bool short, vector bool short);
13343 vector signed short vec_xor (vector bool short, vector signed short);
13344 vector signed short vec_xor (vector signed short, vector bool short);
13345 vector signed short vec_xor (vector signed short, vector signed short);
13346 vector unsigned short vec_xor (vector bool short,
13347                                vector unsigned short);
13348 vector unsigned short vec_xor (vector unsigned short,
13349                                vector bool short);
13350 vector unsigned short vec_xor (vector unsigned short,
13351                                vector unsigned short);
13352 vector signed char vec_xor (vector bool char, vector signed char);
13353 vector bool char vec_xor (vector bool char, vector bool char);
13354 vector signed char vec_xor (vector signed char, vector bool char);
13355 vector signed char vec_xor (vector signed char, vector signed char);
13356 vector unsigned char vec_xor (vector bool char, vector unsigned char);
13357 vector unsigned char vec_xor (vector unsigned char, vector bool char);
13358 vector unsigned char vec_xor (vector unsigned char,
13359                               vector unsigned char);
13361 int vec_all_eq (vector signed char, vector bool char);
13362 int vec_all_eq (vector signed char, vector signed char);
13363 int vec_all_eq (vector unsigned char, vector bool char);
13364 int vec_all_eq (vector unsigned char, vector unsigned char);
13365 int vec_all_eq (vector bool char, vector bool char);
13366 int vec_all_eq (vector bool char, vector unsigned char);
13367 int vec_all_eq (vector bool char, vector signed char);
13368 int vec_all_eq (vector signed short, vector bool short);
13369 int vec_all_eq (vector signed short, vector signed short);
13370 int vec_all_eq (vector unsigned short, vector bool short);
13371 int vec_all_eq (vector unsigned short, vector unsigned short);
13372 int vec_all_eq (vector bool short, vector bool short);
13373 int vec_all_eq (vector bool short, vector unsigned short);
13374 int vec_all_eq (vector bool short, vector signed short);
13375 int vec_all_eq (vector pixel, vector pixel);
13376 int vec_all_eq (vector signed int, vector bool int);
13377 int vec_all_eq (vector signed int, vector signed int);
13378 int vec_all_eq (vector unsigned int, vector bool int);
13379 int vec_all_eq (vector unsigned int, vector unsigned int);
13380 int vec_all_eq (vector bool int, vector bool int);
13381 int vec_all_eq (vector bool int, vector unsigned int);
13382 int vec_all_eq (vector bool int, vector signed int);
13383 int vec_all_eq (vector float, vector float);
13385 int vec_all_ge (vector bool char, vector unsigned char);
13386 int vec_all_ge (vector unsigned char, vector bool char);
13387 int vec_all_ge (vector unsigned char, vector unsigned char);
13388 int vec_all_ge (vector bool char, vector signed char);
13389 int vec_all_ge (vector signed char, vector bool char);
13390 int vec_all_ge (vector signed char, vector signed char);
13391 int vec_all_ge (vector bool short, vector unsigned short);
13392 int vec_all_ge (vector unsigned short, vector bool short);
13393 int vec_all_ge (vector unsigned short, vector unsigned short);
13394 int vec_all_ge (vector signed short, vector signed short);
13395 int vec_all_ge (vector bool short, vector signed short);
13396 int vec_all_ge (vector signed short, vector bool short);
13397 int vec_all_ge (vector bool int, vector unsigned int);
13398 int vec_all_ge (vector unsigned int, vector bool int);
13399 int vec_all_ge (vector unsigned int, vector unsigned int);
13400 int vec_all_ge (vector bool int, vector signed int);
13401 int vec_all_ge (vector signed int, vector bool int);
13402 int vec_all_ge (vector signed int, vector signed int);
13403 int vec_all_ge (vector float, vector float);
13405 int vec_all_gt (vector bool char, vector unsigned char);
13406 int vec_all_gt (vector unsigned char, vector bool char);
13407 int vec_all_gt (vector unsigned char, vector unsigned char);
13408 int vec_all_gt (vector bool char, vector signed char);
13409 int vec_all_gt (vector signed char, vector bool char);
13410 int vec_all_gt (vector signed char, vector signed char);
13411 int vec_all_gt (vector bool short, vector unsigned short);
13412 int vec_all_gt (vector unsigned short, vector bool short);
13413 int vec_all_gt (vector unsigned short, vector unsigned short);
13414 int vec_all_gt (vector bool short, vector signed short);
13415 int vec_all_gt (vector signed short, vector bool short);
13416 int vec_all_gt (vector signed short, vector signed short);
13417 int vec_all_gt (vector bool int, vector unsigned int);
13418 int vec_all_gt (vector unsigned int, vector bool int);
13419 int vec_all_gt (vector unsigned int, vector unsigned int);
13420 int vec_all_gt (vector bool int, vector signed int);
13421 int vec_all_gt (vector signed int, vector bool int);
13422 int vec_all_gt (vector signed int, vector signed int);
13423 int vec_all_gt (vector float, vector float);
13425 int vec_all_in (vector float, vector float);
13427 int vec_all_le (vector bool char, vector unsigned char);
13428 int vec_all_le (vector unsigned char, vector bool char);
13429 int vec_all_le (vector unsigned char, vector unsigned char);
13430 int vec_all_le (vector bool char, vector signed char);
13431 int vec_all_le (vector signed char, vector bool char);
13432 int vec_all_le (vector signed char, vector signed char);
13433 int vec_all_le (vector bool short, vector unsigned short);
13434 int vec_all_le (vector unsigned short, vector bool short);
13435 int vec_all_le (vector unsigned short, vector unsigned short);
13436 int vec_all_le (vector bool short, vector signed short);
13437 int vec_all_le (vector signed short, vector bool short);
13438 int vec_all_le (vector signed short, vector signed short);
13439 int vec_all_le (vector bool int, vector unsigned int);
13440 int vec_all_le (vector unsigned int, vector bool int);
13441 int vec_all_le (vector unsigned int, vector unsigned int);
13442 int vec_all_le (vector bool int, vector signed int);
13443 int vec_all_le (vector signed int, vector bool int);
13444 int vec_all_le (vector signed int, vector signed int);
13445 int vec_all_le (vector float, vector float);
13447 int vec_all_lt (vector bool char, vector unsigned char);
13448 int vec_all_lt (vector unsigned char, vector bool char);
13449 int vec_all_lt (vector unsigned char, vector unsigned char);
13450 int vec_all_lt (vector bool char, vector signed char);
13451 int vec_all_lt (vector signed char, vector bool char);
13452 int vec_all_lt (vector signed char, vector signed char);
13453 int vec_all_lt (vector bool short, vector unsigned short);
13454 int vec_all_lt (vector unsigned short, vector bool short);
13455 int vec_all_lt (vector unsigned short, vector unsigned short);
13456 int vec_all_lt (vector bool short, vector signed short);
13457 int vec_all_lt (vector signed short, vector bool short);
13458 int vec_all_lt (vector signed short, vector signed short);
13459 int vec_all_lt (vector bool int, vector unsigned int);
13460 int vec_all_lt (vector unsigned int, vector bool int);
13461 int vec_all_lt (vector unsigned int, vector unsigned int);
13462 int vec_all_lt (vector bool int, vector signed int);
13463 int vec_all_lt (vector signed int, vector bool int);
13464 int vec_all_lt (vector signed int, vector signed int);
13465 int vec_all_lt (vector float, vector float);
13467 int vec_all_nan (vector float);
13469 int vec_all_ne (vector signed char, vector bool char);
13470 int vec_all_ne (vector signed char, vector signed char);
13471 int vec_all_ne (vector unsigned char, vector bool char);
13472 int vec_all_ne (vector unsigned char, vector unsigned char);
13473 int vec_all_ne (vector bool char, vector bool char);
13474 int vec_all_ne (vector bool char, vector unsigned char);
13475 int vec_all_ne (vector bool char, vector signed char);
13476 int vec_all_ne (vector signed short, vector bool short);
13477 int vec_all_ne (vector signed short, vector signed short);
13478 int vec_all_ne (vector unsigned short, vector bool short);
13479 int vec_all_ne (vector unsigned short, vector unsigned short);
13480 int vec_all_ne (vector bool short, vector bool short);
13481 int vec_all_ne (vector bool short, vector unsigned short);
13482 int vec_all_ne (vector bool short, vector signed short);
13483 int vec_all_ne (vector pixel, vector pixel);
13484 int vec_all_ne (vector signed int, vector bool int);
13485 int vec_all_ne (vector signed int, vector signed int);
13486 int vec_all_ne (vector unsigned int, vector bool int);
13487 int vec_all_ne (vector unsigned int, vector unsigned int);
13488 int vec_all_ne (vector bool int, vector bool int);
13489 int vec_all_ne (vector bool int, vector unsigned int);
13490 int vec_all_ne (vector bool int, vector signed int);
13491 int vec_all_ne (vector float, vector float);
13493 int vec_all_nge (vector float, vector float);
13495 int vec_all_ngt (vector float, vector float);
13497 int vec_all_nle (vector float, vector float);
13499 int vec_all_nlt (vector float, vector float);
13501 int vec_all_numeric (vector float);
13503 int vec_any_eq (vector signed char, vector bool char);
13504 int vec_any_eq (vector signed char, vector signed char);
13505 int vec_any_eq (vector unsigned char, vector bool char);
13506 int vec_any_eq (vector unsigned char, vector unsigned char);
13507 int vec_any_eq (vector bool char, vector bool char);
13508 int vec_any_eq (vector bool char, vector unsigned char);
13509 int vec_any_eq (vector bool char, vector signed char);
13510 int vec_any_eq (vector signed short, vector bool short);
13511 int vec_any_eq (vector signed short, vector signed short);
13512 int vec_any_eq (vector unsigned short, vector bool short);
13513 int vec_any_eq (vector unsigned short, vector unsigned short);
13514 int vec_any_eq (vector bool short, vector bool short);
13515 int vec_any_eq (vector bool short, vector unsigned short);
13516 int vec_any_eq (vector bool short, vector signed short);
13517 int vec_any_eq (vector pixel, vector pixel);
13518 int vec_any_eq (vector signed int, vector bool int);
13519 int vec_any_eq (vector signed int, vector signed int);
13520 int vec_any_eq (vector unsigned int, vector bool int);
13521 int vec_any_eq (vector unsigned int, vector unsigned int);
13522 int vec_any_eq (vector bool int, vector bool int);
13523 int vec_any_eq (vector bool int, vector unsigned int);
13524 int vec_any_eq (vector bool int, vector signed int);
13525 int vec_any_eq (vector float, vector float);
13527 int vec_any_ge (vector signed char, vector bool char);
13528 int vec_any_ge (vector unsigned char, vector bool char);
13529 int vec_any_ge (vector unsigned char, vector unsigned char);
13530 int vec_any_ge (vector signed char, vector signed char);
13531 int vec_any_ge (vector bool char, vector unsigned char);
13532 int vec_any_ge (vector bool char, vector signed char);
13533 int vec_any_ge (vector unsigned short, vector bool short);
13534 int vec_any_ge (vector unsigned short, vector unsigned short);
13535 int vec_any_ge (vector signed short, vector signed short);
13536 int vec_any_ge (vector signed short, vector bool short);
13537 int vec_any_ge (vector bool short, vector unsigned short);
13538 int vec_any_ge (vector bool short, vector signed short);
13539 int vec_any_ge (vector signed int, vector bool int);
13540 int vec_any_ge (vector unsigned int, vector bool int);
13541 int vec_any_ge (vector unsigned int, vector unsigned int);
13542 int vec_any_ge (vector signed int, vector signed int);
13543 int vec_any_ge (vector bool int, vector unsigned int);
13544 int vec_any_ge (vector bool int, vector signed int);
13545 int vec_any_ge (vector float, vector float);
13547 int vec_any_gt (vector bool char, vector unsigned char);
13548 int vec_any_gt (vector unsigned char, vector bool char);
13549 int vec_any_gt (vector unsigned char, vector unsigned char);
13550 int vec_any_gt (vector bool char, vector signed char);
13551 int vec_any_gt (vector signed char, vector bool char);
13552 int vec_any_gt (vector signed char, vector signed char);
13553 int vec_any_gt (vector bool short, vector unsigned short);
13554 int vec_any_gt (vector unsigned short, vector bool short);
13555 int vec_any_gt (vector unsigned short, vector unsigned short);
13556 int vec_any_gt (vector bool short, vector signed short);
13557 int vec_any_gt (vector signed short, vector bool short);
13558 int vec_any_gt (vector signed short, vector signed short);
13559 int vec_any_gt (vector bool int, vector unsigned int);
13560 int vec_any_gt (vector unsigned int, vector bool int);
13561 int vec_any_gt (vector unsigned int, vector unsigned int);
13562 int vec_any_gt (vector bool int, vector signed int);
13563 int vec_any_gt (vector signed int, vector bool int);
13564 int vec_any_gt (vector signed int, vector signed int);
13565 int vec_any_gt (vector float, vector float);
13567 int vec_any_le (vector bool char, vector unsigned char);
13568 int vec_any_le (vector unsigned char, vector bool char);
13569 int vec_any_le (vector unsigned char, vector unsigned char);
13570 int vec_any_le (vector bool char, vector signed char);
13571 int vec_any_le (vector signed char, vector bool char);
13572 int vec_any_le (vector signed char, vector signed char);
13573 int vec_any_le (vector bool short, vector unsigned short);
13574 int vec_any_le (vector unsigned short, vector bool short);
13575 int vec_any_le (vector unsigned short, vector unsigned short);
13576 int vec_any_le (vector bool short, vector signed short);
13577 int vec_any_le (vector signed short, vector bool short);
13578 int vec_any_le (vector signed short, vector signed short);
13579 int vec_any_le (vector bool int, vector unsigned int);
13580 int vec_any_le (vector unsigned int, vector bool int);
13581 int vec_any_le (vector unsigned int, vector unsigned int);
13582 int vec_any_le (vector bool int, vector signed int);
13583 int vec_any_le (vector signed int, vector bool int);
13584 int vec_any_le (vector signed int, vector signed int);
13585 int vec_any_le (vector float, vector float);
13587 int vec_any_lt (vector bool char, vector unsigned char);
13588 int vec_any_lt (vector unsigned char, vector bool char);
13589 int vec_any_lt (vector unsigned char, vector unsigned char);
13590 int vec_any_lt (vector bool char, vector signed char);
13591 int vec_any_lt (vector signed char, vector bool char);
13592 int vec_any_lt (vector signed char, vector signed char);
13593 int vec_any_lt (vector bool short, vector unsigned short);
13594 int vec_any_lt (vector unsigned short, vector bool short);
13595 int vec_any_lt (vector unsigned short, vector unsigned short);
13596 int vec_any_lt (vector bool short, vector signed short);
13597 int vec_any_lt (vector signed short, vector bool short);
13598 int vec_any_lt (vector signed short, vector signed short);
13599 int vec_any_lt (vector bool int, vector unsigned int);
13600 int vec_any_lt (vector unsigned int, vector bool int);
13601 int vec_any_lt (vector unsigned int, vector unsigned int);
13602 int vec_any_lt (vector bool int, vector signed int);
13603 int vec_any_lt (vector signed int, vector bool int);
13604 int vec_any_lt (vector signed int, vector signed int);
13605 int vec_any_lt (vector float, vector float);
13607 int vec_any_nan (vector float);
13609 int vec_any_ne (vector signed char, vector bool char);
13610 int vec_any_ne (vector signed char, vector signed char);
13611 int vec_any_ne (vector unsigned char, vector bool char);
13612 int vec_any_ne (vector unsigned char, vector unsigned char);
13613 int vec_any_ne (vector bool char, vector bool char);
13614 int vec_any_ne (vector bool char, vector unsigned char);
13615 int vec_any_ne (vector bool char, vector signed char);
13616 int vec_any_ne (vector signed short, vector bool short);
13617 int vec_any_ne (vector signed short, vector signed short);
13618 int vec_any_ne (vector unsigned short, vector bool short);
13619 int vec_any_ne (vector unsigned short, vector unsigned short);
13620 int vec_any_ne (vector bool short, vector bool short);
13621 int vec_any_ne (vector bool short, vector unsigned short);
13622 int vec_any_ne (vector bool short, vector signed short);
13623 int vec_any_ne (vector pixel, vector pixel);
13624 int vec_any_ne (vector signed int, vector bool int);
13625 int vec_any_ne (vector signed int, vector signed int);
13626 int vec_any_ne (vector unsigned int, vector bool int);
13627 int vec_any_ne (vector unsigned int, vector unsigned int);
13628 int vec_any_ne (vector bool int, vector bool int);
13629 int vec_any_ne (vector bool int, vector unsigned int);
13630 int vec_any_ne (vector bool int, vector signed int);
13631 int vec_any_ne (vector float, vector float);
13633 int vec_any_nge (vector float, vector float);
13635 int vec_any_ngt (vector float, vector float);
13637 int vec_any_nle (vector float, vector float);
13639 int vec_any_nlt (vector float, vector float);
13641 int vec_any_numeric (vector float);
13643 int vec_any_out (vector float, vector float);
13644 @end smallexample
13646 If the vector/scalar (VSX) instruction set is available, the following
13647 additional functions are available:
13649 @smallexample
13650 vector double vec_abs (vector double);
13651 vector double vec_add (vector double, vector double);
13652 vector double vec_and (vector double, vector double);
13653 vector double vec_and (vector double, vector bool long);
13654 vector double vec_and (vector bool long, vector double);
13655 vector double vec_andc (vector double, vector double);
13656 vector double vec_andc (vector double, vector bool long);
13657 vector double vec_andc (vector bool long, vector double);
13658 vector double vec_ceil (vector double);
13659 vector bool long vec_cmpeq (vector double, vector double);
13660 vector bool long vec_cmpge (vector double, vector double);
13661 vector bool long vec_cmpgt (vector double, vector double);
13662 vector bool long vec_cmple (vector double, vector double);
13663 vector bool long vec_cmplt (vector double, vector double);
13664 vector float vec_div (vector float, vector float);
13665 vector double vec_div (vector double, vector double);
13666 vector double vec_floor (vector double);
13667 vector double vec_ld (int, const vector double *);
13668 vector double vec_ld (int, const double *);
13669 vector double vec_ldl (int, const vector double *);
13670 vector double vec_ldl (int, const double *);
13671 vector unsigned char vec_lvsl (int, const volatile double *);
13672 vector unsigned char vec_lvsr (int, const volatile double *);
13673 vector double vec_madd (vector double, vector double, vector double);
13674 vector double vec_max (vector double, vector double);
13675 vector double vec_min (vector double, vector double);
13676 vector float vec_msub (vector float, vector float, vector float);
13677 vector double vec_msub (vector double, vector double, vector double);
13678 vector float vec_mul (vector float, vector float);
13679 vector double vec_mul (vector double, vector double);
13680 vector float vec_nearbyint (vector float);
13681 vector double vec_nearbyint (vector double);
13682 vector float vec_nmadd (vector float, vector float, vector float);
13683 vector double vec_nmadd (vector double, vector double, vector double);
13684 vector double vec_nmsub (vector double, vector double, vector double);
13685 vector double vec_nor (vector double, vector double);
13686 vector double vec_or (vector double, vector double);
13687 vector double vec_or (vector double, vector bool long);
13688 vector double vec_or (vector bool long, vector double);
13689 vector double vec_perm (vector double,
13690                         vector double,
13691                         vector unsigned char);
13692 vector double vec_rint (vector double);
13693 vector double vec_recip (vector double, vector double);
13694 vector double vec_rsqrt (vector double);
13695 vector double vec_rsqrte (vector double);
13696 vector double vec_sel (vector double, vector double, vector bool long);
13697 vector double vec_sel (vector double, vector double, vector unsigned long);
13698 vector double vec_sub (vector double, vector double);
13699 vector float vec_sqrt (vector float);
13700 vector double vec_sqrt (vector double);
13701 void vec_st (vector double, int, vector double *);
13702 void vec_st (vector double, int, double *);
13703 vector double vec_trunc (vector double);
13704 vector double vec_xor (vector double, vector double);
13705 vector double vec_xor (vector double, vector bool long);
13706 vector double vec_xor (vector bool long, vector double);
13707 int vec_all_eq (vector double, vector double);
13708 int vec_all_ge (vector double, vector double);
13709 int vec_all_gt (vector double, vector double);
13710 int vec_all_le (vector double, vector double);
13711 int vec_all_lt (vector double, vector double);
13712 int vec_all_nan (vector double);
13713 int vec_all_ne (vector double, vector double);
13714 int vec_all_nge (vector double, vector double);
13715 int vec_all_ngt (vector double, vector double);
13716 int vec_all_nle (vector double, vector double);
13717 int vec_all_nlt (vector double, vector double);
13718 int vec_all_numeric (vector double);
13719 int vec_any_eq (vector double, vector double);
13720 int vec_any_ge (vector double, vector double);
13721 int vec_any_gt (vector double, vector double);
13722 int vec_any_le (vector double, vector double);
13723 int vec_any_lt (vector double, vector double);
13724 int vec_any_nan (vector double);
13725 int vec_any_ne (vector double, vector double);
13726 int vec_any_nge (vector double, vector double);
13727 int vec_any_ngt (vector double, vector double);
13728 int vec_any_nle (vector double, vector double);
13729 int vec_any_nlt (vector double, vector double);
13730 int vec_any_numeric (vector double);
13732 vector double vec_vsx_ld (int, const vector double *);
13733 vector double vec_vsx_ld (int, const double *);
13734 vector float vec_vsx_ld (int, const vector float *);
13735 vector float vec_vsx_ld (int, const float *);
13736 vector bool int vec_vsx_ld (int, const vector bool int *);
13737 vector signed int vec_vsx_ld (int, const vector signed int *);
13738 vector signed int vec_vsx_ld (int, const int *);
13739 vector signed int vec_vsx_ld (int, const long *);
13740 vector unsigned int vec_vsx_ld (int, const vector unsigned int *);
13741 vector unsigned int vec_vsx_ld (int, const unsigned int *);
13742 vector unsigned int vec_vsx_ld (int, const unsigned long *);
13743 vector bool short vec_vsx_ld (int, const vector bool short *);
13744 vector pixel vec_vsx_ld (int, const vector pixel *);
13745 vector signed short vec_vsx_ld (int, const vector signed short *);
13746 vector signed short vec_vsx_ld (int, const short *);
13747 vector unsigned short vec_vsx_ld (int, const vector unsigned short *);
13748 vector unsigned short vec_vsx_ld (int, const unsigned short *);
13749 vector bool char vec_vsx_ld (int, const vector bool char *);
13750 vector signed char vec_vsx_ld (int, const vector signed char *);
13751 vector signed char vec_vsx_ld (int, const signed char *);
13752 vector unsigned char vec_vsx_ld (int, const vector unsigned char *);
13753 vector unsigned char vec_vsx_ld (int, const unsigned char *);
13755 void vec_vsx_st (vector double, int, vector double *);
13756 void vec_vsx_st (vector double, int, double *);
13757 void vec_vsx_st (vector float, int, vector float *);
13758 void vec_vsx_st (vector float, int, float *);
13759 void vec_vsx_st (vector signed int, int, vector signed int *);
13760 void vec_vsx_st (vector signed int, int, int *);
13761 void vec_vsx_st (vector unsigned int, int, vector unsigned int *);
13762 void vec_vsx_st (vector unsigned int, int, unsigned int *);
13763 void vec_vsx_st (vector bool int, int, vector bool int *);
13764 void vec_vsx_st (vector bool int, int, unsigned int *);
13765 void vec_vsx_st (vector bool int, int, int *);
13766 void vec_vsx_st (vector signed short, int, vector signed short *);
13767 void vec_vsx_st (vector signed short, int, short *);
13768 void vec_vsx_st (vector unsigned short, int, vector unsigned short *);
13769 void vec_vsx_st (vector unsigned short, int, unsigned short *);
13770 void vec_vsx_st (vector bool short, int, vector bool short *);
13771 void vec_vsx_st (vector bool short, int, unsigned short *);
13772 void vec_vsx_st (vector pixel, int, vector pixel *);
13773 void vec_vsx_st (vector pixel, int, unsigned short *);
13774 void vec_vsx_st (vector pixel, int, short *);
13775 void vec_vsx_st (vector bool short, int, short *);
13776 void vec_vsx_st (vector signed char, int, vector signed char *);
13777 void vec_vsx_st (vector signed char, int, signed char *);
13778 void vec_vsx_st (vector unsigned char, int, vector unsigned char *);
13779 void vec_vsx_st (vector unsigned char, int, unsigned char *);
13780 void vec_vsx_st (vector bool char, int, vector bool char *);
13781 void vec_vsx_st (vector bool char, int, unsigned char *);
13782 void vec_vsx_st (vector bool char, int, signed char *);
13783 @end smallexample
13785 Note that the @samp{vec_ld} and @samp{vec_st} built-in functions always
13786 generate the AltiVec @samp{LVX} and @samp{STVX} instructions even
13787 if the VSX instruction set is available.  The @samp{vec_vsx_ld} and
13788 @samp{vec_vsx_st} built-in functions always generate the VSX @samp{LXVD2X},
13789 @samp{LXVW4X}, @samp{STXVD2X}, and @samp{STXVW4X} instructions.
13791 @node SH Built-in Functions
13792 @subsection SH Built-in Functions
13793 The following built-in functions are supported on the SH1, SH2, SH3 and SH4
13794 families of processors:
13796 @deftypefn {Built-in Function} {void} __builtin_set_thread_pointer (void *@var{ptr})
13797 Sets the @samp{GBR} register to the specified value @var{ptr}.  This is usually
13798 used by system code that manages threads and execution contexts.  The compiler
13799 normally does not generate code that modifies the contents of @samp{GBR} and
13800 thus the value is preserved across function calls.  Changing the @samp{GBR}
13801 value in user code must be done with caution, since the compiler might use
13802 @samp{GBR} in order to access thread local variables.
13804 @end deftypefn
13806 @deftypefn {Built-in Function} {void *} __builtin_thread_pointer (void)
13807 Returns the value that is currently set in the @samp{GBR} register.
13808 Memory loads and stores that use the thread pointer as a base address are
13809 turned into @samp{GBR} based displacement loads and stores, if possible.
13810 For example:
13811 @smallexample
13812 struct my_tcb
13814    int a, b, c, d, e;
13817 int get_tcb_value (void)
13819   // Generate @samp{mov.l @@(8,gbr),r0} instruction
13820   return ((my_tcb*)__builtin_thread_pointer ())->c;
13823 @end smallexample
13824 @end deftypefn
13826 @node RX Built-in Functions
13827 @subsection RX Built-in Functions
13828 GCC supports some of the RX instructions which cannot be expressed in
13829 the C programming language via the use of built-in functions.  The
13830 following functions are supported:
13832 @deftypefn {Built-in Function}  void __builtin_rx_brk (void)
13833 Generates the @code{brk} machine instruction.
13834 @end deftypefn
13836 @deftypefn {Built-in Function}  void __builtin_rx_clrpsw (int)
13837 Generates the @code{clrpsw} machine instruction to clear the specified
13838 bit in the processor status word.
13839 @end deftypefn
13841 @deftypefn {Built-in Function}  void __builtin_rx_int (int)
13842 Generates the @code{int} machine instruction to generate an interrupt
13843 with the specified value.
13844 @end deftypefn
13846 @deftypefn {Built-in Function}  void __builtin_rx_machi (int, int)
13847 Generates the @code{machi} machine instruction to add the result of
13848 multiplying the top 16 bits of the two arguments into the
13849 accumulator.
13850 @end deftypefn
13852 @deftypefn {Built-in Function}  void __builtin_rx_maclo (int, int)
13853 Generates the @code{maclo} machine instruction to add the result of
13854 multiplying the bottom 16 bits of the two arguments into the
13855 accumulator.
13856 @end deftypefn
13858 @deftypefn {Built-in Function}  void __builtin_rx_mulhi (int, int)
13859 Generates the @code{mulhi} machine instruction to place the result of
13860 multiplying the top 16 bits of the two arguments into the
13861 accumulator.
13862 @end deftypefn
13864 @deftypefn {Built-in Function}  void __builtin_rx_mullo (int, int)
13865 Generates the @code{mullo} machine instruction to place the result of
13866 multiplying the bottom 16 bits of the two arguments into the
13867 accumulator.
13868 @end deftypefn
13870 @deftypefn {Built-in Function}  int  __builtin_rx_mvfachi (void)
13871 Generates the @code{mvfachi} machine instruction to read the top
13872 32 bits of the accumulator.
13873 @end deftypefn
13875 @deftypefn {Built-in Function}  int  __builtin_rx_mvfacmi (void)
13876 Generates the @code{mvfacmi} machine instruction to read the middle
13877 32 bits of the accumulator.
13878 @end deftypefn
13880 @deftypefn {Built-in Function}  int __builtin_rx_mvfc (int)
13881 Generates the @code{mvfc} machine instruction which reads the control
13882 register specified in its argument and returns its value.
13883 @end deftypefn
13885 @deftypefn {Built-in Function}  void __builtin_rx_mvtachi (int)
13886 Generates the @code{mvtachi} machine instruction to set the top
13887 32 bits of the accumulator.
13888 @end deftypefn
13890 @deftypefn {Built-in Function}  void __builtin_rx_mvtaclo (int)
13891 Generates the @code{mvtaclo} machine instruction to set the bottom
13892 32 bits of the accumulator.
13893 @end deftypefn
13895 @deftypefn {Built-in Function}  void __builtin_rx_mvtc (int reg, int val)
13896 Generates the @code{mvtc} machine instruction which sets control
13897 register number @code{reg} to @code{val}.
13898 @end deftypefn
13900 @deftypefn {Built-in Function}  void __builtin_rx_mvtipl (int)
13901 Generates the @code{mvtipl} machine instruction set the interrupt
13902 priority level.
13903 @end deftypefn
13905 @deftypefn {Built-in Function}  void __builtin_rx_racw (int)
13906 Generates the @code{racw} machine instruction to round the accumulator
13907 according to the specified mode.
13908 @end deftypefn
13910 @deftypefn {Built-in Function}  int __builtin_rx_revw (int)
13911 Generates the @code{revw} machine instruction which swaps the bytes in
13912 the argument so that bits 0--7 now occupy bits 8--15 and vice versa,
13913 and also bits 16--23 occupy bits 24--31 and vice versa.
13914 @end deftypefn
13916 @deftypefn {Built-in Function}  void __builtin_rx_rmpa (void)
13917 Generates the @code{rmpa} machine instruction which initiates a
13918 repeated multiply and accumulate sequence.
13919 @end deftypefn
13921 @deftypefn {Built-in Function}  void __builtin_rx_round (float)
13922 Generates the @code{round} machine instruction which returns the
13923 floating-point argument rounded according to the current rounding mode
13924 set in the floating-point status word register.
13925 @end deftypefn
13927 @deftypefn {Built-in Function}  int __builtin_rx_sat (int)
13928 Generates the @code{sat} machine instruction which returns the
13929 saturated value of the argument.
13930 @end deftypefn
13932 @deftypefn {Built-in Function}  void __builtin_rx_setpsw (int)
13933 Generates the @code{setpsw} machine instruction to set the specified
13934 bit in the processor status word.
13935 @end deftypefn
13937 @deftypefn {Built-in Function}  void __builtin_rx_wait (void)
13938 Generates the @code{wait} machine instruction.
13939 @end deftypefn
13941 @node SPARC VIS Built-in Functions
13942 @subsection SPARC VIS Built-in Functions
13944 GCC supports SIMD operations on the SPARC using both the generic vector
13945 extensions (@pxref{Vector Extensions}) as well as built-in functions for
13946 the SPARC Visual Instruction Set (VIS).  When you use the @option{-mvis}
13947 switch, the VIS extension is exposed as the following built-in functions:
13949 @smallexample
13950 typedef int v1si __attribute__ ((vector_size (4)));
13951 typedef int v2si __attribute__ ((vector_size (8)));
13952 typedef short v4hi __attribute__ ((vector_size (8)));
13953 typedef short v2hi __attribute__ ((vector_size (4)));
13954 typedef unsigned char v8qi __attribute__ ((vector_size (8)));
13955 typedef unsigned char v4qi __attribute__ ((vector_size (4)));
13957 void __builtin_vis_write_gsr (int64_t);
13958 int64_t __builtin_vis_read_gsr (void);
13960 void * __builtin_vis_alignaddr (void *, long);
13961 void * __builtin_vis_alignaddrl (void *, long);
13962 int64_t __builtin_vis_faligndatadi (int64_t, int64_t);
13963 v2si __builtin_vis_faligndatav2si (v2si, v2si);
13964 v4hi __builtin_vis_faligndatav4hi (v4si, v4si);
13965 v8qi __builtin_vis_faligndatav8qi (v8qi, v8qi);
13967 v4hi __builtin_vis_fexpand (v4qi);
13969 v4hi __builtin_vis_fmul8x16 (v4qi, v4hi);
13970 v4hi __builtin_vis_fmul8x16au (v4qi, v2hi);
13971 v4hi __builtin_vis_fmul8x16al (v4qi, v2hi);
13972 v4hi __builtin_vis_fmul8sux16 (v8qi, v4hi);
13973 v4hi __builtin_vis_fmul8ulx16 (v8qi, v4hi);
13974 v2si __builtin_vis_fmuld8sux16 (v4qi, v2hi);
13975 v2si __builtin_vis_fmuld8ulx16 (v4qi, v2hi);
13977 v4qi __builtin_vis_fpack16 (v4hi);
13978 v8qi __builtin_vis_fpack32 (v2si, v8qi);
13979 v2hi __builtin_vis_fpackfix (v2si);
13980 v8qi __builtin_vis_fpmerge (v4qi, v4qi);
13982 int64_t __builtin_vis_pdist (v8qi, v8qi, int64_t);
13984 long __builtin_vis_edge8 (void *, void *);
13985 long __builtin_vis_edge8l (void *, void *);
13986 long __builtin_vis_edge16 (void *, void *);
13987 long __builtin_vis_edge16l (void *, void *);
13988 long __builtin_vis_edge32 (void *, void *);
13989 long __builtin_vis_edge32l (void *, void *);
13991 long __builtin_vis_fcmple16 (v4hi, v4hi);
13992 long __builtin_vis_fcmple32 (v2si, v2si);
13993 long __builtin_vis_fcmpne16 (v4hi, v4hi);
13994 long __builtin_vis_fcmpne32 (v2si, v2si);
13995 long __builtin_vis_fcmpgt16 (v4hi, v4hi);
13996 long __builtin_vis_fcmpgt32 (v2si, v2si);
13997 long __builtin_vis_fcmpeq16 (v4hi, v4hi);
13998 long __builtin_vis_fcmpeq32 (v2si, v2si);
14000 v4hi __builtin_vis_fpadd16 (v4hi, v4hi);
14001 v2hi __builtin_vis_fpadd16s (v2hi, v2hi);
14002 v2si __builtin_vis_fpadd32 (v2si, v2si);
14003 v1si __builtin_vis_fpadd32s (v1si, v1si);
14004 v4hi __builtin_vis_fpsub16 (v4hi, v4hi);
14005 v2hi __builtin_vis_fpsub16s (v2hi, v2hi);
14006 v2si __builtin_vis_fpsub32 (v2si, v2si);
14007 v1si __builtin_vis_fpsub32s (v1si, v1si);
14009 long __builtin_vis_array8 (long, long);
14010 long __builtin_vis_array16 (long, long);
14011 long __builtin_vis_array32 (long, long);
14012 @end smallexample
14014 When you use the @option{-mvis2} switch, the VIS version 2.0 built-in
14015 functions also become available:
14017 @smallexample
14018 long __builtin_vis_bmask (long, long);
14019 int64_t __builtin_vis_bshuffledi (int64_t, int64_t);
14020 v2si __builtin_vis_bshufflev2si (v2si, v2si);
14021 v4hi __builtin_vis_bshufflev2si (v4hi, v4hi);
14022 v8qi __builtin_vis_bshufflev2si (v8qi, v8qi);
14024 long __builtin_vis_edge8n (void *, void *);
14025 long __builtin_vis_edge8ln (void *, void *);
14026 long __builtin_vis_edge16n (void *, void *);
14027 long __builtin_vis_edge16ln (void *, void *);
14028 long __builtin_vis_edge32n (void *, void *);
14029 long __builtin_vis_edge32ln (void *, void *);
14030 @end smallexample
14032 When you use the @option{-mvis3} switch, the VIS version 3.0 built-in
14033 functions also become available:
14035 @smallexample
14036 void __builtin_vis_cmask8 (long);
14037 void __builtin_vis_cmask16 (long);
14038 void __builtin_vis_cmask32 (long);
14040 v4hi __builtin_vis_fchksm16 (v4hi, v4hi);
14042 v4hi __builtin_vis_fsll16 (v4hi, v4hi);
14043 v4hi __builtin_vis_fslas16 (v4hi, v4hi);
14044 v4hi __builtin_vis_fsrl16 (v4hi, v4hi);
14045 v4hi __builtin_vis_fsra16 (v4hi, v4hi);
14046 v2si __builtin_vis_fsll16 (v2si, v2si);
14047 v2si __builtin_vis_fslas16 (v2si, v2si);
14048 v2si __builtin_vis_fsrl16 (v2si, v2si);
14049 v2si __builtin_vis_fsra16 (v2si, v2si);
14051 long __builtin_vis_pdistn (v8qi, v8qi);
14053 v4hi __builtin_vis_fmean16 (v4hi, v4hi);
14055 int64_t __builtin_vis_fpadd64 (int64_t, int64_t);
14056 int64_t __builtin_vis_fpsub64 (int64_t, int64_t);
14058 v4hi __builtin_vis_fpadds16 (v4hi, v4hi);
14059 v2hi __builtin_vis_fpadds16s (v2hi, v2hi);
14060 v4hi __builtin_vis_fpsubs16 (v4hi, v4hi);
14061 v2hi __builtin_vis_fpsubs16s (v2hi, v2hi);
14062 v2si __builtin_vis_fpadds32 (v2si, v2si);
14063 v1si __builtin_vis_fpadds32s (v1si, v1si);
14064 v2si __builtin_vis_fpsubs32 (v2si, v2si);
14065 v1si __builtin_vis_fpsubs32s (v1si, v1si);
14067 long __builtin_vis_fucmple8 (v8qi, v8qi);
14068 long __builtin_vis_fucmpne8 (v8qi, v8qi);
14069 long __builtin_vis_fucmpgt8 (v8qi, v8qi);
14070 long __builtin_vis_fucmpeq8 (v8qi, v8qi);
14072 float __builtin_vis_fhadds (float, float);
14073 double __builtin_vis_fhaddd (double, double);
14074 float __builtin_vis_fhsubs (float, float);
14075 double __builtin_vis_fhsubd (double, double);
14076 float __builtin_vis_fnhadds (float, float);
14077 double __builtin_vis_fnhaddd (double, double);
14079 int64_t __builtin_vis_umulxhi (int64_t, int64_t);
14080 int64_t __builtin_vis_xmulx (int64_t, int64_t);
14081 int64_t __builtin_vis_xmulxhi (int64_t, int64_t);
14082 @end smallexample
14084 @node SPU Built-in Functions
14085 @subsection SPU Built-in Functions
14087 GCC provides extensions for the SPU processor as described in the
14088 Sony/Toshiba/IBM SPU Language Extensions Specification, which can be
14089 found at @uref{http://cell.scei.co.jp/} or
14090 @uref{http://www.ibm.com/developerworks/power/cell/}.  GCC's
14091 implementation differs in several ways.
14093 @itemize @bullet
14095 @item
14096 The optional extension of specifying vector constants in parentheses is
14097 not supported.
14099 @item
14100 A vector initializer requires no cast if the vector constant is of the
14101 same type as the variable it is initializing.
14103 @item
14104 If @code{signed} or @code{unsigned} is omitted, the signedness of the
14105 vector type is the default signedness of the base type.  The default
14106 varies depending on the operating system, so a portable program should
14107 always specify the signedness.
14109 @item
14110 By default, the keyword @code{__vector} is added. The macro
14111 @code{vector} is defined in @code{<spu_intrinsics.h>} and can be
14112 undefined.
14114 @item
14115 GCC allows using a @code{typedef} name as the type specifier for a
14116 vector type.
14118 @item
14119 For C, overloaded functions are implemented with macros so the following
14120 does not work:
14122 @smallexample
14123   spu_add ((vector signed int)@{1, 2, 3, 4@}, foo);
14124 @end smallexample
14126 @noindent
14127 Since @code{spu_add} is a macro, the vector constant in the example
14128 is treated as four separate arguments.  Wrap the entire argument in
14129 parentheses for this to work.
14131 @item
14132 The extended version of @code{__builtin_expect} is not supported.
14134 @end itemize
14136 @emph{Note:} Only the interface described in the aforementioned
14137 specification is supported. Internally, GCC uses built-in functions to
14138 implement the required functionality, but these are not supported and
14139 are subject to change without notice.
14141 @node TI C6X Built-in Functions
14142 @subsection TI C6X Built-in Functions
14144 GCC provides intrinsics to access certain instructions of the TI C6X
14145 processors.  These intrinsics, listed below, are available after
14146 inclusion of the @code{c6x_intrinsics.h} header file.  They map directly
14147 to C6X instructions.
14149 @smallexample
14151 int _sadd (int, int)
14152 int _ssub (int, int)
14153 int _sadd2 (int, int)
14154 int _ssub2 (int, int)
14155 long long _mpy2 (int, int)
14156 long long _smpy2 (int, int)
14157 int _add4 (int, int)
14158 int _sub4 (int, int)
14159 int _saddu4 (int, int)
14161 int _smpy (int, int)
14162 int _smpyh (int, int)
14163 int _smpyhl (int, int)
14164 int _smpylh (int, int)
14166 int _sshl (int, int)
14167 int _subc (int, int)
14169 int _avg2 (int, int)
14170 int _avgu4 (int, int)
14172 int _clrr (int, int)
14173 int _extr (int, int)
14174 int _extru (int, int)
14175 int _abs (int)
14176 int _abs2 (int)
14178 @end smallexample
14180 @node TILE-Gx Built-in Functions
14181 @subsection TILE-Gx Built-in Functions
14183 GCC provides intrinsics to access every instruction of the TILE-Gx
14184 processor.  The intrinsics are of the form:
14186 @smallexample
14188 unsigned long long __insn_@var{op} (...)
14190 @end smallexample
14192 Where @var{op} is the name of the instruction.  Refer to the ISA manual
14193 for the complete list of instructions.
14195 GCC also provides intrinsics to directly access the network registers.
14196 The intrinsics are:
14198 @smallexample
14200 unsigned long long __tile_idn0_receive (void)
14201 unsigned long long __tile_idn1_receive (void)
14202 unsigned long long __tile_udn0_receive (void)
14203 unsigned long long __tile_udn1_receive (void)
14204 unsigned long long __tile_udn2_receive (void)
14205 unsigned long long __tile_udn3_receive (void)
14206 void __tile_idn_send (unsigned long long)
14207 void __tile_udn_send (unsigned long long)
14209 @end smallexample
14211 The intrinsic @code{void __tile_network_barrier (void)} is used to
14212 guarantee that no network operations before it are reordered with
14213 those after it.
14215 @node TILEPro Built-in Functions
14216 @subsection TILEPro Built-in Functions
14218 GCC provides intrinsics to access every instruction of the TILEPro
14219 processor.  The intrinsics are of the form:
14221 @smallexample
14223 unsigned __insn_@var{op} (...)
14225 @end smallexample
14227 @noindent
14228 where @var{op} is the name of the instruction.  Refer to the ISA manual
14229 for the complete list of instructions.
14231 GCC also provides intrinsics to directly access the network registers.
14232 The intrinsics are:
14234 @smallexample
14236 unsigned __tile_idn0_receive (void)
14237 unsigned __tile_idn1_receive (void)
14238 unsigned __tile_sn_receive (void)
14239 unsigned __tile_udn0_receive (void)
14240 unsigned __tile_udn1_receive (void)
14241 unsigned __tile_udn2_receive (void)
14242 unsigned __tile_udn3_receive (void)
14243 void __tile_idn_send (unsigned)
14244 void __tile_sn_send (unsigned)
14245 void __tile_udn_send (unsigned)
14247 @end smallexample
14249 The intrinsic @code{void __tile_network_barrier (void)} is used to
14250 guarantee that no network operations before it are reordered with
14251 those after it.
14253 @node Target Format Checks
14254 @section Format Checks Specific to Particular Target Machines
14256 For some target machines, GCC supports additional options to the
14257 format attribute
14258 (@pxref{Function Attributes,,Declaring Attributes of Functions}).
14260 @menu
14261 * Solaris Format Checks::
14262 * Darwin Format Checks::
14263 @end menu
14265 @node Solaris Format Checks
14266 @subsection Solaris Format Checks
14268 Solaris targets support the @code{cmn_err} (or @code{__cmn_err__}) format
14269 check.  @code{cmn_err} accepts a subset of the standard @code{printf}
14270 conversions, and the two-argument @code{%b} conversion for displaying
14271 bit-fields.  See the Solaris man page for @code{cmn_err} for more information.
14273 @node Darwin Format Checks
14274 @subsection Darwin Format Checks
14276 Darwin targets support the @code{CFString} (or @code{__CFString__}) in the format
14277 attribute context.  Declarations made with such attribution are parsed for correct syntax
14278 and format argument types.  However, parsing of the format string itself is currently undefined
14279 and is not carried out by this version of the compiler.
14281 Additionally, @code{CFStringRefs} (defined by the @code{CoreFoundation} headers) may
14282 also be used as format arguments.  Note that the relevant headers are only likely to be
14283 available on Darwin (OSX) installations.  On such installations, the XCode and system
14284 documentation provide descriptions of @code{CFString}, @code{CFStringRefs} and
14285 associated functions.
14287 @node Pragmas
14288 @section Pragmas Accepted by GCC
14289 @cindex pragmas
14290 @cindex @code{#pragma}
14292 GCC supports several types of pragmas, primarily in order to compile
14293 code originally written for other compilers.  Note that in general
14294 we do not recommend the use of pragmas; @xref{Function Attributes},
14295 for further explanation.
14297 @menu
14298 * ARM Pragmas::
14299 * M32C Pragmas::
14300 * MeP Pragmas::
14301 * RS/6000 and PowerPC Pragmas::
14302 * Darwin Pragmas::
14303 * Solaris Pragmas::
14304 * Symbol-Renaming Pragmas::
14305 * Structure-Packing Pragmas::
14306 * Weak Pragmas::
14307 * Diagnostic Pragmas::
14308 * Visibility Pragmas::
14309 * Push/Pop Macro Pragmas::
14310 * Function Specific Option Pragmas::
14311 @end menu
14313 @node ARM Pragmas
14314 @subsection ARM Pragmas
14316 The ARM target defines pragmas for controlling the default addition of
14317 @code{long_call} and @code{short_call} attributes to functions.
14318 @xref{Function Attributes}, for information about the effects of these
14319 attributes.
14321 @table @code
14322 @item long_calls
14323 @cindex pragma, long_calls
14324 Set all subsequent functions to have the @code{long_call} attribute.
14326 @item no_long_calls
14327 @cindex pragma, no_long_calls
14328 Set all subsequent functions to have the @code{short_call} attribute.
14330 @item long_calls_off
14331 @cindex pragma, long_calls_off
14332 Do not affect the @code{long_call} or @code{short_call} attributes of
14333 subsequent functions.
14334 @end table
14336 @node M32C Pragmas
14337 @subsection M32C Pragmas
14339 @table @code
14340 @item GCC memregs @var{number}
14341 @cindex pragma, memregs
14342 Overrides the command-line option @code{-memregs=} for the current
14343 file.  Use with care!  This pragma must be before any function in the
14344 file, and mixing different memregs values in different objects may
14345 make them incompatible.  This pragma is useful when a
14346 performance-critical function uses a memreg for temporary values,
14347 as it may allow you to reduce the number of memregs used.
14349 @item ADDRESS @var{name} @var{address}
14350 @cindex pragma, address
14351 For any declared symbols matching @var{name}, this does three things
14352 to that symbol: it forces the symbol to be located at the given
14353 address (a number), it forces the symbol to be volatile, and it
14354 changes the symbol's scope to be static.  This pragma exists for
14355 compatibility with other compilers, but note that the common
14356 @code{1234H} numeric syntax is not supported (use @code{0x1234}
14357 instead).  Example:
14359 @smallexample
14360 #pragma ADDRESS port3 0x103
14361 char port3;
14362 @end smallexample
14364 @end table
14366 @node MeP Pragmas
14367 @subsection MeP Pragmas
14369 @table @code
14371 @item custom io_volatile (on|off)
14372 @cindex pragma, custom io_volatile
14373 Overrides the command-line option @code{-mio-volatile} for the current
14374 file.  Note that for compatibility with future GCC releases, this
14375 option should only be used once before any @code{io} variables in each
14376 file.
14378 @item GCC coprocessor available @var{registers}
14379 @cindex pragma, coprocessor available
14380 Specifies which coprocessor registers are available to the register
14381 allocator.  @var{registers} may be a single register, register range
14382 separated by ellipses, or comma-separated list of those.  Example:
14384 @smallexample
14385 #pragma GCC coprocessor available $c0...$c10, $c28
14386 @end smallexample
14388 @item GCC coprocessor call_saved @var{registers}
14389 @cindex pragma, coprocessor call_saved
14390 Specifies which coprocessor registers are to be saved and restored by
14391 any function using them.  @var{registers} may be a single register,
14392 register range separated by ellipses, or comma-separated list of
14393 those.  Example:
14395 @smallexample
14396 #pragma GCC coprocessor call_saved $c4...$c6, $c31
14397 @end smallexample
14399 @item GCC coprocessor subclass '(A|B|C|D)' = @var{registers}
14400 @cindex pragma, coprocessor subclass
14401 Creates and defines a register class.  These register classes can be
14402 used by inline @code{asm} constructs.  @var{registers} may be a single
14403 register, register range separated by ellipses, or comma-separated
14404 list of those.  Example:
14406 @smallexample
14407 #pragma GCC coprocessor subclass 'B' = $c2, $c4, $c6
14409 asm ("cpfoo %0" : "=B" (x));
14410 @end smallexample
14412 @item GCC disinterrupt @var{name} , @var{name} @dots{}
14413 @cindex pragma, disinterrupt
14414 For the named functions, the compiler adds code to disable interrupts
14415 for the duration of those functions.  If any functions so named 
14416 are not encountered in the source, a warning is emitted that the pragma is
14417 not used.  Examples:
14419 @smallexample
14420 #pragma disinterrupt foo
14421 #pragma disinterrupt bar, grill
14422 int foo () @{ @dots{} @}
14423 @end smallexample
14425 @item GCC call @var{name} , @var{name} @dots{}
14426 @cindex pragma, call
14427 For the named functions, the compiler always uses a register-indirect
14428 call model when calling the named functions.  Examples:
14430 @smallexample
14431 extern int foo ();
14432 #pragma call foo
14433 @end smallexample
14435 @end table
14437 @node RS/6000 and PowerPC Pragmas
14438 @subsection RS/6000 and PowerPC Pragmas
14440 The RS/6000 and PowerPC targets define one pragma for controlling
14441 whether or not the @code{longcall} attribute is added to function
14442 declarations by default.  This pragma overrides the @option{-mlongcall}
14443 option, but not the @code{longcall} and @code{shortcall} attributes.
14444 @xref{RS/6000 and PowerPC Options}, for more information about when long
14445 calls are and are not necessary.
14447 @table @code
14448 @item longcall (1)
14449 @cindex pragma, longcall
14450 Apply the @code{longcall} attribute to all subsequent function
14451 declarations.
14453 @item longcall (0)
14454 Do not apply the @code{longcall} attribute to subsequent function
14455 declarations.
14456 @end table
14458 @c Describe h8300 pragmas here.
14459 @c Describe sh pragmas here.
14460 @c Describe v850 pragmas here.
14462 @node Darwin Pragmas
14463 @subsection Darwin Pragmas
14465 The following pragmas are available for all architectures running the
14466 Darwin operating system.  These are useful for compatibility with other
14467 Mac OS compilers.
14469 @table @code
14470 @item mark @var{tokens}@dots{}
14471 @cindex pragma, mark
14472 This pragma is accepted, but has no effect.
14474 @item options align=@var{alignment}
14475 @cindex pragma, options align
14476 This pragma sets the alignment of fields in structures.  The values of
14477 @var{alignment} may be @code{mac68k}, to emulate m68k alignment, or
14478 @code{power}, to emulate PowerPC alignment.  Uses of this pragma nest
14479 properly; to restore the previous setting, use @code{reset} for the
14480 @var{alignment}.
14482 @item segment @var{tokens}@dots{}
14483 @cindex pragma, segment
14484 This pragma is accepted, but has no effect.
14486 @item unused (@var{var} [, @var{var}]@dots{})
14487 @cindex pragma, unused
14488 This pragma declares variables to be possibly unused.  GCC does not
14489 produce warnings for the listed variables.  The effect is similar to
14490 that of the @code{unused} attribute, except that this pragma may appear
14491 anywhere within the variables' scopes.
14492 @end table
14494 @node Solaris Pragmas
14495 @subsection Solaris Pragmas
14497 The Solaris target supports @code{#pragma redefine_extname}
14498 (@pxref{Symbol-Renaming Pragmas}).  It also supports additional
14499 @code{#pragma} directives for compatibility with the system compiler.
14501 @table @code
14502 @item align @var{alignment} (@var{variable} [, @var{variable}]...)
14503 @cindex pragma, align
14505 Increase the minimum alignment of each @var{variable} to @var{alignment}.
14506 This is the same as GCC's @code{aligned} attribute @pxref{Variable
14507 Attributes}).  Macro expansion occurs on the arguments to this pragma
14508 when compiling C and Objective-C@.  It does not currently occur when
14509 compiling C++, but this is a bug which may be fixed in a future
14510 release.
14512 @item fini (@var{function} [, @var{function}]...)
14513 @cindex pragma, fini
14515 This pragma causes each listed @var{function} to be called after
14516 main, or during shared module unloading, by adding a call to the
14517 @code{.fini} section.
14519 @item init (@var{function} [, @var{function}]...)
14520 @cindex pragma, init
14522 This pragma causes each listed @var{function} to be called during
14523 initialization (before @code{main}) or during shared module loading, by
14524 adding a call to the @code{.init} section.
14526 @end table
14528 @node Symbol-Renaming Pragmas
14529 @subsection Symbol-Renaming Pragmas
14531 For compatibility with the Solaris system headers, GCC
14532 supports two @code{#pragma} directives that change the name used in
14533 assembly for a given declaration. To get this effect
14534 on all platforms supported by GCC, use the asm labels extension (@pxref{Asm
14535 Labels}).
14537 @table @code
14538 @item redefine_extname @var{oldname} @var{newname}
14539 @cindex pragma, redefine_extname
14541 This pragma gives the C function @var{oldname} the assembly symbol
14542 @var{newname}.  The preprocessor macro @code{__PRAGMA_REDEFINE_EXTNAME}
14543 is defined if this pragma is available (currently on all platforms).
14544 @end table
14546 This pragma and the asm labels extension interact in a complicated
14547 manner.  Here are some corner cases you may want to be aware of.
14549 @enumerate
14550 @item Both pragmas silently apply only to declarations with external
14551 linkage.  Asm labels do not have this restriction.
14553 @item In C++, both pragmas silently apply only to declarations with
14554 ``C'' linkage.  Again, asm labels do not have this restriction.
14556 @item If any of the three ways of changing the assembly name of a
14557 declaration is applied to a declaration whose assembly name has
14558 already been determined (either by a previous use of one of these
14559 features, or because the compiler needed the assembly name in order to
14560 generate code), and the new name is different, a warning issues and
14561 the name does not change.
14563 @item The @var{oldname} used by @code{#pragma redefine_extname} is
14564 always the C-language name.
14565 @end enumerate
14567 @node Structure-Packing Pragmas
14568 @subsection Structure-Packing Pragmas
14570 For compatibility with Microsoft Windows compilers, GCC supports a
14571 set of @code{#pragma} directives that change the maximum alignment of
14572 members of structures (other than zero-width bit-fields), unions, and
14573 classes subsequently defined. The @var{n} value below always is required
14574 to be a small power of two and specifies the new alignment in bytes.
14576 @enumerate
14577 @item @code{#pragma pack(@var{n})} simply sets the new alignment.
14578 @item @code{#pragma pack()} sets the alignment to the one that was in
14579 effect when compilation started (see also command-line option
14580 @option{-fpack-struct[=@var{n}]} @pxref{Code Gen Options}).
14581 @item @code{#pragma pack(push[,@var{n}])} pushes the current alignment
14582 setting on an internal stack and then optionally sets the new alignment.
14583 @item @code{#pragma pack(pop)} restores the alignment setting to the one
14584 saved at the top of the internal stack (and removes that stack entry).
14585 Note that @code{#pragma pack([@var{n}])} does not influence this internal
14586 stack; thus it is possible to have @code{#pragma pack(push)} followed by
14587 multiple @code{#pragma pack(@var{n})} instances and finalized by a single
14588 @code{#pragma pack(pop)}.
14589 @end enumerate
14591 Some targets, e.g.@: i386 and PowerPC, support the @code{ms_struct}
14592 @code{#pragma} which lays out a structure as the documented
14593 @code{__attribute__ ((ms_struct))}.
14594 @enumerate
14595 @item @code{#pragma ms_struct on} turns on the layout for structures
14596 declared.
14597 @item @code{#pragma ms_struct off} turns off the layout for structures
14598 declared.
14599 @item @code{#pragma ms_struct reset} goes back to the default layout.
14600 @end enumerate
14602 @node Weak Pragmas
14603 @subsection Weak Pragmas
14605 For compatibility with SVR4, GCC supports a set of @code{#pragma}
14606 directives for declaring symbols to be weak, and defining weak
14607 aliases.
14609 @table @code
14610 @item #pragma weak @var{symbol}
14611 @cindex pragma, weak
14612 This pragma declares @var{symbol} to be weak, as if the declaration
14613 had the attribute of the same name.  The pragma may appear before
14614 or after the declaration of @var{symbol}.  It is not an error for
14615 @var{symbol} to never be defined at all.
14617 @item #pragma weak @var{symbol1} = @var{symbol2}
14618 This pragma declares @var{symbol1} to be a weak alias of @var{symbol2}.
14619 It is an error if @var{symbol2} is not defined in the current
14620 translation unit.
14621 @end table
14623 @node Diagnostic Pragmas
14624 @subsection Diagnostic Pragmas
14626 GCC allows the user to selectively enable or disable certain types of
14627 diagnostics, and change the kind of the diagnostic.  For example, a
14628 project's policy might require that all sources compile with
14629 @option{-Werror} but certain files might have exceptions allowing
14630 specific types of warnings.  Or, a project might selectively enable
14631 diagnostics and treat them as errors depending on which preprocessor
14632 macros are defined.
14634 @table @code
14635 @item #pragma GCC diagnostic @var{kind} @var{option}
14636 @cindex pragma, diagnostic
14638 Modifies the disposition of a diagnostic.  Note that not all
14639 diagnostics are modifiable; at the moment only warnings (normally
14640 controlled by @samp{-W@dots{}}) can be controlled, and not all of them.
14641 Use @option{-fdiagnostics-show-option} to determine which diagnostics
14642 are controllable and which option controls them.
14644 @var{kind} is @samp{error} to treat this diagnostic as an error,
14645 @samp{warning} to treat it like a warning (even if @option{-Werror} is
14646 in effect), or @samp{ignored} if the diagnostic is to be ignored.
14647 @var{option} is a double quoted string that matches the command-line
14648 option.
14650 @smallexample
14651 #pragma GCC diagnostic warning "-Wformat"
14652 #pragma GCC diagnostic error "-Wformat"
14653 #pragma GCC diagnostic ignored "-Wformat"
14654 @end smallexample
14656 Note that these pragmas override any command-line options.  GCC keeps
14657 track of the location of each pragma, and issues diagnostics according
14658 to the state as of that point in the source file.  Thus, pragmas occurring
14659 after a line do not affect diagnostics caused by that line.
14661 @item #pragma GCC diagnostic push
14662 @itemx #pragma GCC diagnostic pop
14664 Causes GCC to remember the state of the diagnostics as of each
14665 @code{push}, and restore to that point at each @code{pop}.  If a
14666 @code{pop} has no matching @code{push}, the command-line options are
14667 restored.
14669 @smallexample
14670 #pragma GCC diagnostic error "-Wuninitialized"
14671   foo(a);                       /* error is given for this one */
14672 #pragma GCC diagnostic push
14673 #pragma GCC diagnostic ignored "-Wuninitialized"
14674   foo(b);                       /* no diagnostic for this one */
14675 #pragma GCC diagnostic pop
14676   foo(c);                       /* error is given for this one */
14677 #pragma GCC diagnostic pop
14678   foo(d);                       /* depends on command-line options */
14679 @end smallexample
14681 @end table
14683 GCC also offers a simple mechanism for printing messages during
14684 compilation.
14686 @table @code
14687 @item #pragma message @var{string}
14688 @cindex pragma, diagnostic
14690 Prints @var{string} as a compiler message on compilation.  The message
14691 is informational only, and is neither a compilation warning nor an error.
14693 @smallexample
14694 #pragma message "Compiling " __FILE__ "..."
14695 @end smallexample
14697 @var{string} may be parenthesized, and is printed with location
14698 information.  For example,
14700 @smallexample
14701 #define DO_PRAGMA(x) _Pragma (#x)
14702 #define TODO(x) DO_PRAGMA(message ("TODO - " #x))
14704 TODO(Remember to fix this)
14705 @end smallexample
14707 @noindent
14708 prints @samp{/tmp/file.c:4: note: #pragma message:
14709 TODO - Remember to fix this}.
14711 @end table
14713 @node Visibility Pragmas
14714 @subsection Visibility Pragmas
14716 @table @code
14717 @item #pragma GCC visibility push(@var{visibility})
14718 @itemx #pragma GCC visibility pop
14719 @cindex pragma, visibility
14721 This pragma allows the user to set the visibility for multiple
14722 declarations without having to give each a visibility attribute
14723 @xref{Function Attributes}, for more information about visibility and
14724 the attribute syntax.
14726 In C++, @samp{#pragma GCC visibility} affects only namespace-scope
14727 declarations.  Class members and template specializations are not
14728 affected; if you want to override the visibility for a particular
14729 member or instantiation, you must use an attribute.
14731 @end table
14734 @node Push/Pop Macro Pragmas
14735 @subsection Push/Pop Macro Pragmas
14737 For compatibility with Microsoft Windows compilers, GCC supports
14738 @samp{#pragma push_macro(@var{"macro_name"})}
14739 and @samp{#pragma pop_macro(@var{"macro_name"})}.
14741 @table @code
14742 @item #pragma push_macro(@var{"macro_name"})
14743 @cindex pragma, push_macro
14744 This pragma saves the value of the macro named as @var{macro_name} to
14745 the top of the stack for this macro.
14747 @item #pragma pop_macro(@var{"macro_name"})
14748 @cindex pragma, pop_macro
14749 This pragma sets the value of the macro named as @var{macro_name} to
14750 the value on top of the stack for this macro. If the stack for
14751 @var{macro_name} is empty, the value of the macro remains unchanged.
14752 @end table
14754 For example:
14756 @smallexample
14757 #define X  1
14758 #pragma push_macro("X")
14759 #undef X
14760 #define X -1
14761 #pragma pop_macro("X")
14762 int x [X];
14763 @end smallexample
14765 @noindent
14766 In this example, the definition of X as 1 is saved by @code{#pragma
14767 push_macro} and restored by @code{#pragma pop_macro}.
14769 @node Function Specific Option Pragmas
14770 @subsection Function Specific Option Pragmas
14772 @table @code
14773 @item #pragma GCC target (@var{"string"}...)
14774 @cindex pragma GCC target
14776 This pragma allows you to set target specific options for functions
14777 defined later in the source file.  One or more strings can be
14778 specified.  Each function that is defined after this point is as
14779 if @code{attribute((target("STRING")))} was specified for that
14780 function.  The parenthesis around the options is optional.
14781 @xref{Function Attributes}, for more information about the
14782 @code{target} attribute and the attribute syntax.
14784 The @code{#pragma GCC target} attribute is not implemented in GCC versions earlier
14785 than 4.4 for the i386/x86_64 and 4.6 for the PowerPC back ends.  At
14786 present, it is not implemented for other back ends.
14787 @end table
14789 @table @code
14790 @item #pragma GCC optimize (@var{"string"}...)
14791 @cindex pragma GCC optimize
14793 This pragma allows you to set global optimization options for functions
14794 defined later in the source file.  One or more strings can be
14795 specified.  Each function that is defined after this point is as
14796 if @code{attribute((optimize("STRING")))} was specified for that
14797 function.  The parenthesis around the options is optional.
14798 @xref{Function Attributes}, for more information about the
14799 @code{optimize} attribute and the attribute syntax.
14801 The @samp{#pragma GCC optimize} pragma is not implemented in GCC
14802 versions earlier than 4.4.
14803 @end table
14805 @table @code
14806 @item #pragma GCC push_options
14807 @itemx #pragma GCC pop_options
14808 @cindex pragma GCC push_options
14809 @cindex pragma GCC pop_options
14811 These pragmas maintain a stack of the current target and optimization
14812 options.  It is intended for include files where you temporarily want
14813 to switch to using a different @samp{#pragma GCC target} or
14814 @samp{#pragma GCC optimize} and then to pop back to the previous
14815 options.
14817 The @samp{#pragma GCC push_options} and @samp{#pragma GCC pop_options}
14818 pragmas are not implemented in GCC versions earlier than 4.4.
14819 @end table
14821 @table @code
14822 @item #pragma GCC reset_options
14823 @cindex pragma GCC reset_options
14825 This pragma clears the current @code{#pragma GCC target} and
14826 @code{#pragma GCC optimize} to use the default switches as specified
14827 on the command line.
14829 The @samp{#pragma GCC reset_options} pragma is not implemented in GCC
14830 versions earlier than 4.4.
14831 @end table
14833 @node Unnamed Fields
14834 @section Unnamed struct/union fields within structs/unions
14835 @cindex @code{struct}
14836 @cindex @code{union}
14838 As permitted by ISO C11 and for compatibility with other compilers,
14839 GCC allows you to define
14840 a structure or union that contains, as fields, structures and unions
14841 without names.  For example:
14843 @smallexample
14844 struct @{
14845   int a;
14846   union @{
14847     int b;
14848     float c;
14849   @};
14850   int d;
14851 @} foo;
14852 @end smallexample
14854 @noindent
14855 In this example, you are able to access members of the unnamed
14856 union with code like @samp{foo.b}.  Note that only unnamed structs and
14857 unions are allowed, you may not have, for example, an unnamed
14858 @code{int}.
14860 You must never create such structures that cause ambiguous field definitions.
14861 For example, in this structure:
14863 @smallexample
14864 struct @{
14865   int a;
14866   struct @{
14867     int a;
14868   @};
14869 @} foo;
14870 @end smallexample
14872 @noindent
14873 it is ambiguous which @code{a} is being referred to with @samp{foo.a}.
14874 The compiler gives errors for such constructs.
14876 @opindex fms-extensions
14877 Unless @option{-fms-extensions} is used, the unnamed field must be a
14878 structure or union definition without a tag (for example, @samp{struct
14879 @{ int a; @};}).  If @option{-fms-extensions} is used, the field may
14880 also be a definition with a tag such as @samp{struct foo @{ int a;
14881 @};}, a reference to a previously defined structure or union such as
14882 @samp{struct foo;}, or a reference to a @code{typedef} name for a
14883 previously defined structure or union type.
14885 @opindex fplan9-extensions
14886 The option @option{-fplan9-extensions} enables
14887 @option{-fms-extensions} as well as two other extensions.  First, a
14888 pointer to a structure is automatically converted to a pointer to an
14889 anonymous field for assignments and function calls.  For example:
14891 @smallexample
14892 struct s1 @{ int a; @};
14893 struct s2 @{ struct s1; @};
14894 extern void f1 (struct s1 *);
14895 void f2 (struct s2 *p) @{ f1 (p); @}
14896 @end smallexample
14898 @noindent
14899 In the call to @code{f1} inside @code{f2}, the pointer @code{p} is
14900 converted into a pointer to the anonymous field.
14902 Second, when the type of an anonymous field is a @code{typedef} for a
14903 @code{struct} or @code{union}, code may refer to the field using the
14904 name of the @code{typedef}.
14906 @smallexample
14907 typedef struct @{ int a; @} s1;
14908 struct s2 @{ s1; @};
14909 s1 f1 (struct s2 *p) @{ return p->s1; @}
14910 @end smallexample
14912 These usages are only permitted when they are not ambiguous.
14914 @node Thread-Local
14915 @section Thread-Local Storage
14916 @cindex Thread-Local Storage
14917 @cindex @acronym{TLS}
14918 @cindex @code{__thread}
14920 Thread-local storage (@acronym{TLS}) is a mechanism by which variables
14921 are allocated such that there is one instance of the variable per extant
14922 thread.  The runtime model GCC uses to implement this originates
14923 in the IA-64 processor-specific ABI, but has since been migrated
14924 to other processors as well.  It requires significant support from
14925 the linker (@command{ld}), dynamic linker (@command{ld.so}), and
14926 system libraries (@file{libc.so} and @file{libpthread.so}), so it
14927 is not available everywhere.
14929 At the user level, the extension is visible with a new storage
14930 class keyword: @code{__thread}.  For example:
14932 @smallexample
14933 __thread int i;
14934 extern __thread struct state s;
14935 static __thread char *p;
14936 @end smallexample
14938 The @code{__thread} specifier may be used alone, with the @code{extern}
14939 or @code{static} specifiers, but with no other storage class specifier.
14940 When used with @code{extern} or @code{static}, @code{__thread} must appear
14941 immediately after the other storage class specifier.
14943 The @code{__thread} specifier may be applied to any global, file-scoped
14944 static, function-scoped static, or static data member of a class.  It may
14945 not be applied to block-scoped automatic or non-static data member.
14947 When the address-of operator is applied to a thread-local variable, it is
14948 evaluated at run time and returns the address of the current thread's
14949 instance of that variable.  An address so obtained may be used by any
14950 thread.  When a thread terminates, any pointers to thread-local variables
14951 in that thread become invalid.
14953 No static initialization may refer to the address of a thread-local variable.
14955 In C++, if an initializer is present for a thread-local variable, it must
14956 be a @var{constant-expression}, as defined in 5.19.2 of the ANSI/ISO C++
14957 standard.
14959 See @uref{http://www.akkadia.org/drepper/tls.pdf,
14960 ELF Handling For Thread-Local Storage} for a detailed explanation of
14961 the four thread-local storage addressing models, and how the runtime
14962 is expected to function.
14964 @menu
14965 * C99 Thread-Local Edits::
14966 * C++98 Thread-Local Edits::
14967 @end menu
14969 @node C99 Thread-Local Edits
14970 @subsection ISO/IEC 9899:1999 Edits for Thread-Local Storage
14972 The following are a set of changes to ISO/IEC 9899:1999 (aka C99)
14973 that document the exact semantics of the language extension.
14975 @itemize @bullet
14976 @item
14977 @cite{5.1.2  Execution environments}
14979 Add new text after paragraph 1
14981 @quotation
14982 Within either execution environment, a @dfn{thread} is a flow of
14983 control within a program.  It is implementation defined whether
14984 or not there may be more than one thread associated with a program.
14985 It is implementation defined how threads beyond the first are
14986 created, the name and type of the function called at thread
14987 startup, and how threads may be terminated.  However, objects
14988 with thread storage duration shall be initialized before thread
14989 startup.
14990 @end quotation
14992 @item
14993 @cite{6.2.4  Storage durations of objects}
14995 Add new text before paragraph 3
14997 @quotation
14998 An object whose identifier is declared with the storage-class
14999 specifier @w{@code{__thread}} has @dfn{thread storage duration}.
15000 Its lifetime is the entire execution of the thread, and its
15001 stored value is initialized only once, prior to thread startup.
15002 @end quotation
15004 @item
15005 @cite{6.4.1  Keywords}
15007 Add @code{__thread}.
15009 @item
15010 @cite{6.7.1  Storage-class specifiers}
15012 Add @code{__thread} to the list of storage class specifiers in
15013 paragraph 1.
15015 Change paragraph 2 to
15017 @quotation
15018 With the exception of @code{__thread}, at most one storage-class
15019 specifier may be given [@dots{}].  The @code{__thread} specifier may
15020 be used alone, or immediately following @code{extern} or
15021 @code{static}.
15022 @end quotation
15024 Add new text after paragraph 6
15026 @quotation
15027 The declaration of an identifier for a variable that has
15028 block scope that specifies @code{__thread} shall also
15029 specify either @code{extern} or @code{static}.
15031 The @code{__thread} specifier shall be used only with
15032 variables.
15033 @end quotation
15034 @end itemize
15036 @node C++98 Thread-Local Edits
15037 @subsection ISO/IEC 14882:1998 Edits for Thread-Local Storage
15039 The following are a set of changes to ISO/IEC 14882:1998 (aka C++98)
15040 that document the exact semantics of the language extension.
15042 @itemize @bullet
15043 @item
15044 @b{[intro.execution]}
15046 New text after paragraph 4
15048 @quotation
15049 A @dfn{thread} is a flow of control within the abstract machine.
15050 It is implementation defined whether or not there may be more than
15051 one thread.
15052 @end quotation
15054 New text after paragraph 7
15056 @quotation
15057 It is unspecified whether additional action must be taken to
15058 ensure when and whether side effects are visible to other threads.
15059 @end quotation
15061 @item
15062 @b{[lex.key]}
15064 Add @code{__thread}.
15066 @item
15067 @b{[basic.start.main]}
15069 Add after paragraph 5
15071 @quotation
15072 The thread that begins execution at the @code{main} function is called
15073 the @dfn{main thread}.  It is implementation defined how functions
15074 beginning threads other than the main thread are designated or typed.
15075 A function so designated, as well as the @code{main} function, is called
15076 a @dfn{thread startup function}.  It is implementation defined what
15077 happens if a thread startup function returns.  It is implementation
15078 defined what happens to other threads when any thread calls @code{exit}.
15079 @end quotation
15081 @item
15082 @b{[basic.start.init]}
15084 Add after paragraph 4
15086 @quotation
15087 The storage for an object of thread storage duration shall be
15088 statically initialized before the first statement of the thread startup
15089 function.  An object of thread storage duration shall not require
15090 dynamic initialization.
15091 @end quotation
15093 @item
15094 @b{[basic.start.term]}
15096 Add after paragraph 3
15098 @quotation
15099 The type of an object with thread storage duration shall not have a
15100 non-trivial destructor, nor shall it be an array type whose elements
15101 (directly or indirectly) have non-trivial destructors.
15102 @end quotation
15104 @item
15105 @b{[basic.stc]}
15107 Add ``thread storage duration'' to the list in paragraph 1.
15109 Change paragraph 2
15111 @quotation
15112 Thread, static, and automatic storage durations are associated with
15113 objects introduced by declarations [@dots{}].
15114 @end quotation
15116 Add @code{__thread} to the list of specifiers in paragraph 3.
15118 @item
15119 @b{[basic.stc.thread]}
15121 New section before @b{[basic.stc.static]}
15123 @quotation
15124 The keyword @code{__thread} applied to a non-local object gives the
15125 object thread storage duration.
15127 A local variable or class data member declared both @code{static}
15128 and @code{__thread} gives the variable or member thread storage
15129 duration.
15130 @end quotation
15132 @item
15133 @b{[basic.stc.static]}
15135 Change paragraph 1
15137 @quotation
15138 All objects that have neither thread storage duration, dynamic
15139 storage duration nor are local [@dots{}].
15140 @end quotation
15142 @item
15143 @b{[dcl.stc]}
15145 Add @code{__thread} to the list in paragraph 1.
15147 Change paragraph 1
15149 @quotation
15150 With the exception of @code{__thread}, at most one
15151 @var{storage-class-specifier} shall appear in a given
15152 @var{decl-specifier-seq}.  The @code{__thread} specifier may
15153 be used alone, or immediately following the @code{extern} or
15154 @code{static} specifiers.  [@dots{}]
15155 @end quotation
15157 Add after paragraph 5
15159 @quotation
15160 The @code{__thread} specifier can be applied only to the names of objects
15161 and to anonymous unions.
15162 @end quotation
15164 @item
15165 @b{[class.mem]}
15167 Add after paragraph 6
15169 @quotation
15170 Non-@code{static} members shall not be @code{__thread}.
15171 @end quotation
15172 @end itemize
15174 @node Binary constants
15175 @section Binary constants using the @samp{0b} prefix
15176 @cindex Binary constants using the @samp{0b} prefix
15178 Integer constants can be written as binary constants, consisting of a
15179 sequence of @samp{0} and @samp{1} digits, prefixed by @samp{0b} or
15180 @samp{0B}.  This is particularly useful in environments that operate a
15181 lot on the bit level (like microcontrollers).
15183 The following statements are identical:
15185 @smallexample
15186 i =       42;
15187 i =     0x2a;
15188 i =      052;
15189 i = 0b101010;
15190 @end smallexample
15192 The type of these constants follows the same rules as for octal or
15193 hexadecimal integer constants, so suffixes like @samp{L} or @samp{UL}
15194 can be applied.
15196 @node C++ Extensions
15197 @chapter Extensions to the C++ Language
15198 @cindex extensions, C++ language
15199 @cindex C++ language extensions
15201 The GNU compiler provides these extensions to the C++ language (and you
15202 can also use most of the C language extensions in your C++ programs).  If you
15203 want to write code that checks whether these features are available, you can
15204 test for the GNU compiler the same way as for C programs: check for a
15205 predefined macro @code{__GNUC__}.  You can also use @code{__GNUG__} to
15206 test specifically for GNU C++ (@pxref{Common Predefined Macros,,
15207 Predefined Macros,cpp,The GNU C Preprocessor}).
15209 @menu
15210 * C++ Volatiles::       What constitutes an access to a volatile object.
15211 * Restricted Pointers:: C99 restricted pointers and references.
15212 * Vague Linkage::       Where G++ puts inlines, vtables and such.
15213 * C++ Interface::       You can use a single C++ header file for both
15214                         declarations and definitions.
15215 * Template Instantiation:: Methods for ensuring that exactly one copy of
15216                         each needed template instantiation is emitted.
15217 * Bound member functions:: You can extract a function pointer to the
15218                         method denoted by a @samp{->*} or @samp{.*} expression.
15219 * C++ Attributes::      Variable, function, and type attributes for C++ only.
15220 * Namespace Association:: Strong using-directives for namespace association.
15221 * Type Traits::         Compiler support for type traits
15222 * Java Exceptions::     Tweaking exception handling to work with Java.
15223 * Deprecated Features:: Things will disappear from G++.
15224 * Backwards Compatibility:: Compatibilities with earlier definitions of C++.
15225 @end menu
15227 @node C++ Volatiles
15228 @section When is a Volatile C++ Object Accessed?
15229 @cindex accessing volatiles
15230 @cindex volatile read
15231 @cindex volatile write
15232 @cindex volatile access
15234 The C++ standard differs from the C standard in its treatment of
15235 volatile objects.  It fails to specify what constitutes a volatile
15236 access, except to say that C++ should behave in a similar manner to C
15237 with respect to volatiles, where possible.  However, the different
15238 lvalueness of expressions between C and C++ complicate the behavior.
15239 G++ behaves the same as GCC for volatile access, @xref{C
15240 Extensions,,Volatiles}, for a description of GCC's behavior.
15242 The C and C++ language specifications differ when an object is
15243 accessed in a void context:
15245 @smallexample
15246 volatile int *src = @var{somevalue};
15247 *src;
15248 @end smallexample
15250 The C++ standard specifies that such expressions do not undergo lvalue
15251 to rvalue conversion, and that the type of the dereferenced object may
15252 be incomplete.  The C++ standard does not specify explicitly that it
15253 is lvalue to rvalue conversion that is responsible for causing an
15254 access.  There is reason to believe that it is, because otherwise
15255 certain simple expressions become undefined.  However, because it
15256 would surprise most programmers, G++ treats dereferencing a pointer to
15257 volatile object of complete type as GCC would do for an equivalent
15258 type in C@.  When the object has incomplete type, G++ issues a
15259 warning; if you wish to force an error, you must force a conversion to
15260 rvalue with, for instance, a static cast.
15262 When using a reference to volatile, G++ does not treat equivalent
15263 expressions as accesses to volatiles, but instead issues a warning that
15264 no volatile is accessed.  The rationale for this is that otherwise it
15265 becomes difficult to determine where volatile access occur, and not
15266 possible to ignore the return value from functions returning volatile
15267 references.  Again, if you wish to force a read, cast the reference to
15268 an rvalue.
15270 G++ implements the same behavior as GCC does when assigning to a
15271 volatile object---there is no reread of the assigned-to object, the
15272 assigned rvalue is reused.  Note that in C++ assignment expressions
15273 are lvalues, and if used as an lvalue, the volatile object is
15274 referred to.  For instance, @var{vref} refers to @var{vobj}, as
15275 expected, in the following example:
15277 @smallexample
15278 volatile int vobj;
15279 volatile int &vref = vobj = @var{something};
15280 @end smallexample
15282 @node Restricted Pointers
15283 @section Restricting Pointer Aliasing
15284 @cindex restricted pointers
15285 @cindex restricted references
15286 @cindex restricted this pointer
15288 As with the C front end, G++ understands the C99 feature of restricted pointers,
15289 specified with the @code{__restrict__}, or @code{__restrict} type
15290 qualifier.  Because you cannot compile C++ by specifying the @option{-std=c99}
15291 language flag, @code{restrict} is not a keyword in C++.
15293 In addition to allowing restricted pointers, you can specify restricted
15294 references, which indicate that the reference is not aliased in the local
15295 context.
15297 @smallexample
15298 void fn (int *__restrict__ rptr, int &__restrict__ rref)
15300   /* @r{@dots{}} */
15302 @end smallexample
15304 @noindent
15305 In the body of @code{fn}, @var{rptr} points to an unaliased integer and
15306 @var{rref} refers to a (different) unaliased integer.
15308 You may also specify whether a member function's @var{this} pointer is
15309 unaliased by using @code{__restrict__} as a member function qualifier.
15311 @smallexample
15312 void T::fn () __restrict__
15314   /* @r{@dots{}} */
15316 @end smallexample
15318 @noindent
15319 Within the body of @code{T::fn}, @var{this} has the effective
15320 definition @code{T *__restrict__ const this}.  Notice that the
15321 interpretation of a @code{__restrict__} member function qualifier is
15322 different to that of @code{const} or @code{volatile} qualifier, in that it
15323 is applied to the pointer rather than the object.  This is consistent with
15324 other compilers that implement restricted pointers.
15326 As with all outermost parameter qualifiers, @code{__restrict__} is
15327 ignored in function definition matching.  This means you only need to
15328 specify @code{__restrict__} in a function definition, rather than
15329 in a function prototype as well.
15331 @node Vague Linkage
15332 @section Vague Linkage
15333 @cindex vague linkage
15335 There are several constructs in C++ that require space in the object
15336 file but are not clearly tied to a single translation unit.  We say that
15337 these constructs have ``vague linkage''.  Typically such constructs are
15338 emitted wherever they are needed, though sometimes we can be more
15339 clever.
15341 @table @asis
15342 @item Inline Functions
15343 Inline functions are typically defined in a header file which can be
15344 included in many different compilations.  Hopefully they can usually be
15345 inlined, but sometimes an out-of-line copy is necessary, if the address
15346 of the function is taken or if inlining fails.  In general, we emit an
15347 out-of-line copy in all translation units where one is needed.  As an
15348 exception, we only emit inline virtual functions with the vtable, since
15349 it always requires a copy.
15351 Local static variables and string constants used in an inline function
15352 are also considered to have vague linkage, since they must be shared
15353 between all inlined and out-of-line instances of the function.
15355 @item VTables
15356 @cindex vtable
15357 C++ virtual functions are implemented in most compilers using a lookup
15358 table, known as a vtable.  The vtable contains pointers to the virtual
15359 functions provided by a class, and each object of the class contains a
15360 pointer to its vtable (or vtables, in some multiple-inheritance
15361 situations).  If the class declares any non-inline, non-pure virtual
15362 functions, the first one is chosen as the ``key method'' for the class,
15363 and the vtable is only emitted in the translation unit where the key
15364 method is defined.
15366 @emph{Note:} If the chosen key method is later defined as inline, the
15367 vtable is still emitted in every translation unit that defines it.
15368 Make sure that any inline virtuals are declared inline in the class
15369 body, even if they are not defined there.
15371 @item @code{type_info} objects
15372 @cindex @code{type_info}
15373 @cindex RTTI
15374 C++ requires information about types to be written out in order to
15375 implement @samp{dynamic_cast}, @samp{typeid} and exception handling.
15376 For polymorphic classes (classes with virtual functions), the @samp{type_info}
15377 object is written out along with the vtable so that @samp{dynamic_cast}
15378 can determine the dynamic type of a class object at run time.  For all
15379 other types, we write out the @samp{type_info} object when it is used: when
15380 applying @samp{typeid} to an expression, throwing an object, or
15381 referring to a type in a catch clause or exception specification.
15383 @item Template Instantiations
15384 Most everything in this section also applies to template instantiations,
15385 but there are other options as well.
15386 @xref{Template Instantiation,,Where's the Template?}.
15388 @end table
15390 When used with GNU ld version 2.8 or later on an ELF system such as
15391 GNU/Linux or Solaris 2, or on Microsoft Windows, duplicate copies of
15392 these constructs will be discarded at link time.  This is known as
15393 COMDAT support.
15395 On targets that don't support COMDAT, but do support weak symbols, GCC
15396 uses them.  This way one copy overrides all the others, but
15397 the unused copies still take up space in the executable.
15399 For targets that do not support either COMDAT or weak symbols,
15400 most entities with vague linkage are emitted as local symbols to
15401 avoid duplicate definition errors from the linker.  This does not happen
15402 for local statics in inlines, however, as having multiple copies
15403 almost certainly breaks things.
15405 @xref{C++ Interface,,Declarations and Definitions in One Header}, for
15406 another way to control placement of these constructs.
15408 @node C++ Interface
15409 @section #pragma interface and implementation
15411 @cindex interface and implementation headers, C++
15412 @cindex C++ interface and implementation headers
15413 @cindex pragmas, interface and implementation
15415 @code{#pragma interface} and @code{#pragma implementation} provide the
15416 user with a way of explicitly directing the compiler to emit entities
15417 with vague linkage (and debugging information) in a particular
15418 translation unit.
15420 @emph{Note:} As of GCC 2.7.2, these @code{#pragma}s are not useful in
15421 most cases, because of COMDAT support and the ``key method'' heuristic
15422 mentioned in @ref{Vague Linkage}.  Using them can actually cause your
15423 program to grow due to unnecessary out-of-line copies of inline
15424 functions.  Currently (3.4) the only benefit of these
15425 @code{#pragma}s is reduced duplication of debugging information, and
15426 that should be addressed soon on DWARF 2 targets with the use of
15427 COMDAT groups.
15429 @table @code
15430 @item #pragma interface
15431 @itemx #pragma interface "@var{subdir}/@var{objects}.h"
15432 @kindex #pragma interface
15433 Use this directive in @emph{header files} that define object classes, to save
15434 space in most of the object files that use those classes.  Normally,
15435 local copies of certain information (backup copies of inline member
15436 functions, debugging information, and the internal tables that implement
15437 virtual functions) must be kept in each object file that includes class
15438 definitions.  You can use this pragma to avoid such duplication.  When a
15439 header file containing @samp{#pragma interface} is included in a
15440 compilation, this auxiliary information is not generated (unless
15441 the main input source file itself uses @samp{#pragma implementation}).
15442 Instead, the object files contain references to be resolved at link
15443 time.
15445 The second form of this directive is useful for the case where you have
15446 multiple headers with the same name in different directories.  If you
15447 use this form, you must specify the same string to @samp{#pragma
15448 implementation}.
15450 @item #pragma implementation
15451 @itemx #pragma implementation "@var{objects}.h"
15452 @kindex #pragma implementation
15453 Use this pragma in a @emph{main input file}, when you want full output from
15454 included header files to be generated (and made globally visible).  The
15455 included header file, in turn, should use @samp{#pragma interface}.
15456 Backup copies of inline member functions, debugging information, and the
15457 internal tables used to implement virtual functions are all generated in
15458 implementation files.
15460 @cindex implied @code{#pragma implementation}
15461 @cindex @code{#pragma implementation}, implied
15462 @cindex naming convention, implementation headers
15463 If you use @samp{#pragma implementation} with no argument, it applies to
15464 an include file with the same basename@footnote{A file's @dfn{basename}
15465 is the name stripped of all leading path information and of trailing
15466 suffixes, such as @samp{.h} or @samp{.C} or @samp{.cc}.} as your source
15467 file.  For example, in @file{allclass.cc}, giving just
15468 @samp{#pragma implementation}
15469 by itself is equivalent to @samp{#pragma implementation "allclass.h"}.
15471 In versions of GNU C++ prior to 2.6.0 @file{allclass.h} was treated as
15472 an implementation file whenever you would include it from
15473 @file{allclass.cc} even if you never specified @samp{#pragma
15474 implementation}.  This was deemed to be more trouble than it was worth,
15475 however, and disabled.
15477 Use the string argument if you want a single implementation file to
15478 include code from multiple header files.  (You must also use
15479 @samp{#include} to include the header file; @samp{#pragma
15480 implementation} only specifies how to use the file---it doesn't actually
15481 include it.)
15483 There is no way to split up the contents of a single header file into
15484 multiple implementation files.
15485 @end table
15487 @cindex inlining and C++ pragmas
15488 @cindex C++ pragmas, effect on inlining
15489 @cindex pragmas in C++, effect on inlining
15490 @samp{#pragma implementation} and @samp{#pragma interface} also have an
15491 effect on function inlining.
15493 If you define a class in a header file marked with @samp{#pragma
15494 interface}, the effect on an inline function defined in that class is
15495 similar to an explicit @code{extern} declaration---the compiler emits
15496 no code at all to define an independent version of the function.  Its
15497 definition is used only for inlining with its callers.
15499 @opindex fno-implement-inlines
15500 Conversely, when you include the same header file in a main source file
15501 that declares it as @samp{#pragma implementation}, the compiler emits
15502 code for the function itself; this defines a version of the function
15503 that can be found via pointers (or by callers compiled without
15504 inlining).  If all calls to the function can be inlined, you can avoid
15505 emitting the function by compiling with @option{-fno-implement-inlines}.
15506 If any calls are not inlined, you will get linker errors.
15508 @node Template Instantiation
15509 @section Where's the Template?
15510 @cindex template instantiation
15512 C++ templates are the first language feature to require more
15513 intelligence from the environment than one usually finds on a UNIX
15514 system.  Somehow the compiler and linker have to make sure that each
15515 template instance occurs exactly once in the executable if it is needed,
15516 and not at all otherwise.  There are two basic approaches to this
15517 problem, which are referred to as the Borland model and the Cfront model.
15519 @table @asis
15520 @item Borland model
15521 Borland C++ solved the template instantiation problem by adding the code
15522 equivalent of common blocks to their linker; the compiler emits template
15523 instances in each translation unit that uses them, and the linker
15524 collapses them together.  The advantage of this model is that the linker
15525 only has to consider the object files themselves; there is no external
15526 complexity to worry about.  This disadvantage is that compilation time
15527 is increased because the template code is being compiled repeatedly.
15528 Code written for this model tends to include definitions of all
15529 templates in the header file, since they must be seen to be
15530 instantiated.
15532 @item Cfront model
15533 The AT&T C++ translator, Cfront, solved the template instantiation
15534 problem by creating the notion of a template repository, an
15535 automatically maintained place where template instances are stored.  A
15536 more modern version of the repository works as follows: As individual
15537 object files are built, the compiler places any template definitions and
15538 instantiations encountered in the repository.  At link time, the link
15539 wrapper adds in the objects in the repository and compiles any needed
15540 instances that were not previously emitted.  The advantages of this
15541 model are more optimal compilation speed and the ability to use the
15542 system linker; to implement the Borland model a compiler vendor also
15543 needs to replace the linker.  The disadvantages are vastly increased
15544 complexity, and thus potential for error; for some code this can be
15545 just as transparent, but in practice it can been very difficult to build
15546 multiple programs in one directory and one program in multiple
15547 directories.  Code written for this model tends to separate definitions
15548 of non-inline member templates into a separate file, which should be
15549 compiled separately.
15550 @end table
15552 When used with GNU ld version 2.8 or later on an ELF system such as
15553 GNU/Linux or Solaris 2, or on Microsoft Windows, G++ supports the
15554 Borland model.  On other systems, G++ implements neither automatic
15555 model.
15557 You have the following options for dealing with template instantiations:
15559 @enumerate
15560 @item
15561 @opindex frepo
15562 Compile your template-using code with @option{-frepo}.  The compiler
15563 generates files with the extension @samp{.rpo} listing all of the
15564 template instantiations used in the corresponding object files that
15565 could be instantiated there; the link wrapper, @samp{collect2},
15566 then updates the @samp{.rpo} files to tell the compiler where to place
15567 those instantiations and rebuild any affected object files.  The
15568 link-time overhead is negligible after the first pass, as the compiler
15569 continues to place the instantiations in the same files.
15571 This is your best option for application code written for the Borland
15572 model, as it just works.  Code written for the Cfront model 
15573 needs to be modified so that the template definitions are available at
15574 one or more points of instantiation; usually this is as simple as adding
15575 @code{#include <tmethods.cc>} to the end of each template header.
15577 For library code, if you want the library to provide all of the template
15578 instantiations it needs, just try to link all of its object files
15579 together; the link will fail, but cause the instantiations to be
15580 generated as a side effect.  Be warned, however, that this may cause
15581 conflicts if multiple libraries try to provide the same instantiations.
15582 For greater control, use explicit instantiation as described in the next
15583 option.
15585 @item
15586 @opindex fno-implicit-templates
15587 Compile your code with @option{-fno-implicit-templates} to disable the
15588 implicit generation of template instances, and explicitly instantiate
15589 all the ones you use.  This approach requires more knowledge of exactly
15590 which instances you need than do the others, but it's less
15591 mysterious and allows greater control.  You can scatter the explicit
15592 instantiations throughout your program, perhaps putting them in the
15593 translation units where the instances are used or the translation units
15594 that define the templates themselves; you can put all of the explicit
15595 instantiations you need into one big file; or you can create small files
15596 like
15598 @smallexample
15599 #include "Foo.h"
15600 #include "Foo.cc"
15602 template class Foo<int>;
15603 template ostream& operator <<
15604                 (ostream&, const Foo<int>&);
15605 @end smallexample
15607 @noindent
15608 for each of the instances you need, and create a template instantiation
15609 library from those.
15611 If you are using Cfront-model code, you can probably get away with not
15612 using @option{-fno-implicit-templates} when compiling files that don't
15613 @samp{#include} the member template definitions.
15615 If you use one big file to do the instantiations, you may want to
15616 compile it without @option{-fno-implicit-templates} so you get all of the
15617 instances required by your explicit instantiations (but not by any
15618 other files) without having to specify them as well.
15620 The ISO C++ 2011 standard allows forward declaration of explicit
15621 instantiations (with @code{extern}). G++ supports explicit instantiation
15622 declarations in C++98 mode and has extended the template instantiation
15623 syntax to support instantiation of the compiler support data for a
15624 template class (i.e.@: the vtable) without instantiating any of its
15625 members (with @code{inline}), and instantiation of only the static data
15626 members of a template class, without the support data or member
15627 functions (with (@code{static}):
15629 @smallexample
15630 extern template int max (int, int);
15631 inline template class Foo<int>;
15632 static template class Foo<int>;
15633 @end smallexample
15635 @item
15636 Do nothing.  Pretend G++ does implement automatic instantiation
15637 management.  Code written for the Borland model works fine, but
15638 each translation unit contains instances of each of the templates it
15639 uses.  In a large program, this can lead to an unacceptable amount of code
15640 duplication.
15641 @end enumerate
15643 @node Bound member functions
15644 @section Extracting the function pointer from a bound pointer to member function
15645 @cindex pmf
15646 @cindex pointer to member function
15647 @cindex bound pointer to member function
15649 In C++, pointer to member functions (PMFs) are implemented using a wide
15650 pointer of sorts to handle all the possible call mechanisms; the PMF
15651 needs to store information about how to adjust the @samp{this} pointer,
15652 and if the function pointed to is virtual, where to find the vtable, and
15653 where in the vtable to look for the member function.  If you are using
15654 PMFs in an inner loop, you should really reconsider that decision.  If
15655 that is not an option, you can extract the pointer to the function that
15656 would be called for a given object/PMF pair and call it directly inside
15657 the inner loop, to save a bit of time.
15659 Note that you still pay the penalty for the call through a
15660 function pointer; on most modern architectures, such a call defeats the
15661 branch prediction features of the CPU@.  This is also true of normal
15662 virtual function calls.
15664 The syntax for this extension is
15666 @smallexample
15667 extern A a;
15668 extern int (A::*fp)();
15669 typedef int (*fptr)(A *);
15671 fptr p = (fptr)(a.*fp);
15672 @end smallexample
15674 For PMF constants (i.e.@: expressions of the form @samp{&Klasse::Member}),
15675 no object is needed to obtain the address of the function.  They can be
15676 converted to function pointers directly:
15678 @smallexample
15679 fptr p1 = (fptr)(&A::foo);
15680 @end smallexample
15682 @opindex Wno-pmf-conversions
15683 You must specify @option{-Wno-pmf-conversions} to use this extension.
15685 @node C++ Attributes
15686 @section C++-Specific Variable, Function, and Type Attributes
15688 Some attributes only make sense for C++ programs.
15690 @table @code
15691 @item abi_tag ("@var{tag}", ...)
15692 @cindex @code{abi_tag} attribute
15693 The @code{abi_tag} attribute can be applied to a function or class
15694 declaration.  It modifies the mangled name of the function or class to
15695 incorporate the tag name, in order to distinguish the function or
15696 class from an earlier version with a different ABI; perhaps the class
15697 has changed size, or the function has a different return type that is
15698 not encoded in the mangled name.
15700 The argument can be a list of strings of arbitrary length.  The
15701 strings are sorted on output, so the order of the list is
15702 unimportant.
15704 A redeclaration of a function or class must not add new ABI tags,
15705 since doing so would change the mangled name.
15707 The @option{-Wabi-tag} flag enables a warning about a class which does
15708 not have all the ABI tags used by its subobjects and virtual functions; for users with code
15709 that needs to coexist with an earlier ABI, using this option can help
15710 to find all affected types that need to be tagged.
15712 @item init_priority (@var{priority})
15713 @cindex @code{init_priority} attribute
15716 In Standard C++, objects defined at namespace scope are guaranteed to be
15717 initialized in an order in strict accordance with that of their definitions
15718 @emph{in a given translation unit}.  No guarantee is made for initializations
15719 across translation units.  However, GNU C++ allows users to control the
15720 order of initialization of objects defined at namespace scope with the
15721 @code{init_priority} attribute by specifying a relative @var{priority},
15722 a constant integral expression currently bounded between 101 and 65535
15723 inclusive.  Lower numbers indicate a higher priority.
15725 In the following example, @code{A} would normally be created before
15726 @code{B}, but the @code{init_priority} attribute reverses that order:
15728 @smallexample
15729 Some_Class  A  __attribute__ ((init_priority (2000)));
15730 Some_Class  B  __attribute__ ((init_priority (543)));
15731 @end smallexample
15733 @noindent
15734 Note that the particular values of @var{priority} do not matter; only their
15735 relative ordering.
15737 @item java_interface
15738 @cindex @code{java_interface} attribute
15740 This type attribute informs C++ that the class is a Java interface.  It may
15741 only be applied to classes declared within an @code{extern "Java"} block.
15742 Calls to methods declared in this interface are dispatched using GCJ's
15743 interface table mechanism, instead of regular virtual table dispatch.
15745 @end table
15747 See also @ref{Namespace Association}.
15749 @node Namespace Association
15750 @section Namespace Association
15752 @strong{Caution:} The semantics of this extension are equivalent
15753 to C++ 2011 inline namespaces.  Users should use inline namespaces
15754 instead as this extension will be removed in future versions of G++.
15756 A using-directive with @code{__attribute ((strong))} is stronger
15757 than a normal using-directive in two ways:
15759 @itemize @bullet
15760 @item
15761 Templates from the used namespace can be specialized and explicitly
15762 instantiated as though they were members of the using namespace.
15764 @item
15765 The using namespace is considered an associated namespace of all
15766 templates in the used namespace for purposes of argument-dependent
15767 name lookup.
15768 @end itemize
15770 The used namespace must be nested within the using namespace so that
15771 normal unqualified lookup works properly.
15773 This is useful for composing a namespace transparently from
15774 implementation namespaces.  For example:
15776 @smallexample
15777 namespace std @{
15778   namespace debug @{
15779     template <class T> struct A @{ @};
15780   @}
15781   using namespace debug __attribute ((__strong__));
15782   template <> struct A<int> @{ @};   // @r{ok to specialize}
15784   template <class T> void f (A<T>);
15787 int main()
15789   f (std::A<float>());             // @r{lookup finds} std::f
15790   f (std::A<int>());
15792 @end smallexample
15794 @node Type Traits
15795 @section Type Traits
15797 The C++ front end implements syntactic extensions that allow
15798 compile-time determination of 
15799 various characteristics of a type (or of a
15800 pair of types).
15802 @table @code
15803 @item __has_nothrow_assign (type)
15804 If @code{type} is const qualified or is a reference type then the trait is
15805 false.  Otherwise if @code{__has_trivial_assign (type)} is true then the trait
15806 is true, else if @code{type} is a cv class or union type with copy assignment
15807 operators that are known not to throw an exception then the trait is true,
15808 else it is false.  Requires: @code{type} shall be a complete type,
15809 (possibly cv-qualified) @code{void}, or an array of unknown bound.
15811 @item __has_nothrow_copy (type)
15812 If @code{__has_trivial_copy (type)} is true then the trait is true, else if
15813 @code{type} is a cv class or union type with copy constructors that
15814 are known not to throw an exception then the trait is true, else it is false.
15815 Requires: @code{type} shall be a complete type, (possibly cv-qualified)
15816 @code{void}, or an array of unknown bound.
15818 @item __has_nothrow_constructor (type)
15819 If @code{__has_trivial_constructor (type)} is true then the trait is
15820 true, else if @code{type} is a cv class or union type (or array
15821 thereof) with a default constructor that is known not to throw an
15822 exception then the trait is true, else it is false.  Requires:
15823 @code{type} shall be a complete type, (possibly cv-qualified)
15824 @code{void}, or an array of unknown bound.
15826 @item __has_trivial_assign (type)
15827 If @code{type} is const qualified or is a reference type then the trait is
15828 false.  Otherwise if @code{__is_pod (type)} is true then the trait is
15829 true, else if @code{type} is a cv class or union type with a trivial
15830 copy assignment ([class.copy]) then the trait is true, else it is
15831 false.  Requires: @code{type} shall be a complete type, (possibly
15832 cv-qualified) @code{void}, or an array of unknown bound.
15834 @item __has_trivial_copy (type)
15835 If @code{__is_pod (type)} is true or @code{type} is a reference type
15836 then the trait is true, else if @code{type} is a cv class or union type
15837 with a trivial copy constructor ([class.copy]) then the trait
15838 is true, else it is false.  Requires: @code{type} shall be a complete
15839 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
15841 @item __has_trivial_constructor (type)
15842 If @code{__is_pod (type)} is true then the trait is true, else if
15843 @code{type} is a cv class or union type (or array thereof) with a
15844 trivial default constructor ([class.ctor]) then the trait is true,
15845 else it is false.  Requires: @code{type} shall be a complete
15846 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
15848 @item __has_trivial_destructor (type)
15849 If @code{__is_pod (type)} is true or @code{type} is a reference type then
15850 the trait is true, else if @code{type} is a cv class or union type (or
15851 array thereof) with a trivial destructor ([class.dtor]) then the trait
15852 is true, else it is false.  Requires: @code{type} shall be a complete
15853 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
15855 @item __has_virtual_destructor (type)
15856 If @code{type} is a class type with a virtual destructor
15857 ([class.dtor]) then the trait is true, else it is false.  Requires:
15858 @code{type} shall be a complete type, (possibly cv-qualified)
15859 @code{void}, or an array of unknown bound.
15861 @item __is_abstract (type)
15862 If @code{type} is an abstract class ([class.abstract]) then the trait
15863 is true, else it is false.  Requires: @code{type} shall be a complete
15864 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
15866 @item __is_base_of (base_type, derived_type)
15867 If @code{base_type} is a base class of @code{derived_type}
15868 ([class.derived]) then the trait is true, otherwise it is false.
15869 Top-level cv qualifications of @code{base_type} and
15870 @code{derived_type} are ignored.  For the purposes of this trait, a
15871 class type is considered is own base.  Requires: if @code{__is_class
15872 (base_type)} and @code{__is_class (derived_type)} are true and
15873 @code{base_type} and @code{derived_type} are not the same type
15874 (disregarding cv-qualifiers), @code{derived_type} shall be a complete
15875 type.  Diagnostic is produced if this requirement is not met.
15877 @item __is_class (type)
15878 If @code{type} is a cv class type, and not a union type
15879 ([basic.compound]) the trait is true, else it is false.
15881 @item __is_empty (type)
15882 If @code{__is_class (type)} is false then the trait is false.
15883 Otherwise @code{type} is considered empty if and only if: @code{type}
15884 has no non-static data members, or all non-static data members, if
15885 any, are bit-fields of length 0, and @code{type} has no virtual
15886 members, and @code{type} has no virtual base classes, and @code{type}
15887 has no base classes @code{base_type} for which
15888 @code{__is_empty (base_type)} is false.  Requires: @code{type} shall
15889 be a complete type, (possibly cv-qualified) @code{void}, or an array
15890 of unknown bound.
15892 @item __is_enum (type)
15893 If @code{type} is a cv enumeration type ([basic.compound]) the trait is
15894 true, else it is false.
15896 @item __is_literal_type (type)
15897 If @code{type} is a literal type ([basic.types]) the trait is
15898 true, else it is false.  Requires: @code{type} shall be a complete type,
15899 (possibly cv-qualified) @code{void}, or an array of unknown bound.
15901 @item __is_pod (type)
15902 If @code{type} is a cv POD type ([basic.types]) then the trait is true,
15903 else it is false.  Requires: @code{type} shall be a complete type,
15904 (possibly cv-qualified) @code{void}, or an array of unknown bound.
15906 @item __is_polymorphic (type)
15907 If @code{type} is a polymorphic class ([class.virtual]) then the trait
15908 is true, else it is false.  Requires: @code{type} shall be a complete
15909 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
15911 @item __is_standard_layout (type)
15912 If @code{type} is a standard-layout type ([basic.types]) the trait is
15913 true, else it is false.  Requires: @code{type} shall be a complete
15914 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
15916 @item __is_trivial (type)
15917 If @code{type} is a trivial type ([basic.types]) the trait is
15918 true, else it is false.  Requires: @code{type} shall be a complete
15919 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
15921 @item __is_union (type)
15922 If @code{type} is a cv union type ([basic.compound]) the trait is
15923 true, else it is false.
15925 @item __underlying_type (type)
15926 The underlying type of @code{type}.  Requires: @code{type} shall be
15927 an enumeration type ([dcl.enum]).
15929 @end table
15931 @node Java Exceptions
15932 @section Java Exceptions
15934 The Java language uses a slightly different exception handling model
15935 from C++.  Normally, GNU C++ automatically detects when you are
15936 writing C++ code that uses Java exceptions, and handle them
15937 appropriately.  However, if C++ code only needs to execute destructors
15938 when Java exceptions are thrown through it, GCC guesses incorrectly.
15939 Sample problematic code is:
15941 @smallexample
15942   struct S @{ ~S(); @};
15943   extern void bar();    // @r{is written in Java, and may throw exceptions}
15944   void foo()
15945   @{
15946     S s;
15947     bar();
15948   @}
15949 @end smallexample
15951 @noindent
15952 The usual effect of an incorrect guess is a link failure, complaining of
15953 a missing routine called @samp{__gxx_personality_v0}.
15955 You can inform the compiler that Java exceptions are to be used in a
15956 translation unit, irrespective of what it might think, by writing
15957 @samp{@w{#pragma GCC java_exceptions}} at the head of the file.  This
15958 @samp{#pragma} must appear before any functions that throw or catch
15959 exceptions, or run destructors when exceptions are thrown through them.
15961 You cannot mix Java and C++ exceptions in the same translation unit.  It
15962 is believed to be safe to throw a C++ exception from one file through
15963 another file compiled for the Java exception model, or vice versa, but
15964 there may be bugs in this area.
15966 @node Deprecated Features
15967 @section Deprecated Features
15969 In the past, the GNU C++ compiler was extended to experiment with new
15970 features, at a time when the C++ language was still evolving.  Now that
15971 the C++ standard is complete, some of those features are superseded by
15972 superior alternatives.  Using the old features might cause a warning in
15973 some cases that the feature will be dropped in the future.  In other
15974 cases, the feature might be gone already.
15976 While the list below is not exhaustive, it documents some of the options
15977 that are now deprecated:
15979 @table @code
15980 @item -fexternal-templates
15981 @itemx -falt-external-templates
15982 These are two of the many ways for G++ to implement template
15983 instantiation.  @xref{Template Instantiation}.  The C++ standard clearly
15984 defines how template definitions have to be organized across
15985 implementation units.  G++ has an implicit instantiation mechanism that
15986 should work just fine for standard-conforming code.
15988 @item -fstrict-prototype
15989 @itemx -fno-strict-prototype
15990 Previously it was possible to use an empty prototype parameter list to
15991 indicate an unspecified number of parameters (like C), rather than no
15992 parameters, as C++ demands.  This feature has been removed, except where
15993 it is required for backwards compatibility.   @xref{Backwards Compatibility}.
15994 @end table
15996 G++ allows a virtual function returning @samp{void *} to be overridden
15997 by one returning a different pointer type.  This extension to the
15998 covariant return type rules is now deprecated and will be removed from a
15999 future version.
16001 The G++ minimum and maximum operators (@samp{<?} and @samp{>?}) and
16002 their compound forms (@samp{<?=}) and @samp{>?=}) have been deprecated
16003 and are now removed from G++.  Code using these operators should be
16004 modified to use @code{std::min} and @code{std::max} instead.
16006 The named return value extension has been deprecated, and is now
16007 removed from G++.
16009 The use of initializer lists with new expressions has been deprecated,
16010 and is now removed from G++.
16012 Floating and complex non-type template parameters have been deprecated,
16013 and are now removed from G++.
16015 The implicit typename extension has been deprecated and is now
16016 removed from G++.
16018 The use of default arguments in function pointers, function typedefs
16019 and other places where they are not permitted by the standard is
16020 deprecated and will be removed from a future version of G++.
16022 G++ allows floating-point literals to appear in integral constant expressions,
16023 e.g.@: @samp{ enum E @{ e = int(2.2 * 3.7) @} }
16024 This extension is deprecated and will be removed from a future version.
16026 G++ allows static data members of const floating-point type to be declared
16027 with an initializer in a class definition. The standard only allows
16028 initializers for static members of const integral types and const
16029 enumeration types so this extension has been deprecated and will be removed
16030 from a future version.
16032 @node Backwards Compatibility
16033 @section Backwards Compatibility
16034 @cindex Backwards Compatibility
16035 @cindex ARM [Annotated C++ Reference Manual]
16037 Now that there is a definitive ISO standard C++, G++ has a specification
16038 to adhere to.  The C++ language evolved over time, and features that
16039 used to be acceptable in previous drafts of the standard, such as the ARM
16040 [Annotated C++ Reference Manual], are no longer accepted.  In order to allow
16041 compilation of C++ written to such drafts, G++ contains some backwards
16042 compatibilities.  @emph{All such backwards compatibility features are
16043 liable to disappear in future versions of G++.} They should be considered
16044 deprecated.   @xref{Deprecated Features}.
16046 @table @code
16047 @item For scope
16048 If a variable is declared at for scope, it used to remain in scope until
16049 the end of the scope that contained the for statement (rather than just
16050 within the for scope).  G++ retains this, but issues a warning, if such a
16051 variable is accessed outside the for scope.
16053 @item Implicit C language
16054 Old C system header files did not contain an @code{extern "C" @{@dots{}@}}
16055 scope to set the language.  On such systems, all header files are
16056 implicitly scoped inside a C language scope.  Also, an empty prototype
16057 @code{()} is treated as an unspecified number of arguments, rather
16058 than no arguments, as C++ demands.
16059 @end table