OSDN Git Service

* optc-save-gen.awk: New. Based on optc-gen.awk. Don't generate
[pf3gnuchains/gcc-fork.git] / gcc / doc / extend.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1996, 1998, 1999, 2000, 2001,
2 @c 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
3 @c Free Software Foundation, Inc.
4
5 @c This is part of the GCC manual.
6 @c For copying conditions, see the file gcc.texi.
7
8 @node C Extensions
9 @chapter Extensions to the C Language Family
10 @cindex extensions, C language
11 @cindex C language extensions
12
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@.
19
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++.
23
24 Some features that are in ISO C99 but not C90 or C++ are also, as
25 extensions, accepted by GCC in C90 mode and in C++.
26
27 @menu
28 * Statement Exprs::     Putting statements and declarations inside expressions.
29 * Local Labels::        Labels local to a block.
30 * Labels as Values::    Getting pointers to labels, and computed gotos.
31 * Nested Functions::    As in Algol and Pascal, lexical scoping of functions.
32 * Constructing Calls::  Dispatching a call to another function.
33 * Typeof::              @code{typeof}: referring to the type of an expression.
34 * Conditionals::        Omitting the middle operand of a @samp{?:} expression.
35 * Long Long::           Double-word integers---@code{long long int}.
36 * __int128::                    128-bit integers---@code{__int128}.
37 * Complex::             Data types for complex numbers.
38 * Floating Types::      Additional Floating Types.
39 * Half-Precision::      Half-Precision Floating Point.
40 * Decimal Float::       Decimal Floating Types.
41 * Hex Floats::          Hexadecimal floating-point constants.
42 * Fixed-Point::         Fixed-Point Types.
43 * Named Address Spaces::Named address spaces.
44 * Zero Length::         Zero-length arrays.
45 * Variable Length::     Arrays whose length is computed at run time.
46 * Empty Structures::    Structures with no members.
47 * Variadic Macros::     Macros with a variable number of arguments.
48 * Escaped Newlines::    Slightly looser rules for escaped newlines.
49 * Subscripting::        Any array can be subscripted, even if not an lvalue.
50 * Pointer Arith::       Arithmetic on @code{void}-pointers and function pointers.
51 * Initializers::        Non-constant initializers.
52 * Compound Literals::   Compound literals give structures, unions
53                         or arrays as values.
54 * Designated Inits::    Labeling elements of initializers.
55 * Cast to Union::       Casting to union type from any member of the union.
56 * Case Ranges::         `case 1 ... 9' and such.
57 * Mixed Declarations::  Mixing declarations and code.
58 * Function Attributes:: Declaring that functions have no side effects,
59                         or that they can never return.
60 * Attribute Syntax::    Formal syntax for attributes.
61 * Function Prototypes:: Prototype declarations and old-style definitions.
62 * C++ Comments::        C++ comments are recognized.
63 * Dollar Signs::        Dollar sign is allowed in identifiers.
64 * Character Escapes::   @samp{\e} stands for the character @key{ESC}.
65 * Variable Attributes:: Specifying attributes of variables.
66 * Type Attributes::     Specifying attributes of types.
67 * Alignment::           Inquiring about the alignment of a type or variable.
68 * Inline::              Defining inline functions (as fast as macros).
69 * Volatiles::           What constitutes an access to a volatile object.
70 * Extended Asm::        Assembler instructions with C expressions as operands.
71                         (With them you can define ``built-in'' functions.)
72 * Constraints::         Constraints for asm operands
73 * Asm Labels::          Specifying the assembler name to use for a C symbol.
74 * Explicit Reg Vars::   Defining variables residing in specified registers.
75 * Alternate Keywords::  @code{__const__}, @code{__asm__}, etc., for header files.
76 * Incomplete Enums::    @code{enum foo;}, with details to follow.
77 * Function Names::      Printable strings which are the name of the current
78                         function.
79 * Return Address::      Getting the return or frame address of a function.
80 * Vector Extensions::   Using vector instructions through built-in functions.
81 * Offsetof::            Special syntax for implementing @code{offsetof}.
82 * Atomic Builtins::     Built-in functions for atomic memory access.
83 * Object Size Checking:: Built-in functions for limited buffer overflow
84                         checking.
85 * Other Builtins::      Other built-in functions.
86 * Target Builtins::     Built-in functions specific to particular targets.
87 * Target Format Checks:: Format checks specific to particular targets.
88 * Pragmas::             Pragmas accepted by GCC.
89 * Unnamed Fields::      Unnamed struct/union fields within structs/unions.
90 * Thread-Local::        Per-thread variables.
91 * Binary constants::    Binary constants using the @samp{0b} prefix.
92 @end menu
93
94 @node Statement Exprs
95 @section Statements and Declarations in Expressions
96 @cindex statements inside expressions
97 @cindex declarations inside expressions
98 @cindex expressions containing statements
99 @cindex macros, statements in expressions
100
101 @c the above section title wrapped and causes an underfull hbox.. i
102 @c changed it from "within" to "in". --mew 4feb93
103 A compound statement enclosed in parentheses may appear as an expression
104 in GNU C@.  This allows you to use loops, switches, and local variables
105 within an expression.
106
107 Recall that a compound statement is a sequence of statements surrounded
108 by braces; in this construct, parentheses go around the braces.  For
109 example:
110
111 @smallexample
112 (@{ int y = foo (); int z;
113    if (y > 0) z = y;
114    else z = - y;
115    z; @})
116 @end smallexample
117
118 @noindent
119 is a valid (though slightly more complex than necessary) expression
120 for the absolute value of @code{foo ()}.
121
122 The last thing in the compound statement should be an expression
123 followed by a semicolon; the value of this subexpression serves as the
124 value of the entire construct.  (If you use some other kind of statement
125 last within the braces, the construct has type @code{void}, and thus
126 effectively no value.)
127
128 This feature is especially useful in making macro definitions ``safe'' (so
129 that they evaluate each operand exactly once).  For example, the
130 ``maximum'' function is commonly defined as a macro in standard C as
131 follows:
132
133 @smallexample
134 #define max(a,b) ((a) > (b) ? (a) : (b))
135 @end smallexample
136
137 @noindent
138 @cindex side effects, macro argument
139 But this definition computes either @var{a} or @var{b} twice, with bad
140 results if the operand has side effects.  In GNU C, if you know the
141 type of the operands (here taken as @code{int}), you can define
142 the macro safely as follows:
143
144 @smallexample
145 #define maxint(a,b) \
146   (@{int _a = (a), _b = (b); _a > _b ? _a : _b; @})
147 @end smallexample
148
149 Embedded statements are not allowed in constant expressions, such as
150 the value of an enumeration constant, the width of a bit-field, or
151 the initial value of a static variable.
152
153 If you don't know the type of the operand, you can still do this, but you
154 must use @code{typeof} (@pxref{Typeof}).
155
156 In G++, the result value of a statement expression undergoes array and
157 function pointer decay, and is returned by value to the enclosing
158 expression.  For instance, if @code{A} is a class, then
159
160 @smallexample
161         A a;
162
163         (@{a;@}).Foo ()
164 @end smallexample
165
166 @noindent
167 will construct a temporary @code{A} object to hold the result of the
168 statement expression, and that will be used to invoke @code{Foo}.
169 Therefore the @code{this} pointer observed by @code{Foo} will not be the
170 address of @code{a}.
171
172 Any temporaries created within a statement within a statement expression
173 will be destroyed at the statement's end.  This makes statement
174 expressions inside macros slightly different from function calls.  In
175 the latter case temporaries introduced during argument evaluation will
176 be destroyed at the end of the statement that includes the function
177 call.  In the statement expression case they will be destroyed during
178 the statement expression.  For instance,
179
180 @smallexample
181 #define macro(a)  (@{__typeof__(a) b = (a); b + 3; @})
182 template<typename T> T function(T a) @{ T b = a; return b + 3; @}
183
184 void foo ()
185 @{
186   macro (X ());
187   function (X ());
188 @}
189 @end smallexample
190
191 @noindent
192 will have different places where temporaries are destroyed.  For the
193 @code{macro} case, the temporary @code{X} will be destroyed just after
194 the initialization of @code{b}.  In the @code{function} case that
195 temporary will be destroyed when the function returns.
196
197 These considerations mean that it is probably a bad idea to use
198 statement-expressions of this form in header files that are designed to
199 work with C++.  (Note that some versions of the GNU C Library contained
200 header files using statement-expression that lead to precisely this
201 bug.)
202
203 Jumping into a statement expression with @code{goto} or using a
204 @code{switch} statement outside the statement expression with a
205 @code{case} or @code{default} label inside the statement expression is
206 not permitted.  Jumping into a statement expression with a computed
207 @code{goto} (@pxref{Labels as Values}) yields undefined behavior.
208 Jumping out of a statement expression is permitted, but if the
209 statement expression is part of a larger expression then it is
210 unspecified which other subexpressions of that expression have been
211 evaluated except where the language definition requires certain
212 subexpressions to be evaluated before or after the statement
213 expression.  In any case, as with a function call the evaluation of a
214 statement expression is not interleaved with the evaluation of other
215 parts of the containing expression.  For example,
216
217 @smallexample
218   foo (), ((@{ bar1 (); goto a; 0; @}) + bar2 ()), baz();
219 @end smallexample
220
221 @noindent
222 will call @code{foo} and @code{bar1} and will not call @code{baz} but
223 may or may not call @code{bar2}.  If @code{bar2} is called, it will be
224 called after @code{foo} and before @code{bar1}
225
226 @node Local Labels
227 @section Locally Declared Labels
228 @cindex local labels
229 @cindex macros, local labels
230
231 GCC allows you to declare @dfn{local labels} in any nested block
232 scope.  A local label is just like an ordinary label, but you can
233 only reference it (with a @code{goto} statement, or by taking its
234 address) within the block in which it was declared.
235
236 A local label declaration looks like this:
237
238 @smallexample
239 __label__ @var{label};
240 @end smallexample
241
242 @noindent
243 or
244
245 @smallexample
246 __label__ @var{label1}, @var{label2}, /* @r{@dots{}} */;
247 @end smallexample
248
249 Local label declarations must come at the beginning of the block,
250 before any ordinary declarations or statements.
251
252 The label declaration defines the label @emph{name}, but does not define
253 the label itself.  You must do this in the usual way, with
254 @code{@var{label}:}, within the statements of the statement expression.
255
256 The local label feature is useful for complex macros.  If a macro
257 contains nested loops, a @code{goto} can be useful for breaking out of
258 them.  However, an ordinary label whose scope is the whole function
259 cannot be used: if the macro can be expanded several times in one
260 function, the label will be multiply defined in that function.  A
261 local label avoids this problem.  For example:
262
263 @smallexample
264 #define SEARCH(value, array, target)              \
265 do @{                                              \
266   __label__ found;                                \
267   typeof (target) _SEARCH_target = (target);      \
268   typeof (*(array)) *_SEARCH_array = (array);     \
269   int i, j;                                       \
270   int value;                                      \
271   for (i = 0; i < max; i++)                       \
272     for (j = 0; j < max; j++)                     \
273       if (_SEARCH_array[i][j] == _SEARCH_target)  \
274         @{ (value) = i; goto found; @}              \
275   (value) = -1;                                   \
276  found:;                                          \
277 @} while (0)
278 @end smallexample
279
280 This could also be written using a statement-expression:
281
282 @smallexample
283 #define SEARCH(array, target)                     \
284 (@{                                                \
285   __label__ found;                                \
286   typeof (target) _SEARCH_target = (target);      \
287   typeof (*(array)) *_SEARCH_array = (array);     \
288   int i, j;                                       \
289   int value;                                      \
290   for (i = 0; i < max; i++)                       \
291     for (j = 0; j < max; j++)                     \
292       if (_SEARCH_array[i][j] == _SEARCH_target)  \
293         @{ value = i; goto found; @}                \
294   value = -1;                                     \
295  found:                                           \
296   value;                                          \
297 @})
298 @end smallexample
299
300 Local label declarations also make the labels they declare visible to
301 nested functions, if there are any.  @xref{Nested Functions}, for details.
302
303 @node Labels as Values
304 @section Labels as Values
305 @cindex labels as values
306 @cindex computed gotos
307 @cindex goto with computed label
308 @cindex address of a label
309
310 You can get the address of a label defined in the current function
311 (or a containing function) with the unary operator @samp{&&}.  The
312 value has type @code{void *}.  This value is a constant and can be used
313 wherever a constant of that type is valid.  For example:
314
315 @smallexample
316 void *ptr;
317 /* @r{@dots{}} */
318 ptr = &&foo;
319 @end smallexample
320
321 To use these values, you need to be able to jump to one.  This is done
322 with the computed goto statement@footnote{The analogous feature in
323 Fortran is called an assigned goto, but that name seems inappropriate in
324 C, where one can do more than simply store label addresses in label
325 variables.}, @code{goto *@var{exp};}.  For example,
326
327 @smallexample
328 goto *ptr;
329 @end smallexample
330
331 @noindent
332 Any expression of type @code{void *} is allowed.
333
334 One way of using these constants is in initializing a static array that
335 will serve as a jump table:
336
337 @smallexample
338 static void *array[] = @{ &&foo, &&bar, &&hack @};
339 @end smallexample
340
341 Then you can select a label with indexing, like this:
342
343 @smallexample
344 goto *array[i];
345 @end smallexample
346
347 @noindent
348 Note that this does not check whether the subscript is in bounds---array
349 indexing in C never does that.
350
351 Such an array of label values serves a purpose much like that of the
352 @code{switch} statement.  The @code{switch} statement is cleaner, so
353 use that rather than an array unless the problem does not fit a
354 @code{switch} statement very well.
355
356 Another use of label values is in an interpreter for threaded code.
357 The labels within the interpreter function can be stored in the
358 threaded code for super-fast dispatching.
359
360 You may not use this mechanism to jump to code in a different function.
361 If you do that, totally unpredictable things will happen.  The best way to
362 avoid this is to store the label address only in automatic variables and
363 never pass it as an argument.
364
365 An alternate way to write the above example is
366
367 @smallexample
368 static const int array[] = @{ &&foo - &&foo, &&bar - &&foo,
369                              &&hack - &&foo @};
370 goto *(&&foo + array[i]);
371 @end smallexample
372
373 @noindent
374 This is more friendly to code living in shared libraries, as it reduces
375 the number of dynamic relocations that are needed, and by consequence,
376 allows the data to be read-only.
377
378 The @code{&&foo} expressions for the same label might have different
379 values if the containing function is inlined or cloned.  If a program
380 relies on them being always the same,
381 @code{__attribute__((__noinline__,__noclone__))} should be used to
382 prevent inlining and cloning.  If @code{&&foo} is used in a static
383 variable initializer, inlining and cloning is forbidden.
384
385 @node Nested Functions
386 @section Nested Functions
387 @cindex nested functions
388 @cindex downward funargs
389 @cindex thunks
390
391 A @dfn{nested function} is a function defined inside another function.
392 (Nested functions are not supported for GNU C++.)  The nested function's
393 name is local to the block where it is defined.  For example, here we
394 define a nested function named @code{square}, and call it twice:
395
396 @smallexample
397 @group
398 foo (double a, double b)
399 @{
400   double square (double z) @{ return z * z; @}
401
402   return square (a) + square (b);
403 @}
404 @end group
405 @end smallexample
406
407 The nested function can access all the variables of the containing
408 function that are visible at the point of its definition.  This is
409 called @dfn{lexical scoping}.  For example, here we show a nested
410 function which uses an inherited variable named @code{offset}:
411
412 @smallexample
413 @group
414 bar (int *array, int offset, int size)
415 @{
416   int access (int *array, int index)
417     @{ return array[index + offset]; @}
418   int i;
419   /* @r{@dots{}} */
420   for (i = 0; i < size; i++)
421     /* @r{@dots{}} */ access (array, i) /* @r{@dots{}} */
422 @}
423 @end group
424 @end smallexample
425
426 Nested function definitions are permitted within functions in the places
427 where variable definitions are allowed; that is, in any block, mixed
428 with the other declarations and statements in the block.
429
430 It is possible to call the nested function from outside the scope of its
431 name by storing its address or passing the address to another function:
432
433 @smallexample
434 hack (int *array, int size)
435 @{
436   void store (int index, int value)
437     @{ array[index] = value; @}
438
439   intermediate (store, size);
440 @}
441 @end smallexample
442
443 Here, the function @code{intermediate} receives the address of
444 @code{store} as an argument.  If @code{intermediate} calls @code{store},
445 the arguments given to @code{store} are used to store into @code{array}.
446 But this technique works only so long as the containing function
447 (@code{hack}, in this example) does not exit.
448
449 If you try to call the nested function through its address after the
450 containing function has exited, all hell will break loose.  If you try
451 to call it after a containing scope level has exited, and if it refers
452 to some of the variables that are no longer in scope, you may be lucky,
453 but it's not wise to take the risk.  If, however, the nested function
454 does not refer to anything that has gone out of scope, you should be
455 safe.
456
457 GCC implements taking the address of a nested function using a technique
458 called @dfn{trampolines}.  This technique was described in
459 @cite{Lexical Closures for C++} (Thomas M. Breuel, USENIX
460 C++ Conference Proceedings, October 17-21, 1988).
461
462 A nested function can jump to a label inherited from a containing
463 function, provided the label was explicitly declared in the containing
464 function (@pxref{Local Labels}).  Such a jump returns instantly to the
465 containing function, exiting the nested function which did the
466 @code{goto} and any intermediate functions as well.  Here is an example:
467
468 @smallexample
469 @group
470 bar (int *array, int offset, int size)
471 @{
472   __label__ failure;
473   int access (int *array, int index)
474     @{
475       if (index > size)
476         goto failure;
477       return array[index + offset];
478     @}
479   int i;
480   /* @r{@dots{}} */
481   for (i = 0; i < size; i++)
482     /* @r{@dots{}} */ access (array, i) /* @r{@dots{}} */
483   /* @r{@dots{}} */
484   return 0;
485
486  /* @r{Control comes here from @code{access}
487     if it detects an error.}  */
488  failure:
489   return -1;
490 @}
491 @end group
492 @end smallexample
493
494 A nested function always has no linkage.  Declaring one with
495 @code{extern} or @code{static} is erroneous.  If you need to declare the nested function
496 before its definition, use @code{auto} (which is otherwise meaningless
497 for function declarations).
498
499 @smallexample
500 bar (int *array, int offset, int size)
501 @{
502   __label__ failure;
503   auto int access (int *, int);
504   /* @r{@dots{}} */
505   int access (int *array, int index)
506     @{
507       if (index > size)
508         goto failure;
509       return array[index + offset];
510     @}
511   /* @r{@dots{}} */
512 @}
513 @end smallexample
514
515 @node Constructing Calls
516 @section Constructing Function Calls
517 @cindex constructing calls
518 @cindex forwarding calls
519
520 Using the built-in functions described below, you can record
521 the arguments a function received, and call another function
522 with the same arguments, without knowing the number or types
523 of the arguments.
524
525 You can also record the return value of that function call,
526 and later return that value, without knowing what data type
527 the function tried to return (as long as your caller expects
528 that data type).
529
530 However, these built-in functions may interact badly with some
531 sophisticated features or other extensions of the language.  It
532 is, therefore, not recommended to use them outside very simple
533 functions acting as mere forwarders for their arguments.
534
535 @deftypefn {Built-in Function} {void *} __builtin_apply_args ()
536 This built-in function returns a pointer to data
537 describing how to perform a call with the same arguments as were passed
538 to the current function.
539
540 The function saves the arg pointer register, structure value address,
541 and all registers that might be used to pass arguments to a function
542 into a block of memory allocated on the stack.  Then it returns the
543 address of that block.
544 @end deftypefn
545
546 @deftypefn {Built-in Function} {void *} __builtin_apply (void (*@var{function})(), void *@var{arguments}, size_t @var{size})
547 This built-in function invokes @var{function}
548 with a copy of the parameters described by @var{arguments}
549 and @var{size}.
550
551 The value of @var{arguments} should be the value returned by
552 @code{__builtin_apply_args}.  The argument @var{size} specifies the size
553 of the stack argument data, in bytes.
554
555 This function returns a pointer to data describing
556 how to return whatever value was returned by @var{function}.  The data
557 is saved in a block of memory allocated on the stack.
558
559 It is not always simple to compute the proper value for @var{size}.  The
560 value is used by @code{__builtin_apply} to compute the amount of data
561 that should be pushed on the stack and copied from the incoming argument
562 area.
563 @end deftypefn
564
565 @deftypefn {Built-in Function} {void} __builtin_return (void *@var{result})
566 This built-in function returns the value described by @var{result} from
567 the containing function.  You should specify, for @var{result}, a value
568 returned by @code{__builtin_apply}.
569 @end deftypefn
570
571 @deftypefn {Built-in Function} {} __builtin_va_arg_pack ()
572 This built-in function represents all anonymous arguments of an inline
573 function.  It can be used only in inline functions which will be always
574 inlined, never compiled as a separate function, such as those using
575 @code{__attribute__ ((__always_inline__))} or
576 @code{__attribute__ ((__gnu_inline__))} extern inline functions.
577 It must be only passed as last argument to some other function
578 with variable arguments.  This is useful for writing small wrapper
579 inlines for variable argument functions, when using preprocessor
580 macros is undesirable.  For example:
581 @smallexample
582 extern int myprintf (FILE *f, const char *format, ...);
583 extern inline __attribute__ ((__gnu_inline__)) int
584 myprintf (FILE *f, const char *format, ...)
585 @{
586   int r = fprintf (f, "myprintf: ");
587   if (r < 0)
588     return r;
589   int s = fprintf (f, format, __builtin_va_arg_pack ());
590   if (s < 0)
591     return s;
592   return r + s;
593 @}
594 @end smallexample
595 @end deftypefn
596
597 @deftypefn {Built-in Function} {size_t} __builtin_va_arg_pack_len ()
598 This built-in function returns the number of anonymous arguments of
599 an inline function.  It can be used only in inline functions which
600 will be always inlined, never compiled as a separate function, such
601 as those using @code{__attribute__ ((__always_inline__))} or
602 @code{__attribute__ ((__gnu_inline__))} extern inline functions.
603 For example following will do link or runtime checking of open
604 arguments for optimized code:
605 @smallexample
606 #ifdef __OPTIMIZE__
607 extern inline __attribute__((__gnu_inline__)) int
608 myopen (const char *path, int oflag, ...)
609 @{
610   if (__builtin_va_arg_pack_len () > 1)
611     warn_open_too_many_arguments ();
612
613   if (__builtin_constant_p (oflag))
614     @{
615       if ((oflag & O_CREAT) != 0 && __builtin_va_arg_pack_len () < 1)
616         @{
617           warn_open_missing_mode ();
618           return __open_2 (path, oflag);
619         @}
620       return open (path, oflag, __builtin_va_arg_pack ());
621     @}
622
623   if (__builtin_va_arg_pack_len () < 1)
624     return __open_2 (path, oflag);
625
626   return open (path, oflag, __builtin_va_arg_pack ());
627 @}
628 #endif
629 @end smallexample
630 @end deftypefn
631
632 @node Typeof
633 @section Referring to a Type with @code{typeof}
634 @findex typeof
635 @findex sizeof
636 @cindex macros, types of arguments
637
638 Another way to refer to the type of an expression is with @code{typeof}.
639 The syntax of using of this keyword looks like @code{sizeof}, but the
640 construct acts semantically like a type name defined with @code{typedef}.
641
642 There are two ways of writing the argument to @code{typeof}: with an
643 expression or with a type.  Here is an example with an expression:
644
645 @smallexample
646 typeof (x[0](1))
647 @end smallexample
648
649 @noindent
650 This assumes that @code{x} is an array of pointers to functions;
651 the type described is that of the values of the functions.
652
653 Here is an example with a typename as the argument:
654
655 @smallexample
656 typeof (int *)
657 @end smallexample
658
659 @noindent
660 Here the type described is that of pointers to @code{int}.
661
662 If you are writing a header file that must work when included in ISO C
663 programs, write @code{__typeof__} instead of @code{typeof}.
664 @xref{Alternate Keywords}.
665
666 A @code{typeof}-construct can be used anywhere a typedef name could be
667 used.  For example, you can use it in a declaration, in a cast, or inside
668 of @code{sizeof} or @code{typeof}.
669
670 The operand of @code{typeof} is evaluated for its side effects if and
671 only if it is an expression of variably modified type or the name of
672 such a type.
673
674 @code{typeof} is often useful in conjunction with the
675 statements-within-expressions feature.  Here is how the two together can
676 be used to define a safe ``maximum'' macro that operates on any
677 arithmetic type and evaluates each of its arguments exactly once:
678
679 @smallexample
680 #define max(a,b) \
681   (@{ typeof (a) _a = (a); \
682       typeof (b) _b = (b); \
683     _a > _b ? _a : _b; @})
684 @end smallexample
685
686 @cindex underscores in variables in macros
687 @cindex @samp{_} in variables in macros
688 @cindex local variables in macros
689 @cindex variables, local, in macros
690 @cindex macros, local variables in
691
692 The reason for using names that start with underscores for the local
693 variables is to avoid conflicts with variable names that occur within the
694 expressions that are substituted for @code{a} and @code{b}.  Eventually we
695 hope to design a new form of declaration syntax that allows you to declare
696 variables whose scopes start only after their initializers; this will be a
697 more reliable way to prevent such conflicts.
698
699 @noindent
700 Some more examples of the use of @code{typeof}:
701
702 @itemize @bullet
703 @item
704 This declares @code{y} with the type of what @code{x} points to.
705
706 @smallexample
707 typeof (*x) y;
708 @end smallexample
709
710 @item
711 This declares @code{y} as an array of such values.
712
713 @smallexample
714 typeof (*x) y[4];
715 @end smallexample
716
717 @item
718 This declares @code{y} as an array of pointers to characters:
719
720 @smallexample
721 typeof (typeof (char *)[4]) y;
722 @end smallexample
723
724 @noindent
725 It is equivalent to the following traditional C declaration:
726
727 @smallexample
728 char *y[4];
729 @end smallexample
730
731 To see the meaning of the declaration using @code{typeof}, and why it
732 might be a useful way to write, rewrite it with these macros:
733
734 @smallexample
735 #define pointer(T)  typeof(T *)
736 #define array(T, N) typeof(T [N])
737 @end smallexample
738
739 @noindent
740 Now the declaration can be rewritten this way:
741
742 @smallexample
743 array (pointer (char), 4) y;
744 @end smallexample
745
746 @noindent
747 Thus, @code{array (pointer (char), 4)} is the type of arrays of 4
748 pointers to @code{char}.
749 @end itemize
750
751 @emph{Compatibility Note:} In addition to @code{typeof}, GCC 2 supported
752 a more limited extension which permitted one to write
753
754 @smallexample
755 typedef @var{T} = @var{expr};
756 @end smallexample
757
758 @noindent
759 with the effect of declaring @var{T} to have the type of the expression
760 @var{expr}.  This extension does not work with GCC 3 (versions between
761 3.0 and 3.2 will crash; 3.2.1 and later give an error).  Code which
762 relies on it should be rewritten to use @code{typeof}:
763
764 @smallexample
765 typedef typeof(@var{expr}) @var{T};
766 @end smallexample
767
768 @noindent
769 This will work with all versions of GCC@.
770
771 @node Conditionals
772 @section Conditionals with Omitted Operands
773 @cindex conditional expressions, extensions
774 @cindex omitted middle-operands
775 @cindex middle-operands, omitted
776 @cindex extensions, @code{?:}
777 @cindex @code{?:} extensions
778
779 The middle operand in a conditional expression may be omitted.  Then
780 if the first operand is nonzero, its value is the value of the conditional
781 expression.
782
783 Therefore, the expression
784
785 @smallexample
786 x ? : y
787 @end smallexample
788
789 @noindent
790 has the value of @code{x} if that is nonzero; otherwise, the value of
791 @code{y}.
792
793 This example is perfectly equivalent to
794
795 @smallexample
796 x ? x : y
797 @end smallexample
798
799 @cindex side effect in @code{?:}
800 @cindex @code{?:} side effect
801 @noindent
802 In this simple case, the ability to omit the middle operand is not
803 especially useful.  When it becomes useful is when the first operand does,
804 or may (if it is a macro argument), contain a side effect.  Then repeating
805 the operand in the middle would perform the side effect twice.  Omitting
806 the middle operand uses the value already computed without the undesirable
807 effects of recomputing it.
808
809 @node __int128
810 @section 128-bits integers
811 @cindex @code{__int128} data types
812
813 As an extension the integer scalar type @code{__int128} is supported for
814 targets having an integer mode wide enough to hold 128-bit.
815 Simply write @code{__int128} for a signed 128-bit integer, or
816 @code{unsigned __int128} for an unsigned 128-bit integer.  There is no
817 support in GCC to express an integer constant of type @code{__int128}
818 for targets having @code{long long} integer with less then 128 bit width.
819
820 @node Long Long
821 @section Double-Word Integers
822 @cindex @code{long long} data types
823 @cindex double-word arithmetic
824 @cindex multiprecision arithmetic
825 @cindex @code{LL} integer suffix
826 @cindex @code{ULL} integer suffix
827
828 ISO C99 supports data types for integers that are at least 64 bits wide,
829 and as an extension GCC supports them in C90 mode and in C++.
830 Simply write @code{long long int} for a signed integer, or
831 @code{unsigned long long int} for an unsigned integer.  To make an
832 integer constant of type @code{long long int}, add the suffix @samp{LL}
833 to the integer.  To make an integer constant of type @code{unsigned long
834 long int}, add the suffix @samp{ULL} to the integer.
835
836 You can use these types in arithmetic like any other integer types.
837 Addition, subtraction, and bitwise boolean operations on these types
838 are open-coded on all types of machines.  Multiplication is open-coded
839 if the machine supports fullword-to-doubleword a widening multiply
840 instruction.  Division and shifts are open-coded only on machines that
841 provide special support.  The operations that are not open-coded use
842 special library routines that come with GCC@.
843
844 There may be pitfalls when you use @code{long long} types for function
845 arguments, unless you declare function prototypes.  If a function
846 expects type @code{int} for its argument, and you pass a value of type
847 @code{long long int}, confusion will result because the caller and the
848 subroutine will disagree about the number of bytes for the argument.
849 Likewise, if the function expects @code{long long int} and you pass
850 @code{int}.  The best way to avoid such problems is to use prototypes.
851
852 @node Complex
853 @section Complex Numbers
854 @cindex complex numbers
855 @cindex @code{_Complex} keyword
856 @cindex @code{__complex__} keyword
857
858 ISO C99 supports complex floating data types, and as an extension GCC
859 supports them in C90 mode and in C++, and supports complex integer data
860 types which are not part of ISO C99.  You can declare complex types
861 using the keyword @code{_Complex}.  As an extension, the older GNU
862 keyword @code{__complex__} is also supported.
863
864 For example, @samp{_Complex double x;} declares @code{x} as a
865 variable whose real part and imaginary part are both of type
866 @code{double}.  @samp{_Complex short int y;} declares @code{y} to
867 have real and imaginary parts of type @code{short int}; this is not
868 likely to be useful, but it shows that the set of complex types is
869 complete.
870
871 To write a constant with a complex data type, use the suffix @samp{i} or
872 @samp{j} (either one; they are equivalent).  For example, @code{2.5fi}
873 has type @code{_Complex float} and @code{3i} has type
874 @code{_Complex int}.  Such a constant always has a pure imaginary
875 value, but you can form any complex value you like by adding one to a
876 real constant.  This is a GNU extension; if you have an ISO C99
877 conforming C library (such as GNU libc), and want to construct complex
878 constants of floating type, you should include @code{<complex.h>} and
879 use the macros @code{I} or @code{_Complex_I} instead.
880
881 @cindex @code{__real__} keyword
882 @cindex @code{__imag__} keyword
883 To extract the real part of a complex-valued expression @var{exp}, write
884 @code{__real__ @var{exp}}.  Likewise, use @code{__imag__} to
885 extract the imaginary part.  This is a GNU extension; for values of
886 floating type, you should use the ISO C99 functions @code{crealf},
887 @code{creal}, @code{creall}, @code{cimagf}, @code{cimag} and
888 @code{cimagl}, declared in @code{<complex.h>} and also provided as
889 built-in functions by GCC@.
890
891 @cindex complex conjugation
892 The operator @samp{~} performs complex conjugation when used on a value
893 with a complex type.  This is a GNU extension; for values of
894 floating type, you should use the ISO C99 functions @code{conjf},
895 @code{conj} and @code{conjl}, declared in @code{<complex.h>} and also
896 provided as built-in functions by GCC@.
897
898 GCC can allocate complex automatic variables in a noncontiguous
899 fashion; it's even possible for the real part to be in a register while
900 the imaginary part is on the stack (or vice-versa).  Only the DWARF2
901 debug info format can represent this, so use of DWARF2 is recommended.
902 If you are using the stabs debug info format, GCC describes a noncontiguous
903 complex variable as if it were two separate variables of noncomplex type.
904 If the variable's actual name is @code{foo}, the two fictitious
905 variables are named @code{foo$real} and @code{foo$imag}.  You can
906 examine and set these two fictitious variables with your debugger.
907
908 @node Floating Types
909 @section Additional Floating Types
910 @cindex additional floating types
911 @cindex @code{__float80} data type
912 @cindex @code{__float128} data type
913 @cindex @code{w} floating point suffix
914 @cindex @code{q} floating point suffix
915 @cindex @code{W} floating point suffix
916 @cindex @code{Q} floating point suffix
917
918 As an extension, the GNU C compiler supports additional floating
919 types, @code{__float80} and @code{__float128} to support 80bit
920 (@code{XFmode}) and 128 bit (@code{TFmode}) floating types.
921 Support for additional types includes the arithmetic operators:
922 add, subtract, multiply, divide; unary arithmetic operators;
923 relational operators; equality operators; and conversions to and from
924 integer and other floating types.  Use a suffix @samp{w} or @samp{W}
925 in a literal constant of type @code{__float80} and @samp{q} or @samp{Q}
926 for @code{_float128}.  You can declare complex types using the
927 corresponding internal complex type, @code{XCmode} for @code{__float80}
928 type and @code{TCmode} for @code{__float128} type:
929
930 @smallexample
931 typedef _Complex float __attribute__((mode(TC))) _Complex128;
932 typedef _Complex float __attribute__((mode(XC))) _Complex80;
933 @end smallexample
934
935 Not all targets support additional floating point types.  @code{__float80}
936 and @code{__float128} types are supported on i386, x86_64 and ia64 targets.
937 The @code{__float128} type is supported on hppa HP-UX targets.
938
939 @node Half-Precision
940 @section Half-Precision Floating Point
941 @cindex half-precision floating point
942 @cindex @code{__fp16} data type
943
944 On ARM targets, GCC supports half-precision (16-bit) floating point via
945 the @code{__fp16} type.  You must enable this type explicitly
946 with the @option{-mfp16-format} command-line option in order to use it.
947
948 ARM supports two incompatible representations for half-precision
949 floating-point values.  You must choose one of the representations and
950 use it consistently in your program.
951
952 Specifying @option{-mfp16-format=ieee} selects the IEEE 754-2008 format.
953 This format can represent normalized values in the range of @math{2^{-14}} to 65504.
954 There are 11 bits of significand precision, approximately 3
955 decimal digits.
956
957 Specifying @option{-mfp16-format=alternative} selects the ARM
958 alternative format.  This representation is similar to the IEEE
959 format, but does not support infinities or NaNs.  Instead, the range
960 of exponents is extended, so that this format can represent normalized
961 values in the range of @math{2^{-14}} to 131008.
962
963 The @code{__fp16} type is a storage format only.  For purposes
964 of arithmetic and other operations, @code{__fp16} values in C or C++
965 expressions are automatically promoted to @code{float}.  In addition,
966 you cannot declare a function with a return value or parameters
967 of type @code{__fp16}.
968
969 Note that conversions from @code{double} to @code{__fp16}
970 involve an intermediate conversion to @code{float}.  Because
971 of rounding, this can sometimes produce a different result than a
972 direct conversion.
973
974 ARM provides hardware support for conversions between
975 @code{__fp16} and @code{float} values
976 as an extension to VFP and NEON (Advanced SIMD).  GCC generates
977 code using these hardware instructions if you compile with
978 options to select an FPU that provides them;
979 for example, @option{-mfpu=neon-fp16 -mfloat-abi=softfp},
980 in addition to the @option{-mfp16-format} option to select
981 a half-precision format.
982
983 Language-level support for the @code{__fp16} data type is
984 independent of whether GCC generates code using hardware floating-point
985 instructions.  In cases where hardware support is not specified, GCC
986 implements conversions between @code{__fp16} and @code{float} values
987 as library calls.
988
989 @node Decimal Float
990 @section Decimal Floating Types
991 @cindex decimal floating types
992 @cindex @code{_Decimal32} data type
993 @cindex @code{_Decimal64} data type
994 @cindex @code{_Decimal128} data type
995 @cindex @code{df} integer suffix
996 @cindex @code{dd} integer suffix
997 @cindex @code{dl} integer suffix
998 @cindex @code{DF} integer suffix
999 @cindex @code{DD} integer suffix
1000 @cindex @code{DL} integer suffix
1001
1002 As an extension, the GNU C compiler supports decimal floating types as
1003 defined in the N1312 draft of ISO/IEC WDTR24732.  Support for decimal
1004 floating types in GCC will evolve as the draft technical report changes.
1005 Calling conventions for any target might also change.  Not all targets
1006 support decimal floating types.
1007
1008 The decimal floating types are @code{_Decimal32}, @code{_Decimal64}, and
1009 @code{_Decimal128}.  They use a radix of ten, unlike the floating types
1010 @code{float}, @code{double}, and @code{long double} whose radix is not
1011 specified by the C standard but is usually two.
1012
1013 Support for decimal floating types includes the arithmetic operators
1014 add, subtract, multiply, divide; unary arithmetic operators;
1015 relational operators; equality operators; and conversions to and from
1016 integer and other floating types.  Use a suffix @samp{df} or
1017 @samp{DF} in a literal constant of type @code{_Decimal32}, @samp{dd}
1018 or @samp{DD} for @code{_Decimal64}, and @samp{dl} or @samp{DL} for
1019 @code{_Decimal128}.
1020
1021 GCC support of decimal float as specified by the draft technical report
1022 is incomplete:
1023
1024 @itemize @bullet
1025 @item
1026 When the value of a decimal floating type cannot be represented in the
1027 integer type to which it is being converted, the result is undefined
1028 rather than the result value specified by the draft technical report.
1029
1030 @item
1031 GCC does not provide the C library functionality associated with
1032 @file{math.h}, @file{fenv.h}, @file{stdio.h}, @file{stdlib.h}, and
1033 @file{wchar.h}, which must come from a separate C library implementation.
1034 Because of this the GNU C compiler does not define macro
1035 @code{__STDC_DEC_FP__} to indicate that the implementation conforms to
1036 the technical report.
1037 @end itemize
1038
1039 Types @code{_Decimal32}, @code{_Decimal64}, and @code{_Decimal128}
1040 are supported by the DWARF2 debug information format.
1041
1042 @node Hex Floats
1043 @section Hex Floats
1044 @cindex hex floats
1045
1046 ISO C99 supports floating-point numbers written not only in the usual
1047 decimal notation, such as @code{1.55e1}, but also numbers such as
1048 @code{0x1.fp3} written in hexadecimal format.  As a GNU extension, GCC
1049 supports this in C90 mode (except in some cases when strictly
1050 conforming) and in C++.  In that format the
1051 @samp{0x} hex introducer and the @samp{p} or @samp{P} exponent field are
1052 mandatory.  The exponent is a decimal number that indicates the power of
1053 2 by which the significant part will be multiplied.  Thus @samp{0x1.f} is
1054 @tex
1055 $1 {15\over16}$,
1056 @end tex
1057 @ifnottex
1058 1 15/16,
1059 @end ifnottex
1060 @samp{p3} multiplies it by 8, and the value of @code{0x1.fp3}
1061 is the same as @code{1.55e1}.
1062
1063 Unlike for floating-point numbers in the decimal notation the exponent
1064 is always required in the hexadecimal notation.  Otherwise the compiler
1065 would not be able to resolve the ambiguity of, e.g., @code{0x1.f}.  This
1066 could mean @code{1.0f} or @code{1.9375} since @samp{f} is also the
1067 extension for floating-point constants of type @code{float}.
1068
1069 @node Fixed-Point
1070 @section Fixed-Point Types
1071 @cindex fixed-point types
1072 @cindex @code{_Fract} data type
1073 @cindex @code{_Accum} data type
1074 @cindex @code{_Sat} data type
1075 @cindex @code{hr} fixed-suffix
1076 @cindex @code{r} fixed-suffix
1077 @cindex @code{lr} fixed-suffix
1078 @cindex @code{llr} fixed-suffix
1079 @cindex @code{uhr} fixed-suffix
1080 @cindex @code{ur} fixed-suffix
1081 @cindex @code{ulr} fixed-suffix
1082 @cindex @code{ullr} fixed-suffix
1083 @cindex @code{hk} fixed-suffix
1084 @cindex @code{k} fixed-suffix
1085 @cindex @code{lk} fixed-suffix
1086 @cindex @code{llk} fixed-suffix
1087 @cindex @code{uhk} fixed-suffix
1088 @cindex @code{uk} fixed-suffix
1089 @cindex @code{ulk} fixed-suffix
1090 @cindex @code{ullk} fixed-suffix
1091 @cindex @code{HR} fixed-suffix
1092 @cindex @code{R} fixed-suffix
1093 @cindex @code{LR} fixed-suffix
1094 @cindex @code{LLR} fixed-suffix
1095 @cindex @code{UHR} fixed-suffix
1096 @cindex @code{UR} fixed-suffix
1097 @cindex @code{ULR} fixed-suffix
1098 @cindex @code{ULLR} fixed-suffix
1099 @cindex @code{HK} fixed-suffix
1100 @cindex @code{K} fixed-suffix
1101 @cindex @code{LK} fixed-suffix
1102 @cindex @code{LLK} fixed-suffix
1103 @cindex @code{UHK} fixed-suffix
1104 @cindex @code{UK} fixed-suffix
1105 @cindex @code{ULK} fixed-suffix
1106 @cindex @code{ULLK} fixed-suffix
1107
1108 As an extension, the GNU C compiler supports fixed-point types as
1109 defined in the N1169 draft of ISO/IEC DTR 18037.  Support for fixed-point
1110 types in GCC will evolve as the draft technical report changes.
1111 Calling conventions for any target might also change.  Not all targets
1112 support fixed-point types.
1113
1114 The fixed-point types are
1115 @code{short _Fract},
1116 @code{_Fract},
1117 @code{long _Fract},
1118 @code{long long _Fract},
1119 @code{unsigned short _Fract},
1120 @code{unsigned _Fract},
1121 @code{unsigned long _Fract},
1122 @code{unsigned long long _Fract},
1123 @code{_Sat short _Fract},
1124 @code{_Sat _Fract},
1125 @code{_Sat long _Fract},
1126 @code{_Sat long long _Fract},
1127 @code{_Sat unsigned short _Fract},
1128 @code{_Sat unsigned _Fract},
1129 @code{_Sat unsigned long _Fract},
1130 @code{_Sat unsigned long long _Fract},
1131 @code{short _Accum},
1132 @code{_Accum},
1133 @code{long _Accum},
1134 @code{long long _Accum},
1135 @code{unsigned short _Accum},
1136 @code{unsigned _Accum},
1137 @code{unsigned long _Accum},
1138 @code{unsigned long long _Accum},
1139 @code{_Sat short _Accum},
1140 @code{_Sat _Accum},
1141 @code{_Sat long _Accum},
1142 @code{_Sat long long _Accum},
1143 @code{_Sat unsigned short _Accum},
1144 @code{_Sat unsigned _Accum},
1145 @code{_Sat unsigned long _Accum},
1146 @code{_Sat unsigned long long _Accum}.
1147
1148 Fixed-point data values contain fractional and optional integral parts.
1149 The format of fixed-point data varies and depends on the target machine.
1150
1151 Support for fixed-point types includes:
1152 @itemize @bullet
1153 @item
1154 prefix and postfix increment and decrement operators (@code{++}, @code{--})
1155 @item
1156 unary arithmetic operators (@code{+}, @code{-}, @code{!})
1157 @item
1158 binary arithmetic operators (@code{+}, @code{-}, @code{*}, @code{/})
1159 @item
1160 binary shift operators (@code{<<}, @code{>>})
1161 @item
1162 relational operators (@code{<}, @code{<=}, @code{>=}, @code{>})
1163 @item
1164 equality operators (@code{==}, @code{!=})
1165 @item
1166 assignment operators (@code{+=}, @code{-=}, @code{*=}, @code{/=},
1167 @code{<<=}, @code{>>=})
1168 @item
1169 conversions to and from integer, floating-point, or fixed-point types
1170 @end itemize
1171
1172 Use a suffix in a fixed-point literal constant:
1173 @itemize
1174 @item @samp{hr} or @samp{HR} for @code{short _Fract} and
1175 @code{_Sat short _Fract}
1176 @item @samp{r} or @samp{R} for @code{_Fract} and @code{_Sat _Fract}
1177 @item @samp{lr} or @samp{LR} for @code{long _Fract} and
1178 @code{_Sat long _Fract}
1179 @item @samp{llr} or @samp{LLR} for @code{long long _Fract} and
1180 @code{_Sat long long _Fract}
1181 @item @samp{uhr} or @samp{UHR} for @code{unsigned short _Fract} and
1182 @code{_Sat unsigned short _Fract}
1183 @item @samp{ur} or @samp{UR} for @code{unsigned _Fract} and
1184 @code{_Sat unsigned _Fract}
1185 @item @samp{ulr} or @samp{ULR} for @code{unsigned long _Fract} and
1186 @code{_Sat unsigned long _Fract}
1187 @item @samp{ullr} or @samp{ULLR} for @code{unsigned long long _Fract}
1188 and @code{_Sat unsigned long long _Fract}
1189 @item @samp{hk} or @samp{HK} for @code{short _Accum} and
1190 @code{_Sat short _Accum}
1191 @item @samp{k} or @samp{K} for @code{_Accum} and @code{_Sat _Accum}
1192 @item @samp{lk} or @samp{LK} for @code{long _Accum} and
1193 @code{_Sat long _Accum}
1194 @item @samp{llk} or @samp{LLK} for @code{long long _Accum} and
1195 @code{_Sat long long _Accum}
1196 @item @samp{uhk} or @samp{UHK} for @code{unsigned short _Accum} and
1197 @code{_Sat unsigned short _Accum}
1198 @item @samp{uk} or @samp{UK} for @code{unsigned _Accum} and
1199 @code{_Sat unsigned _Accum}
1200 @item @samp{ulk} or @samp{ULK} for @code{unsigned long _Accum} and
1201 @code{_Sat unsigned long _Accum}
1202 @item @samp{ullk} or @samp{ULLK} for @code{unsigned long long _Accum}
1203 and @code{_Sat unsigned long long _Accum}
1204 @end itemize
1205
1206 GCC support of fixed-point types as specified by the draft technical report
1207 is incomplete:
1208
1209 @itemize @bullet
1210 @item
1211 Pragmas to control overflow and rounding behaviors are not implemented.
1212 @end itemize
1213
1214 Fixed-point types are supported by the DWARF2 debug information format.
1215
1216 @node Named Address Spaces
1217 @section Named address spaces
1218 @cindex named address spaces
1219
1220 As an extension, the GNU C compiler supports named address spaces as
1221 defined in the N1275 draft of ISO/IEC DTR 18037.  Support for named
1222 address spaces in GCC will evolve as the draft technical report changes.
1223 Calling conventions for any target might also change.  At present, only
1224 the SPU and M32C targets support other address spaces.  On the SPU target, for
1225 example, variables may be declared as belonging to another address space
1226 by qualifying the type with the @code{__ea} address space identifier:
1227
1228 @smallexample
1229 extern int __ea i;
1230 @end smallexample
1231
1232 When the variable @code{i} is accessed, the compiler will generate
1233 special code to access this variable.  It may use runtime library
1234 support, or generate special machine instructions to access that address
1235 space.
1236
1237 The @code{__ea} identifier may be used exactly like any other C type
1238 qualifier (e.g., @code{const} or @code{volatile}).  See the N1275
1239 document for more details.
1240
1241 On the M32C target, with the R8C and M16C cpu variants, variables
1242 qualified with @code{__far} are accessed using 32-bit addresses in
1243 order to access memory beyond the first 64k bytes.  If @code{__far} is
1244 used with the M32CM or M32C cpu variants, it has no effect.
1245
1246 @node Zero Length
1247 @section Arrays of Length Zero
1248 @cindex arrays of length zero
1249 @cindex zero-length arrays
1250 @cindex length-zero arrays
1251 @cindex flexible array members
1252
1253 Zero-length arrays are allowed in GNU C@.  They are very useful as the
1254 last element of a structure which is really a header for a variable-length
1255 object:
1256
1257 @smallexample
1258 struct line @{
1259   int length;
1260   char contents[0];
1261 @};
1262
1263 struct line *thisline = (struct line *)
1264   malloc (sizeof (struct line) + this_length);
1265 thisline->length = this_length;
1266 @end smallexample
1267
1268 In ISO C90, you would have to give @code{contents} a length of 1, which
1269 means either you waste space or complicate the argument to @code{malloc}.
1270
1271 In ISO C99, you would use a @dfn{flexible array member}, which is
1272 slightly different in syntax and semantics:
1273
1274 @itemize @bullet
1275 @item
1276 Flexible array members are written as @code{contents[]} without
1277 the @code{0}.
1278
1279 @item
1280 Flexible array members have incomplete type, and so the @code{sizeof}
1281 operator may not be applied.  As a quirk of the original implementation
1282 of zero-length arrays, @code{sizeof} evaluates to zero.
1283
1284 @item
1285 Flexible array members may only appear as the last member of a
1286 @code{struct} that is otherwise non-empty.
1287
1288 @item
1289 A structure containing a flexible array member, or a union containing
1290 such a structure (possibly recursively), may not be a member of a
1291 structure or an element of an array.  (However, these uses are
1292 permitted by GCC as extensions.)
1293 @end itemize
1294
1295 GCC versions before 3.0 allowed zero-length arrays to be statically
1296 initialized, as if they were flexible arrays.  In addition to those
1297 cases that were useful, it also allowed initializations in situations
1298 that would corrupt later data.  Non-empty initialization of zero-length
1299 arrays is now treated like any case where there are more initializer
1300 elements than the array holds, in that a suitable warning about "excess
1301 elements in array" is given, and the excess elements (all of them, in
1302 this case) are ignored.
1303
1304 Instead GCC allows static initialization of flexible array members.
1305 This is equivalent to defining a new structure containing the original
1306 structure followed by an array of sufficient size to contain the data.
1307 I.e.@: in the following, @code{f1} is constructed as if it were declared
1308 like @code{f2}.
1309
1310 @smallexample
1311 struct f1 @{
1312   int x; int y[];
1313 @} f1 = @{ 1, @{ 2, 3, 4 @} @};
1314
1315 struct f2 @{
1316   struct f1 f1; int data[3];
1317 @} f2 = @{ @{ 1 @}, @{ 2, 3, 4 @} @};
1318 @end smallexample
1319
1320 @noindent
1321 The convenience of this extension is that @code{f1} has the desired
1322 type, eliminating the need to consistently refer to @code{f2.f1}.
1323
1324 This has symmetry with normal static arrays, in that an array of
1325 unknown size is also written with @code{[]}.
1326
1327 Of course, this extension only makes sense if the extra data comes at
1328 the end of a top-level object, as otherwise we would be overwriting
1329 data at subsequent offsets.  To avoid undue complication and confusion
1330 with initialization of deeply nested arrays, we simply disallow any
1331 non-empty initialization except when the structure is the top-level
1332 object.  For example:
1333
1334 @smallexample
1335 struct foo @{ int x; int y[]; @};
1336 struct bar @{ struct foo z; @};
1337
1338 struct foo a = @{ 1, @{ 2, 3, 4 @} @};        // @r{Valid.}
1339 struct bar b = @{ @{ 1, @{ 2, 3, 4 @} @} @};    // @r{Invalid.}
1340 struct bar c = @{ @{ 1, @{ @} @} @};            // @r{Valid.}
1341 struct foo d[1] = @{ @{ 1 @{ 2, 3, 4 @} @} @};  // @r{Invalid.}
1342 @end smallexample
1343
1344 @node Empty Structures
1345 @section Structures With No Members
1346 @cindex empty structures
1347 @cindex zero-size structures
1348
1349 GCC permits a C structure to have no members:
1350
1351 @smallexample
1352 struct empty @{
1353 @};
1354 @end smallexample
1355
1356 The structure will have size zero.  In C++, empty structures are part
1357 of the language.  G++ treats empty structures as if they had a single
1358 member of type @code{char}.
1359
1360 @node Variable Length
1361 @section Arrays of Variable Length
1362 @cindex variable-length arrays
1363 @cindex arrays of variable length
1364 @cindex VLAs
1365
1366 Variable-length automatic arrays are allowed in ISO C99, and as an
1367 extension GCC accepts them in C90 mode and in C++.  These arrays are
1368 declared like any other automatic arrays, but with a length that is not
1369 a constant expression.  The storage is allocated at the point of
1370 declaration and deallocated when the brace-level is exited.  For
1371 example:
1372
1373 @smallexample
1374 FILE *
1375 concat_fopen (char *s1, char *s2, char *mode)
1376 @{
1377   char str[strlen (s1) + strlen (s2) + 1];
1378   strcpy (str, s1);
1379   strcat (str, s2);
1380   return fopen (str, mode);
1381 @}
1382 @end smallexample
1383
1384 @cindex scope of a variable length array
1385 @cindex variable-length array scope
1386 @cindex deallocating variable length arrays
1387 Jumping or breaking out of the scope of the array name deallocates the
1388 storage.  Jumping into the scope is not allowed; you get an error
1389 message for it.
1390
1391 @cindex @code{alloca} vs variable-length arrays
1392 You can use the function @code{alloca} to get an effect much like
1393 variable-length arrays.  The function @code{alloca} is available in
1394 many other C implementations (but not in all).  On the other hand,
1395 variable-length arrays are more elegant.
1396
1397 There are other differences between these two methods.  Space allocated
1398 with @code{alloca} exists until the containing @emph{function} returns.
1399 The space for a variable-length array is deallocated as soon as the array
1400 name's scope ends.  (If you use both variable-length arrays and
1401 @code{alloca} in the same function, deallocation of a variable-length array
1402 will also deallocate anything more recently allocated with @code{alloca}.)
1403
1404 You can also use variable-length arrays as arguments to functions:
1405
1406 @smallexample
1407 struct entry
1408 tester (int len, char data[len][len])
1409 @{
1410   /* @r{@dots{}} */
1411 @}
1412 @end smallexample
1413
1414 The length of an array is computed once when the storage is allocated
1415 and is remembered for the scope of the array in case you access it with
1416 @code{sizeof}.
1417
1418 If you want to pass the array first and the length afterward, you can
1419 use a forward declaration in the parameter list---another GNU extension.
1420
1421 @smallexample
1422 struct entry
1423 tester (int len; char data[len][len], int len)
1424 @{
1425   /* @r{@dots{}} */
1426 @}
1427 @end smallexample
1428
1429 @cindex parameter forward declaration
1430 The @samp{int len} before the semicolon is a @dfn{parameter forward
1431 declaration}, and it serves the purpose of making the name @code{len}
1432 known when the declaration of @code{data} is parsed.
1433
1434 You can write any number of such parameter forward declarations in the
1435 parameter list.  They can be separated by commas or semicolons, but the
1436 last one must end with a semicolon, which is followed by the ``real''
1437 parameter declarations.  Each forward declaration must match a ``real''
1438 declaration in parameter name and data type.  ISO C99 does not support
1439 parameter forward declarations.
1440
1441 @node Variadic Macros
1442 @section Macros with a Variable Number of Arguments.
1443 @cindex variable number of arguments
1444 @cindex macro with variable arguments
1445 @cindex rest argument (in macro)
1446 @cindex variadic macros
1447
1448 In the ISO C standard of 1999, a macro can be declared to accept a
1449 variable number of arguments much as a function can.  The syntax for
1450 defining the macro is similar to that of a function.  Here is an
1451 example:
1452
1453 @smallexample
1454 #define debug(format, ...) fprintf (stderr, format, __VA_ARGS__)
1455 @end smallexample
1456
1457 Here @samp{@dots{}} is a @dfn{variable argument}.  In the invocation of
1458 such a macro, it represents the zero or more tokens until the closing
1459 parenthesis that ends the invocation, including any commas.  This set of
1460 tokens replaces the identifier @code{__VA_ARGS__} in the macro body
1461 wherever it appears.  See the CPP manual for more information.
1462
1463 GCC has long supported variadic macros, and used a different syntax that
1464 allowed you to give a name to the variable arguments just like any other
1465 argument.  Here is an example:
1466
1467 @smallexample
1468 #define debug(format, args...) fprintf (stderr, format, args)
1469 @end smallexample
1470
1471 This is in all ways equivalent to the ISO C example above, but arguably
1472 more readable and descriptive.
1473
1474 GNU CPP has two further variadic macro extensions, and permits them to
1475 be used with either of the above forms of macro definition.
1476
1477 In standard C, you are not allowed to leave the variable argument out
1478 entirely; but you are allowed to pass an empty argument.  For example,
1479 this invocation is invalid in ISO C, because there is no comma after
1480 the string:
1481
1482 @smallexample
1483 debug ("A message")
1484 @end smallexample
1485
1486 GNU CPP permits you to completely omit the variable arguments in this
1487 way.  In the above examples, the compiler would complain, though since
1488 the expansion of the macro still has the extra comma after the format
1489 string.
1490
1491 To help solve this problem, CPP behaves specially for variable arguments
1492 used with the token paste operator, @samp{##}.  If instead you write
1493
1494 @smallexample
1495 #define debug(format, ...) fprintf (stderr, format, ## __VA_ARGS__)
1496 @end smallexample
1497
1498 and if the variable arguments are omitted or empty, the @samp{##}
1499 operator causes the preprocessor to remove the comma before it.  If you
1500 do provide some variable arguments in your macro invocation, GNU CPP
1501 does not complain about the paste operation and instead places the
1502 variable arguments after the comma.  Just like any other pasted macro
1503 argument, these arguments are not macro expanded.
1504
1505 @node Escaped Newlines
1506 @section Slightly Looser Rules for Escaped Newlines
1507 @cindex escaped newlines
1508 @cindex newlines (escaped)
1509
1510 Recently, the preprocessor has relaxed its treatment of escaped
1511 newlines.  Previously, the newline had to immediately follow a
1512 backslash.  The current implementation allows whitespace in the form
1513 of spaces, horizontal and vertical tabs, and form feeds between the
1514 backslash and the subsequent newline.  The preprocessor issues a
1515 warning, but treats it as a valid escaped newline and combines the two
1516 lines to form a single logical line.  This works within comments and
1517 tokens, as well as between tokens.  Comments are @emph{not} treated as
1518 whitespace for the purposes of this relaxation, since they have not
1519 yet been replaced with spaces.
1520
1521 @node Subscripting
1522 @section Non-Lvalue Arrays May Have Subscripts
1523 @cindex subscripting
1524 @cindex arrays, non-lvalue
1525
1526 @cindex subscripting and function values
1527 In ISO C99, arrays that are not lvalues still decay to pointers, and
1528 may be subscripted, although they may not be modified or used after
1529 the next sequence point and the unary @samp{&} operator may not be
1530 applied to them.  As an extension, GCC allows such arrays to be
1531 subscripted in C90 mode, though otherwise they do not decay to
1532 pointers outside C99 mode.  For example,
1533 this is valid in GNU C though not valid in C90:
1534
1535 @smallexample
1536 @group
1537 struct foo @{int a[4];@};
1538
1539 struct foo f();
1540
1541 bar (int index)
1542 @{
1543   return f().a[index];
1544 @}
1545 @end group
1546 @end smallexample
1547
1548 @node Pointer Arith
1549 @section Arithmetic on @code{void}- and Function-Pointers
1550 @cindex void pointers, arithmetic
1551 @cindex void, size of pointer to
1552 @cindex function pointers, arithmetic
1553 @cindex function, size of pointer to
1554
1555 In GNU C, addition and subtraction operations are supported on pointers to
1556 @code{void} and on pointers to functions.  This is done by treating the
1557 size of a @code{void} or of a function as 1.
1558
1559 A consequence of this is that @code{sizeof} is also allowed on @code{void}
1560 and on function types, and returns 1.
1561
1562 @opindex Wpointer-arith
1563 The option @option{-Wpointer-arith} requests a warning if these extensions
1564 are used.
1565
1566 @node Initializers
1567 @section Non-Constant Initializers
1568 @cindex initializers, non-constant
1569 @cindex non-constant initializers
1570
1571 As in standard C++ and ISO C99, the elements of an aggregate initializer for an
1572 automatic variable are not required to be constant expressions in GNU C@.
1573 Here is an example of an initializer with run-time varying elements:
1574
1575 @smallexample
1576 foo (float f, float g)
1577 @{
1578   float beat_freqs[2] = @{ f-g, f+g @};
1579   /* @r{@dots{}} */
1580 @}
1581 @end smallexample
1582
1583 @node Compound Literals
1584 @section Compound Literals
1585 @cindex constructor expressions
1586 @cindex initializations in expressions
1587 @cindex structures, constructor expression
1588 @cindex expressions, constructor
1589 @cindex compound literals
1590 @c The GNU C name for what C99 calls compound literals was "constructor expressions".
1591
1592 ISO C99 supports compound literals.  A compound literal looks like
1593 a cast containing an initializer.  Its value is an object of the
1594 type specified in the cast, containing the elements specified in
1595 the initializer; it is an lvalue.  As an extension, GCC supports
1596 compound literals in C90 mode and in C++.
1597
1598 Usually, the specified type is a structure.  Assume that
1599 @code{struct foo} and @code{structure} are declared as shown:
1600
1601 @smallexample
1602 struct foo @{int a; char b[2];@} structure;
1603 @end smallexample
1604
1605 @noindent
1606 Here is an example of constructing a @code{struct foo} with a compound literal:
1607
1608 @smallexample
1609 structure = ((struct foo) @{x + y, 'a', 0@});
1610 @end smallexample
1611
1612 @noindent
1613 This is equivalent to writing the following:
1614
1615 @smallexample
1616 @{
1617   struct foo temp = @{x + y, 'a', 0@};
1618   structure = temp;
1619 @}
1620 @end smallexample
1621
1622 You can also construct an array.  If all the elements of the compound literal
1623 are (made up of) simple constant expressions, suitable for use in
1624 initializers of objects of static storage duration, then the compound
1625 literal can be coerced to a pointer to its first element and used in
1626 such an initializer, as shown here:
1627
1628 @smallexample
1629 char **foo = (char *[]) @{ "x", "y", "z" @};
1630 @end smallexample
1631
1632 Compound literals for scalar types and union types are is
1633 also allowed, but then the compound literal is equivalent
1634 to a cast.
1635
1636 As a GNU extension, GCC allows initialization of objects with static storage
1637 duration by compound literals (which is not possible in ISO C99, because
1638 the initializer is not a constant).
1639 It is handled as if the object was initialized only with the bracket
1640 enclosed list if the types of the compound literal and the object match.
1641 The initializer list of the compound literal must be constant.
1642 If the object being initialized has array type of unknown size, the size is
1643 determined by compound literal size.
1644
1645 @smallexample
1646 static struct foo x = (struct foo) @{1, 'a', 'b'@};
1647 static int y[] = (int []) @{1, 2, 3@};
1648 static int z[] = (int [3]) @{1@};
1649 @end smallexample
1650
1651 @noindent
1652 The above lines are equivalent to the following:
1653 @smallexample
1654 static struct foo x = @{1, 'a', 'b'@};
1655 static int y[] = @{1, 2, 3@};
1656 static int z[] = @{1, 0, 0@};
1657 @end smallexample
1658
1659 @node Designated Inits
1660 @section Designated Initializers
1661 @cindex initializers with labeled elements
1662 @cindex labeled elements in initializers
1663 @cindex case labels in initializers
1664 @cindex designated initializers
1665
1666 Standard C90 requires the elements of an initializer to appear in a fixed
1667 order, the same as the order of the elements in the array or structure
1668 being initialized.
1669
1670 In ISO C99 you can give the elements in any order, specifying the array
1671 indices or structure field names they apply to, and GNU C allows this as
1672 an extension in C90 mode as well.  This extension is not
1673 implemented in GNU C++.
1674
1675 To specify an array index, write
1676 @samp{[@var{index}] =} before the element value.  For example,
1677
1678 @smallexample
1679 int a[6] = @{ [4] = 29, [2] = 15 @};
1680 @end smallexample
1681
1682 @noindent
1683 is equivalent to
1684
1685 @smallexample
1686 int a[6] = @{ 0, 0, 15, 0, 29, 0 @};
1687 @end smallexample
1688
1689 @noindent
1690 The index values must be constant expressions, even if the array being
1691 initialized is automatic.
1692
1693 An alternative syntax for this which has been obsolete since GCC 2.5 but
1694 GCC still accepts is to write @samp{[@var{index}]} before the element
1695 value, with no @samp{=}.
1696
1697 To initialize a range of elements to the same value, write
1698 @samp{[@var{first} ... @var{last}] = @var{value}}.  This is a GNU
1699 extension.  For example,
1700
1701 @smallexample
1702 int widths[] = @{ [0 ... 9] = 1, [10 ... 99] = 2, [100] = 3 @};
1703 @end smallexample
1704
1705 @noindent
1706 If the value in it has side-effects, the side-effects will happen only once,
1707 not for each initialized field by the range initializer.
1708
1709 @noindent
1710 Note that the length of the array is the highest value specified
1711 plus one.
1712
1713 In a structure initializer, specify the name of a field to initialize
1714 with @samp{.@var{fieldname} =} before the element value.  For example,
1715 given the following structure,
1716
1717 @smallexample
1718 struct point @{ int x, y; @};
1719 @end smallexample
1720
1721 @noindent
1722 the following initialization
1723
1724 @smallexample
1725 struct point p = @{ .y = yvalue, .x = xvalue @};
1726 @end smallexample
1727
1728 @noindent
1729 is equivalent to
1730
1731 @smallexample
1732 struct point p = @{ xvalue, yvalue @};
1733 @end smallexample
1734
1735 Another syntax which has the same meaning, obsolete since GCC 2.5, is
1736 @samp{@var{fieldname}:}, as shown here:
1737
1738 @smallexample
1739 struct point p = @{ y: yvalue, x: xvalue @};
1740 @end smallexample
1741
1742 @cindex designators
1743 The @samp{[@var{index}]} or @samp{.@var{fieldname}} is known as a
1744 @dfn{designator}.  You can also use a designator (or the obsolete colon
1745 syntax) when initializing a union, to specify which element of the union
1746 should be used.  For example,
1747
1748 @smallexample
1749 union foo @{ int i; double d; @};
1750
1751 union foo f = @{ .d = 4 @};
1752 @end smallexample
1753
1754 @noindent
1755 will convert 4 to a @code{double} to store it in the union using
1756 the second element.  By contrast, casting 4 to type @code{union foo}
1757 would store it into the union as the integer @code{i}, since it is
1758 an integer.  (@xref{Cast to Union}.)
1759
1760 You can combine this technique of naming elements with ordinary C
1761 initialization of successive elements.  Each initializer element that
1762 does not have a designator applies to the next consecutive element of the
1763 array or structure.  For example,
1764
1765 @smallexample
1766 int a[6] = @{ [1] = v1, v2, [4] = v4 @};
1767 @end smallexample
1768
1769 @noindent
1770 is equivalent to
1771
1772 @smallexample
1773 int a[6] = @{ 0, v1, v2, 0, v4, 0 @};
1774 @end smallexample
1775
1776 Labeling the elements of an array initializer is especially useful
1777 when the indices are characters or belong to an @code{enum} type.
1778 For example:
1779
1780 @smallexample
1781 int whitespace[256]
1782   = @{ [' '] = 1, ['\t'] = 1, ['\h'] = 1,
1783       ['\f'] = 1, ['\n'] = 1, ['\r'] = 1 @};
1784 @end smallexample
1785
1786 @cindex designator lists
1787 You can also write a series of @samp{.@var{fieldname}} and
1788 @samp{[@var{index}]} designators before an @samp{=} to specify a
1789 nested subobject to initialize; the list is taken relative to the
1790 subobject corresponding to the closest surrounding brace pair.  For
1791 example, with the @samp{struct point} declaration above:
1792
1793 @smallexample
1794 struct point ptarray[10] = @{ [2].y = yv2, [2].x = xv2, [0].x = xv0 @};
1795 @end smallexample
1796
1797 @noindent
1798 If the same field is initialized multiple times, it will have value from
1799 the last initialization.  If any such overridden initialization has
1800 side-effect, it is unspecified whether the side-effect happens or not.
1801 Currently, GCC will discard them and issue a warning.
1802
1803 @node Case Ranges
1804 @section Case Ranges
1805 @cindex case ranges
1806 @cindex ranges in case statements
1807
1808 You can specify a range of consecutive values in a single @code{case} label,
1809 like this:
1810
1811 @smallexample
1812 case @var{low} ... @var{high}:
1813 @end smallexample
1814
1815 @noindent
1816 This has the same effect as the proper number of individual @code{case}
1817 labels, one for each integer value from @var{low} to @var{high}, inclusive.
1818
1819 This feature is especially useful for ranges of ASCII character codes:
1820
1821 @smallexample
1822 case 'A' ... 'Z':
1823 @end smallexample
1824
1825 @strong{Be careful:} Write spaces around the @code{...}, for otherwise
1826 it may be parsed wrong when you use it with integer values.  For example,
1827 write this:
1828
1829 @smallexample
1830 case 1 ... 5:
1831 @end smallexample
1832
1833 @noindent
1834 rather than this:
1835
1836 @smallexample
1837 case 1...5:
1838 @end smallexample
1839
1840 @node Cast to Union
1841 @section Cast to a Union Type
1842 @cindex cast to a union
1843 @cindex union, casting to a
1844
1845 A cast to union type is similar to other casts, except that the type
1846 specified is a union type.  You can specify the type either with
1847 @code{union @var{tag}} or with a typedef name.  A cast to union is actually
1848 a constructor though, not a cast, and hence does not yield an lvalue like
1849 normal casts.  (@xref{Compound Literals}.)
1850
1851 The types that may be cast to the union type are those of the members
1852 of the union.  Thus, given the following union and variables:
1853
1854 @smallexample
1855 union foo @{ int i; double d; @};
1856 int x;
1857 double y;
1858 @end smallexample
1859
1860 @noindent
1861 both @code{x} and @code{y} can be cast to type @code{union foo}.
1862
1863 Using the cast as the right-hand side of an assignment to a variable of
1864 union type is equivalent to storing in a member of the union:
1865
1866 @smallexample
1867 union foo u;
1868 /* @r{@dots{}} */
1869 u = (union foo) x  @equiv{}  u.i = x
1870 u = (union foo) y  @equiv{}  u.d = y
1871 @end smallexample
1872
1873 You can also use the union cast as a function argument:
1874
1875 @smallexample
1876 void hack (union foo);
1877 /* @r{@dots{}} */
1878 hack ((union foo) x);
1879 @end smallexample
1880
1881 @node Mixed Declarations
1882 @section Mixed Declarations and Code
1883 @cindex mixed declarations and code
1884 @cindex declarations, mixed with code
1885 @cindex code, mixed with declarations
1886
1887 ISO C99 and ISO C++ allow declarations and code to be freely mixed
1888 within compound statements.  As an extension, GCC also allows this in
1889 C90 mode.  For example, you could do:
1890
1891 @smallexample
1892 int i;
1893 /* @r{@dots{}} */
1894 i++;
1895 int j = i + 2;
1896 @end smallexample
1897
1898 Each identifier is visible from where it is declared until the end of
1899 the enclosing block.
1900
1901 @node Function Attributes
1902 @section Declaring Attributes of Functions
1903 @cindex function attributes
1904 @cindex declaring attributes of functions
1905 @cindex functions that never return
1906 @cindex functions that return more than once
1907 @cindex functions that have no side effects
1908 @cindex functions in arbitrary sections
1909 @cindex functions that behave like malloc
1910 @cindex @code{volatile} applied to function
1911 @cindex @code{const} applied to function
1912 @cindex functions with @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style arguments
1913 @cindex functions with non-null pointer arguments
1914 @cindex functions that are passed arguments in registers on the 386
1915 @cindex functions that pop the argument stack on the 386
1916 @cindex functions that do not pop the argument stack on the 386
1917 @cindex functions that have different compilation options on the 386
1918 @cindex functions that have different optimization options
1919 @cindex functions that are dynamically resolved
1920
1921 In GNU C, you declare certain things about functions called in your program
1922 which help the compiler optimize function calls and check your code more
1923 carefully.
1924
1925 The keyword @code{__attribute__} allows you to specify special
1926 attributes when making a declaration.  This keyword is followed by an
1927 attribute specification inside double parentheses.  The following
1928 attributes are currently defined for functions on all targets:
1929 @code{aligned}, @code{alloc_size}, @code{noreturn},
1930 @code{returns_twice}, @code{noinline}, @code{noclone},
1931 @code{always_inline}, @code{flatten}, @code{pure}, @code{const},
1932 @code{nothrow}, @code{sentinel}, @code{format}, @code{format_arg},
1933 @code{no_instrument_function}, @code{no_split_stack},
1934 @code{section}, @code{constructor},
1935 @code{destructor}, @code{used}, @code{unused}, @code{deprecated},
1936 @code{weak}, @code{malloc}, @code{alias}, @code{ifunc},
1937 @code{warn_unused_result}, @code{nonnull}, @code{gnu_inline},
1938 @code{externally_visible}, @code{hot}, @code{cold}, @code{artificial},
1939 @code{error} and @code{warning}.  Several other attributes are defined
1940 for functions on particular target systems.  Other attributes,
1941 including @code{section} are supported for variables declarations
1942 (@pxref{Variable Attributes}) and for types (@pxref{Type Attributes}).
1943
1944 GCC plugins may provide their own attributes.
1945
1946 You may also specify attributes with @samp{__} preceding and following
1947 each keyword.  This allows you to use them in header files without
1948 being concerned about a possible macro of the same name.  For example,
1949 you may use @code{__noreturn__} instead of @code{noreturn}.
1950
1951 @xref{Attribute Syntax}, for details of the exact syntax for using
1952 attributes.
1953
1954 @table @code
1955 @c Keep this table alphabetized by attribute name.  Treat _ as space.
1956
1957 @item alias ("@var{target}")
1958 @cindex @code{alias} attribute
1959 The @code{alias} attribute causes the declaration to be emitted as an
1960 alias for another symbol, which must be specified.  For instance,
1961
1962 @smallexample
1963 void __f () @{ /* @r{Do something.} */; @}
1964 void f () __attribute__ ((weak, alias ("__f")));
1965 @end smallexample
1966
1967 defines @samp{f} to be a weak alias for @samp{__f}.  In C++, the
1968 mangled name for the target must be used.  It is an error if @samp{__f}
1969 is not defined in the same translation unit.
1970
1971 Not all target machines support this attribute.
1972
1973 @item aligned (@var{alignment})
1974 @cindex @code{aligned} attribute
1975 This attribute specifies a minimum alignment for the function,
1976 measured in bytes.
1977
1978 You cannot use this attribute to decrease the alignment of a function,
1979 only to increase it.  However, when you explicitly specify a function
1980 alignment this will override the effect of the
1981 @option{-falign-functions} (@pxref{Optimize Options}) option for this
1982 function.
1983
1984 Note that the effectiveness of @code{aligned} attributes may be
1985 limited by inherent limitations in your linker.  On many systems, the
1986 linker is only able to arrange for functions to be aligned up to a
1987 certain maximum alignment.  (For some linkers, the maximum supported
1988 alignment may be very very small.)  See your linker documentation for
1989 further information.
1990
1991 The @code{aligned} attribute can also be used for variables and fields
1992 (@pxref{Variable Attributes}.)
1993
1994 @item alloc_size
1995 @cindex @code{alloc_size} attribute
1996 The @code{alloc_size} attribute is used to tell the compiler that the
1997 function return value points to memory, where the size is given by
1998 one or two of the functions parameters.  GCC uses this
1999 information to improve the correctness of @code{__builtin_object_size}.
2000
2001 The function parameter(s) denoting the allocated size are specified by
2002 one or two integer arguments supplied to the attribute.  The allocated size
2003 is either the value of the single function argument specified or the product
2004 of the two function arguments specified.  Argument numbering starts at
2005 one.
2006
2007 For instance,
2008
2009 @smallexample
2010 void* my_calloc(size_t, size_t) __attribute__((alloc_size(1,2)))
2011 void my_realloc(void*, size_t) __attribute__((alloc_size(2)))
2012 @end smallexample
2013
2014 declares that my_calloc will return memory of the size given by
2015 the product of parameter 1 and 2 and that my_realloc will return memory
2016 of the size given by parameter 2.
2017
2018 @item always_inline
2019 @cindex @code{always_inline} function attribute
2020 Generally, functions are not inlined unless optimization is specified.
2021 For functions declared inline, this attribute inlines the function even
2022 if no optimization level was specified.
2023
2024 @item gnu_inline
2025 @cindex @code{gnu_inline} function attribute
2026 This attribute should be used with a function which is also declared
2027 with the @code{inline} keyword.  It directs GCC to treat the function
2028 as if it were defined in gnu90 mode even when compiling in C99 or
2029 gnu99 mode.
2030
2031 If the function is declared @code{extern}, then this definition of the
2032 function is used only for inlining.  In no case is the function
2033 compiled as a standalone function, not even if you take its address
2034 explicitly.  Such an address becomes an external reference, as if you
2035 had only declared the function, and had not defined it.  This has
2036 almost the effect of a macro.  The way to use this is to put a
2037 function definition in a header file with this attribute, and put
2038 another copy of the function, without @code{extern}, in a library
2039 file.  The definition in the header file will cause most calls to the
2040 function to be inlined.  If any uses of the function remain, they will
2041 refer to the single copy in the library.  Note that the two
2042 definitions of the functions need not be precisely the same, although
2043 if they do not have the same effect your program may behave oddly.
2044
2045 In C, if the function is neither @code{extern} nor @code{static}, then
2046 the function is compiled as a standalone function, as well as being
2047 inlined where possible.
2048
2049 This is how GCC traditionally handled functions declared
2050 @code{inline}.  Since ISO C99 specifies a different semantics for
2051 @code{inline}, this function attribute is provided as a transition
2052 measure and as a useful feature in its own right.  This attribute is
2053 available in GCC 4.1.3 and later.  It is available if either of the
2054 preprocessor macros @code{__GNUC_GNU_INLINE__} or
2055 @code{__GNUC_STDC_INLINE__} are defined.  @xref{Inline,,An Inline
2056 Function is As Fast As a Macro}.
2057
2058 In C++, this attribute does not depend on @code{extern} in any way,
2059 but it still requires the @code{inline} keyword to enable its special
2060 behavior.
2061
2062 @item artificial
2063 @cindex @code{artificial} function attribute
2064 This attribute is useful for small inline wrappers which if possible
2065 should appear during debugging as a unit, depending on the debug
2066 info format it will either mean marking the function as artificial
2067 or using the caller location for all instructions within the inlined
2068 body.
2069
2070 @item bank_switch
2071 @cindex interrupt handler functions
2072 When added to an interrupt handler with the M32C port, causes the
2073 prologue and epilogue to use bank switching to preserve the registers
2074 rather than saving them on the stack.
2075
2076 @item flatten
2077 @cindex @code{flatten} function attribute
2078 Generally, inlining into a function is limited.  For a function marked with
2079 this attribute, every call inside this function will be inlined, if possible.
2080 Whether the function itself is considered for inlining depends on its size and
2081 the current inlining parameters.
2082
2083 @item error ("@var{message}")
2084 @cindex @code{error} function attribute
2085 If this attribute is used on a function declaration and a call to such a function
2086 is not eliminated through dead code elimination or other optimizations, an error
2087 which will include @var{message} will be diagnosed.  This is useful
2088 for compile time checking, especially together with @code{__builtin_constant_p}
2089 and inline functions where checking the inline function arguments is not
2090 possible through @code{extern char [(condition) ? 1 : -1];} tricks.
2091 While it is possible to leave the function undefined and thus invoke
2092 a link failure, when using this attribute the problem will be diagnosed
2093 earlier and with exact location of the call even in presence of inline
2094 functions or when not emitting debugging information.
2095
2096 @item warning ("@var{message}")
2097 @cindex @code{warning} function attribute
2098 If this attribute is used on a function declaration and a call to such a function
2099 is not eliminated through dead code elimination or other optimizations, a warning
2100 which will include @var{message} will be diagnosed.  This is useful
2101 for compile time checking, especially together with @code{__builtin_constant_p}
2102 and inline functions.  While it is possible to define the function with
2103 a message in @code{.gnu.warning*} section, when using this attribute the problem
2104 will be diagnosed earlier and with exact location of the call even in presence
2105 of inline functions or when not emitting debugging information.
2106
2107 @item cdecl
2108 @cindex functions that do pop the argument stack on the 386
2109 @opindex mrtd
2110 On the Intel 386, the @code{cdecl} attribute causes the compiler to
2111 assume that the calling function will pop off the stack space used to
2112 pass arguments.  This is
2113 useful to override the effects of the @option{-mrtd} switch.
2114
2115 @item const
2116 @cindex @code{const} function attribute
2117 Many functions do not examine any values except their arguments, and
2118 have no effects except the return value.  Basically this is just slightly
2119 more strict class than the @code{pure} attribute below, since function is not
2120 allowed to read global memory.
2121
2122 @cindex pointer arguments
2123 Note that a function that has pointer arguments and examines the data
2124 pointed to must @emph{not} be declared @code{const}.  Likewise, a
2125 function that calls a non-@code{const} function usually must not be
2126 @code{const}.  It does not make sense for a @code{const} function to
2127 return @code{void}.
2128
2129 The attribute @code{const} is not implemented in GCC versions earlier
2130 than 2.5.  An alternative way to declare that a function has no side
2131 effects, which works in the current version and in some older versions,
2132 is as follows:
2133
2134 @smallexample
2135 typedef int intfn ();
2136
2137 extern const intfn square;
2138 @end smallexample
2139
2140 This approach does not work in GNU C++ from 2.6.0 on, since the language
2141 specifies that the @samp{const} must be attached to the return value.
2142
2143 @item constructor
2144 @itemx destructor
2145 @itemx constructor (@var{priority})
2146 @itemx destructor (@var{priority})
2147 @cindex @code{constructor} function attribute
2148 @cindex @code{destructor} function attribute
2149 The @code{constructor} attribute causes the function to be called
2150 automatically before execution enters @code{main ()}.  Similarly, the
2151 @code{destructor} attribute causes the function to be called
2152 automatically after @code{main ()} has completed or @code{exit ()} has
2153 been called.  Functions with these attributes are useful for
2154 initializing data that will be used implicitly during the execution of
2155 the program.
2156
2157 You may provide an optional integer priority to control the order in
2158 which constructor and destructor functions are run.  A constructor
2159 with a smaller priority number runs before a constructor with a larger
2160 priority number; the opposite relationship holds for destructors.  So,
2161 if you have a constructor that allocates a resource and a destructor
2162 that deallocates the same resource, both functions typically have the
2163 same priority.  The priorities for constructor and destructor
2164 functions are the same as those specified for namespace-scope C++
2165 objects (@pxref{C++ Attributes}).
2166
2167 These attributes are not currently implemented for Objective-C@.
2168
2169 @item deprecated
2170 @itemx deprecated (@var{msg})
2171 @cindex @code{deprecated} attribute.
2172 The @code{deprecated} attribute results in a warning if the function
2173 is used anywhere in the source file.  This is useful when identifying
2174 functions that are expected to be removed in a future version of a
2175 program.  The warning also includes the location of the declaration
2176 of the deprecated function, to enable users to easily find further
2177 information about why the function is deprecated, or what they should
2178 do instead.  Note that the warnings only occurs for uses:
2179
2180 @smallexample
2181 int old_fn () __attribute__ ((deprecated));
2182 int old_fn ();
2183 int (*fn_ptr)() = old_fn;
2184 @end smallexample
2185
2186 results in a warning on line 3 but not line 2.  The optional msg
2187 argument, which must be a string, will be printed in the warning if
2188 present.
2189
2190 The @code{deprecated} attribute can also be used for variables and
2191 types (@pxref{Variable Attributes}, @pxref{Type Attributes}.)
2192
2193 @item disinterrupt
2194 @cindex @code{disinterrupt} attribute
2195 On MeP targets, this attribute causes the compiler to emit
2196 instructions to disable interrupts for the duration of the given
2197 function.
2198
2199 @item dllexport
2200 @cindex @code{__declspec(dllexport)}
2201 On Microsoft Windows targets and Symbian OS targets the
2202 @code{dllexport} attribute causes the compiler to provide a global
2203 pointer to a pointer in a DLL, so that it can be referenced with the
2204 @code{dllimport} attribute.  On Microsoft Windows targets, the pointer
2205 name is formed by combining @code{_imp__} and the function or variable
2206 name.
2207
2208 You can use @code{__declspec(dllexport)} as a synonym for
2209 @code{__attribute__ ((dllexport))} for compatibility with other
2210 compilers.
2211
2212 On systems that support the @code{visibility} attribute, this
2213 attribute also implies ``default'' visibility.  It is an error to
2214 explicitly specify any other visibility.
2215
2216 In previous versions of GCC, the @code{dllexport} attribute was ignored
2217 for inlined functions, unless the @option{-fkeep-inline-functions} flag
2218 had been used.  The default behaviour now is to emit all dllexported
2219 inline functions; however, this can cause object file-size bloat, in
2220 which case the old behaviour can be restored by using
2221 @option{-fno-keep-inline-dllexport}.
2222
2223 The attribute is also ignored for undefined symbols.
2224
2225 When applied to C++ classes, the attribute marks defined non-inlined
2226 member functions and static data members as exports.  Static consts
2227 initialized in-class are not marked unless they are also defined
2228 out-of-class.
2229
2230 For Microsoft Windows targets there are alternative methods for
2231 including the symbol in the DLL's export table such as using a
2232 @file{.def} file with an @code{EXPORTS} section or, with GNU ld, using
2233 the @option{--export-all} linker flag.
2234
2235 @item dllimport
2236 @cindex @code{__declspec(dllimport)}
2237 On Microsoft Windows and Symbian OS targets, the @code{dllimport}
2238 attribute causes the compiler to reference a function or variable via
2239 a global pointer to a pointer that is set up by the DLL exporting the
2240 symbol.  The attribute implies @code{extern}.  On Microsoft Windows
2241 targets, the pointer name is formed by combining @code{_imp__} and the
2242 function or variable name.
2243
2244 You can use @code{__declspec(dllimport)} as a synonym for
2245 @code{__attribute__ ((dllimport))} for compatibility with other
2246 compilers.
2247
2248 On systems that support the @code{visibility} attribute, this
2249 attribute also implies ``default'' visibility.  It is an error to
2250 explicitly specify any other visibility.
2251
2252 Currently, the attribute is ignored for inlined functions.  If the
2253 attribute is applied to a symbol @emph{definition}, an error is reported.
2254 If a symbol previously declared @code{dllimport} is later defined, the
2255 attribute is ignored in subsequent references, and a warning is emitted.
2256 The attribute is also overridden by a subsequent declaration as
2257 @code{dllexport}.
2258
2259 When applied to C++ classes, the attribute marks non-inlined
2260 member functions and static data members as imports.  However, the
2261 attribute is ignored for virtual methods to allow creation of vtables
2262 using thunks.
2263
2264 On the SH Symbian OS target the @code{dllimport} attribute also has
2265 another affect---it can cause the vtable and run-time type information
2266 for a class to be exported.  This happens when the class has a
2267 dllimport'ed constructor or a non-inline, non-pure virtual function
2268 and, for either of those two conditions, the class also has an inline
2269 constructor or destructor and has a key function that is defined in
2270 the current translation unit.
2271
2272 For Microsoft Windows based targets the use of the @code{dllimport}
2273 attribute on functions is not necessary, but provides a small
2274 performance benefit by eliminating a thunk in the DLL@.  The use of the
2275 @code{dllimport} attribute on imported variables was required on older
2276 versions of the GNU linker, but can now be avoided by passing the
2277 @option{--enable-auto-import} switch to the GNU linker.  As with
2278 functions, using the attribute for a variable eliminates a thunk in
2279 the DLL@.
2280
2281 One drawback to using this attribute is that a pointer to a
2282 @emph{variable} marked as @code{dllimport} cannot be used as a constant
2283 address. However, a pointer to a @emph{function} with the
2284 @code{dllimport} attribute can be used as a constant initializer; in
2285 this case, the address of a stub function in the import lib is
2286 referenced.  On Microsoft Windows targets, the attribute can be disabled
2287 for functions by setting the @option{-mnop-fun-dllimport} flag.
2288
2289 @item eightbit_data
2290 @cindex eight bit data on the H8/300, H8/300H, and H8S
2291 Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
2292 variable should be placed into the eight bit data section.
2293 The compiler will generate more efficient code for certain operations
2294 on data in the eight bit data area.  Note the eight bit data area is limited to
2295 256 bytes of data.
2296
2297 You must use GAS and GLD from GNU binutils version 2.7 or later for
2298 this attribute to work correctly.
2299
2300 @item exception_handler
2301 @cindex exception handler functions on the Blackfin processor
2302 Use this attribute on the Blackfin to indicate that the specified function
2303 is an exception handler.  The compiler will generate function entry and
2304 exit sequences suitable for use in an exception handler when this
2305 attribute is present.
2306
2307 @item externally_visible
2308 @cindex @code{externally_visible} attribute.
2309 This attribute, attached to a global variable or function, nullifies
2310 the effect of the @option{-fwhole-program} command-line option, so the
2311 object remains visible outside the current compilation unit. If @option{-fwhole-program} is used together with @option{-flto} and @command{gold} is used as the linker plugin, @code{externally_visible} attributes are automatically added to functions (not variable yet due to a current @command{gold} issue) that are accessed outside of LTO objects according to resolution file produced by @command{gold}.  For other linkers that cannot generate resolution file, explicit @code{externally_visible} attributes are still necessary.
2312
2313 @item far
2314 @cindex functions which handle memory bank switching
2315 On 68HC11 and 68HC12 the @code{far} attribute causes the compiler to
2316 use a calling convention that takes care of switching memory banks when
2317 entering and leaving a function.  This calling convention is also the
2318 default when using the @option{-mlong-calls} option.
2319
2320 On 68HC12 the compiler will use the @code{call} and @code{rtc} instructions
2321 to call and return from a function.
2322
2323 On 68HC11 the compiler will generate a sequence of instructions
2324 to invoke a board-specific routine to switch the memory bank and call the
2325 real function.  The board-specific routine simulates a @code{call}.
2326 At the end of a function, it will jump to a board-specific routine
2327 instead of using @code{rts}.  The board-specific return routine simulates
2328 the @code{rtc}.
2329
2330 On MeP targets this causes the compiler to use a calling convention
2331 which assumes the called function is too far away for the built-in
2332 addressing modes.
2333
2334 @item fast_interrupt
2335 @cindex interrupt handler functions
2336 Use this attribute on the M32C and RX ports to indicate that the specified
2337 function is a fast interrupt handler.  This is just like the
2338 @code{interrupt} attribute, except that @code{freit} is used to return
2339 instead of @code{reit}.
2340
2341 @item fastcall
2342 @cindex functions that pop the argument stack on the 386
2343 On the Intel 386, the @code{fastcall} attribute causes the compiler to
2344 pass the first argument (if of integral type) in the register ECX and
2345 the second argument (if of integral type) in the register EDX@.  Subsequent
2346 and other typed arguments are passed on the stack.  The called function will
2347 pop the arguments off the stack.  If the number of arguments is variable all
2348 arguments are pushed on the stack.
2349
2350 @item thiscall
2351 @cindex functions that pop the argument stack on the 386
2352 On the Intel 386, the @code{thiscall} attribute causes the compiler to
2353 pass the first argument (if of integral type) in the register ECX.
2354 Subsequent and other typed arguments are passed on the stack. The called
2355 function will pop the arguments off the stack.
2356 If the number of arguments is variable all arguments are pushed on the
2357 stack.
2358 The @code{thiscall} attribute is intended for C++ non-static member functions.
2359 As gcc extension this calling convention can be used for C-functions
2360 and for static member methods.
2361
2362 @item format (@var{archetype}, @var{string-index}, @var{first-to-check})
2363 @cindex @code{format} function attribute
2364 @opindex Wformat
2365 The @code{format} attribute specifies that a function takes @code{printf},
2366 @code{scanf}, @code{strftime} or @code{strfmon} style arguments which
2367 should be type-checked against a format string.  For example, the
2368 declaration:
2369
2370 @smallexample
2371 extern int
2372 my_printf (void *my_object, const char *my_format, ...)
2373       __attribute__ ((format (printf, 2, 3)));
2374 @end smallexample
2375
2376 @noindent
2377 causes the compiler to check the arguments in calls to @code{my_printf}
2378 for consistency with the @code{printf} style format string argument
2379 @code{my_format}.
2380
2381 The parameter @var{archetype} determines how the format string is
2382 interpreted, and should be @code{printf}, @code{scanf}, @code{strftime},
2383 @code{gnu_printf}, @code{gnu_scanf}, @code{gnu_strftime} or
2384 @code{strfmon}.  (You can also use @code{__printf__},
2385 @code{__scanf__}, @code{__strftime__} or @code{__strfmon__}.)  On
2386 MinGW targets, @code{ms_printf}, @code{ms_scanf}, and
2387 @code{ms_strftime} are also present.
2388 @var{archtype} values such as @code{printf} refer to the formats accepted
2389 by the system's C run-time library, while @code{gnu_} values always refer
2390 to the formats accepted by the GNU C Library.  On Microsoft Windows
2391 targets, @code{ms_} values refer to the formats accepted by the
2392 @file{msvcrt.dll} library.
2393 The parameter @var{string-index}
2394 specifies which argument is the format string argument (starting
2395 from 1), while @var{first-to-check} is the number of the first
2396 argument to check against the format string.  For functions
2397 where the arguments are not available to be checked (such as
2398 @code{vprintf}), specify the third parameter as zero.  In this case the
2399 compiler only checks the format string for consistency.  For
2400 @code{strftime} formats, the third parameter is required to be zero.
2401 Since non-static C++ methods have an implicit @code{this} argument, the
2402 arguments of such methods should be counted from two, not one, when
2403 giving values for @var{string-index} and @var{first-to-check}.
2404
2405 In the example above, the format string (@code{my_format}) is the second
2406 argument of the function @code{my_print}, and the arguments to check
2407 start with the third argument, so the correct parameters for the format
2408 attribute are 2 and 3.
2409
2410 @opindex ffreestanding
2411 @opindex fno-builtin
2412 The @code{format} attribute allows you to identify your own functions
2413 which take format strings as arguments, so that GCC can check the
2414 calls to these functions for errors.  The compiler always (unless
2415 @option{-ffreestanding} or @option{-fno-builtin} is used) checks formats
2416 for the standard library functions @code{printf}, @code{fprintf},
2417 @code{sprintf}, @code{scanf}, @code{fscanf}, @code{sscanf}, @code{strftime},
2418 @code{vprintf}, @code{vfprintf} and @code{vsprintf} whenever such
2419 warnings are requested (using @option{-Wformat}), so there is no need to
2420 modify the header file @file{stdio.h}.  In C99 mode, the functions
2421 @code{snprintf}, @code{vsnprintf}, @code{vscanf}, @code{vfscanf} and
2422 @code{vsscanf} are also checked.  Except in strictly conforming C
2423 standard modes, the X/Open function @code{strfmon} is also checked as
2424 are @code{printf_unlocked} and @code{fprintf_unlocked}.
2425 @xref{C Dialect Options,,Options Controlling C Dialect}.
2426
2427 For Objective-C dialects, @code{NSString} (or @code{__NSString__}) is
2428 recognized in the same context.  Declarations including these format attributes
2429 will be parsed for correct syntax, however the result of checking of such format
2430 strings is not yet defined, and will not be carried out by this version of the
2431 compiler.
2432
2433 The target may also provide additional types of format checks.
2434 @xref{Target Format Checks,,Format Checks Specific to Particular
2435 Target Machines}.
2436
2437 @item format_arg (@var{string-index})
2438 @cindex @code{format_arg} function attribute
2439 @opindex Wformat-nonliteral
2440 The @code{format_arg} attribute specifies that a function takes a format
2441 string for a @code{printf}, @code{scanf}, @code{strftime} or
2442 @code{strfmon} style function and modifies it (for example, to translate
2443 it into another language), so the result can be passed to a
2444 @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style
2445 function (with the remaining arguments to the format function the same
2446 as they would have been for the unmodified string).  For example, the
2447 declaration:
2448
2449 @smallexample
2450 extern char *
2451 my_dgettext (char *my_domain, const char *my_format)
2452       __attribute__ ((format_arg (2)));
2453 @end smallexample
2454
2455 @noindent
2456 causes the compiler to check the arguments in calls to a @code{printf},
2457 @code{scanf}, @code{strftime} or @code{strfmon} type function, whose
2458 format string argument is a call to the @code{my_dgettext} function, for
2459 consistency with the format string argument @code{my_format}.  If the
2460 @code{format_arg} attribute had not been specified, all the compiler
2461 could tell in such calls to format functions would be that the format
2462 string argument is not constant; this would generate a warning when
2463 @option{-Wformat-nonliteral} is used, but the calls could not be checked
2464 without the attribute.
2465
2466 The parameter @var{string-index} specifies which argument is the format
2467 string argument (starting from one).  Since non-static C++ methods have
2468 an implicit @code{this} argument, the arguments of such methods should
2469 be counted from two.
2470
2471 The @code{format-arg} attribute allows you to identify your own
2472 functions which modify format strings, so that GCC can check the
2473 calls to @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon}
2474 type function whose operands are a call to one of your own function.
2475 The compiler always treats @code{gettext}, @code{dgettext}, and
2476 @code{dcgettext} in this manner except when strict ISO C support is
2477 requested by @option{-ansi} or an appropriate @option{-std} option, or
2478 @option{-ffreestanding} or @option{-fno-builtin}
2479 is used.  @xref{C Dialect Options,,Options
2480 Controlling C Dialect}.
2481
2482 For Objective-C dialects, the @code{format-arg} attribute may refer to an
2483 @code{NSString} reference for compatibility with the @code{format} attribute
2484 above.
2485
2486 The target may also allow additional types in @code{format-arg} attributes.
2487 @xref{Target Format Checks,,Format Checks Specific to Particular
2488 Target Machines}.
2489
2490 @item function_vector
2491 @cindex calling functions through the function vector on H8/300, M16C, M32C and SH2A processors
2492 Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
2493 function should be called through the function vector.  Calling a
2494 function through the function vector will reduce code size, however;
2495 the function vector has a limited size (maximum 128 entries on the H8/300
2496 and 64 entries on the H8/300H and H8S) and shares space with the interrupt vector.
2497
2498 In SH2A target, this attribute declares a function to be called using the
2499 TBR relative addressing mode.  The argument to this attribute is the entry
2500 number of the same function in a vector table containing all the TBR
2501 relative addressable functions.  For the successful jump, register TBR
2502 should contain the start address of this TBR relative vector table.
2503 In the startup routine of the user application, user needs to care of this
2504 TBR register initialization.  The TBR relative vector table can have at
2505 max 256 function entries.  The jumps to these functions will be generated
2506 using a SH2A specific, non delayed branch instruction JSR/N @@(disp8,TBR).
2507 You must use GAS and GLD from GNU binutils version 2.7 or later for
2508 this attribute to work correctly.
2509
2510 Please refer the example of M16C target, to see the use of this
2511 attribute while declaring a function,
2512
2513 In an application, for a function being called once, this attribute will
2514 save at least 8 bytes of code; and if other successive calls are being
2515 made to the same function, it will save 2 bytes of code per each of these
2516 calls.
2517
2518 On M16C/M32C targets, the @code{function_vector} attribute declares a
2519 special page subroutine call function. Use of this attribute reduces
2520 the code size by 2 bytes for each call generated to the
2521 subroutine. The argument to the attribute is the vector number entry
2522 from the special page vector table which contains the 16 low-order
2523 bits of the subroutine's entry address. Each vector table has special
2524 page number (18 to 255) which are used in @code{jsrs} instruction.
2525 Jump addresses of the routines are generated by adding 0x0F0000 (in
2526 case of M16C targets) or 0xFF0000 (in case of M32C targets), to the 2
2527 byte addresses set in the vector table. Therefore you need to ensure
2528 that all the special page vector routines should get mapped within the
2529 address range 0x0F0000 to 0x0FFFFF (for M16C) and 0xFF0000 to 0xFFFFFF
2530 (for M32C).
2531
2532 In the following example 2 bytes will be saved for each call to
2533 function @code{foo}.
2534
2535 @smallexample
2536 void foo (void) __attribute__((function_vector(0x18)));
2537 void foo (void)
2538 @{
2539 @}
2540
2541 void bar (void)
2542 @{
2543     foo();
2544 @}
2545 @end smallexample
2546
2547 If functions are defined in one file and are called in another file,
2548 then be sure to write this declaration in both files.
2549
2550 This attribute is ignored for R8C target.
2551
2552 @item interrupt
2553 @cindex interrupt handler functions
2554 Use this attribute on the ARM, AVR, M32C, M32R/D, m68k, MeP, MIPS,
2555 RX and Xstormy16 ports to indicate that the specified function is an
2556 interrupt handler.  The compiler will generate function entry and exit
2557 sequences suitable for use in an interrupt handler when this attribute
2558 is present.
2559
2560 Note, interrupt handlers for the Blackfin, H8/300, H8/300H, H8S, MicroBlaze,
2561 and SH processors can be specified via the @code{interrupt_handler} attribute.
2562
2563 Note, on the AVR, interrupts will be enabled inside the function.
2564
2565 Note, for the ARM, you can specify the kind of interrupt to be handled by
2566 adding an optional parameter to the interrupt attribute like this:
2567
2568 @smallexample
2569 void f () __attribute__ ((interrupt ("IRQ")));
2570 @end smallexample
2571
2572 Permissible values for this parameter are: IRQ, FIQ, SWI, ABORT and UNDEF@.
2573
2574 On ARMv7-M the interrupt type is ignored, and the attribute means the function
2575 may be called with a word aligned stack pointer.
2576
2577 On MIPS targets, you can use the following attributes to modify the behavior
2578 of an interrupt handler:
2579 @table @code
2580 @item use_shadow_register_set
2581 @cindex @code{use_shadow_register_set} attribute
2582 Assume that the handler uses a shadow register set, instead of
2583 the main general-purpose registers.
2584
2585 @item keep_interrupts_masked
2586 @cindex @code{keep_interrupts_masked} attribute
2587 Keep interrupts masked for the whole function.  Without this attribute,
2588 GCC tries to reenable interrupts for as much of the function as it can.
2589
2590 @item use_debug_exception_return
2591 @cindex @code{use_debug_exception_return} attribute
2592 Return using the @code{deret} instruction.  Interrupt handlers that don't
2593 have this attribute return using @code{eret} instead.
2594 @end table
2595
2596 You can use any combination of these attributes, as shown below:
2597 @smallexample
2598 void __attribute__ ((interrupt)) v0 ();
2599 void __attribute__ ((interrupt, use_shadow_register_set)) v1 ();
2600 void __attribute__ ((interrupt, keep_interrupts_masked)) v2 ();
2601 void __attribute__ ((interrupt, use_debug_exception_return)) v3 ();
2602 void __attribute__ ((interrupt, use_shadow_register_set,
2603                      keep_interrupts_masked)) v4 ();
2604 void __attribute__ ((interrupt, use_shadow_register_set,
2605                      use_debug_exception_return)) v5 ();
2606 void __attribute__ ((interrupt, keep_interrupts_masked,
2607                      use_debug_exception_return)) v6 ();
2608 void __attribute__ ((interrupt, use_shadow_register_set,
2609                      keep_interrupts_masked,
2610                      use_debug_exception_return)) v7 ();
2611 @end smallexample
2612
2613 @item ifunc ("@var{resolver}")
2614 @cindex @code{ifunc} attribute
2615 The @code{ifunc} attribute is used to mark a function as an indirect
2616 function using the STT_GNU_IFUNC symbol type extension to the ELF
2617 standard.  This allows the resolution of the symbol value to be
2618 determined dynamically at load time, and an optimized version of the
2619 routine can be selected for the particular processor or other system
2620 characteristics determined then.  To use this attribute, first define
2621 the implementation functions available, and a resolver function that
2622 returns a pointer to the selected implementation function.  The
2623 implementation functions' declarations must match the API of the
2624 function being implemented, the resolver's declaration is be a
2625 function returning pointer to void function returning void:
2626
2627 @smallexample
2628 void *my_memcpy (void *dst, const void *src, size_t len)
2629 @{
2630   @dots{}
2631 @}
2632
2633 static void (*resolve_memcpy (void)) (void)
2634 @{
2635   return my_memcpy; // we'll just always select this routine
2636 @}
2637 @end smallexample
2638
2639 The exported header file declaring the function the user calls would
2640 contain:
2641
2642 @smallexample
2643 extern void *memcpy (void *, const void *, size_t);
2644 @end smallexample
2645
2646 allowing the user to call this as a regular function, unaware of the
2647 implementation.  Finally, the indirect function needs to be defined in
2648 the same translation unit as the resolver function:
2649
2650 @smallexample
2651 void *memcpy (void *, const void *, size_t)
2652      __attribute__ ((ifunc ("resolve_memcpy")));
2653 @end smallexample
2654
2655 Indirect functions cannot be weak, and require a recent binutils (at
2656 least version 2.20.1), and GNU C library (at least version 2.11.1).
2657
2658 @item interrupt_handler
2659 @cindex interrupt handler functions on the Blackfin, m68k, H8/300 and SH processors
2660 Use this attribute on the Blackfin, m68k, H8/300, H8/300H, H8S, and SH to
2661 indicate that the specified function is an interrupt handler.  The compiler
2662 will generate function entry and exit sequences suitable for use in an
2663 interrupt handler when this attribute is present.
2664
2665 @item interrupt_thread
2666 @cindex interrupt thread functions on fido
2667 Use this attribute on fido, a subarchitecture of the m68k, to indicate
2668 that the specified function is an interrupt handler that is designed
2669 to run as a thread.  The compiler omits generate prologue/epilogue
2670 sequences and replaces the return instruction with a @code{sleep}
2671 instruction.  This attribute is available only on fido.
2672
2673 @item isr
2674 @cindex interrupt service routines on ARM
2675 Use this attribute on ARM to write Interrupt Service Routines. This is an
2676 alias to the @code{interrupt} attribute above.
2677
2678 @item kspisusp
2679 @cindex User stack pointer in interrupts on the Blackfin
2680 When used together with @code{interrupt_handler}, @code{exception_handler}
2681 or @code{nmi_handler}, code will be generated to load the stack pointer
2682 from the USP register in the function prologue.
2683
2684 @item l1_text
2685 @cindex @code{l1_text} function attribute
2686 This attribute specifies a function to be placed into L1 Instruction
2687 SRAM@. The function will be put into a specific section named @code{.l1.text}.
2688 With @option{-mfdpic}, function calls with a such function as the callee
2689 or caller will use inlined PLT.
2690
2691 @item l2
2692 @cindex @code{l2} function attribute
2693 On the Blackfin, this attribute specifies a function to be placed into L2
2694 SRAM. The function will be put into a specific section named
2695 @code{.l1.text}. With @option{-mfdpic}, callers of such functions will use
2696 an inlined PLT.
2697
2698 @item leaf
2699 @cindex @code{leaf} function attribute
2700 Calls to external functions with this attribute must return to the current
2701 compilation unit only by return or by exception handling.  In particular, leaf
2702 functions are not allowed to call callback function passed to it from the current
2703 compilation unit or directly call functions exported by the unit or longjmp
2704 into the unit.  Leaf function might still call functions from other compilation
2705 units and thus they are not necessarily leaf in the sense that they contain no
2706 function calls at all.
2707
2708 The attribute is intended for library functions to improve dataflow analysis.
2709 The compiler takes the hint that any data not escaping the current compilation unit can
2710 not be used or modified by the leaf function.  For example, the @code{sin} function
2711 is a leaf function, but @code{qsort} is not.
2712
2713 Note that leaf functions might invoke signals and signal handlers might be
2714 defined in the current compilation unit and use static variables.  The only
2715 compliant way to write such a signal handler is to declare such variables
2716 @code{volatile}.
2717
2718 The attribute has no effect on functions defined within the current compilation
2719 unit.  This is to allow easy merging of multiple compilation units into one,
2720 for example, by using the link time optimization.  For this reason the
2721 attribute is not allowed on types to annotate indirect calls.
2722
2723 @item long_call/short_call
2724 @cindex indirect calls on ARM
2725 This attribute specifies how a particular function is called on
2726 ARM@.  Both attributes override the @option{-mlong-calls} (@pxref{ARM Options})
2727 command-line switch and @code{#pragma long_calls} settings.  The
2728 @code{long_call} attribute indicates that the function might be far
2729 away from the call site and require a different (more expensive)
2730 calling sequence.   The @code{short_call} attribute always places
2731 the offset to the function from the call site into the @samp{BL}
2732 instruction directly.
2733
2734 @item longcall/shortcall
2735 @cindex functions called via pointer on the RS/6000 and PowerPC
2736 On the Blackfin, RS/6000 and PowerPC, the @code{longcall} attribute
2737 indicates that the function might be far away from the call site and
2738 require a different (more expensive) calling sequence.  The
2739 @code{shortcall} attribute indicates that the function is always close
2740 enough for the shorter calling sequence to be used.  These attributes
2741 override both the @option{-mlongcall} switch and, on the RS/6000 and
2742 PowerPC, the @code{#pragma longcall} setting.
2743
2744 @xref{RS/6000 and PowerPC Options}, for more information on whether long
2745 calls are necessary.
2746
2747 @item long_call/near/far
2748 @cindex indirect calls on MIPS
2749 These attributes specify how a particular function is called on MIPS@.
2750 The attributes override the @option{-mlong-calls} (@pxref{MIPS Options})
2751 command-line switch.  The @code{long_call} and @code{far} attributes are
2752 synonyms, and cause the compiler to always call
2753 the function by first loading its address into a register, and then using
2754 the contents of that register.  The @code{near} attribute has the opposite
2755 effect; it specifies that non-PIC calls should be made using the more
2756 efficient @code{jal} instruction.
2757
2758 @item malloc
2759 @cindex @code{malloc} attribute
2760 The @code{malloc} attribute is used to tell the compiler that a function
2761 may be treated as if any non-@code{NULL} pointer it returns cannot
2762 alias any other pointer valid when the function returns.
2763 This will often improve optimization.
2764 Standard functions with this property include @code{malloc} and
2765 @code{calloc}.  @code{realloc}-like functions have this property as
2766 long as the old pointer is never referred to (including comparing it
2767 to the new pointer) after the function returns a non-@code{NULL}
2768 value.
2769
2770 @item mips16/nomips16
2771 @cindex @code{mips16} attribute
2772 @cindex @code{nomips16} attribute
2773
2774 On MIPS targets, you can use the @code{mips16} and @code{nomips16}
2775 function attributes to locally select or turn off MIPS16 code generation.
2776 A function with the @code{mips16} attribute is emitted as MIPS16 code,
2777 while MIPS16 code generation is disabled for functions with the
2778 @code{nomips16} attribute.  These attributes override the
2779 @option{-mips16} and @option{-mno-mips16} options on the command line
2780 (@pxref{MIPS Options}).
2781
2782 When compiling files containing mixed MIPS16 and non-MIPS16 code, the
2783 preprocessor symbol @code{__mips16} reflects the setting on the command line,
2784 not that within individual functions.  Mixed MIPS16 and non-MIPS16 code
2785 may interact badly with some GCC extensions such as @code{__builtin_apply}
2786 (@pxref{Constructing Calls}).
2787
2788 @item model (@var{model-name})
2789 @cindex function addressability on the M32R/D
2790 @cindex variable addressability on the IA-64
2791
2792 On the M32R/D, use this attribute to set the addressability of an
2793 object, and of the code generated for a function.  The identifier
2794 @var{model-name} is one of @code{small}, @code{medium}, or
2795 @code{large}, representing each of the code models.
2796
2797 Small model objects live in the lower 16MB of memory (so that their
2798 addresses can be loaded with the @code{ld24} instruction), and are
2799 callable with the @code{bl} instruction.
2800
2801 Medium model objects may live anywhere in the 32-bit address space (the
2802 compiler will generate @code{seth/add3} instructions to load their addresses),
2803 and are callable with the @code{bl} instruction.
2804
2805 Large model objects may live anywhere in the 32-bit address space (the
2806 compiler will generate @code{seth/add3} instructions to load their addresses),
2807 and may not be reachable with the @code{bl} instruction (the compiler will
2808 generate the much slower @code{seth/add3/jl} instruction sequence).
2809
2810 On IA-64, use this attribute to set the addressability of an object.
2811 At present, the only supported identifier for @var{model-name} is
2812 @code{small}, indicating addressability via ``small'' (22-bit)
2813 addresses (so that their addresses can be loaded with the @code{addl}
2814 instruction).  Caveat: such addressing is by definition not position
2815 independent and hence this attribute must not be used for objects
2816 defined by shared libraries.
2817
2818 @item ms_abi/sysv_abi
2819 @cindex @code{ms_abi} attribute
2820 @cindex @code{sysv_abi} attribute
2821
2822 On 64-bit x86_64-*-* targets, you can use an ABI attribute to indicate
2823 which calling convention should be used for a function.  The @code{ms_abi}
2824 attribute tells the compiler to use the Microsoft ABI, while the
2825 @code{sysv_abi} attribute tells the compiler to use the ABI used on
2826 GNU/Linux and other systems.  The default is to use the Microsoft ABI
2827 when targeting Windows.  On all other systems, the default is the AMD ABI.
2828
2829 Note, the @code{ms_abi} attribute for Windows targets currently requires
2830 the @option{-maccumulate-outgoing-args} option.
2831
2832 @item callee_pop_aggregate_return (@var{number})
2833 @cindex @code{callee_pop_aggregate_return} attribute
2834
2835 On 32-bit i?86-*-* targets, you can control by those attribute for
2836 aggregate return in memory, if the caller is responsible to pop the hidden
2837 pointer together with the rest of the arguments - @var{number} equal to
2838 zero -, or if the callee is responsible to pop hidden pointer - @var{number}
2839 equal to one.
2840
2841 For i?86-netware, the caller pops the stack for the hidden arguments pointing
2842 to aggregate return value.  This differs from the default i386 ABI which assumes
2843 that the callee pops the stack for hidden pointer.
2844
2845 @item ms_hook_prologue
2846 @cindex @code{ms_hook_prologue} attribute
2847
2848 On 32 bit i[34567]86-*-* targets and 64 bit x86_64-*-* targets, you can use
2849 this function attribute to make gcc generate the "hot-patching" function
2850 prologue used in Win32 API functions in Microsoft Windows XP Service Pack 2
2851 and newer.
2852
2853 @item naked
2854 @cindex function without a prologue/epilogue code
2855 Use this attribute on the ARM, AVR, MCORE, RX and SPU ports to indicate that
2856 the specified function does not need prologue/epilogue sequences generated by
2857 the compiler.  It is up to the programmer to provide these sequences. The
2858 only statements that can be safely included in naked functions are
2859 @code{asm} statements that do not have operands.  All other statements,
2860 including declarations of local variables, @code{if} statements, and so
2861 forth, should be avoided.  Naked functions should be used to implement the
2862 body of an assembly function, while allowing the compiler to construct
2863 the requisite function declaration for the assembler.
2864
2865 @item near
2866 @cindex functions which do not handle memory bank switching on 68HC11/68HC12
2867 On 68HC11 and 68HC12 the @code{near} attribute causes the compiler to
2868 use the normal calling convention based on @code{jsr} and @code{rts}.
2869 This attribute can be used to cancel the effect of the @option{-mlong-calls}
2870 option.
2871
2872 On MeP targets this attribute causes the compiler to assume the called
2873 function is close enough to use the normal calling convention,
2874 overriding the @code{-mtf} command line option.
2875
2876 @item nesting
2877 @cindex Allow nesting in an interrupt handler on the Blackfin processor.
2878 Use this attribute together with @code{interrupt_handler},
2879 @code{exception_handler} or @code{nmi_handler} to indicate that the function
2880 entry code should enable nested interrupts or exceptions.
2881
2882 @item nmi_handler
2883 @cindex NMI handler functions on the Blackfin processor
2884 Use this attribute on the Blackfin to indicate that the specified function
2885 is an NMI handler.  The compiler will generate function entry and
2886 exit sequences suitable for use in an NMI handler when this
2887 attribute is present.
2888
2889 @item no_instrument_function
2890 @cindex @code{no_instrument_function} function attribute
2891 @opindex finstrument-functions
2892 If @option{-finstrument-functions} is given, profiling function calls will
2893 be generated at entry and exit of most user-compiled functions.
2894 Functions with this attribute will not be so instrumented.
2895
2896 @item no_split_stack
2897 @cindex @code{no_split_stack} function attribute
2898 @opindex fsplit-stack
2899 If @option{-fsplit-stack} is given, functions will have a small
2900 prologue which decides whether to split the stack.  Functions with the
2901 @code{no_split_stack} attribute will not have that prologue, and thus
2902 may run with only a small amount of stack space available.
2903
2904 @item noinline
2905 @cindex @code{noinline} function attribute
2906 This function attribute prevents a function from being considered for
2907 inlining.
2908 @c Don't enumerate the optimizations by name here; we try to be
2909 @c future-compatible with this mechanism.
2910 If the function does not have side-effects, there are optimizations
2911 other than inlining that causes function calls to be optimized away,
2912 although the function call is live.  To keep such calls from being
2913 optimized away, put
2914 @smallexample
2915 asm ("");
2916 @end smallexample
2917 (@pxref{Extended Asm}) in the called function, to serve as a special
2918 side-effect.
2919
2920 @item noclone
2921 @cindex @code{noclone} function attribute
2922 This function attribute prevents a function from being considered for
2923 cloning - a mechanism which produces specialized copies of functions
2924 and which is (currently) performed by interprocedural constant
2925 propagation.
2926
2927 @item nonnull (@var{arg-index}, @dots{})
2928 @cindex @code{nonnull} function attribute
2929 The @code{nonnull} attribute specifies that some function parameters should
2930 be non-null pointers.  For instance, the declaration:
2931
2932 @smallexample
2933 extern void *
2934 my_memcpy (void *dest, const void *src, size_t len)
2935         __attribute__((nonnull (1, 2)));
2936 @end smallexample
2937
2938 @noindent
2939 causes the compiler to check that, in calls to @code{my_memcpy},
2940 arguments @var{dest} and @var{src} are non-null.  If the compiler
2941 determines that a null pointer is passed in an argument slot marked
2942 as non-null, and the @option{-Wnonnull} option is enabled, a warning
2943 is issued.  The compiler may also choose to make optimizations based
2944 on the knowledge that certain function arguments will not be null.
2945
2946 If no argument index list is given to the @code{nonnull} attribute,
2947 all pointer arguments are marked as non-null.  To illustrate, the
2948 following declaration is equivalent to the previous example:
2949
2950 @smallexample
2951 extern void *
2952 my_memcpy (void *dest, const void *src, size_t len)
2953         __attribute__((nonnull));
2954 @end smallexample
2955
2956 @item noreturn
2957 @cindex @code{noreturn} function attribute
2958 A few standard library functions, such as @code{abort} and @code{exit},
2959 cannot return.  GCC knows this automatically.  Some programs define
2960 their own functions that never return.  You can declare them
2961 @code{noreturn} to tell the compiler this fact.  For example,
2962
2963 @smallexample
2964 @group
2965 void fatal () __attribute__ ((noreturn));
2966
2967 void
2968 fatal (/* @r{@dots{}} */)
2969 @{
2970   /* @r{@dots{}} */ /* @r{Print error message.} */ /* @r{@dots{}} */
2971   exit (1);
2972 @}
2973 @end group
2974 @end smallexample
2975
2976 The @code{noreturn} keyword tells the compiler to assume that
2977 @code{fatal} cannot return.  It can then optimize without regard to what
2978 would happen if @code{fatal} ever did return.  This makes slightly
2979 better code.  More importantly, it helps avoid spurious warnings of
2980 uninitialized variables.
2981
2982 The @code{noreturn} keyword does not affect the exceptional path when that
2983 applies: a @code{noreturn}-marked function may still return to the caller
2984 by throwing an exception or calling @code{longjmp}.
2985
2986 Do not assume that registers saved by the calling function are
2987 restored before calling the @code{noreturn} function.
2988
2989 It does not make sense for a @code{noreturn} function to have a return
2990 type other than @code{void}.
2991
2992 The attribute @code{noreturn} is not implemented in GCC versions
2993 earlier than 2.5.  An alternative way to declare that a function does
2994 not return, which works in the current version and in some older
2995 versions, is as follows:
2996
2997 @smallexample
2998 typedef void voidfn ();
2999
3000 volatile voidfn fatal;
3001 @end smallexample
3002
3003 This approach does not work in GNU C++.
3004
3005 @item nothrow
3006 @cindex @code{nothrow} function attribute
3007 The @code{nothrow} attribute is used to inform the compiler that a
3008 function cannot throw an exception.  For example, most functions in
3009 the standard C library can be guaranteed not to throw an exception
3010 with the notable exceptions of @code{qsort} and @code{bsearch} that
3011 take function pointer arguments.  The @code{nothrow} attribute is not
3012 implemented in GCC versions earlier than 3.3.
3013
3014 @item optimize
3015 @cindex @code{optimize} function attribute
3016 The @code{optimize} attribute is used to specify that a function is to
3017 be compiled with different optimization options than specified on the
3018 command line.  Arguments can either be numbers or strings.  Numbers
3019 are assumed to be an optimization level.  Strings that begin with
3020 @code{O} are assumed to be an optimization option, while other options
3021 are assumed to be used with a @code{-f} prefix.  You can also use the
3022 @samp{#pragma GCC optimize} pragma to set the optimization options
3023 that affect more than one function.
3024 @xref{Function Specific Option Pragmas}, for details about the
3025 @samp{#pragma GCC optimize} pragma.
3026
3027 This can be used for instance to have frequently executed functions
3028 compiled with more aggressive optimization options that produce faster
3029 and larger code, while other functions can be called with less
3030 aggressive options.
3031
3032 @item pcs
3033 @cindex @code{pcs} function attribute
3034
3035 The @code{pcs} attribute can be used to control the calling convention
3036 used for a function on ARM.  The attribute takes an argument that specifies
3037 the calling convention to use.
3038
3039 When compiling using the AAPCS ABI (or a variant of that) then valid
3040 values for the argument are @code{"aapcs"} and @code{"aapcs-vfp"}.  In
3041 order to use a variant other than @code{"aapcs"} then the compiler must
3042 be permitted to use the appropriate co-processor registers (i.e., the
3043 VFP registers must be available in order to use @code{"aapcs-vfp"}).
3044 For example,
3045
3046 @smallexample
3047 /* Argument passed in r0, and result returned in r0+r1.  */
3048 double f2d (float) __attribute__((pcs("aapcs")));
3049 @end smallexample
3050
3051 Variadic functions always use the @code{"aapcs"} calling convention and
3052 the compiler will reject attempts to specify an alternative.
3053
3054 @item pure
3055 @cindex @code{pure} function attribute
3056 Many functions have no effects except the return value and their
3057 return value depends only on the parameters and/or global variables.
3058 Such a function can be subject
3059 to common subexpression elimination and loop optimization just as an
3060 arithmetic operator would be.  These functions should be declared
3061 with the attribute @code{pure}.  For example,
3062
3063 @smallexample
3064 int square (int) __attribute__ ((pure));
3065 @end smallexample
3066
3067 @noindent
3068 says that the hypothetical function @code{square} is safe to call
3069 fewer times than the program says.
3070
3071 Some of common examples of pure functions are @code{strlen} or @code{memcmp}.
3072 Interesting non-pure functions are functions with infinite loops or those
3073 depending on volatile memory or other system resource, that may change between
3074 two consecutive calls (such as @code{feof} in a multithreading environment).
3075
3076 The attribute @code{pure} is not implemented in GCC versions earlier
3077 than 2.96.
3078
3079 @item hot
3080 @cindex @code{hot} function attribute
3081 The @code{hot} attribute is used to inform the compiler that a function is a
3082 hot spot of the compiled program.  The function is optimized more aggressively
3083 and on many target it is placed into special subsection of the text section so
3084 all hot functions appears close together improving locality.
3085
3086 When profile feedback is available, via @option{-fprofile-use}, hot functions
3087 are automatically detected and this attribute is ignored.
3088
3089 The @code{hot} attribute is not implemented in GCC versions earlier
3090 than 4.3.
3091
3092 @item cold
3093 @cindex @code{cold} function attribute
3094 The @code{cold} attribute is used to inform the compiler that a function is
3095 unlikely executed.  The function is optimized for size rather than speed and on
3096 many targets it is placed into special subsection of the text section so all
3097 cold functions appears close together improving code locality of non-cold parts
3098 of program.  The paths leading to call of cold functions within code are marked
3099 as unlikely by the branch prediction mechanism. It is thus useful to mark
3100 functions used to handle unlikely conditions, such as @code{perror}, as cold to
3101 improve optimization of hot functions that do call marked functions in rare
3102 occasions.
3103
3104 When profile feedback is available, via @option{-fprofile-use}, hot functions
3105 are automatically detected and this attribute is ignored.
3106
3107 The @code{cold} attribute is not implemented in GCC versions earlier than 4.3.
3108
3109 @item regparm (@var{number})
3110 @cindex @code{regparm} attribute
3111 @cindex functions that are passed arguments in registers on the 386
3112 On the Intel 386, the @code{regparm} attribute causes the compiler to
3113 pass arguments number one to @var{number} if they are of integral type
3114 in registers EAX, EDX, and ECX instead of on the stack.  Functions that
3115 take a variable number of arguments will continue to be passed all of their
3116 arguments on the stack.
3117
3118 Beware that on some ELF systems this attribute is unsuitable for
3119 global functions in shared libraries with lazy binding (which is the
3120 default).  Lazy binding will send the first call via resolving code in
3121 the loader, which might assume EAX, EDX and ECX can be clobbered, as
3122 per the standard calling conventions.  Solaris 8 is affected by this.
3123 GNU systems with GLIBC 2.1 or higher, and FreeBSD, are believed to be
3124 safe since the loaders there save EAX, EDX and ECX.  (Lazy binding can be
3125 disabled with the linker or the loader if desired, to avoid the
3126 problem.)
3127
3128 @item sseregparm
3129 @cindex @code{sseregparm} attribute
3130 On the Intel 386 with SSE support, the @code{sseregparm} attribute
3131 causes the compiler to pass up to 3 floating point arguments in
3132 SSE registers instead of on the stack.  Functions that take a
3133 variable number of arguments will continue to pass all of their
3134 floating point arguments on the stack.
3135
3136 @item force_align_arg_pointer
3137 @cindex @code{force_align_arg_pointer} attribute
3138 On the Intel x86, the @code{force_align_arg_pointer} attribute may be
3139 applied to individual function definitions, generating an alternate
3140 prologue and epilogue that realigns the runtime stack if necessary.
3141 This supports mixing legacy codes that run with a 4-byte aligned stack
3142 with modern codes that keep a 16-byte stack for SSE compatibility.
3143
3144 @item resbank
3145 @cindex @code{resbank} attribute
3146 On the SH2A target, this attribute enables the high-speed register
3147 saving and restoration using a register bank for @code{interrupt_handler}
3148 routines.  Saving to the bank is performed automatically after the CPU
3149 accepts an interrupt that uses a register bank.
3150
3151 The nineteen 32-bit registers comprising general register R0 to R14,
3152 control register GBR, and system registers MACH, MACL, and PR and the
3153 vector table address offset are saved into a register bank.  Register
3154 banks are stacked in first-in last-out (FILO) sequence.  Restoration
3155 from the bank is executed by issuing a RESBANK instruction.
3156
3157 @item returns_twice
3158 @cindex @code{returns_twice} attribute
3159 The @code{returns_twice} attribute tells the compiler that a function may
3160 return more than one time.  The compiler will ensure that all registers
3161 are dead before calling such a function and will emit a warning about
3162 the variables that may be clobbered after the second return from the
3163 function.  Examples of such functions are @code{setjmp} and @code{vfork}.
3164 The @code{longjmp}-like counterpart of such function, if any, might need
3165 to be marked with the @code{noreturn} attribute.
3166
3167 @item saveall
3168 @cindex save all registers on the Blackfin, H8/300, H8/300H, and H8S
3169 Use this attribute on the Blackfin, H8/300, H8/300H, and H8S to indicate that
3170 all registers except the stack pointer should be saved in the prologue
3171 regardless of whether they are used or not.
3172
3173 @item save_volatiles
3174 @cindex save volatile registers on the MicroBlaze
3175 Use this attribute on the MicroBlaze to indicate that the function is
3176 an interrupt handler.  All volatile registers (in addition to non-volatile
3177 registers) will be saved in the function prologue.  If the function is a leaf
3178 function, only volatiles used by the function are saved.  A normal function
3179 return is generated instead of a return from interrupt.
3180
3181 @item section ("@var{section-name}")
3182 @cindex @code{section} function attribute
3183 Normally, the compiler places the code it generates in the @code{text} section.
3184 Sometimes, however, you need additional sections, or you need certain
3185 particular functions to appear in special sections.  The @code{section}
3186 attribute specifies that a function lives in a particular section.
3187 For example, the declaration:
3188
3189 @smallexample
3190 extern void foobar (void) __attribute__ ((section ("bar")));
3191 @end smallexample
3192
3193 @noindent
3194 puts the function @code{foobar} in the @code{bar} section.
3195
3196 Some file formats do not support arbitrary sections so the @code{section}
3197 attribute is not available on all platforms.
3198 If you need to map the entire contents of a module to a particular
3199 section, consider using the facilities of the linker instead.
3200
3201 @item sentinel
3202 @cindex @code{sentinel} function attribute
3203 This function attribute ensures that a parameter in a function call is
3204 an explicit @code{NULL}.  The attribute is only valid on variadic
3205 functions.  By default, the sentinel is located at position zero, the
3206 last parameter of the function call.  If an optional integer position
3207 argument P is supplied to the attribute, the sentinel must be located at
3208 position P counting backwards from the end of the argument list.
3209
3210 @smallexample
3211 __attribute__ ((sentinel))
3212 is equivalent to
3213 __attribute__ ((sentinel(0)))
3214 @end smallexample
3215
3216 The attribute is automatically set with a position of 0 for the built-in
3217 functions @code{execl} and @code{execlp}.  The built-in function
3218 @code{execle} has the attribute set with a position of 1.
3219
3220 A valid @code{NULL} in this context is defined as zero with any pointer
3221 type.  If your system defines the @code{NULL} macro with an integer type
3222 then you need to add an explicit cast.  GCC replaces @code{stddef.h}
3223 with a copy that redefines NULL appropriately.
3224
3225 The warnings for missing or incorrect sentinels are enabled with
3226 @option{-Wformat}.
3227
3228 @item short_call
3229 See long_call/short_call.
3230
3231 @item shortcall
3232 See longcall/shortcall.
3233
3234 @item signal
3235 @cindex signal handler functions on the AVR processors
3236 Use this attribute on the AVR to indicate that the specified
3237 function is a signal handler.  The compiler will generate function
3238 entry and exit sequences suitable for use in a signal handler when this
3239 attribute is present.  Interrupts will be disabled inside the function.
3240
3241 @item sp_switch
3242 Use this attribute on the SH to indicate an @code{interrupt_handler}
3243 function should switch to an alternate stack.  It expects a string
3244 argument that names a global variable holding the address of the
3245 alternate stack.
3246
3247 @smallexample
3248 void *alt_stack;
3249 void f () __attribute__ ((interrupt_handler,
3250                           sp_switch ("alt_stack")));
3251 @end smallexample
3252
3253 @item stdcall
3254 @cindex functions that pop the argument stack on the 386
3255 On the Intel 386, the @code{stdcall} attribute causes the compiler to
3256 assume that the called function will pop off the stack space used to
3257 pass arguments, unless it takes a variable number of arguments.
3258
3259 @item syscall_linkage
3260 @cindex @code{syscall_linkage} attribute
3261 This attribute is used to modify the IA64 calling convention by marking
3262 all input registers as live at all function exits.  This makes it possible
3263 to restart a system call after an interrupt without having to save/restore
3264 the input registers.  This also prevents kernel data from leaking into
3265 application code.
3266
3267 @item target
3268 @cindex @code{target} function attribute
3269 The @code{target} attribute is used to specify that a function is to
3270 be compiled with different target options than specified on the
3271 command line.  This can be used for instance to have functions
3272 compiled with a different ISA (instruction set architecture) than the
3273 default.  You can also use the @samp{#pragma GCC target} pragma to set
3274 more than one function to be compiled with specific target options.
3275 @xref{Function Specific Option Pragmas}, for details about the
3276 @samp{#pragma GCC target} pragma.
3277
3278 For instance on a 386, you could compile one function with
3279 @code{target("sse4.1,arch=core2")} and another with
3280 @code{target("sse4a,arch=amdfam10")} that would be equivalent to
3281 compiling the first function with @option{-msse4.1} and
3282 @option{-march=core2} options, and the second function with
3283 @option{-msse4a} and @option{-march=amdfam10} options.  It is up to the
3284 user to make sure that a function is only invoked on a machine that
3285 supports the particular ISA it was compiled for (for example by using
3286 @code{cpuid} on 386 to determine what feature bits and architecture
3287 family are used).
3288
3289 @smallexample
3290 int core2_func (void) __attribute__ ((__target__ ("arch=core2")));
3291 int sse3_func (void) __attribute__ ((__target__ ("sse3")));
3292 @end smallexample
3293
3294 On the 386, the following options are allowed:
3295
3296 @table @samp
3297 @item abm
3298 @itemx no-abm
3299 @cindex @code{target("abm")} attribute
3300 Enable/disable the generation of the advanced bit instructions.
3301
3302 @item aes
3303 @itemx no-aes
3304 @cindex @code{target("aes")} attribute
3305 Enable/disable the generation of the AES instructions.
3306
3307 @item mmx
3308 @itemx no-mmx
3309 @cindex @code{target("mmx")} attribute
3310 Enable/disable the generation of the MMX instructions.
3311
3312 @item pclmul
3313 @itemx no-pclmul
3314 @cindex @code{target("pclmul")} attribute
3315 Enable/disable the generation of the PCLMUL instructions.
3316
3317 @item popcnt
3318 @itemx no-popcnt
3319 @cindex @code{target("popcnt")} attribute
3320 Enable/disable the generation of the POPCNT instruction.
3321
3322 @item sse
3323 @itemx no-sse
3324 @cindex @code{target("sse")} attribute
3325 Enable/disable the generation of the SSE instructions.
3326
3327 @item sse2
3328 @itemx no-sse2
3329 @cindex @code{target("sse2")} attribute
3330 Enable/disable the generation of the SSE2 instructions.
3331
3332 @item sse3
3333 @itemx no-sse3
3334 @cindex @code{target("sse3")} attribute
3335 Enable/disable the generation of the SSE3 instructions.
3336
3337 @item sse4
3338 @itemx no-sse4
3339 @cindex @code{target("sse4")} attribute
3340 Enable/disable the generation of the SSE4 instructions (both SSE4.1
3341 and SSE4.2).
3342
3343 @item sse4.1
3344 @itemx no-sse4.1
3345 @cindex @code{target("sse4.1")} attribute
3346 Enable/disable the generation of the sse4.1 instructions.
3347
3348 @item sse4.2
3349 @itemx no-sse4.2
3350 @cindex @code{target("sse4.2")} attribute
3351 Enable/disable the generation of the sse4.2 instructions.
3352
3353 @item sse4a
3354 @itemx no-sse4a
3355 @cindex @code{target("sse4a")} attribute
3356 Enable/disable the generation of the SSE4A instructions.
3357
3358 @item fma4
3359 @itemx no-fma4
3360 @cindex @code{target("fma4")} attribute
3361 Enable/disable the generation of the FMA4 instructions.
3362
3363 @item xop
3364 @itemx no-xop
3365 @cindex @code{target("xop")} attribute
3366 Enable/disable the generation of the XOP instructions.
3367
3368 @item lwp
3369 @itemx no-lwp
3370 @cindex @code{target("lwp")} attribute
3371 Enable/disable the generation of the LWP instructions.
3372
3373 @item ssse3
3374 @itemx no-ssse3
3375 @cindex @code{target("ssse3")} attribute
3376 Enable/disable the generation of the SSSE3 instructions.
3377
3378 @item cld
3379 @itemx no-cld
3380 @cindex @code{target("cld")} attribute
3381 Enable/disable the generation of the CLD before string moves.
3382
3383 @item fancy-math-387
3384 @itemx no-fancy-math-387
3385 @cindex @code{target("fancy-math-387")} attribute
3386 Enable/disable the generation of the @code{sin}, @code{cos}, and
3387 @code{sqrt} instructions on the 387 floating point unit.
3388
3389 @item fused-madd
3390 @itemx no-fused-madd
3391 @cindex @code{target("fused-madd")} attribute
3392 Enable/disable the generation of the fused multiply/add instructions.
3393
3394 @item ieee-fp
3395 @itemx no-ieee-fp
3396 @cindex @code{target("ieee-fp")} attribute
3397 Enable/disable the generation of floating point that depends on IEEE arithmetic.
3398
3399 @item inline-all-stringops
3400 @itemx no-inline-all-stringops
3401 @cindex @code{target("inline-all-stringops")} attribute
3402 Enable/disable inlining of string operations.
3403
3404 @item inline-stringops-dynamically
3405 @itemx no-inline-stringops-dynamically
3406 @cindex @code{target("inline-stringops-dynamically")} attribute
3407 Enable/disable the generation of the inline code to do small string
3408 operations and calling the library routines for large operations.
3409
3410 @item align-stringops
3411 @itemx no-align-stringops
3412 @cindex @code{target("align-stringops")} attribute
3413 Do/do not align destination of inlined string operations.
3414
3415 @item recip
3416 @itemx no-recip
3417 @cindex @code{target("recip")} attribute
3418 Enable/disable the generation of RCPSS, RCPPS, RSQRTSS and RSQRTPS
3419 instructions followed an additional Newton-Raphson step instead of
3420 doing a floating point division.
3421
3422 @item arch=@var{ARCH}
3423 @cindex @code{target("arch=@var{ARCH}")} attribute
3424 Specify the architecture to generate code for in compiling the function.
3425
3426 @item tune=@var{TUNE}
3427 @cindex @code{target("tune=@var{TUNE}")} attribute
3428 Specify the architecture to tune for in compiling the function.
3429
3430 @item fpmath=@var{FPMATH}
3431 @cindex @code{target("fpmath=@var{FPMATH}")} attribute
3432 Specify which floating point unit to use.  The
3433 @code{target("fpmath=sse,387")} option must be specified as
3434 @code{target("fpmath=sse+387")} because the comma would separate
3435 different options.
3436 @end table
3437
3438 On the PowerPC, the following options are allowed:
3439
3440 @table @samp
3441 @item altivec
3442 @itemx no-altivec
3443 @cindex @code{target("altivec")} attribute
3444 Generate code that uses (does not use) AltiVec instructions.  In
3445 32-bit code, you cannot enable Altivec instructions unless
3446 @option{-mabi=altivec} was used on the command line.
3447
3448 @item cmpb
3449 @itemx no-cmpb
3450 @cindex @code{target("cmpb")} attribute
3451 Generate code that uses (does not use) the compare bytes instruction
3452 implemented on the POWER6 processor and other processors that support
3453 the PowerPC V2.05 architecture.
3454
3455 @item dlmzb
3456 @itemx no-dlmzb
3457 @cindex @code{target("dlmzb")} attribute
3458 Generate code that uses (does not use) the string-search @samp{dlmzb}
3459 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
3460 generated by default when targetting those processors.
3461
3462 @item fprnd
3463 @itemx no-fprnd
3464 @cindex @code{target("fprnd")} attribute
3465 Generate code that uses (does not use) the FP round to integer
3466 instructions implemented on the POWER5+ processor and other processors
3467 that support the PowerPC V2.03 architecture.
3468
3469 @item hard-dfp
3470 @itemx no-hard-dfp
3471 @cindex @code{target("hard-dfp")} attribute
3472 Generate code that uses (does not use) the decimal floating point
3473 instructions implemented on some POWER processors.
3474
3475 @item isel
3476 @itemx no-isel
3477 @cindex @code{target("isel")} attribute
3478 Generate code that uses (does not use) ISEL instruction.
3479
3480 @item mfcrf
3481 @itemx no-mfcrf
3482 @cindex @code{target("mfcrf")} attribute
3483 Generate code that uses (does not use) the move from condition
3484 register field instruction implemented on the POWER4 processor and
3485 other processors that support the PowerPC V2.01 architecture.
3486
3487 @item mfpgpr
3488 @itemx no-mfpgpr
3489 @cindex @code{target("mfpgpr")} attribute
3490 Generate code that uses (does not use) the FP move to/from general
3491 purpose register instructions implemented on the POWER6X processor and
3492 other processors that support the extended PowerPC V2.05 architecture.
3493
3494 @item mulhw
3495 @itemx no-mulhw
3496 @cindex @code{target("mulhw")} attribute
3497 Generate code that uses (does not use) the half-word multiply and
3498 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
3499 These instructions are generated by default when targetting those
3500 processors.
3501
3502 @item multiple
3503 @itemx no-multiple
3504 @cindex @code{target("multiple")} attribute
3505 Generate code that uses (does not use) the load multiple word
3506 instructions and the store multiple word instructions.
3507
3508 @item update
3509 @itemx no-update
3510 @cindex @code{target("update")} attribute
3511 Generate code that uses (does not use) the load or store instructions
3512 that update the base register to the address of the calculated memory
3513 location.
3514
3515 @item popcntb
3516 @itemx no-popcntb
3517 @cindex @code{target("popcntb")} attribute
3518 Generate code that uses (does not use) the popcount and double
3519 precision FP reciprocal estimate instruction implemented on the POWER5
3520 processor and other processors that support the PowerPC V2.02
3521 architecture.
3522
3523 @item popcntd
3524 @itemx no-popcntd
3525 @cindex @code{target("popcntd")} attribute
3526 Generate code that uses (does not use) the popcount instruction
3527 implemented on the POWER7 processor and other processors that support
3528 the PowerPC V2.06 architecture.
3529
3530 @item powerpc-gfxopt
3531 @itemx no-powerpc-gfxopt
3532 @cindex @code{target("powerpc-gfxopt")} attribute
3533 Generate code that uses (does not use) the optional PowerPC
3534 architecture instructions in the Graphics group, including
3535 floating-point select.
3536
3537 @item powerpc-gpopt
3538 @itemx no-powerpc-gpopt
3539 @cindex @code{target("powerpc-gpopt")} attribute
3540 Generate code that uses (does not use) the optional PowerPC
3541 architecture instructions in the General Purpose group, including
3542 floating-point square root.
3543
3544 @item recip-precision
3545 @itemx no-recip-precision
3546 @cindex @code{target("recip-precision")} attribute
3547 Assume (do not assume) that the reciprocal estimate instructions
3548 provide higher precision estimates than is mandated by the powerpc
3549 ABI.
3550
3551 @item string
3552 @itemx no-string
3553 @cindex @code{target("string")} attribute
3554 Generate code that uses (does not use) the load string instructions
3555 and the store string word instructions to save multiple registers and
3556 do small block moves.
3557
3558 @item vsx
3559 @itemx no-vsx
3560 @cindex @code{target("vsx")} attribute
3561 Generate code that uses (does not use) vector/scalar (VSX)
3562 instructions, and also enable the use of built-in functions that allow
3563 more direct access to the VSX instruction set.  In 32-bit code, you
3564 cannot enable VSX or Altivec instructions unless
3565 @option{-mabi=altivec} was used on the command line.
3566
3567 @item friz
3568 @itemx no-friz
3569 @cindex @code{target("friz")} attribute
3570 Generate (do not generate) the @code{friz} instruction when the
3571 @option{-funsafe-math-optimizations} option is used to optimize
3572 rounding a floating point value to 64-bit integer and back to floating
3573 point.  The @code{friz} instruction does not return the same value if
3574 the floating point number is too large to fit in an integer.
3575
3576 @item avoid-indexed-addresses
3577 @itemx no-avoid-indexed-addresses
3578 @cindex @code{target("avoid-indexed-addresses")} attribute
3579 Generate code that tries to avoid (not avoid) the use of indexed load
3580 or store instructions.
3581
3582 @item paired
3583 @itemx no-paired
3584 @cindex @code{target("paired")} attribute
3585 Generate code that uses (does not use) the generation of PAIRED simd
3586 instructions.
3587
3588 @item longcall
3589 @itemx no-longcall
3590 @cindex @code{target("longcall")} attribute
3591 Generate code that assumes (does not assume) that all calls are far
3592 away so that a longer more expensive calling sequence is required.
3593
3594 @item cpu=@var{CPU}
3595 @cindex @code{target("cpu=@var{CPU}")} attribute
3596 Specify the architecture to generate code for when compiling the
3597 function.  If you select the @code{"target("cpu=power7)"} attribute when
3598 generating 32-bit code, VSX and Altivec instructions are not generated
3599 unless you use the @option{-mabi=altivec} option on the command line.
3600
3601 @item tune=@var{TUNE}
3602 @cindex @code{target("tune=@var{TUNE}")} attribute
3603 Specify the architecture to tune for when compiling the function.  If
3604 you do not specify the @code{target("tune=@var{TUNE}")} attribute and
3605 you do specify the @code{target("cpu=@var{CPU}")} attribute,
3606 compilation will tune for the @var{CPU} architecture, and not the
3607 default tuning specified on the command line.
3608 @end table
3609
3610 On the 386/x86_64 and PowerPC backends, you can use either multiple
3611 strings to specify multiple options, or you can separate the option
3612 with a comma (@code{,}).
3613
3614 On the 386/x86_64 and PowerPC backends, the inliner will not inline a
3615 function that has different target options than the caller, unless the
3616 callee has a subset of the target options of the caller.  For example
3617 a function declared with @code{target("sse3")} can inline a function
3618 with @code{target("sse2")}, since @code{-msse3} implies @code{-msse2}.
3619
3620 The @code{target} attribute is not implemented in GCC versions earlier
3621 than 4.4 for the i386/x86_64 and 4.6 for the PowerPC backends.  It is
3622 not currently implemented for other backends.
3623
3624 @item tiny_data
3625 @cindex tiny data section on the H8/300H and H8S
3626 Use this attribute on the H8/300H and H8S to indicate that the specified
3627 variable should be placed into the tiny data section.
3628 The compiler will generate more efficient code for loads and stores
3629 on data in the tiny data section.  Note the tiny data area is limited to
3630 slightly under 32kbytes of data.
3631
3632 @item trap_exit
3633 Use this attribute on the SH for an @code{interrupt_handler} to return using
3634 @code{trapa} instead of @code{rte}.  This attribute expects an integer
3635 argument specifying the trap number to be used.
3636
3637 @item unused
3638 @cindex @code{unused} attribute.
3639 This attribute, attached to a function, means that the function is meant
3640 to be possibly unused.  GCC will not produce a warning for this
3641 function.
3642
3643 @item used
3644 @cindex @code{used} attribute.
3645 This attribute, attached to a function, means that code must be emitted
3646 for the function even if it appears that the function is not referenced.
3647 This is useful, for example, when the function is referenced only in
3648 inline assembly.
3649
3650 @item version_id
3651 @cindex @code{version_id} attribute
3652 This IA64 HP-UX attribute, attached to a global variable or function, renames a
3653 symbol to contain a version string, thus allowing for function level
3654 versioning.  HP-UX system header files may use version level functioning
3655 for some system calls.
3656
3657 @smallexample
3658 extern int foo () __attribute__((version_id ("20040821")));
3659 @end smallexample
3660
3661 Calls to @var{foo} will be mapped to calls to @var{foo@{20040821@}}.
3662
3663 @item visibility ("@var{visibility_type}")
3664 @cindex @code{visibility} attribute
3665 This attribute affects the linkage of the declaration to which it is attached.
3666 There are four supported @var{visibility_type} values: default,
3667 hidden, protected or internal visibility.
3668
3669 @smallexample
3670 void __attribute__ ((visibility ("protected")))
3671 f () @{ /* @r{Do something.} */; @}
3672 int i __attribute__ ((visibility ("hidden")));
3673 @end smallexample
3674
3675 The possible values of @var{visibility_type} correspond to the
3676 visibility settings in the ELF gABI.
3677
3678 @table @dfn
3679 @c keep this list of visibilities in alphabetical order.
3680
3681 @item default
3682 Default visibility is the normal case for the object file format.
3683 This value is available for the visibility attribute to override other
3684 options that may change the assumed visibility of entities.
3685
3686 On ELF, default visibility means that the declaration is visible to other
3687 modules and, in shared libraries, means that the declared entity may be
3688 overridden.
3689
3690 On Darwin, default visibility means that the declaration is visible to
3691 other modules.
3692
3693 Default visibility corresponds to ``external linkage'' in the language.
3694
3695 @item hidden
3696 Hidden visibility indicates that the entity declared will have a new
3697 form of linkage, which we'll call ``hidden linkage''.  Two
3698 declarations of an object with hidden linkage refer to the same object
3699 if they are in the same shared object.
3700
3701 @item internal
3702 Internal visibility is like hidden visibility, but with additional
3703 processor specific semantics.  Unless otherwise specified by the
3704 psABI, GCC defines internal visibility to mean that a function is
3705 @emph{never} called from another module.  Compare this with hidden
3706 functions which, while they cannot be referenced directly by other
3707 modules, can be referenced indirectly via function pointers.  By
3708 indicating that a function cannot be called from outside the module,
3709 GCC may for instance omit the load of a PIC register since it is known
3710 that the calling function loaded the correct value.
3711
3712 @item protected
3713 Protected visibility is like default visibility except that it
3714 indicates that references within the defining module will bind to the
3715 definition in that module.  That is, the declared entity cannot be
3716 overridden by another module.
3717
3718 @end table
3719
3720 All visibilities are supported on many, but not all, ELF targets
3721 (supported when the assembler supports the @samp{.visibility}
3722 pseudo-op).  Default visibility is supported everywhere.  Hidden
3723 visibility is supported on Darwin targets.
3724
3725 The visibility attribute should be applied only to declarations which
3726 would otherwise have external linkage.  The attribute should be applied
3727 consistently, so that the same entity should not be declared with
3728 different settings of the attribute.
3729
3730 In C++, the visibility attribute applies to types as well as functions
3731 and objects, because in C++ types have linkage.  A class must not have
3732 greater visibility than its non-static data member types and bases,
3733 and class members default to the visibility of their class.  Also, a
3734 declaration without explicit visibility is limited to the visibility
3735 of its type.
3736
3737 In C++, you can mark member functions and static member variables of a
3738 class with the visibility attribute.  This is useful if you know a
3739 particular method or static member variable should only be used from
3740 one shared object; then you can mark it hidden while the rest of the
3741 class has default visibility.  Care must be taken to avoid breaking
3742 the One Definition Rule; for example, it is usually not useful to mark
3743 an inline method as hidden without marking the whole class as hidden.
3744
3745 A C++ namespace declaration can also have the visibility attribute.
3746 This attribute applies only to the particular namespace body, not to
3747 other definitions of the same namespace; it is equivalent to using
3748 @samp{#pragma GCC visibility} before and after the namespace
3749 definition (@pxref{Visibility Pragmas}).
3750
3751 In C++, if a template argument has limited visibility, this
3752 restriction is implicitly propagated to the template instantiation.
3753 Otherwise, template instantiations and specializations default to the
3754 visibility of their template.
3755
3756 If both the template and enclosing class have explicit visibility, the
3757 visibility from the template is used.
3758
3759 @item vliw
3760 @cindex @code{vliw} attribute
3761 On MeP, the @code{vliw} attribute tells the compiler to emit
3762 instructions in VLIW mode instead of core mode.  Note that this
3763 attribute is not allowed unless a VLIW coprocessor has been configured
3764 and enabled through command line options.
3765
3766 @item warn_unused_result
3767 @cindex @code{warn_unused_result} attribute
3768 The @code{warn_unused_result} attribute causes a warning to be emitted
3769 if a caller of the function with this attribute does not use its
3770 return value.  This is useful for functions where not checking
3771 the result is either a security problem or always a bug, such as
3772 @code{realloc}.
3773
3774 @smallexample
3775 int fn () __attribute__ ((warn_unused_result));
3776 int foo ()
3777 @{
3778   if (fn () < 0) return -1;
3779   fn ();
3780   return 0;
3781 @}
3782 @end smallexample
3783
3784 results in warning on line 5.
3785
3786 @item weak
3787 @cindex @code{weak} attribute
3788 The @code{weak} attribute causes the declaration to be emitted as a weak
3789 symbol rather than a global.  This is primarily useful in defining
3790 library functions which can be overridden in user code, though it can
3791 also be used with non-function declarations.  Weak symbols are supported
3792 for ELF targets, and also for a.out targets when using the GNU assembler
3793 and linker.
3794
3795 @item weakref
3796 @itemx weakref ("@var{target}")
3797 @cindex @code{weakref} attribute
3798 The @code{weakref} attribute marks a declaration as a weak reference.
3799 Without arguments, it should be accompanied by an @code{alias} attribute
3800 naming the target symbol.  Optionally, the @var{target} may be given as
3801 an argument to @code{weakref} itself.  In either case, @code{weakref}
3802 implicitly marks the declaration as @code{weak}.  Without a
3803 @var{target}, given as an argument to @code{weakref} or to @code{alias},
3804 @code{weakref} is equivalent to @code{weak}.
3805
3806 @smallexample
3807 static int x() __attribute__ ((weakref ("y")));
3808 /* is equivalent to... */
3809 static int x() __attribute__ ((weak, weakref, alias ("y")));
3810 /* and to... */
3811 static int x() __attribute__ ((weakref));
3812 static int x() __attribute__ ((alias ("y")));
3813 @end smallexample
3814
3815 A weak reference is an alias that does not by itself require a
3816 definition to be given for the target symbol.  If the target symbol is
3817 only referenced through weak references, then it becomes a @code{weak}
3818 undefined symbol.  If it is directly referenced, however, then such
3819 strong references prevail, and a definition will be required for the
3820 symbol, not necessarily in the same translation unit.
3821
3822 The effect is equivalent to moving all references to the alias to a
3823 separate translation unit, renaming the alias to the aliased symbol,
3824 declaring it as weak, compiling the two separate translation units and
3825 performing a reloadable link on them.
3826
3827 At present, a declaration to which @code{weakref} is attached can
3828 only be @code{static}.
3829
3830 @end table
3831
3832 You can specify multiple attributes in a declaration by separating them
3833 by commas within the double parentheses or by immediately following an
3834 attribute declaration with another attribute declaration.
3835
3836 @cindex @code{#pragma}, reason for not using
3837 @cindex pragma, reason for not using
3838 Some people object to the @code{__attribute__} feature, suggesting that
3839 ISO C's @code{#pragma} should be used instead.  At the time
3840 @code{__attribute__} was designed, there were two reasons for not doing
3841 this.
3842
3843 @enumerate
3844 @item
3845 It is impossible to generate @code{#pragma} commands from a macro.
3846
3847 @item
3848 There is no telling what the same @code{#pragma} might mean in another
3849 compiler.
3850 @end enumerate
3851
3852 These two reasons applied to almost any application that might have been
3853 proposed for @code{#pragma}.  It was basically a mistake to use
3854 @code{#pragma} for @emph{anything}.
3855
3856 The ISO C99 standard includes @code{_Pragma}, which now allows pragmas
3857 to be generated from macros.  In addition, a @code{#pragma GCC}
3858 namespace is now in use for GCC-specific pragmas.  However, it has been
3859 found convenient to use @code{__attribute__} to achieve a natural
3860 attachment of attributes to their corresponding declarations, whereas
3861 @code{#pragma GCC} is of use for constructs that do not naturally form
3862 part of the grammar.  @xref{Other Directives,,Miscellaneous
3863 Preprocessing Directives, cpp, The GNU C Preprocessor}.
3864
3865 @node Attribute Syntax
3866 @section Attribute Syntax
3867 @cindex attribute syntax
3868
3869 This section describes the syntax with which @code{__attribute__} may be
3870 used, and the constructs to which attribute specifiers bind, for the C
3871 language.  Some details may vary for C++ and Objective-C@.  Because of
3872 infelicities in the grammar for attributes, some forms described here
3873 may not be successfully parsed in all cases.
3874
3875 There are some problems with the semantics of attributes in C++.  For
3876 example, there are no manglings for attributes, although they may affect
3877 code generation, so problems may arise when attributed types are used in
3878 conjunction with templates or overloading.  Similarly, @code{typeid}
3879 does not distinguish between types with different attributes.  Support
3880 for attributes in C++ may be restricted in future to attributes on
3881 declarations only, but not on nested declarators.
3882
3883 @xref{Function Attributes}, for details of the semantics of attributes
3884 applying to functions.  @xref{Variable Attributes}, for details of the
3885 semantics of attributes applying to variables.  @xref{Type Attributes},
3886 for details of the semantics of attributes applying to structure, union
3887 and enumerated types.
3888
3889 An @dfn{attribute specifier} is of the form
3890 @code{__attribute__ ((@var{attribute-list}))}.  An @dfn{attribute list}
3891 is a possibly empty comma-separated sequence of @dfn{attributes}, where
3892 each attribute is one of the following:
3893
3894 @itemize @bullet
3895 @item
3896 Empty.  Empty attributes are ignored.
3897
3898 @item
3899 A word (which may be an identifier such as @code{unused}, or a reserved
3900 word such as @code{const}).
3901
3902 @item
3903 A word, followed by, in parentheses, parameters for the attribute.
3904 These parameters take one of the following forms:
3905
3906 @itemize @bullet
3907 @item
3908 An identifier.  For example, @code{mode} attributes use this form.
3909
3910 @item
3911 An identifier followed by a comma and a non-empty comma-separated list
3912 of expressions.  For example, @code{format} attributes use this form.
3913
3914 @item
3915 A possibly empty comma-separated list of expressions.  For example,
3916 @code{format_arg} attributes use this form with the list being a single
3917 integer constant expression, and @code{alias} attributes use this form
3918 with the list being a single string constant.
3919 @end itemize
3920 @end itemize
3921
3922 An @dfn{attribute specifier list} is a sequence of one or more attribute
3923 specifiers, not separated by any other tokens.
3924
3925 In GNU C, an attribute specifier list may appear after the colon following a
3926 label, other than a @code{case} or @code{default} label.  The only
3927 attribute it makes sense to use after a label is @code{unused}.  This
3928 feature is intended for code generated by programs which contains labels
3929 that may be unused but which is compiled with @option{-Wall}.  It would
3930 not normally be appropriate to use in it human-written code, though it
3931 could be useful in cases where the code that jumps to the label is
3932 contained within an @code{#ifdef} conditional.  GNU C++ only permits
3933 attributes on labels if the attribute specifier is immediately
3934 followed by a semicolon (i.e., the label applies to an empty
3935 statement).  If the semicolon is missing, C++ label attributes are
3936 ambiguous, as it is permissible for a declaration, which could begin
3937 with an attribute list, to be labelled in C++.  Declarations cannot be
3938 labelled in C90 or C99, so the ambiguity does not arise there.
3939
3940 An attribute specifier list may appear as part of a @code{struct},
3941 @code{union} or @code{enum} specifier.  It may go either immediately
3942 after the @code{struct}, @code{union} or @code{enum} keyword, or after
3943 the closing brace.  The former syntax is preferred.
3944 Where attribute specifiers follow the closing brace, they are considered
3945 to relate to the structure, union or enumerated type defined, not to any
3946 enclosing declaration the type specifier appears in, and the type
3947 defined is not complete until after the attribute specifiers.
3948 @c Otherwise, there would be the following problems: a shift/reduce
3949 @c conflict between attributes binding the struct/union/enum and
3950 @c binding to the list of specifiers/qualifiers; and "aligned"
3951 @c attributes could use sizeof for the structure, but the size could be
3952 @c changed later by "packed" attributes.
3953
3954 Otherwise, an attribute specifier appears as part of a declaration,
3955 counting declarations of unnamed parameters and type names, and relates
3956 to that declaration (which may be nested in another declaration, for
3957 example in the case of a parameter declaration), or to a particular declarator
3958 within a declaration.  Where an
3959 attribute specifier is applied to a parameter declared as a function or
3960 an array, it should apply to the function or array rather than the
3961 pointer to which the parameter is implicitly converted, but this is not
3962 yet correctly implemented.
3963
3964 Any list of specifiers and qualifiers at the start of a declaration may
3965 contain attribute specifiers, whether or not such a list may in that
3966 context contain storage class specifiers.  (Some attributes, however,
3967 are essentially in the nature of storage class specifiers, and only make
3968 sense where storage class specifiers may be used; for example,
3969 @code{section}.)  There is one necessary limitation to this syntax: the
3970 first old-style parameter declaration in a function definition cannot
3971 begin with an attribute specifier, because such an attribute applies to
3972 the function instead by syntax described below (which, however, is not
3973 yet implemented in this case).  In some other cases, attribute
3974 specifiers are permitted by this grammar but not yet supported by the
3975 compiler.  All attribute specifiers in this place relate to the
3976 declaration as a whole.  In the obsolescent usage where a type of
3977 @code{int} is implied by the absence of type specifiers, such a list of
3978 specifiers and qualifiers may be an attribute specifier list with no
3979 other specifiers or qualifiers.
3980
3981 At present, the first parameter in a function prototype must have some
3982 type specifier which is not an attribute specifier; this resolves an
3983 ambiguity in the interpretation of @code{void f(int
3984 (__attribute__((foo)) x))}, but is subject to change.  At present, if
3985 the parentheses of a function declarator contain only attributes then
3986 those attributes are ignored, rather than yielding an error or warning
3987 or implying a single parameter of type int, but this is subject to
3988 change.
3989
3990 An attribute specifier list may appear immediately before a declarator
3991 (other than the first) in a comma-separated list of declarators in a
3992 declaration of more than one identifier using a single list of
3993 specifiers and qualifiers.  Such attribute specifiers apply
3994 only to the identifier before whose declarator they appear.  For
3995 example, in
3996
3997 @smallexample
3998 __attribute__((noreturn)) void d0 (void),
3999     __attribute__((format(printf, 1, 2))) d1 (const char *, ...),
4000      d2 (void)
4001 @end smallexample
4002
4003 @noindent
4004 the @code{noreturn} attribute applies to all the functions
4005 declared; the @code{format} attribute only applies to @code{d1}.
4006
4007 An attribute specifier list may appear immediately before the comma,
4008 @code{=} or semicolon terminating the declaration of an identifier other
4009 than a function definition.  Such attribute specifiers apply
4010 to the declared object or function.  Where an
4011 assembler name for an object or function is specified (@pxref{Asm
4012 Labels}), the attribute must follow the @code{asm}
4013 specification.
4014
4015 An attribute specifier list may, in future, be permitted to appear after
4016 the declarator in a function definition (before any old-style parameter
4017 declarations or the function body).
4018
4019 Attribute specifiers may be mixed with type qualifiers appearing inside
4020 the @code{[]} of a parameter array declarator, in the C99 construct by
4021 which such qualifiers are applied to the pointer to which the array is
4022 implicitly converted.  Such attribute specifiers apply to the pointer,
4023 not to the array, but at present this is not implemented and they are
4024 ignored.
4025
4026 An attribute specifier list may appear at the start of a nested
4027 declarator.  At present, there are some limitations in this usage: the
4028 attributes correctly apply to the declarator, but for most individual
4029 attributes the semantics this implies are not implemented.
4030 When attribute specifiers follow the @code{*} of a pointer
4031 declarator, they may be mixed with any type qualifiers present.
4032 The following describes the formal semantics of this syntax.  It will make the
4033 most sense if you are familiar with the formal specification of
4034 declarators in the ISO C standard.
4035
4036 Consider (as in C99 subclause 6.7.5 paragraph 4) a declaration @code{T
4037 D1}, where @code{T} contains declaration specifiers that specify a type
4038 @var{Type} (such as @code{int}) and @code{D1} is a declarator that
4039 contains an identifier @var{ident}.  The type specified for @var{ident}
4040 for derived declarators whose type does not include an attribute
4041 specifier is as in the ISO C standard.
4042
4043 If @code{D1} has the form @code{( @var{attribute-specifier-list} D )},
4044 and the declaration @code{T D} specifies the type
4045 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
4046 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
4047 @var{attribute-specifier-list} @var{Type}'' for @var{ident}.
4048
4049 If @code{D1} has the form @code{*
4050 @var{type-qualifier-and-attribute-specifier-list} D}, and the
4051 declaration @code{T D} specifies the type
4052 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
4053 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
4054 @var{type-qualifier-and-attribute-specifier-list} pointer to @var{Type}'' for
4055 @var{ident}.
4056
4057 For example,
4058
4059 @smallexample
4060 void (__attribute__((noreturn)) ****f) (void);
4061 @end smallexample
4062
4063 @noindent
4064 specifies the type ``pointer to pointer to pointer to pointer to
4065 non-returning function returning @code{void}''.  As another example,
4066
4067 @smallexample
4068 char *__attribute__((aligned(8))) *f;
4069 @end smallexample
4070
4071 @noindent
4072 specifies the type ``pointer to 8-byte-aligned pointer to @code{char}''.
4073 Note again that this does not work with most attributes; for example,
4074 the usage of @samp{aligned} and @samp{noreturn} attributes given above
4075 is not yet supported.
4076
4077 For compatibility with existing code written for compiler versions that
4078 did not implement attributes on nested declarators, some laxity is
4079 allowed in the placing of attributes.  If an attribute that only applies
4080 to types is applied to a declaration, it will be treated as applying to
4081 the type of that declaration.  If an attribute that only applies to
4082 declarations is applied to the type of a declaration, it will be treated
4083 as applying to that declaration; and, for compatibility with code
4084 placing the attributes immediately before the identifier declared, such
4085 an attribute applied to a function return type will be treated as
4086 applying to the function type, and such an attribute applied to an array
4087 element type will be treated as applying to the array type.  If an
4088 attribute that only applies to function types is applied to a
4089 pointer-to-function type, it will be treated as applying to the pointer
4090 target type; if such an attribute is applied to a function return type
4091 that is not a pointer-to-function type, it will be treated as applying
4092 to the function type.
4093
4094 @node Function Prototypes
4095 @section Prototypes and Old-Style Function Definitions
4096 @cindex function prototype declarations
4097 @cindex old-style function definitions
4098 @cindex promotion of formal parameters
4099
4100 GNU C extends ISO C to allow a function prototype to override a later
4101 old-style non-prototype definition.  Consider the following example:
4102
4103 @smallexample
4104 /* @r{Use prototypes unless the compiler is old-fashioned.}  */
4105 #ifdef __STDC__
4106 #define P(x) x
4107 #else
4108 #define P(x) ()
4109 #endif
4110
4111 /* @r{Prototype function declaration.}  */
4112 int isroot P((uid_t));
4113
4114 /* @r{Old-style function definition.}  */
4115 int
4116 isroot (x)   /* @r{??? lossage here ???} */
4117      uid_t x;
4118 @{
4119   return x == 0;
4120 @}
4121 @end smallexample
4122
4123 Suppose the type @code{uid_t} happens to be @code{short}.  ISO C does
4124 not allow this example, because subword arguments in old-style
4125 non-prototype definitions are promoted.  Therefore in this example the
4126 function definition's argument is really an @code{int}, which does not
4127 match the prototype argument type of @code{short}.
4128
4129 This restriction of ISO C makes it hard to write code that is portable
4130 to traditional C compilers, because the programmer does not know
4131 whether the @code{uid_t} type is @code{short}, @code{int}, or
4132 @code{long}.  Therefore, in cases like these GNU C allows a prototype
4133 to override a later old-style definition.  More precisely, in GNU C, a
4134 function prototype argument type overrides the argument type specified
4135 by a later old-style definition if the former type is the same as the
4136 latter type before promotion.  Thus in GNU C the above example is
4137 equivalent to the following:
4138
4139 @smallexample
4140 int isroot (uid_t);
4141
4142 int
4143 isroot (uid_t x)
4144 @{
4145   return x == 0;
4146 @}
4147 @end smallexample
4148
4149 @noindent
4150 GNU C++ does not support old-style function definitions, so this
4151 extension is irrelevant.
4152
4153 @node C++ Comments
4154 @section C++ Style Comments
4155 @cindex @code{//}
4156 @cindex C++ comments
4157 @cindex comments, C++ style
4158
4159 In GNU C, you may use C++ style comments, which start with @samp{//} and
4160 continue until the end of the line.  Many other C implementations allow
4161 such comments, and they are included in the 1999 C standard.  However,
4162 C++ style comments are not recognized if you specify an @option{-std}
4163 option specifying a version of ISO C before C99, or @option{-ansi}
4164 (equivalent to @option{-std=c90}).
4165
4166 @node Dollar Signs
4167 @section Dollar Signs in Identifier Names
4168 @cindex $
4169 @cindex dollar signs in identifier names
4170 @cindex identifier names, dollar signs in
4171
4172 In GNU C, you may normally use dollar signs in identifier names.
4173 This is because many traditional C implementations allow such identifiers.
4174 However, dollar signs in identifiers are not supported on a few target
4175 machines, typically because the target assembler does not allow them.
4176
4177 @node Character Escapes
4178 @section The Character @key{ESC} in Constants
4179
4180 You can use the sequence @samp{\e} in a string or character constant to
4181 stand for the ASCII character @key{ESC}.
4182
4183 @node Variable Attributes
4184 @section Specifying Attributes of Variables
4185 @cindex attribute of variables
4186 @cindex variable attributes
4187
4188 The keyword @code{__attribute__} allows you to specify special
4189 attributes of variables or structure fields.  This keyword is followed
4190 by an attribute specification inside double parentheses.  Some
4191 attributes are currently defined generically for variables.
4192 Other attributes are defined for variables on particular target
4193 systems.  Other attributes are available for functions
4194 (@pxref{Function Attributes}) and for types (@pxref{Type Attributes}).
4195 Other front ends might define more attributes
4196 (@pxref{C++ Extensions,,Extensions to the C++ Language}).
4197
4198 You may also specify attributes with @samp{__} preceding and following
4199 each keyword.  This allows you to use them in header files without
4200 being concerned about a possible macro of the same name.  For example,
4201 you may use @code{__aligned__} instead of @code{aligned}.
4202
4203 @xref{Attribute Syntax}, for details of the exact syntax for using
4204 attributes.
4205
4206 @table @code
4207 @cindex @code{aligned} attribute
4208 @item aligned (@var{alignment})
4209 This attribute specifies a minimum alignment for the variable or
4210 structure field, measured in bytes.  For example, the declaration:
4211
4212 @smallexample
4213 int x __attribute__ ((aligned (16))) = 0;
4214 @end smallexample
4215
4216 @noindent
4217 causes the compiler to allocate the global variable @code{x} on a
4218 16-byte boundary.  On a 68040, this could be used in conjunction with
4219 an @code{asm} expression to access the @code{move16} instruction which
4220 requires 16-byte aligned operands.
4221
4222 You can also specify the alignment of structure fields.  For example, to
4223 create a double-word aligned @code{int} pair, you could write:
4224
4225 @smallexample
4226 struct foo @{ int x[2] __attribute__ ((aligned (8))); @};
4227 @end smallexample
4228
4229 @noindent
4230 This is an alternative to creating a union with a @code{double} member
4231 that forces the union to be double-word aligned.
4232
4233 As in the preceding examples, you can explicitly specify the alignment
4234 (in bytes) that you wish the compiler to use for a given variable or
4235 structure field.  Alternatively, you can leave out the alignment factor
4236 and just ask the compiler to align a variable or field to the
4237 default alignment for the target architecture you are compiling for.
4238 The default alignment is sufficient for all scalar types, but may not be
4239 enough for all vector types on a target which supports vector operations.
4240 The default alignment is fixed for a particular target ABI.
4241
4242 Gcc also provides a target specific macro @code{__BIGGEST_ALIGNMENT__},
4243 which is the largest alignment ever used for any data type on the
4244 target machine you are compiling for.  For example, you could write:
4245
4246 @smallexample
4247 short array[3] __attribute__ ((aligned (__BIGGEST_ALIGNMENT__)));
4248 @end smallexample
4249
4250 The compiler automatically sets the alignment for the declared
4251 variable or field to @code{__BIGGEST_ALIGNMENT__}.  Doing this can
4252 often make copy operations more efficient, because the compiler can
4253 use whatever instructions copy the biggest chunks of memory when
4254 performing copies to or from the variables or fields that you have
4255 aligned this way.  Note that the value of @code{__BIGGEST_ALIGNMENT__}
4256 may change depending on command line options.
4257
4258 When used on a struct, or struct member, the @code{aligned} attribute can
4259 only increase the alignment; in order to decrease it, the @code{packed}
4260 attribute must be specified as well.  When used as part of a typedef, the
4261 @code{aligned} attribute can both increase and decrease alignment, and
4262 specifying the @code{packed} attribute will generate a warning.
4263
4264 Note that the effectiveness of @code{aligned} attributes may be limited
4265 by inherent limitations in your linker.  On many systems, the linker is
4266 only able to arrange for variables to be aligned up to a certain maximum
4267 alignment.  (For some linkers, the maximum supported alignment may
4268 be very very small.)  If your linker is only able to align variables
4269 up to a maximum of 8 byte alignment, then specifying @code{aligned(16)}
4270 in an @code{__attribute__} will still only provide you with 8 byte
4271 alignment.  See your linker documentation for further information.
4272
4273 The @code{aligned} attribute can also be used for functions
4274 (@pxref{Function Attributes}.)
4275
4276 @item cleanup (@var{cleanup_function})
4277 @cindex @code{cleanup} attribute
4278 The @code{cleanup} attribute runs a function when the variable goes
4279 out of scope.  This attribute can only be applied to auto function
4280 scope variables; it may not be applied to parameters or variables
4281 with static storage duration.  The function must take one parameter,
4282 a pointer to a type compatible with the variable.  The return value
4283 of the function (if any) is ignored.
4284
4285 If @option{-fexceptions} is enabled, then @var{cleanup_function}
4286 will be run during the stack unwinding that happens during the
4287 processing of the exception.  Note that the @code{cleanup} attribute
4288 does not allow the exception to be caught, only to perform an action.
4289 It is undefined what happens if @var{cleanup_function} does not
4290 return normally.
4291
4292 @item common
4293 @itemx nocommon
4294 @cindex @code{common} attribute
4295 @cindex @code{nocommon} attribute
4296 @opindex fcommon
4297 @opindex fno-common
4298 The @code{common} attribute requests GCC to place a variable in
4299 ``common'' storage.  The @code{nocommon} attribute requests the
4300 opposite---to allocate space for it directly.
4301
4302 These attributes override the default chosen by the
4303 @option{-fno-common} and @option{-fcommon} flags respectively.
4304
4305 @item deprecated
4306 @itemx deprecated (@var{msg})
4307 @cindex @code{deprecated} attribute
4308 The @code{deprecated} attribute results in a warning if the variable
4309 is used anywhere in the source file.  This is useful when identifying
4310 variables that are expected to be removed in a future version of a
4311 program.  The warning also includes the location of the declaration
4312 of the deprecated variable, to enable users to easily find further
4313 information about why the variable is deprecated, or what they should
4314 do instead.  Note that the warning only occurs for uses:
4315
4316 @smallexample
4317 extern int old_var __attribute__ ((deprecated));
4318 extern int old_var;
4319 int new_fn () @{ return old_var; @}
4320 @end smallexample
4321
4322 results in a warning on line 3 but not line 2.  The optional msg
4323 argument, which must be a string, will be printed in the warning if
4324 present.
4325
4326 The @code{deprecated} attribute can also be used for functions and
4327 types (@pxref{Function Attributes}, @pxref{Type Attributes}.)
4328
4329 @item mode (@var{mode})
4330 @cindex @code{mode} attribute
4331 This attribute specifies the data type for the declaration---whichever
4332 type corresponds to the mode @var{mode}.  This in effect lets you
4333 request an integer or floating point type according to its width.
4334
4335 You may also specify a mode of @samp{byte} or @samp{__byte__} to
4336 indicate the mode corresponding to a one-byte integer, @samp{word} or
4337 @samp{__word__} for the mode of a one-word integer, and @samp{pointer}
4338 or @samp{__pointer__} for the mode used to represent pointers.
4339
4340 @item packed
4341 @cindex @code{packed} attribute
4342 The @code{packed} attribute specifies that a variable or structure field
4343 should have the smallest possible alignment---one byte for a variable,
4344 and one bit for a field, unless you specify a larger value with the
4345 @code{aligned} attribute.
4346
4347 Here is a structure in which the field @code{x} is packed, so that it
4348 immediately follows @code{a}:
4349
4350 @smallexample
4351 struct foo
4352 @{
4353   char a;
4354   int x[2] __attribute__ ((packed));
4355 @};
4356 @end smallexample
4357
4358 @emph{Note:} The 4.1, 4.2 and 4.3 series of GCC ignore the
4359 @code{packed} attribute on bit-fields of type @code{char}.  This has
4360 been fixed in GCC 4.4 but the change can lead to differences in the
4361 structure layout.  See the documentation of
4362 @option{-Wpacked-bitfield-compat} for more information.
4363
4364 @item section ("@var{section-name}")
4365 @cindex @code{section} variable attribute
4366 Normally, the compiler places the objects it generates in sections like
4367 @code{data} and @code{bss}.  Sometimes, however, you need additional sections,
4368 or you need certain particular variables to appear in special sections,
4369 for example to map to special hardware.  The @code{section}
4370 attribute specifies that a variable (or function) lives in a particular
4371 section.  For example, this small program uses several specific section names:
4372
4373 @smallexample
4374 struct duart a __attribute__ ((section ("DUART_A"))) = @{ 0 @};
4375 struct duart b __attribute__ ((section ("DUART_B"))) = @{ 0 @};
4376 char stack[10000] __attribute__ ((section ("STACK"))) = @{ 0 @};
4377 int init_data __attribute__ ((section ("INITDATA")));
4378
4379 main()
4380 @{
4381   /* @r{Initialize stack pointer} */
4382   init_sp (stack + sizeof (stack));
4383
4384   /* @r{Initialize initialized data} */
4385   memcpy (&init_data, &data, &edata - &data);
4386
4387   /* @r{Turn on the serial ports} */
4388   init_duart (&a);
4389   init_duart (&b);
4390 @}
4391 @end smallexample
4392
4393 @noindent
4394 Use the @code{section} attribute with
4395 @emph{global} variables and not @emph{local} variables,
4396 as shown in the example.
4397
4398 You may use the @code{section} attribute with initialized or
4399 uninitialized global variables but the linker requires
4400 each object be defined once, with the exception that uninitialized
4401 variables tentatively go in the @code{common} (or @code{bss}) section
4402 and can be multiply ``defined''.  Using the @code{section} attribute
4403 will change what section the variable goes into and may cause the
4404 linker to issue an error if an uninitialized variable has multiple
4405 definitions.  You can force a variable to be initialized with the
4406 @option{-fno-common} flag or the @code{nocommon} attribute.
4407
4408 Some file formats do not support arbitrary sections so the @code{section}
4409 attribute is not available on all platforms.
4410 If you need to map the entire contents of a module to a particular
4411 section, consider using the facilities of the linker instead.
4412
4413 @item shared
4414 @cindex @code{shared} variable attribute
4415 On Microsoft Windows, in addition to putting variable definitions in a named
4416 section, the section can also be shared among all running copies of an
4417 executable or DLL@.  For example, this small program defines shared data
4418 by putting it in a named section @code{shared} and marking the section
4419 shareable:
4420
4421 @smallexample
4422 int foo __attribute__((section ("shared"), shared)) = 0;
4423
4424 int
4425 main()
4426 @{
4427   /* @r{Read and write foo.  All running
4428      copies see the same value.}  */
4429   return 0;
4430 @}
4431 @end smallexample
4432
4433 @noindent
4434 You may only use the @code{shared} attribute along with @code{section}
4435 attribute with a fully initialized global definition because of the way
4436 linkers work.  See @code{section} attribute for more information.
4437
4438 The @code{shared} attribute is only available on Microsoft Windows@.
4439
4440 @item tls_model ("@var{tls_model}")
4441 @cindex @code{tls_model} attribute
4442 The @code{tls_model} attribute sets thread-local storage model
4443 (@pxref{Thread-Local}) of a particular @code{__thread} variable,
4444 overriding @option{-ftls-model=} command-line switch on a per-variable
4445 basis.
4446 The @var{tls_model} argument should be one of @code{global-dynamic},
4447 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
4448
4449 Not all targets support this attribute.
4450
4451 @item unused
4452 This attribute, attached to a variable, means that the variable is meant
4453 to be possibly unused.  GCC will not produce a warning for this
4454 variable.
4455
4456 @item used
4457 This attribute, attached to a variable, means that the variable must be
4458 emitted even if it appears that the variable is not referenced.
4459
4460 @item vector_size (@var{bytes})
4461 This attribute specifies the vector size for the variable, measured in
4462 bytes.  For example, the declaration:
4463
4464 @smallexample
4465 int foo __attribute__ ((vector_size (16)));
4466 @end smallexample
4467
4468 @noindent
4469 causes the compiler to set the mode for @code{foo}, to be 16 bytes,
4470 divided into @code{int} sized units.  Assuming a 32-bit int (a vector of
4471 4 units of 4 bytes), the corresponding mode of @code{foo} will be V4SI@.
4472
4473 This attribute is only applicable to integral and float scalars,
4474 although arrays, pointers, and function return values are allowed in
4475 conjunction with this construct.
4476
4477 Aggregates with this attribute are invalid, even if they are of the same
4478 size as a corresponding scalar.  For example, the declaration:
4479
4480 @smallexample
4481 struct S @{ int a; @};
4482 struct S  __attribute__ ((vector_size (16))) foo;
4483 @end smallexample
4484
4485 @noindent
4486 is invalid even if the size of the structure is the same as the size of
4487 the @code{int}.
4488
4489 @item selectany
4490 The @code{selectany} attribute causes an initialized global variable to
4491 have link-once semantics.  When multiple definitions of the variable are
4492 encountered by the linker, the first is selected and the remainder are
4493 discarded.  Following usage by the Microsoft compiler, the linker is told
4494 @emph{not} to warn about size or content differences of the multiple
4495 definitions.
4496
4497 Although the primary usage of this attribute is for POD types, the
4498 attribute can also be applied to global C++ objects that are initialized
4499 by a constructor.  In this case, the static initialization and destruction
4500 code for the object is emitted in each translation defining the object,
4501 but the calls to the constructor and destructor are protected by a
4502 link-once guard variable.
4503
4504 The @code{selectany} attribute is only available on Microsoft Windows
4505 targets.  You can use @code{__declspec (selectany)} as a synonym for
4506 @code{__attribute__ ((selectany))} for compatibility with other
4507 compilers.
4508
4509 @item weak
4510 The @code{weak} attribute is described in @ref{Function Attributes}.
4511
4512 @item dllimport
4513 The @code{dllimport} attribute is described in @ref{Function Attributes}.
4514
4515 @item dllexport
4516 The @code{dllexport} attribute is described in @ref{Function Attributes}.
4517
4518 @end table
4519
4520 @subsection Blackfin Variable Attributes
4521
4522 Three attributes are currently defined for the Blackfin.
4523
4524 @table @code
4525 @item l1_data
4526 @itemx l1_data_A
4527 @itemx l1_data_B
4528 @cindex @code{l1_data} variable attribute
4529 @cindex @code{l1_data_A} variable attribute
4530 @cindex @code{l1_data_B} variable attribute
4531 Use these attributes on the Blackfin to place the variable into L1 Data SRAM.
4532 Variables with @code{l1_data} attribute will be put into the specific section
4533 named @code{.l1.data}. Those with @code{l1_data_A} attribute will be put into
4534 the specific section named @code{.l1.data.A}. Those with @code{l1_data_B}
4535 attribute will be put into the specific section named @code{.l1.data.B}.
4536
4537 @item l2
4538 @cindex @code{l2} variable attribute
4539 Use this attribute on the Blackfin to place the variable into L2 SRAM.
4540 Variables with @code{l2} attribute will be put into the specific section
4541 named @code{.l2.data}.
4542 @end table
4543
4544 @subsection M32R/D Variable Attributes
4545
4546 One attribute is currently defined for the M32R/D@.
4547
4548 @table @code
4549 @item model (@var{model-name})
4550 @cindex variable addressability on the M32R/D
4551 Use this attribute on the M32R/D to set the addressability of an object.
4552 The identifier @var{model-name} is one of @code{small}, @code{medium},
4553 or @code{large}, representing each of the code models.
4554
4555 Small model objects live in the lower 16MB of memory (so that their
4556 addresses can be loaded with the @code{ld24} instruction).
4557
4558 Medium and large model objects may live anywhere in the 32-bit address space
4559 (the compiler will generate @code{seth/add3} instructions to load their
4560 addresses).
4561 @end table
4562
4563 @anchor{MeP Variable Attributes}
4564 @subsection MeP Variable Attributes
4565
4566 The MeP target has a number of addressing modes and busses.  The
4567 @code{near} space spans the standard memory space's first 16 megabytes
4568 (24 bits).  The @code{far} space spans the entire 32-bit memory space.
4569 The @code{based} space is a 128 byte region in the memory space which
4570 is addressed relative to the @code{$tp} register.  The @code{tiny}
4571 space is a 65536 byte region relative to the @code{$gp} register.  In
4572 addition to these memory regions, the MeP target has a separate 16-bit
4573 control bus which is specified with @code{cb} attributes.
4574
4575 @table @code
4576
4577 @item based
4578 Any variable with the @code{based} attribute will be assigned to the
4579 @code{.based} section, and will be accessed with relative to the
4580 @code{$tp} register.
4581
4582 @item tiny
4583 Likewise, the @code{tiny} attribute assigned variables to the
4584 @code{.tiny} section, relative to the @code{$gp} register.
4585
4586 @item near
4587 Variables with the @code{near} attribute are assumed to have addresses
4588 that fit in a 24-bit addressing mode.  This is the default for large
4589 variables (@code{-mtiny=4} is the default) but this attribute can
4590 override @code{-mtiny=} for small variables, or override @code{-ml}.
4591
4592 @item far
4593 Variables with the @code{far} attribute are addressed using a full
4594 32-bit address.  Since this covers the entire memory space, this
4595 allows modules to make no assumptions about where variables might be
4596 stored.
4597
4598 @item io
4599 @itemx io (@var{addr})
4600 Variables with the @code{io} attribute are used to address
4601 memory-mapped peripherals.  If an address is specified, the variable
4602 is assigned that address, else it is not assigned an address (it is
4603 assumed some other module will assign an address).  Example:
4604
4605 @example
4606 int timer_count __attribute__((io(0x123)));
4607 @end example
4608
4609 @item cb
4610 @itemx cb (@var{addr})
4611 Variables with the @code{cb} attribute are used to access the control
4612 bus, using special instructions.  @code{addr} indicates the control bus
4613 address.  Example:
4614
4615 @example
4616 int cpu_clock __attribute__((cb(0x123)));
4617 @end example
4618
4619 @end table
4620
4621 @anchor{i386 Variable Attributes}
4622 @subsection i386 Variable Attributes
4623
4624 Two attributes are currently defined for i386 configurations:
4625 @code{ms_struct} and @code{gcc_struct}
4626
4627 @table @code
4628 @item ms_struct
4629 @itemx gcc_struct
4630 @cindex @code{ms_struct} attribute
4631 @cindex @code{gcc_struct} attribute
4632
4633 If @code{packed} is used on a structure, or if bit-fields are used
4634 it may be that the Microsoft ABI packs them differently
4635 than GCC would normally pack them.  Particularly when moving packed
4636 data between functions compiled with GCC and the native Microsoft compiler
4637 (either via function call or as data in a file), it may be necessary to access
4638 either format.
4639
4640 Currently @option{-m[no-]ms-bitfields} is provided for the Microsoft Windows X86
4641 compilers to match the native Microsoft compiler.
4642
4643 The Microsoft structure layout algorithm is fairly simple with the exception
4644 of the bitfield packing:
4645
4646 The padding and alignment of members of structures and whether a bit field
4647 can straddle a storage-unit boundary
4648
4649 @enumerate
4650 @item Structure members are stored sequentially in the order in which they are
4651 declared: the first member has the lowest memory address and the last member
4652 the highest.
4653
4654 @item Every data object has an alignment-requirement. The alignment-requirement
4655 for all data except structures, unions, and arrays is either the size of the
4656 object or the current packing size (specified with either the aligned attribute
4657 or the pack pragma), whichever is less. For structures,  unions, and arrays,
4658 the alignment-requirement is the largest alignment-requirement of its members.
4659 Every object is allocated an offset so that:
4660
4661 offset %  alignment-requirement == 0
4662
4663 @item Adjacent bit fields are packed into the same 1-, 2-, or 4-byte allocation
4664 unit if the integral types are the same size and if the next bit field fits
4665 into the current allocation unit without crossing the boundary imposed by the
4666 common alignment requirements of the bit fields.
4667 @end enumerate
4668
4669 Handling of zero-length bitfields:
4670
4671 MSVC interprets zero-length bitfields in the following ways:
4672
4673 @enumerate
4674 @item If a zero-length bitfield is inserted between two bitfields that would
4675 normally be coalesced, the bitfields will not be coalesced.
4676
4677 For example:
4678
4679 @smallexample
4680 struct
4681  @{
4682    unsigned long bf_1 : 12;
4683    unsigned long : 0;
4684    unsigned long bf_2 : 12;
4685  @} t1;
4686 @end smallexample
4687
4688 The size of @code{t1} would be 8 bytes with the zero-length bitfield.  If the
4689 zero-length bitfield were removed, @code{t1}'s size would be 4 bytes.
4690
4691 @item If a zero-length bitfield is inserted after a bitfield, @code{foo}, and the
4692 alignment of the zero-length bitfield is greater than the member that follows it,
4693 @code{bar}, @code{bar} will be aligned as the type of the zero-length bitfield.
4694
4695 For example:
4696
4697 @smallexample
4698 struct
4699  @{
4700    char foo : 4;
4701    short : 0;
4702    char bar;
4703  @} t2;
4704
4705 struct
4706  @{
4707    char foo : 4;
4708    short : 0;
4709    double bar;
4710  @} t3;
4711 @end smallexample
4712
4713 For @code{t2}, @code{bar} will be placed at offset 2, rather than offset 1.
4714 Accordingly, the size of @code{t2} will be 4.  For @code{t3}, the zero-length
4715 bitfield will not affect the alignment of @code{bar} or, as a result, the size
4716 of the structure.
4717
4718 Taking this into account, it is important to note the following:
4719
4720 @enumerate
4721 @item If a zero-length bitfield follows a normal bitfield, the type of the
4722 zero-length bitfield may affect the alignment of the structure as whole. For
4723 example, @code{t2} has a size of 4 bytes, since the zero-length bitfield follows a
4724 normal bitfield, and is of type short.
4725
4726 @item Even if a zero-length bitfield is not followed by a normal bitfield, it may
4727 still affect the alignment of the structure:
4728
4729 @smallexample
4730 struct
4731  @{
4732    char foo : 6;
4733    long : 0;
4734  @} t4;
4735 @end smallexample
4736
4737 Here, @code{t4} will take up 4 bytes.
4738 @end enumerate
4739
4740 @item Zero-length bitfields following non-bitfield members are ignored:
4741
4742 @smallexample
4743 struct
4744  @{
4745    char foo;
4746    long : 0;
4747    char bar;
4748  @} t5;
4749 @end smallexample
4750
4751 Here, @code{t5} will take up 2 bytes.
4752 @end enumerate
4753 @end table
4754
4755 @subsection PowerPC Variable Attributes
4756
4757 Three attributes currently are defined for PowerPC configurations:
4758 @code{altivec}, @code{ms_struct} and @code{gcc_struct}.
4759
4760 For full documentation of the struct attributes please see the
4761 documentation in @ref{i386 Variable Attributes}.
4762
4763 For documentation of @code{altivec} attribute please see the
4764 documentation in @ref{PowerPC Type Attributes}.
4765
4766 @subsection SPU Variable Attributes
4767
4768 The SPU supports the @code{spu_vector} attribute for variables.  For
4769 documentation of this attribute please see the documentation in
4770 @ref{SPU Type Attributes}.
4771
4772 @subsection Xstormy16 Variable Attributes
4773
4774 One attribute is currently defined for xstormy16 configurations:
4775 @code{below100}.
4776
4777 @table @code
4778 @item below100
4779 @cindex @code{below100} attribute
4780
4781 If a variable has the @code{below100} attribute (@code{BELOW100} is
4782 allowed also), GCC will place the variable in the first 0x100 bytes of
4783 memory and use special opcodes to access it.  Such variables will be
4784 placed in either the @code{.bss_below100} section or the
4785 @code{.data_below100} section.
4786
4787 @end table
4788
4789 @subsection AVR Variable Attributes
4790
4791 @table @code
4792 @item progmem
4793 @cindex @code{progmem} variable attribute
4794 The @code{progmem} attribute is used on the AVR to place data in the Program
4795 Memory address space. The AVR is a Harvard Architecture processor and data
4796 normally resides in the Data Memory address space.
4797 @end table
4798
4799 @node Type Attributes
4800 @section Specifying Attributes of Types
4801 @cindex attribute of types
4802 @cindex type attributes
4803
4804 The keyword @code{__attribute__} allows you to specify special
4805 attributes of @code{struct} and @code{union} types when you define
4806 such types.  This keyword is followed by an attribute specification
4807 inside double parentheses.  Seven attributes are currently defined for
4808 types: @code{aligned}, @code{packed}, @code{transparent_union},
4809 @code{unused}, @code{deprecated}, @code{visibility}, and
4810 @code{may_alias}.  Other attributes are defined for functions
4811 (@pxref{Function Attributes}) and for variables (@pxref{Variable
4812 Attributes}).
4813
4814 You may also specify any one of these attributes with @samp{__}
4815 preceding and following its keyword.  This allows you to use these
4816 attributes in header files without being concerned about a possible
4817 macro of the same name.  For example, you may use @code{__aligned__}
4818 instead of @code{aligned}.
4819
4820 You may specify type attributes in an enum, struct or union type
4821 declaration or definition, or for other types in a @code{typedef}
4822 declaration.
4823
4824 For an enum, struct or union type, you may specify attributes either
4825 between the enum, struct or union tag and the name of the type, or
4826 just past the closing curly brace of the @emph{definition}.  The
4827 former syntax is preferred.
4828
4829 @xref{Attribute Syntax}, for details of the exact syntax for using
4830 attributes.
4831
4832 @table @code
4833 @cindex @code{aligned} attribute
4834 @item aligned (@var{alignment})
4835 This attribute specifies a minimum alignment (in bytes) for variables
4836 of the specified type.  For example, the declarations:
4837
4838 @smallexample
4839 struct S @{ short f[3]; @} __attribute__ ((aligned (8)));
4840 typedef int more_aligned_int __attribute__ ((aligned (8)));
4841 @end smallexample
4842
4843 @noindent
4844 force the compiler to insure (as far as it can) that each variable whose
4845 type is @code{struct S} or @code{more_aligned_int} will be allocated and
4846 aligned @emph{at least} on a 8-byte boundary.  On a SPARC, having all
4847 variables of type @code{struct S} aligned to 8-byte boundaries allows
4848 the compiler to use the @code{ldd} and @code{std} (doubleword load and
4849 store) instructions when copying one variable of type @code{struct S} to
4850 another, thus improving run-time efficiency.
4851
4852 Note that the alignment of any given @code{struct} or @code{union} type
4853 is required by the ISO C standard to be at least a perfect multiple of
4854 the lowest common multiple of the alignments of all of the members of
4855 the @code{struct} or @code{union} in question.  This means that you @emph{can}
4856 effectively adjust the alignment of a @code{struct} or @code{union}
4857 type by attaching an @code{aligned} attribute to any one of the members
4858 of such a type, but the notation illustrated in the example above is a
4859 more obvious, intuitive, and readable way to request the compiler to
4860 adjust the alignment of an entire @code{struct} or @code{union} type.
4861
4862 As in the preceding example, you can explicitly specify the alignment
4863 (in bytes) that you wish the compiler to use for a given @code{struct}
4864 or @code{union} type.  Alternatively, you can leave out the alignment factor
4865 and just ask the compiler to align a type to the maximum
4866 useful alignment for the target machine you are compiling for.  For
4867 example, you could write:
4868
4869 @smallexample
4870 struct S @{ short f[3]; @} __attribute__ ((aligned));
4871 @end smallexample
4872
4873 Whenever you leave out the alignment factor in an @code{aligned}
4874 attribute specification, the compiler automatically sets the alignment
4875 for the type to the largest alignment which is ever used for any data
4876 type on the target machine you are compiling for.  Doing this can often
4877 make copy operations more efficient, because the compiler can use
4878 whatever instructions copy the biggest chunks of memory when performing
4879 copies to or from the variables which have types that you have aligned
4880 this way.
4881
4882 In the example above, if the size of each @code{short} is 2 bytes, then
4883 the size of the entire @code{struct S} type is 6 bytes.  The smallest
4884 power of two which is greater than or equal to that is 8, so the
4885 compiler sets the alignment for the entire @code{struct S} type to 8
4886 bytes.
4887
4888 Note that although you can ask the compiler to select a time-efficient
4889 alignment for a given type and then declare only individual stand-alone
4890 objects of that type, the compiler's ability to select a time-efficient
4891 alignment is primarily useful only when you plan to create arrays of
4892 variables having the relevant (efficiently aligned) type.  If you
4893 declare or use arrays of variables of an efficiently-aligned type, then
4894 it is likely that your program will also be doing pointer arithmetic (or
4895 subscripting, which amounts to the same thing) on pointers to the
4896 relevant type, and the code that the compiler generates for these
4897 pointer arithmetic operations will often be more efficient for
4898 efficiently-aligned types than for other types.
4899
4900 The @code{aligned} attribute can only increase the alignment; but you
4901 can decrease it by specifying @code{packed} as well.  See below.
4902
4903 Note that the effectiveness of @code{aligned} attributes may be limited
4904 by inherent limitations in your linker.  On many systems, the linker is
4905 only able to arrange for variables to be aligned up to a certain maximum
4906 alignment.  (For some linkers, the maximum supported alignment may
4907 be very very small.)  If your linker is only able to align variables
4908 up to a maximum of 8 byte alignment, then specifying @code{aligned(16)}
4909 in an @code{__attribute__} will still only provide you with 8 byte
4910 alignment.  See your linker documentation for further information.
4911
4912 @item packed
4913 This attribute, attached to @code{struct} or @code{union} type
4914 definition, specifies that each member (other than zero-width bitfields)
4915 of the structure or union is placed to minimize the memory required.  When
4916 attached to an @code{enum} definition, it indicates that the smallest
4917 integral type should be used.
4918
4919 @opindex fshort-enums
4920 Specifying this attribute for @code{struct} and @code{union} types is
4921 equivalent to specifying the @code{packed} attribute on each of the
4922 structure or union members.  Specifying the @option{-fshort-enums}
4923 flag on the line is equivalent to specifying the @code{packed}
4924 attribute on all @code{enum} definitions.
4925
4926 In the following example @code{struct my_packed_struct}'s members are
4927 packed closely together, but the internal layout of its @code{s} member
4928 is not packed---to do that, @code{struct my_unpacked_struct} would need to
4929 be packed too.
4930
4931 @smallexample
4932 struct my_unpacked_struct
4933  @{
4934     char c;
4935     int i;
4936  @};
4937
4938 struct __attribute__ ((__packed__)) my_packed_struct
4939   @{
4940      char c;
4941      int  i;
4942      struct my_unpacked_struct s;
4943   @};
4944 @end smallexample
4945
4946 You may only specify this attribute on the definition of an @code{enum},
4947 @code{struct} or @code{union}, not on a @code{typedef} which does not
4948 also define the enumerated type, structure or union.
4949
4950 @item transparent_union
4951 This attribute, attached to a @code{union} type definition, indicates
4952 that any function parameter having that union type causes calls to that
4953 function to be treated in a special way.
4954
4955 First, the argument corresponding to a transparent union type can be of
4956 any type in the union; no cast is required.  Also, if the union contains
4957 a pointer type, the corresponding argument can be a null pointer
4958 constant or a void pointer expression; and if the union contains a void
4959 pointer type, the corresponding argument can be any pointer expression.
4960 If the union member type is a pointer, qualifiers like @code{const} on
4961 the referenced type must be respected, just as with normal pointer
4962 conversions.
4963
4964 Second, the argument is passed to the function using the calling
4965 conventions of the first member of the transparent union, not the calling
4966 conventions of the union itself.  All members of the union must have the
4967 same machine representation; this is necessary for this argument passing
4968 to work properly.
4969
4970 Transparent unions are designed for library functions that have multiple
4971 interfaces for compatibility reasons.  For example, suppose the
4972 @code{wait} function must accept either a value of type @code{int *} to
4973 comply with Posix, or a value of type @code{union wait *} to comply with
4974 the 4.1BSD interface.  If @code{wait}'s parameter were @code{void *},
4975 @code{wait} would accept both kinds of arguments, but it would also
4976 accept any other pointer type and this would make argument type checking
4977 less useful.  Instead, @code{<sys/wait.h>} might define the interface
4978 as follows:
4979
4980 @smallexample
4981 typedef union __attribute__ ((__transparent_union__))
4982   @{
4983     int *__ip;
4984     union wait *__up;
4985   @} wait_status_ptr_t;
4986
4987 pid_t wait (wait_status_ptr_t);
4988 @end smallexample
4989
4990 This interface allows either @code{int *} or @code{union wait *}
4991 arguments to be passed, using the @code{int *} calling convention.
4992 The program can call @code{wait} with arguments of either type:
4993
4994 @smallexample
4995 int w1 () @{ int w; return wait (&w); @}
4996 int w2 () @{ union wait w; return wait (&w); @}
4997 @end smallexample
4998
4999 With this interface, @code{wait}'s implementation might look like this:
5000
5001 @smallexample
5002 pid_t wait (wait_status_ptr_t p)
5003 @{
5004   return waitpid (-1, p.__ip, 0);
5005 @}
5006 @end smallexample
5007
5008 @item unused
5009 When attached to a type (including a @code{union} or a @code{struct}),
5010 this attribute means that variables of that type are meant to appear
5011 possibly unused.  GCC will not produce a warning for any variables of
5012 that type, even if the variable appears to do nothing.  This is often
5013 the case with lock or thread classes, which are usually defined and then
5014 not referenced, but contain constructors and destructors that have
5015 nontrivial bookkeeping functions.
5016
5017 @item deprecated
5018 @itemx deprecated (@var{msg})
5019 The @code{deprecated} attribute results in a warning if the type
5020 is used anywhere in the source file.  This is useful when identifying
5021 types that are expected to be removed in a future version of a program.
5022 If possible, the warning also includes the location of the declaration
5023 of the deprecated type, to enable users to easily find further
5024 information about why the type is deprecated, or what they should do
5025 instead.  Note that the warnings only occur for uses and then only
5026 if the type is being applied to an identifier that itself is not being
5027 declared as deprecated.
5028
5029 @smallexample
5030 typedef int T1 __attribute__ ((deprecated));
5031 T1 x;
5032 typedef T1 T2;
5033 T2 y;
5034 typedef T1 T3 __attribute__ ((deprecated));
5035 T3 z __attribute__ ((deprecated));
5036 @end smallexample
5037
5038 results in a warning on line 2 and 3 but not lines 4, 5, or 6.  No
5039 warning is issued for line 4 because T2 is not explicitly
5040 deprecated.  Line 5 has no warning because T3 is explicitly
5041 deprecated.  Similarly for line 6.  The optional msg
5042 argument, which must be a string, will be printed in the warning if
5043 present.
5044
5045 The @code{deprecated} attribute can also be used for functions and
5046 variables (@pxref{Function Attributes}, @pxref{Variable Attributes}.)
5047
5048 @item may_alias
5049 Accesses through pointers to types with this attribute are not subject
5050 to type-based alias analysis, but are instead assumed to be able to alias
5051 any other type of objects.  In the context of 6.5/7 an lvalue expression
5052 dereferencing such a pointer is treated like having a character type.
5053 See @option{-fstrict-aliasing} for more information on aliasing issues.
5054 This extension exists to support some vector APIs, in which pointers to
5055 one vector type are permitted to alias pointers to a different vector type.
5056
5057 Note that an object of a type with this attribute does not have any
5058 special semantics.
5059
5060 Example of use:
5061
5062 @smallexample
5063 typedef short __attribute__((__may_alias__)) short_a;
5064
5065 int
5066 main (void)
5067 @{
5068   int a = 0x12345678;
5069   short_a *b = (short_a *) &a;
5070
5071   b[1] = 0;
5072
5073   if (a == 0x12345678)
5074     abort();
5075
5076   exit(0);
5077 @}
5078 @end smallexample
5079
5080 If you replaced @code{short_a} with @code{short} in the variable
5081 declaration, the above program would abort when compiled with
5082 @option{-fstrict-aliasing}, which is on by default at @option{-O2} or
5083 above in recent GCC versions.
5084
5085 @item visibility
5086 In C++, attribute visibility (@pxref{Function Attributes}) can also be
5087 applied to class, struct, union and enum types.  Unlike other type
5088 attributes, the attribute must appear between the initial keyword and
5089 the name of the type; it cannot appear after the body of the type.
5090
5091 Note that the type visibility is applied to vague linkage entities
5092 associated with the class (vtable, typeinfo node, etc.).  In
5093 particular, if a class is thrown as an exception in one shared object
5094 and caught in another, the class must have default visibility.
5095 Otherwise the two shared objects will be unable to use the same
5096 typeinfo node and exception handling will break.
5097
5098 @end table
5099
5100 @subsection ARM Type Attributes
5101
5102 On those ARM targets that support @code{dllimport} (such as Symbian
5103 OS), you can use the @code{notshared} attribute to indicate that the
5104 virtual table and other similar data for a class should not be
5105 exported from a DLL@.  For example:
5106
5107 @smallexample
5108 class __declspec(notshared) C @{
5109 public:
5110   __declspec(dllimport) C();
5111   virtual void f();
5112 @}
5113
5114 __declspec(dllexport)
5115 C::C() @{@}
5116 @end smallexample
5117
5118 In this code, @code{C::C} is exported from the current DLL, but the
5119 virtual table for @code{C} is not exported.  (You can use
5120 @code{__attribute__} instead of @code{__declspec} if you prefer, but
5121 most Symbian OS code uses @code{__declspec}.)
5122
5123 @anchor{MeP Type Attributes}
5124 @subsection MeP Type Attributes
5125
5126 Many of the MeP variable attributes may be applied to types as well.
5127 Specifically, the @code{based}, @code{tiny}, @code{near}, and
5128 @code{far} attributes may be applied to either.  The @code{io} and
5129 @code{cb} attributes may not be applied to types.
5130
5131 @anchor{i386 Type Attributes}
5132 @subsection i386 Type Attributes
5133
5134 Two attributes are currently defined for i386 configurations:
5135 @code{ms_struct} and @code{gcc_struct}.
5136
5137 @table @code
5138
5139 @item ms_struct
5140 @itemx gcc_struct
5141 @cindex @code{ms_struct}
5142 @cindex @code{gcc_struct}
5143
5144 If @code{packed} is used on a structure, or if bit-fields are used
5145 it may be that the Microsoft ABI packs them differently
5146 than GCC would normally pack them.  Particularly when moving packed
5147 data between functions compiled with GCC and the native Microsoft compiler
5148 (either via function call or as data in a file), it may be necessary to access
5149 either format.
5150
5151 Currently @option{-m[no-]ms-bitfields} is provided for the Microsoft Windows X86
5152 compilers to match the native Microsoft compiler.
5153 @end table
5154
5155 To specify multiple attributes, separate them by commas within the
5156 double parentheses: for example, @samp{__attribute__ ((aligned (16),
5157 packed))}.
5158
5159 @anchor{PowerPC Type Attributes}
5160 @subsection PowerPC Type Attributes
5161
5162 Three attributes currently are defined for PowerPC configurations:
5163 @code{altivec}, @code{ms_struct} and @code{gcc_struct}.
5164
5165 For full documentation of the @code{ms_struct} and @code{gcc_struct}
5166 attributes please see the documentation in @ref{i386 Type Attributes}.
5167
5168 The @code{altivec} attribute allows one to declare AltiVec vector data
5169 types supported by the AltiVec Programming Interface Manual.  The
5170 attribute requires an argument to specify one of three vector types:
5171 @code{vector__}, @code{pixel__} (always followed by unsigned short),
5172 and @code{bool__} (always followed by unsigned).
5173
5174 @smallexample
5175 __attribute__((altivec(vector__)))
5176 __attribute__((altivec(pixel__))) unsigned short
5177 __attribute__((altivec(bool__))) unsigned
5178 @end smallexample
5179
5180 These attributes mainly are intended to support the @code{__vector},
5181 @code{__pixel}, and @code{__bool} AltiVec keywords.
5182
5183 @anchor{SPU Type Attributes}
5184 @subsection SPU Type Attributes
5185
5186 The SPU supports the @code{spu_vector} attribute for types.  This attribute
5187 allows one to declare vector data types supported by the Sony/Toshiba/IBM SPU
5188 Language Extensions Specification.  It is intended to support the
5189 @code{__vector} keyword.
5190
5191 @node Alignment
5192 @section Inquiring on Alignment of Types or Variables
5193 @cindex alignment
5194 @cindex type alignment
5195 @cindex variable alignment
5196
5197 The keyword @code{__alignof__} allows you to inquire about how an object
5198 is aligned, or the minimum alignment usually required by a type.  Its
5199 syntax is just like @code{sizeof}.
5200
5201 For example, if the target machine requires a @code{double} value to be
5202 aligned on an 8-byte boundary, then @code{__alignof__ (double)} is 8.
5203 This is true on many RISC machines.  On more traditional machine
5204 designs, @code{__alignof__ (double)} is 4 or even 2.
5205
5206 Some machines never actually require alignment; they allow reference to any
5207 data type even at an odd address.  For these machines, @code{__alignof__}
5208 reports the smallest alignment that GCC will give the data type, usually as
5209 mandated by the target ABI.
5210
5211 If the operand of @code{__alignof__} is an lvalue rather than a type,
5212 its value is the required alignment for its type, taking into account
5213 any minimum alignment specified with GCC's @code{__attribute__}
5214 extension (@pxref{Variable Attributes}).  For example, after this
5215 declaration:
5216
5217 @smallexample
5218 struct foo @{ int x; char y; @} foo1;
5219 @end smallexample
5220
5221 @noindent
5222 the value of @code{__alignof__ (foo1.y)} is 1, even though its actual
5223 alignment is probably 2 or 4, the same as @code{__alignof__ (int)}.
5224
5225 It is an error to ask for the alignment of an incomplete type.
5226
5227
5228 @node Inline
5229 @section An Inline Function is As Fast As a Macro
5230 @cindex inline functions
5231 @cindex integrating function code
5232 @cindex open coding
5233 @cindex macros, inline alternative
5234
5235 By declaring a function inline, you can direct GCC to make
5236 calls to that function faster.  One way GCC can achieve this is to
5237 integrate that function's code into the code for its callers.  This
5238 makes execution faster by eliminating the function-call overhead; in
5239 addition, if any of the actual argument values are constant, their
5240 known values may permit simplifications at compile time so that not
5241 all of the inline function's code needs to be included.  The effect on
5242 code size is less predictable; object code may be larger or smaller
5243 with function inlining, depending on the particular case.  You can
5244 also direct GCC to try to integrate all ``simple enough'' functions
5245 into their callers with the option @option{-finline-functions}.
5246
5247 GCC implements three different semantics of declaring a function
5248 inline.  One is available with @option{-std=gnu89} or
5249 @option{-fgnu89-inline} or when @code{gnu_inline} attribute is present
5250 on all inline declarations, another when
5251 @option{-std=c99}, @option{-std=c1x},
5252 @option{-std=gnu99} or @option{-std=gnu1x}
5253 (without @option{-fgnu89-inline}), and the third
5254 is used when compiling C++.
5255
5256 To declare a function inline, use the @code{inline} keyword in its
5257 declaration, like this:
5258
5259 @smallexample
5260 static inline int
5261 inc (int *a)
5262 @{
5263   return (*a)++;
5264 @}
5265 @end smallexample
5266
5267 If you are writing a header file to be included in ISO C90 programs, write
5268 @code{__inline__} instead of @code{inline}.  @xref{Alternate Keywords}.
5269
5270 The three types of inlining behave similarly in two important cases:
5271 when the @code{inline} keyword is used on a @code{static} function,
5272 like the example above, and when a function is first declared without
5273 using the @code{inline} keyword and then is defined with
5274 @code{inline}, like this:
5275
5276 @smallexample
5277 extern int inc (int *a);
5278 inline int
5279 inc (int *a)
5280 @{
5281   return (*a)++;
5282 @}
5283 @end smallexample
5284
5285 In both of these common cases, the program behaves the same as if you
5286 had not used the @code{inline} keyword, except for its speed.
5287
5288 @cindex inline functions, omission of
5289 @opindex fkeep-inline-functions
5290 When a function is both inline and @code{static}, if all calls to the
5291 function are integrated into the caller, and the function's address is
5292 never used, then the function's own assembler code is never referenced.
5293 In this case, GCC does not actually output assembler code for the
5294 function, unless you specify the option @option{-fkeep-inline-functions}.
5295 Some calls cannot be integrated for various reasons (in particular,
5296 calls that precede the function's definition cannot be integrated, and
5297 neither can recursive calls within the definition).  If there is a
5298 nonintegrated call, then the function is compiled to assembler code as
5299 usual.  The function must also be compiled as usual if the program
5300 refers to its address, because that can't be inlined.
5301
5302 @opindex Winline
5303 Note that certain usages in a function definition can make it unsuitable
5304 for inline substitution.  Among these usages are: use of varargs, use of
5305 alloca, use of variable sized data types (@pxref{Variable Length}),
5306 use of computed goto (@pxref{Labels as Values}), use of nonlocal goto,
5307 and nested functions (@pxref{Nested Functions}).  Using @option{-Winline}
5308 will warn when a function marked @code{inline} could not be substituted,
5309 and will give the reason for the failure.
5310
5311 @cindex automatic @code{inline} for C++ member fns
5312 @cindex @code{inline} automatic for C++ member fns
5313 @cindex member fns, automatically @code{inline}
5314 @cindex C++ member fns, automatically @code{inline}
5315 @opindex fno-default-inline
5316 As required by ISO C++, GCC considers member functions defined within
5317 the body of a class to be marked inline even if they are
5318 not explicitly declared with the @code{inline} keyword.  You can
5319 override this with @option{-fno-default-inline}; @pxref{C++ Dialect
5320 Options,,Options Controlling C++ Dialect}.
5321
5322 GCC does not inline any functions when not optimizing unless you specify
5323 the @samp{always_inline} attribute for the function, like this:
5324
5325 @smallexample
5326 /* @r{Prototype.}  */
5327 inline void foo (const char) __attribute__((always_inline));
5328 @end smallexample
5329
5330 The remainder of this section is specific to GNU C90 inlining.
5331
5332 @cindex non-static inline function
5333 When an inline function is not @code{static}, then the compiler must assume
5334 that there may be calls from other source files; since a global symbol can
5335 be defined only once in any program, the function must not be defined in
5336 the other source files, so the calls therein cannot be integrated.
5337 Therefore, a non-@code{static} inline function is always compiled on its
5338 own in the usual fashion.
5339
5340 If you specify both @code{inline} and @code{extern} in the function
5341 definition, then the definition is used only for inlining.  In no case
5342 is the function compiled on its own, not even if you refer to its
5343 address explicitly.  Such an address becomes an external reference, as
5344 if you had only declared the function, and had not defined it.
5345
5346 This combination of @code{inline} and @code{extern} has almost the
5347 effect of a macro.  The way to use it is to put a function definition in
5348 a header file with these keywords, and put another copy of the
5349 definition (lacking @code{inline} and @code{extern}) in a library file.
5350 The definition in the header file will cause most calls to the function
5351 to be inlined.  If any uses of the function remain, they will refer to
5352 the single copy in the library.
5353
5354 @node Volatiles
5355 @section When is a Volatile Object Accessed?
5356 @cindex accessing volatiles
5357 @cindex volatile read
5358 @cindex volatile write
5359 @cindex volatile access
5360
5361 C has the concept of volatile objects.  These are normally accessed by
5362 pointers and used for accessing hardware or inter-thread
5363 communication.  The standard encourages compilers to refrain from
5364 optimizations concerning accesses to volatile objects, but leaves it
5365 implementation defined as to what constitutes a volatile access.  The
5366 minimum requirement is that at a sequence point all previous accesses
5367 to volatile objects have stabilized and no subsequent accesses have
5368 occurred.  Thus an implementation is free to reorder and combine
5369 volatile accesses which occur between sequence points, but cannot do
5370 so for accesses across a sequence point.  The use of volatile does
5371 not allow you to violate the restriction on updating objects multiple
5372 times between two sequence points.
5373
5374 Accesses to non-volatile objects are not ordered with respect to
5375 volatile accesses.  You cannot use a volatile object as a memory
5376 barrier to order a sequence of writes to non-volatile memory.  For
5377 instance:
5378
5379 @smallexample
5380 int *ptr = @var{something};
5381 volatile int vobj;
5382 *ptr = @var{something};
5383 vobj = 1;
5384 @end smallexample
5385
5386 Unless @var{*ptr} and @var{vobj} can be aliased, it is not guaranteed
5387 that the write to @var{*ptr} will have occurred by the time the update
5388 of @var{vobj} has happened.  If you need this guarantee, you must use
5389 a stronger memory barrier such as:
5390
5391 @smallexample
5392 int *ptr = @var{something};
5393 volatile int vobj;
5394 *ptr = @var{something};
5395 asm volatile ("" : : : "memory");
5396 vobj = 1;
5397 @end smallexample
5398
5399 A scalar volatile object is read when it is accessed in a void context:
5400
5401 @smallexample
5402 volatile int *src = @var{somevalue};
5403 *src;
5404 @end smallexample
5405
5406 Such expressions are rvalues, and GCC implements this as a
5407 read of the volatile object being pointed to.
5408
5409 Assignments are also expressions and have an rvalue.  However when
5410 assigning to a scalar volatile, the volatile object is not reread,
5411 regardless of whether the assignment expression's rvalue is used or
5412 not.  If the assignment's rvalue is used, the value is that assigned
5413 to the volatile object.  For instance, there is no read of @var{vobj}
5414 in all the following cases:
5415
5416 @smallexample
5417 int obj;
5418 volatile int vobj;
5419 vobj = @var{something};
5420 obj = vobj = @var{something};
5421 obj ? vobj = @var{onething} : vobj = @var{anotherthing};
5422 obj = (@var{something}, vobj = @var{anotherthing});
5423 @end smallexample
5424
5425 If you need to read the volatile object after an assignment has
5426 occurred, you must use a separate expression with an intervening
5427 sequence point.
5428
5429 As bitfields are not individually addressable, volatile bitfields may
5430 be implicitly read when written to, or when adjacent bitfields are
5431 accessed.  Bitfield operations may be optimized such that adjacent
5432 bitfields are only partially accessed, if they straddle a storage unit
5433 boundary.  For these reasons it is unwise to use volatile bitfields to
5434 access hardware.
5435
5436 @node Extended Asm
5437 @section Assembler Instructions with C Expression Operands
5438 @cindex extended @code{asm}
5439 @cindex @code{asm} expressions
5440 @cindex assembler instructions
5441 @cindex registers
5442
5443 In an assembler instruction using @code{asm}, you can specify the
5444 operands of the instruction using C expressions.  This means you need not
5445 guess which registers or memory locations will contain the data you want
5446 to use.
5447
5448 You must specify an assembler instruction template much like what
5449 appears in a machine description, plus an operand constraint string for
5450 each operand.
5451
5452 For example, here is how to use the 68881's @code{fsinx} instruction:
5453
5454 @smallexample
5455 asm ("fsinx %1,%0" : "=f" (result) : "f" (angle));
5456 @end smallexample
5457
5458 @noindent
5459 Here @code{angle} is the C expression for the input operand while
5460 @code{result} is that of the output operand.  Each has @samp{"f"} as its
5461 operand constraint, saying that a floating point register is required.
5462 The @samp{=} in @samp{=f} indicates that the operand is an output; all
5463 output operands' constraints must use @samp{=}.  The constraints use the
5464 same language used in the machine description (@pxref{Constraints}).
5465
5466 Each operand is described by an operand-constraint string followed by
5467 the C expression in parentheses.  A colon separates the assembler
5468 template from the first output operand and another separates the last
5469 output operand from the first input, if any.  Commas separate the
5470 operands within each group.  The total number of operands is currently
5471 limited to 30; this limitation may be lifted in some future version of
5472 GCC@.
5473
5474 If there are no output operands but there are input operands, you must
5475 place two consecutive colons surrounding the place where the output
5476 operands would go.
5477
5478 As of GCC version 3.1, it is also possible to specify input and output
5479 operands using symbolic names which can be referenced within the
5480 assembler code.  These names are specified inside square brackets
5481 preceding the constraint string, and can be referenced inside the
5482 assembler code using @code{%[@var{name}]} instead of a percentage sign
5483 followed by the operand number.  Using named operands the above example
5484 could look like:
5485
5486 @smallexample
5487 asm ("fsinx %[angle],%[output]"
5488      : [output] "=f" (result)
5489      : [angle] "f" (angle));
5490 @end smallexample
5491
5492 @noindent
5493 Note that the symbolic operand names have no relation whatsoever to
5494 other C identifiers.  You may use any name you like, even those of
5495 existing C symbols, but you must ensure that no two operands within the same
5496 assembler construct use the same symbolic name.
5497
5498 Output operand expressions must be lvalues; the compiler can check this.
5499 The input operands need not be lvalues.  The compiler cannot check
5500 whether the operands have data types that are reasonable for the
5501 instruction being executed.  It does not parse the assembler instruction
5502 template and does not know what it means or even whether it is valid
5503 assembler input.  The extended @code{asm} feature is most often used for
5504 machine instructions the compiler itself does not know exist.  If
5505 the output expression cannot be directly addressed (for example, it is a
5506 bit-field), your constraint must allow a register.  In that case, GCC
5507 will use the register as the output of the @code{asm}, and then store
5508 that register into the output.
5509
5510 The ordinary output operands must be write-only; GCC will assume that
5511 the values in these operands before the instruction are dead and need
5512 not be generated.  Extended asm supports input-output or read-write
5513 operands.  Use the constraint character @samp{+} to indicate such an
5514 operand and list it with the output operands.  You should only use
5515 read-write operands when the constraints for the operand (or the
5516 operand in which only some of the bits are to be changed) allow a
5517 register.
5518
5519 You may, as an alternative, logically split its function into two
5520 separate operands, one input operand and one write-only output
5521 operand.  The connection between them is expressed by constraints
5522 which say they need to be in the same location when the instruction
5523 executes.  You can use the same C expression for both operands, or
5524 different expressions.  For example, here we write the (fictitious)
5525 @samp{combine} instruction with @code{bar} as its read-only source
5526 operand and @code{foo} as its read-write destination:
5527
5528 @smallexample
5529 asm ("combine %2,%0" : "=r" (foo) : "0" (foo), "g" (bar));
5530 @end smallexample
5531
5532 @noindent
5533 The constraint @samp{"0"} for operand 1 says that it must occupy the
5534 same location as operand 0.  A number in constraint is allowed only in
5535 an input operand and it must refer to an output operand.
5536
5537 Only a number in the constraint can guarantee that one operand will be in
5538 the same place as another.  The mere fact that @code{foo} is the value
5539 of both operands is not enough to guarantee that they will be in the
5540 same place in the generated assembler code.  The following would not
5541 work reliably:
5542
5543 @smallexample
5544 asm ("combine %2,%0" : "=r" (foo) : "r" (foo), "g" (bar));
5545 @end smallexample
5546
5547 Various optimizations or reloading could cause operands 0 and 1 to be in
5548 different registers; GCC knows no reason not to do so.  For example, the
5549 compiler might find a copy of the value of @code{foo} in one register and
5550 use it for operand 1, but generate the output operand 0 in a different
5551 register (copying it afterward to @code{foo}'s own address).  Of course,
5552 since the register for operand 1 is not even mentioned in the assembler
5553 code, the result will not work, but GCC can't tell that.
5554
5555 As of GCC version 3.1, one may write @code{[@var{name}]} instead of
5556 the operand number for a matching constraint.  For example:
5557
5558 @smallexample
5559 asm ("cmoveq %1,%2,%[result]"
5560      : [result] "=r"(result)
5561      : "r" (test), "r"(new), "[result]"(old));
5562 @end smallexample
5563
5564 Sometimes you need to make an @code{asm} operand be a specific register,
5565 but there's no matching constraint letter for that register @emph{by
5566 itself}.  To force the operand into that register, use a local variable
5567 for the operand and specify the register in the variable declaration.
5568 @xref{Explicit Reg Vars}.  Then for the @code{asm} operand, use any
5569 register constraint letter that matches the register:
5570
5571 @smallexample
5572 register int *p1 asm ("r0") = @dots{};
5573 register int *p2 asm ("r1") = @dots{};
5574 register int *result asm ("r0");
5575 asm ("sysint" : "=r" (result) : "0" (p1), "r" (p2));
5576 @end smallexample
5577
5578 @anchor{Example of asm with clobbered asm reg}
5579 In the above example, beware that a register that is call-clobbered by
5580 the target ABI will be overwritten by any function call in the
5581 assignment, including library calls for arithmetic operators.
5582 Also a register may be clobbered when generating some operations,
5583 like variable shift, memory copy or memory move on x86.
5584 Assuming it is a call-clobbered register, this may happen to @code{r0}
5585 above by the assignment to @code{p2}.  If you have to use such a
5586 register, use temporary variables for expressions between the register
5587 assignment and use:
5588
5589 @smallexample
5590 int t1 = @dots{};
5591 register int *p1 asm ("r0") = @dots{};
5592 register int *p2 asm ("r1") = t1;
5593 register int *result asm ("r0");
5594 asm ("sysint" : "=r" (result) : "0" (p1), "r" (p2));
5595 @end smallexample
5596
5597 Some instructions clobber specific hard registers.  To describe this,
5598 write a third colon after the input operands, followed by the names of
5599 the clobbered hard registers (given as strings).  Here is a realistic
5600 example for the VAX:
5601
5602 @smallexample
5603 asm volatile ("movc3 %0,%1,%2"
5604               : /* @r{no outputs} */
5605               : "g" (from), "g" (to), "g" (count)
5606               : "r0", "r1", "r2", "r3", "r4", "r5");
5607 @end smallexample
5608
5609 You may not write a clobber description in a way that overlaps with an
5610 input or output operand.  For example, you may not have an operand
5611 describing a register class with one member if you mention that register
5612 in the clobber list.  Variables declared to live in specific registers
5613 (@pxref{Explicit Reg Vars}), and used as asm input or output operands must
5614 have no part mentioned in the clobber description.
5615 There is no way for you to specify that an input
5616 operand is modified without also specifying it as an output
5617 operand.  Note that if all the output operands you specify are for this
5618 purpose (and hence unused), you will then also need to specify
5619 @code{volatile} for the @code{asm} construct, as described below, to
5620 prevent GCC from deleting the @code{asm} statement as unused.
5621
5622 If you refer to a particular hardware register from the assembler code,
5623 you will probably have to list the register after the third colon to
5624 tell the compiler the register's value is modified.  In some assemblers,
5625 the register names begin with @samp{%}; to produce one @samp{%} in the
5626 assembler code, you must write @samp{%%} in the input.
5627
5628 If your assembler instruction can alter the condition code register, add
5629 @samp{cc} to the list of clobbered registers.  GCC on some machines
5630 represents the condition codes as a specific hardware register;
5631 @samp{cc} serves to name this register.  On other machines, the
5632 condition code is handled differently, and specifying @samp{cc} has no
5633 effect.  But it is valid no matter what the machine.
5634
5635 If your assembler instructions access memory in an unpredictable
5636 fashion, add @samp{memory} to the list of clobbered registers.  This
5637 will cause GCC to not keep memory values cached in registers across the
5638 assembler instruction and not optimize stores or loads to that memory.
5639 You will also want to add the @code{volatile} keyword if the memory
5640 affected is not listed in the inputs or outputs of the @code{asm}, as
5641 the @samp{memory} clobber does not count as a side-effect of the
5642 @code{asm}.  If you know how large the accessed memory is, you can add
5643 it as input or output but if this is not known, you should add
5644 @samp{memory}.  As an example, if you access ten bytes of a string, you
5645 can use a memory input like:
5646
5647 @smallexample
5648 @{"m"( (@{ struct @{ char x[10]; @} *p = (void *)ptr ; *p; @}) )@}.
5649 @end smallexample
5650
5651 Note that in the following example the memory input is necessary,
5652 otherwise GCC might optimize the store to @code{x} away:
5653 @smallexample
5654 int foo ()
5655 @{
5656   int x = 42;
5657   int *y = &x;
5658   int result;
5659   asm ("magic stuff accessing an 'int' pointed to by '%1'"
5660         "=&d" (r) : "a" (y), "m" (*y));
5661   return result;
5662 @}
5663 @end smallexample
5664
5665 You can put multiple assembler instructions together in a single
5666 @code{asm} template, separated by the characters normally used in assembly
5667 code for the system.  A combination that works in most places is a newline
5668 to break the line, plus a tab character to move to the instruction field
5669 (written as @samp{\n\t}).  Sometimes semicolons can be used, if the
5670 assembler allows semicolons as a line-breaking character.  Note that some
5671 assembler dialects use semicolons to start a comment.
5672 The input operands are guaranteed not to use any of the clobbered
5673 registers, and neither will the output operands' addresses, so you can
5674 read and write the clobbered registers as many times as you like.  Here
5675 is an example of multiple instructions in a template; it assumes the
5676 subroutine @code{_foo} accepts arguments in registers 9 and 10:
5677
5678 @smallexample
5679 asm ("movl %0,r9\n\tmovl %1,r10\n\tcall _foo"
5680      : /* no outputs */
5681      : "g" (from), "g" (to)
5682      : "r9", "r10");
5683 @end smallexample
5684
5685 Unless an output operand has the @samp{&} constraint modifier, GCC
5686 may allocate it in the same register as an unrelated input operand, on
5687 the assumption the inputs are consumed before the outputs are produced.
5688 This assumption may be false if the assembler code actually consists of
5689 more than one instruction.  In such a case, use @samp{&} for each output
5690 operand that may not overlap an input.  @xref{Modifiers}.
5691
5692 If you want to test the condition code produced by an assembler
5693 instruction, you must include a branch and a label in the @code{asm}
5694 construct, as follows:
5695
5696 @smallexample
5697 asm ("clr %0\n\tfrob %1\n\tbeq 0f\n\tmov #1,%0\n0:"
5698      : "g" (result)
5699      : "g" (input));
5700 @end smallexample
5701
5702 @noindent
5703 This assumes your assembler supports local labels, as the GNU assembler
5704 and most Unix assemblers do.
5705
5706 Speaking of labels, jumps from one @code{asm} to another are not
5707 supported.  The compiler's optimizers do not know about these jumps, and
5708 therefore they cannot take account of them when deciding how to
5709 optimize.  @xref{Extended asm with goto}.
5710
5711 @cindex macros containing @code{asm}
5712 Usually the most convenient way to use these @code{asm} instructions is to
5713 encapsulate them in macros that look like functions.  For example,
5714
5715 @smallexample
5716 #define sin(x)       \
5717 (@{ double __value, __arg = (x);   \
5718    asm ("fsinx %1,%0": "=f" (__value): "f" (__arg));  \
5719    __value; @})
5720 @end smallexample
5721
5722 @noindent
5723 Here the variable @code{__arg} is used to make sure that the instruction
5724 operates on a proper @code{double} value, and to accept only those
5725 arguments @code{x} which can convert automatically to a @code{double}.
5726
5727 Another way to make sure the instruction operates on the correct data
5728 type is to use a cast in the @code{asm}.  This is different from using a
5729 variable @code{__arg} in that it converts more different types.  For
5730 example, if the desired type were @code{int}, casting the argument to
5731 @code{int} would accept a pointer with no complaint, while assigning the
5732 argument to an @code{int} variable named @code{__arg} would warn about
5733 using a pointer unless the caller explicitly casts it.
5734
5735 If an @code{asm} has output operands, GCC assumes for optimization
5736 purposes the instruction has no side effects except to change the output
5737 operands.  This does not mean instructions with a side effect cannot be
5738 used, but you must be careful, because the compiler may eliminate them
5739 if the output operands aren't used, or move them out of loops, or
5740 replace two with one if they constitute a common subexpression.  Also,
5741 if your instruction does have a side effect on a variable that otherwise
5742 appears not to change, the old value of the variable may be reused later
5743 if it happens to be found in a register.
5744
5745 You can prevent an @code{asm} instruction from being deleted
5746 by writing the keyword @code{volatile} after
5747 the @code{asm}.  For example:
5748
5749 @smallexample
5750 #define get_and_set_priority(new)              \
5751 (@{ int __old;                                  \
5752    asm volatile ("get_and_set_priority %0, %1" \
5753                  : "=g" (__old) : "g" (new));  \
5754    __old; @})
5755 @end smallexample
5756
5757 @noindent
5758 The @code{volatile} keyword indicates that the instruction has
5759 important side-effects.  GCC will not delete a volatile @code{asm} if
5760 it is reachable.  (The instruction can still be deleted if GCC can
5761 prove that control-flow will never reach the location of the
5762 instruction.)  Note that even a volatile @code{asm} instruction
5763 can be moved relative to other code, including across jump
5764 instructions.  For example, on many targets there is a system
5765 register which can be set to control the rounding mode of
5766 floating point operations.  You might try
5767 setting it with a volatile @code{asm}, like this PowerPC example:
5768
5769 @smallexample
5770        asm volatile("mtfsf 255,%0" : : "f" (fpenv));
5771        sum = x + y;
5772 @end smallexample
5773
5774 @noindent
5775 This will not work reliably, as the compiler may move the addition back
5776 before the volatile @code{asm}.  To make it work you need to add an
5777 artificial dependency to the @code{asm} referencing a variable in the code
5778 you don't want moved, for example:
5779
5780 @smallexample
5781     asm volatile ("mtfsf 255,%1" : "=X"(sum): "f"(fpenv));
5782     sum = x + y;
5783 @end smallexample
5784
5785 Similarly, you can't expect a
5786 sequence of volatile @code{asm} instructions to remain perfectly
5787 consecutive.  If you want consecutive output, use a single @code{asm}.
5788 Also, GCC will perform some optimizations across a volatile @code{asm}
5789 instruction; GCC does not ``forget everything'' when it encounters
5790 a volatile @code{asm} instruction the way some other compilers do.
5791
5792 An @code{asm} instruction without any output operands will be treated
5793 identically to a volatile @code{asm} instruction.
5794
5795 It is a natural idea to look for a way to give access to the condition
5796 code left by the assembler instruction.  However, when we attempted to
5797 implement this, we found no way to make it work reliably.  The problem
5798 is that output operands might need reloading, which would result in
5799 additional following ``store'' instructions.  On most machines, these
5800 instructions would alter the condition code before there was time to
5801 test it.  This problem doesn't arise for ordinary ``test'' and
5802 ``compare'' instructions because they don't have any output operands.
5803
5804 For reasons similar to those described above, it is not possible to give
5805 an assembler instruction access to the condition code left by previous
5806 instructions.
5807
5808 @anchor{Extended asm with goto}
5809 As of GCC version 4.5, @code{asm goto} may be used to have the assembly
5810 jump to one or more C labels.  In this form, a fifth section after the
5811 clobber list contains a list of all C labels to which the assembly may jump.
5812 Each label operand is implicitly self-named.  The @code{asm} is also assumed
5813 to fall through to the next statement.
5814
5815 This form of @code{asm} is restricted to not have outputs.  This is due
5816 to a internal restriction in the compiler that control transfer instructions
5817 cannot have outputs.  This restriction on @code{asm goto} may be lifted
5818 in some future version of the compiler.  In the mean time, @code{asm goto}
5819 may include a memory clobber, and so leave outputs in memory.
5820
5821 @smallexample
5822 int frob(int x)
5823 @{
5824   int y;
5825   asm goto ("frob %%r5, %1; jc %l[error]; mov (%2), %%r5"
5826             : : "r"(x), "r"(&y) : "r5", "memory" : error);
5827   return y;
5828  error:
5829   return -1;
5830 @}
5831 @end smallexample
5832
5833 In this (inefficient) example, the @code{frob} instruction sets the
5834 carry bit to indicate an error.  The @code{jc} instruction detects
5835 this and branches to the @code{error} label.  Finally, the output
5836 of the @code{frob} instruction (@code{%r5}) is stored into the memory
5837 for variable @code{y}, which is later read by the @code{return} statement.
5838
5839 @smallexample
5840 void doit(void)
5841 @{
5842   int i = 0;
5843   asm goto ("mfsr %%r1, 123; jmp %%r1;"
5844             ".pushsection doit_table;"
5845             ".long %l0, %l1, %l2, %l3;"
5846             ".popsection"
5847             : : : "r1" : label1, label2, label3, label4);
5848   __builtin_unreachable ();
5849
5850  label1:
5851   f1();
5852   return;
5853  label2:
5854   f2();
5855   return;
5856  label3:
5857   i = 1;
5858  label4:
5859   f3(i);
5860 @}
5861 @end smallexample
5862
5863 In this (also inefficient) example, the @code{mfsr} instruction reads
5864 an address from some out-of-band machine register, and the following
5865 @code{jmp} instruction branches to that address.  The address read by
5866 the @code{mfsr} instruction is assumed to have been previously set via
5867 some application-specific mechanism to be one of the four values stored
5868 in the @code{doit_table} section.  Finally, the @code{asm} is followed
5869 by a call to @code{__builtin_unreachable} to indicate that the @code{asm}
5870 does not in fact fall through.
5871
5872 @smallexample
5873 #define TRACE1(NUM)                         \
5874   do @{                                      \
5875     asm goto ("0: nop;"                     \
5876               ".pushsection trace_table;"   \
5877               ".long 0b, %l0;"              \
5878               ".popsection"                 \
5879               : : : : trace#NUM);           \
5880     if (0) @{ trace#NUM: trace(); @}          \
5881   @} while (0)
5882 #define TRACE  TRACE1(__COUNTER__)
5883 @end smallexample
5884
5885 In this example (which in fact inspired the @code{asm goto} feature)
5886 we want on rare occasions to call the @code{trace} function; on other
5887 occasions we'd like to keep the overhead to the absolute minimum.
5888 The normal code path consists of a single @code{nop} instruction.
5889 However, we record the address of this @code{nop} together with the
5890 address of a label that calls the @code{trace} function.  This allows
5891 the @code{nop} instruction to be patched at runtime to be an
5892 unconditional branch to the stored label.  It is assumed that an
5893 optimizing compiler will move the labeled block out of line, to
5894 optimize the fall through path from the @code{asm}.
5895
5896 If you are writing a header file that should be includable in ISO C
5897 programs, write @code{__asm__} instead of @code{asm}.  @xref{Alternate
5898 Keywords}.
5899
5900 @subsection Size of an @code{asm}
5901
5902 Some targets require that GCC track the size of each instruction used in
5903 order to generate correct code.  Because the final length of an
5904 @code{asm} is only known by the assembler, GCC must make an estimate as
5905 to how big it will be.  The estimate is formed by counting the number of
5906 statements in the pattern of the @code{asm} and multiplying that by the
5907 length of the longest instruction on that processor.  Statements in the
5908 @code{asm} are identified by newline characters and whatever statement
5909 separator characters are supported by the assembler; on most processors
5910 this is the `@code{;}' character.
5911
5912 Normally, GCC's estimate is perfectly adequate to ensure that correct
5913 code is generated, but it is possible to confuse the compiler if you use
5914 pseudo instructions or assembler macros that expand into multiple real
5915 instructions or if you use assembler directives that expand to more
5916 space in the object file than would be needed for a single instruction.
5917 If this happens then the assembler will produce a diagnostic saying that
5918 a label is unreachable.
5919
5920 @subsection i386 floating point asm operands
5921
5922 There are several rules on the usage of stack-like regs in
5923 asm_operands insns.  These rules apply only to the operands that are
5924 stack-like regs:
5925
5926 @enumerate
5927 @item
5928 Given a set of input regs that die in an asm_operands, it is
5929 necessary to know which are implicitly popped by the asm, and
5930 which must be explicitly popped by gcc.
5931
5932 An input reg that is implicitly popped by the asm must be
5933 explicitly clobbered, unless it is constrained to match an
5934 output operand.
5935
5936 @item
5937 For any input reg that is implicitly popped by an asm, it is
5938 necessary to know how to adjust the stack to compensate for the pop.
5939 If any non-popped input is closer to the top of the reg-stack than
5940 the implicitly popped reg, it would not be possible to know what the
5941 stack looked like---it's not clear how the rest of the stack ``slides
5942 up''.
5943
5944 All implicitly popped input regs must be closer to the top of
5945 the reg-stack than any input that is not implicitly popped.
5946
5947 It is possible that if an input dies in an insn, reload might
5948 use the input reg for an output reload.  Consider this example:
5949
5950 @smallexample
5951 asm ("foo" : "=t" (a) : "f" (b));
5952 @end smallexample
5953
5954 This asm says that input B is not popped by the asm, and that
5955 the asm pushes a result onto the reg-stack, i.e., the stack is one
5956 deeper after the asm than it was before.  But, it is possible that
5957 reload will think that it can use the same reg for both the input and
5958 the output, if input B dies in this insn.
5959
5960 If any input operand uses the @code{f} constraint, all output reg
5961 constraints must use the @code{&} earlyclobber.
5962
5963 The asm above would be written as
5964
5965 @smallexample
5966 asm ("foo" : "=&t" (a) : "f" (b));
5967 @end smallexample
5968
5969 @item
5970 Some operands need to be in particular places on the stack.  All
5971 output operands fall in this category---there is no other way to
5972 know which regs the outputs appear in unless the user indicates
5973 this in the constraints.
5974
5975 Output operands must specifically indicate which reg an output
5976 appears in after an asm.  @code{=f} is not allowed: the operand
5977 constraints must select a class with a single reg.
5978
5979 @item
5980 Output operands may not be ``inserted'' between existing stack regs.
5981 Since no 387 opcode uses a read/write operand, all output operands
5982 are dead before the asm_operands, and are pushed by the asm_operands.
5983 It makes no sense to push anywhere but the top of the reg-stack.
5984
5985 Output operands must start at the top of the reg-stack: output
5986 operands may not ``skip'' a reg.
5987
5988 @item
5989 Some asm statements may need extra stack space for internal
5990 calculations.  This can be guaranteed by clobbering stack registers
5991 unrelated to the inputs and outputs.
5992
5993 @end enumerate
5994
5995 Here are a couple of reasonable asms to want to write.  This asm
5996 takes one input, which is internally popped, and produces two outputs.
5997
5998 @smallexample
5999 asm ("fsincos" : "=t" (cos), "=u" (sin) : "0" (inp));
6000 @end smallexample
6001
6002 This asm takes two inputs, which are popped by the @code{fyl2xp1} opcode,
6003 and replaces them with one output.  The user must code the @code{st(1)}
6004 clobber for reg-stack.c to know that @code{fyl2xp1} pops both inputs.
6005
6006 @smallexample
6007 asm ("fyl2xp1" : "=t" (result) : "0" (x), "u" (y) : "st(1)");
6008 @end smallexample
6009
6010 @include md.texi
6011
6012 @node Asm Labels
6013 @section Controlling Names Used in Assembler Code
6014 @cindex assembler names for identifiers
6015 @cindex names used in assembler code
6016 @cindex identifiers, names in assembler code
6017
6018 You can specify the name to be used in the assembler code for a C
6019 function or variable by writing the @code{asm} (or @code{__asm__})
6020 keyword after the declarator as follows:
6021
6022 @smallexample
6023 int foo asm ("myfoo") = 2;
6024 @end smallexample
6025
6026 @noindent
6027 This specifies that the name to be used for the variable @code{foo} in
6028 the assembler code should be @samp{myfoo} rather than the usual
6029 @samp{_foo}.
6030
6031 On systems where an underscore is normally prepended to the name of a C
6032 function or variable, this feature allows you to define names for the
6033 linker that do not start with an underscore.
6034
6035 It does not make sense to use this feature with a non-static local
6036 variable since such variables do not have assembler names.  If you are
6037 trying to put the variable in a particular register, see @ref{Explicit
6038 Reg Vars}.  GCC presently accepts such code with a warning, but will
6039 probably be changed to issue an error, rather than a warning, in the
6040 future.
6041
6042 You cannot use @code{asm} in this way in a function @emph{definition}; but
6043 you can get the same effect by writing a declaration for the function
6044 before its definition and putting @code{asm} there, like this:
6045
6046 @smallexample
6047 extern func () asm ("FUNC");
6048
6049 func (x, y)
6050      int x, y;
6051 /* @r{@dots{}} */
6052 @end smallexample
6053
6054 It is up to you to make sure that the assembler names you choose do not
6055 conflict with any other assembler symbols.  Also, you must not use a
6056 register name; that would produce completely invalid assembler code.  GCC
6057 does not as yet have the ability to store static variables in registers.
6058 Perhaps that will be added.
6059
6060 @node Explicit Reg Vars
6061 @section Variables in Specified Registers
6062 @cindex explicit register variables
6063 @cindex variables in specified registers
6064 @cindex specified registers
6065 @cindex registers, global allocation
6066
6067 GNU C allows you to put a few global variables into specified hardware
6068 registers.  You can also specify the register in which an ordinary
6069 register variable should be allocated.
6070
6071 @itemize @bullet
6072 @item
6073 Global register variables reserve registers throughout the program.
6074 This may be useful in programs such as programming language
6075 interpreters which have a couple of global variables that are accessed
6076 very often.
6077
6078 @item
6079 Local register variables in specific registers do not reserve the
6080 registers, except at the point where they are used as input or output
6081 operands in an @code{asm} statement and the @code{asm} statement itself is
6082 not deleted.  The compiler's data flow analysis is capable of determining
6083 where the specified registers contain live values, and where they are
6084 available for other uses.  Stores into local register variables may be deleted
6085 when they appear to be dead according to dataflow analysis.  References
6086 to local register variables may be deleted or moved or simplified.
6087
6088 These local variables are sometimes convenient for use with the extended
6089 @code{asm} feature (@pxref{Extended Asm}), if you want to write one
6090 output of the assembler instruction directly into a particular register.
6091 (This will work provided the register you specify fits the constraints
6092 specified for that operand in the @code{asm}.)
6093 @end itemize
6094
6095 @menu
6096 * Global Reg Vars::
6097 * Local Reg Vars::
6098 @end menu
6099
6100 @node Global Reg Vars
6101 @subsection Defining Global Register Variables
6102 @cindex global register variables
6103 @cindex registers, global variables in
6104
6105 You can define a global register variable in GNU C like this:
6106
6107 @smallexample
6108 register int *foo asm ("a5");
6109 @end smallexample
6110
6111 @noindent
6112 Here @code{a5} is the name of the register which should be used.  Choose a
6113 register which is normally saved and restored by function calls on your
6114 machine, so that library routines will not clobber it.
6115
6116 Naturally the register name is cpu-dependent, so you would need to
6117 conditionalize your program according to cpu type.  The register
6118 @code{a5} would be a good choice on a 68000 for a variable of pointer
6119 type.  On machines with register windows, be sure to choose a ``global''
6120 register that is not affected magically by the function call mechanism.
6121
6122 In addition, operating systems on one type of cpu may differ in how they
6123 name the registers; then you would need additional conditionals.  For
6124 example, some 68000 operating systems call this register @code{%a5}.
6125
6126 Eventually there may be a way of asking the compiler to choose a register
6127 automatically, but first we need to figure out how it should choose and
6128 how to enable you to guide the choice.  No solution is evident.
6129
6130 Defining a global register variable in a certain register reserves that
6131 register entirely for this use, at least within the current compilation.
6132 The register will not be allocated for any other purpose in the functions
6133 in the current compilation.  The register will not be saved and restored by
6134 these functions.  Stores into this register are never deleted even if they
6135 would appear to be dead, but references may be deleted or moved or
6136 simplified.
6137
6138 It is not safe to access the global register variables from signal
6139 handlers, or from more than one thread of control, because the system
6140 library routines may temporarily use the register for other things (unless
6141 you recompile them specially for the task at hand).
6142
6143 @cindex @code{qsort}, and global register variables
6144 It is not safe for one function that uses a global register variable to
6145 call another such function @code{foo} by way of a third function
6146 @code{lose} that was compiled without knowledge of this variable (i.e.@: in a
6147 different source file in which the variable wasn't declared).  This is
6148 because @code{lose} might save the register and put some other value there.
6149 For example, you can't expect a global register variable to be available in
6150 the comparison-function that you pass to @code{qsort}, since @code{qsort}
6151 might have put something else in that register.  (If you are prepared to
6152 recompile @code{qsort} with the same global register variable, you can
6153 solve this problem.)
6154
6155 If you want to recompile @code{qsort} or other source files which do not
6156 actually use your global register variable, so that they will not use that
6157 register for any other purpose, then it suffices to specify the compiler
6158 option @option{-ffixed-@var{reg}}.  You need not actually add a global
6159 register declaration to their source code.
6160
6161 A function which can alter the value of a global register variable cannot
6162 safely be called from a function compiled without this variable, because it
6163 could clobber the value the caller expects to find there on return.
6164 Therefore, the function which is the entry point into the part of the
6165 program that uses the global register variable must explicitly save and
6166 restore the value which belongs to its caller.
6167
6168 @cindex register variable after @code{longjmp}
6169 @cindex global register after @code{longjmp}
6170 @cindex value after @code{longjmp}
6171 @findex longjmp
6172 @findex setjmp
6173 On most machines, @code{longjmp} will restore to each global register
6174 variable the value it had at the time of the @code{setjmp}.  On some
6175 machines, however, @code{longjmp} will not change the value of global
6176 register variables.  To be portable, the function that called @code{setjmp}
6177 should make other arrangements to save the values of the global register
6178 variables, and to restore them in a @code{longjmp}.  This way, the same
6179 thing will happen regardless of what @code{longjmp} does.
6180
6181 All global register variable declarations must precede all function
6182 definitions.  If such a declaration could appear after function
6183 definitions, the declaration would be too late to prevent the register from
6184 being used for other purposes in the preceding functions.
6185
6186 Global register variables may not have initial values, because an
6187 executable file has no means to supply initial contents for a register.
6188
6189 On the SPARC, there are reports that g3 @dots{} g7 are suitable
6190 registers, but certain library functions, such as @code{getwd}, as well
6191 as the subroutines for division and remainder, modify g3 and g4.  g1 and
6192 g2 are local temporaries.
6193
6194 On the 68000, a2 @dots{} a5 should be suitable, as should d2 @dots{} d7.
6195 Of course, it will not do to use more than a few of those.
6196
6197 @node Local Reg Vars
6198 @subsection Specifying Registers for Local Variables
6199 @cindex local variables, specifying registers
6200 @cindex specifying registers for local variables
6201 @cindex registers for local variables
6202
6203 You can define a local register variable with a specified register
6204 like this:
6205
6206 @smallexample
6207 register int *foo asm ("a5");
6208 @end smallexample
6209
6210 @noindent
6211 Here @code{a5} is the name of the register which should be used.  Note
6212 that this is the same syntax used for defining global register
6213 variables, but for a local variable it would appear within a function.
6214
6215 Naturally the register name is cpu-dependent, but this is not a
6216 problem, since specific registers are most often useful with explicit
6217 assembler instructions (@pxref{Extended Asm}).  Both of these things
6218 generally require that you conditionalize your program according to
6219 cpu type.
6220
6221 In addition, operating systems on one type of cpu may differ in how they
6222 name the registers; then you would need additional conditionals.  For
6223 example, some 68000 operating systems call this register @code{%a5}.
6224
6225 Defining such a register variable does not reserve the register; it
6226 remains available for other uses in places where flow control determines
6227 the variable's value is not live.
6228
6229 This option does not guarantee that GCC will generate code that has
6230 this variable in the register you specify at all times.  You may not
6231 code an explicit reference to this register in the @emph{assembler
6232 instruction template} part of an @code{asm} statement and assume it will
6233 always refer to this variable.  However, using the variable as an
6234 @code{asm} @emph{operand} guarantees that the specified register is used
6235 for the operand.
6236
6237 Stores into local register variables may be deleted when they appear to be dead
6238 according to dataflow analysis.  References to local register variables may
6239 be deleted or moved or simplified.
6240
6241 As for global register variables, it's recommended that you choose a
6242 register which is normally saved and restored by function calls on
6243 your machine, so that library routines will not clobber it.  A common
6244 pitfall is to initialize multiple call-clobbered registers with
6245 arbitrary expressions, where a function call or library call for an
6246 arithmetic operator will overwrite a register value from a previous
6247 assignment, for example @code{r0} below:
6248 @smallexample
6249 register int *p1 asm ("r0") = @dots{};
6250 register int *p2 asm ("r1") = @dots{};
6251 @end smallexample
6252 In those cases, a solution is to use a temporary variable for
6253 each arbitrary expression.   @xref{Example of asm with clobbered asm reg}.
6254
6255 @node Alternate Keywords
6256 @section Alternate Keywords
6257 @cindex alternate keywords
6258 @cindex keywords, alternate
6259
6260 @option{-ansi} and the various @option{-std} options disable certain
6261 keywords.  This causes trouble when you want to use GNU C extensions, or
6262 a general-purpose header file that should be usable by all programs,
6263 including ISO C programs.  The keywords @code{asm}, @code{typeof} and
6264 @code{inline} are not available in programs compiled with
6265 @option{-ansi} or @option{-std} (although @code{inline} can be used in a
6266 program compiled with @option{-std=c99} or @option{-std=c1x}).  The
6267 ISO C99 keyword
6268 @code{restrict} is only available when @option{-std=gnu99} (which will
6269 eventually be the default) or @option{-std=c99} (or the equivalent
6270 @option{-std=iso9899:1999}), or an option for a later standard
6271 version, is used.
6272
6273 The way to solve these problems is to put @samp{__} at the beginning and
6274 end of each problematical keyword.  For example, use @code{__asm__}
6275 instead of @code{asm}, and @code{__inline__} instead of @code{inline}.
6276
6277 Other C compilers won't accept these alternative keywords; if you want to
6278 compile with another compiler, you can define the alternate keywords as
6279 macros to replace them with the customary keywords.  It looks like this:
6280
6281 @smallexample
6282 #ifndef __GNUC__
6283 #define __asm__ asm
6284 #endif
6285 @end smallexample
6286
6287 @findex __extension__
6288 @opindex pedantic
6289 @option{-pedantic} and other options cause warnings for many GNU C extensions.
6290 You can
6291 prevent such warnings within one expression by writing
6292 @code{__extension__} before the expression.  @code{__extension__} has no
6293 effect aside from this.
6294
6295 @node Incomplete Enums
6296 @section Incomplete @code{enum} Types
6297
6298 You can define an @code{enum} tag without specifying its possible values.
6299 This results in an incomplete type, much like what you get if you write
6300 @code{struct foo} without describing the elements.  A later declaration
6301 which does specify the possible values completes the type.
6302
6303 You can't allocate variables or storage using the type while it is
6304 incomplete.  However, you can work with pointers to that type.
6305
6306 This extension may not be very useful, but it makes the handling of
6307 @code{enum} more consistent with the way @code{struct} and @code{union}
6308 are handled.
6309
6310 This extension is not supported by GNU C++.
6311
6312 @node Function Names
6313 @section Function Names as Strings
6314 @cindex @code{__func__} identifier
6315 @cindex @code{__FUNCTION__} identifier
6316 @cindex @code{__PRETTY_FUNCTION__} identifier
6317
6318 GCC provides three magic variables which hold the name of the current
6319 function, as a string.  The first of these is @code{__func__}, which
6320 is part of the C99 standard:
6321
6322 The identifier @code{__func__} is implicitly declared by the translator
6323 as if, immediately following the opening brace of each function
6324 definition, the declaration
6325
6326 @smallexample
6327 static const char __func__[] = "function-name";
6328 @end smallexample
6329
6330 @noindent
6331 appeared, where function-name is the name of the lexically-enclosing
6332 function.  This name is the unadorned name of the function.
6333
6334 @code{__FUNCTION__} is another name for @code{__func__}.  Older
6335 versions of GCC recognize only this name.  However, it is not
6336 standardized.  For maximum portability, we recommend you use
6337 @code{__func__}, but provide a fallback definition with the
6338 preprocessor:
6339
6340 @smallexample
6341 #if __STDC_VERSION__ < 199901L
6342 # if __GNUC__ >= 2
6343 #  define __func__ __FUNCTION__
6344 # else
6345 #  define __func__ "<unknown>"
6346 # endif
6347 #endif
6348 @end smallexample
6349
6350 In C, @code{__PRETTY_FUNCTION__} is yet another name for
6351 @code{__func__}.  However, in C++, @code{__PRETTY_FUNCTION__} contains
6352 the type signature of the function as well as its bare name.  For
6353 example, this program:
6354
6355 @smallexample
6356 extern "C" @{
6357 extern int printf (char *, ...);
6358 @}
6359
6360 class a @{
6361  public:
6362   void sub (int i)
6363     @{
6364       printf ("__FUNCTION__ = %s\n", __FUNCTION__);
6365       printf ("__PRETTY_FUNCTION__ = %s\n", __PRETTY_FUNCTION__);
6366     @}
6367 @};
6368
6369 int
6370 main (void)
6371 @{
6372   a ax;
6373   ax.sub (0);
6374   return 0;
6375 @}
6376 @end smallexample
6377
6378 @noindent
6379 gives this output:
6380
6381 @smallexample
6382 __FUNCTION__ = sub
6383 __PRETTY_FUNCTION__ = void a::sub(int)
6384 @end smallexample
6385
6386 These identifiers are not preprocessor macros.  In GCC 3.3 and
6387 earlier, in C only, @code{__FUNCTION__} and @code{__PRETTY_FUNCTION__}
6388 were treated as string literals; they could be used to initialize
6389 @code{char} arrays, and they could be concatenated with other string
6390 literals.  GCC 3.4 and later treat them as variables, like
6391 @code{__func__}.  In C++, @code{__FUNCTION__} and
6392 @code{__PRETTY_FUNCTION__} have always been variables.
6393
6394 @node Return Address
6395 @section Getting the Return or Frame Address of a Function
6396
6397 These functions may be used to get information about the callers of a
6398 function.
6399
6400 @deftypefn {Built-in Function} {void *} __builtin_return_address (unsigned int @var{level})
6401 This function returns the return address of the current function, or of
6402 one of its callers.  The @var{level} argument is number of frames to
6403 scan up the call stack.  A value of @code{0} yields the return address
6404 of the current function, a value of @code{1} yields the return address
6405 of the caller of the current function, and so forth.  When inlining
6406 the expected behavior is that the function will return the address of
6407 the function that will be returned to.  To work around this behavior use
6408 the @code{noinline} function attribute.
6409
6410 The @var{level} argument must be a constant integer.
6411
6412 On some machines it may be impossible to determine the return address of
6413 any function other than the current one; in such cases, or when the top
6414 of the stack has been reached, this function will return @code{0} or a
6415 random value.  In addition, @code{__builtin_frame_address} may be used
6416 to determine if the top of the stack has been reached.
6417
6418 Additional post-processing of the returned value may be needed, see
6419 @code{__builtin_extract_return_address}.
6420
6421 This function should only be used with a nonzero argument for debugging
6422 purposes.
6423 @end deftypefn
6424
6425 @deftypefn {Built-in Function} {void *} __builtin_extract_return_address (void *@var{addr})
6426 The address as returned by @code{__builtin_return_address} may have to be fed
6427 through this function to get the actual encoded address.  For example, on the
6428 31-bit S/390 platform the highest bit has to be masked out, or on SPARC
6429 platforms an offset has to be added for the true next instruction to be
6430 executed.
6431
6432 If no fixup is needed, this function simply passes through @var{addr}.
6433 @end deftypefn
6434
6435 @deftypefn {Built-in Function} {void *} __builtin_frob_return_address (void *@var{addr})
6436 This function does the reverse of @code{__builtin_extract_return_address}.
6437 @end deftypefn
6438
6439 @deftypefn {Built-in Function} {void *} __builtin_frame_address (unsigned int @var{level})
6440 This function is similar to @code{__builtin_return_address}, but it
6441 returns the address of the function frame rather than the return address
6442 of the function.  Calling @code{__builtin_frame_address} with a value of
6443 @code{0} yields the frame address of the current function, a value of
6444 @code{1} yields the frame address of the caller of the current function,
6445 and so forth.
6446
6447 The frame is the area on the stack which holds local variables and saved
6448 registers.  The frame address is normally the address of the first word
6449 pushed on to the stack by the function.  However, the exact definition
6450 depends upon the processor and the calling convention.  If the processor
6451 has a dedicated frame pointer register, and the function has a frame,
6452 then @code{__builtin_frame_address} will return the value of the frame
6453 pointer register.
6454
6455 On some machines it may be impossible to determine the frame address of
6456 any function other than the current one; in such cases, or when the top
6457 of the stack has been reached, this function will return @code{0} if
6458 the first frame pointer is properly initialized by the startup code.
6459
6460 This function should only be used with a nonzero argument for debugging
6461 purposes.
6462 @end deftypefn
6463
6464 @node Vector Extensions
6465 @section Using vector instructions through built-in functions
6466
6467 On some targets, the instruction set contains SIMD vector instructions that
6468 operate on multiple values contained in one large register at the same time.
6469 For example, on the i386 the MMX, 3DNow!@: and SSE extensions can be used
6470 this way.
6471
6472 The first step in using these extensions is to provide the necessary data
6473 types.  This should be done using an appropriate @code{typedef}:
6474
6475 @smallexample
6476 typedef int v4si __attribute__ ((vector_size (16)));
6477 @end smallexample
6478
6479 The @code{int} type specifies the base type, while the attribute specifies
6480 the vector size for the variable, measured in bytes.  For example, the
6481 declaration above causes the compiler to set the mode for the @code{v4si}
6482 type to be 16 bytes wide and divided into @code{int} sized units.  For
6483 a 32-bit @code{int} this means a vector of 4 units of 4 bytes, and the
6484 corresponding mode of @code{foo} will be @acronym{V4SI}.
6485
6486 The @code{vector_size} attribute is only applicable to integral and
6487 float scalars, although arrays, pointers, and function return values
6488 are allowed in conjunction with this construct.
6489
6490 All the basic integer types can be used as base types, both as signed
6491 and as unsigned: @code{char}, @code{short}, @code{int}, @code{long},
6492 @code{long long}.  In addition, @code{float} and @code{double} can be
6493 used to build floating-point vector types.
6494
6495 Specifying a combination that is not valid for the current architecture
6496 will cause GCC to synthesize the instructions using a narrower mode.
6497 For example, if you specify a variable of type @code{V4SI} and your
6498 architecture does not allow for this specific SIMD type, GCC will
6499 produce code that uses 4 @code{SIs}.
6500
6501 The types defined in this manner can be used with a subset of normal C
6502 operations.  Currently, GCC will allow using the following operators
6503 on these types: @code{+, -, *, /, unary minus, ^, |, &, ~, %}@.
6504
6505 The operations behave like C++ @code{valarrays}.  Addition is defined as
6506 the addition of the corresponding elements of the operands.  For
6507 example, in the code below, each of the 4 elements in @var{a} will be
6508 added to the corresponding 4 elements in @var{b} and the resulting
6509 vector will be stored in @var{c}.
6510
6511 @smallexample
6512 typedef int v4si __attribute__ ((vector_size (16)));
6513
6514 v4si a, b, c;
6515
6516 c = a + b;
6517 @end smallexample
6518
6519 Subtraction, multiplication, division, and the logical operations
6520 operate in a similar manner.  Likewise, the result of using the unary
6521 minus or complement operators on a vector type is a vector whose
6522 elements are the negative or complemented values of the corresponding
6523 elements in the operand.
6524
6525 In C it is possible to use shifting operators @code{<<}, @code{>>} on
6526 integer-type vectors. The operation is defined as following: @code{@{a0,
6527 a1, @dots{}, an@} >> @{b0, b1, @dots{}, bn@} == @{a0 >> b0, a1 >> b1,
6528 @dots{}, an >> bn@}}@. Vector operands must have the same number of
6529 elements.  Additionally second operands can be a scalar integer in which
6530 case the scalar is converted to the type used by the vector operand (with
6531 possible truncation) and each element of this new vector is the scalar's
6532 value.
6533 Consider the following code.
6534
6535 @smallexample
6536 typedef int v4si __attribute__ ((vector_size (16)));
6537
6538 v4si a, b;
6539
6540 b = a >> 1;     /* b = a >> @{1,1,1,1@}; */
6541 @end smallexample
6542
6543 In C vectors can be subscripted as if the vector were an array with
6544 the same number of elements and base type.  Out of bound accesses
6545 invoke undefined behavior at runtime.  Warnings for out of bound
6546 accesses for vector subscription can be enabled with
6547 @option{-Warray-bounds}.
6548
6549 You can declare variables and use them in function calls and returns, as
6550 well as in assignments and some casts.  You can specify a vector type as
6551 a return type for a function.  Vector types can also be used as function
6552 arguments.  It is possible to cast from one vector type to another,
6553 provided they are of the same size (in fact, you can also cast vectors
6554 to and from other datatypes of the same size).
6555
6556 You cannot operate between vectors of different lengths or different
6557 signedness without a cast.
6558
6559 A port that supports hardware vector operations, usually provides a set
6560 of built-in functions that can be used to operate on vectors.  For
6561 example, a function to add two vectors and multiply the result by a
6562 third could look like this:
6563
6564 @smallexample
6565 v4si f (v4si a, v4si b, v4si c)
6566 @{
6567   v4si tmp = __builtin_addv4si (a, b);
6568   return __builtin_mulv4si (tmp, c);
6569 @}
6570
6571 @end smallexample
6572
6573 @node Offsetof
6574 @section Offsetof
6575 @findex __builtin_offsetof
6576
6577 GCC implements for both C and C++ a syntactic extension to implement
6578 the @code{offsetof} macro.
6579
6580 @smallexample
6581 primary:
6582         "__builtin_offsetof" "(" @code{typename} "," offsetof_member_designator ")"
6583
6584 offsetof_member_designator:
6585           @code{identifier}
6586         | offsetof_member_designator "." @code{identifier}
6587         | offsetof_member_designator "[" @code{expr} "]"
6588 @end smallexample
6589
6590 This extension is sufficient such that
6591
6592 @smallexample
6593 #define offsetof(@var{type}, @var{member})  __builtin_offsetof (@var{type}, @var{member})
6594 @end smallexample
6595
6596 is a suitable definition of the @code{offsetof} macro.  In C++, @var{type}
6597 may be dependent.  In either case, @var{member} may consist of a single
6598 identifier, or a sequence of member accesses and array references.
6599
6600 @node Atomic Builtins
6601 @section Built-in functions for atomic memory access
6602
6603 The following builtins are intended to be compatible with those described
6604 in the @cite{Intel Itanium Processor-specific Application Binary Interface},
6605 section 7.4.  As such, they depart from the normal GCC practice of using
6606 the ``__builtin_'' prefix, and further that they are overloaded such that
6607 they work on multiple types.
6608
6609 The definition given in the Intel documentation allows only for the use of
6610 the types @code{int}, @code{long}, @code{long long} as well as their unsigned
6611 counterparts.  GCC will allow any integral scalar or pointer type that is
6612 1, 2, 4 or 8 bytes in length.
6613
6614 Not all operations are supported by all target processors.  If a particular
6615 operation cannot be implemented on the target processor, a warning will be
6616 generated and a call an external function will be generated.  The external
6617 function will carry the same name as the builtin, with an additional suffix
6618 @samp{_@var{n}} where @var{n} is the size of the data type.
6619
6620 @c ??? Should we have a mechanism to suppress this warning?  This is almost
6621 @c useful for implementing the operation under the control of an external
6622 @c mutex.
6623
6624 In most cases, these builtins are considered a @dfn{full barrier}.  That is,
6625 no memory operand will be moved across the operation, either forward or
6626 backward.  Further, instructions will be issued as necessary to prevent the
6627 processor from speculating loads across the operation and from queuing stores
6628 after the operation.
6629
6630 All of the routines are described in the Intel documentation to take
6631 ``an optional list of variables protected by the memory barrier''.  It's
6632 not clear what is meant by that; it could mean that @emph{only} the
6633 following variables are protected, or it could mean that these variables
6634 should in addition be protected.  At present GCC ignores this list and
6635 protects all variables which are globally accessible.  If in the future
6636 we make some use of this list, an empty list will continue to mean all
6637 globally accessible variables.
6638
6639 @table @code
6640 @item @var{type} __sync_fetch_and_add (@var{type} *ptr, @var{type} value, ...)
6641 @itemx @var{type} __sync_fetch_and_sub (@var{type} *ptr, @var{type} value, ...)
6642 @itemx @var{type} __sync_fetch_and_or (@var{type} *ptr, @var{type} value, ...)
6643 @itemx @var{type} __sync_fetch_and_and (@var{type} *ptr, @var{type} value, ...)
6644 @itemx @var{type} __sync_fetch_and_xor (@var{type} *ptr, @var{type} value, ...)
6645 @itemx @var{type} __sync_fetch_and_nand (@var{type} *ptr, @var{type} value, ...)
6646 @findex __sync_fetch_and_add
6647 @findex __sync_fetch_and_sub
6648 @findex __sync_fetch_and_or
6649 @findex __sync_fetch_and_and
6650 @findex __sync_fetch_and_xor
6651 @findex __sync_fetch_and_nand
6652 These builtins perform the operation suggested by the name, and
6653 returns the value that had previously been in memory.  That is,
6654
6655 @smallexample
6656 @{ tmp = *ptr; *ptr @var{op}= value; return tmp; @}
6657 @{ tmp = *ptr; *ptr = ~(tmp & value); return tmp; @}   // nand
6658 @end smallexample
6659
6660 @emph{Note:} GCC 4.4 and later implement @code{__sync_fetch_and_nand}
6661 builtin as @code{*ptr = ~(tmp & value)} instead of @code{*ptr = ~tmp & value}.
6662
6663 @item @var{type} __sync_add_and_fetch (@var{type} *ptr, @var{type} value, ...)
6664 @itemx @var{type} __sync_sub_and_fetch (@var{type} *ptr, @var{type} value, ...)
6665 @itemx @var{type} __sync_or_and_fetch (@var{type} *ptr, @var{type} value, ...)
6666 @itemx @var{type} __sync_and_and_fetch (@var{type} *ptr, @var{type} value, ...)
6667 @itemx @var{type} __sync_xor_and_fetch (@var{type} *ptr, @var{type} value, ...)
6668 @itemx @var{type} __sync_nand_and_fetch (@var{type} *ptr, @var{type} value, ...)
6669 @findex __sync_add_and_fetch
6670 @findex __sync_sub_and_fetch
6671 @findex __sync_or_and_fetch
6672 @findex __sync_and_and_fetch
6673 @findex __sync_xor_and_fetch
6674 @findex __sync_nand_and_fetch
6675 These builtins perform the operation suggested by the name, and
6676 return the new value.  That is,
6677
6678 @smallexample
6679 @{ *ptr @var{op}= value; return *ptr; @}
6680 @{ *ptr = ~(*ptr & value); return *ptr; @}   // nand
6681 @end smallexample
6682
6683 @emph{Note:} GCC 4.4 and later implement @code{__sync_nand_and_fetch}
6684 builtin as @code{*ptr = ~(*ptr & value)} instead of
6685 @code{*ptr = ~*ptr & value}.
6686
6687 @item bool __sync_bool_compare_and_swap (@var{type} *ptr, @var{type} oldval @var{type} newval, ...)
6688 @itemx @var{type} __sync_val_compare_and_swap (@var{type} *ptr, @var{type} oldval @var{type} newval, ...)
6689 @findex __sync_bool_compare_and_swap
6690 @findex __sync_val_compare_and_swap
6691 These builtins perform an atomic compare and swap.  That is, if the current
6692 value of @code{*@var{ptr}} is @var{oldval}, then write @var{newval} into
6693 @code{*@var{ptr}}.
6694
6695 The ``bool'' version returns true if the comparison is successful and
6696 @var{newval} was written.  The ``val'' version returns the contents
6697 of @code{*@var{ptr}} before the operation.
6698
6699 @item __sync_synchronize (...)
6700 @findex __sync_synchronize
6701 This builtin issues a full memory barrier.
6702
6703 @item @var{type} __sync_lock_test_and_set (@var{type} *ptr, @var{type} value, ...)
6704 @findex __sync_lock_test_and_set
6705 This builtin, as described by Intel, is not a traditional test-and-set
6706 operation, but rather an atomic exchange operation.  It writes @var{value}
6707 into @code{*@var{ptr}}, and returns the previous contents of
6708 @code{*@var{ptr}}.
6709
6710 Many targets have only minimal support for such locks, and do not support
6711 a full exchange operation.  In this case, a target may support reduced
6712 functionality here by which the @emph{only} valid value to store is the
6713 immediate constant 1.  The exact value actually stored in @code{*@var{ptr}}
6714 is implementation defined.
6715
6716 This builtin is not a full barrier, but rather an @dfn{acquire barrier}.
6717 This means that references after the builtin cannot move to (or be
6718 speculated to) before the builtin, but previous memory stores may not
6719 be globally visible yet, and previous memory loads may not yet be
6720 satisfied.
6721
6722 @item void __sync_lock_release (@var{type} *ptr, ...)
6723 @findex __sync_lock_release
6724 This builtin releases the lock acquired by @code{__sync_lock_test_and_set}.
6725 Normally this means writing the constant 0 to @code{*@var{ptr}}.
6726
6727 This builtin is not a full barrier, but rather a @dfn{release barrier}.
6728 This means that all previous memory stores are globally visible, and all
6729 previous memory loads have been satisfied, but following memory reads
6730 are not prevented from being speculated to before the barrier.
6731 @end table
6732
6733 @node Object Size Checking
6734 @section Object Size Checking Builtins
6735 @findex __builtin_object_size
6736 @findex __builtin___memcpy_chk
6737 @findex __builtin___mempcpy_chk
6738 @findex __builtin___memmove_chk
6739 @findex __builtin___memset_chk
6740 @findex __builtin___strcpy_chk
6741 @findex __builtin___stpcpy_chk
6742 @findex __builtin___strncpy_chk
6743 @findex __builtin___strcat_chk
6744 @findex __builtin___strncat_chk
6745 @findex __builtin___sprintf_chk
6746 @findex __builtin___snprintf_chk
6747 @findex __builtin___vsprintf_chk
6748 @findex __builtin___vsnprintf_chk
6749 @findex __builtin___printf_chk
6750 @findex __builtin___vprintf_chk
6751 @findex __builtin___fprintf_chk
6752 @findex __builtin___vfprintf_chk
6753
6754 GCC implements a limited buffer overflow protection mechanism
6755 that can prevent some buffer overflow attacks.
6756
6757 @deftypefn {Built-in Function} {size_t} __builtin_object_size (void * @var{ptr}, int @var{type})
6758 is a built-in construct that returns a constant number of bytes from
6759 @var{ptr} to the end of the object @var{ptr} pointer points to
6760 (if known at compile time).  @code{__builtin_object_size} never evaluates
6761 its arguments for side-effects.  If there are any side-effects in them, it
6762 returns @code{(size_t) -1} for @var{type} 0 or 1 and @code{(size_t) 0}
6763 for @var{type} 2 or 3.  If there are multiple objects @var{ptr} can
6764 point to and all of them are known at compile time, the returned number
6765 is the maximum of remaining byte counts in those objects if @var{type} & 2 is
6766 0 and minimum if nonzero.  If it is not possible to determine which objects
6767 @var{ptr} points to at compile time, @code{__builtin_object_size} should
6768 return @code{(size_t) -1} for @var{type} 0 or 1 and @code{(size_t) 0}
6769 for @var{type} 2 or 3.
6770
6771 @var{type} is an integer constant from 0 to 3.  If the least significant
6772 bit is clear, objects are whole variables, if it is set, a closest
6773 surrounding subobject is considered the object a pointer points to.
6774 The second bit determines if maximum or minimum of remaining bytes
6775 is computed.
6776
6777 @smallexample
6778 struct V @{ char buf1[10]; int b; char buf2[10]; @} var;
6779 char *p = &var.buf1[1], *q = &var.b;
6780
6781 /* Here the object p points to is var.  */
6782 assert (__builtin_object_size (p, 0) == sizeof (var) - 1);
6783 /* The subobject p points to is var.buf1.  */
6784 assert (__builtin_object_size (p, 1) == sizeof (var.buf1) - 1);
6785 /* The object q points to is var.  */
6786 assert (__builtin_object_size (q, 0)
6787         == (char *) (&var + 1) - (char *) &var.b);
6788 /* The subobject q points to is var.b.  */
6789 assert (__builtin_object_size (q, 1) == sizeof (var.b));
6790 @end smallexample
6791 @end deftypefn
6792
6793 There are built-in functions added for many common string operation
6794 functions, e.g., for @code{memcpy} @code{__builtin___memcpy_chk}
6795 built-in is provided.  This built-in has an additional last argument,
6796 which is the number of bytes remaining in object the @var{dest}
6797 argument points to or @code{(size_t) -1} if the size is not known.
6798
6799 The built-in functions are optimized into the normal string functions
6800 like @code{memcpy} if the last argument is @code{(size_t) -1} or if
6801 it is known at compile time that the destination object will not
6802 be overflown.  If the compiler can determine at compile time the
6803 object will be always overflown, it issues a warning.
6804
6805 The intended use can be e.g.
6806
6807 @smallexample
6808 #undef memcpy
6809 #define bos0(dest) __builtin_object_size (dest, 0)
6810 #define memcpy(dest, src, n) \
6811   __builtin___memcpy_chk (dest, src, n, bos0 (dest))
6812
6813 char *volatile p;
6814 char buf[10];
6815 /* It is unknown what object p points to, so this is optimized
6816    into plain memcpy - no checking is possible.  */
6817 memcpy (p, "abcde", n);
6818 /* Destination is known and length too.  It is known at compile
6819    time there will be no overflow.  */
6820 memcpy (&buf[5], "abcde", 5);
6821 /* Destination is known, but the length is not known at compile time.
6822    This will result in __memcpy_chk call that can check for overflow
6823    at runtime.  */
6824 memcpy (&buf[5], "abcde", n);
6825 /* Destination is known and it is known at compile time there will
6826    be overflow.  There will be a warning and __memcpy_chk call that
6827    will abort the program at runtime.  */
6828 memcpy (&buf[6], "abcde", 5);
6829 @end smallexample
6830
6831 Such built-in functions are provided for @code{memcpy}, @code{mempcpy},
6832 @code{memmove}, @code{memset}, @code{strcpy}, @code{stpcpy}, @code{strncpy},
6833 @code{strcat} and @code{strncat}.
6834
6835 There are also checking built-in functions for formatted output functions.
6836 @smallexample
6837 int __builtin___sprintf_chk (char *s, int flag, size_t os, const char *fmt, ...);
6838 int __builtin___snprintf_chk (char *s, size_t maxlen, int flag, size_t os,
6839                               const char *fmt, ...);
6840 int __builtin___vsprintf_chk (char *s, int flag, size_t os, const char *fmt,
6841                               va_list ap);
6842 int __builtin___vsnprintf_chk (char *s, size_t maxlen, int flag, size_t os,
6843                                const char *fmt, va_list ap);
6844 @end smallexample
6845
6846 The added @var{flag} argument is passed unchanged to @code{__sprintf_chk}
6847 etc.@: functions and can contain implementation specific flags on what
6848 additional security measures the checking function might take, such as
6849 handling @code{%n} differently.
6850
6851 The @var{os} argument is the object size @var{s} points to, like in the
6852 other built-in functions.  There is a small difference in the behavior
6853 though, if @var{os} is @code{(size_t) -1}, the built-in functions are
6854 optimized into the non-checking functions only if @var{flag} is 0, otherwise
6855 the checking function is called with @var{os} argument set to
6856 @code{(size_t) -1}.
6857
6858 In addition to this, there are checking built-in functions
6859 @code{__builtin___printf_chk}, @code{__builtin___vprintf_chk},
6860 @code{__builtin___fprintf_chk} and @code{__builtin___vfprintf_chk}.
6861 These have just one additional argument, @var{flag}, right before
6862 format string @var{fmt}.  If the compiler is able to optimize them to
6863 @code{fputc} etc.@: functions, it will, otherwise the checking function
6864 should be called and the @var{flag} argument passed to it.
6865
6866 @node Other Builtins
6867 @section Other built-in functions provided by GCC
6868 @cindex built-in functions
6869 @findex __builtin_fpclassify
6870 @findex __builtin_isfinite
6871 @findex __builtin_isnormal
6872 @findex __builtin_isgreater
6873 @findex __builtin_isgreaterequal
6874 @findex __builtin_isinf_sign
6875 @findex __builtin_isless
6876 @findex __builtin_islessequal
6877 @findex __builtin_islessgreater
6878 @findex __builtin_isunordered
6879 @findex __builtin_powi
6880 @findex __builtin_powif
6881 @findex __builtin_powil
6882 @findex _Exit
6883 @findex _exit
6884 @findex abort
6885 @findex abs
6886 @findex acos
6887 @findex acosf
6888 @findex acosh
6889 @findex acoshf
6890 @findex acoshl
6891 @findex acosl
6892 @findex alloca
6893 @findex asin
6894 @findex asinf
6895 @findex asinh
6896 @findex asinhf
6897 @findex asinhl
6898 @findex asinl
6899 @findex atan
6900 @findex atan2
6901 @findex atan2f
6902 @findex atan2l
6903 @findex atanf
6904 @findex atanh
6905 @findex atanhf
6906 @findex atanhl
6907 @findex atanl
6908 @findex bcmp
6909 @findex bzero
6910 @findex cabs
6911 @findex cabsf
6912 @findex cabsl
6913 @findex cacos
6914 @findex cacosf
6915 @findex cacosh
6916 @findex cacoshf
6917 @findex cacoshl
6918 @findex cacosl
6919 @findex calloc
6920 @findex carg
6921 @findex cargf
6922 @findex cargl
6923 @findex casin
6924 @findex casinf
6925 @findex casinh
6926 @findex casinhf
6927 @findex casinhl
6928 @findex casinl
6929 @findex catan
6930 @findex catanf
6931 @findex catanh
6932 @findex catanhf
6933 @findex catanhl
6934 @findex catanl
6935 @findex cbrt
6936 @findex cbrtf
6937 @findex cbrtl
6938 @findex ccos
6939 @findex ccosf
6940 @findex ccosh
6941 @findex ccoshf
6942 @findex ccoshl
6943 @findex ccosl
6944 @findex ceil
6945 @findex ceilf
6946 @findex ceill
6947 @findex cexp
6948 @findex cexpf
6949 @findex cexpl
6950 @findex cimag
6951 @findex cimagf
6952 @findex cimagl
6953 @findex clog
6954 @findex clogf
6955 @findex clogl
6956 @findex conj
6957 @findex conjf
6958 @findex conjl
6959 @findex copysign
6960 @findex copysignf
6961 @findex copysignl
6962 @findex cos
6963 @findex cosf
6964 @findex cosh
6965 @findex coshf
6966 @findex coshl
6967 @findex cosl
6968 @findex cpow
6969 @findex cpowf
6970 @findex cpowl
6971 @findex cproj
6972 @findex cprojf
6973 @findex cprojl
6974 @findex creal
6975 @findex crealf
6976 @findex creall
6977 @findex csin
6978 @findex csinf
6979 @findex csinh
6980 @findex csinhf
6981 @findex csinhl
6982 @findex csinl
6983 @findex csqrt
6984 @findex csqrtf
6985 @findex csqrtl
6986 @findex ctan
6987 @findex ctanf
6988 @findex ctanh
6989 @findex ctanhf
6990 @findex ctanhl
6991 @findex ctanl
6992 @findex dcgettext
6993 @findex dgettext
6994 @findex drem
6995 @findex dremf
6996 @findex dreml
6997 @findex erf
6998 @findex erfc
6999 @findex erfcf
7000 @findex erfcl
7001 @findex erff
7002 @findex erfl
7003 @findex exit
7004 @findex exp
7005 @findex exp10
7006 @findex exp10f
7007 @findex exp10l
7008 @findex exp2
7009 @findex exp2f
7010 @findex exp2l
7011 @findex expf
7012 @findex expl
7013 @findex expm1
7014 @findex expm1f
7015 @findex expm1l
7016 @findex fabs
7017 @findex fabsf
7018 @findex fabsl
7019 @findex fdim
7020 @findex fdimf
7021 @findex fdiml
7022 @findex ffs
7023 @findex floor
7024 @findex floorf
7025 @findex floorl
7026 @findex fma
7027 @findex fmaf
7028 @findex fmal
7029 @findex fmax
7030 @findex fmaxf
7031 @findex fmaxl
7032 @findex fmin
7033 @findex fminf
7034 @findex fminl
7035 @findex fmod
7036 @findex fmodf
7037 @findex fmodl
7038 @findex fprintf
7039 @findex fprintf_unlocked
7040 @findex fputs
7041 @findex fputs_unlocked
7042 @findex frexp
7043 @findex frexpf
7044 @findex frexpl
7045 @findex fscanf
7046 @findex gamma
7047 @findex gammaf
7048 @findex gammal
7049 @findex gamma_r
7050 @findex gammaf_r
7051 @findex gammal_r
7052 @findex gettext
7053 @findex hypot
7054 @findex hypotf
7055 @findex hypotl
7056 @findex ilogb
7057 @findex ilogbf
7058 @findex ilogbl
7059 @findex imaxabs
7060 @findex index
7061 @findex isalnum
7062 @findex isalpha
7063 @findex isascii
7064 @findex isblank
7065 @findex iscntrl
7066 @findex isdigit
7067 @findex isgraph
7068 @findex islower
7069 @findex isprint
7070 @findex ispunct
7071 @findex isspace
7072 @findex isupper
7073 @findex iswalnum
7074 @findex iswalpha
7075 @findex iswblank
7076 @findex iswcntrl
7077 @findex iswdigit
7078 @findex iswgraph
7079 @findex iswlower
7080 @findex iswprint
7081 @findex iswpunct
7082 @findex iswspace
7083 @findex iswupper
7084 @findex iswxdigit
7085 @findex isxdigit
7086 @findex j0
7087 @findex j0f
7088 @findex j0l
7089 @findex j1
7090 @findex j1f
7091 @findex j1l
7092 @findex jn
7093 @findex jnf
7094 @findex jnl
7095 @findex labs
7096 @findex ldexp
7097 @findex ldexpf
7098 @findex ldexpl
7099 @findex lgamma
7100 @findex lgammaf
7101 @findex lgammal
7102 @findex lgamma_r
7103 @findex lgammaf_r
7104 @findex lgammal_r
7105 @findex llabs
7106 @findex llrint
7107 @findex llrintf
7108 @findex llrintl
7109 @findex llround
7110 @findex llroundf
7111 @findex llroundl
7112 @findex log
7113 @findex log10
7114 @findex log10f
7115 @findex log10l
7116 @findex log1p
7117 @findex log1pf
7118 @findex log1pl
7119 @findex log2
7120 @findex log2f
7121 @findex log2l
7122 @findex logb
7123 @findex logbf
7124 @findex logbl
7125 @findex logf
7126 @findex logl
7127 @findex lrint
7128 @findex lrintf
7129 @findex lrintl
7130 @findex lround
7131 @findex lroundf
7132 @findex lroundl
7133 @findex malloc
7134 @findex memchr
7135 @findex memcmp
7136 @findex memcpy
7137 @findex mempcpy
7138 @findex memset
7139 @findex modf
7140 @findex modff
7141 @findex modfl
7142 @findex nearbyint
7143 @findex nearbyintf
7144 @findex nearbyintl
7145 @findex nextafter
7146 @findex nextafterf
7147 @findex nextafterl
7148 @findex nexttoward
7149 @findex nexttowardf
7150 @findex nexttowardl
7151 @findex pow
7152 @findex pow10
7153 @findex pow10f
7154 @findex pow10l
7155 @findex powf
7156 @findex powl
7157 @findex printf
7158 @findex printf_unlocked
7159 @findex putchar
7160 @findex puts
7161 @findex remainder
7162 @findex remainderf
7163 @findex remainderl
7164 @findex remquo
7165 @findex remquof
7166 @findex remquol
7167 @findex rindex
7168 @findex rint
7169 @findex rintf
7170 @findex rintl
7171 @findex round
7172 @findex roundf
7173 @findex roundl
7174 @findex scalb
7175 @findex scalbf
7176 @findex scalbl
7177 @findex scalbln
7178 @findex scalblnf
7179 @findex scalblnf
7180 @findex scalbn
7181 @findex scalbnf
7182 @findex scanfnl
7183 @findex signbit
7184 @findex signbitf
7185 @findex signbitl
7186 @findex signbitd32
7187 @findex signbitd64
7188 @findex signbitd128
7189 @findex significand
7190 @findex significandf
7191 @findex significandl
7192 @findex sin
7193 @findex sincos
7194 @findex sincosf
7195 @findex sincosl
7196 @findex sinf
7197 @findex sinh
7198 @findex sinhf
7199 @findex sinhl
7200 @findex sinl
7201 @findex snprintf
7202 @findex sprintf
7203 @findex sqrt
7204 @findex sqrtf
7205 @findex sqrtl
7206 @findex sscanf
7207 @findex stpcpy
7208 @findex stpncpy
7209 @findex strcasecmp
7210 @findex strcat
7211 @findex strchr
7212 @findex strcmp
7213 @findex strcpy
7214 @findex strcspn
7215 @findex strdup
7216 @findex strfmon
7217 @findex strftime
7218 @findex strlen
7219 @findex strncasecmp
7220 @findex strncat
7221 @findex strncmp
7222 @findex strncpy
7223 @findex strndup
7224 @findex strpbrk
7225 @findex strrchr
7226 @findex strspn
7227 @findex strstr
7228 @findex tan
7229 @findex tanf
7230 @findex tanh
7231 @findex tanhf
7232 @findex tanhl
7233 @findex tanl
7234 @findex tgamma
7235 @findex tgammaf
7236 @findex tgammal
7237 @findex toascii
7238 @findex tolower
7239 @findex toupper
7240 @findex towlower
7241 @findex towupper
7242 @findex trunc
7243 @findex truncf
7244 @findex truncl
7245 @findex vfprintf
7246 @findex vfscanf
7247 @findex vprintf
7248 @findex vscanf
7249 @findex vsnprintf
7250 @findex vsprintf
7251 @findex vsscanf
7252 @findex y0
7253 @findex y0f
7254 @findex y0l
7255 @findex y1
7256 @findex y1f
7257 @findex y1l
7258 @findex yn
7259 @findex ynf
7260 @findex ynl
7261
7262 GCC provides a large number of built-in functions other than the ones
7263 mentioned above.  Some of these are for internal use in the processing
7264 of exceptions or variable-length argument lists and will not be
7265 documented here because they may change from time to time; we do not
7266 recommend general use of these functions.
7267
7268 The remaining functions are provided for optimization purposes.
7269
7270 @opindex fno-builtin
7271 GCC includes built-in versions of many of the functions in the standard
7272 C library.  The versions prefixed with @code{__builtin_} will always be
7273 treated as having the same meaning as the C library function even if you
7274 specify the @option{-fno-builtin} option.  (@pxref{C Dialect Options})
7275 Many of these functions are only optimized in certain cases; if they are
7276 not optimized in a particular case, a call to the library function will
7277 be emitted.
7278
7279 @opindex ansi
7280 @opindex std
7281 Outside strict ISO C mode (@option{-ansi}, @option{-std=c90},
7282 @option{-std=c99} or @option{-std=c1x}), the functions
7283 @code{_exit}, @code{alloca}, @code{bcmp}, @code{bzero},
7284 @code{dcgettext}, @code{dgettext}, @code{dremf}, @code{dreml},
7285 @code{drem}, @code{exp10f}, @code{exp10l}, @code{exp10}, @code{ffsll},
7286 @code{ffsl}, @code{ffs}, @code{fprintf_unlocked},
7287 @code{fputs_unlocked}, @code{gammaf}, @code{gammal}, @code{gamma},
7288 @code{gammaf_r}, @code{gammal_r}, @code{gamma_r}, @code{gettext},
7289 @code{index}, @code{isascii}, @code{j0f}, @code{j0l}, @code{j0},
7290 @code{j1f}, @code{j1l}, @code{j1}, @code{jnf}, @code{jnl}, @code{jn},
7291 @code{lgammaf_r}, @code{lgammal_r}, @code{lgamma_r}, @code{mempcpy},
7292 @code{pow10f}, @code{pow10l}, @code{pow10}, @code{printf_unlocked},
7293 @code{rindex}, @code{scalbf}, @code{scalbl}, @code{scalb},
7294 @code{signbit}, @code{signbitf}, @code{signbitl}, @code{signbitd32},
7295 @code{signbitd64}, @code{signbitd128}, @code{significandf},
7296 @code{significandl}, @code{significand}, @code{sincosf},
7297 @code{sincosl}, @code{sincos}, @code{stpcpy}, @code{stpncpy},
7298 @code{strcasecmp}, @code{strdup}, @code{strfmon}, @code{strncasecmp},
7299 @code{strndup}, @code{toascii}, @code{y0f}, @code{y0l}, @code{y0},
7300 @code{y1f}, @code{y1l}, @code{y1}, @code{ynf}, @code{ynl} and
7301 @code{yn}
7302 may be handled as built-in functions.
7303 All these functions have corresponding versions
7304 prefixed with @code{__builtin_}, which may be used even in strict C90
7305 mode.
7306
7307 The ISO C99 functions
7308 @code{_Exit}, @code{acoshf}, @code{acoshl}, @code{acosh}, @code{asinhf},
7309 @code{asinhl}, @code{asinh}, @code{atanhf}, @code{atanhl}, @code{atanh},
7310 @code{cabsf}, @code{cabsl}, @code{cabs}, @code{cacosf}, @code{cacoshf},
7311 @code{cacoshl}, @code{cacosh}, @code{cacosl}, @code{cacos},
7312 @code{cargf}, @code{cargl}, @code{carg}, @code{casinf}, @code{casinhf},
7313 @code{casinhl}, @code{casinh}, @code{casinl}, @code{casin},
7314 @code{catanf}, @code{catanhf}, @code{catanhl}, @code{catanh},
7315 @code{catanl}, @code{catan}, @code{cbrtf}, @code{cbrtl}, @code{cbrt},
7316 @code{ccosf}, @code{ccoshf}, @code{ccoshl}, @code{ccosh}, @code{ccosl},
7317 @code{ccos}, @code{cexpf}, @code{cexpl}, @code{cexp}, @code{cimagf},
7318 @code{cimagl}, @code{cimag}, @code{clogf}, @code{clogl}, @code{clog},
7319 @code{conjf}, @code{conjl}, @code{conj}, @code{copysignf}, @code{copysignl},
7320 @code{copysign}, @code{cpowf}, @code{cpowl}, @code{cpow}, @code{cprojf},
7321 @code{cprojl}, @code{cproj}, @code{crealf}, @code{creall}, @code{creal},
7322 @code{csinf}, @code{csinhf}, @code{csinhl}, @code{csinh}, @code{csinl},
7323 @code{csin}, @code{csqrtf}, @code{csqrtl}, @code{csqrt}, @code{ctanf},
7324 @code{ctanhf}, @code{ctanhl}, @code{ctanh}, @code{ctanl}, @code{ctan},
7325 @code{erfcf}, @code{erfcl}, @code{erfc}, @code{erff}, @code{erfl},
7326 @code{erf}, @code{exp2f}, @code{exp2l}, @code{exp2}, @code{expm1f},
7327 @code{expm1l}, @code{expm1}, @code{fdimf}, @code{fdiml}, @code{fdim},
7328 @code{fmaf}, @code{fmal}, @code{fmaxf}, @code{fmaxl}, @code{fmax},
7329 @code{fma}, @code{fminf}, @code{fminl}, @code{fmin}, @code{hypotf},
7330 @code{hypotl}, @code{hypot}, @code{ilogbf}, @code{ilogbl}, @code{ilogb},
7331 @code{imaxabs}, @code{isblank}, @code{iswblank}, @code{lgammaf},
7332 @code{lgammal}, @code{lgamma}, @code{llabs}, @code{llrintf}, @code{llrintl},
7333 @code{llrint}, @code{llroundf}, @code{llroundl}, @code{llround},
7334 @code{log1pf}, @code{log1pl}, @code{log1p}, @code{log2f}, @code{log2l},
7335 @code{log2}, @code{logbf}, @code{logbl}, @code{logb}, @code{lrintf},
7336 @code{lrintl}, @code{lrint}, @code{lroundf}, @code{lroundl},
7337 @code{lround}, @code{nearbyintf}, @code{nearbyintl}, @code{nearbyint},
7338 @code{nextafterf}, @code{nextafterl}, @code{nextafter},
7339 @code{nexttowardf}, @code{nexttowardl}, @code{nexttoward},
7340 @code{remainderf}, @code{remainderl}, @code{remainder}, @code{remquof},
7341 @code{remquol}, @code{remquo}, @code{rintf}, @code{rintl}, @code{rint},
7342 @code{roundf}, @code{roundl}, @code{round}, @code{scalblnf},
7343 @code{scalblnl}, @code{scalbln}, @code{scalbnf}, @code{scalbnl},
7344 @code{scalbn}, @code{snprintf}, @code{tgammaf}, @code{tgammal},
7345 @code{tgamma}, @code{truncf}, @code{truncl}, @code{trunc},
7346 @code{vfscanf}, @code{vscanf}, @code{vsnprintf} and @code{vsscanf}
7347 are handled as built-in functions
7348 except in strict ISO C90 mode (@option{-ansi} or @option{-std=c90}).
7349
7350 There are also built-in versions of the ISO C99 functions
7351 @code{acosf}, @code{acosl}, @code{asinf}, @code{asinl}, @code{atan2f},
7352 @code{atan2l}, @code{atanf}, @code{atanl}, @code{ceilf}, @code{ceill},
7353 @code{cosf}, @code{coshf}, @code{coshl}, @code{cosl}, @code{expf},
7354 @code{expl}, @code{fabsf}, @code{fabsl}, @code{floorf}, @code{floorl},
7355 @code{fmodf}, @code{fmodl}, @code{frexpf}, @code{frexpl}, @code{ldexpf},
7356 @code{ldexpl}, @code{log10f}, @code{log10l}, @code{logf}, @code{logl},
7357 @code{modfl}, @code{modf}, @code{powf}, @code{powl}, @code{sinf},
7358 @code{sinhf}, @code{sinhl}, @code{sinl}, @code{sqrtf}, @code{sqrtl},
7359 @code{tanf}, @code{tanhf}, @code{tanhl} and @code{tanl}
7360 that are recognized in any mode since ISO C90 reserves these names for
7361 the purpose to which ISO C99 puts them.  All these functions have
7362 corresponding versions prefixed with @code{__builtin_}.
7363
7364 The ISO C94 functions
7365 @code{iswalnum}, @code{iswalpha}, @code{iswcntrl}, @code{iswdigit},
7366 @code{iswgraph}, @code{iswlower}, @code{iswprint}, @code{iswpunct},
7367 @code{iswspace}, @code{iswupper}, @code{iswxdigit}, @code{towlower} and
7368 @code{towupper}
7369 are handled as built-in functions
7370 except in strict ISO C90 mode (@option{-ansi} or @option{-std=c90}).
7371
7372 The ISO C90 functions
7373 @code{abort}, @code{abs}, @code{acos}, @code{asin}, @code{atan2},
7374 @code{atan}, @code{calloc}, @code{ceil}, @code{cosh}, @code{cos},
7375 @code{exit}, @code{exp}, @code{fabs}, @code{floor}, @code{fmod},
7376 @code{fprintf}, @code{fputs}, @code{frexp}, @code{fscanf},
7377 @code{isalnum}, @code{isalpha}, @code{iscntrl}, @code{isdigit},
7378 @code{isgraph}, @code{islower}, @code{isprint}, @code{ispunct},
7379 @code{isspace}, @code{isupper}, @code{isxdigit}, @code{tolower},
7380 @code{toupper}, @code{labs}, @code{ldexp}, @code{log10}, @code{log},
7381 @code{malloc}, @code{memchr}, @code{memcmp}, @code{memcpy},
7382 @code{memset}, @code{modf}, @code{pow}, @code{printf}, @code{putchar},
7383 @code{puts}, @code{scanf}, @code{sinh}, @code{sin}, @code{snprintf},
7384 @code{sprintf}, @code{sqrt}, @code{sscanf}, @code{strcat},
7385 @code{strchr}, @code{strcmp}, @code{strcpy}, @code{strcspn},
7386 @code{strlen}, @code{strncat}, @code{strncmp}, @code{strncpy},
7387 @code{strpbrk}, @code{strrchr}, @code{strspn}, @code{strstr},
7388 @code{tanh}, @code{tan}, @code{vfprintf}, @code{vprintf} and @code{vsprintf}
7389 are all recognized as built-in functions unless
7390 @option{-fno-builtin} is specified (or @option{-fno-builtin-@var{function}}
7391 is specified for an individual function).  All of these functions have
7392 corresponding versions prefixed with @code{__builtin_}.
7393
7394 GCC provides built-in versions of the ISO C99 floating point comparison
7395 macros that avoid raising exceptions for unordered operands.  They have
7396 the same names as the standard macros ( @code{isgreater},
7397 @code{isgreaterequal}, @code{isless}, @code{islessequal},
7398 @code{islessgreater}, and @code{isunordered}) , with @code{__builtin_}
7399 prefixed.  We intend for a library implementor to be able to simply
7400 @code{#define} each standard macro to its built-in equivalent.
7401 In the same fashion, GCC provides @code{fpclassify}, @code{isfinite},
7402 @code{isinf_sign} and @code{isnormal} built-ins used with
7403 @code{__builtin_} prefixed.  The @code{isinf} and @code{isnan}
7404 builtins appear both with and without the @code{__builtin_} prefix.
7405
7406 @deftypefn {Built-in Function} int __builtin_types_compatible_p (@var{type1}, @var{type2})
7407
7408 You can use the built-in function @code{__builtin_types_compatible_p} to
7409 determine whether two types are the same.
7410
7411 This built-in function returns 1 if the unqualified versions of the
7412 types @var{type1} and @var{type2} (which are types, not expressions) are
7413 compatible, 0 otherwise.  The result of this built-in function can be
7414 used in integer constant expressions.
7415
7416 This built-in function ignores top level qualifiers (e.g., @code{const},
7417 @code{volatile}).  For example, @code{int} is equivalent to @code{const
7418 int}.
7419
7420 The type @code{int[]} and @code{int[5]} are compatible.  On the other
7421 hand, @code{int} and @code{char *} are not compatible, even if the size
7422 of their types, on the particular architecture are the same.  Also, the
7423 amount of pointer indirection is taken into account when determining
7424 similarity.  Consequently, @code{short *} is not similar to
7425 @code{short **}.  Furthermore, two types that are typedefed are
7426 considered compatible if their underlying types are compatible.
7427
7428 An @code{enum} type is not considered to be compatible with another
7429 @code{enum} type even if both are compatible with the same integer
7430 type; this is what the C standard specifies.
7431 For example, @code{enum @{foo, bar@}} is not similar to
7432 @code{enum @{hot, dog@}}.
7433
7434 You would typically use this function in code whose execution varies
7435 depending on the arguments' types.  For example:
7436
7437 @smallexample
7438 #define foo(x)                                                  \
7439   (@{                                                           \
7440     typeof (x) tmp = (x);                                       \
7441     if (__builtin_types_compatible_p (typeof (x), long double)) \
7442       tmp = foo_long_double (tmp);                              \
7443     else if (__builtin_types_compatible_p (typeof (x), double)) \
7444       tmp = foo_double (tmp);                                   \
7445     else if (__builtin_types_compatible_p (typeof (x), float))  \
7446       tmp = foo_float (tmp);                                    \
7447     else                                                        \
7448       abort ();                                                 \
7449     tmp;                                                        \
7450   @})
7451 @end smallexample
7452
7453 @emph{Note:} This construct is only available for C@.
7454
7455 @end deftypefn
7456
7457 @deftypefn {Built-in Function} @var{type} __builtin_choose_expr (@var{const_exp}, @var{exp1}, @var{exp2})
7458
7459 You can use the built-in function @code{__builtin_choose_expr} to
7460 evaluate code depending on the value of a constant expression.  This
7461 built-in function returns @var{exp1} if @var{const_exp}, which is an
7462 integer constant expression, is nonzero.  Otherwise it returns @var{exp2}.
7463
7464 This built-in function is analogous to the @samp{? :} operator in C,
7465 except that the expression returned has its type unaltered by promotion
7466 rules.  Also, the built-in function does not evaluate the expression
7467 that was not chosen.  For example, if @var{const_exp} evaluates to true,
7468 @var{exp2} is not evaluated even if it has side-effects.
7469
7470 This built-in function can return an lvalue if the chosen argument is an
7471 lvalue.
7472
7473 If @var{exp1} is returned, the return type is the same as @var{exp1}'s
7474 type.  Similarly, if @var{exp2} is returned, its return type is the same
7475 as @var{exp2}.
7476
7477 Example:
7478
7479 @smallexample
7480 #define foo(x)                                                    \
7481   __builtin_choose_expr (                                         \
7482     __builtin_types_compatible_p (typeof (x), double),            \
7483     foo_double (x),                                               \
7484     __builtin_choose_expr (                                       \
7485       __builtin_types_compatible_p (typeof (x), float),           \
7486       foo_float (x),                                              \
7487       /* @r{The void expression results in a compile-time error}  \
7488          @r{when assigning the result to something.}  */          \
7489       (void)0))
7490 @end smallexample
7491
7492 @emph{Note:} This construct is only available for C@.  Furthermore, the
7493 unused expression (@var{exp1} or @var{exp2} depending on the value of
7494 @var{const_exp}) may still generate syntax errors.  This may change in
7495 future revisions.
7496
7497 @end deftypefn
7498
7499 @deftypefn {Built-in Function} int __builtin_constant_p (@var{exp})
7500 You can use the built-in function @code{__builtin_constant_p} to
7501 determine if a value is known to be constant at compile-time and hence
7502 that GCC can perform constant-folding on expressions involving that
7503 value.  The argument of the function is the value to test.  The function
7504 returns the integer 1 if the argument is known to be a compile-time
7505 constant and 0 if it is not known to be a compile-time constant.  A
7506 return of 0 does not indicate that the value is @emph{not} a constant,
7507 but merely that GCC cannot prove it is a constant with the specified
7508 value of the @option{-O} option.
7509
7510 You would typically use this function in an embedded application where
7511 memory was a critical resource.  If you have some complex calculation,
7512 you may want it to be folded if it involves constants, but need to call
7513 a function if it does not.  For example:
7514
7515 @smallexample
7516 #define Scale_Value(X)      \
7517   (__builtin_constant_p (X) \
7518   ? ((X) * SCALE + OFFSET) : Scale (X))
7519 @end smallexample
7520
7521 You may use this built-in function in either a macro or an inline
7522 function.  However, if you use it in an inlined function and pass an
7523 argument of the function as the argument to the built-in, GCC will
7524 never return 1 when you call the inline function with a string constant
7525 or compound literal (@pxref{Compound Literals}) and will not return 1
7526 when you pass a constant numeric value to the inline function unless you
7527 specify the @option{-O} option.
7528
7529 You may also use @code{__builtin_constant_p} in initializers for static
7530 data.  For instance, you can write
7531
7532 @smallexample
7533 static const int table[] = @{
7534    __builtin_constant_p (EXPRESSION) ? (EXPRESSION) : -1,
7535    /* @r{@dots{}} */
7536 @};
7537 @end smallexample
7538
7539 @noindent
7540 This is an acceptable initializer even if @var{EXPRESSION} is not a
7541 constant expression, including the case where
7542 @code{__builtin_constant_p} returns 1 because @var{EXPRESSION} can be
7543 folded to a constant but @var{EXPRESSION} contains operands that would
7544 not otherwise be permitted in a static initializer (for example,
7545 @code{0 && foo ()}).  GCC must be more conservative about evaluating the
7546 built-in in this case, because it has no opportunity to perform
7547 optimization.
7548
7549 Previous versions of GCC did not accept this built-in in data
7550 initializers.  The earliest version where it is completely safe is
7551 3.0.1.
7552 @end deftypefn
7553
7554 @deftypefn {Built-in Function} long __builtin_expect (long @var{exp}, long @var{c})
7555 @opindex fprofile-arcs
7556 You may use @code{__builtin_expect} to provide the compiler with
7557 branch prediction information.  In general, you should prefer to
7558 use actual profile feedback for this (@option{-fprofile-arcs}), as
7559 programmers are notoriously bad at predicting how their programs
7560 actually perform.  However, there are applications in which this
7561 data is hard to collect.
7562
7563 The return value is the value of @var{exp}, which should be an integral
7564 expression.  The semantics of the built-in are that it is expected that
7565 @var{exp} == @var{c}.  For example:
7566
7567 @smallexample
7568 if (__builtin_expect (x, 0))
7569   foo ();
7570 @end smallexample
7571
7572 @noindent
7573 would indicate that we do not expect to call @code{foo}, since
7574 we expect @code{x} to be zero.  Since you are limited to integral
7575 expressions for @var{exp}, you should use constructions such as
7576
7577 @smallexample
7578 if (__builtin_expect (ptr != NULL, 1))
7579   error ();
7580 @end smallexample
7581
7582 @noindent
7583 when testing pointer or floating-point values.
7584 @end deftypefn
7585
7586 @deftypefn {Built-in Function} void __builtin_trap (void)
7587 This function causes the program to exit abnormally.  GCC implements
7588 this function by using a target-dependent mechanism (such as
7589 intentionally executing an illegal instruction) or by calling
7590 @code{abort}.  The mechanism used may vary from release to release so
7591 you should not rely on any particular implementation.
7592 @end deftypefn
7593
7594 @deftypefn {Built-in Function} void __builtin_unreachable (void)
7595 If control flow reaches the point of the @code{__builtin_unreachable},
7596 the program is undefined.  It is useful in situations where the
7597 compiler cannot deduce the unreachability of the code.
7598
7599 One such case is immediately following an @code{asm} statement that
7600 will either never terminate, or one that transfers control elsewhere
7601 and never returns.  In this example, without the
7602 @code{__builtin_unreachable}, GCC would issue a warning that control
7603 reaches the end of a non-void function.  It would also generate code
7604 to return after the @code{asm}.
7605
7606 @smallexample
7607 int f (int c, int v)
7608 @{
7609   if (c)
7610     @{
7611       return v;
7612     @}
7613   else
7614     @{
7615       asm("jmp error_handler");
7616       __builtin_unreachable ();
7617     @}
7618 @}
7619 @end smallexample
7620
7621 Because the @code{asm} statement unconditionally transfers control out
7622 of the function, control will never reach the end of the function
7623 body.  The @code{__builtin_unreachable} is in fact unreachable and
7624 communicates this fact to the compiler.
7625
7626 Another use for @code{__builtin_unreachable} is following a call a
7627 function that never returns but that is not declared
7628 @code{__attribute__((noreturn))}, as in this example:
7629
7630 @smallexample
7631 void function_that_never_returns (void);
7632
7633 int g (int c)
7634 @{
7635   if (c)
7636     @{
7637       return 1;
7638     @}
7639   else
7640     @{
7641       function_that_never_returns ();
7642       __builtin_unreachable ();
7643     @}
7644 @}
7645 @end smallexample
7646
7647 @end deftypefn
7648
7649 @deftypefn {Built-in Function} void __builtin___clear_cache (char *@var{begin}, char *@var{end})
7650 This function is used to flush the processor's instruction cache for
7651 the region of memory between @var{begin} inclusive and @var{end}
7652 exclusive.  Some targets require that the instruction cache be
7653 flushed, after modifying memory containing code, in order to obtain
7654 deterministic behavior.
7655
7656 If the target does not require instruction cache flushes,
7657 @code{__builtin___clear_cache} has no effect.  Otherwise either
7658 instructions are emitted in-line to clear the instruction cache or a
7659 call to the @code{__clear_cache} function in libgcc is made.
7660 @end deftypefn
7661
7662 @deftypefn {Built-in Function} void __builtin_prefetch (const void *@var{addr}, ...)
7663 This function is used to minimize cache-miss latency by moving data into
7664 a cache before it is accessed.
7665 You can insert calls to @code{__builtin_prefetch} into code for which
7666 you know addresses of data in memory that is likely to be accessed soon.
7667 If the target supports them, data prefetch instructions will be generated.
7668 If the prefetch is done early enough before the access then the data will
7669 be in the cache by the time it is accessed.
7670
7671 The value of @var{addr} is the address of the memory to prefetch.
7672 There are two optional arguments, @var{rw} and @var{locality}.
7673 The value of @var{rw} is a compile-time constant one or zero; one
7674 means that the prefetch is preparing for a write to the memory address
7675 and zero, the default, means that the prefetch is preparing for a read.
7676 The value @var{locality} must be a compile-time constant integer between
7677 zero and three.  A value of zero means that the data has no temporal
7678 locality, so it need not be left in the cache after the access.  A value
7679 of three means that the data has a high degree of temporal locality and
7680 should be left in all levels of cache possible.  Values of one and two
7681 mean, respectively, a low or moderate degree of temporal locality.  The
7682 default is three.
7683
7684 @smallexample
7685 for (i = 0; i < n; i++)
7686   @{
7687     a[i] = a[i] + b[i];
7688     __builtin_prefetch (&a[i+j], 1, 1);
7689     __builtin_prefetch (&b[i+j], 0, 1);
7690     /* @r{@dots{}} */
7691   @}
7692 @end smallexample
7693
7694 Data prefetch does not generate faults if @var{addr} is invalid, but
7695 the address expression itself must be valid.  For example, a prefetch
7696 of @code{p->next} will not fault if @code{p->next} is not a valid
7697 address, but evaluation will fault if @code{p} is not a valid address.
7698
7699 If the target does not support data prefetch, the address expression
7700 is evaluated if it includes side effects but no other code is generated
7701 and GCC does not issue a warning.
7702 @end deftypefn
7703
7704 @deftypefn {Built-in Function} double __builtin_huge_val (void)
7705 Returns a positive infinity, if supported by the floating-point format,
7706 else @code{DBL_MAX}.  This function is suitable for implementing the
7707 ISO C macro @code{HUGE_VAL}.
7708 @end deftypefn
7709
7710 @deftypefn {Built-in Function} float __builtin_huge_valf (void)
7711 Similar to @code{__builtin_huge_val}, except the return type is @code{float}.
7712 @end deftypefn
7713
7714 @deftypefn {Built-in Function} {long double} __builtin_huge_vall (void)
7715 Similar to @code{__builtin_huge_val}, except the return
7716 type is @code{long double}.
7717 @end deftypefn
7718
7719 @deftypefn {Built-in Function} int __builtin_fpclassify (int, int, int, int, int, ...)
7720 This built-in implements the C99 fpclassify functionality.  The first
7721 five int arguments should be the target library's notion of the
7722 possible FP classes and are used for return values.  They must be
7723 constant values and they must appear in this order: @code{FP_NAN},
7724 @code{FP_INFINITE}, @code{FP_NORMAL}, @code{FP_SUBNORMAL} and
7725 @code{FP_ZERO}.  The ellipsis is for exactly one floating point value
7726 to classify.  GCC treats the last argument as type-generic, which
7727 means it does not do default promotion from float to double.
7728 @end deftypefn
7729
7730 @deftypefn {Built-in Function} double __builtin_inf (void)
7731 Similar to @code{__builtin_huge_val}, except a warning is generated
7732 if the target floating-point format does not support infinities.
7733 @end deftypefn
7734
7735 @deftypefn {Built-in Function} _Decimal32 __builtin_infd32 (void)
7736 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal32}.
7737 @end deftypefn
7738
7739 @deftypefn {Built-in Function} _Decimal64 __builtin_infd64 (void)
7740 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal64}.
7741 @end deftypefn
7742
7743 @deftypefn {Built-in Function} _Decimal128 __builtin_infd128 (void)
7744 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal128}.
7745 @end deftypefn
7746
7747 @deftypefn {Built-in Function} float __builtin_inff (void)
7748 Similar to @code{__builtin_inf}, except the return type is @code{float}.
7749 This function is suitable for implementing the ISO C99 macro @code{INFINITY}.
7750 @end deftypefn
7751
7752 @deftypefn {Built-in Function} {long double} __builtin_infl (void)
7753 Similar to @code{__builtin_inf}, except the return
7754 type is @code{long double}.
7755 @end deftypefn
7756
7757 @deftypefn {Built-in Function} int __builtin_isinf_sign (...)
7758 Similar to @code{isinf}, except the return value will be negative for
7759 an argument of @code{-Inf}.  Note while the parameter list is an
7760 ellipsis, this function only accepts exactly one floating point
7761 argument.  GCC treats this parameter as type-generic, which means it
7762 does not do default promotion from float to double.
7763 @end deftypefn
7764
7765 @deftypefn {Built-in Function} double __builtin_nan (const char *str)
7766 This is an implementation of the ISO C99 function @code{nan}.
7767
7768 Since ISO C99 defines this function in terms of @code{strtod}, which we
7769 do not implement, a description of the parsing is in order.  The string
7770 is parsed as by @code{strtol}; that is, the base is recognized by
7771 leading @samp{0} or @samp{0x} prefixes.  The number parsed is placed
7772 in the significand such that the least significant bit of the number
7773 is at the least significant bit of the significand.  The number is
7774 truncated to fit the significand field provided.  The significand is
7775 forced to be a quiet NaN@.
7776
7777 This function, if given a string literal all of which would have been
7778 consumed by strtol, is evaluated early enough that it is considered a
7779 compile-time constant.
7780 @end deftypefn
7781
7782 @deftypefn {Built-in Function} _Decimal32 __builtin_nand32 (const char *str)
7783 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal32}.
7784 @end deftypefn
7785
7786 @deftypefn {Built-in Function} _Decimal64 __builtin_nand64 (const char *str)
7787 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal64}.
7788 @end deftypefn
7789
7790 @deftypefn {Built-in Function} _Decimal128 __builtin_nand128 (const char *str)
7791 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal128}.
7792 @end deftypefn
7793
7794 @deftypefn {Built-in Function} float __builtin_nanf (const char *str)
7795 Similar to @code{__builtin_nan}, except the return type is @code{float}.
7796 @end deftypefn
7797
7798 @deftypefn {Built-in Function} {long double} __builtin_nanl (const char *str)
7799 Similar to @code{__builtin_nan}, except the return type is @code{long double}.
7800 @end deftypefn
7801
7802 @deftypefn {Built-in Function} double __builtin_nans (const char *str)
7803 Similar to @code{__builtin_nan}, except the significand is forced
7804 to be a signaling NaN@.  The @code{nans} function is proposed by
7805 @uref{http://www.open-std.org/jtc1/sc22/wg14/www/docs/n965.htm,,WG14 N965}.
7806 @end deftypefn
7807
7808 @deftypefn {Built-in Function} float __builtin_nansf (const char *str)
7809 Similar to @code{__builtin_nans}, except the return type is @code{float}.
7810 @end deftypefn
7811
7812 @deftypefn {Built-in Function} {long double} __builtin_nansl (const char *str)
7813 Similar to @code{__builtin_nans}, except the return type is @code{long double}.
7814 @end deftypefn
7815
7816 @deftypefn {Built-in Function} int __builtin_ffs (unsigned int x)
7817 Returns one plus the index of the least significant 1-bit of @var{x}, or
7818 if @var{x} is zero, returns zero.
7819 @end deftypefn
7820
7821 @deftypefn {Built-in Function} int __builtin_clz (unsigned int x)
7822 Returns the number of leading 0-bits in @var{x}, starting at the most
7823 significant bit position.  If @var{x} is 0, the result is undefined.
7824 @end deftypefn
7825
7826 @deftypefn {Built-in Function} int __builtin_ctz (unsigned int x)
7827 Returns the number of trailing 0-bits in @var{x}, starting at the least
7828 significant bit position.  If @var{x} is 0, the result is undefined.
7829 @end deftypefn
7830
7831 @deftypefn {Built-in Function} int __builtin_popcount (unsigned int x)
7832 Returns the number of 1-bits in @var{x}.
7833 @end deftypefn
7834
7835 @deftypefn {Built-in Function} int __builtin_parity (unsigned int x)
7836 Returns the parity of @var{x}, i.e.@: the number of 1-bits in @var{x}
7837 modulo 2.
7838 @end deftypefn
7839
7840 @deftypefn {Built-in Function} int __builtin_ffsl (unsigned long)
7841 Similar to @code{__builtin_ffs}, except the argument type is
7842 @code{unsigned long}.
7843 @end deftypefn
7844
7845 @deftypefn {Built-in Function} int __builtin_clzl (unsigned long)
7846 Similar to @code{__builtin_clz}, except the argument type is
7847 @code{unsigned long}.
7848 @end deftypefn
7849
7850 @deftypefn {Built-in Function} int __builtin_ctzl (unsigned long)
7851 Similar to @code{__builtin_ctz}, except the argument type is
7852 @code{unsigned long}.
7853 @end deftypefn
7854
7855 @deftypefn {Built-in Function} int __builtin_popcountl (unsigned long)
7856 Similar to @code{__builtin_popcount}, except the argument type is
7857 @code{unsigned long}.
7858 @end deftypefn
7859
7860 @deftypefn {Built-in Function} int __builtin_parityl (unsigned long)
7861 Similar to @code{__builtin_parity}, except the argument type is
7862 @code{unsigned long}.
7863 @end deftypefn
7864
7865 @deftypefn {Built-in Function} int __builtin_ffsll (unsigned long long)
7866 Similar to @code{__builtin_ffs}, except the argument type is
7867 @code{unsigned long long}.
7868 @end deftypefn
7869
7870 @deftypefn {Built-in Function} int __builtin_clzll (unsigned long long)
7871 Similar to @code{__builtin_clz}, except the argument type is
7872 @code{unsigned long long}.
7873 @end deftypefn
7874
7875 @deftypefn {Built-in Function} int __builtin_ctzll (unsigned long long)
7876 Similar to @code{__builtin_ctz}, except the argument type is
7877 @code{unsigned long long}.
7878 @end deftypefn
7879
7880 @deftypefn {Built-in Function} int __builtin_popcountll (unsigned long long)
7881 Similar to @code{__builtin_popcount}, except the argument type is
7882 @code{unsigned long long}.
7883 @end deftypefn
7884
7885 @deftypefn {Built-in Function} int __builtin_parityll (unsigned long long)
7886 Similar to @code{__builtin_parity}, except the argument type is
7887 @code{unsigned long long}.
7888 @end deftypefn
7889
7890 @deftypefn {Built-in Function} double __builtin_powi (double, int)
7891 Returns the first argument raised to the power of the second.  Unlike the
7892 @code{pow} function no guarantees about precision and rounding are made.
7893 @end deftypefn
7894
7895 @deftypefn {Built-in Function} float __builtin_powif (float, int)
7896 Similar to @code{__builtin_powi}, except the argument and return types
7897 are @code{float}.
7898 @end deftypefn
7899
7900 @deftypefn {Built-in Function} {long double} __builtin_powil (long double, int)
7901 Similar to @code{__builtin_powi}, except the argument and return types
7902 are @code{long double}.
7903 @end deftypefn
7904
7905 @deftypefn {Built-in Function} int32_t __builtin_bswap32 (int32_t x)
7906 Returns @var{x} with the order of the bytes reversed; for example,
7907 @code{0xaabbccdd} becomes @code{0xddccbbaa}.  Byte here always means
7908 exactly 8 bits.
7909 @end deftypefn
7910
7911 @deftypefn {Built-in Function} int64_t __builtin_bswap64 (int64_t x)
7912 Similar to @code{__builtin_bswap32}, except the argument and return types
7913 are 64-bit.
7914 @end deftypefn
7915
7916 @node Target Builtins
7917 @section Built-in Functions Specific to Particular Target Machines
7918
7919 On some target machines, GCC supports many built-in functions specific
7920 to those machines.  Generally these generate calls to specific machine
7921 instructions, but allow the compiler to schedule those calls.
7922
7923 @menu
7924 * Alpha Built-in Functions::
7925 * ARM iWMMXt Built-in Functions::
7926 * ARM NEON Intrinsics::
7927 * AVR Built-in Functions::
7928 * Blackfin Built-in Functions::
7929 * FR-V Built-in Functions::
7930 * X86 Built-in Functions::
7931 * MIPS DSP Built-in Functions::
7932 * MIPS Paired-Single Support::
7933 * MIPS Loongson Built-in Functions::
7934 * Other MIPS Built-in Functions::
7935 * picoChip Built-in Functions::
7936 * PowerPC AltiVec/VSX Built-in Functions::
7937 * RX Built-in Functions::
7938 * SPARC VIS Built-in Functions::
7939 * SPU Built-in Functions::
7940 @end menu
7941
7942 @node Alpha Built-in Functions
7943 @subsection Alpha Built-in Functions
7944
7945 These built-in functions are available for the Alpha family of
7946 processors, depending on the command-line switches used.
7947
7948 The following built-in functions are always available.  They
7949 all generate the machine instruction that is part of the name.
7950
7951 @smallexample
7952 long __builtin_alpha_implver (void)
7953 long __builtin_alpha_rpcc (void)
7954 long __builtin_alpha_amask (long)
7955 long __builtin_alpha_cmpbge (long, long)
7956 long __builtin_alpha_extbl (long, long)
7957 long __builtin_alpha_extwl (long, long)
7958 long __builtin_alpha_extll (long, long)
7959 long __builtin_alpha_extql (long, long)
7960 long __builtin_alpha_extwh (long, long)
7961 long __builtin_alpha_extlh (long, long)
7962 long __builtin_alpha_extqh (long, long)
7963 long __builtin_alpha_insbl (long, long)
7964 long __builtin_alpha_inswl (long, long)
7965 long __builtin_alpha_insll (long, long)
7966 long __builtin_alpha_insql (long, long)
7967 long __builtin_alpha_inswh (long, long)
7968 long __builtin_alpha_inslh (long, long)
7969 long __builtin_alpha_insqh (long, long)
7970 long __builtin_alpha_mskbl (long, long)
7971 long __builtin_alpha_mskwl (long, long)
7972 long __builtin_alpha_mskll (long, long)
7973 long __builtin_alpha_mskql (long, long)
7974 long __builtin_alpha_mskwh (long, long)
7975 long __builtin_alpha_msklh (long, long)
7976 long __builtin_alpha_mskqh (long, long)
7977 long __builtin_alpha_umulh (long, long)
7978 long __builtin_alpha_zap (long, long)
7979 long __builtin_alpha_zapnot (long, long)
7980 @end smallexample
7981
7982 The following built-in functions are always with @option{-mmax}
7983 or @option{-mcpu=@var{cpu}} where @var{cpu} is @code{pca56} or
7984 later.  They all generate the machine instruction that is part
7985 of the name.
7986
7987 @smallexample
7988 long __builtin_alpha_pklb (long)
7989 long __builtin_alpha_pkwb (long)
7990 long __builtin_alpha_unpkbl (long)
7991 long __builtin_alpha_unpkbw (long)
7992 long __builtin_alpha_minub8 (long, long)
7993 long __builtin_alpha_minsb8 (long, long)
7994 long __builtin_alpha_minuw4 (long, long)
7995 long __builtin_alpha_minsw4 (long, long)
7996 long __builtin_alpha_maxub8 (long, long)
7997 long __builtin_alpha_maxsb8 (long, long)
7998 long __builtin_alpha_maxuw4 (long, long)
7999 long __builtin_alpha_maxsw4 (long, long)
8000 long __builtin_alpha_perr (long, long)
8001 @end smallexample
8002
8003 The following built-in functions are always with @option{-mcix}
8004 or @option{-mcpu=@var{cpu}} where @var{cpu} is @code{ev67} or
8005 later.  They all generate the machine instruction that is part
8006 of the name.
8007
8008 @smallexample
8009 long __builtin_alpha_cttz (long)
8010 long __builtin_alpha_ctlz (long)
8011 long __builtin_alpha_ctpop (long)
8012 @end smallexample
8013
8014 The following builtins are available on systems that use the OSF/1
8015 PALcode.  Normally they invoke the @code{rduniq} and @code{wruniq}
8016 PAL calls, but when invoked with @option{-mtls-kernel}, they invoke
8017 @code{rdval} and @code{wrval}.
8018
8019 @smallexample
8020 void *__builtin_thread_pointer (void)
8021 void __builtin_set_thread_pointer (void *)
8022 @end smallexample
8023
8024 @node ARM iWMMXt Built-in Functions
8025 @subsection ARM iWMMXt Built-in Functions
8026
8027 These built-in functions are available for the ARM family of
8028 processors when the @option{-mcpu=iwmmxt} switch is used:
8029
8030 @smallexample
8031 typedef int v2si __attribute__ ((vector_size (8)));
8032 typedef short v4hi __attribute__ ((vector_size (8)));
8033 typedef char v8qi __attribute__ ((vector_size (8)));
8034
8035 int __builtin_arm_getwcx (int)
8036 void __builtin_arm_setwcx (int, int)
8037 int __builtin_arm_textrmsb (v8qi, int)
8038 int __builtin_arm_textrmsh (v4hi, int)
8039 int __builtin_arm_textrmsw (v2si, int)
8040 int __builtin_arm_textrmub (v8qi, int)
8041 int __builtin_arm_textrmuh (v4hi, int)
8042 int __builtin_arm_textrmuw (v2si, int)
8043 v8qi __builtin_arm_tinsrb (v8qi, int)
8044 v4hi __builtin_arm_tinsrh (v4hi, int)
8045 v2si __builtin_arm_tinsrw (v2si, int)
8046 long long __builtin_arm_tmia (long long, int, int)
8047 long long __builtin_arm_tmiabb (long long, int, int)
8048 long long __builtin_arm_tmiabt (long long, int, int)
8049 long long __builtin_arm_tmiaph (long long, int, int)
8050 long long __builtin_arm_tmiatb (long long, int, int)
8051 long long __builtin_arm_tmiatt (long long, int, int)
8052 int __builtin_arm_tmovmskb (v8qi)
8053 int __builtin_arm_tmovmskh (v4hi)
8054 int __builtin_arm_tmovmskw (v2si)
8055 long long __builtin_arm_waccb (v8qi)
8056 long long __builtin_arm_wacch (v4hi)
8057 long long __builtin_arm_waccw (v2si)
8058 v8qi __builtin_arm_waddb (v8qi, v8qi)
8059 v8qi __builtin_arm_waddbss (v8qi, v8qi)
8060 v8qi __builtin_arm_waddbus (v8qi, v8qi)
8061 v4hi __builtin_arm_waddh (v4hi, v4hi)
8062 v4hi __builtin_arm_waddhss (v4hi, v4hi)
8063 v4hi __builtin_arm_waddhus (v4hi, v4hi)
8064 v2si __builtin_arm_waddw (v2si, v2si)
8065 v2si __builtin_arm_waddwss (v2si, v2si)
8066 v2si __builtin_arm_waddwus (v2si, v2si)
8067 v8qi __builtin_arm_walign (v8qi, v8qi, int)
8068 long long __builtin_arm_wand(long long, long long)
8069 long long __builtin_arm_wandn (long long, long long)
8070 v8qi __builtin_arm_wavg2b (v8qi, v8qi)
8071 v8qi __builtin_arm_wavg2br (v8qi, v8qi)
8072 v4hi __builtin_arm_wavg2h (v4hi, v4hi)
8073 v4hi __builtin_arm_wavg2hr (v4hi, v4hi)
8074 v8qi __builtin_arm_wcmpeqb (v8qi, v8qi)
8075 v4hi __builtin_arm_wcmpeqh (v4hi, v4hi)
8076 v2si __builtin_arm_wcmpeqw (v2si, v2si)
8077 v8qi __builtin_arm_wcmpgtsb (v8qi, v8qi)
8078 v4hi __builtin_arm_wcmpgtsh (v4hi, v4hi)
8079 v2si __builtin_arm_wcmpgtsw (v2si, v2si)
8080 v8qi __builtin_arm_wcmpgtub (v8qi, v8qi)
8081 v4hi __builtin_arm_wcmpgtuh (v4hi, v4hi)
8082 v2si __builtin_arm_wcmpgtuw (v2si, v2si)
8083 long long __builtin_arm_wmacs (long long, v4hi, v4hi)
8084 long long __builtin_arm_wmacsz (v4hi, v4hi)
8085 long long __builtin_arm_wmacu (long long, v4hi, v4hi)
8086 long long __builtin_arm_wmacuz (v4hi, v4hi)
8087 v4hi __builtin_arm_wmadds (v4hi, v4hi)
8088 v4hi __builtin_arm_wmaddu (v4hi, v4hi)
8089 v8qi __builtin_arm_wmaxsb (v8qi, v8qi)
8090 v4hi __builtin_arm_wmaxsh (v4hi, v4hi)
8091 v2si __builtin_arm_wmaxsw (v2si, v2si)
8092 v8qi __builtin_arm_wmaxub (v8qi, v8qi)
8093 v4hi __builtin_arm_wmaxuh (v4hi, v4hi)
8094 v2si __builtin_arm_wmaxuw (v2si, v2si)
8095 v8qi __builtin_arm_wminsb (v8qi, v8qi)
8096 v4hi __builtin_arm_wminsh (v4hi, v4hi)
8097 v2si __builtin_arm_wminsw (v2si, v2si)
8098 v8qi __builtin_arm_wminub (v8qi, v8qi)
8099 v4hi __builtin_arm_wminuh (v4hi, v4hi)
8100 v2si __builtin_arm_wminuw (v2si, v2si)
8101 v4hi __builtin_arm_wmulsm (v4hi, v4hi)
8102 v4hi __builtin_arm_wmulul (v4hi, v4hi)
8103 v4hi __builtin_arm_wmulum (v4hi, v4hi)
8104 long long __builtin_arm_wor (long long, long long)
8105 v2si __builtin_arm_wpackdss (long long, long long)
8106 v2si __builtin_arm_wpackdus (long long, long long)
8107 v8qi __builtin_arm_wpackhss (v4hi, v4hi)
8108 v8qi __builtin_arm_wpackhus (v4hi, v4hi)
8109 v4hi __builtin_arm_wpackwss (v2si, v2si)
8110 v4hi __builtin_arm_wpackwus (v2si, v2si)
8111 long long __builtin_arm_wrord (long long, long long)
8112 long long __builtin_arm_wrordi (long long, int)
8113 v4hi __builtin_arm_wrorh (v4hi, long long)
8114 v4hi __builtin_arm_wrorhi (v4hi, int)
8115 v2si __builtin_arm_wrorw (v2si, long long)
8116 v2si __builtin_arm_wrorwi (v2si, int)
8117 v2si __builtin_arm_wsadb (v8qi, v8qi)
8118 v2si __builtin_arm_wsadbz (v8qi, v8qi)
8119 v2si __builtin_arm_wsadh (v4hi, v4hi)
8120 v2si __builtin_arm_wsadhz (v4hi, v4hi)
8121 v4hi __builtin_arm_wshufh (v4hi, int)
8122 long long __builtin_arm_wslld (long long, long long)
8123 long long __builtin_arm_wslldi (long long, int)
8124 v4hi __builtin_arm_wsllh (v4hi, long long)
8125 v4hi __builtin_arm_wsllhi (v4hi, int)
8126 v2si __builtin_arm_wsllw (v2si, long long)
8127 v2si __builtin_arm_wsllwi (v2si, int)
8128 long long __builtin_arm_wsrad (long long, long long)
8129 long long __builtin_arm_wsradi (long long, int)
8130 v4hi __builtin_arm_wsrah (v4hi, long long)
8131 v4hi __builtin_arm_wsrahi (v4hi, int)
8132 v2si __builtin_arm_wsraw (v2si, long long)
8133 v2si __builtin_arm_wsrawi (v2si, int)
8134 long long __builtin_arm_wsrld (long long, long long)
8135 long long __builtin_arm_wsrldi (long long, int)
8136 v4hi __builtin_arm_wsrlh (v4hi, long long)
8137 v4hi __builtin_arm_wsrlhi (v4hi, int)
8138 v2si __builtin_arm_wsrlw (v2si, long long)
8139 v2si __builtin_arm_wsrlwi (v2si, int)
8140 v8qi __builtin_arm_wsubb (v8qi, v8qi)
8141 v8qi __builtin_arm_wsubbss (v8qi, v8qi)
8142 v8qi __builtin_arm_wsubbus (v8qi, v8qi)
8143 v4hi __builtin_arm_wsubh (v4hi, v4hi)
8144 v4hi __builtin_arm_wsubhss (v4hi, v4hi)
8145 v4hi __builtin_arm_wsubhus (v4hi, v4hi)
8146 v2si __builtin_arm_wsubw (v2si, v2si)
8147 v2si __builtin_arm_wsubwss (v2si, v2si)
8148 v2si __builtin_arm_wsubwus (v2si, v2si)
8149 v4hi __builtin_arm_wunpckehsb (v8qi)
8150 v2si __builtin_arm_wunpckehsh (v4hi)
8151 long long __builtin_arm_wunpckehsw (v2si)
8152 v4hi __builtin_arm_wunpckehub (v8qi)
8153 v2si __builtin_arm_wunpckehuh (v4hi)
8154 long long __builtin_arm_wunpckehuw (v2si)
8155 v4hi __builtin_arm_wunpckelsb (v8qi)
8156 v2si __builtin_arm_wunpckelsh (v4hi)
8157 long long __builtin_arm_wunpckelsw (v2si)
8158 v4hi __builtin_arm_wunpckelub (v8qi)
8159 v2si __builtin_arm_wunpckeluh (v4hi)
8160 long long __builtin_arm_wunpckeluw (v2si)
8161 v8qi __builtin_arm_wunpckihb (v8qi, v8qi)
8162 v4hi __builtin_arm_wunpckihh (v4hi, v4hi)
8163 v2si __builtin_arm_wunpckihw (v2si, v2si)
8164 v8qi __builtin_arm_wunpckilb (v8qi, v8qi)
8165 v4hi __builtin_arm_wunpckilh (v4hi, v4hi)
8166 v2si __builtin_arm_wunpckilw (v2si, v2si)
8167 long long __builtin_arm_wxor (long long, long long)
8168 long long __builtin_arm_wzero ()
8169 @end smallexample
8170
8171 @node ARM NEON Intrinsics
8172 @subsection ARM NEON Intrinsics
8173
8174 These built-in intrinsics for the ARM Advanced SIMD extension are available
8175 when the @option{-mfpu=neon} switch is used:
8176
8177 @include arm-neon-intrinsics.texi
8178
8179 @node AVR Built-in Functions
8180 @subsection AVR Built-in Functions
8181
8182 For each built-in function for AVR, there is an equally named,
8183 uppercase built-in macro defined. That way users can easily query if
8184 or if not a specific built-in is implemented or not. For example, if
8185 @code{__builtin_avr_nop} is available the macro
8186 @code{__BUILTIN_AVR_NOP} is defined to @code{1} and undefined otherwise.
8187
8188 The following built-in functions map to the respective machine
8189 instruction, i.e. @code{nop}, @code{sei}, @code{cli}, @code{sleep},
8190 @code{wdr}, @code{swap}, @code{fmul}, @code{fmuls}
8191 resp. @code{fmulsu}. The latter three are only available if the AVR
8192 device actually supports multiplication.
8193
8194 @smallexample
8195 void __builtin_avr_nop (void)
8196 void __builtin_avr_sei (void)
8197 void __builtin_avr_cli (void)
8198 void __builtin_avr_sleep (void)
8199 void __builtin_avr_wdr (void)
8200 unsigned char __builtin_avr_swap (unsigned char)
8201 unsigned int __builtin_avr_fmul (unsigned char, unsigned char)
8202 int __builtin_avr_fmuls (char, char)
8203 int __builtin_avr_fmulsu (char, unsigned char)
8204 @end smallexample
8205
8206 In order to delay execution for a specific number of cycles, GCC
8207 implements
8208 @smallexample
8209 void __builtin_avr_delay_cycles (unsigned long ticks)
8210 @end smallexample
8211
8212 @code{ticks} is the number of ticks to delay execution. Note that this
8213 built-in does not take into account the effect of interrupts which
8214 might increase delay time. @code{ticks} must be a compile time
8215 integer constant; delays with a variable number of cycles are not supported.
8216
8217 @node Blackfin Built-in Functions
8218 @subsection Blackfin Built-in Functions
8219
8220 Currently, there are two Blackfin-specific built-in functions.  These are
8221 used for generating @code{CSYNC} and @code{SSYNC} machine insns without
8222 using inline assembly; by using these built-in functions the compiler can
8223 automatically add workarounds for hardware errata involving these
8224 instructions.  These functions are named as follows:
8225
8226 @smallexample
8227 void __builtin_bfin_csync (void)
8228 void __builtin_bfin_ssync (void)
8229 @end smallexample
8230
8231 @node FR-V Built-in Functions
8232 @subsection FR-V Built-in Functions
8233
8234 GCC provides many FR-V-specific built-in functions.  In general,
8235 these functions are intended to be compatible with those described
8236 by @cite{FR-V Family, Softune C/C++ Compiler Manual (V6), Fujitsu
8237 Semiconductor}.  The two exceptions are @code{__MDUNPACKH} and
8238 @code{__MBTOHE}, the gcc forms of which pass 128-bit values by
8239 pointer rather than by value.
8240
8241 Most of the functions are named after specific FR-V instructions.
8242 Such functions are said to be ``directly mapped'' and are summarized
8243 here in tabular form.
8244
8245 @menu
8246 * Argument Types::
8247 * Directly-mapped Integer Functions::
8248 * Directly-mapped Media Functions::
8249 * Raw read/write Functions::
8250 * Other Built-in Functions::
8251 @end menu
8252
8253 @node Argument Types
8254 @subsubsection Argument Types
8255
8256 The arguments to the built-in functions can be divided into three groups:
8257 register numbers, compile-time constants and run-time values.  In order
8258 to make this classification clear at a glance, the arguments and return
8259 values are given the following pseudo types:
8260
8261 @multitable @columnfractions .20 .30 .15 .35
8262 @item Pseudo type @tab Real C type @tab Constant? @tab Description
8263 @item @code{uh} @tab @code{unsigned short} @tab No @tab an unsigned halfword
8264 @item @code{uw1} @tab @code{unsigned int} @tab No @tab an unsigned word
8265 @item @code{sw1} @tab @code{int} @tab No @tab a signed word
8266 @item @code{uw2} @tab @code{unsigned long long} @tab No
8267 @tab an unsigned doubleword
8268 @item @code{sw2} @tab @code{long long} @tab No @tab a signed doubleword
8269 @item @code{const} @tab @code{int} @tab Yes @tab an integer constant
8270 @item @code{acc} @tab @code{int} @tab Yes @tab an ACC register number
8271 @item @code{iacc} @tab @code{int} @tab Yes @tab an IACC register number
8272 @end multitable
8273
8274 These pseudo types are not defined by GCC, they are simply a notational
8275 convenience used in this manual.
8276
8277 Arguments of type @code{uh}, @code{uw1}, @code{sw1}, @code{uw2}
8278 and @code{sw2} are evaluated at run time.  They correspond to
8279 register operands in the underlying FR-V instructions.
8280
8281 @code{const} arguments represent immediate operands in the underlying
8282 FR-V instructions.  They must be compile-time constants.
8283
8284 @code{acc} arguments are evaluated at compile time and specify the number
8285 of an accumulator register.  For example, an @code{acc} argument of 2
8286 will select the ACC2 register.
8287
8288 @code{iacc} arguments are similar to @code{acc} arguments but specify the
8289 number of an IACC register.  See @pxref{Other Built-in Functions}
8290 for more details.
8291
8292 @node Directly-mapped Integer Functions
8293 @subsubsection Directly-mapped Integer Functions
8294
8295 The functions listed below map directly to FR-V I-type instructions.
8296
8297 @multitable @columnfractions .45 .32 .23
8298 @item Function prototype @tab Example usage @tab Assembly output
8299 @item @code{sw1 __ADDSS (sw1, sw1)}
8300 @tab @code{@var{c} = __ADDSS (@var{a}, @var{b})}
8301 @tab @code{ADDSS @var{a},@var{b},@var{c}}
8302 @item @code{sw1 __SCAN (sw1, sw1)}
8303 @tab @code{@var{c} = __SCAN (@var{a}, @var{b})}
8304 @tab @code{SCAN @var{a},@var{b},@var{c}}
8305 @item @code{sw1 __SCUTSS (sw1)}
8306 @tab @code{@var{b} = __SCUTSS (@var{a})}
8307 @tab @code{SCUTSS @var{a},@var{b}}
8308 @item @code{sw1 __SLASS (sw1, sw1)}
8309 @tab @code{@var{c} = __SLASS (@var{a}, @var{b})}
8310 @tab @code{SLASS @var{a},@var{b},@var{c}}
8311 @item @code{void __SMASS (sw1, sw1)}
8312 @tab @code{__SMASS (@var{a}, @var{b})}
8313 @tab @code{SMASS @var{a},@var{b}}
8314 @item @code{void __SMSSS (sw1, sw1)}
8315 @tab @code{__SMSSS (@var{a}, @var{b})}
8316 @tab @code{SMSSS @var{a},@var{b}}
8317 @item @code{void __SMU (sw1, sw1)}
8318 @tab @code{__SMU (@var{a}, @var{b})}
8319 @tab @code{SMU @var{a},@var{b}}
8320 @item @code{sw2 __SMUL (sw1, sw1)}
8321 @tab @code{@var{c} = __SMUL (@var{a}, @var{b})}
8322 @tab @code{SMUL @var{a},@var{b},@var{c}}
8323 @item @code{sw1 __SUBSS (sw1, sw1)}
8324 @tab @code{@var{c} = __SUBSS (@var{a}, @var{b})}
8325 @tab @code{SUBSS @var{a},@var{b},@var{c}}
8326 @item @code{uw2 __UMUL (uw1, uw1)}
8327 @tab @code{@var{c} = __UMUL (@var{a}, @var{b})}
8328 @tab @code{UMUL @var{a},@var{b},@var{c}}
8329 @end multitable
8330
8331 @node Directly-mapped Media Functions
8332 @subsubsection Directly-mapped Media Functions
8333
8334 The functions listed below map directly to FR-V M-type instructions.
8335
8336 @multitable @columnfractions .45 .32 .23
8337 @item Function prototype @tab Example usage @tab Assembly output
8338 @item @code{uw1 __MABSHS (sw1)}
8339 @tab @code{@var{b} = __MABSHS (@var{a})}
8340 @tab @code{MABSHS @var{a},@var{b}}
8341 @item @code{void __MADDACCS (acc, acc)}
8342 @tab @code{__MADDACCS (@var{b}, @var{a})}
8343 @tab @code{MADDACCS @var{a},@var{b}}
8344 @item @code{sw1 __MADDHSS (sw1, sw1)}
8345 @tab @code{@var{c} = __MADDHSS (@var{a}, @var{b})}
8346 @tab @code{MADDHSS @var{a},@var{b},@var{c}}
8347 @item @code{uw1 __MADDHUS (uw1, uw1)}
8348 @tab @code{@var{c} = __MADDHUS (@var{a}, @var{b})}
8349 @tab @code{MADDHUS @var{a},@var{b},@var{c}}
8350 @item @code{uw1 __MAND (uw1, uw1)}
8351 @tab @code{@var{c} = __MAND (@var{a}, @var{b})}
8352 @tab @code{MAND @var{a},@var{b},@var{c}}
8353 @item @code{void __MASACCS (acc, acc)}
8354 @tab @code{__MASACCS (@var{b}, @var{a})}
8355 @tab @code{MASACCS @var{a},@var{b}}
8356 @item @code{uw1 __MAVEH (uw1, uw1)}
8357 @tab @code{@var{c} = __MAVEH (@var{a}, @var{b})}
8358 @tab @code{MAVEH @var{a},@var{b},@var{c}}
8359 @item @code{uw2 __MBTOH (uw1)}
8360 @tab @code{@var{b} = __MBTOH (@var{a})}
8361 @tab @code{MBTOH @var{a},@var{b}}
8362 @item @code{void __MBTOHE (uw1 *, uw1)}
8363 @tab @code{__MBTOHE (&@var{b}, @var{a})}
8364 @tab @code{MBTOHE @var{a},@var{b}}
8365 @item @code{void __MCLRACC (acc)}
8366 @tab @code{__MCLRACC (@var{a})}
8367 @tab @code{MCLRACC @var{a}}
8368 @item @code{void __MCLRACCA (void)}
8369 @tab @code{__MCLRACCA ()}
8370 @tab @code{MCLRACCA}
8371 @item @code{uw1 __Mcop1 (uw1, uw1)}
8372 @tab @code{@var{c} = __Mcop1 (@var{a}, @var{b})}
8373 @tab @code{Mcop1 @var{a},@var{b},@var{c}}
8374 @item @code{uw1 __Mcop2 (uw1, uw1)}
8375 @tab @code{@var{c} = __Mcop2 (@var{a}, @var{b})}
8376 @tab @code{Mcop2 @var{a},@var{b},@var{c}}
8377 @item @code{uw1 __MCPLHI (uw2, const)}
8378 @tab @code{@var{c} = __MCPLHI (@var{a}, @var{b})}
8379 @tab @code{MCPLHI @var{a},#@var{b},@var{c}}
8380 @item @code{uw1 __MCPLI (uw2, const)}
8381 @tab @code{@var{c} = __MCPLI (@var{a}, @var{b})}
8382 @tab @code{MCPLI @var{a},#@var{b},@var{c}}
8383 @item @code{void __MCPXIS (acc, sw1, sw1)}
8384 @tab @code{__MCPXIS (@var{c}, @var{a}, @var{b})}
8385 @tab @code{MCPXIS @var{a},@var{b},@var{c}}
8386 @item @code{void __MCPXIU (acc, uw1, uw1)}
8387 @tab @code{__MCPXIU (@var{c}, @var{a}, @var{b})}
8388 @tab @code{MCPXIU @var{a},@var{b},@var{c}}
8389 @item @code{void __MCPXRS (acc, sw1, sw1)}
8390 @tab @code{__MCPXRS (@var{c}, @var{a}, @var{b})}
8391 @tab @code{MCPXRS @var{a},@var{b},@var{c}}
8392 @item @code{void __MCPXRU (acc, uw1, uw1)}
8393 @tab @code{__MCPXRU (@var{c}, @var{a}, @var{b})}
8394 @tab @code{MCPXRU @var{a},@var{b},@var{c}}
8395 @item @code{uw1 __MCUT (acc, uw1)}
8396 @tab @code{@var{c} = __MCUT (@var{a}, @var{b})}
8397 @tab @code{MCUT @var{a},@var{b},@var{c}}
8398 @item @code{uw1 __MCUTSS (acc, sw1)}
8399 @tab @code{@var{c} = __MCUTSS (@var{a}, @var{b})}
8400 @tab @code{MCUTSS @var{a},@var{b},@var{c}}
8401 @item @code{void __MDADDACCS (acc, acc)}
8402 @tab @code{__MDADDACCS (@var{b}, @var{a})}
8403 @tab @code{MDADDACCS @var{a},@var{b}}
8404 @item @code{void __MDASACCS (acc, acc)}
8405 @tab @code{__MDASACCS (@var{b}, @var{a})}
8406 @tab @code{MDASACCS @var{a},@var{b}}
8407 @item @code{uw2 __MDCUTSSI (acc, const)}
8408 @tab @code{@var{c} = __MDCUTSSI (@var{a}, @var{b})}
8409 @tab @code{MDCUTSSI @var{a},#@var{b},@var{c}}
8410 @item @code{uw2 __MDPACKH (uw2, uw2)}
8411 @tab @code{@var{c} = __MDPACKH (@var{a}, @var{b})}
8412 @tab @code{MDPACKH @var{a},@var{b},@var{c}}
8413 @item @code{uw2 __MDROTLI (uw2, const)}
8414 @tab @code{@var{c} = __MDROTLI (@var{a}, @var{b})}
8415 @tab @code{MDROTLI @var{a},#@var{b},@var{c}}
8416 @item @code{void __MDSUBACCS (acc, acc)}
8417 @tab @code{__MDSUBACCS (@var{b}, @var{a})}
8418 @tab @code{MDSUBACCS @var{a},@var{b}}
8419 @item @code{void __MDUNPACKH (uw1 *, uw2)}
8420 @tab @code{__MDUNPACKH (&@var{b}, @var{a})}
8421 @tab @code{MDUNPACKH @var{a},@var{b}}
8422 @item @code{uw2 __MEXPDHD (uw1, const)}
8423 @tab @code{@var{c} = __MEXPDHD (@var{a}, @var{b})}
8424 @tab @code{MEXPDHD @var{a},#@var{b},@var{c}}
8425 @item @code{uw1 __MEXPDHW (uw1, const)}
8426 @tab @code{@var{c} = __MEXPDHW (@var{a}, @var{b})}
8427 @tab @code{MEXPDHW @var{a},#@var{b},@var{c}}
8428 @item @code{uw1 __MHDSETH (uw1, const)}
8429 @tab @code{@var{c} = __MHDSETH (@var{a}, @var{b})}
8430 @tab @code{MHDSETH @var{a},#@var{b},@var{c}}
8431 @item @code{sw1 __MHDSETS (const)}
8432 @tab @code{@var{b} = __MHDSETS (@var{a})}
8433 @tab @code{MHDSETS #@var{a},@var{b}}
8434 @item @code{uw1 __MHSETHIH (uw1, const)}
8435 @tab @code{@var{b} = __MHSETHIH (@var{b}, @var{a})}
8436 @tab @code{MHSETHIH #@var{a},@var{b}}
8437 @item @code{sw1 __MHSETHIS (sw1, const)}
8438 @tab @code{@var{b} = __MHSETHIS (@var{b}, @var{a})}
8439 @tab @code{MHSETHIS #@var{a},@var{b}}
8440 @item @code{uw1 __MHSETLOH (uw1, const)}
8441 @tab @code{@var{b} = __MHSETLOH (@var{b}, @var{a})}
8442 @tab @code{MHSETLOH #@var{a},@var{b}}
8443 @item @code{sw1 __MHSETLOS (sw1, const)}
8444 @tab @code{@var{b} = __MHSETLOS (@var{b}, @var{a})}
8445 @tab @code{MHSETLOS #@var{a},@var{b}}
8446 @item @code{uw1 __MHTOB (uw2)}
8447 @tab @code{@var{b} = __MHTOB (@var{a})}
8448 @tab @code{MHTOB @var{a},@var{b}}
8449 @item @code{void __MMACHS (acc, sw1, sw1)}
8450 @tab @code{__MMACHS (@var{c}, @var{a}, @var{b})}
8451 @tab @code{MMACHS @var{a},@var{b},@var{c}}
8452 @item @code{void __MMACHU (acc, uw1, uw1)}
8453 @tab @code{__MMACHU (@var{c}, @var{a}, @var{b})}
8454 @tab @code{MMACHU @var{a},@var{b},@var{c}}
8455 @item @code{void __MMRDHS (acc, sw1, sw1)}
8456 @tab @code{__MMRDHS (@var{c}, @var{a}, @var{b})}
8457 @tab @code{MMRDHS @var{a},@var{b},@var{c}}
8458 @item @code{void __MMRDHU (acc, uw1, uw1)}
8459 @tab @code{__MMRDHU (@var{c}, @var{a}, @var{b})}
8460 @tab @code{MMRDHU @var{a},@var{b},@var{c}}
8461 @item @code{void __MMULHS (acc, sw1, sw1)}
8462 @tab @code{__MMULHS (@var{c}, @var{a}, @var{b})}
8463 @tab @code{MMULHS @var{a},@var{b},@var{c}}
8464 @item @code{void __MMULHU (acc, uw1, uw1)}
8465 @tab @code{__MMULHU (@var{c}, @var{a}, @var{b})}
8466 @tab @code{MMULHU @var{a},@var{b},@var{c}}
8467 @item @code{void __MMULXHS (acc, sw1, sw1)}
8468 @tab @code{__MMULXHS (@var{c}, @var{a}, @var{b})}
8469 @tab @code{MMULXHS @var{a},@var{b},@var{c}}
8470 @item @code{void __MMULXHU (acc, uw1, uw1)}
8471 @tab @code{__MMULXHU (@var{c}, @var{a}, @var{b})}
8472 @tab @code{MMULXHU @var{a},@var{b},@var{c}}
8473 @item @code{uw1 __MNOT (uw1)}
8474 @tab @code{@var{b} = __MNOT (@var{a})}
8475 @tab @code{MNOT @var{a},@var{b}}
8476 @item @code{uw1 __MOR (uw1, uw1)}
8477 @tab @code{@var{c} = __MOR (@var{a}, @var{b})}
8478 @tab @code{MOR @var{a},@var{b},@var{c}}
8479 @item @code{uw1 __MPACKH (uh, uh)}
8480 @tab @code{@var{c} = __MPACKH (@var{a}, @var{b})}
8481 @tab @code{MPACKH @var{a},@var{b},@var{c}}
8482 @item @code{sw2 __MQADDHSS (sw2, sw2)}
8483 @tab @code{@var{c} = __MQADDHSS (@var{a}, @var{b})}
8484 @tab @code{MQADDHSS @var{a},@var{b},@var{c}}
8485 @item @code{uw2 __MQADDHUS (uw2, uw2)}
8486 @tab @code{@var{c} = __MQADDHUS (@var{a}, @var{b})}
8487 @tab @code{MQADDHUS @var{a},@var{b},@var{c}}
8488 @item @code{void __MQCPXIS (acc, sw2, sw2)}
8489 @tab @code{__MQCPXIS (@var{c}, @var{a}, @var{b})}
8490 @tab @code{MQCPXIS @var{a},@var{b},@var{c}}
8491 @item @code{void __MQCPXIU (acc, uw2, uw2)}
8492 @tab @code{__MQCPXIU (@var{c}, @var{a}, @var{b})}
8493 @tab @code{MQCPXIU @var{a},@var{b},@var{c}}
8494 @item @code{void __MQCPXRS (acc, sw2, sw2)}
8495 @tab @code{__MQCPXRS (@var{c}, @var{a}, @var{b})}
8496 @tab @code{MQCPXRS @var{a},@var{b},@var{c}}
8497 @item @code{void __MQCPXRU (acc, uw2, uw2)}
8498 @tab @code{__MQCPXRU (@var{c}, @var{a}, @var{b})}
8499 @tab @code{MQCPXRU @var{a},@var{b},@var{c}}
8500 @item @code{sw2 __MQLCLRHS (sw2, sw2)}
8501 @tab @code{@var{c} = __MQLCLRHS (@var{a}, @var{b})}
8502 @tab @code{MQLCLRHS @var{a},@var{b},@var{c}}
8503 @item @code{sw2 __MQLMTHS (sw2, sw2)}
8504 @tab @code{@var{c} = __MQLMTHS (@var{a}, @var{b})}
8505 @tab @code{MQLMTHS @var{a},@var{b},@var{c}}
8506 @item @code{void __MQMACHS (acc, sw2, sw2)}
8507 @tab @code{__MQMACHS (@var{c}, @var{a}, @var{b})}
8508 @tab @code{MQMACHS @var{a},@var{b},@var{c}}
8509 @item @code{void __MQMACHU (acc, uw2, uw2)}
8510 @tab @code{__MQMACHU (@var{c}, @var{a}, @var{b})}
8511 @tab @code{MQMACHU @var{a},@var{b},@var{c}}
8512 @item @code{void __MQMACXHS (acc, sw2, sw2)}
8513 @tab @code{__MQMACXHS (@var{c}, @var{a}, @var{b})}
8514 @tab @code{MQMACXHS @var{a},@var{b},@var{c}}
8515 @item @code{void __MQMULHS (acc, sw2, sw2)}
8516 @tab @code{__MQMULHS (@var{c}, @var{a}, @var{b})}
8517 @tab @code{MQMULHS @var{a},@var{b},@var{c}}
8518 @item @code{void __MQMULHU (acc, uw2, uw2)}
8519 @tab @code{__MQMULHU (@var{c}, @var{a}, @var{b})}
8520 @tab @code{MQMULHU @var{a},@var{b},@var{c}}
8521 @item @code{void __MQMULXHS (acc, sw2, sw2)}
8522 @tab @code{__MQMULXHS (@var{c}, @var{a}, @var{b})}
8523 @tab @code{MQMULXHS @var{a},@var{b},@var{c}}
8524 @item @code{void __MQMULXHU (acc, uw2, uw2)}
8525 @tab @code{__MQMULXHU (@var{c}, @var{a}, @var{b})}
8526 @tab @code{MQMULXHU @var{a},@var{b},@var{c}}
8527 @item @code{sw2 __MQSATHS (sw2, sw2)}
8528 @tab @code{@var{c} = __MQSATHS (@var{a}, @var{b})}
8529 @tab @code{MQSATHS @var{a},@var{b},@var{c}}
8530 @item @code{uw2 __MQSLLHI (uw2, int)}
8531 @tab @code{@var{c} = __MQSLLHI (@var{a}, @var{b})}
8532 @tab @code{MQSLLHI @var{a},@var{b},@var{c}}
8533 @item @code{sw2 __MQSRAHI (sw2, int)}
8534 @tab @code{@var{c} = __MQSRAHI (@var{a}, @var{b})}
8535 @tab @code{MQSRAHI @var{a},@var{b},@var{c}}
8536 @item @code{sw2 __MQSUBHSS (sw2, sw2)}
8537 @tab @code{@var{c} = __MQSUBHSS (@var{a}, @var{b})}
8538 @tab @code{MQSUBHSS @var{a},@var{b},@var{c}}
8539 @item @code{uw2 __MQSUBHUS (uw2, uw2)}
8540 @tab @code{@var{c} = __MQSUBHUS (@var{a}, @var{b})}
8541 @tab @code{MQSUBHUS @var{a},@var{b},@var{c}}
8542 @item @code{void __MQXMACHS (acc, sw2, sw2)}
8543 @tab @code{__MQXMACHS (@var{c}, @var{a}, @var{b})}
8544 @tab @code{MQXMACHS @var{a},@var{b},@var{c}}
8545 @item @code{void __MQXMACXHS (acc, sw2, sw2)}
8546 @tab @code{__MQXMACXHS (@var{c}, @var{a}, @var{b})}
8547 @tab @code{MQXMACXHS @var{a},@var{b},@var{c}}
8548 @item @code{uw1 __MRDACC (acc)}
8549 @tab @code{@var{b} = __MRDACC (@var{a})}
8550 @tab @code{MRDACC @var{a},@var{b}}
8551 @item @code{uw1 __MRDACCG (acc)}
8552 @tab @code{@var{b} = __MRDACCG (@var{a})}
8553 @tab @code{MRDACCG @var{a},@var{b}}
8554 @item @code{uw1 __MROTLI (uw1, const)}
8555 @tab @code{@var{c} = __MROTLI (@var{a}, @var{b})}
8556 @tab @code{MROTLI @var{a},#@var{b},@var{c}}
8557 @item @code{uw1 __MROTRI (uw1, const)}
8558 @tab @code{@var{c} = __MROTRI (@var{a}, @var{b})}
8559 @tab @code{MROTRI @var{a},#@var{b},@var{c}}
8560 @item @code{sw1 __MSATHS (sw1, sw1)}
8561 @tab @code{@var{c} = __MSATHS (@var{a}, @var{b})}
8562 @tab @code{MSATHS @var{a},@var{b},@var{c}}
8563 @item @code{uw1 __MSATHU (uw1, uw1)}
8564 @tab @code{@var{c} = __MSATHU (@var{a}, @var{b})}
8565 @tab @code{MSATHU @var{a},@var{b},@var{c}}
8566 @item @code{uw1 __MSLLHI (uw1, const)}
8567 @tab @code{@var{c} = __MSLLHI (@var{a}, @var{b})}
8568 @tab @code{MSLLHI @var{a},#@var{b},@var{c}}
8569 @item @code{sw1 __MSRAHI (sw1, const)}
8570 @tab @code{@var{c} = __MSRAHI (@var{a}, @var{b})}
8571 @tab @code{MSRAHI @var{a},#@var{b},@var{c}}
8572 @item @code{uw1 __MSRLHI (uw1, const)}
8573 @tab @code{@var{c} = __MSRLHI (@var{a}, @var{b})}
8574 @tab @code{MSRLHI @var{a},#@var{b},@var{c}}
8575 @item @code{void __MSUBACCS (acc, acc)}
8576 @tab @code{__MSUBACCS (@var{b}, @var{a})}
8577 @tab @code{MSUBACCS @var{a},@var{b}}
8578 @item @code{sw1 __MSUBHSS (sw1, sw1)}
8579 @tab @code{@var{c} = __MSUBHSS (@var{a}, @var{b})}
8580 @tab @code{MSUBHSS @var{a},@var{b},@var{c}}
8581 @item @code{uw1 __MSUBHUS (uw1, uw1)}
8582 @tab @code{@var{c} = __MSUBHUS (@var{a}, @var{b})}
8583 @tab @code{MSUBHUS @var{a},@var{b},@var{c}}
8584 @item @code{void __MTRAP (void)}
8585 @tab @code{__MTRAP ()}
8586 @tab @code{MTRAP}
8587 @item @code{uw2 __MUNPACKH (uw1)}
8588 @tab @code{@var{b} = __MUNPACKH (@var{a})}
8589 @tab @code{MUNPACKH @var{a},@var{b}}
8590 @item @code{uw1 __MWCUT (uw2, uw1)}
8591 @tab @code{@var{c} = __MWCUT (@var{a}, @var{b})}
8592 @tab @code{MWCUT @var{a},@var{b},@var{c}}
8593 @item @code{void __MWTACC (acc, uw1)}
8594 @tab @code{__MWTACC (@var{b}, @var{a})}
8595 @tab @code{MWTACC @var{a},@var{b}}
8596 @item @code{void __MWTACCG (acc, uw1)}
8597 @tab @code{__MWTACCG (@var{b}, @var{a})}
8598 @tab @code{MWTACCG @var{a},@var{b}}
8599 @item @code{uw1 __MXOR (uw1, uw1)}
8600 @tab @code{@var{c} = __MXOR (@var{a}, @var{b})}
8601 @tab @code{MXOR @var{a},@var{b},@var{c}}
8602 @end multitable
8603
8604 @node Raw read/write Functions
8605 @subsubsection Raw read/write Functions
8606
8607 This sections describes built-in functions related to read and write
8608 instructions to access memory.  These functions generate
8609 @code{membar} instructions to flush the I/O load and stores where
8610 appropriate, as described in Fujitsu's manual described above.
8611
8612 @table @code
8613
8614 @item unsigned char __builtin_read8 (void *@var{data})
8615 @item unsigned short __builtin_read16 (void *@var{data})
8616 @item unsigned long __builtin_read32 (void *@var{data})
8617 @item unsigned long long __builtin_read64 (void *@var{data})
8618
8619 @item void __builtin_write8 (void *@var{data}, unsigned char @var{datum})
8620 @item void __builtin_write16 (void *@var{data}, unsigned short @var{datum})
8621 @item void __builtin_write32 (void *@var{data}, unsigned long @var{datum})
8622 @item void __builtin_write64 (void *@var{data}, unsigned long long @var{datum})
8623 @end table
8624
8625 @node Other Built-in Functions
8626 @subsubsection Other Built-in Functions
8627
8628 This section describes built-in functions that are not named after
8629 a specific FR-V instruction.
8630
8631 @table @code
8632 @item sw2 __IACCreadll (iacc @var{reg})
8633 Return the full 64-bit value of IACC0@.  The @var{reg} argument is reserved
8634 for future expansion and must be 0.
8635
8636 @item sw1 __IACCreadl (iacc @var{reg})
8637 Return the value of IACC0H if @var{reg} is 0 and IACC0L if @var{reg} is 1.
8638 Other values of @var{reg} are rejected as invalid.
8639
8640 @item void __IACCsetll (iacc @var{reg}, sw2 @var{x})
8641 Set the full 64-bit value of IACC0 to @var{x}.  The @var{reg} argument
8642 is reserved for future expansion and must be 0.
8643
8644 @item void __IACCsetl (iacc @var{reg}, sw1 @var{x})
8645 Set IACC0H to @var{x} if @var{reg} is 0 and IACC0L to @var{x} if @var{reg}
8646 is 1.  Other values of @var{reg} are rejected as invalid.
8647
8648 @item void __data_prefetch0 (const void *@var{x})
8649 Use the @code{dcpl} instruction to load the contents of address @var{x}
8650 into the data cache.
8651
8652 @item void __data_prefetch (const void *@var{x})
8653 Use the @code{nldub} instruction to load the contents of address @var{x}
8654 into the data cache.  The instruction will be issued in slot I1@.
8655 @end table
8656
8657 @node X86 Built-in Functions
8658 @subsection X86 Built-in Functions
8659
8660 These built-in functions are available for the i386 and x86-64 family
8661 of computers, depending on the command-line switches used.
8662
8663 Note that, if you specify command-line switches such as @option{-msse},
8664 the compiler could use the extended instruction sets even if the built-ins
8665 are not used explicitly in the program.  For this reason, applications
8666 which perform runtime CPU detection must compile separate files for each
8667 supported architecture, using the appropriate flags.  In particular,
8668 the file containing the CPU detection code should be compiled without
8669 these options.
8670
8671 The following machine modes are available for use with MMX built-in functions
8672 (@pxref{Vector Extensions}): @code{V2SI} for a vector of two 32-bit integers,
8673 @code{V4HI} for a vector of four 16-bit integers, and @code{V8QI} for a
8674 vector of eight 8-bit integers.  Some of the built-in functions operate on
8675 MMX registers as a whole 64-bit entity, these use @code{V1DI} as their mode.
8676
8677 If 3DNow!@: extensions are enabled, @code{V2SF} is used as a mode for a vector
8678 of two 32-bit floating point values.
8679
8680 If SSE extensions are enabled, @code{V4SF} is used for a vector of four 32-bit
8681 floating point values.  Some instructions use a vector of four 32-bit
8682 integers, these use @code{V4SI}.  Finally, some instructions operate on an
8683 entire vector register, interpreting it as a 128-bit integer, these use mode
8684 @code{TI}.
8685
8686 In 64-bit mode, the x86-64 family of processors uses additional built-in
8687 functions for efficient use of @code{TF} (@code{__float128}) 128-bit
8688 floating point and @code{TC} 128-bit complex floating point values.
8689
8690 The following floating point built-in functions are available in 64-bit
8691 mode.  All of them implement the function that is part of the name.
8692
8693 @smallexample
8694 __float128 __builtin_fabsq (__float128)
8695 __float128 __builtin_copysignq (__float128, __float128)
8696 @end smallexample
8697
8698 The following floating point built-in functions are made available in the
8699 64-bit mode.
8700
8701 @table @code
8702 @item __float128 __builtin_infq (void)
8703 Similar to @code{__builtin_inf}, except the return type is @code{__float128}.
8704 @findex __builtin_infq
8705
8706 @item __float128 __builtin_huge_valq (void)
8707 Similar to @code{__builtin_huge_val}, except the return type is @code{__float128}.
8708 @findex __builtin_huge_valq
8709 @end table
8710
8711 The following built-in functions are made available by @option{-mmmx}.
8712 All of them generate the machine instruction that is part of the name.
8713
8714 @smallexample
8715 v8qi __builtin_ia32_paddb (v8qi, v8qi)
8716 v4hi __builtin_ia32_paddw (v4hi, v4hi)
8717 v2si __builtin_ia32_paddd (v2si, v2si)
8718 v8qi __builtin_ia32_psubb (v8qi, v8qi)
8719 v4hi __builtin_ia32_psubw (v4hi, v4hi)
8720 v2si __builtin_ia32_psubd (v2si, v2si)
8721 v8qi __builtin_ia32_paddsb (v8qi, v8qi)
8722 v4hi __builtin_ia32_paddsw (v4hi, v4hi)
8723 v8qi __builtin_ia32_psubsb (v8qi, v8qi)
8724 v4hi __builtin_ia32_psubsw (v4hi, v4hi)
8725 v8qi __builtin_ia32_paddusb (v8qi, v8qi)
8726 v4hi __builtin_ia32_paddusw (v4hi, v4hi)
8727 v8qi __builtin_ia32_psubusb (v8qi, v8qi)
8728 v4hi __builtin_ia32_psubusw (v4hi, v4hi)
8729 v4hi __builtin_ia32_pmullw (v4hi, v4hi)
8730 v4hi __builtin_ia32_pmulhw (v4hi, v4hi)
8731 di __builtin_ia32_pand (di, di)
8732 di __builtin_ia32_pandn (di,di)
8733 di __builtin_ia32_por (di, di)
8734 di __builtin_ia32_pxor (di, di)
8735 v8qi __builtin_ia32_pcmpeqb (v8qi, v8qi)
8736 v4hi __builtin_ia32_pcmpeqw (v4hi, v4hi)
8737 v2si __builtin_ia32_pcmpeqd (v2si, v2si)
8738 v8qi __builtin_ia32_pcmpgtb (v8qi, v8qi)
8739 v4hi __builtin_ia32_pcmpgtw (v4hi, v4hi)
8740 v2si __builtin_ia32_pcmpgtd (v2si, v2si)
8741 v8qi __builtin_ia32_punpckhbw (v8qi, v8qi)
8742 v4hi __builtin_ia32_punpckhwd (v4hi, v4hi)
8743 v2si __builtin_ia32_punpckhdq (v2si, v2si)
8744 v8qi __builtin_ia32_punpcklbw (v8qi, v8qi)
8745 v4hi __builtin_ia32_punpcklwd (v4hi, v4hi)
8746 v2si __builtin_ia32_punpckldq (v2si, v2si)
8747 v8qi __builtin_ia32_packsswb (v4hi, v4hi)
8748 v4hi __builtin_ia32_packssdw (v2si, v2si)
8749 v8qi __builtin_ia32_packuswb (v4hi, v4hi)
8750
8751 v4hi __builtin_ia32_psllw (v4hi, v4hi)
8752 v2si __builtin_ia32_pslld (v2si, v2si)
8753 v1di __builtin_ia32_psllq (v1di, v1di)
8754 v4hi __builtin_ia32_psrlw (v4hi, v4hi)
8755 v2si __builtin_ia32_psrld (v2si, v2si)
8756 v1di __builtin_ia32_psrlq (v1di, v1di)
8757 v4hi __builtin_ia32_psraw (v4hi, v4hi)
8758 v2si __builtin_ia32_psrad (v2si, v2si)
8759 v4hi __builtin_ia32_psllwi (v4hi, int)
8760 v2si __builtin_ia32_pslldi (v2si, int)
8761 v1di __builtin_ia32_psllqi (v1di, int)
8762 v4hi __builtin_ia32_psrlwi (v4hi, int)
8763 v2si __builtin_ia32_psrldi (v2si, int)
8764 v1di __builtin_ia32_psrlqi (v1di, int)
8765 v4hi __builtin_ia32_psrawi (v4hi, int)
8766 v2si __builtin_ia32_psradi (v2si, int)
8767
8768 @end smallexample
8769
8770 The following built-in functions are made available either with
8771 @option{-msse}, or with a combination of @option{-m3dnow} and
8772 @option{-march=athlon}.  All of them generate the machine
8773 instruction that is part of the name.
8774
8775 @smallexample
8776 v4hi __builtin_ia32_pmulhuw (v4hi, v4hi)
8777 v8qi __builtin_ia32_pavgb (v8qi, v8qi)
8778 v4hi __builtin_ia32_pavgw (v4hi, v4hi)
8779 v1di __builtin_ia32_psadbw (v8qi, v8qi)
8780 v8qi __builtin_ia32_pmaxub (v8qi, v8qi)
8781 v4hi __builtin_ia32_pmaxsw (v4hi, v4hi)
8782 v8qi __builtin_ia32_pminub (v8qi, v8qi)
8783 v4hi __builtin_ia32_pminsw (v4hi, v4hi)
8784 int __builtin_ia32_pextrw (v4hi, int)
8785 v4hi __builtin_ia32_pinsrw (v4hi, int, int)
8786 int __builtin_ia32_pmovmskb (v8qi)
8787 void __builtin_ia32_maskmovq (v8qi, v8qi, char *)
8788 void __builtin_ia32_movntq (di *, di)
8789 void __builtin_ia32_sfence (void)
8790 @end smallexample
8791
8792 The following built-in functions are available when @option{-msse} is used.
8793 All of them generate the machine instruction that is part of the name.
8794
8795 @smallexample
8796 int __builtin_ia32_comieq (v4sf, v4sf)
8797 int __builtin_ia32_comineq (v4sf, v4sf)
8798 int __builtin_ia32_comilt (v4sf, v4sf)
8799 int __builtin_ia32_comile (v4sf, v4sf)
8800 int __builtin_ia32_comigt (v4sf, v4sf)
8801 int __builtin_ia32_comige (v4sf, v4sf)
8802 int __builtin_ia32_ucomieq (v4sf, v4sf)
8803 int __builtin_ia32_ucomineq (v4sf, v4sf)
8804 int __builtin_ia32_ucomilt (v4sf, v4sf)
8805 int __builtin_ia32_ucomile (v4sf, v4sf)
8806 int __builtin_ia32_ucomigt (v4sf, v4sf)
8807 int __builtin_ia32_ucomige (v4sf, v4sf)
8808 v4sf __builtin_ia32_addps (v4sf, v4sf)
8809 v4sf __builtin_ia32_subps (v4sf, v4sf)
8810 v4sf __builtin_ia32_mulps (v4sf, v4sf)
8811 v4sf __builtin_ia32_divps (v4sf, v4sf)
8812 v4sf __builtin_ia32_addss (v4sf, v4sf)
8813 v4sf __builtin_ia32_subss (v4sf, v4sf)
8814 v4sf __builtin_ia32_mulss (v4sf, v4sf)
8815 v4sf __builtin_ia32_divss (v4sf, v4sf)
8816 v4si __builtin_ia32_cmpeqps (v4sf, v4sf)
8817 v4si __builtin_ia32_cmpltps (v4sf, v4sf)
8818 v4si __builtin_ia32_cmpleps (v4sf, v4sf)
8819 v4si __builtin_ia32_cmpgtps (v4sf, v4sf)
8820 v4si __builtin_ia32_cmpgeps (v4sf, v4sf)
8821 v4si __builtin_ia32_cmpunordps (v4sf, v4sf)
8822 v4si __builtin_ia32_cmpneqps (v4sf, v4sf)
8823 v4si __builtin_ia32_cmpnltps (v4sf, v4sf)
8824 v4si __builtin_ia32_cmpnleps (v4sf, v4sf)
8825 v4si __builtin_ia32_cmpngtps (v4sf, v4sf)
8826 v4si __builtin_ia32_cmpngeps (v4sf, v4sf)
8827 v4si __builtin_ia32_cmpordps (v4sf, v4sf)
8828 v4si __builtin_ia32_cmpeqss (v4sf, v4sf)
8829 v4si __builtin_ia32_cmpltss (v4sf, v4sf)
8830 v4si __builtin_ia32_cmpless (v4sf, v4sf)
8831 v4si __builtin_ia32_cmpunordss (v4sf, v4sf)
8832 v4si __builtin_ia32_cmpneqss (v4sf, v4sf)
8833 v4si __builtin_ia32_cmpnlts (v4sf, v4sf)
8834 v4si __builtin_ia32_cmpnless (v4sf, v4sf)
8835 v4si __builtin_ia32_cmpordss (v4sf, v4sf)
8836 v4sf __builtin_ia32_maxps (v4sf, v4sf)
8837 v4sf __builtin_ia32_maxss (v4sf, v4sf)
8838 v4sf __builtin_ia32_minps (v4sf, v4sf)
8839 v4sf __builtin_ia32_minss (v4sf, v4sf)
8840 v4sf __builtin_ia32_andps (v4sf, v4sf)
8841 v4sf __builtin_ia32_andnps (v4sf, v4sf)
8842 v4sf __builtin_ia32_orps (v4sf, v4sf)
8843 v4sf __builtin_ia32_xorps (v4sf, v4sf)
8844 v4sf __builtin_ia32_movss (v4sf, v4sf)
8845 v4sf __builtin_ia32_movhlps (v4sf, v4sf)
8846 v4sf __builtin_ia32_movlhps (v4sf, v4sf)
8847 v4sf __builtin_ia32_unpckhps (v4sf, v4sf)
8848 v4sf __builtin_ia32_unpcklps (v4sf, v4sf)
8849 v4sf __builtin_ia32_cvtpi2ps (v4sf, v2si)
8850 v4sf __builtin_ia32_cvtsi2ss (v4sf, int)
8851 v2si __builtin_ia32_cvtps2pi (v4sf)
8852 int __builtin_ia32_cvtss2si (v4sf)
8853 v2si __builtin_ia32_cvttps2pi (v4sf)
8854 int __builtin_ia32_cvttss2si (v4sf)
8855 v4sf __builtin_ia32_rcpps (v4sf)
8856 v4sf __builtin_ia32_rsqrtps (v4sf)
8857 v4sf __builtin_ia32_sqrtps (v4sf)
8858 v4sf __builtin_ia32_rcpss (v4sf)
8859 v4sf __builtin_ia32_rsqrtss (v4sf)
8860 v4sf __builtin_ia32_sqrtss (v4sf)
8861 v4sf __builtin_ia32_shufps (v4sf, v4sf, int)
8862 void __builtin_ia32_movntps (float *, v4sf)
8863 int __builtin_ia32_movmskps (v4sf)
8864 @end smallexample
8865
8866 The following built-in functions are available when @option{-msse} is used.
8867
8868 @table @code
8869 @item v4sf __builtin_ia32_loadaps (float *)
8870 Generates the @code{movaps} machine instruction as a load from memory.
8871 @item void __builtin_ia32_storeaps (float *, v4sf)
8872 Generates the @code{movaps} machine instruction as a store to memory.
8873 @item v4sf __builtin_ia32_loadups (float *)
8874 Generates the @code{movups} machine instruction as a load from memory.
8875 @item void __builtin_ia32_storeups (float *, v4sf)
8876 Generates the @code{movups} machine instruction as a store to memory.
8877 @item v4sf __builtin_ia32_loadsss (float *)
8878 Generates the @code{movss} machine instruction as a load from memory.
8879 @item void __builtin_ia32_storess (float *, v4sf)
8880 Generates the @code{movss} machine instruction as a store to memory.
8881 @item v4sf __builtin_ia32_loadhps (v4sf, const v2sf *)
8882 Generates the @code{movhps} machine instruction as a load from memory.
8883 @item v4sf __builtin_ia32_loadlps (v4sf, const v2sf *)
8884 Generates the @code{movlps} machine instruction as a load from memory
8885 @item void __builtin_ia32_storehps (v2sf *, v4sf)
8886 Generates the @code{movhps} machine instruction as a store to memory.
8887 @item void __builtin_ia32_storelps (v2sf *, v4sf)
8888 Generates the @code{movlps} machine instruction as a store to memory.
8889 @end table
8890
8891 The following built-in functions are available when @option{-msse2} is used.
8892 All of them generate the machine instruction that is part of the name.
8893
8894 @smallexample
8895 int __builtin_ia32_comisdeq (v2df, v2df)
8896 int __builtin_ia32_comisdlt (v2df, v2df)
8897 int __builtin_ia32_comisdle (v2df, v2df)
8898 int __builtin_ia32_comisdgt (v2df, v2df)
8899 int __builtin_ia32_comisdge (v2df, v2df)
8900 int __builtin_ia32_comisdneq (v2df, v2df)
8901 int __builtin_ia32_ucomisdeq (v2df, v2df)
8902 int __builtin_ia32_ucomisdlt (v2df, v2df)
8903 int __builtin_ia32_ucomisdle (v2df, v2df)
8904 int __builtin_ia32_ucomisdgt (v2df, v2df)
8905 int __builtin_ia32_ucomisdge (v2df, v2df)
8906 int __builtin_ia32_ucomisdneq (v2df, v2df)
8907 v2df __builtin_ia32_cmpeqpd (v2df, v2df)
8908 v2df __builtin_ia32_cmpltpd (v2df, v2df)
8909 v2df __builtin_ia32_cmplepd (v2df, v2df)
8910 v2df __builtin_ia32_cmpgtpd (v2df, v2df)
8911 v2df __builtin_ia32_cmpgepd (v2df, v2df)
8912 v2df __builtin_ia32_cmpunordpd (v2df, v2df)
8913 v2df __builtin_ia32_cmpneqpd (v2df, v2df)
8914 v2df __builtin_ia32_cmpnltpd (v2df, v2df)
8915 v2df __builtin_ia32_cmpnlepd (v2df, v2df)
8916 v2df __builtin_ia32_cmpngtpd (v2df, v2df)
8917 v2df __builtin_ia32_cmpngepd (v2df, v2df)
8918 v2df __builtin_ia32_cmpordpd (v2df, v2df)
8919 v2df __builtin_ia32_cmpeqsd (v2df, v2df)
8920 v2df __builtin_ia32_cmpltsd (v2df, v2df)
8921 v2df __builtin_ia32_cmplesd (v2df, v2df)
8922 v2df __builtin_ia32_cmpunordsd (v2df, v2df)
8923 v2df __builtin_ia32_cmpneqsd (v2df, v2df)
8924 v2df __builtin_ia32_cmpnltsd (v2df, v2df)
8925 v2df __builtin_ia32_cmpnlesd (v2df, v2df)
8926 v2df __builtin_ia32_cmpordsd (v2df, v2df)
8927 v2di __builtin_ia32_paddq (v2di, v2di)
8928 v2di __builtin_ia32_psubq (v2di, v2di)
8929 v2df __builtin_ia32_addpd (v2df, v2df)
8930 v2df __builtin_ia32_subpd (v2df, v2df)
8931 v2df __builtin_ia32_mulpd (v2df, v2df)
8932 v2df __builtin_ia32_divpd (v2df, v2df)
8933 v2df __builtin_ia32_addsd (v2df, v2df)
8934 v2df __builtin_ia32_subsd (v2df, v2df)
8935 v2df __builtin_ia32_mulsd (v2df, v2df)
8936 v2df __builtin_ia32_divsd (v2df, v2df)
8937 v2df __builtin_ia32_minpd (v2df, v2df)
8938 v2df __builtin_ia32_maxpd (v2df, v2df)
8939 v2df __builtin_ia32_minsd (v2df, v2df)
8940 v2df __builtin_ia32_maxsd (v2df, v2df)
8941 v2df __builtin_ia32_andpd (v2df, v2df)
8942 v2df __builtin_ia32_andnpd (v2df, v2df)
8943 v2df __builtin_ia32_orpd (v2df, v2df)
8944 v2df __builtin_ia32_xorpd (v2df, v2df)
8945 v2df __builtin_ia32_movsd (v2df, v2df)
8946 v2df __builtin_ia32_unpckhpd (v2df, v2df)
8947 v2df __builtin_ia32_unpcklpd (v2df, v2df)
8948 v16qi __builtin_ia32_paddb128 (v16qi, v16qi)
8949 v8hi __builtin_ia32_paddw128 (v8hi, v8hi)
8950 v4si __builtin_ia32_paddd128 (v4si, v4si)
8951 v2di __builtin_ia32_paddq128 (v2di, v2di)
8952 v16qi __builtin_ia32_psubb128 (v16qi, v16qi)
8953 v8hi __builtin_ia32_psubw128 (v8hi, v8hi)
8954 v4si __builtin_ia32_psubd128 (v4si, v4si)
8955 v2di __builtin_ia32_psubq128 (v2di, v2di)
8956 v8hi __builtin_ia32_pmullw128 (v8hi, v8hi)
8957 v8hi __builtin_ia32_pmulhw128 (v8hi, v8hi)
8958 v2di __builtin_ia32_pand128 (v2di, v2di)
8959 v2di __builtin_ia32_pandn128 (v2di, v2di)
8960 v2di __builtin_ia32_por128 (v2di, v2di)
8961 v2di __builtin_ia32_pxor128 (v2di, v2di)
8962 v16qi __builtin_ia32_pavgb128 (v16qi, v16qi)
8963 v8hi __builtin_ia32_pavgw128 (v8hi, v8hi)
8964 v16qi __builtin_ia32_pcmpeqb128 (v16qi, v16qi)
8965 v8hi __builtin_ia32_pcmpeqw128 (v8hi, v8hi)
8966 v4si __builtin_ia32_pcmpeqd128 (v4si, v4si)
8967 v16qi __builtin_ia32_pcmpgtb128 (v16qi, v16qi)
8968 v8hi __builtin_ia32_pcmpgtw128 (v8hi, v8hi)
8969 v4si __builtin_ia32_pcmpgtd128 (v4si, v4si)
8970 v16qi __builtin_ia32_pmaxub128 (v16qi, v16qi)
8971 v8hi __builtin_ia32_pmaxsw128 (v8hi, v8hi)
8972 v16qi __builtin_ia32_pminub128 (v16qi, v16qi)
8973 v8hi __builtin_ia32_pminsw128 (v8hi, v8hi)
8974 v16qi __builtin_ia32_punpckhbw128 (v16qi, v16qi)
8975 v8hi __builtin_ia32_punpckhwd128 (v8hi, v8hi)
8976 v4si __builtin_ia32_punpckhdq128 (v4si, v4si)
8977 v2di __builtin_ia32_punpckhqdq128 (v2di, v2di)
8978 v16qi __builtin_ia32_punpcklbw128 (v16qi, v16qi)
8979 v8hi __builtin_ia32_punpcklwd128 (v8hi, v8hi)
8980 v4si __builtin_ia32_punpckldq128 (v4si, v4si)
8981 v2di __builtin_ia32_punpcklqdq128 (v2di, v2di)
8982 v16qi __builtin_ia32_packsswb128 (v8hi, v8hi)
8983 v8hi __builtin_ia32_packssdw128 (v4si, v4si)
8984 v16qi __builtin_ia32_packuswb128 (v8hi, v8hi)
8985 v8hi __builtin_ia32_pmulhuw128 (v8hi, v8hi)
8986 void __builtin_ia32_maskmovdqu (v16qi, v16qi)
8987 v2df __builtin_ia32_loadupd (double *)
8988 void __builtin_ia32_storeupd (double *, v2df)
8989 v2df __builtin_ia32_loadhpd (v2df, double const *)
8990 v2df __builtin_ia32_loadlpd (v2df, double const *)
8991 int __builtin_ia32_movmskpd (v2df)
8992 int __builtin_ia32_pmovmskb128 (v16qi)
8993 void __builtin_ia32_movnti (int *, int)
8994 void __builtin_ia32_movntpd (double *, v2df)
8995 void __builtin_ia32_movntdq (v2df *, v2df)
8996 v4si __builtin_ia32_pshufd (v4si, int)
8997 v8hi __builtin_ia32_pshuflw (v8hi, int)
8998 v8hi __builtin_ia32_pshufhw (v8hi, int)
8999 v2di __builtin_ia32_psadbw128 (v16qi, v16qi)
9000 v2df __builtin_ia32_sqrtpd (v2df)
9001 v2df __builtin_ia32_sqrtsd (v2df)
9002 v2df __builtin_ia32_shufpd (v2df, v2df, int)
9003 v2df __builtin_ia32_cvtdq2pd (v4si)
9004 v4sf __builtin_ia32_cvtdq2ps (v4si)
9005 v4si __builtin_ia32_cvtpd2dq (v2df)
9006 v2si __builtin_ia32_cvtpd2pi (v2df)
9007 v4sf __builtin_ia32_cvtpd2ps (v2df)
9008 v4si __builtin_ia32_cvttpd2dq (v2df)
9009 v2si __builtin_ia32_cvttpd2pi (v2df)
9010 v2df __builtin_ia32_cvtpi2pd (v2si)
9011 int __builtin_ia32_cvtsd2si (v2df)
9012 int __builtin_ia32_cvttsd2si (v2df)
9013 long long __builtin_ia32_cvtsd2si64 (v2df)
9014 long long __builtin_ia32_cvttsd2si64 (v2df)
9015 v4si __builtin_ia32_cvtps2dq (v4sf)
9016 v2df __builtin_ia32_cvtps2pd (v4sf)
9017 v4si __builtin_ia32_cvttps2dq (v4sf)
9018 v2df __builtin_ia32_cvtsi2sd (v2df, int)
9019 v2df __builtin_ia32_cvtsi642sd (v2df, long long)
9020 v4sf __builtin_ia32_cvtsd2ss (v4sf, v2df)
9021 v2df __builtin_ia32_cvtss2sd (v2df, v4sf)
9022 void __builtin_ia32_clflush (const void *)
9023 void __builtin_ia32_lfence (void)
9024 void __builtin_ia32_mfence (void)
9025 v16qi __builtin_ia32_loaddqu (const char *)
9026 void __builtin_ia32_storedqu (char *, v16qi)
9027 v1di __builtin_ia32_pmuludq (v2si, v2si)
9028 v2di __builtin_ia32_pmuludq128 (v4si, v4si)
9029 v8hi __builtin_ia32_psllw128 (v8hi, v8hi)
9030 v4si __builtin_ia32_pslld128 (v4si, v4si)
9031 v2di __builtin_ia32_psllq128 (v2di, v2di)
9032 v8hi __builtin_ia32_psrlw128 (v8hi, v8hi)
9033 v4si __builtin_ia32_psrld128 (v4si, v4si)
9034 v2di __builtin_ia32_psrlq128 (v2di, v2di)
9035 v8hi __builtin_ia32_psraw128 (v8hi, v8hi)
9036 v4si __builtin_ia32_psrad128 (v4si, v4si)
9037 v2di __builtin_ia32_pslldqi128 (v2di, int)
9038 v8hi __builtin_ia32_psllwi128 (v8hi, int)
9039 v4si __builtin_ia32_pslldi128 (v4si, int)
9040 v2di __builtin_ia32_psllqi128 (v2di, int)
9041 v2di __builtin_ia32_psrldqi128 (v2di, int)
9042 v8hi __builtin_ia32_psrlwi128 (v8hi, int)
9043 v4si __builtin_ia32_psrldi128 (v4si, int)
9044 v2di __builtin_ia32_psrlqi128 (v2di, int)
9045 v8hi __builtin_ia32_psrawi128 (v8hi, int)
9046 v4si __builtin_ia32_psradi128 (v4si, int)
9047 v4si __builtin_ia32_pmaddwd128 (v8hi, v8hi)
9048 v2di __builtin_ia32_movq128 (v2di)
9049 @end smallexample
9050
9051 The following built-in functions are available when @option{-msse3} is used.
9052 All of them generate the machine instruction that is part of the name.
9053
9054 @smallexample
9055 v2df __builtin_ia32_addsubpd (v2df, v2df)
9056 v4sf __builtin_ia32_addsubps (v4sf, v4sf)
9057 v2df __builtin_ia32_haddpd (v2df, v2df)
9058 v4sf __builtin_ia32_haddps (v4sf, v4sf)
9059 v2df __builtin_ia32_hsubpd (v2df, v2df)
9060 v4sf __builtin_ia32_hsubps (v4sf, v4sf)
9061 v16qi __builtin_ia32_lddqu (char const *)
9062 void __builtin_ia32_monitor (void *, unsigned int, unsigned int)
9063 v2df __builtin_ia32_movddup (v2df)
9064 v4sf __builtin_ia32_movshdup (v4sf)
9065 v4sf __builtin_ia32_movsldup (v4sf)
9066 void __builtin_ia32_mwait (unsigned int, unsigned int)
9067 @end smallexample
9068
9069 The following built-in functions are available when @option{-msse3} is used.
9070
9071 @table @code
9072 @item v2df __builtin_ia32_loadddup (double const *)
9073 Generates the @code{movddup} machine instruction as a load from memory.
9074 @end table
9075
9076 The following built-in functions are available when @option{-mssse3} is used.
9077 All of them generate the machine instruction that is part of the name
9078 with MMX registers.
9079
9080 @smallexample
9081 v2si __builtin_ia32_phaddd (v2si, v2si)
9082 v4hi __builtin_ia32_phaddw (v4hi, v4hi)
9083 v4hi __builtin_ia32_phaddsw (v4hi, v4hi)
9084 v2si __builtin_ia32_phsubd (v2si, v2si)
9085 v4hi __builtin_ia32_phsubw (v4hi, v4hi)
9086 v4hi __builtin_ia32_phsubsw (v4hi, v4hi)
9087 v4hi __builtin_ia32_pmaddubsw (v8qi, v8qi)
9088 v4hi __builtin_ia32_pmulhrsw (v4hi, v4hi)
9089 v8qi __builtin_ia32_pshufb (v8qi, v8qi)
9090 v8qi __builtin_ia32_psignb (v8qi, v8qi)
9091 v2si __builtin_ia32_psignd (v2si, v2si)
9092 v4hi __builtin_ia32_psignw (v4hi, v4hi)
9093 v1di __builtin_ia32_palignr (v1di, v1di, int)
9094 v8qi __builtin_ia32_pabsb (v8qi)
9095 v2si __builtin_ia32_pabsd (v2si)
9096 v4hi __builtin_ia32_pabsw (v4hi)
9097 @end smallexample
9098
9099 The following built-in functions are available when @option{-mssse3} is used.
9100 All of them generate the machine instruction that is part of the name
9101 with SSE registers.
9102
9103 @smallexample
9104 v4si __builtin_ia32_phaddd128 (v4si, v4si)
9105 v8hi __builtin_ia32_phaddw128 (v8hi, v8hi)
9106 v8hi __builtin_ia32_phaddsw128 (v8hi, v8hi)
9107 v4si __builtin_ia32_phsubd128 (v4si, v4si)
9108 v8hi __builtin_ia32_phsubw128 (v8hi, v8hi)
9109 v8hi __builtin_ia32_phsubsw128 (v8hi, v8hi)
9110 v8hi __builtin_ia32_pmaddubsw128 (v16qi, v16qi)
9111 v8hi __builtin_ia32_pmulhrsw128 (v8hi, v8hi)
9112 v16qi __builtin_ia32_pshufb128 (v16qi, v16qi)
9113 v16qi __builtin_ia32_psignb128 (v16qi, v16qi)
9114 v4si __builtin_ia32_psignd128 (v4si, v4si)
9115 v8hi __builtin_ia32_psignw128 (v8hi, v8hi)
9116 v2di __builtin_ia32_palignr128 (v2di, v2di, int)
9117 v16qi __builtin_ia32_pabsb128 (v16qi)
9118 v4si __builtin_ia32_pabsd128 (v4si)
9119 v8hi __builtin_ia32_pabsw128 (v8hi)
9120 @end smallexample
9121
9122 The following built-in functions are available when @option{-msse4.1} is
9123 used.  All of them generate the machine instruction that is part of the
9124 name.
9125
9126 @smallexample
9127 v2df __builtin_ia32_blendpd (v2df, v2df, const int)
9128 v4sf __builtin_ia32_blendps (v4sf, v4sf, const int)
9129 v2df __builtin_ia32_blendvpd (v2df, v2df, v2df)
9130 v4sf __builtin_ia32_blendvps (v4sf, v4sf, v4sf)
9131 v2df __builtin_ia32_dppd (v2df, v2df, const int)
9132 v4sf __builtin_ia32_dpps (v4sf, v4sf, const int)
9133 v4sf __builtin_ia32_insertps128 (v4sf, v4sf, const int)
9134 v2di __builtin_ia32_movntdqa (v2di *);
9135 v16qi __builtin_ia32_mpsadbw128 (v16qi, v16qi, const int)
9136 v8hi __builtin_ia32_packusdw128 (v4si, v4si)
9137 v16qi __builtin_ia32_pblendvb128 (v16qi, v16qi, v16qi)
9138 v8hi __builtin_ia32_pblendw128 (v8hi, v8hi, const int)
9139 v2di __builtin_ia32_pcmpeqq (v2di, v2di)
9140 v8hi __builtin_ia32_phminposuw128 (v8hi)
9141 v16qi __builtin_ia32_pmaxsb128 (v16qi, v16qi)
9142 v4si __builtin_ia32_pmaxsd128 (v4si, v4si)
9143 v4si __builtin_ia32_pmaxud128 (v4si, v4si)
9144 v8hi __builtin_ia32_pmaxuw128 (v8hi, v8hi)
9145 v16qi __builtin_ia32_pminsb128 (v16qi, v16qi)
9146 v4si __builtin_ia32_pminsd128 (v4si, v4si)
9147 v4si __builtin_ia32_pminud128 (v4si, v4si)
9148 v8hi __builtin_ia32_pminuw128 (v8hi, v8hi)
9149 v4si __builtin_ia32_pmovsxbd128 (v16qi)
9150 v2di __builtin_ia32_pmovsxbq128 (v16qi)
9151 v8hi __builtin_ia32_pmovsxbw128 (v16qi)
9152 v2di __builtin_ia32_pmovsxdq128 (v4si)
9153 v4si __builtin_ia32_pmovsxwd128 (v8hi)
9154 v2di __builtin_ia32_pmovsxwq128 (v8hi)
9155 v4si __builtin_ia32_pmovzxbd128 (v16qi)
9156 v2di __builtin_ia32_pmovzxbq128 (v16qi)
9157 v8hi __builtin_ia32_pmovzxbw128 (v16qi)
9158 v2di __builtin_ia32_pmovzxdq128 (v4si)
9159 v4si __builtin_ia32_pmovzxwd128 (v8hi)
9160 v2di __builtin_ia32_pmovzxwq128 (v8hi)
9161 v2di __builtin_ia32_pmuldq128 (v4si, v4si)
9162 v4si __builtin_ia32_pmulld128 (v4si, v4si)
9163 int __builtin_ia32_ptestc128 (v2di, v2di)
9164 int __builtin_ia32_ptestnzc128 (v2di, v2di)
9165 int __builtin_ia32_ptestz128 (v2di, v2di)
9166 v2df __builtin_ia32_roundpd (v2df, const int)
9167 v4sf __builtin_ia32_roundps (v4sf, const int)
9168 v2df __builtin_ia32_roundsd (v2df, v2df, const int)
9169 v4sf __builtin_ia32_roundss (v4sf, v4sf, const int)
9170 @end smallexample
9171
9172 The following built-in functions are available when @option{-msse4.1} is
9173 used.
9174
9175 @table @code
9176 @item v4sf __builtin_ia32_vec_set_v4sf (v4sf, float, const int)
9177 Generates the @code{insertps} machine instruction.
9178 @item int __builtin_ia32_vec_ext_v16qi (v16qi, const int)
9179 Generates the @code{pextrb} machine instruction.
9180 @item v16qi __builtin_ia32_vec_set_v16qi (v16qi, int, const int)
9181 Generates the @code{pinsrb} machine instruction.
9182 @item v4si __builtin_ia32_vec_set_v4si (v4si, int, const int)
9183 Generates the @code{pinsrd} machine instruction.
9184 @item v2di __builtin_ia32_vec_set_v2di (v2di, long long, const int)
9185 Generates the @code{pinsrq} machine instruction in 64bit mode.
9186 @end table
9187
9188 The following built-in functions are changed to generate new SSE4.1
9189 instructions when @option{-msse4.1} is used.
9190
9191 @table @code
9192 @item float __builtin_ia32_vec_ext_v4sf (v4sf, const int)
9193 Generates the @code{extractps} machine instruction.
9194 @item int __builtin_ia32_vec_ext_v4si (v4si, const int)
9195 Generates the @code{pextrd} machine instruction.
9196 @item long long __builtin_ia32_vec_ext_v2di (v2di, const int)
9197 Generates the @code{pextrq} machine instruction in 64bit mode.
9198 @end table
9199
9200 The following built-in functions are available when @option{-msse4.2} is
9201 used.  All of them generate the machine instruction that is part of the
9202 name.
9203
9204 @smallexample
9205 v16qi __builtin_ia32_pcmpestrm128 (v16qi, int, v16qi, int, const int)
9206 int __builtin_ia32_pcmpestri128 (v16qi, int, v16qi, int, const int)
9207 int __builtin_ia32_pcmpestria128 (v16qi, int, v16qi, int, const int)
9208 int __builtin_ia32_pcmpestric128 (v16qi, int, v16qi, int, const int)
9209 int __builtin_ia32_pcmpestrio128 (v16qi, int, v16qi, int, const int)
9210 int __builtin_ia32_pcmpestris128 (v16qi, int, v16qi, int, const int)
9211 int __builtin_ia32_pcmpestriz128 (v16qi, int, v16qi, int, const int)
9212 v16qi __builtin_ia32_pcmpistrm128 (v16qi, v16qi, const int)
9213 int __builtin_ia32_pcmpistri128 (v16qi, v16qi, const int)
9214 int __builtin_ia32_pcmpistria128 (v16qi, v16qi, const int)
9215 int __builtin_ia32_pcmpistric128 (v16qi, v16qi, const int)
9216 int __builtin_ia32_pcmpistrio128 (v16qi, v16qi, const int)
9217 int __builtin_ia32_pcmpistris128 (v16qi, v16qi, const int)
9218 int __builtin_ia32_pcmpistriz128 (v16qi, v16qi, const int)
9219 v2di __builtin_ia32_pcmpgtq (v2di, v2di)
9220 @end smallexample
9221
9222 The following built-in functions are available when @option{-msse4.2} is
9223 used.
9224
9225 @table @code
9226 @item unsigned int __builtin_ia32_crc32qi (unsigned int, unsigned char)
9227 Generates the @code{crc32b} machine instruction.
9228 @item unsigned int __builtin_ia32_crc32hi (unsigned int, unsigned short)
9229 Generates the @code{crc32w} machine instruction.
9230 @item unsigned int __builtin_ia32_crc32si (unsigned int, unsigned int)
9231 Generates the @code{crc32l} machine instruction.
9232 @item unsigned long long __builtin_ia32_crc32di (unsigned long long, unsigned long long)
9233 Generates the @code{crc32q} machine instruction.
9234 @end table
9235
9236 The following built-in functions are changed to generate new SSE4.2
9237 instructions when @option{-msse4.2} is used.
9238
9239 @table @code
9240 @item int __builtin_popcount (unsigned int)
9241 Generates the @code{popcntl} machine instruction.
9242 @item int __builtin_popcountl (unsigned long)
9243 Generates the @code{popcntl} or @code{popcntq} machine instruction,
9244 depending on the size of @code{unsigned long}.
9245 @item int __builtin_popcountll (unsigned long long)
9246 Generates the @code{popcntq} machine instruction.
9247 @end table
9248
9249 The following built-in functions are available when @option{-mavx} is
9250 used. All of them generate the machine instruction that is part of the
9251 name.
9252
9253 @smallexample
9254 v4df __builtin_ia32_addpd256 (v4df,v4df)
9255 v8sf __builtin_ia32_addps256 (v8sf,v8sf)
9256 v4df __builtin_ia32_addsubpd256 (v4df,v4df)
9257 v8sf __builtin_ia32_addsubps256 (v8sf,v8sf)
9258 v4df __builtin_ia32_andnpd256 (v4df,v4df)
9259 v8sf __builtin_ia32_andnps256 (v8sf,v8sf)
9260 v4df __builtin_ia32_andpd256 (v4df,v4df)
9261 v8sf __builtin_ia32_andps256 (v8sf,v8sf)
9262 v4df __builtin_ia32_blendpd256 (v4df,v4df,int)
9263 v8sf __builtin_ia32_blendps256 (v8sf,v8sf,int)
9264 v4df __builtin_ia32_blendvpd256 (v4df,v4df,v4df)
9265 v8sf __builtin_ia32_blendvps256 (v8sf,v8sf,v8sf)
9266 v2df __builtin_ia32_cmppd (v2df,v2df,int)
9267 v4df __builtin_ia32_cmppd256 (v4df,v4df,int)
9268 v4sf __builtin_ia32_cmpps (v4sf,v4sf,int)
9269 v8sf __builtin_ia32_cmpps256 (v8sf,v8sf,int)
9270 v2df __builtin_ia32_cmpsd (v2df,v2df,int)
9271 v4sf __builtin_ia32_cmpss (v4sf,v4sf,int)
9272 v4df __builtin_ia32_cvtdq2pd256 (v4si)
9273 v8sf __builtin_ia32_cvtdq2ps256 (v8si)
9274 v4si __builtin_ia32_cvtpd2dq256 (v4df)
9275 v4sf __builtin_ia32_cvtpd2ps256 (v4df)
9276 v8si __builtin_ia32_cvtps2dq256 (v8sf)
9277 v4df __builtin_ia32_cvtps2pd256 (v4sf)
9278 v4si __builtin_ia32_cvttpd2dq256 (v4df)
9279 v8si __builtin_ia32_cvttps2dq256 (v8sf)
9280 v4df __builtin_ia32_divpd256 (v4df,v4df)
9281 v8sf __builtin_ia32_divps256 (v8sf,v8sf)
9282 v8sf __builtin_ia32_dpps256 (v8sf,v8sf,int)
9283 v4df __builtin_ia32_haddpd256 (v4df,v4df)
9284 v8sf __builtin_ia32_haddps256 (v8sf,v8sf)
9285 v4df __builtin_ia32_hsubpd256 (v4df,v4df)
9286 v8sf __builtin_ia32_hsubps256 (v8sf,v8sf)
9287 v32qi __builtin_ia32_lddqu256 (pcchar)
9288 v32qi __builtin_ia32_loaddqu256 (pcchar)
9289 v4df __builtin_ia32_loadupd256 (pcdouble)
9290 v8sf __builtin_ia32_loadups256 (pcfloat)
9291 v2df __builtin_ia32_maskloadpd (pcv2df,v2df)
9292 v4df __builtin_ia32_maskloadpd256 (pcv4df,v4df)
9293 v4sf __builtin_ia32_maskloadps (pcv4sf,v4sf)
9294 v8sf __builtin_ia32_maskloadps256 (pcv8sf,v8sf)
9295 void __builtin_ia32_maskstorepd (pv2df,v2df,v2df)
9296 void __builtin_ia32_maskstorepd256 (pv4df,v4df,v4df)
9297 void __builtin_ia32_maskstoreps (pv4sf,v4sf,v4sf)
9298 void __builtin_ia32_maskstoreps256 (pv8sf,v8sf,v8sf)
9299 v4df __builtin_ia32_maxpd256 (v4df,v4df)
9300 v8sf __builtin_ia32_maxps256 (v8sf,v8sf)
9301 v4df __builtin_ia32_minpd256 (v4df,v4df)
9302 v8sf __builtin_ia32_minps256 (v8sf,v8sf)
9303 v4df __builtin_ia32_movddup256 (v4df)
9304 int __builtin_ia32_movmskpd256 (v4df)
9305 int __builtin_ia32_movmskps256 (v8sf)
9306 v8sf __builtin_ia32_movshdup256 (v8sf)
9307 v8sf __builtin_ia32_movsldup256 (v8sf)
9308 v4df __builtin_ia32_mulpd256 (v4df,v4df)
9309 v8sf __builtin_ia32_mulps256 (v8sf,v8sf)
9310 v4df __builtin_ia32_orpd256 (v4df,v4df)
9311 v8sf __builtin_ia32_orps256 (v8sf,v8sf)
9312 v2df __builtin_ia32_pd_pd256 (v4df)
9313 v4df __builtin_ia32_pd256_pd (v2df)
9314 v4sf __builtin_ia32_ps_ps256 (v8sf)
9315 v8sf __builtin_ia32_ps256_ps (v4sf)
9316 int __builtin_ia32_ptestc256 (v4di,v4di,ptest)
9317 int __builtin_ia32_ptestnzc256 (v4di,v4di,ptest)
9318 int __builtin_ia32_ptestz256 (v4di,v4di,ptest)
9319 v8sf __builtin_ia32_rcpps256 (v8sf)
9320 v4df __builtin_ia32_roundpd256 (v4df,int)
9321 v8sf __builtin_ia32_roundps256 (v8sf,int)
9322 v8sf __builtin_ia32_rsqrtps_nr256 (v8sf)
9323 v8sf __builtin_ia32_rsqrtps256 (v8sf)
9324 v4df __builtin_ia32_shufpd256 (v4df,v4df,int)
9325 v8sf __builtin_ia32_shufps256 (v8sf,v8sf,int)
9326 v4si __builtin_ia32_si_si256 (v8si)
9327 v8si __builtin_ia32_si256_si (v4si)
9328 v4df __builtin_ia32_sqrtpd256 (v4df)
9329 v8sf __builtin_ia32_sqrtps_nr256 (v8sf)
9330 v8sf __builtin_ia32_sqrtps256 (v8sf)
9331 void __builtin_ia32_storedqu256 (pchar,v32qi)
9332 void __builtin_ia32_storeupd256 (pdouble,v4df)
9333 void __builtin_ia32_storeups256 (pfloat,v8sf)
9334 v4df __builtin_ia32_subpd256 (v4df,v4df)
9335 v8sf __builtin_ia32_subps256 (v8sf,v8sf)
9336 v4df __builtin_ia32_unpckhpd256 (v4df,v4df)
9337 v8sf __builtin_ia32_unpckhps256 (v8sf,v8sf)
9338 v4df __builtin_ia32_unpcklpd256 (v4df,v4df)
9339 v8sf __builtin_ia32_unpcklps256 (v8sf,v8sf)
9340 v4df __builtin_ia32_vbroadcastf128_pd256 (pcv2df)
9341 v8sf __builtin_ia32_vbroadcastf128_ps256 (pcv4sf)
9342 v4df __builtin_ia32_vbroadcastsd256 (pcdouble)
9343 v4sf __builtin_ia32_vbroadcastss (pcfloat)
9344 v8sf __builtin_ia32_vbroadcastss256 (pcfloat)
9345 v2df __builtin_ia32_vextractf128_pd256 (v4df,int)
9346 v4sf __builtin_ia32_vextractf128_ps256 (v8sf,int)
9347 v4si __builtin_ia32_vextractf128_si256 (v8si,int)
9348 v4df __builtin_ia32_vinsertf128_pd256 (v4df,v2df,int)
9349 v8sf __builtin_ia32_vinsertf128_ps256 (v8sf,v4sf,int)
9350 v8si __builtin_ia32_vinsertf128_si256 (v8si,v4si,int)
9351 v4df __builtin_ia32_vperm2f128_pd256 (v4df,v4df,int)
9352 v8sf __builtin_ia32_vperm2f128_ps256 (v8sf,v8sf,int)
9353 v8si __builtin_ia32_vperm2f128_si256 (v8si,v8si,int)
9354 v2df __builtin_ia32_vpermil2pd (v2df,v2df,v2di,int)
9355 v4df __builtin_ia32_vpermil2pd256 (v4df,v4df,v4di,int)
9356 v4sf __builtin_ia32_vpermil2ps (v4sf,v4sf,v4si,int)
9357 v8sf __builtin_ia32_vpermil2ps256 (v8sf,v8sf,v8si,int)
9358 v2df __builtin_ia32_vpermilpd (v2df,int)
9359 v4df __builtin_ia32_vpermilpd256 (v4df,int)
9360 v4sf __builtin_ia32_vpermilps (v4sf,int)
9361 v8sf __builtin_ia32_vpermilps256 (v8sf,int)
9362 v2df __builtin_ia32_vpermilvarpd (v2df,v2di)
9363 v4df __builtin_ia32_vpermilvarpd256 (v4df,v4di)
9364 v4sf __builtin_ia32_vpermilvarps (v4sf,v4si)
9365 v8sf __builtin_ia32_vpermilvarps256 (v8sf,v8si)
9366 int __builtin_ia32_vtestcpd (v2df,v2df,ptest)
9367 int __builtin_ia32_vtestcpd256 (v4df,v4df,ptest)
9368 int __builtin_ia32_vtestcps (v4sf,v4sf,ptest)
9369 int __builtin_ia32_vtestcps256 (v8sf,v8sf,ptest)
9370 int __builtin_ia32_vtestnzcpd (v2df,v2df,ptest)
9371 int __builtin_ia32_vtestnzcpd256 (v4df,v4df,ptest)
9372 int __builtin_ia32_vtestnzcps (v4sf,v4sf,ptest)
9373 int __builtin_ia32_vtestnzcps256 (v8sf,v8sf,ptest)
9374 int __builtin_ia32_vtestzpd (v2df,v2df,ptest)
9375 int __builtin_ia32_vtestzpd256 (v4df,v4df,ptest)
9376 int __builtin_ia32_vtestzps (v4sf,v4sf,ptest)
9377 int __builtin_ia32_vtestzps256 (v8sf,v8sf,ptest)
9378 void __builtin_ia32_vzeroall (void)
9379 void __builtin_ia32_vzeroupper (void)
9380 v4df __builtin_ia32_xorpd256 (v4df,v4df)
9381 v8sf __builtin_ia32_xorps256 (v8sf,v8sf)
9382 @end smallexample
9383
9384 The following built-in functions are available when @option{-maes} is
9385 used.  All of them generate the machine instruction that is part of the
9386 name.
9387
9388 @smallexample
9389 v2di __builtin_ia32_aesenc128 (v2di, v2di)
9390 v2di __builtin_ia32_aesenclast128 (v2di, v2di)
9391 v2di __builtin_ia32_aesdec128 (v2di, v2di)
9392 v2di __builtin_ia32_aesdeclast128 (v2di, v2di)
9393 v2di __builtin_ia32_aeskeygenassist128 (v2di, const int)
9394 v2di __builtin_ia32_aesimc128 (v2di)
9395 @end smallexample
9396
9397 The following built-in function is available when @option{-mpclmul} is
9398 used.
9399
9400 @table @code
9401 @item v2di __builtin_ia32_pclmulqdq128 (v2di, v2di, const int)
9402 Generates the @code{pclmulqdq} machine instruction.
9403 @end table
9404
9405 The following built-in function is available when @option{-mfsgsbase} is
9406 used.  All of them generate the machine instruction that is part of the
9407 name.
9408
9409 @smallexample
9410 unsigned int __builtin_ia32_rdfsbase32 (void)
9411 unsigned long long __builtin_ia32_rdfsbase64 (void)
9412 unsigned int __builtin_ia32_rdgsbase32 (void)
9413 unsigned long long __builtin_ia32_rdgsbase64 (void)
9414 void _writefsbase_u32 (unsigned int)
9415 void _writefsbase_u64 (unsigned long long)
9416 void _writegsbase_u32 (unsigned int)
9417 void _writegsbase_u64 (unsigned long long)
9418 @end smallexample
9419
9420 The following built-in function is available when @option{-mrdrnd} is
9421 used.  All of them generate the machine instruction that is part of the
9422 name.
9423
9424 @smallexample
9425 unsigned int __builtin_ia32_rdrand16_step (unsigned short *)
9426 unsigned int __builtin_ia32_rdrand32_step (unsigned int *)
9427 unsigned int __builtin_ia32_rdrand64_step (unsigned long long *)
9428 @end smallexample
9429
9430 The following built-in functions are available when @option{-msse4a} is used.
9431 All of them generate the machine instruction that is part of the name.
9432
9433 @smallexample
9434 void __builtin_ia32_movntsd (double *, v2df)
9435 void __builtin_ia32_movntss (float *, v4sf)
9436 v2di __builtin_ia32_extrq  (v2di, v16qi)
9437 v2di __builtin_ia32_extrqi (v2di, const unsigned int, const unsigned int)
9438 v2di __builtin_ia32_insertq (v2di, v2di)
9439 v2di __builtin_ia32_insertqi (v2di, v2di, const unsigned int, const unsigned int)
9440 @end smallexample
9441
9442 The following built-in functions are available when @option{-mxop} is used.
9443 @smallexample
9444 v2df __builtin_ia32_vfrczpd (v2df)
9445 v4sf __builtin_ia32_vfrczps (v4sf)
9446 v2df __builtin_ia32_vfrczsd (v2df, v2df)
9447 v4sf __builtin_ia32_vfrczss (v4sf, v4sf)
9448 v4df __builtin_ia32_vfrczpd256 (v4df)
9449 v8sf __builtin_ia32_vfrczps256 (v8sf)
9450 v2di __builtin_ia32_vpcmov (v2di, v2di, v2di)
9451 v2di __builtin_ia32_vpcmov_v2di (v2di, v2di, v2di)
9452 v4si __builtin_ia32_vpcmov_v4si (v4si, v4si, v4si)
9453 v8hi __builtin_ia32_vpcmov_v8hi (v8hi, v8hi, v8hi)
9454 v16qi __builtin_ia32_vpcmov_v16qi (v16qi, v16qi, v16qi)
9455 v2df __builtin_ia32_vpcmov_v2df (v2df, v2df, v2df)
9456 v4sf __builtin_ia32_vpcmov_v4sf (v4sf, v4sf, v4sf)
9457 v4di __builtin_ia32_vpcmov_v4di256 (v4di, v4di, v4di)
9458 v8si __builtin_ia32_vpcmov_v8si256 (v8si, v8si, v8si)
9459 v16hi __builtin_ia32_vpcmov_v16hi256 (v16hi, v16hi, v16hi)
9460 v32qi __builtin_ia32_vpcmov_v32qi256 (v32qi, v32qi, v32qi)
9461 v4df __builtin_ia32_vpcmov_v4df256 (v4df, v4df, v4df)
9462 v8sf __builtin_ia32_vpcmov_v8sf256 (v8sf, v8sf, v8sf)
9463 v16qi __builtin_ia32_vpcomeqb (v16qi, v16qi)
9464 v8hi __builtin_ia32_vpcomeqw (v8hi, v8hi)
9465 v4si __builtin_ia32_vpcomeqd (v4si, v4si)
9466 v2di __builtin_ia32_vpcomeqq (v2di, v2di)
9467 v16qi __builtin_ia32_vpcomequb (v16qi, v16qi)
9468 v4si __builtin_ia32_vpcomequd (v4si, v4si)
9469 v2di __builtin_ia32_vpcomequq (v2di, v2di)
9470 v8hi __builtin_ia32_vpcomequw (v8hi, v8hi)
9471 v8hi __builtin_ia32_vpcomeqw (v8hi, v8hi)
9472 v16qi __builtin_ia32_vpcomfalseb (v16qi, v16qi)
9473 v4si __builtin_ia32_vpcomfalsed (v4si, v4si)
9474 v2di __builtin_ia32_vpcomfalseq (v2di, v2di)
9475 v16qi __builtin_ia32_vpcomfalseub (v16qi, v16qi)
9476 v4si __builtin_ia32_vpcomfalseud (v4si, v4si)
9477 v2di __builtin_ia32_vpcomfalseuq (v2di, v2di)
9478 v8hi __builtin_ia32_vpcomfalseuw (v8hi, v8hi)
9479 v8hi __builtin_ia32_vpcomfalsew (v8hi, v8hi)
9480 v16qi __builtin_ia32_vpcomgeb (v16qi, v16qi)
9481 v4si __builtin_ia32_vpcomged (v4si, v4si)
9482 v2di __builtin_ia32_vpcomgeq (v2di, v2di)
9483 v16qi __builtin_ia32_vpcomgeub (v16qi, v16qi)
9484 v4si __builtin_ia32_vpcomgeud (v4si, v4si)
9485 v2di __builtin_ia32_vpcomgeuq (v2di, v2di)
9486 v8hi __builtin_ia32_vpcomgeuw (v8hi, v8hi)
9487 v8hi __builtin_ia32_vpcomgew (v8hi, v8hi)
9488 v16qi __builtin_ia32_vpcomgtb (v16qi, v16qi)
9489 v4si __builtin_ia32_vpcomgtd (v4si, v4si)
9490 v2di __builtin_ia32_vpcomgtq (v2di, v2di)
9491 v16qi __builtin_ia32_vpcomgtub (v16qi, v16qi)
9492 v4si __builtin_ia32_vpcomgtud (v4si, v4si)
9493 v2di __builtin_ia32_vpcomgtuq (v2di, v2di)
9494 v8hi __builtin_ia32_vpcomgtuw (v8hi, v8hi)
9495 v8hi __builtin_ia32_vpcomgtw (v8hi, v8hi)
9496 v16qi __builtin_ia32_vpcomleb (v16qi, v16qi)
9497 v4si __builtin_ia32_vpcomled (v4si, v4si)
9498 v2di __builtin_ia32_vpcomleq (v2di, v2di)
9499 v16qi __builtin_ia32_vpcomleub (v16qi, v16qi)
9500 v4si __builtin_ia32_vpcomleud (v4si, v4si)
9501 v2di __builtin_ia32_vpcomleuq (v2di, v2di)
9502 v8hi __builtin_ia32_vpcomleuw (v8hi, v8hi)
9503 v8hi __builtin_ia32_vpcomlew (v8hi, v8hi)
9504 v16qi __builtin_ia32_vpcomltb (v16qi, v16qi)
9505 v4si __builtin_ia32_vpcomltd (v4si, v4si)
9506 v2di __builtin_ia32_vpcomltq (v2di, v2di)
9507 v16qi __builtin_ia32_vpcomltub (v16qi, v16qi)
9508 v4si __builtin_ia32_vpcomltud (v4si, v4si)
9509 v2di __builtin_ia32_vpcomltuq (v2di, v2di)
9510 v8hi __builtin_ia32_vpcomltuw (v8hi, v8hi)
9511 v8hi __builtin_ia32_vpcomltw (v8hi, v8hi)
9512 v16qi __builtin_ia32_vpcomneb (v16qi, v16qi)
9513 v4si __builtin_ia32_vpcomned (v4si, v4si)
9514 v2di __builtin_ia32_vpcomneq (v2di, v2di)
9515 v16qi __builtin_ia32_vpcomneub (v16qi, v16qi)
9516 v4si __builtin_ia32_vpcomneud (v4si, v4si)
9517 v2di __builtin_ia32_vpcomneuq (v2di, v2di)
9518 v8hi __builtin_ia32_vpcomneuw (v8hi, v8hi)
9519 v8hi __builtin_ia32_vpcomnew (v8hi, v8hi)
9520 v16qi __builtin_ia32_vpcomtrueb (v16qi, v16qi)
9521 v4si __builtin_ia32_vpcomtrued (v4si, v4si)
9522 v2di __builtin_ia32_vpcomtrueq (v2di, v2di)
9523 v16qi __builtin_ia32_vpcomtrueub (v16qi, v16qi)
9524 v4si __builtin_ia32_vpcomtrueud (v4si, v4si)
9525 v2di __builtin_ia32_vpcomtrueuq (v2di, v2di)
9526 v8hi __builtin_ia32_vpcomtrueuw (v8hi, v8hi)
9527 v8hi __builtin_ia32_vpcomtruew (v8hi, v8hi)
9528 v4si __builtin_ia32_vphaddbd (v16qi)
9529 v2di __builtin_ia32_vphaddbq (v16qi)
9530 v8hi __builtin_ia32_vphaddbw (v16qi)
9531 v2di __builtin_ia32_vphadddq (v4si)
9532 v4si __builtin_ia32_vphaddubd (v16qi)
9533 v2di __builtin_ia32_vphaddubq (v16qi)
9534 v8hi __builtin_ia32_vphaddubw (v16qi)
9535 v2di __builtin_ia32_vphaddudq (v4si)
9536 v4si __builtin_ia32_vphadduwd (v8hi)
9537 v2di __builtin_ia32_vphadduwq (v8hi)
9538 v4si __builtin_ia32_vphaddwd (v8hi)
9539 v2di __builtin_ia32_vphaddwq (v8hi)
9540 v8hi __builtin_ia32_vphsubbw (v16qi)
9541 v2di __builtin_ia32_vphsubdq (v4si)
9542 v4si __builtin_ia32_vphsubwd (v8hi)
9543 v4si __builtin_ia32_vpmacsdd (v4si, v4si, v4si)
9544 v2di __builtin_ia32_vpmacsdqh (v4si, v4si, v2di)
9545 v2di __builtin_ia32_vpmacsdql (v4si, v4si, v2di)
9546 v4si __builtin_ia32_vpmacssdd (v4si, v4si, v4si)
9547 v2di __builtin_ia32_vpmacssdqh (v4si, v4si, v2di)
9548 v2di __builtin_ia32_vpmacssdql (v4si, v4si, v2di)
9549 v4si __builtin_ia32_vpmacsswd (v8hi, v8hi, v4si)
9550 v8hi __builtin_ia32_vpmacssww (v8hi, v8hi, v8hi)
9551 v4si __builtin_ia32_vpmacswd (v8hi, v8hi, v4si)
9552 v8hi __builtin_ia32_vpmacsww (v8hi, v8hi, v8hi)
9553 v4si __builtin_ia32_vpmadcsswd (v8hi, v8hi, v4si)
9554 v4si __builtin_ia32_vpmadcswd (v8hi, v8hi, v4si)
9555 v16qi __builtin_ia32_vpperm (v16qi, v16qi, v16qi)
9556 v16qi __builtin_ia32_vprotb (v16qi, v16qi)
9557 v4si __builtin_ia32_vprotd (v4si, v4si)
9558 v2di __builtin_ia32_vprotq (v2di, v2di)
9559 v8hi __builtin_ia32_vprotw (v8hi, v8hi)
9560 v16qi __builtin_ia32_vpshab (v16qi, v16qi)
9561 v4si __builtin_ia32_vpshad (v4si, v4si)
9562 v2di __builtin_ia32_vpshaq (v2di, v2di)
9563 v8hi __builtin_ia32_vpshaw (v8hi, v8hi)
9564 v16qi __builtin_ia32_vpshlb (v16qi, v16qi)
9565 v4si __builtin_ia32_vpshld (v4si, v4si)
9566 v2di __builtin_ia32_vpshlq (v2di, v2di)
9567 v8hi __builtin_ia32_vpshlw (v8hi, v8hi)
9568 @end smallexample
9569
9570 The following built-in functions are available when @option{-mfma4} is used.
9571 All of them generate the machine instruction that is part of the name
9572 with MMX registers.
9573
9574 @smallexample
9575 v2df __builtin_ia32_fmaddpd (v2df, v2df, v2df)
9576 v4sf __builtin_ia32_fmaddps (v4sf, v4sf, v4sf)
9577 v2df __builtin_ia32_fmaddsd (v2df, v2df, v2df)
9578 v4sf __builtin_ia32_fmaddss (v4sf, v4sf, v4sf)
9579 v2df __builtin_ia32_fmsubpd (v2df, v2df, v2df)
9580 v4sf __builtin_ia32_fmsubps (v4sf, v4sf, v4sf)
9581 v2df __builtin_ia32_fmsubsd (v2df, v2df, v2df)
9582 v4sf __builtin_ia32_fmsubss (v4sf, v4sf, v4sf)
9583 v2df __builtin_ia32_fnmaddpd (v2df, v2df, v2df)
9584 v4sf __builtin_ia32_fnmaddps (v4sf, v4sf, v4sf)
9585 v2df __builtin_ia32_fnmaddsd (v2df, v2df, v2df)
9586 v4sf __builtin_ia32_fnmaddss (v4sf, v4sf, v4sf)
9587 v2df __builtin_ia32_fnmsubpd (v2df, v2df, v2df)
9588 v4sf __builtin_ia32_fnmsubps (v4sf, v4sf, v4sf)
9589 v2df __builtin_ia32_fnmsubsd (v2df, v2df, v2df)
9590 v4sf __builtin_ia32_fnmsubss (v4sf, v4sf, v4sf)
9591 v2df __builtin_ia32_fmaddsubpd  (v2df, v2df, v2df)
9592 v4sf __builtin_ia32_fmaddsubps  (v4sf, v4sf, v4sf)
9593 v2df __builtin_ia32_fmsubaddpd  (v2df, v2df, v2df)
9594 v4sf __builtin_ia32_fmsubaddps  (v4sf, v4sf, v4sf)
9595 v4df __builtin_ia32_fmaddpd256 (v4df, v4df, v4df)
9596 v8sf __builtin_ia32_fmaddps256 (v8sf, v8sf, v8sf)
9597 v4df __builtin_ia32_fmsubpd256 (v4df, v4df, v4df)
9598 v8sf __builtin_ia32_fmsubps256 (v8sf, v8sf, v8sf)
9599 v4df __builtin_ia32_fnmaddpd256 (v4df, v4df, v4df)
9600 v8sf __builtin_ia32_fnmaddps256 (v8sf, v8sf, v8sf)
9601 v4df __builtin_ia32_fnmsubpd256 (v4df, v4df, v4df)
9602 v8sf __builtin_ia32_fnmsubps256 (v8sf, v8sf, v8sf)
9603 v4df __builtin_ia32_fmaddsubpd256 (v4df, v4df, v4df)
9604 v8sf __builtin_ia32_fmaddsubps256 (v8sf, v8sf, v8sf)
9605 v4df __builtin_ia32_fmsubaddpd256 (v4df, v4df, v4df)
9606 v8sf __builtin_ia32_fmsubaddps256 (v8sf, v8sf, v8sf)
9607
9608 @end smallexample
9609
9610 The following built-in functions are available when @option{-mlwp} is used.
9611
9612 @smallexample
9613 void __builtin_ia32_llwpcb16 (void *);
9614 void __builtin_ia32_llwpcb32 (void *);
9615 void __builtin_ia32_llwpcb64 (void *);
9616 void * __builtin_ia32_llwpcb16 (void);
9617 void * __builtin_ia32_llwpcb32 (void);
9618 void * __builtin_ia32_llwpcb64 (void);
9619 void __builtin_ia32_lwpval16 (unsigned short, unsigned int, unsigned short)
9620 void __builtin_ia32_lwpval32 (unsigned int, unsigned int, unsigned int)
9621 void __builtin_ia32_lwpval64 (unsigned __int64, unsigned int, unsigned int)
9622 unsigned char __builtin_ia32_lwpins16 (unsigned short, unsigned int, unsigned short)
9623 unsigned char __builtin_ia32_lwpins32 (unsigned int, unsigned int, unsigned int)
9624 unsigned char __builtin_ia32_lwpins64 (unsigned __int64, unsigned int, unsigned int)
9625 @end smallexample
9626
9627 The following built-in functions are available when @option{-mbmi} is used.
9628 All of them generate the machine instruction that is part of the name.
9629 @smallexample
9630 unsigned int __builtin_ia32_bextr_u32(unsigned int, unsigned int);
9631 unsigned long long __builtin_ia32_bextr_u64 (unsigned long long, unsigned long long);
9632 unsigned short __builtin_ia32_lzcnt_16(unsigned short);
9633 unsigned int __builtin_ia32_lzcnt_u32(unsigned int);
9634 unsigned long long __builtin_ia32_lzcnt_u64 (unsigned long long);
9635 @end smallexample
9636
9637 The following built-in functions are available when @option{-mtbm} is used.
9638 Both of them generate the immediate form of the bextr machine instruction.
9639 @smallexample
9640 unsigned int __builtin_ia32_bextri_u32 (unsigned int, const unsigned int);
9641 unsigned long long __builtin_ia32_bextri_u64 (unsigned long long, const unsigned long long);
9642 @end smallexample
9643
9644
9645 The following built-in functions are available when @option{-m3dnow} is used.
9646 All of them generate the machine instruction that is part of the name.
9647
9648 @smallexample
9649 void __builtin_ia32_femms (void)
9650 v8qi __builtin_ia32_pavgusb (v8qi, v8qi)
9651 v2si __builtin_ia32_pf2id (v2sf)
9652 v2sf __builtin_ia32_pfacc (v2sf, v2sf)
9653 v2sf __builtin_ia32_pfadd (v2sf, v2sf)
9654 v2si __builtin_ia32_pfcmpeq (v2sf, v2sf)
9655 v2si __builtin_ia32_pfcmpge (v2sf, v2sf)
9656 v2si __builtin_ia32_pfcmpgt (v2sf, v2sf)
9657 v2sf __builtin_ia32_pfmax (v2sf, v2sf)
9658 v2sf __builtin_ia32_pfmin (v2sf, v2sf)
9659 v2sf __builtin_ia32_pfmul (v2sf, v2sf)
9660 v2sf __builtin_ia32_pfrcp (v2sf)
9661 v2sf __builtin_ia32_pfrcpit1 (v2sf, v2sf)
9662 v2sf __builtin_ia32_pfrcpit2 (v2sf, v2sf)
9663 v2sf __builtin_ia32_pfrsqrt (v2sf)
9664 v2sf __builtin_ia32_pfrsqrtit1 (v2sf, v2sf)
9665 v2sf __builtin_ia32_pfsub (v2sf, v2sf)
9666 v2sf __builtin_ia32_pfsubr (v2sf, v2sf)
9667 v2sf __builtin_ia32_pi2fd (v2si)
9668 v4hi __builtin_ia32_pmulhrw (v4hi, v4hi)
9669 @end smallexample
9670
9671 The following built-in functions are available when both @option{-m3dnow}
9672 and @option{-march=athlon} are used.  All of them generate the machine
9673 instruction that is part of the name.
9674
9675 @smallexample
9676 v2si __builtin_ia32_pf2iw (v2sf)
9677 v2sf __builtin_ia32_pfnacc (v2sf, v2sf)
9678 v2sf __builtin_ia32_pfpnacc (v2sf, v2sf)
9679 v2sf __builtin_ia32_pi2fw (v2si)
9680 v2sf __builtin_ia32_pswapdsf (v2sf)
9681 v2si __builtin_ia32_pswapdsi (v2si)
9682 @end smallexample
9683
9684 @node MIPS DSP Built-in Functions
9685 @subsection MIPS DSP Built-in Functions
9686
9687 The MIPS DSP Application-Specific Extension (ASE) includes new
9688 instructions that are designed to improve the performance of DSP and
9689 media applications.  It provides instructions that operate on packed
9690 8-bit/16-bit integer data, Q7, Q15 and Q31 fractional data.
9691
9692 GCC supports MIPS DSP operations using both the generic
9693 vector extensions (@pxref{Vector Extensions}) and a collection of
9694 MIPS-specific built-in functions.  Both kinds of support are
9695 enabled by the @option{-mdsp} command-line option.
9696
9697 Revision 2 of the ASE was introduced in the second half of 2006.
9698 This revision adds extra instructions to the original ASE, but is
9699 otherwise backwards-compatible with it.  You can select revision 2
9700 using the command-line option @option{-mdspr2}; this option implies
9701 @option{-mdsp}.
9702
9703 The SCOUNT and POS bits of the DSP control register are global.  The
9704 WRDSP, EXTPDP, EXTPDPV and MTHLIP instructions modify the SCOUNT and
9705 POS bits.  During optimization, the compiler will not delete these
9706 instructions and it will not delete calls to functions containing
9707 these instructions.
9708
9709 At present, GCC only provides support for operations on 32-bit
9710 vectors.  The vector type associated with 8-bit integer data is
9711 usually called @code{v4i8}, the vector type associated with Q7
9712 is usually called @code{v4q7}, the vector type associated with 16-bit
9713 integer data is usually called @code{v2i16}, and the vector type
9714 associated with Q15 is usually called @code{v2q15}.  They can be
9715 defined in C as follows:
9716
9717 @smallexample
9718 typedef signed char v4i8 __attribute__ ((vector_size(4)));
9719 typedef signed char v4q7 __attribute__ ((vector_size(4)));
9720 typedef short v2i16 __attribute__ ((vector_size(4)));
9721 typedef short v2q15 __attribute__ ((vector_size(4)));
9722 @end smallexample
9723
9724 @code{v4i8}, @code{v4q7}, @code{v2i16} and @code{v2q15} values are
9725 initialized in the same way as aggregates.  For example:
9726
9727 @smallexample
9728 v4i8 a = @{1, 2, 3, 4@};
9729 v4i8 b;
9730 b = (v4i8) @{5, 6, 7, 8@};
9731
9732 v2q15 c = @{0x0fcb, 0x3a75@};
9733 v2q15 d;
9734 d = (v2q15) @{0.1234 * 0x1.0p15, 0.4567 * 0x1.0p15@};
9735 @end smallexample
9736
9737 @emph{Note:} The CPU's endianness determines the order in which values
9738 are packed.  On little-endian targets, the first value is the least
9739 significant and the last value is the most significant.  The opposite
9740 order applies to big-endian targets.  For example, the code above will
9741 set the lowest byte of @code{a} to @code{1} on little-endian targets
9742 and @code{4} on big-endian targets.
9743
9744 @emph{Note:} Q7, Q15 and Q31 values must be initialized with their integer
9745 representation.  As shown in this example, the integer representation
9746 of a Q7 value can be obtained by multiplying the fractional value by
9747 @code{0x1.0p7}.  The equivalent for Q15 values is to multiply by
9748 @code{0x1.0p15}.  The equivalent for Q31 values is to multiply by
9749 @code{0x1.0p31}.
9750
9751 The table below lists the @code{v4i8} and @code{v2q15} operations for which
9752 hardware support exists.  @code{a} and @code{b} are @code{v4i8} values,
9753 and @code{c} and @code{d} are @code{v2q15} values.
9754
9755 @multitable @columnfractions .50 .50
9756 @item C code @tab MIPS instruction
9757 @item @code{a + b} @tab @code{addu.qb}
9758 @item @code{c + d} @tab @code{addq.ph}
9759 @item @code{a - b} @tab @code{subu.qb}
9760 @item @code{c - d} @tab @code{subq.ph}
9761 @end multitable
9762
9763 The table below lists the @code{v2i16} operation for which
9764 hardware support exists for the DSP ASE REV 2.  @code{e} and @code{f} are
9765 @code{v2i16} values.
9766
9767 @multitable @columnfractions .50 .50
9768 @item C code @tab MIPS instruction
9769 @item @code{e * f} @tab @code{mul.ph}
9770 @end multitable
9771
9772 It is easier to describe the DSP built-in functions if we first define
9773 the following types:
9774
9775 @smallexample
9776 typedef int q31;
9777 typedef int i32;
9778 typedef unsigned int ui32;
9779 typedef long long a64;
9780 @end smallexample
9781
9782 @code{q31} and @code{i32} are actually the same as @code{int}, but we
9783 use @code{q31} to indicate a Q31 fractional value and @code{i32} to
9784 indicate a 32-bit integer value.  Similarly, @code{a64} is the same as
9785 @code{long long}, but we use @code{a64} to indicate values that will
9786 be placed in one of the four DSP accumulators (@code{$ac0},
9787 @code{$ac1}, @code{$ac2} or @code{$ac3}).
9788
9789 Also, some built-in functions prefer or require immediate numbers as
9790 parameters, because the corresponding DSP instructions accept both immediate
9791 numbers and register operands, or accept immediate numbers only.  The
9792 immediate parameters are listed as follows.
9793
9794 @smallexample
9795 imm0_3: 0 to 3.
9796 imm0_7: 0 to 7.
9797 imm0_15: 0 to 15.
9798 imm0_31: 0 to 31.
9799 imm0_63: 0 to 63.
9800 imm0_255: 0 to 255.
9801 imm_n32_31: -32 to 31.
9802 imm_n512_511: -512 to 511.
9803 @end smallexample
9804
9805 The following built-in functions map directly to a particular MIPS DSP
9806 instruction.  Please refer to the architecture specification
9807 for details on what each instruction does.
9808
9809 @smallexample
9810 v2q15 __builtin_mips_addq_ph (v2q15, v2q15)
9811 v2q15 __builtin_mips_addq_s_ph (v2q15, v2q15)
9812 q31 __builtin_mips_addq_s_w (q31, q31)
9813 v4i8 __builtin_mips_addu_qb (v4i8, v4i8)
9814 v4i8 __builtin_mips_addu_s_qb (v4i8, v4i8)
9815 v2q15 __builtin_mips_subq_ph (v2q15, v2q15)
9816 v2q15 __builtin_mips_subq_s_ph (v2q15, v2q15)
9817 q31 __builtin_mips_subq_s_w (q31, q31)
9818 v4i8 __builtin_mips_subu_qb (v4i8, v4i8)
9819 v4i8 __builtin_mips_subu_s_qb (v4i8, v4i8)
9820 i32 __builtin_mips_addsc (i32, i32)
9821 i32 __builtin_mips_addwc (i32, i32)
9822 i32 __builtin_mips_modsub (i32, i32)
9823 i32 __builtin_mips_raddu_w_qb (v4i8)
9824 v2q15 __builtin_mips_absq_s_ph (v2q15)
9825 q31 __builtin_mips_absq_s_w (q31)
9826 v4i8 __builtin_mips_precrq_qb_ph (v2q15, v2q15)
9827 v2q15 __builtin_mips_precrq_ph_w (q31, q31)
9828 v2q15 __builtin_mips_precrq_rs_ph_w (q31, q31)
9829 v4i8 __builtin_mips_precrqu_s_qb_ph (v2q15, v2q15)
9830 q31 __builtin_mips_preceq_w_phl (v2q15)
9831 q31 __builtin_mips_preceq_w_phr (v2q15)
9832 v2q15 __builtin_mips_precequ_ph_qbl (v4i8)
9833 v2q15 __builtin_mips_precequ_ph_qbr (v4i8)
9834 v2q15 __builtin_mips_precequ_ph_qbla (v4i8)
9835 v2q15 __builtin_mips_precequ_ph_qbra (v4i8)
9836 v2q15 __builtin_mips_preceu_ph_qbl (v4i8)
9837 v2q15 __builtin_mips_preceu_ph_qbr (v4i8)
9838 v2q15 __builtin_mips_preceu_ph_qbla (v4i8)
9839 v2q15 __builtin_mips_preceu_ph_qbra (v4i8)
9840 v4i8 __builtin_mips_shll_qb (v4i8, imm0_7)
9841 v4i8 __builtin_mips_shll_qb (v4i8, i32)
9842 v2q15 __builtin_mips_shll_ph (v2q15, imm0_15)
9843 v2q15 __builtin_mips_shll_ph (v2q15, i32)
9844 v2q15 __builtin_mips_shll_s_ph (v2q15, imm0_15)
9845 v2q15 __builtin_mips_shll_s_ph (v2q15, i32)
9846 q31 __builtin_mips_shll_s_w (q31, imm0_31)
9847 q31 __builtin_mips_shll_s_w (q31, i32)
9848 v4i8 __builtin_mips_shrl_qb (v4i8, imm0_7)
9849 v4i8 __builtin_mips_shrl_qb (v4i8, i32)
9850 v2q15 __builtin_mips_shra_ph (v2q15, imm0_15)
9851 v2q15 __builtin_mips_shra_ph (v2q15, i32)
9852 v2q15 __builtin_mips_shra_r_ph (v2q15, imm0_15)
9853 v2q15 __builtin_mips_shra_r_ph (v2q15, i32)
9854 q31 __builtin_mips_shra_r_w (q31, imm0_31)
9855 q31 __builtin_mips_shra_r_w (q31, i32)
9856 v2q15 __builtin_mips_muleu_s_ph_qbl (v4i8, v2q15)
9857 v2q15 __builtin_mips_muleu_s_ph_qbr (v4i8, v2q15)
9858 v2q15 __builtin_mips_mulq_rs_ph (v2q15, v2q15)
9859 q31 __builtin_mips_muleq_s_w_phl (v2q15, v2q15)
9860 q31 __builtin_mips_muleq_s_w_phr (v2q15, v2q15)
9861 a64 __builtin_mips_dpau_h_qbl (a64, v4i8, v4i8)
9862 a64 __builtin_mips_dpau_h_qbr (a64, v4i8, v4i8)
9863 a64 __builtin_mips_dpsu_h_qbl (a64, v4i8, v4i8)
9864 a64 __builtin_mips_dpsu_h_qbr (a64, v4i8, v4i8)
9865 a64 __builtin_mips_dpaq_s_w_ph (a64, v2q15, v2q15)
9866 a64 __builtin_mips_dpaq_sa_l_w (a64, q31, q31)
9867 a64 __builtin_mips_dpsq_s_w_ph (a64, v2q15, v2q15)
9868 a64 __builtin_mips_dpsq_sa_l_w (a64, q31, q31)
9869 a64 __builtin_mips_mulsaq_s_w_ph (a64, v2q15, v2q15)
9870 a64 __builtin_mips_maq_s_w_phl (a64, v2q15, v2q15)
9871 a64 __builtin_mips_maq_s_w_phr (a64, v2q15, v2q15)
9872 a64 __builtin_mips_maq_sa_w_phl (a64, v2q15, v2q15)
9873 a64 __builtin_mips_maq_sa_w_phr (a64, v2q15, v2q15)
9874 i32 __builtin_mips_bitrev (i32)
9875 i32 __builtin_mips_insv (i32, i32)
9876 v4i8 __builtin_mips_repl_qb (imm0_255)
9877 v4i8 __builtin_mips_repl_qb (i32)
9878 v2q15 __builtin_mips_repl_ph (imm_n512_511)
9879 v2q15 __builtin_mips_repl_ph (i32)
9880 void __builtin_mips_cmpu_eq_qb (v4i8, v4i8)
9881 void __builtin_mips_cmpu_lt_qb (v4i8, v4i8)
9882 void __builtin_mips_cmpu_le_qb (v4i8, v4i8)
9883 i32 __builtin_mips_cmpgu_eq_qb (v4i8, v4i8)
9884 i32 __builtin_mips_cmpgu_lt_qb (v4i8, v4i8)
9885 i32 __builtin_mips_cmpgu_le_qb (v4i8, v4i8)
9886 void __builtin_mips_cmp_eq_ph (v2q15, v2q15)
9887 void __builtin_mips_cmp_lt_ph (v2q15, v2q15)
9888 void __builtin_mips_cmp_le_ph (v2q15, v2q15)
9889 v4i8 __builtin_mips_pick_qb (v4i8, v4i8)
9890 v2q15 __builtin_mips_pick_ph (v2q15, v2q15)
9891 v2q15 __builtin_mips_packrl_ph (v2q15, v2q15)
9892 i32 __builtin_mips_extr_w (a64, imm0_31)
9893 i32 __builtin_mips_extr_w (a64, i32)
9894 i32 __builtin_mips_extr_r_w (a64, imm0_31)
9895 i32 __builtin_mips_extr_s_h (a64, i32)
9896 i32 __builtin_mips_extr_rs_w (a64, imm0_31)
9897 i32 __builtin_mips_extr_rs_w (a64, i32)
9898 i32 __builtin_mips_extr_s_h (a64, imm0_31)
9899 i32 __builtin_mips_extr_r_w (a64, i32)
9900 i32 __builtin_mips_extp (a64, imm0_31)
9901 i32 __builtin_mips_extp (a64, i32)
9902 i32 __builtin_mips_extpdp (a64, imm0_31)
9903 i32 __builtin_mips_extpdp (a64, i32)
9904 a64 __builtin_mips_shilo (a64, imm_n32_31)
9905 a64 __builtin_mips_shilo (a64, i32)
9906 a64 __builtin_mips_mthlip (a64, i32)
9907 void __builtin_mips_wrdsp (i32, imm0_63)
9908 i32 __builtin_mips_rddsp (imm0_63)
9909 i32 __builtin_mips_lbux (void *, i32)
9910 i32 __builtin_mips_lhx (void *, i32)
9911 i32 __builtin_mips_lwx (void *, i32)
9912 i32 __builtin_mips_bposge32 (void)
9913 a64 __builtin_mips_madd (a64, i32, i32);
9914 a64 __builtin_mips_maddu (a64, ui32, ui32);
9915 a64 __builtin_mips_msub (a64, i32, i32);
9916 a64 __builtin_mips_msubu (a64, ui32, ui32);
9917 a64 __builtin_mips_mult (i32, i32);
9918 a64 __builtin_mips_multu (ui32, ui32);
9919 @end smallexample
9920
9921 The following built-in functions map directly to a particular MIPS DSP REV 2
9922 instruction.  Please refer to the architecture specification
9923 for details on what each instruction does.
9924
9925 @smallexample
9926 v4q7 __builtin_mips_absq_s_qb (v4q7);
9927 v2i16 __builtin_mips_addu_ph (v2i16, v2i16);
9928 v2i16 __builtin_mips_addu_s_ph (v2i16, v2i16);
9929 v4i8 __builtin_mips_adduh_qb (v4i8, v4i8);
9930 v4i8 __builtin_mips_adduh_r_qb (v4i8, v4i8);
9931 i32 __builtin_mips_append (i32, i32, imm0_31);
9932 i32 __builtin_mips_balign (i32, i32, imm0_3);
9933 i32 __builtin_mips_cmpgdu_eq_qb (v4i8, v4i8);
9934 i32 __builtin_mips_cmpgdu_lt_qb (v4i8, v4i8);
9935 i32 __builtin_mips_cmpgdu_le_qb (v4i8, v4i8);
9936 a64 __builtin_mips_dpa_w_ph (a64, v2i16, v2i16);
9937 a64 __builtin_mips_dps_w_ph (a64, v2i16, v2i16);
9938 v2i16 __builtin_mips_mul_ph (v2i16, v2i16);
9939 v2i16 __builtin_mips_mul_s_ph (v2i16, v2i16);
9940 q31 __builtin_mips_mulq_rs_w (q31, q31);
9941 v2q15 __builtin_mips_mulq_s_ph (v2q15, v2q15);
9942 q31 __builtin_mips_mulq_s_w (q31, q31);
9943 a64 __builtin_mips_mulsa_w_ph (a64, v2i16, v2i16);
9944 v4i8 __builtin_mips_precr_qb_ph (v2i16, v2i16);
9945 v2i16 __builtin_mips_precr_sra_ph_w (i32, i32, imm0_31);
9946 v2i16 __builtin_mips_precr_sra_r_ph_w (i32, i32, imm0_31);
9947 i32 __builtin_mips_prepend (i32, i32, imm0_31);
9948 v4i8 __builtin_mips_shra_qb (v4i8, imm0_7);
9949 v4i8 __builtin_mips_shra_r_qb (v4i8, imm0_7);
9950 v4i8 __builtin_mips_shra_qb (v4i8, i32);
9951 v4i8 __builtin_mips_shra_r_qb (v4i8, i32);
9952 v2i16 __builtin_mips_shrl_ph (v2i16, imm0_15);
9953 v2i16 __builtin_mips_shrl_ph (v2i16, i32);
9954 v2i16 __builtin_mips_subu_ph (v2i16, v2i16);
9955 v2i16 __builtin_mips_subu_s_ph (v2i16, v2i16);
9956 v4i8 __builtin_mips_subuh_qb (v4i8, v4i8);
9957 v4i8 __builtin_mips_subuh_r_qb (v4i8, v4i8);
9958 v2q15 __builtin_mips_addqh_ph (v2q15, v2q15);
9959 v2q15 __builtin_mips_addqh_r_ph (v2q15, v2q15);
9960 q31 __builtin_mips_addqh_w (q31, q31);
9961 q31 __builtin_mips_addqh_r_w (q31, q31);
9962 v2q15 __builtin_mips_subqh_ph (v2q15, v2q15);
9963 v2q15 __builtin_mips_subqh_r_ph (v2q15, v2q15);
9964 q31 __builtin_mips_subqh_w (q31, q31);
9965 q31 __builtin_mips_subqh_r_w (q31, q31);
9966 a64 __builtin_mips_dpax_w_ph (a64, v2i16, v2i16);
9967 a64 __builtin_mips_dpsx_w_ph (a64, v2i16, v2i16);
9968 a64 __builtin_mips_dpaqx_s_w_ph (a64, v2q15, v2q15);
9969 a64 __builtin_mips_dpaqx_sa_w_ph (a64, v2q15, v2q15);
9970 a64 __builtin_mips_dpsqx_s_w_ph (a64, v2q15, v2q15);
9971 a64 __builtin_mips_dpsqx_sa_w_ph (a64, v2q15, v2q15);
9972 @end smallexample
9973
9974
9975 @node MIPS Paired-Single Support
9976 @subsection MIPS Paired-Single Support
9977
9978 The MIPS64 architecture includes a number of instructions that
9979 operate on pairs of single-precision floating-point values.
9980 Each pair is packed into a 64-bit floating-point register,
9981 with one element being designated the ``upper half'' and
9982 the other being designated the ``lower half''.
9983
9984 GCC supports paired-single operations using both the generic
9985 vector extensions (@pxref{Vector Extensions}) and a collection of
9986 MIPS-specific built-in functions.  Both kinds of support are
9987 enabled by the @option{-mpaired-single} command-line option.
9988
9989 The vector type associated with paired-single values is usually
9990 called @code{v2sf}.  It can be defined in C as follows:
9991
9992 @smallexample
9993 typedef float v2sf __attribute__ ((vector_size (8)));
9994 @end smallexample
9995
9996 @code{v2sf} values are initialized in the same way as aggregates.
9997 For example:
9998
9999 @smallexample
10000 v2sf a = @{1.5, 9.1@};
10001 v2sf b;
10002 float e, f;
10003 b = (v2sf) @{e, f@};
10004 @end smallexample
10005
10006 @emph{Note:} The CPU's endianness determines which value is stored in
10007 the upper half of a register and which value is stored in the lower half.
10008 On little-endian targets, the first value is the lower one and the second
10009 value is the upper one.  The opposite order applies to big-endian targets.
10010 For example, the code above will set the lower half of @code{a} to
10011 @code{1.5} on little-endian targets and @code{9.1} on big-endian targets.
10012
10013 @node MIPS Loongson Built-in Functions
10014 @subsection MIPS Loongson Built-in Functions
10015
10016 GCC provides intrinsics to access the SIMD instructions provided by the
10017 ST Microelectronics Loongson-2E and -2F processors.  These intrinsics,
10018 available after inclusion of the @code{loongson.h} header file,
10019 operate on the following 64-bit vector types:
10020
10021 @itemize
10022 @item @code{uint8x8_t}, a vector of eight unsigned 8-bit integers;
10023 @item @code{uint16x4_t}, a vector of four unsigned 16-bit integers;
10024 @item @code{uint32x2_t}, a vector of two unsigned 32-bit integers;
10025 @item @code{int8x8_t}, a vector of eight signed 8-bit integers;
10026 @item @code{int16x4_t}, a vector of four signed 16-bit integers;
10027 @item @code{int32x2_t}, a vector of two signed 32-bit integers.
10028 @end itemize
10029
10030 The intrinsics provided are listed below; each is named after the
10031 machine instruction to which it corresponds, with suffixes added as
10032 appropriate to distinguish intrinsics that expand to the same machine
10033 instruction yet have different argument types.  Refer to the architecture
10034 documentation for a description of the functionality of each
10035 instruction.
10036
10037 @smallexample
10038 int16x4_t packsswh (int32x2_t s, int32x2_t t);
10039 int8x8_t packsshb (int16x4_t s, int16x4_t t);
10040 uint8x8_t packushb (uint16x4_t s, uint16x4_t t);
10041 uint32x2_t paddw_u (uint32x2_t s, uint32x2_t t);
10042 uint16x4_t paddh_u (uint16x4_t s, uint16x4_t t);
10043 uint8x8_t paddb_u (uint8x8_t s, uint8x8_t t);
10044 int32x2_t paddw_s (int32x2_t s, int32x2_t t);
10045 int16x4_t paddh_s (int16x4_t s, int16x4_t t);
10046 int8x8_t paddb_s (int8x8_t s, int8x8_t t);
10047 uint64_t paddd_u (uint64_t s, uint64_t t);
10048 int64_t paddd_s (int64_t s, int64_t t);
10049 int16x4_t paddsh (int16x4_t s, int16x4_t t);
10050 int8x8_t paddsb (int8x8_t s, int8x8_t t);
10051 uint16x4_t paddush (uint16x4_t s, uint16x4_t t);
10052 uint8x8_t paddusb (uint8x8_t s, uint8x8_t t);
10053 uint64_t pandn_ud (uint64_t s, uint64_t t);
10054 uint32x2_t pandn_uw (uint32x2_t s, uint32x2_t t);
10055 uint16x4_t pandn_uh (uint16x4_t s, uint16x4_t t);
10056 uint8x8_t pandn_ub (uint8x8_t s, uint8x8_t t);
10057 int64_t pandn_sd (int64_t s, int64_t t);
10058 int32x2_t pandn_sw (int32x2_t s, int32x2_t t);
10059 int16x4_t pandn_sh (int16x4_t s, int16x4_t t);
10060 int8x8_t pandn_sb (int8x8_t s, int8x8_t t);
10061 uint16x4_t pavgh (uint16x4_t s, uint16x4_t t);
10062 uint8x8_t pavgb (uint8x8_t s, uint8x8_t t);
10063 uint32x2_t pcmpeqw_u (uint32x2_t s, uint32x2_t t);
10064 uint16x4_t pcmpeqh_u (uint16x4_t s, uint16x4_t t);
10065 uint8x8_t pcmpeqb_u (uint8x8_t s, uint8x8_t t);
10066 int32x2_t pcmpeqw_s (int32x2_t s, int32x2_t t);
10067 int16x4_t pcmpeqh_s (int16x4_t s, int16x4_t t);
10068 int8x8_t pcmpeqb_s (int8x8_t s, int8x8_t t);
10069 uint32x2_t pcmpgtw_u (uint32x2_t s, uint32x2_t t);
10070 uint16x4_t pcmpgth_u (uint16x4_t s, uint16x4_t t);
10071 uint8x8_t pcmpgtb_u (uint8x8_t s, uint8x8_t t);
10072 int32x2_t pcmpgtw_s (int32x2_t s, int32x2_t t);
10073 int16x4_t pcmpgth_s (int16x4_t s, int16x4_t t);
10074 int8x8_t pcmpgtb_s (int8x8_t s, int8x8_t t);
10075 uint16x4_t pextrh_u (uint16x4_t s, int field);
10076 int16x4_t pextrh_s (int16x4_t s, int field);
10077 uint16x4_t pinsrh_0_u (uint16x4_t s, uint16x4_t t);
10078 uint16x4_t pinsrh_1_u (uint16x4_t s, uint16x4_t t);
10079 uint16x4_t pinsrh_2_u (uint16x4_t s, uint16x4_t t);
10080 uint16x4_t pinsrh_3_u (uint16x4_t s, uint16x4_t t);
10081 int16x4_t pinsrh_0_s (int16x4_t s, int16x4_t t);
10082 int16x4_t pinsrh_1_s (int16x4_t s, int16x4_t t);
10083 int16x4_t pinsrh_2_s (int16x4_t s, int16x4_t t);
10084 int16x4_t pinsrh_3_s (int16x4_t s, int16x4_t t);
10085 int32x2_t pmaddhw (int16x4_t s, int16x4_t t);
10086 int16x4_t pmaxsh (int16x4_t s, int16x4_t t);
10087 uint8x8_t pmaxub (uint8x8_t s, uint8x8_t t);
10088 int16x4_t pminsh (int16x4_t s, int16x4_t t);
10089 uint8x8_t pminub (uint8x8_t s, uint8x8_t t);
10090 uint8x8_t pmovmskb_u (uint8x8_t s);
10091 int8x8_t pmovmskb_s (int8x8_t s);
10092 uint16x4_t pmulhuh (uint16x4_t s, uint16x4_t t);
10093 int16x4_t pmulhh (int16x4_t s, int16x4_t t);
10094 int16x4_t pmullh (int16x4_t s, int16x4_t t);
10095 int64_t pmuluw (uint32x2_t s, uint32x2_t t);
10096 uint8x8_t pasubub (uint8x8_t s, uint8x8_t t);
10097 uint16x4_t biadd (uint8x8_t s);
10098 uint16x4_t psadbh (uint8x8_t s, uint8x8_t t);
10099 uint16x4_t pshufh_u (uint16x4_t dest, uint16x4_t s, uint8_t order);
10100 int16x4_t pshufh_s (int16x4_t dest, int16x4_t s, uint8_t order);
10101 uint16x4_t psllh_u (uint16x4_t s, uint8_t amount);
10102 int16x4_t psllh_s (int16x4_t s, uint8_t amount);
10103 uint32x2_t psllw_u (uint32x2_t s, uint8_t amount);
10104 int32x2_t psllw_s (int32x2_t s, uint8_t amount);
10105 uint16x4_t psrlh_u (uint16x4_t s, uint8_t amount);
10106 int16x4_t psrlh_s (int16x4_t s, uint8_t amount);
10107 uint32x2_t psrlw_u (uint32x2_t s, uint8_t amount);
10108 int32x2_t psrlw_s (int32x2_t s, uint8_t amount);
10109 uint16x4_t psrah_u (uint16x4_t s, uint8_t amount);
10110 int16x4_t psrah_s (int16x4_t s, uint8_t amount);
10111 uint32x2_t psraw_u (uint32x2_t s, uint8_t amount);
10112 int32x2_t psraw_s (int32x2_t s, uint8_t amount);
10113 uint32x2_t psubw_u (uint32x2_t s, uint32x2_t t);
10114 uint16x4_t psubh_u (uint16x4_t s, uint16x4_t t);
10115 uint8x8_t psubb_u (uint8x8_t s, uint8x8_t t);
10116 int32x2_t psubw_s (int32x2_t s, int32x2_t t);
10117 int16x4_t psubh_s (int16x4_t s, int16x4_t t);
10118 int8x8_t psubb_s (int8x8_t s, int8x8_t t);
10119 uint64_t psubd_u (uint64_t s, uint64_t t);
10120 int64_t psubd_s (int64_t s, int64_t t);
10121 int16x4_t psubsh (int16x4_t s, int16x4_t t);
10122 int8x8_t psubsb (int8x8_t s, int8x8_t t);
10123 uint16x4_t psubush (uint16x4_t s, uint16x4_t t);
10124 uint8x8_t psubusb (uint8x8_t s, uint8x8_t t);
10125 uint32x2_t punpckhwd_u (uint32x2_t s, uint32x2_t t);
10126 uint16x4_t punpckhhw_u (uint16x4_t s, uint16x4_t t);
10127 uint8x8_t punpckhbh_u (uint8x8_t s, uint8x8_t t);
10128 int32x2_t punpckhwd_s (int32x2_t s, int32x2_t t);
10129 int16x4_t punpckhhw_s (int16x4_t s, int16x4_t t);
10130 int8x8_t punpckhbh_s (int8x8_t s, int8x8_t t);
10131 uint32x2_t punpcklwd_u (uint32x2_t s, uint32x2_t t);
10132 uint16x4_t punpcklhw_u (uint16x4_t s, uint16x4_t t);
10133 uint8x8_t punpcklbh_u (uint8x8_t s, uint8x8_t t);
10134 int32x2_t punpcklwd_s (int32x2_t s, int32x2_t t);
10135 int16x4_t punpcklhw_s (int16x4_t s, int16x4_t t);
10136 int8x8_t punpcklbh_s (int8x8_t s, int8x8_t t);
10137 @end smallexample
10138
10139 @menu
10140 * Paired-Single Arithmetic::
10141 * Paired-Single Built-in Functions::
10142 * MIPS-3D Built-in Functions::
10143 @end menu
10144
10145 @node Paired-Single Arithmetic
10146 @subsubsection Paired-Single Arithmetic
10147
10148 The table below lists the @code{v2sf} operations for which hardware
10149 support exists.  @code{a}, @code{b} and @code{c} are @code{v2sf}
10150 values and @code{x} is an integral value.
10151
10152 @multitable @columnfractions .50 .50
10153 @item C code @tab MIPS instruction
10154 @item @code{a + b} @tab @code{add.ps}
10155 @item @code{a - b} @tab @code{sub.ps}
10156 @item @code{-a} @tab @code{neg.ps}
10157 @item @code{a * b} @tab @code{mul.ps}
10158 @item @code{a * b + c} @tab @code{madd.ps}
10159 @item @code{a * b - c} @tab @code{msub.ps}
10160 @item @code{-(a * b + c)} @tab @code{nmadd.ps}
10161 @item @code{-(a * b - c)} @tab @code{nmsub.ps}
10162 @item @code{x ? a : b} @tab @code{movn.ps}/@code{movz.ps}
10163 @end multitable
10164
10165 Note that the multiply-accumulate instructions can be disabled
10166 using the command-line option @code{-mno-fused-madd}.
10167
10168 @node Paired-Single Built-in Functions
10169 @subsubsection Paired-Single Built-in Functions
10170
10171 The following paired-single functions map directly to a particular
10172 MIPS instruction.  Please refer to the architecture specification
10173 for details on what each instruction does.
10174
10175 @table @code
10176 @item v2sf __builtin_mips_pll_ps (v2sf, v2sf)
10177 Pair lower lower (@code{pll.ps}).
10178
10179 @item v2sf __builtin_mips_pul_ps (v2sf, v2sf)
10180 Pair upper lower (@code{pul.ps}).
10181
10182 @item v2sf __builtin_mips_plu_ps (v2sf, v2sf)
10183 Pair lower upper (@code{plu.ps}).
10184
10185 @item v2sf __builtin_mips_puu_ps (v2sf, v2sf)
10186 Pair upper upper (@code{puu.ps}).
10187
10188 @item v2sf __builtin_mips_cvt_ps_s (float, float)
10189 Convert pair to paired single (@code{cvt.ps.s}).
10190
10191 @item float __builtin_mips_cvt_s_pl (v2sf)
10192 Convert pair lower to single (@code{cvt.s.pl}).
10193
10194 @item float __builtin_mips_cvt_s_pu (v2sf)
10195 Convert pair upper to single (@code{cvt.s.pu}).
10196
10197 @item v2sf __builtin_mips_abs_ps (v2sf)
10198 Absolute value (@code{abs.ps}).
10199
10200 @item v2sf __builtin_mips_alnv_ps (v2sf, v2sf, int)
10201 Align variable (@code{alnv.ps}).
10202
10203 @emph{Note:} The value of the third parameter must be 0 or 4
10204 modulo 8, otherwise the result will be unpredictable.  Please read the
10205 instruction description for details.
10206 @end table
10207
10208 The following multi-instruction functions are also available.
10209 In each case, @var{cond} can be any of the 16 floating-point conditions:
10210 @code{f}, @code{un}, @code{eq}, @code{ueq}, @code{olt}, @code{ult},
10211 @code{ole}, @code{ule}, @code{sf}, @code{ngle}, @code{seq}, @code{ngl},
10212 @code{lt}, @code{nge}, @code{le} or @code{ngt}.
10213
10214 @table @code
10215 @item v2sf __builtin_mips_movt_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
10216 @itemx v2sf __builtin_mips_movf_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
10217 Conditional move based on floating point comparison (@code{c.@var{cond}.ps},
10218 @code{movt.ps}/@code{movf.ps}).
10219
10220 The @code{movt} functions return the value @var{x} computed by:
10221
10222 @smallexample
10223 c.@var{cond}.ps @var{cc},@var{a},@var{b}
10224 mov.ps @var{x},@var{c}
10225 movt.ps @var{x},@var{d},@var{cc}
10226 @end smallexample
10227
10228 The @code{movf} functions are similar but use @code{movf.ps} instead
10229 of @code{movt.ps}.
10230
10231 @item int __builtin_mips_upper_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
10232 @itemx int __builtin_mips_lower_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
10233 Comparison of two paired-single values (@code{c.@var{cond}.ps},
10234 @code{bc1t}/@code{bc1f}).
10235
10236 These functions compare @var{a} and @var{b} using @code{c.@var{cond}.ps}
10237 and return either the upper or lower half of the result.  For example:
10238
10239 @smallexample
10240 v2sf a, b;
10241 if (__builtin_mips_upper_c_eq_ps (a, b))
10242   upper_halves_are_equal ();
10243 else
10244   upper_halves_are_unequal ();
10245
10246 if (__builtin_mips_lower_c_eq_ps (a, b))
10247   lower_halves_are_equal ();
10248 else
10249   lower_halves_are_unequal ();
10250 @end smallexample
10251 @end table
10252
10253 @node MIPS-3D Built-in Functions
10254 @subsubsection MIPS-3D Built-in Functions
10255
10256 The MIPS-3D Application-Specific Extension (ASE) includes additional
10257 paired-single instructions that are designed to improve the performance
10258 of 3D graphics operations.  Support for these instructions is controlled
10259 by the @option{-mips3d} command-line option.
10260
10261 The functions listed below map directly to a particular MIPS-3D
10262 instruction.  Please refer to the architecture specification for
10263 more details on what each instruction does.
10264
10265 @table @code
10266 @item v2sf __builtin_mips_addr_ps (v2sf, v2sf)
10267 Reduction add (@code{addr.ps}).
10268
10269 @item v2sf __builtin_mips_mulr_ps (v2sf, v2sf)
10270 Reduction multiply (@code{mulr.ps}).
10271
10272 @item v2sf __builtin_mips_cvt_pw_ps (v2sf)
10273 Convert paired single to paired word (@code{cvt.pw.ps}).
10274
10275 @item v2sf __builtin_mips_cvt_ps_pw (v2sf)
10276 Convert paired word to paired single (@code{cvt.ps.pw}).
10277
10278 @item float __builtin_mips_recip1_s (float)
10279 @itemx double __builtin_mips_recip1_d (double)
10280 @itemx v2sf __builtin_mips_recip1_ps (v2sf)
10281 Reduced precision reciprocal (sequence step 1) (@code{recip1.@var{fmt}}).
10282
10283 @item float __builtin_mips_recip2_s (float, float)
10284 @itemx double __builtin_mips_recip2_d (double, double)
10285 @itemx v2sf __builtin_mips_recip2_ps (v2sf, v2sf)
10286 Reduced precision reciprocal (sequence step 2) (@code{recip2.@var{fmt}}).
10287
10288 @item float __builtin_mips_rsqrt1_s (float)
10289 @itemx double __builtin_mips_rsqrt1_d (double)
10290 @itemx v2sf __builtin_mips_rsqrt1_ps (v2sf)
10291 Reduced precision reciprocal square root (sequence step 1)
10292 (@code{rsqrt1.@var{fmt}}).
10293
10294 @item float __builtin_mips_rsqrt2_s (float, float)
10295 @itemx double __builtin_mips_rsqrt2_d (double, double)
10296 @itemx v2sf __builtin_mips_rsqrt2_ps (v2sf, v2sf)
10297 Reduced precision reciprocal square root (sequence step 2)
10298 (@code{rsqrt2.@var{fmt}}).
10299 @end table
10300
10301 The following multi-instruction functions are also available.
10302 In each case, @var{cond} can be any of the 16 floating-point conditions:
10303 @code{f}, @code{un}, @code{eq}, @code{ueq}, @code{olt}, @code{ult},
10304 @code{ole}, @code{ule}, @code{sf}, @code{ngle}, @code{seq},
10305 @code{ngl}, @code{lt}, @code{nge}, @code{le} or @code{ngt}.
10306
10307 @table @code
10308 @item int __builtin_mips_cabs_@var{cond}_s (float @var{a}, float @var{b})
10309 @itemx int __builtin_mips_cabs_@var{cond}_d (double @var{a}, double @var{b})
10310 Absolute comparison of two scalar values (@code{cabs.@var{cond}.@var{fmt}},
10311 @code{bc1t}/@code{bc1f}).
10312
10313 These functions compare @var{a} and @var{b} using @code{cabs.@var{cond}.s}
10314 or @code{cabs.@var{cond}.d} and return the result as a boolean value.
10315 For example:
10316
10317 @smallexample
10318 float a, b;
10319 if (__builtin_mips_cabs_eq_s (a, b))
10320   true ();
10321 else
10322   false ();
10323 @end smallexample
10324
10325 @item int __builtin_mips_upper_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
10326 @itemx int __builtin_mips_lower_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
10327 Absolute comparison of two paired-single values (@code{cabs.@var{cond}.ps},
10328 @code{bc1t}/@code{bc1f}).
10329
10330 These functions compare @var{a} and @var{b} using @code{cabs.@var{cond}.ps}
10331 and return either the upper or lower half of the result.  For example:
10332
10333 @smallexample
10334 v2sf a, b;
10335 if (__builtin_mips_upper_cabs_eq_ps (a, b))
10336   upper_halves_are_equal ();
10337 else
10338   upper_halves_are_unequal ();
10339
10340 if (__builtin_mips_lower_cabs_eq_ps (a, b))
10341   lower_halves_are_equal ();
10342 else
10343   lower_halves_are_unequal ();
10344 @end smallexample
10345
10346 @item v2sf __builtin_mips_movt_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
10347 @itemx v2sf __builtin_mips_movf_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
10348 Conditional move based on absolute comparison (@code{cabs.@var{cond}.ps},
10349 @code{movt.ps}/@code{movf.ps}).
10350
10351 The @code{movt} functions return the value @var{x} computed by:
10352
10353 @smallexample
10354 cabs.@var{cond}.ps @var{cc},@var{a},@var{b}
10355 mov.ps @var{x},@var{c}
10356 movt.ps @var{x},@var{d},@var{cc}
10357 @end smallexample
10358
10359 The @code{movf} functions are similar but use @code{movf.ps} instead
10360 of @code{movt.ps}.
10361
10362 @item int __builtin_mips_any_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
10363 @itemx int __builtin_mips_all_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
10364 @itemx int __builtin_mips_any_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
10365 @itemx int __builtin_mips_all_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
10366 Comparison of two paired-single values
10367 (@code{c.@var{cond}.ps}/@code{cabs.@var{cond}.ps},
10368 @code{bc1any2t}/@code{bc1any2f}).
10369
10370 These functions compare @var{a} and @var{b} using @code{c.@var{cond}.ps}
10371 or @code{cabs.@var{cond}.ps}.  The @code{any} forms return true if either
10372 result is true and the @code{all} forms return true if both results are true.
10373 For example:
10374
10375 @smallexample
10376 v2sf a, b;
10377 if (__builtin_mips_any_c_eq_ps (a, b))
10378   one_is_true ();
10379 else
10380   both_are_false ();
10381
10382 if (__builtin_mips_all_c_eq_ps (a, b))
10383   both_are_true ();
10384 else
10385   one_is_false ();
10386 @end smallexample
10387
10388 @item int __builtin_mips_any_c_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
10389 @itemx int __builtin_mips_all_c_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
10390 @itemx int __builtin_mips_any_cabs_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
10391 @itemx int __builtin_mips_all_cabs_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
10392 Comparison of four paired-single values
10393 (@code{c.@var{cond}.ps}/@code{cabs.@var{cond}.ps},
10394 @code{bc1any4t}/@code{bc1any4f}).
10395
10396 These functions use @code{c.@var{cond}.ps} or @code{cabs.@var{cond}.ps}
10397 to compare @var{a} with @var{b} and to compare @var{c} with @var{d}.
10398 The @code{any} forms return true if any of the four results are true
10399 and the @code{all} forms return true if all four results are true.
10400 For example:
10401
10402 @smallexample
10403 v2sf a, b, c, d;
10404 if (__builtin_mips_any_c_eq_4s (a, b, c, d))
10405   some_are_true ();
10406 else
10407   all_are_false ();
10408
10409 if (__builtin_mips_all_c_eq_4s (a, b, c, d))
10410   all_are_true ();
10411 else
10412   some_are_false ();
10413 @end smallexample
10414 @end table
10415
10416 @node picoChip Built-in Functions
10417 @subsection picoChip Built-in Functions
10418
10419 GCC provides an interface to selected machine instructions from the
10420 picoChip instruction set.
10421
10422 @table @code
10423 @item int __builtin_sbc (int @var{value})
10424 Sign bit count.  Return the number of consecutive bits in @var{value}
10425 which have the same value as the sign-bit.  The result is the number of
10426 leading sign bits minus one, giving the number of redundant sign bits in
10427 @var{value}.
10428
10429 @item int __builtin_byteswap (int @var{value})
10430 Byte swap.  Return the result of swapping the upper and lower bytes of
10431 @var{value}.
10432
10433 @item int __builtin_brev (int @var{value})
10434 Bit reversal.  Return the result of reversing the bits in
10435 @var{value}.  Bit 15 is swapped with bit 0, bit 14 is swapped with bit 1,
10436 and so on.
10437
10438 @item int __builtin_adds (int @var{x}, int @var{y})
10439 Saturating addition.  Return the result of adding @var{x} and @var{y},
10440 storing the value 32767 if the result overflows.
10441
10442 @item int __builtin_subs (int @var{x}, int @var{y})
10443 Saturating subtraction.  Return the result of subtracting @var{y} from
10444 @var{x}, storing the value @minus{}32768 if the result overflows.
10445
10446 @item void __builtin_halt (void)
10447 Halt.  The processor will stop execution.  This built-in is useful for
10448 implementing assertions.
10449
10450 @end table
10451
10452 @node Other MIPS Built-in Functions
10453 @subsection Other MIPS Built-in Functions
10454
10455 GCC provides other MIPS-specific built-in functions:
10456
10457 @table @code
10458 @item void __builtin_mips_cache (int @var{op}, const volatile void *@var{addr})
10459 Insert a @samp{cache} instruction with operands @var{op} and @var{addr}.
10460 GCC defines the preprocessor macro @code{___GCC_HAVE_BUILTIN_MIPS_CACHE}
10461 when this function is available.
10462 @end table
10463
10464 @node PowerPC AltiVec/VSX Built-in Functions
10465 @subsection PowerPC AltiVec Built-in Functions
10466
10467 GCC provides an interface for the PowerPC family of processors to access
10468 the AltiVec operations described in Motorola's AltiVec Programming
10469 Interface Manual.  The interface is made available by including
10470 @code{<altivec.h>} and using @option{-maltivec} and
10471 @option{-mabi=altivec}.  The interface supports the following vector
10472 types.
10473
10474 @smallexample
10475 vector unsigned char
10476 vector signed char
10477 vector bool char
10478
10479 vector unsigned short
10480 vector signed short
10481 vector bool short
10482 vector pixel
10483
10484 vector unsigned int
10485 vector signed int
10486 vector bool int
10487 vector float
10488 @end smallexample
10489
10490 If @option{-mvsx} is used the following additional vector types are
10491 implemented.
10492
10493 @smallexample
10494 vector unsigned long
10495 vector signed long
10496 vector double
10497 @end smallexample
10498
10499 The long types are only implemented for 64-bit code generation, and
10500 the long type is only used in the floating point/integer conversion
10501 instructions.
10502
10503 GCC's implementation of the high-level language interface available from
10504 C and C++ code differs from Motorola's documentation in several ways.
10505
10506 @itemize @bullet
10507
10508 @item
10509 A vector constant is a list of constant expressions within curly braces.
10510
10511 @item
10512 A vector initializer requires no cast if the vector constant is of the
10513 same type as the variable it is initializing.
10514
10515 @item
10516 If @code{signed} or @code{unsigned} is omitted, the signedness of the
10517 vector type is the default signedness of the base type.  The default
10518 varies depending on the operating system, so a portable program should
10519 always specify the signedness.
10520
10521 @item
10522 Compiling with @option{-maltivec} adds keywords @code{__vector},
10523 @code{vector}, @code{__pixel}, @code{pixel}, @code{__bool} and
10524 @code{bool}.  When compiling ISO C, the context-sensitive substitution
10525 of the keywords @code{vector}, @code{pixel} and @code{bool} is
10526 disabled.  To use them, you must include @code{<altivec.h>} instead.
10527
10528 @item
10529 GCC allows using a @code{typedef} name as the type specifier for a
10530 vector type.
10531
10532 @item
10533 For C, overloaded functions are implemented with macros so the following
10534 does not work:
10535
10536 @smallexample
10537   vec_add ((vector signed int)@{1, 2, 3, 4@}, foo);
10538 @end smallexample
10539
10540 Since @code{vec_add} is a macro, the vector constant in the example
10541 is treated as four separate arguments.  Wrap the entire argument in
10542 parentheses for this to work.
10543 @end itemize
10544
10545 @emph{Note:} Only the @code{<altivec.h>} interface is supported.
10546 Internally, GCC uses built-in functions to achieve the functionality in
10547 the aforementioned header file, but they are not supported and are
10548 subject to change without notice.
10549
10550 The following interfaces are supported for the generic and specific
10551 AltiVec operations and the AltiVec predicates.  In cases where there
10552 is a direct mapping between generic and specific operations, only the
10553 generic names are shown here, although the specific operations can also
10554 be used.
10555
10556 Arguments that are documented as @code{const int} require literal
10557 integral values within the range required for that operation.
10558
10559 @smallexample
10560 vector signed char vec_abs (vector signed char);
10561 vector signed short vec_abs (vector signed short);
10562 vector signed int vec_abs (vector signed int);
10563 vector float vec_abs (vector float);
10564
10565 vector signed char vec_abss (vector signed char);
10566 vector signed short vec_abss (vector signed short);
10567 vector signed int vec_abss (vector signed int);
10568
10569 vector signed char vec_add (vector bool char, vector signed char);
10570 vector signed char vec_add (vector signed char, vector bool char);
10571 vector signed char vec_add (vector signed char, vector signed char);
10572 vector unsigned char vec_add (vector bool char, vector unsigned char);
10573 vector unsigned char vec_add (vector unsigned char, vector bool char);
10574 vector unsigned char vec_add (vector unsigned char,
10575                               vector unsigned char);
10576 vector signed short vec_add (vector bool short, vector signed short);
10577 vector signed short vec_add (vector signed short, vector bool short);
10578 vector signed short vec_add (vector signed short, vector signed short);
10579 vector unsigned short vec_add (vector bool short,
10580                                vector unsigned short);
10581 vector unsigned short vec_add (vector unsigned short,
10582                                vector bool short);
10583 vector unsigned short vec_add (vector unsigned short,
10584                                vector unsigned short);
10585 vector signed int vec_add (vector bool int, vector signed int);
10586 vector signed int vec_add (vector signed int, vector bool int);
10587 vector signed int vec_add (vector signed int, vector signed int);
10588 vector unsigned int vec_add (vector bool int, vector unsigned int);
10589 vector unsigned int vec_add (vector unsigned int, vector bool int);
10590 vector unsigned int vec_add (vector unsigned int, vector unsigned int);
10591 vector float vec_add (vector float, vector float);
10592
10593 vector float vec_vaddfp (vector float, vector float);
10594
10595 vector signed int vec_vadduwm (vector bool int, vector signed int);
10596 vector signed int vec_vadduwm (vector signed int, vector bool int);
10597 vector signed int vec_vadduwm (vector signed int, vector signed int);
10598 vector unsigned int vec_vadduwm (vector bool int, vector unsigned int);
10599 vector unsigned int vec_vadduwm (vector unsigned int, vector bool int);
10600 vector unsigned int vec_vadduwm (vector unsigned int,
10601                                  vector unsigned int);
10602
10603 vector signed short vec_vadduhm (vector bool short,
10604                                  vector signed short);
10605 vector signed short vec_vadduhm (vector signed short,
10606                                  vector bool short);
10607 vector signed short vec_vadduhm (vector signed short,
10608                                  vector signed short);
10609 vector unsigned short vec_vadduhm (vector bool short,
10610                                    vector unsigned short);
10611 vector unsigned short vec_vadduhm (vector unsigned short,
10612                                    vector bool short);
10613 vector unsigned short vec_vadduhm (vector unsigned short,
10614                                    vector unsigned short);
10615
10616 vector signed char vec_vaddubm (vector bool char, vector signed char);
10617 vector signed char vec_vaddubm (vector signed char, vector bool char);
10618 vector signed char vec_vaddubm (vector signed char, vector signed char);
10619 vector unsigned char vec_vaddubm (vector bool char,
10620                                   vector unsigned char);
10621 vector unsigned char vec_vaddubm (vector unsigned char,
10622                                   vector bool char);
10623 vector unsigned char vec_vaddubm (vector unsigned char,
10624                                   vector unsigned char);
10625
10626 vector unsigned int vec_addc (vector unsigned int, vector unsigned int);
10627
10628 vector unsigned char vec_adds (vector bool char, vector unsigned char);
10629 vector unsigned char vec_adds (vector unsigned char, vector bool char);
10630 vector unsigned char vec_adds (vector unsigned char,
10631                                vector unsigned char);
10632 vector signed char vec_adds (vector bool char, vector signed char);
10633 vector signed char vec_adds (vector signed char, vector bool char);
10634 vector signed char vec_adds (vector signed char, vector signed char);
10635 vector unsigned short vec_adds (vector bool short,
10636                                 vector unsigned short);
10637 vector unsigned short vec_adds (vector unsigned short,
10638                                 vector bool short);
10639 vector unsigned short vec_adds (vector unsigned short,
10640                                 vector unsigned short);
10641 vector signed short vec_adds (vector bool short, vector signed short);
10642 vector signed short vec_adds (vector signed short, vector bool short);
10643 vector signed short vec_adds (vector signed short, vector signed short);
10644 vector unsigned int vec_adds (vector bool int, vector unsigned int);
10645 vector unsigned int vec_adds (vector unsigned int, vector bool int);
10646 vector unsigned int vec_adds (vector unsigned int, vector unsigned int);
10647 vector signed int vec_adds (vector bool int, vector signed int);
10648 vector signed int vec_adds (vector signed int, vector bool int);
10649 vector signed int vec_adds (vector signed int, vector signed int);
10650
10651 vector signed int vec_vaddsws (vector bool int, vector signed int);
10652 vector signed int vec_vaddsws (vector signed int, vector bool int);
10653 vector signed int vec_vaddsws (vector signed int, vector signed int);
10654
10655 vector unsigned int vec_vadduws (vector bool int, vector unsigned int);
10656 vector unsigned int vec_vadduws (vector unsigned int, vector bool int);
10657 vector unsigned int vec_vadduws (vector unsigned int,
10658                                  vector unsigned int);
10659
10660 vector signed short vec_vaddshs (vector bool short,
10661                                  vector signed short);
10662 vector signed short vec_vaddshs (vector signed short,
10663                                  vector bool short);
10664 vector signed short vec_vaddshs (vector signed short,
10665                                  vector signed short);
10666
10667 vector unsigned short vec_vadduhs (vector bool short,
10668                                    vector unsigned short);
10669 vector unsigned short vec_vadduhs (vector unsigned short,
10670                                    vector bool short);
10671 vector unsigned short vec_vadduhs (vector unsigned short,
10672                                    vector unsigned short);
10673
10674 vector signed char vec_vaddsbs (vector bool char, vector signed char);
10675 vector signed char vec_vaddsbs (vector signed char, vector bool char);
10676 vector signed char vec_vaddsbs (vector signed char, vector signed char);
10677
10678 vector unsigned char vec_vaddubs (vector bool char,
10679                                   vector unsigned char);
10680 vector unsigned char vec_vaddubs (vector unsigned char,
10681                                   vector bool char);
10682 vector unsigned char vec_vaddubs (vector unsigned char,
10683                                   vector unsigned char);
10684
10685 vector float vec_and (vector float, vector float);
10686 vector float vec_and (vector float, vector bool int);
10687 vector float vec_and (vector bool int, vector float);
10688 vector bool int vec_and (vector bool int, vector bool int);
10689 vector signed int vec_and (vector bool int, vector signed int);
10690 vector signed int vec_and (vector signed int, vector bool int);
10691 vector signed int vec_and (vector signed int, vector signed int);
10692 vector unsigned int vec_and (vector bool int, vector unsigned int);
10693 vector unsigned int vec_and (vector unsigned int, vector bool int);
10694 vector unsigned int vec_and (vector unsigned int, vector unsigned int);
10695 vector bool short vec_and (vector bool short, vector bool short);
10696 vector signed short vec_and (vector bool short, vector signed short);
10697 vector signed short vec_and (vector signed short, vector bool short);
10698 vector signed short vec_and (vector signed short, vector signed short);
10699 vector unsigned short vec_and (vector bool short,
10700                                vector unsigned short);
10701 vector unsigned short vec_and (vector unsigned short,
10702                                vector bool short);
10703 vector unsigned short vec_and (vector unsigned short,
10704                                vector unsigned short);
10705 vector signed char vec_and (vector bool char, vector signed char);
10706 vector bool char vec_and (vector bool char, vector bool char);
10707 vector signed char vec_and (vector signed char, vector bool char);
10708 vector signed char vec_and (vector signed char, vector signed char);
10709 vector unsigned char vec_and (vector bool char, vector unsigned char);
10710 vector unsigned char vec_and (vector unsigned char, vector bool char);
10711 vector unsigned char vec_and (vector unsigned char,
10712                               vector unsigned char);
10713
10714 vector float vec_andc (vector float, vector float);
10715 vector float vec_andc (vector float, vector bool int);
10716 vector float vec_andc (vector bool int, vector float);
10717 vector bool int vec_andc (vector bool int, vector bool int);
10718 vector signed int vec_andc (vector bool int, vector signed int);
10719 vector signed int vec_andc (vector signed int, vector bool int);
10720 vector signed int vec_andc (vector signed int, vector signed int);
10721 vector unsigned int vec_andc (vector bool int, vector unsigned int);
10722 vector unsigned int vec_andc (vector unsigned int, vector bool int);
10723 vector unsigned int vec_andc (vector unsigned int, vector unsigned int);
10724 vector bool short vec_andc (vector bool short, vector bool short);
10725 vector signed short vec_andc (vector bool short, vector signed short);
10726 vector signed short vec_andc (vector signed short, vector bool short);
10727 vector signed short vec_andc (vector signed short, vector signed short);
10728 vector unsigned short vec_andc (vector bool short,
10729                                 vector unsigned short);
10730 vector unsigned short vec_andc (vector unsigned short,
10731                                 vector bool short);
10732 vector unsigned short vec_andc (vector unsigned short,
10733                                 vector unsigned short);
10734 vector signed char vec_andc (vector bool char, vector signed char);
10735 vector bool char vec_andc (vector bool char, vector bool char);
10736 vector signed char vec_andc (vector signed char, vector bool char);
10737 vector signed char vec_andc (vector signed char, vector signed char);
10738 vector unsigned char vec_andc (vector bool char, vector unsigned char);
10739 vector unsigned char vec_andc (vector unsigned char, vector bool char);
10740 vector unsigned char vec_andc (vector unsigned char,
10741                                vector unsigned char);
10742
10743 vector unsigned char vec_avg (vector unsigned char,
10744                               vector unsigned char);
10745 vector signed char vec_avg (vector signed char, vector signed char);
10746 vector unsigned short vec_avg (vector unsigned short,
10747                                vector unsigned short);
10748 vector signed short vec_avg (vector signed short, vector signed short);
10749 vector unsigned int vec_avg (vector unsigned int, vector unsigned int);
10750 vector signed int vec_avg (vector signed int, vector signed int);
10751
10752 vector signed int vec_vavgsw (vector signed int, vector signed int);
10753
10754 vector unsigned int vec_vavguw (vector unsigned int,
10755                                 vector unsigned int);
10756
10757 vector signed short vec_vavgsh (vector signed short,
10758                                 vector signed short);
10759
10760 vector unsigned short vec_vavguh (vector unsigned short,
10761                                   vector unsigned short);
10762
10763 vector signed char vec_vavgsb (vector signed char, vector signed char);
10764
10765 vector unsigned char vec_vavgub (vector unsigned char,
10766                                  vector unsigned char);
10767
10768 vector float vec_copysign (vector float);
10769
10770 vector float vec_ceil (vector float);
10771
10772 vector signed int vec_cmpb (vector float, vector float);
10773
10774 vector bool char vec_cmpeq (vector signed char, vector signed char);
10775 vector bool char vec_cmpeq (vector unsigned char, vector unsigned char);
10776 vector bool short vec_cmpeq (vector signed short, vector signed short);
10777 vector bool short vec_cmpeq (vector unsigned short,
10778                              vector unsigned short);
10779 vector bool int vec_cmpeq (vector signed int, vector signed int);
10780 vector bool int vec_cmpeq (vector unsigned int, vector unsigned int);
10781 vector bool int vec_cmpeq (vector float, vector float);
10782
10783 vector bool int vec_vcmpeqfp (vector float, vector float);
10784
10785 vector bool int vec_vcmpequw (vector signed int, vector signed int);
10786 vector bool int vec_vcmpequw (vector unsigned int, vector unsigned int);
10787
10788 vector bool short vec_vcmpequh (vector signed short,
10789                                 vector signed short);
10790 vector bool short vec_vcmpequh (vector unsigned short,
10791                                 vector unsigned short);
10792
10793 vector bool char vec_vcmpequb (vector signed char, vector signed char);
10794 vector bool char vec_vcmpequb (vector unsigned char,
10795                                vector unsigned char);
10796
10797 vector bool int vec_cmpge (vector float, vector float);
10798
10799 vector bool char vec_cmpgt (vector unsigned char, vector unsigned char);
10800 vector bool char vec_cmpgt (vector signed char, vector signed char);
10801 vector bool short vec_cmpgt (vector unsigned short,
10802                              vector unsigned short);
10803 vector bool short vec_cmpgt (vector signed short, vector signed short);
10804 vector bool int vec_cmpgt (vector unsigned int, vector unsigned int);
10805 vector bool int vec_cmpgt (vector signed int, vector signed int);
10806 vector bool int vec_cmpgt (vector float, vector float);
10807
10808 vector bool int vec_vcmpgtfp (vector float, vector float);
10809
10810 vector bool int vec_vcmpgtsw (vector signed int, vector signed int);
10811
10812 vector bool int vec_vcmpgtuw (vector unsigned int, vector unsigned int);
10813
10814 vector bool short vec_vcmpgtsh (vector signed short,
10815                                 vector signed short);
10816
10817 vector bool short vec_vcmpgtuh (vector unsigned short,
10818                                 vector unsigned short);
10819
10820 vector bool char vec_vcmpgtsb (vector signed char, vector signed char);
10821
10822 vector bool char vec_vcmpgtub (vector unsigned char,
10823                                vector unsigned char);
10824
10825 vector bool int vec_cmple (vector float, vector float);
10826
10827 vector bool char vec_cmplt (vector unsigned char, vector unsigned char);
10828 vector bool char vec_cmplt (vector signed char, vector signed char);
10829 vector bool short vec_cmplt (vector unsigned short,
10830                              vector unsigned short);
10831 vector bool short vec_cmplt (vector signed short, vector signed short);
10832 vector bool int vec_cmplt (vector unsigned int, vector unsigned int);
10833 vector bool int vec_cmplt (vector signed int, vector signed int);
10834 vector bool int vec_cmplt (vector float, vector float);
10835
10836 vector float vec_ctf (vector unsigned int, const int);
10837 vector float vec_ctf (vector signed int, const int);
10838
10839 vector float vec_vcfsx (vector signed int, const int);
10840
10841 vector float vec_vcfux (vector unsigned int, const int);
10842
10843 vector signed int vec_cts (vector float, const int);
10844
10845 vector unsigned int vec_ctu (vector float, const int);
10846
10847 void vec_dss (const int);
10848
10849 void vec_dssall (void);
10850
10851 void vec_dst (const vector unsigned char *, int, const int);
10852 void vec_dst (const vector signed char *, int, const int);
10853 void vec_dst (const vector bool char *, int, const int);
10854 void vec_dst (const vector unsigned short *, int, const int);
10855 void vec_dst (const vector signed short *, int, const int);
10856 void vec_dst (const vector bool short *, int, const int);
10857 void vec_dst (const vector pixel *, int, const int);
10858 void vec_dst (const vector unsigned int *, int, const int);
10859 void vec_dst (const vector signed int *, int, const int);
10860 void vec_dst (const vector bool int *, int, const int);
10861 void vec_dst (const vector float *, int, const int);
10862 void vec_dst (const unsigned char *, int, const int);
10863 void vec_dst (const signed char *, int, const int);
10864 void vec_dst (const unsigned short *, int, const int);
10865 void vec_dst (const short *, int, const int);
10866 void vec_dst (const unsigned int *, int, const int);
10867 void vec_dst (const int *, int, const int);
10868 void vec_dst (const unsigned long *, int, const int);
10869 void vec_dst (const long *, int, const int);
10870 void vec_dst (const float *, int, const int);
10871
10872 void vec_dstst (const vector unsigned char *, int, const int);
10873 void vec_dstst (const vector signed char *, int, const int);
10874 void vec_dstst (const vector bool char *, int, const int);
10875 void vec_dstst (const vector unsigned short *, int, const int);
10876 void vec_dstst (const vector signed short *, int, const int);
10877 void vec_dstst (const vector bool short *, int, const int);
10878 void vec_dstst (const vector pixel *, int, const int);
10879 void vec_dstst (const vector unsigned int *, int, const int);
10880 void vec_dstst (const vector signed int *, int, const int);
10881 void vec_dstst (const vector bool int *, int, const int);
10882 void vec_dstst (const vector float *, int, const int);
10883 void vec_dstst (const unsigned char *, int, const int);
10884 void vec_dstst (const signed char *, int, const int);
10885 void vec_dstst (const unsigned short *, int, const int);
10886 void vec_dstst (const short *, int, const int);
10887 void vec_dstst (const unsigned int *, int, const int);
10888 void vec_dstst (const int *, int, const int);
10889 void vec_dstst (const unsigned long *, int, const int);
10890 void vec_dstst (const long *, int, const int);
10891 void vec_dstst (const float *, int, const int);
10892
10893 void vec_dststt (const vector unsigned char *, int, const int);
10894 void vec_dststt (const vector signed char *, int, const int);
10895 void vec_dststt (const vector bool char *, int, const int);
10896 void vec_dststt (const vector unsigned short *, int, const int);
10897 void vec_dststt (const vector signed short *, int, const int);
10898 void vec_dststt (const vector bool short *, int, const int);
10899 void vec_dststt (const vector pixel *, int, const int);
10900 void vec_dststt (const vector unsigned int *, int, const int);
10901 void vec_dststt (const vector signed int *, int, const int);
10902 void vec_dststt (const vector bool int *, int, const int);
10903 void vec_dststt (const vector float *, int, const int);
10904 void vec_dststt (const unsigned char *, int, const int);
10905 void vec_dststt (const signed char *, int, const int);
10906 void vec_dststt (const unsigned short *, int, const int);
10907 void vec_dststt (const short *, int, const int);
10908 void vec_dststt (const unsigned int *, int, const int);
10909 void vec_dststt (const int *, int, const int);
10910 void vec_dststt (const unsigned long *, int, const int);
10911 void vec_dststt (const long *, int, const int);
10912 void vec_dststt (const float *, int, const int);
10913
10914 void vec_dstt (const vector unsigned char *, int, const int);
10915 void vec_dstt (const vector signed char *, int, const int);
10916 void vec_dstt (const vector bool char *, int, const int);
10917 void vec_dstt (const vector unsigned short *, int, const int);
10918 void vec_dstt (const vector signed short *, int, const int);
10919 void vec_dstt (const vector bool short *, int, const int);
10920 void vec_dstt (const vector pixel *, int, const int);
10921 void vec_dstt (const vector unsigned int *, int, const int);
10922 void vec_dstt (const vector signed int *, int, const int);
10923 void vec_dstt (const vector bool int *, int, const int);
10924 void vec_dstt (const vector float *, int, const int);
10925 void vec_dstt (const unsigned char *, int, const int);
10926 void vec_dstt (const signed char *, int, const int);
10927 void vec_dstt (const unsigned short *, int, const int);
10928 void vec_dstt (const short *, int, const int);
10929 void vec_dstt (const unsigned int *, int, const int);
10930 void vec_dstt (const int *, int, const int);
10931 void vec_dstt (const unsigned long *, int, const int);
10932 void vec_dstt (const long *, int, const int);
10933 void vec_dstt (const float *, int, const int);
10934
10935 vector float vec_expte (vector float);
10936
10937 vector float vec_floor (vector float);
10938
10939 vector float vec_ld (int, const vector float *);
10940 vector float vec_ld (int, const float *);
10941 vector bool int vec_ld (int, const vector bool int *);
10942 vector signed int vec_ld (int, const vector signed int *);
10943 vector signed int vec_ld (int, const int *);
10944 vector signed int vec_ld (int, const long *);
10945 vector unsigned int vec_ld (int, const vector unsigned int *);
10946 vector unsigned int vec_ld (int, const unsigned int *);
10947 vector unsigned int vec_ld (int, const unsigned long *);
10948 vector bool short vec_ld (int, const vector bool short *);
10949 vector pixel vec_ld (int, const vector pixel *);
10950 vector signed short vec_ld (int, const vector signed short *);
10951 vector signed short vec_ld (int, const short *);
10952 vector unsigned short vec_ld (int, const vector unsigned short *);
10953 vector unsigned short vec_ld (int, const unsigned short *);
10954 vector bool char vec_ld (int, const vector bool char *);
10955 vector signed char vec_ld (int, const vector signed char *);
10956 vector signed char vec_ld (int, const signed char *);
10957 vector unsigned char vec_ld (int, const vector unsigned char *);
10958 vector unsigned char vec_ld (int, const unsigned char *);
10959
10960 vector signed char vec_lde (int, const signed char *);
10961 vector unsigned char vec_lde (int, const unsigned char *);
10962 vector signed short vec_lde (int, const short *);
10963 vector unsigned short vec_lde (int, const unsigned short *);
10964 vector float vec_lde (int, const float *);
10965 vector signed int vec_lde (int, const int *);
10966 vector unsigned int vec_lde (int, const unsigned int *);
10967 vector signed int vec_lde (int, const long *);
10968 vector unsigned int vec_lde (int, const unsigned long *);
10969
10970 vector float vec_lvewx (int, float *);
10971 vector signed int vec_lvewx (int, int *);
10972 vector unsigned int vec_lvewx (int, unsigned int *);
10973 vector signed int vec_lvewx (int, long *);
10974 vector unsigned int vec_lvewx (int, unsigned long *);
10975
10976 vector signed short vec_lvehx (int, short *);
10977 vector unsigned short vec_lvehx (int, unsigned short *);
10978
10979 vector signed char vec_lvebx (int, char *);
10980 vector unsigned char vec_lvebx (int, unsigned char *);
10981
10982 vector float vec_ldl (int, const vector float *);
10983 vector float vec_ldl (int, const float *);
10984 vector bool int vec_ldl (int, const vector bool int *);
10985 vector signed int vec_ldl (int, const vector signed int *);
10986 vector signed int vec_ldl (int, const int *);
10987 vector signed int vec_ldl (int, const long *);
10988 vector unsigned int vec_ldl (int, const vector unsigned int *);
10989 vector unsigned int vec_ldl (int, const unsigned int *);
10990 vector unsigned int vec_ldl (int, const unsigned long *);
10991 vector bool short vec_ldl (int, const vector bool short *);
10992 vector pixel vec_ldl (int, const vector pixel *);
10993 vector signed short vec_ldl (int, const vector signed short *);
10994 vector signed short vec_ldl (int, const short *);
10995 vector unsigned short vec_ldl (int, const vector unsigned short *);
10996 vector unsigned short vec_ldl (int, const unsigned short *);
10997 vector bool char vec_ldl (int, const vector bool char *);
10998 vector signed char vec_ldl (int, const vector signed char *);
10999 vector signed char vec_ldl (int, const signed char *);
11000 vector unsigned char vec_ldl (int, const vector unsigned char *);
11001 vector unsigned char vec_ldl (int, const unsigned char *);
11002
11003 vector float vec_loge (vector float);
11004
11005 vector unsigned char vec_lvsl (int, const volatile unsigned char *);
11006 vector unsigned char vec_lvsl (int, const volatile signed char *);
11007 vector unsigned char vec_lvsl (int, const volatile unsigned short *);
11008 vector unsigned char vec_lvsl (int, const volatile short *);
11009 vector unsigned char vec_lvsl (int, const volatile unsigned int *);
11010 vector unsigned char vec_lvsl (int, const volatile int *);
11011 vector unsigned char vec_lvsl (int, const volatile unsigned long *);
11012 vector unsigned char vec_lvsl (int, const volatile long *);
11013 vector unsigned char vec_lvsl (int, const volatile float *);
11014
11015 vector unsigned char vec_lvsr (int, const volatile unsigned char *);
11016 vector unsigned char vec_lvsr (int, const volatile signed char *);
11017 vector unsigned char vec_lvsr (int, const volatile unsigned short *);
11018 vector unsigned char vec_lvsr (int, const volatile short *);
11019 vector unsigned char vec_lvsr (int, const volatile unsigned int *);
11020 vector unsigned char vec_lvsr (int, const volatile int *);
11021 vector unsigned char vec_lvsr (int, const volatile unsigned long *);
11022 vector unsigned char vec_lvsr (int, const volatile long *);
11023 vector unsigned char vec_lvsr (int, const volatile float *);
11024
11025 vector float vec_madd (vector float, vector float, vector float);
11026
11027 vector signed short vec_madds (vector signed short,
11028                                vector signed short,
11029                                vector signed short);
11030
11031 vector unsigned char vec_max (vector bool char, vector unsigned char);
11032 vector unsigned char vec_max (vector unsigned char, vector bool char);
11033 vector unsigned char vec_max (vector unsigned char,
11034                               vector unsigned char);
11035 vector signed char vec_max (vector bool char, vector signed char);
11036 vector signed char vec_max (vector signed char, vector bool char);
11037 vector signed char vec_max (vector signed char, vector signed char);
11038 vector unsigned short vec_max (vector bool short,
11039                                vector unsigned short);
11040 vector unsigned short vec_max (vector unsigned short,
11041                                vector bool short);
11042 vector unsigned short vec_max (vector unsigned short,
11043                                vector unsigned short);
11044 vector signed short vec_max (vector bool short, vector signed short);
11045 vector signed short vec_max (vector signed short, vector bool short);
11046 vector signed short vec_max (vector signed short, vector signed short);
11047 vector unsigned int vec_max (vector bool int, vector unsigned int);
11048 vector unsigned int vec_max (vector unsigned int, vector bool int);
11049 vector unsigned int vec_max (vector unsigned int, vector unsigned int);
11050 vector signed int vec_max (vector bool int, vector signed int);
11051 vector signed int vec_max (vector signed int, vector bool int);
11052 vector signed int vec_max (vector signed int, vector signed int);
11053 vector float vec_max (vector float, vector float);
11054
11055 vector float vec_vmaxfp (vector float, vector float);
11056
11057 vector signed int vec_vmaxsw (vector bool int, vector signed int);
11058 vector signed int vec_vmaxsw (vector signed int, vector bool int);
11059 vector signed int vec_vmaxsw (vector signed int, vector signed int);
11060
11061 vector unsigned int vec_vmaxuw (vector bool int, vector unsigned int);
11062 vector unsigned int vec_vmaxuw (vector unsigned int, vector bool int);
11063 vector unsigned int vec_vmaxuw (vector unsigned int,
11064                                 vector unsigned int);
11065
11066 vector signed short vec_vmaxsh (vector bool short, vector signed short);
11067 vector signed short vec_vmaxsh (vector signed short, vector bool short);
11068 vector signed short vec_vmaxsh (vector signed short,
11069                                 vector signed short);
11070
11071 vector unsigned short vec_vmaxuh (vector bool short,
11072                                   vector unsigned short);
11073 vector unsigned short vec_vmaxuh (vector unsigned short,
11074                                   vector bool short);
11075 vector unsigned short vec_vmaxuh (vector unsigned short,
11076                                   vector unsigned short);
11077
11078 vector signed char vec_vmaxsb (vector bool char, vector signed char);
11079 vector signed char vec_vmaxsb (vector signed char, vector bool char);
11080 vector signed char vec_vmaxsb (vector signed char, vector signed char);
11081
11082 vector unsigned char vec_vmaxub (vector bool char,
11083                                  vector unsigned char);
11084 vector unsigned char vec_vmaxub (vector unsigned char,
11085                                  vector bool char);
11086 vector unsigned char vec_vmaxub (vector unsigned char,
11087                                  vector unsigned char);
11088
11089 vector bool char vec_mergeh (vector bool char, vector bool char);
11090 vector signed char vec_mergeh (vector signed char, vector signed char);
11091 vector unsigned char vec_mergeh (vector unsigned char,
11092                                  vector unsigned char);
11093 vector bool short vec_mergeh (vector bool short, vector bool short);
11094 vector pixel vec_mergeh (vector pixel, vector pixel);
11095 vector signed short vec_mergeh (vector signed short,
11096                                 vector signed short);
11097 vector unsigned short vec_mergeh (vector unsigned short,
11098                                   vector unsigned short);
11099 vector float vec_mergeh (vector float, vector float);
11100 vector bool int vec_mergeh (vector bool int, vector bool int);
11101 vector signed int vec_mergeh (vector signed int, vector signed int);
11102 vector unsigned int vec_mergeh (vector unsigned int,
11103                                 vector unsigned int);
11104
11105 vector float vec_vmrghw (vector float, vector float);
11106 vector bool int vec_vmrghw (vector bool int, vector bool int);
11107 vector signed int vec_vmrghw (vector signed int, vector signed int);
11108 vector unsigned int vec_vmrghw (vector unsigned int,
11109                                 vector unsigned int);
11110
11111 vector bool short vec_vmrghh (vector bool short, vector bool short);
11112 vector signed short vec_vmrghh (vector signed short,
11113                                 vector signed short);
11114 vector unsigned short vec_vmrghh (vector unsigned short,
11115                                   vector unsigned short);
11116 vector pixel vec_vmrghh (vector pixel, vector pixel);
11117
11118 vector bool char vec_vmrghb (vector bool char, vector bool char);
11119 vector signed char vec_vmrghb (vector signed char, vector signed char);
11120 vector unsigned char vec_vmrghb (vector unsigned char,
11121                                  vector unsigned char);
11122
11123 vector bool char vec_mergel (vector bool char, vector bool char);
11124 vector signed char vec_mergel (vector signed char, vector signed char);
11125 vector unsigned char vec_mergel (vector unsigned char,
11126                                  vector unsigned char);
11127 vector bool short vec_mergel (vector bool short, vector bool short);
11128 vector pixel vec_mergel (vector pixel, vector pixel);
11129 vector signed short vec_mergel (vector signed short,
11130                                 vector signed short);
11131 vector unsigned short vec_mergel (vector unsigned short,
11132                                   vector unsigned short);
11133 vector float vec_mergel (vector float, vector float);
11134 vector bool int vec_mergel (vector bool int, vector bool int);
11135 vector signed int vec_mergel (vector signed int, vector signed int);
11136 vector unsigned int vec_mergel (vector unsigned int,
11137                                 vector unsigned int);
11138
11139 vector float vec_vmrglw (vector float, vector float);
11140 vector signed int vec_vmrglw (vector signed int, vector signed int);
11141 vector unsigned int vec_vmrglw (vector unsigned int,
11142                                 vector unsigned int);
11143 vector bool int vec_vmrglw (vector bool int, vector bool int);
11144
11145 vector bool short vec_vmrglh (vector bool short, vector bool short);
11146 vector signed short vec_vmrglh (vector signed short,
11147                                 vector signed short);
11148 vector unsigned short vec_vmrglh (vector unsigned short,
11149                                   vector unsigned short);
11150 vector pixel vec_vmrglh (vector pixel, vector pixel);
11151
11152 vector bool char vec_vmrglb (vector bool char, vector bool char);
11153 vector signed char vec_vmrglb (vector signed char, vector signed char);
11154 vector unsigned char vec_vmrglb (vector unsigned char,
11155                                  vector unsigned char);
11156
11157 vector unsigned short vec_mfvscr (void);
11158
11159 vector unsigned char vec_min (vector bool char, vector unsigned char);
11160 vector unsigned char vec_min (vector unsigned char, vector bool char);
11161 vector unsigned char vec_min (vector unsigned char,
11162                               vector unsigned char);
11163 vector signed char vec_min (vector bool char, vector signed char);
11164 vector signed char vec_min (vector signed char, vector bool char);
11165 vector signed char vec_min (vector signed char, vector signed char);
11166 vector unsigned short vec_min (vector bool short,
11167                                vector unsigned short);
11168 vector unsigned short vec_min (vector unsigned short,
11169                                vector bool short);
11170 vector unsigned short vec_min (vector unsigned short,
11171                                vector unsigned short);
11172 vector signed short vec_min (vector bool short, vector signed short);
11173 vector signed short vec_min (vector signed short, vector bool short);
11174 vector signed short vec_min (vector signed short, vector signed short);
11175 vector unsigned int vec_min (vector bool int, vector unsigned int);
11176 vector unsigned int vec_min (vector unsigned int, vector bool int);
11177 vector unsigned int vec_min (vector unsigned int, vector unsigned int);
11178 vector signed int vec_min (vector bool int, vector signed int);
11179 vector signed int vec_min (vector signed int, vector bool int);
11180 vector signed int vec_min (vector signed int, vector signed int);
11181 vector float vec_min (vector float, vector float);
11182
11183 vector float vec_vminfp (vector float, vector float);
11184
11185 vector signed int vec_vminsw (vector bool int, vector signed int);
11186 vector signed int vec_vminsw (vector signed int, vector bool int);
11187 vector signed int vec_vminsw (vector signed int, vector signed int);
11188
11189 vector unsigned int vec_vminuw (vector bool int, vector unsigned int);
11190 vector unsigned int vec_vminuw (vector unsigned int, vector bool int);
11191 vector unsigned int vec_vminuw (vector unsigned int,
11192                                 vector unsigned int);
11193
11194 vector signed short vec_vminsh (vector bool short, vector signed short);
11195 vector signed short vec_vminsh (vector signed short, vector bool short);
11196 vector signed short vec_vminsh (vector signed short,
11197                                 vector signed short);
11198
11199 vector unsigned short vec_vminuh (vector bool short,
11200                                   vector unsigned short);
11201 vector unsigned short vec_vminuh (vector unsigned short,
11202                                   vector bool short);
11203 vector unsigned short vec_vminuh (vector unsigned short,
11204                                   vector unsigned short);
11205
11206 vector signed char vec_vminsb (vector bool char, vector signed char);
11207 vector signed char vec_vminsb (vector signed char, vector bool char);
11208 vector signed char vec_vminsb (vector signed char, vector signed char);
11209
11210 vector unsigned char vec_vminub (vector bool char,
11211                                  vector unsigned char);
11212 vector unsigned char vec_vminub (vector unsigned char,
11213                                  vector bool char);
11214 vector unsigned char vec_vminub (vector unsigned char,
11215                                  vector unsigned char);
11216
11217 vector signed short vec_mladd (vector signed short,
11218                                vector signed short,
11219                                vector signed short);
11220 vector signed short vec_mladd (vector signed short,
11221                                vector unsigned short,
11222                                vector unsigned short);
11223 vector signed short vec_mladd (vector unsigned short,
11224                                vector signed short,
11225                                vector signed short);
11226 vector unsigned short vec_mladd (vector unsigned short,
11227                                  vector unsigned short,
11228                                  vector unsigned short);
11229
11230 vector signed short vec_mradds (vector signed short,
11231                                 vector signed short,
11232                                 vector signed short);
11233
11234 vector unsigned int vec_msum (vector unsigned char,
11235                               vector unsigned char,
11236                               vector unsigned int);
11237 vector signed int vec_msum (vector signed char,
11238                             vector unsigned char,
11239                             vector signed int);
11240 vector unsigned int vec_msum (vector unsigned short,
11241                               vector unsigned short,
11242                               vector unsigned int);
11243 vector signed int vec_msum (vector signed short,
11244                             vector signed short,
11245                             vector signed int);
11246
11247 vector signed int vec_vmsumshm (vector signed short,
11248                                 vector signed short,
11249                                 vector signed int);
11250
11251 vector unsigned int vec_vmsumuhm (vector unsigned short,
11252                                   vector unsigned short,
11253                                   vector unsigned int);
11254
11255 vector signed int vec_vmsummbm (vector signed char,
11256                                 vector unsigned char,
11257                                 vector signed int);
11258
11259 vector unsigned int vec_vmsumubm (vector unsigned char,
11260                                   vector unsigned char,
11261                                   vector unsigned int);
11262
11263 vector unsigned int vec_msums (vector unsigned short,
11264                                vector unsigned short,
11265                                vector unsigned int);
11266 vector signed int vec_msums (vector signed short,
11267                              vector signed short,
11268                              vector signed int);
11269
11270 vector signed int vec_vmsumshs (vector signed short,
11271                                 vector signed short,
11272                                 vector signed int);
11273
11274 vector unsigned int vec_vmsumuhs (vector unsigned short,
11275                                   vector unsigned short,
11276                                   vector unsigned int);
11277
11278 void vec_mtvscr (vector signed int);
11279 void vec_mtvscr (vector unsigned int);
11280 void vec_mtvscr (vector bool int);
11281 void vec_mtvscr (vector signed short);
11282 void vec_mtvscr (vector unsigned short);
11283 void vec_mtvscr (vector bool short);
11284 void vec_mtvscr (vector pixel);
11285 void vec_mtvscr (vector signed char);
11286 void vec_mtvscr (vector unsigned char);
11287 void vec_mtvscr (vector bool char);
11288
11289 vector unsigned short vec_mule (vector unsigned char,
11290                                 vector unsigned char);
11291 vector signed short vec_mule (vector signed char,
11292                               vector signed char);
11293 vector unsigned int vec_mule (vector unsigned short,
11294                               vector unsigned short);
11295 vector signed int vec_mule (vector signed short, vector signed short);
11296
11297 vector signed int vec_vmulesh (vector signed short,
11298                                vector signed short);
11299
11300 vector unsigned int vec_vmuleuh (vector unsigned short,
11301                                  vector unsigned short);
11302
11303 vector signed short vec_vmulesb (vector signed char,
11304                                  vector signed char);
11305
11306 vector unsigned short vec_vmuleub (vector unsigned char,
11307                                   vector unsigned char);
11308
11309 vector unsigned short vec_mulo (vector unsigned char,
11310                                 vector unsigned char);
11311 vector signed short vec_mulo (vector signed char, vector signed char);
11312 vector unsigned int vec_mulo (vector unsigned short,
11313                               vector unsigned short);
11314 vector signed int vec_mulo (vector signed short, vector signed short);
11315
11316 vector signed int vec_vmulosh (vector signed short,
11317                                vector signed short);
11318
11319 vector unsigned int vec_vmulouh (vector unsigned short,
11320                                  vector unsigned short);
11321
11322 vector signed short vec_vmulosb (vector signed char,
11323                                  vector signed char);
11324
11325 vector unsigned short vec_vmuloub (vector unsigned char,
11326                                    vector unsigned char);
11327
11328 vector float vec_nmsub (vector float, vector float, vector float);
11329
11330 vector float vec_nor (vector float, vector float);
11331 vector signed int vec_nor (vector signed int, vector signed int);
11332 vector unsigned int vec_nor (vector unsigned int, vector unsigned int);
11333 vector bool int vec_nor (vector bool int, vector bool int);
11334 vector signed short vec_nor (vector signed short, vector signed short);
11335 vector unsigned short vec_nor (vector unsigned short,
11336                                vector unsigned short);
11337 vector bool short vec_nor (vector bool short, vector bool short);
11338 vector signed char vec_nor (vector signed char, vector signed char);
11339 vector unsigned char vec_nor (vector unsigned char,
11340                               vector unsigned char);
11341 vector bool char vec_nor (vector bool char, vector bool char);
11342
11343 vector float vec_or (vector float, vector float);
11344 vector float vec_or (vector float, vector bool int);
11345 vector float vec_or (vector bool int, vector float);
11346 vector bool int vec_or (vector bool int, vector bool int);
11347 vector signed int vec_or (vector bool int, vector signed int);
11348 vector signed int vec_or (vector signed int, vector bool int);
11349 vector signed int vec_or (vector signed int, vector signed int);
11350 vector unsigned int vec_or (vector bool int, vector unsigned int);
11351 vector unsigned int vec_or (vector unsigned int, vector bool int);
11352 vector unsigned int vec_or (vector unsigned int, vector unsigned int);
11353 vector bool short vec_or (vector bool short, vector bool short);
11354 vector signed short vec_or (vector bool short, vector signed short);
11355 vector signed short vec_or (vector signed short, vector bool short);
11356 vector signed short vec_or (vector signed short, vector signed short);
11357 vector unsigned short vec_or (vector bool short, vector unsigned short);
11358 vector unsigned short vec_or (vector unsigned short, vector bool short);
11359 vector unsigned short vec_or (vector unsigned short,
11360                               vector unsigned short);
11361 vector signed char vec_or (vector bool char, vector signed char);
11362 vector bool char vec_or (vector bool char, vector bool char);
11363 vector signed char vec_or (vector signed char, vector bool char);
11364 vector signed char vec_or (vector signed char, vector signed char);
11365 vector unsigned char vec_or (vector bool char, vector unsigned char);
11366 vector unsigned char vec_or (vector unsigned char, vector bool char);
11367 vector unsigned char vec_or (vector unsigned char,
11368                              vector unsigned char);
11369
11370 vector signed char vec_pack (vector signed short, vector signed short);
11371 vector unsigned char vec_pack (vector unsigned short,
11372                                vector unsigned short);
11373 vector bool char vec_pack (vector bool short, vector bool short);
11374 vector signed short vec_pack (vector signed int, vector signed int);
11375 vector unsigned short vec_pack (vector unsigned int,
11376                                 vector unsigned int);
11377 vector bool short vec_pack (vector bool int, vector bool int);
11378
11379 vector bool short vec_vpkuwum (vector bool int, vector bool int);
11380 vector signed short vec_vpkuwum (vector signed int, vector signed int);
11381 vector unsigned short vec_vpkuwum (vector unsigned int,
11382                                    vector unsigned int);
11383
11384 vector bool char vec_vpkuhum (vector bool short, vector bool short);
11385 vector signed char vec_vpkuhum (vector signed short,
11386                                 vector signed short);
11387 vector unsigned char vec_vpkuhum (vector unsigned short,
11388                                   vector unsigned short);
11389
11390 vector pixel vec_packpx (vector unsigned int, vector unsigned int);
11391
11392 vector unsigned char vec_packs (vector unsigned short,
11393                                 vector unsigned short);
11394 vector signed char vec_packs (vector signed short, vector signed short);
11395 vector unsigned short vec_packs (vector unsigned int,
11396                                  vector unsigned int);
11397 vector signed short vec_packs (vector signed int, vector signed int);
11398
11399 vector signed short vec_vpkswss (vector signed int, vector signed int);
11400
11401 vector unsigned short vec_vpkuwus (vector unsigned int,
11402                                    vector unsigned int);
11403
11404 vector signed char vec_vpkshss (vector signed short,
11405                                 vector signed short);
11406
11407 vector unsigned char vec_vpkuhus (vector unsigned short,
11408                                   vector unsigned short);
11409
11410 vector unsigned char vec_packsu (vector unsigned short,
11411                                  vector unsigned short);
11412 vector unsigned char vec_packsu (vector signed short,
11413                                  vector signed short);
11414 vector unsigned short vec_packsu (vector unsigned int,
11415                                   vector unsigned int);
11416 vector unsigned short vec_packsu (vector signed int, vector signed int);
11417
11418 vector unsigned short vec_vpkswus (vector signed int,
11419                                    vector signed int);
11420
11421 vector unsigned char vec_vpkshus (vector signed short,
11422                                   vector signed short);
11423
11424 vector float vec_perm (vector float,
11425                        vector float,
11426                        vector unsigned char);
11427 vector signed int vec_perm (vector signed int,
11428                             vector signed int,
11429                             vector unsigned char);
11430 vector unsigned int vec_perm (vector unsigned int,
11431                               vector unsigned int,
11432                               vector unsigned char);
11433 vector bool int vec_perm (vector bool int,
11434                           vector bool int,
11435                           vector unsigned char);
11436 vector signed short vec_perm (vector signed short,
11437                               vector signed short,
11438                               vector unsigned char);
11439 vector unsigned short vec_perm (vector unsigned short,
11440                                 vector unsigned short,
11441                                 vector unsigned char);
11442 vector bool short vec_perm (vector bool short,
11443                             vector bool short,
11444                             vector unsigned char);
11445 vector pixel vec_perm (vector pixel,
11446                        vector pixel,
11447                        vector unsigned char);
11448 vector signed char vec_perm (vector signed char,
11449                              vector signed char,
11450                              vector unsigned char);
11451 vector unsigned char vec_perm (vector unsigned char,
11452                                vector unsigned char,
11453                                vector unsigned char);
11454 vector bool char vec_perm (vector bool char,
11455                            vector bool char,
11456                            vector unsigned char);
11457
11458 vector float vec_re (vector float);
11459
11460 vector signed char vec_rl (vector signed char,
11461                            vector unsigned char);
11462 vector unsigned char vec_rl (vector unsigned char,
11463                              vector unsigned char);
11464 vector signed short vec_rl (vector signed short, vector unsigned short);
11465 vector unsigned short vec_rl (vector unsigned short,
11466                               vector unsigned short);
11467 vector signed int vec_rl (vector signed int, vector unsigned int);
11468 vector unsigned int vec_rl (vector unsigned int, vector unsigned int);
11469
11470 vector signed int vec_vrlw (vector signed int, vector unsigned int);
11471 vector unsigned int vec_vrlw (vector unsigned int, vector unsigned int);
11472
11473 vector signed short vec_vrlh (vector signed short,
11474                               vector unsigned short);
11475 vector unsigned short vec_vrlh (vector unsigned short,
11476                                 vector unsigned short);
11477
11478 vector signed char vec_vrlb (vector signed char, vector unsigned char);
11479 vector unsigned char vec_vrlb (vector unsigned char,
11480                                vector unsigned char);
11481
11482 vector float vec_round (vector float);
11483
11484 vector float vec_recip (vector float, vector float);
11485
11486 vector float vec_rsqrt (vector float);
11487
11488 vector float vec_rsqrte (vector float);
11489
11490 vector float vec_sel (vector float, vector float, vector bool int);
11491 vector float vec_sel (vector float, vector float, vector unsigned int);
11492 vector signed int vec_sel (vector signed int,
11493                            vector signed int,
11494                            vector bool int);
11495 vector signed int vec_sel (vector signed int,
11496                            vector signed int,
11497                            vector unsigned int);
11498 vector unsigned int vec_sel (vector unsigned int,
11499                              vector unsigned int,
11500                              vector bool int);
11501 vector unsigned int vec_sel (vector unsigned int,
11502                              vector unsigned int,
11503                              vector unsigned int);
11504 vector bool int vec_sel (vector bool int,
11505                          vector bool int,
11506                          vector bool int);
11507 vector bool int vec_sel (vector bool int,
11508                          vector bool int,
11509                          vector unsigned int);
11510 vector signed short vec_sel (vector signed short,
11511                              vector signed short,
11512                              vector bool short);
11513 vector signed short vec_sel (vector signed short,
11514                              vector signed short,
11515                              vector unsigned short);
11516 vector unsigned short vec_sel (vector unsigned short,
11517                                vector unsigned short,
11518                                vector bool short);
11519 vector unsigned short vec_sel (vector unsigned short,
11520                                vector unsigned short,
11521                                vector unsigned short);
11522 vector bool short vec_sel (vector bool short,
11523                            vector bool short,
11524                            vector bool short);
11525 vector bool short vec_sel (vector bool short,
11526                            vector bool short,
11527                            vector unsigned short);
11528 vector signed char vec_sel (vector signed char,
11529                             vector signed char,
11530                             vector bool char);
11531 vector signed char vec_sel (vector signed char,
11532                             vector signed char,
11533                             vector unsigned char);
11534 vector unsigned char vec_sel (vector unsigned char,
11535                               vector unsigned char,
11536                               vector bool char);
11537 vector unsigned char vec_sel (vector unsigned char,
11538                               vector unsigned char,
11539                               vector unsigned char);
11540 vector bool char vec_sel (vector bool char,
11541                           vector bool char,
11542                           vector bool char);
11543 vector bool char vec_sel (vector bool char,
11544                           vector bool char,
11545                           vector unsigned char);
11546
11547 vector signed char vec_sl (vector signed char,
11548                            vector unsigned char);
11549 vector unsigned char vec_sl (vector unsigned char,
11550                              vector unsigned char);
11551 vector signed short vec_sl (vector signed short, vector unsigned short);
11552 vector unsigned short vec_sl (vector unsigned short,
11553                               vector unsigned short);
11554 vector signed int vec_sl (vector signed int, vector unsigned int);
11555 vector unsigned int vec_sl (vector unsigned int, vector unsigned int);
11556
11557 vector signed int vec_vslw (vector signed int, vector unsigned int);
11558 vector unsigned int vec_vslw (vector unsigned int, vector unsigned int);
11559
11560 vector signed short vec_vslh (vector signed short,
11561                               vector unsigned short);
11562 vector unsigned short vec_vslh (vector unsigned short,
11563                                 vector unsigned short);
11564
11565 vector signed char vec_vslb (vector signed char, vector unsigned char);
11566 vector unsigned char vec_vslb (vector unsigned char,
11567                                vector unsigned char);
11568
11569 vector float vec_sld (vector float, vector float, const int);
11570 vector signed int vec_sld (vector signed int,
11571                            vector signed int,
11572                            const int);
11573 vector unsigned int vec_sld (vector unsigned int,
11574                              vector unsigned int,
11575                              const int);
11576 vector bool int vec_sld (vector bool int,
11577                          vector bool int,
11578                          const int);
11579 vector signed short vec_sld (vector signed short,
11580                              vector signed short,
11581                              const int);
11582 vector unsigned short vec_sld (vector unsigned short,
11583                                vector unsigned short,
11584                                const int);
11585 vector bool short vec_sld (vector bool short,
11586                            vector bool short,
11587                            const int);
11588 vector pixel vec_sld (vector pixel,
11589                       vector pixel,
11590                       const int);
11591 vector signed char vec_sld (vector signed char,
11592                             vector signed char,
11593                             const int);
11594 vector unsigned char vec_sld (vector unsigned char,
11595                               vector unsigned char,
11596                               const int);
11597 vector bool char vec_sld (vector bool char,
11598                           vector bool char,
11599                           const int);
11600
11601 vector signed int vec_sll (vector signed int,
11602                            vector unsigned int);
11603 vector signed int vec_sll (vector signed int,
11604                            vector unsigned short);
11605 vector signed int vec_sll (vector signed int,
11606                            vector unsigned char);
11607 vector unsigned int vec_sll (vector unsigned int,
11608                              vector unsigned int);
11609 vector unsigned int vec_sll (vector unsigned int,
11610                              vector unsigned short);
11611 vector unsigned int vec_sll (vector unsigned int,
11612                              vector unsigned char);
11613 vector bool int vec_sll (vector bool int,
11614                          vector unsigned int);
11615 vector bool int vec_sll (vector bool int,
11616                          vector unsigned short);
11617 vector bool int vec_sll (vector bool int,
11618                          vector unsigned char);
11619 vector signed short vec_sll (vector signed short,
11620                              vector unsigned int);
11621 vector signed short vec_sll (vector signed short,
11622                              vector unsigned short);
11623 vector signed short vec_sll (vector signed short,
11624                              vector unsigned char);
11625 vector unsigned short vec_sll (vector unsigned short,
11626                                vector unsigned int);
11627 vector unsigned short vec_sll (vector unsigned short,
11628                                vector unsigned short);
11629 vector unsigned short vec_sll (vector unsigned short,
11630                                vector unsigned char);
11631 vector bool short vec_sll (vector bool short, vector unsigned int);
11632 vector bool short vec_sll (vector bool short, vector unsigned short);
11633 vector bool short vec_sll (vector bool short, vector unsigned char);
11634 vector pixel vec_sll (vector pixel, vector unsigned int);
11635 vector pixel vec_sll (vector pixel, vector unsigned short);
11636 vector pixel vec_sll (vector pixel, vector unsigned char);
11637 vector signed char vec_sll (vector signed char, vector unsigned int);
11638 vector signed char vec_sll (vector signed char, vector unsigned short);
11639 vector signed char vec_sll (vector signed char, vector unsigned char);
11640 vector unsigned char vec_sll (vector unsigned char,
11641                               vector unsigned int);
11642 vector unsigned char vec_sll (vector unsigned char,
11643                               vector unsigned short);
11644 vector unsigned char vec_sll (vector unsigned char,
11645                               vector unsigned char);
11646 vector bool char vec_sll (vector bool char, vector unsigned int);
11647 vector bool char vec_sll (vector bool char, vector unsigned short);
11648 vector bool char vec_sll (vector bool char, vector unsigned char);
11649
11650 vector float vec_slo (vector float, vector signed char);
11651 vector float vec_slo (vector float, vector unsigned char);
11652 vector signed int vec_slo (vector signed int, vector signed char);
11653 vector signed int vec_slo (vector signed int, vector unsigned char);
11654 vector unsigned int vec_slo (vector unsigned int, vector signed char);
11655 vector unsigned int vec_slo (vector unsigned int, vector unsigned char);
11656 vector signed short vec_slo (vector signed short, vector signed char);
11657 vector signed short vec_slo (vector signed short, vector unsigned char);
11658 vector unsigned short vec_slo (vector unsigned short,
11659                                vector signed char);
11660 vector unsigned short vec_slo (vector unsigned short,
11661                                vector unsigned char);
11662 vector pixel vec_slo (vector pixel, vector signed char);
11663 vector pixel vec_slo (vector pixel, vector unsigned char);
11664 vector signed char vec_slo (vector signed char, vector signed char);
11665 vector signed char vec_slo (vector signed char, vector unsigned char);
11666 vector unsigned char vec_slo (vector unsigned char, vector signed char);
11667 vector unsigned char vec_slo (vector unsigned char,
11668                               vector unsigned char);
11669
11670 vector signed char vec_splat (vector signed char, const int);
11671 vector unsigned char vec_splat (vector unsigned char, const int);
11672 vector bool char vec_splat (vector bool char, const int);
11673 vector signed short vec_splat (vector signed short, const int);
11674 vector unsigned short vec_splat (vector unsigned short, const int);
11675 vector bool short vec_splat (vector bool short, const int);
11676 vector pixel vec_splat (vector pixel, const int);
11677 vector float vec_splat (vector float, const int);
11678 vector signed int vec_splat (vector signed int, const int);
11679 vector unsigned int vec_splat (vector unsigned int, const int);
11680 vector bool int vec_splat (vector bool int, const int);
11681
11682 vector float vec_vspltw (vector float, const int);
11683 vector signed int vec_vspltw (vector signed int, const int);
11684 vector unsigned int vec_vspltw (vector unsigned int, const int);
11685 vector bool int vec_vspltw (vector bool int, const int);
11686
11687 vector bool short vec_vsplth (vector bool short, const int);
11688 vector signed short vec_vsplth (vector signed short, const int);
11689 vector unsigned short vec_vsplth (vector unsigned short, const int);
11690 vector pixel vec_vsplth (vector pixel, const int);
11691
11692 vector signed char vec_vspltb (vector signed char, const int);
11693 vector unsigned char vec_vspltb (vector unsigned char, const int);
11694 vector bool char vec_vspltb (vector bool char, const int);
11695
11696 vector signed char vec_splat_s8 (const int);
11697
11698 vector signed short vec_splat_s16 (const int);
11699
11700 vector signed int vec_splat_s32 (const int);
11701
11702 vector unsigned char vec_splat_u8 (const int);
11703
11704 vector unsigned short vec_splat_u16 (const int);
11705
11706 vector unsigned int vec_splat_u32 (const int);
11707
11708 vector signed char vec_sr (vector signed char, vector unsigned char);
11709 vector unsigned char vec_sr (vector unsigned char,
11710                              vector unsigned char);
11711 vector signed short vec_sr (vector signed short,
11712                             vector unsigned short);
11713 vector unsigned short vec_sr (vector unsigned short,
11714                               vector unsigned short);
11715 vector signed int vec_sr (vector signed int, vector unsigned int);
11716 vector unsigned int vec_sr (vector unsigned int, vector unsigned int);
11717
11718 vector signed int vec_vsrw (vector signed int, vector unsigned int);
11719 vector unsigned int vec_vsrw (vector unsigned int, vector unsigned int);
11720
11721 vector signed short vec_vsrh (vector signed short,
11722                               vector unsigned short);
11723 vector unsigned short vec_vsrh (vector unsigned short,
11724                                 vector unsigned short);
11725
11726 vector signed char vec_vsrb (vector signed char, vector unsigned char);
11727 vector unsigned char vec_vsrb (vector unsigned char,
11728                                vector unsigned char);
11729
11730 vector signed char vec_sra (vector signed char, vector unsigned char);
11731 vector unsigned char vec_sra (vector unsigned char,
11732                               vector unsigned char);
11733 vector signed short vec_sra (vector signed short,
11734                              vector unsigned short);
11735 vector unsigned short vec_sra (vector unsigned short,
11736                                vector unsigned short);
11737 vector signed int vec_sra (vector signed int, vector unsigned int);
11738 vector unsigned int vec_sra (vector unsigned int, vector unsigned int);
11739
11740 vector signed int vec_vsraw (vector signed int, vector unsigned int);
11741 vector unsigned int vec_vsraw (vector unsigned int,
11742                                vector unsigned int);
11743
11744 vector signed short vec_vsrah (vector signed short,
11745                                vector unsigned short);
11746 vector unsigned short vec_vsrah (vector unsigned short,
11747                                  vector unsigned short);
11748
11749 vector signed char vec_vsrab (vector signed char, vector unsigned char);
11750 vector unsigned char vec_vsrab (vector unsigned char,
11751                                 vector unsigned char);
11752
11753 vector signed int vec_srl (vector signed int, vector unsigned int);
11754 vector signed int vec_srl (vector signed int, vector unsigned short);
11755 vector signed int vec_srl (vector signed int, vector unsigned char);
11756 vector unsigned int vec_srl (vector unsigned int, vector unsigned int);
11757 vector unsigned int vec_srl (vector unsigned int,
11758                              vector unsigned short);
11759 vector unsigned int vec_srl (vector unsigned int, vector unsigned char);
11760 vector bool int vec_srl (vector bool int, vector unsigned int);
11761 vector bool int vec_srl (vector bool int, vector unsigned short);
11762 vector bool int vec_srl (vector bool int, vector unsigned char);
11763 vector signed short vec_srl (vector signed short, vector unsigned int);
11764 vector signed short vec_srl (vector signed short,
11765                              vector unsigned short);
11766 vector signed short vec_srl (vector signed short, vector unsigned char);
11767 vector unsigned short vec_srl (vector unsigned short,
11768                                vector unsigned int);
11769 vector unsigned short vec_srl (vector unsigned short,
11770                                vector unsigned short);
11771 vector unsigned short vec_srl (vector unsigned short,
11772                                vector unsigned char);
11773 vector bool short vec_srl (vector bool short, vector unsigned int);
11774 vector bool short vec_srl (vector bool short, vector unsigned short);
11775 vector bool short vec_srl (vector bool short, vector unsigned char);
11776 vector pixel vec_srl (vector pixel, vector unsigned int);
11777 vector pixel vec_srl (vector pixel, vector unsigned short);
11778 vector pixel vec_srl (vector pixel, vector unsigned char);
11779 vector signed char vec_srl (vector signed char, vector unsigned int);
11780 vector signed char vec_srl (vector signed char, vector unsigned short);
11781 vector signed char vec_srl (vector signed char, vector unsigned char);
11782 vector unsigned char vec_srl (vector unsigned char,
11783                               vector unsigned int);
11784 vector unsigned char vec_srl (vector unsigned char,
11785                               vector unsigned short);
11786 vector unsigned char vec_srl (vector unsigned char,
11787                               vector unsigned char);
11788 vector bool char vec_srl (vector bool char, vector unsigned int);
11789 vector bool char vec_srl (vector bool char, vector unsigned short);
11790 vector bool char vec_srl (vector bool char, vector unsigned char);
11791
11792 vector float vec_sro (vector float, vector signed char);
11793 vector float vec_sro (vector float, vector unsigned char);
11794 vector signed int vec_sro (vector signed int, vector signed char);
11795 vector signed int vec_sro (vector signed int, vector unsigned char);
11796 vector unsigned int vec_sro (vector unsigned int, vector signed char);
11797 vector unsigned int vec_sro (vector unsigned int, vector unsigned char);
11798 vector signed short vec_sro (vector signed short, vector signed char);
11799 vector signed short vec_sro (vector signed short, vector unsigned char);
11800 vector unsigned short vec_sro (vector unsigned short,
11801                                vector signed char);
11802 vector unsigned short vec_sro (vector unsigned short,
11803                                vector unsigned char);
11804 vector pixel vec_sro (vector pixel, vector signed char);
11805 vector pixel vec_sro (vector pixel, vector unsigned char);
11806 vector signed char vec_sro (vector signed char, vector signed char);
11807 vector signed char vec_sro (vector signed char, vector unsigned char);
11808 vector unsigned char vec_sro (vector unsigned char, vector signed char);
11809 vector unsigned char vec_sro (vector unsigned char,
11810                               vector unsigned char);
11811
11812 void vec_st (vector float, int, vector float *);
11813 void vec_st (vector float, int, float *);
11814 void vec_st (vector signed int, int, vector signed int *);
11815 void vec_st (vector signed int, int, int *);
11816 void vec_st (vector unsigned int, int, vector unsigned int *);
11817 void vec_st (vector unsigned int, int, unsigned int *);
11818 void vec_st (vector bool int, int, vector bool int *);
11819 void vec_st (vector bool int, int, unsigned int *);
11820 void vec_st (vector bool int, int, int *);
11821 void vec_st (vector signed short, int, vector signed short *);
11822 void vec_st (vector signed short, int, short *);
11823 void vec_st (vector unsigned short, int, vector unsigned short *);
11824 void vec_st (vector unsigned short, int, unsigned short *);
11825 void vec_st (vector bool short, int, vector bool short *);
11826 void vec_st (vector bool short, int, unsigned short *);
11827 void vec_st (vector pixel, int, vector pixel *);
11828 void vec_st (vector pixel, int, unsigned short *);
11829 void vec_st (vector pixel, int, short *);
11830 void vec_st (vector bool short, int, short *);
11831 void vec_st (vector signed char, int, vector signed char *);
11832 void vec_st (vector signed char, int, signed char *);
11833 void vec_st (vector unsigned char, int, vector unsigned char *);
11834 void vec_st (vector unsigned char, int, unsigned char *);
11835 void vec_st (vector bool char, int, vector bool char *);
11836 void vec_st (vector bool char, int, unsigned char *);
11837 void vec_st (vector bool char, int, signed char *);
11838
11839 void vec_ste (vector signed char, int, signed char *);
11840 void vec_ste (vector unsigned char, int, unsigned char *);
11841 void vec_ste (vector bool char, int, signed char *);
11842 void vec_ste (vector bool char, int, unsigned char *);
11843 void vec_ste (vector signed short, int, short *);
11844 void vec_ste (vector unsigned short, int, unsigned short *);
11845 void vec_ste (vector bool short, int, short *);
11846 void vec_ste (vector bool short, int, unsigned short *);
11847 void vec_ste (vector pixel, int, short *);
11848 void vec_ste (vector pixel, int, unsigned short *);
11849 void vec_ste (vector float, int, float *);
11850 void vec_ste (vector signed int, int, int *);
11851 void vec_ste (vector unsigned int, int, unsigned int *);
11852 void vec_ste (vector bool int, int, int *);
11853 void vec_ste (vector bool int, int, unsigned int *);
11854
11855 void vec_stvewx (vector float, int, float *);
11856 void vec_stvewx (vector signed int, int, int *);
11857 void vec_stvewx (vector unsigned int, int, unsigned int *);
11858 void vec_stvewx (vector bool int, int, int *);
11859 void vec_stvewx (vector bool int, int, unsigned int *);
11860
11861 void vec_stvehx (vector signed short, int, short *);
11862 void vec_stvehx (vector unsigned short, int, unsigned short *);
11863 void vec_stvehx (vector bool short, int, short *);
11864 void vec_stvehx (vector bool short, int, unsigned short *);
11865 void vec_stvehx (vector pixel, int, short *);
11866 void vec_stvehx (vector pixel, int, unsigned short *);
11867
11868 void vec_stvebx (vector signed char, int, signed char *);
11869 void vec_stvebx (vector unsigned char, int, unsigned char *);
11870 void vec_stvebx (vector bool char, int, signed char *);
11871 void vec_stvebx (vector bool char, int, unsigned char *);
11872
11873 void vec_stl (vector float, int, vector float *);
11874 void vec_stl (vector float, int, float *);
11875 void vec_stl (vector signed int, int, vector signed int *);
11876 void vec_stl (vector signed int, int, int *);
11877 void vec_stl (vector unsigned int, int, vector unsigned int *);
11878 void vec_stl (vector unsigned int, int, unsigned int *);
11879 void vec_stl (vector bool int, int, vector bool int *);
11880 void vec_stl (vector bool int, int, unsigned int *);
11881 void vec_stl (vector bool int, int, int *);
11882 void vec_stl (vector signed short, int, vector signed short *);
11883 void vec_stl (vector signed short, int, short *);
11884 void vec_stl (vector unsigned short, int, vector unsigned short *);
11885 void vec_stl (vector unsigned short, int, unsigned short *);
11886 void vec_stl (vector bool short, int, vector bool short *);
11887 void vec_stl (vector bool short, int, unsigned short *);
11888 void vec_stl (vector bool short, int, short *);
11889 void vec_stl (vector pixel, int, vector pixel *);
11890 void vec_stl (vector pixel, int, unsigned short *);
11891 void vec_stl (vector pixel, int, short *);
11892 void vec_stl (vector signed char, int, vector signed char *);
11893 void vec_stl (vector signed char, int, signed char *);
11894 void vec_stl (vector unsigned char, int, vector unsigned char *);
11895 void vec_stl (vector unsigned char, int, unsigned char *);
11896 void vec_stl (vector bool char, int, vector bool char *);
11897 void vec_stl (vector bool char, int, unsigned char *);
11898 void vec_stl (vector bool char, int, signed char *);
11899
11900 vector signed char vec_sub (vector bool char, vector signed char);
11901 vector signed char vec_sub (vector signed char, vector bool char);
11902 vector signed char vec_sub (vector signed char, vector signed char);
11903 vector unsigned char vec_sub (vector bool char, vector unsigned char);
11904 vector unsigned char vec_sub (vector unsigned char, vector bool char);
11905 vector unsigned char vec_sub (vector unsigned char,
11906                               vector unsigned char);
11907 vector signed short vec_sub (vector bool short, vector signed short);
11908 vector signed short vec_sub (vector signed short, vector bool short);
11909 vector signed short vec_sub (vector signed short, vector signed short);
11910 vector unsigned short vec_sub (vector bool short,
11911                                vector unsigned short);
11912 vector unsigned short vec_sub (vector unsigned short,
11913                                vector bool short);
11914 vector unsigned short vec_sub (vector unsigned short,
11915                                vector unsigned short);
11916 vector signed int vec_sub (vector bool int, vector signed int);
11917 vector signed int vec_sub (vector signed int, vector bool int);
11918 vector signed int vec_sub (vector signed int, vector signed int);
11919 vector unsigned int vec_sub (vector bool int, vector unsigned int);
11920 vector unsigned int vec_sub (vector unsigned int, vector bool int);
11921 vector unsigned int vec_sub (vector unsigned int, vector unsigned int);
11922 vector float vec_sub (vector float, vector float);
11923
11924 vector float vec_vsubfp (vector float, vector float);
11925
11926 vector signed int vec_vsubuwm (vector bool int, vector signed int);
11927 vector signed int vec_vsubuwm (vector signed int, vector bool int);
11928 vector signed int vec_vsubuwm (vector signed int, vector signed int);
11929 vector unsigned int vec_vsubuwm (vector bool int, vector unsigned int);
11930 vector unsigned int vec_vsubuwm (vector unsigned int, vector bool int);
11931 vector unsigned int vec_vsubuwm (vector unsigned int,
11932                                  vector unsigned int);
11933
11934 vector signed short vec_vsubuhm (vector bool short,
11935                                  vector signed short);
11936 vector signed short vec_vsubuhm (vector signed short,
11937                                  vector bool short);
11938 vector signed short vec_vsubuhm (vector signed short,
11939                                  vector signed short);
11940 vector unsigned short vec_vsubuhm (vector bool short,
11941                                    vector unsigned short);
11942 vector unsigned short vec_vsubuhm (vector unsigned short,
11943                                    vector bool short);
11944 vector unsigned short vec_vsubuhm (vector unsigned short,
11945                                    vector unsigned short);
11946
11947 vector signed char vec_vsububm (vector bool char, vector signed char);
11948 vector signed char vec_vsububm (vector signed char, vector bool char);
11949 vector signed char vec_vsububm (vector signed char, vector signed char);
11950 vector unsigned char vec_vsububm (vector bool char,
11951                                   vector unsigned char);
11952 vector unsigned char vec_vsububm (vector unsigned char,
11953                                   vector bool char);
11954 vector unsigned char vec_vsububm (vector unsigned char,
11955                                   vector unsigned char);
11956
11957 vector unsigned int vec_subc (vector unsigned int, vector unsigned int);
11958
11959 vector unsigned char vec_subs (vector bool char, vector unsigned char);
11960 vector unsigned char vec_subs (vector unsigned char, vector bool char);
11961 vector unsigned char vec_subs (vector unsigned char,
11962                                vector unsigned char);
11963 vector signed char vec_subs (vector bool char, vector signed char);
11964 vector signed char vec_subs (vector signed char, vector bool char);
11965 vector signed char vec_subs (vector signed char, vector signed char);
11966 vector unsigned short vec_subs (vector bool short,
11967                                 vector unsigned short);
11968 vector unsigned short vec_subs (vector unsigned short,
11969                                 vector bool short);
11970 vector unsigned short vec_subs (vector unsigned short,
11971                                 vector unsigned short);
11972 vector signed short vec_subs (vector bool short, vector signed short);
11973 vector signed short vec_subs (vector signed short, vector bool short);
11974 vector signed short vec_subs (vector signed short, vector signed short);
11975 vector unsigned int vec_subs (vector bool int, vector unsigned int);
11976 vector unsigned int vec_subs (vector unsigned int, vector bool int);
11977 vector unsigned int vec_subs (vector unsigned int, vector unsigned int);
11978 vector signed int vec_subs (vector bool int, vector signed int);
11979 vector signed int vec_subs (vector signed int, vector bool int);
11980 vector signed int vec_subs (vector signed int, vector signed int);
11981
11982 vector signed int vec_vsubsws (vector bool int, vector signed int);
11983 vector signed int vec_vsubsws (vector signed int, vector bool int);
11984 vector signed int vec_vsubsws (vector signed int, vector signed int);
11985
11986 vector unsigned int vec_vsubuws (vector bool int, vector unsigned int);
11987 vector unsigned int vec_vsubuws (vector unsigned int, vector bool int);
11988 vector unsigned int vec_vsubuws (vector unsigned int,
11989                                  vector unsigned int);
11990
11991 vector signed short vec_vsubshs (vector bool short,
11992                                  vector signed short);
11993 vector signed short vec_vsubshs (vector signed short,
11994                                  vector bool short);
11995 vector signed short vec_vsubshs (vector signed short,
11996                                  vector signed short);
11997
11998 vector unsigned short vec_vsubuhs (vector bool short,
11999                                    vector unsigned short);
12000 vector unsigned short vec_vsubuhs (vector unsigned short,
12001                                    vector bool short);
12002 vector unsigned short vec_vsubuhs (vector unsigned short,
12003                                    vector unsigned short);
12004
12005 vector signed char vec_vsubsbs (vector bool char, vector signed char);
12006 vector signed char vec_vsubsbs (vector signed char, vector bool char);
12007 vector signed char vec_vsubsbs (vector signed char, vector signed char);
12008
12009 vector unsigned char vec_vsububs (vector bool char,
12010                                   vector unsigned char);
12011 vector unsigned char vec_vsububs (vector unsigned char,
12012                                   vector bool char);
12013 vector unsigned char vec_vsububs (vector unsigned char,
12014                                   vector unsigned char);
12015
12016 vector unsigned int vec_sum4s (vector unsigned char,
12017                                vector unsigned int);
12018 vector signed int vec_sum4s (vector signed char, vector signed int);
12019 vector signed int vec_sum4s (vector signed short, vector signed int);
12020
12021 vector signed int vec_vsum4shs (vector signed short, vector signed int);
12022
12023 vector signed int vec_vsum4sbs (vector signed char, vector signed int);
12024
12025 vector unsigned int vec_vsum4ubs (vector unsigned char,
12026                                   vector unsigned int);
12027
12028 vector signed int vec_sum2s (vector signed int, vector signed int);
12029
12030 vector signed int vec_sums (vector signed int, vector signed int);
12031
12032 vector float vec_trunc (vector float);
12033
12034 vector signed short vec_unpackh (vector signed char);
12035 vector bool short vec_unpackh (vector bool char);
12036 vector signed int vec_unpackh (vector signed short);
12037 vector bool int vec_unpackh (vector bool short);
12038 vector unsigned int vec_unpackh (vector pixel);
12039
12040 vector bool int vec_vupkhsh (vector bool short);
12041 vector signed int vec_vupkhsh (vector signed short);
12042
12043 vector unsigned int vec_vupkhpx (vector pixel);
12044
12045 vector bool short vec_vupkhsb (vector bool char);
12046 vector signed short vec_vupkhsb (vector signed char);
12047
12048 vector signed short vec_unpackl (vector signed char);
12049 vector bool short vec_unpackl (vector bool char);
12050 vector unsigned int vec_unpackl (vector pixel);
12051 vector signed int vec_unpackl (vector signed short);
12052 vector bool int vec_unpackl (vector bool short);
12053
12054 vector unsigned int vec_vupklpx (vector pixel);
12055
12056 vector bool int vec_vupklsh (vector bool short);
12057 vector signed int vec_vupklsh (vector signed short);
12058
12059 vector bool short vec_vupklsb (vector bool char);
12060 vector signed short vec_vupklsb (vector signed char);
12061
12062 vector float vec_xor (vector float, vector float);
12063 vector float vec_xor (vector float, vector bool int);
12064 vector float vec_xor (vector bool int, vector float);
12065 vector bool int vec_xor (vector bool int, vector bool int);
12066 vector signed int vec_xor (vector bool int, vector signed int);
12067 vector signed int vec_xor (vector signed int, vector bool int);
12068 vector signed int vec_xor (vector signed int, vector signed int);
12069 vector unsigned int vec_xor (vector bool int, vector unsigned int);
12070 vector unsigned int vec_xor (vector unsigned int, vector bool int);
12071 vector unsigned int vec_xor (vector unsigned int, vector unsigned int);
12072 vector bool short vec_xor (vector bool short, vector bool short);
12073 vector signed short vec_xor (vector bool short, vector signed short);
12074 vector signed short vec_xor (vector signed short, vector bool short);
12075 vector signed short vec_xor (vector signed short, vector signed short);
12076 vector unsigned short vec_xor (vector bool short,
12077                                vector unsigned short);
12078 vector unsigned short vec_xor (vector unsigned short,
12079                                vector bool short);
12080 vector unsigned short vec_xor (vector unsigned short,
12081                                vector unsigned short);
12082 vector signed char vec_xor (vector bool char, vector signed char);
12083 vector bool char vec_xor (vector bool char, vector bool char);
12084 vector signed char vec_xor (vector signed char, vector bool char);
12085 vector signed char vec_xor (vector signed char, vector signed char);
12086 vector unsigned char vec_xor (vector bool char, vector unsigned char);
12087 vector unsigned char vec_xor (vector unsigned char, vector bool char);
12088 vector unsigned char vec_xor (vector unsigned char,
12089                               vector unsigned char);
12090
12091 int vec_all_eq (vector signed char, vector bool char);
12092 int vec_all_eq (vector signed char, vector signed char);
12093 int vec_all_eq (vector unsigned char, vector bool char);
12094 int vec_all_eq (vector unsigned char, vector unsigned char);
12095 int vec_all_eq (vector bool char, vector bool char);
12096 int vec_all_eq (vector bool char, vector unsigned char);
12097 int vec_all_eq (vector bool char, vector signed char);
12098 int vec_all_eq (vector signed short, vector bool short);
12099 int vec_all_eq (vector signed short, vector signed short);
12100 int vec_all_eq (vector unsigned short, vector bool short);
12101 int vec_all_eq (vector unsigned short, vector unsigned short);
12102 int vec_all_eq (vector bool short, vector bool short);
12103 int vec_all_eq (vector bool short, vector unsigned short);
12104 int vec_all_eq (vector bool short, vector signed short);
12105 int vec_all_eq (vector pixel, vector pixel);
12106 int vec_all_eq (vector signed int, vector bool int);
12107 int vec_all_eq (vector signed int, vector signed int);
12108 int vec_all_eq (vector unsigned int, vector bool int);
12109 int vec_all_eq (vector unsigned int, vector unsigned int);
12110 int vec_all_eq (vector bool int, vector bool int);
12111 int vec_all_eq (vector bool int, vector unsigned int);
12112 int vec_all_eq (vector bool int, vector signed int);
12113 int vec_all_eq (vector float, vector float);
12114
12115 int vec_all_ge (vector bool char, vector unsigned char);
12116 int vec_all_ge (vector unsigned char, vector bool char);
12117 int vec_all_ge (vector unsigned char, vector unsigned char);
12118 int vec_all_ge (vector bool char, vector signed char);
12119 int vec_all_ge (vector signed char, vector bool char);
12120 int vec_all_ge (vector signed char, vector signed char);
12121 int vec_all_ge (vector bool short, vector unsigned short);
12122 int vec_all_ge (vector unsigned short, vector bool short);
12123 int vec_all_ge (vector unsigned short, vector unsigned short);
12124 int vec_all_ge (vector signed short, vector signed short);
12125 int vec_all_ge (vector bool short, vector signed short);
12126 int vec_all_ge (vector signed short, vector bool short);
12127 int vec_all_ge (vector bool int, vector unsigned int);
12128 int vec_all_ge (vector unsigned int, vector bool int);
12129 int vec_all_ge (vector unsigned int, vector unsigned int);
12130 int vec_all_ge (vector bool int, vector signed int);
12131 int vec_all_ge (vector signed int, vector bool int);
12132 int vec_all_ge (vector signed int, vector signed int);
12133 int vec_all_ge (vector float, vector float);
12134
12135 int vec_all_gt (vector bool char, vector unsigned char);
12136 int vec_all_gt (vector unsigned char, vector bool char);
12137 int vec_all_gt (vector unsigned char, vector unsigned char);
12138 int vec_all_gt (vector bool char, vector signed char);
12139 int vec_all_gt (vector signed char, vector bool char);
12140 int vec_all_gt (vector signed char, vector signed char);
12141 int vec_all_gt (vector bool short, vector unsigned short);
12142 int vec_all_gt (vector unsigned short, vector bool short);
12143 int vec_all_gt (vector unsigned short, vector unsigned short);
12144 int vec_all_gt (vector bool short, vector signed short);
12145 int vec_all_gt (vector signed short, vector bool short);
12146 int vec_all_gt (vector signed short, vector signed short);
12147 int vec_all_gt (vector bool int, vector unsigned int);
12148 int vec_all_gt (vector unsigned int, vector bool int);
12149 int vec_all_gt (vector unsigned int, vector unsigned int);
12150 int vec_all_gt (vector bool int, vector signed int);
12151 int vec_all_gt (vector signed int, vector bool int);
12152 int vec_all_gt (vector signed int, vector signed int);
12153 int vec_all_gt (vector float, vector float);
12154
12155 int vec_all_in (vector float, vector float);
12156
12157 int vec_all_le (vector bool char, vector unsigned char);
12158 int vec_all_le (vector unsigned char, vector bool char);
12159 int vec_all_le (vector unsigned char, vector unsigned char);
12160 int vec_all_le (vector bool char, vector signed char);
12161 int vec_all_le (vector signed char, vector bool char);
12162 int vec_all_le (vector signed char, vector signed char);
12163 int vec_all_le (vector bool short, vector unsigned short);
12164 int vec_all_le (vector unsigned short, vector bool short);
12165 int vec_all_le (vector unsigned short, vector unsigned short);
12166 int vec_all_le (vector bool short, vector signed short);
12167 int vec_all_le (vector signed short, vector bool short);
12168 int vec_all_le (vector signed short, vector signed short);
12169 int vec_all_le (vector bool int, vector unsigned int);
12170 int vec_all_le (vector unsigned int, vector bool int);
12171 int vec_all_le (vector unsigned int, vector unsigned int);
12172 int vec_all_le (vector bool int, vector signed int);
12173 int vec_all_le (vector signed int, vector bool int);
12174 int vec_all_le (vector signed int, vector signed int);
12175 int vec_all_le (vector float, vector float);
12176
12177 int vec_all_lt (vector bool char, vector unsigned char);
12178 int vec_all_lt (vector unsigned char, vector bool char);
12179 int vec_all_lt (vector unsigned char, vector unsigned char);
12180 int vec_all_lt (vector bool char, vector signed char);
12181 int vec_all_lt (vector signed char, vector bool char);
12182 int vec_all_lt (vector signed char, vector signed char);
12183 int vec_all_lt (vector bool short, vector unsigned short);
12184 int vec_all_lt (vector unsigned short, vector bool short);
12185 int vec_all_lt (vector unsigned short, vector unsigned short);
12186 int vec_all_lt (vector bool short, vector signed short);
12187 int vec_all_lt (vector signed short, vector bool short);
12188 int vec_all_lt (vector signed short, vector signed short);
12189 int vec_all_lt (vector bool int, vector unsigned int);
12190 int vec_all_lt (vector unsigned int, vector bool int);
12191 int vec_all_lt (vector unsigned int, vector unsigned int);
12192 int vec_all_lt (vector bool int, vector signed int);
12193 int vec_all_lt (vector signed int, vector bool int);
12194 int vec_all_lt (vector signed int, vector signed int);
12195 int vec_all_lt (vector float, vector float);
12196
12197 int vec_all_nan (vector float);
12198
12199 int vec_all_ne (vector signed char, vector bool char);
12200 int vec_all_ne (vector signed char, vector signed char);
12201 int vec_all_ne (vector unsigned char, vector bool char);
12202 int vec_all_ne (vector unsigned char, vector unsigned char);
12203 int vec_all_ne (vector bool char, vector bool char);
12204 int vec_all_ne (vector bool char, vector unsigned char);
12205 int vec_all_ne (vector bool char, vector signed char);
12206 int vec_all_ne (vector signed short, vector bool short);
12207 int vec_all_ne (vector signed short, vector signed short);
12208 int vec_all_ne (vector unsigned short, vector bool short);
12209 int vec_all_ne (vector unsigned short, vector unsigned short);
12210 int vec_all_ne (vector bool short, vector bool short);
12211 int vec_all_ne (vector bool short, vector unsigned short);
12212 int vec_all_ne (vector bool short, vector signed short);
12213 int vec_all_ne (vector pixel, vector pixel);
12214 int vec_all_ne (vector signed int, vector bool int);
12215 int vec_all_ne (vector signed int, vector signed int);
12216 int vec_all_ne (vector unsigned int, vector bool int);
12217 int vec_all_ne (vector unsigned int, vector unsigned int);
12218 int vec_all_ne (vector bool int, vector bool int);
12219 int vec_all_ne (vector bool int, vector unsigned int);
12220 int vec_all_ne (vector bool int, vector signed int);
12221 int vec_all_ne (vector float, vector float);
12222
12223 int vec_all_nge (vector float, vector float);
12224
12225 int vec_all_ngt (vector float, vector float);
12226
12227 int vec_all_nle (vector float, vector float);
12228
12229 int vec_all_nlt (vector float, vector float);
12230
12231 int vec_all_numeric (vector float);
12232
12233 int vec_any_eq (vector signed char, vector bool char);
12234 int vec_any_eq (vector signed char, vector signed char);
12235 int vec_any_eq (vector unsigned char, vector bool char);
12236 int vec_any_eq (vector unsigned char, vector unsigned char);
12237 int vec_any_eq (vector bool char, vector bool char);
12238 int vec_any_eq (vector bool char, vector unsigned char);
12239 int vec_any_eq (vector bool char, vector signed char);
12240 int vec_any_eq (vector signed short, vector bool short);
12241 int vec_any_eq (vector signed short, vector signed short);
12242 int vec_any_eq (vector unsigned short, vector bool short);
12243 int vec_any_eq (vector unsigned short, vector unsigned short);
12244 int vec_any_eq (vector bool short, vector bool short);
12245 int vec_any_eq (vector bool short, vector unsigned short);
12246 int vec_any_eq (vector bool short, vector signed short);
12247 int vec_any_eq (vector pixel, vector pixel);
12248 int vec_any_eq (vector signed int, vector bool int);
12249 int vec_any_eq (vector signed int, vector signed int);
12250 int vec_any_eq (vector unsigned int, vector bool int);
12251 int vec_any_eq (vector unsigned int, vector unsigned int);
12252 int vec_any_eq (vector bool int, vector bool int);
12253 int vec_any_eq (vector bool int, vector unsigned int);
12254 int vec_any_eq (vector bool int, vector signed int);
12255 int vec_any_eq (vector float, vector float);
12256
12257 int vec_any_ge (vector signed char, vector bool char);
12258 int vec_any_ge (vector unsigned char, vector bool char);
12259 int vec_any_ge (vector unsigned char, vector unsigned char);
12260 int vec_any_ge (vector signed char, vector signed char);
12261 int vec_any_ge (vector bool char, vector unsigned char);
12262 int vec_any_ge (vector bool char, vector signed char);
12263 int vec_any_ge (vector unsigned short, vector bool short);
12264 int vec_any_ge (vector unsigned short, vector unsigned short);
12265 int vec_any_ge (vector signed short, vector signed short);
12266 int vec_any_ge (vector signed short, vector bool short);
12267 int vec_any_ge (vector bool short, vector unsigned short);
12268 int vec_any_ge (vector bool short, vector signed short);
12269 int vec_any_ge (vector signed int, vector bool int);
12270 int vec_any_ge (vector unsigned int, vector bool int);
12271 int vec_any_ge (vector unsigned int, vector unsigned int);
12272 int vec_any_ge (vector signed int, vector signed int);
12273 int vec_any_ge (vector bool int, vector unsigned int);
12274 int vec_any_ge (vector bool int, vector signed int);
12275 int vec_any_ge (vector float, vector float);
12276
12277 int vec_any_gt (vector bool char, vector unsigned char);
12278 int vec_any_gt (vector unsigned char, vector bool char);
12279 int vec_any_gt (vector unsigned char, vector unsigned char);
12280 int vec_any_gt (vector bool char, vector signed char);
12281 int vec_any_gt (vector signed char, vector bool char);
12282 int vec_any_gt (vector signed char, vector signed char);
12283 int vec_any_gt (vector bool short, vector unsigned short);
12284 int vec_any_gt (vector unsigned short, vector bool short);
12285 int vec_any_gt (vector unsigned short, vector unsigned short);
12286 int vec_any_gt (vector bool short, vector signed short);
12287 int vec_any_gt (vector signed short, vector bool short);
12288 int vec_any_gt (vector signed short, vector signed short);
12289 int vec_any_gt (vector bool int, vector unsigned int);
12290 int vec_any_gt (vector unsigned int, vector bool int);
12291 int vec_any_gt (vector unsigned int, vector unsigned int);
12292 int vec_any_gt (vector bool int, vector signed int);
12293 int vec_any_gt (vector signed int, vector bool int);
12294 int vec_any_gt (vector signed int, vector signed int);
12295 int vec_any_gt (vector float, vector float);
12296
12297 int vec_any_le (vector bool char, vector unsigned char);
12298 int vec_any_le (vector unsigned char, vector bool char);
12299 int vec_any_le (vector unsigned char, vector unsigned char);
12300 int vec_any_le (vector bool char, vector signed char);
12301 int vec_any_le (vector signed char, vector bool char);
12302 int vec_any_le (vector signed char, vector signed char);
12303 int vec_any_le (vector bool short, vector unsigned short);
12304 int vec_any_le (vector unsigned short, vector bool short);
12305 int vec_any_le (vector unsigned short, vector unsigned short);
12306 int vec_any_le (vector bool short, vector signed short);
12307 int vec_any_le (vector signed short, vector bool short);
12308 int vec_any_le (vector signed short, vector signed short);
12309 int vec_any_le (vector bool int, vector unsigned int);
12310 int vec_any_le (vector unsigned int, vector bool int);
12311 int vec_any_le (vector unsigned int, vector unsigned int);
12312 int vec_any_le (vector bool int, vector signed int);
12313 int vec_any_le (vector signed int, vector bool int);
12314 int vec_any_le (vector signed int, vector signed int);
12315 int vec_any_le (vector float, vector float);
12316
12317 int vec_any_lt (vector bool char, vector unsigned char);
12318 int vec_any_lt (vector unsigned char, vector bool char);
12319 int vec_any_lt (vector unsigned char, vector unsigned char);
12320 int vec_any_lt (vector bool char, vector signed char);
12321 int vec_any_lt (vector signed char, vector bool char);
12322 int vec_any_lt (vector signed char, vector signed char);
12323 int vec_any_lt (vector bool short, vector unsigned short);
12324 int vec_any_lt (vector unsigned short, vector bool short);
12325 int vec_any_lt (vector unsigned short, vector unsigned short);
12326 int vec_any_lt (vector bool short, vector signed short);
12327 int vec_any_lt (vector signed short, vector bool short);
12328 int vec_any_lt (vector signed short, vector signed short);
12329 int vec_any_lt (vector bool int, vector unsigned int);
12330 int vec_any_lt (vector unsigned int, vector bool int);
12331 int vec_any_lt (vector unsigned int, vector unsigned int);
12332 int vec_any_lt (vector bool int, vector signed int);
12333 int vec_any_lt (vector signed int, vector bool int);
12334 int vec_any_lt (vector signed int, vector signed int);
12335 int vec_any_lt (vector float, vector float);
12336
12337 int vec_any_nan (vector float);
12338
12339 int vec_any_ne (vector signed char, vector bool char);
12340 int vec_any_ne (vector signed char, vector signed char);
12341 int vec_any_ne (vector unsigned char, vector bool char);
12342 int vec_any_ne (vector unsigned char, vector unsigned char);
12343 int vec_any_ne (vector bool char, vector bool char);
12344 int vec_any_ne (vector bool char, vector unsigned char);
12345 int vec_any_ne (vector bool char, vector signed char);
12346 int vec_any_ne (vector signed short, vector bool short);
12347 int vec_any_ne (vector signed short, vector signed short);
12348 int vec_any_ne (vector unsigned short, vector bool short);
12349 int vec_any_ne (vector unsigned short, vector unsigned short);
12350 int vec_any_ne (vector bool short, vector bool short);
12351 int vec_any_ne (vector bool short, vector unsigned short);
12352 int vec_any_ne (vector bool short, vector signed short);
12353 int vec_any_ne (vector pixel, vector pixel);
12354 int vec_any_ne (vector signed int, vector bool int);
12355 int vec_any_ne (vector signed int, vector signed int);
12356 int vec_any_ne (vector unsigned int, vector bool int);
12357 int vec_any_ne (vector unsigned int, vector unsigned int);
12358 int vec_any_ne (vector bool int, vector bool int);
12359 int vec_any_ne (vector bool int, vector unsigned int);
12360 int vec_any_ne (vector bool int, vector signed int);
12361 int vec_any_ne (vector float, vector float);
12362
12363 int vec_any_nge (vector float, vector float);
12364
12365 int vec_any_ngt (vector float, vector float);
12366
12367 int vec_any_nle (vector float, vector float);
12368
12369 int vec_any_nlt (vector float, vector float);
12370
12371 int vec_any_numeric (vector float);
12372
12373 int vec_any_out (vector float, vector float);
12374 @end smallexample
12375
12376 If the vector/scalar (VSX) instruction set is available, the following
12377 additional functions are available:
12378
12379 @smallexample
12380 vector double vec_abs (vector double);
12381 vector double vec_add (vector double, vector double);
12382 vector double vec_and (vector double, vector double);
12383 vector double vec_and (vector double, vector bool long);
12384 vector double vec_and (vector bool long, vector double);
12385 vector double vec_andc (vector double, vector double);
12386 vector double vec_andc (vector double, vector bool long);
12387 vector double vec_andc (vector bool long, vector double);
12388 vector double vec_ceil (vector double);
12389 vector bool long vec_cmpeq (vector double, vector double);
12390 vector bool long vec_cmpge (vector double, vector double);
12391 vector bool long vec_cmpgt (vector double, vector double);
12392 vector bool long vec_cmple (vector double, vector double);
12393 vector bool long vec_cmplt (vector double, vector double);
12394 vector float vec_div (vector float, vector float);
12395 vector double vec_div (vector double, vector double);
12396 vector double vec_floor (vector double);
12397 vector double vec_ld (int, const vector double *);
12398 vector double vec_ld (int, const double *);
12399 vector double vec_ldl (int, const vector double *);
12400 vector double vec_ldl (int, const double *);
12401 vector unsigned char vec_lvsl (int, const volatile double *);
12402 vector unsigned char vec_lvsr (int, const volatile double *);
12403 vector double vec_madd (vector double, vector double, vector double);
12404 vector double vec_max (vector double, vector double);
12405 vector double vec_min (vector double, vector double);
12406 vector float vec_msub (vector float, vector float, vector float);
12407 vector double vec_msub (vector double, vector double, vector double);
12408 vector float vec_mul (vector float, vector float);
12409 vector double vec_mul (vector double, vector double);
12410 vector float vec_nearbyint (vector float);
12411 vector double vec_nearbyint (vector double);
12412 vector float vec_nmadd (vector float, vector float, vector float);
12413 vector double vec_nmadd (vector double, vector double, vector double);
12414 vector double vec_nmsub (vector double, vector double, vector double);
12415 vector double vec_nor (vector double, vector double);
12416 vector double vec_or (vector double, vector double);
12417 vector double vec_or (vector double, vector bool long);
12418 vector double vec_or (vector bool long, vector double);
12419 vector double vec_perm (vector double,
12420                         vector double,
12421                         vector unsigned char);
12422 vector double vec_rint (vector double);
12423 vector double vec_recip (vector double, vector double);
12424 vector double vec_rsqrt (vector double);
12425 vector double vec_rsqrte (vector double);
12426 vector double vec_sel (vector double, vector double, vector bool long);
12427 vector double vec_sel (vector double, vector double, vector unsigned long);
12428 vector double vec_sub (vector double, vector double);
12429 vector float vec_sqrt (vector float);
12430 vector double vec_sqrt (vector double);
12431 void vec_st (vector double, int, vector double *);
12432 void vec_st (vector double, int, double *);
12433 vector double vec_trunc (vector double);
12434 vector double vec_xor (vector double, vector double);
12435 vector double vec_xor (vector double, vector bool long);
12436 vector double vec_xor (vector bool long, vector double);
12437 int vec_all_eq (vector double, vector double);
12438 int vec_all_ge (vector double, vector double);
12439 int vec_all_gt (vector double, vector double);
12440 int vec_all_le (vector double, vector double);
12441 int vec_all_lt (vector double, vector double);
12442 int vec_all_nan (vector double);
12443 int vec_all_ne (vector double, vector double);
12444 int vec_all_nge (vector double, vector double);
12445 int vec_all_ngt (vector double, vector double);
12446 int vec_all_nle (vector double, vector double);
12447 int vec_all_nlt (vector double, vector double);
12448 int vec_all_numeric (vector double);
12449 int vec_any_eq (vector double, vector double);
12450 int vec_any_ge (vector double, vector double);
12451 int vec_any_gt (vector double, vector double);
12452 int vec_any_le (vector double, vector double);
12453 int vec_any_lt (vector double, vector double);
12454 int vec_any_nan (vector double);
12455 int vec_any_ne (vector double, vector double);
12456 int vec_any_nge (vector double, vector double);
12457 int vec_any_ngt (vector double, vector double);
12458 int vec_any_nle (vector double, vector double);
12459 int vec_any_nlt (vector double, vector double);
12460 int vec_any_numeric (vector double);
12461
12462 vector double vec_vsx_ld (int, const vector double *);
12463 vector double vec_vsx_ld (int, const double *);
12464 vector float vec_vsx_ld (int, const vector float *);
12465 vector float vec_vsx_ld (int, const float *);
12466 vector bool int vec_vsx_ld (int, const vector bool int *);
12467 vector signed int vec_vsx_ld (int, const vector signed int *);
12468 vector signed int vec_vsx_ld (int, const int *);
12469 vector signed int vec_vsx_ld (int, const long *);
12470 vector unsigned int vec_vsx_ld (int, const vector unsigned int *);
12471 vector unsigned int vec_vsx_ld (int, const unsigned int *);
12472 vector unsigned int vec_vsx_ld (int, const unsigned long *);
12473 vector bool short vec_vsx_ld (int, const vector bool short *);
12474 vector pixel vec_vsx_ld (int, const vector pixel *);
12475 vector signed short vec_vsx_ld (int, const vector signed short *);
12476 vector signed short vec_vsx_ld (int, const short *);
12477 vector unsigned short vec_vsx_ld (int, const vector unsigned short *);
12478 vector unsigned short vec_vsx_ld (int, const unsigned short *);
12479 vector bool char vec_vsx_ld (int, const vector bool char *);
12480 vector signed char vec_vsx_ld (int, const vector signed char *);
12481 vector signed char vec_vsx_ld (int, const signed char *);
12482 vector unsigned char vec_vsx_ld (int, const vector unsigned char *);
12483 vector unsigned char vec_vsx_ld (int, const unsigned char *);
12484
12485 void vec_vsx_st (vector double, int, vector double *);
12486 void vec_vsx_st (vector double, int, double *);
12487 void vec_vsx_st (vector float, int, vector float *);
12488 void vec_vsx_st (vector float, int, float *);
12489 void vec_vsx_st (vector signed int, int, vector signed int *);
12490 void vec_vsx_st (vector signed int, int, int *);
12491 void vec_vsx_st (vector unsigned int, int, vector unsigned int *);
12492 void vec_vsx_st (vector unsigned int, int, unsigned int *);
12493 void vec_vsx_st (vector bool int, int, vector bool int *);
12494 void vec_vsx_st (vector bool int, int, unsigned int *);
12495 void vec_vsx_st (vector bool int, int, int *);
12496 void vec_vsx_st (vector signed short, int, vector signed short *);
12497 void vec_vsx_st (vector signed short, int, short *);
12498 void vec_vsx_st (vector unsigned short, int, vector unsigned short *);
12499 void vec_vsx_st (vector unsigned short, int, unsigned short *);
12500 void vec_vsx_st (vector bool short, int, vector bool short *);
12501 void vec_vsx_st (vector bool short, int, unsigned short *);
12502 void vec_vsx_st (vector pixel, int, vector pixel *);
12503 void vec_vsx_st (vector pixel, int, unsigned short *);
12504 void vec_vsx_st (vector pixel, int, short *);
12505 void vec_vsx_st (vector bool short, int, short *);
12506 void vec_vsx_st (vector signed char, int, vector signed char *);
12507 void vec_vsx_st (vector signed char, int, signed char *);
12508 void vec_vsx_st (vector unsigned char, int, vector unsigned char *);
12509 void vec_vsx_st (vector unsigned char, int, unsigned char *);
12510 void vec_vsx_st (vector bool char, int, vector bool char *);
12511 void vec_vsx_st (vector bool char, int, unsigned char *);
12512 void vec_vsx_st (vector bool char, int, signed char *);
12513 @end smallexample
12514
12515 Note that the @samp{vec_ld} and @samp{vec_st} builtins will always
12516 generate the Altivec @samp{LVX} and @samp{STVX} instructions even
12517 if the VSX instruction set is available.  The @samp{vec_vsx_ld} and
12518 @samp{vec_vsx_st} builtins will always generate the VSX @samp{LXVD2X},
12519 @samp{LXVW4X}, @samp{STXVD2X}, and @samp{STXVW4X} instructions.
12520
12521 GCC provides a few other builtins on Powerpc to access certain instructions:
12522 @smallexample
12523 float __builtin_recipdivf (float, float);
12524 float __builtin_rsqrtf (float);
12525 double __builtin_recipdiv (double, double);
12526 double __builtin_rsqrt (double);
12527 long __builtin_bpermd (long, long);
12528 int __builtin_bswap16 (int);
12529 @end smallexample
12530
12531 The @code{vec_rsqrt}, @code{__builtin_rsqrt}, and
12532 @code{__builtin_rsqrtf} functions generate multiple instructions to
12533 implement the reciprocal sqrt functionality using reciprocal sqrt
12534 estimate instructions.
12535
12536 The @code{__builtin_recipdiv}, and @code{__builtin_recipdivf}
12537 functions generate multiple instructions to implement division using
12538 the reciprocal estimate instructions.
12539
12540 @node RX Built-in Functions
12541 @subsection RX Built-in Functions
12542 GCC supports some of the RX instructions which cannot be expressed in
12543 the C programming language via the use of built-in functions.  The
12544 following functions are supported:
12545
12546 @deftypefn {Built-in Function}  void __builtin_rx_brk (void)
12547 Generates the @code{brk} machine instruction.
12548 @end deftypefn
12549
12550 @deftypefn {Built-in Function}  void __builtin_rx_clrpsw (int)
12551 Generates the @code{clrpsw} machine instruction to clear the specified
12552 bit in the processor status word.
12553 @end deftypefn
12554
12555 @deftypefn {Built-in Function}  void __builtin_rx_int (int)
12556 Generates the @code{int} machine instruction to generate an interrupt
12557 with the specified value.
12558 @end deftypefn
12559
12560 @deftypefn {Built-in Function}  void __builtin_rx_machi (int, int)
12561 Generates the @code{machi} machine instruction to add the result of
12562 multiplying the top 16-bits of the two arguments into the
12563 accumulator.
12564 @end deftypefn
12565
12566 @deftypefn {Built-in Function}  void __builtin_rx_maclo (int, int)
12567 Generates the @code{maclo} machine instruction to add the result of
12568 multiplying the bottom 16-bits of the two arguments into the
12569 accumulator.
12570 @end deftypefn
12571
12572 @deftypefn {Built-in Function}  void __builtin_rx_mulhi (int, int)
12573 Generates the @code{mulhi} machine instruction to place the result of
12574 multiplying the top 16-bits of the two arguments into the
12575 accumulator.
12576 @end deftypefn
12577
12578 @deftypefn {Built-in Function}  void __builtin_rx_mullo (int, int)
12579 Generates the @code{mullo} machine instruction to place the result of
12580 multiplying the bottom 16-bits of the two arguments into the
12581 accumulator.
12582 @end deftypefn
12583
12584 @deftypefn {Built-in Function}  int  __builtin_rx_mvfachi (void)
12585 Generates the @code{mvfachi} machine instruction to read the top
12586 32-bits of the accumulator.
12587 @end deftypefn
12588
12589 @deftypefn {Built-in Function}  int  __builtin_rx_mvfacmi (void)
12590 Generates the @code{mvfacmi} machine instruction to read the middle
12591 32-bits of the accumulator.
12592 @end deftypefn
12593
12594 @deftypefn {Built-in Function}  int __builtin_rx_mvfc (int)
12595 Generates the @code{mvfc} machine instruction which reads the control
12596 register specified in its argument and returns its value.
12597 @end deftypefn
12598
12599 @deftypefn {Built-in Function}  void __builtin_rx_mvtachi (int)
12600 Generates the @code{mvtachi} machine instruction to set the top
12601 32-bits of the accumulator.
12602 @end deftypefn
12603
12604 @deftypefn {Built-in Function}  void __builtin_rx_mvtaclo (int)
12605 Generates the @code{mvtaclo} machine instruction to set the bottom
12606 32-bits of the accumulator.
12607 @end deftypefn
12608
12609 @deftypefn {Built-in Function}  void __builtin_rx_mvtc (int reg, int val)
12610 Generates the @code{mvtc} machine instruction which sets control
12611 register number @code{reg} to @code{val}.
12612 @end deftypefn
12613
12614 @deftypefn {Built-in Function}  void __builtin_rx_mvtipl (int)
12615 Generates the @code{mvtipl} machine instruction set the interrupt
12616 priority level.
12617 @end deftypefn
12618
12619 @deftypefn {Built-in Function}  void __builtin_rx_racw (int)
12620 Generates the @code{racw} machine instruction to round the accumulator
12621 according to the specified mode.
12622 @end deftypefn
12623
12624 @deftypefn {Built-in Function}  int __builtin_rx_revw (int)
12625 Generates the @code{revw} machine instruction which swaps the bytes in
12626 the argument so that bits 0--7 now occupy bits 8--15 and vice versa,
12627 and also bits 16--23 occupy bits 24--31 and vice versa.
12628 @end deftypefn
12629
12630 @deftypefn {Built-in Function}  void __builtin_rx_rmpa (void)
12631 Generates the @code{rmpa} machine instruction which initiates a
12632 repeated multiply and accumulate sequence.
12633 @end deftypefn
12634
12635 @deftypefn {Built-in Function}  void __builtin_rx_round (float)
12636 Generates the @code{round} machine instruction which returns the
12637 floating point argument rounded according to the current rounding mode
12638 set in the floating point status word register.
12639 @end deftypefn
12640
12641 @deftypefn {Built-in Function}  int __builtin_rx_sat (int)
12642 Generates the @code{sat} machine instruction which returns the
12643 saturated value of the argument.
12644 @end deftypefn
12645
12646 @deftypefn {Built-in Function}  void __builtin_rx_setpsw (int)
12647 Generates the @code{setpsw} machine instruction to set the specified
12648 bit in the processor status word.
12649 @end deftypefn
12650
12651 @deftypefn {Built-in Function}  void __builtin_rx_wait (void)
12652 Generates the @code{wait} machine instruction.
12653 @end deftypefn
12654
12655 @node SPARC VIS Built-in Functions
12656 @subsection SPARC VIS Built-in Functions
12657
12658 GCC supports SIMD operations on the SPARC using both the generic vector
12659 extensions (@pxref{Vector Extensions}) as well as built-in functions for
12660 the SPARC Visual Instruction Set (VIS).  When you use the @option{-mvis}
12661 switch, the VIS extension is exposed as the following built-in functions:
12662
12663 @smallexample
12664 typedef int v2si __attribute__ ((vector_size (8)));
12665 typedef short v4hi __attribute__ ((vector_size (8)));
12666 typedef short v2hi __attribute__ ((vector_size (4)));
12667 typedef char v8qi __attribute__ ((vector_size (8)));
12668 typedef char v4qi __attribute__ ((vector_size (4)));
12669
12670 void * __builtin_vis_alignaddr (void *, long);
12671 int64_t __builtin_vis_faligndatadi (int64_t, int64_t);
12672 v2si __builtin_vis_faligndatav2si (v2si, v2si);
12673 v4hi __builtin_vis_faligndatav4hi (v4si, v4si);
12674 v8qi __builtin_vis_faligndatav8qi (v8qi, v8qi);
12675
12676 v4hi __builtin_vis_fexpand (v4qi);
12677
12678 v4hi __builtin_vis_fmul8x16 (v4qi, v4hi);
12679 v4hi __builtin_vis_fmul8x16au (v4qi, v4hi);
12680 v4hi __builtin_vis_fmul8x16al (v4qi, v4hi);
12681 v4hi __builtin_vis_fmul8sux16 (v8qi, v4hi);
12682 v4hi __builtin_vis_fmul8ulx16 (v8qi, v4hi);
12683 v2si __builtin_vis_fmuld8sux16 (v4qi, v2hi);
12684 v2si __builtin_vis_fmuld8ulx16 (v4qi, v2hi);
12685
12686 v4qi __builtin_vis_fpack16 (v4hi);
12687 v8qi __builtin_vis_fpack32 (v2si, v2si);
12688 v2hi __builtin_vis_fpackfix (v2si);
12689 v8qi __builtin_vis_fpmerge (v4qi, v4qi);
12690
12691 int64_t __builtin_vis_pdist (v8qi, v8qi, int64_t);
12692 @end smallexample
12693
12694 @node SPU Built-in Functions
12695 @subsection SPU Built-in Functions
12696
12697 GCC provides extensions for the SPU processor as described in the
12698 Sony/Toshiba/IBM SPU Language Extensions Specification, which can be
12699 found at @uref{http://cell.scei.co.jp/} or
12700 @uref{http://www.ibm.com/developerworks/power/cell/}.  GCC's
12701 implementation differs in several ways.
12702
12703 @itemize @bullet
12704
12705 @item
12706 The optional extension of specifying vector constants in parentheses is
12707 not supported.
12708
12709 @item
12710 A vector initializer requires no cast if the vector constant is of the
12711 same type as the variable it is initializing.
12712
12713 @item
12714 If @code{signed} or @code{unsigned} is omitted, the signedness of the
12715 vector type is the default signedness of the base type.  The default
12716 varies depending on the operating system, so a portable program should
12717 always specify the signedness.
12718
12719 @item
12720 By default, the keyword @code{__vector} is added. The macro
12721 @code{vector} is defined in @code{<spu_intrinsics.h>} and can be
12722 undefined.
12723
12724 @item
12725 GCC allows using a @code{typedef} name as the type specifier for a
12726 vector type.
12727
12728 @item
12729 For C, overloaded functions are implemented with macros so the following
12730 does not work:
12731
12732 @smallexample
12733   spu_add ((vector signed int)@{1, 2, 3, 4@}, foo);
12734 @end smallexample
12735
12736 Since @code{spu_add} is a macro, the vector constant in the example
12737 is treated as four separate arguments.  Wrap the entire argument in
12738 parentheses for this to work.
12739
12740 @item
12741 The extended version of @code{__builtin_expect} is not supported.
12742
12743 @end itemize
12744
12745 @emph{Note:} Only the interface described in the aforementioned
12746 specification is supported. Internally, GCC uses built-in functions to
12747 implement the required functionality, but these are not supported and
12748 are subject to change without notice.
12749
12750 @node Target Format Checks
12751 @section Format Checks Specific to Particular Target Machines
12752
12753 For some target machines, GCC supports additional options to the
12754 format attribute
12755 (@pxref{Function Attributes,,Declaring Attributes of Functions}).
12756
12757 @menu
12758 * Solaris Format Checks::
12759 * Darwin Format Checks::
12760 @end menu
12761
12762 @node Solaris Format Checks
12763 @subsection Solaris Format Checks
12764
12765 Solaris targets support the @code{cmn_err} (or @code{__cmn_err__}) format
12766 check.  @code{cmn_err} accepts a subset of the standard @code{printf}
12767 conversions, and the two-argument @code{%b} conversion for displaying
12768 bit-fields.  See the Solaris man page for @code{cmn_err} for more information.
12769
12770 @node Darwin Format Checks
12771 @subsection Darwin Format Checks
12772
12773 Darwin targets support the @code{CFString} (or @code{__CFString__}) in the format
12774 attribute context.  Declarations made with such attribution will be parsed for correct syntax
12775 and format argument types.  However, parsing of the format string itself is currently undefined
12776 and will not be carried out by this version of the compiler.
12777
12778 Additionally, @code{CFStringRefs} (defined by the @code{CoreFoundation} headers) may
12779 also be used as format arguments.  Note that the relevant headers are only likely to be
12780 available on Darwin (OSX) installations.  On such installations, the XCode and system
12781 documentation provide descriptions of @code{CFString}, @code{CFStringRefs} and
12782 associated functions.
12783
12784 @node Pragmas
12785 @section Pragmas Accepted by GCC
12786 @cindex pragmas
12787 @cindex @code{#pragma}
12788
12789 GCC supports several types of pragmas, primarily in order to compile
12790 code originally written for other compilers.  Note that in general
12791 we do not recommend the use of pragmas; @xref{Function Attributes},
12792 for further explanation.
12793
12794 @menu
12795 * ARM Pragmas::
12796 * M32C Pragmas::
12797 * MeP Pragmas::
12798 * RS/6000 and PowerPC Pragmas::
12799 * Darwin Pragmas::
12800 * Solaris Pragmas::
12801 * Symbol-Renaming Pragmas::
12802 * Structure-Packing Pragmas::
12803 * Weak Pragmas::
12804 * Diagnostic Pragmas::
12805 * Visibility Pragmas::
12806 * Push/Pop Macro Pragmas::
12807 * Function Specific Option Pragmas::
12808 @end menu
12809
12810 @node ARM Pragmas
12811 @subsection ARM Pragmas
12812
12813 The ARM target defines pragmas for controlling the default addition of
12814 @code{long_call} and @code{short_call} attributes to functions.
12815 @xref{Function Attributes}, for information about the effects of these
12816 attributes.
12817
12818 @table @code
12819 @item long_calls
12820 @cindex pragma, long_calls
12821 Set all subsequent functions to have the @code{long_call} attribute.
12822
12823 @item no_long_calls
12824 @cindex pragma, no_long_calls
12825 Set all subsequent functions to have the @code{short_call} attribute.
12826
12827 @item long_calls_off
12828 @cindex pragma, long_calls_off
12829 Do not affect the @code{long_call} or @code{short_call} attributes of
12830 subsequent functions.
12831 @end table
12832
12833 @node M32C Pragmas
12834 @subsection M32C Pragmas
12835
12836 @table @code
12837 @item GCC memregs @var{number}
12838 @cindex pragma, memregs
12839 Overrides the command-line option @code{-memregs=} for the current
12840 file.  Use with care!  This pragma must be before any function in the
12841 file, and mixing different memregs values in different objects may
12842 make them incompatible.  This pragma is useful when a
12843 performance-critical function uses a memreg for temporary values,
12844 as it may allow you to reduce the number of memregs used.
12845
12846 @item ADDRESS @var{name} @var{address}
12847 @cindex pragma, address
12848 For any declared symbols matching @var{name}, this does three things
12849 to that symbol: it forces the symbol to be located at the given
12850 address (a number), it forces the symbol to be volatile, and it
12851 changes the symbol's scope to be static.  This pragma exists for
12852 compatibility with other compilers, but note that the common
12853 @code{1234H} numeric syntax is not supported (use @code{0x1234}
12854 instead).  Example:
12855
12856 @example
12857 #pragma ADDRESS port3 0x103
12858 char port3;
12859 @end example
12860
12861 @end table
12862
12863 @node MeP Pragmas
12864 @subsection MeP Pragmas
12865
12866 @table @code
12867
12868 @item custom io_volatile (on|off)
12869 @cindex pragma, custom io_volatile
12870 Overrides the command line option @code{-mio-volatile} for the current
12871 file.  Note that for compatibility with future GCC releases, this
12872 option should only be used once before any @code{io} variables in each
12873 file.
12874
12875 @item GCC coprocessor available @var{registers}
12876 @cindex pragma, coprocessor available
12877 Specifies which coprocessor registers are available to the register
12878 allocator.  @var{registers} may be a single register, register range
12879 separated by ellipses, or comma-separated list of those.  Example:
12880
12881 @example
12882 #pragma GCC coprocessor available $c0...$c10, $c28
12883 @end example
12884
12885 @item GCC coprocessor call_saved @var{registers}
12886 @cindex pragma, coprocessor call_saved
12887 Specifies which coprocessor registers are to be saved and restored by
12888 any function using them.  @var{registers} may be a single register,
12889 register range separated by ellipses, or comma-separated list of
12890 those.  Example:
12891
12892 @example
12893 #pragma GCC coprocessor call_saved $c4...$c6, $c31
12894 @end example
12895
12896 @item GCC coprocessor subclass '(A|B|C|D)' = @var{registers}
12897 @cindex pragma, coprocessor subclass
12898 Creates and defines a register class.  These register classes can be
12899 used by inline @code{asm} constructs.  @var{registers} may be a single
12900 register, register range separated by ellipses, or comma-separated
12901 list of those.  Example:
12902
12903 @example
12904 #pragma GCC coprocessor subclass 'B' = $c2, $c4, $c6
12905
12906 asm ("cpfoo %0" : "=B" (x));
12907 @end example
12908
12909 @item GCC disinterrupt @var{name} , @var{name} @dots{}
12910 @cindex pragma, disinterrupt
12911 For the named functions, the compiler adds code to disable interrupts
12912 for the duration of those functions.  Any functions so named, which
12913 are not encountered in the source, cause a warning that the pragma was
12914 not used.  Examples:
12915
12916 @example
12917 #pragma disinterrupt foo
12918 #pragma disinterrupt bar, grill
12919 int foo () @{ @dots{} @}
12920 @end example
12921
12922 @item GCC call @var{name} , @var{name} @dots{}
12923 @cindex pragma, call
12924 For the named functions, the compiler always uses a register-indirect
12925 call model when calling the named functions.  Examples:
12926
12927 @example
12928 extern int foo ();
12929 #pragma call foo
12930 @end example
12931
12932 @end table
12933
12934 @node RS/6000 and PowerPC Pragmas
12935 @subsection RS/6000 and PowerPC Pragmas
12936
12937 The RS/6000 and PowerPC targets define one pragma for controlling
12938 whether or not the @code{longcall} attribute is added to function
12939 declarations by default.  This pragma overrides the @option{-mlongcall}
12940 option, but not the @code{longcall} and @code{shortcall} attributes.
12941 @xref{RS/6000 and PowerPC Options}, for more information about when long
12942 calls are and are not necessary.
12943
12944 @table @code
12945 @item longcall (1)
12946 @cindex pragma, longcall
12947 Apply the @code{longcall} attribute to all subsequent function
12948 declarations.
12949
12950 @item longcall (0)
12951 Do not apply the @code{longcall} attribute to subsequent function
12952 declarations.
12953 @end table
12954
12955 @c Describe h8300 pragmas here.
12956 @c Describe sh pragmas here.
12957 @c Describe v850 pragmas here.
12958
12959 @node Darwin Pragmas
12960 @subsection Darwin Pragmas
12961
12962 The following pragmas are available for all architectures running the
12963 Darwin operating system.  These are useful for compatibility with other
12964 Mac OS compilers.
12965
12966 @table @code
12967 @item mark @var{tokens}@dots{}
12968 @cindex pragma, mark
12969 This pragma is accepted, but has no effect.
12970
12971 @item options align=@var{alignment}
12972 @cindex pragma, options align
12973 This pragma sets the alignment of fields in structures.  The values of
12974 @var{alignment} may be @code{mac68k}, to emulate m68k alignment, or
12975 @code{power}, to emulate PowerPC alignment.  Uses of this pragma nest
12976 properly; to restore the previous setting, use @code{reset} for the
12977 @var{alignment}.
12978
12979 @item segment @var{tokens}@dots{}
12980 @cindex pragma, segment
12981 This pragma is accepted, but has no effect.
12982
12983 @item unused (@var{var} [, @var{var}]@dots{})
12984 @cindex pragma, unused
12985 This pragma declares variables to be possibly unused.  GCC will not
12986 produce warnings for the listed variables.  The effect is similar to
12987 that of the @code{unused} attribute, except that this pragma may appear
12988 anywhere within the variables' scopes.
12989 @end table
12990
12991 @node Solaris Pragmas
12992 @subsection Solaris Pragmas
12993
12994 The Solaris target supports @code{#pragma redefine_extname}
12995 (@pxref{Symbol-Renaming Pragmas}).  It also supports additional
12996 @code{#pragma} directives for compatibility with the system compiler.
12997
12998 @table @code
12999 @item align @var{alignment} (@var{variable} [, @var{variable}]...)
13000 @cindex pragma, align
13001
13002 Increase the minimum alignment of each @var{variable} to @var{alignment}.
13003 This is the same as GCC's @code{aligned} attribute @pxref{Variable
13004 Attributes}).  Macro expansion occurs on the arguments to this pragma
13005 when compiling C and Objective-C@.  It does not currently occur when
13006 compiling C++, but this is a bug which may be fixed in a future
13007 release.
13008
13009 @item fini (@var{function} [, @var{function}]...)
13010 @cindex pragma, fini
13011
13012 This pragma causes each listed @var{function} to be called after
13013 main, or during shared module unloading, by adding a call to the
13014 @code{.fini} section.
13015
13016 @item init (@var{function} [, @var{function}]...)
13017 @cindex pragma, init
13018
13019 This pragma causes each listed @var{function} to be called during
13020 initialization (before @code{main}) or during shared module loading, by
13021 adding a call to the @code{.init} section.
13022
13023 @end table
13024
13025 @node Symbol-Renaming Pragmas
13026 @subsection Symbol-Renaming Pragmas
13027
13028 For compatibility with the Solaris and Tru64 UNIX system headers, GCC
13029 supports two @code{#pragma} directives which change the name used in
13030 assembly for a given declaration.  @code{#pragma extern_prefix} is only
13031 available on platforms whose system headers need it. To get this effect
13032 on all platforms supported by GCC, use the asm labels extension (@pxref{Asm
13033 Labels}).
13034
13035 @table @code
13036 @item redefine_extname @var{oldname} @var{newname}
13037 @cindex pragma, redefine_extname
13038
13039 This pragma gives the C function @var{oldname} the assembly symbol
13040 @var{newname}.  The preprocessor macro @code{__PRAGMA_REDEFINE_EXTNAME}
13041 will be defined if this pragma is available (currently on all platforms).
13042
13043 @item extern_prefix @var{string}
13044 @cindex pragma, extern_prefix
13045
13046 This pragma causes all subsequent external function and variable
13047 declarations to have @var{string} prepended to their assembly symbols.
13048 This effect may be terminated with another @code{extern_prefix} pragma
13049 whose argument is an empty string.  The preprocessor macro
13050 @code{__PRAGMA_EXTERN_PREFIX} will be defined if this pragma is
13051 available (currently only on Tru64 UNIX)@.
13052 @end table
13053
13054 These pragmas and the asm labels extension interact in a complicated
13055 manner.  Here are some corner cases you may want to be aware of.
13056
13057 @enumerate
13058 @item Both pragmas silently apply only to declarations with external
13059 linkage.  Asm labels do not have this restriction.
13060
13061 @item In C++, both pragmas silently apply only to declarations with
13062 ``C'' linkage.  Again, asm labels do not have this restriction.
13063
13064 @item If any of the three ways of changing the assembly name of a
13065 declaration is applied to a declaration whose assembly name has
13066 already been determined (either by a previous use of one of these
13067 features, or because the compiler needed the assembly name in order to
13068 generate code), and the new name is different, a warning issues and
13069 the name does not change.
13070
13071 @item The @var{oldname} used by @code{#pragma redefine_extname} is
13072 always the C-language name.
13073
13074 @item If @code{#pragma extern_prefix} is in effect, and a declaration
13075 occurs with an asm label attached, the prefix is silently ignored for
13076 that declaration.
13077
13078 @item If @code{#pragma extern_prefix} and @code{#pragma redefine_extname}
13079 apply to the same declaration, whichever triggered first wins, and a
13080 warning issues if they contradict each other.  (We would like to have
13081 @code{#pragma redefine_extname} always win, for consistency with asm
13082 labels, but if @code{#pragma extern_prefix} triggers first we have no
13083 way of knowing that that happened.)
13084 @end enumerate
13085
13086 @node Structure-Packing Pragmas
13087 @subsection Structure-Packing Pragmas
13088
13089 For compatibility with Microsoft Windows compilers, GCC supports a
13090 set of @code{#pragma} directives which change the maximum alignment of
13091 members of structures (other than zero-width bitfields), unions, and
13092 classes subsequently defined. The @var{n} value below always is required
13093 to be a small power of two and specifies the new alignment in bytes.
13094
13095 @enumerate
13096 @item @code{#pragma pack(@var{n})} simply sets the new alignment.
13097 @item @code{#pragma pack()} sets the alignment to the one that was in
13098 effect when compilation started (see also command-line option
13099 @option{-fpack-struct[=@var{n}]} @pxref{Code Gen Options}).
13100 @item @code{#pragma pack(push[,@var{n}])} pushes the current alignment
13101 setting on an internal stack and then optionally sets the new alignment.
13102 @item @code{#pragma pack(pop)} restores the alignment setting to the one
13103 saved at the top of the internal stack (and removes that stack entry).
13104 Note that @code{#pragma pack([@var{n}])} does not influence this internal
13105 stack; thus it is possible to have @code{#pragma pack(push)} followed by
13106 multiple @code{#pragma pack(@var{n})} instances and finalized by a single
13107 @code{#pragma pack(pop)}.
13108 @end enumerate
13109
13110 Some targets, e.g.@: i386 and powerpc, support the @code{ms_struct}
13111 @code{#pragma} which lays out a structure as the documented
13112 @code{__attribute__ ((ms_struct))}.
13113 @enumerate
13114 @item @code{#pragma ms_struct on} turns on the layout for structures
13115 declared.
13116 @item @code{#pragma ms_struct off} turns off the layout for structures
13117 declared.
13118 @item @code{#pragma ms_struct reset} goes back to the default layout.
13119 @end enumerate
13120
13121 @node Weak Pragmas
13122 @subsection Weak Pragmas
13123
13124 For compatibility with SVR4, GCC supports a set of @code{#pragma}
13125 directives for declaring symbols to be weak, and defining weak
13126 aliases.
13127
13128 @table @code
13129 @item #pragma weak @var{symbol}
13130 @cindex pragma, weak
13131 This pragma declares @var{symbol} to be weak, as if the declaration
13132 had the attribute of the same name.  The pragma may appear before
13133 or after the declaration of @var{symbol}.  It is not an error for
13134 @var{symbol} to never be defined at all.
13135
13136 @item #pragma weak @var{symbol1} = @var{symbol2}
13137 This pragma declares @var{symbol1} to be a weak alias of @var{symbol2}.
13138 It is an error if @var{symbol2} is not defined in the current
13139 translation unit.
13140 @end table
13141
13142 @node Diagnostic Pragmas
13143 @subsection Diagnostic Pragmas
13144
13145 GCC allows the user to selectively enable or disable certain types of
13146 diagnostics, and change the kind of the diagnostic.  For example, a
13147 project's policy might require that all sources compile with
13148 @option{-Werror} but certain files might have exceptions allowing
13149 specific types of warnings.  Or, a project might selectively enable
13150 diagnostics and treat them as errors depending on which preprocessor
13151 macros are defined.
13152
13153 @table @code
13154 @item #pragma GCC diagnostic @var{kind} @var{option}
13155 @cindex pragma, diagnostic
13156
13157 Modifies the disposition of a diagnostic.  Note that not all
13158 diagnostics are modifiable; at the moment only warnings (normally
13159 controlled by @samp{-W@dots{}}) can be controlled, and not all of them.
13160 Use @option{-fdiagnostics-show-option} to determine which diagnostics
13161 are controllable and which option controls them.
13162
13163 @var{kind} is @samp{error} to treat this diagnostic as an error,
13164 @samp{warning} to treat it like a warning (even if @option{-Werror} is
13165 in effect), or @samp{ignored} if the diagnostic is to be ignored.
13166 @var{option} is a double quoted string which matches the command-line
13167 option.
13168
13169 @example
13170 #pragma GCC diagnostic warning "-Wformat"
13171 #pragma GCC diagnostic error "-Wformat"
13172 #pragma GCC diagnostic ignored "-Wformat"
13173 @end example
13174
13175 Note that these pragmas override any command-line options.  GCC keeps
13176 track of the location of each pragma, and issues diagnostics according
13177 to the state as of that point in the source file.  Thus, pragmas occurring
13178 after a line do not affect diagnostics caused by that line.
13179
13180 @item #pragma GCC diagnostic push
13181 @itemx #pragma GCC diagnostic pop
13182
13183 Causes GCC to remember the state of the diagnostics as of each
13184 @code{push}, and restore to that point at each @code{pop}.  If a
13185 @code{pop} has no matching @code{push}, the command line options are
13186 restored.
13187
13188 @example
13189 #pragma GCC diagnostic error "-Wuninitialized"
13190   foo(a);                       /* error is given for this one */
13191 #pragma GCC diagnostic push
13192 #pragma GCC diagnostic ignored "-Wuninitialized"
13193   foo(b);                       /* no diagnostic for this one */
13194 #pragma GCC diagnostic pop
13195   foo(c);                       /* error is given for this one */
13196 #pragma GCC diagnostic pop
13197   foo(d);                       /* depends on command line options */
13198 @end example
13199
13200 @end table
13201
13202 GCC also offers a simple mechanism for printing messages during
13203 compilation.
13204
13205 @table @code
13206 @item #pragma message @var{string}
13207 @cindex pragma, diagnostic
13208
13209 Prints @var{string} as a compiler message on compilation.  The message
13210 is informational only, and is neither a compilation warning nor an error.
13211
13212 @smallexample
13213 #pragma message "Compiling " __FILE__ "..."
13214 @end smallexample
13215
13216 @var{string} may be parenthesized, and is printed with location
13217 information.  For example,
13218
13219 @smallexample
13220 #define DO_PRAGMA(x) _Pragma (#x)
13221 #define TODO(x) DO_PRAGMA(message ("TODO - " #x))
13222
13223 TODO(Remember to fix this)
13224 @end smallexample
13225
13226 prints @samp{/tmp/file.c:4: note: #pragma message:
13227 TODO - Remember to fix this}.
13228
13229 @end table
13230
13231 @node Visibility Pragmas
13232 @subsection Visibility Pragmas
13233
13234 @table @code
13235 @item #pragma GCC visibility push(@var{visibility})
13236 @itemx #pragma GCC visibility pop
13237 @cindex pragma, visibility
13238
13239 This pragma allows the user to set the visibility for multiple
13240 declarations without having to give each a visibility attribute
13241 @xref{Function Attributes}, for more information about visibility and
13242 the attribute syntax.
13243
13244 In C++, @samp{#pragma GCC visibility} affects only namespace-scope
13245 declarations.  Class members and template specializations are not
13246 affected; if you want to override the visibility for a particular
13247 member or instantiation, you must use an attribute.
13248
13249 @end table
13250
13251
13252 @node Push/Pop Macro Pragmas
13253 @subsection Push/Pop Macro Pragmas
13254
13255 For compatibility with Microsoft Windows compilers, GCC supports
13256 @samp{#pragma push_macro(@var{"macro_name"})}
13257 and @samp{#pragma pop_macro(@var{"macro_name"})}.
13258
13259 @table @code
13260 @item #pragma push_macro(@var{"macro_name"})
13261 @cindex pragma, push_macro
13262 This pragma saves the value of the macro named as @var{macro_name} to
13263 the top of the stack for this macro.
13264
13265 @item #pragma pop_macro(@var{"macro_name"})
13266 @cindex pragma, pop_macro
13267 This pragma sets the value of the macro named as @var{macro_name} to
13268 the value on top of the stack for this macro. If the stack for
13269 @var{macro_name} is empty, the value of the macro remains unchanged.
13270 @end table
13271
13272 For example:
13273
13274 @smallexample
13275 #define X  1
13276 #pragma push_macro("X")
13277 #undef X
13278 #define X -1
13279 #pragma pop_macro("X")
13280 int x [X];
13281 @end smallexample
13282
13283 In this example, the definition of X as 1 is saved by @code{#pragma
13284 push_macro} and restored by @code{#pragma pop_macro}.
13285
13286 @node Function Specific Option Pragmas
13287 @subsection Function Specific Option Pragmas
13288
13289 @table @code
13290 @item #pragma GCC target (@var{"string"}...)
13291 @cindex pragma GCC target
13292
13293 This pragma allows you to set target specific options for functions
13294 defined later in the source file.  One or more strings can be
13295 specified.  Each function that is defined after this point will be as
13296 if @code{attribute((target("STRING")))} was specified for that
13297 function.  The parenthesis around the options is optional.
13298 @xref{Function Attributes}, for more information about the
13299 @code{target} attribute and the attribute syntax.
13300
13301 The @code{#pragma GCC target} attribute is not implemented in GCC versions earlier
13302 than 4.4 for the i386/x86_64 and 4.6 for the PowerPC backends.  At
13303 present, it is not implemented for other backends.
13304 @end table
13305
13306 @table @code
13307 @item #pragma GCC optimize (@var{"string"}...)
13308 @cindex pragma GCC optimize
13309
13310 This pragma allows you to set global optimization options for functions
13311 defined later in the source file.  One or more strings can be
13312 specified.  Each function that is defined after this point will be as
13313 if @code{attribute((optimize("STRING")))} was specified for that
13314 function.  The parenthesis around the options is optional.
13315 @xref{Function Attributes}, for more information about the
13316 @code{optimize} attribute and the attribute syntax.
13317
13318 The @samp{#pragma GCC optimize} pragma is not implemented in GCC
13319 versions earlier than 4.4.
13320 @end table
13321
13322 @table @code
13323 @item #pragma GCC push_options
13324 @itemx #pragma GCC pop_options
13325 @cindex pragma GCC push_options
13326 @cindex pragma GCC pop_options
13327
13328 These pragmas maintain a stack of the current target and optimization
13329 options.  It is intended for include files where you temporarily want
13330 to switch to using a different @samp{#pragma GCC target} or
13331 @samp{#pragma GCC optimize} and then to pop back to the previous
13332 options.
13333
13334 The @samp{#pragma GCC push_options} and @samp{#pragma GCC pop_options}
13335 pragmas are not implemented in GCC versions earlier than 4.4.
13336 @end table
13337
13338 @table @code
13339 @item #pragma GCC reset_options
13340 @cindex pragma GCC reset_options
13341
13342 This pragma clears the current @code{#pragma GCC target} and
13343 @code{#pragma GCC optimize} to use the default switches as specified
13344 on the command line.
13345
13346 The @samp{#pragma GCC reset_options} pragma is not implemented in GCC
13347 versions earlier than 4.4.
13348 @end table
13349
13350 @node Unnamed Fields
13351 @section Unnamed struct/union fields within structs/unions
13352 @cindex @code{struct}
13353 @cindex @code{union}
13354
13355 As permitted by ISO C1X and for compatibility with other compilers,
13356 GCC allows you to define
13357 a structure or union that contains, as fields, structures and unions
13358 without names.  For example:
13359
13360 @smallexample
13361 struct @{
13362   int a;
13363   union @{
13364     int b;
13365     float c;
13366   @};
13367   int d;
13368 @} foo;
13369 @end smallexample
13370
13371 In this example, the user would be able to access members of the unnamed
13372 union with code like @samp{foo.b}.  Note that only unnamed structs and
13373 unions are allowed, you may not have, for example, an unnamed
13374 @code{int}.
13375
13376 You must never create such structures that cause ambiguous field definitions.
13377 For example, this structure:
13378
13379 @smallexample
13380 struct @{
13381   int a;
13382   struct @{
13383     int a;
13384   @};
13385 @} foo;
13386 @end smallexample
13387
13388 It is ambiguous which @code{a} is being referred to with @samp{foo.a}.
13389 The compiler gives errors for such constructs.
13390
13391 @opindex fms-extensions
13392 Unless @option{-fms-extensions} is used, the unnamed field must be a
13393 structure or union definition without a tag (for example, @samp{struct
13394 @{ int a; @};}).  If @option{-fms-extensions} is used, the field may
13395 also be a definition with a tag such as @samp{struct foo @{ int a;
13396 @};}, a reference to a previously defined structure or union such as
13397 @samp{struct foo;}, or a reference to a @code{typedef} name for a
13398 previously defined structure or union type.
13399
13400 @opindex fplan9-extensions
13401 The option @option{-fplan9-extensions} enables
13402 @option{-fms-extensions} as well as two other extensions.  First, a
13403 pointer to a structure is automatically converted to a pointer to an
13404 anonymous field for assignments and function calls.  For example:
13405
13406 @smallexample
13407 struct s1 @{ int a; @};
13408 struct s2 @{ struct s1; @};
13409 extern void f1 (struct s1 *);
13410 void f2 (struct s2 *p) @{ f1 (p); @}
13411 @end smallexample
13412
13413 In the call to @code{f1} inside @code{f2}, the pointer @code{p} is
13414 converted into a pointer to the anonymous field.
13415
13416 Second, when the type of an anonymous field is a @code{typedef} for a
13417 @code{struct} or @code{union}, code may refer to the field using the
13418 name of the @code{typedef}.
13419
13420 @smallexample
13421 typedef struct @{ int a; @} s1;
13422 struct s2 @{ s1; @};
13423 s1 f1 (struct s2 *p) @{ return p->s1; @}
13424 @end smallexample
13425
13426 These usages are only permitted when they are not ambiguous.
13427
13428 @node Thread-Local
13429 @section Thread-Local Storage
13430 @cindex Thread-Local Storage
13431 @cindex @acronym{TLS}
13432 @cindex @code{__thread}
13433
13434 Thread-local storage (@acronym{TLS}) is a mechanism by which variables
13435 are allocated such that there is one instance of the variable per extant
13436 thread.  The run-time model GCC uses to implement this originates
13437 in the IA-64 processor-specific ABI, but has since been migrated
13438 to other processors as well.  It requires significant support from
13439 the linker (@command{ld}), dynamic linker (@command{ld.so}), and
13440 system libraries (@file{libc.so} and @file{libpthread.so}), so it
13441 is not available everywhere.
13442
13443 At the user level, the extension is visible with a new storage
13444 class keyword: @code{__thread}.  For example:
13445
13446 @smallexample
13447 __thread int i;
13448 extern __thread struct state s;
13449 static __thread char *p;
13450 @end smallexample
13451
13452 The @code{__thread} specifier may be used alone, with the @code{extern}
13453 or @code{static} specifiers, but with no other storage class specifier.
13454 When used with @code{extern} or @code{static}, @code{__thread} must appear
13455 immediately after the other storage class specifier.
13456
13457 The @code{__thread} specifier may be applied to any global, file-scoped
13458 static, function-scoped static, or static data member of a class.  It may
13459 not be applied to block-scoped automatic or non-static data member.
13460
13461 When the address-of operator is applied to a thread-local variable, it is
13462 evaluated at run-time and returns the address of the current thread's
13463 instance of that variable.  An address so obtained may be used by any
13464 thread.  When a thread terminates, any pointers to thread-local variables
13465 in that thread become invalid.
13466
13467 No static initialization may refer to the address of a thread-local variable.
13468
13469 In C++, if an initializer is present for a thread-local variable, it must
13470 be a @var{constant-expression}, as defined in 5.19.2 of the ANSI/ISO C++
13471 standard.
13472
13473 See @uref{http://www.akkadia.org/drepper/tls.pdf,
13474 ELF Handling For Thread-Local Storage} for a detailed explanation of
13475 the four thread-local storage addressing models, and how the run-time
13476 is expected to function.
13477
13478 @menu
13479 * C99 Thread-Local Edits::
13480 * C++98 Thread-Local Edits::
13481 @end menu
13482
13483 @node C99 Thread-Local Edits
13484 @subsection ISO/IEC 9899:1999 Edits for Thread-Local Storage
13485
13486 The following are a set of changes to ISO/IEC 9899:1999 (aka C99)
13487 that document the exact semantics of the language extension.
13488
13489 @itemize @bullet
13490 @item
13491 @cite{5.1.2  Execution environments}
13492
13493 Add new text after paragraph 1
13494
13495 @quotation
13496 Within either execution environment, a @dfn{thread} is a flow of
13497 control within a program.  It is implementation defined whether
13498 or not there may be more than one thread associated with a program.
13499 It is implementation defined how threads beyond the first are
13500 created, the name and type of the function called at thread
13501 startup, and how threads may be terminated.  However, objects
13502 with thread storage duration shall be initialized before thread
13503 startup.
13504 @end quotation
13505
13506 @item
13507 @cite{6.2.4  Storage durations of objects}
13508
13509 Add new text before paragraph 3
13510
13511 @quotation
13512 An object whose identifier is declared with the storage-class
13513 specifier @w{@code{__thread}} has @dfn{thread storage duration}.
13514 Its lifetime is the entire execution of the thread, and its
13515 stored value is initialized only once, prior to thread startup.
13516 @end quotation
13517
13518 @item
13519 @cite{6.4.1  Keywords}
13520
13521 Add @code{__thread}.
13522
13523 @item
13524 @cite{6.7.1  Storage-class specifiers}
13525
13526 Add @code{__thread} to the list of storage class specifiers in
13527 paragraph 1.
13528
13529 Change paragraph 2 to
13530
13531 @quotation
13532 With the exception of @code{__thread}, at most one storage-class
13533 specifier may be given [@dots{}].  The @code{__thread} specifier may
13534 be used alone, or immediately following @code{extern} or
13535 @code{static}.
13536 @end quotation
13537
13538 Add new text after paragraph 6
13539
13540 @quotation
13541 The declaration of an identifier for a variable that has
13542 block scope that specifies @code{__thread} shall also
13543 specify either @code{extern} or @code{static}.
13544
13545 The @code{__thread} specifier shall be used only with
13546 variables.
13547 @end quotation
13548 @end itemize
13549
13550 @node C++98 Thread-Local Edits
13551 @subsection ISO/IEC 14882:1998 Edits for Thread-Local Storage
13552
13553 The following are a set of changes to ISO/IEC 14882:1998 (aka C++98)
13554 that document the exact semantics of the language extension.
13555
13556 @itemize @bullet
13557 @item
13558 @b{[intro.execution]}
13559
13560 New text after paragraph 4
13561
13562 @quotation
13563 A @dfn{thread} is a flow of control within the abstract machine.
13564 It is implementation defined whether or not there may be more than
13565 one thread.
13566 @end quotation
13567
13568 New text after paragraph 7
13569
13570 @quotation
13571 It is unspecified whether additional action must be taken to
13572 ensure when and whether side effects are visible to other threads.
13573 @end quotation
13574
13575 @item
13576 @b{[lex.key]}
13577
13578 Add @code{__thread}.
13579
13580 @item
13581 @b{[basic.start.main]}
13582
13583 Add after paragraph 5
13584
13585 @quotation
13586 The thread that begins execution at the @code{main} function is called
13587 the @dfn{main thread}.  It is implementation defined how functions
13588 beginning threads other than the main thread are designated or typed.
13589 A function so designated, as well as the @code{main} function, is called
13590 a @dfn{thread startup function}.  It is implementation defined what
13591 happens if a thread startup function returns.  It is implementation
13592 defined what happens to other threads when any thread calls @code{exit}.
13593 @end quotation
13594
13595 @item
13596 @b{[basic.start.init]}
13597
13598 Add after paragraph 4
13599
13600 @quotation
13601 The storage for an object of thread storage duration shall be
13602 statically initialized before the first statement of the thread startup
13603 function.  An object of thread storage duration shall not require
13604 dynamic initialization.
13605 @end quotation
13606
13607 @item
13608 @b{[basic.start.term]}
13609
13610 Add after paragraph 3
13611
13612 @quotation
13613 The type of an object with thread storage duration shall not have a
13614 non-trivial destructor, nor shall it be an array type whose elements
13615 (directly or indirectly) have non-trivial destructors.
13616 @end quotation
13617
13618 @item
13619 @b{[basic.stc]}
13620
13621 Add ``thread storage duration'' to the list in paragraph 1.
13622
13623 Change paragraph 2
13624
13625 @quotation
13626 Thread, static, and automatic storage durations are associated with
13627 objects introduced by declarations [@dots{}].
13628 @end quotation
13629
13630 Add @code{__thread} to the list of specifiers in paragraph 3.
13631
13632 @item
13633 @b{[basic.stc.thread]}
13634
13635 New section before @b{[basic.stc.static]}
13636
13637 @quotation
13638 The keyword @code{__thread} applied to a non-local object gives the
13639 object thread storage duration.
13640
13641 A local variable or class data member declared both @code{static}
13642 and @code{__thread} gives the variable or member thread storage
13643 duration.
13644 @end quotation
13645
13646 @item
13647 @b{[basic.stc.static]}
13648
13649 Change paragraph 1
13650
13651 @quotation
13652 All objects which have neither thread storage duration, dynamic
13653 storage duration nor are local [@dots{}].
13654 @end quotation
13655
13656 @item
13657 @b{[dcl.stc]}
13658
13659 Add @code{__thread} to the list in paragraph 1.
13660
13661 Change paragraph 1
13662
13663 @quotation
13664 With the exception of @code{__thread}, at most one
13665 @var{storage-class-specifier} shall appear in a given
13666 @var{decl-specifier-seq}.  The @code{__thread} specifier may
13667 be used alone, or immediately following the @code{extern} or
13668 @code{static} specifiers.  [@dots{}]
13669 @end quotation
13670
13671 Add after paragraph 5
13672
13673 @quotation
13674 The @code{__thread} specifier can be applied only to the names of objects
13675 and to anonymous unions.
13676 @end quotation
13677
13678 @item
13679 @b{[class.mem]}
13680
13681 Add after paragraph 6
13682
13683 @quotation
13684 Non-@code{static} members shall not be @code{__thread}.
13685 @end quotation
13686 @end itemize
13687
13688 @node Binary constants
13689 @section Binary constants using the @samp{0b} prefix
13690 @cindex Binary constants using the @samp{0b} prefix
13691
13692 Integer constants can be written as binary constants, consisting of a
13693 sequence of @samp{0} and @samp{1} digits, prefixed by @samp{0b} or
13694 @samp{0B}.  This is particularly useful in environments that operate a
13695 lot on the bit-level (like microcontrollers).
13696
13697 The following statements are identical:
13698
13699 @smallexample
13700 i =       42;
13701 i =     0x2a;
13702 i =      052;
13703 i = 0b101010;
13704 @end smallexample
13705
13706 The type of these constants follows the same rules as for octal or
13707 hexadecimal integer constants, so suffixes like @samp{L} or @samp{UL}
13708 can be applied.
13709
13710 @node C++ Extensions
13711 @chapter Extensions to the C++ Language
13712 @cindex extensions, C++ language
13713 @cindex C++ language extensions
13714
13715 The GNU compiler provides these extensions to the C++ language (and you
13716 can also use most of the C language extensions in your C++ programs).  If you
13717 want to write code that checks whether these features are available, you can
13718 test for the GNU compiler the same way as for C programs: check for a
13719 predefined macro @code{__GNUC__}.  You can also use @code{__GNUG__} to
13720 test specifically for GNU C++ (@pxref{Common Predefined Macros,,
13721 Predefined Macros,cpp,The GNU C Preprocessor}).
13722
13723 @menu
13724 * C++ Volatiles::       What constitutes an access to a volatile object.
13725 * Restricted Pointers:: C99 restricted pointers and references.
13726 * Vague Linkage::       Where G++ puts inlines, vtables and such.
13727 * C++ Interface::       You can use a single C++ header file for both
13728                         declarations and definitions.
13729 * Template Instantiation:: Methods for ensuring that exactly one copy of
13730                         each needed template instantiation is emitted.
13731 * Bound member functions:: You can extract a function pointer to the
13732                         method denoted by a @samp{->*} or @samp{.*} expression.
13733 * C++ Attributes::      Variable, function, and type attributes for C++ only.
13734 * Namespace Association:: Strong using-directives for namespace association.
13735 * Type Traits::         Compiler support for type traits
13736 * Java Exceptions::     Tweaking exception handling to work with Java.
13737 * Deprecated Features:: Things will disappear from g++.
13738 * Backwards Compatibility:: Compatibilities with earlier definitions of C++.
13739 @end menu
13740
13741 @node C++ Volatiles
13742 @section When is a Volatile C++ Object Accessed?
13743 @cindex accessing volatiles
13744 @cindex volatile read
13745 @cindex volatile write
13746 @cindex volatile access
13747
13748 The C++ standard differs from the C standard in its treatment of
13749 volatile objects.  It fails to specify what constitutes a volatile
13750 access, except to say that C++ should behave in a similar manner to C
13751 with respect to volatiles, where possible.  However, the different
13752 lvalueness of expressions between C and C++ complicate the behavior.
13753 G++ behaves the same as GCC for volatile access, @xref{C
13754 Extensions,,Volatiles}, for a description of GCC's behavior.
13755
13756 The C and C++ language specifications differ when an object is
13757 accessed in a void context:
13758
13759 @smallexample
13760 volatile int *src = @var{somevalue};
13761 *src;
13762 @end smallexample
13763
13764 The C++ standard specifies that such expressions do not undergo lvalue
13765 to rvalue conversion, and that the type of the dereferenced object may
13766 be incomplete.  The C++ standard does not specify explicitly that it
13767 is lvalue to rvalue conversion which is responsible for causing an
13768 access.  There is reason to believe that it is, because otherwise
13769 certain simple expressions become undefined.  However, because it
13770 would surprise most programmers, G++ treats dereferencing a pointer to
13771 volatile object of complete type as GCC would do for an equivalent
13772 type in C@.  When the object has incomplete type, G++ issues a
13773 warning; if you wish to force an error, you must force a conversion to
13774 rvalue with, for instance, a static cast.
13775
13776 When using a reference to volatile, G++ does not treat equivalent
13777 expressions as accesses to volatiles, but instead issues a warning that
13778 no volatile is accessed.  The rationale for this is that otherwise it
13779 becomes difficult to determine where volatile access occur, and not
13780 possible to ignore the return value from functions returning volatile
13781 references.  Again, if you wish to force a read, cast the reference to
13782 an rvalue.
13783
13784 G++ implements the same behavior as GCC does when assigning to a
13785 volatile object -- there is no reread of the assigned-to object, the
13786 assigned rvalue is reused.  Note that in C++ assignment expressions
13787 are lvalues, and if used as an lvalue, the volatile object will be
13788 referred to.  For instance, @var{vref} will refer to @var{vobj}, as
13789 expected, in the following example:
13790
13791 @smallexample
13792 volatile int vobj;
13793 volatile int &vref = vobj = @var{something};
13794 @end smallexample
13795
13796 @node Restricted Pointers
13797 @section Restricting Pointer Aliasing
13798 @cindex restricted pointers
13799 @cindex restricted references
13800 @cindex restricted this pointer
13801
13802 As with the C front end, G++ understands the C99 feature of restricted pointers,
13803 specified with the @code{__restrict__}, or @code{__restrict} type
13804 qualifier.  Because you cannot compile C++ by specifying the @option{-std=c99}
13805 language flag, @code{restrict} is not a keyword in C++.
13806
13807 In addition to allowing restricted pointers, you can specify restricted
13808 references, which indicate that the reference is not aliased in the local
13809 context.
13810
13811 @smallexample
13812 void fn (int *__restrict__ rptr, int &__restrict__ rref)
13813 @{
13814   /* @r{@dots{}} */
13815 @}
13816 @end smallexample
13817
13818 @noindent
13819 In the body of @code{fn}, @var{rptr} points to an unaliased integer and
13820 @var{rref} refers to a (different) unaliased integer.
13821
13822 You may also specify whether a member function's @var{this} pointer is
13823 unaliased by using @code{__restrict__} as a member function qualifier.
13824
13825 @smallexample
13826 void T::fn () __restrict__
13827 @{
13828   /* @r{@dots{}} */
13829 @}
13830 @end smallexample
13831
13832 @noindent
13833 Within the body of @code{T::fn}, @var{this} will have the effective
13834 definition @code{T *__restrict__ const this}.  Notice that the
13835 interpretation of a @code{__restrict__} member function qualifier is
13836 different to that of @code{const} or @code{volatile} qualifier, in that it
13837 is applied to the pointer rather than the object.  This is consistent with
13838 other compilers which implement restricted pointers.
13839
13840 As with all outermost parameter qualifiers, @code{__restrict__} is
13841 ignored in function definition matching.  This means you only need to
13842 specify @code{__restrict__} in a function definition, rather than
13843 in a function prototype as well.
13844
13845 @node Vague Linkage
13846 @section Vague Linkage
13847 @cindex vague linkage
13848
13849 There are several constructs in C++ which require space in the object
13850 file but are not clearly tied to a single translation unit.  We say that
13851 these constructs have ``vague linkage''.  Typically such constructs are
13852 emitted wherever they are needed, though sometimes we can be more
13853 clever.
13854
13855 @table @asis
13856 @item Inline Functions
13857 Inline functions are typically defined in a header file which can be
13858 included in many different compilations.  Hopefully they can usually be
13859 inlined, but sometimes an out-of-line copy is necessary, if the address
13860 of the function is taken or if inlining fails.  In general, we emit an
13861 out-of-line copy in all translation units where one is needed.  As an
13862 exception, we only emit inline virtual functions with the vtable, since
13863 it will always require a copy.
13864
13865 Local static variables and string constants used in an inline function
13866 are also considered to have vague linkage, since they must be shared
13867 between all inlined and out-of-line instances of the function.
13868
13869 @item VTables
13870 @cindex vtable
13871 C++ virtual functions are implemented in most compilers using a lookup
13872 table, known as a vtable.  The vtable contains pointers to the virtual
13873 functions provided by a class, and each object of the class contains a
13874 pointer to its vtable (or vtables, in some multiple-inheritance
13875 situations).  If the class declares any non-inline, non-pure virtual
13876 functions, the first one is chosen as the ``key method'' for the class,
13877 and the vtable is only emitted in the translation unit where the key
13878 method is defined.
13879
13880 @emph{Note:} If the chosen key method is later defined as inline, the
13881 vtable will still be emitted in every translation unit which defines it.
13882 Make sure that any inline virtuals are declared inline in the class
13883 body, even if they are not defined there.
13884
13885 @item @code{type_info} objects
13886 @cindex @code{type_info}
13887 @cindex RTTI
13888 C++ requires information about types to be written out in order to
13889 implement @samp{dynamic_cast}, @samp{typeid} and exception handling.
13890 For polymorphic classes (classes with virtual functions), the @samp{type_info}
13891 object is written out along with the vtable so that @samp{dynamic_cast}
13892 can determine the dynamic type of a class object at runtime.  For all
13893 other types, we write out the @samp{type_info} object when it is used: when
13894 applying @samp{typeid} to an expression, throwing an object, or
13895 referring to a type in a catch clause or exception specification.
13896
13897 @item Template Instantiations
13898 Most everything in this section also applies to template instantiations,
13899 but there are other options as well.
13900 @xref{Template Instantiation,,Where's the Template?}.
13901
13902 @end table
13903
13904 When used with GNU ld version 2.8 or later on an ELF system such as
13905 GNU/Linux or Solaris 2, or on Microsoft Windows, duplicate copies of
13906 these constructs will be discarded at link time.  This is known as
13907 COMDAT support.
13908
13909 On targets that don't support COMDAT, but do support weak symbols, GCC
13910 will use them.  This way one copy will override all the others, but
13911 the unused copies will still take up space in the executable.
13912
13913 For targets which do not support either COMDAT or weak symbols,
13914 most entities with vague linkage will be emitted as local symbols to
13915 avoid duplicate definition errors from the linker.  This will not happen
13916 for local statics in inlines, however, as having multiple copies will
13917 almost certainly break things.
13918
13919 @xref{C++ Interface,,Declarations and Definitions in One Header}, for
13920 another way to control placement of these constructs.
13921
13922 @node C++ Interface
13923 @section #pragma interface and implementation
13924
13925 @cindex interface and implementation headers, C++
13926 @cindex C++ interface and implementation headers
13927 @cindex pragmas, interface and implementation
13928
13929 @code{#pragma interface} and @code{#pragma implementation} provide the
13930 user with a way of explicitly directing the compiler to emit entities
13931 with vague linkage (and debugging information) in a particular
13932 translation unit.
13933
13934 @emph{Note:} As of GCC 2.7.2, these @code{#pragma}s are not useful in
13935 most cases, because of COMDAT support and the ``key method'' heuristic
13936 mentioned in @ref{Vague Linkage}.  Using them can actually cause your
13937 program to grow due to unnecessary out-of-line copies of inline
13938 functions.  Currently (3.4) the only benefit of these
13939 @code{#pragma}s is reduced duplication of debugging information, and
13940 that should be addressed soon on DWARF 2 targets with the use of
13941 COMDAT groups.
13942
13943 @table @code
13944 @item #pragma interface
13945 @itemx #pragma interface "@var{subdir}/@var{objects}.h"
13946 @kindex #pragma interface
13947 Use this directive in @emph{header files} that define object classes, to save
13948 space in most of the object files that use those classes.  Normally,
13949 local copies of certain information (backup copies of inline member
13950 functions, debugging information, and the internal tables that implement
13951 virtual functions) must be kept in each object file that includes class
13952 definitions.  You can use this pragma to avoid such duplication.  When a
13953 header file containing @samp{#pragma interface} is included in a
13954 compilation, this auxiliary information will not be generated (unless
13955 the main input source file itself uses @samp{#pragma implementation}).
13956 Instead, the object files will contain references to be resolved at link
13957 time.
13958
13959 The second form of this directive is useful for the case where you have
13960 multiple headers with the same name in different directories.  If you
13961 use this form, you must specify the same string to @samp{#pragma
13962 implementation}.
13963
13964 @item #pragma implementation
13965 @itemx #pragma implementation "@var{objects}.h"
13966 @kindex #pragma implementation
13967 Use this pragma in a @emph{main input file}, when you want full output from
13968 included header files to be generated (and made globally visible).  The
13969 included header file, in turn, should use @samp{#pragma interface}.
13970 Backup copies of inline member functions, debugging information, and the
13971 internal tables used to implement virtual functions are all generated in
13972 implementation files.
13973
13974 @cindex implied @code{#pragma implementation}
13975 @cindex @code{#pragma implementation}, implied
13976 @cindex naming convention, implementation headers
13977 If you use @samp{#pragma implementation} with no argument, it applies to
13978 an include file with the same basename@footnote{A file's @dfn{basename}
13979 was the name stripped of all leading path information and of trailing
13980 suffixes, such as @samp{.h} or @samp{.C} or @samp{.cc}.} as your source
13981 file.  For example, in @file{allclass.cc}, giving just
13982 @samp{#pragma implementation}
13983 by itself is equivalent to @samp{#pragma implementation "allclass.h"}.
13984
13985 In versions of GNU C++ prior to 2.6.0 @file{allclass.h} was treated as
13986 an implementation file whenever you would include it from
13987 @file{allclass.cc} even if you never specified @samp{#pragma
13988 implementation}.  This was deemed to be more trouble than it was worth,
13989 however, and disabled.
13990
13991 Use the string argument if you want a single implementation file to
13992 include code from multiple header files.  (You must also use
13993 @samp{#include} to include the header file; @samp{#pragma
13994 implementation} only specifies how to use the file---it doesn't actually
13995 include it.)
13996
13997 There is no way to split up the contents of a single header file into
13998 multiple implementation files.
13999 @end table
14000
14001 @cindex inlining and C++ pragmas
14002 @cindex C++ pragmas, effect on inlining
14003 @cindex pragmas in C++, effect on inlining
14004 @samp{#pragma implementation} and @samp{#pragma interface} also have an
14005 effect on function inlining.
14006
14007 If you define a class in a header file marked with @samp{#pragma
14008 interface}, the effect on an inline function defined in that class is
14009 similar to an explicit @code{extern} declaration---the compiler emits
14010 no code at all to define an independent version of the function.  Its
14011 definition is used only for inlining with its callers.
14012
14013 @opindex fno-implement-inlines
14014 Conversely, when you include the same header file in a main source file
14015 that declares it as @samp{#pragma implementation}, the compiler emits
14016 code for the function itself; this defines a version of the function
14017 that can be found via pointers (or by callers compiled without
14018 inlining).  If all calls to the function can be inlined, you can avoid
14019 emitting the function by compiling with @option{-fno-implement-inlines}.
14020 If any calls were not inlined, you will get linker errors.
14021
14022 @node Template Instantiation
14023 @section Where's the Template?
14024 @cindex template instantiation
14025
14026 C++ templates are the first language feature to require more
14027 intelligence from the environment than one usually finds on a UNIX
14028 system.  Somehow the compiler and linker have to make sure that each
14029 template instance occurs exactly once in the executable if it is needed,
14030 and not at all otherwise.  There are two basic approaches to this
14031 problem, which are referred to as the Borland model and the Cfront model.
14032
14033 @table @asis
14034 @item Borland model
14035 Borland C++ solved the template instantiation problem by adding the code
14036 equivalent of common blocks to their linker; the compiler emits template
14037 instances in each translation unit that uses them, and the linker
14038 collapses them together.  The advantage of this model is that the linker
14039 only has to consider the object files themselves; there is no external
14040 complexity to worry about.  This disadvantage is that compilation time
14041 is increased because the template code is being compiled repeatedly.
14042 Code written for this model tends to include definitions of all
14043 templates in the header file, since they must be seen to be
14044 instantiated.
14045
14046 @item Cfront model
14047 The AT&T C++ translator, Cfront, solved the template instantiation
14048 problem by creating the notion of a template repository, an
14049 automatically maintained place where template instances are stored.  A
14050 more modern version of the repository works as follows: As individual
14051 object files are built, the compiler places any template definitions and
14052 instantiations encountered in the repository.  At link time, the link
14053 wrapper adds in the objects in the repository and compiles any needed
14054 instances that were not previously emitted.  The advantages of this
14055 model are more optimal compilation speed and the ability to use the
14056 system linker; to implement the Borland model a compiler vendor also
14057 needs to replace the linker.  The disadvantages are vastly increased
14058 complexity, and thus potential for error; for some code this can be
14059 just as transparent, but in practice it can been very difficult to build
14060 multiple programs in one directory and one program in multiple
14061 directories.  Code written for this model tends to separate definitions
14062 of non-inline member templates into a separate file, which should be
14063 compiled separately.
14064 @end table
14065
14066 When used with GNU ld version 2.8 or later on an ELF system such as
14067 GNU/Linux or Solaris 2, or on Microsoft Windows, G++ supports the
14068 Borland model.  On other systems, G++ implements neither automatic
14069 model.
14070
14071 A future version of G++ will support a hybrid model whereby the compiler
14072 will emit any instantiations for which the template definition is
14073 included in the compile, and store template definitions and
14074 instantiation context information into the object file for the rest.
14075 The link wrapper will extract that information as necessary and invoke
14076 the compiler to produce the remaining instantiations.  The linker will
14077 then combine duplicate instantiations.
14078
14079 In the mean time, you have the following options for dealing with
14080 template instantiations:
14081
14082 @enumerate
14083 @item
14084 @opindex frepo
14085 Compile your template-using code with @option{-frepo}.  The compiler will
14086 generate files with the extension @samp{.rpo} listing all of the
14087 template instantiations used in the corresponding object files which
14088 could be instantiated there; the link wrapper, @samp{collect2}, will
14089 then update the @samp{.rpo} files to tell the compiler where to place
14090 those instantiations and rebuild any affected object files.  The
14091 link-time overhead is negligible after the first pass, as the compiler
14092 will continue to place the instantiations in the same files.
14093
14094 This is your best option for application code written for the Borland
14095 model, as it will just work.  Code written for the Cfront model will
14096 need to be modified so that the template definitions are available at
14097 one or more points of instantiation; usually this is as simple as adding
14098 @code{#include <tmethods.cc>} to the end of each template header.
14099
14100 For library code, if you want the library to provide all of the template
14101 instantiations it needs, just try to link all of its object files
14102 together; the link will fail, but cause the instantiations to be
14103 generated as a side effect.  Be warned, however, that this may cause
14104 conflicts if multiple libraries try to provide the same instantiations.
14105 For greater control, use explicit instantiation as described in the next
14106 option.
14107
14108 @item
14109 @opindex fno-implicit-templates
14110 Compile your code with @option{-fno-implicit-templates} to disable the
14111 implicit generation of template instances, and explicitly instantiate
14112 all the ones you use.  This approach requires more knowledge of exactly
14113 which instances you need than do the others, but it's less
14114 mysterious and allows greater control.  You can scatter the explicit
14115 instantiations throughout your program, perhaps putting them in the
14116 translation units where the instances are used or the translation units
14117 that define the templates themselves; you can put all of the explicit
14118 instantiations you need into one big file; or you can create small files
14119 like
14120
14121 @smallexample
14122 #include "Foo.h"
14123 #include "Foo.cc"
14124
14125 template class Foo<int>;
14126 template ostream& operator <<
14127                 (ostream&, const Foo<int>&);
14128 @end smallexample
14129
14130 for each of the instances you need, and create a template instantiation
14131 library from those.
14132
14133 If you are using Cfront-model code, you can probably get away with not
14134 using @option{-fno-implicit-templates} when compiling files that don't
14135 @samp{#include} the member template definitions.
14136
14137 If you use one big file to do the instantiations, you may want to
14138 compile it without @option{-fno-implicit-templates} so you get all of the
14139 instances required by your explicit instantiations (but not by any
14140 other files) without having to specify them as well.
14141
14142 G++ has extended the template instantiation syntax given in the ISO
14143 standard to allow forward declaration of explicit instantiations
14144 (with @code{extern}), instantiation of the compiler support data for a
14145 template class (i.e.@: the vtable) without instantiating any of its
14146 members (with @code{inline}), and instantiation of only the static data
14147 members of a template class, without the support data or member
14148 functions (with (@code{static}):
14149
14150 @smallexample
14151 extern template int max (int, int);
14152 inline template class Foo<int>;
14153 static template class Foo<int>;
14154 @end smallexample
14155
14156 @item
14157 Do nothing.  Pretend G++ does implement automatic instantiation
14158 management.  Code written for the Borland model will work fine, but
14159 each translation unit will contain instances of each of the templates it
14160 uses.  In a large program, this can lead to an unacceptable amount of code
14161 duplication.
14162 @end enumerate
14163
14164 @node Bound member functions
14165 @section Extracting the function pointer from a bound pointer to member function
14166 @cindex pmf
14167 @cindex pointer to member function
14168 @cindex bound pointer to member function
14169
14170 In C++, pointer to member functions (PMFs) are implemented using a wide
14171 pointer of sorts to handle all the possible call mechanisms; the PMF
14172 needs to store information about how to adjust the @samp{this} pointer,
14173 and if the function pointed to is virtual, where to find the vtable, and
14174 where in the vtable to look for the member function.  If you are using
14175 PMFs in an inner loop, you should really reconsider that decision.  If
14176 that is not an option, you can extract the pointer to the function that
14177 would be called for a given object/PMF pair and call it directly inside
14178 the inner loop, to save a bit of time.
14179
14180 Note that you will still be paying the penalty for the call through a
14181 function pointer; on most modern architectures, such a call defeats the
14182 branch prediction features of the CPU@.  This is also true of normal
14183 virtual function calls.
14184
14185 The syntax for this extension is
14186
14187 @smallexample
14188 extern A a;
14189 extern int (A::*fp)();
14190 typedef int (*fptr)(A *);
14191
14192 fptr p = (fptr)(a.*fp);
14193 @end smallexample
14194
14195 For PMF constants (i.e.@: expressions of the form @samp{&Klasse::Member}),
14196 no object is needed to obtain the address of the function.  They can be
14197 converted to function pointers directly:
14198
14199 @smallexample
14200 fptr p1 = (fptr)(&A::foo);
14201 @end smallexample
14202
14203 @opindex Wno-pmf-conversions
14204 You must specify @option{-Wno-pmf-conversions} to use this extension.
14205
14206 @node C++ Attributes
14207 @section C++-Specific Variable, Function, and Type Attributes
14208
14209 Some attributes only make sense for C++ programs.
14210
14211 @table @code
14212 @item init_priority (@var{priority})
14213 @cindex @code{init_priority} attribute
14214
14215
14216 In Standard C++, objects defined at namespace scope are guaranteed to be
14217 initialized in an order in strict accordance with that of their definitions
14218 @emph{in a given translation unit}.  No guarantee is made for initializations
14219 across translation units.  However, GNU C++ allows users to control the
14220 order of initialization of objects defined at namespace scope with the
14221 @code{init_priority} attribute by specifying a relative @var{priority},
14222 a constant integral expression currently bounded between 101 and 65535
14223 inclusive.  Lower numbers indicate a higher priority.
14224
14225 In the following example, @code{A} would normally be created before
14226 @code{B}, but the @code{init_priority} attribute has reversed that order:
14227
14228 @smallexample
14229 Some_Class  A  __attribute__ ((init_priority (2000)));
14230 Some_Class  B  __attribute__ ((init_priority (543)));
14231 @end smallexample
14232
14233 @noindent
14234 Note that the particular values of @var{priority} do not matter; only their
14235 relative ordering.
14236
14237 @item java_interface
14238 @cindex @code{java_interface} attribute
14239
14240 This type attribute informs C++ that the class is a Java interface.  It may
14241 only be applied to classes declared within an @code{extern "Java"} block.
14242 Calls to methods declared in this interface will be dispatched using GCJ's
14243 interface table mechanism, instead of regular virtual table dispatch.
14244
14245 @end table
14246
14247 See also @ref{Namespace Association}.
14248
14249 @node Namespace Association
14250 @section Namespace Association
14251
14252 @strong{Caution:} The semantics of this extension are not fully
14253 defined.  Users should refrain from using this extension as its
14254 semantics may change subtly over time.  It is possible that this
14255 extension will be removed in future versions of G++.
14256
14257 A using-directive with @code{__attribute ((strong))} is stronger
14258 than a normal using-directive in two ways:
14259
14260 @itemize @bullet
14261 @item
14262 Templates from the used namespace can be specialized and explicitly
14263 instantiated as though they were members of the using namespace.
14264
14265 @item
14266 The using namespace is considered an associated namespace of all
14267 templates in the used namespace for purposes of argument-dependent
14268 name lookup.
14269 @end itemize
14270
14271 The used namespace must be nested within the using namespace so that
14272 normal unqualified lookup works properly.
14273
14274 This is useful for composing a namespace transparently from
14275 implementation namespaces.  For example:
14276
14277 @smallexample
14278 namespace std @{
14279   namespace debug @{
14280     template <class T> struct A @{ @};
14281   @}
14282   using namespace debug __attribute ((__strong__));
14283   template <> struct A<int> @{ @};   // @r{ok to specialize}
14284
14285   template <class T> void f (A<T>);
14286 @}
14287
14288 int main()
14289 @{
14290   f (std::A<float>());             // @r{lookup finds} std::f
14291   f (std::A<int>());
14292 @}
14293 @end smallexample
14294
14295 @node Type Traits
14296 @section Type Traits
14297
14298 The C++ front-end implements syntactic extensions that allow to
14299 determine at compile time various characteristics of a type (or of a
14300 pair of types).
14301
14302 @table @code
14303 @item __has_nothrow_assign (type)
14304 If @code{type} is const qualified or is a reference type then the trait is
14305 false.  Otherwise if @code{__has_trivial_assign (type)} is true then the trait
14306 is true, else if @code{type} is a cv class or union type with copy assignment
14307 operators that are known not to throw an exception then the trait is true,
14308 else it is false.  Requires: @code{type} shall be a complete type,
14309 (possibly cv-qualified) @code{void}, or an array of unknown bound.
14310
14311 @item __has_nothrow_copy (type)
14312 If @code{__has_trivial_copy (type)} is true then the trait is true, else if
14313 @code{type} is a cv class or union type with copy constructors that
14314 are known not to throw an exception then the trait is true, else it is false.
14315 Requires: @code{type} shall be a complete type, (possibly cv-qualified)
14316 @code{void}, or an array of unknown bound.
14317
14318 @item __has_nothrow_constructor (type)
14319 If @code{__has_trivial_constructor (type)} is true then the trait is
14320 true, else if @code{type} is a cv class or union type (or array
14321 thereof) with a default constructor that is known not to throw an
14322 exception then the trait is true, else it is false.  Requires:
14323 @code{type} shall be a complete type, (possibly cv-qualified)
14324 @code{void}, or an array of unknown bound.
14325
14326 @item __has_trivial_assign (type)
14327 If @code{type} is const qualified or is a reference type then the trait is
14328 false.  Otherwise if @code{__is_pod (type)} is true then the trait is
14329 true, else if @code{type} is a cv class or union type with a trivial
14330 copy assignment ([class.copy]) then the trait is true, else it is
14331 false.  Requires: @code{type} shall be a complete type, (possibly
14332 cv-qualified) @code{void}, or an array of unknown bound.
14333
14334 @item __has_trivial_copy (type)
14335 If @code{__is_pod (type)} is true or @code{type} is a reference type
14336 then the trait is true, else if @code{type} is a cv class or union type
14337 with a trivial copy constructor ([class.copy]) then the trait
14338 is true, else it is false.  Requires: @code{type} shall be a complete
14339 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
14340
14341 @item __has_trivial_constructor (type)
14342 If @code{__is_pod (type)} is true then the trait is true, else if
14343 @code{type} is a cv class or union type (or array thereof) with a
14344 trivial default constructor ([class.ctor]) then the trait is true,
14345 else it is false.  Requires: @code{type} shall be a complete
14346 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
14347
14348 @item __has_trivial_destructor (type)
14349 If @code{__is_pod (type)} is true or @code{type} is a reference type then
14350 the trait is true, else if @code{type} is a cv class or union type (or
14351 array thereof) with a trivial destructor ([class.dtor]) then the trait
14352 is true, else it is false.  Requires: @code{type} shall be a complete
14353 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
14354
14355 @item __has_virtual_destructor (type)
14356 If @code{type} is a class type with a virtual destructor
14357 ([class.dtor]) then the trait is true, else it is false.  Requires:
14358 @code{type} shall be a complete type, (possibly cv-qualified)
14359 @code{void}, or an array of unknown bound.
14360
14361 @item __is_abstract (type)
14362 If @code{type} is an abstract class ([class.abstract]) then the trait
14363 is true, else it is false.  Requires: @code{type} shall be a complete
14364 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
14365
14366 @item __is_base_of (base_type, derived_type)
14367 If @code{base_type} is a base class of @code{derived_type}
14368 ([class.derived]) then the trait is true, otherwise it is false.
14369 Top-level cv qualifications of @code{base_type} and
14370 @code{derived_type} are ignored.  For the purposes of this trait, a
14371 class type is considered is own base.  Requires: if @code{__is_class
14372 (base_type)} and @code{__is_class (derived_type)} are true and
14373 @code{base_type} and @code{derived_type} are not the same type
14374 (disregarding cv-qualifiers), @code{derived_type} shall be a complete
14375 type.  Diagnostic is produced if this requirement is not met.
14376
14377 @item __is_class (type)
14378 If @code{type} is a cv class type, and not a union type
14379 ([basic.compound]) the trait is true, else it is false.
14380
14381 @item __is_empty (type)
14382 If @code{__is_class (type)} is false then the trait is false.
14383 Otherwise @code{type} is considered empty if and only if: @code{type}
14384 has no non-static data members, or all non-static data members, if
14385 any, are bit-fields of length 0, and @code{type} has no virtual
14386 members, and @code{type} has no virtual base classes, and @code{type}
14387 has no base classes @code{base_type} for which
14388 @code{__is_empty (base_type)} is false.  Requires: @code{type} shall
14389 be a complete type, (possibly cv-qualified) @code{void}, or an array
14390 of unknown bound.
14391
14392 @item __is_enum (type)
14393 If @code{type} is a cv enumeration type ([basic.compound]) the trait is
14394 true, else it is false.
14395
14396 @item __is_literal_type (type)
14397 If @code{type} is a literal type ([basic.types]) the trait is
14398 true, else it is false.  Requires: @code{type} shall be a complete type,
14399 (possibly cv-qualified) @code{void}, or an array of unknown bound.
14400
14401 @item __is_pod (type)
14402 If @code{type} is a cv POD type ([basic.types]) then the trait is true,
14403 else it is false.  Requires: @code{type} shall be a complete type,
14404 (possibly cv-qualified) @code{void}, or an array of unknown bound.
14405
14406 @item __is_polymorphic (type)
14407 If @code{type} is a polymorphic class ([class.virtual]) then the trait
14408 is true, else it is false.  Requires: @code{type} shall be a complete
14409 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
14410
14411 @item __is_standard_layout (type)
14412 If @code{type} is a standard-layout type ([basic.types]) the trait is
14413 true, else it is false.  Requires: @code{type} shall be a complete
14414 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
14415
14416 @item __is_trivial (type)
14417 If @code{type} is a trivial type ([basic.types]) the trait is
14418 true, else it is false.  Requires: @code{type} shall be a complete
14419 type, (possibly cv-qualified) @code{void}, or an array of unknown bound.
14420
14421 @item __is_union (type)
14422 If @code{type} is a cv union type ([basic.compound]) the trait is
14423 true, else it is false.
14424
14425 @item __underlying_type (type)
14426 The underlying type of @code{type}.  Requires: @code{type} shall be
14427 an enumeration type ([dcl.enum]).
14428
14429 @end table
14430
14431 @node Java Exceptions
14432 @section Java Exceptions
14433
14434 The Java language uses a slightly different exception handling model
14435 from C++.  Normally, GNU C++ will automatically detect when you are
14436 writing C++ code that uses Java exceptions, and handle them
14437 appropriately.  However, if C++ code only needs to execute destructors
14438 when Java exceptions are thrown through it, GCC will guess incorrectly.
14439 Sample problematic code is:
14440
14441 @smallexample
14442   struct S @{ ~S(); @};
14443   extern void bar();    // @r{is written in Java, and may throw exceptions}
14444   void foo()
14445   @{
14446     S s;
14447     bar();
14448   @}
14449 @end smallexample
14450
14451 @noindent
14452 The usual effect of an incorrect guess is a link failure, complaining of
14453 a missing routine called @samp{__gxx_personality_v0}.
14454
14455 You can inform the compiler that Java exceptions are to be used in a
14456 translation unit, irrespective of what it might think, by writing
14457 @samp{@w{#pragma GCC java_exceptions}} at the head of the file.  This
14458 @samp{#pragma} must appear before any functions that throw or catch
14459 exceptions, or run destructors when exceptions are thrown through them.
14460
14461 You cannot mix Java and C++ exceptions in the same translation unit.  It
14462 is believed to be safe to throw a C++ exception from one file through
14463 another file compiled for the Java exception model, or vice versa, but
14464 there may be bugs in this area.
14465
14466 @node Deprecated Features
14467 @section Deprecated Features
14468
14469 In the past, the GNU C++ compiler was extended to experiment with new
14470 features, at a time when the C++ language was still evolving.  Now that
14471 the C++ standard is complete, some of those features are superseded by
14472 superior alternatives.  Using the old features might cause a warning in
14473 some cases that the feature will be dropped in the future.  In other
14474 cases, the feature might be gone already.
14475
14476 While the list below is not exhaustive, it documents some of the options
14477 that are now deprecated:
14478
14479 @table @code
14480 @item -fexternal-templates
14481 @itemx -falt-external-templates
14482 These are two of the many ways for G++ to implement template
14483 instantiation.  @xref{Template Instantiation}.  The C++ standard clearly
14484 defines how template definitions have to be organized across
14485 implementation units.  G++ has an implicit instantiation mechanism that
14486 should work just fine for standard-conforming code.
14487
14488 @item -fstrict-prototype
14489 @itemx -fno-strict-prototype
14490 Previously it was possible to use an empty prototype parameter list to
14491 indicate an unspecified number of parameters (like C), rather than no
14492 parameters, as C++ demands.  This feature has been removed, except where
14493 it is required for backwards compatibility.   @xref{Backwards Compatibility}.
14494 @end table
14495
14496 G++ allows a virtual function returning @samp{void *} to be overridden
14497 by one returning a different pointer type.  This extension to the
14498 covariant return type rules is now deprecated and will be removed from a
14499 future version.
14500
14501 The G++ minimum and maximum operators (@samp{<?} and @samp{>?}) and
14502 their compound forms (@samp{<?=}) and @samp{>?=}) have been deprecated
14503 and are now removed from G++.  Code using these operators should be
14504 modified to use @code{std::min} and @code{std::max} instead.
14505
14506 The named return value extension has been deprecated, and is now
14507 removed from G++.
14508
14509 The use of initializer lists with new expressions has been deprecated,
14510 and is now removed from G++.
14511
14512 Floating and complex non-type template parameters have been deprecated,
14513 and are now removed from G++.
14514
14515 The implicit typename extension has been deprecated and is now
14516 removed from G++.
14517
14518 The use of default arguments in function pointers, function typedefs
14519 and other places where they are not permitted by the standard is
14520 deprecated and will be removed from a future version of G++.
14521
14522 G++ allows floating-point literals to appear in integral constant expressions,
14523 e.g. @samp{ enum E @{ e = int(2.2 * 3.7) @} }
14524 This extension is deprecated and will be removed from a future version.
14525
14526 G++ allows static data members of const floating-point type to be declared
14527 with an initializer in a class definition. The standard only allows
14528 initializers for static members of const integral types and const
14529 enumeration types so this extension has been deprecated and will be removed
14530 from a future version.
14531
14532 @node Backwards Compatibility
14533 @section Backwards Compatibility
14534 @cindex Backwards Compatibility
14535 @cindex ARM [Annotated C++ Reference Manual]
14536
14537 Now that there is a definitive ISO standard C++, G++ has a specification
14538 to adhere to.  The C++ language evolved over time, and features that
14539 used to be acceptable in previous drafts of the standard, such as the ARM
14540 [Annotated C++ Reference Manual], are no longer accepted.  In order to allow
14541 compilation of C++ written to such drafts, G++ contains some backwards
14542 compatibilities.  @emph{All such backwards compatibility features are
14543 liable to disappear in future versions of G++.} They should be considered
14544 deprecated.   @xref{Deprecated Features}.
14545
14546 @table @code
14547 @item For scope
14548 If a variable is declared at for scope, it used to remain in scope until
14549 the end of the scope which contained the for statement (rather than just
14550 within the for scope).  G++ retains this, but issues a warning, if such a
14551 variable is accessed outside the for scope.
14552
14553 @item Implicit C language
14554 Old C system header files did not contain an @code{extern "C" @{@dots{}@}}
14555 scope to set the language.  On such systems, all header files are
14556 implicitly scoped inside a C language scope.  Also, an empty prototype
14557 @code{()} will be treated as an unspecified number of arguments, rather
14558 than no arguments, as C++ demands.
14559 @end table