Remove fused-madd from documentation
[official-gcc.git] / gcc / doc / extend.texi
blob96fed1502dc6c595a06a3d159984167939aa7b57
1 @c Copyright (C) 1988-2016 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
6 @node C Extensions
7 @chapter Extensions to the C Language Family
8 @cindex extensions, C language
9 @cindex C language extensions
11 @opindex pedantic
12 GNU C provides several language features not found in ISO standard C@.
13 (The @option{-pedantic} option directs GCC to print a warning message if
14 any of these features is used.)  To test for the availability of these
15 features in conditional compilation, check for a predefined macro
16 @code{__GNUC__}, which is always defined under GCC@.
18 These extensions are available in C and Objective-C@.  Most of them are
19 also available in C++.  @xref{C++ Extensions,,Extensions to the
20 C++ Language}, for extensions that apply @emph{only} to C++.
22 Some features that are in ISO C99 but not C90 or C++ are also, as
23 extensions, accepted by GCC in C90 mode and in C++.
25 @menu
26 * Statement Exprs::     Putting statements and declarations inside expressions.
27 * Local Labels::        Labels local to a block.
28 * Labels as Values::    Getting pointers to labels, and computed gotos.
29 * Nested Functions::    As in Algol and Pascal, lexical scoping of functions.
30 * Constructing Calls::  Dispatching a call to another function.
31 * Typeof::              @code{typeof}: referring to the type of an expression.
32 * Conditionals::        Omitting the middle operand of a @samp{?:} expression.
33 * __int128::            128-bit integers---@code{__int128}.
34 * Long Long::           Double-word integers---@code{long long int}.
35 * Complex::             Data types for complex numbers.
36 * Floating Types::      Additional Floating Types.
37 * Half-Precision::      Half-Precision Floating Point.
38 * Decimal Float::       Decimal Floating Types.
39 * Hex Floats::          Hexadecimal floating-point constants.
40 * Fixed-Point::         Fixed-Point Types.
41 * Named Address Spaces::Named address spaces.
42 * Zero Length::         Zero-length arrays.
43 * Empty Structures::    Structures with no members.
44 * Variable Length::     Arrays whose length is computed at run time.
45 * Variadic Macros::     Macros with a variable number of arguments.
46 * Escaped Newlines::    Slightly looser rules for escaped newlines.
47 * Subscripting::        Any array can be subscripted, even if not an lvalue.
48 * Pointer Arith::       Arithmetic on @code{void}-pointers and function pointers.
49 * Pointers to Arrays::  Pointers to arrays with qualifiers work as expected.
50 * Initializers::        Non-constant initializers.
51 * Compound Literals::   Compound literals give structures, unions
52                         or arrays as values.
53 * Designated Inits::    Labeling elements of initializers.
54 * Case Ranges::         `case 1 ... 9' and such.
55 * Cast to Union::       Casting to union type from any member of the union.
56 * Mixed Declarations::  Mixing declarations and code.
57 * Function Attributes:: Declaring that functions have no side effects,
58                         or that they can never return.
59 * Variable Attributes:: Specifying attributes of variables.
60 * Type Attributes::     Specifying attributes of types.
61 * Label Attributes::    Specifying attributes on labels.
62 * Enumerator Attributes:: Specifying attributes on enumerators.
63 * Attribute Syntax::    Formal syntax for attributes.
64 * Function Prototypes:: Prototype declarations and old-style definitions.
65 * C++ Comments::        C++ comments are recognized.
66 * Dollar Signs::        Dollar sign is allowed in identifiers.
67 * Character Escapes::   @samp{\e} stands for the character @key{ESC}.
68 * Alignment::           Inquiring about the alignment of a type or variable.
69 * Inline::              Defining inline functions (as fast as macros).
70 * Volatiles::           What constitutes an access to a volatile object.
71 * Using Assembly Language with C:: Instructions and extensions for interfacing C with assembler.
72 * Alternate Keywords::  @code{__const__}, @code{__asm__}, etc., for header files.
73 * Incomplete Enums::    @code{enum foo;}, with details to follow.
74 * Function Names::      Printable strings which are the name of the current
75                         function.
76 * Return Address::      Getting the return or frame address of a function.
77 * Vector Extensions::   Using vector instructions through built-in functions.
78 * Offsetof::            Special syntax for implementing @code{offsetof}.
79 * __sync Builtins::     Legacy built-in functions for atomic memory access.
80 * __atomic Builtins::   Atomic built-in functions with memory model.
81 * Integer Overflow Builtins:: Built-in functions to perform arithmetics and
82                         arithmetic overflow checking.
83 * x86 specific memory model extensions for transactional memory:: x86 memory models.
84 * Object Size Checking:: Built-in functions for limited buffer overflow
85                         checking.
86 * Pointer Bounds Checker builtins:: Built-in functions for Pointer Bounds Checker.
87 * Cilk Plus Builtins::  Built-in functions for the Cilk Plus language extension.
88 * Other Builtins::      Other built-in functions.
89 * Target Builtins::     Built-in functions specific to particular targets.
90 * Target Format Checks:: Format checks specific to particular targets.
91 * Pragmas::             Pragmas accepted by GCC.
92 * Unnamed Fields::      Unnamed struct/union fields within structs/unions.
93 * Thread-Local::        Per-thread variables.
94 * Binary constants::    Binary constants using the @samp{0b} prefix.
95 @end menu
97 @node Statement Exprs
98 @section Statements and Declarations in Expressions
99 @cindex statements inside expressions
100 @cindex declarations inside expressions
101 @cindex expressions containing statements
102 @cindex macros, statements in expressions
104 @c the above section title wrapped and causes an underfull hbox.. i
105 @c changed it from "within" to "in". --mew 4feb93
106 A compound statement enclosed in parentheses may appear as an expression
107 in GNU C@.  This allows you to use loops, switches, and local variables
108 within an expression.
110 Recall that a compound statement is a sequence of statements surrounded
111 by braces; in this construct, parentheses go around the braces.  For
112 example:
114 @smallexample
115 (@{ int y = foo (); int z;
116    if (y > 0) z = y;
117    else z = - y;
118    z; @})
119 @end smallexample
121 @noindent
122 is a valid (though slightly more complex than necessary) expression
123 for the absolute value of @code{foo ()}.
125 The last thing in the compound statement should be an expression
126 followed by a semicolon; the value of this subexpression serves as the
127 value of the entire construct.  (If you use some other kind of statement
128 last within the braces, the construct has type @code{void}, and thus
129 effectively no value.)
131 This feature is especially useful in making macro definitions ``safe'' (so
132 that they evaluate each operand exactly once).  For example, the
133 ``maximum'' function is commonly defined as a macro in standard C as
134 follows:
136 @smallexample
137 #define max(a,b) ((a) > (b) ? (a) : (b))
138 @end smallexample
140 @noindent
141 @cindex side effects, macro argument
142 But this definition computes either @var{a} or @var{b} twice, with bad
143 results if the operand has side effects.  In GNU C, if you know the
144 type of the operands (here taken as @code{int}), you can define
145 the macro safely as follows:
147 @smallexample
148 #define maxint(a,b) \
149   (@{int _a = (a), _b = (b); _a > _b ? _a : _b; @})
150 @end smallexample
152 Embedded statements are not allowed in constant expressions, such as
153 the value of an enumeration constant, the width of a bit-field, or
154 the initial value of a static variable.
156 If you don't know the type of the operand, you can still do this, but you
157 must use @code{typeof} or @code{__auto_type} (@pxref{Typeof}).
159 In G++, the result value of a statement expression undergoes array and
160 function pointer decay, and is returned by value to the enclosing
161 expression.  For instance, if @code{A} is a class, then
163 @smallexample
164         A a;
166         (@{a;@}).Foo ()
167 @end smallexample
169 @noindent
170 constructs a temporary @code{A} object to hold the result of the
171 statement expression, and that is used to invoke @code{Foo}.
172 Therefore the @code{this} pointer observed by @code{Foo} is not the
173 address of @code{a}.
175 In a statement expression, any temporaries created within a statement
176 are destroyed at that statement's end.  This makes statement
177 expressions inside macros slightly different from function calls.  In
178 the latter case temporaries introduced during argument evaluation are
179 destroyed at the end of the statement that includes the function
180 call.  In the statement expression case they are destroyed during
181 the statement expression.  For instance,
183 @smallexample
184 #define macro(a)  (@{__typeof__(a) b = (a); b + 3; @})
185 template<typename T> T function(T a) @{ T b = a; return b + 3; @}
187 void foo ()
189   macro (X ());
190   function (X ());
192 @end smallexample
194 @noindent
195 has different places where temporaries are destroyed.  For the
196 @code{macro} case, the temporary @code{X} is destroyed just after
197 the initialization of @code{b}.  In the @code{function} case that
198 temporary is destroyed when the function returns.
200 These considerations mean that it is probably a bad idea to use
201 statement expressions of this form in header files that are designed to
202 work with C++.  (Note that some versions of the GNU C Library contained
203 header files using statement expressions that lead to precisely this
204 bug.)
206 Jumping into a statement expression with @code{goto} or using a
207 @code{switch} statement outside the statement expression with a
208 @code{case} or @code{default} label inside the statement expression is
209 not permitted.  Jumping into a statement expression with a computed
210 @code{goto} (@pxref{Labels as Values}) has undefined behavior.
211 Jumping out of a statement expression is permitted, but if the
212 statement expression is part of a larger expression then it is
213 unspecified which other subexpressions of that expression have been
214 evaluated except where the language definition requires certain
215 subexpressions to be evaluated before or after the statement
216 expression.  In any case, as with a function call, the evaluation of a
217 statement expression is not interleaved with the evaluation of other
218 parts of the containing expression.  For example,
220 @smallexample
221   foo (), ((@{ bar1 (); goto a; 0; @}) + bar2 ()), baz();
222 @end smallexample
224 @noindent
225 calls @code{foo} and @code{bar1} and does not call @code{baz} but
226 may or may not call @code{bar2}.  If @code{bar2} is called, it is
227 called after @code{foo} and before @code{bar1}.
229 @node Local Labels
230 @section Locally Declared Labels
231 @cindex local labels
232 @cindex macros, local labels
234 GCC allows you to declare @dfn{local labels} in any nested block
235 scope.  A local label is just like an ordinary label, but you can
236 only reference it (with a @code{goto} statement, or by taking its
237 address) within the block in which it is declared.
239 A local label declaration looks like this:
241 @smallexample
242 __label__ @var{label};
243 @end smallexample
245 @noindent
248 @smallexample
249 __label__ @var{label1}, @var{label2}, /* @r{@dots{}} */;
250 @end smallexample
252 Local label declarations must come at the beginning of the block,
253 before any ordinary declarations or statements.
255 The label declaration defines the label @emph{name}, but does not define
256 the label itself.  You must do this in the usual way, with
257 @code{@var{label}:}, within the statements of the statement expression.
259 The local label feature is useful for complex macros.  If a macro
260 contains nested loops, a @code{goto} can be useful for breaking out of
261 them.  However, an ordinary label whose scope is the whole function
262 cannot be used: if the macro can be expanded several times in one
263 function, the label is multiply defined in that function.  A
264 local label avoids this problem.  For example:
266 @smallexample
267 #define SEARCH(value, array, target)              \
268 do @{                                              \
269   __label__ found;                                \
270   typeof (target) _SEARCH_target = (target);      \
271   typeof (*(array)) *_SEARCH_array = (array);     \
272   int i, j;                                       \
273   int value;                                      \
274   for (i = 0; i < max; i++)                       \
275     for (j = 0; j < max; j++)                     \
276       if (_SEARCH_array[i][j] == _SEARCH_target)  \
277         @{ (value) = i; goto found; @}              \
278   (value) = -1;                                   \
279  found:;                                          \
280 @} while (0)
281 @end smallexample
283 This could also be written using a statement expression:
285 @smallexample
286 #define SEARCH(array, target)                     \
287 (@{                                                \
288   __label__ found;                                \
289   typeof (target) _SEARCH_target = (target);      \
290   typeof (*(array)) *_SEARCH_array = (array);     \
291   int i, j;                                       \
292   int value;                                      \
293   for (i = 0; i < max; i++)                       \
294     for (j = 0; j < max; j++)                     \
295       if (_SEARCH_array[i][j] == _SEARCH_target)  \
296         @{ value = i; goto found; @}                \
297   value = -1;                                     \
298  found:                                           \
299   value;                                          \
301 @end smallexample
303 Local label declarations also make the labels they declare visible to
304 nested functions, if there are any.  @xref{Nested Functions}, for details.
306 @node Labels as Values
307 @section Labels as Values
308 @cindex labels as values
309 @cindex computed gotos
310 @cindex goto with computed label
311 @cindex address of a label
313 You can get the address of a label defined in the current function
314 (or a containing function) with the unary operator @samp{&&}.  The
315 value has type @code{void *}.  This value is a constant and can be used
316 wherever a constant of that type is valid.  For example:
318 @smallexample
319 void *ptr;
320 /* @r{@dots{}} */
321 ptr = &&foo;
322 @end smallexample
324 To use these values, you need to be able to jump to one.  This is done
325 with the computed goto statement@footnote{The analogous feature in
326 Fortran is called an assigned goto, but that name seems inappropriate in
327 C, where one can do more than simply store label addresses in label
328 variables.}, @code{goto *@var{exp};}.  For example,
330 @smallexample
331 goto *ptr;
332 @end smallexample
334 @noindent
335 Any expression of type @code{void *} is allowed.
337 One way of using these constants is in initializing a static array that
338 serves as a jump table:
340 @smallexample
341 static void *array[] = @{ &&foo, &&bar, &&hack @};
342 @end smallexample
344 @noindent
345 Then you can select a label with indexing, like this:
347 @smallexample
348 goto *array[i];
349 @end smallexample
351 @noindent
352 Note that this does not check whether the subscript is in bounds---array
353 indexing in C never does that.
355 Such an array of label values serves a purpose much like that of the
356 @code{switch} statement.  The @code{switch} statement is cleaner, so
357 use that rather than an array unless the problem does not fit a
358 @code{switch} statement very well.
360 Another use of label values is in an interpreter for threaded code.
361 The labels within the interpreter function can be stored in the
362 threaded code for super-fast dispatching.
364 You may not use this mechanism to jump to code in a different function.
365 If you do that, totally unpredictable things happen.  The best way to
366 avoid this is to store the label address only in automatic variables and
367 never pass it as an argument.
369 An alternate way to write the above example is
371 @smallexample
372 static const int array[] = @{ &&foo - &&foo, &&bar - &&foo,
373                              &&hack - &&foo @};
374 goto *(&&foo + array[i]);
375 @end smallexample
377 @noindent
378 This is more friendly to code living in shared libraries, as it reduces
379 the number of dynamic relocations that are needed, and by consequence,
380 allows the data to be read-only.
381 This alternative with label differences is not supported for the AVR target,
382 please use the first approach for AVR programs.
384 The @code{&&foo} expressions for the same label might have different
385 values if the containing function is inlined or cloned.  If a program
386 relies on them being always the same,
387 @code{__attribute__((__noinline__,__noclone__))} should be used to
388 prevent inlining and cloning.  If @code{&&foo} is used in a static
389 variable initializer, inlining and cloning is forbidden.
391 @node Nested Functions
392 @section Nested Functions
393 @cindex nested functions
394 @cindex downward funargs
395 @cindex thunks
397 A @dfn{nested function} is a function defined inside another function.
398 Nested functions are supported as an extension in GNU C, but are not
399 supported by GNU C++.
401 The nested function's name is local to the block where it is defined.
402 For example, here we define a nested function named @code{square}, and
403 call it twice:
405 @smallexample
406 @group
407 foo (double a, double b)
409   double square (double z) @{ return z * z; @}
411   return square (a) + square (b);
413 @end group
414 @end smallexample
416 The nested function can access all the variables of the containing
417 function that are visible at the point of its definition.  This is
418 called @dfn{lexical scoping}.  For example, here we show a nested
419 function which uses an inherited variable named @code{offset}:
421 @smallexample
422 @group
423 bar (int *array, int offset, int size)
425   int access (int *array, int index)
426     @{ return array[index + offset]; @}
427   int i;
428   /* @r{@dots{}} */
429   for (i = 0; i < size; i++)
430     /* @r{@dots{}} */ access (array, i) /* @r{@dots{}} */
432 @end group
433 @end smallexample
435 Nested function definitions are permitted within functions in the places
436 where variable definitions are allowed; that is, in any block, mixed
437 with the other declarations and statements in the block.
439 It is possible to call the nested function from outside the scope of its
440 name by storing its address or passing the address to another function:
442 @smallexample
443 hack (int *array, int size)
445   void store (int index, int value)
446     @{ array[index] = value; @}
448   intermediate (store, size);
450 @end smallexample
452 Here, the function @code{intermediate} receives the address of
453 @code{store} as an argument.  If @code{intermediate} calls @code{store},
454 the arguments given to @code{store} are used to store into @code{array}.
455 But this technique works only so long as the containing function
456 (@code{hack}, in this example) does not exit.
458 If you try to call the nested function through its address after the
459 containing function exits, all hell breaks loose.  If you try
460 to call it after a containing scope level exits, and if it refers
461 to some of the variables that are no longer in scope, you may be lucky,
462 but it's not wise to take the risk.  If, however, the nested function
463 does not refer to anything that has gone out of scope, you should be
464 safe.
466 GCC implements taking the address of a nested function using a technique
467 called @dfn{trampolines}.  This technique was described in
468 @cite{Lexical Closures for C++} (Thomas M. Breuel, USENIX
469 C++ Conference Proceedings, October 17-21, 1988).
471 A nested function can jump to a label inherited from a containing
472 function, provided the label is explicitly declared in the containing
473 function (@pxref{Local Labels}).  Such a jump returns instantly to the
474 containing function, exiting the nested function that did the
475 @code{goto} and any intermediate functions as well.  Here is an example:
477 @smallexample
478 @group
479 bar (int *array, int offset, int size)
481   __label__ failure;
482   int access (int *array, int index)
483     @{
484       if (index > size)
485         goto failure;
486       return array[index + offset];
487     @}
488   int i;
489   /* @r{@dots{}} */
490   for (i = 0; i < size; i++)
491     /* @r{@dots{}} */ access (array, i) /* @r{@dots{}} */
492   /* @r{@dots{}} */
493   return 0;
495  /* @r{Control comes here from @code{access}
496     if it detects an error.}  */
497  failure:
498   return -1;
500 @end group
501 @end smallexample
503 A nested function always has no linkage.  Declaring one with
504 @code{extern} or @code{static} is erroneous.  If you need to declare the nested function
505 before its definition, use @code{auto} (which is otherwise meaningless
506 for function declarations).
508 @smallexample
509 bar (int *array, int offset, int size)
511   __label__ failure;
512   auto int access (int *, int);
513   /* @r{@dots{}} */
514   int access (int *array, int index)
515     @{
516       if (index > size)
517         goto failure;
518       return array[index + offset];
519     @}
520   /* @r{@dots{}} */
522 @end smallexample
524 @node Constructing Calls
525 @section Constructing Function Calls
526 @cindex constructing calls
527 @cindex forwarding calls
529 Using the built-in functions described below, you can record
530 the arguments a function received, and call another function
531 with the same arguments, without knowing the number or types
532 of the arguments.
534 You can also record the return value of that function call,
535 and later return that value, without knowing what data type
536 the function tried to return (as long as your caller expects
537 that data type).
539 However, these built-in functions may interact badly with some
540 sophisticated features or other extensions of the language.  It
541 is, therefore, not recommended to use them outside very simple
542 functions acting as mere forwarders for their arguments.
544 @deftypefn {Built-in Function} {void *} __builtin_apply_args ()
545 This built-in function returns a pointer to data
546 describing how to perform a call with the same arguments as are passed
547 to the current function.
549 The function saves the arg pointer register, structure value address,
550 and all registers that might be used to pass arguments to a function
551 into a block of memory allocated on the stack.  Then it returns the
552 address of that block.
553 @end deftypefn
555 @deftypefn {Built-in Function} {void *} __builtin_apply (void (*@var{function})(), void *@var{arguments}, size_t @var{size})
556 This built-in function invokes @var{function}
557 with a copy of the parameters described by @var{arguments}
558 and @var{size}.
560 The value of @var{arguments} should be the value returned by
561 @code{__builtin_apply_args}.  The argument @var{size} specifies the size
562 of the stack argument data, in bytes.
564 This function returns a pointer to data describing
565 how to return whatever value is returned by @var{function}.  The data
566 is saved in a block of memory allocated on the stack.
568 It is not always simple to compute the proper value for @var{size}.  The
569 value is used by @code{__builtin_apply} to compute the amount of data
570 that should be pushed on the stack and copied from the incoming argument
571 area.
572 @end deftypefn
574 @deftypefn {Built-in Function} {void} __builtin_return (void *@var{result})
575 This built-in function returns the value described by @var{result} from
576 the containing function.  You should specify, for @var{result}, a value
577 returned by @code{__builtin_apply}.
578 @end deftypefn
580 @deftypefn {Built-in Function} {} __builtin_va_arg_pack ()
581 This built-in function represents all anonymous arguments of an inline
582 function.  It can be used only in inline functions that are always
583 inlined, never compiled as a separate function, such as those using
584 @code{__attribute__ ((__always_inline__))} or
585 @code{__attribute__ ((__gnu_inline__))} extern inline functions.
586 It must be only passed as last argument to some other function
587 with variable arguments.  This is useful for writing small wrapper
588 inlines for variable argument functions, when using preprocessor
589 macros is undesirable.  For example:
590 @smallexample
591 extern int myprintf (FILE *f, const char *format, ...);
592 extern inline __attribute__ ((__gnu_inline__)) int
593 myprintf (FILE *f, const char *format, ...)
595   int r = fprintf (f, "myprintf: ");
596   if (r < 0)
597     return r;
598   int s = fprintf (f, format, __builtin_va_arg_pack ());
599   if (s < 0)
600     return s;
601   return r + s;
603 @end smallexample
604 @end deftypefn
606 @deftypefn {Built-in Function} {size_t} __builtin_va_arg_pack_len ()
607 This built-in function returns the number of anonymous arguments of
608 an inline function.  It can be used only in inline functions that
609 are always inlined, never compiled as a separate function, such
610 as those using @code{__attribute__ ((__always_inline__))} or
611 @code{__attribute__ ((__gnu_inline__))} extern inline functions.
612 For example following does link- or run-time checking of open
613 arguments for optimized code:
614 @smallexample
615 #ifdef __OPTIMIZE__
616 extern inline __attribute__((__gnu_inline__)) int
617 myopen (const char *path, int oflag, ...)
619   if (__builtin_va_arg_pack_len () > 1)
620     warn_open_too_many_arguments ();
622   if (__builtin_constant_p (oflag))
623     @{
624       if ((oflag & O_CREAT) != 0 && __builtin_va_arg_pack_len () < 1)
625         @{
626           warn_open_missing_mode ();
627           return __open_2 (path, oflag);
628         @}
629       return open (path, oflag, __builtin_va_arg_pack ());
630     @}
632   if (__builtin_va_arg_pack_len () < 1)
633     return __open_2 (path, oflag);
635   return open (path, oflag, __builtin_va_arg_pack ());
637 #endif
638 @end smallexample
639 @end deftypefn
641 @node Typeof
642 @section Referring to a Type with @code{typeof}
643 @findex typeof
644 @findex sizeof
645 @cindex macros, types of arguments
647 Another way to refer to the type of an expression is with @code{typeof}.
648 The syntax of using of this keyword looks like @code{sizeof}, but the
649 construct acts semantically like a type name defined with @code{typedef}.
651 There are two ways of writing the argument to @code{typeof}: with an
652 expression or with a type.  Here is an example with an expression:
654 @smallexample
655 typeof (x[0](1))
656 @end smallexample
658 @noindent
659 This assumes that @code{x} is an array of pointers to functions;
660 the type described is that of the values of the functions.
662 Here is an example with a typename as the argument:
664 @smallexample
665 typeof (int *)
666 @end smallexample
668 @noindent
669 Here the type described is that of pointers to @code{int}.
671 If you are writing a header file that must work when included in ISO C
672 programs, write @code{__typeof__} instead of @code{typeof}.
673 @xref{Alternate Keywords}.
675 A @code{typeof} construct can be used anywhere a typedef name can be
676 used.  For example, you can use it in a declaration, in a cast, or inside
677 of @code{sizeof} or @code{typeof}.
679 The operand of @code{typeof} is evaluated for its side effects if and
680 only if it is an expression of variably modified type or the name of
681 such a type.
683 @code{typeof} is often useful in conjunction with
684 statement expressions (@pxref{Statement Exprs}).
685 Here is how the two together can
686 be used to define a safe ``maximum'' macro which operates on any
687 arithmetic type and evaluates each of its arguments exactly once:
689 @smallexample
690 #define max(a,b) \
691   (@{ typeof (a) _a = (a); \
692       typeof (b) _b = (b); \
693     _a > _b ? _a : _b; @})
694 @end smallexample
696 @cindex underscores in variables in macros
697 @cindex @samp{_} in variables in macros
698 @cindex local variables in macros
699 @cindex variables, local, in macros
700 @cindex macros, local variables in
702 The reason for using names that start with underscores for the local
703 variables is to avoid conflicts with variable names that occur within the
704 expressions that are substituted for @code{a} and @code{b}.  Eventually we
705 hope to design a new form of declaration syntax that allows you to declare
706 variables whose scopes start only after their initializers; this will be a
707 more reliable way to prevent such conflicts.
709 @noindent
710 Some more examples of the use of @code{typeof}:
712 @itemize @bullet
713 @item
714 This declares @code{y} with the type of what @code{x} points to.
716 @smallexample
717 typeof (*x) y;
718 @end smallexample
720 @item
721 This declares @code{y} as an array of such values.
723 @smallexample
724 typeof (*x) y[4];
725 @end smallexample
727 @item
728 This declares @code{y} as an array of pointers to characters:
730 @smallexample
731 typeof (typeof (char *)[4]) y;
732 @end smallexample
734 @noindent
735 It is equivalent to the following traditional C declaration:
737 @smallexample
738 char *y[4];
739 @end smallexample
741 To see the meaning of the declaration using @code{typeof}, and why it
742 might be a useful way to write, rewrite it with these macros:
744 @smallexample
745 #define pointer(T)  typeof(T *)
746 #define array(T, N) typeof(T [N])
747 @end smallexample
749 @noindent
750 Now the declaration can be rewritten this way:
752 @smallexample
753 array (pointer (char), 4) y;
754 @end smallexample
756 @noindent
757 Thus, @code{array (pointer (char), 4)} is the type of arrays of 4
758 pointers to @code{char}.
759 @end itemize
761 In GNU C, but not GNU C++, you may also declare the type of a variable
762 as @code{__auto_type}.  In that case, the declaration must declare
763 only one variable, whose declarator must just be an identifier, the
764 declaration must be initialized, and the type of the variable is
765 determined by the initializer; the name of the variable is not in
766 scope until after the initializer.  (In C++, you should use C++11
767 @code{auto} for this purpose.)  Using @code{__auto_type}, the
768 ``maximum'' macro above could be written as:
770 @smallexample
771 #define max(a,b) \
772   (@{ __auto_type _a = (a); \
773       __auto_type _b = (b); \
774     _a > _b ? _a : _b; @})
775 @end smallexample
777 Using @code{__auto_type} instead of @code{typeof} has two advantages:
779 @itemize @bullet
780 @item Each argument to the macro appears only once in the expansion of
781 the macro.  This prevents the size of the macro expansion growing
782 exponentially when calls to such macros are nested inside arguments of
783 such macros.
785 @item If the argument to the macro has variably modified type, it is
786 evaluated only once when using @code{__auto_type}, but twice if
787 @code{typeof} is used.
788 @end itemize
790 @node Conditionals
791 @section Conditionals with Omitted Operands
792 @cindex conditional expressions, extensions
793 @cindex omitted middle-operands
794 @cindex middle-operands, omitted
795 @cindex extensions, @code{?:}
796 @cindex @code{?:} extensions
798 The middle operand in a conditional expression may be omitted.  Then
799 if the first operand is nonzero, its value is the value of the conditional
800 expression.
802 Therefore, the expression
804 @smallexample
805 x ? : y
806 @end smallexample
808 @noindent
809 has the value of @code{x} if that is nonzero; otherwise, the value of
810 @code{y}.
812 This example is perfectly equivalent to
814 @smallexample
815 x ? x : y
816 @end smallexample
818 @cindex side effect in @code{?:}
819 @cindex @code{?:} side effect
820 @noindent
821 In this simple case, the ability to omit the middle operand is not
822 especially useful.  When it becomes useful is when the first operand does,
823 or may (if it is a macro argument), contain a side effect.  Then repeating
824 the operand in the middle would perform the side effect twice.  Omitting
825 the middle operand uses the value already computed without the undesirable
826 effects of recomputing it.
828 @node __int128
829 @section 128-bit Integers
830 @cindex @code{__int128} data types
832 As an extension the integer scalar type @code{__int128} is supported for
833 targets which have an integer mode wide enough to hold 128 bits.
834 Simply write @code{__int128} for a signed 128-bit integer, or
835 @code{unsigned __int128} for an unsigned 128-bit integer.  There is no
836 support in GCC for expressing an integer constant of type @code{__int128}
837 for targets with @code{long long} integer less than 128 bits wide.
839 @node Long Long
840 @section Double-Word Integers
841 @cindex @code{long long} data types
842 @cindex double-word arithmetic
843 @cindex multiprecision arithmetic
844 @cindex @code{LL} integer suffix
845 @cindex @code{ULL} integer suffix
847 ISO C99 supports data types for integers that are at least 64 bits wide,
848 and as an extension GCC supports them in C90 mode and in C++.
849 Simply write @code{long long int} for a signed integer, or
850 @code{unsigned long long int} for an unsigned integer.  To make an
851 integer constant of type @code{long long int}, add the suffix @samp{LL}
852 to the integer.  To make an integer constant of type @code{unsigned long
853 long int}, add the suffix @samp{ULL} to the integer.
855 You can use these types in arithmetic like any other integer types.
856 Addition, subtraction, and bitwise boolean operations on these types
857 are open-coded on all types of machines.  Multiplication is open-coded
858 if the machine supports a fullword-to-doubleword widening multiply
859 instruction.  Division and shifts are open-coded only on machines that
860 provide special support.  The operations that are not open-coded use
861 special library routines that come with GCC@.
863 There may be pitfalls when you use @code{long long} types for function
864 arguments without function prototypes.  If a function
865 expects type @code{int} for its argument, and you pass a value of type
866 @code{long long int}, confusion results because the caller and the
867 subroutine disagree about the number of bytes for the argument.
868 Likewise, if the function expects @code{long long int} and you pass
869 @code{int}.  The best way to avoid such problems is to use prototypes.
871 @node Complex
872 @section Complex Numbers
873 @cindex complex numbers
874 @cindex @code{_Complex} keyword
875 @cindex @code{__complex__} keyword
877 ISO C99 supports complex floating data types, and as an extension GCC
878 supports them in C90 mode and in C++.  GCC also supports complex integer data
879 types which are not part of ISO C99.  You can declare complex types
880 using the keyword @code{_Complex}.  As an extension, the older GNU
881 keyword @code{__complex__} is also supported.
883 For example, @samp{_Complex double x;} declares @code{x} as a
884 variable whose real part and imaginary part are both of type
885 @code{double}.  @samp{_Complex short int y;} declares @code{y} to
886 have real and imaginary parts of type @code{short int}; this is not
887 likely to be useful, but it shows that the set of complex types is
888 complete.
890 To write a constant with a complex data type, use the suffix @samp{i} or
891 @samp{j} (either one; they are equivalent).  For example, @code{2.5fi}
892 has type @code{_Complex float} and @code{3i} has type
893 @code{_Complex int}.  Such a constant always has a pure imaginary
894 value, but you can form any complex value you like by adding one to a
895 real constant.  This is a GNU extension; if you have an ISO C99
896 conforming C library (such as the GNU C Library), and want to construct complex
897 constants of floating type, you should include @code{<complex.h>} and
898 use the macros @code{I} or @code{_Complex_I} instead.
900 @cindex @code{__real__} keyword
901 @cindex @code{__imag__} keyword
902 To extract the real part of a complex-valued expression @var{exp}, write
903 @code{__real__ @var{exp}}.  Likewise, use @code{__imag__} to
904 extract the imaginary part.  This is a GNU extension; for values of
905 floating type, you should use the ISO C99 functions @code{crealf},
906 @code{creal}, @code{creall}, @code{cimagf}, @code{cimag} and
907 @code{cimagl}, declared in @code{<complex.h>} and also provided as
908 built-in functions by GCC@.
910 @cindex complex conjugation
911 The operator @samp{~} performs complex conjugation when used on a value
912 with a complex type.  This is a GNU extension; for values of
913 floating type, you should use the ISO C99 functions @code{conjf},
914 @code{conj} and @code{conjl}, declared in @code{<complex.h>} and also
915 provided as built-in functions by GCC@.
917 GCC can allocate complex automatic variables in a noncontiguous
918 fashion; it's even possible for the real part to be in a register while
919 the imaginary part is on the stack (or vice versa).  Only the DWARF
920 debug info format can represent this, so use of DWARF is recommended.
921 If you are using the stabs debug info format, GCC describes a noncontiguous
922 complex variable as if it were two separate variables of noncomplex type.
923 If the variable's actual name is @code{foo}, the two fictitious
924 variables are named @code{foo$real} and @code{foo$imag}.  You can
925 examine and set these two fictitious variables with your debugger.
927 @node Floating Types
928 @section Additional Floating Types
929 @cindex additional floating types
930 @cindex @code{_Float@var{n}} data types
931 @cindex @code{_Float@var{n}x} data types
932 @cindex @code{__float80} data type
933 @cindex @code{__float128} data type
934 @cindex @code{__ibm128} data type
935 @cindex @code{w} floating point suffix
936 @cindex @code{q} floating point suffix
937 @cindex @code{W} floating point suffix
938 @cindex @code{Q} floating point suffix
940 ISO/IEC TS 18661-3:2015 defines C support for additional floating
941 types @code{_Float@var{n}} and @code{_Float@var{n}x}, and GCC supports
942 these type names; the set of types supported depends on the target
943 architecture.  These types are not supported when compiling C++.
944 Constants with these types use suffixes @code{f@var{n}} or
945 @code{F@var{n}} and @code{f@var{n}x} or @code{F@var{n}x}.  These type
946 names can be used together with @code{_Complex} to declare complex
947 types.
949 As an extension, GNU C and GNU C++ support additional floating
950 types, @code{__float80} and @code{__float128} to support 80-bit
951 (@code{XFmode}) and 128-bit (@code{TFmode}) floating types; these are
952 aliases for the type names @code{_Float64x} and @code{_Float128}.
953 Support for additional types includes the arithmetic operators:
954 add, subtract, multiply, divide; unary arithmetic operators;
955 relational operators; equality operators; and conversions to and from
956 integer and other floating types.  Use a suffix @samp{w} or @samp{W}
957 in a literal constant of type @code{__float80} or type
958 @code{__ibm128}.  Use a suffix @samp{q} or @samp{Q} for @code{_float128}.
960 On the i386, x86_64, IA-64, and HP-UX targets, you can declare complex
961 types using the corresponding internal complex type, @code{XCmode} for
962 @code{__float80} type and @code{TCmode} for @code{__float128} type:
964 @smallexample
965 typedef _Complex float __attribute__((mode(TC))) _Complex128;
966 typedef _Complex float __attribute__((mode(XC))) _Complex80;
967 @end smallexample
969 In order to use @code{_Float128}, @code{__float128} and
970 @code{__ibm128} on PowerPC Linux
971 systems, you must use the @option{-mfloat128}. It is expected in
972 future versions of GCC that @code{_Float128} and @code{__float128}
973 will be enabled
974 automatically.  In addition, there are currently problems in using the
975 complex @code{__float128} type.  When these problems are fixed, you
976 would use the following syntax to declare @code{_Complex128} to be a
977 complex @code{__float128} type:
979 On the PowerPC Linux VSX targets, you can declare complex types using
980 the corresponding internal complex type, @code{KCmode} for
981 @code{__float128} type and @code{ICmode} for @code{__ibm128} type:
983 @smallexample
984 typedef _Complex float __attribute__((mode(KC))) _Complex_float128;
985 typedef _Complex float __attribute__((mode(IC))) _Complex_ibm128;
986 @end smallexample
988 Not all targets support additional floating-point types.
989 @code{__float80} and @code{__float128} types are supported on x86 and
990 IA-64 targets.  The @code{__float128} type is supported on hppa HP-UX.
991 The @code{__float128} type is supported on PowerPC 64-bit Linux
992 systems by default if the vector scalar instruction set (VSX) is
993 enabled.  The @code{_Float128} type is supported on all systems where
994 @code{__float128} is supported or where @code{long double} has the
995 IEEE binary128 format.  The @code{_Float64x} type is supported on all
996 systems where @code{__float128} is supported.  The @code{_Float32}
997 type is supported on all systems supporting IEEE binary32; the
998 @code{_Float64} and @code{Float32x} types are supported on all systems
999 supporting IEEE binary64.  GCC does not currently support
1000 @code{_Float16} or @code{_Float128x} on any systems.
1002 On the PowerPC, @code{__ibm128} provides access to the IBM extended
1003 double format, and it is intended to be used by the library functions
1004 that handle conversions if/when long double is changed to be IEEE
1005 128-bit floating point.
1007 @node Half-Precision
1008 @section Half-Precision Floating Point
1009 @cindex half-precision floating point
1010 @cindex @code{__fp16} data type
1012 On ARM targets, GCC supports half-precision (16-bit) floating point via
1013 the @code{__fp16} type.  You must enable this type explicitly
1014 with the @option{-mfp16-format} command-line option in order to use it.
1016 ARM supports two incompatible representations for half-precision
1017 floating-point values.  You must choose one of the representations and
1018 use it consistently in your program.
1020 Specifying @option{-mfp16-format=ieee} selects the IEEE 754-2008 format.
1021 This format can represent normalized values in the range of @math{2^{-14}} to 65504.
1022 There are 11 bits of significand precision, approximately 3
1023 decimal digits.
1025 Specifying @option{-mfp16-format=alternative} selects the ARM
1026 alternative format.  This representation is similar to the IEEE
1027 format, but does not support infinities or NaNs.  Instead, the range
1028 of exponents is extended, so that this format can represent normalized
1029 values in the range of @math{2^{-14}} to 131008.
1031 The @code{__fp16} type is a storage format only.  For purposes
1032 of arithmetic and other operations, @code{__fp16} values in C or C++
1033 expressions are automatically promoted to @code{float}.  In addition,
1034 you cannot declare a function with a return value or parameters
1035 of type @code{__fp16}.
1037 Note that conversions from @code{double} to @code{__fp16}
1038 involve an intermediate conversion to @code{float}.  Because
1039 of rounding, this can sometimes produce a different result than a
1040 direct conversion.
1042 ARM provides hardware support for conversions between
1043 @code{__fp16} and @code{float} values
1044 as an extension to VFP and NEON (Advanced SIMD).  GCC generates
1045 code using these hardware instructions if you compile with
1046 options to select an FPU that provides them;
1047 for example, @option{-mfpu=neon-fp16 -mfloat-abi=softfp},
1048 in addition to the @option{-mfp16-format} option to select
1049 a half-precision format.
1051 Language-level support for the @code{__fp16} data type is
1052 independent of whether GCC generates code using hardware floating-point
1053 instructions.  In cases where hardware support is not specified, GCC
1054 implements conversions between @code{__fp16} and @code{float} values
1055 as library calls.
1057 @node Decimal Float
1058 @section Decimal Floating Types
1059 @cindex decimal floating types
1060 @cindex @code{_Decimal32} data type
1061 @cindex @code{_Decimal64} data type
1062 @cindex @code{_Decimal128} data type
1063 @cindex @code{df} integer suffix
1064 @cindex @code{dd} integer suffix
1065 @cindex @code{dl} integer suffix
1066 @cindex @code{DF} integer suffix
1067 @cindex @code{DD} integer suffix
1068 @cindex @code{DL} integer suffix
1070 As an extension, GNU C supports decimal floating types as
1071 defined in the N1312 draft of ISO/IEC WDTR24732.  Support for decimal
1072 floating types in GCC will evolve as the draft technical report changes.
1073 Calling conventions for any target might also change.  Not all targets
1074 support decimal floating types.
1076 The decimal floating types are @code{_Decimal32}, @code{_Decimal64}, and
1077 @code{_Decimal128}.  They use a radix of ten, unlike the floating types
1078 @code{float}, @code{double}, and @code{long double} whose radix is not
1079 specified by the C standard but is usually two.
1081 Support for decimal floating types includes the arithmetic operators
1082 add, subtract, multiply, divide; unary arithmetic operators;
1083 relational operators; equality operators; and conversions to and from
1084 integer and other floating types.  Use a suffix @samp{df} or
1085 @samp{DF} in a literal constant of type @code{_Decimal32}, @samp{dd}
1086 or @samp{DD} for @code{_Decimal64}, and @samp{dl} or @samp{DL} for
1087 @code{_Decimal128}.
1089 GCC support of decimal float as specified by the draft technical report
1090 is incomplete:
1092 @itemize @bullet
1093 @item
1094 When the value of a decimal floating type cannot be represented in the
1095 integer type to which it is being converted, the result is undefined
1096 rather than the result value specified by the draft technical report.
1098 @item
1099 GCC does not provide the C library functionality associated with
1100 @file{math.h}, @file{fenv.h}, @file{stdio.h}, @file{stdlib.h}, and
1101 @file{wchar.h}, which must come from a separate C library implementation.
1102 Because of this the GNU C compiler does not define macro
1103 @code{__STDC_DEC_FP__} to indicate that the implementation conforms to
1104 the technical report.
1105 @end itemize
1107 Types @code{_Decimal32}, @code{_Decimal64}, and @code{_Decimal128}
1108 are supported by the DWARF debug information format.
1110 @node Hex Floats
1111 @section Hex Floats
1112 @cindex hex floats
1114 ISO C99 supports floating-point numbers written not only in the usual
1115 decimal notation, such as @code{1.55e1}, but also numbers such as
1116 @code{0x1.fp3} written in hexadecimal format.  As a GNU extension, GCC
1117 supports this in C90 mode (except in some cases when strictly
1118 conforming) and in C++.  In that format the
1119 @samp{0x} hex introducer and the @samp{p} or @samp{P} exponent field are
1120 mandatory.  The exponent is a decimal number that indicates the power of
1121 2 by which the significant part is multiplied.  Thus @samp{0x1.f} is
1122 @tex
1123 $1 {15\over16}$,
1124 @end tex
1125 @ifnottex
1126 1 15/16,
1127 @end ifnottex
1128 @samp{p3} multiplies it by 8, and the value of @code{0x1.fp3}
1129 is the same as @code{1.55e1}.
1131 Unlike for floating-point numbers in the decimal notation the exponent
1132 is always required in the hexadecimal notation.  Otherwise the compiler
1133 would not be able to resolve the ambiguity of, e.g., @code{0x1.f}.  This
1134 could mean @code{1.0f} or @code{1.9375} since @samp{f} is also the
1135 extension for floating-point constants of type @code{float}.
1137 @node Fixed-Point
1138 @section Fixed-Point Types
1139 @cindex fixed-point types
1140 @cindex @code{_Fract} data type
1141 @cindex @code{_Accum} data type
1142 @cindex @code{_Sat} data type
1143 @cindex @code{hr} fixed-suffix
1144 @cindex @code{r} fixed-suffix
1145 @cindex @code{lr} fixed-suffix
1146 @cindex @code{llr} fixed-suffix
1147 @cindex @code{uhr} fixed-suffix
1148 @cindex @code{ur} fixed-suffix
1149 @cindex @code{ulr} fixed-suffix
1150 @cindex @code{ullr} fixed-suffix
1151 @cindex @code{hk} fixed-suffix
1152 @cindex @code{k} fixed-suffix
1153 @cindex @code{lk} fixed-suffix
1154 @cindex @code{llk} fixed-suffix
1155 @cindex @code{uhk} fixed-suffix
1156 @cindex @code{uk} fixed-suffix
1157 @cindex @code{ulk} fixed-suffix
1158 @cindex @code{ullk} fixed-suffix
1159 @cindex @code{HR} fixed-suffix
1160 @cindex @code{R} fixed-suffix
1161 @cindex @code{LR} fixed-suffix
1162 @cindex @code{LLR} fixed-suffix
1163 @cindex @code{UHR} fixed-suffix
1164 @cindex @code{UR} fixed-suffix
1165 @cindex @code{ULR} fixed-suffix
1166 @cindex @code{ULLR} fixed-suffix
1167 @cindex @code{HK} fixed-suffix
1168 @cindex @code{K} fixed-suffix
1169 @cindex @code{LK} fixed-suffix
1170 @cindex @code{LLK} fixed-suffix
1171 @cindex @code{UHK} fixed-suffix
1172 @cindex @code{UK} fixed-suffix
1173 @cindex @code{ULK} fixed-suffix
1174 @cindex @code{ULLK} fixed-suffix
1176 As an extension, GNU C supports fixed-point types as
1177 defined in the N1169 draft of ISO/IEC DTR 18037.  Support for fixed-point
1178 types in GCC will evolve as the draft technical report changes.
1179 Calling conventions for any target might also change.  Not all targets
1180 support fixed-point types.
1182 The fixed-point types are
1183 @code{short _Fract},
1184 @code{_Fract},
1185 @code{long _Fract},
1186 @code{long long _Fract},
1187 @code{unsigned short _Fract},
1188 @code{unsigned _Fract},
1189 @code{unsigned long _Fract},
1190 @code{unsigned long long _Fract},
1191 @code{_Sat short _Fract},
1192 @code{_Sat _Fract},
1193 @code{_Sat long _Fract},
1194 @code{_Sat long long _Fract},
1195 @code{_Sat unsigned short _Fract},
1196 @code{_Sat unsigned _Fract},
1197 @code{_Sat unsigned long _Fract},
1198 @code{_Sat unsigned long long _Fract},
1199 @code{short _Accum},
1200 @code{_Accum},
1201 @code{long _Accum},
1202 @code{long long _Accum},
1203 @code{unsigned short _Accum},
1204 @code{unsigned _Accum},
1205 @code{unsigned long _Accum},
1206 @code{unsigned long long _Accum},
1207 @code{_Sat short _Accum},
1208 @code{_Sat _Accum},
1209 @code{_Sat long _Accum},
1210 @code{_Sat long long _Accum},
1211 @code{_Sat unsigned short _Accum},
1212 @code{_Sat unsigned _Accum},
1213 @code{_Sat unsigned long _Accum},
1214 @code{_Sat unsigned long long _Accum}.
1216 Fixed-point data values contain fractional and optional integral parts.
1217 The format of fixed-point data varies and depends on the target machine.
1219 Support for fixed-point types includes:
1220 @itemize @bullet
1221 @item
1222 prefix and postfix increment and decrement operators (@code{++}, @code{--})
1223 @item
1224 unary arithmetic operators (@code{+}, @code{-}, @code{!})
1225 @item
1226 binary arithmetic operators (@code{+}, @code{-}, @code{*}, @code{/})
1227 @item
1228 binary shift operators (@code{<<}, @code{>>})
1229 @item
1230 relational operators (@code{<}, @code{<=}, @code{>=}, @code{>})
1231 @item
1232 equality operators (@code{==}, @code{!=})
1233 @item
1234 assignment operators (@code{+=}, @code{-=}, @code{*=}, @code{/=},
1235 @code{<<=}, @code{>>=})
1236 @item
1237 conversions to and from integer, floating-point, or fixed-point types
1238 @end itemize
1240 Use a suffix in a fixed-point literal constant:
1241 @itemize
1242 @item @samp{hr} or @samp{HR} for @code{short _Fract} and
1243 @code{_Sat short _Fract}
1244 @item @samp{r} or @samp{R} for @code{_Fract} and @code{_Sat _Fract}
1245 @item @samp{lr} or @samp{LR} for @code{long _Fract} and
1246 @code{_Sat long _Fract}
1247 @item @samp{llr} or @samp{LLR} for @code{long long _Fract} and
1248 @code{_Sat long long _Fract}
1249 @item @samp{uhr} or @samp{UHR} for @code{unsigned short _Fract} and
1250 @code{_Sat unsigned short _Fract}
1251 @item @samp{ur} or @samp{UR} for @code{unsigned _Fract} and
1252 @code{_Sat unsigned _Fract}
1253 @item @samp{ulr} or @samp{ULR} for @code{unsigned long _Fract} and
1254 @code{_Sat unsigned long _Fract}
1255 @item @samp{ullr} or @samp{ULLR} for @code{unsigned long long _Fract}
1256 and @code{_Sat unsigned long long _Fract}
1257 @item @samp{hk} or @samp{HK} for @code{short _Accum} and
1258 @code{_Sat short _Accum}
1259 @item @samp{k} or @samp{K} for @code{_Accum} and @code{_Sat _Accum}
1260 @item @samp{lk} or @samp{LK} for @code{long _Accum} and
1261 @code{_Sat long _Accum}
1262 @item @samp{llk} or @samp{LLK} for @code{long long _Accum} and
1263 @code{_Sat long long _Accum}
1264 @item @samp{uhk} or @samp{UHK} for @code{unsigned short _Accum} and
1265 @code{_Sat unsigned short _Accum}
1266 @item @samp{uk} or @samp{UK} for @code{unsigned _Accum} and
1267 @code{_Sat unsigned _Accum}
1268 @item @samp{ulk} or @samp{ULK} for @code{unsigned long _Accum} and
1269 @code{_Sat unsigned long _Accum}
1270 @item @samp{ullk} or @samp{ULLK} for @code{unsigned long long _Accum}
1271 and @code{_Sat unsigned long long _Accum}
1272 @end itemize
1274 GCC support of fixed-point types as specified by the draft technical report
1275 is incomplete:
1277 @itemize @bullet
1278 @item
1279 Pragmas to control overflow and rounding behaviors are not implemented.
1280 @end itemize
1282 Fixed-point types are supported by the DWARF debug information format.
1284 @node Named Address Spaces
1285 @section Named Address Spaces
1286 @cindex Named Address Spaces
1288 As an extension, GNU C supports named address spaces as
1289 defined in the N1275 draft of ISO/IEC DTR 18037.  Support for named
1290 address spaces in GCC will evolve as the draft technical report
1291 changes.  Calling conventions for any target might also change.  At
1292 present, only the AVR, SPU, M32C, RL78, and x86 targets support
1293 address spaces other than the generic address space.
1295 Address space identifiers may be used exactly like any other C type
1296 qualifier (e.g., @code{const} or @code{volatile}).  See the N1275
1297 document for more details.
1299 @anchor{AVR Named Address Spaces}
1300 @subsection AVR Named Address Spaces
1302 On the AVR target, there are several address spaces that can be used
1303 in order to put read-only data into the flash memory and access that
1304 data by means of the special instructions @code{LPM} or @code{ELPM}
1305 needed to read from flash.
1307 Per default, any data including read-only data is located in RAM
1308 (the generic address space) so that non-generic address spaces are
1309 needed to locate read-only data in flash memory
1310 @emph{and} to generate the right instructions to access this data
1311 without using (inline) assembler code.
1313 @table @code
1314 @item __flash
1315 @cindex @code{__flash} AVR Named Address Spaces
1316 The @code{__flash} qualifier locates data in the
1317 @code{.progmem.data} section. Data is read using the @code{LPM}
1318 instruction. Pointers to this address space are 16 bits wide.
1320 @item __flash1
1321 @itemx __flash2
1322 @itemx __flash3
1323 @itemx __flash4
1324 @itemx __flash5
1325 @cindex @code{__flash1} AVR Named Address Spaces
1326 @cindex @code{__flash2} AVR Named Address Spaces
1327 @cindex @code{__flash3} AVR Named Address Spaces
1328 @cindex @code{__flash4} AVR Named Address Spaces
1329 @cindex @code{__flash5} AVR Named Address Spaces
1330 These are 16-bit address spaces locating data in section
1331 @code{.progmem@var{N}.data} where @var{N} refers to
1332 address space @code{__flash@var{N}}.
1333 The compiler sets the @code{RAMPZ} segment register appropriately 
1334 before reading data by means of the @code{ELPM} instruction.
1336 @item __memx
1337 @cindex @code{__memx} AVR Named Address Spaces
1338 This is a 24-bit address space that linearizes flash and RAM:
1339 If the high bit of the address is set, data is read from
1340 RAM using the lower two bytes as RAM address.
1341 If the high bit of the address is clear, data is read from flash
1342 with @code{RAMPZ} set according to the high byte of the address.
1343 @xref{AVR Built-in Functions,,@code{__builtin_avr_flash_segment}}.
1345 Objects in this address space are located in @code{.progmemx.data}.
1346 @end table
1348 @b{Example}
1350 @smallexample
1351 char my_read (const __flash char ** p)
1353     /* p is a pointer to RAM that points to a pointer to flash.
1354        The first indirection of p reads that flash pointer
1355        from RAM and the second indirection reads a char from this
1356        flash address.  */
1358     return **p;
1361 /* Locate array[] in flash memory */
1362 const __flash int array[] = @{ 3, 5, 7, 11, 13, 17, 19 @};
1364 int i = 1;
1366 int main (void)
1368    /* Return 17 by reading from flash memory */
1369    return array[array[i]];
1371 @end smallexample
1373 @noindent
1374 For each named address space supported by avr-gcc there is an equally
1375 named but uppercase built-in macro defined. 
1376 The purpose is to facilitate testing if respective address space
1377 support is available or not:
1379 @smallexample
1380 #ifdef __FLASH
1381 const __flash int var = 1;
1383 int read_var (void)
1385     return var;
1387 #else
1388 #include <avr/pgmspace.h> /* From AVR-LibC */
1390 const int var PROGMEM = 1;
1392 int read_var (void)
1394     return (int) pgm_read_word (&var);
1396 #endif /* __FLASH */
1397 @end smallexample
1399 @noindent
1400 Notice that attribute @ref{AVR Variable Attributes,,@code{progmem}}
1401 locates data in flash but
1402 accesses to these data read from generic address space, i.e.@:
1403 from RAM,
1404 so that you need special accessors like @code{pgm_read_byte}
1405 from @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC}}
1406 together with attribute @code{progmem}.
1408 @noindent
1409 @b{Limitations and caveats}
1411 @itemize
1412 @item
1413 Reading across the 64@tie{}KiB section boundary of
1414 the @code{__flash} or @code{__flash@var{N}} address spaces
1415 shows undefined behavior. The only address space that
1416 supports reading across the 64@tie{}KiB flash segment boundaries is
1417 @code{__memx}.
1419 @item
1420 If you use one of the @code{__flash@var{N}} address spaces
1421 you must arrange your linker script to locate the
1422 @code{.progmem@var{N}.data} sections according to your needs.
1424 @item
1425 Any data or pointers to the non-generic address spaces must
1426 be qualified as @code{const}, i.e.@: as read-only data.
1427 This still applies if the data in one of these address
1428 spaces like software version number or calibration lookup table are intended to
1429 be changed after load time by, say, a boot loader. In this case
1430 the right qualification is @code{const} @code{volatile} so that the compiler
1431 must not optimize away known values or insert them
1432 as immediates into operands of instructions.
1434 @item
1435 The following code initializes a variable @code{pfoo}
1436 located in static storage with a 24-bit address:
1437 @smallexample
1438 extern const __memx char foo;
1439 const __memx void *pfoo = &foo;
1440 @end smallexample
1442 @noindent
1443 Such code requires at least binutils 2.23, see
1444 @w{@uref{http://sourceware.org/PR13503,PR13503}}.
1446 @item
1447 On the reduced Tiny devices like ATtiny40, no address spaces are supported.
1448 Data can be put into and read from flash memory by means of
1449 attribute @code{progmem}, see @ref{AVR Variable Attributes}.
1451 @end itemize
1453 @subsection M32C Named Address Spaces
1454 @cindex @code{__far} M32C Named Address Spaces
1456 On the M32C target, with the R8C and M16C CPU variants, variables
1457 qualified with @code{__far} are accessed using 32-bit addresses in
1458 order to access memory beyond the first 64@tie{}Ki bytes.  If
1459 @code{__far} is used with the M32CM or M32C CPU variants, it has no
1460 effect.
1462 @subsection RL78 Named Address Spaces
1463 @cindex @code{__far} RL78 Named Address Spaces
1465 On the RL78 target, variables qualified with @code{__far} are accessed
1466 with 32-bit pointers (20-bit addresses) rather than the default 16-bit
1467 addresses.  Non-far variables are assumed to appear in the topmost
1468 64@tie{}KiB of the address space.
1470 @subsection SPU Named Address Spaces
1471 @cindex @code{__ea} SPU Named Address Spaces
1473 On the SPU target variables may be declared as
1474 belonging to another address space by qualifying the type with the
1475 @code{__ea} address space identifier:
1477 @smallexample
1478 extern int __ea i;
1479 @end smallexample
1481 @noindent 
1482 The compiler generates special code to access the variable @code{i}.
1483 It may use runtime library
1484 support, or generate special machine instructions to access that address
1485 space.
1487 @subsection x86 Named Address Spaces
1488 @cindex x86 named address spaces
1490 On the x86 target, variables may be declared as being relative
1491 to the @code{%fs} or @code{%gs} segments.
1493 @table @code
1494 @item __seg_fs
1495 @itemx __seg_gs
1496 @cindex @code{__seg_fs} x86 named address space
1497 @cindex @code{__seg_gs} x86 named address space
1498 The object is accessed with the respective segment override prefix.
1500 The respective segment base must be set via some method specific to
1501 the operating system.  Rather than require an expensive system call
1502 to retrieve the segment base, these address spaces are not considered
1503 to be subspaces of the generic (flat) address space.  This means that
1504 explicit casts are required to convert pointers between these address
1505 spaces and the generic address space.  In practice the application
1506 should cast to @code{uintptr_t} and apply the segment base offset
1507 that it installed previously.
1509 The preprocessor symbols @code{__SEG_FS} and @code{__SEG_GS} are
1510 defined when these address spaces are supported.
1511 @end table
1513 @node Zero Length
1514 @section Arrays of Length Zero
1515 @cindex arrays of length zero
1516 @cindex zero-length arrays
1517 @cindex length-zero arrays
1518 @cindex flexible array members
1520 Zero-length arrays are allowed in GNU C@.  They are very useful as the
1521 last element of a structure that is really a header for a variable-length
1522 object:
1524 @smallexample
1525 struct line @{
1526   int length;
1527   char contents[0];
1530 struct line *thisline = (struct line *)
1531   malloc (sizeof (struct line) + this_length);
1532 thisline->length = this_length;
1533 @end smallexample
1535 In ISO C90, you would have to give @code{contents} a length of 1, which
1536 means either you waste space or complicate the argument to @code{malloc}.
1538 In ISO C99, you would use a @dfn{flexible array member}, which is
1539 slightly different in syntax and semantics:
1541 @itemize @bullet
1542 @item
1543 Flexible array members are written as @code{contents[]} without
1544 the @code{0}.
1546 @item
1547 Flexible array members have incomplete type, and so the @code{sizeof}
1548 operator may not be applied.  As a quirk of the original implementation
1549 of zero-length arrays, @code{sizeof} evaluates to zero.
1551 @item
1552 Flexible array members may only appear as the last member of a
1553 @code{struct} that is otherwise non-empty.
1555 @item
1556 A structure containing a flexible array member, or a union containing
1557 such a structure (possibly recursively), may not be a member of a
1558 structure or an element of an array.  (However, these uses are
1559 permitted by GCC as extensions.)
1560 @end itemize
1562 Non-empty initialization of zero-length
1563 arrays is treated like any case where there are more initializer
1564 elements than the array holds, in that a suitable warning about ``excess
1565 elements in array'' is given, and the excess elements (all of them, in
1566 this case) are ignored.
1568 GCC allows static initialization of flexible array members.
1569 This is equivalent to defining a new structure containing the original
1570 structure followed by an array of sufficient size to contain the data.
1571 E.g.@: in the following, @code{f1} is constructed as if it were declared
1572 like @code{f2}.
1574 @smallexample
1575 struct f1 @{
1576   int x; int y[];
1577 @} f1 = @{ 1, @{ 2, 3, 4 @} @};
1579 struct f2 @{
1580   struct f1 f1; int data[3];
1581 @} f2 = @{ @{ 1 @}, @{ 2, 3, 4 @} @};
1582 @end smallexample
1584 @noindent
1585 The convenience of this extension is that @code{f1} has the desired
1586 type, eliminating the need to consistently refer to @code{f2.f1}.
1588 This has symmetry with normal static arrays, in that an array of
1589 unknown size is also written with @code{[]}.
1591 Of course, this extension only makes sense if the extra data comes at
1592 the end of a top-level object, as otherwise we would be overwriting
1593 data at subsequent offsets.  To avoid undue complication and confusion
1594 with initialization of deeply nested arrays, we simply disallow any
1595 non-empty initialization except when the structure is the top-level
1596 object.  For example:
1598 @smallexample
1599 struct foo @{ int x; int y[]; @};
1600 struct bar @{ struct foo z; @};
1602 struct foo a = @{ 1, @{ 2, 3, 4 @} @};        // @r{Valid.}
1603 struct bar b = @{ @{ 1, @{ 2, 3, 4 @} @} @};    // @r{Invalid.}
1604 struct bar c = @{ @{ 1, @{ @} @} @};            // @r{Valid.}
1605 struct foo d[1] = @{ @{ 1, @{ 2, 3, 4 @} @} @};  // @r{Invalid.}
1606 @end smallexample
1608 @node Empty Structures
1609 @section Structures with No Members
1610 @cindex empty structures
1611 @cindex zero-size structures
1613 GCC permits a C structure to have no members:
1615 @smallexample
1616 struct empty @{
1618 @end smallexample
1620 The structure has size zero.  In C++, empty structures are part
1621 of the language.  G++ treats empty structures as if they had a single
1622 member of type @code{char}.
1624 @node Variable Length
1625 @section Arrays of Variable Length
1626 @cindex variable-length arrays
1627 @cindex arrays of variable length
1628 @cindex VLAs
1630 Variable-length automatic arrays are allowed in ISO C99, and as an
1631 extension GCC accepts them in C90 mode and in C++.  These arrays are
1632 declared like any other automatic arrays, but with a length that is not
1633 a constant expression.  The storage is allocated at the point of
1634 declaration and deallocated when the block scope containing the declaration
1635 exits.  For
1636 example:
1638 @smallexample
1639 FILE *
1640 concat_fopen (char *s1, char *s2, char *mode)
1642   char str[strlen (s1) + strlen (s2) + 1];
1643   strcpy (str, s1);
1644   strcat (str, s2);
1645   return fopen (str, mode);
1647 @end smallexample
1649 @cindex scope of a variable length array
1650 @cindex variable-length array scope
1651 @cindex deallocating variable length arrays
1652 Jumping or breaking out of the scope of the array name deallocates the
1653 storage.  Jumping into the scope is not allowed; you get an error
1654 message for it.
1656 @cindex variable-length array in a structure
1657 As an extension, GCC accepts variable-length arrays as a member of
1658 a structure or a union.  For example:
1660 @smallexample
1661 void
1662 foo (int n)
1664   struct S @{ int x[n]; @};
1666 @end smallexample
1668 @cindex @code{alloca} vs variable-length arrays
1669 You can use the function @code{alloca} to get an effect much like
1670 variable-length arrays.  The function @code{alloca} is available in
1671 many other C implementations (but not in all).  On the other hand,
1672 variable-length arrays are more elegant.
1674 There are other differences between these two methods.  Space allocated
1675 with @code{alloca} exists until the containing @emph{function} returns.
1676 The space for a variable-length array is deallocated as soon as the array
1677 name's scope ends, unless you also use @code{alloca} in this scope.
1679 You can also use variable-length arrays as arguments to functions:
1681 @smallexample
1682 struct entry
1683 tester (int len, char data[len][len])
1685   /* @r{@dots{}} */
1687 @end smallexample
1689 The length of an array is computed once when the storage is allocated
1690 and is remembered for the scope of the array in case you access it with
1691 @code{sizeof}.
1693 If you want to pass the array first and the length afterward, you can
1694 use a forward declaration in the parameter list---another GNU extension.
1696 @smallexample
1697 struct entry
1698 tester (int len; char data[len][len], int len)
1700   /* @r{@dots{}} */
1702 @end smallexample
1704 @cindex parameter forward declaration
1705 The @samp{int len} before the semicolon is a @dfn{parameter forward
1706 declaration}, and it serves the purpose of making the name @code{len}
1707 known when the declaration of @code{data} is parsed.
1709 You can write any number of such parameter forward declarations in the
1710 parameter list.  They can be separated by commas or semicolons, but the
1711 last one must end with a semicolon, which is followed by the ``real''
1712 parameter declarations.  Each forward declaration must match a ``real''
1713 declaration in parameter name and data type.  ISO C99 does not support
1714 parameter forward declarations.
1716 @node Variadic Macros
1717 @section Macros with a Variable Number of Arguments.
1718 @cindex variable number of arguments
1719 @cindex macro with variable arguments
1720 @cindex rest argument (in macro)
1721 @cindex variadic macros
1723 In the ISO C standard of 1999, a macro can be declared to accept a
1724 variable number of arguments much as a function can.  The syntax for
1725 defining the macro is similar to that of a function.  Here is an
1726 example:
1728 @smallexample
1729 #define debug(format, ...) fprintf (stderr, format, __VA_ARGS__)
1730 @end smallexample
1732 @noindent
1733 Here @samp{@dots{}} is a @dfn{variable argument}.  In the invocation of
1734 such a macro, it represents the zero or more tokens until the closing
1735 parenthesis that ends the invocation, including any commas.  This set of
1736 tokens replaces the identifier @code{__VA_ARGS__} in the macro body
1737 wherever it appears.  See the CPP manual for more information.
1739 GCC has long supported variadic macros, and used a different syntax that
1740 allowed you to give a name to the variable arguments just like any other
1741 argument.  Here is an example:
1743 @smallexample
1744 #define debug(format, args...) fprintf (stderr, format, args)
1745 @end smallexample
1747 @noindent
1748 This is in all ways equivalent to the ISO C example above, but arguably
1749 more readable and descriptive.
1751 GNU CPP has two further variadic macro extensions, and permits them to
1752 be used with either of the above forms of macro definition.
1754 In standard C, you are not allowed to leave the variable argument out
1755 entirely; but you are allowed to pass an empty argument.  For example,
1756 this invocation is invalid in ISO C, because there is no comma after
1757 the string:
1759 @smallexample
1760 debug ("A message")
1761 @end smallexample
1763 GNU CPP permits you to completely omit the variable arguments in this
1764 way.  In the above examples, the compiler would complain, though since
1765 the expansion of the macro still has the extra comma after the format
1766 string.
1768 To help solve this problem, CPP behaves specially for variable arguments
1769 used with the token paste operator, @samp{##}.  If instead you write
1771 @smallexample
1772 #define debug(format, ...) fprintf (stderr, format, ## __VA_ARGS__)
1773 @end smallexample
1775 @noindent
1776 and if the variable arguments are omitted or empty, the @samp{##}
1777 operator causes the preprocessor to remove the comma before it.  If you
1778 do provide some variable arguments in your macro invocation, GNU CPP
1779 does not complain about the paste operation and instead places the
1780 variable arguments after the comma.  Just like any other pasted macro
1781 argument, these arguments are not macro expanded.
1783 @node Escaped Newlines
1784 @section Slightly Looser Rules for Escaped Newlines
1785 @cindex escaped newlines
1786 @cindex newlines (escaped)
1788 The preprocessor treatment of escaped newlines is more relaxed 
1789 than that specified by the C90 standard, which requires the newline
1790 to immediately follow a backslash.  
1791 GCC's implementation allows whitespace in the form
1792 of spaces, horizontal and vertical tabs, and form feeds between the
1793 backslash and the subsequent newline.  The preprocessor issues a
1794 warning, but treats it as a valid escaped newline and combines the two
1795 lines to form a single logical line.  This works within comments and
1796 tokens, as well as between tokens.  Comments are @emph{not} treated as
1797 whitespace for the purposes of this relaxation, since they have not
1798 yet been replaced with spaces.
1800 @node Subscripting
1801 @section Non-Lvalue Arrays May Have Subscripts
1802 @cindex subscripting
1803 @cindex arrays, non-lvalue
1805 @cindex subscripting and function values
1806 In ISO C99, arrays that are not lvalues still decay to pointers, and
1807 may be subscripted, although they may not be modified or used after
1808 the next sequence point and the unary @samp{&} operator may not be
1809 applied to them.  As an extension, GNU C allows such arrays to be
1810 subscripted in C90 mode, though otherwise they do not decay to
1811 pointers outside C99 mode.  For example,
1812 this is valid in GNU C though not valid in C90:
1814 @smallexample
1815 @group
1816 struct foo @{int a[4];@};
1818 struct foo f();
1820 bar (int index)
1822   return f().a[index];
1824 @end group
1825 @end smallexample
1827 @node Pointer Arith
1828 @section Arithmetic on @code{void}- and Function-Pointers
1829 @cindex void pointers, arithmetic
1830 @cindex void, size of pointer to
1831 @cindex function pointers, arithmetic
1832 @cindex function, size of pointer to
1834 In GNU C, addition and subtraction operations are supported on pointers to
1835 @code{void} and on pointers to functions.  This is done by treating the
1836 size of a @code{void} or of a function as 1.
1838 A consequence of this is that @code{sizeof} is also allowed on @code{void}
1839 and on function types, and returns 1.
1841 @opindex Wpointer-arith
1842 The option @option{-Wpointer-arith} requests a warning if these extensions
1843 are used.
1845 @node Pointers to Arrays
1846 @section Pointers to Arrays with Qualifiers Work as Expected
1847 @cindex pointers to arrays
1848 @cindex const qualifier
1850 In GNU C, pointers to arrays with qualifiers work similar to pointers
1851 to other qualified types. For example, a value of type @code{int (*)[5]}
1852 can be used to initialize a variable of type @code{const int (*)[5]}.
1853 These types are incompatible in ISO C because the @code{const} qualifier
1854 is formally attached to the element type of the array and not the
1855 array itself.
1857 @smallexample
1858 extern void
1859 transpose (int N, int M, double out[M][N], const double in[N][M]);
1860 double x[3][2];
1861 double y[2][3];
1862 @r{@dots{}}
1863 transpose(3, 2, y, x);
1864 @end smallexample
1866 @node Initializers
1867 @section Non-Constant Initializers
1868 @cindex initializers, non-constant
1869 @cindex non-constant initializers
1871 As in standard C++ and ISO C99, the elements of an aggregate initializer for an
1872 automatic variable are not required to be constant expressions in GNU C@.
1873 Here is an example of an initializer with run-time varying elements:
1875 @smallexample
1876 foo (float f, float g)
1878   float beat_freqs[2] = @{ f-g, f+g @};
1879   /* @r{@dots{}} */
1881 @end smallexample
1883 @node Compound Literals
1884 @section Compound Literals
1885 @cindex constructor expressions
1886 @cindex initializations in expressions
1887 @cindex structures, constructor expression
1888 @cindex expressions, constructor
1889 @cindex compound literals
1890 @c The GNU C name for what C99 calls compound literals was "constructor expressions".
1892 A compound literal looks like a cast of a brace-enclosed aggregate
1893 initializer list.  Its value is an object of the type specified in
1894 the cast, containing the elements specified in the initializer.
1895 Unlike the result of a cast, a compound literal is an lvalue.  ISO
1896 C99 and later support compound literals.  As an extension, GCC
1897 supports compound literals also in C90 mode and in C++, although
1898 as explained below, the C++ semantics are somewhat different.
1900 Usually, the specified type of a compound literal is a structure.  Assume
1901 that @code{struct foo} and @code{structure} are declared as shown:
1903 @smallexample
1904 struct foo @{int a; char b[2];@} structure;
1905 @end smallexample
1907 @noindent
1908 Here is an example of constructing a @code{struct foo} with a compound literal:
1910 @smallexample
1911 structure = ((struct foo) @{x + y, 'a', 0@});
1912 @end smallexample
1914 @noindent
1915 This is equivalent to writing the following:
1917 @smallexample
1919   struct foo temp = @{x + y, 'a', 0@};
1920   structure = temp;
1922 @end smallexample
1924 You can also construct an array, though this is dangerous in C++, as
1925 explained below.  If all the elements of the compound literal are
1926 (made up of) simple constant expressions suitable for use in
1927 initializers of objects of static storage duration, then the compound
1928 literal can be coerced to a pointer to its first element and used in
1929 such an initializer, as shown here:
1931 @smallexample
1932 char **foo = (char *[]) @{ "x", "y", "z" @};
1933 @end smallexample
1935 Compound literals for scalar types and union types are also allowed.  In
1936 the following example the variable @code{i} is initialized to the value
1937 @code{2}, the result of incrementing the unnamed object created by
1938 the compound literal.
1940 @smallexample
1941 int i = ++(int) @{ 1 @};
1942 @end smallexample
1944 As a GNU extension, GCC allows initialization of objects with static storage
1945 duration by compound literals (which is not possible in ISO C99 because
1946 the initializer is not a constant).
1947 It is handled as if the object were initialized only with the brace-enclosed
1948 list if the types of the compound literal and the object match.
1949 The elements of the compound literal must be constant.
1950 If the object being initialized has array type of unknown size, the size is
1951 determined by the size of the compound literal.
1953 @smallexample
1954 static struct foo x = (struct foo) @{1, 'a', 'b'@};
1955 static int y[] = (int []) @{1, 2, 3@};
1956 static int z[] = (int [3]) @{1@};
1957 @end smallexample
1959 @noindent
1960 The above lines are equivalent to the following:
1961 @smallexample
1962 static struct foo x = @{1, 'a', 'b'@};
1963 static int y[] = @{1, 2, 3@};
1964 static int z[] = @{1, 0, 0@};
1965 @end smallexample
1967 In C, a compound literal designates an unnamed object with static or
1968 automatic storage duration.  In C++, a compound literal designates a
1969 temporary object that only lives until the end of its full-expression.
1970 As a result, well-defined C code that takes the address of a subobject
1971 of a compound literal can be undefined in C++, so G++ rejects
1972 the conversion of a temporary array to a pointer.  For instance, if
1973 the array compound literal example above appeared inside a function,
1974 any subsequent use of @code{foo} in C++ would have undefined behavior
1975 because the lifetime of the array ends after the declaration of @code{foo}.
1977 As an optimization, G++ sometimes gives array compound literals longer
1978 lifetimes: when the array either appears outside a function or has
1979 a @code{const}-qualified type.  If @code{foo} and its initializer had
1980 elements of type @code{char *const} rather than @code{char *}, or if
1981 @code{foo} were a global variable, the array would have static storage
1982 duration.  But it is probably safest just to avoid the use of array
1983 compound literals in C++ code.
1985 @node Designated Inits
1986 @section Designated Initializers
1987 @cindex initializers with labeled elements
1988 @cindex labeled elements in initializers
1989 @cindex case labels in initializers
1990 @cindex designated initializers
1992 Standard C90 requires the elements of an initializer to appear in a fixed
1993 order, the same as the order of the elements in the array or structure
1994 being initialized.
1996 In ISO C99 you can give the elements in any order, specifying the array
1997 indices or structure field names they apply to, and GNU C allows this as
1998 an extension in C90 mode as well.  This extension is not
1999 implemented in GNU C++.
2001 To specify an array index, write
2002 @samp{[@var{index}] =} before the element value.  For example,
2004 @smallexample
2005 int a[6] = @{ [4] = 29, [2] = 15 @};
2006 @end smallexample
2008 @noindent
2009 is equivalent to
2011 @smallexample
2012 int a[6] = @{ 0, 0, 15, 0, 29, 0 @};
2013 @end smallexample
2015 @noindent
2016 The index values must be constant expressions, even if the array being
2017 initialized is automatic.
2019 An alternative syntax for this that has been obsolete since GCC 2.5 but
2020 GCC still accepts is to write @samp{[@var{index}]} before the element
2021 value, with no @samp{=}.
2023 To initialize a range of elements to the same value, write
2024 @samp{[@var{first} ... @var{last}] = @var{value}}.  This is a GNU
2025 extension.  For example,
2027 @smallexample
2028 int widths[] = @{ [0 ... 9] = 1, [10 ... 99] = 2, [100] = 3 @};
2029 @end smallexample
2031 @noindent
2032 If the value in it has side-effects, the side-effects happen only once,
2033 not for each initialized field by the range initializer.
2035 @noindent
2036 Note that the length of the array is the highest value specified
2037 plus one.
2039 In a structure initializer, specify the name of a field to initialize
2040 with @samp{.@var{fieldname} =} before the element value.  For example,
2041 given the following structure,
2043 @smallexample
2044 struct point @{ int x, y; @};
2045 @end smallexample
2047 @noindent
2048 the following initialization
2050 @smallexample
2051 struct point p = @{ .y = yvalue, .x = xvalue @};
2052 @end smallexample
2054 @noindent
2055 is equivalent to
2057 @smallexample
2058 struct point p = @{ xvalue, yvalue @};
2059 @end smallexample
2061 Another syntax that has the same meaning, obsolete since GCC 2.5, is
2062 @samp{@var{fieldname}:}, as shown here:
2064 @smallexample
2065 struct point p = @{ y: yvalue, x: xvalue @};
2066 @end smallexample
2068 Omitted field members are implicitly initialized the same as objects
2069 that have static storage duration.
2071 @cindex designators
2072 The @samp{[@var{index}]} or @samp{.@var{fieldname}} is known as a
2073 @dfn{designator}.  You can also use a designator (or the obsolete colon
2074 syntax) when initializing a union, to specify which element of the union
2075 should be used.  For example,
2077 @smallexample
2078 union foo @{ int i; double d; @};
2080 union foo f = @{ .d = 4 @};
2081 @end smallexample
2083 @noindent
2084 converts 4 to a @code{double} to store it in the union using
2085 the second element.  By contrast, casting 4 to type @code{union foo}
2086 stores it into the union as the integer @code{i}, since it is
2087 an integer.  (@xref{Cast to Union}.)
2089 You can combine this technique of naming elements with ordinary C
2090 initialization of successive elements.  Each initializer element that
2091 does not have a designator applies to the next consecutive element of the
2092 array or structure.  For example,
2094 @smallexample
2095 int a[6] = @{ [1] = v1, v2, [4] = v4 @};
2096 @end smallexample
2098 @noindent
2099 is equivalent to
2101 @smallexample
2102 int a[6] = @{ 0, v1, v2, 0, v4, 0 @};
2103 @end smallexample
2105 Labeling the elements of an array initializer is especially useful
2106 when the indices are characters or belong to an @code{enum} type.
2107 For example:
2109 @smallexample
2110 int whitespace[256]
2111   = @{ [' '] = 1, ['\t'] = 1, ['\h'] = 1,
2112       ['\f'] = 1, ['\n'] = 1, ['\r'] = 1 @};
2113 @end smallexample
2115 @cindex designator lists
2116 You can also write a series of @samp{.@var{fieldname}} and
2117 @samp{[@var{index}]} designators before an @samp{=} to specify a
2118 nested subobject to initialize; the list is taken relative to the
2119 subobject corresponding to the closest surrounding brace pair.  For
2120 example, with the @samp{struct point} declaration above:
2122 @smallexample
2123 struct point ptarray[10] = @{ [2].y = yv2, [2].x = xv2, [0].x = xv0 @};
2124 @end smallexample
2126 @noindent
2127 If the same field is initialized multiple times, it has the value from
2128 the last initialization.  If any such overridden initialization has
2129 side-effect, it is unspecified whether the side-effect happens or not.
2130 Currently, GCC discards them and issues a warning.
2132 @node Case Ranges
2133 @section Case Ranges
2134 @cindex case ranges
2135 @cindex ranges in case statements
2137 You can specify a range of consecutive values in a single @code{case} label,
2138 like this:
2140 @smallexample
2141 case @var{low} ... @var{high}:
2142 @end smallexample
2144 @noindent
2145 This has the same effect as the proper number of individual @code{case}
2146 labels, one for each integer value from @var{low} to @var{high}, inclusive.
2148 This feature is especially useful for ranges of ASCII character codes:
2150 @smallexample
2151 case 'A' ... 'Z':
2152 @end smallexample
2154 @strong{Be careful:} Write spaces around the @code{...}, for otherwise
2155 it may be parsed wrong when you use it with integer values.  For example,
2156 write this:
2158 @smallexample
2159 case 1 ... 5:
2160 @end smallexample
2162 @noindent
2163 rather than this:
2165 @smallexample
2166 case 1...5:
2167 @end smallexample
2169 @node Cast to Union
2170 @section Cast to a Union Type
2171 @cindex cast to a union
2172 @cindex union, casting to a
2174 A cast to union type looks similar to other casts, except that the type
2175 specified is a union type.  You can specify the type either with the
2176 @code{union} keyword or with a @code{typedef} name that refers to
2177 a union.  A cast to a union actually creates a compound literal and
2178 yields an lvalue, not an rvalue like true casts do.
2179 (@xref{Compound Literals}.)
2181 The types that may be cast to the union type are those of the members
2182 of the union.  Thus, given the following union and variables:
2184 @smallexample
2185 union foo @{ int i; double d; @};
2186 int x;
2187 double y;
2188 @end smallexample
2190 @noindent
2191 both @code{x} and @code{y} can be cast to type @code{union foo}.
2193 Using the cast as the right-hand side of an assignment to a variable of
2194 union type is equivalent to storing in a member of the union:
2196 @smallexample
2197 union foo u;
2198 /* @r{@dots{}} */
2199 u = (union foo) x  @equiv{}  u.i = x
2200 u = (union foo) y  @equiv{}  u.d = y
2201 @end smallexample
2203 You can also use the union cast as a function argument:
2205 @smallexample
2206 void hack (union foo);
2207 /* @r{@dots{}} */
2208 hack ((union foo) x);
2209 @end smallexample
2211 @node Mixed Declarations
2212 @section Mixed Declarations and Code
2213 @cindex mixed declarations and code
2214 @cindex declarations, mixed with code
2215 @cindex code, mixed with declarations
2217 ISO C99 and ISO C++ allow declarations and code to be freely mixed
2218 within compound statements.  As an extension, GNU C also allows this in
2219 C90 mode.  For example, you could do:
2221 @smallexample
2222 int i;
2223 /* @r{@dots{}} */
2224 i++;
2225 int j = i + 2;
2226 @end smallexample
2228 Each identifier is visible from where it is declared until the end of
2229 the enclosing block.
2231 @node Function Attributes
2232 @section Declaring Attributes of Functions
2233 @cindex function attributes
2234 @cindex declaring attributes of functions
2235 @cindex @code{volatile} applied to function
2236 @cindex @code{const} applied to function
2238 In GNU C, you can use function attributes to declare certain things
2239 about functions called in your program which help the compiler
2240 optimize calls and check your code more carefully.  For example, you
2241 can use attributes to declare that a function never returns
2242 (@code{noreturn}), returns a value depending only on its arguments
2243 (@code{pure}), or has @code{printf}-style arguments (@code{format}).
2245 You can also use attributes to control memory placement, code
2246 generation options or call/return conventions within the function
2247 being annotated.  Many of these attributes are target-specific.  For
2248 example, many targets support attributes for defining interrupt
2249 handler functions, which typically must follow special register usage
2250 and return conventions.
2252 Function attributes are introduced by the @code{__attribute__} keyword
2253 on a declaration, followed by an attribute specification inside double
2254 parentheses.  You can specify multiple attributes in a declaration by
2255 separating them by commas within the double parentheses or by
2256 immediately following an attribute declaration with another attribute
2257 declaration.  @xref{Attribute Syntax}, for the exact rules on
2258 attribute syntax and placement.
2260 GCC also supports attributes on
2261 variable declarations (@pxref{Variable Attributes}),
2262 labels (@pxref{Label Attributes}),
2263 enumerators (@pxref{Enumerator Attributes}),
2264 and types (@pxref{Type Attributes}).
2266 There is some overlap between the purposes of attributes and pragmas
2267 (@pxref{Pragmas,,Pragmas Accepted by GCC}).  It has been
2268 found convenient to use @code{__attribute__} to achieve a natural
2269 attachment of attributes to their corresponding declarations, whereas
2270 @code{#pragma} is of use for compatibility with other compilers
2271 or constructs that do not naturally form part of the grammar.
2273 In addition to the attributes documented here,
2274 GCC plugins may provide their own attributes.
2276 @menu
2277 * Common Function Attributes::
2278 * AArch64 Function Attributes::
2279 * ARC Function Attributes::
2280 * ARM Function Attributes::
2281 * AVR Function Attributes::
2282 * Blackfin Function Attributes::
2283 * CR16 Function Attributes::
2284 * Epiphany Function Attributes::
2285 * H8/300 Function Attributes::
2286 * IA-64 Function Attributes::
2287 * M32C Function Attributes::
2288 * M32R/D Function Attributes::
2289 * m68k Function Attributes::
2290 * MCORE Function Attributes::
2291 * MeP Function Attributes::
2292 * MicroBlaze Function Attributes::
2293 * Microsoft Windows Function Attributes::
2294 * MIPS Function Attributes::
2295 * MSP430 Function Attributes::
2296 * NDS32 Function Attributes::
2297 * Nios II Function Attributes::
2298 * Nvidia PTX Function Attributes::
2299 * PowerPC Function Attributes::
2300 * RL78 Function Attributes::
2301 * RX Function Attributes::
2302 * S/390 Function Attributes::
2303 * SH Function Attributes::
2304 * SPU Function Attributes::
2305 * Symbian OS Function Attributes::
2306 * V850 Function Attributes::
2307 * Visium Function Attributes::
2308 * x86 Function Attributes::
2309 * Xstormy16 Function Attributes::
2310 @end menu
2312 @node Common Function Attributes
2313 @subsection Common Function Attributes
2315 The following attributes are supported on most targets.
2317 @table @code
2318 @c Keep this table alphabetized by attribute name.  Treat _ as space.
2320 @item alias ("@var{target}")
2321 @cindex @code{alias} function attribute
2322 The @code{alias} attribute causes the declaration to be emitted as an
2323 alias for another symbol, which must be specified.  For instance,
2325 @smallexample
2326 void __f () @{ /* @r{Do something.} */; @}
2327 void f () __attribute__ ((weak, alias ("__f")));
2328 @end smallexample
2330 @noindent
2331 defines @samp{f} to be a weak alias for @samp{__f}.  In C++, the
2332 mangled name for the target must be used.  It is an error if @samp{__f}
2333 is not defined in the same translation unit.
2335 This attribute requires assembler and object file support,
2336 and may not be available on all targets.
2338 @item aligned (@var{alignment})
2339 @cindex @code{aligned} function attribute
2340 This attribute specifies a minimum alignment for the function,
2341 measured in bytes.
2343 You cannot use this attribute to decrease the alignment of a function,
2344 only to increase it.  However, when you explicitly specify a function
2345 alignment this overrides the effect of the
2346 @option{-falign-functions} (@pxref{Optimize Options}) option for this
2347 function.
2349 Note that the effectiveness of @code{aligned} attributes may be
2350 limited by inherent limitations in your linker.  On many systems, the
2351 linker is only able to arrange for functions to be aligned up to a
2352 certain maximum alignment.  (For some linkers, the maximum supported
2353 alignment may be very very small.)  See your linker documentation for
2354 further information.
2356 The @code{aligned} attribute can also be used for variables and fields
2357 (@pxref{Variable Attributes}.)
2359 @item alloc_align
2360 @cindex @code{alloc_align} function attribute
2361 The @code{alloc_align} attribute is used to tell the compiler that the
2362 function return value points to memory, where the returned pointer minimum
2363 alignment is given by one of the functions parameters.  GCC uses this
2364 information to improve pointer alignment analysis.
2366 The function parameter denoting the allocated alignment is specified by
2367 one integer argument, whose number is the argument of the attribute.
2368 Argument numbering starts at one.
2370 For instance,
2372 @smallexample
2373 void* my_memalign(size_t, size_t) __attribute__((alloc_align(1)))
2374 @end smallexample
2376 @noindent
2377 declares that @code{my_memalign} returns memory with minimum alignment
2378 given by parameter 1.
2380 @item alloc_size
2381 @cindex @code{alloc_size} function attribute
2382 The @code{alloc_size} attribute is used to tell the compiler that the
2383 function return value points to memory, where the size is given by
2384 one or two of the functions parameters.  GCC uses this
2385 information to improve the correctness of @code{__builtin_object_size}.
2387 The function parameter(s) denoting the allocated size are specified by
2388 one or two integer arguments supplied to the attribute.  The allocated size
2389 is either the value of the single function argument specified or the product
2390 of the two function arguments specified.  Argument numbering starts at
2391 one.
2393 For instance,
2395 @smallexample
2396 void* my_calloc(size_t, size_t) __attribute__((alloc_size(1,2)))
2397 void* my_realloc(void*, size_t) __attribute__((alloc_size(2)))
2398 @end smallexample
2400 @noindent
2401 declares that @code{my_calloc} returns memory of the size given by
2402 the product of parameter 1 and 2 and that @code{my_realloc} returns memory
2403 of the size given by parameter 2.
2405 @item always_inline
2406 @cindex @code{always_inline} function attribute
2407 Generally, functions are not inlined unless optimization is specified.
2408 For functions declared inline, this attribute inlines the function
2409 independent of any restrictions that otherwise apply to inlining.
2410 Failure to inline such a function is diagnosed as an error.
2411 Note that if such a function is called indirectly the compiler may
2412 or may not inline it depending on optimization level and a failure
2413 to inline an indirect call may or may not be diagnosed.
2415 @item artificial
2416 @cindex @code{artificial} function attribute
2417 This attribute is useful for small inline wrappers that if possible
2418 should appear during debugging as a unit.  Depending on the debug
2419 info format it either means marking the function as artificial
2420 or using the caller location for all instructions within the inlined
2421 body.
2423 @item assume_aligned
2424 @cindex @code{assume_aligned} function attribute
2425 The @code{assume_aligned} attribute is used to tell the compiler that the
2426 function return value points to memory, where the returned pointer minimum
2427 alignment is given by the first argument.
2428 If the attribute has two arguments, the second argument is misalignment offset.
2430 For instance
2432 @smallexample
2433 void* my_alloc1(size_t) __attribute__((assume_aligned(16)))
2434 void* my_alloc2(size_t) __attribute__((assume_aligned(32, 8)))
2435 @end smallexample
2437 @noindent
2438 declares that @code{my_alloc1} returns 16-byte aligned pointer and
2439 that @code{my_alloc2} returns a pointer whose value modulo 32 is equal
2440 to 8.
2442 @item bnd_instrument
2443 @cindex @code{bnd_instrument} function attribute
2444 The @code{bnd_instrument} attribute on functions is used to inform the
2445 compiler that the function should be instrumented when compiled
2446 with the @option{-fchkp-instrument-marked-only} option.
2448 @item bnd_legacy
2449 @cindex @code{bnd_legacy} function attribute
2450 @cindex Pointer Bounds Checker attributes
2451 The @code{bnd_legacy} attribute on functions is used to inform the
2452 compiler that the function should not be instrumented when compiled
2453 with the @option{-fcheck-pointer-bounds} option.
2455 @item cold
2456 @cindex @code{cold} function attribute
2457 The @code{cold} attribute on functions is used to inform the compiler that
2458 the function is unlikely to be executed.  The function is optimized for
2459 size rather than speed and on many targets it is placed into a special
2460 subsection of the text section so all cold functions appear close together,
2461 improving code locality of non-cold parts of program.  The paths leading
2462 to calls of cold functions within code are marked as unlikely by the branch
2463 prediction mechanism.  It is thus useful to mark functions used to handle
2464 unlikely conditions, such as @code{perror}, as cold to improve optimization
2465 of hot functions that do call marked functions in rare occasions.
2467 When profile feedback is available, via @option{-fprofile-use}, cold functions
2468 are automatically detected and this attribute is ignored.
2470 @item const
2471 @cindex @code{const} function attribute
2472 @cindex functions that have no side effects
2473 Many functions do not examine any values except their arguments, and
2474 have no effects except the return value.  Basically this is just slightly
2475 more strict class than the @code{pure} attribute below, since function is not
2476 allowed to read global memory.
2478 @cindex pointer arguments
2479 Note that a function that has pointer arguments and examines the data
2480 pointed to must @emph{not} be declared @code{const}.  Likewise, a
2481 function that calls a non-@code{const} function usually must not be
2482 @code{const}.  It does not make sense for a @code{const} function to
2483 return @code{void}.
2485 @item constructor
2486 @itemx destructor
2487 @itemx constructor (@var{priority})
2488 @itemx destructor (@var{priority})
2489 @cindex @code{constructor} function attribute
2490 @cindex @code{destructor} function attribute
2491 The @code{constructor} attribute causes the function to be called
2492 automatically before execution enters @code{main ()}.  Similarly, the
2493 @code{destructor} attribute causes the function to be called
2494 automatically after @code{main ()} completes or @code{exit ()} is
2495 called.  Functions with these attributes are useful for
2496 initializing data that is used implicitly during the execution of
2497 the program.
2499 You may provide an optional integer priority to control the order in
2500 which constructor and destructor functions are run.  A constructor
2501 with a smaller priority number runs before a constructor with a larger
2502 priority number; the opposite relationship holds for destructors.  So,
2503 if you have a constructor that allocates a resource and a destructor
2504 that deallocates the same resource, both functions typically have the
2505 same priority.  The priorities for constructor and destructor
2506 functions are the same as those specified for namespace-scope C++
2507 objects (@pxref{C++ Attributes}).
2509 These attributes are not currently implemented for Objective-C@.
2511 @item deprecated
2512 @itemx deprecated (@var{msg})
2513 @cindex @code{deprecated} function attribute
2514 The @code{deprecated} attribute results in a warning if the function
2515 is used anywhere in the source file.  This is useful when identifying
2516 functions that are expected to be removed in a future version of a
2517 program.  The warning also includes the location of the declaration
2518 of the deprecated function, to enable users to easily find further
2519 information about why the function is deprecated, or what they should
2520 do instead.  Note that the warnings only occurs for uses:
2522 @smallexample
2523 int old_fn () __attribute__ ((deprecated));
2524 int old_fn ();
2525 int (*fn_ptr)() = old_fn;
2526 @end smallexample
2528 @noindent
2529 results in a warning on line 3 but not line 2.  The optional @var{msg}
2530 argument, which must be a string, is printed in the warning if
2531 present.
2533 The @code{deprecated} attribute can also be used for variables and
2534 types (@pxref{Variable Attributes}, @pxref{Type Attributes}.)
2536 @item error ("@var{message}")
2537 @itemx warning ("@var{message}")
2538 @cindex @code{error} function attribute
2539 @cindex @code{warning} function attribute
2540 If the @code{error} or @code{warning} attribute 
2541 is used on a function declaration and a call to such a function
2542 is not eliminated through dead code elimination or other optimizations, 
2543 an error or warning (respectively) that includes @var{message} is diagnosed.  
2544 This is useful
2545 for compile-time checking, especially together with @code{__builtin_constant_p}
2546 and inline functions where checking the inline function arguments is not
2547 possible through @code{extern char [(condition) ? 1 : -1];} tricks.
2549 While it is possible to leave the function undefined and thus invoke
2550 a link failure (to define the function with
2551 a message in @code{.gnu.warning*} section),
2552 when using these attributes the problem is diagnosed
2553 earlier and with exact location of the call even in presence of inline
2554 functions or when not emitting debugging information.
2556 @item externally_visible
2557 @cindex @code{externally_visible} function attribute
2558 This attribute, attached to a global variable or function, nullifies
2559 the effect of the @option{-fwhole-program} command-line option, so the
2560 object remains visible outside the current compilation unit.
2562 If @option{-fwhole-program} is used together with @option{-flto} and 
2563 @command{gold} is used as the linker plugin, 
2564 @code{externally_visible} attributes are automatically added to functions 
2565 (not variable yet due to a current @command{gold} issue) 
2566 that are accessed outside of LTO objects according to resolution file
2567 produced by @command{gold}.
2568 For other linkers that cannot generate resolution file,
2569 explicit @code{externally_visible} attributes are still necessary.
2571 @item flatten
2572 @cindex @code{flatten} function attribute
2573 Generally, inlining into a function is limited.  For a function marked with
2574 this attribute, every call inside this function is inlined, if possible.
2575 Whether the function itself is considered for inlining depends on its size and
2576 the current inlining parameters.
2578 @item format (@var{archetype}, @var{string-index}, @var{first-to-check})
2579 @cindex @code{format} function attribute
2580 @cindex functions with @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style arguments
2581 @opindex Wformat
2582 The @code{format} attribute specifies that a function takes @code{printf},
2583 @code{scanf}, @code{strftime} or @code{strfmon} style arguments that
2584 should be type-checked against a format string.  For example, the
2585 declaration:
2587 @smallexample
2588 extern int
2589 my_printf (void *my_object, const char *my_format, ...)
2590       __attribute__ ((format (printf, 2, 3)));
2591 @end smallexample
2593 @noindent
2594 causes the compiler to check the arguments in calls to @code{my_printf}
2595 for consistency with the @code{printf} style format string argument
2596 @code{my_format}.
2598 The parameter @var{archetype} determines how the format string is
2599 interpreted, and should be @code{printf}, @code{scanf}, @code{strftime},
2600 @code{gnu_printf}, @code{gnu_scanf}, @code{gnu_strftime} or
2601 @code{strfmon}.  (You can also use @code{__printf__},
2602 @code{__scanf__}, @code{__strftime__} or @code{__strfmon__}.)  On
2603 MinGW targets, @code{ms_printf}, @code{ms_scanf}, and
2604 @code{ms_strftime} are also present.
2605 @var{archetype} values such as @code{printf} refer to the formats accepted
2606 by the system's C runtime library,
2607 while values prefixed with @samp{gnu_} always refer
2608 to the formats accepted by the GNU C Library.  On Microsoft Windows
2609 targets, values prefixed with @samp{ms_} refer to the formats accepted by the
2610 @file{msvcrt.dll} library.
2611 The parameter @var{string-index}
2612 specifies which argument is the format string argument (starting
2613 from 1), while @var{first-to-check} is the number of the first
2614 argument to check against the format string.  For functions
2615 where the arguments are not available to be checked (such as
2616 @code{vprintf}), specify the third parameter as zero.  In this case the
2617 compiler only checks the format string for consistency.  For
2618 @code{strftime} formats, the third parameter is required to be zero.
2619 Since non-static C++ methods have an implicit @code{this} argument, the
2620 arguments of such methods should be counted from two, not one, when
2621 giving values for @var{string-index} and @var{first-to-check}.
2623 In the example above, the format string (@code{my_format}) is the second
2624 argument of the function @code{my_print}, and the arguments to check
2625 start with the third argument, so the correct parameters for the format
2626 attribute are 2 and 3.
2628 @opindex ffreestanding
2629 @opindex fno-builtin
2630 The @code{format} attribute allows you to identify your own functions
2631 that take format strings as arguments, so that GCC can check the
2632 calls to these functions for errors.  The compiler always (unless
2633 @option{-ffreestanding} or @option{-fno-builtin} is used) checks formats
2634 for the standard library functions @code{printf}, @code{fprintf},
2635 @code{sprintf}, @code{scanf}, @code{fscanf}, @code{sscanf}, @code{strftime},
2636 @code{vprintf}, @code{vfprintf} and @code{vsprintf} whenever such
2637 warnings are requested (using @option{-Wformat}), so there is no need to
2638 modify the header file @file{stdio.h}.  In C99 mode, the functions
2639 @code{snprintf}, @code{vsnprintf}, @code{vscanf}, @code{vfscanf} and
2640 @code{vsscanf} are also checked.  Except in strictly conforming C
2641 standard modes, the X/Open function @code{strfmon} is also checked as
2642 are @code{printf_unlocked} and @code{fprintf_unlocked}.
2643 @xref{C Dialect Options,,Options Controlling C Dialect}.
2645 For Objective-C dialects, @code{NSString} (or @code{__NSString__}) is
2646 recognized in the same context.  Declarations including these format attributes
2647 are parsed for correct syntax, however the result of checking of such format
2648 strings is not yet defined, and is not carried out by this version of the
2649 compiler.
2651 The target may also provide additional types of format checks.
2652 @xref{Target Format Checks,,Format Checks Specific to Particular
2653 Target Machines}.
2655 @item format_arg (@var{string-index})
2656 @cindex @code{format_arg} function attribute
2657 @opindex Wformat-nonliteral
2658 The @code{format_arg} attribute specifies that a function takes a format
2659 string for a @code{printf}, @code{scanf}, @code{strftime} or
2660 @code{strfmon} style function and modifies it (for example, to translate
2661 it into another language), so the result can be passed to a
2662 @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style
2663 function (with the remaining arguments to the format function the same
2664 as they would have been for the unmodified string).  For example, the
2665 declaration:
2667 @smallexample
2668 extern char *
2669 my_dgettext (char *my_domain, const char *my_format)
2670       __attribute__ ((format_arg (2)));
2671 @end smallexample
2673 @noindent
2674 causes the compiler to check the arguments in calls to a @code{printf},
2675 @code{scanf}, @code{strftime} or @code{strfmon} type function, whose
2676 format string argument is a call to the @code{my_dgettext} function, for
2677 consistency with the format string argument @code{my_format}.  If the
2678 @code{format_arg} attribute had not been specified, all the compiler
2679 could tell in such calls to format functions would be that the format
2680 string argument is not constant; this would generate a warning when
2681 @option{-Wformat-nonliteral} is used, but the calls could not be checked
2682 without the attribute.
2684 The parameter @var{string-index} specifies which argument is the format
2685 string argument (starting from one).  Since non-static C++ methods have
2686 an implicit @code{this} argument, the arguments of such methods should
2687 be counted from two.
2689 The @code{format_arg} attribute allows you to identify your own
2690 functions that modify format strings, so that GCC can check the
2691 calls to @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon}
2692 type function whose operands are a call to one of your own function.
2693 The compiler always treats @code{gettext}, @code{dgettext}, and
2694 @code{dcgettext} in this manner except when strict ISO C support is
2695 requested by @option{-ansi} or an appropriate @option{-std} option, or
2696 @option{-ffreestanding} or @option{-fno-builtin}
2697 is used.  @xref{C Dialect Options,,Options
2698 Controlling C Dialect}.
2700 For Objective-C dialects, the @code{format-arg} attribute may refer to an
2701 @code{NSString} reference for compatibility with the @code{format} attribute
2702 above.
2704 The target may also allow additional types in @code{format-arg} attributes.
2705 @xref{Target Format Checks,,Format Checks Specific to Particular
2706 Target Machines}.
2708 @item gnu_inline
2709 @cindex @code{gnu_inline} function attribute
2710 This attribute should be used with a function that is also declared
2711 with the @code{inline} keyword.  It directs GCC to treat the function
2712 as if it were defined in gnu90 mode even when compiling in C99 or
2713 gnu99 mode.
2715 If the function is declared @code{extern}, then this definition of the
2716 function is used only for inlining.  In no case is the function
2717 compiled as a standalone function, not even if you take its address
2718 explicitly.  Such an address becomes an external reference, as if you
2719 had only declared the function, and had not defined it.  This has
2720 almost the effect of a macro.  The way to use this is to put a
2721 function definition in a header file with this attribute, and put
2722 another copy of the function, without @code{extern}, in a library
2723 file.  The definition in the header file causes most calls to the
2724 function to be inlined.  If any uses of the function remain, they
2725 refer to the single copy in the library.  Note that the two
2726 definitions of the functions need not be precisely the same, although
2727 if they do not have the same effect your program may behave oddly.
2729 In C, if the function is neither @code{extern} nor @code{static}, then
2730 the function is compiled as a standalone function, as well as being
2731 inlined where possible.
2733 This is how GCC traditionally handled functions declared
2734 @code{inline}.  Since ISO C99 specifies a different semantics for
2735 @code{inline}, this function attribute is provided as a transition
2736 measure and as a useful feature in its own right.  This attribute is
2737 available in GCC 4.1.3 and later.  It is available if either of the
2738 preprocessor macros @code{__GNUC_GNU_INLINE__} or
2739 @code{__GNUC_STDC_INLINE__} are defined.  @xref{Inline,,An Inline
2740 Function is As Fast As a Macro}.
2742 In C++, this attribute does not depend on @code{extern} in any way,
2743 but it still requires the @code{inline} keyword to enable its special
2744 behavior.
2746 @item hot
2747 @cindex @code{hot} function attribute
2748 The @code{hot} attribute on a function is used to inform the compiler that
2749 the function is a hot spot of the compiled program.  The function is
2750 optimized more aggressively and on many targets it is placed into a special
2751 subsection of the text section so all hot functions appear close together,
2752 improving locality.
2754 When profile feedback is available, via @option{-fprofile-use}, hot functions
2755 are automatically detected and this attribute is ignored.
2757 @item ifunc ("@var{resolver}")
2758 @cindex @code{ifunc} function attribute
2759 @cindex indirect functions
2760 @cindex functions that are dynamically resolved
2761 The @code{ifunc} attribute is used to mark a function as an indirect
2762 function using the STT_GNU_IFUNC symbol type extension to the ELF
2763 standard.  This allows the resolution of the symbol value to be
2764 determined dynamically at load time, and an optimized version of the
2765 routine can be selected for the particular processor or other system
2766 characteristics determined then.  To use this attribute, first define
2767 the implementation functions available, and a resolver function that
2768 returns a pointer to the selected implementation function.  The
2769 implementation functions' declarations must match the API of the
2770 function being implemented, the resolver's declaration is be a
2771 function returning pointer to void function returning void:
2773 @smallexample
2774 void *my_memcpy (void *dst, const void *src, size_t len)
2776   @dots{}
2779 static void (*resolve_memcpy (void)) (void)
2781   return my_memcpy; // we'll just always select this routine
2783 @end smallexample
2785 @noindent
2786 The exported header file declaring the function the user calls would
2787 contain:
2789 @smallexample
2790 extern void *memcpy (void *, const void *, size_t);
2791 @end smallexample
2793 @noindent
2794 allowing the user to call this as a regular function, unaware of the
2795 implementation.  Finally, the indirect function needs to be defined in
2796 the same translation unit as the resolver function:
2798 @smallexample
2799 void *memcpy (void *, const void *, size_t)
2800      __attribute__ ((ifunc ("resolve_memcpy")));
2801 @end smallexample
2803 Indirect functions cannot be weak.  Binutils version 2.20.1 or higher
2804 and GNU C Library version 2.11.1 are required to use this feature.
2806 @item interrupt
2807 @itemx interrupt_handler
2808 Many GCC back ends support attributes to indicate that a function is
2809 an interrupt handler, which tells the compiler to generate function
2810 entry and exit sequences that differ from those from regular
2811 functions.  The exact syntax and behavior are target-specific;
2812 refer to the following subsections for details.
2814 @item leaf
2815 @cindex @code{leaf} function attribute
2816 Calls to external functions with this attribute must return to the
2817 current compilation unit only by return or by exception handling.  In
2818 particular, a leaf function is not allowed to invoke callback functions
2819 passed to it from the current compilation unit, directly call functions
2820 exported by the unit, or @code{longjmp} into the unit.  Leaf functions
2821 might still call functions from other compilation units and thus they
2822 are not necessarily leaf in the sense that they contain no function
2823 calls at all.
2825 The attribute is intended for library functions to improve dataflow
2826 analysis.  The compiler takes the hint that any data not escaping the
2827 current compilation unit cannot be used or modified by the leaf
2828 function.  For example, the @code{sin} function is a leaf function, but
2829 @code{qsort} is not.
2831 Note that leaf functions might indirectly run a signal handler defined
2832 in the current compilation unit that uses static variables.  Similarly,
2833 when lazy symbol resolution is in effect, leaf functions might invoke
2834 indirect functions whose resolver function or implementation function is
2835 defined in the current compilation unit and uses static variables.  There
2836 is no standard-compliant way to write such a signal handler, resolver
2837 function, or implementation function, and the best that you can do is to
2838 remove the @code{leaf} attribute or mark all such static variables
2839 @code{volatile}.  Lastly, for ELF-based systems that support symbol
2840 interposition, care should be taken that functions defined in the
2841 current compilation unit do not unexpectedly interpose other symbols
2842 based on the defined standards mode and defined feature test macros;
2843 otherwise an inadvertent callback would be added.
2845 The attribute has no effect on functions defined within the current
2846 compilation unit.  This is to allow easy merging of multiple compilation
2847 units into one, for example, by using the link-time optimization.  For
2848 this reason the attribute is not allowed on types to annotate indirect
2849 calls.
2851 @item malloc
2852 @cindex @code{malloc} function attribute
2853 @cindex functions that behave like malloc
2854 This tells the compiler that a function is @code{malloc}-like, i.e.,
2855 that the pointer @var{P} returned by the function cannot alias any
2856 other pointer valid when the function returns, and moreover no
2857 pointers to valid objects occur in any storage addressed by @var{P}.
2859 Using this attribute can improve optimization.  Functions like
2860 @code{malloc} and @code{calloc} have this property because they return
2861 a pointer to uninitialized or zeroed-out storage.  However, functions
2862 like @code{realloc} do not have this property, as they can return a
2863 pointer to storage containing pointers.
2865 @item no_icf
2866 @cindex @code{no_icf} function attribute
2867 This function attribute prevents a functions from being merged with another
2868 semantically equivalent function.
2870 @item no_instrument_function
2871 @cindex @code{no_instrument_function} function attribute
2872 @opindex finstrument-functions
2873 If @option{-finstrument-functions} is given, profiling function calls are
2874 generated at entry and exit of most user-compiled functions.
2875 Functions with this attribute are not so instrumented.
2877 @item no_profile_instrument_function
2878 @cindex @code{no_profile_instrument_function} function attribute
2879 The @code{no_profile_instrument_function} attribute on functions is used
2880 to inform the compiler that it should not process any profile feedback based
2881 optimization code instrumentation.
2883 @item no_reorder
2884 @cindex @code{no_reorder} function attribute
2885 Do not reorder functions or variables marked @code{no_reorder}
2886 against each other or top level assembler statements the executable.
2887 The actual order in the program will depend on the linker command
2888 line. Static variables marked like this are also not removed.
2889 This has a similar effect
2890 as the @option{-fno-toplevel-reorder} option, but only applies to the
2891 marked symbols.
2893 @item no_sanitize_address
2894 @itemx no_address_safety_analysis
2895 @cindex @code{no_sanitize_address} function attribute
2896 The @code{no_sanitize_address} attribute on functions is used
2897 to inform the compiler that it should not instrument memory accesses
2898 in the function when compiling with the @option{-fsanitize=address} option.
2899 The @code{no_address_safety_analysis} is a deprecated alias of the
2900 @code{no_sanitize_address} attribute, new code should use
2901 @code{no_sanitize_address}.
2903 @item no_sanitize_thread
2904 @cindex @code{no_sanitize_thread} function attribute
2905 The @code{no_sanitize_thread} attribute on functions is used
2906 to inform the compiler that it should not instrument memory accesses
2907 in the function when compiling with the @option{-fsanitize=thread} option.
2909 @item no_sanitize_undefined
2910 @cindex @code{no_sanitize_undefined} function attribute
2911 The @code{no_sanitize_undefined} attribute on functions is used
2912 to inform the compiler that it should not check for undefined behavior
2913 in the function when compiling with the @option{-fsanitize=undefined} option.
2915 @item no_split_stack
2916 @cindex @code{no_split_stack} function attribute
2917 @opindex fsplit-stack
2918 If @option{-fsplit-stack} is given, functions have a small
2919 prologue which decides whether to split the stack.  Functions with the
2920 @code{no_split_stack} attribute do not have that prologue, and thus
2921 may run with only a small amount of stack space available.
2923 @item no_stack_limit
2924 @cindex @code{no_stack_limit} function attribute
2925 This attribute locally overrides the @option{-fstack-limit-register}
2926 and @option{-fstack-limit-symbol} command-line options; it has the effect
2927 of disabling stack limit checking in the function it applies to.
2929 @item noclone
2930 @cindex @code{noclone} function attribute
2931 This function attribute prevents a function from being considered for
2932 cloning---a mechanism that produces specialized copies of functions
2933 and which is (currently) performed by interprocedural constant
2934 propagation.
2936 @item noinline
2937 @cindex @code{noinline} function attribute
2938 This function attribute prevents a function from being considered for
2939 inlining.
2940 @c Don't enumerate the optimizations by name here; we try to be
2941 @c future-compatible with this mechanism.
2942 If the function does not have side-effects, there are optimizations
2943 other than inlining that cause function calls to be optimized away,
2944 although the function call is live.  To keep such calls from being
2945 optimized away, put
2946 @smallexample
2947 asm ("");
2948 @end smallexample
2950 @noindent
2951 (@pxref{Extended Asm}) in the called function, to serve as a special
2952 side-effect.
2954 @item nonnull (@var{arg-index}, @dots{})
2955 @cindex @code{nonnull} function attribute
2956 @cindex functions with non-null pointer arguments
2957 The @code{nonnull} attribute specifies that some function parameters should
2958 be non-null pointers.  For instance, the declaration:
2960 @smallexample
2961 extern void *
2962 my_memcpy (void *dest, const void *src, size_t len)
2963         __attribute__((nonnull (1, 2)));
2964 @end smallexample
2966 @noindent
2967 causes the compiler to check that, in calls to @code{my_memcpy},
2968 arguments @var{dest} and @var{src} are non-null.  If the compiler
2969 determines that a null pointer is passed in an argument slot marked
2970 as non-null, and the @option{-Wnonnull} option is enabled, a warning
2971 is issued.  The compiler may also choose to make optimizations based
2972 on the knowledge that certain function arguments will never be null.
2974 If no argument index list is given to the @code{nonnull} attribute,
2975 all pointer arguments are marked as non-null.  To illustrate, the
2976 following declaration is equivalent to the previous example:
2978 @smallexample
2979 extern void *
2980 my_memcpy (void *dest, const void *src, size_t len)
2981         __attribute__((nonnull));
2982 @end smallexample
2984 @item noplt
2985 @cindex @code{noplt} function attribute
2986 The @code{noplt} attribute is the counterpart to option @option{-fno-plt}.
2987 Calls to functions marked with this attribute in position-independent code
2988 do not use the PLT.
2990 @smallexample
2991 @group
2992 /* Externally defined function foo.  */
2993 int foo () __attribute__ ((noplt));
2996 main (/* @r{@dots{}} */)
2998   /* @r{@dots{}} */
2999   foo ();
3000   /* @r{@dots{}} */
3002 @end group
3003 @end smallexample
3005 The @code{noplt} attribute on function @code{foo}
3006 tells the compiler to assume that
3007 the function @code{foo} is externally defined and that the call to
3008 @code{foo} must avoid the PLT
3009 in position-independent code.
3011 In position-dependent code, a few targets also convert calls to
3012 functions that are marked to not use the PLT to use the GOT instead.
3014 @item noreturn
3015 @cindex @code{noreturn} function attribute
3016 @cindex functions that never return
3017 A few standard library functions, such as @code{abort} and @code{exit},
3018 cannot return.  GCC knows this automatically.  Some programs define
3019 their own functions that never return.  You can declare them
3020 @code{noreturn} to tell the compiler this fact.  For example,
3022 @smallexample
3023 @group
3024 void fatal () __attribute__ ((noreturn));
3026 void
3027 fatal (/* @r{@dots{}} */)
3029   /* @r{@dots{}} */ /* @r{Print error message.} */ /* @r{@dots{}} */
3030   exit (1);
3032 @end group
3033 @end smallexample
3035 The @code{noreturn} keyword tells the compiler to assume that
3036 @code{fatal} cannot return.  It can then optimize without regard to what
3037 would happen if @code{fatal} ever did return.  This makes slightly
3038 better code.  More importantly, it helps avoid spurious warnings of
3039 uninitialized variables.
3041 The @code{noreturn} keyword does not affect the exceptional path when that
3042 applies: a @code{noreturn}-marked function may still return to the caller
3043 by throwing an exception or calling @code{longjmp}.
3045 Do not assume that registers saved by the calling function are
3046 restored before calling the @code{noreturn} function.
3048 It does not make sense for a @code{noreturn} function to have a return
3049 type other than @code{void}.
3051 @item nothrow
3052 @cindex @code{nothrow} function attribute
3053 The @code{nothrow} attribute is used to inform the compiler that a
3054 function cannot throw an exception.  For example, most functions in
3055 the standard C library can be guaranteed not to throw an exception
3056 with the notable exceptions of @code{qsort} and @code{bsearch} that
3057 take function pointer arguments.
3059 @item optimize
3060 @cindex @code{optimize} function attribute
3061 The @code{optimize} attribute is used to specify that a function is to
3062 be compiled with different optimization options than specified on the
3063 command line.  Arguments can either be numbers or strings.  Numbers
3064 are assumed to be an optimization level.  Strings that begin with
3065 @code{O} are assumed to be an optimization option, while other options
3066 are assumed to be used with a @code{-f} prefix.  You can also use the
3067 @samp{#pragma GCC optimize} pragma to set the optimization options
3068 that affect more than one function.
3069 @xref{Function Specific Option Pragmas}, for details about the
3070 @samp{#pragma GCC optimize} pragma.
3072 This attribute should be used for debugging purposes only.  It is not
3073 suitable in production code.
3075 @item pure
3076 @cindex @code{pure} function attribute
3077 @cindex functions that have no side effects
3078 Many functions have no effects except the return value and their
3079 return value depends only on the parameters and/or global variables.
3080 Such a function can be subject
3081 to common subexpression elimination and loop optimization just as an
3082 arithmetic operator would be.  These functions should be declared
3083 with the attribute @code{pure}.  For example,
3085 @smallexample
3086 int square (int) __attribute__ ((pure));
3087 @end smallexample
3089 @noindent
3090 says that the hypothetical function @code{square} is safe to call
3091 fewer times than the program says.
3093 Some common examples of pure functions are @code{strlen} or @code{memcmp}.
3094 Interesting non-pure functions are functions with infinite loops or those
3095 depending on volatile memory or other system resource, that may change between
3096 two consecutive calls (such as @code{feof} in a multithreading environment).
3098 @item returns_nonnull
3099 @cindex @code{returns_nonnull} function attribute
3100 The @code{returns_nonnull} attribute specifies that the function
3101 return value should be a non-null pointer.  For instance, the declaration:
3103 @smallexample
3104 extern void *
3105 mymalloc (size_t len) __attribute__((returns_nonnull));
3106 @end smallexample
3108 @noindent
3109 lets the compiler optimize callers based on the knowledge
3110 that the return value will never be null.
3112 @item returns_twice
3113 @cindex @code{returns_twice} function attribute
3114 @cindex functions that return more than once
3115 The @code{returns_twice} attribute tells the compiler that a function may
3116 return more than one time.  The compiler ensures that all registers
3117 are dead before calling such a function and emits a warning about
3118 the variables that may be clobbered after the second return from the
3119 function.  Examples of such functions are @code{setjmp} and @code{vfork}.
3120 The @code{longjmp}-like counterpart of such function, if any, might need
3121 to be marked with the @code{noreturn} attribute.
3123 @item section ("@var{section-name}")
3124 @cindex @code{section} function attribute
3125 @cindex functions in arbitrary sections
3126 Normally, the compiler places the code it generates in the @code{text} section.
3127 Sometimes, however, you need additional sections, or you need certain
3128 particular functions to appear in special sections.  The @code{section}
3129 attribute specifies that a function lives in a particular section.
3130 For example, the declaration:
3132 @smallexample
3133 extern void foobar (void) __attribute__ ((section ("bar")));
3134 @end smallexample
3136 @noindent
3137 puts the function @code{foobar} in the @code{bar} section.
3139 Some file formats do not support arbitrary sections so the @code{section}
3140 attribute is not available on all platforms.
3141 If you need to map the entire contents of a module to a particular
3142 section, consider using the facilities of the linker instead.
3144 @item sentinel
3145 @cindex @code{sentinel} function attribute
3146 This function attribute ensures that a parameter in a function call is
3147 an explicit @code{NULL}.  The attribute is only valid on variadic
3148 functions.  By default, the sentinel is located at position zero, the
3149 last parameter of the function call.  If an optional integer position
3150 argument P is supplied to the attribute, the sentinel must be located at
3151 position P counting backwards from the end of the argument list.
3153 @smallexample
3154 __attribute__ ((sentinel))
3155 is equivalent to
3156 __attribute__ ((sentinel(0)))
3157 @end smallexample
3159 The attribute is automatically set with a position of 0 for the built-in
3160 functions @code{execl} and @code{execlp}.  The built-in function
3161 @code{execle} has the attribute set with a position of 1.
3163 A valid @code{NULL} in this context is defined as zero with any pointer
3164 type.  If your system defines the @code{NULL} macro with an integer type
3165 then you need to add an explicit cast.  GCC replaces @code{stddef.h}
3166 with a copy that redefines NULL appropriately.
3168 The warnings for missing or incorrect sentinels are enabled with
3169 @option{-Wformat}.
3171 @item simd
3172 @itemx simd("@var{mask}")
3173 @cindex @code{simd} function attribute
3174 This attribute enables creation of one or more function versions that
3175 can process multiple arguments using SIMD instructions from a
3176 single invocation.  Specifying this attribute allows compiler to
3177 assume that such versions are available at link time (provided
3178 in the same or another translation unit).  Generated versions are
3179 target-dependent and described in the corresponding Vector ABI document.  For
3180 x86_64 target this document can be found
3181 @w{@uref{https://sourceware.org/glibc/wiki/libmvec?action=AttachFile&do=view&target=VectorABI.txt,here}}.
3183 The optional argument @var{mask} may have the value
3184 @code{notinbranch} or @code{inbranch},
3185 and instructs the compiler to generate non-masked or masked
3186 clones correspondingly. By default, all clones are generated.
3188 The attribute should not be used together with Cilk Plus @code{vector}
3189 attribute on the same function.
3191 If the attribute is specified and @code{#pragma omp declare simd} is
3192 present on a declaration and the @option{-fopenmp} or @option{-fopenmp-simd}
3193 switch is specified, then the attribute is ignored.
3195 @item stack_protect
3196 @cindex @code{stack_protect} function attribute
3197 This attribute adds stack protection code to the function if 
3198 flags @option{-fstack-protector}, @option{-fstack-protector-strong}
3199 or @option{-fstack-protector-explicit} are set.
3201 @item target (@var{options})
3202 @cindex @code{target} function attribute
3203 Multiple target back ends implement the @code{target} attribute
3204 to specify that a function is to
3205 be compiled with different target options than specified on the
3206 command line.  This can be used for instance to have functions
3207 compiled with a different ISA (instruction set architecture) than the
3208 default.  You can also use the @samp{#pragma GCC target} pragma to set
3209 more than one function to be compiled with specific target options.
3210 @xref{Function Specific Option Pragmas}, for details about the
3211 @samp{#pragma GCC target} pragma.
3213 For instance, on an x86, you could declare one function with the
3214 @code{target("sse4.1,arch=core2")} attribute and another with
3215 @code{target("sse4a,arch=amdfam10")}.  This is equivalent to
3216 compiling the first function with @option{-msse4.1} and
3217 @option{-march=core2} options, and the second function with
3218 @option{-msse4a} and @option{-march=amdfam10} options.  It is up to you
3219 to make sure that a function is only invoked on a machine that
3220 supports the particular ISA it is compiled for (for example by using
3221 @code{cpuid} on x86 to determine what feature bits and architecture
3222 family are used).
3224 @smallexample
3225 int core2_func (void) __attribute__ ((__target__ ("arch=core2")));
3226 int sse3_func (void) __attribute__ ((__target__ ("sse3")));
3227 @end smallexample
3229 You can either use multiple
3230 strings separated by commas to specify multiple options,
3231 or separate the options with a comma (@samp{,}) within a single string.
3233 The options supported are specific to each target; refer to @ref{x86
3234 Function Attributes}, @ref{PowerPC Function Attributes},
3235 @ref{ARM Function Attributes},and @ref{Nios II Function Attributes},
3236 for details.
3238 @item target_clones (@var{options})
3239 @cindex @code{target_clones} function attribute
3240 The @code{target_clones} attribute is used to specify that a function
3241 be cloned into multiple versions compiled with different target options
3242 than specified on the command line.  The supported options and restrictions
3243 are the same as for @code{target} attribute.
3245 For instance, on an x86, you could compile a function with
3246 @code{target_clones("sse4.1,avx")}.  GCC creates two function clones,
3247 one compiled with @option{-msse4.1} and another with @option{-mavx}.
3248 It also creates a resolver function (see the @code{ifunc} attribute
3249 above) that dynamically selects a clone suitable for current architecture.
3251 @item unused
3252 @cindex @code{unused} function attribute
3253 This attribute, attached to a function, means that the function is meant
3254 to be possibly unused.  GCC does not produce a warning for this
3255 function.
3257 @item used
3258 @cindex @code{used} function attribute
3259 This attribute, attached to a function, means that code must be emitted
3260 for the function even if it appears that the function is not referenced.
3261 This is useful, for example, when the function is referenced only in
3262 inline assembly.
3264 When applied to a member function of a C++ class template, the
3265 attribute also means that the function is instantiated if the
3266 class itself is instantiated.
3268 @item visibility ("@var{visibility_type}")
3269 @cindex @code{visibility} function attribute
3270 This attribute affects the linkage of the declaration to which it is attached.
3271 It can be applied to variables (@pxref{Common Variable Attributes}) and types
3272 (@pxref{Common Type Attributes}) as well as functions.
3274 There are four supported @var{visibility_type} values: default,
3275 hidden, protected or internal visibility.
3277 @smallexample
3278 void __attribute__ ((visibility ("protected")))
3279 f () @{ /* @r{Do something.} */; @}
3280 int i __attribute__ ((visibility ("hidden")));
3281 @end smallexample
3283 The possible values of @var{visibility_type} correspond to the
3284 visibility settings in the ELF gABI.
3286 @table @code
3287 @c keep this list of visibilities in alphabetical order.
3289 @item default
3290 Default visibility is the normal case for the object file format.
3291 This value is available for the visibility attribute to override other
3292 options that may change the assumed visibility of entities.
3294 On ELF, default visibility means that the declaration is visible to other
3295 modules and, in shared libraries, means that the declared entity may be
3296 overridden.
3298 On Darwin, default visibility means that the declaration is visible to
3299 other modules.
3301 Default visibility corresponds to ``external linkage'' in the language.
3303 @item hidden
3304 Hidden visibility indicates that the entity declared has a new
3305 form of linkage, which we call ``hidden linkage''.  Two
3306 declarations of an object with hidden linkage refer to the same object
3307 if they are in the same shared object.
3309 @item internal
3310 Internal visibility is like hidden visibility, but with additional
3311 processor specific semantics.  Unless otherwise specified by the
3312 psABI, GCC defines internal visibility to mean that a function is
3313 @emph{never} called from another module.  Compare this with hidden
3314 functions which, while they cannot be referenced directly by other
3315 modules, can be referenced indirectly via function pointers.  By
3316 indicating that a function cannot be called from outside the module,
3317 GCC may for instance omit the load of a PIC register since it is known
3318 that the calling function loaded the correct value.
3320 @item protected
3321 Protected visibility is like default visibility except that it
3322 indicates that references within the defining module bind to the
3323 definition in that module.  That is, the declared entity cannot be
3324 overridden by another module.
3326 @end table
3328 All visibilities are supported on many, but not all, ELF targets
3329 (supported when the assembler supports the @samp{.visibility}
3330 pseudo-op).  Default visibility is supported everywhere.  Hidden
3331 visibility is supported on Darwin targets.
3333 The visibility attribute should be applied only to declarations that
3334 would otherwise have external linkage.  The attribute should be applied
3335 consistently, so that the same entity should not be declared with
3336 different settings of the attribute.
3338 In C++, the visibility attribute applies to types as well as functions
3339 and objects, because in C++ types have linkage.  A class must not have
3340 greater visibility than its non-static data member types and bases,
3341 and class members default to the visibility of their class.  Also, a
3342 declaration without explicit visibility is limited to the visibility
3343 of its type.
3345 In C++, you can mark member functions and static member variables of a
3346 class with the visibility attribute.  This is useful if you know a
3347 particular method or static member variable should only be used from
3348 one shared object; then you can mark it hidden while the rest of the
3349 class has default visibility.  Care must be taken to avoid breaking
3350 the One Definition Rule; for example, it is usually not useful to mark
3351 an inline method as hidden without marking the whole class as hidden.
3353 A C++ namespace declaration can also have the visibility attribute.
3355 @smallexample
3356 namespace nspace1 __attribute__ ((visibility ("protected")))
3357 @{ /* @r{Do something.} */; @}
3358 @end smallexample
3360 This attribute applies only to the particular namespace body, not to
3361 other definitions of the same namespace; it is equivalent to using
3362 @samp{#pragma GCC visibility} before and after the namespace
3363 definition (@pxref{Visibility Pragmas}).
3365 In C++, if a template argument has limited visibility, this
3366 restriction is implicitly propagated to the template instantiation.
3367 Otherwise, template instantiations and specializations default to the
3368 visibility of their template.
3370 If both the template and enclosing class have explicit visibility, the
3371 visibility from the template is used.
3373 @item warn_unused_result
3374 @cindex @code{warn_unused_result} function attribute
3375 The @code{warn_unused_result} attribute causes a warning to be emitted
3376 if a caller of the function with this attribute does not use its
3377 return value.  This is useful for functions where not checking
3378 the result is either a security problem or always a bug, such as
3379 @code{realloc}.
3381 @smallexample
3382 int fn () __attribute__ ((warn_unused_result));
3383 int foo ()
3385   if (fn () < 0) return -1;
3386   fn ();
3387   return 0;
3389 @end smallexample
3391 @noindent
3392 results in warning on line 5.
3394 @item weak
3395 @cindex @code{weak} function attribute
3396 The @code{weak} attribute causes the declaration to be emitted as a weak
3397 symbol rather than a global.  This is primarily useful in defining
3398 library functions that can be overridden in user code, though it can
3399 also be used with non-function declarations.  Weak symbols are supported
3400 for ELF targets, and also for a.out targets when using the GNU assembler
3401 and linker.
3403 @item weakref
3404 @itemx weakref ("@var{target}")
3405 @cindex @code{weakref} function attribute
3406 The @code{weakref} attribute marks a declaration as a weak reference.
3407 Without arguments, it should be accompanied by an @code{alias} attribute
3408 naming the target symbol.  Optionally, the @var{target} may be given as
3409 an argument to @code{weakref} itself.  In either case, @code{weakref}
3410 implicitly marks the declaration as @code{weak}.  Without a
3411 @var{target}, given as an argument to @code{weakref} or to @code{alias},
3412 @code{weakref} is equivalent to @code{weak}.
3414 @smallexample
3415 static int x() __attribute__ ((weakref ("y")));
3416 /* is equivalent to... */
3417 static int x() __attribute__ ((weak, weakref, alias ("y")));
3418 /* and to... */
3419 static int x() __attribute__ ((weakref));
3420 static int x() __attribute__ ((alias ("y")));
3421 @end smallexample
3423 A weak reference is an alias that does not by itself require a
3424 definition to be given for the target symbol.  If the target symbol is
3425 only referenced through weak references, then it becomes a @code{weak}
3426 undefined symbol.  If it is directly referenced, however, then such
3427 strong references prevail, and a definition is required for the
3428 symbol, not necessarily in the same translation unit.
3430 The effect is equivalent to moving all references to the alias to a
3431 separate translation unit, renaming the alias to the aliased symbol,
3432 declaring it as weak, compiling the two separate translation units and
3433 performing a reloadable link on them.
3435 At present, a declaration to which @code{weakref} is attached can
3436 only be @code{static}.
3439 @end table
3441 @c This is the end of the target-independent attribute table
3443 @node AArch64 Function Attributes
3444 @subsection AArch64 Function Attributes
3446 The following target-specific function attributes are available for the
3447 AArch64 target.  For the most part, these options mirror the behavior of
3448 similar command-line options (@pxref{AArch64 Options}), but on a
3449 per-function basis.
3451 @table @code
3452 @item general-regs-only
3453 @cindex @code{general-regs-only} function attribute, AArch64
3454 Indicates that no floating-point or Advanced SIMD registers should be
3455 used when generating code for this function.  If the function explicitly
3456 uses floating-point code, then the compiler gives an error.  This is
3457 the same behavior as that of the command-line option
3458 @option{-mgeneral-regs-only}.
3460 @item fix-cortex-a53-835769
3461 @cindex @code{fix-cortex-a53-835769} function attribute, AArch64
3462 Indicates that the workaround for the Cortex-A53 erratum 835769 should be
3463 applied to this function.  To explicitly disable the workaround for this
3464 function specify the negated form: @code{no-fix-cortex-a53-835769}.
3465 This corresponds to the behavior of the command line options
3466 @option{-mfix-cortex-a53-835769} and @option{-mno-fix-cortex-a53-835769}.
3468 @item cmodel=
3469 @cindex @code{cmodel=} function attribute, AArch64
3470 Indicates that code should be generated for a particular code model for
3471 this function.  The behavior and permissible arguments are the same as
3472 for the command line option @option{-mcmodel=}.
3474 @item strict-align
3475 @cindex @code{strict-align} function attribute, AArch64
3476 Indicates that the compiler should not assume that unaligned memory references
3477 are handled by the system.  The behavior is the same as for the command-line
3478 option @option{-mstrict-align}.
3480 @item omit-leaf-frame-pointer
3481 @cindex @code{omit-leaf-frame-pointer} function attribute, AArch64
3482 Indicates that the frame pointer should be omitted for a leaf function call.
3483 To keep the frame pointer, the inverse attribute
3484 @code{no-omit-leaf-frame-pointer} can be specified.  These attributes have
3485 the same behavior as the command-line options @option{-momit-leaf-frame-pointer}
3486 and @option{-mno-omit-leaf-frame-pointer}.
3488 @item tls-dialect=
3489 @cindex @code{tls-dialect=} function attribute, AArch64
3490 Specifies the TLS dialect to use for this function.  The behavior and
3491 permissible arguments are the same as for the command-line option
3492 @option{-mtls-dialect=}.
3494 @item arch=
3495 @cindex @code{arch=} function attribute, AArch64
3496 Specifies the architecture version and architectural extensions to use
3497 for this function.  The behavior and permissible arguments are the same as
3498 for the @option{-march=} command-line option.
3500 @item tune=
3501 @cindex @code{tune=} function attribute, AArch64
3502 Specifies the core for which to tune the performance of this function.
3503 The behavior and permissible arguments are the same as for the @option{-mtune=}
3504 command-line option.
3506 @item cpu=
3507 @cindex @code{cpu=} function attribute, AArch64
3508 Specifies the core for which to tune the performance of this function and also
3509 whose architectural features to use.  The behavior and valid arguments are the
3510 same as for the @option{-mcpu=} command-line option.
3512 @end table
3514 The above target attributes can be specified as follows:
3516 @smallexample
3517 __attribute__((target("@var{attr-string}")))
3519 f (int a)
3521   return a + 5;
3523 @end smallexample
3525 where @code{@var{attr-string}} is one of the attribute strings specified above.
3527 Additionally, the architectural extension string may be specified on its
3528 own.  This can be used to turn on and off particular architectural extensions
3529 without having to specify a particular architecture version or core.  Example:
3531 @smallexample
3532 __attribute__((target("+crc+nocrypto")))
3534 foo (int a)
3536   return a + 5;
3538 @end smallexample
3540 In this example @code{target("+crc+nocrypto")} enables the @code{crc}
3541 extension and disables the @code{crypto} extension for the function @code{foo}
3542 without modifying an existing @option{-march=} or @option{-mcpu} option.
3544 Multiple target function attributes can be specified by separating them with
3545 a comma.  For example:
3546 @smallexample
3547 __attribute__((target("arch=armv8-a+crc+crypto,tune=cortex-a53")))
3549 foo (int a)
3551   return a + 5;
3553 @end smallexample
3555 is valid and compiles function @code{foo} for ARMv8-A with @code{crc}
3556 and @code{crypto} extensions and tunes it for @code{cortex-a53}.
3558 @subsubsection Inlining rules
3559 Specifying target attributes on individual functions or performing link-time
3560 optimization across translation units compiled with different target options
3561 can affect function inlining rules:
3563 In particular, a caller function can inline a callee function only if the
3564 architectural features available to the callee are a subset of the features
3565 available to the caller.
3566 For example: A function @code{foo} compiled with @option{-march=armv8-a+crc},
3567 or tagged with the equivalent @code{arch=armv8-a+crc} attribute,
3568 can inline a function @code{bar} compiled with @option{-march=armv8-a+nocrc}
3569 because the all the architectural features that function @code{bar} requires
3570 are available to function @code{foo}.  Conversely, function @code{bar} cannot
3571 inline function @code{foo}.
3573 Additionally inlining a function compiled with @option{-mstrict-align} into a
3574 function compiled without @code{-mstrict-align} is not allowed.
3575 However, inlining a function compiled without @option{-mstrict-align} into a
3576 function compiled with @option{-mstrict-align} is allowed.
3578 Note that CPU tuning options and attributes such as the @option{-mcpu=},
3579 @option{-mtune=} do not inhibit inlining unless the CPU specified by the
3580 @option{-mcpu=} option or the @code{cpu=} attribute conflicts with the
3581 architectural feature rules specified above.
3583 @node ARC Function Attributes
3584 @subsection ARC Function Attributes
3586 These function attributes are supported by the ARC back end:
3588 @table @code
3589 @item interrupt
3590 @cindex @code{interrupt} function attribute, ARC
3591 Use this attribute to indicate
3592 that the specified function is an interrupt handler.  The compiler generates
3593 function entry and exit sequences suitable for use in an interrupt handler
3594 when this attribute is present.
3596 On the ARC, you must specify the kind of interrupt to be handled
3597 in a parameter to the interrupt attribute like this:
3599 @smallexample
3600 void f () __attribute__ ((interrupt ("ilink1")));
3601 @end smallexample
3603 Permissible values for this parameter are: @w{@code{ilink1}} and
3604 @w{@code{ilink2}}.
3606 @item long_call
3607 @itemx medium_call
3608 @itemx short_call
3609 @cindex @code{long_call} function attribute, ARC
3610 @cindex @code{medium_call} function attribute, ARC
3611 @cindex @code{short_call} function attribute, ARC
3612 @cindex indirect calls, ARC
3613 These attributes specify how a particular function is called.
3614 These attributes override the
3615 @option{-mlong-calls} and @option{-mmedium-calls} (@pxref{ARC Options})
3616 command-line switches and @code{#pragma long_calls} settings.
3618 For ARC, a function marked with the @code{long_call} attribute is
3619 always called using register-indirect jump-and-link instructions,
3620 thereby enabling the called function to be placed anywhere within the
3621 32-bit address space.  A function marked with the @code{medium_call}
3622 attribute will always be close enough to be called with an unconditional
3623 branch-and-link instruction, which has a 25-bit offset from
3624 the call site.  A function marked with the @code{short_call}
3625 attribute will always be close enough to be called with a conditional
3626 branch-and-link instruction, which has a 21-bit offset from
3627 the call site.
3628 @end table
3630 @node ARM Function Attributes
3631 @subsection ARM Function Attributes
3633 These function attributes are supported for ARM targets:
3635 @table @code
3636 @item interrupt
3637 @cindex @code{interrupt} function attribute, ARM
3638 Use this attribute to indicate
3639 that the specified function is an interrupt handler.  The compiler generates
3640 function entry and exit sequences suitable for use in an interrupt handler
3641 when this attribute is present.
3643 You can specify the kind of interrupt to be handled by
3644 adding an optional parameter to the interrupt attribute like this:
3646 @smallexample
3647 void f () __attribute__ ((interrupt ("IRQ")));
3648 @end smallexample
3650 @noindent
3651 Permissible values for this parameter are: @code{IRQ}, @code{FIQ},
3652 @code{SWI}, @code{ABORT} and @code{UNDEF}.
3654 On ARMv7-M the interrupt type is ignored, and the attribute means the function
3655 may be called with a word-aligned stack pointer.
3657 @item isr
3658 @cindex @code{isr} function attribute, ARM
3659 Use this attribute on ARM to write Interrupt Service Routines. This is an
3660 alias to the @code{interrupt} attribute above.
3662 @item long_call
3663 @itemx short_call
3664 @cindex @code{long_call} function attribute, ARM
3665 @cindex @code{short_call} function attribute, ARM
3666 @cindex indirect calls, ARM
3667 These attributes specify how a particular function is called.
3668 These attributes override the
3669 @option{-mlong-calls} (@pxref{ARM Options})
3670 command-line switch and @code{#pragma long_calls} settings.  For ARM, the
3671 @code{long_call} attribute indicates that the function might be far
3672 away from the call site and require a different (more expensive)
3673 calling sequence.   The @code{short_call} attribute always places
3674 the offset to the function from the call site into the @samp{BL}
3675 instruction directly.
3677 @item naked
3678 @cindex @code{naked} function attribute, ARM
3679 This attribute allows the compiler to construct the
3680 requisite function declaration, while allowing the body of the
3681 function to be assembly code. The specified function will not have
3682 prologue/epilogue sequences generated by the compiler. Only basic
3683 @code{asm} statements can safely be included in naked functions
3684 (@pxref{Basic Asm}). While using extended @code{asm} or a mixture of
3685 basic @code{asm} and C code may appear to work, they cannot be
3686 depended upon to work reliably and are not supported.
3688 @item pcs
3689 @cindex @code{pcs} function attribute, ARM
3691 The @code{pcs} attribute can be used to control the calling convention
3692 used for a function on ARM.  The attribute takes an argument that specifies
3693 the calling convention to use.
3695 When compiling using the AAPCS ABI (or a variant of it) then valid
3696 values for the argument are @code{"aapcs"} and @code{"aapcs-vfp"}.  In
3697 order to use a variant other than @code{"aapcs"} then the compiler must
3698 be permitted to use the appropriate co-processor registers (i.e., the
3699 VFP registers must be available in order to use @code{"aapcs-vfp"}).
3700 For example,
3702 @smallexample
3703 /* Argument passed in r0, and result returned in r0+r1.  */
3704 double f2d (float) __attribute__((pcs("aapcs")));
3705 @end smallexample
3707 Variadic functions always use the @code{"aapcs"} calling convention and
3708 the compiler rejects attempts to specify an alternative.
3710 @item target (@var{options})
3711 @cindex @code{target} function attribute
3712 As discussed in @ref{Common Function Attributes}, this attribute 
3713 allows specification of target-specific compilation options.
3715 On ARM, the following options are allowed:
3717 @table @samp
3718 @item thumb
3719 @cindex @code{target("thumb")} function attribute, ARM
3720 Force code generation in the Thumb (T16/T32) ISA, depending on the
3721 architecture level.
3723 @item arm
3724 @cindex @code{target("arm")} function attribute, ARM
3725 Force code generation in the ARM (A32) ISA.
3727 Functions from different modes can be inlined in the caller's mode.
3729 @item fpu=
3730 @cindex @code{target("fpu=")} function attribute, ARM
3731 Specifies the fpu for which to tune the performance of this function.
3732 The behavior and permissible arguments are the same as for the @option{-mfpu=}
3733 command-line option.
3735 @end table
3737 @end table
3739 @node AVR Function Attributes
3740 @subsection AVR Function Attributes
3742 These function attributes are supported by the AVR back end:
3744 @table @code
3745 @item interrupt
3746 @cindex @code{interrupt} function attribute, AVR
3747 Use this attribute to indicate
3748 that the specified function is an interrupt handler.  The compiler generates
3749 function entry and exit sequences suitable for use in an interrupt handler
3750 when this attribute is present.
3752 On the AVR, the hardware globally disables interrupts when an
3753 interrupt is executed.  The first instruction of an interrupt handler
3754 declared with this attribute is a @code{SEI} instruction to
3755 re-enable interrupts.  See also the @code{signal} function attribute
3756 that does not insert a @code{SEI} instruction.  If both @code{signal} and
3757 @code{interrupt} are specified for the same function, @code{signal}
3758 is silently ignored.
3760 @item naked
3761 @cindex @code{naked} function attribute, AVR
3762 This attribute allows the compiler to construct the
3763 requisite function declaration, while allowing the body of the
3764 function to be assembly code. The specified function will not have
3765 prologue/epilogue sequences generated by the compiler. Only basic
3766 @code{asm} statements can safely be included in naked functions
3767 (@pxref{Basic Asm}). While using extended @code{asm} or a mixture of
3768 basic @code{asm} and C code may appear to work, they cannot be
3769 depended upon to work reliably and are not supported.
3771 @item OS_main
3772 @itemx OS_task
3773 @cindex @code{OS_main} function attribute, AVR
3774 @cindex @code{OS_task} function attribute, AVR
3775 On AVR, functions with the @code{OS_main} or @code{OS_task} attribute
3776 do not save/restore any call-saved register in their prologue/epilogue.
3778 The @code{OS_main} attribute can be used when there @emph{is
3779 guarantee} that interrupts are disabled at the time when the function
3780 is entered.  This saves resources when the stack pointer has to be
3781 changed to set up a frame for local variables.
3783 The @code{OS_task} attribute can be used when there is @emph{no
3784 guarantee} that interrupts are disabled at that time when the function
3785 is entered like for, e@.g@. task functions in a multi-threading operating
3786 system. In that case, changing the stack pointer register is
3787 guarded by save/clear/restore of the global interrupt enable flag.
3789 The differences to the @code{naked} function attribute are:
3790 @itemize @bullet
3791 @item @code{naked} functions do not have a return instruction whereas 
3792 @code{OS_main} and @code{OS_task} functions have a @code{RET} or
3793 @code{RETI} return instruction.
3794 @item @code{naked} functions do not set up a frame for local variables
3795 or a frame pointer whereas @code{OS_main} and @code{OS_task} do this
3796 as needed.
3797 @end itemize
3799 @item signal
3800 @cindex @code{signal} function attribute, AVR
3801 Use this attribute on the AVR to indicate that the specified
3802 function is an interrupt handler.  The compiler generates function
3803 entry and exit sequences suitable for use in an interrupt handler when this
3804 attribute is present.
3806 See also the @code{interrupt} function attribute. 
3808 The AVR hardware globally disables interrupts when an interrupt is executed.
3809 Interrupt handler functions defined with the @code{signal} attribute
3810 do not re-enable interrupts.  It is save to enable interrupts in a
3811 @code{signal} handler.  This ``save'' only applies to the code
3812 generated by the compiler and not to the IRQ layout of the
3813 application which is responsibility of the application.
3815 If both @code{signal} and @code{interrupt} are specified for the same
3816 function, @code{signal} is silently ignored.
3817 @end table
3819 @node Blackfin Function Attributes
3820 @subsection Blackfin Function Attributes
3822 These function attributes are supported by the Blackfin back end:
3824 @table @code
3826 @item exception_handler
3827 @cindex @code{exception_handler} function attribute
3828 @cindex exception handler functions, Blackfin
3829 Use this attribute on the Blackfin to indicate that the specified function
3830 is an exception handler.  The compiler generates function entry and
3831 exit sequences suitable for use in an exception handler when this
3832 attribute is present.
3834 @item interrupt_handler
3835 @cindex @code{interrupt_handler} function attribute, Blackfin
3836 Use this attribute to
3837 indicate that the specified function is an interrupt handler.  The compiler
3838 generates function entry and exit sequences suitable for use in an
3839 interrupt handler when this attribute is present.
3841 @item kspisusp
3842 @cindex @code{kspisusp} function attribute, Blackfin
3843 @cindex User stack pointer in interrupts on the Blackfin
3844 When used together with @code{interrupt_handler}, @code{exception_handler}
3845 or @code{nmi_handler}, code is generated to load the stack pointer
3846 from the USP register in the function prologue.
3848 @item l1_text
3849 @cindex @code{l1_text} function attribute, Blackfin
3850 This attribute specifies a function to be placed into L1 Instruction
3851 SRAM@. The function is put into a specific section named @code{.l1.text}.
3852 With @option{-mfdpic}, function calls with a such function as the callee
3853 or caller uses inlined PLT.
3855 @item l2
3856 @cindex @code{l2} function attribute, Blackfin
3857 This attribute specifies a function to be placed into L2
3858 SRAM. The function is put into a specific section named
3859 @code{.l2.text}. With @option{-mfdpic}, callers of such functions use
3860 an inlined PLT.
3862 @item longcall
3863 @itemx shortcall
3864 @cindex indirect calls, Blackfin
3865 @cindex @code{longcall} function attribute, Blackfin
3866 @cindex @code{shortcall} function attribute, Blackfin
3867 The @code{longcall} attribute
3868 indicates that the function might be far away from the call site and
3869 require a different (more expensive) calling sequence.  The
3870 @code{shortcall} attribute indicates that the function is always close
3871 enough for the shorter calling sequence to be used.  These attributes
3872 override the @option{-mlongcall} switch.
3874 @item nesting
3875 @cindex @code{nesting} function attribute, Blackfin
3876 @cindex Allow nesting in an interrupt handler on the Blackfin processor
3877 Use this attribute together with @code{interrupt_handler},
3878 @code{exception_handler} or @code{nmi_handler} to indicate that the function
3879 entry code should enable nested interrupts or exceptions.
3881 @item nmi_handler
3882 @cindex @code{nmi_handler} function attribute, Blackfin
3883 @cindex NMI handler functions on the Blackfin processor
3884 Use this attribute on the Blackfin to indicate that the specified function
3885 is an NMI handler.  The compiler generates function entry and
3886 exit sequences suitable for use in an NMI handler when this
3887 attribute is present.
3889 @item saveall
3890 @cindex @code{saveall} function attribute, Blackfin
3891 @cindex save all registers on the Blackfin
3892 Use this attribute to indicate that
3893 all registers except the stack pointer should be saved in the prologue
3894 regardless of whether they are used or not.
3895 @end table
3897 @node CR16 Function Attributes
3898 @subsection CR16 Function Attributes
3900 These function attributes are supported by the CR16 back end:
3902 @table @code
3903 @item interrupt
3904 @cindex @code{interrupt} function attribute, CR16
3905 Use this attribute to indicate
3906 that the specified function is an interrupt handler.  The compiler generates
3907 function entry and exit sequences suitable for use in an interrupt handler
3908 when this attribute is present.
3909 @end table
3911 @node Epiphany Function Attributes
3912 @subsection Epiphany Function Attributes
3914 These function attributes are supported by the Epiphany back end:
3916 @table @code
3917 @item disinterrupt
3918 @cindex @code{disinterrupt} function attribute, Epiphany
3919 This attribute causes the compiler to emit
3920 instructions to disable interrupts for the duration of the given
3921 function.
3923 @item forwarder_section
3924 @cindex @code{forwarder_section} function attribute, Epiphany
3925 This attribute modifies the behavior of an interrupt handler.
3926 The interrupt handler may be in external memory which cannot be
3927 reached by a branch instruction, so generate a local memory trampoline
3928 to transfer control.  The single parameter identifies the section where
3929 the trampoline is placed.
3931 @item interrupt
3932 @cindex @code{interrupt} function attribute, Epiphany
3933 Use this attribute to indicate
3934 that the specified function is an interrupt handler.  The compiler generates
3935 function entry and exit sequences suitable for use in an interrupt handler
3936 when this attribute is present.  It may also generate
3937 a special section with code to initialize the interrupt vector table.
3939 On Epiphany targets one or more optional parameters can be added like this:
3941 @smallexample
3942 void __attribute__ ((interrupt ("dma0, dma1"))) universal_dma_handler ();
3943 @end smallexample
3945 Permissible values for these parameters are: @w{@code{reset}},
3946 @w{@code{software_exception}}, @w{@code{page_miss}},
3947 @w{@code{timer0}}, @w{@code{timer1}}, @w{@code{message}},
3948 @w{@code{dma0}}, @w{@code{dma1}}, @w{@code{wand}} and @w{@code{swi}}.
3949 Multiple parameters indicate that multiple entries in the interrupt
3950 vector table should be initialized for this function, i.e.@: for each
3951 parameter @w{@var{name}}, a jump to the function is emitted in
3952 the section @w{ivt_entry_@var{name}}.  The parameter(s) may be omitted
3953 entirely, in which case no interrupt vector table entry is provided.
3955 Note that interrupts are enabled inside the function
3956 unless the @code{disinterrupt} attribute is also specified.
3958 The following examples are all valid uses of these attributes on
3959 Epiphany targets:
3960 @smallexample
3961 void __attribute__ ((interrupt)) universal_handler ();
3962 void __attribute__ ((interrupt ("dma1"))) dma1_handler ();
3963 void __attribute__ ((interrupt ("dma0, dma1"))) 
3964   universal_dma_handler ();
3965 void __attribute__ ((interrupt ("timer0"), disinterrupt))
3966   fast_timer_handler ();
3967 void __attribute__ ((interrupt ("dma0, dma1"), 
3968                      forwarder_section ("tramp")))
3969   external_dma_handler ();
3970 @end smallexample
3972 @item long_call
3973 @itemx short_call
3974 @cindex @code{long_call} function attribute, Epiphany
3975 @cindex @code{short_call} function attribute, Epiphany
3976 @cindex indirect calls, Epiphany
3977 These attributes specify how a particular function is called.
3978 These attributes override the
3979 @option{-mlong-calls} (@pxref{Adapteva Epiphany Options})
3980 command-line switch and @code{#pragma long_calls} settings.
3981 @end table
3984 @node H8/300 Function Attributes
3985 @subsection H8/300 Function Attributes
3987 These function attributes are available for H8/300 targets:
3989 @table @code
3990 @item function_vector
3991 @cindex @code{function_vector} function attribute, H8/300
3992 Use this attribute on the H8/300, H8/300H, and H8S to indicate 
3993 that the specified function should be called through the function vector.
3994 Calling a function through the function vector reduces code size; however,
3995 the function vector has a limited size (maximum 128 entries on the H8/300
3996 and 64 entries on the H8/300H and H8S)
3997 and shares space with the interrupt vector.
3999 @item interrupt_handler
4000 @cindex @code{interrupt_handler} function attribute, H8/300
4001 Use this attribute on the H8/300, H8/300H, and H8S to
4002 indicate that the specified function is an interrupt handler.  The compiler
4003 generates function entry and exit sequences suitable for use in an
4004 interrupt handler when this attribute is present.
4006 @item saveall
4007 @cindex @code{saveall} function attribute, H8/300
4008 @cindex save all registers on the H8/300, H8/300H, and H8S
4009 Use this attribute on the H8/300, H8/300H, and H8S to indicate that
4010 all registers except the stack pointer should be saved in the prologue
4011 regardless of whether they are used or not.
4012 @end table
4014 @node IA-64 Function Attributes
4015 @subsection IA-64 Function Attributes
4017 These function attributes are supported on IA-64 targets:
4019 @table @code
4020 @item syscall_linkage
4021 @cindex @code{syscall_linkage} function attribute, IA-64
4022 This attribute is used to modify the IA-64 calling convention by marking
4023 all input registers as live at all function exits.  This makes it possible
4024 to restart a system call after an interrupt without having to save/restore
4025 the input registers.  This also prevents kernel data from leaking into
4026 application code.
4028 @item version_id
4029 @cindex @code{version_id} function attribute, IA-64
4030 This IA-64 HP-UX attribute, attached to a global variable or function, renames a
4031 symbol to contain a version string, thus allowing for function level
4032 versioning.  HP-UX system header files may use function level versioning
4033 for some system calls.
4035 @smallexample
4036 extern int foo () __attribute__((version_id ("20040821")));
4037 @end smallexample
4039 @noindent
4040 Calls to @code{foo} are mapped to calls to @code{foo@{20040821@}}.
4041 @end table
4043 @node M32C Function Attributes
4044 @subsection M32C Function Attributes
4046 These function attributes are supported by the M32C back end:
4048 @table @code
4049 @item bank_switch
4050 @cindex @code{bank_switch} function attribute, M32C
4051 When added to an interrupt handler with the M32C port, causes the
4052 prologue and epilogue to use bank switching to preserve the registers
4053 rather than saving them on the stack.
4055 @item fast_interrupt
4056 @cindex @code{fast_interrupt} function attribute, M32C
4057 Use this attribute on the M32C port to indicate that the specified
4058 function is a fast interrupt handler.  This is just like the
4059 @code{interrupt} attribute, except that @code{freit} is used to return
4060 instead of @code{reit}.
4062 @item function_vector
4063 @cindex @code{function_vector} function attribute, M16C/M32C
4064 On M16C/M32C targets, the @code{function_vector} attribute declares a
4065 special page subroutine call function. Use of this attribute reduces
4066 the code size by 2 bytes for each call generated to the
4067 subroutine. The argument to the attribute is the vector number entry
4068 from the special page vector table which contains the 16 low-order
4069 bits of the subroutine's entry address. Each vector table has special
4070 page number (18 to 255) that is used in @code{jsrs} instructions.
4071 Jump addresses of the routines are generated by adding 0x0F0000 (in
4072 case of M16C targets) or 0xFF0000 (in case of M32C targets), to the
4073 2-byte addresses set in the vector table. Therefore you need to ensure
4074 that all the special page vector routines should get mapped within the
4075 address range 0x0F0000 to 0x0FFFFF (for M16C) and 0xFF0000 to 0xFFFFFF
4076 (for M32C).
4078 In the following example 2 bytes are saved for each call to
4079 function @code{foo}.
4081 @smallexample
4082 void foo (void) __attribute__((function_vector(0x18)));
4083 void foo (void)
4087 void bar (void)
4089     foo();
4091 @end smallexample
4093 If functions are defined in one file and are called in another file,
4094 then be sure to write this declaration in both files.
4096 This attribute is ignored for R8C target.
4098 @item interrupt
4099 @cindex @code{interrupt} function attribute, M32C
4100 Use this attribute to indicate
4101 that the specified function is an interrupt handler.  The compiler generates
4102 function entry and exit sequences suitable for use in an interrupt handler
4103 when this attribute is present.
4104 @end table
4106 @node M32R/D Function Attributes
4107 @subsection M32R/D Function Attributes
4109 These function attributes are supported by the M32R/D back end:
4111 @table @code
4112 @item interrupt
4113 @cindex @code{interrupt} function attribute, M32R/D
4114 Use this attribute to indicate
4115 that the specified function is an interrupt handler.  The compiler generates
4116 function entry and exit sequences suitable for use in an interrupt handler
4117 when this attribute is present.
4119 @item model (@var{model-name})
4120 @cindex @code{model} function attribute, M32R/D
4121 @cindex function addressability on the M32R/D
4123 On the M32R/D, use this attribute to set the addressability of an
4124 object, and of the code generated for a function.  The identifier
4125 @var{model-name} is one of @code{small}, @code{medium}, or
4126 @code{large}, representing each of the code models.
4128 Small model objects live in the lower 16MB of memory (so that their
4129 addresses can be loaded with the @code{ld24} instruction), and are
4130 callable with the @code{bl} instruction.
4132 Medium model objects may live anywhere in the 32-bit address space (the
4133 compiler generates @code{seth/add3} instructions to load their addresses),
4134 and are callable with the @code{bl} instruction.
4136 Large model objects may live anywhere in the 32-bit address space (the
4137 compiler generates @code{seth/add3} instructions to load their addresses),
4138 and may not be reachable with the @code{bl} instruction (the compiler
4139 generates the much slower @code{seth/add3/jl} instruction sequence).
4140 @end table
4142 @node m68k Function Attributes
4143 @subsection m68k Function Attributes
4145 These function attributes are supported by the m68k back end:
4147 @table @code
4148 @item interrupt
4149 @itemx interrupt_handler
4150 @cindex @code{interrupt} function attribute, m68k
4151 @cindex @code{interrupt_handler} function attribute, m68k
4152 Use this attribute to
4153 indicate that the specified function is an interrupt handler.  The compiler
4154 generates function entry and exit sequences suitable for use in an
4155 interrupt handler when this attribute is present.  Either name may be used.
4157 @item interrupt_thread
4158 @cindex @code{interrupt_thread} function attribute, fido
4159 Use this attribute on fido, a subarchitecture of the m68k, to indicate
4160 that the specified function is an interrupt handler that is designed
4161 to run as a thread.  The compiler omits generate prologue/epilogue
4162 sequences and replaces the return instruction with a @code{sleep}
4163 instruction.  This attribute is available only on fido.
4164 @end table
4166 @node MCORE Function Attributes
4167 @subsection MCORE Function Attributes
4169 These function attributes are supported by the MCORE back end:
4171 @table @code
4172 @item naked
4173 @cindex @code{naked} function attribute, MCORE
4174 This attribute allows the compiler to construct the
4175 requisite function declaration, while allowing the body of the
4176 function to be assembly code. The specified function will not have
4177 prologue/epilogue sequences generated by the compiler. Only basic
4178 @code{asm} statements can safely be included in naked functions
4179 (@pxref{Basic Asm}). While using extended @code{asm} or a mixture of
4180 basic @code{asm} and C code may appear to work, they cannot be
4181 depended upon to work reliably and are not supported.
4182 @end table
4184 @node MeP Function Attributes
4185 @subsection MeP Function Attributes
4187 These function attributes are supported by the MeP back end:
4189 @table @code
4190 @item disinterrupt
4191 @cindex @code{disinterrupt} function attribute, MeP
4192 On MeP targets, this attribute causes the compiler to emit
4193 instructions to disable interrupts for the duration of the given
4194 function.
4196 @item interrupt
4197 @cindex @code{interrupt} function attribute, MeP
4198 Use this attribute to indicate
4199 that the specified function is an interrupt handler.  The compiler generates
4200 function entry and exit sequences suitable for use in an interrupt handler
4201 when this attribute is present.
4203 @item near
4204 @cindex @code{near} function attribute, MeP
4205 This attribute causes the compiler to assume the called
4206 function is close enough to use the normal calling convention,
4207 overriding the @option{-mtf} command-line option.
4209 @item far
4210 @cindex @code{far} function attribute, MeP
4211 On MeP targets this causes the compiler to use a calling convention
4212 that assumes the called function is too far away for the built-in
4213 addressing modes.
4215 @item vliw
4216 @cindex @code{vliw} function attribute, MeP
4217 The @code{vliw} attribute tells the compiler to emit
4218 instructions in VLIW mode instead of core mode.  Note that this
4219 attribute is not allowed unless a VLIW coprocessor has been configured
4220 and enabled through command-line options.
4221 @end table
4223 @node MicroBlaze Function Attributes
4224 @subsection MicroBlaze Function Attributes
4226 These function attributes are supported on MicroBlaze targets:
4228 @table @code
4229 @item save_volatiles
4230 @cindex @code{save_volatiles} function attribute, MicroBlaze
4231 Use this attribute to indicate that the function is
4232 an interrupt handler.  All volatile registers (in addition to non-volatile
4233 registers) are saved in the function prologue.  If the function is a leaf
4234 function, only volatiles used by the function are saved.  A normal function
4235 return is generated instead of a return from interrupt.
4237 @item break_handler
4238 @cindex @code{break_handler} function attribute, MicroBlaze
4239 @cindex break handler functions
4240 Use this attribute to indicate that
4241 the specified function is a break handler.  The compiler generates function
4242 entry and exit sequences suitable for use in an break handler when this
4243 attribute is present. The return from @code{break_handler} is done through
4244 the @code{rtbd} instead of @code{rtsd}.
4246 @smallexample
4247 void f () __attribute__ ((break_handler));
4248 @end smallexample
4250 @item interrupt_handler
4251 @itemx fast_interrupt 
4252 @cindex @code{interrupt_handler} function attribute, MicroBlaze
4253 @cindex @code{fast_interrupt} function attribute, MicroBlaze
4254 These attributes indicate that the specified function is an interrupt
4255 handler.  Use the @code{fast_interrupt} attribute to indicate handlers
4256 used in low-latency interrupt mode, and @code{interrupt_handler} for
4257 interrupts that do not use low-latency handlers.  In both cases, GCC
4258 emits appropriate prologue code and generates a return from the handler
4259 using @code{rtid} instead of @code{rtsd}.
4260 @end table
4262 @node Microsoft Windows Function Attributes
4263 @subsection Microsoft Windows Function Attributes
4265 The following attributes are available on Microsoft Windows and Symbian OS
4266 targets.
4268 @table @code
4269 @item dllexport
4270 @cindex @code{dllexport} function attribute
4271 @cindex @code{__declspec(dllexport)}
4272 On Microsoft Windows targets and Symbian OS targets the
4273 @code{dllexport} attribute causes the compiler to provide a global
4274 pointer to a pointer in a DLL, so that it can be referenced with the
4275 @code{dllimport} attribute.  On Microsoft Windows targets, the pointer
4276 name is formed by combining @code{_imp__} and the function or variable
4277 name.
4279 You can use @code{__declspec(dllexport)} as a synonym for
4280 @code{__attribute__ ((dllexport))} for compatibility with other
4281 compilers.
4283 On systems that support the @code{visibility} attribute, this
4284 attribute also implies ``default'' visibility.  It is an error to
4285 explicitly specify any other visibility.
4287 GCC's default behavior is to emit all inline functions with the
4288 @code{dllexport} attribute.  Since this can cause object file-size bloat,
4289 you can use @option{-fno-keep-inline-dllexport}, which tells GCC to
4290 ignore the attribute for inlined functions unless the 
4291 @option{-fkeep-inline-functions} flag is used instead.
4293 The attribute is ignored for undefined symbols.
4295 When applied to C++ classes, the attribute marks defined non-inlined
4296 member functions and static data members as exports.  Static consts
4297 initialized in-class are not marked unless they are also defined
4298 out-of-class.
4300 For Microsoft Windows targets there are alternative methods for
4301 including the symbol in the DLL's export table such as using a
4302 @file{.def} file with an @code{EXPORTS} section or, with GNU ld, using
4303 the @option{--export-all} linker flag.
4305 @item dllimport
4306 @cindex @code{dllimport} function attribute
4307 @cindex @code{__declspec(dllimport)}
4308 On Microsoft Windows and Symbian OS targets, the @code{dllimport}
4309 attribute causes the compiler to reference a function or variable via
4310 a global pointer to a pointer that is set up by the DLL exporting the
4311 symbol.  The attribute implies @code{extern}.  On Microsoft Windows
4312 targets, the pointer name is formed by combining @code{_imp__} and the
4313 function or variable name.
4315 You can use @code{__declspec(dllimport)} as a synonym for
4316 @code{__attribute__ ((dllimport))} for compatibility with other
4317 compilers.
4319 On systems that support the @code{visibility} attribute, this
4320 attribute also implies ``default'' visibility.  It is an error to
4321 explicitly specify any other visibility.
4323 Currently, the attribute is ignored for inlined functions.  If the
4324 attribute is applied to a symbol @emph{definition}, an error is reported.
4325 If a symbol previously declared @code{dllimport} is later defined, the
4326 attribute is ignored in subsequent references, and a warning is emitted.
4327 The attribute is also overridden by a subsequent declaration as
4328 @code{dllexport}.
4330 When applied to C++ classes, the attribute marks non-inlined
4331 member functions and static data members as imports.  However, the
4332 attribute is ignored for virtual methods to allow creation of vtables
4333 using thunks.
4335 On the SH Symbian OS target the @code{dllimport} attribute also has
4336 another affect---it can cause the vtable and run-time type information
4337 for a class to be exported.  This happens when the class has a
4338 dllimported constructor or a non-inline, non-pure virtual function
4339 and, for either of those two conditions, the class also has an inline
4340 constructor or destructor and has a key function that is defined in
4341 the current translation unit.
4343 For Microsoft Windows targets the use of the @code{dllimport}
4344 attribute on functions is not necessary, but provides a small
4345 performance benefit by eliminating a thunk in the DLL@.  The use of the
4346 @code{dllimport} attribute on imported variables can be avoided by passing the
4347 @option{--enable-auto-import} switch to the GNU linker.  As with
4348 functions, using the attribute for a variable eliminates a thunk in
4349 the DLL@.
4351 One drawback to using this attribute is that a pointer to a
4352 @emph{variable} marked as @code{dllimport} cannot be used as a constant
4353 address. However, a pointer to a @emph{function} with the
4354 @code{dllimport} attribute can be used as a constant initializer; in
4355 this case, the address of a stub function in the import lib is
4356 referenced.  On Microsoft Windows targets, the attribute can be disabled
4357 for functions by setting the @option{-mnop-fun-dllimport} flag.
4358 @end table
4360 @node MIPS Function Attributes
4361 @subsection MIPS Function Attributes
4363 These function attributes are supported by the MIPS back end:
4365 @table @code
4366 @item interrupt
4367 @cindex @code{interrupt} function attribute, MIPS
4368 Use this attribute to indicate that the specified function is an interrupt
4369 handler.  The compiler generates function entry and exit sequences suitable
4370 for use in an interrupt handler when this attribute is present.
4371 An optional argument is supported for the interrupt attribute which allows
4372 the interrupt mode to be described.  By default GCC assumes the external
4373 interrupt controller (EIC) mode is in use, this can be explicitly set using
4374 @code{eic}.  When interrupts are non-masked then the requested Interrupt
4375 Priority Level (IPL) is copied to the current IPL which has the effect of only
4376 enabling higher priority interrupts.  To use vectored interrupt mode use
4377 the argument @code{vector=[sw0|sw1|hw0|hw1|hw2|hw3|hw4|hw5]}, this will change
4378 the behavior of the non-masked interrupt support and GCC will arrange to mask
4379 all interrupts from sw0 up to and including the specified interrupt vector.
4381 You can use the following attributes to modify the behavior
4382 of an interrupt handler:
4383 @table @code
4384 @item use_shadow_register_set
4385 @cindex @code{use_shadow_register_set} function attribute, MIPS
4386 Assume that the handler uses a shadow register set, instead of
4387 the main general-purpose registers.  An optional argument @code{intstack} is
4388 supported to indicate that the shadow register set contains a valid stack
4389 pointer.
4391 @item keep_interrupts_masked
4392 @cindex @code{keep_interrupts_masked} function attribute, MIPS
4393 Keep interrupts masked for the whole function.  Without this attribute,
4394 GCC tries to reenable interrupts for as much of the function as it can.
4396 @item use_debug_exception_return
4397 @cindex @code{use_debug_exception_return} function attribute, MIPS
4398 Return using the @code{deret} instruction.  Interrupt handlers that don't
4399 have this attribute return using @code{eret} instead.
4400 @end table
4402 You can use any combination of these attributes, as shown below:
4403 @smallexample
4404 void __attribute__ ((interrupt)) v0 ();
4405 void __attribute__ ((interrupt, use_shadow_register_set)) v1 ();
4406 void __attribute__ ((interrupt, keep_interrupts_masked)) v2 ();
4407 void __attribute__ ((interrupt, use_debug_exception_return)) v3 ();
4408 void __attribute__ ((interrupt, use_shadow_register_set,
4409                      keep_interrupts_masked)) v4 ();
4410 void __attribute__ ((interrupt, use_shadow_register_set,
4411                      use_debug_exception_return)) v5 ();
4412 void __attribute__ ((interrupt, keep_interrupts_masked,
4413                      use_debug_exception_return)) v6 ();
4414 void __attribute__ ((interrupt, use_shadow_register_set,
4415                      keep_interrupts_masked,
4416                      use_debug_exception_return)) v7 ();
4417 void __attribute__ ((interrupt("eic"))) v8 ();
4418 void __attribute__ ((interrupt("vector=hw3"))) v9 ();
4419 @end smallexample
4421 @item long_call
4422 @itemx near
4423 @itemx far
4424 @cindex indirect calls, MIPS
4425 @cindex @code{long_call} function attribute, MIPS
4426 @cindex @code{near} function attribute, MIPS
4427 @cindex @code{far} function attribute, MIPS
4428 These attributes specify how a particular function is called on MIPS@.
4429 The attributes override the @option{-mlong-calls} (@pxref{MIPS Options})
4430 command-line switch.  The @code{long_call} and @code{far} attributes are
4431 synonyms, and cause the compiler to always call
4432 the function by first loading its address into a register, and then using
4433 the contents of that register.  The @code{near} attribute has the opposite
4434 effect; it specifies that non-PIC calls should be made using the more
4435 efficient @code{jal} instruction.
4437 @item mips16
4438 @itemx nomips16
4439 @cindex @code{mips16} function attribute, MIPS
4440 @cindex @code{nomips16} function attribute, MIPS
4442 On MIPS targets, you can use the @code{mips16} and @code{nomips16}
4443 function attributes to locally select or turn off MIPS16 code generation.
4444 A function with the @code{mips16} attribute is emitted as MIPS16 code,
4445 while MIPS16 code generation is disabled for functions with the
4446 @code{nomips16} attribute.  These attributes override the
4447 @option{-mips16} and @option{-mno-mips16} options on the command line
4448 (@pxref{MIPS Options}).
4450 When compiling files containing mixed MIPS16 and non-MIPS16 code, the
4451 preprocessor symbol @code{__mips16} reflects the setting on the command line,
4452 not that within individual functions.  Mixed MIPS16 and non-MIPS16 code
4453 may interact badly with some GCC extensions such as @code{__builtin_apply}
4454 (@pxref{Constructing Calls}).
4456 @item micromips, MIPS
4457 @itemx nomicromips, MIPS
4458 @cindex @code{micromips} function attribute
4459 @cindex @code{nomicromips} function attribute
4461 On MIPS targets, you can use the @code{micromips} and @code{nomicromips}
4462 function attributes to locally select or turn off microMIPS code generation.
4463 A function with the @code{micromips} attribute is emitted as microMIPS code,
4464 while microMIPS code generation is disabled for functions with the
4465 @code{nomicromips} attribute.  These attributes override the
4466 @option{-mmicromips} and @option{-mno-micromips} options on the command line
4467 (@pxref{MIPS Options}).
4469 When compiling files containing mixed microMIPS and non-microMIPS code, the
4470 preprocessor symbol @code{__mips_micromips} reflects the setting on the
4471 command line,
4472 not that within individual functions.  Mixed microMIPS and non-microMIPS code
4473 may interact badly with some GCC extensions such as @code{__builtin_apply}
4474 (@pxref{Constructing Calls}).
4476 @item nocompression
4477 @cindex @code{nocompression} function attribute, MIPS
4478 On MIPS targets, you can use the @code{nocompression} function attribute
4479 to locally turn off MIPS16 and microMIPS code generation.  This attribute
4480 overrides the @option{-mips16} and @option{-mmicromips} options on the
4481 command line (@pxref{MIPS Options}).
4482 @end table
4484 @node MSP430 Function Attributes
4485 @subsection MSP430 Function Attributes
4487 These function attributes are supported by the MSP430 back end:
4489 @table @code
4490 @item critical
4491 @cindex @code{critical} function attribute, MSP430
4492 Critical functions disable interrupts upon entry and restore the
4493 previous interrupt state upon exit.  Critical functions cannot also
4494 have the @code{naked} or @code{reentrant} attributes.  They can have
4495 the @code{interrupt} attribute.
4497 @item interrupt
4498 @cindex @code{interrupt} function attribute, MSP430
4499 Use this attribute to indicate
4500 that the specified function is an interrupt handler.  The compiler generates
4501 function entry and exit sequences suitable for use in an interrupt handler
4502 when this attribute is present.
4504 You can provide an argument to the interrupt
4505 attribute which specifies a name or number.  If the argument is a
4506 number it indicates the slot in the interrupt vector table (0 - 31) to
4507 which this handler should be assigned.  If the argument is a name it
4508 is treated as a symbolic name for the vector slot.  These names should
4509 match up with appropriate entries in the linker script.  By default
4510 the names @code{watchdog} for vector 26, @code{nmi} for vector 30 and
4511 @code{reset} for vector 31 are recognized.
4513 @item naked
4514 @cindex @code{naked} function attribute, MSP430
4515 This attribute allows the compiler to construct the
4516 requisite function declaration, while allowing the body of the
4517 function to be assembly code. The specified function will not have
4518 prologue/epilogue sequences generated by the compiler. Only basic
4519 @code{asm} statements can safely be included in naked functions
4520 (@pxref{Basic Asm}). While using extended @code{asm} or a mixture of
4521 basic @code{asm} and C code may appear to work, they cannot be
4522 depended upon to work reliably and are not supported.
4524 @item reentrant
4525 @cindex @code{reentrant} function attribute, MSP430
4526 Reentrant functions disable interrupts upon entry and enable them
4527 upon exit.  Reentrant functions cannot also have the @code{naked}
4528 or @code{critical} attributes.  They can have the @code{interrupt}
4529 attribute.
4531 @item wakeup
4532 @cindex @code{wakeup} function attribute, MSP430
4533 This attribute only applies to interrupt functions.  It is silently
4534 ignored if applied to a non-interrupt function.  A wakeup interrupt
4535 function will rouse the processor from any low-power state that it
4536 might be in when the function exits.
4538 @item lower
4539 @itemx upper
4540 @itemx either
4541 @cindex @code{lower} function attribute, MSP430
4542 @cindex @code{upper} function attribute, MSP430
4543 @cindex @code{either} function attribute, MSP430
4544 On the MSP430 target these attributes can be used to specify whether
4545 the function or variable should be placed into low memory, high
4546 memory, or the placement should be left to the linker to decide.  The
4547 attributes are only significant if compiling for the MSP430X
4548 architecture.
4550 The attributes work in conjunction with a linker script that has been
4551 augmented to specify where to place sections with a @code{.lower} and
4552 a @code{.upper} prefix.  So, for example, as well as placing the
4553 @code{.data} section, the script also specifies the placement of a
4554 @code{.lower.data} and a @code{.upper.data} section.  The intention
4555 is that @code{lower} sections are placed into a small but easier to
4556 access memory region and the upper sections are placed into a larger, but
4557 slower to access, region.
4559 The @code{either} attribute is special.  It tells the linker to place
4560 the object into the corresponding @code{lower} section if there is
4561 room for it.  If there is insufficient room then the object is placed
4562 into the corresponding @code{upper} section instead.  Note that the
4563 placement algorithm is not very sophisticated.  It does not attempt to
4564 find an optimal packing of the @code{lower} sections.  It just makes
4565 one pass over the objects and does the best that it can.  Using the
4566 @option{-ffunction-sections} and @option{-fdata-sections} command-line
4567 options can help the packing, however, since they produce smaller,
4568 easier to pack regions.
4569 @end table
4571 @node NDS32 Function Attributes
4572 @subsection NDS32 Function Attributes
4574 These function attributes are supported by the NDS32 back end:
4576 @table @code
4577 @item exception
4578 @cindex @code{exception} function attribute
4579 @cindex exception handler functions, NDS32
4580 Use this attribute on the NDS32 target to indicate that the specified function
4581 is an exception handler.  The compiler will generate corresponding sections
4582 for use in an exception handler.
4584 @item interrupt
4585 @cindex @code{interrupt} function attribute, NDS32
4586 On NDS32 target, this attribute indicates that the specified function
4587 is an interrupt handler.  The compiler generates corresponding sections
4588 for use in an interrupt handler.  You can use the following attributes
4589 to modify the behavior:
4590 @table @code
4591 @item nested
4592 @cindex @code{nested} function attribute, NDS32
4593 This interrupt service routine is interruptible.
4594 @item not_nested
4595 @cindex @code{not_nested} function attribute, NDS32
4596 This interrupt service routine is not interruptible.
4597 @item nested_ready
4598 @cindex @code{nested_ready} function attribute, NDS32
4599 This interrupt service routine is interruptible after @code{PSW.GIE}
4600 (global interrupt enable) is set.  This allows interrupt service routine to
4601 finish some short critical code before enabling interrupts.
4602 @item save_all
4603 @cindex @code{save_all} function attribute, NDS32
4604 The system will help save all registers into stack before entering
4605 interrupt handler.
4606 @item partial_save
4607 @cindex @code{partial_save} function attribute, NDS32
4608 The system will help save caller registers into stack before entering
4609 interrupt handler.
4610 @end table
4612 @item naked
4613 @cindex @code{naked} function attribute, NDS32
4614 This attribute allows the compiler to construct the
4615 requisite function declaration, while allowing the body of the
4616 function to be assembly code. The specified function will not have
4617 prologue/epilogue sequences generated by the compiler. Only basic
4618 @code{asm} statements can safely be included in naked functions
4619 (@pxref{Basic Asm}). While using extended @code{asm} or a mixture of
4620 basic @code{asm} and C code may appear to work, they cannot be
4621 depended upon to work reliably and are not supported.
4623 @item reset
4624 @cindex @code{reset} function attribute, NDS32
4625 @cindex reset handler functions
4626 Use this attribute on the NDS32 target to indicate that the specified function
4627 is a reset handler.  The compiler will generate corresponding sections
4628 for use in a reset handler.  You can use the following attributes
4629 to provide extra exception handling:
4630 @table @code
4631 @item nmi
4632 @cindex @code{nmi} function attribute, NDS32
4633 Provide a user-defined function to handle NMI exception.
4634 @item warm
4635 @cindex @code{warm} function attribute, NDS32
4636 Provide a user-defined function to handle warm reset exception.
4637 @end table
4638 @end table
4640 @node Nios II Function Attributes
4641 @subsection Nios II Function Attributes
4643 These function attributes are supported by the Nios II back end:
4645 @table @code
4646 @item target (@var{options})
4647 @cindex @code{target} function attribute
4648 As discussed in @ref{Common Function Attributes}, this attribute 
4649 allows specification of target-specific compilation options.
4651 When compiling for Nios II, the following options are allowed:
4653 @table @samp
4654 @item custom-@var{insn}=@var{N}
4655 @itemx no-custom-@var{insn}
4656 @cindex @code{target("custom-@var{insn}=@var{N}")} function attribute, Nios II
4657 @cindex @code{target("no-custom-@var{insn}")} function attribute, Nios II
4658 Each @samp{custom-@var{insn}=@var{N}} attribute locally enables use of a
4659 custom instruction with encoding @var{N} when generating code that uses 
4660 @var{insn}.  Similarly, @samp{no-custom-@var{insn}} locally inhibits use of
4661 the custom instruction @var{insn}.
4662 These target attributes correspond to the
4663 @option{-mcustom-@var{insn}=@var{N}} and @option{-mno-custom-@var{insn}}
4664 command-line options, and support the same set of @var{insn} keywords.
4665 @xref{Nios II Options}, for more information.
4667 @item custom-fpu-cfg=@var{name}
4668 @cindex @code{target("custom-fpu-cfg=@var{name}")} function attribute, Nios II
4669 This attribute corresponds to the @option{-mcustom-fpu-cfg=@var{name}}
4670 command-line option, to select a predefined set of custom instructions
4671 named @var{name}.
4672 @xref{Nios II Options}, for more information.
4673 @end table
4674 @end table
4676 @node Nvidia PTX Function Attributes
4677 @subsection Nvidia PTX Function Attributes
4679 These function attributes are supported by the Nvidia PTX back end:
4681 @table @code
4682 @item kernel
4683 @cindex @code{kernel} attribute, Nvidia PTX
4684 This attribute indicates that the corresponding function should be compiled
4685 as a kernel function, which can be invoked from the host via the CUDA RT 
4686 library.
4687 By default functions are only callable only from other PTX functions.
4689 Kernel functions must have @code{void} return type.
4690 @end table
4692 @node PowerPC Function Attributes
4693 @subsection PowerPC Function Attributes
4695 These function attributes are supported by the PowerPC back end:
4697 @table @code
4698 @item longcall
4699 @itemx shortcall
4700 @cindex indirect calls, PowerPC
4701 @cindex @code{longcall} function attribute, PowerPC
4702 @cindex @code{shortcall} function attribute, PowerPC
4703 The @code{longcall} attribute
4704 indicates that the function might be far away from the call site and
4705 require a different (more expensive) calling sequence.  The
4706 @code{shortcall} attribute indicates that the function is always close
4707 enough for the shorter calling sequence to be used.  These attributes
4708 override both the @option{-mlongcall} switch and
4709 the @code{#pragma longcall} setting.
4711 @xref{RS/6000 and PowerPC Options}, for more information on whether long
4712 calls are necessary.
4714 @item target (@var{options})
4715 @cindex @code{target} function attribute
4716 As discussed in @ref{Common Function Attributes}, this attribute 
4717 allows specification of target-specific compilation options.
4719 On the PowerPC, the following options are allowed:
4721 @table @samp
4722 @item altivec
4723 @itemx no-altivec
4724 @cindex @code{target("altivec")} function attribute, PowerPC
4725 Generate code that uses (does not use) AltiVec instructions.  In
4726 32-bit code, you cannot enable AltiVec instructions unless
4727 @option{-mabi=altivec} is used on the command line.
4729 @item cmpb
4730 @itemx no-cmpb
4731 @cindex @code{target("cmpb")} function attribute, PowerPC
4732 Generate code that uses (does not use) the compare bytes instruction
4733 implemented on the POWER6 processor and other processors that support
4734 the PowerPC V2.05 architecture.
4736 @item dlmzb
4737 @itemx no-dlmzb
4738 @cindex @code{target("dlmzb")} function attribute, PowerPC
4739 Generate code that uses (does not use) the string-search @samp{dlmzb}
4740 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
4741 generated by default when targeting those processors.
4743 @item fprnd
4744 @itemx no-fprnd
4745 @cindex @code{target("fprnd")} function attribute, PowerPC
4746 Generate code that uses (does not use) the FP round to integer
4747 instructions implemented on the POWER5+ processor and other processors
4748 that support the PowerPC V2.03 architecture.
4750 @item hard-dfp
4751 @itemx no-hard-dfp
4752 @cindex @code{target("hard-dfp")} function attribute, PowerPC
4753 Generate code that uses (does not use) the decimal floating-point
4754 instructions implemented on some POWER processors.
4756 @item isel
4757 @itemx no-isel
4758 @cindex @code{target("isel")} function attribute, PowerPC
4759 Generate code that uses (does not use) ISEL instruction.
4761 @item mfcrf
4762 @itemx no-mfcrf
4763 @cindex @code{target("mfcrf")} function attribute, PowerPC
4764 Generate code that uses (does not use) the move from condition
4765 register field instruction implemented on the POWER4 processor and
4766 other processors that support the PowerPC V2.01 architecture.
4768 @item mfpgpr
4769 @itemx no-mfpgpr
4770 @cindex @code{target("mfpgpr")} function attribute, PowerPC
4771 Generate code that uses (does not use) the FP move to/from general
4772 purpose register instructions implemented on the POWER6X processor and
4773 other processors that support the extended PowerPC V2.05 architecture.
4775 @item mulhw
4776 @itemx no-mulhw
4777 @cindex @code{target("mulhw")} function attribute, PowerPC
4778 Generate code that uses (does not use) the half-word multiply and
4779 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
4780 These instructions are generated by default when targeting those
4781 processors.
4783 @item multiple
4784 @itemx no-multiple
4785 @cindex @code{target("multiple")} function attribute, PowerPC
4786 Generate code that uses (does not use) the load multiple word
4787 instructions and the store multiple word instructions.
4789 @item update
4790 @itemx no-update
4791 @cindex @code{target("update")} function attribute, PowerPC
4792 Generate code that uses (does not use) the load or store instructions
4793 that update the base register to the address of the calculated memory
4794 location.
4796 @item popcntb
4797 @itemx no-popcntb
4798 @cindex @code{target("popcntb")} function attribute, PowerPC
4799 Generate code that uses (does not use) the popcount and double-precision
4800 FP reciprocal estimate instruction implemented on the POWER5
4801 processor and other processors that support the PowerPC V2.02
4802 architecture.
4804 @item popcntd
4805 @itemx no-popcntd
4806 @cindex @code{target("popcntd")} function attribute, PowerPC
4807 Generate code that uses (does not use) the popcount instruction
4808 implemented on the POWER7 processor and other processors that support
4809 the PowerPC V2.06 architecture.
4811 @item powerpc-gfxopt
4812 @itemx no-powerpc-gfxopt
4813 @cindex @code{target("powerpc-gfxopt")} function attribute, PowerPC
4814 Generate code that uses (does not use) the optional PowerPC
4815 architecture instructions in the Graphics group, including
4816 floating-point select.
4818 @item powerpc-gpopt
4819 @itemx no-powerpc-gpopt
4820 @cindex @code{target("powerpc-gpopt")} function attribute, PowerPC
4821 Generate code that uses (does not use) the optional PowerPC
4822 architecture instructions in the General Purpose group, including
4823 floating-point square root.
4825 @item recip-precision
4826 @itemx no-recip-precision
4827 @cindex @code{target("recip-precision")} function attribute, PowerPC
4828 Assume (do not assume) that the reciprocal estimate instructions
4829 provide higher-precision estimates than is mandated by the PowerPC
4830 ABI.
4832 @item string
4833 @itemx no-string
4834 @cindex @code{target("string")} function attribute, PowerPC
4835 Generate code that uses (does not use) the load string instructions
4836 and the store string word instructions to save multiple registers and
4837 do small block moves.
4839 @item vsx
4840 @itemx no-vsx
4841 @cindex @code{target("vsx")} function attribute, PowerPC
4842 Generate code that uses (does not use) vector/scalar (VSX)
4843 instructions, and also enable the use of built-in functions that allow
4844 more direct access to the VSX instruction set.  In 32-bit code, you
4845 cannot enable VSX or AltiVec instructions unless
4846 @option{-mabi=altivec} is used on the command line.
4848 @item friz
4849 @itemx no-friz
4850 @cindex @code{target("friz")} function attribute, PowerPC
4851 Generate (do not generate) the @code{friz} instruction when the
4852 @option{-funsafe-math-optimizations} option is used to optimize
4853 rounding a floating-point value to 64-bit integer and back to floating
4854 point.  The @code{friz} instruction does not return the same value if
4855 the floating-point number is too large to fit in an integer.
4857 @item avoid-indexed-addresses
4858 @itemx no-avoid-indexed-addresses
4859 @cindex @code{target("avoid-indexed-addresses")} function attribute, PowerPC
4860 Generate code that tries to avoid (not avoid) the use of indexed load
4861 or store instructions.
4863 @item paired
4864 @itemx no-paired
4865 @cindex @code{target("paired")} function attribute, PowerPC
4866 Generate code that uses (does not use) the generation of PAIRED simd
4867 instructions.
4869 @item longcall
4870 @itemx no-longcall
4871 @cindex @code{target("longcall")} function attribute, PowerPC
4872 Generate code that assumes (does not assume) that all calls are far
4873 away so that a longer more expensive calling sequence is required.
4875 @item cpu=@var{CPU}
4876 @cindex @code{target("cpu=@var{CPU}")} function attribute, PowerPC
4877 Specify the architecture to generate code for when compiling the
4878 function.  If you select the @code{target("cpu=power7")} attribute when
4879 generating 32-bit code, VSX and AltiVec instructions are not generated
4880 unless you use the @option{-mabi=altivec} option on the command line.
4882 @item tune=@var{TUNE}
4883 @cindex @code{target("tune=@var{TUNE}")} function attribute, PowerPC
4884 Specify the architecture to tune for when compiling the function.  If
4885 you do not specify the @code{target("tune=@var{TUNE}")} attribute and
4886 you do specify the @code{target("cpu=@var{CPU}")} attribute,
4887 compilation tunes for the @var{CPU} architecture, and not the
4888 default tuning specified on the command line.
4889 @end table
4891 On the PowerPC, the inliner does not inline a
4892 function that has different target options than the caller, unless the
4893 callee has a subset of the target options of the caller.
4894 @end table
4896 @node RL78 Function Attributes
4897 @subsection RL78 Function Attributes
4899 These function attributes are supported by the RL78 back end:
4901 @table @code
4902 @item interrupt
4903 @itemx brk_interrupt
4904 @cindex @code{interrupt} function attribute, RL78
4905 @cindex @code{brk_interrupt} function attribute, RL78
4906 These attributes indicate
4907 that the specified function is an interrupt handler.  The compiler generates
4908 function entry and exit sequences suitable for use in an interrupt handler
4909 when this attribute is present.
4911 Use @code{brk_interrupt} instead of @code{interrupt} for
4912 handlers intended to be used with the @code{BRK} opcode (i.e.@: those
4913 that must end with @code{RETB} instead of @code{RETI}).
4915 @item naked
4916 @cindex @code{naked} function attribute, RL78
4917 This attribute allows the compiler to construct the
4918 requisite function declaration, while allowing the body of the
4919 function to be assembly code. The specified function will not have
4920 prologue/epilogue sequences generated by the compiler. Only basic
4921 @code{asm} statements can safely be included in naked functions
4922 (@pxref{Basic Asm}). While using extended @code{asm} or a mixture of
4923 basic @code{asm} and C code may appear to work, they cannot be
4924 depended upon to work reliably and are not supported.
4925 @end table
4927 @node RX Function Attributes
4928 @subsection RX Function Attributes
4930 These function attributes are supported by the RX back end:
4932 @table @code
4933 @item fast_interrupt
4934 @cindex @code{fast_interrupt} function attribute, RX
4935 Use this attribute on the RX port to indicate that the specified
4936 function is a fast interrupt handler.  This is just like the
4937 @code{interrupt} attribute, except that @code{freit} is used to return
4938 instead of @code{reit}.
4940 @item interrupt
4941 @cindex @code{interrupt} function attribute, RX
4942 Use this attribute to indicate
4943 that the specified function is an interrupt handler.  The compiler generates
4944 function entry and exit sequences suitable for use in an interrupt handler
4945 when this attribute is present.
4947 On RX targets, you may specify one or more vector numbers as arguments
4948 to the attribute, as well as naming an alternate table name.
4949 Parameters are handled sequentially, so one handler can be assigned to
4950 multiple entries in multiple tables.  One may also pass the magic
4951 string @code{"$default"} which causes the function to be used for any
4952 unfilled slots in the current table.
4954 This example shows a simple assignment of a function to one vector in
4955 the default table (note that preprocessor macros may be used for
4956 chip-specific symbolic vector names):
4957 @smallexample
4958 void __attribute__ ((interrupt (5))) txd1_handler ();
4959 @end smallexample
4961 This example assigns a function to two slots in the default table
4962 (using preprocessor macros defined elsewhere) and makes it the default
4963 for the @code{dct} table:
4964 @smallexample
4965 void __attribute__ ((interrupt (RXD1_VECT,RXD2_VECT,"dct","$default")))
4966         txd1_handler ();
4967 @end smallexample
4969 @item naked
4970 @cindex @code{naked} function attribute, RX
4971 This attribute allows the compiler to construct the
4972 requisite function declaration, while allowing the body of the
4973 function to be assembly code. The specified function will not have
4974 prologue/epilogue sequences generated by the compiler. Only basic
4975 @code{asm} statements can safely be included in naked functions
4976 (@pxref{Basic Asm}). While using extended @code{asm} or a mixture of
4977 basic @code{asm} and C code may appear to work, they cannot be
4978 depended upon to work reliably and are not supported.
4980 @item vector
4981 @cindex @code{vector} function attribute, RX
4982 This RX attribute is similar to the @code{interrupt} attribute, including its
4983 parameters, but does not make the function an interrupt-handler type
4984 function (i.e. it retains the normal C function calling ABI).  See the
4985 @code{interrupt} attribute for a description of its arguments.
4986 @end table
4988 @node S/390 Function Attributes
4989 @subsection S/390 Function Attributes
4991 These function attributes are supported on the S/390:
4993 @table @code
4994 @item hotpatch (@var{halfwords-before-function-label},@var{halfwords-after-function-label})
4995 @cindex @code{hotpatch} function attribute, S/390
4997 On S/390 System z targets, you can use this function attribute to
4998 make GCC generate a ``hot-patching'' function prologue.  If the
4999 @option{-mhotpatch=} command-line option is used at the same time,
5000 the @code{hotpatch} attribute takes precedence.  The first of the
5001 two arguments specifies the number of halfwords to be added before
5002 the function label.  A second argument can be used to specify the
5003 number of halfwords to be added after the function label.  For
5004 both arguments the maximum allowed value is 1000000.
5006 If both arguments are zero, hotpatching is disabled.
5008 @item target (@var{options})
5009 @cindex @code{target} function attribute
5010 As discussed in @ref{Common Function Attributes}, this attribute
5011 allows specification of target-specific compilation options.
5013 On S/390, the following options are supported:
5015 @table @samp
5016 @item arch=
5017 @item tune=
5018 @item stack-guard=
5019 @item stack-size=
5020 @item branch-cost=
5021 @item warn-framesize=
5022 @item backchain
5023 @itemx no-backchain
5024 @item hard-dfp
5025 @itemx no-hard-dfp
5026 @item hard-float
5027 @itemx soft-float
5028 @item htm
5029 @itemx no-htm
5030 @item vx
5031 @itemx no-vx
5032 @item packed-stack
5033 @itemx no-packed-stack
5034 @item small-exec
5035 @itemx no-small-exec
5036 @item mvcle
5037 @itemx no-mvcle
5038 @item warn-dynamicstack
5039 @itemx no-warn-dynamicstack
5040 @end table
5042 The options work exactly like the S/390 specific command line
5043 options (without the prefix @option{-m}) except that they do not
5044 change any feature macros.  For example,
5046 @smallexample
5047 @code{target("no-vx")}
5048 @end smallexample
5050 does not undefine the @code{__VEC__} macro.
5051 @end table
5053 @node SH Function Attributes
5054 @subsection SH Function Attributes
5056 These function attributes are supported on the SH family of processors:
5058 @table @code
5059 @item function_vector
5060 @cindex @code{function_vector} function attribute, SH
5061 @cindex calling functions through the function vector on SH2A
5062 On SH2A targets, this attribute declares a function to be called using the
5063 TBR relative addressing mode.  The argument to this attribute is the entry
5064 number of the same function in a vector table containing all the TBR
5065 relative addressable functions.  For correct operation the TBR must be setup
5066 accordingly to point to the start of the vector table before any functions with
5067 this attribute are invoked.  Usually a good place to do the initialization is
5068 the startup routine.  The TBR relative vector table can have at max 256 function
5069 entries.  The jumps to these functions are generated using a SH2A specific,
5070 non delayed branch instruction JSR/N @@(disp8,TBR).  You must use GAS and GLD
5071 from GNU binutils version 2.7 or later for this attribute to work correctly.
5073 In an application, for a function being called once, this attribute
5074 saves at least 8 bytes of code; and if other successive calls are being
5075 made to the same function, it saves 2 bytes of code per each of these
5076 calls.
5078 @item interrupt_handler
5079 @cindex @code{interrupt_handler} function attribute, SH
5080 Use this attribute to
5081 indicate that the specified function is an interrupt handler.  The compiler
5082 generates function entry and exit sequences suitable for use in an
5083 interrupt handler when this attribute is present.
5085 @item nosave_low_regs
5086 @cindex @code{nosave_low_regs} function attribute, SH
5087 Use this attribute on SH targets to indicate that an @code{interrupt_handler}
5088 function should not save and restore registers R0..R7.  This can be used on SH3*
5089 and SH4* targets that have a second R0..R7 register bank for non-reentrant
5090 interrupt handlers.
5092 @item renesas
5093 @cindex @code{renesas} function attribute, SH
5094 On SH targets this attribute specifies that the function or struct follows the
5095 Renesas ABI.
5097 @item resbank
5098 @cindex @code{resbank} function attribute, SH
5099 On the SH2A target, this attribute enables the high-speed register
5100 saving and restoration using a register bank for @code{interrupt_handler}
5101 routines.  Saving to the bank is performed automatically after the CPU
5102 accepts an interrupt that uses a register bank.
5104 The nineteen 32-bit registers comprising general register R0 to R14,
5105 control register GBR, and system registers MACH, MACL, and PR and the
5106 vector table address offset are saved into a register bank.  Register
5107 banks are stacked in first-in last-out (FILO) sequence.  Restoration
5108 from the bank is executed by issuing a RESBANK instruction.
5110 @item sp_switch
5111 @cindex @code{sp_switch} function attribute, SH
5112 Use this attribute on the SH to indicate an @code{interrupt_handler}
5113 function should switch to an alternate stack.  It expects a string
5114 argument that names a global variable holding the address of the
5115 alternate stack.
5117 @smallexample
5118 void *alt_stack;
5119 void f () __attribute__ ((interrupt_handler,
5120                           sp_switch ("alt_stack")));
5121 @end smallexample
5123 @item trap_exit
5124 @cindex @code{trap_exit} function attribute, SH
5125 Use this attribute on the SH for an @code{interrupt_handler} to return using
5126 @code{trapa} instead of @code{rte}.  This attribute expects an integer
5127 argument specifying the trap number to be used.
5129 @item trapa_handler
5130 @cindex @code{trapa_handler} function attribute, SH
5131 On SH targets this function attribute is similar to @code{interrupt_handler}
5132 but it does not save and restore all registers.
5133 @end table
5135 @node SPU Function Attributes
5136 @subsection SPU Function Attributes
5138 These function attributes are supported by the SPU back end:
5140 @table @code
5141 @item naked
5142 @cindex @code{naked} function attribute, SPU
5143 This attribute allows the compiler to construct the
5144 requisite function declaration, while allowing the body of the
5145 function to be assembly code. The specified function will not have
5146 prologue/epilogue sequences generated by the compiler. Only basic
5147 @code{asm} statements can safely be included in naked functions
5148 (@pxref{Basic Asm}). While using extended @code{asm} or a mixture of
5149 basic @code{asm} and C code may appear to work, they cannot be
5150 depended upon to work reliably and are not supported.
5151 @end table
5153 @node Symbian OS Function Attributes
5154 @subsection Symbian OS Function Attributes
5156 @xref{Microsoft Windows Function Attributes}, for discussion of the
5157 @code{dllexport} and @code{dllimport} attributes.
5159 @node V850 Function Attributes
5160 @subsection V850 Function Attributes
5162 The V850 back end supports these function attributes:
5164 @table @code
5165 @item interrupt
5166 @itemx interrupt_handler
5167 @cindex @code{interrupt} function attribute, V850
5168 @cindex @code{interrupt_handler} function attribute, V850
5169 Use these attributes to indicate
5170 that the specified function is an interrupt handler.  The compiler generates
5171 function entry and exit sequences suitable for use in an interrupt handler
5172 when either attribute is present.
5173 @end table
5175 @node Visium Function Attributes
5176 @subsection Visium Function Attributes
5178 These function attributes are supported by the Visium back end:
5180 @table @code
5181 @item interrupt
5182 @cindex @code{interrupt} function attribute, Visium
5183 Use this attribute to indicate
5184 that the specified function is an interrupt handler.  The compiler generates
5185 function entry and exit sequences suitable for use in an interrupt handler
5186 when this attribute is present.
5187 @end table
5189 @node x86 Function Attributes
5190 @subsection x86 Function Attributes
5192 These function attributes are supported by the x86 back end:
5194 @table @code
5195 @item cdecl
5196 @cindex @code{cdecl} function attribute, x86-32
5197 @cindex functions that pop the argument stack on x86-32
5198 @opindex mrtd
5199 On the x86-32 targets, the @code{cdecl} attribute causes the compiler to
5200 assume that the calling function pops off the stack space used to
5201 pass arguments.  This is
5202 useful to override the effects of the @option{-mrtd} switch.
5204 @item fastcall
5205 @cindex @code{fastcall} function attribute, x86-32
5206 @cindex functions that pop the argument stack on x86-32
5207 On x86-32 targets, the @code{fastcall} attribute causes the compiler to
5208 pass the first argument (if of integral type) in the register ECX and
5209 the second argument (if of integral type) in the register EDX@.  Subsequent
5210 and other typed arguments are passed on the stack.  The called function
5211 pops the arguments off the stack.  If the number of arguments is variable all
5212 arguments are pushed on the stack.
5214 @item thiscall
5215 @cindex @code{thiscall} function attribute, x86-32
5216 @cindex functions that pop the argument stack on x86-32
5217 On x86-32 targets, the @code{thiscall} attribute causes the compiler to
5218 pass the first argument (if of integral type) in the register ECX.
5219 Subsequent and other typed arguments are passed on the stack. The called
5220 function pops the arguments off the stack.
5221 If the number of arguments is variable all arguments are pushed on the
5222 stack.
5223 The @code{thiscall} attribute is intended for C++ non-static member functions.
5224 As a GCC extension, this calling convention can be used for C functions
5225 and for static member methods.
5227 @item ms_abi
5228 @itemx sysv_abi
5229 @cindex @code{ms_abi} function attribute, x86
5230 @cindex @code{sysv_abi} function attribute, x86
5232 On 32-bit and 64-bit x86 targets, you can use an ABI attribute
5233 to indicate which calling convention should be used for a function.  The
5234 @code{ms_abi} attribute tells the compiler to use the Microsoft ABI,
5235 while the @code{sysv_abi} attribute tells the compiler to use the ABI
5236 used on GNU/Linux and other systems.  The default is to use the Microsoft ABI
5237 when targeting Windows.  On all other systems, the default is the x86/AMD ABI.
5239 Note, the @code{ms_abi} attribute for Microsoft Windows 64-bit targets currently
5240 requires the @option{-maccumulate-outgoing-args} option.
5242 @item callee_pop_aggregate_return (@var{number})
5243 @cindex @code{callee_pop_aggregate_return} function attribute, x86
5245 On x86-32 targets, you can use this attribute to control how
5246 aggregates are returned in memory.  If the caller is responsible for
5247 popping the hidden pointer together with the rest of the arguments, specify
5248 @var{number} equal to zero.  If callee is responsible for popping the
5249 hidden pointer, specify @var{number} equal to one.  
5251 The default x86-32 ABI assumes that the callee pops the
5252 stack for hidden pointer.  However, on x86-32 Microsoft Windows targets,
5253 the compiler assumes that the
5254 caller pops the stack for hidden pointer.
5256 @item ms_hook_prologue
5257 @cindex @code{ms_hook_prologue} function attribute, x86
5259 On 32-bit and 64-bit x86 targets, you can use
5260 this function attribute to make GCC generate the ``hot-patching'' function
5261 prologue used in Win32 API functions in Microsoft Windows XP Service Pack 2
5262 and newer.
5264 @item regparm (@var{number})
5265 @cindex @code{regparm} function attribute, x86
5266 @cindex functions that are passed arguments in registers on x86-32
5267 On x86-32 targets, the @code{regparm} attribute causes the compiler to
5268 pass arguments number one to @var{number} if they are of integral type
5269 in registers EAX, EDX, and ECX instead of on the stack.  Functions that
5270 take a variable number of arguments continue to be passed all of their
5271 arguments on the stack.
5273 Beware that on some ELF systems this attribute is unsuitable for
5274 global functions in shared libraries with lazy binding (which is the
5275 default).  Lazy binding sends the first call via resolving code in
5276 the loader, which might assume EAX, EDX and ECX can be clobbered, as
5277 per the standard calling conventions.  Solaris 8 is affected by this.
5278 Systems with the GNU C Library version 2.1 or higher
5279 and FreeBSD are believed to be
5280 safe since the loaders there save EAX, EDX and ECX.  (Lazy binding can be
5281 disabled with the linker or the loader if desired, to avoid the
5282 problem.)
5284 @item sseregparm
5285 @cindex @code{sseregparm} function attribute, x86
5286 On x86-32 targets with SSE support, the @code{sseregparm} attribute
5287 causes the compiler to pass up to 3 floating-point arguments in
5288 SSE registers instead of on the stack.  Functions that take a
5289 variable number of arguments continue to pass all of their
5290 floating-point arguments on the stack.
5292 @item force_align_arg_pointer
5293 @cindex @code{force_align_arg_pointer} function attribute, x86
5294 On x86 targets, the @code{force_align_arg_pointer} attribute may be
5295 applied to individual function definitions, generating an alternate
5296 prologue and epilogue that realigns the run-time stack if necessary.
5297 This supports mixing legacy codes that run with a 4-byte aligned stack
5298 with modern codes that keep a 16-byte stack for SSE compatibility.
5300 @item stdcall
5301 @cindex @code{stdcall} function attribute, x86-32
5302 @cindex functions that pop the argument stack on x86-32
5303 On x86-32 targets, the @code{stdcall} attribute causes the compiler to
5304 assume that the called function pops off the stack space used to
5305 pass arguments, unless it takes a variable number of arguments.
5307 @item no_caller_saved_registers
5308 @cindex @code{no_caller_saved_registers} function attribute, x86
5309 Use this attribute to indicate that the specified function has no
5310 caller-saved registers. That is, all registers are callee-saved. For
5311 example, this attribute can be used for a function called from an
5312 interrupt handler. The compiler generates proper function entry and
5313 exit sequences to save and restore any modified registers, except for
5314 the EFLAGS register.  Since GCC doesn't preserve MPX, SSE, MMX nor x87
5315 states, the GCC option @option{-mgeneral-regs-only} should be used to
5316 compile functions with @code{no_caller_saved_registers} attribute.
5318 @item interrupt
5319 @cindex @code{interrupt} function attribute, x86
5320 Use this attribute to indicate that the specified function is an
5321 interrupt handler or an exception handler (depending on parameters passed
5322 to the function, explained further).  The compiler generates function
5323 entry and exit sequences suitable for use in an interrupt handler when
5324 this attribute is present.  The @code{IRET} instruction, instead of the
5325 @code{RET} instruction, is used to return from interrupt handlers.  All
5326 registers, except for the EFLAGS register which is restored by the
5327 @code{IRET} instruction, are preserved by the compiler.  Since GCC
5328 doesn't preserve MPX, SSE, MMX nor x87 states, the GCC option
5329 @option{-mgeneral-regs-only} should be used to compile interrupt and
5330 exception handlers.
5332 Any interruptible-without-stack-switch code must be compiled with
5333 @option{-mno-red-zone} since interrupt handlers can and will, because
5334 of the hardware design, touch the red zone.
5336 An interrupt handler must be declared with a mandatory pointer
5337 argument:
5339 @smallexample
5340 struct interrupt_frame;
5342 __attribute__ ((interrupt))
5343 void
5344 f (struct interrupt_frame *frame)
5347 @end smallexample
5349 @noindent
5350 and you must define @code{struct interrupt_frame} as described in the
5351 processor's manual.
5353 Exception handlers differ from interrupt handlers because the system
5354 pushes an error code on the stack.  An exception handler declaration is
5355 similar to that for an interrupt handler, but with a different mandatory
5356 function signature.  The compiler arranges to pop the error code off the
5357 stack before the @code{IRET} instruction.
5359 @smallexample
5360 #ifdef __x86_64__
5361 typedef unsigned long long int uword_t;
5362 #else
5363 typedef unsigned int uword_t;
5364 #endif
5366 struct interrupt_frame;
5368 __attribute__ ((interrupt))
5369 void
5370 f (struct interrupt_frame *frame, uword_t error_code)
5372   ...
5374 @end smallexample
5376 Exception handlers should only be used for exceptions that push an error
5377 code; you should use an interrupt handler in other cases.  The system
5378 will crash if the wrong kind of handler is used.
5380 @item target (@var{options})
5381 @cindex @code{target} function attribute
5382 As discussed in @ref{Common Function Attributes}, this attribute 
5383 allows specification of target-specific compilation options.
5385 On the x86, the following options are allowed:
5386 @table @samp
5387 @item abm
5388 @itemx no-abm
5389 @cindex @code{target("abm")} function attribute, x86
5390 Enable/disable the generation of the advanced bit instructions.
5392 @item aes
5393 @itemx no-aes
5394 @cindex @code{target("aes")} function attribute, x86
5395 Enable/disable the generation of the AES instructions.
5397 @item default
5398 @cindex @code{target("default")} function attribute, x86
5399 @xref{Function Multiversioning}, where it is used to specify the
5400 default function version.
5402 @item mmx
5403 @itemx no-mmx
5404 @cindex @code{target("mmx")} function attribute, x86
5405 Enable/disable the generation of the MMX instructions.
5407 @item pclmul
5408 @itemx no-pclmul
5409 @cindex @code{target("pclmul")} function attribute, x86
5410 Enable/disable the generation of the PCLMUL instructions.
5412 @item popcnt
5413 @itemx no-popcnt
5414 @cindex @code{target("popcnt")} function attribute, x86
5415 Enable/disable the generation of the POPCNT instruction.
5417 @item sse
5418 @itemx no-sse
5419 @cindex @code{target("sse")} function attribute, x86
5420 Enable/disable the generation of the SSE instructions.
5422 @item sse2
5423 @itemx no-sse2
5424 @cindex @code{target("sse2")} function attribute, x86
5425 Enable/disable the generation of the SSE2 instructions.
5427 @item sse3
5428 @itemx no-sse3
5429 @cindex @code{target("sse3")} function attribute, x86
5430 Enable/disable the generation of the SSE3 instructions.
5432 @item sse4
5433 @itemx no-sse4
5434 @cindex @code{target("sse4")} function attribute, x86
5435 Enable/disable the generation of the SSE4 instructions (both SSE4.1
5436 and SSE4.2).
5438 @item sse4.1
5439 @itemx no-sse4.1
5440 @cindex @code{target("sse4.1")} function attribute, x86
5441 Enable/disable the generation of the sse4.1 instructions.
5443 @item sse4.2
5444 @itemx no-sse4.2
5445 @cindex @code{target("sse4.2")} function attribute, x86
5446 Enable/disable the generation of the sse4.2 instructions.
5448 @item sse4a
5449 @itemx no-sse4a
5450 @cindex @code{target("sse4a")} function attribute, x86
5451 Enable/disable the generation of the SSE4A instructions.
5453 @item fma4
5454 @itemx no-fma4
5455 @cindex @code{target("fma4")} function attribute, x86
5456 Enable/disable the generation of the FMA4 instructions.
5458 @item xop
5459 @itemx no-xop
5460 @cindex @code{target("xop")} function attribute, x86
5461 Enable/disable the generation of the XOP instructions.
5463 @item lwp
5464 @itemx no-lwp
5465 @cindex @code{target("lwp")} function attribute, x86
5466 Enable/disable the generation of the LWP instructions.
5468 @item ssse3
5469 @itemx no-ssse3
5470 @cindex @code{target("ssse3")} function attribute, x86
5471 Enable/disable the generation of the SSSE3 instructions.
5473 @item cld
5474 @itemx no-cld
5475 @cindex @code{target("cld")} function attribute, x86
5476 Enable/disable the generation of the CLD before string moves.
5478 @item fancy-math-387
5479 @itemx no-fancy-math-387
5480 @cindex @code{target("fancy-math-387")} function attribute, x86
5481 Enable/disable the generation of the @code{sin}, @code{cos}, and
5482 @code{sqrt} instructions on the 387 floating-point unit.
5484 @item ieee-fp
5485 @itemx no-ieee-fp
5486 @cindex @code{target("ieee-fp")} function attribute, x86
5487 Enable/disable the generation of floating point that depends on IEEE arithmetic.
5489 @item inline-all-stringops
5490 @itemx no-inline-all-stringops
5491 @cindex @code{target("inline-all-stringops")} function attribute, x86
5492 Enable/disable inlining of string operations.
5494 @item inline-stringops-dynamically
5495 @itemx no-inline-stringops-dynamically
5496 @cindex @code{target("inline-stringops-dynamically")} function attribute, x86
5497 Enable/disable the generation of the inline code to do small string
5498 operations and calling the library routines for large operations.
5500 @item align-stringops
5501 @itemx no-align-stringops
5502 @cindex @code{target("align-stringops")} function attribute, x86
5503 Do/do not align destination of inlined string operations.
5505 @item recip
5506 @itemx no-recip
5507 @cindex @code{target("recip")} function attribute, x86
5508 Enable/disable the generation of RCPSS, RCPPS, RSQRTSS and RSQRTPS
5509 instructions followed an additional Newton-Raphson step instead of
5510 doing a floating-point division.
5512 @item arch=@var{ARCH}
5513 @cindex @code{target("arch=@var{ARCH}")} function attribute, x86
5514 Specify the architecture to generate code for in compiling the function.
5516 @item tune=@var{TUNE}
5517 @cindex @code{target("tune=@var{TUNE}")} function attribute, x86
5518 Specify the architecture to tune for in compiling the function.
5520 @item fpmath=@var{FPMATH}
5521 @cindex @code{target("fpmath=@var{FPMATH}")} function attribute, x86
5522 Specify which floating-point unit to use.  You must specify the
5523 @code{target("fpmath=sse,387")} option as
5524 @code{target("fpmath=sse+387")} because the comma would separate
5525 different options.
5526 @end table
5528 On the x86, the inliner does not inline a
5529 function that has different target options than the caller, unless the
5530 callee has a subset of the target options of the caller.  For example
5531 a function declared with @code{target("sse3")} can inline a function
5532 with @code{target("sse2")}, since @code{-msse3} implies @code{-msse2}.
5533 @end table
5535 @node Xstormy16 Function Attributes
5536 @subsection Xstormy16 Function Attributes
5538 These function attributes are supported by the Xstormy16 back end:
5540 @table @code
5541 @item interrupt
5542 @cindex @code{interrupt} function attribute, Xstormy16
5543 Use this attribute to indicate
5544 that the specified function is an interrupt handler.  The compiler generates
5545 function entry and exit sequences suitable for use in an interrupt handler
5546 when this attribute is present.
5547 @end table
5549 @node Variable Attributes
5550 @section Specifying Attributes of Variables
5551 @cindex attribute of variables
5552 @cindex variable attributes
5554 The keyword @code{__attribute__} allows you to specify special
5555 attributes of variables or structure fields.  This keyword is followed
5556 by an attribute specification inside double parentheses.  Some
5557 attributes are currently defined generically for variables.
5558 Other attributes are defined for variables on particular target
5559 systems.  Other attributes are available for functions
5560 (@pxref{Function Attributes}), labels (@pxref{Label Attributes}),
5561 enumerators (@pxref{Enumerator Attributes}), and for types
5562 (@pxref{Type Attributes}).
5563 Other front ends might define more attributes
5564 (@pxref{C++ Extensions,,Extensions to the C++ Language}).
5566 @xref{Attribute Syntax}, for details of the exact syntax for using
5567 attributes.
5569 @menu
5570 * Common Variable Attributes::
5571 * AVR Variable Attributes::
5572 * Blackfin Variable Attributes::
5573 * H8/300 Variable Attributes::
5574 * IA-64 Variable Attributes::
5575 * M32R/D Variable Attributes::
5576 * MeP Variable Attributes::
5577 * Microsoft Windows Variable Attributes::
5578 * MSP430 Variable Attributes::
5579 * PowerPC Variable Attributes::
5580 * RL78 Variable Attributes::
5581 * SPU Variable Attributes::
5582 * V850 Variable Attributes::
5583 * x86 Variable Attributes::
5584 * Xstormy16 Variable Attributes::
5585 @end menu
5587 @node Common Variable Attributes
5588 @subsection Common Variable Attributes
5590 The following attributes are supported on most targets.
5592 @table @code
5593 @cindex @code{aligned} variable attribute
5594 @item aligned (@var{alignment})
5595 This attribute specifies a minimum alignment for the variable or
5596 structure field, measured in bytes.  For example, the declaration:
5598 @smallexample
5599 int x __attribute__ ((aligned (16))) = 0;
5600 @end smallexample
5602 @noindent
5603 causes the compiler to allocate the global variable @code{x} on a
5604 16-byte boundary.  On a 68040, this could be used in conjunction with
5605 an @code{asm} expression to access the @code{move16} instruction which
5606 requires 16-byte aligned operands.
5608 You can also specify the alignment of structure fields.  For example, to
5609 create a double-word aligned @code{int} pair, you could write:
5611 @smallexample
5612 struct foo @{ int x[2] __attribute__ ((aligned (8))); @};
5613 @end smallexample
5615 @noindent
5616 This is an alternative to creating a union with a @code{double} member,
5617 which forces the union to be double-word aligned.
5619 As in the preceding examples, you can explicitly specify the alignment
5620 (in bytes) that you wish the compiler to use for a given variable or
5621 structure field.  Alternatively, you can leave out the alignment factor
5622 and just ask the compiler to align a variable or field to the
5623 default alignment for the target architecture you are compiling for.
5624 The default alignment is sufficient for all scalar types, but may not be
5625 enough for all vector types on a target that supports vector operations.
5626 The default alignment is fixed for a particular target ABI.
5628 GCC also provides a target specific macro @code{__BIGGEST_ALIGNMENT__},
5629 which is the largest alignment ever used for any data type on the
5630 target machine you are compiling for.  For example, you could write:
5632 @smallexample
5633 short array[3] __attribute__ ((aligned (__BIGGEST_ALIGNMENT__)));
5634 @end smallexample
5636 The compiler automatically sets the alignment for the declared
5637 variable or field to @code{__BIGGEST_ALIGNMENT__}.  Doing this can
5638 often make copy operations more efficient, because the compiler can
5639 use whatever instructions copy the biggest chunks of memory when
5640 performing copies to or from the variables or fields that you have
5641 aligned this way.  Note that the value of @code{__BIGGEST_ALIGNMENT__}
5642 may change depending on command-line options.
5644 When used on a struct, or struct member, the @code{aligned} attribute can
5645 only increase the alignment; in order to decrease it, the @code{packed}
5646 attribute must be specified as well.  When used as part of a typedef, the
5647 @code{aligned} attribute can both increase and decrease alignment, and
5648 specifying the @code{packed} attribute generates a warning.
5650 Note that the effectiveness of @code{aligned} attributes may be limited
5651 by inherent limitations in your linker.  On many systems, the linker is
5652 only able to arrange for variables to be aligned up to a certain maximum
5653 alignment.  (For some linkers, the maximum supported alignment may
5654 be very very small.)  If your linker is only able to align variables
5655 up to a maximum of 8-byte alignment, then specifying @code{aligned(16)}
5656 in an @code{__attribute__} still only provides you with 8-byte
5657 alignment.  See your linker documentation for further information.
5659 The @code{aligned} attribute can also be used for functions
5660 (@pxref{Common Function Attributes}.)
5662 @item cleanup (@var{cleanup_function})
5663 @cindex @code{cleanup} variable attribute
5664 The @code{cleanup} attribute runs a function when the variable goes
5665 out of scope.  This attribute can only be applied to auto function
5666 scope variables; it may not be applied to parameters or variables
5667 with static storage duration.  The function must take one parameter,
5668 a pointer to a type compatible with the variable.  The return value
5669 of the function (if any) is ignored.
5671 If @option{-fexceptions} is enabled, then @var{cleanup_function}
5672 is run during the stack unwinding that happens during the
5673 processing of the exception.  Note that the @code{cleanup} attribute
5674 does not allow the exception to be caught, only to perform an action.
5675 It is undefined what happens if @var{cleanup_function} does not
5676 return normally.
5678 @item common
5679 @itemx nocommon
5680 @cindex @code{common} variable attribute
5681 @cindex @code{nocommon} variable attribute
5682 @opindex fcommon
5683 @opindex fno-common
5684 The @code{common} attribute requests GCC to place a variable in
5685 ``common'' storage.  The @code{nocommon} attribute requests the
5686 opposite---to allocate space for it directly.
5688 These attributes override the default chosen by the
5689 @option{-fno-common} and @option{-fcommon} flags respectively.
5691 @item deprecated
5692 @itemx deprecated (@var{msg})
5693 @cindex @code{deprecated} variable attribute
5694 The @code{deprecated} attribute results in a warning if the variable
5695 is used anywhere in the source file.  This is useful when identifying
5696 variables that are expected to be removed in a future version of a
5697 program.  The warning also includes the location of the declaration
5698 of the deprecated variable, to enable users to easily find further
5699 information about why the variable is deprecated, or what they should
5700 do instead.  Note that the warning only occurs for uses:
5702 @smallexample
5703 extern int old_var __attribute__ ((deprecated));
5704 extern int old_var;
5705 int new_fn () @{ return old_var; @}
5706 @end smallexample
5708 @noindent
5709 results in a warning on line 3 but not line 2.  The optional @var{msg}
5710 argument, which must be a string, is printed in the warning if
5711 present.
5713 The @code{deprecated} attribute can also be used for functions and
5714 types (@pxref{Common Function Attributes},
5715 @pxref{Common Type Attributes}).
5717 @item mode (@var{mode})
5718 @cindex @code{mode} variable attribute
5719 This attribute specifies the data type for the declaration---whichever
5720 type corresponds to the mode @var{mode}.  This in effect lets you
5721 request an integer or floating-point type according to its width.
5723 You may also specify a mode of @code{byte} or @code{__byte__} to
5724 indicate the mode corresponding to a one-byte integer, @code{word} or
5725 @code{__word__} for the mode of a one-word integer, and @code{pointer}
5726 or @code{__pointer__} for the mode used to represent pointers.
5728 @item packed
5729 @cindex @code{packed} variable attribute
5730 The @code{packed} attribute specifies that a variable or structure field
5731 should have the smallest possible alignment---one byte for a variable,
5732 and one bit for a field, unless you specify a larger value with the
5733 @code{aligned} attribute.
5735 Here is a structure in which the field @code{x} is packed, so that it
5736 immediately follows @code{a}:
5738 @smallexample
5739 struct foo
5741   char a;
5742   int x[2] __attribute__ ((packed));
5744 @end smallexample
5746 @emph{Note:} The 4.1, 4.2 and 4.3 series of GCC ignore the
5747 @code{packed} attribute on bit-fields of type @code{char}.  This has
5748 been fixed in GCC 4.4 but the change can lead to differences in the
5749 structure layout.  See the documentation of
5750 @option{-Wpacked-bitfield-compat} for more information.
5752 @item section ("@var{section-name}")
5753 @cindex @code{section} variable attribute
5754 Normally, the compiler places the objects it generates in sections like
5755 @code{data} and @code{bss}.  Sometimes, however, you need additional sections,
5756 or you need certain particular variables to appear in special sections,
5757 for example to map to special hardware.  The @code{section}
5758 attribute specifies that a variable (or function) lives in a particular
5759 section.  For example, this small program uses several specific section names:
5761 @smallexample
5762 struct duart a __attribute__ ((section ("DUART_A"))) = @{ 0 @};
5763 struct duart b __attribute__ ((section ("DUART_B"))) = @{ 0 @};
5764 char stack[10000] __attribute__ ((section ("STACK"))) = @{ 0 @};
5765 int init_data __attribute__ ((section ("INITDATA")));
5767 main()
5769   /* @r{Initialize stack pointer} */
5770   init_sp (stack + sizeof (stack));
5772   /* @r{Initialize initialized data} */
5773   memcpy (&init_data, &data, &edata - &data);
5775   /* @r{Turn on the serial ports} */
5776   init_duart (&a);
5777   init_duart (&b);
5779 @end smallexample
5781 @noindent
5782 Use the @code{section} attribute with
5783 @emph{global} variables and not @emph{local} variables,
5784 as shown in the example.
5786 You may use the @code{section} attribute with initialized or
5787 uninitialized global variables but the linker requires
5788 each object be defined once, with the exception that uninitialized
5789 variables tentatively go in the @code{common} (or @code{bss}) section
5790 and can be multiply ``defined''.  Using the @code{section} attribute
5791 changes what section the variable goes into and may cause the
5792 linker to issue an error if an uninitialized variable has multiple
5793 definitions.  You can force a variable to be initialized with the
5794 @option{-fno-common} flag or the @code{nocommon} attribute.
5796 Some file formats do not support arbitrary sections so the @code{section}
5797 attribute is not available on all platforms.
5798 If you need to map the entire contents of a module to a particular
5799 section, consider using the facilities of the linker instead.
5801 @item tls_model ("@var{tls_model}")
5802 @cindex @code{tls_model} variable attribute
5803 The @code{tls_model} attribute sets thread-local storage model
5804 (@pxref{Thread-Local}) of a particular @code{__thread} variable,
5805 overriding @option{-ftls-model=} command-line switch on a per-variable
5806 basis.
5807 The @var{tls_model} argument should be one of @code{global-dynamic},
5808 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
5810 Not all targets support this attribute.
5812 @item unused
5813 @cindex @code{unused} variable attribute
5814 This attribute, attached to a variable, means that the variable is meant
5815 to be possibly unused.  GCC does not produce a warning for this
5816 variable.
5818 @item used
5819 @cindex @code{used} variable attribute
5820 This attribute, attached to a variable with static storage, means that
5821 the variable must be emitted even if it appears that the variable is not
5822 referenced.
5824 When applied to a static data member of a C++ class template, the
5825 attribute also means that the member is instantiated if the
5826 class itself is instantiated.
5828 @item vector_size (@var{bytes})
5829 @cindex @code{vector_size} variable attribute
5830 This attribute specifies the vector size for the variable, measured in
5831 bytes.  For example, the declaration:
5833 @smallexample
5834 int foo __attribute__ ((vector_size (16)));
5835 @end smallexample
5837 @noindent
5838 causes the compiler to set the mode for @code{foo}, to be 16 bytes,
5839 divided into @code{int} sized units.  Assuming a 32-bit int (a vector of
5840 4 units of 4 bytes), the corresponding mode of @code{foo} is V4SI@.
5842 This attribute is only applicable to integral and float scalars,
5843 although arrays, pointers, and function return values are allowed in
5844 conjunction with this construct.
5846 Aggregates with this attribute are invalid, even if they are of the same
5847 size as a corresponding scalar.  For example, the declaration:
5849 @smallexample
5850 struct S @{ int a; @};
5851 struct S  __attribute__ ((vector_size (16))) foo;
5852 @end smallexample
5854 @noindent
5855 is invalid even if the size of the structure is the same as the size of
5856 the @code{int}.
5858 @item visibility ("@var{visibility_type}")
5859 @cindex @code{visibility} variable attribute
5860 This attribute affects the linkage of the declaration to which it is attached.
5861 The @code{visibility} attribute is described in
5862 @ref{Common Function Attributes}.
5864 @item weak
5865 @cindex @code{weak} variable attribute
5866 The @code{weak} attribute is described in
5867 @ref{Common Function Attributes}.
5869 @end table
5871 @node AVR Variable Attributes
5872 @subsection AVR Variable Attributes
5874 @table @code
5875 @item progmem
5876 @cindex @code{progmem} variable attribute, AVR
5877 The @code{progmem} attribute is used on the AVR to place read-only
5878 data in the non-volatile program memory (flash). The @code{progmem}
5879 attribute accomplishes this by putting respective variables into a
5880 section whose name starts with @code{.progmem}.
5882 This attribute works similar to the @code{section} attribute
5883 but adds additional checking.
5885 @table @asis
5886 @item @bullet{}@tie{} Ordinary AVR cores with 32 general purpose registers:
5887 @code{progmem} affects the location
5888 of the data but not how this data is accessed.
5889 In order to read data located with the @code{progmem} attribute
5890 (inline) assembler must be used.
5891 @smallexample
5892 /* Use custom macros from @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC}} */
5893 #include <avr/pgmspace.h> 
5895 /* Locate var in flash memory */
5896 const int var[2] PROGMEM = @{ 1, 2 @};
5898 int read_var (int i)
5900     /* Access var[] by accessor macro from avr/pgmspace.h */
5901     return (int) pgm_read_word (& var[i]);
5903 @end smallexample
5905 AVR is a Harvard architecture processor and data and read-only data
5906 normally resides in the data memory (RAM).
5908 See also the @ref{AVR Named Address Spaces} section for
5909 an alternate way to locate and access data in flash memory.
5911 @item @bullet{}@tie{}Reduced AVR Tiny cores like ATtiny40:
5912 The compiler adds @code{0x4000}
5913 to the addresses of objects and declarations in @code{progmem} and locates
5914 the objects in flash memory, namely in section @code{.progmem.data}.
5915 The offset is needed because the flash memory is visible in the RAM
5916 address space starting at address @code{0x4000}.
5918 Data in @code{progmem} can be accessed by means of ordinary C@tie{}code,
5919 no special functions or macros are needed.
5921 @smallexample
5922 /* var is located in flash memory */
5923 extern const int var[2] __attribute__((progmem));
5925 int read_var (int i)
5927     return var[i];
5929 @end smallexample
5931 @end table
5933 @item io
5934 @itemx io (@var{addr})
5935 @cindex @code{io} variable attribute, AVR
5936 Variables with the @code{io} attribute are used to address
5937 memory-mapped peripherals in the io address range.
5938 If an address is specified, the variable
5939 is assigned that address, and the value is interpreted as an
5940 address in the data address space.
5941 Example:
5943 @smallexample
5944 volatile int porta __attribute__((io (0x22)));
5945 @end smallexample
5947 The address specified in the address in the data address range.
5949 Otherwise, the variable it is not assigned an address, but the
5950 compiler will still use in/out instructions where applicable,
5951 assuming some other module assigns an address in the io address range.
5952 Example:
5954 @smallexample
5955 extern volatile int porta __attribute__((io));
5956 @end smallexample
5958 @item io_low
5959 @itemx io_low (@var{addr})
5960 @cindex @code{io_low} variable attribute, AVR
5961 This is like the @code{io} attribute, but additionally it informs the
5962 compiler that the object lies in the lower half of the I/O area,
5963 allowing the use of @code{cbi}, @code{sbi}, @code{sbic} and @code{sbis}
5964 instructions.
5966 @item address
5967 @itemx address (@var{addr})
5968 @cindex @code{address} variable attribute, AVR
5969 Variables with the @code{address} attribute are used to address
5970 memory-mapped peripherals that may lie outside the io address range.
5972 @smallexample
5973 volatile int porta __attribute__((address (0x600)));
5974 @end smallexample
5976 @end table
5978 @node Blackfin Variable Attributes
5979 @subsection Blackfin Variable Attributes
5981 Three attributes are currently defined for the Blackfin.
5983 @table @code
5984 @item l1_data
5985 @itemx l1_data_A
5986 @itemx l1_data_B
5987 @cindex @code{l1_data} variable attribute, Blackfin
5988 @cindex @code{l1_data_A} variable attribute, Blackfin
5989 @cindex @code{l1_data_B} variable attribute, Blackfin
5990 Use these attributes on the Blackfin to place the variable into L1 Data SRAM.
5991 Variables with @code{l1_data} attribute are put into the specific section
5992 named @code{.l1.data}. Those with @code{l1_data_A} attribute are put into
5993 the specific section named @code{.l1.data.A}. Those with @code{l1_data_B}
5994 attribute are put into the specific section named @code{.l1.data.B}.
5996 @item l2
5997 @cindex @code{l2} variable attribute, Blackfin
5998 Use this attribute on the Blackfin to place the variable into L2 SRAM.
5999 Variables with @code{l2} attribute are put into the specific section
6000 named @code{.l2.data}.
6001 @end table
6003 @node H8/300 Variable Attributes
6004 @subsection H8/300 Variable Attributes
6006 These variable attributes are available for H8/300 targets:
6008 @table @code
6009 @item eightbit_data
6010 @cindex @code{eightbit_data} variable attribute, H8/300
6011 @cindex eight-bit data on the H8/300, H8/300H, and H8S
6012 Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
6013 variable should be placed into the eight-bit data section.
6014 The compiler generates more efficient code for certain operations
6015 on data in the eight-bit data area.  Note the eight-bit data area is limited to
6016 256 bytes of data.
6018 You must use GAS and GLD from GNU binutils version 2.7 or later for
6019 this attribute to work correctly.
6021 @item tiny_data
6022 @cindex @code{tiny_data} variable attribute, H8/300
6023 @cindex tiny data section on the H8/300H and H8S
6024 Use this attribute on the H8/300H and H8S to indicate that the specified
6025 variable should be placed into the tiny data section.
6026 The compiler generates more efficient code for loads and stores
6027 on data in the tiny data section.  Note the tiny data area is limited to
6028 slightly under 32KB of data.
6030 @end table
6032 @node IA-64 Variable Attributes
6033 @subsection IA-64 Variable Attributes
6035 The IA-64 back end supports the following variable attribute:
6037 @table @code
6038 @item model (@var{model-name})
6039 @cindex @code{model} variable attribute, IA-64
6041 On IA-64, use this attribute to set the addressability of an object.
6042 At present, the only supported identifier for @var{model-name} is
6043 @code{small}, indicating addressability via ``small'' (22-bit)
6044 addresses (so that their addresses can be loaded with the @code{addl}
6045 instruction).  Caveat: such addressing is by definition not position
6046 independent and hence this attribute must not be used for objects
6047 defined by shared libraries.
6049 @end table
6051 @node M32R/D Variable Attributes
6052 @subsection M32R/D Variable Attributes
6054 One attribute is currently defined for the M32R/D@.
6056 @table @code
6057 @item model (@var{model-name})
6058 @cindex @code{model-name} variable attribute, M32R/D
6059 @cindex variable addressability on the M32R/D
6060 Use this attribute on the M32R/D to set the addressability of an object.
6061 The identifier @var{model-name} is one of @code{small}, @code{medium},
6062 or @code{large}, representing each of the code models.
6064 Small model objects live in the lower 16MB of memory (so that their
6065 addresses can be loaded with the @code{ld24} instruction).
6067 Medium and large model objects may live anywhere in the 32-bit address space
6068 (the compiler generates @code{seth/add3} instructions to load their
6069 addresses).
6070 @end table
6072 @node MeP Variable Attributes
6073 @subsection MeP Variable Attributes
6075 The MeP target has a number of addressing modes and busses.  The
6076 @code{near} space spans the standard memory space's first 16 megabytes
6077 (24 bits).  The @code{far} space spans the entire 32-bit memory space.
6078 The @code{based} space is a 128-byte region in the memory space that
6079 is addressed relative to the @code{$tp} register.  The @code{tiny}
6080 space is a 65536-byte region relative to the @code{$gp} register.  In
6081 addition to these memory regions, the MeP target has a separate 16-bit
6082 control bus which is specified with @code{cb} attributes.
6084 @table @code
6086 @item based
6087 @cindex @code{based} variable attribute, MeP
6088 Any variable with the @code{based} attribute is assigned to the
6089 @code{.based} section, and is accessed with relative to the
6090 @code{$tp} register.
6092 @item tiny
6093 @cindex @code{tiny} variable attribute, MeP
6094 Likewise, the @code{tiny} attribute assigned variables to the
6095 @code{.tiny} section, relative to the @code{$gp} register.
6097 @item near
6098 @cindex @code{near} variable attribute, MeP
6099 Variables with the @code{near} attribute are assumed to have addresses
6100 that fit in a 24-bit addressing mode.  This is the default for large
6101 variables (@code{-mtiny=4} is the default) but this attribute can
6102 override @code{-mtiny=} for small variables, or override @code{-ml}.
6104 @item far
6105 @cindex @code{far} variable attribute, MeP
6106 Variables with the @code{far} attribute are addressed using a full
6107 32-bit address.  Since this covers the entire memory space, this
6108 allows modules to make no assumptions about where variables might be
6109 stored.
6111 @item io
6112 @cindex @code{io} variable attribute, MeP
6113 @itemx io (@var{addr})
6114 Variables with the @code{io} attribute are used to address
6115 memory-mapped peripherals.  If an address is specified, the variable
6116 is assigned that address, else it is not assigned an address (it is
6117 assumed some other module assigns an address).  Example:
6119 @smallexample
6120 int timer_count __attribute__((io(0x123)));
6121 @end smallexample
6123 @item cb
6124 @itemx cb (@var{addr})
6125 @cindex @code{cb} variable attribute, MeP
6126 Variables with the @code{cb} attribute are used to access the control
6127 bus, using special instructions.  @code{addr} indicates the control bus
6128 address.  Example:
6130 @smallexample
6131 int cpu_clock __attribute__((cb(0x123)));
6132 @end smallexample
6134 @end table
6136 @node Microsoft Windows Variable Attributes
6137 @subsection Microsoft Windows Variable Attributes
6139 You can use these attributes on Microsoft Windows targets.
6140 @ref{x86 Variable Attributes} for additional Windows compatibility
6141 attributes available on all x86 targets.
6143 @table @code
6144 @item dllimport
6145 @itemx dllexport
6146 @cindex @code{dllimport} variable attribute
6147 @cindex @code{dllexport} variable attribute
6148 The @code{dllimport} and @code{dllexport} attributes are described in
6149 @ref{Microsoft Windows Function Attributes}.
6151 @item selectany
6152 @cindex @code{selectany} variable attribute
6153 The @code{selectany} attribute causes an initialized global variable to
6154 have link-once semantics.  When multiple definitions of the variable are
6155 encountered by the linker, the first is selected and the remainder are
6156 discarded.  Following usage by the Microsoft compiler, the linker is told
6157 @emph{not} to warn about size or content differences of the multiple
6158 definitions.
6160 Although the primary usage of this attribute is for POD types, the
6161 attribute can also be applied to global C++ objects that are initialized
6162 by a constructor.  In this case, the static initialization and destruction
6163 code for the object is emitted in each translation defining the object,
6164 but the calls to the constructor and destructor are protected by a
6165 link-once guard variable.
6167 The @code{selectany} attribute is only available on Microsoft Windows
6168 targets.  You can use @code{__declspec (selectany)} as a synonym for
6169 @code{__attribute__ ((selectany))} for compatibility with other
6170 compilers.
6172 @item shared
6173 @cindex @code{shared} variable attribute
6174 On Microsoft Windows, in addition to putting variable definitions in a named
6175 section, the section can also be shared among all running copies of an
6176 executable or DLL@.  For example, this small program defines shared data
6177 by putting it in a named section @code{shared} and marking the section
6178 shareable:
6180 @smallexample
6181 int foo __attribute__((section ("shared"), shared)) = 0;
6184 main()
6186   /* @r{Read and write foo.  All running
6187      copies see the same value.}  */
6188   return 0;
6190 @end smallexample
6192 @noindent
6193 You may only use the @code{shared} attribute along with @code{section}
6194 attribute with a fully-initialized global definition because of the way
6195 linkers work.  See @code{section} attribute for more information.
6197 The @code{shared} attribute is only available on Microsoft Windows@.
6199 @end table
6201 @node MSP430 Variable Attributes
6202 @subsection MSP430 Variable Attributes
6204 @table @code
6205 @item noinit
6206 @cindex @code{noinit} variable attribute, MSP430 
6207 Any data with the @code{noinit} attribute will not be initialised by
6208 the C runtime startup code, or the program loader.  Not initialising
6209 data in this way can reduce program startup times.
6211 @item persistent
6212 @cindex @code{persistent} variable attribute, MSP430 
6213 Any variable with the @code{persistent} attribute will not be
6214 initialised by the C runtime startup code.  Instead its value will be
6215 set once, when the application is loaded, and then never initialised
6216 again, even if the processor is reset or the program restarts.
6217 Persistent data is intended to be placed into FLASH RAM, where its
6218 value will be retained across resets.  The linker script being used to
6219 create the application should ensure that persistent data is correctly
6220 placed.
6222 @item lower
6223 @itemx upper
6224 @itemx either
6225 @cindex @code{lower} variable attribute, MSP430 
6226 @cindex @code{upper} variable attribute, MSP430 
6227 @cindex @code{either} variable attribute, MSP430 
6228 These attributes are the same as the MSP430 function attributes of the
6229 same name (@pxref{MSP430 Function Attributes}).  
6230 These attributes can be applied to both functions and variables.
6231 @end table
6233 @node PowerPC Variable Attributes
6234 @subsection PowerPC Variable Attributes
6236 Three attributes currently are defined for PowerPC configurations:
6237 @code{altivec}, @code{ms_struct} and @code{gcc_struct}.
6239 @cindex @code{ms_struct} variable attribute, PowerPC
6240 @cindex @code{gcc_struct} variable attribute, PowerPC
6241 For full documentation of the struct attributes please see the
6242 documentation in @ref{x86 Variable Attributes}.
6244 @cindex @code{altivec} variable attribute, PowerPC
6245 For documentation of @code{altivec} attribute please see the
6246 documentation in @ref{PowerPC Type Attributes}.
6248 @node RL78 Variable Attributes
6249 @subsection RL78 Variable Attributes
6251 @cindex @code{saddr} variable attribute, RL78
6252 The RL78 back end supports the @code{saddr} variable attribute.  This
6253 specifies placement of the corresponding variable in the SADDR area,
6254 which can be accessed more efficiently than the default memory region.
6256 @node SPU Variable Attributes
6257 @subsection SPU Variable Attributes
6259 @cindex @code{spu_vector} variable attribute, SPU
6260 The SPU supports the @code{spu_vector} attribute for variables.  For
6261 documentation of this attribute please see the documentation in
6262 @ref{SPU Type Attributes}.
6264 @node V850 Variable Attributes
6265 @subsection V850 Variable Attributes
6267 These variable attributes are supported by the V850 back end:
6269 @table @code
6271 @item sda
6272 @cindex @code{sda} variable attribute, V850
6273 Use this attribute to explicitly place a variable in the small data area,
6274 which can hold up to 64 kilobytes.
6276 @item tda
6277 @cindex @code{tda} variable attribute, V850
6278 Use this attribute to explicitly place a variable in the tiny data area,
6279 which can hold up to 256 bytes in total.
6281 @item zda
6282 @cindex @code{zda} variable attribute, V850
6283 Use this attribute to explicitly place a variable in the first 32 kilobytes
6284 of memory.
6285 @end table
6287 @node x86 Variable Attributes
6288 @subsection x86 Variable Attributes
6290 Two attributes are currently defined for x86 configurations:
6291 @code{ms_struct} and @code{gcc_struct}.
6293 @table @code
6294 @item ms_struct
6295 @itemx gcc_struct
6296 @cindex @code{ms_struct} variable attribute, x86
6297 @cindex @code{gcc_struct} variable attribute, x86
6299 If @code{packed} is used on a structure, or if bit-fields are used,
6300 it may be that the Microsoft ABI lays out the structure differently
6301 than the way GCC normally does.  Particularly when moving packed
6302 data between functions compiled with GCC and the native Microsoft compiler
6303 (either via function call or as data in a file), it may be necessary to access
6304 either format.
6306 The @code{ms_struct} and @code{gcc_struct} attributes correspond
6307 to the @option{-mms-bitfields} and @option{-mno-ms-bitfields}
6308 command-line options, respectively;
6309 see @ref{x86 Options}, for details of how structure layout is affected.
6310 @xref{x86 Type Attributes}, for information about the corresponding
6311 attributes on types.
6313 @end table
6315 @node Xstormy16 Variable Attributes
6316 @subsection Xstormy16 Variable Attributes
6318 One attribute is currently defined for xstormy16 configurations:
6319 @code{below100}.
6321 @table @code
6322 @item below100
6323 @cindex @code{below100} variable attribute, Xstormy16
6325 If a variable has the @code{below100} attribute (@code{BELOW100} is
6326 allowed also), GCC places the variable in the first 0x100 bytes of
6327 memory and use special opcodes to access it.  Such variables are
6328 placed in either the @code{.bss_below100} section or the
6329 @code{.data_below100} section.
6331 @end table
6333 @node Type Attributes
6334 @section Specifying Attributes of Types
6335 @cindex attribute of types
6336 @cindex type attributes
6338 The keyword @code{__attribute__} allows you to specify special
6339 attributes of types.  Some type attributes apply only to @code{struct}
6340 and @code{union} types, while others can apply to any type defined
6341 via a @code{typedef} declaration.  Other attributes are defined for
6342 functions (@pxref{Function Attributes}), labels (@pxref{Label 
6343 Attributes}), enumerators (@pxref{Enumerator Attributes}), and for
6344 variables (@pxref{Variable Attributes}).
6346 The @code{__attribute__} keyword is followed by an attribute specification
6347 inside double parentheses.  
6349 You may specify type attributes in an enum, struct or union type
6350 declaration or definition by placing them immediately after the
6351 @code{struct}, @code{union} or @code{enum} keyword.  A less preferred
6352 syntax is to place them just past the closing curly brace of the
6353 definition.
6355 You can also include type attributes in a @code{typedef} declaration.
6356 @xref{Attribute Syntax}, for details of the exact syntax for using
6357 attributes.
6359 @menu
6360 * Common Type Attributes::
6361 * ARM Type Attributes::
6362 * MeP Type Attributes::
6363 * PowerPC Type Attributes::
6364 * SPU Type Attributes::
6365 * x86 Type Attributes::
6366 @end menu
6368 @node Common Type Attributes
6369 @subsection Common Type Attributes
6371 The following type attributes are supported on most targets.
6373 @table @code
6374 @cindex @code{aligned} type attribute
6375 @item aligned (@var{alignment})
6376 This attribute specifies a minimum alignment (in bytes) for variables
6377 of the specified type.  For example, the declarations:
6379 @smallexample
6380 struct S @{ short f[3]; @} __attribute__ ((aligned (8)));
6381 typedef int more_aligned_int __attribute__ ((aligned (8)));
6382 @end smallexample
6384 @noindent
6385 force the compiler to ensure (as far as it can) that each variable whose
6386 type is @code{struct S} or @code{more_aligned_int} is allocated and
6387 aligned @emph{at least} on a 8-byte boundary.  On a SPARC, having all
6388 variables of type @code{struct S} aligned to 8-byte boundaries allows
6389 the compiler to use the @code{ldd} and @code{std} (doubleword load and
6390 store) instructions when copying one variable of type @code{struct S} to
6391 another, thus improving run-time efficiency.
6393 Note that the alignment of any given @code{struct} or @code{union} type
6394 is required by the ISO C standard to be at least a perfect multiple of
6395 the lowest common multiple of the alignments of all of the members of
6396 the @code{struct} or @code{union} in question.  This means that you @emph{can}
6397 effectively adjust the alignment of a @code{struct} or @code{union}
6398 type by attaching an @code{aligned} attribute to any one of the members
6399 of such a type, but the notation illustrated in the example above is a
6400 more obvious, intuitive, and readable way to request the compiler to
6401 adjust the alignment of an entire @code{struct} or @code{union} type.
6403 As in the preceding example, you can explicitly specify the alignment
6404 (in bytes) that you wish the compiler to use for a given @code{struct}
6405 or @code{union} type.  Alternatively, you can leave out the alignment factor
6406 and just ask the compiler to align a type to the maximum
6407 useful alignment for the target machine you are compiling for.  For
6408 example, you could write:
6410 @smallexample
6411 struct S @{ short f[3]; @} __attribute__ ((aligned));
6412 @end smallexample
6414 Whenever you leave out the alignment factor in an @code{aligned}
6415 attribute specification, the compiler automatically sets the alignment
6416 for the type to the largest alignment that is ever used for any data
6417 type on the target machine you are compiling for.  Doing this can often
6418 make copy operations more efficient, because the compiler can use
6419 whatever instructions copy the biggest chunks of memory when performing
6420 copies to or from the variables that have types that you have aligned
6421 this way.
6423 In the example above, if the size of each @code{short} is 2 bytes, then
6424 the size of the entire @code{struct S} type is 6 bytes.  The smallest
6425 power of two that is greater than or equal to that is 8, so the
6426 compiler sets the alignment for the entire @code{struct S} type to 8
6427 bytes.
6429 Note that although you can ask the compiler to select a time-efficient
6430 alignment for a given type and then declare only individual stand-alone
6431 objects of that type, the compiler's ability to select a time-efficient
6432 alignment is primarily useful only when you plan to create arrays of
6433 variables having the relevant (efficiently aligned) type.  If you
6434 declare or use arrays of variables of an efficiently-aligned type, then
6435 it is likely that your program also does pointer arithmetic (or
6436 subscripting, which amounts to the same thing) on pointers to the
6437 relevant type, and the code that the compiler generates for these
6438 pointer arithmetic operations is often more efficient for
6439 efficiently-aligned types than for other types.
6441 Note that the effectiveness of @code{aligned} attributes may be limited
6442 by inherent limitations in your linker.  On many systems, the linker is
6443 only able to arrange for variables to be aligned up to a certain maximum
6444 alignment.  (For some linkers, the maximum supported alignment may
6445 be very very small.)  If your linker is only able to align variables
6446 up to a maximum of 8-byte alignment, then specifying @code{aligned(16)}
6447 in an @code{__attribute__} still only provides you with 8-byte
6448 alignment.  See your linker documentation for further information.
6450 The @code{aligned} attribute can only increase alignment.  Alignment
6451 can be decreased by specifying the @code{packed} attribute.  See below.
6453 @item bnd_variable_size
6454 @cindex @code{bnd_variable_size} type attribute
6455 @cindex Pointer Bounds Checker attributes
6456 When applied to a structure field, this attribute tells Pointer
6457 Bounds Checker that the size of this field should not be computed
6458 using static type information.  It may be used to mark variably-sized
6459 static array fields placed at the end of a structure.
6461 @smallexample
6462 struct S
6464   int size;
6465   char data[1];
6467 S *p = (S *)malloc (sizeof(S) + 100);
6468 p->data[10] = 0; //Bounds violation
6469 @end smallexample
6471 @noindent
6472 By using an attribute for the field we may avoid unwanted bound
6473 violation checks:
6475 @smallexample
6476 struct S
6478   int size;
6479   char data[1] __attribute__((bnd_variable_size));
6481 S *p = (S *)malloc (sizeof(S) + 100);
6482 p->data[10] = 0; //OK
6483 @end smallexample
6485 @item deprecated
6486 @itemx deprecated (@var{msg})
6487 @cindex @code{deprecated} type attribute
6488 The @code{deprecated} attribute results in a warning if the type
6489 is used anywhere in the source file.  This is useful when identifying
6490 types that are expected to be removed in a future version of a program.
6491 If possible, the warning also includes the location of the declaration
6492 of the deprecated type, to enable users to easily find further
6493 information about why the type is deprecated, or what they should do
6494 instead.  Note that the warnings only occur for uses and then only
6495 if the type is being applied to an identifier that itself is not being
6496 declared as deprecated.
6498 @smallexample
6499 typedef int T1 __attribute__ ((deprecated));
6500 T1 x;
6501 typedef T1 T2;
6502 T2 y;
6503 typedef T1 T3 __attribute__ ((deprecated));
6504 T3 z __attribute__ ((deprecated));
6505 @end smallexample
6507 @noindent
6508 results in a warning on line 2 and 3 but not lines 4, 5, or 6.  No
6509 warning is issued for line 4 because T2 is not explicitly
6510 deprecated.  Line 5 has no warning because T3 is explicitly
6511 deprecated.  Similarly for line 6.  The optional @var{msg}
6512 argument, which must be a string, is printed in the warning if
6513 present.
6515 The @code{deprecated} attribute can also be used for functions and
6516 variables (@pxref{Function Attributes}, @pxref{Variable Attributes}.)
6518 @item designated_init
6519 @cindex @code{designated_init} type attribute
6520 This attribute may only be applied to structure types.  It indicates
6521 that any initialization of an object of this type must use designated
6522 initializers rather than positional initializers.  The intent of this
6523 attribute is to allow the programmer to indicate that a structure's
6524 layout may change, and that therefore relying on positional
6525 initialization will result in future breakage.
6527 GCC emits warnings based on this attribute by default; use
6528 @option{-Wno-designated-init} to suppress them.
6530 @item may_alias
6531 @cindex @code{may_alias} type attribute
6532 Accesses through pointers to types with this attribute are not subject
6533 to type-based alias analysis, but are instead assumed to be able to alias
6534 any other type of objects.
6535 In the context of section 6.5 paragraph 7 of the C99 standard,
6536 an lvalue expression
6537 dereferencing such a pointer is treated like having a character type.
6538 See @option{-fstrict-aliasing} for more information on aliasing issues.
6539 This extension exists to support some vector APIs, in which pointers to
6540 one vector type are permitted to alias pointers to a different vector type.
6542 Note that an object of a type with this attribute does not have any
6543 special semantics.
6545 Example of use:
6547 @smallexample
6548 typedef short __attribute__((__may_alias__)) short_a;
6551 main (void)
6553   int a = 0x12345678;
6554   short_a *b = (short_a *) &a;
6556   b[1] = 0;
6558   if (a == 0x12345678)
6559     abort();
6561   exit(0);
6563 @end smallexample
6565 @noindent
6566 If you replaced @code{short_a} with @code{short} in the variable
6567 declaration, the above program would abort when compiled with
6568 @option{-fstrict-aliasing}, which is on by default at @option{-O2} or
6569 above.
6571 @item packed
6572 @cindex @code{packed} type attribute
6573 This attribute, attached to @code{struct} or @code{union} type
6574 definition, specifies that each member (other than zero-width bit-fields)
6575 of the structure or union is placed to minimize the memory required.  When
6576 attached to an @code{enum} definition, it indicates that the smallest
6577 integral type should be used.
6579 @opindex fshort-enums
6580 Specifying the @code{packed} attribute for @code{struct} and @code{union}
6581 types is equivalent to specifying the @code{packed} attribute on each
6582 of the structure or union members.  Specifying the @option{-fshort-enums}
6583 flag on the command line is equivalent to specifying the @code{packed}
6584 attribute on all @code{enum} definitions.
6586 In the following example @code{struct my_packed_struct}'s members are
6587 packed closely together, but the internal layout of its @code{s} member
6588 is not packed---to do that, @code{struct my_unpacked_struct} needs to
6589 be packed too.
6591 @smallexample
6592 struct my_unpacked_struct
6593  @{
6594     char c;
6595     int i;
6596  @};
6598 struct __attribute__ ((__packed__)) my_packed_struct
6599   @{
6600      char c;
6601      int  i;
6602      struct my_unpacked_struct s;
6603   @};
6604 @end smallexample
6606 You may only specify the @code{packed} attribute attribute on the definition
6607 of an @code{enum}, @code{struct} or @code{union}, not on a @code{typedef}
6608 that does not also define the enumerated type, structure or union.
6610 @item scalar_storage_order ("@var{endianness}")
6611 @cindex @code{scalar_storage_order} type attribute
6612 When attached to a @code{union} or a @code{struct}, this attribute sets
6613 the storage order, aka endianness, of the scalar fields of the type, as
6614 well as the array fields whose component is scalar.  The supported
6615 endiannesses are @code{big-endian} and @code{little-endian}.  The attribute
6616 has no effects on fields which are themselves a @code{union}, a @code{struct}
6617 or an array whose component is a @code{union} or a @code{struct}, and it is
6618 possible for these fields to have a different scalar storage order than the
6619 enclosing type.
6621 This attribute is supported only for targets that use a uniform default
6622 scalar storage order (fortunately, most of them), i.e. targets that store
6623 the scalars either all in big-endian or all in little-endian.
6625 Additional restrictions are enforced for types with the reverse scalar
6626 storage order with regard to the scalar storage order of the target:
6628 @itemize
6629 @item Taking the address of a scalar field of a @code{union} or a
6630 @code{struct} with reverse scalar storage order is not permitted and yields
6631 an error.
6632 @item Taking the address of an array field, whose component is scalar, of
6633 a @code{union} or a @code{struct} with reverse scalar storage order is
6634 permitted but yields a warning, unless @option{-Wno-scalar-storage-order}
6635 is specified.
6636 @item Taking the address of a @code{union} or a @code{struct} with reverse
6637 scalar storage order is permitted.
6638 @end itemize
6640 These restrictions exist because the storage order attribute is lost when
6641 the address of a scalar or the address of an array with scalar component is
6642 taken, so storing indirectly through this address generally does not work.
6643 The second case is nevertheless allowed to be able to perform a block copy
6644 from or to the array.
6646 Moreover, the use of type punning or aliasing to toggle the storage order
6647 is not supported; that is to say, a given scalar object cannot be accessed
6648 through distinct types that assign a different storage order to it.
6650 @item transparent_union
6651 @cindex @code{transparent_union} type attribute
6653 This attribute, attached to a @code{union} type definition, indicates
6654 that any function parameter having that union type causes calls to that
6655 function to be treated in a special way.
6657 First, the argument corresponding to a transparent union type can be of
6658 any type in the union; no cast is required.  Also, if the union contains
6659 a pointer type, the corresponding argument can be a null pointer
6660 constant or a void pointer expression; and if the union contains a void
6661 pointer type, the corresponding argument can be any pointer expression.
6662 If the union member type is a pointer, qualifiers like @code{const} on
6663 the referenced type must be respected, just as with normal pointer
6664 conversions.
6666 Second, the argument is passed to the function using the calling
6667 conventions of the first member of the transparent union, not the calling
6668 conventions of the union itself.  All members of the union must have the
6669 same machine representation; this is necessary for this argument passing
6670 to work properly.
6672 Transparent unions are designed for library functions that have multiple
6673 interfaces for compatibility reasons.  For example, suppose the
6674 @code{wait} function must accept either a value of type @code{int *} to
6675 comply with POSIX, or a value of type @code{union wait *} to comply with
6676 the 4.1BSD interface.  If @code{wait}'s parameter were @code{void *},
6677 @code{wait} would accept both kinds of arguments, but it would also
6678 accept any other pointer type and this would make argument type checking
6679 less useful.  Instead, @code{<sys/wait.h>} might define the interface
6680 as follows:
6682 @smallexample
6683 typedef union __attribute__ ((__transparent_union__))
6684   @{
6685     int *__ip;
6686     union wait *__up;
6687   @} wait_status_ptr_t;
6689 pid_t wait (wait_status_ptr_t);
6690 @end smallexample
6692 @noindent
6693 This interface allows either @code{int *} or @code{union wait *}
6694 arguments to be passed, using the @code{int *} calling convention.
6695 The program can call @code{wait} with arguments of either type:
6697 @smallexample
6698 int w1 () @{ int w; return wait (&w); @}
6699 int w2 () @{ union wait w; return wait (&w); @}
6700 @end smallexample
6702 @noindent
6703 With this interface, @code{wait}'s implementation might look like this:
6705 @smallexample
6706 pid_t wait (wait_status_ptr_t p)
6708   return waitpid (-1, p.__ip, 0);
6710 @end smallexample
6712 @item unused
6713 @cindex @code{unused} type attribute
6714 When attached to a type (including a @code{union} or a @code{struct}),
6715 this attribute means that variables of that type are meant to appear
6716 possibly unused.  GCC does not produce a warning for any variables of
6717 that type, even if the variable appears to do nothing.  This is often
6718 the case with lock or thread classes, which are usually defined and then
6719 not referenced, but contain constructors and destructors that have
6720 nontrivial bookkeeping functions.
6722 @item visibility
6723 @cindex @code{visibility} type attribute
6724 In C++, attribute visibility (@pxref{Function Attributes}) can also be
6725 applied to class, struct, union and enum types.  Unlike other type
6726 attributes, the attribute must appear between the initial keyword and
6727 the name of the type; it cannot appear after the body of the type.
6729 Note that the type visibility is applied to vague linkage entities
6730 associated with the class (vtable, typeinfo node, etc.).  In
6731 particular, if a class is thrown as an exception in one shared object
6732 and caught in another, the class must have default visibility.
6733 Otherwise the two shared objects are unable to use the same
6734 typeinfo node and exception handling will break.
6736 @end table
6738 To specify multiple attributes, separate them by commas within the
6739 double parentheses: for example, @samp{__attribute__ ((aligned (16),
6740 packed))}.
6742 @node ARM Type Attributes
6743 @subsection ARM Type Attributes
6745 @cindex @code{notshared} type attribute, ARM
6746 On those ARM targets that support @code{dllimport} (such as Symbian
6747 OS), you can use the @code{notshared} attribute to indicate that the
6748 virtual table and other similar data for a class should not be
6749 exported from a DLL@.  For example:
6751 @smallexample
6752 class __declspec(notshared) C @{
6753 public:
6754   __declspec(dllimport) C();
6755   virtual void f();
6758 __declspec(dllexport)
6759 C::C() @{@}
6760 @end smallexample
6762 @noindent
6763 In this code, @code{C::C} is exported from the current DLL, but the
6764 virtual table for @code{C} is not exported.  (You can use
6765 @code{__attribute__} instead of @code{__declspec} if you prefer, but
6766 most Symbian OS code uses @code{__declspec}.)
6768 @node MeP Type Attributes
6769 @subsection MeP Type Attributes
6771 @cindex @code{based} type attribute, MeP
6772 @cindex @code{tiny} type attribute, MeP
6773 @cindex @code{near} type attribute, MeP
6774 @cindex @code{far} type attribute, MeP
6775 Many of the MeP variable attributes may be applied to types as well.
6776 Specifically, the @code{based}, @code{tiny}, @code{near}, and
6777 @code{far} attributes may be applied to either.  The @code{io} and
6778 @code{cb} attributes may not be applied to types.
6780 @node PowerPC Type Attributes
6781 @subsection PowerPC Type Attributes
6783 Three attributes currently are defined for PowerPC configurations:
6784 @code{altivec}, @code{ms_struct} and @code{gcc_struct}.
6786 @cindex @code{ms_struct} type attribute, PowerPC
6787 @cindex @code{gcc_struct} type attribute, PowerPC
6788 For full documentation of the @code{ms_struct} and @code{gcc_struct}
6789 attributes please see the documentation in @ref{x86 Type Attributes}.
6791 @cindex @code{altivec} type attribute, PowerPC
6792 The @code{altivec} attribute allows one to declare AltiVec vector data
6793 types supported by the AltiVec Programming Interface Manual.  The
6794 attribute requires an argument to specify one of three vector types:
6795 @code{vector__}, @code{pixel__} (always followed by unsigned short),
6796 and @code{bool__} (always followed by unsigned).
6798 @smallexample
6799 __attribute__((altivec(vector__)))
6800 __attribute__((altivec(pixel__))) unsigned short
6801 __attribute__((altivec(bool__))) unsigned
6802 @end smallexample
6804 These attributes mainly are intended to support the @code{__vector},
6805 @code{__pixel}, and @code{__bool} AltiVec keywords.
6807 @node SPU Type Attributes
6808 @subsection SPU Type Attributes
6810 @cindex @code{spu_vector} type attribute, SPU
6811 The SPU supports the @code{spu_vector} attribute for types.  This attribute
6812 allows one to declare vector data types supported by the Sony/Toshiba/IBM SPU
6813 Language Extensions Specification.  It is intended to support the
6814 @code{__vector} keyword.
6816 @node x86 Type Attributes
6817 @subsection x86 Type Attributes
6819 Two attributes are currently defined for x86 configurations:
6820 @code{ms_struct} and @code{gcc_struct}.
6822 @table @code
6824 @item ms_struct
6825 @itemx gcc_struct
6826 @cindex @code{ms_struct} type attribute, x86
6827 @cindex @code{gcc_struct} type attribute, x86
6829 If @code{packed} is used on a structure, or if bit-fields are used
6830 it may be that the Microsoft ABI packs them differently
6831 than GCC normally packs them.  Particularly when moving packed
6832 data between functions compiled with GCC and the native Microsoft compiler
6833 (either via function call or as data in a file), it may be necessary to access
6834 either format.
6836 The @code{ms_struct} and @code{gcc_struct} attributes correspond
6837 to the @option{-mms-bitfields} and @option{-mno-ms-bitfields}
6838 command-line options, respectively;
6839 see @ref{x86 Options}, for details of how structure layout is affected.
6840 @xref{x86 Variable Attributes}, for information about the corresponding
6841 attributes on variables.
6843 @end table
6845 @node Label Attributes
6846 @section Label Attributes
6847 @cindex Label Attributes
6849 GCC allows attributes to be set on C labels.  @xref{Attribute Syntax}, for 
6850 details of the exact syntax for using attributes.  Other attributes are 
6851 available for functions (@pxref{Function Attributes}), variables 
6852 (@pxref{Variable Attributes}), enumerators (@pxref{Enumerator Attributes}),
6853 and for types (@pxref{Type Attributes}).
6855 This example uses the @code{cold} label attribute to indicate the 
6856 @code{ErrorHandling} branch is unlikely to be taken and that the
6857 @code{ErrorHandling} label is unused:
6859 @smallexample
6861    asm goto ("some asm" : : : : NoError);
6863 /* This branch (the fall-through from the asm) is less commonly used */
6864 ErrorHandling: 
6865    __attribute__((cold, unused)); /* Semi-colon is required here */
6866    printf("error\n");
6867    return 0;
6869 NoError:
6870    printf("no error\n");
6871    return 1;
6872 @end smallexample
6874 @table @code
6875 @item unused
6876 @cindex @code{unused} label attribute
6877 This feature is intended for program-generated code that may contain 
6878 unused labels, but which is compiled with @option{-Wall}.  It is
6879 not normally appropriate to use in it human-written code, though it
6880 could be useful in cases where the code that jumps to the label is
6881 contained within an @code{#ifdef} conditional.
6883 @item hot
6884 @cindex @code{hot} label attribute
6885 The @code{hot} attribute on a label is used to inform the compiler that
6886 the path following the label is more likely than paths that are not so
6887 annotated.  This attribute is used in cases where @code{__builtin_expect}
6888 cannot be used, for instance with computed goto or @code{asm goto}.
6890 @item cold
6891 @cindex @code{cold} label attribute
6892 The @code{cold} attribute on labels is used to inform the compiler that
6893 the path following the label is unlikely to be executed.  This attribute
6894 is used in cases where @code{__builtin_expect} cannot be used, for instance
6895 with computed goto or @code{asm goto}.
6897 @end table
6899 @node Enumerator Attributes
6900 @section Enumerator Attributes
6901 @cindex Enumerator Attributes
6903 GCC allows attributes to be set on enumerators.  @xref{Attribute Syntax}, for
6904 details of the exact syntax for using attributes.  Other attributes are
6905 available for functions (@pxref{Function Attributes}), variables
6906 (@pxref{Variable Attributes}), labels (@pxref{Label Attributes}),
6907 and for types (@pxref{Type Attributes}).
6909 This example uses the @code{deprecated} enumerator attribute to indicate the
6910 @code{oldval} enumerator is deprecated:
6912 @smallexample
6913 enum E @{
6914   oldval __attribute__((deprecated)),
6915   newval
6919 fn (void)
6921   return oldval;
6923 @end smallexample
6925 @table @code
6926 @item deprecated
6927 @cindex @code{deprecated} enumerator attribute
6928 The @code{deprecated} attribute results in a warning if the enumerator
6929 is used anywhere in the source file.  This is useful when identifying
6930 enumerators that are expected to be removed in a future version of a
6931 program.  The warning also includes the location of the declaration
6932 of the deprecated enumerator, to enable users to easily find further
6933 information about why the enumerator is deprecated, or what they should
6934 do instead.  Note that the warnings only occurs for uses.
6936 @end table
6938 @node Attribute Syntax
6939 @section Attribute Syntax
6940 @cindex attribute syntax
6942 This section describes the syntax with which @code{__attribute__} may be
6943 used, and the constructs to which attribute specifiers bind, for the C
6944 language.  Some details may vary for C++ and Objective-C@.  Because of
6945 infelicities in the grammar for attributes, some forms described here
6946 may not be successfully parsed in all cases.
6948 There are some problems with the semantics of attributes in C++.  For
6949 example, there are no manglings for attributes, although they may affect
6950 code generation, so problems may arise when attributed types are used in
6951 conjunction with templates or overloading.  Similarly, @code{typeid}
6952 does not distinguish between types with different attributes.  Support
6953 for attributes in C++ may be restricted in future to attributes on
6954 declarations only, but not on nested declarators.
6956 @xref{Function Attributes}, for details of the semantics of attributes
6957 applying to functions.  @xref{Variable Attributes}, for details of the
6958 semantics of attributes applying to variables.  @xref{Type Attributes},
6959 for details of the semantics of attributes applying to structure, union
6960 and enumerated types.
6961 @xref{Label Attributes}, for details of the semantics of attributes 
6962 applying to labels.
6963 @xref{Enumerator Attributes}, for details of the semantics of attributes
6964 applying to enumerators.
6966 An @dfn{attribute specifier} is of the form
6967 @code{__attribute__ ((@var{attribute-list}))}.  An @dfn{attribute list}
6968 is a possibly empty comma-separated sequence of @dfn{attributes}, where
6969 each attribute is one of the following:
6971 @itemize @bullet
6972 @item
6973 Empty.  Empty attributes are ignored.
6975 @item
6976 An attribute name
6977 (which may be an identifier such as @code{unused}, or a reserved
6978 word such as @code{const}).
6980 @item
6981 An attribute name followed by a parenthesized list of
6982 parameters for the attribute.
6983 These parameters take one of the following forms:
6985 @itemize @bullet
6986 @item
6987 An identifier.  For example, @code{mode} attributes use this form.
6989 @item
6990 An identifier followed by a comma and a non-empty comma-separated list
6991 of expressions.  For example, @code{format} attributes use this form.
6993 @item
6994 A possibly empty comma-separated list of expressions.  For example,
6995 @code{format_arg} attributes use this form with the list being a single
6996 integer constant expression, and @code{alias} attributes use this form
6997 with the list being a single string constant.
6998 @end itemize
6999 @end itemize
7001 An @dfn{attribute specifier list} is a sequence of one or more attribute
7002 specifiers, not separated by any other tokens.
7004 You may optionally specify attribute names with @samp{__}
7005 preceding and following the name.
7006 This allows you to use them in header files without
7007 being concerned about a possible macro of the same name.  For example,
7008 you may use the attribute name @code{__noreturn__} instead of @code{noreturn}.
7011 @subsubheading Label Attributes
7013 In GNU C, an attribute specifier list may appear after the colon following a
7014 label, other than a @code{case} or @code{default} label.  GNU C++ only permits
7015 attributes on labels if the attribute specifier is immediately
7016 followed by a semicolon (i.e., the label applies to an empty
7017 statement).  If the semicolon is missing, C++ label attributes are
7018 ambiguous, as it is permissible for a declaration, which could begin
7019 with an attribute list, to be labelled in C++.  Declarations cannot be
7020 labelled in C90 or C99, so the ambiguity does not arise there.
7022 @subsubheading Enumerator Attributes
7024 In GNU C, an attribute specifier list may appear as part of an enumerator.
7025 The attribute goes after the enumeration constant, before @code{=}, if
7026 present.  The optional attribute in the enumerator appertains to the
7027 enumeration constant.  It is not possible to place the attribute after
7028 the constant expression, if present.
7030 @subsubheading Type Attributes
7032 An attribute specifier list may appear as part of a @code{struct},
7033 @code{union} or @code{enum} specifier.  It may go either immediately
7034 after the @code{struct}, @code{union} or @code{enum} keyword, or after
7035 the closing brace.  The former syntax is preferred.
7036 Where attribute specifiers follow the closing brace, they are considered
7037 to relate to the structure, union or enumerated type defined, not to any
7038 enclosing declaration the type specifier appears in, and the type
7039 defined is not complete until after the attribute specifiers.
7040 @c Otherwise, there would be the following problems: a shift/reduce
7041 @c conflict between attributes binding the struct/union/enum and
7042 @c binding to the list of specifiers/qualifiers; and "aligned"
7043 @c attributes could use sizeof for the structure, but the size could be
7044 @c changed later by "packed" attributes.
7047 @subsubheading All other attributes
7049 Otherwise, an attribute specifier appears as part of a declaration,
7050 counting declarations of unnamed parameters and type names, and relates
7051 to that declaration (which may be nested in another declaration, for
7052 example in the case of a parameter declaration), or to a particular declarator
7053 within a declaration.  Where an
7054 attribute specifier is applied to a parameter declared as a function or
7055 an array, it should apply to the function or array rather than the
7056 pointer to which the parameter is implicitly converted, but this is not
7057 yet correctly implemented.
7059 Any list of specifiers and qualifiers at the start of a declaration may
7060 contain attribute specifiers, whether or not such a list may in that
7061 context contain storage class specifiers.  (Some attributes, however,
7062 are essentially in the nature of storage class specifiers, and only make
7063 sense where storage class specifiers may be used; for example,
7064 @code{section}.)  There is one necessary limitation to this syntax: the
7065 first old-style parameter declaration in a function definition cannot
7066 begin with an attribute specifier, because such an attribute applies to
7067 the function instead by syntax described below (which, however, is not
7068 yet implemented in this case).  In some other cases, attribute
7069 specifiers are permitted by this grammar but not yet supported by the
7070 compiler.  All attribute specifiers in this place relate to the
7071 declaration as a whole.  In the obsolescent usage where a type of
7072 @code{int} is implied by the absence of type specifiers, such a list of
7073 specifiers and qualifiers may be an attribute specifier list with no
7074 other specifiers or qualifiers.
7076 At present, the first parameter in a function prototype must have some
7077 type specifier that is not an attribute specifier; this resolves an
7078 ambiguity in the interpretation of @code{void f(int
7079 (__attribute__((foo)) x))}, but is subject to change.  At present, if
7080 the parentheses of a function declarator contain only attributes then
7081 those attributes are ignored, rather than yielding an error or warning
7082 or implying a single parameter of type int, but this is subject to
7083 change.
7085 An attribute specifier list may appear immediately before a declarator
7086 (other than the first) in a comma-separated list of declarators in a
7087 declaration of more than one identifier using a single list of
7088 specifiers and qualifiers.  Such attribute specifiers apply
7089 only to the identifier before whose declarator they appear.  For
7090 example, in
7092 @smallexample
7093 __attribute__((noreturn)) void d0 (void),
7094     __attribute__((format(printf, 1, 2))) d1 (const char *, ...),
7095      d2 (void);
7096 @end smallexample
7098 @noindent
7099 the @code{noreturn} attribute applies to all the functions
7100 declared; the @code{format} attribute only applies to @code{d1}.
7102 An attribute specifier list may appear immediately before the comma,
7103 @code{=} or semicolon terminating the declaration of an identifier other
7104 than a function definition.  Such attribute specifiers apply
7105 to the declared object or function.  Where an
7106 assembler name for an object or function is specified (@pxref{Asm
7107 Labels}), the attribute must follow the @code{asm}
7108 specification.
7110 An attribute specifier list may, in future, be permitted to appear after
7111 the declarator in a function definition (before any old-style parameter
7112 declarations or the function body).
7114 Attribute specifiers may be mixed with type qualifiers appearing inside
7115 the @code{[]} of a parameter array declarator, in the C99 construct by
7116 which such qualifiers are applied to the pointer to which the array is
7117 implicitly converted.  Such attribute specifiers apply to the pointer,
7118 not to the array, but at present this is not implemented and they are
7119 ignored.
7121 An attribute specifier list may appear at the start of a nested
7122 declarator.  At present, there are some limitations in this usage: the
7123 attributes correctly apply to the declarator, but for most individual
7124 attributes the semantics this implies are not implemented.
7125 When attribute specifiers follow the @code{*} of a pointer
7126 declarator, they may be mixed with any type qualifiers present.
7127 The following describes the formal semantics of this syntax.  It makes the
7128 most sense if you are familiar with the formal specification of
7129 declarators in the ISO C standard.
7131 Consider (as in C99 subclause 6.7.5 paragraph 4) a declaration @code{T
7132 D1}, where @code{T} contains declaration specifiers that specify a type
7133 @var{Type} (such as @code{int}) and @code{D1} is a declarator that
7134 contains an identifier @var{ident}.  The type specified for @var{ident}
7135 for derived declarators whose type does not include an attribute
7136 specifier is as in the ISO C standard.
7138 If @code{D1} has the form @code{( @var{attribute-specifier-list} D )},
7139 and the declaration @code{T D} specifies the type
7140 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
7141 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
7142 @var{attribute-specifier-list} @var{Type}'' for @var{ident}.
7144 If @code{D1} has the form @code{*
7145 @var{type-qualifier-and-attribute-specifier-list} D}, and the
7146 declaration @code{T D} specifies the type
7147 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
7148 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
7149 @var{type-qualifier-and-attribute-specifier-list} pointer to @var{Type}'' for
7150 @var{ident}.
7152 For example,
7154 @smallexample
7155 void (__attribute__((noreturn)) ****f) (void);
7156 @end smallexample
7158 @noindent
7159 specifies the type ``pointer to pointer to pointer to pointer to
7160 non-returning function returning @code{void}''.  As another example,
7162 @smallexample
7163 char *__attribute__((aligned(8))) *f;
7164 @end smallexample
7166 @noindent
7167 specifies the type ``pointer to 8-byte-aligned pointer to @code{char}''.
7168 Note again that this does not work with most attributes; for example,
7169 the usage of @samp{aligned} and @samp{noreturn} attributes given above
7170 is not yet supported.
7172 For compatibility with existing code written for compiler versions that
7173 did not implement attributes on nested declarators, some laxity is
7174 allowed in the placing of attributes.  If an attribute that only applies
7175 to types is applied to a declaration, it is treated as applying to
7176 the type of that declaration.  If an attribute that only applies to
7177 declarations is applied to the type of a declaration, it is treated
7178 as applying to that declaration; and, for compatibility with code
7179 placing the attributes immediately before the identifier declared, such
7180 an attribute applied to a function return type is treated as
7181 applying to the function type, and such an attribute applied to an array
7182 element type is treated as applying to the array type.  If an
7183 attribute that only applies to function types is applied to a
7184 pointer-to-function type, it is treated as applying to the pointer
7185 target type; if such an attribute is applied to a function return type
7186 that is not a pointer-to-function type, it is treated as applying
7187 to the function type.
7189 @node Function Prototypes
7190 @section Prototypes and Old-Style Function Definitions
7191 @cindex function prototype declarations
7192 @cindex old-style function definitions
7193 @cindex promotion of formal parameters
7195 GNU C extends ISO C to allow a function prototype to override a later
7196 old-style non-prototype definition.  Consider the following example:
7198 @smallexample
7199 /* @r{Use prototypes unless the compiler is old-fashioned.}  */
7200 #ifdef __STDC__
7201 #define P(x) x
7202 #else
7203 #define P(x) ()
7204 #endif
7206 /* @r{Prototype function declaration.}  */
7207 int isroot P((uid_t));
7209 /* @r{Old-style function definition.}  */
7211 isroot (x)   /* @r{??? lossage here ???} */
7212      uid_t x;
7214   return x == 0;
7216 @end smallexample
7218 Suppose the type @code{uid_t} happens to be @code{short}.  ISO C does
7219 not allow this example, because subword arguments in old-style
7220 non-prototype definitions are promoted.  Therefore in this example the
7221 function definition's argument is really an @code{int}, which does not
7222 match the prototype argument type of @code{short}.
7224 This restriction of ISO C makes it hard to write code that is portable
7225 to traditional C compilers, because the programmer does not know
7226 whether the @code{uid_t} type is @code{short}, @code{int}, or
7227 @code{long}.  Therefore, in cases like these GNU C allows a prototype
7228 to override a later old-style definition.  More precisely, in GNU C, a
7229 function prototype argument type overrides the argument type specified
7230 by a later old-style definition if the former type is the same as the
7231 latter type before promotion.  Thus in GNU C the above example is
7232 equivalent to the following:
7234 @smallexample
7235 int isroot (uid_t);
7238 isroot (uid_t x)
7240   return x == 0;
7242 @end smallexample
7244 @noindent
7245 GNU C++ does not support old-style function definitions, so this
7246 extension is irrelevant.
7248 @node C++ Comments
7249 @section C++ Style Comments
7250 @cindex @code{//}
7251 @cindex C++ comments
7252 @cindex comments, C++ style
7254 In GNU C, you may use C++ style comments, which start with @samp{//} and
7255 continue until the end of the line.  Many other C implementations allow
7256 such comments, and they are included in the 1999 C standard.  However,
7257 C++ style comments are not recognized if you specify an @option{-std}
7258 option specifying a version of ISO C before C99, or @option{-ansi}
7259 (equivalent to @option{-std=c90}).
7261 @node Dollar Signs
7262 @section Dollar Signs in Identifier Names
7263 @cindex $
7264 @cindex dollar signs in identifier names
7265 @cindex identifier names, dollar signs in
7267 In GNU C, you may normally use dollar signs in identifier names.
7268 This is because many traditional C implementations allow such identifiers.
7269 However, dollar signs in identifiers are not supported on a few target
7270 machines, typically because the target assembler does not allow them.
7272 @node Character Escapes
7273 @section The Character @key{ESC} in Constants
7275 You can use the sequence @samp{\e} in a string or character constant to
7276 stand for the ASCII character @key{ESC}.
7278 @node Alignment
7279 @section Inquiring on Alignment of Types or Variables
7280 @cindex alignment
7281 @cindex type alignment
7282 @cindex variable alignment
7284 The keyword @code{__alignof__} allows you to inquire about how an object
7285 is aligned, or the minimum alignment usually required by a type.  Its
7286 syntax is just like @code{sizeof}.
7288 For example, if the target machine requires a @code{double} value to be
7289 aligned on an 8-byte boundary, then @code{__alignof__ (double)} is 8.
7290 This is true on many RISC machines.  On more traditional machine
7291 designs, @code{__alignof__ (double)} is 4 or even 2.
7293 Some machines never actually require alignment; they allow reference to any
7294 data type even at an odd address.  For these machines, @code{__alignof__}
7295 reports the smallest alignment that GCC gives the data type, usually as
7296 mandated by the target ABI.
7298 If the operand of @code{__alignof__} is an lvalue rather than a type,
7299 its value is the required alignment for its type, taking into account
7300 any minimum alignment specified with GCC's @code{__attribute__}
7301 extension (@pxref{Variable Attributes}).  For example, after this
7302 declaration:
7304 @smallexample
7305 struct foo @{ int x; char y; @} foo1;
7306 @end smallexample
7308 @noindent
7309 the value of @code{__alignof__ (foo1.y)} is 1, even though its actual
7310 alignment is probably 2 or 4, the same as @code{__alignof__ (int)}.
7312 It is an error to ask for the alignment of an incomplete type.
7315 @node Inline
7316 @section An Inline Function is As Fast As a Macro
7317 @cindex inline functions
7318 @cindex integrating function code
7319 @cindex open coding
7320 @cindex macros, inline alternative
7322 By declaring a function inline, you can direct GCC to make
7323 calls to that function faster.  One way GCC can achieve this is to
7324 integrate that function's code into the code for its callers.  This
7325 makes execution faster by eliminating the function-call overhead; in
7326 addition, if any of the actual argument values are constant, their
7327 known values may permit simplifications at compile time so that not
7328 all of the inline function's code needs to be included.  The effect on
7329 code size is less predictable; object code may be larger or smaller
7330 with function inlining, depending on the particular case.  You can
7331 also direct GCC to try to integrate all ``simple enough'' functions
7332 into their callers with the option @option{-finline-functions}.
7334 GCC implements three different semantics of declaring a function
7335 inline.  One is available with @option{-std=gnu89} or
7336 @option{-fgnu89-inline} or when @code{gnu_inline} attribute is present
7337 on all inline declarations, another when
7338 @option{-std=c99}, @option{-std=c11},
7339 @option{-std=gnu99} or @option{-std=gnu11}
7340 (without @option{-fgnu89-inline}), and the third
7341 is used when compiling C++.
7343 To declare a function inline, use the @code{inline} keyword in its
7344 declaration, like this:
7346 @smallexample
7347 static inline int
7348 inc (int *a)
7350   return (*a)++;
7352 @end smallexample
7354 If you are writing a header file to be included in ISO C90 programs, write
7355 @code{__inline__} instead of @code{inline}.  @xref{Alternate Keywords}.
7357 The three types of inlining behave similarly in two important cases:
7358 when the @code{inline} keyword is used on a @code{static} function,
7359 like the example above, and when a function is first declared without
7360 using the @code{inline} keyword and then is defined with
7361 @code{inline}, like this:
7363 @smallexample
7364 extern int inc (int *a);
7365 inline int
7366 inc (int *a)
7368   return (*a)++;
7370 @end smallexample
7372 In both of these common cases, the program behaves the same as if you
7373 had not used the @code{inline} keyword, except for its speed.
7375 @cindex inline functions, omission of
7376 @opindex fkeep-inline-functions
7377 When a function is both inline and @code{static}, if all calls to the
7378 function are integrated into the caller, and the function's address is
7379 never used, then the function's own assembler code is never referenced.
7380 In this case, GCC does not actually output assembler code for the
7381 function, unless you specify the option @option{-fkeep-inline-functions}.
7382 If there is a nonintegrated call, then the function is compiled to
7383 assembler code as usual.  The function must also be compiled as usual if
7384 the program refers to its address, because that can't be inlined.
7386 @opindex Winline
7387 Note that certain usages in a function definition can make it unsuitable
7388 for inline substitution.  Among these usages are: variadic functions,
7389 use of @code{alloca}, use of computed goto (@pxref{Labels as Values}),
7390 use of nonlocal goto, use of nested functions, use of @code{setjmp}, use
7391 of @code{__builtin_longjmp} and use of @code{__builtin_return} or
7392 @code{__builtin_apply_args}.  Using @option{-Winline} warns when a
7393 function marked @code{inline} could not be substituted, and gives the
7394 reason for the failure.
7396 @cindex automatic @code{inline} for C++ member fns
7397 @cindex @code{inline} automatic for C++ member fns
7398 @cindex member fns, automatically @code{inline}
7399 @cindex C++ member fns, automatically @code{inline}
7400 @opindex fno-default-inline
7401 As required by ISO C++, GCC considers member functions defined within
7402 the body of a class to be marked inline even if they are
7403 not explicitly declared with the @code{inline} keyword.  You can
7404 override this with @option{-fno-default-inline}; @pxref{C++ Dialect
7405 Options,,Options Controlling C++ Dialect}.
7407 GCC does not inline any functions when not optimizing unless you specify
7408 the @samp{always_inline} attribute for the function, like this:
7410 @smallexample
7411 /* @r{Prototype.}  */
7412 inline void foo (const char) __attribute__((always_inline));
7413 @end smallexample
7415 The remainder of this section is specific to GNU C90 inlining.
7417 @cindex non-static inline function
7418 When an inline function is not @code{static}, then the compiler must assume
7419 that there may be calls from other source files; since a global symbol can
7420 be defined only once in any program, the function must not be defined in
7421 the other source files, so the calls therein cannot be integrated.
7422 Therefore, a non-@code{static} inline function is always compiled on its
7423 own in the usual fashion.
7425 If you specify both @code{inline} and @code{extern} in the function
7426 definition, then the definition is used only for inlining.  In no case
7427 is the function compiled on its own, not even if you refer to its
7428 address explicitly.  Such an address becomes an external reference, as
7429 if you had only declared the function, and had not defined it.
7431 This combination of @code{inline} and @code{extern} has almost the
7432 effect of a macro.  The way to use it is to put a function definition in
7433 a header file with these keywords, and put another copy of the
7434 definition (lacking @code{inline} and @code{extern}) in a library file.
7435 The definition in the header file causes most calls to the function
7436 to be inlined.  If any uses of the function remain, they refer to
7437 the single copy in the library.
7439 @node Volatiles
7440 @section When is a Volatile Object Accessed?
7441 @cindex accessing volatiles
7442 @cindex volatile read
7443 @cindex volatile write
7444 @cindex volatile access
7446 C has the concept of volatile objects.  These are normally accessed by
7447 pointers and used for accessing hardware or inter-thread
7448 communication.  The standard encourages compilers to refrain from
7449 optimizations concerning accesses to volatile objects, but leaves it
7450 implementation defined as to what constitutes a volatile access.  The
7451 minimum requirement is that at a sequence point all previous accesses
7452 to volatile objects have stabilized and no subsequent accesses have
7453 occurred.  Thus an implementation is free to reorder and combine
7454 volatile accesses that occur between sequence points, but cannot do
7455 so for accesses across a sequence point.  The use of volatile does
7456 not allow you to violate the restriction on updating objects multiple
7457 times between two sequence points.
7459 Accesses to non-volatile objects are not ordered with respect to
7460 volatile accesses.  You cannot use a volatile object as a memory
7461 barrier to order a sequence of writes to non-volatile memory.  For
7462 instance:
7464 @smallexample
7465 int *ptr = @var{something};
7466 volatile int vobj;
7467 *ptr = @var{something};
7468 vobj = 1;
7469 @end smallexample
7471 @noindent
7472 Unless @var{*ptr} and @var{vobj} can be aliased, it is not guaranteed
7473 that the write to @var{*ptr} occurs by the time the update
7474 of @var{vobj} happens.  If you need this guarantee, you must use
7475 a stronger memory barrier such as:
7477 @smallexample
7478 int *ptr = @var{something};
7479 volatile int vobj;
7480 *ptr = @var{something};
7481 asm volatile ("" : : : "memory");
7482 vobj = 1;
7483 @end smallexample
7485 A scalar volatile object is read when it is accessed in a void context:
7487 @smallexample
7488 volatile int *src = @var{somevalue};
7489 *src;
7490 @end smallexample
7492 Such expressions are rvalues, and GCC implements this as a
7493 read of the volatile object being pointed to.
7495 Assignments are also expressions and have an rvalue.  However when
7496 assigning to a scalar volatile, the volatile object is not reread,
7497 regardless of whether the assignment expression's rvalue is used or
7498 not.  If the assignment's rvalue is used, the value is that assigned
7499 to the volatile object.  For instance, there is no read of @var{vobj}
7500 in all the following cases:
7502 @smallexample
7503 int obj;
7504 volatile int vobj;
7505 vobj = @var{something};
7506 obj = vobj = @var{something};
7507 obj ? vobj = @var{onething} : vobj = @var{anotherthing};
7508 obj = (@var{something}, vobj = @var{anotherthing});
7509 @end smallexample
7511 If you need to read the volatile object after an assignment has
7512 occurred, you must use a separate expression with an intervening
7513 sequence point.
7515 As bit-fields are not individually addressable, volatile bit-fields may
7516 be implicitly read when written to, or when adjacent bit-fields are
7517 accessed.  Bit-field operations may be optimized such that adjacent
7518 bit-fields are only partially accessed, if they straddle a storage unit
7519 boundary.  For these reasons it is unwise to use volatile bit-fields to
7520 access hardware.
7522 @node Using Assembly Language with C
7523 @section How to Use Inline Assembly Language in C Code
7524 @cindex @code{asm} keyword
7525 @cindex assembly language in C
7526 @cindex inline assembly language
7527 @cindex mixing assembly language and C
7529 The @code{asm} keyword allows you to embed assembler instructions
7530 within C code.  GCC provides two forms of inline @code{asm}
7531 statements.  A @dfn{basic @code{asm}} statement is one with no
7532 operands (@pxref{Basic Asm}), while an @dfn{extended @code{asm}}
7533 statement (@pxref{Extended Asm}) includes one or more operands.  
7534 The extended form is preferred for mixing C and assembly language
7535 within a function, but to include assembly language at
7536 top level you must use basic @code{asm}.
7538 You can also use the @code{asm} keyword to override the assembler name
7539 for a C symbol, or to place a C variable in a specific register.
7541 @menu
7542 * Basic Asm::          Inline assembler without operands.
7543 * Extended Asm::       Inline assembler with operands.
7544 * Constraints::        Constraints for @code{asm} operands
7545 * Asm Labels::         Specifying the assembler name to use for a C symbol.
7546 * Explicit Register Variables::  Defining variables residing in specified 
7547                        registers.
7548 * Size of an asm::     How GCC calculates the size of an @code{asm} block.
7549 @end menu
7551 @node Basic Asm
7552 @subsection Basic Asm --- Assembler Instructions Without Operands
7553 @cindex basic @code{asm}
7554 @cindex assembly language in C, basic
7556 A basic @code{asm} statement has the following syntax:
7558 @example
7559 asm @r{[} volatile @r{]} ( @var{AssemblerInstructions} )
7560 @end example
7562 The @code{asm} keyword is a GNU extension.
7563 When writing code that can be compiled with @option{-ansi} and the
7564 various @option{-std} options, use @code{__asm__} instead of 
7565 @code{asm} (@pxref{Alternate Keywords}).
7567 @subsubheading Qualifiers
7568 @table @code
7569 @item volatile
7570 The optional @code{volatile} qualifier has no effect. 
7571 All basic @code{asm} blocks are implicitly volatile.
7572 @end table
7574 @subsubheading Parameters
7575 @table @var
7577 @item AssemblerInstructions
7578 This is a literal string that specifies the assembler code. The string can 
7579 contain any instructions recognized by the assembler, including directives. 
7580 GCC does not parse the assembler instructions themselves and 
7581 does not know what they mean or even whether they are valid assembler input. 
7583 You may place multiple assembler instructions together in a single @code{asm} 
7584 string, separated by the characters normally used in assembly code for the 
7585 system. A combination that works in most places is a newline to break the 
7586 line, plus a tab character (written as @samp{\n\t}).
7587 Some assemblers allow semicolons as a line separator. However, 
7588 note that some assembler dialects use semicolons to start a comment. 
7589 @end table
7591 @subsubheading Remarks
7592 Using extended @code{asm} (@pxref{Extended Asm}) typically produces
7593 smaller, safer, and more efficient code, and in most cases it is a
7594 better solution than basic @code{asm}.  However, there are two
7595 situations where only basic @code{asm} can be used:
7597 @itemize @bullet
7598 @item
7599 Extended @code{asm} statements have to be inside a C
7600 function, so to write inline assembly language at file scope (``top-level''),
7601 outside of C functions, you must use basic @code{asm}.
7602 You can use this technique to emit assembler directives,
7603 define assembly language macros that can be invoked elsewhere in the file,
7604 or write entire functions in assembly language.
7606 @item
7607 Functions declared
7608 with the @code{naked} attribute also require basic @code{asm}
7609 (@pxref{Function Attributes}).
7610 @end itemize
7612 Safely accessing C data and calling functions from basic @code{asm} is more 
7613 complex than it may appear. To access C data, it is better to use extended 
7614 @code{asm}.
7616 Do not expect a sequence of @code{asm} statements to remain perfectly 
7617 consecutive after compilation. If certain instructions need to remain 
7618 consecutive in the output, put them in a single multi-instruction @code{asm}
7619 statement. Note that GCC's optimizers can move @code{asm} statements 
7620 relative to other code, including across jumps.
7622 @code{asm} statements may not perform jumps into other @code{asm} statements. 
7623 GCC does not know about these jumps, and therefore cannot take 
7624 account of them when deciding how to optimize. Jumps from @code{asm} to C 
7625 labels are only supported in extended @code{asm}.
7627 Under certain circumstances, GCC may duplicate (or remove duplicates of) your 
7628 assembly code when optimizing. This can lead to unexpected duplicate 
7629 symbol errors during compilation if your assembly code defines symbols or 
7630 labels.
7632 @strong{Warning:} The C standards do not specify semantics for @code{asm},
7633 making it a potential source of incompatibilities between compilers.  These
7634 incompatibilities may not produce compiler warnings/errors.
7636 GCC does not parse basic @code{asm}'s @var{AssemblerInstructions}, which
7637 means there is no way to communicate to the compiler what is happening
7638 inside them.  GCC has no visibility of symbols in the @code{asm} and may
7639 discard them as unreferenced.  It also does not know about side effects of
7640 the assembler code, such as modifications to memory or registers.  Unlike
7641 some compilers, GCC assumes that no changes to general purpose registers
7642 occur.  This assumption may change in a future release.
7644 To avoid complications from future changes to the semantics and the
7645 compatibility issues between compilers, consider replacing basic @code{asm}
7646 with extended @code{asm}.  See
7647 @uref{https://gcc.gnu.org/wiki/ConvertBasicAsmToExtended, How to convert
7648 from basic asm to extended asm} for information about how to perform this
7649 conversion.
7651 The compiler copies the assembler instructions in a basic @code{asm} 
7652 verbatim to the assembly language output file, without 
7653 processing dialects or any of the @samp{%} operators that are available with
7654 extended @code{asm}. This results in minor differences between basic 
7655 @code{asm} strings and extended @code{asm} templates. For example, to refer to 
7656 registers you might use @samp{%eax} in basic @code{asm} and
7657 @samp{%%eax} in extended @code{asm}.
7659 On targets such as x86 that support multiple assembler dialects,
7660 all basic @code{asm} blocks use the assembler dialect specified by the 
7661 @option{-masm} command-line option (@pxref{x86 Options}).  
7662 Basic @code{asm} provides no
7663 mechanism to provide different assembler strings for different dialects.
7665 For basic @code{asm} with non-empty assembler string GCC assumes
7666 the assembler block does not change any general purpose registers,
7667 but it may read or write any globally accessible variable.
7669 Here is an example of basic @code{asm} for i386:
7671 @example
7672 /* Note that this code will not compile with -masm=intel */
7673 #define DebugBreak() asm("int $3")
7674 @end example
7676 @node Extended Asm
7677 @subsection Extended Asm - Assembler Instructions with C Expression Operands
7678 @cindex extended @code{asm}
7679 @cindex assembly language in C, extended
7681 With extended @code{asm} you can read and write C variables from 
7682 assembler and perform jumps from assembler code to C labels.  
7683 Extended @code{asm} syntax uses colons (@samp{:}) to delimit
7684 the operand parameters after the assembler template:
7686 @example
7687 asm @r{[}volatile@r{]} ( @var{AssemblerTemplate} 
7688                  : @var{OutputOperands} 
7689                  @r{[} : @var{InputOperands}
7690                  @r{[} : @var{Clobbers} @r{]} @r{]})
7692 asm @r{[}volatile@r{]} goto ( @var{AssemblerTemplate} 
7693                       : 
7694                       : @var{InputOperands}
7695                       : @var{Clobbers}
7696                       : @var{GotoLabels})
7697 @end example
7699 The @code{asm} keyword is a GNU extension.
7700 When writing code that can be compiled with @option{-ansi} and the
7701 various @option{-std} options, use @code{__asm__} instead of 
7702 @code{asm} (@pxref{Alternate Keywords}).
7704 @subsubheading Qualifiers
7705 @table @code
7707 @item volatile
7708 The typical use of extended @code{asm} statements is to manipulate input 
7709 values to produce output values. However, your @code{asm} statements may 
7710 also produce side effects. If so, you may need to use the @code{volatile} 
7711 qualifier to disable certain optimizations. @xref{Volatile}.
7713 @item goto
7714 This qualifier informs the compiler that the @code{asm} statement may 
7715 perform a jump to one of the labels listed in the @var{GotoLabels}.
7716 @xref{GotoLabels}.
7717 @end table
7719 @subsubheading Parameters
7720 @table @var
7721 @item AssemblerTemplate
7722 This is a literal string that is the template for the assembler code. It is a 
7723 combination of fixed text and tokens that refer to the input, output, 
7724 and goto parameters. @xref{AssemblerTemplate}.
7726 @item OutputOperands
7727 A comma-separated list of the C variables modified by the instructions in the 
7728 @var{AssemblerTemplate}.  An empty list is permitted.  @xref{OutputOperands}.
7730 @item InputOperands
7731 A comma-separated list of C expressions read by the instructions in the 
7732 @var{AssemblerTemplate}.  An empty list is permitted.  @xref{InputOperands}.
7734 @item Clobbers
7735 A comma-separated list of registers or other values changed by the 
7736 @var{AssemblerTemplate}, beyond those listed as outputs.
7737 An empty list is permitted.  @xref{Clobbers}.
7739 @item GotoLabels
7740 When you are using the @code{goto} form of @code{asm}, this section contains 
7741 the list of all C labels to which the code in the 
7742 @var{AssemblerTemplate} may jump. 
7743 @xref{GotoLabels}.
7745 @code{asm} statements may not perform jumps into other @code{asm} statements,
7746 only to the listed @var{GotoLabels}.
7747 GCC's optimizers do not know about other jumps; therefore they cannot take 
7748 account of them when deciding how to optimize.
7749 @end table
7751 The total number of input + output + goto operands is limited to 30.
7753 @subsubheading Remarks
7754 The @code{asm} statement allows you to include assembly instructions directly 
7755 within C code. This may help you to maximize performance in time-sensitive 
7756 code or to access assembly instructions that are not readily available to C 
7757 programs.
7759 Note that extended @code{asm} statements must be inside a function. Only 
7760 basic @code{asm} may be outside functions (@pxref{Basic Asm}).
7761 Functions declared with the @code{naked} attribute also require basic 
7762 @code{asm} (@pxref{Function Attributes}).
7764 While the uses of @code{asm} are many and varied, it may help to think of an 
7765 @code{asm} statement as a series of low-level instructions that convert input 
7766 parameters to output parameters. So a simple (if not particularly useful) 
7767 example for i386 using @code{asm} might look like this:
7769 @example
7770 int src = 1;
7771 int dst;   
7773 asm ("mov %1, %0\n\t"
7774     "add $1, %0"
7775     : "=r" (dst) 
7776     : "r" (src));
7778 printf("%d\n", dst);
7779 @end example
7781 This code copies @code{src} to @code{dst} and add 1 to @code{dst}.
7783 @anchor{Volatile}
7784 @subsubsection Volatile
7785 @cindex volatile @code{asm}
7786 @cindex @code{asm} volatile
7788 GCC's optimizers sometimes discard @code{asm} statements if they determine 
7789 there is no need for the output variables. Also, the optimizers may move 
7790 code out of loops if they believe that the code will always return the same 
7791 result (i.e. none of its input values change between calls). Using the 
7792 @code{volatile} qualifier disables these optimizations. @code{asm} statements 
7793 that have no output operands, including @code{asm goto} statements, 
7794 are implicitly volatile.
7796 This i386 code demonstrates a case that does not use (or require) the 
7797 @code{volatile} qualifier. If it is performing assertion checking, this code 
7798 uses @code{asm} to perform the validation. Otherwise, @code{dwRes} is 
7799 unreferenced by any code. As a result, the optimizers can discard the 
7800 @code{asm} statement, which in turn removes the need for the entire 
7801 @code{DoCheck} routine. By omitting the @code{volatile} qualifier when it 
7802 isn't needed you allow the optimizers to produce the most efficient code 
7803 possible.
7805 @example
7806 void DoCheck(uint32_t dwSomeValue)
7808    uint32_t dwRes;
7810    // Assumes dwSomeValue is not zero.
7811    asm ("bsfl %1,%0"
7812      : "=r" (dwRes)
7813      : "r" (dwSomeValue)
7814      : "cc");
7816    assert(dwRes > 3);
7818 @end example
7820 The next example shows a case where the optimizers can recognize that the input 
7821 (@code{dwSomeValue}) never changes during the execution of the function and can 
7822 therefore move the @code{asm} outside the loop to produce more efficient code. 
7823 Again, using @code{volatile} disables this type of optimization.
7825 @example
7826 void do_print(uint32_t dwSomeValue)
7828    uint32_t dwRes;
7830    for (uint32_t x=0; x < 5; x++)
7831    @{
7832       // Assumes dwSomeValue is not zero.
7833       asm ("bsfl %1,%0"
7834         : "=r" (dwRes)
7835         : "r" (dwSomeValue)
7836         : "cc");
7838       printf("%u: %u %u\n", x, dwSomeValue, dwRes);
7839    @}
7841 @end example
7843 The following example demonstrates a case where you need to use the 
7844 @code{volatile} qualifier. 
7845 It uses the x86 @code{rdtsc} instruction, which reads 
7846 the computer's time-stamp counter. Without the @code{volatile} qualifier, 
7847 the optimizers might assume that the @code{asm} block will always return the 
7848 same value and therefore optimize away the second call.
7850 @example
7851 uint64_t msr;
7853 asm volatile ( "rdtsc\n\t"    // Returns the time in EDX:EAX.
7854         "shl $32, %%rdx\n\t"  // Shift the upper bits left.
7855         "or %%rdx, %0"        // 'Or' in the lower bits.
7856         : "=a" (msr)
7857         : 
7858         : "rdx");
7860 printf("msr: %llx\n", msr);
7862 // Do other work...
7864 // Reprint the timestamp
7865 asm volatile ( "rdtsc\n\t"    // Returns the time in EDX:EAX.
7866         "shl $32, %%rdx\n\t"  // Shift the upper bits left.
7867         "or %%rdx, %0"        // 'Or' in the lower bits.
7868         : "=a" (msr)
7869         : 
7870         : "rdx");
7872 printf("msr: %llx\n", msr);
7873 @end example
7875 GCC's optimizers do not treat this code like the non-volatile code in the 
7876 earlier examples. They do not move it out of loops or omit it on the 
7877 assumption that the result from a previous call is still valid.
7879 Note that the compiler can move even volatile @code{asm} instructions relative 
7880 to other code, including across jump instructions. For example, on many 
7881 targets there is a system register that controls the rounding mode of 
7882 floating-point operations. Setting it with a volatile @code{asm}, as in the 
7883 following PowerPC example, does not work reliably.
7885 @example
7886 asm volatile("mtfsf 255, %0" : : "f" (fpenv));
7887 sum = x + y;
7888 @end example
7890 The compiler may move the addition back before the volatile @code{asm}. To 
7891 make it work as expected, add an artificial dependency to the @code{asm} by 
7892 referencing a variable in the subsequent code, for example: 
7894 @example
7895 asm volatile ("mtfsf 255,%1" : "=X" (sum) : "f" (fpenv));
7896 sum = x + y;
7897 @end example
7899 Under certain circumstances, GCC may duplicate (or remove duplicates of) your 
7900 assembly code when optimizing. This can lead to unexpected duplicate symbol 
7901 errors during compilation if your asm code defines symbols or labels. 
7902 Using @samp{%=} 
7903 (@pxref{AssemblerTemplate}) may help resolve this problem.
7905 @anchor{AssemblerTemplate}
7906 @subsubsection Assembler Template
7907 @cindex @code{asm} assembler template
7909 An assembler template is a literal string containing assembler instructions.
7910 The compiler replaces tokens in the template that refer 
7911 to inputs, outputs, and goto labels,
7912 and then outputs the resulting string to the assembler. The 
7913 string can contain any instructions recognized by the assembler, including 
7914 directives. GCC does not parse the assembler instructions 
7915 themselves and does not know what they mean or even whether they are valid 
7916 assembler input. However, it does count the statements 
7917 (@pxref{Size of an asm}).
7919 You may place multiple assembler instructions together in a single @code{asm} 
7920 string, separated by the characters normally used in assembly code for the 
7921 system. A combination that works in most places is a newline to break the 
7922 line, plus a tab character to move to the instruction field (written as 
7923 @samp{\n\t}). 
7924 Some assemblers allow semicolons as a line separator. However, note 
7925 that some assembler dialects use semicolons to start a comment. 
7927 Do not expect a sequence of @code{asm} statements to remain perfectly 
7928 consecutive after compilation, even when you are using the @code{volatile} 
7929 qualifier. If certain instructions need to remain consecutive in the output, 
7930 put them in a single multi-instruction asm statement.
7932 Accessing data from C programs without using input/output operands (such as 
7933 by using global symbols directly from the assembler template) may not work as 
7934 expected. Similarly, calling functions directly from an assembler template 
7935 requires a detailed understanding of the target assembler and ABI.
7937 Since GCC does not parse the assembler template,
7938 it has no visibility of any 
7939 symbols it references. This may result in GCC discarding those symbols as 
7940 unreferenced unless they are also listed as input, output, or goto operands.
7942 @subsubheading Special format strings
7944 In addition to the tokens described by the input, output, and goto operands, 
7945 these tokens have special meanings in the assembler template:
7947 @table @samp
7948 @item %% 
7949 Outputs a single @samp{%} into the assembler code.
7951 @item %= 
7952 Outputs a number that is unique to each instance of the @code{asm} 
7953 statement in the entire compilation. This option is useful when creating local 
7954 labels and referring to them multiple times in a single template that 
7955 generates multiple assembler instructions. 
7957 @item %@{
7958 @itemx %|
7959 @itemx %@}
7960 Outputs @samp{@{}, @samp{|}, and @samp{@}} characters (respectively)
7961 into the assembler code.  When unescaped, these characters have special
7962 meaning to indicate multiple assembler dialects, as described below.
7963 @end table
7965 @subsubheading Multiple assembler dialects in @code{asm} templates
7967 On targets such as x86, GCC supports multiple assembler dialects.
7968 The @option{-masm} option controls which dialect GCC uses as its 
7969 default for inline assembler. The target-specific documentation for the 
7970 @option{-masm} option contains the list of supported dialects, as well as the 
7971 default dialect if the option is not specified. This information may be 
7972 important to understand, since assembler code that works correctly when 
7973 compiled using one dialect will likely fail if compiled using another.
7974 @xref{x86 Options}.
7976 If your code needs to support multiple assembler dialects (for example, if 
7977 you are writing public headers that need to support a variety of compilation 
7978 options), use constructs of this form:
7980 @example
7981 @{ dialect0 | dialect1 | dialect2... @}
7982 @end example
7984 This construct outputs @code{dialect0} 
7985 when using dialect #0 to compile the code, 
7986 @code{dialect1} for dialect #1, etc. If there are fewer alternatives within the 
7987 braces than the number of dialects the compiler supports, the construct 
7988 outputs nothing.
7990 For example, if an x86 compiler supports two dialects
7991 (@samp{att}, @samp{intel}), an 
7992 assembler template such as this:
7994 @example
7995 "bt@{l %[Offset],%[Base] | %[Base],%[Offset]@}; jc %l2"
7996 @end example
7998 @noindent
7999 is equivalent to one of
8001 @example
8002 "btl %[Offset],%[Base] ; jc %l2"   @r{/* att dialect */}
8003 "bt %[Base],%[Offset]; jc %l2"     @r{/* intel dialect */}
8004 @end example
8006 Using that same compiler, this code:
8008 @example
8009 "xchg@{l@}\t@{%%@}ebx, %1"
8010 @end example
8012 @noindent
8013 corresponds to either
8015 @example
8016 "xchgl\t%%ebx, %1"                 @r{/* att dialect */}
8017 "xchg\tebx, %1"                    @r{/* intel dialect */}
8018 @end example
8020 There is no support for nesting dialect alternatives.
8022 @anchor{OutputOperands}
8023 @subsubsection Output Operands
8024 @cindex @code{asm} output operands
8026 An @code{asm} statement has zero or more output operands indicating the names
8027 of C variables modified by the assembler code.
8029 In this i386 example, @code{old} (referred to in the template string as 
8030 @code{%0}) and @code{*Base} (as @code{%1}) are outputs and @code{Offset} 
8031 (@code{%2}) is an input:
8033 @example
8034 bool old;
8036 __asm__ ("btsl %2,%1\n\t" // Turn on zero-based bit #Offset in Base.
8037          "sbb %0,%0"      // Use the CF to calculate old.
8038    : "=r" (old), "+rm" (*Base)
8039    : "Ir" (Offset)
8040    : "cc");
8042 return old;
8043 @end example
8045 Operands are separated by commas.  Each operand has this format:
8047 @example
8048 @r{[} [@var{asmSymbolicName}] @r{]} @var{constraint} (@var{cvariablename})
8049 @end example
8051 @table @var
8052 @item asmSymbolicName
8053 Specifies a symbolic name for the operand.
8054 Reference the name in the assembler template 
8055 by enclosing it in square brackets 
8056 (i.e. @samp{%[Value]}). The scope of the name is the @code{asm} statement 
8057 that contains the definition. Any valid C variable name is acceptable, 
8058 including names already defined in the surrounding code. No two operands 
8059 within the same @code{asm} statement can use the same symbolic name.
8061 When not using an @var{asmSymbolicName}, use the (zero-based) position
8062 of the operand 
8063 in the list of operands in the assembler template. For example if there are 
8064 three output operands, use @samp{%0} in the template to refer to the first, 
8065 @samp{%1} for the second, and @samp{%2} for the third. 
8067 @item constraint
8068 A string constant specifying constraints on the placement of the operand; 
8069 @xref{Constraints}, for details.
8071 Output constraints must begin with either @samp{=} (a variable overwriting an 
8072 existing value) or @samp{+} (when reading and writing). When using 
8073 @samp{=}, do not assume the location contains the existing value
8074 on entry to the @code{asm}, except 
8075 when the operand is tied to an input; @pxref{InputOperands,,Input Operands}.
8077 After the prefix, there must be one or more additional constraints 
8078 (@pxref{Constraints}) that describe where the value resides. Common 
8079 constraints include @samp{r} for register and @samp{m} for memory. 
8080 When you list more than one possible location (for example, @code{"=rm"}),
8081 the compiler chooses the most efficient one based on the current context. 
8082 If you list as many alternates as the @code{asm} statement allows, you permit 
8083 the optimizers to produce the best possible code. 
8084 If you must use a specific register, but your Machine Constraints do not
8085 provide sufficient control to select the specific register you want, 
8086 local register variables may provide a solution (@pxref{Local Register 
8087 Variables}).
8089 @item cvariablename
8090 Specifies a C lvalue expression to hold the output, typically a variable name.
8091 The enclosing parentheses are a required part of the syntax.
8093 @end table
8095 When the compiler selects the registers to use to 
8096 represent the output operands, it does not use any of the clobbered registers 
8097 (@pxref{Clobbers}).
8099 Output operand expressions must be lvalues. The compiler cannot check whether 
8100 the operands have data types that are reasonable for the instruction being 
8101 executed. For output expressions that are not directly addressable (for 
8102 example a bit-field), the constraint must allow a register. In that case, GCC 
8103 uses the register as the output of the @code{asm}, and then stores that 
8104 register into the output. 
8106 Operands using the @samp{+} constraint modifier count as two operands 
8107 (that is, both as input and output) towards the total maximum of 30 operands
8108 per @code{asm} statement.
8110 Use the @samp{&} constraint modifier (@pxref{Modifiers}) on all output
8111 operands that must not overlap an input.  Otherwise, 
8112 GCC may allocate the output operand in the same register as an unrelated 
8113 input operand, on the assumption that the assembler code consumes its 
8114 inputs before producing outputs. This assumption may be false if the assembler 
8115 code actually consists of more than one instruction.
8117 The same problem can occur if one output parameter (@var{a}) allows a register 
8118 constraint and another output parameter (@var{b}) allows a memory constraint.
8119 The code generated by GCC to access the memory address in @var{b} can contain
8120 registers which @emph{might} be shared by @var{a}, and GCC considers those 
8121 registers to be inputs to the asm. As above, GCC assumes that such input
8122 registers are consumed before any outputs are written. This assumption may 
8123 result in incorrect behavior if the asm writes to @var{a} before using 
8124 @var{b}. Combining the @samp{&} modifier with the register constraint on @var{a}
8125 ensures that modifying @var{a} does not affect the address referenced by 
8126 @var{b}. Otherwise, the location of @var{b} 
8127 is undefined if @var{a} is modified before using @var{b}.
8129 @code{asm} supports operand modifiers on operands (for example @samp{%k2} 
8130 instead of simply @samp{%2}). Typically these qualifiers are hardware 
8131 dependent. The list of supported modifiers for x86 is found at 
8132 @ref{x86Operandmodifiers,x86 Operand modifiers}.
8134 If the C code that follows the @code{asm} makes no use of any of the output 
8135 operands, use @code{volatile} for the @code{asm} statement to prevent the 
8136 optimizers from discarding the @code{asm} statement as unneeded 
8137 (see @ref{Volatile}).
8139 This code makes no use of the optional @var{asmSymbolicName}. Therefore it 
8140 references the first output operand as @code{%0} (were there a second, it 
8141 would be @code{%1}, etc). The number of the first input operand is one greater 
8142 than that of the last output operand. In this i386 example, that makes 
8143 @code{Mask} referenced as @code{%1}:
8145 @example
8146 uint32_t Mask = 1234;
8147 uint32_t Index;
8149   asm ("bsfl %1, %0"
8150      : "=r" (Index)
8151      : "r" (Mask)
8152      : "cc");
8153 @end example
8155 That code overwrites the variable @code{Index} (@samp{=}),
8156 placing the value in a register (@samp{r}).
8157 Using the generic @samp{r} constraint instead of a constraint for a specific 
8158 register allows the compiler to pick the register to use, which can result 
8159 in more efficient code. This may not be possible if an assembler instruction 
8160 requires a specific register.
8162 The following i386 example uses the @var{asmSymbolicName} syntax.
8163 It produces the 
8164 same result as the code above, but some may consider it more readable or more 
8165 maintainable since reordering index numbers is not necessary when adding or 
8166 removing operands. The names @code{aIndex} and @code{aMask}
8167 are only used in this example to emphasize which 
8168 names get used where.
8169 It is acceptable to reuse the names @code{Index} and @code{Mask}.
8171 @example
8172 uint32_t Mask = 1234;
8173 uint32_t Index;
8175   asm ("bsfl %[aMask], %[aIndex]"
8176      : [aIndex] "=r" (Index)
8177      : [aMask] "r" (Mask)
8178      : "cc");
8179 @end example
8181 Here are some more examples of output operands.
8183 @example
8184 uint32_t c = 1;
8185 uint32_t d;
8186 uint32_t *e = &c;
8188 asm ("mov %[e], %[d]"
8189    : [d] "=rm" (d)
8190    : [e] "rm" (*e));
8191 @end example
8193 Here, @code{d} may either be in a register or in memory. Since the compiler 
8194 might already have the current value of the @code{uint32_t} location
8195 pointed to by @code{e}
8196 in a register, you can enable it to choose the best location
8197 for @code{d} by specifying both constraints.
8199 @anchor{FlagOutputOperands}
8200 @subsubsection Flag Output Operands
8201 @cindex @code{asm} flag output operands
8203 Some targets have a special register that holds the ``flags'' for the
8204 result of an operation or comparison.  Normally, the contents of that
8205 register are either unmodifed by the asm, or the asm is considered to
8206 clobber the contents.
8208 On some targets, a special form of output operand exists by which
8209 conditions in the flags register may be outputs of the asm.  The set of
8210 conditions supported are target specific, but the general rule is that
8211 the output variable must be a scalar integer, and the value is boolean.
8212 When supported, the target defines the preprocessor symbol
8213 @code{__GCC_ASM_FLAG_OUTPUTS__}.
8215 Because of the special nature of the flag output operands, the constraint
8216 may not include alternatives.
8218 Most often, the target has only one flags register, and thus is an implied
8219 operand of many instructions.  In this case, the operand should not be
8220 referenced within the assembler template via @code{%0} etc, as there's
8221 no corresponding text in the assembly language.
8223 @table @asis
8224 @item x86 family
8225 The flag output constraints for the x86 family are of the form
8226 @samp{=@@cc@var{cond}} where @var{cond} is one of the standard
8227 conditions defined in the ISA manual for @code{j@var{cc}} or
8228 @code{set@var{cc}}.
8230 @table @code
8231 @item a
8232 ``above'' or unsigned greater than
8233 @item ae
8234 ``above or equal'' or unsigned greater than or equal
8235 @item b
8236 ``below'' or unsigned less than
8237 @item be
8238 ``below or equal'' or unsigned less than or equal
8239 @item c
8240 carry flag set
8241 @item e
8242 @itemx z
8243 ``equal'' or zero flag set
8244 @item g
8245 signed greater than
8246 @item ge
8247 signed greater than or equal
8248 @item l
8249 signed less than
8250 @item le
8251 signed less than or equal
8252 @item o
8253 overflow flag set
8254 @item p
8255 parity flag set
8256 @item s
8257 sign flag set
8258 @item na
8259 @itemx nae
8260 @itemx nb
8261 @itemx nbe
8262 @itemx nc
8263 @itemx ne
8264 @itemx ng
8265 @itemx nge
8266 @itemx nl
8267 @itemx nle
8268 @itemx no
8269 @itemx np
8270 @itemx ns
8271 @itemx nz
8272 ``not'' @var{flag}, or inverted versions of those above
8273 @end table
8275 @end table
8277 @anchor{InputOperands}
8278 @subsubsection Input Operands
8279 @cindex @code{asm} input operands
8280 @cindex @code{asm} expressions
8282 Input operands make values from C variables and expressions available to the 
8283 assembly code.
8285 Operands are separated by commas.  Each operand has this format:
8287 @example
8288 @r{[} [@var{asmSymbolicName}] @r{]} @var{constraint} (@var{cexpression})
8289 @end example
8291 @table @var
8292 @item asmSymbolicName
8293 Specifies a symbolic name for the operand.
8294 Reference the name in the assembler template 
8295 by enclosing it in square brackets 
8296 (i.e. @samp{%[Value]}). The scope of the name is the @code{asm} statement 
8297 that contains the definition. Any valid C variable name is acceptable, 
8298 including names already defined in the surrounding code. No two operands 
8299 within the same @code{asm} statement can use the same symbolic name.
8301 When not using an @var{asmSymbolicName}, use the (zero-based) position
8302 of the operand 
8303 in the list of operands in the assembler template. For example if there are
8304 two output operands and three inputs,
8305 use @samp{%2} in the template to refer to the first input operand,
8306 @samp{%3} for the second, and @samp{%4} for the third. 
8308 @item constraint
8309 A string constant specifying constraints on the placement of the operand; 
8310 @xref{Constraints}, for details.
8312 Input constraint strings may not begin with either @samp{=} or @samp{+}.
8313 When you list more than one possible location (for example, @samp{"irm"}), 
8314 the compiler chooses the most efficient one based on the current context.
8315 If you must use a specific register, but your Machine Constraints do not
8316 provide sufficient control to select the specific register you want, 
8317 local register variables may provide a solution (@pxref{Local Register 
8318 Variables}).
8320 Input constraints can also be digits (for example, @code{"0"}). This indicates 
8321 that the specified input must be in the same place as the output constraint 
8322 at the (zero-based) index in the output constraint list. 
8323 When using @var{asmSymbolicName} syntax for the output operands,
8324 you may use these names (enclosed in brackets @samp{[]}) instead of digits.
8326 @item cexpression
8327 This is the C variable or expression being passed to the @code{asm} statement 
8328 as input.  The enclosing parentheses are a required part of the syntax.
8330 @end table
8332 When the compiler selects the registers to use to represent the input 
8333 operands, it does not use any of the clobbered registers (@pxref{Clobbers}).
8335 If there are no output operands but there are input operands, place two 
8336 consecutive colons where the output operands would go:
8338 @example
8339 __asm__ ("some instructions"
8340    : /* No outputs. */
8341    : "r" (Offset / 8));
8342 @end example
8344 @strong{Warning:} Do @emph{not} modify the contents of input-only operands 
8345 (except for inputs tied to outputs). The compiler assumes that on exit from 
8346 the @code{asm} statement these operands contain the same values as they 
8347 had before executing the statement. 
8348 It is @emph{not} possible to use clobbers
8349 to inform the compiler that the values in these inputs are changing. One 
8350 common work-around is to tie the changing input variable to an output variable 
8351 that never gets used. Note, however, that if the code that follows the 
8352 @code{asm} statement makes no use of any of the output operands, the GCC 
8353 optimizers may discard the @code{asm} statement as unneeded 
8354 (see @ref{Volatile}).
8356 @code{asm} supports operand modifiers on operands (for example @samp{%k2} 
8357 instead of simply @samp{%2}). Typically these qualifiers are hardware 
8358 dependent. The list of supported modifiers for x86 is found at 
8359 @ref{x86Operandmodifiers,x86 Operand modifiers}.
8361 In this example using the fictitious @code{combine} instruction, the 
8362 constraint @code{"0"} for input operand 1 says that it must occupy the same 
8363 location as output operand 0. Only input operands may use numbers in 
8364 constraints, and they must each refer to an output operand. Only a number (or 
8365 the symbolic assembler name) in the constraint can guarantee that one operand 
8366 is in the same place as another. The mere fact that @code{foo} is the value of 
8367 both operands is not enough to guarantee that they are in the same place in 
8368 the generated assembler code.
8370 @example
8371 asm ("combine %2, %0" 
8372    : "=r" (foo) 
8373    : "0" (foo), "g" (bar));
8374 @end example
8376 Here is an example using symbolic names.
8378 @example
8379 asm ("cmoveq %1, %2, %[result]" 
8380    : [result] "=r"(result) 
8381    : "r" (test), "r" (new), "[result]" (old));
8382 @end example
8384 @anchor{Clobbers}
8385 @subsubsection Clobbers
8386 @cindex @code{asm} clobbers
8388 While the compiler is aware of changes to entries listed in the output 
8389 operands, the inline @code{asm} code may modify more than just the outputs. For 
8390 example, calculations may require additional registers, or the processor may 
8391 overwrite a register as a side effect of a particular assembler instruction. 
8392 In order to inform the compiler of these changes, list them in the clobber 
8393 list. Clobber list items are either register names or the special clobbers 
8394 (listed below). Each clobber list item is a string constant 
8395 enclosed in double quotes and separated by commas.
8397 Clobber descriptions may not in any way overlap with an input or output 
8398 operand. For example, you may not have an operand describing a register class 
8399 with one member when listing that register in the clobber list. Variables 
8400 declared to live in specific registers (@pxref{Explicit Register 
8401 Variables}) and used 
8402 as @code{asm} input or output operands must have no part mentioned in the 
8403 clobber description. In particular, there is no way to specify that input 
8404 operands get modified without also specifying them as output operands.
8406 When the compiler selects which registers to use to represent input and output 
8407 operands, it does not use any of the clobbered registers. As a result, 
8408 clobbered registers are available for any use in the assembler code.
8410 Here is a realistic example for the VAX showing the use of clobbered 
8411 registers: 
8413 @example
8414 asm volatile ("movc3 %0, %1, %2"
8415                    : /* No outputs. */
8416                    : "g" (from), "g" (to), "g" (count)
8417                    : "r0", "r1", "r2", "r3", "r4", "r5");
8418 @end example
8420 Also, there are two special clobber arguments:
8422 @table @code
8423 @item "cc"
8424 The @code{"cc"} clobber indicates that the assembler code modifies the flags 
8425 register. On some machines, GCC represents the condition codes as a specific 
8426 hardware register; @code{"cc"} serves to name this register.
8427 On other machines, condition code handling is different, 
8428 and specifying @code{"cc"} has no effect. But 
8429 it is valid no matter what the target.
8431 @item "memory"
8432 The @code{"memory"} clobber tells the compiler that the assembly code
8433 performs memory 
8434 reads or writes to items other than those listed in the input and output 
8435 operands (for example, accessing the memory pointed to by one of the input 
8436 parameters). To ensure memory contains correct values, GCC may need to flush 
8437 specific register values to memory before executing the @code{asm}. Further, 
8438 the compiler does not assume that any values read from memory before an 
8439 @code{asm} remain unchanged after that @code{asm}; it reloads them as 
8440 needed.  
8441 Using the @code{"memory"} clobber effectively forms a read/write
8442 memory barrier for the compiler.
8444 Note that this clobber does not prevent the @emph{processor} from doing 
8445 speculative reads past the @code{asm} statement. To prevent that, you need 
8446 processor-specific fence instructions.
8448 Flushing registers to memory has performance implications and may be an issue 
8449 for time-sensitive code.  You can use a trick to avoid this if the size of 
8450 the memory being accessed is known at compile time. For example, if accessing 
8451 ten bytes of a string, use a memory input like: 
8453 @code{@{"m"( (@{ struct @{ char x[10]; @} *p = (void *)ptr ; *p; @}) )@}}.
8455 @end table
8457 @anchor{GotoLabels}
8458 @subsubsection Goto Labels
8459 @cindex @code{asm} goto labels
8461 @code{asm goto} allows assembly code to jump to one or more C labels.  The
8462 @var{GotoLabels} section in an @code{asm goto} statement contains 
8463 a comma-separated 
8464 list of all C labels to which the assembler code may jump. GCC assumes that 
8465 @code{asm} execution falls through to the next statement (if this is not the 
8466 case, consider using the @code{__builtin_unreachable} intrinsic after the 
8467 @code{asm} statement). Optimization of @code{asm goto} may be improved by 
8468 using the @code{hot} and @code{cold} label attributes (@pxref{Label 
8469 Attributes}).
8471 An @code{asm goto} statement cannot have outputs.
8472 This is due to an internal restriction of 
8473 the compiler: control transfer instructions cannot have outputs. 
8474 If the assembler code does modify anything, use the @code{"memory"} clobber 
8475 to force the 
8476 optimizers to flush all register values to memory and reload them if 
8477 necessary after the @code{asm} statement.
8479 Also note that an @code{asm goto} statement is always implicitly
8480 considered volatile.
8482 To reference a label in the assembler template,
8483 prefix it with @samp{%l} (lowercase @samp{L}) followed 
8484 by its (zero-based) position in @var{GotoLabels} plus the number of input 
8485 operands.  For example, if the @code{asm} has three inputs and references two 
8486 labels, refer to the first label as @samp{%l3} and the second as @samp{%l4}).
8488 Alternately, you can reference labels using the actual C label name enclosed
8489 in brackets.  For example, to reference a label named @code{carry}, you can
8490 use @samp{%l[carry]}.  The label must still be listed in the @var{GotoLabels}
8491 section when using this approach.
8493 Here is an example of @code{asm goto} for i386:
8495 @example
8496 asm goto (
8497     "btl %1, %0\n\t"
8498     "jc %l2"
8499     : /* No outputs. */
8500     : "r" (p1), "r" (p2) 
8501     : "cc" 
8502     : carry);
8504 return 0;
8506 carry:
8507 return 1;
8508 @end example
8510 The following example shows an @code{asm goto} that uses a memory clobber.
8512 @example
8513 int frob(int x)
8515   int y;
8516   asm goto ("frob %%r5, %1; jc %l[error]; mov (%2), %%r5"
8517             : /* No outputs. */
8518             : "r"(x), "r"(&y)
8519             : "r5", "memory" 
8520             : error);
8521   return y;
8522 error:
8523   return -1;
8525 @end example
8527 @anchor{x86Operandmodifiers}
8528 @subsubsection x86 Operand Modifiers
8530 References to input, output, and goto operands in the assembler template
8531 of extended @code{asm} statements can use 
8532 modifiers to affect the way the operands are formatted in 
8533 the code output to the assembler. For example, the 
8534 following code uses the @samp{h} and @samp{b} modifiers for x86:
8536 @example
8537 uint16_t  num;
8538 asm volatile ("xchg %h0, %b0" : "+a" (num) );
8539 @end example
8541 @noindent
8542 These modifiers generate this assembler code:
8544 @example
8545 xchg %ah, %al
8546 @end example
8548 The rest of this discussion uses the following code for illustrative purposes.
8550 @example
8551 int main()
8553    int iInt = 1;
8555 top:
8557    asm volatile goto ("some assembler instructions here"
8558    : /* No outputs. */
8559    : "q" (iInt), "X" (sizeof(unsigned char) + 1)
8560    : /* No clobbers. */
8561    : top);
8563 @end example
8565 With no modifiers, this is what the output from the operands would be for the 
8566 @samp{att} and @samp{intel} dialects of assembler:
8568 @multitable {Operand} {masm=att} {OFFSET FLAT:.L2}
8569 @headitem Operand @tab masm=att @tab masm=intel
8570 @item @code{%0}
8571 @tab @code{%eax}
8572 @tab @code{eax}
8573 @item @code{%1}
8574 @tab @code{$2}
8575 @tab @code{2}
8576 @item @code{%2}
8577 @tab @code{$.L2}
8578 @tab @code{OFFSET FLAT:.L2}
8579 @end multitable
8581 The table below shows the list of supported modifiers and their effects.
8583 @multitable {Modifier} {Print the opcode suffix for the size of th} {Operand} {masm=att} {masm=intel}
8584 @headitem Modifier @tab Description @tab Operand @tab @option{masm=att} @tab @option{masm=intel}
8585 @item @code{z}
8586 @tab Print the opcode suffix for the size of the current integer operand (one of @code{b}/@code{w}/@code{l}/@code{q}).
8587 @tab @code{%z0}
8588 @tab @code{l}
8589 @tab 
8590 @item @code{b}
8591 @tab Print the QImode name of the register.
8592 @tab @code{%b0}
8593 @tab @code{%al}
8594 @tab @code{al}
8595 @item @code{h}
8596 @tab Print the QImode name for a ``high'' register.
8597 @tab @code{%h0}
8598 @tab @code{%ah}
8599 @tab @code{ah}
8600 @item @code{w}
8601 @tab Print the HImode name of the register.
8602 @tab @code{%w0}
8603 @tab @code{%ax}
8604 @tab @code{ax}
8605 @item @code{k}
8606 @tab Print the SImode name of the register.
8607 @tab @code{%k0}
8608 @tab @code{%eax}
8609 @tab @code{eax}
8610 @item @code{q}
8611 @tab Print the DImode name of the register.
8612 @tab @code{%q0}
8613 @tab @code{%rax}
8614 @tab @code{rax}
8615 @item @code{l}
8616 @tab Print the label name with no punctuation.
8617 @tab @code{%l2}
8618 @tab @code{.L2}
8619 @tab @code{.L2}
8620 @item @code{c}
8621 @tab Require a constant operand and print the constant expression with no punctuation.
8622 @tab @code{%c1}
8623 @tab @code{2}
8624 @tab @code{2}
8625 @end multitable
8627 @anchor{x86floatingpointasmoperands}
8628 @subsubsection x86 Floating-Point @code{asm} Operands
8630 On x86 targets, there are several rules on the usage of stack-like registers
8631 in the operands of an @code{asm}.  These rules apply only to the operands
8632 that are stack-like registers:
8634 @enumerate
8635 @item
8636 Given a set of input registers that die in an @code{asm}, it is
8637 necessary to know which are implicitly popped by the @code{asm}, and
8638 which must be explicitly popped by GCC@.
8640 An input register that is implicitly popped by the @code{asm} must be
8641 explicitly clobbered, unless it is constrained to match an
8642 output operand.
8644 @item
8645 For any input register that is implicitly popped by an @code{asm}, it is
8646 necessary to know how to adjust the stack to compensate for the pop.
8647 If any non-popped input is closer to the top of the reg-stack than
8648 the implicitly popped register, it would not be possible to know what the
8649 stack looked like---it's not clear how the rest of the stack ``slides
8650 up''.
8652 All implicitly popped input registers must be closer to the top of
8653 the reg-stack than any input that is not implicitly popped.
8655 It is possible that if an input dies in an @code{asm}, the compiler might
8656 use the input register for an output reload.  Consider this example:
8658 @smallexample
8659 asm ("foo" : "=t" (a) : "f" (b));
8660 @end smallexample
8662 @noindent
8663 This code says that input @code{b} is not popped by the @code{asm}, and that
8664 the @code{asm} pushes a result onto the reg-stack, i.e., the stack is one
8665 deeper after the @code{asm} than it was before.  But, it is possible that
8666 reload may think that it can use the same register for both the input and
8667 the output.
8669 To prevent this from happening,
8670 if any input operand uses the @samp{f} constraint, all output register
8671 constraints must use the @samp{&} early-clobber modifier.
8673 The example above is correctly written as:
8675 @smallexample
8676 asm ("foo" : "=&t" (a) : "f" (b));
8677 @end smallexample
8679 @item
8680 Some operands need to be in particular places on the stack.  All
8681 output operands fall in this category---GCC has no other way to
8682 know which registers the outputs appear in unless you indicate
8683 this in the constraints.
8685 Output operands must specifically indicate which register an output
8686 appears in after an @code{asm}.  @samp{=f} is not allowed: the operand
8687 constraints must select a class with a single register.
8689 @item
8690 Output operands may not be ``inserted'' between existing stack registers.
8691 Since no 387 opcode uses a read/write operand, all output operands
8692 are dead before the @code{asm}, and are pushed by the @code{asm}.
8693 It makes no sense to push anywhere but the top of the reg-stack.
8695 Output operands must start at the top of the reg-stack: output
8696 operands may not ``skip'' a register.
8698 @item
8699 Some @code{asm} statements may need extra stack space for internal
8700 calculations.  This can be guaranteed by clobbering stack registers
8701 unrelated to the inputs and outputs.
8703 @end enumerate
8705 This @code{asm}
8706 takes one input, which is internally popped, and produces two outputs.
8708 @smallexample
8709 asm ("fsincos" : "=t" (cos), "=u" (sin) : "0" (inp));
8710 @end smallexample
8712 @noindent
8713 This @code{asm} takes two inputs, which are popped by the @code{fyl2xp1} opcode,
8714 and replaces them with one output.  The @code{st(1)} clobber is necessary 
8715 for the compiler to know that @code{fyl2xp1} pops both inputs.
8717 @smallexample
8718 asm ("fyl2xp1" : "=t" (result) : "0" (x), "u" (y) : "st(1)");
8719 @end smallexample
8721 @lowersections
8722 @include md.texi
8723 @raisesections
8725 @node Asm Labels
8726 @subsection Controlling Names Used in Assembler Code
8727 @cindex assembler names for identifiers
8728 @cindex names used in assembler code
8729 @cindex identifiers, names in assembler code
8731 You can specify the name to be used in the assembler code for a C
8732 function or variable by writing the @code{asm} (or @code{__asm__})
8733 keyword after the declarator.
8734 It is up to you to make sure that the assembler names you choose do not
8735 conflict with any other assembler symbols, or reference registers.
8737 @subsubheading Assembler names for data:
8739 This sample shows how to specify the assembler name for data:
8741 @smallexample
8742 int foo asm ("myfoo") = 2;
8743 @end smallexample
8745 @noindent
8746 This specifies that the name to be used for the variable @code{foo} in
8747 the assembler code should be @samp{myfoo} rather than the usual
8748 @samp{_foo}.
8750 On systems where an underscore is normally prepended to the name of a C
8751 variable, this feature allows you to define names for the
8752 linker that do not start with an underscore.
8754 GCC does not support using this feature with a non-static local variable 
8755 since such variables do not have assembler names.  If you are
8756 trying to put the variable in a particular register, see 
8757 @ref{Explicit Register Variables}.
8759 @subsubheading Assembler names for functions:
8761 To specify the assembler name for functions, write a declaration for the 
8762 function before its definition and put @code{asm} there, like this:
8764 @smallexample
8765 int func (int x, int y) asm ("MYFUNC");
8766      
8767 int func (int x, int y)
8769    /* @r{@dots{}} */
8770 @end smallexample
8772 @noindent
8773 This specifies that the name to be used for the function @code{func} in
8774 the assembler code should be @code{MYFUNC}.
8776 @node Explicit Register Variables
8777 @subsection Variables in Specified Registers
8778 @anchor{Explicit Reg Vars}
8779 @cindex explicit register variables
8780 @cindex variables in specified registers
8781 @cindex specified registers
8783 GNU C allows you to associate specific hardware registers with C 
8784 variables.  In almost all cases, allowing the compiler to assign
8785 registers produces the best code.  However under certain unusual
8786 circumstances, more precise control over the variable storage is 
8787 required.
8789 Both global and local variables can be associated with a register.  The
8790 consequences of performing this association are very different between
8791 the two, as explained in the sections below.
8793 @menu
8794 * Global Register Variables::   Variables declared at global scope.
8795 * Local Register Variables::    Variables declared within a function.
8796 @end menu
8798 @node Global Register Variables
8799 @subsubsection Defining Global Register Variables
8800 @anchor{Global Reg Vars}
8801 @cindex global register variables
8802 @cindex registers, global variables in
8803 @cindex registers, global allocation
8805 You can define a global register variable and associate it with a specified 
8806 register like this:
8808 @smallexample
8809 register int *foo asm ("r12");
8810 @end smallexample
8812 @noindent
8813 Here @code{r12} is the name of the register that should be used. Note that 
8814 this is the same syntax used for defining local register variables, but for 
8815 a global variable the declaration appears outside a function. The 
8816 @code{register} keyword is required, and cannot be combined with 
8817 @code{static}. The register name must be a valid register name for the
8818 target platform.
8820 Registers are a scarce resource on most systems and allowing the 
8821 compiler to manage their usage usually results in the best code. However, 
8822 under special circumstances it can make sense to reserve some globally.
8823 For example this may be useful in programs such as programming language 
8824 interpreters that have a couple of global variables that are accessed 
8825 very often.
8827 After defining a global register variable, for the current compilation
8828 unit:
8830 @itemize @bullet
8831 @item The register is reserved entirely for this use, and will not be 
8832 allocated for any other purpose.
8833 @item The register is not saved and restored by any functions.
8834 @item Stores into this register are never deleted even if they appear to be 
8835 dead, but references may be deleted, moved or simplified.
8836 @end itemize
8838 Note that these points @emph{only} apply to code that is compiled with the
8839 definition. The behavior of code that is merely linked in (for example 
8840 code from libraries) is not affected.
8842 If you want to recompile source files that do not actually use your global 
8843 register variable so they do not use the specified register for any other 
8844 purpose, you need not actually add the global register declaration to 
8845 their source code. It suffices to specify the compiler option 
8846 @option{-ffixed-@var{reg}} (@pxref{Code Gen Options}) to reserve the 
8847 register.
8849 @subsubheading Declaring the variable
8851 Global register variables can not have initial values, because an
8852 executable file has no means to supply initial contents for a register.
8854 When selecting a register, choose one that is normally saved and 
8855 restored by function calls on your machine. This ensures that code
8856 which is unaware of this reservation (such as library routines) will 
8857 restore it before returning.
8859 On machines with register windows, be sure to choose a global
8860 register that is not affected magically by the function call mechanism.
8862 @subsubheading Using the variable
8864 @cindex @code{qsort}, and global register variables
8865 When calling routines that are not aware of the reservation, be 
8866 cautious if those routines call back into code which uses them. As an 
8867 example, if you call the system library version of @code{qsort}, it may 
8868 clobber your registers during execution, but (if you have selected 
8869 appropriate registers) it will restore them before returning. However 
8870 it will @emph{not} restore them before calling @code{qsort}'s comparison 
8871 function. As a result, global values will not reliably be available to 
8872 the comparison function unless the @code{qsort} function itself is rebuilt.
8874 Similarly, it is not safe to access the global register variables from signal
8875 handlers or from more than one thread of control. Unless you recompile 
8876 them specially for the task at hand, the system library routines may 
8877 temporarily use the register for other things.
8879 @cindex register variable after @code{longjmp}
8880 @cindex global register after @code{longjmp}
8881 @cindex value after @code{longjmp}
8882 @findex longjmp
8883 @findex setjmp
8884 On most machines, @code{longjmp} restores to each global register
8885 variable the value it had at the time of the @code{setjmp}. On some
8886 machines, however, @code{longjmp} does not change the value of global
8887 register variables. To be portable, the function that called @code{setjmp}
8888 should make other arrangements to save the values of the global register
8889 variables, and to restore them in a @code{longjmp}. This way, the same
8890 thing happens regardless of what @code{longjmp} does.
8892 Eventually there may be a way of asking the compiler to choose a register 
8893 automatically, but first we need to figure out how it should choose and 
8894 how to enable you to guide the choice.  No solution is evident.
8896 @node Local Register Variables
8897 @subsubsection Specifying Registers for Local Variables
8898 @anchor{Local Reg Vars}
8899 @cindex local variables, specifying registers
8900 @cindex specifying registers for local variables
8901 @cindex registers for local variables
8903 You can define a local register variable and associate it with a specified 
8904 register like this:
8906 @smallexample
8907 register int *foo asm ("r12");
8908 @end smallexample
8910 @noindent
8911 Here @code{r12} is the name of the register that should be used.  Note
8912 that this is the same syntax used for defining global register variables, 
8913 but for a local variable the declaration appears within a function.  The 
8914 @code{register} keyword is required, and cannot be combined with 
8915 @code{static}.  The register name must be a valid register name for the
8916 target platform.
8918 As with global register variables, it is recommended that you choose 
8919 a register that is normally saved and restored by function calls on your 
8920 machine, so that calls to library routines will not clobber it.
8922 The only supported use for this feature is to specify registers
8923 for input and output operands when calling Extended @code{asm} 
8924 (@pxref{Extended Asm}).  This may be necessary if the constraints for a 
8925 particular machine don't provide sufficient control to select the desired 
8926 register.  To force an operand into a register, create a local variable 
8927 and specify the register name after the variable's declaration.  Then use 
8928 the local variable for the @code{asm} operand and specify any constraint 
8929 letter that matches the register:
8931 @smallexample
8932 register int *p1 asm ("r0") = @dots{};
8933 register int *p2 asm ("r1") = @dots{};
8934 register int *result asm ("r0");
8935 asm ("sysint" : "=r" (result) : "0" (p1), "r" (p2));
8936 @end smallexample
8938 @emph{Warning:} In the above example, be aware that a register (for example 
8939 @code{r0}) can be call-clobbered by subsequent code, including function 
8940 calls and library calls for arithmetic operators on other variables (for 
8941 example the initialization of @code{p2}).  In this case, use temporary 
8942 variables for expressions between the register assignments:
8944 @smallexample
8945 int t1 = @dots{};
8946 register int *p1 asm ("r0") = @dots{};
8947 register int *p2 asm ("r1") = t1;
8948 register int *result asm ("r0");
8949 asm ("sysint" : "=r" (result) : "0" (p1), "r" (p2));
8950 @end smallexample
8952 Defining a register variable does not reserve the register.  Other than
8953 when invoking the Extended @code{asm}, the contents of the specified 
8954 register are not guaranteed.  For this reason, the following uses 
8955 are explicitly @emph{not} supported.  If they appear to work, it is only 
8956 happenstance, and may stop working as intended due to (seemingly) 
8957 unrelated changes in surrounding code, or even minor changes in the 
8958 optimization of a future version of gcc:
8960 @itemize @bullet
8961 @item Passing parameters to or from Basic @code{asm}
8962 @item Passing parameters to or from Extended @code{asm} without using input 
8963 or output operands.
8964 @item Passing parameters to or from routines written in assembler (or
8965 other languages) using non-standard calling conventions.
8966 @end itemize
8968 Some developers use Local Register Variables in an attempt to improve 
8969 gcc's allocation of registers, especially in large functions.  In this 
8970 case the register name is essentially a hint to the register allocator.
8971 While in some instances this can generate better code, improvements are
8972 subject to the whims of the allocator/optimizers.  Since there are no
8973 guarantees that your improvements won't be lost, this usage of Local
8974 Register Variables is discouraged.
8976 On the MIPS platform, there is related use for local register variables 
8977 with slightly different characteristics (@pxref{MIPS Coprocessors,, 
8978 Defining coprocessor specifics for MIPS targets, gccint, 
8979 GNU Compiler Collection (GCC) Internals}).
8981 @node Size of an asm
8982 @subsection Size of an @code{asm}
8984 Some targets require that GCC track the size of each instruction used
8985 in order to generate correct code.  Because the final length of the
8986 code produced by an @code{asm} statement is only known by the
8987 assembler, GCC must make an estimate as to how big it will be.  It
8988 does this by counting the number of instructions in the pattern of the
8989 @code{asm} and multiplying that by the length of the longest
8990 instruction supported by that processor.  (When working out the number
8991 of instructions, it assumes that any occurrence of a newline or of
8992 whatever statement separator character is supported by the assembler --
8993 typically @samp{;} --- indicates the end of an instruction.)
8995 Normally, GCC's estimate is adequate to ensure that correct
8996 code is generated, but it is possible to confuse the compiler if you use
8997 pseudo instructions or assembler macros that expand into multiple real
8998 instructions, or if you use assembler directives that expand to more
8999 space in the object file than is needed for a single instruction.
9000 If this happens then the assembler may produce a diagnostic saying that
9001 a label is unreachable.
9003 @node Alternate Keywords
9004 @section Alternate Keywords
9005 @cindex alternate keywords
9006 @cindex keywords, alternate
9008 @option{-ansi} and the various @option{-std} options disable certain
9009 keywords.  This causes trouble when you want to use GNU C extensions, or
9010 a general-purpose header file that should be usable by all programs,
9011 including ISO C programs.  The keywords @code{asm}, @code{typeof} and
9012 @code{inline} are not available in programs compiled with
9013 @option{-ansi} or @option{-std} (although @code{inline} can be used in a
9014 program compiled with @option{-std=c99} or @option{-std=c11}).  The
9015 ISO C99 keyword
9016 @code{restrict} is only available when @option{-std=gnu99} (which will
9017 eventually be the default) or @option{-std=c99} (or the equivalent
9018 @option{-std=iso9899:1999}), or an option for a later standard
9019 version, is used.
9021 The way to solve these problems is to put @samp{__} at the beginning and
9022 end of each problematical keyword.  For example, use @code{__asm__}
9023 instead of @code{asm}, and @code{__inline__} instead of @code{inline}.
9025 Other C compilers won't accept these alternative keywords; if you want to
9026 compile with another compiler, you can define the alternate keywords as
9027 macros to replace them with the customary keywords.  It looks like this:
9029 @smallexample
9030 #ifndef __GNUC__
9031 #define __asm__ asm
9032 #endif
9033 @end smallexample
9035 @findex __extension__
9036 @opindex pedantic
9037 @option{-pedantic} and other options cause warnings for many GNU C extensions.
9038 You can
9039 prevent such warnings within one expression by writing
9040 @code{__extension__} before the expression.  @code{__extension__} has no
9041 effect aside from this.
9043 @node Incomplete Enums
9044 @section Incomplete @code{enum} Types
9046 You can define an @code{enum} tag without specifying its possible values.
9047 This results in an incomplete type, much like what you get if you write
9048 @code{struct foo} without describing the elements.  A later declaration
9049 that does specify the possible values completes the type.
9051 You can't allocate variables or storage using the type while it is
9052 incomplete.  However, you can work with pointers to that type.
9054 This extension may not be very useful, but it makes the handling of
9055 @code{enum} more consistent with the way @code{struct} and @code{union}
9056 are handled.
9058 This extension is not supported by GNU C++.
9060 @node Function Names
9061 @section Function Names as Strings
9062 @cindex @code{__func__} identifier
9063 @cindex @code{__FUNCTION__} identifier
9064 @cindex @code{__PRETTY_FUNCTION__} identifier
9066 GCC provides three magic constants that hold the name of the current
9067 function as a string.  In C++11 and later modes, all three are treated
9068 as constant expressions and can be used in @code{constexpr} constexts.
9069 The first of these constants is @code{__func__}, which is part of
9070 the C99 standard:
9072 The identifier @code{__func__} is implicitly declared by the translator
9073 as if, immediately following the opening brace of each function
9074 definition, the declaration
9076 @smallexample
9077 static const char __func__[] = "function-name";
9078 @end smallexample
9080 @noindent
9081 appeared, where function-name is the name of the lexically-enclosing
9082 function.  This name is the unadorned name of the function.  As an
9083 extension, at file (or, in C++, namespace scope), @code{__func__}
9084 evaluates to the empty string.
9086 @code{__FUNCTION__} is another name for @code{__func__}, provided for
9087 backward compatibility with old versions of GCC.
9089 In C, @code{__PRETTY_FUNCTION__} is yet another name for
9090 @code{__func__}, except that at file (or, in C++, namespace scope),
9091 it evaluates to the string @code{"top level"}.  In addition, in C++,
9092 @code{__PRETTY_FUNCTION__} contains the signature of the function as
9093 well as its bare name.  For example, this program:
9095 @smallexample
9096 extern "C" int printf (const char *, ...);
9098 class a @{
9099  public:
9100   void sub (int i)
9101     @{
9102       printf ("__FUNCTION__ = %s\n", __FUNCTION__);
9103       printf ("__PRETTY_FUNCTION__ = %s\n", __PRETTY_FUNCTION__);
9104     @}
9108 main (void)
9110   a ax;
9111   ax.sub (0);
9112   return 0;
9114 @end smallexample
9116 @noindent
9117 gives this output:
9119 @smallexample
9120 __FUNCTION__ = sub
9121 __PRETTY_FUNCTION__ = void a::sub(int)
9122 @end smallexample
9124 These identifiers are variables, not preprocessor macros, and may not
9125 be used to initialize @code{char} arrays or be concatenated with string
9126 literals.
9128 @node Return Address
9129 @section Getting the Return or Frame Address of a Function
9131 These functions may be used to get information about the callers of a
9132 function.
9134 @deftypefn {Built-in Function} {void *} __builtin_return_address (unsigned int @var{level})
9135 This function returns the return address of the current function, or of
9136 one of its callers.  The @var{level} argument is number of frames to
9137 scan up the call stack.  A value of @code{0} yields the return address
9138 of the current function, a value of @code{1} yields the return address
9139 of the caller of the current function, and so forth.  When inlining
9140 the expected behavior is that the function returns the address of
9141 the function that is returned to.  To work around this behavior use
9142 the @code{noinline} function attribute.
9144 The @var{level} argument must be a constant integer.
9146 On some machines it may be impossible to determine the return address of
9147 any function other than the current one; in such cases, or when the top
9148 of the stack has been reached, this function returns @code{0} or a
9149 random value.  In addition, @code{__builtin_frame_address} may be used
9150 to determine if the top of the stack has been reached.
9152 Additional post-processing of the returned value may be needed, see
9153 @code{__builtin_extract_return_addr}.
9155 Calling this function with a nonzero argument can have unpredictable
9156 effects, including crashing the calling program.  As a result, calls
9157 that are considered unsafe are diagnosed when the @option{-Wframe-address}
9158 option is in effect.  Such calls should only be made in debugging
9159 situations.
9160 @end deftypefn
9162 @deftypefn {Built-in Function} {void *} __builtin_extract_return_addr (void *@var{addr})
9163 The address as returned by @code{__builtin_return_address} may have to be fed
9164 through this function to get the actual encoded address.  For example, on the
9165 31-bit S/390 platform the highest bit has to be masked out, or on SPARC
9166 platforms an offset has to be added for the true next instruction to be
9167 executed.
9169 If no fixup is needed, this function simply passes through @var{addr}.
9170 @end deftypefn
9172 @deftypefn {Built-in Function} {void *} __builtin_frob_return_address (void *@var{addr})
9173 This function does the reverse of @code{__builtin_extract_return_addr}.
9174 @end deftypefn
9176 @deftypefn {Built-in Function} {void *} __builtin_frame_address (unsigned int @var{level})
9177 This function is similar to @code{__builtin_return_address}, but it
9178 returns the address of the function frame rather than the return address
9179 of the function.  Calling @code{__builtin_frame_address} with a value of
9180 @code{0} yields the frame address of the current function, a value of
9181 @code{1} yields the frame address of the caller of the current function,
9182 and so forth.
9184 The frame is the area on the stack that holds local variables and saved
9185 registers.  The frame address is normally the address of the first word
9186 pushed on to the stack by the function.  However, the exact definition
9187 depends upon the processor and the calling convention.  If the processor
9188 has a dedicated frame pointer register, and the function has a frame,
9189 then @code{__builtin_frame_address} returns the value of the frame
9190 pointer register.
9192 On some machines it may be impossible to determine the frame address of
9193 any function other than the current one; in such cases, or when the top
9194 of the stack has been reached, this function returns @code{0} if
9195 the first frame pointer is properly initialized by the startup code.
9197 Calling this function with a nonzero argument can have unpredictable
9198 effects, including crashing the calling program.  As a result, calls
9199 that are considered unsafe are diagnosed when the @option{-Wframe-address}
9200 option is in effect.  Such calls should only be made in debugging
9201 situations.
9202 @end deftypefn
9204 @node Vector Extensions
9205 @section Using Vector Instructions through Built-in Functions
9207 On some targets, the instruction set contains SIMD vector instructions which
9208 operate on multiple values contained in one large register at the same time.
9209 For example, on the x86 the MMX, 3DNow!@: and SSE extensions can be used
9210 this way.
9212 The first step in using these extensions is to provide the necessary data
9213 types.  This should be done using an appropriate @code{typedef}:
9215 @smallexample
9216 typedef int v4si __attribute__ ((vector_size (16)));
9217 @end smallexample
9219 @noindent
9220 The @code{int} type specifies the base type, while the attribute specifies
9221 the vector size for the variable, measured in bytes.  For example, the
9222 declaration above causes the compiler to set the mode for the @code{v4si}
9223 type to be 16 bytes wide and divided into @code{int} sized units.  For
9224 a 32-bit @code{int} this means a vector of 4 units of 4 bytes, and the
9225 corresponding mode of @code{foo} is @acronym{V4SI}.
9227 The @code{vector_size} attribute is only applicable to integral and
9228 float scalars, although arrays, pointers, and function return values
9229 are allowed in conjunction with this construct. Only sizes that are
9230 a power of two are currently allowed.
9232 All the basic integer types can be used as base types, both as signed
9233 and as unsigned: @code{char}, @code{short}, @code{int}, @code{long},
9234 @code{long long}.  In addition, @code{float} and @code{double} can be
9235 used to build floating-point vector types.
9237 Specifying a combination that is not valid for the current architecture
9238 causes GCC to synthesize the instructions using a narrower mode.
9239 For example, if you specify a variable of type @code{V4SI} and your
9240 architecture does not allow for this specific SIMD type, GCC
9241 produces code that uses 4 @code{SIs}.
9243 The types defined in this manner can be used with a subset of normal C
9244 operations.  Currently, GCC allows using the following operators
9245 on these types: @code{+, -, *, /, unary minus, ^, |, &, ~, %}@.
9247 The operations behave like C++ @code{valarrays}.  Addition is defined as
9248 the addition of the corresponding elements of the operands.  For
9249 example, in the code below, each of the 4 elements in @var{a} is
9250 added to the corresponding 4 elements in @var{b} and the resulting
9251 vector is stored in @var{c}.
9253 @smallexample
9254 typedef int v4si __attribute__ ((vector_size (16)));
9256 v4si a, b, c;
9258 c = a + b;
9259 @end smallexample
9261 Subtraction, multiplication, division, and the logical operations
9262 operate in a similar manner.  Likewise, the result of using the unary
9263 minus or complement operators on a vector type is a vector whose
9264 elements are the negative or complemented values of the corresponding
9265 elements in the operand.
9267 It is possible to use shifting operators @code{<<}, @code{>>} on
9268 integer-type vectors. The operation is defined as following: @code{@{a0,
9269 a1, @dots{}, an@} >> @{b0, b1, @dots{}, bn@} == @{a0 >> b0, a1 >> b1,
9270 @dots{}, an >> bn@}}@. Vector operands must have the same number of
9271 elements. 
9273 For convenience, it is allowed to use a binary vector operation
9274 where one operand is a scalar. In that case the compiler transforms
9275 the scalar operand into a vector where each element is the scalar from
9276 the operation. The transformation happens only if the scalar could be
9277 safely converted to the vector-element type.
9278 Consider the following code.
9280 @smallexample
9281 typedef int v4si __attribute__ ((vector_size (16)));
9283 v4si a, b, c;
9284 long l;
9286 a = b + 1;    /* a = b + @{1,1,1,1@}; */
9287 a = 2 * b;    /* a = @{2,2,2,2@} * b; */
9289 a = l + a;    /* Error, cannot convert long to int. */
9290 @end smallexample
9292 Vectors can be subscripted as if the vector were an array with
9293 the same number of elements and base type.  Out of bound accesses
9294 invoke undefined behavior at run time.  Warnings for out of bound
9295 accesses for vector subscription can be enabled with
9296 @option{-Warray-bounds}.
9298 Vector comparison is supported with standard comparison
9299 operators: @code{==, !=, <, <=, >, >=}. Comparison operands can be
9300 vector expressions of integer-type or real-type. Comparison between
9301 integer-type vectors and real-type vectors are not supported.  The
9302 result of the comparison is a vector of the same width and number of
9303 elements as the comparison operands with a signed integral element
9304 type.
9306 Vectors are compared element-wise producing 0 when comparison is false
9307 and -1 (constant of the appropriate type where all bits are set)
9308 otherwise. Consider the following example.
9310 @smallexample
9311 typedef int v4si __attribute__ ((vector_size (16)));
9313 v4si a = @{1,2,3,4@};
9314 v4si b = @{3,2,1,4@};
9315 v4si c;
9317 c = a >  b;     /* The result would be @{0, 0,-1, 0@}  */
9318 c = a == b;     /* The result would be @{0,-1, 0,-1@}  */
9319 @end smallexample
9321 In C++, the ternary operator @code{?:} is available. @code{a?b:c}, where
9322 @code{b} and @code{c} are vectors of the same type and @code{a} is an
9323 integer vector with the same number of elements of the same size as @code{b}
9324 and @code{c}, computes all three arguments and creates a vector
9325 @code{@{a[0]?b[0]:c[0], a[1]?b[1]:c[1], @dots{}@}}.  Note that unlike in
9326 OpenCL, @code{a} is thus interpreted as @code{a != 0} and not @code{a < 0}.
9327 As in the case of binary operations, this syntax is also accepted when
9328 one of @code{b} or @code{c} is a scalar that is then transformed into a
9329 vector. If both @code{b} and @code{c} are scalars and the type of
9330 @code{true?b:c} has the same size as the element type of @code{a}, then
9331 @code{b} and @code{c} are converted to a vector type whose elements have
9332 this type and with the same number of elements as @code{a}.
9334 In C++, the logic operators @code{!, &&, ||} are available for vectors.
9335 @code{!v} is equivalent to @code{v == 0}, @code{a && b} is equivalent to
9336 @code{a!=0 & b!=0} and @code{a || b} is equivalent to @code{a!=0 | b!=0}.
9337 For mixed operations between a scalar @code{s} and a vector @code{v},
9338 @code{s && v} is equivalent to @code{s?v!=0:0} (the evaluation is
9339 short-circuit) and @code{v && s} is equivalent to @code{v!=0 & (s?-1:0)}.
9341 Vector shuffling is available using functions
9342 @code{__builtin_shuffle (vec, mask)} and
9343 @code{__builtin_shuffle (vec0, vec1, mask)}.
9344 Both functions construct a permutation of elements from one or two
9345 vectors and return a vector of the same type as the input vector(s).
9346 The @var{mask} is an integral vector with the same width (@var{W})
9347 and element count (@var{N}) as the output vector.
9349 The elements of the input vectors are numbered in memory ordering of
9350 @var{vec0} beginning at 0 and @var{vec1} beginning at @var{N}.  The
9351 elements of @var{mask} are considered modulo @var{N} in the single-operand
9352 case and modulo @math{2*@var{N}} in the two-operand case.
9354 Consider the following example,
9356 @smallexample
9357 typedef int v4si __attribute__ ((vector_size (16)));
9359 v4si a = @{1,2,3,4@};
9360 v4si b = @{5,6,7,8@};
9361 v4si mask1 = @{0,1,1,3@};
9362 v4si mask2 = @{0,4,2,5@};
9363 v4si res;
9365 res = __builtin_shuffle (a, mask1);       /* res is @{1,2,2,4@}  */
9366 res = __builtin_shuffle (a, b, mask2);    /* res is @{1,5,3,6@}  */
9367 @end smallexample
9369 Note that @code{__builtin_shuffle} is intentionally semantically
9370 compatible with the OpenCL @code{shuffle} and @code{shuffle2} functions.
9372 You can declare variables and use them in function calls and returns, as
9373 well as in assignments and some casts.  You can specify a vector type as
9374 a return type for a function.  Vector types can also be used as function
9375 arguments.  It is possible to cast from one vector type to another,
9376 provided they are of the same size (in fact, you can also cast vectors
9377 to and from other datatypes of the same size).
9379 You cannot operate between vectors of different lengths or different
9380 signedness without a cast.
9382 @node Offsetof
9383 @section Support for @code{offsetof}
9384 @findex __builtin_offsetof
9386 GCC implements for both C and C++ a syntactic extension to implement
9387 the @code{offsetof} macro.
9389 @smallexample
9390 primary:
9391         "__builtin_offsetof" "(" @code{typename} "," offsetof_member_designator ")"
9393 offsetof_member_designator:
9394           @code{identifier}
9395         | offsetof_member_designator "." @code{identifier}
9396         | offsetof_member_designator "[" @code{expr} "]"
9397 @end smallexample
9399 This extension is sufficient such that
9401 @smallexample
9402 #define offsetof(@var{type}, @var{member})  __builtin_offsetof (@var{type}, @var{member})
9403 @end smallexample
9405 @noindent
9406 is a suitable definition of the @code{offsetof} macro.  In C++, @var{type}
9407 may be dependent.  In either case, @var{member} may consist of a single
9408 identifier, or a sequence of member accesses and array references.
9410 @node __sync Builtins
9411 @section Legacy @code{__sync} Built-in Functions for Atomic Memory Access
9413 The following built-in functions
9414 are intended to be compatible with those described
9415 in the @cite{Intel Itanium Processor-specific Application Binary Interface},
9416 section 7.4.  As such, they depart from normal GCC practice by not using
9417 the @samp{__builtin_} prefix and also by being overloaded so that they
9418 work on multiple types.
9420 The definition given in the Intel documentation allows only for the use of
9421 the types @code{int}, @code{long}, @code{long long} or their unsigned
9422 counterparts.  GCC allows any scalar type that is 1, 2, 4 or 8 bytes in
9423 size other than the C type @code{_Bool} or the C++ type @code{bool}.
9424 Operations on pointer arguments are performed as if the operands were
9425 of the @code{uintptr_t} type.  That is, they are not scaled by the size
9426 of the type to which the pointer points.
9428 These functions are implemented in terms of the @samp{__atomic}
9429 builtins (@pxref{__atomic Builtins}).  They should not be used for new
9430 code which should use the @samp{__atomic} builtins instead.
9432 Not all operations are supported by all target processors.  If a particular
9433 operation cannot be implemented on the target processor, a warning is
9434 generated and a call to an external function is generated.  The external
9435 function carries the same name as the built-in version,
9436 with an additional suffix
9437 @samp{_@var{n}} where @var{n} is the size of the data type.
9439 @c ??? Should we have a mechanism to suppress this warning?  This is almost
9440 @c useful for implementing the operation under the control of an external
9441 @c mutex.
9443 In most cases, these built-in functions are considered a @dfn{full barrier}.
9444 That is,
9445 no memory operand is moved across the operation, either forward or
9446 backward.  Further, instructions are issued as necessary to prevent the
9447 processor from speculating loads across the operation and from queuing stores
9448 after the operation.
9450 All of the routines are described in the Intel documentation to take
9451 ``an optional list of variables protected by the memory barrier''.  It's
9452 not clear what is meant by that; it could mean that @emph{only} the
9453 listed variables are protected, or it could mean a list of additional
9454 variables to be protected.  The list is ignored by GCC which treats it as
9455 empty.  GCC interprets an empty list as meaning that all globally
9456 accessible variables should be protected.
9458 @table @code
9459 @item @var{type} __sync_fetch_and_add (@var{type} *ptr, @var{type} value, ...)
9460 @itemx @var{type} __sync_fetch_and_sub (@var{type} *ptr, @var{type} value, ...)
9461 @itemx @var{type} __sync_fetch_and_or (@var{type} *ptr, @var{type} value, ...)
9462 @itemx @var{type} __sync_fetch_and_and (@var{type} *ptr, @var{type} value, ...)
9463 @itemx @var{type} __sync_fetch_and_xor (@var{type} *ptr, @var{type} value, ...)
9464 @itemx @var{type} __sync_fetch_and_nand (@var{type} *ptr, @var{type} value, ...)
9465 @findex __sync_fetch_and_add
9466 @findex __sync_fetch_and_sub
9467 @findex __sync_fetch_and_or
9468 @findex __sync_fetch_and_and
9469 @findex __sync_fetch_and_xor
9470 @findex __sync_fetch_and_nand
9471 These built-in functions perform the operation suggested by the name, and
9472 returns the value that had previously been in memory.  That is, operations
9473 on integer operands have the following semantics.  Operations on pointer
9474 arguments are performed as if the operands were of the @code{uintptr_t}
9475 type.  That is, they are not scaled by the size of the type to which
9476 the pointer points.
9478 @smallexample
9479 @{ tmp = *ptr; *ptr @var{op}= value; return tmp; @}
9480 @{ tmp = *ptr; *ptr = ~(tmp & value); return tmp; @}   // nand
9481 @end smallexample
9483 The object pointed to by the first argument must be of integer or pointer
9484 type.  It must not be a boolean type.
9486 @emph{Note:} GCC 4.4 and later implement @code{__sync_fetch_and_nand}
9487 as @code{*ptr = ~(tmp & value)} instead of @code{*ptr = ~tmp & value}.
9489 @item @var{type} __sync_add_and_fetch (@var{type} *ptr, @var{type} value, ...)
9490 @itemx @var{type} __sync_sub_and_fetch (@var{type} *ptr, @var{type} value, ...)
9491 @itemx @var{type} __sync_or_and_fetch (@var{type} *ptr, @var{type} value, ...)
9492 @itemx @var{type} __sync_and_and_fetch (@var{type} *ptr, @var{type} value, ...)
9493 @itemx @var{type} __sync_xor_and_fetch (@var{type} *ptr, @var{type} value, ...)
9494 @itemx @var{type} __sync_nand_and_fetch (@var{type} *ptr, @var{type} value, ...)
9495 @findex __sync_add_and_fetch
9496 @findex __sync_sub_and_fetch
9497 @findex __sync_or_and_fetch
9498 @findex __sync_and_and_fetch
9499 @findex __sync_xor_and_fetch
9500 @findex __sync_nand_and_fetch
9501 These built-in functions perform the operation suggested by the name, and
9502 return the new value.  That is, operations on integer operands have
9503 the following semantics.  Operations on pointer operands are performed as
9504 if the operand's type were @code{uintptr_t}.
9506 @smallexample
9507 @{ *ptr @var{op}= value; return *ptr; @}
9508 @{ *ptr = ~(*ptr & value); return *ptr; @}   // nand
9509 @end smallexample
9511 The same constraints on arguments apply as for the corresponding
9512 @code{__sync_op_and_fetch} built-in functions.
9514 @emph{Note:} GCC 4.4 and later implement @code{__sync_nand_and_fetch}
9515 as @code{*ptr = ~(*ptr & value)} instead of
9516 @code{*ptr = ~*ptr & value}.
9518 @item bool __sync_bool_compare_and_swap (@var{type} *ptr, @var{type} oldval, @var{type} newval, ...)
9519 @itemx @var{type} __sync_val_compare_and_swap (@var{type} *ptr, @var{type} oldval, @var{type} newval, ...)
9520 @findex __sync_bool_compare_and_swap
9521 @findex __sync_val_compare_and_swap
9522 These built-in functions perform an atomic compare and swap.
9523 That is, if the current
9524 value of @code{*@var{ptr}} is @var{oldval}, then write @var{newval} into
9525 @code{*@var{ptr}}.
9527 The ``bool'' version returns true if the comparison is successful and
9528 @var{newval} is written.  The ``val'' version returns the contents
9529 of @code{*@var{ptr}} before the operation.
9531 @item __sync_synchronize (...)
9532 @findex __sync_synchronize
9533 This built-in function issues a full memory barrier.
9535 @item @var{type} __sync_lock_test_and_set (@var{type} *ptr, @var{type} value, ...)
9536 @findex __sync_lock_test_and_set
9537 This built-in function, as described by Intel, is not a traditional test-and-set
9538 operation, but rather an atomic exchange operation.  It writes @var{value}
9539 into @code{*@var{ptr}}, and returns the previous contents of
9540 @code{*@var{ptr}}.
9542 Many targets have only minimal support for such locks, and do not support
9543 a full exchange operation.  In this case, a target may support reduced
9544 functionality here by which the @emph{only} valid value to store is the
9545 immediate constant 1.  The exact value actually stored in @code{*@var{ptr}}
9546 is implementation defined.
9548 This built-in function is not a full barrier,
9549 but rather an @dfn{acquire barrier}.
9550 This means that references after the operation cannot move to (or be
9551 speculated to) before the operation, but previous memory stores may not
9552 be globally visible yet, and previous memory loads may not yet be
9553 satisfied.
9555 @item void __sync_lock_release (@var{type} *ptr, ...)
9556 @findex __sync_lock_release
9557 This built-in function releases the lock acquired by
9558 @code{__sync_lock_test_and_set}.
9559 Normally this means writing the constant 0 to @code{*@var{ptr}}.
9561 This built-in function is not a full barrier,
9562 but rather a @dfn{release barrier}.
9563 This means that all previous memory stores are globally visible, and all
9564 previous memory loads have been satisfied, but following memory reads
9565 are not prevented from being speculated to before the barrier.
9566 @end table
9568 @node __atomic Builtins
9569 @section Built-in Functions for Memory Model Aware Atomic Operations
9571 The following built-in functions approximately match the requirements
9572 for the C++11 memory model.  They are all
9573 identified by being prefixed with @samp{__atomic} and most are
9574 overloaded so that they work with multiple types.
9576 These functions are intended to replace the legacy @samp{__sync}
9577 builtins.  The main difference is that the memory order that is requested
9578 is a parameter to the functions.  New code should always use the
9579 @samp{__atomic} builtins rather than the @samp{__sync} builtins.
9581 Note that the @samp{__atomic} builtins assume that programs will
9582 conform to the C++11 memory model.  In particular, they assume
9583 that programs are free of data races.  See the C++11 standard for
9584 detailed requirements.
9586 The @samp{__atomic} builtins can be used with any integral scalar or
9587 pointer type that is 1, 2, 4, or 8 bytes in length.  16-byte integral
9588 types are also allowed if @samp{__int128} (@pxref{__int128}) is
9589 supported by the architecture.
9591 The four non-arithmetic functions (load, store, exchange, and 
9592 compare_exchange) all have a generic version as well.  This generic
9593 version works on any data type.  It uses the lock-free built-in function
9594 if the specific data type size makes that possible; otherwise, an
9595 external call is left to be resolved at run time.  This external call is
9596 the same format with the addition of a @samp{size_t} parameter inserted
9597 as the first parameter indicating the size of the object being pointed to.
9598 All objects must be the same size.
9600 There are 6 different memory orders that can be specified.  These map
9601 to the C++11 memory orders with the same names, see the C++11 standard
9602 or the @uref{http://gcc.gnu.org/wiki/Atomic/GCCMM/AtomicSync,GCC wiki
9603 on atomic synchronization} for detailed definitions.  Individual
9604 targets may also support additional memory orders for use on specific
9605 architectures.  Refer to the target documentation for details of
9606 these.
9608 An atomic operation can both constrain code motion and
9609 be mapped to hardware instructions for synchronization between threads
9610 (e.g., a fence).  To which extent this happens is controlled by the
9611 memory orders, which are listed here in approximately ascending order of
9612 strength.  The description of each memory order is only meant to roughly
9613 illustrate the effects and is not a specification; see the C++11
9614 memory model for precise semantics.
9616 @table  @code
9617 @item __ATOMIC_RELAXED
9618 Implies no inter-thread ordering constraints.
9619 @item __ATOMIC_CONSUME
9620 This is currently implemented using the stronger @code{__ATOMIC_ACQUIRE}
9621 memory order because of a deficiency in C++11's semantics for
9622 @code{memory_order_consume}.
9623 @item __ATOMIC_ACQUIRE
9624 Creates an inter-thread happens-before constraint from the release (or
9625 stronger) semantic store to this acquire load.  Can prevent hoisting
9626 of code to before the operation.
9627 @item __ATOMIC_RELEASE
9628 Creates an inter-thread happens-before constraint to acquire (or stronger)
9629 semantic loads that read from this release store.  Can prevent sinking
9630 of code to after the operation.
9631 @item __ATOMIC_ACQ_REL
9632 Combines the effects of both @code{__ATOMIC_ACQUIRE} and
9633 @code{__ATOMIC_RELEASE}.
9634 @item __ATOMIC_SEQ_CST
9635 Enforces total ordering with all other @code{__ATOMIC_SEQ_CST} operations.
9636 @end table
9638 Note that in the C++11 memory model, @emph{fences} (e.g.,
9639 @samp{__atomic_thread_fence}) take effect in combination with other
9640 atomic operations on specific memory locations (e.g., atomic loads);
9641 operations on specific memory locations do not necessarily affect other
9642 operations in the same way.
9644 Target architectures are encouraged to provide their own patterns for
9645 each of the atomic built-in functions.  If no target is provided, the original
9646 non-memory model set of @samp{__sync} atomic built-in functions are
9647 used, along with any required synchronization fences surrounding it in
9648 order to achieve the proper behavior.  Execution in this case is subject
9649 to the same restrictions as those built-in functions.
9651 If there is no pattern or mechanism to provide a lock-free instruction
9652 sequence, a call is made to an external routine with the same parameters
9653 to be resolved at run time.
9655 When implementing patterns for these built-in functions, the memory order
9656 parameter can be ignored as long as the pattern implements the most
9657 restrictive @code{__ATOMIC_SEQ_CST} memory order.  Any of the other memory
9658 orders execute correctly with this memory order but they may not execute as
9659 efficiently as they could with a more appropriate implementation of the
9660 relaxed requirements.
9662 Note that the C++11 standard allows for the memory order parameter to be
9663 determined at run time rather than at compile time.  These built-in
9664 functions map any run-time value to @code{__ATOMIC_SEQ_CST} rather
9665 than invoke a runtime library call or inline a switch statement.  This is
9666 standard compliant, safe, and the simplest approach for now.
9668 The memory order parameter is a signed int, but only the lower 16 bits are
9669 reserved for the memory order.  The remainder of the signed int is reserved
9670 for target use and should be 0.  Use of the predefined atomic values
9671 ensures proper usage.
9673 @deftypefn {Built-in Function} @var{type} __atomic_load_n (@var{type} *ptr, int memorder)
9674 This built-in function implements an atomic load operation.  It returns the
9675 contents of @code{*@var{ptr}}.
9677 The valid memory order variants are
9678 @code{__ATOMIC_RELAXED}, @code{__ATOMIC_SEQ_CST}, @code{__ATOMIC_ACQUIRE},
9679 and @code{__ATOMIC_CONSUME}.
9681 @end deftypefn
9683 @deftypefn {Built-in Function} void __atomic_load (@var{type} *ptr, @var{type} *ret, int memorder)
9684 This is the generic version of an atomic load.  It returns the
9685 contents of @code{*@var{ptr}} in @code{*@var{ret}}.
9687 @end deftypefn
9689 @deftypefn {Built-in Function} void __atomic_store_n (@var{type} *ptr, @var{type} val, int memorder)
9690 This built-in function implements an atomic store operation.  It writes 
9691 @code{@var{val}} into @code{*@var{ptr}}.  
9693 The valid memory order variants are
9694 @code{__ATOMIC_RELAXED}, @code{__ATOMIC_SEQ_CST}, and @code{__ATOMIC_RELEASE}.
9696 @end deftypefn
9698 @deftypefn {Built-in Function} void __atomic_store (@var{type} *ptr, @var{type} *val, int memorder)
9699 This is the generic version of an atomic store.  It stores the value
9700 of @code{*@var{val}} into @code{*@var{ptr}}.
9702 @end deftypefn
9704 @deftypefn {Built-in Function} @var{type} __atomic_exchange_n (@var{type} *ptr, @var{type} val, int memorder)
9705 This built-in function implements an atomic exchange operation.  It writes
9706 @var{val} into @code{*@var{ptr}}, and returns the previous contents of
9707 @code{*@var{ptr}}.
9709 The valid memory order variants are
9710 @code{__ATOMIC_RELAXED}, @code{__ATOMIC_SEQ_CST}, @code{__ATOMIC_ACQUIRE},
9711 @code{__ATOMIC_RELEASE}, and @code{__ATOMIC_ACQ_REL}.
9713 @end deftypefn
9715 @deftypefn {Built-in Function} void __atomic_exchange (@var{type} *ptr, @var{type} *val, @var{type} *ret, int memorder)
9716 This is the generic version of an atomic exchange.  It stores the
9717 contents of @code{*@var{val}} into @code{*@var{ptr}}. The original value
9718 of @code{*@var{ptr}} is copied into @code{*@var{ret}}.
9720 @end deftypefn
9722 @deftypefn {Built-in Function} bool __atomic_compare_exchange_n (@var{type} *ptr, @var{type} *expected, @var{type} desired, bool weak, int success_memorder, int failure_memorder)
9723 This built-in function implements an atomic compare and exchange operation.
9724 This compares the contents of @code{*@var{ptr}} with the contents of
9725 @code{*@var{expected}}. If equal, the operation is a @emph{read-modify-write}
9726 operation that writes @var{desired} into @code{*@var{ptr}}.  If they are not
9727 equal, the operation is a @emph{read} and the current contents of
9728 @code{*@var{ptr}} are written into @code{*@var{expected}}.  @var{weak} is true
9729 for weak compare_exchange, which may fail spuriously, and false for
9730 the strong variation, which never fails spuriously.  Many targets
9731 only offer the strong variation and ignore the parameter.  When in doubt, use
9732 the strong variation.
9734 If @var{desired} is written into @code{*@var{ptr}} then true is returned
9735 and memory is affected according to the
9736 memory order specified by @var{success_memorder}.  There are no
9737 restrictions on what memory order can be used here.
9739 Otherwise, false is returned and memory is affected according
9740 to @var{failure_memorder}. This memory order cannot be
9741 @code{__ATOMIC_RELEASE} nor @code{__ATOMIC_ACQ_REL}.  It also cannot be a
9742 stronger order than that specified by @var{success_memorder}.
9744 @end deftypefn
9746 @deftypefn {Built-in Function} bool __atomic_compare_exchange (@var{type} *ptr, @var{type} *expected, @var{type} *desired, bool weak, int success_memorder, int failure_memorder)
9747 This built-in function implements the generic version of
9748 @code{__atomic_compare_exchange}.  The function is virtually identical to
9749 @code{__atomic_compare_exchange_n}, except the desired value is also a
9750 pointer.
9752 @end deftypefn
9754 @deftypefn {Built-in Function} @var{type} __atomic_add_fetch (@var{type} *ptr, @var{type} val, int memorder)
9755 @deftypefnx {Built-in Function} @var{type} __atomic_sub_fetch (@var{type} *ptr, @var{type} val, int memorder)
9756 @deftypefnx {Built-in Function} @var{type} __atomic_and_fetch (@var{type} *ptr, @var{type} val, int memorder)
9757 @deftypefnx {Built-in Function} @var{type} __atomic_xor_fetch (@var{type} *ptr, @var{type} val, int memorder)
9758 @deftypefnx {Built-in Function} @var{type} __atomic_or_fetch (@var{type} *ptr, @var{type} val, int memorder)
9759 @deftypefnx {Built-in Function} @var{type} __atomic_nand_fetch (@var{type} *ptr, @var{type} val, int memorder)
9760 These built-in functions perform the operation suggested by the name, and
9761 return the result of the operation.  Operations on pointer arguments are
9762 performed as if the operands were of the @code{uintptr_t} type.  That is,
9763 they are not scaled by the size of the type to which the pointer points.
9765 @smallexample
9766 @{ *ptr @var{op}= val; return *ptr; @}
9767 @end smallexample
9769 The object pointed to by the first argument must be of integer or pointer
9770 type.  It must not be a boolean type.  All memory orders are valid.
9772 @end deftypefn
9774 @deftypefn {Built-in Function} @var{type} __atomic_fetch_add (@var{type} *ptr, @var{type} val, int memorder)
9775 @deftypefnx {Built-in Function} @var{type} __atomic_fetch_sub (@var{type} *ptr, @var{type} val, int memorder)
9776 @deftypefnx {Built-in Function} @var{type} __atomic_fetch_and (@var{type} *ptr, @var{type} val, int memorder)
9777 @deftypefnx {Built-in Function} @var{type} __atomic_fetch_xor (@var{type} *ptr, @var{type} val, int memorder)
9778 @deftypefnx {Built-in Function} @var{type} __atomic_fetch_or (@var{type} *ptr, @var{type} val, int memorder)
9779 @deftypefnx {Built-in Function} @var{type} __atomic_fetch_nand (@var{type} *ptr, @var{type} val, int memorder)
9780 These built-in functions perform the operation suggested by the name, and
9781 return the value that had previously been in @code{*@var{ptr}}.  Operations
9782 on pointer arguments are performed as if the operands were of
9783 the @code{uintptr_t} type.  That is, they are not scaled by the size of
9784 the type to which the pointer points.
9786 @smallexample
9787 @{ tmp = *ptr; *ptr @var{op}= val; return tmp; @}
9788 @end smallexample
9790 The same constraints on arguments apply as for the corresponding
9791 @code{__atomic_op_fetch} built-in functions.  All memory orders are valid.
9793 @end deftypefn
9795 @deftypefn {Built-in Function} bool __atomic_test_and_set (void *ptr, int memorder)
9797 This built-in function performs an atomic test-and-set operation on
9798 the byte at @code{*@var{ptr}}.  The byte is set to some implementation
9799 defined nonzero ``set'' value and the return value is @code{true} if and only
9800 if the previous contents were ``set''.
9801 It should be only used for operands of type @code{bool} or @code{char}. For 
9802 other types only part of the value may be set.
9804 All memory orders are valid.
9806 @end deftypefn
9808 @deftypefn {Built-in Function} void __atomic_clear (bool *ptr, int memorder)
9810 This built-in function performs an atomic clear operation on
9811 @code{*@var{ptr}}.  After the operation, @code{*@var{ptr}} contains 0.
9812 It should be only used for operands of type @code{bool} or @code{char} and 
9813 in conjunction with @code{__atomic_test_and_set}.
9814 For other types it may only clear partially. If the type is not @code{bool}
9815 prefer using @code{__atomic_store}.
9817 The valid memory order variants are
9818 @code{__ATOMIC_RELAXED}, @code{__ATOMIC_SEQ_CST}, and
9819 @code{__ATOMIC_RELEASE}.
9821 @end deftypefn
9823 @deftypefn {Built-in Function} void __atomic_thread_fence (int memorder)
9825 This built-in function acts as a synchronization fence between threads
9826 based on the specified memory order.
9828 All memory orders are valid.
9830 @end deftypefn
9832 @deftypefn {Built-in Function} void __atomic_signal_fence (int memorder)
9834 This built-in function acts as a synchronization fence between a thread
9835 and signal handlers based in the same thread.
9837 All memory orders are valid.
9839 @end deftypefn
9841 @deftypefn {Built-in Function} bool __atomic_always_lock_free (size_t size,  void *ptr)
9843 This built-in function returns true if objects of @var{size} bytes always
9844 generate lock-free atomic instructions for the target architecture.
9845 @var{size} must resolve to a compile-time constant and the result also
9846 resolves to a compile-time constant.
9848 @var{ptr} is an optional pointer to the object that may be used to determine
9849 alignment.  A value of 0 indicates typical alignment should be used.  The 
9850 compiler may also ignore this parameter.
9852 @smallexample
9853 if (__atomic_always_lock_free (sizeof (long long), 0))
9854 @end smallexample
9856 @end deftypefn
9858 @deftypefn {Built-in Function} bool __atomic_is_lock_free (size_t size, void *ptr)
9860 This built-in function returns true if objects of @var{size} bytes always
9861 generate lock-free atomic instructions for the target architecture.  If
9862 the built-in function is not known to be lock-free, a call is made to a
9863 runtime routine named @code{__atomic_is_lock_free}.
9865 @var{ptr} is an optional pointer to the object that may be used to determine
9866 alignment.  A value of 0 indicates typical alignment should be used.  The 
9867 compiler may also ignore this parameter.
9868 @end deftypefn
9870 @node Integer Overflow Builtins
9871 @section Built-in Functions to Perform Arithmetic with Overflow Checking
9873 The following built-in functions allow performing simple arithmetic operations
9874 together with checking whether the operations overflowed.
9876 @deftypefn {Built-in Function} bool __builtin_add_overflow (@var{type1} a, @var{type2} b, @var{type3} *res)
9877 @deftypefnx {Built-in Function} bool __builtin_sadd_overflow (int a, int b, int *res)
9878 @deftypefnx {Built-in Function} bool __builtin_saddl_overflow (long int a, long int b, long int *res)
9879 @deftypefnx {Built-in Function} bool __builtin_saddll_overflow (long long int a, long long int b, long long int *res)
9880 @deftypefnx {Built-in Function} bool __builtin_uadd_overflow (unsigned int a, unsigned int b, unsigned int *res)
9881 @deftypefnx {Built-in Function} bool __builtin_uaddl_overflow (unsigned long int a, unsigned long int b, unsigned long int *res)
9882 @deftypefnx {Built-in Function} bool __builtin_uaddll_overflow (unsigned long long int a, unsigned long long int b, unsigned long long int *res)
9884 These built-in functions promote the first two operands into infinite precision signed
9885 type and perform addition on those promoted operands.  The result is then
9886 cast to the type the third pointer argument points to and stored there.
9887 If the stored result is equal to the infinite precision result, the built-in
9888 functions return false, otherwise they return true.  As the addition is
9889 performed in infinite signed precision, these built-in functions have fully defined
9890 behavior for all argument values.
9892 The first built-in function allows arbitrary integral types for operands and
9893 the result type must be pointer to some integral type other than enumerated or
9894 boolean type, the rest of the built-in functions have explicit integer types.
9896 The compiler will attempt to use hardware instructions to implement
9897 these built-in functions where possible, like conditional jump on overflow
9898 after addition, conditional jump on carry etc.
9900 @end deftypefn
9902 @deftypefn {Built-in Function} bool __builtin_sub_overflow (@var{type1} a, @var{type2} b, @var{type3} *res)
9903 @deftypefnx {Built-in Function} bool __builtin_ssub_overflow (int a, int b, int *res)
9904 @deftypefnx {Built-in Function} bool __builtin_ssubl_overflow (long int a, long int b, long int *res)
9905 @deftypefnx {Built-in Function} bool __builtin_ssubll_overflow (long long int a, long long int b, long long int *res)
9906 @deftypefnx {Built-in Function} bool __builtin_usub_overflow (unsigned int a, unsigned int b, unsigned int *res)
9907 @deftypefnx {Built-in Function} bool __builtin_usubl_overflow (unsigned long int a, unsigned long int b, unsigned long int *res)
9908 @deftypefnx {Built-in Function} bool __builtin_usubll_overflow (unsigned long long int a, unsigned long long int b, unsigned long long int *res)
9910 These built-in functions are similar to the add overflow checking built-in
9911 functions above, except they perform subtraction, subtract the second argument
9912 from the first one, instead of addition.
9914 @end deftypefn
9916 @deftypefn {Built-in Function} bool __builtin_mul_overflow (@var{type1} a, @var{type2} b, @var{type3} *res)
9917 @deftypefnx {Built-in Function} bool __builtin_smul_overflow (int a, int b, int *res)
9918 @deftypefnx {Built-in Function} bool __builtin_smull_overflow (long int a, long int b, long int *res)
9919 @deftypefnx {Built-in Function} bool __builtin_smulll_overflow (long long int a, long long int b, long long int *res)
9920 @deftypefnx {Built-in Function} bool __builtin_umul_overflow (unsigned int a, unsigned int b, unsigned int *res)
9921 @deftypefnx {Built-in Function} bool __builtin_umull_overflow (unsigned long int a, unsigned long int b, unsigned long int *res)
9922 @deftypefnx {Built-in Function} bool __builtin_umulll_overflow (unsigned long long int a, unsigned long long int b, unsigned long long int *res)
9924 These built-in functions are similar to the add overflow checking built-in
9925 functions above, except they perform multiplication, instead of addition.
9927 @end deftypefn
9929 The following built-in functions allow checking if simple arithmetic operation
9930 would overflow.
9932 @deftypefn {Built-in Function} bool __builtin_add_overflow_p (@var{type1} a, @var{type2} b, @var{type3} c)
9933 @deftypefnx {Built-in Function} bool __builtin_sub_overflow_p (@var{type1} a, @var{type2} b, @var{type3} c)
9934 @deftypefnx {Built-in Function} bool __builtin_mul_overflow_p (@var{type1} a, @var{type2} b, @var{type3} c)
9936 These built-in functions are similar to @code{__builtin_add_overflow},
9937 @code{__builtin_sub_overflow}, or @code{__builtin_mul_overflow}, except that
9938 they don't store the result of the arithmetic operation anywhere and the
9939 last argument is not a pointer, but some expression with integral type other
9940 than enumerated or boolean type.
9942 The built-in functions promote the first two operands into infinite precision signed type
9943 and perform addition on those promoted operands. The result is then
9944 cast to the type of the third argument.  If the cast result is equal to the infinite
9945 precision result, the built-in functions return false, otherwise they return true.
9946 The value of the third argument is ignored, just the side-effects in the third argument
9947 are evaluated, and no integral argument promotions are performed on the last argument.
9948 If the third argument is a bit-field, the type used for the result cast has the
9949 precision and signedness of the given bit-field, rather than precision and signedness
9950 of the underlying type.
9952 For example, the following macro can be used to portably check, at
9953 compile-time, whether or not adding two constant integers will overflow,
9954 and perform the addition only when it is known to be safe and not to trigger
9955 a @option{-Woverflow} warning.
9957 @smallexample
9958 #define INT_ADD_OVERFLOW_P(a, b) \
9959    __builtin_add_overflow_p (a, b, (__typeof__ ((a) + (b))) 0)
9961 enum @{
9962     A = INT_MAX, B = 3,
9963     C = INT_ADD_OVERFLOW_P (A, B) ? 0 : A + B,
9964     D = __builtin_add_overflow_p (1, SCHAR_MAX, (signed char) 0)
9966 @end smallexample
9968 The compiler will attempt to use hardware instructions to implement
9969 these built-in functions where possible, like conditional jump on overflow
9970 after addition, conditional jump on carry etc.
9972 @end deftypefn
9974 @node x86 specific memory model extensions for transactional memory
9975 @section x86-Specific Memory Model Extensions for Transactional Memory
9977 The x86 architecture supports additional memory ordering flags
9978 to mark lock critical sections for hardware lock elision. 
9979 These must be specified in addition to an existing memory order to
9980 atomic intrinsics.
9982 @table @code
9983 @item __ATOMIC_HLE_ACQUIRE
9984 Start lock elision on a lock variable.
9985 Memory order must be @code{__ATOMIC_ACQUIRE} or stronger.
9986 @item __ATOMIC_HLE_RELEASE
9987 End lock elision on a lock variable.
9988 Memory order must be @code{__ATOMIC_RELEASE} or stronger.
9989 @end table
9991 When a lock acquire fails, it is required for good performance to abort
9992 the transaction quickly. This can be done with a @code{_mm_pause}.
9994 @smallexample
9995 #include <immintrin.h> // For _mm_pause
9997 int lockvar;
9999 /* Acquire lock with lock elision */
10000 while (__atomic_exchange_n(&lockvar, 1, __ATOMIC_ACQUIRE|__ATOMIC_HLE_ACQUIRE))
10001     _mm_pause(); /* Abort failed transaction */
10003 /* Free lock with lock elision */
10004 __atomic_store_n(&lockvar, 0, __ATOMIC_RELEASE|__ATOMIC_HLE_RELEASE);
10005 @end smallexample
10007 @node Object Size Checking
10008 @section Object Size Checking Built-in Functions
10009 @findex __builtin_object_size
10010 @findex __builtin___memcpy_chk
10011 @findex __builtin___mempcpy_chk
10012 @findex __builtin___memmove_chk
10013 @findex __builtin___memset_chk
10014 @findex __builtin___strcpy_chk
10015 @findex __builtin___stpcpy_chk
10016 @findex __builtin___strncpy_chk
10017 @findex __builtin___strcat_chk
10018 @findex __builtin___strncat_chk
10019 @findex __builtin___sprintf_chk
10020 @findex __builtin___snprintf_chk
10021 @findex __builtin___vsprintf_chk
10022 @findex __builtin___vsnprintf_chk
10023 @findex __builtin___printf_chk
10024 @findex __builtin___vprintf_chk
10025 @findex __builtin___fprintf_chk
10026 @findex __builtin___vfprintf_chk
10028 GCC implements a limited buffer overflow protection mechanism that can
10029 prevent some buffer overflow attacks by determining the sizes of objects
10030 into which data is about to be written and preventing the writes when
10031 the size isn't sufficient.  The built-in functions described below yield
10032 the best results when used together and when optimization is enabled.
10033 For example, to detect object sizes across function boundaries or to
10034 follow pointer assignments through non-trivial control flow they rely
10035 on various optimization passes enabled with @option{-O2}.  However, to
10036 a limited extent, they can be used without optimization as well.
10038 @deftypefn {Built-in Function} {size_t} __builtin_object_size (void * @var{ptr}, int @var{type})
10039 is a built-in construct that returns a constant number of bytes from
10040 @var{ptr} to the end of the object @var{ptr} pointer points to
10041 (if known at compile time).  @code{__builtin_object_size} never evaluates
10042 its arguments for side-effects.  If there are any side-effects in them, it
10043 returns @code{(size_t) -1} for @var{type} 0 or 1 and @code{(size_t) 0}
10044 for @var{type} 2 or 3.  If there are multiple objects @var{ptr} can
10045 point to and all of them are known at compile time, the returned number
10046 is the maximum of remaining byte counts in those objects if @var{type} & 2 is
10047 0 and minimum if nonzero.  If it is not possible to determine which objects
10048 @var{ptr} points to at compile time, @code{__builtin_object_size} should
10049 return @code{(size_t) -1} for @var{type} 0 or 1 and @code{(size_t) 0}
10050 for @var{type} 2 or 3.
10052 @var{type} is an integer constant from 0 to 3.  If the least significant
10053 bit is clear, objects are whole variables, if it is set, a closest
10054 surrounding subobject is considered the object a pointer points to.
10055 The second bit determines if maximum or minimum of remaining bytes
10056 is computed.
10058 @smallexample
10059 struct V @{ char buf1[10]; int b; char buf2[10]; @} var;
10060 char *p = &var.buf1[1], *q = &var.b;
10062 /* Here the object p points to is var.  */
10063 assert (__builtin_object_size (p, 0) == sizeof (var) - 1);
10064 /* The subobject p points to is var.buf1.  */
10065 assert (__builtin_object_size (p, 1) == sizeof (var.buf1) - 1);
10066 /* The object q points to is var.  */
10067 assert (__builtin_object_size (q, 0)
10068         == (char *) (&var + 1) - (char *) &var.b);
10069 /* The subobject q points to is var.b.  */
10070 assert (__builtin_object_size (q, 1) == sizeof (var.b));
10071 @end smallexample
10072 @end deftypefn
10074 There are built-in functions added for many common string operation
10075 functions, e.g., for @code{memcpy} @code{__builtin___memcpy_chk}
10076 built-in is provided.  This built-in has an additional last argument,
10077 which is the number of bytes remaining in object the @var{dest}
10078 argument points to or @code{(size_t) -1} if the size is not known.
10080 The built-in functions are optimized into the normal string functions
10081 like @code{memcpy} if the last argument is @code{(size_t) -1} or if
10082 it is known at compile time that the destination object will not
10083 be overflown.  If the compiler can determine at compile time the
10084 object will be always overflown, it issues a warning.
10086 The intended use can be e.g.@:
10088 @smallexample
10089 #undef memcpy
10090 #define bos0(dest) __builtin_object_size (dest, 0)
10091 #define memcpy(dest, src, n) \
10092   __builtin___memcpy_chk (dest, src, n, bos0 (dest))
10094 char *volatile p;
10095 char buf[10];
10096 /* It is unknown what object p points to, so this is optimized
10097    into plain memcpy - no checking is possible.  */
10098 memcpy (p, "abcde", n);
10099 /* Destination is known and length too.  It is known at compile
10100    time there will be no overflow.  */
10101 memcpy (&buf[5], "abcde", 5);
10102 /* Destination is known, but the length is not known at compile time.
10103    This will result in __memcpy_chk call that can check for overflow
10104    at run time.  */
10105 memcpy (&buf[5], "abcde", n);
10106 /* Destination is known and it is known at compile time there will
10107    be overflow.  There will be a warning and __memcpy_chk call that
10108    will abort the program at run time.  */
10109 memcpy (&buf[6], "abcde", 5);
10110 @end smallexample
10112 Such built-in functions are provided for @code{memcpy}, @code{mempcpy},
10113 @code{memmove}, @code{memset}, @code{strcpy}, @code{stpcpy}, @code{strncpy},
10114 @code{strcat} and @code{strncat}.
10116 There are also checking built-in functions for formatted output functions.
10117 @smallexample
10118 int __builtin___sprintf_chk (char *s, int flag, size_t os, const char *fmt, ...);
10119 int __builtin___snprintf_chk (char *s, size_t maxlen, int flag, size_t os,
10120                               const char *fmt, ...);
10121 int __builtin___vsprintf_chk (char *s, int flag, size_t os, const char *fmt,
10122                               va_list ap);
10123 int __builtin___vsnprintf_chk (char *s, size_t maxlen, int flag, size_t os,
10124                                const char *fmt, va_list ap);
10125 @end smallexample
10127 The added @var{flag} argument is passed unchanged to @code{__sprintf_chk}
10128 etc.@: functions and can contain implementation specific flags on what
10129 additional security measures the checking function might take, such as
10130 handling @code{%n} differently.
10132 The @var{os} argument is the object size @var{s} points to, like in the
10133 other built-in functions.  There is a small difference in the behavior
10134 though, if @var{os} is @code{(size_t) -1}, the built-in functions are
10135 optimized into the non-checking functions only if @var{flag} is 0, otherwise
10136 the checking function is called with @var{os} argument set to
10137 @code{(size_t) -1}.
10139 In addition to this, there are checking built-in functions
10140 @code{__builtin___printf_chk}, @code{__builtin___vprintf_chk},
10141 @code{__builtin___fprintf_chk} and @code{__builtin___vfprintf_chk}.
10142 These have just one additional argument, @var{flag}, right before
10143 format string @var{fmt}.  If the compiler is able to optimize them to
10144 @code{fputc} etc.@: functions, it does, otherwise the checking function
10145 is called and the @var{flag} argument passed to it.
10147 @node Pointer Bounds Checker builtins
10148 @section Pointer Bounds Checker Built-in Functions
10149 @cindex Pointer Bounds Checker builtins
10150 @findex __builtin___bnd_set_ptr_bounds
10151 @findex __builtin___bnd_narrow_ptr_bounds
10152 @findex __builtin___bnd_copy_ptr_bounds
10153 @findex __builtin___bnd_init_ptr_bounds
10154 @findex __builtin___bnd_null_ptr_bounds
10155 @findex __builtin___bnd_store_ptr_bounds
10156 @findex __builtin___bnd_chk_ptr_lbounds
10157 @findex __builtin___bnd_chk_ptr_ubounds
10158 @findex __builtin___bnd_chk_ptr_bounds
10159 @findex __builtin___bnd_get_ptr_lbound
10160 @findex __builtin___bnd_get_ptr_ubound
10162 GCC provides a set of built-in functions to control Pointer Bounds Checker
10163 instrumentation.  Note that all Pointer Bounds Checker builtins can be used
10164 even if you compile with Pointer Bounds Checker off
10165 (@option{-fno-check-pointer-bounds}).
10166 The behavior may differ in such case as documented below.
10168 @deftypefn {Built-in Function} {void *} __builtin___bnd_set_ptr_bounds (const void *@var{q}, size_t @var{size})
10170 This built-in function returns a new pointer with the value of @var{q}, and
10171 associate it with the bounds [@var{q}, @var{q}+@var{size}-1].  With Pointer
10172 Bounds Checker off, the built-in function just returns the first argument.
10174 @smallexample
10175 extern void *__wrap_malloc (size_t n)
10177   void *p = (void *)__real_malloc (n);
10178   if (!p) return __builtin___bnd_null_ptr_bounds (p);
10179   return __builtin___bnd_set_ptr_bounds (p, n);
10181 @end smallexample
10183 @end deftypefn
10185 @deftypefn {Built-in Function} {void *} __builtin___bnd_narrow_ptr_bounds (const void *@var{p}, const void *@var{q}, size_t  @var{size})
10187 This built-in function returns a new pointer with the value of @var{p}
10188 and associates it with the narrowed bounds formed by the intersection
10189 of bounds associated with @var{q} and the bounds
10190 [@var{p}, @var{p} + @var{size} - 1].
10191 With Pointer Bounds Checker off, the built-in function just returns the first
10192 argument.
10194 @smallexample
10195 void init_objects (object *objs, size_t size)
10197   size_t i;
10198   /* Initialize objects one-by-one passing pointers with bounds of 
10199      an object, not the full array of objects.  */
10200   for (i = 0; i < size; i++)
10201     init_object (__builtin___bnd_narrow_ptr_bounds (objs + i, objs,
10202                                                     sizeof(object)));
10204 @end smallexample
10206 @end deftypefn
10208 @deftypefn {Built-in Function} {void *} __builtin___bnd_copy_ptr_bounds (const void *@var{q}, const void *@var{r})
10210 This built-in function returns a new pointer with the value of @var{q},
10211 and associates it with the bounds already associated with pointer @var{r}.
10212 With Pointer Bounds Checker off, the built-in function just returns the first
10213 argument.
10215 @smallexample
10216 /* Here is a way to get pointer to object's field but
10217    still with the full object's bounds.  */
10218 int *field_ptr = __builtin___bnd_copy_ptr_bounds (&objptr->int_field, 
10219                                                   objptr);
10220 @end smallexample
10222 @end deftypefn
10224 @deftypefn {Built-in Function} {void *} __builtin___bnd_init_ptr_bounds (const void *@var{q})
10226 This built-in function returns a new pointer with the value of @var{q}, and
10227 associates it with INIT (allowing full memory access) bounds. With Pointer
10228 Bounds Checker off, the built-in function just returns the first argument.
10230 @end deftypefn
10232 @deftypefn {Built-in Function} {void *} __builtin___bnd_null_ptr_bounds (const void *@var{q})
10234 This built-in function returns a new pointer with the value of @var{q}, and
10235 associates it with NULL (allowing no memory access) bounds. With Pointer
10236 Bounds Checker off, the built-in function just returns the first argument.
10238 @end deftypefn
10240 @deftypefn {Built-in Function} void __builtin___bnd_store_ptr_bounds (const void **@var{ptr_addr}, const void *@var{ptr_val})
10242 This built-in function stores the bounds associated with pointer @var{ptr_val}
10243 and location @var{ptr_addr} into Bounds Table.  This can be useful to propagate
10244 bounds from legacy code without touching the associated pointer's memory when
10245 pointers are copied as integers.  With Pointer Bounds Checker off, the built-in
10246 function call is ignored.
10248 @end deftypefn
10250 @deftypefn {Built-in Function} void __builtin___bnd_chk_ptr_lbounds (const void *@var{q})
10252 This built-in function checks if the pointer @var{q} is within the lower
10253 bound of its associated bounds.  With Pointer Bounds Checker off, the built-in
10254 function call is ignored.
10256 @smallexample
10257 extern void *__wrap_memset (void *dst, int c, size_t len)
10259   if (len > 0)
10260     @{
10261       __builtin___bnd_chk_ptr_lbounds (dst);
10262       __builtin___bnd_chk_ptr_ubounds ((char *)dst + len - 1);
10263       __real_memset (dst, c, len);
10264     @}
10265   return dst;
10267 @end smallexample
10269 @end deftypefn
10271 @deftypefn {Built-in Function} void __builtin___bnd_chk_ptr_ubounds (const void *@var{q})
10273 This built-in function checks if the pointer @var{q} is within the upper
10274 bound of its associated bounds.  With Pointer Bounds Checker off, the built-in
10275 function call is ignored.
10277 @end deftypefn
10279 @deftypefn {Built-in Function} void __builtin___bnd_chk_ptr_bounds (const void *@var{q}, size_t @var{size})
10281 This built-in function checks if [@var{q}, @var{q} + @var{size} - 1] is within
10282 the lower and upper bounds associated with @var{q}.  With Pointer Bounds Checker
10283 off, the built-in function call is ignored.
10285 @smallexample
10286 extern void *__wrap_memcpy (void *dst, const void *src, size_t n)
10288   if (n > 0)
10289     @{
10290       __bnd_chk_ptr_bounds (dst, n);
10291       __bnd_chk_ptr_bounds (src, n);
10292       __real_memcpy (dst, src, n);
10293     @}
10294   return dst;
10296 @end smallexample
10298 @end deftypefn
10300 @deftypefn {Built-in Function} {const void *} __builtin___bnd_get_ptr_lbound (const void *@var{q})
10302 This built-in function returns the lower bound associated
10303 with the pointer @var{q}, as a pointer value.  
10304 This is useful for debugging using @code{printf}.
10305 With Pointer Bounds Checker off, the built-in function returns 0.
10307 @smallexample
10308 void *lb = __builtin___bnd_get_ptr_lbound (q);
10309 void *ub = __builtin___bnd_get_ptr_ubound (q);
10310 printf ("q = %p  lb(q) = %p  ub(q) = %p", q, lb, ub);
10311 @end smallexample
10313 @end deftypefn
10315 @deftypefn {Built-in Function} {const void *} __builtin___bnd_get_ptr_ubound (const void *@var{q})
10317 This built-in function returns the upper bound (which is a pointer) associated
10318 with the pointer @var{q}.  With Pointer Bounds Checker off,
10319 the built-in function returns -1.
10321 @end deftypefn
10323 @node Cilk Plus Builtins
10324 @section Cilk Plus C/C++ Language Extension Built-in Functions
10326 GCC provides support for the following built-in reduction functions if Cilk Plus
10327 is enabled. Cilk Plus can be enabled using the @option{-fcilkplus} flag.
10329 @itemize @bullet
10330 @item @code{__sec_implicit_index}
10331 @item @code{__sec_reduce}
10332 @item @code{__sec_reduce_add}
10333 @item @code{__sec_reduce_all_nonzero}
10334 @item @code{__sec_reduce_all_zero}
10335 @item @code{__sec_reduce_any_nonzero}
10336 @item @code{__sec_reduce_any_zero}
10337 @item @code{__sec_reduce_max}
10338 @item @code{__sec_reduce_min}
10339 @item @code{__sec_reduce_max_ind}
10340 @item @code{__sec_reduce_min_ind}
10341 @item @code{__sec_reduce_mul}
10342 @item @code{__sec_reduce_mutating}
10343 @end itemize
10345 Further details and examples about these built-in functions are described 
10346 in the Cilk Plus language manual which can be found at 
10347 @uref{http://www.cilkplus.org}.
10349 @node Other Builtins
10350 @section Other Built-in Functions Provided by GCC
10351 @cindex built-in functions
10352 @findex __builtin_alloca
10353 @findex __builtin_alloca_with_align
10354 @findex __builtin_call_with_static_chain
10355 @findex __builtin_fpclassify
10356 @findex __builtin_isfinite
10357 @findex __builtin_isnormal
10358 @findex __builtin_isgreater
10359 @findex __builtin_isgreaterequal
10360 @findex __builtin_isinf_sign
10361 @findex __builtin_isless
10362 @findex __builtin_islessequal
10363 @findex __builtin_islessgreater
10364 @findex __builtin_isunordered
10365 @findex __builtin_powi
10366 @findex __builtin_powif
10367 @findex __builtin_powil
10368 @findex _Exit
10369 @findex _exit
10370 @findex abort
10371 @findex abs
10372 @findex acos
10373 @findex acosf
10374 @findex acosh
10375 @findex acoshf
10376 @findex acoshl
10377 @findex acosl
10378 @findex alloca
10379 @findex asin
10380 @findex asinf
10381 @findex asinh
10382 @findex asinhf
10383 @findex asinhl
10384 @findex asinl
10385 @findex atan
10386 @findex atan2
10387 @findex atan2f
10388 @findex atan2l
10389 @findex atanf
10390 @findex atanh
10391 @findex atanhf
10392 @findex atanhl
10393 @findex atanl
10394 @findex bcmp
10395 @findex bzero
10396 @findex cabs
10397 @findex cabsf
10398 @findex cabsl
10399 @findex cacos
10400 @findex cacosf
10401 @findex cacosh
10402 @findex cacoshf
10403 @findex cacoshl
10404 @findex cacosl
10405 @findex calloc
10406 @findex carg
10407 @findex cargf
10408 @findex cargl
10409 @findex casin
10410 @findex casinf
10411 @findex casinh
10412 @findex casinhf
10413 @findex casinhl
10414 @findex casinl
10415 @findex catan
10416 @findex catanf
10417 @findex catanh
10418 @findex catanhf
10419 @findex catanhl
10420 @findex catanl
10421 @findex cbrt
10422 @findex cbrtf
10423 @findex cbrtl
10424 @findex ccos
10425 @findex ccosf
10426 @findex ccosh
10427 @findex ccoshf
10428 @findex ccoshl
10429 @findex ccosl
10430 @findex ceil
10431 @findex ceilf
10432 @findex ceill
10433 @findex cexp
10434 @findex cexpf
10435 @findex cexpl
10436 @findex cimag
10437 @findex cimagf
10438 @findex cimagl
10439 @findex clog
10440 @findex clogf
10441 @findex clogl
10442 @findex clog10
10443 @findex clog10f
10444 @findex clog10l
10445 @findex conj
10446 @findex conjf
10447 @findex conjl
10448 @findex copysign
10449 @findex copysignf
10450 @findex copysignl
10451 @findex cos
10452 @findex cosf
10453 @findex cosh
10454 @findex coshf
10455 @findex coshl
10456 @findex cosl
10457 @findex cpow
10458 @findex cpowf
10459 @findex cpowl
10460 @findex cproj
10461 @findex cprojf
10462 @findex cprojl
10463 @findex creal
10464 @findex crealf
10465 @findex creall
10466 @findex csin
10467 @findex csinf
10468 @findex csinh
10469 @findex csinhf
10470 @findex csinhl
10471 @findex csinl
10472 @findex csqrt
10473 @findex csqrtf
10474 @findex csqrtl
10475 @findex ctan
10476 @findex ctanf
10477 @findex ctanh
10478 @findex ctanhf
10479 @findex ctanhl
10480 @findex ctanl
10481 @findex dcgettext
10482 @findex dgettext
10483 @findex drem
10484 @findex dremf
10485 @findex dreml
10486 @findex erf
10487 @findex erfc
10488 @findex erfcf
10489 @findex erfcl
10490 @findex erff
10491 @findex erfl
10492 @findex exit
10493 @findex exp
10494 @findex exp10
10495 @findex exp10f
10496 @findex exp10l
10497 @findex exp2
10498 @findex exp2f
10499 @findex exp2l
10500 @findex expf
10501 @findex expl
10502 @findex expm1
10503 @findex expm1f
10504 @findex expm1l
10505 @findex fabs
10506 @findex fabsf
10507 @findex fabsl
10508 @findex fdim
10509 @findex fdimf
10510 @findex fdiml
10511 @findex ffs
10512 @findex floor
10513 @findex floorf
10514 @findex floorl
10515 @findex fma
10516 @findex fmaf
10517 @findex fmal
10518 @findex fmax
10519 @findex fmaxf
10520 @findex fmaxl
10521 @findex fmin
10522 @findex fminf
10523 @findex fminl
10524 @findex fmod
10525 @findex fmodf
10526 @findex fmodl
10527 @findex fprintf
10528 @findex fprintf_unlocked
10529 @findex fputs
10530 @findex fputs_unlocked
10531 @findex frexp
10532 @findex frexpf
10533 @findex frexpl
10534 @findex fscanf
10535 @findex gamma
10536 @findex gammaf
10537 @findex gammal
10538 @findex gamma_r
10539 @findex gammaf_r
10540 @findex gammal_r
10541 @findex gettext
10542 @findex hypot
10543 @findex hypotf
10544 @findex hypotl
10545 @findex ilogb
10546 @findex ilogbf
10547 @findex ilogbl
10548 @findex imaxabs
10549 @findex index
10550 @findex isalnum
10551 @findex isalpha
10552 @findex isascii
10553 @findex isblank
10554 @findex iscntrl
10555 @findex isdigit
10556 @findex isgraph
10557 @findex islower
10558 @findex isprint
10559 @findex ispunct
10560 @findex isspace
10561 @findex isupper
10562 @findex iswalnum
10563 @findex iswalpha
10564 @findex iswblank
10565 @findex iswcntrl
10566 @findex iswdigit
10567 @findex iswgraph
10568 @findex iswlower
10569 @findex iswprint
10570 @findex iswpunct
10571 @findex iswspace
10572 @findex iswupper
10573 @findex iswxdigit
10574 @findex isxdigit
10575 @findex j0
10576 @findex j0f
10577 @findex j0l
10578 @findex j1
10579 @findex j1f
10580 @findex j1l
10581 @findex jn
10582 @findex jnf
10583 @findex jnl
10584 @findex labs
10585 @findex ldexp
10586 @findex ldexpf
10587 @findex ldexpl
10588 @findex lgamma
10589 @findex lgammaf
10590 @findex lgammal
10591 @findex lgamma_r
10592 @findex lgammaf_r
10593 @findex lgammal_r
10594 @findex llabs
10595 @findex llrint
10596 @findex llrintf
10597 @findex llrintl
10598 @findex llround
10599 @findex llroundf
10600 @findex llroundl
10601 @findex log
10602 @findex log10
10603 @findex log10f
10604 @findex log10l
10605 @findex log1p
10606 @findex log1pf
10607 @findex log1pl
10608 @findex log2
10609 @findex log2f
10610 @findex log2l
10611 @findex logb
10612 @findex logbf
10613 @findex logbl
10614 @findex logf
10615 @findex logl
10616 @findex lrint
10617 @findex lrintf
10618 @findex lrintl
10619 @findex lround
10620 @findex lroundf
10621 @findex lroundl
10622 @findex malloc
10623 @findex memchr
10624 @findex memcmp
10625 @findex memcpy
10626 @findex mempcpy
10627 @findex memset
10628 @findex modf
10629 @findex modff
10630 @findex modfl
10631 @findex nearbyint
10632 @findex nearbyintf
10633 @findex nearbyintl
10634 @findex nextafter
10635 @findex nextafterf
10636 @findex nextafterl
10637 @findex nexttoward
10638 @findex nexttowardf
10639 @findex nexttowardl
10640 @findex pow
10641 @findex pow10
10642 @findex pow10f
10643 @findex pow10l
10644 @findex powf
10645 @findex powl
10646 @findex printf
10647 @findex printf_unlocked
10648 @findex putchar
10649 @findex puts
10650 @findex remainder
10651 @findex remainderf
10652 @findex remainderl
10653 @findex remquo
10654 @findex remquof
10655 @findex remquol
10656 @findex rindex
10657 @findex rint
10658 @findex rintf
10659 @findex rintl
10660 @findex round
10661 @findex roundf
10662 @findex roundl
10663 @findex scalb
10664 @findex scalbf
10665 @findex scalbl
10666 @findex scalbln
10667 @findex scalblnf
10668 @findex scalblnf
10669 @findex scalbn
10670 @findex scalbnf
10671 @findex scanfnl
10672 @findex signbit
10673 @findex signbitf
10674 @findex signbitl
10675 @findex signbitd32
10676 @findex signbitd64
10677 @findex signbitd128
10678 @findex significand
10679 @findex significandf
10680 @findex significandl
10681 @findex sin
10682 @findex sincos
10683 @findex sincosf
10684 @findex sincosl
10685 @findex sinf
10686 @findex sinh
10687 @findex sinhf
10688 @findex sinhl
10689 @findex sinl
10690 @findex snprintf
10691 @findex sprintf
10692 @findex sqrt
10693 @findex sqrtf
10694 @findex sqrtl
10695 @findex sscanf
10696 @findex stpcpy
10697 @findex stpncpy
10698 @findex strcasecmp
10699 @findex strcat
10700 @findex strchr
10701 @findex strcmp
10702 @findex strcpy
10703 @findex strcspn
10704 @findex strdup
10705 @findex strfmon
10706 @findex strftime
10707 @findex strlen
10708 @findex strncasecmp
10709 @findex strncat
10710 @findex strncmp
10711 @findex strncpy
10712 @findex strndup
10713 @findex strpbrk
10714 @findex strrchr
10715 @findex strspn
10716 @findex strstr
10717 @findex tan
10718 @findex tanf
10719 @findex tanh
10720 @findex tanhf
10721 @findex tanhl
10722 @findex tanl
10723 @findex tgamma
10724 @findex tgammaf
10725 @findex tgammal
10726 @findex toascii
10727 @findex tolower
10728 @findex toupper
10729 @findex towlower
10730 @findex towupper
10731 @findex trunc
10732 @findex truncf
10733 @findex truncl
10734 @findex vfprintf
10735 @findex vfscanf
10736 @findex vprintf
10737 @findex vscanf
10738 @findex vsnprintf
10739 @findex vsprintf
10740 @findex vsscanf
10741 @findex y0
10742 @findex y0f
10743 @findex y0l
10744 @findex y1
10745 @findex y1f
10746 @findex y1l
10747 @findex yn
10748 @findex ynf
10749 @findex ynl
10751 GCC provides a large number of built-in functions other than the ones
10752 mentioned above.  Some of these are for internal use in the processing
10753 of exceptions or variable-length argument lists and are not
10754 documented here because they may change from time to time; we do not
10755 recommend general use of these functions.
10757 The remaining functions are provided for optimization purposes.
10759 With the exception of built-ins that have library equivalents such as
10760 the standard C library functions discussed below, or that expand to
10761 library calls, GCC built-in functions are always expanded inline and
10762 thus do not have corresponding entry points and their address cannot
10763 be obtained.  Attempting to use them in an expression other than
10764 a function call results in a compile-time error.
10766 @opindex fno-builtin
10767 GCC includes built-in versions of many of the functions in the standard
10768 C library.  These functions come in two forms: one whose names start with
10769 the @code{__builtin_} prefix, and the other without.  Both forms have the
10770 same type (including prototype), the same address (when their address is
10771 taken), and the same meaning as the C library functions even if you specify
10772 the @option{-fno-builtin} option @pxref{C Dialect Options}).  Many of these
10773 functions are only optimized in certain cases; if they are not optimized in
10774 a particular case, a call to the library function is emitted.
10776 @opindex ansi
10777 @opindex std
10778 Outside strict ISO C mode (@option{-ansi}, @option{-std=c90},
10779 @option{-std=c99} or @option{-std=c11}), the functions
10780 @code{_exit}, @code{alloca}, @code{bcmp}, @code{bzero},
10781 @code{dcgettext}, @code{dgettext}, @code{dremf}, @code{dreml},
10782 @code{drem}, @code{exp10f}, @code{exp10l}, @code{exp10}, @code{ffsll},
10783 @code{ffsl}, @code{ffs}, @code{fprintf_unlocked},
10784 @code{fputs_unlocked}, @code{gammaf}, @code{gammal}, @code{gamma},
10785 @code{gammaf_r}, @code{gammal_r}, @code{gamma_r}, @code{gettext},
10786 @code{index}, @code{isascii}, @code{j0f}, @code{j0l}, @code{j0},
10787 @code{j1f}, @code{j1l}, @code{j1}, @code{jnf}, @code{jnl}, @code{jn},
10788 @code{lgammaf_r}, @code{lgammal_r}, @code{lgamma_r}, @code{mempcpy},
10789 @code{pow10f}, @code{pow10l}, @code{pow10}, @code{printf_unlocked},
10790 @code{rindex}, @code{scalbf}, @code{scalbl}, @code{scalb},
10791 @code{signbit}, @code{signbitf}, @code{signbitl}, @code{signbitd32},
10792 @code{signbitd64}, @code{signbitd128}, @code{significandf},
10793 @code{significandl}, @code{significand}, @code{sincosf},
10794 @code{sincosl}, @code{sincos}, @code{stpcpy}, @code{stpncpy},
10795 @code{strcasecmp}, @code{strdup}, @code{strfmon}, @code{strncasecmp},
10796 @code{strndup}, @code{toascii}, @code{y0f}, @code{y0l}, @code{y0},
10797 @code{y1f}, @code{y1l}, @code{y1}, @code{ynf}, @code{ynl} and
10798 @code{yn}
10799 may be handled as built-in functions.
10800 All these functions have corresponding versions
10801 prefixed with @code{__builtin_}, which may be used even in strict C90
10802 mode.
10804 The ISO C99 functions
10805 @code{_Exit}, @code{acoshf}, @code{acoshl}, @code{acosh}, @code{asinhf},
10806 @code{asinhl}, @code{asinh}, @code{atanhf}, @code{atanhl}, @code{atanh},
10807 @code{cabsf}, @code{cabsl}, @code{cabs}, @code{cacosf}, @code{cacoshf},
10808 @code{cacoshl}, @code{cacosh}, @code{cacosl}, @code{cacos},
10809 @code{cargf}, @code{cargl}, @code{carg}, @code{casinf}, @code{casinhf},
10810 @code{casinhl}, @code{casinh}, @code{casinl}, @code{casin},
10811 @code{catanf}, @code{catanhf}, @code{catanhl}, @code{catanh},
10812 @code{catanl}, @code{catan}, @code{cbrtf}, @code{cbrtl}, @code{cbrt},
10813 @code{ccosf}, @code{ccoshf}, @code{ccoshl}, @code{ccosh}, @code{ccosl},
10814 @code{ccos}, @code{cexpf}, @code{cexpl}, @code{cexp}, @code{cimagf},
10815 @code{cimagl}, @code{cimag}, @code{clogf}, @code{clogl}, @code{clog},
10816 @code{conjf}, @code{conjl}, @code{conj}, @code{copysignf}, @code{copysignl},
10817 @code{copysign}, @code{cpowf}, @code{cpowl}, @code{cpow}, @code{cprojf},
10818 @code{cprojl}, @code{cproj}, @code{crealf}, @code{creall}, @code{creal},
10819 @code{csinf}, @code{csinhf}, @code{csinhl}, @code{csinh}, @code{csinl},
10820 @code{csin}, @code{csqrtf}, @code{csqrtl}, @code{csqrt}, @code{ctanf},
10821 @code{ctanhf}, @code{ctanhl}, @code{ctanh}, @code{ctanl}, @code{ctan},
10822 @code{erfcf}, @code{erfcl}, @code{erfc}, @code{erff}, @code{erfl},
10823 @code{erf}, @code{exp2f}, @code{exp2l}, @code{exp2}, @code{expm1f},
10824 @code{expm1l}, @code{expm1}, @code{fdimf}, @code{fdiml}, @code{fdim},
10825 @code{fmaf}, @code{fmal}, @code{fmaxf}, @code{fmaxl}, @code{fmax},
10826 @code{fma}, @code{fminf}, @code{fminl}, @code{fmin}, @code{hypotf},
10827 @code{hypotl}, @code{hypot}, @code{ilogbf}, @code{ilogbl}, @code{ilogb},
10828 @code{imaxabs}, @code{isblank}, @code{iswblank}, @code{lgammaf},
10829 @code{lgammal}, @code{lgamma}, @code{llabs}, @code{llrintf}, @code{llrintl},
10830 @code{llrint}, @code{llroundf}, @code{llroundl}, @code{llround},
10831 @code{log1pf}, @code{log1pl}, @code{log1p}, @code{log2f}, @code{log2l},
10832 @code{log2}, @code{logbf}, @code{logbl}, @code{logb}, @code{lrintf},
10833 @code{lrintl}, @code{lrint}, @code{lroundf}, @code{lroundl},
10834 @code{lround}, @code{nearbyintf}, @code{nearbyintl}, @code{nearbyint},
10835 @code{nextafterf}, @code{nextafterl}, @code{nextafter},
10836 @code{nexttowardf}, @code{nexttowardl}, @code{nexttoward},
10837 @code{remainderf}, @code{remainderl}, @code{remainder}, @code{remquof},
10838 @code{remquol}, @code{remquo}, @code{rintf}, @code{rintl}, @code{rint},
10839 @code{roundf}, @code{roundl}, @code{round}, @code{scalblnf},
10840 @code{scalblnl}, @code{scalbln}, @code{scalbnf}, @code{scalbnl},
10841 @code{scalbn}, @code{snprintf}, @code{tgammaf}, @code{tgammal},
10842 @code{tgamma}, @code{truncf}, @code{truncl}, @code{trunc},
10843 @code{vfscanf}, @code{vscanf}, @code{vsnprintf} and @code{vsscanf}
10844 are handled as built-in functions
10845 except in strict ISO C90 mode (@option{-ansi} or @option{-std=c90}).
10847 There are also built-in versions of the ISO C99 functions
10848 @code{acosf}, @code{acosl}, @code{asinf}, @code{asinl}, @code{atan2f},
10849 @code{atan2l}, @code{atanf}, @code{atanl}, @code{ceilf}, @code{ceill},
10850 @code{cosf}, @code{coshf}, @code{coshl}, @code{cosl}, @code{expf},
10851 @code{expl}, @code{fabsf}, @code{fabsl}, @code{floorf}, @code{floorl},
10852 @code{fmodf}, @code{fmodl}, @code{frexpf}, @code{frexpl}, @code{ldexpf},
10853 @code{ldexpl}, @code{log10f}, @code{log10l}, @code{logf}, @code{logl},
10854 @code{modfl}, @code{modf}, @code{powf}, @code{powl}, @code{sinf},
10855 @code{sinhf}, @code{sinhl}, @code{sinl}, @code{sqrtf}, @code{sqrtl},
10856 @code{tanf}, @code{tanhf}, @code{tanhl} and @code{tanl}
10857 that are recognized in any mode since ISO C90 reserves these names for
10858 the purpose to which ISO C99 puts them.  All these functions have
10859 corresponding versions prefixed with @code{__builtin_}.
10861 There are also built-in functions @code{__builtin_fabsf@var{n}},
10862 @code{__builtin_fabsf@var{n}x}, @code{__builtin_copysignf@var{n}} and
10863 @code{__builtin_copysignf@var{n}x}, corresponding to the TS 18661-3
10864 functions @code{fabsf@var{n}}, @code{fabsf@var{n}x},
10865 @code{copysignf@var{n}} and @code{copysignf@var{n}x}, for supported
10866 types @code{_Float@var{n}} and @code{_Float@var{n}x}.
10868 There are also GNU extension functions @code{clog10}, @code{clog10f} and
10869 @code{clog10l} which names are reserved by ISO C99 for future use.
10870 All these functions have versions prefixed with @code{__builtin_}.
10872 The ISO C94 functions
10873 @code{iswalnum}, @code{iswalpha}, @code{iswcntrl}, @code{iswdigit},
10874 @code{iswgraph}, @code{iswlower}, @code{iswprint}, @code{iswpunct},
10875 @code{iswspace}, @code{iswupper}, @code{iswxdigit}, @code{towlower} and
10876 @code{towupper}
10877 are handled as built-in functions
10878 except in strict ISO C90 mode (@option{-ansi} or @option{-std=c90}).
10880 The ISO C90 functions
10881 @code{abort}, @code{abs}, @code{acos}, @code{asin}, @code{atan2},
10882 @code{atan}, @code{calloc}, @code{ceil}, @code{cosh}, @code{cos},
10883 @code{exit}, @code{exp}, @code{fabs}, @code{floor}, @code{fmod},
10884 @code{fprintf}, @code{fputs}, @code{frexp}, @code{fscanf},
10885 @code{isalnum}, @code{isalpha}, @code{iscntrl}, @code{isdigit},
10886 @code{isgraph}, @code{islower}, @code{isprint}, @code{ispunct},
10887 @code{isspace}, @code{isupper}, @code{isxdigit}, @code{tolower},
10888 @code{toupper}, @code{labs}, @code{ldexp}, @code{log10}, @code{log},
10889 @code{malloc}, @code{memchr}, @code{memcmp}, @code{memcpy},
10890 @code{memset}, @code{modf}, @code{pow}, @code{printf}, @code{putchar},
10891 @code{puts}, @code{scanf}, @code{sinh}, @code{sin}, @code{snprintf},
10892 @code{sprintf}, @code{sqrt}, @code{sscanf}, @code{strcat},
10893 @code{strchr}, @code{strcmp}, @code{strcpy}, @code{strcspn},
10894 @code{strlen}, @code{strncat}, @code{strncmp}, @code{strncpy},
10895 @code{strpbrk}, @code{strrchr}, @code{strspn}, @code{strstr},
10896 @code{tanh}, @code{tan}, @code{vfprintf}, @code{vprintf} and @code{vsprintf}
10897 are all recognized as built-in functions unless
10898 @option{-fno-builtin} is specified (or @option{-fno-builtin-@var{function}}
10899 is specified for an individual function).  All of these functions have
10900 corresponding versions prefixed with @code{__builtin_}.
10902 GCC provides built-in versions of the ISO C99 floating-point comparison
10903 macros that avoid raising exceptions for unordered operands.  They have
10904 the same names as the standard macros ( @code{isgreater},
10905 @code{isgreaterequal}, @code{isless}, @code{islessequal},
10906 @code{islessgreater}, and @code{isunordered}) , with @code{__builtin_}
10907 prefixed.  We intend for a library implementor to be able to simply
10908 @code{#define} each standard macro to its built-in equivalent.
10909 In the same fashion, GCC provides @code{fpclassify}, @code{isfinite},
10910 @code{isinf_sign}, @code{isnormal} and @code{signbit} built-ins used with
10911 @code{__builtin_} prefixed.  The @code{isinf} and @code{isnan}
10912 built-in functions appear both with and without the @code{__builtin_} prefix.
10914 @deftypefn {Built-in Function} void *__builtin_alloca (size_t size)
10915 The @code{__builtin_alloca} function must be called at block scope.
10916 The function allocates an object @var{size} bytes large on the stack
10917 of the calling function.  The object is aligned on the default stack
10918 alignment boundary for the target determined by the
10919 @code{__BIGGEST_ALIGNMENT__} macro.  The @code{__builtin_alloca}
10920 function returns a pointer to the first byte of the allocated object.
10921 The lifetime of the allocated object ends just before the calling
10922 function returns to its caller.   This is so even when
10923 @code{__builtin_alloca} is called within a nested block.
10925 For example, the following function allocates eight objects of @code{n}
10926 bytes each on the stack, storing a pointer to each in consecutive elements
10927 of the array @code{a}.  It then passes the array to function @code{g}
10928 which can safely use the storage pointed to by each of the array elements.
10930 @smallexample
10931 void f (unsigned n)
10933   void *a [8];
10934   for (int i = 0; i != 8; ++i)
10935     a [i] = __builtin_alloca (n);
10937   g (a, n);   // @r{safe}
10939 @end smallexample
10941 Since the @code{__builtin_alloca} function doesn't validate its argument
10942 it is the responsibility of its caller to make sure the argument doesn't
10943 cause it to exceed the stack size limit.
10944 The @code{__builtin_alloca} function is provided to make it possible to
10945 allocate on the stack arrays of bytes with an upper bound that may be
10946 computed at run time.  Since C99 Variable Length Arrays offer
10947 similar functionality under a portable, more convenient, and safer
10948 interface they are recommended instead, in both C99 and C++ programs
10949 where GCC provides them as an extension.
10950 @xref{Variable Length}, for details.
10952 @end deftypefn
10954 @deftypefn {Built-in Function} void *__builtin_alloca_with_align (size_t size, size_t alignment)
10955 The @code{__builtin_alloca_with_align} function must be called at block
10956 scope.  The function allocates an object @var{size} bytes large on
10957 the stack of the calling function.  The allocated object is aligned on
10958 the boundary specified by the argument @var{alignment} whose unit is given
10959 in bits (not bytes).  The @var{size} argument must be positive and not
10960 exceed the stack size limit.  The @var{alignment} argument must be a constant
10961 integer expression that evaluates to a power of 2 greater than or equal to
10962 @code{CHAR_BIT} and less than some unspecified maximum.  Invocations
10963 with other values are rejected with an error indicating the valid bounds.
10964 The function returns a pointer to the first byte of the allocated object.
10965 The lifetime of the allocated object ends at the end of the block in which
10966 the function was called.  The allocated storage is released no later than
10967 just before the calling function returns to its caller, but may be released
10968 at the end of the block in which the function was called.
10970 For example, in the following function the call to @code{g} is unsafe
10971 because when @code{overalign} is non-zero, the space allocated by
10972 @code{__builtin_alloca_with_align} may have been released at the end
10973 of the @code{if} statement in which it was called.
10975 @smallexample
10976 void f (unsigned n, bool overalign)
10978   void *p;
10979   if (overalign)
10980     p = __builtin_alloca_with_align (n, 64 /* bits */);
10981   else
10982     p = __builtin_alloc (n);
10984   g (p, n);   // @r{unsafe}
10986 @end smallexample
10988 Since the @code{__builtin_alloca_with_align} function doesn't validate its
10989 @var{size} argument it is the responsibility of its caller to make sure
10990 the argument doesn't cause it to exceed the stack size limit.
10991 The @code{__builtin_alloca_with_align} function is provided to make
10992 it possible to allocate on the stack overaligned arrays of bytes with
10993 an upper bound that may be computed at run time.  Since C99
10994 Variable Length Arrays offer the same functionality under
10995 a portable, more convenient, and safer interface they are recommended
10996 instead, in both C99 and C++ programs where GCC provides them as
10997 an extension.  @xref{Variable Length}, for details.
10999 @end deftypefn
11001 @deftypefn {Built-in Function} int __builtin_types_compatible_p (@var{type1}, @var{type2})
11003 You can use the built-in function @code{__builtin_types_compatible_p} to
11004 determine whether two types are the same.
11006 This built-in function returns 1 if the unqualified versions of the
11007 types @var{type1} and @var{type2} (which are types, not expressions) are
11008 compatible, 0 otherwise.  The result of this built-in function can be
11009 used in integer constant expressions.
11011 This built-in function ignores top level qualifiers (e.g., @code{const},
11012 @code{volatile}).  For example, @code{int} is equivalent to @code{const
11013 int}.
11015 The type @code{int[]} and @code{int[5]} are compatible.  On the other
11016 hand, @code{int} and @code{char *} are not compatible, even if the size
11017 of their types, on the particular architecture are the same.  Also, the
11018 amount of pointer indirection is taken into account when determining
11019 similarity.  Consequently, @code{short *} is not similar to
11020 @code{short **}.  Furthermore, two types that are typedefed are
11021 considered compatible if their underlying types are compatible.
11023 An @code{enum} type is not considered to be compatible with another
11024 @code{enum} type even if both are compatible with the same integer
11025 type; this is what the C standard specifies.
11026 For example, @code{enum @{foo, bar@}} is not similar to
11027 @code{enum @{hot, dog@}}.
11029 You typically use this function in code whose execution varies
11030 depending on the arguments' types.  For example:
11032 @smallexample
11033 #define foo(x)                                                  \
11034   (@{                                                           \
11035     typeof (x) tmp = (x);                                       \
11036     if (__builtin_types_compatible_p (typeof (x), long double)) \
11037       tmp = foo_long_double (tmp);                              \
11038     else if (__builtin_types_compatible_p (typeof (x), double)) \
11039       tmp = foo_double (tmp);                                   \
11040     else if (__builtin_types_compatible_p (typeof (x), float))  \
11041       tmp = foo_float (tmp);                                    \
11042     else                                                        \
11043       abort ();                                                 \
11044     tmp;                                                        \
11045   @})
11046 @end smallexample
11048 @emph{Note:} This construct is only available for C@.
11050 @end deftypefn
11052 @deftypefn {Built-in Function} @var{type} __builtin_call_with_static_chain (@var{call_exp}, @var{pointer_exp})
11054 The @var{call_exp} expression must be a function call, and the
11055 @var{pointer_exp} expression must be a pointer.  The @var{pointer_exp}
11056 is passed to the function call in the target's static chain location.
11057 The result of builtin is the result of the function call.
11059 @emph{Note:} This builtin is only available for C@.
11060 This builtin can be used to call Go closures from C.
11062 @end deftypefn
11064 @deftypefn {Built-in Function} @var{type} __builtin_choose_expr (@var{const_exp}, @var{exp1}, @var{exp2})
11066 You can use the built-in function @code{__builtin_choose_expr} to
11067 evaluate code depending on the value of a constant expression.  This
11068 built-in function returns @var{exp1} if @var{const_exp}, which is an
11069 integer constant expression, is nonzero.  Otherwise it returns @var{exp2}.
11071 This built-in function is analogous to the @samp{? :} operator in C,
11072 except that the expression returned has its type unaltered by promotion
11073 rules.  Also, the built-in function does not evaluate the expression
11074 that is not chosen.  For example, if @var{const_exp} evaluates to true,
11075 @var{exp2} is not evaluated even if it has side-effects.
11077 This built-in function can return an lvalue if the chosen argument is an
11078 lvalue.
11080 If @var{exp1} is returned, the return type is the same as @var{exp1}'s
11081 type.  Similarly, if @var{exp2} is returned, its return type is the same
11082 as @var{exp2}.
11084 Example:
11086 @smallexample
11087 #define foo(x)                                                    \
11088   __builtin_choose_expr (                                         \
11089     __builtin_types_compatible_p (typeof (x), double),            \
11090     foo_double (x),                                               \
11091     __builtin_choose_expr (                                       \
11092       __builtin_types_compatible_p (typeof (x), float),           \
11093       foo_float (x),                                              \
11094       /* @r{The void expression results in a compile-time error}  \
11095          @r{when assigning the result to something.}  */          \
11096       (void)0))
11097 @end smallexample
11099 @emph{Note:} This construct is only available for C@.  Furthermore, the
11100 unused expression (@var{exp1} or @var{exp2} depending on the value of
11101 @var{const_exp}) may still generate syntax errors.  This may change in
11102 future revisions.
11104 @end deftypefn
11106 @deftypefn {Built-in Function} @var{type} __builtin_complex (@var{real}, @var{imag})
11108 The built-in function @code{__builtin_complex} is provided for use in
11109 implementing the ISO C11 macros @code{CMPLXF}, @code{CMPLX} and
11110 @code{CMPLXL}.  @var{real} and @var{imag} must have the same type, a
11111 real binary floating-point type, and the result has the corresponding
11112 complex type with real and imaginary parts @var{real} and @var{imag}.
11113 Unlike @samp{@var{real} + I * @var{imag}}, this works even when
11114 infinities, NaNs and negative zeros are involved.
11116 @end deftypefn
11118 @deftypefn {Built-in Function} int __builtin_constant_p (@var{exp})
11119 You can use the built-in function @code{__builtin_constant_p} to
11120 determine if a value is known to be constant at compile time and hence
11121 that GCC can perform constant-folding on expressions involving that
11122 value.  The argument of the function is the value to test.  The function
11123 returns the integer 1 if the argument is known to be a compile-time
11124 constant and 0 if it is not known to be a compile-time constant.  A
11125 return of 0 does not indicate that the value is @emph{not} a constant,
11126 but merely that GCC cannot prove it is a constant with the specified
11127 value of the @option{-O} option.
11129 You typically use this function in an embedded application where
11130 memory is a critical resource.  If you have some complex calculation,
11131 you may want it to be folded if it involves constants, but need to call
11132 a function if it does not.  For example:
11134 @smallexample
11135 #define Scale_Value(X)      \
11136   (__builtin_constant_p (X) \
11137   ? ((X) * SCALE + OFFSET) : Scale (X))
11138 @end smallexample
11140 You may use this built-in function in either a macro or an inline
11141 function.  However, if you use it in an inlined function and pass an
11142 argument of the function as the argument to the built-in, GCC 
11143 never returns 1 when you call the inline function with a string constant
11144 or compound literal (@pxref{Compound Literals}) and does not return 1
11145 when you pass a constant numeric value to the inline function unless you
11146 specify the @option{-O} option.
11148 You may also use @code{__builtin_constant_p} in initializers for static
11149 data.  For instance, you can write
11151 @smallexample
11152 static const int table[] = @{
11153    __builtin_constant_p (EXPRESSION) ? (EXPRESSION) : -1,
11154    /* @r{@dots{}} */
11156 @end smallexample
11158 @noindent
11159 This is an acceptable initializer even if @var{EXPRESSION} is not a
11160 constant expression, including the case where
11161 @code{__builtin_constant_p} returns 1 because @var{EXPRESSION} can be
11162 folded to a constant but @var{EXPRESSION} contains operands that are
11163 not otherwise permitted in a static initializer (for example,
11164 @code{0 && foo ()}).  GCC must be more conservative about evaluating the
11165 built-in in this case, because it has no opportunity to perform
11166 optimization.
11167 @end deftypefn
11169 @deftypefn {Built-in Function} long __builtin_expect (long @var{exp}, long @var{c})
11170 @opindex fprofile-arcs
11171 You may use @code{__builtin_expect} to provide the compiler with
11172 branch prediction information.  In general, you should prefer to
11173 use actual profile feedback for this (@option{-fprofile-arcs}), as
11174 programmers are notoriously bad at predicting how their programs
11175 actually perform.  However, there are applications in which this
11176 data is hard to collect.
11178 The return value is the value of @var{exp}, which should be an integral
11179 expression.  The semantics of the built-in are that it is expected that
11180 @var{exp} == @var{c}.  For example:
11182 @smallexample
11183 if (__builtin_expect (x, 0))
11184   foo ();
11185 @end smallexample
11187 @noindent
11188 indicates that we do not expect to call @code{foo}, since
11189 we expect @code{x} to be zero.  Since you are limited to integral
11190 expressions for @var{exp}, you should use constructions such as
11192 @smallexample
11193 if (__builtin_expect (ptr != NULL, 1))
11194   foo (*ptr);
11195 @end smallexample
11197 @noindent
11198 when testing pointer or floating-point values.
11199 @end deftypefn
11201 @deftypefn {Built-in Function} void __builtin_trap (void)
11202 This function causes the program to exit abnormally.  GCC implements
11203 this function by using a target-dependent mechanism (such as
11204 intentionally executing an illegal instruction) or by calling
11205 @code{abort}.  The mechanism used may vary from release to release so
11206 you should not rely on any particular implementation.
11207 @end deftypefn
11209 @deftypefn {Built-in Function} void __builtin_unreachable (void)
11210 If control flow reaches the point of the @code{__builtin_unreachable},
11211 the program is undefined.  It is useful in situations where the
11212 compiler cannot deduce the unreachability of the code.
11214 One such case is immediately following an @code{asm} statement that
11215 either never terminates, or one that transfers control elsewhere
11216 and never returns.  In this example, without the
11217 @code{__builtin_unreachable}, GCC issues a warning that control
11218 reaches the end of a non-void function.  It also generates code
11219 to return after the @code{asm}.
11221 @smallexample
11222 int f (int c, int v)
11224   if (c)
11225     @{
11226       return v;
11227     @}
11228   else
11229     @{
11230       asm("jmp error_handler");
11231       __builtin_unreachable ();
11232     @}
11234 @end smallexample
11236 @noindent
11237 Because the @code{asm} statement unconditionally transfers control out
11238 of the function, control never reaches the end of the function
11239 body.  The @code{__builtin_unreachable} is in fact unreachable and
11240 communicates this fact to the compiler.
11242 Another use for @code{__builtin_unreachable} is following a call a
11243 function that never returns but that is not declared
11244 @code{__attribute__((noreturn))}, as in this example:
11246 @smallexample
11247 void function_that_never_returns (void);
11249 int g (int c)
11251   if (c)
11252     @{
11253       return 1;
11254     @}
11255   else
11256     @{
11257       function_that_never_returns ();
11258       __builtin_unreachable ();
11259     @}
11261 @end smallexample
11263 @end deftypefn
11265 @deftypefn {Built-in Function} {void *} __builtin_assume_aligned (const void *@var{exp}, size_t @var{align}, ...)
11266 This function returns its first argument, and allows the compiler
11267 to assume that the returned pointer is at least @var{align} bytes
11268 aligned.  This built-in can have either two or three arguments,
11269 if it has three, the third argument should have integer type, and
11270 if it is nonzero means misalignment offset.  For example:
11272 @smallexample
11273 void *x = __builtin_assume_aligned (arg, 16);
11274 @end smallexample
11276 @noindent
11277 means that the compiler can assume @code{x}, set to @code{arg}, is at least
11278 16-byte aligned, while:
11280 @smallexample
11281 void *x = __builtin_assume_aligned (arg, 32, 8);
11282 @end smallexample
11284 @noindent
11285 means that the compiler can assume for @code{x}, set to @code{arg}, that
11286 @code{(char *) x - 8} is 32-byte aligned.
11287 @end deftypefn
11289 @deftypefn {Built-in Function} int __builtin_LINE ()
11290 This function is the equivalent of the preprocessor @code{__LINE__}
11291 macro and returns a constant integer expression that evaluates to
11292 the line number of the invocation of the built-in.  When used as a C++
11293 default argument for a function @var{F}, it returns the line number
11294 of the call to @var{F}.
11295 @end deftypefn
11297 @deftypefn {Built-in Function} {const char *} __builtin_FUNCTION ()
11298 This function is the equivalent of the @code{__FUNCTION__} symbol
11299 and returns an address constant pointing to the name of the function
11300 from which the built-in was invoked, or the empty string if
11301 the invocation is not at function scope.  When used as a C++ default
11302 argument for a function @var{F}, it returns the name of @var{F}'s
11303 caller or the empty string if the call was not made at function
11304 scope.
11305 @end deftypefn
11307 @deftypefn {Built-in Function} {const char *} __builtin_FILE ()
11308 This function is the equivalent of the preprocessor @code{__FILE__}
11309 macro and returns an address constant pointing to the file name
11310 containing the invocation of the built-in, or the empty string if
11311 the invocation is not at function scope.  When used as a C++ default
11312 argument for a function @var{F}, it returns the file name of the call
11313 to @var{F} or the empty string if the call was not made at function
11314 scope.
11316 For example, in the following, each call to function @code{foo} will
11317 print a line similar to @code{"file.c:123: foo: message"} with the name
11318 of the file and the line number of the @code{printf} call, the name of
11319 the function @code{foo}, followed by the word @code{message}.
11321 @smallexample
11322 const char*
11323 function (const char *func = __builtin_FUNCTION ())
11325   return func;
11328 void foo (void)
11330   printf ("%s:%i: %s: message\n", file (), line (), function ());
11332 @end smallexample
11334 @end deftypefn
11336 @deftypefn {Built-in Function} void __builtin___clear_cache (char *@var{begin}, char *@var{end})
11337 This function is used to flush the processor's instruction cache for
11338 the region of memory between @var{begin} inclusive and @var{end}
11339 exclusive.  Some targets require that the instruction cache be
11340 flushed, after modifying memory containing code, in order to obtain
11341 deterministic behavior.
11343 If the target does not require instruction cache flushes,
11344 @code{__builtin___clear_cache} has no effect.  Otherwise either
11345 instructions are emitted in-line to clear the instruction cache or a
11346 call to the @code{__clear_cache} function in libgcc is made.
11347 @end deftypefn
11349 @deftypefn {Built-in Function} void __builtin_prefetch (const void *@var{addr}, ...)
11350 This function is used to minimize cache-miss latency by moving data into
11351 a cache before it is accessed.
11352 You can insert calls to @code{__builtin_prefetch} into code for which
11353 you know addresses of data in memory that is likely to be accessed soon.
11354 If the target supports them, data prefetch instructions are generated.
11355 If the prefetch is done early enough before the access then the data will
11356 be in the cache by the time it is accessed.
11358 The value of @var{addr} is the address of the memory to prefetch.
11359 There are two optional arguments, @var{rw} and @var{locality}.
11360 The value of @var{rw} is a compile-time constant one or zero; one
11361 means that the prefetch is preparing for a write to the memory address
11362 and zero, the default, means that the prefetch is preparing for a read.
11363 The value @var{locality} must be a compile-time constant integer between
11364 zero and three.  A value of zero means that the data has no temporal
11365 locality, so it need not be left in the cache after the access.  A value
11366 of three means that the data has a high degree of temporal locality and
11367 should be left in all levels of cache possible.  Values of one and two
11368 mean, respectively, a low or moderate degree of temporal locality.  The
11369 default is three.
11371 @smallexample
11372 for (i = 0; i < n; i++)
11373   @{
11374     a[i] = a[i] + b[i];
11375     __builtin_prefetch (&a[i+j], 1, 1);
11376     __builtin_prefetch (&b[i+j], 0, 1);
11377     /* @r{@dots{}} */
11378   @}
11379 @end smallexample
11381 Data prefetch does not generate faults if @var{addr} is invalid, but
11382 the address expression itself must be valid.  For example, a prefetch
11383 of @code{p->next} does not fault if @code{p->next} is not a valid
11384 address, but evaluation faults if @code{p} is not a valid address.
11386 If the target does not support data prefetch, the address expression
11387 is evaluated if it includes side effects but no other code is generated
11388 and GCC does not issue a warning.
11389 @end deftypefn
11391 @deftypefn {Built-in Function} double __builtin_huge_val (void)
11392 Returns a positive infinity, if supported by the floating-point format,
11393 else @code{DBL_MAX}.  This function is suitable for implementing the
11394 ISO C macro @code{HUGE_VAL}.
11395 @end deftypefn
11397 @deftypefn {Built-in Function} float __builtin_huge_valf (void)
11398 Similar to @code{__builtin_huge_val}, except the return type is @code{float}.
11399 @end deftypefn
11401 @deftypefn {Built-in Function} {long double} __builtin_huge_vall (void)
11402 Similar to @code{__builtin_huge_val}, except the return
11403 type is @code{long double}.
11404 @end deftypefn
11406 @deftypefn {Built-in Function} _Float@var{n} __builtin_huge_valf@var{n} (void)
11407 Similar to @code{__builtin_huge_val}, except the return type is
11408 @code{_Float@var{n}}.
11409 @end deftypefn
11411 @deftypefn {Built-in Function} _Float@var{n}x __builtin_huge_valf@var{n}x (void)
11412 Similar to @code{__builtin_huge_val}, except the return type is
11413 @code{_Float@var{n}x}.
11414 @end deftypefn
11416 @deftypefn {Built-in Function} int __builtin_fpclassify (int, int, int, int, int, ...)
11417 This built-in implements the C99 fpclassify functionality.  The first
11418 five int arguments should be the target library's notion of the
11419 possible FP classes and are used for return values.  They must be
11420 constant values and they must appear in this order: @code{FP_NAN},
11421 @code{FP_INFINITE}, @code{FP_NORMAL}, @code{FP_SUBNORMAL} and
11422 @code{FP_ZERO}.  The ellipsis is for exactly one floating-point value
11423 to classify.  GCC treats the last argument as type-generic, which
11424 means it does not do default promotion from float to double.
11425 @end deftypefn
11427 @deftypefn {Built-in Function} double __builtin_inf (void)
11428 Similar to @code{__builtin_huge_val}, except a warning is generated
11429 if the target floating-point format does not support infinities.
11430 @end deftypefn
11432 @deftypefn {Built-in Function} _Decimal32 __builtin_infd32 (void)
11433 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal32}.
11434 @end deftypefn
11436 @deftypefn {Built-in Function} _Decimal64 __builtin_infd64 (void)
11437 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal64}.
11438 @end deftypefn
11440 @deftypefn {Built-in Function} _Decimal128 __builtin_infd128 (void)
11441 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal128}.
11442 @end deftypefn
11444 @deftypefn {Built-in Function} float __builtin_inff (void)
11445 Similar to @code{__builtin_inf}, except the return type is @code{float}.
11446 This function is suitable for implementing the ISO C99 macro @code{INFINITY}.
11447 @end deftypefn
11449 @deftypefn {Built-in Function} {long double} __builtin_infl (void)
11450 Similar to @code{__builtin_inf}, except the return
11451 type is @code{long double}.
11452 @end deftypefn
11454 @deftypefn {Built-in Function} _Float@var{n} __builtin_inff@var{n} (void)
11455 Similar to @code{__builtin_inf}, except the return
11456 type is @code{_Float@var{n}}.
11457 @end deftypefn
11459 @deftypefn {Built-in Function} _Float@var{n} __builtin_inff@var{n}x (void)
11460 Similar to @code{__builtin_inf}, except the return
11461 type is @code{_Float@var{n}x}.
11462 @end deftypefn
11464 @deftypefn {Built-in Function} int __builtin_isinf_sign (...)
11465 Similar to @code{isinf}, except the return value is -1 for
11466 an argument of @code{-Inf} and 1 for an argument of @code{+Inf}.
11467 Note while the parameter list is an
11468 ellipsis, this function only accepts exactly one floating-point
11469 argument.  GCC treats this parameter as type-generic, which means it
11470 does not do default promotion from float to double.
11471 @end deftypefn
11473 @deftypefn {Built-in Function} double __builtin_nan (const char *str)
11474 This is an implementation of the ISO C99 function @code{nan}.
11476 Since ISO C99 defines this function in terms of @code{strtod}, which we
11477 do not implement, a description of the parsing is in order.  The string
11478 is parsed as by @code{strtol}; that is, the base is recognized by
11479 leading @samp{0} or @samp{0x} prefixes.  The number parsed is placed
11480 in the significand such that the least significant bit of the number
11481 is at the least significant bit of the significand.  The number is
11482 truncated to fit the significand field provided.  The significand is
11483 forced to be a quiet NaN@.
11485 This function, if given a string literal all of which would have been
11486 consumed by @code{strtol}, is evaluated early enough that it is considered a
11487 compile-time constant.
11488 @end deftypefn
11490 @deftypefn {Built-in Function} _Decimal32 __builtin_nand32 (const char *str)
11491 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal32}.
11492 @end deftypefn
11494 @deftypefn {Built-in Function} _Decimal64 __builtin_nand64 (const char *str)
11495 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal64}.
11496 @end deftypefn
11498 @deftypefn {Built-in Function} _Decimal128 __builtin_nand128 (const char *str)
11499 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal128}.
11500 @end deftypefn
11502 @deftypefn {Built-in Function} float __builtin_nanf (const char *str)
11503 Similar to @code{__builtin_nan}, except the return type is @code{float}.
11504 @end deftypefn
11506 @deftypefn {Built-in Function} {long double} __builtin_nanl (const char *str)
11507 Similar to @code{__builtin_nan}, except the return type is @code{long double}.
11508 @end deftypefn
11510 @deftypefn {Built-in Function} _Float@var{n} __builtin_nanf@var{n} (const char *str)
11511 Similar to @code{__builtin_nan}, except the return type is
11512 @code{_Float@var{n}}.
11513 @end deftypefn
11515 @deftypefn {Built-in Function} _Float@var{n}x __builtin_nanf@var{n}x (const char *str)
11516 Similar to @code{__builtin_nan}, except the return type is
11517 @code{_Float@var{n}x}.
11518 @end deftypefn
11520 @deftypefn {Built-in Function} double __builtin_nans (const char *str)
11521 Similar to @code{__builtin_nan}, except the significand is forced
11522 to be a signaling NaN@.  The @code{nans} function is proposed by
11523 @uref{http://www.open-std.org/jtc1/sc22/wg14/www/docs/n965.htm,,WG14 N965}.
11524 @end deftypefn
11526 @deftypefn {Built-in Function} float __builtin_nansf (const char *str)
11527 Similar to @code{__builtin_nans}, except the return type is @code{float}.
11528 @end deftypefn
11530 @deftypefn {Built-in Function} {long double} __builtin_nansl (const char *str)
11531 Similar to @code{__builtin_nans}, except the return type is @code{long double}.
11532 @end deftypefn
11534 @deftypefn {Built-in Function} _Float@var{n} __builtin_nansf@var{n} (const char *str)
11535 Similar to @code{__builtin_nans}, except the return type is
11536 @code{_Float@var{n}}.
11537 @end deftypefn
11539 @deftypefn {Built-in Function} _Float@var{n}x __builtin_nansf@var{n}x (const char *str)
11540 Similar to @code{__builtin_nans}, except the return type is
11541 @code{_Float@var{n}x}.
11542 @end deftypefn
11544 @deftypefn {Built-in Function} int __builtin_ffs (int x)
11545 Returns one plus the index of the least significant 1-bit of @var{x}, or
11546 if @var{x} is zero, returns zero.
11547 @end deftypefn
11549 @deftypefn {Built-in Function} int __builtin_clz (unsigned int x)
11550 Returns the number of leading 0-bits in @var{x}, starting at the most
11551 significant bit position.  If @var{x} is 0, the result is undefined.
11552 @end deftypefn
11554 @deftypefn {Built-in Function} int __builtin_ctz (unsigned int x)
11555 Returns the number of trailing 0-bits in @var{x}, starting at the least
11556 significant bit position.  If @var{x} is 0, the result is undefined.
11557 @end deftypefn
11559 @deftypefn {Built-in Function} int __builtin_clrsb (int x)
11560 Returns the number of leading redundant sign bits in @var{x}, i.e.@: the
11561 number of bits following the most significant bit that are identical
11562 to it.  There are no special cases for 0 or other values. 
11563 @end deftypefn
11565 @deftypefn {Built-in Function} int __builtin_popcount (unsigned int x)
11566 Returns the number of 1-bits in @var{x}.
11567 @end deftypefn
11569 @deftypefn {Built-in Function} int __builtin_parity (unsigned int x)
11570 Returns the parity of @var{x}, i.e.@: the number of 1-bits in @var{x}
11571 modulo 2.
11572 @end deftypefn
11574 @deftypefn {Built-in Function} int __builtin_ffsl (long)
11575 Similar to @code{__builtin_ffs}, except the argument type is
11576 @code{long}.
11577 @end deftypefn
11579 @deftypefn {Built-in Function} int __builtin_clzl (unsigned long)
11580 Similar to @code{__builtin_clz}, except the argument type is
11581 @code{unsigned long}.
11582 @end deftypefn
11584 @deftypefn {Built-in Function} int __builtin_ctzl (unsigned long)
11585 Similar to @code{__builtin_ctz}, except the argument type is
11586 @code{unsigned long}.
11587 @end deftypefn
11589 @deftypefn {Built-in Function} int __builtin_clrsbl (long)
11590 Similar to @code{__builtin_clrsb}, except the argument type is
11591 @code{long}.
11592 @end deftypefn
11594 @deftypefn {Built-in Function} int __builtin_popcountl (unsigned long)
11595 Similar to @code{__builtin_popcount}, except the argument type is
11596 @code{unsigned long}.
11597 @end deftypefn
11599 @deftypefn {Built-in Function} int __builtin_parityl (unsigned long)
11600 Similar to @code{__builtin_parity}, except the argument type is
11601 @code{unsigned long}.
11602 @end deftypefn
11604 @deftypefn {Built-in Function} int __builtin_ffsll (long long)
11605 Similar to @code{__builtin_ffs}, except the argument type is
11606 @code{long long}.
11607 @end deftypefn
11609 @deftypefn {Built-in Function} int __builtin_clzll (unsigned long long)
11610 Similar to @code{__builtin_clz}, except the argument type is
11611 @code{unsigned long long}.
11612 @end deftypefn
11614 @deftypefn {Built-in Function} int __builtin_ctzll (unsigned long long)
11615 Similar to @code{__builtin_ctz}, except the argument type is
11616 @code{unsigned long long}.
11617 @end deftypefn
11619 @deftypefn {Built-in Function} int __builtin_clrsbll (long long)
11620 Similar to @code{__builtin_clrsb}, except the argument type is
11621 @code{long long}.
11622 @end deftypefn
11624 @deftypefn {Built-in Function} int __builtin_popcountll (unsigned long long)
11625 Similar to @code{__builtin_popcount}, except the argument type is
11626 @code{unsigned long long}.
11627 @end deftypefn
11629 @deftypefn {Built-in Function} int __builtin_parityll (unsigned long long)
11630 Similar to @code{__builtin_parity}, except the argument type is
11631 @code{unsigned long long}.
11632 @end deftypefn
11634 @deftypefn {Built-in Function} double __builtin_powi (double, int)
11635 Returns the first argument raised to the power of the second.  Unlike the
11636 @code{pow} function no guarantees about precision and rounding are made.
11637 @end deftypefn
11639 @deftypefn {Built-in Function} float __builtin_powif (float, int)
11640 Similar to @code{__builtin_powi}, except the argument and return types
11641 are @code{float}.
11642 @end deftypefn
11644 @deftypefn {Built-in Function} {long double} __builtin_powil (long double, int)
11645 Similar to @code{__builtin_powi}, except the argument and return types
11646 are @code{long double}.
11647 @end deftypefn
11649 @deftypefn {Built-in Function} uint16_t __builtin_bswap16 (uint16_t x)
11650 Returns @var{x} with the order of the bytes reversed; for example,
11651 @code{0xaabb} becomes @code{0xbbaa}.  Byte here always means
11652 exactly 8 bits.
11653 @end deftypefn
11655 @deftypefn {Built-in Function} uint32_t __builtin_bswap32 (uint32_t x)
11656 Similar to @code{__builtin_bswap16}, except the argument and return types
11657 are 32 bit.
11658 @end deftypefn
11660 @deftypefn {Built-in Function} uint64_t __builtin_bswap64 (uint64_t x)
11661 Similar to @code{__builtin_bswap32}, except the argument and return types
11662 are 64 bit.
11663 @end deftypefn
11665 @node Target Builtins
11666 @section Built-in Functions Specific to Particular Target Machines
11668 On some target machines, GCC supports many built-in functions specific
11669 to those machines.  Generally these generate calls to specific machine
11670 instructions, but allow the compiler to schedule those calls.
11672 @menu
11673 * AArch64 Built-in Functions::
11674 * Alpha Built-in Functions::
11675 * Altera Nios II Built-in Functions::
11676 * ARC Built-in Functions::
11677 * ARC SIMD Built-in Functions::
11678 * ARM iWMMXt Built-in Functions::
11679 * ARM C Language Extensions (ACLE)::
11680 * ARM Floating Point Status and Control Intrinsics::
11681 * AVR Built-in Functions::
11682 * Blackfin Built-in Functions::
11683 * FR-V Built-in Functions::
11684 * MIPS DSP Built-in Functions::
11685 * MIPS Paired-Single Support::
11686 * MIPS Loongson Built-in Functions::
11687 * MIPS SIMD Architecture (MSA) Support::
11688 * Other MIPS Built-in Functions::
11689 * MSP430 Built-in Functions::
11690 * NDS32 Built-in Functions::
11691 * picoChip Built-in Functions::
11692 * PowerPC Built-in Functions::
11693 * PowerPC AltiVec/VSX Built-in Functions::
11694 * PowerPC Hardware Transactional Memory Built-in Functions::
11695 * RX Built-in Functions::
11696 * S/390 System z Built-in Functions::
11697 * SH Built-in Functions::
11698 * SPARC VIS Built-in Functions::
11699 * SPU Built-in Functions::
11700 * TI C6X Built-in Functions::
11701 * TILE-Gx Built-in Functions::
11702 * TILEPro Built-in Functions::
11703 * x86 Built-in Functions::
11704 * x86 transactional memory intrinsics::
11705 @end menu
11707 @node AArch64 Built-in Functions
11708 @subsection AArch64 Built-in Functions
11710 These built-in functions are available for the AArch64 family of
11711 processors.
11712 @smallexample
11713 unsigned int __builtin_aarch64_get_fpcr ()
11714 void __builtin_aarch64_set_fpcr (unsigned int)
11715 unsigned int __builtin_aarch64_get_fpsr ()
11716 void __builtin_aarch64_set_fpsr (unsigned int)
11717 @end smallexample
11719 @node Alpha Built-in Functions
11720 @subsection Alpha Built-in Functions
11722 These built-in functions are available for the Alpha family of
11723 processors, depending on the command-line switches used.
11725 The following built-in functions are always available.  They
11726 all generate the machine instruction that is part of the name.
11728 @smallexample
11729 long __builtin_alpha_implver (void)
11730 long __builtin_alpha_rpcc (void)
11731 long __builtin_alpha_amask (long)
11732 long __builtin_alpha_cmpbge (long, long)
11733 long __builtin_alpha_extbl (long, long)
11734 long __builtin_alpha_extwl (long, long)
11735 long __builtin_alpha_extll (long, long)
11736 long __builtin_alpha_extql (long, long)
11737 long __builtin_alpha_extwh (long, long)
11738 long __builtin_alpha_extlh (long, long)
11739 long __builtin_alpha_extqh (long, long)
11740 long __builtin_alpha_insbl (long, long)
11741 long __builtin_alpha_inswl (long, long)
11742 long __builtin_alpha_insll (long, long)
11743 long __builtin_alpha_insql (long, long)
11744 long __builtin_alpha_inswh (long, long)
11745 long __builtin_alpha_inslh (long, long)
11746 long __builtin_alpha_insqh (long, long)
11747 long __builtin_alpha_mskbl (long, long)
11748 long __builtin_alpha_mskwl (long, long)
11749 long __builtin_alpha_mskll (long, long)
11750 long __builtin_alpha_mskql (long, long)
11751 long __builtin_alpha_mskwh (long, long)
11752 long __builtin_alpha_msklh (long, long)
11753 long __builtin_alpha_mskqh (long, long)
11754 long __builtin_alpha_umulh (long, long)
11755 long __builtin_alpha_zap (long, long)
11756 long __builtin_alpha_zapnot (long, long)
11757 @end smallexample
11759 The following built-in functions are always with @option{-mmax}
11760 or @option{-mcpu=@var{cpu}} where @var{cpu} is @code{pca56} or
11761 later.  They all generate the machine instruction that is part
11762 of the name.
11764 @smallexample
11765 long __builtin_alpha_pklb (long)
11766 long __builtin_alpha_pkwb (long)
11767 long __builtin_alpha_unpkbl (long)
11768 long __builtin_alpha_unpkbw (long)
11769 long __builtin_alpha_minub8 (long, long)
11770 long __builtin_alpha_minsb8 (long, long)
11771 long __builtin_alpha_minuw4 (long, long)
11772 long __builtin_alpha_minsw4 (long, long)
11773 long __builtin_alpha_maxub8 (long, long)
11774 long __builtin_alpha_maxsb8 (long, long)
11775 long __builtin_alpha_maxuw4 (long, long)
11776 long __builtin_alpha_maxsw4 (long, long)
11777 long __builtin_alpha_perr (long, long)
11778 @end smallexample
11780 The following built-in functions are always with @option{-mcix}
11781 or @option{-mcpu=@var{cpu}} where @var{cpu} is @code{ev67} or
11782 later.  They all generate the machine instruction that is part
11783 of the name.
11785 @smallexample
11786 long __builtin_alpha_cttz (long)
11787 long __builtin_alpha_ctlz (long)
11788 long __builtin_alpha_ctpop (long)
11789 @end smallexample
11791 The following built-in functions are available on systems that use the OSF/1
11792 PALcode.  Normally they invoke the @code{rduniq} and @code{wruniq}
11793 PAL calls, but when invoked with @option{-mtls-kernel}, they invoke
11794 @code{rdval} and @code{wrval}.
11796 @smallexample
11797 void *__builtin_thread_pointer (void)
11798 void __builtin_set_thread_pointer (void *)
11799 @end smallexample
11801 @node Altera Nios II Built-in Functions
11802 @subsection Altera Nios II Built-in Functions
11804 These built-in functions are available for the Altera Nios II
11805 family of processors.
11807 The following built-in functions are always available.  They
11808 all generate the machine instruction that is part of the name.
11810 @example
11811 int __builtin_ldbio (volatile const void *)
11812 int __builtin_ldbuio (volatile const void *)
11813 int __builtin_ldhio (volatile const void *)
11814 int __builtin_ldhuio (volatile const void *)
11815 int __builtin_ldwio (volatile const void *)
11816 void __builtin_stbio (volatile void *, int)
11817 void __builtin_sthio (volatile void *, int)
11818 void __builtin_stwio (volatile void *, int)
11819 void __builtin_sync (void)
11820 int __builtin_rdctl (int) 
11821 int __builtin_rdprs (int, int)
11822 void __builtin_wrctl (int, int)
11823 void __builtin_flushd (volatile void *)
11824 void __builtin_flushda (volatile void *)
11825 int __builtin_wrpie (int);
11826 void __builtin_eni (int);
11827 int __builtin_ldex (volatile const void *)
11828 int __builtin_stex (volatile void *, int)
11829 int __builtin_ldsex (volatile const void *)
11830 int __builtin_stsex (volatile void *, int)
11831 @end example
11833 The following built-in functions are always available.  They
11834 all generate a Nios II Custom Instruction. The name of the
11835 function represents the types that the function takes and
11836 returns. The letter before the @code{n} is the return type
11837 or void if absent. The @code{n} represents the first parameter
11838 to all the custom instructions, the custom instruction number.
11839 The two letters after the @code{n} represent the up to two
11840 parameters to the function.
11842 The letters represent the following data types:
11843 @table @code
11844 @item <no letter>
11845 @code{void} for return type and no parameter for parameter types.
11847 @item i
11848 @code{int} for return type and parameter type
11850 @item f
11851 @code{float} for return type and parameter type
11853 @item p
11854 @code{void *} for return type and parameter type
11856 @end table
11858 And the function names are:
11859 @example
11860 void __builtin_custom_n (void)
11861 void __builtin_custom_ni (int)
11862 void __builtin_custom_nf (float)
11863 void __builtin_custom_np (void *)
11864 void __builtin_custom_nii (int, int)
11865 void __builtin_custom_nif (int, float)
11866 void __builtin_custom_nip (int, void *)
11867 void __builtin_custom_nfi (float, int)
11868 void __builtin_custom_nff (float, float)
11869 void __builtin_custom_nfp (float, void *)
11870 void __builtin_custom_npi (void *, int)
11871 void __builtin_custom_npf (void *, float)
11872 void __builtin_custom_npp (void *, void *)
11873 int __builtin_custom_in (void)
11874 int __builtin_custom_ini (int)
11875 int __builtin_custom_inf (float)
11876 int __builtin_custom_inp (void *)
11877 int __builtin_custom_inii (int, int)
11878 int __builtin_custom_inif (int, float)
11879 int __builtin_custom_inip (int, void *)
11880 int __builtin_custom_infi (float, int)
11881 int __builtin_custom_inff (float, float)
11882 int __builtin_custom_infp (float, void *)
11883 int __builtin_custom_inpi (void *, int)
11884 int __builtin_custom_inpf (void *, float)
11885 int __builtin_custom_inpp (void *, void *)
11886 float __builtin_custom_fn (void)
11887 float __builtin_custom_fni (int)
11888 float __builtin_custom_fnf (float)
11889 float __builtin_custom_fnp (void *)
11890 float __builtin_custom_fnii (int, int)
11891 float __builtin_custom_fnif (int, float)
11892 float __builtin_custom_fnip (int, void *)
11893 float __builtin_custom_fnfi (float, int)
11894 float __builtin_custom_fnff (float, float)
11895 float __builtin_custom_fnfp (float, void *)
11896 float __builtin_custom_fnpi (void *, int)
11897 float __builtin_custom_fnpf (void *, float)
11898 float __builtin_custom_fnpp (void *, void *)
11899 void * __builtin_custom_pn (void)
11900 void * __builtin_custom_pni (int)
11901 void * __builtin_custom_pnf (float)
11902 void * __builtin_custom_pnp (void *)
11903 void * __builtin_custom_pnii (int, int)
11904 void * __builtin_custom_pnif (int, float)
11905 void * __builtin_custom_pnip (int, void *)
11906 void * __builtin_custom_pnfi (float, int)
11907 void * __builtin_custom_pnff (float, float)
11908 void * __builtin_custom_pnfp (float, void *)
11909 void * __builtin_custom_pnpi (void *, int)
11910 void * __builtin_custom_pnpf (void *, float)
11911 void * __builtin_custom_pnpp (void *, void *)
11912 @end example
11914 @node ARC Built-in Functions
11915 @subsection ARC Built-in Functions
11917 The following built-in functions are provided for ARC targets.  The
11918 built-ins generate the corresponding assembly instructions.  In the
11919 examples given below, the generated code often requires an operand or
11920 result to be in a register.  Where necessary further code will be
11921 generated to ensure this is true, but for brevity this is not
11922 described in each case.
11924 @emph{Note:} Using a built-in to generate an instruction not supported
11925 by a target may cause problems. At present the compiler is not
11926 guaranteed to detect such misuse, and as a result an internal compiler
11927 error may be generated.
11929 @deftypefn {Built-in Function} int __builtin_arc_aligned (void *@var{val}, int @var{alignval})
11930 Return 1 if @var{val} is known to have the byte alignment given
11931 by @var{alignval}, otherwise return 0.
11932 Note that this is different from
11933 @smallexample
11934 __alignof__(*(char *)@var{val}) >= alignval
11935 @end smallexample
11936 because __alignof__ sees only the type of the dereference, whereas
11937 __builtin_arc_align uses alignment information from the pointer
11938 as well as from the pointed-to type.
11939 The information available will depend on optimization level.
11940 @end deftypefn
11942 @deftypefn {Built-in Function} void __builtin_arc_brk (void)
11943 Generates
11944 @example
11946 @end example
11947 @end deftypefn
11949 @deftypefn {Built-in Function} {unsigned int} __builtin_arc_core_read (unsigned int @var{regno})
11950 The operand is the number of a register to be read.  Generates:
11951 @example
11952 mov  @var{dest}, r@var{regno}
11953 @end example
11954 where the value in @var{dest} will be the result returned from the
11955 built-in.
11956 @end deftypefn
11958 @deftypefn {Built-in Function} void __builtin_arc_core_write (unsigned int @var{regno}, unsigned int @var{val})
11959 The first operand is the number of a register to be written, the
11960 second operand is a compile time constant to write into that
11961 register.  Generates:
11962 @example
11963 mov  r@var{regno}, @var{val}
11964 @end example
11965 @end deftypefn
11967 @deftypefn {Built-in Function} int __builtin_arc_divaw (int @var{a}, int @var{b})
11968 Only available if either @option{-mcpu=ARC700} or @option{-meA} is set.
11969 Generates:
11970 @example
11971 divaw  @var{dest}, @var{a}, @var{b}
11972 @end example
11973 where the value in @var{dest} will be the result returned from the
11974 built-in.
11975 @end deftypefn
11977 @deftypefn {Built-in Function} void __builtin_arc_flag (unsigned int @var{a})
11978 Generates
11979 @example
11980 flag  @var{a}
11981 @end example
11982 @end deftypefn
11984 @deftypefn {Built-in Function} {unsigned int} __builtin_arc_lr (unsigned int @var{auxr})
11985 The operand, @var{auxv}, is the address of an auxiliary register and
11986 must be a compile time constant.  Generates:
11987 @example
11988 lr  @var{dest}, [@var{auxr}]
11989 @end example
11990 Where the value in @var{dest} will be the result returned from the
11991 built-in.
11992 @end deftypefn
11994 @deftypefn {Built-in Function} void __builtin_arc_mul64 (int @var{a}, int @var{b})
11995 Only available with @option{-mmul64}.  Generates:
11996 @example
11997 mul64  @var{a}, @var{b}
11998 @end example
11999 @end deftypefn
12001 @deftypefn {Built-in Function} void __builtin_arc_mulu64 (unsigned int @var{a}, unsigned int @var{b})
12002 Only available with @option{-mmul64}.  Generates:
12003 @example
12004 mulu64  @var{a}, @var{b}
12005 @end example
12006 @end deftypefn
12008 @deftypefn {Built-in Function} void __builtin_arc_nop (void)
12009 Generates:
12010 @example
12012 @end example
12013 @end deftypefn
12015 @deftypefn {Built-in Function} int __builtin_arc_norm (int @var{src})
12016 Only valid if the @samp{norm} instruction is available through the
12017 @option{-mnorm} option or by default with @option{-mcpu=ARC700}.
12018 Generates:
12019 @example
12020 norm  @var{dest}, @var{src}
12021 @end example
12022 Where the value in @var{dest} will be the result returned from the
12023 built-in.
12024 @end deftypefn
12026 @deftypefn {Built-in Function}  {short int} __builtin_arc_normw (short int @var{src})
12027 Only valid if the @samp{normw} instruction is available through the
12028 @option{-mnorm} option or by default with @option{-mcpu=ARC700}.
12029 Generates:
12030 @example
12031 normw  @var{dest}, @var{src}
12032 @end example
12033 Where the value in @var{dest} will be the result returned from the
12034 built-in.
12035 @end deftypefn
12037 @deftypefn {Built-in Function}  void __builtin_arc_rtie (void)
12038 Generates:
12039 @example
12040 rtie
12041 @end example
12042 @end deftypefn
12044 @deftypefn {Built-in Function}  void __builtin_arc_sleep (int @var{a}
12045 Generates:
12046 @example
12047 sleep  @var{a}
12048 @end example
12049 @end deftypefn
12051 @deftypefn {Built-in Function}  void __builtin_arc_sr (unsigned int @var{auxr}, unsigned int @var{val})
12052 The first argument, @var{auxv}, is the address of an auxiliary
12053 register, the second argument, @var{val}, is a compile time constant
12054 to be written to the register.  Generates:
12055 @example
12056 sr  @var{auxr}, [@var{val}]
12057 @end example
12058 @end deftypefn
12060 @deftypefn {Built-in Function}  int __builtin_arc_swap (int @var{src})
12061 Only valid with @option{-mswap}.  Generates:
12062 @example
12063 swap  @var{dest}, @var{src}
12064 @end example
12065 Where the value in @var{dest} will be the result returned from the
12066 built-in.
12067 @end deftypefn
12069 @deftypefn {Built-in Function}  void __builtin_arc_swi (void)
12070 Generates:
12071 @example
12073 @end example
12074 @end deftypefn
12076 @deftypefn {Built-in Function}  void __builtin_arc_sync (void)
12077 Only available with @option{-mcpu=ARC700}.  Generates:
12078 @example
12079 sync
12080 @end example
12081 @end deftypefn
12083 @deftypefn {Built-in Function}  void __builtin_arc_trap_s (unsigned int @var{c})
12084 Only available with @option{-mcpu=ARC700}.  Generates:
12085 @example
12086 trap_s  @var{c}
12087 @end example
12088 @end deftypefn
12090 @deftypefn {Built-in Function}  void __builtin_arc_unimp_s (void)
12091 Only available with @option{-mcpu=ARC700}.  Generates:
12092 @example
12093 unimp_s
12094 @end example
12095 @end deftypefn
12097 The instructions generated by the following builtins are not
12098 considered as candidates for scheduling.  They are not moved around by
12099 the compiler during scheduling, and thus can be expected to appear
12100 where they are put in the C code:
12101 @example
12102 __builtin_arc_brk()
12103 __builtin_arc_core_read()
12104 __builtin_arc_core_write()
12105 __builtin_arc_flag()
12106 __builtin_arc_lr()
12107 __builtin_arc_sleep()
12108 __builtin_arc_sr()
12109 __builtin_arc_swi()
12110 @end example
12112 @node ARC SIMD Built-in Functions
12113 @subsection ARC SIMD Built-in Functions
12115 SIMD builtins provided by the compiler can be used to generate the
12116 vector instructions.  This section describes the available builtins
12117 and their usage in programs.  With the @option{-msimd} option, the
12118 compiler provides 128-bit vector types, which can be specified using
12119 the @code{vector_size} attribute.  The header file @file{arc-simd.h}
12120 can be included to use the following predefined types:
12121 @example
12122 typedef int __v4si   __attribute__((vector_size(16)));
12123 typedef short __v8hi __attribute__((vector_size(16)));
12124 @end example
12126 These types can be used to define 128-bit variables.  The built-in
12127 functions listed in the following section can be used on these
12128 variables to generate the vector operations.
12130 For all builtins, @code{__builtin_arc_@var{someinsn}}, the header file
12131 @file{arc-simd.h} also provides equivalent macros called
12132 @code{_@var{someinsn}} that can be used for programming ease and
12133 improved readability.  The following macros for DMA control are also
12134 provided:
12135 @example
12136 #define _setup_dma_in_channel_reg _vdiwr
12137 #define _setup_dma_out_channel_reg _vdowr
12138 @end example
12140 The following is a complete list of all the SIMD built-ins provided
12141 for ARC, grouped by calling signature.
12143 The following take two @code{__v8hi} arguments and return a
12144 @code{__v8hi} result:
12145 @example
12146 __v8hi __builtin_arc_vaddaw (__v8hi, __v8hi)
12147 __v8hi __builtin_arc_vaddw (__v8hi, __v8hi)
12148 __v8hi __builtin_arc_vand (__v8hi, __v8hi)
12149 __v8hi __builtin_arc_vandaw (__v8hi, __v8hi)
12150 __v8hi __builtin_arc_vavb (__v8hi, __v8hi)
12151 __v8hi __builtin_arc_vavrb (__v8hi, __v8hi)
12152 __v8hi __builtin_arc_vbic (__v8hi, __v8hi)
12153 __v8hi __builtin_arc_vbicaw (__v8hi, __v8hi)
12154 __v8hi __builtin_arc_vdifaw (__v8hi, __v8hi)
12155 __v8hi __builtin_arc_vdifw (__v8hi, __v8hi)
12156 __v8hi __builtin_arc_veqw (__v8hi, __v8hi)
12157 __v8hi __builtin_arc_vh264f (__v8hi, __v8hi)
12158 __v8hi __builtin_arc_vh264ft (__v8hi, __v8hi)
12159 __v8hi __builtin_arc_vh264fw (__v8hi, __v8hi)
12160 __v8hi __builtin_arc_vlew (__v8hi, __v8hi)
12161 __v8hi __builtin_arc_vltw (__v8hi, __v8hi)
12162 __v8hi __builtin_arc_vmaxaw (__v8hi, __v8hi)
12163 __v8hi __builtin_arc_vmaxw (__v8hi, __v8hi)
12164 __v8hi __builtin_arc_vminaw (__v8hi, __v8hi)
12165 __v8hi __builtin_arc_vminw (__v8hi, __v8hi)
12166 __v8hi __builtin_arc_vmr1aw (__v8hi, __v8hi)
12167 __v8hi __builtin_arc_vmr1w (__v8hi, __v8hi)
12168 __v8hi __builtin_arc_vmr2aw (__v8hi, __v8hi)
12169 __v8hi __builtin_arc_vmr2w (__v8hi, __v8hi)
12170 __v8hi __builtin_arc_vmr3aw (__v8hi, __v8hi)
12171 __v8hi __builtin_arc_vmr3w (__v8hi, __v8hi)
12172 __v8hi __builtin_arc_vmr4aw (__v8hi, __v8hi)
12173 __v8hi __builtin_arc_vmr4w (__v8hi, __v8hi)
12174 __v8hi __builtin_arc_vmr5aw (__v8hi, __v8hi)
12175 __v8hi __builtin_arc_vmr5w (__v8hi, __v8hi)
12176 __v8hi __builtin_arc_vmr6aw (__v8hi, __v8hi)
12177 __v8hi __builtin_arc_vmr6w (__v8hi, __v8hi)
12178 __v8hi __builtin_arc_vmr7aw (__v8hi, __v8hi)
12179 __v8hi __builtin_arc_vmr7w (__v8hi, __v8hi)
12180 __v8hi __builtin_arc_vmrb (__v8hi, __v8hi)
12181 __v8hi __builtin_arc_vmulaw (__v8hi, __v8hi)
12182 __v8hi __builtin_arc_vmulfaw (__v8hi, __v8hi)
12183 __v8hi __builtin_arc_vmulfw (__v8hi, __v8hi)
12184 __v8hi __builtin_arc_vmulw (__v8hi, __v8hi)
12185 __v8hi __builtin_arc_vnew (__v8hi, __v8hi)
12186 __v8hi __builtin_arc_vor (__v8hi, __v8hi)
12187 __v8hi __builtin_arc_vsubaw (__v8hi, __v8hi)
12188 __v8hi __builtin_arc_vsubw (__v8hi, __v8hi)
12189 __v8hi __builtin_arc_vsummw (__v8hi, __v8hi)
12190 __v8hi __builtin_arc_vvc1f (__v8hi, __v8hi)
12191 __v8hi __builtin_arc_vvc1ft (__v8hi, __v8hi)
12192 __v8hi __builtin_arc_vxor (__v8hi, __v8hi)
12193 __v8hi __builtin_arc_vxoraw (__v8hi, __v8hi)
12194 @end example
12196 The following take one @code{__v8hi} and one @code{int} argument and return a
12197 @code{__v8hi} result:
12199 @example
12200 __v8hi __builtin_arc_vbaddw (__v8hi, int)
12201 __v8hi __builtin_arc_vbmaxw (__v8hi, int)
12202 __v8hi __builtin_arc_vbminw (__v8hi, int)
12203 __v8hi __builtin_arc_vbmulaw (__v8hi, int)
12204 __v8hi __builtin_arc_vbmulfw (__v8hi, int)
12205 __v8hi __builtin_arc_vbmulw (__v8hi, int)
12206 __v8hi __builtin_arc_vbrsubw (__v8hi, int)
12207 __v8hi __builtin_arc_vbsubw (__v8hi, int)
12208 @end example
12210 The following take one @code{__v8hi} argument and one @code{int} argument which
12211 must be a 3-bit compile time constant indicating a register number
12212 I0-I7.  They return a @code{__v8hi} result.
12213 @example
12214 __v8hi __builtin_arc_vasrw (__v8hi, const int)
12215 __v8hi __builtin_arc_vsr8 (__v8hi, const int)
12216 __v8hi __builtin_arc_vsr8aw (__v8hi, const int)
12217 @end example
12219 The following take one @code{__v8hi} argument and one @code{int}
12220 argument which must be a 6-bit compile time constant.  They return a
12221 @code{__v8hi} result.
12222 @example
12223 __v8hi __builtin_arc_vasrpwbi (__v8hi, const int)
12224 __v8hi __builtin_arc_vasrrpwbi (__v8hi, const int)
12225 __v8hi __builtin_arc_vasrrwi (__v8hi, const int)
12226 __v8hi __builtin_arc_vasrsrwi (__v8hi, const int)
12227 __v8hi __builtin_arc_vasrwi (__v8hi, const int)
12228 __v8hi __builtin_arc_vsr8awi (__v8hi, const int)
12229 __v8hi __builtin_arc_vsr8i (__v8hi, const int)
12230 @end example
12232 The following take one @code{__v8hi} argument and one @code{int} argument which
12233 must be a 8-bit compile time constant.  They return a @code{__v8hi}
12234 result.
12235 @example
12236 __v8hi __builtin_arc_vd6tapf (__v8hi, const int)
12237 __v8hi __builtin_arc_vmvaw (__v8hi, const int)
12238 __v8hi __builtin_arc_vmvw (__v8hi, const int)
12239 __v8hi __builtin_arc_vmvzw (__v8hi, const int)
12240 @end example
12242 The following take two @code{int} arguments, the second of which which
12243 must be a 8-bit compile time constant.  They return a @code{__v8hi}
12244 result:
12245 @example
12246 __v8hi __builtin_arc_vmovaw (int, const int)
12247 __v8hi __builtin_arc_vmovw (int, const int)
12248 __v8hi __builtin_arc_vmovzw (int, const int)
12249 @end example
12251 The following take a single @code{__v8hi} argument and return a
12252 @code{__v8hi} result:
12253 @example
12254 __v8hi __builtin_arc_vabsaw (__v8hi)
12255 __v8hi __builtin_arc_vabsw (__v8hi)
12256 __v8hi __builtin_arc_vaddsuw (__v8hi)
12257 __v8hi __builtin_arc_vexch1 (__v8hi)
12258 __v8hi __builtin_arc_vexch2 (__v8hi)
12259 __v8hi __builtin_arc_vexch4 (__v8hi)
12260 __v8hi __builtin_arc_vsignw (__v8hi)
12261 __v8hi __builtin_arc_vupbaw (__v8hi)
12262 __v8hi __builtin_arc_vupbw (__v8hi)
12263 __v8hi __builtin_arc_vupsbaw (__v8hi)
12264 __v8hi __builtin_arc_vupsbw (__v8hi)
12265 @end example
12267 The following take two @code{int} arguments and return no result:
12268 @example
12269 void __builtin_arc_vdirun (int, int)
12270 void __builtin_arc_vdorun (int, int)
12271 @end example
12273 The following take two @code{int} arguments and return no result.  The
12274 first argument must a 3-bit compile time constant indicating one of
12275 the DR0-DR7 DMA setup channels:
12276 @example
12277 void __builtin_arc_vdiwr (const int, int)
12278 void __builtin_arc_vdowr (const int, int)
12279 @end example
12281 The following take an @code{int} argument and return no result:
12282 @example
12283 void __builtin_arc_vendrec (int)
12284 void __builtin_arc_vrec (int)
12285 void __builtin_arc_vrecrun (int)
12286 void __builtin_arc_vrun (int)
12287 @end example
12289 The following take a @code{__v8hi} argument and two @code{int}
12290 arguments and return a @code{__v8hi} result.  The second argument must
12291 be a 3-bit compile time constants, indicating one the registers I0-I7,
12292 and the third argument must be an 8-bit compile time constant.
12294 @emph{Note:} Although the equivalent hardware instructions do not take
12295 an SIMD register as an operand, these builtins overwrite the relevant
12296 bits of the @code{__v8hi} register provided as the first argument with
12297 the value loaded from the @code{[Ib, u8]} location in the SDM.
12299 @example
12300 __v8hi __builtin_arc_vld32 (__v8hi, const int, const int)
12301 __v8hi __builtin_arc_vld32wh (__v8hi, const int, const int)
12302 __v8hi __builtin_arc_vld32wl (__v8hi, const int, const int)
12303 __v8hi __builtin_arc_vld64 (__v8hi, const int, const int)
12304 @end example
12306 The following take two @code{int} arguments and return a @code{__v8hi}
12307 result.  The first argument must be a 3-bit compile time constants,
12308 indicating one the registers I0-I7, and the second argument must be an
12309 8-bit compile time constant.
12311 @example
12312 __v8hi __builtin_arc_vld128 (const int, const int)
12313 __v8hi __builtin_arc_vld64w (const int, const int)
12314 @end example
12316 The following take a @code{__v8hi} argument and two @code{int}
12317 arguments and return no result.  The second argument must be a 3-bit
12318 compile time constants, indicating one the registers I0-I7, and the
12319 third argument must be an 8-bit compile time constant.
12321 @example
12322 void __builtin_arc_vst128 (__v8hi, const int, const int)
12323 void __builtin_arc_vst64 (__v8hi, const int, const int)
12324 @end example
12326 The following take a @code{__v8hi} argument and three @code{int}
12327 arguments and return no result.  The second argument must be a 3-bit
12328 compile-time constant, identifying the 16-bit sub-register to be
12329 stored, the third argument must be a 3-bit compile time constants,
12330 indicating one the registers I0-I7, and the fourth argument must be an
12331 8-bit compile time constant.
12333 @example
12334 void __builtin_arc_vst16_n (__v8hi, const int, const int, const int)
12335 void __builtin_arc_vst32_n (__v8hi, const int, const int, const int)
12336 @end example
12338 @node ARM iWMMXt Built-in Functions
12339 @subsection ARM iWMMXt Built-in Functions
12341 These built-in functions are available for the ARM family of
12342 processors when the @option{-mcpu=iwmmxt} switch is used:
12344 @smallexample
12345 typedef int v2si __attribute__ ((vector_size (8)));
12346 typedef short v4hi __attribute__ ((vector_size (8)));
12347 typedef char v8qi __attribute__ ((vector_size (8)));
12349 int __builtin_arm_getwcgr0 (void)
12350 void __builtin_arm_setwcgr0 (int)
12351 int __builtin_arm_getwcgr1 (void)
12352 void __builtin_arm_setwcgr1 (int)
12353 int __builtin_arm_getwcgr2 (void)
12354 void __builtin_arm_setwcgr2 (int)
12355 int __builtin_arm_getwcgr3 (void)
12356 void __builtin_arm_setwcgr3 (int)
12357 int __builtin_arm_textrmsb (v8qi, int)
12358 int __builtin_arm_textrmsh (v4hi, int)
12359 int __builtin_arm_textrmsw (v2si, int)
12360 int __builtin_arm_textrmub (v8qi, int)
12361 int __builtin_arm_textrmuh (v4hi, int)
12362 int __builtin_arm_textrmuw (v2si, int)
12363 v8qi __builtin_arm_tinsrb (v8qi, int, int)
12364 v4hi __builtin_arm_tinsrh (v4hi, int, int)
12365 v2si __builtin_arm_tinsrw (v2si, int, int)
12366 long long __builtin_arm_tmia (long long, int, int)
12367 long long __builtin_arm_tmiabb (long long, int, int)
12368 long long __builtin_arm_tmiabt (long long, int, int)
12369 long long __builtin_arm_tmiaph (long long, int, int)
12370 long long __builtin_arm_tmiatb (long long, int, int)
12371 long long __builtin_arm_tmiatt (long long, int, int)
12372 int __builtin_arm_tmovmskb (v8qi)
12373 int __builtin_arm_tmovmskh (v4hi)
12374 int __builtin_arm_tmovmskw (v2si)
12375 long long __builtin_arm_waccb (v8qi)
12376 long long __builtin_arm_wacch (v4hi)
12377 long long __builtin_arm_waccw (v2si)
12378 v8qi __builtin_arm_waddb (v8qi, v8qi)
12379 v8qi __builtin_arm_waddbss (v8qi, v8qi)
12380 v8qi __builtin_arm_waddbus (v8qi, v8qi)
12381 v4hi __builtin_arm_waddh (v4hi, v4hi)
12382 v4hi __builtin_arm_waddhss (v4hi, v4hi)
12383 v4hi __builtin_arm_waddhus (v4hi, v4hi)
12384 v2si __builtin_arm_waddw (v2si, v2si)
12385 v2si __builtin_arm_waddwss (v2si, v2si)
12386 v2si __builtin_arm_waddwus (v2si, v2si)
12387 v8qi __builtin_arm_walign (v8qi, v8qi, int)
12388 long long __builtin_arm_wand(long long, long long)
12389 long long __builtin_arm_wandn (long long, long long)
12390 v8qi __builtin_arm_wavg2b (v8qi, v8qi)
12391 v8qi __builtin_arm_wavg2br (v8qi, v8qi)
12392 v4hi __builtin_arm_wavg2h (v4hi, v4hi)
12393 v4hi __builtin_arm_wavg2hr (v4hi, v4hi)
12394 v8qi __builtin_arm_wcmpeqb (v8qi, v8qi)
12395 v4hi __builtin_arm_wcmpeqh (v4hi, v4hi)
12396 v2si __builtin_arm_wcmpeqw (v2si, v2si)
12397 v8qi __builtin_arm_wcmpgtsb (v8qi, v8qi)
12398 v4hi __builtin_arm_wcmpgtsh (v4hi, v4hi)
12399 v2si __builtin_arm_wcmpgtsw (v2si, v2si)
12400 v8qi __builtin_arm_wcmpgtub (v8qi, v8qi)
12401 v4hi __builtin_arm_wcmpgtuh (v4hi, v4hi)
12402 v2si __builtin_arm_wcmpgtuw (v2si, v2si)
12403 long long __builtin_arm_wmacs (long long, v4hi, v4hi)
12404 long long __builtin_arm_wmacsz (v4hi, v4hi)
12405 long long __builtin_arm_wmacu (long long, v4hi, v4hi)
12406 long long __builtin_arm_wmacuz (v4hi, v4hi)
12407 v4hi __builtin_arm_wmadds (v4hi, v4hi)
12408 v4hi __builtin_arm_wmaddu (v4hi, v4hi)
12409 v8qi __builtin_arm_wmaxsb (v8qi, v8qi)
12410 v4hi __builtin_arm_wmaxsh (v4hi, v4hi)
12411 v2si __builtin_arm_wmaxsw (v2si, v2si)
12412 v8qi __builtin_arm_wmaxub (v8qi, v8qi)
12413 v4hi __builtin_arm_wmaxuh (v4hi, v4hi)
12414 v2si __builtin_arm_wmaxuw (v2si, v2si)
12415 v8qi __builtin_arm_wminsb (v8qi, v8qi)
12416 v4hi __builtin_arm_wminsh (v4hi, v4hi)
12417 v2si __builtin_arm_wminsw (v2si, v2si)
12418 v8qi __builtin_arm_wminub (v8qi, v8qi)
12419 v4hi __builtin_arm_wminuh (v4hi, v4hi)
12420 v2si __builtin_arm_wminuw (v2si, v2si)
12421 v4hi __builtin_arm_wmulsm (v4hi, v4hi)
12422 v4hi __builtin_arm_wmulul (v4hi, v4hi)
12423 v4hi __builtin_arm_wmulum (v4hi, v4hi)
12424 long long __builtin_arm_wor (long long, long long)
12425 v2si __builtin_arm_wpackdss (long long, long long)
12426 v2si __builtin_arm_wpackdus (long long, long long)
12427 v8qi __builtin_arm_wpackhss (v4hi, v4hi)
12428 v8qi __builtin_arm_wpackhus (v4hi, v4hi)
12429 v4hi __builtin_arm_wpackwss (v2si, v2si)
12430 v4hi __builtin_arm_wpackwus (v2si, v2si)
12431 long long __builtin_arm_wrord (long long, long long)
12432 long long __builtin_arm_wrordi (long long, int)
12433 v4hi __builtin_arm_wrorh (v4hi, long long)
12434 v4hi __builtin_arm_wrorhi (v4hi, int)
12435 v2si __builtin_arm_wrorw (v2si, long long)
12436 v2si __builtin_arm_wrorwi (v2si, int)
12437 v2si __builtin_arm_wsadb (v2si, v8qi, v8qi)
12438 v2si __builtin_arm_wsadbz (v8qi, v8qi)
12439 v2si __builtin_arm_wsadh (v2si, v4hi, v4hi)
12440 v2si __builtin_arm_wsadhz (v4hi, v4hi)
12441 v4hi __builtin_arm_wshufh (v4hi, int)
12442 long long __builtin_arm_wslld (long long, long long)
12443 long long __builtin_arm_wslldi (long long, int)
12444 v4hi __builtin_arm_wsllh (v4hi, long long)
12445 v4hi __builtin_arm_wsllhi (v4hi, int)
12446 v2si __builtin_arm_wsllw (v2si, long long)
12447 v2si __builtin_arm_wsllwi (v2si, int)
12448 long long __builtin_arm_wsrad (long long, long long)
12449 long long __builtin_arm_wsradi (long long, int)
12450 v4hi __builtin_arm_wsrah (v4hi, long long)
12451 v4hi __builtin_arm_wsrahi (v4hi, int)
12452 v2si __builtin_arm_wsraw (v2si, long long)
12453 v2si __builtin_arm_wsrawi (v2si, int)
12454 long long __builtin_arm_wsrld (long long, long long)
12455 long long __builtin_arm_wsrldi (long long, int)
12456 v4hi __builtin_arm_wsrlh (v4hi, long long)
12457 v4hi __builtin_arm_wsrlhi (v4hi, int)
12458 v2si __builtin_arm_wsrlw (v2si, long long)
12459 v2si __builtin_arm_wsrlwi (v2si, int)
12460 v8qi __builtin_arm_wsubb (v8qi, v8qi)
12461 v8qi __builtin_arm_wsubbss (v8qi, v8qi)
12462 v8qi __builtin_arm_wsubbus (v8qi, v8qi)
12463 v4hi __builtin_arm_wsubh (v4hi, v4hi)
12464 v4hi __builtin_arm_wsubhss (v4hi, v4hi)
12465 v4hi __builtin_arm_wsubhus (v4hi, v4hi)
12466 v2si __builtin_arm_wsubw (v2si, v2si)
12467 v2si __builtin_arm_wsubwss (v2si, v2si)
12468 v2si __builtin_arm_wsubwus (v2si, v2si)
12469 v4hi __builtin_arm_wunpckehsb (v8qi)
12470 v2si __builtin_arm_wunpckehsh (v4hi)
12471 long long __builtin_arm_wunpckehsw (v2si)
12472 v4hi __builtin_arm_wunpckehub (v8qi)
12473 v2si __builtin_arm_wunpckehuh (v4hi)
12474 long long __builtin_arm_wunpckehuw (v2si)
12475 v4hi __builtin_arm_wunpckelsb (v8qi)
12476 v2si __builtin_arm_wunpckelsh (v4hi)
12477 long long __builtin_arm_wunpckelsw (v2si)
12478 v4hi __builtin_arm_wunpckelub (v8qi)
12479 v2si __builtin_arm_wunpckeluh (v4hi)
12480 long long __builtin_arm_wunpckeluw (v2si)
12481 v8qi __builtin_arm_wunpckihb (v8qi, v8qi)
12482 v4hi __builtin_arm_wunpckihh (v4hi, v4hi)
12483 v2si __builtin_arm_wunpckihw (v2si, v2si)
12484 v8qi __builtin_arm_wunpckilb (v8qi, v8qi)
12485 v4hi __builtin_arm_wunpckilh (v4hi, v4hi)
12486 v2si __builtin_arm_wunpckilw (v2si, v2si)
12487 long long __builtin_arm_wxor (long long, long long)
12488 long long __builtin_arm_wzero ()
12489 @end smallexample
12492 @node ARM C Language Extensions (ACLE)
12493 @subsection ARM C Language Extensions (ACLE)
12495 GCC implements extensions for C as described in the ARM C Language
12496 Extensions (ACLE) specification, which can be found at
12497 @uref{http://infocenter.arm.com/help/topic/com.arm.doc.ihi0053c/IHI0053C_acle_2_0.pdf}.
12499 As a part of ACLE, GCC implements extensions for Advanced SIMD as described in
12500 the ARM C Language Extensions Specification.  The complete list of Advanced SIMD
12501 intrinsics can be found at
12502 @uref{http://infocenter.arm.com/help/topic/com.arm.doc.ihi0073a/IHI0073A_arm_neon_intrinsics_ref.pdf}.
12503 The built-in intrinsics for the Advanced SIMD extension are available when
12504 NEON is enabled.
12506 Currently, ARM and AArch64 back ends do not support ACLE 2.0 fully.  Both
12507 back ends support CRC32 intrinsics from @file{arm_acle.h}.  The ARM back end's
12508 16-bit floating-point Advanced SIMD intrinsics currently comply to ACLE v1.1.
12509 AArch64's back end does not have support for 16-bit floating point Advanced SIMD
12510 intrinsics yet.
12512 See @ref{ARM Options} and @ref{AArch64 Options} for more information on the
12513 availability of extensions.
12515 @node ARM Floating Point Status and Control Intrinsics
12516 @subsection ARM Floating Point Status and Control Intrinsics
12518 These built-in functions are available for the ARM family of
12519 processors with floating-point unit.
12521 @smallexample
12522 unsigned int __builtin_arm_get_fpscr ()
12523 void __builtin_arm_set_fpscr (unsigned int)
12524 @end smallexample
12526 @node AVR Built-in Functions
12527 @subsection AVR Built-in Functions
12529 For each built-in function for AVR, there is an equally named,
12530 uppercase built-in macro defined. That way users can easily query if
12531 or if not a specific built-in is implemented or not. For example, if
12532 @code{__builtin_avr_nop} is available the macro
12533 @code{__BUILTIN_AVR_NOP} is defined to @code{1} and undefined otherwise.
12535 The following built-in functions map to the respective machine
12536 instruction, i.e.@: @code{nop}, @code{sei}, @code{cli}, @code{sleep},
12537 @code{wdr}, @code{swap}, @code{fmul}, @code{fmuls}
12538 resp. @code{fmulsu}. The three @code{fmul*} built-ins are implemented
12539 as library call if no hardware multiplier is available.
12541 @smallexample
12542 void __builtin_avr_nop (void)
12543 void __builtin_avr_sei (void)
12544 void __builtin_avr_cli (void)
12545 void __builtin_avr_sleep (void)
12546 void __builtin_avr_wdr (void)
12547 unsigned char __builtin_avr_swap (unsigned char)
12548 unsigned int __builtin_avr_fmul (unsigned char, unsigned char)
12549 int __builtin_avr_fmuls (char, char)
12550 int __builtin_avr_fmulsu (char, unsigned char)
12551 @end smallexample
12553 In order to delay execution for a specific number of cycles, GCC
12554 implements
12555 @smallexample
12556 void __builtin_avr_delay_cycles (unsigned long ticks)
12557 @end smallexample
12559 @noindent
12560 @code{ticks} is the number of ticks to delay execution. Note that this
12561 built-in does not take into account the effect of interrupts that
12562 might increase delay time. @code{ticks} must be a compile-time
12563 integer constant; delays with a variable number of cycles are not supported.
12565 @smallexample
12566 char __builtin_avr_flash_segment (const __memx void*)
12567 @end smallexample
12569 @noindent
12570 This built-in takes a byte address to the 24-bit
12571 @ref{AVR Named Address Spaces,address space} @code{__memx} and returns
12572 the number of the flash segment (the 64 KiB chunk) where the address
12573 points to.  Counting starts at @code{0}.
12574 If the address does not point to flash memory, return @code{-1}.
12576 @smallexample
12577 unsigned char __builtin_avr_insert_bits (unsigned long map, unsigned char bits, unsigned char val)
12578 @end smallexample
12580 @noindent
12581 Insert bits from @var{bits} into @var{val} and return the resulting
12582 value. The nibbles of @var{map} determine how the insertion is
12583 performed: Let @var{X} be the @var{n}-th nibble of @var{map}
12584 @enumerate
12585 @item If @var{X} is @code{0xf},
12586 then the @var{n}-th bit of @var{val} is returned unaltered.
12588 @item If X is in the range 0@dots{}7,
12589 then the @var{n}-th result bit is set to the @var{X}-th bit of @var{bits}
12591 @item If X is in the range 8@dots{}@code{0xe},
12592 then the @var{n}-th result bit is undefined.
12593 @end enumerate
12595 @noindent
12596 One typical use case for this built-in is adjusting input and
12597 output values to non-contiguous port layouts. Some examples:
12599 @smallexample
12600 // same as val, bits is unused
12601 __builtin_avr_insert_bits (0xffffffff, bits, val)
12602 @end smallexample
12604 @smallexample
12605 // same as bits, val is unused
12606 __builtin_avr_insert_bits (0x76543210, bits, val)
12607 @end smallexample
12609 @smallexample
12610 // same as rotating bits by 4
12611 __builtin_avr_insert_bits (0x32107654, bits, 0)
12612 @end smallexample
12614 @smallexample
12615 // high nibble of result is the high nibble of val
12616 // low nibble of result is the low nibble of bits
12617 __builtin_avr_insert_bits (0xffff3210, bits, val)
12618 @end smallexample
12620 @smallexample
12621 // reverse the bit order of bits
12622 __builtin_avr_insert_bits (0x01234567, bits, 0)
12623 @end smallexample
12625 @smallexample
12626 void __builtin_avr_nops (unsigned count)
12627 @end smallexample
12629 @noindent
12630 Insert @code{count} @code{NOP} instructions.
12631 The number of instructions must be a compile-time integer constant.
12633 @node Blackfin Built-in Functions
12634 @subsection Blackfin Built-in Functions
12636 Currently, there are two Blackfin-specific built-in functions.  These are
12637 used for generating @code{CSYNC} and @code{SSYNC} machine insns without
12638 using inline assembly; by using these built-in functions the compiler can
12639 automatically add workarounds for hardware errata involving these
12640 instructions.  These functions are named as follows:
12642 @smallexample
12643 void __builtin_bfin_csync (void)
12644 void __builtin_bfin_ssync (void)
12645 @end smallexample
12647 @node FR-V Built-in Functions
12648 @subsection FR-V Built-in Functions
12650 GCC provides many FR-V-specific built-in functions.  In general,
12651 these functions are intended to be compatible with those described
12652 by @cite{FR-V Family, Softune C/C++ Compiler Manual (V6), Fujitsu
12653 Semiconductor}.  The two exceptions are @code{__MDUNPACKH} and
12654 @code{__MBTOHE}, the GCC forms of which pass 128-bit values by
12655 pointer rather than by value.
12657 Most of the functions are named after specific FR-V instructions.
12658 Such functions are said to be ``directly mapped'' and are summarized
12659 here in tabular form.
12661 @menu
12662 * Argument Types::
12663 * Directly-mapped Integer Functions::
12664 * Directly-mapped Media Functions::
12665 * Raw read/write Functions::
12666 * Other Built-in Functions::
12667 @end menu
12669 @node Argument Types
12670 @subsubsection Argument Types
12672 The arguments to the built-in functions can be divided into three groups:
12673 register numbers, compile-time constants and run-time values.  In order
12674 to make this classification clear at a glance, the arguments and return
12675 values are given the following pseudo types:
12677 @multitable @columnfractions .20 .30 .15 .35
12678 @item Pseudo type @tab Real C type @tab Constant? @tab Description
12679 @item @code{uh} @tab @code{unsigned short} @tab No @tab an unsigned halfword
12680 @item @code{uw1} @tab @code{unsigned int} @tab No @tab an unsigned word
12681 @item @code{sw1} @tab @code{int} @tab No @tab a signed word
12682 @item @code{uw2} @tab @code{unsigned long long} @tab No
12683 @tab an unsigned doubleword
12684 @item @code{sw2} @tab @code{long long} @tab No @tab a signed doubleword
12685 @item @code{const} @tab @code{int} @tab Yes @tab an integer constant
12686 @item @code{acc} @tab @code{int} @tab Yes @tab an ACC register number
12687 @item @code{iacc} @tab @code{int} @tab Yes @tab an IACC register number
12688 @end multitable
12690 These pseudo types are not defined by GCC, they are simply a notational
12691 convenience used in this manual.
12693 Arguments of type @code{uh}, @code{uw1}, @code{sw1}, @code{uw2}
12694 and @code{sw2} are evaluated at run time.  They correspond to
12695 register operands in the underlying FR-V instructions.
12697 @code{const} arguments represent immediate operands in the underlying
12698 FR-V instructions.  They must be compile-time constants.
12700 @code{acc} arguments are evaluated at compile time and specify the number
12701 of an accumulator register.  For example, an @code{acc} argument of 2
12702 selects the ACC2 register.
12704 @code{iacc} arguments are similar to @code{acc} arguments but specify the
12705 number of an IACC register.  See @pxref{Other Built-in Functions}
12706 for more details.
12708 @node Directly-mapped Integer Functions
12709 @subsubsection Directly-Mapped Integer Functions
12711 The functions listed below map directly to FR-V I-type instructions.
12713 @multitable @columnfractions .45 .32 .23
12714 @item Function prototype @tab Example usage @tab Assembly output
12715 @item @code{sw1 __ADDSS (sw1, sw1)}
12716 @tab @code{@var{c} = __ADDSS (@var{a}, @var{b})}
12717 @tab @code{ADDSS @var{a},@var{b},@var{c}}
12718 @item @code{sw1 __SCAN (sw1, sw1)}
12719 @tab @code{@var{c} = __SCAN (@var{a}, @var{b})}
12720 @tab @code{SCAN @var{a},@var{b},@var{c}}
12721 @item @code{sw1 __SCUTSS (sw1)}
12722 @tab @code{@var{b} = __SCUTSS (@var{a})}
12723 @tab @code{SCUTSS @var{a},@var{b}}
12724 @item @code{sw1 __SLASS (sw1, sw1)}
12725 @tab @code{@var{c} = __SLASS (@var{a}, @var{b})}
12726 @tab @code{SLASS @var{a},@var{b},@var{c}}
12727 @item @code{void __SMASS (sw1, sw1)}
12728 @tab @code{__SMASS (@var{a}, @var{b})}
12729 @tab @code{SMASS @var{a},@var{b}}
12730 @item @code{void __SMSSS (sw1, sw1)}
12731 @tab @code{__SMSSS (@var{a}, @var{b})}
12732 @tab @code{SMSSS @var{a},@var{b}}
12733 @item @code{void __SMU (sw1, sw1)}
12734 @tab @code{__SMU (@var{a}, @var{b})}
12735 @tab @code{SMU @var{a},@var{b}}
12736 @item @code{sw2 __SMUL (sw1, sw1)}
12737 @tab @code{@var{c} = __SMUL (@var{a}, @var{b})}
12738 @tab @code{SMUL @var{a},@var{b},@var{c}}
12739 @item @code{sw1 __SUBSS (sw1, sw1)}
12740 @tab @code{@var{c} = __SUBSS (@var{a}, @var{b})}
12741 @tab @code{SUBSS @var{a},@var{b},@var{c}}
12742 @item @code{uw2 __UMUL (uw1, uw1)}
12743 @tab @code{@var{c} = __UMUL (@var{a}, @var{b})}
12744 @tab @code{UMUL @var{a},@var{b},@var{c}}
12745 @end multitable
12747 @node Directly-mapped Media Functions
12748 @subsubsection Directly-Mapped Media Functions
12750 The functions listed below map directly to FR-V M-type instructions.
12752 @multitable @columnfractions .45 .32 .23
12753 @item Function prototype @tab Example usage @tab Assembly output
12754 @item @code{uw1 __MABSHS (sw1)}
12755 @tab @code{@var{b} = __MABSHS (@var{a})}
12756 @tab @code{MABSHS @var{a},@var{b}}
12757 @item @code{void __MADDACCS (acc, acc)}
12758 @tab @code{__MADDACCS (@var{b}, @var{a})}
12759 @tab @code{MADDACCS @var{a},@var{b}}
12760 @item @code{sw1 __MADDHSS (sw1, sw1)}
12761 @tab @code{@var{c} = __MADDHSS (@var{a}, @var{b})}
12762 @tab @code{MADDHSS @var{a},@var{b},@var{c}}
12763 @item @code{uw1 __MADDHUS (uw1, uw1)}
12764 @tab @code{@var{c} = __MADDHUS (@var{a}, @var{b})}
12765 @tab @code{MADDHUS @var{a},@var{b},@var{c}}
12766 @item @code{uw1 __MAND (uw1, uw1)}
12767 @tab @code{@var{c} = __MAND (@var{a}, @var{b})}
12768 @tab @code{MAND @var{a},@var{b},@var{c}}
12769 @item @code{void __MASACCS (acc, acc)}
12770 @tab @code{__MASACCS (@var{b}, @var{a})}
12771 @tab @code{MASACCS @var{a},@var{b}}
12772 @item @code{uw1 __MAVEH (uw1, uw1)}
12773 @tab @code{@var{c} = __MAVEH (@var{a}, @var{b})}
12774 @tab @code{MAVEH @var{a},@var{b},@var{c}}
12775 @item @code{uw2 __MBTOH (uw1)}
12776 @tab @code{@var{b} = __MBTOH (@var{a})}
12777 @tab @code{MBTOH @var{a},@var{b}}
12778 @item @code{void __MBTOHE (uw1 *, uw1)}
12779 @tab @code{__MBTOHE (&@var{b}, @var{a})}
12780 @tab @code{MBTOHE @var{a},@var{b}}
12781 @item @code{void __MCLRACC (acc)}
12782 @tab @code{__MCLRACC (@var{a})}
12783 @tab @code{MCLRACC @var{a}}
12784 @item @code{void __MCLRACCA (void)}
12785 @tab @code{__MCLRACCA ()}
12786 @tab @code{MCLRACCA}
12787 @item @code{uw1 __Mcop1 (uw1, uw1)}
12788 @tab @code{@var{c} = __Mcop1 (@var{a}, @var{b})}
12789 @tab @code{Mcop1 @var{a},@var{b},@var{c}}
12790 @item @code{uw1 __Mcop2 (uw1, uw1)}
12791 @tab @code{@var{c} = __Mcop2 (@var{a}, @var{b})}
12792 @tab @code{Mcop2 @var{a},@var{b},@var{c}}
12793 @item @code{uw1 __MCPLHI (uw2, const)}
12794 @tab @code{@var{c} = __MCPLHI (@var{a}, @var{b})}
12795 @tab @code{MCPLHI @var{a},#@var{b},@var{c}}
12796 @item @code{uw1 __MCPLI (uw2, const)}
12797 @tab @code{@var{c} = __MCPLI (@var{a}, @var{b})}
12798 @tab @code{MCPLI @var{a},#@var{b},@var{c}}
12799 @item @code{void __MCPXIS (acc, sw1, sw1)}
12800 @tab @code{__MCPXIS (@var{c}, @var{a}, @var{b})}
12801 @tab @code{MCPXIS @var{a},@var{b},@var{c}}
12802 @item @code{void __MCPXIU (acc, uw1, uw1)}
12803 @tab @code{__MCPXIU (@var{c}, @var{a}, @var{b})}
12804 @tab @code{MCPXIU @var{a},@var{b},@var{c}}
12805 @item @code{void __MCPXRS (acc, sw1, sw1)}
12806 @tab @code{__MCPXRS (@var{c}, @var{a}, @var{b})}
12807 @tab @code{MCPXRS @var{a},@var{b},@var{c}}
12808 @item @code{void __MCPXRU (acc, uw1, uw1)}
12809 @tab @code{__MCPXRU (@var{c}, @var{a}, @var{b})}
12810 @tab @code{MCPXRU @var{a},@var{b},@var{c}}
12811 @item @code{uw1 __MCUT (acc, uw1)}
12812 @tab @code{@var{c} = __MCUT (@var{a}, @var{b})}
12813 @tab @code{MCUT @var{a},@var{b},@var{c}}
12814 @item @code{uw1 __MCUTSS (acc, sw1)}
12815 @tab @code{@var{c} = __MCUTSS (@var{a}, @var{b})}
12816 @tab @code{MCUTSS @var{a},@var{b},@var{c}}
12817 @item @code{void __MDADDACCS (acc, acc)}
12818 @tab @code{__MDADDACCS (@var{b}, @var{a})}
12819 @tab @code{MDADDACCS @var{a},@var{b}}
12820 @item @code{void __MDASACCS (acc, acc)}
12821 @tab @code{__MDASACCS (@var{b}, @var{a})}
12822 @tab @code{MDASACCS @var{a},@var{b}}
12823 @item @code{uw2 __MDCUTSSI (acc, const)}
12824 @tab @code{@var{c} = __MDCUTSSI (@var{a}, @var{b})}
12825 @tab @code{MDCUTSSI @var{a},#@var{b},@var{c}}
12826 @item @code{uw2 __MDPACKH (uw2, uw2)}
12827 @tab @code{@var{c} = __MDPACKH (@var{a}, @var{b})}
12828 @tab @code{MDPACKH @var{a},@var{b},@var{c}}
12829 @item @code{uw2 __MDROTLI (uw2, const)}
12830 @tab @code{@var{c} = __MDROTLI (@var{a}, @var{b})}
12831 @tab @code{MDROTLI @var{a},#@var{b},@var{c}}
12832 @item @code{void __MDSUBACCS (acc, acc)}
12833 @tab @code{__MDSUBACCS (@var{b}, @var{a})}
12834 @tab @code{MDSUBACCS @var{a},@var{b}}
12835 @item @code{void __MDUNPACKH (uw1 *, uw2)}
12836 @tab @code{__MDUNPACKH (&@var{b}, @var{a})}
12837 @tab @code{MDUNPACKH @var{a},@var{b}}
12838 @item @code{uw2 __MEXPDHD (uw1, const)}
12839 @tab @code{@var{c} = __MEXPDHD (@var{a}, @var{b})}
12840 @tab @code{MEXPDHD @var{a},#@var{b},@var{c}}
12841 @item @code{uw1 __MEXPDHW (uw1, const)}
12842 @tab @code{@var{c} = __MEXPDHW (@var{a}, @var{b})}
12843 @tab @code{MEXPDHW @var{a},#@var{b},@var{c}}
12844 @item @code{uw1 __MHDSETH (uw1, const)}
12845 @tab @code{@var{c} = __MHDSETH (@var{a}, @var{b})}
12846 @tab @code{MHDSETH @var{a},#@var{b},@var{c}}
12847 @item @code{sw1 __MHDSETS (const)}
12848 @tab @code{@var{b} = __MHDSETS (@var{a})}
12849 @tab @code{MHDSETS #@var{a},@var{b}}
12850 @item @code{uw1 __MHSETHIH (uw1, const)}
12851 @tab @code{@var{b} = __MHSETHIH (@var{b}, @var{a})}
12852 @tab @code{MHSETHIH #@var{a},@var{b}}
12853 @item @code{sw1 __MHSETHIS (sw1, const)}
12854 @tab @code{@var{b} = __MHSETHIS (@var{b}, @var{a})}
12855 @tab @code{MHSETHIS #@var{a},@var{b}}
12856 @item @code{uw1 __MHSETLOH (uw1, const)}
12857 @tab @code{@var{b} = __MHSETLOH (@var{b}, @var{a})}
12858 @tab @code{MHSETLOH #@var{a},@var{b}}
12859 @item @code{sw1 __MHSETLOS (sw1, const)}
12860 @tab @code{@var{b} = __MHSETLOS (@var{b}, @var{a})}
12861 @tab @code{MHSETLOS #@var{a},@var{b}}
12862 @item @code{uw1 __MHTOB (uw2)}
12863 @tab @code{@var{b} = __MHTOB (@var{a})}
12864 @tab @code{MHTOB @var{a},@var{b}}
12865 @item @code{void __MMACHS (acc, sw1, sw1)}
12866 @tab @code{__MMACHS (@var{c}, @var{a}, @var{b})}
12867 @tab @code{MMACHS @var{a},@var{b},@var{c}}
12868 @item @code{void __MMACHU (acc, uw1, uw1)}
12869 @tab @code{__MMACHU (@var{c}, @var{a}, @var{b})}
12870 @tab @code{MMACHU @var{a},@var{b},@var{c}}
12871 @item @code{void __MMRDHS (acc, sw1, sw1)}
12872 @tab @code{__MMRDHS (@var{c}, @var{a}, @var{b})}
12873 @tab @code{MMRDHS @var{a},@var{b},@var{c}}
12874 @item @code{void __MMRDHU (acc, uw1, uw1)}
12875 @tab @code{__MMRDHU (@var{c}, @var{a}, @var{b})}
12876 @tab @code{MMRDHU @var{a},@var{b},@var{c}}
12877 @item @code{void __MMULHS (acc, sw1, sw1)}
12878 @tab @code{__MMULHS (@var{c}, @var{a}, @var{b})}
12879 @tab @code{MMULHS @var{a},@var{b},@var{c}}
12880 @item @code{void __MMULHU (acc, uw1, uw1)}
12881 @tab @code{__MMULHU (@var{c}, @var{a}, @var{b})}
12882 @tab @code{MMULHU @var{a},@var{b},@var{c}}
12883 @item @code{void __MMULXHS (acc, sw1, sw1)}
12884 @tab @code{__MMULXHS (@var{c}, @var{a}, @var{b})}
12885 @tab @code{MMULXHS @var{a},@var{b},@var{c}}
12886 @item @code{void __MMULXHU (acc, uw1, uw1)}
12887 @tab @code{__MMULXHU (@var{c}, @var{a}, @var{b})}
12888 @tab @code{MMULXHU @var{a},@var{b},@var{c}}
12889 @item @code{uw1 __MNOT (uw1)}
12890 @tab @code{@var{b} = __MNOT (@var{a})}
12891 @tab @code{MNOT @var{a},@var{b}}
12892 @item @code{uw1 __MOR (uw1, uw1)}
12893 @tab @code{@var{c} = __MOR (@var{a}, @var{b})}
12894 @tab @code{MOR @var{a},@var{b},@var{c}}
12895 @item @code{uw1 __MPACKH (uh, uh)}
12896 @tab @code{@var{c} = __MPACKH (@var{a}, @var{b})}
12897 @tab @code{MPACKH @var{a},@var{b},@var{c}}
12898 @item @code{sw2 __MQADDHSS (sw2, sw2)}
12899 @tab @code{@var{c} = __MQADDHSS (@var{a}, @var{b})}
12900 @tab @code{MQADDHSS @var{a},@var{b},@var{c}}
12901 @item @code{uw2 __MQADDHUS (uw2, uw2)}
12902 @tab @code{@var{c} = __MQADDHUS (@var{a}, @var{b})}
12903 @tab @code{MQADDHUS @var{a},@var{b},@var{c}}
12904 @item @code{void __MQCPXIS (acc, sw2, sw2)}
12905 @tab @code{__MQCPXIS (@var{c}, @var{a}, @var{b})}
12906 @tab @code{MQCPXIS @var{a},@var{b},@var{c}}
12907 @item @code{void __MQCPXIU (acc, uw2, uw2)}
12908 @tab @code{__MQCPXIU (@var{c}, @var{a}, @var{b})}
12909 @tab @code{MQCPXIU @var{a},@var{b},@var{c}}
12910 @item @code{void __MQCPXRS (acc, sw2, sw2)}
12911 @tab @code{__MQCPXRS (@var{c}, @var{a}, @var{b})}
12912 @tab @code{MQCPXRS @var{a},@var{b},@var{c}}
12913 @item @code{void __MQCPXRU (acc, uw2, uw2)}
12914 @tab @code{__MQCPXRU (@var{c}, @var{a}, @var{b})}
12915 @tab @code{MQCPXRU @var{a},@var{b},@var{c}}
12916 @item @code{sw2 __MQLCLRHS (sw2, sw2)}
12917 @tab @code{@var{c} = __MQLCLRHS (@var{a}, @var{b})}
12918 @tab @code{MQLCLRHS @var{a},@var{b},@var{c}}
12919 @item @code{sw2 __MQLMTHS (sw2, sw2)}
12920 @tab @code{@var{c} = __MQLMTHS (@var{a}, @var{b})}
12921 @tab @code{MQLMTHS @var{a},@var{b},@var{c}}
12922 @item @code{void __MQMACHS (acc, sw2, sw2)}
12923 @tab @code{__MQMACHS (@var{c}, @var{a}, @var{b})}
12924 @tab @code{MQMACHS @var{a},@var{b},@var{c}}
12925 @item @code{void __MQMACHU (acc, uw2, uw2)}
12926 @tab @code{__MQMACHU (@var{c}, @var{a}, @var{b})}
12927 @tab @code{MQMACHU @var{a},@var{b},@var{c}}
12928 @item @code{void __MQMACXHS (acc, sw2, sw2)}
12929 @tab @code{__MQMACXHS (@var{c}, @var{a}, @var{b})}
12930 @tab @code{MQMACXHS @var{a},@var{b},@var{c}}
12931 @item @code{void __MQMULHS (acc, sw2, sw2)}
12932 @tab @code{__MQMULHS (@var{c}, @var{a}, @var{b})}
12933 @tab @code{MQMULHS @var{a},@var{b},@var{c}}
12934 @item @code{void __MQMULHU (acc, uw2, uw2)}
12935 @tab @code{__MQMULHU (@var{c}, @var{a}, @var{b})}
12936 @tab @code{MQMULHU @var{a},@var{b},@var{c}}
12937 @item @code{void __MQMULXHS (acc, sw2, sw2)}
12938 @tab @code{__MQMULXHS (@var{c}, @var{a}, @var{b})}
12939 @tab @code{MQMULXHS @var{a},@var{b},@var{c}}
12940 @item @code{void __MQMULXHU (acc, uw2, uw2)}
12941 @tab @code{__MQMULXHU (@var{c}, @var{a}, @var{b})}
12942 @tab @code{MQMULXHU @var{a},@var{b},@var{c}}
12943 @item @code{sw2 __MQSATHS (sw2, sw2)}
12944 @tab @code{@var{c} = __MQSATHS (@var{a}, @var{b})}
12945 @tab @code{MQSATHS @var{a},@var{b},@var{c}}
12946 @item @code{uw2 __MQSLLHI (uw2, int)}
12947 @tab @code{@var{c} = __MQSLLHI (@var{a}, @var{b})}
12948 @tab @code{MQSLLHI @var{a},@var{b},@var{c}}
12949 @item @code{sw2 __MQSRAHI (sw2, int)}
12950 @tab @code{@var{c} = __MQSRAHI (@var{a}, @var{b})}
12951 @tab @code{MQSRAHI @var{a},@var{b},@var{c}}
12952 @item @code{sw2 __MQSUBHSS (sw2, sw2)}
12953 @tab @code{@var{c} = __MQSUBHSS (@var{a}, @var{b})}
12954 @tab @code{MQSUBHSS @var{a},@var{b},@var{c}}
12955 @item @code{uw2 __MQSUBHUS (uw2, uw2)}
12956 @tab @code{@var{c} = __MQSUBHUS (@var{a}, @var{b})}
12957 @tab @code{MQSUBHUS @var{a},@var{b},@var{c}}
12958 @item @code{void __MQXMACHS (acc, sw2, sw2)}
12959 @tab @code{__MQXMACHS (@var{c}, @var{a}, @var{b})}
12960 @tab @code{MQXMACHS @var{a},@var{b},@var{c}}
12961 @item @code{void __MQXMACXHS (acc, sw2, sw2)}
12962 @tab @code{__MQXMACXHS (@var{c}, @var{a}, @var{b})}
12963 @tab @code{MQXMACXHS @var{a},@var{b},@var{c}}
12964 @item @code{uw1 __MRDACC (acc)}
12965 @tab @code{@var{b} = __MRDACC (@var{a})}
12966 @tab @code{MRDACC @var{a},@var{b}}
12967 @item @code{uw1 __MRDACCG (acc)}
12968 @tab @code{@var{b} = __MRDACCG (@var{a})}
12969 @tab @code{MRDACCG @var{a},@var{b}}
12970 @item @code{uw1 __MROTLI (uw1, const)}
12971 @tab @code{@var{c} = __MROTLI (@var{a}, @var{b})}
12972 @tab @code{MROTLI @var{a},#@var{b},@var{c}}
12973 @item @code{uw1 __MROTRI (uw1, const)}
12974 @tab @code{@var{c} = __MROTRI (@var{a}, @var{b})}
12975 @tab @code{MROTRI @var{a},#@var{b},@var{c}}
12976 @item @code{sw1 __MSATHS (sw1, sw1)}
12977 @tab @code{@var{c} = __MSATHS (@var{a}, @var{b})}
12978 @tab @code{MSATHS @var{a},@var{b},@var{c}}
12979 @item @code{uw1 __MSATHU (uw1, uw1)}
12980 @tab @code{@var{c} = __MSATHU (@var{a}, @var{b})}
12981 @tab @code{MSATHU @var{a},@var{b},@var{c}}
12982 @item @code{uw1 __MSLLHI (uw1, const)}
12983 @tab @code{@var{c} = __MSLLHI (@var{a}, @var{b})}
12984 @tab @code{MSLLHI @var{a},#@var{b},@var{c}}
12985 @item @code{sw1 __MSRAHI (sw1, const)}
12986 @tab @code{@var{c} = __MSRAHI (@var{a}, @var{b})}
12987 @tab @code{MSRAHI @var{a},#@var{b},@var{c}}
12988 @item @code{uw1 __MSRLHI (uw1, const)}
12989 @tab @code{@var{c} = __MSRLHI (@var{a}, @var{b})}
12990 @tab @code{MSRLHI @var{a},#@var{b},@var{c}}
12991 @item @code{void __MSUBACCS (acc, acc)}
12992 @tab @code{__MSUBACCS (@var{b}, @var{a})}
12993 @tab @code{MSUBACCS @var{a},@var{b}}
12994 @item @code{sw1 __MSUBHSS (sw1, sw1)}
12995 @tab @code{@var{c} = __MSUBHSS (@var{a}, @var{b})}
12996 @tab @code{MSUBHSS @var{a},@var{b},@var{c}}
12997 @item @code{uw1 __MSUBHUS (uw1, uw1)}
12998 @tab @code{@var{c} = __MSUBHUS (@var{a}, @var{b})}
12999 @tab @code{MSUBHUS @var{a},@var{b},@var{c}}
13000 @item @code{void __MTRAP (void)}
13001 @tab @code{__MTRAP ()}
13002 @tab @code{MTRAP}
13003 @item @code{uw2 __MUNPACKH (uw1)}
13004 @tab @code{@var{b} = __MUNPACKH (@var{a})}
13005 @tab @code{MUNPACKH @var{a},@var{b}}
13006 @item @code{uw1 __MWCUT (uw2, uw1)}
13007 @tab @code{@var{c} = __MWCUT (@var{a}, @var{b})}
13008 @tab @code{MWCUT @var{a},@var{b},@var{c}}
13009 @item @code{void __MWTACC (acc, uw1)}
13010 @tab @code{__MWTACC (@var{b}, @var{a})}
13011 @tab @code{MWTACC @var{a},@var{b}}
13012 @item @code{void __MWTACCG (acc, uw1)}
13013 @tab @code{__MWTACCG (@var{b}, @var{a})}
13014 @tab @code{MWTACCG @var{a},@var{b}}
13015 @item @code{uw1 __MXOR (uw1, uw1)}
13016 @tab @code{@var{c} = __MXOR (@var{a}, @var{b})}
13017 @tab @code{MXOR @var{a},@var{b},@var{c}}
13018 @end multitable
13020 @node Raw read/write Functions
13021 @subsubsection Raw Read/Write Functions
13023 This sections describes built-in functions related to read and write
13024 instructions to access memory.  These functions generate
13025 @code{membar} instructions to flush the I/O load and stores where
13026 appropriate, as described in Fujitsu's manual described above.
13028 @table @code
13030 @item unsigned char __builtin_read8 (void *@var{data})
13031 @item unsigned short __builtin_read16 (void *@var{data})
13032 @item unsigned long __builtin_read32 (void *@var{data})
13033 @item unsigned long long __builtin_read64 (void *@var{data})
13035 @item void __builtin_write8 (void *@var{data}, unsigned char @var{datum})
13036 @item void __builtin_write16 (void *@var{data}, unsigned short @var{datum})
13037 @item void __builtin_write32 (void *@var{data}, unsigned long @var{datum})
13038 @item void __builtin_write64 (void *@var{data}, unsigned long long @var{datum})
13039 @end table
13041 @node Other Built-in Functions
13042 @subsubsection Other Built-in Functions
13044 This section describes built-in functions that are not named after
13045 a specific FR-V instruction.
13047 @table @code
13048 @item sw2 __IACCreadll (iacc @var{reg})
13049 Return the full 64-bit value of IACC0@.  The @var{reg} argument is reserved
13050 for future expansion and must be 0.
13052 @item sw1 __IACCreadl (iacc @var{reg})
13053 Return the value of IACC0H if @var{reg} is 0 and IACC0L if @var{reg} is 1.
13054 Other values of @var{reg} are rejected as invalid.
13056 @item void __IACCsetll (iacc @var{reg}, sw2 @var{x})
13057 Set the full 64-bit value of IACC0 to @var{x}.  The @var{reg} argument
13058 is reserved for future expansion and must be 0.
13060 @item void __IACCsetl (iacc @var{reg}, sw1 @var{x})
13061 Set IACC0H to @var{x} if @var{reg} is 0 and IACC0L to @var{x} if @var{reg}
13062 is 1.  Other values of @var{reg} are rejected as invalid.
13064 @item void __data_prefetch0 (const void *@var{x})
13065 Use the @code{dcpl} instruction to load the contents of address @var{x}
13066 into the data cache.
13068 @item void __data_prefetch (const void *@var{x})
13069 Use the @code{nldub} instruction to load the contents of address @var{x}
13070 into the data cache.  The instruction is issued in slot I1@.
13071 @end table
13073 @node MIPS DSP Built-in Functions
13074 @subsection MIPS DSP Built-in Functions
13076 The MIPS DSP Application-Specific Extension (ASE) includes new
13077 instructions that are designed to improve the performance of DSP and
13078 media applications.  It provides instructions that operate on packed
13079 8-bit/16-bit integer data, Q7, Q15 and Q31 fractional data.
13081 GCC supports MIPS DSP operations using both the generic
13082 vector extensions (@pxref{Vector Extensions}) and a collection of
13083 MIPS-specific built-in functions.  Both kinds of support are
13084 enabled by the @option{-mdsp} command-line option.
13086 Revision 2 of the ASE was introduced in the second half of 2006.
13087 This revision adds extra instructions to the original ASE, but is
13088 otherwise backwards-compatible with it.  You can select revision 2
13089 using the command-line option @option{-mdspr2}; this option implies
13090 @option{-mdsp}.
13092 The SCOUNT and POS bits of the DSP control register are global.  The
13093 WRDSP, EXTPDP, EXTPDPV and MTHLIP instructions modify the SCOUNT and
13094 POS bits.  During optimization, the compiler does not delete these
13095 instructions and it does not delete calls to functions containing
13096 these instructions.
13098 At present, GCC only provides support for operations on 32-bit
13099 vectors.  The vector type associated with 8-bit integer data is
13100 usually called @code{v4i8}, the vector type associated with Q7
13101 is usually called @code{v4q7}, the vector type associated with 16-bit
13102 integer data is usually called @code{v2i16}, and the vector type
13103 associated with Q15 is usually called @code{v2q15}.  They can be
13104 defined in C as follows:
13106 @smallexample
13107 typedef signed char v4i8 __attribute__ ((vector_size(4)));
13108 typedef signed char v4q7 __attribute__ ((vector_size(4)));
13109 typedef short v2i16 __attribute__ ((vector_size(4)));
13110 typedef short v2q15 __attribute__ ((vector_size(4)));
13111 @end smallexample
13113 @code{v4i8}, @code{v4q7}, @code{v2i16} and @code{v2q15} values are
13114 initialized in the same way as aggregates.  For example:
13116 @smallexample
13117 v4i8 a = @{1, 2, 3, 4@};
13118 v4i8 b;
13119 b = (v4i8) @{5, 6, 7, 8@};
13121 v2q15 c = @{0x0fcb, 0x3a75@};
13122 v2q15 d;
13123 d = (v2q15) @{0.1234 * 0x1.0p15, 0.4567 * 0x1.0p15@};
13124 @end smallexample
13126 @emph{Note:} The CPU's endianness determines the order in which values
13127 are packed.  On little-endian targets, the first value is the least
13128 significant and the last value is the most significant.  The opposite
13129 order applies to big-endian targets.  For example, the code above
13130 sets the lowest byte of @code{a} to @code{1} on little-endian targets
13131 and @code{4} on big-endian targets.
13133 @emph{Note:} Q7, Q15 and Q31 values must be initialized with their integer
13134 representation.  As shown in this example, the integer representation
13135 of a Q7 value can be obtained by multiplying the fractional value by
13136 @code{0x1.0p7}.  The equivalent for Q15 values is to multiply by
13137 @code{0x1.0p15}.  The equivalent for Q31 values is to multiply by
13138 @code{0x1.0p31}.
13140 The table below lists the @code{v4i8} and @code{v2q15} operations for which
13141 hardware support exists.  @code{a} and @code{b} are @code{v4i8} values,
13142 and @code{c} and @code{d} are @code{v2q15} values.
13144 @multitable @columnfractions .50 .50
13145 @item C code @tab MIPS instruction
13146 @item @code{a + b} @tab @code{addu.qb}
13147 @item @code{c + d} @tab @code{addq.ph}
13148 @item @code{a - b} @tab @code{subu.qb}
13149 @item @code{c - d} @tab @code{subq.ph}
13150 @end multitable
13152 The table below lists the @code{v2i16} operation for which
13153 hardware support exists for the DSP ASE REV 2.  @code{e} and @code{f} are
13154 @code{v2i16} values.
13156 @multitable @columnfractions .50 .50
13157 @item C code @tab MIPS instruction
13158 @item @code{e * f} @tab @code{mul.ph}
13159 @end multitable
13161 It is easier to describe the DSP built-in functions if we first define
13162 the following types:
13164 @smallexample
13165 typedef int q31;
13166 typedef int i32;
13167 typedef unsigned int ui32;
13168 typedef long long a64;
13169 @end smallexample
13171 @code{q31} and @code{i32} are actually the same as @code{int}, but we
13172 use @code{q31} to indicate a Q31 fractional value and @code{i32} to
13173 indicate a 32-bit integer value.  Similarly, @code{a64} is the same as
13174 @code{long long}, but we use @code{a64} to indicate values that are
13175 placed in one of the four DSP accumulators (@code{$ac0},
13176 @code{$ac1}, @code{$ac2} or @code{$ac3}).
13178 Also, some built-in functions prefer or require immediate numbers as
13179 parameters, because the corresponding DSP instructions accept both immediate
13180 numbers and register operands, or accept immediate numbers only.  The
13181 immediate parameters are listed as follows.
13183 @smallexample
13184 imm0_3: 0 to 3.
13185 imm0_7: 0 to 7.
13186 imm0_15: 0 to 15.
13187 imm0_31: 0 to 31.
13188 imm0_63: 0 to 63.
13189 imm0_255: 0 to 255.
13190 imm_n32_31: -32 to 31.
13191 imm_n512_511: -512 to 511.
13192 @end smallexample
13194 The following built-in functions map directly to a particular MIPS DSP
13195 instruction.  Please refer to the architecture specification
13196 for details on what each instruction does.
13198 @smallexample
13199 v2q15 __builtin_mips_addq_ph (v2q15, v2q15)
13200 v2q15 __builtin_mips_addq_s_ph (v2q15, v2q15)
13201 q31 __builtin_mips_addq_s_w (q31, q31)
13202 v4i8 __builtin_mips_addu_qb (v4i8, v4i8)
13203 v4i8 __builtin_mips_addu_s_qb (v4i8, v4i8)
13204 v2q15 __builtin_mips_subq_ph (v2q15, v2q15)
13205 v2q15 __builtin_mips_subq_s_ph (v2q15, v2q15)
13206 q31 __builtin_mips_subq_s_w (q31, q31)
13207 v4i8 __builtin_mips_subu_qb (v4i8, v4i8)
13208 v4i8 __builtin_mips_subu_s_qb (v4i8, v4i8)
13209 i32 __builtin_mips_addsc (i32, i32)
13210 i32 __builtin_mips_addwc (i32, i32)
13211 i32 __builtin_mips_modsub (i32, i32)
13212 i32 __builtin_mips_raddu_w_qb (v4i8)
13213 v2q15 __builtin_mips_absq_s_ph (v2q15)
13214 q31 __builtin_mips_absq_s_w (q31)
13215 v4i8 __builtin_mips_precrq_qb_ph (v2q15, v2q15)
13216 v2q15 __builtin_mips_precrq_ph_w (q31, q31)
13217 v2q15 __builtin_mips_precrq_rs_ph_w (q31, q31)
13218 v4i8 __builtin_mips_precrqu_s_qb_ph (v2q15, v2q15)
13219 q31 __builtin_mips_preceq_w_phl (v2q15)
13220 q31 __builtin_mips_preceq_w_phr (v2q15)
13221 v2q15 __builtin_mips_precequ_ph_qbl (v4i8)
13222 v2q15 __builtin_mips_precequ_ph_qbr (v4i8)
13223 v2q15 __builtin_mips_precequ_ph_qbla (v4i8)
13224 v2q15 __builtin_mips_precequ_ph_qbra (v4i8)
13225 v2q15 __builtin_mips_preceu_ph_qbl (v4i8)
13226 v2q15 __builtin_mips_preceu_ph_qbr (v4i8)
13227 v2q15 __builtin_mips_preceu_ph_qbla (v4i8)
13228 v2q15 __builtin_mips_preceu_ph_qbra (v4i8)
13229 v4i8 __builtin_mips_shll_qb (v4i8, imm0_7)
13230 v4i8 __builtin_mips_shll_qb (v4i8, i32)
13231 v2q15 __builtin_mips_shll_ph (v2q15, imm0_15)
13232 v2q15 __builtin_mips_shll_ph (v2q15, i32)
13233 v2q15 __builtin_mips_shll_s_ph (v2q15, imm0_15)
13234 v2q15 __builtin_mips_shll_s_ph (v2q15, i32)
13235 q31 __builtin_mips_shll_s_w (q31, imm0_31)
13236 q31 __builtin_mips_shll_s_w (q31, i32)
13237 v4i8 __builtin_mips_shrl_qb (v4i8, imm0_7)
13238 v4i8 __builtin_mips_shrl_qb (v4i8, i32)
13239 v2q15 __builtin_mips_shra_ph (v2q15, imm0_15)
13240 v2q15 __builtin_mips_shra_ph (v2q15, i32)
13241 v2q15 __builtin_mips_shra_r_ph (v2q15, imm0_15)
13242 v2q15 __builtin_mips_shra_r_ph (v2q15, i32)
13243 q31 __builtin_mips_shra_r_w (q31, imm0_31)
13244 q31 __builtin_mips_shra_r_w (q31, i32)
13245 v2q15 __builtin_mips_muleu_s_ph_qbl (v4i8, v2q15)
13246 v2q15 __builtin_mips_muleu_s_ph_qbr (v4i8, v2q15)
13247 v2q15 __builtin_mips_mulq_rs_ph (v2q15, v2q15)
13248 q31 __builtin_mips_muleq_s_w_phl (v2q15, v2q15)
13249 q31 __builtin_mips_muleq_s_w_phr (v2q15, v2q15)
13250 a64 __builtin_mips_dpau_h_qbl (a64, v4i8, v4i8)
13251 a64 __builtin_mips_dpau_h_qbr (a64, v4i8, v4i8)
13252 a64 __builtin_mips_dpsu_h_qbl (a64, v4i8, v4i8)
13253 a64 __builtin_mips_dpsu_h_qbr (a64, v4i8, v4i8)
13254 a64 __builtin_mips_dpaq_s_w_ph (a64, v2q15, v2q15)
13255 a64 __builtin_mips_dpaq_sa_l_w (a64, q31, q31)
13256 a64 __builtin_mips_dpsq_s_w_ph (a64, v2q15, v2q15)
13257 a64 __builtin_mips_dpsq_sa_l_w (a64, q31, q31)
13258 a64 __builtin_mips_mulsaq_s_w_ph (a64, v2q15, v2q15)
13259 a64 __builtin_mips_maq_s_w_phl (a64, v2q15, v2q15)
13260 a64 __builtin_mips_maq_s_w_phr (a64, v2q15, v2q15)
13261 a64 __builtin_mips_maq_sa_w_phl (a64, v2q15, v2q15)
13262 a64 __builtin_mips_maq_sa_w_phr (a64, v2q15, v2q15)
13263 i32 __builtin_mips_bitrev (i32)
13264 i32 __builtin_mips_insv (i32, i32)
13265 v4i8 __builtin_mips_repl_qb (imm0_255)
13266 v4i8 __builtin_mips_repl_qb (i32)
13267 v2q15 __builtin_mips_repl_ph (imm_n512_511)
13268 v2q15 __builtin_mips_repl_ph (i32)
13269 void __builtin_mips_cmpu_eq_qb (v4i8, v4i8)
13270 void __builtin_mips_cmpu_lt_qb (v4i8, v4i8)
13271 void __builtin_mips_cmpu_le_qb (v4i8, v4i8)
13272 i32 __builtin_mips_cmpgu_eq_qb (v4i8, v4i8)
13273 i32 __builtin_mips_cmpgu_lt_qb (v4i8, v4i8)
13274 i32 __builtin_mips_cmpgu_le_qb (v4i8, v4i8)
13275 void __builtin_mips_cmp_eq_ph (v2q15, v2q15)
13276 void __builtin_mips_cmp_lt_ph (v2q15, v2q15)
13277 void __builtin_mips_cmp_le_ph (v2q15, v2q15)
13278 v4i8 __builtin_mips_pick_qb (v4i8, v4i8)
13279 v2q15 __builtin_mips_pick_ph (v2q15, v2q15)
13280 v2q15 __builtin_mips_packrl_ph (v2q15, v2q15)
13281 i32 __builtin_mips_extr_w (a64, imm0_31)
13282 i32 __builtin_mips_extr_w (a64, i32)
13283 i32 __builtin_mips_extr_r_w (a64, imm0_31)
13284 i32 __builtin_mips_extr_s_h (a64, i32)
13285 i32 __builtin_mips_extr_rs_w (a64, imm0_31)
13286 i32 __builtin_mips_extr_rs_w (a64, i32)
13287 i32 __builtin_mips_extr_s_h (a64, imm0_31)
13288 i32 __builtin_mips_extr_r_w (a64, i32)
13289 i32 __builtin_mips_extp (a64, imm0_31)
13290 i32 __builtin_mips_extp (a64, i32)
13291 i32 __builtin_mips_extpdp (a64, imm0_31)
13292 i32 __builtin_mips_extpdp (a64, i32)
13293 a64 __builtin_mips_shilo (a64, imm_n32_31)
13294 a64 __builtin_mips_shilo (a64, i32)
13295 a64 __builtin_mips_mthlip (a64, i32)
13296 void __builtin_mips_wrdsp (i32, imm0_63)
13297 i32 __builtin_mips_rddsp (imm0_63)
13298 i32 __builtin_mips_lbux (void *, i32)
13299 i32 __builtin_mips_lhx (void *, i32)
13300 i32 __builtin_mips_lwx (void *, i32)
13301 a64 __builtin_mips_ldx (void *, i32) [MIPS64 only]
13302 i32 __builtin_mips_bposge32 (void)
13303 a64 __builtin_mips_madd (a64, i32, i32);
13304 a64 __builtin_mips_maddu (a64, ui32, ui32);
13305 a64 __builtin_mips_msub (a64, i32, i32);
13306 a64 __builtin_mips_msubu (a64, ui32, ui32);
13307 a64 __builtin_mips_mult (i32, i32);
13308 a64 __builtin_mips_multu (ui32, ui32);
13309 @end smallexample
13311 The following built-in functions map directly to a particular MIPS DSP REV 2
13312 instruction.  Please refer to the architecture specification
13313 for details on what each instruction does.
13315 @smallexample
13316 v4q7 __builtin_mips_absq_s_qb (v4q7);
13317 v2i16 __builtin_mips_addu_ph (v2i16, v2i16);
13318 v2i16 __builtin_mips_addu_s_ph (v2i16, v2i16);
13319 v4i8 __builtin_mips_adduh_qb (v4i8, v4i8);
13320 v4i8 __builtin_mips_adduh_r_qb (v4i8, v4i8);
13321 i32 __builtin_mips_append (i32, i32, imm0_31);
13322 i32 __builtin_mips_balign (i32, i32, imm0_3);
13323 i32 __builtin_mips_cmpgdu_eq_qb (v4i8, v4i8);
13324 i32 __builtin_mips_cmpgdu_lt_qb (v4i8, v4i8);
13325 i32 __builtin_mips_cmpgdu_le_qb (v4i8, v4i8);
13326 a64 __builtin_mips_dpa_w_ph (a64, v2i16, v2i16);
13327 a64 __builtin_mips_dps_w_ph (a64, v2i16, v2i16);
13328 v2i16 __builtin_mips_mul_ph (v2i16, v2i16);
13329 v2i16 __builtin_mips_mul_s_ph (v2i16, v2i16);
13330 q31 __builtin_mips_mulq_rs_w (q31, q31);
13331 v2q15 __builtin_mips_mulq_s_ph (v2q15, v2q15);
13332 q31 __builtin_mips_mulq_s_w (q31, q31);
13333 a64 __builtin_mips_mulsa_w_ph (a64, v2i16, v2i16);
13334 v4i8 __builtin_mips_precr_qb_ph (v2i16, v2i16);
13335 v2i16 __builtin_mips_precr_sra_ph_w (i32, i32, imm0_31);
13336 v2i16 __builtin_mips_precr_sra_r_ph_w (i32, i32, imm0_31);
13337 i32 __builtin_mips_prepend (i32, i32, imm0_31);
13338 v4i8 __builtin_mips_shra_qb (v4i8, imm0_7);
13339 v4i8 __builtin_mips_shra_r_qb (v4i8, imm0_7);
13340 v4i8 __builtin_mips_shra_qb (v4i8, i32);
13341 v4i8 __builtin_mips_shra_r_qb (v4i8, i32);
13342 v2i16 __builtin_mips_shrl_ph (v2i16, imm0_15);
13343 v2i16 __builtin_mips_shrl_ph (v2i16, i32);
13344 v2i16 __builtin_mips_subu_ph (v2i16, v2i16);
13345 v2i16 __builtin_mips_subu_s_ph (v2i16, v2i16);
13346 v4i8 __builtin_mips_subuh_qb (v4i8, v4i8);
13347 v4i8 __builtin_mips_subuh_r_qb (v4i8, v4i8);
13348 v2q15 __builtin_mips_addqh_ph (v2q15, v2q15);
13349 v2q15 __builtin_mips_addqh_r_ph (v2q15, v2q15);
13350 q31 __builtin_mips_addqh_w (q31, q31);
13351 q31 __builtin_mips_addqh_r_w (q31, q31);
13352 v2q15 __builtin_mips_subqh_ph (v2q15, v2q15);
13353 v2q15 __builtin_mips_subqh_r_ph (v2q15, v2q15);
13354 q31 __builtin_mips_subqh_w (q31, q31);
13355 q31 __builtin_mips_subqh_r_w (q31, q31);
13356 a64 __builtin_mips_dpax_w_ph (a64, v2i16, v2i16);
13357 a64 __builtin_mips_dpsx_w_ph (a64, v2i16, v2i16);
13358 a64 __builtin_mips_dpaqx_s_w_ph (a64, v2q15, v2q15);
13359 a64 __builtin_mips_dpaqx_sa_w_ph (a64, v2q15, v2q15);
13360 a64 __builtin_mips_dpsqx_s_w_ph (a64, v2q15, v2q15);
13361 a64 __builtin_mips_dpsqx_sa_w_ph (a64, v2q15, v2q15);
13362 @end smallexample
13365 @node MIPS Paired-Single Support
13366 @subsection MIPS Paired-Single Support
13368 The MIPS64 architecture includes a number of instructions that
13369 operate on pairs of single-precision floating-point values.
13370 Each pair is packed into a 64-bit floating-point register,
13371 with one element being designated the ``upper half'' and
13372 the other being designated the ``lower half''.
13374 GCC supports paired-single operations using both the generic
13375 vector extensions (@pxref{Vector Extensions}) and a collection of
13376 MIPS-specific built-in functions.  Both kinds of support are
13377 enabled by the @option{-mpaired-single} command-line option.
13379 The vector type associated with paired-single values is usually
13380 called @code{v2sf}.  It can be defined in C as follows:
13382 @smallexample
13383 typedef float v2sf __attribute__ ((vector_size (8)));
13384 @end smallexample
13386 @code{v2sf} values are initialized in the same way as aggregates.
13387 For example:
13389 @smallexample
13390 v2sf a = @{1.5, 9.1@};
13391 v2sf b;
13392 float e, f;
13393 b = (v2sf) @{e, f@};
13394 @end smallexample
13396 @emph{Note:} The CPU's endianness determines which value is stored in
13397 the upper half of a register and which value is stored in the lower half.
13398 On little-endian targets, the first value is the lower one and the second
13399 value is the upper one.  The opposite order applies to big-endian targets.
13400 For example, the code above sets the lower half of @code{a} to
13401 @code{1.5} on little-endian targets and @code{9.1} on big-endian targets.
13403 @node MIPS Loongson Built-in Functions
13404 @subsection MIPS Loongson Built-in Functions
13406 GCC provides intrinsics to access the SIMD instructions provided by the
13407 ST Microelectronics Loongson-2E and -2F processors.  These intrinsics,
13408 available after inclusion of the @code{loongson.h} header file,
13409 operate on the following 64-bit vector types:
13411 @itemize
13412 @item @code{uint8x8_t}, a vector of eight unsigned 8-bit integers;
13413 @item @code{uint16x4_t}, a vector of four unsigned 16-bit integers;
13414 @item @code{uint32x2_t}, a vector of two unsigned 32-bit integers;
13415 @item @code{int8x8_t}, a vector of eight signed 8-bit integers;
13416 @item @code{int16x4_t}, a vector of four signed 16-bit integers;
13417 @item @code{int32x2_t}, a vector of two signed 32-bit integers.
13418 @end itemize
13420 The intrinsics provided are listed below; each is named after the
13421 machine instruction to which it corresponds, with suffixes added as
13422 appropriate to distinguish intrinsics that expand to the same machine
13423 instruction yet have different argument types.  Refer to the architecture
13424 documentation for a description of the functionality of each
13425 instruction.
13427 @smallexample
13428 int16x4_t packsswh (int32x2_t s, int32x2_t t);
13429 int8x8_t packsshb (int16x4_t s, int16x4_t t);
13430 uint8x8_t packushb (uint16x4_t s, uint16x4_t t);
13431 uint32x2_t paddw_u (uint32x2_t s, uint32x2_t t);
13432 uint16x4_t paddh_u (uint16x4_t s, uint16x4_t t);
13433 uint8x8_t paddb_u (uint8x8_t s, uint8x8_t t);
13434 int32x2_t paddw_s (int32x2_t s, int32x2_t t);
13435 int16x4_t paddh_s (int16x4_t s, int16x4_t t);
13436 int8x8_t paddb_s (int8x8_t s, int8x8_t t);
13437 uint64_t paddd_u (uint64_t s, uint64_t t);
13438 int64_t paddd_s (int64_t s, int64_t t);
13439 int16x4_t paddsh (int16x4_t s, int16x4_t t);
13440 int8x8_t paddsb (int8x8_t s, int8x8_t t);
13441 uint16x4_t paddush (uint16x4_t s, uint16x4_t t);
13442 uint8x8_t paddusb (uint8x8_t s, uint8x8_t t);
13443 uint64_t pandn_ud (uint64_t s, uint64_t t);
13444 uint32x2_t pandn_uw (uint32x2_t s, uint32x2_t t);
13445 uint16x4_t pandn_uh (uint16x4_t s, uint16x4_t t);
13446 uint8x8_t pandn_ub (uint8x8_t s, uint8x8_t t);
13447 int64_t pandn_sd (int64_t s, int64_t t);
13448 int32x2_t pandn_sw (int32x2_t s, int32x2_t t);
13449 int16x4_t pandn_sh (int16x4_t s, int16x4_t t);
13450 int8x8_t pandn_sb (int8x8_t s, int8x8_t t);
13451 uint16x4_t pavgh (uint16x4_t s, uint16x4_t t);
13452 uint8x8_t pavgb (uint8x8_t s, uint8x8_t t);
13453 uint32x2_t pcmpeqw_u (uint32x2_t s, uint32x2_t t);
13454 uint16x4_t pcmpeqh_u (uint16x4_t s, uint16x4_t t);
13455 uint8x8_t pcmpeqb_u (uint8x8_t s, uint8x8_t t);
13456 int32x2_t pcmpeqw_s (int32x2_t s, int32x2_t t);
13457 int16x4_t pcmpeqh_s (int16x4_t s, int16x4_t t);
13458 int8x8_t pcmpeqb_s (int8x8_t s, int8x8_t t);
13459 uint32x2_t pcmpgtw_u (uint32x2_t s, uint32x2_t t);
13460 uint16x4_t pcmpgth_u (uint16x4_t s, uint16x4_t t);
13461 uint8x8_t pcmpgtb_u (uint8x8_t s, uint8x8_t t);
13462 int32x2_t pcmpgtw_s (int32x2_t s, int32x2_t t);
13463 int16x4_t pcmpgth_s (int16x4_t s, int16x4_t t);
13464 int8x8_t pcmpgtb_s (int8x8_t s, int8x8_t t);
13465 uint16x4_t pextrh_u (uint16x4_t s, int field);
13466 int16x4_t pextrh_s (int16x4_t s, int field);
13467 uint16x4_t pinsrh_0_u (uint16x4_t s, uint16x4_t t);
13468 uint16x4_t pinsrh_1_u (uint16x4_t s, uint16x4_t t);
13469 uint16x4_t pinsrh_2_u (uint16x4_t s, uint16x4_t t);
13470 uint16x4_t pinsrh_3_u (uint16x4_t s, uint16x4_t t);
13471 int16x4_t pinsrh_0_s (int16x4_t s, int16x4_t t);
13472 int16x4_t pinsrh_1_s (int16x4_t s, int16x4_t t);
13473 int16x4_t pinsrh_2_s (int16x4_t s, int16x4_t t);
13474 int16x4_t pinsrh_3_s (int16x4_t s, int16x4_t t);
13475 int32x2_t pmaddhw (int16x4_t s, int16x4_t t);
13476 int16x4_t pmaxsh (int16x4_t s, int16x4_t t);
13477 uint8x8_t pmaxub (uint8x8_t s, uint8x8_t t);
13478 int16x4_t pminsh (int16x4_t s, int16x4_t t);
13479 uint8x8_t pminub (uint8x8_t s, uint8x8_t t);
13480 uint8x8_t pmovmskb_u (uint8x8_t s);
13481 int8x8_t pmovmskb_s (int8x8_t s);
13482 uint16x4_t pmulhuh (uint16x4_t s, uint16x4_t t);
13483 int16x4_t pmulhh (int16x4_t s, int16x4_t t);
13484 int16x4_t pmullh (int16x4_t s, int16x4_t t);
13485 int64_t pmuluw (uint32x2_t s, uint32x2_t t);
13486 uint8x8_t pasubub (uint8x8_t s, uint8x8_t t);
13487 uint16x4_t biadd (uint8x8_t s);
13488 uint16x4_t psadbh (uint8x8_t s, uint8x8_t t);
13489 uint16x4_t pshufh_u (uint16x4_t dest, uint16x4_t s, uint8_t order);
13490 int16x4_t pshufh_s (int16x4_t dest, int16x4_t s, uint8_t order);
13491 uint16x4_t psllh_u (uint16x4_t s, uint8_t amount);
13492 int16x4_t psllh_s (int16x4_t s, uint8_t amount);
13493 uint32x2_t psllw_u (uint32x2_t s, uint8_t amount);
13494 int32x2_t psllw_s (int32x2_t s, uint8_t amount);
13495 uint16x4_t psrlh_u (uint16x4_t s, uint8_t amount);
13496 int16x4_t psrlh_s (int16x4_t s, uint8_t amount);
13497 uint32x2_t psrlw_u (uint32x2_t s, uint8_t amount);
13498 int32x2_t psrlw_s (int32x2_t s, uint8_t amount);
13499 uint16x4_t psrah_u (uint16x4_t s, uint8_t amount);
13500 int16x4_t psrah_s (int16x4_t s, uint8_t amount);
13501 uint32x2_t psraw_u (uint32x2_t s, uint8_t amount);
13502 int32x2_t psraw_s (int32x2_t s, uint8_t amount);
13503 uint32x2_t psubw_u (uint32x2_t s, uint32x2_t t);
13504 uint16x4_t psubh_u (uint16x4_t s, uint16x4_t t);
13505 uint8x8_t psubb_u (uint8x8_t s, uint8x8_t t);
13506 int32x2_t psubw_s (int32x2_t s, int32x2_t t);
13507 int16x4_t psubh_s (int16x4_t s, int16x4_t t);
13508 int8x8_t psubb_s (int8x8_t s, int8x8_t t);
13509 uint64_t psubd_u (uint64_t s, uint64_t t);
13510 int64_t psubd_s (int64_t s, int64_t t);
13511 int16x4_t psubsh (int16x4_t s, int16x4_t t);
13512 int8x8_t psubsb (int8x8_t s, int8x8_t t);
13513 uint16x4_t psubush (uint16x4_t s, uint16x4_t t);
13514 uint8x8_t psubusb (uint8x8_t s, uint8x8_t t);
13515 uint32x2_t punpckhwd_u (uint32x2_t s, uint32x2_t t);
13516 uint16x4_t punpckhhw_u (uint16x4_t s, uint16x4_t t);
13517 uint8x8_t punpckhbh_u (uint8x8_t s, uint8x8_t t);
13518 int32x2_t punpckhwd_s (int32x2_t s, int32x2_t t);
13519 int16x4_t punpckhhw_s (int16x4_t s, int16x4_t t);
13520 int8x8_t punpckhbh_s (int8x8_t s, int8x8_t t);
13521 uint32x2_t punpcklwd_u (uint32x2_t s, uint32x2_t t);
13522 uint16x4_t punpcklhw_u (uint16x4_t s, uint16x4_t t);
13523 uint8x8_t punpcklbh_u (uint8x8_t s, uint8x8_t t);
13524 int32x2_t punpcklwd_s (int32x2_t s, int32x2_t t);
13525 int16x4_t punpcklhw_s (int16x4_t s, int16x4_t t);
13526 int8x8_t punpcklbh_s (int8x8_t s, int8x8_t t);
13527 @end smallexample
13529 @menu
13530 * Paired-Single Arithmetic::
13531 * Paired-Single Built-in Functions::
13532 * MIPS-3D Built-in Functions::
13533 @end menu
13535 @node Paired-Single Arithmetic
13536 @subsubsection Paired-Single Arithmetic
13538 The table below lists the @code{v2sf} operations for which hardware
13539 support exists.  @code{a}, @code{b} and @code{c} are @code{v2sf}
13540 values and @code{x} is an integral value.
13542 @multitable @columnfractions .50 .50
13543 @item C code @tab MIPS instruction
13544 @item @code{a + b} @tab @code{add.ps}
13545 @item @code{a - b} @tab @code{sub.ps}
13546 @item @code{-a} @tab @code{neg.ps}
13547 @item @code{a * b} @tab @code{mul.ps}
13548 @item @code{a * b + c} @tab @code{madd.ps}
13549 @item @code{a * b - c} @tab @code{msub.ps}
13550 @item @code{-(a * b + c)} @tab @code{nmadd.ps}
13551 @item @code{-(a * b - c)} @tab @code{nmsub.ps}
13552 @item @code{x ? a : b} @tab @code{movn.ps}/@code{movz.ps}
13553 @end multitable
13555 Note that the multiply-accumulate instructions can be disabled
13556 using the command-line option @code{-mno-fused-madd}.
13558 @node Paired-Single Built-in Functions
13559 @subsubsection Paired-Single Built-in Functions
13561 The following paired-single functions map directly to a particular
13562 MIPS instruction.  Please refer to the architecture specification
13563 for details on what each instruction does.
13565 @table @code
13566 @item v2sf __builtin_mips_pll_ps (v2sf, v2sf)
13567 Pair lower lower (@code{pll.ps}).
13569 @item v2sf __builtin_mips_pul_ps (v2sf, v2sf)
13570 Pair upper lower (@code{pul.ps}).
13572 @item v2sf __builtin_mips_plu_ps (v2sf, v2sf)
13573 Pair lower upper (@code{plu.ps}).
13575 @item v2sf __builtin_mips_puu_ps (v2sf, v2sf)
13576 Pair upper upper (@code{puu.ps}).
13578 @item v2sf __builtin_mips_cvt_ps_s (float, float)
13579 Convert pair to paired single (@code{cvt.ps.s}).
13581 @item float __builtin_mips_cvt_s_pl (v2sf)
13582 Convert pair lower to single (@code{cvt.s.pl}).
13584 @item float __builtin_mips_cvt_s_pu (v2sf)
13585 Convert pair upper to single (@code{cvt.s.pu}).
13587 @item v2sf __builtin_mips_abs_ps (v2sf)
13588 Absolute value (@code{abs.ps}).
13590 @item v2sf __builtin_mips_alnv_ps (v2sf, v2sf, int)
13591 Align variable (@code{alnv.ps}).
13593 @emph{Note:} The value of the third parameter must be 0 or 4
13594 modulo 8, otherwise the result is unpredictable.  Please read the
13595 instruction description for details.
13596 @end table
13598 The following multi-instruction functions are also available.
13599 In each case, @var{cond} can be any of the 16 floating-point conditions:
13600 @code{f}, @code{un}, @code{eq}, @code{ueq}, @code{olt}, @code{ult},
13601 @code{ole}, @code{ule}, @code{sf}, @code{ngle}, @code{seq}, @code{ngl},
13602 @code{lt}, @code{nge}, @code{le} or @code{ngt}.
13604 @table @code
13605 @item v2sf __builtin_mips_movt_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
13606 @itemx v2sf __builtin_mips_movf_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
13607 Conditional move based on floating-point comparison (@code{c.@var{cond}.ps},
13608 @code{movt.ps}/@code{movf.ps}).
13610 The @code{movt} functions return the value @var{x} computed by:
13612 @smallexample
13613 c.@var{cond}.ps @var{cc},@var{a},@var{b}
13614 mov.ps @var{x},@var{c}
13615 movt.ps @var{x},@var{d},@var{cc}
13616 @end smallexample
13618 The @code{movf} functions are similar but use @code{movf.ps} instead
13619 of @code{movt.ps}.
13621 @item int __builtin_mips_upper_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
13622 @itemx int __builtin_mips_lower_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
13623 Comparison of two paired-single values (@code{c.@var{cond}.ps},
13624 @code{bc1t}/@code{bc1f}).
13626 These functions compare @var{a} and @var{b} using @code{c.@var{cond}.ps}
13627 and return either the upper or lower half of the result.  For example:
13629 @smallexample
13630 v2sf a, b;
13631 if (__builtin_mips_upper_c_eq_ps (a, b))
13632   upper_halves_are_equal ();
13633 else
13634   upper_halves_are_unequal ();
13636 if (__builtin_mips_lower_c_eq_ps (a, b))
13637   lower_halves_are_equal ();
13638 else
13639   lower_halves_are_unequal ();
13640 @end smallexample
13641 @end table
13643 @node MIPS-3D Built-in Functions
13644 @subsubsection MIPS-3D Built-in Functions
13646 The MIPS-3D Application-Specific Extension (ASE) includes additional
13647 paired-single instructions that are designed to improve the performance
13648 of 3D graphics operations.  Support for these instructions is controlled
13649 by the @option{-mips3d} command-line option.
13651 The functions listed below map directly to a particular MIPS-3D
13652 instruction.  Please refer to the architecture specification for
13653 more details on what each instruction does.
13655 @table @code
13656 @item v2sf __builtin_mips_addr_ps (v2sf, v2sf)
13657 Reduction add (@code{addr.ps}).
13659 @item v2sf __builtin_mips_mulr_ps (v2sf, v2sf)
13660 Reduction multiply (@code{mulr.ps}).
13662 @item v2sf __builtin_mips_cvt_pw_ps (v2sf)
13663 Convert paired single to paired word (@code{cvt.pw.ps}).
13665 @item v2sf __builtin_mips_cvt_ps_pw (v2sf)
13666 Convert paired word to paired single (@code{cvt.ps.pw}).
13668 @item float __builtin_mips_recip1_s (float)
13669 @itemx double __builtin_mips_recip1_d (double)
13670 @itemx v2sf __builtin_mips_recip1_ps (v2sf)
13671 Reduced-precision reciprocal (sequence step 1) (@code{recip1.@var{fmt}}).
13673 @item float __builtin_mips_recip2_s (float, float)
13674 @itemx double __builtin_mips_recip2_d (double, double)
13675 @itemx v2sf __builtin_mips_recip2_ps (v2sf, v2sf)
13676 Reduced-precision reciprocal (sequence step 2) (@code{recip2.@var{fmt}}).
13678 @item float __builtin_mips_rsqrt1_s (float)
13679 @itemx double __builtin_mips_rsqrt1_d (double)
13680 @itemx v2sf __builtin_mips_rsqrt1_ps (v2sf)
13681 Reduced-precision reciprocal square root (sequence step 1)
13682 (@code{rsqrt1.@var{fmt}}).
13684 @item float __builtin_mips_rsqrt2_s (float, float)
13685 @itemx double __builtin_mips_rsqrt2_d (double, double)
13686 @itemx v2sf __builtin_mips_rsqrt2_ps (v2sf, v2sf)
13687 Reduced-precision reciprocal square root (sequence step 2)
13688 (@code{rsqrt2.@var{fmt}}).
13689 @end table
13691 The following multi-instruction functions are also available.
13692 In each case, @var{cond} can be any of the 16 floating-point conditions:
13693 @code{f}, @code{un}, @code{eq}, @code{ueq}, @code{olt}, @code{ult},
13694 @code{ole}, @code{ule}, @code{sf}, @code{ngle}, @code{seq},
13695 @code{ngl}, @code{lt}, @code{nge}, @code{le} or @code{ngt}.
13697 @table @code
13698 @item int __builtin_mips_cabs_@var{cond}_s (float @var{a}, float @var{b})
13699 @itemx int __builtin_mips_cabs_@var{cond}_d (double @var{a}, double @var{b})
13700 Absolute comparison of two scalar values (@code{cabs.@var{cond}.@var{fmt}},
13701 @code{bc1t}/@code{bc1f}).
13703 These functions compare @var{a} and @var{b} using @code{cabs.@var{cond}.s}
13704 or @code{cabs.@var{cond}.d} and return the result as a boolean value.
13705 For example:
13707 @smallexample
13708 float a, b;
13709 if (__builtin_mips_cabs_eq_s (a, b))
13710   true ();
13711 else
13712   false ();
13713 @end smallexample
13715 @item int __builtin_mips_upper_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
13716 @itemx int __builtin_mips_lower_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
13717 Absolute comparison of two paired-single values (@code{cabs.@var{cond}.ps},
13718 @code{bc1t}/@code{bc1f}).
13720 These functions compare @var{a} and @var{b} using @code{cabs.@var{cond}.ps}
13721 and return either the upper or lower half of the result.  For example:
13723 @smallexample
13724 v2sf a, b;
13725 if (__builtin_mips_upper_cabs_eq_ps (a, b))
13726   upper_halves_are_equal ();
13727 else
13728   upper_halves_are_unequal ();
13730 if (__builtin_mips_lower_cabs_eq_ps (a, b))
13731   lower_halves_are_equal ();
13732 else
13733   lower_halves_are_unequal ();
13734 @end smallexample
13736 @item v2sf __builtin_mips_movt_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
13737 @itemx v2sf __builtin_mips_movf_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
13738 Conditional move based on absolute comparison (@code{cabs.@var{cond}.ps},
13739 @code{movt.ps}/@code{movf.ps}).
13741 The @code{movt} functions return the value @var{x} computed by:
13743 @smallexample
13744 cabs.@var{cond}.ps @var{cc},@var{a},@var{b}
13745 mov.ps @var{x},@var{c}
13746 movt.ps @var{x},@var{d},@var{cc}
13747 @end smallexample
13749 The @code{movf} functions are similar but use @code{movf.ps} instead
13750 of @code{movt.ps}.
13752 @item int __builtin_mips_any_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
13753 @itemx int __builtin_mips_all_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
13754 @itemx int __builtin_mips_any_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
13755 @itemx int __builtin_mips_all_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
13756 Comparison of two paired-single values
13757 (@code{c.@var{cond}.ps}/@code{cabs.@var{cond}.ps},
13758 @code{bc1any2t}/@code{bc1any2f}).
13760 These functions compare @var{a} and @var{b} using @code{c.@var{cond}.ps}
13761 or @code{cabs.@var{cond}.ps}.  The @code{any} forms return true if either
13762 result is true and the @code{all} forms return true if both results are true.
13763 For example:
13765 @smallexample
13766 v2sf a, b;
13767 if (__builtin_mips_any_c_eq_ps (a, b))
13768   one_is_true ();
13769 else
13770   both_are_false ();
13772 if (__builtin_mips_all_c_eq_ps (a, b))
13773   both_are_true ();
13774 else
13775   one_is_false ();
13776 @end smallexample
13778 @item int __builtin_mips_any_c_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
13779 @itemx int __builtin_mips_all_c_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
13780 @itemx int __builtin_mips_any_cabs_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
13781 @itemx int __builtin_mips_all_cabs_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
13782 Comparison of four paired-single values
13783 (@code{c.@var{cond}.ps}/@code{cabs.@var{cond}.ps},
13784 @code{bc1any4t}/@code{bc1any4f}).
13786 These functions use @code{c.@var{cond}.ps} or @code{cabs.@var{cond}.ps}
13787 to compare @var{a} with @var{b} and to compare @var{c} with @var{d}.
13788 The @code{any} forms return true if any of the four results are true
13789 and the @code{all} forms return true if all four results are true.
13790 For example:
13792 @smallexample
13793 v2sf a, b, c, d;
13794 if (__builtin_mips_any_c_eq_4s (a, b, c, d))
13795   some_are_true ();
13796 else
13797   all_are_false ();
13799 if (__builtin_mips_all_c_eq_4s (a, b, c, d))
13800   all_are_true ();
13801 else
13802   some_are_false ();
13803 @end smallexample
13804 @end table
13806 @node MIPS SIMD Architecture (MSA) Support
13807 @subsection MIPS SIMD Architecture (MSA) Support
13809 @menu
13810 * MIPS SIMD Architecture Built-in Functions::
13811 @end menu
13813 GCC provides intrinsics to access the SIMD instructions provided by the
13814 MSA MIPS SIMD Architecture.  The interface is made available by including
13815 @code{<msa.h>} and using @option{-mmsa -mhard-float -mfp64 -mnan=2008}.
13816 For each @code{__builtin_msa_*}, there is a shortened name of the intrinsic,
13817 @code{__msa_*}.
13819 MSA implements 128-bit wide vector registers, operating on 8-, 16-, 32- and
13820 64-bit integer, 16- and 32-bit fixed-point, or 32- and 64-bit floating point
13821 data elements.  The following vectors typedefs are included in @code{msa.h}:
13822 @itemize
13823 @item @code{v16i8}, a vector of sixteen signed 8-bit integers;
13824 @item @code{v16u8}, a vector of sixteen unsigned 8-bit integers;
13825 @item @code{v8i16}, a vector of eight signed 16-bit integers;
13826 @item @code{v8u16}, a vector of eight unsigned 16-bit integers;
13827 @item @code{v4i32}, a vector of four signed 32-bit integers;
13828 @item @code{v4u32}, a vector of four unsigned 32-bit integers;
13829 @item @code{v2i64}, a vector of two signed 64-bit integers;
13830 @item @code{v2u64}, a vector of two unsigned 64-bit integers;
13831 @item @code{v4f32}, a vector of four 32-bit floats;
13832 @item @code{v2f64}, a vector of two 64-bit doubles.
13833 @end itemize
13835 Intructions and corresponding built-ins may have additional restrictions and/or
13836 input/output values manipulated:
13837 @itemize
13838 @item @code{imm0_1}, an integer literal in range 0 to 1;
13839 @item @code{imm0_3}, an integer literal in range 0 to 3;
13840 @item @code{imm0_7}, an integer literal in range 0 to 7;
13841 @item @code{imm0_15}, an integer literal in range 0 to 15;
13842 @item @code{imm0_31}, an integer literal in range 0 to 31;
13843 @item @code{imm0_63}, an integer literal in range 0 to 63;
13844 @item @code{imm0_255}, an integer literal in range 0 to 255;
13845 @item @code{imm_n16_15}, an integer literal in range -16 to 15;
13846 @item @code{imm_n512_511}, an integer literal in range -512 to 511;
13847 @item @code{imm_n1024_1022}, an integer literal in range -512 to 511 left
13848 shifted by 1 bit, i.e., -1024, -1022, @dots{}, 1020, 1022;
13849 @item @code{imm_n2048_2044}, an integer literal in range -512 to 511 left
13850 shifted by 2 bits, i.e., -2048, -2044, @dots{}, 2040, 2044;
13851 @item @code{imm_n4096_4088}, an integer literal in range -512 to 511 left
13852 shifted by 3 bits, i.e., -4096, -4088, @dots{}, 4080, 4088;
13853 @item @code{imm1_4}, an integer literal in range 1 to 4;
13854 @item @code{i32, i64, u32, u64, f32, f64}, defined as follows:
13855 @end itemize
13857 @smallexample
13859 typedef int i32;
13860 #if __LONG_MAX__ == __LONG_LONG_MAX__
13861 typedef long i64;
13862 #else
13863 typedef long long i64;
13864 #endif
13866 typedef unsigned int u32;
13867 #if __LONG_MAX__ == __LONG_LONG_MAX__
13868 typedef unsigned long u64;
13869 #else
13870 typedef unsigned long long u64;
13871 #endif
13873 typedef double f64;
13874 typedef float f32;
13876 @end smallexample
13878 @node MIPS SIMD Architecture Built-in Functions
13879 @subsubsection MIPS SIMD Architecture Built-in Functions
13881 The intrinsics provided are listed below; each is named after the
13882 machine instruction.
13884 @smallexample
13885 v16i8 __builtin_msa_add_a_b (v16i8, v16i8);
13886 v8i16 __builtin_msa_add_a_h (v8i16, v8i16);
13887 v4i32 __builtin_msa_add_a_w (v4i32, v4i32);
13888 v2i64 __builtin_msa_add_a_d (v2i64, v2i64);
13890 v16i8 __builtin_msa_adds_a_b (v16i8, v16i8);
13891 v8i16 __builtin_msa_adds_a_h (v8i16, v8i16);
13892 v4i32 __builtin_msa_adds_a_w (v4i32, v4i32);
13893 v2i64 __builtin_msa_adds_a_d (v2i64, v2i64);
13895 v16i8 __builtin_msa_adds_s_b (v16i8, v16i8);
13896 v8i16 __builtin_msa_adds_s_h (v8i16, v8i16);
13897 v4i32 __builtin_msa_adds_s_w (v4i32, v4i32);
13898 v2i64 __builtin_msa_adds_s_d (v2i64, v2i64);
13900 v16u8 __builtin_msa_adds_u_b (v16u8, v16u8);
13901 v8u16 __builtin_msa_adds_u_h (v8u16, v8u16);
13902 v4u32 __builtin_msa_adds_u_w (v4u32, v4u32);
13903 v2u64 __builtin_msa_adds_u_d (v2u64, v2u64);
13905 v16i8 __builtin_msa_addv_b (v16i8, v16i8);
13906 v8i16 __builtin_msa_addv_h (v8i16, v8i16);
13907 v4i32 __builtin_msa_addv_w (v4i32, v4i32);
13908 v2i64 __builtin_msa_addv_d (v2i64, v2i64);
13910 v16i8 __builtin_msa_addvi_b (v16i8, imm0_31);
13911 v8i16 __builtin_msa_addvi_h (v8i16, imm0_31);
13912 v4i32 __builtin_msa_addvi_w (v4i32, imm0_31);
13913 v2i64 __builtin_msa_addvi_d (v2i64, imm0_31);
13915 v16u8 __builtin_msa_and_v (v16u8, v16u8);
13917 v16u8 __builtin_msa_andi_b (v16u8, imm0_255);
13919 v16i8 __builtin_msa_asub_s_b (v16i8, v16i8);
13920 v8i16 __builtin_msa_asub_s_h (v8i16, v8i16);
13921 v4i32 __builtin_msa_asub_s_w (v4i32, v4i32);
13922 v2i64 __builtin_msa_asub_s_d (v2i64, v2i64);
13924 v16u8 __builtin_msa_asub_u_b (v16u8, v16u8);
13925 v8u16 __builtin_msa_asub_u_h (v8u16, v8u16);
13926 v4u32 __builtin_msa_asub_u_w (v4u32, v4u32);
13927 v2u64 __builtin_msa_asub_u_d (v2u64, v2u64);
13929 v16i8 __builtin_msa_ave_s_b (v16i8, v16i8);
13930 v8i16 __builtin_msa_ave_s_h (v8i16, v8i16);
13931 v4i32 __builtin_msa_ave_s_w (v4i32, v4i32);
13932 v2i64 __builtin_msa_ave_s_d (v2i64, v2i64);
13934 v16u8 __builtin_msa_ave_u_b (v16u8, v16u8);
13935 v8u16 __builtin_msa_ave_u_h (v8u16, v8u16);
13936 v4u32 __builtin_msa_ave_u_w (v4u32, v4u32);
13937 v2u64 __builtin_msa_ave_u_d (v2u64, v2u64);
13939 v16i8 __builtin_msa_aver_s_b (v16i8, v16i8);
13940 v8i16 __builtin_msa_aver_s_h (v8i16, v8i16);
13941 v4i32 __builtin_msa_aver_s_w (v4i32, v4i32);
13942 v2i64 __builtin_msa_aver_s_d (v2i64, v2i64);
13944 v16u8 __builtin_msa_aver_u_b (v16u8, v16u8);
13945 v8u16 __builtin_msa_aver_u_h (v8u16, v8u16);
13946 v4u32 __builtin_msa_aver_u_w (v4u32, v4u32);
13947 v2u64 __builtin_msa_aver_u_d (v2u64, v2u64);
13949 v16u8 __builtin_msa_bclr_b (v16u8, v16u8);
13950 v8u16 __builtin_msa_bclr_h (v8u16, v8u16);
13951 v4u32 __builtin_msa_bclr_w (v4u32, v4u32);
13952 v2u64 __builtin_msa_bclr_d (v2u64, v2u64);
13954 v16u8 __builtin_msa_bclri_b (v16u8, imm0_7);
13955 v8u16 __builtin_msa_bclri_h (v8u16, imm0_15);
13956 v4u32 __builtin_msa_bclri_w (v4u32, imm0_31);
13957 v2u64 __builtin_msa_bclri_d (v2u64, imm0_63);
13959 v16u8 __builtin_msa_binsl_b (v16u8, v16u8, v16u8);
13960 v8u16 __builtin_msa_binsl_h (v8u16, v8u16, v8u16);
13961 v4u32 __builtin_msa_binsl_w (v4u32, v4u32, v4u32);
13962 v2u64 __builtin_msa_binsl_d (v2u64, v2u64, v2u64);
13964 v16u8 __builtin_msa_binsli_b (v16u8, v16u8, imm0_7);
13965 v8u16 __builtin_msa_binsli_h (v8u16, v8u16, imm0_15);
13966 v4u32 __builtin_msa_binsli_w (v4u32, v4u32, imm0_31);
13967 v2u64 __builtin_msa_binsli_d (v2u64, v2u64, imm0_63);
13969 v16u8 __builtin_msa_binsr_b (v16u8, v16u8, v16u8);
13970 v8u16 __builtin_msa_binsr_h (v8u16, v8u16, v8u16);
13971 v4u32 __builtin_msa_binsr_w (v4u32, v4u32, v4u32);
13972 v2u64 __builtin_msa_binsr_d (v2u64, v2u64, v2u64);
13974 v16u8 __builtin_msa_binsri_b (v16u8, v16u8, imm0_7);
13975 v8u16 __builtin_msa_binsri_h (v8u16, v8u16, imm0_15);
13976 v4u32 __builtin_msa_binsri_w (v4u32, v4u32, imm0_31);
13977 v2u64 __builtin_msa_binsri_d (v2u64, v2u64, imm0_63);
13979 v16u8 __builtin_msa_bmnz_v (v16u8, v16u8, v16u8);
13981 v16u8 __builtin_msa_bmnzi_b (v16u8, v16u8, imm0_255);
13983 v16u8 __builtin_msa_bmz_v (v16u8, v16u8, v16u8);
13985 v16u8 __builtin_msa_bmzi_b (v16u8, v16u8, imm0_255);
13987 v16u8 __builtin_msa_bneg_b (v16u8, v16u8);
13988 v8u16 __builtin_msa_bneg_h (v8u16, v8u16);
13989 v4u32 __builtin_msa_bneg_w (v4u32, v4u32);
13990 v2u64 __builtin_msa_bneg_d (v2u64, v2u64);
13992 v16u8 __builtin_msa_bnegi_b (v16u8, imm0_7);
13993 v8u16 __builtin_msa_bnegi_h (v8u16, imm0_15);
13994 v4u32 __builtin_msa_bnegi_w (v4u32, imm0_31);
13995 v2u64 __builtin_msa_bnegi_d (v2u64, imm0_63);
13997 i32 __builtin_msa_bnz_b (v16u8);
13998 i32 __builtin_msa_bnz_h (v8u16);
13999 i32 __builtin_msa_bnz_w (v4u32);
14000 i32 __builtin_msa_bnz_d (v2u64);
14002 i32 __builtin_msa_bnz_v (v16u8);
14004 v16u8 __builtin_msa_bsel_v (v16u8, v16u8, v16u8);
14006 v16u8 __builtin_msa_bseli_b (v16u8, v16u8, imm0_255);
14008 v16u8 __builtin_msa_bset_b (v16u8, v16u8);
14009 v8u16 __builtin_msa_bset_h (v8u16, v8u16);
14010 v4u32 __builtin_msa_bset_w (v4u32, v4u32);
14011 v2u64 __builtin_msa_bset_d (v2u64, v2u64);
14013 v16u8 __builtin_msa_bseti_b (v16u8, imm0_7);
14014 v8u16 __builtin_msa_bseti_h (v8u16, imm0_15);
14015 v4u32 __builtin_msa_bseti_w (v4u32, imm0_31);
14016 v2u64 __builtin_msa_bseti_d (v2u64, imm0_63);
14018 i32 __builtin_msa_bz_b (v16u8);
14019 i32 __builtin_msa_bz_h (v8u16);
14020 i32 __builtin_msa_bz_w (v4u32);
14021 i32 __builtin_msa_bz_d (v2u64);
14023 i32 __builtin_msa_bz_v (v16u8);
14025 v16i8 __builtin_msa_ceq_b (v16i8, v16i8);
14026 v8i16 __builtin_msa_ceq_h (v8i16, v8i16);
14027 v4i32 __builtin_msa_ceq_w (v4i32, v4i32);
14028 v2i64 __builtin_msa_ceq_d (v2i64, v2i64);
14030 v16i8 __builtin_msa_ceqi_b (v16i8, imm_n16_15);
14031 v8i16 __builtin_msa_ceqi_h (v8i16, imm_n16_15);
14032 v4i32 __builtin_msa_ceqi_w (v4i32, imm_n16_15);
14033 v2i64 __builtin_msa_ceqi_d (v2i64, imm_n16_15);
14035 i32 __builtin_msa_cfcmsa (imm0_31);
14037 v16i8 __builtin_msa_cle_s_b (v16i8, v16i8);
14038 v8i16 __builtin_msa_cle_s_h (v8i16, v8i16);
14039 v4i32 __builtin_msa_cle_s_w (v4i32, v4i32);
14040 v2i64 __builtin_msa_cle_s_d (v2i64, v2i64);
14042 v16i8 __builtin_msa_cle_u_b (v16u8, v16u8);
14043 v8i16 __builtin_msa_cle_u_h (v8u16, v8u16);
14044 v4i32 __builtin_msa_cle_u_w (v4u32, v4u32);
14045 v2i64 __builtin_msa_cle_u_d (v2u64, v2u64);
14047 v16i8 __builtin_msa_clei_s_b (v16i8, imm_n16_15);
14048 v8i16 __builtin_msa_clei_s_h (v8i16, imm_n16_15);
14049 v4i32 __builtin_msa_clei_s_w (v4i32, imm_n16_15);
14050 v2i64 __builtin_msa_clei_s_d (v2i64, imm_n16_15);
14052 v16i8 __builtin_msa_clei_u_b (v16u8, imm0_31);
14053 v8i16 __builtin_msa_clei_u_h (v8u16, imm0_31);
14054 v4i32 __builtin_msa_clei_u_w (v4u32, imm0_31);
14055 v2i64 __builtin_msa_clei_u_d (v2u64, imm0_31);
14057 v16i8 __builtin_msa_clt_s_b (v16i8, v16i8);
14058 v8i16 __builtin_msa_clt_s_h (v8i16, v8i16);
14059 v4i32 __builtin_msa_clt_s_w (v4i32, v4i32);
14060 v2i64 __builtin_msa_clt_s_d (v2i64, v2i64);
14062 v16i8 __builtin_msa_clt_u_b (v16u8, v16u8);
14063 v8i16 __builtin_msa_clt_u_h (v8u16, v8u16);
14064 v4i32 __builtin_msa_clt_u_w (v4u32, v4u32);
14065 v2i64 __builtin_msa_clt_u_d (v2u64, v2u64);
14067 v16i8 __builtin_msa_clti_s_b (v16i8, imm_n16_15);
14068 v8i16 __builtin_msa_clti_s_h (v8i16, imm_n16_15);
14069 v4i32 __builtin_msa_clti_s_w (v4i32, imm_n16_15);
14070 v2i64 __builtin_msa_clti_s_d (v2i64, imm_n16_15);
14072 v16i8 __builtin_msa_clti_u_b (v16u8, imm0_31);
14073 v8i16 __builtin_msa_clti_u_h (v8u16, imm0_31);
14074 v4i32 __builtin_msa_clti_u_w (v4u32, imm0_31);
14075 v2i64 __builtin_msa_clti_u_d (v2u64, imm0_31);
14077 i32 __builtin_msa_copy_s_b (v16i8, imm0_15);
14078 i32 __builtin_msa_copy_s_h (v8i16, imm0_7);
14079 i32 __builtin_msa_copy_s_w (v4i32, imm0_3);
14080 i64 __builtin_msa_copy_s_d (v2i64, imm0_1);
14082 u32 __builtin_msa_copy_u_b (v16i8, imm0_15);
14083 u32 __builtin_msa_copy_u_h (v8i16, imm0_7);
14084 u32 __builtin_msa_copy_u_w (v4i32, imm0_3);
14085 u64 __builtin_msa_copy_u_d (v2i64, imm0_1);
14087 void __builtin_msa_ctcmsa (imm0_31, i32);
14089 v16i8 __builtin_msa_div_s_b (v16i8, v16i8);
14090 v8i16 __builtin_msa_div_s_h (v8i16, v8i16);
14091 v4i32 __builtin_msa_div_s_w (v4i32, v4i32);
14092 v2i64 __builtin_msa_div_s_d (v2i64, v2i64);
14094 v16u8 __builtin_msa_div_u_b (v16u8, v16u8);
14095 v8u16 __builtin_msa_div_u_h (v8u16, v8u16);
14096 v4u32 __builtin_msa_div_u_w (v4u32, v4u32);
14097 v2u64 __builtin_msa_div_u_d (v2u64, v2u64);
14099 v8i16 __builtin_msa_dotp_s_h (v16i8, v16i8);
14100 v4i32 __builtin_msa_dotp_s_w (v8i16, v8i16);
14101 v2i64 __builtin_msa_dotp_s_d (v4i32, v4i32);
14103 v8u16 __builtin_msa_dotp_u_h (v16u8, v16u8);
14104 v4u32 __builtin_msa_dotp_u_w (v8u16, v8u16);
14105 v2u64 __builtin_msa_dotp_u_d (v4u32, v4u32);
14107 v8i16 __builtin_msa_dpadd_s_h (v8i16, v16i8, v16i8);
14108 v4i32 __builtin_msa_dpadd_s_w (v4i32, v8i16, v8i16);
14109 v2i64 __builtin_msa_dpadd_s_d (v2i64, v4i32, v4i32);
14111 v8u16 __builtin_msa_dpadd_u_h (v8u16, v16u8, v16u8);
14112 v4u32 __builtin_msa_dpadd_u_w (v4u32, v8u16, v8u16);
14113 v2u64 __builtin_msa_dpadd_u_d (v2u64, v4u32, v4u32);
14115 v8i16 __builtin_msa_dpsub_s_h (v8i16, v16i8, v16i8);
14116 v4i32 __builtin_msa_dpsub_s_w (v4i32, v8i16, v8i16);
14117 v2i64 __builtin_msa_dpsub_s_d (v2i64, v4i32, v4i32);
14119 v8i16 __builtin_msa_dpsub_u_h (v8i16, v16u8, v16u8);
14120 v4i32 __builtin_msa_dpsub_u_w (v4i32, v8u16, v8u16);
14121 v2i64 __builtin_msa_dpsub_u_d (v2i64, v4u32, v4u32);
14123 v4f32 __builtin_msa_fadd_w (v4f32, v4f32);
14124 v2f64 __builtin_msa_fadd_d (v2f64, v2f64);
14126 v4i32 __builtin_msa_fcaf_w (v4f32, v4f32);
14127 v2i64 __builtin_msa_fcaf_d (v2f64, v2f64);
14129 v4i32 __builtin_msa_fceq_w (v4f32, v4f32);
14130 v2i64 __builtin_msa_fceq_d (v2f64, v2f64);
14132 v4i32 __builtin_msa_fclass_w (v4f32);
14133 v2i64 __builtin_msa_fclass_d (v2f64);
14135 v4i32 __builtin_msa_fcle_w (v4f32, v4f32);
14136 v2i64 __builtin_msa_fcle_d (v2f64, v2f64);
14138 v4i32 __builtin_msa_fclt_w (v4f32, v4f32);
14139 v2i64 __builtin_msa_fclt_d (v2f64, v2f64);
14141 v4i32 __builtin_msa_fcne_w (v4f32, v4f32);
14142 v2i64 __builtin_msa_fcne_d (v2f64, v2f64);
14144 v4i32 __builtin_msa_fcor_w (v4f32, v4f32);
14145 v2i64 __builtin_msa_fcor_d (v2f64, v2f64);
14147 v4i32 __builtin_msa_fcueq_w (v4f32, v4f32);
14148 v2i64 __builtin_msa_fcueq_d (v2f64, v2f64);
14150 v4i32 __builtin_msa_fcule_w (v4f32, v4f32);
14151 v2i64 __builtin_msa_fcule_d (v2f64, v2f64);
14153 v4i32 __builtin_msa_fcult_w (v4f32, v4f32);
14154 v2i64 __builtin_msa_fcult_d (v2f64, v2f64);
14156 v4i32 __builtin_msa_fcun_w (v4f32, v4f32);
14157 v2i64 __builtin_msa_fcun_d (v2f64, v2f64);
14159 v4i32 __builtin_msa_fcune_w (v4f32, v4f32);
14160 v2i64 __builtin_msa_fcune_d (v2f64, v2f64);
14162 v4f32 __builtin_msa_fdiv_w (v4f32, v4f32);
14163 v2f64 __builtin_msa_fdiv_d (v2f64, v2f64);
14165 v8i16 __builtin_msa_fexdo_h (v4f32, v4f32);
14166 v4f32 __builtin_msa_fexdo_w (v2f64, v2f64);
14168 v4f32 __builtin_msa_fexp2_w (v4f32, v4i32);
14169 v2f64 __builtin_msa_fexp2_d (v2f64, v2i64);
14171 v4f32 __builtin_msa_fexupl_w (v8i16);
14172 v2f64 __builtin_msa_fexupl_d (v4f32);
14174 v4f32 __builtin_msa_fexupr_w (v8i16);
14175 v2f64 __builtin_msa_fexupr_d (v4f32);
14177 v4f32 __builtin_msa_ffint_s_w (v4i32);
14178 v2f64 __builtin_msa_ffint_s_d (v2i64);
14180 v4f32 __builtin_msa_ffint_u_w (v4u32);
14181 v2f64 __builtin_msa_ffint_u_d (v2u64);
14183 v4f32 __builtin_msa_ffql_w (v8i16);
14184 v2f64 __builtin_msa_ffql_d (v4i32);
14186 v4f32 __builtin_msa_ffqr_w (v8i16);
14187 v2f64 __builtin_msa_ffqr_d (v4i32);
14189 v16i8 __builtin_msa_fill_b (i32);
14190 v8i16 __builtin_msa_fill_h (i32);
14191 v4i32 __builtin_msa_fill_w (i32);
14192 v2i64 __builtin_msa_fill_d (i64);
14194 v4f32 __builtin_msa_flog2_w (v4f32);
14195 v2f64 __builtin_msa_flog2_d (v2f64);
14197 v4f32 __builtin_msa_fmadd_w (v4f32, v4f32, v4f32);
14198 v2f64 __builtin_msa_fmadd_d (v2f64, v2f64, v2f64);
14200 v4f32 __builtin_msa_fmax_w (v4f32, v4f32);
14201 v2f64 __builtin_msa_fmax_d (v2f64, v2f64);
14203 v4f32 __builtin_msa_fmax_a_w (v4f32, v4f32);
14204 v2f64 __builtin_msa_fmax_a_d (v2f64, v2f64);
14206 v4f32 __builtin_msa_fmin_w (v4f32, v4f32);
14207 v2f64 __builtin_msa_fmin_d (v2f64, v2f64);
14209 v4f32 __builtin_msa_fmin_a_w (v4f32, v4f32);
14210 v2f64 __builtin_msa_fmin_a_d (v2f64, v2f64);
14212 v4f32 __builtin_msa_fmsub_w (v4f32, v4f32, v4f32);
14213 v2f64 __builtin_msa_fmsub_d (v2f64, v2f64, v2f64);
14215 v4f32 __builtin_msa_fmul_w (v4f32, v4f32);
14216 v2f64 __builtin_msa_fmul_d (v2f64, v2f64);
14218 v4f32 __builtin_msa_frint_w (v4f32);
14219 v2f64 __builtin_msa_frint_d (v2f64);
14221 v4f32 __builtin_msa_frcp_w (v4f32);
14222 v2f64 __builtin_msa_frcp_d (v2f64);
14224 v4f32 __builtin_msa_frsqrt_w (v4f32);
14225 v2f64 __builtin_msa_frsqrt_d (v2f64);
14227 v4i32 __builtin_msa_fsaf_w (v4f32, v4f32);
14228 v2i64 __builtin_msa_fsaf_d (v2f64, v2f64);
14230 v4i32 __builtin_msa_fseq_w (v4f32, v4f32);
14231 v2i64 __builtin_msa_fseq_d (v2f64, v2f64);
14233 v4i32 __builtin_msa_fsle_w (v4f32, v4f32);
14234 v2i64 __builtin_msa_fsle_d (v2f64, v2f64);
14236 v4i32 __builtin_msa_fslt_w (v4f32, v4f32);
14237 v2i64 __builtin_msa_fslt_d (v2f64, v2f64);
14239 v4i32 __builtin_msa_fsne_w (v4f32, v4f32);
14240 v2i64 __builtin_msa_fsne_d (v2f64, v2f64);
14242 v4i32 __builtin_msa_fsor_w (v4f32, v4f32);
14243 v2i64 __builtin_msa_fsor_d (v2f64, v2f64);
14245 v4f32 __builtin_msa_fsqrt_w (v4f32);
14246 v2f64 __builtin_msa_fsqrt_d (v2f64);
14248 v4f32 __builtin_msa_fsub_w (v4f32, v4f32);
14249 v2f64 __builtin_msa_fsub_d (v2f64, v2f64);
14251 v4i32 __builtin_msa_fsueq_w (v4f32, v4f32);
14252 v2i64 __builtin_msa_fsueq_d (v2f64, v2f64);
14254 v4i32 __builtin_msa_fsule_w (v4f32, v4f32);
14255 v2i64 __builtin_msa_fsule_d (v2f64, v2f64);
14257 v4i32 __builtin_msa_fsult_w (v4f32, v4f32);
14258 v2i64 __builtin_msa_fsult_d (v2f64, v2f64);
14260 v4i32 __builtin_msa_fsun_w (v4f32, v4f32);
14261 v2i64 __builtin_msa_fsun_d (v2f64, v2f64);
14263 v4i32 __builtin_msa_fsune_w (v4f32, v4f32);
14264 v2i64 __builtin_msa_fsune_d (v2f64, v2f64);
14266 v4i32 __builtin_msa_ftint_s_w (v4f32);
14267 v2i64 __builtin_msa_ftint_s_d (v2f64);
14269 v4u32 __builtin_msa_ftint_u_w (v4f32);
14270 v2u64 __builtin_msa_ftint_u_d (v2f64);
14272 v8i16 __builtin_msa_ftq_h (v4f32, v4f32);
14273 v4i32 __builtin_msa_ftq_w (v2f64, v2f64);
14275 v4i32 __builtin_msa_ftrunc_s_w (v4f32);
14276 v2i64 __builtin_msa_ftrunc_s_d (v2f64);
14278 v4u32 __builtin_msa_ftrunc_u_w (v4f32);
14279 v2u64 __builtin_msa_ftrunc_u_d (v2f64);
14281 v8i16 __builtin_msa_hadd_s_h (v16i8, v16i8);
14282 v4i32 __builtin_msa_hadd_s_w (v8i16, v8i16);
14283 v2i64 __builtin_msa_hadd_s_d (v4i32, v4i32);
14285 v8u16 __builtin_msa_hadd_u_h (v16u8, v16u8);
14286 v4u32 __builtin_msa_hadd_u_w (v8u16, v8u16);
14287 v2u64 __builtin_msa_hadd_u_d (v4u32, v4u32);
14289 v8i16 __builtin_msa_hsub_s_h (v16i8, v16i8);
14290 v4i32 __builtin_msa_hsub_s_w (v8i16, v8i16);
14291 v2i64 __builtin_msa_hsub_s_d (v4i32, v4i32);
14293 v8i16 __builtin_msa_hsub_u_h (v16u8, v16u8);
14294 v4i32 __builtin_msa_hsub_u_w (v8u16, v8u16);
14295 v2i64 __builtin_msa_hsub_u_d (v4u32, v4u32);
14297 v16i8 __builtin_msa_ilvev_b (v16i8, v16i8);
14298 v8i16 __builtin_msa_ilvev_h (v8i16, v8i16);
14299 v4i32 __builtin_msa_ilvev_w (v4i32, v4i32);
14300 v2i64 __builtin_msa_ilvev_d (v2i64, v2i64);
14302 v16i8 __builtin_msa_ilvl_b (v16i8, v16i8);
14303 v8i16 __builtin_msa_ilvl_h (v8i16, v8i16);
14304 v4i32 __builtin_msa_ilvl_w (v4i32, v4i32);
14305 v2i64 __builtin_msa_ilvl_d (v2i64, v2i64);
14307 v16i8 __builtin_msa_ilvod_b (v16i8, v16i8);
14308 v8i16 __builtin_msa_ilvod_h (v8i16, v8i16);
14309 v4i32 __builtin_msa_ilvod_w (v4i32, v4i32);
14310 v2i64 __builtin_msa_ilvod_d (v2i64, v2i64);
14312 v16i8 __builtin_msa_ilvr_b (v16i8, v16i8);
14313 v8i16 __builtin_msa_ilvr_h (v8i16, v8i16);
14314 v4i32 __builtin_msa_ilvr_w (v4i32, v4i32);
14315 v2i64 __builtin_msa_ilvr_d (v2i64, v2i64);
14317 v16i8 __builtin_msa_insert_b (v16i8, imm0_15, i32);
14318 v8i16 __builtin_msa_insert_h (v8i16, imm0_7, i32);
14319 v4i32 __builtin_msa_insert_w (v4i32, imm0_3, i32);
14320 v2i64 __builtin_msa_insert_d (v2i64, imm0_1, i64);
14322 v16i8 __builtin_msa_insve_b (v16i8, imm0_15, v16i8);
14323 v8i16 __builtin_msa_insve_h (v8i16, imm0_7, v8i16);
14324 v4i32 __builtin_msa_insve_w (v4i32, imm0_3, v4i32);
14325 v2i64 __builtin_msa_insve_d (v2i64, imm0_1, v2i64);
14327 v16i8 __builtin_msa_ld_b (void *, imm_n512_511);
14328 v8i16 __builtin_msa_ld_h (void *, imm_n1024_1022);
14329 v4i32 __builtin_msa_ld_w (void *, imm_n2048_2044);
14330 v2i64 __builtin_msa_ld_d (void *, imm_n4096_4088);
14332 v16i8 __builtin_msa_ldi_b (imm_n512_511);
14333 v8i16 __builtin_msa_ldi_h (imm_n512_511);
14334 v4i32 __builtin_msa_ldi_w (imm_n512_511);
14335 v2i64 __builtin_msa_ldi_d (imm_n512_511);
14337 v8i16 __builtin_msa_madd_q_h (v8i16, v8i16, v8i16);
14338 v4i32 __builtin_msa_madd_q_w (v4i32, v4i32, v4i32);
14340 v8i16 __builtin_msa_maddr_q_h (v8i16, v8i16, v8i16);
14341 v4i32 __builtin_msa_maddr_q_w (v4i32, v4i32, v4i32);
14343 v16i8 __builtin_msa_maddv_b (v16i8, v16i8, v16i8);
14344 v8i16 __builtin_msa_maddv_h (v8i16, v8i16, v8i16);
14345 v4i32 __builtin_msa_maddv_w (v4i32, v4i32, v4i32);
14346 v2i64 __builtin_msa_maddv_d (v2i64, v2i64, v2i64);
14348 v16i8 __builtin_msa_max_a_b (v16i8, v16i8);
14349 v8i16 __builtin_msa_max_a_h (v8i16, v8i16);
14350 v4i32 __builtin_msa_max_a_w (v4i32, v4i32);
14351 v2i64 __builtin_msa_max_a_d (v2i64, v2i64);
14353 v16i8 __builtin_msa_max_s_b (v16i8, v16i8);
14354 v8i16 __builtin_msa_max_s_h (v8i16, v8i16);
14355 v4i32 __builtin_msa_max_s_w (v4i32, v4i32);
14356 v2i64 __builtin_msa_max_s_d (v2i64, v2i64);
14358 v16u8 __builtin_msa_max_u_b (v16u8, v16u8);
14359 v8u16 __builtin_msa_max_u_h (v8u16, v8u16);
14360 v4u32 __builtin_msa_max_u_w (v4u32, v4u32);
14361 v2u64 __builtin_msa_max_u_d (v2u64, v2u64);
14363 v16i8 __builtin_msa_maxi_s_b (v16i8, imm_n16_15);
14364 v8i16 __builtin_msa_maxi_s_h (v8i16, imm_n16_15);
14365 v4i32 __builtin_msa_maxi_s_w (v4i32, imm_n16_15);
14366 v2i64 __builtin_msa_maxi_s_d (v2i64, imm_n16_15);
14368 v16u8 __builtin_msa_maxi_u_b (v16u8, imm0_31);
14369 v8u16 __builtin_msa_maxi_u_h (v8u16, imm0_31);
14370 v4u32 __builtin_msa_maxi_u_w (v4u32, imm0_31);
14371 v2u64 __builtin_msa_maxi_u_d (v2u64, imm0_31);
14373 v16i8 __builtin_msa_min_a_b (v16i8, v16i8);
14374 v8i16 __builtin_msa_min_a_h (v8i16, v8i16);
14375 v4i32 __builtin_msa_min_a_w (v4i32, v4i32);
14376 v2i64 __builtin_msa_min_a_d (v2i64, v2i64);
14378 v16i8 __builtin_msa_min_s_b (v16i8, v16i8);
14379 v8i16 __builtin_msa_min_s_h (v8i16, v8i16);
14380 v4i32 __builtin_msa_min_s_w (v4i32, v4i32);
14381 v2i64 __builtin_msa_min_s_d (v2i64, v2i64);
14383 v16u8 __builtin_msa_min_u_b (v16u8, v16u8);
14384 v8u16 __builtin_msa_min_u_h (v8u16, v8u16);
14385 v4u32 __builtin_msa_min_u_w (v4u32, v4u32);
14386 v2u64 __builtin_msa_min_u_d (v2u64, v2u64);
14388 v16i8 __builtin_msa_mini_s_b (v16i8, imm_n16_15);
14389 v8i16 __builtin_msa_mini_s_h (v8i16, imm_n16_15);
14390 v4i32 __builtin_msa_mini_s_w (v4i32, imm_n16_15);
14391 v2i64 __builtin_msa_mini_s_d (v2i64, imm_n16_15);
14393 v16u8 __builtin_msa_mini_u_b (v16u8, imm0_31);
14394 v8u16 __builtin_msa_mini_u_h (v8u16, imm0_31);
14395 v4u32 __builtin_msa_mini_u_w (v4u32, imm0_31);
14396 v2u64 __builtin_msa_mini_u_d (v2u64, imm0_31);
14398 v16i8 __builtin_msa_mod_s_b (v16i8, v16i8);
14399 v8i16 __builtin_msa_mod_s_h (v8i16, v8i16);
14400 v4i32 __builtin_msa_mod_s_w (v4i32, v4i32);
14401 v2i64 __builtin_msa_mod_s_d (v2i64, v2i64);
14403 v16u8 __builtin_msa_mod_u_b (v16u8, v16u8);
14404 v8u16 __builtin_msa_mod_u_h (v8u16, v8u16);
14405 v4u32 __builtin_msa_mod_u_w (v4u32, v4u32);
14406 v2u64 __builtin_msa_mod_u_d (v2u64, v2u64);
14408 v16i8 __builtin_msa_move_v (v16i8);
14410 v8i16 __builtin_msa_msub_q_h (v8i16, v8i16, v8i16);
14411 v4i32 __builtin_msa_msub_q_w (v4i32, v4i32, v4i32);
14413 v8i16 __builtin_msa_msubr_q_h (v8i16, v8i16, v8i16);
14414 v4i32 __builtin_msa_msubr_q_w (v4i32, v4i32, v4i32);
14416 v16i8 __builtin_msa_msubv_b (v16i8, v16i8, v16i8);
14417 v8i16 __builtin_msa_msubv_h (v8i16, v8i16, v8i16);
14418 v4i32 __builtin_msa_msubv_w (v4i32, v4i32, v4i32);
14419 v2i64 __builtin_msa_msubv_d (v2i64, v2i64, v2i64);
14421 v8i16 __builtin_msa_mul_q_h (v8i16, v8i16);
14422 v4i32 __builtin_msa_mul_q_w (v4i32, v4i32);
14424 v8i16 __builtin_msa_mulr_q_h (v8i16, v8i16);
14425 v4i32 __builtin_msa_mulr_q_w (v4i32, v4i32);
14427 v16i8 __builtin_msa_mulv_b (v16i8, v16i8);
14428 v8i16 __builtin_msa_mulv_h (v8i16, v8i16);
14429 v4i32 __builtin_msa_mulv_w (v4i32, v4i32);
14430 v2i64 __builtin_msa_mulv_d (v2i64, v2i64);
14432 v16i8 __builtin_msa_nloc_b (v16i8);
14433 v8i16 __builtin_msa_nloc_h (v8i16);
14434 v4i32 __builtin_msa_nloc_w (v4i32);
14435 v2i64 __builtin_msa_nloc_d (v2i64);
14437 v16i8 __builtin_msa_nlzc_b (v16i8);
14438 v8i16 __builtin_msa_nlzc_h (v8i16);
14439 v4i32 __builtin_msa_nlzc_w (v4i32);
14440 v2i64 __builtin_msa_nlzc_d (v2i64);
14442 v16u8 __builtin_msa_nor_v (v16u8, v16u8);
14444 v16u8 __builtin_msa_nori_b (v16u8, imm0_255);
14446 v16u8 __builtin_msa_or_v (v16u8, v16u8);
14448 v16u8 __builtin_msa_ori_b (v16u8, imm0_255);
14450 v16i8 __builtin_msa_pckev_b (v16i8, v16i8);
14451 v8i16 __builtin_msa_pckev_h (v8i16, v8i16);
14452 v4i32 __builtin_msa_pckev_w (v4i32, v4i32);
14453 v2i64 __builtin_msa_pckev_d (v2i64, v2i64);
14455 v16i8 __builtin_msa_pckod_b (v16i8, v16i8);
14456 v8i16 __builtin_msa_pckod_h (v8i16, v8i16);
14457 v4i32 __builtin_msa_pckod_w (v4i32, v4i32);
14458 v2i64 __builtin_msa_pckod_d (v2i64, v2i64);
14460 v16i8 __builtin_msa_pcnt_b (v16i8);
14461 v8i16 __builtin_msa_pcnt_h (v8i16);
14462 v4i32 __builtin_msa_pcnt_w (v4i32);
14463 v2i64 __builtin_msa_pcnt_d (v2i64);
14465 v16i8 __builtin_msa_sat_s_b (v16i8, imm0_7);
14466 v8i16 __builtin_msa_sat_s_h (v8i16, imm0_15);
14467 v4i32 __builtin_msa_sat_s_w (v4i32, imm0_31);
14468 v2i64 __builtin_msa_sat_s_d (v2i64, imm0_63);
14470 v16u8 __builtin_msa_sat_u_b (v16u8, imm0_7);
14471 v8u16 __builtin_msa_sat_u_h (v8u16, imm0_15);
14472 v4u32 __builtin_msa_sat_u_w (v4u32, imm0_31);
14473 v2u64 __builtin_msa_sat_u_d (v2u64, imm0_63);
14475 v16i8 __builtin_msa_shf_b (v16i8, imm0_255);
14476 v8i16 __builtin_msa_shf_h (v8i16, imm0_255);
14477 v4i32 __builtin_msa_shf_w (v4i32, imm0_255);
14479 v16i8 __builtin_msa_sld_b (v16i8, v16i8, i32);
14480 v8i16 __builtin_msa_sld_h (v8i16, v8i16, i32);
14481 v4i32 __builtin_msa_sld_w (v4i32, v4i32, i32);
14482 v2i64 __builtin_msa_sld_d (v2i64, v2i64, i32);
14484 v16i8 __builtin_msa_sldi_b (v16i8, v16i8, imm0_15);
14485 v8i16 __builtin_msa_sldi_h (v8i16, v8i16, imm0_7);
14486 v4i32 __builtin_msa_sldi_w (v4i32, v4i32, imm0_3);
14487 v2i64 __builtin_msa_sldi_d (v2i64, v2i64, imm0_1);
14489 v16i8 __builtin_msa_sll_b (v16i8, v16i8);
14490 v8i16 __builtin_msa_sll_h (v8i16, v8i16);
14491 v4i32 __builtin_msa_sll_w (v4i32, v4i32);
14492 v2i64 __builtin_msa_sll_d (v2i64, v2i64);
14494 v16i8 __builtin_msa_slli_b (v16i8, imm0_7);
14495 v8i16 __builtin_msa_slli_h (v8i16, imm0_15);
14496 v4i32 __builtin_msa_slli_w (v4i32, imm0_31);
14497 v2i64 __builtin_msa_slli_d (v2i64, imm0_63);
14499 v16i8 __builtin_msa_splat_b (v16i8, i32);
14500 v8i16 __builtin_msa_splat_h (v8i16, i32);
14501 v4i32 __builtin_msa_splat_w (v4i32, i32);
14502 v2i64 __builtin_msa_splat_d (v2i64, i32);
14504 v16i8 __builtin_msa_splati_b (v16i8, imm0_15);
14505 v8i16 __builtin_msa_splati_h (v8i16, imm0_7);
14506 v4i32 __builtin_msa_splati_w (v4i32, imm0_3);
14507 v2i64 __builtin_msa_splati_d (v2i64, imm0_1);
14509 v16i8 __builtin_msa_sra_b (v16i8, v16i8);
14510 v8i16 __builtin_msa_sra_h (v8i16, v8i16);
14511 v4i32 __builtin_msa_sra_w (v4i32, v4i32);
14512 v2i64 __builtin_msa_sra_d (v2i64, v2i64);
14514 v16i8 __builtin_msa_srai_b (v16i8, imm0_7);
14515 v8i16 __builtin_msa_srai_h (v8i16, imm0_15);
14516 v4i32 __builtin_msa_srai_w (v4i32, imm0_31);
14517 v2i64 __builtin_msa_srai_d (v2i64, imm0_63);
14519 v16i8 __builtin_msa_srar_b (v16i8, v16i8);
14520 v8i16 __builtin_msa_srar_h (v8i16, v8i16);
14521 v4i32 __builtin_msa_srar_w (v4i32, v4i32);
14522 v2i64 __builtin_msa_srar_d (v2i64, v2i64);
14524 v16i8 __builtin_msa_srari_b (v16i8, imm0_7);
14525 v8i16 __builtin_msa_srari_h (v8i16, imm0_15);
14526 v4i32 __builtin_msa_srari_w (v4i32, imm0_31);
14527 v2i64 __builtin_msa_srari_d (v2i64, imm0_63);
14529 v16i8 __builtin_msa_srl_b (v16i8, v16i8);
14530 v8i16 __builtin_msa_srl_h (v8i16, v8i16);
14531 v4i32 __builtin_msa_srl_w (v4i32, v4i32);
14532 v2i64 __builtin_msa_srl_d (v2i64, v2i64);
14534 v16i8 __builtin_msa_srli_b (v16i8, imm0_7);
14535 v8i16 __builtin_msa_srli_h (v8i16, imm0_15);
14536 v4i32 __builtin_msa_srli_w (v4i32, imm0_31);
14537 v2i64 __builtin_msa_srli_d (v2i64, imm0_63);
14539 v16i8 __builtin_msa_srlr_b (v16i8, v16i8);
14540 v8i16 __builtin_msa_srlr_h (v8i16, v8i16);
14541 v4i32 __builtin_msa_srlr_w (v4i32, v4i32);
14542 v2i64 __builtin_msa_srlr_d (v2i64, v2i64);
14544 v16i8 __builtin_msa_srlri_b (v16i8, imm0_7);
14545 v8i16 __builtin_msa_srlri_h (v8i16, imm0_15);
14546 v4i32 __builtin_msa_srlri_w (v4i32, imm0_31);
14547 v2i64 __builtin_msa_srlri_d (v2i64, imm0_63);
14549 void __builtin_msa_st_b (v16i8, void *, imm_n512_511);
14550 void __builtin_msa_st_h (v8i16, void *, imm_n1024_1022);
14551 void __builtin_msa_st_w (v4i32, void *, imm_n2048_2044);
14552 void __builtin_msa_st_d (v2i64, void *, imm_n4096_4088);
14554 v16i8 __builtin_msa_subs_s_b (v16i8, v16i8);
14555 v8i16 __builtin_msa_subs_s_h (v8i16, v8i16);
14556 v4i32 __builtin_msa_subs_s_w (v4i32, v4i32);
14557 v2i64 __builtin_msa_subs_s_d (v2i64, v2i64);
14559 v16u8 __builtin_msa_subs_u_b (v16u8, v16u8);
14560 v8u16 __builtin_msa_subs_u_h (v8u16, v8u16);
14561 v4u32 __builtin_msa_subs_u_w (v4u32, v4u32);
14562 v2u64 __builtin_msa_subs_u_d (v2u64, v2u64);
14564 v16u8 __builtin_msa_subsus_u_b (v16u8, v16i8);
14565 v8u16 __builtin_msa_subsus_u_h (v8u16, v8i16);
14566 v4u32 __builtin_msa_subsus_u_w (v4u32, v4i32);
14567 v2u64 __builtin_msa_subsus_u_d (v2u64, v2i64);
14569 v16i8 __builtin_msa_subsuu_s_b (v16u8, v16u8);
14570 v8i16 __builtin_msa_subsuu_s_h (v8u16, v8u16);
14571 v4i32 __builtin_msa_subsuu_s_w (v4u32, v4u32);
14572 v2i64 __builtin_msa_subsuu_s_d (v2u64, v2u64);
14574 v16i8 __builtin_msa_subv_b (v16i8, v16i8);
14575 v8i16 __builtin_msa_subv_h (v8i16, v8i16);
14576 v4i32 __builtin_msa_subv_w (v4i32, v4i32);
14577 v2i64 __builtin_msa_subv_d (v2i64, v2i64);
14579 v16i8 __builtin_msa_subvi_b (v16i8, imm0_31);
14580 v8i16 __builtin_msa_subvi_h (v8i16, imm0_31);
14581 v4i32 __builtin_msa_subvi_w (v4i32, imm0_31);
14582 v2i64 __builtin_msa_subvi_d (v2i64, imm0_31);
14584 v16i8 __builtin_msa_vshf_b (v16i8, v16i8, v16i8);
14585 v8i16 __builtin_msa_vshf_h (v8i16, v8i16, v8i16);
14586 v4i32 __builtin_msa_vshf_w (v4i32, v4i32, v4i32);
14587 v2i64 __builtin_msa_vshf_d (v2i64, v2i64, v2i64);
14589 v16u8 __builtin_msa_xor_v (v16u8, v16u8);
14591 v16u8 __builtin_msa_xori_b (v16u8, imm0_255);
14592 @end smallexample
14594 @node Other MIPS Built-in Functions
14595 @subsection Other MIPS Built-in Functions
14597 GCC provides other MIPS-specific built-in functions:
14599 @table @code
14600 @item void __builtin_mips_cache (int @var{op}, const volatile void *@var{addr})
14601 Insert a @samp{cache} instruction with operands @var{op} and @var{addr}.
14602 GCC defines the preprocessor macro @code{___GCC_HAVE_BUILTIN_MIPS_CACHE}
14603 when this function is available.
14605 @item unsigned int __builtin_mips_get_fcsr (void)
14606 @itemx void __builtin_mips_set_fcsr (unsigned int @var{value})
14607 Get and set the contents of the floating-point control and status register
14608 (FPU control register 31).  These functions are only available in hard-float
14609 code but can be called in both MIPS16 and non-MIPS16 contexts.
14611 @code{__builtin_mips_set_fcsr} can be used to change any bit of the
14612 register except the condition codes, which GCC assumes are preserved.
14613 @end table
14615 @node MSP430 Built-in Functions
14616 @subsection MSP430 Built-in Functions
14618 GCC provides a couple of special builtin functions to aid in the
14619 writing of interrupt handlers in C.
14621 @table @code
14622 @item __bic_SR_register_on_exit (int @var{mask})
14623 This clears the indicated bits in the saved copy of the status register
14624 currently residing on the stack.  This only works inside interrupt
14625 handlers and the changes to the status register will only take affect
14626 once the handler returns.
14628 @item __bis_SR_register_on_exit (int @var{mask})
14629 This sets the indicated bits in the saved copy of the status register
14630 currently residing on the stack.  This only works inside interrupt
14631 handlers and the changes to the status register will only take affect
14632 once the handler returns.
14634 @item __delay_cycles (long long @var{cycles})
14635 This inserts an instruction sequence that takes exactly @var{cycles}
14636 cycles (between 0 and about 17E9) to complete.  The inserted sequence
14637 may use jumps, loops, or no-ops, and does not interfere with any other
14638 instructions.  Note that @var{cycles} must be a compile-time constant
14639 integer - that is, you must pass a number, not a variable that may be
14640 optimized to a constant later.  The number of cycles delayed by this
14641 builtin is exact.
14642 @end table
14644 @node NDS32 Built-in Functions
14645 @subsection NDS32 Built-in Functions
14647 These built-in functions are available for the NDS32 target:
14649 @deftypefn {Built-in Function} void __builtin_nds32_isync (int *@var{addr})
14650 Insert an ISYNC instruction into the instruction stream where
14651 @var{addr} is an instruction address for serialization.
14652 @end deftypefn
14654 @deftypefn {Built-in Function} void __builtin_nds32_isb (void)
14655 Insert an ISB instruction into the instruction stream.
14656 @end deftypefn
14658 @deftypefn {Built-in Function} int __builtin_nds32_mfsr (int @var{sr})
14659 Return the content of a system register which is mapped by @var{sr}.
14660 @end deftypefn
14662 @deftypefn {Built-in Function} int __builtin_nds32_mfusr (int @var{usr})
14663 Return the content of a user space register which is mapped by @var{usr}.
14664 @end deftypefn
14666 @deftypefn {Built-in Function} void __builtin_nds32_mtsr (int @var{value}, int @var{sr})
14667 Move the @var{value} to a system register which is mapped by @var{sr}.
14668 @end deftypefn
14670 @deftypefn {Built-in Function} void __builtin_nds32_mtusr (int @var{value}, int @var{usr})
14671 Move the @var{value} to a user space register which is mapped by @var{usr}.
14672 @end deftypefn
14674 @deftypefn {Built-in Function} void __builtin_nds32_setgie_en (void)
14675 Enable global interrupt.
14676 @end deftypefn
14678 @deftypefn {Built-in Function} void __builtin_nds32_setgie_dis (void)
14679 Disable global interrupt.
14680 @end deftypefn
14682 @node picoChip Built-in Functions
14683 @subsection picoChip Built-in Functions
14685 GCC provides an interface to selected machine instructions from the
14686 picoChip instruction set.
14688 @table @code
14689 @item int __builtin_sbc (int @var{value})
14690 Sign bit count.  Return the number of consecutive bits in @var{value}
14691 that have the same value as the sign bit.  The result is the number of
14692 leading sign bits minus one, giving the number of redundant sign bits in
14693 @var{value}.
14695 @item int __builtin_byteswap (int @var{value})
14696 Byte swap.  Return the result of swapping the upper and lower bytes of
14697 @var{value}.
14699 @item int __builtin_brev (int @var{value})
14700 Bit reversal.  Return the result of reversing the bits in
14701 @var{value}.  Bit 15 is swapped with bit 0, bit 14 is swapped with bit 1,
14702 and so on.
14704 @item int __builtin_adds (int @var{x}, int @var{y})
14705 Saturating addition.  Return the result of adding @var{x} and @var{y},
14706 storing the value 32767 if the result overflows.
14708 @item int __builtin_subs (int @var{x}, int @var{y})
14709 Saturating subtraction.  Return the result of subtracting @var{y} from
14710 @var{x}, storing the value @minus{}32768 if the result overflows.
14712 @item void __builtin_halt (void)
14713 Halt.  The processor stops execution.  This built-in is useful for
14714 implementing assertions.
14716 @end table
14718 @node PowerPC Built-in Functions
14719 @subsection PowerPC Built-in Functions
14721 The following built-in functions are always available and can be used to
14722 check the PowerPC target platform type:
14724 @deftypefn {Built-in Function} void __builtin_cpu_init (void)
14725 This function is a @code{nop} on the PowerPC platform and is included solely
14726 to maintain API compatibility with the x86 builtins.
14727 @end deftypefn
14729 @deftypefn {Built-in Function} int __builtin_cpu_is (const char *@var{cpuname})
14730 This function returns a value of @code{1} if the run-time CPU is of type
14731 @var{cpuname} and returns @code{0} otherwise. The following CPU names can be
14732 detected:
14734 @table @samp
14735 @item power9
14736 IBM POWER9 Server CPU.
14737 @item power8
14738 IBM POWER8 Server CPU.
14739 @item power7
14740 IBM POWER7 Server CPU.
14741 @item power6x
14742 IBM POWER6 Server CPU (RAW mode).
14743 @item power6
14744 IBM POWER6 Server CPU (Architected mode).
14745 @item power5+
14746 IBM POWER5+ Server CPU.
14747 @item power5
14748 IBM POWER5 Server CPU.
14749 @item ppc970
14750 IBM 970 Server CPU (ie, Apple G5).
14751 @item power4
14752 IBM POWER4 Server CPU.
14753 @item ppca2
14754 IBM A2 64-bit Embedded CPU
14755 @item ppc476
14756 IBM PowerPC 476FP 32-bit Embedded CPU.
14757 @item ppc464
14758 IBM PowerPC 464 32-bit Embedded CPU.
14759 @item ppc440
14760 PowerPC 440 32-bit Embedded CPU.
14761 @item ppc405
14762 PowerPC 405 32-bit Embedded CPU.
14763 @item ppc-cell-be
14764 IBM PowerPC Cell Broadband Engine Architecture CPU.
14765 @end table
14767 Here is an example:
14768 @smallexample
14769 if (__builtin_cpu_is ("power8"))
14770   @{
14771      do_power8 (); // POWER8 specific implementation.
14772   @}
14773 else
14774   @{
14775      do_generic (); // Generic implementation.
14776   @}
14777 @end smallexample
14778 @end deftypefn
14780 @deftypefn {Built-in Function} int __builtin_cpu_supports (const char *@var{feature})
14781 This function returns a value of @code{1} if the run-time CPU supports the HWCAP
14782 feature @var{feature} and returns @code{0} otherwise. The following features can be
14783 detected:
14785 @table @samp
14786 @item 4xxmac
14787 4xx CPU has a Multiply Accumulator.
14788 @item altivec
14789 CPU has a SIMD/Vector Unit.
14790 @item arch_2_05
14791 CPU supports ISA 2.05 (eg, POWER6)
14792 @item arch_2_06
14793 CPU supports ISA 2.06 (eg, POWER7)
14794 @item arch_2_07
14795 CPU supports ISA 2.07 (eg, POWER8)
14796 @item arch_3_00
14797 CPU supports ISA 3.0 (eg, POWER9)
14798 @item archpmu
14799 CPU supports the set of compatible performance monitoring events.
14800 @item booke
14801 CPU supports the Embedded ISA category.
14802 @item cellbe
14803 CPU has a CELL broadband engine.
14804 @item dfp
14805 CPU has a decimal floating point unit.
14806 @item dscr
14807 CPU supports the data stream control register.
14808 @item ebb
14809 CPU supports event base branching.
14810 @item efpdouble
14811 CPU has a SPE double precision floating point unit.
14812 @item efpsingle
14813 CPU has a SPE single precision floating point unit.
14814 @item fpu
14815 CPU has a floating point unit.
14816 @item htm
14817 CPU has hardware transaction memory instructions.
14818 @item htm-nosc
14819 Kernel aborts hardware transactions when a syscall is made.
14820 @item ic_snoop
14821 CPU supports icache snooping capabilities.
14822 @item ieee128
14823 CPU supports 128-bit IEEE binary floating point instructions.
14824 @item isel
14825 CPU supports the integer select instruction.
14826 @item mmu
14827 CPU has a memory management unit.
14828 @item notb
14829 CPU does not have a timebase (eg, 601 and 403gx).
14830 @item pa6t
14831 CPU supports the PA Semi 6T CORE ISA.
14832 @item power4
14833 CPU supports ISA 2.00 (eg, POWER4)
14834 @item power5
14835 CPU supports ISA 2.02 (eg, POWER5)
14836 @item power5+
14837 CPU supports ISA 2.03 (eg, POWER5+)
14838 @item power6x
14839 CPU supports ISA 2.05 (eg, POWER6) extended opcodes mffgpr and mftgpr.
14840 @item ppc32
14841 CPU supports 32-bit mode execution.
14842 @item ppc601
14843 CPU supports the old POWER ISA (eg, 601)
14844 @item ppc64
14845 CPU supports 64-bit mode execution.
14846 @item ppcle
14847 CPU supports a little-endian mode that uses address swizzling.
14848 @item smt
14849 CPU support simultaneous multi-threading.
14850 @item spe
14851 CPU has a signal processing extension unit.
14852 @item tar
14853 CPU supports the target address register.
14854 @item true_le
14855 CPU supports true little-endian mode.
14856 @item ucache
14857 CPU has unified I/D cache.
14858 @item vcrypto
14859 CPU supports the vector cryptography instructions.
14860 @item vsx
14861 CPU supports the vector-scalar extension.
14862 @end table
14864 Here is an example:
14865 @smallexample
14866 if (__builtin_cpu_supports ("fpu"))
14867   @{
14868      asm("fadd %0,%1,%2" : "=d"(dst) : "d"(src1), "d"(src2));
14869   @}
14870 else
14871   @{
14872      dst = __fadd (src1, src2); // Software FP addition function.
14873   @}
14874 @end smallexample
14875 @end deftypefn
14877 These built-in functions are available for the PowerPC family of
14878 processors:
14879 @smallexample
14880 float __builtin_recipdivf (float, float);
14881 float __builtin_rsqrtf (float);
14882 double __builtin_recipdiv (double, double);
14883 double __builtin_rsqrt (double);
14884 uint64_t __builtin_ppc_get_timebase ();
14885 unsigned long __builtin_ppc_mftb ();
14886 double __builtin_unpack_longdouble (long double, int);
14887 long double __builtin_pack_longdouble (double, double);
14888 @end smallexample
14890 The @code{vec_rsqrt}, @code{__builtin_rsqrt}, and
14891 @code{__builtin_rsqrtf} functions generate multiple instructions to
14892 implement the reciprocal sqrt functionality using reciprocal sqrt
14893 estimate instructions.
14895 The @code{__builtin_recipdiv}, and @code{__builtin_recipdivf}
14896 functions generate multiple instructions to implement division using
14897 the reciprocal estimate instructions.
14899 The @code{__builtin_ppc_get_timebase} and @code{__builtin_ppc_mftb}
14900 functions generate instructions to read the Time Base Register.  The
14901 @code{__builtin_ppc_get_timebase} function may generate multiple
14902 instructions and always returns the 64 bits of the Time Base Register.
14903 The @code{__builtin_ppc_mftb} function always generates one instruction and
14904 returns the Time Base Register value as an unsigned long, throwing away
14905 the most significant word on 32-bit environments.
14907 Additional built-in functions are available for the 64-bit PowerPC
14908 family of processors, for efficient use of 128-bit floating point
14909 (@code{__float128}) values.
14911 The following floating-point built-in functions are available with
14912 @code{-mfloat128} and Altivec support.  All of them implement the
14913 function that is part of the name.
14915 @smallexample
14916 __float128 __builtin_fabsq (__float128)
14917 __float128 __builtin_copysignq (__float128, __float128)
14918 @end smallexample
14920 The following built-in functions are available with @code{-mfloat128}
14921 and Altivec support.
14923 @table @code
14924 @item __float128 __builtin_infq (void)
14925 Similar to @code{__builtin_inf}, except the return type is @code{__float128}.
14926 @findex __builtin_infq
14928 @item __float128 __builtin_huge_valq (void)
14929 Similar to @code{__builtin_huge_val}, except the return type is @code{__float128}.
14930 @findex __builtin_huge_valq
14932 @item __float128 __builtin_nanq (void)
14933 Similar to @code{__builtin_nan}, except the return type is @code{__float128}.
14934 @findex __builtin_nanq
14936 @item __float128 __builtin_nansq (void)
14937 Similar to @code{__builtin_nans}, except the return type is @code{__float128}.
14938 @findex __builtin_nansq
14939 @end table
14941 The following built-in functions are available for the PowerPC family
14942 of processors, starting with ISA 2.06 or later (@option{-mcpu=power7}
14943 or @option{-mpopcntd}):
14944 @smallexample
14945 long __builtin_bpermd (long, long);
14946 int __builtin_divwe (int, int);
14947 int __builtin_divweo (int, int);
14948 unsigned int __builtin_divweu (unsigned int, unsigned int);
14949 unsigned int __builtin_divweuo (unsigned int, unsigned int);
14950 long __builtin_divde (long, long);
14951 long __builtin_divdeo (long, long);
14952 unsigned long __builtin_divdeu (unsigned long, unsigned long);
14953 unsigned long __builtin_divdeuo (unsigned long, unsigned long);
14954 unsigned int cdtbcd (unsigned int);
14955 unsigned int cbcdtd (unsigned int);
14956 unsigned int addg6s (unsigned int, unsigned int);
14957 @end smallexample
14959 The @code{__builtin_divde}, @code{__builtin_divdeo},
14960 @code{__builtin_divdeu}, @code{__builtin_divdeou} functions require a
14961 64-bit environment support ISA 2.06 or later.
14963 The following built-in functions are available for the PowerPC family
14964 of processors, starting with ISA 3.0 or later (@option{-mcpu=power9}):
14965 @smallexample
14966 long long __builtin_darn (void);
14967 long long __builtin_darn_raw (void);
14968 int __builtin_darn_32 (void);
14970 int __builtin_dfp_dtstsfi_lt (unsigned int comparison, _Decimal64 value);
14971 int __builtin_dfp_dtstsfi_lt (unsigned int comparison, _Decimal128 value);
14972 int __builtin_dfp_dtstsfi_lt_dd (unsigned int comparison, _Decimal64 value);
14973 int __builtin_dfp_dtstsfi_lt_td (unsigned int comparison, _Decimal128 value);
14975 int __builtin_dfp_dtstsfi_gt (unsigned int comparison, _Decimal64 value);
14976 int __builtin_dfp_dtstsfi_gt (unsigned int comparison, _Decimal128 value);
14977 int __builtin_dfp_dtstsfi_gt_dd (unsigned int comparison, _Decimal64 value);
14978 int __builtin_dfp_dtstsfi_gt_td (unsigned int comparison, _Decimal128 value);
14980 int __builtin_dfp_dtstsfi_eq (unsigned int comparison, _Decimal64 value);
14981 int __builtin_dfp_dtstsfi_eq (unsigned int comparison, _Decimal128 value);
14982 int __builtin_dfp_dtstsfi_eq_dd (unsigned int comparison, _Decimal64 value);
14983 int __builtin_dfp_dtstsfi_eq_td (unsigned int comparison, _Decimal128 value);
14985 int __builtin_dfp_dtstsfi_ov (unsigned int comparison, _Decimal64 value);
14986 int __builtin_dfp_dtstsfi_ov (unsigned int comparison, _Decimal128 value);
14987 int __builtin_dfp_dtstsfi_ov_dd (unsigned int comparison, _Decimal64 value);
14988 int __builtin_dfp_dtstsfi_ov_td (unsigned int comparison, _Decimal128 value);
14990 unsigned int scalar_extract_exp (double source);
14991 unsigned long long int scalar_extract_sig (double source);
14993 double
14994 scalar_insert_exp (unsigned long long int significand, unsigned long long int exponent);
14996 int scalar_cmp_exp_gt (double arg1, double arg2);
14997 int scalar_cmp_exp_lt (double arg1, double arg2);
14998 int scalar_cmp_exp_eq (double arg1, double arg2);
14999 int scalar_cmp_exp_unordered (double arg1, double arg2);
15001 int scalar_test_data_class (float source, unsigned int condition);
15002 int scalar_test_data_class (double source, unsigned int condition);
15004 int scalar_test_neg (float source);
15005 int scalar_test_neg (double source);
15006 @end smallexample
15008 The @code{__builtin_darn} and @code{__builtin_darn_raw}
15009 functions require a
15010 64-bit environment supporting ISA 3.0 or later.
15011 The @code{__builtin_darn} function provides a 64-bit conditioned
15012 random number.  The @code{__builtin_darn_raw} function provides a
15013 64-bit raw random number.  The @code{__builtin_darn_32} function
15014 provides a 32-bit random number.
15016 The @code{scalar_extract_sig} and @code{scalar_insert_exp}
15017 functions require a 64-bit environment supporting ISA 3.0 or later.
15018 The @code{scalar_extract_exp} and @code{vec_extract_sig} built-in
15019 functions return the significand and exponent respectively of their
15020 @code{source} arguments.  The
15021 @code{scalar_insert_exp} built-in function returns a double-precision
15022 floating point value that is constructed by assembling the values of its
15023 @code{significand} and @code{exponent} arguments.  The sign of the
15024 result is copied from the most significant bit of the
15025 @code{significand} argument.  The significand and exponent components
15026 of the result are composed of the least significant 11 bits of the
15027 @code{significand} argument and the least significant 52 bits of the
15028 @code{exponent} argument.
15030 The @code{scalar_cmp_exp_gt}, @code{scalar_cmp_exp_lt},
15031 @code{scalar_cmp_exp_eq}, and @code{scalar_cmp_exp_unordered} built-in
15032 functions return a non-zero value if @code{arg1} is greater than, less
15033 than, equal to, or not comparable to @code{arg2} respectively.  The
15034 arguments are not comparable if one or the other equals NaN (not a
15035 number). 
15037 The @code{scalar_test_data_class} built-in functions return a non-zero
15038 value if any of the condition tests enabled by the value of the
15039 @code{condition} variable are true.  The
15040 @code{condition} argument must be an unsigned integer with value not
15041 exceeding 127.  The
15042 @code{condition} argument is encoded as a bitmask with each bit
15043 enabling the testing of a different condition, as characterized by the
15044 following:
15045 @smallexample
15046 0x40    Test for NaN
15047 0x20    Test for +Infinity
15048 0x10    Test for -Infinity
15049 0x08    Test for +Zero
15050 0x04    Test for -Zero
15051 0x02    Test for +Denormal
15052 0x01    Test for -Denormal
15053 @end smallexample
15055 If all of the enabled test conditions are false, the return value is 0.
15057 The @code{scalar_test_neg} built-in functions return a non-zero value
15058 if their @code{source} argument holds a negative value.
15060 The @code{__builtin_dfp_dtstsfi_lt} function returns a non-zero value
15061 if and only if the number of signficant digits of its @code{value} argument
15062 is less than its @code{comparison} argument.  The
15063 @code{__builtin_dfp_dtstsfi_lt_dd} and
15064 @code{__builtin_dfp_dtstsfi_lt_td} functions behave similarly, but
15065 require that the type of the @code{value} argument be
15066 @code{__Decimal64} and @code{__Decimal128} respectively.
15068 The @code{__builtin_dfp_dtstsfi_gt} function returns a non-zero value
15069 if and only if the number of signficant digits of its @code{value} argument
15070 is greater than its @code{comparison} argument.  The
15071 @code{__builtin_dfp_dtstsfi_gt_dd} and
15072 @code{__builtin_dfp_dtstsfi_gt_td} functions behave similarly, but
15073 require that the type of the @code{value} argument be
15074 @code{__Decimal64} and @code{__Decimal128} respectively.
15076 The @code{__builtin_dfp_dtstsfi_eq} function returns a non-zero value
15077 if and only if the number of signficant digits of its @code{value} argument
15078 equals its @code{comparison} argument.  The
15079 @code{__builtin_dfp_dtstsfi_eq_dd} and
15080 @code{__builtin_dfp_dtstsfi_eq_td} functions behave similarly, but
15081 require that the type of the @code{value} argument be
15082 @code{__Decimal64} and @code{__Decimal128} respectively.
15084 The @code{__builtin_dfp_dtstsfi_ov} function returns a non-zero value
15085 if and only if its @code{value} argument has an undefined number of
15086 significant digits, such as when @code{value} is an encoding of @code{NaN}.
15087 The @code{__builtin_dfp_dtstsfi_ov_dd} and
15088 @code{__builtin_dfp_dtstsfi_ov_td} functions behave similarly, but
15089 require that the type of the @code{value} argument be
15090 @code{__Decimal64} and @code{__Decimal128} respectively.
15092 The following built-in functions are available for the PowerPC family
15093 of processors when hardware decimal floating point
15094 (@option{-mhard-dfp}) is available:
15095 @smallexample
15096 _Decimal64 __builtin_dxex (_Decimal64);
15097 _Decimal128 __builtin_dxexq (_Decimal128);
15098 _Decimal64 __builtin_ddedpd (int, _Decimal64);
15099 _Decimal128 __builtin_ddedpdq (int, _Decimal128);
15100 _Decimal64 __builtin_denbcd (int, _Decimal64);
15101 _Decimal128 __builtin_denbcdq (int, _Decimal128);
15102 _Decimal64 __builtin_diex (_Decimal64, _Decimal64);
15103 _Decimal128 _builtin_diexq (_Decimal128, _Decimal128);
15104 _Decimal64 __builtin_dscli (_Decimal64, int);
15105 _Decimal128 __builtin_dscliq (_Decimal128, int);
15106 _Decimal64 __builtin_dscri (_Decimal64, int);
15107 _Decimal128 __builtin_dscriq (_Decimal128, int);
15108 unsigned long long __builtin_unpack_dec128 (_Decimal128, int);
15109 _Decimal128 __builtin_pack_dec128 (unsigned long long, unsigned long long);
15110 @end smallexample
15112 The following built-in functions are available for the PowerPC family
15113 of processors when the Vector Scalar (vsx) instruction set is
15114 available:
15115 @smallexample
15116 unsigned long long __builtin_unpack_vector_int128 (vector __int128_t, int);
15117 vector __int128_t __builtin_pack_vector_int128 (unsigned long long,
15118                                                 unsigned long long);
15119 @end smallexample
15121 @node PowerPC AltiVec/VSX Built-in Functions
15122 @subsection PowerPC AltiVec Built-in Functions
15124 GCC provides an interface for the PowerPC family of processors to access
15125 the AltiVec operations described in Motorola's AltiVec Programming
15126 Interface Manual.  The interface is made available by including
15127 @code{<altivec.h>} and using @option{-maltivec} and
15128 @option{-mabi=altivec}.  The interface supports the following vector
15129 types.
15131 @smallexample
15132 vector unsigned char
15133 vector signed char
15134 vector bool char
15136 vector unsigned short
15137 vector signed short
15138 vector bool short
15139 vector pixel
15141 vector unsigned int
15142 vector signed int
15143 vector bool int
15144 vector float
15145 @end smallexample
15147 If @option{-mvsx} is used the following additional vector types are
15148 implemented.
15150 @smallexample
15151 vector unsigned long
15152 vector signed long
15153 vector double
15154 @end smallexample
15156 The long types are only implemented for 64-bit code generation, and
15157 the long type is only used in the floating point/integer conversion
15158 instructions.
15160 GCC's implementation of the high-level language interface available from
15161 C and C++ code differs from Motorola's documentation in several ways.
15163 @itemize @bullet
15165 @item
15166 A vector constant is a list of constant expressions within curly braces.
15168 @item
15169 A vector initializer requires no cast if the vector constant is of the
15170 same type as the variable it is initializing.
15172 @item
15173 If @code{signed} or @code{unsigned} is omitted, the signedness of the
15174 vector type is the default signedness of the base type.  The default
15175 varies depending on the operating system, so a portable program should
15176 always specify the signedness.
15178 @item
15179 Compiling with @option{-maltivec} adds keywords @code{__vector},
15180 @code{vector}, @code{__pixel}, @code{pixel}, @code{__bool} and
15181 @code{bool}.  When compiling ISO C, the context-sensitive substitution
15182 of the keywords @code{vector}, @code{pixel} and @code{bool} is
15183 disabled.  To use them, you must include @code{<altivec.h>} instead.
15185 @item
15186 GCC allows using a @code{typedef} name as the type specifier for a
15187 vector type.
15189 @item
15190 For C, overloaded functions are implemented with macros so the following
15191 does not work:
15193 @smallexample
15194   vec_add ((vector signed int)@{1, 2, 3, 4@}, foo);
15195 @end smallexample
15197 @noindent
15198 Since @code{vec_add} is a macro, the vector constant in the example
15199 is treated as four separate arguments.  Wrap the entire argument in
15200 parentheses for this to work.
15201 @end itemize
15203 @emph{Note:} Only the @code{<altivec.h>} interface is supported.
15204 Internally, GCC uses built-in functions to achieve the functionality in
15205 the aforementioned header file, but they are not supported and are
15206 subject to change without notice.
15208 The following interfaces are supported for the generic and specific
15209 AltiVec operations and the AltiVec predicates.  In cases where there
15210 is a direct mapping between generic and specific operations, only the
15211 generic names are shown here, although the specific operations can also
15212 be used.
15214 Arguments that are documented as @code{const int} require literal
15215 integral values within the range required for that operation.
15217 @smallexample
15218 vector signed char vec_abs (vector signed char);
15219 vector signed short vec_abs (vector signed short);
15220 vector signed int vec_abs (vector signed int);
15221 vector float vec_abs (vector float);
15223 vector signed char vec_abss (vector signed char);
15224 vector signed short vec_abss (vector signed short);
15225 vector signed int vec_abss (vector signed int);
15227 vector signed char vec_add (vector bool char, vector signed char);
15228 vector signed char vec_add (vector signed char, vector bool char);
15229 vector signed char vec_add (vector signed char, vector signed char);
15230 vector unsigned char vec_add (vector bool char, vector unsigned char);
15231 vector unsigned char vec_add (vector unsigned char, vector bool char);
15232 vector unsigned char vec_add (vector unsigned char,
15233                               vector unsigned char);
15234 vector signed short vec_add (vector bool short, vector signed short);
15235 vector signed short vec_add (vector signed short, vector bool short);
15236 vector signed short vec_add (vector signed short, vector signed short);
15237 vector unsigned short vec_add (vector bool short,
15238                                vector unsigned short);
15239 vector unsigned short vec_add (vector unsigned short,
15240                                vector bool short);
15241 vector unsigned short vec_add (vector unsigned short,
15242                                vector unsigned short);
15243 vector signed int vec_add (vector bool int, vector signed int);
15244 vector signed int vec_add (vector signed int, vector bool int);
15245 vector signed int vec_add (vector signed int, vector signed int);
15246 vector unsigned int vec_add (vector bool int, vector unsigned int);
15247 vector unsigned int vec_add (vector unsigned int, vector bool int);
15248 vector unsigned int vec_add (vector unsigned int, vector unsigned int);
15249 vector float vec_add (vector float, vector float);
15251 vector float vec_vaddfp (vector float, vector float);
15253 vector signed int vec_vadduwm (vector bool int, vector signed int);
15254 vector signed int vec_vadduwm (vector signed int, vector bool int);
15255 vector signed int vec_vadduwm (vector signed int, vector signed int);
15256 vector unsigned int vec_vadduwm (vector bool int, vector unsigned int);
15257 vector unsigned int vec_vadduwm (vector unsigned int, vector bool int);
15258 vector unsigned int vec_vadduwm (vector unsigned int,
15259                                  vector unsigned int);
15261 vector signed short vec_vadduhm (vector bool short,
15262                                  vector signed short);
15263 vector signed short vec_vadduhm (vector signed short,
15264                                  vector bool short);
15265 vector signed short vec_vadduhm (vector signed short,
15266                                  vector signed short);
15267 vector unsigned short vec_vadduhm (vector bool short,
15268                                    vector unsigned short);
15269 vector unsigned short vec_vadduhm (vector unsigned short,
15270                                    vector bool short);
15271 vector unsigned short vec_vadduhm (vector unsigned short,
15272                                    vector unsigned short);
15274 vector signed char vec_vaddubm (vector bool char, vector signed char);
15275 vector signed char vec_vaddubm (vector signed char, vector bool char);
15276 vector signed char vec_vaddubm (vector signed char, vector signed char);
15277 vector unsigned char vec_vaddubm (vector bool char,
15278                                   vector unsigned char);
15279 vector unsigned char vec_vaddubm (vector unsigned char,
15280                                   vector bool char);
15281 vector unsigned char vec_vaddubm (vector unsigned char,
15282                                   vector unsigned char);
15284 vector unsigned int vec_addc (vector unsigned int, vector unsigned int);
15286 vector unsigned char vec_adds (vector bool char, vector unsigned char);
15287 vector unsigned char vec_adds (vector unsigned char, vector bool char);
15288 vector unsigned char vec_adds (vector unsigned char,
15289                                vector unsigned char);
15290 vector signed char vec_adds (vector bool char, vector signed char);
15291 vector signed char vec_adds (vector signed char, vector bool char);
15292 vector signed char vec_adds (vector signed char, vector signed char);
15293 vector unsigned short vec_adds (vector bool short,
15294                                 vector unsigned short);
15295 vector unsigned short vec_adds (vector unsigned short,
15296                                 vector bool short);
15297 vector unsigned short vec_adds (vector unsigned short,
15298                                 vector unsigned short);
15299 vector signed short vec_adds (vector bool short, vector signed short);
15300 vector signed short vec_adds (vector signed short, vector bool short);
15301 vector signed short vec_adds (vector signed short, vector signed short);
15302 vector unsigned int vec_adds (vector bool int, vector unsigned int);
15303 vector unsigned int vec_adds (vector unsigned int, vector bool int);
15304 vector unsigned int vec_adds (vector unsigned int, vector unsigned int);
15305 vector signed int vec_adds (vector bool int, vector signed int);
15306 vector signed int vec_adds (vector signed int, vector bool int);
15307 vector signed int vec_adds (vector signed int, vector signed int);
15309 vector signed int vec_vaddsws (vector bool int, vector signed int);
15310 vector signed int vec_vaddsws (vector signed int, vector bool int);
15311 vector signed int vec_vaddsws (vector signed int, vector signed int);
15313 vector unsigned int vec_vadduws (vector bool int, vector unsigned int);
15314 vector unsigned int vec_vadduws (vector unsigned int, vector bool int);
15315 vector unsigned int vec_vadduws (vector unsigned int,
15316                                  vector unsigned int);
15318 vector signed short vec_vaddshs (vector bool short,
15319                                  vector signed short);
15320 vector signed short vec_vaddshs (vector signed short,
15321                                  vector bool short);
15322 vector signed short vec_vaddshs (vector signed short,
15323                                  vector signed short);
15325 vector unsigned short vec_vadduhs (vector bool short,
15326                                    vector unsigned short);
15327 vector unsigned short vec_vadduhs (vector unsigned short,
15328                                    vector bool short);
15329 vector unsigned short vec_vadduhs (vector unsigned short,
15330                                    vector unsigned short);
15332 vector signed char vec_vaddsbs (vector bool char, vector signed char);
15333 vector signed char vec_vaddsbs (vector signed char, vector bool char);
15334 vector signed char vec_vaddsbs (vector signed char, vector signed char);
15336 vector unsigned char vec_vaddubs (vector bool char,
15337                                   vector unsigned char);
15338 vector unsigned char vec_vaddubs (vector unsigned char,
15339                                   vector bool char);
15340 vector unsigned char vec_vaddubs (vector unsigned char,
15341                                   vector unsigned char);
15343 vector float vec_and (vector float, vector float);
15344 vector float vec_and (vector float, vector bool int);
15345 vector float vec_and (vector bool int, vector float);
15346 vector bool int vec_and (vector bool int, vector bool int);
15347 vector signed int vec_and (vector bool int, vector signed int);
15348 vector signed int vec_and (vector signed int, vector bool int);
15349 vector signed int vec_and (vector signed int, vector signed int);
15350 vector unsigned int vec_and (vector bool int, vector unsigned int);
15351 vector unsigned int vec_and (vector unsigned int, vector bool int);
15352 vector unsigned int vec_and (vector unsigned int, vector unsigned int);
15353 vector bool short vec_and (vector bool short, vector bool short);
15354 vector signed short vec_and (vector bool short, vector signed short);
15355 vector signed short vec_and (vector signed short, vector bool short);
15356 vector signed short vec_and (vector signed short, vector signed short);
15357 vector unsigned short vec_and (vector bool short,
15358                                vector unsigned short);
15359 vector unsigned short vec_and (vector unsigned short,
15360                                vector bool short);
15361 vector unsigned short vec_and (vector unsigned short,
15362                                vector unsigned short);
15363 vector signed char vec_and (vector bool char, vector signed char);
15364 vector bool char vec_and (vector bool char, vector bool char);
15365 vector signed char vec_and (vector signed char, vector bool char);
15366 vector signed char vec_and (vector signed char, vector signed char);
15367 vector unsigned char vec_and (vector bool char, vector unsigned char);
15368 vector unsigned char vec_and (vector unsigned char, vector bool char);
15369 vector unsigned char vec_and (vector unsigned char,
15370                               vector unsigned char);
15372 vector float vec_andc (vector float, vector float);
15373 vector float vec_andc (vector float, vector bool int);
15374 vector float vec_andc (vector bool int, vector float);
15375 vector bool int vec_andc (vector bool int, vector bool int);
15376 vector signed int vec_andc (vector bool int, vector signed int);
15377 vector signed int vec_andc (vector signed int, vector bool int);
15378 vector signed int vec_andc (vector signed int, vector signed int);
15379 vector unsigned int vec_andc (vector bool int, vector unsigned int);
15380 vector unsigned int vec_andc (vector unsigned int, vector bool int);
15381 vector unsigned int vec_andc (vector unsigned int, vector unsigned int);
15382 vector bool short vec_andc (vector bool short, vector bool short);
15383 vector signed short vec_andc (vector bool short, vector signed short);
15384 vector signed short vec_andc (vector signed short, vector bool short);
15385 vector signed short vec_andc (vector signed short, vector signed short);
15386 vector unsigned short vec_andc (vector bool short,
15387                                 vector unsigned short);
15388 vector unsigned short vec_andc (vector unsigned short,
15389                                 vector bool short);
15390 vector unsigned short vec_andc (vector unsigned short,
15391                                 vector unsigned short);
15392 vector signed char vec_andc (vector bool char, vector signed char);
15393 vector bool char vec_andc (vector bool char, vector bool char);
15394 vector signed char vec_andc (vector signed char, vector bool char);
15395 vector signed char vec_andc (vector signed char, vector signed char);
15396 vector unsigned char vec_andc (vector bool char, vector unsigned char);
15397 vector unsigned char vec_andc (vector unsigned char, vector bool char);
15398 vector unsigned char vec_andc (vector unsigned char,
15399                                vector unsigned char);
15401 vector unsigned char vec_avg (vector unsigned char,
15402                               vector unsigned char);
15403 vector signed char vec_avg (vector signed char, vector signed char);
15404 vector unsigned short vec_avg (vector unsigned short,
15405                                vector unsigned short);
15406 vector signed short vec_avg (vector signed short, vector signed short);
15407 vector unsigned int vec_avg (vector unsigned int, vector unsigned int);
15408 vector signed int vec_avg (vector signed int, vector signed int);
15410 vector signed int vec_vavgsw (vector signed int, vector signed int);
15412 vector unsigned int vec_vavguw (vector unsigned int,
15413                                 vector unsigned int);
15415 vector signed short vec_vavgsh (vector signed short,
15416                                 vector signed short);
15418 vector unsigned short vec_vavguh (vector unsigned short,
15419                                   vector unsigned short);
15421 vector signed char vec_vavgsb (vector signed char, vector signed char);
15423 vector unsigned char vec_vavgub (vector unsigned char,
15424                                  vector unsigned char);
15426 vector float vec_copysign (vector float);
15428 vector float vec_ceil (vector float);
15430 vector signed int vec_cmpb (vector float, vector float);
15432 vector bool char vec_cmpeq (vector signed char, vector signed char);
15433 vector bool char vec_cmpeq (vector unsigned char, vector unsigned char);
15434 vector bool short vec_cmpeq (vector signed short, vector signed short);
15435 vector bool short vec_cmpeq (vector unsigned short,
15436                              vector unsigned short);
15437 vector bool int vec_cmpeq (vector signed int, vector signed int);
15438 vector bool int vec_cmpeq (vector unsigned int, vector unsigned int);
15439 vector bool int vec_cmpeq (vector float, vector float);
15441 vector bool int vec_vcmpeqfp (vector float, vector float);
15443 vector bool int vec_vcmpequw (vector signed int, vector signed int);
15444 vector bool int vec_vcmpequw (vector unsigned int, vector unsigned int);
15446 vector bool short vec_vcmpequh (vector signed short,
15447                                 vector signed short);
15448 vector bool short vec_vcmpequh (vector unsigned short,
15449                                 vector unsigned short);
15451 vector bool char vec_vcmpequb (vector signed char, vector signed char);
15452 vector bool char vec_vcmpequb (vector unsigned char,
15453                                vector unsigned char);
15455 vector bool int vec_cmpge (vector float, vector float);
15457 vector bool char vec_cmpgt (vector unsigned char, vector unsigned char);
15458 vector bool char vec_cmpgt (vector signed char, vector signed char);
15459 vector bool short vec_cmpgt (vector unsigned short,
15460                              vector unsigned short);
15461 vector bool short vec_cmpgt (vector signed short, vector signed short);
15462 vector bool int vec_cmpgt (vector unsigned int, vector unsigned int);
15463 vector bool int vec_cmpgt (vector signed int, vector signed int);
15464 vector bool int vec_cmpgt (vector float, vector float);
15466 vector bool int vec_vcmpgtfp (vector float, vector float);
15468 vector bool int vec_vcmpgtsw (vector signed int, vector signed int);
15470 vector bool int vec_vcmpgtuw (vector unsigned int, vector unsigned int);
15472 vector bool short vec_vcmpgtsh (vector signed short,
15473                                 vector signed short);
15475 vector bool short vec_vcmpgtuh (vector unsigned short,
15476                                 vector unsigned short);
15478 vector bool char vec_vcmpgtsb (vector signed char, vector signed char);
15480 vector bool char vec_vcmpgtub (vector unsigned char,
15481                                vector unsigned char);
15483 vector bool int vec_cmple (vector float, vector float);
15485 vector bool char vec_cmplt (vector unsigned char, vector unsigned char);
15486 vector bool char vec_cmplt (vector signed char, vector signed char);
15487 vector bool short vec_cmplt (vector unsigned short,
15488                              vector unsigned short);
15489 vector bool short vec_cmplt (vector signed short, vector signed short);
15490 vector bool int vec_cmplt (vector unsigned int, vector unsigned int);
15491 vector bool int vec_cmplt (vector signed int, vector signed int);
15492 vector bool int vec_cmplt (vector float, vector float);
15494 vector float vec_cpsgn (vector float, vector float);
15496 vector float vec_ctf (vector unsigned int, const int);
15497 vector float vec_ctf (vector signed int, const int);
15498 vector double vec_ctf (vector unsigned long, const int);
15499 vector double vec_ctf (vector signed long, const int);
15501 vector float vec_vcfsx (vector signed int, const int);
15503 vector float vec_vcfux (vector unsigned int, const int);
15505 vector signed int vec_cts (vector float, const int);
15506 vector signed long vec_cts (vector double, const int);
15508 vector unsigned int vec_ctu (vector float, const int);
15509 vector unsigned long vec_ctu (vector double, const int);
15511 void vec_dss (const int);
15513 void vec_dssall (void);
15515 void vec_dst (const vector unsigned char *, int, const int);
15516 void vec_dst (const vector signed char *, int, const int);
15517 void vec_dst (const vector bool char *, int, const int);
15518 void vec_dst (const vector unsigned short *, int, const int);
15519 void vec_dst (const vector signed short *, int, const int);
15520 void vec_dst (const vector bool short *, int, const int);
15521 void vec_dst (const vector pixel *, int, const int);
15522 void vec_dst (const vector unsigned int *, int, const int);
15523 void vec_dst (const vector signed int *, int, const int);
15524 void vec_dst (const vector bool int *, int, const int);
15525 void vec_dst (const vector float *, int, const int);
15526 void vec_dst (const unsigned char *, int, const int);
15527 void vec_dst (const signed char *, int, const int);
15528 void vec_dst (const unsigned short *, int, const int);
15529 void vec_dst (const short *, int, const int);
15530 void vec_dst (const unsigned int *, int, const int);
15531 void vec_dst (const int *, int, const int);
15532 void vec_dst (const unsigned long *, int, const int);
15533 void vec_dst (const long *, int, const int);
15534 void vec_dst (const float *, int, const int);
15536 void vec_dstst (const vector unsigned char *, int, const int);
15537 void vec_dstst (const vector signed char *, int, const int);
15538 void vec_dstst (const vector bool char *, int, const int);
15539 void vec_dstst (const vector unsigned short *, int, const int);
15540 void vec_dstst (const vector signed short *, int, const int);
15541 void vec_dstst (const vector bool short *, int, const int);
15542 void vec_dstst (const vector pixel *, int, const int);
15543 void vec_dstst (const vector unsigned int *, int, const int);
15544 void vec_dstst (const vector signed int *, int, const int);
15545 void vec_dstst (const vector bool int *, int, const int);
15546 void vec_dstst (const vector float *, int, const int);
15547 void vec_dstst (const unsigned char *, int, const int);
15548 void vec_dstst (const signed char *, int, const int);
15549 void vec_dstst (const unsigned short *, int, const int);
15550 void vec_dstst (const short *, int, const int);
15551 void vec_dstst (const unsigned int *, int, const int);
15552 void vec_dstst (const int *, int, const int);
15553 void vec_dstst (const unsigned long *, int, const int);
15554 void vec_dstst (const long *, int, const int);
15555 void vec_dstst (const float *, int, const int);
15557 void vec_dststt (const vector unsigned char *, int, const int);
15558 void vec_dststt (const vector signed char *, int, const int);
15559 void vec_dststt (const vector bool char *, int, const int);
15560 void vec_dststt (const vector unsigned short *, int, const int);
15561 void vec_dststt (const vector signed short *, int, const int);
15562 void vec_dststt (const vector bool short *, int, const int);
15563 void vec_dststt (const vector pixel *, int, const int);
15564 void vec_dststt (const vector unsigned int *, int, const int);
15565 void vec_dststt (const vector signed int *, int, const int);
15566 void vec_dststt (const vector bool int *, int, const int);
15567 void vec_dststt (const vector float *, int, const int);
15568 void vec_dststt (const unsigned char *, int, const int);
15569 void vec_dststt (const signed char *, int, const int);
15570 void vec_dststt (const unsigned short *, int, const int);
15571 void vec_dststt (const short *, int, const int);
15572 void vec_dststt (const unsigned int *, int, const int);
15573 void vec_dststt (const int *, int, const int);
15574 void vec_dststt (const unsigned long *, int, const int);
15575 void vec_dststt (const long *, int, const int);
15576 void vec_dststt (const float *, int, const int);
15578 void vec_dstt (const vector unsigned char *, int, const int);
15579 void vec_dstt (const vector signed char *, int, const int);
15580 void vec_dstt (const vector bool char *, int, const int);
15581 void vec_dstt (const vector unsigned short *, int, const int);
15582 void vec_dstt (const vector signed short *, int, const int);
15583 void vec_dstt (const vector bool short *, int, const int);
15584 void vec_dstt (const vector pixel *, int, const int);
15585 void vec_dstt (const vector unsigned int *, int, const int);
15586 void vec_dstt (const vector signed int *, int, const int);
15587 void vec_dstt (const vector bool int *, int, const int);
15588 void vec_dstt (const vector float *, int, const int);
15589 void vec_dstt (const unsigned char *, int, const int);
15590 void vec_dstt (const signed char *, int, const int);
15591 void vec_dstt (const unsigned short *, int, const int);
15592 void vec_dstt (const short *, int, const int);
15593 void vec_dstt (const unsigned int *, int, const int);
15594 void vec_dstt (const int *, int, const int);
15595 void vec_dstt (const unsigned long *, int, const int);
15596 void vec_dstt (const long *, int, const int);
15597 void vec_dstt (const float *, int, const int);
15599 vector float vec_expte (vector float);
15601 vector float vec_floor (vector float);
15603 vector float vec_ld (int, const vector float *);
15604 vector float vec_ld (int, const float *);
15605 vector bool int vec_ld (int, const vector bool int *);
15606 vector signed int vec_ld (int, const vector signed int *);
15607 vector signed int vec_ld (int, const int *);
15608 vector signed int vec_ld (int, const long *);
15609 vector unsigned int vec_ld (int, const vector unsigned int *);
15610 vector unsigned int vec_ld (int, const unsigned int *);
15611 vector unsigned int vec_ld (int, const unsigned long *);
15612 vector bool short vec_ld (int, const vector bool short *);
15613 vector pixel vec_ld (int, const vector pixel *);
15614 vector signed short vec_ld (int, const vector signed short *);
15615 vector signed short vec_ld (int, const short *);
15616 vector unsigned short vec_ld (int, const vector unsigned short *);
15617 vector unsigned short vec_ld (int, const unsigned short *);
15618 vector bool char vec_ld (int, const vector bool char *);
15619 vector signed char vec_ld (int, const vector signed char *);
15620 vector signed char vec_ld (int, const signed char *);
15621 vector unsigned char vec_ld (int, const vector unsigned char *);
15622 vector unsigned char vec_ld (int, const unsigned char *);
15624 vector signed char vec_lde (int, const signed char *);
15625 vector unsigned char vec_lde (int, const unsigned char *);
15626 vector signed short vec_lde (int, const short *);
15627 vector unsigned short vec_lde (int, const unsigned short *);
15628 vector float vec_lde (int, const float *);
15629 vector signed int vec_lde (int, const int *);
15630 vector unsigned int vec_lde (int, const unsigned int *);
15631 vector signed int vec_lde (int, const long *);
15632 vector unsigned int vec_lde (int, const unsigned long *);
15634 vector float vec_lvewx (int, float *);
15635 vector signed int vec_lvewx (int, int *);
15636 vector unsigned int vec_lvewx (int, unsigned int *);
15637 vector signed int vec_lvewx (int, long *);
15638 vector unsigned int vec_lvewx (int, unsigned long *);
15640 vector signed short vec_lvehx (int, short *);
15641 vector unsigned short vec_lvehx (int, unsigned short *);
15643 vector signed char vec_lvebx (int, char *);
15644 vector unsigned char vec_lvebx (int, unsigned char *);
15646 vector float vec_ldl (int, const vector float *);
15647 vector float vec_ldl (int, const float *);
15648 vector bool int vec_ldl (int, const vector bool int *);
15649 vector signed int vec_ldl (int, const vector signed int *);
15650 vector signed int vec_ldl (int, const int *);
15651 vector signed int vec_ldl (int, const long *);
15652 vector unsigned int vec_ldl (int, const vector unsigned int *);
15653 vector unsigned int vec_ldl (int, const unsigned int *);
15654 vector unsigned int vec_ldl (int, const unsigned long *);
15655 vector bool short vec_ldl (int, const vector bool short *);
15656 vector pixel vec_ldl (int, const vector pixel *);
15657 vector signed short vec_ldl (int, const vector signed short *);
15658 vector signed short vec_ldl (int, const short *);
15659 vector unsigned short vec_ldl (int, const vector unsigned short *);
15660 vector unsigned short vec_ldl (int, const unsigned short *);
15661 vector bool char vec_ldl (int, const vector bool char *);
15662 vector signed char vec_ldl (int, const vector signed char *);
15663 vector signed char vec_ldl (int, const signed char *);
15664 vector unsigned char vec_ldl (int, const vector unsigned char *);
15665 vector unsigned char vec_ldl (int, const unsigned char *);
15667 vector float vec_loge (vector float);
15669 vector unsigned char vec_lvsl (int, const volatile unsigned char *);
15670 vector unsigned char vec_lvsl (int, const volatile signed char *);
15671 vector unsigned char vec_lvsl (int, const volatile unsigned short *);
15672 vector unsigned char vec_lvsl (int, const volatile short *);
15673 vector unsigned char vec_lvsl (int, const volatile unsigned int *);
15674 vector unsigned char vec_lvsl (int, const volatile int *);
15675 vector unsigned char vec_lvsl (int, const volatile unsigned long *);
15676 vector unsigned char vec_lvsl (int, const volatile long *);
15677 vector unsigned char vec_lvsl (int, const volatile float *);
15679 vector unsigned char vec_lvsr (int, const volatile unsigned char *);
15680 vector unsigned char vec_lvsr (int, const volatile signed char *);
15681 vector unsigned char vec_lvsr (int, const volatile unsigned short *);
15682 vector unsigned char vec_lvsr (int, const volatile short *);
15683 vector unsigned char vec_lvsr (int, const volatile unsigned int *);
15684 vector unsigned char vec_lvsr (int, const volatile int *);
15685 vector unsigned char vec_lvsr (int, const volatile unsigned long *);
15686 vector unsigned char vec_lvsr (int, const volatile long *);
15687 vector unsigned char vec_lvsr (int, const volatile float *);
15689 vector float vec_madd (vector float, vector float, vector float);
15691 vector signed short vec_madds (vector signed short,
15692                                vector signed short,
15693                                vector signed short);
15695 vector unsigned char vec_max (vector bool char, vector unsigned char);
15696 vector unsigned char vec_max (vector unsigned char, vector bool char);
15697 vector unsigned char vec_max (vector unsigned char,
15698                               vector unsigned char);
15699 vector signed char vec_max (vector bool char, vector signed char);
15700 vector signed char vec_max (vector signed char, vector bool char);
15701 vector signed char vec_max (vector signed char, vector signed char);
15702 vector unsigned short vec_max (vector bool short,
15703                                vector unsigned short);
15704 vector unsigned short vec_max (vector unsigned short,
15705                                vector bool short);
15706 vector unsigned short vec_max (vector unsigned short,
15707                                vector unsigned short);
15708 vector signed short vec_max (vector bool short, vector signed short);
15709 vector signed short vec_max (vector signed short, vector bool short);
15710 vector signed short vec_max (vector signed short, vector signed short);
15711 vector unsigned int vec_max (vector bool int, vector unsigned int);
15712 vector unsigned int vec_max (vector unsigned int, vector bool int);
15713 vector unsigned int vec_max (vector unsigned int, vector unsigned int);
15714 vector signed int vec_max (vector bool int, vector signed int);
15715 vector signed int vec_max (vector signed int, vector bool int);
15716 vector signed int vec_max (vector signed int, vector signed int);
15717 vector float vec_max (vector float, vector float);
15719 vector float vec_vmaxfp (vector float, vector float);
15721 vector signed int vec_vmaxsw (vector bool int, vector signed int);
15722 vector signed int vec_vmaxsw (vector signed int, vector bool int);
15723 vector signed int vec_vmaxsw (vector signed int, vector signed int);
15725 vector unsigned int vec_vmaxuw (vector bool int, vector unsigned int);
15726 vector unsigned int vec_vmaxuw (vector unsigned int, vector bool int);
15727 vector unsigned int vec_vmaxuw (vector unsigned int,
15728                                 vector unsigned int);
15730 vector signed short vec_vmaxsh (vector bool short, vector signed short);
15731 vector signed short vec_vmaxsh (vector signed short, vector bool short);
15732 vector signed short vec_vmaxsh (vector signed short,
15733                                 vector signed short);
15735 vector unsigned short vec_vmaxuh (vector bool short,
15736                                   vector unsigned short);
15737 vector unsigned short vec_vmaxuh (vector unsigned short,
15738                                   vector bool short);
15739 vector unsigned short vec_vmaxuh (vector unsigned short,
15740                                   vector unsigned short);
15742 vector signed char vec_vmaxsb (vector bool char, vector signed char);
15743 vector signed char vec_vmaxsb (vector signed char, vector bool char);
15744 vector signed char vec_vmaxsb (vector signed char, vector signed char);
15746 vector unsigned char vec_vmaxub (vector bool char,
15747                                  vector unsigned char);
15748 vector unsigned char vec_vmaxub (vector unsigned char,
15749                                  vector bool char);
15750 vector unsigned char vec_vmaxub (vector unsigned char,
15751                                  vector unsigned char);
15753 vector bool char vec_mergeh (vector bool char, vector bool char);
15754 vector signed char vec_mergeh (vector signed char, vector signed char);
15755 vector unsigned char vec_mergeh (vector unsigned char,
15756                                  vector unsigned char);
15757 vector bool short vec_mergeh (vector bool short, vector bool short);
15758 vector pixel vec_mergeh (vector pixel, vector pixel);
15759 vector signed short vec_mergeh (vector signed short,
15760                                 vector signed short);
15761 vector unsigned short vec_mergeh (vector unsigned short,
15762                                   vector unsigned short);
15763 vector float vec_mergeh (vector float, vector float);
15764 vector bool int vec_mergeh (vector bool int, vector bool int);
15765 vector signed int vec_mergeh (vector signed int, vector signed int);
15766 vector unsigned int vec_mergeh (vector unsigned int,
15767                                 vector unsigned int);
15769 vector float vec_vmrghw (vector float, vector float);
15770 vector bool int vec_vmrghw (vector bool int, vector bool int);
15771 vector signed int vec_vmrghw (vector signed int, vector signed int);
15772 vector unsigned int vec_vmrghw (vector unsigned int,
15773                                 vector unsigned int);
15775 vector bool short vec_vmrghh (vector bool short, vector bool short);
15776 vector signed short vec_vmrghh (vector signed short,
15777                                 vector signed short);
15778 vector unsigned short vec_vmrghh (vector unsigned short,
15779                                   vector unsigned short);
15780 vector pixel vec_vmrghh (vector pixel, vector pixel);
15782 vector bool char vec_vmrghb (vector bool char, vector bool char);
15783 vector signed char vec_vmrghb (vector signed char, vector signed char);
15784 vector unsigned char vec_vmrghb (vector unsigned char,
15785                                  vector unsigned char);
15787 vector bool char vec_mergel (vector bool char, vector bool char);
15788 vector signed char vec_mergel (vector signed char, vector signed char);
15789 vector unsigned char vec_mergel (vector unsigned char,
15790                                  vector unsigned char);
15791 vector bool short vec_mergel (vector bool short, vector bool short);
15792 vector pixel vec_mergel (vector pixel, vector pixel);
15793 vector signed short vec_mergel (vector signed short,
15794                                 vector signed short);
15795 vector unsigned short vec_mergel (vector unsigned short,
15796                                   vector unsigned short);
15797 vector float vec_mergel (vector float, vector float);
15798 vector bool int vec_mergel (vector bool int, vector bool int);
15799 vector signed int vec_mergel (vector signed int, vector signed int);
15800 vector unsigned int vec_mergel (vector unsigned int,
15801                                 vector unsigned int);
15803 vector float vec_vmrglw (vector float, vector float);
15804 vector signed int vec_vmrglw (vector signed int, vector signed int);
15805 vector unsigned int vec_vmrglw (vector unsigned int,
15806                                 vector unsigned int);
15807 vector bool int vec_vmrglw (vector bool int, vector bool int);
15809 vector bool short vec_vmrglh (vector bool short, vector bool short);
15810 vector signed short vec_vmrglh (vector signed short,
15811                                 vector signed short);
15812 vector unsigned short vec_vmrglh (vector unsigned short,
15813                                   vector unsigned short);
15814 vector pixel vec_vmrglh (vector pixel, vector pixel);
15816 vector bool char vec_vmrglb (vector bool char, vector bool char);
15817 vector signed char vec_vmrglb (vector signed char, vector signed char);
15818 vector unsigned char vec_vmrglb (vector unsigned char,
15819                                  vector unsigned char);
15821 vector unsigned short vec_mfvscr (void);
15823 vector unsigned char vec_min (vector bool char, vector unsigned char);
15824 vector unsigned char vec_min (vector unsigned char, vector bool char);
15825 vector unsigned char vec_min (vector unsigned char,
15826                               vector unsigned char);
15827 vector signed char vec_min (vector bool char, vector signed char);
15828 vector signed char vec_min (vector signed char, vector bool char);
15829 vector signed char vec_min (vector signed char, vector signed char);
15830 vector unsigned short vec_min (vector bool short,
15831                                vector unsigned short);
15832 vector unsigned short vec_min (vector unsigned short,
15833                                vector bool short);
15834 vector unsigned short vec_min (vector unsigned short,
15835                                vector unsigned short);
15836 vector signed short vec_min (vector bool short, vector signed short);
15837 vector signed short vec_min (vector signed short, vector bool short);
15838 vector signed short vec_min (vector signed short, vector signed short);
15839 vector unsigned int vec_min (vector bool int, vector unsigned int);
15840 vector unsigned int vec_min (vector unsigned int, vector bool int);
15841 vector unsigned int vec_min (vector unsigned int, vector unsigned int);
15842 vector signed int vec_min (vector bool int, vector signed int);
15843 vector signed int vec_min (vector signed int, vector bool int);
15844 vector signed int vec_min (vector signed int, vector signed int);
15845 vector float vec_min (vector float, vector float);
15847 vector float vec_vminfp (vector float, vector float);
15849 vector signed int vec_vminsw (vector bool int, vector signed int);
15850 vector signed int vec_vminsw (vector signed int, vector bool int);
15851 vector signed int vec_vminsw (vector signed int, vector signed int);
15853 vector unsigned int vec_vminuw (vector bool int, vector unsigned int);
15854 vector unsigned int vec_vminuw (vector unsigned int, vector bool int);
15855 vector unsigned int vec_vminuw (vector unsigned int,
15856                                 vector unsigned int);
15858 vector signed short vec_vminsh (vector bool short, vector signed short);
15859 vector signed short vec_vminsh (vector signed short, vector bool short);
15860 vector signed short vec_vminsh (vector signed short,
15861                                 vector signed short);
15863 vector unsigned short vec_vminuh (vector bool short,
15864                                   vector unsigned short);
15865 vector unsigned short vec_vminuh (vector unsigned short,
15866                                   vector bool short);
15867 vector unsigned short vec_vminuh (vector unsigned short,
15868                                   vector unsigned short);
15870 vector signed char vec_vminsb (vector bool char, vector signed char);
15871 vector signed char vec_vminsb (vector signed char, vector bool char);
15872 vector signed char vec_vminsb (vector signed char, vector signed char);
15874 vector unsigned char vec_vminub (vector bool char,
15875                                  vector unsigned char);
15876 vector unsigned char vec_vminub (vector unsigned char,
15877                                  vector bool char);
15878 vector unsigned char vec_vminub (vector unsigned char,
15879                                  vector unsigned char);
15881 vector signed short vec_mladd (vector signed short,
15882                                vector signed short,
15883                                vector signed short);
15884 vector signed short vec_mladd (vector signed short,
15885                                vector unsigned short,
15886                                vector unsigned short);
15887 vector signed short vec_mladd (vector unsigned short,
15888                                vector signed short,
15889                                vector signed short);
15890 vector unsigned short vec_mladd (vector unsigned short,
15891                                  vector unsigned short,
15892                                  vector unsigned short);
15894 vector signed short vec_mradds (vector signed short,
15895                                 vector signed short,
15896                                 vector signed short);
15898 vector unsigned int vec_msum (vector unsigned char,
15899                               vector unsigned char,
15900                               vector unsigned int);
15901 vector signed int vec_msum (vector signed char,
15902                             vector unsigned char,
15903                             vector signed int);
15904 vector unsigned int vec_msum (vector unsigned short,
15905                               vector unsigned short,
15906                               vector unsigned int);
15907 vector signed int vec_msum (vector signed short,
15908                             vector signed short,
15909                             vector signed int);
15911 vector signed int vec_vmsumshm (vector signed short,
15912                                 vector signed short,
15913                                 vector signed int);
15915 vector unsigned int vec_vmsumuhm (vector unsigned short,
15916                                   vector unsigned short,
15917                                   vector unsigned int);
15919 vector signed int vec_vmsummbm (vector signed char,
15920                                 vector unsigned char,
15921                                 vector signed int);
15923 vector unsigned int vec_vmsumubm (vector unsigned char,
15924                                   vector unsigned char,
15925                                   vector unsigned int);
15927 vector unsigned int vec_msums (vector unsigned short,
15928                                vector unsigned short,
15929                                vector unsigned int);
15930 vector signed int vec_msums (vector signed short,
15931                              vector signed short,
15932                              vector signed int);
15934 vector signed int vec_vmsumshs (vector signed short,
15935                                 vector signed short,
15936                                 vector signed int);
15938 vector unsigned int vec_vmsumuhs (vector unsigned short,
15939                                   vector unsigned short,
15940                                   vector unsigned int);
15942 void vec_mtvscr (vector signed int);
15943 void vec_mtvscr (vector unsigned int);
15944 void vec_mtvscr (vector bool int);
15945 void vec_mtvscr (vector signed short);
15946 void vec_mtvscr (vector unsigned short);
15947 void vec_mtvscr (vector bool short);
15948 void vec_mtvscr (vector pixel);
15949 void vec_mtvscr (vector signed char);
15950 void vec_mtvscr (vector unsigned char);
15951 void vec_mtvscr (vector bool char);
15953 vector unsigned short vec_mule (vector unsigned char,
15954                                 vector unsigned char);
15955 vector signed short vec_mule (vector signed char,
15956                               vector signed char);
15957 vector unsigned int vec_mule (vector unsigned short,
15958                               vector unsigned short);
15959 vector signed int vec_mule (vector signed short, vector signed short);
15961 vector signed int vec_vmulesh (vector signed short,
15962                                vector signed short);
15964 vector unsigned int vec_vmuleuh (vector unsigned short,
15965                                  vector unsigned short);
15967 vector signed short vec_vmulesb (vector signed char,
15968                                  vector signed char);
15970 vector unsigned short vec_vmuleub (vector unsigned char,
15971                                   vector unsigned char);
15973 vector unsigned short vec_mulo (vector unsigned char,
15974                                 vector unsigned char);
15975 vector signed short vec_mulo (vector signed char, vector signed char);
15976 vector unsigned int vec_mulo (vector unsigned short,
15977                               vector unsigned short);
15978 vector signed int vec_mulo (vector signed short, vector signed short);
15980 vector signed int vec_vmulosh (vector signed short,
15981                                vector signed short);
15983 vector unsigned int vec_vmulouh (vector unsigned short,
15984                                  vector unsigned short);
15986 vector signed short vec_vmulosb (vector signed char,
15987                                  vector signed char);
15989 vector unsigned short vec_vmuloub (vector unsigned char,
15990                                    vector unsigned char);
15992 vector float vec_nmsub (vector float, vector float, vector float);
15994 vector float vec_nor (vector float, vector float);
15995 vector signed int vec_nor (vector signed int, vector signed int);
15996 vector unsigned int vec_nor (vector unsigned int, vector unsigned int);
15997 vector bool int vec_nor (vector bool int, vector bool int);
15998 vector signed short vec_nor (vector signed short, vector signed short);
15999 vector unsigned short vec_nor (vector unsigned short,
16000                                vector unsigned short);
16001 vector bool short vec_nor (vector bool short, vector bool short);
16002 vector signed char vec_nor (vector signed char, vector signed char);
16003 vector unsigned char vec_nor (vector unsigned char,
16004                               vector unsigned char);
16005 vector bool char vec_nor (vector bool char, vector bool char);
16007 vector float vec_or (vector float, vector float);
16008 vector float vec_or (vector float, vector bool int);
16009 vector float vec_or (vector bool int, vector float);
16010 vector bool int vec_or (vector bool int, vector bool int);
16011 vector signed int vec_or (vector bool int, vector signed int);
16012 vector signed int vec_or (vector signed int, vector bool int);
16013 vector signed int vec_or (vector signed int, vector signed int);
16014 vector unsigned int vec_or (vector bool int, vector unsigned int);
16015 vector unsigned int vec_or (vector unsigned int, vector bool int);
16016 vector unsigned int vec_or (vector unsigned int, vector unsigned int);
16017 vector bool short vec_or (vector bool short, vector bool short);
16018 vector signed short vec_or (vector bool short, vector signed short);
16019 vector signed short vec_or (vector signed short, vector bool short);
16020 vector signed short vec_or (vector signed short, vector signed short);
16021 vector unsigned short vec_or (vector bool short, vector unsigned short);
16022 vector unsigned short vec_or (vector unsigned short, vector bool short);
16023 vector unsigned short vec_or (vector unsigned short,
16024                               vector unsigned short);
16025 vector signed char vec_or (vector bool char, vector signed char);
16026 vector bool char vec_or (vector bool char, vector bool char);
16027 vector signed char vec_or (vector signed char, vector bool char);
16028 vector signed char vec_or (vector signed char, vector signed char);
16029 vector unsigned char vec_or (vector bool char, vector unsigned char);
16030 vector unsigned char vec_or (vector unsigned char, vector bool char);
16031 vector unsigned char vec_or (vector unsigned char,
16032                              vector unsigned char);
16034 vector signed char vec_pack (vector signed short, vector signed short);
16035 vector unsigned char vec_pack (vector unsigned short,
16036                                vector unsigned short);
16037 vector bool char vec_pack (vector bool short, vector bool short);
16038 vector signed short vec_pack (vector signed int, vector signed int);
16039 vector unsigned short vec_pack (vector unsigned int,
16040                                 vector unsigned int);
16041 vector bool short vec_pack (vector bool int, vector bool int);
16043 vector bool short vec_vpkuwum (vector bool int, vector bool int);
16044 vector signed short vec_vpkuwum (vector signed int, vector signed int);
16045 vector unsigned short vec_vpkuwum (vector unsigned int,
16046                                    vector unsigned int);
16048 vector bool char vec_vpkuhum (vector bool short, vector bool short);
16049 vector signed char vec_vpkuhum (vector signed short,
16050                                 vector signed short);
16051 vector unsigned char vec_vpkuhum (vector unsigned short,
16052                                   vector unsigned short);
16054 vector pixel vec_packpx (vector unsigned int, vector unsigned int);
16056 vector unsigned char vec_packs (vector unsigned short,
16057                                 vector unsigned short);
16058 vector signed char vec_packs (vector signed short, vector signed short);
16059 vector unsigned short vec_packs (vector unsigned int,
16060                                  vector unsigned int);
16061 vector signed short vec_packs (vector signed int, vector signed int);
16063 vector signed short vec_vpkswss (vector signed int, vector signed int);
16065 vector unsigned short vec_vpkuwus (vector unsigned int,
16066                                    vector unsigned int);
16068 vector signed char vec_vpkshss (vector signed short,
16069                                 vector signed short);
16071 vector unsigned char vec_vpkuhus (vector unsigned short,
16072                                   vector unsigned short);
16074 vector unsigned char vec_packsu (vector unsigned short,
16075                                  vector unsigned short);
16076 vector unsigned char vec_packsu (vector signed short,
16077                                  vector signed short);
16078 vector unsigned short vec_packsu (vector unsigned int,
16079                                   vector unsigned int);
16080 vector unsigned short vec_packsu (vector signed int, vector signed int);
16082 vector unsigned short vec_vpkswus (vector signed int,
16083                                    vector signed int);
16085 vector unsigned char vec_vpkshus (vector signed short,
16086                                   vector signed short);
16088 vector float vec_perm (vector float,
16089                        vector float,
16090                        vector unsigned char);
16091 vector signed int vec_perm (vector signed int,
16092                             vector signed int,
16093                             vector unsigned char);
16094 vector unsigned int vec_perm (vector unsigned int,
16095                               vector unsigned int,
16096                               vector unsigned char);
16097 vector bool int vec_perm (vector bool int,
16098                           vector bool int,
16099                           vector unsigned char);
16100 vector signed short vec_perm (vector signed short,
16101                               vector signed short,
16102                               vector unsigned char);
16103 vector unsigned short vec_perm (vector unsigned short,
16104                                 vector unsigned short,
16105                                 vector unsigned char);
16106 vector bool short vec_perm (vector bool short,
16107                             vector bool short,
16108                             vector unsigned char);
16109 vector pixel vec_perm (vector pixel,
16110                        vector pixel,
16111                        vector unsigned char);
16112 vector signed char vec_perm (vector signed char,
16113                              vector signed char,
16114                              vector unsigned char);
16115 vector unsigned char vec_perm (vector unsigned char,
16116                                vector unsigned char,
16117                                vector unsigned char);
16118 vector bool char vec_perm (vector bool char,
16119                            vector bool char,
16120                            vector unsigned char);
16122 vector float vec_re (vector float);
16124 vector signed char vec_rl (vector signed char,
16125                            vector unsigned char);
16126 vector unsigned char vec_rl (vector unsigned char,
16127                              vector unsigned char);
16128 vector signed short vec_rl (vector signed short, vector unsigned short);
16129 vector unsigned short vec_rl (vector unsigned short,
16130                               vector unsigned short);
16131 vector signed int vec_rl (vector signed int, vector unsigned int);
16132 vector unsigned int vec_rl (vector unsigned int, vector unsigned int);
16134 vector signed int vec_vrlw (vector signed int, vector unsigned int);
16135 vector unsigned int vec_vrlw (vector unsigned int, vector unsigned int);
16137 vector signed short vec_vrlh (vector signed short,
16138                               vector unsigned short);
16139 vector unsigned short vec_vrlh (vector unsigned short,
16140                                 vector unsigned short);
16142 vector signed char vec_vrlb (vector signed char, vector unsigned char);
16143 vector unsigned char vec_vrlb (vector unsigned char,
16144                                vector unsigned char);
16146 vector float vec_round (vector float);
16148 vector float vec_recip (vector float, vector float);
16150 vector float vec_rsqrt (vector float);
16152 vector float vec_rsqrte (vector float);
16154 vector float vec_sel (vector float, vector float, vector bool int);
16155 vector float vec_sel (vector float, vector float, vector unsigned int);
16156 vector signed int vec_sel (vector signed int,
16157                            vector signed int,
16158                            vector bool int);
16159 vector signed int vec_sel (vector signed int,
16160                            vector signed int,
16161                            vector unsigned int);
16162 vector unsigned int vec_sel (vector unsigned int,
16163                              vector unsigned int,
16164                              vector bool int);
16165 vector unsigned int vec_sel (vector unsigned int,
16166                              vector unsigned int,
16167                              vector unsigned int);
16168 vector bool int vec_sel (vector bool int,
16169                          vector bool int,
16170                          vector bool int);
16171 vector bool int vec_sel (vector bool int,
16172                          vector bool int,
16173                          vector unsigned int);
16174 vector signed short vec_sel (vector signed short,
16175                              vector signed short,
16176                              vector bool short);
16177 vector signed short vec_sel (vector signed short,
16178                              vector signed short,
16179                              vector unsigned short);
16180 vector unsigned short vec_sel (vector unsigned short,
16181                                vector unsigned short,
16182                                vector bool short);
16183 vector unsigned short vec_sel (vector unsigned short,
16184                                vector unsigned short,
16185                                vector unsigned short);
16186 vector bool short vec_sel (vector bool short,
16187                            vector bool short,
16188                            vector bool short);
16189 vector bool short vec_sel (vector bool short,
16190                            vector bool short,
16191                            vector unsigned short);
16192 vector signed char vec_sel (vector signed char,
16193                             vector signed char,
16194                             vector bool char);
16195 vector signed char vec_sel (vector signed char,
16196                             vector signed char,
16197                             vector unsigned char);
16198 vector unsigned char vec_sel (vector unsigned char,
16199                               vector unsigned char,
16200                               vector bool char);
16201 vector unsigned char vec_sel (vector unsigned char,
16202                               vector unsigned char,
16203                               vector unsigned char);
16204 vector bool char vec_sel (vector bool char,
16205                           vector bool char,
16206                           vector bool char);
16207 vector bool char vec_sel (vector bool char,
16208                           vector bool char,
16209                           vector unsigned char);
16211 vector signed char vec_sl (vector signed char,
16212                            vector unsigned char);
16213 vector unsigned char vec_sl (vector unsigned char,
16214                              vector unsigned char);
16215 vector signed short vec_sl (vector signed short, vector unsigned short);
16216 vector unsigned short vec_sl (vector unsigned short,
16217                               vector unsigned short);
16218 vector signed int vec_sl (vector signed int, vector unsigned int);
16219 vector unsigned int vec_sl (vector unsigned int, vector unsigned int);
16221 vector signed int vec_vslw (vector signed int, vector unsigned int);
16222 vector unsigned int vec_vslw (vector unsigned int, vector unsigned int);
16224 vector signed short vec_vslh (vector signed short,
16225                               vector unsigned short);
16226 vector unsigned short vec_vslh (vector unsigned short,
16227                                 vector unsigned short);
16229 vector signed char vec_vslb (vector signed char, vector unsigned char);
16230 vector unsigned char vec_vslb (vector unsigned char,
16231                                vector unsigned char);
16233 vector float vec_sld (vector float, vector float, const int);
16234 vector signed int vec_sld (vector signed int,
16235                            vector signed int,
16236                            const int);
16237 vector unsigned int vec_sld (vector unsigned int,
16238                              vector unsigned int,
16239                              const int);
16240 vector bool int vec_sld (vector bool int,
16241                          vector bool int,
16242                          const int);
16243 vector signed short vec_sld (vector signed short,
16244                              vector signed short,
16245                              const int);
16246 vector unsigned short vec_sld (vector unsigned short,
16247                                vector unsigned short,
16248                                const int);
16249 vector bool short vec_sld (vector bool short,
16250                            vector bool short,
16251                            const int);
16252 vector pixel vec_sld (vector pixel,
16253                       vector pixel,
16254                       const int);
16255 vector signed char vec_sld (vector signed char,
16256                             vector signed char,
16257                             const int);
16258 vector unsigned char vec_sld (vector unsigned char,
16259                               vector unsigned char,
16260                               const int);
16261 vector bool char vec_sld (vector bool char,
16262                           vector bool char,
16263                           const int);
16265 vector signed int vec_sll (vector signed int,
16266                            vector unsigned int);
16267 vector signed int vec_sll (vector signed int,
16268                            vector unsigned short);
16269 vector signed int vec_sll (vector signed int,
16270                            vector unsigned char);
16271 vector unsigned int vec_sll (vector unsigned int,
16272                              vector unsigned int);
16273 vector unsigned int vec_sll (vector unsigned int,
16274                              vector unsigned short);
16275 vector unsigned int vec_sll (vector unsigned int,
16276                              vector unsigned char);
16277 vector bool int vec_sll (vector bool int,
16278                          vector unsigned int);
16279 vector bool int vec_sll (vector bool int,
16280                          vector unsigned short);
16281 vector bool int vec_sll (vector bool int,
16282                          vector unsigned char);
16283 vector signed short vec_sll (vector signed short,
16284                              vector unsigned int);
16285 vector signed short vec_sll (vector signed short,
16286                              vector unsigned short);
16287 vector signed short vec_sll (vector signed short,
16288                              vector unsigned char);
16289 vector unsigned short vec_sll (vector unsigned short,
16290                                vector unsigned int);
16291 vector unsigned short vec_sll (vector unsigned short,
16292                                vector unsigned short);
16293 vector unsigned short vec_sll (vector unsigned short,
16294                                vector unsigned char);
16295 vector bool short vec_sll (vector bool short, vector unsigned int);
16296 vector bool short vec_sll (vector bool short, vector unsigned short);
16297 vector bool short vec_sll (vector bool short, vector unsigned char);
16298 vector pixel vec_sll (vector pixel, vector unsigned int);
16299 vector pixel vec_sll (vector pixel, vector unsigned short);
16300 vector pixel vec_sll (vector pixel, vector unsigned char);
16301 vector signed char vec_sll (vector signed char, vector unsigned int);
16302 vector signed char vec_sll (vector signed char, vector unsigned short);
16303 vector signed char vec_sll (vector signed char, vector unsigned char);
16304 vector unsigned char vec_sll (vector unsigned char,
16305                               vector unsigned int);
16306 vector unsigned char vec_sll (vector unsigned char,
16307                               vector unsigned short);
16308 vector unsigned char vec_sll (vector unsigned char,
16309                               vector unsigned char);
16310 vector bool char vec_sll (vector bool char, vector unsigned int);
16311 vector bool char vec_sll (vector bool char, vector unsigned short);
16312 vector bool char vec_sll (vector bool char, vector unsigned char);
16314 vector float vec_slo (vector float, vector signed char);
16315 vector float vec_slo (vector float, vector unsigned char);
16316 vector signed int vec_slo (vector signed int, vector signed char);
16317 vector signed int vec_slo (vector signed int, vector unsigned char);
16318 vector unsigned int vec_slo (vector unsigned int, vector signed char);
16319 vector unsigned int vec_slo (vector unsigned int, vector unsigned char);
16320 vector signed short vec_slo (vector signed short, vector signed char);
16321 vector signed short vec_slo (vector signed short, vector unsigned char);
16322 vector unsigned short vec_slo (vector unsigned short,
16323                                vector signed char);
16324 vector unsigned short vec_slo (vector unsigned short,
16325                                vector unsigned char);
16326 vector pixel vec_slo (vector pixel, vector signed char);
16327 vector pixel vec_slo (vector pixel, vector unsigned char);
16328 vector signed char vec_slo (vector signed char, vector signed char);
16329 vector signed char vec_slo (vector signed char, vector unsigned char);
16330 vector unsigned char vec_slo (vector unsigned char, vector signed char);
16331 vector unsigned char vec_slo (vector unsigned char,
16332                               vector unsigned char);
16334 vector signed char vec_splat (vector signed char, const int);
16335 vector unsigned char vec_splat (vector unsigned char, const int);
16336 vector bool char vec_splat (vector bool char, const int);
16337 vector signed short vec_splat (vector signed short, const int);
16338 vector unsigned short vec_splat (vector unsigned short, const int);
16339 vector bool short vec_splat (vector bool short, const int);
16340 vector pixel vec_splat (vector pixel, const int);
16341 vector float vec_splat (vector float, const int);
16342 vector signed int vec_splat (vector signed int, const int);
16343 vector unsigned int vec_splat (vector unsigned int, const int);
16344 vector bool int vec_splat (vector bool int, const int);
16345 vector signed long vec_splat (vector signed long, const int);
16346 vector unsigned long vec_splat (vector unsigned long, const int);
16348 vector signed char vec_splats (signed char);
16349 vector unsigned char vec_splats (unsigned char);
16350 vector signed short vec_splats (signed short);
16351 vector unsigned short vec_splats (unsigned short);
16352 vector signed int vec_splats (signed int);
16353 vector unsigned int vec_splats (unsigned int);
16354 vector float vec_splats (float);
16356 vector float vec_vspltw (vector float, const int);
16357 vector signed int vec_vspltw (vector signed int, const int);
16358 vector unsigned int vec_vspltw (vector unsigned int, const int);
16359 vector bool int vec_vspltw (vector bool int, const int);
16361 vector bool short vec_vsplth (vector bool short, const int);
16362 vector signed short vec_vsplth (vector signed short, const int);
16363 vector unsigned short vec_vsplth (vector unsigned short, const int);
16364 vector pixel vec_vsplth (vector pixel, const int);
16366 vector signed char vec_vspltb (vector signed char, const int);
16367 vector unsigned char vec_vspltb (vector unsigned char, const int);
16368 vector bool char vec_vspltb (vector bool char, const int);
16370 vector signed char vec_splat_s8 (const int);
16372 vector signed short vec_splat_s16 (const int);
16374 vector signed int vec_splat_s32 (const int);
16376 vector unsigned char vec_splat_u8 (const int);
16378 vector unsigned short vec_splat_u16 (const int);
16380 vector unsigned int vec_splat_u32 (const int);
16382 vector signed char vec_sr (vector signed char, vector unsigned char);
16383 vector unsigned char vec_sr (vector unsigned char,
16384                              vector unsigned char);
16385 vector signed short vec_sr (vector signed short,
16386                             vector unsigned short);
16387 vector unsigned short vec_sr (vector unsigned short,
16388                               vector unsigned short);
16389 vector signed int vec_sr (vector signed int, vector unsigned int);
16390 vector unsigned int vec_sr (vector unsigned int, vector unsigned int);
16392 vector signed int vec_vsrw (vector signed int, vector unsigned int);
16393 vector unsigned int vec_vsrw (vector unsigned int, vector unsigned int);
16395 vector signed short vec_vsrh (vector signed short,
16396                               vector unsigned short);
16397 vector unsigned short vec_vsrh (vector unsigned short,
16398                                 vector unsigned short);
16400 vector signed char vec_vsrb (vector signed char, vector unsigned char);
16401 vector unsigned char vec_vsrb (vector unsigned char,
16402                                vector unsigned char);
16404 vector signed char vec_sra (vector signed char, vector unsigned char);
16405 vector unsigned char vec_sra (vector unsigned char,
16406                               vector unsigned char);
16407 vector signed short vec_sra (vector signed short,
16408                              vector unsigned short);
16409 vector unsigned short vec_sra (vector unsigned short,
16410                                vector unsigned short);
16411 vector signed int vec_sra (vector signed int, vector unsigned int);
16412 vector unsigned int vec_sra (vector unsigned int, vector unsigned int);
16414 vector signed int vec_vsraw (vector signed int, vector unsigned int);
16415 vector unsigned int vec_vsraw (vector unsigned int,
16416                                vector unsigned int);
16418 vector signed short vec_vsrah (vector signed short,
16419                                vector unsigned short);
16420 vector unsigned short vec_vsrah (vector unsigned short,
16421                                  vector unsigned short);
16423 vector signed char vec_vsrab (vector signed char, vector unsigned char);
16424 vector unsigned char vec_vsrab (vector unsigned char,
16425                                 vector unsigned char);
16427 vector signed int vec_srl (vector signed int, vector unsigned int);
16428 vector signed int vec_srl (vector signed int, vector unsigned short);
16429 vector signed int vec_srl (vector signed int, vector unsigned char);
16430 vector unsigned int vec_srl (vector unsigned int, vector unsigned int);
16431 vector unsigned int vec_srl (vector unsigned int,
16432                              vector unsigned short);
16433 vector unsigned int vec_srl (vector unsigned int, vector unsigned char);
16434 vector bool int vec_srl (vector bool int, vector unsigned int);
16435 vector bool int vec_srl (vector bool int, vector unsigned short);
16436 vector bool int vec_srl (vector bool int, vector unsigned char);
16437 vector signed short vec_srl (vector signed short, vector unsigned int);
16438 vector signed short vec_srl (vector signed short,
16439                              vector unsigned short);
16440 vector signed short vec_srl (vector signed short, vector unsigned char);
16441 vector unsigned short vec_srl (vector unsigned short,
16442                                vector unsigned int);
16443 vector unsigned short vec_srl (vector unsigned short,
16444                                vector unsigned short);
16445 vector unsigned short vec_srl (vector unsigned short,
16446                                vector unsigned char);
16447 vector bool short vec_srl (vector bool short, vector unsigned int);
16448 vector bool short vec_srl (vector bool short, vector unsigned short);
16449 vector bool short vec_srl (vector bool short, vector unsigned char);
16450 vector pixel vec_srl (vector pixel, vector unsigned int);
16451 vector pixel vec_srl (vector pixel, vector unsigned short);
16452 vector pixel vec_srl (vector pixel, vector unsigned char);
16453 vector signed char vec_srl (vector signed char, vector unsigned int);
16454 vector signed char vec_srl (vector signed char, vector unsigned short);
16455 vector signed char vec_srl (vector signed char, vector unsigned char);
16456 vector unsigned char vec_srl (vector unsigned char,
16457                               vector unsigned int);
16458 vector unsigned char vec_srl (vector unsigned char,
16459                               vector unsigned short);
16460 vector unsigned char vec_srl (vector unsigned char,
16461                               vector unsigned char);
16462 vector bool char vec_srl (vector bool char, vector unsigned int);
16463 vector bool char vec_srl (vector bool char, vector unsigned short);
16464 vector bool char vec_srl (vector bool char, vector unsigned char);
16466 vector float vec_sro (vector float, vector signed char);
16467 vector float vec_sro (vector float, vector unsigned char);
16468 vector signed int vec_sro (vector signed int, vector signed char);
16469 vector signed int vec_sro (vector signed int, vector unsigned char);
16470 vector unsigned int vec_sro (vector unsigned int, vector signed char);
16471 vector unsigned int vec_sro (vector unsigned int, vector unsigned char);
16472 vector signed short vec_sro (vector signed short, vector signed char);
16473 vector signed short vec_sro (vector signed short, vector unsigned char);
16474 vector unsigned short vec_sro (vector unsigned short,
16475                                vector signed char);
16476 vector unsigned short vec_sro (vector unsigned short,
16477                                vector unsigned char);
16478 vector pixel vec_sro (vector pixel, vector signed char);
16479 vector pixel vec_sro (vector pixel, vector unsigned char);
16480 vector signed char vec_sro (vector signed char, vector signed char);
16481 vector signed char vec_sro (vector signed char, vector unsigned char);
16482 vector unsigned char vec_sro (vector unsigned char, vector signed char);
16483 vector unsigned char vec_sro (vector unsigned char,
16484                               vector unsigned char);
16486 void vec_st (vector float, int, vector float *);
16487 void vec_st (vector float, int, float *);
16488 void vec_st (vector signed int, int, vector signed int *);
16489 void vec_st (vector signed int, int, int *);
16490 void vec_st (vector unsigned int, int, vector unsigned int *);
16491 void vec_st (vector unsigned int, int, unsigned int *);
16492 void vec_st (vector bool int, int, vector bool int *);
16493 void vec_st (vector bool int, int, unsigned int *);
16494 void vec_st (vector bool int, int, int *);
16495 void vec_st (vector signed short, int, vector signed short *);
16496 void vec_st (vector signed short, int, short *);
16497 void vec_st (vector unsigned short, int, vector unsigned short *);
16498 void vec_st (vector unsigned short, int, unsigned short *);
16499 void vec_st (vector bool short, int, vector bool short *);
16500 void vec_st (vector bool short, int, unsigned short *);
16501 void vec_st (vector pixel, int, vector pixel *);
16502 void vec_st (vector pixel, int, unsigned short *);
16503 void vec_st (vector pixel, int, short *);
16504 void vec_st (vector bool short, int, short *);
16505 void vec_st (vector signed char, int, vector signed char *);
16506 void vec_st (vector signed char, int, signed char *);
16507 void vec_st (vector unsigned char, int, vector unsigned char *);
16508 void vec_st (vector unsigned char, int, unsigned char *);
16509 void vec_st (vector bool char, int, vector bool char *);
16510 void vec_st (vector bool char, int, unsigned char *);
16511 void vec_st (vector bool char, int, signed char *);
16513 void vec_ste (vector signed char, int, signed char *);
16514 void vec_ste (vector unsigned char, int, unsigned char *);
16515 void vec_ste (vector bool char, int, signed char *);
16516 void vec_ste (vector bool char, int, unsigned char *);
16517 void vec_ste (vector signed short, int, short *);
16518 void vec_ste (vector unsigned short, int, unsigned short *);
16519 void vec_ste (vector bool short, int, short *);
16520 void vec_ste (vector bool short, int, unsigned short *);
16521 void vec_ste (vector pixel, int, short *);
16522 void vec_ste (vector pixel, int, unsigned short *);
16523 void vec_ste (vector float, int, float *);
16524 void vec_ste (vector signed int, int, int *);
16525 void vec_ste (vector unsigned int, int, unsigned int *);
16526 void vec_ste (vector bool int, int, int *);
16527 void vec_ste (vector bool int, int, unsigned int *);
16529 void vec_stvewx (vector float, int, float *);
16530 void vec_stvewx (vector signed int, int, int *);
16531 void vec_stvewx (vector unsigned int, int, unsigned int *);
16532 void vec_stvewx (vector bool int, int, int *);
16533 void vec_stvewx (vector bool int, int, unsigned int *);
16535 void vec_stvehx (vector signed short, int, short *);
16536 void vec_stvehx (vector unsigned short, int, unsigned short *);
16537 void vec_stvehx (vector bool short, int, short *);
16538 void vec_stvehx (vector bool short, int, unsigned short *);
16539 void vec_stvehx (vector pixel, int, short *);
16540 void vec_stvehx (vector pixel, int, unsigned short *);
16542 void vec_stvebx (vector signed char, int, signed char *);
16543 void vec_stvebx (vector unsigned char, int, unsigned char *);
16544 void vec_stvebx (vector bool char, int, signed char *);
16545 void vec_stvebx (vector bool char, int, unsigned char *);
16547 void vec_stl (vector float, int, vector float *);
16548 void vec_stl (vector float, int, float *);
16549 void vec_stl (vector signed int, int, vector signed int *);
16550 void vec_stl (vector signed int, int, int *);
16551 void vec_stl (vector unsigned int, int, vector unsigned int *);
16552 void vec_stl (vector unsigned int, int, unsigned int *);
16553 void vec_stl (vector bool int, int, vector bool int *);
16554 void vec_stl (vector bool int, int, unsigned int *);
16555 void vec_stl (vector bool int, int, int *);
16556 void vec_stl (vector signed short, int, vector signed short *);
16557 void vec_stl (vector signed short, int, short *);
16558 void vec_stl (vector unsigned short, int, vector unsigned short *);
16559 void vec_stl (vector unsigned short, int, unsigned short *);
16560 void vec_stl (vector bool short, int, vector bool short *);
16561 void vec_stl (vector bool short, int, unsigned short *);
16562 void vec_stl (vector bool short, int, short *);
16563 void vec_stl (vector pixel, int, vector pixel *);
16564 void vec_stl (vector pixel, int, unsigned short *);
16565 void vec_stl (vector pixel, int, short *);
16566 void vec_stl (vector signed char, int, vector signed char *);
16567 void vec_stl (vector signed char, int, signed char *);
16568 void vec_stl (vector unsigned char, int, vector unsigned char *);
16569 void vec_stl (vector unsigned char, int, unsigned char *);
16570 void vec_stl (vector bool char, int, vector bool char *);
16571 void vec_stl (vector bool char, int, unsigned char *);
16572 void vec_stl (vector bool char, int, signed char *);
16574 vector signed char vec_sub (vector bool char, vector signed char);
16575 vector signed char vec_sub (vector signed char, vector bool char);
16576 vector signed char vec_sub (vector signed char, vector signed char);
16577 vector unsigned char vec_sub (vector bool char, vector unsigned char);
16578 vector unsigned char vec_sub (vector unsigned char, vector bool char);
16579 vector unsigned char vec_sub (vector unsigned char,
16580                               vector unsigned char);
16581 vector signed short vec_sub (vector bool short, vector signed short);
16582 vector signed short vec_sub (vector signed short, vector bool short);
16583 vector signed short vec_sub (vector signed short, vector signed short);
16584 vector unsigned short vec_sub (vector bool short,
16585                                vector unsigned short);
16586 vector unsigned short vec_sub (vector unsigned short,
16587                                vector bool short);
16588 vector unsigned short vec_sub (vector unsigned short,
16589                                vector unsigned short);
16590 vector signed int vec_sub (vector bool int, vector signed int);
16591 vector signed int vec_sub (vector signed int, vector bool int);
16592 vector signed int vec_sub (vector signed int, vector signed int);
16593 vector unsigned int vec_sub (vector bool int, vector unsigned int);
16594 vector unsigned int vec_sub (vector unsigned int, vector bool int);
16595 vector unsigned int vec_sub (vector unsigned int, vector unsigned int);
16596 vector float vec_sub (vector float, vector float);
16598 vector float vec_vsubfp (vector float, vector float);
16600 vector signed int vec_vsubuwm (vector bool int, vector signed int);
16601 vector signed int vec_vsubuwm (vector signed int, vector bool int);
16602 vector signed int vec_vsubuwm (vector signed int, vector signed int);
16603 vector unsigned int vec_vsubuwm (vector bool int, vector unsigned int);
16604 vector unsigned int vec_vsubuwm (vector unsigned int, vector bool int);
16605 vector unsigned int vec_vsubuwm (vector unsigned int,
16606                                  vector unsigned int);
16608 vector signed short vec_vsubuhm (vector bool short,
16609                                  vector signed short);
16610 vector signed short vec_vsubuhm (vector signed short,
16611                                  vector bool short);
16612 vector signed short vec_vsubuhm (vector signed short,
16613                                  vector signed short);
16614 vector unsigned short vec_vsubuhm (vector bool short,
16615                                    vector unsigned short);
16616 vector unsigned short vec_vsubuhm (vector unsigned short,
16617                                    vector bool short);
16618 vector unsigned short vec_vsubuhm (vector unsigned short,
16619                                    vector unsigned short);
16621 vector signed char vec_vsububm (vector bool char, vector signed char);
16622 vector signed char vec_vsububm (vector signed char, vector bool char);
16623 vector signed char vec_vsububm (vector signed char, vector signed char);
16624 vector unsigned char vec_vsububm (vector bool char,
16625                                   vector unsigned char);
16626 vector unsigned char vec_vsububm (vector unsigned char,
16627                                   vector bool char);
16628 vector unsigned char vec_vsububm (vector unsigned char,
16629                                   vector unsigned char);
16631 vector unsigned int vec_subc (vector unsigned int, vector unsigned int);
16633 vector unsigned char vec_subs (vector bool char, vector unsigned char);
16634 vector unsigned char vec_subs (vector unsigned char, vector bool char);
16635 vector unsigned char vec_subs (vector unsigned char,
16636                                vector unsigned char);
16637 vector signed char vec_subs (vector bool char, vector signed char);
16638 vector signed char vec_subs (vector signed char, vector bool char);
16639 vector signed char vec_subs (vector signed char, vector signed char);
16640 vector unsigned short vec_subs (vector bool short,
16641                                 vector unsigned short);
16642 vector unsigned short vec_subs (vector unsigned short,
16643                                 vector bool short);
16644 vector unsigned short vec_subs (vector unsigned short,
16645                                 vector unsigned short);
16646 vector signed short vec_subs (vector bool short, vector signed short);
16647 vector signed short vec_subs (vector signed short, vector bool short);
16648 vector signed short vec_subs (vector signed short, vector signed short);
16649 vector unsigned int vec_subs (vector bool int, vector unsigned int);
16650 vector unsigned int vec_subs (vector unsigned int, vector bool int);
16651 vector unsigned int vec_subs (vector unsigned int, vector unsigned int);
16652 vector signed int vec_subs (vector bool int, vector signed int);
16653 vector signed int vec_subs (vector signed int, vector bool int);
16654 vector signed int vec_subs (vector signed int, vector signed int);
16656 vector signed int vec_vsubsws (vector bool int, vector signed int);
16657 vector signed int vec_vsubsws (vector signed int, vector bool int);
16658 vector signed int vec_vsubsws (vector signed int, vector signed int);
16660 vector unsigned int vec_vsubuws (vector bool int, vector unsigned int);
16661 vector unsigned int vec_vsubuws (vector unsigned int, vector bool int);
16662 vector unsigned int vec_vsubuws (vector unsigned int,
16663                                  vector unsigned int);
16665 vector signed short vec_vsubshs (vector bool short,
16666                                  vector signed short);
16667 vector signed short vec_vsubshs (vector signed short,
16668                                  vector bool short);
16669 vector signed short vec_vsubshs (vector signed short,
16670                                  vector signed short);
16672 vector unsigned short vec_vsubuhs (vector bool short,
16673                                    vector unsigned short);
16674 vector unsigned short vec_vsubuhs (vector unsigned short,
16675                                    vector bool short);
16676 vector unsigned short vec_vsubuhs (vector unsigned short,
16677                                    vector unsigned short);
16679 vector signed char vec_vsubsbs (vector bool char, vector signed char);
16680 vector signed char vec_vsubsbs (vector signed char, vector bool char);
16681 vector signed char vec_vsubsbs (vector signed char, vector signed char);
16683 vector unsigned char vec_vsububs (vector bool char,
16684                                   vector unsigned char);
16685 vector unsigned char vec_vsububs (vector unsigned char,
16686                                   vector bool char);
16687 vector unsigned char vec_vsububs (vector unsigned char,
16688                                   vector unsigned char);
16690 vector unsigned int vec_sum4s (vector unsigned char,
16691                                vector unsigned int);
16692 vector signed int vec_sum4s (vector signed char, vector signed int);
16693 vector signed int vec_sum4s (vector signed short, vector signed int);
16695 vector signed int vec_vsum4shs (vector signed short, vector signed int);
16697 vector signed int vec_vsum4sbs (vector signed char, vector signed int);
16699 vector unsigned int vec_vsum4ubs (vector unsigned char,
16700                                   vector unsigned int);
16702 vector signed int vec_sum2s (vector signed int, vector signed int);
16704 vector signed int vec_sums (vector signed int, vector signed int);
16706 vector float vec_trunc (vector float);
16708 vector signed short vec_unpackh (vector signed char);
16709 vector bool short vec_unpackh (vector bool char);
16710 vector signed int vec_unpackh (vector signed short);
16711 vector bool int vec_unpackh (vector bool short);
16712 vector unsigned int vec_unpackh (vector pixel);
16714 vector bool int vec_vupkhsh (vector bool short);
16715 vector signed int vec_vupkhsh (vector signed short);
16717 vector unsigned int vec_vupkhpx (vector pixel);
16719 vector bool short vec_vupkhsb (vector bool char);
16720 vector signed short vec_vupkhsb (vector signed char);
16722 vector signed short vec_unpackl (vector signed char);
16723 vector bool short vec_unpackl (vector bool char);
16724 vector unsigned int vec_unpackl (vector pixel);
16725 vector signed int vec_unpackl (vector signed short);
16726 vector bool int vec_unpackl (vector bool short);
16728 vector unsigned int vec_vupklpx (vector pixel);
16730 vector bool int vec_vupklsh (vector bool short);
16731 vector signed int vec_vupklsh (vector signed short);
16733 vector bool short vec_vupklsb (vector bool char);
16734 vector signed short vec_vupklsb (vector signed char);
16736 vector float vec_xor (vector float, vector float);
16737 vector float vec_xor (vector float, vector bool int);
16738 vector float vec_xor (vector bool int, vector float);
16739 vector bool int vec_xor (vector bool int, vector bool int);
16740 vector signed int vec_xor (vector bool int, vector signed int);
16741 vector signed int vec_xor (vector signed int, vector bool int);
16742 vector signed int vec_xor (vector signed int, vector signed int);
16743 vector unsigned int vec_xor (vector bool int, vector unsigned int);
16744 vector unsigned int vec_xor (vector unsigned int, vector bool int);
16745 vector unsigned int vec_xor (vector unsigned int, vector unsigned int);
16746 vector bool short vec_xor (vector bool short, vector bool short);
16747 vector signed short vec_xor (vector bool short, vector signed short);
16748 vector signed short vec_xor (vector signed short, vector bool short);
16749 vector signed short vec_xor (vector signed short, vector signed short);
16750 vector unsigned short vec_xor (vector bool short,
16751                                vector unsigned short);
16752 vector unsigned short vec_xor (vector unsigned short,
16753                                vector bool short);
16754 vector unsigned short vec_xor (vector unsigned short,
16755                                vector unsigned short);
16756 vector signed char vec_xor (vector bool char, vector signed char);
16757 vector bool char vec_xor (vector bool char, vector bool char);
16758 vector signed char vec_xor (vector signed char, vector bool char);
16759 vector signed char vec_xor (vector signed char, vector signed char);
16760 vector unsigned char vec_xor (vector bool char, vector unsigned char);
16761 vector unsigned char vec_xor (vector unsigned char, vector bool char);
16762 vector unsigned char vec_xor (vector unsigned char,
16763                               vector unsigned char);
16765 int vec_all_eq (vector signed char, vector bool char);
16766 int vec_all_eq (vector signed char, vector signed char);
16767 int vec_all_eq (vector unsigned char, vector bool char);
16768 int vec_all_eq (vector unsigned char, vector unsigned char);
16769 int vec_all_eq (vector bool char, vector bool char);
16770 int vec_all_eq (vector bool char, vector unsigned char);
16771 int vec_all_eq (vector bool char, vector signed char);
16772 int vec_all_eq (vector signed short, vector bool short);
16773 int vec_all_eq (vector signed short, vector signed short);
16774 int vec_all_eq (vector unsigned short, vector bool short);
16775 int vec_all_eq (vector unsigned short, vector unsigned short);
16776 int vec_all_eq (vector bool short, vector bool short);
16777 int vec_all_eq (vector bool short, vector unsigned short);
16778 int vec_all_eq (vector bool short, vector signed short);
16779 int vec_all_eq (vector pixel, vector pixel);
16780 int vec_all_eq (vector signed int, vector bool int);
16781 int vec_all_eq (vector signed int, vector signed int);
16782 int vec_all_eq (vector unsigned int, vector bool int);
16783 int vec_all_eq (vector unsigned int, vector unsigned int);
16784 int vec_all_eq (vector bool int, vector bool int);
16785 int vec_all_eq (vector bool int, vector unsigned int);
16786 int vec_all_eq (vector bool int, vector signed int);
16787 int vec_all_eq (vector float, vector float);
16789 int vec_all_ge (vector bool char, vector unsigned char);
16790 int vec_all_ge (vector unsigned char, vector bool char);
16791 int vec_all_ge (vector unsigned char, vector unsigned char);
16792 int vec_all_ge (vector bool char, vector signed char);
16793 int vec_all_ge (vector signed char, vector bool char);
16794 int vec_all_ge (vector signed char, vector signed char);
16795 int vec_all_ge (vector bool short, vector unsigned short);
16796 int vec_all_ge (vector unsigned short, vector bool short);
16797 int vec_all_ge (vector unsigned short, vector unsigned short);
16798 int vec_all_ge (vector signed short, vector signed short);
16799 int vec_all_ge (vector bool short, vector signed short);
16800 int vec_all_ge (vector signed short, vector bool short);
16801 int vec_all_ge (vector bool int, vector unsigned int);
16802 int vec_all_ge (vector unsigned int, vector bool int);
16803 int vec_all_ge (vector unsigned int, vector unsigned int);
16804 int vec_all_ge (vector bool int, vector signed int);
16805 int vec_all_ge (vector signed int, vector bool int);
16806 int vec_all_ge (vector signed int, vector signed int);
16807 int vec_all_ge (vector float, vector float);
16809 int vec_all_gt (vector bool char, vector unsigned char);
16810 int vec_all_gt (vector unsigned char, vector bool char);
16811 int vec_all_gt (vector unsigned char, vector unsigned char);
16812 int vec_all_gt (vector bool char, vector signed char);
16813 int vec_all_gt (vector signed char, vector bool char);
16814 int vec_all_gt (vector signed char, vector signed char);
16815 int vec_all_gt (vector bool short, vector unsigned short);
16816 int vec_all_gt (vector unsigned short, vector bool short);
16817 int vec_all_gt (vector unsigned short, vector unsigned short);
16818 int vec_all_gt (vector bool short, vector signed short);
16819 int vec_all_gt (vector signed short, vector bool short);
16820 int vec_all_gt (vector signed short, vector signed short);
16821 int vec_all_gt (vector bool int, vector unsigned int);
16822 int vec_all_gt (vector unsigned int, vector bool int);
16823 int vec_all_gt (vector unsigned int, vector unsigned int);
16824 int vec_all_gt (vector bool int, vector signed int);
16825 int vec_all_gt (vector signed int, vector bool int);
16826 int vec_all_gt (vector signed int, vector signed int);
16827 int vec_all_gt (vector float, vector float);
16829 int vec_all_in (vector float, vector float);
16831 int vec_all_le (vector bool char, vector unsigned char);
16832 int vec_all_le (vector unsigned char, vector bool char);
16833 int vec_all_le (vector unsigned char, vector unsigned char);
16834 int vec_all_le (vector bool char, vector signed char);
16835 int vec_all_le (vector signed char, vector bool char);
16836 int vec_all_le (vector signed char, vector signed char);
16837 int vec_all_le (vector bool short, vector unsigned short);
16838 int vec_all_le (vector unsigned short, vector bool short);
16839 int vec_all_le (vector unsigned short, vector unsigned short);
16840 int vec_all_le (vector bool short, vector signed short);
16841 int vec_all_le (vector signed short, vector bool short);
16842 int vec_all_le (vector signed short, vector signed short);
16843 int vec_all_le (vector bool int, vector unsigned int);
16844 int vec_all_le (vector unsigned int, vector bool int);
16845 int vec_all_le (vector unsigned int, vector unsigned int);
16846 int vec_all_le (vector bool int, vector signed int);
16847 int vec_all_le (vector signed int, vector bool int);
16848 int vec_all_le (vector signed int, vector signed int);
16849 int vec_all_le (vector float, vector float);
16851 int vec_all_lt (vector bool char, vector unsigned char);
16852 int vec_all_lt (vector unsigned char, vector bool char);
16853 int vec_all_lt (vector unsigned char, vector unsigned char);
16854 int vec_all_lt (vector bool char, vector signed char);
16855 int vec_all_lt (vector signed char, vector bool char);
16856 int vec_all_lt (vector signed char, vector signed char);
16857 int vec_all_lt (vector bool short, vector unsigned short);
16858 int vec_all_lt (vector unsigned short, vector bool short);
16859 int vec_all_lt (vector unsigned short, vector unsigned short);
16860 int vec_all_lt (vector bool short, vector signed short);
16861 int vec_all_lt (vector signed short, vector bool short);
16862 int vec_all_lt (vector signed short, vector signed short);
16863 int vec_all_lt (vector bool int, vector unsigned int);
16864 int vec_all_lt (vector unsigned int, vector bool int);
16865 int vec_all_lt (vector unsigned int, vector unsigned int);
16866 int vec_all_lt (vector bool int, vector signed int);
16867 int vec_all_lt (vector signed int, vector bool int);
16868 int vec_all_lt (vector signed int, vector signed int);
16869 int vec_all_lt (vector float, vector float);
16871 int vec_all_nan (vector float);
16873 int vec_all_ne (vector signed char, vector bool char);
16874 int vec_all_ne (vector signed char, vector signed char);
16875 int vec_all_ne (vector unsigned char, vector bool char);
16876 int vec_all_ne (vector unsigned char, vector unsigned char);
16877 int vec_all_ne (vector bool char, vector bool char);
16878 int vec_all_ne (vector bool char, vector unsigned char);
16879 int vec_all_ne (vector bool char, vector signed char);
16880 int vec_all_ne (vector signed short, vector bool short);
16881 int vec_all_ne (vector signed short, vector signed short);
16882 int vec_all_ne (vector unsigned short, vector bool short);
16883 int vec_all_ne (vector unsigned short, vector unsigned short);
16884 int vec_all_ne (vector bool short, vector bool short);
16885 int vec_all_ne (vector bool short, vector unsigned short);
16886 int vec_all_ne (vector bool short, vector signed short);
16887 int vec_all_ne (vector pixel, vector pixel);
16888 int vec_all_ne (vector signed int, vector bool int);
16889 int vec_all_ne (vector signed int, vector signed int);
16890 int vec_all_ne (vector unsigned int, vector bool int);
16891 int vec_all_ne (vector unsigned int, vector unsigned int);
16892 int vec_all_ne (vector bool int, vector bool int);
16893 int vec_all_ne (vector bool int, vector unsigned int);
16894 int vec_all_ne (vector bool int, vector signed int);
16895 int vec_all_ne (vector float, vector float);
16897 int vec_all_nge (vector float, vector float);
16899 int vec_all_ngt (vector float, vector float);
16901 int vec_all_nle (vector float, vector float);
16903 int vec_all_nlt (vector float, vector float);
16905 int vec_all_numeric (vector float);
16907 int vec_any_eq (vector signed char, vector bool char);
16908 int vec_any_eq (vector signed char, vector signed char);
16909 int vec_any_eq (vector unsigned char, vector bool char);
16910 int vec_any_eq (vector unsigned char, vector unsigned char);
16911 int vec_any_eq (vector bool char, vector bool char);
16912 int vec_any_eq (vector bool char, vector unsigned char);
16913 int vec_any_eq (vector bool char, vector signed char);
16914 int vec_any_eq (vector signed short, vector bool short);
16915 int vec_any_eq (vector signed short, vector signed short);
16916 int vec_any_eq (vector unsigned short, vector bool short);
16917 int vec_any_eq (vector unsigned short, vector unsigned short);
16918 int vec_any_eq (vector bool short, vector bool short);
16919 int vec_any_eq (vector bool short, vector unsigned short);
16920 int vec_any_eq (vector bool short, vector signed short);
16921 int vec_any_eq (vector pixel, vector pixel);
16922 int vec_any_eq (vector signed int, vector bool int);
16923 int vec_any_eq (vector signed int, vector signed int);
16924 int vec_any_eq (vector unsigned int, vector bool int);
16925 int vec_any_eq (vector unsigned int, vector unsigned int);
16926 int vec_any_eq (vector bool int, vector bool int);
16927 int vec_any_eq (vector bool int, vector unsigned int);
16928 int vec_any_eq (vector bool int, vector signed int);
16929 int vec_any_eq (vector float, vector float);
16931 int vec_any_ge (vector signed char, vector bool char);
16932 int vec_any_ge (vector unsigned char, vector bool char);
16933 int vec_any_ge (vector unsigned char, vector unsigned char);
16934 int vec_any_ge (vector signed char, vector signed char);
16935 int vec_any_ge (vector bool char, vector unsigned char);
16936 int vec_any_ge (vector bool char, vector signed char);
16937 int vec_any_ge (vector unsigned short, vector bool short);
16938 int vec_any_ge (vector unsigned short, vector unsigned short);
16939 int vec_any_ge (vector signed short, vector signed short);
16940 int vec_any_ge (vector signed short, vector bool short);
16941 int vec_any_ge (vector bool short, vector unsigned short);
16942 int vec_any_ge (vector bool short, vector signed short);
16943 int vec_any_ge (vector signed int, vector bool int);
16944 int vec_any_ge (vector unsigned int, vector bool int);
16945 int vec_any_ge (vector unsigned int, vector unsigned int);
16946 int vec_any_ge (vector signed int, vector signed int);
16947 int vec_any_ge (vector bool int, vector unsigned int);
16948 int vec_any_ge (vector bool int, vector signed int);
16949 int vec_any_ge (vector float, vector float);
16951 int vec_any_gt (vector bool char, vector unsigned char);
16952 int vec_any_gt (vector unsigned char, vector bool char);
16953 int vec_any_gt (vector unsigned char, vector unsigned char);
16954 int vec_any_gt (vector bool char, vector signed char);
16955 int vec_any_gt (vector signed char, vector bool char);
16956 int vec_any_gt (vector signed char, vector signed char);
16957 int vec_any_gt (vector bool short, vector unsigned short);
16958 int vec_any_gt (vector unsigned short, vector bool short);
16959 int vec_any_gt (vector unsigned short, vector unsigned short);
16960 int vec_any_gt (vector bool short, vector signed short);
16961 int vec_any_gt (vector signed short, vector bool short);
16962 int vec_any_gt (vector signed short, vector signed short);
16963 int vec_any_gt (vector bool int, vector unsigned int);
16964 int vec_any_gt (vector unsigned int, vector bool int);
16965 int vec_any_gt (vector unsigned int, vector unsigned int);
16966 int vec_any_gt (vector bool int, vector signed int);
16967 int vec_any_gt (vector signed int, vector bool int);
16968 int vec_any_gt (vector signed int, vector signed int);
16969 int vec_any_gt (vector float, vector float);
16971 int vec_any_le (vector bool char, vector unsigned char);
16972 int vec_any_le (vector unsigned char, vector bool char);
16973 int vec_any_le (vector unsigned char, vector unsigned char);
16974 int vec_any_le (vector bool char, vector signed char);
16975 int vec_any_le (vector signed char, vector bool char);
16976 int vec_any_le (vector signed char, vector signed char);
16977 int vec_any_le (vector bool short, vector unsigned short);
16978 int vec_any_le (vector unsigned short, vector bool short);
16979 int vec_any_le (vector unsigned short, vector unsigned short);
16980 int vec_any_le (vector bool short, vector signed short);
16981 int vec_any_le (vector signed short, vector bool short);
16982 int vec_any_le (vector signed short, vector signed short);
16983 int vec_any_le (vector bool int, vector unsigned int);
16984 int vec_any_le (vector unsigned int, vector bool int);
16985 int vec_any_le (vector unsigned int, vector unsigned int);
16986 int vec_any_le (vector bool int, vector signed int);
16987 int vec_any_le (vector signed int, vector bool int);
16988 int vec_any_le (vector signed int, vector signed int);
16989 int vec_any_le (vector float, vector float);
16991 int vec_any_lt (vector bool char, vector unsigned char);
16992 int vec_any_lt (vector unsigned char, vector bool char);
16993 int vec_any_lt (vector unsigned char, vector unsigned char);
16994 int vec_any_lt (vector bool char, vector signed char);
16995 int vec_any_lt (vector signed char, vector bool char);
16996 int vec_any_lt (vector signed char, vector signed char);
16997 int vec_any_lt (vector bool short, vector unsigned short);
16998 int vec_any_lt (vector unsigned short, vector bool short);
16999 int vec_any_lt (vector unsigned short, vector unsigned short);
17000 int vec_any_lt (vector bool short, vector signed short);
17001 int vec_any_lt (vector signed short, vector bool short);
17002 int vec_any_lt (vector signed short, vector signed short);
17003 int vec_any_lt (vector bool int, vector unsigned int);
17004 int vec_any_lt (vector unsigned int, vector bool int);
17005 int vec_any_lt (vector unsigned int, vector unsigned int);
17006 int vec_any_lt (vector bool int, vector signed int);
17007 int vec_any_lt (vector signed int, vector bool int);
17008 int vec_any_lt (vector signed int, vector signed int);
17009 int vec_any_lt (vector float, vector float);
17011 int vec_any_nan (vector float);
17013 int vec_any_ne (vector signed char, vector bool char);
17014 int vec_any_ne (vector signed char, vector signed char);
17015 int vec_any_ne (vector unsigned char, vector bool char);
17016 int vec_any_ne (vector unsigned char, vector unsigned char);
17017 int vec_any_ne (vector bool char, vector bool char);
17018 int vec_any_ne (vector bool char, vector unsigned char);
17019 int vec_any_ne (vector bool char, vector signed char);
17020 int vec_any_ne (vector signed short, vector bool short);
17021 int vec_any_ne (vector signed short, vector signed short);
17022 int vec_any_ne (vector unsigned short, vector bool short);
17023 int vec_any_ne (vector unsigned short, vector unsigned short);
17024 int vec_any_ne (vector bool short, vector bool short);
17025 int vec_any_ne (vector bool short, vector unsigned short);
17026 int vec_any_ne (vector bool short, vector signed short);
17027 int vec_any_ne (vector pixel, vector pixel);
17028 int vec_any_ne (vector signed int, vector bool int);
17029 int vec_any_ne (vector signed int, vector signed int);
17030 int vec_any_ne (vector unsigned int, vector bool int);
17031 int vec_any_ne (vector unsigned int, vector unsigned int);
17032 int vec_any_ne (vector bool int, vector bool int);
17033 int vec_any_ne (vector bool int, vector unsigned int);
17034 int vec_any_ne (vector bool int, vector signed int);
17035 int vec_any_ne (vector float, vector float);
17037 int vec_any_nge (vector float, vector float);
17039 int vec_any_ngt (vector float, vector float);
17041 int vec_any_nle (vector float, vector float);
17043 int vec_any_nlt (vector float, vector float);
17045 int vec_any_numeric (vector float);
17047 int vec_any_out (vector float, vector float);
17048 @end smallexample
17050 If the vector/scalar (VSX) instruction set is available, the following
17051 additional functions are available:
17053 @smallexample
17054 vector double vec_abs (vector double);
17055 vector double vec_add (vector double, vector double);
17056 vector double vec_and (vector double, vector double);
17057 vector double vec_and (vector double, vector bool long);
17058 vector double vec_and (vector bool long, vector double);
17059 vector long vec_and (vector long, vector long);
17060 vector long vec_and (vector long, vector bool long);
17061 vector long vec_and (vector bool long, vector long);
17062 vector unsigned long vec_and (vector unsigned long, vector unsigned long);
17063 vector unsigned long vec_and (vector unsigned long, vector bool long);
17064 vector unsigned long vec_and (vector bool long, vector unsigned long);
17065 vector double vec_andc (vector double, vector double);
17066 vector double vec_andc (vector double, vector bool long);
17067 vector double vec_andc (vector bool long, vector double);
17068 vector long vec_andc (vector long, vector long);
17069 vector long vec_andc (vector long, vector bool long);
17070 vector long vec_andc (vector bool long, vector long);
17071 vector unsigned long vec_andc (vector unsigned long, vector unsigned long);
17072 vector unsigned long vec_andc (vector unsigned long, vector bool long);
17073 vector unsigned long vec_andc (vector bool long, vector unsigned long);
17074 vector double vec_ceil (vector double);
17075 vector bool long vec_cmpeq (vector double, vector double);
17076 vector bool long vec_cmpge (vector double, vector double);
17077 vector bool long vec_cmpgt (vector double, vector double);
17078 vector bool long vec_cmple (vector double, vector double);
17079 vector bool long vec_cmplt (vector double, vector double);
17080 vector double vec_cpsgn (vector double, vector double);
17081 vector float vec_div (vector float, vector float);
17082 vector double vec_div (vector double, vector double);
17083 vector long vec_div (vector long, vector long);
17084 vector unsigned long vec_div (vector unsigned long, vector unsigned long);
17085 vector double vec_floor (vector double);
17086 vector double vec_ld (int, const vector double *);
17087 vector double vec_ld (int, const double *);
17088 vector double vec_ldl (int, const vector double *);
17089 vector double vec_ldl (int, const double *);
17090 vector unsigned char vec_lvsl (int, const volatile double *);
17091 vector unsigned char vec_lvsr (int, const volatile double *);
17092 vector double vec_madd (vector double, vector double, vector double);
17093 vector double vec_max (vector double, vector double);
17094 vector signed long vec_mergeh (vector signed long, vector signed long);
17095 vector signed long vec_mergeh (vector signed long, vector bool long);
17096 vector signed long vec_mergeh (vector bool long, vector signed long);
17097 vector unsigned long vec_mergeh (vector unsigned long, vector unsigned long);
17098 vector unsigned long vec_mergeh (vector unsigned long, vector bool long);
17099 vector unsigned long vec_mergeh (vector bool long, vector unsigned long);
17100 vector signed long vec_mergel (vector signed long, vector signed long);
17101 vector signed long vec_mergel (vector signed long, vector bool long);
17102 vector signed long vec_mergel (vector bool long, vector signed long);
17103 vector unsigned long vec_mergel (vector unsigned long, vector unsigned long);
17104 vector unsigned long vec_mergel (vector unsigned long, vector bool long);
17105 vector unsigned long vec_mergel (vector bool long, vector unsigned long);
17106 vector double vec_min (vector double, vector double);
17107 vector float vec_msub (vector float, vector float, vector float);
17108 vector double vec_msub (vector double, vector double, vector double);
17109 vector float vec_mul (vector float, vector float);
17110 vector double vec_mul (vector double, vector double);
17111 vector long vec_mul (vector long, vector long);
17112 vector unsigned long vec_mul (vector unsigned long, vector unsigned long);
17113 vector float vec_nearbyint (vector float);
17114 vector double vec_nearbyint (vector double);
17115 vector float vec_nmadd (vector float, vector float, vector float);
17116 vector double vec_nmadd (vector double, vector double, vector double);
17117 vector double vec_nmsub (vector double, vector double, vector double);
17118 vector double vec_nor (vector double, vector double);
17119 vector long vec_nor (vector long, vector long);
17120 vector long vec_nor (vector long, vector bool long);
17121 vector long vec_nor (vector bool long, vector long);
17122 vector unsigned long vec_nor (vector unsigned long, vector unsigned long);
17123 vector unsigned long vec_nor (vector unsigned long, vector bool long);
17124 vector unsigned long vec_nor (vector bool long, vector unsigned long);
17125 vector double vec_or (vector double, vector double);
17126 vector double vec_or (vector double, vector bool long);
17127 vector double vec_or (vector bool long, vector double);
17128 vector long vec_or (vector long, vector long);
17129 vector long vec_or (vector long, vector bool long);
17130 vector long vec_or (vector bool long, vector long);
17131 vector unsigned long vec_or (vector unsigned long, vector unsigned long);
17132 vector unsigned long vec_or (vector unsigned long, vector bool long);
17133 vector unsigned long vec_or (vector bool long, vector unsigned long);
17134 vector double vec_perm (vector double, vector double, vector unsigned char);
17135 vector long vec_perm (vector long, vector long, vector unsigned char);
17136 vector unsigned long vec_perm (vector unsigned long, vector unsigned long,
17137                                vector unsigned char);
17138 vector double vec_rint (vector double);
17139 vector double vec_recip (vector double, vector double);
17140 vector double vec_rsqrt (vector double);
17141 vector double vec_rsqrte (vector double);
17142 vector double vec_sel (vector double, vector double, vector bool long);
17143 vector double vec_sel (vector double, vector double, vector unsigned long);
17144 vector long vec_sel (vector long, vector long, vector long);
17145 vector long vec_sel (vector long, vector long, vector unsigned long);
17146 vector long vec_sel (vector long, vector long, vector bool long);
17147 vector unsigned long vec_sel (vector unsigned long, vector unsigned long,
17148                               vector long);
17149 vector unsigned long vec_sel (vector unsigned long, vector unsigned long,
17150                               vector unsigned long);
17151 vector unsigned long vec_sel (vector unsigned long, vector unsigned long,
17152                               vector bool long);
17153 vector double vec_splats (double);
17154 vector signed long vec_splats (signed long);
17155 vector unsigned long vec_splats (unsigned long);
17156 vector float vec_sqrt (vector float);
17157 vector double vec_sqrt (vector double);
17158 void vec_st (vector double, int, vector double *);
17159 void vec_st (vector double, int, double *);
17160 vector double vec_sub (vector double, vector double);
17161 vector double vec_trunc (vector double);
17162 vector double vec_xl (int, vector double *);
17163 vector double vec_xl (int, double *);
17164 vector long long vec_xl (int, vector long long *);
17165 vector long long vec_xl (int, long long *);
17166 vector unsigned long long vec_xl (int, vector unsigned long long *);
17167 vector unsigned long long vec_xl (int, unsigned long long *);
17168 vector float vec_xl (int, vector float *);
17169 vector float vec_xl (int, float *);
17170 vector int vec_xl (int, vector int *);
17171 vector int vec_xl (int, int *);
17172 vector unsigned int vec_xl (int, vector unsigned int *);
17173 vector unsigned int vec_xl (int, unsigned int *);
17174 vector double vec_xor (vector double, vector double);
17175 vector double vec_xor (vector double, vector bool long);
17176 vector double vec_xor (vector bool long, vector double);
17177 vector long vec_xor (vector long, vector long);
17178 vector long vec_xor (vector long, vector bool long);
17179 vector long vec_xor (vector bool long, vector long);
17180 vector unsigned long vec_xor (vector unsigned long, vector unsigned long);
17181 vector unsigned long vec_xor (vector unsigned long, vector bool long);
17182 vector unsigned long vec_xor (vector bool long, vector unsigned long);
17183 void vec_xst (vector double, int, vector double *);
17184 void vec_xst (vector double, int, double *);
17185 void vec_xst (vector long long, int, vector long long *);
17186 void vec_xst (vector long long, int, long long *);
17187 void vec_xst (vector unsigned long long, int, vector unsigned long long *);
17188 void vec_xst (vector unsigned long long, int, unsigned long long *);
17189 void vec_xst (vector float, int, vector float *);
17190 void vec_xst (vector float, int, float *);
17191 void vec_xst (vector int, int, vector int *);
17192 void vec_xst (vector int, int, int *);
17193 void vec_xst (vector unsigned int, int, vector unsigned int *);
17194 void vec_xst (vector unsigned int, int, unsigned int *);
17195 int vec_all_eq (vector double, vector double);
17196 int vec_all_ge (vector double, vector double);
17197 int vec_all_gt (vector double, vector double);
17198 int vec_all_le (vector double, vector double);
17199 int vec_all_lt (vector double, vector double);
17200 int vec_all_nan (vector double);
17201 int vec_all_ne (vector double, vector double);
17202 int vec_all_nge (vector double, vector double);
17203 int vec_all_ngt (vector double, vector double);
17204 int vec_all_nle (vector double, vector double);
17205 int vec_all_nlt (vector double, vector double);
17206 int vec_all_numeric (vector double);
17207 int vec_any_eq (vector double, vector double);
17208 int vec_any_ge (vector double, vector double);
17209 int vec_any_gt (vector double, vector double);
17210 int vec_any_le (vector double, vector double);
17211 int vec_any_lt (vector double, vector double);
17212 int vec_any_nan (vector double);
17213 int vec_any_ne (vector double, vector double);
17214 int vec_any_nge (vector double, vector double);
17215 int vec_any_ngt (vector double, vector double);
17216 int vec_any_nle (vector double, vector double);
17217 int vec_any_nlt (vector double, vector double);
17218 int vec_any_numeric (vector double);
17220 vector double vec_vsx_ld (int, const vector double *);
17221 vector double vec_vsx_ld (int, const double *);
17222 vector float vec_vsx_ld (int, const vector float *);
17223 vector float vec_vsx_ld (int, const float *);
17224 vector bool int vec_vsx_ld (int, const vector bool int *);
17225 vector signed int vec_vsx_ld (int, const vector signed int *);
17226 vector signed int vec_vsx_ld (int, const int *);
17227 vector signed int vec_vsx_ld (int, const long *);
17228 vector unsigned int vec_vsx_ld (int, const vector unsigned int *);
17229 vector unsigned int vec_vsx_ld (int, const unsigned int *);
17230 vector unsigned int vec_vsx_ld (int, const unsigned long *);
17231 vector bool short vec_vsx_ld (int, const vector bool short *);
17232 vector pixel vec_vsx_ld (int, const vector pixel *);
17233 vector signed short vec_vsx_ld (int, const vector signed short *);
17234 vector signed short vec_vsx_ld (int, const short *);
17235 vector unsigned short vec_vsx_ld (int, const vector unsigned short *);
17236 vector unsigned short vec_vsx_ld (int, const unsigned short *);
17237 vector bool char vec_vsx_ld (int, const vector bool char *);
17238 vector signed char vec_vsx_ld (int, const vector signed char *);
17239 vector signed char vec_vsx_ld (int, const signed char *);
17240 vector unsigned char vec_vsx_ld (int, const vector unsigned char *);
17241 vector unsigned char vec_vsx_ld (int, const unsigned char *);
17243 void vec_vsx_st (vector double, int, vector double *);
17244 void vec_vsx_st (vector double, int, double *);
17245 void vec_vsx_st (vector float, int, vector float *);
17246 void vec_vsx_st (vector float, int, float *);
17247 void vec_vsx_st (vector signed int, int, vector signed int *);
17248 void vec_vsx_st (vector signed int, int, int *);
17249 void vec_vsx_st (vector unsigned int, int, vector unsigned int *);
17250 void vec_vsx_st (vector unsigned int, int, unsigned int *);
17251 void vec_vsx_st (vector bool int, int, vector bool int *);
17252 void vec_vsx_st (vector bool int, int, unsigned int *);
17253 void vec_vsx_st (vector bool int, int, int *);
17254 void vec_vsx_st (vector signed short, int, vector signed short *);
17255 void vec_vsx_st (vector signed short, int, short *);
17256 void vec_vsx_st (vector unsigned short, int, vector unsigned short *);
17257 void vec_vsx_st (vector unsigned short, int, unsigned short *);
17258 void vec_vsx_st (vector bool short, int, vector bool short *);
17259 void vec_vsx_st (vector bool short, int, unsigned short *);
17260 void vec_vsx_st (vector pixel, int, vector pixel *);
17261 void vec_vsx_st (vector pixel, int, unsigned short *);
17262 void vec_vsx_st (vector pixel, int, short *);
17263 void vec_vsx_st (vector bool short, int, short *);
17264 void vec_vsx_st (vector signed char, int, vector signed char *);
17265 void vec_vsx_st (vector signed char, int, signed char *);
17266 void vec_vsx_st (vector unsigned char, int, vector unsigned char *);
17267 void vec_vsx_st (vector unsigned char, int, unsigned char *);
17268 void vec_vsx_st (vector bool char, int, vector bool char *);
17269 void vec_vsx_st (vector bool char, int, unsigned char *);
17270 void vec_vsx_st (vector bool char, int, signed char *);
17272 vector double vec_xxpermdi (vector double, vector double, int);
17273 vector float vec_xxpermdi (vector float, vector float, int);
17274 vector long long vec_xxpermdi (vector long long, vector long long, int);
17275 vector unsigned long long vec_xxpermdi (vector unsigned long long,
17276                                         vector unsigned long long, int);
17277 vector int vec_xxpermdi (vector int, vector int, int);
17278 vector unsigned int vec_xxpermdi (vector unsigned int,
17279                                   vector unsigned int, int);
17280 vector short vec_xxpermdi (vector short, vector short, int);
17281 vector unsigned short vec_xxpermdi (vector unsigned short,
17282                                     vector unsigned short, int);
17283 vector signed char vec_xxpermdi (vector signed char, vector signed char, int);
17284 vector unsigned char vec_xxpermdi (vector unsigned char,
17285                                    vector unsigned char, int);
17287 vector double vec_xxsldi (vector double, vector double, int);
17288 vector float vec_xxsldi (vector float, vector float, int);
17289 vector long long vec_xxsldi (vector long long, vector long long, int);
17290 vector unsigned long long vec_xxsldi (vector unsigned long long,
17291                                       vector unsigned long long, int);
17292 vector int vec_xxsldi (vector int, vector int, int);
17293 vector unsigned int vec_xxsldi (vector unsigned int, vector unsigned int, int);
17294 vector short vec_xxsldi (vector short, vector short, int);
17295 vector unsigned short vec_xxsldi (vector unsigned short,
17296                                   vector unsigned short, int);
17297 vector signed char vec_xxsldi (vector signed char, vector signed char, int);
17298 vector unsigned char vec_xxsldi (vector unsigned char,
17299                                  vector unsigned char, int);
17300 @end smallexample
17302 Note that the @samp{vec_ld} and @samp{vec_st} built-in functions always
17303 generate the AltiVec @samp{LVX} and @samp{STVX} instructions even
17304 if the VSX instruction set is available.  The @samp{vec_vsx_ld} and
17305 @samp{vec_vsx_st} built-in functions always generate the VSX @samp{LXVD2X},
17306 @samp{LXVW4X}, @samp{STXVD2X}, and @samp{STXVW4X} instructions.
17308 If the ISA 2.07 additions to the vector/scalar (power8-vector)
17309 instruction set are available, the following additional functions are
17310 available for both 32-bit and 64-bit targets.  For 64-bit targets, you
17311 can use @var{vector long} instead of @var{vector long long},
17312 @var{vector bool long} instead of @var{vector bool long long}, and
17313 @var{vector unsigned long} instead of @var{vector unsigned long long}.
17315 @smallexample
17316 vector long long vec_abs (vector long long);
17318 vector long long vec_add (vector long long, vector long long);
17319 vector unsigned long long vec_add (vector unsigned long long,
17320                                    vector unsigned long long);
17322 int vec_all_eq (vector long long, vector long long);
17323 int vec_all_eq (vector unsigned long long, vector unsigned long long);
17324 int vec_all_ge (vector long long, vector long long);
17325 int vec_all_ge (vector unsigned long long, vector unsigned long long);
17326 int vec_all_gt (vector long long, vector long long);
17327 int vec_all_gt (vector unsigned long long, vector unsigned long long);
17328 int vec_all_le (vector long long, vector long long);
17329 int vec_all_le (vector unsigned long long, vector unsigned long long);
17330 int vec_all_lt (vector long long, vector long long);
17331 int vec_all_lt (vector unsigned long long, vector unsigned long long);
17332 int vec_all_ne (vector long long, vector long long);
17333 int vec_all_ne (vector unsigned long long, vector unsigned long long);
17335 int vec_any_eq (vector long long, vector long long);
17336 int vec_any_eq (vector unsigned long long, vector unsigned long long);
17337 int vec_any_ge (vector long long, vector long long);
17338 int vec_any_ge (vector unsigned long long, vector unsigned long long);
17339 int vec_any_gt (vector long long, vector long long);
17340 int vec_any_gt (vector unsigned long long, vector unsigned long long);
17341 int vec_any_le (vector long long, vector long long);
17342 int vec_any_le (vector unsigned long long, vector unsigned long long);
17343 int vec_any_lt (vector long long, vector long long);
17344 int vec_any_lt (vector unsigned long long, vector unsigned long long);
17345 int vec_any_ne (vector long long, vector long long);
17346 int vec_any_ne (vector unsigned long long, vector unsigned long long);
17348 vector long long vec_eqv (vector long long, vector long long);
17349 vector long long vec_eqv (vector bool long long, vector long long);
17350 vector long long vec_eqv (vector long long, vector bool long long);
17351 vector unsigned long long vec_eqv (vector unsigned long long,
17352                                    vector unsigned long long);
17353 vector unsigned long long vec_eqv (vector bool long long,
17354                                    vector unsigned long long);
17355 vector unsigned long long vec_eqv (vector unsigned long long,
17356                                    vector bool long long);
17357 vector int vec_eqv (vector int, vector int);
17358 vector int vec_eqv (vector bool int, vector int);
17359 vector int vec_eqv (vector int, vector bool int);
17360 vector unsigned int vec_eqv (vector unsigned int, vector unsigned int);
17361 vector unsigned int vec_eqv (vector bool unsigned int,
17362                              vector unsigned int);
17363 vector unsigned int vec_eqv (vector unsigned int,
17364                              vector bool unsigned int);
17365 vector short vec_eqv (vector short, vector short);
17366 vector short vec_eqv (vector bool short, vector short);
17367 vector short vec_eqv (vector short, vector bool short);
17368 vector unsigned short vec_eqv (vector unsigned short, vector unsigned short);
17369 vector unsigned short vec_eqv (vector bool unsigned short,
17370                                vector unsigned short);
17371 vector unsigned short vec_eqv (vector unsigned short,
17372                                vector bool unsigned short);
17373 vector signed char vec_eqv (vector signed char, vector signed char);
17374 vector signed char vec_eqv (vector bool signed char, vector signed char);
17375 vector signed char vec_eqv (vector signed char, vector bool signed char);
17376 vector unsigned char vec_eqv (vector unsigned char, vector unsigned char);
17377 vector unsigned char vec_eqv (vector bool unsigned char, vector unsigned char);
17378 vector unsigned char vec_eqv (vector unsigned char, vector bool unsigned char);
17380 vector long long vec_max (vector long long, vector long long);
17381 vector unsigned long long vec_max (vector unsigned long long,
17382                                    vector unsigned long long);
17384 vector signed int vec_mergee (vector signed int, vector signed int);
17385 vector unsigned int vec_mergee (vector unsigned int, vector unsigned int);
17386 vector bool int vec_mergee (vector bool int, vector bool int);
17388 vector signed int vec_mergeo (vector signed int, vector signed int);
17389 vector unsigned int vec_mergeo (vector unsigned int, vector unsigned int);
17390 vector bool int vec_mergeo (vector bool int, vector bool int);
17392 vector long long vec_min (vector long long, vector long long);
17393 vector unsigned long long vec_min (vector unsigned long long,
17394                                    vector unsigned long long);
17396 vector long long vec_nand (vector long long, vector long long);
17397 vector long long vec_nand (vector bool long long, vector long long);
17398 vector long long vec_nand (vector long long, vector bool long long);
17399 vector unsigned long long vec_nand (vector unsigned long long,
17400                                     vector unsigned long long);
17401 vector unsigned long long vec_nand (vector bool long long,
17402                                    vector unsigned long long);
17403 vector unsigned long long vec_nand (vector unsigned long long,
17404                                     vector bool long long);
17405 vector int vec_nand (vector int, vector int);
17406 vector int vec_nand (vector bool int, vector int);
17407 vector int vec_nand (vector int, vector bool int);
17408 vector unsigned int vec_nand (vector unsigned int, vector unsigned int);
17409 vector unsigned int vec_nand (vector bool unsigned int,
17410                               vector unsigned int);
17411 vector unsigned int vec_nand (vector unsigned int,
17412                               vector bool unsigned int);
17413 vector short vec_nand (vector short, vector short);
17414 vector short vec_nand (vector bool short, vector short);
17415 vector short vec_nand (vector short, vector bool short);
17416 vector unsigned short vec_nand (vector unsigned short, vector unsigned short);
17417 vector unsigned short vec_nand (vector bool unsigned short,
17418                                 vector unsigned short);
17419 vector unsigned short vec_nand (vector unsigned short,
17420                                 vector bool unsigned short);
17421 vector signed char vec_nand (vector signed char, vector signed char);
17422 vector signed char vec_nand (vector bool signed char, vector signed char);
17423 vector signed char vec_nand (vector signed char, vector bool signed char);
17424 vector unsigned char vec_nand (vector unsigned char, vector unsigned char);
17425 vector unsigned char vec_nand (vector bool unsigned char, vector unsigned char);
17426 vector unsigned char vec_nand (vector unsigned char, vector bool unsigned char);
17428 vector long long vec_orc (vector long long, vector long long);
17429 vector long long vec_orc (vector bool long long, vector long long);
17430 vector long long vec_orc (vector long long, vector bool long long);
17431 vector unsigned long long vec_orc (vector unsigned long long,
17432                                    vector unsigned long long);
17433 vector unsigned long long vec_orc (vector bool long long,
17434                                    vector unsigned long long);
17435 vector unsigned long long vec_orc (vector unsigned long long,
17436                                    vector bool long long);
17437 vector int vec_orc (vector int, vector int);
17438 vector int vec_orc (vector bool int, vector int);
17439 vector int vec_orc (vector int, vector bool int);
17440 vector unsigned int vec_orc (vector unsigned int, vector unsigned int);
17441 vector unsigned int vec_orc (vector bool unsigned int,
17442                              vector unsigned int);
17443 vector unsigned int vec_orc (vector unsigned int,
17444                              vector bool unsigned int);
17445 vector short vec_orc (vector short, vector short);
17446 vector short vec_orc (vector bool short, vector short);
17447 vector short vec_orc (vector short, vector bool short);
17448 vector unsigned short vec_orc (vector unsigned short, vector unsigned short);
17449 vector unsigned short vec_orc (vector bool unsigned short,
17450                                vector unsigned short);
17451 vector unsigned short vec_orc (vector unsigned short,
17452                                vector bool unsigned short);
17453 vector signed char vec_orc (vector signed char, vector signed char);
17454 vector signed char vec_orc (vector bool signed char, vector signed char);
17455 vector signed char vec_orc (vector signed char, vector bool signed char);
17456 vector unsigned char vec_orc (vector unsigned char, vector unsigned char);
17457 vector unsigned char vec_orc (vector bool unsigned char, vector unsigned char);
17458 vector unsigned char vec_orc (vector unsigned char, vector bool unsigned char);
17460 vector int vec_pack (vector long long, vector long long);
17461 vector unsigned int vec_pack (vector unsigned long long,
17462                               vector unsigned long long);
17463 vector bool int vec_pack (vector bool long long, vector bool long long);
17465 vector int vec_packs (vector long long, vector long long);
17466 vector unsigned int vec_packs (vector unsigned long long,
17467                                vector unsigned long long);
17469 vector unsigned int vec_packsu (vector long long, vector long long);
17470 vector unsigned int vec_packsu (vector unsigned long long,
17471                                 vector unsigned long long);
17473 vector long long vec_rl (vector long long,
17474                          vector unsigned long long);
17475 vector long long vec_rl (vector unsigned long long,
17476                          vector unsigned long long);
17478 vector long long vec_sl (vector long long, vector unsigned long long);
17479 vector long long vec_sl (vector unsigned long long,
17480                          vector unsigned long long);
17482 vector long long vec_sr (vector long long, vector unsigned long long);
17483 vector unsigned long long char vec_sr (vector unsigned long long,
17484                                        vector unsigned long long);
17486 vector long long vec_sra (vector long long, vector unsigned long long);
17487 vector unsigned long long vec_sra (vector unsigned long long,
17488                                    vector unsigned long long);
17490 vector long long vec_sub (vector long long, vector long long);
17491 vector unsigned long long vec_sub (vector unsigned long long,
17492                                    vector unsigned long long);
17494 vector long long vec_unpackh (vector int);
17495 vector unsigned long long vec_unpackh (vector unsigned int);
17497 vector long long vec_unpackl (vector int);
17498 vector unsigned long long vec_unpackl (vector unsigned int);
17500 vector long long vec_vaddudm (vector long long, vector long long);
17501 vector long long vec_vaddudm (vector bool long long, vector long long);
17502 vector long long vec_vaddudm (vector long long, vector bool long long);
17503 vector unsigned long long vec_vaddudm (vector unsigned long long,
17504                                        vector unsigned long long);
17505 vector unsigned long long vec_vaddudm (vector bool unsigned long long,
17506                                        vector unsigned long long);
17507 vector unsigned long long vec_vaddudm (vector unsigned long long,
17508                                        vector bool unsigned long long);
17510 vector long long vec_vbpermq (vector signed char, vector signed char);
17511 vector long long vec_vbpermq (vector unsigned char, vector unsigned char);
17513 vector long long vec_cntlz (vector long long);
17514 vector unsigned long long vec_cntlz (vector unsigned long long);
17515 vector int vec_cntlz (vector int);
17516 vector unsigned int vec_cntlz (vector int);
17517 vector short vec_cntlz (vector short);
17518 vector unsigned short vec_cntlz (vector unsigned short);
17519 vector signed char vec_cntlz (vector signed char);
17520 vector unsigned char vec_cntlz (vector unsigned char);
17522 vector long long vec_vclz (vector long long);
17523 vector unsigned long long vec_vclz (vector unsigned long long);
17524 vector int vec_vclz (vector int);
17525 vector unsigned int vec_vclz (vector int);
17526 vector short vec_vclz (vector short);
17527 vector unsigned short vec_vclz (vector unsigned short);
17528 vector signed char vec_vclz (vector signed char);
17529 vector unsigned char vec_vclz (vector unsigned char);
17531 vector signed char vec_vclzb (vector signed char);
17532 vector unsigned char vec_vclzb (vector unsigned char);
17534 vector long long vec_vclzd (vector long long);
17535 vector unsigned long long vec_vclzd (vector unsigned long long);
17537 vector short vec_vclzh (vector short);
17538 vector unsigned short vec_vclzh (vector unsigned short);
17540 vector int vec_vclzw (vector int);
17541 vector unsigned int vec_vclzw (vector int);
17543 vector signed char vec_vgbbd (vector signed char);
17544 vector unsigned char vec_vgbbd (vector unsigned char);
17546 vector long long vec_vmaxsd (vector long long, vector long long);
17548 vector unsigned long long vec_vmaxud (vector unsigned long long,
17549                                       unsigned vector long long);
17551 vector long long vec_vminsd (vector long long, vector long long);
17553 vector unsigned long long vec_vminud (vector long long,
17554                                       vector long long);
17556 vector int vec_vpksdss (vector long long, vector long long);
17557 vector unsigned int vec_vpksdss (vector long long, vector long long);
17559 vector unsigned int vec_vpkudus (vector unsigned long long,
17560                                  vector unsigned long long);
17562 vector int vec_vpkudum (vector long long, vector long long);
17563 vector unsigned int vec_vpkudum (vector unsigned long long,
17564                                  vector unsigned long long);
17565 vector bool int vec_vpkudum (vector bool long long, vector bool long long);
17567 vector long long vec_vpopcnt (vector long long);
17568 vector unsigned long long vec_vpopcnt (vector unsigned long long);
17569 vector int vec_vpopcnt (vector int);
17570 vector unsigned int vec_vpopcnt (vector int);
17571 vector short vec_vpopcnt (vector short);
17572 vector unsigned short vec_vpopcnt (vector unsigned short);
17573 vector signed char vec_vpopcnt (vector signed char);
17574 vector unsigned char vec_vpopcnt (vector unsigned char);
17576 vector signed char vec_vpopcntb (vector signed char);
17577 vector unsigned char vec_vpopcntb (vector unsigned char);
17579 vector long long vec_vpopcntd (vector long long);
17580 vector unsigned long long vec_vpopcntd (vector unsigned long long);
17582 vector short vec_vpopcnth (vector short);
17583 vector unsigned short vec_vpopcnth (vector unsigned short);
17585 vector int vec_vpopcntw (vector int);
17586 vector unsigned int vec_vpopcntw (vector int);
17588 vector long long vec_vrld (vector long long, vector unsigned long long);
17589 vector unsigned long long vec_vrld (vector unsigned long long,
17590                                     vector unsigned long long);
17592 vector long long vec_vsld (vector long long, vector unsigned long long);
17593 vector long long vec_vsld (vector unsigned long long,
17594                            vector unsigned long long);
17596 vector long long vec_vsrad (vector long long, vector unsigned long long);
17597 vector unsigned long long vec_vsrad (vector unsigned long long,
17598                                      vector unsigned long long);
17600 vector long long vec_vsrd (vector long long, vector unsigned long long);
17601 vector unsigned long long char vec_vsrd (vector unsigned long long,
17602                                          vector unsigned long long);
17604 vector long long vec_vsubudm (vector long long, vector long long);
17605 vector long long vec_vsubudm (vector bool long long, vector long long);
17606 vector long long vec_vsubudm (vector long long, vector bool long long);
17607 vector unsigned long long vec_vsubudm (vector unsigned long long,
17608                                        vector unsigned long long);
17609 vector unsigned long long vec_vsubudm (vector bool long long,
17610                                        vector unsigned long long);
17611 vector unsigned long long vec_vsubudm (vector unsigned long long,
17612                                        vector bool long long);
17614 vector long long vec_vupkhsw (vector int);
17615 vector unsigned long long vec_vupkhsw (vector unsigned int);
17617 vector long long vec_vupklsw (vector int);
17618 vector unsigned long long vec_vupklsw (vector int);
17619 @end smallexample
17621 If the ISA 2.07 additions to the vector/scalar (power8-vector)
17622 instruction set are available, the following additional functions are
17623 available for 64-bit targets.  New vector types
17624 (@var{vector __int128_t} and @var{vector __uint128_t}) are available
17625 to hold the @var{__int128_t} and @var{__uint128_t} types to use these
17626 builtins.
17628 The normal vector extract, and set operations work on
17629 @var{vector __int128_t} and @var{vector __uint128_t} types,
17630 but the index value must be 0.
17632 @smallexample
17633 vector __int128_t vec_vaddcuq (vector __int128_t, vector __int128_t);
17634 vector __uint128_t vec_vaddcuq (vector __uint128_t, vector __uint128_t);
17636 vector __int128_t vec_vadduqm (vector __int128_t, vector __int128_t);
17637 vector __uint128_t vec_vadduqm (vector __uint128_t, vector __uint128_t);
17639 vector __int128_t vec_vaddecuq (vector __int128_t, vector __int128_t,
17640                                 vector __int128_t);
17641 vector __uint128_t vec_vaddecuq (vector __uint128_t, vector __uint128_t,
17642                                  vector __uint128_t);
17644 vector __int128_t vec_vaddeuqm (vector __int128_t, vector __int128_t,
17645                                 vector __int128_t);
17646 vector __uint128_t vec_vaddeuqm (vector __uint128_t, vector __uint128_t,
17647                                  vector __uint128_t);
17649 vector __int128_t vec_vsubecuq (vector __int128_t, vector __int128_t,
17650                                 vector __int128_t);
17651 vector __uint128_t vec_vsubecuq (vector __uint128_t, vector __uint128_t,
17652                                  vector __uint128_t);
17654 vector __int128_t vec_vsubeuqm (vector __int128_t, vector __int128_t,
17655                                 vector __int128_t);
17656 vector __uint128_t vec_vsubeuqm (vector __uint128_t, vector __uint128_t,
17657                                  vector __uint128_t);
17659 vector __int128_t vec_vsubcuq (vector __int128_t, vector __int128_t);
17660 vector __uint128_t vec_vsubcuq (vector __uint128_t, vector __uint128_t);
17662 __int128_t vec_vsubuqm (__int128_t, __int128_t);
17663 __uint128_t vec_vsubuqm (__uint128_t, __uint128_t);
17665 vector __int128_t __builtin_bcdadd (vector __int128_t, vector__int128_t);
17666 int __builtin_bcdadd_lt (vector __int128_t, vector__int128_t);
17667 int __builtin_bcdadd_eq (vector __int128_t, vector__int128_t);
17668 int __builtin_bcdadd_gt (vector __int128_t, vector__int128_t);
17669 int __builtin_bcdadd_ov (vector __int128_t, vector__int128_t);
17670 vector __int128_t bcdsub (vector __int128_t, vector__int128_t);
17671 int __builtin_bcdsub_lt (vector __int128_t, vector__int128_t);
17672 int __builtin_bcdsub_eq (vector __int128_t, vector__int128_t);
17673 int __builtin_bcdsub_gt (vector __int128_t, vector__int128_t);
17674 int __builtin_bcdsub_ov (vector __int128_t, vector__int128_t);
17675 @end smallexample
17677 If the ISA 3.0 instruction set additions (@option{-mcpu=power9})
17678 are available:
17680 @smallexample
17681 vector long long vec_vctz (vector long long);
17682 vector unsigned long long vec_vctz (vector unsigned long long);
17683 vector int vec_vctz (vector int);
17684 vector unsigned int vec_vctz (vector int);
17685 vector short vec_vctz (vector short);
17686 vector unsigned short vec_vctz (vector unsigned short);
17687 vector signed char vec_vctz (vector signed char);
17688 vector unsigned char vec_vctz (vector unsigned char);
17690 vector signed char vec_vctzb (vector signed char);
17691 vector unsigned char vec_vctzb (vector unsigned char);
17693 vector long long vec_vctzd (vector long long);
17694 vector unsigned long long vec_vctzd (vector unsigned long long);
17696 vector short vec_vctzh (vector short);
17697 vector unsigned short vec_vctzh (vector unsigned short);
17699 vector int vec_vctzw (vector int);
17700 vector unsigned int vec_vctzw (vector int);
17702 vector int vec_vprtyb (vector int);
17703 vector unsigned int vec_vprtyb (vector unsigned int);
17704 vector long long vec_vprtyb (vector long long);
17705 vector unsigned long long vec_vprtyb (vector unsigned long long);
17707 vector int vec_vprtybw (vector int);
17708 vector unsigned int vec_vprtybw (vector unsigned int);
17710 vector long long vec_vprtybd (vector long long);
17711 vector unsigned long long vec_vprtybd (vector unsigned long long);
17712 @end smallexample
17714 On 64-bit targets, if the ISA 3.0 additions (@option{-mcpu=power9})
17715 are available:
17717 @smallexample
17718 vector long vec_vprtyb (vector long);
17719 vector unsigned long vec_vprtyb (vector unsigned long);
17720 vector __int128_t vec_vprtyb (vector __int128_t);
17721 vector __uint128_t vec_vprtyb (vector __uint128_t);
17723 vector long vec_vprtybd (vector long);
17724 vector unsigned long vec_vprtybd (vector unsigned long);
17726 vector __int128_t vec_vprtybq (vector __int128_t);
17727 vector __uint128_t vec_vprtybd (vector __uint128_t);
17728 @end smallexample
17730 The following built-in vector functions are available for the PowerPC family
17731 of processors, starting with ISA 3.0 or later (@option{-mcpu=power9}):
17732 @smallexample
17733 __vector unsigned char
17734 vec_slv (__vector unsigned char src, __vector unsigned char shift_distance);
17735 __vector unsigned char
17736 vec_srv (__vector unsigned char src, __vector unsigned char shift_distance);
17737 @end smallexample
17739 The @code{vec_slv} and @code{vec_srv} functions operate on
17740 all of the bytes of their @code{src} and @code{shift_distance}
17741 arguments in parallel.  The behavior of the @code{vec_slv} is as if
17742 there existed a temporary array of 17 unsigned characters
17743 @code{slv_array} within which elements 0 through 15 are the same as
17744 the entries in the @code{src} array and element 16 equals 0.  The
17745 result returned from the @code{vec_slv} function is a
17746 @code{__vector} of 16 unsigned characters within which element
17747 @code{i} is computed using the C expression
17748 @code{0xff & (*((unsigned short *)(slv_array + i)) << (0x07 &
17749 shift_distance[i]))},
17750 with this resulting value coerced to the @code{unsigned char} type.
17751 The behavior of the @code{vec_srv} is as if
17752 there existed a temporary array of 17 unsigned characters
17753 @code{srv_array} within which element 0 equals zero and
17754 elements 1 through 16 equal the elements 0 through 15 of
17755 the @code{src} array.  The
17756 result returned from the @code{vec_srv} function is a
17757 @code{__vector} of 16 unsigned characters within which element
17758 @code{i} is computed using the C expression
17759 @code{0xff & (*((unsigned short *)(srv_array + i)) >>
17760 (0x07 & shift_distance[i]))},
17761 with this resulting value coerced to the @code{unsigned char} type.
17763 The following built-in functions are available for the PowerPC family
17764 of processors, starting with ISA 3.0 or later (@option{-mcpu=power9}):
17765 @smallexample
17766 __vector unsigned char
17767 vec_absd (__vector unsigned char arg1, __vector unsigned char arg2);
17768 __vector unsigned short
17769 vec_absd (__vector unsigned short arg1, __vector unsigned short arg2);
17770 __vector unsigned int
17771 vec_absd (__vector unsigned int arg1, __vector unsigned int arg2);
17773 __vector unsigned char
17774 vec_absdb (__vector unsigned char arg1, __vector unsigned char arg2);
17775 __vector unsigned short
17776 vec_absdh (__vector unsigned short arg1, __vector unsigned short arg2);
17777 __vector unsigned int
17778 vec_absdw (__vector unsigned int arg1, __vector unsigned int arg2);
17779 @end smallexample
17781 The @code{vec_absd}, @code{vec_absdb}, @code{vec_absdh}, and
17782 @code{vec_absdw} built-in functions each computes the absolute
17783 differences of the pairs of vector elements supplied in its two vector
17784 arguments, placing the absolute differences into the corresponding
17785 elements of the vector result.
17787 The following built-in functions are available for the PowerPC family
17788 of processors, starting with ISA 3.0 or later (@option{-mcpu=power9}):
17789 @smallexample
17790 __vector int
17791 vec_extract_exp (__vector float source);
17792 __vector long long int
17793 vec_extract_exp (__vector double source);
17795 __vector int
17796 vec_extract_sig (__vector float source);
17797 __vector long long int
17798 vec_extract_sig (__vector double source);
17800 __vector float
17801 vec_insert_exp (__vector unsigned int significands,  __vector unsigned int exponents);
17802 __vector double
17803 vec_insert_exp (__vector unsigned long long int significands,
17804                 __vector unsigned long long int exponents);
17806 __vector int vec_test_data_class (__vector float source, unsigned int condition);
17807 __vector long long int vec_test_data_class (__vector double source, unsigned int condition);
17808 @end smallexample
17810 The @code{vec_extract_sig} and @code{vec_extract_exp} built-in
17811 functions return vectors representing the significands and exponents
17812 of their @code{source} arguments respectively.  The
17813 @code{vec_insert_exp} built-in functions return a vector of single- or
17814 double-precision floating
17815 point values constructed by assembling the values of their
17816 @code{significands} and @code{exponents} arguments into the
17817 corresponding elements of the returned vector.  The sign of each
17818 element of the result is copied from the most significant bit of the
17819 corresponding entry within the @code{significands} argument.  The
17820 significand and exponent components of each element of the result are
17821 composed of the least significant bits of the corresponding
17822 @code{significands} element and the least significant bits of the
17823 corresponding @code{exponents} element.
17825 The @code{vec_test_data_class} built-in function returns a vector
17826 representing the results of testing the @code{source} vector for the
17827 condition selected by the @code{condition} argument.  The
17828 @code{condition} argument must be an unsigned integer with value not
17829 exceeding 127.  The
17830 @code{condition} argument is encoded as a bitmask with each bit
17831 enabling the testing of a different condition, as characterized by the
17832 following:
17833 @smallexample
17834 0x40    Test for NaN
17835 0x20    Test for +Infinity
17836 0x10    Test for -Infinity
17837 0x08    Test for +Zero
17838 0x04    Test for -Zero
17839 0x02    Test for +Denormal
17840 0x01    Test for -Denormal
17841 @end smallexample
17843 If any of the enabled test conditions is true, the corresponding entry
17844 in the result vector is -1.  Otherwise (all of the enabled test
17845 conditions are false), the corresponding entry of the result vector is 0.
17847 If the cryptographic instructions are enabled (@option{-mcrypto} or
17848 @option{-mcpu=power8}), the following builtins are enabled.
17850 @smallexample
17851 vector unsigned long long __builtin_crypto_vsbox (vector unsigned long long);
17853 vector unsigned long long __builtin_crypto_vcipher (vector unsigned long long,
17854                                                     vector unsigned long long);
17856 vector unsigned long long __builtin_crypto_vcipherlast
17857                                      (vector unsigned long long,
17858                                       vector unsigned long long);
17860 vector unsigned long long __builtin_crypto_vncipher (vector unsigned long long,
17861                                                      vector unsigned long long);
17863 vector unsigned long long __builtin_crypto_vncipherlast
17864                                      (vector unsigned long long,
17865                                       vector unsigned long long);
17867 vector unsigned char __builtin_crypto_vpermxor (vector unsigned char,
17868                                                 vector unsigned char,
17869                                                 vector unsigned char);
17871 vector unsigned short __builtin_crypto_vpermxor (vector unsigned short,
17872                                                  vector unsigned short,
17873                                                  vector unsigned short);
17875 vector unsigned int __builtin_crypto_vpermxor (vector unsigned int,
17876                                                vector unsigned int,
17877                                                vector unsigned int);
17879 vector unsigned long long __builtin_crypto_vpermxor (vector unsigned long long,
17880                                                      vector unsigned long long,
17881                                                      vector unsigned long long);
17883 vector unsigned char __builtin_crypto_vpmsumb (vector unsigned char,
17884                                                vector unsigned char);
17886 vector unsigned short __builtin_crypto_vpmsumb (vector unsigned short,
17887                                                 vector unsigned short);
17889 vector unsigned int __builtin_crypto_vpmsumb (vector unsigned int,
17890                                               vector unsigned int);
17892 vector unsigned long long __builtin_crypto_vpmsumb (vector unsigned long long,
17893                                                     vector unsigned long long);
17895 vector unsigned long long __builtin_crypto_vshasigmad
17896                                (vector unsigned long long, int, int);
17898 vector unsigned int __builtin_crypto_vshasigmaw (vector unsigned int,
17899                                                  int, int);
17900 @end smallexample
17902 The second argument to the @var{__builtin_crypto_vshasigmad} and
17903 @var{__builtin_crypto_vshasigmaw} builtin functions must be a constant
17904 integer that is 0 or 1.  The third argument to these builtin functions
17905 must be a constant integer in the range of 0 to 15.
17907 If the ISA 3.0 instruction set additions 
17908 are enabled (@option{-mcpu=power9}), the following additional
17909 functions are available for both 32-bit and 64-bit targets.
17911 vector short vec_xl (int, vector short *);
17912 vector short vec_xl (int, short *);
17913 vector unsigned short vec_xl (int, vector unsigned short *);
17914 vector unsigned short vec_xl (int, unsigned short *);
17915 vector char vec_xl (int, vector char *);
17916 vector char vec_xl (int, char *);
17917 vector unsigned char vec_xl (int, vector unsigned char *);
17918 vector unsigned char vec_xl (int, unsigned char *);
17920 void vec_xst (vector short, int, vector short *);
17921 void vec_xst (vector short, int, short *);
17922 void vec_xst (vector unsigned short, int, vector unsigned short *);
17923 void vec_xst (vector unsigned short, int, unsigned short *);
17924 void vec_xst (vector char, int, vector char *);
17925 void vec_xst (vector char, int, char *);
17926 void vec_xst (vector unsigned char, int, vector unsigned char *);
17927 void vec_xst (vector unsigned char, int, unsigned char *);
17929 @node PowerPC Hardware Transactional Memory Built-in Functions
17930 @subsection PowerPC Hardware Transactional Memory Built-in Functions
17931 GCC provides two interfaces for accessing the Hardware Transactional
17932 Memory (HTM) instructions available on some of the PowerPC family
17933 of processors (eg, POWER8).  The two interfaces come in a low level
17934 interface, consisting of built-in functions specific to PowerPC and a
17935 higher level interface consisting of inline functions that are common
17936 between PowerPC and S/390.
17938 @subsubsection PowerPC HTM Low Level Built-in Functions
17940 The following low level built-in functions are available with
17941 @option{-mhtm} or @option{-mcpu=CPU} where CPU is `power8' or later.
17942 They all generate the machine instruction that is part of the name.
17944 The HTM builtins (with the exception of @code{__builtin_tbegin}) return
17945 the full 4-bit condition register value set by their associated hardware
17946 instruction.  The header file @code{htmintrin.h} defines some macros that can
17947 be used to decipher the return value.  The @code{__builtin_tbegin} builtin
17948 returns a simple true or false value depending on whether a transaction was
17949 successfully started or not.  The arguments of the builtins match exactly the
17950 type and order of the associated hardware instruction's operands, except for
17951 the @code{__builtin_tcheck} builtin, which does not take any input arguments.
17952 Refer to the ISA manual for a description of each instruction's operands.
17954 @smallexample
17955 unsigned int __builtin_tbegin (unsigned int)
17956 unsigned int __builtin_tend (unsigned int)
17958 unsigned int __builtin_tabort (unsigned int)
17959 unsigned int __builtin_tabortdc (unsigned int, unsigned int, unsigned int)
17960 unsigned int __builtin_tabortdci (unsigned int, unsigned int, int)
17961 unsigned int __builtin_tabortwc (unsigned int, unsigned int, unsigned int)
17962 unsigned int __builtin_tabortwci (unsigned int, unsigned int, int)
17964 unsigned int __builtin_tcheck (void)
17965 unsigned int __builtin_treclaim (unsigned int)
17966 unsigned int __builtin_trechkpt (void)
17967 unsigned int __builtin_tsr (unsigned int)
17968 @end smallexample
17970 In addition to the above HTM built-ins, we have added built-ins for
17971 some common extended mnemonics of the HTM instructions:
17973 @smallexample
17974 unsigned int __builtin_tendall (void)
17975 unsigned int __builtin_tresume (void)
17976 unsigned int __builtin_tsuspend (void)
17977 @end smallexample
17979 Note that the semantics of the above HTM builtins are required to mimic
17980 the locking semantics used for critical sections.  Builtins that are used
17981 to create a new transaction or restart a suspended transaction must have
17982 lock acquisition like semantics while those builtins that end or suspend a
17983 transaction must have lock release like semantics.  Specifically, this must
17984 mimic lock semantics as specified by C++11, for example: Lock acquisition is
17985 as-if an execution of __atomic_exchange_n(&globallock,1,__ATOMIC_ACQUIRE)
17986 that returns 0, and lock release is as-if an execution of
17987 __atomic_store(&globallock,0,__ATOMIC_RELEASE), with globallock being an
17988 implicit implementation-defined lock used for all transactions.  The HTM
17989 instructions associated with with the builtins inherently provide the
17990 correct acquisition and release hardware barriers required.  However,
17991 the compiler must also be prohibited from moving loads and stores across
17992 the builtins in a way that would violate their semantics.  This has been
17993 accomplished by adding memory barriers to the associated HTM instructions
17994 (which is a conservative approach to provide acquire and release semantics).
17995 Earlier versions of the compiler did not treat the HTM instructions as
17996 memory barriers.  A @code{__TM_FENCE__} macro has been added, which can
17997 be used to determine whether the current compiler treats HTM instructions
17998 as memory barriers or not.  This allows the user to explicitly add memory
17999 barriers to their code when using an older version of the compiler.
18001 The following set of built-in functions are available to gain access
18002 to the HTM specific special purpose registers.
18004 @smallexample
18005 unsigned long __builtin_get_texasr (void)
18006 unsigned long __builtin_get_texasru (void)
18007 unsigned long __builtin_get_tfhar (void)
18008 unsigned long __builtin_get_tfiar (void)
18010 void __builtin_set_texasr (unsigned long);
18011 void __builtin_set_texasru (unsigned long);
18012 void __builtin_set_tfhar (unsigned long);
18013 void __builtin_set_tfiar (unsigned long);
18014 @end smallexample
18016 Example usage of these low level built-in functions may look like:
18018 @smallexample
18019 #include <htmintrin.h>
18021 int num_retries = 10;
18023 while (1)
18024   @{
18025     if (__builtin_tbegin (0))
18026       @{
18027         /* Transaction State Initiated.  */
18028         if (is_locked (lock))
18029           __builtin_tabort (0);
18030         ... transaction code...
18031         __builtin_tend (0);
18032         break;
18033       @}
18034     else
18035       @{
18036         /* Transaction State Failed.  Use locks if the transaction
18037            failure is "persistent" or we've tried too many times.  */
18038         if (num_retries-- <= 0
18039             || _TEXASRU_FAILURE_PERSISTENT (__builtin_get_texasru ()))
18040           @{
18041             acquire_lock (lock);
18042             ... non transactional fallback path...
18043             release_lock (lock);
18044             break;
18045           @}
18046       @}
18047   @}
18048 @end smallexample
18050 One final built-in function has been added that returns the value of
18051 the 2-bit Transaction State field of the Machine Status Register (MSR)
18052 as stored in @code{CR0}.
18054 @smallexample
18055 unsigned long __builtin_ttest (void)
18056 @end smallexample
18058 This built-in can be used to determine the current transaction state
18059 using the following code example:
18061 @smallexample
18062 #include <htmintrin.h>
18064 unsigned char tx_state = _HTM_STATE (__builtin_ttest ());
18066 if (tx_state == _HTM_TRANSACTIONAL)
18067   @{
18068     /* Code to use in transactional state.  */
18069   @}
18070 else if (tx_state == _HTM_NONTRANSACTIONAL)
18071   @{
18072     /* Code to use in non-transactional state.  */
18073   @}
18074 else if (tx_state == _HTM_SUSPENDED)
18075   @{
18076     /* Code to use in transaction suspended state.  */
18077   @}
18078 @end smallexample
18080 @subsubsection PowerPC HTM High Level Inline Functions
18082 The following high level HTM interface is made available by including
18083 @code{<htmxlintrin.h>} and using @option{-mhtm} or @option{-mcpu=CPU}
18084 where CPU is `power8' or later.  This interface is common between PowerPC
18085 and S/390, allowing users to write one HTM source implementation that
18086 can be compiled and executed on either system.
18088 @smallexample
18089 long __TM_simple_begin (void)
18090 long __TM_begin (void* const TM_buff)
18091 long __TM_end (void)
18092 void __TM_abort (void)
18093 void __TM_named_abort (unsigned char const code)
18094 void __TM_resume (void)
18095 void __TM_suspend (void)
18097 long __TM_is_user_abort (void* const TM_buff)
18098 long __TM_is_named_user_abort (void* const TM_buff, unsigned char *code)
18099 long __TM_is_illegal (void* const TM_buff)
18100 long __TM_is_footprint_exceeded (void* const TM_buff)
18101 long __TM_nesting_depth (void* const TM_buff)
18102 long __TM_is_nested_too_deep(void* const TM_buff)
18103 long __TM_is_conflict(void* const TM_buff)
18104 long __TM_is_failure_persistent(void* const TM_buff)
18105 long __TM_failure_address(void* const TM_buff)
18106 long long __TM_failure_code(void* const TM_buff)
18107 @end smallexample
18109 Using these common set of HTM inline functions, we can create
18110 a more portable version of the HTM example in the previous
18111 section that will work on either PowerPC or S/390:
18113 @smallexample
18114 #include <htmxlintrin.h>
18116 int num_retries = 10;
18117 TM_buff_type TM_buff;
18119 while (1)
18120   @{
18121     if (__TM_begin (TM_buff) == _HTM_TBEGIN_STARTED)
18122       @{
18123         /* Transaction State Initiated.  */
18124         if (is_locked (lock))
18125           __TM_abort ();
18126         ... transaction code...
18127         __TM_end ();
18128         break;
18129       @}
18130     else
18131       @{
18132         /* Transaction State Failed.  Use locks if the transaction
18133            failure is "persistent" or we've tried too many times.  */
18134         if (num_retries-- <= 0
18135             || __TM_is_failure_persistent (TM_buff))
18136           @{
18137             acquire_lock (lock);
18138             ... non transactional fallback path...
18139             release_lock (lock);
18140             break;
18141           @}
18142       @}
18143   @}
18144 @end smallexample
18146 @node RX Built-in Functions
18147 @subsection RX Built-in Functions
18148 GCC supports some of the RX instructions which cannot be expressed in
18149 the C programming language via the use of built-in functions.  The
18150 following functions are supported:
18152 @deftypefn {Built-in Function}  void __builtin_rx_brk (void)
18153 Generates the @code{brk} machine instruction.
18154 @end deftypefn
18156 @deftypefn {Built-in Function}  void __builtin_rx_clrpsw (int)
18157 Generates the @code{clrpsw} machine instruction to clear the specified
18158 bit in the processor status word.
18159 @end deftypefn
18161 @deftypefn {Built-in Function}  void __builtin_rx_int (int)
18162 Generates the @code{int} machine instruction to generate an interrupt
18163 with the specified value.
18164 @end deftypefn
18166 @deftypefn {Built-in Function}  void __builtin_rx_machi (int, int)
18167 Generates the @code{machi} machine instruction to add the result of
18168 multiplying the top 16 bits of the two arguments into the
18169 accumulator.
18170 @end deftypefn
18172 @deftypefn {Built-in Function}  void __builtin_rx_maclo (int, int)
18173 Generates the @code{maclo} machine instruction to add the result of
18174 multiplying the bottom 16 bits of the two arguments into the
18175 accumulator.
18176 @end deftypefn
18178 @deftypefn {Built-in Function}  void __builtin_rx_mulhi (int, int)
18179 Generates the @code{mulhi} machine instruction to place the result of
18180 multiplying the top 16 bits of the two arguments into the
18181 accumulator.
18182 @end deftypefn
18184 @deftypefn {Built-in Function}  void __builtin_rx_mullo (int, int)
18185 Generates the @code{mullo} machine instruction to place the result of
18186 multiplying the bottom 16 bits of the two arguments into the
18187 accumulator.
18188 @end deftypefn
18190 @deftypefn {Built-in Function}  int  __builtin_rx_mvfachi (void)
18191 Generates the @code{mvfachi} machine instruction to read the top
18192 32 bits of the accumulator.
18193 @end deftypefn
18195 @deftypefn {Built-in Function}  int  __builtin_rx_mvfacmi (void)
18196 Generates the @code{mvfacmi} machine instruction to read the middle
18197 32 bits of the accumulator.
18198 @end deftypefn
18200 @deftypefn {Built-in Function}  int __builtin_rx_mvfc (int)
18201 Generates the @code{mvfc} machine instruction which reads the control
18202 register specified in its argument and returns its value.
18203 @end deftypefn
18205 @deftypefn {Built-in Function}  void __builtin_rx_mvtachi (int)
18206 Generates the @code{mvtachi} machine instruction to set the top
18207 32 bits of the accumulator.
18208 @end deftypefn
18210 @deftypefn {Built-in Function}  void __builtin_rx_mvtaclo (int)
18211 Generates the @code{mvtaclo} machine instruction to set the bottom
18212 32 bits of the accumulator.
18213 @end deftypefn
18215 @deftypefn {Built-in Function}  void __builtin_rx_mvtc (int reg, int val)
18216 Generates the @code{mvtc} machine instruction which sets control
18217 register number @code{reg} to @code{val}.
18218 @end deftypefn
18220 @deftypefn {Built-in Function}  void __builtin_rx_mvtipl (int)
18221 Generates the @code{mvtipl} machine instruction set the interrupt
18222 priority level.
18223 @end deftypefn
18225 @deftypefn {Built-in Function}  void __builtin_rx_racw (int)
18226 Generates the @code{racw} machine instruction to round the accumulator
18227 according to the specified mode.
18228 @end deftypefn
18230 @deftypefn {Built-in Function}  int __builtin_rx_revw (int)
18231 Generates the @code{revw} machine instruction which swaps the bytes in
18232 the argument so that bits 0--7 now occupy bits 8--15 and vice versa,
18233 and also bits 16--23 occupy bits 24--31 and vice versa.
18234 @end deftypefn
18236 @deftypefn {Built-in Function}  void __builtin_rx_rmpa (void)
18237 Generates the @code{rmpa} machine instruction which initiates a
18238 repeated multiply and accumulate sequence.
18239 @end deftypefn
18241 @deftypefn {Built-in Function}  void __builtin_rx_round (float)
18242 Generates the @code{round} machine instruction which returns the
18243 floating-point argument rounded according to the current rounding mode
18244 set in the floating-point status word register.
18245 @end deftypefn
18247 @deftypefn {Built-in Function}  int __builtin_rx_sat (int)
18248 Generates the @code{sat} machine instruction which returns the
18249 saturated value of the argument.
18250 @end deftypefn
18252 @deftypefn {Built-in Function}  void __builtin_rx_setpsw (int)
18253 Generates the @code{setpsw} machine instruction to set the specified
18254 bit in the processor status word.
18255 @end deftypefn
18257 @deftypefn {Built-in Function}  void __builtin_rx_wait (void)
18258 Generates the @code{wait} machine instruction.
18259 @end deftypefn
18261 @node S/390 System z Built-in Functions
18262 @subsection S/390 System z Built-in Functions
18263 @deftypefn {Built-in Function} int __builtin_tbegin (void*)
18264 Generates the @code{tbegin} machine instruction starting a
18265 non-constrained hardware transaction.  If the parameter is non-NULL the
18266 memory area is used to store the transaction diagnostic buffer and
18267 will be passed as first operand to @code{tbegin}.  This buffer can be
18268 defined using the @code{struct __htm_tdb} C struct defined in
18269 @code{htmintrin.h} and must reside on a double-word boundary.  The
18270 second tbegin operand is set to @code{0xff0c}. This enables
18271 save/restore of all GPRs and disables aborts for FPR and AR
18272 manipulations inside the transaction body.  The condition code set by
18273 the tbegin instruction is returned as integer value.  The tbegin
18274 instruction by definition overwrites the content of all FPRs.  The
18275 compiler will generate code which saves and restores the FPRs.  For
18276 soft-float code it is recommended to used the @code{*_nofloat}
18277 variant.  In order to prevent a TDB from being written it is required
18278 to pass a constant zero value as parameter.  Passing a zero value
18279 through a variable is not sufficient.  Although modifications of
18280 access registers inside the transaction will not trigger an
18281 transaction abort it is not supported to actually modify them.  Access
18282 registers do not get saved when entering a transaction. They will have
18283 undefined state when reaching the abort code.
18284 @end deftypefn
18286 Macros for the possible return codes of tbegin are defined in the
18287 @code{htmintrin.h} header file:
18289 @table @code
18290 @item _HTM_TBEGIN_STARTED
18291 @code{tbegin} has been executed as part of normal processing.  The
18292 transaction body is supposed to be executed.
18293 @item _HTM_TBEGIN_INDETERMINATE
18294 The transaction was aborted due to an indeterminate condition which
18295 might be persistent.
18296 @item _HTM_TBEGIN_TRANSIENT
18297 The transaction aborted due to a transient failure.  The transaction
18298 should be re-executed in that case.
18299 @item _HTM_TBEGIN_PERSISTENT
18300 The transaction aborted due to a persistent failure.  Re-execution
18301 under same circumstances will not be productive.
18302 @end table
18304 @defmac _HTM_FIRST_USER_ABORT_CODE
18305 The @code{_HTM_FIRST_USER_ABORT_CODE} defined in @code{htmintrin.h}
18306 specifies the first abort code which can be used for
18307 @code{__builtin_tabort}.  Values below this threshold are reserved for
18308 machine use.
18309 @end defmac
18311 @deftp {Data type} {struct __htm_tdb}
18312 The @code{struct __htm_tdb} defined in @code{htmintrin.h} describes
18313 the structure of the transaction diagnostic block as specified in the
18314 Principles of Operation manual chapter 5-91.
18315 @end deftp
18317 @deftypefn {Built-in Function} int __builtin_tbegin_nofloat (void*)
18318 Same as @code{__builtin_tbegin} but without FPR saves and restores.
18319 Using this variant in code making use of FPRs will leave the FPRs in
18320 undefined state when entering the transaction abort handler code.
18321 @end deftypefn
18323 @deftypefn {Built-in Function} int __builtin_tbegin_retry (void*, int)
18324 In addition to @code{__builtin_tbegin} a loop for transient failures
18325 is generated.  If tbegin returns a condition code of 2 the transaction
18326 will be retried as often as specified in the second argument.  The
18327 perform processor assist instruction is used to tell the CPU about the
18328 number of fails so far.
18329 @end deftypefn
18331 @deftypefn {Built-in Function} int __builtin_tbegin_retry_nofloat (void*, int)
18332 Same as @code{__builtin_tbegin_retry} but without FPR saves and
18333 restores.  Using this variant in code making use of FPRs will leave
18334 the FPRs in undefined state when entering the transaction abort
18335 handler code.
18336 @end deftypefn
18338 @deftypefn {Built-in Function} void __builtin_tbeginc (void)
18339 Generates the @code{tbeginc} machine instruction starting a constrained
18340 hardware transaction.  The second operand is set to @code{0xff08}.
18341 @end deftypefn
18343 @deftypefn {Built-in Function} int __builtin_tend (void)
18344 Generates the @code{tend} machine instruction finishing a transaction
18345 and making the changes visible to other threads.  The condition code
18346 generated by tend is returned as integer value.
18347 @end deftypefn
18349 @deftypefn {Built-in Function} void __builtin_tabort (int)
18350 Generates the @code{tabort} machine instruction with the specified
18351 abort code.  Abort codes from 0 through 255 are reserved and will
18352 result in an error message.
18353 @end deftypefn
18355 @deftypefn {Built-in Function} void __builtin_tx_assist (int)
18356 Generates the @code{ppa rX,rY,1} machine instruction.  Where the
18357 integer parameter is loaded into rX and a value of zero is loaded into
18358 rY.  The integer parameter specifies the number of times the
18359 transaction repeatedly aborted.
18360 @end deftypefn
18362 @deftypefn {Built-in Function} int __builtin_tx_nesting_depth (void)
18363 Generates the @code{etnd} machine instruction.  The current nesting
18364 depth is returned as integer value.  For a nesting depth of 0 the code
18365 is not executed as part of an transaction.
18366 @end deftypefn
18368 @deftypefn {Built-in Function} void __builtin_non_tx_store (uint64_t *, uint64_t)
18370 Generates the @code{ntstg} machine instruction.  The second argument
18371 is written to the first arguments location.  The store operation will
18372 not be rolled-back in case of an transaction abort.
18373 @end deftypefn
18375 @node SH Built-in Functions
18376 @subsection SH Built-in Functions
18377 The following built-in functions are supported on the SH1, SH2, SH3 and SH4
18378 families of processors:
18380 @deftypefn {Built-in Function} {void} __builtin_set_thread_pointer (void *@var{ptr})
18381 Sets the @samp{GBR} register to the specified value @var{ptr}.  This is usually
18382 used by system code that manages threads and execution contexts.  The compiler
18383 normally does not generate code that modifies the contents of @samp{GBR} and
18384 thus the value is preserved across function calls.  Changing the @samp{GBR}
18385 value in user code must be done with caution, since the compiler might use
18386 @samp{GBR} in order to access thread local variables.
18388 @end deftypefn
18390 @deftypefn {Built-in Function} {void *} __builtin_thread_pointer (void)
18391 Returns the value that is currently set in the @samp{GBR} register.
18392 Memory loads and stores that use the thread pointer as a base address are
18393 turned into @samp{GBR} based displacement loads and stores, if possible.
18394 For example:
18395 @smallexample
18396 struct my_tcb
18398    int a, b, c, d, e;
18401 int get_tcb_value (void)
18403   // Generate @samp{mov.l @@(8,gbr),r0} instruction
18404   return ((my_tcb*)__builtin_thread_pointer ())->c;
18407 @end smallexample
18408 @end deftypefn
18410 @deftypefn {Built-in Function} {unsigned int} __builtin_sh_get_fpscr (void)
18411 Returns the value that is currently set in the @samp{FPSCR} register.
18412 @end deftypefn
18414 @deftypefn {Built-in Function} {void} __builtin_sh_set_fpscr (unsigned int @var{val})
18415 Sets the @samp{FPSCR} register to the specified value @var{val}, while
18416 preserving the current values of the FR, SZ and PR bits.
18417 @end deftypefn
18419 @node SPARC VIS Built-in Functions
18420 @subsection SPARC VIS Built-in Functions
18422 GCC supports SIMD operations on the SPARC using both the generic vector
18423 extensions (@pxref{Vector Extensions}) as well as built-in functions for
18424 the SPARC Visual Instruction Set (VIS).  When you use the @option{-mvis}
18425 switch, the VIS extension is exposed as the following built-in functions:
18427 @smallexample
18428 typedef int v1si __attribute__ ((vector_size (4)));
18429 typedef int v2si __attribute__ ((vector_size (8)));
18430 typedef short v4hi __attribute__ ((vector_size (8)));
18431 typedef short v2hi __attribute__ ((vector_size (4)));
18432 typedef unsigned char v8qi __attribute__ ((vector_size (8)));
18433 typedef unsigned char v4qi __attribute__ ((vector_size (4)));
18435 void __builtin_vis_write_gsr (int64_t);
18436 int64_t __builtin_vis_read_gsr (void);
18438 void * __builtin_vis_alignaddr (void *, long);
18439 void * __builtin_vis_alignaddrl (void *, long);
18440 int64_t __builtin_vis_faligndatadi (int64_t, int64_t);
18441 v2si __builtin_vis_faligndatav2si (v2si, v2si);
18442 v4hi __builtin_vis_faligndatav4hi (v4si, v4si);
18443 v8qi __builtin_vis_faligndatav8qi (v8qi, v8qi);
18445 v4hi __builtin_vis_fexpand (v4qi);
18447 v4hi __builtin_vis_fmul8x16 (v4qi, v4hi);
18448 v4hi __builtin_vis_fmul8x16au (v4qi, v2hi);
18449 v4hi __builtin_vis_fmul8x16al (v4qi, v2hi);
18450 v4hi __builtin_vis_fmul8sux16 (v8qi, v4hi);
18451 v4hi __builtin_vis_fmul8ulx16 (v8qi, v4hi);
18452 v2si __builtin_vis_fmuld8sux16 (v4qi, v2hi);
18453 v2si __builtin_vis_fmuld8ulx16 (v4qi, v2hi);
18455 v4qi __builtin_vis_fpack16 (v4hi);
18456 v8qi __builtin_vis_fpack32 (v2si, v8qi);
18457 v2hi __builtin_vis_fpackfix (v2si);
18458 v8qi __builtin_vis_fpmerge (v4qi, v4qi);
18460 int64_t __builtin_vis_pdist (v8qi, v8qi, int64_t);
18462 long __builtin_vis_edge8 (void *, void *);
18463 long __builtin_vis_edge8l (void *, void *);
18464 long __builtin_vis_edge16 (void *, void *);
18465 long __builtin_vis_edge16l (void *, void *);
18466 long __builtin_vis_edge32 (void *, void *);
18467 long __builtin_vis_edge32l (void *, void *);
18469 long __builtin_vis_fcmple16 (v4hi, v4hi);
18470 long __builtin_vis_fcmple32 (v2si, v2si);
18471 long __builtin_vis_fcmpne16 (v4hi, v4hi);
18472 long __builtin_vis_fcmpne32 (v2si, v2si);
18473 long __builtin_vis_fcmpgt16 (v4hi, v4hi);
18474 long __builtin_vis_fcmpgt32 (v2si, v2si);
18475 long __builtin_vis_fcmpeq16 (v4hi, v4hi);
18476 long __builtin_vis_fcmpeq32 (v2si, v2si);
18478 v4hi __builtin_vis_fpadd16 (v4hi, v4hi);
18479 v2hi __builtin_vis_fpadd16s (v2hi, v2hi);
18480 v2si __builtin_vis_fpadd32 (v2si, v2si);
18481 v1si __builtin_vis_fpadd32s (v1si, v1si);
18482 v4hi __builtin_vis_fpsub16 (v4hi, v4hi);
18483 v2hi __builtin_vis_fpsub16s (v2hi, v2hi);
18484 v2si __builtin_vis_fpsub32 (v2si, v2si);
18485 v1si __builtin_vis_fpsub32s (v1si, v1si);
18487 long __builtin_vis_array8 (long, long);
18488 long __builtin_vis_array16 (long, long);
18489 long __builtin_vis_array32 (long, long);
18490 @end smallexample
18492 When you use the @option{-mvis2} switch, the VIS version 2.0 built-in
18493 functions also become available:
18495 @smallexample
18496 long __builtin_vis_bmask (long, long);
18497 int64_t __builtin_vis_bshuffledi (int64_t, int64_t);
18498 v2si __builtin_vis_bshufflev2si (v2si, v2si);
18499 v4hi __builtin_vis_bshufflev2si (v4hi, v4hi);
18500 v8qi __builtin_vis_bshufflev2si (v8qi, v8qi);
18502 long __builtin_vis_edge8n (void *, void *);
18503 long __builtin_vis_edge8ln (void *, void *);
18504 long __builtin_vis_edge16n (void *, void *);
18505 long __builtin_vis_edge16ln (void *, void *);
18506 long __builtin_vis_edge32n (void *, void *);
18507 long __builtin_vis_edge32ln (void *, void *);
18508 @end smallexample
18510 When you use the @option{-mvis3} switch, the VIS version 3.0 built-in
18511 functions also become available:
18513 @smallexample
18514 void __builtin_vis_cmask8 (long);
18515 void __builtin_vis_cmask16 (long);
18516 void __builtin_vis_cmask32 (long);
18518 v4hi __builtin_vis_fchksm16 (v4hi, v4hi);
18520 v4hi __builtin_vis_fsll16 (v4hi, v4hi);
18521 v4hi __builtin_vis_fslas16 (v4hi, v4hi);
18522 v4hi __builtin_vis_fsrl16 (v4hi, v4hi);
18523 v4hi __builtin_vis_fsra16 (v4hi, v4hi);
18524 v2si __builtin_vis_fsll16 (v2si, v2si);
18525 v2si __builtin_vis_fslas16 (v2si, v2si);
18526 v2si __builtin_vis_fsrl16 (v2si, v2si);
18527 v2si __builtin_vis_fsra16 (v2si, v2si);
18529 long __builtin_vis_pdistn (v8qi, v8qi);
18531 v4hi __builtin_vis_fmean16 (v4hi, v4hi);
18533 int64_t __builtin_vis_fpadd64 (int64_t, int64_t);
18534 int64_t __builtin_vis_fpsub64 (int64_t, int64_t);
18536 v4hi __builtin_vis_fpadds16 (v4hi, v4hi);
18537 v2hi __builtin_vis_fpadds16s (v2hi, v2hi);
18538 v4hi __builtin_vis_fpsubs16 (v4hi, v4hi);
18539 v2hi __builtin_vis_fpsubs16s (v2hi, v2hi);
18540 v2si __builtin_vis_fpadds32 (v2si, v2si);
18541 v1si __builtin_vis_fpadds32s (v1si, v1si);
18542 v2si __builtin_vis_fpsubs32 (v2si, v2si);
18543 v1si __builtin_vis_fpsubs32s (v1si, v1si);
18545 long __builtin_vis_fucmple8 (v8qi, v8qi);
18546 long __builtin_vis_fucmpne8 (v8qi, v8qi);
18547 long __builtin_vis_fucmpgt8 (v8qi, v8qi);
18548 long __builtin_vis_fucmpeq8 (v8qi, v8qi);
18550 float __builtin_vis_fhadds (float, float);
18551 double __builtin_vis_fhaddd (double, double);
18552 float __builtin_vis_fhsubs (float, float);
18553 double __builtin_vis_fhsubd (double, double);
18554 float __builtin_vis_fnhadds (float, float);
18555 double __builtin_vis_fnhaddd (double, double);
18557 int64_t __builtin_vis_umulxhi (int64_t, int64_t);
18558 int64_t __builtin_vis_xmulx (int64_t, int64_t);
18559 int64_t __builtin_vis_xmulxhi (int64_t, int64_t);
18560 @end smallexample
18562 When you use the @option{-mvis4} switch, the VIS version 4.0 built-in
18563 functions also become available:
18565 @smallexample
18566 v8qi __builtin_vis_fpadd8 (v8qi, v8qi);
18567 v8qi __builtin_vis_fpadds8 (v8qi, v8qi);
18568 v8qi __builtin_vis_fpaddus8 (v8qi, v8qi);
18569 v4hi __builtin_vis_fpaddus16 (v4hi, v4hi);
18571 v8qi __builtin_vis_fpsub8 (v8qi, v8qi);
18572 v8qi __builtin_vis_fpsubs8 (v8qi, v8qi);
18573 v8qi __builtin_vis_fpsubus8 (v8qi, v8qi);
18574 v4hi __builtin_vis_fpsubus16 (v4hi, v4hi);
18576 long __builtin_vis_fpcmple8 (v8qi, v8qi);
18577 long __builtin_vis_fpcmpgt8 (v8qi, v8qi);
18578 long __builtin_vis_fpcmpule16 (v4hi, v4hi);
18579 long __builtin_vis_fpcmpugt16 (v4hi, v4hi);
18580 long __builtin_vis_fpcmpule32 (v2si, v2si);
18581 long __builtin_vis_fpcmpugt32 (v2si, v2si);
18583 v8qi __builtin_vis_fpmax8 (v8qi, v8qi);
18584 v4hi __builtin_vis_fpmax16 (v4hi, v4hi);
18585 v2si __builtin_vis_fpmax32 (v2si, v2si);
18587 v8qi __builtin_vis_fpmaxu8 (v8qi, v8qi);
18588 v4hi __builtin_vis_fpmaxu16 (v4hi, v4hi);
18589 v2si __builtin_vis_fpmaxu32 (v2si, v2si);
18592 v8qi __builtin_vis_fpmin8 (v8qi, v8qi);
18593 v4hi __builtin_vis_fpmin16 (v4hi, v4hi);
18594 v2si __builtin_vis_fpmin32 (v2si, v2si);
18596 v8qi __builtin_vis_fpminu8 (v8qi, v8qi);
18597 v4hi __builtin_vis_fpminu16 (v4hi, v4hi);
18598 v2si __builtin_vis_fpminu32 (v2si, v2si);
18599 @end smallexample
18601 @node SPU Built-in Functions
18602 @subsection SPU Built-in Functions
18604 GCC provides extensions for the SPU processor as described in the
18605 Sony/Toshiba/IBM SPU Language Extensions Specification.  GCC's
18606 implementation differs in several ways.
18608 @itemize @bullet
18610 @item
18611 The optional extension of specifying vector constants in parentheses is
18612 not supported.
18614 @item
18615 A vector initializer requires no cast if the vector constant is of the
18616 same type as the variable it is initializing.
18618 @item
18619 If @code{signed} or @code{unsigned} is omitted, the signedness of the
18620 vector type is the default signedness of the base type.  The default
18621 varies depending on the operating system, so a portable program should
18622 always specify the signedness.
18624 @item
18625 By default, the keyword @code{__vector} is added. The macro
18626 @code{vector} is defined in @code{<spu_intrinsics.h>} and can be
18627 undefined.
18629 @item
18630 GCC allows using a @code{typedef} name as the type specifier for a
18631 vector type.
18633 @item
18634 For C, overloaded functions are implemented with macros so the following
18635 does not work:
18637 @smallexample
18638   spu_add ((vector signed int)@{1, 2, 3, 4@}, foo);
18639 @end smallexample
18641 @noindent
18642 Since @code{spu_add} is a macro, the vector constant in the example
18643 is treated as four separate arguments.  Wrap the entire argument in
18644 parentheses for this to work.
18646 @item
18647 The extended version of @code{__builtin_expect} is not supported.
18649 @end itemize
18651 @emph{Note:} Only the interface described in the aforementioned
18652 specification is supported. Internally, GCC uses built-in functions to
18653 implement the required functionality, but these are not supported and
18654 are subject to change without notice.
18656 @node TI C6X Built-in Functions
18657 @subsection TI C6X Built-in Functions
18659 GCC provides intrinsics to access certain instructions of the TI C6X
18660 processors.  These intrinsics, listed below, are available after
18661 inclusion of the @code{c6x_intrinsics.h} header file.  They map directly
18662 to C6X instructions.
18664 @smallexample
18666 int _sadd (int, int)
18667 int _ssub (int, int)
18668 int _sadd2 (int, int)
18669 int _ssub2 (int, int)
18670 long long _mpy2 (int, int)
18671 long long _smpy2 (int, int)
18672 int _add4 (int, int)
18673 int _sub4 (int, int)
18674 int _saddu4 (int, int)
18676 int _smpy (int, int)
18677 int _smpyh (int, int)
18678 int _smpyhl (int, int)
18679 int _smpylh (int, int)
18681 int _sshl (int, int)
18682 int _subc (int, int)
18684 int _avg2 (int, int)
18685 int _avgu4 (int, int)
18687 int _clrr (int, int)
18688 int _extr (int, int)
18689 int _extru (int, int)
18690 int _abs (int)
18691 int _abs2 (int)
18693 @end smallexample
18695 @node TILE-Gx Built-in Functions
18696 @subsection TILE-Gx Built-in Functions
18698 GCC provides intrinsics to access every instruction of the TILE-Gx
18699 processor.  The intrinsics are of the form:
18701 @smallexample
18703 unsigned long long __insn_@var{op} (...)
18705 @end smallexample
18707 Where @var{op} is the name of the instruction.  Refer to the ISA manual
18708 for the complete list of instructions.
18710 GCC also provides intrinsics to directly access the network registers.
18711 The intrinsics are:
18713 @smallexample
18715 unsigned long long __tile_idn0_receive (void)
18716 unsigned long long __tile_idn1_receive (void)
18717 unsigned long long __tile_udn0_receive (void)
18718 unsigned long long __tile_udn1_receive (void)
18719 unsigned long long __tile_udn2_receive (void)
18720 unsigned long long __tile_udn3_receive (void)
18721 void __tile_idn_send (unsigned long long)
18722 void __tile_udn_send (unsigned long long)
18724 @end smallexample
18726 The intrinsic @code{void __tile_network_barrier (void)} is used to
18727 guarantee that no network operations before it are reordered with
18728 those after it.
18730 @node TILEPro Built-in Functions
18731 @subsection TILEPro Built-in Functions
18733 GCC provides intrinsics to access every instruction of the TILEPro
18734 processor.  The intrinsics are of the form:
18736 @smallexample
18738 unsigned __insn_@var{op} (...)
18740 @end smallexample
18742 @noindent
18743 where @var{op} is the name of the instruction.  Refer to the ISA manual
18744 for the complete list of instructions.
18746 GCC also provides intrinsics to directly access the network registers.
18747 The intrinsics are:
18749 @smallexample
18751 unsigned __tile_idn0_receive (void)
18752 unsigned __tile_idn1_receive (void)
18753 unsigned __tile_sn_receive (void)
18754 unsigned __tile_udn0_receive (void)
18755 unsigned __tile_udn1_receive (void)
18756 unsigned __tile_udn2_receive (void)
18757 unsigned __tile_udn3_receive (void)
18758 void __tile_idn_send (unsigned)
18759 void __tile_sn_send (unsigned)
18760 void __tile_udn_send (unsigned)
18762 @end smallexample
18764 The intrinsic @code{void __tile_network_barrier (void)} is used to
18765 guarantee that no network operations before it are reordered with
18766 those after it.
18768 @node x86 Built-in Functions
18769 @subsection x86 Built-in Functions
18771 These built-in functions are available for the x86-32 and x86-64 family
18772 of computers, depending on the command-line switches used.
18774 If you specify command-line switches such as @option{-msse},
18775 the compiler could use the extended instruction sets even if the built-ins
18776 are not used explicitly in the program.  For this reason, applications
18777 that perform run-time CPU detection must compile separate files for each
18778 supported architecture, using the appropriate flags.  In particular,
18779 the file containing the CPU detection code should be compiled without
18780 these options.
18782 The following machine modes are available for use with MMX built-in functions
18783 (@pxref{Vector Extensions}): @code{V2SI} for a vector of two 32-bit integers,
18784 @code{V4HI} for a vector of four 16-bit integers, and @code{V8QI} for a
18785 vector of eight 8-bit integers.  Some of the built-in functions operate on
18786 MMX registers as a whole 64-bit entity, these use @code{V1DI} as their mode.
18788 If 3DNow!@: extensions are enabled, @code{V2SF} is used as a mode for a vector
18789 of two 32-bit floating-point values.
18791 If SSE extensions are enabled, @code{V4SF} is used for a vector of four 32-bit
18792 floating-point values.  Some instructions use a vector of four 32-bit
18793 integers, these use @code{V4SI}.  Finally, some instructions operate on an
18794 entire vector register, interpreting it as a 128-bit integer, these use mode
18795 @code{TI}.
18797 The x86-32 and x86-64 family of processors use additional built-in
18798 functions for efficient use of @code{TF} (@code{__float128}) 128-bit
18799 floating point and @code{TC} 128-bit complex floating-point values.
18801 The following floating-point built-in functions are always available.  All
18802 of them implement the function that is part of the name.
18804 @smallexample
18805 __float128 __builtin_fabsq (__float128)
18806 __float128 __builtin_copysignq (__float128, __float128)
18807 @end smallexample
18809 The following built-in functions are always available.
18811 @table @code
18812 @item __float128 __builtin_infq (void)
18813 Similar to @code{__builtin_inf}, except the return type is @code{__float128}.
18814 @findex __builtin_infq
18816 @item __float128 __builtin_huge_valq (void)
18817 Similar to @code{__builtin_huge_val}, except the return type is @code{__float128}.
18818 @findex __builtin_huge_valq
18820 @item __float128 __builtin_nanq (void)
18821 Similar to @code{__builtin_nan}, except the return type is @code{__float128}.
18822 @findex __builtin_nanq
18824 @item __float128 __builtin_nansq (void)
18825 Similar to @code{__builtin_nans}, except the return type is @code{__float128}.
18826 @findex __builtin_nansq
18827 @end table
18829 The following built-in function is always available.
18831 @table @code
18832 @item void __builtin_ia32_pause (void)
18833 Generates the @code{pause} machine instruction with a compiler memory
18834 barrier.
18835 @end table
18837 The following built-in functions are always available and can be used to
18838 check the target platform type.
18840 @deftypefn {Built-in Function} void __builtin_cpu_init (void)
18841 This function runs the CPU detection code to check the type of CPU and the
18842 features supported.  This built-in function needs to be invoked along with the built-in functions
18843 to check CPU type and features, @code{__builtin_cpu_is} and
18844 @code{__builtin_cpu_supports}, only when used in a function that is
18845 executed before any constructors are called.  The CPU detection code is
18846 automatically executed in a very high priority constructor.
18848 For example, this function has to be used in @code{ifunc} resolvers that
18849 check for CPU type using the built-in functions @code{__builtin_cpu_is}
18850 and @code{__builtin_cpu_supports}, or in constructors on targets that
18851 don't support constructor priority.
18852 @smallexample
18854 static void (*resolve_memcpy (void)) (void)
18856   // ifunc resolvers fire before constructors, explicitly call the init
18857   // function.
18858   __builtin_cpu_init ();
18859   if (__builtin_cpu_supports ("ssse3"))
18860     return ssse3_memcpy; // super fast memcpy with ssse3 instructions.
18861   else
18862     return default_memcpy;
18865 void *memcpy (void *, const void *, size_t)
18866      __attribute__ ((ifunc ("resolve_memcpy")));
18867 @end smallexample
18869 @end deftypefn
18871 @deftypefn {Built-in Function} int __builtin_cpu_is (const char *@var{cpuname})
18872 This function returns a positive integer if the run-time CPU
18873 is of type @var{cpuname}
18874 and returns @code{0} otherwise. The following CPU names can be detected:
18876 @table @samp
18877 @item intel
18878 Intel CPU.
18880 @item atom
18881 Intel Atom CPU.
18883 @item core2
18884 Intel Core 2 CPU.
18886 @item corei7
18887 Intel Core i7 CPU.
18889 @item nehalem
18890 Intel Core i7 Nehalem CPU.
18892 @item westmere
18893 Intel Core i7 Westmere CPU.
18895 @item sandybridge
18896 Intel Core i7 Sandy Bridge CPU.
18898 @item amd
18899 AMD CPU.
18901 @item amdfam10h
18902 AMD Family 10h CPU.
18904 @item barcelona
18905 AMD Family 10h Barcelona CPU.
18907 @item shanghai
18908 AMD Family 10h Shanghai CPU.
18910 @item istanbul
18911 AMD Family 10h Istanbul CPU.
18913 @item btver1
18914 AMD Family 14h CPU.
18916 @item amdfam15h
18917 AMD Family 15h CPU.
18919 @item bdver1
18920 AMD Family 15h Bulldozer version 1.
18922 @item bdver2
18923 AMD Family 15h Bulldozer version 2.
18925 @item bdver3
18926 AMD Family 15h Bulldozer version 3.
18928 @item bdver4
18929 AMD Family 15h Bulldozer version 4.
18931 @item btver2
18932 AMD Family 16h CPU.
18934 @item znver1
18935 AMD Family 17h CPU.
18936 @end table
18938 Here is an example:
18939 @smallexample
18940 if (__builtin_cpu_is ("corei7"))
18941   @{
18942      do_corei7 (); // Core i7 specific implementation.
18943   @}
18944 else
18945   @{
18946      do_generic (); // Generic implementation.
18947   @}
18948 @end smallexample
18949 @end deftypefn
18951 @deftypefn {Built-in Function} int __builtin_cpu_supports (const char *@var{feature})
18952 This function returns a positive integer if the run-time CPU
18953 supports @var{feature}
18954 and returns @code{0} otherwise. The following features can be detected:
18956 @table @samp
18957 @item cmov
18958 CMOV instruction.
18959 @item mmx
18960 MMX instructions.
18961 @item popcnt
18962 POPCNT instruction.
18963 @item sse
18964 SSE instructions.
18965 @item sse2
18966 SSE2 instructions.
18967 @item sse3
18968 SSE3 instructions.
18969 @item ssse3
18970 SSSE3 instructions.
18971 @item sse4.1
18972 SSE4.1 instructions.
18973 @item sse4.2
18974 SSE4.2 instructions.
18975 @item avx
18976 AVX instructions.
18977 @item avx2
18978 AVX2 instructions.
18979 @item avx512f
18980 AVX512F instructions.
18981 @end table
18983 Here is an example:
18984 @smallexample
18985 if (__builtin_cpu_supports ("popcnt"))
18986   @{
18987      asm("popcnt %1,%0" : "=r"(count) : "rm"(n) : "cc");
18988   @}
18989 else
18990   @{
18991      count = generic_countbits (n); //generic implementation.
18992   @}
18993 @end smallexample
18994 @end deftypefn
18997 The following built-in functions are made available by @option{-mmmx}.
18998 All of them generate the machine instruction that is part of the name.
19000 @smallexample
19001 v8qi __builtin_ia32_paddb (v8qi, v8qi)
19002 v4hi __builtin_ia32_paddw (v4hi, v4hi)
19003 v2si __builtin_ia32_paddd (v2si, v2si)
19004 v8qi __builtin_ia32_psubb (v8qi, v8qi)
19005 v4hi __builtin_ia32_psubw (v4hi, v4hi)
19006 v2si __builtin_ia32_psubd (v2si, v2si)
19007 v8qi __builtin_ia32_paddsb (v8qi, v8qi)
19008 v4hi __builtin_ia32_paddsw (v4hi, v4hi)
19009 v8qi __builtin_ia32_psubsb (v8qi, v8qi)
19010 v4hi __builtin_ia32_psubsw (v4hi, v4hi)
19011 v8qi __builtin_ia32_paddusb (v8qi, v8qi)
19012 v4hi __builtin_ia32_paddusw (v4hi, v4hi)
19013 v8qi __builtin_ia32_psubusb (v8qi, v8qi)
19014 v4hi __builtin_ia32_psubusw (v4hi, v4hi)
19015 v4hi __builtin_ia32_pmullw (v4hi, v4hi)
19016 v4hi __builtin_ia32_pmulhw (v4hi, v4hi)
19017 di __builtin_ia32_pand (di, di)
19018 di __builtin_ia32_pandn (di,di)
19019 di __builtin_ia32_por (di, di)
19020 di __builtin_ia32_pxor (di, di)
19021 v8qi __builtin_ia32_pcmpeqb (v8qi, v8qi)
19022 v4hi __builtin_ia32_pcmpeqw (v4hi, v4hi)
19023 v2si __builtin_ia32_pcmpeqd (v2si, v2si)
19024 v8qi __builtin_ia32_pcmpgtb (v8qi, v8qi)
19025 v4hi __builtin_ia32_pcmpgtw (v4hi, v4hi)
19026 v2si __builtin_ia32_pcmpgtd (v2si, v2si)
19027 v8qi __builtin_ia32_punpckhbw (v8qi, v8qi)
19028 v4hi __builtin_ia32_punpckhwd (v4hi, v4hi)
19029 v2si __builtin_ia32_punpckhdq (v2si, v2si)
19030 v8qi __builtin_ia32_punpcklbw (v8qi, v8qi)
19031 v4hi __builtin_ia32_punpcklwd (v4hi, v4hi)
19032 v2si __builtin_ia32_punpckldq (v2si, v2si)
19033 v8qi __builtin_ia32_packsswb (v4hi, v4hi)
19034 v4hi __builtin_ia32_packssdw (v2si, v2si)
19035 v8qi __builtin_ia32_packuswb (v4hi, v4hi)
19037 v4hi __builtin_ia32_psllw (v4hi, v4hi)
19038 v2si __builtin_ia32_pslld (v2si, v2si)
19039 v1di __builtin_ia32_psllq (v1di, v1di)
19040 v4hi __builtin_ia32_psrlw (v4hi, v4hi)
19041 v2si __builtin_ia32_psrld (v2si, v2si)
19042 v1di __builtin_ia32_psrlq (v1di, v1di)
19043 v4hi __builtin_ia32_psraw (v4hi, v4hi)
19044 v2si __builtin_ia32_psrad (v2si, v2si)
19045 v4hi __builtin_ia32_psllwi (v4hi, int)
19046 v2si __builtin_ia32_pslldi (v2si, int)
19047 v1di __builtin_ia32_psllqi (v1di, int)
19048 v4hi __builtin_ia32_psrlwi (v4hi, int)
19049 v2si __builtin_ia32_psrldi (v2si, int)
19050 v1di __builtin_ia32_psrlqi (v1di, int)
19051 v4hi __builtin_ia32_psrawi (v4hi, int)
19052 v2si __builtin_ia32_psradi (v2si, int)
19054 @end smallexample
19056 The following built-in functions are made available either with
19057 @option{-msse}, or with a combination of @option{-m3dnow} and
19058 @option{-march=athlon}.  All of them generate the machine
19059 instruction that is part of the name.
19061 @smallexample
19062 v4hi __builtin_ia32_pmulhuw (v4hi, v4hi)
19063 v8qi __builtin_ia32_pavgb (v8qi, v8qi)
19064 v4hi __builtin_ia32_pavgw (v4hi, v4hi)
19065 v1di __builtin_ia32_psadbw (v8qi, v8qi)
19066 v8qi __builtin_ia32_pmaxub (v8qi, v8qi)
19067 v4hi __builtin_ia32_pmaxsw (v4hi, v4hi)
19068 v8qi __builtin_ia32_pminub (v8qi, v8qi)
19069 v4hi __builtin_ia32_pminsw (v4hi, v4hi)
19070 int __builtin_ia32_pmovmskb (v8qi)
19071 void __builtin_ia32_maskmovq (v8qi, v8qi, char *)
19072 void __builtin_ia32_movntq (di *, di)
19073 void __builtin_ia32_sfence (void)
19074 @end smallexample
19076 The following built-in functions are available when @option{-msse} is used.
19077 All of them generate the machine instruction that is part of the name.
19079 @smallexample
19080 int __builtin_ia32_comieq (v4sf, v4sf)
19081 int __builtin_ia32_comineq (v4sf, v4sf)
19082 int __builtin_ia32_comilt (v4sf, v4sf)
19083 int __builtin_ia32_comile (v4sf, v4sf)
19084 int __builtin_ia32_comigt (v4sf, v4sf)
19085 int __builtin_ia32_comige (v4sf, v4sf)
19086 int __builtin_ia32_ucomieq (v4sf, v4sf)
19087 int __builtin_ia32_ucomineq (v4sf, v4sf)
19088 int __builtin_ia32_ucomilt (v4sf, v4sf)
19089 int __builtin_ia32_ucomile (v4sf, v4sf)
19090 int __builtin_ia32_ucomigt (v4sf, v4sf)
19091 int __builtin_ia32_ucomige (v4sf, v4sf)
19092 v4sf __builtin_ia32_addps (v4sf, v4sf)
19093 v4sf __builtin_ia32_subps (v4sf, v4sf)
19094 v4sf __builtin_ia32_mulps (v4sf, v4sf)
19095 v4sf __builtin_ia32_divps (v4sf, v4sf)
19096 v4sf __builtin_ia32_addss (v4sf, v4sf)
19097 v4sf __builtin_ia32_subss (v4sf, v4sf)
19098 v4sf __builtin_ia32_mulss (v4sf, v4sf)
19099 v4sf __builtin_ia32_divss (v4sf, v4sf)
19100 v4sf __builtin_ia32_cmpeqps (v4sf, v4sf)
19101 v4sf __builtin_ia32_cmpltps (v4sf, v4sf)
19102 v4sf __builtin_ia32_cmpleps (v4sf, v4sf)
19103 v4sf __builtin_ia32_cmpgtps (v4sf, v4sf)
19104 v4sf __builtin_ia32_cmpgeps (v4sf, v4sf)
19105 v4sf __builtin_ia32_cmpunordps (v4sf, v4sf)
19106 v4sf __builtin_ia32_cmpneqps (v4sf, v4sf)
19107 v4sf __builtin_ia32_cmpnltps (v4sf, v4sf)
19108 v4sf __builtin_ia32_cmpnleps (v4sf, v4sf)
19109 v4sf __builtin_ia32_cmpngtps (v4sf, v4sf)
19110 v4sf __builtin_ia32_cmpngeps (v4sf, v4sf)
19111 v4sf __builtin_ia32_cmpordps (v4sf, v4sf)
19112 v4sf __builtin_ia32_cmpeqss (v4sf, v4sf)
19113 v4sf __builtin_ia32_cmpltss (v4sf, v4sf)
19114 v4sf __builtin_ia32_cmpless (v4sf, v4sf)
19115 v4sf __builtin_ia32_cmpunordss (v4sf, v4sf)
19116 v4sf __builtin_ia32_cmpneqss (v4sf, v4sf)
19117 v4sf __builtin_ia32_cmpnltss (v4sf, v4sf)
19118 v4sf __builtin_ia32_cmpnless (v4sf, v4sf)
19119 v4sf __builtin_ia32_cmpordss (v4sf, v4sf)
19120 v4sf __builtin_ia32_maxps (v4sf, v4sf)
19121 v4sf __builtin_ia32_maxss (v4sf, v4sf)
19122 v4sf __builtin_ia32_minps (v4sf, v4sf)
19123 v4sf __builtin_ia32_minss (v4sf, v4sf)
19124 v4sf __builtin_ia32_andps (v4sf, v4sf)
19125 v4sf __builtin_ia32_andnps (v4sf, v4sf)
19126 v4sf __builtin_ia32_orps (v4sf, v4sf)
19127 v4sf __builtin_ia32_xorps (v4sf, v4sf)
19128 v4sf __builtin_ia32_movss (v4sf, v4sf)
19129 v4sf __builtin_ia32_movhlps (v4sf, v4sf)
19130 v4sf __builtin_ia32_movlhps (v4sf, v4sf)
19131 v4sf __builtin_ia32_unpckhps (v4sf, v4sf)
19132 v4sf __builtin_ia32_unpcklps (v4sf, v4sf)
19133 v4sf __builtin_ia32_cvtpi2ps (v4sf, v2si)
19134 v4sf __builtin_ia32_cvtsi2ss (v4sf, int)
19135 v2si __builtin_ia32_cvtps2pi (v4sf)
19136 int __builtin_ia32_cvtss2si (v4sf)
19137 v2si __builtin_ia32_cvttps2pi (v4sf)
19138 int __builtin_ia32_cvttss2si (v4sf)
19139 v4sf __builtin_ia32_rcpps (v4sf)
19140 v4sf __builtin_ia32_rsqrtps (v4sf)
19141 v4sf __builtin_ia32_sqrtps (v4sf)
19142 v4sf __builtin_ia32_rcpss (v4sf)
19143 v4sf __builtin_ia32_rsqrtss (v4sf)
19144 v4sf __builtin_ia32_sqrtss (v4sf)
19145 v4sf __builtin_ia32_shufps (v4sf, v4sf, int)
19146 void __builtin_ia32_movntps (float *, v4sf)
19147 int __builtin_ia32_movmskps (v4sf)
19148 @end smallexample
19150 The following built-in functions are available when @option{-msse} is used.
19152 @table @code
19153 @item v4sf __builtin_ia32_loadups (float *)
19154 Generates the @code{movups} machine instruction as a load from memory.
19155 @item void __builtin_ia32_storeups (float *, v4sf)
19156 Generates the @code{movups} machine instruction as a store to memory.
19157 @item v4sf __builtin_ia32_loadss (float *)
19158 Generates the @code{movss} machine instruction as a load from memory.
19159 @item v4sf __builtin_ia32_loadhps (v4sf, const v2sf *)
19160 Generates the @code{movhps} machine instruction as a load from memory.
19161 @item v4sf __builtin_ia32_loadlps (v4sf, const v2sf *)
19162 Generates the @code{movlps} machine instruction as a load from memory
19163 @item void __builtin_ia32_storehps (v2sf *, v4sf)
19164 Generates the @code{movhps} machine instruction as a store to memory.
19165 @item void __builtin_ia32_storelps (v2sf *, v4sf)
19166 Generates the @code{movlps} machine instruction as a store to memory.
19167 @end table
19169 The following built-in functions are available when @option{-msse2} is used.
19170 All of them generate the machine instruction that is part of the name.
19172 @smallexample
19173 int __builtin_ia32_comisdeq (v2df, v2df)
19174 int __builtin_ia32_comisdlt (v2df, v2df)
19175 int __builtin_ia32_comisdle (v2df, v2df)
19176 int __builtin_ia32_comisdgt (v2df, v2df)
19177 int __builtin_ia32_comisdge (v2df, v2df)
19178 int __builtin_ia32_comisdneq (v2df, v2df)
19179 int __builtin_ia32_ucomisdeq (v2df, v2df)
19180 int __builtin_ia32_ucomisdlt (v2df, v2df)
19181 int __builtin_ia32_ucomisdle (v2df, v2df)
19182 int __builtin_ia32_ucomisdgt (v2df, v2df)
19183 int __builtin_ia32_ucomisdge (v2df, v2df)
19184 int __builtin_ia32_ucomisdneq (v2df, v2df)
19185 v2df __builtin_ia32_cmpeqpd (v2df, v2df)
19186 v2df __builtin_ia32_cmpltpd (v2df, v2df)
19187 v2df __builtin_ia32_cmplepd (v2df, v2df)
19188 v2df __builtin_ia32_cmpgtpd (v2df, v2df)
19189 v2df __builtin_ia32_cmpgepd (v2df, v2df)
19190 v2df __builtin_ia32_cmpunordpd (v2df, v2df)
19191 v2df __builtin_ia32_cmpneqpd (v2df, v2df)
19192 v2df __builtin_ia32_cmpnltpd (v2df, v2df)
19193 v2df __builtin_ia32_cmpnlepd (v2df, v2df)
19194 v2df __builtin_ia32_cmpngtpd (v2df, v2df)
19195 v2df __builtin_ia32_cmpngepd (v2df, v2df)
19196 v2df __builtin_ia32_cmpordpd (v2df, v2df)
19197 v2df __builtin_ia32_cmpeqsd (v2df, v2df)
19198 v2df __builtin_ia32_cmpltsd (v2df, v2df)
19199 v2df __builtin_ia32_cmplesd (v2df, v2df)
19200 v2df __builtin_ia32_cmpunordsd (v2df, v2df)
19201 v2df __builtin_ia32_cmpneqsd (v2df, v2df)
19202 v2df __builtin_ia32_cmpnltsd (v2df, v2df)
19203 v2df __builtin_ia32_cmpnlesd (v2df, v2df)
19204 v2df __builtin_ia32_cmpordsd (v2df, v2df)
19205 v2di __builtin_ia32_paddq (v2di, v2di)
19206 v2di __builtin_ia32_psubq (v2di, v2di)
19207 v2df __builtin_ia32_addpd (v2df, v2df)
19208 v2df __builtin_ia32_subpd (v2df, v2df)
19209 v2df __builtin_ia32_mulpd (v2df, v2df)
19210 v2df __builtin_ia32_divpd (v2df, v2df)
19211 v2df __builtin_ia32_addsd (v2df, v2df)
19212 v2df __builtin_ia32_subsd (v2df, v2df)
19213 v2df __builtin_ia32_mulsd (v2df, v2df)
19214 v2df __builtin_ia32_divsd (v2df, v2df)
19215 v2df __builtin_ia32_minpd (v2df, v2df)
19216 v2df __builtin_ia32_maxpd (v2df, v2df)
19217 v2df __builtin_ia32_minsd (v2df, v2df)
19218 v2df __builtin_ia32_maxsd (v2df, v2df)
19219 v2df __builtin_ia32_andpd (v2df, v2df)
19220 v2df __builtin_ia32_andnpd (v2df, v2df)
19221 v2df __builtin_ia32_orpd (v2df, v2df)
19222 v2df __builtin_ia32_xorpd (v2df, v2df)
19223 v2df __builtin_ia32_movsd (v2df, v2df)
19224 v2df __builtin_ia32_unpckhpd (v2df, v2df)
19225 v2df __builtin_ia32_unpcklpd (v2df, v2df)
19226 v16qi __builtin_ia32_paddb128 (v16qi, v16qi)
19227 v8hi __builtin_ia32_paddw128 (v8hi, v8hi)
19228 v4si __builtin_ia32_paddd128 (v4si, v4si)
19229 v2di __builtin_ia32_paddq128 (v2di, v2di)
19230 v16qi __builtin_ia32_psubb128 (v16qi, v16qi)
19231 v8hi __builtin_ia32_psubw128 (v8hi, v8hi)
19232 v4si __builtin_ia32_psubd128 (v4si, v4si)
19233 v2di __builtin_ia32_psubq128 (v2di, v2di)
19234 v8hi __builtin_ia32_pmullw128 (v8hi, v8hi)
19235 v8hi __builtin_ia32_pmulhw128 (v8hi, v8hi)
19236 v2di __builtin_ia32_pand128 (v2di, v2di)
19237 v2di __builtin_ia32_pandn128 (v2di, v2di)
19238 v2di __builtin_ia32_por128 (v2di, v2di)
19239 v2di __builtin_ia32_pxor128 (v2di, v2di)
19240 v16qi __builtin_ia32_pavgb128 (v16qi, v16qi)
19241 v8hi __builtin_ia32_pavgw128 (v8hi, v8hi)
19242 v16qi __builtin_ia32_pcmpeqb128 (v16qi, v16qi)
19243 v8hi __builtin_ia32_pcmpeqw128 (v8hi, v8hi)
19244 v4si __builtin_ia32_pcmpeqd128 (v4si, v4si)
19245 v16qi __builtin_ia32_pcmpgtb128 (v16qi, v16qi)
19246 v8hi __builtin_ia32_pcmpgtw128 (v8hi, v8hi)
19247 v4si __builtin_ia32_pcmpgtd128 (v4si, v4si)
19248 v16qi __builtin_ia32_pmaxub128 (v16qi, v16qi)
19249 v8hi __builtin_ia32_pmaxsw128 (v8hi, v8hi)
19250 v16qi __builtin_ia32_pminub128 (v16qi, v16qi)
19251 v8hi __builtin_ia32_pminsw128 (v8hi, v8hi)
19252 v16qi __builtin_ia32_punpckhbw128 (v16qi, v16qi)
19253 v8hi __builtin_ia32_punpckhwd128 (v8hi, v8hi)
19254 v4si __builtin_ia32_punpckhdq128 (v4si, v4si)
19255 v2di __builtin_ia32_punpckhqdq128 (v2di, v2di)
19256 v16qi __builtin_ia32_punpcklbw128 (v16qi, v16qi)
19257 v8hi __builtin_ia32_punpcklwd128 (v8hi, v8hi)
19258 v4si __builtin_ia32_punpckldq128 (v4si, v4si)
19259 v2di __builtin_ia32_punpcklqdq128 (v2di, v2di)
19260 v16qi __builtin_ia32_packsswb128 (v8hi, v8hi)
19261 v8hi __builtin_ia32_packssdw128 (v4si, v4si)
19262 v16qi __builtin_ia32_packuswb128 (v8hi, v8hi)
19263 v8hi __builtin_ia32_pmulhuw128 (v8hi, v8hi)
19264 void __builtin_ia32_maskmovdqu (v16qi, v16qi)
19265 v2df __builtin_ia32_loadupd (double *)
19266 void __builtin_ia32_storeupd (double *, v2df)
19267 v2df __builtin_ia32_loadhpd (v2df, double const *)
19268 v2df __builtin_ia32_loadlpd (v2df, double const *)
19269 int __builtin_ia32_movmskpd (v2df)
19270 int __builtin_ia32_pmovmskb128 (v16qi)
19271 void __builtin_ia32_movnti (int *, int)
19272 void __builtin_ia32_movnti64 (long long int *, long long int)
19273 void __builtin_ia32_movntpd (double *, v2df)
19274 void __builtin_ia32_movntdq (v2df *, v2df)
19275 v4si __builtin_ia32_pshufd (v4si, int)
19276 v8hi __builtin_ia32_pshuflw (v8hi, int)
19277 v8hi __builtin_ia32_pshufhw (v8hi, int)
19278 v2di __builtin_ia32_psadbw128 (v16qi, v16qi)
19279 v2df __builtin_ia32_sqrtpd (v2df)
19280 v2df __builtin_ia32_sqrtsd (v2df)
19281 v2df __builtin_ia32_shufpd (v2df, v2df, int)
19282 v2df __builtin_ia32_cvtdq2pd (v4si)
19283 v4sf __builtin_ia32_cvtdq2ps (v4si)
19284 v4si __builtin_ia32_cvtpd2dq (v2df)
19285 v2si __builtin_ia32_cvtpd2pi (v2df)
19286 v4sf __builtin_ia32_cvtpd2ps (v2df)
19287 v4si __builtin_ia32_cvttpd2dq (v2df)
19288 v2si __builtin_ia32_cvttpd2pi (v2df)
19289 v2df __builtin_ia32_cvtpi2pd (v2si)
19290 int __builtin_ia32_cvtsd2si (v2df)
19291 int __builtin_ia32_cvttsd2si (v2df)
19292 long long __builtin_ia32_cvtsd2si64 (v2df)
19293 long long __builtin_ia32_cvttsd2si64 (v2df)
19294 v4si __builtin_ia32_cvtps2dq (v4sf)
19295 v2df __builtin_ia32_cvtps2pd (v4sf)
19296 v4si __builtin_ia32_cvttps2dq (v4sf)
19297 v2df __builtin_ia32_cvtsi2sd (v2df, int)
19298 v2df __builtin_ia32_cvtsi642sd (v2df, long long)
19299 v4sf __builtin_ia32_cvtsd2ss (v4sf, v2df)
19300 v2df __builtin_ia32_cvtss2sd (v2df, v4sf)
19301 void __builtin_ia32_clflush (const void *)
19302 void __builtin_ia32_lfence (void)
19303 void __builtin_ia32_mfence (void)
19304 v16qi __builtin_ia32_loaddqu (const char *)
19305 void __builtin_ia32_storedqu (char *, v16qi)
19306 v1di __builtin_ia32_pmuludq (v2si, v2si)
19307 v2di __builtin_ia32_pmuludq128 (v4si, v4si)
19308 v8hi __builtin_ia32_psllw128 (v8hi, v8hi)
19309 v4si __builtin_ia32_pslld128 (v4si, v4si)
19310 v2di __builtin_ia32_psllq128 (v2di, v2di)
19311 v8hi __builtin_ia32_psrlw128 (v8hi, v8hi)
19312 v4si __builtin_ia32_psrld128 (v4si, v4si)
19313 v2di __builtin_ia32_psrlq128 (v2di, v2di)
19314 v8hi __builtin_ia32_psraw128 (v8hi, v8hi)
19315 v4si __builtin_ia32_psrad128 (v4si, v4si)
19316 v2di __builtin_ia32_pslldqi128 (v2di, int)
19317 v8hi __builtin_ia32_psllwi128 (v8hi, int)
19318 v4si __builtin_ia32_pslldi128 (v4si, int)
19319 v2di __builtin_ia32_psllqi128 (v2di, int)
19320 v2di __builtin_ia32_psrldqi128 (v2di, int)
19321 v8hi __builtin_ia32_psrlwi128 (v8hi, int)
19322 v4si __builtin_ia32_psrldi128 (v4si, int)
19323 v2di __builtin_ia32_psrlqi128 (v2di, int)
19324 v8hi __builtin_ia32_psrawi128 (v8hi, int)
19325 v4si __builtin_ia32_psradi128 (v4si, int)
19326 v4si __builtin_ia32_pmaddwd128 (v8hi, v8hi)
19327 v2di __builtin_ia32_movq128 (v2di)
19328 @end smallexample
19330 The following built-in functions are available when @option{-msse3} is used.
19331 All of them generate the machine instruction that is part of the name.
19333 @smallexample
19334 v2df __builtin_ia32_addsubpd (v2df, v2df)
19335 v4sf __builtin_ia32_addsubps (v4sf, v4sf)
19336 v2df __builtin_ia32_haddpd (v2df, v2df)
19337 v4sf __builtin_ia32_haddps (v4sf, v4sf)
19338 v2df __builtin_ia32_hsubpd (v2df, v2df)
19339 v4sf __builtin_ia32_hsubps (v4sf, v4sf)
19340 v16qi __builtin_ia32_lddqu (char const *)
19341 void __builtin_ia32_monitor (void *, unsigned int, unsigned int)
19342 v4sf __builtin_ia32_movshdup (v4sf)
19343 v4sf __builtin_ia32_movsldup (v4sf)
19344 void __builtin_ia32_mwait (unsigned int, unsigned int)
19345 @end smallexample
19347 The following built-in functions are available when @option{-mssse3} is used.
19348 All of them generate the machine instruction that is part of the name.
19350 @smallexample
19351 v2si __builtin_ia32_phaddd (v2si, v2si)
19352 v4hi __builtin_ia32_phaddw (v4hi, v4hi)
19353 v4hi __builtin_ia32_phaddsw (v4hi, v4hi)
19354 v2si __builtin_ia32_phsubd (v2si, v2si)
19355 v4hi __builtin_ia32_phsubw (v4hi, v4hi)
19356 v4hi __builtin_ia32_phsubsw (v4hi, v4hi)
19357 v4hi __builtin_ia32_pmaddubsw (v8qi, v8qi)
19358 v4hi __builtin_ia32_pmulhrsw (v4hi, v4hi)
19359 v8qi __builtin_ia32_pshufb (v8qi, v8qi)
19360 v8qi __builtin_ia32_psignb (v8qi, v8qi)
19361 v2si __builtin_ia32_psignd (v2si, v2si)
19362 v4hi __builtin_ia32_psignw (v4hi, v4hi)
19363 v1di __builtin_ia32_palignr (v1di, v1di, int)
19364 v8qi __builtin_ia32_pabsb (v8qi)
19365 v2si __builtin_ia32_pabsd (v2si)
19366 v4hi __builtin_ia32_pabsw (v4hi)
19367 @end smallexample
19369 The following built-in functions are available when @option{-mssse3} is used.
19370 All of them generate the machine instruction that is part of the name.
19372 @smallexample
19373 v4si __builtin_ia32_phaddd128 (v4si, v4si)
19374 v8hi __builtin_ia32_phaddw128 (v8hi, v8hi)
19375 v8hi __builtin_ia32_phaddsw128 (v8hi, v8hi)
19376 v4si __builtin_ia32_phsubd128 (v4si, v4si)
19377 v8hi __builtin_ia32_phsubw128 (v8hi, v8hi)
19378 v8hi __builtin_ia32_phsubsw128 (v8hi, v8hi)
19379 v8hi __builtin_ia32_pmaddubsw128 (v16qi, v16qi)
19380 v8hi __builtin_ia32_pmulhrsw128 (v8hi, v8hi)
19381 v16qi __builtin_ia32_pshufb128 (v16qi, v16qi)
19382 v16qi __builtin_ia32_psignb128 (v16qi, v16qi)
19383 v4si __builtin_ia32_psignd128 (v4si, v4si)
19384 v8hi __builtin_ia32_psignw128 (v8hi, v8hi)
19385 v2di __builtin_ia32_palignr128 (v2di, v2di, int)
19386 v16qi __builtin_ia32_pabsb128 (v16qi)
19387 v4si __builtin_ia32_pabsd128 (v4si)
19388 v8hi __builtin_ia32_pabsw128 (v8hi)
19389 @end smallexample
19391 The following built-in functions are available when @option{-msse4.1} is
19392 used.  All of them generate the machine instruction that is part of the
19393 name.
19395 @smallexample
19396 v2df __builtin_ia32_blendpd (v2df, v2df, const int)
19397 v4sf __builtin_ia32_blendps (v4sf, v4sf, const int)
19398 v2df __builtin_ia32_blendvpd (v2df, v2df, v2df)
19399 v4sf __builtin_ia32_blendvps (v4sf, v4sf, v4sf)
19400 v2df __builtin_ia32_dppd (v2df, v2df, const int)
19401 v4sf __builtin_ia32_dpps (v4sf, v4sf, const int)
19402 v4sf __builtin_ia32_insertps128 (v4sf, v4sf, const int)
19403 v2di __builtin_ia32_movntdqa (v2di *);
19404 v16qi __builtin_ia32_mpsadbw128 (v16qi, v16qi, const int)
19405 v8hi __builtin_ia32_packusdw128 (v4si, v4si)
19406 v16qi __builtin_ia32_pblendvb128 (v16qi, v16qi, v16qi)
19407 v8hi __builtin_ia32_pblendw128 (v8hi, v8hi, const int)
19408 v2di __builtin_ia32_pcmpeqq (v2di, v2di)
19409 v8hi __builtin_ia32_phminposuw128 (v8hi)
19410 v16qi __builtin_ia32_pmaxsb128 (v16qi, v16qi)
19411 v4si __builtin_ia32_pmaxsd128 (v4si, v4si)
19412 v4si __builtin_ia32_pmaxud128 (v4si, v4si)
19413 v8hi __builtin_ia32_pmaxuw128 (v8hi, v8hi)
19414 v16qi __builtin_ia32_pminsb128 (v16qi, v16qi)
19415 v4si __builtin_ia32_pminsd128 (v4si, v4si)
19416 v4si __builtin_ia32_pminud128 (v4si, v4si)
19417 v8hi __builtin_ia32_pminuw128 (v8hi, v8hi)
19418 v4si __builtin_ia32_pmovsxbd128 (v16qi)
19419 v2di __builtin_ia32_pmovsxbq128 (v16qi)
19420 v8hi __builtin_ia32_pmovsxbw128 (v16qi)
19421 v2di __builtin_ia32_pmovsxdq128 (v4si)
19422 v4si __builtin_ia32_pmovsxwd128 (v8hi)
19423 v2di __builtin_ia32_pmovsxwq128 (v8hi)
19424 v4si __builtin_ia32_pmovzxbd128 (v16qi)
19425 v2di __builtin_ia32_pmovzxbq128 (v16qi)
19426 v8hi __builtin_ia32_pmovzxbw128 (v16qi)
19427 v2di __builtin_ia32_pmovzxdq128 (v4si)
19428 v4si __builtin_ia32_pmovzxwd128 (v8hi)
19429 v2di __builtin_ia32_pmovzxwq128 (v8hi)
19430 v2di __builtin_ia32_pmuldq128 (v4si, v4si)
19431 v4si __builtin_ia32_pmulld128 (v4si, v4si)
19432 int __builtin_ia32_ptestc128 (v2di, v2di)
19433 int __builtin_ia32_ptestnzc128 (v2di, v2di)
19434 int __builtin_ia32_ptestz128 (v2di, v2di)
19435 v2df __builtin_ia32_roundpd (v2df, const int)
19436 v4sf __builtin_ia32_roundps (v4sf, const int)
19437 v2df __builtin_ia32_roundsd (v2df, v2df, const int)
19438 v4sf __builtin_ia32_roundss (v4sf, v4sf, const int)
19439 @end smallexample
19441 The following built-in functions are available when @option{-msse4.1} is
19442 used.
19444 @table @code
19445 @item v4sf __builtin_ia32_vec_set_v4sf (v4sf, float, const int)
19446 Generates the @code{insertps} machine instruction.
19447 @item int __builtin_ia32_vec_ext_v16qi (v16qi, const int)
19448 Generates the @code{pextrb} machine instruction.
19449 @item v16qi __builtin_ia32_vec_set_v16qi (v16qi, int, const int)
19450 Generates the @code{pinsrb} machine instruction.
19451 @item v4si __builtin_ia32_vec_set_v4si (v4si, int, const int)
19452 Generates the @code{pinsrd} machine instruction.
19453 @item v2di __builtin_ia32_vec_set_v2di (v2di, long long, const int)
19454 Generates the @code{pinsrq} machine instruction in 64bit mode.
19455 @end table
19457 The following built-in functions are changed to generate new SSE4.1
19458 instructions when @option{-msse4.1} is used.
19460 @table @code
19461 @item float __builtin_ia32_vec_ext_v4sf (v4sf, const int)
19462 Generates the @code{extractps} machine instruction.
19463 @item int __builtin_ia32_vec_ext_v4si (v4si, const int)
19464 Generates the @code{pextrd} machine instruction.
19465 @item long long __builtin_ia32_vec_ext_v2di (v2di, const int)
19466 Generates the @code{pextrq} machine instruction in 64bit mode.
19467 @end table
19469 The following built-in functions are available when @option{-msse4.2} is
19470 used.  All of them generate the machine instruction that is part of the
19471 name.
19473 @smallexample
19474 v16qi __builtin_ia32_pcmpestrm128 (v16qi, int, v16qi, int, const int)
19475 int __builtin_ia32_pcmpestri128 (v16qi, int, v16qi, int, const int)
19476 int __builtin_ia32_pcmpestria128 (v16qi, int, v16qi, int, const int)
19477 int __builtin_ia32_pcmpestric128 (v16qi, int, v16qi, int, const int)
19478 int __builtin_ia32_pcmpestrio128 (v16qi, int, v16qi, int, const int)
19479 int __builtin_ia32_pcmpestris128 (v16qi, int, v16qi, int, const int)
19480 int __builtin_ia32_pcmpestriz128 (v16qi, int, v16qi, int, const int)
19481 v16qi __builtin_ia32_pcmpistrm128 (v16qi, v16qi, const int)
19482 int __builtin_ia32_pcmpistri128 (v16qi, v16qi, const int)
19483 int __builtin_ia32_pcmpistria128 (v16qi, v16qi, const int)
19484 int __builtin_ia32_pcmpistric128 (v16qi, v16qi, const int)
19485 int __builtin_ia32_pcmpistrio128 (v16qi, v16qi, const int)
19486 int __builtin_ia32_pcmpistris128 (v16qi, v16qi, const int)
19487 int __builtin_ia32_pcmpistriz128 (v16qi, v16qi, const int)
19488 v2di __builtin_ia32_pcmpgtq (v2di, v2di)
19489 @end smallexample
19491 The following built-in functions are available when @option{-msse4.2} is
19492 used.
19494 @table @code
19495 @item unsigned int __builtin_ia32_crc32qi (unsigned int, unsigned char)
19496 Generates the @code{crc32b} machine instruction.
19497 @item unsigned int __builtin_ia32_crc32hi (unsigned int, unsigned short)
19498 Generates the @code{crc32w} machine instruction.
19499 @item unsigned int __builtin_ia32_crc32si (unsigned int, unsigned int)
19500 Generates the @code{crc32l} machine instruction.
19501 @item unsigned long long __builtin_ia32_crc32di (unsigned long long, unsigned long long)
19502 Generates the @code{crc32q} machine instruction.
19503 @end table
19505 The following built-in functions are changed to generate new SSE4.2
19506 instructions when @option{-msse4.2} is used.
19508 @table @code
19509 @item int __builtin_popcount (unsigned int)
19510 Generates the @code{popcntl} machine instruction.
19511 @item int __builtin_popcountl (unsigned long)
19512 Generates the @code{popcntl} or @code{popcntq} machine instruction,
19513 depending on the size of @code{unsigned long}.
19514 @item int __builtin_popcountll (unsigned long long)
19515 Generates the @code{popcntq} machine instruction.
19516 @end table
19518 The following built-in functions are available when @option{-mavx} is
19519 used. All of them generate the machine instruction that is part of the
19520 name.
19522 @smallexample
19523 v4df __builtin_ia32_addpd256 (v4df,v4df)
19524 v8sf __builtin_ia32_addps256 (v8sf,v8sf)
19525 v4df __builtin_ia32_addsubpd256 (v4df,v4df)
19526 v8sf __builtin_ia32_addsubps256 (v8sf,v8sf)
19527 v4df __builtin_ia32_andnpd256 (v4df,v4df)
19528 v8sf __builtin_ia32_andnps256 (v8sf,v8sf)
19529 v4df __builtin_ia32_andpd256 (v4df,v4df)
19530 v8sf __builtin_ia32_andps256 (v8sf,v8sf)
19531 v4df __builtin_ia32_blendpd256 (v4df,v4df,int)
19532 v8sf __builtin_ia32_blendps256 (v8sf,v8sf,int)
19533 v4df __builtin_ia32_blendvpd256 (v4df,v4df,v4df)
19534 v8sf __builtin_ia32_blendvps256 (v8sf,v8sf,v8sf)
19535 v2df __builtin_ia32_cmppd (v2df,v2df,int)
19536 v4df __builtin_ia32_cmppd256 (v4df,v4df,int)
19537 v4sf __builtin_ia32_cmpps (v4sf,v4sf,int)
19538 v8sf __builtin_ia32_cmpps256 (v8sf,v8sf,int)
19539 v2df __builtin_ia32_cmpsd (v2df,v2df,int)
19540 v4sf __builtin_ia32_cmpss (v4sf,v4sf,int)
19541 v4df __builtin_ia32_cvtdq2pd256 (v4si)
19542 v8sf __builtin_ia32_cvtdq2ps256 (v8si)
19543 v4si __builtin_ia32_cvtpd2dq256 (v4df)
19544 v4sf __builtin_ia32_cvtpd2ps256 (v4df)
19545 v8si __builtin_ia32_cvtps2dq256 (v8sf)
19546 v4df __builtin_ia32_cvtps2pd256 (v4sf)
19547 v4si __builtin_ia32_cvttpd2dq256 (v4df)
19548 v8si __builtin_ia32_cvttps2dq256 (v8sf)
19549 v4df __builtin_ia32_divpd256 (v4df,v4df)
19550 v8sf __builtin_ia32_divps256 (v8sf,v8sf)
19551 v8sf __builtin_ia32_dpps256 (v8sf,v8sf,int)
19552 v4df __builtin_ia32_haddpd256 (v4df,v4df)
19553 v8sf __builtin_ia32_haddps256 (v8sf,v8sf)
19554 v4df __builtin_ia32_hsubpd256 (v4df,v4df)
19555 v8sf __builtin_ia32_hsubps256 (v8sf,v8sf)
19556 v32qi __builtin_ia32_lddqu256 (pcchar)
19557 v32qi __builtin_ia32_loaddqu256 (pcchar)
19558 v4df __builtin_ia32_loadupd256 (pcdouble)
19559 v8sf __builtin_ia32_loadups256 (pcfloat)
19560 v2df __builtin_ia32_maskloadpd (pcv2df,v2df)
19561 v4df __builtin_ia32_maskloadpd256 (pcv4df,v4df)
19562 v4sf __builtin_ia32_maskloadps (pcv4sf,v4sf)
19563 v8sf __builtin_ia32_maskloadps256 (pcv8sf,v8sf)
19564 void __builtin_ia32_maskstorepd (pv2df,v2df,v2df)
19565 void __builtin_ia32_maskstorepd256 (pv4df,v4df,v4df)
19566 void __builtin_ia32_maskstoreps (pv4sf,v4sf,v4sf)
19567 void __builtin_ia32_maskstoreps256 (pv8sf,v8sf,v8sf)
19568 v4df __builtin_ia32_maxpd256 (v4df,v4df)
19569 v8sf __builtin_ia32_maxps256 (v8sf,v8sf)
19570 v4df __builtin_ia32_minpd256 (v4df,v4df)
19571 v8sf __builtin_ia32_minps256 (v8sf,v8sf)
19572 v4df __builtin_ia32_movddup256 (v4df)
19573 int __builtin_ia32_movmskpd256 (v4df)
19574 int __builtin_ia32_movmskps256 (v8sf)
19575 v8sf __builtin_ia32_movshdup256 (v8sf)
19576 v8sf __builtin_ia32_movsldup256 (v8sf)
19577 v4df __builtin_ia32_mulpd256 (v4df,v4df)
19578 v8sf __builtin_ia32_mulps256 (v8sf,v8sf)
19579 v4df __builtin_ia32_orpd256 (v4df,v4df)
19580 v8sf __builtin_ia32_orps256 (v8sf,v8sf)
19581 v2df __builtin_ia32_pd_pd256 (v4df)
19582 v4df __builtin_ia32_pd256_pd (v2df)
19583 v4sf __builtin_ia32_ps_ps256 (v8sf)
19584 v8sf __builtin_ia32_ps256_ps (v4sf)
19585 int __builtin_ia32_ptestc256 (v4di,v4di,ptest)
19586 int __builtin_ia32_ptestnzc256 (v4di,v4di,ptest)
19587 int __builtin_ia32_ptestz256 (v4di,v4di,ptest)
19588 v8sf __builtin_ia32_rcpps256 (v8sf)
19589 v4df __builtin_ia32_roundpd256 (v4df,int)
19590 v8sf __builtin_ia32_roundps256 (v8sf,int)
19591 v8sf __builtin_ia32_rsqrtps_nr256 (v8sf)
19592 v8sf __builtin_ia32_rsqrtps256 (v8sf)
19593 v4df __builtin_ia32_shufpd256 (v4df,v4df,int)
19594 v8sf __builtin_ia32_shufps256 (v8sf,v8sf,int)
19595 v4si __builtin_ia32_si_si256 (v8si)
19596 v8si __builtin_ia32_si256_si (v4si)
19597 v4df __builtin_ia32_sqrtpd256 (v4df)
19598 v8sf __builtin_ia32_sqrtps_nr256 (v8sf)
19599 v8sf __builtin_ia32_sqrtps256 (v8sf)
19600 void __builtin_ia32_storedqu256 (pchar,v32qi)
19601 void __builtin_ia32_storeupd256 (pdouble,v4df)
19602 void __builtin_ia32_storeups256 (pfloat,v8sf)
19603 v4df __builtin_ia32_subpd256 (v4df,v4df)
19604 v8sf __builtin_ia32_subps256 (v8sf,v8sf)
19605 v4df __builtin_ia32_unpckhpd256 (v4df,v4df)
19606 v8sf __builtin_ia32_unpckhps256 (v8sf,v8sf)
19607 v4df __builtin_ia32_unpcklpd256 (v4df,v4df)
19608 v8sf __builtin_ia32_unpcklps256 (v8sf,v8sf)
19609 v4df __builtin_ia32_vbroadcastf128_pd256 (pcv2df)
19610 v8sf __builtin_ia32_vbroadcastf128_ps256 (pcv4sf)
19611 v4df __builtin_ia32_vbroadcastsd256 (pcdouble)
19612 v4sf __builtin_ia32_vbroadcastss (pcfloat)
19613 v8sf __builtin_ia32_vbroadcastss256 (pcfloat)
19614 v2df __builtin_ia32_vextractf128_pd256 (v4df,int)
19615 v4sf __builtin_ia32_vextractf128_ps256 (v8sf,int)
19616 v4si __builtin_ia32_vextractf128_si256 (v8si,int)
19617 v4df __builtin_ia32_vinsertf128_pd256 (v4df,v2df,int)
19618 v8sf __builtin_ia32_vinsertf128_ps256 (v8sf,v4sf,int)
19619 v8si __builtin_ia32_vinsertf128_si256 (v8si,v4si,int)
19620 v4df __builtin_ia32_vperm2f128_pd256 (v4df,v4df,int)
19621 v8sf __builtin_ia32_vperm2f128_ps256 (v8sf,v8sf,int)
19622 v8si __builtin_ia32_vperm2f128_si256 (v8si,v8si,int)
19623 v2df __builtin_ia32_vpermil2pd (v2df,v2df,v2di,int)
19624 v4df __builtin_ia32_vpermil2pd256 (v4df,v4df,v4di,int)
19625 v4sf __builtin_ia32_vpermil2ps (v4sf,v4sf,v4si,int)
19626 v8sf __builtin_ia32_vpermil2ps256 (v8sf,v8sf,v8si,int)
19627 v2df __builtin_ia32_vpermilpd (v2df,int)
19628 v4df __builtin_ia32_vpermilpd256 (v4df,int)
19629 v4sf __builtin_ia32_vpermilps (v4sf,int)
19630 v8sf __builtin_ia32_vpermilps256 (v8sf,int)
19631 v2df __builtin_ia32_vpermilvarpd (v2df,v2di)
19632 v4df __builtin_ia32_vpermilvarpd256 (v4df,v4di)
19633 v4sf __builtin_ia32_vpermilvarps (v4sf,v4si)
19634 v8sf __builtin_ia32_vpermilvarps256 (v8sf,v8si)
19635 int __builtin_ia32_vtestcpd (v2df,v2df,ptest)
19636 int __builtin_ia32_vtestcpd256 (v4df,v4df,ptest)
19637 int __builtin_ia32_vtestcps (v4sf,v4sf,ptest)
19638 int __builtin_ia32_vtestcps256 (v8sf,v8sf,ptest)
19639 int __builtin_ia32_vtestnzcpd (v2df,v2df,ptest)
19640 int __builtin_ia32_vtestnzcpd256 (v4df,v4df,ptest)
19641 int __builtin_ia32_vtestnzcps (v4sf,v4sf,ptest)
19642 int __builtin_ia32_vtestnzcps256 (v8sf,v8sf,ptest)
19643 int __builtin_ia32_vtestzpd (v2df,v2df,ptest)
19644 int __builtin_ia32_vtestzpd256 (v4df,v4df,ptest)
19645 int __builtin_ia32_vtestzps (v4sf,v4sf,ptest)
19646 int __builtin_ia32_vtestzps256 (v8sf,v8sf,ptest)
19647 void __builtin_ia32_vzeroall (void)
19648 void __builtin_ia32_vzeroupper (void)
19649 v4df __builtin_ia32_xorpd256 (v4df,v4df)
19650 v8sf __builtin_ia32_xorps256 (v8sf,v8sf)
19651 @end smallexample
19653 The following built-in functions are available when @option{-mavx2} is
19654 used. All of them generate the machine instruction that is part of the
19655 name.
19657 @smallexample
19658 v32qi __builtin_ia32_mpsadbw256 (v32qi,v32qi,int)
19659 v32qi __builtin_ia32_pabsb256 (v32qi)
19660 v16hi __builtin_ia32_pabsw256 (v16hi)
19661 v8si __builtin_ia32_pabsd256 (v8si)
19662 v16hi __builtin_ia32_packssdw256 (v8si,v8si)
19663 v32qi __builtin_ia32_packsswb256 (v16hi,v16hi)
19664 v16hi __builtin_ia32_packusdw256 (v8si,v8si)
19665 v32qi __builtin_ia32_packuswb256 (v16hi,v16hi)
19666 v32qi __builtin_ia32_paddb256 (v32qi,v32qi)
19667 v16hi __builtin_ia32_paddw256 (v16hi,v16hi)
19668 v8si __builtin_ia32_paddd256 (v8si,v8si)
19669 v4di __builtin_ia32_paddq256 (v4di,v4di)
19670 v32qi __builtin_ia32_paddsb256 (v32qi,v32qi)
19671 v16hi __builtin_ia32_paddsw256 (v16hi,v16hi)
19672 v32qi __builtin_ia32_paddusb256 (v32qi,v32qi)
19673 v16hi __builtin_ia32_paddusw256 (v16hi,v16hi)
19674 v4di __builtin_ia32_palignr256 (v4di,v4di,int)
19675 v4di __builtin_ia32_andsi256 (v4di,v4di)
19676 v4di __builtin_ia32_andnotsi256 (v4di,v4di)
19677 v32qi __builtin_ia32_pavgb256 (v32qi,v32qi)
19678 v16hi __builtin_ia32_pavgw256 (v16hi,v16hi)
19679 v32qi __builtin_ia32_pblendvb256 (v32qi,v32qi,v32qi)
19680 v16hi __builtin_ia32_pblendw256 (v16hi,v16hi,int)
19681 v32qi __builtin_ia32_pcmpeqb256 (v32qi,v32qi)
19682 v16hi __builtin_ia32_pcmpeqw256 (v16hi,v16hi)
19683 v8si __builtin_ia32_pcmpeqd256 (c8si,v8si)
19684 v4di __builtin_ia32_pcmpeqq256 (v4di,v4di)
19685 v32qi __builtin_ia32_pcmpgtb256 (v32qi,v32qi)
19686 v16hi __builtin_ia32_pcmpgtw256 (16hi,v16hi)
19687 v8si __builtin_ia32_pcmpgtd256 (v8si,v8si)
19688 v4di __builtin_ia32_pcmpgtq256 (v4di,v4di)
19689 v16hi __builtin_ia32_phaddw256 (v16hi,v16hi)
19690 v8si __builtin_ia32_phaddd256 (v8si,v8si)
19691 v16hi __builtin_ia32_phaddsw256 (v16hi,v16hi)
19692 v16hi __builtin_ia32_phsubw256 (v16hi,v16hi)
19693 v8si __builtin_ia32_phsubd256 (v8si,v8si)
19694 v16hi __builtin_ia32_phsubsw256 (v16hi,v16hi)
19695 v32qi __builtin_ia32_pmaddubsw256 (v32qi,v32qi)
19696 v16hi __builtin_ia32_pmaddwd256 (v16hi,v16hi)
19697 v32qi __builtin_ia32_pmaxsb256 (v32qi,v32qi)
19698 v16hi __builtin_ia32_pmaxsw256 (v16hi,v16hi)
19699 v8si __builtin_ia32_pmaxsd256 (v8si,v8si)
19700 v32qi __builtin_ia32_pmaxub256 (v32qi,v32qi)
19701 v16hi __builtin_ia32_pmaxuw256 (v16hi,v16hi)
19702 v8si __builtin_ia32_pmaxud256 (v8si,v8si)
19703 v32qi __builtin_ia32_pminsb256 (v32qi,v32qi)
19704 v16hi __builtin_ia32_pminsw256 (v16hi,v16hi)
19705 v8si __builtin_ia32_pminsd256 (v8si,v8si)
19706 v32qi __builtin_ia32_pminub256 (v32qi,v32qi)
19707 v16hi __builtin_ia32_pminuw256 (v16hi,v16hi)
19708 v8si __builtin_ia32_pminud256 (v8si,v8si)
19709 int __builtin_ia32_pmovmskb256 (v32qi)
19710 v16hi __builtin_ia32_pmovsxbw256 (v16qi)
19711 v8si __builtin_ia32_pmovsxbd256 (v16qi)
19712 v4di __builtin_ia32_pmovsxbq256 (v16qi)
19713 v8si __builtin_ia32_pmovsxwd256 (v8hi)
19714 v4di __builtin_ia32_pmovsxwq256 (v8hi)
19715 v4di __builtin_ia32_pmovsxdq256 (v4si)
19716 v16hi __builtin_ia32_pmovzxbw256 (v16qi)
19717 v8si __builtin_ia32_pmovzxbd256 (v16qi)
19718 v4di __builtin_ia32_pmovzxbq256 (v16qi)
19719 v8si __builtin_ia32_pmovzxwd256 (v8hi)
19720 v4di __builtin_ia32_pmovzxwq256 (v8hi)
19721 v4di __builtin_ia32_pmovzxdq256 (v4si)
19722 v4di __builtin_ia32_pmuldq256 (v8si,v8si)
19723 v16hi __builtin_ia32_pmulhrsw256 (v16hi, v16hi)
19724 v16hi __builtin_ia32_pmulhuw256 (v16hi,v16hi)
19725 v16hi __builtin_ia32_pmulhw256 (v16hi,v16hi)
19726 v16hi __builtin_ia32_pmullw256 (v16hi,v16hi)
19727 v8si __builtin_ia32_pmulld256 (v8si,v8si)
19728 v4di __builtin_ia32_pmuludq256 (v8si,v8si)
19729 v4di __builtin_ia32_por256 (v4di,v4di)
19730 v16hi __builtin_ia32_psadbw256 (v32qi,v32qi)
19731 v32qi __builtin_ia32_pshufb256 (v32qi,v32qi)
19732 v8si __builtin_ia32_pshufd256 (v8si,int)
19733 v16hi __builtin_ia32_pshufhw256 (v16hi,int)
19734 v16hi __builtin_ia32_pshuflw256 (v16hi,int)
19735 v32qi __builtin_ia32_psignb256 (v32qi,v32qi)
19736 v16hi __builtin_ia32_psignw256 (v16hi,v16hi)
19737 v8si __builtin_ia32_psignd256 (v8si,v8si)
19738 v4di __builtin_ia32_pslldqi256 (v4di,int)
19739 v16hi __builtin_ia32_psllwi256 (16hi,int)
19740 v16hi __builtin_ia32_psllw256(v16hi,v8hi)
19741 v8si __builtin_ia32_pslldi256 (v8si,int)
19742 v8si __builtin_ia32_pslld256(v8si,v4si)
19743 v4di __builtin_ia32_psllqi256 (v4di,int)
19744 v4di __builtin_ia32_psllq256(v4di,v2di)
19745 v16hi __builtin_ia32_psrawi256 (v16hi,int)
19746 v16hi __builtin_ia32_psraw256 (v16hi,v8hi)
19747 v8si __builtin_ia32_psradi256 (v8si,int)
19748 v8si __builtin_ia32_psrad256 (v8si,v4si)
19749 v4di __builtin_ia32_psrldqi256 (v4di, int)
19750 v16hi __builtin_ia32_psrlwi256 (v16hi,int)
19751 v16hi __builtin_ia32_psrlw256 (v16hi,v8hi)
19752 v8si __builtin_ia32_psrldi256 (v8si,int)
19753 v8si __builtin_ia32_psrld256 (v8si,v4si)
19754 v4di __builtin_ia32_psrlqi256 (v4di,int)
19755 v4di __builtin_ia32_psrlq256(v4di,v2di)
19756 v32qi __builtin_ia32_psubb256 (v32qi,v32qi)
19757 v32hi __builtin_ia32_psubw256 (v16hi,v16hi)
19758 v8si __builtin_ia32_psubd256 (v8si,v8si)
19759 v4di __builtin_ia32_psubq256 (v4di,v4di)
19760 v32qi __builtin_ia32_psubsb256 (v32qi,v32qi)
19761 v16hi __builtin_ia32_psubsw256 (v16hi,v16hi)
19762 v32qi __builtin_ia32_psubusb256 (v32qi,v32qi)
19763 v16hi __builtin_ia32_psubusw256 (v16hi,v16hi)
19764 v32qi __builtin_ia32_punpckhbw256 (v32qi,v32qi)
19765 v16hi __builtin_ia32_punpckhwd256 (v16hi,v16hi)
19766 v8si __builtin_ia32_punpckhdq256 (v8si,v8si)
19767 v4di __builtin_ia32_punpckhqdq256 (v4di,v4di)
19768 v32qi __builtin_ia32_punpcklbw256 (v32qi,v32qi)
19769 v16hi __builtin_ia32_punpcklwd256 (v16hi,v16hi)
19770 v8si __builtin_ia32_punpckldq256 (v8si,v8si)
19771 v4di __builtin_ia32_punpcklqdq256 (v4di,v4di)
19772 v4di __builtin_ia32_pxor256 (v4di,v4di)
19773 v4di __builtin_ia32_movntdqa256 (pv4di)
19774 v4sf __builtin_ia32_vbroadcastss_ps (v4sf)
19775 v8sf __builtin_ia32_vbroadcastss_ps256 (v4sf)
19776 v4df __builtin_ia32_vbroadcastsd_pd256 (v2df)
19777 v4di __builtin_ia32_vbroadcastsi256 (v2di)
19778 v4si __builtin_ia32_pblendd128 (v4si,v4si)
19779 v8si __builtin_ia32_pblendd256 (v8si,v8si)
19780 v32qi __builtin_ia32_pbroadcastb256 (v16qi)
19781 v16hi __builtin_ia32_pbroadcastw256 (v8hi)
19782 v8si __builtin_ia32_pbroadcastd256 (v4si)
19783 v4di __builtin_ia32_pbroadcastq256 (v2di)
19784 v16qi __builtin_ia32_pbroadcastb128 (v16qi)
19785 v8hi __builtin_ia32_pbroadcastw128 (v8hi)
19786 v4si __builtin_ia32_pbroadcastd128 (v4si)
19787 v2di __builtin_ia32_pbroadcastq128 (v2di)
19788 v8si __builtin_ia32_permvarsi256 (v8si,v8si)
19789 v4df __builtin_ia32_permdf256 (v4df,int)
19790 v8sf __builtin_ia32_permvarsf256 (v8sf,v8sf)
19791 v4di __builtin_ia32_permdi256 (v4di,int)
19792 v4di __builtin_ia32_permti256 (v4di,v4di,int)
19793 v4di __builtin_ia32_extract128i256 (v4di,int)
19794 v4di __builtin_ia32_insert128i256 (v4di,v2di,int)
19795 v8si __builtin_ia32_maskloadd256 (pcv8si,v8si)
19796 v4di __builtin_ia32_maskloadq256 (pcv4di,v4di)
19797 v4si __builtin_ia32_maskloadd (pcv4si,v4si)
19798 v2di __builtin_ia32_maskloadq (pcv2di,v2di)
19799 void __builtin_ia32_maskstored256 (pv8si,v8si,v8si)
19800 void __builtin_ia32_maskstoreq256 (pv4di,v4di,v4di)
19801 void __builtin_ia32_maskstored (pv4si,v4si,v4si)
19802 void __builtin_ia32_maskstoreq (pv2di,v2di,v2di)
19803 v8si __builtin_ia32_psllv8si (v8si,v8si)
19804 v4si __builtin_ia32_psllv4si (v4si,v4si)
19805 v4di __builtin_ia32_psllv4di (v4di,v4di)
19806 v2di __builtin_ia32_psllv2di (v2di,v2di)
19807 v8si __builtin_ia32_psrav8si (v8si,v8si)
19808 v4si __builtin_ia32_psrav4si (v4si,v4si)
19809 v8si __builtin_ia32_psrlv8si (v8si,v8si)
19810 v4si __builtin_ia32_psrlv4si (v4si,v4si)
19811 v4di __builtin_ia32_psrlv4di (v4di,v4di)
19812 v2di __builtin_ia32_psrlv2di (v2di,v2di)
19813 v2df __builtin_ia32_gathersiv2df (v2df, pcdouble,v4si,v2df,int)
19814 v4df __builtin_ia32_gathersiv4df (v4df, pcdouble,v4si,v4df,int)
19815 v2df __builtin_ia32_gatherdiv2df (v2df, pcdouble,v2di,v2df,int)
19816 v4df __builtin_ia32_gatherdiv4df (v4df, pcdouble,v4di,v4df,int)
19817 v4sf __builtin_ia32_gathersiv4sf (v4sf, pcfloat,v4si,v4sf,int)
19818 v8sf __builtin_ia32_gathersiv8sf (v8sf, pcfloat,v8si,v8sf,int)
19819 v4sf __builtin_ia32_gatherdiv4sf (v4sf, pcfloat,v2di,v4sf,int)
19820 v4sf __builtin_ia32_gatherdiv4sf256 (v4sf, pcfloat,v4di,v4sf,int)
19821 v2di __builtin_ia32_gathersiv2di (v2di, pcint64,v4si,v2di,int)
19822 v4di __builtin_ia32_gathersiv4di (v4di, pcint64,v4si,v4di,int)
19823 v2di __builtin_ia32_gatherdiv2di (v2di, pcint64,v2di,v2di,int)
19824 v4di __builtin_ia32_gatherdiv4di (v4di, pcint64,v4di,v4di,int)
19825 v4si __builtin_ia32_gathersiv4si (v4si, pcint,v4si,v4si,int)
19826 v8si __builtin_ia32_gathersiv8si (v8si, pcint,v8si,v8si,int)
19827 v4si __builtin_ia32_gatherdiv4si (v4si, pcint,v2di,v4si,int)
19828 v4si __builtin_ia32_gatherdiv4si256 (v4si, pcint,v4di,v4si,int)
19829 @end smallexample
19831 The following built-in functions are available when @option{-maes} is
19832 used.  All of them generate the machine instruction that is part of the
19833 name.
19835 @smallexample
19836 v2di __builtin_ia32_aesenc128 (v2di, v2di)
19837 v2di __builtin_ia32_aesenclast128 (v2di, v2di)
19838 v2di __builtin_ia32_aesdec128 (v2di, v2di)
19839 v2di __builtin_ia32_aesdeclast128 (v2di, v2di)
19840 v2di __builtin_ia32_aeskeygenassist128 (v2di, const int)
19841 v2di __builtin_ia32_aesimc128 (v2di)
19842 @end smallexample
19844 The following built-in function is available when @option{-mpclmul} is
19845 used.
19847 @table @code
19848 @item v2di __builtin_ia32_pclmulqdq128 (v2di, v2di, const int)
19849 Generates the @code{pclmulqdq} machine instruction.
19850 @end table
19852 The following built-in function is available when @option{-mfsgsbase} is
19853 used.  All of them generate the machine instruction that is part of the
19854 name.
19856 @smallexample
19857 unsigned int __builtin_ia32_rdfsbase32 (void)
19858 unsigned long long __builtin_ia32_rdfsbase64 (void)
19859 unsigned int __builtin_ia32_rdgsbase32 (void)
19860 unsigned long long __builtin_ia32_rdgsbase64 (void)
19861 void _writefsbase_u32 (unsigned int)
19862 void _writefsbase_u64 (unsigned long long)
19863 void _writegsbase_u32 (unsigned int)
19864 void _writegsbase_u64 (unsigned long long)
19865 @end smallexample
19867 The following built-in function is available when @option{-mrdrnd} is
19868 used.  All of them generate the machine instruction that is part of the
19869 name.
19871 @smallexample
19872 unsigned int __builtin_ia32_rdrand16_step (unsigned short *)
19873 unsigned int __builtin_ia32_rdrand32_step (unsigned int *)
19874 unsigned int __builtin_ia32_rdrand64_step (unsigned long long *)
19875 @end smallexample
19877 The following built-in functions are available when @option{-msse4a} is used.
19878 All of them generate the machine instruction that is part of the name.
19880 @smallexample
19881 void __builtin_ia32_movntsd (double *, v2df)
19882 void __builtin_ia32_movntss (float *, v4sf)
19883 v2di __builtin_ia32_extrq  (v2di, v16qi)
19884 v2di __builtin_ia32_extrqi (v2di, const unsigned int, const unsigned int)
19885 v2di __builtin_ia32_insertq (v2di, v2di)
19886 v2di __builtin_ia32_insertqi (v2di, v2di, const unsigned int, const unsigned int)
19887 @end smallexample
19889 The following built-in functions are available when @option{-mxop} is used.
19890 @smallexample
19891 v2df __builtin_ia32_vfrczpd (v2df)
19892 v4sf __builtin_ia32_vfrczps (v4sf)
19893 v2df __builtin_ia32_vfrczsd (v2df)
19894 v4sf __builtin_ia32_vfrczss (v4sf)
19895 v4df __builtin_ia32_vfrczpd256 (v4df)
19896 v8sf __builtin_ia32_vfrczps256 (v8sf)
19897 v2di __builtin_ia32_vpcmov (v2di, v2di, v2di)
19898 v2di __builtin_ia32_vpcmov_v2di (v2di, v2di, v2di)
19899 v4si __builtin_ia32_vpcmov_v4si (v4si, v4si, v4si)
19900 v8hi __builtin_ia32_vpcmov_v8hi (v8hi, v8hi, v8hi)
19901 v16qi __builtin_ia32_vpcmov_v16qi (v16qi, v16qi, v16qi)
19902 v2df __builtin_ia32_vpcmov_v2df (v2df, v2df, v2df)
19903 v4sf __builtin_ia32_vpcmov_v4sf (v4sf, v4sf, v4sf)
19904 v4di __builtin_ia32_vpcmov_v4di256 (v4di, v4di, v4di)
19905 v8si __builtin_ia32_vpcmov_v8si256 (v8si, v8si, v8si)
19906 v16hi __builtin_ia32_vpcmov_v16hi256 (v16hi, v16hi, v16hi)
19907 v32qi __builtin_ia32_vpcmov_v32qi256 (v32qi, v32qi, v32qi)
19908 v4df __builtin_ia32_vpcmov_v4df256 (v4df, v4df, v4df)
19909 v8sf __builtin_ia32_vpcmov_v8sf256 (v8sf, v8sf, v8sf)
19910 v16qi __builtin_ia32_vpcomeqb (v16qi, v16qi)
19911 v8hi __builtin_ia32_vpcomeqw (v8hi, v8hi)
19912 v4si __builtin_ia32_vpcomeqd (v4si, v4si)
19913 v2di __builtin_ia32_vpcomeqq (v2di, v2di)
19914 v16qi __builtin_ia32_vpcomequb (v16qi, v16qi)
19915 v4si __builtin_ia32_vpcomequd (v4si, v4si)
19916 v2di __builtin_ia32_vpcomequq (v2di, v2di)
19917 v8hi __builtin_ia32_vpcomequw (v8hi, v8hi)
19918 v8hi __builtin_ia32_vpcomeqw (v8hi, v8hi)
19919 v16qi __builtin_ia32_vpcomfalseb (v16qi, v16qi)
19920 v4si __builtin_ia32_vpcomfalsed (v4si, v4si)
19921 v2di __builtin_ia32_vpcomfalseq (v2di, v2di)
19922 v16qi __builtin_ia32_vpcomfalseub (v16qi, v16qi)
19923 v4si __builtin_ia32_vpcomfalseud (v4si, v4si)
19924 v2di __builtin_ia32_vpcomfalseuq (v2di, v2di)
19925 v8hi __builtin_ia32_vpcomfalseuw (v8hi, v8hi)
19926 v8hi __builtin_ia32_vpcomfalsew (v8hi, v8hi)
19927 v16qi __builtin_ia32_vpcomgeb (v16qi, v16qi)
19928 v4si __builtin_ia32_vpcomged (v4si, v4si)
19929 v2di __builtin_ia32_vpcomgeq (v2di, v2di)
19930 v16qi __builtin_ia32_vpcomgeub (v16qi, v16qi)
19931 v4si __builtin_ia32_vpcomgeud (v4si, v4si)
19932 v2di __builtin_ia32_vpcomgeuq (v2di, v2di)
19933 v8hi __builtin_ia32_vpcomgeuw (v8hi, v8hi)
19934 v8hi __builtin_ia32_vpcomgew (v8hi, v8hi)
19935 v16qi __builtin_ia32_vpcomgtb (v16qi, v16qi)
19936 v4si __builtin_ia32_vpcomgtd (v4si, v4si)
19937 v2di __builtin_ia32_vpcomgtq (v2di, v2di)
19938 v16qi __builtin_ia32_vpcomgtub (v16qi, v16qi)
19939 v4si __builtin_ia32_vpcomgtud (v4si, v4si)
19940 v2di __builtin_ia32_vpcomgtuq (v2di, v2di)
19941 v8hi __builtin_ia32_vpcomgtuw (v8hi, v8hi)
19942 v8hi __builtin_ia32_vpcomgtw (v8hi, v8hi)
19943 v16qi __builtin_ia32_vpcomleb (v16qi, v16qi)
19944 v4si __builtin_ia32_vpcomled (v4si, v4si)
19945 v2di __builtin_ia32_vpcomleq (v2di, v2di)
19946 v16qi __builtin_ia32_vpcomleub (v16qi, v16qi)
19947 v4si __builtin_ia32_vpcomleud (v4si, v4si)
19948 v2di __builtin_ia32_vpcomleuq (v2di, v2di)
19949 v8hi __builtin_ia32_vpcomleuw (v8hi, v8hi)
19950 v8hi __builtin_ia32_vpcomlew (v8hi, v8hi)
19951 v16qi __builtin_ia32_vpcomltb (v16qi, v16qi)
19952 v4si __builtin_ia32_vpcomltd (v4si, v4si)
19953 v2di __builtin_ia32_vpcomltq (v2di, v2di)
19954 v16qi __builtin_ia32_vpcomltub (v16qi, v16qi)
19955 v4si __builtin_ia32_vpcomltud (v4si, v4si)
19956 v2di __builtin_ia32_vpcomltuq (v2di, v2di)
19957 v8hi __builtin_ia32_vpcomltuw (v8hi, v8hi)
19958 v8hi __builtin_ia32_vpcomltw (v8hi, v8hi)
19959 v16qi __builtin_ia32_vpcomneb (v16qi, v16qi)
19960 v4si __builtin_ia32_vpcomned (v4si, v4si)
19961 v2di __builtin_ia32_vpcomneq (v2di, v2di)
19962 v16qi __builtin_ia32_vpcomneub (v16qi, v16qi)
19963 v4si __builtin_ia32_vpcomneud (v4si, v4si)
19964 v2di __builtin_ia32_vpcomneuq (v2di, v2di)
19965 v8hi __builtin_ia32_vpcomneuw (v8hi, v8hi)
19966 v8hi __builtin_ia32_vpcomnew (v8hi, v8hi)
19967 v16qi __builtin_ia32_vpcomtrueb (v16qi, v16qi)
19968 v4si __builtin_ia32_vpcomtrued (v4si, v4si)
19969 v2di __builtin_ia32_vpcomtrueq (v2di, v2di)
19970 v16qi __builtin_ia32_vpcomtrueub (v16qi, v16qi)
19971 v4si __builtin_ia32_vpcomtrueud (v4si, v4si)
19972 v2di __builtin_ia32_vpcomtrueuq (v2di, v2di)
19973 v8hi __builtin_ia32_vpcomtrueuw (v8hi, v8hi)
19974 v8hi __builtin_ia32_vpcomtruew (v8hi, v8hi)
19975 v4si __builtin_ia32_vphaddbd (v16qi)
19976 v2di __builtin_ia32_vphaddbq (v16qi)
19977 v8hi __builtin_ia32_vphaddbw (v16qi)
19978 v2di __builtin_ia32_vphadddq (v4si)
19979 v4si __builtin_ia32_vphaddubd (v16qi)
19980 v2di __builtin_ia32_vphaddubq (v16qi)
19981 v8hi __builtin_ia32_vphaddubw (v16qi)
19982 v2di __builtin_ia32_vphaddudq (v4si)
19983 v4si __builtin_ia32_vphadduwd (v8hi)
19984 v2di __builtin_ia32_vphadduwq (v8hi)
19985 v4si __builtin_ia32_vphaddwd (v8hi)
19986 v2di __builtin_ia32_vphaddwq (v8hi)
19987 v8hi __builtin_ia32_vphsubbw (v16qi)
19988 v2di __builtin_ia32_vphsubdq (v4si)
19989 v4si __builtin_ia32_vphsubwd (v8hi)
19990 v4si __builtin_ia32_vpmacsdd (v4si, v4si, v4si)
19991 v2di __builtin_ia32_vpmacsdqh (v4si, v4si, v2di)
19992 v2di __builtin_ia32_vpmacsdql (v4si, v4si, v2di)
19993 v4si __builtin_ia32_vpmacssdd (v4si, v4si, v4si)
19994 v2di __builtin_ia32_vpmacssdqh (v4si, v4si, v2di)
19995 v2di __builtin_ia32_vpmacssdql (v4si, v4si, v2di)
19996 v4si __builtin_ia32_vpmacsswd (v8hi, v8hi, v4si)
19997 v8hi __builtin_ia32_vpmacssww (v8hi, v8hi, v8hi)
19998 v4si __builtin_ia32_vpmacswd (v8hi, v8hi, v4si)
19999 v8hi __builtin_ia32_vpmacsww (v8hi, v8hi, v8hi)
20000 v4si __builtin_ia32_vpmadcsswd (v8hi, v8hi, v4si)
20001 v4si __builtin_ia32_vpmadcswd (v8hi, v8hi, v4si)
20002 v16qi __builtin_ia32_vpperm (v16qi, v16qi, v16qi)
20003 v16qi __builtin_ia32_vprotb (v16qi, v16qi)
20004 v4si __builtin_ia32_vprotd (v4si, v4si)
20005 v2di __builtin_ia32_vprotq (v2di, v2di)
20006 v8hi __builtin_ia32_vprotw (v8hi, v8hi)
20007 v16qi __builtin_ia32_vpshab (v16qi, v16qi)
20008 v4si __builtin_ia32_vpshad (v4si, v4si)
20009 v2di __builtin_ia32_vpshaq (v2di, v2di)
20010 v8hi __builtin_ia32_vpshaw (v8hi, v8hi)
20011 v16qi __builtin_ia32_vpshlb (v16qi, v16qi)
20012 v4si __builtin_ia32_vpshld (v4si, v4si)
20013 v2di __builtin_ia32_vpshlq (v2di, v2di)
20014 v8hi __builtin_ia32_vpshlw (v8hi, v8hi)
20015 @end smallexample
20017 The following built-in functions are available when @option{-mfma4} is used.
20018 All of them generate the machine instruction that is part of the name.
20020 @smallexample
20021 v2df __builtin_ia32_vfmaddpd (v2df, v2df, v2df)
20022 v4sf __builtin_ia32_vfmaddps (v4sf, v4sf, v4sf)
20023 v2df __builtin_ia32_vfmaddsd (v2df, v2df, v2df)
20024 v4sf __builtin_ia32_vfmaddss (v4sf, v4sf, v4sf)
20025 v2df __builtin_ia32_vfmsubpd (v2df, v2df, v2df)
20026 v4sf __builtin_ia32_vfmsubps (v4sf, v4sf, v4sf)
20027 v2df __builtin_ia32_vfmsubsd (v2df, v2df, v2df)
20028 v4sf __builtin_ia32_vfmsubss (v4sf, v4sf, v4sf)
20029 v2df __builtin_ia32_vfnmaddpd (v2df, v2df, v2df)
20030 v4sf __builtin_ia32_vfnmaddps (v4sf, v4sf, v4sf)
20031 v2df __builtin_ia32_vfnmaddsd (v2df, v2df, v2df)
20032 v4sf __builtin_ia32_vfnmaddss (v4sf, v4sf, v4sf)
20033 v2df __builtin_ia32_vfnmsubpd (v2df, v2df, v2df)
20034 v4sf __builtin_ia32_vfnmsubps (v4sf, v4sf, v4sf)
20035 v2df __builtin_ia32_vfnmsubsd (v2df, v2df, v2df)
20036 v4sf __builtin_ia32_vfnmsubss (v4sf, v4sf, v4sf)
20037 v2df __builtin_ia32_vfmaddsubpd  (v2df, v2df, v2df)
20038 v4sf __builtin_ia32_vfmaddsubps  (v4sf, v4sf, v4sf)
20039 v2df __builtin_ia32_vfmsubaddpd  (v2df, v2df, v2df)
20040 v4sf __builtin_ia32_vfmsubaddps  (v4sf, v4sf, v4sf)
20041 v4df __builtin_ia32_vfmaddpd256 (v4df, v4df, v4df)
20042 v8sf __builtin_ia32_vfmaddps256 (v8sf, v8sf, v8sf)
20043 v4df __builtin_ia32_vfmsubpd256 (v4df, v4df, v4df)
20044 v8sf __builtin_ia32_vfmsubps256 (v8sf, v8sf, v8sf)
20045 v4df __builtin_ia32_vfnmaddpd256 (v4df, v4df, v4df)
20046 v8sf __builtin_ia32_vfnmaddps256 (v8sf, v8sf, v8sf)
20047 v4df __builtin_ia32_vfnmsubpd256 (v4df, v4df, v4df)
20048 v8sf __builtin_ia32_vfnmsubps256 (v8sf, v8sf, v8sf)
20049 v4df __builtin_ia32_vfmaddsubpd256 (v4df, v4df, v4df)
20050 v8sf __builtin_ia32_vfmaddsubps256 (v8sf, v8sf, v8sf)
20051 v4df __builtin_ia32_vfmsubaddpd256 (v4df, v4df, v4df)
20052 v8sf __builtin_ia32_vfmsubaddps256 (v8sf, v8sf, v8sf)
20054 @end smallexample
20056 The following built-in functions are available when @option{-mlwp} is used.
20058 @smallexample
20059 void __builtin_ia32_llwpcb16 (void *);
20060 void __builtin_ia32_llwpcb32 (void *);
20061 void __builtin_ia32_llwpcb64 (void *);
20062 void * __builtin_ia32_llwpcb16 (void);
20063 void * __builtin_ia32_llwpcb32 (void);
20064 void * __builtin_ia32_llwpcb64 (void);
20065 void __builtin_ia32_lwpval16 (unsigned short, unsigned int, unsigned short)
20066 void __builtin_ia32_lwpval32 (unsigned int, unsigned int, unsigned int)
20067 void __builtin_ia32_lwpval64 (unsigned __int64, unsigned int, unsigned int)
20068 unsigned char __builtin_ia32_lwpins16 (unsigned short, unsigned int, unsigned short)
20069 unsigned char __builtin_ia32_lwpins32 (unsigned int, unsigned int, unsigned int)
20070 unsigned char __builtin_ia32_lwpins64 (unsigned __int64, unsigned int, unsigned int)
20071 @end smallexample
20073 The following built-in functions are available when @option{-mbmi} is used.
20074 All of them generate the machine instruction that is part of the name.
20075 @smallexample
20076 unsigned int __builtin_ia32_bextr_u32(unsigned int, unsigned int);
20077 unsigned long long __builtin_ia32_bextr_u64 (unsigned long long, unsigned long long);
20078 @end smallexample
20080 The following built-in functions are available when @option{-mbmi2} is used.
20081 All of them generate the machine instruction that is part of the name.
20082 @smallexample
20083 unsigned int _bzhi_u32 (unsigned int, unsigned int)
20084 unsigned int _pdep_u32 (unsigned int, unsigned int)
20085 unsigned int _pext_u32 (unsigned int, unsigned int)
20086 unsigned long long _bzhi_u64 (unsigned long long, unsigned long long)
20087 unsigned long long _pdep_u64 (unsigned long long, unsigned long long)
20088 unsigned long long _pext_u64 (unsigned long long, unsigned long long)
20089 @end smallexample
20091 The following built-in functions are available when @option{-mlzcnt} is used.
20092 All of them generate the machine instruction that is part of the name.
20093 @smallexample
20094 unsigned short __builtin_ia32_lzcnt_16(unsigned short);
20095 unsigned int __builtin_ia32_lzcnt_u32(unsigned int);
20096 unsigned long long __builtin_ia32_lzcnt_u64 (unsigned long long);
20097 @end smallexample
20099 The following built-in functions are available when @option{-mfxsr} is used.
20100 All of them generate the machine instruction that is part of the name.
20101 @smallexample
20102 void __builtin_ia32_fxsave (void *)
20103 void __builtin_ia32_fxrstor (void *)
20104 void __builtin_ia32_fxsave64 (void *)
20105 void __builtin_ia32_fxrstor64 (void *)
20106 @end smallexample
20108 The following built-in functions are available when @option{-mxsave} is used.
20109 All of them generate the machine instruction that is part of the name.
20110 @smallexample
20111 void __builtin_ia32_xsave (void *, long long)
20112 void __builtin_ia32_xrstor (void *, long long)
20113 void __builtin_ia32_xsave64 (void *, long long)
20114 void __builtin_ia32_xrstor64 (void *, long long)
20115 @end smallexample
20117 The following built-in functions are available when @option{-mxsaveopt} is used.
20118 All of them generate the machine instruction that is part of the name.
20119 @smallexample
20120 void __builtin_ia32_xsaveopt (void *, long long)
20121 void __builtin_ia32_xsaveopt64 (void *, long long)
20122 @end smallexample
20124 The following built-in functions are available when @option{-mtbm} is used.
20125 Both of them generate the immediate form of the bextr machine instruction.
20126 @smallexample
20127 unsigned int __builtin_ia32_bextri_u32 (unsigned int, const unsigned int);
20128 unsigned long long __builtin_ia32_bextri_u64 (unsigned long long, const unsigned long long);
20129 @end smallexample
20132 The following built-in functions are available when @option{-m3dnow} is used.
20133 All of them generate the machine instruction that is part of the name.
20135 @smallexample
20136 void __builtin_ia32_femms (void)
20137 v8qi __builtin_ia32_pavgusb (v8qi, v8qi)
20138 v2si __builtin_ia32_pf2id (v2sf)
20139 v2sf __builtin_ia32_pfacc (v2sf, v2sf)
20140 v2sf __builtin_ia32_pfadd (v2sf, v2sf)
20141 v2si __builtin_ia32_pfcmpeq (v2sf, v2sf)
20142 v2si __builtin_ia32_pfcmpge (v2sf, v2sf)
20143 v2si __builtin_ia32_pfcmpgt (v2sf, v2sf)
20144 v2sf __builtin_ia32_pfmax (v2sf, v2sf)
20145 v2sf __builtin_ia32_pfmin (v2sf, v2sf)
20146 v2sf __builtin_ia32_pfmul (v2sf, v2sf)
20147 v2sf __builtin_ia32_pfrcp (v2sf)
20148 v2sf __builtin_ia32_pfrcpit1 (v2sf, v2sf)
20149 v2sf __builtin_ia32_pfrcpit2 (v2sf, v2sf)
20150 v2sf __builtin_ia32_pfrsqrt (v2sf)
20151 v2sf __builtin_ia32_pfsub (v2sf, v2sf)
20152 v2sf __builtin_ia32_pfsubr (v2sf, v2sf)
20153 v2sf __builtin_ia32_pi2fd (v2si)
20154 v4hi __builtin_ia32_pmulhrw (v4hi, v4hi)
20155 @end smallexample
20157 The following built-in functions are available when both @option{-m3dnow}
20158 and @option{-march=athlon} are used.  All of them generate the machine
20159 instruction that is part of the name.
20161 @smallexample
20162 v2si __builtin_ia32_pf2iw (v2sf)
20163 v2sf __builtin_ia32_pfnacc (v2sf, v2sf)
20164 v2sf __builtin_ia32_pfpnacc (v2sf, v2sf)
20165 v2sf __builtin_ia32_pi2fw (v2si)
20166 v2sf __builtin_ia32_pswapdsf (v2sf)
20167 v2si __builtin_ia32_pswapdsi (v2si)
20168 @end smallexample
20170 The following built-in functions are available when @option{-mrtm} is used
20171 They are used for restricted transactional memory. These are the internal
20172 low level functions. Normally the functions in 
20173 @ref{x86 transactional memory intrinsics} should be used instead.
20175 @smallexample
20176 int __builtin_ia32_xbegin ()
20177 void __builtin_ia32_xend ()
20178 void __builtin_ia32_xabort (status)
20179 int __builtin_ia32_xtest ()
20180 @end smallexample
20182 The following built-in functions are available when @option{-mmwaitx} is used.
20183 All of them generate the machine instruction that is part of the name.
20184 @smallexample
20185 void __builtin_ia32_monitorx (void *, unsigned int, unsigned int)
20186 void __builtin_ia32_mwaitx (unsigned int, unsigned int, unsigned int)
20187 @end smallexample
20189 The following built-in functions are available when @option{-mclzero} is used.
20190 All of them generate the machine instruction that is part of the name.
20191 @smallexample
20192 void __builtin_i32_clzero (void *)
20193 @end smallexample
20195 The following built-in functions are available when @option{-mpku} is used.
20196 They generate reads and writes to PKRU.
20197 @smallexample
20198 void __builtin_ia32_wrpkru (unsigned int)
20199 unsigned int __builtin_ia32_rdpkru ()
20200 @end smallexample
20202 @node x86 transactional memory intrinsics
20203 @subsection x86 Transactional Memory Intrinsics
20205 These hardware transactional memory intrinsics for x86 allow you to use
20206 memory transactions with RTM (Restricted Transactional Memory).
20207 This support is enabled with the @option{-mrtm} option.
20208 For using HLE (Hardware Lock Elision) see 
20209 @ref{x86 specific memory model extensions for transactional memory} instead.
20211 A memory transaction commits all changes to memory in an atomic way,
20212 as visible to other threads. If the transaction fails it is rolled back
20213 and all side effects discarded.
20215 Generally there is no guarantee that a memory transaction ever succeeds
20216 and suitable fallback code always needs to be supplied.
20218 @deftypefn {RTM Function} {unsigned} _xbegin ()
20219 Start a RTM (Restricted Transactional Memory) transaction. 
20220 Returns @code{_XBEGIN_STARTED} when the transaction
20221 started successfully (note this is not 0, so the constant has to be 
20222 explicitly tested).  
20224 If the transaction aborts, all side-effects 
20225 are undone and an abort code encoded as a bit mask is returned.
20226 The following macros are defined:
20228 @table @code
20229 @item _XABORT_EXPLICIT
20230 Transaction was explicitly aborted with @code{_xabort}.  The parameter passed
20231 to @code{_xabort} is available with @code{_XABORT_CODE(status)}.
20232 @item _XABORT_RETRY
20233 Transaction retry is possible.
20234 @item _XABORT_CONFLICT
20235 Transaction abort due to a memory conflict with another thread.
20236 @item _XABORT_CAPACITY
20237 Transaction abort due to the transaction using too much memory.
20238 @item _XABORT_DEBUG
20239 Transaction abort due to a debug trap.
20240 @item _XABORT_NESTED
20241 Transaction abort in an inner nested transaction.
20242 @end table
20244 There is no guarantee
20245 any transaction ever succeeds, so there always needs to be a valid
20246 fallback path.
20247 @end deftypefn
20249 @deftypefn {RTM Function} {void} _xend ()
20250 Commit the current transaction. When no transaction is active this faults.
20251 All memory side-effects of the transaction become visible
20252 to other threads in an atomic manner.
20253 @end deftypefn
20255 @deftypefn {RTM Function} {int} _xtest ()
20256 Return a nonzero value if a transaction is currently active, otherwise 0.
20257 @end deftypefn
20259 @deftypefn {RTM Function} {void} _xabort (status)
20260 Abort the current transaction. When no transaction is active this is a no-op.
20261 The @var{status} is an 8-bit constant; its value is encoded in the return 
20262 value from @code{_xbegin}.
20263 @end deftypefn
20265 Here is an example showing handling for @code{_XABORT_RETRY}
20266 and a fallback path for other failures:
20268 @smallexample
20269 #include <immintrin.h>
20271 int n_tries, max_tries;
20272 unsigned status = _XABORT_EXPLICIT;
20275 for (n_tries = 0; n_tries < max_tries; n_tries++) 
20276   @{
20277     status = _xbegin ();
20278     if (status == _XBEGIN_STARTED || !(status & _XABORT_RETRY))
20279       break;
20280   @}
20281 if (status == _XBEGIN_STARTED) 
20282   @{
20283     ... transaction code...
20284     _xend ();
20285   @} 
20286 else 
20287   @{
20288     ... non-transactional fallback path...
20289   @}
20290 @end smallexample
20292 @noindent
20293 Note that, in most cases, the transactional and non-transactional code
20294 must synchronize together to ensure consistency.
20296 @node Target Format Checks
20297 @section Format Checks Specific to Particular Target Machines
20299 For some target machines, GCC supports additional options to the
20300 format attribute
20301 (@pxref{Function Attributes,,Declaring Attributes of Functions}).
20303 @menu
20304 * Solaris Format Checks::
20305 * Darwin Format Checks::
20306 @end menu
20308 @node Solaris Format Checks
20309 @subsection Solaris Format Checks
20311 Solaris targets support the @code{cmn_err} (or @code{__cmn_err__}) format
20312 check.  @code{cmn_err} accepts a subset of the standard @code{printf}
20313 conversions, and the two-argument @code{%b} conversion for displaying
20314 bit-fields.  See the Solaris man page for @code{cmn_err} for more information.
20316 @node Darwin Format Checks
20317 @subsection Darwin Format Checks
20319 Darwin targets support the @code{CFString} (or @code{__CFString__}) in the format
20320 attribute context.  Declarations made with such attribution are parsed for correct syntax
20321 and format argument types.  However, parsing of the format string itself is currently undefined
20322 and is not carried out by this version of the compiler.
20324 Additionally, @code{CFStringRefs} (defined by the @code{CoreFoundation} headers) may
20325 also be used as format arguments.  Note that the relevant headers are only likely to be
20326 available on Darwin (OSX) installations.  On such installations, the XCode and system
20327 documentation provide descriptions of @code{CFString}, @code{CFStringRefs} and
20328 associated functions.
20330 @node Pragmas
20331 @section Pragmas Accepted by GCC
20332 @cindex pragmas
20333 @cindex @code{#pragma}
20335 GCC supports several types of pragmas, primarily in order to compile
20336 code originally written for other compilers.  Note that in general
20337 we do not recommend the use of pragmas; @xref{Function Attributes},
20338 for further explanation.
20340 @menu
20341 * AArch64 Pragmas::
20342 * ARM Pragmas::
20343 * M32C Pragmas::
20344 * MeP Pragmas::
20345 * RS/6000 and PowerPC Pragmas::
20346 * S/390 Pragmas::
20347 * Darwin Pragmas::
20348 * Solaris Pragmas::
20349 * Symbol-Renaming Pragmas::
20350 * Structure-Layout Pragmas::
20351 * Weak Pragmas::
20352 * Diagnostic Pragmas::
20353 * Visibility Pragmas::
20354 * Push/Pop Macro Pragmas::
20355 * Function Specific Option Pragmas::
20356 * Loop-Specific Pragmas::
20357 @end menu
20359 @node AArch64 Pragmas
20360 @subsection AArch64 Pragmas
20362 The pragmas defined by the AArch64 target correspond to the AArch64
20363 target function attributes.  They can be specified as below:
20364 @smallexample
20365 #pragma GCC target("string")
20366 @end smallexample
20368 where @code{@var{string}} can be any string accepted as an AArch64 target
20369 attribute.  @xref{AArch64 Function Attributes}, for more details
20370 on the permissible values of @code{string}.
20372 @node ARM Pragmas
20373 @subsection ARM Pragmas
20375 The ARM target defines pragmas for controlling the default addition of
20376 @code{long_call} and @code{short_call} attributes to functions.
20377 @xref{Function Attributes}, for information about the effects of these
20378 attributes.
20380 @table @code
20381 @item long_calls
20382 @cindex pragma, long_calls
20383 Set all subsequent functions to have the @code{long_call} attribute.
20385 @item no_long_calls
20386 @cindex pragma, no_long_calls
20387 Set all subsequent functions to have the @code{short_call} attribute.
20389 @item long_calls_off
20390 @cindex pragma, long_calls_off
20391 Do not affect the @code{long_call} or @code{short_call} attributes of
20392 subsequent functions.
20393 @end table
20395 @node M32C Pragmas
20396 @subsection M32C Pragmas
20398 @table @code
20399 @item GCC memregs @var{number}
20400 @cindex pragma, memregs
20401 Overrides the command-line option @code{-memregs=} for the current
20402 file.  Use with care!  This pragma must be before any function in the
20403 file, and mixing different memregs values in different objects may
20404 make them incompatible.  This pragma is useful when a
20405 performance-critical function uses a memreg for temporary values,
20406 as it may allow you to reduce the number of memregs used.
20408 @item ADDRESS @var{name} @var{address}
20409 @cindex pragma, address
20410 For any declared symbols matching @var{name}, this does three things
20411 to that symbol: it forces the symbol to be located at the given
20412 address (a number), it forces the symbol to be volatile, and it
20413 changes the symbol's scope to be static.  This pragma exists for
20414 compatibility with other compilers, but note that the common
20415 @code{1234H} numeric syntax is not supported (use @code{0x1234}
20416 instead).  Example:
20418 @smallexample
20419 #pragma ADDRESS port3 0x103
20420 char port3;
20421 @end smallexample
20423 @end table
20425 @node MeP Pragmas
20426 @subsection MeP Pragmas
20428 @table @code
20430 @item custom io_volatile (on|off)
20431 @cindex pragma, custom io_volatile
20432 Overrides the command-line option @code{-mio-volatile} for the current
20433 file.  Note that for compatibility with future GCC releases, this
20434 option should only be used once before any @code{io} variables in each
20435 file.
20437 @item GCC coprocessor available @var{registers}
20438 @cindex pragma, coprocessor available
20439 Specifies which coprocessor registers are available to the register
20440 allocator.  @var{registers} may be a single register, register range
20441 separated by ellipses, or comma-separated list of those.  Example:
20443 @smallexample
20444 #pragma GCC coprocessor available $c0...$c10, $c28
20445 @end smallexample
20447 @item GCC coprocessor call_saved @var{registers}
20448 @cindex pragma, coprocessor call_saved
20449 Specifies which coprocessor registers are to be saved and restored by
20450 any function using them.  @var{registers} may be a single register,
20451 register range separated by ellipses, or comma-separated list of
20452 those.  Example:
20454 @smallexample
20455 #pragma GCC coprocessor call_saved $c4...$c6, $c31
20456 @end smallexample
20458 @item GCC coprocessor subclass '(A|B|C|D)' = @var{registers}
20459 @cindex pragma, coprocessor subclass
20460 Creates and defines a register class.  These register classes can be
20461 used by inline @code{asm} constructs.  @var{registers} may be a single
20462 register, register range separated by ellipses, or comma-separated
20463 list of those.  Example:
20465 @smallexample
20466 #pragma GCC coprocessor subclass 'B' = $c2, $c4, $c6
20468 asm ("cpfoo %0" : "=B" (x));
20469 @end smallexample
20471 @item GCC disinterrupt @var{name} , @var{name} @dots{}
20472 @cindex pragma, disinterrupt
20473 For the named functions, the compiler adds code to disable interrupts
20474 for the duration of those functions.  If any functions so named 
20475 are not encountered in the source, a warning is emitted that the pragma is
20476 not used.  Examples:
20478 @smallexample
20479 #pragma disinterrupt foo
20480 #pragma disinterrupt bar, grill
20481 int foo () @{ @dots{} @}
20482 @end smallexample
20484 @item GCC call @var{name} , @var{name} @dots{}
20485 @cindex pragma, call
20486 For the named functions, the compiler always uses a register-indirect
20487 call model when calling the named functions.  Examples:
20489 @smallexample
20490 extern int foo ();
20491 #pragma call foo
20492 @end smallexample
20494 @end table
20496 @node RS/6000 and PowerPC Pragmas
20497 @subsection RS/6000 and PowerPC Pragmas
20499 The RS/6000 and PowerPC targets define one pragma for controlling
20500 whether or not the @code{longcall} attribute is added to function
20501 declarations by default.  This pragma overrides the @option{-mlongcall}
20502 option, but not the @code{longcall} and @code{shortcall} attributes.
20503 @xref{RS/6000 and PowerPC Options}, for more information about when long
20504 calls are and are not necessary.
20506 @table @code
20507 @item longcall (1)
20508 @cindex pragma, longcall
20509 Apply the @code{longcall} attribute to all subsequent function
20510 declarations.
20512 @item longcall (0)
20513 Do not apply the @code{longcall} attribute to subsequent function
20514 declarations.
20515 @end table
20517 @c Describe h8300 pragmas here.
20518 @c Describe sh pragmas here.
20519 @c Describe v850 pragmas here.
20521 @node S/390 Pragmas
20522 @subsection S/390 Pragmas
20524 The pragmas defined by the S/390 target correspond to the S/390
20525 target function attributes and some the additional options:
20527 @table @samp
20528 @item zvector
20529 @itemx no-zvector
20530 @end table
20532 Note that options of the pragma, unlike options of the target
20533 attribute, do change the value of preprocessor macros like
20534 @code{__VEC__}.  They can be specified as below:
20536 @smallexample
20537 #pragma GCC target("string[,string]...")
20538 #pragma GCC target("string"[,"string"]...)
20539 @end smallexample
20541 @node Darwin Pragmas
20542 @subsection Darwin Pragmas
20544 The following pragmas are available for all architectures running the
20545 Darwin operating system.  These are useful for compatibility with other
20546 Mac OS compilers.
20548 @table @code
20549 @item mark @var{tokens}@dots{}
20550 @cindex pragma, mark
20551 This pragma is accepted, but has no effect.
20553 @item options align=@var{alignment}
20554 @cindex pragma, options align
20555 This pragma sets the alignment of fields in structures.  The values of
20556 @var{alignment} may be @code{mac68k}, to emulate m68k alignment, or
20557 @code{power}, to emulate PowerPC alignment.  Uses of this pragma nest
20558 properly; to restore the previous setting, use @code{reset} for the
20559 @var{alignment}.
20561 @item segment @var{tokens}@dots{}
20562 @cindex pragma, segment
20563 This pragma is accepted, but has no effect.
20565 @item unused (@var{var} [, @var{var}]@dots{})
20566 @cindex pragma, unused
20567 This pragma declares variables to be possibly unused.  GCC does not
20568 produce warnings for the listed variables.  The effect is similar to
20569 that of the @code{unused} attribute, except that this pragma may appear
20570 anywhere within the variables' scopes.
20571 @end table
20573 @node Solaris Pragmas
20574 @subsection Solaris Pragmas
20576 The Solaris target supports @code{#pragma redefine_extname}
20577 (@pxref{Symbol-Renaming Pragmas}).  It also supports additional
20578 @code{#pragma} directives for compatibility with the system compiler.
20580 @table @code
20581 @item align @var{alignment} (@var{variable} [, @var{variable}]...)
20582 @cindex pragma, align
20584 Increase the minimum alignment of each @var{variable} to @var{alignment}.
20585 This is the same as GCC's @code{aligned} attribute @pxref{Variable
20586 Attributes}).  Macro expansion occurs on the arguments to this pragma
20587 when compiling C and Objective-C@.  It does not currently occur when
20588 compiling C++, but this is a bug which may be fixed in a future
20589 release.
20591 @item fini (@var{function} [, @var{function}]...)
20592 @cindex pragma, fini
20594 This pragma causes each listed @var{function} to be called after
20595 main, or during shared module unloading, by adding a call to the
20596 @code{.fini} section.
20598 @item init (@var{function} [, @var{function}]...)
20599 @cindex pragma, init
20601 This pragma causes each listed @var{function} to be called during
20602 initialization (before @code{main}) or during shared module loading, by
20603 adding a call to the @code{.init} section.
20605 @end table
20607 @node Symbol-Renaming Pragmas
20608 @subsection Symbol-Renaming Pragmas
20610 GCC supports a @code{#pragma} directive that changes the name used in
20611 assembly for a given declaration. While this pragma is supported on all
20612 platforms, it is intended primarily to provide compatibility with the
20613 Solaris system headers. This effect can also be achieved using the asm
20614 labels extension (@pxref{Asm Labels}).
20616 @table @code
20617 @item redefine_extname @var{oldname} @var{newname}
20618 @cindex pragma, redefine_extname
20620 This pragma gives the C function @var{oldname} the assembly symbol
20621 @var{newname}.  The preprocessor macro @code{__PRAGMA_REDEFINE_EXTNAME}
20622 is defined if this pragma is available (currently on all platforms).
20623 @end table
20625 This pragma and the asm labels extension interact in a complicated
20626 manner.  Here are some corner cases you may want to be aware of:
20628 @enumerate
20629 @item This pragma silently applies only to declarations with external
20630 linkage.  Asm labels do not have this restriction.
20632 @item In C++, this pragma silently applies only to declarations with
20633 ``C'' linkage.  Again, asm labels do not have this restriction.
20635 @item If either of the ways of changing the assembly name of a
20636 declaration are applied to a declaration whose assembly name has
20637 already been determined (either by a previous use of one of these
20638 features, or because the compiler needed the assembly name in order to
20639 generate code), and the new name is different, a warning issues and
20640 the name does not change.
20642 @item The @var{oldname} used by @code{#pragma redefine_extname} is
20643 always the C-language name.
20644 @end enumerate
20646 @node Structure-Layout Pragmas
20647 @subsection Structure-Layout Pragmas
20649 For compatibility with Microsoft Windows compilers, GCC supports a
20650 set of @code{#pragma} directives that change the maximum alignment of
20651 members of structures (other than zero-width bit-fields), unions, and
20652 classes subsequently defined. The @var{n} value below always is required
20653 to be a small power of two and specifies the new alignment in bytes.
20655 @enumerate
20656 @item @code{#pragma pack(@var{n})} simply sets the new alignment.
20657 @item @code{#pragma pack()} sets the alignment to the one that was in
20658 effect when compilation started (see also command-line option
20659 @option{-fpack-struct[=@var{n}]} @pxref{Code Gen Options}).
20660 @item @code{#pragma pack(push[,@var{n}])} pushes the current alignment
20661 setting on an internal stack and then optionally sets the new alignment.
20662 @item @code{#pragma pack(pop)} restores the alignment setting to the one
20663 saved at the top of the internal stack (and removes that stack entry).
20664 Note that @code{#pragma pack([@var{n}])} does not influence this internal
20665 stack; thus it is possible to have @code{#pragma pack(push)} followed by
20666 multiple @code{#pragma pack(@var{n})} instances and finalized by a single
20667 @code{#pragma pack(pop)}.
20668 @end enumerate
20670 Some targets, e.g.@: x86 and PowerPC, support the @code{#pragma ms_struct}
20671 directive which lays out structures and unions subsequently defined as the
20672 documented @code{__attribute__ ((ms_struct))}.
20674 @enumerate
20675 @item @code{#pragma ms_struct on} turns on the Microsoft layout.
20676 @item @code{#pragma ms_struct off} turns off the Microsoft layout.
20677 @item @code{#pragma ms_struct reset} goes back to the default layout.
20678 @end enumerate
20680 Most targets also support the @code{#pragma scalar_storage_order} directive
20681 which lays out structures and unions subsequently defined as the documented
20682 @code{__attribute__ ((scalar_storage_order))}.
20684 @enumerate
20685 @item @code{#pragma scalar_storage_order big-endian} sets the storage order
20686 of the scalar fields to big-endian.
20687 @item @code{#pragma scalar_storage_order little-endian} sets the storage order
20688 of the scalar fields to little-endian.
20689 @item @code{#pragma scalar_storage_order default} goes back to the endianness
20690 that was in effect when compilation started (see also command-line option
20691 @option{-fsso-struct=@var{endianness}} @pxref{C Dialect Options}).
20692 @end enumerate
20694 @node Weak Pragmas
20695 @subsection Weak Pragmas
20697 For compatibility with SVR4, GCC supports a set of @code{#pragma}
20698 directives for declaring symbols to be weak, and defining weak
20699 aliases.
20701 @table @code
20702 @item #pragma weak @var{symbol}
20703 @cindex pragma, weak
20704 This pragma declares @var{symbol} to be weak, as if the declaration
20705 had the attribute of the same name.  The pragma may appear before
20706 or after the declaration of @var{symbol}.  It is not an error for
20707 @var{symbol} to never be defined at all.
20709 @item #pragma weak @var{symbol1} = @var{symbol2}
20710 This pragma declares @var{symbol1} to be a weak alias of @var{symbol2}.
20711 It is an error if @var{symbol2} is not defined in the current
20712 translation unit.
20713 @end table
20715 @node Diagnostic Pragmas
20716 @subsection Diagnostic Pragmas
20718 GCC allows the user to selectively enable or disable certain types of
20719 diagnostics, and change the kind of the diagnostic.  For example, a
20720 project's policy might require that all sources compile with
20721 @option{-Werror} but certain files might have exceptions allowing
20722 specific types of warnings.  Or, a project might selectively enable
20723 diagnostics and treat them as errors depending on which preprocessor
20724 macros are defined.
20726 @table @code
20727 @item #pragma GCC diagnostic @var{kind} @var{option}
20728 @cindex pragma, diagnostic
20730 Modifies the disposition of a diagnostic.  Note that not all
20731 diagnostics are modifiable; at the moment only warnings (normally
20732 controlled by @samp{-W@dots{}}) can be controlled, and not all of them.
20733 Use @option{-fdiagnostics-show-option} to determine which diagnostics
20734 are controllable and which option controls them.
20736 @var{kind} is @samp{error} to treat this diagnostic as an error,
20737 @samp{warning} to treat it like a warning (even if @option{-Werror} is
20738 in effect), or @samp{ignored} if the diagnostic is to be ignored.
20739 @var{option} is a double quoted string that matches the command-line
20740 option.
20742 @smallexample
20743 #pragma GCC diagnostic warning "-Wformat"
20744 #pragma GCC diagnostic error "-Wformat"
20745 #pragma GCC diagnostic ignored "-Wformat"
20746 @end smallexample
20748 Note that these pragmas override any command-line options.  GCC keeps
20749 track of the location of each pragma, and issues diagnostics according
20750 to the state as of that point in the source file.  Thus, pragmas occurring
20751 after a line do not affect diagnostics caused by that line.
20753 @item #pragma GCC diagnostic push
20754 @itemx #pragma GCC diagnostic pop
20756 Causes GCC to remember the state of the diagnostics as of each
20757 @code{push}, and restore to that point at each @code{pop}.  If a
20758 @code{pop} has no matching @code{push}, the command-line options are
20759 restored.
20761 @smallexample
20762 #pragma GCC diagnostic error "-Wuninitialized"
20763   foo(a);                       /* error is given for this one */
20764 #pragma GCC diagnostic push
20765 #pragma GCC diagnostic ignored "-Wuninitialized"
20766   foo(b);                       /* no diagnostic for this one */
20767 #pragma GCC diagnostic pop
20768   foo(c);                       /* error is given for this one */
20769 #pragma GCC diagnostic pop
20770   foo(d);                       /* depends on command-line options */
20771 @end smallexample
20773 @end table
20775 GCC also offers a simple mechanism for printing messages during
20776 compilation.
20778 @table @code
20779 @item #pragma message @var{string}
20780 @cindex pragma, diagnostic
20782 Prints @var{string} as a compiler message on compilation.  The message
20783 is informational only, and is neither a compilation warning nor an error.
20785 @smallexample
20786 #pragma message "Compiling " __FILE__ "..."
20787 @end smallexample
20789 @var{string} may be parenthesized, and is printed with location
20790 information.  For example,
20792 @smallexample
20793 #define DO_PRAGMA(x) _Pragma (#x)
20794 #define TODO(x) DO_PRAGMA(message ("TODO - " #x))
20796 TODO(Remember to fix this)
20797 @end smallexample
20799 @noindent
20800 prints @samp{/tmp/file.c:4: note: #pragma message:
20801 TODO - Remember to fix this}.
20803 @end table
20805 @node Visibility Pragmas
20806 @subsection Visibility Pragmas
20808 @table @code
20809 @item #pragma GCC visibility push(@var{visibility})
20810 @itemx #pragma GCC visibility pop
20811 @cindex pragma, visibility
20813 This pragma allows the user to set the visibility for multiple
20814 declarations without having to give each a visibility attribute
20815 (@pxref{Function Attributes}).
20817 In C++, @samp{#pragma GCC visibility} affects only namespace-scope
20818 declarations.  Class members and template specializations are not
20819 affected; if you want to override the visibility for a particular
20820 member or instantiation, you must use an attribute.
20822 @end table
20825 @node Push/Pop Macro Pragmas
20826 @subsection Push/Pop Macro Pragmas
20828 For compatibility with Microsoft Windows compilers, GCC supports
20829 @samp{#pragma push_macro(@var{"macro_name"})}
20830 and @samp{#pragma pop_macro(@var{"macro_name"})}.
20832 @table @code
20833 @item #pragma push_macro(@var{"macro_name"})
20834 @cindex pragma, push_macro
20835 This pragma saves the value of the macro named as @var{macro_name} to
20836 the top of the stack for this macro.
20838 @item #pragma pop_macro(@var{"macro_name"})
20839 @cindex pragma, pop_macro
20840 This pragma sets the value of the macro named as @var{macro_name} to
20841 the value on top of the stack for this macro. If the stack for
20842 @var{macro_name} is empty, the value of the macro remains unchanged.
20843 @end table
20845 For example:
20847 @smallexample
20848 #define X  1
20849 #pragma push_macro("X")
20850 #undef X
20851 #define X -1
20852 #pragma pop_macro("X")
20853 int x [X];
20854 @end smallexample
20856 @noindent
20857 In this example, the definition of X as 1 is saved by @code{#pragma
20858 push_macro} and restored by @code{#pragma pop_macro}.
20860 @node Function Specific Option Pragmas
20861 @subsection Function Specific Option Pragmas
20863 @table @code
20864 @item #pragma GCC target (@var{"string"}...)
20865 @cindex pragma GCC target
20867 This pragma allows you to set target specific options for functions
20868 defined later in the source file.  One or more strings can be
20869 specified.  Each function that is defined after this point is as
20870 if @code{attribute((target("STRING")))} was specified for that
20871 function.  The parenthesis around the options is optional.
20872 @xref{Function Attributes}, for more information about the
20873 @code{target} attribute and the attribute syntax.
20875 The @code{#pragma GCC target} pragma is presently implemented for
20876 x86, PowerPC, and Nios II targets only.
20877 @end table
20879 @table @code
20880 @item #pragma GCC optimize (@var{"string"}...)
20881 @cindex pragma GCC optimize
20883 This pragma allows you to set global optimization options for functions
20884 defined later in the source file.  One or more strings can be
20885 specified.  Each function that is defined after this point is as
20886 if @code{attribute((optimize("STRING")))} was specified for that
20887 function.  The parenthesis around the options is optional.
20888 @xref{Function Attributes}, for more information about the
20889 @code{optimize} attribute and the attribute syntax.
20890 @end table
20892 @table @code
20893 @item #pragma GCC push_options
20894 @itemx #pragma GCC pop_options
20895 @cindex pragma GCC push_options
20896 @cindex pragma GCC pop_options
20898 These pragmas maintain a stack of the current target and optimization
20899 options.  It is intended for include files where you temporarily want
20900 to switch to using a different @samp{#pragma GCC target} or
20901 @samp{#pragma GCC optimize} and then to pop back to the previous
20902 options.
20903 @end table
20905 @table @code
20906 @item #pragma GCC reset_options
20907 @cindex pragma GCC reset_options
20909 This pragma clears the current @code{#pragma GCC target} and
20910 @code{#pragma GCC optimize} to use the default switches as specified
20911 on the command line.
20912 @end table
20914 @node Loop-Specific Pragmas
20915 @subsection Loop-Specific Pragmas
20917 @table @code
20918 @item #pragma GCC ivdep
20919 @cindex pragma GCC ivdep
20920 @end table
20922 With this pragma, the programmer asserts that there are no loop-carried
20923 dependencies which would prevent consecutive iterations of
20924 the following loop from executing concurrently with SIMD
20925 (single instruction multiple data) instructions.
20927 For example, the compiler can only unconditionally vectorize the following
20928 loop with the pragma:
20930 @smallexample
20931 void foo (int n, int *a, int *b, int *c)
20933   int i, j;
20934 #pragma GCC ivdep
20935   for (i = 0; i < n; ++i)
20936     a[i] = b[i] + c[i];
20938 @end smallexample
20940 @noindent
20941 In this example, using the @code{restrict} qualifier had the same
20942 effect. In the following example, that would not be possible. Assume
20943 @math{k < -m} or @math{k >= m}. Only with the pragma, the compiler knows
20944 that it can unconditionally vectorize the following loop:
20946 @smallexample
20947 void ignore_vec_dep (int *a, int k, int c, int m)
20949 #pragma GCC ivdep
20950   for (int i = 0; i < m; i++)
20951     a[i] = a[i + k] * c;
20953 @end smallexample
20956 @node Unnamed Fields
20957 @section Unnamed Structure and Union Fields
20958 @cindex @code{struct}
20959 @cindex @code{union}
20961 As permitted by ISO C11 and for compatibility with other compilers,
20962 GCC allows you to define
20963 a structure or union that contains, as fields, structures and unions
20964 without names.  For example:
20966 @smallexample
20967 struct @{
20968   int a;
20969   union @{
20970     int b;
20971     float c;
20972   @};
20973   int d;
20974 @} foo;
20975 @end smallexample
20977 @noindent
20978 In this example, you are able to access members of the unnamed
20979 union with code like @samp{foo.b}.  Note that only unnamed structs and
20980 unions are allowed, you may not have, for example, an unnamed
20981 @code{int}.
20983 You must never create such structures that cause ambiguous field definitions.
20984 For example, in this structure:
20986 @smallexample
20987 struct @{
20988   int a;
20989   struct @{
20990     int a;
20991   @};
20992 @} foo;
20993 @end smallexample
20995 @noindent
20996 it is ambiguous which @code{a} is being referred to with @samp{foo.a}.
20997 The compiler gives errors for such constructs.
20999 @opindex fms-extensions
21000 Unless @option{-fms-extensions} is used, the unnamed field must be a
21001 structure or union definition without a tag (for example, @samp{struct
21002 @{ int a; @};}).  If @option{-fms-extensions} is used, the field may
21003 also be a definition with a tag such as @samp{struct foo @{ int a;
21004 @};}, a reference to a previously defined structure or union such as
21005 @samp{struct foo;}, or a reference to a @code{typedef} name for a
21006 previously defined structure or union type.
21008 @opindex fplan9-extensions
21009 The option @option{-fplan9-extensions} enables
21010 @option{-fms-extensions} as well as two other extensions.  First, a
21011 pointer to a structure is automatically converted to a pointer to an
21012 anonymous field for assignments and function calls.  For example:
21014 @smallexample
21015 struct s1 @{ int a; @};
21016 struct s2 @{ struct s1; @};
21017 extern void f1 (struct s1 *);
21018 void f2 (struct s2 *p) @{ f1 (p); @}
21019 @end smallexample
21021 @noindent
21022 In the call to @code{f1} inside @code{f2}, the pointer @code{p} is
21023 converted into a pointer to the anonymous field.
21025 Second, when the type of an anonymous field is a @code{typedef} for a
21026 @code{struct} or @code{union}, code may refer to the field using the
21027 name of the @code{typedef}.
21029 @smallexample
21030 typedef struct @{ int a; @} s1;
21031 struct s2 @{ s1; @};
21032 s1 f1 (struct s2 *p) @{ return p->s1; @}
21033 @end smallexample
21035 These usages are only permitted when they are not ambiguous.
21037 @node Thread-Local
21038 @section Thread-Local Storage
21039 @cindex Thread-Local Storage
21040 @cindex @acronym{TLS}
21041 @cindex @code{__thread}
21043 Thread-local storage (@acronym{TLS}) is a mechanism by which variables
21044 are allocated such that there is one instance of the variable per extant
21045 thread.  The runtime model GCC uses to implement this originates
21046 in the IA-64 processor-specific ABI, but has since been migrated
21047 to other processors as well.  It requires significant support from
21048 the linker (@command{ld}), dynamic linker (@command{ld.so}), and
21049 system libraries (@file{libc.so} and @file{libpthread.so}), so it
21050 is not available everywhere.
21052 At the user level, the extension is visible with a new storage
21053 class keyword: @code{__thread}.  For example:
21055 @smallexample
21056 __thread int i;
21057 extern __thread struct state s;
21058 static __thread char *p;
21059 @end smallexample
21061 The @code{__thread} specifier may be used alone, with the @code{extern}
21062 or @code{static} specifiers, but with no other storage class specifier.
21063 When used with @code{extern} or @code{static}, @code{__thread} must appear
21064 immediately after the other storage class specifier.
21066 The @code{__thread} specifier may be applied to any global, file-scoped
21067 static, function-scoped static, or static data member of a class.  It may
21068 not be applied to block-scoped automatic or non-static data member.
21070 When the address-of operator is applied to a thread-local variable, it is
21071 evaluated at run time and returns the address of the current thread's
21072 instance of that variable.  An address so obtained may be used by any
21073 thread.  When a thread terminates, any pointers to thread-local variables
21074 in that thread become invalid.
21076 No static initialization may refer to the address of a thread-local variable.
21078 In C++, if an initializer is present for a thread-local variable, it must
21079 be a @var{constant-expression}, as defined in 5.19.2 of the ANSI/ISO C++
21080 standard.
21082 See @uref{http://www.akkadia.org/drepper/tls.pdf,
21083 ELF Handling For Thread-Local Storage} for a detailed explanation of
21084 the four thread-local storage addressing models, and how the runtime
21085 is expected to function.
21087 @menu
21088 * C99 Thread-Local Edits::
21089 * C++98 Thread-Local Edits::
21090 @end menu
21092 @node C99 Thread-Local Edits
21093 @subsection ISO/IEC 9899:1999 Edits for Thread-Local Storage
21095 The following are a set of changes to ISO/IEC 9899:1999 (aka C99)
21096 that document the exact semantics of the language extension.
21098 @itemize @bullet
21099 @item
21100 @cite{5.1.2  Execution environments}
21102 Add new text after paragraph 1
21104 @quotation
21105 Within either execution environment, a @dfn{thread} is a flow of
21106 control within a program.  It is implementation defined whether
21107 or not there may be more than one thread associated with a program.
21108 It is implementation defined how threads beyond the first are
21109 created, the name and type of the function called at thread
21110 startup, and how threads may be terminated.  However, objects
21111 with thread storage duration shall be initialized before thread
21112 startup.
21113 @end quotation
21115 @item
21116 @cite{6.2.4  Storage durations of objects}
21118 Add new text before paragraph 3
21120 @quotation
21121 An object whose identifier is declared with the storage-class
21122 specifier @w{@code{__thread}} has @dfn{thread storage duration}.
21123 Its lifetime is the entire execution of the thread, and its
21124 stored value is initialized only once, prior to thread startup.
21125 @end quotation
21127 @item
21128 @cite{6.4.1  Keywords}
21130 Add @code{__thread}.
21132 @item
21133 @cite{6.7.1  Storage-class specifiers}
21135 Add @code{__thread} to the list of storage class specifiers in
21136 paragraph 1.
21138 Change paragraph 2 to
21140 @quotation
21141 With the exception of @code{__thread}, at most one storage-class
21142 specifier may be given [@dots{}].  The @code{__thread} specifier may
21143 be used alone, or immediately following @code{extern} or
21144 @code{static}.
21145 @end quotation
21147 Add new text after paragraph 6
21149 @quotation
21150 The declaration of an identifier for a variable that has
21151 block scope that specifies @code{__thread} shall also
21152 specify either @code{extern} or @code{static}.
21154 The @code{__thread} specifier shall be used only with
21155 variables.
21156 @end quotation
21157 @end itemize
21159 @node C++98 Thread-Local Edits
21160 @subsection ISO/IEC 14882:1998 Edits for Thread-Local Storage
21162 The following are a set of changes to ISO/IEC 14882:1998 (aka C++98)
21163 that document the exact semantics of the language extension.
21165 @itemize @bullet
21166 @item
21167 @b{[intro.execution]}
21169 New text after paragraph 4
21171 @quotation
21172 A @dfn{thread} is a flow of control within the abstract machine.
21173 It is implementation defined whether or not there may be more than
21174 one thread.
21175 @end quotation
21177 New text after paragraph 7
21179 @quotation
21180 It is unspecified whether additional action must be taken to
21181 ensure when and whether side effects are visible to other threads.
21182 @end quotation
21184 @item
21185 @b{[lex.key]}
21187 Add @code{__thread}.
21189 @item
21190 @b{[basic.start.main]}
21192 Add after paragraph 5
21194 @quotation
21195 The thread that begins execution at the @code{main} function is called
21196 the @dfn{main thread}.  It is implementation defined how functions
21197 beginning threads other than the main thread are designated or typed.
21198 A function so designated, as well as the @code{main} function, is called
21199 a @dfn{thread startup function}.  It is implementation defined what
21200 happens if a thread startup function returns.  It is implementation
21201 defined what happens to other threads when any thread calls @code{exit}.
21202 @end quotation
21204 @item
21205 @b{[basic.start.init]}
21207 Add after paragraph 4
21209 @quotation
21210 The storage for an object of thread storage duration shall be
21211 statically initialized before the first statement of the thread startup
21212 function.  An object of thread storage duration shall not require
21213 dynamic initialization.
21214 @end quotation
21216 @item
21217 @b{[basic.start.term]}
21219 Add after paragraph 3
21221 @quotation
21222 The type of an object with thread storage duration shall not have a
21223 non-trivial destructor, nor shall it be an array type whose elements
21224 (directly or indirectly) have non-trivial destructors.
21225 @end quotation
21227 @item
21228 @b{[basic.stc]}
21230 Add ``thread storage duration'' to the list in paragraph 1.
21232 Change paragraph 2
21234 @quotation
21235 Thread, static, and automatic storage durations are associated with
21236 objects introduced by declarations [@dots{}].
21237 @end quotation
21239 Add @code{__thread} to the list of specifiers in paragraph 3.
21241 @item
21242 @b{[basic.stc.thread]}
21244 New section before @b{[basic.stc.static]}
21246 @quotation
21247 The keyword @code{__thread} applied to a non-local object gives the
21248 object thread storage duration.
21250 A local variable or class data member declared both @code{static}
21251 and @code{__thread} gives the variable or member thread storage
21252 duration.
21253 @end quotation
21255 @item
21256 @b{[basic.stc.static]}
21258 Change paragraph 1
21260 @quotation
21261 All objects that have neither thread storage duration, dynamic
21262 storage duration nor are local [@dots{}].
21263 @end quotation
21265 @item
21266 @b{[dcl.stc]}
21268 Add @code{__thread} to the list in paragraph 1.
21270 Change paragraph 1
21272 @quotation
21273 With the exception of @code{__thread}, at most one
21274 @var{storage-class-specifier} shall appear in a given
21275 @var{decl-specifier-seq}.  The @code{__thread} specifier may
21276 be used alone, or immediately following the @code{extern} or
21277 @code{static} specifiers.  [@dots{}]
21278 @end quotation
21280 Add after paragraph 5
21282 @quotation
21283 The @code{__thread} specifier can be applied only to the names of objects
21284 and to anonymous unions.
21285 @end quotation
21287 @item
21288 @b{[class.mem]}
21290 Add after paragraph 6
21292 @quotation
21293 Non-@code{static} members shall not be @code{__thread}.
21294 @end quotation
21295 @end itemize
21297 @node Binary constants
21298 @section Binary Constants using the @samp{0b} Prefix
21299 @cindex Binary constants using the @samp{0b} prefix
21301 Integer constants can be written as binary constants, consisting of a
21302 sequence of @samp{0} and @samp{1} digits, prefixed by @samp{0b} or
21303 @samp{0B}.  This is particularly useful in environments that operate a
21304 lot on the bit level (like microcontrollers).
21306 The following statements are identical:
21308 @smallexample
21309 i =       42;
21310 i =     0x2a;
21311 i =      052;
21312 i = 0b101010;
21313 @end smallexample
21315 The type of these constants follows the same rules as for octal or
21316 hexadecimal integer constants, so suffixes like @samp{L} or @samp{UL}
21317 can be applied.
21319 @node C++ Extensions
21320 @chapter Extensions to the C++ Language
21321 @cindex extensions, C++ language
21322 @cindex C++ language extensions
21324 The GNU compiler provides these extensions to the C++ language (and you
21325 can also use most of the C language extensions in your C++ programs).  If you
21326 want to write code that checks whether these features are available, you can
21327 test for the GNU compiler the same way as for C programs: check for a
21328 predefined macro @code{__GNUC__}.  You can also use @code{__GNUG__} to
21329 test specifically for GNU C++ (@pxref{Common Predefined Macros,,
21330 Predefined Macros,cpp,The GNU C Preprocessor}).
21332 @menu
21333 * C++ Volatiles::       What constitutes an access to a volatile object.
21334 * Restricted Pointers:: C99 restricted pointers and references.
21335 * Vague Linkage::       Where G++ puts inlines, vtables and such.
21336 * C++ Interface::       You can use a single C++ header file for both
21337                         declarations and definitions.
21338 * Template Instantiation:: Methods for ensuring that exactly one copy of
21339                         each needed template instantiation is emitted.
21340 * Bound member functions:: You can extract a function pointer to the
21341                         method denoted by a @samp{->*} or @samp{.*} expression.
21342 * C++ Attributes::      Variable, function, and type attributes for C++ only.
21343 * Function Multiversioning::   Declaring multiple function versions.
21344 * Namespace Association:: Strong using-directives for namespace association.
21345 * Type Traits::         Compiler support for type traits.
21346 * C++ Concepts::        Improved support for generic programming.
21347 * Java Exceptions::     Tweaking exception handling to work with Java.
21348 * Deprecated Features:: Things will disappear from G++.
21349 * Backwards Compatibility:: Compatibilities with earlier definitions of C++.
21350 @end menu
21352 @node C++ Volatiles
21353 @section When is a Volatile C++ Object Accessed?
21354 @cindex accessing volatiles
21355 @cindex volatile read
21356 @cindex volatile write
21357 @cindex volatile access
21359 The C++ standard differs from the C standard in its treatment of
21360 volatile objects.  It fails to specify what constitutes a volatile
21361 access, except to say that C++ should behave in a similar manner to C
21362 with respect to volatiles, where possible.  However, the different
21363 lvalueness of expressions between C and C++ complicate the behavior.
21364 G++ behaves the same as GCC for volatile access, @xref{C
21365 Extensions,,Volatiles}, for a description of GCC's behavior.
21367 The C and C++ language specifications differ when an object is
21368 accessed in a void context:
21370 @smallexample
21371 volatile int *src = @var{somevalue};
21372 *src;
21373 @end smallexample
21375 The C++ standard specifies that such expressions do not undergo lvalue
21376 to rvalue conversion, and that the type of the dereferenced object may
21377 be incomplete.  The C++ standard does not specify explicitly that it
21378 is lvalue to rvalue conversion that is responsible for causing an
21379 access.  There is reason to believe that it is, because otherwise
21380 certain simple expressions become undefined.  However, because it
21381 would surprise most programmers, G++ treats dereferencing a pointer to
21382 volatile object of complete type as GCC would do for an equivalent
21383 type in C@.  When the object has incomplete type, G++ issues a
21384 warning; if you wish to force an error, you must force a conversion to
21385 rvalue with, for instance, a static cast.
21387 When using a reference to volatile, G++ does not treat equivalent
21388 expressions as accesses to volatiles, but instead issues a warning that
21389 no volatile is accessed.  The rationale for this is that otherwise it
21390 becomes difficult to determine where volatile access occur, and not
21391 possible to ignore the return value from functions returning volatile
21392 references.  Again, if you wish to force a read, cast the reference to
21393 an rvalue.
21395 G++ implements the same behavior as GCC does when assigning to a
21396 volatile object---there is no reread of the assigned-to object, the
21397 assigned rvalue is reused.  Note that in C++ assignment expressions
21398 are lvalues, and if used as an lvalue, the volatile object is
21399 referred to.  For instance, @var{vref} refers to @var{vobj}, as
21400 expected, in the following example:
21402 @smallexample
21403 volatile int vobj;
21404 volatile int &vref = vobj = @var{something};
21405 @end smallexample
21407 @node Restricted Pointers
21408 @section Restricting Pointer Aliasing
21409 @cindex restricted pointers
21410 @cindex restricted references
21411 @cindex restricted this pointer
21413 As with the C front end, G++ understands the C99 feature of restricted pointers,
21414 specified with the @code{__restrict__}, or @code{__restrict} type
21415 qualifier.  Because you cannot compile C++ by specifying the @option{-std=c99}
21416 language flag, @code{restrict} is not a keyword in C++.
21418 In addition to allowing restricted pointers, you can specify restricted
21419 references, which indicate that the reference is not aliased in the local
21420 context.
21422 @smallexample
21423 void fn (int *__restrict__ rptr, int &__restrict__ rref)
21425   /* @r{@dots{}} */
21427 @end smallexample
21429 @noindent
21430 In the body of @code{fn}, @var{rptr} points to an unaliased integer and
21431 @var{rref} refers to a (different) unaliased integer.
21433 You may also specify whether a member function's @var{this} pointer is
21434 unaliased by using @code{__restrict__} as a member function qualifier.
21436 @smallexample
21437 void T::fn () __restrict__
21439   /* @r{@dots{}} */
21441 @end smallexample
21443 @noindent
21444 Within the body of @code{T::fn}, @var{this} has the effective
21445 definition @code{T *__restrict__ const this}.  Notice that the
21446 interpretation of a @code{__restrict__} member function qualifier is
21447 different to that of @code{const} or @code{volatile} qualifier, in that it
21448 is applied to the pointer rather than the object.  This is consistent with
21449 other compilers that implement restricted pointers.
21451 As with all outermost parameter qualifiers, @code{__restrict__} is
21452 ignored in function definition matching.  This means you only need to
21453 specify @code{__restrict__} in a function definition, rather than
21454 in a function prototype as well.
21456 @node Vague Linkage
21457 @section Vague Linkage
21458 @cindex vague linkage
21460 There are several constructs in C++ that require space in the object
21461 file but are not clearly tied to a single translation unit.  We say that
21462 these constructs have ``vague linkage''.  Typically such constructs are
21463 emitted wherever they are needed, though sometimes we can be more
21464 clever.
21466 @table @asis
21467 @item Inline Functions
21468 Inline functions are typically defined in a header file which can be
21469 included in many different compilations.  Hopefully they can usually be
21470 inlined, but sometimes an out-of-line copy is necessary, if the address
21471 of the function is taken or if inlining fails.  In general, we emit an
21472 out-of-line copy in all translation units where one is needed.  As an
21473 exception, we only emit inline virtual functions with the vtable, since
21474 it always requires a copy.
21476 Local static variables and string constants used in an inline function
21477 are also considered to have vague linkage, since they must be shared
21478 between all inlined and out-of-line instances of the function.
21480 @item VTables
21481 @cindex vtable
21482 C++ virtual functions are implemented in most compilers using a lookup
21483 table, known as a vtable.  The vtable contains pointers to the virtual
21484 functions provided by a class, and each object of the class contains a
21485 pointer to its vtable (or vtables, in some multiple-inheritance
21486 situations).  If the class declares any non-inline, non-pure virtual
21487 functions, the first one is chosen as the ``key method'' for the class,
21488 and the vtable is only emitted in the translation unit where the key
21489 method is defined.
21491 @emph{Note:} If the chosen key method is later defined as inline, the
21492 vtable is still emitted in every translation unit that defines it.
21493 Make sure that any inline virtuals are declared inline in the class
21494 body, even if they are not defined there.
21496 @item @code{type_info} objects
21497 @cindex @code{type_info}
21498 @cindex RTTI
21499 C++ requires information about types to be written out in order to
21500 implement @samp{dynamic_cast}, @samp{typeid} and exception handling.
21501 For polymorphic classes (classes with virtual functions), the @samp{type_info}
21502 object is written out along with the vtable so that @samp{dynamic_cast}
21503 can determine the dynamic type of a class object at run time.  For all
21504 other types, we write out the @samp{type_info} object when it is used: when
21505 applying @samp{typeid} to an expression, throwing an object, or
21506 referring to a type in a catch clause or exception specification.
21508 @item Template Instantiations
21509 Most everything in this section also applies to template instantiations,
21510 but there are other options as well.
21511 @xref{Template Instantiation,,Where's the Template?}.
21513 @end table
21515 When used with GNU ld version 2.8 or later on an ELF system such as
21516 GNU/Linux or Solaris 2, or on Microsoft Windows, duplicate copies of
21517 these constructs will be discarded at link time.  This is known as
21518 COMDAT support.
21520 On targets that don't support COMDAT, but do support weak symbols, GCC
21521 uses them.  This way one copy overrides all the others, but
21522 the unused copies still take up space in the executable.
21524 For targets that do not support either COMDAT or weak symbols,
21525 most entities with vague linkage are emitted as local symbols to
21526 avoid duplicate definition errors from the linker.  This does not happen
21527 for local statics in inlines, however, as having multiple copies
21528 almost certainly breaks things.
21530 @xref{C++ Interface,,Declarations and Definitions in One Header}, for
21531 another way to control placement of these constructs.
21533 @node C++ Interface
21534 @section C++ Interface and Implementation Pragmas
21536 @cindex interface and implementation headers, C++
21537 @cindex C++ interface and implementation headers
21538 @cindex pragmas, interface and implementation
21540 @code{#pragma interface} and @code{#pragma implementation} provide the
21541 user with a way of explicitly directing the compiler to emit entities
21542 with vague linkage (and debugging information) in a particular
21543 translation unit.
21545 @emph{Note:} These @code{#pragma}s have been superceded as of GCC 2.7.2
21546 by COMDAT support and the ``key method'' heuristic
21547 mentioned in @ref{Vague Linkage}.  Using them can actually cause your
21548 program to grow due to unnecessary out-of-line copies of inline
21549 functions.
21551 @table @code
21552 @item #pragma interface
21553 @itemx #pragma interface "@var{subdir}/@var{objects}.h"
21554 @kindex #pragma interface
21555 Use this directive in @emph{header files} that define object classes, to save
21556 space in most of the object files that use those classes.  Normally,
21557 local copies of certain information (backup copies of inline member
21558 functions, debugging information, and the internal tables that implement
21559 virtual functions) must be kept in each object file that includes class
21560 definitions.  You can use this pragma to avoid such duplication.  When a
21561 header file containing @samp{#pragma interface} is included in a
21562 compilation, this auxiliary information is not generated (unless
21563 the main input source file itself uses @samp{#pragma implementation}).
21564 Instead, the object files contain references to be resolved at link
21565 time.
21567 The second form of this directive is useful for the case where you have
21568 multiple headers with the same name in different directories.  If you
21569 use this form, you must specify the same string to @samp{#pragma
21570 implementation}.
21572 @item #pragma implementation
21573 @itemx #pragma implementation "@var{objects}.h"
21574 @kindex #pragma implementation
21575 Use this pragma in a @emph{main input file}, when you want full output from
21576 included header files to be generated (and made globally visible).  The
21577 included header file, in turn, should use @samp{#pragma interface}.
21578 Backup copies of inline member functions, debugging information, and the
21579 internal tables used to implement virtual functions are all generated in
21580 implementation files.
21582 @cindex implied @code{#pragma implementation}
21583 @cindex @code{#pragma implementation}, implied
21584 @cindex naming convention, implementation headers
21585 If you use @samp{#pragma implementation} with no argument, it applies to
21586 an include file with the same basename@footnote{A file's @dfn{basename}
21587 is the name stripped of all leading path information and of trailing
21588 suffixes, such as @samp{.h} or @samp{.C} or @samp{.cc}.} as your source
21589 file.  For example, in @file{allclass.cc}, giving just
21590 @samp{#pragma implementation}
21591 by itself is equivalent to @samp{#pragma implementation "allclass.h"}.
21593 Use the string argument if you want a single implementation file to
21594 include code from multiple header files.  (You must also use
21595 @samp{#include} to include the header file; @samp{#pragma
21596 implementation} only specifies how to use the file---it doesn't actually
21597 include it.)
21599 There is no way to split up the contents of a single header file into
21600 multiple implementation files.
21601 @end table
21603 @cindex inlining and C++ pragmas
21604 @cindex C++ pragmas, effect on inlining
21605 @cindex pragmas in C++, effect on inlining
21606 @samp{#pragma implementation} and @samp{#pragma interface} also have an
21607 effect on function inlining.
21609 If you define a class in a header file marked with @samp{#pragma
21610 interface}, the effect on an inline function defined in that class is
21611 similar to an explicit @code{extern} declaration---the compiler emits
21612 no code at all to define an independent version of the function.  Its
21613 definition is used only for inlining with its callers.
21615 @opindex fno-implement-inlines
21616 Conversely, when you include the same header file in a main source file
21617 that declares it as @samp{#pragma implementation}, the compiler emits
21618 code for the function itself; this defines a version of the function
21619 that can be found via pointers (or by callers compiled without
21620 inlining).  If all calls to the function can be inlined, you can avoid
21621 emitting the function by compiling with @option{-fno-implement-inlines}.
21622 If any calls are not inlined, you will get linker errors.
21624 @node Template Instantiation
21625 @section Where's the Template?
21626 @cindex template instantiation
21628 C++ templates were the first language feature to require more
21629 intelligence from the environment than was traditionally found on a UNIX
21630 system.  Somehow the compiler and linker have to make sure that each
21631 template instance occurs exactly once in the executable if it is needed,
21632 and not at all otherwise.  There are two basic approaches to this
21633 problem, which are referred to as the Borland model and the Cfront model.
21635 @table @asis
21636 @item Borland model
21637 Borland C++ solved the template instantiation problem by adding the code
21638 equivalent of common blocks to their linker; the compiler emits template
21639 instances in each translation unit that uses them, and the linker
21640 collapses them together.  The advantage of this model is that the linker
21641 only has to consider the object files themselves; there is no external
21642 complexity to worry about.  The disadvantage is that compilation time
21643 is increased because the template code is being compiled repeatedly.
21644 Code written for this model tends to include definitions of all
21645 templates in the header file, since they must be seen to be
21646 instantiated.
21648 @item Cfront model
21649 The AT&T C++ translator, Cfront, solved the template instantiation
21650 problem by creating the notion of a template repository, an
21651 automatically maintained place where template instances are stored.  A
21652 more modern version of the repository works as follows: As individual
21653 object files are built, the compiler places any template definitions and
21654 instantiations encountered in the repository.  At link time, the link
21655 wrapper adds in the objects in the repository and compiles any needed
21656 instances that were not previously emitted.  The advantages of this
21657 model are more optimal compilation speed and the ability to use the
21658 system linker; to implement the Borland model a compiler vendor also
21659 needs to replace the linker.  The disadvantages are vastly increased
21660 complexity, and thus potential for error; for some code this can be
21661 just as transparent, but in practice it can been very difficult to build
21662 multiple programs in one directory and one program in multiple
21663 directories.  Code written for this model tends to separate definitions
21664 of non-inline member templates into a separate file, which should be
21665 compiled separately.
21666 @end table
21668 G++ implements the Borland model on targets where the linker supports it,
21669 including ELF targets (such as GNU/Linux), Mac OS X and Microsoft Windows.
21670 Otherwise G++ implements neither automatic model.
21672 You have the following options for dealing with template instantiations:
21674 @enumerate
21675 @item
21676 Do nothing.  Code written for the Borland model works fine, but
21677 each translation unit contains instances of each of the templates it
21678 uses.  The duplicate instances will be discarded by the linker, but in
21679 a large program, this can lead to an unacceptable amount of code
21680 duplication in object files or shared libraries.
21682 Duplicate instances of a template can be avoided by defining an explicit
21683 instantiation in one object file, and preventing the compiler from doing
21684 implicit instantiations in any other object files by using an explicit
21685 instantiation declaration, using the @code{extern template} syntax:
21687 @smallexample
21688 extern template int max (int, int);
21689 @end smallexample
21691 This syntax is defined in the C++ 2011 standard, but has been supported by
21692 G++ and other compilers since well before 2011.
21694 Explicit instantiations can be used for the largest or most frequently
21695 duplicated instances, without having to know exactly which other instances
21696 are used in the rest of the program.  You can scatter the explicit
21697 instantiations throughout your program, perhaps putting them in the
21698 translation units where the instances are used or the translation units
21699 that define the templates themselves; you can put all of the explicit
21700 instantiations you need into one big file; or you can create small files
21701 like
21703 @smallexample
21704 #include "Foo.h"
21705 #include "Foo.cc"
21707 template class Foo<int>;
21708 template ostream& operator <<
21709                 (ostream&, const Foo<int>&);
21710 @end smallexample
21712 @noindent
21713 for each of the instances you need, and create a template instantiation
21714 library from those.
21716 This is the simplest option, but also offers flexibility and
21717 fine-grained control when necessary. It is also the most portable
21718 alternative and programs using this approach will work with most modern
21719 compilers.
21721 @item
21722 @opindex frepo
21723 Compile your template-using code with @option{-frepo}.  The compiler
21724 generates files with the extension @samp{.rpo} listing all of the
21725 template instantiations used in the corresponding object files that
21726 could be instantiated there; the link wrapper, @samp{collect2},
21727 then updates the @samp{.rpo} files to tell the compiler where to place
21728 those instantiations and rebuild any affected object files.  The
21729 link-time overhead is negligible after the first pass, as the compiler
21730 continues to place the instantiations in the same files.
21732 This can be a suitable option for application code written for the Borland
21733 model, as it usually just works.  Code written for the Cfront model 
21734 needs to be modified so that the template definitions are available at
21735 one or more points of instantiation; usually this is as simple as adding
21736 @code{#include <tmethods.cc>} to the end of each template header.
21738 For library code, if you want the library to provide all of the template
21739 instantiations it needs, just try to link all of its object files
21740 together; the link will fail, but cause the instantiations to be
21741 generated as a side effect.  Be warned, however, that this may cause
21742 conflicts if multiple libraries try to provide the same instantiations.
21743 For greater control, use explicit instantiation as described in the next
21744 option.
21746 @item
21747 @opindex fno-implicit-templates
21748 Compile your code with @option{-fno-implicit-templates} to disable the
21749 implicit generation of template instances, and explicitly instantiate
21750 all the ones you use.  This approach requires more knowledge of exactly
21751 which instances you need than do the others, but it's less
21752 mysterious and allows greater control if you want to ensure that only
21753 the intended instances are used.
21755 If you are using Cfront-model code, you can probably get away with not
21756 using @option{-fno-implicit-templates} when compiling files that don't
21757 @samp{#include} the member template definitions.
21759 If you use one big file to do the instantiations, you may want to
21760 compile it without @option{-fno-implicit-templates} so you get all of the
21761 instances required by your explicit instantiations (but not by any
21762 other files) without having to specify them as well.
21764 In addition to forward declaration of explicit instantiations
21765 (with @code{extern}), G++ has extended the template instantiation
21766 syntax to support instantiation of the compiler support data for a
21767 template class (i.e.@: the vtable) without instantiating any of its
21768 members (with @code{inline}), and instantiation of only the static data
21769 members of a template class, without the support data or member
21770 functions (with @code{static}):
21772 @smallexample
21773 inline template class Foo<int>;
21774 static template class Foo<int>;
21775 @end smallexample
21776 @end enumerate
21778 @node Bound member functions
21779 @section Extracting the Function Pointer from a Bound Pointer to Member Function
21780 @cindex pmf
21781 @cindex pointer to member function
21782 @cindex bound pointer to member function
21784 In C++, pointer to member functions (PMFs) are implemented using a wide
21785 pointer of sorts to handle all the possible call mechanisms; the PMF
21786 needs to store information about how to adjust the @samp{this} pointer,
21787 and if the function pointed to is virtual, where to find the vtable, and
21788 where in the vtable to look for the member function.  If you are using
21789 PMFs in an inner loop, you should really reconsider that decision.  If
21790 that is not an option, you can extract the pointer to the function that
21791 would be called for a given object/PMF pair and call it directly inside
21792 the inner loop, to save a bit of time.
21794 Note that you still pay the penalty for the call through a
21795 function pointer; on most modern architectures, such a call defeats the
21796 branch prediction features of the CPU@.  This is also true of normal
21797 virtual function calls.
21799 The syntax for this extension is
21801 @smallexample
21802 extern A a;
21803 extern int (A::*fp)();
21804 typedef int (*fptr)(A *);
21806 fptr p = (fptr)(a.*fp);
21807 @end smallexample
21809 For PMF constants (i.e.@: expressions of the form @samp{&Klasse::Member}),
21810 no object is needed to obtain the address of the function.  They can be
21811 converted to function pointers directly:
21813 @smallexample
21814 fptr p1 = (fptr)(&A::foo);
21815 @end smallexample
21817 @opindex Wno-pmf-conversions
21818 You must specify @option{-Wno-pmf-conversions} to use this extension.
21820 @node C++ Attributes
21821 @section C++-Specific Variable, Function, and Type Attributes
21823 Some attributes only make sense for C++ programs.
21825 @table @code
21826 @item abi_tag ("@var{tag}", ...)
21827 @cindex @code{abi_tag} function attribute
21828 @cindex @code{abi_tag} variable attribute
21829 @cindex @code{abi_tag} type attribute
21830 The @code{abi_tag} attribute can be applied to a function, variable, or class
21831 declaration.  It modifies the mangled name of the entity to
21832 incorporate the tag name, in order to distinguish the function or
21833 class from an earlier version with a different ABI; perhaps the class
21834 has changed size, or the function has a different return type that is
21835 not encoded in the mangled name.
21837 The attribute can also be applied to an inline namespace, but does not
21838 affect the mangled name of the namespace; in this case it is only used
21839 for @option{-Wabi-tag} warnings and automatic tagging of functions and
21840 variables.  Tagging inline namespaces is generally preferable to
21841 tagging individual declarations, but the latter is sometimes
21842 necessary, such as when only certain members of a class need to be
21843 tagged.
21845 The argument can be a list of strings of arbitrary length.  The
21846 strings are sorted on output, so the order of the list is
21847 unimportant.
21849 A redeclaration of an entity must not add new ABI tags,
21850 since doing so would change the mangled name.
21852 The ABI tags apply to a name, so all instantiations and
21853 specializations of a template have the same tags.  The attribute will
21854 be ignored if applied to an explicit specialization or instantiation.
21856 The @option{-Wabi-tag} flag enables a warning about a class which does
21857 not have all the ABI tags used by its subobjects and virtual functions; for users with code
21858 that needs to coexist with an earlier ABI, using this option can help
21859 to find all affected types that need to be tagged.
21861 When a type involving an ABI tag is used as the type of a variable or
21862 return type of a function where that tag is not already present in the
21863 signature of the function, the tag is automatically applied to the
21864 variable or function.  @option{-Wabi-tag} also warns about this
21865 situation; this warning can be avoided by explicitly tagging the
21866 variable or function or moving it into a tagged inline namespace.
21868 @item init_priority (@var{priority})
21869 @cindex @code{init_priority} variable attribute
21871 In Standard C++, objects defined at namespace scope are guaranteed to be
21872 initialized in an order in strict accordance with that of their definitions
21873 @emph{in a given translation unit}.  No guarantee is made for initializations
21874 across translation units.  However, GNU C++ allows users to control the
21875 order of initialization of objects defined at namespace scope with the
21876 @code{init_priority} attribute by specifying a relative @var{priority},
21877 a constant integral expression currently bounded between 101 and 65535
21878 inclusive.  Lower numbers indicate a higher priority.
21880 In the following example, @code{A} would normally be created before
21881 @code{B}, but the @code{init_priority} attribute reverses that order:
21883 @smallexample
21884 Some_Class  A  __attribute__ ((init_priority (2000)));
21885 Some_Class  B  __attribute__ ((init_priority (543)));
21886 @end smallexample
21888 @noindent
21889 Note that the particular values of @var{priority} do not matter; only their
21890 relative ordering.
21892 @item java_interface
21893 @cindex @code{java_interface} type attribute
21895 This type attribute informs C++ that the class is a Java interface.  It may
21896 only be applied to classes declared within an @code{extern "Java"} block.
21897 Calls to methods declared in this interface are dispatched using GCJ's
21898 interface table mechanism, instead of regular virtual table dispatch.
21900 @item warn_unused
21901 @cindex @code{warn_unused} type attribute
21903 For C++ types with non-trivial constructors and/or destructors it is
21904 impossible for the compiler to determine whether a variable of this
21905 type is truly unused if it is not referenced. This type attribute
21906 informs the compiler that variables of this type should be warned
21907 about if they appear to be unused, just like variables of fundamental
21908 types.
21910 This attribute is appropriate for types which just represent a value,
21911 such as @code{std::string}; it is not appropriate for types which
21912 control a resource, such as @code{std::lock_guard}.
21914 This attribute is also accepted in C, but it is unnecessary because C
21915 does not have constructors or destructors.
21917 @end table
21919 See also @ref{Namespace Association}.
21921 @node Function Multiversioning
21922 @section Function Multiversioning
21923 @cindex function versions
21925 With the GNU C++ front end, for x86 targets, you may specify multiple
21926 versions of a function, where each function is specialized for a
21927 specific target feature.  At runtime, the appropriate version of the
21928 function is automatically executed depending on the characteristics of
21929 the execution platform.  Here is an example.
21931 @smallexample
21932 __attribute__ ((target ("default")))
21933 int foo ()
21935   // The default version of foo.
21936   return 0;
21939 __attribute__ ((target ("sse4.2")))
21940 int foo ()
21942   // foo version for SSE4.2
21943   return 1;
21946 __attribute__ ((target ("arch=atom")))
21947 int foo ()
21949   // foo version for the Intel ATOM processor
21950   return 2;
21953 __attribute__ ((target ("arch=amdfam10")))
21954 int foo ()
21956   // foo version for the AMD Family 0x10 processors.
21957   return 3;
21960 int main ()
21962   int (*p)() = &foo;
21963   assert ((*p) () == foo ());
21964   return 0;
21966 @end smallexample
21968 In the above example, four versions of function foo are created. The
21969 first version of foo with the target attribute "default" is the default
21970 version.  This version gets executed when no other target specific
21971 version qualifies for execution on a particular platform. A new version
21972 of foo is created by using the same function signature but with a
21973 different target string.  Function foo is called or a pointer to it is
21974 taken just like a regular function.  GCC takes care of doing the
21975 dispatching to call the right version at runtime.  Refer to the
21976 @uref{http://gcc.gnu.org/wiki/FunctionMultiVersioning, GCC wiki on
21977 Function Multiversioning} for more details.
21979 @node Namespace Association
21980 @section Namespace Association
21982 @strong{Caution:} The semantics of this extension are equivalent
21983 to C++ 2011 inline namespaces.  Users should use inline namespaces
21984 instead as this extension will be removed in future versions of G++.
21986 A using-directive with @code{__attribute ((strong))} is stronger
21987 than a normal using-directive in two ways:
21989 @itemize @bullet
21990 @item
21991 Templates from the used namespace can be specialized and explicitly
21992 instantiated as though they were members of the using namespace.
21994 @item
21995 The using namespace is considered an associated namespace of all
21996 templates in the used namespace for purposes of argument-dependent
21997 name lookup.
21998 @end itemize
22000 The used namespace must be nested within the using namespace so that
22001 normal unqualified lookup works properly.
22003 This is useful for composing a namespace transparently from
22004 implementation namespaces.  For example:
22006 @smallexample
22007 namespace std @{
22008   namespace debug @{
22009     template <class T> struct A @{ @};
22010   @}
22011   using namespace debug __attribute ((__strong__));
22012   template <> struct A<int> @{ @};   // @r{OK to specialize}
22014   template <class T> void f (A<T>);
22017 int main()
22019   f (std::A<float>());             // @r{lookup finds} std::f
22020   f (std::A<int>());
22022 @end smallexample
22024 @node Type Traits
22025 @section Type Traits
22027 The C++ front end implements syntactic extensions that allow
22028 compile-time determination of 
22029 various characteristics of a type (or of a
22030 pair of types).
22032 @table @code
22033 @item __has_nothrow_assign (type)
22034 If @code{type} is const qualified or is a reference type then the trait is
22035 false.  Otherwise if @code{__has_trivial_assign (type)} is true then the trait
22036 is true, else if @code{type} is a cv class or union type with copy assignment
22037 operators that are known not to throw an exception then the trait is true,
22038 else it is false.  Requires: @code{type} shall be a complete type,
22039 (possibly cv-qualified) @code{void}, or an array of unknown bound.
22041 @item __has_nothrow_copy (type)
22042 If @code{__has_trivial_copy (type)} is true then the trait is true, else if
22043 @code{type} is a cv class or union type with copy constructors that
22044 are known not to throw an exception then the trait is true, else it is false.
22045 Requires: @code{type} shall be a complete type, (possibly cv-qualified)
22046 @code{void}, or an array of unknown bound.
22048 @item __has_nothrow_constructor (type)
22049 If @code{__has_trivial_constructor (type)} is true then the trait is
22050 true, else if @code{type} is a cv class or union type (or array
22051 thereof) with a default constructor that is known not to throw an
22052 exception then the trait is true, else it is false.  Requires:
22053 @code{type} shall be a complete type, (possibly cv-qualified)
22054 @code{void}, or an array of unknown bound.
22056 @item __has_trivial_assign (type)
22057 If @code{type} is const qualified or is a reference type then the trait is
22058 false.  Otherwise if @code{__is_pod (type)} is true then the trait is
22059 true, else if @code{type} is a cv class or union type with a trivial
22060 copy assignment ([class.copy]) then the trait is true, else it is
22061 false.  Requires: @code{type} shall be a complete type, (possibly
22062 cv-qualified) @code{void}, or an array of unknown bound.
22064 @item __has_trivial_copy (type)
22065 If @code{__is_pod (type)} is true or @code{type} is a reference type
22066 then the trait is true, else if @code{type} is a cv class or union type
22067 with a trivial copy constructor ([class.copy]) then the trait
22068 is true, else it is false.  Requires: @code{type} shall be a complete
22069 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
22071 @item __has_trivial_constructor (type)
22072 If @code{__is_pod (type)} is true then the trait is true, else if
22073 @code{type} is a cv class or union type (or array thereof) with a
22074 trivial default constructor ([class.ctor]) then the trait is true,
22075 else it is false.  Requires: @code{type} shall be a complete
22076 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
22078 @item __has_trivial_destructor (type)
22079 If @code{__is_pod (type)} is true or @code{type} is a reference type then
22080 the trait is true, else if @code{type} is a cv class or union type (or
22081 array thereof) with a trivial destructor ([class.dtor]) then the trait
22082 is true, else it is false.  Requires: @code{type} shall be a complete
22083 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
22085 @item __has_virtual_destructor (type)
22086 If @code{type} is a class type with a virtual destructor
22087 ([class.dtor]) then the trait is true, else it is false.  Requires:
22088 @code{type} shall be a complete type, (possibly cv-qualified)
22089 @code{void}, or an array of unknown bound.
22091 @item __is_abstract (type)
22092 If @code{type} is an abstract class ([class.abstract]) then the trait
22093 is true, else it is false.  Requires: @code{type} shall be a complete
22094 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
22096 @item __is_base_of (base_type, derived_type)
22097 If @code{base_type} is a base class of @code{derived_type}
22098 ([class.derived]) then the trait is true, otherwise it is false.
22099 Top-level cv qualifications of @code{base_type} and
22100 @code{derived_type} are ignored.  For the purposes of this trait, a
22101 class type is considered is own base.  Requires: if @code{__is_class
22102 (base_type)} and @code{__is_class (derived_type)} are true and
22103 @code{base_type} and @code{derived_type} are not the same type
22104 (disregarding cv-qualifiers), @code{derived_type} shall be a complete
22105 type.  A diagnostic is produced if this requirement is not met.
22107 @item __is_class (type)
22108 If @code{type} is a cv class type, and not a union type
22109 ([basic.compound]) the trait is true, else it is false.
22111 @item __is_empty (type)
22112 If @code{__is_class (type)} is false then the trait is false.
22113 Otherwise @code{type} is considered empty if and only if: @code{type}
22114 has no non-static data members, or all non-static data members, if
22115 any, are bit-fields of length 0, and @code{type} has no virtual
22116 members, and @code{type} has no virtual base classes, and @code{type}
22117 has no base classes @code{base_type} for which
22118 @code{__is_empty (base_type)} is false.  Requires: @code{type} shall
22119 be a complete type, (possibly cv-qualified) @code{void}, or an array
22120 of unknown bound.
22122 @item __is_enum (type)
22123 If @code{type} is a cv enumeration type ([basic.compound]) the trait is
22124 true, else it is false.
22126 @item __is_literal_type (type)
22127 If @code{type} is a literal type ([basic.types]) the trait is
22128 true, else it is false.  Requires: @code{type} shall be a complete type,
22129 (possibly cv-qualified) @code{void}, or an array of unknown bound.
22131 @item __is_pod (type)
22132 If @code{type} is a cv POD type ([basic.types]) then the trait is true,
22133 else it is false.  Requires: @code{type} shall be a complete type,
22134 (possibly cv-qualified) @code{void}, or an array of unknown bound.
22136 @item __is_polymorphic (type)
22137 If @code{type} is a polymorphic class ([class.virtual]) then the trait
22138 is true, else it is false.  Requires: @code{type} shall be a complete
22139 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
22141 @item __is_standard_layout (type)
22142 If @code{type} is a standard-layout type ([basic.types]) the trait is
22143 true, else it is false.  Requires: @code{type} shall be a complete
22144 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
22146 @item __is_trivial (type)
22147 If @code{type} is a trivial type ([basic.types]) the trait is
22148 true, else it is false.  Requires: @code{type} shall be a complete
22149 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
22151 @item __is_union (type)
22152 If @code{type} is a cv union type ([basic.compound]) the trait is
22153 true, else it is false.
22155 @item __underlying_type (type)
22156 The underlying type of @code{type}.  Requires: @code{type} shall be
22157 an enumeration type ([dcl.enum]).
22159 @end table
22162 @node C++ Concepts
22163 @section C++ Concepts
22165 C++ concepts provide much-improved support for generic programming. In
22166 particular, they allow the specification of constraints on template arguments.
22167 The constraints are used to extend the usual overloading and partial
22168 specialization capabilities of the language, allowing generic data structures
22169 and algorithms to be ``refined'' based on their properties rather than their
22170 type names.
22172 The following keywords are reserved for concepts.
22174 @table @code
22175 @item assumes
22176 States an expression as an assumption, and if possible, verifies that the
22177 assumption is valid. For example, @code{assume(n > 0)}.
22179 @item axiom
22180 Introduces an axiom definition. Axioms introduce requirements on values.
22182 @item forall
22183 Introduces a universally quantified object in an axiom. For example,
22184 @code{forall (int n) n + 0 == n}).
22186 @item concept
22187 Introduces a concept definition. Concepts are sets of syntactic and semantic
22188 requirements on types and their values.
22190 @item requires
22191 Introduces constraints on template arguments or requirements for a member
22192 function of a class template.
22194 @end table
22196 The front end also exposes a number of internal mechanism that can be used
22197 to simplify the writing of type traits. Note that some of these traits are
22198 likely to be removed in the future.
22200 @table @code
22201 @item __is_same (type1, type2)
22202 A binary type trait: true whenever the type arguments are the same.
22204 @end table
22207 @node Java Exceptions
22208 @section Java Exceptions
22210 The Java language uses a slightly different exception handling model
22211 from C++.  Normally, GNU C++ automatically detects when you are
22212 writing C++ code that uses Java exceptions, and handle them
22213 appropriately.  However, if C++ code only needs to execute destructors
22214 when Java exceptions are thrown through it, GCC guesses incorrectly.
22215 Sample problematic code is:
22217 @smallexample
22218   struct S @{ ~S(); @};
22219   extern void bar();    // @r{is written in Java, and may throw exceptions}
22220   void foo()
22221   @{
22222     S s;
22223     bar();
22224   @}
22225 @end smallexample
22227 @noindent
22228 The usual effect of an incorrect guess is a link failure, complaining of
22229 a missing routine called @samp{__gxx_personality_v0}.
22231 You can inform the compiler that Java exceptions are to be used in a
22232 translation unit, irrespective of what it might think, by writing
22233 @samp{@w{#pragma GCC java_exceptions}} at the head of the file.  This
22234 @samp{#pragma} must appear before any functions that throw or catch
22235 exceptions, or run destructors when exceptions are thrown through them.
22237 You cannot mix Java and C++ exceptions in the same translation unit.  It
22238 is believed to be safe to throw a C++ exception from one file through
22239 another file compiled for the Java exception model, or vice versa, but
22240 there may be bugs in this area.
22242 @node Deprecated Features
22243 @section Deprecated Features
22245 In the past, the GNU C++ compiler was extended to experiment with new
22246 features, at a time when the C++ language was still evolving.  Now that
22247 the C++ standard is complete, some of those features are superseded by
22248 superior alternatives.  Using the old features might cause a warning in
22249 some cases that the feature will be dropped in the future.  In other
22250 cases, the feature might be gone already.
22252 While the list below is not exhaustive, it documents some of the options
22253 that are now deprecated:
22255 @table @code
22256 @item -fexternal-templates
22257 @itemx -falt-external-templates
22258 These are two of the many ways for G++ to implement template
22259 instantiation.  @xref{Template Instantiation}.  The C++ standard clearly
22260 defines how template definitions have to be organized across
22261 implementation units.  G++ has an implicit instantiation mechanism that
22262 should work just fine for standard-conforming code.
22264 @item -fstrict-prototype
22265 @itemx -fno-strict-prototype
22266 Previously it was possible to use an empty prototype parameter list to
22267 indicate an unspecified number of parameters (like C), rather than no
22268 parameters, as C++ demands.  This feature has been removed, except where
22269 it is required for backwards compatibility.   @xref{Backwards Compatibility}.
22270 @end table
22272 G++ allows a virtual function returning @samp{void *} to be overridden
22273 by one returning a different pointer type.  This extension to the
22274 covariant return type rules is now deprecated and will be removed from a
22275 future version.
22277 The G++ minimum and maximum operators (@samp{<?} and @samp{>?}) and
22278 their compound forms (@samp{<?=}) and @samp{>?=}) have been deprecated
22279 and are now removed from G++.  Code using these operators should be
22280 modified to use @code{std::min} and @code{std::max} instead.
22282 The named return value extension has been deprecated, and is now
22283 removed from G++.
22285 The use of initializer lists with new expressions has been deprecated,
22286 and is now removed from G++.
22288 Floating and complex non-type template parameters have been deprecated,
22289 and are now removed from G++.
22291 The implicit typename extension has been deprecated and is now
22292 removed from G++.
22294 The use of default arguments in function pointers, function typedefs
22295 and other places where they are not permitted by the standard is
22296 deprecated and will be removed from a future version of G++.
22298 G++ allows floating-point literals to appear in integral constant expressions,
22299 e.g.@: @samp{ enum E @{ e = int(2.2 * 3.7) @} }
22300 This extension is deprecated and will be removed from a future version.
22302 G++ allows static data members of const floating-point type to be declared
22303 with an initializer in a class definition. The standard only allows
22304 initializers for static members of const integral types and const
22305 enumeration types so this extension has been deprecated and will be removed
22306 from a future version.
22308 @node Backwards Compatibility
22309 @section Backwards Compatibility
22310 @cindex Backwards Compatibility
22311 @cindex ARM [Annotated C++ Reference Manual]
22313 Now that there is a definitive ISO standard C++, G++ has a specification
22314 to adhere to.  The C++ language evolved over time, and features that
22315 used to be acceptable in previous drafts of the standard, such as the ARM
22316 [Annotated C++ Reference Manual], are no longer accepted.  In order to allow
22317 compilation of C++ written to such drafts, G++ contains some backwards
22318 compatibilities.  @emph{All such backwards compatibility features are
22319 liable to disappear in future versions of G++.} They should be considered
22320 deprecated.   @xref{Deprecated Features}.
22322 @table @code
22323 @item For scope
22324 If a variable is declared at for scope, it used to remain in scope until
22325 the end of the scope that contained the for statement (rather than just
22326 within the for scope).  G++ retains this, but issues a warning, if such a
22327 variable is accessed outside the for scope.
22329 @item Implicit C language
22330 Old C system header files did not contain an @code{extern "C" @{@dots{}@}}
22331 scope to set the language.  On such systems, all header files are
22332 implicitly scoped inside a C language scope.  Also, an empty prototype
22333 @code{()} is treated as an unspecified number of arguments, rather
22334 than no arguments, as C++ demands.
22335 @end table
22337 @c  LocalWords:  emph deftypefn builtin ARCv2EM SIMD builtins msimd
22338 @c  LocalWords:  typedef v4si v8hi DMA dma vdiwr vdowr