Merge aosp-toolchain/gcc/gcc-4_9 changes.
[official-gcc.git] / gcc-4_9 / gcc / doc / extend.texi
blob4c0914a35528f3637634ccc0182e8663068a5553
1 @c Copyright (C) 1988-2014 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 * Initializers::        Non-constant initializers.
50 * Compound Literals::   Compound literals give structures, unions
51                         or arrays as values.
52 * Designated Inits::    Labeling elements of initializers.
53 * Case Ranges::         `case 1 ... 9' and such.
54 * Cast to Union::       Casting to union type from any member of the union.
55 * Mixed Declarations::  Mixing declarations and code.
56 * Function Attributes:: Declaring that functions have no side effects,
57                         or that they can never return.
58 * Attribute Syntax::    Formal syntax for attributes.
59 * Function Prototypes:: Prototype declarations and old-style definitions.
60 * C++ Comments::        C++ comments are recognized.
61 * Dollar Signs::        Dollar sign is allowed in identifiers.
62 * Character Escapes::   @samp{\e} stands for the character @key{ESC}.
63 * Variable Attributes:: Specifying attributes of variables.
64 * Type Attributes::     Specifying attributes of types.
65 * Alignment::           Inquiring about the alignment of a type or variable.
66 * Inline::              Defining inline functions (as fast as macros).
67 * Volatiles::           What constitutes an access to a volatile object.
68 * Extended Asm::        Assembler instructions with C expressions as operands.
69                         (With them you can define ``built-in'' functions.)
70 * Constraints::         Constraints for asm operands
71 * Asm Labels::          Specifying the assembler name to use for a C symbol.
72 * Explicit Reg Vars::   Defining variables residing in specified registers.
73 * Alternate Keywords::  @code{__const__}, @code{__asm__}, etc., for header files.
74 * Incomplete Enums::    @code{enum foo;}, with details to follow.
75 * Function Names::      Printable strings which are the name of the current
76                         function.
77 * Return Address::      Getting the return or frame address of a function.
78 * Vector Extensions::   Using vector instructions through built-in functions.
79 * Offsetof::            Special syntax for implementing @code{offsetof}.
80 * __sync Builtins::     Legacy built-in functions for atomic memory access.
81 * __atomic Builtins::   Atomic built-in functions with memory model.
82 * x86 specific memory model extensions for transactional memory:: x86 memory models.
83 * Object Size Checking:: Built-in functions for limited buffer overflow
84                         checking.
85 * Cilk Plus Builtins::  Built-in functions for the Cilk Plus language extension.
86 * Other Builtins::      Other built-in functions.
87 * Target Builtins::     Built-in functions specific to particular targets.
88 * Target Format Checks:: Format checks specific to particular targets.
89 * Pragmas::             Pragmas accepted by GCC.
90 * Unnamed Fields::      Unnamed struct/union fields within structs/unions.
91 * Thread-Local::        Per-thread variables.
92 * Binary constants::    Binary constants using the @samp{0b} prefix.
93 @end menu
95 @node Statement Exprs
96 @section Statements and Declarations in Expressions
97 @cindex statements inside expressions
98 @cindex declarations inside expressions
99 @cindex expressions containing statements
100 @cindex macros, statements in expressions
102 @c the above section title wrapped and causes an underfull hbox.. i
103 @c changed it from "within" to "in". --mew 4feb93
104 A compound statement enclosed in parentheses may appear as an expression
105 in GNU C@.  This allows you to use loops, switches, and local variables
106 within an expression.
108 Recall that a compound statement is a sequence of statements surrounded
109 by braces; in this construct, parentheses go around the braces.  For
110 example:
112 @smallexample
113 (@{ int y = foo (); int z;
114    if (y > 0) z = y;
115    else z = - y;
116    z; @})
117 @end smallexample
119 @noindent
120 is a valid (though slightly more complex than necessary) expression
121 for the absolute value of @code{foo ()}.
123 The last thing in the compound statement should be an expression
124 followed by a semicolon; the value of this subexpression serves as the
125 value of the entire construct.  (If you use some other kind of statement
126 last within the braces, the construct has type @code{void}, and thus
127 effectively no value.)
129 This feature is especially useful in making macro definitions ``safe'' (so
130 that they evaluate each operand exactly once).  For example, the
131 ``maximum'' function is commonly defined as a macro in standard C as
132 follows:
134 @smallexample
135 #define max(a,b) ((a) > (b) ? (a) : (b))
136 @end smallexample
138 @noindent
139 @cindex side effects, macro argument
140 But this definition computes either @var{a} or @var{b} twice, with bad
141 results if the operand has side effects.  In GNU C, if you know the
142 type of the operands (here taken as @code{int}), you can define
143 the macro safely as follows:
145 @smallexample
146 #define maxint(a,b) \
147   (@{int _a = (a), _b = (b); _a > _b ? _a : _b; @})
148 @end smallexample
150 Embedded statements are not allowed in constant expressions, such as
151 the value of an enumeration constant, the width of a bit-field, or
152 the initial value of a static variable.
154 If you don't know the type of the operand, you can still do this, but you
155 must use @code{typeof} or @code{__auto_type} (@pxref{Typeof}).
157 In G++, the result value of a statement expression undergoes array and
158 function pointer decay, and is returned by value to the enclosing
159 expression.  For instance, if @code{A} is a class, then
161 @smallexample
162         A a;
164         (@{a;@}).Foo ()
165 @end smallexample
167 @noindent
168 constructs a temporary @code{A} object to hold the result of the
169 statement expression, and that is used to invoke @code{Foo}.
170 Therefore the @code{this} pointer observed by @code{Foo} is not the
171 address of @code{a}.
173 In a statement expression, any temporaries created within a statement
174 are destroyed at that statement's end.  This makes statement
175 expressions inside macros slightly different from function calls.  In
176 the latter case temporaries introduced during argument evaluation are
177 destroyed at the end of the statement that includes the function
178 call.  In the statement expression case they are destroyed during
179 the statement expression.  For instance,
181 @smallexample
182 #define macro(a)  (@{__typeof__(a) b = (a); b + 3; @})
183 template<typename T> T function(T a) @{ T b = a; return b + 3; @}
185 void foo ()
187   macro (X ());
188   function (X ());
190 @end smallexample
192 @noindent
193 has different places where temporaries are destroyed.  For the
194 @code{macro} case, the temporary @code{X} is destroyed just after
195 the initialization of @code{b}.  In the @code{function} case that
196 temporary is destroyed when the function returns.
198 These considerations mean that it is probably a bad idea to use
199 statement expressions of this form in header files that are designed to
200 work with C++.  (Note that some versions of the GNU C Library contained
201 header files using statement expressions that lead to precisely this
202 bug.)
204 Jumping into a statement expression with @code{goto} or using a
205 @code{switch} statement outside the statement expression with a
206 @code{case} or @code{default} label inside the statement expression is
207 not permitted.  Jumping into a statement expression with a computed
208 @code{goto} (@pxref{Labels as Values}) has undefined behavior.
209 Jumping out of a statement expression is permitted, but if the
210 statement expression is part of a larger expression then it is
211 unspecified which other subexpressions of that expression have been
212 evaluated except where the language definition requires certain
213 subexpressions to be evaluated before or after the statement
214 expression.  In any case, as with a function call, the evaluation of a
215 statement expression is not interleaved with the evaluation of other
216 parts of the containing expression.  For example,
218 @smallexample
219   foo (), ((@{ bar1 (); goto a; 0; @}) + bar2 ()), baz();
220 @end smallexample
222 @noindent
223 calls @code{foo} and @code{bar1} and does not call @code{baz} but
224 may or may not call @code{bar2}.  If @code{bar2} is called, it is
225 called after @code{foo} and before @code{bar1}.
227 @node Local Labels
228 @section Locally Declared Labels
229 @cindex local labels
230 @cindex macros, local labels
232 GCC allows you to declare @dfn{local labels} in any nested block
233 scope.  A local label is just like an ordinary label, but you can
234 only reference it (with a @code{goto} statement, or by taking its
235 address) within the block in which it is declared.
237 A local label declaration looks like this:
239 @smallexample
240 __label__ @var{label};
241 @end smallexample
243 @noindent
246 @smallexample
247 __label__ @var{label1}, @var{label2}, /* @r{@dots{}} */;
248 @end smallexample
250 Local label declarations must come at the beginning of the block,
251 before any ordinary declarations or statements.
253 The label declaration defines the label @emph{name}, but does not define
254 the label itself.  You must do this in the usual way, with
255 @code{@var{label}:}, within the statements of the statement expression.
257 The local label feature is useful for complex macros.  If a macro
258 contains nested loops, a @code{goto} can be useful for breaking out of
259 them.  However, an ordinary label whose scope is the whole function
260 cannot be used: if the macro can be expanded several times in one
261 function, the label is multiply defined in that function.  A
262 local label avoids this problem.  For example:
264 @smallexample
265 #define SEARCH(value, array, target)              \
266 do @{                                              \
267   __label__ found;                                \
268   typeof (target) _SEARCH_target = (target);      \
269   typeof (*(array)) *_SEARCH_array = (array);     \
270   int i, j;                                       \
271   int value;                                      \
272   for (i = 0; i < max; i++)                       \
273     for (j = 0; j < max; j++)                     \
274       if (_SEARCH_array[i][j] == _SEARCH_target)  \
275         @{ (value) = i; goto found; @}              \
276   (value) = -1;                                   \
277  found:;                                          \
278 @} while (0)
279 @end smallexample
281 This could also be written using a statement expression:
283 @smallexample
284 #define SEARCH(array, target)                     \
285 (@{                                                \
286   __label__ found;                                \
287   typeof (target) _SEARCH_target = (target);      \
288   typeof (*(array)) *_SEARCH_array = (array);     \
289   int i, j;                                       \
290   int value;                                      \
291   for (i = 0; i < max; i++)                       \
292     for (j = 0; j < max; j++)                     \
293       if (_SEARCH_array[i][j] == _SEARCH_target)  \
294         @{ value = i; goto found; @}                \
295   value = -1;                                     \
296  found:                                           \
297   value;                                          \
299 @end smallexample
301 Local label declarations also make the labels they declare visible to
302 nested functions, if there are any.  @xref{Nested Functions}, for details.
304 @node Labels as Values
305 @section Labels as Values
306 @cindex labels as values
307 @cindex computed gotos
308 @cindex goto with computed label
309 @cindex address of a label
311 You can get the address of a label defined in the current function
312 (or a containing function) with the unary operator @samp{&&}.  The
313 value has type @code{void *}.  This value is a constant and can be used
314 wherever a constant of that type is valid.  For example:
316 @smallexample
317 void *ptr;
318 /* @r{@dots{}} */
319 ptr = &&foo;
320 @end smallexample
322 To use these values, you need to be able to jump to one.  This is done
323 with the computed goto statement@footnote{The analogous feature in
324 Fortran is called an assigned goto, but that name seems inappropriate in
325 C, where one can do more than simply store label addresses in label
326 variables.}, @code{goto *@var{exp};}.  For example,
328 @smallexample
329 goto *ptr;
330 @end smallexample
332 @noindent
333 Any expression of type @code{void *} is allowed.
335 One way of using these constants is in initializing a static array that
336 serves as a jump table:
338 @smallexample
339 static void *array[] = @{ &&foo, &&bar, &&hack @};
340 @end smallexample
342 @noindent
343 Then you can select a label with indexing, like this:
345 @smallexample
346 goto *array[i];
347 @end smallexample
349 @noindent
350 Note that this does not check whether the subscript is in bounds---array
351 indexing in C never does that.
353 Such an array of label values serves a purpose much like that of the
354 @code{switch} statement.  The @code{switch} statement is cleaner, so
355 use that rather than an array unless the problem does not fit a
356 @code{switch} statement very well.
358 Another use of label values is in an interpreter for threaded code.
359 The labels within the interpreter function can be stored in the
360 threaded code for super-fast dispatching.
362 You may not use this mechanism to jump to code in a different function.
363 If you do that, totally unpredictable things happen.  The best way to
364 avoid this is to store the label address only in automatic variables and
365 never pass it as an argument.
367 An alternate way to write the above example is
369 @smallexample
370 static const int array[] = @{ &&foo - &&foo, &&bar - &&foo,
371                              &&hack - &&foo @};
372 goto *(&&foo + array[i]);
373 @end smallexample
375 @noindent
376 This is more friendly to code living in shared libraries, as it reduces
377 the number of dynamic relocations that are needed, and by consequence,
378 allows the data to be read-only.
379 This alternative with label differences is not supported for the AVR target,
380 please use the first approach for AVR programs.
382 The @code{&&foo} expressions for the same label might have different
383 values if the containing function is inlined or cloned.  If a program
384 relies on them being always the same,
385 @code{__attribute__((__noinline__,__noclone__))} should be used to
386 prevent inlining and cloning.  If @code{&&foo} is used in a static
387 variable initializer, inlining and cloning is forbidden.
389 @node Nested Functions
390 @section Nested Functions
391 @cindex nested functions
392 @cindex downward funargs
393 @cindex thunks
395 A @dfn{nested function} is a function defined inside another function.
396 Nested functions are supported as an extension in GNU C, but are not
397 supported by GNU C++.
399 The nested function's name is local to the block where it is defined.
400 For example, here we define a nested function named @code{square}, and
401 call it twice:
403 @smallexample
404 @group
405 foo (double a, double b)
407   double square (double z) @{ return z * z; @}
409   return square (a) + square (b);
411 @end group
412 @end smallexample
414 The nested function can access all the variables of the containing
415 function that are visible at the point of its definition.  This is
416 called @dfn{lexical scoping}.  For example, here we show a nested
417 function which uses an inherited variable named @code{offset}:
419 @smallexample
420 @group
421 bar (int *array, int offset, int size)
423   int access (int *array, int index)
424     @{ return array[index + offset]; @}
425   int i;
426   /* @r{@dots{}} */
427   for (i = 0; i < size; i++)
428     /* @r{@dots{}} */ access (array, i) /* @r{@dots{}} */
430 @end group
431 @end smallexample
433 Nested function definitions are permitted within functions in the places
434 where variable definitions are allowed; that is, in any block, mixed
435 with the other declarations and statements in the block.
437 It is possible to call the nested function from outside the scope of its
438 name by storing its address or passing the address to another function:
440 @smallexample
441 hack (int *array, int size)
443   void store (int index, int value)
444     @{ array[index] = value; @}
446   intermediate (store, size);
448 @end smallexample
450 Here, the function @code{intermediate} receives the address of
451 @code{store} as an argument.  If @code{intermediate} calls @code{store},
452 the arguments given to @code{store} are used to store into @code{array}.
453 But this technique works only so long as the containing function
454 (@code{hack}, in this example) does not exit.
456 If you try to call the nested function through its address after the
457 containing function exits, all hell breaks loose.  If you try
458 to call it after a containing scope level exits, and if it refers
459 to some of the variables that are no longer in scope, you may be lucky,
460 but it's not wise to take the risk.  If, however, the nested function
461 does not refer to anything that has gone out of scope, you should be
462 safe.
464 GCC implements taking the address of a nested function using a technique
465 called @dfn{trampolines}.  This technique was described in
466 @cite{Lexical Closures for C++} (Thomas M. Breuel, USENIX
467 C++ Conference Proceedings, October 17-21, 1988).
469 A nested function can jump to a label inherited from a containing
470 function, provided the label is explicitly declared in the containing
471 function (@pxref{Local Labels}).  Such a jump returns instantly to the
472 containing function, exiting the nested function that did the
473 @code{goto} and any intermediate functions as well.  Here is an example:
475 @smallexample
476 @group
477 bar (int *array, int offset, int size)
479   __label__ failure;
480   int access (int *array, int index)
481     @{
482       if (index > size)
483         goto failure;
484       return array[index + offset];
485     @}
486   int i;
487   /* @r{@dots{}} */
488   for (i = 0; i < size; i++)
489     /* @r{@dots{}} */ access (array, i) /* @r{@dots{}} */
490   /* @r{@dots{}} */
491   return 0;
493  /* @r{Control comes here from @code{access}
494     if it detects an error.}  */
495  failure:
496   return -1;
498 @end group
499 @end smallexample
501 A nested function always has no linkage.  Declaring one with
502 @code{extern} or @code{static} is erroneous.  If you need to declare the nested function
503 before its definition, use @code{auto} (which is otherwise meaningless
504 for function declarations).
506 @smallexample
507 bar (int *array, int offset, int size)
509   __label__ failure;
510   auto int access (int *, int);
511   /* @r{@dots{}} */
512   int access (int *array, int index)
513     @{
514       if (index > size)
515         goto failure;
516       return array[index + offset];
517     @}
518   /* @r{@dots{}} */
520 @end smallexample
522 @node Constructing Calls
523 @section Constructing Function Calls
524 @cindex constructing calls
525 @cindex forwarding calls
527 Using the built-in functions described below, you can record
528 the arguments a function received, and call another function
529 with the same arguments, without knowing the number or types
530 of the arguments.
532 You can also record the return value of that function call,
533 and later return that value, without knowing what data type
534 the function tried to return (as long as your caller expects
535 that data type).
537 However, these built-in functions may interact badly with some
538 sophisticated features or other extensions of the language.  It
539 is, therefore, not recommended to use them outside very simple
540 functions acting as mere forwarders for their arguments.
542 @deftypefn {Built-in Function} {void *} __builtin_apply_args ()
543 This built-in function returns a pointer to data
544 describing how to perform a call with the same arguments as are passed
545 to the current function.
547 The function saves the arg pointer register, structure value address,
548 and all registers that might be used to pass arguments to a function
549 into a block of memory allocated on the stack.  Then it returns the
550 address of that block.
551 @end deftypefn
553 @deftypefn {Built-in Function} {void *} __builtin_apply (void (*@var{function})(), void *@var{arguments}, size_t @var{size})
554 This built-in function invokes @var{function}
555 with a copy of the parameters described by @var{arguments}
556 and @var{size}.
558 The value of @var{arguments} should be the value returned by
559 @code{__builtin_apply_args}.  The argument @var{size} specifies the size
560 of the stack argument data, in bytes.
562 This function returns a pointer to data describing
563 how to return whatever value is returned by @var{function}.  The data
564 is saved in a block of memory allocated on the stack.
566 It is not always simple to compute the proper value for @var{size}.  The
567 value is used by @code{__builtin_apply} to compute the amount of data
568 that should be pushed on the stack and copied from the incoming argument
569 area.
570 @end deftypefn
572 @deftypefn {Built-in Function} {void} __builtin_return (void *@var{result})
573 This built-in function returns the value described by @var{result} from
574 the containing function.  You should specify, for @var{result}, a value
575 returned by @code{__builtin_apply}.
576 @end deftypefn
578 @deftypefn {Built-in Function} {} __builtin_va_arg_pack ()
579 This built-in function represents all anonymous arguments of an inline
580 function.  It can be used only in inline functions that are always
581 inlined, never compiled as a separate function, such as those using
582 @code{__attribute__ ((__always_inline__))} or
583 @code{__attribute__ ((__gnu_inline__))} extern inline functions.
584 It must be only passed as last argument to some other function
585 with variable arguments.  This is useful for writing small wrapper
586 inlines for variable argument functions, when using preprocessor
587 macros is undesirable.  For example:
588 @smallexample
589 extern int myprintf (FILE *f, const char *format, ...);
590 extern inline __attribute__ ((__gnu_inline__)) int
591 myprintf (FILE *f, const char *format, ...)
593   int r = fprintf (f, "myprintf: ");
594   if (r < 0)
595     return r;
596   int s = fprintf (f, format, __builtin_va_arg_pack ());
597   if (s < 0)
598     return s;
599   return r + s;
601 @end smallexample
602 @end deftypefn
604 @deftypefn {Built-in Function} {size_t} __builtin_va_arg_pack_len ()
605 This built-in function returns the number of anonymous arguments of
606 an inline function.  It can be used only in inline functions that
607 are always inlined, never compiled as a separate function, such
608 as those using @code{__attribute__ ((__always_inline__))} or
609 @code{__attribute__ ((__gnu_inline__))} extern inline functions.
610 For example following does link- or run-time checking of open
611 arguments for optimized code:
612 @smallexample
613 #ifdef __OPTIMIZE__
614 extern inline __attribute__((__gnu_inline__)) int
615 myopen (const char *path, int oflag, ...)
617   if (__builtin_va_arg_pack_len () > 1)
618     warn_open_too_many_arguments ();
620   if (__builtin_constant_p (oflag))
621     @{
622       if ((oflag & O_CREAT) != 0 && __builtin_va_arg_pack_len () < 1)
623         @{
624           warn_open_missing_mode ();
625           return __open_2 (path, oflag);
626         @}
627       return open (path, oflag, __builtin_va_arg_pack ());
628     @}
630   if (__builtin_va_arg_pack_len () < 1)
631     return __open_2 (path, oflag);
633   return open (path, oflag, __builtin_va_arg_pack ());
635 #endif
636 @end smallexample
637 @end deftypefn
639 @node Typeof
640 @section Referring to a Type with @code{typeof}
641 @findex typeof
642 @findex sizeof
643 @cindex macros, types of arguments
645 Another way to refer to the type of an expression is with @code{typeof}.
646 The syntax of using of this keyword looks like @code{sizeof}, but the
647 construct acts semantically like a type name defined with @code{typedef}.
649 There are two ways of writing the argument to @code{typeof}: with an
650 expression or with a type.  Here is an example with an expression:
652 @smallexample
653 typeof (x[0](1))
654 @end smallexample
656 @noindent
657 This assumes that @code{x} is an array of pointers to functions;
658 the type described is that of the values of the functions.
660 Here is an example with a typename as the argument:
662 @smallexample
663 typeof (int *)
664 @end smallexample
666 @noindent
667 Here the type described is that of pointers to @code{int}.
669 If you are writing a header file that must work when included in ISO C
670 programs, write @code{__typeof__} instead of @code{typeof}.
671 @xref{Alternate Keywords}.
673 A @code{typeof} construct can be used anywhere a typedef name can be
674 used.  For example, you can use it in a declaration, in a cast, or inside
675 of @code{sizeof} or @code{typeof}.
677 The operand of @code{typeof} is evaluated for its side effects if and
678 only if it is an expression of variably modified type or the name of
679 such a type.
681 @code{typeof} is often useful in conjunction with
682 statement expressions (@pxref{Statement Exprs}).
683 Here is how the two together can
684 be used to define a safe ``maximum'' macro which operates on any
685 arithmetic type and evaluates each of its arguments exactly once:
687 @smallexample
688 #define max(a,b) \
689   (@{ typeof (a) _a = (a); \
690       typeof (b) _b = (b); \
691     _a > _b ? _a : _b; @})
692 @end smallexample
694 @cindex underscores in variables in macros
695 @cindex @samp{_} in variables in macros
696 @cindex local variables in macros
697 @cindex variables, local, in macros
698 @cindex macros, local variables in
700 The reason for using names that start with underscores for the local
701 variables is to avoid conflicts with variable names that occur within the
702 expressions that are substituted for @code{a} and @code{b}.  Eventually we
703 hope to design a new form of declaration syntax that allows you to declare
704 variables whose scopes start only after their initializers; this will be a
705 more reliable way to prevent such conflicts.
707 @noindent
708 Some more examples of the use of @code{typeof}:
710 @itemize @bullet
711 @item
712 This declares @code{y} with the type of what @code{x} points to.
714 @smallexample
715 typeof (*x) y;
716 @end smallexample
718 @item
719 This declares @code{y} as an array of such values.
721 @smallexample
722 typeof (*x) y[4];
723 @end smallexample
725 @item
726 This declares @code{y} as an array of pointers to characters:
728 @smallexample
729 typeof (typeof (char *)[4]) y;
730 @end smallexample
732 @noindent
733 It is equivalent to the following traditional C declaration:
735 @smallexample
736 char *y[4];
737 @end smallexample
739 To see the meaning of the declaration using @code{typeof}, and why it
740 might be a useful way to write, rewrite it with these macros:
742 @smallexample
743 #define pointer(T)  typeof(T *)
744 #define array(T, N) typeof(T [N])
745 @end smallexample
747 @noindent
748 Now the declaration can be rewritten this way:
750 @smallexample
751 array (pointer (char), 4) y;
752 @end smallexample
754 @noindent
755 Thus, @code{array (pointer (char), 4)} is the type of arrays of 4
756 pointers to @code{char}.
757 @end itemize
759 In GNU C, but not GNU C++, you may also declare the type of a variable
760 as @code{__auto_type}.  In that case, the declaration must declare
761 only one variable, whose declarator must just be an identifier, the
762 declaration must be initialized, and the type of the variable is
763 determined by the initializer; the name of the variable is not in
764 scope until after the initializer.  (In C++, you should use C++11
765 @code{auto} for this purpose.)  Using @code{__auto_type}, the
766 ``maximum'' macro above could be written as:
768 @smallexample
769 #define max(a,b) \
770   (@{ __auto_type _a = (a); \
771       __auto_type _b = (b); \
772     _a > _b ? _a : _b; @})
773 @end smallexample
775 Using @code{__auto_type} instead of @code{typeof} has two advantages:
777 @itemize @bullet
778 @item Each argument to the macro appears only once in the expansion of
779 the macro.  This prevents the size of the macro expansion growing
780 exponentially when calls to such macros are nested inside arguments of
781 such macros.
783 @item If the argument to the macro has variably modified type, it is
784 evaluated only once when using @code{__auto_type}, but twice if
785 @code{typeof} is used.
786 @end itemize
788 @emph{Compatibility Note:} In addition to @code{typeof}, GCC 2 supported
789 a more limited extension that permitted one to write
791 @smallexample
792 typedef @var{T} = @var{expr};
793 @end smallexample
795 @noindent
796 with the effect of declaring @var{T} to have the type of the expression
797 @var{expr}.  This extension does not work with GCC 3 (versions between
798 3.0 and 3.2 crash; 3.2.1 and later give an error).  Code that
799 relies on it should be rewritten to use @code{typeof}:
801 @smallexample
802 typedef typeof(@var{expr}) @var{T};
803 @end smallexample
805 @noindent
806 This works with all versions of GCC@.
808 @node Conditionals
809 @section Conditionals with Omitted Operands
810 @cindex conditional expressions, extensions
811 @cindex omitted middle-operands
812 @cindex middle-operands, omitted
813 @cindex extensions, @code{?:}
814 @cindex @code{?:} extensions
816 The middle operand in a conditional expression may be omitted.  Then
817 if the first operand is nonzero, its value is the value of the conditional
818 expression.
820 Therefore, the expression
822 @smallexample
823 x ? : y
824 @end smallexample
826 @noindent
827 has the value of @code{x} if that is nonzero; otherwise, the value of
828 @code{y}.
830 This example is perfectly equivalent to
832 @smallexample
833 x ? x : y
834 @end smallexample
836 @cindex side effect in @code{?:}
837 @cindex @code{?:} side effect
838 @noindent
839 In this simple case, the ability to omit the middle operand is not
840 especially useful.  When it becomes useful is when the first operand does,
841 or may (if it is a macro argument), contain a side effect.  Then repeating
842 the operand in the middle would perform the side effect twice.  Omitting
843 the middle operand uses the value already computed without the undesirable
844 effects of recomputing it.
846 @node __int128
847 @section 128-bit integers
848 @cindex @code{__int128} data types
850 As an extension the integer scalar type @code{__int128} is supported for
851 targets which have an integer mode wide enough to hold 128 bits.
852 Simply write @code{__int128} for a signed 128-bit integer, or
853 @code{unsigned __int128} for an unsigned 128-bit integer.  There is no
854 support in GCC for expressing an integer constant of type @code{__int128}
855 for targets with @code{long long} integer less than 128 bits wide.
857 @node Long Long
858 @section Double-Word Integers
859 @cindex @code{long long} data types
860 @cindex double-word arithmetic
861 @cindex multiprecision arithmetic
862 @cindex @code{LL} integer suffix
863 @cindex @code{ULL} integer suffix
865 ISO C99 supports data types for integers that are at least 64 bits wide,
866 and as an extension GCC supports them in C90 mode and in C++.
867 Simply write @code{long long int} for a signed integer, or
868 @code{unsigned long long int} for an unsigned integer.  To make an
869 integer constant of type @code{long long int}, add the suffix @samp{LL}
870 to the integer.  To make an integer constant of type @code{unsigned long
871 long int}, add the suffix @samp{ULL} to the integer.
873 You can use these types in arithmetic like any other integer types.
874 Addition, subtraction, and bitwise boolean operations on these types
875 are open-coded on all types of machines.  Multiplication is open-coded
876 if the machine supports a fullword-to-doubleword widening multiply
877 instruction.  Division and shifts are open-coded only on machines that
878 provide special support.  The operations that are not open-coded use
879 special library routines that come with GCC@.
881 There may be pitfalls when you use @code{long long} types for function
882 arguments without function prototypes.  If a function
883 expects type @code{int} for its argument, and you pass a value of type
884 @code{long long int}, confusion results because the caller and the
885 subroutine disagree about the number of bytes for the argument.
886 Likewise, if the function expects @code{long long int} and you pass
887 @code{int}.  The best way to avoid such problems is to use prototypes.
889 @node Complex
890 @section Complex Numbers
891 @cindex complex numbers
892 @cindex @code{_Complex} keyword
893 @cindex @code{__complex__} keyword
895 ISO C99 supports complex floating data types, and as an extension GCC
896 supports them in C90 mode and in C++.  GCC also supports complex integer data
897 types which are not part of ISO C99.  You can declare complex types
898 using the keyword @code{_Complex}.  As an extension, the older GNU
899 keyword @code{__complex__} is also supported.
901 For example, @samp{_Complex double x;} declares @code{x} as a
902 variable whose real part and imaginary part are both of type
903 @code{double}.  @samp{_Complex short int y;} declares @code{y} to
904 have real and imaginary parts of type @code{short int}; this is not
905 likely to be useful, but it shows that the set of complex types is
906 complete.
908 To write a constant with a complex data type, use the suffix @samp{i} or
909 @samp{j} (either one; they are equivalent).  For example, @code{2.5fi}
910 has type @code{_Complex float} and @code{3i} has type
911 @code{_Complex int}.  Such a constant always has a pure imaginary
912 value, but you can form any complex value you like by adding one to a
913 real constant.  This is a GNU extension; if you have an ISO C99
914 conforming C library (such as the GNU C Library), and want to construct complex
915 constants of floating type, you should include @code{<complex.h>} and
916 use the macros @code{I} or @code{_Complex_I} instead.
918 @cindex @code{__real__} keyword
919 @cindex @code{__imag__} keyword
920 To extract the real part of a complex-valued expression @var{exp}, write
921 @code{__real__ @var{exp}}.  Likewise, use @code{__imag__} to
922 extract the imaginary part.  This is a GNU extension; for values of
923 floating type, you should use the ISO C99 functions @code{crealf},
924 @code{creal}, @code{creall}, @code{cimagf}, @code{cimag} and
925 @code{cimagl}, declared in @code{<complex.h>} and also provided as
926 built-in functions by GCC@.
928 @cindex complex conjugation
929 The operator @samp{~} performs complex conjugation when used on a value
930 with a complex type.  This is a GNU extension; for values of
931 floating type, you should use the ISO C99 functions @code{conjf},
932 @code{conj} and @code{conjl}, declared in @code{<complex.h>} and also
933 provided as built-in functions by GCC@.
935 GCC can allocate complex automatic variables in a noncontiguous
936 fashion; it's even possible for the real part to be in a register while
937 the imaginary part is on the stack (or vice versa).  Only the DWARF 2
938 debug info format can represent this, so use of DWARF 2 is recommended.
939 If you are using the stabs debug info format, GCC describes a noncontiguous
940 complex variable as if it were two separate variables of noncomplex type.
941 If the variable's actual name is @code{foo}, the two fictitious
942 variables are named @code{foo$real} and @code{foo$imag}.  You can
943 examine and set these two fictitious variables with your debugger.
945 @node Floating Types
946 @section Additional Floating Types
947 @cindex additional floating types
948 @cindex @code{__float80} data type
949 @cindex @code{__float128} data type
950 @cindex @code{w} floating point suffix
951 @cindex @code{q} floating point suffix
952 @cindex @code{W} floating point suffix
953 @cindex @code{Q} floating point suffix
955 As an extension, GNU C supports additional floating
956 types, @code{__float80} and @code{__float128} to support 80-bit
957 (@code{XFmode}) and 128-bit (@code{TFmode}) floating types.
958 Support for additional types includes the arithmetic operators:
959 add, subtract, multiply, divide; unary arithmetic operators;
960 relational operators; equality operators; and conversions to and from
961 integer and other floating types.  Use a suffix @samp{w} or @samp{W}
962 in a literal constant of type @code{__float80} and @samp{q} or @samp{Q}
963 for @code{_float128}.  You can declare complex types using the
964 corresponding internal complex type, @code{XCmode} for @code{__float80}
965 type and @code{TCmode} for @code{__float128} type:
967 @smallexample
968 typedef _Complex float __attribute__((mode(TC))) _Complex128;
969 typedef _Complex float __attribute__((mode(XC))) _Complex80;
970 @end smallexample
972 Not all targets support additional floating-point types.  @code{__float80}
973 and @code{__float128} types are supported on i386, x86_64 and IA-64 targets.
974 The @code{__float128} type is supported on hppa HP-UX targets.
976 @node Half-Precision
977 @section Half-Precision Floating Point
978 @cindex half-precision floating point
979 @cindex @code{__fp16} data type
981 On ARM targets, GCC supports half-precision (16-bit) floating point via
982 the @code{__fp16} type.  You must enable this type explicitly
983 with the @option{-mfp16-format} command-line option in order to use it.
985 ARM supports two incompatible representations for half-precision
986 floating-point values.  You must choose one of the representations and
987 use it consistently in your program.
989 Specifying @option{-mfp16-format=ieee} selects the IEEE 754-2008 format.
990 This format can represent normalized values in the range of @math{2^{-14}} to 65504.
991 There are 11 bits of significand precision, approximately 3
992 decimal digits.
994 Specifying @option{-mfp16-format=alternative} selects the ARM
995 alternative format.  This representation is similar to the IEEE
996 format, but does not support infinities or NaNs.  Instead, the range
997 of exponents is extended, so that this format can represent normalized
998 values in the range of @math{2^{-14}} to 131008.
1000 The @code{__fp16} type is a storage format only.  For purposes
1001 of arithmetic and other operations, @code{__fp16} values in C or C++
1002 expressions are automatically promoted to @code{float}.  In addition,
1003 you cannot declare a function with a return value or parameters
1004 of type @code{__fp16}.
1006 Note that conversions from @code{double} to @code{__fp16}
1007 involve an intermediate conversion to @code{float}.  Because
1008 of rounding, this can sometimes produce a different result than a
1009 direct conversion.
1011 ARM provides hardware support for conversions between
1012 @code{__fp16} and @code{float} values
1013 as an extension to VFP and NEON (Advanced SIMD).  GCC generates
1014 code using these hardware instructions if you compile with
1015 options to select an FPU that provides them;
1016 for example, @option{-mfpu=neon-fp16 -mfloat-abi=softfp},
1017 in addition to the @option{-mfp16-format} option to select
1018 a half-precision format.
1020 Language-level support for the @code{__fp16} data type is
1021 independent of whether GCC generates code using hardware floating-point
1022 instructions.  In cases where hardware support is not specified, GCC
1023 implements conversions between @code{__fp16} and @code{float} values
1024 as library calls.
1026 @node Decimal Float
1027 @section Decimal Floating Types
1028 @cindex decimal floating types
1029 @cindex @code{_Decimal32} data type
1030 @cindex @code{_Decimal64} data type
1031 @cindex @code{_Decimal128} data type
1032 @cindex @code{df} integer suffix
1033 @cindex @code{dd} integer suffix
1034 @cindex @code{dl} integer suffix
1035 @cindex @code{DF} integer suffix
1036 @cindex @code{DD} integer suffix
1037 @cindex @code{DL} integer suffix
1039 As an extension, GNU C supports decimal floating types as
1040 defined in the N1312 draft of ISO/IEC WDTR24732.  Support for decimal
1041 floating types in GCC will evolve as the draft technical report changes.
1042 Calling conventions for any target might also change.  Not all targets
1043 support decimal floating types.
1045 The decimal floating types are @code{_Decimal32}, @code{_Decimal64}, and
1046 @code{_Decimal128}.  They use a radix of ten, unlike the floating types
1047 @code{float}, @code{double}, and @code{long double} whose radix is not
1048 specified by the C standard but is usually two.
1050 Support for decimal floating types includes the arithmetic operators
1051 add, subtract, multiply, divide; unary arithmetic operators;
1052 relational operators; equality operators; and conversions to and from
1053 integer and other floating types.  Use a suffix @samp{df} or
1054 @samp{DF} in a literal constant of type @code{_Decimal32}, @samp{dd}
1055 or @samp{DD} for @code{_Decimal64}, and @samp{dl} or @samp{DL} for
1056 @code{_Decimal128}.
1058 GCC support of decimal float as specified by the draft technical report
1059 is incomplete:
1061 @itemize @bullet
1062 @item
1063 When the value of a decimal floating type cannot be represented in the
1064 integer type to which it is being converted, the result is undefined
1065 rather than the result value specified by the draft technical report.
1067 @item
1068 GCC does not provide the C library functionality associated with
1069 @file{math.h}, @file{fenv.h}, @file{stdio.h}, @file{stdlib.h}, and
1070 @file{wchar.h}, which must come from a separate C library implementation.
1071 Because of this the GNU C compiler does not define macro
1072 @code{__STDC_DEC_FP__} to indicate that the implementation conforms to
1073 the technical report.
1074 @end itemize
1076 Types @code{_Decimal32}, @code{_Decimal64}, and @code{_Decimal128}
1077 are supported by the DWARF 2 debug information format.
1079 @node Hex Floats
1080 @section Hex Floats
1081 @cindex hex floats
1083 ISO C99 supports floating-point numbers written not only in the usual
1084 decimal notation, such as @code{1.55e1}, but also numbers such as
1085 @code{0x1.fp3} written in hexadecimal format.  As a GNU extension, GCC
1086 supports this in C90 mode (except in some cases when strictly
1087 conforming) and in C++.  In that format the
1088 @samp{0x} hex introducer and the @samp{p} or @samp{P} exponent field are
1089 mandatory.  The exponent is a decimal number that indicates the power of
1090 2 by which the significant part is multiplied.  Thus @samp{0x1.f} is
1091 @tex
1092 $1 {15\over16}$,
1093 @end tex
1094 @ifnottex
1095 1 15/16,
1096 @end ifnottex
1097 @samp{p3} multiplies it by 8, and the value of @code{0x1.fp3}
1098 is the same as @code{1.55e1}.
1100 Unlike for floating-point numbers in the decimal notation the exponent
1101 is always required in the hexadecimal notation.  Otherwise the compiler
1102 would not be able to resolve the ambiguity of, e.g., @code{0x1.f}.  This
1103 could mean @code{1.0f} or @code{1.9375} since @samp{f} is also the
1104 extension for floating-point constants of type @code{float}.
1106 @node Fixed-Point
1107 @section Fixed-Point Types
1108 @cindex fixed-point types
1109 @cindex @code{_Fract} data type
1110 @cindex @code{_Accum} data type
1111 @cindex @code{_Sat} data type
1112 @cindex @code{hr} fixed-suffix
1113 @cindex @code{r} fixed-suffix
1114 @cindex @code{lr} fixed-suffix
1115 @cindex @code{llr} fixed-suffix
1116 @cindex @code{uhr} fixed-suffix
1117 @cindex @code{ur} fixed-suffix
1118 @cindex @code{ulr} fixed-suffix
1119 @cindex @code{ullr} fixed-suffix
1120 @cindex @code{hk} fixed-suffix
1121 @cindex @code{k} fixed-suffix
1122 @cindex @code{lk} fixed-suffix
1123 @cindex @code{llk} fixed-suffix
1124 @cindex @code{uhk} fixed-suffix
1125 @cindex @code{uk} fixed-suffix
1126 @cindex @code{ulk} fixed-suffix
1127 @cindex @code{ullk} fixed-suffix
1128 @cindex @code{HR} fixed-suffix
1129 @cindex @code{R} fixed-suffix
1130 @cindex @code{LR} fixed-suffix
1131 @cindex @code{LLR} fixed-suffix
1132 @cindex @code{UHR} fixed-suffix
1133 @cindex @code{UR} fixed-suffix
1134 @cindex @code{ULR} fixed-suffix
1135 @cindex @code{ULLR} fixed-suffix
1136 @cindex @code{HK} fixed-suffix
1137 @cindex @code{K} fixed-suffix
1138 @cindex @code{LK} fixed-suffix
1139 @cindex @code{LLK} fixed-suffix
1140 @cindex @code{UHK} fixed-suffix
1141 @cindex @code{UK} fixed-suffix
1142 @cindex @code{ULK} fixed-suffix
1143 @cindex @code{ULLK} fixed-suffix
1145 As an extension, GNU C supports fixed-point types as
1146 defined in the N1169 draft of ISO/IEC DTR 18037.  Support for fixed-point
1147 types in GCC will evolve as the draft technical report changes.
1148 Calling conventions for any target might also change.  Not all targets
1149 support fixed-point types.
1151 The fixed-point types are
1152 @code{short _Fract},
1153 @code{_Fract},
1154 @code{long _Fract},
1155 @code{long long _Fract},
1156 @code{unsigned short _Fract},
1157 @code{unsigned _Fract},
1158 @code{unsigned long _Fract},
1159 @code{unsigned long long _Fract},
1160 @code{_Sat short _Fract},
1161 @code{_Sat _Fract},
1162 @code{_Sat long _Fract},
1163 @code{_Sat long long _Fract},
1164 @code{_Sat unsigned short _Fract},
1165 @code{_Sat unsigned _Fract},
1166 @code{_Sat unsigned long _Fract},
1167 @code{_Sat unsigned long long _Fract},
1168 @code{short _Accum},
1169 @code{_Accum},
1170 @code{long _Accum},
1171 @code{long long _Accum},
1172 @code{unsigned short _Accum},
1173 @code{unsigned _Accum},
1174 @code{unsigned long _Accum},
1175 @code{unsigned long long _Accum},
1176 @code{_Sat short _Accum},
1177 @code{_Sat _Accum},
1178 @code{_Sat long _Accum},
1179 @code{_Sat long long _Accum},
1180 @code{_Sat unsigned short _Accum},
1181 @code{_Sat unsigned _Accum},
1182 @code{_Sat unsigned long _Accum},
1183 @code{_Sat unsigned long long _Accum}.
1185 Fixed-point data values contain fractional and optional integral parts.
1186 The format of fixed-point data varies and depends on the target machine.
1188 Support for fixed-point types includes:
1189 @itemize @bullet
1190 @item
1191 prefix and postfix increment and decrement operators (@code{++}, @code{--})
1192 @item
1193 unary arithmetic operators (@code{+}, @code{-}, @code{!})
1194 @item
1195 binary arithmetic operators (@code{+}, @code{-}, @code{*}, @code{/})
1196 @item
1197 binary shift operators (@code{<<}, @code{>>})
1198 @item
1199 relational operators (@code{<}, @code{<=}, @code{>=}, @code{>})
1200 @item
1201 equality operators (@code{==}, @code{!=})
1202 @item
1203 assignment operators (@code{+=}, @code{-=}, @code{*=}, @code{/=},
1204 @code{<<=}, @code{>>=})
1205 @item
1206 conversions to and from integer, floating-point, or fixed-point types
1207 @end itemize
1209 Use a suffix in a fixed-point literal constant:
1210 @itemize
1211 @item @samp{hr} or @samp{HR} for @code{short _Fract} and
1212 @code{_Sat short _Fract}
1213 @item @samp{r} or @samp{R} for @code{_Fract} and @code{_Sat _Fract}
1214 @item @samp{lr} or @samp{LR} for @code{long _Fract} and
1215 @code{_Sat long _Fract}
1216 @item @samp{llr} or @samp{LLR} for @code{long long _Fract} and
1217 @code{_Sat long long _Fract}
1218 @item @samp{uhr} or @samp{UHR} for @code{unsigned short _Fract} and
1219 @code{_Sat unsigned short _Fract}
1220 @item @samp{ur} or @samp{UR} for @code{unsigned _Fract} and
1221 @code{_Sat unsigned _Fract}
1222 @item @samp{ulr} or @samp{ULR} for @code{unsigned long _Fract} and
1223 @code{_Sat unsigned long _Fract}
1224 @item @samp{ullr} or @samp{ULLR} for @code{unsigned long long _Fract}
1225 and @code{_Sat unsigned long long _Fract}
1226 @item @samp{hk} or @samp{HK} for @code{short _Accum} and
1227 @code{_Sat short _Accum}
1228 @item @samp{k} or @samp{K} for @code{_Accum} and @code{_Sat _Accum}
1229 @item @samp{lk} or @samp{LK} for @code{long _Accum} and
1230 @code{_Sat long _Accum}
1231 @item @samp{llk} or @samp{LLK} for @code{long long _Accum} and
1232 @code{_Sat long long _Accum}
1233 @item @samp{uhk} or @samp{UHK} for @code{unsigned short _Accum} and
1234 @code{_Sat unsigned short _Accum}
1235 @item @samp{uk} or @samp{UK} for @code{unsigned _Accum} and
1236 @code{_Sat unsigned _Accum}
1237 @item @samp{ulk} or @samp{ULK} for @code{unsigned long _Accum} and
1238 @code{_Sat unsigned long _Accum}
1239 @item @samp{ullk} or @samp{ULLK} for @code{unsigned long long _Accum}
1240 and @code{_Sat unsigned long long _Accum}
1241 @end itemize
1243 GCC support of fixed-point types as specified by the draft technical report
1244 is incomplete:
1246 @itemize @bullet
1247 @item
1248 Pragmas to control overflow and rounding behaviors are not implemented.
1249 @end itemize
1251 Fixed-point types are supported by the DWARF 2 debug information format.
1253 @node Named Address Spaces
1254 @section Named Address Spaces
1255 @cindex Named Address Spaces
1257 As an extension, GNU C supports named address spaces as
1258 defined in the N1275 draft of ISO/IEC DTR 18037.  Support for named
1259 address spaces in GCC will evolve as the draft technical report
1260 changes.  Calling conventions for any target might also change.  At
1261 present, only the AVR, SPU, M32C, and RL78 targets support address
1262 spaces other than the generic address space.
1264 Address space identifiers may be used exactly like any other C type
1265 qualifier (e.g., @code{const} or @code{volatile}).  See the N1275
1266 document for more details.
1268 @anchor{AVR Named Address Spaces}
1269 @subsection AVR Named Address Spaces
1271 On the AVR target, there are several address spaces that can be used
1272 in order to put read-only data into the flash memory and access that
1273 data by means of the special instructions @code{LPM} or @code{ELPM}
1274 needed to read from flash.
1276 Per default, any data including read-only data is located in RAM
1277 (the generic address space) so that non-generic address spaces are
1278 needed to locate read-only data in flash memory
1279 @emph{and} to generate the right instructions to access this data
1280 without using (inline) assembler code.
1282 @table @code
1283 @item __flash
1284 @cindex @code{__flash} AVR Named Address Spaces
1285 The @code{__flash} qualifier locates data in the
1286 @code{.progmem.data} section. Data is read using the @code{LPM}
1287 instruction. Pointers to this address space are 16 bits wide.
1289 @item __flash1
1290 @itemx __flash2
1291 @itemx __flash3
1292 @itemx __flash4
1293 @itemx __flash5
1294 @cindex @code{__flash1} AVR Named Address Spaces
1295 @cindex @code{__flash2} AVR Named Address Spaces
1296 @cindex @code{__flash3} AVR Named Address Spaces
1297 @cindex @code{__flash4} AVR Named Address Spaces
1298 @cindex @code{__flash5} AVR Named Address Spaces
1299 These are 16-bit address spaces locating data in section
1300 @code{.progmem@var{N}.data} where @var{N} refers to
1301 address space @code{__flash@var{N}}.
1302 The compiler sets the @code{RAMPZ} segment register appropriately 
1303 before reading data by means of the @code{ELPM} instruction.
1305 @item __memx
1306 @cindex @code{__memx} AVR Named Address Spaces
1307 This is a 24-bit address space that linearizes flash and RAM:
1308 If the high bit of the address is set, data is read from
1309 RAM using the lower two bytes as RAM address.
1310 If the high bit of the address is clear, data is read from flash
1311 with @code{RAMPZ} set according to the high byte of the address.
1312 @xref{AVR Built-in Functions,,@code{__builtin_avr_flash_segment}}.
1314 Objects in this address space are located in @code{.progmemx.data}.
1315 @end table
1317 @b{Example}
1319 @smallexample
1320 char my_read (const __flash char ** p)
1322     /* p is a pointer to RAM that points to a pointer to flash.
1323        The first indirection of p reads that flash pointer
1324        from RAM and the second indirection reads a char from this
1325        flash address.  */
1327     return **p;
1330 /* Locate array[] in flash memory */
1331 const __flash int array[] = @{ 3, 5, 7, 11, 13, 17, 19 @};
1333 int i = 1;
1335 int main (void)
1337    /* Return 17 by reading from flash memory */
1338    return array[array[i]];
1340 @end smallexample
1342 @noindent
1343 For each named address space supported by avr-gcc there is an equally
1344 named but uppercase built-in macro defined. 
1345 The purpose is to facilitate testing if respective address space
1346 support is available or not:
1348 @smallexample
1349 #ifdef __FLASH
1350 const __flash int var = 1;
1352 int read_var (void)
1354     return var;
1356 #else
1357 #include <avr/pgmspace.h> /* From AVR-LibC */
1359 const int var PROGMEM = 1;
1361 int read_var (void)
1363     return (int) pgm_read_word (&var);
1365 #endif /* __FLASH */
1366 @end smallexample
1368 @noindent
1369 Notice that attribute @ref{AVR Variable Attributes,,@code{progmem}}
1370 locates data in flash but
1371 accesses to these data read from generic address space, i.e.@:
1372 from RAM,
1373 so that you need special accessors like @code{pgm_read_byte}
1374 from @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC}}
1375 together with attribute @code{progmem}.
1377 @noindent
1378 @b{Limitations and caveats}
1380 @itemize
1381 @item
1382 Reading across the 64@tie{}KiB section boundary of
1383 the @code{__flash} or @code{__flash@var{N}} address spaces
1384 shows undefined behavior. The only address space that
1385 supports reading across the 64@tie{}KiB flash segment boundaries is
1386 @code{__memx}.
1388 @item
1389 If you use one of the @code{__flash@var{N}} address spaces
1390 you must arrange your linker script to locate the
1391 @code{.progmem@var{N}.data} sections according to your needs.
1393 @item
1394 Any data or pointers to the non-generic address spaces must
1395 be qualified as @code{const}, i.e.@: as read-only data.
1396 This still applies if the data in one of these address
1397 spaces like software version number or calibration lookup table are intended to
1398 be changed after load time by, say, a boot loader. In this case
1399 the right qualification is @code{const} @code{volatile} so that the compiler
1400 must not optimize away known values or insert them
1401 as immediates into operands of instructions.
1403 @item
1404 The following code initializes a variable @code{pfoo}
1405 located in static storage with a 24-bit address:
1406 @smallexample
1407 extern const __memx char foo;
1408 const __memx void *pfoo = &foo;
1409 @end smallexample
1411 @noindent
1412 Such code requires at least binutils 2.23, see
1413 @w{@uref{http://sourceware.org/PR13503,PR13503}}.
1415 @end itemize
1417 @subsection M32C Named Address Spaces
1418 @cindex @code{__far} M32C Named Address Spaces
1420 On the M32C target, with the R8C and M16C CPU variants, variables
1421 qualified with @code{__far} are accessed using 32-bit addresses in
1422 order to access memory beyond the first 64@tie{}Ki bytes.  If
1423 @code{__far} is used with the M32CM or M32C CPU variants, it has no
1424 effect.
1426 @subsection RL78 Named Address Spaces
1427 @cindex @code{__far} RL78 Named Address Spaces
1429 On the RL78 target, variables qualified with @code{__far} are accessed
1430 with 32-bit pointers (20-bit addresses) rather than the default 16-bit
1431 addresses.  Non-far variables are assumed to appear in the topmost
1432 64@tie{}KiB of the address space.
1434 @subsection SPU Named Address Spaces
1435 @cindex @code{__ea} SPU Named Address Spaces
1437 On the SPU target variables may be declared as
1438 belonging to another address space by qualifying the type with the
1439 @code{__ea} address space identifier:
1441 @smallexample
1442 extern int __ea i;
1443 @end smallexample
1445 @noindent 
1446 The compiler generates special code to access the variable @code{i}.
1447 It may use runtime library
1448 support, or generate special machine instructions to access that address
1449 space.
1451 @node Zero Length
1452 @section Arrays of Length Zero
1453 @cindex arrays of length zero
1454 @cindex zero-length arrays
1455 @cindex length-zero arrays
1456 @cindex flexible array members
1458 Zero-length arrays are allowed in GNU C@.  They are very useful as the
1459 last element of a structure that is really a header for a variable-length
1460 object:
1462 @smallexample
1463 struct line @{
1464   int length;
1465   char contents[0];
1468 struct line *thisline = (struct line *)
1469   malloc (sizeof (struct line) + this_length);
1470 thisline->length = this_length;
1471 @end smallexample
1473 In ISO C90, you would have to give @code{contents} a length of 1, which
1474 means either you waste space or complicate the argument to @code{malloc}.
1476 In ISO C99, you would use a @dfn{flexible array member}, which is
1477 slightly different in syntax and semantics:
1479 @itemize @bullet
1480 @item
1481 Flexible array members are written as @code{contents[]} without
1482 the @code{0}.
1484 @item
1485 Flexible array members have incomplete type, and so the @code{sizeof}
1486 operator may not be applied.  As a quirk of the original implementation
1487 of zero-length arrays, @code{sizeof} evaluates to zero.
1489 @item
1490 Flexible array members may only appear as the last member of a
1491 @code{struct} that is otherwise non-empty.
1493 @item
1494 A structure containing a flexible array member, or a union containing
1495 such a structure (possibly recursively), may not be a member of a
1496 structure or an element of an array.  (However, these uses are
1497 permitted by GCC as extensions.)
1498 @end itemize
1500 GCC versions before 3.0 allowed zero-length arrays to be statically
1501 initialized, as if they were flexible arrays.  In addition to those
1502 cases that were useful, it also allowed initializations in situations
1503 that would corrupt later data.  Non-empty initialization of zero-length
1504 arrays is now treated like any case where there are more initializer
1505 elements than the array holds, in that a suitable warning about ``excess
1506 elements in array'' is given, and the excess elements (all of them, in
1507 this case) are ignored.
1509 Instead GCC allows static initialization of flexible array members.
1510 This is equivalent to defining a new structure containing the original
1511 structure followed by an array of sufficient size to contain the data.
1512 E.g.@: in the following, @code{f1} is constructed as if it were declared
1513 like @code{f2}.
1515 @smallexample
1516 struct f1 @{
1517   int x; int y[];
1518 @} f1 = @{ 1, @{ 2, 3, 4 @} @};
1520 struct f2 @{
1521   struct f1 f1; int data[3];
1522 @} f2 = @{ @{ 1 @}, @{ 2, 3, 4 @} @};
1523 @end smallexample
1525 @noindent
1526 The convenience of this extension is that @code{f1} has the desired
1527 type, eliminating the need to consistently refer to @code{f2.f1}.
1529 This has symmetry with normal static arrays, in that an array of
1530 unknown size is also written with @code{[]}.
1532 Of course, this extension only makes sense if the extra data comes at
1533 the end of a top-level object, as otherwise we would be overwriting
1534 data at subsequent offsets.  To avoid undue complication and confusion
1535 with initialization of deeply nested arrays, we simply disallow any
1536 non-empty initialization except when the structure is the top-level
1537 object.  For example:
1539 @smallexample
1540 struct foo @{ int x; int y[]; @};
1541 struct bar @{ struct foo z; @};
1543 struct foo a = @{ 1, @{ 2, 3, 4 @} @};        // @r{Valid.}
1544 struct bar b = @{ @{ 1, @{ 2, 3, 4 @} @} @};    // @r{Invalid.}
1545 struct bar c = @{ @{ 1, @{ @} @} @};            // @r{Valid.}
1546 struct foo d[1] = @{ @{ 1 @{ 2, 3, 4 @} @} @};  // @r{Invalid.}
1547 @end smallexample
1549 @node Empty Structures
1550 @section Structures With No Members
1551 @cindex empty structures
1552 @cindex zero-size structures
1554 GCC permits a C structure to have no members:
1556 @smallexample
1557 struct empty @{
1559 @end smallexample
1561 The structure has size zero.  In C++, empty structures are part
1562 of the language.  G++ treats empty structures as if they had a single
1563 member of type @code{char}.
1565 @node Variable Length
1566 @section Arrays of Variable Length
1567 @cindex variable-length arrays
1568 @cindex arrays of variable length
1569 @cindex VLAs
1571 Variable-length automatic arrays are allowed in ISO C99, and as an
1572 extension GCC accepts them in C90 mode and in C++.  These arrays are
1573 declared like any other automatic arrays, but with a length that is not
1574 a constant expression.  The storage is allocated at the point of
1575 declaration and deallocated when the block scope containing the declaration
1576 exits.  For
1577 example:
1579 @smallexample
1580 FILE *
1581 concat_fopen (char *s1, char *s2, char *mode)
1583   char str[strlen (s1) + strlen (s2) + 1];
1584   strcpy (str, s1);
1585   strcat (str, s2);
1586   return fopen (str, mode);
1588 @end smallexample
1590 @cindex scope of a variable length array
1591 @cindex variable-length array scope
1592 @cindex deallocating variable length arrays
1593 Jumping or breaking out of the scope of the array name deallocates the
1594 storage.  Jumping into the scope is not allowed; you get an error
1595 message for it.
1597 @cindex variable-length array in a structure
1598 As an extension, GCC accepts variable-length arrays as a member of
1599 a structure or a union.  For example:
1601 @smallexample
1602 void
1603 foo (int n)
1605   struct S @{ int x[n]; @};
1607 @end smallexample
1609 @cindex @code{alloca} vs variable-length arrays
1610 You can use the function @code{alloca} to get an effect much like
1611 variable-length arrays.  The function @code{alloca} is available in
1612 many other C implementations (but not in all).  On the other hand,
1613 variable-length arrays are more elegant.
1615 There are other differences between these two methods.  Space allocated
1616 with @code{alloca} exists until the containing @emph{function} returns.
1617 The space for a variable-length array is deallocated as soon as the array
1618 name's scope ends.  (If you use both variable-length arrays and
1619 @code{alloca} in the same function, deallocation of a variable-length array
1620 also deallocates anything more recently allocated with @code{alloca}.)
1622 You can also use variable-length arrays as arguments to functions:
1624 @smallexample
1625 struct entry
1626 tester (int len, char data[len][len])
1628   /* @r{@dots{}} */
1630 @end smallexample
1632 The length of an array is computed once when the storage is allocated
1633 and is remembered for the scope of the array in case you access it with
1634 @code{sizeof}.
1636 If you want to pass the array first and the length afterward, you can
1637 use a forward declaration in the parameter list---another GNU extension.
1639 @smallexample
1640 struct entry
1641 tester (int len; char data[len][len], int len)
1643   /* @r{@dots{}} */
1645 @end smallexample
1647 @cindex parameter forward declaration
1648 The @samp{int len} before the semicolon is a @dfn{parameter forward
1649 declaration}, and it serves the purpose of making the name @code{len}
1650 known when the declaration of @code{data} is parsed.
1652 You can write any number of such parameter forward declarations in the
1653 parameter list.  They can be separated by commas or semicolons, but the
1654 last one must end with a semicolon, which is followed by the ``real''
1655 parameter declarations.  Each forward declaration must match a ``real''
1656 declaration in parameter name and data type.  ISO C99 does not support
1657 parameter forward declarations.
1659 @node Variadic Macros
1660 @section Macros with a Variable Number of Arguments.
1661 @cindex variable number of arguments
1662 @cindex macro with variable arguments
1663 @cindex rest argument (in macro)
1664 @cindex variadic macros
1666 In the ISO C standard of 1999, a macro can be declared to accept a
1667 variable number of arguments much as a function can.  The syntax for
1668 defining the macro is similar to that of a function.  Here is an
1669 example:
1671 @smallexample
1672 #define debug(format, ...) fprintf (stderr, format, __VA_ARGS__)
1673 @end smallexample
1675 @noindent
1676 Here @samp{@dots{}} is a @dfn{variable argument}.  In the invocation of
1677 such a macro, it represents the zero or more tokens until the closing
1678 parenthesis that ends the invocation, including any commas.  This set of
1679 tokens replaces the identifier @code{__VA_ARGS__} in the macro body
1680 wherever it appears.  See the CPP manual for more information.
1682 GCC has long supported variadic macros, and used a different syntax that
1683 allowed you to give a name to the variable arguments just like any other
1684 argument.  Here is an example:
1686 @smallexample
1687 #define debug(format, args...) fprintf (stderr, format, args)
1688 @end smallexample
1690 @noindent
1691 This is in all ways equivalent to the ISO C example above, but arguably
1692 more readable and descriptive.
1694 GNU CPP has two further variadic macro extensions, and permits them to
1695 be used with either of the above forms of macro definition.
1697 In standard C, you are not allowed to leave the variable argument out
1698 entirely; but you are allowed to pass an empty argument.  For example,
1699 this invocation is invalid in ISO C, because there is no comma after
1700 the string:
1702 @smallexample
1703 debug ("A message")
1704 @end smallexample
1706 GNU CPP permits you to completely omit the variable arguments in this
1707 way.  In the above examples, the compiler would complain, though since
1708 the expansion of the macro still has the extra comma after the format
1709 string.
1711 To help solve this problem, CPP behaves specially for variable arguments
1712 used with the token paste operator, @samp{##}.  If instead you write
1714 @smallexample
1715 #define debug(format, ...) fprintf (stderr, format, ## __VA_ARGS__)
1716 @end smallexample
1718 @noindent
1719 and if the variable arguments are omitted or empty, the @samp{##}
1720 operator causes the preprocessor to remove the comma before it.  If you
1721 do provide some variable arguments in your macro invocation, GNU CPP
1722 does not complain about the paste operation and instead places the
1723 variable arguments after the comma.  Just like any other pasted macro
1724 argument, these arguments are not macro expanded.
1726 @node Escaped Newlines
1727 @section Slightly Looser Rules for Escaped Newlines
1728 @cindex escaped newlines
1729 @cindex newlines (escaped)
1731 Recently, the preprocessor has relaxed its treatment of escaped
1732 newlines.  Previously, the newline had to immediately follow a
1733 backslash.  The current implementation allows whitespace in the form
1734 of spaces, horizontal and vertical tabs, and form feeds between the
1735 backslash and the subsequent newline.  The preprocessor issues a
1736 warning, but treats it as a valid escaped newline and combines the two
1737 lines to form a single logical line.  This works within comments and
1738 tokens, as well as between tokens.  Comments are @emph{not} treated as
1739 whitespace for the purposes of this relaxation, since they have not
1740 yet been replaced with spaces.
1742 @node Subscripting
1743 @section Non-Lvalue Arrays May Have Subscripts
1744 @cindex subscripting
1745 @cindex arrays, non-lvalue
1747 @cindex subscripting and function values
1748 In ISO C99, arrays that are not lvalues still decay to pointers, and
1749 may be subscripted, although they may not be modified or used after
1750 the next sequence point and the unary @samp{&} operator may not be
1751 applied to them.  As an extension, GNU C allows such arrays to be
1752 subscripted in C90 mode, though otherwise they do not decay to
1753 pointers outside C99 mode.  For example,
1754 this is valid in GNU C though not valid in C90:
1756 @smallexample
1757 @group
1758 struct foo @{int a[4];@};
1760 struct foo f();
1762 bar (int index)
1764   return f().a[index];
1766 @end group
1767 @end smallexample
1769 @node Pointer Arith
1770 @section Arithmetic on @code{void}- and Function-Pointers
1771 @cindex void pointers, arithmetic
1772 @cindex void, size of pointer to
1773 @cindex function pointers, arithmetic
1774 @cindex function, size of pointer to
1776 In GNU C, addition and subtraction operations are supported on pointers to
1777 @code{void} and on pointers to functions.  This is done by treating the
1778 size of a @code{void} or of a function as 1.
1780 A consequence of this is that @code{sizeof} is also allowed on @code{void}
1781 and on function types, and returns 1.
1783 @opindex Wpointer-arith
1784 The option @option{-Wpointer-arith} requests a warning if these extensions
1785 are used.
1787 @node Initializers
1788 @section Non-Constant Initializers
1789 @cindex initializers, non-constant
1790 @cindex non-constant initializers
1792 As in standard C++ and ISO C99, the elements of an aggregate initializer for an
1793 automatic variable are not required to be constant expressions in GNU C@.
1794 Here is an example of an initializer with run-time varying elements:
1796 @smallexample
1797 foo (float f, float g)
1799   float beat_freqs[2] = @{ f-g, f+g @};
1800   /* @r{@dots{}} */
1802 @end smallexample
1804 @node Compound Literals
1805 @section Compound Literals
1806 @cindex constructor expressions
1807 @cindex initializations in expressions
1808 @cindex structures, constructor expression
1809 @cindex expressions, constructor
1810 @cindex compound literals
1811 @c The GNU C name for what C99 calls compound literals was "constructor expressions".
1813 ISO C99 supports compound literals.  A compound literal looks like
1814 a cast containing an initializer.  Its value is an object of the
1815 type specified in the cast, containing the elements specified in
1816 the initializer; it is an lvalue.  As an extension, GCC supports
1817 compound literals in C90 mode and in C++, though the semantics are
1818 somewhat different in C++.
1820 Usually, the specified type is a structure.  Assume that
1821 @code{struct foo} and @code{structure} are declared as shown:
1823 @smallexample
1824 struct foo @{int a; char b[2];@} structure;
1825 @end smallexample
1827 @noindent
1828 Here is an example of constructing a @code{struct foo} with a compound literal:
1830 @smallexample
1831 structure = ((struct foo) @{x + y, 'a', 0@});
1832 @end smallexample
1834 @noindent
1835 This is equivalent to writing the following:
1837 @smallexample
1839   struct foo temp = @{x + y, 'a', 0@};
1840   structure = temp;
1842 @end smallexample
1844 You can also construct an array, though this is dangerous in C++, as
1845 explained below.  If all the elements of the compound literal are
1846 (made up of) simple constant expressions, suitable for use in
1847 initializers of objects of static storage duration, then the compound
1848 literal can be coerced to a pointer to its first element and used in
1849 such an initializer, as shown here:
1851 @smallexample
1852 char **foo = (char *[]) @{ "x", "y", "z" @};
1853 @end smallexample
1855 Compound literals for scalar types and union types are
1856 also allowed, but then the compound literal is equivalent
1857 to a cast.
1859 As a GNU extension, GCC allows initialization of objects with static storage
1860 duration by compound literals (which is not possible in ISO C99, because
1861 the initializer is not a constant).
1862 It is handled as if the object is initialized only with the bracket
1863 enclosed list if the types of the compound literal and the object match.
1864 The initializer list of the compound literal must be constant.
1865 If the object being initialized has array type of unknown size, the size is
1866 determined by compound literal size.
1868 @smallexample
1869 static struct foo x = (struct foo) @{1, 'a', 'b'@};
1870 static int y[] = (int []) @{1, 2, 3@};
1871 static int z[] = (int [3]) @{1@};
1872 @end smallexample
1874 @noindent
1875 The above lines are equivalent to the following:
1876 @smallexample
1877 static struct foo x = @{1, 'a', 'b'@};
1878 static int y[] = @{1, 2, 3@};
1879 static int z[] = @{1, 0, 0@};
1880 @end smallexample
1882 In C, a compound literal designates an unnamed object with static or
1883 automatic storage duration.  In C++, a compound literal designates a
1884 temporary object, which only lives until the end of its
1885 full-expression.  As a result, well-defined C code that takes the
1886 address of a subobject of a compound literal can be undefined in C++.
1887 For instance, if the array compound literal example above appeared
1888 inside a function, any subsequent use of @samp{foo} in C++ has
1889 undefined behavior because the lifetime of the array ends after the
1890 declaration of @samp{foo}.  As a result, the C++ compiler now rejects
1891 the conversion of a temporary array to a pointer.
1893 As an optimization, the C++ compiler sometimes gives array compound
1894 literals longer lifetimes: when the array either appears outside a
1895 function or has const-qualified type.  If @samp{foo} and its
1896 initializer had elements of @samp{char *const} type rather than
1897 @samp{char *}, or if @samp{foo} were a global variable, the array
1898 would have static storage duration.  But it is probably safest just to
1899 avoid the use of array compound literals in code compiled as C++.
1901 @node Designated Inits
1902 @section Designated Initializers
1903 @cindex initializers with labeled elements
1904 @cindex labeled elements in initializers
1905 @cindex case labels in initializers
1906 @cindex designated initializers
1908 Standard C90 requires the elements of an initializer to appear in a fixed
1909 order, the same as the order of the elements in the array or structure
1910 being initialized.
1912 In ISO C99 you can give the elements in any order, specifying the array
1913 indices or structure field names they apply to, and GNU C allows this as
1914 an extension in C90 mode as well.  This extension is not
1915 implemented in GNU C++.
1917 To specify an array index, write
1918 @samp{[@var{index}] =} before the element value.  For example,
1920 @smallexample
1921 int a[6] = @{ [4] = 29, [2] = 15 @};
1922 @end smallexample
1924 @noindent
1925 is equivalent to
1927 @smallexample
1928 int a[6] = @{ 0, 0, 15, 0, 29, 0 @};
1929 @end smallexample
1931 @noindent
1932 The index values must be constant expressions, even if the array being
1933 initialized is automatic.
1935 An alternative syntax for this that has been obsolete since GCC 2.5 but
1936 GCC still accepts is to write @samp{[@var{index}]} before the element
1937 value, with no @samp{=}.
1939 To initialize a range of elements to the same value, write
1940 @samp{[@var{first} ... @var{last}] = @var{value}}.  This is a GNU
1941 extension.  For example,
1943 @smallexample
1944 int widths[] = @{ [0 ... 9] = 1, [10 ... 99] = 2, [100] = 3 @};
1945 @end smallexample
1947 @noindent
1948 If the value in it has side-effects, the side-effects happen only once,
1949 not for each initialized field by the range initializer.
1951 @noindent
1952 Note that the length of the array is the highest value specified
1953 plus one.
1955 In a structure initializer, specify the name of a field to initialize
1956 with @samp{.@var{fieldname} =} before the element value.  For example,
1957 given the following structure,
1959 @smallexample
1960 struct point @{ int x, y; @};
1961 @end smallexample
1963 @noindent
1964 the following initialization
1966 @smallexample
1967 struct point p = @{ .y = yvalue, .x = xvalue @};
1968 @end smallexample
1970 @noindent
1971 is equivalent to
1973 @smallexample
1974 struct point p = @{ xvalue, yvalue @};
1975 @end smallexample
1977 Another syntax that has the same meaning, obsolete since GCC 2.5, is
1978 @samp{@var{fieldname}:}, as shown here:
1980 @smallexample
1981 struct point p = @{ y: yvalue, x: xvalue @};
1982 @end smallexample
1984 Omitted field members are implicitly initialized the same as objects
1985 that have static storage duration.
1987 @cindex designators
1988 The @samp{[@var{index}]} or @samp{.@var{fieldname}} is known as a
1989 @dfn{designator}.  You can also use a designator (or the obsolete colon
1990 syntax) when initializing a union, to specify which element of the union
1991 should be used.  For example,
1993 @smallexample
1994 union foo @{ int i; double d; @};
1996 union foo f = @{ .d = 4 @};
1997 @end smallexample
1999 @noindent
2000 converts 4 to a @code{double} to store it in the union using
2001 the second element.  By contrast, casting 4 to type @code{union foo}
2002 stores it into the union as the integer @code{i}, since it is
2003 an integer.  (@xref{Cast to Union}.)
2005 You can combine this technique of naming elements with ordinary C
2006 initialization of successive elements.  Each initializer element that
2007 does not have a designator applies to the next consecutive element of the
2008 array or structure.  For example,
2010 @smallexample
2011 int a[6] = @{ [1] = v1, v2, [4] = v4 @};
2012 @end smallexample
2014 @noindent
2015 is equivalent to
2017 @smallexample
2018 int a[6] = @{ 0, v1, v2, 0, v4, 0 @};
2019 @end smallexample
2021 Labeling the elements of an array initializer is especially useful
2022 when the indices are characters or belong to an @code{enum} type.
2023 For example:
2025 @smallexample
2026 int whitespace[256]
2027   = @{ [' '] = 1, ['\t'] = 1, ['\h'] = 1,
2028       ['\f'] = 1, ['\n'] = 1, ['\r'] = 1 @};
2029 @end smallexample
2031 @cindex designator lists
2032 You can also write a series of @samp{.@var{fieldname}} and
2033 @samp{[@var{index}]} designators before an @samp{=} to specify a
2034 nested subobject to initialize; the list is taken relative to the
2035 subobject corresponding to the closest surrounding brace pair.  For
2036 example, with the @samp{struct point} declaration above:
2038 @smallexample
2039 struct point ptarray[10] = @{ [2].y = yv2, [2].x = xv2, [0].x = xv0 @};
2040 @end smallexample
2042 @noindent
2043 If the same field is initialized multiple times, it has the value from
2044 the last initialization.  If any such overridden initialization has
2045 side-effect, it is unspecified whether the side-effect happens or not.
2046 Currently, GCC discards them and issues a warning.
2048 @node Case Ranges
2049 @section Case Ranges
2050 @cindex case ranges
2051 @cindex ranges in case statements
2053 You can specify a range of consecutive values in a single @code{case} label,
2054 like this:
2056 @smallexample
2057 case @var{low} ... @var{high}:
2058 @end smallexample
2060 @noindent
2061 This has the same effect as the proper number of individual @code{case}
2062 labels, one for each integer value from @var{low} to @var{high}, inclusive.
2064 This feature is especially useful for ranges of ASCII character codes:
2066 @smallexample
2067 case 'A' ... 'Z':
2068 @end smallexample
2070 @strong{Be careful:} Write spaces around the @code{...}, for otherwise
2071 it may be parsed wrong when you use it with integer values.  For example,
2072 write this:
2074 @smallexample
2075 case 1 ... 5:
2076 @end smallexample
2078 @noindent
2079 rather than this:
2081 @smallexample
2082 case 1...5:
2083 @end smallexample
2085 @node Cast to Union
2086 @section Cast to a Union Type
2087 @cindex cast to a union
2088 @cindex union, casting to a
2090 A cast to union type is similar to other casts, except that the type
2091 specified is a union type.  You can specify the type either with
2092 @code{union @var{tag}} or with a typedef name.  A cast to union is actually
2093 a constructor, not a cast, and hence does not yield an lvalue like
2094 normal casts.  (@xref{Compound Literals}.)
2096 The types that may be cast to the union type are those of the members
2097 of the union.  Thus, given the following union and variables:
2099 @smallexample
2100 union foo @{ int i; double d; @};
2101 int x;
2102 double y;
2103 @end smallexample
2105 @noindent
2106 both @code{x} and @code{y} can be cast to type @code{union foo}.
2108 Using the cast as the right-hand side of an assignment to a variable of
2109 union type is equivalent to storing in a member of the union:
2111 @smallexample
2112 union foo u;
2113 /* @r{@dots{}} */
2114 u = (union foo) x  @equiv{}  u.i = x
2115 u = (union foo) y  @equiv{}  u.d = y
2116 @end smallexample
2118 You can also use the union cast as a function argument:
2120 @smallexample
2121 void hack (union foo);
2122 /* @r{@dots{}} */
2123 hack ((union foo) x);
2124 @end smallexample
2126 @node Mixed Declarations
2127 @section Mixed Declarations and Code
2128 @cindex mixed declarations and code
2129 @cindex declarations, mixed with code
2130 @cindex code, mixed with declarations
2132 ISO C99 and ISO C++ allow declarations and code to be freely mixed
2133 within compound statements.  As an extension, GNU C also allows this in
2134 C90 mode.  For example, you could do:
2136 @smallexample
2137 int i;
2138 /* @r{@dots{}} */
2139 i++;
2140 int j = i + 2;
2141 @end smallexample
2143 Each identifier is visible from where it is declared until the end of
2144 the enclosing block.
2146 @node Function Attributes
2147 @section Declaring Attributes of Functions
2148 @cindex function attributes
2149 @cindex declaring attributes of functions
2150 @cindex functions that never return
2151 @cindex functions that return more than once
2152 @cindex functions that have no side effects
2153 @cindex functions in arbitrary sections
2154 @cindex functions that behave like malloc
2155 @cindex @code{volatile} applied to function
2156 @cindex @code{const} applied to function
2157 @cindex functions with @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style arguments
2158 @cindex functions with non-null pointer arguments
2159 @cindex functions that are passed arguments in registers on the 386
2160 @cindex functions that pop the argument stack on the 386
2161 @cindex functions that do not pop the argument stack on the 386
2162 @cindex functions that have different compilation options on the 386
2163 @cindex functions that have different optimization options
2164 @cindex functions that are dynamically resolved
2166 In GNU C, you declare certain things about functions called in your program
2167 which help the compiler optimize function calls and check your code more
2168 carefully.
2170 The keyword @code{__attribute__} allows you to specify special
2171 attributes when making a declaration.  This keyword is followed by an
2172 attribute specification inside double parentheses.  The following
2173 attributes are currently defined for functions on all targets:
2174 @code{aligned}, @code{alloc_size}, @code{alloc_align}, @code{assume_aligned},
2175 @code{noreturn}, @code{returns_twice}, @code{noinline}, @code{noclone},
2176 @code{always_inline}, @code{flatten}, @code{pure}, @code{const},
2177 @code{nothrow}, @code{sentinel}, @code{format}, @code{format_arg},
2178 @code{no_instrument_function}, @code{no_split_stack},
2179 @code{section}, @code{constructor},
2180 @code{destructor}, @code{used}, @code{unused}, @code{deprecated},
2181 @code{weak}, @code{malloc}, @code{alias}, @code{ifunc},
2182 @code{warn_unused_result}, @code{nonnull},
2183 @code{returns_nonnull}, @code{gnu_inline},
2184 @code{externally_visible}, @code{hot}, @code{cold}, @code{artificial},
2185 @code{no_sanitize_address}, @code{no_address_safety_analysis},
2186 @code{no_sanitize_undefined},
2187 @code{error} and @code{warning}.
2188 Several other attributes are defined for functions on particular
2189 target systems.  Other attributes, including @code{section} are
2190 supported for variables declarations (@pxref{Variable Attributes})
2191 and for types (@pxref{Type Attributes}).
2193 GCC plugins may provide their own attributes.
2195 You may also specify attributes with @samp{__} preceding and following
2196 each keyword.  This allows you to use them in header files without
2197 being concerned about a possible macro of the same name.  For example,
2198 you may use @code{__noreturn__} instead of @code{noreturn}.
2200 @xref{Attribute Syntax}, for details of the exact syntax for using
2201 attributes.
2203 @table @code
2204 @c Keep this table alphabetized by attribute name.  Treat _ as space.
2206 @item alias ("@var{target}")
2207 @cindex @code{alias} attribute
2208 The @code{alias} attribute causes the declaration to be emitted as an
2209 alias for another symbol, which must be specified.  For instance,
2211 @smallexample
2212 void __f () @{ /* @r{Do something.} */; @}
2213 void f () __attribute__ ((weak, alias ("__f")));
2214 @end smallexample
2216 @noindent
2217 defines @samp{f} to be a weak alias for @samp{__f}.  In C++, the
2218 mangled name for the target must be used.  It is an error if @samp{__f}
2219 is not defined in the same translation unit.
2221 Not all target machines support this attribute.
2223 @item aligned (@var{alignment})
2224 @cindex @code{aligned} attribute
2225 This attribute specifies a minimum alignment for the function,
2226 measured in bytes.
2228 You cannot use this attribute to decrease the alignment of a function,
2229 only to increase it.  However, when you explicitly specify a function
2230 alignment this overrides the effect of the
2231 @option{-falign-functions} (@pxref{Optimize Options}) option for this
2232 function.
2234 Note that the effectiveness of @code{aligned} attributes may be
2235 limited by inherent limitations in your linker.  On many systems, the
2236 linker is only able to arrange for functions to be aligned up to a
2237 certain maximum alignment.  (For some linkers, the maximum supported
2238 alignment may be very very small.)  See your linker documentation for
2239 further information.
2241 The @code{aligned} attribute can also be used for variables and fields
2242 (@pxref{Variable Attributes}.)
2244 @item alloc_size
2245 @cindex @code{alloc_size} attribute
2246 The @code{alloc_size} attribute is used to tell the compiler that the
2247 function return value points to memory, where the size is given by
2248 one or two of the functions parameters.  GCC uses this
2249 information to improve the correctness of @code{__builtin_object_size}.
2251 The function parameter(s) denoting the allocated size are specified by
2252 one or two integer arguments supplied to the attribute.  The allocated size
2253 is either the value of the single function argument specified or the product
2254 of the two function arguments specified.  Argument numbering starts at
2255 one.
2257 For instance,
2259 @smallexample
2260 void* my_calloc(size_t, size_t) __attribute__((alloc_size(1,2)))
2261 void* my_realloc(void*, size_t) __attribute__((alloc_size(2)))
2262 @end smallexample
2264 @noindent
2265 declares that @code{my_calloc} returns memory of the size given by
2266 the product of parameter 1 and 2 and that @code{my_realloc} returns memory
2267 of the size given by parameter 2.
2269 @item alloc_align
2270 @cindex @code{alloc_align} attribute
2271 The @code{alloc_align} attribute is used to tell the compiler that the
2272 function return value points to memory, where the returned pointer minimum
2273 alignment is given by one of the functions parameters.  GCC uses this
2274 information to improve pointer alignment analysis.
2276 The function parameter denoting the allocated alignment is specified by
2277 one integer argument, whose number is the argument of the attribute.
2278 Argument numbering starts at one.
2280 For instance,
2282 @smallexample
2283 void* my_memalign(size_t, size_t) __attribute__((alloc_align(1)))
2284 @end smallexample
2286 @noindent
2287 declares that @code{my_memalign} returns memory with minimum alignment
2288 given by parameter 1.
2290 @item assume_aligned
2291 @cindex @code{assume_aligned} attribute
2292 The @code{assume_aligned} attribute is used to tell the compiler that the
2293 function return value points to memory, where the returned pointer minimum
2294 alignment is given by the first argument.
2295 If the attribute has two arguments, the second argument is misalignment offset.
2297 For instance
2299 @smallexample
2300 void* my_alloc1(size_t) __attribute__((assume_aligned(16)))
2301 void* my_alloc2(size_t) __attribute__((assume_aligned(32, 8)))
2302 @end smallexample
2304 @noindent
2305 declares that @code{my_alloc1} returns 16-byte aligned pointer and
2306 that @code{my_alloc2} returns a pointer whose value modulo 32 is equal
2307 to 8.
2309 @item always_inline
2310 @cindex @code{always_inline} function attribute
2311 Generally, functions are not inlined unless optimization is specified.
2312 For functions declared inline, this attribute inlines the function even
2313 if no optimization level is specified.
2315 @item gnu_inline
2316 @cindex @code{gnu_inline} function attribute
2317 This attribute should be used with a function that is also declared
2318 with the @code{inline} keyword.  It directs GCC to treat the function
2319 as if it were defined in gnu90 mode even when compiling in C99 or
2320 gnu99 mode.
2322 If the function is declared @code{extern}, then this definition of the
2323 function is used only for inlining.  In no case is the function
2324 compiled as a standalone function, not even if you take its address
2325 explicitly.  Such an address becomes an external reference, as if you
2326 had only declared the function, and had not defined it.  This has
2327 almost the effect of a macro.  The way to use this is to put a
2328 function definition in a header file with this attribute, and put
2329 another copy of the function, without @code{extern}, in a library
2330 file.  The definition in the header file causes most calls to the
2331 function to be inlined.  If any uses of the function remain, they
2332 refer to the single copy in the library.  Note that the two
2333 definitions of the functions need not be precisely the same, although
2334 if they do not have the same effect your program may behave oddly.
2336 In C, if the function is neither @code{extern} nor @code{static}, then
2337 the function is compiled as a standalone function, as well as being
2338 inlined where possible.
2340 This is how GCC traditionally handled functions declared
2341 @code{inline}.  Since ISO C99 specifies a different semantics for
2342 @code{inline}, this function attribute is provided as a transition
2343 measure and as a useful feature in its own right.  This attribute is
2344 available in GCC 4.1.3 and later.  It is available if either of the
2345 preprocessor macros @code{__GNUC_GNU_INLINE__} or
2346 @code{__GNUC_STDC_INLINE__} are defined.  @xref{Inline,,An Inline
2347 Function is As Fast As a Macro}.
2349 In C++, this attribute does not depend on @code{extern} in any way,
2350 but it still requires the @code{inline} keyword to enable its special
2351 behavior.
2353 @item artificial
2354 @cindex @code{artificial} function attribute
2355 This attribute is useful for small inline wrappers that if possible
2356 should appear during debugging as a unit.  Depending on the debug
2357 info format it either means marking the function as artificial
2358 or using the caller location for all instructions within the inlined
2359 body.
2361 @item bank_switch
2362 @cindex interrupt handler functions
2363 When added to an interrupt handler with the M32C port, causes the
2364 prologue and epilogue to use bank switching to preserve the registers
2365 rather than saving them on the stack.
2367 @item flatten
2368 @cindex @code{flatten} function attribute
2369 Generally, inlining into a function is limited.  For a function marked with
2370 this attribute, every call inside this function is inlined, if possible.
2371 Whether the function itself is considered for inlining depends on its size and
2372 the current inlining parameters.
2374 @item error ("@var{message}")
2375 @cindex @code{error} function attribute
2376 If this attribute is used on a function declaration and a call to such a function
2377 is not eliminated through dead code elimination or other optimizations, an error
2378 that includes @var{message} is diagnosed.  This is useful
2379 for compile-time checking, especially together with @code{__builtin_constant_p}
2380 and inline functions where checking the inline function arguments is not
2381 possible through @code{extern char [(condition) ? 1 : -1];} tricks.
2382 While it is possible to leave the function undefined and thus invoke
2383 a link failure, when using this attribute the problem is diagnosed
2384 earlier and with exact location of the call even in presence of inline
2385 functions or when not emitting debugging information.
2387 @item warning ("@var{message}")
2388 @cindex @code{warning} function attribute
2389 If this attribute is used on a function declaration and a call to such a function
2390 is not eliminated through dead code elimination or other optimizations, a warning
2391 that includes @var{message} is diagnosed.  This is useful
2392 for compile-time checking, especially together with @code{__builtin_constant_p}
2393 and inline functions.  While it is possible to define the function with
2394 a message in @code{.gnu.warning*} section, when using this attribute the problem
2395 is diagnosed earlier and with exact location of the call even in presence
2396 of inline functions or when not emitting debugging information.
2398 @item cdecl
2399 @cindex functions that do pop the argument stack on the 386
2400 @opindex mrtd
2401 On the Intel 386, the @code{cdecl} attribute causes the compiler to
2402 assume that the calling function pops off the stack space used to
2403 pass arguments.  This is
2404 useful to override the effects of the @option{-mrtd} switch.
2406 @item const
2407 @cindex @code{const} function attribute
2408 Many functions do not examine any values except their arguments, and
2409 have no effects except the return value.  Basically this is just slightly
2410 more strict class than the @code{pure} attribute below, since function is not
2411 allowed to read global memory.
2413 @cindex pointer arguments
2414 Note that a function that has pointer arguments and examines the data
2415 pointed to must @emph{not} be declared @code{const}.  Likewise, a
2416 function that calls a non-@code{const} function usually must not be
2417 @code{const}.  It does not make sense for a @code{const} function to
2418 return @code{void}.
2420 The attribute @code{const} is not implemented in GCC versions earlier
2421 than 2.5.  An alternative way to declare that a function has no side
2422 effects, which works in the current version and in some older versions,
2423 is as follows:
2425 @smallexample
2426 typedef int intfn ();
2428 extern const intfn square;
2429 @end smallexample
2431 @noindent
2432 This approach does not work in GNU C++ from 2.6.0 on, since the language
2433 specifies that the @samp{const} must be attached to the return value.
2435 @item constructor
2436 @itemx destructor
2437 @itemx constructor (@var{priority})
2438 @itemx destructor (@var{priority})
2439 @cindex @code{constructor} function attribute
2440 @cindex @code{destructor} function attribute
2441 The @code{constructor} attribute causes the function to be called
2442 automatically before execution enters @code{main ()}.  Similarly, the
2443 @code{destructor} attribute causes the function to be called
2444 automatically after @code{main ()} completes or @code{exit ()} is
2445 called.  Functions with these attributes are useful for
2446 initializing data that is used implicitly during the execution of
2447 the program.
2449 You may provide an optional integer priority to control the order in
2450 which constructor and destructor functions are run.  A constructor
2451 with a smaller priority number runs before a constructor with a larger
2452 priority number; the opposite relationship holds for destructors.  So,
2453 if you have a constructor that allocates a resource and a destructor
2454 that deallocates the same resource, both functions typically have the
2455 same priority.  The priorities for constructor and destructor
2456 functions are the same as those specified for namespace-scope C++
2457 objects (@pxref{C++ Attributes}).
2459 These attributes are not currently implemented for Objective-C@.
2461 @item deprecated
2462 @itemx deprecated (@var{msg})
2463 @cindex @code{deprecated} attribute.
2464 The @code{deprecated} attribute results in a warning if the function
2465 is used anywhere in the source file.  This is useful when identifying
2466 functions that are expected to be removed in a future version of a
2467 program.  The warning also includes the location of the declaration
2468 of the deprecated function, to enable users to easily find further
2469 information about why the function is deprecated, or what they should
2470 do instead.  Note that the warnings only occurs for uses:
2472 @smallexample
2473 int old_fn () __attribute__ ((deprecated));
2474 int old_fn ();
2475 int (*fn_ptr)() = old_fn;
2476 @end smallexample
2478 @noindent
2479 results in a warning on line 3 but not line 2.  The optional @var{msg}
2480 argument, which must be a string, is printed in the warning if
2481 present.
2483 The @code{deprecated} attribute can also be used for variables and
2484 types (@pxref{Variable Attributes}, @pxref{Type Attributes}.)
2486 @item disinterrupt
2487 @cindex @code{disinterrupt} attribute
2488 On Epiphany and MeP targets, this attribute causes the compiler to emit
2489 instructions to disable interrupts for the duration of the given
2490 function.
2492 @item dllexport
2493 @cindex @code{__declspec(dllexport)}
2494 On Microsoft Windows targets and Symbian OS targets the
2495 @code{dllexport} attribute causes the compiler to provide a global
2496 pointer to a pointer in a DLL, so that it can be referenced with the
2497 @code{dllimport} attribute.  On Microsoft Windows targets, the pointer
2498 name is formed by combining @code{_imp__} and the function or variable
2499 name.
2501 You can use @code{__declspec(dllexport)} as a synonym for
2502 @code{__attribute__ ((dllexport))} for compatibility with other
2503 compilers.
2505 On systems that support the @code{visibility} attribute, this
2506 attribute also implies ``default'' visibility.  It is an error to
2507 explicitly specify any other visibility.
2509 In previous versions of GCC, the @code{dllexport} attribute was ignored
2510 for inlined functions, unless the @option{-fkeep-inline-functions} flag
2511 had been used.  The default behavior now is to emit all dllexported
2512 inline functions; however, this can cause object file-size bloat, in
2513 which case the old behavior can be restored by using
2514 @option{-fno-keep-inline-dllexport}.
2516 The attribute is also ignored for undefined symbols.
2518 When applied to C++ classes, the attribute marks defined non-inlined
2519 member functions and static data members as exports.  Static consts
2520 initialized in-class are not marked unless they are also defined
2521 out-of-class.
2523 For Microsoft Windows targets there are alternative methods for
2524 including the symbol in the DLL's export table such as using a
2525 @file{.def} file with an @code{EXPORTS} section or, with GNU ld, using
2526 the @option{--export-all} linker flag.
2528 @item dllimport
2529 @cindex @code{__declspec(dllimport)}
2530 On Microsoft Windows and Symbian OS targets, the @code{dllimport}
2531 attribute causes the compiler to reference a function or variable via
2532 a global pointer to a pointer that is set up by the DLL exporting the
2533 symbol.  The attribute implies @code{extern}.  On Microsoft Windows
2534 targets, the pointer name is formed by combining @code{_imp__} and the
2535 function or variable name.
2537 You can use @code{__declspec(dllimport)} as a synonym for
2538 @code{__attribute__ ((dllimport))} for compatibility with other
2539 compilers.
2541 On systems that support the @code{visibility} attribute, this
2542 attribute also implies ``default'' visibility.  It is an error to
2543 explicitly specify any other visibility.
2545 Currently, the attribute is ignored for inlined functions.  If the
2546 attribute is applied to a symbol @emph{definition}, an error is reported.
2547 If a symbol previously declared @code{dllimport} is later defined, the
2548 attribute is ignored in subsequent references, and a warning is emitted.
2549 The attribute is also overridden by a subsequent declaration as
2550 @code{dllexport}.
2552 When applied to C++ classes, the attribute marks non-inlined
2553 member functions and static data members as imports.  However, the
2554 attribute is ignored for virtual methods to allow creation of vtables
2555 using thunks.
2557 On the SH Symbian OS target the @code{dllimport} attribute also has
2558 another affect---it can cause the vtable and run-time type information
2559 for a class to be exported.  This happens when the class has a
2560 dllimported constructor or a non-inline, non-pure virtual function
2561 and, for either of those two conditions, the class also has an inline
2562 constructor or destructor and has a key function that is defined in
2563 the current translation unit.
2565 For Microsoft Windows targets the use of the @code{dllimport}
2566 attribute on functions is not necessary, but provides a small
2567 performance benefit by eliminating a thunk in the DLL@.  The use of the
2568 @code{dllimport} attribute on imported variables was required on older
2569 versions of the GNU linker, but can now be avoided by passing the
2570 @option{--enable-auto-import} switch to the GNU linker.  As with
2571 functions, using the attribute for a variable eliminates a thunk in
2572 the DLL@.
2574 One drawback to using this attribute is that a pointer to a
2575 @emph{variable} marked as @code{dllimport} cannot be used as a constant
2576 address. However, a pointer to a @emph{function} with the
2577 @code{dllimport} attribute can be used as a constant initializer; in
2578 this case, the address of a stub function in the import lib is
2579 referenced.  On Microsoft Windows targets, the attribute can be disabled
2580 for functions by setting the @option{-mnop-fun-dllimport} flag.
2582 @item eightbit_data
2583 @cindex eight-bit data on the H8/300, H8/300H, and H8S
2584 Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
2585 variable should be placed into the eight-bit data section.
2586 The compiler generates more efficient code for certain operations
2587 on data in the eight-bit data area.  Note the eight-bit data area is limited to
2588 256 bytes of data.
2590 You must use GAS and GLD from GNU binutils version 2.7 or later for
2591 this attribute to work correctly.
2593 @item exception
2594 @cindex exception handler functions
2595 Use this attribute on the NDS32 target to indicate that the specified function
2596 is an exception handler.  The compiler will generate corresponding sections
2597 for use in an exception handler.
2599 @item exception_handler
2600 @cindex exception handler functions on the Blackfin processor
2601 Use this attribute on the Blackfin to indicate that the specified function
2602 is an exception handler.  The compiler generates function entry and
2603 exit sequences suitable for use in an exception handler when this
2604 attribute is present.
2606 @item externally_visible
2607 @cindex @code{externally_visible} attribute.
2608 This attribute, attached to a global variable or function, nullifies
2609 the effect of the @option{-fwhole-program} command-line option, so the
2610 object remains visible outside the current compilation unit.
2612 If @option{-fwhole-program} is used together with @option{-flto} and 
2613 @command{gold} is used as the linker plugin, 
2614 @code{externally_visible} attributes are automatically added to functions 
2615 (not variable yet due to a current @command{gold} issue) 
2616 that are accessed outside of LTO objects according to resolution file
2617 produced by @command{gold}.
2618 For other linkers that cannot generate resolution file,
2619 explicit @code{externally_visible} attributes are still necessary.
2621 @item far
2622 @cindex functions that handle memory bank switching
2623 On 68HC11 and 68HC12 the @code{far} attribute causes the compiler to
2624 use a calling convention that takes care of switching memory banks when
2625 entering and leaving a function.  This calling convention is also the
2626 default when using the @option{-mlong-calls} option.
2628 On 68HC12 the compiler uses the @code{call} and @code{rtc} instructions
2629 to call and return from a function.
2631 On 68HC11 the compiler generates a sequence of instructions
2632 to invoke a board-specific routine to switch the memory bank and call the
2633 real function.  The board-specific routine simulates a @code{call}.
2634 At the end of a function, it jumps to a board-specific routine
2635 instead of using @code{rts}.  The board-specific return routine simulates
2636 the @code{rtc}.
2638 On MeP targets this causes the compiler to use a calling convention
2639 that assumes the called function is too far away for the built-in
2640 addressing modes.
2642 @item fast_interrupt
2643 @cindex interrupt handler functions
2644 Use this attribute on the M32C and RX ports to indicate that the specified
2645 function is a fast interrupt handler.  This is just like the
2646 @code{interrupt} attribute, except that @code{freit} is used to return
2647 instead of @code{reit}.
2649 @item fastcall
2650 @cindex functions that pop the argument stack on the 386
2651 On the Intel 386, the @code{fastcall} attribute causes the compiler to
2652 pass the first argument (if of integral type) in the register ECX and
2653 the second argument (if of integral type) in the register EDX@.  Subsequent
2654 and other typed arguments are passed on the stack.  The called function
2655 pops the arguments off the stack.  If the number of arguments is variable all
2656 arguments are pushed on the stack.
2658 @item thiscall
2659 @cindex functions that pop the argument stack on the 386
2660 On the Intel 386, the @code{thiscall} attribute causes the compiler to
2661 pass the first argument (if of integral type) in the register ECX.
2662 Subsequent and other typed arguments are passed on the stack. The called
2663 function pops the arguments off the stack.
2664 If the number of arguments is variable all arguments are pushed on the
2665 stack.
2666 The @code{thiscall} attribute is intended for C++ non-static member functions.
2667 As a GCC extension, this calling convention can be used for C functions
2668 and for static member methods.
2670 @item format (@var{archetype}, @var{string-index}, @var{first-to-check})
2671 @cindex @code{format} function attribute
2672 @opindex Wformat
2673 The @code{format} attribute specifies that a function takes @code{printf},
2674 @code{scanf}, @code{strftime} or @code{strfmon} style arguments that
2675 should be type-checked against a format string.  For example, the
2676 declaration:
2678 @smallexample
2679 extern int
2680 my_printf (void *my_object, const char *my_format, ...)
2681       __attribute__ ((format (printf, 2, 3)));
2682 @end smallexample
2684 @noindent
2685 causes the compiler to check the arguments in calls to @code{my_printf}
2686 for consistency with the @code{printf} style format string argument
2687 @code{my_format}.
2689 The parameter @var{archetype} determines how the format string is
2690 interpreted, and should be @code{printf}, @code{scanf}, @code{strftime},
2691 @code{gnu_printf}, @code{gnu_scanf}, @code{gnu_strftime} or
2692 @code{strfmon}.  (You can also use @code{__printf__},
2693 @code{__scanf__}, @code{__strftime__} or @code{__strfmon__}.)  On
2694 MinGW targets, @code{ms_printf}, @code{ms_scanf}, and
2695 @code{ms_strftime} are also present.
2696 @var{archetype} values such as @code{printf} refer to the formats accepted
2697 by the system's C runtime library,
2698 while values prefixed with @samp{gnu_} always refer
2699 to the formats accepted by the GNU C Library.  On Microsoft Windows
2700 targets, values prefixed with @samp{ms_} refer to the formats accepted by the
2701 @file{msvcrt.dll} library.
2702 The parameter @var{string-index}
2703 specifies which argument is the format string argument (starting
2704 from 1), while @var{first-to-check} is the number of the first
2705 argument to check against the format string.  For functions
2706 where the arguments are not available to be checked (such as
2707 @code{vprintf}), specify the third parameter as zero.  In this case the
2708 compiler only checks the format string for consistency.  For
2709 @code{strftime} formats, the third parameter is required to be zero.
2710 Since non-static C++ methods have an implicit @code{this} argument, the
2711 arguments of such methods should be counted from two, not one, when
2712 giving values for @var{string-index} and @var{first-to-check}.
2714 In the example above, the format string (@code{my_format}) is the second
2715 argument of the function @code{my_print}, and the arguments to check
2716 start with the third argument, so the correct parameters for the format
2717 attribute are 2 and 3.
2719 @opindex ffreestanding
2720 @opindex fno-builtin
2721 The @code{format} attribute allows you to identify your own functions
2722 that take format strings as arguments, so that GCC can check the
2723 calls to these functions for errors.  The compiler always (unless
2724 @option{-ffreestanding} or @option{-fno-builtin} is used) checks formats
2725 for the standard library functions @code{printf}, @code{fprintf},
2726 @code{sprintf}, @code{scanf}, @code{fscanf}, @code{sscanf}, @code{strftime},
2727 @code{vprintf}, @code{vfprintf} and @code{vsprintf} whenever such
2728 warnings are requested (using @option{-Wformat}), so there is no need to
2729 modify the header file @file{stdio.h}.  In C99 mode, the functions
2730 @code{snprintf}, @code{vsnprintf}, @code{vscanf}, @code{vfscanf} and
2731 @code{vsscanf} are also checked.  Except in strictly conforming C
2732 standard modes, the X/Open function @code{strfmon} is also checked as
2733 are @code{printf_unlocked} and @code{fprintf_unlocked}.
2734 @xref{C Dialect Options,,Options Controlling C Dialect}.
2736 For Objective-C dialects, @code{NSString} (or @code{__NSString__}) is
2737 recognized in the same context.  Declarations including these format attributes
2738 are parsed for correct syntax, however the result of checking of such format
2739 strings is not yet defined, and is not carried out by this version of the
2740 compiler.
2742 The target may also provide additional types of format checks.
2743 @xref{Target Format Checks,,Format Checks Specific to Particular
2744 Target Machines}.
2746 @item format_arg (@var{string-index})
2747 @cindex @code{format_arg} function attribute
2748 @opindex Wformat-nonliteral
2749 The @code{format_arg} attribute specifies that a function takes a format
2750 string for a @code{printf}, @code{scanf}, @code{strftime} or
2751 @code{strfmon} style function and modifies it (for example, to translate
2752 it into another language), so the result can be passed to a
2753 @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style
2754 function (with the remaining arguments to the format function the same
2755 as they would have been for the unmodified string).  For example, the
2756 declaration:
2758 @smallexample
2759 extern char *
2760 my_dgettext (char *my_domain, const char *my_format)
2761       __attribute__ ((format_arg (2)));
2762 @end smallexample
2764 @noindent
2765 causes the compiler to check the arguments in calls to a @code{printf},
2766 @code{scanf}, @code{strftime} or @code{strfmon} type function, whose
2767 format string argument is a call to the @code{my_dgettext} function, for
2768 consistency with the format string argument @code{my_format}.  If the
2769 @code{format_arg} attribute had not been specified, all the compiler
2770 could tell in such calls to format functions would be that the format
2771 string argument is not constant; this would generate a warning when
2772 @option{-Wformat-nonliteral} is used, but the calls could not be checked
2773 without the attribute.
2775 The parameter @var{string-index} specifies which argument is the format
2776 string argument (starting from one).  Since non-static C++ methods have
2777 an implicit @code{this} argument, the arguments of such methods should
2778 be counted from two.
2780 The @code{format_arg} attribute allows you to identify your own
2781 functions that modify format strings, so that GCC can check the
2782 calls to @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon}
2783 type function whose operands are a call to one of your own function.
2784 The compiler always treats @code{gettext}, @code{dgettext}, and
2785 @code{dcgettext} in this manner except when strict ISO C support is
2786 requested by @option{-ansi} or an appropriate @option{-std} option, or
2787 @option{-ffreestanding} or @option{-fno-builtin}
2788 is used.  @xref{C Dialect Options,,Options
2789 Controlling C Dialect}.
2791 For Objective-C dialects, the @code{format-arg} attribute may refer to an
2792 @code{NSString} reference for compatibility with the @code{format} attribute
2793 above.
2795 The target may also allow additional types in @code{format-arg} attributes.
2796 @xref{Target Format Checks,,Format Checks Specific to Particular
2797 Target Machines}.
2799 @item function_vector
2800 @cindex calling functions through the function vector on H8/300, M16C, M32C and SH2A processors
2801 Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
2802 function should be called through the function vector.  Calling a
2803 function through the function vector reduces code size, however;
2804 the function vector has a limited size (maximum 128 entries on the H8/300
2805 and 64 entries on the H8/300H and H8S) and shares space with the interrupt vector.
2807 On SH2A targets, this attribute declares a function to be called using the
2808 TBR relative addressing mode.  The argument to this attribute is the entry
2809 number of the same function in a vector table containing all the TBR
2810 relative addressable functions.  For correct operation the TBR must be setup
2811 accordingly to point to the start of the vector table before any functions with
2812 this attribute are invoked.  Usually a good place to do the initialization is
2813 the startup routine.  The TBR relative vector table can have at max 256 function
2814 entries.  The jumps to these functions are generated using a SH2A specific,
2815 non delayed branch instruction JSR/N @@(disp8,TBR).  You must use GAS and GLD
2816 from GNU binutils version 2.7 or later for this attribute to work correctly.
2818 Please refer the example of M16C target, to see the use of this
2819 attribute while declaring a function,
2821 In an application, for a function being called once, this attribute
2822 saves at least 8 bytes of code; and if other successive calls are being
2823 made to the same function, it saves 2 bytes of code per each of these
2824 calls.
2826 On M16C/M32C targets, the @code{function_vector} attribute declares a
2827 special page subroutine call function. Use of this attribute reduces
2828 the code size by 2 bytes for each call generated to the
2829 subroutine. The argument to the attribute is the vector number entry
2830 from the special page vector table which contains the 16 low-order
2831 bits of the subroutine's entry address. Each vector table has special
2832 page number (18 to 255) that is used in @code{jsrs} instructions.
2833 Jump addresses of the routines are generated by adding 0x0F0000 (in
2834 case of M16C targets) or 0xFF0000 (in case of M32C targets), to the
2835 2-byte addresses set in the vector table. Therefore you need to ensure
2836 that all the special page vector routines should get mapped within the
2837 address range 0x0F0000 to 0x0FFFFF (for M16C) and 0xFF0000 to 0xFFFFFF
2838 (for M32C).
2840 In the following example 2 bytes are saved for each call to
2841 function @code{foo}.
2843 @smallexample
2844 void foo (void) __attribute__((function_vector(0x18)));
2845 void foo (void)
2849 void bar (void)
2851     foo();
2853 @end smallexample
2855 If functions are defined in one file and are called in another file,
2856 then be sure to write this declaration in both files.
2858 This attribute is ignored for R8C target.
2860 @item ifunc ("@var{resolver}")
2861 @cindex @code{ifunc} attribute
2862 The @code{ifunc} attribute is used to mark a function as an indirect
2863 function using the STT_GNU_IFUNC symbol type extension to the ELF
2864 standard.  This allows the resolution of the symbol value to be
2865 determined dynamically at load time, and an optimized version of the
2866 routine can be selected for the particular processor or other system
2867 characteristics determined then.  To use this attribute, first define
2868 the implementation functions available, and a resolver function that
2869 returns a pointer to the selected implementation function.  The
2870 implementation functions' declarations must match the API of the
2871 function being implemented, the resolver's declaration is be a
2872 function returning pointer to void function returning void:
2874 @smallexample
2875 void *my_memcpy (void *dst, const void *src, size_t len)
2877   @dots{}
2880 static void (*resolve_memcpy (void)) (void)
2882   return my_memcpy; // we'll just always select this routine
2884 @end smallexample
2886 @noindent
2887 The exported header file declaring the function the user calls would
2888 contain:
2890 @smallexample
2891 extern void *memcpy (void *, const void *, size_t);
2892 @end smallexample
2894 @noindent
2895 allowing the user to call this as a regular function, unaware of the
2896 implementation.  Finally, the indirect function needs to be defined in
2897 the same translation unit as the resolver function:
2899 @smallexample
2900 void *memcpy (void *, const void *, size_t)
2901      __attribute__ ((ifunc ("resolve_memcpy")));
2902 @end smallexample
2904 Indirect functions cannot be weak, and require a recent binutils (at
2905 least version 2.20.1), and GNU C library (at least version 2.11.1).
2907 @item interrupt
2908 @cindex interrupt handler functions
2909 Use this attribute on the ARC, ARM, AVR, CR16, Epiphany, M32C, M32R/D,
2910 m68k, MeP, MIPS, MSP430, RL78, RX and Xstormy16 ports to indicate that
2911 the specified function is an
2912 interrupt handler.  The compiler generates function entry and exit
2913 sequences suitable for use in an interrupt handler when this attribute
2914 is present.  With Epiphany targets it may also generate a special section with
2915 code to initialize the interrupt vector table.
2917 Note, interrupt handlers for the Blackfin, H8/300, H8/300H, H8S, MicroBlaze,
2918 and SH processors can be specified via the @code{interrupt_handler} attribute.
2920 Note, on the ARC, you must specify the kind of interrupt to be handled
2921 in a parameter to the interrupt attribute like this:
2923 @smallexample
2924 void f () __attribute__ ((interrupt ("ilink1")));
2925 @end smallexample
2927 Permissible values for this parameter are: @w{@code{ilink1}} and
2928 @w{@code{ilink2}}.
2930 Note, on the AVR, the hardware globally disables interrupts when an
2931 interrupt is executed.  The first instruction of an interrupt handler
2932 declared with this attribute is a @code{SEI} instruction to
2933 re-enable interrupts.  See also the @code{signal} function attribute
2934 that does not insert a @code{SEI} instruction.  If both @code{signal} and
2935 @code{interrupt} are specified for the same function, @code{signal}
2936 is silently ignored.
2938 Note, for the ARM, you can specify the kind of interrupt to be handled by
2939 adding an optional parameter to the interrupt attribute like this:
2941 @smallexample
2942 void f () __attribute__ ((interrupt ("IRQ")));
2943 @end smallexample
2945 @noindent
2946 Permissible values for this parameter are: @code{IRQ}, @code{FIQ},
2947 @code{SWI}, @code{ABORT} and @code{UNDEF}.
2949 On ARMv7-M the interrupt type is ignored, and the attribute means the function
2950 may be called with a word-aligned stack pointer.
2952 Note, for the MSP430 you can provide an argument to the interrupt
2953 attribute which specifies a name or number.  If the argument is a
2954 number it indicates the slot in the interrupt vector table (0 - 31) to
2955 which this handler should be assigned.  If the argument is a name it
2956 is treated as a symbolic name for the vector slot.  These names should
2957 match up with appropriate entries in the linker script.  By default
2958 the names @code{watchdog} for vector 26, @code{nmi} for vector 30 and
2959 @code{reset} for vector 31 are recognised.
2961 You can also use the following function attributes to modify how
2962 normal functions interact with interrupt functions:
2964 @table @code
2965 @item critical
2966 @cindex @code{critical} attribute
2967 Critical functions disable interrupts upon entry and restore the
2968 previous interrupt state upon exit.  Critical functions cannot also
2969 have the @code{naked} or @code{reentrant} attributes.  They can have
2970 the @code{interrupt} attribute.
2972 @item reentrant
2973 @cindex @code{reentrant} attribute
2974 Reentrant functions disable interrupts upon entry and enable them
2975 upon exit.  Reentrant functions cannot also have the @code{naked}
2976 or @code{critical} attributes.  They can have the @code{interrupt}
2977 attribute.
2979 @item wakeup
2980 @cindex @code{wakeup} attribute
2981 This attribute only applies to interrupt functions.  It is silently
2982 ignored if applied to a non-interrupt function.  A wakeup interrupt
2983 function will rouse the processor from any low-power state that it
2984 might be in when the function exits.
2986 @end table
2988 On Epiphany targets one or more optional parameters can be added like this:
2990 @smallexample
2991 void __attribute__ ((interrupt ("dma0, dma1"))) universal_dma_handler ();
2992 @end smallexample
2994 Permissible values for these parameters are: @w{@code{reset}},
2995 @w{@code{software_exception}}, @w{@code{page_miss}},
2996 @w{@code{timer0}}, @w{@code{timer1}}, @w{@code{message}},
2997 @w{@code{dma0}}, @w{@code{dma1}}, @w{@code{wand}} and @w{@code{swi}}.
2998 Multiple parameters indicate that multiple entries in the interrupt
2999 vector table should be initialized for this function, i.e.@: for each
3000 parameter @w{@var{name}}, a jump to the function is emitted in
3001 the section @w{ivt_entry_@var{name}}.  The parameter(s) may be omitted
3002 entirely, in which case no interrupt vector table entry is provided.
3004 Note, on Epiphany targets, interrupts are enabled inside the function
3005 unless the @code{disinterrupt} attribute is also specified.
3007 On Epiphany targets, you can also use the following attribute to
3008 modify the behavior of an interrupt handler:
3009 @table @code
3010 @item forwarder_section
3011 @cindex @code{forwarder_section} attribute
3012 The interrupt handler may be in external memory which cannot be
3013 reached by a branch instruction, so generate a local memory trampoline
3014 to transfer control.  The single parameter identifies the section where
3015 the trampoline is placed.
3016 @end table
3018 The following examples are all valid uses of these attributes on
3019 Epiphany targets:
3020 @smallexample
3021 void __attribute__ ((interrupt)) universal_handler ();
3022 void __attribute__ ((interrupt ("dma1"))) dma1_handler ();
3023 void __attribute__ ((interrupt ("dma0, dma1"))) universal_dma_handler ();
3024 void __attribute__ ((interrupt ("timer0"), disinterrupt))
3025   fast_timer_handler ();
3026 void __attribute__ ((interrupt ("dma0, dma1"), forwarder_section ("tramp")))
3027   external_dma_handler ();
3028 @end smallexample
3030 On MIPS targets, you can use the following attributes to modify the behavior
3031 of an interrupt handler:
3032 @table @code
3033 @item use_shadow_register_set
3034 @cindex @code{use_shadow_register_set} attribute
3035 Assume that the handler uses a shadow register set, instead of
3036 the main general-purpose registers.
3038 @item keep_interrupts_masked
3039 @cindex @code{keep_interrupts_masked} attribute
3040 Keep interrupts masked for the whole function.  Without this attribute,
3041 GCC tries to reenable interrupts for as much of the function as it can.
3043 @item use_debug_exception_return
3044 @cindex @code{use_debug_exception_return} attribute
3045 Return using the @code{deret} instruction.  Interrupt handlers that don't
3046 have this attribute return using @code{eret} instead.
3047 @end table
3049 You can use any combination of these attributes, as shown below:
3050 @smallexample
3051 void __attribute__ ((interrupt)) v0 ();
3052 void __attribute__ ((interrupt, use_shadow_register_set)) v1 ();
3053 void __attribute__ ((interrupt, keep_interrupts_masked)) v2 ();
3054 void __attribute__ ((interrupt, use_debug_exception_return)) v3 ();
3055 void __attribute__ ((interrupt, use_shadow_register_set,
3056                      keep_interrupts_masked)) v4 ();
3057 void __attribute__ ((interrupt, use_shadow_register_set,
3058                      use_debug_exception_return)) v5 ();
3059 void __attribute__ ((interrupt, keep_interrupts_masked,
3060                      use_debug_exception_return)) v6 ();
3061 void __attribute__ ((interrupt, use_shadow_register_set,
3062                      keep_interrupts_masked,
3063                      use_debug_exception_return)) v7 ();
3064 @end smallexample
3066 On NDS32 target, this attribute is to indicate that the specified function
3067 is an interrupt handler.  The compiler will generate corresponding sections
3068 for use in an interrupt handler.  You can use the following attributes
3069 to modify the behavior:
3070 @table @code
3071 @item nested
3072 @cindex @code{nested} attribute
3073 This interrupt service routine is interruptible.
3074 @item not_nested
3075 @cindex @code{not_nested} attribute
3076 This interrupt service routine is not interruptible.
3077 @item nested_ready
3078 @cindex @code{nested_ready} attribute
3079 This interrupt service routine is interruptible after @code{PSW.GIE}
3080 (global interrupt enable) is set.  This allows interrupt service routine to
3081 finish some short critical code before enabling interrupts.
3082 @item save_all
3083 @cindex @code{save_all} attribute
3084 The system will help save all registers into stack before entering
3085 interrupt handler.
3086 @item partial_save
3087 @cindex @code{partial_save} attribute
3088 The system will help save caller registers into stack before entering
3089 interrupt handler.
3090 @end table
3092 On RL78, use @code{brk_interrupt} instead of @code{interrupt} for
3093 handlers intended to be used with the @code{BRK} opcode (i.e.@: those
3094 that must end with @code{RETB} instead of @code{RETI}).
3096 @item interrupt_handler
3097 @cindex interrupt handler functions on the Blackfin, m68k, H8/300 and SH processors
3098 Use this attribute on the Blackfin, m68k, H8/300, H8/300H, H8S, and SH to
3099 indicate that the specified function is an interrupt handler.  The compiler
3100 generates function entry and exit sequences suitable for use in an
3101 interrupt handler when this attribute is present.
3103 @item interrupt_thread
3104 @cindex interrupt thread functions on fido
3105 Use this attribute on fido, a subarchitecture of the m68k, to indicate
3106 that the specified function is an interrupt handler that is designed
3107 to run as a thread.  The compiler omits generate prologue/epilogue
3108 sequences and replaces the return instruction with a @code{sleep}
3109 instruction.  This attribute is available only on fido.
3111 @item isr
3112 @cindex interrupt service routines on ARM
3113 Use this attribute on ARM to write Interrupt Service Routines. This is an
3114 alias to the @code{interrupt} attribute above.
3116 @item kspisusp
3117 @cindex User stack pointer in interrupts on the Blackfin
3118 When used together with @code{interrupt_handler}, @code{exception_handler}
3119 or @code{nmi_handler}, code is generated to load the stack pointer
3120 from the USP register in the function prologue.
3122 @item l1_text
3123 @cindex @code{l1_text} function attribute
3124 This attribute specifies a function to be placed into L1 Instruction
3125 SRAM@. The function is put into a specific section named @code{.l1.text}.
3126 With @option{-mfdpic}, function calls with a such function as the callee
3127 or caller uses inlined PLT.
3129 @item l2
3130 @cindex @code{l2} function attribute
3131 On the Blackfin, this attribute specifies a function to be placed into L2
3132 SRAM. The function is put into a specific section named
3133 @code{.l1.text}. With @option{-mfdpic}, callers of such functions use
3134 an inlined PLT.
3136 @item leaf
3137 @cindex @code{leaf} function attribute
3138 Calls to external functions with this attribute must return to the current
3139 compilation unit only by return or by exception handling.  In particular, leaf
3140 functions are not allowed to call callback function passed to it from the current
3141 compilation unit or directly call functions exported by the unit or longjmp
3142 into the unit.  Leaf function might still call functions from other compilation
3143 units and thus they are not necessarily leaf in the sense that they contain no
3144 function calls at all.
3146 The attribute is intended for library functions to improve dataflow analysis.
3147 The compiler takes the hint that any data not escaping the current compilation unit can
3148 not be used or modified by the leaf function.  For example, the @code{sin} function
3149 is a leaf function, but @code{qsort} is not.
3151 Note that leaf functions might invoke signals and signal handlers might be
3152 defined in the current compilation unit and use static variables.  The only
3153 compliant way to write such a signal handler is to declare such variables
3154 @code{volatile}.
3156 The attribute has no effect on functions defined within the current compilation
3157 unit.  This is to allow easy merging of multiple compilation units into one,
3158 for example, by using the link-time optimization.  For this reason the
3159 attribute is not allowed on types to annotate indirect calls.
3161 @item long_call/medium_call/short_call
3162 @cindex indirect calls on ARC
3163 @cindex indirect calls on ARM
3164 @cindex indirect calls on Epiphany
3165 These attributes specify how a particular function is called on
3166 ARC, ARM and Epiphany - with @code{medium_call} being specific to ARC.
3167 These attributes override the
3168 @option{-mlong-calls} (@pxref{ARM Options} and @ref{ARC Options})
3169 and @option{-mmedium-calls} (@pxref{ARC Options})
3170 command-line switches and @code{#pragma long_calls} settings.  For ARM, the
3171 @code{long_call} attribute indicates that the function might be far
3172 away from the call site and require a different (more expensive)
3173 calling sequence.   The @code{short_call} attribute always places
3174 the offset to the function from the call site into the @samp{BL}
3175 instruction directly.
3177 For ARC, a function marked with the @code{long_call} attribute is
3178 always called using register-indirect jump-and-link instructions,
3179 thereby enabling the called function to be placed anywhere within the
3180 32-bit address space.  A function marked with the @code{medium_call}
3181 attribute will always be close enough to be called with an unconditional
3182 branch-and-link instruction, which has a 25-bit offset from
3183 the call site.  A function marked with the @code{short_call}
3184 attribute will always be close enough to be called with a conditional
3185 branch-and-link instruction, which has a 21-bit offset from
3186 the call site.
3188 @item longcall/shortcall
3189 @cindex functions called via pointer on the RS/6000 and PowerPC
3190 On the Blackfin, RS/6000 and PowerPC, the @code{longcall} attribute
3191 indicates that the function might be far away from the call site and
3192 require a different (more expensive) calling sequence.  The
3193 @code{shortcall} attribute indicates that the function is always close
3194 enough for the shorter calling sequence to be used.  These attributes
3195 override both the @option{-mlongcall} switch and, on the RS/6000 and
3196 PowerPC, the @code{#pragma longcall} setting.
3198 @xref{RS/6000 and PowerPC Options}, for more information on whether long
3199 calls are necessary.
3201 @item long_call/near/far
3202 @cindex indirect calls on MIPS
3203 These attributes specify how a particular function is called on MIPS@.
3204 The attributes override the @option{-mlong-calls} (@pxref{MIPS Options})
3205 command-line switch.  The @code{long_call} and @code{far} attributes are
3206 synonyms, and cause the compiler to always call
3207 the function by first loading its address into a register, and then using
3208 the contents of that register.  The @code{near} attribute has the opposite
3209 effect; it specifies that non-PIC calls should be made using the more
3210 efficient @code{jal} instruction.
3212 @item malloc
3213 @cindex @code{malloc} attribute
3214 The @code{malloc} attribute is used to tell the compiler that a function
3215 may be treated as if any non-@code{NULL} pointer it returns cannot
3216 alias any other pointer valid when the function returns and that the memory
3217 has undefined content.
3218 This often improves optimization.
3219 Standard functions with this property include @code{malloc} and
3220 @code{calloc}.  @code{realloc}-like functions do not have this
3221 property as the memory pointed to does not have undefined content.
3223 @item mips16/nomips16
3224 @cindex @code{mips16} attribute
3225 @cindex @code{nomips16} attribute
3227 On MIPS targets, you can use the @code{mips16} and @code{nomips16}
3228 function attributes to locally select or turn off MIPS16 code generation.
3229 A function with the @code{mips16} attribute is emitted as MIPS16 code,
3230 while MIPS16 code generation is disabled for functions with the
3231 @code{nomips16} attribute.  These attributes override the
3232 @option{-mips16} and @option{-mno-mips16} options on the command line
3233 (@pxref{MIPS Options}).
3235 When compiling files containing mixed MIPS16 and non-MIPS16 code, the
3236 preprocessor symbol @code{__mips16} reflects the setting on the command line,
3237 not that within individual functions.  Mixed MIPS16 and non-MIPS16 code
3238 may interact badly with some GCC extensions such as @code{__builtin_apply}
3239 (@pxref{Constructing Calls}).
3241 @item micromips/nomicromips
3242 @cindex @code{micromips} attribute
3243 @cindex @code{nomicromips} attribute
3245 On MIPS targets, you can use the @code{micromips} and @code{nomicromips}
3246 function attributes to locally select or turn off microMIPS code generation.
3247 A function with the @code{micromips} attribute is emitted as microMIPS code,
3248 while microMIPS code generation is disabled for functions with the
3249 @code{nomicromips} attribute.  These attributes override the
3250 @option{-mmicromips} and @option{-mno-micromips} options on the command line
3251 (@pxref{MIPS Options}).
3253 When compiling files containing mixed microMIPS and non-microMIPS code, the
3254 preprocessor symbol @code{__mips_micromips} reflects the setting on the
3255 command line,
3256 not that within individual functions.  Mixed microMIPS and non-microMIPS code
3257 may interact badly with some GCC extensions such as @code{__builtin_apply}
3258 (@pxref{Constructing Calls}).
3260 @item model (@var{model-name})
3261 @cindex function addressability on the M32R/D
3262 @cindex variable addressability on the IA-64
3264 On the M32R/D, use this attribute to set the addressability of an
3265 object, and of the code generated for a function.  The identifier
3266 @var{model-name} is one of @code{small}, @code{medium}, or
3267 @code{large}, representing each of the code models.
3269 Small model objects live in the lower 16MB of memory (so that their
3270 addresses can be loaded with the @code{ld24} instruction), and are
3271 callable with the @code{bl} instruction.
3273 Medium model objects may live anywhere in the 32-bit address space (the
3274 compiler generates @code{seth/add3} instructions to load their addresses),
3275 and are callable with the @code{bl} instruction.
3277 Large model objects may live anywhere in the 32-bit address space (the
3278 compiler generates @code{seth/add3} instructions to load their addresses),
3279 and may not be reachable with the @code{bl} instruction (the compiler
3280 generates the much slower @code{seth/add3/jl} instruction sequence).
3282 On IA-64, use this attribute to set the addressability of an object.
3283 At present, the only supported identifier for @var{model-name} is
3284 @code{small}, indicating addressability via ``small'' (22-bit)
3285 addresses (so that their addresses can be loaded with the @code{addl}
3286 instruction).  Caveat: such addressing is by definition not position
3287 independent and hence this attribute must not be used for objects
3288 defined by shared libraries.
3290 @item ms_abi/sysv_abi
3291 @cindex @code{ms_abi} attribute
3292 @cindex @code{sysv_abi} attribute
3294 On 32-bit and 64-bit (i?86|x86_64)-*-* targets, you can use an ABI attribute
3295 to indicate which calling convention should be used for a function.  The
3296 @code{ms_abi} attribute tells the compiler to use the Microsoft ABI,
3297 while the @code{sysv_abi} attribute tells the compiler to use the ABI
3298 used on GNU/Linux and other systems.  The default is to use the Microsoft ABI
3299 when targeting Windows.  On all other systems, the default is the x86/AMD ABI.
3301 Note, the @code{ms_abi} attribute for Microsoft Windows 64-bit targets currently
3302 requires the @option{-maccumulate-outgoing-args} option.
3304 @item callee_pop_aggregate_return (@var{number})
3305 @cindex @code{callee_pop_aggregate_return} attribute
3307 On 32-bit i?86-*-* targets, you can use this attribute to control how
3308 aggregates are returned in memory.  If the caller is responsible for
3309 popping the hidden pointer together with the rest of the arguments, specify
3310 @var{number} equal to zero.  If callee is responsible for popping the
3311 hidden pointer, specify @var{number} equal to one.  
3313 The default i386 ABI assumes that the callee pops the
3314 stack for hidden pointer.  However, on 32-bit i386 Microsoft Windows targets,
3315 the compiler assumes that the
3316 caller pops the stack for hidden pointer.
3318 @item ms_hook_prologue
3319 @cindex @code{ms_hook_prologue} attribute
3321 On 32-bit i[34567]86-*-* targets and 64-bit x86_64-*-* targets, you can use
3322 this function attribute to make GCC generate the ``hot-patching'' function
3323 prologue used in Win32 API functions in Microsoft Windows XP Service Pack 2
3324 and newer.
3326 @item hotpatch [(@var{prologue-halfwords})]
3327 @cindex @code{hotpatch} attribute
3329 On S/390 System z targets, you can use this function attribute to
3330 make GCC generate a ``hot-patching'' function prologue.  The
3331 @code{hotpatch} has no effect on funtions that are explicitly
3332 inline.  If the @option{-mhotpatch} or @option{-mno-hotpatch}
3333 command-line option is used at the same time, the @code{hotpatch}
3334 attribute takes precedence.  If an argument is given, the maximum
3335 allowed value is 1000000.
3337 @item naked
3338 @cindex function without a prologue/epilogue code
3339 Use this attribute on the ARM, AVR, MCORE, MSP430, NDS32, RL78, RX and SPU
3340 ports to indicate that the specified function does not need prologue/epilogue
3341 sequences generated by the compiler.
3342 It is up to the programmer to provide these sequences. The
3343 only statements that can be safely included in naked functions are
3344 @code{asm} statements that do not have operands.  All other statements,
3345 including declarations of local variables, @code{if} statements, and so
3346 forth, should be avoided.  Naked functions should be used to implement the
3347 body of an assembly function, while allowing the compiler to construct
3348 the requisite function declaration for the assembler.
3350 @item near
3351 @cindex functions that do not handle memory bank switching on 68HC11/68HC12
3352 On 68HC11 and 68HC12 the @code{near} attribute causes the compiler to
3353 use the normal calling convention based on @code{jsr} and @code{rts}.
3354 This attribute can be used to cancel the effect of the @option{-mlong-calls}
3355 option.
3357 On MeP targets this attribute causes the compiler to assume the called
3358 function is close enough to use the normal calling convention,
3359 overriding the @option{-mtf} command-line option.
3361 @item nesting
3362 @cindex Allow nesting in an interrupt handler on the Blackfin processor.
3363 Use this attribute together with @code{interrupt_handler},
3364 @code{exception_handler} or @code{nmi_handler} to indicate that the function
3365 entry code should enable nested interrupts or exceptions.
3367 @item nmi_handler
3368 @cindex NMI handler functions on the Blackfin processor
3369 Use this attribute on the Blackfin to indicate that the specified function
3370 is an NMI handler.  The compiler generates function entry and
3371 exit sequences suitable for use in an NMI handler when this
3372 attribute is present.
3374 @item nocompression
3375 @cindex @code{nocompression} attribute
3376 On MIPS targets, you can use the @code{nocompression} function attribute
3377 to locally turn off MIPS16 and microMIPS code generation.  This attribute
3378 overrides the @option{-mips16} and @option{-mmicromips} options on the
3379 command line (@pxref{MIPS Options}).
3381 @item no_instrument_function
3382 @cindex @code{no_instrument_function} function attribute
3383 @opindex finstrument-functions
3384 If @option{-finstrument-functions} is given, profiling function calls are
3385 generated at entry and exit of most user-compiled functions.
3386 Functions with this attribute are not so instrumented.
3388 @item no_split_stack
3389 @cindex @code{no_split_stack} function attribute
3390 @opindex fsplit-stack
3391 If @option{-fsplit-stack} is given, functions have a small
3392 prologue which decides whether to split the stack.  Functions with the
3393 @code{no_split_stack} attribute do not have that prologue, and thus
3394 may run with only a small amount of stack space available.
3396 @item noinline
3397 @cindex @code{noinline} function attribute
3398 This function attribute prevents a function from being considered for
3399 inlining.
3400 @c Don't enumerate the optimizations by name here; we try to be
3401 @c future-compatible with this mechanism.
3402 If the function does not have side-effects, there are optimizations
3403 other than inlining that cause function calls to be optimized away,
3404 although the function call is live.  To keep such calls from being
3405 optimized away, put
3406 @smallexample
3407 asm ("");
3408 @end smallexample
3410 @noindent
3411 (@pxref{Extended Asm}) in the called function, to serve as a special
3412 side-effect.
3414 @item noclone
3415 @cindex @code{noclone} function attribute
3416 This function attribute prevents a function from being considered for
3417 cloning---a mechanism that produces specialized copies of functions
3418 and which is (currently) performed by interprocedural constant
3419 propagation.
3421 @item nonnull (@var{arg-index}, @dots{})
3422 @cindex @code{nonnull} function attribute
3423 The @code{nonnull} attribute specifies that some function parameters should
3424 be non-null pointers.  For instance, the declaration:
3426 @smallexample
3427 extern void *
3428 my_memcpy (void *dest, const void *src, size_t len)
3429         __attribute__((nonnull (1, 2)));
3430 @end smallexample
3432 @noindent
3433 causes the compiler to check that, in calls to @code{my_memcpy},
3434 arguments @var{dest} and @var{src} are non-null.  If the compiler
3435 determines that a null pointer is passed in an argument slot marked
3436 as non-null, and the @option{-Wnonnull} option is enabled, a warning
3437 is issued.  The compiler may also choose to make optimizations based
3438 on the knowledge that certain function arguments will never be null.
3440 If no argument index list is given to the @code{nonnull} attribute,
3441 all pointer arguments are marked as non-null.  To illustrate, the
3442 following declaration is equivalent to the previous example:
3444 @smallexample
3445 extern void *
3446 my_memcpy (void *dest, const void *src, size_t len)
3447         __attribute__((nonnull));
3448 @end smallexample
3450 @item returns_nonnull
3451 @cindex @code{returns_nonnull} function attribute
3452 The @code{returns_nonnull} attribute specifies that the function
3453 return value should be a non-null pointer.  For instance, the declaration:
3455 @smallexample
3456 extern void *
3457 mymalloc (size_t len) __attribute__((returns_nonnull));
3458 @end smallexample
3460 @noindent
3461 lets the compiler optimize callers based on the knowledge
3462 that the return value will never be null.
3464 @item noreturn
3465 @cindex @code{noreturn} function attribute
3466 A few standard library functions, such as @code{abort} and @code{exit},
3467 cannot return.  GCC knows this automatically.  Some programs define
3468 their own functions that never return.  You can declare them
3469 @code{noreturn} to tell the compiler this fact.  For example,
3471 @smallexample
3472 @group
3473 void fatal () __attribute__ ((noreturn));
3475 void
3476 fatal (/* @r{@dots{}} */)
3478   /* @r{@dots{}} */ /* @r{Print error message.} */ /* @r{@dots{}} */
3479   exit (1);
3481 @end group
3482 @end smallexample
3484 The @code{noreturn} keyword tells the compiler to assume that
3485 @code{fatal} cannot return.  It can then optimize without regard to what
3486 would happen if @code{fatal} ever did return.  This makes slightly
3487 better code.  More importantly, it helps avoid spurious warnings of
3488 uninitialized variables.
3490 The @code{noreturn} keyword does not affect the exceptional path when that
3491 applies: a @code{noreturn}-marked function may still return to the caller
3492 by throwing an exception or calling @code{longjmp}.
3494 Do not assume that registers saved by the calling function are
3495 restored before calling the @code{noreturn} function.
3497 It does not make sense for a @code{noreturn} function to have a return
3498 type other than @code{void}.
3500 The attribute @code{noreturn} is not implemented in GCC versions
3501 earlier than 2.5.  An alternative way to declare that a function does
3502 not return, which works in the current version and in some older
3503 versions, is as follows:
3505 @smallexample
3506 typedef void voidfn ();
3508 volatile voidfn fatal;
3509 @end smallexample
3511 @noindent
3512 This approach does not work in GNU C++.
3514 @item nothrow
3515 @cindex @code{nothrow} function attribute
3516 The @code{nothrow} attribute is used to inform the compiler that a
3517 function cannot throw an exception.  For example, most functions in
3518 the standard C library can be guaranteed not to throw an exception
3519 with the notable exceptions of @code{qsort} and @code{bsearch} that
3520 take function pointer arguments.  The @code{nothrow} attribute is not
3521 implemented in GCC versions earlier than 3.3.
3523 @item nosave_low_regs
3524 @cindex @code{nosave_low_regs} attribute
3525 Use this attribute on SH targets to indicate that an @code{interrupt_handler}
3526 function should not save and restore registers R0..R7.  This can be used on SH3*
3527 and SH4* targets that have a second R0..R7 register bank for non-reentrant
3528 interrupt handlers.
3530 @item noplt
3531 @cindex @code{noplt} function attribute
3532 The @code{noplt} attribute is the counterpart to option @option{-fno-plt} and
3533 does not use PLT for calls to functions marked with this attribute in position
3534 independent code. 
3536 @smallexample
3537 @group
3538 /* Externally defined function foo.  */
3539 int foo () __attribute__ ((noplt));
3542 main (/* @r{@dots{}} */)
3544   /* @r{@dots{}} */
3545   foo ();
3546   /* @r{@dots{}} */
3548 @end group
3549 @end smallexample
3551 The @code{noplt} attribute on function foo tells the compiler to assume that
3552 the function foo is externally defined and the call to foo must avoid the PLT
3553 in position independent code.
3555 Additionally, a few targets also convert calls to those functions that are
3556 marked to not use the PLT to use the GOT instead for non-position independent
3557 code.
3559 @item optimize
3560 @cindex @code{optimize} function attribute
3561 The @code{optimize} attribute is used to specify that a function is to
3562 be compiled with different optimization options than specified on the
3563 command line.  Arguments can either be numbers or strings.  Numbers
3564 are assumed to be an optimization level.  Strings that begin with
3565 @code{O} are assumed to be an optimization option, while other options
3566 are assumed to be used with a @code{-f} prefix.  You can also use the
3567 @samp{#pragma GCC optimize} pragma to set the optimization options
3568 that affect more than one function.
3569 @xref{Function Specific Option Pragmas}, for details about the
3570 @samp{#pragma GCC optimize} pragma.
3572 This can be used for instance to have frequently-executed functions
3573 compiled with more aggressive optimization options that produce faster
3574 and larger code, while other functions can be compiled with less
3575 aggressive options.
3577 @item OS_main/OS_task
3578 @cindex @code{OS_main} AVR function attribute
3579 @cindex @code{OS_task} AVR function attribute
3580 On AVR, functions with the @code{OS_main} or @code{OS_task} attribute
3581 do not save/restore any call-saved register in their prologue/epilogue.
3583 The @code{OS_main} attribute can be used when there @emph{is
3584 guarantee} that interrupts are disabled at the time when the function
3585 is entered.  This saves resources when the stack pointer has to be
3586 changed to set up a frame for local variables.
3588 The @code{OS_task} attribute can be used when there is @emph{no
3589 guarantee} that interrupts are disabled at that time when the function
3590 is entered like for, e@.g@. task functions in a multi-threading operating
3591 system. In that case, changing the stack pointer register is
3592 guarded by save/clear/restore of the global interrupt enable flag.
3594 The differences to the @code{naked} function attribute are:
3595 @itemize @bullet
3596 @item @code{naked} functions do not have a return instruction whereas 
3597 @code{OS_main} and @code{OS_task} functions have a @code{RET} or
3598 @code{RETI} return instruction.
3599 @item @code{naked} functions do not set up a frame for local variables
3600 or a frame pointer whereas @code{OS_main} and @code{OS_task} do this
3601 as needed.
3602 @end itemize
3604 @item pcs
3605 @cindex @code{pcs} function attribute
3607 The @code{pcs} attribute can be used to control the calling convention
3608 used for a function on ARM.  The attribute takes an argument that specifies
3609 the calling convention to use.
3611 When compiling using the AAPCS ABI (or a variant of it) then valid
3612 values for the argument are @code{"aapcs"} and @code{"aapcs-vfp"}.  In
3613 order to use a variant other than @code{"aapcs"} then the compiler must
3614 be permitted to use the appropriate co-processor registers (i.e., the
3615 VFP registers must be available in order to use @code{"aapcs-vfp"}).
3616 For example,
3618 @smallexample
3619 /* Argument passed in r0, and result returned in r0+r1.  */
3620 double f2d (float) __attribute__((pcs("aapcs")));
3621 @end smallexample
3623 Variadic functions always use the @code{"aapcs"} calling convention and
3624 the compiler rejects attempts to specify an alternative.
3626 @item pure
3627 @cindex @code{pure} function attribute
3628 Many functions have no effects except the return value and their
3629 return value depends only on the parameters and/or global variables.
3630 Such a function can be subject
3631 to common subexpression elimination and loop optimization just as an
3632 arithmetic operator would be.  These functions should be declared
3633 with the attribute @code{pure}.  For example,
3635 @smallexample
3636 int square (int) __attribute__ ((pure));
3637 @end smallexample
3639 @noindent
3640 says that the hypothetical function @code{square} is safe to call
3641 fewer times than the program says.
3643 Some of common examples of pure functions are @code{strlen} or @code{memcmp}.
3644 Interesting non-pure functions are functions with infinite loops or those
3645 depending on volatile memory or other system resource, that may change between
3646 two consecutive calls (such as @code{feof} in a multithreading environment).
3648 The attribute @code{pure} is not implemented in GCC versions earlier
3649 than 2.96.
3651 @item hot
3652 @cindex @code{hot} function attribute
3653 The @code{hot} attribute on a function is used to inform the compiler that
3654 the function is a hot spot of the compiled program.  The function is
3655 optimized more aggressively and on many target it is placed into special
3656 subsection of the text section so all hot functions appears close together
3657 improving locality.
3659 When profile feedback is available, via @option{-fprofile-use}, hot functions
3660 are automatically detected and this attribute is ignored.
3662 The @code{hot} attribute on functions is not implemented in GCC versions
3663 earlier than 4.3.
3665 @cindex @code{hot} label attribute
3666 The @code{hot} attribute on a label is used to inform the compiler that
3667 path following the label are more likely than paths that are not so
3668 annotated.  This attribute is used in cases where @code{__builtin_expect}
3669 cannot be used, for instance with computed goto or @code{asm goto}.
3671 The @code{hot} attribute on labels is not implemented in GCC versions
3672 earlier than 4.8.
3674 @item cold
3675 @cindex @code{cold} function attribute
3676 The @code{cold} attribute on functions is used to inform the compiler that
3677 the function is unlikely to be executed.  The function is optimized for
3678 size rather than speed and on many targets it is placed into special
3679 subsection of the text section so all cold functions appears close together
3680 improving code locality of non-cold parts of program.  The paths leading
3681 to call of cold functions within code are marked as unlikely by the branch
3682 prediction mechanism.  It is thus useful to mark functions used to handle
3683 unlikely conditions, such as @code{perror}, as cold to improve optimization
3684 of hot functions that do call marked functions in rare occasions.
3686 When profile feedback is available, via @option{-fprofile-use}, cold functions
3687 are automatically detected and this attribute is ignored.
3689 The @code{cold} attribute on functions is not implemented in GCC versions
3690 earlier than 4.3.
3692 @cindex @code{cold} label attribute
3693 The @code{cold} attribute on labels is used to inform the compiler that
3694 the path following the label is unlikely to be executed.  This attribute
3695 is used in cases where @code{__builtin_expect} cannot be used, for instance
3696 with computed goto or @code{asm goto}.
3698 The @code{cold} attribute on labels is not implemented in GCC versions
3699 earlier than 4.8.
3701 @item no_sanitize_address
3702 @itemx no_address_safety_analysis
3703 @cindex @code{no_sanitize_address} function attribute
3704 The @code{no_sanitize_address} attribute on functions is used
3705 to inform the compiler that it should not instrument memory accesses
3706 in the function when compiling with the @option{-fsanitize=address} option.
3707 The @code{no_address_safety_analysis} is a deprecated alias of the
3708 @code{no_sanitize_address} attribute, new code should use
3709 @code{no_sanitize_address}.
3711 @item no_sanitize_undefined
3712 @cindex @code{no_sanitize_undefined} function attribute
3713 The @code{no_sanitize_undefined} attribute on functions is used
3714 to inform the compiler that it should not check for undefined behavior
3715 in the function when compiling with the @option{-fsanitize=undefined} option.
3717 @item regparm (@var{number})
3718 @cindex @code{regparm} attribute
3719 @cindex functions that are passed arguments in registers on the 386
3720 On the Intel 386, the @code{regparm} attribute causes the compiler to
3721 pass arguments number one to @var{number} if they are of integral type
3722 in registers EAX, EDX, and ECX instead of on the stack.  Functions that
3723 take a variable number of arguments continue to be passed all of their
3724 arguments on the stack.
3726 Beware that on some ELF systems this attribute is unsuitable for
3727 global functions in shared libraries with lazy binding (which is the
3728 default).  Lazy binding sends the first call via resolving code in
3729 the loader, which might assume EAX, EDX and ECX can be clobbered, as
3730 per the standard calling conventions.  Solaris 8 is affected by this.
3731 Systems with the GNU C Library version 2.1 or higher
3732 and FreeBSD are believed to be
3733 safe since the loaders there save EAX, EDX and ECX.  (Lazy binding can be
3734 disabled with the linker or the loader if desired, to avoid the
3735 problem.)
3737 @item reset
3738 @cindex reset handler functions
3739 Use this attribute on the NDS32 target to indicate that the specified function
3740 is a reset handler.  The compiler will generate corresponding sections
3741 for use in a reset handler.  You can use the following attributes
3742 to provide extra exception handling:
3743 @table @code
3744 @item nmi
3745 @cindex @code{nmi} attribute
3746 Provide a user-defined function to handle NMI exception.
3747 @item warm
3748 @cindex @code{warm} attribute
3749 Provide a user-defined function to handle warm reset exception.
3750 @end table
3752 @item sseregparm
3753 @cindex @code{sseregparm} attribute
3754 On the Intel 386 with SSE support, the @code{sseregparm} attribute
3755 causes the compiler to pass up to 3 floating-point arguments in
3756 SSE registers instead of on the stack.  Functions that take a
3757 variable number of arguments continue to pass all of their
3758 floating-point arguments on the stack.
3760 @item force_align_arg_pointer
3761 @cindex @code{force_align_arg_pointer} attribute
3762 On the Intel x86, the @code{force_align_arg_pointer} attribute may be
3763 applied to individual function definitions, generating an alternate
3764 prologue and epilogue that realigns the run-time stack if necessary.
3765 This supports mixing legacy codes that run with a 4-byte aligned stack
3766 with modern codes that keep a 16-byte stack for SSE compatibility.
3768 @item renesas
3769 @cindex @code{renesas} attribute
3770 On SH targets this attribute specifies that the function or struct follows the
3771 Renesas ABI.
3773 @item resbank
3774 @cindex @code{resbank} attribute
3775 On the SH2A target, this attribute enables the high-speed register
3776 saving and restoration using a register bank for @code{interrupt_handler}
3777 routines.  Saving to the bank is performed automatically after the CPU
3778 accepts an interrupt that uses a register bank.
3780 The nineteen 32-bit registers comprising general register R0 to R14,
3781 control register GBR, and system registers MACH, MACL, and PR and the
3782 vector table address offset are saved into a register bank.  Register
3783 banks are stacked in first-in last-out (FILO) sequence.  Restoration
3784 from the bank is executed by issuing a RESBANK instruction.
3786 @item returns_twice
3787 @cindex @code{returns_twice} attribute
3788 The @code{returns_twice} attribute tells the compiler that a function may
3789 return more than one time.  The compiler ensures that all registers
3790 are dead before calling such a function and emits a warning about
3791 the variables that may be clobbered after the second return from the
3792 function.  Examples of such functions are @code{setjmp} and @code{vfork}.
3793 The @code{longjmp}-like counterpart of such function, if any, might need
3794 to be marked with the @code{noreturn} attribute.
3796 @item saveall
3797 @cindex save all registers on the Blackfin, H8/300, H8/300H, and H8S
3798 Use this attribute on the Blackfin, H8/300, H8/300H, and H8S to indicate that
3799 all registers except the stack pointer should be saved in the prologue
3800 regardless of whether they are used or not.
3802 @item save_volatiles
3803 @cindex save volatile registers on the MicroBlaze
3804 Use this attribute on the MicroBlaze to indicate that the function is
3805 an interrupt handler.  All volatile registers (in addition to non-volatile
3806 registers) are saved in the function prologue.  If the function is a leaf
3807 function, only volatiles used by the function are saved.  A normal function
3808 return is generated instead of a return from interrupt.
3810 @item section ("@var{section-name}")
3811 @cindex @code{section} function attribute
3812 Normally, the compiler places the code it generates in the @code{text} section.
3813 Sometimes, however, you need additional sections, or you need certain
3814 particular functions to appear in special sections.  The @code{section}
3815 attribute specifies that a function lives in a particular section.
3816 For example, the declaration:
3818 @smallexample
3819 extern void foobar (void) __attribute__ ((section ("bar")));
3820 @end smallexample
3822 @noindent
3823 puts the function @code{foobar} in the @code{bar} section.
3825 Some file formats do not support arbitrary sections so the @code{section}
3826 attribute is not available on all platforms.
3827 If you need to map the entire contents of a module to a particular
3828 section, consider using the facilities of the linker instead.
3830 @item sentinel
3831 @cindex @code{sentinel} function attribute
3832 This function attribute ensures that a parameter in a function call is
3833 an explicit @code{NULL}.  The attribute is only valid on variadic
3834 functions.  By default, the sentinel is located at position zero, the
3835 last parameter of the function call.  If an optional integer position
3836 argument P is supplied to the attribute, the sentinel must be located at
3837 position P counting backwards from the end of the argument list.
3839 @smallexample
3840 __attribute__ ((sentinel))
3841 is equivalent to
3842 __attribute__ ((sentinel(0)))
3843 @end smallexample
3845 The attribute is automatically set with a position of 0 for the built-in
3846 functions @code{execl} and @code{execlp}.  The built-in function
3847 @code{execle} has the attribute set with a position of 1.
3849 A valid @code{NULL} in this context is defined as zero with any pointer
3850 type.  If your system defines the @code{NULL} macro with an integer type
3851 then you need to add an explicit cast.  GCC replaces @code{stddef.h}
3852 with a copy that redefines NULL appropriately.
3854 The warnings for missing or incorrect sentinels are enabled with
3855 @option{-Wformat}.
3857 @item short_call
3858 See @code{long_call/short_call}.
3860 @item shortcall
3861 See @code{longcall/shortcall}.
3863 @item signal
3864 @cindex interrupt handler functions on the AVR processors
3865 Use this attribute on the AVR to indicate that the specified
3866 function is an interrupt handler.  The compiler generates function
3867 entry and exit sequences suitable for use in an interrupt handler when this
3868 attribute is present.
3870 See also the @code{interrupt} function attribute. 
3872 The AVR hardware globally disables interrupts when an interrupt is executed.
3873 Interrupt handler functions defined with the @code{signal} attribute
3874 do not re-enable interrupts.  It is save to enable interrupts in a
3875 @code{signal} handler.  This ``save'' only applies to the code
3876 generated by the compiler and not to the IRQ layout of the
3877 application which is responsibility of the application.
3879 If both @code{signal} and @code{interrupt} are specified for the same
3880 function, @code{signal} is silently ignored.
3882 @item sp_switch
3883 @cindex @code{sp_switch} attribute
3884 Use this attribute on the SH to indicate an @code{interrupt_handler}
3885 function should switch to an alternate stack.  It expects a string
3886 argument that names a global variable holding the address of the
3887 alternate stack.
3889 @smallexample
3890 void *alt_stack;
3891 void f () __attribute__ ((interrupt_handler,
3892                           sp_switch ("alt_stack")));
3893 @end smallexample
3895 @item stdcall
3896 @cindex functions that pop the argument stack on the 386
3897 On the Intel 386, the @code{stdcall} attribute causes the compiler to
3898 assume that the called function pops off the stack space used to
3899 pass arguments, unless it takes a variable number of arguments.
3901 @item syscall_linkage
3902 @cindex @code{syscall_linkage} attribute
3903 This attribute is used to modify the IA-64 calling convention by marking
3904 all input registers as live at all function exits.  This makes it possible
3905 to restart a system call after an interrupt without having to save/restore
3906 the input registers.  This also prevents kernel data from leaking into
3907 application code.
3909 @item target
3910 @cindex @code{target} function attribute
3911 The @code{target} attribute is used to specify that a function is to
3912 be compiled with different target options than specified on the
3913 command line.  This can be used for instance to have functions
3914 compiled with a different ISA (instruction set architecture) than the
3915 default.  You can also use the @samp{#pragma GCC target} pragma to set
3916 more than one function to be compiled with specific target options.
3917 @xref{Function Specific Option Pragmas}, for details about the
3918 @samp{#pragma GCC target} pragma.
3920 For instance on a 386, you could compile one function with
3921 @code{target("sse4.1,arch=core2")} and another with
3922 @code{target("sse4a,arch=amdfam10")}.  This is equivalent to
3923 compiling the first function with @option{-msse4.1} and
3924 @option{-march=core2} options, and the second function with
3925 @option{-msse4a} and @option{-march=amdfam10} options.  It is up to the
3926 user to make sure that a function is only invoked on a machine that
3927 supports the particular ISA it is compiled for (for example by using
3928 @code{cpuid} on 386 to determine what feature bits and architecture
3929 family are used).
3931 @smallexample
3932 int core2_func (void) __attribute__ ((__target__ ("arch=core2")));
3933 int sse3_func (void) __attribute__ ((__target__ ("sse3")));
3934 @end smallexample
3936 You can either use multiple
3937 strings to specify multiple options, or separate the options
3938 with a comma (@samp{,}).
3940 The @code{target} attribute is presently implemented for
3941 i386/x86_64, PowerPC, and Nios II targets only.
3942 The options supported are specific to each target.
3944 On the 386, the following options are allowed:
3946 @table @samp
3947 @item abm
3948 @itemx no-abm
3949 @cindex @code{target("abm")} attribute
3950 Enable/disable the generation of the advanced bit instructions.
3952 @item aes
3953 @itemx no-aes
3954 @cindex @code{target("aes")} attribute
3955 Enable/disable the generation of the AES instructions.
3957 @item default
3958 @cindex @code{target("default")} attribute
3959 @xref{Function Multiversioning}, where it is used to specify the
3960 default function version.
3962 @item mmx
3963 @itemx no-mmx
3964 @cindex @code{target("mmx")} attribute
3965 Enable/disable the generation of the MMX instructions.
3967 @item pclmul
3968 @itemx no-pclmul
3969 @cindex @code{target("pclmul")} attribute
3970 Enable/disable the generation of the PCLMUL instructions.
3972 @item popcnt
3973 @itemx no-popcnt
3974 @cindex @code{target("popcnt")} attribute
3975 Enable/disable the generation of the POPCNT instruction.
3977 @item sse
3978 @itemx no-sse
3979 @cindex @code{target("sse")} attribute
3980 Enable/disable the generation of the SSE instructions.
3982 @item sse2
3983 @itemx no-sse2
3984 @cindex @code{target("sse2")} attribute
3985 Enable/disable the generation of the SSE2 instructions.
3987 @item sse3
3988 @itemx no-sse3
3989 @cindex @code{target("sse3")} attribute
3990 Enable/disable the generation of the SSE3 instructions.
3992 @item sse4
3993 @itemx no-sse4
3994 @cindex @code{target("sse4")} attribute
3995 Enable/disable the generation of the SSE4 instructions (both SSE4.1
3996 and SSE4.2).
3998 @item sse4.1
3999 @itemx no-sse4.1
4000 @cindex @code{target("sse4.1")} attribute
4001 Enable/disable the generation of the sse4.1 instructions.
4003 @item sse4.2
4004 @itemx no-sse4.2
4005 @cindex @code{target("sse4.2")} attribute
4006 Enable/disable the generation of the sse4.2 instructions.
4008 @item sse4a
4009 @itemx no-sse4a
4010 @cindex @code{target("sse4a")} attribute
4011 Enable/disable the generation of the SSE4A instructions.
4013 @item fma4
4014 @itemx no-fma4
4015 @cindex @code{target("fma4")} attribute
4016 Enable/disable the generation of the FMA4 instructions.
4018 @item xop
4019 @itemx no-xop
4020 @cindex @code{target("xop")} attribute
4021 Enable/disable the generation of the XOP instructions.
4023 @item lwp
4024 @itemx no-lwp
4025 @cindex @code{target("lwp")} attribute
4026 Enable/disable the generation of the LWP instructions.
4028 @item ssse3
4029 @itemx no-ssse3
4030 @cindex @code{target("ssse3")} attribute
4031 Enable/disable the generation of the SSSE3 instructions.
4033 @item cld
4034 @itemx no-cld
4035 @cindex @code{target("cld")} attribute
4036 Enable/disable the generation of the CLD before string moves.
4038 @item fancy-math-387
4039 @itemx no-fancy-math-387
4040 @cindex @code{target("fancy-math-387")} attribute
4041 Enable/disable the generation of the @code{sin}, @code{cos}, and
4042 @code{sqrt} instructions on the 387 floating-point unit.
4044 @item fused-madd
4045 @itemx no-fused-madd
4046 @cindex @code{target("fused-madd")} attribute
4047 Enable/disable the generation of the fused multiply/add instructions.
4049 @item ieee-fp
4050 @itemx no-ieee-fp
4051 @cindex @code{target("ieee-fp")} attribute
4052 Enable/disable the generation of floating point that depends on IEEE arithmetic.
4054 @item inline-all-stringops
4055 @itemx no-inline-all-stringops
4056 @cindex @code{target("inline-all-stringops")} attribute
4057 Enable/disable inlining of string operations.
4059 @item inline-stringops-dynamically
4060 @itemx no-inline-stringops-dynamically
4061 @cindex @code{target("inline-stringops-dynamically")} attribute
4062 Enable/disable the generation of the inline code to do small string
4063 operations and calling the library routines for large operations.
4065 @item align-stringops
4066 @itemx no-align-stringops
4067 @cindex @code{target("align-stringops")} attribute
4068 Do/do not align destination of inlined string operations.
4070 @item recip
4071 @itemx no-recip
4072 @cindex @code{target("recip")} attribute
4073 Enable/disable the generation of RCPSS, RCPPS, RSQRTSS and RSQRTPS
4074 instructions followed an additional Newton-Raphson step instead of
4075 doing a floating-point division.
4077 @item arch=@var{ARCH}
4078 @cindex @code{target("arch=@var{ARCH}")} attribute
4079 Specify the architecture to generate code for in compiling the function.
4081 @item tune=@var{TUNE}
4082 @cindex @code{target("tune=@var{TUNE}")} attribute
4083 Specify the architecture to tune for in compiling the function.
4085 @item fpmath=@var{FPMATH}
4086 @cindex @code{target("fpmath=@var{FPMATH}")} attribute
4087 Specify which floating-point unit to use.  The
4088 @code{target("fpmath=sse,387")} option must be specified as
4089 @code{target("fpmath=sse+387")} because the comma would separate
4090 different options.
4091 @end table
4093 On the PowerPC, the following options are allowed:
4095 @table @samp
4096 @item altivec
4097 @itemx no-altivec
4098 @cindex @code{target("altivec")} attribute
4099 Generate code that uses (does not use) AltiVec instructions.  In
4100 32-bit code, you cannot enable AltiVec instructions unless
4101 @option{-mabi=altivec} is used on the command line.
4103 @item cmpb
4104 @itemx no-cmpb
4105 @cindex @code{target("cmpb")} attribute
4106 Generate code that uses (does not use) the compare bytes instruction
4107 implemented on the POWER6 processor and other processors that support
4108 the PowerPC V2.05 architecture.
4110 @item dlmzb
4111 @itemx no-dlmzb
4112 @cindex @code{target("dlmzb")} attribute
4113 Generate code that uses (does not use) the string-search @samp{dlmzb}
4114 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
4115 generated by default when targeting those processors.
4117 @item fprnd
4118 @itemx no-fprnd
4119 @cindex @code{target("fprnd")} attribute
4120 Generate code that uses (does not use) the FP round to integer
4121 instructions implemented on the POWER5+ processor and other processors
4122 that support the PowerPC V2.03 architecture.
4124 @item hard-dfp
4125 @itemx no-hard-dfp
4126 @cindex @code{target("hard-dfp")} attribute
4127 Generate code that uses (does not use) the decimal floating-point
4128 instructions implemented on some POWER processors.
4130 @item isel
4131 @itemx no-isel
4132 @cindex @code{target("isel")} attribute
4133 Generate code that uses (does not use) ISEL instruction.
4135 @item mfcrf
4136 @itemx no-mfcrf
4137 @cindex @code{target("mfcrf")} attribute
4138 Generate code that uses (does not use) the move from condition
4139 register field instruction implemented on the POWER4 processor and
4140 other processors that support the PowerPC V2.01 architecture.
4142 @item mfpgpr
4143 @itemx no-mfpgpr
4144 @cindex @code{target("mfpgpr")} attribute
4145 Generate code that uses (does not use) the FP move to/from general
4146 purpose register instructions implemented on the POWER6X processor and
4147 other processors that support the extended PowerPC V2.05 architecture.
4149 @item mulhw
4150 @itemx no-mulhw
4151 @cindex @code{target("mulhw")} attribute
4152 Generate code that uses (does not use) the half-word multiply and
4153 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
4154 These instructions are generated by default when targeting those
4155 processors.
4157 @item multiple
4158 @itemx no-multiple
4159 @cindex @code{target("multiple")} attribute
4160 Generate code that uses (does not use) the load multiple word
4161 instructions and the store multiple word instructions.
4163 @item update
4164 @itemx no-update
4165 @cindex @code{target("update")} attribute
4166 Generate code that uses (does not use) the load or store instructions
4167 that update the base register to the address of the calculated memory
4168 location.
4170 @item popcntb
4171 @itemx no-popcntb
4172 @cindex @code{target("popcntb")} attribute
4173 Generate code that uses (does not use) the popcount and double-precision
4174 FP reciprocal estimate instruction implemented on the POWER5
4175 processor and other processors that support the PowerPC V2.02
4176 architecture.
4178 @item popcntd
4179 @itemx no-popcntd
4180 @cindex @code{target("popcntd")} attribute
4181 Generate code that uses (does not use) the popcount instruction
4182 implemented on the POWER7 processor and other processors that support
4183 the PowerPC V2.06 architecture.
4185 @item powerpc-gfxopt
4186 @itemx no-powerpc-gfxopt
4187 @cindex @code{target("powerpc-gfxopt")} attribute
4188 Generate code that uses (does not use) the optional PowerPC
4189 architecture instructions in the Graphics group, including
4190 floating-point select.
4192 @item powerpc-gpopt
4193 @itemx no-powerpc-gpopt
4194 @cindex @code{target("powerpc-gpopt")} attribute
4195 Generate code that uses (does not use) the optional PowerPC
4196 architecture instructions in the General Purpose group, including
4197 floating-point square root.
4199 @item recip-precision
4200 @itemx no-recip-precision
4201 @cindex @code{target("recip-precision")} attribute
4202 Assume (do not assume) that the reciprocal estimate instructions
4203 provide higher-precision estimates than is mandated by the powerpc
4204 ABI.
4206 @item string
4207 @itemx no-string
4208 @cindex @code{target("string")} attribute
4209 Generate code that uses (does not use) the load string instructions
4210 and the store string word instructions to save multiple registers and
4211 do small block moves.
4213 @item vsx
4214 @itemx no-vsx
4215 @cindex @code{target("vsx")} attribute
4216 Generate code that uses (does not use) vector/scalar (VSX)
4217 instructions, and also enable the use of built-in functions that allow
4218 more direct access to the VSX instruction set.  In 32-bit code, you
4219 cannot enable VSX or AltiVec instructions unless
4220 @option{-mabi=altivec} is used on the command line.
4222 @item friz
4223 @itemx no-friz
4224 @cindex @code{target("friz")} attribute
4225 Generate (do not generate) the @code{friz} instruction when the
4226 @option{-funsafe-math-optimizations} option is used to optimize
4227 rounding a floating-point value to 64-bit integer and back to floating
4228 point.  The @code{friz} instruction does not return the same value if
4229 the floating-point number is too large to fit in an integer.
4231 @item avoid-indexed-addresses
4232 @itemx no-avoid-indexed-addresses
4233 @cindex @code{target("avoid-indexed-addresses")} attribute
4234 Generate code that tries to avoid (not avoid) the use of indexed load
4235 or store instructions.
4237 @item paired
4238 @itemx no-paired
4239 @cindex @code{target("paired")} attribute
4240 Generate code that uses (does not use) the generation of PAIRED simd
4241 instructions.
4243 @item longcall
4244 @itemx no-longcall
4245 @cindex @code{target("longcall")} attribute
4246 Generate code that assumes (does not assume) that all calls are far
4247 away so that a longer more expensive calling sequence is required.
4249 @item cpu=@var{CPU}
4250 @cindex @code{target("cpu=@var{CPU}")} attribute
4251 Specify the architecture to generate code for when compiling the
4252 function.  If you select the @code{target("cpu=power7")} attribute when
4253 generating 32-bit code, VSX and AltiVec instructions are not generated
4254 unless you use the @option{-mabi=altivec} option on the command line.
4256 @item tune=@var{TUNE}
4257 @cindex @code{target("tune=@var{TUNE}")} attribute
4258 Specify the architecture to tune for when compiling the function.  If
4259 you do not specify the @code{target("tune=@var{TUNE}")} attribute and
4260 you do specify the @code{target("cpu=@var{CPU}")} attribute,
4261 compilation tunes for the @var{CPU} architecture, and not the
4262 default tuning specified on the command line.
4263 @end table
4265 When compiling for Nios II, the following options are allowed:
4267 @table @samp
4268 @item custom-@var{insn}=@var{N}
4269 @itemx no-custom-@var{insn}
4270 @cindex @code{target("custom-@var{insn}=@var{N}")} attribute
4271 @cindex @code{target("no-custom-@var{insn}")} attribute
4272 Each @samp{custom-@var{insn}=@var{N}} attribute locally enables use of a
4273 custom instruction with encoding @var{N} when generating code that uses 
4274 @var{insn}.  Similarly, @samp{no-custom-@var{insn}} locally inhibits use of
4275 the custom instruction @var{insn}.
4276 These target attributes correspond to the
4277 @option{-mcustom-@var{insn}=@var{N}} and @option{-mno-custom-@var{insn}}
4278 command-line options, and support the same set of @var{insn} keywords.
4279 @xref{Nios II Options}, for more information.
4281 @item custom-fpu-cfg=@var{name}
4282 @cindex @code{target("custom-fpu-cfg=@var{name}")} attribute
4283 This attribute corresponds to the @option{-mcustom-fpu-cfg=@var{name}}
4284 command-line option, to select a predefined set of custom instructions
4285 named @var{name}.
4286 @xref{Nios II Options}, for more information.
4287 @end table
4289 On the 386/x86_64 and PowerPC back ends, the inliner does not inline a
4290 function that has different target options than the caller, unless the
4291 callee has a subset of the target options of the caller.  For example
4292 a function declared with @code{target("sse3")} can inline a function
4293 with @code{target("sse2")}, since @code{-msse3} implies @code{-msse2}.
4295 @item tiny_data
4296 @cindex tiny data section on the H8/300H and H8S
4297 Use this attribute on the H8/300H and H8S to indicate that the specified
4298 variable should be placed into the tiny data section.
4299 The compiler generates more efficient code for loads and stores
4300 on data in the tiny data section.  Note the tiny data area is limited to
4301 slightly under 32KB of data.
4303 @item trap_exit
4304 @cindex @code{trap_exit} attribute
4305 Use this attribute on the SH for an @code{interrupt_handler} to return using
4306 @code{trapa} instead of @code{rte}.  This attribute expects an integer
4307 argument specifying the trap number to be used.
4309 @item trapa_handler
4310 @cindex @code{trapa_handler} attribute
4311 On SH targets this function attribute is similar to @code{interrupt_handler}
4312 but it does not save and restore all registers.
4314 @item unused
4315 @cindex @code{unused} attribute.
4316 This attribute, attached to a function, means that the function is meant
4317 to be possibly unused.  GCC does not produce a warning for this
4318 function.
4320 @item used
4321 @cindex @code{used} attribute.
4322 This attribute, attached to a function, means that code must be emitted
4323 for the function even if it appears that the function is not referenced.
4324 This is useful, for example, when the function is referenced only in
4325 inline assembly.
4327 When applied to a member function of a C++ class template, the
4328 attribute also means that the function is instantiated if the
4329 class itself is instantiated.
4331 @item version_id
4332 @cindex @code{version_id} attribute
4333 This IA-64 HP-UX attribute, attached to a global variable or function, renames a
4334 symbol to contain a version string, thus allowing for function level
4335 versioning.  HP-UX system header files may use function level versioning
4336 for some system calls.
4338 @smallexample
4339 extern int foo () __attribute__((version_id ("20040821")));
4340 @end smallexample
4342 @noindent
4343 Calls to @var{foo} are mapped to calls to @var{foo@{20040821@}}.
4345 @item visibility ("@var{visibility_type}")
4346 @cindex @code{visibility} attribute
4347 This attribute affects the linkage of the declaration to which it is attached.
4348 There are four supported @var{visibility_type} values: default,
4349 hidden, protected or internal visibility.
4351 @smallexample
4352 void __attribute__ ((visibility ("protected")))
4353 f () @{ /* @r{Do something.} */; @}
4354 int i __attribute__ ((visibility ("hidden")));
4355 @end smallexample
4357 The possible values of @var{visibility_type} correspond to the
4358 visibility settings in the ELF gABI.
4360 @table @dfn
4361 @c keep this list of visibilities in alphabetical order.
4363 @item default
4364 Default visibility is the normal case for the object file format.
4365 This value is available for the visibility attribute to override other
4366 options that may change the assumed visibility of entities.
4368 On ELF, default visibility means that the declaration is visible to other
4369 modules and, in shared libraries, means that the declared entity may be
4370 overridden.
4372 On Darwin, default visibility means that the declaration is visible to
4373 other modules.
4375 Default visibility corresponds to ``external linkage'' in the language.
4377 @item hidden
4378 Hidden visibility indicates that the entity declared has a new
4379 form of linkage, which we call ``hidden linkage''.  Two
4380 declarations of an object with hidden linkage refer to the same object
4381 if they are in the same shared object.
4383 @item internal
4384 Internal visibility is like hidden visibility, but with additional
4385 processor specific semantics.  Unless otherwise specified by the
4386 psABI, GCC defines internal visibility to mean that a function is
4387 @emph{never} called from another module.  Compare this with hidden
4388 functions which, while they cannot be referenced directly by other
4389 modules, can be referenced indirectly via function pointers.  By
4390 indicating that a function cannot be called from outside the module,
4391 GCC may for instance omit the load of a PIC register since it is known
4392 that the calling function loaded the correct value.
4394 @item protected
4395 Protected visibility is like default visibility except that it
4396 indicates that references within the defining module bind to the
4397 definition in that module.  That is, the declared entity cannot be
4398 overridden by another module.
4400 @end table
4402 All visibilities are supported on many, but not all, ELF targets
4403 (supported when the assembler supports the @samp{.visibility}
4404 pseudo-op).  Default visibility is supported everywhere.  Hidden
4405 visibility is supported on Darwin targets.
4407 The visibility attribute should be applied only to declarations that
4408 would otherwise have external linkage.  The attribute should be applied
4409 consistently, so that the same entity should not be declared with
4410 different settings of the attribute.
4412 In C++, the visibility attribute applies to types as well as functions
4413 and objects, because in C++ types have linkage.  A class must not have
4414 greater visibility than its non-static data member types and bases,
4415 and class members default to the visibility of their class.  Also, a
4416 declaration without explicit visibility is limited to the visibility
4417 of its type.
4419 In C++, you can mark member functions and static member variables of a
4420 class with the visibility attribute.  This is useful if you know a
4421 particular method or static member variable should only be used from
4422 one shared object; then you can mark it hidden while the rest of the
4423 class has default visibility.  Care must be taken to avoid breaking
4424 the One Definition Rule; for example, it is usually not useful to mark
4425 an inline method as hidden without marking the whole class as hidden.
4427 A C++ namespace declaration can also have the visibility attribute.
4429 @smallexample
4430 namespace nspace1 __attribute__ ((visibility ("protected")))
4431 @{ /* @r{Do something.} */; @}
4432 @end smallexample
4434 This attribute applies only to the particular namespace body, not to
4435 other definitions of the same namespace; it is equivalent to using
4436 @samp{#pragma GCC visibility} before and after the namespace
4437 definition (@pxref{Visibility Pragmas}).
4439 In C++, if a template argument has limited visibility, this
4440 restriction is implicitly propagated to the template instantiation.
4441 Otherwise, template instantiations and specializations default to the
4442 visibility of their template.
4444 If both the template and enclosing class have explicit visibility, the
4445 visibility from the template is used.
4447 @item vliw
4448 @cindex @code{vliw} attribute
4449 On MeP, the @code{vliw} attribute tells the compiler to emit
4450 instructions in VLIW mode instead of core mode.  Note that this
4451 attribute is not allowed unless a VLIW coprocessor has been configured
4452 and enabled through command-line options.
4454 @item warn_unused_result
4455 @cindex @code{warn_unused_result} attribute
4456 The @code{warn_unused_result} attribute causes a warning to be emitted
4457 if a caller of the function with this attribute does not use its
4458 return value.  This is useful for functions where not checking
4459 the result is either a security problem or always a bug, such as
4460 @code{realloc}.
4462 @smallexample
4463 int fn () __attribute__ ((warn_unused_result));
4464 int foo ()
4466   if (fn () < 0) return -1;
4467   fn ();
4468   return 0;
4470 @end smallexample
4472 @noindent
4473 results in warning on line 5.
4475 @item weak
4476 @cindex @code{weak} attribute
4477 The @code{weak} attribute causes the declaration to be emitted as a weak
4478 symbol rather than a global.  This is primarily useful in defining
4479 library functions that can be overridden in user code, though it can
4480 also be used with non-function declarations.  Weak symbols are supported
4481 for ELF targets, and also for a.out targets when using the GNU assembler
4482 and linker.
4484 @item weakref
4485 @itemx weakref ("@var{target}")
4486 @cindex @code{weakref} attribute
4487 The @code{weakref} attribute marks a declaration as a weak reference.
4488 Without arguments, it should be accompanied by an @code{alias} attribute
4489 naming the target symbol.  Optionally, the @var{target} may be given as
4490 an argument to @code{weakref} itself.  In either case, @code{weakref}
4491 implicitly marks the declaration as @code{weak}.  Without a
4492 @var{target}, given as an argument to @code{weakref} or to @code{alias},
4493 @code{weakref} is equivalent to @code{weak}.
4495 @smallexample
4496 static int x() __attribute__ ((weakref ("y")));
4497 /* is equivalent to... */
4498 static int x() __attribute__ ((weak, weakref, alias ("y")));
4499 /* and to... */
4500 static int x() __attribute__ ((weakref));
4501 static int x() __attribute__ ((alias ("y")));
4502 @end smallexample
4504 A weak reference is an alias that does not by itself require a
4505 definition to be given for the target symbol.  If the target symbol is
4506 only referenced through weak references, then it becomes a @code{weak}
4507 undefined symbol.  If it is directly referenced, however, then such
4508 strong references prevail, and a definition is required for the
4509 symbol, not necessarily in the same translation unit.
4511 The effect is equivalent to moving all references to the alias to a
4512 separate translation unit, renaming the alias to the aliased symbol,
4513 declaring it as weak, compiling the two separate translation units and
4514 performing a reloadable link on them.
4516 At present, a declaration to which @code{weakref} is attached can
4517 only be @code{static}.
4519 @end table
4521 You can specify multiple attributes in a declaration by separating them
4522 by commas within the double parentheses or by immediately following an
4523 attribute declaration with another attribute declaration.
4525 @cindex @code{#pragma}, reason for not using
4526 @cindex pragma, reason for not using
4527 Some people object to the @code{__attribute__} feature, suggesting that
4528 ISO C's @code{#pragma} should be used instead.  At the time
4529 @code{__attribute__} was designed, there were two reasons for not doing
4530 this.
4532 @enumerate
4533 @item
4534 It is impossible to generate @code{#pragma} commands from a macro.
4536 @item
4537 There is no telling what the same @code{#pragma} might mean in another
4538 compiler.
4539 @end enumerate
4541 These two reasons applied to almost any application that might have been
4542 proposed for @code{#pragma}.  It was basically a mistake to use
4543 @code{#pragma} for @emph{anything}.
4545 The ISO C99 standard includes @code{_Pragma}, which now allows pragmas
4546 to be generated from macros.  In addition, a @code{#pragma GCC}
4547 namespace is now in use for GCC-specific pragmas.  However, it has been
4548 found convenient to use @code{__attribute__} to achieve a natural
4549 attachment of attributes to their corresponding declarations, whereas
4550 @code{#pragma GCC} is of use for constructs that do not naturally form
4551 part of the grammar.  @xref{Pragmas,,Pragmas Accepted by GCC}.
4553 @node Attribute Syntax
4554 @section Attribute Syntax
4555 @cindex attribute syntax
4557 This section describes the syntax with which @code{__attribute__} may be
4558 used, and the constructs to which attribute specifiers bind, for the C
4559 language.  Some details may vary for C++ and Objective-C@.  Because of
4560 infelicities in the grammar for attributes, some forms described here
4561 may not be successfully parsed in all cases.
4563 There are some problems with the semantics of attributes in C++.  For
4564 example, there are no manglings for attributes, although they may affect
4565 code generation, so problems may arise when attributed types are used in
4566 conjunction with templates or overloading.  Similarly, @code{typeid}
4567 does not distinguish between types with different attributes.  Support
4568 for attributes in C++ may be restricted in future to attributes on
4569 declarations only, but not on nested declarators.
4571 @xref{Function Attributes}, for details of the semantics of attributes
4572 applying to functions.  @xref{Variable Attributes}, for details of the
4573 semantics of attributes applying to variables.  @xref{Type Attributes},
4574 for details of the semantics of attributes applying to structure, union
4575 and enumerated types.
4577 An @dfn{attribute specifier} is of the form
4578 @code{__attribute__ ((@var{attribute-list}))}.  An @dfn{attribute list}
4579 is a possibly empty comma-separated sequence of @dfn{attributes}, where
4580 each attribute is one of the following:
4582 @itemize @bullet
4583 @item
4584 Empty.  Empty attributes are ignored.
4586 @item
4587 A word (which may be an identifier such as @code{unused}, or a reserved
4588 word such as @code{const}).
4590 @item
4591 A word, followed by, in parentheses, parameters for the attribute.
4592 These parameters take one of the following forms:
4594 @itemize @bullet
4595 @item
4596 An identifier.  For example, @code{mode} attributes use this form.
4598 @item
4599 An identifier followed by a comma and a non-empty comma-separated list
4600 of expressions.  For example, @code{format} attributes use this form.
4602 @item
4603 A possibly empty comma-separated list of expressions.  For example,
4604 @code{format_arg} attributes use this form with the list being a single
4605 integer constant expression, and @code{alias} attributes use this form
4606 with the list being a single string constant.
4607 @end itemize
4608 @end itemize
4610 An @dfn{attribute specifier list} is a sequence of one or more attribute
4611 specifiers, not separated by any other tokens.
4613 In GNU C, an attribute specifier list may appear after the colon following a
4614 label, other than a @code{case} or @code{default} label.  The only
4615 attribute it makes sense to use after a label is @code{unused}.  This
4616 feature is intended for program-generated code that may contain unused labels,
4617 but which is compiled with @option{-Wall}.  It is
4618 not normally appropriate to use in it human-written code, though it
4619 could be useful in cases where the code that jumps to the label is
4620 contained within an @code{#ifdef} conditional.  GNU C++ only permits
4621 attributes on labels if the attribute specifier is immediately
4622 followed by a semicolon (i.e., the label applies to an empty
4623 statement).  If the semicolon is missing, C++ label attributes are
4624 ambiguous, as it is permissible for a declaration, which could begin
4625 with an attribute list, to be labelled in C++.  Declarations cannot be
4626 labelled in C90 or C99, so the ambiguity does not arise there.
4628 An attribute specifier list may appear as part of a @code{struct},
4629 @code{union} or @code{enum} specifier.  It may go either immediately
4630 after the @code{struct}, @code{union} or @code{enum} keyword, or after
4631 the closing brace.  The former syntax is preferred.
4632 Where attribute specifiers follow the closing brace, they are considered
4633 to relate to the structure, union or enumerated type defined, not to any
4634 enclosing declaration the type specifier appears in, and the type
4635 defined is not complete until after the attribute specifiers.
4636 @c Otherwise, there would be the following problems: a shift/reduce
4637 @c conflict between attributes binding the struct/union/enum and
4638 @c binding to the list of specifiers/qualifiers; and "aligned"
4639 @c attributes could use sizeof for the structure, but the size could be
4640 @c changed later by "packed" attributes.
4642 Otherwise, an attribute specifier appears as part of a declaration,
4643 counting declarations of unnamed parameters and type names, and relates
4644 to that declaration (which may be nested in another declaration, for
4645 example in the case of a parameter declaration), or to a particular declarator
4646 within a declaration.  Where an
4647 attribute specifier is applied to a parameter declared as a function or
4648 an array, it should apply to the function or array rather than the
4649 pointer to which the parameter is implicitly converted, but this is not
4650 yet correctly implemented.
4652 Any list of specifiers and qualifiers at the start of a declaration may
4653 contain attribute specifiers, whether or not such a list may in that
4654 context contain storage class specifiers.  (Some attributes, however,
4655 are essentially in the nature of storage class specifiers, and only make
4656 sense where storage class specifiers may be used; for example,
4657 @code{section}.)  There is one necessary limitation to this syntax: the
4658 first old-style parameter declaration in a function definition cannot
4659 begin with an attribute specifier, because such an attribute applies to
4660 the function instead by syntax described below (which, however, is not
4661 yet implemented in this case).  In some other cases, attribute
4662 specifiers are permitted by this grammar but not yet supported by the
4663 compiler.  All attribute specifiers in this place relate to the
4664 declaration as a whole.  In the obsolescent usage where a type of
4665 @code{int} is implied by the absence of type specifiers, such a list of
4666 specifiers and qualifiers may be an attribute specifier list with no
4667 other specifiers or qualifiers.
4669 At present, the first parameter in a function prototype must have some
4670 type specifier that is not an attribute specifier; this resolves an
4671 ambiguity in the interpretation of @code{void f(int
4672 (__attribute__((foo)) x))}, but is subject to change.  At present, if
4673 the parentheses of a function declarator contain only attributes then
4674 those attributes are ignored, rather than yielding an error or warning
4675 or implying a single parameter of type int, but this is subject to
4676 change.
4678 An attribute specifier list may appear immediately before a declarator
4679 (other than the first) in a comma-separated list of declarators in a
4680 declaration of more than one identifier using a single list of
4681 specifiers and qualifiers.  Such attribute specifiers apply
4682 only to the identifier before whose declarator they appear.  For
4683 example, in
4685 @smallexample
4686 __attribute__((noreturn)) void d0 (void),
4687     __attribute__((format(printf, 1, 2))) d1 (const char *, ...),
4688      d2 (void)
4689 @end smallexample
4691 @noindent
4692 the @code{noreturn} attribute applies to all the functions
4693 declared; the @code{format} attribute only applies to @code{d1}.
4695 An attribute specifier list may appear immediately before the comma,
4696 @code{=} or semicolon terminating the declaration of an identifier other
4697 than a function definition.  Such attribute specifiers apply
4698 to the declared object or function.  Where an
4699 assembler name for an object or function is specified (@pxref{Asm
4700 Labels}), the attribute must follow the @code{asm}
4701 specification.
4703 An attribute specifier list may, in future, be permitted to appear after
4704 the declarator in a function definition (before any old-style parameter
4705 declarations or the function body).
4707 Attribute specifiers may be mixed with type qualifiers appearing inside
4708 the @code{[]} of a parameter array declarator, in the C99 construct by
4709 which such qualifiers are applied to the pointer to which the array is
4710 implicitly converted.  Such attribute specifiers apply to the pointer,
4711 not to the array, but at present this is not implemented and they are
4712 ignored.
4714 An attribute specifier list may appear at the start of a nested
4715 declarator.  At present, there are some limitations in this usage: the
4716 attributes correctly apply to the declarator, but for most individual
4717 attributes the semantics this implies are not implemented.
4718 When attribute specifiers follow the @code{*} of a pointer
4719 declarator, they may be mixed with any type qualifiers present.
4720 The following describes the formal semantics of this syntax.  It makes the
4721 most sense if you are familiar with the formal specification of
4722 declarators in the ISO C standard.
4724 Consider (as in C99 subclause 6.7.5 paragraph 4) a declaration @code{T
4725 D1}, where @code{T} contains declaration specifiers that specify a type
4726 @var{Type} (such as @code{int}) and @code{D1} is a declarator that
4727 contains an identifier @var{ident}.  The type specified for @var{ident}
4728 for derived declarators whose type does not include an attribute
4729 specifier is as in the ISO C standard.
4731 If @code{D1} has the form @code{( @var{attribute-specifier-list} D )},
4732 and the declaration @code{T D} specifies the type
4733 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
4734 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
4735 @var{attribute-specifier-list} @var{Type}'' for @var{ident}.
4737 If @code{D1} has the form @code{*
4738 @var{type-qualifier-and-attribute-specifier-list} D}, and the
4739 declaration @code{T D} specifies the type
4740 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
4741 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
4742 @var{type-qualifier-and-attribute-specifier-list} pointer to @var{Type}'' for
4743 @var{ident}.
4745 For example,
4747 @smallexample
4748 void (__attribute__((noreturn)) ****f) (void);
4749 @end smallexample
4751 @noindent
4752 specifies the type ``pointer to pointer to pointer to pointer to
4753 non-returning function returning @code{void}''.  As another example,
4755 @smallexample
4756 char *__attribute__((aligned(8))) *f;
4757 @end smallexample
4759 @noindent
4760 specifies the type ``pointer to 8-byte-aligned pointer to @code{char}''.
4761 Note again that this does not work with most attributes; for example,
4762 the usage of @samp{aligned} and @samp{noreturn} attributes given above
4763 is not yet supported.
4765 For compatibility with existing code written for compiler versions that
4766 did not implement attributes on nested declarators, some laxity is
4767 allowed in the placing of attributes.  If an attribute that only applies
4768 to types is applied to a declaration, it is treated as applying to
4769 the type of that declaration.  If an attribute that only applies to
4770 declarations is applied to the type of a declaration, it is treated
4771 as applying to that declaration; and, for compatibility with code
4772 placing the attributes immediately before the identifier declared, such
4773 an attribute applied to a function return type is treated as
4774 applying to the function type, and such an attribute applied to an array
4775 element type is treated as applying to the array type.  If an
4776 attribute that only applies to function types is applied to a
4777 pointer-to-function type, it is treated as applying to the pointer
4778 target type; if such an attribute is applied to a function return type
4779 that is not a pointer-to-function type, it is treated as applying
4780 to the function type.
4782 @node Function Prototypes
4783 @section Prototypes and Old-Style Function Definitions
4784 @cindex function prototype declarations
4785 @cindex old-style function definitions
4786 @cindex promotion of formal parameters
4788 GNU C extends ISO C to allow a function prototype to override a later
4789 old-style non-prototype definition.  Consider the following example:
4791 @smallexample
4792 /* @r{Use prototypes unless the compiler is old-fashioned.}  */
4793 #ifdef __STDC__
4794 #define P(x) x
4795 #else
4796 #define P(x) ()
4797 #endif
4799 /* @r{Prototype function declaration.}  */
4800 int isroot P((uid_t));
4802 /* @r{Old-style function definition.}  */
4804 isroot (x)   /* @r{??? lossage here ???} */
4805      uid_t x;
4807   return x == 0;
4809 @end smallexample
4811 Suppose the type @code{uid_t} happens to be @code{short}.  ISO C does
4812 not allow this example, because subword arguments in old-style
4813 non-prototype definitions are promoted.  Therefore in this example the
4814 function definition's argument is really an @code{int}, which does not
4815 match the prototype argument type of @code{short}.
4817 This restriction of ISO C makes it hard to write code that is portable
4818 to traditional C compilers, because the programmer does not know
4819 whether the @code{uid_t} type is @code{short}, @code{int}, or
4820 @code{long}.  Therefore, in cases like these GNU C allows a prototype
4821 to override a later old-style definition.  More precisely, in GNU C, a
4822 function prototype argument type overrides the argument type specified
4823 by a later old-style definition if the former type is the same as the
4824 latter type before promotion.  Thus in GNU C the above example is
4825 equivalent to the following:
4827 @smallexample
4828 int isroot (uid_t);
4831 isroot (uid_t x)
4833   return x == 0;
4835 @end smallexample
4837 @noindent
4838 GNU C++ does not support old-style function definitions, so this
4839 extension is irrelevant.
4841 @node C++ Comments
4842 @section C++ Style Comments
4843 @cindex @code{//}
4844 @cindex C++ comments
4845 @cindex comments, C++ style
4847 In GNU C, you may use C++ style comments, which start with @samp{//} and
4848 continue until the end of the line.  Many other C implementations allow
4849 such comments, and they are included in the 1999 C standard.  However,
4850 C++ style comments are not recognized if you specify an @option{-std}
4851 option specifying a version of ISO C before C99, or @option{-ansi}
4852 (equivalent to @option{-std=c90}).
4854 @node Dollar Signs
4855 @section Dollar Signs in Identifier Names
4856 @cindex $
4857 @cindex dollar signs in identifier names
4858 @cindex identifier names, dollar signs in
4860 In GNU C, you may normally use dollar signs in identifier names.
4861 This is because many traditional C implementations allow such identifiers.
4862 However, dollar signs in identifiers are not supported on a few target
4863 machines, typically because the target assembler does not allow them.
4865 @node Character Escapes
4866 @section The Character @key{ESC} in Constants
4868 You can use the sequence @samp{\e} in a string or character constant to
4869 stand for the ASCII character @key{ESC}.
4871 @node Variable Attributes
4872 @section Specifying Attributes of Variables
4873 @cindex attribute of variables
4874 @cindex variable attributes
4876 The keyword @code{__attribute__} allows you to specify special
4877 attributes of variables or structure fields.  This keyword is followed
4878 by an attribute specification inside double parentheses.  Some
4879 attributes are currently defined generically for variables.
4880 Other attributes are defined for variables on particular target
4881 systems.  Other attributes are available for functions
4882 (@pxref{Function Attributes}) and for types (@pxref{Type Attributes}).
4883 Other front ends might define more attributes
4884 (@pxref{C++ Extensions,,Extensions to the C++ Language}).
4886 You may also specify attributes with @samp{__} preceding and following
4887 each keyword.  This allows you to use them in header files without
4888 being concerned about a possible macro of the same name.  For example,
4889 you may use @code{__aligned__} instead of @code{aligned}.
4891 @xref{Attribute Syntax}, for details of the exact syntax for using
4892 attributes.
4894 @table @code
4895 @cindex @code{aligned} attribute
4896 @item aligned (@var{alignment})
4897 This attribute specifies a minimum alignment for the variable or
4898 structure field, measured in bytes.  For example, the declaration:
4900 @smallexample
4901 int x __attribute__ ((aligned (16))) = 0;
4902 @end smallexample
4904 @noindent
4905 causes the compiler to allocate the global variable @code{x} on a
4906 16-byte boundary.  On a 68040, this could be used in conjunction with
4907 an @code{asm} expression to access the @code{move16} instruction which
4908 requires 16-byte aligned operands.
4910 You can also specify the alignment of structure fields.  For example, to
4911 create a double-word aligned @code{int} pair, you could write:
4913 @smallexample
4914 struct foo @{ int x[2] __attribute__ ((aligned (8))); @};
4915 @end smallexample
4917 @noindent
4918 This is an alternative to creating a union with a @code{double} member,
4919 which forces the union to be double-word aligned.
4921 As in the preceding examples, you can explicitly specify the alignment
4922 (in bytes) that you wish the compiler to use for a given variable or
4923 structure field.  Alternatively, you can leave out the alignment factor
4924 and just ask the compiler to align a variable or field to the
4925 default alignment for the target architecture you are compiling for.
4926 The default alignment is sufficient for all scalar types, but may not be
4927 enough for all vector types on a target that supports vector operations.
4928 The default alignment is fixed for a particular target ABI.
4930 GCC also provides a target specific macro @code{__BIGGEST_ALIGNMENT__},
4931 which is the largest alignment ever used for any data type on the
4932 target machine you are compiling for.  For example, you could write:
4934 @smallexample
4935 short array[3] __attribute__ ((aligned (__BIGGEST_ALIGNMENT__)));
4936 @end smallexample
4938 The compiler automatically sets the alignment for the declared
4939 variable or field to @code{__BIGGEST_ALIGNMENT__}.  Doing this can
4940 often make copy operations more efficient, because the compiler can
4941 use whatever instructions copy the biggest chunks of memory when
4942 performing copies to or from the variables or fields that you have
4943 aligned this way.  Note that the value of @code{__BIGGEST_ALIGNMENT__}
4944 may change depending on command-line options.
4946 When used on a struct, or struct member, the @code{aligned} attribute can
4947 only increase the alignment; in order to decrease it, the @code{packed}
4948 attribute must be specified as well.  When used as part of a typedef, the
4949 @code{aligned} attribute can both increase and decrease alignment, and
4950 specifying the @code{packed} attribute generates a warning.
4952 Note that the effectiveness of @code{aligned} attributes may be limited
4953 by inherent limitations in your linker.  On many systems, the linker is
4954 only able to arrange for variables to be aligned up to a certain maximum
4955 alignment.  (For some linkers, the maximum supported alignment may
4956 be very very small.)  If your linker is only able to align variables
4957 up to a maximum of 8-byte alignment, then specifying @code{aligned(16)}
4958 in an @code{__attribute__} still only provides you with 8-byte
4959 alignment.  See your linker documentation for further information.
4961 The @code{aligned} attribute can also be used for functions
4962 (@pxref{Function Attributes}.)
4964 @item cleanup (@var{cleanup_function})
4965 @cindex @code{cleanup} attribute
4966 The @code{cleanup} attribute runs a function when the variable goes
4967 out of scope.  This attribute can only be applied to auto function
4968 scope variables; it may not be applied to parameters or variables
4969 with static storage duration.  The function must take one parameter,
4970 a pointer to a type compatible with the variable.  The return value
4971 of the function (if any) is ignored.
4973 If @option{-fexceptions} is enabled, then @var{cleanup_function}
4974 is run during the stack unwinding that happens during the
4975 processing of the exception.  Note that the @code{cleanup} attribute
4976 does not allow the exception to be caught, only to perform an action.
4977 It is undefined what happens if @var{cleanup_function} does not
4978 return normally.
4980 @item common
4981 @itemx nocommon
4982 @cindex @code{common} attribute
4983 @cindex @code{nocommon} attribute
4984 @opindex fcommon
4985 @opindex fno-common
4986 The @code{common} attribute requests GCC to place a variable in
4987 ``common'' storage.  The @code{nocommon} attribute requests the
4988 opposite---to allocate space for it directly.
4990 These attributes override the default chosen by the
4991 @option{-fno-common} and @option{-fcommon} flags respectively.
4993 @item deprecated
4994 @itemx deprecated (@var{msg})
4995 @cindex @code{deprecated} attribute
4996 The @code{deprecated} attribute results in a warning if the variable
4997 is used anywhere in the source file.  This is useful when identifying
4998 variables that are expected to be removed in a future version of a
4999 program.  The warning also includes the location of the declaration
5000 of the deprecated variable, to enable users to easily find further
5001 information about why the variable is deprecated, or what they should
5002 do instead.  Note that the warning only occurs for uses:
5004 @smallexample
5005 extern int old_var __attribute__ ((deprecated));
5006 extern int old_var;
5007 int new_fn () @{ return old_var; @}
5008 @end smallexample
5010 @noindent
5011 results in a warning on line 3 but not line 2.  The optional @var{msg}
5012 argument, which must be a string, is printed in the warning if
5013 present.
5015 The @code{deprecated} attribute can also be used for functions and
5016 types (@pxref{Function Attributes}, @pxref{Type Attributes}.)
5018 @item mode (@var{mode})
5019 @cindex @code{mode} attribute
5020 This attribute specifies the data type for the declaration---whichever
5021 type corresponds to the mode @var{mode}.  This in effect lets you
5022 request an integer or floating-point type according to its width.
5024 You may also specify a mode of @code{byte} or @code{__byte__} to
5025 indicate the mode corresponding to a one-byte integer, @code{word} or
5026 @code{__word__} for the mode of a one-word integer, and @code{pointer}
5027 or @code{__pointer__} for the mode used to represent pointers.
5029 @item packed
5030 @cindex @code{packed} attribute
5031 The @code{packed} attribute specifies that a variable or structure field
5032 should have the smallest possible alignment---one byte for a variable,
5033 and one bit for a field, unless you specify a larger value with the
5034 @code{aligned} attribute.
5036 Here is a structure in which the field @code{x} is packed, so that it
5037 immediately follows @code{a}:
5039 @smallexample
5040 struct foo
5042   char a;
5043   int x[2] __attribute__ ((packed));
5045 @end smallexample
5047 @emph{Note:} The 4.1, 4.2 and 4.3 series of GCC ignore the
5048 @code{packed} attribute on bit-fields of type @code{char}.  This has
5049 been fixed in GCC 4.4 but the change can lead to differences in the
5050 structure layout.  See the documentation of
5051 @option{-Wpacked-bitfield-compat} for more information.
5053 @item section ("@var{section-name}")
5054 @cindex @code{section} variable attribute
5055 Normally, the compiler places the objects it generates in sections like
5056 @code{data} and @code{bss}.  Sometimes, however, you need additional sections,
5057 or you need certain particular variables to appear in special sections,
5058 for example to map to special hardware.  The @code{section}
5059 attribute specifies that a variable (or function) lives in a particular
5060 section.  For example, this small program uses several specific section names:
5062 @smallexample
5063 struct duart a __attribute__ ((section ("DUART_A"))) = @{ 0 @};
5064 struct duart b __attribute__ ((section ("DUART_B"))) = @{ 0 @};
5065 char stack[10000] __attribute__ ((section ("STACK"))) = @{ 0 @};
5066 int init_data __attribute__ ((section ("INITDATA")));
5068 main()
5070   /* @r{Initialize stack pointer} */
5071   init_sp (stack + sizeof (stack));
5073   /* @r{Initialize initialized data} */
5074   memcpy (&init_data, &data, &edata - &data);
5076   /* @r{Turn on the serial ports} */
5077   init_duart (&a);
5078   init_duart (&b);
5080 @end smallexample
5082 @noindent
5083 Use the @code{section} attribute with
5084 @emph{global} variables and not @emph{local} variables,
5085 as shown in the example.
5087 You may use the @code{section} attribute with initialized or
5088 uninitialized global variables but the linker requires
5089 each object be defined once, with the exception that uninitialized
5090 variables tentatively go in the @code{common} (or @code{bss}) section
5091 and can be multiply ``defined''.  Using the @code{section} attribute
5092 changes what section the variable goes into and may cause the
5093 linker to issue an error if an uninitialized variable has multiple
5094 definitions.  You can force a variable to be initialized with the
5095 @option{-fno-common} flag or the @code{nocommon} attribute.
5097 Some file formats do not support arbitrary sections so the @code{section}
5098 attribute is not available on all platforms.
5099 If you need to map the entire contents of a module to a particular
5100 section, consider using the facilities of the linker instead.
5102 @item shared
5103 @cindex @code{shared} variable attribute
5104 On Microsoft Windows, in addition to putting variable definitions in a named
5105 section, the section can also be shared among all running copies of an
5106 executable or DLL@.  For example, this small program defines shared data
5107 by putting it in a named section @code{shared} and marking the section
5108 shareable:
5110 @smallexample
5111 int foo __attribute__((section ("shared"), shared)) = 0;
5114 main()
5116   /* @r{Read and write foo.  All running
5117      copies see the same value.}  */
5118   return 0;
5120 @end smallexample
5122 @noindent
5123 You may only use the @code{shared} attribute along with @code{section}
5124 attribute with a fully-initialized global definition because of the way
5125 linkers work.  See @code{section} attribute for more information.
5127 The @code{shared} attribute is only available on Microsoft Windows@.
5129 @item tls_model ("@var{tls_model}")
5130 @cindex @code{tls_model} attribute
5131 The @code{tls_model} attribute sets thread-local storage model
5132 (@pxref{Thread-Local}) of a particular @code{__thread} variable,
5133 overriding @option{-ftls-model=} command-line switch on a per-variable
5134 basis.
5135 The @var{tls_model} argument should be one of @code{global-dynamic},
5136 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
5138 Not all targets support this attribute.
5140 @item unused
5141 This attribute, attached to a variable, means that the variable is meant
5142 to be possibly unused.  GCC does not produce a warning for this
5143 variable.
5145 @item used
5146 This attribute, attached to a variable with the static storage, means that
5147 the variable must be emitted even if it appears that the variable is not
5148 referenced.
5150 When applied to a static data member of a C++ class template, the
5151 attribute also means that the member is instantiated if the
5152 class itself is instantiated.
5154 @item vector_size (@var{bytes})
5155 This attribute specifies the vector size for the variable, measured in
5156 bytes.  For example, the declaration:
5158 @smallexample
5159 int foo __attribute__ ((vector_size (16)));
5160 @end smallexample
5162 @noindent
5163 causes the compiler to set the mode for @code{foo}, to be 16 bytes,
5164 divided into @code{int} sized units.  Assuming a 32-bit int (a vector of
5165 4 units of 4 bytes), the corresponding mode of @code{foo} is V4SI@.
5167 This attribute is only applicable to integral and float scalars,
5168 although arrays, pointers, and function return values are allowed in
5169 conjunction with this construct.
5171 Aggregates with this attribute are invalid, even if they are of the same
5172 size as a corresponding scalar.  For example, the declaration:
5174 @smallexample
5175 struct S @{ int a; @};
5176 struct S  __attribute__ ((vector_size (16))) foo;
5177 @end smallexample
5179 @noindent
5180 is invalid even if the size of the structure is the same as the size of
5181 the @code{int}.
5183 @item selectany
5184 The @code{selectany} attribute causes an initialized global variable to
5185 have link-once semantics.  When multiple definitions of the variable are
5186 encountered by the linker, the first is selected and the remainder are
5187 discarded.  Following usage by the Microsoft compiler, the linker is told
5188 @emph{not} to warn about size or content differences of the multiple
5189 definitions.
5191 Although the primary usage of this attribute is for POD types, the
5192 attribute can also be applied to global C++ objects that are initialized
5193 by a constructor.  In this case, the static initialization and destruction
5194 code for the object is emitted in each translation defining the object,
5195 but the calls to the constructor and destructor are protected by a
5196 link-once guard variable.
5198 The @code{selectany} attribute is only available on Microsoft Windows
5199 targets.  You can use @code{__declspec (selectany)} as a synonym for
5200 @code{__attribute__ ((selectany))} for compatibility with other
5201 compilers.
5203 @item weak
5204 The @code{weak} attribute is described in @ref{Function Attributes}.
5206 @item dllimport
5207 The @code{dllimport} attribute is described in @ref{Function Attributes}.
5209 @item dllexport
5210 The @code{dllexport} attribute is described in @ref{Function Attributes}.
5212 @end table
5214 @anchor{AVR Variable Attributes}
5215 @subsection AVR Variable Attributes
5217 @table @code
5218 @item progmem
5219 @cindex @code{progmem} AVR variable attribute
5220 The @code{progmem} attribute is used on the AVR to place read-only
5221 data in the non-volatile program memory (flash). The @code{progmem}
5222 attribute accomplishes this by putting respective variables into a
5223 section whose name starts with @code{.progmem}.
5225 This attribute works similar to the @code{section} attribute
5226 but adds additional checking. Notice that just like the
5227 @code{section} attribute, @code{progmem} affects the location
5228 of the data but not how this data is accessed.
5230 In order to read data located with the @code{progmem} attribute
5231 (inline) assembler must be used.
5232 @smallexample
5233 /* Use custom macros from @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC}} */
5234 #include <avr/pgmspace.h> 
5236 /* Locate var in flash memory */
5237 const int var[2] PROGMEM = @{ 1, 2 @};
5239 int read_var (int i)
5241     /* Access var[] by accessor macro from avr/pgmspace.h */
5242     return (int) pgm_read_word (& var[i]);
5244 @end smallexample
5246 AVR is a Harvard architecture processor and data and read-only data
5247 normally resides in the data memory (RAM).
5249 See also the @ref{AVR Named Address Spaces} section for
5250 an alternate way to locate and access data in flash memory.
5251 @end table
5253 @subsection Blackfin Variable Attributes
5255 Three attributes are currently defined for the Blackfin.
5257 @table @code
5258 @item l1_data
5259 @itemx l1_data_A
5260 @itemx l1_data_B
5261 @cindex @code{l1_data} variable attribute
5262 @cindex @code{l1_data_A} variable attribute
5263 @cindex @code{l1_data_B} variable attribute
5264 Use these attributes on the Blackfin to place the variable into L1 Data SRAM.
5265 Variables with @code{l1_data} attribute are put into the specific section
5266 named @code{.l1.data}. Those with @code{l1_data_A} attribute are put into
5267 the specific section named @code{.l1.data.A}. Those with @code{l1_data_B}
5268 attribute are put into the specific section named @code{.l1.data.B}.
5270 @item l2
5271 @cindex @code{l2} variable attribute
5272 Use this attribute on the Blackfin to place the variable into L2 SRAM.
5273 Variables with @code{l2} attribute are put into the specific section
5274 named @code{.l2.data}.
5275 @end table
5277 @subsection M32R/D Variable Attributes
5279 One attribute is currently defined for the M32R/D@.
5281 @table @code
5282 @item model (@var{model-name})
5283 @cindex variable addressability on the M32R/D
5284 Use this attribute on the M32R/D to set the addressability of an object.
5285 The identifier @var{model-name} is one of @code{small}, @code{medium},
5286 or @code{large}, representing each of the code models.
5288 Small model objects live in the lower 16MB of memory (so that their
5289 addresses can be loaded with the @code{ld24} instruction).
5291 Medium and large model objects may live anywhere in the 32-bit address space
5292 (the compiler generates @code{seth/add3} instructions to load their
5293 addresses).
5294 @end table
5296 @anchor{MeP Variable Attributes}
5297 @subsection MeP Variable Attributes
5299 The MeP target has a number of addressing modes and busses.  The
5300 @code{near} space spans the standard memory space's first 16 megabytes
5301 (24 bits).  The @code{far} space spans the entire 32-bit memory space.
5302 The @code{based} space is a 128-byte region in the memory space that
5303 is addressed relative to the @code{$tp} register.  The @code{tiny}
5304 space is a 65536-byte region relative to the @code{$gp} register.  In
5305 addition to these memory regions, the MeP target has a separate 16-bit
5306 control bus which is specified with @code{cb} attributes.
5308 @table @code
5310 @item based
5311 Any variable with the @code{based} attribute is assigned to the
5312 @code{.based} section, and is accessed with relative to the
5313 @code{$tp} register.
5315 @item tiny
5316 Likewise, the @code{tiny} attribute assigned variables to the
5317 @code{.tiny} section, relative to the @code{$gp} register.
5319 @item near
5320 Variables with the @code{near} attribute are assumed to have addresses
5321 that fit in a 24-bit addressing mode.  This is the default for large
5322 variables (@code{-mtiny=4} is the default) but this attribute can
5323 override @code{-mtiny=} for small variables, or override @code{-ml}.
5325 @item far
5326 Variables with the @code{far} attribute are addressed using a full
5327 32-bit address.  Since this covers the entire memory space, this
5328 allows modules to make no assumptions about where variables might be
5329 stored.
5331 @item io
5332 @itemx io (@var{addr})
5333 Variables with the @code{io} attribute are used to address
5334 memory-mapped peripherals.  If an address is specified, the variable
5335 is assigned that address, else it is not assigned an address (it is
5336 assumed some other module assigns an address).  Example:
5338 @smallexample
5339 int timer_count __attribute__((io(0x123)));
5340 @end smallexample
5342 @item cb
5343 @itemx cb (@var{addr})
5344 Variables with the @code{cb} attribute are used to access the control
5345 bus, using special instructions.  @code{addr} indicates the control bus
5346 address.  Example:
5348 @smallexample
5349 int cpu_clock __attribute__((cb(0x123)));
5350 @end smallexample
5352 @end table
5354 @anchor{i386 Variable Attributes}
5355 @subsection i386 Variable Attributes
5357 Two attributes are currently defined for i386 configurations:
5358 @code{ms_struct} and @code{gcc_struct}
5360 @table @code
5361 @item ms_struct
5362 @itemx gcc_struct
5363 @cindex @code{ms_struct} attribute
5364 @cindex @code{gcc_struct} attribute
5366 If @code{packed} is used on a structure, or if bit-fields are used,
5367 it may be that the Microsoft ABI lays out the structure differently
5368 than the way GCC normally does.  Particularly when moving packed
5369 data between functions compiled with GCC and the native Microsoft compiler
5370 (either via function call or as data in a file), it may be necessary to access
5371 either format.
5373 Currently @option{-m[no-]ms-bitfields} is provided for the Microsoft Windows X86
5374 compilers to match the native Microsoft compiler.
5376 The Microsoft structure layout algorithm is fairly simple with the exception
5377 of the bit-field packing.  
5378 The padding and alignment of members of structures and whether a bit-field 
5379 can straddle a storage-unit boundary are determine by these rules:
5381 @enumerate
5382 @item Structure members are stored sequentially in the order in which they are
5383 declared: the first member has the lowest memory address and the last member
5384 the highest.
5386 @item Every data object has an alignment requirement.  The alignment requirement
5387 for all data except structures, unions, and arrays is either the size of the
5388 object or the current packing size (specified with either the
5389 @code{aligned} attribute or the @code{pack} pragma),
5390 whichever is less.  For structures, unions, and arrays,
5391 the alignment requirement is the largest alignment requirement of its members.
5392 Every object is allocated an offset so that:
5394 @smallexample
5395 offset % alignment_requirement == 0
5396 @end smallexample
5398 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
5399 unit if the integral types are the same size and if the next bit-field fits
5400 into the current allocation unit without crossing the boundary imposed by the
5401 common alignment requirements of the bit-fields.
5402 @end enumerate
5404 MSVC interprets zero-length bit-fields in the following ways:
5406 @enumerate
5407 @item If a zero-length bit-field is inserted between two bit-fields that
5408 are normally coalesced, the bit-fields are not coalesced.
5410 For example:
5412 @smallexample
5413 struct
5414  @{
5415    unsigned long bf_1 : 12;
5416    unsigned long : 0;
5417    unsigned long bf_2 : 12;
5418  @} t1;
5419 @end smallexample
5421 @noindent
5422 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
5423 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
5425 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
5426 alignment of the zero-length bit-field is greater than the member that follows it,
5427 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
5429 For example:
5431 @smallexample
5432 struct
5433  @{
5434    char foo : 4;
5435    short : 0;
5436    char bar;
5437  @} t2;
5439 struct
5440  @{
5441    char foo : 4;
5442    short : 0;
5443    double bar;
5444  @} t3;
5445 @end smallexample
5447 @noindent
5448 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
5449 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
5450 bit-field does not affect the alignment of @code{bar} or, as a result, the size
5451 of the structure.
5453 Taking this into account, it is important to note the following:
5455 @enumerate
5456 @item If a zero-length bit-field follows a normal bit-field, the type of the
5457 zero-length bit-field may affect the alignment of the structure as whole. For
5458 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
5459 normal bit-field, and is of type short.
5461 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
5462 still affect the alignment of the structure:
5464 @smallexample
5465 struct
5466  @{
5467    char foo : 6;
5468    long : 0;
5469  @} t4;
5470 @end smallexample
5472 @noindent
5473 Here, @code{t4} takes up 4 bytes.
5474 @end enumerate
5476 @item Zero-length bit-fields following non-bit-field members are ignored:
5478 @smallexample
5479 struct
5480  @{
5481    char foo;
5482    long : 0;
5483    char bar;
5484  @} t5;
5485 @end smallexample
5487 @noindent
5488 Here, @code{t5} takes up 2 bytes.
5489 @end enumerate
5490 @end table
5492 @subsection PowerPC Variable Attributes
5494 Three attributes currently are defined for PowerPC configurations:
5495 @code{altivec}, @code{ms_struct} and @code{gcc_struct}.
5497 For full documentation of the struct attributes please see the
5498 documentation in @ref{i386 Variable Attributes}.
5500 For documentation of @code{altivec} attribute please see the
5501 documentation in @ref{PowerPC Type Attributes}.
5503 @subsection SPU Variable Attributes
5505 The SPU supports the @code{spu_vector} attribute for variables.  For
5506 documentation of this attribute please see the documentation in
5507 @ref{SPU Type Attributes}.
5509 @subsection Xstormy16 Variable Attributes
5511 One attribute is currently defined for xstormy16 configurations:
5512 @code{below100}.
5514 @table @code
5515 @item below100
5516 @cindex @code{below100} attribute
5518 If a variable has the @code{below100} attribute (@code{BELOW100} is
5519 allowed also), GCC places the variable in the first 0x100 bytes of
5520 memory and use special opcodes to access it.  Such variables are
5521 placed in either the @code{.bss_below100} section or the
5522 @code{.data_below100} section.
5524 @end table
5526 @node Type Attributes
5527 @section Specifying Attributes of Types
5528 @cindex attribute of types
5529 @cindex type attributes
5531 The keyword @code{__attribute__} allows you to specify special
5532 attributes of @code{struct} and @code{union} types when you define
5533 such types.  This keyword is followed by an attribute specification
5534 inside double parentheses.  Seven attributes are currently defined for
5535 types: @code{aligned}, @code{packed}, @code{transparent_union},
5536 @code{unused}, @code{deprecated}, @code{visibility}, and
5537 @code{may_alias}.  Other attributes are defined for functions
5538 (@pxref{Function Attributes}) and for variables (@pxref{Variable
5539 Attributes}).
5541 You may also specify any one of these attributes with @samp{__}
5542 preceding and following its keyword.  This allows you to use these
5543 attributes in header files without being concerned about a possible
5544 macro of the same name.  For example, you may use @code{__aligned__}
5545 instead of @code{aligned}.
5547 You may specify type attributes in an enum, struct or union type
5548 declaration or definition, or for other types in a @code{typedef}
5549 declaration.
5551 For an enum, struct or union type, you may specify attributes either
5552 between the enum, struct or union tag and the name of the type, or
5553 just past the closing curly brace of the @emph{definition}.  The
5554 former syntax is preferred.
5556 @xref{Attribute Syntax}, for details of the exact syntax for using
5557 attributes.
5559 @table @code
5560 @cindex @code{aligned} attribute
5561 @item aligned (@var{alignment})
5562 This attribute specifies a minimum alignment (in bytes) for variables
5563 of the specified type.  For example, the declarations:
5565 @smallexample
5566 struct S @{ short f[3]; @} __attribute__ ((aligned (8)));
5567 typedef int more_aligned_int __attribute__ ((aligned (8)));
5568 @end smallexample
5570 @noindent
5571 force the compiler to ensure (as far as it can) that each variable whose
5572 type is @code{struct S} or @code{more_aligned_int} is allocated and
5573 aligned @emph{at least} on a 8-byte boundary.  On a SPARC, having all
5574 variables of type @code{struct S} aligned to 8-byte boundaries allows
5575 the compiler to use the @code{ldd} and @code{std} (doubleword load and
5576 store) instructions when copying one variable of type @code{struct S} to
5577 another, thus improving run-time efficiency.
5579 Note that the alignment of any given @code{struct} or @code{union} type
5580 is required by the ISO C standard to be at least a perfect multiple of
5581 the lowest common multiple of the alignments of all of the members of
5582 the @code{struct} or @code{union} in question.  This means that you @emph{can}
5583 effectively adjust the alignment of a @code{struct} or @code{union}
5584 type by attaching an @code{aligned} attribute to any one of the members
5585 of such a type, but the notation illustrated in the example above is a
5586 more obvious, intuitive, and readable way to request the compiler to
5587 adjust the alignment of an entire @code{struct} or @code{union} type.
5589 As in the preceding example, you can explicitly specify the alignment
5590 (in bytes) that you wish the compiler to use for a given @code{struct}
5591 or @code{union} type.  Alternatively, you can leave out the alignment factor
5592 and just ask the compiler to align a type to the maximum
5593 useful alignment for the target machine you are compiling for.  For
5594 example, you could write:
5596 @smallexample
5597 struct S @{ short f[3]; @} __attribute__ ((aligned));
5598 @end smallexample
5600 Whenever you leave out the alignment factor in an @code{aligned}
5601 attribute specification, the compiler automatically sets the alignment
5602 for the type to the largest alignment that is ever used for any data
5603 type on the target machine you are compiling for.  Doing this can often
5604 make copy operations more efficient, because the compiler can use
5605 whatever instructions copy the biggest chunks of memory when performing
5606 copies to or from the variables that have types that you have aligned
5607 this way.
5609 In the example above, if the size of each @code{short} is 2 bytes, then
5610 the size of the entire @code{struct S} type is 6 bytes.  The smallest
5611 power of two that is greater than or equal to that is 8, so the
5612 compiler sets the alignment for the entire @code{struct S} type to 8
5613 bytes.
5615 Note that although you can ask the compiler to select a time-efficient
5616 alignment for a given type and then declare only individual stand-alone
5617 objects of that type, the compiler's ability to select a time-efficient
5618 alignment is primarily useful only when you plan to create arrays of
5619 variables having the relevant (efficiently aligned) type.  If you
5620 declare or use arrays of variables of an efficiently-aligned type, then
5621 it is likely that your program also does pointer arithmetic (or
5622 subscripting, which amounts to the same thing) on pointers to the
5623 relevant type, and the code that the compiler generates for these
5624 pointer arithmetic operations is often more efficient for
5625 efficiently-aligned types than for other types.
5627 The @code{aligned} attribute can only increase the alignment; but you
5628 can decrease it by specifying @code{packed} as well.  See below.
5630 Note that the effectiveness of @code{aligned} attributes may be limited
5631 by inherent limitations in your linker.  On many systems, the linker is
5632 only able to arrange for variables to be aligned up to a certain maximum
5633 alignment.  (For some linkers, the maximum supported alignment may
5634 be very very small.)  If your linker is only able to align variables
5635 up to a maximum of 8-byte alignment, then specifying @code{aligned(16)}
5636 in an @code{__attribute__} still only provides you with 8-byte
5637 alignment.  See your linker documentation for further information.
5639 @item packed
5640 This attribute, attached to @code{struct} or @code{union} type
5641 definition, specifies that each member (other than zero-width bit-fields)
5642 of the structure or union is placed to minimize the memory required.  When
5643 attached to an @code{enum} definition, it indicates that the smallest
5644 integral type should be used.
5646 @opindex fshort-enums
5647 Specifying this attribute for @code{struct} and @code{union} types is
5648 equivalent to specifying the @code{packed} attribute on each of the
5649 structure or union members.  Specifying the @option{-fshort-enums}
5650 flag on the line is equivalent to specifying the @code{packed}
5651 attribute on all @code{enum} definitions.
5653 In the following example @code{struct my_packed_struct}'s members are
5654 packed closely together, but the internal layout of its @code{s} member
5655 is not packed---to do that, @code{struct my_unpacked_struct} needs to
5656 be packed too.
5658 @smallexample
5659 struct my_unpacked_struct
5660  @{
5661     char c;
5662     int i;
5663  @};
5665 struct __attribute__ ((__packed__)) my_packed_struct
5666   @{
5667      char c;
5668      int  i;
5669      struct my_unpacked_struct s;
5670   @};
5671 @end smallexample
5673 You may only specify this attribute on the definition of an @code{enum},
5674 @code{struct} or @code{union}, not on a @code{typedef} that does not
5675 also define the enumerated type, structure or union.
5677 @item transparent_union
5678 This attribute, attached to a @code{union} type definition, indicates
5679 that any function parameter having that union type causes calls to that
5680 function to be treated in a special way.
5682 First, the argument corresponding to a transparent union type can be of
5683 any type in the union; no cast is required.  Also, if the union contains
5684 a pointer type, the corresponding argument can be a null pointer
5685 constant or a void pointer expression; and if the union contains a void
5686 pointer type, the corresponding argument can be any pointer expression.
5687 If the union member type is a pointer, qualifiers like @code{const} on
5688 the referenced type must be respected, just as with normal pointer
5689 conversions.
5691 Second, the argument is passed to the function using the calling
5692 conventions of the first member of the transparent union, not the calling
5693 conventions of the union itself.  All members of the union must have the
5694 same machine representation; this is necessary for this argument passing
5695 to work properly.
5697 Transparent unions are designed for library functions that have multiple
5698 interfaces for compatibility reasons.  For example, suppose the
5699 @code{wait} function must accept either a value of type @code{int *} to
5700 comply with POSIX, or a value of type @code{union wait *} to comply with
5701 the 4.1BSD interface.  If @code{wait}'s parameter were @code{void *},
5702 @code{wait} would accept both kinds of arguments, but it would also
5703 accept any other pointer type and this would make argument type checking
5704 less useful.  Instead, @code{<sys/wait.h>} might define the interface
5705 as follows:
5707 @smallexample
5708 typedef union __attribute__ ((__transparent_union__))
5709   @{
5710     int *__ip;
5711     union wait *__up;
5712   @} wait_status_ptr_t;
5714 pid_t wait (wait_status_ptr_t);
5715 @end smallexample
5717 @noindent
5718 This interface allows either @code{int *} or @code{union wait *}
5719 arguments to be passed, using the @code{int *} calling convention.
5720 The program can call @code{wait} with arguments of either type:
5722 @smallexample
5723 int w1 () @{ int w; return wait (&w); @}
5724 int w2 () @{ union wait w; return wait (&w); @}
5725 @end smallexample
5727 @noindent
5728 With this interface, @code{wait}'s implementation might look like this:
5730 @smallexample
5731 pid_t wait (wait_status_ptr_t p)
5733   return waitpid (-1, p.__ip, 0);
5735 @end smallexample
5737 @item unused
5738 When attached to a type (including a @code{union} or a @code{struct}),
5739 this attribute means that variables of that type are meant to appear
5740 possibly unused.  GCC does not produce a warning for any variables of
5741 that type, even if the variable appears to do nothing.  This is often
5742 the case with lock or thread classes, which are usually defined and then
5743 not referenced, but contain constructors and destructors that have
5744 nontrivial bookkeeping functions.
5746 @item deprecated
5747 @itemx deprecated (@var{msg})
5748 The @code{deprecated} attribute results in a warning if the type
5749 is used anywhere in the source file.  This is useful when identifying
5750 types that are expected to be removed in a future version of a program.
5751 If possible, the warning also includes the location of the declaration
5752 of the deprecated type, to enable users to easily find further
5753 information about why the type is deprecated, or what they should do
5754 instead.  Note that the warnings only occur for uses and then only
5755 if the type is being applied to an identifier that itself is not being
5756 declared as deprecated.
5758 @smallexample
5759 typedef int T1 __attribute__ ((deprecated));
5760 T1 x;
5761 typedef T1 T2;
5762 T2 y;
5763 typedef T1 T3 __attribute__ ((deprecated));
5764 T3 z __attribute__ ((deprecated));
5765 @end smallexample
5767 @noindent
5768 results in a warning on line 2 and 3 but not lines 4, 5, or 6.  No
5769 warning is issued for line 4 because T2 is not explicitly
5770 deprecated.  Line 5 has no warning because T3 is explicitly
5771 deprecated.  Similarly for line 6.  The optional @var{msg}
5772 argument, which must be a string, is printed in the warning if
5773 present.
5775 The @code{deprecated} attribute can also be used for functions and
5776 variables (@pxref{Function Attributes}, @pxref{Variable Attributes}.)
5778 @item may_alias
5779 Accesses through pointers to types with this attribute are not subject
5780 to type-based alias analysis, but are instead assumed to be able to alias
5781 any other type of objects.
5782 In the context of section 6.5 paragraph 7 of the C99 standard,
5783 an lvalue expression
5784 dereferencing such a pointer is treated like having a character type.
5785 See @option{-fstrict-aliasing} for more information on aliasing issues.
5786 This extension exists to support some vector APIs, in which pointers to
5787 one vector type are permitted to alias pointers to a different vector type.
5789 Note that an object of a type with this attribute does not have any
5790 special semantics.
5792 Example of use:
5794 @smallexample
5795 typedef short __attribute__((__may_alias__)) short_a;
5798 main (void)
5800   int a = 0x12345678;
5801   short_a *b = (short_a *) &a;
5803   b[1] = 0;
5805   if (a == 0x12345678)
5806     abort();
5808   exit(0);
5810 @end smallexample
5812 @noindent
5813 If you replaced @code{short_a} with @code{short} in the variable
5814 declaration, the above program would abort when compiled with
5815 @option{-fstrict-aliasing}, which is on by default at @option{-O2} or
5816 above in recent GCC versions.
5818 @item visibility
5819 In C++, attribute visibility (@pxref{Function Attributes}) can also be
5820 applied to class, struct, union and enum types.  Unlike other type
5821 attributes, the attribute must appear between the initial keyword and
5822 the name of the type; it cannot appear after the body of the type.
5824 Note that the type visibility is applied to vague linkage entities
5825 associated with the class (vtable, typeinfo node, etc.).  In
5826 particular, if a class is thrown as an exception in one shared object
5827 and caught in another, the class must have default visibility.
5828 Otherwise the two shared objects are unable to use the same
5829 typeinfo node and exception handling will break.
5831 @end table
5833 To specify multiple attributes, separate them by commas within the
5834 double parentheses: for example, @samp{__attribute__ ((aligned (16),
5835 packed))}.
5837 @subsection ARM Type Attributes
5839 On those ARM targets that support @code{dllimport} (such as Symbian
5840 OS), you can use the @code{notshared} attribute to indicate that the
5841 virtual table and other similar data for a class should not be
5842 exported from a DLL@.  For example:
5844 @smallexample
5845 class __declspec(notshared) C @{
5846 public:
5847   __declspec(dllimport) C();
5848   virtual void f();
5851 __declspec(dllexport)
5852 C::C() @{@}
5853 @end smallexample
5855 @noindent
5856 In this code, @code{C::C} is exported from the current DLL, but the
5857 virtual table for @code{C} is not exported.  (You can use
5858 @code{__attribute__} instead of @code{__declspec} if you prefer, but
5859 most Symbian OS code uses @code{__declspec}.)
5861 @anchor{MeP Type Attributes}
5862 @subsection MeP Type Attributes
5864 Many of the MeP variable attributes may be applied to types as well.
5865 Specifically, the @code{based}, @code{tiny}, @code{near}, and
5866 @code{far} attributes may be applied to either.  The @code{io} and
5867 @code{cb} attributes may not be applied to types.
5869 @anchor{i386 Type Attributes}
5870 @subsection i386 Type Attributes
5872 Two attributes are currently defined for i386 configurations:
5873 @code{ms_struct} and @code{gcc_struct}.
5875 @table @code
5877 @item ms_struct
5878 @itemx gcc_struct
5879 @cindex @code{ms_struct}
5880 @cindex @code{gcc_struct}
5882 If @code{packed} is used on a structure, or if bit-fields are used
5883 it may be that the Microsoft ABI packs them differently
5884 than GCC normally packs them.  Particularly when moving packed
5885 data between functions compiled with GCC and the native Microsoft compiler
5886 (either via function call or as data in a file), it may be necessary to access
5887 either format.
5889 Currently @option{-m[no-]ms-bitfields} is provided for the Microsoft Windows X86
5890 compilers to match the native Microsoft compiler.
5891 @end table
5893 @anchor{PowerPC Type Attributes}
5894 @subsection PowerPC Type Attributes
5896 Three attributes currently are defined for PowerPC configurations:
5897 @code{altivec}, @code{ms_struct} and @code{gcc_struct}.
5899 For full documentation of the @code{ms_struct} and @code{gcc_struct}
5900 attributes please see the documentation in @ref{i386 Type Attributes}.
5902 The @code{altivec} attribute allows one to declare AltiVec vector data
5903 types supported by the AltiVec Programming Interface Manual.  The
5904 attribute requires an argument to specify one of three vector types:
5905 @code{vector__}, @code{pixel__} (always followed by unsigned short),
5906 and @code{bool__} (always followed by unsigned).
5908 @smallexample
5909 __attribute__((altivec(vector__)))
5910 __attribute__((altivec(pixel__))) unsigned short
5911 __attribute__((altivec(bool__))) unsigned
5912 @end smallexample
5914 These attributes mainly are intended to support the @code{__vector},
5915 @code{__pixel}, and @code{__bool} AltiVec keywords.
5917 @anchor{SPU Type Attributes}
5918 @subsection SPU Type Attributes
5920 The SPU supports the @code{spu_vector} attribute for types.  This attribute
5921 allows one to declare vector data types supported by the Sony/Toshiba/IBM SPU
5922 Language Extensions Specification.  It is intended to support the
5923 @code{__vector} keyword.
5925 @node Alignment
5926 @section Inquiring on Alignment of Types or Variables
5927 @cindex alignment
5928 @cindex type alignment
5929 @cindex variable alignment
5931 The keyword @code{__alignof__} allows you to inquire about how an object
5932 is aligned, or the minimum alignment usually required by a type.  Its
5933 syntax is just like @code{sizeof}.
5935 For example, if the target machine requires a @code{double} value to be
5936 aligned on an 8-byte boundary, then @code{__alignof__ (double)} is 8.
5937 This is true on many RISC machines.  On more traditional machine
5938 designs, @code{__alignof__ (double)} is 4 or even 2.
5940 Some machines never actually require alignment; they allow reference to any
5941 data type even at an odd address.  For these machines, @code{__alignof__}
5942 reports the smallest alignment that GCC gives the data type, usually as
5943 mandated by the target ABI.
5945 If the operand of @code{__alignof__} is an lvalue rather than a type,
5946 its value is the required alignment for its type, taking into account
5947 any minimum alignment specified with GCC's @code{__attribute__}
5948 extension (@pxref{Variable Attributes}).  For example, after this
5949 declaration:
5951 @smallexample
5952 struct foo @{ int x; char y; @} foo1;
5953 @end smallexample
5955 @noindent
5956 the value of @code{__alignof__ (foo1.y)} is 1, even though its actual
5957 alignment is probably 2 or 4, the same as @code{__alignof__ (int)}.
5959 It is an error to ask for the alignment of an incomplete type.
5962 @node Inline
5963 @section An Inline Function is As Fast As a Macro
5964 @cindex inline functions
5965 @cindex integrating function code
5966 @cindex open coding
5967 @cindex macros, inline alternative
5969 By declaring a function inline, you can direct GCC to make
5970 calls to that function faster.  One way GCC can achieve this is to
5971 integrate that function's code into the code for its callers.  This
5972 makes execution faster by eliminating the function-call overhead; in
5973 addition, if any of the actual argument values are constant, their
5974 known values may permit simplifications at compile time so that not
5975 all of the inline function's code needs to be included.  The effect on
5976 code size is less predictable; object code may be larger or smaller
5977 with function inlining, depending on the particular case.  You can
5978 also direct GCC to try to integrate all ``simple enough'' functions
5979 into their callers with the option @option{-finline-functions}.
5981 GCC implements three different semantics of declaring a function
5982 inline.  One is available with @option{-std=gnu89} or
5983 @option{-fgnu89-inline} or when @code{gnu_inline} attribute is present
5984 on all inline declarations, another when
5985 @option{-std=c99}, @option{-std=c11},
5986 @option{-std=gnu99} or @option{-std=gnu11}
5987 (without @option{-fgnu89-inline}), and the third
5988 is used when compiling C++.
5990 To declare a function inline, use the @code{inline} keyword in its
5991 declaration, like this:
5993 @smallexample
5994 static inline int
5995 inc (int *a)
5997   return (*a)++;
5999 @end smallexample
6001 If you are writing a header file to be included in ISO C90 programs, write
6002 @code{__inline__} instead of @code{inline}.  @xref{Alternate Keywords}.
6004 The three types of inlining behave similarly in two important cases:
6005 when the @code{inline} keyword is used on a @code{static} function,
6006 like the example above, and when a function is first declared without
6007 using the @code{inline} keyword and then is defined with
6008 @code{inline}, like this:
6010 @smallexample
6011 extern int inc (int *a);
6012 inline int
6013 inc (int *a)
6015   return (*a)++;
6017 @end smallexample
6019 In both of these common cases, the program behaves the same as if you
6020 had not used the @code{inline} keyword, except for its speed.
6022 @cindex inline functions, omission of
6023 @opindex fkeep-inline-functions
6024 When a function is both inline and @code{static}, if all calls to the
6025 function are integrated into the caller, and the function's address is
6026 never used, then the function's own assembler code is never referenced.
6027 In this case, GCC does not actually output assembler code for the
6028 function, unless you specify the option @option{-fkeep-inline-functions}.
6029 Some calls cannot be integrated for various reasons (in particular,
6030 calls that precede the function's definition cannot be integrated, and
6031 neither can recursive calls within the definition).  If there is a
6032 nonintegrated call, then the function is compiled to assembler code as
6033 usual.  The function must also be compiled as usual if the program
6034 refers to its address, because that can't be inlined.
6036 @opindex Winline
6037 Note that certain usages in a function definition can make it unsuitable
6038 for inline substitution.  Among these usages are: variadic functions, use of
6039 @code{alloca}, use of variable-length data types (@pxref{Variable Length}),
6040 use of computed goto (@pxref{Labels as Values}), use of nonlocal goto,
6041 and nested functions (@pxref{Nested Functions}).  Using @option{-Winline}
6042 warns when a function marked @code{inline} could not be substituted,
6043 and gives the reason for the failure.
6045 @cindex automatic @code{inline} for C++ member fns
6046 @cindex @code{inline} automatic for C++ member fns
6047 @cindex member fns, automatically @code{inline}
6048 @cindex C++ member fns, automatically @code{inline}
6049 @opindex fno-default-inline
6050 As required by ISO C++, GCC considers member functions defined within
6051 the body of a class to be marked inline even if they are
6052 not explicitly declared with the @code{inline} keyword.  You can
6053 override this with @option{-fno-default-inline}; @pxref{C++ Dialect
6054 Options,,Options Controlling C++ Dialect}.
6056 GCC does not inline any functions when not optimizing unless you specify
6057 the @samp{always_inline} attribute for the function, like this:
6059 @smallexample
6060 /* @r{Prototype.}  */
6061 inline void foo (const char) __attribute__((always_inline));
6062 @end smallexample
6064 The remainder of this section is specific to GNU C90 inlining.
6066 @cindex non-static inline function
6067 When an inline function is not @code{static}, then the compiler must assume
6068 that there may be calls from other source files; since a global symbol can
6069 be defined only once in any program, the function must not be defined in
6070 the other source files, so the calls therein cannot be integrated.
6071 Therefore, a non-@code{static} inline function is always compiled on its
6072 own in the usual fashion.
6074 If you specify both @code{inline} and @code{extern} in the function
6075 definition, then the definition is used only for inlining.  In no case
6076 is the function compiled on its own, not even if you refer to its
6077 address explicitly.  Such an address becomes an external reference, as
6078 if you had only declared the function, and had not defined it.
6080 This combination of @code{inline} and @code{extern} has almost the
6081 effect of a macro.  The way to use it is to put a function definition in
6082 a header file with these keywords, and put another copy of the
6083 definition (lacking @code{inline} and @code{extern}) in a library file.
6084 The definition in the header file causes most calls to the function
6085 to be inlined.  If any uses of the function remain, they refer to
6086 the single copy in the library.
6088 @node Volatiles
6089 @section When is a Volatile Object Accessed?
6090 @cindex accessing volatiles
6091 @cindex volatile read
6092 @cindex volatile write
6093 @cindex volatile access
6095 C has the concept of volatile objects.  These are normally accessed by
6096 pointers and used for accessing hardware or inter-thread
6097 communication.  The standard encourages compilers to refrain from
6098 optimizations concerning accesses to volatile objects, but leaves it
6099 implementation defined as to what constitutes a volatile access.  The
6100 minimum requirement is that at a sequence point all previous accesses
6101 to volatile objects have stabilized and no subsequent accesses have
6102 occurred.  Thus an implementation is free to reorder and combine
6103 volatile accesses that occur between sequence points, but cannot do
6104 so for accesses across a sequence point.  The use of volatile does
6105 not allow you to violate the restriction on updating objects multiple
6106 times between two sequence points.
6108 Accesses to non-volatile objects are not ordered with respect to
6109 volatile accesses.  You cannot use a volatile object as a memory
6110 barrier to order a sequence of writes to non-volatile memory.  For
6111 instance:
6113 @smallexample
6114 int *ptr = @var{something};
6115 volatile int vobj;
6116 *ptr = @var{something};
6117 vobj = 1;
6118 @end smallexample
6120 @noindent
6121 Unless @var{*ptr} and @var{vobj} can be aliased, it is not guaranteed
6122 that the write to @var{*ptr} occurs by the time the update
6123 of @var{vobj} happens.  If you need this guarantee, you must use
6124 a stronger memory barrier such as:
6126 @smallexample
6127 int *ptr = @var{something};
6128 volatile int vobj;
6129 *ptr = @var{something};
6130 asm volatile ("" : : : "memory");
6131 vobj = 1;
6132 @end smallexample
6134 A scalar volatile object is read when it is accessed in a void context:
6136 @smallexample
6137 volatile int *src = @var{somevalue};
6138 *src;
6139 @end smallexample
6141 Such expressions are rvalues, and GCC implements this as a
6142 read of the volatile object being pointed to.
6144 Assignments are also expressions and have an rvalue.  However when
6145 assigning to a scalar volatile, the volatile object is not reread,
6146 regardless of whether the assignment expression's rvalue is used or
6147 not.  If the assignment's rvalue is used, the value is that assigned
6148 to the volatile object.  For instance, there is no read of @var{vobj}
6149 in all the following cases:
6151 @smallexample
6152 int obj;
6153 volatile int vobj;
6154 vobj = @var{something};
6155 obj = vobj = @var{something};
6156 obj ? vobj = @var{onething} : vobj = @var{anotherthing};
6157 obj = (@var{something}, vobj = @var{anotherthing});
6158 @end smallexample
6160 If you need to read the volatile object after an assignment has
6161 occurred, you must use a separate expression with an intervening
6162 sequence point.
6164 As bit-fields are not individually addressable, volatile bit-fields may
6165 be implicitly read when written to, or when adjacent bit-fields are
6166 accessed.  Bit-field operations may be optimized such that adjacent
6167 bit-fields are only partially accessed, if they straddle a storage unit
6168 boundary.  For these reasons it is unwise to use volatile bit-fields to
6169 access hardware.
6171 @node Extended Asm
6172 @section Assembler Instructions with C Expression Operands
6173 @cindex extended @code{asm}
6174 @cindex @code{asm} expressions
6175 @cindex assembler instructions
6176 @cindex registers
6178 In an assembler instruction using @code{asm}, you can specify the
6179 operands of the instruction using C expressions.  This means you need not
6180 guess which registers or memory locations contain the data you want
6181 to use.
6183 You must specify an assembler instruction template much like what
6184 appears in a machine description, plus an operand constraint string for
6185 each operand.
6187 For example, here is how to use the 68881's @code{fsinx} instruction:
6189 @smallexample
6190 asm ("fsinx %1,%0" : "=f" (result) : "f" (angle));
6191 @end smallexample
6193 @noindent
6194 Here @code{angle} is the C expression for the input operand while
6195 @code{result} is that of the output operand.  Each has @samp{"f"} as its
6196 operand constraint, saying that a floating-point register is required.
6197 The @samp{=} in @samp{=f} indicates that the operand is an output; all
6198 output operands' constraints must use @samp{=}.  The constraints use the
6199 same language used in the machine description (@pxref{Constraints}).
6201 Each operand is described by an operand-constraint string followed by
6202 the C expression in parentheses.  A colon separates the assembler
6203 template from the first output operand and another separates the last
6204 output operand from the first input, if any.  Commas separate the
6205 operands within each group.  The total number of operands is currently
6206 limited to 30; this limitation may be lifted in some future version of
6207 GCC@.
6209 If there are no output operands but there are input operands, you must
6210 place two consecutive colons surrounding the place where the output
6211 operands would go.
6213 As of GCC version 3.1, it is also possible to specify input and output
6214 operands using symbolic names which can be referenced within the
6215 assembler code.  These names are specified inside square brackets
6216 preceding the constraint string, and can be referenced inside the
6217 assembler code using @code{%[@var{name}]} instead of a percentage sign
6218 followed by the operand number.  Using named operands the above example
6219 could look like:
6221 @smallexample
6222 asm ("fsinx %[angle],%[output]"
6223      : [output] "=f" (result)
6224      : [angle] "f" (angle));
6225 @end smallexample
6227 @noindent
6228 Note that the symbolic operand names have no relation whatsoever to
6229 other C identifiers.  You may use any name you like, even those of
6230 existing C symbols, but you must ensure that no two operands within the same
6231 assembler construct use the same symbolic name.
6233 Output operand expressions must be lvalues; the compiler can check this.
6234 The input operands need not be lvalues.  The compiler cannot check
6235 whether the operands have data types that are reasonable for the
6236 instruction being executed.  It does not parse the assembler instruction
6237 template and does not know what it means or even whether it is valid
6238 assembler input.  The extended @code{asm} feature is most often used for
6239 machine instructions the compiler itself does not know exist.  If
6240 the output expression cannot be directly addressed (for example, it is a
6241 bit-field), your constraint must allow a register.  In that case, GCC
6242 uses the register as the output of the @code{asm}, and then stores
6243 that register into the output.
6245 The ordinary output operands must be write-only; GCC assumes that
6246 the values in these operands before the instruction are dead and need
6247 not be generated.  Extended asm supports input-output or read-write
6248 operands.  Use the constraint character @samp{+} to indicate such an
6249 operand and list it with the output operands.
6251 You may, as an alternative, logically split its function into two
6252 separate operands, one input operand and one write-only output
6253 operand.  The connection between them is expressed by constraints
6254 that say they need to be in the same location when the instruction
6255 executes.  You can use the same C expression for both operands, or
6256 different expressions.  For example, here we write the (fictitious)
6257 @samp{combine} instruction with @code{bar} as its read-only source
6258 operand and @code{foo} as its read-write destination:
6260 @smallexample
6261 asm ("combine %2,%0" : "=r" (foo) : "0" (foo), "g" (bar));
6262 @end smallexample
6264 @noindent
6265 The constraint @samp{"0"} for operand 1 says that it must occupy the
6266 same location as operand 0.  A number in constraint is allowed only in
6267 an input operand and it must refer to an output operand.
6269 Only a number in the constraint can guarantee that one operand is in
6270 the same place as another.  The mere fact that @code{foo} is the value
6271 of both operands is not enough to guarantee that they are in the
6272 same place in the generated assembler code.  The following does not
6273 work reliably:
6275 @smallexample
6276 asm ("combine %2,%0" : "=r" (foo) : "r" (foo), "g" (bar));
6277 @end smallexample
6279 Various optimizations or reloading could cause operands 0 and 1 to be in
6280 different registers; GCC knows no reason not to do so.  For example, the
6281 compiler might find a copy of the value of @code{foo} in one register and
6282 use it for operand 1, but generate the output operand 0 in a different
6283 register (copying it afterward to @code{foo}'s own address).  Of course,
6284 since the register for operand 1 is not even mentioned in the assembler
6285 code, the result will not work, but GCC can't tell that.
6287 As of GCC version 3.1, one may write @code{[@var{name}]} instead of
6288 the operand number for a matching constraint.  For example:
6290 @smallexample
6291 asm ("cmoveq %1,%2,%[result]"
6292      : [result] "=r"(result)
6293      : "r" (test), "r"(new), "[result]"(old));
6294 @end smallexample
6296 Sometimes you need to make an @code{asm} operand be a specific register,
6297 but there's no matching constraint letter for that register @emph{by
6298 itself}.  To force the operand into that register, use a local variable
6299 for the operand and specify the register in the variable declaration.
6300 @xref{Explicit Reg Vars}.  Then for the @code{asm} operand, use any
6301 register constraint letter that matches the register:
6303 @smallexample
6304 register int *p1 asm ("r0") = @dots{};
6305 register int *p2 asm ("r1") = @dots{};
6306 register int *result asm ("r0");
6307 asm ("sysint" : "=r" (result) : "0" (p1), "r" (p2));
6308 @end smallexample
6310 @anchor{Example of asm with clobbered asm reg}
6311 In the above example, beware that a register that is call-clobbered by
6312 the target ABI will be overwritten by any function call in the
6313 assignment, including library calls for arithmetic operators.
6314 Also a register may be clobbered when generating some operations,
6315 like variable shift, memory copy or memory move on x86.
6316 Assuming it is a call-clobbered register, this may happen to @code{r0}
6317 above by the assignment to @code{p2}.  If you have to use such a
6318 register, use temporary variables for expressions between the register
6319 assignment and use:
6321 @smallexample
6322 int t1 = @dots{};
6323 register int *p1 asm ("r0") = @dots{};
6324 register int *p2 asm ("r1") = t1;
6325 register int *result asm ("r0");
6326 asm ("sysint" : "=r" (result) : "0" (p1), "r" (p2));
6327 @end smallexample
6329 Some instructions clobber specific hard registers.  To describe this,
6330 write a third colon after the input operands, followed by the names of
6331 the clobbered hard registers (given as strings).  Here is a realistic
6332 example for the VAX:
6334 @smallexample
6335 asm volatile ("movc3 %0,%1,%2"
6336               : /* @r{no outputs} */
6337               : "g" (from), "g" (to), "g" (count)
6338               : "r0", "r1", "r2", "r3", "r4", "r5");
6339 @end smallexample
6341 You may not write a clobber description in a way that overlaps with an
6342 input or output operand.  For example, you may not have an operand
6343 describing a register class with one member if you mention that register
6344 in the clobber list.  Variables declared to live in specific registers
6345 (@pxref{Explicit Reg Vars}), and used as asm input or output operands must
6346 have no part mentioned in the clobber description.
6347 There is no way for you to specify that an input
6348 operand is modified without also specifying it as an output
6349 operand.  Note that if all the output operands you specify are for this
6350 purpose (and hence unused), you then also need to specify
6351 @code{volatile} for the @code{asm} construct, as described below, to
6352 prevent GCC from deleting the @code{asm} statement as unused.
6354 If you refer to a particular hardware register from the assembler code,
6355 you probably have to list the register after the third colon to
6356 tell the compiler the register's value is modified.  In some assemblers,
6357 the register names begin with @samp{%}; to produce one @samp{%} in the
6358 assembler code, you must write @samp{%%} in the input.
6360 If your assembler instruction can alter the condition code register, add
6361 @samp{cc} to the list of clobbered registers.  GCC on some machines
6362 represents the condition codes as a specific hardware register;
6363 @samp{cc} serves to name this register.  On other machines, the
6364 condition code is handled differently, and specifying @samp{cc} has no
6365 effect.  But it is valid no matter what the machine.
6367 If your assembler instructions access memory in an unpredictable
6368 fashion, add @samp{memory} to the list of clobbered registers.  This
6369 causes GCC to not keep memory values cached in registers across the
6370 assembler instruction and not optimize stores or loads to that memory.
6371 You also should add the @code{volatile} keyword if the memory
6372 affected is not listed in the inputs or outputs of the @code{asm}, as
6373 the @samp{memory} clobber does not count as a side-effect of the
6374 @code{asm}.  If you know how large the accessed memory is, you can add
6375 it as input or output but if this is not known, you should add
6376 @samp{memory}.  As an example, if you access ten bytes of a string, you
6377 can use a memory input like:
6379 @smallexample
6380 @{"m"( (@{ struct @{ char x[10]; @} *p = (void *)ptr ; *p; @}) )@}.
6381 @end smallexample
6383 Note that in the following example the memory input is necessary,
6384 otherwise GCC might optimize the store to @code{x} away:
6385 @smallexample
6386 int foo ()
6388   int x = 42;
6389   int *y = &x;
6390   int result;
6391   asm ("magic stuff accessing an 'int' pointed to by '%1'"
6392        : "=&d" (result) : "a" (y), "m" (*y));
6393   return result;
6395 @end smallexample
6397 You can put multiple assembler instructions together in a single
6398 @code{asm} template, separated by the characters normally used in assembly
6399 code for the system.  A combination that works in most places is a newline
6400 to break the line, plus a tab character to move to the instruction field
6401 (written as @samp{\n\t}).  Sometimes semicolons can be used, if the
6402 assembler allows semicolons as a line-breaking character.  Note that some
6403 assembler dialects use semicolons to start a comment.
6404 The input operands are guaranteed not to use any of the clobbered
6405 registers, and neither do the output operands' addresses, so you can
6406 read and write the clobbered registers as many times as you like.  Here
6407 is an example of multiple instructions in a template; it assumes the
6408 subroutine @code{_foo} accepts arguments in registers 9 and 10:
6410 @smallexample
6411 asm ("movl %0,r9\n\tmovl %1,r10\n\tcall _foo"
6412      : /* no outputs */
6413      : "g" (from), "g" (to)
6414      : "r9", "r10");
6415 @end smallexample
6417 Unless an output operand has the @samp{&} constraint modifier, GCC
6418 may allocate it in the same register as an unrelated input operand, on
6419 the assumption the inputs are consumed before the outputs are produced.
6420 This assumption may be false if the assembler code actually consists of
6421 more than one instruction.  In such a case, use @samp{&} for each output
6422 operand that may not overlap an input.  @xref{Modifiers}.
6424 If you want to test the condition code produced by an assembler
6425 instruction, you must include a branch and a label in the @code{asm}
6426 construct, as follows:
6428 @smallexample
6429 asm ("clr %0\n\tfrob %1\n\tbeq 0f\n\tmov #1,%0\n0:"
6430      : "g" (result)
6431      : "g" (input));
6432 @end smallexample
6434 @noindent
6435 This assumes your assembler supports local labels, as the GNU assembler
6436 and most Unix assemblers do.
6438 Speaking of labels, jumps from one @code{asm} to another are not
6439 supported.  The compiler's optimizers do not know about these jumps, and
6440 therefore they cannot take account of them when deciding how to
6441 optimize.  @xref{Extended asm with goto}.
6443 @cindex macros containing @code{asm}
6444 Usually the most convenient way to use these @code{asm} instructions is to
6445 encapsulate them in macros that look like functions.  For example,
6447 @smallexample
6448 #define sin(x)       \
6449 (@{ double __value, __arg = (x);   \
6450    asm ("fsinx %1,%0": "=f" (__value): "f" (__arg));  \
6451    __value; @})
6452 @end smallexample
6454 @noindent
6455 Here the variable @code{__arg} is used to make sure that the instruction
6456 operates on a proper @code{double} value, and to accept only those
6457 arguments @code{x} that can convert automatically to a @code{double}.
6459 Another way to make sure the instruction operates on the correct data
6460 type is to use a cast in the @code{asm}.  This is different from using a
6461 variable @code{__arg} in that it converts more different types.  For
6462 example, if the desired type is @code{int}, casting the argument to
6463 @code{int} accepts a pointer with no complaint, while assigning the
6464 argument to an @code{int} variable named @code{__arg} warns about
6465 using a pointer unless the caller explicitly casts it.
6467 If an @code{asm} has output operands, GCC assumes for optimization
6468 purposes the instruction has no side effects except to change the output
6469 operands.  This does not mean instructions with a side effect cannot be
6470 used, but you must be careful, because the compiler may eliminate them
6471 if the output operands aren't used, or move them out of loops, or
6472 replace two with one if they constitute a common subexpression.  Also,
6473 if your instruction does have a side effect on a variable that otherwise
6474 appears not to change, the old value of the variable may be reused later
6475 if it happens to be found in a register.
6477 You can prevent an @code{asm} instruction from being deleted
6478 by writing the keyword @code{volatile} after
6479 the @code{asm}.  For example:
6481 @smallexample
6482 #define get_and_set_priority(new)              \
6483 (@{ int __old;                                  \
6484    asm volatile ("get_and_set_priority %0, %1" \
6485                  : "=g" (__old) : "g" (new));  \
6486    __old; @})
6487 @end smallexample
6489 @noindent
6490 The @code{volatile} keyword indicates that the instruction has
6491 important side-effects.  GCC does not delete a volatile @code{asm} if
6492 it is reachable.  (The instruction can still be deleted if GCC can
6493 prove that control flow never reaches the location of the
6494 instruction.)  Note that even a volatile @code{asm} instruction
6495 can be moved relative to other code, including across jump
6496 instructions.  For example, on many targets there is a system
6497 register that can be set to control the rounding mode of
6498 floating-point operations.  You might try
6499 setting it with a volatile @code{asm}, like this PowerPC example:
6501 @smallexample
6502        asm volatile("mtfsf 255,%0" : : "f" (fpenv));
6503        sum = x + y;
6504 @end smallexample
6506 @noindent
6507 This does not work reliably, as the compiler may move the addition back
6508 before the volatile @code{asm}.  To make it work you need to add an
6509 artificial dependency to the @code{asm} referencing a variable in the code
6510 you don't want moved, for example:
6512 @smallexample
6513     asm volatile ("mtfsf 255,%1" : "=X"(sum): "f"(fpenv));
6514     sum = x + y;
6515 @end smallexample
6517 Similarly, you can't expect a
6518 sequence of volatile @code{asm} instructions to remain perfectly
6519 consecutive.  If you want consecutive output, use a single @code{asm}.
6520 Also, GCC performs some optimizations across a volatile @code{asm}
6521 instruction; GCC does not ``forget everything'' when it encounters
6522 a volatile @code{asm} instruction the way some other compilers do.
6524 An @code{asm} instruction without any output operands is treated
6525 identically to a volatile @code{asm} instruction.
6527 It is a natural idea to look for a way to give access to the condition
6528 code left by the assembler instruction.  However, when we attempted to
6529 implement this, we found no way to make it work reliably.  The problem
6530 is that output operands might need reloading, which result in
6531 additional following ``store'' instructions.  On most machines, these
6532 instructions alter the condition code before there is time to
6533 test it.  This problem doesn't arise for ordinary ``test'' and
6534 ``compare'' instructions because they don't have any output operands.
6536 For reasons similar to those described above, it is not possible to give
6537 an assembler instruction access to the condition code left by previous
6538 instructions.
6540 @anchor{Extended asm with goto}
6541 As of GCC version 4.5, @code{asm goto} may be used to have the assembly
6542 jump to one or more C labels.  In this form, a fifth section after the
6543 clobber list contains a list of all C labels to which the assembly may jump.
6544 Each label operand is implicitly self-named.  The @code{asm} is also assumed
6545 to fall through to the next statement.
6547 This form of @code{asm} is restricted to not have outputs.  This is due
6548 to a internal restriction in the compiler that control transfer instructions
6549 cannot have outputs.  This restriction on @code{asm goto} may be lifted
6550 in some future version of the compiler.  In the meantime, @code{asm goto}
6551 may include a memory clobber, and so leave outputs in memory.
6553 @smallexample
6554 int frob(int x)
6556   int y;
6557   asm goto ("frob %%r5, %1; jc %l[error]; mov (%2), %%r5"
6558             : : "r"(x), "r"(&y) : "r5", "memory" : error);
6559   return y;
6560  error:
6561   return -1;
6563 @end smallexample
6565 @noindent
6566 In this (inefficient) example, the @code{frob} instruction sets the
6567 carry bit to indicate an error.  The @code{jc} instruction detects
6568 this and branches to the @code{error} label.  Finally, the output
6569 of the @code{frob} instruction (@code{%r5}) is stored into the memory
6570 for variable @code{y}, which is later read by the @code{return} statement.
6572 @smallexample
6573 void doit(void)
6575   int i = 0;
6576   asm goto ("mfsr %%r1, 123; jmp %%r1;"
6577             ".pushsection doit_table;"
6578             ".long %l0, %l1, %l2, %l3;"
6579             ".popsection"
6580             : : : "r1" : label1, label2, label3, label4);
6581   __builtin_unreachable ();
6583  label1:
6584   f1();
6585   return;
6586  label2:
6587   f2();
6588   return;
6589  label3:
6590   i = 1;
6591  label4:
6592   f3(i);
6594 @end smallexample
6596 @noindent
6597 In this (also inefficient) example, the @code{mfsr} instruction reads
6598 an address from some out-of-band machine register, and the following
6599 @code{jmp} instruction branches to that address.  The address read by
6600 the @code{mfsr} instruction is assumed to have been previously set via
6601 some application-specific mechanism to be one of the four values stored
6602 in the @code{doit_table} section.  Finally, the @code{asm} is followed
6603 by a call to @code{__builtin_unreachable} to indicate that the @code{asm}
6604 does not in fact fall through.
6606 @smallexample
6607 #define TRACE1(NUM)                         \
6608   do @{                                      \
6609     asm goto ("0: nop;"                     \
6610               ".pushsection trace_table;"   \
6611               ".long 0b, %l0;"              \
6612               ".popsection"                 \
6613               : : : : trace#NUM);           \
6614     if (0) @{ trace#NUM: trace(); @}          \
6615   @} while (0)
6616 #define TRACE  TRACE1(__COUNTER__)
6617 @end smallexample
6619 @noindent
6620 In this example (which in fact inspired the @code{asm goto} feature)
6621 we want on rare occasions to call the @code{trace} function; on other
6622 occasions we'd like to keep the overhead to the absolute minimum.
6623 The normal code path consists of a single @code{nop} instruction.
6624 However, we record the address of this @code{nop} together with the
6625 address of a label that calls the @code{trace} function.  This allows
6626 the @code{nop} instruction to be patched at run time to be an
6627 unconditional branch to the stored label.  It is assumed that an
6628 optimizing compiler moves the labeled block out of line, to
6629 optimize the fall through path from the @code{asm}.
6631 If you are writing a header file that should be includable in ISO C
6632 programs, write @code{__asm__} instead of @code{asm}.  @xref{Alternate
6633 Keywords}.
6635 @subsection Size of an @code{asm}
6637 Some targets require that GCC track the size of each instruction used in
6638 order to generate correct code.  Because the final length of an
6639 @code{asm} is only known by the assembler, GCC must make an estimate as
6640 to how big it will be.  The estimate is formed by counting the number of
6641 statements in the pattern of the @code{asm} and multiplying that by the
6642 length of the longest instruction on that processor.  Statements in the
6643 @code{asm} are identified by newline characters and whatever statement
6644 separator characters are supported by the assembler; on most processors
6645 this is the @samp{;} character.
6647 Normally, GCC's estimate is perfectly adequate to ensure that correct
6648 code is generated, but it is possible to confuse the compiler if you use
6649 pseudo instructions or assembler macros that expand into multiple real
6650 instructions or if you use assembler directives that expand to more
6651 space in the object file than is needed for a single instruction.
6652 If this happens then the assembler produces a diagnostic saying that
6653 a label is unreachable.
6655 @subsection i386 floating-point asm operands
6657 On i386 targets, there are several rules on the usage of stack-like registers
6658 in the operands of an @code{asm}.  These rules apply only to the operands
6659 that are stack-like registers:
6661 @enumerate
6662 @item
6663 Given a set of input registers that die in an @code{asm}, it is
6664 necessary to know which are implicitly popped by the @code{asm}, and
6665 which must be explicitly popped by GCC@.
6667 An input register that is implicitly popped by the @code{asm} must be
6668 explicitly clobbered, unless it is constrained to match an
6669 output operand.
6671 @item
6672 For any input register that is implicitly popped by an @code{asm}, it is
6673 necessary to know how to adjust the stack to compensate for the pop.
6674 If any non-popped input is closer to the top of the reg-stack than
6675 the implicitly popped register, it would not be possible to know what the
6676 stack looked like---it's not clear how the rest of the stack ``slides
6677 up''.
6679 All implicitly popped input registers must be closer to the top of
6680 the reg-stack than any input that is not implicitly popped.
6682 It is possible that if an input dies in an @code{asm}, the compiler might
6683 use the input register for an output reload.  Consider this example:
6685 @smallexample
6686 asm ("foo" : "=t" (a) : "f" (b));
6687 @end smallexample
6689 @noindent
6690 This code says that input @code{b} is not popped by the @code{asm}, and that
6691 the @code{asm} pushes a result onto the reg-stack, i.e., the stack is one
6692 deeper after the @code{asm} than it was before.  But, it is possible that
6693 reload may think that it can use the same register for both the input and
6694 the output.
6696 To prevent this from happening,
6697 if any input operand uses the @code{f} constraint, all output register
6698 constraints must use the @code{&} early-clobber modifier.
6700 The example above would be correctly written as:
6702 @smallexample
6703 asm ("foo" : "=&t" (a) : "f" (b));
6704 @end smallexample
6706 @item
6707 Some operands need to be in particular places on the stack.  All
6708 output operands fall in this category---GCC has no other way to
6709 know which registers the outputs appear in unless you indicate
6710 this in the constraints.
6712 Output operands must specifically indicate which register an output
6713 appears in after an @code{asm}.  @code{=f} is not allowed: the operand
6714 constraints must select a class with a single register.
6716 @item
6717 Output operands may not be ``inserted'' between existing stack registers.
6718 Since no 387 opcode uses a read/write operand, all output operands
6719 are dead before the @code{asm}, and are pushed by the @code{asm}.
6720 It makes no sense to push anywhere but the top of the reg-stack.
6722 Output operands must start at the top of the reg-stack: output
6723 operands may not ``skip'' a register.
6725 @item
6726 Some @code{asm} statements may need extra stack space for internal
6727 calculations.  This can be guaranteed by clobbering stack registers
6728 unrelated to the inputs and outputs.
6730 @end enumerate
6732 Here are a couple of reasonable @code{asm}s to want to write.  This
6733 @code{asm}
6734 takes one input, which is internally popped, and produces two outputs.
6736 @smallexample
6737 asm ("fsincos" : "=t" (cos), "=u" (sin) : "0" (inp));
6738 @end smallexample
6740 @noindent
6741 This @code{asm} takes two inputs, which are popped by the @code{fyl2xp1} opcode,
6742 and replaces them with one output.  The @code{st(1)} clobber is necessary 
6743 for the compiler to know that @code{fyl2xp1} pops both inputs.
6745 @smallexample
6746 asm ("fyl2xp1" : "=t" (result) : "0" (x), "u" (y) : "st(1)");
6747 @end smallexample
6749 @include md.texi
6751 @node Asm Labels
6752 @section Controlling Names Used in Assembler Code
6753 @cindex assembler names for identifiers
6754 @cindex names used in assembler code
6755 @cindex identifiers, names in assembler code
6757 You can specify the name to be used in the assembler code for a C
6758 function or variable by writing the @code{asm} (or @code{__asm__})
6759 keyword after the declarator as follows:
6761 @smallexample
6762 int foo asm ("myfoo") = 2;
6763 @end smallexample
6765 @noindent
6766 This specifies that the name to be used for the variable @code{foo} in
6767 the assembler code should be @samp{myfoo} rather than the usual
6768 @samp{_foo}.
6770 On systems where an underscore is normally prepended to the name of a C
6771 function or variable, this feature allows you to define names for the
6772 linker that do not start with an underscore.
6774 It does not make sense to use this feature with a non-static local
6775 variable since such variables do not have assembler names.  If you are
6776 trying to put the variable in a particular register, see @ref{Explicit
6777 Reg Vars}.  GCC presently accepts such code with a warning, but will
6778 probably be changed to issue an error, rather than a warning, in the
6779 future.
6781 You cannot use @code{asm} in this way in a function @emph{definition}; but
6782 you can get the same effect by writing a declaration for the function
6783 before its definition and putting @code{asm} there, like this:
6785 @smallexample
6786 extern func () asm ("FUNC");
6788 func (x, y)
6789      int x, y;
6790 /* @r{@dots{}} */
6791 @end smallexample
6793 It is up to you to make sure that the assembler names you choose do not
6794 conflict with any other assembler symbols.  Also, you must not use a
6795 register name; that would produce completely invalid assembler code.  GCC
6796 does not as yet have the ability to store static variables in registers.
6797 Perhaps that will be added.
6799 @node Explicit Reg Vars
6800 @section Variables in Specified Registers
6801 @cindex explicit register variables
6802 @cindex variables in specified registers
6803 @cindex specified registers
6804 @cindex registers, global allocation
6806 GNU C allows you to put a few global variables into specified hardware
6807 registers.  You can also specify the register in which an ordinary
6808 register variable should be allocated.
6810 @itemize @bullet
6811 @item
6812 Global register variables reserve registers throughout the program.
6813 This may be useful in programs such as programming language
6814 interpreters that have a couple of global variables that are accessed
6815 very often.
6817 @item
6818 Local register variables in specific registers do not reserve the
6819 registers, except at the point where they are used as input or output
6820 operands in an @code{asm} statement and the @code{asm} statement itself is
6821 not deleted.  The compiler's data flow analysis is capable of determining
6822 where the specified registers contain live values, and where they are
6823 available for other uses.  Stores into local register variables may be deleted
6824 when they appear to be dead according to dataflow analysis.  References
6825 to local register variables may be deleted or moved or simplified.
6827 These local variables are sometimes convenient for use with the extended
6828 @code{asm} feature (@pxref{Extended Asm}), if you want to write one
6829 output of the assembler instruction directly into a particular register.
6830 (This works provided the register you specify fits the constraints
6831 specified for that operand in the @code{asm}.)
6832 @end itemize
6834 @menu
6835 * Global Reg Vars::
6836 * Local Reg Vars::
6837 @end menu
6839 @node Global Reg Vars
6840 @subsection Defining Global Register Variables
6841 @cindex global register variables
6842 @cindex registers, global variables in
6844 You can define a global register variable in GNU C like this:
6846 @smallexample
6847 register int *foo asm ("a5");
6848 @end smallexample
6850 @noindent
6851 Here @code{a5} is the name of the register that should be used.  Choose a
6852 register that is normally saved and restored by function calls on your
6853 machine, so that library routines will not clobber it.
6855 Naturally the register name is cpu-dependent, so you need to
6856 conditionalize your program according to cpu type.  The register
6857 @code{a5} is a good choice on a 68000 for a variable of pointer
6858 type.  On machines with register windows, be sure to choose a ``global''
6859 register that is not affected magically by the function call mechanism.
6861 In addition, different operating systems on the same CPU may differ in how they
6862 name the registers; then you need additional conditionals.  For
6863 example, some 68000 operating systems call this register @code{%a5}.
6865 Eventually there may be a way of asking the compiler to choose a register
6866 automatically, but first we need to figure out how it should choose and
6867 how to enable you to guide the choice.  No solution is evident.
6869 Defining a global register variable in a certain register reserves that
6870 register entirely for this use, at least within the current compilation.
6871 The register is not allocated for any other purpose in the functions
6872 in the current compilation, and is not saved and restored by
6873 these functions.  Stores into this register are never deleted even if they
6874 appear to be dead, but references may be deleted or moved or
6875 simplified.
6877 It is not safe to access the global register variables from signal
6878 handlers, or from more than one thread of control, because the system
6879 library routines may temporarily use the register for other things (unless
6880 you recompile them specially for the task at hand).
6882 @cindex @code{qsort}, and global register variables
6883 It is not safe for one function that uses a global register variable to
6884 call another such function @code{foo} by way of a third function
6885 @code{lose} that is compiled without knowledge of this variable (i.e.@: in a
6886 different source file in which the variable isn't declared).  This is
6887 because @code{lose} might save the register and put some other value there.
6888 For example, you can't expect a global register variable to be available in
6889 the comparison-function that you pass to @code{qsort}, since @code{qsort}
6890 might have put something else in that register.  (If you are prepared to
6891 recompile @code{qsort} with the same global register variable, you can
6892 solve this problem.)
6894 If you want to recompile @code{qsort} or other source files that do not
6895 actually use your global register variable, so that they do not use that
6896 register for any other purpose, then it suffices to specify the compiler
6897 option @option{-ffixed-@var{reg}}.  You need not actually add a global
6898 register declaration to their source code.
6900 A function that can alter the value of a global register variable cannot
6901 safely be called from a function compiled without this variable, because it
6902 could clobber the value the caller expects to find there on return.
6903 Therefore, the function that is the entry point into the part of the
6904 program that uses the global register variable must explicitly save and
6905 restore the value that belongs to its caller.
6907 @cindex register variable after @code{longjmp}
6908 @cindex global register after @code{longjmp}
6909 @cindex value after @code{longjmp}
6910 @findex longjmp
6911 @findex setjmp
6912 On most machines, @code{longjmp} restores to each global register
6913 variable the value it had at the time of the @code{setjmp}.  On some
6914 machines, however, @code{longjmp} does not change the value of global
6915 register variables.  To be portable, the function that called @code{setjmp}
6916 should make other arrangements to save the values of the global register
6917 variables, and to restore them in a @code{longjmp}.  This way, the same
6918 thing happens regardless of what @code{longjmp} does.
6920 All global register variable declarations must precede all function
6921 definitions.  If such a declaration could appear after function
6922 definitions, the declaration would be too late to prevent the register from
6923 being used for other purposes in the preceding functions.
6925 Global register variables may not have initial values, because an
6926 executable file has no means to supply initial contents for a register.
6928 On the SPARC, there are reports that g3 @dots{} g7 are suitable
6929 registers, but certain library functions, such as @code{getwd}, as well
6930 as the subroutines for division and remainder, modify g3 and g4.  g1 and
6931 g2 are local temporaries.
6933 On the 68000, a2 @dots{} a5 should be suitable, as should d2 @dots{} d7.
6934 Of course, it does not do to use more than a few of those.
6936 @node Local Reg Vars
6937 @subsection Specifying Registers for Local Variables
6938 @cindex local variables, specifying registers
6939 @cindex specifying registers for local variables
6940 @cindex registers for local variables
6942 You can define a local register variable with a specified register
6943 like this:
6945 @smallexample
6946 register int *foo asm ("a5");
6947 @end smallexample
6949 @noindent
6950 Here @code{a5} is the name of the register that should be used.  Note
6951 that this is the same syntax used for defining global register
6952 variables, but for a local variable it appears within a function.
6954 Naturally the register name is cpu-dependent, but this is not a
6955 problem, since specific registers are most often useful with explicit
6956 assembler instructions (@pxref{Extended Asm}).  Both of these things
6957 generally require that you conditionalize your program according to
6958 cpu type.
6960 In addition, operating systems on one type of cpu may differ in how they
6961 name the registers; then you need additional conditionals.  For
6962 example, some 68000 operating systems call this register @code{%a5}.
6964 Defining such a register variable does not reserve the register; it
6965 remains available for other uses in places where flow control determines
6966 the variable's value is not live.
6968 This option does not guarantee that GCC generates code that has
6969 this variable in the register you specify at all times.  You may not
6970 code an explicit reference to this register in the @emph{assembler
6971 instruction template} part of an @code{asm} statement and assume it
6972 always refers to this variable.  However, using the variable as an
6973 @code{asm} @emph{operand} guarantees that the specified register is used
6974 for the operand.
6976 Stores into local register variables may be deleted when they appear to be dead
6977 according to dataflow analysis.  References to local register variables may
6978 be deleted or moved or simplified.
6980 As for global register variables, it's recommended that you choose a
6981 register that is normally saved and restored by function calls on
6982 your machine, so that library routines will not clobber it.  A common
6983 pitfall is to initialize multiple call-clobbered registers with
6984 arbitrary expressions, where a function call or library call for an
6985 arithmetic operator overwrites a register value from a previous
6986 assignment, for example @code{r0} below:
6987 @smallexample
6988 register int *p1 asm ("r0") = @dots{};
6989 register int *p2 asm ("r1") = @dots{};
6990 @end smallexample
6992 @noindent
6993 In those cases, a solution is to use a temporary variable for
6994 each arbitrary expression.   @xref{Example of asm with clobbered asm reg}.
6996 @node Alternate Keywords
6997 @section Alternate Keywords
6998 @cindex alternate keywords
6999 @cindex keywords, alternate
7001 @option{-ansi} and the various @option{-std} options disable certain
7002 keywords.  This causes trouble when you want to use GNU C extensions, or
7003 a general-purpose header file that should be usable by all programs,
7004 including ISO C programs.  The keywords @code{asm}, @code{typeof} and
7005 @code{inline} are not available in programs compiled with
7006 @option{-ansi} or @option{-std} (although @code{inline} can be used in a
7007 program compiled with @option{-std=c99} or @option{-std=c11}).  The
7008 ISO C99 keyword
7009 @code{restrict} is only available when @option{-std=gnu99} (which will
7010 eventually be the default) or @option{-std=c99} (or the equivalent
7011 @option{-std=iso9899:1999}), or an option for a later standard
7012 version, is used.
7014 The way to solve these problems is to put @samp{__} at the beginning and
7015 end of each problematical keyword.  For example, use @code{__asm__}
7016 instead of @code{asm}, and @code{__inline__} instead of @code{inline}.
7018 Other C compilers won't accept these alternative keywords; if you want to
7019 compile with another compiler, you can define the alternate keywords as
7020 macros to replace them with the customary keywords.  It looks like this:
7022 @smallexample
7023 #ifndef __GNUC__
7024 #define __asm__ asm
7025 #endif
7026 @end smallexample
7028 @findex __extension__
7029 @opindex pedantic
7030 @option{-pedantic} and other options cause warnings for many GNU C extensions.
7031 You can
7032 prevent such warnings within one expression by writing
7033 @code{__extension__} before the expression.  @code{__extension__} has no
7034 effect aside from this.
7036 @node Incomplete Enums
7037 @section Incomplete @code{enum} Types
7039 You can define an @code{enum} tag without specifying its possible values.
7040 This results in an incomplete type, much like what you get if you write
7041 @code{struct foo} without describing the elements.  A later declaration
7042 that does specify the possible values completes the type.
7044 You can't allocate variables or storage using the type while it is
7045 incomplete.  However, you can work with pointers to that type.
7047 This extension may not be very useful, but it makes the handling of
7048 @code{enum} more consistent with the way @code{struct} and @code{union}
7049 are handled.
7051 This extension is not supported by GNU C++.
7053 @node Function Names
7054 @section Function Names as Strings
7055 @cindex @code{__func__} identifier
7056 @cindex @code{__FUNCTION__} identifier
7057 @cindex @code{__PRETTY_FUNCTION__} identifier
7059 GCC provides three magic variables that hold the name of the current
7060 function, as a string.  The first of these is @code{__func__}, which
7061 is part of the C99 standard:
7063 The identifier @code{__func__} is implicitly declared by the translator
7064 as if, immediately following the opening brace of each function
7065 definition, the declaration
7067 @smallexample
7068 static const char __func__[] = "function-name";
7069 @end smallexample
7071 @noindent
7072 appeared, where function-name is the name of the lexically-enclosing
7073 function.  This name is the unadorned name of the function.
7075 @code{__FUNCTION__} is another name for @code{__func__}.  Older
7076 versions of GCC recognize only this name.  However, it is not
7077 standardized.  For maximum portability, we recommend you use
7078 @code{__func__}, but provide a fallback definition with the
7079 preprocessor:
7081 @smallexample
7082 #if __STDC_VERSION__ < 199901L
7083 # if __GNUC__ >= 2
7084 #  define __func__ __FUNCTION__
7085 # else
7086 #  define __func__ "<unknown>"
7087 # endif
7088 #endif
7089 @end smallexample
7091 In C, @code{__PRETTY_FUNCTION__} is yet another name for
7092 @code{__func__}.  However, in C++, @code{__PRETTY_FUNCTION__} contains
7093 the type signature of the function as well as its bare name.  For
7094 example, this program:
7096 @smallexample
7097 extern "C" @{
7098 extern int printf (char *, ...);
7101 class a @{
7102  public:
7103   void sub (int i)
7104     @{
7105       printf ("__FUNCTION__ = %s\n", __FUNCTION__);
7106       printf ("__PRETTY_FUNCTION__ = %s\n", __PRETTY_FUNCTION__);
7107     @}
7111 main (void)
7113   a ax;
7114   ax.sub (0);
7115   return 0;
7117 @end smallexample
7119 @noindent
7120 gives this output:
7122 @smallexample
7123 __FUNCTION__ = sub
7124 __PRETTY_FUNCTION__ = void a::sub(int)
7125 @end smallexample
7127 These identifiers are not preprocessor macros.  In GCC 3.3 and
7128 earlier, in C only, @code{__FUNCTION__} and @code{__PRETTY_FUNCTION__}
7129 were treated as string literals; they could be used to initialize
7130 @code{char} arrays, and they could be concatenated with other string
7131 literals.  GCC 3.4 and later treat them as variables, like
7132 @code{__func__}.  In C++, @code{__FUNCTION__} and
7133 @code{__PRETTY_FUNCTION__} have always been variables.
7135 @node Return Address
7136 @section Getting the Return or Frame Address of a Function
7138 These functions may be used to get information about the callers of a
7139 function.
7141 @deftypefn {Built-in Function} {void *} __builtin_return_address (unsigned int @var{level})
7142 This function returns the return address of the current function, or of
7143 one of its callers.  The @var{level} argument is number of frames to
7144 scan up the call stack.  A value of @code{0} yields the return address
7145 of the current function, a value of @code{1} yields the return address
7146 of the caller of the current function, and so forth.  When inlining
7147 the expected behavior is that the function returns the address of
7148 the function that is returned to.  To work around this behavior use
7149 the @code{noinline} function attribute.
7151 The @var{level} argument must be a constant integer.
7153 On some machines it may be impossible to determine the return address of
7154 any function other than the current one; in such cases, or when the top
7155 of the stack has been reached, this function returns @code{0} or a
7156 random value.  In addition, @code{__builtin_frame_address} may be used
7157 to determine if the top of the stack has been reached.
7159 Additional post-processing of the returned value may be needed, see
7160 @code{__builtin_extract_return_addr}.
7162 This function should only be used with a nonzero argument for debugging
7163 purposes.
7164 @end deftypefn
7166 @deftypefn {Built-in Function} {void *} __builtin_extract_return_addr (void *@var{addr})
7167 The address as returned by @code{__builtin_return_address} may have to be fed
7168 through this function to get the actual encoded address.  For example, on the
7169 31-bit S/390 platform the highest bit has to be masked out, or on SPARC
7170 platforms an offset has to be added for the true next instruction to be
7171 executed.
7173 If no fixup is needed, this function simply passes through @var{addr}.
7174 @end deftypefn
7176 @deftypefn {Built-in Function} {void *} __builtin_frob_return_address (void *@var{addr})
7177 This function does the reverse of @code{__builtin_extract_return_addr}.
7178 @end deftypefn
7180 @deftypefn {Built-in Function} {void *} __builtin_frame_address (unsigned int @var{level})
7181 This function is similar to @code{__builtin_return_address}, but it
7182 returns the address of the function frame rather than the return address
7183 of the function.  Calling @code{__builtin_frame_address} with a value of
7184 @code{0} yields the frame address of the current function, a value of
7185 @code{1} yields the frame address of the caller of the current function,
7186 and so forth.
7188 The frame is the area on the stack that holds local variables and saved
7189 registers.  The frame address is normally the address of the first word
7190 pushed on to the stack by the function.  However, the exact definition
7191 depends upon the processor and the calling convention.  If the processor
7192 has a dedicated frame pointer register, and the function has a frame,
7193 then @code{__builtin_frame_address} returns the value of the frame
7194 pointer register.
7196 On some machines it may be impossible to determine the frame address of
7197 any function other than the current one; in such cases, or when the top
7198 of the stack has been reached, this function returns @code{0} if
7199 the first frame pointer is properly initialized by the startup code.
7201 This function should only be used with a nonzero argument for debugging
7202 purposes.
7203 @end deftypefn
7205 @node Vector Extensions
7206 @section Using Vector Instructions through Built-in Functions
7208 On some targets, the instruction set contains SIMD vector instructions which
7209 operate on multiple values contained in one large register at the same time.
7210 For example, on the i386 the MMX, 3DNow!@: and SSE extensions can be used
7211 this way.
7213 The first step in using these extensions is to provide the necessary data
7214 types.  This should be done using an appropriate @code{typedef}:
7216 @smallexample
7217 typedef int v4si __attribute__ ((vector_size (16)));
7218 @end smallexample
7220 @noindent
7221 The @code{int} type specifies the base type, while the attribute specifies
7222 the vector size for the variable, measured in bytes.  For example, the
7223 declaration above causes the compiler to set the mode for the @code{v4si}
7224 type to be 16 bytes wide and divided into @code{int} sized units.  For
7225 a 32-bit @code{int} this means a vector of 4 units of 4 bytes, and the
7226 corresponding mode of @code{foo} is @acronym{V4SI}.
7228 The @code{vector_size} attribute is only applicable to integral and
7229 float scalars, although arrays, pointers, and function return values
7230 are allowed in conjunction with this construct. Only sizes that are
7231 a power of two are currently allowed.
7233 All the basic integer types can be used as base types, both as signed
7234 and as unsigned: @code{char}, @code{short}, @code{int}, @code{long},
7235 @code{long long}.  In addition, @code{float} and @code{double} can be
7236 used to build floating-point vector types.
7238 Specifying a combination that is not valid for the current architecture
7239 causes GCC to synthesize the instructions using a narrower mode.
7240 For example, if you specify a variable of type @code{V4SI} and your
7241 architecture does not allow for this specific SIMD type, GCC
7242 produces code that uses 4 @code{SIs}.
7244 The types defined in this manner can be used with a subset of normal C
7245 operations.  Currently, GCC allows using the following operators
7246 on these types: @code{+, -, *, /, unary minus, ^, |, &, ~, %}@.
7248 The operations behave like C++ @code{valarrays}.  Addition is defined as
7249 the addition of the corresponding elements of the operands.  For
7250 example, in the code below, each of the 4 elements in @var{a} is
7251 added to the corresponding 4 elements in @var{b} and the resulting
7252 vector is stored in @var{c}.
7254 @smallexample
7255 typedef int v4si __attribute__ ((vector_size (16)));
7257 v4si a, b, c;
7259 c = a + b;
7260 @end smallexample
7262 Subtraction, multiplication, division, and the logical operations
7263 operate in a similar manner.  Likewise, the result of using the unary
7264 minus or complement operators on a vector type is a vector whose
7265 elements are the negative or complemented values of the corresponding
7266 elements in the operand.
7268 It is possible to use shifting operators @code{<<}, @code{>>} on
7269 integer-type vectors. The operation is defined as following: @code{@{a0,
7270 a1, @dots{}, an@} >> @{b0, b1, @dots{}, bn@} == @{a0 >> b0, a1 >> b1,
7271 @dots{}, an >> bn@}}@. Vector operands must have the same number of
7272 elements. 
7274 For convenience, it is allowed to use a binary vector operation
7275 where one operand is a scalar. In that case the compiler transforms
7276 the scalar operand into a vector where each element is the scalar from
7277 the operation. The transformation happens only if the scalar could be
7278 safely converted to the vector-element type.
7279 Consider the following code.
7281 @smallexample
7282 typedef int v4si __attribute__ ((vector_size (16)));
7284 v4si a, b, c;
7285 long l;
7287 a = b + 1;    /* a = b + @{1,1,1,1@}; */
7288 a = 2 * b;    /* a = @{2,2,2,2@} * b; */
7290 a = l + a;    /* Error, cannot convert long to int. */
7291 @end smallexample
7293 Vectors can be subscripted as if the vector were an array with
7294 the same number of elements and base type.  Out of bound accesses
7295 invoke undefined behavior at run time.  Warnings for out of bound
7296 accesses for vector subscription can be enabled with
7297 @option{-Warray-bounds}.
7299 Vector comparison is supported with standard comparison
7300 operators: @code{==, !=, <, <=, >, >=}. Comparison operands can be
7301 vector expressions of integer-type or real-type. Comparison between
7302 integer-type vectors and real-type vectors are not supported.  The
7303 result of the comparison is a vector of the same width and number of
7304 elements as the comparison operands with a signed integral element
7305 type.
7307 Vectors are compared element-wise producing 0 when comparison is false
7308 and -1 (constant of the appropriate type where all bits are set)
7309 otherwise. Consider the following example.
7311 @smallexample
7312 typedef int v4si __attribute__ ((vector_size (16)));
7314 v4si a = @{1,2,3,4@};
7315 v4si b = @{3,2,1,4@};
7316 v4si c;
7318 c = a >  b;     /* The result would be @{0, 0,-1, 0@}  */
7319 c = a == b;     /* The result would be @{0,-1, 0,-1@}  */
7320 @end smallexample
7322 In C++, the ternary operator @code{?:} is available. @code{a?b:c}, where
7323 @code{b} and @code{c} are vectors of the same type and @code{a} is an
7324 integer vector with the same number of elements of the same size as @code{b}
7325 and @code{c}, computes all three arguments and creates a vector
7326 @code{@{a[0]?b[0]:c[0], a[1]?b[1]:c[1], @dots{}@}}.  Note that unlike in
7327 OpenCL, @code{a} is thus interpreted as @code{a != 0} and not @code{a < 0}.
7328 As in the case of binary operations, this syntax is also accepted when
7329 one of @code{b} or @code{c} is a scalar that is then transformed into a
7330 vector. If both @code{b} and @code{c} are scalars and the type of
7331 @code{true?b:c} has the same size as the element type of @code{a}, then
7332 @code{b} and @code{c} are converted to a vector type whose elements have
7333 this type and with the same number of elements as @code{a}.
7335 Vector shuffling is available using functions
7336 @code{__builtin_shuffle (vec, mask)} and
7337 @code{__builtin_shuffle (vec0, vec1, mask)}.
7338 Both functions construct a permutation of elements from one or two
7339 vectors and return a vector of the same type as the input vector(s).
7340 The @var{mask} is an integral vector with the same width (@var{W})
7341 and element count (@var{N}) as the output vector.
7343 The elements of the input vectors are numbered in memory ordering of
7344 @var{vec0} beginning at 0 and @var{vec1} beginning at @var{N}.  The
7345 elements of @var{mask} are considered modulo @var{N} in the single-operand
7346 case and modulo @math{2*@var{N}} in the two-operand case.
7348 Consider the following example,
7350 @smallexample
7351 typedef int v4si __attribute__ ((vector_size (16)));
7353 v4si a = @{1,2,3,4@};
7354 v4si b = @{5,6,7,8@};
7355 v4si mask1 = @{0,1,1,3@};
7356 v4si mask2 = @{0,4,2,5@};
7357 v4si res;
7359 res = __builtin_shuffle (a, mask1);       /* res is @{1,2,2,4@}  */
7360 res = __builtin_shuffle (a, b, mask2);    /* res is @{1,5,3,6@}  */
7361 @end smallexample
7363 Note that @code{__builtin_shuffle} is intentionally semantically
7364 compatible with the OpenCL @code{shuffle} and @code{shuffle2} functions.
7366 You can declare variables and use them in function calls and returns, as
7367 well as in assignments and some casts.  You can specify a vector type as
7368 a return type for a function.  Vector types can also be used as function
7369 arguments.  It is possible to cast from one vector type to another,
7370 provided they are of the same size (in fact, you can also cast vectors
7371 to and from other datatypes of the same size).
7373 You cannot operate between vectors of different lengths or different
7374 signedness without a cast.
7376 @node Offsetof
7377 @section Offsetof
7378 @findex __builtin_offsetof
7380 GCC implements for both C and C++ a syntactic extension to implement
7381 the @code{offsetof} macro.
7383 @smallexample
7384 primary:
7385         "__builtin_offsetof" "(" @code{typename} "," offsetof_member_designator ")"
7387 offsetof_member_designator:
7388           @code{identifier}
7389         | offsetof_member_designator "." @code{identifier}
7390         | offsetof_member_designator "[" @code{expr} "]"
7391 @end smallexample
7393 This extension is sufficient such that
7395 @smallexample
7396 #define offsetof(@var{type}, @var{member})  __builtin_offsetof (@var{type}, @var{member})
7397 @end smallexample
7399 @noindent
7400 is a suitable definition of the @code{offsetof} macro.  In C++, @var{type}
7401 may be dependent.  In either case, @var{member} may consist of a single
7402 identifier, or a sequence of member accesses and array references.
7404 @node __sync Builtins
7405 @section Legacy __sync Built-in Functions for Atomic Memory Access
7407 The following built-in functions
7408 are intended to be compatible with those described
7409 in the @cite{Intel Itanium Processor-specific Application Binary Interface},
7410 section 7.4.  As such, they depart from the normal GCC practice of using
7411 the @samp{__builtin_} prefix, and further that they are overloaded such that
7412 they work on multiple types.
7414 The definition given in the Intel documentation allows only for the use of
7415 the types @code{int}, @code{long}, @code{long long} as well as their unsigned
7416 counterparts.  GCC allows any integral scalar or pointer type that is
7417 1, 2, 4 or 8 bytes in length.
7419 Not all operations are supported by all target processors.  If a particular
7420 operation cannot be implemented on the target processor, a warning is
7421 generated and a call an external function is generated.  The external
7422 function carries the same name as the built-in version,
7423 with an additional suffix
7424 @samp{_@var{n}} where @var{n} is the size of the data type.
7426 @c ??? Should we have a mechanism to suppress this warning?  This is almost
7427 @c useful for implementing the operation under the control of an external
7428 @c mutex.
7430 In most cases, these built-in functions are considered a @dfn{full barrier}.
7431 That is,
7432 no memory operand is moved across the operation, either forward or
7433 backward.  Further, instructions are issued as necessary to prevent the
7434 processor from speculating loads across the operation and from queuing stores
7435 after the operation.
7437 All of the routines are described in the Intel documentation to take
7438 ``an optional list of variables protected by the memory barrier''.  It's
7439 not clear what is meant by that; it could mean that @emph{only} the
7440 following variables are protected, or it could mean that these variables
7441 should in addition be protected.  At present GCC ignores this list and
7442 protects all variables that are globally accessible.  If in the future
7443 we make some use of this list, an empty list will continue to mean all
7444 globally accessible variables.
7446 @table @code
7447 @item @var{type} __sync_fetch_and_add (@var{type} *ptr, @var{type} value, ...)
7448 @itemx @var{type} __sync_fetch_and_sub (@var{type} *ptr, @var{type} value, ...)
7449 @itemx @var{type} __sync_fetch_and_or (@var{type} *ptr, @var{type} value, ...)
7450 @itemx @var{type} __sync_fetch_and_and (@var{type} *ptr, @var{type} value, ...)
7451 @itemx @var{type} __sync_fetch_and_xor (@var{type} *ptr, @var{type} value, ...)
7452 @itemx @var{type} __sync_fetch_and_nand (@var{type} *ptr, @var{type} value, ...)
7453 @findex __sync_fetch_and_add
7454 @findex __sync_fetch_and_sub
7455 @findex __sync_fetch_and_or
7456 @findex __sync_fetch_and_and
7457 @findex __sync_fetch_and_xor
7458 @findex __sync_fetch_and_nand
7459 These built-in functions perform the operation suggested by the name, and
7460 returns the value that had previously been in memory.  That is,
7462 @smallexample
7463 @{ tmp = *ptr; *ptr @var{op}= value; return tmp; @}
7464 @{ tmp = *ptr; *ptr = ~(tmp & value); return tmp; @}   // nand
7465 @end smallexample
7467 @emph{Note:} GCC 4.4 and later implement @code{__sync_fetch_and_nand}
7468 as @code{*ptr = ~(tmp & value)} instead of @code{*ptr = ~tmp & value}.
7470 @item @var{type} __sync_add_and_fetch (@var{type} *ptr, @var{type} value, ...)
7471 @itemx @var{type} __sync_sub_and_fetch (@var{type} *ptr, @var{type} value, ...)
7472 @itemx @var{type} __sync_or_and_fetch (@var{type} *ptr, @var{type} value, ...)
7473 @itemx @var{type} __sync_and_and_fetch (@var{type} *ptr, @var{type} value, ...)
7474 @itemx @var{type} __sync_xor_and_fetch (@var{type} *ptr, @var{type} value, ...)
7475 @itemx @var{type} __sync_nand_and_fetch (@var{type} *ptr, @var{type} value, ...)
7476 @findex __sync_add_and_fetch
7477 @findex __sync_sub_and_fetch
7478 @findex __sync_or_and_fetch
7479 @findex __sync_and_and_fetch
7480 @findex __sync_xor_and_fetch
7481 @findex __sync_nand_and_fetch
7482 These built-in functions perform the operation suggested by the name, and
7483 return the new value.  That is,
7485 @smallexample
7486 @{ *ptr @var{op}= value; return *ptr; @}
7487 @{ *ptr = ~(*ptr & value); return *ptr; @}   // nand
7488 @end smallexample
7490 @emph{Note:} GCC 4.4 and later implement @code{__sync_nand_and_fetch}
7491 as @code{*ptr = ~(*ptr & value)} instead of
7492 @code{*ptr = ~*ptr & value}.
7494 @item bool __sync_bool_compare_and_swap (@var{type} *ptr, @var{type} oldval, @var{type} newval, ...)
7495 @itemx @var{type} __sync_val_compare_and_swap (@var{type} *ptr, @var{type} oldval, @var{type} newval, ...)
7496 @findex __sync_bool_compare_and_swap
7497 @findex __sync_val_compare_and_swap
7498 These built-in functions perform an atomic compare and swap.
7499 That is, if the current
7500 value of @code{*@var{ptr}} is @var{oldval}, then write @var{newval} into
7501 @code{*@var{ptr}}.
7503 The ``bool'' version returns true if the comparison is successful and
7504 @var{newval} is written.  The ``val'' version returns the contents
7505 of @code{*@var{ptr}} before the operation.
7507 @item __sync_synchronize (...)
7508 @findex __sync_synchronize
7509 This built-in function issues a full memory barrier.
7511 @item @var{type} __sync_lock_test_and_set (@var{type} *ptr, @var{type} value, ...)
7512 @findex __sync_lock_test_and_set
7513 This built-in function, as described by Intel, is not a traditional test-and-set
7514 operation, but rather an atomic exchange operation.  It writes @var{value}
7515 into @code{*@var{ptr}}, and returns the previous contents of
7516 @code{*@var{ptr}}.
7518 Many targets have only minimal support for such locks, and do not support
7519 a full exchange operation.  In this case, a target may support reduced
7520 functionality here by which the @emph{only} valid value to store is the
7521 immediate constant 1.  The exact value actually stored in @code{*@var{ptr}}
7522 is implementation defined.
7524 This built-in function is not a full barrier,
7525 but rather an @dfn{acquire barrier}.
7526 This means that references after the operation cannot move to (or be
7527 speculated to) before the operation, but previous memory stores may not
7528 be globally visible yet, and previous memory loads may not yet be
7529 satisfied.
7531 @item void __sync_lock_release (@var{type} *ptr, ...)
7532 @findex __sync_lock_release
7533 This built-in function releases the lock acquired by
7534 @code{__sync_lock_test_and_set}.
7535 Normally this means writing the constant 0 to @code{*@var{ptr}}.
7537 This built-in function is not a full barrier,
7538 but rather a @dfn{release barrier}.
7539 This means that all previous memory stores are globally visible, and all
7540 previous memory loads have been satisfied, but following memory reads
7541 are not prevented from being speculated to before the barrier.
7542 @end table
7544 @node __atomic Builtins
7545 @section Built-in functions for memory model aware atomic operations
7547 The following built-in functions approximately match the requirements for
7548 C++11 memory model. Many are similar to the @samp{__sync} prefixed built-in
7549 functions, but all also have a memory model parameter.  These are all
7550 identified by being prefixed with @samp{__atomic}, and most are overloaded
7551 such that they work with multiple types.
7553 GCC allows any integral scalar or pointer type that is 1, 2, 4, or 8
7554 bytes in length. 16-byte integral types are also allowed if
7555 @samp{__int128} (@pxref{__int128}) is supported by the architecture.
7557 Target architectures are encouraged to provide their own patterns for
7558 each of these built-in functions.  If no target is provided, the original 
7559 non-memory model set of @samp{__sync} atomic built-in functions are
7560 utilized, along with any required synchronization fences surrounding it in
7561 order to achieve the proper behavior.  Execution in this case is subject
7562 to the same restrictions as those built-in functions.
7564 If there is no pattern or mechanism to provide a lock free instruction
7565 sequence, a call is made to an external routine with the same parameters
7566 to be resolved at run time.
7568 The four non-arithmetic functions (load, store, exchange, and 
7569 compare_exchange) all have a generic version as well.  This generic
7570 version works on any data type.  If the data type size maps to one
7571 of the integral sizes that may have lock free support, the generic
7572 version utilizes the lock free built-in function.  Otherwise an
7573 external call is left to be resolved at run time.  This external call is
7574 the same format with the addition of a @samp{size_t} parameter inserted
7575 as the first parameter indicating the size of the object being pointed to.
7576 All objects must be the same size.
7578 There are 6 different memory models that can be specified.  These map
7579 to the same names in the C++11 standard.  Refer there or to the
7580 @uref{http://gcc.gnu.org/wiki/Atomic/GCCMM/AtomicSync,GCC wiki on
7581 atomic synchronization} for more detailed definitions.  These memory
7582 models integrate both barriers to code motion as well as synchronization
7583 requirements with other threads. These are listed in approximately
7584 ascending order of strength. It is also possible to use target specific
7585 flags for memory model flags, like Hardware Lock Elision.
7587 @table  @code
7588 @item __ATOMIC_RELAXED
7589 No barriers or synchronization.
7590 @item __ATOMIC_CONSUME
7591 Data dependency only for both barrier and synchronization with another
7592 thread.
7593 @item __ATOMIC_ACQUIRE
7594 Barrier to hoisting of code and synchronizes with release (or stronger)
7595 semantic stores from another thread.
7596 @item __ATOMIC_RELEASE
7597 Barrier to sinking of code and synchronizes with acquire (or stronger)
7598 semantic loads from another thread.
7599 @item __ATOMIC_ACQ_REL
7600 Full barrier in both directions and synchronizes with acquire loads and
7601 release stores in another thread.
7602 @item __ATOMIC_SEQ_CST
7603 Full barrier in both directions and synchronizes with acquire loads and
7604 release stores in all threads.
7605 @end table
7607 When implementing patterns for these built-in functions, the memory model
7608 parameter can be ignored as long as the pattern implements the most
7609 restrictive @code{__ATOMIC_SEQ_CST} model.  Any of the other memory models
7610 execute correctly with this memory model but they may not execute as
7611 efficiently as they could with a more appropriate implementation of the
7612 relaxed requirements.
7614 Note that the C++11 standard allows for the memory model parameter to be
7615 determined at run time rather than at compile time.  These built-in
7616 functions map any run-time value to @code{__ATOMIC_SEQ_CST} rather
7617 than invoke a runtime library call or inline a switch statement.  This is
7618 standard compliant, safe, and the simplest approach for now.
7620 The memory model parameter is a signed int, but only the lower 8 bits are
7621 reserved for the memory model.  The remainder of the signed int is reserved
7622 for future use and should be 0.  Use of the predefined atomic values
7623 ensures proper usage.
7625 @deftypefn {Built-in Function} @var{type} __atomic_load_n (@var{type} *ptr, int memmodel)
7626 This built-in function implements an atomic load operation.  It returns the
7627 contents of @code{*@var{ptr}}.
7629 The valid memory model variants are
7630 @code{__ATOMIC_RELAXED}, @code{__ATOMIC_SEQ_CST}, @code{__ATOMIC_ACQUIRE},
7631 and @code{__ATOMIC_CONSUME}.
7633 @end deftypefn
7635 @deftypefn {Built-in Function} void __atomic_load (@var{type} *ptr, @var{type} *ret, int memmodel)
7636 This is the generic version of an atomic load.  It returns the
7637 contents of @code{*@var{ptr}} in @code{*@var{ret}}.
7639 @end deftypefn
7641 @deftypefn {Built-in Function} void __atomic_store_n (@var{type} *ptr, @var{type} val, int memmodel)
7642 This built-in function implements an atomic store operation.  It writes 
7643 @code{@var{val}} into @code{*@var{ptr}}.  
7645 The valid memory model variants are
7646 @code{__ATOMIC_RELAXED}, @code{__ATOMIC_SEQ_CST}, and @code{__ATOMIC_RELEASE}.
7648 @end deftypefn
7650 @deftypefn {Built-in Function} void __atomic_store (@var{type} *ptr, @var{type} *val, int memmodel)
7651 This is the generic version of an atomic store.  It stores the value
7652 of @code{*@var{val}} into @code{*@var{ptr}}.
7654 @end deftypefn
7656 @deftypefn {Built-in Function} @var{type} __atomic_exchange_n (@var{type} *ptr, @var{type} val, int memmodel)
7657 This built-in function implements an atomic exchange operation.  It writes
7658 @var{val} into @code{*@var{ptr}}, and returns the previous contents of
7659 @code{*@var{ptr}}.
7661 The valid memory model variants are
7662 @code{__ATOMIC_RELAXED}, @code{__ATOMIC_SEQ_CST}, @code{__ATOMIC_ACQUIRE},
7663 @code{__ATOMIC_RELEASE}, and @code{__ATOMIC_ACQ_REL}.
7665 @end deftypefn
7667 @deftypefn {Built-in Function} void __atomic_exchange (@var{type} *ptr, @var{type} *val, @var{type} *ret, int memmodel)
7668 This is the generic version of an atomic exchange.  It stores the
7669 contents of @code{*@var{val}} into @code{*@var{ptr}}. The original value
7670 of @code{*@var{ptr}} is copied into @code{*@var{ret}}.
7672 @end deftypefn
7674 @deftypefn {Built-in Function} bool __atomic_compare_exchange_n (@var{type} *ptr, @var{type} *expected, @var{type} desired, bool weak, int success_memmodel, int failure_memmodel)
7675 This built-in function implements an atomic compare and exchange operation.
7676 This compares the contents of @code{*@var{ptr}} with the contents of
7677 @code{*@var{expected}} and if equal, writes @var{desired} into
7678 @code{*@var{ptr}}.  If they are not equal, the current contents of
7679 @code{*@var{ptr}} is written into @code{*@var{expected}}.  @var{weak} is true
7680 for weak compare_exchange, and false for the strong variation.  Many targets 
7681 only offer the strong variation and ignore the parameter.  When in doubt, use
7682 the strong variation.
7684 True is returned if @var{desired} is written into
7685 @code{*@var{ptr}} and the execution is considered to conform to the
7686 memory model specified by @var{success_memmodel}.  There are no
7687 restrictions on what memory model can be used here.
7689 False is returned otherwise, and the execution is considered to conform
7690 to @var{failure_memmodel}. This memory model cannot be
7691 @code{__ATOMIC_RELEASE} nor @code{__ATOMIC_ACQ_REL}.  It also cannot be a
7692 stronger model than that specified by @var{success_memmodel}.
7694 @end deftypefn
7696 @deftypefn {Built-in Function} bool __atomic_compare_exchange (@var{type} *ptr, @var{type} *expected, @var{type} *desired, bool weak, int success_memmodel, int failure_memmodel)
7697 This built-in function implements the generic version of
7698 @code{__atomic_compare_exchange}.  The function is virtually identical to
7699 @code{__atomic_compare_exchange_n}, except the desired value is also a
7700 pointer.
7702 @end deftypefn
7704 @deftypefn {Built-in Function} @var{type} __atomic_add_fetch (@var{type} *ptr, @var{type} val, int memmodel)
7705 @deftypefnx {Built-in Function} @var{type} __atomic_sub_fetch (@var{type} *ptr, @var{type} val, int memmodel)
7706 @deftypefnx {Built-in Function} @var{type} __atomic_and_fetch (@var{type} *ptr, @var{type} val, int memmodel)
7707 @deftypefnx {Built-in Function} @var{type} __atomic_xor_fetch (@var{type} *ptr, @var{type} val, int memmodel)
7708 @deftypefnx {Built-in Function} @var{type} __atomic_or_fetch (@var{type} *ptr, @var{type} val, int memmodel)
7709 @deftypefnx {Built-in Function} @var{type} __atomic_nand_fetch (@var{type} *ptr, @var{type} val, int memmodel)
7710 These built-in functions perform the operation suggested by the name, and
7711 return the result of the operation. That is,
7713 @smallexample
7714 @{ *ptr @var{op}= val; return *ptr; @}
7715 @end smallexample
7717 All memory models are valid.
7719 @end deftypefn
7721 @deftypefn {Built-in Function} @var{type} __atomic_fetch_add (@var{type} *ptr, @var{type} val, int memmodel)
7722 @deftypefnx {Built-in Function} @var{type} __atomic_fetch_sub (@var{type} *ptr, @var{type} val, int memmodel)
7723 @deftypefnx {Built-in Function} @var{type} __atomic_fetch_and (@var{type} *ptr, @var{type} val, int memmodel)
7724 @deftypefnx {Built-in Function} @var{type} __atomic_fetch_xor (@var{type} *ptr, @var{type} val, int memmodel)
7725 @deftypefnx {Built-in Function} @var{type} __atomic_fetch_or (@var{type} *ptr, @var{type} val, int memmodel)
7726 @deftypefnx {Built-in Function} @var{type} __atomic_fetch_nand (@var{type} *ptr, @var{type} val, int memmodel)
7727 These built-in functions perform the operation suggested by the name, and
7728 return the value that had previously been in @code{*@var{ptr}}.  That is,
7730 @smallexample
7731 @{ tmp = *ptr; *ptr @var{op}= val; return tmp; @}
7732 @end smallexample
7734 All memory models are valid.
7736 @end deftypefn
7738 @deftypefn {Built-in Function} bool __atomic_test_and_set (void *ptr, int memmodel)
7740 This built-in function performs an atomic test-and-set operation on
7741 the byte at @code{*@var{ptr}}.  The byte is set to some implementation
7742 defined nonzero ``set'' value and the return value is @code{true} if and only
7743 if the previous contents were ``set''.
7744 It should be only used for operands of type @code{bool} or @code{char}. For 
7745 other types only part of the value may be set.
7747 All memory models are valid.
7749 @end deftypefn
7751 @deftypefn {Built-in Function} void __atomic_clear (bool *ptr, int memmodel)
7753 This built-in function performs an atomic clear operation on
7754 @code{*@var{ptr}}.  After the operation, @code{*@var{ptr}} contains 0.
7755 It should be only used for operands of type @code{bool} or @code{char} and 
7756 in conjunction with @code{__atomic_test_and_set}.
7757 For other types it may only clear partially. If the type is not @code{bool}
7758 prefer using @code{__atomic_store}.
7760 The valid memory model variants are
7761 @code{__ATOMIC_RELAXED}, @code{__ATOMIC_SEQ_CST}, and
7762 @code{__ATOMIC_RELEASE}.
7764 @end deftypefn
7766 @deftypefn {Built-in Function} void __atomic_thread_fence (int memmodel)
7768 This built-in function acts as a synchronization fence between threads
7769 based on the specified memory model.
7771 All memory orders are valid.
7773 @end deftypefn
7775 @deftypefn {Built-in Function} void __atomic_signal_fence (int memmodel)
7777 This built-in function acts as a synchronization fence between a thread
7778 and signal handlers based in the same thread.
7780 All memory orders are valid.
7782 @end deftypefn
7784 @deftypefn {Built-in Function} bool __atomic_always_lock_free (size_t size,  void *ptr)
7786 This built-in function returns true if objects of @var{size} bytes always
7787 generate lock free atomic instructions for the target architecture.  
7788 @var{size} must resolve to a compile-time constant and the result also
7789 resolves to a compile-time constant.
7791 @var{ptr} is an optional pointer to the object that may be used to determine
7792 alignment.  A value of 0 indicates typical alignment should be used.  The 
7793 compiler may also ignore this parameter.
7795 @smallexample
7796 if (_atomic_always_lock_free (sizeof (long long), 0))
7797 @end smallexample
7799 @end deftypefn
7801 @deftypefn {Built-in Function} bool __atomic_is_lock_free (size_t size, void *ptr)
7803 This built-in function returns true if objects of @var{size} bytes always
7804 generate lock free atomic instructions for the target architecture.  If
7805 it is not known to be lock free a call is made to a runtime routine named
7806 @code{__atomic_is_lock_free}.
7808 @var{ptr} is an optional pointer to the object that may be used to determine
7809 alignment.  A value of 0 indicates typical alignment should be used.  The 
7810 compiler may also ignore this parameter.
7811 @end deftypefn
7813 @node x86 specific memory model extensions for transactional memory
7814 @section x86 specific memory model extensions for transactional memory
7816 The i386 architecture supports additional memory ordering flags
7817 to mark lock critical sections for hardware lock elision. 
7818 These must be specified in addition to an existing memory model to 
7819 atomic intrinsics.
7821 @table @code
7822 @item __ATOMIC_HLE_ACQUIRE
7823 Start lock elision on a lock variable.
7824 Memory model must be @code{__ATOMIC_ACQUIRE} or stronger.
7825 @item __ATOMIC_HLE_RELEASE
7826 End lock elision on a lock variable.
7827 Memory model must be @code{__ATOMIC_RELEASE} or stronger.
7828 @end table
7830 When a lock acquire fails it is required for good performance to abort
7831 the transaction quickly. This can be done with a @code{_mm_pause}
7833 @smallexample
7834 #include <immintrin.h> // For _mm_pause
7836 int lockvar;
7838 /* Acquire lock with lock elision */
7839 while (__atomic_exchange_n(&lockvar, 1, __ATOMIC_ACQUIRE|__ATOMIC_HLE_ACQUIRE))
7840     _mm_pause(); /* Abort failed transaction */
7842 /* Free lock with lock elision */
7843 __atomic_store_n(&lockvar, 0, __ATOMIC_RELEASE|__ATOMIC_HLE_RELEASE);
7844 @end smallexample
7846 @node Object Size Checking
7847 @section Object Size Checking Built-in Functions
7848 @findex __builtin_object_size
7849 @findex __builtin___memcpy_chk
7850 @findex __builtin___mempcpy_chk
7851 @findex __builtin___memmove_chk
7852 @findex __builtin___memset_chk
7853 @findex __builtin___strcpy_chk
7854 @findex __builtin___stpcpy_chk
7855 @findex __builtin___strncpy_chk
7856 @findex __builtin___strcat_chk
7857 @findex __builtin___strncat_chk
7858 @findex __builtin___sprintf_chk
7859 @findex __builtin___snprintf_chk
7860 @findex __builtin___vsprintf_chk
7861 @findex __builtin___vsnprintf_chk
7862 @findex __builtin___printf_chk
7863 @findex __builtin___vprintf_chk
7864 @findex __builtin___fprintf_chk
7865 @findex __builtin___vfprintf_chk
7867 GCC implements a limited buffer overflow protection mechanism
7868 that can prevent some buffer overflow attacks.
7870 @deftypefn {Built-in Function} {size_t} __builtin_object_size (void * @var{ptr}, int @var{type})
7871 is a built-in construct that returns a constant number of bytes from
7872 @var{ptr} to the end of the object @var{ptr} pointer points to
7873 (if known at compile time).  @code{__builtin_object_size} never evaluates
7874 its arguments for side-effects.  If there are any side-effects in them, it
7875 returns @code{(size_t) -1} for @var{type} 0 or 1 and @code{(size_t) 0}
7876 for @var{type} 2 or 3.  If there are multiple objects @var{ptr} can
7877 point to and all of them are known at compile time, the returned number
7878 is the maximum of remaining byte counts in those objects if @var{type} & 2 is
7879 0 and minimum if nonzero.  If it is not possible to determine which objects
7880 @var{ptr} points to at compile time, @code{__builtin_object_size} should
7881 return @code{(size_t) -1} for @var{type} 0 or 1 and @code{(size_t) 0}
7882 for @var{type} 2 or 3.
7884 @var{type} is an integer constant from 0 to 3.  If the least significant
7885 bit is clear, objects are whole variables, if it is set, a closest
7886 surrounding subobject is considered the object a pointer points to.
7887 The second bit determines if maximum or minimum of remaining bytes
7888 is computed.
7890 @smallexample
7891 struct V @{ char buf1[10]; int b; char buf2[10]; @} var;
7892 char *p = &var.buf1[1], *q = &var.b;
7894 /* Here the object p points to is var.  */
7895 assert (__builtin_object_size (p, 0) == sizeof (var) - 1);
7896 /* The subobject p points to is var.buf1.  */
7897 assert (__builtin_object_size (p, 1) == sizeof (var.buf1) - 1);
7898 /* The object q points to is var.  */
7899 assert (__builtin_object_size (q, 0)
7900         == (char *) (&var + 1) - (char *) &var.b);
7901 /* The subobject q points to is var.b.  */
7902 assert (__builtin_object_size (q, 1) == sizeof (var.b));
7903 @end smallexample
7904 @end deftypefn
7906 There are built-in functions added for many common string operation
7907 functions, e.g., for @code{memcpy} @code{__builtin___memcpy_chk}
7908 built-in is provided.  This built-in has an additional last argument,
7909 which is the number of bytes remaining in object the @var{dest}
7910 argument points to or @code{(size_t) -1} if the size is not known.
7912 The built-in functions are optimized into the normal string functions
7913 like @code{memcpy} if the last argument is @code{(size_t) -1} or if
7914 it is known at compile time that the destination object will not
7915 be overflown.  If the compiler can determine at compile time the
7916 object will be always overflown, it issues a warning.
7918 The intended use can be e.g.@:
7920 @smallexample
7921 #undef memcpy
7922 #define bos0(dest) __builtin_object_size (dest, 0)
7923 #define memcpy(dest, src, n) \
7924   __builtin___memcpy_chk (dest, src, n, bos0 (dest))
7926 char *volatile p;
7927 char buf[10];
7928 /* It is unknown what object p points to, so this is optimized
7929    into plain memcpy - no checking is possible.  */
7930 memcpy (p, "abcde", n);
7931 /* Destination is known and length too.  It is known at compile
7932    time there will be no overflow.  */
7933 memcpy (&buf[5], "abcde", 5);
7934 /* Destination is known, but the length is not known at compile time.
7935    This will result in __memcpy_chk call that can check for overflow
7936    at run time.  */
7937 memcpy (&buf[5], "abcde", n);
7938 /* Destination is known and it is known at compile time there will
7939    be overflow.  There will be a warning and __memcpy_chk call that
7940    will abort the program at run time.  */
7941 memcpy (&buf[6], "abcde", 5);
7942 @end smallexample
7944 Such built-in functions are provided for @code{memcpy}, @code{mempcpy},
7945 @code{memmove}, @code{memset}, @code{strcpy}, @code{stpcpy}, @code{strncpy},
7946 @code{strcat} and @code{strncat}.
7948 There are also checking built-in functions for formatted output functions.
7949 @smallexample
7950 int __builtin___sprintf_chk (char *s, int flag, size_t os, const char *fmt, ...);
7951 int __builtin___snprintf_chk (char *s, size_t maxlen, int flag, size_t os,
7952                               const char *fmt, ...);
7953 int __builtin___vsprintf_chk (char *s, int flag, size_t os, const char *fmt,
7954                               va_list ap);
7955 int __builtin___vsnprintf_chk (char *s, size_t maxlen, int flag, size_t os,
7956                                const char *fmt, va_list ap);
7957 @end smallexample
7959 The added @var{flag} argument is passed unchanged to @code{__sprintf_chk}
7960 etc.@: functions and can contain implementation specific flags on what
7961 additional security measures the checking function might take, such as
7962 handling @code{%n} differently.
7964 The @var{os} argument is the object size @var{s} points to, like in the
7965 other built-in functions.  There is a small difference in the behavior
7966 though, if @var{os} is @code{(size_t) -1}, the built-in functions are
7967 optimized into the non-checking functions only if @var{flag} is 0, otherwise
7968 the checking function is called with @var{os} argument set to
7969 @code{(size_t) -1}.
7971 In addition to this, there are checking built-in functions
7972 @code{__builtin___printf_chk}, @code{__builtin___vprintf_chk},
7973 @code{__builtin___fprintf_chk} and @code{__builtin___vfprintf_chk}.
7974 These have just one additional argument, @var{flag}, right before
7975 format string @var{fmt}.  If the compiler is able to optimize them to
7976 @code{fputc} etc.@: functions, it does, otherwise the checking function
7977 is called and the @var{flag} argument passed to it.
7979 @node Cilk Plus Builtins
7980 @section Cilk Plus C/C++ language extension Built-in Functions.
7982 GCC provides support for the following built-in reduction funtions if Cilk Plus
7983 is enabled. Cilk Plus can be enabled using the @option{-fcilkplus} flag.
7985 @itemize @bullet
7986 @item __sec_implicit_index
7987 @item __sec_reduce
7988 @item __sec_reduce_add
7989 @item __sec_reduce_all_nonzero
7990 @item __sec_reduce_all_zero
7991 @item __sec_reduce_any_nonzero
7992 @item __sec_reduce_any_zero
7993 @item __sec_reduce_max
7994 @item __sec_reduce_min
7995 @item __sec_reduce_max_ind
7996 @item __sec_reduce_min_ind
7997 @item __sec_reduce_mul
7998 @item __sec_reduce_mutating
7999 @end itemize
8001 Further details and examples about these built-in functions are described 
8002 in the Cilk Plus language manual which can be found at 
8003 @uref{http://www.cilkplus.org}.
8005 @node Other Builtins
8006 @section Other Built-in Functions Provided by GCC
8007 @cindex built-in functions
8008 @findex __builtin_fpclassify
8009 @findex __builtin_isfinite
8010 @findex __builtin_isnormal
8011 @findex __builtin_isgreater
8012 @findex __builtin_isgreaterequal
8013 @findex __builtin_isinf_sign
8014 @findex __builtin_isless
8015 @findex __builtin_islessequal
8016 @findex __builtin_islessgreater
8017 @findex __builtin_isunordered
8018 @findex __builtin_powi
8019 @findex __builtin_powif
8020 @findex __builtin_powil
8021 @findex _Exit
8022 @findex _exit
8023 @findex abort
8024 @findex abs
8025 @findex acos
8026 @findex acosf
8027 @findex acosh
8028 @findex acoshf
8029 @findex acoshl
8030 @findex acosl
8031 @findex alloca
8032 @findex asin
8033 @findex asinf
8034 @findex asinh
8035 @findex asinhf
8036 @findex asinhl
8037 @findex asinl
8038 @findex atan
8039 @findex atan2
8040 @findex atan2f
8041 @findex atan2l
8042 @findex atanf
8043 @findex atanh
8044 @findex atanhf
8045 @findex atanhl
8046 @findex atanl
8047 @findex bcmp
8048 @findex bzero
8049 @findex cabs
8050 @findex cabsf
8051 @findex cabsl
8052 @findex cacos
8053 @findex cacosf
8054 @findex cacosh
8055 @findex cacoshf
8056 @findex cacoshl
8057 @findex cacosl
8058 @findex calloc
8059 @findex carg
8060 @findex cargf
8061 @findex cargl
8062 @findex casin
8063 @findex casinf
8064 @findex casinh
8065 @findex casinhf
8066 @findex casinhl
8067 @findex casinl
8068 @findex catan
8069 @findex catanf
8070 @findex catanh
8071 @findex catanhf
8072 @findex catanhl
8073 @findex catanl
8074 @findex cbrt
8075 @findex cbrtf
8076 @findex cbrtl
8077 @findex ccos
8078 @findex ccosf
8079 @findex ccosh
8080 @findex ccoshf
8081 @findex ccoshl
8082 @findex ccosl
8083 @findex ceil
8084 @findex ceilf
8085 @findex ceill
8086 @findex cexp
8087 @findex cexpf
8088 @findex cexpl
8089 @findex cimag
8090 @findex cimagf
8091 @findex cimagl
8092 @findex clog
8093 @findex clogf
8094 @findex clogl
8095 @findex conj
8096 @findex conjf
8097 @findex conjl
8098 @findex copysign
8099 @findex copysignf
8100 @findex copysignl
8101 @findex cos
8102 @findex cosf
8103 @findex cosh
8104 @findex coshf
8105 @findex coshl
8106 @findex cosl
8107 @findex cpow
8108 @findex cpowf
8109 @findex cpowl
8110 @findex cproj
8111 @findex cprojf
8112 @findex cprojl
8113 @findex creal
8114 @findex crealf
8115 @findex creall
8116 @findex csin
8117 @findex csinf
8118 @findex csinh
8119 @findex csinhf
8120 @findex csinhl
8121 @findex csinl
8122 @findex csqrt
8123 @findex csqrtf
8124 @findex csqrtl
8125 @findex ctan
8126 @findex ctanf
8127 @findex ctanh
8128 @findex ctanhf
8129 @findex ctanhl
8130 @findex ctanl
8131 @findex dcgettext
8132 @findex dgettext
8133 @findex drem
8134 @findex dremf
8135 @findex dreml
8136 @findex erf
8137 @findex erfc
8138 @findex erfcf
8139 @findex erfcl
8140 @findex erff
8141 @findex erfl
8142 @findex exit
8143 @findex exp
8144 @findex exp10
8145 @findex exp10f
8146 @findex exp10l
8147 @findex exp2
8148 @findex exp2f
8149 @findex exp2l
8150 @findex expf
8151 @findex expl
8152 @findex expm1
8153 @findex expm1f
8154 @findex expm1l
8155 @findex fabs
8156 @findex fabsf
8157 @findex fabsl
8158 @findex fdim
8159 @findex fdimf
8160 @findex fdiml
8161 @findex ffs
8162 @findex floor
8163 @findex floorf
8164 @findex floorl
8165 @findex fma
8166 @findex fmaf
8167 @findex fmal
8168 @findex fmax
8169 @findex fmaxf
8170 @findex fmaxl
8171 @findex fmin
8172 @findex fminf
8173 @findex fminl
8174 @findex fmod
8175 @findex fmodf
8176 @findex fmodl
8177 @findex fprintf
8178 @findex fprintf_unlocked
8179 @findex fputs
8180 @findex fputs_unlocked
8181 @findex frexp
8182 @findex frexpf
8183 @findex frexpl
8184 @findex fscanf
8185 @findex gamma
8186 @findex gammaf
8187 @findex gammal
8188 @findex gamma_r
8189 @findex gammaf_r
8190 @findex gammal_r
8191 @findex gettext
8192 @findex hypot
8193 @findex hypotf
8194 @findex hypotl
8195 @findex ilogb
8196 @findex ilogbf
8197 @findex ilogbl
8198 @findex imaxabs
8199 @findex index
8200 @findex isalnum
8201 @findex isalpha
8202 @findex isascii
8203 @findex isblank
8204 @findex iscntrl
8205 @findex isdigit
8206 @findex isgraph
8207 @findex islower
8208 @findex isprint
8209 @findex ispunct
8210 @findex isspace
8211 @findex isupper
8212 @findex iswalnum
8213 @findex iswalpha
8214 @findex iswblank
8215 @findex iswcntrl
8216 @findex iswdigit
8217 @findex iswgraph
8218 @findex iswlower
8219 @findex iswprint
8220 @findex iswpunct
8221 @findex iswspace
8222 @findex iswupper
8223 @findex iswxdigit
8224 @findex isxdigit
8225 @findex j0
8226 @findex j0f
8227 @findex j0l
8228 @findex j1
8229 @findex j1f
8230 @findex j1l
8231 @findex jn
8232 @findex jnf
8233 @findex jnl
8234 @findex labs
8235 @findex ldexp
8236 @findex ldexpf
8237 @findex ldexpl
8238 @findex lgamma
8239 @findex lgammaf
8240 @findex lgammal
8241 @findex lgamma_r
8242 @findex lgammaf_r
8243 @findex lgammal_r
8244 @findex llabs
8245 @findex llrint
8246 @findex llrintf
8247 @findex llrintl
8248 @findex llround
8249 @findex llroundf
8250 @findex llroundl
8251 @findex log
8252 @findex log10
8253 @findex log10f
8254 @findex log10l
8255 @findex log1p
8256 @findex log1pf
8257 @findex log1pl
8258 @findex log2
8259 @findex log2f
8260 @findex log2l
8261 @findex logb
8262 @findex logbf
8263 @findex logbl
8264 @findex logf
8265 @findex logl
8266 @findex lrint
8267 @findex lrintf
8268 @findex lrintl
8269 @findex lround
8270 @findex lroundf
8271 @findex lroundl
8272 @findex malloc
8273 @findex memchr
8274 @findex memcmp
8275 @findex memcpy
8276 @findex mempcpy
8277 @findex memset
8278 @findex modf
8279 @findex modff
8280 @findex modfl
8281 @findex nearbyint
8282 @findex nearbyintf
8283 @findex nearbyintl
8284 @findex nextafter
8285 @findex nextafterf
8286 @findex nextafterl
8287 @findex nexttoward
8288 @findex nexttowardf
8289 @findex nexttowardl
8290 @findex pow
8291 @findex pow10
8292 @findex pow10f
8293 @findex pow10l
8294 @findex powf
8295 @findex powl
8296 @findex printf
8297 @findex printf_unlocked
8298 @findex putchar
8299 @findex puts
8300 @findex remainder
8301 @findex remainderf
8302 @findex remainderl
8303 @findex remquo
8304 @findex remquof
8305 @findex remquol
8306 @findex rindex
8307 @findex rint
8308 @findex rintf
8309 @findex rintl
8310 @findex round
8311 @findex roundf
8312 @findex roundl
8313 @findex scalb
8314 @findex scalbf
8315 @findex scalbl
8316 @findex scalbln
8317 @findex scalblnf
8318 @findex scalblnf
8319 @findex scalbn
8320 @findex scalbnf
8321 @findex scanfnl
8322 @findex signbit
8323 @findex signbitf
8324 @findex signbitl
8325 @findex signbitd32
8326 @findex signbitd64
8327 @findex signbitd128
8328 @findex significand
8329 @findex significandf
8330 @findex significandl
8331 @findex sin
8332 @findex sincos
8333 @findex sincosf
8334 @findex sincosl
8335 @findex sinf
8336 @findex sinh
8337 @findex sinhf
8338 @findex sinhl
8339 @findex sinl
8340 @findex snprintf
8341 @findex sprintf
8342 @findex sqrt
8343 @findex sqrtf
8344 @findex sqrtl
8345 @findex sscanf
8346 @findex stpcpy
8347 @findex stpncpy
8348 @findex strcasecmp
8349 @findex strcat
8350 @findex strchr
8351 @findex strcmp
8352 @findex strcpy
8353 @findex strcspn
8354 @findex strdup
8355 @findex strfmon
8356 @findex strftime
8357 @findex strlen
8358 @findex strncasecmp
8359 @findex strncat
8360 @findex strncmp
8361 @findex strncpy
8362 @findex strndup
8363 @findex strpbrk
8364 @findex strrchr
8365 @findex strspn
8366 @findex strstr
8367 @findex tan
8368 @findex tanf
8369 @findex tanh
8370 @findex tanhf
8371 @findex tanhl
8372 @findex tanl
8373 @findex tgamma
8374 @findex tgammaf
8375 @findex tgammal
8376 @findex toascii
8377 @findex tolower
8378 @findex toupper
8379 @findex towlower
8380 @findex towupper
8381 @findex trunc
8382 @findex truncf
8383 @findex truncl
8384 @findex vfprintf
8385 @findex vfscanf
8386 @findex vprintf
8387 @findex vscanf
8388 @findex vsnprintf
8389 @findex vsprintf
8390 @findex vsscanf
8391 @findex y0
8392 @findex y0f
8393 @findex y0l
8394 @findex y1
8395 @findex y1f
8396 @findex y1l
8397 @findex yn
8398 @findex ynf
8399 @findex ynl
8401 GCC provides a large number of built-in functions other than the ones
8402 mentioned above.  Some of these are for internal use in the processing
8403 of exceptions or variable-length argument lists and are not
8404 documented here because they may change from time to time; we do not
8405 recommend general use of these functions.
8407 The remaining functions are provided for optimization purposes.
8409 @opindex fno-builtin
8410 GCC includes built-in versions of many of the functions in the standard
8411 C library.  The versions prefixed with @code{__builtin_} are always
8412 treated as having the same meaning as the C library function even if you
8413 specify the @option{-fno-builtin} option.  (@pxref{C Dialect Options})
8414 Many of these functions are only optimized in certain cases; if they are
8415 not optimized in a particular case, a call to the library function is
8416 emitted.
8418 @opindex ansi
8419 @opindex std
8420 Outside strict ISO C mode (@option{-ansi}, @option{-std=c90},
8421 @option{-std=c99} or @option{-std=c11}), the functions
8422 @code{_exit}, @code{alloca}, @code{bcmp}, @code{bzero},
8423 @code{dcgettext}, @code{dgettext}, @code{dremf}, @code{dreml},
8424 @code{drem}, @code{exp10f}, @code{exp10l}, @code{exp10}, @code{ffsll},
8425 @code{ffsl}, @code{ffs}, @code{fprintf_unlocked},
8426 @code{fputs_unlocked}, @code{gammaf}, @code{gammal}, @code{gamma},
8427 @code{gammaf_r}, @code{gammal_r}, @code{gamma_r}, @code{gettext},
8428 @code{index}, @code{isascii}, @code{j0f}, @code{j0l}, @code{j0},
8429 @code{j1f}, @code{j1l}, @code{j1}, @code{jnf}, @code{jnl}, @code{jn},
8430 @code{lgammaf_r}, @code{lgammal_r}, @code{lgamma_r}, @code{mempcpy},
8431 @code{pow10f}, @code{pow10l}, @code{pow10}, @code{printf_unlocked},
8432 @code{rindex}, @code{scalbf}, @code{scalbl}, @code{scalb},
8433 @code{signbit}, @code{signbitf}, @code{signbitl}, @code{signbitd32},
8434 @code{signbitd64}, @code{signbitd128}, @code{significandf},
8435 @code{significandl}, @code{significand}, @code{sincosf},
8436 @code{sincosl}, @code{sincos}, @code{stpcpy}, @code{stpncpy},
8437 @code{strcasecmp}, @code{strdup}, @code{strfmon}, @code{strncasecmp},
8438 @code{strndup}, @code{toascii}, @code{y0f}, @code{y0l}, @code{y0},
8439 @code{y1f}, @code{y1l}, @code{y1}, @code{ynf}, @code{ynl} and
8440 @code{yn}
8441 may be handled as built-in functions.
8442 All these functions have corresponding versions
8443 prefixed with @code{__builtin_}, which may be used even in strict C90
8444 mode.
8446 The ISO C99 functions
8447 @code{_Exit}, @code{acoshf}, @code{acoshl}, @code{acosh}, @code{asinhf},
8448 @code{asinhl}, @code{asinh}, @code{atanhf}, @code{atanhl}, @code{atanh},
8449 @code{cabsf}, @code{cabsl}, @code{cabs}, @code{cacosf}, @code{cacoshf},
8450 @code{cacoshl}, @code{cacosh}, @code{cacosl}, @code{cacos},
8451 @code{cargf}, @code{cargl}, @code{carg}, @code{casinf}, @code{casinhf},
8452 @code{casinhl}, @code{casinh}, @code{casinl}, @code{casin},
8453 @code{catanf}, @code{catanhf}, @code{catanhl}, @code{catanh},
8454 @code{catanl}, @code{catan}, @code{cbrtf}, @code{cbrtl}, @code{cbrt},
8455 @code{ccosf}, @code{ccoshf}, @code{ccoshl}, @code{ccosh}, @code{ccosl},
8456 @code{ccos}, @code{cexpf}, @code{cexpl}, @code{cexp}, @code{cimagf},
8457 @code{cimagl}, @code{cimag}, @code{clogf}, @code{clogl}, @code{clog},
8458 @code{conjf}, @code{conjl}, @code{conj}, @code{copysignf}, @code{copysignl},
8459 @code{copysign}, @code{cpowf}, @code{cpowl}, @code{cpow}, @code{cprojf},
8460 @code{cprojl}, @code{cproj}, @code{crealf}, @code{creall}, @code{creal},
8461 @code{csinf}, @code{csinhf}, @code{csinhl}, @code{csinh}, @code{csinl},
8462 @code{csin}, @code{csqrtf}, @code{csqrtl}, @code{csqrt}, @code{ctanf},
8463 @code{ctanhf}, @code{ctanhl}, @code{ctanh}, @code{ctanl}, @code{ctan},
8464 @code{erfcf}, @code{erfcl}, @code{erfc}, @code{erff}, @code{erfl},
8465 @code{erf}, @code{exp2f}, @code{exp2l}, @code{exp2}, @code{expm1f},
8466 @code{expm1l}, @code{expm1}, @code{fdimf}, @code{fdiml}, @code{fdim},
8467 @code{fmaf}, @code{fmal}, @code{fmaxf}, @code{fmaxl}, @code{fmax},
8468 @code{fma}, @code{fminf}, @code{fminl}, @code{fmin}, @code{hypotf},
8469 @code{hypotl}, @code{hypot}, @code{ilogbf}, @code{ilogbl}, @code{ilogb},
8470 @code{imaxabs}, @code{isblank}, @code{iswblank}, @code{lgammaf},
8471 @code{lgammal}, @code{lgamma}, @code{llabs}, @code{llrintf}, @code{llrintl},
8472 @code{llrint}, @code{llroundf}, @code{llroundl}, @code{llround},
8473 @code{log1pf}, @code{log1pl}, @code{log1p}, @code{log2f}, @code{log2l},
8474 @code{log2}, @code{logbf}, @code{logbl}, @code{logb}, @code{lrintf},
8475 @code{lrintl}, @code{lrint}, @code{lroundf}, @code{lroundl},
8476 @code{lround}, @code{nearbyintf}, @code{nearbyintl}, @code{nearbyint},
8477 @code{nextafterf}, @code{nextafterl}, @code{nextafter},
8478 @code{nexttowardf}, @code{nexttowardl}, @code{nexttoward},
8479 @code{remainderf}, @code{remainderl}, @code{remainder}, @code{remquof},
8480 @code{remquol}, @code{remquo}, @code{rintf}, @code{rintl}, @code{rint},
8481 @code{roundf}, @code{roundl}, @code{round}, @code{scalblnf},
8482 @code{scalblnl}, @code{scalbln}, @code{scalbnf}, @code{scalbnl},
8483 @code{scalbn}, @code{snprintf}, @code{tgammaf}, @code{tgammal},
8484 @code{tgamma}, @code{truncf}, @code{truncl}, @code{trunc},
8485 @code{vfscanf}, @code{vscanf}, @code{vsnprintf} and @code{vsscanf}
8486 are handled as built-in functions
8487 except in strict ISO C90 mode (@option{-ansi} or @option{-std=c90}).
8489 There are also built-in versions of the ISO C99 functions
8490 @code{acosf}, @code{acosl}, @code{asinf}, @code{asinl}, @code{atan2f},
8491 @code{atan2l}, @code{atanf}, @code{atanl}, @code{ceilf}, @code{ceill},
8492 @code{cosf}, @code{coshf}, @code{coshl}, @code{cosl}, @code{expf},
8493 @code{expl}, @code{fabsf}, @code{fabsl}, @code{floorf}, @code{floorl},
8494 @code{fmodf}, @code{fmodl}, @code{frexpf}, @code{frexpl}, @code{ldexpf},
8495 @code{ldexpl}, @code{log10f}, @code{log10l}, @code{logf}, @code{logl},
8496 @code{modfl}, @code{modf}, @code{powf}, @code{powl}, @code{sinf},
8497 @code{sinhf}, @code{sinhl}, @code{sinl}, @code{sqrtf}, @code{sqrtl},
8498 @code{tanf}, @code{tanhf}, @code{tanhl} and @code{tanl}
8499 that are recognized in any mode since ISO C90 reserves these names for
8500 the purpose to which ISO C99 puts them.  All these functions have
8501 corresponding versions prefixed with @code{__builtin_}.
8503 The ISO C94 functions
8504 @code{iswalnum}, @code{iswalpha}, @code{iswcntrl}, @code{iswdigit},
8505 @code{iswgraph}, @code{iswlower}, @code{iswprint}, @code{iswpunct},
8506 @code{iswspace}, @code{iswupper}, @code{iswxdigit}, @code{towlower} and
8507 @code{towupper}
8508 are handled as built-in functions
8509 except in strict ISO C90 mode (@option{-ansi} or @option{-std=c90}).
8511 The ISO C90 functions
8512 @code{abort}, @code{abs}, @code{acos}, @code{asin}, @code{atan2},
8513 @code{atan}, @code{calloc}, @code{ceil}, @code{cosh}, @code{cos},
8514 @code{exit}, @code{exp}, @code{fabs}, @code{floor}, @code{fmod},
8515 @code{fprintf}, @code{fputs}, @code{frexp}, @code{fscanf},
8516 @code{isalnum}, @code{isalpha}, @code{iscntrl}, @code{isdigit},
8517 @code{isgraph}, @code{islower}, @code{isprint}, @code{ispunct},
8518 @code{isspace}, @code{isupper}, @code{isxdigit}, @code{tolower},
8519 @code{toupper}, @code{labs}, @code{ldexp}, @code{log10}, @code{log},
8520 @code{malloc}, @code{memchr}, @code{memcmp}, @code{memcpy},
8521 @code{memset}, @code{modf}, @code{pow}, @code{printf}, @code{putchar},
8522 @code{puts}, @code{scanf}, @code{sinh}, @code{sin}, @code{snprintf},
8523 @code{sprintf}, @code{sqrt}, @code{sscanf}, @code{strcat},
8524 @code{strchr}, @code{strcmp}, @code{strcpy}, @code{strcspn},
8525 @code{strlen}, @code{strncat}, @code{strncmp}, @code{strncpy},
8526 @code{strpbrk}, @code{strrchr}, @code{strspn}, @code{strstr},
8527 @code{tanh}, @code{tan}, @code{vfprintf}, @code{vprintf} and @code{vsprintf}
8528 are all recognized as built-in functions unless
8529 @option{-fno-builtin} is specified (or @option{-fno-builtin-@var{function}}
8530 is specified for an individual function).  All of these functions have
8531 corresponding versions prefixed with @code{__builtin_}.
8533 GCC provides built-in versions of the ISO C99 floating-point comparison
8534 macros that avoid raising exceptions for unordered operands.  They have
8535 the same names as the standard macros ( @code{isgreater},
8536 @code{isgreaterequal}, @code{isless}, @code{islessequal},
8537 @code{islessgreater}, and @code{isunordered}) , with @code{__builtin_}
8538 prefixed.  We intend for a library implementor to be able to simply
8539 @code{#define} each standard macro to its built-in equivalent.
8540 In the same fashion, GCC provides @code{fpclassify}, @code{isfinite},
8541 @code{isinf_sign} and @code{isnormal} built-ins used with
8542 @code{__builtin_} prefixed.  The @code{isinf} and @code{isnan}
8543 built-in functions appear both with and without the @code{__builtin_} prefix.
8545 @deftypefn {Built-in Function} int __builtin_types_compatible_p (@var{type1}, @var{type2})
8547 You can use the built-in function @code{__builtin_types_compatible_p} to
8548 determine whether two types are the same.
8550 This built-in function returns 1 if the unqualified versions of the
8551 types @var{type1} and @var{type2} (which are types, not expressions) are
8552 compatible, 0 otherwise.  The result of this built-in function can be
8553 used in integer constant expressions.
8555 This built-in function ignores top level qualifiers (e.g., @code{const},
8556 @code{volatile}).  For example, @code{int} is equivalent to @code{const
8557 int}.
8559 The type @code{int[]} and @code{int[5]} are compatible.  On the other
8560 hand, @code{int} and @code{char *} are not compatible, even if the size
8561 of their types, on the particular architecture are the same.  Also, the
8562 amount of pointer indirection is taken into account when determining
8563 similarity.  Consequently, @code{short *} is not similar to
8564 @code{short **}.  Furthermore, two types that are typedefed are
8565 considered compatible if their underlying types are compatible.
8567 An @code{enum} type is not considered to be compatible with another
8568 @code{enum} type even if both are compatible with the same integer
8569 type; this is what the C standard specifies.
8570 For example, @code{enum @{foo, bar@}} is not similar to
8571 @code{enum @{hot, dog@}}.
8573 You typically use this function in code whose execution varies
8574 depending on the arguments' types.  For example:
8576 @smallexample
8577 #define foo(x)                                                  \
8578   (@{                                                           \
8579     typeof (x) tmp = (x);                                       \
8580     if (__builtin_types_compatible_p (typeof (x), long double)) \
8581       tmp = foo_long_double (tmp);                              \
8582     else if (__builtin_types_compatible_p (typeof (x), double)) \
8583       tmp = foo_double (tmp);                                   \
8584     else if (__builtin_types_compatible_p (typeof (x), float))  \
8585       tmp = foo_float (tmp);                                    \
8586     else                                                        \
8587       abort ();                                                 \
8588     tmp;                                                        \
8589   @})
8590 @end smallexample
8592 @emph{Note:} This construct is only available for C@.
8594 @end deftypefn
8596 @deftypefn {Built-in Function} @var{type} __builtin_choose_expr (@var{const_exp}, @var{exp1}, @var{exp2})
8598 You can use the built-in function @code{__builtin_choose_expr} to
8599 evaluate code depending on the value of a constant expression.  This
8600 built-in function returns @var{exp1} if @var{const_exp}, which is an
8601 integer constant expression, is nonzero.  Otherwise it returns @var{exp2}.
8603 This built-in function is analogous to the @samp{? :} operator in C,
8604 except that the expression returned has its type unaltered by promotion
8605 rules.  Also, the built-in function does not evaluate the expression
8606 that is not chosen.  For example, if @var{const_exp} evaluates to true,
8607 @var{exp2} is not evaluated even if it has side-effects.
8609 This built-in function can return an lvalue if the chosen argument is an
8610 lvalue.
8612 If @var{exp1} is returned, the return type is the same as @var{exp1}'s
8613 type.  Similarly, if @var{exp2} is returned, its return type is the same
8614 as @var{exp2}.
8616 Example:
8618 @smallexample
8619 #define foo(x)                                                    \
8620   __builtin_choose_expr (                                         \
8621     __builtin_types_compatible_p (typeof (x), double),            \
8622     foo_double (x),                                               \
8623     __builtin_choose_expr (                                       \
8624       __builtin_types_compatible_p (typeof (x), float),           \
8625       foo_float (x),                                              \
8626       /* @r{The void expression results in a compile-time error}  \
8627          @r{when assigning the result to something.}  */          \
8628       (void)0))
8629 @end smallexample
8631 @emph{Note:} This construct is only available for C@.  Furthermore, the
8632 unused expression (@var{exp1} or @var{exp2} depending on the value of
8633 @var{const_exp}) may still generate syntax errors.  This may change in
8634 future revisions.
8636 @end deftypefn
8638 @deftypefn {Built-in Function} @var{type} __builtin_complex (@var{real}, @var{imag})
8640 The built-in function @code{__builtin_complex} is provided for use in
8641 implementing the ISO C11 macros @code{CMPLXF}, @code{CMPLX} and
8642 @code{CMPLXL}.  @var{real} and @var{imag} must have the same type, a
8643 real binary floating-point type, and the result has the corresponding
8644 complex type with real and imaginary parts @var{real} and @var{imag}.
8645 Unlike @samp{@var{real} + I * @var{imag}}, this works even when
8646 infinities, NaNs and negative zeros are involved.
8648 @end deftypefn
8650 @deftypefn {Built-in Function} int __builtin_constant_p (@var{exp})
8651 You can use the built-in function @code{__builtin_constant_p} to
8652 determine if a value is known to be constant at compile time and hence
8653 that GCC can perform constant-folding on expressions involving that
8654 value.  The argument of the function is the value to test.  The function
8655 returns the integer 1 if the argument is known to be a compile-time
8656 constant and 0 if it is not known to be a compile-time constant.  A
8657 return of 0 does not indicate that the value is @emph{not} a constant,
8658 but merely that GCC cannot prove it is a constant with the specified
8659 value of the @option{-O} option.
8661 You typically use this function in an embedded application where
8662 memory is a critical resource.  If you have some complex calculation,
8663 you may want it to be folded if it involves constants, but need to call
8664 a function if it does not.  For example:
8666 @smallexample
8667 #define Scale_Value(X)      \
8668   (__builtin_constant_p (X) \
8669   ? ((X) * SCALE + OFFSET) : Scale (X))
8670 @end smallexample
8672 You may use this built-in function in either a macro or an inline
8673 function.  However, if you use it in an inlined function and pass an
8674 argument of the function as the argument to the built-in, GCC 
8675 never returns 1 when you call the inline function with a string constant
8676 or compound literal (@pxref{Compound Literals}) and does not return 1
8677 when you pass a constant numeric value to the inline function unless you
8678 specify the @option{-O} option.
8680 You may also use @code{__builtin_constant_p} in initializers for static
8681 data.  For instance, you can write
8683 @smallexample
8684 static const int table[] = @{
8685    __builtin_constant_p (EXPRESSION) ? (EXPRESSION) : -1,
8686    /* @r{@dots{}} */
8688 @end smallexample
8690 @noindent
8691 This is an acceptable initializer even if @var{EXPRESSION} is not a
8692 constant expression, including the case where
8693 @code{__builtin_constant_p} returns 1 because @var{EXPRESSION} can be
8694 folded to a constant but @var{EXPRESSION} contains operands that are
8695 not otherwise permitted in a static initializer (for example,
8696 @code{0 && foo ()}).  GCC must be more conservative about evaluating the
8697 built-in in this case, because it has no opportunity to perform
8698 optimization.
8700 Previous versions of GCC did not accept this built-in in data
8701 initializers.  The earliest version where it is completely safe is
8702 3.0.1.
8703 @end deftypefn
8705 @deftypefn {Built-in Function} long __builtin_expect (long @var{exp}, long @var{c})
8706 @opindex fprofile-arcs
8707 You may use @code{__builtin_expect} to provide the compiler with
8708 branch prediction information.  In general, you should prefer to
8709 use actual profile feedback for this (@option{-fprofile-arcs}), as
8710 programmers are notoriously bad at predicting how their programs
8711 actually perform.  However, there are applications in which this
8712 data is hard to collect.
8714 The return value is the value of @var{exp}, which should be an integral
8715 expression.  The semantics of the built-in are that it is expected that
8716 @var{exp} == @var{c}.  For example:
8718 @smallexample
8719 if (__builtin_expect (x, 0))
8720   foo ();
8721 @end smallexample
8723 @noindent
8724 indicates that we do not expect to call @code{foo}, since
8725 we expect @code{x} to be zero.  Since you are limited to integral
8726 expressions for @var{exp}, you should use constructions such as
8728 @smallexample
8729 if (__builtin_expect (ptr != NULL, 1))
8730   foo (*ptr);
8731 @end smallexample
8733 @noindent
8734 when testing pointer or floating-point values.
8735 @end deftypefn
8737 @deftypefn {Built-in Function} void __builtin_trap (void)
8738 This function causes the program to exit abnormally.  GCC implements
8739 this function by using a target-dependent mechanism (such as
8740 intentionally executing an illegal instruction) or by calling
8741 @code{abort}.  The mechanism used may vary from release to release so
8742 you should not rely on any particular implementation.
8743 @end deftypefn
8745 @deftypefn {Built-in Function} void __builtin_unreachable (void)
8746 If control flow reaches the point of the @code{__builtin_unreachable},
8747 the program is undefined.  It is useful in situations where the
8748 compiler cannot deduce the unreachability of the code.
8750 One such case is immediately following an @code{asm} statement that
8751 either never terminates, or one that transfers control elsewhere
8752 and never returns.  In this example, without the
8753 @code{__builtin_unreachable}, GCC issues a warning that control
8754 reaches the end of a non-void function.  It also generates code
8755 to return after the @code{asm}.
8757 @smallexample
8758 int f (int c, int v)
8760   if (c)
8761     @{
8762       return v;
8763     @}
8764   else
8765     @{
8766       asm("jmp error_handler");
8767       __builtin_unreachable ();
8768     @}
8770 @end smallexample
8772 @noindent
8773 Because the @code{asm} statement unconditionally transfers control out
8774 of the function, control never reaches the end of the function
8775 body.  The @code{__builtin_unreachable} is in fact unreachable and
8776 communicates this fact to the compiler.
8778 Another use for @code{__builtin_unreachable} is following a call a
8779 function that never returns but that is not declared
8780 @code{__attribute__((noreturn))}, as in this example:
8782 @smallexample
8783 void function_that_never_returns (void);
8785 int g (int c)
8787   if (c)
8788     @{
8789       return 1;
8790     @}
8791   else
8792     @{
8793       function_that_never_returns ();
8794       __builtin_unreachable ();
8795     @}
8797 @end smallexample
8799 @end deftypefn
8801 @deftypefn {Built-in Function} void *__builtin_assume_aligned (const void *@var{exp}, size_t @var{align}, ...)
8802 This function returns its first argument, and allows the compiler
8803 to assume that the returned pointer is at least @var{align} bytes
8804 aligned.  This built-in can have either two or three arguments,
8805 if it has three, the third argument should have integer type, and
8806 if it is nonzero means misalignment offset.  For example:
8808 @smallexample
8809 void *x = __builtin_assume_aligned (arg, 16);
8810 @end smallexample
8812 @noindent
8813 means that the compiler can assume @code{x}, set to @code{arg}, is at least
8814 16-byte aligned, while:
8816 @smallexample
8817 void *x = __builtin_assume_aligned (arg, 32, 8);
8818 @end smallexample
8820 @noindent
8821 means that the compiler can assume for @code{x}, set to @code{arg}, that
8822 @code{(char *) x - 8} is 32-byte aligned.
8823 @end deftypefn
8825 @deftypefn {Built-in Function} int __builtin_LINE ()
8826 This function is the equivalent to the preprocessor @code{__LINE__}
8827 macro and returns the line number of the invocation of the built-in.
8828 In a C++ default argument for a function @var{F}, it gets the line number of
8829 the call to @var{F}.
8830 @end deftypefn
8832 @deftypefn {Built-in Function} {const char *} __builtin_FUNCTION ()
8833 This function is the equivalent to the preprocessor @code{__FUNCTION__}
8834 macro and returns the function name the invocation of the built-in is in.
8835 @end deftypefn
8837 @deftypefn {Built-in Function} {const char *} __builtin_FILE ()
8838 This function is the equivalent to the preprocessor @code{__FILE__}
8839 macro and returns the file name the invocation of the built-in is in.
8840 In a C++ default argument for a function @var{F}, it gets the file name of
8841 the call to @var{F}.
8842 @end deftypefn
8844 @deftypefn {Built-in Function} void __builtin___clear_cache (char *@var{begin}, char *@var{end})
8845 This function is used to flush the processor's instruction cache for
8846 the region of memory between @var{begin} inclusive and @var{end}
8847 exclusive.  Some targets require that the instruction cache be
8848 flushed, after modifying memory containing code, in order to obtain
8849 deterministic behavior.
8851 If the target does not require instruction cache flushes,
8852 @code{__builtin___clear_cache} has no effect.  Otherwise either
8853 instructions are emitted in-line to clear the instruction cache or a
8854 call to the @code{__clear_cache} function in libgcc is made.
8855 @end deftypefn
8857 @deftypefn {Built-in Function} void __builtin_prefetch (const void *@var{addr}, ...)
8858 This function is used to minimize cache-miss latency by moving data into
8859 a cache before it is accessed.
8860 You can insert calls to @code{__builtin_prefetch} into code for which
8861 you know addresses of data in memory that is likely to be accessed soon.
8862 If the target supports them, data prefetch instructions are generated.
8863 If the prefetch is done early enough before the access then the data will
8864 be in the cache by the time it is accessed.
8866 The value of @var{addr} is the address of the memory to prefetch.
8867 There are two optional arguments, @var{rw} and @var{locality}.
8868 The value of @var{rw} is a compile-time constant one or zero; one
8869 means that the prefetch is preparing for a write to the memory address
8870 and zero, the default, means that the prefetch is preparing for a read.
8871 The value @var{locality} must be a compile-time constant integer between
8872 zero and three.  A value of zero means that the data has no temporal
8873 locality, so it need not be left in the cache after the access.  A value
8874 of three means that the data has a high degree of temporal locality and
8875 should be left in all levels of cache possible.  Values of one and two
8876 mean, respectively, a low or moderate degree of temporal locality.  The
8877 default is three.
8879 @smallexample
8880 for (i = 0; i < n; i++)
8881   @{
8882     a[i] = a[i] + b[i];
8883     __builtin_prefetch (&a[i+j], 1, 1);
8884     __builtin_prefetch (&b[i+j], 0, 1);
8885     /* @r{@dots{}} */
8886   @}
8887 @end smallexample
8889 Data prefetch does not generate faults if @var{addr} is invalid, but
8890 the address expression itself must be valid.  For example, a prefetch
8891 of @code{p->next} does not fault if @code{p->next} is not a valid
8892 address, but evaluation faults if @code{p} is not a valid address.
8894 If the target does not support data prefetch, the address expression
8895 is evaluated if it includes side effects but no other code is generated
8896 and GCC does not issue a warning.
8897 @end deftypefn
8899 @deftypefn {Built-in Function} double __builtin_huge_val (void)
8900 Returns a positive infinity, if supported by the floating-point format,
8901 else @code{DBL_MAX}.  This function is suitable for implementing the
8902 ISO C macro @code{HUGE_VAL}.
8903 @end deftypefn
8905 @deftypefn {Built-in Function} float __builtin_huge_valf (void)
8906 Similar to @code{__builtin_huge_val}, except the return type is @code{float}.
8907 @end deftypefn
8909 @deftypefn {Built-in Function} {long double} __builtin_huge_vall (void)
8910 Similar to @code{__builtin_huge_val}, except the return
8911 type is @code{long double}.
8912 @end deftypefn
8914 @deftypefn {Built-in Function} int __builtin_fpclassify (int, int, int, int, int, ...)
8915 This built-in implements the C99 fpclassify functionality.  The first
8916 five int arguments should be the target library's notion of the
8917 possible FP classes and are used for return values.  They must be
8918 constant values and they must appear in this order: @code{FP_NAN},
8919 @code{FP_INFINITE}, @code{FP_NORMAL}, @code{FP_SUBNORMAL} and
8920 @code{FP_ZERO}.  The ellipsis is for exactly one floating-point value
8921 to classify.  GCC treats the last argument as type-generic, which
8922 means it does not do default promotion from float to double.
8923 @end deftypefn
8925 @deftypefn {Built-in Function} double __builtin_inf (void)
8926 Similar to @code{__builtin_huge_val}, except a warning is generated
8927 if the target floating-point format does not support infinities.
8928 @end deftypefn
8930 @deftypefn {Built-in Function} _Decimal32 __builtin_infd32 (void)
8931 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal32}.
8932 @end deftypefn
8934 @deftypefn {Built-in Function} _Decimal64 __builtin_infd64 (void)
8935 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal64}.
8936 @end deftypefn
8938 @deftypefn {Built-in Function} _Decimal128 __builtin_infd128 (void)
8939 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal128}.
8940 @end deftypefn
8942 @deftypefn {Built-in Function} float __builtin_inff (void)
8943 Similar to @code{__builtin_inf}, except the return type is @code{float}.
8944 This function is suitable for implementing the ISO C99 macro @code{INFINITY}.
8945 @end deftypefn
8947 @deftypefn {Built-in Function} {long double} __builtin_infl (void)
8948 Similar to @code{__builtin_inf}, except the return
8949 type is @code{long double}.
8950 @end deftypefn
8952 @deftypefn {Built-in Function} int __builtin_isinf_sign (...)
8953 Similar to @code{isinf}, except the return value is -1 for
8954 an argument of @code{-Inf} and 1 for an argument of @code{+Inf}.
8955 Note while the parameter list is an
8956 ellipsis, this function only accepts exactly one floating-point
8957 argument.  GCC treats this parameter as type-generic, which means it
8958 does not do default promotion from float to double.
8959 @end deftypefn
8961 @deftypefn {Built-in Function} double __builtin_nan (const char *str)
8962 This is an implementation of the ISO C99 function @code{nan}.
8964 Since ISO C99 defines this function in terms of @code{strtod}, which we
8965 do not implement, a description of the parsing is in order.  The string
8966 is parsed as by @code{strtol}; that is, the base is recognized by
8967 leading @samp{0} or @samp{0x} prefixes.  The number parsed is placed
8968 in the significand such that the least significant bit of the number
8969 is at the least significant bit of the significand.  The number is
8970 truncated to fit the significand field provided.  The significand is
8971 forced to be a quiet NaN@.
8973 This function, if given a string literal all of which would have been
8974 consumed by @code{strtol}, is evaluated early enough that it is considered a
8975 compile-time constant.
8976 @end deftypefn
8978 @deftypefn {Built-in Function} _Decimal32 __builtin_nand32 (const char *str)
8979 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal32}.
8980 @end deftypefn
8982 @deftypefn {Built-in Function} _Decimal64 __builtin_nand64 (const char *str)
8983 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal64}.
8984 @end deftypefn
8986 @deftypefn {Built-in Function} _Decimal128 __builtin_nand128 (const char *str)
8987 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal128}.
8988 @end deftypefn
8990 @deftypefn {Built-in Function} float __builtin_nanf (const char *str)
8991 Similar to @code{__builtin_nan}, except the return type is @code{float}.
8992 @end deftypefn
8994 @deftypefn {Built-in Function} {long double} __builtin_nanl (const char *str)
8995 Similar to @code{__builtin_nan}, except the return type is @code{long double}.
8996 @end deftypefn
8998 @deftypefn {Built-in Function} double __builtin_nans (const char *str)
8999 Similar to @code{__builtin_nan}, except the significand is forced
9000 to be a signaling NaN@.  The @code{nans} function is proposed by
9001 @uref{http://www.open-std.org/jtc1/sc22/wg14/www/docs/n965.htm,,WG14 N965}.
9002 @end deftypefn
9004 @deftypefn {Built-in Function} float __builtin_nansf (const char *str)
9005 Similar to @code{__builtin_nans}, except the return type is @code{float}.
9006 @end deftypefn
9008 @deftypefn {Built-in Function} {long double} __builtin_nansl (const char *str)
9009 Similar to @code{__builtin_nans}, except the return type is @code{long double}.
9010 @end deftypefn
9012 @deftypefn {Built-in Function} int __builtin_ffs (int x)
9013 Returns one plus the index of the least significant 1-bit of @var{x}, or
9014 if @var{x} is zero, returns zero.
9015 @end deftypefn
9017 @deftypefn {Built-in Function} int __builtin_clz (unsigned int x)
9018 Returns the number of leading 0-bits in @var{x}, starting at the most
9019 significant bit position.  If @var{x} is 0, the result is undefined.
9020 @end deftypefn
9022 @deftypefn {Built-in Function} int __builtin_ctz (unsigned int x)
9023 Returns the number of trailing 0-bits in @var{x}, starting at the least
9024 significant bit position.  If @var{x} is 0, the result is undefined.
9025 @end deftypefn
9027 @deftypefn {Built-in Function} int __builtin_clrsb (int x)
9028 Returns the number of leading redundant sign bits in @var{x}, i.e.@: the
9029 number of bits following the most significant bit that are identical
9030 to it.  There are no special cases for 0 or other values. 
9031 @end deftypefn
9033 @deftypefn {Built-in Function} int __builtin_popcount (unsigned int x)
9034 Returns the number of 1-bits in @var{x}.
9035 @end deftypefn
9037 @deftypefn {Built-in Function} int __builtin_parity (unsigned int x)
9038 Returns the parity of @var{x}, i.e.@: the number of 1-bits in @var{x}
9039 modulo 2.
9040 @end deftypefn
9042 @deftypefn {Built-in Function} int __builtin_ffsl (long)
9043 Similar to @code{__builtin_ffs}, except the argument type is
9044 @code{long}.
9045 @end deftypefn
9047 @deftypefn {Built-in Function} int __builtin_clzl (unsigned long)
9048 Similar to @code{__builtin_clz}, except the argument type is
9049 @code{unsigned long}.
9050 @end deftypefn
9052 @deftypefn {Built-in Function} int __builtin_ctzl (unsigned long)
9053 Similar to @code{__builtin_ctz}, except the argument type is
9054 @code{unsigned long}.
9055 @end deftypefn
9057 @deftypefn {Built-in Function} int __builtin_clrsbl (long)
9058 Similar to @code{__builtin_clrsb}, except the argument type is
9059 @code{long}.
9060 @end deftypefn
9062 @deftypefn {Built-in Function} int __builtin_popcountl (unsigned long)
9063 Similar to @code{__builtin_popcount}, except the argument type is
9064 @code{unsigned long}.
9065 @end deftypefn
9067 @deftypefn {Built-in Function} int __builtin_parityl (unsigned long)
9068 Similar to @code{__builtin_parity}, except the argument type is
9069 @code{unsigned long}.
9070 @end deftypefn
9072 @deftypefn {Built-in Function} int __builtin_ffsll (long long)
9073 Similar to @code{__builtin_ffs}, except the argument type is
9074 @code{long long}.
9075 @end deftypefn
9077 @deftypefn {Built-in Function} int __builtin_clzll (unsigned long long)
9078 Similar to @code{__builtin_clz}, except the argument type is
9079 @code{unsigned long long}.
9080 @end deftypefn
9082 @deftypefn {Built-in Function} int __builtin_ctzll (unsigned long long)
9083 Similar to @code{__builtin_ctz}, except the argument type is
9084 @code{unsigned long long}.
9085 @end deftypefn
9087 @deftypefn {Built-in Function} int __builtin_clrsbll (long long)
9088 Similar to @code{__builtin_clrsb}, except the argument type is
9089 @code{long long}.
9090 @end deftypefn
9092 @deftypefn {Built-in Function} int __builtin_popcountll (unsigned long long)
9093 Similar to @code{__builtin_popcount}, except the argument type is
9094 @code{unsigned long long}.
9095 @end deftypefn
9097 @deftypefn {Built-in Function} int __builtin_parityll (unsigned long long)
9098 Similar to @code{__builtin_parity}, except the argument type is
9099 @code{unsigned long long}.
9100 @end deftypefn
9102 @deftypefn {Built-in Function} double __builtin_powi (double, int)
9103 Returns the first argument raised to the power of the second.  Unlike the
9104 @code{pow} function no guarantees about precision and rounding are made.
9105 @end deftypefn
9107 @deftypefn {Built-in Function} float __builtin_powif (float, int)
9108 Similar to @code{__builtin_powi}, except the argument and return types
9109 are @code{float}.
9110 @end deftypefn
9112 @deftypefn {Built-in Function} {long double} __builtin_powil (long double, int)
9113 Similar to @code{__builtin_powi}, except the argument and return types
9114 are @code{long double}.
9115 @end deftypefn
9117 @deftypefn {Built-in Function} uint16_t __builtin_bswap16 (uint16_t x)
9118 Returns @var{x} with the order of the bytes reversed; for example,
9119 @code{0xaabb} becomes @code{0xbbaa}.  Byte here always means
9120 exactly 8 bits.
9121 @end deftypefn
9123 @deftypefn {Built-in Function} uint32_t __builtin_bswap32 (uint32_t x)
9124 Similar to @code{__builtin_bswap16}, except the argument and return types
9125 are 32 bit.
9126 @end deftypefn
9128 @deftypefn {Built-in Function} uint64_t __builtin_bswap64 (uint64_t x)
9129 Similar to @code{__builtin_bswap32}, except the argument and return types
9130 are 64 bit.
9131 @end deftypefn
9133 @node Target Builtins
9134 @section Built-in Functions Specific to Particular Target Machines
9136 On some target machines, GCC supports many built-in functions specific
9137 to those machines.  Generally these generate calls to specific machine
9138 instructions, but allow the compiler to schedule those calls.
9140 @menu
9141 * Alpha Built-in Functions::
9142 * Altera Nios II Built-in Functions::
9143 * ARC Built-in Functions::
9144 * ARC SIMD Built-in Functions::
9145 * ARM iWMMXt Built-in Functions::
9146 * ARM NEON Intrinsics::
9147 * ARM ACLE Intrinsics::
9148 * AVR Built-in Functions::
9149 * Blackfin Built-in Functions::
9150 * FR-V Built-in Functions::
9151 * X86 Built-in Functions::
9152 * X86 transactional memory intrinsics::
9153 * MIPS DSP Built-in Functions::
9154 * MIPS Paired-Single Support::
9155 * MIPS Loongson Built-in Functions::
9156 * MIPS SIMD Architecture Functions::
9157 * Other MIPS Built-in Functions::
9158 * MSP430 Built-in Functions::
9159 * NDS32 Built-in Functions::
9160 * picoChip Built-in Functions::
9161 * PowerPC Built-in Functions::
9162 * PowerPC AltiVec/VSX Built-in Functions::
9163 * PowerPC Hardware Transactional Memory Built-in Functions::
9164 * RX Built-in Functions::
9165 * S/390 System z Built-in Functions::
9166 * SH Built-in Functions::
9167 * SPARC VIS Built-in Functions::
9168 * SPU Built-in Functions::
9169 * TI C6X Built-in Functions::
9170 * TILE-Gx Built-in Functions::
9171 * TILEPro Built-in Functions::
9172 @end menu
9174 @node Alpha Built-in Functions
9175 @subsection Alpha Built-in Functions
9177 These built-in functions are available for the Alpha family of
9178 processors, depending on the command-line switches used.
9180 The following built-in functions are always available.  They
9181 all generate the machine instruction that is part of the name.
9183 @smallexample
9184 long __builtin_alpha_implver (void)
9185 long __builtin_alpha_rpcc (void)
9186 long __builtin_alpha_amask (long)
9187 long __builtin_alpha_cmpbge (long, long)
9188 long __builtin_alpha_extbl (long, long)
9189 long __builtin_alpha_extwl (long, long)
9190 long __builtin_alpha_extll (long, long)
9191 long __builtin_alpha_extql (long, long)
9192 long __builtin_alpha_extwh (long, long)
9193 long __builtin_alpha_extlh (long, long)
9194 long __builtin_alpha_extqh (long, long)
9195 long __builtin_alpha_insbl (long, long)
9196 long __builtin_alpha_inswl (long, long)
9197 long __builtin_alpha_insll (long, long)
9198 long __builtin_alpha_insql (long, long)
9199 long __builtin_alpha_inswh (long, long)
9200 long __builtin_alpha_inslh (long, long)
9201 long __builtin_alpha_insqh (long, long)
9202 long __builtin_alpha_mskbl (long, long)
9203 long __builtin_alpha_mskwl (long, long)
9204 long __builtin_alpha_mskll (long, long)
9205 long __builtin_alpha_mskql (long, long)
9206 long __builtin_alpha_mskwh (long, long)
9207 long __builtin_alpha_msklh (long, long)
9208 long __builtin_alpha_mskqh (long, long)
9209 long __builtin_alpha_umulh (long, long)
9210 long __builtin_alpha_zap (long, long)
9211 long __builtin_alpha_zapnot (long, long)
9212 @end smallexample
9214 The following built-in functions are always with @option{-mmax}
9215 or @option{-mcpu=@var{cpu}} where @var{cpu} is @code{pca56} or
9216 later.  They all generate the machine instruction that is part
9217 of the name.
9219 @smallexample
9220 long __builtin_alpha_pklb (long)
9221 long __builtin_alpha_pkwb (long)
9222 long __builtin_alpha_unpkbl (long)
9223 long __builtin_alpha_unpkbw (long)
9224 long __builtin_alpha_minub8 (long, long)
9225 long __builtin_alpha_minsb8 (long, long)
9226 long __builtin_alpha_minuw4 (long, long)
9227 long __builtin_alpha_minsw4 (long, long)
9228 long __builtin_alpha_maxub8 (long, long)
9229 long __builtin_alpha_maxsb8 (long, long)
9230 long __builtin_alpha_maxuw4 (long, long)
9231 long __builtin_alpha_maxsw4 (long, long)
9232 long __builtin_alpha_perr (long, long)
9233 @end smallexample
9235 The following built-in functions are always with @option{-mcix}
9236 or @option{-mcpu=@var{cpu}} where @var{cpu} is @code{ev67} or
9237 later.  They all generate the machine instruction that is part
9238 of the name.
9240 @smallexample
9241 long __builtin_alpha_cttz (long)
9242 long __builtin_alpha_ctlz (long)
9243 long __builtin_alpha_ctpop (long)
9244 @end smallexample
9246 The following built-in functions are available on systems that use the OSF/1
9247 PALcode.  Normally they invoke the @code{rduniq} and @code{wruniq}
9248 PAL calls, but when invoked with @option{-mtls-kernel}, they invoke
9249 @code{rdval} and @code{wrval}.
9251 @smallexample
9252 void *__builtin_thread_pointer (void)
9253 void __builtin_set_thread_pointer (void *)
9254 @end smallexample
9256 @node Altera Nios II Built-in Functions
9257 @subsection Altera Nios II Built-in Functions
9259 These built-in functions are available for the Altera Nios II
9260 family of processors.
9262 The following built-in functions are always available.  They
9263 all generate the machine instruction that is part of the name.
9265 @example
9266 int __builtin_ldbio (volatile const void *)
9267 int __builtin_ldbuio (volatile const void *)
9268 int __builtin_ldhio (volatile const void *)
9269 int __builtin_ldhuio (volatile const void *)
9270 int __builtin_ldwio (volatile const void *)
9271 void __builtin_stbio (volatile void *, int)
9272 void __builtin_sthio (volatile void *, int)
9273 void __builtin_stwio (volatile void *, int)
9274 void __builtin_sync (void)
9275 int __builtin_rdctl (int) 
9276 void __builtin_wrctl (int, int)
9277 @end example
9279 The following built-in functions are always available.  They
9280 all generate a Nios II Custom Instruction. The name of the
9281 function represents the types that the function takes and
9282 returns. The letter before the @code{n} is the return type
9283 or void if absent. The @code{n} represents the first parameter
9284 to all the custom instructions, the custom instruction number.
9285 The two letters after the @code{n} represent the up to two
9286 parameters to the function.
9288 The letters represent the following data types:
9289 @table @code
9290 @item <no letter>
9291 @code{void} for return type and no parameter for parameter types.
9293 @item i
9294 @code{int} for return type and parameter type
9296 @item f
9297 @code{float} for return type and parameter type
9299 @item p
9300 @code{void *} for return type and parameter type
9302 @end table
9304 And the function names are:
9305 @example
9306 void __builtin_custom_n (void)
9307 void __builtin_custom_ni (int)
9308 void __builtin_custom_nf (float)
9309 void __builtin_custom_np (void *)
9310 void __builtin_custom_nii (int, int)
9311 void __builtin_custom_nif (int, float)
9312 void __builtin_custom_nip (int, void *)
9313 void __builtin_custom_nfi (float, int)
9314 void __builtin_custom_nff (float, float)
9315 void __builtin_custom_nfp (float, void *)
9316 void __builtin_custom_npi (void *, int)
9317 void __builtin_custom_npf (void *, float)
9318 void __builtin_custom_npp (void *, void *)
9319 int __builtin_custom_in (void)
9320 int __builtin_custom_ini (int)
9321 int __builtin_custom_inf (float)
9322 int __builtin_custom_inp (void *)
9323 int __builtin_custom_inii (int, int)
9324 int __builtin_custom_inif (int, float)
9325 int __builtin_custom_inip (int, void *)
9326 int __builtin_custom_infi (float, int)
9327 int __builtin_custom_inff (float, float)
9328 int __builtin_custom_infp (float, void *)
9329 int __builtin_custom_inpi (void *, int)
9330 int __builtin_custom_inpf (void *, float)
9331 int __builtin_custom_inpp (void *, void *)
9332 float __builtin_custom_fn (void)
9333 float __builtin_custom_fni (int)
9334 float __builtin_custom_fnf (float)
9335 float __builtin_custom_fnp (void *)
9336 float __builtin_custom_fnii (int, int)
9337 float __builtin_custom_fnif (int, float)
9338 float __builtin_custom_fnip (int, void *)
9339 float __builtin_custom_fnfi (float, int)
9340 float __builtin_custom_fnff (float, float)
9341 float __builtin_custom_fnfp (float, void *)
9342 float __builtin_custom_fnpi (void *, int)
9343 float __builtin_custom_fnpf (void *, float)
9344 float __builtin_custom_fnpp (void *, void *)
9345 void * __builtin_custom_pn (void)
9346 void * __builtin_custom_pni (int)
9347 void * __builtin_custom_pnf (float)
9348 void * __builtin_custom_pnp (void *)
9349 void * __builtin_custom_pnii (int, int)
9350 void * __builtin_custom_pnif (int, float)
9351 void * __builtin_custom_pnip (int, void *)
9352 void * __builtin_custom_pnfi (float, int)
9353 void * __builtin_custom_pnff (float, float)
9354 void * __builtin_custom_pnfp (float, void *)
9355 void * __builtin_custom_pnpi (void *, int)
9356 void * __builtin_custom_pnpf (void *, float)
9357 void * __builtin_custom_pnpp (void *, void *)
9358 @end example
9360 @node ARC Built-in Functions
9361 @subsection ARC Built-in Functions
9363 The following built-in functions are provided for ARC targets.  The
9364 built-ins generate the corresponding assembly instructions.  In the
9365 examples given below, the generated code often requires an operand or
9366 result to be in a register.  Where necessary further code will be
9367 generated to ensure this is true, but for brevity this is not
9368 described in each case.
9370 @emph{Note:} Using a built-in to generate an instruction not supported
9371 by a target may cause problems. At present the compiler is not
9372 guaranteed to detect such misuse, and as a result an internal compiler
9373 error may be generated.
9375 @deftypefn {Built-in Function} int __builtin_arc_aligned (void *@var{val}, int @var{alignval})
9376 Return 1 if @var{val} is known to have the byte alignment given
9377 by @var{alignval}, otherwise return 0.
9378 Note that this is different from
9379 @smallexample
9380 __alignof__(*(char *)@var{val}) >= alignval
9381 @end smallexample
9382 because __alignof__ sees only the type of the dereference, whereas
9383 __builtin_arc_align uses alignment information from the pointer
9384 as well as from the pointed-to type.
9385 The information available will depend on optimization level.
9386 @end deftypefn
9388 @deftypefn {Built-in Function} void __builtin_arc_brk (void)
9389 Generates
9390 @example
9392 @end example
9393 @end deftypefn
9395 @deftypefn {Built-in Function} {unsigned int} __builtin_arc_core_read (unsigned int @var{regno})
9396 The operand is the number of a register to be read.  Generates:
9397 @example
9398 mov  @var{dest}, r@var{regno}
9399 @end example
9400 where the value in @var{dest} will be the result returned from the
9401 built-in.
9402 @end deftypefn
9404 @deftypefn {Built-in Function} void __builtin_arc_core_write (unsigned int @var{regno}, unsigned int @var{val})
9405 The first operand is the number of a register to be written, the
9406 second operand is a compile time constant to write into that
9407 register.  Generates:
9408 @example
9409 mov  r@var{regno}, @var{val}
9410 @end example
9411 @end deftypefn
9413 @deftypefn {Built-in Function} int __builtin_arc_divaw (int @var{a}, int @var{b})
9414 Only available if either @option{-mcpu=ARC700} or @option{-meA} is set.
9415 Generates:
9416 @example
9417 divaw  @var{dest}, @var{a}, @var{b}
9418 @end example
9419 where the value in @var{dest} will be the result returned from the
9420 built-in.
9421 @end deftypefn
9423 @deftypefn {Built-in Function} void __builtin_arc_flag (unsigned int @var{a})
9424 Generates
9425 @example
9426 flag  @var{a}
9427 @end example
9428 @end deftypefn
9430 @deftypefn {Built-in Function} {unsigned int} __builtin_arc_lr (unsigned int @var{auxr})
9431 The operand, @var{auxv}, is the address of an auxiliary register and
9432 must be a compile time constant.  Generates:
9433 @example
9434 lr  @var{dest}, [@var{auxr}]
9435 @end example
9436 Where the value in @var{dest} will be the result returned from the
9437 built-in.
9438 @end deftypefn
9440 @deftypefn {Built-in Function} void __builtin_arc_mul64 (int @var{a}, int @var{b})
9441 Only available with @option{-mmul64}.  Generates:
9442 @example
9443 mul64  @var{a}, @var{b}
9444 @end example
9445 @end deftypefn
9447 @deftypefn {Built-in Function} void __builtin_arc_mulu64 (unsigned int @var{a}, unsigned int @var{b})
9448 Only available with @option{-mmul64}.  Generates:
9449 @example
9450 mulu64  @var{a}, @var{b}
9451 @end example
9452 @end deftypefn
9454 @deftypefn {Built-in Function} void __builtin_arc_nop (void)
9455 Generates:
9456 @example
9458 @end example
9459 @end deftypefn
9461 @deftypefn {Built-in Function} int __builtin_arc_norm (int @var{src})
9462 Only valid if the @samp{norm} instruction is available through the
9463 @option{-mnorm} option or by default with @option{-mcpu=ARC700}.
9464 Generates:
9465 @example
9466 norm  @var{dest}, @var{src}
9467 @end example
9468 Where the value in @var{dest} will be the result returned from the
9469 built-in.
9470 @end deftypefn
9472 @deftypefn {Built-in Function}  {short int} __builtin_arc_normw (short int @var{src})
9473 Only valid if the @samp{normw} instruction is available through the
9474 @option{-mnorm} option or by default with @option{-mcpu=ARC700}.
9475 Generates:
9476 @example
9477 normw  @var{dest}, @var{src}
9478 @end example
9479 Where the value in @var{dest} will be the result returned from the
9480 built-in.
9481 @end deftypefn
9483 @deftypefn {Built-in Function}  void __builtin_arc_rtie (void)
9484 Generates:
9485 @example
9486 rtie
9487 @end example
9488 @end deftypefn
9490 @deftypefn {Built-in Function}  void __builtin_arc_sleep (int @var{a}
9491 Generates:
9492 @example
9493 sleep  @var{a}
9494 @end example
9495 @end deftypefn
9497 @deftypefn {Built-in Function}  void __builtin_arc_sr (unsigned int @var{auxr}, unsigned int @var{val})
9498 The first argument, @var{auxv}, is the address of an auxiliary
9499 register, the second argument, @var{val}, is a compile time constant
9500 to be written to the register.  Generates:
9501 @example
9502 sr  @var{auxr}, [@var{val}]
9503 @end example
9504 @end deftypefn
9506 @deftypefn {Built-in Function}  int __builtin_arc_swap (int @var{src})
9507 Only valid with @option{-mswap}.  Generates:
9508 @example
9509 swap  @var{dest}, @var{src}
9510 @end example
9511 Where the value in @var{dest} will be the result returned from the
9512 built-in.
9513 @end deftypefn
9515 @deftypefn {Built-in Function}  void __builtin_arc_swi (void)
9516 Generates:
9517 @example
9519 @end example
9520 @end deftypefn
9522 @deftypefn {Built-in Function}  void __builtin_arc_sync (void)
9523 Only available with @option{-mcpu=ARC700}.  Generates:
9524 @example
9525 sync
9526 @end example
9527 @end deftypefn
9529 @deftypefn {Built-in Function}  void __builtin_arc_trap_s (unsigned int @var{c})
9530 Only available with @option{-mcpu=ARC700}.  Generates:
9531 @example
9532 trap_s  @var{c}
9533 @end example
9534 @end deftypefn
9536 @deftypefn {Built-in Function}  void __builtin_arc_unimp_s (void)
9537 Only available with @option{-mcpu=ARC700}.  Generates:
9538 @example
9539 unimp_s
9540 @end example
9541 @end deftypefn
9543 The instructions generated by the following builtins are not
9544 considered as candidates for scheduling.  They are not moved around by
9545 the compiler during scheduling, and thus can be expected to appear
9546 where they are put in the C code:
9547 @example
9548 __builtin_arc_brk()
9549 __builtin_arc_core_read()
9550 __builtin_arc_core_write()
9551 __builtin_arc_flag()
9552 __builtin_arc_lr()
9553 __builtin_arc_sleep()
9554 __builtin_arc_sr()
9555 __builtin_arc_swi()
9556 @end example
9558 @node ARC SIMD Built-in Functions
9559 @subsection ARC SIMD Built-in Functions
9561 SIMD builtins provided by the compiler can be used to generate the
9562 vector instructions.  This section describes the available builtins
9563 and their usage in programs.  With the @option{-msimd} option, the
9564 compiler provides 128-bit vector types, which can be specified using
9565 the @code{vector_size} attribute.  The header file @file{arc-simd.h}
9566 can be included to use the following predefined types:
9567 @example
9568 typedef int __v4si   __attribute__((vector_size(16)));
9569 typedef short __v8hi __attribute__((vector_size(16)));
9570 @end example
9572 These types can be used to define 128-bit variables.  The built-in
9573 functions listed in the following section can be used on these
9574 variables to generate the vector operations.
9576 For all builtins, @code{__builtin_arc_@var{someinsn}}, the header file
9577 @file{arc-simd.h} also provides equivalent macros called
9578 @code{_@var{someinsn}} that can be used for programming ease and
9579 improved readability.  The following macros for DMA control are also
9580 provided:
9581 @example
9582 #define _setup_dma_in_channel_reg _vdiwr
9583 #define _setup_dma_out_channel_reg _vdowr
9584 @end example
9586 The following is a complete list of all the SIMD built-ins provided
9587 for ARC, grouped by calling signature.
9589 The following take two @code{__v8hi} arguments and return a
9590 @code{__v8hi} result:
9591 @example
9592 __v8hi __builtin_arc_vaddaw (__v8hi, __v8hi)
9593 __v8hi __builtin_arc_vaddw (__v8hi, __v8hi)
9594 __v8hi __builtin_arc_vand (__v8hi, __v8hi)
9595 __v8hi __builtin_arc_vandaw (__v8hi, __v8hi)
9596 __v8hi __builtin_arc_vavb (__v8hi, __v8hi)
9597 __v8hi __builtin_arc_vavrb (__v8hi, __v8hi)
9598 __v8hi __builtin_arc_vbic (__v8hi, __v8hi)
9599 __v8hi __builtin_arc_vbicaw (__v8hi, __v8hi)
9600 __v8hi __builtin_arc_vdifaw (__v8hi, __v8hi)
9601 __v8hi __builtin_arc_vdifw (__v8hi, __v8hi)
9602 __v8hi __builtin_arc_veqw (__v8hi, __v8hi)
9603 __v8hi __builtin_arc_vh264f (__v8hi, __v8hi)
9604 __v8hi __builtin_arc_vh264ft (__v8hi, __v8hi)
9605 __v8hi __builtin_arc_vh264fw (__v8hi, __v8hi)
9606 __v8hi __builtin_arc_vlew (__v8hi, __v8hi)
9607 __v8hi __builtin_arc_vltw (__v8hi, __v8hi)
9608 __v8hi __builtin_arc_vmaxaw (__v8hi, __v8hi)
9609 __v8hi __builtin_arc_vmaxw (__v8hi, __v8hi)
9610 __v8hi __builtin_arc_vminaw (__v8hi, __v8hi)
9611 __v8hi __builtin_arc_vminw (__v8hi, __v8hi)
9612 __v8hi __builtin_arc_vmr1aw (__v8hi, __v8hi)
9613 __v8hi __builtin_arc_vmr1w (__v8hi, __v8hi)
9614 __v8hi __builtin_arc_vmr2aw (__v8hi, __v8hi)
9615 __v8hi __builtin_arc_vmr2w (__v8hi, __v8hi)
9616 __v8hi __builtin_arc_vmr3aw (__v8hi, __v8hi)
9617 __v8hi __builtin_arc_vmr3w (__v8hi, __v8hi)
9618 __v8hi __builtin_arc_vmr4aw (__v8hi, __v8hi)
9619 __v8hi __builtin_arc_vmr4w (__v8hi, __v8hi)
9620 __v8hi __builtin_arc_vmr5aw (__v8hi, __v8hi)
9621 __v8hi __builtin_arc_vmr5w (__v8hi, __v8hi)
9622 __v8hi __builtin_arc_vmr6aw (__v8hi, __v8hi)
9623 __v8hi __builtin_arc_vmr6w (__v8hi, __v8hi)
9624 __v8hi __builtin_arc_vmr7aw (__v8hi, __v8hi)
9625 __v8hi __builtin_arc_vmr7w (__v8hi, __v8hi)
9626 __v8hi __builtin_arc_vmrb (__v8hi, __v8hi)
9627 __v8hi __builtin_arc_vmulaw (__v8hi, __v8hi)
9628 __v8hi __builtin_arc_vmulfaw (__v8hi, __v8hi)
9629 __v8hi __builtin_arc_vmulfw (__v8hi, __v8hi)
9630 __v8hi __builtin_arc_vmulw (__v8hi, __v8hi)
9631 __v8hi __builtin_arc_vnew (__v8hi, __v8hi)
9632 __v8hi __builtin_arc_vor (__v8hi, __v8hi)
9633 __v8hi __builtin_arc_vsubaw (__v8hi, __v8hi)
9634 __v8hi __builtin_arc_vsubw (__v8hi, __v8hi)
9635 __v8hi __builtin_arc_vsummw (__v8hi, __v8hi)
9636 __v8hi __builtin_arc_vvc1f (__v8hi, __v8hi)
9637 __v8hi __builtin_arc_vvc1ft (__v8hi, __v8hi)
9638 __v8hi __builtin_arc_vxor (__v8hi, __v8hi)
9639 __v8hi __builtin_arc_vxoraw (__v8hi, __v8hi)
9640 @end example
9642 The following take one @code{__v8hi} and one @code{int} argument and return a
9643 @code{__v8hi} result:
9645 @example
9646 __v8hi __builtin_arc_vbaddw (__v8hi, int)
9647 __v8hi __builtin_arc_vbmaxw (__v8hi, int)
9648 __v8hi __builtin_arc_vbminw (__v8hi, int)
9649 __v8hi __builtin_arc_vbmulaw (__v8hi, int)
9650 __v8hi __builtin_arc_vbmulfw (__v8hi, int)
9651 __v8hi __builtin_arc_vbmulw (__v8hi, int)
9652 __v8hi __builtin_arc_vbrsubw (__v8hi, int)
9653 __v8hi __builtin_arc_vbsubw (__v8hi, int)
9654 @end example
9656 The following take one @code{__v8hi} argument and one @code{int} argument which
9657 must be a 3-bit compile time constant indicating a register number
9658 I0-I7.  They return a @code{__v8hi} result.
9659 @example
9660 __v8hi __builtin_arc_vasrw (__v8hi, const int)
9661 __v8hi __builtin_arc_vsr8 (__v8hi, const int)
9662 __v8hi __builtin_arc_vsr8aw (__v8hi, const int)
9663 @end example
9665 The following take one @code{__v8hi} argument and one @code{int}
9666 argument which must be a 6-bit compile time constant.  They return a
9667 @code{__v8hi} result.
9668 @example
9669 __v8hi __builtin_arc_vasrpwbi (__v8hi, const int)
9670 __v8hi __builtin_arc_vasrrpwbi (__v8hi, const int)
9671 __v8hi __builtin_arc_vasrrwi (__v8hi, const int)
9672 __v8hi __builtin_arc_vasrsrwi (__v8hi, const int)
9673 __v8hi __builtin_arc_vasrwi (__v8hi, const int)
9674 __v8hi __builtin_arc_vsr8awi (__v8hi, const int)
9675 __v8hi __builtin_arc_vsr8i (__v8hi, const int)
9676 @end example
9678 The following take one @code{__v8hi} argument and one @code{int} argument which
9679 must be a 8-bit compile time constant.  They return a @code{__v8hi}
9680 result.
9681 @example
9682 __v8hi __builtin_arc_vd6tapf (__v8hi, const int)
9683 __v8hi __builtin_arc_vmvaw (__v8hi, const int)
9684 __v8hi __builtin_arc_vmvw (__v8hi, const int)
9685 __v8hi __builtin_arc_vmvzw (__v8hi, const int)
9686 @end example
9688 The following take two @code{int} arguments, the second of which which
9689 must be a 8-bit compile time constant.  They return a @code{__v8hi}
9690 result:
9691 @example
9692 __v8hi __builtin_arc_vmovaw (int, const int)
9693 __v8hi __builtin_arc_vmovw (int, const int)
9694 __v8hi __builtin_arc_vmovzw (int, const int)
9695 @end example
9697 The following take a single @code{__v8hi} argument and return a
9698 @code{__v8hi} result:
9699 @example
9700 __v8hi __builtin_arc_vabsaw (__v8hi)
9701 __v8hi __builtin_arc_vabsw (__v8hi)
9702 __v8hi __builtin_arc_vaddsuw (__v8hi)
9703 __v8hi __builtin_arc_vexch1 (__v8hi)
9704 __v8hi __builtin_arc_vexch2 (__v8hi)
9705 __v8hi __builtin_arc_vexch4 (__v8hi)
9706 __v8hi __builtin_arc_vsignw (__v8hi)
9707 __v8hi __builtin_arc_vupbaw (__v8hi)
9708 __v8hi __builtin_arc_vupbw (__v8hi)
9709 __v8hi __builtin_arc_vupsbaw (__v8hi)
9710 __v8hi __builtin_arc_vupsbw (__v8hi)
9711 @end example
9713 The followign take two @code{int} arguments and return no result:
9714 @example
9715 void __builtin_arc_vdirun (int, int)
9716 void __builtin_arc_vdorun (int, int)
9717 @end example
9719 The following take two @code{int} arguments and return no result.  The
9720 first argument must a 3-bit compile time constant indicating one of
9721 the DR0-DR7 DMA setup channels:
9722 @example
9723 void __builtin_arc_vdiwr (const int, int)
9724 void __builtin_arc_vdowr (const int, int)
9725 @end example
9727 The following take an @code{int} argument and return no result:
9728 @example
9729 void __builtin_arc_vendrec (int)
9730 void __builtin_arc_vrec (int)
9731 void __builtin_arc_vrecrun (int)
9732 void __builtin_arc_vrun (int)
9733 @end example
9735 The following take a @code{__v8hi} argument and two @code{int}
9736 arguments and return a @code{__v8hi} result.  The second argument must
9737 be a 3-bit compile time constants, indicating one the registers I0-I7,
9738 and the third argument must be an 8-bit compile time constant.
9740 @emph{Note:} Although the equivalent hardware instructions do not take
9741 an SIMD register as an operand, these builtins overwrite the relevant
9742 bits of the @code{__v8hi} register provided as the first argument with
9743 the value loaded from the @code{[Ib, u8]} location in the SDM.
9745 @example
9746 __v8hi __builtin_arc_vld32 (__v8hi, const int, const int)
9747 __v8hi __builtin_arc_vld32wh (__v8hi, const int, const int)
9748 __v8hi __builtin_arc_vld32wl (__v8hi, const int, const int)
9749 __v8hi __builtin_arc_vld64 (__v8hi, const int, const int)
9750 @end example
9752 The following take two @code{int} arguments and return a @code{__v8hi}
9753 result.  The first argument must be a 3-bit compile time constants,
9754 indicating one the registers I0-I7, and the second argument must be an
9755 8-bit compile time constant.
9757 @example
9758 __v8hi __builtin_arc_vld128 (const int, const int)
9759 __v8hi __builtin_arc_vld64w (const int, const int)
9760 @end example
9762 The following take a @code{__v8hi} argument and two @code{int}
9763 arguments and return no result.  The second argument must be a 3-bit
9764 compile time constants, indicating one the registers I0-I7, and the
9765 third argument must be an 8-bit compile time constant.
9767 @example
9768 void __builtin_arc_vst128 (__v8hi, const int, const int)
9769 void __builtin_arc_vst64 (__v8hi, const int, const int)
9770 @end example
9772 The following take a @code{__v8hi} argument and three @code{int}
9773 arguments and return no result.  The second argument must be a 3-bit
9774 compile-time constant, identifying the 16-bit sub-register to be
9775 stored, the third argument must be a 3-bit compile time constants,
9776 indicating one the registers I0-I7, and the fourth argument must be an
9777 8-bit compile time constant.
9779 @example
9780 void __builtin_arc_vst16_n (__v8hi, const int, const int, const int)
9781 void __builtin_arc_vst32_n (__v8hi, const int, const int, const int)
9782 @end example
9784 @node ARM iWMMXt Built-in Functions
9785 @subsection ARM iWMMXt Built-in Functions
9787 These built-in functions are available for the ARM family of
9788 processors when the @option{-mcpu=iwmmxt} switch is used:
9790 @smallexample
9791 typedef int v2si __attribute__ ((vector_size (8)));
9792 typedef short v4hi __attribute__ ((vector_size (8)));
9793 typedef char v8qi __attribute__ ((vector_size (8)));
9795 int __builtin_arm_getwcgr0 (void)
9796 void __builtin_arm_setwcgr0 (int)
9797 int __builtin_arm_getwcgr1 (void)
9798 void __builtin_arm_setwcgr1 (int)
9799 int __builtin_arm_getwcgr2 (void)
9800 void __builtin_arm_setwcgr2 (int)
9801 int __builtin_arm_getwcgr3 (void)
9802 void __builtin_arm_setwcgr3 (int)
9803 int __builtin_arm_textrmsb (v8qi, int)
9804 int __builtin_arm_textrmsh (v4hi, int)
9805 int __builtin_arm_textrmsw (v2si, int)
9806 int __builtin_arm_textrmub (v8qi, int)
9807 int __builtin_arm_textrmuh (v4hi, int)
9808 int __builtin_arm_textrmuw (v2si, int)
9809 v8qi __builtin_arm_tinsrb (v8qi, int, int)
9810 v4hi __builtin_arm_tinsrh (v4hi, int, int)
9811 v2si __builtin_arm_tinsrw (v2si, int, int)
9812 long long __builtin_arm_tmia (long long, int, int)
9813 long long __builtin_arm_tmiabb (long long, int, int)
9814 long long __builtin_arm_tmiabt (long long, int, int)
9815 long long __builtin_arm_tmiaph (long long, int, int)
9816 long long __builtin_arm_tmiatb (long long, int, int)
9817 long long __builtin_arm_tmiatt (long long, int, int)
9818 int __builtin_arm_tmovmskb (v8qi)
9819 int __builtin_arm_tmovmskh (v4hi)
9820 int __builtin_arm_tmovmskw (v2si)
9821 long long __builtin_arm_waccb (v8qi)
9822 long long __builtin_arm_wacch (v4hi)
9823 long long __builtin_arm_waccw (v2si)
9824 v8qi __builtin_arm_waddb (v8qi, v8qi)
9825 v8qi __builtin_arm_waddbss (v8qi, v8qi)
9826 v8qi __builtin_arm_waddbus (v8qi, v8qi)
9827 v4hi __builtin_arm_waddh (v4hi, v4hi)
9828 v4hi __builtin_arm_waddhss (v4hi, v4hi)
9829 v4hi __builtin_arm_waddhus (v4hi, v4hi)
9830 v2si __builtin_arm_waddw (v2si, v2si)
9831 v2si __builtin_arm_waddwss (v2si, v2si)
9832 v2si __builtin_arm_waddwus (v2si, v2si)
9833 v8qi __builtin_arm_walign (v8qi, v8qi, int)
9834 long long __builtin_arm_wand(long long, long long)
9835 long long __builtin_arm_wandn (long long, long long)
9836 v8qi __builtin_arm_wavg2b (v8qi, v8qi)
9837 v8qi __builtin_arm_wavg2br (v8qi, v8qi)
9838 v4hi __builtin_arm_wavg2h (v4hi, v4hi)
9839 v4hi __builtin_arm_wavg2hr (v4hi, v4hi)
9840 v8qi __builtin_arm_wcmpeqb (v8qi, v8qi)
9841 v4hi __builtin_arm_wcmpeqh (v4hi, v4hi)
9842 v2si __builtin_arm_wcmpeqw (v2si, v2si)
9843 v8qi __builtin_arm_wcmpgtsb (v8qi, v8qi)
9844 v4hi __builtin_arm_wcmpgtsh (v4hi, v4hi)
9845 v2si __builtin_arm_wcmpgtsw (v2si, v2si)
9846 v8qi __builtin_arm_wcmpgtub (v8qi, v8qi)
9847 v4hi __builtin_arm_wcmpgtuh (v4hi, v4hi)
9848 v2si __builtin_arm_wcmpgtuw (v2si, v2si)
9849 long long __builtin_arm_wmacs (long long, v4hi, v4hi)
9850 long long __builtin_arm_wmacsz (v4hi, v4hi)
9851 long long __builtin_arm_wmacu (long long, v4hi, v4hi)
9852 long long __builtin_arm_wmacuz (v4hi, v4hi)
9853 v4hi __builtin_arm_wmadds (v4hi, v4hi)
9854 v4hi __builtin_arm_wmaddu (v4hi, v4hi)
9855 v8qi __builtin_arm_wmaxsb (v8qi, v8qi)
9856 v4hi __builtin_arm_wmaxsh (v4hi, v4hi)
9857 v2si __builtin_arm_wmaxsw (v2si, v2si)
9858 v8qi __builtin_arm_wmaxub (v8qi, v8qi)
9859 v4hi __builtin_arm_wmaxuh (v4hi, v4hi)
9860 v2si __builtin_arm_wmaxuw (v2si, v2si)
9861 v8qi __builtin_arm_wminsb (v8qi, v8qi)
9862 v4hi __builtin_arm_wminsh (v4hi, v4hi)
9863 v2si __builtin_arm_wminsw (v2si, v2si)
9864 v8qi __builtin_arm_wminub (v8qi, v8qi)
9865 v4hi __builtin_arm_wminuh (v4hi, v4hi)
9866 v2si __builtin_arm_wminuw (v2si, v2si)
9867 v4hi __builtin_arm_wmulsm (v4hi, v4hi)
9868 v4hi __builtin_arm_wmulul (v4hi, v4hi)
9869 v4hi __builtin_arm_wmulum (v4hi, v4hi)
9870 long long __builtin_arm_wor (long long, long long)
9871 v2si __builtin_arm_wpackdss (long long, long long)
9872 v2si __builtin_arm_wpackdus (long long, long long)
9873 v8qi __builtin_arm_wpackhss (v4hi, v4hi)
9874 v8qi __builtin_arm_wpackhus (v4hi, v4hi)
9875 v4hi __builtin_arm_wpackwss (v2si, v2si)
9876 v4hi __builtin_arm_wpackwus (v2si, v2si)
9877 long long __builtin_arm_wrord (long long, long long)
9878 long long __builtin_arm_wrordi (long long, int)
9879 v4hi __builtin_arm_wrorh (v4hi, long long)
9880 v4hi __builtin_arm_wrorhi (v4hi, int)
9881 v2si __builtin_arm_wrorw (v2si, long long)
9882 v2si __builtin_arm_wrorwi (v2si, int)
9883 v2si __builtin_arm_wsadb (v2si, v8qi, v8qi)
9884 v2si __builtin_arm_wsadbz (v8qi, v8qi)
9885 v2si __builtin_arm_wsadh (v2si, v4hi, v4hi)
9886 v2si __builtin_arm_wsadhz (v4hi, v4hi)
9887 v4hi __builtin_arm_wshufh (v4hi, int)
9888 long long __builtin_arm_wslld (long long, long long)
9889 long long __builtin_arm_wslldi (long long, int)
9890 v4hi __builtin_arm_wsllh (v4hi, long long)
9891 v4hi __builtin_arm_wsllhi (v4hi, int)
9892 v2si __builtin_arm_wsllw (v2si, long long)
9893 v2si __builtin_arm_wsllwi (v2si, int)
9894 long long __builtin_arm_wsrad (long long, long long)
9895 long long __builtin_arm_wsradi (long long, int)
9896 v4hi __builtin_arm_wsrah (v4hi, long long)
9897 v4hi __builtin_arm_wsrahi (v4hi, int)
9898 v2si __builtin_arm_wsraw (v2si, long long)
9899 v2si __builtin_arm_wsrawi (v2si, int)
9900 long long __builtin_arm_wsrld (long long, long long)
9901 long long __builtin_arm_wsrldi (long long, int)
9902 v4hi __builtin_arm_wsrlh (v4hi, long long)
9903 v4hi __builtin_arm_wsrlhi (v4hi, int)
9904 v2si __builtin_arm_wsrlw (v2si, long long)
9905 v2si __builtin_arm_wsrlwi (v2si, int)
9906 v8qi __builtin_arm_wsubb (v8qi, v8qi)
9907 v8qi __builtin_arm_wsubbss (v8qi, v8qi)
9908 v8qi __builtin_arm_wsubbus (v8qi, v8qi)
9909 v4hi __builtin_arm_wsubh (v4hi, v4hi)
9910 v4hi __builtin_arm_wsubhss (v4hi, v4hi)
9911 v4hi __builtin_arm_wsubhus (v4hi, v4hi)
9912 v2si __builtin_arm_wsubw (v2si, v2si)
9913 v2si __builtin_arm_wsubwss (v2si, v2si)
9914 v2si __builtin_arm_wsubwus (v2si, v2si)
9915 v4hi __builtin_arm_wunpckehsb (v8qi)
9916 v2si __builtin_arm_wunpckehsh (v4hi)
9917 long long __builtin_arm_wunpckehsw (v2si)
9918 v4hi __builtin_arm_wunpckehub (v8qi)
9919 v2si __builtin_arm_wunpckehuh (v4hi)
9920 long long __builtin_arm_wunpckehuw (v2si)
9921 v4hi __builtin_arm_wunpckelsb (v8qi)
9922 v2si __builtin_arm_wunpckelsh (v4hi)
9923 long long __builtin_arm_wunpckelsw (v2si)
9924 v4hi __builtin_arm_wunpckelub (v8qi)
9925 v2si __builtin_arm_wunpckeluh (v4hi)
9926 long long __builtin_arm_wunpckeluw (v2si)
9927 v8qi __builtin_arm_wunpckihb (v8qi, v8qi)
9928 v4hi __builtin_arm_wunpckihh (v4hi, v4hi)
9929 v2si __builtin_arm_wunpckihw (v2si, v2si)
9930 v8qi __builtin_arm_wunpckilb (v8qi, v8qi)
9931 v4hi __builtin_arm_wunpckilh (v4hi, v4hi)
9932 v2si __builtin_arm_wunpckilw (v2si, v2si)
9933 long long __builtin_arm_wxor (long long, long long)
9934 long long __builtin_arm_wzero ()
9935 @end smallexample
9937 @node ARM NEON Intrinsics
9938 @subsection ARM NEON Intrinsics
9940 These built-in intrinsics for the ARM Advanced SIMD extension are available
9941 when the @option{-mfpu=neon} switch is used:
9943 @include arm-neon-intrinsics.texi
9945 @node ARM ACLE Intrinsics
9946 @subsection ARM ACLE Intrinsics
9948 @include arm-acle-intrinsics.texi
9950 @node AVR Built-in Functions
9951 @subsection AVR Built-in Functions
9953 For each built-in function for AVR, there is an equally named,
9954 uppercase built-in macro defined. That way users can easily query if
9955 or if not a specific built-in is implemented or not. For example, if
9956 @code{__builtin_avr_nop} is available the macro
9957 @code{__BUILTIN_AVR_NOP} is defined to @code{1} and undefined otherwise.
9959 The following built-in functions map to the respective machine
9960 instruction, i.e.@: @code{nop}, @code{sei}, @code{cli}, @code{sleep},
9961 @code{wdr}, @code{swap}, @code{fmul}, @code{fmuls}
9962 resp. @code{fmulsu}. The three @code{fmul*} built-ins are implemented
9963 as library call if no hardware multiplier is available.
9965 @smallexample
9966 void __builtin_avr_nop (void)
9967 void __builtin_avr_sei (void)
9968 void __builtin_avr_cli (void)
9969 void __builtin_avr_sleep (void)
9970 void __builtin_avr_wdr (void)
9971 unsigned char __builtin_avr_swap (unsigned char)
9972 unsigned int __builtin_avr_fmul (unsigned char, unsigned char)
9973 int __builtin_avr_fmuls (char, char)
9974 int __builtin_avr_fmulsu (char, unsigned char)
9975 @end smallexample
9977 In order to delay execution for a specific number of cycles, GCC
9978 implements
9979 @smallexample
9980 void __builtin_avr_delay_cycles (unsigned long ticks)
9981 @end smallexample
9983 @noindent
9984 @code{ticks} is the number of ticks to delay execution. Note that this
9985 built-in does not take into account the effect of interrupts that
9986 might increase delay time. @code{ticks} must be a compile-time
9987 integer constant; delays with a variable number of cycles are not supported.
9989 @smallexample
9990 char __builtin_avr_flash_segment (const __memx void*)
9991 @end smallexample
9993 @noindent
9994 This built-in takes a byte address to the 24-bit
9995 @ref{AVR Named Address Spaces,address space} @code{__memx} and returns
9996 the number of the flash segment (the 64 KiB chunk) where the address
9997 points to.  Counting starts at @code{0}.
9998 If the address does not point to flash memory, return @code{-1}.
10000 @smallexample
10001 unsigned char __builtin_avr_insert_bits (unsigned long map, unsigned char bits, unsigned char val)
10002 @end smallexample
10004 @noindent
10005 Insert bits from @var{bits} into @var{val} and return the resulting
10006 value. The nibbles of @var{map} determine how the insertion is
10007 performed: Let @var{X} be the @var{n}-th nibble of @var{map}
10008 @enumerate
10009 @item If @var{X} is @code{0xf},
10010 then the @var{n}-th bit of @var{val} is returned unaltered.
10012 @item If X is in the range 0@dots{}7,
10013 then the @var{n}-th result bit is set to the @var{X}-th bit of @var{bits}
10015 @item If X is in the range 8@dots{}@code{0xe},
10016 then the @var{n}-th result bit is undefined.
10017 @end enumerate
10019 @noindent
10020 One typical use case for this built-in is adjusting input and
10021 output values to non-contiguous port layouts. Some examples:
10023 @smallexample
10024 // same as val, bits is unused
10025 __builtin_avr_insert_bits (0xffffffff, bits, val)
10026 @end smallexample
10028 @smallexample
10029 // same as bits, val is unused
10030 __builtin_avr_insert_bits (0x76543210, bits, val)
10031 @end smallexample
10033 @smallexample
10034 // same as rotating bits by 4
10035 __builtin_avr_insert_bits (0x32107654, bits, 0)
10036 @end smallexample
10038 @smallexample
10039 // high nibble of result is the high nibble of val
10040 // low nibble of result is the low nibble of bits
10041 __builtin_avr_insert_bits (0xffff3210, bits, val)
10042 @end smallexample
10044 @smallexample
10045 // reverse the bit order of bits
10046 __builtin_avr_insert_bits (0x01234567, bits, 0)
10047 @end smallexample
10049 @node Blackfin Built-in Functions
10050 @subsection Blackfin Built-in Functions
10052 Currently, there are two Blackfin-specific built-in functions.  These are
10053 used for generating @code{CSYNC} and @code{SSYNC} machine insns without
10054 using inline assembly; by using these built-in functions the compiler can
10055 automatically add workarounds for hardware errata involving these
10056 instructions.  These functions are named as follows:
10058 @smallexample
10059 void __builtin_bfin_csync (void)
10060 void __builtin_bfin_ssync (void)
10061 @end smallexample
10063 @node FR-V Built-in Functions
10064 @subsection FR-V Built-in Functions
10066 GCC provides many FR-V-specific built-in functions.  In general,
10067 these functions are intended to be compatible with those described
10068 by @cite{FR-V Family, Softune C/C++ Compiler Manual (V6), Fujitsu
10069 Semiconductor}.  The two exceptions are @code{__MDUNPACKH} and
10070 @code{__MBTOHE}, the GCC forms of which pass 128-bit values by
10071 pointer rather than by value.
10073 Most of the functions are named after specific FR-V instructions.
10074 Such functions are said to be ``directly mapped'' and are summarized
10075 here in tabular form.
10077 @menu
10078 * Argument Types::
10079 * Directly-mapped Integer Functions::
10080 * Directly-mapped Media Functions::
10081 * Raw read/write Functions::
10082 * Other Built-in Functions::
10083 @end menu
10085 @node Argument Types
10086 @subsubsection Argument Types
10088 The arguments to the built-in functions can be divided into three groups:
10089 register numbers, compile-time constants and run-time values.  In order
10090 to make this classification clear at a glance, the arguments and return
10091 values are given the following pseudo types:
10093 @multitable @columnfractions .20 .30 .15 .35
10094 @item Pseudo type @tab Real C type @tab Constant? @tab Description
10095 @item @code{uh} @tab @code{unsigned short} @tab No @tab an unsigned halfword
10096 @item @code{uw1} @tab @code{unsigned int} @tab No @tab an unsigned word
10097 @item @code{sw1} @tab @code{int} @tab No @tab a signed word
10098 @item @code{uw2} @tab @code{unsigned long long} @tab No
10099 @tab an unsigned doubleword
10100 @item @code{sw2} @tab @code{long long} @tab No @tab a signed doubleword
10101 @item @code{const} @tab @code{int} @tab Yes @tab an integer constant
10102 @item @code{acc} @tab @code{int} @tab Yes @tab an ACC register number
10103 @item @code{iacc} @tab @code{int} @tab Yes @tab an IACC register number
10104 @end multitable
10106 These pseudo types are not defined by GCC, they are simply a notational
10107 convenience used in this manual.
10109 Arguments of type @code{uh}, @code{uw1}, @code{sw1}, @code{uw2}
10110 and @code{sw2} are evaluated at run time.  They correspond to
10111 register operands in the underlying FR-V instructions.
10113 @code{const} arguments represent immediate operands in the underlying
10114 FR-V instructions.  They must be compile-time constants.
10116 @code{acc} arguments are evaluated at compile time and specify the number
10117 of an accumulator register.  For example, an @code{acc} argument of 2
10118 selects the ACC2 register.
10120 @code{iacc} arguments are similar to @code{acc} arguments but specify the
10121 number of an IACC register.  See @pxref{Other Built-in Functions}
10122 for more details.
10124 @node Directly-mapped Integer Functions
10125 @subsubsection Directly-mapped Integer Functions
10127 The functions listed below map directly to FR-V I-type instructions.
10129 @multitable @columnfractions .45 .32 .23
10130 @item Function prototype @tab Example usage @tab Assembly output
10131 @item @code{sw1 __ADDSS (sw1, sw1)}
10132 @tab @code{@var{c} = __ADDSS (@var{a}, @var{b})}
10133 @tab @code{ADDSS @var{a},@var{b},@var{c}}
10134 @item @code{sw1 __SCAN (sw1, sw1)}
10135 @tab @code{@var{c} = __SCAN (@var{a}, @var{b})}
10136 @tab @code{SCAN @var{a},@var{b},@var{c}}
10137 @item @code{sw1 __SCUTSS (sw1)}
10138 @tab @code{@var{b} = __SCUTSS (@var{a})}
10139 @tab @code{SCUTSS @var{a},@var{b}}
10140 @item @code{sw1 __SLASS (sw1, sw1)}
10141 @tab @code{@var{c} = __SLASS (@var{a}, @var{b})}
10142 @tab @code{SLASS @var{a},@var{b},@var{c}}
10143 @item @code{void __SMASS (sw1, sw1)}
10144 @tab @code{__SMASS (@var{a}, @var{b})}
10145 @tab @code{SMASS @var{a},@var{b}}
10146 @item @code{void __SMSSS (sw1, sw1)}
10147 @tab @code{__SMSSS (@var{a}, @var{b})}
10148 @tab @code{SMSSS @var{a},@var{b}}
10149 @item @code{void __SMU (sw1, sw1)}
10150 @tab @code{__SMU (@var{a}, @var{b})}
10151 @tab @code{SMU @var{a},@var{b}}
10152 @item @code{sw2 __SMUL (sw1, sw1)}
10153 @tab @code{@var{c} = __SMUL (@var{a}, @var{b})}
10154 @tab @code{SMUL @var{a},@var{b},@var{c}}
10155 @item @code{sw1 __SUBSS (sw1, sw1)}
10156 @tab @code{@var{c} = __SUBSS (@var{a}, @var{b})}
10157 @tab @code{SUBSS @var{a},@var{b},@var{c}}
10158 @item @code{uw2 __UMUL (uw1, uw1)}
10159 @tab @code{@var{c} = __UMUL (@var{a}, @var{b})}
10160 @tab @code{UMUL @var{a},@var{b},@var{c}}
10161 @end multitable
10163 @node Directly-mapped Media Functions
10164 @subsubsection Directly-mapped Media Functions
10166 The functions listed below map directly to FR-V M-type instructions.
10168 @multitable @columnfractions .45 .32 .23
10169 @item Function prototype @tab Example usage @tab Assembly output
10170 @item @code{uw1 __MABSHS (sw1)}
10171 @tab @code{@var{b} = __MABSHS (@var{a})}
10172 @tab @code{MABSHS @var{a},@var{b}}
10173 @item @code{void __MADDACCS (acc, acc)}
10174 @tab @code{__MADDACCS (@var{b}, @var{a})}
10175 @tab @code{MADDACCS @var{a},@var{b}}
10176 @item @code{sw1 __MADDHSS (sw1, sw1)}
10177 @tab @code{@var{c} = __MADDHSS (@var{a}, @var{b})}
10178 @tab @code{MADDHSS @var{a},@var{b},@var{c}}
10179 @item @code{uw1 __MADDHUS (uw1, uw1)}
10180 @tab @code{@var{c} = __MADDHUS (@var{a}, @var{b})}
10181 @tab @code{MADDHUS @var{a},@var{b},@var{c}}
10182 @item @code{uw1 __MAND (uw1, uw1)}
10183 @tab @code{@var{c} = __MAND (@var{a}, @var{b})}
10184 @tab @code{MAND @var{a},@var{b},@var{c}}
10185 @item @code{void __MASACCS (acc, acc)}
10186 @tab @code{__MASACCS (@var{b}, @var{a})}
10187 @tab @code{MASACCS @var{a},@var{b}}
10188 @item @code{uw1 __MAVEH (uw1, uw1)}
10189 @tab @code{@var{c} = __MAVEH (@var{a}, @var{b})}
10190 @tab @code{MAVEH @var{a},@var{b},@var{c}}
10191 @item @code{uw2 __MBTOH (uw1)}
10192 @tab @code{@var{b} = __MBTOH (@var{a})}
10193 @tab @code{MBTOH @var{a},@var{b}}
10194 @item @code{void __MBTOHE (uw1 *, uw1)}
10195 @tab @code{__MBTOHE (&@var{b}, @var{a})}
10196 @tab @code{MBTOHE @var{a},@var{b}}
10197 @item @code{void __MCLRACC (acc)}
10198 @tab @code{__MCLRACC (@var{a})}
10199 @tab @code{MCLRACC @var{a}}
10200 @item @code{void __MCLRACCA (void)}
10201 @tab @code{__MCLRACCA ()}
10202 @tab @code{MCLRACCA}
10203 @item @code{uw1 __Mcop1 (uw1, uw1)}
10204 @tab @code{@var{c} = __Mcop1 (@var{a}, @var{b})}
10205 @tab @code{Mcop1 @var{a},@var{b},@var{c}}
10206 @item @code{uw1 __Mcop2 (uw1, uw1)}
10207 @tab @code{@var{c} = __Mcop2 (@var{a}, @var{b})}
10208 @tab @code{Mcop2 @var{a},@var{b},@var{c}}
10209 @item @code{uw1 __MCPLHI (uw2, const)}
10210 @tab @code{@var{c} = __MCPLHI (@var{a}, @var{b})}
10211 @tab @code{MCPLHI @var{a},#@var{b},@var{c}}
10212 @item @code{uw1 __MCPLI (uw2, const)}
10213 @tab @code{@var{c} = __MCPLI (@var{a}, @var{b})}
10214 @tab @code{MCPLI @var{a},#@var{b},@var{c}}
10215 @item @code{void __MCPXIS (acc, sw1, sw1)}
10216 @tab @code{__MCPXIS (@var{c}, @var{a}, @var{b})}
10217 @tab @code{MCPXIS @var{a},@var{b},@var{c}}
10218 @item @code{void __MCPXIU (acc, uw1, uw1)}
10219 @tab @code{__MCPXIU (@var{c}, @var{a}, @var{b})}
10220 @tab @code{MCPXIU @var{a},@var{b},@var{c}}
10221 @item @code{void __MCPXRS (acc, sw1, sw1)}
10222 @tab @code{__MCPXRS (@var{c}, @var{a}, @var{b})}
10223 @tab @code{MCPXRS @var{a},@var{b},@var{c}}
10224 @item @code{void __MCPXRU (acc, uw1, uw1)}
10225 @tab @code{__MCPXRU (@var{c}, @var{a}, @var{b})}
10226 @tab @code{MCPXRU @var{a},@var{b},@var{c}}
10227 @item @code{uw1 __MCUT (acc, uw1)}
10228 @tab @code{@var{c} = __MCUT (@var{a}, @var{b})}
10229 @tab @code{MCUT @var{a},@var{b},@var{c}}
10230 @item @code{uw1 __MCUTSS (acc, sw1)}
10231 @tab @code{@var{c} = __MCUTSS (@var{a}, @var{b})}
10232 @tab @code{MCUTSS @var{a},@var{b},@var{c}}
10233 @item @code{void __MDADDACCS (acc, acc)}
10234 @tab @code{__MDADDACCS (@var{b}, @var{a})}
10235 @tab @code{MDADDACCS @var{a},@var{b}}
10236 @item @code{void __MDASACCS (acc, acc)}
10237 @tab @code{__MDASACCS (@var{b}, @var{a})}
10238 @tab @code{MDASACCS @var{a},@var{b}}
10239 @item @code{uw2 __MDCUTSSI (acc, const)}
10240 @tab @code{@var{c} = __MDCUTSSI (@var{a}, @var{b})}
10241 @tab @code{MDCUTSSI @var{a},#@var{b},@var{c}}
10242 @item @code{uw2 __MDPACKH (uw2, uw2)}
10243 @tab @code{@var{c} = __MDPACKH (@var{a}, @var{b})}
10244 @tab @code{MDPACKH @var{a},@var{b},@var{c}}
10245 @item @code{uw2 __MDROTLI (uw2, const)}
10246 @tab @code{@var{c} = __MDROTLI (@var{a}, @var{b})}
10247 @tab @code{MDROTLI @var{a},#@var{b},@var{c}}
10248 @item @code{void __MDSUBACCS (acc, acc)}
10249 @tab @code{__MDSUBACCS (@var{b}, @var{a})}
10250 @tab @code{MDSUBACCS @var{a},@var{b}}
10251 @item @code{void __MDUNPACKH (uw1 *, uw2)}
10252 @tab @code{__MDUNPACKH (&@var{b}, @var{a})}
10253 @tab @code{MDUNPACKH @var{a},@var{b}}
10254 @item @code{uw2 __MEXPDHD (uw1, const)}
10255 @tab @code{@var{c} = __MEXPDHD (@var{a}, @var{b})}
10256 @tab @code{MEXPDHD @var{a},#@var{b},@var{c}}
10257 @item @code{uw1 __MEXPDHW (uw1, const)}
10258 @tab @code{@var{c} = __MEXPDHW (@var{a}, @var{b})}
10259 @tab @code{MEXPDHW @var{a},#@var{b},@var{c}}
10260 @item @code{uw1 __MHDSETH (uw1, const)}
10261 @tab @code{@var{c} = __MHDSETH (@var{a}, @var{b})}
10262 @tab @code{MHDSETH @var{a},#@var{b},@var{c}}
10263 @item @code{sw1 __MHDSETS (const)}
10264 @tab @code{@var{b} = __MHDSETS (@var{a})}
10265 @tab @code{MHDSETS #@var{a},@var{b}}
10266 @item @code{uw1 __MHSETHIH (uw1, const)}
10267 @tab @code{@var{b} = __MHSETHIH (@var{b}, @var{a})}
10268 @tab @code{MHSETHIH #@var{a},@var{b}}
10269 @item @code{sw1 __MHSETHIS (sw1, const)}
10270 @tab @code{@var{b} = __MHSETHIS (@var{b}, @var{a})}
10271 @tab @code{MHSETHIS #@var{a},@var{b}}
10272 @item @code{uw1 __MHSETLOH (uw1, const)}
10273 @tab @code{@var{b} = __MHSETLOH (@var{b}, @var{a})}
10274 @tab @code{MHSETLOH #@var{a},@var{b}}
10275 @item @code{sw1 __MHSETLOS (sw1, const)}
10276 @tab @code{@var{b} = __MHSETLOS (@var{b}, @var{a})}
10277 @tab @code{MHSETLOS #@var{a},@var{b}}
10278 @item @code{uw1 __MHTOB (uw2)}
10279 @tab @code{@var{b} = __MHTOB (@var{a})}
10280 @tab @code{MHTOB @var{a},@var{b}}
10281 @item @code{void __MMACHS (acc, sw1, sw1)}
10282 @tab @code{__MMACHS (@var{c}, @var{a}, @var{b})}
10283 @tab @code{MMACHS @var{a},@var{b},@var{c}}
10284 @item @code{void __MMACHU (acc, uw1, uw1)}
10285 @tab @code{__MMACHU (@var{c}, @var{a}, @var{b})}
10286 @tab @code{MMACHU @var{a},@var{b},@var{c}}
10287 @item @code{void __MMRDHS (acc, sw1, sw1)}
10288 @tab @code{__MMRDHS (@var{c}, @var{a}, @var{b})}
10289 @tab @code{MMRDHS @var{a},@var{b},@var{c}}
10290 @item @code{void __MMRDHU (acc, uw1, uw1)}
10291 @tab @code{__MMRDHU (@var{c}, @var{a}, @var{b})}
10292 @tab @code{MMRDHU @var{a},@var{b},@var{c}}
10293 @item @code{void __MMULHS (acc, sw1, sw1)}
10294 @tab @code{__MMULHS (@var{c}, @var{a}, @var{b})}
10295 @tab @code{MMULHS @var{a},@var{b},@var{c}}
10296 @item @code{void __MMULHU (acc, uw1, uw1)}
10297 @tab @code{__MMULHU (@var{c}, @var{a}, @var{b})}
10298 @tab @code{MMULHU @var{a},@var{b},@var{c}}
10299 @item @code{void __MMULXHS (acc, sw1, sw1)}
10300 @tab @code{__MMULXHS (@var{c}, @var{a}, @var{b})}
10301 @tab @code{MMULXHS @var{a},@var{b},@var{c}}
10302 @item @code{void __MMULXHU (acc, uw1, uw1)}
10303 @tab @code{__MMULXHU (@var{c}, @var{a}, @var{b})}
10304 @tab @code{MMULXHU @var{a},@var{b},@var{c}}
10305 @item @code{uw1 __MNOT (uw1)}
10306 @tab @code{@var{b} = __MNOT (@var{a})}
10307 @tab @code{MNOT @var{a},@var{b}}
10308 @item @code{uw1 __MOR (uw1, uw1)}
10309 @tab @code{@var{c} = __MOR (@var{a}, @var{b})}
10310 @tab @code{MOR @var{a},@var{b},@var{c}}
10311 @item @code{uw1 __MPACKH (uh, uh)}
10312 @tab @code{@var{c} = __MPACKH (@var{a}, @var{b})}
10313 @tab @code{MPACKH @var{a},@var{b},@var{c}}
10314 @item @code{sw2 __MQADDHSS (sw2, sw2)}
10315 @tab @code{@var{c} = __MQADDHSS (@var{a}, @var{b})}
10316 @tab @code{MQADDHSS @var{a},@var{b},@var{c}}
10317 @item @code{uw2 __MQADDHUS (uw2, uw2)}
10318 @tab @code{@var{c} = __MQADDHUS (@var{a}, @var{b})}
10319 @tab @code{MQADDHUS @var{a},@var{b},@var{c}}
10320 @item @code{void __MQCPXIS (acc, sw2, sw2)}
10321 @tab @code{__MQCPXIS (@var{c}, @var{a}, @var{b})}
10322 @tab @code{MQCPXIS @var{a},@var{b},@var{c}}
10323 @item @code{void __MQCPXIU (acc, uw2, uw2)}
10324 @tab @code{__MQCPXIU (@var{c}, @var{a}, @var{b})}
10325 @tab @code{MQCPXIU @var{a},@var{b},@var{c}}
10326 @item @code{void __MQCPXRS (acc, sw2, sw2)}
10327 @tab @code{__MQCPXRS (@var{c}, @var{a}, @var{b})}
10328 @tab @code{MQCPXRS @var{a},@var{b},@var{c}}
10329 @item @code{void __MQCPXRU (acc, uw2, uw2)}
10330 @tab @code{__MQCPXRU (@var{c}, @var{a}, @var{b})}
10331 @tab @code{MQCPXRU @var{a},@var{b},@var{c}}
10332 @item @code{sw2 __MQLCLRHS (sw2, sw2)}
10333 @tab @code{@var{c} = __MQLCLRHS (@var{a}, @var{b})}
10334 @tab @code{MQLCLRHS @var{a},@var{b},@var{c}}
10335 @item @code{sw2 __MQLMTHS (sw2, sw2)}
10336 @tab @code{@var{c} = __MQLMTHS (@var{a}, @var{b})}
10337 @tab @code{MQLMTHS @var{a},@var{b},@var{c}}
10338 @item @code{void __MQMACHS (acc, sw2, sw2)}
10339 @tab @code{__MQMACHS (@var{c}, @var{a}, @var{b})}
10340 @tab @code{MQMACHS @var{a},@var{b},@var{c}}
10341 @item @code{void __MQMACHU (acc, uw2, uw2)}
10342 @tab @code{__MQMACHU (@var{c}, @var{a}, @var{b})}
10343 @tab @code{MQMACHU @var{a},@var{b},@var{c}}
10344 @item @code{void __MQMACXHS (acc, sw2, sw2)}
10345 @tab @code{__MQMACXHS (@var{c}, @var{a}, @var{b})}
10346 @tab @code{MQMACXHS @var{a},@var{b},@var{c}}
10347 @item @code{void __MQMULHS (acc, sw2, sw2)}
10348 @tab @code{__MQMULHS (@var{c}, @var{a}, @var{b})}
10349 @tab @code{MQMULHS @var{a},@var{b},@var{c}}
10350 @item @code{void __MQMULHU (acc, uw2, uw2)}
10351 @tab @code{__MQMULHU (@var{c}, @var{a}, @var{b})}
10352 @tab @code{MQMULHU @var{a},@var{b},@var{c}}
10353 @item @code{void __MQMULXHS (acc, sw2, sw2)}
10354 @tab @code{__MQMULXHS (@var{c}, @var{a}, @var{b})}
10355 @tab @code{MQMULXHS @var{a},@var{b},@var{c}}
10356 @item @code{void __MQMULXHU (acc, uw2, uw2)}
10357 @tab @code{__MQMULXHU (@var{c}, @var{a}, @var{b})}
10358 @tab @code{MQMULXHU @var{a},@var{b},@var{c}}
10359 @item @code{sw2 __MQSATHS (sw2, sw2)}
10360 @tab @code{@var{c} = __MQSATHS (@var{a}, @var{b})}
10361 @tab @code{MQSATHS @var{a},@var{b},@var{c}}
10362 @item @code{uw2 __MQSLLHI (uw2, int)}
10363 @tab @code{@var{c} = __MQSLLHI (@var{a}, @var{b})}
10364 @tab @code{MQSLLHI @var{a},@var{b},@var{c}}
10365 @item @code{sw2 __MQSRAHI (sw2, int)}
10366 @tab @code{@var{c} = __MQSRAHI (@var{a}, @var{b})}
10367 @tab @code{MQSRAHI @var{a},@var{b},@var{c}}
10368 @item @code{sw2 __MQSUBHSS (sw2, sw2)}
10369 @tab @code{@var{c} = __MQSUBHSS (@var{a}, @var{b})}
10370 @tab @code{MQSUBHSS @var{a},@var{b},@var{c}}
10371 @item @code{uw2 __MQSUBHUS (uw2, uw2)}
10372 @tab @code{@var{c} = __MQSUBHUS (@var{a}, @var{b})}
10373 @tab @code{MQSUBHUS @var{a},@var{b},@var{c}}
10374 @item @code{void __MQXMACHS (acc, sw2, sw2)}
10375 @tab @code{__MQXMACHS (@var{c}, @var{a}, @var{b})}
10376 @tab @code{MQXMACHS @var{a},@var{b},@var{c}}
10377 @item @code{void __MQXMACXHS (acc, sw2, sw2)}
10378 @tab @code{__MQXMACXHS (@var{c}, @var{a}, @var{b})}
10379 @tab @code{MQXMACXHS @var{a},@var{b},@var{c}}
10380 @item @code{uw1 __MRDACC (acc)}
10381 @tab @code{@var{b} = __MRDACC (@var{a})}
10382 @tab @code{MRDACC @var{a},@var{b}}
10383 @item @code{uw1 __MRDACCG (acc)}
10384 @tab @code{@var{b} = __MRDACCG (@var{a})}
10385 @tab @code{MRDACCG @var{a},@var{b}}
10386 @item @code{uw1 __MROTLI (uw1, const)}
10387 @tab @code{@var{c} = __MROTLI (@var{a}, @var{b})}
10388 @tab @code{MROTLI @var{a},#@var{b},@var{c}}
10389 @item @code{uw1 __MROTRI (uw1, const)}
10390 @tab @code{@var{c} = __MROTRI (@var{a}, @var{b})}
10391 @tab @code{MROTRI @var{a},#@var{b},@var{c}}
10392 @item @code{sw1 __MSATHS (sw1, sw1)}
10393 @tab @code{@var{c} = __MSATHS (@var{a}, @var{b})}
10394 @tab @code{MSATHS @var{a},@var{b},@var{c}}
10395 @item @code{uw1 __MSATHU (uw1, uw1)}
10396 @tab @code{@var{c} = __MSATHU (@var{a}, @var{b})}
10397 @tab @code{MSATHU @var{a},@var{b},@var{c}}
10398 @item @code{uw1 __MSLLHI (uw1, const)}
10399 @tab @code{@var{c} = __MSLLHI (@var{a}, @var{b})}
10400 @tab @code{MSLLHI @var{a},#@var{b},@var{c}}
10401 @item @code{sw1 __MSRAHI (sw1, const)}
10402 @tab @code{@var{c} = __MSRAHI (@var{a}, @var{b})}
10403 @tab @code{MSRAHI @var{a},#@var{b},@var{c}}
10404 @item @code{uw1 __MSRLHI (uw1, const)}
10405 @tab @code{@var{c} = __MSRLHI (@var{a}, @var{b})}
10406 @tab @code{MSRLHI @var{a},#@var{b},@var{c}}
10407 @item @code{void __MSUBACCS (acc, acc)}
10408 @tab @code{__MSUBACCS (@var{b}, @var{a})}
10409 @tab @code{MSUBACCS @var{a},@var{b}}
10410 @item @code{sw1 __MSUBHSS (sw1, sw1)}
10411 @tab @code{@var{c} = __MSUBHSS (@var{a}, @var{b})}
10412 @tab @code{MSUBHSS @var{a},@var{b},@var{c}}
10413 @item @code{uw1 __MSUBHUS (uw1, uw1)}
10414 @tab @code{@var{c} = __MSUBHUS (@var{a}, @var{b})}
10415 @tab @code{MSUBHUS @var{a},@var{b},@var{c}}
10416 @item @code{void __MTRAP (void)}
10417 @tab @code{__MTRAP ()}
10418 @tab @code{MTRAP}
10419 @item @code{uw2 __MUNPACKH (uw1)}
10420 @tab @code{@var{b} = __MUNPACKH (@var{a})}
10421 @tab @code{MUNPACKH @var{a},@var{b}}
10422 @item @code{uw1 __MWCUT (uw2, uw1)}
10423 @tab @code{@var{c} = __MWCUT (@var{a}, @var{b})}
10424 @tab @code{MWCUT @var{a},@var{b},@var{c}}
10425 @item @code{void __MWTACC (acc, uw1)}
10426 @tab @code{__MWTACC (@var{b}, @var{a})}
10427 @tab @code{MWTACC @var{a},@var{b}}
10428 @item @code{void __MWTACCG (acc, uw1)}
10429 @tab @code{__MWTACCG (@var{b}, @var{a})}
10430 @tab @code{MWTACCG @var{a},@var{b}}
10431 @item @code{uw1 __MXOR (uw1, uw1)}
10432 @tab @code{@var{c} = __MXOR (@var{a}, @var{b})}
10433 @tab @code{MXOR @var{a},@var{b},@var{c}}
10434 @end multitable
10436 @node Raw read/write Functions
10437 @subsubsection Raw read/write Functions
10439 This sections describes built-in functions related to read and write
10440 instructions to access memory.  These functions generate
10441 @code{membar} instructions to flush the I/O load and stores where
10442 appropriate, as described in Fujitsu's manual described above.
10444 @table @code
10446 @item unsigned char __builtin_read8 (void *@var{data})
10447 @item unsigned short __builtin_read16 (void *@var{data})
10448 @item unsigned long __builtin_read32 (void *@var{data})
10449 @item unsigned long long __builtin_read64 (void *@var{data})
10451 @item void __builtin_write8 (void *@var{data}, unsigned char @var{datum})
10452 @item void __builtin_write16 (void *@var{data}, unsigned short @var{datum})
10453 @item void __builtin_write32 (void *@var{data}, unsigned long @var{datum})
10454 @item void __builtin_write64 (void *@var{data}, unsigned long long @var{datum})
10455 @end table
10457 @node Other Built-in Functions
10458 @subsubsection Other Built-in Functions
10460 This section describes built-in functions that are not named after
10461 a specific FR-V instruction.
10463 @table @code
10464 @item sw2 __IACCreadll (iacc @var{reg})
10465 Return the full 64-bit value of IACC0@.  The @var{reg} argument is reserved
10466 for future expansion and must be 0.
10468 @item sw1 __IACCreadl (iacc @var{reg})
10469 Return the value of IACC0H if @var{reg} is 0 and IACC0L if @var{reg} is 1.
10470 Other values of @var{reg} are rejected as invalid.
10472 @item void __IACCsetll (iacc @var{reg}, sw2 @var{x})
10473 Set the full 64-bit value of IACC0 to @var{x}.  The @var{reg} argument
10474 is reserved for future expansion and must be 0.
10476 @item void __IACCsetl (iacc @var{reg}, sw1 @var{x})
10477 Set IACC0H to @var{x} if @var{reg} is 0 and IACC0L to @var{x} if @var{reg}
10478 is 1.  Other values of @var{reg} are rejected as invalid.
10480 @item void __data_prefetch0 (const void *@var{x})
10481 Use the @code{dcpl} instruction to load the contents of address @var{x}
10482 into the data cache.
10484 @item void __data_prefetch (const void *@var{x})
10485 Use the @code{nldub} instruction to load the contents of address @var{x}
10486 into the data cache.  The instruction is issued in slot I1@.
10487 @end table
10489 @node X86 Built-in Functions
10490 @subsection X86 Built-in Functions
10492 These built-in functions are available for the i386 and x86-64 family
10493 of computers, depending on the command-line switches used.
10495 If you specify command-line switches such as @option{-msse},
10496 the compiler could use the extended instruction sets even if the built-ins
10497 are not used explicitly in the program.  For this reason, applications
10498 that perform run-time CPU detection must compile separate files for each
10499 supported architecture, using the appropriate flags.  In particular,
10500 the file containing the CPU detection code should be compiled without
10501 these options.
10503 The following machine modes are available for use with MMX built-in functions
10504 (@pxref{Vector Extensions}): @code{V2SI} for a vector of two 32-bit integers,
10505 @code{V4HI} for a vector of four 16-bit integers, and @code{V8QI} for a
10506 vector of eight 8-bit integers.  Some of the built-in functions operate on
10507 MMX registers as a whole 64-bit entity, these use @code{V1DI} as their mode.
10509 If 3DNow!@: extensions are enabled, @code{V2SF} is used as a mode for a vector
10510 of two 32-bit floating-point values.
10512 If SSE extensions are enabled, @code{V4SF} is used for a vector of four 32-bit
10513 floating-point values.  Some instructions use a vector of four 32-bit
10514 integers, these use @code{V4SI}.  Finally, some instructions operate on an
10515 entire vector register, interpreting it as a 128-bit integer, these use mode
10516 @code{TI}.
10518 In 64-bit mode, the x86-64 family of processors uses additional built-in
10519 functions for efficient use of @code{TF} (@code{__float128}) 128-bit
10520 floating point and @code{TC} 128-bit complex floating-point values.
10522 The following floating-point built-in functions are available in 64-bit
10523 mode.  All of them implement the function that is part of the name.
10525 @smallexample
10526 __float128 __builtin_fabsq (__float128)
10527 __float128 __builtin_copysignq (__float128, __float128)
10528 @end smallexample
10530 The following built-in function is always available.
10532 @table @code
10533 @item void __builtin_ia32_pause (void)
10534 Generates the @code{pause} machine instruction with a compiler memory
10535 barrier.
10536 @end table
10538 The following floating-point built-in functions are made available in the
10539 64-bit mode.
10541 @table @code
10542 @item __float128 __builtin_infq (void)
10543 Similar to @code{__builtin_inf}, except the return type is @code{__float128}.
10544 @findex __builtin_infq
10546 @item __float128 __builtin_huge_valq (void)
10547 Similar to @code{__builtin_huge_val}, except the return type is @code{__float128}.
10548 @findex __builtin_huge_valq
10549 @end table
10551 The following built-in functions are always available and can be used to
10552 check the target platform type.
10554 @deftypefn {Built-in Function} void __builtin_cpu_init (void)
10555 This function runs the CPU detection code to check the type of CPU and the
10556 features supported.  This built-in function needs to be invoked along with the built-in functions
10557 to check CPU type and features, @code{__builtin_cpu_is} and
10558 @code{__builtin_cpu_supports}, only when used in a function that is
10559 executed before any constructors are called.  The CPU detection code is
10560 automatically executed in a very high priority constructor.
10562 For example, this function has to be used in @code{ifunc} resolvers that
10563 check for CPU type using the built-in functions @code{__builtin_cpu_is}
10564 and @code{__builtin_cpu_supports}, or in constructors on targets that
10565 don't support constructor priority.
10566 @smallexample
10568 static void (*resolve_memcpy (void)) (void)
10570   // ifunc resolvers fire before constructors, explicitly call the init
10571   // function.
10572   __builtin_cpu_init ();
10573   if (__builtin_cpu_supports ("ssse3"))
10574     return ssse3_memcpy; // super fast memcpy with ssse3 instructions.
10575   else
10576     return default_memcpy;
10579 void *memcpy (void *, const void *, size_t)
10580      __attribute__ ((ifunc ("resolve_memcpy")));
10581 @end smallexample
10583 @end deftypefn
10585 @deftypefn {Built-in Function} int __builtin_cpu_is (const char *@var{cpuname})
10586 This function returns a positive integer if the run-time CPU
10587 is of type @var{cpuname}
10588 and returns @code{0} otherwise. The following CPU names can be detected:
10590 @table @samp
10591 @item intel
10592 Intel CPU.
10594 @item atom
10595 Intel Atom CPU.
10597 @item core2
10598 Intel Core 2 CPU.
10600 @item corei7
10601 Intel Core i7 CPU.
10603 @item nehalem
10604 Intel Core i7 Nehalem CPU.
10606 @item westmere
10607 Intel Core i7 Westmere CPU.
10609 @item sandybridge
10610 Intel Core i7 Sandy Bridge CPU.
10612 @item amd
10613 AMD CPU.
10615 @item amdfam10h
10616 AMD Family 10h CPU.
10618 @item barcelona
10619 AMD Family 10h Barcelona CPU.
10621 @item shanghai
10622 AMD Family 10h Shanghai CPU.
10624 @item istanbul
10625 AMD Family 10h Istanbul CPU.
10627 @item btver1
10628 AMD Family 14h CPU.
10630 @item amdfam15h
10631 AMD Family 15h CPU.
10633 @item bdver1
10634 AMD Family 15h Bulldozer version 1.
10636 @item bdver2
10637 AMD Family 15h Bulldozer version 2.
10639 @item bdver3
10640 AMD Family 15h Bulldozer version 3.
10642 @item bdver4
10643 AMD Family 15h Bulldozer version 4.
10645 @item btver2
10646 AMD Family 16h CPU.
10647 @end table
10649 Here is an example:
10650 @smallexample
10651 if (__builtin_cpu_is ("corei7"))
10652   @{
10653      do_corei7 (); // Core i7 specific implementation.
10654   @}
10655 else
10656   @{
10657      do_generic (); // Generic implementation.
10658   @}
10659 @end smallexample
10660 @end deftypefn
10662 @deftypefn {Built-in Function} int __builtin_cpu_supports (const char *@var{feature})
10663 This function returns a positive integer if the run-time CPU
10664 supports @var{feature}
10665 and returns @code{0} otherwise. The following features can be detected:
10667 @table @samp
10668 @item cmov
10669 CMOV instruction.
10670 @item mmx
10671 MMX instructions.
10672 @item popcnt
10673 POPCNT instruction.
10674 @item sse
10675 SSE instructions.
10676 @item sse2
10677 SSE2 instructions.
10678 @item sse3
10679 SSE3 instructions.
10680 @item ssse3
10681 SSSE3 instructions.
10682 @item sse4.1
10683 SSE4.1 instructions.
10684 @item sse4.2
10685 SSE4.2 instructions.
10686 @item avx
10687 AVX instructions.
10688 @item avx2
10689 AVX2 instructions.
10690 @end table
10692 Here is an example:
10693 @smallexample
10694 if (__builtin_cpu_supports ("popcnt"))
10695   @{
10696      asm("popcnt %1,%0" : "=r"(count) : "rm"(n) : "cc");
10697   @}
10698 else
10699   @{
10700      count = generic_countbits (n); //generic implementation.
10701   @}
10702 @end smallexample
10703 @end deftypefn
10706 The following built-in functions are made available by @option{-mmmx}.
10707 All of them generate the machine instruction that is part of the name.
10709 @smallexample
10710 v8qi __builtin_ia32_paddb (v8qi, v8qi)
10711 v4hi __builtin_ia32_paddw (v4hi, v4hi)
10712 v2si __builtin_ia32_paddd (v2si, v2si)
10713 v8qi __builtin_ia32_psubb (v8qi, v8qi)
10714 v4hi __builtin_ia32_psubw (v4hi, v4hi)
10715 v2si __builtin_ia32_psubd (v2si, v2si)
10716 v8qi __builtin_ia32_paddsb (v8qi, v8qi)
10717 v4hi __builtin_ia32_paddsw (v4hi, v4hi)
10718 v8qi __builtin_ia32_psubsb (v8qi, v8qi)
10719 v4hi __builtin_ia32_psubsw (v4hi, v4hi)
10720 v8qi __builtin_ia32_paddusb (v8qi, v8qi)
10721 v4hi __builtin_ia32_paddusw (v4hi, v4hi)
10722 v8qi __builtin_ia32_psubusb (v8qi, v8qi)
10723 v4hi __builtin_ia32_psubusw (v4hi, v4hi)
10724 v4hi __builtin_ia32_pmullw (v4hi, v4hi)
10725 v4hi __builtin_ia32_pmulhw (v4hi, v4hi)
10726 di __builtin_ia32_pand (di, di)
10727 di __builtin_ia32_pandn (di,di)
10728 di __builtin_ia32_por (di, di)
10729 di __builtin_ia32_pxor (di, di)
10730 v8qi __builtin_ia32_pcmpeqb (v8qi, v8qi)
10731 v4hi __builtin_ia32_pcmpeqw (v4hi, v4hi)
10732 v2si __builtin_ia32_pcmpeqd (v2si, v2si)
10733 v8qi __builtin_ia32_pcmpgtb (v8qi, v8qi)
10734 v4hi __builtin_ia32_pcmpgtw (v4hi, v4hi)
10735 v2si __builtin_ia32_pcmpgtd (v2si, v2si)
10736 v8qi __builtin_ia32_punpckhbw (v8qi, v8qi)
10737 v4hi __builtin_ia32_punpckhwd (v4hi, v4hi)
10738 v2si __builtin_ia32_punpckhdq (v2si, v2si)
10739 v8qi __builtin_ia32_punpcklbw (v8qi, v8qi)
10740 v4hi __builtin_ia32_punpcklwd (v4hi, v4hi)
10741 v2si __builtin_ia32_punpckldq (v2si, v2si)
10742 v8qi __builtin_ia32_packsswb (v4hi, v4hi)
10743 v4hi __builtin_ia32_packssdw (v2si, v2si)
10744 v8qi __builtin_ia32_packuswb (v4hi, v4hi)
10746 v4hi __builtin_ia32_psllw (v4hi, v4hi)
10747 v2si __builtin_ia32_pslld (v2si, v2si)
10748 v1di __builtin_ia32_psllq (v1di, v1di)
10749 v4hi __builtin_ia32_psrlw (v4hi, v4hi)
10750 v2si __builtin_ia32_psrld (v2si, v2si)
10751 v1di __builtin_ia32_psrlq (v1di, v1di)
10752 v4hi __builtin_ia32_psraw (v4hi, v4hi)
10753 v2si __builtin_ia32_psrad (v2si, v2si)
10754 v4hi __builtin_ia32_psllwi (v4hi, int)
10755 v2si __builtin_ia32_pslldi (v2si, int)
10756 v1di __builtin_ia32_psllqi (v1di, int)
10757 v4hi __builtin_ia32_psrlwi (v4hi, int)
10758 v2si __builtin_ia32_psrldi (v2si, int)
10759 v1di __builtin_ia32_psrlqi (v1di, int)
10760 v4hi __builtin_ia32_psrawi (v4hi, int)
10761 v2si __builtin_ia32_psradi (v2si, int)
10763 @end smallexample
10765 The following built-in functions are made available either with
10766 @option{-msse}, or with a combination of @option{-m3dnow} and
10767 @option{-march=athlon}.  All of them generate the machine
10768 instruction that is part of the name.
10770 @smallexample
10771 v4hi __builtin_ia32_pmulhuw (v4hi, v4hi)
10772 v8qi __builtin_ia32_pavgb (v8qi, v8qi)
10773 v4hi __builtin_ia32_pavgw (v4hi, v4hi)
10774 v1di __builtin_ia32_psadbw (v8qi, v8qi)
10775 v8qi __builtin_ia32_pmaxub (v8qi, v8qi)
10776 v4hi __builtin_ia32_pmaxsw (v4hi, v4hi)
10777 v8qi __builtin_ia32_pminub (v8qi, v8qi)
10778 v4hi __builtin_ia32_pminsw (v4hi, v4hi)
10779 int __builtin_ia32_pmovmskb (v8qi)
10780 void __builtin_ia32_maskmovq (v8qi, v8qi, char *)
10781 void __builtin_ia32_movntq (di *, di)
10782 void __builtin_ia32_sfence (void)
10783 @end smallexample
10785 The following built-in functions are available when @option{-msse} is used.
10786 All of them generate the machine instruction that is part of the name.
10788 @smallexample
10789 int __builtin_ia32_comieq (v4sf, v4sf)
10790 int __builtin_ia32_comineq (v4sf, v4sf)
10791 int __builtin_ia32_comilt (v4sf, v4sf)
10792 int __builtin_ia32_comile (v4sf, v4sf)
10793 int __builtin_ia32_comigt (v4sf, v4sf)
10794 int __builtin_ia32_comige (v4sf, v4sf)
10795 int __builtin_ia32_ucomieq (v4sf, v4sf)
10796 int __builtin_ia32_ucomineq (v4sf, v4sf)
10797 int __builtin_ia32_ucomilt (v4sf, v4sf)
10798 int __builtin_ia32_ucomile (v4sf, v4sf)
10799 int __builtin_ia32_ucomigt (v4sf, v4sf)
10800 int __builtin_ia32_ucomige (v4sf, v4sf)
10801 v4sf __builtin_ia32_addps (v4sf, v4sf)
10802 v4sf __builtin_ia32_subps (v4sf, v4sf)
10803 v4sf __builtin_ia32_mulps (v4sf, v4sf)
10804 v4sf __builtin_ia32_divps (v4sf, v4sf)
10805 v4sf __builtin_ia32_addss (v4sf, v4sf)
10806 v4sf __builtin_ia32_subss (v4sf, v4sf)
10807 v4sf __builtin_ia32_mulss (v4sf, v4sf)
10808 v4sf __builtin_ia32_divss (v4sf, v4sf)
10809 v4sf __builtin_ia32_cmpeqps (v4sf, v4sf)
10810 v4sf __builtin_ia32_cmpltps (v4sf, v4sf)
10811 v4sf __builtin_ia32_cmpleps (v4sf, v4sf)
10812 v4sf __builtin_ia32_cmpgtps (v4sf, v4sf)
10813 v4sf __builtin_ia32_cmpgeps (v4sf, v4sf)
10814 v4sf __builtin_ia32_cmpunordps (v4sf, v4sf)
10815 v4sf __builtin_ia32_cmpneqps (v4sf, v4sf)
10816 v4sf __builtin_ia32_cmpnltps (v4sf, v4sf)
10817 v4sf __builtin_ia32_cmpnleps (v4sf, v4sf)
10818 v4sf __builtin_ia32_cmpngtps (v4sf, v4sf)
10819 v4sf __builtin_ia32_cmpngeps (v4sf, v4sf)
10820 v4sf __builtin_ia32_cmpordps (v4sf, v4sf)
10821 v4sf __builtin_ia32_cmpeqss (v4sf, v4sf)
10822 v4sf __builtin_ia32_cmpltss (v4sf, v4sf)
10823 v4sf __builtin_ia32_cmpless (v4sf, v4sf)
10824 v4sf __builtin_ia32_cmpunordss (v4sf, v4sf)
10825 v4sf __builtin_ia32_cmpneqss (v4sf, v4sf)
10826 v4sf __builtin_ia32_cmpnltss (v4sf, v4sf)
10827 v4sf __builtin_ia32_cmpnless (v4sf, v4sf)
10828 v4sf __builtin_ia32_cmpordss (v4sf, v4sf)
10829 v4sf __builtin_ia32_maxps (v4sf, v4sf)
10830 v4sf __builtin_ia32_maxss (v4sf, v4sf)
10831 v4sf __builtin_ia32_minps (v4sf, v4sf)
10832 v4sf __builtin_ia32_minss (v4sf, v4sf)
10833 v4sf __builtin_ia32_andps (v4sf, v4sf)
10834 v4sf __builtin_ia32_andnps (v4sf, v4sf)
10835 v4sf __builtin_ia32_orps (v4sf, v4sf)
10836 v4sf __builtin_ia32_xorps (v4sf, v4sf)
10837 v4sf __builtin_ia32_movss (v4sf, v4sf)
10838 v4sf __builtin_ia32_movhlps (v4sf, v4sf)
10839 v4sf __builtin_ia32_movlhps (v4sf, v4sf)
10840 v4sf __builtin_ia32_unpckhps (v4sf, v4sf)
10841 v4sf __builtin_ia32_unpcklps (v4sf, v4sf)
10842 v4sf __builtin_ia32_cvtpi2ps (v4sf, v2si)
10843 v4sf __builtin_ia32_cvtsi2ss (v4sf, int)
10844 v2si __builtin_ia32_cvtps2pi (v4sf)
10845 int __builtin_ia32_cvtss2si (v4sf)
10846 v2si __builtin_ia32_cvttps2pi (v4sf)
10847 int __builtin_ia32_cvttss2si (v4sf)
10848 v4sf __builtin_ia32_rcpps (v4sf)
10849 v4sf __builtin_ia32_rsqrtps (v4sf)
10850 v4sf __builtin_ia32_sqrtps (v4sf)
10851 v4sf __builtin_ia32_rcpss (v4sf)
10852 v4sf __builtin_ia32_rsqrtss (v4sf)
10853 v4sf __builtin_ia32_sqrtss (v4sf)
10854 v4sf __builtin_ia32_shufps (v4sf, v4sf, int)
10855 void __builtin_ia32_movntps (float *, v4sf)
10856 int __builtin_ia32_movmskps (v4sf)
10857 @end smallexample
10859 The following built-in functions are available when @option{-msse} is used.
10861 @table @code
10862 @item v4sf __builtin_ia32_loadups (float *)
10863 Generates the @code{movups} machine instruction as a load from memory.
10864 @item void __builtin_ia32_storeups (float *, v4sf)
10865 Generates the @code{movups} machine instruction as a store to memory.
10866 @item v4sf __builtin_ia32_loadss (float *)
10867 Generates the @code{movss} machine instruction as a load from memory.
10868 @item v4sf __builtin_ia32_loadhps (v4sf, const v2sf *)
10869 Generates the @code{movhps} machine instruction as a load from memory.
10870 @item v4sf __builtin_ia32_loadlps (v4sf, const v2sf *)
10871 Generates the @code{movlps} machine instruction as a load from memory
10872 @item void __builtin_ia32_storehps (v2sf *, v4sf)
10873 Generates the @code{movhps} machine instruction as a store to memory.
10874 @item void __builtin_ia32_storelps (v2sf *, v4sf)
10875 Generates the @code{movlps} machine instruction as a store to memory.
10876 @end table
10878 The following built-in functions are available when @option{-msse2} is used.
10879 All of them generate the machine instruction that is part of the name.
10881 @smallexample
10882 int __builtin_ia32_comisdeq (v2df, v2df)
10883 int __builtin_ia32_comisdlt (v2df, v2df)
10884 int __builtin_ia32_comisdle (v2df, v2df)
10885 int __builtin_ia32_comisdgt (v2df, v2df)
10886 int __builtin_ia32_comisdge (v2df, v2df)
10887 int __builtin_ia32_comisdneq (v2df, v2df)
10888 int __builtin_ia32_ucomisdeq (v2df, v2df)
10889 int __builtin_ia32_ucomisdlt (v2df, v2df)
10890 int __builtin_ia32_ucomisdle (v2df, v2df)
10891 int __builtin_ia32_ucomisdgt (v2df, v2df)
10892 int __builtin_ia32_ucomisdge (v2df, v2df)
10893 int __builtin_ia32_ucomisdneq (v2df, v2df)
10894 v2df __builtin_ia32_cmpeqpd (v2df, v2df)
10895 v2df __builtin_ia32_cmpltpd (v2df, v2df)
10896 v2df __builtin_ia32_cmplepd (v2df, v2df)
10897 v2df __builtin_ia32_cmpgtpd (v2df, v2df)
10898 v2df __builtin_ia32_cmpgepd (v2df, v2df)
10899 v2df __builtin_ia32_cmpunordpd (v2df, v2df)
10900 v2df __builtin_ia32_cmpneqpd (v2df, v2df)
10901 v2df __builtin_ia32_cmpnltpd (v2df, v2df)
10902 v2df __builtin_ia32_cmpnlepd (v2df, v2df)
10903 v2df __builtin_ia32_cmpngtpd (v2df, v2df)
10904 v2df __builtin_ia32_cmpngepd (v2df, v2df)
10905 v2df __builtin_ia32_cmpordpd (v2df, v2df)
10906 v2df __builtin_ia32_cmpeqsd (v2df, v2df)
10907 v2df __builtin_ia32_cmpltsd (v2df, v2df)
10908 v2df __builtin_ia32_cmplesd (v2df, v2df)
10909 v2df __builtin_ia32_cmpunordsd (v2df, v2df)
10910 v2df __builtin_ia32_cmpneqsd (v2df, v2df)
10911 v2df __builtin_ia32_cmpnltsd (v2df, v2df)
10912 v2df __builtin_ia32_cmpnlesd (v2df, v2df)
10913 v2df __builtin_ia32_cmpordsd (v2df, v2df)
10914 v2di __builtin_ia32_paddq (v2di, v2di)
10915 v2di __builtin_ia32_psubq (v2di, v2di)
10916 v2df __builtin_ia32_addpd (v2df, v2df)
10917 v2df __builtin_ia32_subpd (v2df, v2df)
10918 v2df __builtin_ia32_mulpd (v2df, v2df)
10919 v2df __builtin_ia32_divpd (v2df, v2df)
10920 v2df __builtin_ia32_addsd (v2df, v2df)
10921 v2df __builtin_ia32_subsd (v2df, v2df)
10922 v2df __builtin_ia32_mulsd (v2df, v2df)
10923 v2df __builtin_ia32_divsd (v2df, v2df)
10924 v2df __builtin_ia32_minpd (v2df, v2df)
10925 v2df __builtin_ia32_maxpd (v2df, v2df)
10926 v2df __builtin_ia32_minsd (v2df, v2df)
10927 v2df __builtin_ia32_maxsd (v2df, v2df)
10928 v2df __builtin_ia32_andpd (v2df, v2df)
10929 v2df __builtin_ia32_andnpd (v2df, v2df)
10930 v2df __builtin_ia32_orpd (v2df, v2df)
10931 v2df __builtin_ia32_xorpd (v2df, v2df)
10932 v2df __builtin_ia32_movsd (v2df, v2df)
10933 v2df __builtin_ia32_unpckhpd (v2df, v2df)
10934 v2df __builtin_ia32_unpcklpd (v2df, v2df)
10935 v16qi __builtin_ia32_paddb128 (v16qi, v16qi)
10936 v8hi __builtin_ia32_paddw128 (v8hi, v8hi)
10937 v4si __builtin_ia32_paddd128 (v4si, v4si)
10938 v2di __builtin_ia32_paddq128 (v2di, v2di)
10939 v16qi __builtin_ia32_psubb128 (v16qi, v16qi)
10940 v8hi __builtin_ia32_psubw128 (v8hi, v8hi)
10941 v4si __builtin_ia32_psubd128 (v4si, v4si)
10942 v2di __builtin_ia32_psubq128 (v2di, v2di)
10943 v8hi __builtin_ia32_pmullw128 (v8hi, v8hi)
10944 v8hi __builtin_ia32_pmulhw128 (v8hi, v8hi)
10945 v2di __builtin_ia32_pand128 (v2di, v2di)
10946 v2di __builtin_ia32_pandn128 (v2di, v2di)
10947 v2di __builtin_ia32_por128 (v2di, v2di)
10948 v2di __builtin_ia32_pxor128 (v2di, v2di)
10949 v16qi __builtin_ia32_pavgb128 (v16qi, v16qi)
10950 v8hi __builtin_ia32_pavgw128 (v8hi, v8hi)
10951 v16qi __builtin_ia32_pcmpeqb128 (v16qi, v16qi)
10952 v8hi __builtin_ia32_pcmpeqw128 (v8hi, v8hi)
10953 v4si __builtin_ia32_pcmpeqd128 (v4si, v4si)
10954 v16qi __builtin_ia32_pcmpgtb128 (v16qi, v16qi)
10955 v8hi __builtin_ia32_pcmpgtw128 (v8hi, v8hi)
10956 v4si __builtin_ia32_pcmpgtd128 (v4si, v4si)
10957 v16qi __builtin_ia32_pmaxub128 (v16qi, v16qi)
10958 v8hi __builtin_ia32_pmaxsw128 (v8hi, v8hi)
10959 v16qi __builtin_ia32_pminub128 (v16qi, v16qi)
10960 v8hi __builtin_ia32_pminsw128 (v8hi, v8hi)
10961 v16qi __builtin_ia32_punpckhbw128 (v16qi, v16qi)
10962 v8hi __builtin_ia32_punpckhwd128 (v8hi, v8hi)
10963 v4si __builtin_ia32_punpckhdq128 (v4si, v4si)
10964 v2di __builtin_ia32_punpckhqdq128 (v2di, v2di)
10965 v16qi __builtin_ia32_punpcklbw128 (v16qi, v16qi)
10966 v8hi __builtin_ia32_punpcklwd128 (v8hi, v8hi)
10967 v4si __builtin_ia32_punpckldq128 (v4si, v4si)
10968 v2di __builtin_ia32_punpcklqdq128 (v2di, v2di)
10969 v16qi __builtin_ia32_packsswb128 (v8hi, v8hi)
10970 v8hi __builtin_ia32_packssdw128 (v4si, v4si)
10971 v16qi __builtin_ia32_packuswb128 (v8hi, v8hi)
10972 v8hi __builtin_ia32_pmulhuw128 (v8hi, v8hi)
10973 void __builtin_ia32_maskmovdqu (v16qi, v16qi)
10974 v2df __builtin_ia32_loadupd (double *)
10975 void __builtin_ia32_storeupd (double *, v2df)
10976 v2df __builtin_ia32_loadhpd (v2df, double const *)
10977 v2df __builtin_ia32_loadlpd (v2df, double const *)
10978 int __builtin_ia32_movmskpd (v2df)
10979 int __builtin_ia32_pmovmskb128 (v16qi)
10980 void __builtin_ia32_movnti (int *, int)
10981 void __builtin_ia32_movnti64 (long long int *, long long int)
10982 void __builtin_ia32_movntpd (double *, v2df)
10983 void __builtin_ia32_movntdq (v2df *, v2df)
10984 v4si __builtin_ia32_pshufd (v4si, int)
10985 v8hi __builtin_ia32_pshuflw (v8hi, int)
10986 v8hi __builtin_ia32_pshufhw (v8hi, int)
10987 v2di __builtin_ia32_psadbw128 (v16qi, v16qi)
10988 v2df __builtin_ia32_sqrtpd (v2df)
10989 v2df __builtin_ia32_sqrtsd (v2df)
10990 v2df __builtin_ia32_shufpd (v2df, v2df, int)
10991 v2df __builtin_ia32_cvtdq2pd (v4si)
10992 v4sf __builtin_ia32_cvtdq2ps (v4si)
10993 v4si __builtin_ia32_cvtpd2dq (v2df)
10994 v2si __builtin_ia32_cvtpd2pi (v2df)
10995 v4sf __builtin_ia32_cvtpd2ps (v2df)
10996 v4si __builtin_ia32_cvttpd2dq (v2df)
10997 v2si __builtin_ia32_cvttpd2pi (v2df)
10998 v2df __builtin_ia32_cvtpi2pd (v2si)
10999 int __builtin_ia32_cvtsd2si (v2df)
11000 int __builtin_ia32_cvttsd2si (v2df)
11001 long long __builtin_ia32_cvtsd2si64 (v2df)
11002 long long __builtin_ia32_cvttsd2si64 (v2df)
11003 v4si __builtin_ia32_cvtps2dq (v4sf)
11004 v2df __builtin_ia32_cvtps2pd (v4sf)
11005 v4si __builtin_ia32_cvttps2dq (v4sf)
11006 v2df __builtin_ia32_cvtsi2sd (v2df, int)
11007 v2df __builtin_ia32_cvtsi642sd (v2df, long long)
11008 v4sf __builtin_ia32_cvtsd2ss (v4sf, v2df)
11009 v2df __builtin_ia32_cvtss2sd (v2df, v4sf)
11010 void __builtin_ia32_clflush (const void *)
11011 void __builtin_ia32_lfence (void)
11012 void __builtin_ia32_mfence (void)
11013 v16qi __builtin_ia32_loaddqu (const char *)
11014 void __builtin_ia32_storedqu (char *, v16qi)
11015 v1di __builtin_ia32_pmuludq (v2si, v2si)
11016 v2di __builtin_ia32_pmuludq128 (v4si, v4si)
11017 v8hi __builtin_ia32_psllw128 (v8hi, v8hi)
11018 v4si __builtin_ia32_pslld128 (v4si, v4si)
11019 v2di __builtin_ia32_psllq128 (v2di, v2di)
11020 v8hi __builtin_ia32_psrlw128 (v8hi, v8hi)
11021 v4si __builtin_ia32_psrld128 (v4si, v4si)
11022 v2di __builtin_ia32_psrlq128 (v2di, v2di)
11023 v8hi __builtin_ia32_psraw128 (v8hi, v8hi)
11024 v4si __builtin_ia32_psrad128 (v4si, v4si)
11025 v2di __builtin_ia32_pslldqi128 (v2di, int)
11026 v8hi __builtin_ia32_psllwi128 (v8hi, int)
11027 v4si __builtin_ia32_pslldi128 (v4si, int)
11028 v2di __builtin_ia32_psllqi128 (v2di, int)
11029 v2di __builtin_ia32_psrldqi128 (v2di, int)
11030 v8hi __builtin_ia32_psrlwi128 (v8hi, int)
11031 v4si __builtin_ia32_psrldi128 (v4si, int)
11032 v2di __builtin_ia32_psrlqi128 (v2di, int)
11033 v8hi __builtin_ia32_psrawi128 (v8hi, int)
11034 v4si __builtin_ia32_psradi128 (v4si, int)
11035 v4si __builtin_ia32_pmaddwd128 (v8hi, v8hi)
11036 v2di __builtin_ia32_movq128 (v2di)
11037 @end smallexample
11039 The following built-in functions are available when @option{-msse3} is used.
11040 All of them generate the machine instruction that is part of the name.
11042 @smallexample
11043 v2df __builtin_ia32_addsubpd (v2df, v2df)
11044 v4sf __builtin_ia32_addsubps (v4sf, v4sf)
11045 v2df __builtin_ia32_haddpd (v2df, v2df)
11046 v4sf __builtin_ia32_haddps (v4sf, v4sf)
11047 v2df __builtin_ia32_hsubpd (v2df, v2df)
11048 v4sf __builtin_ia32_hsubps (v4sf, v4sf)
11049 v16qi __builtin_ia32_lddqu (char const *)
11050 void __builtin_ia32_monitor (void *, unsigned int, unsigned int)
11051 v4sf __builtin_ia32_movshdup (v4sf)
11052 v4sf __builtin_ia32_movsldup (v4sf)
11053 void __builtin_ia32_mwait (unsigned int, unsigned int)
11054 @end smallexample
11056 The following built-in functions are available when @option{-mssse3} is used.
11057 All of them generate the machine instruction that is part of the name.
11059 @smallexample
11060 v2si __builtin_ia32_phaddd (v2si, v2si)
11061 v4hi __builtin_ia32_phaddw (v4hi, v4hi)
11062 v4hi __builtin_ia32_phaddsw (v4hi, v4hi)
11063 v2si __builtin_ia32_phsubd (v2si, v2si)
11064 v4hi __builtin_ia32_phsubw (v4hi, v4hi)
11065 v4hi __builtin_ia32_phsubsw (v4hi, v4hi)
11066 v4hi __builtin_ia32_pmaddubsw (v8qi, v8qi)
11067 v4hi __builtin_ia32_pmulhrsw (v4hi, v4hi)
11068 v8qi __builtin_ia32_pshufb (v8qi, v8qi)
11069 v8qi __builtin_ia32_psignb (v8qi, v8qi)
11070 v2si __builtin_ia32_psignd (v2si, v2si)
11071 v4hi __builtin_ia32_psignw (v4hi, v4hi)
11072 v1di __builtin_ia32_palignr (v1di, v1di, int)
11073 v8qi __builtin_ia32_pabsb (v8qi)
11074 v2si __builtin_ia32_pabsd (v2si)
11075 v4hi __builtin_ia32_pabsw (v4hi)
11076 @end smallexample
11078 The following built-in functions are available when @option{-mssse3} is used.
11079 All of them generate the machine instruction that is part of the name.
11081 @smallexample
11082 v4si __builtin_ia32_phaddd128 (v4si, v4si)
11083 v8hi __builtin_ia32_phaddw128 (v8hi, v8hi)
11084 v8hi __builtin_ia32_phaddsw128 (v8hi, v8hi)
11085 v4si __builtin_ia32_phsubd128 (v4si, v4si)
11086 v8hi __builtin_ia32_phsubw128 (v8hi, v8hi)
11087 v8hi __builtin_ia32_phsubsw128 (v8hi, v8hi)
11088 v8hi __builtin_ia32_pmaddubsw128 (v16qi, v16qi)
11089 v8hi __builtin_ia32_pmulhrsw128 (v8hi, v8hi)
11090 v16qi __builtin_ia32_pshufb128 (v16qi, v16qi)
11091 v16qi __builtin_ia32_psignb128 (v16qi, v16qi)
11092 v4si __builtin_ia32_psignd128 (v4si, v4si)
11093 v8hi __builtin_ia32_psignw128 (v8hi, v8hi)
11094 v2di __builtin_ia32_palignr128 (v2di, v2di, int)
11095 v16qi __builtin_ia32_pabsb128 (v16qi)
11096 v4si __builtin_ia32_pabsd128 (v4si)
11097 v8hi __builtin_ia32_pabsw128 (v8hi)
11098 @end smallexample
11100 The following built-in functions are available when @option{-msse4.1} is
11101 used.  All of them generate the machine instruction that is part of the
11102 name.
11104 @smallexample
11105 v2df __builtin_ia32_blendpd (v2df, v2df, const int)
11106 v4sf __builtin_ia32_blendps (v4sf, v4sf, const int)
11107 v2df __builtin_ia32_blendvpd (v2df, v2df, v2df)
11108 v4sf __builtin_ia32_blendvps (v4sf, v4sf, v4sf)
11109 v2df __builtin_ia32_dppd (v2df, v2df, const int)
11110 v4sf __builtin_ia32_dpps (v4sf, v4sf, const int)
11111 v4sf __builtin_ia32_insertps128 (v4sf, v4sf, const int)
11112 v2di __builtin_ia32_movntdqa (v2di *);
11113 v16qi __builtin_ia32_mpsadbw128 (v16qi, v16qi, const int)
11114 v8hi __builtin_ia32_packusdw128 (v4si, v4si)
11115 v16qi __builtin_ia32_pblendvb128 (v16qi, v16qi, v16qi)
11116 v8hi __builtin_ia32_pblendw128 (v8hi, v8hi, const int)
11117 v2di __builtin_ia32_pcmpeqq (v2di, v2di)
11118 v8hi __builtin_ia32_phminposuw128 (v8hi)
11119 v16qi __builtin_ia32_pmaxsb128 (v16qi, v16qi)
11120 v4si __builtin_ia32_pmaxsd128 (v4si, v4si)
11121 v4si __builtin_ia32_pmaxud128 (v4si, v4si)
11122 v8hi __builtin_ia32_pmaxuw128 (v8hi, v8hi)
11123 v16qi __builtin_ia32_pminsb128 (v16qi, v16qi)
11124 v4si __builtin_ia32_pminsd128 (v4si, v4si)
11125 v4si __builtin_ia32_pminud128 (v4si, v4si)
11126 v8hi __builtin_ia32_pminuw128 (v8hi, v8hi)
11127 v4si __builtin_ia32_pmovsxbd128 (v16qi)
11128 v2di __builtin_ia32_pmovsxbq128 (v16qi)
11129 v8hi __builtin_ia32_pmovsxbw128 (v16qi)
11130 v2di __builtin_ia32_pmovsxdq128 (v4si)
11131 v4si __builtin_ia32_pmovsxwd128 (v8hi)
11132 v2di __builtin_ia32_pmovsxwq128 (v8hi)
11133 v4si __builtin_ia32_pmovzxbd128 (v16qi)
11134 v2di __builtin_ia32_pmovzxbq128 (v16qi)
11135 v8hi __builtin_ia32_pmovzxbw128 (v16qi)
11136 v2di __builtin_ia32_pmovzxdq128 (v4si)
11137 v4si __builtin_ia32_pmovzxwd128 (v8hi)
11138 v2di __builtin_ia32_pmovzxwq128 (v8hi)
11139 v2di __builtin_ia32_pmuldq128 (v4si, v4si)
11140 v4si __builtin_ia32_pmulld128 (v4si, v4si)
11141 int __builtin_ia32_ptestc128 (v2di, v2di)
11142 int __builtin_ia32_ptestnzc128 (v2di, v2di)
11143 int __builtin_ia32_ptestz128 (v2di, v2di)
11144 v2df __builtin_ia32_roundpd (v2df, const int)
11145 v4sf __builtin_ia32_roundps (v4sf, const int)
11146 v2df __builtin_ia32_roundsd (v2df, v2df, const int)
11147 v4sf __builtin_ia32_roundss (v4sf, v4sf, const int)
11148 @end smallexample
11150 The following built-in functions are available when @option{-msse4.1} is
11151 used.
11153 @table @code
11154 @item v4sf __builtin_ia32_vec_set_v4sf (v4sf, float, const int)
11155 Generates the @code{insertps} machine instruction.
11156 @item int __builtin_ia32_vec_ext_v16qi (v16qi, const int)
11157 Generates the @code{pextrb} machine instruction.
11158 @item v16qi __builtin_ia32_vec_set_v16qi (v16qi, int, const int)
11159 Generates the @code{pinsrb} machine instruction.
11160 @item v4si __builtin_ia32_vec_set_v4si (v4si, int, const int)
11161 Generates the @code{pinsrd} machine instruction.
11162 @item v2di __builtin_ia32_vec_set_v2di (v2di, long long, const int)
11163 Generates the @code{pinsrq} machine instruction in 64bit mode.
11164 @end table
11166 The following built-in functions are changed to generate new SSE4.1
11167 instructions when @option{-msse4.1} is used.
11169 @table @code
11170 @item float __builtin_ia32_vec_ext_v4sf (v4sf, const int)
11171 Generates the @code{extractps} machine instruction.
11172 @item int __builtin_ia32_vec_ext_v4si (v4si, const int)
11173 Generates the @code{pextrd} machine instruction.
11174 @item long long __builtin_ia32_vec_ext_v2di (v2di, const int)
11175 Generates the @code{pextrq} machine instruction in 64bit mode.
11176 @end table
11178 The following built-in functions are available when @option{-msse4.2} is
11179 used.  All of them generate the machine instruction that is part of the
11180 name.
11182 @smallexample
11183 v16qi __builtin_ia32_pcmpestrm128 (v16qi, int, v16qi, int, const int)
11184 int __builtin_ia32_pcmpestri128 (v16qi, int, v16qi, int, const int)
11185 int __builtin_ia32_pcmpestria128 (v16qi, int, v16qi, int, const int)
11186 int __builtin_ia32_pcmpestric128 (v16qi, int, v16qi, int, const int)
11187 int __builtin_ia32_pcmpestrio128 (v16qi, int, v16qi, int, const int)
11188 int __builtin_ia32_pcmpestris128 (v16qi, int, v16qi, int, const int)
11189 int __builtin_ia32_pcmpestriz128 (v16qi, int, v16qi, int, const int)
11190 v16qi __builtin_ia32_pcmpistrm128 (v16qi, v16qi, const int)
11191 int __builtin_ia32_pcmpistri128 (v16qi, v16qi, const int)
11192 int __builtin_ia32_pcmpistria128 (v16qi, v16qi, const int)
11193 int __builtin_ia32_pcmpistric128 (v16qi, v16qi, const int)
11194 int __builtin_ia32_pcmpistrio128 (v16qi, v16qi, const int)
11195 int __builtin_ia32_pcmpistris128 (v16qi, v16qi, const int)
11196 int __builtin_ia32_pcmpistriz128 (v16qi, v16qi, const int)
11197 v2di __builtin_ia32_pcmpgtq (v2di, v2di)
11198 @end smallexample
11200 The following built-in functions are available when @option{-msse4.2} is
11201 used.
11203 @table @code
11204 @item unsigned int __builtin_ia32_crc32qi (unsigned int, unsigned char)
11205 Generates the @code{crc32b} machine instruction.
11206 @item unsigned int __builtin_ia32_crc32hi (unsigned int, unsigned short)
11207 Generates the @code{crc32w} machine instruction.
11208 @item unsigned int __builtin_ia32_crc32si (unsigned int, unsigned int)
11209 Generates the @code{crc32l} machine instruction.
11210 @item unsigned long long __builtin_ia32_crc32di (unsigned long long, unsigned long long)
11211 Generates the @code{crc32q} machine instruction.
11212 @end table
11214 The following built-in functions are changed to generate new SSE4.2
11215 instructions when @option{-msse4.2} is used.
11217 @table @code
11218 @item int __builtin_popcount (unsigned int)
11219 Generates the @code{popcntl} machine instruction.
11220 @item int __builtin_popcountl (unsigned long)
11221 Generates the @code{popcntl} or @code{popcntq} machine instruction,
11222 depending on the size of @code{unsigned long}.
11223 @item int __builtin_popcountll (unsigned long long)
11224 Generates the @code{popcntq} machine instruction.
11225 @end table
11227 The following built-in functions are available when @option{-mavx} is
11228 used. All of them generate the machine instruction that is part of the
11229 name.
11231 @smallexample
11232 v4df __builtin_ia32_addpd256 (v4df,v4df)
11233 v8sf __builtin_ia32_addps256 (v8sf,v8sf)
11234 v4df __builtin_ia32_addsubpd256 (v4df,v4df)
11235 v8sf __builtin_ia32_addsubps256 (v8sf,v8sf)
11236 v4df __builtin_ia32_andnpd256 (v4df,v4df)
11237 v8sf __builtin_ia32_andnps256 (v8sf,v8sf)
11238 v4df __builtin_ia32_andpd256 (v4df,v4df)
11239 v8sf __builtin_ia32_andps256 (v8sf,v8sf)
11240 v4df __builtin_ia32_blendpd256 (v4df,v4df,int)
11241 v8sf __builtin_ia32_blendps256 (v8sf,v8sf,int)
11242 v4df __builtin_ia32_blendvpd256 (v4df,v4df,v4df)
11243 v8sf __builtin_ia32_blendvps256 (v8sf,v8sf,v8sf)
11244 v2df __builtin_ia32_cmppd (v2df,v2df,int)
11245 v4df __builtin_ia32_cmppd256 (v4df,v4df,int)
11246 v4sf __builtin_ia32_cmpps (v4sf,v4sf,int)
11247 v8sf __builtin_ia32_cmpps256 (v8sf,v8sf,int)
11248 v2df __builtin_ia32_cmpsd (v2df,v2df,int)
11249 v4sf __builtin_ia32_cmpss (v4sf,v4sf,int)
11250 v4df __builtin_ia32_cvtdq2pd256 (v4si)
11251 v8sf __builtin_ia32_cvtdq2ps256 (v8si)
11252 v4si __builtin_ia32_cvtpd2dq256 (v4df)
11253 v4sf __builtin_ia32_cvtpd2ps256 (v4df)
11254 v8si __builtin_ia32_cvtps2dq256 (v8sf)
11255 v4df __builtin_ia32_cvtps2pd256 (v4sf)
11256 v4si __builtin_ia32_cvttpd2dq256 (v4df)
11257 v8si __builtin_ia32_cvttps2dq256 (v8sf)
11258 v4df __builtin_ia32_divpd256 (v4df,v4df)
11259 v8sf __builtin_ia32_divps256 (v8sf,v8sf)
11260 v8sf __builtin_ia32_dpps256 (v8sf,v8sf,int)
11261 v4df __builtin_ia32_haddpd256 (v4df,v4df)
11262 v8sf __builtin_ia32_haddps256 (v8sf,v8sf)
11263 v4df __builtin_ia32_hsubpd256 (v4df,v4df)
11264 v8sf __builtin_ia32_hsubps256 (v8sf,v8sf)
11265 v32qi __builtin_ia32_lddqu256 (pcchar)
11266 v32qi __builtin_ia32_loaddqu256 (pcchar)
11267 v4df __builtin_ia32_loadupd256 (pcdouble)
11268 v8sf __builtin_ia32_loadups256 (pcfloat)
11269 v2df __builtin_ia32_maskloadpd (pcv2df,v2df)
11270 v4df __builtin_ia32_maskloadpd256 (pcv4df,v4df)
11271 v4sf __builtin_ia32_maskloadps (pcv4sf,v4sf)
11272 v8sf __builtin_ia32_maskloadps256 (pcv8sf,v8sf)
11273 void __builtin_ia32_maskstorepd (pv2df,v2df,v2df)
11274 void __builtin_ia32_maskstorepd256 (pv4df,v4df,v4df)
11275 void __builtin_ia32_maskstoreps (pv4sf,v4sf,v4sf)
11276 void __builtin_ia32_maskstoreps256 (pv8sf,v8sf,v8sf)
11277 v4df __builtin_ia32_maxpd256 (v4df,v4df)
11278 v8sf __builtin_ia32_maxps256 (v8sf,v8sf)
11279 v4df __builtin_ia32_minpd256 (v4df,v4df)
11280 v8sf __builtin_ia32_minps256 (v8sf,v8sf)
11281 v4df __builtin_ia32_movddup256 (v4df)
11282 int __builtin_ia32_movmskpd256 (v4df)
11283 int __builtin_ia32_movmskps256 (v8sf)
11284 v8sf __builtin_ia32_movshdup256 (v8sf)
11285 v8sf __builtin_ia32_movsldup256 (v8sf)
11286 v4df __builtin_ia32_mulpd256 (v4df,v4df)
11287 v8sf __builtin_ia32_mulps256 (v8sf,v8sf)
11288 v4df __builtin_ia32_orpd256 (v4df,v4df)
11289 v8sf __builtin_ia32_orps256 (v8sf,v8sf)
11290 v2df __builtin_ia32_pd_pd256 (v4df)
11291 v4df __builtin_ia32_pd256_pd (v2df)
11292 v4sf __builtin_ia32_ps_ps256 (v8sf)
11293 v8sf __builtin_ia32_ps256_ps (v4sf)
11294 int __builtin_ia32_ptestc256 (v4di,v4di,ptest)
11295 int __builtin_ia32_ptestnzc256 (v4di,v4di,ptest)
11296 int __builtin_ia32_ptestz256 (v4di,v4di,ptest)
11297 v8sf __builtin_ia32_rcpps256 (v8sf)
11298 v4df __builtin_ia32_roundpd256 (v4df,int)
11299 v8sf __builtin_ia32_roundps256 (v8sf,int)
11300 v8sf __builtin_ia32_rsqrtps_nr256 (v8sf)
11301 v8sf __builtin_ia32_rsqrtps256 (v8sf)
11302 v4df __builtin_ia32_shufpd256 (v4df,v4df,int)
11303 v8sf __builtin_ia32_shufps256 (v8sf,v8sf,int)
11304 v4si __builtin_ia32_si_si256 (v8si)
11305 v8si __builtin_ia32_si256_si (v4si)
11306 v4df __builtin_ia32_sqrtpd256 (v4df)
11307 v8sf __builtin_ia32_sqrtps_nr256 (v8sf)
11308 v8sf __builtin_ia32_sqrtps256 (v8sf)
11309 void __builtin_ia32_storedqu256 (pchar,v32qi)
11310 void __builtin_ia32_storeupd256 (pdouble,v4df)
11311 void __builtin_ia32_storeups256 (pfloat,v8sf)
11312 v4df __builtin_ia32_subpd256 (v4df,v4df)
11313 v8sf __builtin_ia32_subps256 (v8sf,v8sf)
11314 v4df __builtin_ia32_unpckhpd256 (v4df,v4df)
11315 v8sf __builtin_ia32_unpckhps256 (v8sf,v8sf)
11316 v4df __builtin_ia32_unpcklpd256 (v4df,v4df)
11317 v8sf __builtin_ia32_unpcklps256 (v8sf,v8sf)
11318 v4df __builtin_ia32_vbroadcastf128_pd256 (pcv2df)
11319 v8sf __builtin_ia32_vbroadcastf128_ps256 (pcv4sf)
11320 v4df __builtin_ia32_vbroadcastsd256 (pcdouble)
11321 v4sf __builtin_ia32_vbroadcastss (pcfloat)
11322 v8sf __builtin_ia32_vbroadcastss256 (pcfloat)
11323 v2df __builtin_ia32_vextractf128_pd256 (v4df,int)
11324 v4sf __builtin_ia32_vextractf128_ps256 (v8sf,int)
11325 v4si __builtin_ia32_vextractf128_si256 (v8si,int)
11326 v4df __builtin_ia32_vinsertf128_pd256 (v4df,v2df,int)
11327 v8sf __builtin_ia32_vinsertf128_ps256 (v8sf,v4sf,int)
11328 v8si __builtin_ia32_vinsertf128_si256 (v8si,v4si,int)
11329 v4df __builtin_ia32_vperm2f128_pd256 (v4df,v4df,int)
11330 v8sf __builtin_ia32_vperm2f128_ps256 (v8sf,v8sf,int)
11331 v8si __builtin_ia32_vperm2f128_si256 (v8si,v8si,int)
11332 v2df __builtin_ia32_vpermil2pd (v2df,v2df,v2di,int)
11333 v4df __builtin_ia32_vpermil2pd256 (v4df,v4df,v4di,int)
11334 v4sf __builtin_ia32_vpermil2ps (v4sf,v4sf,v4si,int)
11335 v8sf __builtin_ia32_vpermil2ps256 (v8sf,v8sf,v8si,int)
11336 v2df __builtin_ia32_vpermilpd (v2df,int)
11337 v4df __builtin_ia32_vpermilpd256 (v4df,int)
11338 v4sf __builtin_ia32_vpermilps (v4sf,int)
11339 v8sf __builtin_ia32_vpermilps256 (v8sf,int)
11340 v2df __builtin_ia32_vpermilvarpd (v2df,v2di)
11341 v4df __builtin_ia32_vpermilvarpd256 (v4df,v4di)
11342 v4sf __builtin_ia32_vpermilvarps (v4sf,v4si)
11343 v8sf __builtin_ia32_vpermilvarps256 (v8sf,v8si)
11344 int __builtin_ia32_vtestcpd (v2df,v2df,ptest)
11345 int __builtin_ia32_vtestcpd256 (v4df,v4df,ptest)
11346 int __builtin_ia32_vtestcps (v4sf,v4sf,ptest)
11347 int __builtin_ia32_vtestcps256 (v8sf,v8sf,ptest)
11348 int __builtin_ia32_vtestnzcpd (v2df,v2df,ptest)
11349 int __builtin_ia32_vtestnzcpd256 (v4df,v4df,ptest)
11350 int __builtin_ia32_vtestnzcps (v4sf,v4sf,ptest)
11351 int __builtin_ia32_vtestnzcps256 (v8sf,v8sf,ptest)
11352 int __builtin_ia32_vtestzpd (v2df,v2df,ptest)
11353 int __builtin_ia32_vtestzpd256 (v4df,v4df,ptest)
11354 int __builtin_ia32_vtestzps (v4sf,v4sf,ptest)
11355 int __builtin_ia32_vtestzps256 (v8sf,v8sf,ptest)
11356 void __builtin_ia32_vzeroall (void)
11357 void __builtin_ia32_vzeroupper (void)
11358 v4df __builtin_ia32_xorpd256 (v4df,v4df)
11359 v8sf __builtin_ia32_xorps256 (v8sf,v8sf)
11360 @end smallexample
11362 The following built-in functions are available when @option{-mavx2} is
11363 used. All of them generate the machine instruction that is part of the
11364 name.
11366 @smallexample
11367 v32qi __builtin_ia32_mpsadbw256 (v32qi,v32qi,int)
11368 v32qi __builtin_ia32_pabsb256 (v32qi)
11369 v16hi __builtin_ia32_pabsw256 (v16hi)
11370 v8si __builtin_ia32_pabsd256 (v8si)
11371 v16hi __builtin_ia32_packssdw256 (v8si,v8si)
11372 v32qi __builtin_ia32_packsswb256 (v16hi,v16hi)
11373 v16hi __builtin_ia32_packusdw256 (v8si,v8si)
11374 v32qi __builtin_ia32_packuswb256 (v16hi,v16hi)
11375 v32qi __builtin_ia32_paddb256 (v32qi,v32qi)
11376 v16hi __builtin_ia32_paddw256 (v16hi,v16hi)
11377 v8si __builtin_ia32_paddd256 (v8si,v8si)
11378 v4di __builtin_ia32_paddq256 (v4di,v4di)
11379 v32qi __builtin_ia32_paddsb256 (v32qi,v32qi)
11380 v16hi __builtin_ia32_paddsw256 (v16hi,v16hi)
11381 v32qi __builtin_ia32_paddusb256 (v32qi,v32qi)
11382 v16hi __builtin_ia32_paddusw256 (v16hi,v16hi)
11383 v4di __builtin_ia32_palignr256 (v4di,v4di,int)
11384 v4di __builtin_ia32_andsi256 (v4di,v4di)
11385 v4di __builtin_ia32_andnotsi256 (v4di,v4di)
11386 v32qi __builtin_ia32_pavgb256 (v32qi,v32qi)
11387 v16hi __builtin_ia32_pavgw256 (v16hi,v16hi)
11388 v32qi __builtin_ia32_pblendvb256 (v32qi,v32qi,v32qi)
11389 v16hi __builtin_ia32_pblendw256 (v16hi,v16hi,int)
11390 v32qi __builtin_ia32_pcmpeqb256 (v32qi,v32qi)
11391 v16hi __builtin_ia32_pcmpeqw256 (v16hi,v16hi)
11392 v8si __builtin_ia32_pcmpeqd256 (c8si,v8si)
11393 v4di __builtin_ia32_pcmpeqq256 (v4di,v4di)
11394 v32qi __builtin_ia32_pcmpgtb256 (v32qi,v32qi)
11395 v16hi __builtin_ia32_pcmpgtw256 (16hi,v16hi)
11396 v8si __builtin_ia32_pcmpgtd256 (v8si,v8si)
11397 v4di __builtin_ia32_pcmpgtq256 (v4di,v4di)
11398 v16hi __builtin_ia32_phaddw256 (v16hi,v16hi)
11399 v8si __builtin_ia32_phaddd256 (v8si,v8si)
11400 v16hi __builtin_ia32_phaddsw256 (v16hi,v16hi)
11401 v16hi __builtin_ia32_phsubw256 (v16hi,v16hi)
11402 v8si __builtin_ia32_phsubd256 (v8si,v8si)
11403 v16hi __builtin_ia32_phsubsw256 (v16hi,v16hi)
11404 v32qi __builtin_ia32_pmaddubsw256 (v32qi,v32qi)
11405 v16hi __builtin_ia32_pmaddwd256 (v16hi,v16hi)
11406 v32qi __builtin_ia32_pmaxsb256 (v32qi,v32qi)
11407 v16hi __builtin_ia32_pmaxsw256 (v16hi,v16hi)
11408 v8si __builtin_ia32_pmaxsd256 (v8si,v8si)
11409 v32qi __builtin_ia32_pmaxub256 (v32qi,v32qi)
11410 v16hi __builtin_ia32_pmaxuw256 (v16hi,v16hi)
11411 v8si __builtin_ia32_pmaxud256 (v8si,v8si)
11412 v32qi __builtin_ia32_pminsb256 (v32qi,v32qi)
11413 v16hi __builtin_ia32_pminsw256 (v16hi,v16hi)
11414 v8si __builtin_ia32_pminsd256 (v8si,v8si)
11415 v32qi __builtin_ia32_pminub256 (v32qi,v32qi)
11416 v16hi __builtin_ia32_pminuw256 (v16hi,v16hi)
11417 v8si __builtin_ia32_pminud256 (v8si,v8si)
11418 int __builtin_ia32_pmovmskb256 (v32qi)
11419 v16hi __builtin_ia32_pmovsxbw256 (v16qi)
11420 v8si __builtin_ia32_pmovsxbd256 (v16qi)
11421 v4di __builtin_ia32_pmovsxbq256 (v16qi)
11422 v8si __builtin_ia32_pmovsxwd256 (v8hi)
11423 v4di __builtin_ia32_pmovsxwq256 (v8hi)
11424 v4di __builtin_ia32_pmovsxdq256 (v4si)
11425 v16hi __builtin_ia32_pmovzxbw256 (v16qi)
11426 v8si __builtin_ia32_pmovzxbd256 (v16qi)
11427 v4di __builtin_ia32_pmovzxbq256 (v16qi)
11428 v8si __builtin_ia32_pmovzxwd256 (v8hi)
11429 v4di __builtin_ia32_pmovzxwq256 (v8hi)
11430 v4di __builtin_ia32_pmovzxdq256 (v4si)
11431 v4di __builtin_ia32_pmuldq256 (v8si,v8si)
11432 v16hi __builtin_ia32_pmulhrsw256 (v16hi, v16hi)
11433 v16hi __builtin_ia32_pmulhuw256 (v16hi,v16hi)
11434 v16hi __builtin_ia32_pmulhw256 (v16hi,v16hi)
11435 v16hi __builtin_ia32_pmullw256 (v16hi,v16hi)
11436 v8si __builtin_ia32_pmulld256 (v8si,v8si)
11437 v4di __builtin_ia32_pmuludq256 (v8si,v8si)
11438 v4di __builtin_ia32_por256 (v4di,v4di)
11439 v16hi __builtin_ia32_psadbw256 (v32qi,v32qi)
11440 v32qi __builtin_ia32_pshufb256 (v32qi,v32qi)
11441 v8si __builtin_ia32_pshufd256 (v8si,int)
11442 v16hi __builtin_ia32_pshufhw256 (v16hi,int)
11443 v16hi __builtin_ia32_pshuflw256 (v16hi,int)
11444 v32qi __builtin_ia32_psignb256 (v32qi,v32qi)
11445 v16hi __builtin_ia32_psignw256 (v16hi,v16hi)
11446 v8si __builtin_ia32_psignd256 (v8si,v8si)
11447 v4di __builtin_ia32_pslldqi256 (v4di,int)
11448 v16hi __builtin_ia32_psllwi256 (16hi,int)
11449 v16hi __builtin_ia32_psllw256(v16hi,v8hi)
11450 v8si __builtin_ia32_pslldi256 (v8si,int)
11451 v8si __builtin_ia32_pslld256(v8si,v4si)
11452 v4di __builtin_ia32_psllqi256 (v4di,int)
11453 v4di __builtin_ia32_psllq256(v4di,v2di)
11454 v16hi __builtin_ia32_psrawi256 (v16hi,int)
11455 v16hi __builtin_ia32_psraw256 (v16hi,v8hi)
11456 v8si __builtin_ia32_psradi256 (v8si,int)
11457 v8si __builtin_ia32_psrad256 (v8si,v4si)
11458 v4di __builtin_ia32_psrldqi256 (v4di, int)
11459 v16hi __builtin_ia32_psrlwi256 (v16hi,int)
11460 v16hi __builtin_ia32_psrlw256 (v16hi,v8hi)
11461 v8si __builtin_ia32_psrldi256 (v8si,int)
11462 v8si __builtin_ia32_psrld256 (v8si,v4si)
11463 v4di __builtin_ia32_psrlqi256 (v4di,int)
11464 v4di __builtin_ia32_psrlq256(v4di,v2di)
11465 v32qi __builtin_ia32_psubb256 (v32qi,v32qi)
11466 v32hi __builtin_ia32_psubw256 (v16hi,v16hi)
11467 v8si __builtin_ia32_psubd256 (v8si,v8si)
11468 v4di __builtin_ia32_psubq256 (v4di,v4di)
11469 v32qi __builtin_ia32_psubsb256 (v32qi,v32qi)
11470 v16hi __builtin_ia32_psubsw256 (v16hi,v16hi)
11471 v32qi __builtin_ia32_psubusb256 (v32qi,v32qi)
11472 v16hi __builtin_ia32_psubusw256 (v16hi,v16hi)
11473 v32qi __builtin_ia32_punpckhbw256 (v32qi,v32qi)
11474 v16hi __builtin_ia32_punpckhwd256 (v16hi,v16hi)
11475 v8si __builtin_ia32_punpckhdq256 (v8si,v8si)
11476 v4di __builtin_ia32_punpckhqdq256 (v4di,v4di)
11477 v32qi __builtin_ia32_punpcklbw256 (v32qi,v32qi)
11478 v16hi __builtin_ia32_punpcklwd256 (v16hi,v16hi)
11479 v8si __builtin_ia32_punpckldq256 (v8si,v8si)
11480 v4di __builtin_ia32_punpcklqdq256 (v4di,v4di)
11481 v4di __builtin_ia32_pxor256 (v4di,v4di)
11482 v4di __builtin_ia32_movntdqa256 (pv4di)
11483 v4sf __builtin_ia32_vbroadcastss_ps (v4sf)
11484 v8sf __builtin_ia32_vbroadcastss_ps256 (v4sf)
11485 v4df __builtin_ia32_vbroadcastsd_pd256 (v2df)
11486 v4di __builtin_ia32_vbroadcastsi256 (v2di)
11487 v4si __builtin_ia32_pblendd128 (v4si,v4si)
11488 v8si __builtin_ia32_pblendd256 (v8si,v8si)
11489 v32qi __builtin_ia32_pbroadcastb256 (v16qi)
11490 v16hi __builtin_ia32_pbroadcastw256 (v8hi)
11491 v8si __builtin_ia32_pbroadcastd256 (v4si)
11492 v4di __builtin_ia32_pbroadcastq256 (v2di)
11493 v16qi __builtin_ia32_pbroadcastb128 (v16qi)
11494 v8hi __builtin_ia32_pbroadcastw128 (v8hi)
11495 v4si __builtin_ia32_pbroadcastd128 (v4si)
11496 v2di __builtin_ia32_pbroadcastq128 (v2di)
11497 v8si __builtin_ia32_permvarsi256 (v8si,v8si)
11498 v4df __builtin_ia32_permdf256 (v4df,int)
11499 v8sf __builtin_ia32_permvarsf256 (v8sf,v8sf)
11500 v4di __builtin_ia32_permdi256 (v4di,int)
11501 v4di __builtin_ia32_permti256 (v4di,v4di,int)
11502 v4di __builtin_ia32_extract128i256 (v4di,int)
11503 v4di __builtin_ia32_insert128i256 (v4di,v2di,int)
11504 v8si __builtin_ia32_maskloadd256 (pcv8si,v8si)
11505 v4di __builtin_ia32_maskloadq256 (pcv4di,v4di)
11506 v4si __builtin_ia32_maskloadd (pcv4si,v4si)
11507 v2di __builtin_ia32_maskloadq (pcv2di,v2di)
11508 void __builtin_ia32_maskstored256 (pv8si,v8si,v8si)
11509 void __builtin_ia32_maskstoreq256 (pv4di,v4di,v4di)
11510 void __builtin_ia32_maskstored (pv4si,v4si,v4si)
11511 void __builtin_ia32_maskstoreq (pv2di,v2di,v2di)
11512 v8si __builtin_ia32_psllv8si (v8si,v8si)
11513 v4si __builtin_ia32_psllv4si (v4si,v4si)
11514 v4di __builtin_ia32_psllv4di (v4di,v4di)
11515 v2di __builtin_ia32_psllv2di (v2di,v2di)
11516 v8si __builtin_ia32_psrav8si (v8si,v8si)
11517 v4si __builtin_ia32_psrav4si (v4si,v4si)
11518 v8si __builtin_ia32_psrlv8si (v8si,v8si)
11519 v4si __builtin_ia32_psrlv4si (v4si,v4si)
11520 v4di __builtin_ia32_psrlv4di (v4di,v4di)
11521 v2di __builtin_ia32_psrlv2di (v2di,v2di)
11522 v2df __builtin_ia32_gathersiv2df (v2df, pcdouble,v4si,v2df,int)
11523 v4df __builtin_ia32_gathersiv4df (v4df, pcdouble,v4si,v4df,int)
11524 v2df __builtin_ia32_gatherdiv2df (v2df, pcdouble,v2di,v2df,int)
11525 v4df __builtin_ia32_gatherdiv4df (v4df, pcdouble,v4di,v4df,int)
11526 v4sf __builtin_ia32_gathersiv4sf (v4sf, pcfloat,v4si,v4sf,int)
11527 v8sf __builtin_ia32_gathersiv8sf (v8sf, pcfloat,v8si,v8sf,int)
11528 v4sf __builtin_ia32_gatherdiv4sf (v4sf, pcfloat,v2di,v4sf,int)
11529 v4sf __builtin_ia32_gatherdiv4sf256 (v4sf, pcfloat,v4di,v4sf,int)
11530 v2di __builtin_ia32_gathersiv2di (v2di, pcint64,v4si,v2di,int)
11531 v4di __builtin_ia32_gathersiv4di (v4di, pcint64,v4si,v4di,int)
11532 v2di __builtin_ia32_gatherdiv2di (v2di, pcint64,v2di,v2di,int)
11533 v4di __builtin_ia32_gatherdiv4di (v4di, pcint64,v4di,v4di,int)
11534 v4si __builtin_ia32_gathersiv4si (v4si, pcint,v4si,v4si,int)
11535 v8si __builtin_ia32_gathersiv8si (v8si, pcint,v8si,v8si,int)
11536 v4si __builtin_ia32_gatherdiv4si (v4si, pcint,v2di,v4si,int)
11537 v4si __builtin_ia32_gatherdiv4si256 (v4si, pcint,v4di,v4si,int)
11538 @end smallexample
11540 The following built-in functions are available when @option{-maes} is
11541 used.  All of them generate the machine instruction that is part of the
11542 name.
11544 @smallexample
11545 v2di __builtin_ia32_aesenc128 (v2di, v2di)
11546 v2di __builtin_ia32_aesenclast128 (v2di, v2di)
11547 v2di __builtin_ia32_aesdec128 (v2di, v2di)
11548 v2di __builtin_ia32_aesdeclast128 (v2di, v2di)
11549 v2di __builtin_ia32_aeskeygenassist128 (v2di, const int)
11550 v2di __builtin_ia32_aesimc128 (v2di)
11551 @end smallexample
11553 The following built-in function is available when @option{-mpclmul} is
11554 used.
11556 @table @code
11557 @item v2di __builtin_ia32_pclmulqdq128 (v2di, v2di, const int)
11558 Generates the @code{pclmulqdq} machine instruction.
11559 @end table
11561 The following built-in function is available when @option{-mfsgsbase} is
11562 used.  All of them generate the machine instruction that is part of the
11563 name.
11565 @smallexample
11566 unsigned int __builtin_ia32_rdfsbase32 (void)
11567 unsigned long long __builtin_ia32_rdfsbase64 (void)
11568 unsigned int __builtin_ia32_rdgsbase32 (void)
11569 unsigned long long __builtin_ia32_rdgsbase64 (void)
11570 void _writefsbase_u32 (unsigned int)
11571 void _writefsbase_u64 (unsigned long long)
11572 void _writegsbase_u32 (unsigned int)
11573 void _writegsbase_u64 (unsigned long long)
11574 @end smallexample
11576 The following built-in function is available when @option{-mrdrnd} is
11577 used.  All of them generate the machine instruction that is part of the
11578 name.
11580 @smallexample
11581 unsigned int __builtin_ia32_rdrand16_step (unsigned short *)
11582 unsigned int __builtin_ia32_rdrand32_step (unsigned int *)
11583 unsigned int __builtin_ia32_rdrand64_step (unsigned long long *)
11584 @end smallexample
11586 The following built-in functions are available when @option{-msse4a} is used.
11587 All of them generate the machine instruction that is part of the name.
11589 @smallexample
11590 void __builtin_ia32_movntsd (double *, v2df)
11591 void __builtin_ia32_movntss (float *, v4sf)
11592 v2di __builtin_ia32_extrq  (v2di, v16qi)
11593 v2di __builtin_ia32_extrqi (v2di, const unsigned int, const unsigned int)
11594 v2di __builtin_ia32_insertq (v2di, v2di)
11595 v2di __builtin_ia32_insertqi (v2di, v2di, const unsigned int, const unsigned int)
11596 @end smallexample
11598 The following built-in functions are available when @option{-mxop} is used.
11599 @smallexample
11600 v2df __builtin_ia32_vfrczpd (v2df)
11601 v4sf __builtin_ia32_vfrczps (v4sf)
11602 v2df __builtin_ia32_vfrczsd (v2df)
11603 v4sf __builtin_ia32_vfrczss (v4sf)
11604 v4df __builtin_ia32_vfrczpd256 (v4df)
11605 v8sf __builtin_ia32_vfrczps256 (v8sf)
11606 v2di __builtin_ia32_vpcmov (v2di, v2di, v2di)
11607 v2di __builtin_ia32_vpcmov_v2di (v2di, v2di, v2di)
11608 v4si __builtin_ia32_vpcmov_v4si (v4si, v4si, v4si)
11609 v8hi __builtin_ia32_vpcmov_v8hi (v8hi, v8hi, v8hi)
11610 v16qi __builtin_ia32_vpcmov_v16qi (v16qi, v16qi, v16qi)
11611 v2df __builtin_ia32_vpcmov_v2df (v2df, v2df, v2df)
11612 v4sf __builtin_ia32_vpcmov_v4sf (v4sf, v4sf, v4sf)
11613 v4di __builtin_ia32_vpcmov_v4di256 (v4di, v4di, v4di)
11614 v8si __builtin_ia32_vpcmov_v8si256 (v8si, v8si, v8si)
11615 v16hi __builtin_ia32_vpcmov_v16hi256 (v16hi, v16hi, v16hi)
11616 v32qi __builtin_ia32_vpcmov_v32qi256 (v32qi, v32qi, v32qi)
11617 v4df __builtin_ia32_vpcmov_v4df256 (v4df, v4df, v4df)
11618 v8sf __builtin_ia32_vpcmov_v8sf256 (v8sf, v8sf, v8sf)
11619 v16qi __builtin_ia32_vpcomeqb (v16qi, v16qi)
11620 v8hi __builtin_ia32_vpcomeqw (v8hi, v8hi)
11621 v4si __builtin_ia32_vpcomeqd (v4si, v4si)
11622 v2di __builtin_ia32_vpcomeqq (v2di, v2di)
11623 v16qi __builtin_ia32_vpcomequb (v16qi, v16qi)
11624 v4si __builtin_ia32_vpcomequd (v4si, v4si)
11625 v2di __builtin_ia32_vpcomequq (v2di, v2di)
11626 v8hi __builtin_ia32_vpcomequw (v8hi, v8hi)
11627 v8hi __builtin_ia32_vpcomeqw (v8hi, v8hi)
11628 v16qi __builtin_ia32_vpcomfalseb (v16qi, v16qi)
11629 v4si __builtin_ia32_vpcomfalsed (v4si, v4si)
11630 v2di __builtin_ia32_vpcomfalseq (v2di, v2di)
11631 v16qi __builtin_ia32_vpcomfalseub (v16qi, v16qi)
11632 v4si __builtin_ia32_vpcomfalseud (v4si, v4si)
11633 v2di __builtin_ia32_vpcomfalseuq (v2di, v2di)
11634 v8hi __builtin_ia32_vpcomfalseuw (v8hi, v8hi)
11635 v8hi __builtin_ia32_vpcomfalsew (v8hi, v8hi)
11636 v16qi __builtin_ia32_vpcomgeb (v16qi, v16qi)
11637 v4si __builtin_ia32_vpcomged (v4si, v4si)
11638 v2di __builtin_ia32_vpcomgeq (v2di, v2di)
11639 v16qi __builtin_ia32_vpcomgeub (v16qi, v16qi)
11640 v4si __builtin_ia32_vpcomgeud (v4si, v4si)
11641 v2di __builtin_ia32_vpcomgeuq (v2di, v2di)
11642 v8hi __builtin_ia32_vpcomgeuw (v8hi, v8hi)
11643 v8hi __builtin_ia32_vpcomgew (v8hi, v8hi)
11644 v16qi __builtin_ia32_vpcomgtb (v16qi, v16qi)
11645 v4si __builtin_ia32_vpcomgtd (v4si, v4si)
11646 v2di __builtin_ia32_vpcomgtq (v2di, v2di)
11647 v16qi __builtin_ia32_vpcomgtub (v16qi, v16qi)
11648 v4si __builtin_ia32_vpcomgtud (v4si, v4si)
11649 v2di __builtin_ia32_vpcomgtuq (v2di, v2di)
11650 v8hi __builtin_ia32_vpcomgtuw (v8hi, v8hi)
11651 v8hi __builtin_ia32_vpcomgtw (v8hi, v8hi)
11652 v16qi __builtin_ia32_vpcomleb (v16qi, v16qi)
11653 v4si __builtin_ia32_vpcomled (v4si, v4si)
11654 v2di __builtin_ia32_vpcomleq (v2di, v2di)
11655 v16qi __builtin_ia32_vpcomleub (v16qi, v16qi)
11656 v4si __builtin_ia32_vpcomleud (v4si, v4si)
11657 v2di __builtin_ia32_vpcomleuq (v2di, v2di)
11658 v8hi __builtin_ia32_vpcomleuw (v8hi, v8hi)
11659 v8hi __builtin_ia32_vpcomlew (v8hi, v8hi)
11660 v16qi __builtin_ia32_vpcomltb (v16qi, v16qi)
11661 v4si __builtin_ia32_vpcomltd (v4si, v4si)
11662 v2di __builtin_ia32_vpcomltq (v2di, v2di)
11663 v16qi __builtin_ia32_vpcomltub (v16qi, v16qi)
11664 v4si __builtin_ia32_vpcomltud (v4si, v4si)
11665 v2di __builtin_ia32_vpcomltuq (v2di, v2di)
11666 v8hi __builtin_ia32_vpcomltuw (v8hi, v8hi)
11667 v8hi __builtin_ia32_vpcomltw (v8hi, v8hi)
11668 v16qi __builtin_ia32_vpcomneb (v16qi, v16qi)
11669 v4si __builtin_ia32_vpcomned (v4si, v4si)
11670 v2di __builtin_ia32_vpcomneq (v2di, v2di)
11671 v16qi __builtin_ia32_vpcomneub (v16qi, v16qi)
11672 v4si __builtin_ia32_vpcomneud (v4si, v4si)
11673 v2di __builtin_ia32_vpcomneuq (v2di, v2di)
11674 v8hi __builtin_ia32_vpcomneuw (v8hi, v8hi)
11675 v8hi __builtin_ia32_vpcomnew (v8hi, v8hi)
11676 v16qi __builtin_ia32_vpcomtrueb (v16qi, v16qi)
11677 v4si __builtin_ia32_vpcomtrued (v4si, v4si)
11678 v2di __builtin_ia32_vpcomtrueq (v2di, v2di)
11679 v16qi __builtin_ia32_vpcomtrueub (v16qi, v16qi)
11680 v4si __builtin_ia32_vpcomtrueud (v4si, v4si)
11681 v2di __builtin_ia32_vpcomtrueuq (v2di, v2di)
11682 v8hi __builtin_ia32_vpcomtrueuw (v8hi, v8hi)
11683 v8hi __builtin_ia32_vpcomtruew (v8hi, v8hi)
11684 v4si __builtin_ia32_vphaddbd (v16qi)
11685 v2di __builtin_ia32_vphaddbq (v16qi)
11686 v8hi __builtin_ia32_vphaddbw (v16qi)
11687 v2di __builtin_ia32_vphadddq (v4si)
11688 v4si __builtin_ia32_vphaddubd (v16qi)
11689 v2di __builtin_ia32_vphaddubq (v16qi)
11690 v8hi __builtin_ia32_vphaddubw (v16qi)
11691 v2di __builtin_ia32_vphaddudq (v4si)
11692 v4si __builtin_ia32_vphadduwd (v8hi)
11693 v2di __builtin_ia32_vphadduwq (v8hi)
11694 v4si __builtin_ia32_vphaddwd (v8hi)
11695 v2di __builtin_ia32_vphaddwq (v8hi)
11696 v8hi __builtin_ia32_vphsubbw (v16qi)
11697 v2di __builtin_ia32_vphsubdq (v4si)
11698 v4si __builtin_ia32_vphsubwd (v8hi)
11699 v4si __builtin_ia32_vpmacsdd (v4si, v4si, v4si)
11700 v2di __builtin_ia32_vpmacsdqh (v4si, v4si, v2di)
11701 v2di __builtin_ia32_vpmacsdql (v4si, v4si, v2di)
11702 v4si __builtin_ia32_vpmacssdd (v4si, v4si, v4si)
11703 v2di __builtin_ia32_vpmacssdqh (v4si, v4si, v2di)
11704 v2di __builtin_ia32_vpmacssdql (v4si, v4si, v2di)
11705 v4si __builtin_ia32_vpmacsswd (v8hi, v8hi, v4si)
11706 v8hi __builtin_ia32_vpmacssww (v8hi, v8hi, v8hi)
11707 v4si __builtin_ia32_vpmacswd (v8hi, v8hi, v4si)
11708 v8hi __builtin_ia32_vpmacsww (v8hi, v8hi, v8hi)
11709 v4si __builtin_ia32_vpmadcsswd (v8hi, v8hi, v4si)
11710 v4si __builtin_ia32_vpmadcswd (v8hi, v8hi, v4si)
11711 v16qi __builtin_ia32_vpperm (v16qi, v16qi, v16qi)
11712 v16qi __builtin_ia32_vprotb (v16qi, v16qi)
11713 v4si __builtin_ia32_vprotd (v4si, v4si)
11714 v2di __builtin_ia32_vprotq (v2di, v2di)
11715 v8hi __builtin_ia32_vprotw (v8hi, v8hi)
11716 v16qi __builtin_ia32_vpshab (v16qi, v16qi)
11717 v4si __builtin_ia32_vpshad (v4si, v4si)
11718 v2di __builtin_ia32_vpshaq (v2di, v2di)
11719 v8hi __builtin_ia32_vpshaw (v8hi, v8hi)
11720 v16qi __builtin_ia32_vpshlb (v16qi, v16qi)
11721 v4si __builtin_ia32_vpshld (v4si, v4si)
11722 v2di __builtin_ia32_vpshlq (v2di, v2di)
11723 v8hi __builtin_ia32_vpshlw (v8hi, v8hi)
11724 @end smallexample
11726 The following built-in functions are available when @option{-mfma4} is used.
11727 All of them generate the machine instruction that is part of the name.
11729 @smallexample
11730 v2df __builtin_ia32_vfmaddpd (v2df, v2df, v2df)
11731 v4sf __builtin_ia32_vfmaddps (v4sf, v4sf, v4sf)
11732 v2df __builtin_ia32_vfmaddsd (v2df, v2df, v2df)
11733 v4sf __builtin_ia32_vfmaddss (v4sf, v4sf, v4sf)
11734 v2df __builtin_ia32_vfmsubpd (v2df, v2df, v2df)
11735 v4sf __builtin_ia32_vfmsubps (v4sf, v4sf, v4sf)
11736 v2df __builtin_ia32_vfmsubsd (v2df, v2df, v2df)
11737 v4sf __builtin_ia32_vfmsubss (v4sf, v4sf, v4sf)
11738 v2df __builtin_ia32_vfnmaddpd (v2df, v2df, v2df)
11739 v4sf __builtin_ia32_vfnmaddps (v4sf, v4sf, v4sf)
11740 v2df __builtin_ia32_vfnmaddsd (v2df, v2df, v2df)
11741 v4sf __builtin_ia32_vfnmaddss (v4sf, v4sf, v4sf)
11742 v2df __builtin_ia32_vfnmsubpd (v2df, v2df, v2df)
11743 v4sf __builtin_ia32_vfnmsubps (v4sf, v4sf, v4sf)
11744 v2df __builtin_ia32_vfnmsubsd (v2df, v2df, v2df)
11745 v4sf __builtin_ia32_vfnmsubss (v4sf, v4sf, v4sf)
11746 v2df __builtin_ia32_vfmaddsubpd  (v2df, v2df, v2df)
11747 v4sf __builtin_ia32_vfmaddsubps  (v4sf, v4sf, v4sf)
11748 v2df __builtin_ia32_vfmsubaddpd  (v2df, v2df, v2df)
11749 v4sf __builtin_ia32_vfmsubaddps  (v4sf, v4sf, v4sf)
11750 v4df __builtin_ia32_vfmaddpd256 (v4df, v4df, v4df)
11751 v8sf __builtin_ia32_vfmaddps256 (v8sf, v8sf, v8sf)
11752 v4df __builtin_ia32_vfmsubpd256 (v4df, v4df, v4df)
11753 v8sf __builtin_ia32_vfmsubps256 (v8sf, v8sf, v8sf)
11754 v4df __builtin_ia32_vfnmaddpd256 (v4df, v4df, v4df)
11755 v8sf __builtin_ia32_vfnmaddps256 (v8sf, v8sf, v8sf)
11756 v4df __builtin_ia32_vfnmsubpd256 (v4df, v4df, v4df)
11757 v8sf __builtin_ia32_vfnmsubps256 (v8sf, v8sf, v8sf)
11758 v4df __builtin_ia32_vfmaddsubpd256 (v4df, v4df, v4df)
11759 v8sf __builtin_ia32_vfmaddsubps256 (v8sf, v8sf, v8sf)
11760 v4df __builtin_ia32_vfmsubaddpd256 (v4df, v4df, v4df)
11761 v8sf __builtin_ia32_vfmsubaddps256 (v8sf, v8sf, v8sf)
11763 @end smallexample
11765 The following built-in functions are available when @option{-mlwp} is used.
11767 @smallexample
11768 void __builtin_ia32_llwpcb16 (void *);
11769 void __builtin_ia32_llwpcb32 (void *);
11770 void __builtin_ia32_llwpcb64 (void *);
11771 void * __builtin_ia32_llwpcb16 (void);
11772 void * __builtin_ia32_llwpcb32 (void);
11773 void * __builtin_ia32_llwpcb64 (void);
11774 void __builtin_ia32_lwpval16 (unsigned short, unsigned int, unsigned short)
11775 void __builtin_ia32_lwpval32 (unsigned int, unsigned int, unsigned int)
11776 void __builtin_ia32_lwpval64 (unsigned __int64, unsigned int, unsigned int)
11777 unsigned char __builtin_ia32_lwpins16 (unsigned short, unsigned int, unsigned short)
11778 unsigned char __builtin_ia32_lwpins32 (unsigned int, unsigned int, unsigned int)
11779 unsigned char __builtin_ia32_lwpins64 (unsigned __int64, unsigned int, unsigned int)
11780 @end smallexample
11782 The following built-in functions are available when @option{-mbmi} is used.
11783 All of them generate the machine instruction that is part of the name.
11784 @smallexample
11785 unsigned int __builtin_ia32_bextr_u32(unsigned int, unsigned int);
11786 unsigned long long __builtin_ia32_bextr_u64 (unsigned long long, unsigned long long);
11787 @end smallexample
11789 The following built-in functions are available when @option{-mbmi2} is used.
11790 All of them generate the machine instruction that is part of the name.
11791 @smallexample
11792 unsigned int _bzhi_u32 (unsigned int, unsigned int)
11793 unsigned int _pdep_u32 (unsigned int, unsigned int)
11794 unsigned int _pext_u32 (unsigned int, unsigned int)
11795 unsigned long long _bzhi_u64 (unsigned long long, unsigned long long)
11796 unsigned long long _pdep_u64 (unsigned long long, unsigned long long)
11797 unsigned long long _pext_u64 (unsigned long long, unsigned long long)
11798 @end smallexample
11800 The following built-in functions are available when @option{-mlzcnt} is used.
11801 All of them generate the machine instruction that is part of the name.
11802 @smallexample
11803 unsigned short __builtin_ia32_lzcnt_16(unsigned short);
11804 unsigned int __builtin_ia32_lzcnt_u32(unsigned int);
11805 unsigned long long __builtin_ia32_lzcnt_u64 (unsigned long long);
11806 @end smallexample
11808 The following built-in functions are available when @option{-mfxsr} is used.
11809 All of them generate the machine instruction that is part of the name.
11810 @smallexample
11811 void __builtin_ia32_fxsave (void *)
11812 void __builtin_ia32_fxrstor (void *)
11813 void __builtin_ia32_fxsave64 (void *)
11814 void __builtin_ia32_fxrstor64 (void *)
11815 @end smallexample
11817 The following built-in functions are available when @option{-mxsave} is used.
11818 All of them generate the machine instruction that is part of the name.
11819 @smallexample
11820 void __builtin_ia32_xsave (void *, long long)
11821 void __builtin_ia32_xrstor (void *, long long)
11822 void __builtin_ia32_xsave64 (void *, long long)
11823 void __builtin_ia32_xrstor64 (void *, long long)
11824 @end smallexample
11826 The following built-in functions are available when @option{-mxsaveopt} is used.
11827 All of them generate the machine instruction that is part of the name.
11828 @smallexample
11829 void __builtin_ia32_xsaveopt (void *, long long)
11830 void __builtin_ia32_xsaveopt64 (void *, long long)
11831 @end smallexample
11833 The following built-in functions are available when @option{-mtbm} is used.
11834 Both of them generate the immediate form of the bextr machine instruction.
11835 @smallexample
11836 unsigned int __builtin_ia32_bextri_u32 (unsigned int, const unsigned int);
11837 unsigned long long __builtin_ia32_bextri_u64 (unsigned long long, const unsigned long long);
11838 @end smallexample
11841 The following built-in functions are available when @option{-m3dnow} is used.
11842 All of them generate the machine instruction that is part of the name.
11844 @smallexample
11845 void __builtin_ia32_femms (void)
11846 v8qi __builtin_ia32_pavgusb (v8qi, v8qi)
11847 v2si __builtin_ia32_pf2id (v2sf)
11848 v2sf __builtin_ia32_pfacc (v2sf, v2sf)
11849 v2sf __builtin_ia32_pfadd (v2sf, v2sf)
11850 v2si __builtin_ia32_pfcmpeq (v2sf, v2sf)
11851 v2si __builtin_ia32_pfcmpge (v2sf, v2sf)
11852 v2si __builtin_ia32_pfcmpgt (v2sf, v2sf)
11853 v2sf __builtin_ia32_pfmax (v2sf, v2sf)
11854 v2sf __builtin_ia32_pfmin (v2sf, v2sf)
11855 v2sf __builtin_ia32_pfmul (v2sf, v2sf)
11856 v2sf __builtin_ia32_pfrcp (v2sf)
11857 v2sf __builtin_ia32_pfrcpit1 (v2sf, v2sf)
11858 v2sf __builtin_ia32_pfrcpit2 (v2sf, v2sf)
11859 v2sf __builtin_ia32_pfrsqrt (v2sf)
11860 v2sf __builtin_ia32_pfsub (v2sf, v2sf)
11861 v2sf __builtin_ia32_pfsubr (v2sf, v2sf)
11862 v2sf __builtin_ia32_pi2fd (v2si)
11863 v4hi __builtin_ia32_pmulhrw (v4hi, v4hi)
11864 @end smallexample
11866 The following built-in functions are available when both @option{-m3dnow}
11867 and @option{-march=athlon} are used.  All of them generate the machine
11868 instruction that is part of the name.
11870 @smallexample
11871 v2si __builtin_ia32_pf2iw (v2sf)
11872 v2sf __builtin_ia32_pfnacc (v2sf, v2sf)
11873 v2sf __builtin_ia32_pfpnacc (v2sf, v2sf)
11874 v2sf __builtin_ia32_pi2fw (v2si)
11875 v2sf __builtin_ia32_pswapdsf (v2sf)
11876 v2si __builtin_ia32_pswapdsi (v2si)
11877 @end smallexample
11879 The following built-in functions are available when @option{-mrtm} is used
11880 They are used for restricted transactional memory. These are the internal
11881 low level functions. Normally the functions in 
11882 @ref{X86 transactional memory intrinsics} should be used instead.
11884 @smallexample
11885 int __builtin_ia32_xbegin ()
11886 void __builtin_ia32_xend ()
11887 void __builtin_ia32_xabort (status)
11888 int __builtin_ia32_xtest ()
11889 @end smallexample
11891 @node X86 transactional memory intrinsics
11892 @subsection X86 transaction memory intrinsics
11894 Hardware transactional memory intrinsics for i386. These allow to use
11895 memory transactions with RTM (Restricted Transactional Memory).
11896 For using HLE (Hardware Lock Elision) see @ref{x86 specific memory model extensions for transactional memory} instead.
11897 This support is enabled with the @option{-mrtm} option.
11899 A memory transaction commits all changes to memory in an atomic way,
11900 as visible to other threads. If the transaction fails it is rolled back
11901 and all side effects discarded.
11903 Generally there is no guarantee that a memory transaction ever succeeds
11904 and suitable fallback code always needs to be supplied.
11906 @deftypefn {RTM Function} {unsigned} _xbegin ()
11907 Start a RTM (Restricted Transactional Memory) transaction. 
11908 Returns _XBEGIN_STARTED when the transaction
11909 started successfully (note this is not 0, so the constant has to be 
11910 explicitely tested). When the transaction aborts all side effects
11911 are undone and an abort code is returned. There is no guarantee
11912 any transaction ever succeeds, so there always needs to be a valid
11913 tested fallback path.
11914 @end deftypefn
11916 @smallexample
11917 #include <immintrin.h>
11919 if ((status = _xbegin ()) == _XBEGIN_STARTED) @{
11920     ... transaction code...
11921     _xend ();
11922 @} else @{
11923     ... non transactional fallback path...
11925 @end smallexample
11927 Valid abort status bits (when the value is not @code{_XBEGIN_STARTED}) are:
11929 @table @code
11930 @item _XABORT_EXPLICIT
11931 Transaction explicitely aborted with @code{_xabort}. The parameter passed
11932 to @code{_xabort} is available with @code{_XABORT_CODE(status)}
11933 @item _XABORT_RETRY
11934 Transaction retry is possible.
11935 @item _XABORT_CONFLICT
11936 Transaction abort due to a memory conflict with another thread
11937 @item _XABORT_CAPACITY
11938 Transaction abort due to the transaction using too much memory
11939 @item _XABORT_DEBUG
11940 Transaction abort due to a debug trap
11941 @item _XABORT_NESTED
11942 Transaction abort in a inner nested transaction
11943 @end table
11945 @deftypefn {RTM Function} {void} _xend ()
11946 Commit the current transaction. When no transaction is active this will
11947 fault. All memory side effects of the transactions will become visible
11948 to other threads in an atomic matter.
11949 @end deftypefn
11951 @deftypefn {RTM Function} {int} _xtest ()
11952 Return a value not zero when a transaction is currently active, otherwise 0.
11953 @end deftypefn
11955 @deftypefn {RTM Function} {void} _xabort (status)
11956 Abort the current transaction. When no transaction is active this is a no-op.
11957 status must be a 8bit constant, that is included in the status code returned
11958 by @code{_xbegin}
11959 @end deftypefn
11961 @node MIPS DSP Built-in Functions
11962 @subsection MIPS DSP Built-in Functions
11964 The MIPS DSP Application-Specific Extension (ASE) includes new
11965 instructions that are designed to improve the performance of DSP and
11966 media applications.  It provides instructions that operate on packed
11967 8-bit/16-bit integer data, Q7, Q15 and Q31 fractional data.
11969 GCC supports MIPS DSP operations using both the generic
11970 vector extensions (@pxref{Vector Extensions}) and a collection of
11971 MIPS-specific built-in functions.  Both kinds of support are
11972 enabled by the @option{-mdsp} command-line option.
11974 Revision 2 of the ASE was introduced in the second half of 2006.
11975 This revision adds extra instructions to the original ASE, but is
11976 otherwise backwards-compatible with it.  You can select revision 2
11977 using the command-line option @option{-mdspr2}; this option implies
11978 @option{-mdsp}.
11980 The SCOUNT and POS bits of the DSP control register are global.  The
11981 WRDSP, EXTPDP, EXTPDPV and MTHLIP instructions modify the SCOUNT and
11982 POS bits.  During optimization, the compiler does not delete these
11983 instructions and it does not delete calls to functions containing
11984 these instructions.
11986 At present, GCC only provides support for operations on 32-bit
11987 vectors.  The vector type associated with 8-bit integer data is
11988 usually called @code{v4i8}, the vector type associated with Q7
11989 is usually called @code{v4q7}, the vector type associated with 16-bit
11990 integer data is usually called @code{v2i16}, and the vector type
11991 associated with Q15 is usually called @code{v2q15}.  They can be
11992 defined in C as follows:
11994 @smallexample
11995 typedef signed char v4i8 __attribute__ ((vector_size(4)));
11996 typedef signed char v4q7 __attribute__ ((vector_size(4)));
11997 typedef short v2i16 __attribute__ ((vector_size(4)));
11998 typedef short v2q15 __attribute__ ((vector_size(4)));
11999 @end smallexample
12001 @code{v4i8}, @code{v4q7}, @code{v2i16} and @code{v2q15} values are
12002 initialized in the same way as aggregates.  For example:
12004 @smallexample
12005 v4i8 a = @{1, 2, 3, 4@};
12006 v4i8 b;
12007 b = (v4i8) @{5, 6, 7, 8@};
12009 v2q15 c = @{0x0fcb, 0x3a75@};
12010 v2q15 d;
12011 d = (v2q15) @{0.1234 * 0x1.0p15, 0.4567 * 0x1.0p15@};
12012 @end smallexample
12014 @emph{Note:} The CPU's endianness determines the order in which values
12015 are packed.  On little-endian targets, the first value is the least
12016 significant and the last value is the most significant.  The opposite
12017 order applies to big-endian targets.  For example, the code above
12018 sets the lowest byte of @code{a} to @code{1} on little-endian targets
12019 and @code{4} on big-endian targets.
12021 @emph{Note:} Q7, Q15 and Q31 values must be initialized with their integer
12022 representation.  As shown in this example, the integer representation
12023 of a Q7 value can be obtained by multiplying the fractional value by
12024 @code{0x1.0p7}.  The equivalent for Q15 values is to multiply by
12025 @code{0x1.0p15}.  The equivalent for Q31 values is to multiply by
12026 @code{0x1.0p31}.
12028 The table below lists the @code{v4i8} and @code{v2q15} operations for which
12029 hardware support exists.  @code{a} and @code{b} are @code{v4i8} values,
12030 and @code{c} and @code{d} are @code{v2q15} values.
12032 @multitable @columnfractions .50 .50
12033 @item C code @tab MIPS instruction
12034 @item @code{a + b} @tab @code{addu.qb}
12035 @item @code{c + d} @tab @code{addq.ph}
12036 @item @code{a - b} @tab @code{subu.qb}
12037 @item @code{c - d} @tab @code{subq.ph}
12038 @end multitable
12040 The table below lists the @code{v2i16} operation for which
12041 hardware support exists for the DSP ASE REV 2.  @code{e} and @code{f} are
12042 @code{v2i16} values.
12044 @multitable @columnfractions .50 .50
12045 @item C code @tab MIPS instruction
12046 @item @code{e * f} @tab @code{mul.ph}
12047 @end multitable
12049 It is easier to describe the DSP built-in functions if we first define
12050 the following types:
12052 @smallexample
12053 typedef int q31;
12054 typedef int i32;
12055 typedef unsigned int ui32;
12056 typedef long long a64;
12057 @end smallexample
12059 @code{q31} and @code{i32} are actually the same as @code{int}, but we
12060 use @code{q31} to indicate a Q31 fractional value and @code{i32} to
12061 indicate a 32-bit integer value.  Similarly, @code{a64} is the same as
12062 @code{long long}, but we use @code{a64} to indicate values that are
12063 placed in one of the four DSP accumulators (@code{$ac0},
12064 @code{$ac1}, @code{$ac2} or @code{$ac3}).
12066 Also, some built-in functions prefer or require immediate numbers as
12067 parameters, because the corresponding DSP instructions accept both immediate
12068 numbers and register operands, or accept immediate numbers only.  The
12069 immediate parameters are listed as follows.
12071 @smallexample
12072 imm0_3: 0 to 3.
12073 imm0_7: 0 to 7.
12074 imm0_15: 0 to 15.
12075 imm0_31: 0 to 31.
12076 imm0_63: 0 to 63.
12077 imm0_255: 0 to 255.
12078 imm_n32_31: -32 to 31.
12079 imm_n512_511: -512 to 511.
12080 @end smallexample
12082 The following built-in functions map directly to a particular MIPS DSP
12083 instruction.  Please refer to the architecture specification
12084 for details on what each instruction does.
12086 @smallexample
12087 v2q15 __builtin_mips_addq_ph (v2q15, v2q15)
12088 v2q15 __builtin_mips_addq_s_ph (v2q15, v2q15)
12089 q31 __builtin_mips_addq_s_w (q31, q31)
12090 v4i8 __builtin_mips_addu_qb (v4i8, v4i8)
12091 v4i8 __builtin_mips_addu_s_qb (v4i8, v4i8)
12092 v2q15 __builtin_mips_subq_ph (v2q15, v2q15)
12093 v2q15 __builtin_mips_subq_s_ph (v2q15, v2q15)
12094 q31 __builtin_mips_subq_s_w (q31, q31)
12095 v4i8 __builtin_mips_subu_qb (v4i8, v4i8)
12096 v4i8 __builtin_mips_subu_s_qb (v4i8, v4i8)
12097 i32 __builtin_mips_addsc (i32, i32)
12098 i32 __builtin_mips_addwc (i32, i32)
12099 i32 __builtin_mips_modsub (i32, i32)
12100 i32 __builtin_mips_raddu_w_qb (v4i8)
12101 v2q15 __builtin_mips_absq_s_ph (v2q15)
12102 q31 __builtin_mips_absq_s_w (q31)
12103 v4i8 __builtin_mips_precrq_qb_ph (v2q15, v2q15)
12104 v2q15 __builtin_mips_precrq_ph_w (q31, q31)
12105 v2q15 __builtin_mips_precrq_rs_ph_w (q31, q31)
12106 v4i8 __builtin_mips_precrqu_s_qb_ph (v2q15, v2q15)
12107 q31 __builtin_mips_preceq_w_phl (v2q15)
12108 q31 __builtin_mips_preceq_w_phr (v2q15)
12109 v2q15 __builtin_mips_precequ_ph_qbl (v4i8)
12110 v2q15 __builtin_mips_precequ_ph_qbr (v4i8)
12111 v2q15 __builtin_mips_precequ_ph_qbla (v4i8)
12112 v2q15 __builtin_mips_precequ_ph_qbra (v4i8)
12113 v2q15 __builtin_mips_preceu_ph_qbl (v4i8)
12114 v2q15 __builtin_mips_preceu_ph_qbr (v4i8)
12115 v2q15 __builtin_mips_preceu_ph_qbla (v4i8)
12116 v2q15 __builtin_mips_preceu_ph_qbra (v4i8)
12117 v4i8 __builtin_mips_shll_qb (v4i8, imm0_7)
12118 v4i8 __builtin_mips_shll_qb (v4i8, i32)
12119 v2q15 __builtin_mips_shll_ph (v2q15, imm0_15)
12120 v2q15 __builtin_mips_shll_ph (v2q15, i32)
12121 v2q15 __builtin_mips_shll_s_ph (v2q15, imm0_15)
12122 v2q15 __builtin_mips_shll_s_ph (v2q15, i32)
12123 q31 __builtin_mips_shll_s_w (q31, imm0_31)
12124 q31 __builtin_mips_shll_s_w (q31, i32)
12125 v4i8 __builtin_mips_shrl_qb (v4i8, imm0_7)
12126 v4i8 __builtin_mips_shrl_qb (v4i8, i32)
12127 v2q15 __builtin_mips_shra_ph (v2q15, imm0_15)
12128 v2q15 __builtin_mips_shra_ph (v2q15, i32)
12129 v2q15 __builtin_mips_shra_r_ph (v2q15, imm0_15)
12130 v2q15 __builtin_mips_shra_r_ph (v2q15, i32)
12131 q31 __builtin_mips_shra_r_w (q31, imm0_31)
12132 q31 __builtin_mips_shra_r_w (q31, i32)
12133 v2q15 __builtin_mips_muleu_s_ph_qbl (v4i8, v2q15)
12134 v2q15 __builtin_mips_muleu_s_ph_qbr (v4i8, v2q15)
12135 v2q15 __builtin_mips_mulq_rs_ph (v2q15, v2q15)
12136 q31 __builtin_mips_muleq_s_w_phl (v2q15, v2q15)
12137 q31 __builtin_mips_muleq_s_w_phr (v2q15, v2q15)
12138 a64 __builtin_mips_dpau_h_qbl (a64, v4i8, v4i8)
12139 a64 __builtin_mips_dpau_h_qbr (a64, v4i8, v4i8)
12140 a64 __builtin_mips_dpsu_h_qbl (a64, v4i8, v4i8)
12141 a64 __builtin_mips_dpsu_h_qbr (a64, v4i8, v4i8)
12142 a64 __builtin_mips_dpaq_s_w_ph (a64, v2q15, v2q15)
12143 a64 __builtin_mips_dpaq_sa_l_w (a64, q31, q31)
12144 a64 __builtin_mips_dpsq_s_w_ph (a64, v2q15, v2q15)
12145 a64 __builtin_mips_dpsq_sa_l_w (a64, q31, q31)
12146 a64 __builtin_mips_mulsaq_s_w_ph (a64, v2q15, v2q15)
12147 a64 __builtin_mips_maq_s_w_phl (a64, v2q15, v2q15)
12148 a64 __builtin_mips_maq_s_w_phr (a64, v2q15, v2q15)
12149 a64 __builtin_mips_maq_sa_w_phl (a64, v2q15, v2q15)
12150 a64 __builtin_mips_maq_sa_w_phr (a64, v2q15, v2q15)
12151 i32 __builtin_mips_bitrev (i32)
12152 i32 __builtin_mips_insv (i32, i32)
12153 v4i8 __builtin_mips_repl_qb (imm0_255)
12154 v4i8 __builtin_mips_repl_qb (i32)
12155 v2q15 __builtin_mips_repl_ph (imm_n512_511)
12156 v2q15 __builtin_mips_repl_ph (i32)
12157 void __builtin_mips_cmpu_eq_qb (v4i8, v4i8)
12158 void __builtin_mips_cmpu_lt_qb (v4i8, v4i8)
12159 void __builtin_mips_cmpu_le_qb (v4i8, v4i8)
12160 i32 __builtin_mips_cmpgu_eq_qb (v4i8, v4i8)
12161 i32 __builtin_mips_cmpgu_lt_qb (v4i8, v4i8)
12162 i32 __builtin_mips_cmpgu_le_qb (v4i8, v4i8)
12163 void __builtin_mips_cmp_eq_ph (v2q15, v2q15)
12164 void __builtin_mips_cmp_lt_ph (v2q15, v2q15)
12165 void __builtin_mips_cmp_le_ph (v2q15, v2q15)
12166 v4i8 __builtin_mips_pick_qb (v4i8, v4i8)
12167 v2q15 __builtin_mips_pick_ph (v2q15, v2q15)
12168 v2q15 __builtin_mips_packrl_ph (v2q15, v2q15)
12169 i32 __builtin_mips_extr_w (a64, imm0_31)
12170 i32 __builtin_mips_extr_w (a64, i32)
12171 i32 __builtin_mips_extr_r_w (a64, imm0_31)
12172 i32 __builtin_mips_extr_s_h (a64, i32)
12173 i32 __builtin_mips_extr_rs_w (a64, imm0_31)
12174 i32 __builtin_mips_extr_rs_w (a64, i32)
12175 i32 __builtin_mips_extr_s_h (a64, imm0_31)
12176 i32 __builtin_mips_extr_r_w (a64, i32)
12177 i32 __builtin_mips_extp (a64, imm0_31)
12178 i32 __builtin_mips_extp (a64, i32)
12179 i32 __builtin_mips_extpdp (a64, imm0_31)
12180 i32 __builtin_mips_extpdp (a64, i32)
12181 a64 __builtin_mips_shilo (a64, imm_n32_31)
12182 a64 __builtin_mips_shilo (a64, i32)
12183 a64 __builtin_mips_mthlip (a64, i32)
12184 void __builtin_mips_wrdsp (i32, imm0_63)
12185 i32 __builtin_mips_rddsp (imm0_63)
12186 i32 __builtin_mips_lbux (void *, i32)
12187 i32 __builtin_mips_lhx (void *, i32)
12188 i32 __builtin_mips_lwx (void *, i32)
12189 a64 __builtin_mips_ldx (void *, i32) [MIPS64 only]
12190 i32 __builtin_mips_bposge32 (void)
12191 a64 __builtin_mips_madd (a64, i32, i32);
12192 a64 __builtin_mips_maddu (a64, ui32, ui32);
12193 a64 __builtin_mips_msub (a64, i32, i32);
12194 a64 __builtin_mips_msubu (a64, ui32, ui32);
12195 a64 __builtin_mips_mult (i32, i32);
12196 a64 __builtin_mips_multu (ui32, ui32);
12197 @end smallexample
12199 The following built-in functions map directly to a particular MIPS DSP REV 2
12200 instruction.  Please refer to the architecture specification
12201 for details on what each instruction does.
12203 @smallexample
12204 v4q7 __builtin_mips_absq_s_qb (v4q7);
12205 v2i16 __builtin_mips_addu_ph (v2i16, v2i16);
12206 v2i16 __builtin_mips_addu_s_ph (v2i16, v2i16);
12207 v4i8 __builtin_mips_adduh_qb (v4i8, v4i8);
12208 v4i8 __builtin_mips_adduh_r_qb (v4i8, v4i8);
12209 i32 __builtin_mips_append (i32, i32, imm0_31);
12210 i32 __builtin_mips_balign (i32, i32, imm0_3);
12211 i32 __builtin_mips_cmpgdu_eq_qb (v4i8, v4i8);
12212 i32 __builtin_mips_cmpgdu_lt_qb (v4i8, v4i8);
12213 i32 __builtin_mips_cmpgdu_le_qb (v4i8, v4i8);
12214 a64 __builtin_mips_dpa_w_ph (a64, v2i16, v2i16);
12215 a64 __builtin_mips_dps_w_ph (a64, v2i16, v2i16);
12216 v2i16 __builtin_mips_mul_ph (v2i16, v2i16);
12217 v2i16 __builtin_mips_mul_s_ph (v2i16, v2i16);
12218 q31 __builtin_mips_mulq_rs_w (q31, q31);
12219 v2q15 __builtin_mips_mulq_s_ph (v2q15, v2q15);
12220 q31 __builtin_mips_mulq_s_w (q31, q31);
12221 a64 __builtin_mips_mulsa_w_ph (a64, v2i16, v2i16);
12222 v4i8 __builtin_mips_precr_qb_ph (v2i16, v2i16);
12223 v2i16 __builtin_mips_precr_sra_ph_w (i32, i32, imm0_31);
12224 v2i16 __builtin_mips_precr_sra_r_ph_w (i32, i32, imm0_31);
12225 i32 __builtin_mips_prepend (i32, i32, imm0_31);
12226 v4i8 __builtin_mips_shra_qb (v4i8, imm0_7);
12227 v4i8 __builtin_mips_shra_r_qb (v4i8, imm0_7);
12228 v4i8 __builtin_mips_shra_qb (v4i8, i32);
12229 v4i8 __builtin_mips_shra_r_qb (v4i8, i32);
12230 v2i16 __builtin_mips_shrl_ph (v2i16, imm0_15);
12231 v2i16 __builtin_mips_shrl_ph (v2i16, i32);
12232 v2i16 __builtin_mips_subu_ph (v2i16, v2i16);
12233 v2i16 __builtin_mips_subu_s_ph (v2i16, v2i16);
12234 v4i8 __builtin_mips_subuh_qb (v4i8, v4i8);
12235 v4i8 __builtin_mips_subuh_r_qb (v4i8, v4i8);
12236 v2q15 __builtin_mips_addqh_ph (v2q15, v2q15);
12237 v2q15 __builtin_mips_addqh_r_ph (v2q15, v2q15);
12238 q31 __builtin_mips_addqh_w (q31, q31);
12239 q31 __builtin_mips_addqh_r_w (q31, q31);
12240 v2q15 __builtin_mips_subqh_ph (v2q15, v2q15);
12241 v2q15 __builtin_mips_subqh_r_ph (v2q15, v2q15);
12242 q31 __builtin_mips_subqh_w (q31, q31);
12243 q31 __builtin_mips_subqh_r_w (q31, q31);
12244 a64 __builtin_mips_dpax_w_ph (a64, v2i16, v2i16);
12245 a64 __builtin_mips_dpsx_w_ph (a64, v2i16, v2i16);
12246 a64 __builtin_mips_dpaqx_s_w_ph (a64, v2q15, v2q15);
12247 a64 __builtin_mips_dpaqx_sa_w_ph (a64, v2q15, v2q15);
12248 a64 __builtin_mips_dpsqx_s_w_ph (a64, v2q15, v2q15);
12249 a64 __builtin_mips_dpsqx_sa_w_ph (a64, v2q15, v2q15);
12250 @end smallexample
12253 @node MIPS Paired-Single Support
12254 @subsection MIPS Paired-Single Support
12256 The MIPS64 architecture includes a number of instructions that
12257 operate on pairs of single-precision floating-point values.
12258 Each pair is packed into a 64-bit floating-point register,
12259 with one element being designated the ``upper half'' and
12260 the other being designated the ``lower half''.
12262 GCC supports paired-single operations using both the generic
12263 vector extensions (@pxref{Vector Extensions}) and a collection of
12264 MIPS-specific built-in functions.  Both kinds of support are
12265 enabled by the @option{-mpaired-single} command-line option.
12267 The vector type associated with paired-single values is usually
12268 called @code{v2sf}.  It can be defined in C as follows:
12270 @smallexample
12271 typedef float v2sf __attribute__ ((vector_size (8)));
12272 @end smallexample
12274 @code{v2sf} values are initialized in the same way as aggregates.
12275 For example:
12277 @smallexample
12278 v2sf a = @{1.5, 9.1@};
12279 v2sf b;
12280 float e, f;
12281 b = (v2sf) @{e, f@};
12282 @end smallexample
12284 @emph{Note:} The CPU's endianness determines which value is stored in
12285 the upper half of a register and which value is stored in the lower half.
12286 On little-endian targets, the first value is the lower one and the second
12287 value is the upper one.  The opposite order applies to big-endian targets.
12288 For example, the code above sets the lower half of @code{a} to
12289 @code{1.5} on little-endian targets and @code{9.1} on big-endian targets.
12293 @node MIPS Loongson Built-in Functions
12294 @subsection MIPS Loongson Built-in Functions
12296 GCC provides intrinsics to access the SIMD instructions provided by the
12297 ST Microelectronics Loongson-2E and -2F processors.  These intrinsics,
12298 available after inclusion of the @code{loongson.h} header file,
12299 operate on the following 64-bit vector types:
12301 @itemize
12302 @item @code{uint8x8_t}, a vector of eight unsigned 8-bit integers;
12303 @item @code{uint16x4_t}, a vector of four unsigned 16-bit integers;
12304 @item @code{uint32x2_t}, a vector of two unsigned 32-bit integers;
12305 @item @code{int8x8_t}, a vector of eight signed 8-bit integers;
12306 @item @code{int16x4_t}, a vector of four signed 16-bit integers;
12307 @item @code{int32x2_t}, a vector of two signed 32-bit integers.
12308 @end itemize
12310 The intrinsics provided are listed below; each is named after the
12311 machine instruction to which it corresponds, with suffixes added as
12312 appropriate to distinguish intrinsics that expand to the same machine
12313 instruction yet have different argument types.  Refer to the architecture
12314 documentation for a description of the functionality of each
12315 instruction.
12317 @smallexample
12318 int16x4_t packsswh (int32x2_t s, int32x2_t t);
12319 int8x8_t packsshb (int16x4_t s, int16x4_t t);
12320 uint8x8_t packushb (uint16x4_t s, uint16x4_t t);
12321 uint32x2_t paddw_u (uint32x2_t s, uint32x2_t t);
12322 uint16x4_t paddh_u (uint16x4_t s, uint16x4_t t);
12323 uint8x8_t paddb_u (uint8x8_t s, uint8x8_t t);
12324 int32x2_t paddw_s (int32x2_t s, int32x2_t t);
12325 int16x4_t paddh_s (int16x4_t s, int16x4_t t);
12326 int8x8_t paddb_s (int8x8_t s, int8x8_t t);
12327 uint64_t paddd_u (uint64_t s, uint64_t t);
12328 int64_t paddd_s (int64_t s, int64_t t);
12329 int16x4_t paddsh (int16x4_t s, int16x4_t t);
12330 int8x8_t paddsb (int8x8_t s, int8x8_t t);
12331 uint16x4_t paddush (uint16x4_t s, uint16x4_t t);
12332 uint8x8_t paddusb (uint8x8_t s, uint8x8_t t);
12333 uint64_t pandn_ud (uint64_t s, uint64_t t);
12334 uint32x2_t pandn_uw (uint32x2_t s, uint32x2_t t);
12335 uint16x4_t pandn_uh (uint16x4_t s, uint16x4_t t);
12336 uint8x8_t pandn_ub (uint8x8_t s, uint8x8_t t);
12337 int64_t pandn_sd (int64_t s, int64_t t);
12338 int32x2_t pandn_sw (int32x2_t s, int32x2_t t);
12339 int16x4_t pandn_sh (int16x4_t s, int16x4_t t);
12340 int8x8_t pandn_sb (int8x8_t s, int8x8_t t);
12341 uint16x4_t pavgh (uint16x4_t s, uint16x4_t t);
12342 uint8x8_t pavgb (uint8x8_t s, uint8x8_t t);
12343 uint32x2_t pcmpeqw_u (uint32x2_t s, uint32x2_t t);
12344 uint16x4_t pcmpeqh_u (uint16x4_t s, uint16x4_t t);
12345 uint8x8_t pcmpeqb_u (uint8x8_t s, uint8x8_t t);
12346 int32x2_t pcmpeqw_s (int32x2_t s, int32x2_t t);
12347 int16x4_t pcmpeqh_s (int16x4_t s, int16x4_t t);
12348 int8x8_t pcmpeqb_s (int8x8_t s, int8x8_t t);
12349 uint32x2_t pcmpgtw_u (uint32x2_t s, uint32x2_t t);
12350 uint16x4_t pcmpgth_u (uint16x4_t s, uint16x4_t t);
12351 uint8x8_t pcmpgtb_u (uint8x8_t s, uint8x8_t t);
12352 int32x2_t pcmpgtw_s (int32x2_t s, int32x2_t t);
12353 int16x4_t pcmpgth_s (int16x4_t s, int16x4_t t);
12354 int8x8_t pcmpgtb_s (int8x8_t s, int8x8_t t);
12355 uint16x4_t pextrh_u (uint16x4_t s, int field);
12356 int16x4_t pextrh_s (int16x4_t s, int field);
12357 uint16x4_t pinsrh_0_u (uint16x4_t s, uint16x4_t t);
12358 uint16x4_t pinsrh_1_u (uint16x4_t s, uint16x4_t t);
12359 uint16x4_t pinsrh_2_u (uint16x4_t s, uint16x4_t t);
12360 uint16x4_t pinsrh_3_u (uint16x4_t s, uint16x4_t t);
12361 int16x4_t pinsrh_0_s (int16x4_t s, int16x4_t t);
12362 int16x4_t pinsrh_1_s (int16x4_t s, int16x4_t t);
12363 int16x4_t pinsrh_2_s (int16x4_t s, int16x4_t t);
12364 int16x4_t pinsrh_3_s (int16x4_t s, int16x4_t t);
12365 int32x2_t pmaddhw (int16x4_t s, int16x4_t t);
12366 int16x4_t pmaxsh (int16x4_t s, int16x4_t t);
12367 uint8x8_t pmaxub (uint8x8_t s, uint8x8_t t);
12368 int16x4_t pminsh (int16x4_t s, int16x4_t t);
12369 uint8x8_t pminub (uint8x8_t s, uint8x8_t t);
12370 uint8x8_t pmovmskb_u (uint8x8_t s);
12371 int8x8_t pmovmskb_s (int8x8_t s);
12372 uint16x4_t pmulhuh (uint16x4_t s, uint16x4_t t);
12373 int16x4_t pmulhh (int16x4_t s, int16x4_t t);
12374 int16x4_t pmullh (int16x4_t s, int16x4_t t);
12375 int64_t pmuluw (uint32x2_t s, uint32x2_t t);
12376 uint8x8_t pasubub (uint8x8_t s, uint8x8_t t);
12377 uint16x4_t biadd (uint8x8_t s);
12378 uint16x4_t psadbh (uint8x8_t s, uint8x8_t t);
12379 uint16x4_t pshufh_u (uint16x4_t dest, uint16x4_t s, uint8_t order);
12380 int16x4_t pshufh_s (int16x4_t dest, int16x4_t s, uint8_t order);
12381 uint16x4_t psllh_u (uint16x4_t s, uint8_t amount);
12382 int16x4_t psllh_s (int16x4_t s, uint8_t amount);
12383 uint32x2_t psllw_u (uint32x2_t s, uint8_t amount);
12384 int32x2_t psllw_s (int32x2_t s, uint8_t amount);
12385 uint16x4_t psrlh_u (uint16x4_t s, uint8_t amount);
12386 int16x4_t psrlh_s (int16x4_t s, uint8_t amount);
12387 uint32x2_t psrlw_u (uint32x2_t s, uint8_t amount);
12388 int32x2_t psrlw_s (int32x2_t s, uint8_t amount);
12389 uint16x4_t psrah_u (uint16x4_t s, uint8_t amount);
12390 int16x4_t psrah_s (int16x4_t s, uint8_t amount);
12391 uint32x2_t psraw_u (uint32x2_t s, uint8_t amount);
12392 int32x2_t psraw_s (int32x2_t s, uint8_t amount);
12393 uint32x2_t psubw_u (uint32x2_t s, uint32x2_t t);
12394 uint16x4_t psubh_u (uint16x4_t s, uint16x4_t t);
12395 uint8x8_t psubb_u (uint8x8_t s, uint8x8_t t);
12396 int32x2_t psubw_s (int32x2_t s, int32x2_t t);
12397 int16x4_t psubh_s (int16x4_t s, int16x4_t t);
12398 int8x8_t psubb_s (int8x8_t s, int8x8_t t);
12399 uint64_t psubd_u (uint64_t s, uint64_t t);
12400 int64_t psubd_s (int64_t s, int64_t t);
12401 int16x4_t psubsh (int16x4_t s, int16x4_t t);
12402 int8x8_t psubsb (int8x8_t s, int8x8_t t);
12403 uint16x4_t psubush (uint16x4_t s, uint16x4_t t);
12404 uint8x8_t psubusb (uint8x8_t s, uint8x8_t t);
12405 uint32x2_t punpckhwd_u (uint32x2_t s, uint32x2_t t);
12406 uint16x4_t punpckhhw_u (uint16x4_t s, uint16x4_t t);
12407 uint8x8_t punpckhbh_u (uint8x8_t s, uint8x8_t t);
12408 int32x2_t punpckhwd_s (int32x2_t s, int32x2_t t);
12409 int16x4_t punpckhhw_s (int16x4_t s, int16x4_t t);
12410 int8x8_t punpckhbh_s (int8x8_t s, int8x8_t t);
12411 uint32x2_t punpcklwd_u (uint32x2_t s, uint32x2_t t);
12412 uint16x4_t punpcklhw_u (uint16x4_t s, uint16x4_t t);
12413 uint8x8_t punpcklbh_u (uint8x8_t s, uint8x8_t t);
12414 int32x2_t punpcklwd_s (int32x2_t s, int32x2_t t);
12415 int16x4_t punpcklhw_s (int16x4_t s, int16x4_t t);
12416 int8x8_t punpcklbh_s (int8x8_t s, int8x8_t t);
12417 @end smallexample
12419 @node MIPS SIMD Architecture Functions
12420 @subsection MIPS SIMD Architecture Functions
12422 GCC provides intrinsics to access the SIMD instructions provided by the
12423 MSA MIPS SIMD Architecture.  The interface is made available by
12424 including @code{<msa.h>} and using @option{-mmsa -mhart-float -mfp64 -mnan=2008}
12426 @itemize
12427 @item @code{v16i8}, a vector of sixteen signed 8-bit integers;
12428 @item @code{v16u8}, a vector of sixteen unsigned 8-bit integers;
12429 @item @code{v8i16}, a vector of eight signed 16-bit integers;
12430 @item @code{v8u16}, a vector of eight unsigned 16-bit integers;
12431 @item @code{v4i32}, a vector of four signed 32-bit integers;
12432 @item @code{v4u32}, a vector of four unsigned 32-bit integers;
12433 @item @code{v2i64}, a vector of two signed 64-bit integers;
12434 @item @code{v2u64}, a vector of two unsigned 64-bit integers;
12435 @item @code{v4f32}, a vector of four 32-bit floats;
12436 @item @code{v2f64}, a vector of two 64-bit doubles.
12437 @end itemize
12439 @itemize
12440 @item @code{imm0_1}, an integer literal in range 0 to 1;
12441 @item @code{imm0_3}, an integer literal in range 0 to 3;
12442 @item @code{imm0_7}, an integer literal in range 0 to 7;
12443 @item @code{imm0_15}, an integer literal in range 0 to 15;
12444 @item @code{imm0_31}, an integer literal in range 0 to 31;
12445 @item @code{imm0_63}, an integer literal in range 0 to 63;
12446 @item @code{imm0_255}, an integer literal in range 0 to 255;
12447 @item @code{imm_n16_15}, an integer literal in range -16 to 15;
12448 @item @code{imm_n512_511}, an integer literal in range -512 to 511;
12449 @item @code{imm_n1024_1022}, an integer literal in range -512 to 511 left shifted by 1 bit, i.e., -1024, -1022, @dots{}, 1020, 1022;
12450 @item @code{imm_n2048_2044}, an integer literal in range -512 to 511 left shifted by 2 bits, i.e., -2048, -2044, @dots{}, 2040, 2044;
12451 @item @code{imm_n4096_4088}, an integer literal in range -512 to 511 left shifted by 3 bits, i.e., -4096, -4088, @dots{}, 4080, 4088;
12452 @item @code{imm1_4}, an integer literal in range 1 to 4.
12453 @end itemize
12455 @smallexample
12457 typedef int i32;
12458 #if __LONG_MAX__ == __LONG_LONG_MAX__
12459 typedef long i64;
12460 #else
12461 typedef long long i64;
12462 #endif
12464 typedef unsigned int u32;
12465 #if __LONG_MAX__ == __LONG_LONG_MAX__
12466 typedef unsigned long u64;
12467 #else
12468 typedef unsigned long long u64;
12469 #endif
12471 typedef double f64;
12472 typedef float f32;
12474 @end smallexample
12476 The intrinsics provided are listed below; each is named after the
12477 machine instruction.
12479 @smallexample
12480 v16i8 __builtin_msa_add_a_b (v16i8, v16i8);
12481 v8i16 __builtin_msa_add_a_h (v8i16, v8i16);
12482 v4i32 __builtin_msa_add_a_w (v4i32, v4i32);
12483 v2i64 __builtin_msa_add_a_d (v2i64, v2i64);
12485 v16i8 __builtin_msa_adds_a_b (v16i8, v16i8);
12486 v8i16 __builtin_msa_adds_a_h (v8i16, v8i16);
12487 v4i32 __builtin_msa_adds_a_w (v4i32, v4i32);
12488 v2i64 __builtin_msa_adds_a_d (v2i64, v2i64);
12490 v16i8 __builtin_msa_adds_s_b (v16i8, v16i8);
12491 v8i16 __builtin_msa_adds_s_h (v8i16, v8i16);
12492 v4i32 __builtin_msa_adds_s_w (v4i32, v4i32);
12493 v2i64 __builtin_msa_adds_s_d (v2i64, v2i64);
12495 v16u8 __builtin_msa_adds_u_b (v16u8, v16u8);
12496 v8u16 __builtin_msa_adds_u_h (v8u16, v8u16);
12497 v4u32 __builtin_msa_adds_u_w (v4u32, v4u32);
12498 v2u64 __builtin_msa_adds_u_d (v2u64, v2u64);
12500 v16i8 __builtin_msa_addv_b (v16i8, v16i8);
12501 v8i16 __builtin_msa_addv_h (v8i16, v8i16);
12502 v4i32 __builtin_msa_addv_w (v4i32, v4i32);
12503 v2i64 __builtin_msa_addv_d (v2i64, v2i64);
12505 v16i8 __builtin_msa_addvi_b (v16i8, imm0_31);
12506 v8i16 __builtin_msa_addvi_h (v8i16, imm0_31);
12507 v4i32 __builtin_msa_addvi_w (v4i32, imm0_31);
12508 v2i64 __builtin_msa_addvi_d (v2i64, imm0_31);
12510 v16u8 __builtin_msa_and_v (v16u8, v16u8);
12512 v16u8 __builtin_msa_andi_b (v16u8, imm0_255);
12514 v16i8 __builtin_msa_asub_s_b (v16i8, v16i8);
12515 v8i16 __builtin_msa_asub_s_h (v8i16, v8i16);
12516 v4i32 __builtin_msa_asub_s_w (v4i32, v4i32);
12517 v2i64 __builtin_msa_asub_s_d (v2i64, v2i64);
12519 v16u8 __builtin_msa_asub_u_b (v16u8, v16u8);
12520 v8u16 __builtin_msa_asub_u_h (v8u16, v8u16);
12521 v4u32 __builtin_msa_asub_u_w (v4u32, v4u32);
12522 v2u64 __builtin_msa_asub_u_d (v2u64, v2u64);
12524 v16i8 __builtin_msa_ave_s_b (v16i8, v16i8);
12525 v8i16 __builtin_msa_ave_s_h (v8i16, v8i16);
12526 v4i32 __builtin_msa_ave_s_w (v4i32, v4i32);
12527 v2i64 __builtin_msa_ave_s_d (v2i64, v2i64);
12529 v16u8 __builtin_msa_ave_u_b (v16u8, v16u8);
12530 v8u16 __builtin_msa_ave_u_h (v8u16, v8u16);
12531 v4u32 __builtin_msa_ave_u_w (v4u32, v4u32);
12532 v2u64 __builtin_msa_ave_u_d (v2u64, v2u64);
12534 16i8 __builtin_msa_aver_s_b (v16i8, v16i8);
12535 8i16 __builtin_msa_aver_s_h (v8i16, v8i16);
12536 4i32 __builtin_msa_aver_s_w (v4i32, v4i32);
12537 2i64 __builtin_msa_aver_s_d (v2i64, v2i64);
12539 v16u8 __builtin_msa_aver_u_b (v16u8, v16u8);
12540 v8u16 __builtin_msa_aver_u_h (v8u16, v8u16);
12541 v4u32 __builtin_msa_aver_u_w (v4u32, v4u32);
12542 v2u64 __builtin_msa_aver_u_d (v2u64, v2u64);
12544 v16u8 __builtin_msa_bclr_b (v16u8, v16u8);
12545 v8u16 __builtin_msa_bclr_h (v8u16, v8u16);
12546 4u32 __builtin_msa_bclr_w (v4u32, v4u32);
12547 v2u64 __builtin_msa_bclr_d (v2u64, v2u64);
12549 v16u8 __builtin_msa_bclri_b (v16u8, imm0_7);
12550 v8u16 __builtin_msa_bclri_h (v8u16, imm0_15);
12551 v4u32 __builtin_msa_bclri_w (v4u32, imm0_31);
12552 v2u64 __builtin_msa_bclri_d (v2u64, imm0_63);
12554 v16u8 __builtin_msa_binsl_b (v16u8, v16u8, v16u8);
12555 v8u16 __builtin_msa_binsl_h (v8u16, v8u16, v8u16);
12556 v4u32 __builtin_msa_binsl_w (v4u32, v4u32, v4u32);
12557 v2u64 __builtin_msa_binsl_d (v2u64, v2u64, v2u64);
12559 v16u8 __builtin_msa_binsli_b (v16u8, v16u8, imm0_7);
12560 v8u16 __builtin_msa_binsli_h (v8u16, v8u16, imm0_15);
12561 v4u32 __builtin_msa_binsli_w (v4u32, v4u32, imm0_31);
12562 v2u64 __builtin_msa_binsli_d (v2u64, v2u64, imm0_63);
12564 v16u8 __builtin_msa_binsr_b (v16u8, v16u8, v16u8);
12565 v8u16 __builtin_msa_binsr_h (v8u16, v8u16, v8u16);
12566 v4u32 __builtin_msa_binsr_w (v4u32, v4u32, v4u32);
12567 v2u64 __builtin_msa_binsr_d (v2u64, v2u64, v2u64);
12569 v16u8 __builtin_msa_binsri_b (v16u8, v16u8, imm0_7);
12570 v8u16 __builtin_msa_binsri_h (v8u16, v8u16, imm0_15);
12571 v4u32 __builtin_msa_binsri_w (v4u32, v4u32, imm0_31);
12572 v2u64 __builtin_msa_binsri_d (v2u64, v2u64, imm0_63);
12574 v16u8 __builtin_msa_bmnz_v (v16u8, v16u8, v16u8);
12576 v16u8 __builtin_msa_bmnzi_b (v16u8, v16u8, imm0_255);
12578 v16u8 __builtin_msa_bmz_v (v16u8, v16u8, v16u8);
12580 v16u8 __builtin_msa_bmzi_b (v16u8, v16u8, imm0_255);
12582 v16u8 __builtin_msa_bneg_b (v16u8, v16u8);
12583 v8u16 __builtin_msa_bneg_h (v8u16, v8u16);
12584 v4u32 __builtin_msa_bneg_w (v4u32, v4u32);
12585 v2u64 __builtin_msa_bneg_d (v2u64, v2u64);
12587 v16u8 __builtin_msa_bnegi_b (v16u8, imm0_7);
12588 v8u16 __builtin_msa_bnegi_h (v8u16, imm0_15);
12589 v4u32 __builtin_msa_bnegi_w (v4u32, imm0_31);
12590 v2u64 __builtin_msa_bnegi_d (v2u64, imm0_63);
12592 i32 __builtin_msa_bnz_b (v16u8);
12593 i32 __builtin_msa_bnz_h (v8u16);
12594 i32 __builtin_msa_bnz_w (v4u32);
12595 i32 __builtin_msa_bnz_d (v2u64);
12597 i32 __builtin_msa_bnz_v (v16u8);
12599 v16u8 __builtin_msa_bsel_v (v16u8, v16u8, v16u8);
12601 v16u8 __builtin_msa_bseli_b (v16u8, v16u8, imm0_255);
12603 v16u8 __builtin_msa_bset_b (v16u8, v16u8);
12604 v8u16 __builtin_msa_bset_h (v8u16, v8u16);
12605 v4u32 __builtin_msa_bset_w (v4u32, v4u32);
12606 v2u64 __builtin_msa_bset_d (v2u64, v2u64);
12608 v16u8 __builtin_msa_bseti_b (v16u8, imm0_7);
12609 v8u16 __builtin_msa_bseti_h (v8u16, imm0_15);
12610 v4u32 __builtin_msa_bseti_w (v4u32, imm0_31);
12611 v2u64 __builtin_msa_bseti_d (v2u64, imm0_63);
12613 i32 __builtin_msa_bz_b (v16u8);
12614 i32 __builtin_msa_bz_h (v8u16);
12615 i32 __builtin_msa_bz_w (v4u32);
12616 i32 __builtin_msa_bz_d (v2u64);
12618 i32 __builtin_msa_bz_v (v16u8);
12620 v16i8 __builtin_msa_ceq_b (v16i8, v16i8);
12621 v8i16 __builtin_msa_ceq_h (v8i16, v8i16);
12622 v4i32 __builtin_msa_ceq_w (v4i32, v4i32);
12623 v2i64 __builtin_msa_ceq_d (v2i64, v2i64);
12625 v16i8 __builtin_msa_ceqi_b (v16i8, imm_n16_15);
12626 v8i16 __builtin_msa_ceqi_h (v8i16, imm_n16_15);
12627 v4i32 __builtin_msa_ceqi_w (v4i32, imm_n16_15);
12628 v2i64 __builtin_msa_ceqi_d (v2i64, imm_n16_15);
12630 i32 __builtin_msa_cfcmsa (imm0_31);
12632 v16i8 __builtin_msa_cle_s_b (v16i8, v16i8);
12633 v8i16 __builtin_msa_cle_s_h (v8i16, v8i16);
12634 v4i32 __builtin_msa_cle_s_w (v4i32, v4i32);
12635 v2i64 __builtin_msa_cle_s_d (v2i64, v2i64);
12637 v16i8 __builtin_msa_cle_u_b (v16u8, v16u8);
12638 v8i16 __builtin_msa_cle_u_h (v8u16, v8u16);
12639 v4i32 __builtin_msa_cle_u_w (v4u32, v4u32);
12640 v2i64 __builtin_msa_cle_u_d (v2u64, v2u64);
12642 v16i8 __builtin_msa_clei_s_b (v16i8, imm_n16_15);
12643 v8i16 __builtin_msa_clei_s_h (v8i16, imm_n16_15);
12644 v4i32 __builtin_msa_clei_s_w (v4i32, imm_n16_15);
12645 v2i64 __builtin_msa_clei_s_d (v2i64, imm_n16_15);
12647 v16i8 __builtin_msa_clei_u_b (v16u8, imm0_31);
12648 v8i16 __builtin_msa_clei_u_h (v8u16, imm0_31);
12649 v4i32 __builtin_msa_clei_u_w (v4u32, imm0_31);
12650 v2i64 __builtin_msa_clei_u_d (v2u64, imm0_31);
12652 v16i8 __builtin_msa_clt_s_b (v16i8, v16i8);
12653 v8i16 __builtin_msa_clt_s_h (v8i16, v8i16);
12654 v4i32 __builtin_msa_clt_s_w (v4i32, v4i32);
12655 v2i64 __builtin_msa_clt_s_d (v2i64, v2i64);
12657 v16i8 __builtin_msa_clt_u_b (v16u8, v16u8);
12658 v8i16 __builtin_msa_clt_u_h (v8u16, v8u16);
12659 v4i32 __builtin_msa_clt_u_w (v4u32, v4u32);
12660 v2i64 __builtin_msa_clt_u_d (v2u64, v2u64);
12662 v16i8 __builtin_msa_clti_s_b (v16i8, imm_n16_15);
12663 v8i16 __builtin_msa_clti_s_h (v8i16, imm_n16_15);
12664 v4i32 __builtin_msa_clti_s_w (v4i32, imm_n16_15);
12665 v2i64 __builtin_msa_clti_s_d (v2i64, imm_n16_15);
12667 v16i8 __builtin_msa_clti_u_b (v16u8, imm0_31);
12668 v8i16 __builtin_msa_clti_u_h (v8u16, imm0_31);
12669 v4i32 __builtin_msa_clti_u_w (v4u32, imm0_31);
12670 v2i64 __builtin_msa_clti_u_d (v2u64, imm0_31);
12672 i32 __builtin_msa_copy_s_b (v16i8, imm0_15);
12673 i32 __builtin_msa_copy_s_h (v8i16, imm0_7);
12674 i32 __builtin_msa_copy_s_w (v4i32, imm0_3);
12675 i64 __builtin_msa_copy_s_d (v2i64, imm0_1);
12677 u32 __builtin_msa_copy_u_b (v16i8, imm0_15);
12678 u32 __builtin_msa_copy_u_h (v8i16, imm0_7);
12679 u32 __builtin_msa_copy_u_w (v4i32, imm0_3);
12680 u64 __builtin_msa_copy_u_d (v2i64, imm0_1);
12682 void __builtin_msa_ctcmsa (imm0_31, i32);
12684 v16i8 __builtin_msa_div_s_b (v16i8, v16i8);
12685 v8i16 __builtin_msa_div_s_h (v8i16, v8i16);
12686 v4i32 __builtin_msa_div_s_w (v4i32, v4i32);
12687 v2i64 __builtin_msa_div_s_d (v2i64, v2i64);
12689 v16u8 __builtin_msa_div_u_b (v16u8, v16u8);
12690 v8u16 __builtin_msa_div_u_h (v8u16, v8u16);
12691 v4u32 __builtin_msa_div_u_w (v4u32, v4u32);
12692 v2u64 __builtin_msa_div_u_d (v2u64, v2u64);
12694 v8i16 __builtin_msa_dotp_s_h (v16i8, v16i8);
12695 v4i32 __builtin_msa_dotp_s_w (v8i16, v8i16);
12696 v2i64 __builtin_msa_dotp_s_d (v4i32, v4i32);
12698 v8u16 __builtin_msa_dotp_u_h (v16u8, v16u8);
12699 v4u32 __builtin_msa_dotp_u_w (v8u16, v8u16);
12700 v2u64 __builtin_msa_dotp_u_d (v4u32, v4u32);
12702 v8i16 __builtin_msa_dpadd_s_h (v8i16, v16i8, v16i8);
12703 v4i32 __builtin_msa_dpadd_s_w (v4i32, v8i16, v8i16);
12704 v2i64 __builtin_msa_dpadd_s_d (v2i64, v4i32, v4i32);
12706 v8u16 __builtin_msa_dpadd_u_h (v8u16, v16u8, v16u8);
12707 v4u32 __builtin_msa_dpadd_u_w (v4u32, v8u16, v8u16);
12708 v2u64 __builtin_msa_dpadd_u_d (v2u64, v4u32, v4u32);
12710 v8i16 __builtin_msa_dpsub_s_h (v8i16, v16i8, v16i8);
12711 v4i32 __builtin_msa_dpsub_s_w (v4i32, v8i16, v8i16);
12712 v2i64 __builtin_msa_dpsub_s_d (v2i64, v4i32, v4i32);
12714 v8i16 __builtin_msa_dpsub_u_h (v8i16, v16u8, v16u8);
12715 v4i32 __builtin_msa_dpsub_u_w (v4i32, v8u16, v8u16);
12716 v2i64 __builtin_msa_dpsub_u_d (v2i64, v4u32, v4u32);
12718 v4f32 __builtin_msa_fadd_w (v4f32, v4f32);
12719 v2f64 __builtin_msa_fadd_d (v2f64, v2f64);
12721 v4i32 __builtin_msa_fcaf_w (v4f32, v4f32);
12722 v2i64 __builtin_msa_fcaf_d (v2f64, v2f64);
12724 v4i32 __builtin_msa_fceq_w (v4f32, v4f32);
12725 v2i64 __builtin_msa_fceq_d (v2f64, v2f64);
12727 v4i32 __builtin_msa_fclass_w (v4f32);
12728 v2i64 __builtin_msa_fclass_d (v2f64);
12730 v4i32 __builtin_msa_fcle_w (v4f32, v4f32);
12731 v2i64 __builtin_msa_fcle_d (v2f64, v2f64);
12733 v4i32 __builtin_msa_fclt_w (v4f32, v4f32);
12734 v2i64 __builtin_msa_fclt_d (v2f64, v2f64);
12736 v4i32 __builtin_msa_fcne_w (v4f32, v4f32);
12737 v2i64 __builtin_msa_fcne_d (v2f64, v2f64);
12739 v4i32 __builtin_msa_fcor_w (v4f32, v4f32);
12740 v2i64 __builtin_msa_fcor_d (v2f64, v2f64);
12742 v4i32 __builtin_msa_fcueq_w (v4f32, v4f32);
12743 v2i64 __builtin_msa_fcueq_d (v2f64, v2f64);
12745 v4i32 __builtin_msa_fcule_w (v4f32, v4f32);
12746 v2i64 __builtin_msa_fcule_d (v2f64, v2f64);
12748 v4i32 __builtin_msa_fcult_w (v4f32, v4f32);
12749 v2i64 __builtin_msa_fcult_d (v2f64, v2f64);
12751 v4i32 __builtin_msa_fcun_w (v4f32, v4f32);
12752 v2i64 __builtin_msa_fcun_d (v2f64, v2f64);
12754 v4i32 __builtin_msa_fcune_w (v4f32, v4f32);
12755 v2i64 __builtin_msa_fcune_d (v2f64, v2f64);
12757 v4f32 __builtin_msa_fdiv_w (v4f32, v4f32);
12758 v2f64 __builtin_msa_fdiv_d (v2f64, v2f64);
12760 v8i16 __builtin_msa_fexdo_h (v4f32, v4f32);
12761 v4f32 __builtin_msa_fexdo_w (v2f64, v2f64);
12763 v4f32 __builtin_msa_fexp2_w (v4f32, v4i32);
12764 v2f64 __builtin_msa_fexp2_d (v2f64, v2i64);
12766 v4f32 __builtin_msa_fexupl_w (v8i16);
12767 v2f64 __builtin_msa_fexupl_d (v4f32);
12769 v4f32 __builtin_msa_fexupr_w (v8i16);
12770 v2f64 __builtin_msa_fexupr_d (v4f32);
12772 v4f32 __builtin_msa_ffint_s_w (v4i32);
12773 v2f64 __builtin_msa_ffint_s_d (v2i64);
12775 v4f32 __builtin_msa_ffint_u_w (v4u32);
12776 v2f64 __builtin_msa_ffint_u_d (v2u64);
12778 v4f32 __builtin_msa_ffql_w (v8i16);
12779 v2f64 __builtin_msa_ffql_d (v4i32);
12781 v4f32 __builtin_msa_ffqr_w (v8i16);
12782 v2f64 __builtin_msa_ffqr_d (v4i32);
12784 v16i8 __builtin_msa_fill_b (i32);
12785 v8i16 __builtin_msa_fill_h (i32);
12786 v4i32 __builtin_msa_fill_w (i32);
12787 v2i64 __builtin_msa_fill_d (i64);
12789 v4f32 __builtin_msa_flog2_w (v4f32);
12790 v2f64 __builtin_msa_flog2_d (v2f64);
12792 v4f32 __builtin_msa_fmadd_w (v4f32, v4f32, v4f32);
12793 v2f64 __builtin_msa_fmadd_d (v2f64, v2f64, v2f64);
12795 v4f32 __builtin_msa_fmax_w (v4f32, v4f32);
12796 v2f64 __builtin_msa_fmax_d (v2f64, v2f64);
12798 v4f32 __builtin_msa_fmax_a_w (v4f32, v4f32);
12799 v2f64 __builtin_msa_fmax_a_d (v2f64, v2f64);
12801 v4f32 __builtin_msa_fmin_w (v4f32, v4f32);
12802 v2f64 __builtin_msa_fmin_d (v2f64, v2f64);
12804 v4f32 __builtin_msa_fmin_a_w (v4f32, v4f32);
12805 v2f64 __builtin_msa_fmin_a_d (v2f64, v2f64);
12807 v4f32 __builtin_msa_fmsub_w (v4f32, v4f32, v4f32);
12808 v2f64 __builtin_msa_fmsub_d (v2f64, v2f64, v2f64);
12810 v4f32 __builtin_msa_fmul_w (v4f32, v4f32);
12811 v2f64 __builtin_msa_fmul_d (v2f64, v2f64);
12813 v4f32 __builtin_msa_frint_w (v4f32);
12814 v2f64 __builtin_msa_frint_d (v2f64);
12816 v4f32 __builtin_msa_frcp_w (v4f32);
12817 v2f64 __builtin_msa_frcp_d (v2f64);
12819 v4f32 __builtin_msa_frsqrt_w (v4f32);
12820 v2f64 __builtin_msa_frsqrt_d (v2f64);
12822 v4i32 __builtin_msa_fsaf_w (v4f32, v4f32);
12823 v2i64 __builtin_msa_fsaf_d (v2f64, v2f64);
12825 v4i32 __builtin_msa_fseq_w (v4f32, v4f32);
12826 v2i64 __builtin_msa_fseq_d (v2f64, v2f64);
12828 v4i32 __builtin_msa_fsle_w (v4f32, v4f32);
12829 v2i64 __builtin_msa_fsle_d (v2f64, v2f64);
12831 v4i32 __builtin_msa_fslt_w (v4f32, v4f32);
12832 v2i64 __builtin_msa_fslt_d (v2f64, v2f64);
12834 v4i32 __builtin_msa_fsne_w (v4f32, v4f32);
12835 v2i64 __builtin_msa_fsne_d (v2f64, v2f64);
12837 v4i32 __builtin_msa_fsor_w (v4f32, v4f32);
12838 v2i64 __builtin_msa_fsor_d (v2f64, v2f64);
12840 v4f32 __builtin_msa_fsqrt_w (v4f32);
12841 v2f64 __builtin_msa_fsqrt_d (v2f64);
12843 v4f32 __builtin_msa_fsub_w (v4f32, v4f32);
12844 v2f64 __builtin_msa_fsub_d (v2f64, v2f64);
12846 v4i32 __builtin_msa_fsueq_w (v4f32, v4f32);
12847 v2i64 __builtin_msa_fsueq_d (v2f64, v2f64);
12849 v4i32 __builtin_msa_fsule_w (v4f32, v4f32);
12850 v2i64 __builtin_msa_fsule_d (v2f64, v2f64);
12852 v4i32 __builtin_msa_fsult_w (v4f32, v4f32);
12853 v2i64 __builtin_msa_fsult_d (v2f64, v2f64);
12855 v4i32 __builtin_msa_fsun_w (v4f32, v4f32);
12856 v2i64 __builtin_msa_fsun_d (v2f64, v2f64);
12858 v4i32 __builtin_msa_fsune_w (v4f32, v4f32);
12859 v2i64 __builtin_msa_fsune_d (v2f64, v2f64);
12861 v4i32 __builtin_msa_ftint_s_w (v4f32);
12862 v2i64 __builtin_msa_ftint_s_d (v2f64);
12864 v4u32 __builtin_msa_ftint_u_w (v4f32);
12865 v2u64 __builtin_msa_ftint_u_d (v2f64);
12867 v8i16 __builtin_msa_ftq_h (v4f32, v4f32);
12868 v4i32 __builtin_msa_ftq_w (v2f64, v2f64);
12870 v4i32 __builtin_msa_ftrunc_s_w (v4f32);
12871 v2i64 __builtin_msa_ftrunc_s_d (v2f64);
12873 v4u32 __builtin_msa_ftrunc_u_w (v4f32);
12874 v2u64 __builtin_msa_ftrunc_u_d (v2f64);
12876 v8i16 __builtin_msa_hadd_s_h (v16i8, v16i8);
12877 v4i32 __builtin_msa_hadd_s_w (v8i16, v8i16);
12878 v2i64 __builtin_msa_hadd_s_d (v4i32, v4i32);
12880 v8u16 __builtin_msa_hadd_u_h (v16u8, v16u8);
12881 v4u32 __builtin_msa_hadd_u_w (v8u16, v8u16);
12882 v2u64 __builtin_msa_hadd_u_d (v4u32, v4u32);
12884 v8i16 __builtin_msa_hsub_s_h (v16i8, v16i8);
12885 v4i32 __builtin_msa_hsub_s_w (v8i16, v8i16);
12886 v2i64 __builtin_msa_hsub_s_d (v4i32, v4i32);
12888 v8i16 __builtin_msa_hsub_u_h (v16u8, v16u8);
12889 v4i32 __builtin_msa_hsub_u_w (v8u16, v8u16);
12890 v2i64 __builtin_msa_hsub_u_d (v4u32, v4u32);
12892 v16i8 __builtin_msa_ilvev_b (v16i8, v16i8);
12893 v8i16 __builtin_msa_ilvev_h (v8i16, v8i16);
12894 v4i32 __builtin_msa_ilvev_w (v4i32, v4i32);
12895 v2i64 __builtin_msa_ilvev_d (v2i64, v2i64);
12897 v16i8 __builtin_msa_ilvl_b (v16i8, v16i8);
12898 v8i16 __builtin_msa_ilvl_h (v8i16, v8i16);
12899 v4i32 __builtin_msa_ilvl_w (v4i32, v4i32);
12900 v2i64 __builtin_msa_ilvl_d (v2i64, v2i64);
12902 v16i8 __builtin_msa_ilvod_b (v16i8, v16i8);
12903 v8i16 __builtin_msa_ilvod_h (v8i16, v8i16);
12904 v4i32 __builtin_msa_ilvod_w (v4i32, v4i32);
12905 v2i64 __builtin_msa_ilvod_d (v2i64, v2i64);
12907 v16i8 __builtin_msa_ilvr_b (v16i8, v16i8);
12908 v8i16 __builtin_msa_ilvr_h (v8i16, v8i16);
12909 v4i32 __builtin_msa_ilvr_w (v4i32, v4i32);
12910 v2i64 __builtin_msa_ilvr_d (v2i64, v2i64);
12912 v16i8 __builtin_msa_insert_b (v16i8, imm0_15, i32);
12913 v8i16 __builtin_msa_insert_h (v8i16, imm0_7, i32);
12914 v4i32 __builtin_msa_insert_w (v4i32, imm0_3, i32);
12915 v2i64 __builtin_msa_insert_d (v2i64, imm0_1, i64);
12917 v16i8 __builtin_msa_insve_b (v16i8, imm0_15, v16i8);
12918 v8i16 __builtin_msa_insve_h (v8i16, imm0_7, v8i16);
12919 v4i32 __builtin_msa_insve_w (v4i32, imm0_3, v4i32);
12920 v2i64 __builtin_msa_insve_d (v2i64, imm0_1, v2i64);
12922 v16i8 __builtin_msa_ld_b (void *, imm_n512_511);
12923 v8i16 __builtin_msa_ld_h (void *, imm_n1024_1022);
12924 v4i32 __builtin_msa_ld_w (void *, imm_n2048_2044);
12925 v2i64 __builtin_msa_ld_d (void *, imm_n4096_4088);
12927 v16i8 __builtin_msa_ldi_b (imm_n512_511);
12928 v8i16 __builtin_msa_ldi_h (imm_n512_511);
12929 v4i32 __builtin_msa_ldi_w (imm_n512_511);
12930 v2i64 __builtin_msa_ldi_d (imm_n512_511);
12932 v8i16 __builtin_msa_madd_q_h (v8i16, v8i16, v8i16);
12933 v4i32 __builtin_msa_madd_q_w (v4i32, v4i32, v4i32);
12935 v8i16 __builtin_msa_maddr_q_h (v8i16, v8i16, v8i16);
12936 v4i32 __builtin_msa_maddr_q_w (v4i32, v4i32, v4i32);
12938 v16i8 __builtin_msa_maddv_b (v16i8, v16i8, v16i8);
12939 v8i16 __builtin_msa_maddv_h (v8i16, v8i16, v8i16);
12940 v4i32 __builtin_msa_maddv_w (v4i32, v4i32, v4i32);
12941 v2i64 __builtin_msa_maddv_d (v2i64, v2i64, v2i64);
12943 v16i8 __builtin_msa_max_a_b (v16i8, v16i8);
12944 v8i16 __builtin_msa_max_a_h (v8i16, v8i16);
12945 v4i32 __builtin_msa_max_a_w (v4i32, v4i32);
12946 v2i64 __builtin_msa_max_a_d (v2i64, v2i64);
12948 v16i8 __builtin_msa_max_s_b (v16i8, v16i8);
12949 v8i16 __builtin_msa_max_s_h (v8i16, v8i16);
12950 v4i32 __builtin_msa_max_s_w (v4i32, v4i32);
12951 v2i64 __builtin_msa_max_s_d (v2i64, v2i64);
12953 v16u8 __builtin_msa_max_u_b (v16u8, v16u8);
12954 v8u16 __builtin_msa_max_u_h (v8u16, v8u16);
12955 v4u32 __builtin_msa_max_u_w (v4u32, v4u32);
12956 v2u64 __builtin_msa_max_u_d (v2u64, v2u64);
12958 v16i8 __builtin_msa_maxi_s_b (v16i8, imm_n16_15);
12959 v8i16 __builtin_msa_maxi_s_h (v8i16, imm_n16_15);
12960 v4i32 __builtin_msa_maxi_s_w (v4i32, imm_n16_15);
12961 v2i64 __builtin_msa_maxi_s_d (v2i64, imm_n16_15);
12963 v16u8 __builtin_msa_maxi_u_b (v16u8, imm0_31);
12964 v8u16 __builtin_msa_maxi_u_h (v8u16, imm0_31);
12965 v4u32 __builtin_msa_maxi_u_w (v4u32, imm0_31);
12966 v2u64 __builtin_msa_maxi_u_d (v2u64, imm0_31);
12968 v16i8 __builtin_msa_min_a_b (v16i8, v16i8);
12969 v8i16 __builtin_msa_min_a_h (v8i16, v8i16);
12970 v4i32 __builtin_msa_min_a_w (v4i32, v4i32);
12971 v2i64 __builtin_msa_min_a_d (v2i64, v2i64);
12973 v16i8 __builtin_msa_min_s_b (v16i8, v16i8);
12974 v8i16 __builtin_msa_min_s_h (v8i16, v8i16);
12975 v4i32 __builtin_msa_min_s_w (v4i32, v4i32);
12976 v2i64 __builtin_msa_min_s_d (v2i64, v2i64);
12978 v16u8 __builtin_msa_min_u_b (v16u8, v16u8);
12979 v8u16 __builtin_msa_min_u_h (v8u16, v8u16);
12980 v4u32 __builtin_msa_min_u_w (v4u32, v4u32);
12981 v2u64 __builtin_msa_min_u_d (v2u64, v2u64);
12983 v16i8 __builtin_msa_mini_s_b (v16i8, imm_n16_15);
12984 v8i16 __builtin_msa_mini_s_h (v8i16, imm_n16_15);
12985 v4i32 __builtin_msa_mini_s_w (v4i32, imm_n16_15);
12986 v2i64 __builtin_msa_mini_s_d (v2i64, imm_n16_15);
12988 v16u8 __builtin_msa_mini_u_b (v16u8, imm0_31);
12989 v8u16 __builtin_msa_mini_u_h (v8u16, imm0_31);
12990 v4u32 __builtin_msa_mini_u_w (v4u32, imm0_31);
12991 v2u64 __builtin_msa_mini_u_d (v2u64, imm0_31);
12993 v16i8 __builtin_msa_mod_s_b (v16i8, v16i8);
12994 v8i16 __builtin_msa_mod_s_h (v8i16, v8i16);
12995 v4i32 __builtin_msa_mod_s_w (v4i32, v4i32);
12996 v2i64 __builtin_msa_mod_s_d (v2i64, v2i64);
12998 v16u8 __builtin_msa_mod_u_b (v16u8, v16u8);
12999 v8u16 __builtin_msa_mod_u_h (v8u16, v8u16);
13000 v4u32 __builtin_msa_mod_u_w (v4u32, v4u32);
13001 v2u64 __builtin_msa_mod_u_d (v2u64, v2u64);
13003 v16i8 __builtin_msa_move_v_b (v16i8);
13005 v8i16 __builtin_msa_msub_q_h (v8i16, v8i16, v8i16);
13006 v4i32 __builtin_msa_msub_q_w (v4i32, v4i32, v4i32);
13008 v8i16 __builtin_msa_msubr_q_h (v8i16, v8i16, v8i16);
13009 v4i32 __builtin_msa_msubr_q_w (v4i32, v4i32, v4i32);
13011 v16i8 __builtin_msa_msubv_b (v16i8, v16i8, v16i8);
13012 v8i16 __builtin_msa_msubv_h (v8i16, v8i16, v8i16);
13013 v4i32 __builtin_msa_msubv_w (v4i32, v4i32, v4i32);
13014 v2i64 __builtin_msa_msubv_d (v2i64, v2i64, v2i64);
13016 v8i16 __builtin_msa_mul_q_h (v8i16, v8i16);
13017 v4i32 __builtin_msa_mul_q_w (v4i32, v4i32);
13019 v8i16 __builtin_msa_mulr_q_h (v8i16, v8i16);
13020 v4i32 __builtin_msa_mulr_q_w (v4i32, v4i32);
13022 v16i8 __builtin_msa_mulv_b (v16i8, v16i8);
13023 v8i16 __builtin_msa_mulv_h (v8i16, v8i16);
13024 v4i32 __builtin_msa_mulv_w (v4i32, v4i32);
13025 v2i64 __builtin_msa_mulv_d (v2i64, v2i64);
13027 v16i8 __builtin_msa_nloc_b (v16i8);
13028 v8i16 __builtin_msa_nloc_h (v8i16);
13029 v4i32 __builtin_msa_nloc_w (v4i32);
13030 v2i64 __builtin_msa_nloc_d (v2i64);
13032 v16i8 __builtin_msa_nlzc_b (v16i8);
13033 v8i16 __builtin_msa_nlzc_h (v8i16);
13034 v4i32 __builtin_msa_nlzc_w (v4i32);
13035 v2i64 __builtin_msa_nlzc_d (v2i64);
13037 v16u8 __builtin_msa_nor_v (v16u8, v16u8);
13039 v16u8 __builtin_msa_nori_b (v16u8, imm0_255);
13041 v16u8 __builtin_msa_or_v (v16u8, v16u8);
13043 v16u8 __builtin_msa_ori_b (v16u8, imm0_255);
13045 v16i8 __builtin_msa_pckev_b (v16i8, v16i8);
13046 v8i16 __builtin_msa_pckev_h (v8i16, v8i16);
13047 v4i32 __builtin_msa_pckev_w (v4i32, v4i32);
13048 v2i64 __builtin_msa_pckev_d (v2i64, v2i64);
13050 v16i8 __builtin_msa_pckod_b (v16i8, v16i8);
13051 v8i16 __builtin_msa_pckod_h (v8i16, v8i16);
13052 v4i32 __builtin_msa_pckod_w (v4i32, v4i32);
13053 v2i64 __builtin_msa_pckod_d (v2i64, v2i64);
13055 v16i8 __builtin_msa_pcnt_b (v16i8);
13056 v8i16 __builtin_msa_pcnt_h (v8i16);
13057 v4i32 __builtin_msa_pcnt_w (v4i32);
13058 v2i64 __builtin_msa_pcnt_d (v2i64);
13060 v16i8 __builtin_msa_sat_s_b (v16i8, imm0_7);
13061 v8i16 __builtin_msa_sat_s_h (v8i16, imm0_15);
13062 v4i32 __builtin_msa_sat_s_w (v4i32, imm0_31);
13063 v2i64 __builtin_msa_sat_s_d (v2i64, imm0_63);
13065 v16u8 __builtin_msa_sat_u_b (v16u8, imm0_7);
13066 v8u16 __builtin_msa_sat_u_h (v8u16, imm0_15);
13067 v4u32 __builtin_msa_sat_u_w (v4u32, imm0_31);
13068 v2u64 __builtin_msa_sat_u_d (v2u64, imm0_63);
13070 v16i8 __builtin_msa_shf_b (v16i8, imm0_255);
13072 v8i16 __builtin_msa_shf_h (v8i16, imm0_255);
13074 v4i32 __builtin_msa_shf_w (v4i32, imm0_255);
13076 v16i8 __builtin_msa_sld_b (v16i8, v16i8, i32);
13077 v8i16 __builtin_msa_sld_h (v8i16, v8i16, i32);
13078 v4i32 __builtin_msa_sld_w (v4i32, v4i32, i32);
13079 v2i64 __builtin_msa_sld_d (v2i64, v2i64, i32);
13081 v16i8 __builtin_msa_sldi_b (v16i8, v16i8, imm0_15);
13082 v8i16 __builtin_msa_sldi_h (v8i16, v8i16, imm0_7);
13083 v4i32 __builtin_msa_sldi_w (v4i32, v4i32, imm0_3);
13084 v2i64 __builtin_msa_sldi_d (v2i64, v2i64, imm0_1);
13086 v16i8 __builtin_msa_sll_b (v16i8, v16i8);
13087 v8i16 __builtin_msa_sll_h (v8i16, v8i16);
13088 v4i32 __builtin_msa_sll_w (v4i32, v4i32);
13089 v2i64 __builtin_msa_sll_d (v2i64, v2i64);
13091 v16i8 __builtin_msa_slli_b (v16i8, imm0_7);
13092 v8i16 __builtin_msa_slli_h (v8i16, imm0_15);
13093 v4i32 __builtin_msa_slli_w (v4i32, imm0_31);
13094 v2i64 __builtin_msa_slli_d (v2i64, imm0_63);
13096 v16i8 __builtin_msa_splat_b (v16i8, i32);
13097 v8i16 __builtin_msa_splat_h (v8i16, i32);
13098 v4i32 __builtin_msa_splat_w (v4i32, i32);
13099 v2i64 __builtin_msa_splat_d (v2i64, i32);
13101 v16i8 __builtin_msa_splati_b (v16i8, imm0_15);
13102 v8i16 __builtin_msa_splati_h (v8i16, imm0_7);
13103 v4i32 __builtin_msa_splati_w (v4i32, imm0_3);
13104 v2i64 __builtin_msa_splati_d (v2i64, imm0_1);
13106 v16i8 __builtin_msa_sra_b (v16i8, v16i8);
13107 v8i16 __builtin_msa_sra_h (v8i16, v8i16);
13108 v4i32 __builtin_msa_sra_w (v4i32, v4i32);
13109 v2i64 __builtin_msa_sra_d (v2i64, v2i64);
13111 v16i8 __builtin_msa_srai_b (v16i8, imm0_7);
13112 v8i16 __builtin_msa_srai_h (v8i16, imm0_15);
13113 v4i32 __builtin_msa_srai_w (v4i32, imm0_31);
13114 v2i64 __builtin_msa_srai_d (v2i64, imm0_63);
13116 v16i8 __builtin_msa_srar_b (v16i8, v16i8);
13117 v8i16 __builtin_msa_srar_h (v8i16, v8i16);
13118 v4i32 __builtin_msa_srar_w (v4i32, v4i32);
13119 v2i64 __builtin_msa_srar_d (v2i64, v2i64);
13121 v16i8 __builtin_msa_srari_b (v16i8, imm0_7);
13122 v8i16 __builtin_msa_srari_h (v8i16, imm0_15);
13123 v4i32 __builtin_msa_srari_w (v4i32, imm0_31);
13124 v2i64 __builtin_msa_srari_d (v2i64, imm0_63);
13126 v16i8 __builtin_msa_srl_b (v16i8, v16i8);
13127 v8i16 __builtin_msa_srl_h (v8i16, v8i16);
13128 v4i32 __builtin_msa_srl_w (v4i32, v4i32);
13129 v2i64 __builtin_msa_srl_d (v2i64, v2i64);
13131 v16i8 __builtin_msa_srli_b (v16i8, imm0_7);
13132 v8i16 __builtin_msa_srli_h (v8i16, imm0_15);
13133 v4i32 __builtin_msa_srli_w (v4i32, imm0_31);
13134 v2i64 __builtin_msa_srli_d (v2i64, imm0_63);
13136 v16i8 __builtin_msa_srlr_b (v16i8, v16i8);
13137 v8i16 __builtin_msa_srlr_h (v8i16, v8i16);
13138 v4i32 __builtin_msa_srlr_w (v4i32, v4i32);
13139 v2i64 __builtin_msa_srlr_d (v2i64, v2i64);
13141 v16i8 __builtin_msa_srlri_b (v16i8, imm0_7);
13142 v8i16 __builtin_msa_srlri_h (v8i16, imm0_15);
13143 v4i32 __builtin_msa_srlri_w (v4i32, imm0_31);
13144 v2i64 __builtin_msa_srlri_d (v2i64, imm0_63);
13146 void __builtin_msa_st_b (v16i8, void *, imm_n512_511);
13147 void __builtin_msa_st_h (v8i16, void *, imm_n1024_1022);
13148 void __builtin_msa_st_w (v4i32, void *, imm_n2048_2044);
13149 void __builtin_msa_st_d (v2i64, void *, imm_n4096_4088);
13151 v16i8 __builtin_msa_subs_s_b (v16i8, v16i8);
13152 v8i16 __builtin_msa_subs_s_h (v8i16, v8i16);
13153 v4i32 __builtin_msa_subs_s_w (v4i32, v4i32);
13154 v2i64 __builtin_msa_subs_s_d (v2i64, v2i64);
13156 v16u8 __builtin_msa_subs_u_b (v16u8, v16u8);
13157 v8u16 __builtin_msa_subs_u_h (v8u16, v8u16);
13158 v4u32 __builtin_msa_subs_u_w (v4u32, v4u32);
13159 v2u64 __builtin_msa_subs_u_d (v2u64, v2u64);
13161 v16u8 __builtin_msa_subsus_u_b (v16u8, v16i8);
13162 v8u16 __builtin_msa_subsus_u_h (v8u16, v8i16);
13163 v4u32 __builtin_msa_subsus_u_w (v4u32, v4i32);
13164 v2u64 __builtin_msa_subsus_u_d (v2u64, v2i64);
13166 v16i8 __builtin_msa_subsuu_s_b (v16u8, v16u8);
13167 v8i16 __builtin_msa_subsuu_s_h (v8u16, v8u16);
13168 v4i32 __builtin_msa_subsuu_s_w (v4u32, v4u32);
13169 v2i64 __builtin_msa_subsuu_s_d (v2u64, v2u64);
13171 v16i8 __builtin_msa_subv_b (v16i8, v16i8);
13172 v8i16 __builtin_msa_subv_h (v8i16, v8i16);
13173 v4i32 __builtin_msa_subv_w (v4i32, v4i32);
13174 v2i64 __builtin_msa_subv_d (v2i64, v2i64);
13176 v16i8 __builtin_msa_subvi_b (v16i8, imm0_31);
13177 v8i16 __builtin_msa_subvi_h (v8i16, imm0_31);
13178 v4i32 __builtin_msa_subvi_w (v4i32, imm0_31);
13179 v2i64 __builtin_msa_subvi_d (v2i64, imm0_31);
13181 v16i8 __builtin_msa_vshf_b (v16i8, v16i8, v16i8);
13182 v8i16 __builtin_msa_vshf_h (v8i16, v8i16, v8i16);
13183 v4i32 __builtin_msa_vshf_w (v4i32, v4i32, v4i32);
13184 v2i64 __builtin_msa_vshf_d (v2i64, v2i64, v2i64);
13186 v16u8 __builtin_msa_xor_v (v16u8, v16u8);
13188 v16u8 __builtin_msa_xori_b (v16u8, imm0_255);
13190 v4f32 __builtin_msa_cast_to_vector_float (f32);
13191 v2f64 __builtin_msa_cast_to_vector_double (f64);
13192 f32 __builtin_msa_cast_to_scalar_float (v4f32);
13193 f64 __builtin_msa_cast_to_scalar_double (v2f64);
13195 i32 __builtin_msa_lsa (i32, i32, imm1_4);
13196 i64 __builtin_msa_dlsa (i64, i64, imm1_4);
13197 @end smallexample
13199 @menu
13200 * Paired-Single Arithmetic::
13201 * Paired-Single Built-in Functions::
13202 * MIPS-3D Built-in Functions::
13203 @end menu
13205 @node Paired-Single Arithmetic
13206 @subsubsection Paired-Single Arithmetic
13208 The table below lists the @code{v2sf} operations for which hardware
13209 support exists.  @code{a}, @code{b} and @code{c} are @code{v2sf}
13210 values and @code{x} is an integral value.
13212 @multitable @columnfractions .50 .50
13213 @item C code @tab MIPS instruction
13214 @item @code{a + b} @tab @code{add.ps}
13215 @item @code{a - b} @tab @code{sub.ps}
13216 @item @code{-a} @tab @code{neg.ps}
13217 @item @code{a * b} @tab @code{mul.ps}
13218 @item @code{a * b + c} @tab @code{madd.ps}
13219 @item @code{a * b - c} @tab @code{msub.ps}
13220 @item @code{-(a * b + c)} @tab @code{nmadd.ps}
13221 @item @code{-(a * b - c)} @tab @code{nmsub.ps}
13222 @item @code{x ? a : b} @tab @code{movn.ps}/@code{movz.ps}
13223 @end multitable
13225 Note that the multiply-accumulate instructions can be disabled
13226 using the command-line option @code{-mno-fused-madd}.
13228 @node Paired-Single Built-in Functions
13229 @subsubsection Paired-Single Built-in Functions
13231 The following paired-single functions map directly to a particular
13232 MIPS instruction.  Please refer to the architecture specification
13233 for details on what each instruction does.
13235 @table @code
13236 @item v2sf __builtin_mips_pll_ps (v2sf, v2sf)
13237 Pair lower lower (@code{pll.ps}).
13239 @item v2sf __builtin_mips_pul_ps (v2sf, v2sf)
13240 Pair upper lower (@code{pul.ps}).
13242 @item v2sf __builtin_mips_plu_ps (v2sf, v2sf)
13243 Pair lower upper (@code{plu.ps}).
13245 @item v2sf __builtin_mips_puu_ps (v2sf, v2sf)
13246 Pair upper upper (@code{puu.ps}).
13248 @item v2sf __builtin_mips_cvt_ps_s (float, float)
13249 Convert pair to paired single (@code{cvt.ps.s}).
13251 @item float __builtin_mips_cvt_s_pl (v2sf)
13252 Convert pair lower to single (@code{cvt.s.pl}).
13254 @item float __builtin_mips_cvt_s_pu (v2sf)
13255 Convert pair upper to single (@code{cvt.s.pu}).
13257 @item v2sf __builtin_mips_abs_ps (v2sf)
13258 Absolute value (@code{abs.ps}).
13260 @item v2sf __builtin_mips_alnv_ps (v2sf, v2sf, int)
13261 Align variable (@code{alnv.ps}).
13263 @emph{Note:} The value of the third parameter must be 0 or 4
13264 modulo 8, otherwise the result is unpredictable.  Please read the
13265 instruction description for details.
13266 @end table
13268 The following multi-instruction functions are also available.
13269 In each case, @var{cond} can be any of the 16 floating-point conditions:
13270 @code{f}, @code{un}, @code{eq}, @code{ueq}, @code{olt}, @code{ult},
13271 @code{ole}, @code{ule}, @code{sf}, @code{ngle}, @code{seq}, @code{ngl},
13272 @code{lt}, @code{nge}, @code{le} or @code{ngt}.
13274 @table @code
13275 @item v2sf __builtin_mips_movt_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
13276 @itemx v2sf __builtin_mips_movf_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
13277 Conditional move based on floating-point comparison (@code{c.@var{cond}.ps},
13278 @code{movt.ps}/@code{movf.ps}).
13280 The @code{movt} functions return the value @var{x} computed by:
13282 @smallexample
13283 c.@var{cond}.ps @var{cc},@var{a},@var{b}
13284 mov.ps @var{x},@var{c}
13285 movt.ps @var{x},@var{d},@var{cc}
13286 @end smallexample
13288 The @code{movf} functions are similar but use @code{movf.ps} instead
13289 of @code{movt.ps}.
13291 @item int __builtin_mips_upper_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
13292 @itemx int __builtin_mips_lower_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
13293 Comparison of two paired-single values (@code{c.@var{cond}.ps},
13294 @code{bc1t}/@code{bc1f}).
13296 These functions compare @var{a} and @var{b} using @code{c.@var{cond}.ps}
13297 and return either the upper or lower half of the result.  For example:
13299 @smallexample
13300 v2sf a, b;
13301 if (__builtin_mips_upper_c_eq_ps (a, b))
13302   upper_halves_are_equal ();
13303 else
13304   upper_halves_are_unequal ();
13306 if (__builtin_mips_lower_c_eq_ps (a, b))
13307   lower_halves_are_equal ();
13308 else
13309   lower_halves_are_unequal ();
13310 @end smallexample
13311 @end table
13313 @node MIPS-3D Built-in Functions
13314 @subsubsection MIPS-3D Built-in Functions
13316 The MIPS-3D Application-Specific Extension (ASE) includes additional
13317 paired-single instructions that are designed to improve the performance
13318 of 3D graphics operations.  Support for these instructions is controlled
13319 by the @option{-mips3d} command-line option.
13321 The functions listed below map directly to a particular MIPS-3D
13322 instruction.  Please refer to the architecture specification for
13323 more details on what each instruction does.
13325 @table @code
13326 @item v2sf __builtin_mips_addr_ps (v2sf, v2sf)
13327 Reduction add (@code{addr.ps}).
13329 @item v2sf __builtin_mips_mulr_ps (v2sf, v2sf)
13330 Reduction multiply (@code{mulr.ps}).
13332 @item v2sf __builtin_mips_cvt_pw_ps (v2sf)
13333 Convert paired single to paired word (@code{cvt.pw.ps}).
13335 @item v2sf __builtin_mips_cvt_ps_pw (v2sf)
13336 Convert paired word to paired single (@code{cvt.ps.pw}).
13338 @item float __builtin_mips_recip1_s (float)
13339 @itemx double __builtin_mips_recip1_d (double)
13340 @itemx v2sf __builtin_mips_recip1_ps (v2sf)
13341 Reduced-precision reciprocal (sequence step 1) (@code{recip1.@var{fmt}}).
13343 @item float __builtin_mips_recip2_s (float, float)
13344 @itemx double __builtin_mips_recip2_d (double, double)
13345 @itemx v2sf __builtin_mips_recip2_ps (v2sf, v2sf)
13346 Reduced-precision reciprocal (sequence step 2) (@code{recip2.@var{fmt}}).
13348 @item float __builtin_mips_rsqrt1_s (float)
13349 @itemx double __builtin_mips_rsqrt1_d (double)
13350 @itemx v2sf __builtin_mips_rsqrt1_ps (v2sf)
13351 Reduced-precision reciprocal square root (sequence step 1)
13352 (@code{rsqrt1.@var{fmt}}).
13354 @item float __builtin_mips_rsqrt2_s (float, float)
13355 @itemx double __builtin_mips_rsqrt2_d (double, double)
13356 @itemx v2sf __builtin_mips_rsqrt2_ps (v2sf, v2sf)
13357 Reduced-precision reciprocal square root (sequence step 2)
13358 (@code{rsqrt2.@var{fmt}}).
13359 @end table
13361 The following multi-instruction functions are also available.
13362 In each case, @var{cond} can be any of the 16 floating-point conditions:
13363 @code{f}, @code{un}, @code{eq}, @code{ueq}, @code{olt}, @code{ult},
13364 @code{ole}, @code{ule}, @code{sf}, @code{ngle}, @code{seq},
13365 @code{ngl}, @code{lt}, @code{nge}, @code{le} or @code{ngt}.
13367 @table @code
13368 @item int __builtin_mips_cabs_@var{cond}_s (float @var{a}, float @var{b})
13369 @itemx int __builtin_mips_cabs_@var{cond}_d (double @var{a}, double @var{b})
13370 Absolute comparison of two scalar values (@code{cabs.@var{cond}.@var{fmt}},
13371 @code{bc1t}/@code{bc1f}).
13373 These functions compare @var{a} and @var{b} using @code{cabs.@var{cond}.s}
13374 or @code{cabs.@var{cond}.d} and return the result as a boolean value.
13375 For example:
13377 @smallexample
13378 float a, b;
13379 if (__builtin_mips_cabs_eq_s (a, b))
13380   true ();
13381 else
13382   false ();
13383 @end smallexample
13385 @item int __builtin_mips_upper_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
13386 @itemx int __builtin_mips_lower_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
13387 Absolute comparison of two paired-single values (@code{cabs.@var{cond}.ps},
13388 @code{bc1t}/@code{bc1f}).
13390 These functions compare @var{a} and @var{b} using @code{cabs.@var{cond}.ps}
13391 and return either the upper or lower half of the result.  For example:
13393 @smallexample
13394 v2sf a, b;
13395 if (__builtin_mips_upper_cabs_eq_ps (a, b))
13396   upper_halves_are_equal ();
13397 else
13398   upper_halves_are_unequal ();
13400 if (__builtin_mips_lower_cabs_eq_ps (a, b))
13401   lower_halves_are_equal ();
13402 else
13403   lower_halves_are_unequal ();
13404 @end smallexample
13406 @item v2sf __builtin_mips_movt_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
13407 @itemx v2sf __builtin_mips_movf_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
13408 Conditional move based on absolute comparison (@code{cabs.@var{cond}.ps},
13409 @code{movt.ps}/@code{movf.ps}).
13411 The @code{movt} functions return the value @var{x} computed by:
13413 @smallexample
13414 cabs.@var{cond}.ps @var{cc},@var{a},@var{b}
13415 mov.ps @var{x},@var{c}
13416 movt.ps @var{x},@var{d},@var{cc}
13417 @end smallexample
13419 The @code{movf} functions are similar but use @code{movf.ps} instead
13420 of @code{movt.ps}.
13422 @item int __builtin_mips_any_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
13423 @itemx int __builtin_mips_all_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
13424 @itemx int __builtin_mips_any_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
13425 @itemx int __builtin_mips_all_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
13426 Comparison of two paired-single values
13427 (@code{c.@var{cond}.ps}/@code{cabs.@var{cond}.ps},
13428 @code{bc1any2t}/@code{bc1any2f}).
13430 These functions compare @var{a} and @var{b} using @code{c.@var{cond}.ps}
13431 or @code{cabs.@var{cond}.ps}.  The @code{any} forms return true if either
13432 result is true and the @code{all} forms return true if both results are true.
13433 For example:
13435 @smallexample
13436 v2sf a, b;
13437 if (__builtin_mips_any_c_eq_ps (a, b))
13438   one_is_true ();
13439 else
13440   both_are_false ();
13442 if (__builtin_mips_all_c_eq_ps (a, b))
13443   both_are_true ();
13444 else
13445   one_is_false ();
13446 @end smallexample
13448 @item int __builtin_mips_any_c_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
13449 @itemx int __builtin_mips_all_c_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
13450 @itemx int __builtin_mips_any_cabs_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
13451 @itemx int __builtin_mips_all_cabs_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
13452 Comparison of four paired-single values
13453 (@code{c.@var{cond}.ps}/@code{cabs.@var{cond}.ps},
13454 @code{bc1any4t}/@code{bc1any4f}).
13456 These functions use @code{c.@var{cond}.ps} or @code{cabs.@var{cond}.ps}
13457 to compare @var{a} with @var{b} and to compare @var{c} with @var{d}.
13458 The @code{any} forms return true if any of the four results are true
13459 and the @code{all} forms return true if all four results are true.
13460 For example:
13462 @smallexample
13463 v2sf a, b, c, d;
13464 if (__builtin_mips_any_c_eq_4s (a, b, c, d))
13465   some_are_true ();
13466 else
13467   all_are_false ();
13469 if (__builtin_mips_all_c_eq_4s (a, b, c, d))
13470   all_are_true ();
13471 else
13472   some_are_false ();
13473 @end smallexample
13474 @end table
13476 @node Other MIPS Built-in Functions
13477 @subsection Other MIPS Built-in Functions
13479 GCC provides other MIPS-specific built-in functions:
13481 @table @code
13482 @item void __builtin_mips_cache (int @var{op}, const volatile void *@var{addr})
13483 Insert a @samp{cache} instruction with operands @var{op} and @var{addr}.
13484 GCC defines the preprocessor macro @code{___GCC_HAVE_BUILTIN_MIPS_CACHE}
13485 when this function is available.
13487 @item unsigned int __builtin_mips_get_fcsr (void)
13488 @itemx void __builtin_mips_set_fcsr (unsigned int @var{value})
13489 Get and set the contents of the floating-point control and status register
13490 (FPU control register 31).  These functions are only available in hard-float
13491 code but can be called in both MIPS16 and non-MIPS16 contexts.
13493 @code{__builtin_mips_set_fcsr} can be used to change any bit of the
13494 register except the condition codes, which GCC assumes are preserved.
13495 @end table
13497 @node MSP430 Built-in Functions
13498 @subsection MSP430 Built-in Functions
13500 GCC provides a couple of special builtin functions to aid in the
13501 writing of interrupt handlers in C.
13503 @table @code
13504 @item __bic_SR_register_on_exit (int @var{mask})
13505 This clears the indicated bits in the saved copy of the status register
13506 currently residing on the stack.  This only works inside interrupt
13507 handlers and the changes to the status register will only take affect
13508 once the handler returns.
13510 @item __bis_SR_register_on_exit (int @var{mask})
13511 This sets the indicated bits in the saved copy of the status register
13512 currently residing on the stack.  This only works inside interrupt
13513 handlers and the changes to the status register will only take affect
13514 once the handler returns.
13515 @end table
13517 @node NDS32 Built-in Functions
13518 @subsection NDS32 Built-in Functions
13520 These built-in functions are available for the NDS32 target:
13522 @deftypefn {Built-in Function} void __builtin_nds32_isync (int *@var{addr})
13523 Insert an ISYNC instruction into the instruction stream where
13524 @var{addr} is an instruction address for serialization.
13525 @end deftypefn
13527 @deftypefn {Built-in Function} void __builtin_nds32_isb (void)
13528 Insert an ISB instruction into the instruction stream.
13529 @end deftypefn
13531 @deftypefn {Built-in Function} int __builtin_nds32_mfsr (int @var{sr})
13532 Return the content of a system register which is mapped by @var{sr}.
13533 @end deftypefn
13535 @deftypefn {Built-in Function} int __builtin_nds32_mfusr (int @var{usr})
13536 Return the content of a user space register which is mapped by @var{usr}.
13537 @end deftypefn
13539 @deftypefn {Built-in Function} void __builtin_nds32_mtsr (int @var{value}, int @var{sr})
13540 Move the @var{value} to a system register which is mapped by @var{sr}.
13541 @end deftypefn
13543 @deftypefn {Built-in Function} void __builtin_nds32_mtusr (int @var{value}, int @var{usr})
13544 Move the @var{value} to a user space register which is mapped by @var{usr}.
13545 @end deftypefn
13547 @deftypefn {Built-in Function} void __builtin_nds32_setgie_en (void)
13548 Enable global interrupt.
13549 @end deftypefn
13551 @deftypefn {Built-in Function} void __builtin_nds32_setgie_dis (void)
13552 Disable global interrupt.
13553 @end deftypefn
13555 @node picoChip Built-in Functions
13556 @subsection picoChip Built-in Functions
13558 GCC provides an interface to selected machine instructions from the
13559 picoChip instruction set.
13561 @table @code
13562 @item int __builtin_sbc (int @var{value})
13563 Sign bit count.  Return the number of consecutive bits in @var{value}
13564 that have the same value as the sign bit.  The result is the number of
13565 leading sign bits minus one, giving the number of redundant sign bits in
13566 @var{value}.
13568 @item int __builtin_byteswap (int @var{value})
13569 Byte swap.  Return the result of swapping the upper and lower bytes of
13570 @var{value}.
13572 @item int __builtin_brev (int @var{value})
13573 Bit reversal.  Return the result of reversing the bits in
13574 @var{value}.  Bit 15 is swapped with bit 0, bit 14 is swapped with bit 1,
13575 and so on.
13577 @item int __builtin_adds (int @var{x}, int @var{y})
13578 Saturating addition.  Return the result of adding @var{x} and @var{y},
13579 storing the value 32767 if the result overflows.
13581 @item int __builtin_subs (int @var{x}, int @var{y})
13582 Saturating subtraction.  Return the result of subtracting @var{y} from
13583 @var{x}, storing the value @minus{}32768 if the result overflows.
13585 @item void __builtin_halt (void)
13586 Halt.  The processor stops execution.  This built-in is useful for
13587 implementing assertions.
13589 @end table
13591 @node PowerPC Built-in Functions
13592 @subsection PowerPC Built-in Functions
13594 These built-in functions are available for the PowerPC family of
13595 processors:
13596 @smallexample
13597 float __builtin_recipdivf (float, float);
13598 float __builtin_rsqrtf (float);
13599 double __builtin_recipdiv (double, double);
13600 double __builtin_rsqrt (double);
13601 uint64_t __builtin_ppc_get_timebase ();
13602 unsigned long __builtin_ppc_mftb ();
13603 double __builtin_unpack_longdouble (long double, int);
13604 long double __builtin_pack_longdouble (double, double);
13605 @end smallexample
13607 The @code{vec_rsqrt}, @code{__builtin_rsqrt}, and
13608 @code{__builtin_rsqrtf} functions generate multiple instructions to
13609 implement the reciprocal sqrt functionality using reciprocal sqrt
13610 estimate instructions.
13612 The @code{__builtin_recipdiv}, and @code{__builtin_recipdivf}
13613 functions generate multiple instructions to implement division using
13614 the reciprocal estimate instructions.
13616 The @code{__builtin_ppc_get_timebase} and @code{__builtin_ppc_mftb}
13617 functions generate instructions to read the Time Base Register.  The
13618 @code{__builtin_ppc_get_timebase} function may generate multiple
13619 instructions and always returns the 64 bits of the Time Base Register.
13620 The @code{__builtin_ppc_mftb} function always generates one instruction and
13621 returns the Time Base Register value as an unsigned long, throwing away
13622 the most significant word on 32-bit environments.
13624 The following built-in functions are available for the PowerPC family
13625 of processors, starting with ISA 2.06 or later (@option{-mcpu=power7}
13626 or @option{-mpopcntd}):
13627 @smallexample
13628 long __builtin_bpermd (long, long);
13629 int __builtin_divwe (int, int);
13630 int __builtin_divweo (int, int);
13631 unsigned int __builtin_divweu (unsigned int, unsigned int);
13632 unsigned int __builtin_divweuo (unsigned int, unsigned int);
13633 long __builtin_divde (long, long);
13634 long __builtin_divdeo (long, long);
13635 unsigned long __builtin_divdeu (unsigned long, unsigned long);
13636 unsigned long __builtin_divdeuo (unsigned long, unsigned long);
13637 unsigned int cdtbcd (unsigned int);
13638 unsigned int cbcdtd (unsigned int);
13639 unsigned int addg6s (unsigned int, unsigned int);
13640 @end smallexample
13642 The @code{__builtin_divde}, @code{__builtin_divdeo},
13643 @code{__builitin_divdeu}, @code{__builtin_divdeou} functions require a
13644 64-bit environment support ISA 2.06 or later.
13646 The following built-in functions are available for the PowerPC family
13647 of processors when hardware decimal floating point
13648 (@option{-mhard-dfp}) is available:
13649 @smallexample
13650 _Decimal64 __builtin_dxex (_Decimal64);
13651 _Decimal128 __builtin_dxexq (_Decimal128);
13652 _Decimal64 __builtin_ddedpd (int, _Decimal64);
13653 _Decimal128 __builtin_ddedpdq (int, _Decimal128);
13654 _Decimal64 __builtin_denbcd (int, _Decimal64);
13655 _Decimal128 __builtin_denbcdq (int, _Decimal128);
13656 _Decimal64 __builtin_diex (_Decimal64, _Decimal64);
13657 _Decimal128 _builtin_diexq (_Decimal128, _Decimal128);
13658 _Decimal64 __builtin_dscli (_Decimal64, int);
13659 _Decimal128 __builitn_dscliq (_Decimal128, int);
13660 _Decimal64 __builtin_dscri (_Decimal64, int);
13661 _Decimal128 __builitn_dscriq (_Decimal128, int);
13662 unsigned long long __builtin_unpack_dec128 (_Decimal128, int);
13663 _Decimal128 __builtin_pack_dec128 (unsigned long long, unsigned long long);
13664 @end smallexample
13666 The following built-in functions are available for the PowerPC family
13667 of processors when the Vector Scalar (vsx) instruction set is
13668 available:
13669 @smallexample
13670 unsigned long long __builtin_unpack_vector_int128 (vector __int128_t, int);
13671 vector __int128_t __builtin_pack_vector_int128 (unsigned long long,
13672                                                 unsigned long long);
13673 @end smallexample
13675 @node PowerPC AltiVec/VSX Built-in Functions
13676 @subsection PowerPC AltiVec Built-in Functions
13678 GCC provides an interface for the PowerPC family of processors to access
13679 the AltiVec operations described in Motorola's AltiVec Programming
13680 Interface Manual.  The interface is made available by including
13681 @code{<altivec.h>} and using @option{-maltivec} and
13682 @option{-mabi=altivec}.  The interface supports the following vector
13683 types.
13685 @smallexample
13686 vector unsigned char
13687 vector signed char
13688 vector bool char
13690 vector unsigned short
13691 vector signed short
13692 vector bool short
13693 vector pixel
13695 vector unsigned int
13696 vector signed int
13697 vector bool int
13698 vector float
13699 @end smallexample
13701 If @option{-mvsx} is used the following additional vector types are
13702 implemented.
13704 @smallexample
13705 vector unsigned long
13706 vector signed long
13707 vector double
13708 @end smallexample
13710 The long types are only implemented for 64-bit code generation, and
13711 the long type is only used in the floating point/integer conversion
13712 instructions.
13714 GCC's implementation of the high-level language interface available from
13715 C and C++ code differs from Motorola's documentation in several ways.
13717 @itemize @bullet
13719 @item
13720 A vector constant is a list of constant expressions within curly braces.
13722 @item
13723 A vector initializer requires no cast if the vector constant is of the
13724 same type as the variable it is initializing.
13726 @item
13727 If @code{signed} or @code{unsigned} is omitted, the signedness of the
13728 vector type is the default signedness of the base type.  The default
13729 varies depending on the operating system, so a portable program should
13730 always specify the signedness.
13732 @item
13733 Compiling with @option{-maltivec} adds keywords @code{__vector},
13734 @code{vector}, @code{__pixel}, @code{pixel}, @code{__bool} and
13735 @code{bool}.  When compiling ISO C, the context-sensitive substitution
13736 of the keywords @code{vector}, @code{pixel} and @code{bool} is
13737 disabled.  To use them, you must include @code{<altivec.h>} instead.
13739 @item
13740 GCC allows using a @code{typedef} name as the type specifier for a
13741 vector type.
13743 @item
13744 For C, overloaded functions are implemented with macros so the following
13745 does not work:
13747 @smallexample
13748   vec_add ((vector signed int)@{1, 2, 3, 4@}, foo);
13749 @end smallexample
13751 @noindent
13752 Since @code{vec_add} is a macro, the vector constant in the example
13753 is treated as four separate arguments.  Wrap the entire argument in
13754 parentheses for this to work.
13755 @end itemize
13757 @emph{Note:} Only the @code{<altivec.h>} interface is supported.
13758 Internally, GCC uses built-in functions to achieve the functionality in
13759 the aforementioned header file, but they are not supported and are
13760 subject to change without notice.
13762 The following interfaces are supported for the generic and specific
13763 AltiVec operations and the AltiVec predicates.  In cases where there
13764 is a direct mapping between generic and specific operations, only the
13765 generic names are shown here, although the specific operations can also
13766 be used.
13768 Arguments that are documented as @code{const int} require literal
13769 integral values within the range required for that operation.
13771 @smallexample
13772 vector signed char vec_abs (vector signed char);
13773 vector signed short vec_abs (vector signed short);
13774 vector signed int vec_abs (vector signed int);
13775 vector float vec_abs (vector float);
13777 vector signed char vec_abss (vector signed char);
13778 vector signed short vec_abss (vector signed short);
13779 vector signed int vec_abss (vector signed int);
13781 vector signed char vec_add (vector bool char, vector signed char);
13782 vector signed char vec_add (vector signed char, vector bool char);
13783 vector signed char vec_add (vector signed char, vector signed char);
13784 vector unsigned char vec_add (vector bool char, vector unsigned char);
13785 vector unsigned char vec_add (vector unsigned char, vector bool char);
13786 vector unsigned char vec_add (vector unsigned char,
13787                               vector unsigned char);
13788 vector signed short vec_add (vector bool short, vector signed short);
13789 vector signed short vec_add (vector signed short, vector bool short);
13790 vector signed short vec_add (vector signed short, vector signed short);
13791 vector unsigned short vec_add (vector bool short,
13792                                vector unsigned short);
13793 vector unsigned short vec_add (vector unsigned short,
13794                                vector bool short);
13795 vector unsigned short vec_add (vector unsigned short,
13796                                vector unsigned short);
13797 vector signed int vec_add (vector bool int, vector signed int);
13798 vector signed int vec_add (vector signed int, vector bool int);
13799 vector signed int vec_add (vector signed int, vector signed int);
13800 vector unsigned int vec_add (vector bool int, vector unsigned int);
13801 vector unsigned int vec_add (vector unsigned int, vector bool int);
13802 vector unsigned int vec_add (vector unsigned int, vector unsigned int);
13803 vector float vec_add (vector float, vector float);
13805 vector float vec_vaddfp (vector float, vector float);
13807 vector signed int vec_vadduwm (vector bool int, vector signed int);
13808 vector signed int vec_vadduwm (vector signed int, vector bool int);
13809 vector signed int vec_vadduwm (vector signed int, vector signed int);
13810 vector unsigned int vec_vadduwm (vector bool int, vector unsigned int);
13811 vector unsigned int vec_vadduwm (vector unsigned int, vector bool int);
13812 vector unsigned int vec_vadduwm (vector unsigned int,
13813                                  vector unsigned int);
13815 vector signed short vec_vadduhm (vector bool short,
13816                                  vector signed short);
13817 vector signed short vec_vadduhm (vector signed short,
13818                                  vector bool short);
13819 vector signed short vec_vadduhm (vector signed short,
13820                                  vector signed short);
13821 vector unsigned short vec_vadduhm (vector bool short,
13822                                    vector unsigned short);
13823 vector unsigned short vec_vadduhm (vector unsigned short,
13824                                    vector bool short);
13825 vector unsigned short vec_vadduhm (vector unsigned short,
13826                                    vector unsigned short);
13828 vector signed char vec_vaddubm (vector bool char, vector signed char);
13829 vector signed char vec_vaddubm (vector signed char, vector bool char);
13830 vector signed char vec_vaddubm (vector signed char, vector signed char);
13831 vector unsigned char vec_vaddubm (vector bool char,
13832                                   vector unsigned char);
13833 vector unsigned char vec_vaddubm (vector unsigned char,
13834                                   vector bool char);
13835 vector unsigned char vec_vaddubm (vector unsigned char,
13836                                   vector unsigned char);
13838 vector unsigned int vec_addc (vector unsigned int, vector unsigned int);
13840 vector unsigned char vec_adds (vector bool char, vector unsigned char);
13841 vector unsigned char vec_adds (vector unsigned char, vector bool char);
13842 vector unsigned char vec_adds (vector unsigned char,
13843                                vector unsigned char);
13844 vector signed char vec_adds (vector bool char, vector signed char);
13845 vector signed char vec_adds (vector signed char, vector bool char);
13846 vector signed char vec_adds (vector signed char, vector signed char);
13847 vector unsigned short vec_adds (vector bool short,
13848                                 vector unsigned short);
13849 vector unsigned short vec_adds (vector unsigned short,
13850                                 vector bool short);
13851 vector unsigned short vec_adds (vector unsigned short,
13852                                 vector unsigned short);
13853 vector signed short vec_adds (vector bool short, vector signed short);
13854 vector signed short vec_adds (vector signed short, vector bool short);
13855 vector signed short vec_adds (vector signed short, vector signed short);
13856 vector unsigned int vec_adds (vector bool int, vector unsigned int);
13857 vector unsigned int vec_adds (vector unsigned int, vector bool int);
13858 vector unsigned int vec_adds (vector unsigned int, vector unsigned int);
13859 vector signed int vec_adds (vector bool int, vector signed int);
13860 vector signed int vec_adds (vector signed int, vector bool int);
13861 vector signed int vec_adds (vector signed int, vector signed int);
13863 vector signed int vec_vaddsws (vector bool int, vector signed int);
13864 vector signed int vec_vaddsws (vector signed int, vector bool int);
13865 vector signed int vec_vaddsws (vector signed int, vector signed int);
13867 vector unsigned int vec_vadduws (vector bool int, vector unsigned int);
13868 vector unsigned int vec_vadduws (vector unsigned int, vector bool int);
13869 vector unsigned int vec_vadduws (vector unsigned int,
13870                                  vector unsigned int);
13872 vector signed short vec_vaddshs (vector bool short,
13873                                  vector signed short);
13874 vector signed short vec_vaddshs (vector signed short,
13875                                  vector bool short);
13876 vector signed short vec_vaddshs (vector signed short,
13877                                  vector signed short);
13879 vector unsigned short vec_vadduhs (vector bool short,
13880                                    vector unsigned short);
13881 vector unsigned short vec_vadduhs (vector unsigned short,
13882                                    vector bool short);
13883 vector unsigned short vec_vadduhs (vector unsigned short,
13884                                    vector unsigned short);
13886 vector signed char vec_vaddsbs (vector bool char, vector signed char);
13887 vector signed char vec_vaddsbs (vector signed char, vector bool char);
13888 vector signed char vec_vaddsbs (vector signed char, vector signed char);
13890 vector unsigned char vec_vaddubs (vector bool char,
13891                                   vector unsigned char);
13892 vector unsigned char vec_vaddubs (vector unsigned char,
13893                                   vector bool char);
13894 vector unsigned char vec_vaddubs (vector unsigned char,
13895                                   vector unsigned char);
13897 vector float vec_and (vector float, vector float);
13898 vector float vec_and (vector float, vector bool int);
13899 vector float vec_and (vector bool int, vector float);
13900 vector bool int vec_and (vector bool int, vector bool int);
13901 vector signed int vec_and (vector bool int, vector signed int);
13902 vector signed int vec_and (vector signed int, vector bool int);
13903 vector signed int vec_and (vector signed int, vector signed int);
13904 vector unsigned int vec_and (vector bool int, vector unsigned int);
13905 vector unsigned int vec_and (vector unsigned int, vector bool int);
13906 vector unsigned int vec_and (vector unsigned int, vector unsigned int);
13907 vector bool short vec_and (vector bool short, vector bool short);
13908 vector signed short vec_and (vector bool short, vector signed short);
13909 vector signed short vec_and (vector signed short, vector bool short);
13910 vector signed short vec_and (vector signed short, vector signed short);
13911 vector unsigned short vec_and (vector bool short,
13912                                vector unsigned short);
13913 vector unsigned short vec_and (vector unsigned short,
13914                                vector bool short);
13915 vector unsigned short vec_and (vector unsigned short,
13916                                vector unsigned short);
13917 vector signed char vec_and (vector bool char, vector signed char);
13918 vector bool char vec_and (vector bool char, vector bool char);
13919 vector signed char vec_and (vector signed char, vector bool char);
13920 vector signed char vec_and (vector signed char, vector signed char);
13921 vector unsigned char vec_and (vector bool char, vector unsigned char);
13922 vector unsigned char vec_and (vector unsigned char, vector bool char);
13923 vector unsigned char vec_and (vector unsigned char,
13924                               vector unsigned char);
13926 vector float vec_andc (vector float, vector float);
13927 vector float vec_andc (vector float, vector bool int);
13928 vector float vec_andc (vector bool int, vector float);
13929 vector bool int vec_andc (vector bool int, vector bool int);
13930 vector signed int vec_andc (vector bool int, vector signed int);
13931 vector signed int vec_andc (vector signed int, vector bool int);
13932 vector signed int vec_andc (vector signed int, vector signed int);
13933 vector unsigned int vec_andc (vector bool int, vector unsigned int);
13934 vector unsigned int vec_andc (vector unsigned int, vector bool int);
13935 vector unsigned int vec_andc (vector unsigned int, vector unsigned int);
13936 vector bool short vec_andc (vector bool short, vector bool short);
13937 vector signed short vec_andc (vector bool short, vector signed short);
13938 vector signed short vec_andc (vector signed short, vector bool short);
13939 vector signed short vec_andc (vector signed short, vector signed short);
13940 vector unsigned short vec_andc (vector bool short,
13941                                 vector unsigned short);
13942 vector unsigned short vec_andc (vector unsigned short,
13943                                 vector bool short);
13944 vector unsigned short vec_andc (vector unsigned short,
13945                                 vector unsigned short);
13946 vector signed char vec_andc (vector bool char, vector signed char);
13947 vector bool char vec_andc (vector bool char, vector bool char);
13948 vector signed char vec_andc (vector signed char, vector bool char);
13949 vector signed char vec_andc (vector signed char, vector signed char);
13950 vector unsigned char vec_andc (vector bool char, vector unsigned char);
13951 vector unsigned char vec_andc (vector unsigned char, vector bool char);
13952 vector unsigned char vec_andc (vector unsigned char,
13953                                vector unsigned char);
13955 vector unsigned char vec_avg (vector unsigned char,
13956                               vector unsigned char);
13957 vector signed char vec_avg (vector signed char, vector signed char);
13958 vector unsigned short vec_avg (vector unsigned short,
13959                                vector unsigned short);
13960 vector signed short vec_avg (vector signed short, vector signed short);
13961 vector unsigned int vec_avg (vector unsigned int, vector unsigned int);
13962 vector signed int vec_avg (vector signed int, vector signed int);
13964 vector signed int vec_vavgsw (vector signed int, vector signed int);
13966 vector unsigned int vec_vavguw (vector unsigned int,
13967                                 vector unsigned int);
13969 vector signed short vec_vavgsh (vector signed short,
13970                                 vector signed short);
13972 vector unsigned short vec_vavguh (vector unsigned short,
13973                                   vector unsigned short);
13975 vector signed char vec_vavgsb (vector signed char, vector signed char);
13977 vector unsigned char vec_vavgub (vector unsigned char,
13978                                  vector unsigned char);
13980 vector float vec_copysign (vector float);
13982 vector float vec_ceil (vector float);
13984 vector signed int vec_cmpb (vector float, vector float);
13986 vector bool char vec_cmpeq (vector signed char, vector signed char);
13987 vector bool char vec_cmpeq (vector unsigned char, vector unsigned char);
13988 vector bool short vec_cmpeq (vector signed short, vector signed short);
13989 vector bool short vec_cmpeq (vector unsigned short,
13990                              vector unsigned short);
13991 vector bool int vec_cmpeq (vector signed int, vector signed int);
13992 vector bool int vec_cmpeq (vector unsigned int, vector unsigned int);
13993 vector bool int vec_cmpeq (vector float, vector float);
13995 vector bool int vec_vcmpeqfp (vector float, vector float);
13997 vector bool int vec_vcmpequw (vector signed int, vector signed int);
13998 vector bool int vec_vcmpequw (vector unsigned int, vector unsigned int);
14000 vector bool short vec_vcmpequh (vector signed short,
14001                                 vector signed short);
14002 vector bool short vec_vcmpequh (vector unsigned short,
14003                                 vector unsigned short);
14005 vector bool char vec_vcmpequb (vector signed char, vector signed char);
14006 vector bool char vec_vcmpequb (vector unsigned char,
14007                                vector unsigned char);
14009 vector bool int vec_cmpge (vector float, vector float);
14011 vector bool char vec_cmpgt (vector unsigned char, vector unsigned char);
14012 vector bool char vec_cmpgt (vector signed char, vector signed char);
14013 vector bool short vec_cmpgt (vector unsigned short,
14014                              vector unsigned short);
14015 vector bool short vec_cmpgt (vector signed short, vector signed short);
14016 vector bool int vec_cmpgt (vector unsigned int, vector unsigned int);
14017 vector bool int vec_cmpgt (vector signed int, vector signed int);
14018 vector bool int vec_cmpgt (vector float, vector float);
14020 vector bool int vec_vcmpgtfp (vector float, vector float);
14022 vector bool int vec_vcmpgtsw (vector signed int, vector signed int);
14024 vector bool int vec_vcmpgtuw (vector unsigned int, vector unsigned int);
14026 vector bool short vec_vcmpgtsh (vector signed short,
14027                                 vector signed short);
14029 vector bool short vec_vcmpgtuh (vector unsigned short,
14030                                 vector unsigned short);
14032 vector bool char vec_vcmpgtsb (vector signed char, vector signed char);
14034 vector bool char vec_vcmpgtub (vector unsigned char,
14035                                vector unsigned char);
14037 vector bool int vec_cmple (vector float, vector float);
14039 vector bool char vec_cmplt (vector unsigned char, vector unsigned char);
14040 vector bool char vec_cmplt (vector signed char, vector signed char);
14041 vector bool short vec_cmplt (vector unsigned short,
14042                              vector unsigned short);
14043 vector bool short vec_cmplt (vector signed short, vector signed short);
14044 vector bool int vec_cmplt (vector unsigned int, vector unsigned int);
14045 vector bool int vec_cmplt (vector signed int, vector signed int);
14046 vector bool int vec_cmplt (vector float, vector float);
14048 vector float vec_cpsgn (vector float, vector float);
14050 vector float vec_ctf (vector unsigned int, const int);
14051 vector float vec_ctf (vector signed int, const int);
14052 vector double vec_ctf (vector unsigned long, const int);
14053 vector double vec_ctf (vector signed long, const int);
14055 vector float vec_vcfsx (vector signed int, const int);
14057 vector float vec_vcfux (vector unsigned int, const int);
14059 vector signed int vec_cts (vector float, const int);
14060 vector signed long vec_cts (vector double, const int);
14062 vector unsigned int vec_ctu (vector float, const int);
14063 vector unsigned long vec_ctu (vector double, const int);
14065 void vec_dss (const int);
14067 void vec_dssall (void);
14069 void vec_dst (const vector unsigned char *, int, const int);
14070 void vec_dst (const vector signed char *, int, const int);
14071 void vec_dst (const vector bool char *, int, const int);
14072 void vec_dst (const vector unsigned short *, int, const int);
14073 void vec_dst (const vector signed short *, int, const int);
14074 void vec_dst (const vector bool short *, int, const int);
14075 void vec_dst (const vector pixel *, int, const int);
14076 void vec_dst (const vector unsigned int *, int, const int);
14077 void vec_dst (const vector signed int *, int, const int);
14078 void vec_dst (const vector bool int *, int, const int);
14079 void vec_dst (const vector float *, int, const int);
14080 void vec_dst (const unsigned char *, int, const int);
14081 void vec_dst (const signed char *, int, const int);
14082 void vec_dst (const unsigned short *, int, const int);
14083 void vec_dst (const short *, int, const int);
14084 void vec_dst (const unsigned int *, int, const int);
14085 void vec_dst (const int *, int, const int);
14086 void vec_dst (const unsigned long *, int, const int);
14087 void vec_dst (const long *, int, const int);
14088 void vec_dst (const float *, int, const int);
14090 void vec_dstst (const vector unsigned char *, int, const int);
14091 void vec_dstst (const vector signed char *, int, const int);
14092 void vec_dstst (const vector bool char *, int, const int);
14093 void vec_dstst (const vector unsigned short *, int, const int);
14094 void vec_dstst (const vector signed short *, int, const int);
14095 void vec_dstst (const vector bool short *, int, const int);
14096 void vec_dstst (const vector pixel *, int, const int);
14097 void vec_dstst (const vector unsigned int *, int, const int);
14098 void vec_dstst (const vector signed int *, int, const int);
14099 void vec_dstst (const vector bool int *, int, const int);
14100 void vec_dstst (const vector float *, int, const int);
14101 void vec_dstst (const unsigned char *, int, const int);
14102 void vec_dstst (const signed char *, int, const int);
14103 void vec_dstst (const unsigned short *, int, const int);
14104 void vec_dstst (const short *, int, const int);
14105 void vec_dstst (const unsigned int *, int, const int);
14106 void vec_dstst (const int *, int, const int);
14107 void vec_dstst (const unsigned long *, int, const int);
14108 void vec_dstst (const long *, int, const int);
14109 void vec_dstst (const float *, int, const int);
14111 void vec_dststt (const vector unsigned char *, int, const int);
14112 void vec_dststt (const vector signed char *, int, const int);
14113 void vec_dststt (const vector bool char *, int, const int);
14114 void vec_dststt (const vector unsigned short *, int, const int);
14115 void vec_dststt (const vector signed short *, int, const int);
14116 void vec_dststt (const vector bool short *, int, const int);
14117 void vec_dststt (const vector pixel *, int, const int);
14118 void vec_dststt (const vector unsigned int *, int, const int);
14119 void vec_dststt (const vector signed int *, int, const int);
14120 void vec_dststt (const vector bool int *, int, const int);
14121 void vec_dststt (const vector float *, int, const int);
14122 void vec_dststt (const unsigned char *, int, const int);
14123 void vec_dststt (const signed char *, int, const int);
14124 void vec_dststt (const unsigned short *, int, const int);
14125 void vec_dststt (const short *, int, const int);
14126 void vec_dststt (const unsigned int *, int, const int);
14127 void vec_dststt (const int *, int, const int);
14128 void vec_dststt (const unsigned long *, int, const int);
14129 void vec_dststt (const long *, int, const int);
14130 void vec_dststt (const float *, int, const int);
14132 void vec_dstt (const vector unsigned char *, int, const int);
14133 void vec_dstt (const vector signed char *, int, const int);
14134 void vec_dstt (const vector bool char *, int, const int);
14135 void vec_dstt (const vector unsigned short *, int, const int);
14136 void vec_dstt (const vector signed short *, int, const int);
14137 void vec_dstt (const vector bool short *, int, const int);
14138 void vec_dstt (const vector pixel *, int, const int);
14139 void vec_dstt (const vector unsigned int *, int, const int);
14140 void vec_dstt (const vector signed int *, int, const int);
14141 void vec_dstt (const vector bool int *, int, const int);
14142 void vec_dstt (const vector float *, int, const int);
14143 void vec_dstt (const unsigned char *, int, const int);
14144 void vec_dstt (const signed char *, int, const int);
14145 void vec_dstt (const unsigned short *, int, const int);
14146 void vec_dstt (const short *, int, const int);
14147 void vec_dstt (const unsigned int *, int, const int);
14148 void vec_dstt (const int *, int, const int);
14149 void vec_dstt (const unsigned long *, int, const int);
14150 void vec_dstt (const long *, int, const int);
14151 void vec_dstt (const float *, int, const int);
14153 vector float vec_expte (vector float);
14155 vector float vec_floor (vector float);
14157 vector float vec_ld (int, const vector float *);
14158 vector float vec_ld (int, const float *);
14159 vector bool int vec_ld (int, const vector bool int *);
14160 vector signed int vec_ld (int, const vector signed int *);
14161 vector signed int vec_ld (int, const int *);
14162 vector signed int vec_ld (int, const long *);
14163 vector unsigned int vec_ld (int, const vector unsigned int *);
14164 vector unsigned int vec_ld (int, const unsigned int *);
14165 vector unsigned int vec_ld (int, const unsigned long *);
14166 vector bool short vec_ld (int, const vector bool short *);
14167 vector pixel vec_ld (int, const vector pixel *);
14168 vector signed short vec_ld (int, const vector signed short *);
14169 vector signed short vec_ld (int, const short *);
14170 vector unsigned short vec_ld (int, const vector unsigned short *);
14171 vector unsigned short vec_ld (int, const unsigned short *);
14172 vector bool char vec_ld (int, const vector bool char *);
14173 vector signed char vec_ld (int, const vector signed char *);
14174 vector signed char vec_ld (int, const signed char *);
14175 vector unsigned char vec_ld (int, const vector unsigned char *);
14176 vector unsigned char vec_ld (int, const unsigned char *);
14178 vector signed char vec_lde (int, const signed char *);
14179 vector unsigned char vec_lde (int, const unsigned char *);
14180 vector signed short vec_lde (int, const short *);
14181 vector unsigned short vec_lde (int, const unsigned short *);
14182 vector float vec_lde (int, const float *);
14183 vector signed int vec_lde (int, const int *);
14184 vector unsigned int vec_lde (int, const unsigned int *);
14185 vector signed int vec_lde (int, const long *);
14186 vector unsigned int vec_lde (int, const unsigned long *);
14188 vector float vec_lvewx (int, float *);
14189 vector signed int vec_lvewx (int, int *);
14190 vector unsigned int vec_lvewx (int, unsigned int *);
14191 vector signed int vec_lvewx (int, long *);
14192 vector unsigned int vec_lvewx (int, unsigned long *);
14194 vector signed short vec_lvehx (int, short *);
14195 vector unsigned short vec_lvehx (int, unsigned short *);
14197 vector signed char vec_lvebx (int, char *);
14198 vector unsigned char vec_lvebx (int, unsigned char *);
14200 vector float vec_ldl (int, const vector float *);
14201 vector float vec_ldl (int, const float *);
14202 vector bool int vec_ldl (int, const vector bool int *);
14203 vector signed int vec_ldl (int, const vector signed int *);
14204 vector signed int vec_ldl (int, const int *);
14205 vector signed int vec_ldl (int, const long *);
14206 vector unsigned int vec_ldl (int, const vector unsigned int *);
14207 vector unsigned int vec_ldl (int, const unsigned int *);
14208 vector unsigned int vec_ldl (int, const unsigned long *);
14209 vector bool short vec_ldl (int, const vector bool short *);
14210 vector pixel vec_ldl (int, const vector pixel *);
14211 vector signed short vec_ldl (int, const vector signed short *);
14212 vector signed short vec_ldl (int, const short *);
14213 vector unsigned short vec_ldl (int, const vector unsigned short *);
14214 vector unsigned short vec_ldl (int, const unsigned short *);
14215 vector bool char vec_ldl (int, const vector bool char *);
14216 vector signed char vec_ldl (int, const vector signed char *);
14217 vector signed char vec_ldl (int, const signed char *);
14218 vector unsigned char vec_ldl (int, const vector unsigned char *);
14219 vector unsigned char vec_ldl (int, const unsigned char *);
14221 vector float vec_loge (vector float);
14223 vector unsigned char vec_lvsl (int, const volatile unsigned char *);
14224 vector unsigned char vec_lvsl (int, const volatile signed char *);
14225 vector unsigned char vec_lvsl (int, const volatile unsigned short *);
14226 vector unsigned char vec_lvsl (int, const volatile short *);
14227 vector unsigned char vec_lvsl (int, const volatile unsigned int *);
14228 vector unsigned char vec_lvsl (int, const volatile int *);
14229 vector unsigned char vec_lvsl (int, const volatile unsigned long *);
14230 vector unsigned char vec_lvsl (int, const volatile long *);
14231 vector unsigned char vec_lvsl (int, const volatile float *);
14233 vector unsigned char vec_lvsr (int, const volatile unsigned char *);
14234 vector unsigned char vec_lvsr (int, const volatile signed char *);
14235 vector unsigned char vec_lvsr (int, const volatile unsigned short *);
14236 vector unsigned char vec_lvsr (int, const volatile short *);
14237 vector unsigned char vec_lvsr (int, const volatile unsigned int *);
14238 vector unsigned char vec_lvsr (int, const volatile int *);
14239 vector unsigned char vec_lvsr (int, const volatile unsigned long *);
14240 vector unsigned char vec_lvsr (int, const volatile long *);
14241 vector unsigned char vec_lvsr (int, const volatile float *);
14243 vector float vec_madd (vector float, vector float, vector float);
14245 vector signed short vec_madds (vector signed short,
14246                                vector signed short,
14247                                vector signed short);
14249 vector unsigned char vec_max (vector bool char, vector unsigned char);
14250 vector unsigned char vec_max (vector unsigned char, vector bool char);
14251 vector unsigned char vec_max (vector unsigned char,
14252                               vector unsigned char);
14253 vector signed char vec_max (vector bool char, vector signed char);
14254 vector signed char vec_max (vector signed char, vector bool char);
14255 vector signed char vec_max (vector signed char, vector signed char);
14256 vector unsigned short vec_max (vector bool short,
14257                                vector unsigned short);
14258 vector unsigned short vec_max (vector unsigned short,
14259                                vector bool short);
14260 vector unsigned short vec_max (vector unsigned short,
14261                                vector unsigned short);
14262 vector signed short vec_max (vector bool short, vector signed short);
14263 vector signed short vec_max (vector signed short, vector bool short);
14264 vector signed short vec_max (vector signed short, vector signed short);
14265 vector unsigned int vec_max (vector bool int, vector unsigned int);
14266 vector unsigned int vec_max (vector unsigned int, vector bool int);
14267 vector unsigned int vec_max (vector unsigned int, vector unsigned int);
14268 vector signed int vec_max (vector bool int, vector signed int);
14269 vector signed int vec_max (vector signed int, vector bool int);
14270 vector signed int vec_max (vector signed int, vector signed int);
14271 vector float vec_max (vector float, vector float);
14273 vector float vec_vmaxfp (vector float, vector float);
14275 vector signed int vec_vmaxsw (vector bool int, vector signed int);
14276 vector signed int vec_vmaxsw (vector signed int, vector bool int);
14277 vector signed int vec_vmaxsw (vector signed int, vector signed int);
14279 vector unsigned int vec_vmaxuw (vector bool int, vector unsigned int);
14280 vector unsigned int vec_vmaxuw (vector unsigned int, vector bool int);
14281 vector unsigned int vec_vmaxuw (vector unsigned int,
14282                                 vector unsigned int);
14284 vector signed short vec_vmaxsh (vector bool short, vector signed short);
14285 vector signed short vec_vmaxsh (vector signed short, vector bool short);
14286 vector signed short vec_vmaxsh (vector signed short,
14287                                 vector signed short);
14289 vector unsigned short vec_vmaxuh (vector bool short,
14290                                   vector unsigned short);
14291 vector unsigned short vec_vmaxuh (vector unsigned short,
14292                                   vector bool short);
14293 vector unsigned short vec_vmaxuh (vector unsigned short,
14294                                   vector unsigned short);
14296 vector signed char vec_vmaxsb (vector bool char, vector signed char);
14297 vector signed char vec_vmaxsb (vector signed char, vector bool char);
14298 vector signed char vec_vmaxsb (vector signed char, vector signed char);
14300 vector unsigned char vec_vmaxub (vector bool char,
14301                                  vector unsigned char);
14302 vector unsigned char vec_vmaxub (vector unsigned char,
14303                                  vector bool char);
14304 vector unsigned char vec_vmaxub (vector unsigned char,
14305                                  vector unsigned char);
14307 vector bool char vec_mergeh (vector bool char, vector bool char);
14308 vector signed char vec_mergeh (vector signed char, vector signed char);
14309 vector unsigned char vec_mergeh (vector unsigned char,
14310                                  vector unsigned char);
14311 vector bool short vec_mergeh (vector bool short, vector bool short);
14312 vector pixel vec_mergeh (vector pixel, vector pixel);
14313 vector signed short vec_mergeh (vector signed short,
14314                                 vector signed short);
14315 vector unsigned short vec_mergeh (vector unsigned short,
14316                                   vector unsigned short);
14317 vector float vec_mergeh (vector float, vector float);
14318 vector bool int vec_mergeh (vector bool int, vector bool int);
14319 vector signed int vec_mergeh (vector signed int, vector signed int);
14320 vector unsigned int vec_mergeh (vector unsigned int,
14321                                 vector unsigned int);
14323 vector float vec_vmrghw (vector float, vector float);
14324 vector bool int vec_vmrghw (vector bool int, vector bool int);
14325 vector signed int vec_vmrghw (vector signed int, vector signed int);
14326 vector unsigned int vec_vmrghw (vector unsigned int,
14327                                 vector unsigned int);
14329 vector bool short vec_vmrghh (vector bool short, vector bool short);
14330 vector signed short vec_vmrghh (vector signed short,
14331                                 vector signed short);
14332 vector unsigned short vec_vmrghh (vector unsigned short,
14333                                   vector unsigned short);
14334 vector pixel vec_vmrghh (vector pixel, vector pixel);
14336 vector bool char vec_vmrghb (vector bool char, vector bool char);
14337 vector signed char vec_vmrghb (vector signed char, vector signed char);
14338 vector unsigned char vec_vmrghb (vector unsigned char,
14339                                  vector unsigned char);
14341 vector bool char vec_mergel (vector bool char, vector bool char);
14342 vector signed char vec_mergel (vector signed char, vector signed char);
14343 vector unsigned char vec_mergel (vector unsigned char,
14344                                  vector unsigned char);
14345 vector bool short vec_mergel (vector bool short, vector bool short);
14346 vector pixel vec_mergel (vector pixel, vector pixel);
14347 vector signed short vec_mergel (vector signed short,
14348                                 vector signed short);
14349 vector unsigned short vec_mergel (vector unsigned short,
14350                                   vector unsigned short);
14351 vector float vec_mergel (vector float, vector float);
14352 vector bool int vec_mergel (vector bool int, vector bool int);
14353 vector signed int vec_mergel (vector signed int, vector signed int);
14354 vector unsigned int vec_mergel (vector unsigned int,
14355                                 vector unsigned int);
14357 vector float vec_vmrglw (vector float, vector float);
14358 vector signed int vec_vmrglw (vector signed int, vector signed int);
14359 vector unsigned int vec_vmrglw (vector unsigned int,
14360                                 vector unsigned int);
14361 vector bool int vec_vmrglw (vector bool int, vector bool int);
14363 vector bool short vec_vmrglh (vector bool short, vector bool short);
14364 vector signed short vec_vmrglh (vector signed short,
14365                                 vector signed short);
14366 vector unsigned short vec_vmrglh (vector unsigned short,
14367                                   vector unsigned short);
14368 vector pixel vec_vmrglh (vector pixel, vector pixel);
14370 vector bool char vec_vmrglb (vector bool char, vector bool char);
14371 vector signed char vec_vmrglb (vector signed char, vector signed char);
14372 vector unsigned char vec_vmrglb (vector unsigned char,
14373                                  vector unsigned char);
14375 vector unsigned short vec_mfvscr (void);
14377 vector unsigned char vec_min (vector bool char, vector unsigned char);
14378 vector unsigned char vec_min (vector unsigned char, vector bool char);
14379 vector unsigned char vec_min (vector unsigned char,
14380                               vector unsigned char);
14381 vector signed char vec_min (vector bool char, vector signed char);
14382 vector signed char vec_min (vector signed char, vector bool char);
14383 vector signed char vec_min (vector signed char, vector signed char);
14384 vector unsigned short vec_min (vector bool short,
14385                                vector unsigned short);
14386 vector unsigned short vec_min (vector unsigned short,
14387                                vector bool short);
14388 vector unsigned short vec_min (vector unsigned short,
14389                                vector unsigned short);
14390 vector signed short vec_min (vector bool short, vector signed short);
14391 vector signed short vec_min (vector signed short, vector bool short);
14392 vector signed short vec_min (vector signed short, vector signed short);
14393 vector unsigned int vec_min (vector bool int, vector unsigned int);
14394 vector unsigned int vec_min (vector unsigned int, vector bool int);
14395 vector unsigned int vec_min (vector unsigned int, vector unsigned int);
14396 vector signed int vec_min (vector bool int, vector signed int);
14397 vector signed int vec_min (vector signed int, vector bool int);
14398 vector signed int vec_min (vector signed int, vector signed int);
14399 vector float vec_min (vector float, vector float);
14401 vector float vec_vminfp (vector float, vector float);
14403 vector signed int vec_vminsw (vector bool int, vector signed int);
14404 vector signed int vec_vminsw (vector signed int, vector bool int);
14405 vector signed int vec_vminsw (vector signed int, vector signed int);
14407 vector unsigned int vec_vminuw (vector bool int, vector unsigned int);
14408 vector unsigned int vec_vminuw (vector unsigned int, vector bool int);
14409 vector unsigned int vec_vminuw (vector unsigned int,
14410                                 vector unsigned int);
14412 vector signed short vec_vminsh (vector bool short, vector signed short);
14413 vector signed short vec_vminsh (vector signed short, vector bool short);
14414 vector signed short vec_vminsh (vector signed short,
14415                                 vector signed short);
14417 vector unsigned short vec_vminuh (vector bool short,
14418                                   vector unsigned short);
14419 vector unsigned short vec_vminuh (vector unsigned short,
14420                                   vector bool short);
14421 vector unsigned short vec_vminuh (vector unsigned short,
14422                                   vector unsigned short);
14424 vector signed char vec_vminsb (vector bool char, vector signed char);
14425 vector signed char vec_vminsb (vector signed char, vector bool char);
14426 vector signed char vec_vminsb (vector signed char, vector signed char);
14428 vector unsigned char vec_vminub (vector bool char,
14429                                  vector unsigned char);
14430 vector unsigned char vec_vminub (vector unsigned char,
14431                                  vector bool char);
14432 vector unsigned char vec_vminub (vector unsigned char,
14433                                  vector unsigned char);
14435 vector signed short vec_mladd (vector signed short,
14436                                vector signed short,
14437                                vector signed short);
14438 vector signed short vec_mladd (vector signed short,
14439                                vector unsigned short,
14440                                vector unsigned short);
14441 vector signed short vec_mladd (vector unsigned short,
14442                                vector signed short,
14443                                vector signed short);
14444 vector unsigned short vec_mladd (vector unsigned short,
14445                                  vector unsigned short,
14446                                  vector unsigned short);
14448 vector signed short vec_mradds (vector signed short,
14449                                 vector signed short,
14450                                 vector signed short);
14452 vector unsigned int vec_msum (vector unsigned char,
14453                               vector unsigned char,
14454                               vector unsigned int);
14455 vector signed int vec_msum (vector signed char,
14456                             vector unsigned char,
14457                             vector signed int);
14458 vector unsigned int vec_msum (vector unsigned short,
14459                               vector unsigned short,
14460                               vector unsigned int);
14461 vector signed int vec_msum (vector signed short,
14462                             vector signed short,
14463                             vector signed int);
14465 vector signed int vec_vmsumshm (vector signed short,
14466                                 vector signed short,
14467                                 vector signed int);
14469 vector unsigned int vec_vmsumuhm (vector unsigned short,
14470                                   vector unsigned short,
14471                                   vector unsigned int);
14473 vector signed int vec_vmsummbm (vector signed char,
14474                                 vector unsigned char,
14475                                 vector signed int);
14477 vector unsigned int vec_vmsumubm (vector unsigned char,
14478                                   vector unsigned char,
14479                                   vector unsigned int);
14481 vector unsigned int vec_msums (vector unsigned short,
14482                                vector unsigned short,
14483                                vector unsigned int);
14484 vector signed int vec_msums (vector signed short,
14485                              vector signed short,
14486                              vector signed int);
14488 vector signed int vec_vmsumshs (vector signed short,
14489                                 vector signed short,
14490                                 vector signed int);
14492 vector unsigned int vec_vmsumuhs (vector unsigned short,
14493                                   vector unsigned short,
14494                                   vector unsigned int);
14496 void vec_mtvscr (vector signed int);
14497 void vec_mtvscr (vector unsigned int);
14498 void vec_mtvscr (vector bool int);
14499 void vec_mtvscr (vector signed short);
14500 void vec_mtvscr (vector unsigned short);
14501 void vec_mtvscr (vector bool short);
14502 void vec_mtvscr (vector pixel);
14503 void vec_mtvscr (vector signed char);
14504 void vec_mtvscr (vector unsigned char);
14505 void vec_mtvscr (vector bool char);
14507 vector unsigned short vec_mule (vector unsigned char,
14508                                 vector unsigned char);
14509 vector signed short vec_mule (vector signed char,
14510                               vector signed char);
14511 vector unsigned int vec_mule (vector unsigned short,
14512                               vector unsigned short);
14513 vector signed int vec_mule (vector signed short, vector signed short);
14515 vector signed int vec_vmulesh (vector signed short,
14516                                vector signed short);
14518 vector unsigned int vec_vmuleuh (vector unsigned short,
14519                                  vector unsigned short);
14521 vector signed short vec_vmulesb (vector signed char,
14522                                  vector signed char);
14524 vector unsigned short vec_vmuleub (vector unsigned char,
14525                                   vector unsigned char);
14527 vector unsigned short vec_mulo (vector unsigned char,
14528                                 vector unsigned char);
14529 vector signed short vec_mulo (vector signed char, vector signed char);
14530 vector unsigned int vec_mulo (vector unsigned short,
14531                               vector unsigned short);
14532 vector signed int vec_mulo (vector signed short, vector signed short);
14534 vector signed int vec_vmulosh (vector signed short,
14535                                vector signed short);
14537 vector unsigned int vec_vmulouh (vector unsigned short,
14538                                  vector unsigned short);
14540 vector signed short vec_vmulosb (vector signed char,
14541                                  vector signed char);
14543 vector unsigned short vec_vmuloub (vector unsigned char,
14544                                    vector unsigned char);
14546 vector float vec_nmsub (vector float, vector float, vector float);
14548 vector float vec_nor (vector float, vector float);
14549 vector signed int vec_nor (vector signed int, vector signed int);
14550 vector unsigned int vec_nor (vector unsigned int, vector unsigned int);
14551 vector bool int vec_nor (vector bool int, vector bool int);
14552 vector signed short vec_nor (vector signed short, vector signed short);
14553 vector unsigned short vec_nor (vector unsigned short,
14554                                vector unsigned short);
14555 vector bool short vec_nor (vector bool short, vector bool short);
14556 vector signed char vec_nor (vector signed char, vector signed char);
14557 vector unsigned char vec_nor (vector unsigned char,
14558                               vector unsigned char);
14559 vector bool char vec_nor (vector bool char, vector bool char);
14561 vector float vec_or (vector float, vector float);
14562 vector float vec_or (vector float, vector bool int);
14563 vector float vec_or (vector bool int, vector float);
14564 vector bool int vec_or (vector bool int, vector bool int);
14565 vector signed int vec_or (vector bool int, vector signed int);
14566 vector signed int vec_or (vector signed int, vector bool int);
14567 vector signed int vec_or (vector signed int, vector signed int);
14568 vector unsigned int vec_or (vector bool int, vector unsigned int);
14569 vector unsigned int vec_or (vector unsigned int, vector bool int);
14570 vector unsigned int vec_or (vector unsigned int, vector unsigned int);
14571 vector bool short vec_or (vector bool short, vector bool short);
14572 vector signed short vec_or (vector bool short, vector signed short);
14573 vector signed short vec_or (vector signed short, vector bool short);
14574 vector signed short vec_or (vector signed short, vector signed short);
14575 vector unsigned short vec_or (vector bool short, vector unsigned short);
14576 vector unsigned short vec_or (vector unsigned short, vector bool short);
14577 vector unsigned short vec_or (vector unsigned short,
14578                               vector unsigned short);
14579 vector signed char vec_or (vector bool char, vector signed char);
14580 vector bool char vec_or (vector bool char, vector bool char);
14581 vector signed char vec_or (vector signed char, vector bool char);
14582 vector signed char vec_or (vector signed char, vector signed char);
14583 vector unsigned char vec_or (vector bool char, vector unsigned char);
14584 vector unsigned char vec_or (vector unsigned char, vector bool char);
14585 vector unsigned char vec_or (vector unsigned char,
14586                              vector unsigned char);
14588 vector signed char vec_pack (vector signed short, vector signed short);
14589 vector unsigned char vec_pack (vector unsigned short,
14590                                vector unsigned short);
14591 vector bool char vec_pack (vector bool short, vector bool short);
14592 vector signed short vec_pack (vector signed int, vector signed int);
14593 vector unsigned short vec_pack (vector unsigned int,
14594                                 vector unsigned int);
14595 vector bool short vec_pack (vector bool int, vector bool int);
14597 vector bool short vec_vpkuwum (vector bool int, vector bool int);
14598 vector signed short vec_vpkuwum (vector signed int, vector signed int);
14599 vector unsigned short vec_vpkuwum (vector unsigned int,
14600                                    vector unsigned int);
14602 vector bool char vec_vpkuhum (vector bool short, vector bool short);
14603 vector signed char vec_vpkuhum (vector signed short,
14604                                 vector signed short);
14605 vector unsigned char vec_vpkuhum (vector unsigned short,
14606                                   vector unsigned short);
14608 vector pixel vec_packpx (vector unsigned int, vector unsigned int);
14610 vector unsigned char vec_packs (vector unsigned short,
14611                                 vector unsigned short);
14612 vector signed char vec_packs (vector signed short, vector signed short);
14613 vector unsigned short vec_packs (vector unsigned int,
14614                                  vector unsigned int);
14615 vector signed short vec_packs (vector signed int, vector signed int);
14617 vector signed short vec_vpkswss (vector signed int, vector signed int);
14619 vector unsigned short vec_vpkuwus (vector unsigned int,
14620                                    vector unsigned int);
14622 vector signed char vec_vpkshss (vector signed short,
14623                                 vector signed short);
14625 vector unsigned char vec_vpkuhus (vector unsigned short,
14626                                   vector unsigned short);
14628 vector unsigned char vec_packsu (vector unsigned short,
14629                                  vector unsigned short);
14630 vector unsigned char vec_packsu (vector signed short,
14631                                  vector signed short);
14632 vector unsigned short vec_packsu (vector unsigned int,
14633                                   vector unsigned int);
14634 vector unsigned short vec_packsu (vector signed int, vector signed int);
14636 vector unsigned short vec_vpkswus (vector signed int,
14637                                    vector signed int);
14639 vector unsigned char vec_vpkshus (vector signed short,
14640                                   vector signed short);
14642 vector float vec_perm (vector float,
14643                        vector float,
14644                        vector unsigned char);
14645 vector signed int vec_perm (vector signed int,
14646                             vector signed int,
14647                             vector unsigned char);
14648 vector unsigned int vec_perm (vector unsigned int,
14649                               vector unsigned int,
14650                               vector unsigned char);
14651 vector bool int vec_perm (vector bool int,
14652                           vector bool int,
14653                           vector unsigned char);
14654 vector signed short vec_perm (vector signed short,
14655                               vector signed short,
14656                               vector unsigned char);
14657 vector unsigned short vec_perm (vector unsigned short,
14658                                 vector unsigned short,
14659                                 vector unsigned char);
14660 vector bool short vec_perm (vector bool short,
14661                             vector bool short,
14662                             vector unsigned char);
14663 vector pixel vec_perm (vector pixel,
14664                        vector pixel,
14665                        vector unsigned char);
14666 vector signed char vec_perm (vector signed char,
14667                              vector signed char,
14668                              vector unsigned char);
14669 vector unsigned char vec_perm (vector unsigned char,
14670                                vector unsigned char,
14671                                vector unsigned char);
14672 vector bool char vec_perm (vector bool char,
14673                            vector bool char,
14674                            vector unsigned char);
14676 vector float vec_re (vector float);
14678 vector signed char vec_rl (vector signed char,
14679                            vector unsigned char);
14680 vector unsigned char vec_rl (vector unsigned char,
14681                              vector unsigned char);
14682 vector signed short vec_rl (vector signed short, vector unsigned short);
14683 vector unsigned short vec_rl (vector unsigned short,
14684                               vector unsigned short);
14685 vector signed int vec_rl (vector signed int, vector unsigned int);
14686 vector unsigned int vec_rl (vector unsigned int, vector unsigned int);
14688 vector signed int vec_vrlw (vector signed int, vector unsigned int);
14689 vector unsigned int vec_vrlw (vector unsigned int, vector unsigned int);
14691 vector signed short vec_vrlh (vector signed short,
14692                               vector unsigned short);
14693 vector unsigned short vec_vrlh (vector unsigned short,
14694                                 vector unsigned short);
14696 vector signed char vec_vrlb (vector signed char, vector unsigned char);
14697 vector unsigned char vec_vrlb (vector unsigned char,
14698                                vector unsigned char);
14700 vector float vec_round (vector float);
14702 vector float vec_recip (vector float, vector float);
14704 vector float vec_rsqrt (vector float);
14706 vector float vec_rsqrte (vector float);
14708 vector float vec_sel (vector float, vector float, vector bool int);
14709 vector float vec_sel (vector float, vector float, vector unsigned int);
14710 vector signed int vec_sel (vector signed int,
14711                            vector signed int,
14712                            vector bool int);
14713 vector signed int vec_sel (vector signed int,
14714                            vector signed int,
14715                            vector unsigned int);
14716 vector unsigned int vec_sel (vector unsigned int,
14717                              vector unsigned int,
14718                              vector bool int);
14719 vector unsigned int vec_sel (vector unsigned int,
14720                              vector unsigned int,
14721                              vector unsigned int);
14722 vector bool int vec_sel (vector bool int,
14723                          vector bool int,
14724                          vector bool int);
14725 vector bool int vec_sel (vector bool int,
14726                          vector bool int,
14727                          vector unsigned int);
14728 vector signed short vec_sel (vector signed short,
14729                              vector signed short,
14730                              vector bool short);
14731 vector signed short vec_sel (vector signed short,
14732                              vector signed short,
14733                              vector unsigned short);
14734 vector unsigned short vec_sel (vector unsigned short,
14735                                vector unsigned short,
14736                                vector bool short);
14737 vector unsigned short vec_sel (vector unsigned short,
14738                                vector unsigned short,
14739                                vector unsigned short);
14740 vector bool short vec_sel (vector bool short,
14741                            vector bool short,
14742                            vector bool short);
14743 vector bool short vec_sel (vector bool short,
14744                            vector bool short,
14745                            vector unsigned short);
14746 vector signed char vec_sel (vector signed char,
14747                             vector signed char,
14748                             vector bool char);
14749 vector signed char vec_sel (vector signed char,
14750                             vector signed char,
14751                             vector unsigned char);
14752 vector unsigned char vec_sel (vector unsigned char,
14753                               vector unsigned char,
14754                               vector bool char);
14755 vector unsigned char vec_sel (vector unsigned char,
14756                               vector unsigned char,
14757                               vector unsigned char);
14758 vector bool char vec_sel (vector bool char,
14759                           vector bool char,
14760                           vector bool char);
14761 vector bool char vec_sel (vector bool char,
14762                           vector bool char,
14763                           vector unsigned char);
14765 vector signed char vec_sl (vector signed char,
14766                            vector unsigned char);
14767 vector unsigned char vec_sl (vector unsigned char,
14768                              vector unsigned char);
14769 vector signed short vec_sl (vector signed short, vector unsigned short);
14770 vector unsigned short vec_sl (vector unsigned short,
14771                               vector unsigned short);
14772 vector signed int vec_sl (vector signed int, vector unsigned int);
14773 vector unsigned int vec_sl (vector unsigned int, vector unsigned int);
14775 vector signed int vec_vslw (vector signed int, vector unsigned int);
14776 vector unsigned int vec_vslw (vector unsigned int, vector unsigned int);
14778 vector signed short vec_vslh (vector signed short,
14779                               vector unsigned short);
14780 vector unsigned short vec_vslh (vector unsigned short,
14781                                 vector unsigned short);
14783 vector signed char vec_vslb (vector signed char, vector unsigned char);
14784 vector unsigned char vec_vslb (vector unsigned char,
14785                                vector unsigned char);
14787 vector float vec_sld (vector float, vector float, const int);
14788 vector signed int vec_sld (vector signed int,
14789                            vector signed int,
14790                            const int);
14791 vector unsigned int vec_sld (vector unsigned int,
14792                              vector unsigned int,
14793                              const int);
14794 vector bool int vec_sld (vector bool int,
14795                          vector bool int,
14796                          const int);
14797 vector signed short vec_sld (vector signed short,
14798                              vector signed short,
14799                              const int);
14800 vector unsigned short vec_sld (vector unsigned short,
14801                                vector unsigned short,
14802                                const int);
14803 vector bool short vec_sld (vector bool short,
14804                            vector bool short,
14805                            const int);
14806 vector pixel vec_sld (vector pixel,
14807                       vector pixel,
14808                       const int);
14809 vector signed char vec_sld (vector signed char,
14810                             vector signed char,
14811                             const int);
14812 vector unsigned char vec_sld (vector unsigned char,
14813                               vector unsigned char,
14814                               const int);
14815 vector bool char vec_sld (vector bool char,
14816                           vector bool char,
14817                           const int);
14819 vector signed int vec_sll (vector signed int,
14820                            vector unsigned int);
14821 vector signed int vec_sll (vector signed int,
14822                            vector unsigned short);
14823 vector signed int vec_sll (vector signed int,
14824                            vector unsigned char);
14825 vector unsigned int vec_sll (vector unsigned int,
14826                              vector unsigned int);
14827 vector unsigned int vec_sll (vector unsigned int,
14828                              vector unsigned short);
14829 vector unsigned int vec_sll (vector unsigned int,
14830                              vector unsigned char);
14831 vector bool int vec_sll (vector bool int,
14832                          vector unsigned int);
14833 vector bool int vec_sll (vector bool int,
14834                          vector unsigned short);
14835 vector bool int vec_sll (vector bool int,
14836                          vector unsigned char);
14837 vector signed short vec_sll (vector signed short,
14838                              vector unsigned int);
14839 vector signed short vec_sll (vector signed short,
14840                              vector unsigned short);
14841 vector signed short vec_sll (vector signed short,
14842                              vector unsigned char);
14843 vector unsigned short vec_sll (vector unsigned short,
14844                                vector unsigned int);
14845 vector unsigned short vec_sll (vector unsigned short,
14846                                vector unsigned short);
14847 vector unsigned short vec_sll (vector unsigned short,
14848                                vector unsigned char);
14849 vector bool short vec_sll (vector bool short, vector unsigned int);
14850 vector bool short vec_sll (vector bool short, vector unsigned short);
14851 vector bool short vec_sll (vector bool short, vector unsigned char);
14852 vector pixel vec_sll (vector pixel, vector unsigned int);
14853 vector pixel vec_sll (vector pixel, vector unsigned short);
14854 vector pixel vec_sll (vector pixel, vector unsigned char);
14855 vector signed char vec_sll (vector signed char, vector unsigned int);
14856 vector signed char vec_sll (vector signed char, vector unsigned short);
14857 vector signed char vec_sll (vector signed char, vector unsigned char);
14858 vector unsigned char vec_sll (vector unsigned char,
14859                               vector unsigned int);
14860 vector unsigned char vec_sll (vector unsigned char,
14861                               vector unsigned short);
14862 vector unsigned char vec_sll (vector unsigned char,
14863                               vector unsigned char);
14864 vector bool char vec_sll (vector bool char, vector unsigned int);
14865 vector bool char vec_sll (vector bool char, vector unsigned short);
14866 vector bool char vec_sll (vector bool char, vector unsigned char);
14868 vector float vec_slo (vector float, vector signed char);
14869 vector float vec_slo (vector float, vector unsigned char);
14870 vector signed int vec_slo (vector signed int, vector signed char);
14871 vector signed int vec_slo (vector signed int, vector unsigned char);
14872 vector unsigned int vec_slo (vector unsigned int, vector signed char);
14873 vector unsigned int vec_slo (vector unsigned int, vector unsigned char);
14874 vector signed short vec_slo (vector signed short, vector signed char);
14875 vector signed short vec_slo (vector signed short, vector unsigned char);
14876 vector unsigned short vec_slo (vector unsigned short,
14877                                vector signed char);
14878 vector unsigned short vec_slo (vector unsigned short,
14879                                vector unsigned char);
14880 vector pixel vec_slo (vector pixel, vector signed char);
14881 vector pixel vec_slo (vector pixel, vector unsigned char);
14882 vector signed char vec_slo (vector signed char, vector signed char);
14883 vector signed char vec_slo (vector signed char, vector unsigned char);
14884 vector unsigned char vec_slo (vector unsigned char, vector signed char);
14885 vector unsigned char vec_slo (vector unsigned char,
14886                               vector unsigned char);
14888 vector signed char vec_splat (vector signed char, const int);
14889 vector unsigned char vec_splat (vector unsigned char, const int);
14890 vector bool char vec_splat (vector bool char, const int);
14891 vector signed short vec_splat (vector signed short, const int);
14892 vector unsigned short vec_splat (vector unsigned short, const int);
14893 vector bool short vec_splat (vector bool short, const int);
14894 vector pixel vec_splat (vector pixel, const int);
14895 vector float vec_splat (vector float, const int);
14896 vector signed int vec_splat (vector signed int, const int);
14897 vector unsigned int vec_splat (vector unsigned int, const int);
14898 vector bool int vec_splat (vector bool int, const int);
14899 vector signed long vec_splat (vector signed long, const int);
14900 vector unsigned long vec_splat (vector unsigned long, const int);
14902 vector signed char vec_splats (signed char);
14903 vector unsigned char vec_splats (unsigned char);
14904 vector signed short vec_splats (signed short);
14905 vector unsigned short vec_splats (unsigned short);
14906 vector signed int vec_splats (signed int);
14907 vector unsigned int vec_splats (unsigned int);
14908 vector float vec_splats (float);
14910 vector float vec_vspltw (vector float, const int);
14911 vector signed int vec_vspltw (vector signed int, const int);
14912 vector unsigned int vec_vspltw (vector unsigned int, const int);
14913 vector bool int vec_vspltw (vector bool int, const int);
14915 vector bool short vec_vsplth (vector bool short, const int);
14916 vector signed short vec_vsplth (vector signed short, const int);
14917 vector unsigned short vec_vsplth (vector unsigned short, const int);
14918 vector pixel vec_vsplth (vector pixel, const int);
14920 vector signed char vec_vspltb (vector signed char, const int);
14921 vector unsigned char vec_vspltb (vector unsigned char, const int);
14922 vector bool char vec_vspltb (vector bool char, const int);
14924 vector signed char vec_splat_s8 (const int);
14926 vector signed short vec_splat_s16 (const int);
14928 vector signed int vec_splat_s32 (const int);
14930 vector unsigned char vec_splat_u8 (const int);
14932 vector unsigned short vec_splat_u16 (const int);
14934 vector unsigned int vec_splat_u32 (const int);
14936 vector signed char vec_sr (vector signed char, vector unsigned char);
14937 vector unsigned char vec_sr (vector unsigned char,
14938                              vector unsigned char);
14939 vector signed short vec_sr (vector signed short,
14940                             vector unsigned short);
14941 vector unsigned short vec_sr (vector unsigned short,
14942                               vector unsigned short);
14943 vector signed int vec_sr (vector signed int, vector unsigned int);
14944 vector unsigned int vec_sr (vector unsigned int, vector unsigned int);
14946 vector signed int vec_vsrw (vector signed int, vector unsigned int);
14947 vector unsigned int vec_vsrw (vector unsigned int, vector unsigned int);
14949 vector signed short vec_vsrh (vector signed short,
14950                               vector unsigned short);
14951 vector unsigned short vec_vsrh (vector unsigned short,
14952                                 vector unsigned short);
14954 vector signed char vec_vsrb (vector signed char, vector unsigned char);
14955 vector unsigned char vec_vsrb (vector unsigned char,
14956                                vector unsigned char);
14958 vector signed char vec_sra (vector signed char, vector unsigned char);
14959 vector unsigned char vec_sra (vector unsigned char,
14960                               vector unsigned char);
14961 vector signed short vec_sra (vector signed short,
14962                              vector unsigned short);
14963 vector unsigned short vec_sra (vector unsigned short,
14964                                vector unsigned short);
14965 vector signed int vec_sra (vector signed int, vector unsigned int);
14966 vector unsigned int vec_sra (vector unsigned int, vector unsigned int);
14968 vector signed int vec_vsraw (vector signed int, vector unsigned int);
14969 vector unsigned int vec_vsraw (vector unsigned int,
14970                                vector unsigned int);
14972 vector signed short vec_vsrah (vector signed short,
14973                                vector unsigned short);
14974 vector unsigned short vec_vsrah (vector unsigned short,
14975                                  vector unsigned short);
14977 vector signed char vec_vsrab (vector signed char, vector unsigned char);
14978 vector unsigned char vec_vsrab (vector unsigned char,
14979                                 vector unsigned char);
14981 vector signed int vec_srl (vector signed int, vector unsigned int);
14982 vector signed int vec_srl (vector signed int, vector unsigned short);
14983 vector signed int vec_srl (vector signed int, vector unsigned char);
14984 vector unsigned int vec_srl (vector unsigned int, vector unsigned int);
14985 vector unsigned int vec_srl (vector unsigned int,
14986                              vector unsigned short);
14987 vector unsigned int vec_srl (vector unsigned int, vector unsigned char);
14988 vector bool int vec_srl (vector bool int, vector unsigned int);
14989 vector bool int vec_srl (vector bool int, vector unsigned short);
14990 vector bool int vec_srl (vector bool int, vector unsigned char);
14991 vector signed short vec_srl (vector signed short, vector unsigned int);
14992 vector signed short vec_srl (vector signed short,
14993                              vector unsigned short);
14994 vector signed short vec_srl (vector signed short, vector unsigned char);
14995 vector unsigned short vec_srl (vector unsigned short,
14996                                vector unsigned int);
14997 vector unsigned short vec_srl (vector unsigned short,
14998                                vector unsigned short);
14999 vector unsigned short vec_srl (vector unsigned short,
15000                                vector unsigned char);
15001 vector bool short vec_srl (vector bool short, vector unsigned int);
15002 vector bool short vec_srl (vector bool short, vector unsigned short);
15003 vector bool short vec_srl (vector bool short, vector unsigned char);
15004 vector pixel vec_srl (vector pixel, vector unsigned int);
15005 vector pixel vec_srl (vector pixel, vector unsigned short);
15006 vector pixel vec_srl (vector pixel, vector unsigned char);
15007 vector signed char vec_srl (vector signed char, vector unsigned int);
15008 vector signed char vec_srl (vector signed char, vector unsigned short);
15009 vector signed char vec_srl (vector signed char, vector unsigned char);
15010 vector unsigned char vec_srl (vector unsigned char,
15011                               vector unsigned int);
15012 vector unsigned char vec_srl (vector unsigned char,
15013                               vector unsigned short);
15014 vector unsigned char vec_srl (vector unsigned char,
15015                               vector unsigned char);
15016 vector bool char vec_srl (vector bool char, vector unsigned int);
15017 vector bool char vec_srl (vector bool char, vector unsigned short);
15018 vector bool char vec_srl (vector bool char, vector unsigned char);
15020 vector float vec_sro (vector float, vector signed char);
15021 vector float vec_sro (vector float, vector unsigned char);
15022 vector signed int vec_sro (vector signed int, vector signed char);
15023 vector signed int vec_sro (vector signed int, vector unsigned char);
15024 vector unsigned int vec_sro (vector unsigned int, vector signed char);
15025 vector unsigned int vec_sro (vector unsigned int, vector unsigned char);
15026 vector signed short vec_sro (vector signed short, vector signed char);
15027 vector signed short vec_sro (vector signed short, vector unsigned char);
15028 vector unsigned short vec_sro (vector unsigned short,
15029                                vector signed char);
15030 vector unsigned short vec_sro (vector unsigned short,
15031                                vector unsigned char);
15032 vector pixel vec_sro (vector pixel, vector signed char);
15033 vector pixel vec_sro (vector pixel, vector unsigned char);
15034 vector signed char vec_sro (vector signed char, vector signed char);
15035 vector signed char vec_sro (vector signed char, vector unsigned char);
15036 vector unsigned char vec_sro (vector unsigned char, vector signed char);
15037 vector unsigned char vec_sro (vector unsigned char,
15038                               vector unsigned char);
15040 void vec_st (vector float, int, vector float *);
15041 void vec_st (vector float, int, float *);
15042 void vec_st (vector signed int, int, vector signed int *);
15043 void vec_st (vector signed int, int, int *);
15044 void vec_st (vector unsigned int, int, vector unsigned int *);
15045 void vec_st (vector unsigned int, int, unsigned int *);
15046 void vec_st (vector bool int, int, vector bool int *);
15047 void vec_st (vector bool int, int, unsigned int *);
15048 void vec_st (vector bool int, int, int *);
15049 void vec_st (vector signed short, int, vector signed short *);
15050 void vec_st (vector signed short, int, short *);
15051 void vec_st (vector unsigned short, int, vector unsigned short *);
15052 void vec_st (vector unsigned short, int, unsigned short *);
15053 void vec_st (vector bool short, int, vector bool short *);
15054 void vec_st (vector bool short, int, unsigned short *);
15055 void vec_st (vector pixel, int, vector pixel *);
15056 void vec_st (vector pixel, int, unsigned short *);
15057 void vec_st (vector pixel, int, short *);
15058 void vec_st (vector bool short, int, short *);
15059 void vec_st (vector signed char, int, vector signed char *);
15060 void vec_st (vector signed char, int, signed char *);
15061 void vec_st (vector unsigned char, int, vector unsigned char *);
15062 void vec_st (vector unsigned char, int, unsigned char *);
15063 void vec_st (vector bool char, int, vector bool char *);
15064 void vec_st (vector bool char, int, unsigned char *);
15065 void vec_st (vector bool char, int, signed char *);
15067 void vec_ste (vector signed char, int, signed char *);
15068 void vec_ste (vector unsigned char, int, unsigned char *);
15069 void vec_ste (vector bool char, int, signed char *);
15070 void vec_ste (vector bool char, int, unsigned char *);
15071 void vec_ste (vector signed short, int, short *);
15072 void vec_ste (vector unsigned short, int, unsigned short *);
15073 void vec_ste (vector bool short, int, short *);
15074 void vec_ste (vector bool short, int, unsigned short *);
15075 void vec_ste (vector pixel, int, short *);
15076 void vec_ste (vector pixel, int, unsigned short *);
15077 void vec_ste (vector float, int, float *);
15078 void vec_ste (vector signed int, int, int *);
15079 void vec_ste (vector unsigned int, int, unsigned int *);
15080 void vec_ste (vector bool int, int, int *);
15081 void vec_ste (vector bool int, int, unsigned int *);
15083 void vec_stvewx (vector float, int, float *);
15084 void vec_stvewx (vector signed int, int, int *);
15085 void vec_stvewx (vector unsigned int, int, unsigned int *);
15086 void vec_stvewx (vector bool int, int, int *);
15087 void vec_stvewx (vector bool int, int, unsigned int *);
15089 void vec_stvehx (vector signed short, int, short *);
15090 void vec_stvehx (vector unsigned short, int, unsigned short *);
15091 void vec_stvehx (vector bool short, int, short *);
15092 void vec_stvehx (vector bool short, int, unsigned short *);
15093 void vec_stvehx (vector pixel, int, short *);
15094 void vec_stvehx (vector pixel, int, unsigned short *);
15096 void vec_stvebx (vector signed char, int, signed char *);
15097 void vec_stvebx (vector unsigned char, int, unsigned char *);
15098 void vec_stvebx (vector bool char, int, signed char *);
15099 void vec_stvebx (vector bool char, int, unsigned char *);
15101 void vec_stl (vector float, int, vector float *);
15102 void vec_stl (vector float, int, float *);
15103 void vec_stl (vector signed int, int, vector signed int *);
15104 void vec_stl (vector signed int, int, int *);
15105 void vec_stl (vector unsigned int, int, vector unsigned int *);
15106 void vec_stl (vector unsigned int, int, unsigned int *);
15107 void vec_stl (vector bool int, int, vector bool int *);
15108 void vec_stl (vector bool int, int, unsigned int *);
15109 void vec_stl (vector bool int, int, int *);
15110 void vec_stl (vector signed short, int, vector signed short *);
15111 void vec_stl (vector signed short, int, short *);
15112 void vec_stl (vector unsigned short, int, vector unsigned short *);
15113 void vec_stl (vector unsigned short, int, unsigned short *);
15114 void vec_stl (vector bool short, int, vector bool short *);
15115 void vec_stl (vector bool short, int, unsigned short *);
15116 void vec_stl (vector bool short, int, short *);
15117 void vec_stl (vector pixel, int, vector pixel *);
15118 void vec_stl (vector pixel, int, unsigned short *);
15119 void vec_stl (vector pixel, int, short *);
15120 void vec_stl (vector signed char, int, vector signed char *);
15121 void vec_stl (vector signed char, int, signed char *);
15122 void vec_stl (vector unsigned char, int, vector unsigned char *);
15123 void vec_stl (vector unsigned char, int, unsigned char *);
15124 void vec_stl (vector bool char, int, vector bool char *);
15125 void vec_stl (vector bool char, int, unsigned char *);
15126 void vec_stl (vector bool char, int, signed char *);
15128 vector signed char vec_sub (vector bool char, vector signed char);
15129 vector signed char vec_sub (vector signed char, vector bool char);
15130 vector signed char vec_sub (vector signed char, vector signed char);
15131 vector unsigned char vec_sub (vector bool char, vector unsigned char);
15132 vector unsigned char vec_sub (vector unsigned char, vector bool char);
15133 vector unsigned char vec_sub (vector unsigned char,
15134                               vector unsigned char);
15135 vector signed short vec_sub (vector bool short, vector signed short);
15136 vector signed short vec_sub (vector signed short, vector bool short);
15137 vector signed short vec_sub (vector signed short, vector signed short);
15138 vector unsigned short vec_sub (vector bool short,
15139                                vector unsigned short);
15140 vector unsigned short vec_sub (vector unsigned short,
15141                                vector bool short);
15142 vector unsigned short vec_sub (vector unsigned short,
15143                                vector unsigned short);
15144 vector signed int vec_sub (vector bool int, vector signed int);
15145 vector signed int vec_sub (vector signed int, vector bool int);
15146 vector signed int vec_sub (vector signed int, vector signed int);
15147 vector unsigned int vec_sub (vector bool int, vector unsigned int);
15148 vector unsigned int vec_sub (vector unsigned int, vector bool int);
15149 vector unsigned int vec_sub (vector unsigned int, vector unsigned int);
15150 vector float vec_sub (vector float, vector float);
15152 vector float vec_vsubfp (vector float, vector float);
15154 vector signed int vec_vsubuwm (vector bool int, vector signed int);
15155 vector signed int vec_vsubuwm (vector signed int, vector bool int);
15156 vector signed int vec_vsubuwm (vector signed int, vector signed int);
15157 vector unsigned int vec_vsubuwm (vector bool int, vector unsigned int);
15158 vector unsigned int vec_vsubuwm (vector unsigned int, vector bool int);
15159 vector unsigned int vec_vsubuwm (vector unsigned int,
15160                                  vector unsigned int);
15162 vector signed short vec_vsubuhm (vector bool short,
15163                                  vector signed short);
15164 vector signed short vec_vsubuhm (vector signed short,
15165                                  vector bool short);
15166 vector signed short vec_vsubuhm (vector signed short,
15167                                  vector signed short);
15168 vector unsigned short vec_vsubuhm (vector bool short,
15169                                    vector unsigned short);
15170 vector unsigned short vec_vsubuhm (vector unsigned short,
15171                                    vector bool short);
15172 vector unsigned short vec_vsubuhm (vector unsigned short,
15173                                    vector unsigned short);
15175 vector signed char vec_vsububm (vector bool char, vector signed char);
15176 vector signed char vec_vsububm (vector signed char, vector bool char);
15177 vector signed char vec_vsububm (vector signed char, vector signed char);
15178 vector unsigned char vec_vsububm (vector bool char,
15179                                   vector unsigned char);
15180 vector unsigned char vec_vsububm (vector unsigned char,
15181                                   vector bool char);
15182 vector unsigned char vec_vsububm (vector unsigned char,
15183                                   vector unsigned char);
15185 vector unsigned int vec_subc (vector unsigned int, vector unsigned int);
15187 vector unsigned char vec_subs (vector bool char, vector unsigned char);
15188 vector unsigned char vec_subs (vector unsigned char, vector bool char);
15189 vector unsigned char vec_subs (vector unsigned char,
15190                                vector unsigned char);
15191 vector signed char vec_subs (vector bool char, vector signed char);
15192 vector signed char vec_subs (vector signed char, vector bool char);
15193 vector signed char vec_subs (vector signed char, vector signed char);
15194 vector unsigned short vec_subs (vector bool short,
15195                                 vector unsigned short);
15196 vector unsigned short vec_subs (vector unsigned short,
15197                                 vector bool short);
15198 vector unsigned short vec_subs (vector unsigned short,
15199                                 vector unsigned short);
15200 vector signed short vec_subs (vector bool short, vector signed short);
15201 vector signed short vec_subs (vector signed short, vector bool short);
15202 vector signed short vec_subs (vector signed short, vector signed short);
15203 vector unsigned int vec_subs (vector bool int, vector unsigned int);
15204 vector unsigned int vec_subs (vector unsigned int, vector bool int);
15205 vector unsigned int vec_subs (vector unsigned int, vector unsigned int);
15206 vector signed int vec_subs (vector bool int, vector signed int);
15207 vector signed int vec_subs (vector signed int, vector bool int);
15208 vector signed int vec_subs (vector signed int, vector signed int);
15210 vector signed int vec_vsubsws (vector bool int, vector signed int);
15211 vector signed int vec_vsubsws (vector signed int, vector bool int);
15212 vector signed int vec_vsubsws (vector signed int, vector signed int);
15214 vector unsigned int vec_vsubuws (vector bool int, vector unsigned int);
15215 vector unsigned int vec_vsubuws (vector unsigned int, vector bool int);
15216 vector unsigned int vec_vsubuws (vector unsigned int,
15217                                  vector unsigned int);
15219 vector signed short vec_vsubshs (vector bool short,
15220                                  vector signed short);
15221 vector signed short vec_vsubshs (vector signed short,
15222                                  vector bool short);
15223 vector signed short vec_vsubshs (vector signed short,
15224                                  vector signed short);
15226 vector unsigned short vec_vsubuhs (vector bool short,
15227                                    vector unsigned short);
15228 vector unsigned short vec_vsubuhs (vector unsigned short,
15229                                    vector bool short);
15230 vector unsigned short vec_vsubuhs (vector unsigned short,
15231                                    vector unsigned short);
15233 vector signed char vec_vsubsbs (vector bool char, vector signed char);
15234 vector signed char vec_vsubsbs (vector signed char, vector bool char);
15235 vector signed char vec_vsubsbs (vector signed char, vector signed char);
15237 vector unsigned char vec_vsububs (vector bool char,
15238                                   vector unsigned char);
15239 vector unsigned char vec_vsububs (vector unsigned char,
15240                                   vector bool char);
15241 vector unsigned char vec_vsububs (vector unsigned char,
15242                                   vector unsigned char);
15244 vector unsigned int vec_sum4s (vector unsigned char,
15245                                vector unsigned int);
15246 vector signed int vec_sum4s (vector signed char, vector signed int);
15247 vector signed int vec_sum4s (vector signed short, vector signed int);
15249 vector signed int vec_vsum4shs (vector signed short, vector signed int);
15251 vector signed int vec_vsum4sbs (vector signed char, vector signed int);
15253 vector unsigned int vec_vsum4ubs (vector unsigned char,
15254                                   vector unsigned int);
15256 vector signed int vec_sum2s (vector signed int, vector signed int);
15258 vector signed int vec_sums (vector signed int, vector signed int);
15260 vector float vec_trunc (vector float);
15262 vector signed short vec_unpackh (vector signed char);
15263 vector bool short vec_unpackh (vector bool char);
15264 vector signed int vec_unpackh (vector signed short);
15265 vector bool int vec_unpackh (vector bool short);
15266 vector unsigned int vec_unpackh (vector pixel);
15268 vector bool int vec_vupkhsh (vector bool short);
15269 vector signed int vec_vupkhsh (vector signed short);
15271 vector unsigned int vec_vupkhpx (vector pixel);
15273 vector bool short vec_vupkhsb (vector bool char);
15274 vector signed short vec_vupkhsb (vector signed char);
15276 vector signed short vec_unpackl (vector signed char);
15277 vector bool short vec_unpackl (vector bool char);
15278 vector unsigned int vec_unpackl (vector pixel);
15279 vector signed int vec_unpackl (vector signed short);
15280 vector bool int vec_unpackl (vector bool short);
15282 vector unsigned int vec_vupklpx (vector pixel);
15284 vector bool int vec_vupklsh (vector bool short);
15285 vector signed int vec_vupklsh (vector signed short);
15287 vector bool short vec_vupklsb (vector bool char);
15288 vector signed short vec_vupklsb (vector signed char);
15290 vector float vec_xor (vector float, vector float);
15291 vector float vec_xor (vector float, vector bool int);
15292 vector float vec_xor (vector bool int, vector float);
15293 vector bool int vec_xor (vector bool int, vector bool int);
15294 vector signed int vec_xor (vector bool int, vector signed int);
15295 vector signed int vec_xor (vector signed int, vector bool int);
15296 vector signed int vec_xor (vector signed int, vector signed int);
15297 vector unsigned int vec_xor (vector bool int, vector unsigned int);
15298 vector unsigned int vec_xor (vector unsigned int, vector bool int);
15299 vector unsigned int vec_xor (vector unsigned int, vector unsigned int);
15300 vector bool short vec_xor (vector bool short, vector bool short);
15301 vector signed short vec_xor (vector bool short, vector signed short);
15302 vector signed short vec_xor (vector signed short, vector bool short);
15303 vector signed short vec_xor (vector signed short, vector signed short);
15304 vector unsigned short vec_xor (vector bool short,
15305                                vector unsigned short);
15306 vector unsigned short vec_xor (vector unsigned short,
15307                                vector bool short);
15308 vector unsigned short vec_xor (vector unsigned short,
15309                                vector unsigned short);
15310 vector signed char vec_xor (vector bool char, vector signed char);
15311 vector bool char vec_xor (vector bool char, vector bool char);
15312 vector signed char vec_xor (vector signed char, vector bool char);
15313 vector signed char vec_xor (vector signed char, vector signed char);
15314 vector unsigned char vec_xor (vector bool char, vector unsigned char);
15315 vector unsigned char vec_xor (vector unsigned char, vector bool char);
15316 vector unsigned char vec_xor (vector unsigned char,
15317                               vector unsigned char);
15319 int vec_all_eq (vector signed char, vector bool char);
15320 int vec_all_eq (vector signed char, vector signed char);
15321 int vec_all_eq (vector unsigned char, vector bool char);
15322 int vec_all_eq (vector unsigned char, vector unsigned char);
15323 int vec_all_eq (vector bool char, vector bool char);
15324 int vec_all_eq (vector bool char, vector unsigned char);
15325 int vec_all_eq (vector bool char, vector signed char);
15326 int vec_all_eq (vector signed short, vector bool short);
15327 int vec_all_eq (vector signed short, vector signed short);
15328 int vec_all_eq (vector unsigned short, vector bool short);
15329 int vec_all_eq (vector unsigned short, vector unsigned short);
15330 int vec_all_eq (vector bool short, vector bool short);
15331 int vec_all_eq (vector bool short, vector unsigned short);
15332 int vec_all_eq (vector bool short, vector signed short);
15333 int vec_all_eq (vector pixel, vector pixel);
15334 int vec_all_eq (vector signed int, vector bool int);
15335 int vec_all_eq (vector signed int, vector signed int);
15336 int vec_all_eq (vector unsigned int, vector bool int);
15337 int vec_all_eq (vector unsigned int, vector unsigned int);
15338 int vec_all_eq (vector bool int, vector bool int);
15339 int vec_all_eq (vector bool int, vector unsigned int);
15340 int vec_all_eq (vector bool int, vector signed int);
15341 int vec_all_eq (vector float, vector float);
15343 int vec_all_ge (vector bool char, vector unsigned char);
15344 int vec_all_ge (vector unsigned char, vector bool char);
15345 int vec_all_ge (vector unsigned char, vector unsigned char);
15346 int vec_all_ge (vector bool char, vector signed char);
15347 int vec_all_ge (vector signed char, vector bool char);
15348 int vec_all_ge (vector signed char, vector signed char);
15349 int vec_all_ge (vector bool short, vector unsigned short);
15350 int vec_all_ge (vector unsigned short, vector bool short);
15351 int vec_all_ge (vector unsigned short, vector unsigned short);
15352 int vec_all_ge (vector signed short, vector signed short);
15353 int vec_all_ge (vector bool short, vector signed short);
15354 int vec_all_ge (vector signed short, vector bool short);
15355 int vec_all_ge (vector bool int, vector unsigned int);
15356 int vec_all_ge (vector unsigned int, vector bool int);
15357 int vec_all_ge (vector unsigned int, vector unsigned int);
15358 int vec_all_ge (vector bool int, vector signed int);
15359 int vec_all_ge (vector signed int, vector bool int);
15360 int vec_all_ge (vector signed int, vector signed int);
15361 int vec_all_ge (vector float, vector float);
15363 int vec_all_gt (vector bool char, vector unsigned char);
15364 int vec_all_gt (vector unsigned char, vector bool char);
15365 int vec_all_gt (vector unsigned char, vector unsigned char);
15366 int vec_all_gt (vector bool char, vector signed char);
15367 int vec_all_gt (vector signed char, vector bool char);
15368 int vec_all_gt (vector signed char, vector signed char);
15369 int vec_all_gt (vector bool short, vector unsigned short);
15370 int vec_all_gt (vector unsigned short, vector bool short);
15371 int vec_all_gt (vector unsigned short, vector unsigned short);
15372 int vec_all_gt (vector bool short, vector signed short);
15373 int vec_all_gt (vector signed short, vector bool short);
15374 int vec_all_gt (vector signed short, vector signed short);
15375 int vec_all_gt (vector bool int, vector unsigned int);
15376 int vec_all_gt (vector unsigned int, vector bool int);
15377 int vec_all_gt (vector unsigned int, vector unsigned int);
15378 int vec_all_gt (vector bool int, vector signed int);
15379 int vec_all_gt (vector signed int, vector bool int);
15380 int vec_all_gt (vector signed int, vector signed int);
15381 int vec_all_gt (vector float, vector float);
15383 int vec_all_in (vector float, vector float);
15385 int vec_all_le (vector bool char, vector unsigned char);
15386 int vec_all_le (vector unsigned char, vector bool char);
15387 int vec_all_le (vector unsigned char, vector unsigned char);
15388 int vec_all_le (vector bool char, vector signed char);
15389 int vec_all_le (vector signed char, vector bool char);
15390 int vec_all_le (vector signed char, vector signed char);
15391 int vec_all_le (vector bool short, vector unsigned short);
15392 int vec_all_le (vector unsigned short, vector bool short);
15393 int vec_all_le (vector unsigned short, vector unsigned short);
15394 int vec_all_le (vector bool short, vector signed short);
15395 int vec_all_le (vector signed short, vector bool short);
15396 int vec_all_le (vector signed short, vector signed short);
15397 int vec_all_le (vector bool int, vector unsigned int);
15398 int vec_all_le (vector unsigned int, vector bool int);
15399 int vec_all_le (vector unsigned int, vector unsigned int);
15400 int vec_all_le (vector bool int, vector signed int);
15401 int vec_all_le (vector signed int, vector bool int);
15402 int vec_all_le (vector signed int, vector signed int);
15403 int vec_all_le (vector float, vector float);
15405 int vec_all_lt (vector bool char, vector unsigned char);
15406 int vec_all_lt (vector unsigned char, vector bool char);
15407 int vec_all_lt (vector unsigned char, vector unsigned char);
15408 int vec_all_lt (vector bool char, vector signed char);
15409 int vec_all_lt (vector signed char, vector bool char);
15410 int vec_all_lt (vector signed char, vector signed char);
15411 int vec_all_lt (vector bool short, vector unsigned short);
15412 int vec_all_lt (vector unsigned short, vector bool short);
15413 int vec_all_lt (vector unsigned short, vector unsigned short);
15414 int vec_all_lt (vector bool short, vector signed short);
15415 int vec_all_lt (vector signed short, vector bool short);
15416 int vec_all_lt (vector signed short, vector signed short);
15417 int vec_all_lt (vector bool int, vector unsigned int);
15418 int vec_all_lt (vector unsigned int, vector bool int);
15419 int vec_all_lt (vector unsigned int, vector unsigned int);
15420 int vec_all_lt (vector bool int, vector signed int);
15421 int vec_all_lt (vector signed int, vector bool int);
15422 int vec_all_lt (vector signed int, vector signed int);
15423 int vec_all_lt (vector float, vector float);
15425 int vec_all_nan (vector float);
15427 int vec_all_ne (vector signed char, vector bool char);
15428 int vec_all_ne (vector signed char, vector signed char);
15429 int vec_all_ne (vector unsigned char, vector bool char);
15430 int vec_all_ne (vector unsigned char, vector unsigned char);
15431 int vec_all_ne (vector bool char, vector bool char);
15432 int vec_all_ne (vector bool char, vector unsigned char);
15433 int vec_all_ne (vector bool char, vector signed char);
15434 int vec_all_ne (vector signed short, vector bool short);
15435 int vec_all_ne (vector signed short, vector signed short);
15436 int vec_all_ne (vector unsigned short, vector bool short);
15437 int vec_all_ne (vector unsigned short, vector unsigned short);
15438 int vec_all_ne (vector bool short, vector bool short);
15439 int vec_all_ne (vector bool short, vector unsigned short);
15440 int vec_all_ne (vector bool short, vector signed short);
15441 int vec_all_ne (vector pixel, vector pixel);
15442 int vec_all_ne (vector signed int, vector bool int);
15443 int vec_all_ne (vector signed int, vector signed int);
15444 int vec_all_ne (vector unsigned int, vector bool int);
15445 int vec_all_ne (vector unsigned int, vector unsigned int);
15446 int vec_all_ne (vector bool int, vector bool int);
15447 int vec_all_ne (vector bool int, vector unsigned int);
15448 int vec_all_ne (vector bool int, vector signed int);
15449 int vec_all_ne (vector float, vector float);
15451 int vec_all_nge (vector float, vector float);
15453 int vec_all_ngt (vector float, vector float);
15455 int vec_all_nle (vector float, vector float);
15457 int vec_all_nlt (vector float, vector float);
15459 int vec_all_numeric (vector float);
15461 int vec_any_eq (vector signed char, vector bool char);
15462 int vec_any_eq (vector signed char, vector signed char);
15463 int vec_any_eq (vector unsigned char, vector bool char);
15464 int vec_any_eq (vector unsigned char, vector unsigned char);
15465 int vec_any_eq (vector bool char, vector bool char);
15466 int vec_any_eq (vector bool char, vector unsigned char);
15467 int vec_any_eq (vector bool char, vector signed char);
15468 int vec_any_eq (vector signed short, vector bool short);
15469 int vec_any_eq (vector signed short, vector signed short);
15470 int vec_any_eq (vector unsigned short, vector bool short);
15471 int vec_any_eq (vector unsigned short, vector unsigned short);
15472 int vec_any_eq (vector bool short, vector bool short);
15473 int vec_any_eq (vector bool short, vector unsigned short);
15474 int vec_any_eq (vector bool short, vector signed short);
15475 int vec_any_eq (vector pixel, vector pixel);
15476 int vec_any_eq (vector signed int, vector bool int);
15477 int vec_any_eq (vector signed int, vector signed int);
15478 int vec_any_eq (vector unsigned int, vector bool int);
15479 int vec_any_eq (vector unsigned int, vector unsigned int);
15480 int vec_any_eq (vector bool int, vector bool int);
15481 int vec_any_eq (vector bool int, vector unsigned int);
15482 int vec_any_eq (vector bool int, vector signed int);
15483 int vec_any_eq (vector float, vector float);
15485 int vec_any_ge (vector signed char, vector bool char);
15486 int vec_any_ge (vector unsigned char, vector bool char);
15487 int vec_any_ge (vector unsigned char, vector unsigned char);
15488 int vec_any_ge (vector signed char, vector signed char);
15489 int vec_any_ge (vector bool char, vector unsigned char);
15490 int vec_any_ge (vector bool char, vector signed char);
15491 int vec_any_ge (vector unsigned short, vector bool short);
15492 int vec_any_ge (vector unsigned short, vector unsigned short);
15493 int vec_any_ge (vector signed short, vector signed short);
15494 int vec_any_ge (vector signed short, vector bool short);
15495 int vec_any_ge (vector bool short, vector unsigned short);
15496 int vec_any_ge (vector bool short, vector signed short);
15497 int vec_any_ge (vector signed int, vector bool int);
15498 int vec_any_ge (vector unsigned int, vector bool int);
15499 int vec_any_ge (vector unsigned int, vector unsigned int);
15500 int vec_any_ge (vector signed int, vector signed int);
15501 int vec_any_ge (vector bool int, vector unsigned int);
15502 int vec_any_ge (vector bool int, vector signed int);
15503 int vec_any_ge (vector float, vector float);
15505 int vec_any_gt (vector bool char, vector unsigned char);
15506 int vec_any_gt (vector unsigned char, vector bool char);
15507 int vec_any_gt (vector unsigned char, vector unsigned char);
15508 int vec_any_gt (vector bool char, vector signed char);
15509 int vec_any_gt (vector signed char, vector bool char);
15510 int vec_any_gt (vector signed char, vector signed char);
15511 int vec_any_gt (vector bool short, vector unsigned short);
15512 int vec_any_gt (vector unsigned short, vector bool short);
15513 int vec_any_gt (vector unsigned short, vector unsigned short);
15514 int vec_any_gt (vector bool short, vector signed short);
15515 int vec_any_gt (vector signed short, vector bool short);
15516 int vec_any_gt (vector signed short, vector signed short);
15517 int vec_any_gt (vector bool int, vector unsigned int);
15518 int vec_any_gt (vector unsigned int, vector bool int);
15519 int vec_any_gt (vector unsigned int, vector unsigned int);
15520 int vec_any_gt (vector bool int, vector signed int);
15521 int vec_any_gt (vector signed int, vector bool int);
15522 int vec_any_gt (vector signed int, vector signed int);
15523 int vec_any_gt (vector float, vector float);
15525 int vec_any_le (vector bool char, vector unsigned char);
15526 int vec_any_le (vector unsigned char, vector bool char);
15527 int vec_any_le (vector unsigned char, vector unsigned char);
15528 int vec_any_le (vector bool char, vector signed char);
15529 int vec_any_le (vector signed char, vector bool char);
15530 int vec_any_le (vector signed char, vector signed char);
15531 int vec_any_le (vector bool short, vector unsigned short);
15532 int vec_any_le (vector unsigned short, vector bool short);
15533 int vec_any_le (vector unsigned short, vector unsigned short);
15534 int vec_any_le (vector bool short, vector signed short);
15535 int vec_any_le (vector signed short, vector bool short);
15536 int vec_any_le (vector signed short, vector signed short);
15537 int vec_any_le (vector bool int, vector unsigned int);
15538 int vec_any_le (vector unsigned int, vector bool int);
15539 int vec_any_le (vector unsigned int, vector unsigned int);
15540 int vec_any_le (vector bool int, vector signed int);
15541 int vec_any_le (vector signed int, vector bool int);
15542 int vec_any_le (vector signed int, vector signed int);
15543 int vec_any_le (vector float, vector float);
15545 int vec_any_lt (vector bool char, vector unsigned char);
15546 int vec_any_lt (vector unsigned char, vector bool char);
15547 int vec_any_lt (vector unsigned char, vector unsigned char);
15548 int vec_any_lt (vector bool char, vector signed char);
15549 int vec_any_lt (vector signed char, vector bool char);
15550 int vec_any_lt (vector signed char, vector signed char);
15551 int vec_any_lt (vector bool short, vector unsigned short);
15552 int vec_any_lt (vector unsigned short, vector bool short);
15553 int vec_any_lt (vector unsigned short, vector unsigned short);
15554 int vec_any_lt (vector bool short, vector signed short);
15555 int vec_any_lt (vector signed short, vector bool short);
15556 int vec_any_lt (vector signed short, vector signed short);
15557 int vec_any_lt (vector bool int, vector unsigned int);
15558 int vec_any_lt (vector unsigned int, vector bool int);
15559 int vec_any_lt (vector unsigned int, vector unsigned int);
15560 int vec_any_lt (vector bool int, vector signed int);
15561 int vec_any_lt (vector signed int, vector bool int);
15562 int vec_any_lt (vector signed int, vector signed int);
15563 int vec_any_lt (vector float, vector float);
15565 int vec_any_nan (vector float);
15567 int vec_any_ne (vector signed char, vector bool char);
15568 int vec_any_ne (vector signed char, vector signed char);
15569 int vec_any_ne (vector unsigned char, vector bool char);
15570 int vec_any_ne (vector unsigned char, vector unsigned char);
15571 int vec_any_ne (vector bool char, vector bool char);
15572 int vec_any_ne (vector bool char, vector unsigned char);
15573 int vec_any_ne (vector bool char, vector signed char);
15574 int vec_any_ne (vector signed short, vector bool short);
15575 int vec_any_ne (vector signed short, vector signed short);
15576 int vec_any_ne (vector unsigned short, vector bool short);
15577 int vec_any_ne (vector unsigned short, vector unsigned short);
15578 int vec_any_ne (vector bool short, vector bool short);
15579 int vec_any_ne (vector bool short, vector unsigned short);
15580 int vec_any_ne (vector bool short, vector signed short);
15581 int vec_any_ne (vector pixel, vector pixel);
15582 int vec_any_ne (vector signed int, vector bool int);
15583 int vec_any_ne (vector signed int, vector signed int);
15584 int vec_any_ne (vector unsigned int, vector bool int);
15585 int vec_any_ne (vector unsigned int, vector unsigned int);
15586 int vec_any_ne (vector bool int, vector bool int);
15587 int vec_any_ne (vector bool int, vector unsigned int);
15588 int vec_any_ne (vector bool int, vector signed int);
15589 int vec_any_ne (vector float, vector float);
15591 int vec_any_nge (vector float, vector float);
15593 int vec_any_ngt (vector float, vector float);
15595 int vec_any_nle (vector float, vector float);
15597 int vec_any_nlt (vector float, vector float);
15599 int vec_any_numeric (vector float);
15601 int vec_any_out (vector float, vector float);
15602 @end smallexample
15604 If the vector/scalar (VSX) instruction set is available, the following
15605 additional functions are available:
15607 @smallexample
15608 vector double vec_abs (vector double);
15609 vector double vec_add (vector double, vector double);
15610 vector double vec_and (vector double, vector double);
15611 vector double vec_and (vector double, vector bool long);
15612 vector double vec_and (vector bool long, vector double);
15613 vector long vec_and (vector long, vector long);
15614 vector long vec_and (vector long, vector bool long);
15615 vector long vec_and (vector bool long, vector long);
15616 vector unsigned long vec_and (vector unsigned long, vector unsigned long);
15617 vector unsigned long vec_and (vector unsigned long, vector bool long);
15618 vector unsigned long vec_and (vector bool long, vector unsigned long);
15619 vector double vec_andc (vector double, vector double);
15620 vector double vec_andc (vector double, vector bool long);
15621 vector double vec_andc (vector bool long, vector double);
15622 vector long vec_andc (vector long, vector long);
15623 vector long vec_andc (vector long, vector bool long);
15624 vector long vec_andc (vector bool long, vector long);
15625 vector unsigned long vec_andc (vector unsigned long, vector unsigned long);
15626 vector unsigned long vec_andc (vector unsigned long, vector bool long);
15627 vector unsigned long vec_andc (vector bool long, vector unsigned long);
15628 vector double vec_ceil (vector double);
15629 vector bool long vec_cmpeq (vector double, vector double);
15630 vector bool long vec_cmpge (vector double, vector double);
15631 vector bool long vec_cmpgt (vector double, vector double);
15632 vector bool long vec_cmple (vector double, vector double);
15633 vector bool long vec_cmplt (vector double, vector double);
15634 vector double vec_cpsgn (vector double, vector double);
15635 vector float vec_div (vector float, vector float);
15636 vector double vec_div (vector double, vector double);
15637 vector long vec_div (vector long, vector long);
15638 vector unsigned long vec_div (vector unsigned long, vector unsigned long);
15639 vector double vec_floor (vector double);
15640 vector double vec_ld (int, const vector double *);
15641 vector double vec_ld (int, const double *);
15642 vector double vec_ldl (int, const vector double *);
15643 vector double vec_ldl (int, const double *);
15644 vector unsigned char vec_lvsl (int, const volatile double *);
15645 vector unsigned char vec_lvsr (int, const volatile double *);
15646 vector double vec_madd (vector double, vector double, vector double);
15647 vector double vec_max (vector double, vector double);
15648 vector signed long vec_mergeh (vector signed long, vector signed long);
15649 vector signed long vec_mergeh (vector signed long, vector bool long);
15650 vector signed long vec_mergeh (vector bool long, vector signed long);
15651 vector unsigned long vec_mergeh (vector unsigned long, vector unsigned long);
15652 vector unsigned long vec_mergeh (vector unsigned long, vector bool long);
15653 vector unsigned long vec_mergeh (vector bool long, vector unsigned long);
15654 vector signed long vec_mergel (vector signed long, vector signed long);
15655 vector signed long vec_mergel (vector signed long, vector bool long);
15656 vector signed long vec_mergel (vector bool long, vector signed long);
15657 vector unsigned long vec_mergel (vector unsigned long, vector unsigned long);
15658 vector unsigned long vec_mergel (vector unsigned long, vector bool long);
15659 vector unsigned long vec_mergel (vector bool long, vector unsigned long);
15660 vector double vec_min (vector double, vector double);
15661 vector float vec_msub (vector float, vector float, vector float);
15662 vector double vec_msub (vector double, vector double, vector double);
15663 vector float vec_mul (vector float, vector float);
15664 vector double vec_mul (vector double, vector double);
15665 vector long vec_mul (vector long, vector long);
15666 vector unsigned long vec_mul (vector unsigned long, vector unsigned long);
15667 vector float vec_nearbyint (vector float);
15668 vector double vec_nearbyint (vector double);
15669 vector float vec_nmadd (vector float, vector float, vector float);
15670 vector double vec_nmadd (vector double, vector double, vector double);
15671 vector double vec_nmsub (vector double, vector double, vector double);
15672 vector double vec_nor (vector double, vector double);
15673 vector long vec_nor (vector long, vector long);
15674 vector long vec_nor (vector long, vector bool long);
15675 vector long vec_nor (vector bool long, vector long);
15676 vector unsigned long vec_nor (vector unsigned long, vector unsigned long);
15677 vector unsigned long vec_nor (vector unsigned long, vector bool long);
15678 vector unsigned long vec_nor (vector bool long, vector unsigned long);
15679 vector double vec_or (vector double, vector double);
15680 vector double vec_or (vector double, vector bool long);
15681 vector double vec_or (vector bool long, vector double);
15682 vector long vec_or (vector long, vector long);
15683 vector long vec_or (vector long, vector bool long);
15684 vector long vec_or (vector bool long, vector long);
15685 vector unsigned long vec_or (vector unsigned long, vector unsigned long);
15686 vector unsigned long vec_or (vector unsigned long, vector bool long);
15687 vector unsigned long vec_or (vector bool long, vector unsigned long);
15688 vector double vec_perm (vector double, vector double, vector unsigned char);
15689 vector long vec_perm (vector long, vector long, vector unsigned char);
15690 vector unsigned long vec_perm (vector unsigned long, vector unsigned long,
15691                                vector unsigned char);
15692 vector double vec_rint (vector double);
15693 vector double vec_recip (vector double, vector double);
15694 vector double vec_rsqrt (vector double);
15695 vector double vec_rsqrte (vector double);
15696 vector double vec_sel (vector double, vector double, vector bool long);
15697 vector double vec_sel (vector double, vector double, vector unsigned long);
15698 vector long vec_sel (vector long, vector long, vector long);
15699 vector long vec_sel (vector long, vector long, vector unsigned long);
15700 vector long vec_sel (vector long, vector long, vector bool long);
15701 vector unsigned long vec_sel (vector unsigned long, vector unsigned long,
15702                               vector long);
15703 vector unsigned long vec_sel (vector unsigned long, vector unsigned long,
15704                               vector unsigned long);
15705 vector unsigned long vec_sel (vector unsigned long, vector unsigned long,
15706                               vector bool long);
15707 vector double vec_splats (double);
15708 vector signed long vec_splats (signed long);
15709 vector unsigned long vec_splats (unsigned long);
15710 vector float vec_sqrt (vector float);
15711 vector double vec_sqrt (vector double);
15712 void vec_st (vector double, int, vector double *);
15713 void vec_st (vector double, int, double *);
15714 vector double vec_sub (vector double, vector double);
15715 vector double vec_trunc (vector double);
15716 vector double vec_xor (vector double, vector double);
15717 vector double vec_xor (vector double, vector bool long);
15718 vector double vec_xor (vector bool long, vector double);
15719 vector long vec_xor (vector long, vector long);
15720 vector long vec_xor (vector long, vector bool long);
15721 vector long vec_xor (vector bool long, vector long);
15722 vector unsigned long vec_xor (vector unsigned long, vector unsigned long);
15723 vector unsigned long vec_xor (vector unsigned long, vector bool long);
15724 vector unsigned long vec_xor (vector bool long, vector unsigned long);
15725 int vec_all_eq (vector double, vector double);
15726 int vec_all_ge (vector double, vector double);
15727 int vec_all_gt (vector double, vector double);
15728 int vec_all_le (vector double, vector double);
15729 int vec_all_lt (vector double, vector double);
15730 int vec_all_nan (vector double);
15731 int vec_all_ne (vector double, vector double);
15732 int vec_all_nge (vector double, vector double);
15733 int vec_all_ngt (vector double, vector double);
15734 int vec_all_nle (vector double, vector double);
15735 int vec_all_nlt (vector double, vector double);
15736 int vec_all_numeric (vector double);
15737 int vec_any_eq (vector double, vector double);
15738 int vec_any_ge (vector double, vector double);
15739 int vec_any_gt (vector double, vector double);
15740 int vec_any_le (vector double, vector double);
15741 int vec_any_lt (vector double, vector double);
15742 int vec_any_nan (vector double);
15743 int vec_any_ne (vector double, vector double);
15744 int vec_any_nge (vector double, vector double);
15745 int vec_any_ngt (vector double, vector double);
15746 int vec_any_nle (vector double, vector double);
15747 int vec_any_nlt (vector double, vector double);
15748 int vec_any_numeric (vector double);
15750 vector double vec_vsx_ld (int, const vector double *);
15751 vector double vec_vsx_ld (int, const double *);
15752 vector float vec_vsx_ld (int, const vector float *);
15753 vector float vec_vsx_ld (int, const float *);
15754 vector bool int vec_vsx_ld (int, const vector bool int *);
15755 vector signed int vec_vsx_ld (int, const vector signed int *);
15756 vector signed int vec_vsx_ld (int, const int *);
15757 vector signed int vec_vsx_ld (int, const long *);
15758 vector unsigned int vec_vsx_ld (int, const vector unsigned int *);
15759 vector unsigned int vec_vsx_ld (int, const unsigned int *);
15760 vector unsigned int vec_vsx_ld (int, const unsigned long *);
15761 vector bool short vec_vsx_ld (int, const vector bool short *);
15762 vector pixel vec_vsx_ld (int, const vector pixel *);
15763 vector signed short vec_vsx_ld (int, const vector signed short *);
15764 vector signed short vec_vsx_ld (int, const short *);
15765 vector unsigned short vec_vsx_ld (int, const vector unsigned short *);
15766 vector unsigned short vec_vsx_ld (int, const unsigned short *);
15767 vector bool char vec_vsx_ld (int, const vector bool char *);
15768 vector signed char vec_vsx_ld (int, const vector signed char *);
15769 vector signed char vec_vsx_ld (int, const signed char *);
15770 vector unsigned char vec_vsx_ld (int, const vector unsigned char *);
15771 vector unsigned char vec_vsx_ld (int, const unsigned char *);
15773 void vec_vsx_st (vector double, int, vector double *);
15774 void vec_vsx_st (vector double, int, double *);
15775 void vec_vsx_st (vector float, int, vector float *);
15776 void vec_vsx_st (vector float, int, float *);
15777 void vec_vsx_st (vector signed int, int, vector signed int *);
15778 void vec_vsx_st (vector signed int, int, int *);
15779 void vec_vsx_st (vector unsigned int, int, vector unsigned int *);
15780 void vec_vsx_st (vector unsigned int, int, unsigned int *);
15781 void vec_vsx_st (vector bool int, int, vector bool int *);
15782 void vec_vsx_st (vector bool int, int, unsigned int *);
15783 void vec_vsx_st (vector bool int, int, int *);
15784 void vec_vsx_st (vector signed short, int, vector signed short *);
15785 void vec_vsx_st (vector signed short, int, short *);
15786 void vec_vsx_st (vector unsigned short, int, vector unsigned short *);
15787 void vec_vsx_st (vector unsigned short, int, unsigned short *);
15788 void vec_vsx_st (vector bool short, int, vector bool short *);
15789 void vec_vsx_st (vector bool short, int, unsigned short *);
15790 void vec_vsx_st (vector pixel, int, vector pixel *);
15791 void vec_vsx_st (vector pixel, int, unsigned short *);
15792 void vec_vsx_st (vector pixel, int, short *);
15793 void vec_vsx_st (vector bool short, int, short *);
15794 void vec_vsx_st (vector signed char, int, vector signed char *);
15795 void vec_vsx_st (vector signed char, int, signed char *);
15796 void vec_vsx_st (vector unsigned char, int, vector unsigned char *);
15797 void vec_vsx_st (vector unsigned char, int, unsigned char *);
15798 void vec_vsx_st (vector bool char, int, vector bool char *);
15799 void vec_vsx_st (vector bool char, int, unsigned char *);
15800 void vec_vsx_st (vector bool char, int, signed char *);
15802 vector double vec_xxpermdi (vector double, vector double, int);
15803 vector float vec_xxpermdi (vector float, vector float, int);
15804 vector long long vec_xxpermdi (vector long long, vector long long, int);
15805 vector unsigned long long vec_xxpermdi (vector unsigned long long,
15806                                         vector unsigned long long, int);
15807 vector int vec_xxpermdi (vector int, vector int, int);
15808 vector unsigned int vec_xxpermdi (vector unsigned int,
15809                                   vector unsigned int, int);
15810 vector short vec_xxpermdi (vector short, vector short, int);
15811 vector unsigned short vec_xxpermdi (vector unsigned short,
15812                                     vector unsigned short, int);
15813 vector signed char vec_xxpermdi (vector signed char, vector signed char, int);
15814 vector unsigned char vec_xxpermdi (vector unsigned char,
15815                                    vector unsigned char, int);
15817 vector double vec_xxsldi (vector double, vector double, int);
15818 vector float vec_xxsldi (vector float, vector float, int);
15819 vector long long vec_xxsldi (vector long long, vector long long, int);
15820 vector unsigned long long vec_xxsldi (vector unsigned long long,
15821                                       vector unsigned long long, int);
15822 vector int vec_xxsldi (vector int, vector int, int);
15823 vector unsigned int vec_xxsldi (vector unsigned int, vector unsigned int, int);
15824 vector short vec_xxsldi (vector short, vector short, int);
15825 vector unsigned short vec_xxsldi (vector unsigned short,
15826                                   vector unsigned short, int);
15827 vector signed char vec_xxsldi (vector signed char, vector signed char, int);
15828 vector unsigned char vec_xxsldi (vector unsigned char,
15829                                  vector unsigned char, int);
15830 @end smallexample
15832 Note that the @samp{vec_ld} and @samp{vec_st} built-in functions always
15833 generate the AltiVec @samp{LVX} and @samp{STVX} instructions even
15834 if the VSX instruction set is available.  The @samp{vec_vsx_ld} and
15835 @samp{vec_vsx_st} built-in functions always generate the VSX @samp{LXVD2X},
15836 @samp{LXVW4X}, @samp{STXVD2X}, and @samp{STXVW4X} instructions.
15838 If the ISA 2.07 additions to the vector/scalar (power8-vector)
15839 instruction set is available, the following additional functions are
15840 available for both 32-bit and 64-bit targets.  For 64-bit targets, you
15841 can use @var{vector long} instead of @var{vector long long},
15842 @var{vector bool long} instead of @var{vector bool long long}, and
15843 @var{vector unsigned long} instead of @var{vector unsigned long long}.
15845 @smallexample
15846 vector long long vec_abs (vector long long);
15848 vector long long vec_add (vector long long, vector long long);
15849 vector unsigned long long vec_add (vector unsigned long long,
15850                                    vector unsigned long long);
15852 int vec_all_eq (vector long long, vector long long);
15853 int vec_all_eq (vector unsigned long long, vector unsigned long long);
15854 int vec_all_ge (vector long long, vector long long);
15855 int vec_all_ge (vector unsigned long long, vector unsigned long long);
15856 int vec_all_gt (vector long long, vector long long);
15857 int vec_all_gt (vector unsigned long long, vector unsigned long long);
15858 int vec_all_le (vector long long, vector long long);
15859 int vec_all_le (vector unsigned long long, vector unsigned long long);
15860 int vec_all_lt (vector long long, vector long long);
15861 int vec_all_lt (vector unsigned long long, vector unsigned long long);
15862 int vec_all_ne (vector long long, vector long long);
15863 int vec_all_ne (vector unsigned long long, vector unsigned long long);
15865 int vec_any_eq (vector long long, vector long long);
15866 int vec_any_eq (vector unsigned long long, vector unsigned long long);
15867 int vec_any_ge (vector long long, vector long long);
15868 int vec_any_ge (vector unsigned long long, vector unsigned long long);
15869 int vec_any_gt (vector long long, vector long long);
15870 int vec_any_gt (vector unsigned long long, vector unsigned long long);
15871 int vec_any_le (vector long long, vector long long);
15872 int vec_any_le (vector unsigned long long, vector unsigned long long);
15873 int vec_any_lt (vector long long, vector long long);
15874 int vec_any_lt (vector unsigned long long, vector unsigned long long);
15875 int vec_any_ne (vector long long, vector long long);
15876 int vec_any_ne (vector unsigned long long, vector unsigned long long);
15878 vector long long vec_eqv (vector long long, vector long long);
15879 vector long long vec_eqv (vector bool long long, vector long long);
15880 vector long long vec_eqv (vector long long, vector bool long long);
15881 vector unsigned long long vec_eqv (vector unsigned long long,
15882                                    vector unsigned long long);
15883 vector unsigned long long vec_eqv (vector bool long long,
15884                                    vector unsigned long long);
15885 vector unsigned long long vec_eqv (vector unsigned long long,
15886                                    vector bool long long);
15887 vector int vec_eqv (vector int, vector int);
15888 vector int vec_eqv (vector bool int, vector int);
15889 vector int vec_eqv (vector int, vector bool int);
15890 vector unsigned int vec_eqv (vector unsigned int, vector unsigned int);
15891 vector unsigned int vec_eqv (vector bool unsigned int,
15892                              vector unsigned int);
15893 vector unsigned int vec_eqv (vector unsigned int,
15894                              vector bool unsigned int);
15895 vector short vec_eqv (vector short, vector short);
15896 vector short vec_eqv (vector bool short, vector short);
15897 vector short vec_eqv (vector short, vector bool short);
15898 vector unsigned short vec_eqv (vector unsigned short, vector unsigned short);
15899 vector unsigned short vec_eqv (vector bool unsigned short,
15900                                vector unsigned short);
15901 vector unsigned short vec_eqv (vector unsigned short,
15902                                vector bool unsigned short);
15903 vector signed char vec_eqv (vector signed char, vector signed char);
15904 vector signed char vec_eqv (vector bool signed char, vector signed char);
15905 vector signed char vec_eqv (vector signed char, vector bool signed char);
15906 vector unsigned char vec_eqv (vector unsigned char, vector unsigned char);
15907 vector unsigned char vec_eqv (vector bool unsigned char, vector unsigned char);
15908 vector unsigned char vec_eqv (vector unsigned char, vector bool unsigned char);
15910 vector long long vec_max (vector long long, vector long long);
15911 vector unsigned long long vec_max (vector unsigned long long,
15912                                    vector unsigned long long);
15914 vector signed int vec_mergee (vector signed int, vector signed int);
15915 vector unsigned int vec_mergee (vector unsigned int, vector unsigned int);
15916 vector bool int vec_mergee (vector bool int, vector bool int);
15918 vector signed int vec_mergeo (vector signed int, vector signed int);
15919 vector unsigned int vec_mergeo (vector unsigned int, vector unsigned int);
15920 vector bool int vec_mergeo (vector bool int, vector bool int);
15922 vector long long vec_min (vector long long, vector long long);
15923 vector unsigned long long vec_min (vector unsigned long long,
15924                                    vector unsigned long long);
15926 vector long long vec_nand (vector long long, vector long long);
15927 vector long long vec_nand (vector bool long long, vector long long);
15928 vector long long vec_nand (vector long long, vector bool long long);
15929 vector unsigned long long vec_nand (vector unsigned long long,
15930                                     vector unsigned long long);
15931 vector unsigned long long vec_nand (vector bool long long,
15932                                    vector unsigned long long);
15933 vector unsigned long long vec_nand (vector unsigned long long,
15934                                     vector bool long long);
15935 vector int vec_nand (vector int, vector int);
15936 vector int vec_nand (vector bool int, vector int);
15937 vector int vec_nand (vector int, vector bool int);
15938 vector unsigned int vec_nand (vector unsigned int, vector unsigned int);
15939 vector unsigned int vec_nand (vector bool unsigned int,
15940                               vector unsigned int);
15941 vector unsigned int vec_nand (vector unsigned int,
15942                               vector bool unsigned int);
15943 vector short vec_nand (vector short, vector short);
15944 vector short vec_nand (vector bool short, vector short);
15945 vector short vec_nand (vector short, vector bool short);
15946 vector unsigned short vec_nand (vector unsigned short, vector unsigned short);
15947 vector unsigned short vec_nand (vector bool unsigned short,
15948                                 vector unsigned short);
15949 vector unsigned short vec_nand (vector unsigned short,
15950                                 vector bool unsigned short);
15951 vector signed char vec_nand (vector signed char, vector signed char);
15952 vector signed char vec_nand (vector bool signed char, vector signed char);
15953 vector signed char vec_nand (vector signed char, vector bool signed char);
15954 vector unsigned char vec_nand (vector unsigned char, vector unsigned char);
15955 vector unsigned char vec_nand (vector bool unsigned char, vector unsigned char);
15956 vector unsigned char vec_nand (vector unsigned char, vector bool unsigned char);
15958 vector long long vec_orc (vector long long, vector long long);
15959 vector long long vec_orc (vector bool long long, vector long long);
15960 vector long long vec_orc (vector long long, vector bool long long);
15961 vector unsigned long long vec_orc (vector unsigned long long,
15962                                    vector unsigned long long);
15963 vector unsigned long long vec_orc (vector bool long long,
15964                                    vector unsigned long long);
15965 vector unsigned long long vec_orc (vector unsigned long long,
15966                                    vector bool long long);
15967 vector int vec_orc (vector int, vector int);
15968 vector int vec_orc (vector bool int, vector int);
15969 vector int vec_orc (vector int, vector bool int);
15970 vector unsigned int vec_orc (vector unsigned int, vector unsigned int);
15971 vector unsigned int vec_orc (vector bool unsigned int,
15972                              vector unsigned int);
15973 vector unsigned int vec_orc (vector unsigned int,
15974                              vector bool unsigned int);
15975 vector short vec_orc (vector short, vector short);
15976 vector short vec_orc (vector bool short, vector short);
15977 vector short vec_orc (vector short, vector bool short);
15978 vector unsigned short vec_orc (vector unsigned short, vector unsigned short);
15979 vector unsigned short vec_orc (vector bool unsigned short,
15980                                vector unsigned short);
15981 vector unsigned short vec_orc (vector unsigned short,
15982                                vector bool unsigned short);
15983 vector signed char vec_orc (vector signed char, vector signed char);
15984 vector signed char vec_orc (vector bool signed char, vector signed char);
15985 vector signed char vec_orc (vector signed char, vector bool signed char);
15986 vector unsigned char vec_orc (vector unsigned char, vector unsigned char);
15987 vector unsigned char vec_orc (vector bool unsigned char, vector unsigned char);
15988 vector unsigned char vec_orc (vector unsigned char, vector bool unsigned char);
15990 vector int vec_pack (vector long long, vector long long);
15991 vector unsigned int vec_pack (vector unsigned long long,
15992                               vector unsigned long long);
15993 vector bool int vec_pack (vector bool long long, vector bool long long);
15995 vector int vec_packs (vector long long, vector long long);
15996 vector unsigned int vec_packs (vector unsigned long long,
15997                                vector unsigned long long);
15999 vector unsigned int vec_packsu (vector long long, vector long long);
16000 vector unsigned int vec_packsu (vector unsigned long long,
16001                                 vector unsigned long long);
16003 vector long long vec_rl (vector long long,
16004                          vector unsigned long long);
16005 vector long long vec_rl (vector unsigned long long,
16006                          vector unsigned long long);
16008 vector long long vec_sl (vector long long, vector unsigned long long);
16009 vector long long vec_sl (vector unsigned long long,
16010                          vector unsigned long long);
16012 vector long long vec_sr (vector long long, vector unsigned long long);
16013 vector unsigned long long char vec_sr (vector unsigned long long,
16014                                        vector unsigned long long);
16016 vector long long vec_sra (vector long long, vector unsigned long long);
16017 vector unsigned long long vec_sra (vector unsigned long long,
16018                                    vector unsigned long long);
16020 vector long long vec_sub (vector long long, vector long long);
16021 vector unsigned long long vec_sub (vector unsigned long long,
16022                                    vector unsigned long long);
16024 vector long long vec_unpackh (vector int);
16025 vector unsigned long long vec_unpackh (vector unsigned int);
16027 vector long long vec_unpackl (vector int);
16028 vector unsigned long long vec_unpackl (vector unsigned int);
16030 vector long long vec_vaddudm (vector long long, vector long long);
16031 vector long long vec_vaddudm (vector bool long long, vector long long);
16032 vector long long vec_vaddudm (vector long long, vector bool long long);
16033 vector unsigned long long vec_vaddudm (vector unsigned long long,
16034                                        vector unsigned long long);
16035 vector unsigned long long vec_vaddudm (vector bool unsigned long long,
16036                                        vector unsigned long long);
16037 vector unsigned long long vec_vaddudm (vector unsigned long long,
16038                                        vector bool unsigned long long);
16040 vector long long vec_vbpermq (vector signed char, vector signed char);
16041 vector long long vec_vbpermq (vector unsigned char, vector unsigned char);
16043 vector long long vec_cntlz (vector long long);
16044 vector unsigned long long vec_cntlz (vector unsigned long long);
16045 vector int vec_cntlz (vector int);
16046 vector unsigned int vec_cntlz (vector int);
16047 vector short vec_cntlz (vector short);
16048 vector unsigned short vec_cntlz (vector unsigned short);
16049 vector signed char vec_cntlz (vector signed char);
16050 vector unsigned char vec_cntlz (vector unsigned char);
16052 vector long long vec_vclz (vector long long);
16053 vector unsigned long long vec_vclz (vector unsigned long long);
16054 vector int vec_vclz (vector int);
16055 vector unsigned int vec_vclz (vector int);
16056 vector short vec_vclz (vector short);
16057 vector unsigned short vec_vclz (vector unsigned short);
16058 vector signed char vec_vclz (vector signed char);
16059 vector unsigned char vec_vclz (vector unsigned char);
16061 vector signed char vec_vclzb (vector signed char);
16062 vector unsigned char vec_vclzb (vector unsigned char);
16064 vector long long vec_vclzd (vector long long);
16065 vector unsigned long long vec_vclzd (vector unsigned long long);
16067 vector short vec_vclzh (vector short);
16068 vector unsigned short vec_vclzh (vector unsigned short);
16070 vector int vec_vclzw (vector int);
16071 vector unsigned int vec_vclzw (vector int);
16073 vector signed char vec_vgbbd (vector signed char);
16074 vector unsigned char vec_vgbbd (vector unsigned char);
16076 vector long long vec_vmaxsd (vector long long, vector long long);
16078 vector unsigned long long vec_vmaxud (vector unsigned long long,
16079                                       unsigned vector long long);
16081 vector long long vec_vminsd (vector long long, vector long long);
16083 vector unsigned long long vec_vminud (vector long long,
16084                                       vector long long);
16086 vector int vec_vpksdss (vector long long, vector long long);
16087 vector unsigned int vec_vpksdss (vector long long, vector long long);
16089 vector unsigned int vec_vpkudus (vector unsigned long long,
16090                                  vector unsigned long long);
16092 vector int vec_vpkudum (vector long long, vector long long);
16093 vector unsigned int vec_vpkudum (vector unsigned long long,
16094                                  vector unsigned long long);
16095 vector bool int vec_vpkudum (vector bool long long, vector bool long long);
16097 vector long long vec_vpopcnt (vector long long);
16098 vector unsigned long long vec_vpopcnt (vector unsigned long long);
16099 vector int vec_vpopcnt (vector int);
16100 vector unsigned int vec_vpopcnt (vector int);
16101 vector short vec_vpopcnt (vector short);
16102 vector unsigned short vec_vpopcnt (vector unsigned short);
16103 vector signed char vec_vpopcnt (vector signed char);
16104 vector unsigned char vec_vpopcnt (vector unsigned char);
16106 vector signed char vec_vpopcntb (vector signed char);
16107 vector unsigned char vec_vpopcntb (vector unsigned char);
16109 vector long long vec_vpopcntd (vector long long);
16110 vector unsigned long long vec_vpopcntd (vector unsigned long long);
16112 vector short vec_vpopcnth (vector short);
16113 vector unsigned short vec_vpopcnth (vector unsigned short);
16115 vector int vec_vpopcntw (vector int);
16116 vector unsigned int vec_vpopcntw (vector int);
16118 vector long long vec_vrld (vector long long, vector unsigned long long);
16119 vector unsigned long long vec_vrld (vector unsigned long long,
16120                                     vector unsigned long long);
16122 vector long long vec_vsld (vector long long, vector unsigned long long);
16123 vector long long vec_vsld (vector unsigned long long,
16124                            vector unsigned long long);
16126 vector long long vec_vsrad (vector long long, vector unsigned long long);
16127 vector unsigned long long vec_vsrad (vector unsigned long long,
16128                                      vector unsigned long long);
16130 vector long long vec_vsrd (vector long long, vector unsigned long long);
16131 vector unsigned long long char vec_vsrd (vector unsigned long long,
16132                                          vector unsigned long long);
16134 vector long long vec_vsubudm (vector long long, vector long long);
16135 vector long long vec_vsubudm (vector bool long long, vector long long);
16136 vector long long vec_vsubudm (vector long long, vector bool long long);
16137 vector unsigned long long vec_vsubudm (vector unsigned long long,
16138                                        vector unsigned long long);
16139 vector unsigned long long vec_vsubudm (vector bool long long,
16140                                        vector unsigned long long);
16141 vector unsigned long long vec_vsubudm (vector unsigned long long,
16142                                        vector bool long long);
16144 vector long long vec_vupkhsw (vector int);
16145 vector unsigned long long vec_vupkhsw (vector unsigned int);
16147 vector long long vec_vupklsw (vector int);
16148 vector unsigned long long vec_vupklsw (vector int);
16149 @end smallexample
16151 If the ISA 2.07 additions to the vector/scalar (power8-vector)
16152 instruction set is available, the following additional functions are
16153 available for 64-bit targets.  New vector types
16154 (@var{vector __int128_t} and @var{vector __uint128_t}) are available
16155 to hold the @var{__int128_t} and @var{__uint128_t} types to use these
16156 builtins.
16158 The normal vector extract, and set operations work on
16159 @var{vector __int128_t} and @var{vector __uint128_t} types,
16160 but the index value must be 0.
16162 @smallexample
16163 vector __int128_t vec_vaddcuq (vector __int128_t, vector __int128_t);
16164 vector __uint128_t vec_vaddcuq (vector __uint128_t, vector __uint128_t);
16166 vector __int128_t vec_vadduqm (vector __int128_t, vector __int128_t);
16167 vector __uint128_t vec_vadduqm (vector __uint128_t, vector __uint128_t);
16169 vector __int128_t vec_vaddecuq (vector __int128_t, vector __int128_t,
16170                                 vector __int128_t);
16171 vector __uint128_t vec_vaddecuq (vector __uint128_t, vector __uint128_t, 
16172                                  vector __uint128_t);
16174 vector __int128_t vec_vaddeuqm (vector __int128_t, vector __int128_t,
16175                                 vector __int128_t);
16176 vector __uint128_t vec_vaddeuqm (vector __uint128_t, vector __uint128_t, 
16177                                  vector __uint128_t);
16179 vector __int128_t vec_vsubecuq (vector __int128_t, vector __int128_t,
16180                                 vector __int128_t);
16181 vector __uint128_t vec_vsubecuq (vector __uint128_t, vector __uint128_t, 
16182                                  vector __uint128_t);
16184 vector __int128_t vec_vsubeuqm (vector __int128_t, vector __int128_t,
16185                                 vector __int128_t);
16186 vector __uint128_t vec_vsubeuqm (vector __uint128_t, vector __uint128_t,
16187                                  vector __uint128_t);
16189 vector __int128_t vec_vsubcuq (vector __int128_t, vector __int128_t);
16190 vector __uint128_t vec_vsubcuq (vector __uint128_t, vector __uint128_t);
16192 __int128_t vec_vsubuqm (__int128_t, __int128_t);
16193 __uint128_t vec_vsubuqm (__uint128_t, __uint128_t);
16195 vector __int128_t __builtin_bcdadd (vector __int128_t, vector__int128_t);
16196 int __builtin_bcdadd_lt (vector __int128_t, vector__int128_t);
16197 int __builtin_bcdadd_eq (vector __int128_t, vector__int128_t);
16198 int __builtin_bcdadd_gt (vector __int128_t, vector__int128_t);
16199 int __builtin_bcdadd_ov (vector __int128_t, vector__int128_t);
16200 vector __int128_t bcdsub (vector __int128_t, vector__int128_t);
16201 int __builtin_bcdsub_lt (vector __int128_t, vector__int128_t);
16202 int __builtin_bcdsub_eq (vector __int128_t, vector__int128_t);
16203 int __builtin_bcdsub_gt (vector __int128_t, vector__int128_t);
16204 int __builtin_bcdsub_ov (vector __int128_t, vector__int128_t);
16205 @end smallexample
16207 If the cryptographic instructions are enabled (@option{-mcrypto} or
16208 @option{-mcpu=power8}), the following builtins are enabled.
16210 @smallexample
16211 vector unsigned long long __builtin_crypto_vsbox (vector unsigned long long);
16213 vector unsigned long long __builtin_crypto_vcipher (vector unsigned long long,
16214                                                     vector unsigned long long);
16216 vector unsigned long long __builtin_crypto_vcipherlast
16217                                      (vector unsigned long long,
16218                                       vector unsigned long long);
16220 vector unsigned long long __builtin_crypto_vncipher (vector unsigned long long,
16221                                                      vector unsigned long long);
16223 vector unsigned long long __builtin_crypto_vncipherlast
16224                                      (vector unsigned long long,
16225                                       vector unsigned long long);
16227 vector unsigned char __builtin_crypto_vpermxor (vector unsigned char,
16228                                                 vector unsigned char,
16229                                                 vector unsigned char);
16231 vector unsigned short __builtin_crypto_vpermxor (vector unsigned short,
16232                                                  vector unsigned short,
16233                                                  vector unsigned short);
16235 vector unsigned int __builtin_crypto_vpermxor (vector unsigned int,
16236                                                vector unsigned int,
16237                                                vector unsigned int);
16239 vector unsigned long long __builtin_crypto_vpermxor (vector unsigned long long,
16240                                                      vector unsigned long long,
16241                                                      vector unsigned long long);
16243 vector unsigned char __builtin_crypto_vpmsumb (vector unsigned char,
16244                                                vector unsigned char);
16246 vector unsigned short __builtin_crypto_vpmsumb (vector unsigned short,
16247                                                 vector unsigned short);
16249 vector unsigned int __builtin_crypto_vpmsumb (vector unsigned int,
16250                                               vector unsigned int);
16252 vector unsigned long long __builtin_crypto_vpmsumb (vector unsigned long long,
16253                                                     vector unsigned long long);
16255 vector unsigned long long __builtin_crypto_vshasigmad
16256                                (vector unsigned long long, int, int);
16258 vector unsigned int __builtin_crypto_vshasigmaw (vector unsigned int,
16259                                                  int, int);
16260 @end smallexample
16262 The second argument to the @var{__builtin_crypto_vshasigmad} and
16263 @var{__builtin_crypto_vshasigmaw} builtin functions must be a constant
16264 integer that is 0 or 1.  The third argument to these builtin functions
16265 must be a constant integer in the range of 0 to 15.
16267 @node PowerPC Hardware Transactional Memory Built-in Functions
16268 @subsection PowerPC Hardware Transactional Memory Built-in Functions
16269 GCC provides two interfaces for accessing the Hardware Transactional
16270 Memory (HTM) instructions available on some of the PowerPC family
16271 of prcoessors (eg, POWER8).  The two interfaces come in a low level
16272 interface, consisting of built-in functions specific to PowerPC and a
16273 higher level interface consisting of inline functions that are common
16274 between PowerPC and S/390.
16276 @subsubsection PowerPC HTM Low Level Built-in Functions
16278 The following low level built-in functions are available with
16279 @option{-mhtm} or @option{-mcpu=CPU} where CPU is `power8' or later.
16280 They all generate the machine instruction that is part of the name.
16282 The HTM built-ins return true or false depending on their success and
16283 their arguments match exactly the type and order of the associated
16284 hardware instruction's operands.  Refer to the ISA manual for a
16285 description of each instruction's operands.
16287 @smallexample
16288 unsigned int __builtin_tbegin (unsigned int)
16289 unsigned int __builtin_tend (unsigned int)
16291 unsigned int __builtin_tabort (unsigned int)
16292 unsigned int __builtin_tabortdc (unsigned int, unsigned int, unsigned int)
16293 unsigned int __builtin_tabortdci (unsigned int, unsigned int, int)
16294 unsigned int __builtin_tabortwc (unsigned int, unsigned int, unsigned int)
16295 unsigned int __builtin_tabortwci (unsigned int, unsigned int, int)
16297 unsigned int __builtin_tcheck (unsigned int)
16298 unsigned int __builtin_treclaim (unsigned int)
16299 unsigned int __builtin_trechkpt (void)
16300 unsigned int __builtin_tsr (unsigned int)
16301 @end smallexample
16303 In addition to the above HTM built-ins, we have added built-ins for
16304 some common extended mnemonics of the HTM instructions:
16306 @smallexample
16307 unsigned int __builtin_tendall (void)
16308 unsigned int __builtin_tresume (void)
16309 unsigned int __builtin_tsuspend (void)
16310 @end smallexample
16312 The following set of built-in functions are available to gain access
16313 to the HTM specific special purpose registers.
16315 @smallexample
16316 unsigned long __builtin_get_texasr (void)
16317 unsigned long __builtin_get_texasru (void)
16318 unsigned long __builtin_get_tfhar (void)
16319 unsigned long __builtin_get_tfiar (void)
16321 void __builtin_set_texasr (unsigned long);
16322 void __builtin_set_texasru (unsigned long);
16323 void __builtin_set_tfhar (unsigned long);
16324 void __builtin_set_tfiar (unsigned long);
16325 @end smallexample
16327 Example usage of these low level built-in functions may look like:
16329 @smallexample
16330 #include <htmintrin.h>
16332 int num_retries = 10;
16334 while (1)
16335   @{
16336     if (__builtin_tbegin (0))
16337       @{
16338         /* Transaction State Initiated.  */
16339         if (is_locked (lock))
16340           __builtin_tabort (0);
16341         ... transaction code...
16342         __builtin_tend (0);
16343         break;
16344       @}
16345     else
16346       @{
16347         /* Transaction State Failed.  Use locks if the transaction
16348            failure is "persistent" or we've tried too many times.  */
16349         if (num_retries-- <= 0
16350             || _TEXASRU_FAILURE_PERSISTENT (__builtin_get_texasru ()))
16351           @{
16352             acquire_lock (lock);
16353             ... non transactional fallback path...
16354             release_lock (lock);
16355             break;
16356           @}
16357       @}
16358   @}
16359 @end smallexample
16361 One final built-in function has been added that returns the value of
16362 the 2-bit Transaction State field of the Machine Status Register (MSR)
16363 as stored in @code{CR0}.
16365 @smallexample
16366 unsigned long __builtin_ttest (void)
16367 @end smallexample
16369 This built-in can be used to determine the current transaction state
16370 using the following code example:
16372 @smallexample
16373 #include <htmintrin.h>
16375 unsigned char tx_state = _HTM_STATE (__builtin_ttest ());
16377 if (tx_state == _HTM_TRANSACTIONAL)
16378   @{
16379     /* Code to use in transactional state.  */
16380   @}
16381 else if (tx_state == _HTM_NONTRANSACTIONAL)
16382   @{
16383     /* Code to use in non-transactional state.  */
16384   @}
16385 else if (tx_state == _HTM_SUSPENDED)
16386   @{
16387     /* Code to use in transaction suspended state.  */
16388   @}
16389 @end smallexample
16391 @subsubsection PowerPC HTM High Level Inline Functions
16393 The following high level HTM interface is made available by including
16394 @code{<htmxlintrin.h>} and using @option{-mhtm} or @option{-mcpu=CPU}
16395 where CPU is `power8' or later.  This interface is common between PowerPC
16396 and S/390, allowing users to write one HTM source implementation that
16397 can be compiled and executed on either system.
16399 @smallexample
16400 long __TM_simple_begin (void)
16401 long __TM_begin (void* const TM_buff)
16402 long __TM_end (void)
16403 void __TM_abort (void)
16404 void __TM_named_abort (unsigned char const code)
16405 void __TM_resume (void)
16406 void __TM_suspend (void)
16408 long __TM_is_user_abort (void* const TM_buff)
16409 long __TM_is_named_user_abort (void* const TM_buff, unsigned char *code)
16410 long __TM_is_illegal (void* const TM_buff)
16411 long __TM_is_footprint_exceeded (void* const TM_buff)
16412 long __TM_nesting_depth (void* const TM_buff)
16413 long __TM_is_nested_too_deep(void* const TM_buff)
16414 long __TM_is_conflict(void* const TM_buff)
16415 long __TM_is_failure_persistent(void* const TM_buff)
16416 long __TM_failure_address(void* const TM_buff)
16417 long long __TM_failure_code(void* const TM_buff)
16418 @end smallexample
16420 Using these common set of HTM inline functions, we can create
16421 a more portable version of the HTM example in the previous
16422 section that will work on either PowerPC or S/390:
16424 @smallexample
16425 #include <htmxlintrin.h>
16427 int num_retries = 10;
16428 TM_buff_type TM_buff;
16430 while (1)
16431   @{
16432     if (__TM_begin (TM_buff))
16433       @{
16434         /* Transaction State Initiated.  */
16435         if (is_locked (lock))
16436           __TM_abort ();
16437         ... transaction code...
16438         __TM_end ();
16439         break;
16440       @}
16441     else
16442       @{
16443         /* Transaction State Failed.  Use locks if the transaction
16444            failure is "persistent" or we've tried too many times.  */
16445         if (num_retries-- <= 0
16446             || __TM_is_failure_persistent (TM_buff))
16447           @{
16448             acquire_lock (lock);
16449             ... non transactional fallback path...
16450             release_lock (lock);
16451             break;
16452           @}
16453       @}
16454   @}
16455 @end smallexample
16457 @node RX Built-in Functions
16458 @subsection RX Built-in Functions
16459 GCC supports some of the RX instructions which cannot be expressed in
16460 the C programming language via the use of built-in functions.  The
16461 following functions are supported:
16463 @deftypefn {Built-in Function}  void __builtin_rx_brk (void)
16464 Generates the @code{brk} machine instruction.
16465 @end deftypefn
16467 @deftypefn {Built-in Function}  void __builtin_rx_clrpsw (int)
16468 Generates the @code{clrpsw} machine instruction to clear the specified
16469 bit in the processor status word.
16470 @end deftypefn
16472 @deftypefn {Built-in Function}  void __builtin_rx_int (int)
16473 Generates the @code{int} machine instruction to generate an interrupt
16474 with the specified value.
16475 @end deftypefn
16477 @deftypefn {Built-in Function}  void __builtin_rx_machi (int, int)
16478 Generates the @code{machi} machine instruction to add the result of
16479 multiplying the top 16 bits of the two arguments into the
16480 accumulator.
16481 @end deftypefn
16483 @deftypefn {Built-in Function}  void __builtin_rx_maclo (int, int)
16484 Generates the @code{maclo} machine instruction to add the result of
16485 multiplying the bottom 16 bits of the two arguments into the
16486 accumulator.
16487 @end deftypefn
16489 @deftypefn {Built-in Function}  void __builtin_rx_mulhi (int, int)
16490 Generates the @code{mulhi} machine instruction to place the result of
16491 multiplying the top 16 bits of the two arguments into the
16492 accumulator.
16493 @end deftypefn
16495 @deftypefn {Built-in Function}  void __builtin_rx_mullo (int, int)
16496 Generates the @code{mullo} machine instruction to place the result of
16497 multiplying the bottom 16 bits of the two arguments into the
16498 accumulator.
16499 @end deftypefn
16501 @deftypefn {Built-in Function}  int  __builtin_rx_mvfachi (void)
16502 Generates the @code{mvfachi} machine instruction to read the top
16503 32 bits of the accumulator.
16504 @end deftypefn
16506 @deftypefn {Built-in Function}  int  __builtin_rx_mvfacmi (void)
16507 Generates the @code{mvfacmi} machine instruction to read the middle
16508 32 bits of the accumulator.
16509 @end deftypefn
16511 @deftypefn {Built-in Function}  int __builtin_rx_mvfc (int)
16512 Generates the @code{mvfc} machine instruction which reads the control
16513 register specified in its argument and returns its value.
16514 @end deftypefn
16516 @deftypefn {Built-in Function}  void __builtin_rx_mvtachi (int)
16517 Generates the @code{mvtachi} machine instruction to set the top
16518 32 bits of the accumulator.
16519 @end deftypefn
16521 @deftypefn {Built-in Function}  void __builtin_rx_mvtaclo (int)
16522 Generates the @code{mvtaclo} machine instruction to set the bottom
16523 32 bits of the accumulator.
16524 @end deftypefn
16526 @deftypefn {Built-in Function}  void __builtin_rx_mvtc (int reg, int val)
16527 Generates the @code{mvtc} machine instruction which sets control
16528 register number @code{reg} to @code{val}.
16529 @end deftypefn
16531 @deftypefn {Built-in Function}  void __builtin_rx_mvtipl (int)
16532 Generates the @code{mvtipl} machine instruction set the interrupt
16533 priority level.
16534 @end deftypefn
16536 @deftypefn {Built-in Function}  void __builtin_rx_racw (int)
16537 Generates the @code{racw} machine instruction to round the accumulator
16538 according to the specified mode.
16539 @end deftypefn
16541 @deftypefn {Built-in Function}  int __builtin_rx_revw (int)
16542 Generates the @code{revw} machine instruction which swaps the bytes in
16543 the argument so that bits 0--7 now occupy bits 8--15 and vice versa,
16544 and also bits 16--23 occupy bits 24--31 and vice versa.
16545 @end deftypefn
16547 @deftypefn {Built-in Function}  void __builtin_rx_rmpa (void)
16548 Generates the @code{rmpa} machine instruction which initiates a
16549 repeated multiply and accumulate sequence.
16550 @end deftypefn
16552 @deftypefn {Built-in Function}  void __builtin_rx_round (float)
16553 Generates the @code{round} machine instruction which returns the
16554 floating-point argument rounded according to the current rounding mode
16555 set in the floating-point status word register.
16556 @end deftypefn
16558 @deftypefn {Built-in Function}  int __builtin_rx_sat (int)
16559 Generates the @code{sat} machine instruction which returns the
16560 saturated value of the argument.
16561 @end deftypefn
16563 @deftypefn {Built-in Function}  void __builtin_rx_setpsw (int)
16564 Generates the @code{setpsw} machine instruction to set the specified
16565 bit in the processor status word.
16566 @end deftypefn
16568 @deftypefn {Built-in Function}  void __builtin_rx_wait (void)
16569 Generates the @code{wait} machine instruction.
16570 @end deftypefn
16572 @node S/390 System z Built-in Functions
16573 @subsection S/390 System z Built-in Functions
16574 @deftypefn {Built-in Function} int __builtin_tbegin (void*)
16575 Generates the @code{tbegin} machine instruction starting a
16576 non-constraint hardware transaction.  If the parameter is non-NULL the
16577 memory area is used to store the transaction diagnostic buffer and
16578 will be passed as first operand to @code{tbegin}.  This buffer can be
16579 defined using the @code{struct __htm_tdb} C struct defined in
16580 @code{htmintrin.h} and must reside on a double-word boundary.  The
16581 second tbegin operand is set to @code{0xff0c}. This enables
16582 save/restore of all GPRs and disables aborts for FPR and AR
16583 manipulations inside the transaction body.  The condition code set by
16584 the tbegin instruction is returned as integer value.  The tbegin
16585 instruction by definition overwrites the content of all FPRs.  The
16586 compiler will generate code which saves and restores the FPRs.  For
16587 soft-float code it is recommended to used the @code{*_nofloat}
16588 variant.  In order to prevent a TDB from being written it is required
16589 to pass an constant zero value as parameter.  Passing the zero value
16590 through a variable is not sufficient.  Although modifications of
16591 access registers inside the transaction will not trigger an
16592 transaction abort it is not supported to actually modify them.  Access
16593 registers do not get saved when entering a transaction. They will have
16594 undefined state when reaching the abort code.
16595 @end deftypefn
16597 Macros for the possible return codes of tbegin are defined in the
16598 @code{htmintrin.h} header file:
16600 @table @code
16601 @item _HTM_TBEGIN_STARTED
16602 @code{tbegin} has been executed as part of normal processing.  The
16603 transaction body is supposed to be executed.
16604 @item _HTM_TBEGIN_INDETERMINATE
16605 The transaction was aborted due to an indeterminate condition which
16606 might be persistent.
16607 @item _HTM_TBEGIN_TRANSIENT
16608 The transaction aborted due to a transient failure.  The transaction
16609 should be re-executed in that case.
16610 @item _HTM_TBEGIN_PERSISTENT
16611 The transaction aborted due to a persistent failure.  Re-execution
16612 under same circumstances will not be productive.
16613 @end table
16615 @defmac _HTM_FIRST_USER_ABORT_CODE
16616 The @code{_HTM_FIRST_USER_ABORT_CODE} defined in @code{htmintrin.h}
16617 specifies the first abort code which can be used for
16618 @code{__builtin_tabort}.  Values below this threshold are reserved for
16619 machine use.
16620 @end defmac
16622 @deftp {Data type} {struct __htm_tdb}
16623 The @code{struct __htm_tdb} defined in @code{htmintrin.h} describes
16624 the structure of the transaction diagnostic block as specified in the
16625 Principles of Operation manual chapter 5-91.
16626 @end deftp
16628 @deftypefn {Built-in Function} int __builtin_tbegin_nofloat (void*)
16629 Same as @code{__builtin_tbegin} but without FPR saves and restores.
16630 Using this variant in code making use of FPRs will leave the FPRs in
16631 undefined state when entering the transaction abort handler code.
16632 @end deftypefn
16634 @deftypefn {Built-in Function} int __builtin_tbegin_retry (void*, int)
16635 In addition to @code{__builtin_tbegin} a loop for transient failures
16636 is generated.  If tbegin returns a condition code of 2 the transaction
16637 will be retried as often as specified in the second argument.  The
16638 perform processor assist instruction is used to tell the CPU about the
16639 number of fails so far.
16640 @end deftypefn
16642 @deftypefn {Built-in Function} int __builtin_tbegin_retry_nofloat (void*, int)
16643 Same as @code{__builtin_tbegin_retry} but without FPR saves and
16644 restores.  Using this variant in code making use of FPRs will leave
16645 the FPRs in undefined state when entering the transaction abort
16646 handler code.
16647 @end deftypefn
16649 @deftypefn {Built-in Function} void __builtin_tbeginc (void)
16650 Generates the @code{tbeginc} machine instruction starting a constraint
16651 hardware transaction.  The second operand is set to @code{0xff08}.
16652 @end deftypefn
16654 @deftypefn {Built-in Function} int __builtin_tend (void)
16655 Generates the @code{tend} machine instruction finishing a transaction
16656 and making the changes visible to other threads.  The condition code
16657 generated by tend is returned as integer value.
16658 @end deftypefn
16660 @deftypefn {Built-in Function} void __builtin_tabort (int)
16661 Generates the @code{tabort} machine instruction with the specified
16662 abort code.  Abort codes from 0 through 255 are reserved and will
16663 result in an error message.
16664 @end deftypefn
16666 @deftypefn {Built-in Function} void __builtin_tx_assist (int)
16667 Generates the @code{ppa rX,rY,1} machine instruction.  Where the
16668 integer parameter is loaded into rX and a value of zero is loaded into
16669 rY.  The integer parameter specifies the number of times the
16670 transaction repeatedly aborted.
16671 @end deftypefn
16673 @deftypefn {Built-in Function} int __builtin_tx_nesting_depth (void)
16674 Generates the @code{etnd} machine instruction.  The current nesting
16675 depth is returned as integer value.  For a nesting depth of 0 the code
16676 is not executed as part of an transaction.
16677 @end deftypefn
16679 @deftypefn {Built-in Function} void __builtin_non_tx_store (uint64_t *, uint64_t)
16681 Generates the @code{ntstg} machine instruction.  The second argument
16682 is written to the first arguments location.  The store operation will
16683 not be rolled-back in case of an transaction abort.
16684 @end deftypefn
16686 @node SH Built-in Functions
16687 @subsection SH Built-in Functions
16688 The following built-in functions are supported on the SH1, SH2, SH3 and SH4
16689 families of processors:
16691 @deftypefn {Built-in Function} {void} __builtin_set_thread_pointer (void *@var{ptr})
16692 Sets the @samp{GBR} register to the specified value @var{ptr}.  This is usually
16693 used by system code that manages threads and execution contexts.  The compiler
16694 normally does not generate code that modifies the contents of @samp{GBR} and
16695 thus the value is preserved across function calls.  Changing the @samp{GBR}
16696 value in user code must be done with caution, since the compiler might use
16697 @samp{GBR} in order to access thread local variables.
16699 @end deftypefn
16701 @deftypefn {Built-in Function} {void *} __builtin_thread_pointer (void)
16702 Returns the value that is currently set in the @samp{GBR} register.
16703 Memory loads and stores that use the thread pointer as a base address are
16704 turned into @samp{GBR} based displacement loads and stores, if possible.
16705 For example:
16706 @smallexample
16707 struct my_tcb
16709    int a, b, c, d, e;
16712 int get_tcb_value (void)
16714   // Generate @samp{mov.l @@(8,gbr),r0} instruction
16715   return ((my_tcb*)__builtin_thread_pointer ())->c;
16718 @end smallexample
16719 @end deftypefn
16721 @node SPARC VIS Built-in Functions
16722 @subsection SPARC VIS Built-in Functions
16724 GCC supports SIMD operations on the SPARC using both the generic vector
16725 extensions (@pxref{Vector Extensions}) as well as built-in functions for
16726 the SPARC Visual Instruction Set (VIS).  When you use the @option{-mvis}
16727 switch, the VIS extension is exposed as the following built-in functions:
16729 @smallexample
16730 typedef int v1si __attribute__ ((vector_size (4)));
16731 typedef int v2si __attribute__ ((vector_size (8)));
16732 typedef short v4hi __attribute__ ((vector_size (8)));
16733 typedef short v2hi __attribute__ ((vector_size (4)));
16734 typedef unsigned char v8qi __attribute__ ((vector_size (8)));
16735 typedef unsigned char v4qi __attribute__ ((vector_size (4)));
16737 void __builtin_vis_write_gsr (int64_t);
16738 int64_t __builtin_vis_read_gsr (void);
16740 void * __builtin_vis_alignaddr (void *, long);
16741 void * __builtin_vis_alignaddrl (void *, long);
16742 int64_t __builtin_vis_faligndatadi (int64_t, int64_t);
16743 v2si __builtin_vis_faligndatav2si (v2si, v2si);
16744 v4hi __builtin_vis_faligndatav4hi (v4si, v4si);
16745 v8qi __builtin_vis_faligndatav8qi (v8qi, v8qi);
16747 v4hi __builtin_vis_fexpand (v4qi);
16749 v4hi __builtin_vis_fmul8x16 (v4qi, v4hi);
16750 v4hi __builtin_vis_fmul8x16au (v4qi, v2hi);
16751 v4hi __builtin_vis_fmul8x16al (v4qi, v2hi);
16752 v4hi __builtin_vis_fmul8sux16 (v8qi, v4hi);
16753 v4hi __builtin_vis_fmul8ulx16 (v8qi, v4hi);
16754 v2si __builtin_vis_fmuld8sux16 (v4qi, v2hi);
16755 v2si __builtin_vis_fmuld8ulx16 (v4qi, v2hi);
16757 v4qi __builtin_vis_fpack16 (v4hi);
16758 v8qi __builtin_vis_fpack32 (v2si, v8qi);
16759 v2hi __builtin_vis_fpackfix (v2si);
16760 v8qi __builtin_vis_fpmerge (v4qi, v4qi);
16762 int64_t __builtin_vis_pdist (v8qi, v8qi, int64_t);
16764 long __builtin_vis_edge8 (void *, void *);
16765 long __builtin_vis_edge8l (void *, void *);
16766 long __builtin_vis_edge16 (void *, void *);
16767 long __builtin_vis_edge16l (void *, void *);
16768 long __builtin_vis_edge32 (void *, void *);
16769 long __builtin_vis_edge32l (void *, void *);
16771 long __builtin_vis_fcmple16 (v4hi, v4hi);
16772 long __builtin_vis_fcmple32 (v2si, v2si);
16773 long __builtin_vis_fcmpne16 (v4hi, v4hi);
16774 long __builtin_vis_fcmpne32 (v2si, v2si);
16775 long __builtin_vis_fcmpgt16 (v4hi, v4hi);
16776 long __builtin_vis_fcmpgt32 (v2si, v2si);
16777 long __builtin_vis_fcmpeq16 (v4hi, v4hi);
16778 long __builtin_vis_fcmpeq32 (v2si, v2si);
16780 v4hi __builtin_vis_fpadd16 (v4hi, v4hi);
16781 v2hi __builtin_vis_fpadd16s (v2hi, v2hi);
16782 v2si __builtin_vis_fpadd32 (v2si, v2si);
16783 v1si __builtin_vis_fpadd32s (v1si, v1si);
16784 v4hi __builtin_vis_fpsub16 (v4hi, v4hi);
16785 v2hi __builtin_vis_fpsub16s (v2hi, v2hi);
16786 v2si __builtin_vis_fpsub32 (v2si, v2si);
16787 v1si __builtin_vis_fpsub32s (v1si, v1si);
16789 long __builtin_vis_array8 (long, long);
16790 long __builtin_vis_array16 (long, long);
16791 long __builtin_vis_array32 (long, long);
16792 @end smallexample
16794 When you use the @option{-mvis2} switch, the VIS version 2.0 built-in
16795 functions also become available:
16797 @smallexample
16798 long __builtin_vis_bmask (long, long);
16799 int64_t __builtin_vis_bshuffledi (int64_t, int64_t);
16800 v2si __builtin_vis_bshufflev2si (v2si, v2si);
16801 v4hi __builtin_vis_bshufflev2si (v4hi, v4hi);
16802 v8qi __builtin_vis_bshufflev2si (v8qi, v8qi);
16804 long __builtin_vis_edge8n (void *, void *);
16805 long __builtin_vis_edge8ln (void *, void *);
16806 long __builtin_vis_edge16n (void *, void *);
16807 long __builtin_vis_edge16ln (void *, void *);
16808 long __builtin_vis_edge32n (void *, void *);
16809 long __builtin_vis_edge32ln (void *, void *);
16810 @end smallexample
16812 When you use the @option{-mvis3} switch, the VIS version 3.0 built-in
16813 functions also become available:
16815 @smallexample
16816 void __builtin_vis_cmask8 (long);
16817 void __builtin_vis_cmask16 (long);
16818 void __builtin_vis_cmask32 (long);
16820 v4hi __builtin_vis_fchksm16 (v4hi, v4hi);
16822 v4hi __builtin_vis_fsll16 (v4hi, v4hi);
16823 v4hi __builtin_vis_fslas16 (v4hi, v4hi);
16824 v4hi __builtin_vis_fsrl16 (v4hi, v4hi);
16825 v4hi __builtin_vis_fsra16 (v4hi, v4hi);
16826 v2si __builtin_vis_fsll16 (v2si, v2si);
16827 v2si __builtin_vis_fslas16 (v2si, v2si);
16828 v2si __builtin_vis_fsrl16 (v2si, v2si);
16829 v2si __builtin_vis_fsra16 (v2si, v2si);
16831 long __builtin_vis_pdistn (v8qi, v8qi);
16833 v4hi __builtin_vis_fmean16 (v4hi, v4hi);
16835 int64_t __builtin_vis_fpadd64 (int64_t, int64_t);
16836 int64_t __builtin_vis_fpsub64 (int64_t, int64_t);
16838 v4hi __builtin_vis_fpadds16 (v4hi, v4hi);
16839 v2hi __builtin_vis_fpadds16s (v2hi, v2hi);
16840 v4hi __builtin_vis_fpsubs16 (v4hi, v4hi);
16841 v2hi __builtin_vis_fpsubs16s (v2hi, v2hi);
16842 v2si __builtin_vis_fpadds32 (v2si, v2si);
16843 v1si __builtin_vis_fpadds32s (v1si, v1si);
16844 v2si __builtin_vis_fpsubs32 (v2si, v2si);
16845 v1si __builtin_vis_fpsubs32s (v1si, v1si);
16847 long __builtin_vis_fucmple8 (v8qi, v8qi);
16848 long __builtin_vis_fucmpne8 (v8qi, v8qi);
16849 long __builtin_vis_fucmpgt8 (v8qi, v8qi);
16850 long __builtin_vis_fucmpeq8 (v8qi, v8qi);
16852 float __builtin_vis_fhadds (float, float);
16853 double __builtin_vis_fhaddd (double, double);
16854 float __builtin_vis_fhsubs (float, float);
16855 double __builtin_vis_fhsubd (double, double);
16856 float __builtin_vis_fnhadds (float, float);
16857 double __builtin_vis_fnhaddd (double, double);
16859 int64_t __builtin_vis_umulxhi (int64_t, int64_t);
16860 int64_t __builtin_vis_xmulx (int64_t, int64_t);
16861 int64_t __builtin_vis_xmulxhi (int64_t, int64_t);
16862 @end smallexample
16864 @node SPU Built-in Functions
16865 @subsection SPU Built-in Functions
16867 GCC provides extensions for the SPU processor as described in the
16868 Sony/Toshiba/IBM SPU Language Extensions Specification, which can be
16869 found at @uref{http://cell.scei.co.jp/} or
16870 @uref{http://www.ibm.com/developerworks/power/cell/}.  GCC's
16871 implementation differs in several ways.
16873 @itemize @bullet
16875 @item
16876 The optional extension of specifying vector constants in parentheses is
16877 not supported.
16879 @item
16880 A vector initializer requires no cast if the vector constant is of the
16881 same type as the variable it is initializing.
16883 @item
16884 If @code{signed} or @code{unsigned} is omitted, the signedness of the
16885 vector type is the default signedness of the base type.  The default
16886 varies depending on the operating system, so a portable program should
16887 always specify the signedness.
16889 @item
16890 By default, the keyword @code{__vector} is added. The macro
16891 @code{vector} is defined in @code{<spu_intrinsics.h>} and can be
16892 undefined.
16894 @item
16895 GCC allows using a @code{typedef} name as the type specifier for a
16896 vector type.
16898 @item
16899 For C, overloaded functions are implemented with macros so the following
16900 does not work:
16902 @smallexample
16903   spu_add ((vector signed int)@{1, 2, 3, 4@}, foo);
16904 @end smallexample
16906 @noindent
16907 Since @code{spu_add} is a macro, the vector constant in the example
16908 is treated as four separate arguments.  Wrap the entire argument in
16909 parentheses for this to work.
16911 @item
16912 The extended version of @code{__builtin_expect} is not supported.
16914 @end itemize
16916 @emph{Note:} Only the interface described in the aforementioned
16917 specification is supported. Internally, GCC uses built-in functions to
16918 implement the required functionality, but these are not supported and
16919 are subject to change without notice.
16921 @node TI C6X Built-in Functions
16922 @subsection TI C6X Built-in Functions
16924 GCC provides intrinsics to access certain instructions of the TI C6X
16925 processors.  These intrinsics, listed below, are available after
16926 inclusion of the @code{c6x_intrinsics.h} header file.  They map directly
16927 to C6X instructions.
16929 @smallexample
16931 int _sadd (int, int)
16932 int _ssub (int, int)
16933 int _sadd2 (int, int)
16934 int _ssub2 (int, int)
16935 long long _mpy2 (int, int)
16936 long long _smpy2 (int, int)
16937 int _add4 (int, int)
16938 int _sub4 (int, int)
16939 int _saddu4 (int, int)
16941 int _smpy (int, int)
16942 int _smpyh (int, int)
16943 int _smpyhl (int, int)
16944 int _smpylh (int, int)
16946 int _sshl (int, int)
16947 int _subc (int, int)
16949 int _avg2 (int, int)
16950 int _avgu4 (int, int)
16952 int _clrr (int, int)
16953 int _extr (int, int)
16954 int _extru (int, int)
16955 int _abs (int)
16956 int _abs2 (int)
16958 @end smallexample
16960 @node TILE-Gx Built-in Functions
16961 @subsection TILE-Gx Built-in Functions
16963 GCC provides intrinsics to access every instruction of the TILE-Gx
16964 processor.  The intrinsics are of the form:
16966 @smallexample
16968 unsigned long long __insn_@var{op} (...)
16970 @end smallexample
16972 Where @var{op} is the name of the instruction.  Refer to the ISA manual
16973 for the complete list of instructions.
16975 GCC also provides intrinsics to directly access the network registers.
16976 The intrinsics are:
16978 @smallexample
16980 unsigned long long __tile_idn0_receive (void)
16981 unsigned long long __tile_idn1_receive (void)
16982 unsigned long long __tile_udn0_receive (void)
16983 unsigned long long __tile_udn1_receive (void)
16984 unsigned long long __tile_udn2_receive (void)
16985 unsigned long long __tile_udn3_receive (void)
16986 void __tile_idn_send (unsigned long long)
16987 void __tile_udn_send (unsigned long long)
16989 @end smallexample
16991 The intrinsic @code{void __tile_network_barrier (void)} is used to
16992 guarantee that no network operations before it are reordered with
16993 those after it.
16995 @node TILEPro Built-in Functions
16996 @subsection TILEPro Built-in Functions
16998 GCC provides intrinsics to access every instruction of the TILEPro
16999 processor.  The intrinsics are of the form:
17001 @smallexample
17003 unsigned __insn_@var{op} (...)
17005 @end smallexample
17007 @noindent
17008 where @var{op} is the name of the instruction.  Refer to the ISA manual
17009 for the complete list of instructions.
17011 GCC also provides intrinsics to directly access the network registers.
17012 The intrinsics are:
17014 @smallexample
17016 unsigned __tile_idn0_receive (void)
17017 unsigned __tile_idn1_receive (void)
17018 unsigned __tile_sn_receive (void)
17019 unsigned __tile_udn0_receive (void)
17020 unsigned __tile_udn1_receive (void)
17021 unsigned __tile_udn2_receive (void)
17022 unsigned __tile_udn3_receive (void)
17023 void __tile_idn_send (unsigned)
17024 void __tile_sn_send (unsigned)
17025 void __tile_udn_send (unsigned)
17027 @end smallexample
17029 The intrinsic @code{void __tile_network_barrier (void)} is used to
17030 guarantee that no network operations before it are reordered with
17031 those after it.
17033 @node Target Format Checks
17034 @section Format Checks Specific to Particular Target Machines
17036 For some target machines, GCC supports additional options to the
17037 format attribute
17038 (@pxref{Function Attributes,,Declaring Attributes of Functions}).
17040 @menu
17041 * Solaris Format Checks::
17042 * Darwin Format Checks::
17043 @end menu
17045 @node Solaris Format Checks
17046 @subsection Solaris Format Checks
17048 Solaris targets support the @code{cmn_err} (or @code{__cmn_err__}) format
17049 check.  @code{cmn_err} accepts a subset of the standard @code{printf}
17050 conversions, and the two-argument @code{%b} conversion for displaying
17051 bit-fields.  See the Solaris man page for @code{cmn_err} for more information.
17053 @node Darwin Format Checks
17054 @subsection Darwin Format Checks
17056 Darwin targets support the @code{CFString} (or @code{__CFString__}) in the format
17057 attribute context.  Declarations made with such attribution are parsed for correct syntax
17058 and format argument types.  However, parsing of the format string itself is currently undefined
17059 and is not carried out by this version of the compiler.
17061 Additionally, @code{CFStringRefs} (defined by the @code{CoreFoundation} headers) may
17062 also be used as format arguments.  Note that the relevant headers are only likely to be
17063 available on Darwin (OSX) installations.  On such installations, the XCode and system
17064 documentation provide descriptions of @code{CFString}, @code{CFStringRefs} and
17065 associated functions.
17067 @node Pragmas
17068 @section Pragmas Accepted by GCC
17069 @cindex pragmas
17070 @cindex @code{#pragma}
17072 GCC supports several types of pragmas, primarily in order to compile
17073 code originally written for other compilers.  Note that in general
17074 we do not recommend the use of pragmas; @xref{Function Attributes},
17075 for further explanation.
17077 @menu
17078 * ARM Pragmas::
17079 * M32C Pragmas::
17080 * MeP Pragmas::
17081 * RS/6000 and PowerPC Pragmas::
17082 * Darwin Pragmas::
17083 * Solaris Pragmas::
17084 * Symbol-Renaming Pragmas::
17085 * Structure-Packing Pragmas::
17086 * Weak Pragmas::
17087 * Diagnostic Pragmas::
17088 * Visibility Pragmas::
17089 * Push/Pop Macro Pragmas::
17090 * Function Specific Option Pragmas::
17091 * Loop-Specific Pragmas::
17092 @end menu
17094 @node ARM Pragmas
17095 @subsection ARM Pragmas
17097 The ARM target defines pragmas for controlling the default addition of
17098 @code{long_call} and @code{short_call} attributes to functions.
17099 @xref{Function Attributes}, for information about the effects of these
17100 attributes.
17102 @table @code
17103 @item long_calls
17104 @cindex pragma, long_calls
17105 Set all subsequent functions to have the @code{long_call} attribute.
17107 @item no_long_calls
17108 @cindex pragma, no_long_calls
17109 Set all subsequent functions to have the @code{short_call} attribute.
17111 @item long_calls_off
17112 @cindex pragma, long_calls_off
17113 Do not affect the @code{long_call} or @code{short_call} attributes of
17114 subsequent functions.
17115 @end table
17117 @node M32C Pragmas
17118 @subsection M32C Pragmas
17120 @table @code
17121 @item GCC memregs @var{number}
17122 @cindex pragma, memregs
17123 Overrides the command-line option @code{-memregs=} for the current
17124 file.  Use with care!  This pragma must be before any function in the
17125 file, and mixing different memregs values in different objects may
17126 make them incompatible.  This pragma is useful when a
17127 performance-critical function uses a memreg for temporary values,
17128 as it may allow you to reduce the number of memregs used.
17130 @item ADDRESS @var{name} @var{address}
17131 @cindex pragma, address
17132 For any declared symbols matching @var{name}, this does three things
17133 to that symbol: it forces the symbol to be located at the given
17134 address (a number), it forces the symbol to be volatile, and it
17135 changes the symbol's scope to be static.  This pragma exists for
17136 compatibility with other compilers, but note that the common
17137 @code{1234H} numeric syntax is not supported (use @code{0x1234}
17138 instead).  Example:
17140 @smallexample
17141 #pragma ADDRESS port3 0x103
17142 char port3;
17143 @end smallexample
17145 @end table
17147 @node MeP Pragmas
17148 @subsection MeP Pragmas
17150 @table @code
17152 @item custom io_volatile (on|off)
17153 @cindex pragma, custom io_volatile
17154 Overrides the command-line option @code{-mio-volatile} for the current
17155 file.  Note that for compatibility with future GCC releases, this
17156 option should only be used once before any @code{io} variables in each
17157 file.
17159 @item GCC coprocessor available @var{registers}
17160 @cindex pragma, coprocessor available
17161 Specifies which coprocessor registers are available to the register
17162 allocator.  @var{registers} may be a single register, register range
17163 separated by ellipses, or comma-separated list of those.  Example:
17165 @smallexample
17166 #pragma GCC coprocessor available $c0...$c10, $c28
17167 @end smallexample
17169 @item GCC coprocessor call_saved @var{registers}
17170 @cindex pragma, coprocessor call_saved
17171 Specifies which coprocessor registers are to be saved and restored by
17172 any function using them.  @var{registers} may be a single register,
17173 register range separated by ellipses, or comma-separated list of
17174 those.  Example:
17176 @smallexample
17177 #pragma GCC coprocessor call_saved $c4...$c6, $c31
17178 @end smallexample
17180 @item GCC coprocessor subclass '(A|B|C|D)' = @var{registers}
17181 @cindex pragma, coprocessor subclass
17182 Creates and defines a register class.  These register classes can be
17183 used by inline @code{asm} constructs.  @var{registers} may be a single
17184 register, register range separated by ellipses, or comma-separated
17185 list of those.  Example:
17187 @smallexample
17188 #pragma GCC coprocessor subclass 'B' = $c2, $c4, $c6
17190 asm ("cpfoo %0" : "=B" (x));
17191 @end smallexample
17193 @item GCC disinterrupt @var{name} , @var{name} @dots{}
17194 @cindex pragma, disinterrupt
17195 For the named functions, the compiler adds code to disable interrupts
17196 for the duration of those functions.  If any functions so named 
17197 are not encountered in the source, a warning is emitted that the pragma is
17198 not used.  Examples:
17200 @smallexample
17201 #pragma disinterrupt foo
17202 #pragma disinterrupt bar, grill
17203 int foo () @{ @dots{} @}
17204 @end smallexample
17206 @item GCC call @var{name} , @var{name} @dots{}
17207 @cindex pragma, call
17208 For the named functions, the compiler always uses a register-indirect
17209 call model when calling the named functions.  Examples:
17211 @smallexample
17212 extern int foo ();
17213 #pragma call foo
17214 @end smallexample
17216 @end table
17218 @node RS/6000 and PowerPC Pragmas
17219 @subsection RS/6000 and PowerPC Pragmas
17221 The RS/6000 and PowerPC targets define one pragma for controlling
17222 whether or not the @code{longcall} attribute is added to function
17223 declarations by default.  This pragma overrides the @option{-mlongcall}
17224 option, but not the @code{longcall} and @code{shortcall} attributes.
17225 @xref{RS/6000 and PowerPC Options}, for more information about when long
17226 calls are and are not necessary.
17228 @table @code
17229 @item longcall (1)
17230 @cindex pragma, longcall
17231 Apply the @code{longcall} attribute to all subsequent function
17232 declarations.
17234 @item longcall (0)
17235 Do not apply the @code{longcall} attribute to subsequent function
17236 declarations.
17237 @end table
17239 @c Describe h8300 pragmas here.
17240 @c Describe sh pragmas here.
17241 @c Describe v850 pragmas here.
17243 @node Darwin Pragmas
17244 @subsection Darwin Pragmas
17246 The following pragmas are available for all architectures running the
17247 Darwin operating system.  These are useful for compatibility with other
17248 Mac OS compilers.
17250 @table @code
17251 @item mark @var{tokens}@dots{}
17252 @cindex pragma, mark
17253 This pragma is accepted, but has no effect.
17255 @item options align=@var{alignment}
17256 @cindex pragma, options align
17257 This pragma sets the alignment of fields in structures.  The values of
17258 @var{alignment} may be @code{mac68k}, to emulate m68k alignment, or
17259 @code{power}, to emulate PowerPC alignment.  Uses of this pragma nest
17260 properly; to restore the previous setting, use @code{reset} for the
17261 @var{alignment}.
17263 @item segment @var{tokens}@dots{}
17264 @cindex pragma, segment
17265 This pragma is accepted, but has no effect.
17267 @item unused (@var{var} [, @var{var}]@dots{})
17268 @cindex pragma, unused
17269 This pragma declares variables to be possibly unused.  GCC does not
17270 produce warnings for the listed variables.  The effect is similar to
17271 that of the @code{unused} attribute, except that this pragma may appear
17272 anywhere within the variables' scopes.
17273 @end table
17275 @node Solaris Pragmas
17276 @subsection Solaris Pragmas
17278 The Solaris target supports @code{#pragma redefine_extname}
17279 (@pxref{Symbol-Renaming Pragmas}).  It also supports additional
17280 @code{#pragma} directives for compatibility with the system compiler.
17282 @table @code
17283 @item align @var{alignment} (@var{variable} [, @var{variable}]...)
17284 @cindex pragma, align
17286 Increase the minimum alignment of each @var{variable} to @var{alignment}.
17287 This is the same as GCC's @code{aligned} attribute @pxref{Variable
17288 Attributes}).  Macro expansion occurs on the arguments to this pragma
17289 when compiling C and Objective-C@.  It does not currently occur when
17290 compiling C++, but this is a bug which may be fixed in a future
17291 release.
17293 @item fini (@var{function} [, @var{function}]...)
17294 @cindex pragma, fini
17296 This pragma causes each listed @var{function} to be called after
17297 main, or during shared module unloading, by adding a call to the
17298 @code{.fini} section.
17300 @item init (@var{function} [, @var{function}]...)
17301 @cindex pragma, init
17303 This pragma causes each listed @var{function} to be called during
17304 initialization (before @code{main}) or during shared module loading, by
17305 adding a call to the @code{.init} section.
17307 @end table
17309 @node Symbol-Renaming Pragmas
17310 @subsection Symbol-Renaming Pragmas
17312 For compatibility with the Solaris system headers, GCC
17313 supports two @code{#pragma} directives that change the name used in
17314 assembly for a given declaration. To get this effect
17315 on all platforms supported by GCC, use the asm labels extension (@pxref{Asm
17316 Labels}).
17318 @table @code
17319 @item redefine_extname @var{oldname} @var{newname}
17320 @cindex pragma, redefine_extname
17322 This pragma gives the C function @var{oldname} the assembly symbol
17323 @var{newname}.  The preprocessor macro @code{__PRAGMA_REDEFINE_EXTNAME}
17324 is defined if this pragma is available (currently on all platforms).
17325 @end table
17327 This pragma and the asm labels extension interact in a complicated
17328 manner.  Here are some corner cases you may want to be aware of.
17330 @enumerate
17331 @item Both pragmas silently apply only to declarations with external
17332 linkage.  Asm labels do not have this restriction.
17334 @item In C++, both pragmas silently apply only to declarations with
17335 ``C'' linkage.  Again, asm labels do not have this restriction.
17337 @item If any of the three ways of changing the assembly name of a
17338 declaration is applied to a declaration whose assembly name has
17339 already been determined (either by a previous use of one of these
17340 features, or because the compiler needed the assembly name in order to
17341 generate code), and the new name is different, a warning issues and
17342 the name does not change.
17344 @item The @var{oldname} used by @code{#pragma redefine_extname} is
17345 always the C-language name.
17346 @end enumerate
17348 @node Structure-Packing Pragmas
17349 @subsection Structure-Packing Pragmas
17351 For compatibility with Microsoft Windows compilers, GCC supports a
17352 set of @code{#pragma} directives that change the maximum alignment of
17353 members of structures (other than zero-width bit-fields), unions, and
17354 classes subsequently defined. The @var{n} value below always is required
17355 to be a small power of two and specifies the new alignment in bytes.
17357 @enumerate
17358 @item @code{#pragma pack(@var{n})} simply sets the new alignment.
17359 @item @code{#pragma pack()} sets the alignment to the one that was in
17360 effect when compilation started (see also command-line option
17361 @option{-fpack-struct[=@var{n}]} @pxref{Code Gen Options}).
17362 @item @code{#pragma pack(push[,@var{n}])} pushes the current alignment
17363 setting on an internal stack and then optionally sets the new alignment.
17364 @item @code{#pragma pack(pop)} restores the alignment setting to the one
17365 saved at the top of the internal stack (and removes that stack entry).
17366 Note that @code{#pragma pack([@var{n}])} does not influence this internal
17367 stack; thus it is possible to have @code{#pragma pack(push)} followed by
17368 multiple @code{#pragma pack(@var{n})} instances and finalized by a single
17369 @code{#pragma pack(pop)}.
17370 @end enumerate
17372 Some targets, e.g.@: i386 and PowerPC, support the @code{ms_struct}
17373 @code{#pragma} which lays out a structure as the documented
17374 @code{__attribute__ ((ms_struct))}.
17375 @enumerate
17376 @item @code{#pragma ms_struct on} turns on the layout for structures
17377 declared.
17378 @item @code{#pragma ms_struct off} turns off the layout for structures
17379 declared.
17380 @item @code{#pragma ms_struct reset} goes back to the default layout.
17381 @end enumerate
17383 @node Weak Pragmas
17384 @subsection Weak Pragmas
17386 For compatibility with SVR4, GCC supports a set of @code{#pragma}
17387 directives for declaring symbols to be weak, and defining weak
17388 aliases.
17390 @table @code
17391 @item #pragma weak @var{symbol}
17392 @cindex pragma, weak
17393 This pragma declares @var{symbol} to be weak, as if the declaration
17394 had the attribute of the same name.  The pragma may appear before
17395 or after the declaration of @var{symbol}.  It is not an error for
17396 @var{symbol} to never be defined at all.
17398 @item #pragma weak @var{symbol1} = @var{symbol2}
17399 This pragma declares @var{symbol1} to be a weak alias of @var{symbol2}.
17400 It is an error if @var{symbol2} is not defined in the current
17401 translation unit.
17402 @end table
17404 @node Diagnostic Pragmas
17405 @subsection Diagnostic Pragmas
17407 GCC allows the user to selectively enable or disable certain types of
17408 diagnostics, and change the kind of the diagnostic.  For example, a
17409 project's policy might require that all sources compile with
17410 @option{-Werror} but certain files might have exceptions allowing
17411 specific types of warnings.  Or, a project might selectively enable
17412 diagnostics and treat them as errors depending on which preprocessor
17413 macros are defined.
17415 @table @code
17416 @item #pragma GCC diagnostic @var{kind} @var{option}
17417 @cindex pragma, diagnostic
17419 Modifies the disposition of a diagnostic.  Note that not all
17420 diagnostics are modifiable; at the moment only warnings (normally
17421 controlled by @samp{-W@dots{}}) can be controlled, and not all of them.
17422 Use @option{-fdiagnostics-show-option} to determine which diagnostics
17423 are controllable and which option controls them.
17425 @var{kind} is @samp{error} to treat this diagnostic as an error,
17426 @samp{warning} to treat it like a warning (even if @option{-Werror} is
17427 in effect), or @samp{ignored} if the diagnostic is to be ignored.
17428 @var{option} is a double quoted string that matches the command-line
17429 option.
17431 @smallexample
17432 #pragma GCC diagnostic warning "-Wformat"
17433 #pragma GCC diagnostic error "-Wformat"
17434 #pragma GCC diagnostic ignored "-Wformat"
17435 @end smallexample
17437 Note that these pragmas override any command-line options.  GCC keeps
17438 track of the location of each pragma, and issues diagnostics according
17439 to the state as of that point in the source file.  Thus, pragmas occurring
17440 after a line do not affect diagnostics caused by that line.
17442 @item #pragma GCC diagnostic push
17443 @itemx #pragma GCC diagnostic pop
17445 Causes GCC to remember the state of the diagnostics as of each
17446 @code{push}, and restore to that point at each @code{pop}.  If a
17447 @code{pop} has no matching @code{push}, the command-line options are
17448 restored.
17450 @smallexample
17451 #pragma GCC diagnostic error "-Wuninitialized"
17452   foo(a);                       /* error is given for this one */
17453 #pragma GCC diagnostic push
17454 #pragma GCC diagnostic ignored "-Wuninitialized"
17455   foo(b);                       /* no diagnostic for this one */
17456 #pragma GCC diagnostic pop
17457   foo(c);                       /* error is given for this one */
17458 #pragma GCC diagnostic pop
17459   foo(d);                       /* depends on command-line options */
17460 @end smallexample
17462 @end table
17464 GCC also offers a simple mechanism for printing messages during
17465 compilation.
17467 @table @code
17468 @item #pragma message @var{string}
17469 @cindex pragma, diagnostic
17471 Prints @var{string} as a compiler message on compilation.  The message
17472 is informational only, and is neither a compilation warning nor an error.
17474 @smallexample
17475 #pragma message "Compiling " __FILE__ "..."
17476 @end smallexample
17478 @var{string} may be parenthesized, and is printed with location
17479 information.  For example,
17481 @smallexample
17482 #define DO_PRAGMA(x) _Pragma (#x)
17483 #define TODO(x) DO_PRAGMA(message ("TODO - " #x))
17485 TODO(Remember to fix this)
17486 @end smallexample
17488 @noindent
17489 prints @samp{/tmp/file.c:4: note: #pragma message:
17490 TODO - Remember to fix this}.
17492 @end table
17494 @node Visibility Pragmas
17495 @subsection Visibility Pragmas
17497 @table @code
17498 @item #pragma GCC visibility push(@var{visibility})
17499 @itemx #pragma GCC visibility pop
17500 @cindex pragma, visibility
17502 This pragma allows the user to set the visibility for multiple
17503 declarations without having to give each a visibility attribute
17504 @xref{Function Attributes}, for more information about visibility and
17505 the attribute syntax.
17507 In C++, @samp{#pragma GCC visibility} affects only namespace-scope
17508 declarations.  Class members and template specializations are not
17509 affected; if you want to override the visibility for a particular
17510 member or instantiation, you must use an attribute.
17512 @end table
17515 @node Push/Pop Macro Pragmas
17516 @subsection Push/Pop Macro Pragmas
17518 For compatibility with Microsoft Windows compilers, GCC supports
17519 @samp{#pragma push_macro(@var{"macro_name"})}
17520 and @samp{#pragma pop_macro(@var{"macro_name"})}.
17522 @table @code
17523 @item #pragma push_macro(@var{"macro_name"})
17524 @cindex pragma, push_macro
17525 This pragma saves the value of the macro named as @var{macro_name} to
17526 the top of the stack for this macro.
17528 @item #pragma pop_macro(@var{"macro_name"})
17529 @cindex pragma, pop_macro
17530 This pragma sets the value of the macro named as @var{macro_name} to
17531 the value on top of the stack for this macro. If the stack for
17532 @var{macro_name} is empty, the value of the macro remains unchanged.
17533 @end table
17535 For example:
17537 @smallexample
17538 #define X  1
17539 #pragma push_macro("X")
17540 #undef X
17541 #define X -1
17542 #pragma pop_macro("X")
17543 int x [X];
17544 @end smallexample
17546 @noindent
17547 In this example, the definition of X as 1 is saved by @code{#pragma
17548 push_macro} and restored by @code{#pragma pop_macro}.
17550 @node Function Specific Option Pragmas
17551 @subsection Function Specific Option Pragmas
17553 @table @code
17554 @item #pragma GCC target (@var{"string"}...)
17555 @cindex pragma GCC target
17557 This pragma allows you to set target specific options for functions
17558 defined later in the source file.  One or more strings can be
17559 specified.  Each function that is defined after this point is as
17560 if @code{attribute((target("STRING")))} was specified for that
17561 function.  The parenthesis around the options is optional.
17562 @xref{Function Attributes}, for more information about the
17563 @code{target} attribute and the attribute syntax.
17565 The @code{#pragma GCC target} pragma is presently implemented for
17566 i386/x86_64, PowerPC, and Nios II targets only.
17567 @end table
17569 @table @code
17570 @item #pragma GCC optimize (@var{"string"}...)
17571 @cindex pragma GCC optimize
17573 This pragma allows you to set global optimization options for functions
17574 defined later in the source file.  One or more strings can be
17575 specified.  Each function that is defined after this point is as
17576 if @code{attribute((optimize("STRING")))} was specified for that
17577 function.  The parenthesis around the options is optional.
17578 @xref{Function Attributes}, for more information about the
17579 @code{optimize} attribute and the attribute syntax.
17581 The @samp{#pragma GCC optimize} pragma is not implemented in GCC
17582 versions earlier than 4.4.
17583 @end table
17585 @table @code
17586 @item #pragma GCC push_options
17587 @itemx #pragma GCC pop_options
17588 @cindex pragma GCC push_options
17589 @cindex pragma GCC pop_options
17591 These pragmas maintain a stack of the current target and optimization
17592 options.  It is intended for include files where you temporarily want
17593 to switch to using a different @samp{#pragma GCC target} or
17594 @samp{#pragma GCC optimize} and then to pop back to the previous
17595 options.
17597 The @samp{#pragma GCC push_options} and @samp{#pragma GCC pop_options}
17598 pragmas are not implemented in GCC versions earlier than 4.4.
17599 @end table
17601 @table @code
17602 @item #pragma GCC reset_options
17603 @cindex pragma GCC reset_options
17605 This pragma clears the current @code{#pragma GCC target} and
17606 @code{#pragma GCC optimize} to use the default switches as specified
17607 on the command line.
17609 The @samp{#pragma GCC reset_options} pragma is not implemented in GCC
17610 versions earlier than 4.4.
17611 @end table
17613 @node Loop-Specific Pragmas
17614 @subsection Loop-Specific Pragmas
17616 @table @code
17617 @item #pragma GCC ivdep
17618 @cindex pragma GCC ivdep
17619 @end table
17621 With this pragma, the programmer asserts that there are no loop-carried
17622 dependencies which would prevent that consecutive iterations of
17623 the following loop can be executed concurrently with SIMD
17624 (single instruction multiple data) instructions.
17626 For example, the compiler can only unconditionally vectorize the following
17627 loop with the pragma:
17629 @smallexample
17630 void foo (int n, int *a, int *b, int *c)
17632   int i, j;
17633 #pragma GCC ivdep
17634   for (i = 0; i < n; ++i)
17635     a[i] = b[i] + c[i];
17637 @end smallexample
17639 @noindent
17640 In this example, using the @code{restrict} qualifier had the same
17641 effect. In the following example, that would not be possible. Assume
17642 @math{k < -m} or @math{k >= m}. Only with the pragma, the compiler knows
17643 that it can unconditionally vectorize the following loop:
17645 @smallexample
17646 void ignore_vec_dep (int *a, int k, int c, int m)
17648 #pragma GCC ivdep
17649   for (int i = 0; i < m; i++)
17650     a[i] = a[i + k] * c;
17652 @end smallexample
17655 @node Unnamed Fields
17656 @section Unnamed struct/union fields within structs/unions
17657 @cindex @code{struct}
17658 @cindex @code{union}
17660 As permitted by ISO C11 and for compatibility with other compilers,
17661 GCC allows you to define
17662 a structure or union that contains, as fields, structures and unions
17663 without names.  For example:
17665 @smallexample
17666 struct @{
17667   int a;
17668   union @{
17669     int b;
17670     float c;
17671   @};
17672   int d;
17673 @} foo;
17674 @end smallexample
17676 @noindent
17677 In this example, you are able to access members of the unnamed
17678 union with code like @samp{foo.b}.  Note that only unnamed structs and
17679 unions are allowed, you may not have, for example, an unnamed
17680 @code{int}.
17682 You must never create such structures that cause ambiguous field definitions.
17683 For example, in this structure:
17685 @smallexample
17686 struct @{
17687   int a;
17688   struct @{
17689     int a;
17690   @};
17691 @} foo;
17692 @end smallexample
17694 @noindent
17695 it is ambiguous which @code{a} is being referred to with @samp{foo.a}.
17696 The compiler gives errors for such constructs.
17698 @opindex fms-extensions
17699 Unless @option{-fms-extensions} is used, the unnamed field must be a
17700 structure or union definition without a tag (for example, @samp{struct
17701 @{ int a; @};}).  If @option{-fms-extensions} is used, the field may
17702 also be a definition with a tag such as @samp{struct foo @{ int a;
17703 @};}, a reference to a previously defined structure or union such as
17704 @samp{struct foo;}, or a reference to a @code{typedef} name for a
17705 previously defined structure or union type.
17707 @opindex fplan9-extensions
17708 The option @option{-fplan9-extensions} enables
17709 @option{-fms-extensions} as well as two other extensions.  First, a
17710 pointer to a structure is automatically converted to a pointer to an
17711 anonymous field for assignments and function calls.  For example:
17713 @smallexample
17714 struct s1 @{ int a; @};
17715 struct s2 @{ struct s1; @};
17716 extern void f1 (struct s1 *);
17717 void f2 (struct s2 *p) @{ f1 (p); @}
17718 @end smallexample
17720 @noindent
17721 In the call to @code{f1} inside @code{f2}, the pointer @code{p} is
17722 converted into a pointer to the anonymous field.
17724 Second, when the type of an anonymous field is a @code{typedef} for a
17725 @code{struct} or @code{union}, code may refer to the field using the
17726 name of the @code{typedef}.
17728 @smallexample
17729 typedef struct @{ int a; @} s1;
17730 struct s2 @{ s1; @};
17731 s1 f1 (struct s2 *p) @{ return p->s1; @}
17732 @end smallexample
17734 These usages are only permitted when they are not ambiguous.
17736 @node Thread-Local
17737 @section Thread-Local Storage
17738 @cindex Thread-Local Storage
17739 @cindex @acronym{TLS}
17740 @cindex @code{__thread}
17742 Thread-local storage (@acronym{TLS}) is a mechanism by which variables
17743 are allocated such that there is one instance of the variable per extant
17744 thread.  The runtime model GCC uses to implement this originates
17745 in the IA-64 processor-specific ABI, but has since been migrated
17746 to other processors as well.  It requires significant support from
17747 the linker (@command{ld}), dynamic linker (@command{ld.so}), and
17748 system libraries (@file{libc.so} and @file{libpthread.so}), so it
17749 is not available everywhere.
17751 At the user level, the extension is visible with a new storage
17752 class keyword: @code{__thread}.  For example:
17754 @smallexample
17755 __thread int i;
17756 extern __thread struct state s;
17757 static __thread char *p;
17758 @end smallexample
17760 The @code{__thread} specifier may be used alone, with the @code{extern}
17761 or @code{static} specifiers, but with no other storage class specifier.
17762 When used with @code{extern} or @code{static}, @code{__thread} must appear
17763 immediately after the other storage class specifier.
17765 The @code{__thread} specifier may be applied to any global, file-scoped
17766 static, function-scoped static, or static data member of a class.  It may
17767 not be applied to block-scoped automatic or non-static data member.
17769 When the address-of operator is applied to a thread-local variable, it is
17770 evaluated at run time and returns the address of the current thread's
17771 instance of that variable.  An address so obtained may be used by any
17772 thread.  When a thread terminates, any pointers to thread-local variables
17773 in that thread become invalid.
17775 No static initialization may refer to the address of a thread-local variable.
17777 In C++, if an initializer is present for a thread-local variable, it must
17778 be a @var{constant-expression}, as defined in 5.19.2 of the ANSI/ISO C++
17779 standard.
17781 See @uref{http://www.akkadia.org/drepper/tls.pdf,
17782 ELF Handling For Thread-Local Storage} for a detailed explanation of
17783 the four thread-local storage addressing models, and how the runtime
17784 is expected to function.
17786 @menu
17787 * C99 Thread-Local Edits::
17788 * C++98 Thread-Local Edits::
17789 @end menu
17791 @node C99 Thread-Local Edits
17792 @subsection ISO/IEC 9899:1999 Edits for Thread-Local Storage
17794 The following are a set of changes to ISO/IEC 9899:1999 (aka C99)
17795 that document the exact semantics of the language extension.
17797 @itemize @bullet
17798 @item
17799 @cite{5.1.2  Execution environments}
17801 Add new text after paragraph 1
17803 @quotation
17804 Within either execution environment, a @dfn{thread} is a flow of
17805 control within a program.  It is implementation defined whether
17806 or not there may be more than one thread associated with a program.
17807 It is implementation defined how threads beyond the first are
17808 created, the name and type of the function called at thread
17809 startup, and how threads may be terminated.  However, objects
17810 with thread storage duration shall be initialized before thread
17811 startup.
17812 @end quotation
17814 @item
17815 @cite{6.2.4  Storage durations of objects}
17817 Add new text before paragraph 3
17819 @quotation
17820 An object whose identifier is declared with the storage-class
17821 specifier @w{@code{__thread}} has @dfn{thread storage duration}.
17822 Its lifetime is the entire execution of the thread, and its
17823 stored value is initialized only once, prior to thread startup.
17824 @end quotation
17826 @item
17827 @cite{6.4.1  Keywords}
17829 Add @code{__thread}.
17831 @item
17832 @cite{6.7.1  Storage-class specifiers}
17834 Add @code{__thread} to the list of storage class specifiers in
17835 paragraph 1.
17837 Change paragraph 2 to
17839 @quotation
17840 With the exception of @code{__thread}, at most one storage-class
17841 specifier may be given [@dots{}].  The @code{__thread} specifier may
17842 be used alone, or immediately following @code{extern} or
17843 @code{static}.
17844 @end quotation
17846 Add new text after paragraph 6
17848 @quotation
17849 The declaration of an identifier for a variable that has
17850 block scope that specifies @code{__thread} shall also
17851 specify either @code{extern} or @code{static}.
17853 The @code{__thread} specifier shall be used only with
17854 variables.
17855 @end quotation
17856 @end itemize
17858 @node C++98 Thread-Local Edits
17859 @subsection ISO/IEC 14882:1998 Edits for Thread-Local Storage
17861 The following are a set of changes to ISO/IEC 14882:1998 (aka C++98)
17862 that document the exact semantics of the language extension.
17864 @itemize @bullet
17865 @item
17866 @b{[intro.execution]}
17868 New text after paragraph 4
17870 @quotation
17871 A @dfn{thread} is a flow of control within the abstract machine.
17872 It is implementation defined whether or not there may be more than
17873 one thread.
17874 @end quotation
17876 New text after paragraph 7
17878 @quotation
17879 It is unspecified whether additional action must be taken to
17880 ensure when and whether side effects are visible to other threads.
17881 @end quotation
17883 @item
17884 @b{[lex.key]}
17886 Add @code{__thread}.
17888 @item
17889 @b{[basic.start.main]}
17891 Add after paragraph 5
17893 @quotation
17894 The thread that begins execution at the @code{main} function is called
17895 the @dfn{main thread}.  It is implementation defined how functions
17896 beginning threads other than the main thread are designated or typed.
17897 A function so designated, as well as the @code{main} function, is called
17898 a @dfn{thread startup function}.  It is implementation defined what
17899 happens if a thread startup function returns.  It is implementation
17900 defined what happens to other threads when any thread calls @code{exit}.
17901 @end quotation
17903 @item
17904 @b{[basic.start.init]}
17906 Add after paragraph 4
17908 @quotation
17909 The storage for an object of thread storage duration shall be
17910 statically initialized before the first statement of the thread startup
17911 function.  An object of thread storage duration shall not require
17912 dynamic initialization.
17913 @end quotation
17915 @item
17916 @b{[basic.start.term]}
17918 Add after paragraph 3
17920 @quotation
17921 The type of an object with thread storage duration shall not have a
17922 non-trivial destructor, nor shall it be an array type whose elements
17923 (directly or indirectly) have non-trivial destructors.
17924 @end quotation
17926 @item
17927 @b{[basic.stc]}
17929 Add ``thread storage duration'' to the list in paragraph 1.
17931 Change paragraph 2
17933 @quotation
17934 Thread, static, and automatic storage durations are associated with
17935 objects introduced by declarations [@dots{}].
17936 @end quotation
17938 Add @code{__thread} to the list of specifiers in paragraph 3.
17940 @item
17941 @b{[basic.stc.thread]}
17943 New section before @b{[basic.stc.static]}
17945 @quotation
17946 The keyword @code{__thread} applied to a non-local object gives the
17947 object thread storage duration.
17949 A local variable or class data member declared both @code{static}
17950 and @code{__thread} gives the variable or member thread storage
17951 duration.
17952 @end quotation
17954 @item
17955 @b{[basic.stc.static]}
17957 Change paragraph 1
17959 @quotation
17960 All objects that have neither thread storage duration, dynamic
17961 storage duration nor are local [@dots{}].
17962 @end quotation
17964 @item
17965 @b{[dcl.stc]}
17967 Add @code{__thread} to the list in paragraph 1.
17969 Change paragraph 1
17971 @quotation
17972 With the exception of @code{__thread}, at most one
17973 @var{storage-class-specifier} shall appear in a given
17974 @var{decl-specifier-seq}.  The @code{__thread} specifier may
17975 be used alone, or immediately following the @code{extern} or
17976 @code{static} specifiers.  [@dots{}]
17977 @end quotation
17979 Add after paragraph 5
17981 @quotation
17982 The @code{__thread} specifier can be applied only to the names of objects
17983 and to anonymous unions.
17984 @end quotation
17986 @item
17987 @b{[class.mem]}
17989 Add after paragraph 6
17991 @quotation
17992 Non-@code{static} members shall not be @code{__thread}.
17993 @end quotation
17994 @end itemize
17996 @node Binary constants
17997 @section Binary constants using the @samp{0b} prefix
17998 @cindex Binary constants using the @samp{0b} prefix
18000 Integer constants can be written as binary constants, consisting of a
18001 sequence of @samp{0} and @samp{1} digits, prefixed by @samp{0b} or
18002 @samp{0B}.  This is particularly useful in environments that operate a
18003 lot on the bit level (like microcontrollers).
18005 The following statements are identical:
18007 @smallexample
18008 i =       42;
18009 i =     0x2a;
18010 i =      052;
18011 i = 0b101010;
18012 @end smallexample
18014 The type of these constants follows the same rules as for octal or
18015 hexadecimal integer constants, so suffixes like @samp{L} or @samp{UL}
18016 can be applied.
18018 @node C++ Extensions
18019 @chapter Extensions to the C++ Language
18020 @cindex extensions, C++ language
18021 @cindex C++ language extensions
18023 The GNU compiler provides these extensions to the C++ language (and you
18024 can also use most of the C language extensions in your C++ programs).  If you
18025 want to write code that checks whether these features are available, you can
18026 test for the GNU compiler the same way as for C programs: check for a
18027 predefined macro @code{__GNUC__}.  You can also use @code{__GNUG__} to
18028 test specifically for GNU C++ (@pxref{Common Predefined Macros,,
18029 Predefined Macros,cpp,The GNU C Preprocessor}).
18031 @menu
18032 * C++ Volatiles::       What constitutes an access to a volatile object.
18033 * Restricted Pointers:: C99 restricted pointers and references.
18034 * Vague Linkage::       Where G++ puts inlines, vtables and such.
18035 * C++ Interface::       You can use a single C++ header file for both
18036                         declarations and definitions.
18037 * Template Instantiation:: Methods for ensuring that exactly one copy of
18038                         each needed template instantiation is emitted.
18039 * Bound member functions:: You can extract a function pointer to the
18040                         method denoted by a @samp{->*} or @samp{.*} expression.
18041 * C++ Attributes::      Variable, function, and type attributes for C++ only.
18042 * Function Multiversioning::   Declaring multiple function versions.
18043 * Namespace Association:: Strong using-directives for namespace association.
18044 * Type Traits::         Compiler support for type traits
18045 * Java Exceptions::     Tweaking exception handling to work with Java.
18046 * Deprecated Features:: Things will disappear from G++.
18047 * Backwards Compatibility:: Compatibilities with earlier definitions of C++.
18048 @end menu
18050 @node C++ Volatiles
18051 @section When is a Volatile C++ Object Accessed?
18052 @cindex accessing volatiles
18053 @cindex volatile read
18054 @cindex volatile write
18055 @cindex volatile access
18057 The C++ standard differs from the C standard in its treatment of
18058 volatile objects.  It fails to specify what constitutes a volatile
18059 access, except to say that C++ should behave in a similar manner to C
18060 with respect to volatiles, where possible.  However, the different
18061 lvalueness of expressions between C and C++ complicate the behavior.
18062 G++ behaves the same as GCC for volatile access, @xref{C
18063 Extensions,,Volatiles}, for a description of GCC's behavior.
18065 The C and C++ language specifications differ when an object is
18066 accessed in a void context:
18068 @smallexample
18069 volatile int *src = @var{somevalue};
18070 *src;
18071 @end smallexample
18073 The C++ standard specifies that such expressions do not undergo lvalue
18074 to rvalue conversion, and that the type of the dereferenced object may
18075 be incomplete.  The C++ standard does not specify explicitly that it
18076 is lvalue to rvalue conversion that is responsible for causing an
18077 access.  There is reason to believe that it is, because otherwise
18078 certain simple expressions become undefined.  However, because it
18079 would surprise most programmers, G++ treats dereferencing a pointer to
18080 volatile object of complete type as GCC would do for an equivalent
18081 type in C@.  When the object has incomplete type, G++ issues a
18082 warning; if you wish to force an error, you must force a conversion to
18083 rvalue with, for instance, a static cast.
18085 When using a reference to volatile, G++ does not treat equivalent
18086 expressions as accesses to volatiles, but instead issues a warning that
18087 no volatile is accessed.  The rationale for this is that otherwise it
18088 becomes difficult to determine where volatile access occur, and not
18089 possible to ignore the return value from functions returning volatile
18090 references.  Again, if you wish to force a read, cast the reference to
18091 an rvalue.
18093 G++ implements the same behavior as GCC does when assigning to a
18094 volatile object---there is no reread of the assigned-to object, the
18095 assigned rvalue is reused.  Note that in C++ assignment expressions
18096 are lvalues, and if used as an lvalue, the volatile object is
18097 referred to.  For instance, @var{vref} refers to @var{vobj}, as
18098 expected, in the following example:
18100 @smallexample
18101 volatile int vobj;
18102 volatile int &vref = vobj = @var{something};
18103 @end smallexample
18105 @node Restricted Pointers
18106 @section Restricting Pointer Aliasing
18107 @cindex restricted pointers
18108 @cindex restricted references
18109 @cindex restricted this pointer
18111 As with the C front end, G++ understands the C99 feature of restricted pointers,
18112 specified with the @code{__restrict__}, or @code{__restrict} type
18113 qualifier.  Because you cannot compile C++ by specifying the @option{-std=c99}
18114 language flag, @code{restrict} is not a keyword in C++.
18116 In addition to allowing restricted pointers, you can specify restricted
18117 references, which indicate that the reference is not aliased in the local
18118 context.
18120 @smallexample
18121 void fn (int *__restrict__ rptr, int &__restrict__ rref)
18123   /* @r{@dots{}} */
18125 @end smallexample
18127 @noindent
18128 In the body of @code{fn}, @var{rptr} points to an unaliased integer and
18129 @var{rref} refers to a (different) unaliased integer.
18131 You may also specify whether a member function's @var{this} pointer is
18132 unaliased by using @code{__restrict__} as a member function qualifier.
18134 @smallexample
18135 void T::fn () __restrict__
18137   /* @r{@dots{}} */
18139 @end smallexample
18141 @noindent
18142 Within the body of @code{T::fn}, @var{this} has the effective
18143 definition @code{T *__restrict__ const this}.  Notice that the
18144 interpretation of a @code{__restrict__} member function qualifier is
18145 different to that of @code{const} or @code{volatile} qualifier, in that it
18146 is applied to the pointer rather than the object.  This is consistent with
18147 other compilers that implement restricted pointers.
18149 As with all outermost parameter qualifiers, @code{__restrict__} is
18150 ignored in function definition matching.  This means you only need to
18151 specify @code{__restrict__} in a function definition, rather than
18152 in a function prototype as well.
18154 @node Vague Linkage
18155 @section Vague Linkage
18156 @cindex vague linkage
18158 There are several constructs in C++ that require space in the object
18159 file but are not clearly tied to a single translation unit.  We say that
18160 these constructs have ``vague linkage''.  Typically such constructs are
18161 emitted wherever they are needed, though sometimes we can be more
18162 clever.
18164 @table @asis
18165 @item Inline Functions
18166 Inline functions are typically defined in a header file which can be
18167 included in many different compilations.  Hopefully they can usually be
18168 inlined, but sometimes an out-of-line copy is necessary, if the address
18169 of the function is taken or if inlining fails.  In general, we emit an
18170 out-of-line copy in all translation units where one is needed.  As an
18171 exception, we only emit inline virtual functions with the vtable, since
18172 it always requires a copy.
18174 Local static variables and string constants used in an inline function
18175 are also considered to have vague linkage, since they must be shared
18176 between all inlined and out-of-line instances of the function.
18178 @item VTables
18179 @cindex vtable
18180 C++ virtual functions are implemented in most compilers using a lookup
18181 table, known as a vtable.  The vtable contains pointers to the virtual
18182 functions provided by a class, and each object of the class contains a
18183 pointer to its vtable (or vtables, in some multiple-inheritance
18184 situations).  If the class declares any non-inline, non-pure virtual
18185 functions, the first one is chosen as the ``key method'' for the class,
18186 and the vtable is only emitted in the translation unit where the key
18187 method is defined.
18189 @emph{Note:} If the chosen key method is later defined as inline, the
18190 vtable is still emitted in every translation unit that defines it.
18191 Make sure that any inline virtuals are declared inline in the class
18192 body, even if they are not defined there.
18194 @item @code{type_info} objects
18195 @cindex @code{type_info}
18196 @cindex RTTI
18197 C++ requires information about types to be written out in order to
18198 implement @samp{dynamic_cast}, @samp{typeid} and exception handling.
18199 For polymorphic classes (classes with virtual functions), the @samp{type_info}
18200 object is written out along with the vtable so that @samp{dynamic_cast}
18201 can determine the dynamic type of a class object at run time.  For all
18202 other types, we write out the @samp{type_info} object when it is used: when
18203 applying @samp{typeid} to an expression, throwing an object, or
18204 referring to a type in a catch clause or exception specification.
18206 @item Template Instantiations
18207 Most everything in this section also applies to template instantiations,
18208 but there are other options as well.
18209 @xref{Template Instantiation,,Where's the Template?}.
18211 @end table
18213 When used with GNU ld version 2.8 or later on an ELF system such as
18214 GNU/Linux or Solaris 2, or on Microsoft Windows, duplicate copies of
18215 these constructs will be discarded at link time.  This is known as
18216 COMDAT support.
18218 On targets that don't support COMDAT, but do support weak symbols, GCC
18219 uses them.  This way one copy overrides all the others, but
18220 the unused copies still take up space in the executable.
18222 For targets that do not support either COMDAT or weak symbols,
18223 most entities with vague linkage are emitted as local symbols to
18224 avoid duplicate definition errors from the linker.  This does not happen
18225 for local statics in inlines, however, as having multiple copies
18226 almost certainly breaks things.
18228 @xref{C++ Interface,,Declarations and Definitions in One Header}, for
18229 another way to control placement of these constructs.
18231 @node C++ Interface
18232 @section #pragma interface and implementation
18234 @cindex interface and implementation headers, C++
18235 @cindex C++ interface and implementation headers
18236 @cindex pragmas, interface and implementation
18238 @code{#pragma interface} and @code{#pragma implementation} provide the
18239 user with a way of explicitly directing the compiler to emit entities
18240 with vague linkage (and debugging information) in a particular
18241 translation unit.
18243 @emph{Note:} As of GCC 2.7.2, these @code{#pragma}s are not useful in
18244 most cases, because of COMDAT support and the ``key method'' heuristic
18245 mentioned in @ref{Vague Linkage}.  Using them can actually cause your
18246 program to grow due to unnecessary out-of-line copies of inline
18247 functions.  Currently (3.4) the only benefit of these
18248 @code{#pragma}s is reduced duplication of debugging information, and
18249 that should be addressed soon on DWARF 2 targets with the use of
18250 COMDAT groups.
18252 @table @code
18253 @item #pragma interface
18254 @itemx #pragma interface "@var{subdir}/@var{objects}.h"
18255 @kindex #pragma interface
18256 Use this directive in @emph{header files} that define object classes, to save
18257 space in most of the object files that use those classes.  Normally,
18258 local copies of certain information (backup copies of inline member
18259 functions, debugging information, and the internal tables that implement
18260 virtual functions) must be kept in each object file that includes class
18261 definitions.  You can use this pragma to avoid such duplication.  When a
18262 header file containing @samp{#pragma interface} is included in a
18263 compilation, this auxiliary information is not generated (unless
18264 the main input source file itself uses @samp{#pragma implementation}).
18265 Instead, the object files contain references to be resolved at link
18266 time.
18268 The second form of this directive is useful for the case where you have
18269 multiple headers with the same name in different directories.  If you
18270 use this form, you must specify the same string to @samp{#pragma
18271 implementation}.
18273 @item #pragma implementation
18274 @itemx #pragma implementation "@var{objects}.h"
18275 @kindex #pragma implementation
18276 Use this pragma in a @emph{main input file}, when you want full output from
18277 included header files to be generated (and made globally visible).  The
18278 included header file, in turn, should use @samp{#pragma interface}.
18279 Backup copies of inline member functions, debugging information, and the
18280 internal tables used to implement virtual functions are all generated in
18281 implementation files.
18283 @cindex implied @code{#pragma implementation}
18284 @cindex @code{#pragma implementation}, implied
18285 @cindex naming convention, implementation headers
18286 If you use @samp{#pragma implementation} with no argument, it applies to
18287 an include file with the same basename@footnote{A file's @dfn{basename}
18288 is the name stripped of all leading path information and of trailing
18289 suffixes, such as @samp{.h} or @samp{.C} or @samp{.cc}.} as your source
18290 file.  For example, in @file{allclass.cc}, giving just
18291 @samp{#pragma implementation}
18292 by itself is equivalent to @samp{#pragma implementation "allclass.h"}.
18294 In versions of GNU C++ prior to 2.6.0 @file{allclass.h} was treated as
18295 an implementation file whenever you would include it from
18296 @file{allclass.cc} even if you never specified @samp{#pragma
18297 implementation}.  This was deemed to be more trouble than it was worth,
18298 however, and disabled.
18300 Use the string argument if you want a single implementation file to
18301 include code from multiple header files.  (You must also use
18302 @samp{#include} to include the header file; @samp{#pragma
18303 implementation} only specifies how to use the file---it doesn't actually
18304 include it.)
18306 There is no way to split up the contents of a single header file into
18307 multiple implementation files.
18308 @end table
18310 @cindex inlining and C++ pragmas
18311 @cindex C++ pragmas, effect on inlining
18312 @cindex pragmas in C++, effect on inlining
18313 @samp{#pragma implementation} and @samp{#pragma interface} also have an
18314 effect on function inlining.
18316 If you define a class in a header file marked with @samp{#pragma
18317 interface}, the effect on an inline function defined in that class is
18318 similar to an explicit @code{extern} declaration---the compiler emits
18319 no code at all to define an independent version of the function.  Its
18320 definition is used only for inlining with its callers.
18322 @opindex fno-implement-inlines
18323 Conversely, when you include the same header file in a main source file
18324 that declares it as @samp{#pragma implementation}, the compiler emits
18325 code for the function itself; this defines a version of the function
18326 that can be found via pointers (or by callers compiled without
18327 inlining).  If all calls to the function can be inlined, you can avoid
18328 emitting the function by compiling with @option{-fno-implement-inlines}.
18329 If any calls are not inlined, you will get linker errors.
18331 @node Template Instantiation
18332 @section Where's the Template?
18333 @cindex template instantiation
18335 C++ templates are the first language feature to require more
18336 intelligence from the environment than one usually finds on a UNIX
18337 system.  Somehow the compiler and linker have to make sure that each
18338 template instance occurs exactly once in the executable if it is needed,
18339 and not at all otherwise.  There are two basic approaches to this
18340 problem, which are referred to as the Borland model and the Cfront model.
18342 @table @asis
18343 @item Borland model
18344 Borland C++ solved the template instantiation problem by adding the code
18345 equivalent of common blocks to their linker; the compiler emits template
18346 instances in each translation unit that uses them, and the linker
18347 collapses them together.  The advantage of this model is that the linker
18348 only has to consider the object files themselves; there is no external
18349 complexity to worry about.  This disadvantage is that compilation time
18350 is increased because the template code is being compiled repeatedly.
18351 Code written for this model tends to include definitions of all
18352 templates in the header file, since they must be seen to be
18353 instantiated.
18355 @item Cfront model
18356 The AT&T C++ translator, Cfront, solved the template instantiation
18357 problem by creating the notion of a template repository, an
18358 automatically maintained place where template instances are stored.  A
18359 more modern version of the repository works as follows: As individual
18360 object files are built, the compiler places any template definitions and
18361 instantiations encountered in the repository.  At link time, the link
18362 wrapper adds in the objects in the repository and compiles any needed
18363 instances that were not previously emitted.  The advantages of this
18364 model are more optimal compilation speed and the ability to use the
18365 system linker; to implement the Borland model a compiler vendor also
18366 needs to replace the linker.  The disadvantages are vastly increased
18367 complexity, and thus potential for error; for some code this can be
18368 just as transparent, but in practice it can been very difficult to build
18369 multiple programs in one directory and one program in multiple
18370 directories.  Code written for this model tends to separate definitions
18371 of non-inline member templates into a separate file, which should be
18372 compiled separately.
18373 @end table
18375 When used with GNU ld version 2.8 or later on an ELF system such as
18376 GNU/Linux or Solaris 2, or on Microsoft Windows, G++ supports the
18377 Borland model.  On other systems, G++ implements neither automatic
18378 model.
18380 You have the following options for dealing with template instantiations:
18382 @enumerate
18383 @item
18384 @opindex frepo
18385 Compile your template-using code with @option{-frepo}.  The compiler
18386 generates files with the extension @samp{.rpo} listing all of the
18387 template instantiations used in the corresponding object files that
18388 could be instantiated there; the link wrapper, @samp{collect2},
18389 then updates the @samp{.rpo} files to tell the compiler where to place
18390 those instantiations and rebuild any affected object files.  The
18391 link-time overhead is negligible after the first pass, as the compiler
18392 continues to place the instantiations in the same files.
18394 This is your best option for application code written for the Borland
18395 model, as it just works.  Code written for the Cfront model 
18396 needs to be modified so that the template definitions are available at
18397 one or more points of instantiation; usually this is as simple as adding
18398 @code{#include <tmethods.cc>} to the end of each template header.
18400 For library code, if you want the library to provide all of the template
18401 instantiations it needs, just try to link all of its object files
18402 together; the link will fail, but cause the instantiations to be
18403 generated as a side effect.  Be warned, however, that this may cause
18404 conflicts if multiple libraries try to provide the same instantiations.
18405 For greater control, use explicit instantiation as described in the next
18406 option.
18408 @item
18409 @opindex fno-implicit-templates
18410 Compile your code with @option{-fno-implicit-templates} to disable the
18411 implicit generation of template instances, and explicitly instantiate
18412 all the ones you use.  This approach requires more knowledge of exactly
18413 which instances you need than do the others, but it's less
18414 mysterious and allows greater control.  You can scatter the explicit
18415 instantiations throughout your program, perhaps putting them in the
18416 translation units where the instances are used or the translation units
18417 that define the templates themselves; you can put all of the explicit
18418 instantiations you need into one big file; or you can create small files
18419 like
18421 @smallexample
18422 #include "Foo.h"
18423 #include "Foo.cc"
18425 template class Foo<int>;
18426 template ostream& operator <<
18427                 (ostream&, const Foo<int>&);
18428 @end smallexample
18430 @noindent
18431 for each of the instances you need, and create a template instantiation
18432 library from those.
18434 If you are using Cfront-model code, you can probably get away with not
18435 using @option{-fno-implicit-templates} when compiling files that don't
18436 @samp{#include} the member template definitions.
18438 If you use one big file to do the instantiations, you may want to
18439 compile it without @option{-fno-implicit-templates} so you get all of the
18440 instances required by your explicit instantiations (but not by any
18441 other files) without having to specify them as well.
18443 The ISO C++ 2011 standard allows forward declaration of explicit
18444 instantiations (with @code{extern}). G++ supports explicit instantiation
18445 declarations in C++98 mode and has extended the template instantiation
18446 syntax to support instantiation of the compiler support data for a
18447 template class (i.e.@: the vtable) without instantiating any of its
18448 members (with @code{inline}), and instantiation of only the static data
18449 members of a template class, without the support data or member
18450 functions (with (@code{static}):
18452 @smallexample
18453 extern template int max (int, int);
18454 inline template class Foo<int>;
18455 static template class Foo<int>;
18456 @end smallexample
18458 @item
18459 Do nothing.  Pretend G++ does implement automatic instantiation
18460 management.  Code written for the Borland model works fine, but
18461 each translation unit contains instances of each of the templates it
18462 uses.  In a large program, this can lead to an unacceptable amount of code
18463 duplication.
18464 @end enumerate
18466 @node Bound member functions
18467 @section Extracting the function pointer from a bound pointer to member function
18468 @cindex pmf
18469 @cindex pointer to member function
18470 @cindex bound pointer to member function
18472 In C++, pointer to member functions (PMFs) are implemented using a wide
18473 pointer of sorts to handle all the possible call mechanisms; the PMF
18474 needs to store information about how to adjust the @samp{this} pointer,
18475 and if the function pointed to is virtual, where to find the vtable, and
18476 where in the vtable to look for the member function.  If you are using
18477 PMFs in an inner loop, you should really reconsider that decision.  If
18478 that is not an option, you can extract the pointer to the function that
18479 would be called for a given object/PMF pair and call it directly inside
18480 the inner loop, to save a bit of time.
18482 Note that you still pay the penalty for the call through a
18483 function pointer; on most modern architectures, such a call defeats the
18484 branch prediction features of the CPU@.  This is also true of normal
18485 virtual function calls.
18487 The syntax for this extension is
18489 @smallexample
18490 extern A a;
18491 extern int (A::*fp)();
18492 typedef int (*fptr)(A *);
18494 fptr p = (fptr)(a.*fp);
18495 @end smallexample
18497 For PMF constants (i.e.@: expressions of the form @samp{&Klasse::Member}),
18498 no object is needed to obtain the address of the function.  They can be
18499 converted to function pointers directly:
18501 @smallexample
18502 fptr p1 = (fptr)(&A::foo);
18503 @end smallexample
18505 @opindex Wno-pmf-conversions
18506 You must specify @option{-Wno-pmf-conversions} to use this extension.
18508 @node C++ Attributes
18509 @section C++-Specific Variable, Function, and Type Attributes
18511 Some attributes only make sense for C++ programs.
18513 @table @code
18514 @item abi_tag ("@var{tag}", ...)
18515 @cindex @code{abi_tag} attribute
18516 The @code{abi_tag} attribute can be applied to a function or class
18517 declaration.  It modifies the mangled name of the function or class to
18518 incorporate the tag name, in order to distinguish the function or
18519 class from an earlier version with a different ABI; perhaps the class
18520 has changed size, or the function has a different return type that is
18521 not encoded in the mangled name.
18523 The argument can be a list of strings of arbitrary length.  The
18524 strings are sorted on output, so the order of the list is
18525 unimportant.
18527 A redeclaration of a function or class must not add new ABI tags,
18528 since doing so would change the mangled name.
18530 The ABI tags apply to a name, so all instantiations and
18531 specializations of a template have the same tags.  The attribute will
18532 be ignored if applied to an explicit specialization or instantiation.
18534 The @option{-Wabi-tag} flag enables a warning about a class which does
18535 not have all the ABI tags used by its subobjects and virtual functions; for users with code
18536 that needs to coexist with an earlier ABI, using this option can help
18537 to find all affected types that need to be tagged.
18539 @item init_priority (@var{priority})
18540 @cindex @code{init_priority} attribute
18543 In Standard C++, objects defined at namespace scope are guaranteed to be
18544 initialized in an order in strict accordance with that of their definitions
18545 @emph{in a given translation unit}.  No guarantee is made for initializations
18546 across translation units.  However, GNU C++ allows users to control the
18547 order of initialization of objects defined at namespace scope with the
18548 @code{init_priority} attribute by specifying a relative @var{priority},
18549 a constant integral expression currently bounded between 101 and 65535
18550 inclusive.  Lower numbers indicate a higher priority.
18552 In the following example, @code{A} would normally be created before
18553 @code{B}, but the @code{init_priority} attribute reverses that order:
18555 @smallexample
18556 Some_Class  A  __attribute__ ((init_priority (2000)));
18557 Some_Class  B  __attribute__ ((init_priority (543)));
18558 @end smallexample
18560 @noindent
18561 Note that the particular values of @var{priority} do not matter; only their
18562 relative ordering.
18564 @item java_interface
18565 @cindex @code{java_interface} attribute
18567 This type attribute informs C++ that the class is a Java interface.  It may
18568 only be applied to classes declared within an @code{extern "Java"} block.
18569 Calls to methods declared in this interface are dispatched using GCJ's
18570 interface table mechanism, instead of regular virtual table dispatch.
18572 @item warn_unused
18573 @cindex @code{warn_unused} attribute
18575 For C++ types with non-trivial constructors and/or destructors it is
18576 impossible for the compiler to determine whether a variable of this
18577 type is truly unused if it is not referenced. This type attribute
18578 informs the compiler that variables of this type should be warned
18579 about if they appear to be unused, just like variables of fundamental
18580 types.
18582 This attribute is appropriate for types which just represent a value,
18583 such as @code{std::string}; it is not appropriate for types which
18584 control a resource, such as @code{std::mutex}.
18586 This attribute is also accepted in C, but it is unnecessary because C
18587 does not have constructors or destructors.
18589 @end table
18591 See also @ref{Namespace Association}.
18593 @node Function Multiversioning
18594 @section Function Multiversioning
18595 @cindex function versions
18597 With the GNU C++ front end, for target i386, you may specify multiple
18598 versions of a function, where each function is specialized for a
18599 specific target feature.  At runtime, the appropriate version of the
18600 function is automatically executed depending on the characteristics of
18601 the execution platform.  Here is an example.
18603 @smallexample
18604 __attribute__ ((target ("default")))
18605 int foo ()
18607   // The default version of foo.
18608   return 0;
18611 __attribute__ ((target ("sse4.2")))
18612 int foo ()
18614   // foo version for SSE4.2
18615   return 1;
18618 __attribute__ ((target ("arch=atom")))
18619 int foo ()
18621   // foo version for the Intel ATOM processor
18622   return 2;
18625 __attribute__ ((target ("arch=amdfam10")))
18626 int foo ()
18628   // foo version for the AMD Family 0x10 processors.
18629   return 3;
18632 int main ()
18634   int (*p)() = &foo;
18635   assert ((*p) () == foo ());
18636   return 0;
18638 @end smallexample
18640 In the above example, four versions of function foo are created. The
18641 first version of foo with the target attribute "default" is the default
18642 version.  This version gets executed when no other target specific
18643 version qualifies for execution on a particular platform. A new version
18644 of foo is created by using the same function signature but with a
18645 different target string.  Function foo is called or a pointer to it is
18646 taken just like a regular function.  GCC takes care of doing the
18647 dispatching to call the right version at runtime.  Refer to the
18648 @uref{http://gcc.gnu.org/wiki/FunctionMultiVersioning, GCC wiki on
18649 Function Multiversioning} for more details.
18651 @node Namespace Association
18652 @section Namespace Association
18654 @strong{Caution:} The semantics of this extension are equivalent
18655 to C++ 2011 inline namespaces.  Users should use inline namespaces
18656 instead as this extension will be removed in future versions of G++.
18658 A using-directive with @code{__attribute ((strong))} is stronger
18659 than a normal using-directive in two ways:
18661 @itemize @bullet
18662 @item
18663 Templates from the used namespace can be specialized and explicitly
18664 instantiated as though they were members of the using namespace.
18666 @item
18667 The using namespace is considered an associated namespace of all
18668 templates in the used namespace for purposes of argument-dependent
18669 name lookup.
18670 @end itemize
18672 The used namespace must be nested within the using namespace so that
18673 normal unqualified lookup works properly.
18675 This is useful for composing a namespace transparently from
18676 implementation namespaces.  For example:
18678 @smallexample
18679 namespace std @{
18680   namespace debug @{
18681     template <class T> struct A @{ @};
18682   @}
18683   using namespace debug __attribute ((__strong__));
18684   template <> struct A<int> @{ @};   // @r{OK to specialize}
18686   template <class T> void f (A<T>);
18689 int main()
18691   f (std::A<float>());             // @r{lookup finds} std::f
18692   f (std::A<int>());
18694 @end smallexample
18696 @node Type Traits
18697 @section Type Traits
18699 The C++ front end implements syntactic extensions that allow
18700 compile-time determination of 
18701 various characteristics of a type (or of a
18702 pair of types).
18704 @table @code
18705 @item __has_nothrow_assign (type)
18706 If @code{type} is const qualified or is a reference type then the trait is
18707 false.  Otherwise if @code{__has_trivial_assign (type)} is true then the trait
18708 is true, else if @code{type} is a cv class or union type with copy assignment
18709 operators that are known not to throw an exception then the trait is true,
18710 else it is false.  Requires: @code{type} shall be a complete type,
18711 (possibly cv-qualified) @code{void}, or an array of unknown bound.
18713 @item __has_nothrow_copy (type)
18714 If @code{__has_trivial_copy (type)} is true then the trait is true, else if
18715 @code{type} is a cv class or union type with copy constructors that
18716 are known not to throw an exception then the trait is true, else it is false.
18717 Requires: @code{type} shall be a complete type, (possibly cv-qualified)
18718 @code{void}, or an array of unknown bound.
18720 @item __has_nothrow_constructor (type)
18721 If @code{__has_trivial_constructor (type)} is true then the trait is
18722 true, else if @code{type} is a cv class or union type (or array
18723 thereof) with a default constructor that is known not to throw an
18724 exception then the trait is true, else it is false.  Requires:
18725 @code{type} shall be a complete type, (possibly cv-qualified)
18726 @code{void}, or an array of unknown bound.
18728 @item __has_trivial_assign (type)
18729 If @code{type} is const qualified or is a reference type then the trait is
18730 false.  Otherwise if @code{__is_pod (type)} is true then the trait is
18731 true, else if @code{type} is a cv class or union type with a trivial
18732 copy assignment ([class.copy]) then the trait is true, else it is
18733 false.  Requires: @code{type} shall be a complete type, (possibly
18734 cv-qualified) @code{void}, or an array of unknown bound.
18736 @item __has_trivial_copy (type)
18737 If @code{__is_pod (type)} is true or @code{type} is a reference type
18738 then the trait is true, else if @code{type} is a cv class or union type
18739 with a trivial copy constructor ([class.copy]) then the trait
18740 is true, else it is false.  Requires: @code{type} shall be a complete
18741 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
18743 @item __has_trivial_constructor (type)
18744 If @code{__is_pod (type)} is true then the trait is true, else if
18745 @code{type} is a cv class or union type (or array thereof) with a
18746 trivial default constructor ([class.ctor]) then the trait is true,
18747 else it is false.  Requires: @code{type} shall be a complete
18748 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
18750 @item __has_trivial_destructor (type)
18751 If @code{__is_pod (type)} is true or @code{type} is a reference type then
18752 the trait is true, else if @code{type} is a cv class or union type (or
18753 array thereof) with a trivial destructor ([class.dtor]) then the trait
18754 is true, else it is false.  Requires: @code{type} shall be a complete
18755 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
18757 @item __has_virtual_destructor (type)
18758 If @code{type} is a class type with a virtual destructor
18759 ([class.dtor]) then the trait is true, else it is false.  Requires:
18760 @code{type} shall be a complete type, (possibly cv-qualified)
18761 @code{void}, or an array of unknown bound.
18763 @item __is_abstract (type)
18764 If @code{type} is an abstract class ([class.abstract]) then the trait
18765 is true, else it is false.  Requires: @code{type} shall be a complete
18766 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
18768 @item __is_base_of (base_type, derived_type)
18769 If @code{base_type} is a base class of @code{derived_type}
18770 ([class.derived]) then the trait is true, otherwise it is false.
18771 Top-level cv qualifications of @code{base_type} and
18772 @code{derived_type} are ignored.  For the purposes of this trait, a
18773 class type is considered is own base.  Requires: if @code{__is_class
18774 (base_type)} and @code{__is_class (derived_type)} are true and
18775 @code{base_type} and @code{derived_type} are not the same type
18776 (disregarding cv-qualifiers), @code{derived_type} shall be a complete
18777 type.  Diagnostic is produced if this requirement is not met.
18779 @item __is_class (type)
18780 If @code{type} is a cv class type, and not a union type
18781 ([basic.compound]) the trait is true, else it is false.
18783 @item __is_empty (type)
18784 If @code{__is_class (type)} is false then the trait is false.
18785 Otherwise @code{type} is considered empty if and only if: @code{type}
18786 has no non-static data members, or all non-static data members, if
18787 any, are bit-fields of length 0, and @code{type} has no virtual
18788 members, and @code{type} has no virtual base classes, and @code{type}
18789 has no base classes @code{base_type} for which
18790 @code{__is_empty (base_type)} is false.  Requires: @code{type} shall
18791 be a complete type, (possibly cv-qualified) @code{void}, or an array
18792 of unknown bound.
18794 @item __is_enum (type)
18795 If @code{type} is a cv enumeration type ([basic.compound]) the trait is
18796 true, else it is false.
18798 @item __is_literal_type (type)
18799 If @code{type} is a literal type ([basic.types]) the trait is
18800 true, else it is false.  Requires: @code{type} shall be a complete type,
18801 (possibly cv-qualified) @code{void}, or an array of unknown bound.
18803 @item __is_pod (type)
18804 If @code{type} is a cv POD type ([basic.types]) then the trait is true,
18805 else it is false.  Requires: @code{type} shall be a complete type,
18806 (possibly cv-qualified) @code{void}, or an array of unknown bound.
18808 @item __is_polymorphic (type)
18809 If @code{type} is a polymorphic class ([class.virtual]) then the trait
18810 is true, else it is false.  Requires: @code{type} shall be a complete
18811 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
18813 @item __is_standard_layout (type)
18814 If @code{type} is a standard-layout type ([basic.types]) the trait is
18815 true, else it is false.  Requires: @code{type} shall be a complete
18816 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
18818 @item __is_trivial (type)
18819 If @code{type} is a trivial type ([basic.types]) the trait is
18820 true, else it is false.  Requires: @code{type} shall be a complete
18821 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
18823 @item __is_union (type)
18824 If @code{type} is a cv union type ([basic.compound]) the trait is
18825 true, else it is false.
18827 @item __underlying_type (type)
18828 The underlying type of @code{type}.  Requires: @code{type} shall be
18829 an enumeration type ([dcl.enum]).
18831 @end table
18833 @node Java Exceptions
18834 @section Java Exceptions
18836 The Java language uses a slightly different exception handling model
18837 from C++.  Normally, GNU C++ automatically detects when you are
18838 writing C++ code that uses Java exceptions, and handle them
18839 appropriately.  However, if C++ code only needs to execute destructors
18840 when Java exceptions are thrown through it, GCC guesses incorrectly.
18841 Sample problematic code is:
18843 @smallexample
18844   struct S @{ ~S(); @};
18845   extern void bar();    // @r{is written in Java, and may throw exceptions}
18846   void foo()
18847   @{
18848     S s;
18849     bar();
18850   @}
18851 @end smallexample
18853 @noindent
18854 The usual effect of an incorrect guess is a link failure, complaining of
18855 a missing routine called @samp{__gxx_personality_v0}.
18857 You can inform the compiler that Java exceptions are to be used in a
18858 translation unit, irrespective of what it might think, by writing
18859 @samp{@w{#pragma GCC java_exceptions}} at the head of the file.  This
18860 @samp{#pragma} must appear before any functions that throw or catch
18861 exceptions, or run destructors when exceptions are thrown through them.
18863 You cannot mix Java and C++ exceptions in the same translation unit.  It
18864 is believed to be safe to throw a C++ exception from one file through
18865 another file compiled for the Java exception model, or vice versa, but
18866 there may be bugs in this area.
18868 @node Deprecated Features
18869 @section Deprecated Features
18871 In the past, the GNU C++ compiler was extended to experiment with new
18872 features, at a time when the C++ language was still evolving.  Now that
18873 the C++ standard is complete, some of those features are superseded by
18874 superior alternatives.  Using the old features might cause a warning in
18875 some cases that the feature will be dropped in the future.  In other
18876 cases, the feature might be gone already.
18878 While the list below is not exhaustive, it documents some of the options
18879 that are now deprecated:
18881 @table @code
18882 @item -fexternal-templates
18883 @itemx -falt-external-templates
18884 These are two of the many ways for G++ to implement template
18885 instantiation.  @xref{Template Instantiation}.  The C++ standard clearly
18886 defines how template definitions have to be organized across
18887 implementation units.  G++ has an implicit instantiation mechanism that
18888 should work just fine for standard-conforming code.
18890 @item -fstrict-prototype
18891 @itemx -fno-strict-prototype
18892 Previously it was possible to use an empty prototype parameter list to
18893 indicate an unspecified number of parameters (like C), rather than no
18894 parameters, as C++ demands.  This feature has been removed, except where
18895 it is required for backwards compatibility.   @xref{Backwards Compatibility}.
18896 @end table
18898 G++ allows a virtual function returning @samp{void *} to be overridden
18899 by one returning a different pointer type.  This extension to the
18900 covariant return type rules is now deprecated and will be removed from a
18901 future version.
18903 The G++ minimum and maximum operators (@samp{<?} and @samp{>?}) and
18904 their compound forms (@samp{<?=}) and @samp{>?=}) have been deprecated
18905 and are now removed from G++.  Code using these operators should be
18906 modified to use @code{std::min} and @code{std::max} instead.
18908 The named return value extension has been deprecated, and is now
18909 removed from G++.
18911 The use of initializer lists with new expressions has been deprecated,
18912 and is now removed from G++.
18914 Floating and complex non-type template parameters have been deprecated,
18915 and are now removed from G++.
18917 The implicit typename extension has been deprecated and is now
18918 removed from G++.
18920 The use of default arguments in function pointers, function typedefs
18921 and other places where they are not permitted by the standard is
18922 deprecated and will be removed from a future version of G++.
18924 G++ allows floating-point literals to appear in integral constant expressions,
18925 e.g.@: @samp{ enum E @{ e = int(2.2 * 3.7) @} }
18926 This extension is deprecated and will be removed from a future version.
18928 G++ allows static data members of const floating-point type to be declared
18929 with an initializer in a class definition. The standard only allows
18930 initializers for static members of const integral types and const
18931 enumeration types so this extension has been deprecated and will be removed
18932 from a future version.
18934 @node Backwards Compatibility
18935 @section Backwards Compatibility
18936 @cindex Backwards Compatibility
18937 @cindex ARM [Annotated C++ Reference Manual]
18939 Now that there is a definitive ISO standard C++, G++ has a specification
18940 to adhere to.  The C++ language evolved over time, and features that
18941 used to be acceptable in previous drafts of the standard, such as the ARM
18942 [Annotated C++ Reference Manual], are no longer accepted.  In order to allow
18943 compilation of C++ written to such drafts, G++ contains some backwards
18944 compatibilities.  @emph{All such backwards compatibility features are
18945 liable to disappear in future versions of G++.} They should be considered
18946 deprecated.   @xref{Deprecated Features}.
18948 @table @code
18949 @item For scope
18950 If a variable is declared at for scope, it used to remain in scope until
18951 the end of the scope that contained the for statement (rather than just
18952 within the for scope).  G++ retains this, but issues a warning, if such a
18953 variable is accessed outside the for scope.
18955 @item Implicit C language
18956 Old C system header files did not contain an @code{extern "C" @{@dots{}@}}
18957 scope to set the language.  On such systems, all header files are
18958 implicitly scoped inside a C language scope.  Also, an empty prototype
18959 @code{()} is treated as an unspecified number of arguments, rather
18960 than no arguments, as C++ demands.
18961 @end table
18963 @c  LocalWords:  emph deftypefn builtin ARCv2EM SIMD builtins msimd
18964 @c  LocalWords:  typedef v4si v8hi DMA dma vdiwr vdowr followign