* combine.c (make_compound_operation) <SUBREG>: If force_to_mode
[official-gcc.git] / gcc / doc / extend.texi
blob2453bd87570aefdfbfc12c3462b37138a1c46f84
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1996, 1998, 1999, 2000, 2001,
2 @c 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
3 @c Free Software Foundation, Inc.
5 @c This is part of the GCC manual.
6 @c For copying conditions, see the file gcc.texi.
8 @node C Extensions
9 @chapter Extensions to the C Language Family
10 @cindex extensions, C language
11 @cindex C language extensions
13 @opindex pedantic
14 GNU C provides several language features not found in ISO standard C@.
15 (The @option{-pedantic} option directs GCC to print a warning message if
16 any of these features is used.)  To test for the availability of these
17 features in conditional compilation, check for a predefined macro
18 @code{__GNUC__}, which is always defined under GCC@.
20 These extensions are available in C and Objective-C@.  Most of them are
21 also available in C++.  @xref{C++ Extensions,,Extensions to the
22 C++ Language}, for extensions that apply @emph{only} to C++.
24 Some features that are in ISO C99 but not C89 or C++ are also, as
25 extensions, accepted by GCC in C89 mode and in C++.
27 @menu
28 * Statement Exprs::     Putting statements and declarations inside expressions.
29 * Local Labels::        Labels local to a block.
30 * Labels as Values::    Getting pointers to labels, and computed gotos.
31 * Nested Functions::    As in Algol and Pascal, lexical scoping of functions.
32 * Constructing Calls::  Dispatching a call to another function.
33 * Typeof::              @code{typeof}: referring to the type of an expression.
34 * Conditionals::        Omitting the middle operand of a @samp{?:} expression.
35 * Long Long::           Double-word integers---@code{long long int}.
36 * Complex::             Data types for complex numbers.
37 * Floating Types::      Additional Floating Types.
38 * Half-Precision::      Half-Precision Floating Point.
39 * Decimal Float::       Decimal Floating Types. 
40 * Hex Floats::          Hexadecimal floating-point constants.
41 * Fixed-Point::         Fixed-Point Types.
42 * Zero Length::         Zero-length arrays.
43 * Variable Length::     Arrays whose length is computed at run time.
44 * Empty Structures::    Structures with no members.
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 * Cast to Union::       Casting to union type from any member of the union.
54 * Case Ranges::         `case 1 ... 9' and such.
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 * Extended Asm::        Assembler instructions with C expressions as operands.
68                         (With them you can define ``built-in'' functions.)
69 * Constraints::         Constraints for asm operands
70 * Asm Labels::          Specifying the assembler name to use for a C symbol.
71 * Explicit Reg Vars::   Defining variables residing in specified registers.
72 * Alternate Keywords::  @code{__const__}, @code{__asm__}, etc., for header files.
73 * Incomplete Enums::    @code{enum foo;}, with details to follow.
74 * Function Names::      Printable strings which are the name of the current
75                         function.
76 * Return Address::      Getting the return or frame address of a function.
77 * Vector Extensions::   Using vector instructions through built-in functions.
78 * Offsetof::            Special syntax for implementing @code{offsetof}.
79 * Atomic Builtins::     Built-in functions for atomic memory access.
80 * Object Size Checking:: Built-in functions for limited buffer overflow
81                         checking.
82 * Other Builtins::      Other built-in functions.
83 * Target Builtins::     Built-in functions specific to particular targets.
84 * Target Format Checks:: Format checks specific to particular targets.
85 * Pragmas::             Pragmas accepted by GCC.
86 * Unnamed Fields::      Unnamed struct/union fields within structs/unions.
87 * Thread-Local::        Per-thread variables.
88 * Binary constants::    Binary constants using the @samp{0b} prefix.
89 @end menu
91 @node Statement Exprs
92 @section Statements and Declarations in Expressions
93 @cindex statements inside expressions
94 @cindex declarations inside expressions
95 @cindex expressions containing statements
96 @cindex macros, statements in expressions
98 @c the above section title wrapped and causes an underfull hbox.. i
99 @c changed it from "within" to "in". --mew 4feb93
100 A compound statement enclosed in parentheses may appear as an expression
101 in GNU C@.  This allows you to use loops, switches, and local variables
102 within an expression.
104 Recall that a compound statement is a sequence of statements surrounded
105 by braces; in this construct, parentheses go around the braces.  For
106 example:
108 @smallexample
109 (@{ int y = foo (); int z;
110    if (y > 0) z = y;
111    else z = - y;
112    z; @})
113 @end smallexample
115 @noindent
116 is a valid (though slightly more complex than necessary) expression
117 for the absolute value of @code{foo ()}.
119 The last thing in the compound statement should be an expression
120 followed by a semicolon; the value of this subexpression serves as the
121 value of the entire construct.  (If you use some other kind of statement
122 last within the braces, the construct has type @code{void}, and thus
123 effectively no value.)
125 This feature is especially useful in making macro definitions ``safe'' (so
126 that they evaluate each operand exactly once).  For example, the
127 ``maximum'' function is commonly defined as a macro in standard C as
128 follows:
130 @smallexample
131 #define max(a,b) ((a) > (b) ? (a) : (b))
132 @end smallexample
134 @noindent
135 @cindex side effects, macro argument
136 But this definition computes either @var{a} or @var{b} twice, with bad
137 results if the operand has side effects.  In GNU C, if you know the
138 type of the operands (here taken as @code{int}), you can define
139 the macro safely as follows:
141 @smallexample
142 #define maxint(a,b) \
143   (@{int _a = (a), _b = (b); _a > _b ? _a : _b; @})
144 @end smallexample
146 Embedded statements are not allowed in constant expressions, such as
147 the value of an enumeration constant, the width of a bit-field, or
148 the initial value of a static variable.
150 If you don't know the type of the operand, you can still do this, but you
151 must use @code{typeof} (@pxref{Typeof}).
153 In G++, the result value of a statement expression undergoes array and
154 function pointer decay, and is returned by value to the enclosing
155 expression.  For instance, if @code{A} is a class, then
157 @smallexample
158         A a;
160         (@{a;@}).Foo ()
161 @end smallexample
163 @noindent
164 will construct a temporary @code{A} object to hold the result of the
165 statement expression, and that will be used to invoke @code{Foo}.
166 Therefore the @code{this} pointer observed by @code{Foo} will not be the
167 address of @code{a}.
169 Any temporaries created within a statement within a statement expression
170 will be destroyed at the statement's end.  This makes statement
171 expressions inside macros slightly different from function calls.  In
172 the latter case temporaries introduced during argument evaluation will
173 be destroyed at the end of the statement that includes the function
174 call.  In the statement expression case they will be destroyed during
175 the statement expression.  For instance,
177 @smallexample
178 #define macro(a)  (@{__typeof__(a) b = (a); b + 3; @})
179 template<typename T> T function(T a) @{ T b = a; return b + 3; @}
181 void foo ()
183   macro (X ());
184   function (X ());
186 @end smallexample
188 @noindent
189 will have different places where temporaries are destroyed.  For the
190 @code{macro} case, the temporary @code{X} will be destroyed just after
191 the initialization of @code{b}.  In the @code{function} case that
192 temporary will be destroyed when the function returns.
194 These considerations mean that it is probably a bad idea to use
195 statement-expressions of this form in header files that are designed to
196 work with C++.  (Note that some versions of the GNU C Library contained
197 header files using statement-expression that lead to precisely this
198 bug.)
200 Jumping into a statement expression with @code{goto} or using a
201 @code{switch} statement outside the statement expression with a
202 @code{case} or @code{default} label inside the statement expression is
203 not permitted.  Jumping into a statement expression with a computed
204 @code{goto} (@pxref{Labels as Values}) yields undefined behavior.
205 Jumping out of a statement expression is permitted, but if the
206 statement expression is part of a larger expression then it is
207 unspecified which other subexpressions of that expression have been
208 evaluated except where the language definition requires certain
209 subexpressions to be evaluated before or after the statement
210 expression.  In any case, as with a function call the evaluation of a
211 statement expression is not interleaved with the evaluation of other
212 parts of the containing expression.  For example,
214 @smallexample
215   foo (), ((@{ bar1 (); goto a; 0; @}) + bar2 ()), baz();
216 @end smallexample
218 @noindent
219 will call @code{foo} and @code{bar1} and will not call @code{baz} but
220 may or may not call @code{bar2}.  If @code{bar2} is called, it will be
221 called after @code{foo} and before @code{bar1}
223 @node Local Labels
224 @section Locally Declared Labels
225 @cindex local labels
226 @cindex macros, local labels
228 GCC allows you to declare @dfn{local labels} in any nested block
229 scope.  A local label is just like an ordinary label, but you can
230 only reference it (with a @code{goto} statement, or by taking its
231 address) within the block in which it was declared.
233 A local label declaration looks like this:
235 @smallexample
236 __label__ @var{label};
237 @end smallexample
239 @noindent
242 @smallexample
243 __label__ @var{label1}, @var{label2}, /* @r{@dots{}} */;
244 @end smallexample
246 Local label declarations must come at the beginning of the block,
247 before any ordinary declarations or statements.
249 The label declaration defines the label @emph{name}, but does not define
250 the label itself.  You must do this in the usual way, with
251 @code{@var{label}:}, within the statements of the statement expression.
253 The local label feature is useful for complex macros.  If a macro
254 contains nested loops, a @code{goto} can be useful for breaking out of
255 them.  However, an ordinary label whose scope is the whole function
256 cannot be used: if the macro can be expanded several times in one
257 function, the label will be multiply defined in that function.  A
258 local label avoids this problem.  For example:
260 @smallexample
261 #define SEARCH(value, array, target)              \
262 do @{                                              \
263   __label__ found;                                \
264   typeof (target) _SEARCH_target = (target);      \
265   typeof (*(array)) *_SEARCH_array = (array);     \
266   int i, j;                                       \
267   int value;                                      \
268   for (i = 0; i < max; i++)                       \
269     for (j = 0; j < max; j++)                     \
270       if (_SEARCH_array[i][j] == _SEARCH_target)  \
271         @{ (value) = i; goto found; @}              \
272   (value) = -1;                                   \
273  found:;                                          \
274 @} while (0)
275 @end smallexample
277 This could also be written using a statement-expression:
279 @smallexample
280 #define SEARCH(array, target)                     \
281 (@{                                                \
282   __label__ found;                                \
283   typeof (target) _SEARCH_target = (target);      \
284   typeof (*(array)) *_SEARCH_array = (array);     \
285   int i, j;                                       \
286   int value;                                      \
287   for (i = 0; i < max; i++)                       \
288     for (j = 0; j < max; j++)                     \
289       if (_SEARCH_array[i][j] == _SEARCH_target)  \
290         @{ value = i; goto found; @}                \
291   value = -1;                                     \
292  found:                                           \
293   value;                                          \
295 @end smallexample
297 Local label declarations also make the labels they declare visible to
298 nested functions, if there are any.  @xref{Nested Functions}, for details.
300 @node Labels as Values
301 @section Labels as Values
302 @cindex labels as values
303 @cindex computed gotos
304 @cindex goto with computed label
305 @cindex address of a label
307 You can get the address of a label defined in the current function
308 (or a containing function) with the unary operator @samp{&&}.  The
309 value has type @code{void *}.  This value is a constant and can be used
310 wherever a constant of that type is valid.  For example:
312 @smallexample
313 void *ptr;
314 /* @r{@dots{}} */
315 ptr = &&foo;
316 @end smallexample
318 To use these values, you need to be able to jump to one.  This is done
319 with the computed goto statement@footnote{The analogous feature in
320 Fortran is called an assigned goto, but that name seems inappropriate in
321 C, where one can do more than simply store label addresses in label
322 variables.}, @code{goto *@var{exp};}.  For example,
324 @smallexample
325 goto *ptr;
326 @end smallexample
328 @noindent
329 Any expression of type @code{void *} is allowed.
331 One way of using these constants is in initializing a static array that
332 will serve as a jump table:
334 @smallexample
335 static void *array[] = @{ &&foo, &&bar, &&hack @};
336 @end smallexample
338 Then you can select a label with indexing, like this:
340 @smallexample
341 goto *array[i];
342 @end smallexample
344 @noindent
345 Note that this does not check whether the subscript is in bounds---array
346 indexing in C never does that.
348 Such an array of label values serves a purpose much like that of the
349 @code{switch} statement.  The @code{switch} statement is cleaner, so
350 use that rather than an array unless the problem does not fit a
351 @code{switch} statement very well.
353 Another use of label values is in an interpreter for threaded code.
354 The labels within the interpreter function can be stored in the
355 threaded code for super-fast dispatching.
357 You may not use this mechanism to jump to code in a different function.
358 If you do that, totally unpredictable things will happen.  The best way to
359 avoid this is to store the label address only in automatic variables and
360 never pass it as an argument.
362 An alternate way to write the above example is
364 @smallexample
365 static const int array[] = @{ &&foo - &&foo, &&bar - &&foo,
366                              &&hack - &&foo @};
367 goto *(&&foo + array[i]);
368 @end smallexample
370 @noindent
371 This is more friendly to code living in shared libraries, as it reduces
372 the number of dynamic relocations that are needed, and by consequence,
373 allows the data to be read-only.
375 The @code{&&foo} expressions for the same label might have different values
376 if the containing function is inlined or cloned.  If a program relies on
377 them being always the same, @code{__attribute__((__noinline__))} should
378 be used to prevent inlining.  If @code{&&foo} is used
379 in a static variable initializer, inlining is forbidden.
381 @node Nested Functions
382 @section Nested Functions
383 @cindex nested functions
384 @cindex downward funargs
385 @cindex thunks
387 A @dfn{nested function} is a function defined inside another function.
388 (Nested functions are not supported for GNU C++.)  The nested function's
389 name is local to the block where it is defined.  For example, here we
390 define a nested function named @code{square}, and call it twice:
392 @smallexample
393 @group
394 foo (double a, double b)
396   double square (double z) @{ return z * z; @}
398   return square (a) + square (b);
400 @end group
401 @end smallexample
403 The nested function can access all the variables of the containing
404 function that are visible at the point of its definition.  This is
405 called @dfn{lexical scoping}.  For example, here we show a nested
406 function which uses an inherited variable named @code{offset}:
408 @smallexample
409 @group
410 bar (int *array, int offset, int size)
412   int access (int *array, int index)
413     @{ return array[index + offset]; @}
414   int i;
415   /* @r{@dots{}} */
416   for (i = 0; i < size; i++)
417     /* @r{@dots{}} */ access (array, i) /* @r{@dots{}} */
419 @end group
420 @end smallexample
422 Nested function definitions are permitted within functions in the places
423 where variable definitions are allowed; that is, in any block, mixed
424 with the other declarations and statements in the block.
426 It is possible to call the nested function from outside the scope of its
427 name by storing its address or passing the address to another function:
429 @smallexample
430 hack (int *array, int size)
432   void store (int index, int value)
433     @{ array[index] = value; @}
435   intermediate (store, size);
437 @end smallexample
439 Here, the function @code{intermediate} receives the address of
440 @code{store} as an argument.  If @code{intermediate} calls @code{store},
441 the arguments given to @code{store} are used to store into @code{array}.
442 But this technique works only so long as the containing function
443 (@code{hack}, in this example) does not exit.
445 If you try to call the nested function through its address after the
446 containing function has exited, all hell will break loose.  If you try
447 to call it after a containing scope level has exited, and if it refers
448 to some of the variables that are no longer in scope, you may be lucky,
449 but it's not wise to take the risk.  If, however, the nested function
450 does not refer to anything that has gone out of scope, you should be
451 safe.
453 GCC implements taking the address of a nested function using a technique
454 called @dfn{trampolines}.  This technique was described in 
455 @cite{Lexical Closures for C++} (Thomas M. Breuel, USENIX
456 C++ Conference Proceedings, October 17-21, 1988).
458 A nested function can jump to a label inherited from a containing
459 function, provided the label was explicitly declared in the containing
460 function (@pxref{Local Labels}).  Such a jump returns instantly to the
461 containing function, exiting the nested function which did the
462 @code{goto} and any intermediate functions as well.  Here is an example:
464 @smallexample
465 @group
466 bar (int *array, int offset, int size)
468   __label__ failure;
469   int access (int *array, int index)
470     @{
471       if (index > size)
472         goto failure;
473       return array[index + offset];
474     @}
475   int i;
476   /* @r{@dots{}} */
477   for (i = 0; i < size; i++)
478     /* @r{@dots{}} */ access (array, i) /* @r{@dots{}} */
479   /* @r{@dots{}} */
480   return 0;
482  /* @r{Control comes here from @code{access}
483     if it detects an error.}  */
484  failure:
485   return -1;
487 @end group
488 @end smallexample
490 A nested function always has no linkage.  Declaring one with
491 @code{extern} or @code{static} is erroneous.  If you need to declare the nested function
492 before its definition, use @code{auto} (which is otherwise meaningless
493 for function declarations).
495 @smallexample
496 bar (int *array, int offset, int size)
498   __label__ failure;
499   auto int access (int *, int);
500   /* @r{@dots{}} */
501   int access (int *array, int index)
502     @{
503       if (index > size)
504         goto failure;
505       return array[index + offset];
506     @}
507   /* @r{@dots{}} */
509 @end smallexample
511 @node Constructing Calls
512 @section Constructing Function Calls
513 @cindex constructing calls
514 @cindex forwarding calls
516 Using the built-in functions described below, you can record
517 the arguments a function received, and call another function
518 with the same arguments, without knowing the number or types
519 of the arguments.
521 You can also record the return value of that function call,
522 and later return that value, without knowing what data type
523 the function tried to return (as long as your caller expects
524 that data type).
526 However, these built-in functions may interact badly with some
527 sophisticated features or other extensions of the language.  It
528 is, therefore, not recommended to use them outside very simple
529 functions acting as mere forwarders for their arguments.
531 @deftypefn {Built-in Function} {void *} __builtin_apply_args ()
532 This built-in function returns a pointer to data
533 describing how to perform a call with the same arguments as were passed
534 to the current function.
536 The function saves the arg pointer register, structure value address,
537 and all registers that might be used to pass arguments to a function
538 into a block of memory allocated on the stack.  Then it returns the
539 address of that block.
540 @end deftypefn
542 @deftypefn {Built-in Function} {void *} __builtin_apply (void (*@var{function})(), void *@var{arguments}, size_t @var{size})
543 This built-in function invokes @var{function}
544 with a copy of the parameters described by @var{arguments}
545 and @var{size}.
547 The value of @var{arguments} should be the value returned by
548 @code{__builtin_apply_args}.  The argument @var{size} specifies the size
549 of the stack argument data, in bytes.
551 This function returns a pointer to data describing
552 how to return whatever value was returned by @var{function}.  The data
553 is saved in a block of memory allocated on the stack.
555 It is not always simple to compute the proper value for @var{size}.  The
556 value is used by @code{__builtin_apply} to compute the amount of data
557 that should be pushed on the stack and copied from the incoming argument
558 area.
559 @end deftypefn
561 @deftypefn {Built-in Function} {void} __builtin_return (void *@var{result})
562 This built-in function returns the value described by @var{result} from
563 the containing function.  You should specify, for @var{result}, a value
564 returned by @code{__builtin_apply}.
565 @end deftypefn
567 @deftypefn {Built-in Function} __builtin_va_arg_pack ()
568 This built-in function represents all anonymous arguments of an inline
569 function.  It can be used only in inline functions which will be always
570 inlined, never compiled as a separate function, such as those using
571 @code{__attribute__ ((__always_inline__))} or
572 @code{__attribute__ ((__gnu_inline__))} extern inline functions.
573 It must be only passed as last argument to some other function
574 with variable arguments.  This is useful for writing small wrapper
575 inlines for variable argument functions, when using preprocessor
576 macros is undesirable.  For example:
577 @smallexample
578 extern int myprintf (FILE *f, const char *format, ...);
579 extern inline __attribute__ ((__gnu_inline__)) int
580 myprintf (FILE *f, const char *format, ...)
582   int r = fprintf (f, "myprintf: ");
583   if (r < 0)
584     return r;
585   int s = fprintf (f, format, __builtin_va_arg_pack ());
586   if (s < 0)
587     return s;
588   return r + s;
590 @end smallexample
591 @end deftypefn
593 @deftypefn {Built-in Function} __builtin_va_arg_pack_len ()
594 This built-in function returns the number of anonymous arguments of
595 an inline function.  It can be used only in inline functions which
596 will be always inlined, never compiled as a separate function, such
597 as those using @code{__attribute__ ((__always_inline__))} or
598 @code{__attribute__ ((__gnu_inline__))} extern inline functions.
599 For example following will do link or runtime checking of open
600 arguments for optimized code:
601 @smallexample
602 #ifdef __OPTIMIZE__
603 extern inline __attribute__((__gnu_inline__)) int
604 myopen (const char *path, int oflag, ...)
606   if (__builtin_va_arg_pack_len () > 1)
607     warn_open_too_many_arguments ();
609   if (__builtin_constant_p (oflag))
610     @{
611       if ((oflag & O_CREAT) != 0 && __builtin_va_arg_pack_len () < 1)
612         @{
613           warn_open_missing_mode ();
614           return __open_2 (path, oflag);
615         @}
616       return open (path, oflag, __builtin_va_arg_pack ());
617     @}
618     
619   if (__builtin_va_arg_pack_len () < 1)
620     return __open_2 (path, oflag);
622   return open (path, oflag, __builtin_va_arg_pack ());
624 #endif
625 @end smallexample
626 @end deftypefn
628 @node Typeof
629 @section Referring to a Type with @code{typeof}
630 @findex typeof
631 @findex sizeof
632 @cindex macros, types of arguments
634 Another way to refer to the type of an expression is with @code{typeof}.
635 The syntax of using of this keyword looks like @code{sizeof}, but the
636 construct acts semantically like a type name defined with @code{typedef}.
638 There are two ways of writing the argument to @code{typeof}: with an
639 expression or with a type.  Here is an example with an expression:
641 @smallexample
642 typeof (x[0](1))
643 @end smallexample
645 @noindent
646 This assumes that @code{x} is an array of pointers to functions;
647 the type described is that of the values of the functions.
649 Here is an example with a typename as the argument:
651 @smallexample
652 typeof (int *)
653 @end smallexample
655 @noindent
656 Here the type described is that of pointers to @code{int}.
658 If you are writing a header file that must work when included in ISO C
659 programs, write @code{__typeof__} instead of @code{typeof}.
660 @xref{Alternate Keywords}.
662 A @code{typeof}-construct can be used anywhere a typedef name could be
663 used.  For example, you can use it in a declaration, in a cast, or inside
664 of @code{sizeof} or @code{typeof}.
666 The operand of @code{typeof} is evaluated for its side effects if and
667 only if it is an expression of variably modified type or the name of
668 such a type.
670 @code{typeof} is often useful in conjunction with the
671 statements-within-expressions feature.  Here is how the two together can
672 be used to define a safe ``maximum'' macro that operates on any
673 arithmetic type and evaluates each of its arguments exactly once:
675 @smallexample
676 #define max(a,b) \
677   (@{ typeof (a) _a = (a); \
678       typeof (b) _b = (b); \
679     _a > _b ? _a : _b; @})
680 @end smallexample
682 @cindex underscores in variables in macros
683 @cindex @samp{_} in variables in macros
684 @cindex local variables in macros
685 @cindex variables, local, in macros
686 @cindex macros, local variables in
688 The reason for using names that start with underscores for the local
689 variables is to avoid conflicts with variable names that occur within the
690 expressions that are substituted for @code{a} and @code{b}.  Eventually we
691 hope to design a new form of declaration syntax that allows you to declare
692 variables whose scopes start only after their initializers; this will be a
693 more reliable way to prevent such conflicts.
695 @noindent
696 Some more examples of the use of @code{typeof}:
698 @itemize @bullet
699 @item
700 This declares @code{y} with the type of what @code{x} points to.
702 @smallexample
703 typeof (*x) y;
704 @end smallexample
706 @item
707 This declares @code{y} as an array of such values.
709 @smallexample
710 typeof (*x) y[4];
711 @end smallexample
713 @item
714 This declares @code{y} as an array of pointers to characters:
716 @smallexample
717 typeof (typeof (char *)[4]) y;
718 @end smallexample
720 @noindent
721 It is equivalent to the following traditional C declaration:
723 @smallexample
724 char *y[4];
725 @end smallexample
727 To see the meaning of the declaration using @code{typeof}, and why it
728 might be a useful way to write, rewrite it with these macros:
730 @smallexample
731 #define pointer(T)  typeof(T *)
732 #define array(T, N) typeof(T [N])
733 @end smallexample
735 @noindent
736 Now the declaration can be rewritten this way:
738 @smallexample
739 array (pointer (char), 4) y;
740 @end smallexample
742 @noindent
743 Thus, @code{array (pointer (char), 4)} is the type of arrays of 4
744 pointers to @code{char}.
745 @end itemize
747 @emph{Compatibility Note:} In addition to @code{typeof}, GCC 2 supported
748 a more limited extension which permitted one to write
750 @smallexample
751 typedef @var{T} = @var{expr};
752 @end smallexample
754 @noindent
755 with the effect of declaring @var{T} to have the type of the expression
756 @var{expr}.  This extension does not work with GCC 3 (versions between
757 3.0 and 3.2 will crash; 3.2.1 and later give an error).  Code which
758 relies on it should be rewritten to use @code{typeof}:
760 @smallexample
761 typedef typeof(@var{expr}) @var{T};
762 @end smallexample
764 @noindent
765 This will work with all versions of GCC@.
767 @node Conditionals
768 @section Conditionals with Omitted Operands
769 @cindex conditional expressions, extensions
770 @cindex omitted middle-operands
771 @cindex middle-operands, omitted
772 @cindex extensions, @code{?:}
773 @cindex @code{?:} extensions
775 The middle operand in a conditional expression may be omitted.  Then
776 if the first operand is nonzero, its value is the value of the conditional
777 expression.
779 Therefore, the expression
781 @smallexample
782 x ? : y
783 @end smallexample
785 @noindent
786 has the value of @code{x} if that is nonzero; otherwise, the value of
787 @code{y}.
789 This example is perfectly equivalent to
791 @smallexample
792 x ? x : y
793 @end smallexample
795 @cindex side effect in ?:
796 @cindex ?: side effect
797 @noindent
798 In this simple case, the ability to omit the middle operand is not
799 especially useful.  When it becomes useful is when the first operand does,
800 or may (if it is a macro argument), contain a side effect.  Then repeating
801 the operand in the middle would perform the side effect twice.  Omitting
802 the middle operand uses the value already computed without the undesirable
803 effects of recomputing it.
805 @node Long Long
806 @section Double-Word Integers
807 @cindex @code{long long} data types
808 @cindex double-word arithmetic
809 @cindex multiprecision arithmetic
810 @cindex @code{LL} integer suffix
811 @cindex @code{ULL} integer suffix
813 ISO C99 supports data types for integers that are at least 64 bits wide,
814 and as an extension GCC supports them in C89 mode and in C++.
815 Simply write @code{long long int} for a signed integer, or
816 @code{unsigned long long int} for an unsigned integer.  To make an
817 integer constant of type @code{long long int}, add the suffix @samp{LL}
818 to the integer.  To make an integer constant of type @code{unsigned long
819 long int}, add the suffix @samp{ULL} to the integer.
821 You can use these types in arithmetic like any other integer types.
822 Addition, subtraction, and bitwise boolean operations on these types
823 are open-coded on all types of machines.  Multiplication is open-coded
824 if the machine supports fullword-to-doubleword a widening multiply
825 instruction.  Division and shifts are open-coded only on machines that
826 provide special support.  The operations that are not open-coded use
827 special library routines that come with GCC@.
829 There may be pitfalls when you use @code{long long} types for function
830 arguments, unless you declare function prototypes.  If a function
831 expects type @code{int} for its argument, and you pass a value of type
832 @code{long long int}, confusion will result because the caller and the
833 subroutine will disagree about the number of bytes for the argument.
834 Likewise, if the function expects @code{long long int} and you pass
835 @code{int}.  The best way to avoid such problems is to use prototypes.
837 @node Complex
838 @section Complex Numbers
839 @cindex complex numbers
840 @cindex @code{_Complex} keyword
841 @cindex @code{__complex__} keyword
843 ISO C99 supports complex floating data types, and as an extension GCC
844 supports them in C89 mode and in C++, and supports complex integer data
845 types which are not part of ISO C99.  You can declare complex types
846 using the keyword @code{_Complex}.  As an extension, the older GNU
847 keyword @code{__complex__} is also supported.
849 For example, @samp{_Complex double x;} declares @code{x} as a
850 variable whose real part and imaginary part are both of type
851 @code{double}.  @samp{_Complex short int y;} declares @code{y} to
852 have real and imaginary parts of type @code{short int}; this is not
853 likely to be useful, but it shows that the set of complex types is
854 complete.
856 To write a constant with a complex data type, use the suffix @samp{i} or
857 @samp{j} (either one; they are equivalent).  For example, @code{2.5fi}
858 has type @code{_Complex float} and @code{3i} has type
859 @code{_Complex int}.  Such a constant always has a pure imaginary
860 value, but you can form any complex value you like by adding one to a
861 real constant.  This is a GNU extension; if you have an ISO C99
862 conforming C library (such as GNU libc), and want to construct complex
863 constants of floating type, you should include @code{<complex.h>} and
864 use the macros @code{I} or @code{_Complex_I} instead.
866 @cindex @code{__real__} keyword
867 @cindex @code{__imag__} keyword
868 To extract the real part of a complex-valued expression @var{exp}, write
869 @code{__real__ @var{exp}}.  Likewise, use @code{__imag__} to
870 extract the imaginary part.  This is a GNU extension; for values of
871 floating type, you should use the ISO C99 functions @code{crealf},
872 @code{creal}, @code{creall}, @code{cimagf}, @code{cimag} and
873 @code{cimagl}, declared in @code{<complex.h>} and also provided as
874 built-in functions by GCC@.
876 @cindex complex conjugation
877 The operator @samp{~} performs complex conjugation when used on a value
878 with a complex type.  This is a GNU extension; for values of
879 floating type, you should use the ISO C99 functions @code{conjf},
880 @code{conj} and @code{conjl}, declared in @code{<complex.h>} and also
881 provided as built-in functions by GCC@.
883 GCC can allocate complex automatic variables in a noncontiguous
884 fashion; it's even possible for the real part to be in a register while
885 the imaginary part is on the stack (or vice-versa).  Only the DWARF2
886 debug info format can represent this, so use of DWARF2 is recommended.
887 If you are using the stabs debug info format, GCC describes a noncontiguous
888 complex variable as if it were two separate variables of noncomplex type.
889 If the variable's actual name is @code{foo}, the two fictitious
890 variables are named @code{foo$real} and @code{foo$imag}.  You can
891 examine and set these two fictitious variables with your debugger.
893 @node Floating Types
894 @section Additional Floating Types
895 @cindex additional floating types
896 @cindex @code{__float80} data type
897 @cindex @code{__float128} data type
898 @cindex @code{w} floating point suffix
899 @cindex @code{q} floating point suffix
900 @cindex @code{W} floating point suffix
901 @cindex @code{Q} floating point suffix
903 As an extension, the GNU C compiler supports additional floating
904 types, @code{__float80} and @code{__float128} to support 80bit
905 (@code{XFmode}) and 128 bit (@code{TFmode}) floating types.
906 Support for additional types includes the arithmetic operators:
907 add, subtract, multiply, divide; unary arithmetic operators;
908 relational operators; equality operators; and conversions to and from
909 integer and other floating types.  Use a suffix @samp{w} or @samp{W}
910 in a literal constant of type @code{__float80} and @samp{q} or @samp{Q}
911 for @code{_float128}.  You can declare complex types using the
912 corresponding internal complex type, @code{XCmode} for @code{__float80}
913 type and @code{TCmode} for @code{__float128} type:
915 @smallexample
916 typedef _Complex float __attribute__((mode(TC))) _Complex128;
917 typedef _Complex float __attribute__((mode(XC))) _Complex80;
918 @end smallexample
920 Not all targets support additional floating point types.  @code{__float80}
921 and @code{__float128} types are supported on i386, x86_64 and ia64 targets.
923 @node Half-Precision
924 @section Half-Precision Floating Point
925 @cindex half-precision floating point
926 @cindex @code{__fp16} data type
928 On ARM targets, GCC supports half-precision (16-bit) floating point via
929 the @code{__fp16} type.  You must enable this type explicitly 
930 with the @option{-mfp16-format} command-line option in order to use it.
932 ARM supports two incompatible representations for half-precision
933 floating-point values.  You must choose one of the representations and
934 use it consistently in your program.
936 Specifying @option{-mfp16-format=ieee} selects the IEEE 754-2008 format.
937 This format can represent normalized values in the range of @math{2^{-14}} to 65504.
938 There are 11 bits of significand precision, approximately 3
939 decimal digits.
941 Specifying @option{-mfp16-format=alternative} selects the ARM
942 alternative format.  This representation is similar to the IEEE
943 format, but does not support infinities or NaNs.  Instead, the range
944 of exponents is extended, so that this format can represent normalized
945 values in the range of @math{2^{-14}} to 131008.
947 The @code{__fp16} type is a storage format only.  For purposes
948 of arithmetic and other operations, @code{__fp16} values in C or C++
949 expressions are automatically promoted to @code{float}.  In addition,
950 you cannot declare a function with a return value or parameters 
951 of type @code{__fp16}.
953 Note that conversions from @code{double} to @code{__fp16}
954 involve an intermediate conversion to @code{float}.  Because
955 of rounding, this can sometimes produce a different result than a
956 direct conversion.
958 ARM provides hardware support for conversions between 
959 @code{__fp16} and @code{float} values
960 as an extension to VFP and NEON (Advanced SIMD).  GCC generates
961 code using the instructions provided by this extension if you compile
962 with the options @option{-mfpu=neon-fp16 -mfloat-abi=softfp},
963 in addition to the @option{-mfp16-format} option to select
964 a half-precision format.  
966 Language-level support for the @code{__fp16} data type is
967 independent of whether GCC generates code using hardware floating-point
968 instructions.  In cases where hardware support is not specified, GCC
969 implements conversions between @code{__fp16} and @code{float} values
970 as library calls.
972 @node Decimal Float
973 @section Decimal Floating Types
974 @cindex decimal floating types
975 @cindex @code{_Decimal32} data type
976 @cindex @code{_Decimal64} data type
977 @cindex @code{_Decimal128} data type
978 @cindex @code{df} integer suffix
979 @cindex @code{dd} integer suffix
980 @cindex @code{dl} integer suffix
981 @cindex @code{DF} integer suffix
982 @cindex @code{DD} integer suffix
983 @cindex @code{DL} integer suffix
985 As an extension, the GNU C compiler supports decimal floating types as
986 defined in the N1312 draft of ISO/IEC WDTR24732.  Support for decimal
987 floating types in GCC will evolve as the draft technical report changes.
988 Calling conventions for any target might also change.  Not all targets
989 support decimal floating types.
991 The decimal floating types are @code{_Decimal32}, @code{_Decimal64}, and
992 @code{_Decimal128}.  They use a radix of ten, unlike the floating types
993 @code{float}, @code{double}, and @code{long double} whose radix is not
994 specified by the C standard but is usually two.
996 Support for decimal floating types includes the arithmetic operators
997 add, subtract, multiply, divide; unary arithmetic operators;
998 relational operators; equality operators; and conversions to and from
999 integer and other floating types.  Use a suffix @samp{df} or
1000 @samp{DF} in a literal constant of type @code{_Decimal32}, @samp{dd}
1001 or @samp{DD} for @code{_Decimal64}, and @samp{dl} or @samp{DL} for
1002 @code{_Decimal128}.
1004 GCC support of decimal float as specified by the draft technical report
1005 is incomplete:
1007 @itemize @bullet
1008 @item
1009 When the value of a decimal floating type cannot be represented in the
1010 integer type to which it is being converted, the result is undefined
1011 rather than the result value specified by the draft technical report.
1013 @item
1014 GCC does not provide the C library functionality associated with
1015 @file{math.h}, @file{fenv.h}, @file{stdio.h}, @file{stdlib.h}, and
1016 @file{wchar.h}, which must come from a separate C library implementation.
1017 Because of this the GNU C compiler does not define macro
1018 @code{__STDC_DEC_FP__} to indicate that the implementation conforms to
1019 the technical report.
1020 @end itemize
1022 Types @code{_Decimal32}, @code{_Decimal64}, and @code{_Decimal128}
1023 are supported by the DWARF2 debug information format.
1025 @node Hex Floats
1026 @section Hex Floats
1027 @cindex hex floats
1029 ISO C99 supports floating-point numbers written not only in the usual
1030 decimal notation, such as @code{1.55e1}, but also numbers such as
1031 @code{0x1.fp3} written in hexadecimal format.  As a GNU extension, GCC
1032 supports this in C89 mode (except in some cases when strictly
1033 conforming) and in C++.  In that format the
1034 @samp{0x} hex introducer and the @samp{p} or @samp{P} exponent field are
1035 mandatory.  The exponent is a decimal number that indicates the power of
1036 2 by which the significant part will be multiplied.  Thus @samp{0x1.f} is
1037 @tex
1038 $1 {15\over16}$,
1039 @end tex
1040 @ifnottex
1041 1 15/16,
1042 @end ifnottex
1043 @samp{p3} multiplies it by 8, and the value of @code{0x1.fp3}
1044 is the same as @code{1.55e1}.
1046 Unlike for floating-point numbers in the decimal notation the exponent
1047 is always required in the hexadecimal notation.  Otherwise the compiler
1048 would not be able to resolve the ambiguity of, e.g., @code{0x1.f}.  This
1049 could mean @code{1.0f} or @code{1.9375} since @samp{f} is also the
1050 extension for floating-point constants of type @code{float}.
1052 @node Fixed-Point
1053 @section Fixed-Point Types
1054 @cindex fixed-point types
1055 @cindex @code{_Fract} data type
1056 @cindex @code{_Accum} data type
1057 @cindex @code{_Sat} data type
1058 @cindex @code{hr} fixed-suffix
1059 @cindex @code{r} fixed-suffix
1060 @cindex @code{lr} fixed-suffix
1061 @cindex @code{llr} fixed-suffix
1062 @cindex @code{uhr} fixed-suffix
1063 @cindex @code{ur} fixed-suffix
1064 @cindex @code{ulr} fixed-suffix
1065 @cindex @code{ullr} fixed-suffix
1066 @cindex @code{hk} fixed-suffix
1067 @cindex @code{k} fixed-suffix
1068 @cindex @code{lk} fixed-suffix
1069 @cindex @code{llk} fixed-suffix
1070 @cindex @code{uhk} fixed-suffix
1071 @cindex @code{uk} fixed-suffix
1072 @cindex @code{ulk} fixed-suffix
1073 @cindex @code{ullk} fixed-suffix
1074 @cindex @code{HR} fixed-suffix
1075 @cindex @code{R} fixed-suffix
1076 @cindex @code{LR} fixed-suffix
1077 @cindex @code{LLR} fixed-suffix
1078 @cindex @code{UHR} fixed-suffix
1079 @cindex @code{UR} fixed-suffix
1080 @cindex @code{ULR} fixed-suffix
1081 @cindex @code{ULLR} fixed-suffix
1082 @cindex @code{HK} fixed-suffix
1083 @cindex @code{K} fixed-suffix
1084 @cindex @code{LK} fixed-suffix
1085 @cindex @code{LLK} fixed-suffix
1086 @cindex @code{UHK} fixed-suffix
1087 @cindex @code{UK} fixed-suffix
1088 @cindex @code{ULK} fixed-suffix
1089 @cindex @code{ULLK} fixed-suffix
1091 As an extension, the GNU C compiler supports fixed-point types as
1092 defined in the N1169 draft of ISO/IEC DTR 18037.  Support for fixed-point
1093 types in GCC will evolve as the draft technical report changes.
1094 Calling conventions for any target might also change.  Not all targets
1095 support fixed-point types.
1097 The fixed-point types are
1098 @code{short _Fract},
1099 @code{_Fract},
1100 @code{long _Fract},
1101 @code{long long _Fract},
1102 @code{unsigned short _Fract},
1103 @code{unsigned _Fract},
1104 @code{unsigned long _Fract},
1105 @code{unsigned long long _Fract},
1106 @code{_Sat short _Fract},
1107 @code{_Sat _Fract},
1108 @code{_Sat long _Fract},
1109 @code{_Sat long long _Fract},
1110 @code{_Sat unsigned short _Fract},
1111 @code{_Sat unsigned _Fract},
1112 @code{_Sat unsigned long _Fract},
1113 @code{_Sat unsigned long long _Fract},
1114 @code{short _Accum},
1115 @code{_Accum},
1116 @code{long _Accum},
1117 @code{long long _Accum},
1118 @code{unsigned short _Accum},
1119 @code{unsigned _Accum},
1120 @code{unsigned long _Accum},
1121 @code{unsigned long long _Accum},
1122 @code{_Sat short _Accum},
1123 @code{_Sat _Accum},
1124 @code{_Sat long _Accum},
1125 @code{_Sat long long _Accum},
1126 @code{_Sat unsigned short _Accum},
1127 @code{_Sat unsigned _Accum},
1128 @code{_Sat unsigned long _Accum},
1129 @code{_Sat unsigned long long _Accum}.
1131 Fixed-point data values contain fractional and optional integral parts.
1132 The format of fixed-point data varies and depends on the target machine.
1134 Support for fixed-point types includes:
1135 @itemize @bullet
1136 @item
1137 prefix and postfix increment and decrement operators (@code{++}, @code{--})
1138 @item
1139 unary arithmetic operators (@code{+}, @code{-}, @code{!})
1140 @item
1141 binary arithmetic operators (@code{+}, @code{-}, @code{*}, @code{/})
1142 @item
1143 binary shift operators (@code{<<}, @code{>>})
1144 @item
1145 relational operators (@code{<}, @code{<=}, @code{>=}, @code{>})
1146 @item
1147 equality operators (@code{==}, @code{!=})
1148 @item
1149 assignment operators (@code{+=}, @code{-=}, @code{*=}, @code{/=},
1150 @code{<<=}, @code{>>=})
1151 @item
1152 conversions to and from integer, floating-point, or fixed-point types
1153 @end itemize
1155 Use a suffix in a fixed-point literal constant:
1156 @itemize
1157 @item @samp{hr} or @samp{HR} for @code{short _Fract} and
1158 @code{_Sat short _Fract}
1159 @item @samp{r} or @samp{R} for @code{_Fract} and @code{_Sat _Fract}
1160 @item @samp{lr} or @samp{LR} for @code{long _Fract} and
1161 @code{_Sat long _Fract}
1162 @item @samp{llr} or @samp{LLR} for @code{long long _Fract} and
1163 @code{_Sat long long _Fract}
1164 @item @samp{uhr} or @samp{UHR} for @code{unsigned short _Fract} and
1165 @code{_Sat unsigned short _Fract}
1166 @item @samp{ur} or @samp{UR} for @code{unsigned _Fract} and
1167 @code{_Sat unsigned _Fract}
1168 @item @samp{ulr} or @samp{ULR} for @code{unsigned long _Fract} and
1169 @code{_Sat unsigned long _Fract}
1170 @item @samp{ullr} or @samp{ULLR} for @code{unsigned long long _Fract}
1171 and @code{_Sat unsigned long long _Fract}
1172 @item @samp{hk} or @samp{HK} for @code{short _Accum} and
1173 @code{_Sat short _Accum}
1174 @item @samp{k} or @samp{K} for @code{_Accum} and @code{_Sat _Accum}
1175 @item @samp{lk} or @samp{LK} for @code{long _Accum} and
1176 @code{_Sat long _Accum}
1177 @item @samp{llk} or @samp{LLK} for @code{long long _Accum} and
1178 @code{_Sat long long _Accum}
1179 @item @samp{uhk} or @samp{UHK} for @code{unsigned short _Accum} and
1180 @code{_Sat unsigned short _Accum}
1181 @item @samp{uk} or @samp{UK} for @code{unsigned _Accum} and
1182 @code{_Sat unsigned _Accum}
1183 @item @samp{ulk} or @samp{ULK} for @code{unsigned long _Accum} and
1184 @code{_Sat unsigned long _Accum}
1185 @item @samp{ullk} or @samp{ULLK} for @code{unsigned long long _Accum}
1186 and @code{_Sat unsigned long long _Accum}
1187 @end itemize
1189 GCC support of fixed-point types as specified by the draft technical report
1190 is incomplete:
1192 @itemize @bullet
1193 @item
1194 Pragmas to control overflow and rounding behaviors are not implemented.
1195 @end itemize
1197 Fixed-point types are supported by the DWARF2 debug information format.
1199 @node Zero Length
1200 @section Arrays of Length Zero
1201 @cindex arrays of length zero
1202 @cindex zero-length arrays
1203 @cindex length-zero arrays
1204 @cindex flexible array members
1206 Zero-length arrays are allowed in GNU C@.  They are very useful as the
1207 last element of a structure which is really a header for a variable-length
1208 object:
1210 @smallexample
1211 struct line @{
1212   int length;
1213   char contents[0];
1216 struct line *thisline = (struct line *)
1217   malloc (sizeof (struct line) + this_length);
1218 thisline->length = this_length;
1219 @end smallexample
1221 In ISO C90, you would have to give @code{contents} a length of 1, which
1222 means either you waste space or complicate the argument to @code{malloc}.
1224 In ISO C99, you would use a @dfn{flexible array member}, which is
1225 slightly different in syntax and semantics:
1227 @itemize @bullet
1228 @item
1229 Flexible array members are written as @code{contents[]} without
1230 the @code{0}.
1232 @item
1233 Flexible array members have incomplete type, and so the @code{sizeof}
1234 operator may not be applied.  As a quirk of the original implementation
1235 of zero-length arrays, @code{sizeof} evaluates to zero.
1237 @item
1238 Flexible array members may only appear as the last member of a
1239 @code{struct} that is otherwise non-empty.
1241 @item
1242 A structure containing a flexible array member, or a union containing
1243 such a structure (possibly recursively), may not be a member of a
1244 structure or an element of an array.  (However, these uses are
1245 permitted by GCC as extensions.)
1246 @end itemize
1248 GCC versions before 3.0 allowed zero-length arrays to be statically
1249 initialized, as if they were flexible arrays.  In addition to those
1250 cases that were useful, it also allowed initializations in situations
1251 that would corrupt later data.  Non-empty initialization of zero-length
1252 arrays is now treated like any case where there are more initializer
1253 elements than the array holds, in that a suitable warning about "excess
1254 elements in array" is given, and the excess elements (all of them, in
1255 this case) are ignored.
1257 Instead GCC allows static initialization of flexible array members.
1258 This is equivalent to defining a new structure containing the original
1259 structure followed by an array of sufficient size to contain the data.
1260 I.e.@: in the following, @code{f1} is constructed as if it were declared
1261 like @code{f2}.
1263 @smallexample
1264 struct f1 @{
1265   int x; int y[];
1266 @} f1 = @{ 1, @{ 2, 3, 4 @} @};
1268 struct f2 @{
1269   struct f1 f1; int data[3];
1270 @} f2 = @{ @{ 1 @}, @{ 2, 3, 4 @} @};
1271 @end smallexample
1273 @noindent
1274 The convenience of this extension is that @code{f1} has the desired
1275 type, eliminating the need to consistently refer to @code{f2.f1}.
1277 This has symmetry with normal static arrays, in that an array of
1278 unknown size is also written with @code{[]}.
1280 Of course, this extension only makes sense if the extra data comes at
1281 the end of a top-level object, as otherwise we would be overwriting
1282 data at subsequent offsets.  To avoid undue complication and confusion
1283 with initialization of deeply nested arrays, we simply disallow any
1284 non-empty initialization except when the structure is the top-level
1285 object.  For example:
1287 @smallexample
1288 struct foo @{ int x; int y[]; @};
1289 struct bar @{ struct foo z; @};
1291 struct foo a = @{ 1, @{ 2, 3, 4 @} @};        // @r{Valid.}
1292 struct bar b = @{ @{ 1, @{ 2, 3, 4 @} @} @};    // @r{Invalid.}
1293 struct bar c = @{ @{ 1, @{ @} @} @};            // @r{Valid.}
1294 struct foo d[1] = @{ @{ 1 @{ 2, 3, 4 @} @} @};  // @r{Invalid.}
1295 @end smallexample
1297 @node Empty Structures
1298 @section Structures With No Members
1299 @cindex empty structures
1300 @cindex zero-size structures
1302 GCC permits a C structure to have no members:
1304 @smallexample
1305 struct empty @{
1307 @end smallexample
1309 The structure will have size zero.  In C++, empty structures are part
1310 of the language.  G++ treats empty structures as if they had a single
1311 member of type @code{char}.
1313 @node Variable Length
1314 @section Arrays of Variable Length
1315 @cindex variable-length arrays
1316 @cindex arrays of variable length
1317 @cindex VLAs
1319 Variable-length automatic arrays are allowed in ISO C99, and as an
1320 extension GCC accepts them in C89 mode and in C++.  (However, GCC's
1321 implementation of variable-length arrays does not yet conform in detail
1322 to the ISO C99 standard.)  These arrays are
1323 declared like any other automatic arrays, but with a length that is not
1324 a constant expression.  The storage is allocated at the point of
1325 declaration and deallocated when the brace-level is exited.  For
1326 example:
1328 @smallexample
1329 FILE *
1330 concat_fopen (char *s1, char *s2, char *mode)
1332   char str[strlen (s1) + strlen (s2) + 1];
1333   strcpy (str, s1);
1334   strcat (str, s2);
1335   return fopen (str, mode);
1337 @end smallexample
1339 @cindex scope of a variable length array
1340 @cindex variable-length array scope
1341 @cindex deallocating variable length arrays
1342 Jumping or breaking out of the scope of the array name deallocates the
1343 storage.  Jumping into the scope is not allowed; you get an error
1344 message for it.
1346 @cindex @code{alloca} vs variable-length arrays
1347 You can use the function @code{alloca} to get an effect much like
1348 variable-length arrays.  The function @code{alloca} is available in
1349 many other C implementations (but not in all).  On the other hand,
1350 variable-length arrays are more elegant.
1352 There are other differences between these two methods.  Space allocated
1353 with @code{alloca} exists until the containing @emph{function} returns.
1354 The space for a variable-length array is deallocated as soon as the array
1355 name's scope ends.  (If you use both variable-length arrays and
1356 @code{alloca} in the same function, deallocation of a variable-length array
1357 will also deallocate anything more recently allocated with @code{alloca}.)
1359 You can also use variable-length arrays as arguments to functions:
1361 @smallexample
1362 struct entry
1363 tester (int len, char data[len][len])
1365   /* @r{@dots{}} */
1367 @end smallexample
1369 The length of an array is computed once when the storage is allocated
1370 and is remembered for the scope of the array in case you access it with
1371 @code{sizeof}.
1373 If you want to pass the array first and the length afterward, you can
1374 use a forward declaration in the parameter list---another GNU extension.
1376 @smallexample
1377 struct entry
1378 tester (int len; char data[len][len], int len)
1380   /* @r{@dots{}} */
1382 @end smallexample
1384 @cindex parameter forward declaration
1385 The @samp{int len} before the semicolon is a @dfn{parameter forward
1386 declaration}, and it serves the purpose of making the name @code{len}
1387 known when the declaration of @code{data} is parsed.
1389 You can write any number of such parameter forward declarations in the
1390 parameter list.  They can be separated by commas or semicolons, but the
1391 last one must end with a semicolon, which is followed by the ``real''
1392 parameter declarations.  Each forward declaration must match a ``real''
1393 declaration in parameter name and data type.  ISO C99 does not support
1394 parameter forward declarations.
1396 @node Variadic Macros
1397 @section Macros with a Variable Number of Arguments.
1398 @cindex variable number of arguments
1399 @cindex macro with variable arguments
1400 @cindex rest argument (in macro)
1401 @cindex variadic macros
1403 In the ISO C standard of 1999, a macro can be declared to accept a
1404 variable number of arguments much as a function can.  The syntax for
1405 defining the macro is similar to that of a function.  Here is an
1406 example:
1408 @smallexample
1409 #define debug(format, ...) fprintf (stderr, format, __VA_ARGS__)
1410 @end smallexample
1412 Here @samp{@dots{}} is a @dfn{variable argument}.  In the invocation of
1413 such a macro, it represents the zero or more tokens until the closing
1414 parenthesis that ends the invocation, including any commas.  This set of
1415 tokens replaces the identifier @code{__VA_ARGS__} in the macro body
1416 wherever it appears.  See the CPP manual for more information.
1418 GCC has long supported variadic macros, and used a different syntax that
1419 allowed you to give a name to the variable arguments just like any other
1420 argument.  Here is an example:
1422 @smallexample
1423 #define debug(format, args...) fprintf (stderr, format, args)
1424 @end smallexample
1426 This is in all ways equivalent to the ISO C example above, but arguably
1427 more readable and descriptive.
1429 GNU CPP has two further variadic macro extensions, and permits them to
1430 be used with either of the above forms of macro definition.
1432 In standard C, you are not allowed to leave the variable argument out
1433 entirely; but you are allowed to pass an empty argument.  For example,
1434 this invocation is invalid in ISO C, because there is no comma after
1435 the string:
1437 @smallexample
1438 debug ("A message")
1439 @end smallexample
1441 GNU CPP permits you to completely omit the variable arguments in this
1442 way.  In the above examples, the compiler would complain, though since
1443 the expansion of the macro still has the extra comma after the format
1444 string.
1446 To help solve this problem, CPP behaves specially for variable arguments
1447 used with the token paste operator, @samp{##}.  If instead you write
1449 @smallexample
1450 #define debug(format, ...) fprintf (stderr, format, ## __VA_ARGS__)
1451 @end smallexample
1453 and if the variable arguments are omitted or empty, the @samp{##}
1454 operator causes the preprocessor to remove the comma before it.  If you
1455 do provide some variable arguments in your macro invocation, GNU CPP
1456 does not complain about the paste operation and instead places the
1457 variable arguments after the comma.  Just like any other pasted macro
1458 argument, these arguments are not macro expanded.
1460 @node Escaped Newlines
1461 @section Slightly Looser Rules for Escaped Newlines
1462 @cindex escaped newlines
1463 @cindex newlines (escaped)
1465 Recently, the preprocessor has relaxed its treatment of escaped
1466 newlines.  Previously, the newline had to immediately follow a
1467 backslash.  The current implementation allows whitespace in the form
1468 of spaces, horizontal and vertical tabs, and form feeds between the
1469 backslash and the subsequent newline.  The preprocessor issues a
1470 warning, but treats it as a valid escaped newline and combines the two
1471 lines to form a single logical line.  This works within comments and
1472 tokens, as well as between tokens.  Comments are @emph{not} treated as
1473 whitespace for the purposes of this relaxation, since they have not
1474 yet been replaced with spaces.
1476 @node Subscripting
1477 @section Non-Lvalue Arrays May Have Subscripts
1478 @cindex subscripting
1479 @cindex arrays, non-lvalue
1481 @cindex subscripting and function values
1482 In ISO C99, arrays that are not lvalues still decay to pointers, and
1483 may be subscripted, although they may not be modified or used after
1484 the next sequence point and the unary @samp{&} operator may not be
1485 applied to them.  As an extension, GCC allows such arrays to be
1486 subscripted in C89 mode, though otherwise they do not decay to
1487 pointers outside C99 mode.  For example,
1488 this is valid in GNU C though not valid in C89:
1490 @smallexample
1491 @group
1492 struct foo @{int a[4];@};
1494 struct foo f();
1496 bar (int index)
1498   return f().a[index];
1500 @end group
1501 @end smallexample
1503 @node Pointer Arith
1504 @section Arithmetic on @code{void}- and Function-Pointers
1505 @cindex void pointers, arithmetic
1506 @cindex void, size of pointer to
1507 @cindex function pointers, arithmetic
1508 @cindex function, size of pointer to
1510 In GNU C, addition and subtraction operations are supported on pointers to
1511 @code{void} and on pointers to functions.  This is done by treating the
1512 size of a @code{void} or of a function as 1.
1514 A consequence of this is that @code{sizeof} is also allowed on @code{void}
1515 and on function types, and returns 1.
1517 @opindex Wpointer-arith
1518 The option @option{-Wpointer-arith} requests a warning if these extensions
1519 are used.
1521 @node Initializers
1522 @section Non-Constant Initializers
1523 @cindex initializers, non-constant
1524 @cindex non-constant initializers
1526 As in standard C++ and ISO C99, the elements of an aggregate initializer for an
1527 automatic variable are not required to be constant expressions in GNU C@.
1528 Here is an example of an initializer with run-time varying elements:
1530 @smallexample
1531 foo (float f, float g)
1533   float beat_freqs[2] = @{ f-g, f+g @};
1534   /* @r{@dots{}} */
1536 @end smallexample
1538 @node Compound Literals
1539 @section Compound Literals
1540 @cindex constructor expressions
1541 @cindex initializations in expressions
1542 @cindex structures, constructor expression
1543 @cindex expressions, constructor
1544 @cindex compound literals
1545 @c The GNU C name for what C99 calls compound literals was "constructor expressions".
1547 ISO C99 supports compound literals.  A compound literal looks like
1548 a cast containing an initializer.  Its value is an object of the
1549 type specified in the cast, containing the elements specified in
1550 the initializer; it is an lvalue.  As an extension, GCC supports
1551 compound literals in C89 mode and in C++.
1553 Usually, the specified type is a structure.  Assume that
1554 @code{struct foo} and @code{structure} are declared as shown:
1556 @smallexample
1557 struct foo @{int a; char b[2];@} structure;
1558 @end smallexample
1560 @noindent
1561 Here is an example of constructing a @code{struct foo} with a compound literal:
1563 @smallexample
1564 structure = ((struct foo) @{x + y, 'a', 0@});
1565 @end smallexample
1567 @noindent
1568 This is equivalent to writing the following:
1570 @smallexample
1572   struct foo temp = @{x + y, 'a', 0@};
1573   structure = temp;
1575 @end smallexample
1577 You can also construct an array.  If all the elements of the compound literal
1578 are (made up of) simple constant expressions, suitable for use in
1579 initializers of objects of static storage duration, then the compound
1580 literal can be coerced to a pointer to its first element and used in
1581 such an initializer, as shown here:
1583 @smallexample
1584 char **foo = (char *[]) @{ "x", "y", "z" @};
1585 @end smallexample
1587 Compound literals for scalar types and union types are is
1588 also allowed, but then the compound literal is equivalent
1589 to a cast.
1591 As a GNU extension, GCC allows initialization of objects with static storage
1592 duration by compound literals (which is not possible in ISO C99, because
1593 the initializer is not a constant).
1594 It is handled as if the object was initialized only with the bracket
1595 enclosed list if the types of the compound literal and the object match.
1596 The initializer list of the compound literal must be constant.
1597 If the object being initialized has array type of unknown size, the size is
1598 determined by compound literal size.
1600 @smallexample
1601 static struct foo x = (struct foo) @{1, 'a', 'b'@};
1602 static int y[] = (int []) @{1, 2, 3@};
1603 static int z[] = (int [3]) @{1@};
1604 @end smallexample
1606 @noindent
1607 The above lines are equivalent to the following:
1608 @smallexample
1609 static struct foo x = @{1, 'a', 'b'@};
1610 static int y[] = @{1, 2, 3@};
1611 static int z[] = @{1, 0, 0@};
1612 @end smallexample
1614 @node Designated Inits
1615 @section Designated Initializers
1616 @cindex initializers with labeled elements
1617 @cindex labeled elements in initializers
1618 @cindex case labels in initializers
1619 @cindex designated initializers
1621 Standard C89 requires the elements of an initializer to appear in a fixed
1622 order, the same as the order of the elements in the array or structure
1623 being initialized.
1625 In ISO C99 you can give the elements in any order, specifying the array
1626 indices or structure field names they apply to, and GNU C allows this as
1627 an extension in C89 mode as well.  This extension is not
1628 implemented in GNU C++.
1630 To specify an array index, write
1631 @samp{[@var{index}] =} before the element value.  For example,
1633 @smallexample
1634 int a[6] = @{ [4] = 29, [2] = 15 @};
1635 @end smallexample
1637 @noindent
1638 is equivalent to
1640 @smallexample
1641 int a[6] = @{ 0, 0, 15, 0, 29, 0 @};
1642 @end smallexample
1644 @noindent
1645 The index values must be constant expressions, even if the array being
1646 initialized is automatic.
1648 An alternative syntax for this which has been obsolete since GCC 2.5 but
1649 GCC still accepts is to write @samp{[@var{index}]} before the element
1650 value, with no @samp{=}.
1652 To initialize a range of elements to the same value, write
1653 @samp{[@var{first} ... @var{last}] = @var{value}}.  This is a GNU
1654 extension.  For example,
1656 @smallexample
1657 int widths[] = @{ [0 ... 9] = 1, [10 ... 99] = 2, [100] = 3 @};
1658 @end smallexample
1660 @noindent
1661 If the value in it has side-effects, the side-effects will happen only once,
1662 not for each initialized field by the range initializer.
1664 @noindent
1665 Note that the length of the array is the highest value specified
1666 plus one.
1668 In a structure initializer, specify the name of a field to initialize
1669 with @samp{.@var{fieldname} =} before the element value.  For example,
1670 given the following structure,
1672 @smallexample
1673 struct point @{ int x, y; @};
1674 @end smallexample
1676 @noindent
1677 the following initialization
1679 @smallexample
1680 struct point p = @{ .y = yvalue, .x = xvalue @};
1681 @end smallexample
1683 @noindent
1684 is equivalent to
1686 @smallexample
1687 struct point p = @{ xvalue, yvalue @};
1688 @end smallexample
1690 Another syntax which has the same meaning, obsolete since GCC 2.5, is
1691 @samp{@var{fieldname}:}, as shown here:
1693 @smallexample
1694 struct point p = @{ y: yvalue, x: xvalue @};
1695 @end smallexample
1697 @cindex designators
1698 The @samp{[@var{index}]} or @samp{.@var{fieldname}} is known as a
1699 @dfn{designator}.  You can also use a designator (or the obsolete colon
1700 syntax) when initializing a union, to specify which element of the union
1701 should be used.  For example,
1703 @smallexample
1704 union foo @{ int i; double d; @};
1706 union foo f = @{ .d = 4 @};
1707 @end smallexample
1709 @noindent
1710 will convert 4 to a @code{double} to store it in the union using
1711 the second element.  By contrast, casting 4 to type @code{union foo}
1712 would store it into the union as the integer @code{i}, since it is
1713 an integer.  (@xref{Cast to Union}.)
1715 You can combine this technique of naming elements with ordinary C
1716 initialization of successive elements.  Each initializer element that
1717 does not have a designator applies to the next consecutive element of the
1718 array or structure.  For example,
1720 @smallexample
1721 int a[6] = @{ [1] = v1, v2, [4] = v4 @};
1722 @end smallexample
1724 @noindent
1725 is equivalent to
1727 @smallexample
1728 int a[6] = @{ 0, v1, v2, 0, v4, 0 @};
1729 @end smallexample
1731 Labeling the elements of an array initializer is especially useful
1732 when the indices are characters or belong to an @code{enum} type.
1733 For example:
1735 @smallexample
1736 int whitespace[256]
1737   = @{ [' '] = 1, ['\t'] = 1, ['\h'] = 1,
1738       ['\f'] = 1, ['\n'] = 1, ['\r'] = 1 @};
1739 @end smallexample
1741 @cindex designator lists
1742 You can also write a series of @samp{.@var{fieldname}} and
1743 @samp{[@var{index}]} designators before an @samp{=} to specify a
1744 nested subobject to initialize; the list is taken relative to the
1745 subobject corresponding to the closest surrounding brace pair.  For
1746 example, with the @samp{struct point} declaration above:
1748 @smallexample
1749 struct point ptarray[10] = @{ [2].y = yv2, [2].x = xv2, [0].x = xv0 @};
1750 @end smallexample
1752 @noindent
1753 If the same field is initialized multiple times, it will have value from
1754 the last initialization.  If any such overridden initialization has
1755 side-effect, it is unspecified whether the side-effect happens or not.
1756 Currently, GCC will discard them and issue a warning.
1758 @node Case Ranges
1759 @section Case Ranges
1760 @cindex case ranges
1761 @cindex ranges in case statements
1763 You can specify a range of consecutive values in a single @code{case} label,
1764 like this:
1766 @smallexample
1767 case @var{low} ... @var{high}:
1768 @end smallexample
1770 @noindent
1771 This has the same effect as the proper number of individual @code{case}
1772 labels, one for each integer value from @var{low} to @var{high}, inclusive.
1774 This feature is especially useful for ranges of ASCII character codes:
1776 @smallexample
1777 case 'A' ... 'Z':
1778 @end smallexample
1780 @strong{Be careful:} Write spaces around the @code{...}, for otherwise
1781 it may be parsed wrong when you use it with integer values.  For example,
1782 write this:
1784 @smallexample
1785 case 1 ... 5:
1786 @end smallexample
1788 @noindent
1789 rather than this:
1791 @smallexample
1792 case 1...5:
1793 @end smallexample
1795 @node Cast to Union
1796 @section Cast to a Union Type
1797 @cindex cast to a union
1798 @cindex union, casting to a
1800 A cast to union type is similar to other casts, except that the type
1801 specified is a union type.  You can specify the type either with
1802 @code{union @var{tag}} or with a typedef name.  A cast to union is actually
1803 a constructor though, not a cast, and hence does not yield an lvalue like
1804 normal casts.  (@xref{Compound Literals}.)
1806 The types that may be cast to the union type are those of the members
1807 of the union.  Thus, given the following union and variables:
1809 @smallexample
1810 union foo @{ int i; double d; @};
1811 int x;
1812 double y;
1813 @end smallexample
1815 @noindent
1816 both @code{x} and @code{y} can be cast to type @code{union foo}.
1818 Using the cast as the right-hand side of an assignment to a variable of
1819 union type is equivalent to storing in a member of the union:
1821 @smallexample
1822 union foo u;
1823 /* @r{@dots{}} */
1824 u = (union foo) x  @equiv{}  u.i = x
1825 u = (union foo) y  @equiv{}  u.d = y
1826 @end smallexample
1828 You can also use the union cast as a function argument:
1830 @smallexample
1831 void hack (union foo);
1832 /* @r{@dots{}} */
1833 hack ((union foo) x);
1834 @end smallexample
1836 @node Mixed Declarations
1837 @section Mixed Declarations and Code
1838 @cindex mixed declarations and code
1839 @cindex declarations, mixed with code
1840 @cindex code, mixed with declarations
1842 ISO C99 and ISO C++ allow declarations and code to be freely mixed
1843 within compound statements.  As an extension, GCC also allows this in
1844 C89 mode.  For example, you could do:
1846 @smallexample
1847 int i;
1848 /* @r{@dots{}} */
1849 i++;
1850 int j = i + 2;
1851 @end smallexample
1853 Each identifier is visible from where it is declared until the end of
1854 the enclosing block.
1856 @node Function Attributes
1857 @section Declaring Attributes of Functions
1858 @cindex function attributes
1859 @cindex declaring attributes of functions
1860 @cindex functions that never return
1861 @cindex functions that return more than once
1862 @cindex functions that have no side effects
1863 @cindex functions in arbitrary sections
1864 @cindex functions that behave like malloc
1865 @cindex @code{volatile} applied to function
1866 @cindex @code{const} applied to function
1867 @cindex functions with @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style arguments
1868 @cindex functions with non-null pointer arguments
1869 @cindex functions that are passed arguments in registers on the 386
1870 @cindex functions that pop the argument stack on the 386
1871 @cindex functions that do not pop the argument stack on the 386
1872 @cindex functions that have different compilation options on the 386
1873 @cindex functions that have different optimization options
1875 In GNU C, you declare certain things about functions called in your program
1876 which help the compiler optimize function calls and check your code more
1877 carefully.
1879 The keyword @code{__attribute__} allows you to specify special
1880 attributes when making a declaration.  This keyword is followed by an
1881 attribute specification inside double parentheses.  The following
1882 attributes are currently defined for functions on all targets:
1883 @code{aligned}, @code{alloc_size}, @code{noreturn},
1884 @code{returns_twice}, @code{noinline}, @code{always_inline},
1885 @code{flatten}, @code{pure}, @code{const}, @code{nothrow},
1886 @code{sentinel}, @code{format}, @code{format_arg},
1887 @code{no_instrument_function}, @code{section}, @code{constructor},
1888 @code{destructor}, @code{used}, @code{unused}, @code{deprecated},
1889 @code{weak}, @code{malloc}, @code{alias}, @code{warn_unused_result},
1890 @code{nonnull}, @code{gnu_inline}, @code{externally_visible},
1891 @code{hot}, @code{cold}, @code{artificial}, @code{error}
1892 and @code{warning}.
1893 Several other attributes are defined for functions on particular
1894 target systems.  Other attributes, including @code{section} are
1895 supported for variables declarations (@pxref{Variable Attributes}) and
1896 for types (@pxref{Type Attributes}).
1898 You may also specify attributes with @samp{__} preceding and following
1899 each keyword.  This allows you to use them in header files without
1900 being concerned about a possible macro of the same name.  For example,
1901 you may use @code{__noreturn__} instead of @code{noreturn}.
1903 @xref{Attribute Syntax}, for details of the exact syntax for using
1904 attributes.
1906 @table @code
1907 @c Keep this table alphabetized by attribute name.  Treat _ as space.
1909 @item alias ("@var{target}")
1910 @cindex @code{alias} attribute
1911 The @code{alias} attribute causes the declaration to be emitted as an
1912 alias for another symbol, which must be specified.  For instance,
1914 @smallexample
1915 void __f () @{ /* @r{Do something.} */; @}
1916 void f () __attribute__ ((weak, alias ("__f")));
1917 @end smallexample
1919 defines @samp{f} to be a weak alias for @samp{__f}.  In C++, the
1920 mangled name for the target must be used.  It is an error if @samp{__f}
1921 is not defined in the same translation unit.
1923 Not all target machines support this attribute.
1925 @item aligned (@var{alignment})
1926 @cindex @code{aligned} attribute
1927 This attribute specifies a minimum alignment for the function,
1928 measured in bytes.
1930 You cannot use this attribute to decrease the alignment of a function,
1931 only to increase it.  However, when you explicitly specify a function
1932 alignment this will override the effect of the
1933 @option{-falign-functions} (@pxref{Optimize Options}) option for this
1934 function.
1936 Note that the effectiveness of @code{aligned} attributes may be
1937 limited by inherent limitations in your linker.  On many systems, the
1938 linker is only able to arrange for functions to be aligned up to a
1939 certain maximum alignment.  (For some linkers, the maximum supported
1940 alignment may be very very small.)  See your linker documentation for
1941 further information.
1943 The @code{aligned} attribute can also be used for variables and fields
1944 (@pxref{Variable Attributes}.)
1946 @item alloc_size
1947 @cindex @code{alloc_size} attribute
1948 The @code{alloc_size} attribute is used to tell the compiler that the
1949 function return value points to memory, where the size is given by
1950 one or two of the functions parameters.  GCC uses this 
1951 information to improve the correctness of @code{__builtin_object_size}.
1953 The function parameter(s) denoting the allocated size are specified by
1954 one or two integer arguments supplied to the attribute.  The allocated size
1955 is either the value of the single function argument specified or the product
1956 of the two function arguments specified.  Argument numbering starts at
1957 one.
1959 For instance, 
1961 @smallexample
1962 void* my_calloc(size_t, size_t) __attribute__((alloc_size(1,2)))
1963 void my_realloc(void*, size_t) __attribute__((alloc_size(2)))
1964 @end smallexample
1966 declares that my_calloc will return memory of the size given by
1967 the product of parameter 1 and 2 and that my_realloc will return memory
1968 of the size given by parameter 2.
1970 @item always_inline
1971 @cindex @code{always_inline} function attribute
1972 Generally, functions are not inlined unless optimization is specified.
1973 For functions declared inline, this attribute inlines the function even
1974 if no optimization level was specified.
1976 @item gnu_inline
1977 @cindex @code{gnu_inline} function attribute
1978 This attribute should be used with a function which is also declared
1979 with the @code{inline} keyword.  It directs GCC to treat the function
1980 as if it were defined in gnu89 mode even when compiling in C99 or
1981 gnu99 mode.
1983 If the function is declared @code{extern}, then this definition of the
1984 function is used only for inlining.  In no case is the function
1985 compiled as a standalone function, not even if you take its address
1986 explicitly.  Such an address becomes an external reference, as if you
1987 had only declared the function, and had not defined it.  This has
1988 almost the effect of a macro.  The way to use this is to put a
1989 function definition in a header file with this attribute, and put
1990 another copy of the function, without @code{extern}, in a library
1991 file.  The definition in the header file will cause most calls to the
1992 function to be inlined.  If any uses of the function remain, they will
1993 refer to the single copy in the library.  Note that the two
1994 definitions of the functions need not be precisely the same, although
1995 if they do not have the same effect your program may behave oddly.
1997 In C, if the function is neither @code{extern} nor @code{static}, then
1998 the function is compiled as a standalone function, as well as being
1999 inlined where possible.
2001 This is how GCC traditionally handled functions declared
2002 @code{inline}.  Since ISO C99 specifies a different semantics for
2003 @code{inline}, this function attribute is provided as a transition
2004 measure and as a useful feature in its own right.  This attribute is
2005 available in GCC 4.1.3 and later.  It is available if either of the
2006 preprocessor macros @code{__GNUC_GNU_INLINE__} or
2007 @code{__GNUC_STDC_INLINE__} are defined.  @xref{Inline,,An Inline
2008 Function is As Fast As a Macro}.
2010 In C++, this attribute does not depend on @code{extern} in any way,
2011 but it still requires the @code{inline} keyword to enable its special
2012 behavior.
2014 @item artificial
2015 @cindex @code{artificial} function attribute
2016 This attribute is useful for small inline wrappers which if possible
2017 should appear during debugging as a unit, depending on the debug
2018 info format it will either mean marking the function as artificial
2019 or using the caller location for all instructions within the inlined
2020 body.
2022 @item flatten
2023 @cindex @code{flatten} function attribute
2024 Generally, inlining into a function is limited.  For a function marked with
2025 this attribute, every call inside this function will be inlined, if possible.
2026 Whether the function itself is considered for inlining depends on its size and
2027 the current inlining parameters.
2029 @item error ("@var{message}")
2030 @cindex @code{error} function attribute
2031 If this attribute is used on a function declaration and a call to such a function
2032 is not eliminated through dead code elimination or other optimizations, an error
2033 which will include @var{message} will be diagnosed.  This is useful
2034 for compile time checking, especially together with @code{__builtin_constant_p}
2035 and inline functions where checking the inline function arguments is not
2036 possible through @code{extern char [(condition) ? 1 : -1];} tricks.
2037 While it is possible to leave the function undefined and thus invoke
2038 a link failure, when using this attribute the problem will be diagnosed
2039 earlier and with exact location of the call even in presence of inline
2040 functions or when not emitting debugging information.
2042 @item warning ("@var{message}")
2043 @cindex @code{warning} function attribute
2044 If this attribute is used on a function declaration and a call to such a function
2045 is not eliminated through dead code elimination or other optimizations, a warning
2046 which will include @var{message} will be diagnosed.  This is useful
2047 for compile time checking, especially together with @code{__builtin_constant_p}
2048 and inline functions.  While it is possible to define the function with
2049 a message in @code{.gnu.warning*} section, when using this attribute the problem
2050 will be diagnosed earlier and with exact location of the call even in presence
2051 of inline functions or when not emitting debugging information.
2053 @item cdecl
2054 @cindex functions that do pop the argument stack on the 386
2055 @opindex mrtd
2056 On the Intel 386, the @code{cdecl} attribute causes the compiler to
2057 assume that the calling function will pop off the stack space used to
2058 pass arguments.  This is
2059 useful to override the effects of the @option{-mrtd} switch.
2061 @item const
2062 @cindex @code{const} function attribute
2063 Many functions do not examine any values except their arguments, and
2064 have no effects except the return value.  Basically this is just slightly
2065 more strict class than the @code{pure} attribute below, since function is not
2066 allowed to read global memory.
2068 @cindex pointer arguments
2069 Note that a function that has pointer arguments and examines the data
2070 pointed to must @emph{not} be declared @code{const}.  Likewise, a
2071 function that calls a non-@code{const} function usually must not be
2072 @code{const}.  It does not make sense for a @code{const} function to
2073 return @code{void}.
2075 The attribute @code{const} is not implemented in GCC versions earlier
2076 than 2.5.  An alternative way to declare that a function has no side
2077 effects, which works in the current version and in some older versions,
2078 is as follows:
2080 @smallexample
2081 typedef int intfn ();
2083 extern const intfn square;
2084 @end smallexample
2086 This approach does not work in GNU C++ from 2.6.0 on, since the language
2087 specifies that the @samp{const} must be attached to the return value.
2089 @item constructor
2090 @itemx destructor
2091 @itemx constructor (@var{priority})
2092 @itemx destructor (@var{priority})
2093 @cindex @code{constructor} function attribute
2094 @cindex @code{destructor} function attribute
2095 The @code{constructor} attribute causes the function to be called
2096 automatically before execution enters @code{main ()}.  Similarly, the
2097 @code{destructor} attribute causes the function to be called
2098 automatically after @code{main ()} has completed or @code{exit ()} has
2099 been called.  Functions with these attributes are useful for
2100 initializing data that will be used implicitly during the execution of
2101 the program.
2103 You may provide an optional integer priority to control the order in
2104 which constructor and destructor functions are run.  A constructor
2105 with a smaller priority number runs before a constructor with a larger
2106 priority number; the opposite relationship holds for destructors.  So,
2107 if you have a constructor that allocates a resource and a destructor
2108 that deallocates the same resource, both functions typically have the
2109 same priority.  The priorities for constructor and destructor
2110 functions are the same as those specified for namespace-scope C++
2111 objects (@pxref{C++ Attributes}).
2113 These attributes are not currently implemented for Objective-C@.
2115 @item deprecated
2116 @itemx deprecated (@var{msg})
2117 @cindex @code{deprecated} attribute.
2118 The @code{deprecated} attribute results in a warning if the function
2119 is used anywhere in the source file.  This is useful when identifying
2120 functions that are expected to be removed in a future version of a
2121 program.  The warning also includes the location of the declaration
2122 of the deprecated function, to enable users to easily find further
2123 information about why the function is deprecated, or what they should
2124 do instead.  Note that the warnings only occurs for uses:
2126 @smallexample
2127 int old_fn () __attribute__ ((deprecated));
2128 int old_fn ();
2129 int (*fn_ptr)() = old_fn;
2130 @end smallexample
2132 results in a warning on line 3 but not line 2.  The optional msg
2133 argument, which must be a string, will be printed in the warning if
2134 present.
2136 The @code{deprecated} attribute can also be used for variables and
2137 types (@pxref{Variable Attributes}, @pxref{Type Attributes}.)
2139 @item disinterrupt
2140 @cindex @code{disinterrupt} attribute
2141 On MeP targets, this attribute causes the compiler to emit
2142 instructions to disable interrupts for the duration of the given
2143 function.
2145 @item dllexport
2146 @cindex @code{__declspec(dllexport)}
2147 On Microsoft Windows targets and Symbian OS targets the
2148 @code{dllexport} attribute causes the compiler to provide a global
2149 pointer to a pointer in a DLL, so that it can be referenced with the
2150 @code{dllimport} attribute.  On Microsoft Windows targets, the pointer
2151 name is formed by combining @code{_imp__} and the function or variable
2152 name.
2154 You can use @code{__declspec(dllexport)} as a synonym for
2155 @code{__attribute__ ((dllexport))} for compatibility with other
2156 compilers.
2158 On systems that support the @code{visibility} attribute, this
2159 attribute also implies ``default'' visibility.  It is an error to
2160 explicitly specify any other visibility.
2162 Currently, the @code{dllexport} attribute is ignored for inlined
2163 functions, unless the @option{-fkeep-inline-functions} flag has been
2164 used.  The attribute is also ignored for undefined symbols.
2166 When applied to C++ classes, the attribute marks defined non-inlined
2167 member functions and static data members as exports.  Static consts
2168 initialized in-class are not marked unless they are also defined
2169 out-of-class.
2171 For Microsoft Windows targets there are alternative methods for
2172 including the symbol in the DLL's export table such as using a
2173 @file{.def} file with an @code{EXPORTS} section or, with GNU ld, using
2174 the @option{--export-all} linker flag.
2176 @item dllimport
2177 @cindex @code{__declspec(dllimport)}
2178 On Microsoft Windows and Symbian OS targets, the @code{dllimport}
2179 attribute causes the compiler to reference a function or variable via
2180 a global pointer to a pointer that is set up by the DLL exporting the
2181 symbol.  The attribute implies @code{extern}.  On Microsoft Windows
2182 targets, the pointer name is formed by combining @code{_imp__} and the
2183 function or variable name.
2185 You can use @code{__declspec(dllimport)} as a synonym for
2186 @code{__attribute__ ((dllimport))} for compatibility with other
2187 compilers.
2189 On systems that support the @code{visibility} attribute, this
2190 attribute also implies ``default'' visibility.  It is an error to
2191 explicitly specify any other visibility.
2193 Currently, the attribute is ignored for inlined functions.  If the
2194 attribute is applied to a symbol @emph{definition}, an error is reported.
2195 If a symbol previously declared @code{dllimport} is later defined, the
2196 attribute is ignored in subsequent references, and a warning is emitted.
2197 The attribute is also overridden by a subsequent declaration as
2198 @code{dllexport}.
2200 When applied to C++ classes, the attribute marks non-inlined
2201 member functions and static data members as imports.  However, the
2202 attribute is ignored for virtual methods to allow creation of vtables
2203 using thunks.
2205 On the SH Symbian OS target the @code{dllimport} attribute also has
2206 another affect---it can cause the vtable and run-time type information
2207 for a class to be exported.  This happens when the class has a
2208 dllimport'ed constructor or a non-inline, non-pure virtual function
2209 and, for either of those two conditions, the class also has an inline
2210 constructor or destructor and has a key function that is defined in
2211 the current translation unit.
2213 For Microsoft Windows based targets the use of the @code{dllimport}
2214 attribute on functions is not necessary, but provides a small
2215 performance benefit by eliminating a thunk in the DLL@.  The use of the
2216 @code{dllimport} attribute on imported variables was required on older
2217 versions of the GNU linker, but can now be avoided by passing the
2218 @option{--enable-auto-import} switch to the GNU linker.  As with
2219 functions, using the attribute for a variable eliminates a thunk in
2220 the DLL@.
2222 One drawback to using this attribute is that a pointer to a
2223 @emph{variable} marked as @code{dllimport} cannot be used as a constant
2224 address. However, a pointer to a @emph{function} with the
2225 @code{dllimport} attribute can be used as a constant initializer; in
2226 this case, the address of a stub function in the import lib is
2227 referenced.  On Microsoft Windows targets, the attribute can be disabled
2228 for functions by setting the @option{-mnop-fun-dllimport} flag.
2230 @item eightbit_data
2231 @cindex eight bit data on the H8/300, H8/300H, and H8S
2232 Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
2233 variable should be placed into the eight bit data section.
2234 The compiler will generate more efficient code for certain operations
2235 on data in the eight bit data area.  Note the eight bit data area is limited to
2236 256 bytes of data.
2238 You must use GAS and GLD from GNU binutils version 2.7 or later for
2239 this attribute to work correctly.
2241 @item exception_handler
2242 @cindex exception handler functions on the Blackfin processor
2243 Use this attribute on the Blackfin to indicate that the specified function
2244 is an exception handler.  The compiler will generate function entry and
2245 exit sequences suitable for use in an exception handler when this
2246 attribute is present.
2248 @item externally_visible
2249 @cindex @code{externally_visible} attribute.
2250 This attribute, attached to a global variable or function, nullifies
2251 the effect of the @option{-fwhole-program} command-line option, so the
2252 object remains visible outside the current compilation unit.
2254 @item far
2255 @cindex functions which handle memory bank switching
2256 On 68HC11 and 68HC12 the @code{far} attribute causes the compiler to
2257 use a calling convention that takes care of switching memory banks when
2258 entering and leaving a function.  This calling convention is also the
2259 default when using the @option{-mlong-calls} option.
2261 On 68HC12 the compiler will use the @code{call} and @code{rtc} instructions
2262 to call and return from a function.
2264 On 68HC11 the compiler will generate a sequence of instructions
2265 to invoke a board-specific routine to switch the memory bank and call the
2266 real function.  The board-specific routine simulates a @code{call}.
2267 At the end of a function, it will jump to a board-specific routine
2268 instead of using @code{rts}.  The board-specific return routine simulates
2269 the @code{rtc}.
2271 On MeP targets this causes the compiler to use a calling convention
2272 which assumes the called function is too far away for the built-in
2273 addressing modes.
2275 @item fastcall
2276 @cindex functions that pop the argument stack on the 386
2277 On the Intel 386, the @code{fastcall} attribute causes the compiler to
2278 pass the first argument (if of integral type) in the register ECX and
2279 the second argument (if of integral type) in the register EDX@.  Subsequent
2280 and other typed arguments are passed on the stack.  The called function will
2281 pop the arguments off the stack.  If the number of arguments is variable all
2282 arguments are pushed on the stack.
2284 @item format (@var{archetype}, @var{string-index}, @var{first-to-check})
2285 @cindex @code{format} function attribute
2286 @opindex Wformat
2287 The @code{format} attribute specifies that a function takes @code{printf},
2288 @code{scanf}, @code{strftime} or @code{strfmon} style arguments which
2289 should be type-checked against a format string.  For example, the
2290 declaration:
2292 @smallexample
2293 extern int
2294 my_printf (void *my_object, const char *my_format, ...)
2295       __attribute__ ((format (printf, 2, 3)));
2296 @end smallexample
2298 @noindent
2299 causes the compiler to check the arguments in calls to @code{my_printf}
2300 for consistency with the @code{printf} style format string argument
2301 @code{my_format}.
2303 The parameter @var{archetype} determines how the format string is
2304 interpreted, and should be @code{printf}, @code{scanf}, @code{strftime},
2305 @code{gnu_printf}, @code{gnu_scanf}, @code{gnu_strftime} or
2306 @code{strfmon}.  (You can also use @code{__printf__},
2307 @code{__scanf__}, @code{__strftime__} or @code{__strfmon__}.)  On
2308 MinGW targets, @code{ms_printf}, @code{ms_scanf}, and
2309 @code{ms_strftime} are also present.
2310 @var{archtype} values such as @code{printf} refer to the formats accepted
2311 by the system's C run-time library, while @code{gnu_} values always refer
2312 to the formats accepted by the GNU C Library.  On Microsoft Windows
2313 targets, @code{ms_} values refer to the formats accepted by the
2314 @file{msvcrt.dll} library.
2315 The parameter @var{string-index}
2316 specifies which argument is the format string argument (starting
2317 from 1), while @var{first-to-check} is the number of the first
2318 argument to check against the format string.  For functions
2319 where the arguments are not available to be checked (such as
2320 @code{vprintf}), specify the third parameter as zero.  In this case the
2321 compiler only checks the format string for consistency.  For
2322 @code{strftime} formats, the third parameter is required to be zero.
2323 Since non-static C++ methods have an implicit @code{this} argument, the
2324 arguments of such methods should be counted from two, not one, when
2325 giving values for @var{string-index} and @var{first-to-check}.
2327 In the example above, the format string (@code{my_format}) is the second
2328 argument of the function @code{my_print}, and the arguments to check
2329 start with the third argument, so the correct parameters for the format
2330 attribute are 2 and 3.
2332 @opindex ffreestanding
2333 @opindex fno-builtin
2334 The @code{format} attribute allows you to identify your own functions
2335 which take format strings as arguments, so that GCC can check the
2336 calls to these functions for errors.  The compiler always (unless
2337 @option{-ffreestanding} or @option{-fno-builtin} is used) checks formats
2338 for the standard library functions @code{printf}, @code{fprintf},
2339 @code{sprintf}, @code{scanf}, @code{fscanf}, @code{sscanf}, @code{strftime},
2340 @code{vprintf}, @code{vfprintf} and @code{vsprintf} whenever such
2341 warnings are requested (using @option{-Wformat}), so there is no need to
2342 modify the header file @file{stdio.h}.  In C99 mode, the functions
2343 @code{snprintf}, @code{vsnprintf}, @code{vscanf}, @code{vfscanf} and
2344 @code{vsscanf} are also checked.  Except in strictly conforming C
2345 standard modes, the X/Open function @code{strfmon} is also checked as
2346 are @code{printf_unlocked} and @code{fprintf_unlocked}.
2347 @xref{C Dialect Options,,Options Controlling C Dialect}.
2349 The target may provide additional types of format checks.
2350 @xref{Target Format Checks,,Format Checks Specific to Particular
2351 Target Machines}.
2353 @item format_arg (@var{string-index})
2354 @cindex @code{format_arg} function attribute
2355 @opindex Wformat-nonliteral
2356 The @code{format_arg} attribute specifies that a function takes a format
2357 string for a @code{printf}, @code{scanf}, @code{strftime} or
2358 @code{strfmon} style function and modifies it (for example, to translate
2359 it into another language), so the result can be passed to a
2360 @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style
2361 function (with the remaining arguments to the format function the same
2362 as they would have been for the unmodified string).  For example, the
2363 declaration:
2365 @smallexample
2366 extern char *
2367 my_dgettext (char *my_domain, const char *my_format)
2368       __attribute__ ((format_arg (2)));
2369 @end smallexample
2371 @noindent
2372 causes the compiler to check the arguments in calls to a @code{printf},
2373 @code{scanf}, @code{strftime} or @code{strfmon} type function, whose
2374 format string argument is a call to the @code{my_dgettext} function, for
2375 consistency with the format string argument @code{my_format}.  If the
2376 @code{format_arg} attribute had not been specified, all the compiler
2377 could tell in such calls to format functions would be that the format
2378 string argument is not constant; this would generate a warning when
2379 @option{-Wformat-nonliteral} is used, but the calls could not be checked
2380 without the attribute.
2382 The parameter @var{string-index} specifies which argument is the format
2383 string argument (starting from one).  Since non-static C++ methods have
2384 an implicit @code{this} argument, the arguments of such methods should
2385 be counted from two.
2387 The @code{format-arg} attribute allows you to identify your own
2388 functions which modify format strings, so that GCC can check the
2389 calls to @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon}
2390 type function whose operands are a call to one of your own function.
2391 The compiler always treats @code{gettext}, @code{dgettext}, and
2392 @code{dcgettext} in this manner except when strict ISO C support is
2393 requested by @option{-ansi} or an appropriate @option{-std} option, or
2394 @option{-ffreestanding} or @option{-fno-builtin}
2395 is used.  @xref{C Dialect Options,,Options
2396 Controlling C Dialect}.
2398 @item function_vector
2399 @cindex calling functions through the function vector on H8/300, M16C, M32C and SH2A processors
2400 Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
2401 function should be called through the function vector.  Calling a
2402 function through the function vector will reduce code size, however;
2403 the function vector has a limited size (maximum 128 entries on the H8/300
2404 and 64 entries on the H8/300H and H8S) and shares space with the interrupt vector.
2406 In SH2A target, this attribute declares a function to be called using the
2407 TBR relative addressing mode.  The argument to this attribute is the entry
2408 number of the same function in a vector table containing all the TBR
2409 relative addressable functions.  For the successful jump, register TBR
2410 should contain the start address of this TBR relative vector table.
2411 In the startup routine of the user application, user needs to care of this
2412 TBR register initialization.  The TBR relative vector table can have at
2413 max 256 function entries.  The jumps to these functions will be generated
2414 using a SH2A specific, non delayed branch instruction JSR/N @@(disp8,TBR).
2415 You must use GAS and GLD from GNU binutils version 2.7 or later for
2416 this attribute to work correctly.
2418 Please refer the example of M16C target, to see the use of this
2419 attribute while declaring a function,
2421 In an application, for a function being called once, this attribute will
2422 save at least 8 bytes of code; and if other successive calls are being
2423 made to the same function, it will save 2 bytes of code per each of these
2424 calls.
2426 On M16C/M32C targets, the @code{function_vector} attribute declares a
2427 special page subroutine call function. Use of this attribute reduces
2428 the code size by 2 bytes for each call generated to the
2429 subroutine. The argument to the attribute is the vector number entry
2430 from the special page vector table which contains the 16 low-order
2431 bits of the subroutine's entry address. Each vector table has special
2432 page number (18 to 255) which are used in @code{jsrs} instruction.
2433 Jump addresses of the routines are generated by adding 0x0F0000 (in
2434 case of M16C targets) or 0xFF0000 (in case of M32C targets), to the 2
2435 byte addresses set in the vector table. Therefore you need to ensure
2436 that all the special page vector routines should get mapped within the
2437 address range 0x0F0000 to 0x0FFFFF (for M16C) and 0xFF0000 to 0xFFFFFF
2438 (for M32C).
2440 In the following example 2 bytes will be saved for each call to
2441 function @code{foo}.
2443 @smallexample
2444 void foo (void) __attribute__((function_vector(0x18)));
2445 void foo (void)
2449 void bar (void)
2451     foo();
2453 @end smallexample
2455 If functions are defined in one file and are called in another file,
2456 then be sure to write this declaration in both files.
2458 This attribute is ignored for R8C target.
2460 @item interrupt
2461 @cindex interrupt handler functions
2462 Use this attribute on the ARM, AVR, CRX, M32C, M32R/D, m68k, MeP, MIPS
2463 and Xstormy16 ports to indicate that the specified function is an
2464 interrupt handler.  The compiler will generate function entry and exit
2465 sequences suitable for use in an interrupt handler when this attribute
2466 is present.
2468 Note, interrupt handlers for the Blackfin, H8/300, H8/300H, H8S, and
2469 SH processors can be specified via the @code{interrupt_handler} attribute.
2471 Note, on the AVR, interrupts will be enabled inside the function.
2473 Note, for the ARM, you can specify the kind of interrupt to be handled by
2474 adding an optional parameter to the interrupt attribute like this:
2476 @smallexample
2477 void f () __attribute__ ((interrupt ("IRQ")));
2478 @end smallexample
2480 Permissible values for this parameter are: IRQ, FIQ, SWI, ABORT and UNDEF@.
2482 On ARMv7-M the interrupt type is ignored, and the attribute means the function
2483 may be called with a word aligned stack pointer.
2485 On MIPS targets, you can use the following attributes to modify the behavior
2486 of an interrupt handler:
2487 @table @code
2488 @item use_shadow_register_set
2489 @cindex @code{use_shadow_register_set} attribute
2490 Assume that the handler uses a shadow register set, instead of
2491 the main general-purpose registers.
2493 @item keep_interrupts_masked
2494 @cindex @code{keep_interrupts_masked} attribute
2495 Keep interrupts masked for the whole function.  Without this attribute,
2496 GCC tries to reenable interrupts for as much of the function as it can.
2498 @item use_debug_exception_return
2499 @cindex @code{use_debug_exception_return} attribute
2500 Return using the @code{deret} instruction.  Interrupt handlers that don't
2501 have this attribute return using @code{eret} instead.
2502 @end table
2504 You can use any combination of these attributes, as shown below:
2505 @smallexample
2506 void __attribute__ ((interrupt)) v0 ();
2507 void __attribute__ ((interrupt, use_shadow_register_set)) v1 ();
2508 void __attribute__ ((interrupt, keep_interrupts_masked)) v2 ();
2509 void __attribute__ ((interrupt, use_debug_exception_return)) v3 ();
2510 void __attribute__ ((interrupt, use_shadow_register_set,
2511                      keep_interrupts_masked)) v4 ();
2512 void __attribute__ ((interrupt, use_shadow_register_set,
2513                      use_debug_exception_return)) v5 ();
2514 void __attribute__ ((interrupt, keep_interrupts_masked,
2515                      use_debug_exception_return)) v6 ();
2516 void __attribute__ ((interrupt, use_shadow_register_set,
2517                      keep_interrupts_masked,
2518                      use_debug_exception_return)) v7 ();
2519 @end smallexample
2521 @item interrupt_handler
2522 @cindex interrupt handler functions on the Blackfin, m68k, H8/300 and SH processors
2523 Use this attribute on the Blackfin, m68k, H8/300, H8/300H, H8S, and SH to
2524 indicate that the specified function is an interrupt handler.  The compiler
2525 will generate function entry and exit sequences suitable for use in an
2526 interrupt handler when this attribute is present.
2528 @item interrupt_thread
2529 @cindex interrupt thread functions on fido
2530 Use this attribute on fido, a subarchitecture of the m68k, to indicate
2531 that the specified function is an interrupt handler that is designed
2532 to run as a thread.  The compiler omits generate prologue/epilogue
2533 sequences and replaces the return instruction with a @code{sleep}
2534 instruction.  This attribute is available only on fido.
2536 @item isr
2537 @cindex interrupt service routines on ARM
2538 Use this attribute on ARM to write Interrupt Service Routines. This is an
2539 alias to the @code{interrupt} attribute above.
2541 @item kspisusp
2542 @cindex User stack pointer in interrupts on the Blackfin
2543 When used together with @code{interrupt_handler}, @code{exception_handler}
2544 or @code{nmi_handler}, code will be generated to load the stack pointer
2545 from the USP register in the function prologue.
2547 @item l1_text
2548 @cindex @code{l1_text} function attribute
2549 This attribute specifies a function to be placed into L1 Instruction
2550 SRAM@. The function will be put into a specific section named @code{.l1.text}.
2551 With @option{-mfdpic}, function calls with a such function as the callee
2552 or caller will use inlined PLT.
2554 @item long_call/short_call
2555 @cindex indirect calls on ARM
2556 This attribute specifies how a particular function is called on
2557 ARM@.  Both attributes override the @option{-mlong-calls} (@pxref{ARM Options})
2558 command line switch and @code{#pragma long_calls} settings.  The
2559 @code{long_call} attribute indicates that the function might be far
2560 away from the call site and require a different (more expensive)
2561 calling sequence.   The @code{short_call} attribute always places
2562 the offset to the function from the call site into the @samp{BL}
2563 instruction directly.
2565 @item longcall/shortcall
2566 @cindex functions called via pointer on the RS/6000 and PowerPC
2567 On the Blackfin, RS/6000 and PowerPC, the @code{longcall} attribute
2568 indicates that the function might be far away from the call site and
2569 require a different (more expensive) calling sequence.  The
2570 @code{shortcall} attribute indicates that the function is always close
2571 enough for the shorter calling sequence to be used.  These attributes
2572 override both the @option{-mlongcall} switch and, on the RS/6000 and
2573 PowerPC, the @code{#pragma longcall} setting.
2575 @xref{RS/6000 and PowerPC Options}, for more information on whether long
2576 calls are necessary.
2578 @item long_call/near/far
2579 @cindex indirect calls on MIPS
2580 These attributes specify how a particular function is called on MIPS@.
2581 The attributes override the @option{-mlong-calls} (@pxref{MIPS Options})
2582 command-line switch.  The @code{long_call} and @code{far} attributes are
2583 synonyms, and cause the compiler to always call
2584 the function by first loading its address into a register, and then using
2585 the contents of that register.  The @code{near} attribute has the opposite
2586 effect; it specifies that non-PIC calls should be made using the more 
2587 efficient @code{jal} instruction.
2589 @item malloc
2590 @cindex @code{malloc} attribute
2591 The @code{malloc} attribute is used to tell the compiler that a function
2592 may be treated as if any non-@code{NULL} pointer it returns cannot
2593 alias any other pointer valid when the function returns.
2594 This will often improve optimization.
2595 Standard functions with this property include @code{malloc} and
2596 @code{calloc}.  @code{realloc}-like functions have this property as
2597 long as the old pointer is never referred to (including comparing it
2598 to the new pointer) after the function returns a non-@code{NULL}
2599 value.
2601 @item mips16/nomips16
2602 @cindex @code{mips16} attribute
2603 @cindex @code{nomips16} attribute
2605 On MIPS targets, you can use the @code{mips16} and @code{nomips16}
2606 function attributes to locally select or turn off MIPS16 code generation.
2607 A function with the @code{mips16} attribute is emitted as MIPS16 code, 
2608 while MIPS16 code generation is disabled for functions with the 
2609 @code{nomips16} attribute.  These attributes override the 
2610 @option{-mips16} and @option{-mno-mips16} options on the command line
2611 (@pxref{MIPS Options}).  
2613 When compiling files containing mixed MIPS16 and non-MIPS16 code, the
2614 preprocessor symbol @code{__mips16} reflects the setting on the command line,
2615 not that within individual functions.  Mixed MIPS16 and non-MIPS16 code
2616 may interact badly with some GCC extensions such as @code{__builtin_apply}
2617 (@pxref{Constructing Calls}).
2619 @item model (@var{model-name})
2620 @cindex function addressability on the M32R/D
2621 @cindex variable addressability on the IA-64
2623 On the M32R/D, use this attribute to set the addressability of an
2624 object, and of the code generated for a function.  The identifier
2625 @var{model-name} is one of @code{small}, @code{medium}, or
2626 @code{large}, representing each of the code models.
2628 Small model objects live in the lower 16MB of memory (so that their
2629 addresses can be loaded with the @code{ld24} instruction), and are
2630 callable with the @code{bl} instruction.
2632 Medium model objects may live anywhere in the 32-bit address space (the
2633 compiler will generate @code{seth/add3} instructions to load their addresses),
2634 and are callable with the @code{bl} instruction.
2636 Large model objects may live anywhere in the 32-bit address space (the
2637 compiler will generate @code{seth/add3} instructions to load their addresses),
2638 and may not be reachable with the @code{bl} instruction (the compiler will
2639 generate the much slower @code{seth/add3/jl} instruction sequence).
2641 On IA-64, use this attribute to set the addressability of an object.
2642 At present, the only supported identifier for @var{model-name} is
2643 @code{small}, indicating addressability via ``small'' (22-bit)
2644 addresses (so that their addresses can be loaded with the @code{addl}
2645 instruction).  Caveat: such addressing is by definition not position
2646 independent and hence this attribute must not be used for objects
2647 defined by shared libraries.
2649 @item ms_abi/sysv_abi
2650 @cindex @code{ms_abi} attribute
2651 @cindex @code{sysv_abi} attribute
2653 On 64-bit x86_64-*-* targets, you can use an ABI attribute to indicate
2654 which calling convention should be used for a function.  The @code{ms_abi}
2655 attribute tells the compiler to use the Microsoft ABI, while the
2656 @code{sysv_abi} attribute tells the compiler to use the ABI used on
2657 GNU/Linux and other systems.  The default is to use the Microsoft ABI
2658 when targeting Windows.  On all other systems, the default is the AMD ABI.
2660 Note, This feature is currently sorried out for Windows targets trying to
2662 @item naked
2663 @cindex function without a prologue/epilogue code
2664 Use this attribute on the ARM, AVR, IP2K and SPU ports to indicate that
2665 the specified function does not need prologue/epilogue sequences generated by
2666 the compiler.  It is up to the programmer to provide these sequences. The 
2667 only statements that can be safely included in naked functions are 
2668 @code{asm} statements that do not have operands.  All other statements,
2669 including declarations of local variables, @code{if} statements, and so 
2670 forth, should be avoided.  Naked functions should be used to implement the 
2671 body of an assembly function, while allowing the compiler to construct
2672 the requisite function declaration for the assembler.
2674 @item near
2675 @cindex functions which do not handle memory bank switching on 68HC11/68HC12
2676 On 68HC11 and 68HC12 the @code{near} attribute causes the compiler to
2677 use the normal calling convention based on @code{jsr} and @code{rts}.
2678 This attribute can be used to cancel the effect of the @option{-mlong-calls}
2679 option.
2681 On MeP targets this attribute causes the compiler to assume the called
2682 function is close enough to use the normal calling convention,
2683 overriding the @code{-mtf} command line option.
2685 @item nesting
2686 @cindex Allow nesting in an interrupt handler on the Blackfin processor.
2687 Use this attribute together with @code{interrupt_handler},
2688 @code{exception_handler} or @code{nmi_handler} to indicate that the function
2689 entry code should enable nested interrupts or exceptions.
2691 @item nmi_handler
2692 @cindex NMI handler functions on the Blackfin processor
2693 Use this attribute on the Blackfin to indicate that the specified function
2694 is an NMI handler.  The compiler will generate function entry and
2695 exit sequences suitable for use in an NMI handler when this
2696 attribute is present.
2698 @item no_instrument_function
2699 @cindex @code{no_instrument_function} function attribute
2700 @opindex finstrument-functions
2701 If @option{-finstrument-functions} is given, profiling function calls will
2702 be generated at entry and exit of most user-compiled functions.
2703 Functions with this attribute will not be so instrumented.
2705 @item noinline
2706 @cindex @code{noinline} function attribute
2707 This function attribute prevents a function from being considered for
2708 inlining.
2709 @c Don't enumerate the optimizations by name here; we try to be
2710 @c future-compatible with this mechanism.
2711 If the function does not have side-effects, there are optimizations
2712 other than inlining that causes function calls to be optimized away,
2713 although the function call is live.  To keep such calls from being
2714 optimized away, put
2715 @smallexample
2716 asm ("");
2717 @end smallexample
2718 (@pxref{Extended Asm}) in the called function, to serve as a special
2719 side-effect.
2721 @item nonnull (@var{arg-index}, @dots{})
2722 @cindex @code{nonnull} function attribute
2723 The @code{nonnull} attribute specifies that some function parameters should
2724 be non-null pointers.  For instance, the declaration:
2726 @smallexample
2727 extern void *
2728 my_memcpy (void *dest, const void *src, size_t len)
2729         __attribute__((nonnull (1, 2)));
2730 @end smallexample
2732 @noindent
2733 causes the compiler to check that, in calls to @code{my_memcpy},
2734 arguments @var{dest} and @var{src} are non-null.  If the compiler
2735 determines that a null pointer is passed in an argument slot marked
2736 as non-null, and the @option{-Wnonnull} option is enabled, a warning
2737 is issued.  The compiler may also choose to make optimizations based
2738 on the knowledge that certain function arguments will not be null.
2740 If no argument index list is given to the @code{nonnull} attribute,
2741 all pointer arguments are marked as non-null.  To illustrate, the
2742 following declaration is equivalent to the previous example:
2744 @smallexample
2745 extern void *
2746 my_memcpy (void *dest, const void *src, size_t len)
2747         __attribute__((nonnull));
2748 @end smallexample
2750 @item noreturn
2751 @cindex @code{noreturn} function attribute
2752 A few standard library functions, such as @code{abort} and @code{exit},
2753 cannot return.  GCC knows this automatically.  Some programs define
2754 their own functions that never return.  You can declare them
2755 @code{noreturn} to tell the compiler this fact.  For example,
2757 @smallexample
2758 @group
2759 void fatal () __attribute__ ((noreturn));
2761 void
2762 fatal (/* @r{@dots{}} */)
2764   /* @r{@dots{}} */ /* @r{Print error message.} */ /* @r{@dots{}} */
2765   exit (1);
2767 @end group
2768 @end smallexample
2770 The @code{noreturn} keyword tells the compiler to assume that
2771 @code{fatal} cannot return.  It can then optimize without regard to what
2772 would happen if @code{fatal} ever did return.  This makes slightly
2773 better code.  More importantly, it helps avoid spurious warnings of
2774 uninitialized variables.
2776 The @code{noreturn} keyword does not affect the exceptional path when that
2777 applies: a @code{noreturn}-marked function may still return to the caller
2778 by throwing an exception or calling @code{longjmp}.
2780 Do not assume that registers saved by the calling function are
2781 restored before calling the @code{noreturn} function.
2783 It does not make sense for a @code{noreturn} function to have a return
2784 type other than @code{void}.
2786 The attribute @code{noreturn} is not implemented in GCC versions
2787 earlier than 2.5.  An alternative way to declare that a function does
2788 not return, which works in the current version and in some older
2789 versions, is as follows:
2791 @smallexample
2792 typedef void voidfn ();
2794 volatile voidfn fatal;
2795 @end smallexample
2797 This approach does not work in GNU C++.
2799 @item nothrow
2800 @cindex @code{nothrow} function attribute
2801 The @code{nothrow} attribute is used to inform the compiler that a
2802 function cannot throw an exception.  For example, most functions in
2803 the standard C library can be guaranteed not to throw an exception
2804 with the notable exceptions of @code{qsort} and @code{bsearch} that
2805 take function pointer arguments.  The @code{nothrow} attribute is not
2806 implemented in GCC versions earlier than 3.3.
2808 @item optimize
2809 @cindex @code{optimize} function attribute
2810 The @code{optimize} attribute is used to specify that a function is to
2811 be compiled with different optimization options than specified on the
2812 command line.  Arguments can either be numbers or strings.  Numbers
2813 are assumed to be an optimization level.  Strings that begin with
2814 @code{O} are assumed to be an optimization option, while other options
2815 are assumed to be used with a @code{-f} prefix.  You can also use the
2816 @samp{#pragma GCC optimize} pragma to set the optimization options
2817 that affect more than one function.
2818 @xref{Function Specific Option Pragmas}, for details about the
2819 @samp{#pragma GCC optimize} pragma.
2821 This can be used for instance to have frequently executed functions
2822 compiled with more aggressive optimization options that produce faster
2823 and larger code, while other functions can be called with less
2824 aggressive options.
2826 @item pure
2827 @cindex @code{pure} function attribute
2828 Many functions have no effects except the return value and their
2829 return value depends only on the parameters and/or global variables.
2830 Such a function can be subject
2831 to common subexpression elimination and loop optimization just as an
2832 arithmetic operator would be.  These functions should be declared
2833 with the attribute @code{pure}.  For example,
2835 @smallexample
2836 int square (int) __attribute__ ((pure));
2837 @end smallexample
2839 @noindent
2840 says that the hypothetical function @code{square} is safe to call
2841 fewer times than the program says.
2843 Some of common examples of pure functions are @code{strlen} or @code{memcmp}.
2844 Interesting non-pure functions are functions with infinite loops or those
2845 depending on volatile memory or other system resource, that may change between
2846 two consecutive calls (such as @code{feof} in a multithreading environment).
2848 The attribute @code{pure} is not implemented in GCC versions earlier
2849 than 2.96.
2851 @item hot
2852 @cindex @code{hot} function attribute
2853 The @code{hot} attribute is used to inform the compiler that a function is a
2854 hot spot of the compiled program.  The function is optimized more aggressively
2855 and on many target it is placed into special subsection of the text section so
2856 all hot functions appears close together improving locality.
2858 When profile feedback is available, via @option{-fprofile-use}, hot functions
2859 are automatically detected and this attribute is ignored.
2861 The @code{hot} attribute is not implemented in GCC versions earlier
2862 than 4.3.
2864 @item cold
2865 @cindex @code{cold} function attribute
2866 The @code{cold} attribute is used to inform the compiler that a function is
2867 unlikely executed.  The function is optimized for size rather than speed and on
2868 many targets it is placed into special subsection of the text section so all
2869 cold functions appears close together improving code locality of non-cold parts
2870 of program.  The paths leading to call of cold functions within code are marked
2871 as unlikely by the branch prediction mechanism. It is thus useful to mark
2872 functions used to handle unlikely conditions, such as @code{perror}, as cold to
2873 improve optimization of hot functions that do call marked functions in rare
2874 occasions.
2876 When profile feedback is available, via @option{-fprofile-use}, hot functions
2877 are automatically detected and this attribute is ignored.
2879 The @code{cold} attribute is not implemented in GCC versions earlier than 4.3.
2881 @item regparm (@var{number})
2882 @cindex @code{regparm} attribute
2883 @cindex functions that are passed arguments in registers on the 386
2884 On the Intel 386, the @code{regparm} attribute causes the compiler to
2885 pass arguments number one to @var{number} if they are of integral type
2886 in registers EAX, EDX, and ECX instead of on the stack.  Functions that
2887 take a variable number of arguments will continue to be passed all of their
2888 arguments on the stack.
2890 Beware that on some ELF systems this attribute is unsuitable for
2891 global functions in shared libraries with lazy binding (which is the
2892 default).  Lazy binding will send the first call via resolving code in
2893 the loader, which might assume EAX, EDX and ECX can be clobbered, as
2894 per the standard calling conventions.  Solaris 8 is affected by this.
2895 GNU systems with GLIBC 2.1 or higher, and FreeBSD, are believed to be
2896 safe since the loaders there save EAX, EDX and ECX.  (Lazy binding can be
2897 disabled with the linker or the loader if desired, to avoid the
2898 problem.)
2900 @item sseregparm
2901 @cindex @code{sseregparm} attribute
2902 On the Intel 386 with SSE support, the @code{sseregparm} attribute
2903 causes the compiler to pass up to 3 floating point arguments in
2904 SSE registers instead of on the stack.  Functions that take a
2905 variable number of arguments will continue to pass all of their
2906 floating point arguments on the stack.
2908 @item force_align_arg_pointer
2909 @cindex @code{force_align_arg_pointer} attribute
2910 On the Intel x86, the @code{force_align_arg_pointer} attribute may be
2911 applied to individual function definitions, generating an alternate
2912 prologue and epilogue that realigns the runtime stack if necessary.
2913 This supports mixing legacy codes that run with a 4-byte aligned stack
2914 with modern codes that keep a 16-byte stack for SSE compatibility.
2916 @item resbank
2917 @cindex @code{resbank} attribute
2918 On the SH2A target, this attribute enables the high-speed register
2919 saving and restoration using a register bank for @code{interrupt_handler}
2920 routines.  Saving to the bank is performed automatically after the CPU
2921 accepts an interrupt that uses a register bank.
2923 The nineteen 32-bit registers comprising general register R0 to R14,
2924 control register GBR, and system registers MACH, MACL, and PR and the
2925 vector table address offset are saved into a register bank.  Register
2926 banks are stacked in first-in last-out (FILO) sequence.  Restoration
2927 from the bank is executed by issuing a RESBANK instruction.
2929 @item returns_twice
2930 @cindex @code{returns_twice} attribute
2931 The @code{returns_twice} attribute tells the compiler that a function may
2932 return more than one time.  The compiler will ensure that all registers
2933 are dead before calling such a function and will emit a warning about
2934 the variables that may be clobbered after the second return from the
2935 function.  Examples of such functions are @code{setjmp} and @code{vfork}.
2936 The @code{longjmp}-like counterpart of such function, if any, might need
2937 to be marked with the @code{noreturn} attribute.
2939 @item saveall
2940 @cindex save all registers on the Blackfin, H8/300, H8/300H, and H8S
2941 Use this attribute on the Blackfin, H8/300, H8/300H, and H8S to indicate that
2942 all registers except the stack pointer should be saved in the prologue
2943 regardless of whether they are used or not.
2945 @item section ("@var{section-name}")
2946 @cindex @code{section} function attribute
2947 Normally, the compiler places the code it generates in the @code{text} section.
2948 Sometimes, however, you need additional sections, or you need certain
2949 particular functions to appear in special sections.  The @code{section}
2950 attribute specifies that a function lives in a particular section.
2951 For example, the declaration:
2953 @smallexample
2954 extern void foobar (void) __attribute__ ((section ("bar")));
2955 @end smallexample
2957 @noindent
2958 puts the function @code{foobar} in the @code{bar} section.
2960 Some file formats do not support arbitrary sections so the @code{section}
2961 attribute is not available on all platforms.
2962 If you need to map the entire contents of a module to a particular
2963 section, consider using the facilities of the linker instead.
2965 @item sentinel
2966 @cindex @code{sentinel} function attribute
2967 This function attribute ensures that a parameter in a function call is
2968 an explicit @code{NULL}.  The attribute is only valid on variadic
2969 functions.  By default, the sentinel is located at position zero, the
2970 last parameter of the function call.  If an optional integer position
2971 argument P is supplied to the attribute, the sentinel must be located at
2972 position P counting backwards from the end of the argument list.
2974 @smallexample
2975 __attribute__ ((sentinel))
2976 is equivalent to
2977 __attribute__ ((sentinel(0)))
2978 @end smallexample
2980 The attribute is automatically set with a position of 0 for the built-in
2981 functions @code{execl} and @code{execlp}.  The built-in function
2982 @code{execle} has the attribute set with a position of 1.
2984 A valid @code{NULL} in this context is defined as zero with any pointer
2985 type.  If your system defines the @code{NULL} macro with an integer type
2986 then you need to add an explicit cast.  GCC replaces @code{stddef.h}
2987 with a copy that redefines NULL appropriately.
2989 The warnings for missing or incorrect sentinels are enabled with
2990 @option{-Wformat}.
2992 @item short_call
2993 See long_call/short_call.
2995 @item shortcall
2996 See longcall/shortcall.
2998 @item signal
2999 @cindex signal handler functions on the AVR processors
3000 Use this attribute on the AVR to indicate that the specified
3001 function is a signal handler.  The compiler will generate function
3002 entry and exit sequences suitable for use in a signal handler when this
3003 attribute is present.  Interrupts will be disabled inside the function.
3005 @item sp_switch
3006 Use this attribute on the SH to indicate an @code{interrupt_handler}
3007 function should switch to an alternate stack.  It expects a string
3008 argument that names a global variable holding the address of the
3009 alternate stack.
3011 @smallexample
3012 void *alt_stack;
3013 void f () __attribute__ ((interrupt_handler,
3014                           sp_switch ("alt_stack")));
3015 @end smallexample
3017 @item stdcall
3018 @cindex functions that pop the argument stack on the 386
3019 On the Intel 386, the @code{stdcall} attribute causes the compiler to
3020 assume that the called function will pop off the stack space used to
3021 pass arguments, unless it takes a variable number of arguments.
3023 @item syscall_linkage
3024 @cindex @code{syscall_linkage} attribute
3025 This attribute is used to modify the IA64 calling convention by marking
3026 all input registers as live at all function exits.  This makes it possible
3027 to restart a system call after an interrupt without having to save/restore
3028 the input registers.  This also prevents kernel data from leaking into
3029 application code.
3031 @item target
3032 @cindex @code{target} function attribute
3033 The @code{target} attribute is used to specify that a function is to
3034 be compiled with different target options than specified on the
3035 command line.  This can be used for instance to have functions
3036 compiled with a different ISA (instruction set architecture) than the
3037 default.  You can also use the @samp{#pragma GCC target} pragma to set
3038 more than one function to be compiled with specific target options.
3039 @xref{Function Specific Option Pragmas}, for details about the
3040 @samp{#pragma GCC target} pragma.
3042 For instance on a 386, you could compile one function with
3043 @code{target("sse4.1,arch=core2")} and another with
3044 @code{target("sse4a,arch=amdfam10")} that would be equivalent to
3045 compiling the first function with @option{-msse4.1} and
3046 @option{-march=core2} options, and the second function with
3047 @option{-msse4a} and @option{-march=amdfam10} options.  It is up to the
3048 user to make sure that a function is only invoked on a machine that
3049 supports the particular ISA it was compiled for (for example by using
3050 @code{cpuid} on 386 to determine what feature bits and architecture
3051 family are used).
3053 @smallexample
3054 int core2_func (void) __attribute__ ((__target__ ("arch=core2")));
3055 int sse3_func (void) __attribute__ ((__target__ ("sse3")));
3056 @end smallexample
3058 On the 386, the following options are allowed:
3060 @table @samp
3061 @item abm
3062 @itemx no-abm
3063 @cindex @code{target("abm")} attribute
3064 Enable/disable the generation of the advanced bit instructions.
3066 @item aes
3067 @itemx no-aes
3068 @cindex @code{target("aes")} attribute
3069 Enable/disable the generation of the AES instructions.
3071 @item mmx
3072 @itemx no-mmx
3073 @cindex @code{target("mmx")} attribute
3074 Enable/disable the generation of the MMX instructions.
3076 @item pclmul
3077 @itemx no-pclmul
3078 @cindex @code{target("pclmul")} attribute
3079 Enable/disable the generation of the PCLMUL instructions.
3081 @item popcnt
3082 @itemx no-popcnt
3083 @cindex @code{target("popcnt")} attribute
3084 Enable/disable the generation of the POPCNT instruction.
3086 @item sse
3087 @itemx no-sse
3088 @cindex @code{target("sse")} attribute
3089 Enable/disable the generation of the SSE instructions.
3091 @item sse2
3092 @itemx no-sse2
3093 @cindex @code{target("sse2")} attribute
3094 Enable/disable the generation of the SSE2 instructions.
3096 @item sse3
3097 @itemx no-sse3
3098 @cindex @code{target("sse3")} attribute
3099 Enable/disable the generation of the SSE3 instructions.
3101 @item sse4
3102 @itemx no-sse4
3103 @cindex @code{target("sse4")} attribute
3104 Enable/disable the generation of the SSE4 instructions (both SSE4.1
3105 and SSE4.2).
3107 @item sse4.1
3108 @itemx no-sse4.1
3109 @cindex @code{target("sse4.1")} attribute
3110 Enable/disable the generation of the sse4.1 instructions.
3112 @item sse4.2
3113 @itemx no-sse4.2
3114 @cindex @code{target("sse4.2")} attribute
3115 Enable/disable the generation of the sse4.2 instructions.
3117 @item sse4a
3118 @itemx no-sse4a
3119 @cindex @code{target("sse4a")} attribute
3120 Enable/disable the generation of the SSE4A instructions.
3122 @item sse5
3123 @itemx no-sse5
3124 @cindex @code{target("sse5")} attribute
3125 Enable/disable the generation of the SSE5 instructions.
3127 @item ssse3
3128 @itemx no-ssse3
3129 @cindex @code{target("ssse3")} attribute
3130 Enable/disable the generation of the SSSE3 instructions.
3132 @item cld
3133 @itemx no-cld
3134 @cindex @code{target("cld")} attribute
3135 Enable/disable the generation of the CLD before string moves.
3137 @item fancy-math-387
3138 @itemx no-fancy-math-387
3139 @cindex @code{target("fancy-math-387")} attribute
3140 Enable/disable the generation of the @code{sin}, @code{cos}, and
3141 @code{sqrt} instructions on the 387 floating point unit.
3143 @item fused-madd
3144 @itemx no-fused-madd
3145 @cindex @code{target("fused-madd")} attribute
3146 Enable/disable the generation of the fused multiply/add instructions.
3148 @item ieee-fp
3149 @itemx no-ieee-fp
3150 @cindex @code{target("ieee-fp")} attribute
3151 Enable/disable the generation of floating point that depends on IEEE arithmetic.
3153 @item inline-all-stringops
3154 @itemx no-inline-all-stringops
3155 @cindex @code{target("inline-all-stringops")} attribute
3156 Enable/disable inlining of string operations.
3158 @item inline-stringops-dynamically
3159 @itemx no-inline-stringops-dynamically
3160 @cindex @code{target("inline-stringops-dynamically")} attribute
3161 Enable/disable the generation of the inline code to do small string
3162 operations and calling the library routines for large operations.
3164 @item align-stringops
3165 @itemx no-align-stringops
3166 @cindex @code{target("align-stringops")} attribute
3167 Do/do not align destination of inlined string operations.
3169 @item recip
3170 @itemx no-recip
3171 @cindex @code{target("recip")} attribute
3172 Enable/disable the generation of RCPSS, RCPPS, RSQRTSS and RSQRTPS
3173 instructions followed an additional Newton-Raphson step instead of
3174 doing a floating point division.
3176 @item arch=@var{ARCH}
3177 @cindex @code{target("arch=@var{ARCH}")} attribute
3178 Specify the architecture to generate code for in compiling the function.
3180 @item tune=@var{TUNE}
3181 @cindex @code{target("tune=@var{TUNE}")} attribute
3182 Specify the architecture to tune for in compiling the function.
3184 @item fpmath=@var{FPMATH}
3185 @cindex @code{target("fpmath=@var{FPMATH}")} attribute
3186 Specify which floating point unit to use.  The
3187 @code{target("fpmath=sse,387")} option must be specified as
3188 @code{target("fpmath=sse+387")} because the comma would separate
3189 different options.
3190 @end table
3192 On the 386, you can use either multiple strings to specify multiple
3193 options, or you can separate the option with a comma (@code{,}).
3195 On the 386, the inliner will not inline a function that has different
3196 target options than the caller, unless the callee has a subset of the
3197 target options of the caller.  For example a function declared with
3198 @code{target("sse5")} can inline a function with
3199 @code{target("sse2")}, since @code{-msse5} implies @code{-msse2}.
3201 The @code{target} attribute is not implemented in GCC versions earlier
3202 than 4.4, and at present only the 386 uses it.
3204 @item tiny_data
3205 @cindex tiny data section on the H8/300H and H8S
3206 Use this attribute on the H8/300H and H8S to indicate that the specified
3207 variable should be placed into the tiny data section.
3208 The compiler will generate more efficient code for loads and stores
3209 on data in the tiny data section.  Note the tiny data area is limited to
3210 slightly under 32kbytes of data.
3212 @item trap_exit
3213 Use this attribute on the SH for an @code{interrupt_handler} to return using
3214 @code{trapa} instead of @code{rte}.  This attribute expects an integer
3215 argument specifying the trap number to be used.
3217 @item unused
3218 @cindex @code{unused} attribute.
3219 This attribute, attached to a function, means that the function is meant
3220 to be possibly unused.  GCC will not produce a warning for this
3221 function.
3223 @item used
3224 @cindex @code{used} attribute.
3225 This attribute, attached to a function, means that code must be emitted
3226 for the function even if it appears that the function is not referenced.
3227 This is useful, for example, when the function is referenced only in
3228 inline assembly.
3230 @item version_id
3231 @cindex @code{version_id} attribute
3232 This IA64 HP-UX attribute, attached to a global variable or function, renames a
3233 symbol to contain a version string, thus allowing for function level
3234 versioning.  HP-UX system header files may use version level functioning
3235 for some system calls.
3237 @smallexample
3238 extern int foo () __attribute__((version_id ("20040821")));
3239 @end smallexample
3241 Calls to @var{foo} will be mapped to calls to @var{foo@{20040821@}}.
3243 @item visibility ("@var{visibility_type}")
3244 @cindex @code{visibility} attribute
3245 This attribute affects the linkage of the declaration to which it is attached.
3246 There are four supported @var{visibility_type} values: default,
3247 hidden, protected or internal visibility.
3249 @smallexample
3250 void __attribute__ ((visibility ("protected")))
3251 f () @{ /* @r{Do something.} */; @}
3252 int i __attribute__ ((visibility ("hidden")));
3253 @end smallexample
3255 The possible values of @var{visibility_type} correspond to the
3256 visibility settings in the ELF gABI.
3258 @table @dfn
3259 @c keep this list of visibilities in alphabetical order.
3261 @item default
3262 Default visibility is the normal case for the object file format.
3263 This value is available for the visibility attribute to override other
3264 options that may change the assumed visibility of entities.
3266 On ELF, default visibility means that the declaration is visible to other
3267 modules and, in shared libraries, means that the declared entity may be
3268 overridden.
3270 On Darwin, default visibility means that the declaration is visible to
3271 other modules.
3273 Default visibility corresponds to ``external linkage'' in the language.
3275 @item hidden
3276 Hidden visibility indicates that the entity declared will have a new
3277 form of linkage, which we'll call ``hidden linkage''.  Two
3278 declarations of an object with hidden linkage refer to the same object
3279 if they are in the same shared object.
3281 @item internal
3282 Internal visibility is like hidden visibility, but with additional
3283 processor specific semantics.  Unless otherwise specified by the
3284 psABI, GCC defines internal visibility to mean that a function is
3285 @emph{never} called from another module.  Compare this with hidden
3286 functions which, while they cannot be referenced directly by other
3287 modules, can be referenced indirectly via function pointers.  By
3288 indicating that a function cannot be called from outside the module,
3289 GCC may for instance omit the load of a PIC register since it is known
3290 that the calling function loaded the correct value.
3292 @item protected
3293 Protected visibility is like default visibility except that it
3294 indicates that references within the defining module will bind to the
3295 definition in that module.  That is, the declared entity cannot be
3296 overridden by another module.
3298 @end table
3300 All visibilities are supported on many, but not all, ELF targets
3301 (supported when the assembler supports the @samp{.visibility}
3302 pseudo-op).  Default visibility is supported everywhere.  Hidden
3303 visibility is supported on Darwin targets.
3305 The visibility attribute should be applied only to declarations which
3306 would otherwise have external linkage.  The attribute should be applied
3307 consistently, so that the same entity should not be declared with
3308 different settings of the attribute.
3310 In C++, the visibility attribute applies to types as well as functions
3311 and objects, because in C++ types have linkage.  A class must not have
3312 greater visibility than its non-static data member types and bases,
3313 and class members default to the visibility of their class.  Also, a
3314 declaration without explicit visibility is limited to the visibility
3315 of its type.
3317 In C++, you can mark member functions and static member variables of a
3318 class with the visibility attribute.  This is useful if you know a
3319 particular method or static member variable should only be used from
3320 one shared object; then you can mark it hidden while the rest of the
3321 class has default visibility.  Care must be taken to avoid breaking
3322 the One Definition Rule; for example, it is usually not useful to mark
3323 an inline method as hidden without marking the whole class as hidden.
3325 A C++ namespace declaration can also have the visibility attribute.
3326 This attribute applies only to the particular namespace body, not to
3327 other definitions of the same namespace; it is equivalent to using
3328 @samp{#pragma GCC visibility} before and after the namespace
3329 definition (@pxref{Visibility Pragmas}).
3331 In C++, if a template argument has limited visibility, this
3332 restriction is implicitly propagated to the template instantiation.
3333 Otherwise, template instantiations and specializations default to the
3334 visibility of their template.
3336 If both the template and enclosing class have explicit visibility, the
3337 visibility from the template is used.
3339 @item vliw
3340 @cindex @code{vliw} attribute
3341 On MeP, the @code{vliw} attribute tells the compiler to emit
3342 instructions in VLIW mode instead of core mode.  Note that this
3343 attribute is not allowed unless a VLIW coprocessor has been configured
3344 and enabled through command line options.
3346 @item warn_unused_result
3347 @cindex @code{warn_unused_result} attribute
3348 The @code{warn_unused_result} attribute causes a warning to be emitted
3349 if a caller of the function with this attribute does not use its
3350 return value.  This is useful for functions where not checking
3351 the result is either a security problem or always a bug, such as
3352 @code{realloc}.
3354 @smallexample
3355 int fn () __attribute__ ((warn_unused_result));
3356 int foo ()
3358   if (fn () < 0) return -1;
3359   fn ();
3360   return 0;
3362 @end smallexample
3364 results in warning on line 5.
3366 @item weak
3367 @cindex @code{weak} attribute
3368 The @code{weak} attribute causes the declaration to be emitted as a weak
3369 symbol rather than a global.  This is primarily useful in defining
3370 library functions which can be overridden in user code, though it can
3371 also be used with non-function declarations.  Weak symbols are supported
3372 for ELF targets, and also for a.out targets when using the GNU assembler
3373 and linker.
3375 @item weakref
3376 @itemx weakref ("@var{target}")
3377 @cindex @code{weakref} attribute
3378 The @code{weakref} attribute marks a declaration as a weak reference.
3379 Without arguments, it should be accompanied by an @code{alias} attribute
3380 naming the target symbol.  Optionally, the @var{target} may be given as
3381 an argument to @code{weakref} itself.  In either case, @code{weakref}
3382 implicitly marks the declaration as @code{weak}.  Without a
3383 @var{target}, given as an argument to @code{weakref} or to @code{alias},
3384 @code{weakref} is equivalent to @code{weak}.
3386 @smallexample
3387 static int x() __attribute__ ((weakref ("y")));
3388 /* is equivalent to... */
3389 static int x() __attribute__ ((weak, weakref, alias ("y")));
3390 /* and to... */
3391 static int x() __attribute__ ((weakref));
3392 static int x() __attribute__ ((alias ("y")));
3393 @end smallexample
3395 A weak reference is an alias that does not by itself require a
3396 definition to be given for the target symbol.  If the target symbol is
3397 only referenced through weak references, then the becomes a @code{weak}
3398 undefined symbol.  If it is directly referenced, however, then such
3399 strong references prevail, and a definition will be required for the
3400 symbol, not necessarily in the same translation unit.
3402 The effect is equivalent to moving all references to the alias to a
3403 separate translation unit, renaming the alias to the aliased symbol,
3404 declaring it as weak, compiling the two separate translation units and
3405 performing a reloadable link on them.
3407 At present, a declaration to which @code{weakref} is attached can
3408 only be @code{static}.
3410 @end table
3412 You can specify multiple attributes in a declaration by separating them
3413 by commas within the double parentheses or by immediately following an
3414 attribute declaration with another attribute declaration.
3416 @cindex @code{#pragma}, reason for not using
3417 @cindex pragma, reason for not using
3418 Some people object to the @code{__attribute__} feature, suggesting that
3419 ISO C's @code{#pragma} should be used instead.  At the time
3420 @code{__attribute__} was designed, there were two reasons for not doing
3421 this.
3423 @enumerate
3424 @item
3425 It is impossible to generate @code{#pragma} commands from a macro.
3427 @item
3428 There is no telling what the same @code{#pragma} might mean in another
3429 compiler.
3430 @end enumerate
3432 These two reasons applied to almost any application that might have been
3433 proposed for @code{#pragma}.  It was basically a mistake to use
3434 @code{#pragma} for @emph{anything}.
3436 The ISO C99 standard includes @code{_Pragma}, which now allows pragmas
3437 to be generated from macros.  In addition, a @code{#pragma GCC}
3438 namespace is now in use for GCC-specific pragmas.  However, it has been
3439 found convenient to use @code{__attribute__} to achieve a natural
3440 attachment of attributes to their corresponding declarations, whereas
3441 @code{#pragma GCC} is of use for constructs that do not naturally form
3442 part of the grammar.  @xref{Other Directives,,Miscellaneous
3443 Preprocessing Directives, cpp, The GNU C Preprocessor}.
3445 @node Attribute Syntax
3446 @section Attribute Syntax
3447 @cindex attribute syntax
3449 This section describes the syntax with which @code{__attribute__} may be
3450 used, and the constructs to which attribute specifiers bind, for the C
3451 language.  Some details may vary for C++ and Objective-C@.  Because of
3452 infelicities in the grammar for attributes, some forms described here
3453 may not be successfully parsed in all cases.
3455 There are some problems with the semantics of attributes in C++.  For
3456 example, there are no manglings for attributes, although they may affect
3457 code generation, so problems may arise when attributed types are used in
3458 conjunction with templates or overloading.  Similarly, @code{typeid}
3459 does not distinguish between types with different attributes.  Support
3460 for attributes in C++ may be restricted in future to attributes on
3461 declarations only, but not on nested declarators.
3463 @xref{Function Attributes}, for details of the semantics of attributes
3464 applying to functions.  @xref{Variable Attributes}, for details of the
3465 semantics of attributes applying to variables.  @xref{Type Attributes},
3466 for details of the semantics of attributes applying to structure, union
3467 and enumerated types.
3469 An @dfn{attribute specifier} is of the form
3470 @code{__attribute__ ((@var{attribute-list}))}.  An @dfn{attribute list}
3471 is a possibly empty comma-separated sequence of @dfn{attributes}, where
3472 each attribute is one of the following:
3474 @itemize @bullet
3475 @item
3476 Empty.  Empty attributes are ignored.
3478 @item
3479 A word (which may be an identifier such as @code{unused}, or a reserved
3480 word such as @code{const}).
3482 @item
3483 A word, followed by, in parentheses, parameters for the attribute.
3484 These parameters take one of the following forms:
3486 @itemize @bullet
3487 @item
3488 An identifier.  For example, @code{mode} attributes use this form.
3490 @item
3491 An identifier followed by a comma and a non-empty comma-separated list
3492 of expressions.  For example, @code{format} attributes use this form.
3494 @item
3495 A possibly empty comma-separated list of expressions.  For example,
3496 @code{format_arg} attributes use this form with the list being a single
3497 integer constant expression, and @code{alias} attributes use this form
3498 with the list being a single string constant.
3499 @end itemize
3500 @end itemize
3502 An @dfn{attribute specifier list} is a sequence of one or more attribute
3503 specifiers, not separated by any other tokens.
3505 In GNU C, an attribute specifier list may appear after the colon following a
3506 label, other than a @code{case} or @code{default} label.  The only
3507 attribute it makes sense to use after a label is @code{unused}.  This
3508 feature is intended for code generated by programs which contains labels
3509 that may be unused but which is compiled with @option{-Wall}.  It would
3510 not normally be appropriate to use in it human-written code, though it
3511 could be useful in cases where the code that jumps to the label is
3512 contained within an @code{#ifdef} conditional.  GNU C++ only permits
3513 attributes on labels if the attribute specifier is immediately
3514 followed by a semicolon (i.e., the label applies to an empty
3515 statement).  If the semicolon is missing, C++ label attributes are
3516 ambiguous, as it is permissible for a declaration, which could begin
3517 with an attribute list, to be labelled in C++.  Declarations cannot be
3518 labelled in C90 or C99, so the ambiguity does not arise there.
3520 An attribute specifier list may appear as part of a @code{struct},
3521 @code{union} or @code{enum} specifier.  It may go either immediately
3522 after the @code{struct}, @code{union} or @code{enum} keyword, or after
3523 the closing brace.  The former syntax is preferred.
3524 Where attribute specifiers follow the closing brace, they are considered
3525 to relate to the structure, union or enumerated type defined, not to any
3526 enclosing declaration the type specifier appears in, and the type
3527 defined is not complete until after the attribute specifiers.
3528 @c Otherwise, there would be the following problems: a shift/reduce
3529 @c conflict between attributes binding the struct/union/enum and
3530 @c binding to the list of specifiers/qualifiers; and "aligned"
3531 @c attributes could use sizeof for the structure, but the size could be
3532 @c changed later by "packed" attributes.
3534 Otherwise, an attribute specifier appears as part of a declaration,
3535 counting declarations of unnamed parameters and type names, and relates
3536 to that declaration (which may be nested in another declaration, for
3537 example in the case of a parameter declaration), or to a particular declarator
3538 within a declaration.  Where an
3539 attribute specifier is applied to a parameter declared as a function or
3540 an array, it should apply to the function or array rather than the
3541 pointer to which the parameter is implicitly converted, but this is not
3542 yet correctly implemented.
3544 Any list of specifiers and qualifiers at the start of a declaration may
3545 contain attribute specifiers, whether or not such a list may in that
3546 context contain storage class specifiers.  (Some attributes, however,
3547 are essentially in the nature of storage class specifiers, and only make
3548 sense where storage class specifiers may be used; for example,
3549 @code{section}.)  There is one necessary limitation to this syntax: the
3550 first old-style parameter declaration in a function definition cannot
3551 begin with an attribute specifier, because such an attribute applies to
3552 the function instead by syntax described below (which, however, is not
3553 yet implemented in this case).  In some other cases, attribute
3554 specifiers are permitted by this grammar but not yet supported by the
3555 compiler.  All attribute specifiers in this place relate to the
3556 declaration as a whole.  In the obsolescent usage where a type of
3557 @code{int} is implied by the absence of type specifiers, such a list of
3558 specifiers and qualifiers may be an attribute specifier list with no
3559 other specifiers or qualifiers.
3561 At present, the first parameter in a function prototype must have some
3562 type specifier which is not an attribute specifier; this resolves an
3563 ambiguity in the interpretation of @code{void f(int
3564 (__attribute__((foo)) x))}, but is subject to change.  At present, if
3565 the parentheses of a function declarator contain only attributes then
3566 those attributes are ignored, rather than yielding an error or warning
3567 or implying a single parameter of type int, but this is subject to
3568 change.
3570 An attribute specifier list may appear immediately before a declarator
3571 (other than the first) in a comma-separated list of declarators in a
3572 declaration of more than one identifier using a single list of
3573 specifiers and qualifiers.  Such attribute specifiers apply
3574 only to the identifier before whose declarator they appear.  For
3575 example, in
3577 @smallexample
3578 __attribute__((noreturn)) void d0 (void),
3579     __attribute__((format(printf, 1, 2))) d1 (const char *, ...),
3580      d2 (void)
3581 @end smallexample
3583 @noindent
3584 the @code{noreturn} attribute applies to all the functions
3585 declared; the @code{format} attribute only applies to @code{d1}.
3587 An attribute specifier list may appear immediately before the comma,
3588 @code{=} or semicolon terminating the declaration of an identifier other
3589 than a function definition.  Such attribute specifiers apply
3590 to the declared object or function.  Where an
3591 assembler name for an object or function is specified (@pxref{Asm
3592 Labels}), the attribute must follow the @code{asm}
3593 specification.
3595 An attribute specifier list may, in future, be permitted to appear after
3596 the declarator in a function definition (before any old-style parameter
3597 declarations or the function body).
3599 Attribute specifiers may be mixed with type qualifiers appearing inside
3600 the @code{[]} of a parameter array declarator, in the C99 construct by
3601 which such qualifiers are applied to the pointer to which the array is
3602 implicitly converted.  Such attribute specifiers apply to the pointer,
3603 not to the array, but at present this is not implemented and they are
3604 ignored.
3606 An attribute specifier list may appear at the start of a nested
3607 declarator.  At present, there are some limitations in this usage: the
3608 attributes correctly apply to the declarator, but for most individual
3609 attributes the semantics this implies are not implemented.
3610 When attribute specifiers follow the @code{*} of a pointer
3611 declarator, they may be mixed with any type qualifiers present.
3612 The following describes the formal semantics of this syntax.  It will make the
3613 most sense if you are familiar with the formal specification of
3614 declarators in the ISO C standard.
3616 Consider (as in C99 subclause 6.7.5 paragraph 4) a declaration @code{T
3617 D1}, where @code{T} contains declaration specifiers that specify a type
3618 @var{Type} (such as @code{int}) and @code{D1} is a declarator that
3619 contains an identifier @var{ident}.  The type specified for @var{ident}
3620 for derived declarators whose type does not include an attribute
3621 specifier is as in the ISO C standard.
3623 If @code{D1} has the form @code{( @var{attribute-specifier-list} D )},
3624 and the declaration @code{T D} specifies the type
3625 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
3626 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
3627 @var{attribute-specifier-list} @var{Type}'' for @var{ident}.
3629 If @code{D1} has the form @code{*
3630 @var{type-qualifier-and-attribute-specifier-list} D}, and the
3631 declaration @code{T D} specifies the type
3632 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
3633 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
3634 @var{type-qualifier-and-attribute-specifier-list} @var{Type}'' for
3635 @var{ident}.
3637 For example,
3639 @smallexample
3640 void (__attribute__((noreturn)) ****f) (void);
3641 @end smallexample
3643 @noindent
3644 specifies the type ``pointer to pointer to pointer to pointer to
3645 non-returning function returning @code{void}''.  As another example,
3647 @smallexample
3648 char *__attribute__((aligned(8))) *f;
3649 @end smallexample
3651 @noindent
3652 specifies the type ``pointer to 8-byte-aligned pointer to @code{char}''.
3653 Note again that this does not work with most attributes; for example,
3654 the usage of @samp{aligned} and @samp{noreturn} attributes given above
3655 is not yet supported.
3657 For compatibility with existing code written for compiler versions that
3658 did not implement attributes on nested declarators, some laxity is
3659 allowed in the placing of attributes.  If an attribute that only applies
3660 to types is applied to a declaration, it will be treated as applying to
3661 the type of that declaration.  If an attribute that only applies to
3662 declarations is applied to the type of a declaration, it will be treated
3663 as applying to that declaration; and, for compatibility with code
3664 placing the attributes immediately before the identifier declared, such
3665 an attribute applied to a function return type will be treated as
3666 applying to the function type, and such an attribute applied to an array
3667 element type will be treated as applying to the array type.  If an
3668 attribute that only applies to function types is applied to a
3669 pointer-to-function type, it will be treated as applying to the pointer
3670 target type; if such an attribute is applied to a function return type
3671 that is not a pointer-to-function type, it will be treated as applying
3672 to the function type.
3674 @node Function Prototypes
3675 @section Prototypes and Old-Style Function Definitions
3676 @cindex function prototype declarations
3677 @cindex old-style function definitions
3678 @cindex promotion of formal parameters
3680 GNU C extends ISO C to allow a function prototype to override a later
3681 old-style non-prototype definition.  Consider the following example:
3683 @smallexample
3684 /* @r{Use prototypes unless the compiler is old-fashioned.}  */
3685 #ifdef __STDC__
3686 #define P(x) x
3687 #else
3688 #define P(x) ()
3689 #endif
3691 /* @r{Prototype function declaration.}  */
3692 int isroot P((uid_t));
3694 /* @r{Old-style function definition.}  */
3696 isroot (x)   /* @r{??? lossage here ???} */
3697      uid_t x;
3699   return x == 0;
3701 @end smallexample
3703 Suppose the type @code{uid_t} happens to be @code{short}.  ISO C does
3704 not allow this example, because subword arguments in old-style
3705 non-prototype definitions are promoted.  Therefore in this example the
3706 function definition's argument is really an @code{int}, which does not
3707 match the prototype argument type of @code{short}.
3709 This restriction of ISO C makes it hard to write code that is portable
3710 to traditional C compilers, because the programmer does not know
3711 whether the @code{uid_t} type is @code{short}, @code{int}, or
3712 @code{long}.  Therefore, in cases like these GNU C allows a prototype
3713 to override a later old-style definition.  More precisely, in GNU C, a
3714 function prototype argument type overrides the argument type specified
3715 by a later old-style definition if the former type is the same as the
3716 latter type before promotion.  Thus in GNU C the above example is
3717 equivalent to the following:
3719 @smallexample
3720 int isroot (uid_t);
3723 isroot (uid_t x)
3725   return x == 0;
3727 @end smallexample
3729 @noindent
3730 GNU C++ does not support old-style function definitions, so this
3731 extension is irrelevant.
3733 @node C++ Comments
3734 @section C++ Style Comments
3735 @cindex //
3736 @cindex C++ comments
3737 @cindex comments, C++ style
3739 In GNU C, you may use C++ style comments, which start with @samp{//} and
3740 continue until the end of the line.  Many other C implementations allow
3741 such comments, and they are included in the 1999 C standard.  However,
3742 C++ style comments are not recognized if you specify an @option{-std}
3743 option specifying a version of ISO C before C99, or @option{-ansi}
3744 (equivalent to @option{-std=c89}).
3746 @node Dollar Signs
3747 @section Dollar Signs in Identifier Names
3748 @cindex $
3749 @cindex dollar signs in identifier names
3750 @cindex identifier names, dollar signs in
3752 In GNU C, you may normally use dollar signs in identifier names.
3753 This is because many traditional C implementations allow such identifiers.
3754 However, dollar signs in identifiers are not supported on a few target
3755 machines, typically because the target assembler does not allow them.
3757 @node Character Escapes
3758 @section The Character @key{ESC} in Constants
3760 You can use the sequence @samp{\e} in a string or character constant to
3761 stand for the ASCII character @key{ESC}.
3763 @node Alignment
3764 @section Inquiring on Alignment of Types or Variables
3765 @cindex alignment
3766 @cindex type alignment
3767 @cindex variable alignment
3769 The keyword @code{__alignof__} allows you to inquire about how an object
3770 is aligned, or the minimum alignment usually required by a type.  Its
3771 syntax is just like @code{sizeof}.
3773 For example, if the target machine requires a @code{double} value to be
3774 aligned on an 8-byte boundary, then @code{__alignof__ (double)} is 8.
3775 This is true on many RISC machines.  On more traditional machine
3776 designs, @code{__alignof__ (double)} is 4 or even 2.
3778 Some machines never actually require alignment; they allow reference to any
3779 data type even at an odd address.  For these machines, @code{__alignof__}
3780 reports the smallest alignment that GCC will give the data type, usually as
3781 mandated by the target ABI.
3783 If the operand of @code{__alignof__} is an lvalue rather than a type,
3784 its value is the required alignment for its type, taking into account
3785 any minimum alignment specified with GCC's @code{__attribute__}
3786 extension (@pxref{Variable Attributes}).  For example, after this
3787 declaration:
3789 @smallexample
3790 struct foo @{ int x; char y; @} foo1;
3791 @end smallexample
3793 @noindent
3794 the value of @code{__alignof__ (foo1.y)} is 1, even though its actual
3795 alignment is probably 2 or 4, the same as @code{__alignof__ (int)}.
3797 It is an error to ask for the alignment of an incomplete type.
3799 @node Variable Attributes
3800 @section Specifying Attributes of Variables
3801 @cindex attribute of variables
3802 @cindex variable attributes
3804 The keyword @code{__attribute__} allows you to specify special
3805 attributes of variables or structure fields.  This keyword is followed
3806 by an attribute specification inside double parentheses.  Some
3807 attributes are currently defined generically for variables.
3808 Other attributes are defined for variables on particular target
3809 systems.  Other attributes are available for functions
3810 (@pxref{Function Attributes}) and for types (@pxref{Type Attributes}).
3811 Other front ends might define more attributes
3812 (@pxref{C++ Extensions,,Extensions to the C++ Language}).
3814 You may also specify attributes with @samp{__} preceding and following
3815 each keyword.  This allows you to use them in header files without
3816 being concerned about a possible macro of the same name.  For example,
3817 you may use @code{__aligned__} instead of @code{aligned}.
3819 @xref{Attribute Syntax}, for details of the exact syntax for using
3820 attributes.
3822 @table @code
3823 @cindex @code{aligned} attribute
3824 @item aligned (@var{alignment})
3825 This attribute specifies a minimum alignment for the variable or
3826 structure field, measured in bytes.  For example, the declaration:
3828 @smallexample
3829 int x __attribute__ ((aligned (16))) = 0;
3830 @end smallexample
3832 @noindent
3833 causes the compiler to allocate the global variable @code{x} on a
3834 16-byte boundary.  On a 68040, this could be used in conjunction with
3835 an @code{asm} expression to access the @code{move16} instruction which
3836 requires 16-byte aligned operands.
3838 You can also specify the alignment of structure fields.  For example, to
3839 create a double-word aligned @code{int} pair, you could write:
3841 @smallexample
3842 struct foo @{ int x[2] __attribute__ ((aligned (8))); @};
3843 @end smallexample
3845 @noindent
3846 This is an alternative to creating a union with a @code{double} member
3847 that forces the union to be double-word aligned.
3849 As in the preceding examples, you can explicitly specify the alignment
3850 (in bytes) that you wish the compiler to use for a given variable or
3851 structure field.  Alternatively, you can leave out the alignment factor
3852 and just ask the compiler to align a variable or field to the
3853 default alignment for the target architecture you are compiling for.
3854 The default alignment is sufficient for all scalar types, but may not be
3855 enough for all vector types on a target which supports vector operations.
3856 The default alignment is fixed for a particular target ABI.
3858 Gcc also provides a target specific macro @code{__BIGGEST_ALIGNMENT__},
3859 which is the largest alignment ever used for any data type on the
3860 target machine you are compiling for.  For example, you could write:
3862 @smallexample
3863 short array[3] __attribute__ ((aligned (__BIGGEST_ALIGNMENT__)));
3864 @end smallexample
3866 The compiler automatically sets the alignment for the declared
3867 variable or field to @code{__BIGGEST_ALIGNMENT__}.  Doing this can
3868 often make copy operations more efficient, because the compiler can
3869 use whatever instructions copy the biggest chunks of memory when
3870 performing copies to or from the variables or fields that you have
3871 aligned this way.  Note that the value of @code{__BIGGEST_ALIGNMENT__}
3872 may change depending on command line options.
3874 When used on a struct, or struct member, the @code{aligned} attribute can
3875 only increase the alignment; in order to decrease it, the @code{packed}
3876 attribute must be specified as well.  When used as part of a typedef, the
3877 @code{aligned} attribute can both increase and decrease alignment, and
3878 specifying the @code{packed} attribute will generate a warning.
3880 Note that the effectiveness of @code{aligned} attributes may be limited
3881 by inherent limitations in your linker.  On many systems, the linker is
3882 only able to arrange for variables to be aligned up to a certain maximum
3883 alignment.  (For some linkers, the maximum supported alignment may
3884 be very very small.)  If your linker is only able to align variables
3885 up to a maximum of 8 byte alignment, then specifying @code{aligned(16)}
3886 in an @code{__attribute__} will still only provide you with 8 byte
3887 alignment.  See your linker documentation for further information.
3889 The @code{aligned} attribute can also be used for functions 
3890 (@pxref{Function Attributes}.)
3892 @item cleanup (@var{cleanup_function})
3893 @cindex @code{cleanup} attribute
3894 The @code{cleanup} attribute runs a function when the variable goes
3895 out of scope.  This attribute can only be applied to auto function
3896 scope variables; it may not be applied to parameters or variables
3897 with static storage duration.  The function must take one parameter,
3898 a pointer to a type compatible with the variable.  The return value
3899 of the function (if any) is ignored.
3901 If @option{-fexceptions} is enabled, then @var{cleanup_function}
3902 will be run during the stack unwinding that happens during the
3903 processing of the exception.  Note that the @code{cleanup} attribute
3904 does not allow the exception to be caught, only to perform an action.
3905 It is undefined what happens if @var{cleanup_function} does not
3906 return normally.
3908 @item common
3909 @itemx nocommon
3910 @cindex @code{common} attribute
3911 @cindex @code{nocommon} attribute
3912 @opindex fcommon
3913 @opindex fno-common
3914 The @code{common} attribute requests GCC to place a variable in
3915 ``common'' storage.  The @code{nocommon} attribute requests the
3916 opposite---to allocate space for it directly.
3918 These attributes override the default chosen by the
3919 @option{-fno-common} and @option{-fcommon} flags respectively.
3921 @item deprecated
3922 @itemx deprecated (@var{msg})
3923 @cindex @code{deprecated} attribute
3924 The @code{deprecated} attribute results in a warning if the variable
3925 is used anywhere in the source file.  This is useful when identifying
3926 variables that are expected to be removed in a future version of a
3927 program.  The warning also includes the location of the declaration
3928 of the deprecated variable, to enable users to easily find further
3929 information about why the variable is deprecated, or what they should
3930 do instead.  Note that the warning only occurs for uses:
3932 @smallexample
3933 extern int old_var __attribute__ ((deprecated));
3934 extern int old_var;
3935 int new_fn () @{ return old_var; @}
3936 @end smallexample
3938 results in a warning on line 3 but not line 2.  The optional msg
3939 argument, which must be a string, will be printed in the warning if
3940 present.
3942 The @code{deprecated} attribute can also be used for functions and
3943 types (@pxref{Function Attributes}, @pxref{Type Attributes}.)
3945 @item mode (@var{mode})
3946 @cindex @code{mode} attribute
3947 This attribute specifies the data type for the declaration---whichever
3948 type corresponds to the mode @var{mode}.  This in effect lets you
3949 request an integer or floating point type according to its width.
3951 You may also specify a mode of @samp{byte} or @samp{__byte__} to
3952 indicate the mode corresponding to a one-byte integer, @samp{word} or
3953 @samp{__word__} for the mode of a one-word integer, and @samp{pointer}
3954 or @samp{__pointer__} for the mode used to represent pointers.
3956 @item packed
3957 @cindex @code{packed} attribute
3958 The @code{packed} attribute specifies that a variable or structure field
3959 should have the smallest possible alignment---one byte for a variable,
3960 and one bit for a field, unless you specify a larger value with the
3961 @code{aligned} attribute.
3963 Here is a structure in which the field @code{x} is packed, so that it
3964 immediately follows @code{a}:
3966 @smallexample
3967 struct foo
3969   char a;
3970   int x[2] __attribute__ ((packed));
3972 @end smallexample
3974 @emph{Note:} The 4.1, 4.2 and 4.3 series of GCC ignore the
3975 @code{packed} attribute on bit-fields of type @code{char}.  This has
3976 been fixed in GCC 4.4 but the change can lead to differences in the
3977 structure layout.  See the documentation of
3978 @option{-Wpacked-bitfield-compat} for more information.
3980 @item section ("@var{section-name}")
3981 @cindex @code{section} variable attribute
3982 Normally, the compiler places the objects it generates in sections like
3983 @code{data} and @code{bss}.  Sometimes, however, you need additional sections,
3984 or you need certain particular variables to appear in special sections,
3985 for example to map to special hardware.  The @code{section}
3986 attribute specifies that a variable (or function) lives in a particular
3987 section.  For example, this small program uses several specific section names:
3989 @smallexample
3990 struct duart a __attribute__ ((section ("DUART_A"))) = @{ 0 @};
3991 struct duart b __attribute__ ((section ("DUART_B"))) = @{ 0 @};
3992 char stack[10000] __attribute__ ((section ("STACK"))) = @{ 0 @};
3993 int init_data __attribute__ ((section ("INITDATA")));
3995 main()
3997   /* @r{Initialize stack pointer} */
3998   init_sp (stack + sizeof (stack));
4000   /* @r{Initialize initialized data} */
4001   memcpy (&init_data, &data, &edata - &data);
4003   /* @r{Turn on the serial ports} */
4004   init_duart (&a);
4005   init_duart (&b);
4007 @end smallexample
4009 @noindent
4010 Use the @code{section} attribute with
4011 @emph{global} variables and not @emph{local} variables,
4012 as shown in the example.
4014 You may use the @code{section} attribute with initialized or
4015 uninitialized global variables but the linker requires
4016 each object be defined once, with the exception that uninitialized
4017 variables tentatively go in the @code{common} (or @code{bss}) section
4018 and can be multiply ``defined''.  Using the @code{section} attribute
4019 will change what section the variable goes into and may cause the
4020 linker to issue an error if an uninitialized variable has multiple
4021 definitions.  You can force a variable to be initialized with the
4022 @option{-fno-common} flag or the @code{nocommon} attribute.
4024 Some file formats do not support arbitrary sections so the @code{section}
4025 attribute is not available on all platforms.
4026 If you need to map the entire contents of a module to a particular
4027 section, consider using the facilities of the linker instead.
4029 @item shared
4030 @cindex @code{shared} variable attribute
4031 On Microsoft Windows, in addition to putting variable definitions in a named
4032 section, the section can also be shared among all running copies of an
4033 executable or DLL@.  For example, this small program defines shared data
4034 by putting it in a named section @code{shared} and marking the section
4035 shareable:
4037 @smallexample
4038 int foo __attribute__((section ("shared"), shared)) = 0;
4041 main()
4043   /* @r{Read and write foo.  All running
4044      copies see the same value.}  */
4045   return 0;
4047 @end smallexample
4049 @noindent
4050 You may only use the @code{shared} attribute along with @code{section}
4051 attribute with a fully initialized global definition because of the way
4052 linkers work.  See @code{section} attribute for more information.
4054 The @code{shared} attribute is only available on Microsoft Windows@.
4056 @item tls_model ("@var{tls_model}")
4057 @cindex @code{tls_model} attribute
4058 The @code{tls_model} attribute sets thread-local storage model
4059 (@pxref{Thread-Local}) of a particular @code{__thread} variable,
4060 overriding @option{-ftls-model=} command line switch on a per-variable
4061 basis.
4062 The @var{tls_model} argument should be one of @code{global-dynamic},
4063 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
4065 Not all targets support this attribute.
4067 @item unused
4068 This attribute, attached to a variable, means that the variable is meant
4069 to be possibly unused.  GCC will not produce a warning for this
4070 variable.
4072 @item used
4073 This attribute, attached to a variable, means that the variable must be
4074 emitted even if it appears that the variable is not referenced.
4076 @item vector_size (@var{bytes})
4077 This attribute specifies the vector size for the variable, measured in
4078 bytes.  For example, the declaration:
4080 @smallexample
4081 int foo __attribute__ ((vector_size (16)));
4082 @end smallexample
4084 @noindent
4085 causes the compiler to set the mode for @code{foo}, to be 16 bytes,
4086 divided into @code{int} sized units.  Assuming a 32-bit int (a vector of
4087 4 units of 4 bytes), the corresponding mode of @code{foo} will be V4SI@.
4089 This attribute is only applicable to integral and float scalars,
4090 although arrays, pointers, and function return values are allowed in
4091 conjunction with this construct.
4093 Aggregates with this attribute are invalid, even if they are of the same
4094 size as a corresponding scalar.  For example, the declaration:
4096 @smallexample
4097 struct S @{ int a; @};
4098 struct S  __attribute__ ((vector_size (16))) foo;
4099 @end smallexample
4101 @noindent
4102 is invalid even if the size of the structure is the same as the size of
4103 the @code{int}.
4105 @item selectany
4106 The @code{selectany} attribute causes an initialized global variable to
4107 have link-once semantics.  When multiple definitions of the variable are
4108 encountered by the linker, the first is selected and the remainder are
4109 discarded.  Following usage by the Microsoft compiler, the linker is told
4110 @emph{not} to warn about size or content differences of the multiple
4111 definitions.
4113 Although the primary usage of this attribute is for POD types, the
4114 attribute can also be applied to global C++ objects that are initialized
4115 by a constructor.  In this case, the static initialization and destruction
4116 code for the object is emitted in each translation defining the object,
4117 but the calls to the constructor and destructor are protected by a
4118 link-once guard variable.
4120 The @code{selectany} attribute is only available on Microsoft Windows
4121 targets.  You can use @code{__declspec (selectany)} as a synonym for
4122 @code{__attribute__ ((selectany))} for compatibility with other
4123 compilers.
4125 @item weak
4126 The @code{weak} attribute is described in @ref{Function Attributes}.
4128 @item dllimport
4129 The @code{dllimport} attribute is described in @ref{Function Attributes}.
4131 @item dllexport
4132 The @code{dllexport} attribute is described in @ref{Function Attributes}.
4134 @end table
4136 @subsection Blackfin Variable Attributes
4138 Three attributes are currently defined for the Blackfin.
4140 @table @code
4141 @item l1_data
4142 @item l1_data_A
4143 @item l1_data_B
4144 @cindex @code{l1_data} variable attribute
4145 @cindex @code{l1_data_A} variable attribute
4146 @cindex @code{l1_data_B} variable attribute
4147 Use these attributes on the Blackfin to place the variable into L1 Data SRAM.
4148 Variables with @code{l1_data} attribute will be put into the specific section
4149 named @code{.l1.data}. Those with @code{l1_data_A} attribute will be put into
4150 the specific section named @code{.l1.data.A}. Those with @code{l1_data_B}
4151 attribute will be put into the specific section named @code{.l1.data.B}.
4152 @end table
4154 @subsection M32R/D Variable Attributes
4156 One attribute is currently defined for the M32R/D@.
4158 @table @code
4159 @item model (@var{model-name})
4160 @cindex variable addressability on the M32R/D
4161 Use this attribute on the M32R/D to set the addressability of an object.
4162 The identifier @var{model-name} is one of @code{small}, @code{medium},
4163 or @code{large}, representing each of the code models.
4165 Small model objects live in the lower 16MB of memory (so that their
4166 addresses can be loaded with the @code{ld24} instruction).
4168 Medium and large model objects may live anywhere in the 32-bit address space
4169 (the compiler will generate @code{seth/add3} instructions to load their
4170 addresses).
4171 @end table
4173 @anchor{MeP Variable Attributes}
4174 @subsection MeP Variable Attributes
4176 The MeP target has a number of addressing modes and busses.  The
4177 @code{near} space spans the standard memory space's first 16 megabytes
4178 (24 bits).  The @code{far} space spans the entire 32-bit memory space.
4179 The @code{based} space is a 128 byte region in the memory space which
4180 is addressed relative to the @code{$tp} register.  The @code{tiny}
4181 space is a 65536 byte region relative to the @code{$gp} register.  In
4182 addition to these memory regions, the MeP target has a separate 16-bit
4183 control bus which is specified with @code{cb} attributes.
4185 @table @code
4187 @item based
4188 Any variable with the @code{based} attribute will be assigned to the
4189 @code{.based} section, and will be accessed with relative to the
4190 @code{$tp} register.
4192 @item tiny
4193 Likewise, the @code{tiny} attribute assigned variables to the
4194 @code{.tiny} section, relative to the @code{$gp} register.
4196 @item near
4197 Variables with the @code{near} attribute are assumed to have addresses
4198 that fit in a 24-bit addressing mode.  This is the default for large
4199 variables (@code{-mtiny=4} is the default) but this attribute can
4200 override @code{-mtiny=} for small variables, or override @code{-ml}.
4202 @item far
4203 Variables with the @code{far} attribute are addressed using a full
4204 32-bit address.  Since this covers the entire memory space, this
4205 allows modules to make no assumptions about where variables might be
4206 stored.
4208 @item io
4209 @item io (@var{addr})
4210 Variables with the @code{io} attribute are used to address
4211 memory-mapped peripherals.  If an address is specified, the variable
4212 is assigned that address, else it is not assigned an address (it is
4213 assumed some other module will assign an address).  Example:
4215 @example
4216 int timer_count __attribute__((io(0x123)));
4217 @end example
4219 @item cb
4220 @item cb (@var{addr})
4221 Variables with the @code{cb} attribute are used to access the control
4222 bus, using special instructions.  @code{addr} indicates the control bus
4223 address.  Example:
4225 @example
4226 int cpu_clock __attribute__((cb(0x123)));
4227 @end example
4229 @end table
4231 @anchor{i386 Variable Attributes}
4232 @subsection i386 Variable Attributes
4234 Two attributes are currently defined for i386 configurations:
4235 @code{ms_struct} and @code{gcc_struct}
4237 @table @code
4238 @item ms_struct
4239 @itemx gcc_struct
4240 @cindex @code{ms_struct} attribute
4241 @cindex @code{gcc_struct} attribute
4243 If @code{packed} is used on a structure, or if bit-fields are used
4244 it may be that the Microsoft ABI packs them differently
4245 than GCC would normally pack them.  Particularly when moving packed
4246 data between functions compiled with GCC and the native Microsoft compiler
4247 (either via function call or as data in a file), it may be necessary to access
4248 either format.
4250 Currently @option{-m[no-]ms-bitfields} is provided for the Microsoft Windows X86
4251 compilers to match the native Microsoft compiler.
4253 The Microsoft structure layout algorithm is fairly simple with the exception
4254 of the bitfield packing:
4256 The padding and alignment of members of structures and whether a bit field
4257 can straddle a storage-unit boundary
4259 @enumerate
4260 @item Structure members are stored sequentially in the order in which they are
4261 declared: the first member has the lowest memory address and the last member
4262 the highest.
4264 @item Every data object has an alignment-requirement. The alignment-requirement
4265 for all data except structures, unions, and arrays is either the size of the
4266 object or the current packing size (specified with either the aligned attribute
4267 or the pack pragma), whichever is less. For structures,  unions, and arrays,
4268 the alignment-requirement is the largest alignment-requirement of its members.
4269 Every object is allocated an offset so that:
4271 offset %  alignment-requirement == 0
4273 @item Adjacent bit fields are packed into the same 1-, 2-, or 4-byte allocation
4274 unit if the integral types are the same size and if the next bit field fits
4275 into the current allocation unit without crossing the boundary imposed by the
4276 common alignment requirements of the bit fields.
4277 @end enumerate
4279 Handling of zero-length bitfields:
4281 MSVC interprets zero-length bitfields in the following ways:
4283 @enumerate
4284 @item If a zero-length bitfield is inserted between two bitfields that would
4285 normally be coalesced, the bitfields will not be coalesced.
4287 For example:
4289 @smallexample
4290 struct
4291  @{
4292    unsigned long bf_1 : 12;
4293    unsigned long : 0;
4294    unsigned long bf_2 : 12;
4295  @} t1;
4296 @end smallexample
4298 The size of @code{t1} would be 8 bytes with the zero-length bitfield.  If the
4299 zero-length bitfield were removed, @code{t1}'s size would be 4 bytes.
4301 @item If a zero-length bitfield is inserted after a bitfield, @code{foo}, and the
4302 alignment of the zero-length bitfield is greater than the member that follows it,
4303 @code{bar}, @code{bar} will be aligned as the type of the zero-length bitfield.
4305 For example:
4307 @smallexample
4308 struct
4309  @{
4310    char foo : 4;
4311    short : 0;
4312    char bar;
4313  @} t2;
4315 struct
4316  @{
4317    char foo : 4;
4318    short : 0;
4319    double bar;
4320  @} t3;
4321 @end smallexample
4323 For @code{t2}, @code{bar} will be placed at offset 2, rather than offset 1.
4324 Accordingly, the size of @code{t2} will be 4.  For @code{t3}, the zero-length
4325 bitfield will not affect the alignment of @code{bar} or, as a result, the size
4326 of the structure.
4328 Taking this into account, it is important to note the following:
4330 @enumerate
4331 @item If a zero-length bitfield follows a normal bitfield, the type of the
4332 zero-length bitfield may affect the alignment of the structure as whole. For
4333 example, @code{t2} has a size of 4 bytes, since the zero-length bitfield follows a
4334 normal bitfield, and is of type short.
4336 @item Even if a zero-length bitfield is not followed by a normal bitfield, it may
4337 still affect the alignment of the structure:
4339 @smallexample
4340 struct
4341  @{
4342    char foo : 6;
4343    long : 0;
4344  @} t4;
4345 @end smallexample
4347 Here, @code{t4} will take up 4 bytes.
4348 @end enumerate
4350 @item Zero-length bitfields following non-bitfield members are ignored:
4352 @smallexample
4353 struct
4354  @{
4355    char foo;
4356    long : 0;
4357    char bar;
4358  @} t5;
4359 @end smallexample
4361 Here, @code{t5} will take up 2 bytes.
4362 @end enumerate
4363 @end table
4365 @subsection PowerPC Variable Attributes
4367 Three attributes currently are defined for PowerPC configurations:
4368 @code{altivec}, @code{ms_struct} and @code{gcc_struct}.
4370 For full documentation of the struct attributes please see the
4371 documentation in @ref{i386 Variable Attributes}.
4373 For documentation of @code{altivec} attribute please see the
4374 documentation in @ref{PowerPC Type Attributes}.
4376 @subsection SPU Variable Attributes
4378 The SPU supports the @code{spu_vector} attribute for variables.  For
4379 documentation of this attribute please see the documentation in
4380 @ref{SPU Type Attributes}.
4382 @subsection Xstormy16 Variable Attributes
4384 One attribute is currently defined for xstormy16 configurations:
4385 @code{below100}.
4387 @table @code
4388 @item below100
4389 @cindex @code{below100} attribute
4391 If a variable has the @code{below100} attribute (@code{BELOW100} is
4392 allowed also), GCC will place the variable in the first 0x100 bytes of
4393 memory and use special opcodes to access it.  Such variables will be
4394 placed in either the @code{.bss_below100} section or the
4395 @code{.data_below100} section.
4397 @end table
4399 @subsection AVR Variable Attributes
4401 @table @code
4402 @item progmem
4403 @cindex @code{progmem} variable attribute
4404 The @code{progmem} attribute is used on the AVR to place data in the Program
4405 Memory address space. The AVR is a Harvard Architecture processor and data
4406 normally resides in the Data Memory address space.
4407 @end table
4409 @node Type Attributes
4410 @section Specifying Attributes of Types
4411 @cindex attribute of types
4412 @cindex type attributes
4414 The keyword @code{__attribute__} allows you to specify special
4415 attributes of @code{struct} and @code{union} types when you define
4416 such types.  This keyword is followed by an attribute specification
4417 inside double parentheses.  Seven attributes are currently defined for
4418 types: @code{aligned}, @code{packed}, @code{transparent_union},
4419 @code{unused}, @code{deprecated}, @code{visibility}, and
4420 @code{may_alias}.  Other attributes are defined for functions
4421 (@pxref{Function Attributes}) and for variables (@pxref{Variable
4422 Attributes}).
4424 You may also specify any one of these attributes with @samp{__}
4425 preceding and following its keyword.  This allows you to use these
4426 attributes in header files without being concerned about a possible
4427 macro of the same name.  For example, you may use @code{__aligned__}
4428 instead of @code{aligned}.
4430 You may specify type attributes in an enum, struct or union type
4431 declaration or definition, or for other types in a @code{typedef}
4432 declaration.
4434 For an enum, struct or union type, you may specify attributes either
4435 between the enum, struct or union tag and the name of the type, or
4436 just past the closing curly brace of the @emph{definition}.  The
4437 former syntax is preferred.
4439 @xref{Attribute Syntax}, for details of the exact syntax for using
4440 attributes.
4442 @table @code
4443 @cindex @code{aligned} attribute
4444 @item aligned (@var{alignment})
4445 This attribute specifies a minimum alignment (in bytes) for variables
4446 of the specified type.  For example, the declarations:
4448 @smallexample
4449 struct S @{ short f[3]; @} __attribute__ ((aligned (8)));
4450 typedef int more_aligned_int __attribute__ ((aligned (8)));
4451 @end smallexample
4453 @noindent
4454 force the compiler to insure (as far as it can) that each variable whose
4455 type is @code{struct S} or @code{more_aligned_int} will be allocated and
4456 aligned @emph{at least} on a 8-byte boundary.  On a SPARC, having all
4457 variables of type @code{struct S} aligned to 8-byte boundaries allows
4458 the compiler to use the @code{ldd} and @code{std} (doubleword load and
4459 store) instructions when copying one variable of type @code{struct S} to
4460 another, thus improving run-time efficiency.
4462 Note that the alignment of any given @code{struct} or @code{union} type
4463 is required by the ISO C standard to be at least a perfect multiple of
4464 the lowest common multiple of the alignments of all of the members of
4465 the @code{struct} or @code{union} in question.  This means that you @emph{can}
4466 effectively adjust the alignment of a @code{struct} or @code{union}
4467 type by attaching an @code{aligned} attribute to any one of the members
4468 of such a type, but the notation illustrated in the example above is a
4469 more obvious, intuitive, and readable way to request the compiler to
4470 adjust the alignment of an entire @code{struct} or @code{union} type.
4472 As in the preceding example, you can explicitly specify the alignment
4473 (in bytes) that you wish the compiler to use for a given @code{struct}
4474 or @code{union} type.  Alternatively, you can leave out the alignment factor
4475 and just ask the compiler to align a type to the maximum
4476 useful alignment for the target machine you are compiling for.  For
4477 example, you could write:
4479 @smallexample
4480 struct S @{ short f[3]; @} __attribute__ ((aligned));
4481 @end smallexample
4483 Whenever you leave out the alignment factor in an @code{aligned}
4484 attribute specification, the compiler automatically sets the alignment
4485 for the type to the largest alignment which is ever used for any data
4486 type on the target machine you are compiling for.  Doing this can often
4487 make copy operations more efficient, because the compiler can use
4488 whatever instructions copy the biggest chunks of memory when performing
4489 copies to or from the variables which have types that you have aligned
4490 this way.
4492 In the example above, if the size of each @code{short} is 2 bytes, then
4493 the size of the entire @code{struct S} type is 6 bytes.  The smallest
4494 power of two which is greater than or equal to that is 8, so the
4495 compiler sets the alignment for the entire @code{struct S} type to 8
4496 bytes.
4498 Note that although you can ask the compiler to select a time-efficient
4499 alignment for a given type and then declare only individual stand-alone
4500 objects of that type, the compiler's ability to select a time-efficient
4501 alignment is primarily useful only when you plan to create arrays of
4502 variables having the relevant (efficiently aligned) type.  If you
4503 declare or use arrays of variables of an efficiently-aligned type, then
4504 it is likely that your program will also be doing pointer arithmetic (or
4505 subscripting, which amounts to the same thing) on pointers to the
4506 relevant type, and the code that the compiler generates for these
4507 pointer arithmetic operations will often be more efficient for
4508 efficiently-aligned types than for other types.
4510 The @code{aligned} attribute can only increase the alignment; but you
4511 can decrease it by specifying @code{packed} as well.  See below.
4513 Note that the effectiveness of @code{aligned} attributes may be limited
4514 by inherent limitations in your linker.  On many systems, the linker is
4515 only able to arrange for variables to be aligned up to a certain maximum
4516 alignment.  (For some linkers, the maximum supported alignment may
4517 be very very small.)  If your linker is only able to align variables
4518 up to a maximum of 8 byte alignment, then specifying @code{aligned(16)}
4519 in an @code{__attribute__} will still only provide you with 8 byte
4520 alignment.  See your linker documentation for further information.
4522 @item packed
4523 This attribute, attached to @code{struct} or @code{union} type
4524 definition, specifies that each member (other than zero-width bitfields)
4525 of the structure or union is placed to minimize the memory required.  When
4526 attached to an @code{enum} definition, it indicates that the smallest
4527 integral type should be used.
4529 @opindex fshort-enums
4530 Specifying this attribute for @code{struct} and @code{union} types is
4531 equivalent to specifying the @code{packed} attribute on each of the
4532 structure or union members.  Specifying the @option{-fshort-enums}
4533 flag on the line is equivalent to specifying the @code{packed}
4534 attribute on all @code{enum} definitions.
4536 In the following example @code{struct my_packed_struct}'s members are
4537 packed closely together, but the internal layout of its @code{s} member
4538 is not packed---to do that, @code{struct my_unpacked_struct} would need to
4539 be packed too.
4541 @smallexample
4542 struct my_unpacked_struct
4543  @{
4544     char c;
4545     int i;
4546  @};
4548 struct __attribute__ ((__packed__)) my_packed_struct
4549   @{
4550      char c;
4551      int  i;
4552      struct my_unpacked_struct s;
4553   @};
4554 @end smallexample
4556 You may only specify this attribute on the definition of an @code{enum},
4557 @code{struct} or @code{union}, not on a @code{typedef} which does not
4558 also define the enumerated type, structure or union.
4560 @item transparent_union
4561 This attribute, attached to a @code{union} type definition, indicates
4562 that any function parameter having that union type causes calls to that
4563 function to be treated in a special way.
4565 First, the argument corresponding to a transparent union type can be of
4566 any type in the union; no cast is required.  Also, if the union contains
4567 a pointer type, the corresponding argument can be a null pointer
4568 constant or a void pointer expression; and if the union contains a void
4569 pointer type, the corresponding argument can be any pointer expression.
4570 If the union member type is a pointer, qualifiers like @code{const} on
4571 the referenced type must be respected, just as with normal pointer
4572 conversions.
4574 Second, the argument is passed to the function using the calling
4575 conventions of the first member of the transparent union, not the calling
4576 conventions of the union itself.  All members of the union must have the
4577 same machine representation; this is necessary for this argument passing
4578 to work properly.
4580 Transparent unions are designed for library functions that have multiple
4581 interfaces for compatibility reasons.  For example, suppose the
4582 @code{wait} function must accept either a value of type @code{int *} to
4583 comply with Posix, or a value of type @code{union wait *} to comply with
4584 the 4.1BSD interface.  If @code{wait}'s parameter were @code{void *},
4585 @code{wait} would accept both kinds of arguments, but it would also
4586 accept any other pointer type and this would make argument type checking
4587 less useful.  Instead, @code{<sys/wait.h>} might define the interface
4588 as follows:
4590 @smallexample
4591 typedef union __attribute__ ((__transparent_union__))
4592   @{
4593     int *__ip;
4594     union wait *__up;
4595   @} wait_status_ptr_t;
4597 pid_t wait (wait_status_ptr_t);
4598 @end smallexample
4600 This interface allows either @code{int *} or @code{union wait *}
4601 arguments to be passed, using the @code{int *} calling convention.
4602 The program can call @code{wait} with arguments of either type:
4604 @smallexample
4605 int w1 () @{ int w; return wait (&w); @}
4606 int w2 () @{ union wait w; return wait (&w); @}
4607 @end smallexample
4609 With this interface, @code{wait}'s implementation might look like this:
4611 @smallexample
4612 pid_t wait (wait_status_ptr_t p)
4614   return waitpid (-1, p.__ip, 0);
4616 @end smallexample
4618 @item unused
4619 When attached to a type (including a @code{union} or a @code{struct}),
4620 this attribute means that variables of that type are meant to appear
4621 possibly unused.  GCC will not produce a warning for any variables of
4622 that type, even if the variable appears to do nothing.  This is often
4623 the case with lock or thread classes, which are usually defined and then
4624 not referenced, but contain constructors and destructors that have
4625 nontrivial bookkeeping functions.
4627 @item deprecated
4628 @itemx deprecated (@var{msg})
4629 The @code{deprecated} attribute results in a warning if the type
4630 is used anywhere in the source file.  This is useful when identifying
4631 types that are expected to be removed in a future version of a program.
4632 If possible, the warning also includes the location of the declaration
4633 of the deprecated type, to enable users to easily find further
4634 information about why the type is deprecated, or what they should do
4635 instead.  Note that the warnings only occur for uses and then only
4636 if the type is being applied to an identifier that itself is not being
4637 declared as deprecated.
4639 @smallexample
4640 typedef int T1 __attribute__ ((deprecated));
4641 T1 x;
4642 typedef T1 T2;
4643 T2 y;
4644 typedef T1 T3 __attribute__ ((deprecated));
4645 T3 z __attribute__ ((deprecated));
4646 @end smallexample
4648 results in a warning on line 2 and 3 but not lines 4, 5, or 6.  No
4649 warning is issued for line 4 because T2 is not explicitly
4650 deprecated.  Line 5 has no warning because T3 is explicitly
4651 deprecated.  Similarly for line 6.  The optional msg
4652 argument, which must be a string, will be printed in the warning if
4653 present.
4655 The @code{deprecated} attribute can also be used for functions and
4656 variables (@pxref{Function Attributes}, @pxref{Variable Attributes}.)
4658 @item may_alias
4659 Accesses through pointers to types with this attribute are not subject
4660 to type-based alias analysis, but are instead assumed to be able to alias
4661 any other type of objects.  In the context of 6.5/7 an lvalue expression
4662 dereferencing such a pointer is treated like having a character type.
4663 See @option{-fstrict-aliasing} for more information on aliasing issues.
4664 This extension exists to support some vector APIs, in which pointers to
4665 one vector type are permitted to alias pointers to a different vector type.
4667 Note that an object of a type with this attribute does not have any
4668 special semantics.
4670 Example of use:
4672 @smallexample
4673 typedef short __attribute__((__may_alias__)) short_a;
4676 main (void)
4678   int a = 0x12345678;
4679   short_a *b = (short_a *) &a;
4681   b[1] = 0;
4683   if (a == 0x12345678)
4684     abort();
4686   exit(0);
4688 @end smallexample
4690 If you replaced @code{short_a} with @code{short} in the variable
4691 declaration, the above program would abort when compiled with
4692 @option{-fstrict-aliasing}, which is on by default at @option{-O2} or
4693 above in recent GCC versions.
4695 @item visibility
4696 In C++, attribute visibility (@pxref{Function Attributes}) can also be
4697 applied to class, struct, union and enum types.  Unlike other type
4698 attributes, the attribute must appear between the initial keyword and
4699 the name of the type; it cannot appear after the body of the type.
4701 Note that the type visibility is applied to vague linkage entities
4702 associated with the class (vtable, typeinfo node, etc.).  In
4703 particular, if a class is thrown as an exception in one shared object
4704 and caught in another, the class must have default visibility.
4705 Otherwise the two shared objects will be unable to use the same
4706 typeinfo node and exception handling will break.
4708 @end table
4710 @subsection ARM Type Attributes
4712 On those ARM targets that support @code{dllimport} (such as Symbian
4713 OS), you can use the @code{notshared} attribute to indicate that the
4714 virtual table and other similar data for a class should not be
4715 exported from a DLL@.  For example:
4717 @smallexample
4718 class __declspec(notshared) C @{
4719 public:
4720   __declspec(dllimport) C();
4721   virtual void f();
4724 __declspec(dllexport)
4725 C::C() @{@}
4726 @end smallexample
4728 In this code, @code{C::C} is exported from the current DLL, but the
4729 virtual table for @code{C} is not exported.  (You can use
4730 @code{__attribute__} instead of @code{__declspec} if you prefer, but
4731 most Symbian OS code uses @code{__declspec}.)
4733 @anchor{MeP Type Attributes}
4734 @subsection MeP Type Attributes
4736 Many of the MeP variable attributes may be applied to types as well.
4737 Specifically, the @code{based}, @code{tiny}, @code{near}, and
4738 @code{far} attributes may be applied to either.  The @code{io} and
4739 @code{cb} attributes may not be applied to types.
4741 @anchor{i386 Type Attributes}
4742 @subsection i386 Type Attributes
4744 Two attributes are currently defined for i386 configurations:
4745 @code{ms_struct} and @code{gcc_struct}.
4747 @table @code
4749 @item ms_struct
4750 @itemx gcc_struct
4751 @cindex @code{ms_struct}
4752 @cindex @code{gcc_struct}
4754 If @code{packed} is used on a structure, or if bit-fields are used
4755 it may be that the Microsoft ABI packs them differently
4756 than GCC would normally pack them.  Particularly when moving packed
4757 data between functions compiled with GCC and the native Microsoft compiler
4758 (either via function call or as data in a file), it may be necessary to access
4759 either format.
4761 Currently @option{-m[no-]ms-bitfields} is provided for the Microsoft Windows X86
4762 compilers to match the native Microsoft compiler.
4763 @end table
4765 To specify multiple attributes, separate them by commas within the
4766 double parentheses: for example, @samp{__attribute__ ((aligned (16),
4767 packed))}.
4769 @anchor{PowerPC Type Attributes}
4770 @subsection PowerPC Type Attributes
4772 Three attributes currently are defined for PowerPC configurations:
4773 @code{altivec}, @code{ms_struct} and @code{gcc_struct}.
4775 For full documentation of the @code{ms_struct} and @code{gcc_struct} 
4776 attributes please see the documentation in @ref{i386 Type Attributes}.
4778 The @code{altivec} attribute allows one to declare AltiVec vector data
4779 types supported by the AltiVec Programming Interface Manual.  The
4780 attribute requires an argument to specify one of three vector types:
4781 @code{vector__}, @code{pixel__} (always followed by unsigned short),
4782 and @code{bool__} (always followed by unsigned).
4784 @smallexample
4785 __attribute__((altivec(vector__)))
4786 __attribute__((altivec(pixel__))) unsigned short
4787 __attribute__((altivec(bool__))) unsigned
4788 @end smallexample
4790 These attributes mainly are intended to support the @code{__vector},
4791 @code{__pixel}, and @code{__bool} AltiVec keywords.
4793 @anchor{SPU Type Attributes}
4794 @subsection SPU Type Attributes
4796 The SPU supports the @code{spu_vector} attribute for types.  This attribute
4797 allows one to declare vector data types supported by the Sony/Toshiba/IBM SPU
4798 Language Extensions Specification.  It is intended to support the
4799 @code{__vector} keyword.
4802 @node Inline
4803 @section An Inline Function is As Fast As a Macro
4804 @cindex inline functions
4805 @cindex integrating function code
4806 @cindex open coding
4807 @cindex macros, inline alternative
4809 By declaring a function inline, you can direct GCC to make
4810 calls to that function faster.  One way GCC can achieve this is to
4811 integrate that function's code into the code for its callers.  This
4812 makes execution faster by eliminating the function-call overhead; in
4813 addition, if any of the actual argument values are constant, their
4814 known values may permit simplifications at compile time so that not
4815 all of the inline function's code needs to be included.  The effect on
4816 code size is less predictable; object code may be larger or smaller
4817 with function inlining, depending on the particular case.  You can
4818 also direct GCC to try to integrate all ``simple enough'' functions
4819 into their callers with the option @option{-finline-functions}.
4821 GCC implements three different semantics of declaring a function
4822 inline.  One is available with @option{-std=gnu89} or
4823 @option{-fgnu89-inline} or when @code{gnu_inline} attribute is present
4824 on all inline declarations, another when @option{-std=c99} or
4825 @option{-std=gnu99} (without @option{-fgnu89-inline}), and the third
4826 is used when compiling C++.
4828 To declare a function inline, use the @code{inline} keyword in its
4829 declaration, like this:
4831 @smallexample
4832 static inline int
4833 inc (int *a)
4835   (*a)++;
4837 @end smallexample
4839 If you are writing a header file to be included in ISO C89 programs, write
4840 @code{__inline__} instead of @code{inline}.  @xref{Alternate Keywords}.
4842 The three types of inlining behave similarly in two important cases:
4843 when the @code{inline} keyword is used on a @code{static} function,
4844 like the example above, and when a function is first declared without
4845 using the @code{inline} keyword and then is defined with
4846 @code{inline}, like this:
4848 @smallexample
4849 extern int inc (int *a);
4850 inline int
4851 inc (int *a)
4853   (*a)++;
4855 @end smallexample
4857 In both of these common cases, the program behaves the same as if you
4858 had not used the @code{inline} keyword, except for its speed.
4860 @cindex inline functions, omission of
4861 @opindex fkeep-inline-functions
4862 When a function is both inline and @code{static}, if all calls to the
4863 function are integrated into the caller, and the function's address is
4864 never used, then the function's own assembler code is never referenced.
4865 In this case, GCC does not actually output assembler code for the
4866 function, unless you specify the option @option{-fkeep-inline-functions}.
4867 Some calls cannot be integrated for various reasons (in particular,
4868 calls that precede the function's definition cannot be integrated, and
4869 neither can recursive calls within the definition).  If there is a
4870 nonintegrated call, then the function is compiled to assembler code as
4871 usual.  The function must also be compiled as usual if the program
4872 refers to its address, because that can't be inlined.
4874 @opindex Winline
4875 Note that certain usages in a function definition can make it unsuitable
4876 for inline substitution.  Among these usages are: use of varargs, use of
4877 alloca, use of variable sized data types (@pxref{Variable Length}),
4878 use of computed goto (@pxref{Labels as Values}), use of nonlocal goto,
4879 and nested functions (@pxref{Nested Functions}).  Using @option{-Winline}
4880 will warn when a function marked @code{inline} could not be substituted,
4881 and will give the reason for the failure.
4883 @cindex automatic @code{inline} for C++ member fns
4884 @cindex @code{inline} automatic for C++ member fns
4885 @cindex member fns, automatically @code{inline}
4886 @cindex C++ member fns, automatically @code{inline}
4887 @opindex fno-default-inline
4888 As required by ISO C++, GCC considers member functions defined within
4889 the body of a class to be marked inline even if they are
4890 not explicitly declared with the @code{inline} keyword.  You can
4891 override this with @option{-fno-default-inline}; @pxref{C++ Dialect
4892 Options,,Options Controlling C++ Dialect}.
4894 GCC does not inline any functions when not optimizing unless you specify
4895 the @samp{always_inline} attribute for the function, like this:
4897 @smallexample
4898 /* @r{Prototype.}  */
4899 inline void foo (const char) __attribute__((always_inline));
4900 @end smallexample
4902 The remainder of this section is specific to GNU C89 inlining.
4904 @cindex non-static inline function
4905 When an inline function is not @code{static}, then the compiler must assume
4906 that there may be calls from other source files; since a global symbol can
4907 be defined only once in any program, the function must not be defined in
4908 the other source files, so the calls therein cannot be integrated.
4909 Therefore, a non-@code{static} inline function is always compiled on its
4910 own in the usual fashion.
4912 If you specify both @code{inline} and @code{extern} in the function
4913 definition, then the definition is used only for inlining.  In no case
4914 is the function compiled on its own, not even if you refer to its
4915 address explicitly.  Such an address becomes an external reference, as
4916 if you had only declared the function, and had not defined it.
4918 This combination of @code{inline} and @code{extern} has almost the
4919 effect of a macro.  The way to use it is to put a function definition in
4920 a header file with these keywords, and put another copy of the
4921 definition (lacking @code{inline} and @code{extern}) in a library file.
4922 The definition in the header file will cause most calls to the function
4923 to be inlined.  If any uses of the function remain, they will refer to
4924 the single copy in the library.
4926 @node Extended Asm
4927 @section Assembler Instructions with C Expression Operands
4928 @cindex extended @code{asm}
4929 @cindex @code{asm} expressions
4930 @cindex assembler instructions
4931 @cindex registers
4933 In an assembler instruction using @code{asm}, you can specify the
4934 operands of the instruction using C expressions.  This means you need not
4935 guess which registers or memory locations will contain the data you want
4936 to use.
4938 You must specify an assembler instruction template much like what
4939 appears in a machine description, plus an operand constraint string for
4940 each operand.
4942 For example, here is how to use the 68881's @code{fsinx} instruction:
4944 @smallexample
4945 asm ("fsinx %1,%0" : "=f" (result) : "f" (angle));
4946 @end smallexample
4948 @noindent
4949 Here @code{angle} is the C expression for the input operand while
4950 @code{result} is that of the output operand.  Each has @samp{"f"} as its
4951 operand constraint, saying that a floating point register is required.
4952 The @samp{=} in @samp{=f} indicates that the operand is an output; all
4953 output operands' constraints must use @samp{=}.  The constraints use the
4954 same language used in the machine description (@pxref{Constraints}).
4956 Each operand is described by an operand-constraint string followed by
4957 the C expression in parentheses.  A colon separates the assembler
4958 template from the first output operand and another separates the last
4959 output operand from the first input, if any.  Commas separate the
4960 operands within each group.  The total number of operands is currently
4961 limited to 30; this limitation may be lifted in some future version of
4962 GCC@.
4964 If there are no output operands but there are input operands, you must
4965 place two consecutive colons surrounding the place where the output
4966 operands would go.
4968 As of GCC version 3.1, it is also possible to specify input and output
4969 operands using symbolic names which can be referenced within the
4970 assembler code.  These names are specified inside square brackets
4971 preceding the constraint string, and can be referenced inside the
4972 assembler code using @code{%[@var{name}]} instead of a percentage sign
4973 followed by the operand number.  Using named operands the above example
4974 could look like:
4976 @smallexample
4977 asm ("fsinx %[angle],%[output]"
4978      : [output] "=f" (result)
4979      : [angle] "f" (angle));
4980 @end smallexample
4982 @noindent
4983 Note that the symbolic operand names have no relation whatsoever to
4984 other C identifiers.  You may use any name you like, even those of
4985 existing C symbols, but you must ensure that no two operands within the same
4986 assembler construct use the same symbolic name.
4988 Output operand expressions must be lvalues; the compiler can check this.
4989 The input operands need not be lvalues.  The compiler cannot check
4990 whether the operands have data types that are reasonable for the
4991 instruction being executed.  It does not parse the assembler instruction
4992 template and does not know what it means or even whether it is valid
4993 assembler input.  The extended @code{asm} feature is most often used for
4994 machine instructions the compiler itself does not know exist.  If
4995 the output expression cannot be directly addressed (for example, it is a
4996 bit-field), your constraint must allow a register.  In that case, GCC
4997 will use the register as the output of the @code{asm}, and then store
4998 that register into the output.
5000 The ordinary output operands must be write-only; GCC will assume that
5001 the values in these operands before the instruction are dead and need
5002 not be generated.  Extended asm supports input-output or read-write
5003 operands.  Use the constraint character @samp{+} to indicate such an
5004 operand and list it with the output operands.  You should only use
5005 read-write operands when the constraints for the operand (or the
5006 operand in which only some of the bits are to be changed) allow a
5007 register.
5009 You may, as an alternative, logically split its function into two
5010 separate operands, one input operand and one write-only output
5011 operand.  The connection between them is expressed by constraints
5012 which say they need to be in the same location when the instruction
5013 executes.  You can use the same C expression for both operands, or
5014 different expressions.  For example, here we write the (fictitious)
5015 @samp{combine} instruction with @code{bar} as its read-only source
5016 operand and @code{foo} as its read-write destination:
5018 @smallexample
5019 asm ("combine %2,%0" : "=r" (foo) : "0" (foo), "g" (bar));
5020 @end smallexample
5022 @noindent
5023 The constraint @samp{"0"} for operand 1 says that it must occupy the
5024 same location as operand 0.  A number in constraint is allowed only in
5025 an input operand and it must refer to an output operand.
5027 Only a number in the constraint can guarantee that one operand will be in
5028 the same place as another.  The mere fact that @code{foo} is the value
5029 of both operands is not enough to guarantee that they will be in the
5030 same place in the generated assembler code.  The following would not
5031 work reliably:
5033 @smallexample
5034 asm ("combine %2,%0" : "=r" (foo) : "r" (foo), "g" (bar));
5035 @end smallexample
5037 Various optimizations or reloading could cause operands 0 and 1 to be in
5038 different registers; GCC knows no reason not to do so.  For example, the
5039 compiler might find a copy of the value of @code{foo} in one register and
5040 use it for operand 1, but generate the output operand 0 in a different
5041 register (copying it afterward to @code{foo}'s own address).  Of course,
5042 since the register for operand 1 is not even mentioned in the assembler
5043 code, the result will not work, but GCC can't tell that.
5045 As of GCC version 3.1, one may write @code{[@var{name}]} instead of
5046 the operand number for a matching constraint.  For example:
5048 @smallexample
5049 asm ("cmoveq %1,%2,%[result]"
5050      : [result] "=r"(result)
5051      : "r" (test), "r"(new), "[result]"(old));
5052 @end smallexample
5054 Sometimes you need to make an @code{asm} operand be a specific register,
5055 but there's no matching constraint letter for that register @emph{by
5056 itself}.  To force the operand into that register, use a local variable
5057 for the operand and specify the register in the variable declaration.
5058 @xref{Explicit Reg Vars}.  Then for the @code{asm} operand, use any
5059 register constraint letter that matches the register:
5061 @smallexample
5062 register int *p1 asm ("r0") = @dots{};
5063 register int *p2 asm ("r1") = @dots{};
5064 register int *result asm ("r0");
5065 asm ("sysint" : "=r" (result) : "0" (p1), "r" (p2));
5066 @end smallexample
5068 @anchor{Example of asm with clobbered asm reg}
5069 In the above example, beware that a register that is call-clobbered by
5070 the target ABI will be overwritten by any function call in the
5071 assignment, including library calls for arithmetic operators.
5072 Also a register may be clobbered when generating some operations,
5073 like variable shift, memory copy or memory move on x86.
5074 Assuming it is a call-clobbered register, this may happen to @code{r0}
5075 above by the assignment to @code{p2}.  If you have to use such a
5076 register, use temporary variables for expressions between the register
5077 assignment and use:
5079 @smallexample
5080 int t1 = @dots{};
5081 register int *p1 asm ("r0") = @dots{};
5082 register int *p2 asm ("r1") = t1;
5083 register int *result asm ("r0");
5084 asm ("sysint" : "=r" (result) : "0" (p1), "r" (p2));
5085 @end smallexample
5087 Some instructions clobber specific hard registers.  To describe this,
5088 write a third colon after the input operands, followed by the names of
5089 the clobbered hard registers (given as strings).  Here is a realistic
5090 example for the VAX:
5092 @smallexample
5093 asm volatile ("movc3 %0,%1,%2"
5094               : /* @r{no outputs} */
5095               : "g" (from), "g" (to), "g" (count)
5096               : "r0", "r1", "r2", "r3", "r4", "r5");
5097 @end smallexample
5099 You may not write a clobber description in a way that overlaps with an
5100 input or output operand.  For example, you may not have an operand
5101 describing a register class with one member if you mention that register
5102 in the clobber list.  Variables declared to live in specific registers
5103 (@pxref{Explicit Reg Vars}), and used as asm input or output operands must
5104 have no part mentioned in the clobber description.
5105 There is no way for you to specify that an input
5106 operand is modified without also specifying it as an output
5107 operand.  Note that if all the output operands you specify are for this
5108 purpose (and hence unused), you will then also need to specify
5109 @code{volatile} for the @code{asm} construct, as described below, to
5110 prevent GCC from deleting the @code{asm} statement as unused.
5112 If you refer to a particular hardware register from the assembler code,
5113 you will probably have to list the register after the third colon to
5114 tell the compiler the register's value is modified.  In some assemblers,
5115 the register names begin with @samp{%}; to produce one @samp{%} in the
5116 assembler code, you must write @samp{%%} in the input.
5118 If your assembler instruction can alter the condition code register, add
5119 @samp{cc} to the list of clobbered registers.  GCC on some machines
5120 represents the condition codes as a specific hardware register;
5121 @samp{cc} serves to name this register.  On other machines, the
5122 condition code is handled differently, and specifying @samp{cc} has no
5123 effect.  But it is valid no matter what the machine.
5125 If your assembler instructions access memory in an unpredictable
5126 fashion, add @samp{memory} to the list of clobbered registers.  This
5127 will cause GCC to not keep memory values cached in registers across the
5128 assembler instruction and not optimize stores or loads to that memory.
5129 You will also want to add the @code{volatile} keyword if the memory
5130 affected is not listed in the inputs or outputs of the @code{asm}, as
5131 the @samp{memory} clobber does not count as a side-effect of the
5132 @code{asm}.  If you know how large the accessed memory is, you can add
5133 it as input or output but if this is not known, you should add
5134 @samp{memory}.  As an example, if you access ten bytes of a string, you
5135 can use a memory input like:
5137 @smallexample
5138 @{"m"( (@{ struct @{ char x[10]; @} *p = (void *)ptr ; *p; @}) )@}.
5139 @end smallexample
5141 Note that in the following example the memory input is necessary,
5142 otherwise GCC might optimize the store to @code{x} away:
5143 @smallexample
5144 int foo ()
5146   int x = 42;
5147   int *y = &x;
5148   int result;
5149   asm ("magic stuff accessing an 'int' pointed to by '%1'"
5150         "=&d" (r) : "a" (y), "m" (*y));
5151   return result;
5153 @end smallexample
5155 You can put multiple assembler instructions together in a single
5156 @code{asm} template, separated by the characters normally used in assembly
5157 code for the system.  A combination that works in most places is a newline
5158 to break the line, plus a tab character to move to the instruction field
5159 (written as @samp{\n\t}).  Sometimes semicolons can be used, if the
5160 assembler allows semicolons as a line-breaking character.  Note that some
5161 assembler dialects use semicolons to start a comment.
5162 The input operands are guaranteed not to use any of the clobbered
5163 registers, and neither will the output operands' addresses, so you can
5164 read and write the clobbered registers as many times as you like.  Here
5165 is an example of multiple instructions in a template; it assumes the
5166 subroutine @code{_foo} accepts arguments in registers 9 and 10:
5168 @smallexample
5169 asm ("movl %0,r9\n\tmovl %1,r10\n\tcall _foo"
5170      : /* no outputs */
5171      : "g" (from), "g" (to)
5172      : "r9", "r10");
5173 @end smallexample
5175 Unless an output operand has the @samp{&} constraint modifier, GCC
5176 may allocate it in the same register as an unrelated input operand, on
5177 the assumption the inputs are consumed before the outputs are produced.
5178 This assumption may be false if the assembler code actually consists of
5179 more than one instruction.  In such a case, use @samp{&} for each output
5180 operand that may not overlap an input.  @xref{Modifiers}.
5182 If you want to test the condition code produced by an assembler
5183 instruction, you must include a branch and a label in the @code{asm}
5184 construct, as follows:
5186 @smallexample
5187 asm ("clr %0\n\tfrob %1\n\tbeq 0f\n\tmov #1,%0\n0:"
5188      : "g" (result)
5189      : "g" (input));
5190 @end smallexample
5192 @noindent
5193 This assumes your assembler supports local labels, as the GNU assembler
5194 and most Unix assemblers do.
5196 Speaking of labels, jumps from one @code{asm} to another are not
5197 supported.  The compiler's optimizers do not know about these jumps, and
5198 therefore they cannot take account of them when deciding how to
5199 optimize.
5201 @cindex macros containing @code{asm}
5202 Usually the most convenient way to use these @code{asm} instructions is to
5203 encapsulate them in macros that look like functions.  For example,
5205 @smallexample
5206 #define sin(x)       \
5207 (@{ double __value, __arg = (x);   \
5208    asm ("fsinx %1,%0": "=f" (__value): "f" (__arg));  \
5209    __value; @})
5210 @end smallexample
5212 @noindent
5213 Here the variable @code{__arg} is used to make sure that the instruction
5214 operates on a proper @code{double} value, and to accept only those
5215 arguments @code{x} which can convert automatically to a @code{double}.
5217 Another way to make sure the instruction operates on the correct data
5218 type is to use a cast in the @code{asm}.  This is different from using a
5219 variable @code{__arg} in that it converts more different types.  For
5220 example, if the desired type were @code{int}, casting the argument to
5221 @code{int} would accept a pointer with no complaint, while assigning the
5222 argument to an @code{int} variable named @code{__arg} would warn about
5223 using a pointer unless the caller explicitly casts it.
5225 If an @code{asm} has output operands, GCC assumes for optimization
5226 purposes the instruction has no side effects except to change the output
5227 operands.  This does not mean instructions with a side effect cannot be
5228 used, but you must be careful, because the compiler may eliminate them
5229 if the output operands aren't used, or move them out of loops, or
5230 replace two with one if they constitute a common subexpression.  Also,
5231 if your instruction does have a side effect on a variable that otherwise
5232 appears not to change, the old value of the variable may be reused later
5233 if it happens to be found in a register.
5235 You can prevent an @code{asm} instruction from being deleted
5236 by writing the keyword @code{volatile} after
5237 the @code{asm}.  For example:
5239 @smallexample
5240 #define get_and_set_priority(new)              \
5241 (@{ int __old;                                  \
5242    asm volatile ("get_and_set_priority %0, %1" \
5243                  : "=g" (__old) : "g" (new));  \
5244    __old; @})
5245 @end smallexample
5247 @noindent
5248 The @code{volatile} keyword indicates that the instruction has
5249 important side-effects.  GCC will not delete a volatile @code{asm} if
5250 it is reachable.  (The instruction can still be deleted if GCC can
5251 prove that control-flow will never reach the location of the
5252 instruction.)  Note that even a volatile @code{asm} instruction
5253 can be moved relative to other code, including across jump
5254 instructions.  For example, on many targets there is a system
5255 register which can be set to control the rounding mode of
5256 floating point operations.  You might try
5257 setting it with a volatile @code{asm}, like this PowerPC example:
5259 @smallexample
5260        asm volatile("mtfsf 255,%0" : : "f" (fpenv));
5261        sum = x + y;
5262 @end smallexample
5264 @noindent
5265 This will not work reliably, as the compiler may move the addition back
5266 before the volatile @code{asm}.  To make it work you need to add an
5267 artificial dependency to the @code{asm} referencing a variable in the code
5268 you don't want moved, for example:
5270 @smallexample
5271     asm volatile ("mtfsf 255,%1" : "=X"(sum): "f"(fpenv));
5272     sum = x + y;
5273 @end smallexample
5275 Similarly, you can't expect a
5276 sequence of volatile @code{asm} instructions to remain perfectly
5277 consecutive.  If you want consecutive output, use a single @code{asm}.
5278 Also, GCC will perform some optimizations across a volatile @code{asm}
5279 instruction; GCC does not ``forget everything'' when it encounters
5280 a volatile @code{asm} instruction the way some other compilers do.
5282 An @code{asm} instruction without any output operands will be treated
5283 identically to a volatile @code{asm} instruction.
5285 It is a natural idea to look for a way to give access to the condition
5286 code left by the assembler instruction.  However, when we attempted to
5287 implement this, we found no way to make it work reliably.  The problem
5288 is that output operands might need reloading, which would result in
5289 additional following ``store'' instructions.  On most machines, these
5290 instructions would alter the condition code before there was time to
5291 test it.  This problem doesn't arise for ordinary ``test'' and
5292 ``compare'' instructions because they don't have any output operands.
5294 For reasons similar to those described above, it is not possible to give
5295 an assembler instruction access to the condition code left by previous
5296 instructions.
5298 If you are writing a header file that should be includable in ISO C
5299 programs, write @code{__asm__} instead of @code{asm}.  @xref{Alternate
5300 Keywords}.
5302 @subsection Size of an @code{asm}
5304 Some targets require that GCC track the size of each instruction used in
5305 order to generate correct code.  Because the final length of an
5306 @code{asm} is only known by the assembler, GCC must make an estimate as
5307 to how big it will be.  The estimate is formed by counting the number of
5308 statements in the pattern of the @code{asm} and multiplying that by the
5309 length of the longest instruction on that processor.  Statements in the
5310 @code{asm} are identified by newline characters and whatever statement
5311 separator characters are supported by the assembler; on most processors
5312 this is the `@code{;}' character.
5314 Normally, GCC's estimate is perfectly adequate to ensure that correct
5315 code is generated, but it is possible to confuse the compiler if you use
5316 pseudo instructions or assembler macros that expand into multiple real
5317 instructions or if you use assembler directives that expand to more
5318 space in the object file than would be needed for a single instruction.
5319 If this happens then the assembler will produce a diagnostic saying that
5320 a label is unreachable.
5322 @subsection i386 floating point asm operands
5324 There are several rules on the usage of stack-like regs in
5325 asm_operands insns.  These rules apply only to the operands that are
5326 stack-like regs:
5328 @enumerate
5329 @item
5330 Given a set of input regs that die in an asm_operands, it is
5331 necessary to know which are implicitly popped by the asm, and
5332 which must be explicitly popped by gcc.
5334 An input reg that is implicitly popped by the asm must be
5335 explicitly clobbered, unless it is constrained to match an
5336 output operand.
5338 @item
5339 For any input reg that is implicitly popped by an asm, it is
5340 necessary to know how to adjust the stack to compensate for the pop.
5341 If any non-popped input is closer to the top of the reg-stack than
5342 the implicitly popped reg, it would not be possible to know what the
5343 stack looked like---it's not clear how the rest of the stack ``slides
5344 up''.
5346 All implicitly popped input regs must be closer to the top of
5347 the reg-stack than any input that is not implicitly popped.
5349 It is possible that if an input dies in an insn, reload might
5350 use the input reg for an output reload.  Consider this example:
5352 @smallexample
5353 asm ("foo" : "=t" (a) : "f" (b));
5354 @end smallexample
5356 This asm says that input B is not popped by the asm, and that
5357 the asm pushes a result onto the reg-stack, i.e., the stack is one
5358 deeper after the asm than it was before.  But, it is possible that
5359 reload will think that it can use the same reg for both the input and
5360 the output, if input B dies in this insn.
5362 If any input operand uses the @code{f} constraint, all output reg
5363 constraints must use the @code{&} earlyclobber.
5365 The asm above would be written as
5367 @smallexample
5368 asm ("foo" : "=&t" (a) : "f" (b));
5369 @end smallexample
5371 @item
5372 Some operands need to be in particular places on the stack.  All
5373 output operands fall in this category---there is no other way to
5374 know which regs the outputs appear in unless the user indicates
5375 this in the constraints.
5377 Output operands must specifically indicate which reg an output
5378 appears in after an asm.  @code{=f} is not allowed: the operand
5379 constraints must select a class with a single reg.
5381 @item
5382 Output operands may not be ``inserted'' between existing stack regs.
5383 Since no 387 opcode uses a read/write operand, all output operands
5384 are dead before the asm_operands, and are pushed by the asm_operands.
5385 It makes no sense to push anywhere but the top of the reg-stack.
5387 Output operands must start at the top of the reg-stack: output
5388 operands may not ``skip'' a reg.
5390 @item
5391 Some asm statements may need extra stack space for internal
5392 calculations.  This can be guaranteed by clobbering stack registers
5393 unrelated to the inputs and outputs.
5395 @end enumerate
5397 Here are a couple of reasonable asms to want to write.  This asm
5398 takes one input, which is internally popped, and produces two outputs.
5400 @smallexample
5401 asm ("fsincos" : "=t" (cos), "=u" (sin) : "0" (inp));
5402 @end smallexample
5404 This asm takes two inputs, which are popped by the @code{fyl2xp1} opcode,
5405 and replaces them with one output.  The user must code the @code{st(1)}
5406 clobber for reg-stack.c to know that @code{fyl2xp1} pops both inputs.
5408 @smallexample
5409 asm ("fyl2xp1" : "=t" (result) : "0" (x), "u" (y) : "st(1)");
5410 @end smallexample
5412 @include md.texi
5414 @node Asm Labels
5415 @section Controlling Names Used in Assembler Code
5416 @cindex assembler names for identifiers
5417 @cindex names used in assembler code
5418 @cindex identifiers, names in assembler code
5420 You can specify the name to be used in the assembler code for a C
5421 function or variable by writing the @code{asm} (or @code{__asm__})
5422 keyword after the declarator as follows:
5424 @smallexample
5425 int foo asm ("myfoo") = 2;
5426 @end smallexample
5428 @noindent
5429 This specifies that the name to be used for the variable @code{foo} in
5430 the assembler code should be @samp{myfoo} rather than the usual
5431 @samp{_foo}.
5433 On systems where an underscore is normally prepended to the name of a C
5434 function or variable, this feature allows you to define names for the
5435 linker that do not start with an underscore.
5437 It does not make sense to use this feature with a non-static local
5438 variable since such variables do not have assembler names.  If you are
5439 trying to put the variable in a particular register, see @ref{Explicit
5440 Reg Vars}.  GCC presently accepts such code with a warning, but will
5441 probably be changed to issue an error, rather than a warning, in the
5442 future.
5444 You cannot use @code{asm} in this way in a function @emph{definition}; but
5445 you can get the same effect by writing a declaration for the function
5446 before its definition and putting @code{asm} there, like this:
5448 @smallexample
5449 extern func () asm ("FUNC");
5451 func (x, y)
5452      int x, y;
5453 /* @r{@dots{}} */
5454 @end smallexample
5456 It is up to you to make sure that the assembler names you choose do not
5457 conflict with any other assembler symbols.  Also, you must not use a
5458 register name; that would produce completely invalid assembler code.  GCC
5459 does not as yet have the ability to store static variables in registers.
5460 Perhaps that will be added.
5462 @node Explicit Reg Vars
5463 @section Variables in Specified Registers
5464 @cindex explicit register variables
5465 @cindex variables in specified registers
5466 @cindex specified registers
5467 @cindex registers, global allocation
5469 GNU C allows you to put a few global variables into specified hardware
5470 registers.  You can also specify the register in which an ordinary
5471 register variable should be allocated.
5473 @itemize @bullet
5474 @item
5475 Global register variables reserve registers throughout the program.
5476 This may be useful in programs such as programming language
5477 interpreters which have a couple of global variables that are accessed
5478 very often.
5480 @item
5481 Local register variables in specific registers do not reserve the
5482 registers, except at the point where they are used as input or output
5483 operands in an @code{asm} statement and the @code{asm} statement itself is
5484 not deleted.  The compiler's data flow analysis is capable of determining
5485 where the specified registers contain live values, and where they are
5486 available for other uses.  Stores into local register variables may be deleted
5487 when they appear to be dead according to dataflow analysis.  References
5488 to local register variables may be deleted or moved or simplified.
5490 These local variables are sometimes convenient for use with the extended
5491 @code{asm} feature (@pxref{Extended Asm}), if you want to write one
5492 output of the assembler instruction directly into a particular register.
5493 (This will work provided the register you specify fits the constraints
5494 specified for that operand in the @code{asm}.)
5495 @end itemize
5497 @menu
5498 * Global Reg Vars::
5499 * Local Reg Vars::
5500 @end menu
5502 @node Global Reg Vars
5503 @subsection Defining Global Register Variables
5504 @cindex global register variables
5505 @cindex registers, global variables in
5507 You can define a global register variable in GNU C like this:
5509 @smallexample
5510 register int *foo asm ("a5");
5511 @end smallexample
5513 @noindent
5514 Here @code{a5} is the name of the register which should be used.  Choose a
5515 register which is normally saved and restored by function calls on your
5516 machine, so that library routines will not clobber it.
5518 Naturally the register name is cpu-dependent, so you would need to
5519 conditionalize your program according to cpu type.  The register
5520 @code{a5} would be a good choice on a 68000 for a variable of pointer
5521 type.  On machines with register windows, be sure to choose a ``global''
5522 register that is not affected magically by the function call mechanism.
5524 In addition, operating systems on one type of cpu may differ in how they
5525 name the registers; then you would need additional conditionals.  For
5526 example, some 68000 operating systems call this register @code{%a5}.
5528 Eventually there may be a way of asking the compiler to choose a register
5529 automatically, but first we need to figure out how it should choose and
5530 how to enable you to guide the choice.  No solution is evident.
5532 Defining a global register variable in a certain register reserves that
5533 register entirely for this use, at least within the current compilation.
5534 The register will not be allocated for any other purpose in the functions
5535 in the current compilation.  The register will not be saved and restored by
5536 these functions.  Stores into this register are never deleted even if they
5537 would appear to be dead, but references may be deleted or moved or
5538 simplified.
5540 It is not safe to access the global register variables from signal
5541 handlers, or from more than one thread of control, because the system
5542 library routines may temporarily use the register for other things (unless
5543 you recompile them specially for the task at hand).
5545 @cindex @code{qsort}, and global register variables
5546 It is not safe for one function that uses a global register variable to
5547 call another such function @code{foo} by way of a third function
5548 @code{lose} that was compiled without knowledge of this variable (i.e.@: in a
5549 different source file in which the variable wasn't declared).  This is
5550 because @code{lose} might save the register and put some other value there.
5551 For example, you can't expect a global register variable to be available in
5552 the comparison-function that you pass to @code{qsort}, since @code{qsort}
5553 might have put something else in that register.  (If you are prepared to
5554 recompile @code{qsort} with the same global register variable, you can
5555 solve this problem.)
5557 If you want to recompile @code{qsort} or other source files which do not
5558 actually use your global register variable, so that they will not use that
5559 register for any other purpose, then it suffices to specify the compiler
5560 option @option{-ffixed-@var{reg}}.  You need not actually add a global
5561 register declaration to their source code.
5563 A function which can alter the value of a global register variable cannot
5564 safely be called from a function compiled without this variable, because it
5565 could clobber the value the caller expects to find there on return.
5566 Therefore, the function which is the entry point into the part of the
5567 program that uses the global register variable must explicitly save and
5568 restore the value which belongs to its caller.
5570 @cindex register variable after @code{longjmp}
5571 @cindex global register after @code{longjmp}
5572 @cindex value after @code{longjmp}
5573 @findex longjmp
5574 @findex setjmp
5575 On most machines, @code{longjmp} will restore to each global register
5576 variable the value it had at the time of the @code{setjmp}.  On some
5577 machines, however, @code{longjmp} will not change the value of global
5578 register variables.  To be portable, the function that called @code{setjmp}
5579 should make other arrangements to save the values of the global register
5580 variables, and to restore them in a @code{longjmp}.  This way, the same
5581 thing will happen regardless of what @code{longjmp} does.
5583 All global register variable declarations must precede all function
5584 definitions.  If such a declaration could appear after function
5585 definitions, the declaration would be too late to prevent the register from
5586 being used for other purposes in the preceding functions.
5588 Global register variables may not have initial values, because an
5589 executable file has no means to supply initial contents for a register.
5591 On the SPARC, there are reports that g3 @dots{} g7 are suitable
5592 registers, but certain library functions, such as @code{getwd}, as well
5593 as the subroutines for division and remainder, modify g3 and g4.  g1 and
5594 g2 are local temporaries.
5596 On the 68000, a2 @dots{} a5 should be suitable, as should d2 @dots{} d7.
5597 Of course, it will not do to use more than a few of those.
5599 @node Local Reg Vars
5600 @subsection Specifying Registers for Local Variables
5601 @cindex local variables, specifying registers
5602 @cindex specifying registers for local variables
5603 @cindex registers for local variables
5605 You can define a local register variable with a specified register
5606 like this:
5608 @smallexample
5609 register int *foo asm ("a5");
5610 @end smallexample
5612 @noindent
5613 Here @code{a5} is the name of the register which should be used.  Note
5614 that this is the same syntax used for defining global register
5615 variables, but for a local variable it would appear within a function.
5617 Naturally the register name is cpu-dependent, but this is not a
5618 problem, since specific registers are most often useful with explicit
5619 assembler instructions (@pxref{Extended Asm}).  Both of these things
5620 generally require that you conditionalize your program according to
5621 cpu type.
5623 In addition, operating systems on one type of cpu may differ in how they
5624 name the registers; then you would need additional conditionals.  For
5625 example, some 68000 operating systems call this register @code{%a5}.
5627 Defining such a register variable does not reserve the register; it
5628 remains available for other uses in places where flow control determines
5629 the variable's value is not live.
5631 This option does not guarantee that GCC will generate code that has
5632 this variable in the register you specify at all times.  You may not
5633 code an explicit reference to this register in the @emph{assembler
5634 instruction template} part of an @code{asm} statement and assume it will
5635 always refer to this variable.  However, using the variable as an
5636 @code{asm} @emph{operand} guarantees that the specified register is used
5637 for the operand.
5639 Stores into local register variables may be deleted when they appear to be dead
5640 according to dataflow analysis.  References to local register variables may
5641 be deleted or moved or simplified.
5643 As for global register variables, it's recommended that you choose a
5644 register which is normally saved and restored by function calls on
5645 your machine, so that library routines will not clobber it.  A common
5646 pitfall is to initialize multiple call-clobbered registers with
5647 arbitrary expressions, where a function call or library call for an
5648 arithmetic operator will overwrite a register value from a previous
5649 assignment, for example @code{r0} below:
5650 @smallexample
5651 register int *p1 asm ("r0") = @dots{};
5652 register int *p2 asm ("r1") = @dots{};
5653 @end smallexample
5654 In those cases, a solution is to use a temporary variable for
5655 each arbitrary expression.   @xref{Example of asm with clobbered asm reg}.
5657 @node Alternate Keywords
5658 @section Alternate Keywords
5659 @cindex alternate keywords
5660 @cindex keywords, alternate
5662 @option{-ansi} and the various @option{-std} options disable certain
5663 keywords.  This causes trouble when you want to use GNU C extensions, or
5664 a general-purpose header file that should be usable by all programs,
5665 including ISO C programs.  The keywords @code{asm}, @code{typeof} and
5666 @code{inline} are not available in programs compiled with
5667 @option{-ansi} or @option{-std} (although @code{inline} can be used in a
5668 program compiled with @option{-std=c99}).  The ISO C99 keyword
5669 @code{restrict} is only available when @option{-std=gnu99} (which will
5670 eventually be the default) or @option{-std=c99} (or the equivalent
5671 @option{-std=iso9899:1999}) is used.
5673 The way to solve these problems is to put @samp{__} at the beginning and
5674 end of each problematical keyword.  For example, use @code{__asm__}
5675 instead of @code{asm}, and @code{__inline__} instead of @code{inline}.
5677 Other C compilers won't accept these alternative keywords; if you want to
5678 compile with another compiler, you can define the alternate keywords as
5679 macros to replace them with the customary keywords.  It looks like this:
5681 @smallexample
5682 #ifndef __GNUC__
5683 #define __asm__ asm
5684 #endif
5685 @end smallexample
5687 @findex __extension__
5688 @opindex pedantic
5689 @option{-pedantic} and other options cause warnings for many GNU C extensions.
5690 You can
5691 prevent such warnings within one expression by writing
5692 @code{__extension__} before the expression.  @code{__extension__} has no
5693 effect aside from this.
5695 @node Incomplete Enums
5696 @section Incomplete @code{enum} Types
5698 You can define an @code{enum} tag without specifying its possible values.
5699 This results in an incomplete type, much like what you get if you write
5700 @code{struct foo} without describing the elements.  A later declaration
5701 which does specify the possible values completes the type.
5703 You can't allocate variables or storage using the type while it is
5704 incomplete.  However, you can work with pointers to that type.
5706 This extension may not be very useful, but it makes the handling of
5707 @code{enum} more consistent with the way @code{struct} and @code{union}
5708 are handled.
5710 This extension is not supported by GNU C++.
5712 @node Function Names
5713 @section Function Names as Strings
5714 @cindex @code{__func__} identifier
5715 @cindex @code{__FUNCTION__} identifier
5716 @cindex @code{__PRETTY_FUNCTION__} identifier
5718 GCC provides three magic variables which hold the name of the current
5719 function, as a string.  The first of these is @code{__func__}, which
5720 is part of the C99 standard:
5722 The identifier @code{__func__} is implicitly declared by the translator
5723 as if, immediately following the opening brace of each function
5724 definition, the declaration
5726 @smallexample
5727 static const char __func__[] = "function-name";
5728 @end smallexample
5730 @noindent
5731 appeared, where function-name is the name of the lexically-enclosing
5732 function.  This name is the unadorned name of the function.
5734 @code{__FUNCTION__} is another name for @code{__func__}.  Older
5735 versions of GCC recognize only this name.  However, it is not
5736 standardized.  For maximum portability, we recommend you use
5737 @code{__func__}, but provide a fallback definition with the
5738 preprocessor:
5740 @smallexample
5741 #if __STDC_VERSION__ < 199901L
5742 # if __GNUC__ >= 2
5743 #  define __func__ __FUNCTION__
5744 # else
5745 #  define __func__ "<unknown>"
5746 # endif
5747 #endif
5748 @end smallexample
5750 In C, @code{__PRETTY_FUNCTION__} is yet another name for
5751 @code{__func__}.  However, in C++, @code{__PRETTY_FUNCTION__} contains
5752 the type signature of the function as well as its bare name.  For
5753 example, this program:
5755 @smallexample
5756 extern "C" @{
5757 extern int printf (char *, ...);
5760 class a @{
5761  public:
5762   void sub (int i)
5763     @{
5764       printf ("__FUNCTION__ = %s\n", __FUNCTION__);
5765       printf ("__PRETTY_FUNCTION__ = %s\n", __PRETTY_FUNCTION__);
5766     @}
5770 main (void)
5772   a ax;
5773   ax.sub (0);
5774   return 0;
5776 @end smallexample
5778 @noindent
5779 gives this output:
5781 @smallexample
5782 __FUNCTION__ = sub
5783 __PRETTY_FUNCTION__ = void a::sub(int)
5784 @end smallexample
5786 These identifiers are not preprocessor macros.  In GCC 3.3 and
5787 earlier, in C only, @code{__FUNCTION__} and @code{__PRETTY_FUNCTION__}
5788 were treated as string literals; they could be used to initialize
5789 @code{char} arrays, and they could be concatenated with other string
5790 literals.  GCC 3.4 and later treat them as variables, like
5791 @code{__func__}.  In C++, @code{__FUNCTION__} and
5792 @code{__PRETTY_FUNCTION__} have always been variables.
5794 @node Return Address
5795 @section Getting the Return or Frame Address of a Function
5797 These functions may be used to get information about the callers of a
5798 function.
5800 @deftypefn {Built-in Function} {void *} __builtin_return_address (unsigned int @var{level})
5801 This function returns the return address of the current function, or of
5802 one of its callers.  The @var{level} argument is number of frames to
5803 scan up the call stack.  A value of @code{0} yields the return address
5804 of the current function, a value of @code{1} yields the return address
5805 of the caller of the current function, and so forth.  When inlining
5806 the expected behavior is that the function will return the address of
5807 the function that will be returned to.  To work around this behavior use
5808 the @code{noinline} function attribute.
5810 The @var{level} argument must be a constant integer.
5812 On some machines it may be impossible to determine the return address of
5813 any function other than the current one; in such cases, or when the top
5814 of the stack has been reached, this function will return @code{0} or a
5815 random value.  In addition, @code{__builtin_frame_address} may be used
5816 to determine if the top of the stack has been reached.
5818 This function should only be used with a nonzero argument for debugging
5819 purposes.
5820 @end deftypefn
5822 @deftypefn {Built-in Function} {void *} __builtin_frame_address (unsigned int @var{level})
5823 This function is similar to @code{__builtin_return_address}, but it
5824 returns the address of the function frame rather than the return address
5825 of the function.  Calling @code{__builtin_frame_address} with a value of
5826 @code{0} yields the frame address of the current function, a value of
5827 @code{1} yields the frame address of the caller of the current function,
5828 and so forth.
5830 The frame is the area on the stack which holds local variables and saved
5831 registers.  The frame address is normally the address of the first word
5832 pushed on to the stack by the function.  However, the exact definition
5833 depends upon the processor and the calling convention.  If the processor
5834 has a dedicated frame pointer register, and the function has a frame,
5835 then @code{__builtin_frame_address} will return the value of the frame
5836 pointer register.
5838 On some machines it may be impossible to determine the frame address of
5839 any function other than the current one; in such cases, or when the top
5840 of the stack has been reached, this function will return @code{0} if
5841 the first frame pointer is properly initialized by the startup code.
5843 This function should only be used with a nonzero argument for debugging
5844 purposes.
5845 @end deftypefn
5847 @node Vector Extensions
5848 @section Using vector instructions through built-in functions
5850 On some targets, the instruction set contains SIMD vector instructions that
5851 operate on multiple values contained in one large register at the same time.
5852 For example, on the i386 the MMX, 3Dnow! and SSE extensions can be used
5853 this way.
5855 The first step in using these extensions is to provide the necessary data
5856 types.  This should be done using an appropriate @code{typedef}:
5858 @smallexample
5859 typedef int v4si __attribute__ ((vector_size (16)));
5860 @end smallexample
5862 The @code{int} type specifies the base type, while the attribute specifies
5863 the vector size for the variable, measured in bytes.  For example, the
5864 declaration above causes the compiler to set the mode for the @code{v4si}
5865 type to be 16 bytes wide and divided into @code{int} sized units.  For
5866 a 32-bit @code{int} this means a vector of 4 units of 4 bytes, and the
5867 corresponding mode of @code{foo} will be @acronym{V4SI}.
5869 The @code{vector_size} attribute is only applicable to integral and
5870 float scalars, although arrays, pointers, and function return values
5871 are allowed in conjunction with this construct.
5873 All the basic integer types can be used as base types, both as signed
5874 and as unsigned: @code{char}, @code{short}, @code{int}, @code{long},
5875 @code{long long}.  In addition, @code{float} and @code{double} can be
5876 used to build floating-point vector types.
5878 Specifying a combination that is not valid for the current architecture
5879 will cause GCC to synthesize the instructions using a narrower mode.
5880 For example, if you specify a variable of type @code{V4SI} and your
5881 architecture does not allow for this specific SIMD type, GCC will
5882 produce code that uses 4 @code{SIs}.
5884 The types defined in this manner can be used with a subset of normal C
5885 operations.  Currently, GCC will allow using the following operators
5886 on these types: @code{+, -, *, /, unary minus, ^, |, &, ~, %}@.
5888 The operations behave like C++ @code{valarrays}.  Addition is defined as
5889 the addition of the corresponding elements of the operands.  For
5890 example, in the code below, each of the 4 elements in @var{a} will be
5891 added to the corresponding 4 elements in @var{b} and the resulting
5892 vector will be stored in @var{c}.
5894 @smallexample
5895 typedef int v4si __attribute__ ((vector_size (16)));
5897 v4si a, b, c;
5899 c = a + b;
5900 @end smallexample
5902 Subtraction, multiplication, division, and the logical operations
5903 operate in a similar manner.  Likewise, the result of using the unary
5904 minus or complement operators on a vector type is a vector whose
5905 elements are the negative or complemented values of the corresponding
5906 elements in the operand.
5908 You can declare variables and use them in function calls and returns, as
5909 well as in assignments and some casts.  You can specify a vector type as
5910 a return type for a function.  Vector types can also be used as function
5911 arguments.  It is possible to cast from one vector type to another,
5912 provided they are of the same size (in fact, you can also cast vectors
5913 to and from other datatypes of the same size).
5915 You cannot operate between vectors of different lengths or different
5916 signedness without a cast.
5918 A port that supports hardware vector operations, usually provides a set
5919 of built-in functions that can be used to operate on vectors.  For
5920 example, a function to add two vectors and multiply the result by a
5921 third could look like this:
5923 @smallexample
5924 v4si f (v4si a, v4si b, v4si c)
5926   v4si tmp = __builtin_addv4si (a, b);
5927   return __builtin_mulv4si (tmp, c);
5930 @end smallexample
5932 @node Offsetof
5933 @section Offsetof
5934 @findex __builtin_offsetof
5936 GCC implements for both C and C++ a syntactic extension to implement
5937 the @code{offsetof} macro.
5939 @smallexample
5940 primary:
5941         "__builtin_offsetof" "(" @code{typename} "," offsetof_member_designator ")"
5943 offsetof_member_designator:
5944           @code{identifier}
5945         | offsetof_member_designator "." @code{identifier}
5946         | offsetof_member_designator "[" @code{expr} "]"
5947 @end smallexample
5949 This extension is sufficient such that
5951 @smallexample
5952 #define offsetof(@var{type}, @var{member})  __builtin_offsetof (@var{type}, @var{member})
5953 @end smallexample
5955 is a suitable definition of the @code{offsetof} macro.  In C++, @var{type}
5956 may be dependent.  In either case, @var{member} may consist of a single
5957 identifier, or a sequence of member accesses and array references.
5959 @node Atomic Builtins
5960 @section Built-in functions for atomic memory access
5962 The following builtins are intended to be compatible with those described
5963 in the @cite{Intel Itanium Processor-specific Application Binary Interface},
5964 section 7.4.  As such, they depart from the normal GCC practice of using
5965 the ``__builtin_'' prefix, and further that they are overloaded such that
5966 they work on multiple types.
5968 The definition given in the Intel documentation allows only for the use of
5969 the types @code{int}, @code{long}, @code{long long} as well as their unsigned
5970 counterparts.  GCC will allow any integral scalar or pointer type that is
5971 1, 2, 4 or 8 bytes in length.
5973 Not all operations are supported by all target processors.  If a particular
5974 operation cannot be implemented on the target processor, a warning will be
5975 generated and a call an external function will be generated.  The external
5976 function will carry the same name as the builtin, with an additional suffix
5977 @samp{_@var{n}} where @var{n} is the size of the data type.
5979 @c ??? Should we have a mechanism to suppress this warning?  This is almost
5980 @c useful for implementing the operation under the control of an external
5981 @c mutex.
5983 In most cases, these builtins are considered a @dfn{full barrier}.  That is,
5984 no memory operand will be moved across the operation, either forward or
5985 backward.  Further, instructions will be issued as necessary to prevent the
5986 processor from speculating loads across the operation and from queuing stores
5987 after the operation.
5989 All of the routines are described in the Intel documentation to take
5990 ``an optional list of variables protected by the memory barrier''.  It's
5991 not clear what is meant by that; it could mean that @emph{only} the
5992 following variables are protected, or it could mean that these variables
5993 should in addition be protected.  At present GCC ignores this list and
5994 protects all variables which are globally accessible.  If in the future
5995 we make some use of this list, an empty list will continue to mean all
5996 globally accessible variables.
5998 @table @code
5999 @item @var{type} __sync_fetch_and_add (@var{type} *ptr, @var{type} value, ...)
6000 @itemx @var{type} __sync_fetch_and_sub (@var{type} *ptr, @var{type} value, ...)
6001 @itemx @var{type} __sync_fetch_and_or (@var{type} *ptr, @var{type} value, ...)
6002 @itemx @var{type} __sync_fetch_and_and (@var{type} *ptr, @var{type} value, ...)
6003 @itemx @var{type} __sync_fetch_and_xor (@var{type} *ptr, @var{type} value, ...)
6004 @itemx @var{type} __sync_fetch_and_nand (@var{type} *ptr, @var{type} value, ...)
6005 @findex __sync_fetch_and_add
6006 @findex __sync_fetch_and_sub
6007 @findex __sync_fetch_and_or
6008 @findex __sync_fetch_and_and
6009 @findex __sync_fetch_and_xor
6010 @findex __sync_fetch_and_nand
6011 These builtins perform the operation suggested by the name, and
6012 returns the value that had previously been in memory.  That is,
6014 @smallexample
6015 @{ tmp = *ptr; *ptr @var{op}= value; return tmp; @}
6016 @{ tmp = *ptr; *ptr = ~(tmp & value); return tmp; @}   // nand
6017 @end smallexample
6019 @emph{Note:} GCC 4.4 and later implement @code{__sync_fetch_and_nand}
6020 builtin as @code{*ptr = ~(tmp & value)} instead of @code{*ptr = ~tmp & value}.
6022 @item @var{type} __sync_add_and_fetch (@var{type} *ptr, @var{type} value, ...)
6023 @itemx @var{type} __sync_sub_and_fetch (@var{type} *ptr, @var{type} value, ...)
6024 @itemx @var{type} __sync_or_and_fetch (@var{type} *ptr, @var{type} value, ...)
6025 @itemx @var{type} __sync_and_and_fetch (@var{type} *ptr, @var{type} value, ...)
6026 @itemx @var{type} __sync_xor_and_fetch (@var{type} *ptr, @var{type} value, ...)
6027 @itemx @var{type} __sync_nand_and_fetch (@var{type} *ptr, @var{type} value, ...)
6028 @findex __sync_add_and_fetch
6029 @findex __sync_sub_and_fetch
6030 @findex __sync_or_and_fetch
6031 @findex __sync_and_and_fetch
6032 @findex __sync_xor_and_fetch
6033 @findex __sync_nand_and_fetch
6034 These builtins perform the operation suggested by the name, and
6035 return the new value.  That is,
6037 @smallexample
6038 @{ *ptr @var{op}= value; return *ptr; @}
6039 @{ *ptr = ~(*ptr & value); return *ptr; @}   // nand
6040 @end smallexample
6042 @emph{Note:} GCC 4.4 and later implement @code{__sync_nand_and_fetch}
6043 builtin as @code{*ptr = ~(*ptr & value)} instead of
6044 @code{*ptr = ~*ptr & value}.
6046 @item bool __sync_bool_compare_and_swap (@var{type} *ptr, @var{type} oldval @var{type} newval, ...)
6047 @itemx @var{type} __sync_val_compare_and_swap (@var{type} *ptr, @var{type} oldval @var{type} newval, ...)
6048 @findex __sync_bool_compare_and_swap
6049 @findex __sync_val_compare_and_swap
6050 These builtins perform an atomic compare and swap.  That is, if the current
6051 value of @code{*@var{ptr}} is @var{oldval}, then write @var{newval} into
6052 @code{*@var{ptr}}.
6054 The ``bool'' version returns true if the comparison is successful and
6055 @var{newval} was written.  The ``val'' version returns the contents
6056 of @code{*@var{ptr}} before the operation.
6058 @item __sync_synchronize (...)
6059 @findex __sync_synchronize
6060 This builtin issues a full memory barrier.
6062 @item @var{type} __sync_lock_test_and_set (@var{type} *ptr, @var{type} value, ...)
6063 @findex __sync_lock_test_and_set
6064 This builtin, as described by Intel, is not a traditional test-and-set
6065 operation, but rather an atomic exchange operation.  It writes @var{value}
6066 into @code{*@var{ptr}}, and returns the previous contents of
6067 @code{*@var{ptr}}.
6069 Many targets have only minimal support for such locks, and do not support
6070 a full exchange operation.  In this case, a target may support reduced
6071 functionality here by which the @emph{only} valid value to store is the
6072 immediate constant 1.  The exact value actually stored in @code{*@var{ptr}}
6073 is implementation defined.
6075 This builtin is not a full barrier, but rather an @dfn{acquire barrier}.
6076 This means that references after the builtin cannot move to (or be
6077 speculated to) before the builtin, but previous memory stores may not
6078 be globally visible yet, and previous memory loads may not yet be
6079 satisfied.
6081 @item void __sync_lock_release (@var{type} *ptr, ...)
6082 @findex __sync_lock_release
6083 This builtin releases the lock acquired by @code{__sync_lock_test_and_set}.
6084 Normally this means writing the constant 0 to @code{*@var{ptr}}.
6086 This builtin is not a full barrier, but rather a @dfn{release barrier}.
6087 This means that all previous memory stores are globally visible, and all
6088 previous memory loads have been satisfied, but following memory reads
6089 are not prevented from being speculated to before the barrier.
6090 @end table
6092 @node Object Size Checking
6093 @section Object Size Checking Builtins
6094 @findex __builtin_object_size
6095 @findex __builtin___memcpy_chk
6096 @findex __builtin___mempcpy_chk
6097 @findex __builtin___memmove_chk
6098 @findex __builtin___memset_chk
6099 @findex __builtin___strcpy_chk
6100 @findex __builtin___stpcpy_chk
6101 @findex __builtin___strncpy_chk
6102 @findex __builtin___strcat_chk
6103 @findex __builtin___strncat_chk
6104 @findex __builtin___sprintf_chk
6105 @findex __builtin___snprintf_chk
6106 @findex __builtin___vsprintf_chk
6107 @findex __builtin___vsnprintf_chk
6108 @findex __builtin___printf_chk
6109 @findex __builtin___vprintf_chk
6110 @findex __builtin___fprintf_chk
6111 @findex __builtin___vfprintf_chk
6113 GCC implements a limited buffer overflow protection mechanism
6114 that can prevent some buffer overflow attacks.
6116 @deftypefn {Built-in Function} {size_t} __builtin_object_size (void * @var{ptr}, int @var{type})
6117 is a built-in construct that returns a constant number of bytes from
6118 @var{ptr} to the end of the object @var{ptr} pointer points to
6119 (if known at compile time).  @code{__builtin_object_size} never evaluates
6120 its arguments for side-effects.  If there are any side-effects in them, it
6121 returns @code{(size_t) -1} for @var{type} 0 or 1 and @code{(size_t) 0}
6122 for @var{type} 2 or 3.  If there are multiple objects @var{ptr} can
6123 point to and all of them are known at compile time, the returned number
6124 is the maximum of remaining byte counts in those objects if @var{type} & 2 is
6125 0 and minimum if nonzero.  If it is not possible to determine which objects
6126 @var{ptr} points to at compile time, @code{__builtin_object_size} should
6127 return @code{(size_t) -1} for @var{type} 0 or 1 and @code{(size_t) 0}
6128 for @var{type} 2 or 3.
6130 @var{type} is an integer constant from 0 to 3.  If the least significant
6131 bit is clear, objects are whole variables, if it is set, a closest
6132 surrounding subobject is considered the object a pointer points to.
6133 The second bit determines if maximum or minimum of remaining bytes
6134 is computed.
6136 @smallexample
6137 struct V @{ char buf1[10]; int b; char buf2[10]; @} var;
6138 char *p = &var.buf1[1], *q = &var.b;
6140 /* Here the object p points to is var.  */
6141 assert (__builtin_object_size (p, 0) == sizeof (var) - 1);
6142 /* The subobject p points to is var.buf1.  */
6143 assert (__builtin_object_size (p, 1) == sizeof (var.buf1) - 1);
6144 /* The object q points to is var.  */
6145 assert (__builtin_object_size (q, 0)
6146         == (char *) (&var + 1) - (char *) &var.b);
6147 /* The subobject q points to is var.b.  */
6148 assert (__builtin_object_size (q, 1) == sizeof (var.b));
6149 @end smallexample
6150 @end deftypefn
6152 There are built-in functions added for many common string operation
6153 functions, e.g., for @code{memcpy} @code{__builtin___memcpy_chk}
6154 built-in is provided.  This built-in has an additional last argument,
6155 which is the number of bytes remaining in object the @var{dest}
6156 argument points to or @code{(size_t) -1} if the size is not known.
6158 The built-in functions are optimized into the normal string functions
6159 like @code{memcpy} if the last argument is @code{(size_t) -1} or if
6160 it is known at compile time that the destination object will not
6161 be overflown.  If the compiler can determine at compile time the
6162 object will be always overflown, it issues a warning.
6164 The intended use can be e.g.
6166 @smallexample
6167 #undef memcpy
6168 #define bos0(dest) __builtin_object_size (dest, 0)
6169 #define memcpy(dest, src, n) \
6170   __builtin___memcpy_chk (dest, src, n, bos0 (dest))
6172 char *volatile p;
6173 char buf[10];
6174 /* It is unknown what object p points to, so this is optimized
6175    into plain memcpy - no checking is possible.  */
6176 memcpy (p, "abcde", n);
6177 /* Destination is known and length too.  It is known at compile
6178    time there will be no overflow.  */
6179 memcpy (&buf[5], "abcde", 5);
6180 /* Destination is known, but the length is not known at compile time.
6181    This will result in __memcpy_chk call that can check for overflow
6182    at runtime.  */
6183 memcpy (&buf[5], "abcde", n);
6184 /* Destination is known and it is known at compile time there will
6185    be overflow.  There will be a warning and __memcpy_chk call that
6186    will abort the program at runtime.  */
6187 memcpy (&buf[6], "abcde", 5);
6188 @end smallexample
6190 Such built-in functions are provided for @code{memcpy}, @code{mempcpy},
6191 @code{memmove}, @code{memset}, @code{strcpy}, @code{stpcpy}, @code{strncpy},
6192 @code{strcat} and @code{strncat}.
6194 There are also checking built-in functions for formatted output functions.
6195 @smallexample
6196 int __builtin___sprintf_chk (char *s, int flag, size_t os, const char *fmt, ...);
6197 int __builtin___snprintf_chk (char *s, size_t maxlen, int flag, size_t os,
6198                               const char *fmt, ...);
6199 int __builtin___vsprintf_chk (char *s, int flag, size_t os, const char *fmt,
6200                               va_list ap);
6201 int __builtin___vsnprintf_chk (char *s, size_t maxlen, int flag, size_t os,
6202                                const char *fmt, va_list ap);
6203 @end smallexample
6205 The added @var{flag} argument is passed unchanged to @code{__sprintf_chk}
6206 etc.@: functions and can contain implementation specific flags on what
6207 additional security measures the checking function might take, such as
6208 handling @code{%n} differently.
6210 The @var{os} argument is the object size @var{s} points to, like in the
6211 other built-in functions.  There is a small difference in the behavior
6212 though, if @var{os} is @code{(size_t) -1}, the built-in functions are
6213 optimized into the non-checking functions only if @var{flag} is 0, otherwise
6214 the checking function is called with @var{os} argument set to
6215 @code{(size_t) -1}.
6217 In addition to this, there are checking built-in functions
6218 @code{__builtin___printf_chk}, @code{__builtin___vprintf_chk},
6219 @code{__builtin___fprintf_chk} and @code{__builtin___vfprintf_chk}.
6220 These have just one additional argument, @var{flag}, right before
6221 format string @var{fmt}.  If the compiler is able to optimize them to
6222 @code{fputc} etc.@: functions, it will, otherwise the checking function
6223 should be called and the @var{flag} argument passed to it.
6225 @node Other Builtins
6226 @section Other built-in functions provided by GCC
6227 @cindex built-in functions
6228 @findex __builtin_fpclassify
6229 @findex __builtin_isfinite
6230 @findex __builtin_isnormal
6231 @findex __builtin_isgreater
6232 @findex __builtin_isgreaterequal
6233 @findex __builtin_isinf_sign
6234 @findex __builtin_isless
6235 @findex __builtin_islessequal
6236 @findex __builtin_islessgreater
6237 @findex __builtin_isunordered
6238 @findex __builtin_powi
6239 @findex __builtin_powif
6240 @findex __builtin_powil
6241 @findex _Exit
6242 @findex _exit
6243 @findex abort
6244 @findex abs
6245 @findex acos
6246 @findex acosf
6247 @findex acosh
6248 @findex acoshf
6249 @findex acoshl
6250 @findex acosl
6251 @findex alloca
6252 @findex asin
6253 @findex asinf
6254 @findex asinh
6255 @findex asinhf
6256 @findex asinhl
6257 @findex asinl
6258 @findex atan
6259 @findex atan2
6260 @findex atan2f
6261 @findex atan2l
6262 @findex atanf
6263 @findex atanh
6264 @findex atanhf
6265 @findex atanhl
6266 @findex atanl
6267 @findex bcmp
6268 @findex bzero
6269 @findex cabs
6270 @findex cabsf
6271 @findex cabsl
6272 @findex cacos
6273 @findex cacosf
6274 @findex cacosh
6275 @findex cacoshf
6276 @findex cacoshl
6277 @findex cacosl
6278 @findex calloc
6279 @findex carg
6280 @findex cargf
6281 @findex cargl
6282 @findex casin
6283 @findex casinf
6284 @findex casinh
6285 @findex casinhf
6286 @findex casinhl
6287 @findex casinl
6288 @findex catan
6289 @findex catanf
6290 @findex catanh
6291 @findex catanhf
6292 @findex catanhl
6293 @findex catanl
6294 @findex cbrt
6295 @findex cbrtf
6296 @findex cbrtl
6297 @findex ccos
6298 @findex ccosf
6299 @findex ccosh
6300 @findex ccoshf
6301 @findex ccoshl
6302 @findex ccosl
6303 @findex ceil
6304 @findex ceilf
6305 @findex ceill
6306 @findex cexp
6307 @findex cexpf
6308 @findex cexpl
6309 @findex cimag
6310 @findex cimagf
6311 @findex cimagl
6312 @findex clog
6313 @findex clogf
6314 @findex clogl
6315 @findex conj
6316 @findex conjf
6317 @findex conjl
6318 @findex copysign
6319 @findex copysignf
6320 @findex copysignl
6321 @findex cos
6322 @findex cosf
6323 @findex cosh
6324 @findex coshf
6325 @findex coshl
6326 @findex cosl
6327 @findex cpow
6328 @findex cpowf
6329 @findex cpowl
6330 @findex cproj
6331 @findex cprojf
6332 @findex cprojl
6333 @findex creal
6334 @findex crealf
6335 @findex creall
6336 @findex csin
6337 @findex csinf
6338 @findex csinh
6339 @findex csinhf
6340 @findex csinhl
6341 @findex csinl
6342 @findex csqrt
6343 @findex csqrtf
6344 @findex csqrtl
6345 @findex ctan
6346 @findex ctanf
6347 @findex ctanh
6348 @findex ctanhf
6349 @findex ctanhl
6350 @findex ctanl
6351 @findex dcgettext
6352 @findex dgettext
6353 @findex drem
6354 @findex dremf
6355 @findex dreml
6356 @findex erf
6357 @findex erfc
6358 @findex erfcf
6359 @findex erfcl
6360 @findex erff
6361 @findex erfl
6362 @findex exit
6363 @findex exp
6364 @findex exp10
6365 @findex exp10f
6366 @findex exp10l
6367 @findex exp2
6368 @findex exp2f
6369 @findex exp2l
6370 @findex expf
6371 @findex expl
6372 @findex expm1
6373 @findex expm1f
6374 @findex expm1l
6375 @findex fabs
6376 @findex fabsf
6377 @findex fabsl
6378 @findex fdim
6379 @findex fdimf
6380 @findex fdiml
6381 @findex ffs
6382 @findex floor
6383 @findex floorf
6384 @findex floorl
6385 @findex fma
6386 @findex fmaf
6387 @findex fmal
6388 @findex fmax
6389 @findex fmaxf
6390 @findex fmaxl
6391 @findex fmin
6392 @findex fminf
6393 @findex fminl
6394 @findex fmod
6395 @findex fmodf
6396 @findex fmodl
6397 @findex fprintf
6398 @findex fprintf_unlocked
6399 @findex fputs
6400 @findex fputs_unlocked
6401 @findex frexp
6402 @findex frexpf
6403 @findex frexpl
6404 @findex fscanf
6405 @findex gamma
6406 @findex gammaf
6407 @findex gammal
6408 @findex gamma_r
6409 @findex gammaf_r
6410 @findex gammal_r
6411 @findex gettext
6412 @findex hypot
6413 @findex hypotf
6414 @findex hypotl
6415 @findex ilogb
6416 @findex ilogbf
6417 @findex ilogbl
6418 @findex imaxabs
6419 @findex index
6420 @findex isalnum
6421 @findex isalpha
6422 @findex isascii
6423 @findex isblank
6424 @findex iscntrl
6425 @findex isdigit
6426 @findex isgraph
6427 @findex islower
6428 @findex isprint
6429 @findex ispunct
6430 @findex isspace
6431 @findex isupper
6432 @findex iswalnum
6433 @findex iswalpha
6434 @findex iswblank
6435 @findex iswcntrl
6436 @findex iswdigit
6437 @findex iswgraph
6438 @findex iswlower
6439 @findex iswprint
6440 @findex iswpunct
6441 @findex iswspace
6442 @findex iswupper
6443 @findex iswxdigit
6444 @findex isxdigit
6445 @findex j0
6446 @findex j0f
6447 @findex j0l
6448 @findex j1
6449 @findex j1f
6450 @findex j1l
6451 @findex jn
6452 @findex jnf
6453 @findex jnl
6454 @findex labs
6455 @findex ldexp
6456 @findex ldexpf
6457 @findex ldexpl
6458 @findex lgamma
6459 @findex lgammaf
6460 @findex lgammal
6461 @findex lgamma_r
6462 @findex lgammaf_r
6463 @findex lgammal_r
6464 @findex llabs
6465 @findex llrint
6466 @findex llrintf
6467 @findex llrintl
6468 @findex llround
6469 @findex llroundf
6470 @findex llroundl
6471 @findex log
6472 @findex log10
6473 @findex log10f
6474 @findex log10l
6475 @findex log1p
6476 @findex log1pf
6477 @findex log1pl
6478 @findex log2
6479 @findex log2f
6480 @findex log2l
6481 @findex logb
6482 @findex logbf
6483 @findex logbl
6484 @findex logf
6485 @findex logl
6486 @findex lrint
6487 @findex lrintf
6488 @findex lrintl
6489 @findex lround
6490 @findex lroundf
6491 @findex lroundl
6492 @findex malloc
6493 @findex memchr
6494 @findex memcmp
6495 @findex memcpy
6496 @findex mempcpy
6497 @findex memset
6498 @findex modf
6499 @findex modff
6500 @findex modfl
6501 @findex nearbyint
6502 @findex nearbyintf
6503 @findex nearbyintl
6504 @findex nextafter
6505 @findex nextafterf
6506 @findex nextafterl
6507 @findex nexttoward
6508 @findex nexttowardf
6509 @findex nexttowardl
6510 @findex pow
6511 @findex pow10
6512 @findex pow10f
6513 @findex pow10l
6514 @findex powf
6515 @findex powl
6516 @findex printf
6517 @findex printf_unlocked
6518 @findex putchar
6519 @findex puts
6520 @findex remainder
6521 @findex remainderf
6522 @findex remainderl
6523 @findex remquo
6524 @findex remquof
6525 @findex remquol
6526 @findex rindex
6527 @findex rint
6528 @findex rintf
6529 @findex rintl
6530 @findex round
6531 @findex roundf
6532 @findex roundl
6533 @findex scalb
6534 @findex scalbf
6535 @findex scalbl
6536 @findex scalbln
6537 @findex scalblnf
6538 @findex scalblnf
6539 @findex scalbn
6540 @findex scalbnf
6541 @findex scanfnl
6542 @findex signbit
6543 @findex signbitf
6544 @findex signbitl
6545 @findex signbitd32
6546 @findex signbitd64
6547 @findex signbitd128
6548 @findex significand
6549 @findex significandf
6550 @findex significandl
6551 @findex sin
6552 @findex sincos
6553 @findex sincosf
6554 @findex sincosl
6555 @findex sinf
6556 @findex sinh
6557 @findex sinhf
6558 @findex sinhl
6559 @findex sinl
6560 @findex snprintf
6561 @findex sprintf
6562 @findex sqrt
6563 @findex sqrtf
6564 @findex sqrtl
6565 @findex sscanf
6566 @findex stpcpy
6567 @findex stpncpy
6568 @findex strcasecmp
6569 @findex strcat
6570 @findex strchr
6571 @findex strcmp
6572 @findex strcpy
6573 @findex strcspn
6574 @findex strdup
6575 @findex strfmon
6576 @findex strftime
6577 @findex strlen
6578 @findex strncasecmp
6579 @findex strncat
6580 @findex strncmp
6581 @findex strncpy
6582 @findex strndup
6583 @findex strpbrk
6584 @findex strrchr
6585 @findex strspn
6586 @findex strstr
6587 @findex tan
6588 @findex tanf
6589 @findex tanh
6590 @findex tanhf
6591 @findex tanhl
6592 @findex tanl
6593 @findex tgamma
6594 @findex tgammaf
6595 @findex tgammal
6596 @findex toascii
6597 @findex tolower
6598 @findex toupper
6599 @findex towlower
6600 @findex towupper
6601 @findex trunc
6602 @findex truncf
6603 @findex truncl
6604 @findex vfprintf
6605 @findex vfscanf
6606 @findex vprintf
6607 @findex vscanf
6608 @findex vsnprintf
6609 @findex vsprintf
6610 @findex vsscanf
6611 @findex y0
6612 @findex y0f
6613 @findex y0l
6614 @findex y1
6615 @findex y1f
6616 @findex y1l
6617 @findex yn
6618 @findex ynf
6619 @findex ynl
6621 GCC provides a large number of built-in functions other than the ones
6622 mentioned above.  Some of these are for internal use in the processing
6623 of exceptions or variable-length argument lists and will not be
6624 documented here because they may change from time to time; we do not
6625 recommend general use of these functions.
6627 The remaining functions are provided for optimization purposes.
6629 @opindex fno-builtin
6630 GCC includes built-in versions of many of the functions in the standard
6631 C library.  The versions prefixed with @code{__builtin_} will always be
6632 treated as having the same meaning as the C library function even if you
6633 specify the @option{-fno-builtin} option.  (@pxref{C Dialect Options})
6634 Many of these functions are only optimized in certain cases; if they are
6635 not optimized in a particular case, a call to the library function will
6636 be emitted.
6638 @opindex ansi
6639 @opindex std
6640 Outside strict ISO C mode (@option{-ansi}, @option{-std=c89} or
6641 @option{-std=c99}), the functions
6642 @code{_exit}, @code{alloca}, @code{bcmp}, @code{bzero},
6643 @code{dcgettext}, @code{dgettext}, @code{dremf}, @code{dreml},
6644 @code{drem}, @code{exp10f}, @code{exp10l}, @code{exp10}, @code{ffsll},
6645 @code{ffsl}, @code{ffs}, @code{fprintf_unlocked},
6646 @code{fputs_unlocked}, @code{gammaf}, @code{gammal}, @code{gamma},
6647 @code{gammaf_r}, @code{gammal_r}, @code{gamma_r}, @code{gettext},
6648 @code{index}, @code{isascii}, @code{j0f}, @code{j0l}, @code{j0},
6649 @code{j1f}, @code{j1l}, @code{j1}, @code{jnf}, @code{jnl}, @code{jn},
6650 @code{lgammaf_r}, @code{lgammal_r}, @code{lgamma_r}, @code{mempcpy},
6651 @code{pow10f}, @code{pow10l}, @code{pow10}, @code{printf_unlocked},
6652 @code{rindex}, @code{scalbf}, @code{scalbl}, @code{scalb},
6653 @code{signbit}, @code{signbitf}, @code{signbitl}, @code{signbitd32},
6654 @code{signbitd64}, @code{signbitd128}, @code{significandf},
6655 @code{significandl}, @code{significand}, @code{sincosf},
6656 @code{sincosl}, @code{sincos}, @code{stpcpy}, @code{stpncpy},
6657 @code{strcasecmp}, @code{strdup}, @code{strfmon}, @code{strncasecmp},
6658 @code{strndup}, @code{toascii}, @code{y0f}, @code{y0l}, @code{y0},
6659 @code{y1f}, @code{y1l}, @code{y1}, @code{ynf}, @code{ynl} and
6660 @code{yn}
6661 may be handled as built-in functions.
6662 All these functions have corresponding versions
6663 prefixed with @code{__builtin_}, which may be used even in strict C89
6664 mode.
6666 The ISO C99 functions
6667 @code{_Exit}, @code{acoshf}, @code{acoshl}, @code{acosh}, @code{asinhf},
6668 @code{asinhl}, @code{asinh}, @code{atanhf}, @code{atanhl}, @code{atanh},
6669 @code{cabsf}, @code{cabsl}, @code{cabs}, @code{cacosf}, @code{cacoshf},
6670 @code{cacoshl}, @code{cacosh}, @code{cacosl}, @code{cacos},
6671 @code{cargf}, @code{cargl}, @code{carg}, @code{casinf}, @code{casinhf},
6672 @code{casinhl}, @code{casinh}, @code{casinl}, @code{casin},
6673 @code{catanf}, @code{catanhf}, @code{catanhl}, @code{catanh},
6674 @code{catanl}, @code{catan}, @code{cbrtf}, @code{cbrtl}, @code{cbrt},
6675 @code{ccosf}, @code{ccoshf}, @code{ccoshl}, @code{ccosh}, @code{ccosl},
6676 @code{ccos}, @code{cexpf}, @code{cexpl}, @code{cexp}, @code{cimagf},
6677 @code{cimagl}, @code{cimag}, @code{clogf}, @code{clogl}, @code{clog},
6678 @code{conjf}, @code{conjl}, @code{conj}, @code{copysignf}, @code{copysignl},
6679 @code{copysign}, @code{cpowf}, @code{cpowl}, @code{cpow}, @code{cprojf},
6680 @code{cprojl}, @code{cproj}, @code{crealf}, @code{creall}, @code{creal},
6681 @code{csinf}, @code{csinhf}, @code{csinhl}, @code{csinh}, @code{csinl},
6682 @code{csin}, @code{csqrtf}, @code{csqrtl}, @code{csqrt}, @code{ctanf},
6683 @code{ctanhf}, @code{ctanhl}, @code{ctanh}, @code{ctanl}, @code{ctan},
6684 @code{erfcf}, @code{erfcl}, @code{erfc}, @code{erff}, @code{erfl},
6685 @code{erf}, @code{exp2f}, @code{exp2l}, @code{exp2}, @code{expm1f},
6686 @code{expm1l}, @code{expm1}, @code{fdimf}, @code{fdiml}, @code{fdim},
6687 @code{fmaf}, @code{fmal}, @code{fmaxf}, @code{fmaxl}, @code{fmax},
6688 @code{fma}, @code{fminf}, @code{fminl}, @code{fmin}, @code{hypotf},
6689 @code{hypotl}, @code{hypot}, @code{ilogbf}, @code{ilogbl}, @code{ilogb},
6690 @code{imaxabs}, @code{isblank}, @code{iswblank}, @code{lgammaf},
6691 @code{lgammal}, @code{lgamma}, @code{llabs}, @code{llrintf}, @code{llrintl},
6692 @code{llrint}, @code{llroundf}, @code{llroundl}, @code{llround},
6693 @code{log1pf}, @code{log1pl}, @code{log1p}, @code{log2f}, @code{log2l},
6694 @code{log2}, @code{logbf}, @code{logbl}, @code{logb}, @code{lrintf},
6695 @code{lrintl}, @code{lrint}, @code{lroundf}, @code{lroundl},
6696 @code{lround}, @code{nearbyintf}, @code{nearbyintl}, @code{nearbyint},
6697 @code{nextafterf}, @code{nextafterl}, @code{nextafter},
6698 @code{nexttowardf}, @code{nexttowardl}, @code{nexttoward},
6699 @code{remainderf}, @code{remainderl}, @code{remainder}, @code{remquof},
6700 @code{remquol}, @code{remquo}, @code{rintf}, @code{rintl}, @code{rint},
6701 @code{roundf}, @code{roundl}, @code{round}, @code{scalblnf},
6702 @code{scalblnl}, @code{scalbln}, @code{scalbnf}, @code{scalbnl},
6703 @code{scalbn}, @code{snprintf}, @code{tgammaf}, @code{tgammal},
6704 @code{tgamma}, @code{truncf}, @code{truncl}, @code{trunc},
6705 @code{vfscanf}, @code{vscanf}, @code{vsnprintf} and @code{vsscanf}
6706 are handled as built-in functions
6707 except in strict ISO C90 mode (@option{-ansi} or @option{-std=c89}).
6709 There are also built-in versions of the ISO C99 functions
6710 @code{acosf}, @code{acosl}, @code{asinf}, @code{asinl}, @code{atan2f},
6711 @code{atan2l}, @code{atanf}, @code{atanl}, @code{ceilf}, @code{ceill},
6712 @code{cosf}, @code{coshf}, @code{coshl}, @code{cosl}, @code{expf},
6713 @code{expl}, @code{fabsf}, @code{fabsl}, @code{floorf}, @code{floorl},
6714 @code{fmodf}, @code{fmodl}, @code{frexpf}, @code{frexpl}, @code{ldexpf},
6715 @code{ldexpl}, @code{log10f}, @code{log10l}, @code{logf}, @code{logl},
6716 @code{modfl}, @code{modf}, @code{powf}, @code{powl}, @code{sinf},
6717 @code{sinhf}, @code{sinhl}, @code{sinl}, @code{sqrtf}, @code{sqrtl},
6718 @code{tanf}, @code{tanhf}, @code{tanhl} and @code{tanl}
6719 that are recognized in any mode since ISO C90 reserves these names for
6720 the purpose to which ISO C99 puts them.  All these functions have
6721 corresponding versions prefixed with @code{__builtin_}.
6723 The ISO C94 functions
6724 @code{iswalnum}, @code{iswalpha}, @code{iswcntrl}, @code{iswdigit},
6725 @code{iswgraph}, @code{iswlower}, @code{iswprint}, @code{iswpunct},
6726 @code{iswspace}, @code{iswupper}, @code{iswxdigit}, @code{towlower} and
6727 @code{towupper}
6728 are handled as built-in functions
6729 except in strict ISO C90 mode (@option{-ansi} or @option{-std=c89}).
6731 The ISO C90 functions
6732 @code{abort}, @code{abs}, @code{acos}, @code{asin}, @code{atan2},
6733 @code{atan}, @code{calloc}, @code{ceil}, @code{cosh}, @code{cos},
6734 @code{exit}, @code{exp}, @code{fabs}, @code{floor}, @code{fmod},
6735 @code{fprintf}, @code{fputs}, @code{frexp}, @code{fscanf},
6736 @code{isalnum}, @code{isalpha}, @code{iscntrl}, @code{isdigit},
6737 @code{isgraph}, @code{islower}, @code{isprint}, @code{ispunct},
6738 @code{isspace}, @code{isupper}, @code{isxdigit}, @code{tolower},
6739 @code{toupper}, @code{labs}, @code{ldexp}, @code{log10}, @code{log},
6740 @code{malloc}, @code{memchr}, @code{memcmp}, @code{memcpy},
6741 @code{memset}, @code{modf}, @code{pow}, @code{printf}, @code{putchar},
6742 @code{puts}, @code{scanf}, @code{sinh}, @code{sin}, @code{snprintf},
6743 @code{sprintf}, @code{sqrt}, @code{sscanf}, @code{strcat},
6744 @code{strchr}, @code{strcmp}, @code{strcpy}, @code{strcspn},
6745 @code{strlen}, @code{strncat}, @code{strncmp}, @code{strncpy},
6746 @code{strpbrk}, @code{strrchr}, @code{strspn}, @code{strstr},
6747 @code{tanh}, @code{tan}, @code{vfprintf}, @code{vprintf} and @code{vsprintf}
6748 are all recognized as built-in functions unless
6749 @option{-fno-builtin} is specified (or @option{-fno-builtin-@var{function}}
6750 is specified for an individual function).  All of these functions have
6751 corresponding versions prefixed with @code{__builtin_}.
6753 GCC provides built-in versions of the ISO C99 floating point comparison
6754 macros that avoid raising exceptions for unordered operands.  They have
6755 the same names as the standard macros ( @code{isgreater},
6756 @code{isgreaterequal}, @code{isless}, @code{islessequal},
6757 @code{islessgreater}, and @code{isunordered}) , with @code{__builtin_}
6758 prefixed.  We intend for a library implementor to be able to simply
6759 @code{#define} each standard macro to its built-in equivalent.
6760 In the same fashion, GCC provides @code{fpclassify}, @code{isfinite},
6761 @code{isinf_sign} and @code{isnormal} built-ins used with
6762 @code{__builtin_} prefixed.  The @code{isinf} and @code{isnan}
6763 builtins appear both with and without the @code{__builtin_} prefix.
6765 @deftypefn {Built-in Function} int __builtin_types_compatible_p (@var{type1}, @var{type2})
6767 You can use the built-in function @code{__builtin_types_compatible_p} to
6768 determine whether two types are the same.
6770 This built-in function returns 1 if the unqualified versions of the
6771 types @var{type1} and @var{type2} (which are types, not expressions) are
6772 compatible, 0 otherwise.  The result of this built-in function can be
6773 used in integer constant expressions.
6775 This built-in function ignores top level qualifiers (e.g., @code{const},
6776 @code{volatile}).  For example, @code{int} is equivalent to @code{const
6777 int}.
6779 The type @code{int[]} and @code{int[5]} are compatible.  On the other
6780 hand, @code{int} and @code{char *} are not compatible, even if the size
6781 of their types, on the particular architecture are the same.  Also, the
6782 amount of pointer indirection is taken into account when determining
6783 similarity.  Consequently, @code{short *} is not similar to
6784 @code{short **}.  Furthermore, two types that are typedefed are
6785 considered compatible if their underlying types are compatible.
6787 An @code{enum} type is not considered to be compatible with another
6788 @code{enum} type even if both are compatible with the same integer
6789 type; this is what the C standard specifies.
6790 For example, @code{enum @{foo, bar@}} is not similar to
6791 @code{enum @{hot, dog@}}.
6793 You would typically use this function in code whose execution varies
6794 depending on the arguments' types.  For example:
6796 @smallexample
6797 #define foo(x)                                                  \
6798   (@{                                                           \
6799     typeof (x) tmp = (x);                                       \
6800     if (__builtin_types_compatible_p (typeof (x), long double)) \
6801       tmp = foo_long_double (tmp);                              \
6802     else if (__builtin_types_compatible_p (typeof (x), double)) \
6803       tmp = foo_double (tmp);                                   \
6804     else if (__builtin_types_compatible_p (typeof (x), float))  \
6805       tmp = foo_float (tmp);                                    \
6806     else                                                        \
6807       abort ();                                                 \
6808     tmp;                                                        \
6809   @})
6810 @end smallexample
6812 @emph{Note:} This construct is only available for C@.
6814 @end deftypefn
6816 @deftypefn {Built-in Function} @var{type} __builtin_choose_expr (@var{const_exp}, @var{exp1}, @var{exp2})
6818 You can use the built-in function @code{__builtin_choose_expr} to
6819 evaluate code depending on the value of a constant expression.  This
6820 built-in function returns @var{exp1} if @var{const_exp}, which is an
6821 integer constant expression, is nonzero.  Otherwise it returns 0.
6823 This built-in function is analogous to the @samp{? :} operator in C,
6824 except that the expression returned has its type unaltered by promotion
6825 rules.  Also, the built-in function does not evaluate the expression
6826 that was not chosen.  For example, if @var{const_exp} evaluates to true,
6827 @var{exp2} is not evaluated even if it has side-effects.
6829 This built-in function can return an lvalue if the chosen argument is an
6830 lvalue.
6832 If @var{exp1} is returned, the return type is the same as @var{exp1}'s
6833 type.  Similarly, if @var{exp2} is returned, its return type is the same
6834 as @var{exp2}.
6836 Example:
6838 @smallexample
6839 #define foo(x)                                                    \
6840   __builtin_choose_expr (                                         \
6841     __builtin_types_compatible_p (typeof (x), double),            \
6842     foo_double (x),                                               \
6843     __builtin_choose_expr (                                       \
6844       __builtin_types_compatible_p (typeof (x), float),           \
6845       foo_float (x),                                              \
6846       /* @r{The void expression results in a compile-time error}  \
6847          @r{when assigning the result to something.}  */          \
6848       (void)0))
6849 @end smallexample
6851 @emph{Note:} This construct is only available for C@.  Furthermore, the
6852 unused expression (@var{exp1} or @var{exp2} depending on the value of
6853 @var{const_exp}) may still generate syntax errors.  This may change in
6854 future revisions.
6856 @end deftypefn
6858 @deftypefn {Built-in Function} int __builtin_constant_p (@var{exp})
6859 You can use the built-in function @code{__builtin_constant_p} to
6860 determine if a value is known to be constant at compile-time and hence
6861 that GCC can perform constant-folding on expressions involving that
6862 value.  The argument of the function is the value to test.  The function
6863 returns the integer 1 if the argument is known to be a compile-time
6864 constant and 0 if it is not known to be a compile-time constant.  A
6865 return of 0 does not indicate that the value is @emph{not} a constant,
6866 but merely that GCC cannot prove it is a constant with the specified
6867 value of the @option{-O} option.
6869 You would typically use this function in an embedded application where
6870 memory was a critical resource.  If you have some complex calculation,
6871 you may want it to be folded if it involves constants, but need to call
6872 a function if it does not.  For example:
6874 @smallexample
6875 #define Scale_Value(X)      \
6876   (__builtin_constant_p (X) \
6877   ? ((X) * SCALE + OFFSET) : Scale (X))
6878 @end smallexample
6880 You may use this built-in function in either a macro or an inline
6881 function.  However, if you use it in an inlined function and pass an
6882 argument of the function as the argument to the built-in, GCC will
6883 never return 1 when you call the inline function with a string constant
6884 or compound literal (@pxref{Compound Literals}) and will not return 1
6885 when you pass a constant numeric value to the inline function unless you
6886 specify the @option{-O} option.
6888 You may also use @code{__builtin_constant_p} in initializers for static
6889 data.  For instance, you can write
6891 @smallexample
6892 static const int table[] = @{
6893    __builtin_constant_p (EXPRESSION) ? (EXPRESSION) : -1,
6894    /* @r{@dots{}} */
6896 @end smallexample
6898 @noindent
6899 This is an acceptable initializer even if @var{EXPRESSION} is not a
6900 constant expression, including the case where
6901 @code{__builtin_constant_p} returns 1 because @var{EXPRESSION} can be
6902 folded to a constant but @var{EXPRESSION} contains operands that would
6903 not otherwise be permitted in a static initializer (for example,
6904 @code{0 && foo ()}).  GCC must be more conservative about evaluating the
6905 built-in in this case, because it has no opportunity to perform
6906 optimization.
6908 Previous versions of GCC did not accept this built-in in data
6909 initializers.  The earliest version where it is completely safe is
6910 3.0.1.
6911 @end deftypefn
6913 @deftypefn {Built-in Function} long __builtin_expect (long @var{exp}, long @var{c})
6914 @opindex fprofile-arcs
6915 You may use @code{__builtin_expect} to provide the compiler with
6916 branch prediction information.  In general, you should prefer to
6917 use actual profile feedback for this (@option{-fprofile-arcs}), as
6918 programmers are notoriously bad at predicting how their programs
6919 actually perform.  However, there are applications in which this
6920 data is hard to collect.
6922 The return value is the value of @var{exp}, which should be an integral
6923 expression.  The semantics of the built-in are that it is expected that
6924 @var{exp} == @var{c}.  For example:
6926 @smallexample
6927 if (__builtin_expect (x, 0))
6928   foo ();
6929 @end smallexample
6931 @noindent
6932 would indicate that we do not expect to call @code{foo}, since
6933 we expect @code{x} to be zero.  Since you are limited to integral
6934 expressions for @var{exp}, you should use constructions such as
6936 @smallexample
6937 if (__builtin_expect (ptr != NULL, 1))
6938   error ();
6939 @end smallexample
6941 @noindent
6942 when testing pointer or floating-point values.
6943 @end deftypefn
6945 @deftypefn {Built-in Function} void __builtin_trap (void)
6946 This function causes the program to exit abnormally.  GCC implements
6947 this function by using a target-dependent mechanism (such as
6948 intentionally executing an illegal instruction) or by calling
6949 @code{abort}.  The mechanism used may vary from release to release so
6950 you should not rely on any particular implementation.
6951 @end deftypefn
6953 @deftypefn {Built-in Function} void __builtin_unreachable (void)
6954 If control flow reaches the point of the @code{__builtin_unreachable},
6955 the program is undefined.  It is useful in situations where the
6956 compiler cannot deduce the unreachability of the code.
6958 One such case is immediately following an @code{asm} statement that
6959 will either never terminate, or one that transfers control elsewhere
6960 and never returns.  In this example, without the
6961 @code{__builtin_unreachable}, GCC would issue a warning that control
6962 reaches the end of a non-void function.  It would also generate code
6963 to return after the @code{asm}.
6965 @smallexample
6966 int f (int c, int v)
6968   if (c)
6969     @{
6970       return v;
6971     @}
6972   else
6973     @{
6974       asm("jmp error_handler");
6975       __builtin_unreachable ();
6976     @}
6978 @end smallexample
6980 Because the @code{asm} statement unconditionally transfers control out
6981 of the function, control will never reach the end of the function
6982 body.  The @code{__builtin_unreachable} is in fact unreachable and
6983 communicates this fact to the compiler.
6985 Another use for @code{__builtin_unreachable} is following a call a
6986 function that never returns but that is not declared
6987 @code{__attribute__((noreturn))}, as in this example:
6989 @smallexample
6990 void function_that_never_returns (void);
6992 int g (int c)
6994   if (c)
6995     @{
6996       return 1;
6997     @}
6998   else
6999     @{
7000       function_that_never_returns ();
7001       __builtin_unreachable ();
7002     @}
7004 @end smallexample
7006 @end deftypefn
7008 @deftypefn {Built-in Function} void __builtin___clear_cache (char *@var{begin}, char *@var{end})
7009 This function is used to flush the processor's instruction cache for
7010 the region of memory between @var{begin} inclusive and @var{end}
7011 exclusive.  Some targets require that the instruction cache be
7012 flushed, after modifying memory containing code, in order to obtain
7013 deterministic behavior.
7015 If the target does not require instruction cache flushes,
7016 @code{__builtin___clear_cache} has no effect.  Otherwise either
7017 instructions are emitted in-line to clear the instruction cache or a
7018 call to the @code{__clear_cache} function in libgcc is made.
7019 @end deftypefn
7021 @deftypefn {Built-in Function} void __builtin_prefetch (const void *@var{addr}, ...)
7022 This function is used to minimize cache-miss latency by moving data into
7023 a cache before it is accessed.
7024 You can insert calls to @code{__builtin_prefetch} into code for which
7025 you know addresses of data in memory that is likely to be accessed soon.
7026 If the target supports them, data prefetch instructions will be generated.
7027 If the prefetch is done early enough before the access then the data will
7028 be in the cache by the time it is accessed.
7030 The value of @var{addr} is the address of the memory to prefetch.
7031 There are two optional arguments, @var{rw} and @var{locality}.
7032 The value of @var{rw} is a compile-time constant one or zero; one
7033 means that the prefetch is preparing for a write to the memory address
7034 and zero, the default, means that the prefetch is preparing for a read.
7035 The value @var{locality} must be a compile-time constant integer between
7036 zero and three.  A value of zero means that the data has no temporal
7037 locality, so it need not be left in the cache after the access.  A value
7038 of three means that the data has a high degree of temporal locality and
7039 should be left in all levels of cache possible.  Values of one and two
7040 mean, respectively, a low or moderate degree of temporal locality.  The
7041 default is three.
7043 @smallexample
7044 for (i = 0; i < n; i++)
7045   @{
7046     a[i] = a[i] + b[i];
7047     __builtin_prefetch (&a[i+j], 1, 1);
7048     __builtin_prefetch (&b[i+j], 0, 1);
7049     /* @r{@dots{}} */
7050   @}
7051 @end smallexample
7053 Data prefetch does not generate faults if @var{addr} is invalid, but
7054 the address expression itself must be valid.  For example, a prefetch
7055 of @code{p->next} will not fault if @code{p->next} is not a valid
7056 address, but evaluation will fault if @code{p} is not a valid address.
7058 If the target does not support data prefetch, the address expression
7059 is evaluated if it includes side effects but no other code is generated
7060 and GCC does not issue a warning.
7061 @end deftypefn
7063 @deftypefn {Built-in Function} double __builtin_huge_val (void)
7064 Returns a positive infinity, if supported by the floating-point format,
7065 else @code{DBL_MAX}.  This function is suitable for implementing the
7066 ISO C macro @code{HUGE_VAL}.
7067 @end deftypefn
7069 @deftypefn {Built-in Function} float __builtin_huge_valf (void)
7070 Similar to @code{__builtin_huge_val}, except the return type is @code{float}.
7071 @end deftypefn
7073 @deftypefn {Built-in Function} {long double} __builtin_huge_vall (void)
7074 Similar to @code{__builtin_huge_val}, except the return
7075 type is @code{long double}.
7076 @end deftypefn
7078 @deftypefn {Built-in Function} int __builtin_fpclassify (int, int, int, int, int, ...)
7079 This built-in implements the C99 fpclassify functionality.  The first
7080 five int arguments should be the target library's notion of the
7081 possible FP classes and are used for return values.  They must be
7082 constant values and they must appear in this order: @code{FP_NAN},
7083 @code{FP_INFINITE}, @code{FP_NORMAL}, @code{FP_SUBNORMAL} and
7084 @code{FP_ZERO}.  The ellipsis is for exactly one floating point value
7085 to classify.  GCC treats the last argument as type-generic, which
7086 means it does not do default promotion from float to double.
7087 @end deftypefn
7089 @deftypefn {Built-in Function} double __builtin_inf (void)
7090 Similar to @code{__builtin_huge_val}, except a warning is generated
7091 if the target floating-point format does not support infinities.
7092 @end deftypefn
7094 @deftypefn {Built-in Function} _Decimal32 __builtin_infd32 (void)
7095 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal32}.
7096 @end deftypefn
7098 @deftypefn {Built-in Function} _Decimal64 __builtin_infd64 (void)
7099 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal64}.
7100 @end deftypefn
7102 @deftypefn {Built-in Function} _Decimal128 __builtin_infd128 (void)
7103 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal128}.
7104 @end deftypefn
7106 @deftypefn {Built-in Function} float __builtin_inff (void)
7107 Similar to @code{__builtin_inf}, except the return type is @code{float}.
7108 This function is suitable for implementing the ISO C99 macro @code{INFINITY}.
7109 @end deftypefn
7111 @deftypefn {Built-in Function} {long double} __builtin_infl (void)
7112 Similar to @code{__builtin_inf}, except the return
7113 type is @code{long double}.
7114 @end deftypefn
7116 @deftypefn {Built-in Function} int __builtin_isinf_sign (...)
7117 Similar to @code{isinf}, except the return value will be negative for
7118 an argument of @code{-Inf}.  Note while the parameter list is an
7119 ellipsis, this function only accepts exactly one floating point
7120 argument.  GCC treats this parameter as type-generic, which means it
7121 does not do default promotion from float to double.
7122 @end deftypefn
7124 @deftypefn {Built-in Function} double __builtin_nan (const char *str)
7125 This is an implementation of the ISO C99 function @code{nan}.
7127 Since ISO C99 defines this function in terms of @code{strtod}, which we
7128 do not implement, a description of the parsing is in order.  The string
7129 is parsed as by @code{strtol}; that is, the base is recognized by
7130 leading @samp{0} or @samp{0x} prefixes.  The number parsed is placed
7131 in the significand such that the least significant bit of the number
7132 is at the least significant bit of the significand.  The number is
7133 truncated to fit the significand field provided.  The significand is
7134 forced to be a quiet NaN@.
7136 This function, if given a string literal all of which would have been
7137 consumed by strtol, is evaluated early enough that it is considered a
7138 compile-time constant.
7139 @end deftypefn
7141 @deftypefn {Built-in Function} _Decimal32 __builtin_nand32 (const char *str)
7142 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal32}.
7143 @end deftypefn
7145 @deftypefn {Built-in Function} _Decimal64 __builtin_nand64 (const char *str)
7146 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal64}.
7147 @end deftypefn
7149 @deftypefn {Built-in Function} _Decimal128 __builtin_nand128 (const char *str)
7150 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal128}.
7151 @end deftypefn
7153 @deftypefn {Built-in Function} float __builtin_nanf (const char *str)
7154 Similar to @code{__builtin_nan}, except the return type is @code{float}.
7155 @end deftypefn
7157 @deftypefn {Built-in Function} {long double} __builtin_nanl (const char *str)
7158 Similar to @code{__builtin_nan}, except the return type is @code{long double}.
7159 @end deftypefn
7161 @deftypefn {Built-in Function} double __builtin_nans (const char *str)
7162 Similar to @code{__builtin_nan}, except the significand is forced
7163 to be a signaling NaN@.  The @code{nans} function is proposed by
7164 @uref{http://www.open-std.org/jtc1/sc22/wg14/www/docs/n965.htm,,WG14 N965}.
7165 @end deftypefn
7167 @deftypefn {Built-in Function} float __builtin_nansf (const char *str)
7168 Similar to @code{__builtin_nans}, except the return type is @code{float}.
7169 @end deftypefn
7171 @deftypefn {Built-in Function} {long double} __builtin_nansl (const char *str)
7172 Similar to @code{__builtin_nans}, except the return type is @code{long double}.
7173 @end deftypefn
7175 @deftypefn {Built-in Function} int __builtin_ffs (unsigned int x)
7176 Returns one plus the index of the least significant 1-bit of @var{x}, or
7177 if @var{x} is zero, returns zero.
7178 @end deftypefn
7180 @deftypefn {Built-in Function} int __builtin_clz (unsigned int x)
7181 Returns the number of leading 0-bits in @var{x}, starting at the most
7182 significant bit position.  If @var{x} is 0, the result is undefined.
7183 @end deftypefn
7185 @deftypefn {Built-in Function} int __builtin_ctz (unsigned int x)
7186 Returns the number of trailing 0-bits in @var{x}, starting at the least
7187 significant bit position.  If @var{x} is 0, the result is undefined.
7188 @end deftypefn
7190 @deftypefn {Built-in Function} int __builtin_popcount (unsigned int x)
7191 Returns the number of 1-bits in @var{x}.
7192 @end deftypefn
7194 @deftypefn {Built-in Function} int __builtin_parity (unsigned int x)
7195 Returns the parity of @var{x}, i.e.@: the number of 1-bits in @var{x}
7196 modulo 2.
7197 @end deftypefn
7199 @deftypefn {Built-in Function} int __builtin_ffsl (unsigned long)
7200 Similar to @code{__builtin_ffs}, except the argument type is
7201 @code{unsigned long}.
7202 @end deftypefn
7204 @deftypefn {Built-in Function} int __builtin_clzl (unsigned long)
7205 Similar to @code{__builtin_clz}, except the argument type is
7206 @code{unsigned long}.
7207 @end deftypefn
7209 @deftypefn {Built-in Function} int __builtin_ctzl (unsigned long)
7210 Similar to @code{__builtin_ctz}, except the argument type is
7211 @code{unsigned long}.
7212 @end deftypefn
7214 @deftypefn {Built-in Function} int __builtin_popcountl (unsigned long)
7215 Similar to @code{__builtin_popcount}, except the argument type is
7216 @code{unsigned long}.
7217 @end deftypefn
7219 @deftypefn {Built-in Function} int __builtin_parityl (unsigned long)
7220 Similar to @code{__builtin_parity}, except the argument type is
7221 @code{unsigned long}.
7222 @end deftypefn
7224 @deftypefn {Built-in Function} int __builtin_ffsll (unsigned long long)
7225 Similar to @code{__builtin_ffs}, except the argument type is
7226 @code{unsigned long long}.
7227 @end deftypefn
7229 @deftypefn {Built-in Function} int __builtin_clzll (unsigned long long)
7230 Similar to @code{__builtin_clz}, except the argument type is
7231 @code{unsigned long long}.
7232 @end deftypefn
7234 @deftypefn {Built-in Function} int __builtin_ctzll (unsigned long long)
7235 Similar to @code{__builtin_ctz}, except the argument type is
7236 @code{unsigned long long}.
7237 @end deftypefn
7239 @deftypefn {Built-in Function} int __builtin_popcountll (unsigned long long)
7240 Similar to @code{__builtin_popcount}, except the argument type is
7241 @code{unsigned long long}.
7242 @end deftypefn
7244 @deftypefn {Built-in Function} int __builtin_parityll (unsigned long long)
7245 Similar to @code{__builtin_parity}, except the argument type is
7246 @code{unsigned long long}.
7247 @end deftypefn
7249 @deftypefn {Built-in Function} double __builtin_powi (double, int)
7250 Returns the first argument raised to the power of the second.  Unlike the
7251 @code{pow} function no guarantees about precision and rounding are made.
7252 @end deftypefn
7254 @deftypefn {Built-in Function} float __builtin_powif (float, int)
7255 Similar to @code{__builtin_powi}, except the argument and return types
7256 are @code{float}.
7257 @end deftypefn
7259 @deftypefn {Built-in Function} {long double} __builtin_powil (long double, int)
7260 Similar to @code{__builtin_powi}, except the argument and return types
7261 are @code{long double}.
7262 @end deftypefn
7264 @deftypefn {Built-in Function} int32_t __builtin_bswap32 (int32_t x)
7265 Returns @var{x} with the order of the bytes reversed; for example,
7266 @code{0xaabbccdd} becomes @code{0xddccbbaa}.  Byte here always means
7267 exactly 8 bits.
7268 @end deftypefn
7270 @deftypefn {Built-in Function} int64_t __builtin_bswap64 (int64_t x)
7271 Similar to @code{__builtin_bswap32}, except the argument and return types
7272 are 64-bit.
7273 @end deftypefn
7275 @node Target Builtins
7276 @section Built-in Functions Specific to Particular Target Machines
7278 On some target machines, GCC supports many built-in functions specific
7279 to those machines.  Generally these generate calls to specific machine
7280 instructions, but allow the compiler to schedule those calls.
7282 @menu
7283 * Alpha Built-in Functions::
7284 * ARM iWMMXt Built-in Functions::
7285 * ARM NEON Intrinsics::
7286 * Blackfin Built-in Functions::
7287 * FR-V Built-in Functions::
7288 * X86 Built-in Functions::
7289 * MIPS DSP Built-in Functions::
7290 * MIPS Paired-Single Support::
7291 * MIPS Loongson Built-in Functions::
7292 * Other MIPS Built-in Functions::
7293 * picoChip Built-in Functions::
7294 * PowerPC AltiVec Built-in Functions::
7295 * SPARC VIS Built-in Functions::
7296 * SPU Built-in Functions::
7297 @end menu
7299 @node Alpha Built-in Functions
7300 @subsection Alpha Built-in Functions
7302 These built-in functions are available for the Alpha family of
7303 processors, depending on the command-line switches used.
7305 The following built-in functions are always available.  They
7306 all generate the machine instruction that is part of the name.
7308 @smallexample
7309 long __builtin_alpha_implver (void)
7310 long __builtin_alpha_rpcc (void)
7311 long __builtin_alpha_amask (long)
7312 long __builtin_alpha_cmpbge (long, long)
7313 long __builtin_alpha_extbl (long, long)
7314 long __builtin_alpha_extwl (long, long)
7315 long __builtin_alpha_extll (long, long)
7316 long __builtin_alpha_extql (long, long)
7317 long __builtin_alpha_extwh (long, long)
7318 long __builtin_alpha_extlh (long, long)
7319 long __builtin_alpha_extqh (long, long)
7320 long __builtin_alpha_insbl (long, long)
7321 long __builtin_alpha_inswl (long, long)
7322 long __builtin_alpha_insll (long, long)
7323 long __builtin_alpha_insql (long, long)
7324 long __builtin_alpha_inswh (long, long)
7325 long __builtin_alpha_inslh (long, long)
7326 long __builtin_alpha_insqh (long, long)
7327 long __builtin_alpha_mskbl (long, long)
7328 long __builtin_alpha_mskwl (long, long)
7329 long __builtin_alpha_mskll (long, long)
7330 long __builtin_alpha_mskql (long, long)
7331 long __builtin_alpha_mskwh (long, long)
7332 long __builtin_alpha_msklh (long, long)
7333 long __builtin_alpha_mskqh (long, long)
7334 long __builtin_alpha_umulh (long, long)
7335 long __builtin_alpha_zap (long, long)
7336 long __builtin_alpha_zapnot (long, long)
7337 @end smallexample
7339 The following built-in functions are always with @option{-mmax}
7340 or @option{-mcpu=@var{cpu}} where @var{cpu} is @code{pca56} or
7341 later.  They all generate the machine instruction that is part
7342 of the name.
7344 @smallexample
7345 long __builtin_alpha_pklb (long)
7346 long __builtin_alpha_pkwb (long)
7347 long __builtin_alpha_unpkbl (long)
7348 long __builtin_alpha_unpkbw (long)
7349 long __builtin_alpha_minub8 (long, long)
7350 long __builtin_alpha_minsb8 (long, long)
7351 long __builtin_alpha_minuw4 (long, long)
7352 long __builtin_alpha_minsw4 (long, long)
7353 long __builtin_alpha_maxub8 (long, long)
7354 long __builtin_alpha_maxsb8 (long, long)
7355 long __builtin_alpha_maxuw4 (long, long)
7356 long __builtin_alpha_maxsw4 (long, long)
7357 long __builtin_alpha_perr (long, long)
7358 @end smallexample
7360 The following built-in functions are always with @option{-mcix}
7361 or @option{-mcpu=@var{cpu}} where @var{cpu} is @code{ev67} or
7362 later.  They all generate the machine instruction that is part
7363 of the name.
7365 @smallexample
7366 long __builtin_alpha_cttz (long)
7367 long __builtin_alpha_ctlz (long)
7368 long __builtin_alpha_ctpop (long)
7369 @end smallexample
7371 The following builtins are available on systems that use the OSF/1
7372 PALcode.  Normally they invoke the @code{rduniq} and @code{wruniq}
7373 PAL calls, but when invoked with @option{-mtls-kernel}, they invoke
7374 @code{rdval} and @code{wrval}.
7376 @smallexample
7377 void *__builtin_thread_pointer (void)
7378 void __builtin_set_thread_pointer (void *)
7379 @end smallexample
7381 @node ARM iWMMXt Built-in Functions
7382 @subsection ARM iWMMXt Built-in Functions
7384 These built-in functions are available for the ARM family of
7385 processors when the @option{-mcpu=iwmmxt} switch is used:
7387 @smallexample
7388 typedef int v2si __attribute__ ((vector_size (8)));
7389 typedef short v4hi __attribute__ ((vector_size (8)));
7390 typedef char v8qi __attribute__ ((vector_size (8)));
7392 int __builtin_arm_getwcx (int)
7393 void __builtin_arm_setwcx (int, int)
7394 int __builtin_arm_textrmsb (v8qi, int)
7395 int __builtin_arm_textrmsh (v4hi, int)
7396 int __builtin_arm_textrmsw (v2si, int)
7397 int __builtin_arm_textrmub (v8qi, int)
7398 int __builtin_arm_textrmuh (v4hi, int)
7399 int __builtin_arm_textrmuw (v2si, int)
7400 v8qi __builtin_arm_tinsrb (v8qi, int)
7401 v4hi __builtin_arm_tinsrh (v4hi, int)
7402 v2si __builtin_arm_tinsrw (v2si, int)
7403 long long __builtin_arm_tmia (long long, int, int)
7404 long long __builtin_arm_tmiabb (long long, int, int)
7405 long long __builtin_arm_tmiabt (long long, int, int)
7406 long long __builtin_arm_tmiaph (long long, int, int)
7407 long long __builtin_arm_tmiatb (long long, int, int)
7408 long long __builtin_arm_tmiatt (long long, int, int)
7409 int __builtin_arm_tmovmskb (v8qi)
7410 int __builtin_arm_tmovmskh (v4hi)
7411 int __builtin_arm_tmovmskw (v2si)
7412 long long __builtin_arm_waccb (v8qi)
7413 long long __builtin_arm_wacch (v4hi)
7414 long long __builtin_arm_waccw (v2si)
7415 v8qi __builtin_arm_waddb (v8qi, v8qi)
7416 v8qi __builtin_arm_waddbss (v8qi, v8qi)
7417 v8qi __builtin_arm_waddbus (v8qi, v8qi)
7418 v4hi __builtin_arm_waddh (v4hi, v4hi)
7419 v4hi __builtin_arm_waddhss (v4hi, v4hi)
7420 v4hi __builtin_arm_waddhus (v4hi, v4hi)
7421 v2si __builtin_arm_waddw (v2si, v2si)
7422 v2si __builtin_arm_waddwss (v2si, v2si)
7423 v2si __builtin_arm_waddwus (v2si, v2si)
7424 v8qi __builtin_arm_walign (v8qi, v8qi, int)
7425 long long __builtin_arm_wand(long long, long long)
7426 long long __builtin_arm_wandn (long long, long long)
7427 v8qi __builtin_arm_wavg2b (v8qi, v8qi)
7428 v8qi __builtin_arm_wavg2br (v8qi, v8qi)
7429 v4hi __builtin_arm_wavg2h (v4hi, v4hi)
7430 v4hi __builtin_arm_wavg2hr (v4hi, v4hi)
7431 v8qi __builtin_arm_wcmpeqb (v8qi, v8qi)
7432 v4hi __builtin_arm_wcmpeqh (v4hi, v4hi)
7433 v2si __builtin_arm_wcmpeqw (v2si, v2si)
7434 v8qi __builtin_arm_wcmpgtsb (v8qi, v8qi)
7435 v4hi __builtin_arm_wcmpgtsh (v4hi, v4hi)
7436 v2si __builtin_arm_wcmpgtsw (v2si, v2si)
7437 v8qi __builtin_arm_wcmpgtub (v8qi, v8qi)
7438 v4hi __builtin_arm_wcmpgtuh (v4hi, v4hi)
7439 v2si __builtin_arm_wcmpgtuw (v2si, v2si)
7440 long long __builtin_arm_wmacs (long long, v4hi, v4hi)
7441 long long __builtin_arm_wmacsz (v4hi, v4hi)
7442 long long __builtin_arm_wmacu (long long, v4hi, v4hi)
7443 long long __builtin_arm_wmacuz (v4hi, v4hi)
7444 v4hi __builtin_arm_wmadds (v4hi, v4hi)
7445 v4hi __builtin_arm_wmaddu (v4hi, v4hi)
7446 v8qi __builtin_arm_wmaxsb (v8qi, v8qi)
7447 v4hi __builtin_arm_wmaxsh (v4hi, v4hi)
7448 v2si __builtin_arm_wmaxsw (v2si, v2si)
7449 v8qi __builtin_arm_wmaxub (v8qi, v8qi)
7450 v4hi __builtin_arm_wmaxuh (v4hi, v4hi)
7451 v2si __builtin_arm_wmaxuw (v2si, v2si)
7452 v8qi __builtin_arm_wminsb (v8qi, v8qi)
7453 v4hi __builtin_arm_wminsh (v4hi, v4hi)
7454 v2si __builtin_arm_wminsw (v2si, v2si)
7455 v8qi __builtin_arm_wminub (v8qi, v8qi)
7456 v4hi __builtin_arm_wminuh (v4hi, v4hi)
7457 v2si __builtin_arm_wminuw (v2si, v2si)
7458 v4hi __builtin_arm_wmulsm (v4hi, v4hi)
7459 v4hi __builtin_arm_wmulul (v4hi, v4hi)
7460 v4hi __builtin_arm_wmulum (v4hi, v4hi)
7461 long long __builtin_arm_wor (long long, long long)
7462 v2si __builtin_arm_wpackdss (long long, long long)
7463 v2si __builtin_arm_wpackdus (long long, long long)
7464 v8qi __builtin_arm_wpackhss (v4hi, v4hi)
7465 v8qi __builtin_arm_wpackhus (v4hi, v4hi)
7466 v4hi __builtin_arm_wpackwss (v2si, v2si)
7467 v4hi __builtin_arm_wpackwus (v2si, v2si)
7468 long long __builtin_arm_wrord (long long, long long)
7469 long long __builtin_arm_wrordi (long long, int)
7470 v4hi __builtin_arm_wrorh (v4hi, long long)
7471 v4hi __builtin_arm_wrorhi (v4hi, int)
7472 v2si __builtin_arm_wrorw (v2si, long long)
7473 v2si __builtin_arm_wrorwi (v2si, int)
7474 v2si __builtin_arm_wsadb (v8qi, v8qi)
7475 v2si __builtin_arm_wsadbz (v8qi, v8qi)
7476 v2si __builtin_arm_wsadh (v4hi, v4hi)
7477 v2si __builtin_arm_wsadhz (v4hi, v4hi)
7478 v4hi __builtin_arm_wshufh (v4hi, int)
7479 long long __builtin_arm_wslld (long long, long long)
7480 long long __builtin_arm_wslldi (long long, int)
7481 v4hi __builtin_arm_wsllh (v4hi, long long)
7482 v4hi __builtin_arm_wsllhi (v4hi, int)
7483 v2si __builtin_arm_wsllw (v2si, long long)
7484 v2si __builtin_arm_wsllwi (v2si, int)
7485 long long __builtin_arm_wsrad (long long, long long)
7486 long long __builtin_arm_wsradi (long long, int)
7487 v4hi __builtin_arm_wsrah (v4hi, long long)
7488 v4hi __builtin_arm_wsrahi (v4hi, int)
7489 v2si __builtin_arm_wsraw (v2si, long long)
7490 v2si __builtin_arm_wsrawi (v2si, int)
7491 long long __builtin_arm_wsrld (long long, long long)
7492 long long __builtin_arm_wsrldi (long long, int)
7493 v4hi __builtin_arm_wsrlh (v4hi, long long)
7494 v4hi __builtin_arm_wsrlhi (v4hi, int)
7495 v2si __builtin_arm_wsrlw (v2si, long long)
7496 v2si __builtin_arm_wsrlwi (v2si, int)
7497 v8qi __builtin_arm_wsubb (v8qi, v8qi)
7498 v8qi __builtin_arm_wsubbss (v8qi, v8qi)
7499 v8qi __builtin_arm_wsubbus (v8qi, v8qi)
7500 v4hi __builtin_arm_wsubh (v4hi, v4hi)
7501 v4hi __builtin_arm_wsubhss (v4hi, v4hi)
7502 v4hi __builtin_arm_wsubhus (v4hi, v4hi)
7503 v2si __builtin_arm_wsubw (v2si, v2si)
7504 v2si __builtin_arm_wsubwss (v2si, v2si)
7505 v2si __builtin_arm_wsubwus (v2si, v2si)
7506 v4hi __builtin_arm_wunpckehsb (v8qi)
7507 v2si __builtin_arm_wunpckehsh (v4hi)
7508 long long __builtin_arm_wunpckehsw (v2si)
7509 v4hi __builtin_arm_wunpckehub (v8qi)
7510 v2si __builtin_arm_wunpckehuh (v4hi)
7511 long long __builtin_arm_wunpckehuw (v2si)
7512 v4hi __builtin_arm_wunpckelsb (v8qi)
7513 v2si __builtin_arm_wunpckelsh (v4hi)
7514 long long __builtin_arm_wunpckelsw (v2si)
7515 v4hi __builtin_arm_wunpckelub (v8qi)
7516 v2si __builtin_arm_wunpckeluh (v4hi)
7517 long long __builtin_arm_wunpckeluw (v2si)
7518 v8qi __builtin_arm_wunpckihb (v8qi, v8qi)
7519 v4hi __builtin_arm_wunpckihh (v4hi, v4hi)
7520 v2si __builtin_arm_wunpckihw (v2si, v2si)
7521 v8qi __builtin_arm_wunpckilb (v8qi, v8qi)
7522 v4hi __builtin_arm_wunpckilh (v4hi, v4hi)
7523 v2si __builtin_arm_wunpckilw (v2si, v2si)
7524 long long __builtin_arm_wxor (long long, long long)
7525 long long __builtin_arm_wzero ()
7526 @end smallexample
7528 @node ARM NEON Intrinsics
7529 @subsection ARM NEON Intrinsics
7531 These built-in intrinsics for the ARM Advanced SIMD extension are available
7532 when the @option{-mfpu=neon} switch is used:
7534 @include arm-neon-intrinsics.texi
7536 @node Blackfin Built-in Functions
7537 @subsection Blackfin Built-in Functions
7539 Currently, there are two Blackfin-specific built-in functions.  These are
7540 used for generating @code{CSYNC} and @code{SSYNC} machine insns without
7541 using inline assembly; by using these built-in functions the compiler can
7542 automatically add workarounds for hardware errata involving these
7543 instructions.  These functions are named as follows:
7545 @smallexample
7546 void __builtin_bfin_csync (void)
7547 void __builtin_bfin_ssync (void)
7548 @end smallexample
7550 @node FR-V Built-in Functions
7551 @subsection FR-V Built-in Functions
7553 GCC provides many FR-V-specific built-in functions.  In general,
7554 these functions are intended to be compatible with those described
7555 by @cite{FR-V Family, Softune C/C++ Compiler Manual (V6), Fujitsu
7556 Semiconductor}.  The two exceptions are @code{__MDUNPACKH} and
7557 @code{__MBTOHE}, the gcc forms of which pass 128-bit values by
7558 pointer rather than by value.
7560 Most of the functions are named after specific FR-V instructions.
7561 Such functions are said to be ``directly mapped'' and are summarized
7562 here in tabular form.
7564 @menu
7565 * Argument Types::
7566 * Directly-mapped Integer Functions::
7567 * Directly-mapped Media Functions::
7568 * Raw read/write Functions::
7569 * Other Built-in Functions::
7570 @end menu
7572 @node Argument Types
7573 @subsubsection Argument Types
7575 The arguments to the built-in functions can be divided into three groups:
7576 register numbers, compile-time constants and run-time values.  In order
7577 to make this classification clear at a glance, the arguments and return
7578 values are given the following pseudo types:
7580 @multitable @columnfractions .20 .30 .15 .35
7581 @item Pseudo type @tab Real C type @tab Constant? @tab Description
7582 @item @code{uh} @tab @code{unsigned short} @tab No @tab an unsigned halfword
7583 @item @code{uw1} @tab @code{unsigned int} @tab No @tab an unsigned word
7584 @item @code{sw1} @tab @code{int} @tab No @tab a signed word
7585 @item @code{uw2} @tab @code{unsigned long long} @tab No
7586 @tab an unsigned doubleword
7587 @item @code{sw2} @tab @code{long long} @tab No @tab a signed doubleword
7588 @item @code{const} @tab @code{int} @tab Yes @tab an integer constant
7589 @item @code{acc} @tab @code{int} @tab Yes @tab an ACC register number
7590 @item @code{iacc} @tab @code{int} @tab Yes @tab an IACC register number
7591 @end multitable
7593 These pseudo types are not defined by GCC, they are simply a notational
7594 convenience used in this manual.
7596 Arguments of type @code{uh}, @code{uw1}, @code{sw1}, @code{uw2}
7597 and @code{sw2} are evaluated at run time.  They correspond to
7598 register operands in the underlying FR-V instructions.
7600 @code{const} arguments represent immediate operands in the underlying
7601 FR-V instructions.  They must be compile-time constants.
7603 @code{acc} arguments are evaluated at compile time and specify the number
7604 of an accumulator register.  For example, an @code{acc} argument of 2
7605 will select the ACC2 register.
7607 @code{iacc} arguments are similar to @code{acc} arguments but specify the
7608 number of an IACC register.  See @pxref{Other Built-in Functions}
7609 for more details.
7611 @node Directly-mapped Integer Functions
7612 @subsubsection Directly-mapped Integer Functions
7614 The functions listed below map directly to FR-V I-type instructions.
7616 @multitable @columnfractions .45 .32 .23
7617 @item Function prototype @tab Example usage @tab Assembly output
7618 @item @code{sw1 __ADDSS (sw1, sw1)}
7619 @tab @code{@var{c} = __ADDSS (@var{a}, @var{b})}
7620 @tab @code{ADDSS @var{a},@var{b},@var{c}}
7621 @item @code{sw1 __SCAN (sw1, sw1)}
7622 @tab @code{@var{c} = __SCAN (@var{a}, @var{b})}
7623 @tab @code{SCAN @var{a},@var{b},@var{c}}
7624 @item @code{sw1 __SCUTSS (sw1)}
7625 @tab @code{@var{b} = __SCUTSS (@var{a})}
7626 @tab @code{SCUTSS @var{a},@var{b}}
7627 @item @code{sw1 __SLASS (sw1, sw1)}
7628 @tab @code{@var{c} = __SLASS (@var{a}, @var{b})}
7629 @tab @code{SLASS @var{a},@var{b},@var{c}}
7630 @item @code{void __SMASS (sw1, sw1)}
7631 @tab @code{__SMASS (@var{a}, @var{b})}
7632 @tab @code{SMASS @var{a},@var{b}}
7633 @item @code{void __SMSSS (sw1, sw1)}
7634 @tab @code{__SMSSS (@var{a}, @var{b})}
7635 @tab @code{SMSSS @var{a},@var{b}}
7636 @item @code{void __SMU (sw1, sw1)}
7637 @tab @code{__SMU (@var{a}, @var{b})}
7638 @tab @code{SMU @var{a},@var{b}}
7639 @item @code{sw2 __SMUL (sw1, sw1)}
7640 @tab @code{@var{c} = __SMUL (@var{a}, @var{b})}
7641 @tab @code{SMUL @var{a},@var{b},@var{c}}
7642 @item @code{sw1 __SUBSS (sw1, sw1)}
7643 @tab @code{@var{c} = __SUBSS (@var{a}, @var{b})}
7644 @tab @code{SUBSS @var{a},@var{b},@var{c}}
7645 @item @code{uw2 __UMUL (uw1, uw1)}
7646 @tab @code{@var{c} = __UMUL (@var{a}, @var{b})}
7647 @tab @code{UMUL @var{a},@var{b},@var{c}}
7648 @end multitable
7650 @node Directly-mapped Media Functions
7651 @subsubsection Directly-mapped Media Functions
7653 The functions listed below map directly to FR-V M-type instructions.
7655 @multitable @columnfractions .45 .32 .23
7656 @item Function prototype @tab Example usage @tab Assembly output
7657 @item @code{uw1 __MABSHS (sw1)}
7658 @tab @code{@var{b} = __MABSHS (@var{a})}
7659 @tab @code{MABSHS @var{a},@var{b}}
7660 @item @code{void __MADDACCS (acc, acc)}
7661 @tab @code{__MADDACCS (@var{b}, @var{a})}
7662 @tab @code{MADDACCS @var{a},@var{b}}
7663 @item @code{sw1 __MADDHSS (sw1, sw1)}
7664 @tab @code{@var{c} = __MADDHSS (@var{a}, @var{b})}
7665 @tab @code{MADDHSS @var{a},@var{b},@var{c}}
7666 @item @code{uw1 __MADDHUS (uw1, uw1)}
7667 @tab @code{@var{c} = __MADDHUS (@var{a}, @var{b})}
7668 @tab @code{MADDHUS @var{a},@var{b},@var{c}}
7669 @item @code{uw1 __MAND (uw1, uw1)}
7670 @tab @code{@var{c} = __MAND (@var{a}, @var{b})}
7671 @tab @code{MAND @var{a},@var{b},@var{c}}
7672 @item @code{void __MASACCS (acc, acc)}
7673 @tab @code{__MASACCS (@var{b}, @var{a})}
7674 @tab @code{MASACCS @var{a},@var{b}}
7675 @item @code{uw1 __MAVEH (uw1, uw1)}
7676 @tab @code{@var{c} = __MAVEH (@var{a}, @var{b})}
7677 @tab @code{MAVEH @var{a},@var{b},@var{c}}
7678 @item @code{uw2 __MBTOH (uw1)}
7679 @tab @code{@var{b} = __MBTOH (@var{a})}
7680 @tab @code{MBTOH @var{a},@var{b}}
7681 @item @code{void __MBTOHE (uw1 *, uw1)}
7682 @tab @code{__MBTOHE (&@var{b}, @var{a})}
7683 @tab @code{MBTOHE @var{a},@var{b}}
7684 @item @code{void __MCLRACC (acc)}
7685 @tab @code{__MCLRACC (@var{a})}
7686 @tab @code{MCLRACC @var{a}}
7687 @item @code{void __MCLRACCA (void)}
7688 @tab @code{__MCLRACCA ()}
7689 @tab @code{MCLRACCA}
7690 @item @code{uw1 __Mcop1 (uw1, uw1)}
7691 @tab @code{@var{c} = __Mcop1 (@var{a}, @var{b})}
7692 @tab @code{Mcop1 @var{a},@var{b},@var{c}}
7693 @item @code{uw1 __Mcop2 (uw1, uw1)}
7694 @tab @code{@var{c} = __Mcop2 (@var{a}, @var{b})}
7695 @tab @code{Mcop2 @var{a},@var{b},@var{c}}
7696 @item @code{uw1 __MCPLHI (uw2, const)}
7697 @tab @code{@var{c} = __MCPLHI (@var{a}, @var{b})}
7698 @tab @code{MCPLHI @var{a},#@var{b},@var{c}}
7699 @item @code{uw1 __MCPLI (uw2, const)}
7700 @tab @code{@var{c} = __MCPLI (@var{a}, @var{b})}
7701 @tab @code{MCPLI @var{a},#@var{b},@var{c}}
7702 @item @code{void __MCPXIS (acc, sw1, sw1)}
7703 @tab @code{__MCPXIS (@var{c}, @var{a}, @var{b})}
7704 @tab @code{MCPXIS @var{a},@var{b},@var{c}}
7705 @item @code{void __MCPXIU (acc, uw1, uw1)}
7706 @tab @code{__MCPXIU (@var{c}, @var{a}, @var{b})}
7707 @tab @code{MCPXIU @var{a},@var{b},@var{c}}
7708 @item @code{void __MCPXRS (acc, sw1, sw1)}
7709 @tab @code{__MCPXRS (@var{c}, @var{a}, @var{b})}
7710 @tab @code{MCPXRS @var{a},@var{b},@var{c}}
7711 @item @code{void __MCPXRU (acc, uw1, uw1)}
7712 @tab @code{__MCPXRU (@var{c}, @var{a}, @var{b})}
7713 @tab @code{MCPXRU @var{a},@var{b},@var{c}}
7714 @item @code{uw1 __MCUT (acc, uw1)}
7715 @tab @code{@var{c} = __MCUT (@var{a}, @var{b})}
7716 @tab @code{MCUT @var{a},@var{b},@var{c}}
7717 @item @code{uw1 __MCUTSS (acc, sw1)}
7718 @tab @code{@var{c} = __MCUTSS (@var{a}, @var{b})}
7719 @tab @code{MCUTSS @var{a},@var{b},@var{c}}
7720 @item @code{void __MDADDACCS (acc, acc)}
7721 @tab @code{__MDADDACCS (@var{b}, @var{a})}
7722 @tab @code{MDADDACCS @var{a},@var{b}}
7723 @item @code{void __MDASACCS (acc, acc)}
7724 @tab @code{__MDASACCS (@var{b}, @var{a})}
7725 @tab @code{MDASACCS @var{a},@var{b}}
7726 @item @code{uw2 __MDCUTSSI (acc, const)}
7727 @tab @code{@var{c} = __MDCUTSSI (@var{a}, @var{b})}
7728 @tab @code{MDCUTSSI @var{a},#@var{b},@var{c}}
7729 @item @code{uw2 __MDPACKH (uw2, uw2)}
7730 @tab @code{@var{c} = __MDPACKH (@var{a}, @var{b})}
7731 @tab @code{MDPACKH @var{a},@var{b},@var{c}}
7732 @item @code{uw2 __MDROTLI (uw2, const)}
7733 @tab @code{@var{c} = __MDROTLI (@var{a}, @var{b})}
7734 @tab @code{MDROTLI @var{a},#@var{b},@var{c}}
7735 @item @code{void __MDSUBACCS (acc, acc)}
7736 @tab @code{__MDSUBACCS (@var{b}, @var{a})}
7737 @tab @code{MDSUBACCS @var{a},@var{b}}
7738 @item @code{void __MDUNPACKH (uw1 *, uw2)}
7739 @tab @code{__MDUNPACKH (&@var{b}, @var{a})}
7740 @tab @code{MDUNPACKH @var{a},@var{b}}
7741 @item @code{uw2 __MEXPDHD (uw1, const)}
7742 @tab @code{@var{c} = __MEXPDHD (@var{a}, @var{b})}
7743 @tab @code{MEXPDHD @var{a},#@var{b},@var{c}}
7744 @item @code{uw1 __MEXPDHW (uw1, const)}
7745 @tab @code{@var{c} = __MEXPDHW (@var{a}, @var{b})}
7746 @tab @code{MEXPDHW @var{a},#@var{b},@var{c}}
7747 @item @code{uw1 __MHDSETH (uw1, const)}
7748 @tab @code{@var{c} = __MHDSETH (@var{a}, @var{b})}
7749 @tab @code{MHDSETH @var{a},#@var{b},@var{c}}
7750 @item @code{sw1 __MHDSETS (const)}
7751 @tab @code{@var{b} = __MHDSETS (@var{a})}
7752 @tab @code{MHDSETS #@var{a},@var{b}}
7753 @item @code{uw1 __MHSETHIH (uw1, const)}
7754 @tab @code{@var{b} = __MHSETHIH (@var{b}, @var{a})}
7755 @tab @code{MHSETHIH #@var{a},@var{b}}
7756 @item @code{sw1 __MHSETHIS (sw1, const)}
7757 @tab @code{@var{b} = __MHSETHIS (@var{b}, @var{a})}
7758 @tab @code{MHSETHIS #@var{a},@var{b}}
7759 @item @code{uw1 __MHSETLOH (uw1, const)}
7760 @tab @code{@var{b} = __MHSETLOH (@var{b}, @var{a})}
7761 @tab @code{MHSETLOH #@var{a},@var{b}}
7762 @item @code{sw1 __MHSETLOS (sw1, const)}
7763 @tab @code{@var{b} = __MHSETLOS (@var{b}, @var{a})}
7764 @tab @code{MHSETLOS #@var{a},@var{b}}
7765 @item @code{uw1 __MHTOB (uw2)}
7766 @tab @code{@var{b} = __MHTOB (@var{a})}
7767 @tab @code{MHTOB @var{a},@var{b}}
7768 @item @code{void __MMACHS (acc, sw1, sw1)}
7769 @tab @code{__MMACHS (@var{c}, @var{a}, @var{b})}
7770 @tab @code{MMACHS @var{a},@var{b},@var{c}}
7771 @item @code{void __MMACHU (acc, uw1, uw1)}
7772 @tab @code{__MMACHU (@var{c}, @var{a}, @var{b})}
7773 @tab @code{MMACHU @var{a},@var{b},@var{c}}
7774 @item @code{void __MMRDHS (acc, sw1, sw1)}
7775 @tab @code{__MMRDHS (@var{c}, @var{a}, @var{b})}
7776 @tab @code{MMRDHS @var{a},@var{b},@var{c}}
7777 @item @code{void __MMRDHU (acc, uw1, uw1)}
7778 @tab @code{__MMRDHU (@var{c}, @var{a}, @var{b})}
7779 @tab @code{MMRDHU @var{a},@var{b},@var{c}}
7780 @item @code{void __MMULHS (acc, sw1, sw1)}
7781 @tab @code{__MMULHS (@var{c}, @var{a}, @var{b})}
7782 @tab @code{MMULHS @var{a},@var{b},@var{c}}
7783 @item @code{void __MMULHU (acc, uw1, uw1)}
7784 @tab @code{__MMULHU (@var{c}, @var{a}, @var{b})}
7785 @tab @code{MMULHU @var{a},@var{b},@var{c}}
7786 @item @code{void __MMULXHS (acc, sw1, sw1)}
7787 @tab @code{__MMULXHS (@var{c}, @var{a}, @var{b})}
7788 @tab @code{MMULXHS @var{a},@var{b},@var{c}}
7789 @item @code{void __MMULXHU (acc, uw1, uw1)}
7790 @tab @code{__MMULXHU (@var{c}, @var{a}, @var{b})}
7791 @tab @code{MMULXHU @var{a},@var{b},@var{c}}
7792 @item @code{uw1 __MNOT (uw1)}
7793 @tab @code{@var{b} = __MNOT (@var{a})}
7794 @tab @code{MNOT @var{a},@var{b}}
7795 @item @code{uw1 __MOR (uw1, uw1)}
7796 @tab @code{@var{c} = __MOR (@var{a}, @var{b})}
7797 @tab @code{MOR @var{a},@var{b},@var{c}}
7798 @item @code{uw1 __MPACKH (uh, uh)}
7799 @tab @code{@var{c} = __MPACKH (@var{a}, @var{b})}
7800 @tab @code{MPACKH @var{a},@var{b},@var{c}}
7801 @item @code{sw2 __MQADDHSS (sw2, sw2)}
7802 @tab @code{@var{c} = __MQADDHSS (@var{a}, @var{b})}
7803 @tab @code{MQADDHSS @var{a},@var{b},@var{c}}
7804 @item @code{uw2 __MQADDHUS (uw2, uw2)}
7805 @tab @code{@var{c} = __MQADDHUS (@var{a}, @var{b})}
7806 @tab @code{MQADDHUS @var{a},@var{b},@var{c}}
7807 @item @code{void __MQCPXIS (acc, sw2, sw2)}
7808 @tab @code{__MQCPXIS (@var{c}, @var{a}, @var{b})}
7809 @tab @code{MQCPXIS @var{a},@var{b},@var{c}}
7810 @item @code{void __MQCPXIU (acc, uw2, uw2)}
7811 @tab @code{__MQCPXIU (@var{c}, @var{a}, @var{b})}
7812 @tab @code{MQCPXIU @var{a},@var{b},@var{c}}
7813 @item @code{void __MQCPXRS (acc, sw2, sw2)}
7814 @tab @code{__MQCPXRS (@var{c}, @var{a}, @var{b})}
7815 @tab @code{MQCPXRS @var{a},@var{b},@var{c}}
7816 @item @code{void __MQCPXRU (acc, uw2, uw2)}
7817 @tab @code{__MQCPXRU (@var{c}, @var{a}, @var{b})}
7818 @tab @code{MQCPXRU @var{a},@var{b},@var{c}}
7819 @item @code{sw2 __MQLCLRHS (sw2, sw2)}
7820 @tab @code{@var{c} = __MQLCLRHS (@var{a}, @var{b})}
7821 @tab @code{MQLCLRHS @var{a},@var{b},@var{c}}
7822 @item @code{sw2 __MQLMTHS (sw2, sw2)}
7823 @tab @code{@var{c} = __MQLMTHS (@var{a}, @var{b})}
7824 @tab @code{MQLMTHS @var{a},@var{b},@var{c}}
7825 @item @code{void __MQMACHS (acc, sw2, sw2)}
7826 @tab @code{__MQMACHS (@var{c}, @var{a}, @var{b})}
7827 @tab @code{MQMACHS @var{a},@var{b},@var{c}}
7828 @item @code{void __MQMACHU (acc, uw2, uw2)}
7829 @tab @code{__MQMACHU (@var{c}, @var{a}, @var{b})}
7830 @tab @code{MQMACHU @var{a},@var{b},@var{c}}
7831 @item @code{void __MQMACXHS (acc, sw2, sw2)}
7832 @tab @code{__MQMACXHS (@var{c}, @var{a}, @var{b})}
7833 @tab @code{MQMACXHS @var{a},@var{b},@var{c}}
7834 @item @code{void __MQMULHS (acc, sw2, sw2)}
7835 @tab @code{__MQMULHS (@var{c}, @var{a}, @var{b})}
7836 @tab @code{MQMULHS @var{a},@var{b},@var{c}}
7837 @item @code{void __MQMULHU (acc, uw2, uw2)}
7838 @tab @code{__MQMULHU (@var{c}, @var{a}, @var{b})}
7839 @tab @code{MQMULHU @var{a},@var{b},@var{c}}
7840 @item @code{void __MQMULXHS (acc, sw2, sw2)}
7841 @tab @code{__MQMULXHS (@var{c}, @var{a}, @var{b})}
7842 @tab @code{MQMULXHS @var{a},@var{b},@var{c}}
7843 @item @code{void __MQMULXHU (acc, uw2, uw2)}
7844 @tab @code{__MQMULXHU (@var{c}, @var{a}, @var{b})}
7845 @tab @code{MQMULXHU @var{a},@var{b},@var{c}}
7846 @item @code{sw2 __MQSATHS (sw2, sw2)}
7847 @tab @code{@var{c} = __MQSATHS (@var{a}, @var{b})}
7848 @tab @code{MQSATHS @var{a},@var{b},@var{c}}
7849 @item @code{uw2 __MQSLLHI (uw2, int)}
7850 @tab @code{@var{c} = __MQSLLHI (@var{a}, @var{b})}
7851 @tab @code{MQSLLHI @var{a},@var{b},@var{c}}
7852 @item @code{sw2 __MQSRAHI (sw2, int)}
7853 @tab @code{@var{c} = __MQSRAHI (@var{a}, @var{b})}
7854 @tab @code{MQSRAHI @var{a},@var{b},@var{c}}
7855 @item @code{sw2 __MQSUBHSS (sw2, sw2)}
7856 @tab @code{@var{c} = __MQSUBHSS (@var{a}, @var{b})}
7857 @tab @code{MQSUBHSS @var{a},@var{b},@var{c}}
7858 @item @code{uw2 __MQSUBHUS (uw2, uw2)}
7859 @tab @code{@var{c} = __MQSUBHUS (@var{a}, @var{b})}
7860 @tab @code{MQSUBHUS @var{a},@var{b},@var{c}}
7861 @item @code{void __MQXMACHS (acc, sw2, sw2)}
7862 @tab @code{__MQXMACHS (@var{c}, @var{a}, @var{b})}
7863 @tab @code{MQXMACHS @var{a},@var{b},@var{c}}
7864 @item @code{void __MQXMACXHS (acc, sw2, sw2)}
7865 @tab @code{__MQXMACXHS (@var{c}, @var{a}, @var{b})}
7866 @tab @code{MQXMACXHS @var{a},@var{b},@var{c}}
7867 @item @code{uw1 __MRDACC (acc)}
7868 @tab @code{@var{b} = __MRDACC (@var{a})}
7869 @tab @code{MRDACC @var{a},@var{b}}
7870 @item @code{uw1 __MRDACCG (acc)}
7871 @tab @code{@var{b} = __MRDACCG (@var{a})}
7872 @tab @code{MRDACCG @var{a},@var{b}}
7873 @item @code{uw1 __MROTLI (uw1, const)}
7874 @tab @code{@var{c} = __MROTLI (@var{a}, @var{b})}
7875 @tab @code{MROTLI @var{a},#@var{b},@var{c}}
7876 @item @code{uw1 __MROTRI (uw1, const)}
7877 @tab @code{@var{c} = __MROTRI (@var{a}, @var{b})}
7878 @tab @code{MROTRI @var{a},#@var{b},@var{c}}
7879 @item @code{sw1 __MSATHS (sw1, sw1)}
7880 @tab @code{@var{c} = __MSATHS (@var{a}, @var{b})}
7881 @tab @code{MSATHS @var{a},@var{b},@var{c}}
7882 @item @code{uw1 __MSATHU (uw1, uw1)}
7883 @tab @code{@var{c} = __MSATHU (@var{a}, @var{b})}
7884 @tab @code{MSATHU @var{a},@var{b},@var{c}}
7885 @item @code{uw1 __MSLLHI (uw1, const)}
7886 @tab @code{@var{c} = __MSLLHI (@var{a}, @var{b})}
7887 @tab @code{MSLLHI @var{a},#@var{b},@var{c}}
7888 @item @code{sw1 __MSRAHI (sw1, const)}
7889 @tab @code{@var{c} = __MSRAHI (@var{a}, @var{b})}
7890 @tab @code{MSRAHI @var{a},#@var{b},@var{c}}
7891 @item @code{uw1 __MSRLHI (uw1, const)}
7892 @tab @code{@var{c} = __MSRLHI (@var{a}, @var{b})}
7893 @tab @code{MSRLHI @var{a},#@var{b},@var{c}}
7894 @item @code{void __MSUBACCS (acc, acc)}
7895 @tab @code{__MSUBACCS (@var{b}, @var{a})}
7896 @tab @code{MSUBACCS @var{a},@var{b}}
7897 @item @code{sw1 __MSUBHSS (sw1, sw1)}
7898 @tab @code{@var{c} = __MSUBHSS (@var{a}, @var{b})}
7899 @tab @code{MSUBHSS @var{a},@var{b},@var{c}}
7900 @item @code{uw1 __MSUBHUS (uw1, uw1)}
7901 @tab @code{@var{c} = __MSUBHUS (@var{a}, @var{b})}
7902 @tab @code{MSUBHUS @var{a},@var{b},@var{c}}
7903 @item @code{void __MTRAP (void)}
7904 @tab @code{__MTRAP ()}
7905 @tab @code{MTRAP}
7906 @item @code{uw2 __MUNPACKH (uw1)}
7907 @tab @code{@var{b} = __MUNPACKH (@var{a})}
7908 @tab @code{MUNPACKH @var{a},@var{b}}
7909 @item @code{uw1 __MWCUT (uw2, uw1)}
7910 @tab @code{@var{c} = __MWCUT (@var{a}, @var{b})}
7911 @tab @code{MWCUT @var{a},@var{b},@var{c}}
7912 @item @code{void __MWTACC (acc, uw1)}
7913 @tab @code{__MWTACC (@var{b}, @var{a})}
7914 @tab @code{MWTACC @var{a},@var{b}}
7915 @item @code{void __MWTACCG (acc, uw1)}
7916 @tab @code{__MWTACCG (@var{b}, @var{a})}
7917 @tab @code{MWTACCG @var{a},@var{b}}
7918 @item @code{uw1 __MXOR (uw1, uw1)}
7919 @tab @code{@var{c} = __MXOR (@var{a}, @var{b})}
7920 @tab @code{MXOR @var{a},@var{b},@var{c}}
7921 @end multitable
7923 @node Raw read/write Functions
7924 @subsubsection Raw read/write Functions
7926 This sections describes built-in functions related to read and write
7927 instructions to access memory.  These functions generate
7928 @code{membar} instructions to flush the I/O load and stores where
7929 appropriate, as described in Fujitsu's manual described above.
7931 @table @code
7933 @item unsigned char __builtin_read8 (void *@var{data})
7934 @item unsigned short __builtin_read16 (void *@var{data})
7935 @item unsigned long __builtin_read32 (void *@var{data})
7936 @item unsigned long long __builtin_read64 (void *@var{data})
7938 @item void __builtin_write8 (void *@var{data}, unsigned char @var{datum})
7939 @item void __builtin_write16 (void *@var{data}, unsigned short @var{datum})
7940 @item void __builtin_write32 (void *@var{data}, unsigned long @var{datum})
7941 @item void __builtin_write64 (void *@var{data}, unsigned long long @var{datum})
7942 @end table
7944 @node Other Built-in Functions
7945 @subsubsection Other Built-in Functions
7947 This section describes built-in functions that are not named after
7948 a specific FR-V instruction.
7950 @table @code
7951 @item sw2 __IACCreadll (iacc @var{reg})
7952 Return the full 64-bit value of IACC0@.  The @var{reg} argument is reserved
7953 for future expansion and must be 0.
7955 @item sw1 __IACCreadl (iacc @var{reg})
7956 Return the value of IACC0H if @var{reg} is 0 and IACC0L if @var{reg} is 1.
7957 Other values of @var{reg} are rejected as invalid.
7959 @item void __IACCsetll (iacc @var{reg}, sw2 @var{x})
7960 Set the full 64-bit value of IACC0 to @var{x}.  The @var{reg} argument
7961 is reserved for future expansion and must be 0.
7963 @item void __IACCsetl (iacc @var{reg}, sw1 @var{x})
7964 Set IACC0H to @var{x} if @var{reg} is 0 and IACC0L to @var{x} if @var{reg}
7965 is 1.  Other values of @var{reg} are rejected as invalid.
7967 @item void __data_prefetch0 (const void *@var{x})
7968 Use the @code{dcpl} instruction to load the contents of address @var{x}
7969 into the data cache.
7971 @item void __data_prefetch (const void *@var{x})
7972 Use the @code{nldub} instruction to load the contents of address @var{x}
7973 into the data cache.  The instruction will be issued in slot I1@.
7974 @end table
7976 @node X86 Built-in Functions
7977 @subsection X86 Built-in Functions
7979 These built-in functions are available for the i386 and x86-64 family
7980 of computers, depending on the command-line switches used.
7982 Note that, if you specify command-line switches such as @option{-msse},
7983 the compiler could use the extended instruction sets even if the built-ins
7984 are not used explicitly in the program.  For this reason, applications
7985 which perform runtime CPU detection must compile separate files for each
7986 supported architecture, using the appropriate flags.  In particular,
7987 the file containing the CPU detection code should be compiled without
7988 these options.
7990 The following machine modes are available for use with MMX built-in functions
7991 (@pxref{Vector Extensions}): @code{V2SI} for a vector of two 32-bit integers,
7992 @code{V4HI} for a vector of four 16-bit integers, and @code{V8QI} for a
7993 vector of eight 8-bit integers.  Some of the built-in functions operate on
7994 MMX registers as a whole 64-bit entity, these use @code{V1DI} as their mode.
7996 If 3Dnow extensions are enabled, @code{V2SF} is used as a mode for a vector
7997 of two 32-bit floating point values.
7999 If SSE extensions are enabled, @code{V4SF} is used for a vector of four 32-bit
8000 floating point values.  Some instructions use a vector of four 32-bit
8001 integers, these use @code{V4SI}.  Finally, some instructions operate on an
8002 entire vector register, interpreting it as a 128-bit integer, these use mode
8003 @code{TI}.
8005 In 64-bit mode, the x86-64 family of processors uses additional built-in
8006 functions for efficient use of @code{TF} (@code{__float128}) 128-bit
8007 floating point and @code{TC} 128-bit complex floating point values.
8009 The following floating point built-in functions are available in 64-bit
8010 mode.  All of them implement the function that is part of the name.
8012 @smallexample
8013 __float128 __builtin_fabsq (__float128)
8014 __float128 __builtin_copysignq (__float128, __float128)
8015 @end smallexample
8017 The following floating point built-in functions are made available in the
8018 64-bit mode.
8020 @table @code
8021 @item __float128 __builtin_infq (void)
8022 Similar to @code{__builtin_inf}, except the return type is @code{__float128}.
8023 @findex __builtin_infq
8025 @item __float128 __builtin_huge_valq (void)
8026 Similar to @code{__builtin_huge_val}, except the return type is @code{__float128}.
8027 @findex __builtin_huge_valq
8028 @end table
8030 The following built-in functions are made available by @option{-mmmx}.
8031 All of them generate the machine instruction that is part of the name.
8033 @smallexample
8034 v8qi __builtin_ia32_paddb (v8qi, v8qi)
8035 v4hi __builtin_ia32_paddw (v4hi, v4hi)
8036 v2si __builtin_ia32_paddd (v2si, v2si)
8037 v8qi __builtin_ia32_psubb (v8qi, v8qi)
8038 v4hi __builtin_ia32_psubw (v4hi, v4hi)
8039 v2si __builtin_ia32_psubd (v2si, v2si)
8040 v8qi __builtin_ia32_paddsb (v8qi, v8qi)
8041 v4hi __builtin_ia32_paddsw (v4hi, v4hi)
8042 v8qi __builtin_ia32_psubsb (v8qi, v8qi)
8043 v4hi __builtin_ia32_psubsw (v4hi, v4hi)
8044 v8qi __builtin_ia32_paddusb (v8qi, v8qi)
8045 v4hi __builtin_ia32_paddusw (v4hi, v4hi)
8046 v8qi __builtin_ia32_psubusb (v8qi, v8qi)
8047 v4hi __builtin_ia32_psubusw (v4hi, v4hi)
8048 v4hi __builtin_ia32_pmullw (v4hi, v4hi)
8049 v4hi __builtin_ia32_pmulhw (v4hi, v4hi)
8050 di __builtin_ia32_pand (di, di)
8051 di __builtin_ia32_pandn (di,di)
8052 di __builtin_ia32_por (di, di)
8053 di __builtin_ia32_pxor (di, di)
8054 v8qi __builtin_ia32_pcmpeqb (v8qi, v8qi)
8055 v4hi __builtin_ia32_pcmpeqw (v4hi, v4hi)
8056 v2si __builtin_ia32_pcmpeqd (v2si, v2si)
8057 v8qi __builtin_ia32_pcmpgtb (v8qi, v8qi)
8058 v4hi __builtin_ia32_pcmpgtw (v4hi, v4hi)
8059 v2si __builtin_ia32_pcmpgtd (v2si, v2si)
8060 v8qi __builtin_ia32_punpckhbw (v8qi, v8qi)
8061 v4hi __builtin_ia32_punpckhwd (v4hi, v4hi)
8062 v2si __builtin_ia32_punpckhdq (v2si, v2si)
8063 v8qi __builtin_ia32_punpcklbw (v8qi, v8qi)
8064 v4hi __builtin_ia32_punpcklwd (v4hi, v4hi)
8065 v2si __builtin_ia32_punpckldq (v2si, v2si)
8066 v8qi __builtin_ia32_packsswb (v4hi, v4hi)
8067 v4hi __builtin_ia32_packssdw (v2si, v2si)
8068 v8qi __builtin_ia32_packuswb (v4hi, v4hi)
8070 v4hi __builtin_ia32_psllw (v4hi, v4hi)
8071 v2si __builtin_ia32_pslld (v2si, v2si)
8072 v1di __builtin_ia32_psllq (v1di, v1di)
8073 v4hi __builtin_ia32_psrlw (v4hi, v4hi)
8074 v2si __builtin_ia32_psrld (v2si, v2si)
8075 v1di __builtin_ia32_psrlq (v1di, v1di)
8076 v4hi __builtin_ia32_psraw (v4hi, v4hi)
8077 v2si __builtin_ia32_psrad (v2si, v2si)
8078 v4hi __builtin_ia32_psllwi (v4hi, int)
8079 v2si __builtin_ia32_pslldi (v2si, int)
8080 v1di __builtin_ia32_psllqi (v1di, int)
8081 v4hi __builtin_ia32_psrlwi (v4hi, int)
8082 v2si __builtin_ia32_psrldi (v2si, int)
8083 v1di __builtin_ia32_psrlqi (v1di, int)
8084 v4hi __builtin_ia32_psrawi (v4hi, int)
8085 v2si __builtin_ia32_psradi (v2si, int)
8087 @end smallexample
8089 The following built-in functions are made available either with
8090 @option{-msse}, or with a combination of @option{-m3dnow} and
8091 @option{-march=athlon}.  All of them generate the machine
8092 instruction that is part of the name.
8094 @smallexample
8095 v4hi __builtin_ia32_pmulhuw (v4hi, v4hi)
8096 v8qi __builtin_ia32_pavgb (v8qi, v8qi)
8097 v4hi __builtin_ia32_pavgw (v4hi, v4hi)
8098 v1di __builtin_ia32_psadbw (v8qi, v8qi)
8099 v8qi __builtin_ia32_pmaxub (v8qi, v8qi)
8100 v4hi __builtin_ia32_pmaxsw (v4hi, v4hi)
8101 v8qi __builtin_ia32_pminub (v8qi, v8qi)
8102 v4hi __builtin_ia32_pminsw (v4hi, v4hi)
8103 int __builtin_ia32_pextrw (v4hi, int)
8104 v4hi __builtin_ia32_pinsrw (v4hi, int, int)
8105 int __builtin_ia32_pmovmskb (v8qi)
8106 void __builtin_ia32_maskmovq (v8qi, v8qi, char *)
8107 void __builtin_ia32_movntq (di *, di)
8108 void __builtin_ia32_sfence (void)
8109 @end smallexample
8111 The following built-in functions are available when @option{-msse} is used.
8112 All of them generate the machine instruction that is part of the name.
8114 @smallexample
8115 int __builtin_ia32_comieq (v4sf, v4sf)
8116 int __builtin_ia32_comineq (v4sf, v4sf)
8117 int __builtin_ia32_comilt (v4sf, v4sf)
8118 int __builtin_ia32_comile (v4sf, v4sf)
8119 int __builtin_ia32_comigt (v4sf, v4sf)
8120 int __builtin_ia32_comige (v4sf, v4sf)
8121 int __builtin_ia32_ucomieq (v4sf, v4sf)
8122 int __builtin_ia32_ucomineq (v4sf, v4sf)
8123 int __builtin_ia32_ucomilt (v4sf, v4sf)
8124 int __builtin_ia32_ucomile (v4sf, v4sf)
8125 int __builtin_ia32_ucomigt (v4sf, v4sf)
8126 int __builtin_ia32_ucomige (v4sf, v4sf)
8127 v4sf __builtin_ia32_addps (v4sf, v4sf)
8128 v4sf __builtin_ia32_subps (v4sf, v4sf)
8129 v4sf __builtin_ia32_mulps (v4sf, v4sf)
8130 v4sf __builtin_ia32_divps (v4sf, v4sf)
8131 v4sf __builtin_ia32_addss (v4sf, v4sf)
8132 v4sf __builtin_ia32_subss (v4sf, v4sf)
8133 v4sf __builtin_ia32_mulss (v4sf, v4sf)
8134 v4sf __builtin_ia32_divss (v4sf, v4sf)
8135 v4si __builtin_ia32_cmpeqps (v4sf, v4sf)
8136 v4si __builtin_ia32_cmpltps (v4sf, v4sf)
8137 v4si __builtin_ia32_cmpleps (v4sf, v4sf)
8138 v4si __builtin_ia32_cmpgtps (v4sf, v4sf)
8139 v4si __builtin_ia32_cmpgeps (v4sf, v4sf)
8140 v4si __builtin_ia32_cmpunordps (v4sf, v4sf)
8141 v4si __builtin_ia32_cmpneqps (v4sf, v4sf)
8142 v4si __builtin_ia32_cmpnltps (v4sf, v4sf)
8143 v4si __builtin_ia32_cmpnleps (v4sf, v4sf)
8144 v4si __builtin_ia32_cmpngtps (v4sf, v4sf)
8145 v4si __builtin_ia32_cmpngeps (v4sf, v4sf)
8146 v4si __builtin_ia32_cmpordps (v4sf, v4sf)
8147 v4si __builtin_ia32_cmpeqss (v4sf, v4sf)
8148 v4si __builtin_ia32_cmpltss (v4sf, v4sf)
8149 v4si __builtin_ia32_cmpless (v4sf, v4sf)
8150 v4si __builtin_ia32_cmpunordss (v4sf, v4sf)
8151 v4si __builtin_ia32_cmpneqss (v4sf, v4sf)
8152 v4si __builtin_ia32_cmpnlts (v4sf, v4sf)
8153 v4si __builtin_ia32_cmpnless (v4sf, v4sf)
8154 v4si __builtin_ia32_cmpordss (v4sf, v4sf)
8155 v4sf __builtin_ia32_maxps (v4sf, v4sf)
8156 v4sf __builtin_ia32_maxss (v4sf, v4sf)
8157 v4sf __builtin_ia32_minps (v4sf, v4sf)
8158 v4sf __builtin_ia32_minss (v4sf, v4sf)
8159 v4sf __builtin_ia32_andps (v4sf, v4sf)
8160 v4sf __builtin_ia32_andnps (v4sf, v4sf)
8161 v4sf __builtin_ia32_orps (v4sf, v4sf)
8162 v4sf __builtin_ia32_xorps (v4sf, v4sf)
8163 v4sf __builtin_ia32_movss (v4sf, v4sf)
8164 v4sf __builtin_ia32_movhlps (v4sf, v4sf)
8165 v4sf __builtin_ia32_movlhps (v4sf, v4sf)
8166 v4sf __builtin_ia32_unpckhps (v4sf, v4sf)
8167 v4sf __builtin_ia32_unpcklps (v4sf, v4sf)
8168 v4sf __builtin_ia32_cvtpi2ps (v4sf, v2si)
8169 v4sf __builtin_ia32_cvtsi2ss (v4sf, int)
8170 v2si __builtin_ia32_cvtps2pi (v4sf)
8171 int __builtin_ia32_cvtss2si (v4sf)
8172 v2si __builtin_ia32_cvttps2pi (v4sf)
8173 int __builtin_ia32_cvttss2si (v4sf)
8174 v4sf __builtin_ia32_rcpps (v4sf)
8175 v4sf __builtin_ia32_rsqrtps (v4sf)
8176 v4sf __builtin_ia32_sqrtps (v4sf)
8177 v4sf __builtin_ia32_rcpss (v4sf)
8178 v4sf __builtin_ia32_rsqrtss (v4sf)
8179 v4sf __builtin_ia32_sqrtss (v4sf)
8180 v4sf __builtin_ia32_shufps (v4sf, v4sf, int)
8181 void __builtin_ia32_movntps (float *, v4sf)
8182 int __builtin_ia32_movmskps (v4sf)
8183 @end smallexample
8185 The following built-in functions are available when @option{-msse} is used.
8187 @table @code
8188 @item v4sf __builtin_ia32_loadaps (float *)
8189 Generates the @code{movaps} machine instruction as a load from memory.
8190 @item void __builtin_ia32_storeaps (float *, v4sf)
8191 Generates the @code{movaps} machine instruction as a store to memory.
8192 @item v4sf __builtin_ia32_loadups (float *)
8193 Generates the @code{movups} machine instruction as a load from memory.
8194 @item void __builtin_ia32_storeups (float *, v4sf)
8195 Generates the @code{movups} machine instruction as a store to memory.
8196 @item v4sf __builtin_ia32_loadsss (float *)
8197 Generates the @code{movss} machine instruction as a load from memory.
8198 @item void __builtin_ia32_storess (float *, v4sf)
8199 Generates the @code{movss} machine instruction as a store to memory.
8200 @item v4sf __builtin_ia32_loadhps (v4sf, const v2sf *)
8201 Generates the @code{movhps} machine instruction as a load from memory.
8202 @item v4sf __builtin_ia32_loadlps (v4sf, const v2sf *)
8203 Generates the @code{movlps} machine instruction as a load from memory
8204 @item void __builtin_ia32_storehps (v2sf *, v4sf)
8205 Generates the @code{movhps} machine instruction as a store to memory.
8206 @item void __builtin_ia32_storelps (v2sf *, v4sf)
8207 Generates the @code{movlps} machine instruction as a store to memory.
8208 @end table
8210 The following built-in functions are available when @option{-msse2} is used.
8211 All of them generate the machine instruction that is part of the name.
8213 @smallexample
8214 int __builtin_ia32_comisdeq (v2df, v2df)
8215 int __builtin_ia32_comisdlt (v2df, v2df)
8216 int __builtin_ia32_comisdle (v2df, v2df)
8217 int __builtin_ia32_comisdgt (v2df, v2df)
8218 int __builtin_ia32_comisdge (v2df, v2df)
8219 int __builtin_ia32_comisdneq (v2df, v2df)
8220 int __builtin_ia32_ucomisdeq (v2df, v2df)
8221 int __builtin_ia32_ucomisdlt (v2df, v2df)
8222 int __builtin_ia32_ucomisdle (v2df, v2df)
8223 int __builtin_ia32_ucomisdgt (v2df, v2df)
8224 int __builtin_ia32_ucomisdge (v2df, v2df)
8225 int __builtin_ia32_ucomisdneq (v2df, v2df)
8226 v2df __builtin_ia32_cmpeqpd (v2df, v2df)
8227 v2df __builtin_ia32_cmpltpd (v2df, v2df)
8228 v2df __builtin_ia32_cmplepd (v2df, v2df)
8229 v2df __builtin_ia32_cmpgtpd (v2df, v2df)
8230 v2df __builtin_ia32_cmpgepd (v2df, v2df)
8231 v2df __builtin_ia32_cmpunordpd (v2df, v2df)
8232 v2df __builtin_ia32_cmpneqpd (v2df, v2df)
8233 v2df __builtin_ia32_cmpnltpd (v2df, v2df)
8234 v2df __builtin_ia32_cmpnlepd (v2df, v2df)
8235 v2df __builtin_ia32_cmpngtpd (v2df, v2df)
8236 v2df __builtin_ia32_cmpngepd (v2df, v2df)
8237 v2df __builtin_ia32_cmpordpd (v2df, v2df)
8238 v2df __builtin_ia32_cmpeqsd (v2df, v2df)
8239 v2df __builtin_ia32_cmpltsd (v2df, v2df)
8240 v2df __builtin_ia32_cmplesd (v2df, v2df)
8241 v2df __builtin_ia32_cmpunordsd (v2df, v2df)
8242 v2df __builtin_ia32_cmpneqsd (v2df, v2df)
8243 v2df __builtin_ia32_cmpnltsd (v2df, v2df)
8244 v2df __builtin_ia32_cmpnlesd (v2df, v2df)
8245 v2df __builtin_ia32_cmpordsd (v2df, v2df)
8246 v2di __builtin_ia32_paddq (v2di, v2di)
8247 v2di __builtin_ia32_psubq (v2di, v2di)
8248 v2df __builtin_ia32_addpd (v2df, v2df)
8249 v2df __builtin_ia32_subpd (v2df, v2df)
8250 v2df __builtin_ia32_mulpd (v2df, v2df)
8251 v2df __builtin_ia32_divpd (v2df, v2df)
8252 v2df __builtin_ia32_addsd (v2df, v2df)
8253 v2df __builtin_ia32_subsd (v2df, v2df)
8254 v2df __builtin_ia32_mulsd (v2df, v2df)
8255 v2df __builtin_ia32_divsd (v2df, v2df)
8256 v2df __builtin_ia32_minpd (v2df, v2df)
8257 v2df __builtin_ia32_maxpd (v2df, v2df)
8258 v2df __builtin_ia32_minsd (v2df, v2df)
8259 v2df __builtin_ia32_maxsd (v2df, v2df)
8260 v2df __builtin_ia32_andpd (v2df, v2df)
8261 v2df __builtin_ia32_andnpd (v2df, v2df)
8262 v2df __builtin_ia32_orpd (v2df, v2df)
8263 v2df __builtin_ia32_xorpd (v2df, v2df)
8264 v2df __builtin_ia32_movsd (v2df, v2df)
8265 v2df __builtin_ia32_unpckhpd (v2df, v2df)
8266 v2df __builtin_ia32_unpcklpd (v2df, v2df)
8267 v16qi __builtin_ia32_paddb128 (v16qi, v16qi)
8268 v8hi __builtin_ia32_paddw128 (v8hi, v8hi)
8269 v4si __builtin_ia32_paddd128 (v4si, v4si)
8270 v2di __builtin_ia32_paddq128 (v2di, v2di)
8271 v16qi __builtin_ia32_psubb128 (v16qi, v16qi)
8272 v8hi __builtin_ia32_psubw128 (v8hi, v8hi)
8273 v4si __builtin_ia32_psubd128 (v4si, v4si)
8274 v2di __builtin_ia32_psubq128 (v2di, v2di)
8275 v8hi __builtin_ia32_pmullw128 (v8hi, v8hi)
8276 v8hi __builtin_ia32_pmulhw128 (v8hi, v8hi)
8277 v2di __builtin_ia32_pand128 (v2di, v2di)
8278 v2di __builtin_ia32_pandn128 (v2di, v2di)
8279 v2di __builtin_ia32_por128 (v2di, v2di)
8280 v2di __builtin_ia32_pxor128 (v2di, v2di)
8281 v16qi __builtin_ia32_pavgb128 (v16qi, v16qi)
8282 v8hi __builtin_ia32_pavgw128 (v8hi, v8hi)
8283 v16qi __builtin_ia32_pcmpeqb128 (v16qi, v16qi)
8284 v8hi __builtin_ia32_pcmpeqw128 (v8hi, v8hi)
8285 v4si __builtin_ia32_pcmpeqd128 (v4si, v4si)
8286 v16qi __builtin_ia32_pcmpgtb128 (v16qi, v16qi)
8287 v8hi __builtin_ia32_pcmpgtw128 (v8hi, v8hi)
8288 v4si __builtin_ia32_pcmpgtd128 (v4si, v4si)
8289 v16qi __builtin_ia32_pmaxub128 (v16qi, v16qi)
8290 v8hi __builtin_ia32_pmaxsw128 (v8hi, v8hi)
8291 v16qi __builtin_ia32_pminub128 (v16qi, v16qi)
8292 v8hi __builtin_ia32_pminsw128 (v8hi, v8hi)
8293 v16qi __builtin_ia32_punpckhbw128 (v16qi, v16qi)
8294 v8hi __builtin_ia32_punpckhwd128 (v8hi, v8hi)
8295 v4si __builtin_ia32_punpckhdq128 (v4si, v4si)
8296 v2di __builtin_ia32_punpckhqdq128 (v2di, v2di)
8297 v16qi __builtin_ia32_punpcklbw128 (v16qi, v16qi)
8298 v8hi __builtin_ia32_punpcklwd128 (v8hi, v8hi)
8299 v4si __builtin_ia32_punpckldq128 (v4si, v4si)
8300 v2di __builtin_ia32_punpcklqdq128 (v2di, v2di)
8301 v16qi __builtin_ia32_packsswb128 (v8hi, v8hi)
8302 v8hi __builtin_ia32_packssdw128 (v4si, v4si)
8303 v16qi __builtin_ia32_packuswb128 (v8hi, v8hi)
8304 v8hi __builtin_ia32_pmulhuw128 (v8hi, v8hi)
8305 void __builtin_ia32_maskmovdqu (v16qi, v16qi)
8306 v2df __builtin_ia32_loadupd (double *)
8307 void __builtin_ia32_storeupd (double *, v2df)
8308 v2df __builtin_ia32_loadhpd (v2df, double const *)
8309 v2df __builtin_ia32_loadlpd (v2df, double const *)
8310 int __builtin_ia32_movmskpd (v2df)
8311 int __builtin_ia32_pmovmskb128 (v16qi)
8312 void __builtin_ia32_movnti (int *, int)
8313 void __builtin_ia32_movntpd (double *, v2df)
8314 void __builtin_ia32_movntdq (v2df *, v2df)
8315 v4si __builtin_ia32_pshufd (v4si, int)
8316 v8hi __builtin_ia32_pshuflw (v8hi, int)
8317 v8hi __builtin_ia32_pshufhw (v8hi, int)
8318 v2di __builtin_ia32_psadbw128 (v16qi, v16qi)
8319 v2df __builtin_ia32_sqrtpd (v2df)
8320 v2df __builtin_ia32_sqrtsd (v2df)
8321 v2df __builtin_ia32_shufpd (v2df, v2df, int)
8322 v2df __builtin_ia32_cvtdq2pd (v4si)
8323 v4sf __builtin_ia32_cvtdq2ps (v4si)
8324 v4si __builtin_ia32_cvtpd2dq (v2df)
8325 v2si __builtin_ia32_cvtpd2pi (v2df)
8326 v4sf __builtin_ia32_cvtpd2ps (v2df)
8327 v4si __builtin_ia32_cvttpd2dq (v2df)
8328 v2si __builtin_ia32_cvttpd2pi (v2df)
8329 v2df __builtin_ia32_cvtpi2pd (v2si)
8330 int __builtin_ia32_cvtsd2si (v2df)
8331 int __builtin_ia32_cvttsd2si (v2df)
8332 long long __builtin_ia32_cvtsd2si64 (v2df)
8333 long long __builtin_ia32_cvttsd2si64 (v2df)
8334 v4si __builtin_ia32_cvtps2dq (v4sf)
8335 v2df __builtin_ia32_cvtps2pd (v4sf)
8336 v4si __builtin_ia32_cvttps2dq (v4sf)
8337 v2df __builtin_ia32_cvtsi2sd (v2df, int)
8338 v2df __builtin_ia32_cvtsi642sd (v2df, long long)
8339 v4sf __builtin_ia32_cvtsd2ss (v4sf, v2df)
8340 v2df __builtin_ia32_cvtss2sd (v2df, v4sf)
8341 void __builtin_ia32_clflush (const void *)
8342 void __builtin_ia32_lfence (void)
8343 void __builtin_ia32_mfence (void)
8344 v16qi __builtin_ia32_loaddqu (const char *)
8345 void __builtin_ia32_storedqu (char *, v16qi)
8346 v1di __builtin_ia32_pmuludq (v2si, v2si)
8347 v2di __builtin_ia32_pmuludq128 (v4si, v4si)
8348 v8hi __builtin_ia32_psllw128 (v8hi, v8hi)
8349 v4si __builtin_ia32_pslld128 (v4si, v4si)
8350 v2di __builtin_ia32_psllq128 (v2di, v2di)
8351 v8hi __builtin_ia32_psrlw128 (v8hi, v8hi)
8352 v4si __builtin_ia32_psrld128 (v4si, v4si)
8353 v2di __builtin_ia32_psrlq128 (v2di, v2di)
8354 v8hi __builtin_ia32_psraw128 (v8hi, v8hi)
8355 v4si __builtin_ia32_psrad128 (v4si, v4si)
8356 v2di __builtin_ia32_pslldqi128 (v2di, int)
8357 v8hi __builtin_ia32_psllwi128 (v8hi, int)
8358 v4si __builtin_ia32_pslldi128 (v4si, int)
8359 v2di __builtin_ia32_psllqi128 (v2di, int)
8360 v2di __builtin_ia32_psrldqi128 (v2di, int)
8361 v8hi __builtin_ia32_psrlwi128 (v8hi, int)
8362 v4si __builtin_ia32_psrldi128 (v4si, int)
8363 v2di __builtin_ia32_psrlqi128 (v2di, int)
8364 v8hi __builtin_ia32_psrawi128 (v8hi, int)
8365 v4si __builtin_ia32_psradi128 (v4si, int)
8366 v4si __builtin_ia32_pmaddwd128 (v8hi, v8hi)
8367 v2di __builtin_ia32_movq128 (v2di)
8368 @end smallexample
8370 The following built-in functions are available when @option{-msse3} is used.
8371 All of them generate the machine instruction that is part of the name.
8373 @smallexample
8374 v2df __builtin_ia32_addsubpd (v2df, v2df)
8375 v4sf __builtin_ia32_addsubps (v4sf, v4sf)
8376 v2df __builtin_ia32_haddpd (v2df, v2df)
8377 v4sf __builtin_ia32_haddps (v4sf, v4sf)
8378 v2df __builtin_ia32_hsubpd (v2df, v2df)
8379 v4sf __builtin_ia32_hsubps (v4sf, v4sf)
8380 v16qi __builtin_ia32_lddqu (char const *)
8381 void __builtin_ia32_monitor (void *, unsigned int, unsigned int)
8382 v2df __builtin_ia32_movddup (v2df)
8383 v4sf __builtin_ia32_movshdup (v4sf)
8384 v4sf __builtin_ia32_movsldup (v4sf)
8385 void __builtin_ia32_mwait (unsigned int, unsigned int)
8386 @end smallexample
8388 The following built-in functions are available when @option{-msse3} is used.
8390 @table @code
8391 @item v2df __builtin_ia32_loadddup (double const *)
8392 Generates the @code{movddup} machine instruction as a load from memory.
8393 @end table
8395 The following built-in functions are available when @option{-mssse3} is used.
8396 All of them generate the machine instruction that is part of the name
8397 with MMX registers.
8399 @smallexample
8400 v2si __builtin_ia32_phaddd (v2si, v2si)
8401 v4hi __builtin_ia32_phaddw (v4hi, v4hi)
8402 v4hi __builtin_ia32_phaddsw (v4hi, v4hi)
8403 v2si __builtin_ia32_phsubd (v2si, v2si)
8404 v4hi __builtin_ia32_phsubw (v4hi, v4hi)
8405 v4hi __builtin_ia32_phsubsw (v4hi, v4hi)
8406 v4hi __builtin_ia32_pmaddubsw (v8qi, v8qi)
8407 v4hi __builtin_ia32_pmulhrsw (v4hi, v4hi)
8408 v8qi __builtin_ia32_pshufb (v8qi, v8qi)
8409 v8qi __builtin_ia32_psignb (v8qi, v8qi)
8410 v2si __builtin_ia32_psignd (v2si, v2si)
8411 v4hi __builtin_ia32_psignw (v4hi, v4hi)
8412 v1di __builtin_ia32_palignr (v1di, v1di, int)
8413 v8qi __builtin_ia32_pabsb (v8qi)
8414 v2si __builtin_ia32_pabsd (v2si)
8415 v4hi __builtin_ia32_pabsw (v4hi)
8416 @end smallexample
8418 The following built-in functions are available when @option{-mssse3} is used.
8419 All of them generate the machine instruction that is part of the name
8420 with SSE registers.
8422 @smallexample
8423 v4si __builtin_ia32_phaddd128 (v4si, v4si)
8424 v8hi __builtin_ia32_phaddw128 (v8hi, v8hi)
8425 v8hi __builtin_ia32_phaddsw128 (v8hi, v8hi)
8426 v4si __builtin_ia32_phsubd128 (v4si, v4si)
8427 v8hi __builtin_ia32_phsubw128 (v8hi, v8hi)
8428 v8hi __builtin_ia32_phsubsw128 (v8hi, v8hi)
8429 v8hi __builtin_ia32_pmaddubsw128 (v16qi, v16qi)
8430 v8hi __builtin_ia32_pmulhrsw128 (v8hi, v8hi)
8431 v16qi __builtin_ia32_pshufb128 (v16qi, v16qi)
8432 v16qi __builtin_ia32_psignb128 (v16qi, v16qi)
8433 v4si __builtin_ia32_psignd128 (v4si, v4si)
8434 v8hi __builtin_ia32_psignw128 (v8hi, v8hi)
8435 v2di __builtin_ia32_palignr128 (v2di, v2di, int)
8436 v16qi __builtin_ia32_pabsb128 (v16qi)
8437 v4si __builtin_ia32_pabsd128 (v4si)
8438 v8hi __builtin_ia32_pabsw128 (v8hi)
8439 @end smallexample
8441 The following built-in functions are available when @option{-msse4.1} is
8442 used.  All of them generate the machine instruction that is part of the
8443 name.
8445 @smallexample
8446 v2df __builtin_ia32_blendpd (v2df, v2df, const int)
8447 v4sf __builtin_ia32_blendps (v4sf, v4sf, const int)
8448 v2df __builtin_ia32_blendvpd (v2df, v2df, v2df)
8449 v4sf __builtin_ia32_blendvps (v4sf, v4sf, v4sf)
8450 v2df __builtin_ia32_dppd (v2df, v2df, const int)
8451 v4sf __builtin_ia32_dpps (v4sf, v4sf, const int)
8452 v4sf __builtin_ia32_insertps128 (v4sf, v4sf, const int)
8453 v2di __builtin_ia32_movntdqa (v2di *);
8454 v16qi __builtin_ia32_mpsadbw128 (v16qi, v16qi, const int)
8455 v8hi __builtin_ia32_packusdw128 (v4si, v4si)
8456 v16qi __builtin_ia32_pblendvb128 (v16qi, v16qi, v16qi)
8457 v8hi __builtin_ia32_pblendw128 (v8hi, v8hi, const int)
8458 v2di __builtin_ia32_pcmpeqq (v2di, v2di)
8459 v8hi __builtin_ia32_phminposuw128 (v8hi)
8460 v16qi __builtin_ia32_pmaxsb128 (v16qi, v16qi)
8461 v4si __builtin_ia32_pmaxsd128 (v4si, v4si)
8462 v4si __builtin_ia32_pmaxud128 (v4si, v4si)
8463 v8hi __builtin_ia32_pmaxuw128 (v8hi, v8hi)
8464 v16qi __builtin_ia32_pminsb128 (v16qi, v16qi)
8465 v4si __builtin_ia32_pminsd128 (v4si, v4si)
8466 v4si __builtin_ia32_pminud128 (v4si, v4si)
8467 v8hi __builtin_ia32_pminuw128 (v8hi, v8hi)
8468 v4si __builtin_ia32_pmovsxbd128 (v16qi)
8469 v2di __builtin_ia32_pmovsxbq128 (v16qi)
8470 v8hi __builtin_ia32_pmovsxbw128 (v16qi)
8471 v2di __builtin_ia32_pmovsxdq128 (v4si)
8472 v4si __builtin_ia32_pmovsxwd128 (v8hi)
8473 v2di __builtin_ia32_pmovsxwq128 (v8hi)
8474 v4si __builtin_ia32_pmovzxbd128 (v16qi)
8475 v2di __builtin_ia32_pmovzxbq128 (v16qi)
8476 v8hi __builtin_ia32_pmovzxbw128 (v16qi)
8477 v2di __builtin_ia32_pmovzxdq128 (v4si)
8478 v4si __builtin_ia32_pmovzxwd128 (v8hi)
8479 v2di __builtin_ia32_pmovzxwq128 (v8hi)
8480 v2di __builtin_ia32_pmuldq128 (v4si, v4si)
8481 v4si __builtin_ia32_pmulld128 (v4si, v4si)
8482 int __builtin_ia32_ptestc128 (v2di, v2di)
8483 int __builtin_ia32_ptestnzc128 (v2di, v2di)
8484 int __builtin_ia32_ptestz128 (v2di, v2di)
8485 v2df __builtin_ia32_roundpd (v2df, const int)
8486 v4sf __builtin_ia32_roundps (v4sf, const int)
8487 v2df __builtin_ia32_roundsd (v2df, v2df, const int)
8488 v4sf __builtin_ia32_roundss (v4sf, v4sf, const int)
8489 @end smallexample
8491 The following built-in functions are available when @option{-msse4.1} is
8492 used.
8494 @table @code
8495 @item v4sf __builtin_ia32_vec_set_v4sf (v4sf, float, const int)
8496 Generates the @code{insertps} machine instruction.
8497 @item int __builtin_ia32_vec_ext_v16qi (v16qi, const int)
8498 Generates the @code{pextrb} machine instruction.
8499 @item v16qi __builtin_ia32_vec_set_v16qi (v16qi, int, const int)
8500 Generates the @code{pinsrb} machine instruction.
8501 @item v4si __builtin_ia32_vec_set_v4si (v4si, int, const int)
8502 Generates the @code{pinsrd} machine instruction.
8503 @item v2di __builtin_ia32_vec_set_v2di (v2di, long long, const int)
8504 Generates the @code{pinsrq} machine instruction in 64bit mode.
8505 @end table
8507 The following built-in functions are changed to generate new SSE4.1
8508 instructions when @option{-msse4.1} is used.
8510 @table @code
8511 @item float __builtin_ia32_vec_ext_v4sf (v4sf, const int)
8512 Generates the @code{extractps} machine instruction.
8513 @item int __builtin_ia32_vec_ext_v4si (v4si, const int)
8514 Generates the @code{pextrd} machine instruction.
8515 @item long long __builtin_ia32_vec_ext_v2di (v2di, const int)
8516 Generates the @code{pextrq} machine instruction in 64bit mode.
8517 @end table
8519 The following built-in functions are available when @option{-msse4.2} is
8520 used.  All of them generate the machine instruction that is part of the
8521 name.
8523 @smallexample
8524 v16qi __builtin_ia32_pcmpestrm128 (v16qi, int, v16qi, int, const int)
8525 int __builtin_ia32_pcmpestri128 (v16qi, int, v16qi, int, const int)
8526 int __builtin_ia32_pcmpestria128 (v16qi, int, v16qi, int, const int)
8527 int __builtin_ia32_pcmpestric128 (v16qi, int, v16qi, int, const int)
8528 int __builtin_ia32_pcmpestrio128 (v16qi, int, v16qi, int, const int)
8529 int __builtin_ia32_pcmpestris128 (v16qi, int, v16qi, int, const int)
8530 int __builtin_ia32_pcmpestriz128 (v16qi, int, v16qi, int, const int)
8531 v16qi __builtin_ia32_pcmpistrm128 (v16qi, v16qi, const int)
8532 int __builtin_ia32_pcmpistri128 (v16qi, v16qi, const int)
8533 int __builtin_ia32_pcmpistria128 (v16qi, v16qi, const int)
8534 int __builtin_ia32_pcmpistric128 (v16qi, v16qi, const int)
8535 int __builtin_ia32_pcmpistrio128 (v16qi, v16qi, const int)
8536 int __builtin_ia32_pcmpistris128 (v16qi, v16qi, const int)
8537 int __builtin_ia32_pcmpistriz128 (v16qi, v16qi, const int)
8538 v2di __builtin_ia32_pcmpgtq (v2di, v2di)
8539 @end smallexample
8541 The following built-in functions are available when @option{-msse4.2} is
8542 used.
8544 @table @code
8545 @item unsigned int __builtin_ia32_crc32qi (unsigned int, unsigned char)
8546 Generates the @code{crc32b} machine instruction.
8547 @item unsigned int __builtin_ia32_crc32hi (unsigned int, unsigned short)
8548 Generates the @code{crc32w} machine instruction.
8549 @item unsigned int __builtin_ia32_crc32si (unsigned int, unsigned int)
8550 Generates the @code{crc32l} machine instruction.
8551 @item unsigned long long __builtin_ia32_crc32di (unsigned long long, unsigned long long)
8552 Generates the @code{crc32q} machine instruction.
8553 @end table
8555 The following built-in functions are changed to generate new SSE4.2
8556 instructions when @option{-msse4.2} is used.
8558 @table @code
8559 @item int __builtin_popcount (unsigned int)
8560 Generates the @code{popcntl} machine instruction.
8561 @item int __builtin_popcountl (unsigned long)
8562 Generates the @code{popcntl} or @code{popcntq} machine instruction,
8563 depending on the size of @code{unsigned long}.
8564 @item int __builtin_popcountll (unsigned long long)
8565 Generates the @code{popcntq} machine instruction.
8566 @end table
8568 The following built-in functions are available when @option{-mavx} is
8569 used. All of them generate the machine instruction that is part of the
8570 name.
8572 @smallexample
8573 v4df __builtin_ia32_addpd256 (v4df,v4df)
8574 v8sf __builtin_ia32_addps256 (v8sf,v8sf)
8575 v4df __builtin_ia32_addsubpd256 (v4df,v4df)
8576 v8sf __builtin_ia32_addsubps256 (v8sf,v8sf)
8577 v4df __builtin_ia32_andnpd256 (v4df,v4df)
8578 v8sf __builtin_ia32_andnps256 (v8sf,v8sf)
8579 v4df __builtin_ia32_andpd256 (v4df,v4df)
8580 v8sf __builtin_ia32_andps256 (v8sf,v8sf)
8581 v4df __builtin_ia32_blendpd256 (v4df,v4df,int)
8582 v8sf __builtin_ia32_blendps256 (v8sf,v8sf,int)
8583 v4df __builtin_ia32_blendvpd256 (v4df,v4df,v4df)
8584 v8sf __builtin_ia32_blendvps256 (v8sf,v8sf,v8sf)
8585 v2df __builtin_ia32_cmppd (v2df,v2df,int)
8586 v4df __builtin_ia32_cmppd256 (v4df,v4df,int)
8587 v4sf __builtin_ia32_cmpps (v4sf,v4sf,int)
8588 v8sf __builtin_ia32_cmpps256 (v8sf,v8sf,int)
8589 v2df __builtin_ia32_cmpsd (v2df,v2df,int)
8590 v4sf __builtin_ia32_cmpss (v4sf,v4sf,int)
8591 v4df __builtin_ia32_cvtdq2pd256 (v4si)
8592 v8sf __builtin_ia32_cvtdq2ps256 (v8si)
8593 v4si __builtin_ia32_cvtpd2dq256 (v4df)
8594 v4sf __builtin_ia32_cvtpd2ps256 (v4df)
8595 v8si __builtin_ia32_cvtps2dq256 (v8sf)
8596 v4df __builtin_ia32_cvtps2pd256 (v4sf)
8597 v4si __builtin_ia32_cvttpd2dq256 (v4df)
8598 v8si __builtin_ia32_cvttps2dq256 (v8sf)
8599 v4df __builtin_ia32_divpd256 (v4df,v4df)
8600 v8sf __builtin_ia32_divps256 (v8sf,v8sf)
8601 v8sf __builtin_ia32_dpps256 (v8sf,v8sf,int)
8602 v4df __builtin_ia32_haddpd256 (v4df,v4df)
8603 v8sf __builtin_ia32_haddps256 (v8sf,v8sf)
8604 v4df __builtin_ia32_hsubpd256 (v4df,v4df)
8605 v8sf __builtin_ia32_hsubps256 (v8sf,v8sf)
8606 v32qi __builtin_ia32_lddqu256 (pcchar)
8607 v32qi __builtin_ia32_loaddqu256 (pcchar)
8608 v4df __builtin_ia32_loadupd256 (pcdouble)
8609 v8sf __builtin_ia32_loadups256 (pcfloat)
8610 v2df __builtin_ia32_maskloadpd (pcv2df,v2df)
8611 v4df __builtin_ia32_maskloadpd256 (pcv4df,v4df)
8612 v4sf __builtin_ia32_maskloadps (pcv4sf,v4sf)
8613 v8sf __builtin_ia32_maskloadps256 (pcv8sf,v8sf)
8614 void __builtin_ia32_maskstorepd (pv2df,v2df,v2df)
8615 void __builtin_ia32_maskstorepd256 (pv4df,v4df,v4df)
8616 void __builtin_ia32_maskstoreps (pv4sf,v4sf,v4sf)
8617 void __builtin_ia32_maskstoreps256 (pv8sf,v8sf,v8sf)
8618 v4df __builtin_ia32_maxpd256 (v4df,v4df)
8619 v8sf __builtin_ia32_maxps256 (v8sf,v8sf)
8620 v4df __builtin_ia32_minpd256 (v4df,v4df)
8621 v8sf __builtin_ia32_minps256 (v8sf,v8sf)
8622 v4df __builtin_ia32_movddup256 (v4df)
8623 int __builtin_ia32_movmskpd256 (v4df)
8624 int __builtin_ia32_movmskps256 (v8sf)
8625 v8sf __builtin_ia32_movshdup256 (v8sf)
8626 v8sf __builtin_ia32_movsldup256 (v8sf)
8627 v4df __builtin_ia32_mulpd256 (v4df,v4df)
8628 v8sf __builtin_ia32_mulps256 (v8sf,v8sf)
8629 v4df __builtin_ia32_orpd256 (v4df,v4df)
8630 v8sf __builtin_ia32_orps256 (v8sf,v8sf)
8631 v2df __builtin_ia32_pd_pd256 (v4df)
8632 v4df __builtin_ia32_pd256_pd (v2df)
8633 v4sf __builtin_ia32_ps_ps256 (v8sf)
8634 v8sf __builtin_ia32_ps256_ps (v4sf)
8635 int __builtin_ia32_ptestc256 (v4di,v4di,ptest)
8636 int __builtin_ia32_ptestnzc256 (v4di,v4di,ptest)
8637 int __builtin_ia32_ptestz256 (v4di,v4di,ptest)
8638 v8sf __builtin_ia32_rcpps256 (v8sf)
8639 v4df __builtin_ia32_roundpd256 (v4df,int)
8640 v8sf __builtin_ia32_roundps256 (v8sf,int)
8641 v8sf __builtin_ia32_rsqrtps_nr256 (v8sf)
8642 v8sf __builtin_ia32_rsqrtps256 (v8sf)
8643 v4df __builtin_ia32_shufpd256 (v4df,v4df,int)
8644 v8sf __builtin_ia32_shufps256 (v8sf,v8sf,int)
8645 v4si __builtin_ia32_si_si256 (v8si)
8646 v8si __builtin_ia32_si256_si (v4si)
8647 v4df __builtin_ia32_sqrtpd256 (v4df)
8648 v8sf __builtin_ia32_sqrtps_nr256 (v8sf)
8649 v8sf __builtin_ia32_sqrtps256 (v8sf)
8650 void __builtin_ia32_storedqu256 (pchar,v32qi)
8651 void __builtin_ia32_storeupd256 (pdouble,v4df)
8652 void __builtin_ia32_storeups256 (pfloat,v8sf)
8653 v4df __builtin_ia32_subpd256 (v4df,v4df)
8654 v8sf __builtin_ia32_subps256 (v8sf,v8sf)
8655 v4df __builtin_ia32_unpckhpd256 (v4df,v4df)
8656 v8sf __builtin_ia32_unpckhps256 (v8sf,v8sf)
8657 v4df __builtin_ia32_unpcklpd256 (v4df,v4df)
8658 v8sf __builtin_ia32_unpcklps256 (v8sf,v8sf)
8659 v4df __builtin_ia32_vbroadcastf128_pd256 (pcv2df)
8660 v8sf __builtin_ia32_vbroadcastf128_ps256 (pcv4sf)
8661 v4df __builtin_ia32_vbroadcastsd256 (pcdouble)
8662 v4sf __builtin_ia32_vbroadcastss (pcfloat)
8663 v8sf __builtin_ia32_vbroadcastss256 (pcfloat)
8664 v2df __builtin_ia32_vextractf128_pd256 (v4df,int)
8665 v4sf __builtin_ia32_vextractf128_ps256 (v8sf,int)
8666 v4si __builtin_ia32_vextractf128_si256 (v8si,int)
8667 v4df __builtin_ia32_vinsertf128_pd256 (v4df,v2df,int)
8668 v8sf __builtin_ia32_vinsertf128_ps256 (v8sf,v4sf,int)
8669 v8si __builtin_ia32_vinsertf128_si256 (v8si,v4si,int)
8670 v4df __builtin_ia32_vperm2f128_pd256 (v4df,v4df,int)
8671 v8sf __builtin_ia32_vperm2f128_ps256 (v8sf,v8sf,int)
8672 v8si __builtin_ia32_vperm2f128_si256 (v8si,v8si,int)
8673 v2df __builtin_ia32_vpermil2pd (v2df,v2df,v2di,int)
8674 v4df __builtin_ia32_vpermil2pd256 (v4df,v4df,v4di,int)
8675 v4sf __builtin_ia32_vpermil2ps (v4sf,v4sf,v4si,int)
8676 v8sf __builtin_ia32_vpermil2ps256 (v8sf,v8sf,v8si,int)
8677 v2df __builtin_ia32_vpermilpd (v2df,int)
8678 v4df __builtin_ia32_vpermilpd256 (v4df,int)
8679 v4sf __builtin_ia32_vpermilps (v4sf,int)
8680 v8sf __builtin_ia32_vpermilps256 (v8sf,int)
8681 v2df __builtin_ia32_vpermilvarpd (v2df,v2di)
8682 v4df __builtin_ia32_vpermilvarpd256 (v4df,v4di)
8683 v4sf __builtin_ia32_vpermilvarps (v4sf,v4si)
8684 v8sf __builtin_ia32_vpermilvarps256 (v8sf,v8si)
8685 int __builtin_ia32_vtestcpd (v2df,v2df,ptest)
8686 int __builtin_ia32_vtestcpd256 (v4df,v4df,ptest)
8687 int __builtin_ia32_vtestcps (v4sf,v4sf,ptest)
8688 int __builtin_ia32_vtestcps256 (v8sf,v8sf,ptest)
8689 int __builtin_ia32_vtestnzcpd (v2df,v2df,ptest)
8690 int __builtin_ia32_vtestnzcpd256 (v4df,v4df,ptest)
8691 int __builtin_ia32_vtestnzcps (v4sf,v4sf,ptest)
8692 int __builtin_ia32_vtestnzcps256 (v8sf,v8sf,ptest)
8693 int __builtin_ia32_vtestzpd (v2df,v2df,ptest)
8694 int __builtin_ia32_vtestzpd256 (v4df,v4df,ptest)
8695 int __builtin_ia32_vtestzps (v4sf,v4sf,ptest)
8696 int __builtin_ia32_vtestzps256 (v8sf,v8sf,ptest)
8697 void __builtin_ia32_vzeroall (void)
8698 void __builtin_ia32_vzeroupper (void)
8699 v4df __builtin_ia32_xorpd256 (v4df,v4df)
8700 v8sf __builtin_ia32_xorps256 (v8sf,v8sf)
8701 @end smallexample
8703 The following built-in functions are available when @option{-maes} is
8704 used.  All of them generate the machine instruction that is part of the
8705 name.
8707 @smallexample
8708 v2di __builtin_ia32_aesenc128 (v2di, v2di)
8709 v2di __builtin_ia32_aesenclast128 (v2di, v2di)
8710 v2di __builtin_ia32_aesdec128 (v2di, v2di)
8711 v2di __builtin_ia32_aesdeclast128 (v2di, v2di)
8712 v2di __builtin_ia32_aeskeygenassist128 (v2di, const int)
8713 v2di __builtin_ia32_aesimc128 (v2di)
8714 @end smallexample
8716 The following built-in function is available when @option{-mpclmul} is
8717 used.
8719 @table @code
8720 @item v2di __builtin_ia32_pclmulqdq128 (v2di, v2di, const int)
8721 Generates the @code{pclmulqdq} machine instruction.
8722 @end table
8724 The following built-in functions are available when @option{-msse4a} is used.
8725 All of them generate the machine instruction that is part of the name.
8727 @smallexample
8728 void __builtin_ia32_movntsd (double *, v2df)
8729 void __builtin_ia32_movntss (float *, v4sf)
8730 v2di __builtin_ia32_extrq  (v2di, v16qi)
8731 v2di __builtin_ia32_extrqi (v2di, const unsigned int, const unsigned int)
8732 v2di __builtin_ia32_insertq (v2di, v2di)
8733 v2di __builtin_ia32_insertqi (v2di, v2di, const unsigned int, const unsigned int)
8734 @end smallexample
8736 The following built-in functions are available when @option{-msse5} is used.
8737 All of them generate the machine instruction that is part of the name
8738 with MMX registers.
8740 @smallexample
8741 v2df __builtin_ia32_comeqpd (v2df, v2df)
8742 v2df __builtin_ia32_comeqps (v2df, v2df)
8743 v4sf __builtin_ia32_comeqsd (v4sf, v4sf)
8744 v4sf __builtin_ia32_comeqss (v4sf, v4sf)
8745 v2df __builtin_ia32_comfalsepd (v2df, v2df)
8746 v2df __builtin_ia32_comfalseps (v2df, v2df)
8747 v4sf __builtin_ia32_comfalsesd (v4sf, v4sf)
8748 v4sf __builtin_ia32_comfalsess (v4sf, v4sf)
8749 v2df __builtin_ia32_comgepd (v2df, v2df)
8750 v2df __builtin_ia32_comgeps (v2df, v2df)
8751 v4sf __builtin_ia32_comgesd (v4sf, v4sf)
8752 v4sf __builtin_ia32_comgess (v4sf, v4sf)
8753 v2df __builtin_ia32_comgtpd (v2df, v2df)
8754 v2df __builtin_ia32_comgtps (v2df, v2df)
8755 v4sf __builtin_ia32_comgtsd (v4sf, v4sf)
8756 v4sf __builtin_ia32_comgtss (v4sf, v4sf)
8757 v2df __builtin_ia32_comlepd (v2df, v2df)
8758 v2df __builtin_ia32_comleps (v2df, v2df)
8759 v4sf __builtin_ia32_comlesd (v4sf, v4sf)
8760 v4sf __builtin_ia32_comless (v4sf, v4sf)
8761 v2df __builtin_ia32_comltpd (v2df, v2df)
8762 v2df __builtin_ia32_comltps (v2df, v2df)
8763 v4sf __builtin_ia32_comltsd (v4sf, v4sf)
8764 v4sf __builtin_ia32_comltss (v4sf, v4sf)
8765 v2df __builtin_ia32_comnepd (v2df, v2df)
8766 v2df __builtin_ia32_comneps (v2df, v2df)
8767 v4sf __builtin_ia32_comnesd (v4sf, v4sf)
8768 v4sf __builtin_ia32_comness (v4sf, v4sf)
8769 v2df __builtin_ia32_comordpd (v2df, v2df)
8770 v2df __builtin_ia32_comordps (v2df, v2df)
8771 v4sf __builtin_ia32_comordsd (v4sf, v4sf)
8772 v4sf __builtin_ia32_comordss (v4sf, v4sf)
8773 v2df __builtin_ia32_comtruepd (v2df, v2df)
8774 v2df __builtin_ia32_comtrueps (v2df, v2df)
8775 v4sf __builtin_ia32_comtruesd (v4sf, v4sf)
8776 v4sf __builtin_ia32_comtruess (v4sf, v4sf)
8777 v2df __builtin_ia32_comueqpd (v2df, v2df)
8778 v2df __builtin_ia32_comueqps (v2df, v2df)
8779 v4sf __builtin_ia32_comueqsd (v4sf, v4sf)
8780 v4sf __builtin_ia32_comueqss (v4sf, v4sf)
8781 v2df __builtin_ia32_comugepd (v2df, v2df)
8782 v2df __builtin_ia32_comugeps (v2df, v2df)
8783 v4sf __builtin_ia32_comugesd (v4sf, v4sf)
8784 v4sf __builtin_ia32_comugess (v4sf, v4sf)
8785 v2df __builtin_ia32_comugtpd (v2df, v2df)
8786 v2df __builtin_ia32_comugtps (v2df, v2df)
8787 v4sf __builtin_ia32_comugtsd (v4sf, v4sf)
8788 v4sf __builtin_ia32_comugtss (v4sf, v4sf)
8789 v2df __builtin_ia32_comulepd (v2df, v2df)
8790 v2df __builtin_ia32_comuleps (v2df, v2df)
8791 v4sf __builtin_ia32_comulesd (v4sf, v4sf)
8792 v4sf __builtin_ia32_comuless (v4sf, v4sf)
8793 v2df __builtin_ia32_comultpd (v2df, v2df)
8794 v2df __builtin_ia32_comultps (v2df, v2df)
8795 v4sf __builtin_ia32_comultsd (v4sf, v4sf)
8796 v4sf __builtin_ia32_comultss (v4sf, v4sf)
8797 v2df __builtin_ia32_comunepd (v2df, v2df)
8798 v2df __builtin_ia32_comuneps (v2df, v2df)
8799 v4sf __builtin_ia32_comunesd (v4sf, v4sf)
8800 v4sf __builtin_ia32_comuness (v4sf, v4sf)
8801 v2df __builtin_ia32_comunordpd (v2df, v2df)
8802 v2df __builtin_ia32_comunordps (v2df, v2df)
8803 v4sf __builtin_ia32_comunordsd (v4sf, v4sf)
8804 v4sf __builtin_ia32_comunordss (v4sf, v4sf)
8805 v2df __builtin_ia32_fmaddpd (v2df, v2df, v2df)
8806 v4sf __builtin_ia32_fmaddps (v4sf, v4sf, v4sf)
8807 v2df __builtin_ia32_fmaddsd (v2df, v2df, v2df)
8808 v4sf __builtin_ia32_fmaddss (v4sf, v4sf, v4sf)
8809 v2df __builtin_ia32_fmsubpd (v2df, v2df, v2df)
8810 v4sf __builtin_ia32_fmsubps (v4sf, v4sf, v4sf)
8811 v2df __builtin_ia32_fmsubsd (v2df, v2df, v2df)
8812 v4sf __builtin_ia32_fmsubss (v4sf, v4sf, v4sf)
8813 v2df __builtin_ia32_fnmaddpd (v2df, v2df, v2df)
8814 v4sf __builtin_ia32_fnmaddps (v4sf, v4sf, v4sf)
8815 v2df __builtin_ia32_fnmaddsd (v2df, v2df, v2df)
8816 v4sf __builtin_ia32_fnmaddss (v4sf, v4sf, v4sf)
8817 v2df __builtin_ia32_fnmsubpd (v2df, v2df, v2df)
8818 v4sf __builtin_ia32_fnmsubps (v4sf, v4sf, v4sf)
8819 v2df __builtin_ia32_fnmsubsd (v2df, v2df, v2df)
8820 v4sf __builtin_ia32_fnmsubss (v4sf, v4sf, v4sf)
8821 v2df __builtin_ia32_frczpd (v2df)
8822 v4sf __builtin_ia32_frczps (v4sf)
8823 v2df __builtin_ia32_frczsd (v2df, v2df)
8824 v4sf __builtin_ia32_frczss (v4sf, v4sf)
8825 v2di __builtin_ia32_pcmov (v2di, v2di, v2di)
8826 v2di __builtin_ia32_pcmov_v2di (v2di, v2di, v2di)
8827 v4si __builtin_ia32_pcmov_v4si (v4si, v4si, v4si)
8828 v8hi __builtin_ia32_pcmov_v8hi (v8hi, v8hi, v8hi)
8829 v16qi __builtin_ia32_pcmov_v16qi (v16qi, v16qi, v16qi)
8830 v2df __builtin_ia32_pcmov_v2df (v2df, v2df, v2df)
8831 v4sf __builtin_ia32_pcmov_v4sf (v4sf, v4sf, v4sf)
8832 v16qi __builtin_ia32_pcomeqb (v16qi, v16qi)
8833 v8hi __builtin_ia32_pcomeqw (v8hi, v8hi)
8834 v4si __builtin_ia32_pcomeqd (v4si, v4si)
8835 v2di __builtin_ia32_pcomeqq (v2di, v2di)
8836 v16qi __builtin_ia32_pcomequb (v16qi, v16qi)
8837 v4si __builtin_ia32_pcomequd (v4si, v4si)
8838 v2di __builtin_ia32_pcomequq (v2di, v2di)
8839 v8hi __builtin_ia32_pcomequw (v8hi, v8hi)
8840 v8hi __builtin_ia32_pcomeqw (v8hi, v8hi)
8841 v16qi __builtin_ia32_pcomfalseb (v16qi, v16qi)
8842 v4si __builtin_ia32_pcomfalsed (v4si, v4si)
8843 v2di __builtin_ia32_pcomfalseq (v2di, v2di)
8844 v16qi __builtin_ia32_pcomfalseub (v16qi, v16qi)
8845 v4si __builtin_ia32_pcomfalseud (v4si, v4si)
8846 v2di __builtin_ia32_pcomfalseuq (v2di, v2di)
8847 v8hi __builtin_ia32_pcomfalseuw (v8hi, v8hi)
8848 v8hi __builtin_ia32_pcomfalsew (v8hi, v8hi)
8849 v16qi __builtin_ia32_pcomgeb (v16qi, v16qi)
8850 v4si __builtin_ia32_pcomged (v4si, v4si)
8851 v2di __builtin_ia32_pcomgeq (v2di, v2di)
8852 v16qi __builtin_ia32_pcomgeub (v16qi, v16qi)
8853 v4si __builtin_ia32_pcomgeud (v4si, v4si)
8854 v2di __builtin_ia32_pcomgeuq (v2di, v2di)
8855 v8hi __builtin_ia32_pcomgeuw (v8hi, v8hi)
8856 v8hi __builtin_ia32_pcomgew (v8hi, v8hi)
8857 v16qi __builtin_ia32_pcomgtb (v16qi, v16qi)
8858 v4si __builtin_ia32_pcomgtd (v4si, v4si)
8859 v2di __builtin_ia32_pcomgtq (v2di, v2di)
8860 v16qi __builtin_ia32_pcomgtub (v16qi, v16qi)
8861 v4si __builtin_ia32_pcomgtud (v4si, v4si)
8862 v2di __builtin_ia32_pcomgtuq (v2di, v2di)
8863 v8hi __builtin_ia32_pcomgtuw (v8hi, v8hi)
8864 v8hi __builtin_ia32_pcomgtw (v8hi, v8hi)
8865 v16qi __builtin_ia32_pcomleb (v16qi, v16qi)
8866 v4si __builtin_ia32_pcomled (v4si, v4si)
8867 v2di __builtin_ia32_pcomleq (v2di, v2di)
8868 v16qi __builtin_ia32_pcomleub (v16qi, v16qi)
8869 v4si __builtin_ia32_pcomleud (v4si, v4si)
8870 v2di __builtin_ia32_pcomleuq (v2di, v2di)
8871 v8hi __builtin_ia32_pcomleuw (v8hi, v8hi)
8872 v8hi __builtin_ia32_pcomlew (v8hi, v8hi)
8873 v16qi __builtin_ia32_pcomltb (v16qi, v16qi)
8874 v4si __builtin_ia32_pcomltd (v4si, v4si)
8875 v2di __builtin_ia32_pcomltq (v2di, v2di)
8876 v16qi __builtin_ia32_pcomltub (v16qi, v16qi)
8877 v4si __builtin_ia32_pcomltud (v4si, v4si)
8878 v2di __builtin_ia32_pcomltuq (v2di, v2di)
8879 v8hi __builtin_ia32_pcomltuw (v8hi, v8hi)
8880 v8hi __builtin_ia32_pcomltw (v8hi, v8hi)
8881 v16qi __builtin_ia32_pcomneb (v16qi, v16qi)
8882 v4si __builtin_ia32_pcomned (v4si, v4si)
8883 v2di __builtin_ia32_pcomneq (v2di, v2di)
8884 v16qi __builtin_ia32_pcomneub (v16qi, v16qi)
8885 v4si __builtin_ia32_pcomneud (v4si, v4si)
8886 v2di __builtin_ia32_pcomneuq (v2di, v2di)
8887 v8hi __builtin_ia32_pcomneuw (v8hi, v8hi)
8888 v8hi __builtin_ia32_pcomnew (v8hi, v8hi)
8889 v16qi __builtin_ia32_pcomtrueb (v16qi, v16qi)
8890 v4si __builtin_ia32_pcomtrued (v4si, v4si)
8891 v2di __builtin_ia32_pcomtrueq (v2di, v2di)
8892 v16qi __builtin_ia32_pcomtrueub (v16qi, v16qi)
8893 v4si __builtin_ia32_pcomtrueud (v4si, v4si)
8894 v2di __builtin_ia32_pcomtrueuq (v2di, v2di)
8895 v8hi __builtin_ia32_pcomtrueuw (v8hi, v8hi)
8896 v8hi __builtin_ia32_pcomtruew (v8hi, v8hi)
8897 v4df __builtin_ia32_permpd (v2df, v2df, v16qi)
8898 v4sf __builtin_ia32_permps (v4sf, v4sf, v16qi)
8899 v4si __builtin_ia32_phaddbd (v16qi)
8900 v2di __builtin_ia32_phaddbq (v16qi)
8901 v8hi __builtin_ia32_phaddbw (v16qi)
8902 v2di __builtin_ia32_phadddq (v4si)
8903 v4si __builtin_ia32_phaddubd (v16qi)
8904 v2di __builtin_ia32_phaddubq (v16qi)
8905 v8hi __builtin_ia32_phaddubw (v16qi)
8906 v2di __builtin_ia32_phaddudq (v4si)
8907 v4si __builtin_ia32_phadduwd (v8hi)
8908 v2di __builtin_ia32_phadduwq (v8hi)
8909 v4si __builtin_ia32_phaddwd (v8hi)
8910 v2di __builtin_ia32_phaddwq (v8hi)
8911 v8hi __builtin_ia32_phsubbw (v16qi)
8912 v2di __builtin_ia32_phsubdq (v4si)
8913 v4si __builtin_ia32_phsubwd (v8hi)
8914 v4si __builtin_ia32_pmacsdd (v4si, v4si, v4si)
8915 v2di __builtin_ia32_pmacsdqh (v4si, v4si, v2di)
8916 v2di __builtin_ia32_pmacsdql (v4si, v4si, v2di)
8917 v4si __builtin_ia32_pmacssdd (v4si, v4si, v4si)
8918 v2di __builtin_ia32_pmacssdqh (v4si, v4si, v2di)
8919 v2di __builtin_ia32_pmacssdql (v4si, v4si, v2di)
8920 v4si __builtin_ia32_pmacsswd (v8hi, v8hi, v4si)
8921 v8hi __builtin_ia32_pmacssww (v8hi, v8hi, v8hi)
8922 v4si __builtin_ia32_pmacswd (v8hi, v8hi, v4si)
8923 v8hi __builtin_ia32_pmacsww (v8hi, v8hi, v8hi)
8924 v4si __builtin_ia32_pmadcsswd (v8hi, v8hi, v4si)
8925 v4si __builtin_ia32_pmadcswd (v8hi, v8hi, v4si)
8926 v16qi __builtin_ia32_pperm (v16qi, v16qi, v16qi)
8927 v16qi __builtin_ia32_protb (v16qi, v16qi)
8928 v4si __builtin_ia32_protd (v4si, v4si)
8929 v2di __builtin_ia32_protq (v2di, v2di)
8930 v8hi __builtin_ia32_protw (v8hi, v8hi)
8931 v16qi __builtin_ia32_pshab (v16qi, v16qi)
8932 v4si __builtin_ia32_pshad (v4si, v4si)
8933 v2di __builtin_ia32_pshaq (v2di, v2di)
8934 v8hi __builtin_ia32_pshaw (v8hi, v8hi)
8935 v16qi __builtin_ia32_pshlb (v16qi, v16qi)
8936 v4si __builtin_ia32_pshld (v4si, v4si)
8937 v2di __builtin_ia32_pshlq (v2di, v2di)
8938 v8hi __builtin_ia32_pshlw (v8hi, v8hi)
8939 @end smallexample
8941 The following builtin-in functions are available when @option{-msse5}
8942 is used.  The second argument must be an integer constant and generate
8943 the machine instruction that is part of the name with the @samp{_imm}
8944 suffix removed.
8946 @smallexample
8947 v16qi __builtin_ia32_protb_imm (v16qi, int)
8948 v4si __builtin_ia32_protd_imm (v4si, int)
8949 v2di __builtin_ia32_protq_imm (v2di, int)
8950 v8hi __builtin_ia32_protw_imm (v8hi, int)
8951 @end smallexample
8953 The following built-in functions are available when @option{-m3dnow} is used.
8954 All of them generate the machine instruction that is part of the name.
8956 @smallexample
8957 void __builtin_ia32_femms (void)
8958 v8qi __builtin_ia32_pavgusb (v8qi, v8qi)
8959 v2si __builtin_ia32_pf2id (v2sf)
8960 v2sf __builtin_ia32_pfacc (v2sf, v2sf)
8961 v2sf __builtin_ia32_pfadd (v2sf, v2sf)
8962 v2si __builtin_ia32_pfcmpeq (v2sf, v2sf)
8963 v2si __builtin_ia32_pfcmpge (v2sf, v2sf)
8964 v2si __builtin_ia32_pfcmpgt (v2sf, v2sf)
8965 v2sf __builtin_ia32_pfmax (v2sf, v2sf)
8966 v2sf __builtin_ia32_pfmin (v2sf, v2sf)
8967 v2sf __builtin_ia32_pfmul (v2sf, v2sf)
8968 v2sf __builtin_ia32_pfrcp (v2sf)
8969 v2sf __builtin_ia32_pfrcpit1 (v2sf, v2sf)
8970 v2sf __builtin_ia32_pfrcpit2 (v2sf, v2sf)
8971 v2sf __builtin_ia32_pfrsqrt (v2sf)
8972 v2sf __builtin_ia32_pfrsqrtit1 (v2sf, v2sf)
8973 v2sf __builtin_ia32_pfsub (v2sf, v2sf)
8974 v2sf __builtin_ia32_pfsubr (v2sf, v2sf)
8975 v2sf __builtin_ia32_pi2fd (v2si)
8976 v4hi __builtin_ia32_pmulhrw (v4hi, v4hi)
8977 @end smallexample
8979 The following built-in functions are available when both @option{-m3dnow}
8980 and @option{-march=athlon} are used.  All of them generate the machine
8981 instruction that is part of the name.
8983 @smallexample
8984 v2si __builtin_ia32_pf2iw (v2sf)
8985 v2sf __builtin_ia32_pfnacc (v2sf, v2sf)
8986 v2sf __builtin_ia32_pfpnacc (v2sf, v2sf)
8987 v2sf __builtin_ia32_pi2fw (v2si)
8988 v2sf __builtin_ia32_pswapdsf (v2sf)
8989 v2si __builtin_ia32_pswapdsi (v2si)
8990 @end smallexample
8992 @node MIPS DSP Built-in Functions
8993 @subsection MIPS DSP Built-in Functions
8995 The MIPS DSP Application-Specific Extension (ASE) includes new
8996 instructions that are designed to improve the performance of DSP and
8997 media applications.  It provides instructions that operate on packed
8998 8-bit/16-bit integer data, Q7, Q15 and Q31 fractional data.
9000 GCC supports MIPS DSP operations using both the generic
9001 vector extensions (@pxref{Vector Extensions}) and a collection of
9002 MIPS-specific built-in functions.  Both kinds of support are
9003 enabled by the @option{-mdsp} command-line option.
9005 Revision 2 of the ASE was introduced in the second half of 2006.
9006 This revision adds extra instructions to the original ASE, but is
9007 otherwise backwards-compatible with it.  You can select revision 2
9008 using the command-line option @option{-mdspr2}; this option implies
9009 @option{-mdsp}.
9011 The SCOUNT and POS bits of the DSP control register are global.  The
9012 WRDSP, EXTPDP, EXTPDPV and MTHLIP instructions modify the SCOUNT and
9013 POS bits.  During optimization, the compiler will not delete these
9014 instructions and it will not delete calls to functions containing
9015 these instructions.
9017 At present, GCC only provides support for operations on 32-bit
9018 vectors.  The vector type associated with 8-bit integer data is
9019 usually called @code{v4i8}, the vector type associated with Q7
9020 is usually called @code{v4q7}, the vector type associated with 16-bit
9021 integer data is usually called @code{v2i16}, and the vector type
9022 associated with Q15 is usually called @code{v2q15}.  They can be
9023 defined in C as follows:
9025 @smallexample
9026 typedef signed char v4i8 __attribute__ ((vector_size(4)));
9027 typedef signed char v4q7 __attribute__ ((vector_size(4)));
9028 typedef short v2i16 __attribute__ ((vector_size(4)));
9029 typedef short v2q15 __attribute__ ((vector_size(4)));
9030 @end smallexample
9032 @code{v4i8}, @code{v4q7}, @code{v2i16} and @code{v2q15} values are
9033 initialized in the same way as aggregates.  For example:
9035 @smallexample
9036 v4i8 a = @{1, 2, 3, 4@};
9037 v4i8 b;
9038 b = (v4i8) @{5, 6, 7, 8@};
9040 v2q15 c = @{0x0fcb, 0x3a75@};
9041 v2q15 d;
9042 d = (v2q15) @{0.1234 * 0x1.0p15, 0.4567 * 0x1.0p15@};
9043 @end smallexample
9045 @emph{Note:} The CPU's endianness determines the order in which values
9046 are packed.  On little-endian targets, the first value is the least
9047 significant and the last value is the most significant.  The opposite
9048 order applies to big-endian targets.  For example, the code above will
9049 set the lowest byte of @code{a} to @code{1} on little-endian targets
9050 and @code{4} on big-endian targets.
9052 @emph{Note:} Q7, Q15 and Q31 values must be initialized with their integer
9053 representation.  As shown in this example, the integer representation
9054 of a Q7 value can be obtained by multiplying the fractional value by
9055 @code{0x1.0p7}.  The equivalent for Q15 values is to multiply by
9056 @code{0x1.0p15}.  The equivalent for Q31 values is to multiply by
9057 @code{0x1.0p31}.
9059 The table below lists the @code{v4i8} and @code{v2q15} operations for which
9060 hardware support exists.  @code{a} and @code{b} are @code{v4i8} values,
9061 and @code{c} and @code{d} are @code{v2q15} values.
9063 @multitable @columnfractions .50 .50
9064 @item C code @tab MIPS instruction
9065 @item @code{a + b} @tab @code{addu.qb}
9066 @item @code{c + d} @tab @code{addq.ph}
9067 @item @code{a - b} @tab @code{subu.qb}
9068 @item @code{c - d} @tab @code{subq.ph}
9069 @end multitable
9071 The table below lists the @code{v2i16} operation for which
9072 hardware support exists for the DSP ASE REV 2.  @code{e} and @code{f} are
9073 @code{v2i16} values.
9075 @multitable @columnfractions .50 .50
9076 @item C code @tab MIPS instruction
9077 @item @code{e * f} @tab @code{mul.ph}
9078 @end multitable
9080 It is easier to describe the DSP built-in functions if we first define
9081 the following types:
9083 @smallexample
9084 typedef int q31;
9085 typedef int i32;
9086 typedef unsigned int ui32;
9087 typedef long long a64;
9088 @end smallexample
9090 @code{q31} and @code{i32} are actually the same as @code{int}, but we
9091 use @code{q31} to indicate a Q31 fractional value and @code{i32} to
9092 indicate a 32-bit integer value.  Similarly, @code{a64} is the same as
9093 @code{long long}, but we use @code{a64} to indicate values that will
9094 be placed in one of the four DSP accumulators (@code{$ac0},
9095 @code{$ac1}, @code{$ac2} or @code{$ac3}).
9097 Also, some built-in functions prefer or require immediate numbers as
9098 parameters, because the corresponding DSP instructions accept both immediate
9099 numbers and register operands, or accept immediate numbers only.  The
9100 immediate parameters are listed as follows.
9102 @smallexample
9103 imm0_3: 0 to 3.
9104 imm0_7: 0 to 7.
9105 imm0_15: 0 to 15.
9106 imm0_31: 0 to 31.
9107 imm0_63: 0 to 63.
9108 imm0_255: 0 to 255.
9109 imm_n32_31: -32 to 31.
9110 imm_n512_511: -512 to 511.
9111 @end smallexample
9113 The following built-in functions map directly to a particular MIPS DSP
9114 instruction.  Please refer to the architecture specification
9115 for details on what each instruction does.
9117 @smallexample
9118 v2q15 __builtin_mips_addq_ph (v2q15, v2q15)
9119 v2q15 __builtin_mips_addq_s_ph (v2q15, v2q15)
9120 q31 __builtin_mips_addq_s_w (q31, q31)
9121 v4i8 __builtin_mips_addu_qb (v4i8, v4i8)
9122 v4i8 __builtin_mips_addu_s_qb (v4i8, v4i8)
9123 v2q15 __builtin_mips_subq_ph (v2q15, v2q15)
9124 v2q15 __builtin_mips_subq_s_ph (v2q15, v2q15)
9125 q31 __builtin_mips_subq_s_w (q31, q31)
9126 v4i8 __builtin_mips_subu_qb (v4i8, v4i8)
9127 v4i8 __builtin_mips_subu_s_qb (v4i8, v4i8)
9128 i32 __builtin_mips_addsc (i32, i32)
9129 i32 __builtin_mips_addwc (i32, i32)
9130 i32 __builtin_mips_modsub (i32, i32)
9131 i32 __builtin_mips_raddu_w_qb (v4i8)
9132 v2q15 __builtin_mips_absq_s_ph (v2q15)
9133 q31 __builtin_mips_absq_s_w (q31)
9134 v4i8 __builtin_mips_precrq_qb_ph (v2q15, v2q15)
9135 v2q15 __builtin_mips_precrq_ph_w (q31, q31)
9136 v2q15 __builtin_mips_precrq_rs_ph_w (q31, q31)
9137 v4i8 __builtin_mips_precrqu_s_qb_ph (v2q15, v2q15)
9138 q31 __builtin_mips_preceq_w_phl (v2q15)
9139 q31 __builtin_mips_preceq_w_phr (v2q15)
9140 v2q15 __builtin_mips_precequ_ph_qbl (v4i8)
9141 v2q15 __builtin_mips_precequ_ph_qbr (v4i8)
9142 v2q15 __builtin_mips_precequ_ph_qbla (v4i8)
9143 v2q15 __builtin_mips_precequ_ph_qbra (v4i8)
9144 v2q15 __builtin_mips_preceu_ph_qbl (v4i8)
9145 v2q15 __builtin_mips_preceu_ph_qbr (v4i8)
9146 v2q15 __builtin_mips_preceu_ph_qbla (v4i8)
9147 v2q15 __builtin_mips_preceu_ph_qbra (v4i8)
9148 v4i8 __builtin_mips_shll_qb (v4i8, imm0_7)
9149 v4i8 __builtin_mips_shll_qb (v4i8, i32)
9150 v2q15 __builtin_mips_shll_ph (v2q15, imm0_15)
9151 v2q15 __builtin_mips_shll_ph (v2q15, i32)
9152 v2q15 __builtin_mips_shll_s_ph (v2q15, imm0_15)
9153 v2q15 __builtin_mips_shll_s_ph (v2q15, i32)
9154 q31 __builtin_mips_shll_s_w (q31, imm0_31)
9155 q31 __builtin_mips_shll_s_w (q31, i32)
9156 v4i8 __builtin_mips_shrl_qb (v4i8, imm0_7)
9157 v4i8 __builtin_mips_shrl_qb (v4i8, i32)
9158 v2q15 __builtin_mips_shra_ph (v2q15, imm0_15)
9159 v2q15 __builtin_mips_shra_ph (v2q15, i32)
9160 v2q15 __builtin_mips_shra_r_ph (v2q15, imm0_15)
9161 v2q15 __builtin_mips_shra_r_ph (v2q15, i32)
9162 q31 __builtin_mips_shra_r_w (q31, imm0_31)
9163 q31 __builtin_mips_shra_r_w (q31, i32)
9164 v2q15 __builtin_mips_muleu_s_ph_qbl (v4i8, v2q15)
9165 v2q15 __builtin_mips_muleu_s_ph_qbr (v4i8, v2q15)
9166 v2q15 __builtin_mips_mulq_rs_ph (v2q15, v2q15)
9167 q31 __builtin_mips_muleq_s_w_phl (v2q15, v2q15)
9168 q31 __builtin_mips_muleq_s_w_phr (v2q15, v2q15)
9169 a64 __builtin_mips_dpau_h_qbl (a64, v4i8, v4i8)
9170 a64 __builtin_mips_dpau_h_qbr (a64, v4i8, v4i8)
9171 a64 __builtin_mips_dpsu_h_qbl (a64, v4i8, v4i8)
9172 a64 __builtin_mips_dpsu_h_qbr (a64, v4i8, v4i8)
9173 a64 __builtin_mips_dpaq_s_w_ph (a64, v2q15, v2q15)
9174 a64 __builtin_mips_dpaq_sa_l_w (a64, q31, q31)
9175 a64 __builtin_mips_dpsq_s_w_ph (a64, v2q15, v2q15)
9176 a64 __builtin_mips_dpsq_sa_l_w (a64, q31, q31)
9177 a64 __builtin_mips_mulsaq_s_w_ph (a64, v2q15, v2q15)
9178 a64 __builtin_mips_maq_s_w_phl (a64, v2q15, v2q15)
9179 a64 __builtin_mips_maq_s_w_phr (a64, v2q15, v2q15)
9180 a64 __builtin_mips_maq_sa_w_phl (a64, v2q15, v2q15)
9181 a64 __builtin_mips_maq_sa_w_phr (a64, v2q15, v2q15)
9182 i32 __builtin_mips_bitrev (i32)
9183 i32 __builtin_mips_insv (i32, i32)
9184 v4i8 __builtin_mips_repl_qb (imm0_255)
9185 v4i8 __builtin_mips_repl_qb (i32)
9186 v2q15 __builtin_mips_repl_ph (imm_n512_511)
9187 v2q15 __builtin_mips_repl_ph (i32)
9188 void __builtin_mips_cmpu_eq_qb (v4i8, v4i8)
9189 void __builtin_mips_cmpu_lt_qb (v4i8, v4i8)
9190 void __builtin_mips_cmpu_le_qb (v4i8, v4i8)
9191 i32 __builtin_mips_cmpgu_eq_qb (v4i8, v4i8)
9192 i32 __builtin_mips_cmpgu_lt_qb (v4i8, v4i8)
9193 i32 __builtin_mips_cmpgu_le_qb (v4i8, v4i8)
9194 void __builtin_mips_cmp_eq_ph (v2q15, v2q15)
9195 void __builtin_mips_cmp_lt_ph (v2q15, v2q15)
9196 void __builtin_mips_cmp_le_ph (v2q15, v2q15)
9197 v4i8 __builtin_mips_pick_qb (v4i8, v4i8)
9198 v2q15 __builtin_mips_pick_ph (v2q15, v2q15)
9199 v2q15 __builtin_mips_packrl_ph (v2q15, v2q15)
9200 i32 __builtin_mips_extr_w (a64, imm0_31)
9201 i32 __builtin_mips_extr_w (a64, i32)
9202 i32 __builtin_mips_extr_r_w (a64, imm0_31)
9203 i32 __builtin_mips_extr_s_h (a64, i32)
9204 i32 __builtin_mips_extr_rs_w (a64, imm0_31)
9205 i32 __builtin_mips_extr_rs_w (a64, i32)
9206 i32 __builtin_mips_extr_s_h (a64, imm0_31)
9207 i32 __builtin_mips_extr_r_w (a64, i32)
9208 i32 __builtin_mips_extp (a64, imm0_31)
9209 i32 __builtin_mips_extp (a64, i32)
9210 i32 __builtin_mips_extpdp (a64, imm0_31)
9211 i32 __builtin_mips_extpdp (a64, i32)
9212 a64 __builtin_mips_shilo (a64, imm_n32_31)
9213 a64 __builtin_mips_shilo (a64, i32)
9214 a64 __builtin_mips_mthlip (a64, i32)
9215 void __builtin_mips_wrdsp (i32, imm0_63)
9216 i32 __builtin_mips_rddsp (imm0_63)
9217 i32 __builtin_mips_lbux (void *, i32)
9218 i32 __builtin_mips_lhx (void *, i32)
9219 i32 __builtin_mips_lwx (void *, i32)
9220 i32 __builtin_mips_bposge32 (void)
9221 @end smallexample
9223 The following built-in functions map directly to a particular MIPS DSP REV 2
9224 instruction.  Please refer to the architecture specification
9225 for details on what each instruction does.
9227 @smallexample
9228 v4q7 __builtin_mips_absq_s_qb (v4q7);
9229 v2i16 __builtin_mips_addu_ph (v2i16, v2i16);
9230 v2i16 __builtin_mips_addu_s_ph (v2i16, v2i16);
9231 v4i8 __builtin_mips_adduh_qb (v4i8, v4i8);
9232 v4i8 __builtin_mips_adduh_r_qb (v4i8, v4i8);
9233 i32 __builtin_mips_append (i32, i32, imm0_31);
9234 i32 __builtin_mips_balign (i32, i32, imm0_3);
9235 i32 __builtin_mips_cmpgdu_eq_qb (v4i8, v4i8);
9236 i32 __builtin_mips_cmpgdu_lt_qb (v4i8, v4i8);
9237 i32 __builtin_mips_cmpgdu_le_qb (v4i8, v4i8);
9238 a64 __builtin_mips_dpa_w_ph (a64, v2i16, v2i16);
9239 a64 __builtin_mips_dps_w_ph (a64, v2i16, v2i16);
9240 a64 __builtin_mips_madd (a64, i32, i32);
9241 a64 __builtin_mips_maddu (a64, ui32, ui32);
9242 a64 __builtin_mips_msub (a64, i32, i32);
9243 a64 __builtin_mips_msubu (a64, ui32, ui32);
9244 v2i16 __builtin_mips_mul_ph (v2i16, v2i16);
9245 v2i16 __builtin_mips_mul_s_ph (v2i16, v2i16);
9246 q31 __builtin_mips_mulq_rs_w (q31, q31);
9247 v2q15 __builtin_mips_mulq_s_ph (v2q15, v2q15);
9248 q31 __builtin_mips_mulq_s_w (q31, q31);
9249 a64 __builtin_mips_mulsa_w_ph (a64, v2i16, v2i16);
9250 a64 __builtin_mips_mult (i32, i32);
9251 a64 __builtin_mips_multu (ui32, ui32);
9252 v4i8 __builtin_mips_precr_qb_ph (v2i16, v2i16);
9253 v2i16 __builtin_mips_precr_sra_ph_w (i32, i32, imm0_31);
9254 v2i16 __builtin_mips_precr_sra_r_ph_w (i32, i32, imm0_31);
9255 i32 __builtin_mips_prepend (i32, i32, imm0_31);
9256 v4i8 __builtin_mips_shra_qb (v4i8, imm0_7);
9257 v4i8 __builtin_mips_shra_r_qb (v4i8, imm0_7);
9258 v4i8 __builtin_mips_shra_qb (v4i8, i32);
9259 v4i8 __builtin_mips_shra_r_qb (v4i8, i32);
9260 v2i16 __builtin_mips_shrl_ph (v2i16, imm0_15);
9261 v2i16 __builtin_mips_shrl_ph (v2i16, i32);
9262 v2i16 __builtin_mips_subu_ph (v2i16, v2i16);
9263 v2i16 __builtin_mips_subu_s_ph (v2i16, v2i16);
9264 v4i8 __builtin_mips_subuh_qb (v4i8, v4i8);
9265 v4i8 __builtin_mips_subuh_r_qb (v4i8, v4i8);
9266 v2q15 __builtin_mips_addqh_ph (v2q15, v2q15);
9267 v2q15 __builtin_mips_addqh_r_ph (v2q15, v2q15);
9268 q31 __builtin_mips_addqh_w (q31, q31);
9269 q31 __builtin_mips_addqh_r_w (q31, q31);
9270 v2q15 __builtin_mips_subqh_ph (v2q15, v2q15);
9271 v2q15 __builtin_mips_subqh_r_ph (v2q15, v2q15);
9272 q31 __builtin_mips_subqh_w (q31, q31);
9273 q31 __builtin_mips_subqh_r_w (q31, q31);
9274 a64 __builtin_mips_dpax_w_ph (a64, v2i16, v2i16);
9275 a64 __builtin_mips_dpsx_w_ph (a64, v2i16, v2i16);
9276 a64 __builtin_mips_dpaqx_s_w_ph (a64, v2q15, v2q15);
9277 a64 __builtin_mips_dpaqx_sa_w_ph (a64, v2q15, v2q15);
9278 a64 __builtin_mips_dpsqx_s_w_ph (a64, v2q15, v2q15);
9279 a64 __builtin_mips_dpsqx_sa_w_ph (a64, v2q15, v2q15);
9280 @end smallexample
9283 @node MIPS Paired-Single Support
9284 @subsection MIPS Paired-Single Support
9286 The MIPS64 architecture includes a number of instructions that
9287 operate on pairs of single-precision floating-point values.
9288 Each pair is packed into a 64-bit floating-point register,
9289 with one element being designated the ``upper half'' and
9290 the other being designated the ``lower half''.
9292 GCC supports paired-single operations using both the generic
9293 vector extensions (@pxref{Vector Extensions}) and a collection of
9294 MIPS-specific built-in functions.  Both kinds of support are
9295 enabled by the @option{-mpaired-single} command-line option.
9297 The vector type associated with paired-single values is usually
9298 called @code{v2sf}.  It can be defined in C as follows:
9300 @smallexample
9301 typedef float v2sf __attribute__ ((vector_size (8)));
9302 @end smallexample
9304 @code{v2sf} values are initialized in the same way as aggregates.
9305 For example:
9307 @smallexample
9308 v2sf a = @{1.5, 9.1@};
9309 v2sf b;
9310 float e, f;
9311 b = (v2sf) @{e, f@};
9312 @end smallexample
9314 @emph{Note:} The CPU's endianness determines which value is stored in
9315 the upper half of a register and which value is stored in the lower half.
9316 On little-endian targets, the first value is the lower one and the second
9317 value is the upper one.  The opposite order applies to big-endian targets.
9318 For example, the code above will set the lower half of @code{a} to
9319 @code{1.5} on little-endian targets and @code{9.1} on big-endian targets.
9321 @node MIPS Loongson Built-in Functions
9322 @subsection MIPS Loongson Built-in Functions
9324 GCC provides intrinsics to access the SIMD instructions provided by the
9325 ST Microelectronics Loongson-2E and -2F processors.  These intrinsics,
9326 available after inclusion of the @code{loongson.h} header file,
9327 operate on the following 64-bit vector types:
9329 @itemize
9330 @item @code{uint8x8_t}, a vector of eight unsigned 8-bit integers;
9331 @item @code{uint16x4_t}, a vector of four unsigned 16-bit integers;
9332 @item @code{uint32x2_t}, a vector of two unsigned 32-bit integers;
9333 @item @code{int8x8_t}, a vector of eight signed 8-bit integers;
9334 @item @code{int16x4_t}, a vector of four signed 16-bit integers;
9335 @item @code{int32x2_t}, a vector of two signed 32-bit integers.
9336 @end itemize
9338 The intrinsics provided are listed below; each is named after the
9339 machine instruction to which it corresponds, with suffixes added as
9340 appropriate to distinguish intrinsics that expand to the same machine
9341 instruction yet have different argument types.  Refer to the architecture
9342 documentation for a description of the functionality of each
9343 instruction.
9345 @smallexample
9346 int16x4_t packsswh (int32x2_t s, int32x2_t t);
9347 int8x8_t packsshb (int16x4_t s, int16x4_t t);
9348 uint8x8_t packushb (uint16x4_t s, uint16x4_t t);
9349 uint32x2_t paddw_u (uint32x2_t s, uint32x2_t t);
9350 uint16x4_t paddh_u (uint16x4_t s, uint16x4_t t);
9351 uint8x8_t paddb_u (uint8x8_t s, uint8x8_t t);
9352 int32x2_t paddw_s (int32x2_t s, int32x2_t t);
9353 int16x4_t paddh_s (int16x4_t s, int16x4_t t);
9354 int8x8_t paddb_s (int8x8_t s, int8x8_t t);
9355 uint64_t paddd_u (uint64_t s, uint64_t t);
9356 int64_t paddd_s (int64_t s, int64_t t);
9357 int16x4_t paddsh (int16x4_t s, int16x4_t t);
9358 int8x8_t paddsb (int8x8_t s, int8x8_t t);
9359 uint16x4_t paddush (uint16x4_t s, uint16x4_t t);
9360 uint8x8_t paddusb (uint8x8_t s, uint8x8_t t);
9361 uint64_t pandn_ud (uint64_t s, uint64_t t);
9362 uint32x2_t pandn_uw (uint32x2_t s, uint32x2_t t);
9363 uint16x4_t pandn_uh (uint16x4_t s, uint16x4_t t);
9364 uint8x8_t pandn_ub (uint8x8_t s, uint8x8_t t);
9365 int64_t pandn_sd (int64_t s, int64_t t);
9366 int32x2_t pandn_sw (int32x2_t s, int32x2_t t);
9367 int16x4_t pandn_sh (int16x4_t s, int16x4_t t);
9368 int8x8_t pandn_sb (int8x8_t s, int8x8_t t);
9369 uint16x4_t pavgh (uint16x4_t s, uint16x4_t t);
9370 uint8x8_t pavgb (uint8x8_t s, uint8x8_t t);
9371 uint32x2_t pcmpeqw_u (uint32x2_t s, uint32x2_t t);
9372 uint16x4_t pcmpeqh_u (uint16x4_t s, uint16x4_t t);
9373 uint8x8_t pcmpeqb_u (uint8x8_t s, uint8x8_t t);
9374 int32x2_t pcmpeqw_s (int32x2_t s, int32x2_t t);
9375 int16x4_t pcmpeqh_s (int16x4_t s, int16x4_t t);
9376 int8x8_t pcmpeqb_s (int8x8_t s, int8x8_t t);
9377 uint32x2_t pcmpgtw_u (uint32x2_t s, uint32x2_t t);
9378 uint16x4_t pcmpgth_u (uint16x4_t s, uint16x4_t t);
9379 uint8x8_t pcmpgtb_u (uint8x8_t s, uint8x8_t t);
9380 int32x2_t pcmpgtw_s (int32x2_t s, int32x2_t t);
9381 int16x4_t pcmpgth_s (int16x4_t s, int16x4_t t);
9382 int8x8_t pcmpgtb_s (int8x8_t s, int8x8_t t);
9383 uint16x4_t pextrh_u (uint16x4_t s, int field);
9384 int16x4_t pextrh_s (int16x4_t s, int field);
9385 uint16x4_t pinsrh_0_u (uint16x4_t s, uint16x4_t t);
9386 uint16x4_t pinsrh_1_u (uint16x4_t s, uint16x4_t t);
9387 uint16x4_t pinsrh_2_u (uint16x4_t s, uint16x4_t t);
9388 uint16x4_t pinsrh_3_u (uint16x4_t s, uint16x4_t t);
9389 int16x4_t pinsrh_0_s (int16x4_t s, int16x4_t t);
9390 int16x4_t pinsrh_1_s (int16x4_t s, int16x4_t t);
9391 int16x4_t pinsrh_2_s (int16x4_t s, int16x4_t t);
9392 int16x4_t pinsrh_3_s (int16x4_t s, int16x4_t t);
9393 int32x2_t pmaddhw (int16x4_t s, int16x4_t t);
9394 int16x4_t pmaxsh (int16x4_t s, int16x4_t t);
9395 uint8x8_t pmaxub (uint8x8_t s, uint8x8_t t);
9396 int16x4_t pminsh (int16x4_t s, int16x4_t t);
9397 uint8x8_t pminub (uint8x8_t s, uint8x8_t t);
9398 uint8x8_t pmovmskb_u (uint8x8_t s);
9399 int8x8_t pmovmskb_s (int8x8_t s);
9400 uint16x4_t pmulhuh (uint16x4_t s, uint16x4_t t);
9401 int16x4_t pmulhh (int16x4_t s, int16x4_t t);
9402 int16x4_t pmullh (int16x4_t s, int16x4_t t);
9403 int64_t pmuluw (uint32x2_t s, uint32x2_t t);
9404 uint8x8_t pasubub (uint8x8_t s, uint8x8_t t);
9405 uint16x4_t biadd (uint8x8_t s);
9406 uint16x4_t psadbh (uint8x8_t s, uint8x8_t t);
9407 uint16x4_t pshufh_u (uint16x4_t dest, uint16x4_t s, uint8_t order);
9408 int16x4_t pshufh_s (int16x4_t dest, int16x4_t s, uint8_t order);
9409 uint16x4_t psllh_u (uint16x4_t s, uint8_t amount);
9410 int16x4_t psllh_s (int16x4_t s, uint8_t amount);
9411 uint32x2_t psllw_u (uint32x2_t s, uint8_t amount);
9412 int32x2_t psllw_s (int32x2_t s, uint8_t amount);
9413 uint16x4_t psrlh_u (uint16x4_t s, uint8_t amount);
9414 int16x4_t psrlh_s (int16x4_t s, uint8_t amount);
9415 uint32x2_t psrlw_u (uint32x2_t s, uint8_t amount);
9416 int32x2_t psrlw_s (int32x2_t s, uint8_t amount);
9417 uint16x4_t psrah_u (uint16x4_t s, uint8_t amount);
9418 int16x4_t psrah_s (int16x4_t s, uint8_t amount);
9419 uint32x2_t psraw_u (uint32x2_t s, uint8_t amount);
9420 int32x2_t psraw_s (int32x2_t s, uint8_t amount);
9421 uint32x2_t psubw_u (uint32x2_t s, uint32x2_t t);
9422 uint16x4_t psubh_u (uint16x4_t s, uint16x4_t t);
9423 uint8x8_t psubb_u (uint8x8_t s, uint8x8_t t);
9424 int32x2_t psubw_s (int32x2_t s, int32x2_t t);
9425 int16x4_t psubh_s (int16x4_t s, int16x4_t t);
9426 int8x8_t psubb_s (int8x8_t s, int8x8_t t);
9427 uint64_t psubd_u (uint64_t s, uint64_t t);
9428 int64_t psubd_s (int64_t s, int64_t t);
9429 int16x4_t psubsh (int16x4_t s, int16x4_t t);
9430 int8x8_t psubsb (int8x8_t s, int8x8_t t);
9431 uint16x4_t psubush (uint16x4_t s, uint16x4_t t);
9432 uint8x8_t psubusb (uint8x8_t s, uint8x8_t t);
9433 uint32x2_t punpckhwd_u (uint32x2_t s, uint32x2_t t);
9434 uint16x4_t punpckhhw_u (uint16x4_t s, uint16x4_t t);
9435 uint8x8_t punpckhbh_u (uint8x8_t s, uint8x8_t t);
9436 int32x2_t punpckhwd_s (int32x2_t s, int32x2_t t);
9437 int16x4_t punpckhhw_s (int16x4_t s, int16x4_t t);
9438 int8x8_t punpckhbh_s (int8x8_t s, int8x8_t t);
9439 uint32x2_t punpcklwd_u (uint32x2_t s, uint32x2_t t);
9440 uint16x4_t punpcklhw_u (uint16x4_t s, uint16x4_t t);
9441 uint8x8_t punpcklbh_u (uint8x8_t s, uint8x8_t t);
9442 int32x2_t punpcklwd_s (int32x2_t s, int32x2_t t);
9443 int16x4_t punpcklhw_s (int16x4_t s, int16x4_t t);
9444 int8x8_t punpcklbh_s (int8x8_t s, int8x8_t t);
9445 @end smallexample
9447 @menu
9448 * Paired-Single Arithmetic::
9449 * Paired-Single Built-in Functions::
9450 * MIPS-3D Built-in Functions::
9451 @end menu
9453 @node Paired-Single Arithmetic
9454 @subsubsection Paired-Single Arithmetic
9456 The table below lists the @code{v2sf} operations for which hardware
9457 support exists.  @code{a}, @code{b} and @code{c} are @code{v2sf}
9458 values and @code{x} is an integral value.
9460 @multitable @columnfractions .50 .50
9461 @item C code @tab MIPS instruction
9462 @item @code{a + b} @tab @code{add.ps}
9463 @item @code{a - b} @tab @code{sub.ps}
9464 @item @code{-a} @tab @code{neg.ps}
9465 @item @code{a * b} @tab @code{mul.ps}
9466 @item @code{a * b + c} @tab @code{madd.ps}
9467 @item @code{a * b - c} @tab @code{msub.ps}
9468 @item @code{-(a * b + c)} @tab @code{nmadd.ps}
9469 @item @code{-(a * b - c)} @tab @code{nmsub.ps}
9470 @item @code{x ? a : b} @tab @code{movn.ps}/@code{movz.ps}
9471 @end multitable
9473 Note that the multiply-accumulate instructions can be disabled
9474 using the command-line option @code{-mno-fused-madd}.
9476 @node Paired-Single Built-in Functions
9477 @subsubsection Paired-Single Built-in Functions
9479 The following paired-single functions map directly to a particular
9480 MIPS instruction.  Please refer to the architecture specification
9481 for details on what each instruction does.
9483 @table @code
9484 @item v2sf __builtin_mips_pll_ps (v2sf, v2sf)
9485 Pair lower lower (@code{pll.ps}).
9487 @item v2sf __builtin_mips_pul_ps (v2sf, v2sf)
9488 Pair upper lower (@code{pul.ps}).
9490 @item v2sf __builtin_mips_plu_ps (v2sf, v2sf)
9491 Pair lower upper (@code{plu.ps}).
9493 @item v2sf __builtin_mips_puu_ps (v2sf, v2sf)
9494 Pair upper upper (@code{puu.ps}).
9496 @item v2sf __builtin_mips_cvt_ps_s (float, float)
9497 Convert pair to paired single (@code{cvt.ps.s}).
9499 @item float __builtin_mips_cvt_s_pl (v2sf)
9500 Convert pair lower to single (@code{cvt.s.pl}).
9502 @item float __builtin_mips_cvt_s_pu (v2sf)
9503 Convert pair upper to single (@code{cvt.s.pu}).
9505 @item v2sf __builtin_mips_abs_ps (v2sf)
9506 Absolute value (@code{abs.ps}).
9508 @item v2sf __builtin_mips_alnv_ps (v2sf, v2sf, int)
9509 Align variable (@code{alnv.ps}).
9511 @emph{Note:} The value of the third parameter must be 0 or 4
9512 modulo 8, otherwise the result will be unpredictable.  Please read the
9513 instruction description for details.
9514 @end table
9516 The following multi-instruction functions are also available.
9517 In each case, @var{cond} can be any of the 16 floating-point conditions:
9518 @code{f}, @code{un}, @code{eq}, @code{ueq}, @code{olt}, @code{ult},
9519 @code{ole}, @code{ule}, @code{sf}, @code{ngle}, @code{seq}, @code{ngl},
9520 @code{lt}, @code{nge}, @code{le} or @code{ngt}.
9522 @table @code
9523 @item v2sf __builtin_mips_movt_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
9524 @itemx v2sf __builtin_mips_movf_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
9525 Conditional move based on floating point comparison (@code{c.@var{cond}.ps},
9526 @code{movt.ps}/@code{movf.ps}).
9528 The @code{movt} functions return the value @var{x} computed by:
9530 @smallexample
9531 c.@var{cond}.ps @var{cc},@var{a},@var{b}
9532 mov.ps @var{x},@var{c}
9533 movt.ps @var{x},@var{d},@var{cc}
9534 @end smallexample
9536 The @code{movf} functions are similar but use @code{movf.ps} instead
9537 of @code{movt.ps}.
9539 @item int __builtin_mips_upper_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
9540 @itemx int __builtin_mips_lower_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
9541 Comparison of two paired-single values (@code{c.@var{cond}.ps},
9542 @code{bc1t}/@code{bc1f}).
9544 These functions compare @var{a} and @var{b} using @code{c.@var{cond}.ps}
9545 and return either the upper or lower half of the result.  For example:
9547 @smallexample
9548 v2sf a, b;
9549 if (__builtin_mips_upper_c_eq_ps (a, b))
9550   upper_halves_are_equal ();
9551 else
9552   upper_halves_are_unequal ();
9554 if (__builtin_mips_lower_c_eq_ps (a, b))
9555   lower_halves_are_equal ();
9556 else
9557   lower_halves_are_unequal ();
9558 @end smallexample
9559 @end table
9561 @node MIPS-3D Built-in Functions
9562 @subsubsection MIPS-3D Built-in Functions
9564 The MIPS-3D Application-Specific Extension (ASE) includes additional
9565 paired-single instructions that are designed to improve the performance
9566 of 3D graphics operations.  Support for these instructions is controlled
9567 by the @option{-mips3d} command-line option.
9569 The functions listed below map directly to a particular MIPS-3D
9570 instruction.  Please refer to the architecture specification for
9571 more details on what each instruction does.
9573 @table @code
9574 @item v2sf __builtin_mips_addr_ps (v2sf, v2sf)
9575 Reduction add (@code{addr.ps}).
9577 @item v2sf __builtin_mips_mulr_ps (v2sf, v2sf)
9578 Reduction multiply (@code{mulr.ps}).
9580 @item v2sf __builtin_mips_cvt_pw_ps (v2sf)
9581 Convert paired single to paired word (@code{cvt.pw.ps}).
9583 @item v2sf __builtin_mips_cvt_ps_pw (v2sf)
9584 Convert paired word to paired single (@code{cvt.ps.pw}).
9586 @item float __builtin_mips_recip1_s (float)
9587 @itemx double __builtin_mips_recip1_d (double)
9588 @itemx v2sf __builtin_mips_recip1_ps (v2sf)
9589 Reduced precision reciprocal (sequence step 1) (@code{recip1.@var{fmt}}).
9591 @item float __builtin_mips_recip2_s (float, float)
9592 @itemx double __builtin_mips_recip2_d (double, double)
9593 @itemx v2sf __builtin_mips_recip2_ps (v2sf, v2sf)
9594 Reduced precision reciprocal (sequence step 2) (@code{recip2.@var{fmt}}).
9596 @item float __builtin_mips_rsqrt1_s (float)
9597 @itemx double __builtin_mips_rsqrt1_d (double)
9598 @itemx v2sf __builtin_mips_rsqrt1_ps (v2sf)
9599 Reduced precision reciprocal square root (sequence step 1)
9600 (@code{rsqrt1.@var{fmt}}).
9602 @item float __builtin_mips_rsqrt2_s (float, float)
9603 @itemx double __builtin_mips_rsqrt2_d (double, double)
9604 @itemx v2sf __builtin_mips_rsqrt2_ps (v2sf, v2sf)
9605 Reduced precision reciprocal square root (sequence step 2)
9606 (@code{rsqrt2.@var{fmt}}).
9607 @end table
9609 The following multi-instruction functions are also available.
9610 In each case, @var{cond} can be any of the 16 floating-point conditions:
9611 @code{f}, @code{un}, @code{eq}, @code{ueq}, @code{olt}, @code{ult},
9612 @code{ole}, @code{ule}, @code{sf}, @code{ngle}, @code{seq},
9613 @code{ngl}, @code{lt}, @code{nge}, @code{le} or @code{ngt}.
9615 @table @code
9616 @item int __builtin_mips_cabs_@var{cond}_s (float @var{a}, float @var{b})
9617 @itemx int __builtin_mips_cabs_@var{cond}_d (double @var{a}, double @var{b})
9618 Absolute comparison of two scalar values (@code{cabs.@var{cond}.@var{fmt}},
9619 @code{bc1t}/@code{bc1f}).
9621 These functions compare @var{a} and @var{b} using @code{cabs.@var{cond}.s}
9622 or @code{cabs.@var{cond}.d} and return the result as a boolean value.
9623 For example:
9625 @smallexample
9626 float a, b;
9627 if (__builtin_mips_cabs_eq_s (a, b))
9628   true ();
9629 else
9630   false ();
9631 @end smallexample
9633 @item int __builtin_mips_upper_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
9634 @itemx int __builtin_mips_lower_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
9635 Absolute comparison of two paired-single values (@code{cabs.@var{cond}.ps},
9636 @code{bc1t}/@code{bc1f}).
9638 These functions compare @var{a} and @var{b} using @code{cabs.@var{cond}.ps}
9639 and return either the upper or lower half of the result.  For example:
9641 @smallexample
9642 v2sf a, b;
9643 if (__builtin_mips_upper_cabs_eq_ps (a, b))
9644   upper_halves_are_equal ();
9645 else
9646   upper_halves_are_unequal ();
9648 if (__builtin_mips_lower_cabs_eq_ps (a, b))
9649   lower_halves_are_equal ();
9650 else
9651   lower_halves_are_unequal ();
9652 @end smallexample
9654 @item v2sf __builtin_mips_movt_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
9655 @itemx v2sf __builtin_mips_movf_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
9656 Conditional move based on absolute comparison (@code{cabs.@var{cond}.ps},
9657 @code{movt.ps}/@code{movf.ps}).
9659 The @code{movt} functions return the value @var{x} computed by:
9661 @smallexample
9662 cabs.@var{cond}.ps @var{cc},@var{a},@var{b}
9663 mov.ps @var{x},@var{c}
9664 movt.ps @var{x},@var{d},@var{cc}
9665 @end smallexample
9667 The @code{movf} functions are similar but use @code{movf.ps} instead
9668 of @code{movt.ps}.
9670 @item int __builtin_mips_any_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
9671 @itemx int __builtin_mips_all_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
9672 @itemx int __builtin_mips_any_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
9673 @itemx int __builtin_mips_all_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
9674 Comparison of two paired-single values
9675 (@code{c.@var{cond}.ps}/@code{cabs.@var{cond}.ps},
9676 @code{bc1any2t}/@code{bc1any2f}).
9678 These functions compare @var{a} and @var{b} using @code{c.@var{cond}.ps}
9679 or @code{cabs.@var{cond}.ps}.  The @code{any} forms return true if either
9680 result is true and the @code{all} forms return true if both results are true.
9681 For example:
9683 @smallexample
9684 v2sf a, b;
9685 if (__builtin_mips_any_c_eq_ps (a, b))
9686   one_is_true ();
9687 else
9688   both_are_false ();
9690 if (__builtin_mips_all_c_eq_ps (a, b))
9691   both_are_true ();
9692 else
9693   one_is_false ();
9694 @end smallexample
9696 @item int __builtin_mips_any_c_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
9697 @itemx int __builtin_mips_all_c_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
9698 @itemx int __builtin_mips_any_cabs_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
9699 @itemx int __builtin_mips_all_cabs_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
9700 Comparison of four paired-single values
9701 (@code{c.@var{cond}.ps}/@code{cabs.@var{cond}.ps},
9702 @code{bc1any4t}/@code{bc1any4f}).
9704 These functions use @code{c.@var{cond}.ps} or @code{cabs.@var{cond}.ps}
9705 to compare @var{a} with @var{b} and to compare @var{c} with @var{d}.
9706 The @code{any} forms return true if any of the four results are true
9707 and the @code{all} forms return true if all four results are true.
9708 For example:
9710 @smallexample
9711 v2sf a, b, c, d;
9712 if (__builtin_mips_any_c_eq_4s (a, b, c, d))
9713   some_are_true ();
9714 else
9715   all_are_false ();
9717 if (__builtin_mips_all_c_eq_4s (a, b, c, d))
9718   all_are_true ();
9719 else
9720   some_are_false ();
9721 @end smallexample
9722 @end table
9724 @node picoChip Built-in Functions
9725 @subsection picoChip Built-in Functions
9727 GCC provides an interface to selected machine instructions from the
9728 picoChip instruction set.
9730 @table @code
9731 @item int __builtin_sbc (int @var{value})
9732 Sign bit count.  Return the number of consecutive bits in @var{value}
9733 which have the same value as the sign-bit.  The result is the number of
9734 leading sign bits minus one, giving the number of redundant sign bits in
9735 @var{value}.
9737 @item int __builtin_byteswap (int @var{value})
9738 Byte swap.  Return the result of swapping the upper and lower bytes of
9739 @var{value}.
9741 @item int __builtin_brev (int @var{value})
9742 Bit reversal.  Return the result of reversing the bits in
9743 @var{value}.  Bit 15 is swapped with bit 0, bit 14 is swapped with bit 1,
9744 and so on.
9746 @item int __builtin_adds (int @var{x}, int @var{y})
9747 Saturating addition.  Return the result of adding @var{x} and @var{y},
9748 storing the value 32767 if the result overflows.
9750 @item int __builtin_subs (int @var{x}, int @var{y})
9751 Saturating subtraction.  Return the result of subtracting @var{y} from
9752 @var{x}, storing the value -32768 if the result overflows.
9754 @item void __builtin_halt (void)
9755 Halt.  The processor will stop execution.  This built-in is useful for
9756 implementing assertions.
9758 @end table
9760 @node Other MIPS Built-in Functions
9761 @subsection Other MIPS Built-in Functions
9763 GCC provides other MIPS-specific built-in functions:
9765 @table @code
9766 @item void __builtin_mips_cache (int @var{op}, const volatile void *@var{addr})
9767 Insert a @samp{cache} instruction with operands @var{op} and @var{addr}.
9768 GCC defines the preprocessor macro @code{___GCC_HAVE_BUILTIN_MIPS_CACHE}
9769 when this function is available.
9770 @end table
9772 @node PowerPC AltiVec Built-in Functions
9773 @subsection PowerPC AltiVec Built-in Functions
9775 GCC provides an interface for the PowerPC family of processors to access
9776 the AltiVec operations described in Motorola's AltiVec Programming
9777 Interface Manual.  The interface is made available by including
9778 @code{<altivec.h>} and using @option{-maltivec} and
9779 @option{-mabi=altivec}.  The interface supports the following vector
9780 types.
9782 @smallexample
9783 vector unsigned char
9784 vector signed char
9785 vector bool char
9787 vector unsigned short
9788 vector signed short
9789 vector bool short
9790 vector pixel
9792 vector unsigned int
9793 vector signed int
9794 vector bool int
9795 vector float
9796 @end smallexample
9798 GCC's implementation of the high-level language interface available from
9799 C and C++ code differs from Motorola's documentation in several ways.
9801 @itemize @bullet
9803 @item
9804 A vector constant is a list of constant expressions within curly braces.
9806 @item
9807 A vector initializer requires no cast if the vector constant is of the
9808 same type as the variable it is initializing.
9810 @item
9811 If @code{signed} or @code{unsigned} is omitted, the signedness of the
9812 vector type is the default signedness of the base type.  The default
9813 varies depending on the operating system, so a portable program should
9814 always specify the signedness.
9816 @item
9817 Compiling with @option{-maltivec} adds keywords @code{__vector},
9818 @code{vector}, @code{__pixel}, @code{pixel}, @code{__bool} and
9819 @code{bool}.  When compiling ISO C, the context-sensitive substitution
9820 of the keywords @code{vector}, @code{pixel} and @code{bool} is
9821 disabled.  To use them, you must include @code{<altivec.h>} instead.
9823 @item
9824 GCC allows using a @code{typedef} name as the type specifier for a
9825 vector type.
9827 @item
9828 For C, overloaded functions are implemented with macros so the following
9829 does not work:
9831 @smallexample
9832   vec_add ((vector signed int)@{1, 2, 3, 4@}, foo);
9833 @end smallexample
9835 Since @code{vec_add} is a macro, the vector constant in the example
9836 is treated as four separate arguments.  Wrap the entire argument in
9837 parentheses for this to work.
9838 @end itemize
9840 @emph{Note:} Only the @code{<altivec.h>} interface is supported.
9841 Internally, GCC uses built-in functions to achieve the functionality in
9842 the aforementioned header file, but they are not supported and are
9843 subject to change without notice.
9845 The following interfaces are supported for the generic and specific
9846 AltiVec operations and the AltiVec predicates.  In cases where there
9847 is a direct mapping between generic and specific operations, only the
9848 generic names are shown here, although the specific operations can also
9849 be used.
9851 Arguments that are documented as @code{const int} require literal
9852 integral values within the range required for that operation.
9854 @smallexample
9855 vector signed char vec_abs (vector signed char);
9856 vector signed short vec_abs (vector signed short);
9857 vector signed int vec_abs (vector signed int);
9858 vector float vec_abs (vector float);
9860 vector signed char vec_abss (vector signed char);
9861 vector signed short vec_abss (vector signed short);
9862 vector signed int vec_abss (vector signed int);
9864 vector signed char vec_add (vector bool char, vector signed char);
9865 vector signed char vec_add (vector signed char, vector bool char);
9866 vector signed char vec_add (vector signed char, vector signed char);
9867 vector unsigned char vec_add (vector bool char, vector unsigned char);
9868 vector unsigned char vec_add (vector unsigned char, vector bool char);
9869 vector unsigned char vec_add (vector unsigned char,
9870                               vector unsigned char);
9871 vector signed short vec_add (vector bool short, vector signed short);
9872 vector signed short vec_add (vector signed short, vector bool short);
9873 vector signed short vec_add (vector signed short, vector signed short);
9874 vector unsigned short vec_add (vector bool short,
9875                                vector unsigned short);
9876 vector unsigned short vec_add (vector unsigned short,
9877                                vector bool short);
9878 vector unsigned short vec_add (vector unsigned short,
9879                                vector unsigned short);
9880 vector signed int vec_add (vector bool int, vector signed int);
9881 vector signed int vec_add (vector signed int, vector bool int);
9882 vector signed int vec_add (vector signed int, vector signed int);
9883 vector unsigned int vec_add (vector bool int, vector unsigned int);
9884 vector unsigned int vec_add (vector unsigned int, vector bool int);
9885 vector unsigned int vec_add (vector unsigned int, vector unsigned int);
9886 vector float vec_add (vector float, vector float);
9888 vector float vec_vaddfp (vector float, vector float);
9890 vector signed int vec_vadduwm (vector bool int, vector signed int);
9891 vector signed int vec_vadduwm (vector signed int, vector bool int);
9892 vector signed int vec_vadduwm (vector signed int, vector signed int);
9893 vector unsigned int vec_vadduwm (vector bool int, vector unsigned int);
9894 vector unsigned int vec_vadduwm (vector unsigned int, vector bool int);
9895 vector unsigned int vec_vadduwm (vector unsigned int,
9896                                  vector unsigned int);
9898 vector signed short vec_vadduhm (vector bool short,
9899                                  vector signed short);
9900 vector signed short vec_vadduhm (vector signed short,
9901                                  vector bool short);
9902 vector signed short vec_vadduhm (vector signed short,
9903                                  vector signed short);
9904 vector unsigned short vec_vadduhm (vector bool short,
9905                                    vector unsigned short);
9906 vector unsigned short vec_vadduhm (vector unsigned short,
9907                                    vector bool short);
9908 vector unsigned short vec_vadduhm (vector unsigned short,
9909                                    vector unsigned short);
9911 vector signed char vec_vaddubm (vector bool char, vector signed char);
9912 vector signed char vec_vaddubm (vector signed char, vector bool char);
9913 vector signed char vec_vaddubm (vector signed char, vector signed char);
9914 vector unsigned char vec_vaddubm (vector bool char,
9915                                   vector unsigned char);
9916 vector unsigned char vec_vaddubm (vector unsigned char,
9917                                   vector bool char);
9918 vector unsigned char vec_vaddubm (vector unsigned char,
9919                                   vector unsigned char);
9921 vector unsigned int vec_addc (vector unsigned int, vector unsigned int);
9923 vector unsigned char vec_adds (vector bool char, vector unsigned char);
9924 vector unsigned char vec_adds (vector unsigned char, vector bool char);
9925 vector unsigned char vec_adds (vector unsigned char,
9926                                vector unsigned char);
9927 vector signed char vec_adds (vector bool char, vector signed char);
9928 vector signed char vec_adds (vector signed char, vector bool char);
9929 vector signed char vec_adds (vector signed char, vector signed char);
9930 vector unsigned short vec_adds (vector bool short,
9931                                 vector unsigned short);
9932 vector unsigned short vec_adds (vector unsigned short,
9933                                 vector bool short);
9934 vector unsigned short vec_adds (vector unsigned short,
9935                                 vector unsigned short);
9936 vector signed short vec_adds (vector bool short, vector signed short);
9937 vector signed short vec_adds (vector signed short, vector bool short);
9938 vector signed short vec_adds (vector signed short, vector signed short);
9939 vector unsigned int vec_adds (vector bool int, vector unsigned int);
9940 vector unsigned int vec_adds (vector unsigned int, vector bool int);
9941 vector unsigned int vec_adds (vector unsigned int, vector unsigned int);
9942 vector signed int vec_adds (vector bool int, vector signed int);
9943 vector signed int vec_adds (vector signed int, vector bool int);
9944 vector signed int vec_adds (vector signed int, vector signed int);
9946 vector signed int vec_vaddsws (vector bool int, vector signed int);
9947 vector signed int vec_vaddsws (vector signed int, vector bool int);
9948 vector signed int vec_vaddsws (vector signed int, vector signed int);
9950 vector unsigned int vec_vadduws (vector bool int, vector unsigned int);
9951 vector unsigned int vec_vadduws (vector unsigned int, vector bool int);
9952 vector unsigned int vec_vadduws (vector unsigned int,
9953                                  vector unsigned int);
9955 vector signed short vec_vaddshs (vector bool short,
9956                                  vector signed short);
9957 vector signed short vec_vaddshs (vector signed short,
9958                                  vector bool short);
9959 vector signed short vec_vaddshs (vector signed short,
9960                                  vector signed short);
9962 vector unsigned short vec_vadduhs (vector bool short,
9963                                    vector unsigned short);
9964 vector unsigned short vec_vadduhs (vector unsigned short,
9965                                    vector bool short);
9966 vector unsigned short vec_vadduhs (vector unsigned short,
9967                                    vector unsigned short);
9969 vector signed char vec_vaddsbs (vector bool char, vector signed char);
9970 vector signed char vec_vaddsbs (vector signed char, vector bool char);
9971 vector signed char vec_vaddsbs (vector signed char, vector signed char);
9973 vector unsigned char vec_vaddubs (vector bool char,
9974                                   vector unsigned char);
9975 vector unsigned char vec_vaddubs (vector unsigned char,
9976                                   vector bool char);
9977 vector unsigned char vec_vaddubs (vector unsigned char,
9978                                   vector unsigned char);
9980 vector float vec_and (vector float, vector float);
9981 vector float vec_and (vector float, vector bool int);
9982 vector float vec_and (vector bool int, vector float);
9983 vector bool int vec_and (vector bool int, vector bool int);
9984 vector signed int vec_and (vector bool int, vector signed int);
9985 vector signed int vec_and (vector signed int, vector bool int);
9986 vector signed int vec_and (vector signed int, vector signed int);
9987 vector unsigned int vec_and (vector bool int, vector unsigned int);
9988 vector unsigned int vec_and (vector unsigned int, vector bool int);
9989 vector unsigned int vec_and (vector unsigned int, vector unsigned int);
9990 vector bool short vec_and (vector bool short, vector bool short);
9991 vector signed short vec_and (vector bool short, vector signed short);
9992 vector signed short vec_and (vector signed short, vector bool short);
9993 vector signed short vec_and (vector signed short, vector signed short);
9994 vector unsigned short vec_and (vector bool short,
9995                                vector unsigned short);
9996 vector unsigned short vec_and (vector unsigned short,
9997                                vector bool short);
9998 vector unsigned short vec_and (vector unsigned short,
9999                                vector unsigned short);
10000 vector signed char vec_and (vector bool char, vector signed char);
10001 vector bool char vec_and (vector bool char, vector bool char);
10002 vector signed char vec_and (vector signed char, vector bool char);
10003 vector signed char vec_and (vector signed char, vector signed char);
10004 vector unsigned char vec_and (vector bool char, vector unsigned char);
10005 vector unsigned char vec_and (vector unsigned char, vector bool char);
10006 vector unsigned char vec_and (vector unsigned char,
10007                               vector unsigned char);
10009 vector float vec_andc (vector float, vector float);
10010 vector float vec_andc (vector float, vector bool int);
10011 vector float vec_andc (vector bool int, vector float);
10012 vector bool int vec_andc (vector bool int, vector bool int);
10013 vector signed int vec_andc (vector bool int, vector signed int);
10014 vector signed int vec_andc (vector signed int, vector bool int);
10015 vector signed int vec_andc (vector signed int, vector signed int);
10016 vector unsigned int vec_andc (vector bool int, vector unsigned int);
10017 vector unsigned int vec_andc (vector unsigned int, vector bool int);
10018 vector unsigned int vec_andc (vector unsigned int, vector unsigned int);
10019 vector bool short vec_andc (vector bool short, vector bool short);
10020 vector signed short vec_andc (vector bool short, vector signed short);
10021 vector signed short vec_andc (vector signed short, vector bool short);
10022 vector signed short vec_andc (vector signed short, vector signed short);
10023 vector unsigned short vec_andc (vector bool short,
10024                                 vector unsigned short);
10025 vector unsigned short vec_andc (vector unsigned short,
10026                                 vector bool short);
10027 vector unsigned short vec_andc (vector unsigned short,
10028                                 vector unsigned short);
10029 vector signed char vec_andc (vector bool char, vector signed char);
10030 vector bool char vec_andc (vector bool char, vector bool char);
10031 vector signed char vec_andc (vector signed char, vector bool char);
10032 vector signed char vec_andc (vector signed char, vector signed char);
10033 vector unsigned char vec_andc (vector bool char, vector unsigned char);
10034 vector unsigned char vec_andc (vector unsigned char, vector bool char);
10035 vector unsigned char vec_andc (vector unsigned char,
10036                                vector unsigned char);
10038 vector unsigned char vec_avg (vector unsigned char,
10039                               vector unsigned char);
10040 vector signed char vec_avg (vector signed char, vector signed char);
10041 vector unsigned short vec_avg (vector unsigned short,
10042                                vector unsigned short);
10043 vector signed short vec_avg (vector signed short, vector signed short);
10044 vector unsigned int vec_avg (vector unsigned int, vector unsigned int);
10045 vector signed int vec_avg (vector signed int, vector signed int);
10047 vector signed int vec_vavgsw (vector signed int, vector signed int);
10049 vector unsigned int vec_vavguw (vector unsigned int,
10050                                 vector unsigned int);
10052 vector signed short vec_vavgsh (vector signed short,
10053                                 vector signed short);
10055 vector unsigned short vec_vavguh (vector unsigned short,
10056                                   vector unsigned short);
10058 vector signed char vec_vavgsb (vector signed char, vector signed char);
10060 vector unsigned char vec_vavgub (vector unsigned char,
10061                                  vector unsigned char);
10063 vector float vec_ceil (vector float);
10065 vector signed int vec_cmpb (vector float, vector float);
10067 vector bool char vec_cmpeq (vector signed char, vector signed char);
10068 vector bool char vec_cmpeq (vector unsigned char, vector unsigned char);
10069 vector bool short vec_cmpeq (vector signed short, vector signed short);
10070 vector bool short vec_cmpeq (vector unsigned short,
10071                              vector unsigned short);
10072 vector bool int vec_cmpeq (vector signed int, vector signed int);
10073 vector bool int vec_cmpeq (vector unsigned int, vector unsigned int);
10074 vector bool int vec_cmpeq (vector float, vector float);
10076 vector bool int vec_vcmpeqfp (vector float, vector float);
10078 vector bool int vec_vcmpequw (vector signed int, vector signed int);
10079 vector bool int vec_vcmpequw (vector unsigned int, vector unsigned int);
10081 vector bool short vec_vcmpequh (vector signed short,
10082                                 vector signed short);
10083 vector bool short vec_vcmpequh (vector unsigned short,
10084                                 vector unsigned short);
10086 vector bool char vec_vcmpequb (vector signed char, vector signed char);
10087 vector bool char vec_vcmpequb (vector unsigned char,
10088                                vector unsigned char);
10090 vector bool int vec_cmpge (vector float, vector float);
10092 vector bool char vec_cmpgt (vector unsigned char, vector unsigned char);
10093 vector bool char vec_cmpgt (vector signed char, vector signed char);
10094 vector bool short vec_cmpgt (vector unsigned short,
10095                              vector unsigned short);
10096 vector bool short vec_cmpgt (vector signed short, vector signed short);
10097 vector bool int vec_cmpgt (vector unsigned int, vector unsigned int);
10098 vector bool int vec_cmpgt (vector signed int, vector signed int);
10099 vector bool int vec_cmpgt (vector float, vector float);
10101 vector bool int vec_vcmpgtfp (vector float, vector float);
10103 vector bool int vec_vcmpgtsw (vector signed int, vector signed int);
10105 vector bool int vec_vcmpgtuw (vector unsigned int, vector unsigned int);
10107 vector bool short vec_vcmpgtsh (vector signed short,
10108                                 vector signed short);
10110 vector bool short vec_vcmpgtuh (vector unsigned short,
10111                                 vector unsigned short);
10113 vector bool char vec_vcmpgtsb (vector signed char, vector signed char);
10115 vector bool char vec_vcmpgtub (vector unsigned char,
10116                                vector unsigned char);
10118 vector bool int vec_cmple (vector float, vector float);
10120 vector bool char vec_cmplt (vector unsigned char, vector unsigned char);
10121 vector bool char vec_cmplt (vector signed char, vector signed char);
10122 vector bool short vec_cmplt (vector unsigned short,
10123                              vector unsigned short);
10124 vector bool short vec_cmplt (vector signed short, vector signed short);
10125 vector bool int vec_cmplt (vector unsigned int, vector unsigned int);
10126 vector bool int vec_cmplt (vector signed int, vector signed int);
10127 vector bool int vec_cmplt (vector float, vector float);
10129 vector float vec_ctf (vector unsigned int, const int);
10130 vector float vec_ctf (vector signed int, const int);
10132 vector float vec_vcfsx (vector signed int, const int);
10134 vector float vec_vcfux (vector unsigned int, const int);
10136 vector signed int vec_cts (vector float, const int);
10138 vector unsigned int vec_ctu (vector float, const int);
10140 void vec_dss (const int);
10142 void vec_dssall (void);
10144 void vec_dst (const vector unsigned char *, int, const int);
10145 void vec_dst (const vector signed char *, int, const int);
10146 void vec_dst (const vector bool char *, int, const int);
10147 void vec_dst (const vector unsigned short *, int, const int);
10148 void vec_dst (const vector signed short *, int, const int);
10149 void vec_dst (const vector bool short *, int, const int);
10150 void vec_dst (const vector pixel *, int, const int);
10151 void vec_dst (const vector unsigned int *, int, const int);
10152 void vec_dst (const vector signed int *, int, const int);
10153 void vec_dst (const vector bool int *, int, const int);
10154 void vec_dst (const vector float *, int, const int);
10155 void vec_dst (const unsigned char *, int, const int);
10156 void vec_dst (const signed char *, int, const int);
10157 void vec_dst (const unsigned short *, int, const int);
10158 void vec_dst (const short *, int, const int);
10159 void vec_dst (const unsigned int *, int, const int);
10160 void vec_dst (const int *, int, const int);
10161 void vec_dst (const unsigned long *, int, const int);
10162 void vec_dst (const long *, int, const int);
10163 void vec_dst (const float *, int, const int);
10165 void vec_dstst (const vector unsigned char *, int, const int);
10166 void vec_dstst (const vector signed char *, int, const int);
10167 void vec_dstst (const vector bool char *, int, const int);
10168 void vec_dstst (const vector unsigned short *, int, const int);
10169 void vec_dstst (const vector signed short *, int, const int);
10170 void vec_dstst (const vector bool short *, int, const int);
10171 void vec_dstst (const vector pixel *, int, const int);
10172 void vec_dstst (const vector unsigned int *, int, const int);
10173 void vec_dstst (const vector signed int *, int, const int);
10174 void vec_dstst (const vector bool int *, int, const int);
10175 void vec_dstst (const vector float *, int, const int);
10176 void vec_dstst (const unsigned char *, int, const int);
10177 void vec_dstst (const signed char *, int, const int);
10178 void vec_dstst (const unsigned short *, int, const int);
10179 void vec_dstst (const short *, int, const int);
10180 void vec_dstst (const unsigned int *, int, const int);
10181 void vec_dstst (const int *, int, const int);
10182 void vec_dstst (const unsigned long *, int, const int);
10183 void vec_dstst (const long *, int, const int);
10184 void vec_dstst (const float *, int, const int);
10186 void vec_dststt (const vector unsigned char *, int, const int);
10187 void vec_dststt (const vector signed char *, int, const int);
10188 void vec_dststt (const vector bool char *, int, const int);
10189 void vec_dststt (const vector unsigned short *, int, const int);
10190 void vec_dststt (const vector signed short *, int, const int);
10191 void vec_dststt (const vector bool short *, int, const int);
10192 void vec_dststt (const vector pixel *, int, const int);
10193 void vec_dststt (const vector unsigned int *, int, const int);
10194 void vec_dststt (const vector signed int *, int, const int);
10195 void vec_dststt (const vector bool int *, int, const int);
10196 void vec_dststt (const vector float *, int, const int);
10197 void vec_dststt (const unsigned char *, int, const int);
10198 void vec_dststt (const signed char *, int, const int);
10199 void vec_dststt (const unsigned short *, int, const int);
10200 void vec_dststt (const short *, int, const int);
10201 void vec_dststt (const unsigned int *, int, const int);
10202 void vec_dststt (const int *, int, const int);
10203 void vec_dststt (const unsigned long *, int, const int);
10204 void vec_dststt (const long *, int, const int);
10205 void vec_dststt (const float *, int, const int);
10207 void vec_dstt (const vector unsigned char *, int, const int);
10208 void vec_dstt (const vector signed char *, int, const int);
10209 void vec_dstt (const vector bool char *, int, const int);
10210 void vec_dstt (const vector unsigned short *, int, const int);
10211 void vec_dstt (const vector signed short *, int, const int);
10212 void vec_dstt (const vector bool short *, int, const int);
10213 void vec_dstt (const vector pixel *, int, const int);
10214 void vec_dstt (const vector unsigned int *, int, const int);
10215 void vec_dstt (const vector signed int *, int, const int);
10216 void vec_dstt (const vector bool int *, int, const int);
10217 void vec_dstt (const vector float *, int, const int);
10218 void vec_dstt (const unsigned char *, int, const int);
10219 void vec_dstt (const signed char *, int, const int);
10220 void vec_dstt (const unsigned short *, int, const int);
10221 void vec_dstt (const short *, int, const int);
10222 void vec_dstt (const unsigned int *, int, const int);
10223 void vec_dstt (const int *, int, const int);
10224 void vec_dstt (const unsigned long *, int, const int);
10225 void vec_dstt (const long *, int, const int);
10226 void vec_dstt (const float *, int, const int);
10228 vector float vec_expte (vector float);
10230 vector float vec_floor (vector float);
10232 vector float vec_ld (int, const vector float *);
10233 vector float vec_ld (int, const float *);
10234 vector bool int vec_ld (int, const vector bool int *);
10235 vector signed int vec_ld (int, const vector signed int *);
10236 vector signed int vec_ld (int, const int *);
10237 vector signed int vec_ld (int, const long *);
10238 vector unsigned int vec_ld (int, const vector unsigned int *);
10239 vector unsigned int vec_ld (int, const unsigned int *);
10240 vector unsigned int vec_ld (int, const unsigned long *);
10241 vector bool short vec_ld (int, const vector bool short *);
10242 vector pixel vec_ld (int, const vector pixel *);
10243 vector signed short vec_ld (int, const vector signed short *);
10244 vector signed short vec_ld (int, const short *);
10245 vector unsigned short vec_ld (int, const vector unsigned short *);
10246 vector unsigned short vec_ld (int, const unsigned short *);
10247 vector bool char vec_ld (int, const vector bool char *);
10248 vector signed char vec_ld (int, const vector signed char *);
10249 vector signed char vec_ld (int, const signed char *);
10250 vector unsigned char vec_ld (int, const vector unsigned char *);
10251 vector unsigned char vec_ld (int, const unsigned char *);
10253 vector signed char vec_lde (int, const signed char *);
10254 vector unsigned char vec_lde (int, const unsigned char *);
10255 vector signed short vec_lde (int, const short *);
10256 vector unsigned short vec_lde (int, const unsigned short *);
10257 vector float vec_lde (int, const float *);
10258 vector signed int vec_lde (int, const int *);
10259 vector unsigned int vec_lde (int, const unsigned int *);
10260 vector signed int vec_lde (int, const long *);
10261 vector unsigned int vec_lde (int, const unsigned long *);
10263 vector float vec_lvewx (int, float *);
10264 vector signed int vec_lvewx (int, int *);
10265 vector unsigned int vec_lvewx (int, unsigned int *);
10266 vector signed int vec_lvewx (int, long *);
10267 vector unsigned int vec_lvewx (int, unsigned long *);
10269 vector signed short vec_lvehx (int, short *);
10270 vector unsigned short vec_lvehx (int, unsigned short *);
10272 vector signed char vec_lvebx (int, char *);
10273 vector unsigned char vec_lvebx (int, unsigned char *);
10275 vector float vec_ldl (int, const vector float *);
10276 vector float vec_ldl (int, const float *);
10277 vector bool int vec_ldl (int, const vector bool int *);
10278 vector signed int vec_ldl (int, const vector signed int *);
10279 vector signed int vec_ldl (int, const int *);
10280 vector signed int vec_ldl (int, const long *);
10281 vector unsigned int vec_ldl (int, const vector unsigned int *);
10282 vector unsigned int vec_ldl (int, const unsigned int *);
10283 vector unsigned int vec_ldl (int, const unsigned long *);
10284 vector bool short vec_ldl (int, const vector bool short *);
10285 vector pixel vec_ldl (int, const vector pixel *);
10286 vector signed short vec_ldl (int, const vector signed short *);
10287 vector signed short vec_ldl (int, const short *);
10288 vector unsigned short vec_ldl (int, const vector unsigned short *);
10289 vector unsigned short vec_ldl (int, const unsigned short *);
10290 vector bool char vec_ldl (int, const vector bool char *);
10291 vector signed char vec_ldl (int, const vector signed char *);
10292 vector signed char vec_ldl (int, const signed char *);
10293 vector unsigned char vec_ldl (int, const vector unsigned char *);
10294 vector unsigned char vec_ldl (int, const unsigned char *);
10296 vector float vec_loge (vector float);
10298 vector unsigned char vec_lvsl (int, const volatile unsigned char *);
10299 vector unsigned char vec_lvsl (int, const volatile signed char *);
10300 vector unsigned char vec_lvsl (int, const volatile unsigned short *);
10301 vector unsigned char vec_lvsl (int, const volatile short *);
10302 vector unsigned char vec_lvsl (int, const volatile unsigned int *);
10303 vector unsigned char vec_lvsl (int, const volatile int *);
10304 vector unsigned char vec_lvsl (int, const volatile unsigned long *);
10305 vector unsigned char vec_lvsl (int, const volatile long *);
10306 vector unsigned char vec_lvsl (int, const volatile float *);
10308 vector unsigned char vec_lvsr (int, const volatile unsigned char *);
10309 vector unsigned char vec_lvsr (int, const volatile signed char *);
10310 vector unsigned char vec_lvsr (int, const volatile unsigned short *);
10311 vector unsigned char vec_lvsr (int, const volatile short *);
10312 vector unsigned char vec_lvsr (int, const volatile unsigned int *);
10313 vector unsigned char vec_lvsr (int, const volatile int *);
10314 vector unsigned char vec_lvsr (int, const volatile unsigned long *);
10315 vector unsigned char vec_lvsr (int, const volatile long *);
10316 vector unsigned char vec_lvsr (int, const volatile float *);
10318 vector float vec_madd (vector float, vector float, vector float);
10320 vector signed short vec_madds (vector signed short,
10321                                vector signed short,
10322                                vector signed short);
10324 vector unsigned char vec_max (vector bool char, vector unsigned char);
10325 vector unsigned char vec_max (vector unsigned char, vector bool char);
10326 vector unsigned char vec_max (vector unsigned char,
10327                               vector unsigned char);
10328 vector signed char vec_max (vector bool char, vector signed char);
10329 vector signed char vec_max (vector signed char, vector bool char);
10330 vector signed char vec_max (vector signed char, vector signed char);
10331 vector unsigned short vec_max (vector bool short,
10332                                vector unsigned short);
10333 vector unsigned short vec_max (vector unsigned short,
10334                                vector bool short);
10335 vector unsigned short vec_max (vector unsigned short,
10336                                vector unsigned short);
10337 vector signed short vec_max (vector bool short, vector signed short);
10338 vector signed short vec_max (vector signed short, vector bool short);
10339 vector signed short vec_max (vector signed short, vector signed short);
10340 vector unsigned int vec_max (vector bool int, vector unsigned int);
10341 vector unsigned int vec_max (vector unsigned int, vector bool int);
10342 vector unsigned int vec_max (vector unsigned int, vector unsigned int);
10343 vector signed int vec_max (vector bool int, vector signed int);
10344 vector signed int vec_max (vector signed int, vector bool int);
10345 vector signed int vec_max (vector signed int, vector signed int);
10346 vector float vec_max (vector float, vector float);
10348 vector float vec_vmaxfp (vector float, vector float);
10350 vector signed int vec_vmaxsw (vector bool int, vector signed int);
10351 vector signed int vec_vmaxsw (vector signed int, vector bool int);
10352 vector signed int vec_vmaxsw (vector signed int, vector signed int);
10354 vector unsigned int vec_vmaxuw (vector bool int, vector unsigned int);
10355 vector unsigned int vec_vmaxuw (vector unsigned int, vector bool int);
10356 vector unsigned int vec_vmaxuw (vector unsigned int,
10357                                 vector unsigned int);
10359 vector signed short vec_vmaxsh (vector bool short, vector signed short);
10360 vector signed short vec_vmaxsh (vector signed short, vector bool short);
10361 vector signed short vec_vmaxsh (vector signed short,
10362                                 vector signed short);
10364 vector unsigned short vec_vmaxuh (vector bool short,
10365                                   vector unsigned short);
10366 vector unsigned short vec_vmaxuh (vector unsigned short,
10367                                   vector bool short);
10368 vector unsigned short vec_vmaxuh (vector unsigned short,
10369                                   vector unsigned short);
10371 vector signed char vec_vmaxsb (vector bool char, vector signed char);
10372 vector signed char vec_vmaxsb (vector signed char, vector bool char);
10373 vector signed char vec_vmaxsb (vector signed char, vector signed char);
10375 vector unsigned char vec_vmaxub (vector bool char,
10376                                  vector unsigned char);
10377 vector unsigned char vec_vmaxub (vector unsigned char,
10378                                  vector bool char);
10379 vector unsigned char vec_vmaxub (vector unsigned char,
10380                                  vector unsigned char);
10382 vector bool char vec_mergeh (vector bool char, vector bool char);
10383 vector signed char vec_mergeh (vector signed char, vector signed char);
10384 vector unsigned char vec_mergeh (vector unsigned char,
10385                                  vector unsigned char);
10386 vector bool short vec_mergeh (vector bool short, vector bool short);
10387 vector pixel vec_mergeh (vector pixel, vector pixel);
10388 vector signed short vec_mergeh (vector signed short,
10389                                 vector signed short);
10390 vector unsigned short vec_mergeh (vector unsigned short,
10391                                   vector unsigned short);
10392 vector float vec_mergeh (vector float, vector float);
10393 vector bool int vec_mergeh (vector bool int, vector bool int);
10394 vector signed int vec_mergeh (vector signed int, vector signed int);
10395 vector unsigned int vec_mergeh (vector unsigned int,
10396                                 vector unsigned int);
10398 vector float vec_vmrghw (vector float, vector float);
10399 vector bool int vec_vmrghw (vector bool int, vector bool int);
10400 vector signed int vec_vmrghw (vector signed int, vector signed int);
10401 vector unsigned int vec_vmrghw (vector unsigned int,
10402                                 vector unsigned int);
10404 vector bool short vec_vmrghh (vector bool short, vector bool short);
10405 vector signed short vec_vmrghh (vector signed short,
10406                                 vector signed short);
10407 vector unsigned short vec_vmrghh (vector unsigned short,
10408                                   vector unsigned short);
10409 vector pixel vec_vmrghh (vector pixel, vector pixel);
10411 vector bool char vec_vmrghb (vector bool char, vector bool char);
10412 vector signed char vec_vmrghb (vector signed char, vector signed char);
10413 vector unsigned char vec_vmrghb (vector unsigned char,
10414                                  vector unsigned char);
10416 vector bool char vec_mergel (vector bool char, vector bool char);
10417 vector signed char vec_mergel (vector signed char, vector signed char);
10418 vector unsigned char vec_mergel (vector unsigned char,
10419                                  vector unsigned char);
10420 vector bool short vec_mergel (vector bool short, vector bool short);
10421 vector pixel vec_mergel (vector pixel, vector pixel);
10422 vector signed short vec_mergel (vector signed short,
10423                                 vector signed short);
10424 vector unsigned short vec_mergel (vector unsigned short,
10425                                   vector unsigned short);
10426 vector float vec_mergel (vector float, vector float);
10427 vector bool int vec_mergel (vector bool int, vector bool int);
10428 vector signed int vec_mergel (vector signed int, vector signed int);
10429 vector unsigned int vec_mergel (vector unsigned int,
10430                                 vector unsigned int);
10432 vector float vec_vmrglw (vector float, vector float);
10433 vector signed int vec_vmrglw (vector signed int, vector signed int);
10434 vector unsigned int vec_vmrglw (vector unsigned int,
10435                                 vector unsigned int);
10436 vector bool int vec_vmrglw (vector bool int, vector bool int);
10438 vector bool short vec_vmrglh (vector bool short, vector bool short);
10439 vector signed short vec_vmrglh (vector signed short,
10440                                 vector signed short);
10441 vector unsigned short vec_vmrglh (vector unsigned short,
10442                                   vector unsigned short);
10443 vector pixel vec_vmrglh (vector pixel, vector pixel);
10445 vector bool char vec_vmrglb (vector bool char, vector bool char);
10446 vector signed char vec_vmrglb (vector signed char, vector signed char);
10447 vector unsigned char vec_vmrglb (vector unsigned char,
10448                                  vector unsigned char);
10450 vector unsigned short vec_mfvscr (void);
10452 vector unsigned char vec_min (vector bool char, vector unsigned char);
10453 vector unsigned char vec_min (vector unsigned char, vector bool char);
10454 vector unsigned char vec_min (vector unsigned char,
10455                               vector unsigned char);
10456 vector signed char vec_min (vector bool char, vector signed char);
10457 vector signed char vec_min (vector signed char, vector bool char);
10458 vector signed char vec_min (vector signed char, vector signed char);
10459 vector unsigned short vec_min (vector bool short,
10460                                vector unsigned short);
10461 vector unsigned short vec_min (vector unsigned short,
10462                                vector bool short);
10463 vector unsigned short vec_min (vector unsigned short,
10464                                vector unsigned short);
10465 vector signed short vec_min (vector bool short, vector signed short);
10466 vector signed short vec_min (vector signed short, vector bool short);
10467 vector signed short vec_min (vector signed short, vector signed short);
10468 vector unsigned int vec_min (vector bool int, vector unsigned int);
10469 vector unsigned int vec_min (vector unsigned int, vector bool int);
10470 vector unsigned int vec_min (vector unsigned int, vector unsigned int);
10471 vector signed int vec_min (vector bool int, vector signed int);
10472 vector signed int vec_min (vector signed int, vector bool int);
10473 vector signed int vec_min (vector signed int, vector signed int);
10474 vector float vec_min (vector float, vector float);
10476 vector float vec_vminfp (vector float, vector float);
10478 vector signed int vec_vminsw (vector bool int, vector signed int);
10479 vector signed int vec_vminsw (vector signed int, vector bool int);
10480 vector signed int vec_vminsw (vector signed int, vector signed int);
10482 vector unsigned int vec_vminuw (vector bool int, vector unsigned int);
10483 vector unsigned int vec_vminuw (vector unsigned int, vector bool int);
10484 vector unsigned int vec_vminuw (vector unsigned int,
10485                                 vector unsigned int);
10487 vector signed short vec_vminsh (vector bool short, vector signed short);
10488 vector signed short vec_vminsh (vector signed short, vector bool short);
10489 vector signed short vec_vminsh (vector signed short,
10490                                 vector signed short);
10492 vector unsigned short vec_vminuh (vector bool short,
10493                                   vector unsigned short);
10494 vector unsigned short vec_vminuh (vector unsigned short,
10495                                   vector bool short);
10496 vector unsigned short vec_vminuh (vector unsigned short,
10497                                   vector unsigned short);
10499 vector signed char vec_vminsb (vector bool char, vector signed char);
10500 vector signed char vec_vminsb (vector signed char, vector bool char);
10501 vector signed char vec_vminsb (vector signed char, vector signed char);
10503 vector unsigned char vec_vminub (vector bool char,
10504                                  vector unsigned char);
10505 vector unsigned char vec_vminub (vector unsigned char,
10506                                  vector bool char);
10507 vector unsigned char vec_vminub (vector unsigned char,
10508                                  vector unsigned char);
10510 vector signed short vec_mladd (vector signed short,
10511                                vector signed short,
10512                                vector signed short);
10513 vector signed short vec_mladd (vector signed short,
10514                                vector unsigned short,
10515                                vector unsigned short);
10516 vector signed short vec_mladd (vector unsigned short,
10517                                vector signed short,
10518                                vector signed short);
10519 vector unsigned short vec_mladd (vector unsigned short,
10520                                  vector unsigned short,
10521                                  vector unsigned short);
10523 vector signed short vec_mradds (vector signed short,
10524                                 vector signed short,
10525                                 vector signed short);
10527 vector unsigned int vec_msum (vector unsigned char,
10528                               vector unsigned char,
10529                               vector unsigned int);
10530 vector signed int vec_msum (vector signed char,
10531                             vector unsigned char,
10532                             vector signed int);
10533 vector unsigned int vec_msum (vector unsigned short,
10534                               vector unsigned short,
10535                               vector unsigned int);
10536 vector signed int vec_msum (vector signed short,
10537                             vector signed short,
10538                             vector signed int);
10540 vector signed int vec_vmsumshm (vector signed short,
10541                                 vector signed short,
10542                                 vector signed int);
10544 vector unsigned int vec_vmsumuhm (vector unsigned short,
10545                                   vector unsigned short,
10546                                   vector unsigned int);
10548 vector signed int vec_vmsummbm (vector signed char,
10549                                 vector unsigned char,
10550                                 vector signed int);
10552 vector unsigned int vec_vmsumubm (vector unsigned char,
10553                                   vector unsigned char,
10554                                   vector unsigned int);
10556 vector unsigned int vec_msums (vector unsigned short,
10557                                vector unsigned short,
10558                                vector unsigned int);
10559 vector signed int vec_msums (vector signed short,
10560                              vector signed short,
10561                              vector signed int);
10563 vector signed int vec_vmsumshs (vector signed short,
10564                                 vector signed short,
10565                                 vector signed int);
10567 vector unsigned int vec_vmsumuhs (vector unsigned short,
10568                                   vector unsigned short,
10569                                   vector unsigned int);
10571 void vec_mtvscr (vector signed int);
10572 void vec_mtvscr (vector unsigned int);
10573 void vec_mtvscr (vector bool int);
10574 void vec_mtvscr (vector signed short);
10575 void vec_mtvscr (vector unsigned short);
10576 void vec_mtvscr (vector bool short);
10577 void vec_mtvscr (vector pixel);
10578 void vec_mtvscr (vector signed char);
10579 void vec_mtvscr (vector unsigned char);
10580 void vec_mtvscr (vector bool char);
10582 vector unsigned short vec_mule (vector unsigned char,
10583                                 vector unsigned char);
10584 vector signed short vec_mule (vector signed char,
10585                               vector signed char);
10586 vector unsigned int vec_mule (vector unsigned short,
10587                               vector unsigned short);
10588 vector signed int vec_mule (vector signed short, vector signed short);
10590 vector signed int vec_vmulesh (vector signed short,
10591                                vector signed short);
10593 vector unsigned int vec_vmuleuh (vector unsigned short,
10594                                  vector unsigned short);
10596 vector signed short vec_vmulesb (vector signed char,
10597                                  vector signed char);
10599 vector unsigned short vec_vmuleub (vector unsigned char,
10600                                   vector unsigned char);
10602 vector unsigned short vec_mulo (vector unsigned char,
10603                                 vector unsigned char);
10604 vector signed short vec_mulo (vector signed char, vector signed char);
10605 vector unsigned int vec_mulo (vector unsigned short,
10606                               vector unsigned short);
10607 vector signed int vec_mulo (vector signed short, vector signed short);
10609 vector signed int vec_vmulosh (vector signed short,
10610                                vector signed short);
10612 vector unsigned int vec_vmulouh (vector unsigned short,
10613                                  vector unsigned short);
10615 vector signed short vec_vmulosb (vector signed char,
10616                                  vector signed char);
10618 vector unsigned short vec_vmuloub (vector unsigned char,
10619                                    vector unsigned char);
10621 vector float vec_nmsub (vector float, vector float, vector float);
10623 vector float vec_nor (vector float, vector float);
10624 vector signed int vec_nor (vector signed int, vector signed int);
10625 vector unsigned int vec_nor (vector unsigned int, vector unsigned int);
10626 vector bool int vec_nor (vector bool int, vector bool int);
10627 vector signed short vec_nor (vector signed short, vector signed short);
10628 vector unsigned short vec_nor (vector unsigned short,
10629                                vector unsigned short);
10630 vector bool short vec_nor (vector bool short, vector bool short);
10631 vector signed char vec_nor (vector signed char, vector signed char);
10632 vector unsigned char vec_nor (vector unsigned char,
10633                               vector unsigned char);
10634 vector bool char vec_nor (vector bool char, vector bool char);
10636 vector float vec_or (vector float, vector float);
10637 vector float vec_or (vector float, vector bool int);
10638 vector float vec_or (vector bool int, vector float);
10639 vector bool int vec_or (vector bool int, vector bool int);
10640 vector signed int vec_or (vector bool int, vector signed int);
10641 vector signed int vec_or (vector signed int, vector bool int);
10642 vector signed int vec_or (vector signed int, vector signed int);
10643 vector unsigned int vec_or (vector bool int, vector unsigned int);
10644 vector unsigned int vec_or (vector unsigned int, vector bool int);
10645 vector unsigned int vec_or (vector unsigned int, vector unsigned int);
10646 vector bool short vec_or (vector bool short, vector bool short);
10647 vector signed short vec_or (vector bool short, vector signed short);
10648 vector signed short vec_or (vector signed short, vector bool short);
10649 vector signed short vec_or (vector signed short, vector signed short);
10650 vector unsigned short vec_or (vector bool short, vector unsigned short);
10651 vector unsigned short vec_or (vector unsigned short, vector bool short);
10652 vector unsigned short vec_or (vector unsigned short,
10653                               vector unsigned short);
10654 vector signed char vec_or (vector bool char, vector signed char);
10655 vector bool char vec_or (vector bool char, vector bool char);
10656 vector signed char vec_or (vector signed char, vector bool char);
10657 vector signed char vec_or (vector signed char, vector signed char);
10658 vector unsigned char vec_or (vector bool char, vector unsigned char);
10659 vector unsigned char vec_or (vector unsigned char, vector bool char);
10660 vector unsigned char vec_or (vector unsigned char,
10661                              vector unsigned char);
10663 vector signed char vec_pack (vector signed short, vector signed short);
10664 vector unsigned char vec_pack (vector unsigned short,
10665                                vector unsigned short);
10666 vector bool char vec_pack (vector bool short, vector bool short);
10667 vector signed short vec_pack (vector signed int, vector signed int);
10668 vector unsigned short vec_pack (vector unsigned int,
10669                                 vector unsigned int);
10670 vector bool short vec_pack (vector bool int, vector bool int);
10672 vector bool short vec_vpkuwum (vector bool int, vector bool int);
10673 vector signed short vec_vpkuwum (vector signed int, vector signed int);
10674 vector unsigned short vec_vpkuwum (vector unsigned int,
10675                                    vector unsigned int);
10677 vector bool char vec_vpkuhum (vector bool short, vector bool short);
10678 vector signed char vec_vpkuhum (vector signed short,
10679                                 vector signed short);
10680 vector unsigned char vec_vpkuhum (vector unsigned short,
10681                                   vector unsigned short);
10683 vector pixel vec_packpx (vector unsigned int, vector unsigned int);
10685 vector unsigned char vec_packs (vector unsigned short,
10686                                 vector unsigned short);
10687 vector signed char vec_packs (vector signed short, vector signed short);
10688 vector unsigned short vec_packs (vector unsigned int,
10689                                  vector unsigned int);
10690 vector signed short vec_packs (vector signed int, vector signed int);
10692 vector signed short vec_vpkswss (vector signed int, vector signed int);
10694 vector unsigned short vec_vpkuwus (vector unsigned int,
10695                                    vector unsigned int);
10697 vector signed char vec_vpkshss (vector signed short,
10698                                 vector signed short);
10700 vector unsigned char vec_vpkuhus (vector unsigned short,
10701                                   vector unsigned short);
10703 vector unsigned char vec_packsu (vector unsigned short,
10704                                  vector unsigned short);
10705 vector unsigned char vec_packsu (vector signed short,
10706                                  vector signed short);
10707 vector unsigned short vec_packsu (vector unsigned int,
10708                                   vector unsigned int);
10709 vector unsigned short vec_packsu (vector signed int, vector signed int);
10711 vector unsigned short vec_vpkswus (vector signed int,
10712                                    vector signed int);
10714 vector unsigned char vec_vpkshus (vector signed short,
10715                                   vector signed short);
10717 vector float vec_perm (vector float,
10718                        vector float,
10719                        vector unsigned char);
10720 vector signed int vec_perm (vector signed int,
10721                             vector signed int,
10722                             vector unsigned char);
10723 vector unsigned int vec_perm (vector unsigned int,
10724                               vector unsigned int,
10725                               vector unsigned char);
10726 vector bool int vec_perm (vector bool int,
10727                           vector bool int,
10728                           vector unsigned char);
10729 vector signed short vec_perm (vector signed short,
10730                               vector signed short,
10731                               vector unsigned char);
10732 vector unsigned short vec_perm (vector unsigned short,
10733                                 vector unsigned short,
10734                                 vector unsigned char);
10735 vector bool short vec_perm (vector bool short,
10736                             vector bool short,
10737                             vector unsigned char);
10738 vector pixel vec_perm (vector pixel,
10739                        vector pixel,
10740                        vector unsigned char);
10741 vector signed char vec_perm (vector signed char,
10742                              vector signed char,
10743                              vector unsigned char);
10744 vector unsigned char vec_perm (vector unsigned char,
10745                                vector unsigned char,
10746                                vector unsigned char);
10747 vector bool char vec_perm (vector bool char,
10748                            vector bool char,
10749                            vector unsigned char);
10751 vector float vec_re (vector float);
10753 vector signed char vec_rl (vector signed char,
10754                            vector unsigned char);
10755 vector unsigned char vec_rl (vector unsigned char,
10756                              vector unsigned char);
10757 vector signed short vec_rl (vector signed short, vector unsigned short);
10758 vector unsigned short vec_rl (vector unsigned short,
10759                               vector unsigned short);
10760 vector signed int vec_rl (vector signed int, vector unsigned int);
10761 vector unsigned int vec_rl (vector unsigned int, vector unsigned int);
10763 vector signed int vec_vrlw (vector signed int, vector unsigned int);
10764 vector unsigned int vec_vrlw (vector unsigned int, vector unsigned int);
10766 vector signed short vec_vrlh (vector signed short,
10767                               vector unsigned short);
10768 vector unsigned short vec_vrlh (vector unsigned short,
10769                                 vector unsigned short);
10771 vector signed char vec_vrlb (vector signed char, vector unsigned char);
10772 vector unsigned char vec_vrlb (vector unsigned char,
10773                                vector unsigned char);
10775 vector float vec_round (vector float);
10777 vector float vec_rsqrte (vector float);
10779 vector float vec_sel (vector float, vector float, vector bool int);
10780 vector float vec_sel (vector float, vector float, vector unsigned int);
10781 vector signed int vec_sel (vector signed int,
10782                            vector signed int,
10783                            vector bool int);
10784 vector signed int vec_sel (vector signed int,
10785                            vector signed int,
10786                            vector unsigned int);
10787 vector unsigned int vec_sel (vector unsigned int,
10788                              vector unsigned int,
10789                              vector bool int);
10790 vector unsigned int vec_sel (vector unsigned int,
10791                              vector unsigned int,
10792                              vector unsigned int);
10793 vector bool int vec_sel (vector bool int,
10794                          vector bool int,
10795                          vector bool int);
10796 vector bool int vec_sel (vector bool int,
10797                          vector bool int,
10798                          vector unsigned int);
10799 vector signed short vec_sel (vector signed short,
10800                              vector signed short,
10801                              vector bool short);
10802 vector signed short vec_sel (vector signed short,
10803                              vector signed short,
10804                              vector unsigned short);
10805 vector unsigned short vec_sel (vector unsigned short,
10806                                vector unsigned short,
10807                                vector bool short);
10808 vector unsigned short vec_sel (vector unsigned short,
10809                                vector unsigned short,
10810                                vector unsigned short);
10811 vector bool short vec_sel (vector bool short,
10812                            vector bool short,
10813                            vector bool short);
10814 vector bool short vec_sel (vector bool short,
10815                            vector bool short,
10816                            vector unsigned short);
10817 vector signed char vec_sel (vector signed char,
10818                             vector signed char,
10819                             vector bool char);
10820 vector signed char vec_sel (vector signed char,
10821                             vector signed char,
10822                             vector unsigned char);
10823 vector unsigned char vec_sel (vector unsigned char,
10824                               vector unsigned char,
10825                               vector bool char);
10826 vector unsigned char vec_sel (vector unsigned char,
10827                               vector unsigned char,
10828                               vector unsigned char);
10829 vector bool char vec_sel (vector bool char,
10830                           vector bool char,
10831                           vector bool char);
10832 vector bool char vec_sel (vector bool char,
10833                           vector bool char,
10834                           vector unsigned char);
10836 vector signed char vec_sl (vector signed char,
10837                            vector unsigned char);
10838 vector unsigned char vec_sl (vector unsigned char,
10839                              vector unsigned char);
10840 vector signed short vec_sl (vector signed short, vector unsigned short);
10841 vector unsigned short vec_sl (vector unsigned short,
10842                               vector unsigned short);
10843 vector signed int vec_sl (vector signed int, vector unsigned int);
10844 vector unsigned int vec_sl (vector unsigned int, vector unsigned int);
10846 vector signed int vec_vslw (vector signed int, vector unsigned int);
10847 vector unsigned int vec_vslw (vector unsigned int, vector unsigned int);
10849 vector signed short vec_vslh (vector signed short,
10850                               vector unsigned short);
10851 vector unsigned short vec_vslh (vector unsigned short,
10852                                 vector unsigned short);
10854 vector signed char vec_vslb (vector signed char, vector unsigned char);
10855 vector unsigned char vec_vslb (vector unsigned char,
10856                                vector unsigned char);
10858 vector float vec_sld (vector float, vector float, const int);
10859 vector signed int vec_sld (vector signed int,
10860                            vector signed int,
10861                            const int);
10862 vector unsigned int vec_sld (vector unsigned int,
10863                              vector unsigned int,
10864                              const int);
10865 vector bool int vec_sld (vector bool int,
10866                          vector bool int,
10867                          const int);
10868 vector signed short vec_sld (vector signed short,
10869                              vector signed short,
10870                              const int);
10871 vector unsigned short vec_sld (vector unsigned short,
10872                                vector unsigned short,
10873                                const int);
10874 vector bool short vec_sld (vector bool short,
10875                            vector bool short,
10876                            const int);
10877 vector pixel vec_sld (vector pixel,
10878                       vector pixel,
10879                       const int);
10880 vector signed char vec_sld (vector signed char,
10881                             vector signed char,
10882                             const int);
10883 vector unsigned char vec_sld (vector unsigned char,
10884                               vector unsigned char,
10885                               const int);
10886 vector bool char vec_sld (vector bool char,
10887                           vector bool char,
10888                           const int);
10890 vector signed int vec_sll (vector signed int,
10891                            vector unsigned int);
10892 vector signed int vec_sll (vector signed int,
10893                            vector unsigned short);
10894 vector signed int vec_sll (vector signed int,
10895                            vector unsigned char);
10896 vector unsigned int vec_sll (vector unsigned int,
10897                              vector unsigned int);
10898 vector unsigned int vec_sll (vector unsigned int,
10899                              vector unsigned short);
10900 vector unsigned int vec_sll (vector unsigned int,
10901                              vector unsigned char);
10902 vector bool int vec_sll (vector bool int,
10903                          vector unsigned int);
10904 vector bool int vec_sll (vector bool int,
10905                          vector unsigned short);
10906 vector bool int vec_sll (vector bool int,
10907                          vector unsigned char);
10908 vector signed short vec_sll (vector signed short,
10909                              vector unsigned int);
10910 vector signed short vec_sll (vector signed short,
10911                              vector unsigned short);
10912 vector signed short vec_sll (vector signed short,
10913                              vector unsigned char);
10914 vector unsigned short vec_sll (vector unsigned short,
10915                                vector unsigned int);
10916 vector unsigned short vec_sll (vector unsigned short,
10917                                vector unsigned short);
10918 vector unsigned short vec_sll (vector unsigned short,
10919                                vector unsigned char);
10920 vector bool short vec_sll (vector bool short, vector unsigned int);
10921 vector bool short vec_sll (vector bool short, vector unsigned short);
10922 vector bool short vec_sll (vector bool short, vector unsigned char);
10923 vector pixel vec_sll (vector pixel, vector unsigned int);
10924 vector pixel vec_sll (vector pixel, vector unsigned short);
10925 vector pixel vec_sll (vector pixel, vector unsigned char);
10926 vector signed char vec_sll (vector signed char, vector unsigned int);
10927 vector signed char vec_sll (vector signed char, vector unsigned short);
10928 vector signed char vec_sll (vector signed char, vector unsigned char);
10929 vector unsigned char vec_sll (vector unsigned char,
10930                               vector unsigned int);
10931 vector unsigned char vec_sll (vector unsigned char,
10932                               vector unsigned short);
10933 vector unsigned char vec_sll (vector unsigned char,
10934                               vector unsigned char);
10935 vector bool char vec_sll (vector bool char, vector unsigned int);
10936 vector bool char vec_sll (vector bool char, vector unsigned short);
10937 vector bool char vec_sll (vector bool char, vector unsigned char);
10939 vector float vec_slo (vector float, vector signed char);
10940 vector float vec_slo (vector float, vector unsigned char);
10941 vector signed int vec_slo (vector signed int, vector signed char);
10942 vector signed int vec_slo (vector signed int, vector unsigned char);
10943 vector unsigned int vec_slo (vector unsigned int, vector signed char);
10944 vector unsigned int vec_slo (vector unsigned int, vector unsigned char);
10945 vector signed short vec_slo (vector signed short, vector signed char);
10946 vector signed short vec_slo (vector signed short, vector unsigned char);
10947 vector unsigned short vec_slo (vector unsigned short,
10948                                vector signed char);
10949 vector unsigned short vec_slo (vector unsigned short,
10950                                vector unsigned char);
10951 vector pixel vec_slo (vector pixel, vector signed char);
10952 vector pixel vec_slo (vector pixel, vector unsigned char);
10953 vector signed char vec_slo (vector signed char, vector signed char);
10954 vector signed char vec_slo (vector signed char, vector unsigned char);
10955 vector unsigned char vec_slo (vector unsigned char, vector signed char);
10956 vector unsigned char vec_slo (vector unsigned char,
10957                               vector unsigned char);
10959 vector signed char vec_splat (vector signed char, const int);
10960 vector unsigned char vec_splat (vector unsigned char, const int);
10961 vector bool char vec_splat (vector bool char, const int);
10962 vector signed short vec_splat (vector signed short, const int);
10963 vector unsigned short vec_splat (vector unsigned short, const int);
10964 vector bool short vec_splat (vector bool short, const int);
10965 vector pixel vec_splat (vector pixel, const int);
10966 vector float vec_splat (vector float, const int);
10967 vector signed int vec_splat (vector signed int, const int);
10968 vector unsigned int vec_splat (vector unsigned int, const int);
10969 vector bool int vec_splat (vector bool int, const int);
10971 vector float vec_vspltw (vector float, const int);
10972 vector signed int vec_vspltw (vector signed int, const int);
10973 vector unsigned int vec_vspltw (vector unsigned int, const int);
10974 vector bool int vec_vspltw (vector bool int, const int);
10976 vector bool short vec_vsplth (vector bool short, const int);
10977 vector signed short vec_vsplth (vector signed short, const int);
10978 vector unsigned short vec_vsplth (vector unsigned short, const int);
10979 vector pixel vec_vsplth (vector pixel, const int);
10981 vector signed char vec_vspltb (vector signed char, const int);
10982 vector unsigned char vec_vspltb (vector unsigned char, const int);
10983 vector bool char vec_vspltb (vector bool char, const int);
10985 vector signed char vec_splat_s8 (const int);
10987 vector signed short vec_splat_s16 (const int);
10989 vector signed int vec_splat_s32 (const int);
10991 vector unsigned char vec_splat_u8 (const int);
10993 vector unsigned short vec_splat_u16 (const int);
10995 vector unsigned int vec_splat_u32 (const int);
10997 vector signed char vec_sr (vector signed char, vector unsigned char);
10998 vector unsigned char vec_sr (vector unsigned char,
10999                              vector unsigned char);
11000 vector signed short vec_sr (vector signed short,
11001                             vector unsigned short);
11002 vector unsigned short vec_sr (vector unsigned short,
11003                               vector unsigned short);
11004 vector signed int vec_sr (vector signed int, vector unsigned int);
11005 vector unsigned int vec_sr (vector unsigned int, vector unsigned int);
11007 vector signed int vec_vsrw (vector signed int, vector unsigned int);
11008 vector unsigned int vec_vsrw (vector unsigned int, vector unsigned int);
11010 vector signed short vec_vsrh (vector signed short,
11011                               vector unsigned short);
11012 vector unsigned short vec_vsrh (vector unsigned short,
11013                                 vector unsigned short);
11015 vector signed char vec_vsrb (vector signed char, vector unsigned char);
11016 vector unsigned char vec_vsrb (vector unsigned char,
11017                                vector unsigned char);
11019 vector signed char vec_sra (vector signed char, vector unsigned char);
11020 vector unsigned char vec_sra (vector unsigned char,
11021                               vector unsigned char);
11022 vector signed short vec_sra (vector signed short,
11023                              vector unsigned short);
11024 vector unsigned short vec_sra (vector unsigned short,
11025                                vector unsigned short);
11026 vector signed int vec_sra (vector signed int, vector unsigned int);
11027 vector unsigned int vec_sra (vector unsigned int, vector unsigned int);
11029 vector signed int vec_vsraw (vector signed int, vector unsigned int);
11030 vector unsigned int vec_vsraw (vector unsigned int,
11031                                vector unsigned int);
11033 vector signed short vec_vsrah (vector signed short,
11034                                vector unsigned short);
11035 vector unsigned short vec_vsrah (vector unsigned short,
11036                                  vector unsigned short);
11038 vector signed char vec_vsrab (vector signed char, vector unsigned char);
11039 vector unsigned char vec_vsrab (vector unsigned char,
11040                                 vector unsigned char);
11042 vector signed int vec_srl (vector signed int, vector unsigned int);
11043 vector signed int vec_srl (vector signed int, vector unsigned short);
11044 vector signed int vec_srl (vector signed int, vector unsigned char);
11045 vector unsigned int vec_srl (vector unsigned int, vector unsigned int);
11046 vector unsigned int vec_srl (vector unsigned int,
11047                              vector unsigned short);
11048 vector unsigned int vec_srl (vector unsigned int, vector unsigned char);
11049 vector bool int vec_srl (vector bool int, vector unsigned int);
11050 vector bool int vec_srl (vector bool int, vector unsigned short);
11051 vector bool int vec_srl (vector bool int, vector unsigned char);
11052 vector signed short vec_srl (vector signed short, vector unsigned int);
11053 vector signed short vec_srl (vector signed short,
11054                              vector unsigned short);
11055 vector signed short vec_srl (vector signed short, vector unsigned char);
11056 vector unsigned short vec_srl (vector unsigned short,
11057                                vector unsigned int);
11058 vector unsigned short vec_srl (vector unsigned short,
11059                                vector unsigned short);
11060 vector unsigned short vec_srl (vector unsigned short,
11061                                vector unsigned char);
11062 vector bool short vec_srl (vector bool short, vector unsigned int);
11063 vector bool short vec_srl (vector bool short, vector unsigned short);
11064 vector bool short vec_srl (vector bool short, vector unsigned char);
11065 vector pixel vec_srl (vector pixel, vector unsigned int);
11066 vector pixel vec_srl (vector pixel, vector unsigned short);
11067 vector pixel vec_srl (vector pixel, vector unsigned char);
11068 vector signed char vec_srl (vector signed char, vector unsigned int);
11069 vector signed char vec_srl (vector signed char, vector unsigned short);
11070 vector signed char vec_srl (vector signed char, vector unsigned char);
11071 vector unsigned char vec_srl (vector unsigned char,
11072                               vector unsigned int);
11073 vector unsigned char vec_srl (vector unsigned char,
11074                               vector unsigned short);
11075 vector unsigned char vec_srl (vector unsigned char,
11076                               vector unsigned char);
11077 vector bool char vec_srl (vector bool char, vector unsigned int);
11078 vector bool char vec_srl (vector bool char, vector unsigned short);
11079 vector bool char vec_srl (vector bool char, vector unsigned char);
11081 vector float vec_sro (vector float, vector signed char);
11082 vector float vec_sro (vector float, vector unsigned char);
11083 vector signed int vec_sro (vector signed int, vector signed char);
11084 vector signed int vec_sro (vector signed int, vector unsigned char);
11085 vector unsigned int vec_sro (vector unsigned int, vector signed char);
11086 vector unsigned int vec_sro (vector unsigned int, vector unsigned char);
11087 vector signed short vec_sro (vector signed short, vector signed char);
11088 vector signed short vec_sro (vector signed short, vector unsigned char);
11089 vector unsigned short vec_sro (vector unsigned short,
11090                                vector signed char);
11091 vector unsigned short vec_sro (vector unsigned short,
11092                                vector unsigned char);
11093 vector pixel vec_sro (vector pixel, vector signed char);
11094 vector pixel vec_sro (vector pixel, vector unsigned char);
11095 vector signed char vec_sro (vector signed char, vector signed char);
11096 vector signed char vec_sro (vector signed char, vector unsigned char);
11097 vector unsigned char vec_sro (vector unsigned char, vector signed char);
11098 vector unsigned char vec_sro (vector unsigned char,
11099                               vector unsigned char);
11101 void vec_st (vector float, int, vector float *);
11102 void vec_st (vector float, int, float *);
11103 void vec_st (vector signed int, int, vector signed int *);
11104 void vec_st (vector signed int, int, int *);
11105 void vec_st (vector unsigned int, int, vector unsigned int *);
11106 void vec_st (vector unsigned int, int, unsigned int *);
11107 void vec_st (vector bool int, int, vector bool int *);
11108 void vec_st (vector bool int, int, unsigned int *);
11109 void vec_st (vector bool int, int, int *);
11110 void vec_st (vector signed short, int, vector signed short *);
11111 void vec_st (vector signed short, int, short *);
11112 void vec_st (vector unsigned short, int, vector unsigned short *);
11113 void vec_st (vector unsigned short, int, unsigned short *);
11114 void vec_st (vector bool short, int, vector bool short *);
11115 void vec_st (vector bool short, int, unsigned short *);
11116 void vec_st (vector pixel, int, vector pixel *);
11117 void vec_st (vector pixel, int, unsigned short *);
11118 void vec_st (vector pixel, int, short *);
11119 void vec_st (vector bool short, int, short *);
11120 void vec_st (vector signed char, int, vector signed char *);
11121 void vec_st (vector signed char, int, signed char *);
11122 void vec_st (vector unsigned char, int, vector unsigned char *);
11123 void vec_st (vector unsigned char, int, unsigned char *);
11124 void vec_st (vector bool char, int, vector bool char *);
11125 void vec_st (vector bool char, int, unsigned char *);
11126 void vec_st (vector bool char, int, signed char *);
11128 void vec_ste (vector signed char, int, signed char *);
11129 void vec_ste (vector unsigned char, int, unsigned char *);
11130 void vec_ste (vector bool char, int, signed char *);
11131 void vec_ste (vector bool char, int, unsigned char *);
11132 void vec_ste (vector signed short, int, short *);
11133 void vec_ste (vector unsigned short, int, unsigned short *);
11134 void vec_ste (vector bool short, int, short *);
11135 void vec_ste (vector bool short, int, unsigned short *);
11136 void vec_ste (vector pixel, int, short *);
11137 void vec_ste (vector pixel, int, unsigned short *);
11138 void vec_ste (vector float, int, float *);
11139 void vec_ste (vector signed int, int, int *);
11140 void vec_ste (vector unsigned int, int, unsigned int *);
11141 void vec_ste (vector bool int, int, int *);
11142 void vec_ste (vector bool int, int, unsigned int *);
11144 void vec_stvewx (vector float, int, float *);
11145 void vec_stvewx (vector signed int, int, int *);
11146 void vec_stvewx (vector unsigned int, int, unsigned int *);
11147 void vec_stvewx (vector bool int, int, int *);
11148 void vec_stvewx (vector bool int, int, unsigned int *);
11150 void vec_stvehx (vector signed short, int, short *);
11151 void vec_stvehx (vector unsigned short, int, unsigned short *);
11152 void vec_stvehx (vector bool short, int, short *);
11153 void vec_stvehx (vector bool short, int, unsigned short *);
11154 void vec_stvehx (vector pixel, int, short *);
11155 void vec_stvehx (vector pixel, int, unsigned short *);
11157 void vec_stvebx (vector signed char, int, signed char *);
11158 void vec_stvebx (vector unsigned char, int, unsigned char *);
11159 void vec_stvebx (vector bool char, int, signed char *);
11160 void vec_stvebx (vector bool char, int, unsigned char *);
11162 void vec_stl (vector float, int, vector float *);
11163 void vec_stl (vector float, int, float *);
11164 void vec_stl (vector signed int, int, vector signed int *);
11165 void vec_stl (vector signed int, int, int *);
11166 void vec_stl (vector unsigned int, int, vector unsigned int *);
11167 void vec_stl (vector unsigned int, int, unsigned int *);
11168 void vec_stl (vector bool int, int, vector bool int *);
11169 void vec_stl (vector bool int, int, unsigned int *);
11170 void vec_stl (vector bool int, int, int *);
11171 void vec_stl (vector signed short, int, vector signed short *);
11172 void vec_stl (vector signed short, int, short *);
11173 void vec_stl (vector unsigned short, int, vector unsigned short *);
11174 void vec_stl (vector unsigned short, int, unsigned short *);
11175 void vec_stl (vector bool short, int, vector bool short *);
11176 void vec_stl (vector bool short, int, unsigned short *);
11177 void vec_stl (vector bool short, int, short *);
11178 void vec_stl (vector pixel, int, vector pixel *);
11179 void vec_stl (vector pixel, int, unsigned short *);
11180 void vec_stl (vector pixel, int, short *);
11181 void vec_stl (vector signed char, int, vector signed char *);
11182 void vec_stl (vector signed char, int, signed char *);
11183 void vec_stl (vector unsigned char, int, vector unsigned char *);
11184 void vec_stl (vector unsigned char, int, unsigned char *);
11185 void vec_stl (vector bool char, int, vector bool char *);
11186 void vec_stl (vector bool char, int, unsigned char *);
11187 void vec_stl (vector bool char, int, signed char *);
11189 vector signed char vec_sub (vector bool char, vector signed char);
11190 vector signed char vec_sub (vector signed char, vector bool char);
11191 vector signed char vec_sub (vector signed char, vector signed char);
11192 vector unsigned char vec_sub (vector bool char, vector unsigned char);
11193 vector unsigned char vec_sub (vector unsigned char, vector bool char);
11194 vector unsigned char vec_sub (vector unsigned char,
11195                               vector unsigned char);
11196 vector signed short vec_sub (vector bool short, vector signed short);
11197 vector signed short vec_sub (vector signed short, vector bool short);
11198 vector signed short vec_sub (vector signed short, vector signed short);
11199 vector unsigned short vec_sub (vector bool short,
11200                                vector unsigned short);
11201 vector unsigned short vec_sub (vector unsigned short,
11202                                vector bool short);
11203 vector unsigned short vec_sub (vector unsigned short,
11204                                vector unsigned short);
11205 vector signed int vec_sub (vector bool int, vector signed int);
11206 vector signed int vec_sub (vector signed int, vector bool int);
11207 vector signed int vec_sub (vector signed int, vector signed int);
11208 vector unsigned int vec_sub (vector bool int, vector unsigned int);
11209 vector unsigned int vec_sub (vector unsigned int, vector bool int);
11210 vector unsigned int vec_sub (vector unsigned int, vector unsigned int);
11211 vector float vec_sub (vector float, vector float);
11213 vector float vec_vsubfp (vector float, vector float);
11215 vector signed int vec_vsubuwm (vector bool int, vector signed int);
11216 vector signed int vec_vsubuwm (vector signed int, vector bool int);
11217 vector signed int vec_vsubuwm (vector signed int, vector signed int);
11218 vector unsigned int vec_vsubuwm (vector bool int, vector unsigned int);
11219 vector unsigned int vec_vsubuwm (vector unsigned int, vector bool int);
11220 vector unsigned int vec_vsubuwm (vector unsigned int,
11221                                  vector unsigned int);
11223 vector signed short vec_vsubuhm (vector bool short,
11224                                  vector signed short);
11225 vector signed short vec_vsubuhm (vector signed short,
11226                                  vector bool short);
11227 vector signed short vec_vsubuhm (vector signed short,
11228                                  vector signed short);
11229 vector unsigned short vec_vsubuhm (vector bool short,
11230                                    vector unsigned short);
11231 vector unsigned short vec_vsubuhm (vector unsigned short,
11232                                    vector bool short);
11233 vector unsigned short vec_vsubuhm (vector unsigned short,
11234                                    vector unsigned short);
11236 vector signed char vec_vsububm (vector bool char, vector signed char);
11237 vector signed char vec_vsububm (vector signed char, vector bool char);
11238 vector signed char vec_vsububm (vector signed char, vector signed char);
11239 vector unsigned char vec_vsububm (vector bool char,
11240                                   vector unsigned char);
11241 vector unsigned char vec_vsububm (vector unsigned char,
11242                                   vector bool char);
11243 vector unsigned char vec_vsububm (vector unsigned char,
11244                                   vector unsigned char);
11246 vector unsigned int vec_subc (vector unsigned int, vector unsigned int);
11248 vector unsigned char vec_subs (vector bool char, vector unsigned char);
11249 vector unsigned char vec_subs (vector unsigned char, vector bool char);
11250 vector unsigned char vec_subs (vector unsigned char,
11251                                vector unsigned char);
11252 vector signed char vec_subs (vector bool char, vector signed char);
11253 vector signed char vec_subs (vector signed char, vector bool char);
11254 vector signed char vec_subs (vector signed char, vector signed char);
11255 vector unsigned short vec_subs (vector bool short,
11256                                 vector unsigned short);
11257 vector unsigned short vec_subs (vector unsigned short,
11258                                 vector bool short);
11259 vector unsigned short vec_subs (vector unsigned short,
11260                                 vector unsigned short);
11261 vector signed short vec_subs (vector bool short, vector signed short);
11262 vector signed short vec_subs (vector signed short, vector bool short);
11263 vector signed short vec_subs (vector signed short, vector signed short);
11264 vector unsigned int vec_subs (vector bool int, vector unsigned int);
11265 vector unsigned int vec_subs (vector unsigned int, vector bool int);
11266 vector unsigned int vec_subs (vector unsigned int, vector unsigned int);
11267 vector signed int vec_subs (vector bool int, vector signed int);
11268 vector signed int vec_subs (vector signed int, vector bool int);
11269 vector signed int vec_subs (vector signed int, vector signed int);
11271 vector signed int vec_vsubsws (vector bool int, vector signed int);
11272 vector signed int vec_vsubsws (vector signed int, vector bool int);
11273 vector signed int vec_vsubsws (vector signed int, vector signed int);
11275 vector unsigned int vec_vsubuws (vector bool int, vector unsigned int);
11276 vector unsigned int vec_vsubuws (vector unsigned int, vector bool int);
11277 vector unsigned int vec_vsubuws (vector unsigned int,
11278                                  vector unsigned int);
11280 vector signed short vec_vsubshs (vector bool short,
11281                                  vector signed short);
11282 vector signed short vec_vsubshs (vector signed short,
11283                                  vector bool short);
11284 vector signed short vec_vsubshs (vector signed short,
11285                                  vector signed short);
11287 vector unsigned short vec_vsubuhs (vector bool short,
11288                                    vector unsigned short);
11289 vector unsigned short vec_vsubuhs (vector unsigned short,
11290                                    vector bool short);
11291 vector unsigned short vec_vsubuhs (vector unsigned short,
11292                                    vector unsigned short);
11294 vector signed char vec_vsubsbs (vector bool char, vector signed char);
11295 vector signed char vec_vsubsbs (vector signed char, vector bool char);
11296 vector signed char vec_vsubsbs (vector signed char, vector signed char);
11298 vector unsigned char vec_vsububs (vector bool char,
11299                                   vector unsigned char);
11300 vector unsigned char vec_vsububs (vector unsigned char,
11301                                   vector bool char);
11302 vector unsigned char vec_vsububs (vector unsigned char,
11303                                   vector unsigned char);
11305 vector unsigned int vec_sum4s (vector unsigned char,
11306                                vector unsigned int);
11307 vector signed int vec_sum4s (vector signed char, vector signed int);
11308 vector signed int vec_sum4s (vector signed short, vector signed int);
11310 vector signed int vec_vsum4shs (vector signed short, vector signed int);
11312 vector signed int vec_vsum4sbs (vector signed char, vector signed int);
11314 vector unsigned int vec_vsum4ubs (vector unsigned char,
11315                                   vector unsigned int);
11317 vector signed int vec_sum2s (vector signed int, vector signed int);
11319 vector signed int vec_sums (vector signed int, vector signed int);
11321 vector float vec_trunc (vector float);
11323 vector signed short vec_unpackh (vector signed char);
11324 vector bool short vec_unpackh (vector bool char);
11325 vector signed int vec_unpackh (vector signed short);
11326 vector bool int vec_unpackh (vector bool short);
11327 vector unsigned int vec_unpackh (vector pixel);
11329 vector bool int vec_vupkhsh (vector bool short);
11330 vector signed int vec_vupkhsh (vector signed short);
11332 vector unsigned int vec_vupkhpx (vector pixel);
11334 vector bool short vec_vupkhsb (vector bool char);
11335 vector signed short vec_vupkhsb (vector signed char);
11337 vector signed short vec_unpackl (vector signed char);
11338 vector bool short vec_unpackl (vector bool char);
11339 vector unsigned int vec_unpackl (vector pixel);
11340 vector signed int vec_unpackl (vector signed short);
11341 vector bool int vec_unpackl (vector bool short);
11343 vector unsigned int vec_vupklpx (vector pixel);
11345 vector bool int vec_vupklsh (vector bool short);
11346 vector signed int vec_vupklsh (vector signed short);
11348 vector bool short vec_vupklsb (vector bool char);
11349 vector signed short vec_vupklsb (vector signed char);
11351 vector float vec_xor (vector float, vector float);
11352 vector float vec_xor (vector float, vector bool int);
11353 vector float vec_xor (vector bool int, vector float);
11354 vector bool int vec_xor (vector bool int, vector bool int);
11355 vector signed int vec_xor (vector bool int, vector signed int);
11356 vector signed int vec_xor (vector signed int, vector bool int);
11357 vector signed int vec_xor (vector signed int, vector signed int);
11358 vector unsigned int vec_xor (vector bool int, vector unsigned int);
11359 vector unsigned int vec_xor (vector unsigned int, vector bool int);
11360 vector unsigned int vec_xor (vector unsigned int, vector unsigned int);
11361 vector bool short vec_xor (vector bool short, vector bool short);
11362 vector signed short vec_xor (vector bool short, vector signed short);
11363 vector signed short vec_xor (vector signed short, vector bool short);
11364 vector signed short vec_xor (vector signed short, vector signed short);
11365 vector unsigned short vec_xor (vector bool short,
11366                                vector unsigned short);
11367 vector unsigned short vec_xor (vector unsigned short,
11368                                vector bool short);
11369 vector unsigned short vec_xor (vector unsigned short,
11370                                vector unsigned short);
11371 vector signed char vec_xor (vector bool char, vector signed char);
11372 vector bool char vec_xor (vector bool char, vector bool char);
11373 vector signed char vec_xor (vector signed char, vector bool char);
11374 vector signed char vec_xor (vector signed char, vector signed char);
11375 vector unsigned char vec_xor (vector bool char, vector unsigned char);
11376 vector unsigned char vec_xor (vector unsigned char, vector bool char);
11377 vector unsigned char vec_xor (vector unsigned char,
11378                               vector unsigned char);
11380 int vec_all_eq (vector signed char, vector bool char);
11381 int vec_all_eq (vector signed char, vector signed char);
11382 int vec_all_eq (vector unsigned char, vector bool char);
11383 int vec_all_eq (vector unsigned char, vector unsigned char);
11384 int vec_all_eq (vector bool char, vector bool char);
11385 int vec_all_eq (vector bool char, vector unsigned char);
11386 int vec_all_eq (vector bool char, vector signed char);
11387 int vec_all_eq (vector signed short, vector bool short);
11388 int vec_all_eq (vector signed short, vector signed short);
11389 int vec_all_eq (vector unsigned short, vector bool short);
11390 int vec_all_eq (vector unsigned short, vector unsigned short);
11391 int vec_all_eq (vector bool short, vector bool short);
11392 int vec_all_eq (vector bool short, vector unsigned short);
11393 int vec_all_eq (vector bool short, vector signed short);
11394 int vec_all_eq (vector pixel, vector pixel);
11395 int vec_all_eq (vector signed int, vector bool int);
11396 int vec_all_eq (vector signed int, vector signed int);
11397 int vec_all_eq (vector unsigned int, vector bool int);
11398 int vec_all_eq (vector unsigned int, vector unsigned int);
11399 int vec_all_eq (vector bool int, vector bool int);
11400 int vec_all_eq (vector bool int, vector unsigned int);
11401 int vec_all_eq (vector bool int, vector signed int);
11402 int vec_all_eq (vector float, vector float);
11404 int vec_all_ge (vector bool char, vector unsigned char);
11405 int vec_all_ge (vector unsigned char, vector bool char);
11406 int vec_all_ge (vector unsigned char, vector unsigned char);
11407 int vec_all_ge (vector bool char, vector signed char);
11408 int vec_all_ge (vector signed char, vector bool char);
11409 int vec_all_ge (vector signed char, vector signed char);
11410 int vec_all_ge (vector bool short, vector unsigned short);
11411 int vec_all_ge (vector unsigned short, vector bool short);
11412 int vec_all_ge (vector unsigned short, vector unsigned short);
11413 int vec_all_ge (vector signed short, vector signed short);
11414 int vec_all_ge (vector bool short, vector signed short);
11415 int vec_all_ge (vector signed short, vector bool short);
11416 int vec_all_ge (vector bool int, vector unsigned int);
11417 int vec_all_ge (vector unsigned int, vector bool int);
11418 int vec_all_ge (vector unsigned int, vector unsigned int);
11419 int vec_all_ge (vector bool int, vector signed int);
11420 int vec_all_ge (vector signed int, vector bool int);
11421 int vec_all_ge (vector signed int, vector signed int);
11422 int vec_all_ge (vector float, vector float);
11424 int vec_all_gt (vector bool char, vector unsigned char);
11425 int vec_all_gt (vector unsigned char, vector bool char);
11426 int vec_all_gt (vector unsigned char, vector unsigned char);
11427 int vec_all_gt (vector bool char, vector signed char);
11428 int vec_all_gt (vector signed char, vector bool char);
11429 int vec_all_gt (vector signed char, vector signed char);
11430 int vec_all_gt (vector bool short, vector unsigned short);
11431 int vec_all_gt (vector unsigned short, vector bool short);
11432 int vec_all_gt (vector unsigned short, vector unsigned short);
11433 int vec_all_gt (vector bool short, vector signed short);
11434 int vec_all_gt (vector signed short, vector bool short);
11435 int vec_all_gt (vector signed short, vector signed short);
11436 int vec_all_gt (vector bool int, vector unsigned int);
11437 int vec_all_gt (vector unsigned int, vector bool int);
11438 int vec_all_gt (vector unsigned int, vector unsigned int);
11439 int vec_all_gt (vector bool int, vector signed int);
11440 int vec_all_gt (vector signed int, vector bool int);
11441 int vec_all_gt (vector signed int, vector signed int);
11442 int vec_all_gt (vector float, vector float);
11444 int vec_all_in (vector float, vector float);
11446 int vec_all_le (vector bool char, vector unsigned char);
11447 int vec_all_le (vector unsigned char, vector bool char);
11448 int vec_all_le (vector unsigned char, vector unsigned char);
11449 int vec_all_le (vector bool char, vector signed char);
11450 int vec_all_le (vector signed char, vector bool char);
11451 int vec_all_le (vector signed char, vector signed char);
11452 int vec_all_le (vector bool short, vector unsigned short);
11453 int vec_all_le (vector unsigned short, vector bool short);
11454 int vec_all_le (vector unsigned short, vector unsigned short);
11455 int vec_all_le (vector bool short, vector signed short);
11456 int vec_all_le (vector signed short, vector bool short);
11457 int vec_all_le (vector signed short, vector signed short);
11458 int vec_all_le (vector bool int, vector unsigned int);
11459 int vec_all_le (vector unsigned int, vector bool int);
11460 int vec_all_le (vector unsigned int, vector unsigned int);
11461 int vec_all_le (vector bool int, vector signed int);
11462 int vec_all_le (vector signed int, vector bool int);
11463 int vec_all_le (vector signed int, vector signed int);
11464 int vec_all_le (vector float, vector float);
11466 int vec_all_lt (vector bool char, vector unsigned char);
11467 int vec_all_lt (vector unsigned char, vector bool char);
11468 int vec_all_lt (vector unsigned char, vector unsigned char);
11469 int vec_all_lt (vector bool char, vector signed char);
11470 int vec_all_lt (vector signed char, vector bool char);
11471 int vec_all_lt (vector signed char, vector signed char);
11472 int vec_all_lt (vector bool short, vector unsigned short);
11473 int vec_all_lt (vector unsigned short, vector bool short);
11474 int vec_all_lt (vector unsigned short, vector unsigned short);
11475 int vec_all_lt (vector bool short, vector signed short);
11476 int vec_all_lt (vector signed short, vector bool short);
11477 int vec_all_lt (vector signed short, vector signed short);
11478 int vec_all_lt (vector bool int, vector unsigned int);
11479 int vec_all_lt (vector unsigned int, vector bool int);
11480 int vec_all_lt (vector unsigned int, vector unsigned int);
11481 int vec_all_lt (vector bool int, vector signed int);
11482 int vec_all_lt (vector signed int, vector bool int);
11483 int vec_all_lt (vector signed int, vector signed int);
11484 int vec_all_lt (vector float, vector float);
11486 int vec_all_nan (vector float);
11488 int vec_all_ne (vector signed char, vector bool char);
11489 int vec_all_ne (vector signed char, vector signed char);
11490 int vec_all_ne (vector unsigned char, vector bool char);
11491 int vec_all_ne (vector unsigned char, vector unsigned char);
11492 int vec_all_ne (vector bool char, vector bool char);
11493 int vec_all_ne (vector bool char, vector unsigned char);
11494 int vec_all_ne (vector bool char, vector signed char);
11495 int vec_all_ne (vector signed short, vector bool short);
11496 int vec_all_ne (vector signed short, vector signed short);
11497 int vec_all_ne (vector unsigned short, vector bool short);
11498 int vec_all_ne (vector unsigned short, vector unsigned short);
11499 int vec_all_ne (vector bool short, vector bool short);
11500 int vec_all_ne (vector bool short, vector unsigned short);
11501 int vec_all_ne (vector bool short, vector signed short);
11502 int vec_all_ne (vector pixel, vector pixel);
11503 int vec_all_ne (vector signed int, vector bool int);
11504 int vec_all_ne (vector signed int, vector signed int);
11505 int vec_all_ne (vector unsigned int, vector bool int);
11506 int vec_all_ne (vector unsigned int, vector unsigned int);
11507 int vec_all_ne (vector bool int, vector bool int);
11508 int vec_all_ne (vector bool int, vector unsigned int);
11509 int vec_all_ne (vector bool int, vector signed int);
11510 int vec_all_ne (vector float, vector float);
11512 int vec_all_nge (vector float, vector float);
11514 int vec_all_ngt (vector float, vector float);
11516 int vec_all_nle (vector float, vector float);
11518 int vec_all_nlt (vector float, vector float);
11520 int vec_all_numeric (vector float);
11522 int vec_any_eq (vector signed char, vector bool char);
11523 int vec_any_eq (vector signed char, vector signed char);
11524 int vec_any_eq (vector unsigned char, vector bool char);
11525 int vec_any_eq (vector unsigned char, vector unsigned char);
11526 int vec_any_eq (vector bool char, vector bool char);
11527 int vec_any_eq (vector bool char, vector unsigned char);
11528 int vec_any_eq (vector bool char, vector signed char);
11529 int vec_any_eq (vector signed short, vector bool short);
11530 int vec_any_eq (vector signed short, vector signed short);
11531 int vec_any_eq (vector unsigned short, vector bool short);
11532 int vec_any_eq (vector unsigned short, vector unsigned short);
11533 int vec_any_eq (vector bool short, vector bool short);
11534 int vec_any_eq (vector bool short, vector unsigned short);
11535 int vec_any_eq (vector bool short, vector signed short);
11536 int vec_any_eq (vector pixel, vector pixel);
11537 int vec_any_eq (vector signed int, vector bool int);
11538 int vec_any_eq (vector signed int, vector signed int);
11539 int vec_any_eq (vector unsigned int, vector bool int);
11540 int vec_any_eq (vector unsigned int, vector unsigned int);
11541 int vec_any_eq (vector bool int, vector bool int);
11542 int vec_any_eq (vector bool int, vector unsigned int);
11543 int vec_any_eq (vector bool int, vector signed int);
11544 int vec_any_eq (vector float, vector float);
11546 int vec_any_ge (vector signed char, vector bool char);
11547 int vec_any_ge (vector unsigned char, vector bool char);
11548 int vec_any_ge (vector unsigned char, vector unsigned char);
11549 int vec_any_ge (vector signed char, vector signed char);
11550 int vec_any_ge (vector bool char, vector unsigned char);
11551 int vec_any_ge (vector bool char, vector signed char);
11552 int vec_any_ge (vector unsigned short, vector bool short);
11553 int vec_any_ge (vector unsigned short, vector unsigned short);
11554 int vec_any_ge (vector signed short, vector signed short);
11555 int vec_any_ge (vector signed short, vector bool short);
11556 int vec_any_ge (vector bool short, vector unsigned short);
11557 int vec_any_ge (vector bool short, vector signed short);
11558 int vec_any_ge (vector signed int, vector bool int);
11559 int vec_any_ge (vector unsigned int, vector bool int);
11560 int vec_any_ge (vector unsigned int, vector unsigned int);
11561 int vec_any_ge (vector signed int, vector signed int);
11562 int vec_any_ge (vector bool int, vector unsigned int);
11563 int vec_any_ge (vector bool int, vector signed int);
11564 int vec_any_ge (vector float, vector float);
11566 int vec_any_gt (vector bool char, vector unsigned char);
11567 int vec_any_gt (vector unsigned char, vector bool char);
11568 int vec_any_gt (vector unsigned char, vector unsigned char);
11569 int vec_any_gt (vector bool char, vector signed char);
11570 int vec_any_gt (vector signed char, vector bool char);
11571 int vec_any_gt (vector signed char, vector signed char);
11572 int vec_any_gt (vector bool short, vector unsigned short);
11573 int vec_any_gt (vector unsigned short, vector bool short);
11574 int vec_any_gt (vector unsigned short, vector unsigned short);
11575 int vec_any_gt (vector bool short, vector signed short);
11576 int vec_any_gt (vector signed short, vector bool short);
11577 int vec_any_gt (vector signed short, vector signed short);
11578 int vec_any_gt (vector bool int, vector unsigned int);
11579 int vec_any_gt (vector unsigned int, vector bool int);
11580 int vec_any_gt (vector unsigned int, vector unsigned int);
11581 int vec_any_gt (vector bool int, vector signed int);
11582 int vec_any_gt (vector signed int, vector bool int);
11583 int vec_any_gt (vector signed int, vector signed int);
11584 int vec_any_gt (vector float, vector float);
11586 int vec_any_le (vector bool char, vector unsigned char);
11587 int vec_any_le (vector unsigned char, vector bool char);
11588 int vec_any_le (vector unsigned char, vector unsigned char);
11589 int vec_any_le (vector bool char, vector signed char);
11590 int vec_any_le (vector signed char, vector bool char);
11591 int vec_any_le (vector signed char, vector signed char);
11592 int vec_any_le (vector bool short, vector unsigned short);
11593 int vec_any_le (vector unsigned short, vector bool short);
11594 int vec_any_le (vector unsigned short, vector unsigned short);
11595 int vec_any_le (vector bool short, vector signed short);
11596 int vec_any_le (vector signed short, vector bool short);
11597 int vec_any_le (vector signed short, vector signed short);
11598 int vec_any_le (vector bool int, vector unsigned int);
11599 int vec_any_le (vector unsigned int, vector bool int);
11600 int vec_any_le (vector unsigned int, vector unsigned int);
11601 int vec_any_le (vector bool int, vector signed int);
11602 int vec_any_le (vector signed int, vector bool int);
11603 int vec_any_le (vector signed int, vector signed int);
11604 int vec_any_le (vector float, vector float);
11606 int vec_any_lt (vector bool char, vector unsigned char);
11607 int vec_any_lt (vector unsigned char, vector bool char);
11608 int vec_any_lt (vector unsigned char, vector unsigned char);
11609 int vec_any_lt (vector bool char, vector signed char);
11610 int vec_any_lt (vector signed char, vector bool char);
11611 int vec_any_lt (vector signed char, vector signed char);
11612 int vec_any_lt (vector bool short, vector unsigned short);
11613 int vec_any_lt (vector unsigned short, vector bool short);
11614 int vec_any_lt (vector unsigned short, vector unsigned short);
11615 int vec_any_lt (vector bool short, vector signed short);
11616 int vec_any_lt (vector signed short, vector bool short);
11617 int vec_any_lt (vector signed short, vector signed short);
11618 int vec_any_lt (vector bool int, vector unsigned int);
11619 int vec_any_lt (vector unsigned int, vector bool int);
11620 int vec_any_lt (vector unsigned int, vector unsigned int);
11621 int vec_any_lt (vector bool int, vector signed int);
11622 int vec_any_lt (vector signed int, vector bool int);
11623 int vec_any_lt (vector signed int, vector signed int);
11624 int vec_any_lt (vector float, vector float);
11626 int vec_any_nan (vector float);
11628 int vec_any_ne (vector signed char, vector bool char);
11629 int vec_any_ne (vector signed char, vector signed char);
11630 int vec_any_ne (vector unsigned char, vector bool char);
11631 int vec_any_ne (vector unsigned char, vector unsigned char);
11632 int vec_any_ne (vector bool char, vector bool char);
11633 int vec_any_ne (vector bool char, vector unsigned char);
11634 int vec_any_ne (vector bool char, vector signed char);
11635 int vec_any_ne (vector signed short, vector bool short);
11636 int vec_any_ne (vector signed short, vector signed short);
11637 int vec_any_ne (vector unsigned short, vector bool short);
11638 int vec_any_ne (vector unsigned short, vector unsigned short);
11639 int vec_any_ne (vector bool short, vector bool short);
11640 int vec_any_ne (vector bool short, vector unsigned short);
11641 int vec_any_ne (vector bool short, vector signed short);
11642 int vec_any_ne (vector pixel, vector pixel);
11643 int vec_any_ne (vector signed int, vector bool int);
11644 int vec_any_ne (vector signed int, vector signed int);
11645 int vec_any_ne (vector unsigned int, vector bool int);
11646 int vec_any_ne (vector unsigned int, vector unsigned int);
11647 int vec_any_ne (vector bool int, vector bool int);
11648 int vec_any_ne (vector bool int, vector unsigned int);
11649 int vec_any_ne (vector bool int, vector signed int);
11650 int vec_any_ne (vector float, vector float);
11652 int vec_any_nge (vector float, vector float);
11654 int vec_any_ngt (vector float, vector float);
11656 int vec_any_nle (vector float, vector float);
11658 int vec_any_nlt (vector float, vector float);
11660 int vec_any_numeric (vector float);
11662 int vec_any_out (vector float, vector float);
11663 @end smallexample
11665 @node SPARC VIS Built-in Functions
11666 @subsection SPARC VIS Built-in Functions
11668 GCC supports SIMD operations on the SPARC using both the generic vector
11669 extensions (@pxref{Vector Extensions}) as well as built-in functions for
11670 the SPARC Visual Instruction Set (VIS).  When you use the @option{-mvis}
11671 switch, the VIS extension is exposed as the following built-in functions:
11673 @smallexample
11674 typedef int v2si __attribute__ ((vector_size (8)));
11675 typedef short v4hi __attribute__ ((vector_size (8)));
11676 typedef short v2hi __attribute__ ((vector_size (4)));
11677 typedef char v8qi __attribute__ ((vector_size (8)));
11678 typedef char v4qi __attribute__ ((vector_size (4)));
11680 void * __builtin_vis_alignaddr (void *, long);
11681 int64_t __builtin_vis_faligndatadi (int64_t, int64_t);
11682 v2si __builtin_vis_faligndatav2si (v2si, v2si);
11683 v4hi __builtin_vis_faligndatav4hi (v4si, v4si);
11684 v8qi __builtin_vis_faligndatav8qi (v8qi, v8qi);
11686 v4hi __builtin_vis_fexpand (v4qi);
11688 v4hi __builtin_vis_fmul8x16 (v4qi, v4hi);
11689 v4hi __builtin_vis_fmul8x16au (v4qi, v4hi);
11690 v4hi __builtin_vis_fmul8x16al (v4qi, v4hi);
11691 v4hi __builtin_vis_fmul8sux16 (v8qi, v4hi);
11692 v4hi __builtin_vis_fmul8ulx16 (v8qi, v4hi);
11693 v2si __builtin_vis_fmuld8sux16 (v4qi, v2hi);
11694 v2si __builtin_vis_fmuld8ulx16 (v4qi, v2hi);
11696 v4qi __builtin_vis_fpack16 (v4hi);
11697 v8qi __builtin_vis_fpack32 (v2si, v2si);
11698 v2hi __builtin_vis_fpackfix (v2si);
11699 v8qi __builtin_vis_fpmerge (v4qi, v4qi);
11701 int64_t __builtin_vis_pdist (v8qi, v8qi, int64_t);
11702 @end smallexample
11704 @node SPU Built-in Functions
11705 @subsection SPU Built-in Functions
11707 GCC provides extensions for the SPU processor as described in the
11708 Sony/Toshiba/IBM SPU Language Extensions Specification, which can be
11709 found at @uref{http://cell.scei.co.jp/} or
11710 @uref{http://www.ibm.com/developerworks/power/cell/}.  GCC's
11711 implementation differs in several ways.
11713 @itemize @bullet
11715 @item
11716 The optional extension of specifying vector constants in parentheses is
11717 not supported.
11719 @item
11720 A vector initializer requires no cast if the vector constant is of the
11721 same type as the variable it is initializing.
11723 @item
11724 If @code{signed} or @code{unsigned} is omitted, the signedness of the
11725 vector type is the default signedness of the base type.  The default
11726 varies depending on the operating system, so a portable program should
11727 always specify the signedness.
11729 @item
11730 By default, the keyword @code{__vector} is added. The macro
11731 @code{vector} is defined in @code{<spu_intrinsics.h>} and can be
11732 undefined.
11734 @item
11735 GCC allows using a @code{typedef} name as the type specifier for a
11736 vector type.
11738 @item
11739 For C, overloaded functions are implemented with macros so the following
11740 does not work:
11742 @smallexample
11743   spu_add ((vector signed int)@{1, 2, 3, 4@}, foo);
11744 @end smallexample
11746 Since @code{spu_add} is a macro, the vector constant in the example
11747 is treated as four separate arguments.  Wrap the entire argument in
11748 parentheses for this to work.
11750 @item
11751 The extended version of @code{__builtin_expect} is not supported.
11753 @end itemize
11755 @emph{Note:} Only the interface described in the aforementioned
11756 specification is supported. Internally, GCC uses built-in functions to
11757 implement the required functionality, but these are not supported and
11758 are subject to change without notice.
11760 @node Target Format Checks
11761 @section Format Checks Specific to Particular Target Machines
11763 For some target machines, GCC supports additional options to the
11764 format attribute
11765 (@pxref{Function Attributes,,Declaring Attributes of Functions}).
11767 @menu
11768 * Solaris Format Checks::
11769 @end menu
11771 @node Solaris Format Checks
11772 @subsection Solaris Format Checks
11774 Solaris targets support the @code{cmn_err} (or @code{__cmn_err__}) format
11775 check.  @code{cmn_err} accepts a subset of the standard @code{printf}
11776 conversions, and the two-argument @code{%b} conversion for displaying
11777 bit-fields.  See the Solaris man page for @code{cmn_err} for more information.
11779 @node Pragmas
11780 @section Pragmas Accepted by GCC
11781 @cindex pragmas
11782 @cindex #pragma
11784 GCC supports several types of pragmas, primarily in order to compile
11785 code originally written for other compilers.  Note that in general
11786 we do not recommend the use of pragmas; @xref{Function Attributes},
11787 for further explanation.
11789 @menu
11790 * ARM Pragmas::
11791 * M32C Pragmas::
11792 * MeP Pragmas::
11793 * RS/6000 and PowerPC Pragmas::
11794 * Darwin Pragmas::
11795 * Solaris Pragmas::
11796 * Symbol-Renaming Pragmas::
11797 * Structure-Packing Pragmas::
11798 * Weak Pragmas::
11799 * Diagnostic Pragmas::
11800 * Visibility Pragmas::
11801 * Push/Pop Macro Pragmas::
11802 * Function Specific Option Pragmas::
11803 @end menu
11805 @node ARM Pragmas
11806 @subsection ARM Pragmas
11808 The ARM target defines pragmas for controlling the default addition of
11809 @code{long_call} and @code{short_call} attributes to functions.
11810 @xref{Function Attributes}, for information about the effects of these
11811 attributes.
11813 @table @code
11814 @item long_calls
11815 @cindex pragma, long_calls
11816 Set all subsequent functions to have the @code{long_call} attribute.
11818 @item no_long_calls
11819 @cindex pragma, no_long_calls
11820 Set all subsequent functions to have the @code{short_call} attribute.
11822 @item long_calls_off
11823 @cindex pragma, long_calls_off
11824 Do not affect the @code{long_call} or @code{short_call} attributes of
11825 subsequent functions.
11826 @end table
11828 @node M32C Pragmas
11829 @subsection M32C Pragmas
11831 @table @code
11832 @item memregs @var{number}
11833 @cindex pragma, memregs
11834 Overrides the command line option @code{-memregs=} for the current
11835 file.  Use with care!  This pragma must be before any function in the
11836 file, and mixing different memregs values in different objects may
11837 make them incompatible.  This pragma is useful when a
11838 performance-critical function uses a memreg for temporary values,
11839 as it may allow you to reduce the number of memregs used.
11841 @end table
11843 @node MeP Pragmas
11844 @subsection MeP Pragmas
11846 @table @code
11848 @item custom io_volatile (on|off)
11849 @cindex pragma, custom io_volatile
11850 Overrides the command line option @code{-mio-volatile} for the current
11851 file.  Note that for compatibility with future GCC releases, this
11852 option should only be used once before any @code{io} variables in each
11853 file.
11855 @item GCC coprocessor available @var{registers}
11856 @cindex pragma, coprocessor available
11857 Specifies which coprocessor registers are available to the register
11858 allocator.  @var{registers} may be a single register, register range
11859 separated by ellipses, or comma-separated list of those.  Example:
11861 @example
11862 #pragma GCC coprocessor available $c0...$c10, $c28
11863 @end example
11865 @item GCC coprocessor call_saved @var{registers}
11866 @cindex pragma, coprocessor call_saved
11867 Specifies which coprocessor registers are to be saved and restored by
11868 any function using them.  @var{registers} may be a single register,
11869 register range separated by ellipses, or comma-separated list of
11870 those.  Example:
11872 @example
11873 #pragma GCC coprocessor call_saved $c4...$c6, $c31
11874 @end example
11876 @item GCC coprocessor subclass '(A|B|C|D)' = @var{registers}
11877 @cindex pragma, coprocessor subclass
11878 Creates and defines a register class.  These register classes can be
11879 used by inline @code{asm} constructs.  @var{registers} may be a single
11880 register, register range separated by ellipses, or comma-separated
11881 list of those.  Example:
11883 @example
11884 #pragma GCC coprocessor subclass 'B' = $c2, $c4, $c6
11886 asm ("cpfoo %0" : "=B" (x));
11887 @end example
11889 @item GCC disinterrupt @var{name} , @var{name} @dots{}
11890 @cindex pragma, disinterrupt
11891 For the named functions, the compiler adds code to disable interrupts
11892 for the duration of those functions.  Any functions so named, which
11893 are not encountered in the source, cause a warning that the pragma was
11894 not used.  Examples:
11896 @example
11897 #pragma disinterrupt foo
11898 #pragma disinterrupt bar, grill
11899 int foo () @{ @dots{} @}
11900 @end example
11902 @item GCC call @var{name} , @var{name} @dots{}
11903 @cindex pragma, call
11904 For the named functions, the compiler always uses a register-indirect
11905 call model when calling the named functions.  Examples:
11907 @example
11908 extern int foo ();
11909 #pragma call foo
11910 @end example
11912 @end table
11915 @node RS/6000 and PowerPC Pragmas
11916 @subsection RS/6000 and PowerPC Pragmas
11918 The RS/6000 and PowerPC targets define one pragma for controlling
11919 whether or not the @code{longcall} attribute is added to function
11920 declarations by default.  This pragma overrides the @option{-mlongcall}
11921 option, but not the @code{longcall} and @code{shortcall} attributes.
11922 @xref{RS/6000 and PowerPC Options}, for more information about when long
11923 calls are and are not necessary.
11925 @table @code
11926 @item longcall (1)
11927 @cindex pragma, longcall
11928 Apply the @code{longcall} attribute to all subsequent function
11929 declarations.
11931 @item longcall (0)
11932 Do not apply the @code{longcall} attribute to subsequent function
11933 declarations.
11934 @end table
11936 @c Describe h8300 pragmas here.
11937 @c Describe sh pragmas here.
11938 @c Describe v850 pragmas here.
11940 @node Darwin Pragmas
11941 @subsection Darwin Pragmas
11943 The following pragmas are available for all architectures running the
11944 Darwin operating system.  These are useful for compatibility with other
11945 Mac OS compilers.
11947 @table @code
11948 @item mark @var{tokens}@dots{}
11949 @cindex pragma, mark
11950 This pragma is accepted, but has no effect.
11952 @item options align=@var{alignment}
11953 @cindex pragma, options align
11954 This pragma sets the alignment of fields in structures.  The values of
11955 @var{alignment} may be @code{mac68k}, to emulate m68k alignment, or
11956 @code{power}, to emulate PowerPC alignment.  Uses of this pragma nest
11957 properly; to restore the previous setting, use @code{reset} for the
11958 @var{alignment}.
11960 @item segment @var{tokens}@dots{}
11961 @cindex pragma, segment
11962 This pragma is accepted, but has no effect.
11964 @item unused (@var{var} [, @var{var}]@dots{})
11965 @cindex pragma, unused
11966 This pragma declares variables to be possibly unused.  GCC will not
11967 produce warnings for the listed variables.  The effect is similar to
11968 that of the @code{unused} attribute, except that this pragma may appear
11969 anywhere within the variables' scopes.
11970 @end table
11972 @node Solaris Pragmas
11973 @subsection Solaris Pragmas
11975 The Solaris target supports @code{#pragma redefine_extname}
11976 (@pxref{Symbol-Renaming Pragmas}).  It also supports additional
11977 @code{#pragma} directives for compatibility with the system compiler.
11979 @table @code
11980 @item align @var{alignment} (@var{variable} [, @var{variable}]...)
11981 @cindex pragma, align
11983 Increase the minimum alignment of each @var{variable} to @var{alignment}.
11984 This is the same as GCC's @code{aligned} attribute @pxref{Variable
11985 Attributes}).  Macro expansion occurs on the arguments to this pragma
11986 when compiling C and Objective-C@.  It does not currently occur when
11987 compiling C++, but this is a bug which may be fixed in a future
11988 release.
11990 @item fini (@var{function} [, @var{function}]...)
11991 @cindex pragma, fini
11993 This pragma causes each listed @var{function} to be called after
11994 main, or during shared module unloading, by adding a call to the
11995 @code{.fini} section.
11997 @item init (@var{function} [, @var{function}]...)
11998 @cindex pragma, init
12000 This pragma causes each listed @var{function} to be called during
12001 initialization (before @code{main}) or during shared module loading, by
12002 adding a call to the @code{.init} section.
12004 @end table
12006 @node Symbol-Renaming Pragmas
12007 @subsection Symbol-Renaming Pragmas
12009 For compatibility with the Solaris and Tru64 UNIX system headers, GCC
12010 supports two @code{#pragma} directives which change the name used in
12011 assembly for a given declaration.  These pragmas are only available on
12012 platforms whose system headers need them.  To get this effect on all
12013 platforms supported by GCC, use the asm labels extension (@pxref{Asm
12014 Labels}).
12016 @table @code
12017 @item redefine_extname @var{oldname} @var{newname}
12018 @cindex pragma, redefine_extname
12020 This pragma gives the C function @var{oldname} the assembly symbol
12021 @var{newname}.  The preprocessor macro @code{__PRAGMA_REDEFINE_EXTNAME}
12022 will be defined if this pragma is available (currently only on
12023 Solaris).
12025 @item extern_prefix @var{string}
12026 @cindex pragma, extern_prefix
12028 This pragma causes all subsequent external function and variable
12029 declarations to have @var{string} prepended to their assembly symbols.
12030 This effect may be terminated with another @code{extern_prefix} pragma
12031 whose argument is an empty string.  The preprocessor macro
12032 @code{__PRAGMA_EXTERN_PREFIX} will be defined if this pragma is
12033 available (currently only on Tru64 UNIX)@.
12034 @end table
12036 These pragmas and the asm labels extension interact in a complicated
12037 manner.  Here are some corner cases you may want to be aware of.
12039 @enumerate
12040 @item Both pragmas silently apply only to declarations with external
12041 linkage.  Asm labels do not have this restriction.
12043 @item In C++, both pragmas silently apply only to declarations with
12044 ``C'' linkage.  Again, asm labels do not have this restriction.
12046 @item If any of the three ways of changing the assembly name of a
12047 declaration is applied to a declaration whose assembly name has
12048 already been determined (either by a previous use of one of these
12049 features, or because the compiler needed the assembly name in order to
12050 generate code), and the new name is different, a warning issues and
12051 the name does not change.
12053 @item The @var{oldname} used by @code{#pragma redefine_extname} is
12054 always the C-language name.
12056 @item If @code{#pragma extern_prefix} is in effect, and a declaration
12057 occurs with an asm label attached, the prefix is silently ignored for
12058 that declaration.
12060 @item If @code{#pragma extern_prefix} and @code{#pragma redefine_extname}
12061 apply to the same declaration, whichever triggered first wins, and a
12062 warning issues if they contradict each other.  (We would like to have
12063 @code{#pragma redefine_extname} always win, for consistency with asm
12064 labels, but if @code{#pragma extern_prefix} triggers first we have no
12065 way of knowing that that happened.)
12066 @end enumerate
12068 @node Structure-Packing Pragmas
12069 @subsection Structure-Packing Pragmas
12071 For compatibility with Microsoft Windows compilers, GCC supports a
12072 set of @code{#pragma} directives which change the maximum alignment of
12073 members of structures (other than zero-width bitfields), unions, and
12074 classes subsequently defined. The @var{n} value below always is required
12075 to be a small power of two and specifies the new alignment in bytes.
12077 @enumerate
12078 @item @code{#pragma pack(@var{n})} simply sets the new alignment.
12079 @item @code{#pragma pack()} sets the alignment to the one that was in
12080 effect when compilation started (see also command line option
12081 @option{-fpack-struct[=<n>]} @pxref{Code Gen Options}).
12082 @item @code{#pragma pack(push[,@var{n}])} pushes the current alignment
12083 setting on an internal stack and then optionally sets the new alignment.
12084 @item @code{#pragma pack(pop)} restores the alignment setting to the one
12085 saved at the top of the internal stack (and removes that stack entry).
12086 Note that @code{#pragma pack([@var{n}])} does not influence this internal
12087 stack; thus it is possible to have @code{#pragma pack(push)} followed by
12088 multiple @code{#pragma pack(@var{n})} instances and finalized by a single
12089 @code{#pragma pack(pop)}.
12090 @end enumerate
12092 Some targets, e.g.@: i386 and powerpc, support the @code{ms_struct}
12093 @code{#pragma} which lays out a structure as the documented
12094 @code{__attribute__ ((ms_struct))}.
12095 @enumerate
12096 @item @code{#pragma ms_struct on} turns on the layout for structures
12097 declared.
12098 @item @code{#pragma ms_struct off} turns off the layout for structures
12099 declared.
12100 @item @code{#pragma ms_struct reset} goes back to the default layout.
12101 @end enumerate
12103 @node Weak Pragmas
12104 @subsection Weak Pragmas
12106 For compatibility with SVR4, GCC supports a set of @code{#pragma}
12107 directives for declaring symbols to be weak, and defining weak
12108 aliases.
12110 @table @code
12111 @item #pragma weak @var{symbol}
12112 @cindex pragma, weak
12113 This pragma declares @var{symbol} to be weak, as if the declaration
12114 had the attribute of the same name.  The pragma may appear before
12115 or after the declaration of @var{symbol}, but must appear before
12116 either its first use or its definition.  It is not an error for
12117 @var{symbol} to never be defined at all.
12119 @item #pragma weak @var{symbol1} = @var{symbol2}
12120 This pragma declares @var{symbol1} to be a weak alias of @var{symbol2}.
12121 It is an error if @var{symbol2} is not defined in the current
12122 translation unit.
12123 @end table
12125 @node Diagnostic Pragmas
12126 @subsection Diagnostic Pragmas
12128 GCC allows the user to selectively enable or disable certain types of
12129 diagnostics, and change the kind of the diagnostic.  For example, a
12130 project's policy might require that all sources compile with
12131 @option{-Werror} but certain files might have exceptions allowing
12132 specific types of warnings.  Or, a project might selectively enable
12133 diagnostics and treat them as errors depending on which preprocessor
12134 macros are defined.
12136 @table @code
12137 @item #pragma GCC diagnostic @var{kind} @var{option}
12138 @cindex pragma, diagnostic
12140 Modifies the disposition of a diagnostic.  Note that not all
12141 diagnostics are modifiable; at the moment only warnings (normally
12142 controlled by @samp{-W@dots{}}) can be controlled, and not all of them.
12143 Use @option{-fdiagnostics-show-option} to determine which diagnostics
12144 are controllable and which option controls them.
12146 @var{kind} is @samp{error} to treat this diagnostic as an error,
12147 @samp{warning} to treat it like a warning (even if @option{-Werror} is
12148 in effect), or @samp{ignored} if the diagnostic is to be ignored.
12149 @var{option} is a double quoted string which matches the command line
12150 option.
12152 @example
12153 #pragma GCC diagnostic warning "-Wformat"
12154 #pragma GCC diagnostic error "-Wformat"
12155 #pragma GCC diagnostic ignored "-Wformat"
12156 @end example
12158 Note that these pragmas override any command line options.  Also,
12159 while it is syntactically valid to put these pragmas anywhere in your
12160 sources, the only supported location for them is before any data or
12161 functions are defined.  Doing otherwise may result in unpredictable
12162 results depending on how the optimizer manages your sources.  If the
12163 same option is listed multiple times, the last one specified is the
12164 one that is in effect.  This pragma is not intended to be a general
12165 purpose replacement for command line options, but for implementing
12166 strict control over project policies.
12168 @end table
12170 GCC also offers a simple mechanism for printing messages during
12171 compilation.
12173 @table @code
12174 @item #pragma message @var{string}
12175 @cindex pragma, diagnostic
12177 Prints @var{string} as a compiler message on compilation.  The message
12178 is informational only, and is neither a compilation warning nor an error.
12180 @smallexample
12181 #pragma message "Compiling " __FILE__ "..."
12182 @end smallexample
12184 @var{string} may be parenthesized, and is printed with location
12185 information.  For example,
12187 @smallexample
12188 #define DO_PRAGMA(x) _Pragma (#x)
12189 #define TODO(x) DO_PRAGMA(message ("TODO - " #x))
12191 TODO(Remember to fix this)
12192 @end smallexample
12194 prints @samp{/tmp/file.c:4: note: #pragma message:
12195 TODO - Remember to fix this}.
12197 @end table
12199 @node Visibility Pragmas
12200 @subsection Visibility Pragmas
12202 @table @code
12203 @item #pragma GCC visibility push(@var{visibility})
12204 @itemx #pragma GCC visibility pop
12205 @cindex pragma, visibility
12207 This pragma allows the user to set the visibility for multiple
12208 declarations without having to give each a visibility attribute
12209 @xref{Function Attributes}, for more information about visibility and
12210 the attribute syntax.
12212 In C++, @samp{#pragma GCC visibility} affects only namespace-scope
12213 declarations.  Class members and template specializations are not
12214 affected; if you want to override the visibility for a particular
12215 member or instantiation, you must use an attribute.
12217 @end table
12220 @node Push/Pop Macro Pragmas
12221 @subsection Push/Pop Macro Pragmas
12223 For compatibility with Microsoft Windows compilers, GCC supports
12224 @samp{#pragma push_macro(@var{"macro_name"})}
12225 and @samp{#pragma pop_macro(@var{"macro_name"})}.
12227 @table @code
12228 @item #pragma push_macro(@var{"macro_name"})
12229 @cindex pragma, push_macro
12230 This pragma saves the value of the macro named as @var{macro_name} to
12231 the top of the stack for this macro.
12233 @item #pragma pop_macro(@var{"macro_name"})
12234 @cindex pragma, pop_macro
12235 This pragma sets the value of the macro named as @var{macro_name} to
12236 the value on top of the stack for this macro. If the stack for
12237 @var{macro_name} is empty, the value of the macro remains unchanged.
12238 @end table
12240 For example:
12242 @smallexample
12243 #define X  1
12244 #pragma push_macro("X")
12245 #undef X
12246 #define X -1
12247 #pragma pop_macro("X")
12248 int x [X]; 
12249 @end smallexample
12251 In this example, the definition of X as 1 is saved by @code{#pragma
12252 push_macro} and restored by @code{#pragma pop_macro}.
12254 @node Function Specific Option Pragmas
12255 @subsection Function Specific Option Pragmas
12257 @table @code
12258 @item #pragma GCC target (@var{"string"}...)
12259 @cindex pragma GCC target
12261 This pragma allows you to set target specific options for functions
12262 defined later in the source file.  One or more strings can be
12263 specified.  Each function that is defined after this point will be as
12264 if @code{attribute((target("STRING")))} was specified for that
12265 function.  The parenthesis around the options is optional.
12266 @xref{Function Attributes}, for more information about the
12267 @code{target} attribute and the attribute syntax.
12269 The @samp{#pragma GCC target} pragma is not implemented in GCC
12270 versions earlier than 4.4, and is currently only implemented for the
12271 386 and x86_64 backends.
12272 @end table
12274 @table @code
12275 @item #pragma GCC optimize (@var{"string"}...)
12276 @cindex pragma GCC optimize
12278 This pragma allows you to set global optimization options for functions
12279 defined later in the source file.  One or more strings can be
12280 specified.  Each function that is defined after this point will be as
12281 if @code{attribute((optimize("STRING")))} was specified for that
12282 function.  The parenthesis around the options is optional.
12283 @xref{Function Attributes}, for more information about the
12284 @code{optimize} attribute and the attribute syntax.
12286 The @samp{#pragma GCC optimize} pragma is not implemented in GCC
12287 versions earlier than 4.4.
12288 @end table
12290 @table @code
12291 @item #pragma GCC push_options
12292 @itemx #pragma GCC pop_options
12293 @cindex pragma GCC push_options
12294 @cindex pragma GCC pop_options
12296 These pragmas maintain a stack of the current target and optimization
12297 options.  It is intended for include files where you temporarily want
12298 to switch to using a different @samp{#pragma GCC target} or
12299 @samp{#pragma GCC optimize} and then to pop back to the previous
12300 options.
12302 The @samp{#pragma GCC push_options} and @samp{#pragma GCC pop_options}
12303 pragmas are not implemented in GCC versions earlier than 4.4.
12304 @end table
12306 @table @code
12307 @item #pragma GCC reset_options
12308 @cindex pragma GCC reset_options
12310 This pragma clears the current @code{#pragma GCC target} and
12311 @code{#pragma GCC optimize} to use the default switches as specified
12312 on the command line.
12314 The @samp{#pragma GCC reset_options} pragma is not implemented in GCC
12315 versions earlier than 4.4.
12316 @end table
12318 @node Unnamed Fields
12319 @section Unnamed struct/union fields within structs/unions
12320 @cindex struct
12321 @cindex union
12323 For compatibility with other compilers, GCC allows you to define
12324 a structure or union that contains, as fields, structures and unions
12325 without names.  For example:
12327 @smallexample
12328 struct @{
12329   int a;
12330   union @{
12331     int b;
12332     float c;
12333   @};
12334   int d;
12335 @} foo;
12336 @end smallexample
12338 In this example, the user would be able to access members of the unnamed
12339 union with code like @samp{foo.b}.  Note that only unnamed structs and
12340 unions are allowed, you may not have, for example, an unnamed
12341 @code{int}.
12343 You must never create such structures that cause ambiguous field definitions.
12344 For example, this structure:
12346 @smallexample
12347 struct @{
12348   int a;
12349   struct @{
12350     int a;
12351   @};
12352 @} foo;
12353 @end smallexample
12355 It is ambiguous which @code{a} is being referred to with @samp{foo.a}.
12356 Such constructs are not supported and must be avoided.  In the future,
12357 such constructs may be detected and treated as compilation errors.
12359 @opindex fms-extensions
12360 Unless @option{-fms-extensions} is used, the unnamed field must be a
12361 structure or union definition without a tag (for example, @samp{struct
12362 @{ int a; @};}).  If @option{-fms-extensions} is used, the field may
12363 also be a definition with a tag such as @samp{struct foo @{ int a;
12364 @};}, a reference to a previously defined structure or union such as
12365 @samp{struct foo;}, or a reference to a @code{typedef} name for a
12366 previously defined structure or union type.
12368 @node Thread-Local
12369 @section Thread-Local Storage
12370 @cindex Thread-Local Storage
12371 @cindex @acronym{TLS}
12372 @cindex __thread
12374 Thread-local storage (@acronym{TLS}) is a mechanism by which variables
12375 are allocated such that there is one instance of the variable per extant
12376 thread.  The run-time model GCC uses to implement this originates
12377 in the IA-64 processor-specific ABI, but has since been migrated
12378 to other processors as well.  It requires significant support from
12379 the linker (@command{ld}), dynamic linker (@command{ld.so}), and
12380 system libraries (@file{libc.so} and @file{libpthread.so}), so it
12381 is not available everywhere.
12383 At the user level, the extension is visible with a new storage
12384 class keyword: @code{__thread}.  For example:
12386 @smallexample
12387 __thread int i;
12388 extern __thread struct state s;
12389 static __thread char *p;
12390 @end smallexample
12392 The @code{__thread} specifier may be used alone, with the @code{extern}
12393 or @code{static} specifiers, but with no other storage class specifier.
12394 When used with @code{extern} or @code{static}, @code{__thread} must appear
12395 immediately after the other storage class specifier.
12397 The @code{__thread} specifier may be applied to any global, file-scoped
12398 static, function-scoped static, or static data member of a class.  It may
12399 not be applied to block-scoped automatic or non-static data member.
12401 When the address-of operator is applied to a thread-local variable, it is
12402 evaluated at run-time and returns the address of the current thread's
12403 instance of that variable.  An address so obtained may be used by any
12404 thread.  When a thread terminates, any pointers to thread-local variables
12405 in that thread become invalid.
12407 No static initialization may refer to the address of a thread-local variable.
12409 In C++, if an initializer is present for a thread-local variable, it must
12410 be a @var{constant-expression}, as defined in 5.19.2 of the ANSI/ISO C++
12411 standard.
12413 See @uref{http://people.redhat.com/drepper/tls.pdf,
12414 ELF Handling For Thread-Local Storage} for a detailed explanation of
12415 the four thread-local storage addressing models, and how the run-time
12416 is expected to function.
12418 @menu
12419 * C99 Thread-Local Edits::
12420 * C++98 Thread-Local Edits::
12421 @end menu
12423 @node C99 Thread-Local Edits
12424 @subsection ISO/IEC 9899:1999 Edits for Thread-Local Storage
12426 The following are a set of changes to ISO/IEC 9899:1999 (aka C99)
12427 that document the exact semantics of the language extension.
12429 @itemize @bullet
12430 @item
12431 @cite{5.1.2  Execution environments}
12433 Add new text after paragraph 1
12435 @quotation
12436 Within either execution environment, a @dfn{thread} is a flow of
12437 control within a program.  It is implementation defined whether
12438 or not there may be more than one thread associated with a program.
12439 It is implementation defined how threads beyond the first are
12440 created, the name and type of the function called at thread
12441 startup, and how threads may be terminated.  However, objects
12442 with thread storage duration shall be initialized before thread
12443 startup.
12444 @end quotation
12446 @item
12447 @cite{6.2.4  Storage durations of objects}
12449 Add new text before paragraph 3
12451 @quotation
12452 An object whose identifier is declared with the storage-class
12453 specifier @w{@code{__thread}} has @dfn{thread storage duration}.
12454 Its lifetime is the entire execution of the thread, and its
12455 stored value is initialized only once, prior to thread startup.
12456 @end quotation
12458 @item
12459 @cite{6.4.1  Keywords}
12461 Add @code{__thread}.
12463 @item
12464 @cite{6.7.1  Storage-class specifiers}
12466 Add @code{__thread} to the list of storage class specifiers in
12467 paragraph 1.
12469 Change paragraph 2 to
12471 @quotation
12472 With the exception of @code{__thread}, at most one storage-class
12473 specifier may be given [@dots{}].  The @code{__thread} specifier may
12474 be used alone, or immediately following @code{extern} or
12475 @code{static}.
12476 @end quotation
12478 Add new text after paragraph 6
12480 @quotation
12481 The declaration of an identifier for a variable that has
12482 block scope that specifies @code{__thread} shall also
12483 specify either @code{extern} or @code{static}.
12485 The @code{__thread} specifier shall be used only with
12486 variables.
12487 @end quotation
12488 @end itemize
12490 @node C++98 Thread-Local Edits
12491 @subsection ISO/IEC 14882:1998 Edits for Thread-Local Storage
12493 The following are a set of changes to ISO/IEC 14882:1998 (aka C++98)
12494 that document the exact semantics of the language extension.
12496 @itemize @bullet
12497 @item
12498 @b{[intro.execution]}
12500 New text after paragraph 4
12502 @quotation
12503 A @dfn{thread} is a flow of control within the abstract machine.
12504 It is implementation defined whether or not there may be more than
12505 one thread.
12506 @end quotation
12508 New text after paragraph 7
12510 @quotation
12511 It is unspecified whether additional action must be taken to
12512 ensure when and whether side effects are visible to other threads.
12513 @end quotation
12515 @item
12516 @b{[lex.key]}
12518 Add @code{__thread}.
12520 @item
12521 @b{[basic.start.main]}
12523 Add after paragraph 5
12525 @quotation
12526 The thread that begins execution at the @code{main} function is called
12527 the @dfn{main thread}.  It is implementation defined how functions
12528 beginning threads other than the main thread are designated or typed.
12529 A function so designated, as well as the @code{main} function, is called
12530 a @dfn{thread startup function}.  It is implementation defined what
12531 happens if a thread startup function returns.  It is implementation
12532 defined what happens to other threads when any thread calls @code{exit}.
12533 @end quotation
12535 @item
12536 @b{[basic.start.init]}
12538 Add after paragraph 4
12540 @quotation
12541 The storage for an object of thread storage duration shall be
12542 statically initialized before the first statement of the thread startup
12543 function.  An object of thread storage duration shall not require
12544 dynamic initialization.
12545 @end quotation
12547 @item
12548 @b{[basic.start.term]}
12550 Add after paragraph 3
12552 @quotation
12553 The type of an object with thread storage duration shall not have a
12554 non-trivial destructor, nor shall it be an array type whose elements
12555 (directly or indirectly) have non-trivial destructors.
12556 @end quotation
12558 @item
12559 @b{[basic.stc]}
12561 Add ``thread storage duration'' to the list in paragraph 1.
12563 Change paragraph 2
12565 @quotation
12566 Thread, static, and automatic storage durations are associated with
12567 objects introduced by declarations [@dots{}].
12568 @end quotation
12570 Add @code{__thread} to the list of specifiers in paragraph 3.
12572 @item
12573 @b{[basic.stc.thread]}
12575 New section before @b{[basic.stc.static]}
12577 @quotation
12578 The keyword @code{__thread} applied to a non-local object gives the
12579 object thread storage duration.
12581 A local variable or class data member declared both @code{static}
12582 and @code{__thread} gives the variable or member thread storage
12583 duration.
12584 @end quotation
12586 @item
12587 @b{[basic.stc.static]}
12589 Change paragraph 1
12591 @quotation
12592 All objects which have neither thread storage duration, dynamic
12593 storage duration nor are local [@dots{}].
12594 @end quotation
12596 @item
12597 @b{[dcl.stc]}
12599 Add @code{__thread} to the list in paragraph 1.
12601 Change paragraph 1
12603 @quotation
12604 With the exception of @code{__thread}, at most one
12605 @var{storage-class-specifier} shall appear in a given
12606 @var{decl-specifier-seq}.  The @code{__thread} specifier may
12607 be used alone, or immediately following the @code{extern} or
12608 @code{static} specifiers.  [@dots{}]
12609 @end quotation
12611 Add after paragraph 5
12613 @quotation
12614 The @code{__thread} specifier can be applied only to the names of objects
12615 and to anonymous unions.
12616 @end quotation
12618 @item
12619 @b{[class.mem]}
12621 Add after paragraph 6
12623 @quotation
12624 Non-@code{static} members shall not be @code{__thread}.
12625 @end quotation
12626 @end itemize
12628 @node Binary constants
12629 @section Binary constants using the @samp{0b} prefix
12630 @cindex Binary constants using the @samp{0b} prefix
12632 Integer constants can be written as binary constants, consisting of a
12633 sequence of @samp{0} and @samp{1} digits, prefixed by @samp{0b} or
12634 @samp{0B}.  This is particularly useful in environments that operate a
12635 lot on the bit-level (like microcontrollers).
12637 The following statements are identical:
12639 @smallexample
12640 i =       42;
12641 i =     0x2a;
12642 i =      052;
12643 i = 0b101010;
12644 @end smallexample
12646 The type of these constants follows the same rules as for octal or
12647 hexadecimal integer constants, so suffixes like @samp{L} or @samp{UL}
12648 can be applied.
12650 @node C++ Extensions
12651 @chapter Extensions to the C++ Language
12652 @cindex extensions, C++ language
12653 @cindex C++ language extensions
12655 The GNU compiler provides these extensions to the C++ language (and you
12656 can also use most of the C language extensions in your C++ programs).  If you
12657 want to write code that checks whether these features are available, you can
12658 test for the GNU compiler the same way as for C programs: check for a
12659 predefined macro @code{__GNUC__}.  You can also use @code{__GNUG__} to
12660 test specifically for GNU C++ (@pxref{Common Predefined Macros,,
12661 Predefined Macros,cpp,The GNU C Preprocessor}).
12663 @menu
12664 * Volatiles::           What constitutes an access to a volatile object.
12665 * Restricted Pointers:: C99 restricted pointers and references.
12666 * Vague Linkage::       Where G++ puts inlines, vtables and such.
12667 * C++ Interface::       You can use a single C++ header file for both
12668                         declarations and definitions.
12669 * Template Instantiation:: Methods for ensuring that exactly one copy of
12670                         each needed template instantiation is emitted.
12671 * Bound member functions:: You can extract a function pointer to the
12672                         method denoted by a @samp{->*} or @samp{.*} expression.
12673 * C++ Attributes::      Variable, function, and type attributes for C++ only.
12674 * Namespace Association:: Strong using-directives for namespace association.
12675 * Type Traits::         Compiler support for type traits
12676 * Java Exceptions::     Tweaking exception handling to work with Java.
12677 * Deprecated Features:: Things will disappear from g++.
12678 * Backwards Compatibility:: Compatibilities with earlier definitions of C++.
12679 @end menu
12681 @node Volatiles
12682 @section When is a Volatile Object Accessed?
12683 @cindex accessing volatiles
12684 @cindex volatile read
12685 @cindex volatile write
12686 @cindex volatile access
12688 Both the C and C++ standard have the concept of volatile objects.  These
12689 are normally accessed by pointers and used for accessing hardware.  The
12690 standards encourage compilers to refrain from optimizations concerning
12691 accesses to volatile objects.  The C standard leaves it implementation
12692 defined  as to what constitutes a volatile access.  The C++ standard omits
12693 to specify this, except to say that C++ should behave in a similar manner
12694 to C with respect to volatiles, where possible.  The minimum either
12695 standard specifies is that at a sequence point all previous accesses to
12696 volatile objects have stabilized and no subsequent accesses have
12697 occurred.  Thus an implementation is free to reorder and combine
12698 volatile accesses which occur between sequence points, but cannot do so
12699 for accesses across a sequence point.  The use of volatiles does not
12700 allow you to violate the restriction on updating objects multiple times
12701 within a sequence point.
12703 @xref{Qualifiers implementation, , Volatile qualifier and the C compiler}.
12705 The behavior differs slightly between C and C++ in the non-obvious cases:
12707 @smallexample
12708 volatile int *src = @var{somevalue};
12709 *src;
12710 @end smallexample
12712 With C, such expressions are rvalues, and GCC interprets this either as a
12713 read of the volatile object being pointed to or only as request to evaluate
12714 the side-effects.  The C++ standard specifies that such expressions do not
12715 undergo lvalue to rvalue conversion, and that the type of the dereferenced
12716 object may be incomplete.  The C++ standard does not specify explicitly
12717 that it is this lvalue to rvalue conversion which may be responsible for
12718 causing an access.  However, there is reason to believe that it is,
12719 because otherwise certain simple expressions become undefined.  However,
12720 because it would surprise most programmers, G++ treats dereferencing a
12721 pointer to volatile object of complete type when the value is unused as
12722 GCC would do for an equivalent type in C@.  When the object has incomplete
12723 type, G++ issues a warning; if you wish to force an error, you must
12724 force a conversion to rvalue with, for instance, a static cast.
12726 When using a reference to volatile, G++ does not treat equivalent
12727 expressions as accesses to volatiles, but instead issues a warning that
12728 no volatile is accessed.  The rationale for this is that otherwise it
12729 becomes difficult to determine where volatile access occur, and not
12730 possible to ignore the return value from functions returning volatile
12731 references.  Again, if you wish to force a read, cast the reference to
12732 an rvalue.
12734 @node Restricted Pointers
12735 @section Restricting Pointer Aliasing
12736 @cindex restricted pointers
12737 @cindex restricted references
12738 @cindex restricted this pointer
12740 As with the C front end, G++ understands the C99 feature of restricted pointers,
12741 specified with the @code{__restrict__}, or @code{__restrict} type
12742 qualifier.  Because you cannot compile C++ by specifying the @option{-std=c99}
12743 language flag, @code{restrict} is not a keyword in C++.
12745 In addition to allowing restricted pointers, you can specify restricted
12746 references, which indicate that the reference is not aliased in the local
12747 context.
12749 @smallexample
12750 void fn (int *__restrict__ rptr, int &__restrict__ rref)
12752   /* @r{@dots{}} */
12754 @end smallexample
12756 @noindent
12757 In the body of @code{fn}, @var{rptr} points to an unaliased integer and
12758 @var{rref} refers to a (different) unaliased integer.
12760 You may also specify whether a member function's @var{this} pointer is
12761 unaliased by using @code{__restrict__} as a member function qualifier.
12763 @smallexample
12764 void T::fn () __restrict__
12766   /* @r{@dots{}} */
12768 @end smallexample
12770 @noindent
12771 Within the body of @code{T::fn}, @var{this} will have the effective
12772 definition @code{T *__restrict__ const this}.  Notice that the
12773 interpretation of a @code{__restrict__} member function qualifier is
12774 different to that of @code{const} or @code{volatile} qualifier, in that it
12775 is applied to the pointer rather than the object.  This is consistent with
12776 other compilers which implement restricted pointers.
12778 As with all outermost parameter qualifiers, @code{__restrict__} is
12779 ignored in function definition matching.  This means you only need to
12780 specify @code{__restrict__} in a function definition, rather than
12781 in a function prototype as well.
12783 @node Vague Linkage
12784 @section Vague Linkage
12785 @cindex vague linkage
12787 There are several constructs in C++ which require space in the object
12788 file but are not clearly tied to a single translation unit.  We say that
12789 these constructs have ``vague linkage''.  Typically such constructs are
12790 emitted wherever they are needed, though sometimes we can be more
12791 clever.
12793 @table @asis
12794 @item Inline Functions
12795 Inline functions are typically defined in a header file which can be
12796 included in many different compilations.  Hopefully they can usually be
12797 inlined, but sometimes an out-of-line copy is necessary, if the address
12798 of the function is taken or if inlining fails.  In general, we emit an
12799 out-of-line copy in all translation units where one is needed.  As an
12800 exception, we only emit inline virtual functions with the vtable, since
12801 it will always require a copy.
12803 Local static variables and string constants used in an inline function
12804 are also considered to have vague linkage, since they must be shared
12805 between all inlined and out-of-line instances of the function.
12807 @item VTables
12808 @cindex vtable
12809 C++ virtual functions are implemented in most compilers using a lookup
12810 table, known as a vtable.  The vtable contains pointers to the virtual
12811 functions provided by a class, and each object of the class contains a
12812 pointer to its vtable (or vtables, in some multiple-inheritance
12813 situations).  If the class declares any non-inline, non-pure virtual
12814 functions, the first one is chosen as the ``key method'' for the class,
12815 and the vtable is only emitted in the translation unit where the key
12816 method is defined.
12818 @emph{Note:} If the chosen key method is later defined as inline, the
12819 vtable will still be emitted in every translation unit which defines it.
12820 Make sure that any inline virtuals are declared inline in the class
12821 body, even if they are not defined there.
12823 @item type_info objects
12824 @cindex type_info
12825 @cindex RTTI
12826 C++ requires information about types to be written out in order to
12827 implement @samp{dynamic_cast}, @samp{typeid} and exception handling.
12828 For polymorphic classes (classes with virtual functions), the type_info
12829 object is written out along with the vtable so that @samp{dynamic_cast}
12830 can determine the dynamic type of a class object at runtime.  For all
12831 other types, we write out the type_info object when it is used: when
12832 applying @samp{typeid} to an expression, throwing an object, or
12833 referring to a type in a catch clause or exception specification.
12835 @item Template Instantiations
12836 Most everything in this section also applies to template instantiations,
12837 but there are other options as well.
12838 @xref{Template Instantiation,,Where's the Template?}.
12840 @end table
12842 When used with GNU ld version 2.8 or later on an ELF system such as
12843 GNU/Linux or Solaris 2, or on Microsoft Windows, duplicate copies of
12844 these constructs will be discarded at link time.  This is known as
12845 COMDAT support.
12847 On targets that don't support COMDAT, but do support weak symbols, GCC
12848 will use them.  This way one copy will override all the others, but
12849 the unused copies will still take up space in the executable.
12851 For targets which do not support either COMDAT or weak symbols,
12852 most entities with vague linkage will be emitted as local symbols to
12853 avoid duplicate definition errors from the linker.  This will not happen
12854 for local statics in inlines, however, as having multiple copies will
12855 almost certainly break things.
12857 @xref{C++ Interface,,Declarations and Definitions in One Header}, for
12858 another way to control placement of these constructs.
12860 @node C++ Interface
12861 @section #pragma interface and implementation
12863 @cindex interface and implementation headers, C++
12864 @cindex C++ interface and implementation headers
12865 @cindex pragmas, interface and implementation
12867 @code{#pragma interface} and @code{#pragma implementation} provide the
12868 user with a way of explicitly directing the compiler to emit entities
12869 with vague linkage (and debugging information) in a particular
12870 translation unit.
12872 @emph{Note:} As of GCC 2.7.2, these @code{#pragma}s are not useful in
12873 most cases, because of COMDAT support and the ``key method'' heuristic
12874 mentioned in @ref{Vague Linkage}.  Using them can actually cause your
12875 program to grow due to unnecessary out-of-line copies of inline
12876 functions.  Currently (3.4) the only benefit of these
12877 @code{#pragma}s is reduced duplication of debugging information, and
12878 that should be addressed soon on DWARF 2 targets with the use of
12879 COMDAT groups.
12881 @table @code
12882 @item #pragma interface
12883 @itemx #pragma interface "@var{subdir}/@var{objects}.h"
12884 @kindex #pragma interface
12885 Use this directive in @emph{header files} that define object classes, to save
12886 space in most of the object files that use those classes.  Normally,
12887 local copies of certain information (backup copies of inline member
12888 functions, debugging information, and the internal tables that implement
12889 virtual functions) must be kept in each object file that includes class
12890 definitions.  You can use this pragma to avoid such duplication.  When a
12891 header file containing @samp{#pragma interface} is included in a
12892 compilation, this auxiliary information will not be generated (unless
12893 the main input source file itself uses @samp{#pragma implementation}).
12894 Instead, the object files will contain references to be resolved at link
12895 time.
12897 The second form of this directive is useful for the case where you have
12898 multiple headers with the same name in different directories.  If you
12899 use this form, you must specify the same string to @samp{#pragma
12900 implementation}.
12902 @item #pragma implementation
12903 @itemx #pragma implementation "@var{objects}.h"
12904 @kindex #pragma implementation
12905 Use this pragma in a @emph{main input file}, when you want full output from
12906 included header files to be generated (and made globally visible).  The
12907 included header file, in turn, should use @samp{#pragma interface}.
12908 Backup copies of inline member functions, debugging information, and the
12909 internal tables used to implement virtual functions are all generated in
12910 implementation files.
12912 @cindex implied @code{#pragma implementation}
12913 @cindex @code{#pragma implementation}, implied
12914 @cindex naming convention, implementation headers
12915 If you use @samp{#pragma implementation} with no argument, it applies to
12916 an include file with the same basename@footnote{A file's @dfn{basename}
12917 was the name stripped of all leading path information and of trailing
12918 suffixes, such as @samp{.h} or @samp{.C} or @samp{.cc}.} as your source
12919 file.  For example, in @file{allclass.cc}, giving just
12920 @samp{#pragma implementation}
12921 by itself is equivalent to @samp{#pragma implementation "allclass.h"}.
12923 In versions of GNU C++ prior to 2.6.0 @file{allclass.h} was treated as
12924 an implementation file whenever you would include it from
12925 @file{allclass.cc} even if you never specified @samp{#pragma
12926 implementation}.  This was deemed to be more trouble than it was worth,
12927 however, and disabled.
12929 Use the string argument if you want a single implementation file to
12930 include code from multiple header files.  (You must also use
12931 @samp{#include} to include the header file; @samp{#pragma
12932 implementation} only specifies how to use the file---it doesn't actually
12933 include it.)
12935 There is no way to split up the contents of a single header file into
12936 multiple implementation files.
12937 @end table
12939 @cindex inlining and C++ pragmas
12940 @cindex C++ pragmas, effect on inlining
12941 @cindex pragmas in C++, effect on inlining
12942 @samp{#pragma implementation} and @samp{#pragma interface} also have an
12943 effect on function inlining.
12945 If you define a class in a header file marked with @samp{#pragma
12946 interface}, the effect on an inline function defined in that class is
12947 similar to an explicit @code{extern} declaration---the compiler emits
12948 no code at all to define an independent version of the function.  Its
12949 definition is used only for inlining with its callers.
12951 @opindex fno-implement-inlines
12952 Conversely, when you include the same header file in a main source file
12953 that declares it as @samp{#pragma implementation}, the compiler emits
12954 code for the function itself; this defines a version of the function
12955 that can be found via pointers (or by callers compiled without
12956 inlining).  If all calls to the function can be inlined, you can avoid
12957 emitting the function by compiling with @option{-fno-implement-inlines}.
12958 If any calls were not inlined, you will get linker errors.
12960 @node Template Instantiation
12961 @section Where's the Template?
12962 @cindex template instantiation
12964 C++ templates are the first language feature to require more
12965 intelligence from the environment than one usually finds on a UNIX
12966 system.  Somehow the compiler and linker have to make sure that each
12967 template instance occurs exactly once in the executable if it is needed,
12968 and not at all otherwise.  There are two basic approaches to this
12969 problem, which are referred to as the Borland model and the Cfront model.
12971 @table @asis
12972 @item Borland model
12973 Borland C++ solved the template instantiation problem by adding the code
12974 equivalent of common blocks to their linker; the compiler emits template
12975 instances in each translation unit that uses them, and the linker
12976 collapses them together.  The advantage of this model is that the linker
12977 only has to consider the object files themselves; there is no external
12978 complexity to worry about.  This disadvantage is that compilation time
12979 is increased because the template code is being compiled repeatedly.
12980 Code written for this model tends to include definitions of all
12981 templates in the header file, since they must be seen to be
12982 instantiated.
12984 @item Cfront model
12985 The AT&T C++ translator, Cfront, solved the template instantiation
12986 problem by creating the notion of a template repository, an
12987 automatically maintained place where template instances are stored.  A
12988 more modern version of the repository works as follows: As individual
12989 object files are built, the compiler places any template definitions and
12990 instantiations encountered in the repository.  At link time, the link
12991 wrapper adds in the objects in the repository and compiles any needed
12992 instances that were not previously emitted.  The advantages of this
12993 model are more optimal compilation speed and the ability to use the
12994 system linker; to implement the Borland model a compiler vendor also
12995 needs to replace the linker.  The disadvantages are vastly increased
12996 complexity, and thus potential for error; for some code this can be
12997 just as transparent, but in practice it can been very difficult to build
12998 multiple programs in one directory and one program in multiple
12999 directories.  Code written for this model tends to separate definitions
13000 of non-inline member templates into a separate file, which should be
13001 compiled separately.
13002 @end table
13004 When used with GNU ld version 2.8 or later on an ELF system such as
13005 GNU/Linux or Solaris 2, or on Microsoft Windows, G++ supports the
13006 Borland model.  On other systems, G++ implements neither automatic
13007 model.
13009 A future version of G++ will support a hybrid model whereby the compiler
13010 will emit any instantiations for which the template definition is
13011 included in the compile, and store template definitions and
13012 instantiation context information into the object file for the rest.
13013 The link wrapper will extract that information as necessary and invoke
13014 the compiler to produce the remaining instantiations.  The linker will
13015 then combine duplicate instantiations.
13017 In the mean time, you have the following options for dealing with
13018 template instantiations:
13020 @enumerate
13021 @item
13022 @opindex frepo
13023 Compile your template-using code with @option{-frepo}.  The compiler will
13024 generate files with the extension @samp{.rpo} listing all of the
13025 template instantiations used in the corresponding object files which
13026 could be instantiated there; the link wrapper, @samp{collect2}, will
13027 then update the @samp{.rpo} files to tell the compiler where to place
13028 those instantiations and rebuild any affected object files.  The
13029 link-time overhead is negligible after the first pass, as the compiler
13030 will continue to place the instantiations in the same files.
13032 This is your best option for application code written for the Borland
13033 model, as it will just work.  Code written for the Cfront model will
13034 need to be modified so that the template definitions are available at
13035 one or more points of instantiation; usually this is as simple as adding
13036 @code{#include <tmethods.cc>} to the end of each template header.
13038 For library code, if you want the library to provide all of the template
13039 instantiations it needs, just try to link all of its object files
13040 together; the link will fail, but cause the instantiations to be
13041 generated as a side effect.  Be warned, however, that this may cause
13042 conflicts if multiple libraries try to provide the same instantiations.
13043 For greater control, use explicit instantiation as described in the next
13044 option.
13046 @item
13047 @opindex fno-implicit-templates
13048 Compile your code with @option{-fno-implicit-templates} to disable the
13049 implicit generation of template instances, and explicitly instantiate
13050 all the ones you use.  This approach requires more knowledge of exactly
13051 which instances you need than do the others, but it's less
13052 mysterious and allows greater control.  You can scatter the explicit
13053 instantiations throughout your program, perhaps putting them in the
13054 translation units where the instances are used or the translation units
13055 that define the templates themselves; you can put all of the explicit
13056 instantiations you need into one big file; or you can create small files
13057 like
13059 @smallexample
13060 #include "Foo.h"
13061 #include "Foo.cc"
13063 template class Foo<int>;
13064 template ostream& operator <<
13065                 (ostream&, const Foo<int>&);
13066 @end smallexample
13068 for each of the instances you need, and create a template instantiation
13069 library from those.
13071 If you are using Cfront-model code, you can probably get away with not
13072 using @option{-fno-implicit-templates} when compiling files that don't
13073 @samp{#include} the member template definitions.
13075 If you use one big file to do the instantiations, you may want to
13076 compile it without @option{-fno-implicit-templates} so you get all of the
13077 instances required by your explicit instantiations (but not by any
13078 other files) without having to specify them as well.
13080 G++ has extended the template instantiation syntax given in the ISO
13081 standard to allow forward declaration of explicit instantiations
13082 (with @code{extern}), instantiation of the compiler support data for a
13083 template class (i.e.@: the vtable) without instantiating any of its
13084 members (with @code{inline}), and instantiation of only the static data
13085 members of a template class, without the support data or member
13086 functions (with (@code{static}):
13088 @smallexample
13089 extern template int max (int, int);
13090 inline template class Foo<int>;
13091 static template class Foo<int>;
13092 @end smallexample
13094 @item
13095 Do nothing.  Pretend G++ does implement automatic instantiation
13096 management.  Code written for the Borland model will work fine, but
13097 each translation unit will contain instances of each of the templates it
13098 uses.  In a large program, this can lead to an unacceptable amount of code
13099 duplication.
13100 @end enumerate
13102 @node Bound member functions
13103 @section Extracting the function pointer from a bound pointer to member function
13104 @cindex pmf
13105 @cindex pointer to member function
13106 @cindex bound pointer to member function
13108 In C++, pointer to member functions (PMFs) are implemented using a wide
13109 pointer of sorts to handle all the possible call mechanisms; the PMF
13110 needs to store information about how to adjust the @samp{this} pointer,
13111 and if the function pointed to is virtual, where to find the vtable, and
13112 where in the vtable to look for the member function.  If you are using
13113 PMFs in an inner loop, you should really reconsider that decision.  If
13114 that is not an option, you can extract the pointer to the function that
13115 would be called for a given object/PMF pair and call it directly inside
13116 the inner loop, to save a bit of time.
13118 Note that you will still be paying the penalty for the call through a
13119 function pointer; on most modern architectures, such a call defeats the
13120 branch prediction features of the CPU@.  This is also true of normal
13121 virtual function calls.
13123 The syntax for this extension is
13125 @smallexample
13126 extern A a;
13127 extern int (A::*fp)();
13128 typedef int (*fptr)(A *);
13130 fptr p = (fptr)(a.*fp);
13131 @end smallexample
13133 For PMF constants (i.e.@: expressions of the form @samp{&Klasse::Member}),
13134 no object is needed to obtain the address of the function.  They can be
13135 converted to function pointers directly:
13137 @smallexample
13138 fptr p1 = (fptr)(&A::foo);
13139 @end smallexample
13141 @opindex Wno-pmf-conversions
13142 You must specify @option{-Wno-pmf-conversions} to use this extension.
13144 @node C++ Attributes
13145 @section C++-Specific Variable, Function, and Type Attributes
13147 Some attributes only make sense for C++ programs.
13149 @table @code
13150 @item init_priority (@var{priority})
13151 @cindex init_priority attribute
13154 In Standard C++, objects defined at namespace scope are guaranteed to be
13155 initialized in an order in strict accordance with that of their definitions
13156 @emph{in a given translation unit}.  No guarantee is made for initializations
13157 across translation units.  However, GNU C++ allows users to control the
13158 order of initialization of objects defined at namespace scope with the
13159 @code{init_priority} attribute by specifying a relative @var{priority},
13160 a constant integral expression currently bounded between 101 and 65535
13161 inclusive.  Lower numbers indicate a higher priority.
13163 In the following example, @code{A} would normally be created before
13164 @code{B}, but the @code{init_priority} attribute has reversed that order:
13166 @smallexample
13167 Some_Class  A  __attribute__ ((init_priority (2000)));
13168 Some_Class  B  __attribute__ ((init_priority (543)));
13169 @end smallexample
13171 @noindent
13172 Note that the particular values of @var{priority} do not matter; only their
13173 relative ordering.
13175 @item java_interface
13176 @cindex java_interface attribute
13178 This type attribute informs C++ that the class is a Java interface.  It may
13179 only be applied to classes declared within an @code{extern "Java"} block.
13180 Calls to methods declared in this interface will be dispatched using GCJ's
13181 interface table mechanism, instead of regular virtual table dispatch.
13183 @end table
13185 See also @ref{Namespace Association}.
13187 @node Namespace Association
13188 @section Namespace Association
13190 @strong{Caution:} The semantics of this extension are not fully
13191 defined.  Users should refrain from using this extension as its
13192 semantics may change subtly over time.  It is possible that this
13193 extension will be removed in future versions of G++.
13195 A using-directive with @code{__attribute ((strong))} is stronger
13196 than a normal using-directive in two ways:
13198 @itemize @bullet
13199 @item
13200 Templates from the used namespace can be specialized and explicitly
13201 instantiated as though they were members of the using namespace.
13203 @item
13204 The using namespace is considered an associated namespace of all
13205 templates in the used namespace for purposes of argument-dependent
13206 name lookup.
13207 @end itemize
13209 The used namespace must be nested within the using namespace so that
13210 normal unqualified lookup works properly.
13212 This is useful for composing a namespace transparently from
13213 implementation namespaces.  For example:
13215 @smallexample
13216 namespace std @{
13217   namespace debug @{
13218     template <class T> struct A @{ @};
13219   @}
13220   using namespace debug __attribute ((__strong__));
13221   template <> struct A<int> @{ @};   // @r{ok to specialize}
13223   template <class T> void f (A<T>);
13226 int main()
13228   f (std::A<float>());             // @r{lookup finds} std::f
13229   f (std::A<int>());
13231 @end smallexample
13233 @node Type Traits
13234 @section Type Traits
13236 The C++ front-end implements syntactic extensions that allow to
13237 determine at compile time various characteristics of a type (or of a
13238 pair of types).
13240 @table @code
13241 @item __has_nothrow_assign (type)
13242 If @code{type} is const qualified or is a reference type then the trait is
13243 false.  Otherwise if @code{__has_trivial_assign (type)} is true then the trait
13244 is true, else if @code{type} is a cv class or union type with copy assignment
13245 operators that are known not to throw an exception then the trait is true,
13246 else it is false.  Requires: @code{type} shall be a complete type, an array
13247 type of unknown bound, or is a @code{void} type.
13249 @item __has_nothrow_copy (type)
13250 If @code{__has_trivial_copy (type)} is true then the trait is true, else if
13251 @code{type} is a cv class or union type with copy constructors that
13252 are known not to throw an exception then the trait is true, else it is false.
13253 Requires: @code{type} shall be a complete type, an array type of
13254 unknown bound, or is a @code{void} type.
13256 @item __has_nothrow_constructor (type)
13257 If @code{__has_trivial_constructor (type)} is true then the trait is
13258 true, else if @code{type} is a cv class or union type (or array
13259 thereof) with a default constructor that is known not to throw an
13260 exception then the trait is true, else it is false.  Requires:
13261 @code{type} shall be a complete type, an array type of unknown bound,
13262 or is a @code{void} type.
13264 @item __has_trivial_assign (type)
13265 If @code{type} is const qualified or is a reference type then the trait is
13266 false.  Otherwise if @code{__is_pod (type)} is true then the trait is
13267 true, else if @code{type} is a cv class or union type with a trivial
13268 copy assignment ([class.copy]) then the trait is true, else it is
13269 false.  Requires: @code{type} shall be a complete type, an array type
13270 of unknown bound, or is a @code{void} type.
13272 @item __has_trivial_copy (type)
13273 If @code{__is_pod (type)} is true or @code{type} is a reference type 
13274 then the trait is true, else if @code{type} is a cv class or union type
13275 with a trivial copy constructor ([class.copy]) then the trait
13276 is true, else it is false.  Requires: @code{type} shall be a complete
13277 type, an array type of unknown bound, or is a @code{void} type.
13279 @item __has_trivial_constructor (type)
13280 If @code{__is_pod (type)} is true then the trait is true, else if
13281 @code{type} is a cv class or union type (or array thereof) with a
13282 trivial default constructor ([class.ctor]) then the trait is true,
13283 else it is false.  Requires: @code{type} shall be a complete type, an
13284 array type of unknown bound, or is a @code{void} type.
13286 @item __has_trivial_destructor (type)
13287 If @code{__is_pod (type)} is true or @code{type} is a reference type then
13288 the trait is true, else if @code{type} is a cv class or union type (or
13289 array thereof) with a trivial destructor ([class.dtor]) then the trait
13290 is true, else it is false.  Requires: @code{type} shall be a complete
13291 type, an array type of unknown bound, or is a @code{void} type.
13293 @item __has_virtual_destructor (type)
13294 If @code{type} is a class type with a virtual destructor
13295 ([class.dtor]) then the trait is true, else it is false.  Requires:
13296 @code{type}  shall be a complete type, an array type of unknown bound,
13297 or is a @code{void} type.
13299 @item __is_abstract (type)
13300 If @code{type} is an abstract class ([class.abstract]) then the trait
13301 is true, else it is false.  Requires: @code{type} shall be a complete
13302 type, an array type of unknown bound, or is a @code{void} type.
13304 @item __is_base_of (base_type, derived_type)
13305 If @code{base_type} is a base class of @code{derived_type}
13306 ([class.derived]) then the trait is true, otherwise it is false.
13307 Top-level cv qualifications of @code{base_type} and
13308 @code{derived_type} are ignored.  For the purposes of this trait, a
13309 class type is considered is own base.  Requires: if @code{__is_class
13310 (base_type)} and @code{__is_class (derived_type)} are true and
13311 @code{base_type} and @code{derived_type} are not the same type
13312 (disregarding cv-qualifiers), @code{derived_type} shall be a complete
13313 type.  Diagnostic is produced if this requirement is not met.
13315 @item __is_class (type)
13316 If @code{type} is a cv class type, and not a union type
13317 ([basic.compound]) the trait is true, else it is false.
13319 @item __is_empty (type)
13320 If @code{__is_class (type)} is false then the trait is false.
13321 Otherwise @code{type} is considered empty if and only if: @code{type}
13322 has no non-static data members, or all non-static data members, if
13323 any, are bit-fields of length 0, and @code{type} has no virtual
13324 members, and @code{type} has no virtual base classes, and @code{type}
13325 has no base classes @code{base_type} for which 
13326 @code{__is_empty (base_type)} is false.  Requires: @code{type} shall
13327 be a complete type, an array type of unknown bound, or is a
13328 @code{void} type.
13330 @item __is_enum (type)
13331 If @code{type} is a cv enumeration type ([basic.compound]) the trait is
13332 true, else it is false.
13334 @item __is_pod (type)
13335 If @code{type} is a cv POD type ([basic.types]) then the trait is true,
13336 else it is false.  Requires: @code{type} shall be a complete type, 
13337 an array type of unknown bound, or is a @code{void} type.
13339 @item __is_polymorphic (type)
13340 If @code{type} is a polymorphic class ([class.virtual]) then the trait
13341 is true, else it is false.  Requires: @code{type} shall be a complete
13342 type, an array type of unknown bound, or is a @code{void} type.
13344 @item __is_union (type)
13345 If @code{type} is a cv union type ([basic.compound]) the trait is
13346 true, else it is false.
13348 @end table
13350 @node Java Exceptions
13351 @section Java Exceptions
13353 The Java language uses a slightly different exception handling model
13354 from C++.  Normally, GNU C++ will automatically detect when you are
13355 writing C++ code that uses Java exceptions, and handle them
13356 appropriately.  However, if C++ code only needs to execute destructors
13357 when Java exceptions are thrown through it, GCC will guess incorrectly.
13358 Sample problematic code is:
13360 @smallexample
13361   struct S @{ ~S(); @};
13362   extern void bar();    // @r{is written in Java, and may throw exceptions}
13363   void foo()
13364   @{
13365     S s;
13366     bar();
13367   @}
13368 @end smallexample
13370 @noindent
13371 The usual effect of an incorrect guess is a link failure, complaining of
13372 a missing routine called @samp{__gxx_personality_v0}.
13374 You can inform the compiler that Java exceptions are to be used in a
13375 translation unit, irrespective of what it might think, by writing
13376 @samp{@w{#pragma GCC java_exceptions}} at the head of the file.  This
13377 @samp{#pragma} must appear before any functions that throw or catch
13378 exceptions, or run destructors when exceptions are thrown through them.
13380 You cannot mix Java and C++ exceptions in the same translation unit.  It
13381 is believed to be safe to throw a C++ exception from one file through
13382 another file compiled for the Java exception model, or vice versa, but
13383 there may be bugs in this area.
13385 @node Deprecated Features
13386 @section Deprecated Features
13388 In the past, the GNU C++ compiler was extended to experiment with new
13389 features, at a time when the C++ language was still evolving.  Now that
13390 the C++ standard is complete, some of those features are superseded by
13391 superior alternatives.  Using the old features might cause a warning in
13392 some cases that the feature will be dropped in the future.  In other
13393 cases, the feature might be gone already.
13395 While the list below is not exhaustive, it documents some of the options
13396 that are now deprecated:
13398 @table @code
13399 @item -fexternal-templates
13400 @itemx -falt-external-templates
13401 These are two of the many ways for G++ to implement template
13402 instantiation.  @xref{Template Instantiation}.  The C++ standard clearly
13403 defines how template definitions have to be organized across
13404 implementation units.  G++ has an implicit instantiation mechanism that
13405 should work just fine for standard-conforming code.
13407 @item -fstrict-prototype
13408 @itemx -fno-strict-prototype
13409 Previously it was possible to use an empty prototype parameter list to
13410 indicate an unspecified number of parameters (like C), rather than no
13411 parameters, as C++ demands.  This feature has been removed, except where
13412 it is required for backwards compatibility.   @xref{Backwards Compatibility}.
13413 @end table
13415 G++ allows a virtual function returning @samp{void *} to be overridden
13416 by one returning a different pointer type.  This extension to the
13417 covariant return type rules is now deprecated and will be removed from a
13418 future version.
13420 The G++ minimum and maximum operators (@samp{<?} and @samp{>?}) and
13421 their compound forms (@samp{<?=}) and @samp{>?=}) have been deprecated
13422 and are now removed from G++.  Code using these operators should be
13423 modified to use @code{std::min} and @code{std::max} instead.
13425 The named return value extension has been deprecated, and is now
13426 removed from G++.
13428 The use of initializer lists with new expressions has been deprecated,
13429 and is now removed from G++.
13431 Floating and complex non-type template parameters have been deprecated,
13432 and are now removed from G++.
13434 The implicit typename extension has been deprecated and is now
13435 removed from G++.
13437 The use of default arguments in function pointers, function typedefs
13438 and other places where they are not permitted by the standard is
13439 deprecated and will be removed from a future version of G++.
13441 G++ allows floating-point literals to appear in integral constant expressions,
13442 e.g. @samp{ enum E @{ e = int(2.2 * 3.7) @} }
13443 This extension is deprecated and will be removed from a future version.
13445 G++ allows static data members of const floating-point type to be declared
13446 with an initializer in a class definition. The standard only allows
13447 initializers for static members of const integral types and const
13448 enumeration types so this extension has been deprecated and will be removed
13449 from a future version.
13451 @node Backwards Compatibility
13452 @section Backwards Compatibility
13453 @cindex Backwards Compatibility
13454 @cindex ARM [Annotated C++ Reference Manual]
13456 Now that there is a definitive ISO standard C++, G++ has a specification
13457 to adhere to.  The C++ language evolved over time, and features that
13458 used to be acceptable in previous drafts of the standard, such as the ARM
13459 [Annotated C++ Reference Manual], are no longer accepted.  In order to allow
13460 compilation of C++ written to such drafts, G++ contains some backwards
13461 compatibilities.  @emph{All such backwards compatibility features are
13462 liable to disappear in future versions of G++.} They should be considered
13463 deprecated.   @xref{Deprecated Features}.
13465 @table @code
13466 @item For scope
13467 If a variable is declared at for scope, it used to remain in scope until
13468 the end of the scope which contained the for statement (rather than just
13469 within the for scope).  G++ retains this, but issues a warning, if such a
13470 variable is accessed outside the for scope.
13472 @item Implicit C language
13473 Old C system header files did not contain an @code{extern "C" @{@dots{}@}}
13474 scope to set the language.  On such systems, all header files are
13475 implicitly scoped inside a C language scope.  Also, an empty prototype
13476 @code{()} will be treated as an unspecified number of arguments, rather
13477 than no arguments, as C++ demands.
13478 @end table