OSDN Git Service

PR c/21659
[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
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 Currently, the @code{dllexport} attribute is ignored for inlined
2217 functions, unless the @option{-fkeep-inline-functions} flag has been
2218 used.  The attribute is also ignored for undefined symbols.
2219
2220 When applied to C++ classes, the attribute marks defined non-inlined
2221 member functions and static data members as exports.  Static consts
2222 initialized in-class are not marked unless they are also defined
2223 out-of-class.
2224
2225 For Microsoft Windows targets there are alternative methods for
2226 including the symbol in the DLL's export table such as using a
2227 @file{.def} file with an @code{EXPORTS} section or, with GNU ld, using
2228 the @option{--export-all} linker flag.
2229
2230 @item dllimport
2231 @cindex @code{__declspec(dllimport)}
2232 On Microsoft Windows and Symbian OS targets, the @code{dllimport}
2233 attribute causes the compiler to reference a function or variable via
2234 a global pointer to a pointer that is set up by the DLL exporting the
2235 symbol.  The attribute implies @code{extern}.  On Microsoft Windows
2236 targets, the pointer name is formed by combining @code{_imp__} and the
2237 function or variable name.
2238
2239 You can use @code{__declspec(dllimport)} as a synonym for
2240 @code{__attribute__ ((dllimport))} for compatibility with other
2241 compilers.
2242
2243 On systems that support the @code{visibility} attribute, this
2244 attribute also implies ``default'' visibility.  It is an error to
2245 explicitly specify any other visibility.
2246
2247 Currently, the attribute is ignored for inlined functions.  If the
2248 attribute is applied to a symbol @emph{definition}, an error is reported.
2249 If a symbol previously declared @code{dllimport} is later defined, the
2250 attribute is ignored in subsequent references, and a warning is emitted.
2251 The attribute is also overridden by a subsequent declaration as
2252 @code{dllexport}.
2253
2254 When applied to C++ classes, the attribute marks non-inlined
2255 member functions and static data members as imports.  However, the
2256 attribute is ignored for virtual methods to allow creation of vtables
2257 using thunks.
2258
2259 On the SH Symbian OS target the @code{dllimport} attribute also has
2260 another affect---it can cause the vtable and run-time type information
2261 for a class to be exported.  This happens when the class has a
2262 dllimport'ed constructor or a non-inline, non-pure virtual function
2263 and, for either of those two conditions, the class also has an inline
2264 constructor or destructor and has a key function that is defined in
2265 the current translation unit.
2266
2267 For Microsoft Windows based targets the use of the @code{dllimport}
2268 attribute on functions is not necessary, but provides a small
2269 performance benefit by eliminating a thunk in the DLL@.  The use of the
2270 @code{dllimport} attribute on imported variables was required on older
2271 versions of the GNU linker, but can now be avoided by passing the
2272 @option{--enable-auto-import} switch to the GNU linker.  As with
2273 functions, using the attribute for a variable eliminates a thunk in
2274 the DLL@.
2275
2276 One drawback to using this attribute is that a pointer to a
2277 @emph{variable} marked as @code{dllimport} cannot be used as a constant
2278 address. However, a pointer to a @emph{function} with the
2279 @code{dllimport} attribute can be used as a constant initializer; in
2280 this case, the address of a stub function in the import lib is
2281 referenced.  On Microsoft Windows targets, the attribute can be disabled
2282 for functions by setting the @option{-mnop-fun-dllimport} flag.
2283
2284 @item eightbit_data
2285 @cindex eight bit data on the H8/300, H8/300H, and H8S
2286 Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
2287 variable should be placed into the eight bit data section.
2288 The compiler will generate more efficient code for certain operations
2289 on data in the eight bit data area.  Note the eight bit data area is limited to
2290 256 bytes of data.
2291
2292 You must use GAS and GLD from GNU binutils version 2.7 or later for
2293 this attribute to work correctly.
2294
2295 @item exception_handler
2296 @cindex exception handler functions on the Blackfin processor
2297 Use this attribute on the Blackfin to indicate that the specified function
2298 is an exception handler.  The compiler will generate function entry and
2299 exit sequences suitable for use in an exception handler when this
2300 attribute is present.
2301
2302 @item externally_visible
2303 @cindex @code{externally_visible} attribute.
2304 This attribute, attached to a global variable or function, nullifies
2305 the effect of the @option{-fwhole-program} command-line option, so the
2306 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.
2307
2308 @item far
2309 @cindex functions which handle memory bank switching
2310 On 68HC11 and 68HC12 the @code{far} attribute causes the compiler to
2311 use a calling convention that takes care of switching memory banks when
2312 entering and leaving a function.  This calling convention is also the
2313 default when using the @option{-mlong-calls} option.
2314
2315 On 68HC12 the compiler will use the @code{call} and @code{rtc} instructions
2316 to call and return from a function.
2317
2318 On 68HC11 the compiler will generate a sequence of instructions
2319 to invoke a board-specific routine to switch the memory bank and call the
2320 real function.  The board-specific routine simulates a @code{call}.
2321 At the end of a function, it will jump to a board-specific routine
2322 instead of using @code{rts}.  The board-specific return routine simulates
2323 the @code{rtc}.
2324
2325 On MeP targets this causes the compiler to use a calling convention
2326 which assumes the called function is too far away for the built-in
2327 addressing modes.
2328
2329 @item fast_interrupt
2330 @cindex interrupt handler functions
2331 Use this attribute on the M32C and RX ports to indicate that the specified
2332 function is a fast interrupt handler.  This is just like the
2333 @code{interrupt} attribute, except that @code{freit} is used to return
2334 instead of @code{reit}.
2335
2336 @item fastcall
2337 @cindex functions that pop the argument stack on the 386
2338 On the Intel 386, the @code{fastcall} attribute causes the compiler to
2339 pass the first argument (if of integral type) in the register ECX and
2340 the second argument (if of integral type) in the register EDX@.  Subsequent
2341 and other typed arguments are passed on the stack.  The called function will
2342 pop the arguments off the stack.  If the number of arguments is variable all
2343 arguments are pushed on the stack.
2344
2345 @item thiscall
2346 @cindex functions that pop the argument stack on the 386
2347 On the Intel 386, the @code{thiscall} attribute causes the compiler to
2348 pass the first argument (if of integral type) in the register ECX.
2349 Subsequent and other typed arguments are passed on the stack. The called
2350 function will pop the arguments off the stack.
2351 If the number of arguments is variable all arguments are pushed on the
2352 stack.
2353 The @code{thiscall} attribute is intended for C++ non-static member functions.
2354 As gcc extension this calling convention can be used for C-functions
2355 and for static member methods.
2356
2357 @item format (@var{archetype}, @var{string-index}, @var{first-to-check})
2358 @cindex @code{format} function attribute
2359 @opindex Wformat
2360 The @code{format} attribute specifies that a function takes @code{printf},
2361 @code{scanf}, @code{strftime} or @code{strfmon} style arguments which
2362 should be type-checked against a format string.  For example, the
2363 declaration:
2364
2365 @smallexample
2366 extern int
2367 my_printf (void *my_object, const char *my_format, ...)
2368       __attribute__ ((format (printf, 2, 3)));
2369 @end smallexample
2370
2371 @noindent
2372 causes the compiler to check the arguments in calls to @code{my_printf}
2373 for consistency with the @code{printf} style format string argument
2374 @code{my_format}.
2375
2376 The parameter @var{archetype} determines how the format string is
2377 interpreted, and should be @code{printf}, @code{scanf}, @code{strftime},
2378 @code{gnu_printf}, @code{gnu_scanf}, @code{gnu_strftime} or
2379 @code{strfmon}.  (You can also use @code{__printf__},
2380 @code{__scanf__}, @code{__strftime__} or @code{__strfmon__}.)  On
2381 MinGW targets, @code{ms_printf}, @code{ms_scanf}, and
2382 @code{ms_strftime} are also present.
2383 @var{archtype} values such as @code{printf} refer to the formats accepted
2384 by the system's C run-time library, while @code{gnu_} values always refer
2385 to the formats accepted by the GNU C Library.  On Microsoft Windows
2386 targets, @code{ms_} values refer to the formats accepted by the
2387 @file{msvcrt.dll} library.
2388 The parameter @var{string-index}
2389 specifies which argument is the format string argument (starting
2390 from 1), while @var{first-to-check} is the number of the first
2391 argument to check against the format string.  For functions
2392 where the arguments are not available to be checked (such as
2393 @code{vprintf}), specify the third parameter as zero.  In this case the
2394 compiler only checks the format string for consistency.  For
2395 @code{strftime} formats, the third parameter is required to be zero.
2396 Since non-static C++ methods have an implicit @code{this} argument, the
2397 arguments of such methods should be counted from two, not one, when
2398 giving values for @var{string-index} and @var{first-to-check}.
2399
2400 In the example above, the format string (@code{my_format}) is the second
2401 argument of the function @code{my_print}, and the arguments to check
2402 start with the third argument, so the correct parameters for the format
2403 attribute are 2 and 3.
2404
2405 @opindex ffreestanding
2406 @opindex fno-builtin
2407 The @code{format} attribute allows you to identify your own functions
2408 which take format strings as arguments, so that GCC can check the
2409 calls to these functions for errors.  The compiler always (unless
2410 @option{-ffreestanding} or @option{-fno-builtin} is used) checks formats
2411 for the standard library functions @code{printf}, @code{fprintf},
2412 @code{sprintf}, @code{scanf}, @code{fscanf}, @code{sscanf}, @code{strftime},
2413 @code{vprintf}, @code{vfprintf} and @code{vsprintf} whenever such
2414 warnings are requested (using @option{-Wformat}), so there is no need to
2415 modify the header file @file{stdio.h}.  In C99 mode, the functions
2416 @code{snprintf}, @code{vsnprintf}, @code{vscanf}, @code{vfscanf} and
2417 @code{vsscanf} are also checked.  Except in strictly conforming C
2418 standard modes, the X/Open function @code{strfmon} is also checked as
2419 are @code{printf_unlocked} and @code{fprintf_unlocked}.
2420 @xref{C Dialect Options,,Options Controlling C Dialect}.
2421
2422 For Objective-C dialects, @code{NSString} (or @code{__NSString__}) is 
2423 recognized in the same context.  Declarations including these format attributes
2424 will be parsed for correct syntax, however the result of checking of such format
2425 strings is not yet defined, and will not be carried out by this version of the 
2426 compiler.
2427
2428 The target may also provide additional types of format checks.
2429 @xref{Target Format Checks,,Format Checks Specific to Particular
2430 Target Machines}.
2431
2432 @item format_arg (@var{string-index})
2433 @cindex @code{format_arg} function attribute
2434 @opindex Wformat-nonliteral
2435 The @code{format_arg} attribute specifies that a function takes a format
2436 string for a @code{printf}, @code{scanf}, @code{strftime} or
2437 @code{strfmon} style function and modifies it (for example, to translate
2438 it into another language), so the result can be passed to a
2439 @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style
2440 function (with the remaining arguments to the format function the same
2441 as they would have been for the unmodified string).  For example, the
2442 declaration:
2443
2444 @smallexample
2445 extern char *
2446 my_dgettext (char *my_domain, const char *my_format)
2447       __attribute__ ((format_arg (2)));
2448 @end smallexample
2449
2450 @noindent
2451 causes the compiler to check the arguments in calls to a @code{printf},
2452 @code{scanf}, @code{strftime} or @code{strfmon} type function, whose
2453 format string argument is a call to the @code{my_dgettext} function, for
2454 consistency with the format string argument @code{my_format}.  If the
2455 @code{format_arg} attribute had not been specified, all the compiler
2456 could tell in such calls to format functions would be that the format
2457 string argument is not constant; this would generate a warning when
2458 @option{-Wformat-nonliteral} is used, but the calls could not be checked
2459 without the attribute.
2460
2461 The parameter @var{string-index} specifies which argument is the format
2462 string argument (starting from one).  Since non-static C++ methods have
2463 an implicit @code{this} argument, the arguments of such methods should
2464 be counted from two.
2465
2466 The @code{format-arg} attribute allows you to identify your own
2467 functions which modify format strings, so that GCC can check the
2468 calls to @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon}
2469 type function whose operands are a call to one of your own function.
2470 The compiler always treats @code{gettext}, @code{dgettext}, and
2471 @code{dcgettext} in this manner except when strict ISO C support is
2472 requested by @option{-ansi} or an appropriate @option{-std} option, or
2473 @option{-ffreestanding} or @option{-fno-builtin}
2474 is used.  @xref{C Dialect Options,,Options
2475 Controlling C Dialect}.
2476
2477 For Objective-C dialects, the @code{format-arg} attribute may refer to an
2478 @code{NSString} reference for compatibility with the @code{format} attribute
2479 above.
2480
2481 The target may also allow additional types in @code{format-arg} attributes.
2482 @xref{Target Format Checks,,Format Checks Specific to Particular
2483 Target Machines}.
2484
2485 @item function_vector
2486 @cindex calling functions through the function vector on H8/300, M16C, M32C and SH2A processors
2487 Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
2488 function should be called through the function vector.  Calling a
2489 function through the function vector will reduce code size, however;
2490 the function vector has a limited size (maximum 128 entries on the H8/300
2491 and 64 entries on the H8/300H and H8S) and shares space with the interrupt vector.
2492
2493 In SH2A target, this attribute declares a function to be called using the
2494 TBR relative addressing mode.  The argument to this attribute is the entry
2495 number of the same function in a vector table containing all the TBR
2496 relative addressable functions.  For the successful jump, register TBR
2497 should contain the start address of this TBR relative vector table.
2498 In the startup routine of the user application, user needs to care of this
2499 TBR register initialization.  The TBR relative vector table can have at
2500 max 256 function entries.  The jumps to these functions will be generated
2501 using a SH2A specific, non delayed branch instruction JSR/N @@(disp8,TBR).
2502 You must use GAS and GLD from GNU binutils version 2.7 or later for
2503 this attribute to work correctly.
2504
2505 Please refer the example of M16C target, to see the use of this
2506 attribute while declaring a function,
2507
2508 In an application, for a function being called once, this attribute will
2509 save at least 8 bytes of code; and if other successive calls are being
2510 made to the same function, it will save 2 bytes of code per each of these
2511 calls.
2512
2513 On M16C/M32C targets, the @code{function_vector} attribute declares a
2514 special page subroutine call function. Use of this attribute reduces
2515 the code size by 2 bytes for each call generated to the
2516 subroutine. The argument to the attribute is the vector number entry
2517 from the special page vector table which contains the 16 low-order
2518 bits of the subroutine's entry address. Each vector table has special
2519 page number (18 to 255) which are used in @code{jsrs} instruction.
2520 Jump addresses of the routines are generated by adding 0x0F0000 (in
2521 case of M16C targets) or 0xFF0000 (in case of M32C targets), to the 2
2522 byte addresses set in the vector table. Therefore you need to ensure
2523 that all the special page vector routines should get mapped within the
2524 address range 0x0F0000 to 0x0FFFFF (for M16C) and 0xFF0000 to 0xFFFFFF
2525 (for M32C).
2526
2527 In the following example 2 bytes will be saved for each call to
2528 function @code{foo}.
2529
2530 @smallexample
2531 void foo (void) __attribute__((function_vector(0x18)));
2532 void foo (void)
2533 @{
2534 @}
2535
2536 void bar (void)
2537 @{
2538     foo();
2539 @}
2540 @end smallexample
2541
2542 If functions are defined in one file and are called in another file,
2543 then be sure to write this declaration in both files.
2544
2545 This attribute is ignored for R8C target.
2546
2547 @item interrupt
2548 @cindex interrupt handler functions
2549 Use this attribute on the ARM, AVR, CRX, M32C, M32R/D, m68k, MeP, MIPS,
2550 RX and Xstormy16 ports to indicate that the specified function is an
2551 interrupt handler.  The compiler will generate function entry and exit
2552 sequences suitable for use in an interrupt handler when this attribute
2553 is present.
2554
2555 Note, interrupt handlers for the Blackfin, H8/300, H8/300H, H8S, MicroBlaze,
2556 and SH processors can be specified via the @code{interrupt_handler} attribute.
2557
2558 Note, on the AVR, interrupts will be enabled inside the function.
2559
2560 Note, for the ARM, you can specify the kind of interrupt to be handled by
2561 adding an optional parameter to the interrupt attribute like this:
2562
2563 @smallexample
2564 void f () __attribute__ ((interrupt ("IRQ")));
2565 @end smallexample
2566
2567 Permissible values for this parameter are: IRQ, FIQ, SWI, ABORT and UNDEF@.
2568
2569 On ARMv7-M the interrupt type is ignored, and the attribute means the function
2570 may be called with a word aligned stack pointer.
2571
2572 On MIPS targets, you can use the following attributes to modify the behavior
2573 of an interrupt handler:
2574 @table @code
2575 @item use_shadow_register_set
2576 @cindex @code{use_shadow_register_set} attribute
2577 Assume that the handler uses a shadow register set, instead of
2578 the main general-purpose registers.
2579
2580 @item keep_interrupts_masked
2581 @cindex @code{keep_interrupts_masked} attribute
2582 Keep interrupts masked for the whole function.  Without this attribute,
2583 GCC tries to reenable interrupts for as much of the function as it can.
2584
2585 @item use_debug_exception_return
2586 @cindex @code{use_debug_exception_return} attribute
2587 Return using the @code{deret} instruction.  Interrupt handlers that don't
2588 have this attribute return using @code{eret} instead.
2589 @end table
2590
2591 You can use any combination of these attributes, as shown below:
2592 @smallexample
2593 void __attribute__ ((interrupt)) v0 ();
2594 void __attribute__ ((interrupt, use_shadow_register_set)) v1 ();
2595 void __attribute__ ((interrupt, keep_interrupts_masked)) v2 ();
2596 void __attribute__ ((interrupt, use_debug_exception_return)) v3 ();
2597 void __attribute__ ((interrupt, use_shadow_register_set,
2598                      keep_interrupts_masked)) v4 ();
2599 void __attribute__ ((interrupt, use_shadow_register_set,
2600                      use_debug_exception_return)) v5 ();
2601 void __attribute__ ((interrupt, keep_interrupts_masked,
2602                      use_debug_exception_return)) v6 ();
2603 void __attribute__ ((interrupt, use_shadow_register_set,
2604                      keep_interrupts_masked,
2605                      use_debug_exception_return)) v7 ();
2606 @end smallexample
2607
2608 @item ifunc ("@var{resolver}")
2609 @cindex @code{ifunc} attribute
2610 The @code{ifunc} attribute is used to mark a function as an indirect
2611 function using the STT_GNU_IFUNC symbol type extension to the ELF
2612 standard.  This allows the resolution of the symbol value to be
2613 determined dynamically at load time, and an optimized version of the
2614 routine can be selected for the particular processor or other system
2615 characteristics determined then.  To use this attribute, first define
2616 the implementation functions available, and a resolver function that
2617 returns a pointer to the selected implementation function.  The
2618 implementation functions' declarations must match the API of the
2619 function being implemented, the resolver's declaration is be a
2620 function returning pointer to void function returning void:
2621
2622 @smallexample
2623 void *my_memcpy (void *dst, const void *src, size_t len)
2624 @{
2625   @dots{}
2626 @}
2627
2628 static void (*resolve_memcpy (void)) (void)
2629 @{
2630   return my_memcpy; // we'll just always select this routine
2631 @}
2632 @end smallexample
2633
2634 The exported header file declaring the function the user calls would
2635 contain:
2636
2637 @smallexample
2638 extern void *memcpy (void *, const void *, size_t);
2639 @end smallexample
2640
2641 allowing the user to call this as a regular function, unaware of the
2642 implementation.  Finally, the indirect function needs to be defined in
2643 the same translation unit as the resolver function:
2644
2645 @smallexample
2646 void *memcpy (void *, const void *, size_t)
2647      __attribute__ ((ifunc ("resolve_memcpy")));
2648 @end smallexample
2649
2650 Indirect functions cannot be weak, and require a recent binutils (at
2651 least version 2.20.1), and GNU C library (at least version 2.11.1).
2652
2653 @item interrupt_handler
2654 @cindex interrupt handler functions on the Blackfin, m68k, H8/300 and SH processors
2655 Use this attribute on the Blackfin, m68k, H8/300, H8/300H, H8S, and SH to
2656 indicate that the specified function is an interrupt handler.  The compiler
2657 will generate function entry and exit sequences suitable for use in an
2658 interrupt handler when this attribute is present.
2659
2660 @item interrupt_thread
2661 @cindex interrupt thread functions on fido
2662 Use this attribute on fido, a subarchitecture of the m68k, to indicate
2663 that the specified function is an interrupt handler that is designed
2664 to run as a thread.  The compiler omits generate prologue/epilogue
2665 sequences and replaces the return instruction with a @code{sleep}
2666 instruction.  This attribute is available only on fido.
2667
2668 @item isr
2669 @cindex interrupt service routines on ARM
2670 Use this attribute on ARM to write Interrupt Service Routines. This is an
2671 alias to the @code{interrupt} attribute above.
2672
2673 @item kspisusp
2674 @cindex User stack pointer in interrupts on the Blackfin
2675 When used together with @code{interrupt_handler}, @code{exception_handler}
2676 or @code{nmi_handler}, code will be generated to load the stack pointer
2677 from the USP register in the function prologue.
2678
2679 @item l1_text
2680 @cindex @code{l1_text} function attribute
2681 This attribute specifies a function to be placed into L1 Instruction
2682 SRAM@. The function will be put into a specific section named @code{.l1.text}.
2683 With @option{-mfdpic}, function calls with a such function as the callee
2684 or caller will use inlined PLT.
2685
2686 @item l2
2687 @cindex @code{l2} function attribute
2688 On the Blackfin, this attribute specifies a function to be placed into L2
2689 SRAM. The function will be put into a specific section named
2690 @code{.l1.text}. With @option{-mfdpic}, callers of such functions will use
2691 an inlined PLT.
2692
2693 @item leaf
2694 @cindex @code{leaf} function attribute
2695 Calls to external functions with this attribute must return to the current
2696 compilation unit only by return or by exception handling.  In particular, leaf
2697 functions are not allowed to call callback function passed to it from the current
2698 compilation unit or directly call functions exported by the unit or longjmp
2699 into the unit.  Leaf function might still call functions from other compilation
2700 units and thus they are not necessarily leaf in the sense that they contain no
2701 function calls at all.
2702
2703 The attribute is intended for library functions to improve dataflow analysis.
2704 The compiler takes the hint that any data not escaping the current compilation unit can
2705 not be used or modified by the leaf function.  For example, the @code{sin} function
2706 is a leaf function, but @code{qsort} is not.
2707
2708 Note that leaf functions might invoke signals and signal handlers might be
2709 defined in the current compilation unit and use static variables.  The only
2710 compliant way to write such a signal handler is to declare such variables
2711 @code{volatile}.
2712
2713 The attribute has no effect on functions defined within the current compilation
2714 unit.  This is to allow easy merging of multiple compilation units into one,
2715 for example, by using the link time optimization.  For this reason the
2716 attribute is not allowed on types to annotate indirect calls.
2717
2718 @item long_call/short_call
2719 @cindex indirect calls on ARM
2720 This attribute specifies how a particular function is called on
2721 ARM@.  Both attributes override the @option{-mlong-calls} (@pxref{ARM Options})
2722 command-line switch and @code{#pragma long_calls} settings.  The
2723 @code{long_call} attribute indicates that the function might be far
2724 away from the call site and require a different (more expensive)
2725 calling sequence.   The @code{short_call} attribute always places
2726 the offset to the function from the call site into the @samp{BL}
2727 instruction directly.
2728
2729 @item longcall/shortcall
2730 @cindex functions called via pointer on the RS/6000 and PowerPC
2731 On the Blackfin, RS/6000 and PowerPC, the @code{longcall} attribute
2732 indicates that the function might be far away from the call site and
2733 require a different (more expensive) calling sequence.  The
2734 @code{shortcall} attribute indicates that the function is always close
2735 enough for the shorter calling sequence to be used.  These attributes
2736 override both the @option{-mlongcall} switch and, on the RS/6000 and
2737 PowerPC, the @code{#pragma longcall} setting.
2738
2739 @xref{RS/6000 and PowerPC Options}, for more information on whether long
2740 calls are necessary.
2741
2742 @item long_call/near/far
2743 @cindex indirect calls on MIPS
2744 These attributes specify how a particular function is called on MIPS@.
2745 The attributes override the @option{-mlong-calls} (@pxref{MIPS Options})
2746 command-line switch.  The @code{long_call} and @code{far} attributes are
2747 synonyms, and cause the compiler to always call
2748 the function by first loading its address into a register, and then using
2749 the contents of that register.  The @code{near} attribute has the opposite
2750 effect; it specifies that non-PIC calls should be made using the more 
2751 efficient @code{jal} instruction.
2752
2753 @item malloc
2754 @cindex @code{malloc} attribute
2755 The @code{malloc} attribute is used to tell the compiler that a function
2756 may be treated as if any non-@code{NULL} pointer it returns cannot
2757 alias any other pointer valid when the function returns.
2758 This will often improve optimization.
2759 Standard functions with this property include @code{malloc} and
2760 @code{calloc}.  @code{realloc}-like functions have this property as
2761 long as the old pointer is never referred to (including comparing it
2762 to the new pointer) after the function returns a non-@code{NULL}
2763 value.
2764
2765 @item mips16/nomips16
2766 @cindex @code{mips16} attribute
2767 @cindex @code{nomips16} attribute
2768
2769 On MIPS targets, you can use the @code{mips16} and @code{nomips16}
2770 function attributes to locally select or turn off MIPS16 code generation.
2771 A function with the @code{mips16} attribute is emitted as MIPS16 code, 
2772 while MIPS16 code generation is disabled for functions with the 
2773 @code{nomips16} attribute.  These attributes override the 
2774 @option{-mips16} and @option{-mno-mips16} options on the command line
2775 (@pxref{MIPS Options}).  
2776
2777 When compiling files containing mixed MIPS16 and non-MIPS16 code, the
2778 preprocessor symbol @code{__mips16} reflects the setting on the command line,
2779 not that within individual functions.  Mixed MIPS16 and non-MIPS16 code
2780 may interact badly with some GCC extensions such as @code{__builtin_apply}
2781 (@pxref{Constructing Calls}).
2782
2783 @item model (@var{model-name})
2784 @cindex function addressability on the M32R/D
2785 @cindex variable addressability on the IA-64
2786
2787 On the M32R/D, use this attribute to set the addressability of an
2788 object, and of the code generated for a function.  The identifier
2789 @var{model-name} is one of @code{small}, @code{medium}, or
2790 @code{large}, representing each of the code models.
2791
2792 Small model objects live in the lower 16MB of memory (so that their
2793 addresses can be loaded with the @code{ld24} instruction), and are
2794 callable with the @code{bl} instruction.
2795
2796 Medium model objects may live anywhere in the 32-bit address space (the
2797 compiler will generate @code{seth/add3} instructions to load their addresses),
2798 and are callable with the @code{bl} instruction.
2799
2800 Large model objects may live anywhere in the 32-bit address space (the
2801 compiler will generate @code{seth/add3} instructions to load their addresses),
2802 and may not be reachable with the @code{bl} instruction (the compiler will
2803 generate the much slower @code{seth/add3/jl} instruction sequence).
2804
2805 On IA-64, use this attribute to set the addressability of an object.
2806 At present, the only supported identifier for @var{model-name} is
2807 @code{small}, indicating addressability via ``small'' (22-bit)
2808 addresses (so that their addresses can be loaded with the @code{addl}
2809 instruction).  Caveat: such addressing is by definition not position
2810 independent and hence this attribute must not be used for objects
2811 defined by shared libraries.
2812
2813 @item ms_abi/sysv_abi
2814 @cindex @code{ms_abi} attribute
2815 @cindex @code{sysv_abi} attribute
2816
2817 On 64-bit x86_64-*-* targets, you can use an ABI attribute to indicate
2818 which calling convention should be used for a function.  The @code{ms_abi}
2819 attribute tells the compiler to use the Microsoft ABI, while the
2820 @code{sysv_abi} attribute tells the compiler to use the ABI used on
2821 GNU/Linux and other systems.  The default is to use the Microsoft ABI
2822 when targeting Windows.  On all other systems, the default is the AMD ABI.
2823
2824 Note, the @code{ms_abi} attribute for Windows targets currently requires
2825 the @option{-maccumulate-outgoing-args} option.
2826
2827 @item callee_pop_aggregate_return (@var{number})
2828 @cindex @code{callee_pop_aggregate_return} attribute
2829
2830 On 32-bit i?86-*-* targets, you can control by those attribute for
2831 aggregate return in memory, if the caller is responsible to pop the hidden
2832 pointer together with the rest of the arguments - @var{number} equal to
2833 zero -, or if the callee is responsible to pop hidden pointer - @var{number}
2834 equal to one.
2835
2836 For i?86-netware, the caller pops the stack for the hidden arguments pointing
2837 to aggregate return value.  This differs from the default i386 ABI which assumes
2838 that the callee pops the stack for hidden pointer.
2839
2840 @item ms_hook_prologue
2841 @cindex @code{ms_hook_prologue} attribute
2842
2843 On 32 bit i[34567]86-*-* targets and 64 bit x86_64-*-* targets, you can use
2844 this function attribute to make gcc generate the "hot-patching" function
2845 prologue used in Win32 API functions in Microsoft Windows XP Service Pack 2
2846 and newer.
2847
2848 @item naked
2849 @cindex function without a prologue/epilogue code
2850 Use this attribute on the ARM, AVR, MCORE, RX and SPU ports to indicate that
2851 the specified function does not need prologue/epilogue sequences generated by
2852 the compiler.  It is up to the programmer to provide these sequences. The 
2853 only statements that can be safely included in naked functions are 
2854 @code{asm} statements that do not have operands.  All other statements,
2855 including declarations of local variables, @code{if} statements, and so 
2856 forth, should be avoided.  Naked functions should be used to implement the 
2857 body of an assembly function, while allowing the compiler to construct
2858 the requisite function declaration for the assembler.
2859
2860 @item near
2861 @cindex functions which do not handle memory bank switching on 68HC11/68HC12
2862 On 68HC11 and 68HC12 the @code{near} attribute causes the compiler to
2863 use the normal calling convention based on @code{jsr} and @code{rts}.
2864 This attribute can be used to cancel the effect of the @option{-mlong-calls}
2865 option.
2866
2867 On MeP targets this attribute causes the compiler to assume the called
2868 function is close enough to use the normal calling convention,
2869 overriding the @code{-mtf} command line option.
2870
2871 @item nesting
2872 @cindex Allow nesting in an interrupt handler on the Blackfin processor.
2873 Use this attribute together with @code{interrupt_handler},
2874 @code{exception_handler} or @code{nmi_handler} to indicate that the function
2875 entry code should enable nested interrupts or exceptions.
2876
2877 @item nmi_handler
2878 @cindex NMI handler functions on the Blackfin processor
2879 Use this attribute on the Blackfin to indicate that the specified function
2880 is an NMI handler.  The compiler will generate function entry and
2881 exit sequences suitable for use in an NMI handler when this
2882 attribute is present.
2883
2884 @item no_instrument_function
2885 @cindex @code{no_instrument_function} function attribute
2886 @opindex finstrument-functions
2887 If @option{-finstrument-functions} is given, profiling function calls will
2888 be generated at entry and exit of most user-compiled functions.
2889 Functions with this attribute will not be so instrumented.
2890
2891 @item no_split_stack
2892 @cindex @code{no_split_stack} function attribute
2893 @opindex fsplit-stack
2894 If @option{-fsplit-stack} is given, functions will have a small
2895 prologue which decides whether to split the stack.  Functions with the
2896 @code{no_split_stack} attribute will not have that prologue, and thus
2897 may run with only a small amount of stack space available.
2898
2899 @item noinline
2900 @cindex @code{noinline} function attribute
2901 This function attribute prevents a function from being considered for
2902 inlining.
2903 @c Don't enumerate the optimizations by name here; we try to be
2904 @c future-compatible with this mechanism.
2905 If the function does not have side-effects, there are optimizations
2906 other than inlining that causes function calls to be optimized away,
2907 although the function call is live.  To keep such calls from being
2908 optimized away, put
2909 @smallexample
2910 asm ("");
2911 @end smallexample
2912 (@pxref{Extended Asm}) in the called function, to serve as a special
2913 side-effect.
2914
2915 @item noclone
2916 @cindex @code{noclone} function attribute
2917 This function attribute prevents a function from being considered for
2918 cloning - a mechanism which produces specialized copies of functions
2919 and which is (currently) performed by interprocedural constant
2920 propagation.
2921
2922 @item nonnull (@var{arg-index}, @dots{})
2923 @cindex @code{nonnull} function attribute
2924 The @code{nonnull} attribute specifies that some function parameters should
2925 be non-null pointers.  For instance, the declaration:
2926
2927 @smallexample
2928 extern void *
2929 my_memcpy (void *dest, const void *src, size_t len)
2930         __attribute__((nonnull (1, 2)));
2931 @end smallexample
2932
2933 @noindent
2934 causes the compiler to check that, in calls to @code{my_memcpy},
2935 arguments @var{dest} and @var{src} are non-null.  If the compiler
2936 determines that a null pointer is passed in an argument slot marked
2937 as non-null, and the @option{-Wnonnull} option is enabled, a warning
2938 is issued.  The compiler may also choose to make optimizations based
2939 on the knowledge that certain function arguments will not be null.
2940
2941 If no argument index list is given to the @code{nonnull} attribute,
2942 all pointer arguments are marked as non-null.  To illustrate, the
2943 following declaration is equivalent to the previous example:
2944
2945 @smallexample
2946 extern void *
2947 my_memcpy (void *dest, const void *src, size_t len)
2948         __attribute__((nonnull));
2949 @end smallexample
2950
2951 @item noreturn
2952 @cindex @code{noreturn} function attribute
2953 A few standard library functions, such as @code{abort} and @code{exit},
2954 cannot return.  GCC knows this automatically.  Some programs define
2955 their own functions that never return.  You can declare them
2956 @code{noreturn} to tell the compiler this fact.  For example,
2957
2958 @smallexample
2959 @group
2960 void fatal () __attribute__ ((noreturn));
2961
2962 void
2963 fatal (/* @r{@dots{}} */)
2964 @{
2965   /* @r{@dots{}} */ /* @r{Print error message.} */ /* @r{@dots{}} */
2966   exit (1);
2967 @}
2968 @end group
2969 @end smallexample
2970
2971 The @code{noreturn} keyword tells the compiler to assume that
2972 @code{fatal} cannot return.  It can then optimize without regard to what
2973 would happen if @code{fatal} ever did return.  This makes slightly
2974 better code.  More importantly, it helps avoid spurious warnings of
2975 uninitialized variables.
2976
2977 The @code{noreturn} keyword does not affect the exceptional path when that
2978 applies: a @code{noreturn}-marked function may still return to the caller
2979 by throwing an exception or calling @code{longjmp}.
2980
2981 Do not assume that registers saved by the calling function are
2982 restored before calling the @code{noreturn} function.
2983
2984 It does not make sense for a @code{noreturn} function to have a return
2985 type other than @code{void}.
2986
2987 The attribute @code{noreturn} is not implemented in GCC versions
2988 earlier than 2.5.  An alternative way to declare that a function does
2989 not return, which works in the current version and in some older
2990 versions, is as follows:
2991
2992 @smallexample
2993 typedef void voidfn ();
2994
2995 volatile voidfn fatal;
2996 @end smallexample
2997
2998 This approach does not work in GNU C++.
2999
3000 @item nothrow
3001 @cindex @code{nothrow} function attribute
3002 The @code{nothrow} attribute is used to inform the compiler that a
3003 function cannot throw an exception.  For example, most functions in
3004 the standard C library can be guaranteed not to throw an exception
3005 with the notable exceptions of @code{qsort} and @code{bsearch} that
3006 take function pointer arguments.  The @code{nothrow} attribute is not
3007 implemented in GCC versions earlier than 3.3.
3008
3009 @item optimize
3010 @cindex @code{optimize} function attribute
3011 The @code{optimize} attribute is used to specify that a function is to
3012 be compiled with different optimization options than specified on the
3013 command line.  Arguments can either be numbers or strings.  Numbers
3014 are assumed to be an optimization level.  Strings that begin with
3015 @code{O} are assumed to be an optimization option, while other options
3016 are assumed to be used with a @code{-f} prefix.  You can also use the
3017 @samp{#pragma GCC optimize} pragma to set the optimization options
3018 that affect more than one function.
3019 @xref{Function Specific Option Pragmas}, for details about the
3020 @samp{#pragma GCC optimize} pragma.
3021
3022 This can be used for instance to have frequently executed functions
3023 compiled with more aggressive optimization options that produce faster
3024 and larger code, while other functions can be called with less
3025 aggressive options.
3026
3027 @item pcs
3028 @cindex @code{pcs} function attribute
3029
3030 The @code{pcs} attribute can be used to control the calling convention
3031 used for a function on ARM.  The attribute takes an argument that specifies
3032 the calling convention to use.
3033
3034 When compiling using the AAPCS ABI (or a variant of that) then valid
3035 values for the argument are @code{"aapcs"} and @code{"aapcs-vfp"}.  In
3036 order to use a variant other than @code{"aapcs"} then the compiler must
3037 be permitted to use the appropriate co-processor registers (i.e., the
3038 VFP registers must be available in order to use @code{"aapcs-vfp"}).
3039 For example,
3040
3041 @smallexample
3042 /* Argument passed in r0, and result returned in r0+r1.  */
3043 double f2d (float) __attribute__((pcs("aapcs")));
3044 @end smallexample
3045
3046 Variadic functions always use the @code{"aapcs"} calling convention and
3047 the compiler will reject attempts to specify an alternative.
3048
3049 @item pure
3050 @cindex @code{pure} function attribute
3051 Many functions have no effects except the return value and their
3052 return value depends only on the parameters and/or global variables.
3053 Such a function can be subject
3054 to common subexpression elimination and loop optimization just as an
3055 arithmetic operator would be.  These functions should be declared
3056 with the attribute @code{pure}.  For example,
3057
3058 @smallexample
3059 int square (int) __attribute__ ((pure));
3060 @end smallexample
3061
3062 @noindent
3063 says that the hypothetical function @code{square} is safe to call
3064 fewer times than the program says.
3065
3066 Some of common examples of pure functions are @code{strlen} or @code{memcmp}.
3067 Interesting non-pure functions are functions with infinite loops or those
3068 depending on volatile memory or other system resource, that may change between
3069 two consecutive calls (such as @code{feof} in a multithreading environment).
3070
3071 The attribute @code{pure} is not implemented in GCC versions earlier
3072 than 2.96.
3073
3074 @item hot
3075 @cindex @code{hot} function attribute
3076 The @code{hot} attribute is used to inform the compiler that a function is a
3077 hot spot of the compiled program.  The function is optimized more aggressively
3078 and on many target it is placed into special subsection of the text section so
3079 all hot functions appears close together improving locality.
3080
3081 When profile feedback is available, via @option{-fprofile-use}, hot functions
3082 are automatically detected and this attribute is ignored.
3083
3084 The @code{hot} attribute is not implemented in GCC versions earlier
3085 than 4.3.
3086
3087 @item cold
3088 @cindex @code{cold} function attribute
3089 The @code{cold} attribute is used to inform the compiler that a function is
3090 unlikely executed.  The function is optimized for size rather than speed and on
3091 many targets it is placed into special subsection of the text section so all
3092 cold functions appears close together improving code locality of non-cold parts
3093 of program.  The paths leading to call of cold functions within code are marked
3094 as unlikely by the branch prediction mechanism. It is thus useful to mark
3095 functions used to handle unlikely conditions, such as @code{perror}, as cold to
3096 improve optimization of hot functions that do call marked functions in rare
3097 occasions.
3098
3099 When profile feedback is available, via @option{-fprofile-use}, hot functions
3100 are automatically detected and this attribute is ignored.
3101
3102 The @code{cold} attribute is not implemented in GCC versions earlier than 4.3.
3103
3104 @item regparm (@var{number})
3105 @cindex @code{regparm} attribute
3106 @cindex functions that are passed arguments in registers on the 386
3107 On the Intel 386, the @code{regparm} attribute causes the compiler to
3108 pass arguments number one to @var{number} if they are of integral type
3109 in registers EAX, EDX, and ECX instead of on the stack.  Functions that
3110 take a variable number of arguments will continue to be passed all of their
3111 arguments on the stack.
3112
3113 Beware that on some ELF systems this attribute is unsuitable for
3114 global functions in shared libraries with lazy binding (which is the
3115 default).  Lazy binding will send the first call via resolving code in
3116 the loader, which might assume EAX, EDX and ECX can be clobbered, as
3117 per the standard calling conventions.  Solaris 8 is affected by this.
3118 GNU systems with GLIBC 2.1 or higher, and FreeBSD, are believed to be
3119 safe since the loaders there save EAX, EDX and ECX.  (Lazy binding can be
3120 disabled with the linker or the loader if desired, to avoid the
3121 problem.)
3122
3123 @item sseregparm
3124 @cindex @code{sseregparm} attribute
3125 On the Intel 386 with SSE support, the @code{sseregparm} attribute
3126 causes the compiler to pass up to 3 floating point arguments in
3127 SSE registers instead of on the stack.  Functions that take a
3128 variable number of arguments will continue to pass all of their
3129 floating point arguments on the stack.
3130
3131 @item force_align_arg_pointer
3132 @cindex @code{force_align_arg_pointer} attribute
3133 On the Intel x86, the @code{force_align_arg_pointer} attribute may be
3134 applied to individual function definitions, generating an alternate
3135 prologue and epilogue that realigns the runtime stack if necessary.
3136 This supports mixing legacy codes that run with a 4-byte aligned stack
3137 with modern codes that keep a 16-byte stack for SSE compatibility.
3138
3139 @item resbank
3140 @cindex @code{resbank} attribute
3141 On the SH2A target, this attribute enables the high-speed register
3142 saving and restoration using a register bank for @code{interrupt_handler}
3143 routines.  Saving to the bank is performed automatically after the CPU
3144 accepts an interrupt that uses a register bank.
3145
3146 The nineteen 32-bit registers comprising general register R0 to R14,
3147 control register GBR, and system registers MACH, MACL, and PR and the
3148 vector table address offset are saved into a register bank.  Register
3149 banks are stacked in first-in last-out (FILO) sequence.  Restoration
3150 from the bank is executed by issuing a RESBANK instruction.
3151
3152 @item returns_twice
3153 @cindex @code{returns_twice} attribute
3154 The @code{returns_twice} attribute tells the compiler that a function may
3155 return more than one time.  The compiler will ensure that all registers
3156 are dead before calling such a function and will emit a warning about
3157 the variables that may be clobbered after the second return from the
3158 function.  Examples of such functions are @code{setjmp} and @code{vfork}.
3159 The @code{longjmp}-like counterpart of such function, if any, might need
3160 to be marked with the @code{noreturn} attribute.
3161
3162 @item saveall
3163 @cindex save all registers on the Blackfin, H8/300, H8/300H, and H8S
3164 Use this attribute on the Blackfin, H8/300, H8/300H, and H8S to indicate that
3165 all registers except the stack pointer should be saved in the prologue
3166 regardless of whether they are used or not.
3167
3168 @item save_volatiles
3169 @cindex save volatile registers on the MicroBlaze
3170 Use this attribute on the MicroBlaze to indicate that the function is
3171 an interrupt handler.  All volatile registers (in addition to non-volatile 
3172 registers) will be saved in the function prologue.  If the function is a leaf 
3173 function, only volatiles used by the function are saved.  A normal function 
3174 return is generated instead of a return from interrupt.  
3175
3176 @item section ("@var{section-name}")
3177 @cindex @code{section} function attribute
3178 Normally, the compiler places the code it generates in the @code{text} section.
3179 Sometimes, however, you need additional sections, or you need certain
3180 particular functions to appear in special sections.  The @code{section}
3181 attribute specifies that a function lives in a particular section.
3182 For example, the declaration:
3183
3184 @smallexample
3185 extern void foobar (void) __attribute__ ((section ("bar")));
3186 @end smallexample
3187
3188 @noindent
3189 puts the function @code{foobar} in the @code{bar} section.
3190
3191 Some file formats do not support arbitrary sections so the @code{section}
3192 attribute is not available on all platforms.
3193 If you need to map the entire contents of a module to a particular
3194 section, consider using the facilities of the linker instead.
3195
3196 @item sentinel
3197 @cindex @code{sentinel} function attribute
3198 This function attribute ensures that a parameter in a function call is
3199 an explicit @code{NULL}.  The attribute is only valid on variadic
3200 functions.  By default, the sentinel is located at position zero, the
3201 last parameter of the function call.  If an optional integer position
3202 argument P is supplied to the attribute, the sentinel must be located at
3203 position P counting backwards from the end of the argument list.
3204
3205 @smallexample
3206 __attribute__ ((sentinel))
3207 is equivalent to
3208 __attribute__ ((sentinel(0)))
3209 @end smallexample
3210
3211 The attribute is automatically set with a position of 0 for the built-in
3212 functions @code{execl} and @code{execlp}.  The built-in function
3213 @code{execle} has the attribute set with a position of 1.
3214
3215 A valid @code{NULL} in this context is defined as zero with any pointer
3216 type.  If your system defines the @code{NULL} macro with an integer type
3217 then you need to add an explicit cast.  GCC replaces @code{stddef.h}
3218 with a copy that redefines NULL appropriately.
3219
3220 The warnings for missing or incorrect sentinels are enabled with
3221 @option{-Wformat}.
3222
3223 @item short_call
3224 See long_call/short_call.
3225
3226 @item shortcall
3227 See longcall/shortcall.
3228
3229 @item signal
3230 @cindex signal handler functions on the AVR processors
3231 Use this attribute on the AVR to indicate that the specified
3232 function is a signal handler.  The compiler will generate function
3233 entry and exit sequences suitable for use in a signal handler when this
3234 attribute is present.  Interrupts will be disabled inside the function.
3235
3236 @item sp_switch
3237 Use this attribute on the SH to indicate an @code{interrupt_handler}
3238 function should switch to an alternate stack.  It expects a string
3239 argument that names a global variable holding the address of the
3240 alternate stack.
3241
3242 @smallexample
3243 void *alt_stack;
3244 void f () __attribute__ ((interrupt_handler,
3245                           sp_switch ("alt_stack")));
3246 @end smallexample
3247
3248 @item stdcall
3249 @cindex functions that pop the argument stack on the 386
3250 On the Intel 386, the @code{stdcall} attribute causes the compiler to
3251 assume that the called function will pop off the stack space used to
3252 pass arguments, unless it takes a variable number of arguments.
3253
3254 @item syscall_linkage
3255 @cindex @code{syscall_linkage} attribute
3256 This attribute is used to modify the IA64 calling convention by marking
3257 all input registers as live at all function exits.  This makes it possible
3258 to restart a system call after an interrupt without having to save/restore
3259 the input registers.  This also prevents kernel data from leaking into
3260 application code.
3261
3262 @item target
3263 @cindex @code{target} function attribute
3264 The @code{target} attribute is used to specify that a function is to
3265 be compiled with different target options than specified on the
3266 command line.  This can be used for instance to have functions
3267 compiled with a different ISA (instruction set architecture) than the
3268 default.  You can also use the @samp{#pragma GCC target} pragma to set
3269 more than one function to be compiled with specific target options.
3270 @xref{Function Specific Option Pragmas}, for details about the
3271 @samp{#pragma GCC target} pragma.
3272
3273 For instance on a 386, you could compile one function with
3274 @code{target("sse4.1,arch=core2")} and another with
3275 @code{target("sse4a,arch=amdfam10")} that would be equivalent to
3276 compiling the first function with @option{-msse4.1} and
3277 @option{-march=core2} options, and the second function with
3278 @option{-msse4a} and @option{-march=amdfam10} options.  It is up to the
3279 user to make sure that a function is only invoked on a machine that
3280 supports the particular ISA it was compiled for (for example by using
3281 @code{cpuid} on 386 to determine what feature bits and architecture
3282 family are used).
3283
3284 @smallexample
3285 int core2_func (void) __attribute__ ((__target__ ("arch=core2")));
3286 int sse3_func (void) __attribute__ ((__target__ ("sse3")));
3287 @end smallexample
3288
3289 @table @samp
3290 @item i386 target attributes
3291 On the 386, the following options are allowed:
3292
3293 @table @samp
3294 @item abm
3295 @itemx no-abm
3296 @cindex @code{target("abm")} attribute
3297 Enable/disable the generation of the advanced bit instructions.
3298
3299 @item aes
3300 @itemx no-aes
3301 @cindex @code{target("aes")} attribute
3302 Enable/disable the generation of the AES instructions.
3303
3304 @item mmx
3305 @itemx no-mmx
3306 @cindex @code{target("mmx")} attribute
3307 Enable/disable the generation of the MMX instructions.
3308
3309 @item pclmul
3310 @itemx no-pclmul
3311 @cindex @code{target("pclmul")} attribute
3312 Enable/disable the generation of the PCLMUL instructions.
3313
3314 @item popcnt
3315 @itemx no-popcnt
3316 @cindex @code{target("popcnt")} attribute
3317 Enable/disable the generation of the POPCNT instruction.
3318
3319 @item sse
3320 @itemx no-sse
3321 @cindex @code{target("sse")} attribute
3322 Enable/disable the generation of the SSE instructions.
3323
3324 @item sse2
3325 @itemx no-sse2
3326 @cindex @code{target("sse2")} attribute
3327 Enable/disable the generation of the SSE2 instructions.
3328
3329 @item sse3
3330 @itemx no-sse3
3331 @cindex @code{target("sse3")} attribute
3332 Enable/disable the generation of the SSE3 instructions.
3333
3334 @item sse4
3335 @itemx no-sse4
3336 @cindex @code{target("sse4")} attribute
3337 Enable/disable the generation of the SSE4 instructions (both SSE4.1
3338 and SSE4.2).
3339
3340 @item sse4.1
3341 @itemx no-sse4.1
3342 @cindex @code{target("sse4.1")} attribute
3343 Enable/disable the generation of the sse4.1 instructions.
3344
3345 @item sse4.2
3346 @itemx no-sse4.2
3347 @cindex @code{target("sse4.2")} attribute
3348 Enable/disable the generation of the sse4.2 instructions.
3349
3350 @item sse4a
3351 @itemx no-sse4a
3352 @cindex @code{target("sse4a")} attribute
3353 Enable/disable the generation of the SSE4A instructions.
3354
3355 @item fma4
3356 @itemx no-fma4
3357 @cindex @code{target("fma4")} attribute
3358 Enable/disable the generation of the FMA4 instructions.
3359
3360 @item xop
3361 @itemx no-xop
3362 @cindex @code{target("xop")} attribute
3363 Enable/disable the generation of the XOP instructions.
3364
3365 @item lwp
3366 @itemx no-lwp
3367 @cindex @code{target("lwp")} attribute
3368 Enable/disable the generation of the LWP instructions.
3369
3370 @item ssse3
3371 @itemx no-ssse3
3372 @cindex @code{target("ssse3")} attribute
3373 Enable/disable the generation of the SSSE3 instructions.
3374
3375 @item cld
3376 @itemx no-cld
3377 @cindex @code{target("cld")} attribute
3378 Enable/disable the generation of the CLD before string moves.
3379
3380 @item fancy-math-387
3381 @itemx no-fancy-math-387
3382 @cindex @code{target("fancy-math-387")} attribute
3383 Enable/disable the generation of the @code{sin}, @code{cos}, and
3384 @code{sqrt} instructions on the 387 floating point unit.
3385
3386 @item fused-madd
3387 @itemx no-fused-madd
3388 @cindex @code{target("fused-madd")} attribute
3389 Enable/disable the generation of the fused multiply/add instructions.
3390
3391 @item ieee-fp
3392 @itemx no-ieee-fp
3393 @cindex @code{target("ieee-fp")} attribute
3394 Enable/disable the generation of floating point that depends on IEEE arithmetic.
3395
3396 @item inline-all-stringops
3397 @itemx no-inline-all-stringops
3398 @cindex @code{target("inline-all-stringops")} attribute
3399 Enable/disable inlining of string operations.
3400
3401 @item inline-stringops-dynamically
3402 @itemx no-inline-stringops-dynamically
3403 @cindex @code{target("inline-stringops-dynamically")} attribute
3404 Enable/disable the generation of the inline code to do small string
3405 operations and calling the library routines for large operations.
3406
3407 @item align-stringops
3408 @itemx no-align-stringops
3409 @cindex @code{target("align-stringops")} attribute
3410 Do/do not align destination of inlined string operations.
3411
3412 @item recip
3413 @itemx no-recip
3414 @cindex @code{target("recip")} attribute
3415 Enable/disable the generation of RCPSS, RCPPS, RSQRTSS and RSQRTPS
3416 instructions followed an additional Newton-Raphson step instead of
3417 doing a floating point division.
3418
3419 @item arch=@var{ARCH}
3420 @cindex @code{target("arch=@var{ARCH}")} attribute
3421 Specify the architecture to generate code for in compiling the function.
3422
3423 @item tune=@var{TUNE}
3424 @cindex @code{target("tune=@var{TUNE}")} attribute
3425 Specify the architecture to tune for in compiling the function.
3426
3427 @item fpmath=@var{FPMATH}
3428 @cindex @code{target("fpmath=@var{FPMATH}")} attribute
3429 Specify which floating point unit to use.  The
3430 @code{target("fpmath=sse,387")} option must be specified as
3431 @code{target("fpmath=sse+387")} because the comma would separate
3432 different options.
3433
3434 @item PowerPC target attributes
3435 On the PowerPC, the following options are allowed:
3436
3437 @table @samp
3438 @item altivec
3439 @itemx no-altivec
3440 @cindex @code{target("altivec")} attribute
3441 Generate code that uses (does not use) AltiVec instructions.  In
3442 32-bit code, you cannot enable Altivec instructions unless
3443 @option{-mabi=altivec} was used on the command line.
3444
3445 @item cmpb
3446 @itemx no-cmpb
3447 @cindex @code{target("cmpb")} attribute
3448 Generate code that uses (does not use) the compare bytes instruction
3449 implemented on the POWER6 processor and other processors that support
3450 the PowerPC V2.05 architecture.
3451
3452 @item dlmzb
3453 @itemx no-dlmzb
3454 @cindex @code{target("dlmzb")} attribute
3455 Generate code that uses (does not use) the string-search @samp{dlmzb}
3456 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
3457 generated by default when targetting those processors.
3458
3459 @item fprnd
3460 @itemx no-fprnd
3461 @cindex @code{target("fprnd")} attribute
3462 Generate code that uses (does not use) the FP round to integer
3463 instructions implemented on the POWER5+ processor and other processors
3464 that support the PowerPC V2.03 architecture.
3465
3466 @item hard-dfp
3467 @itemx no-hard-dfp
3468 @cindex @code{target("hard-dfp")} attribute
3469 Generate code that uses (does not use) the decimal floating point
3470 instructions implemented on some POWER processors.
3471
3472 @item isel
3473 @itemx no-isel
3474 @cindex @code{target("isel")} attribute
3475 Generate code that uses (does not use) ISEL instruction.
3476
3477 @item mfcrf
3478 @itemx no-mfcrf
3479 @cindex @code{target("mfcrf")} attribute
3480 Generate code that uses (does not use) the move from condition
3481 register field instruction implemented on the POWER4 processor and
3482 other processors that support the PowerPC V2.01 architecture.
3483
3484 @item mfpgpr
3485 @itemx no-mfpgpr
3486 @cindex @code{target("mfpgpr")} attribute
3487 Generate code that uses (does not use) the FP move to/from general
3488 purpose register instructions implemented on the POWER6X processor and
3489 other processors that support the extended PowerPC V2.05 architecture.
3490
3491 @item mulhw
3492 @itemx no-mulhw
3493 @cindex @code{target("mulhw")} attribute
3494 Generate code that uses (does not use) the half-word multiply and
3495 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
3496 These instructions are generated by default when targetting those
3497 processors.
3498
3499 @item multiple
3500 @itemx no-multiple
3501 @cindex @code{target("multiple")} attribute
3502 Generate code that uses (does not use) the load multiple word
3503 instructions and the store multiple word instructions.
3504
3505 @item update
3506 @itemx no-update
3507 @cindex @code{target("update")} attribute
3508 Generate code that uses (does not use) the load or store instructions
3509 that update the base register to the address of the calculated memory
3510 location.
3511
3512 @item popcntb
3513 @itemx no-popcntb
3514 @cindex @code{target("popcntb")} attribute
3515 Generate code that uses (does not use) the popcount and double
3516 precision FP reciprocal estimate instruction implemented on the POWER5
3517 processor and other processors that support the PowerPC V2.02
3518 architecture.
3519
3520 @item popcntd
3521 @itemx no-popcntd
3522 @cindex @code{target("popcntd")} attribute
3523 Generate code that uses (does not use) the popcount instruction
3524 implemented on the POWER7 processor and other processors that support
3525 the PowerPC V2.06 architecture.
3526
3527 @item powerpc-gfxopt
3528 @itemx no-powerpc-gfxopt
3529 @cindex @code{target("powerpc-gfxopt")} attribute
3530 Generate code that uses (does not use) the optional PowerPC
3531 architecture instructions in the Graphics group, including
3532 floating-point select.
3533
3534 @item powerpc-gpopt
3535 @itemx no-powerpc-gpopt
3536 @cindex @code{target("powerpc-gpopt")} attribute
3537 Generate code that uses (does not use) the optional PowerPC
3538 architecture instructions in the General Purpose group, including
3539 floating-point square root.
3540
3541 @item recip-precision
3542 @itemx no-recip-precision
3543 @cindex @code{target("recip-precision")} attribute
3544 Assume (do not assume) that the reciprocal estimate instructions
3545 provide higher precision estimates than is mandated by the powerpc
3546 ABI.
3547
3548 @item string
3549 @itemx no-string
3550 @cindex @code{target("string")} attribute
3551 Generate code that uses (does not use) the load string instructions
3552 and the store string word instructions to save multiple registers and
3553 do small block moves.
3554
3555 @item vsx
3556 @itemx no-vsx
3557 @cindex @code{target("vsx")} attribute
3558 Generate code that uses (does not use) vector/scalar (VSX)
3559 instructions, and also enable the use of built-in functions that allow
3560 more direct access to the VSX instruction set.  In 32-bit code, you
3561 cannot enable VSX or Altivec instructions unless
3562 @option{-mabi=altivec} was used on the command line.
3563
3564 @item friz
3565 @itemx no-friz
3566 @cindex @code{target("friz")} attribute
3567 Generate (do not generate) the @code{friz} instruction when the
3568 @option{-funsafe-math-optimizations} option is used to optimize
3569 rounding a floating point value to 64-bit integer and back to floating
3570 point.  The @code{friz} instruction does not return the same value if
3571 the floating point number is too large to fit in an integer.
3572
3573 @item avoid-indexed-addresses
3574 @itemx no-avoid-indexed-addresses
3575 @cindex @code{target("avoid-indexed-addresses")} attribute
3576 Generate code that tries to avoid (not avoid) the use of indexed load
3577 or store instructions.
3578
3579 @item paired
3580 @itemx no-paired
3581 @cindex @code{target("paired")} attribute
3582 Generate code that uses (does not use) the generation of PAIRED simd
3583 instructions.
3584
3585 @item longcall
3586 @itemx no-longcall
3587 @cindex @code{target("longcall")} attribute
3588 Generate code that assumes (does not assume) that all calls are far
3589 away so that a longer more expensive calling sequence is required.
3590
3591 @item cpu=@var{CPU}
3592 @cindex @code{target("cpu=@var{CPU}")} attribute
3593 Specify the architecture to generate code for when compiling the
3594 function.  If you select the @code{"target("cpu=power7)"} attribute when
3595 generating 32-bit code, VSX and Altivec instructions are not generated
3596 unless you use the @option{-mabi=altivec} option on the command line.
3597
3598 @item tune=@var{TUNE}
3599 @cindex @code{target("tune=@var{TUNE}")} attribute
3600 Specify the architecture to tune for when compiling the function.  If
3601 you do not specify the @code{target("tune=@var{TUNE}")} attribute and
3602 you do specify the @code{target("cpu=@var{CPU}")} attribute,
3603 compilation will tune for the @var{CPU} architecture, and not the
3604 default tuning specified on the command line.
3605 @end table
3606 @end table
3607 @end table
3608
3609 On the 386/x86_64 and PowerPC backends, you can use either multiple
3610 strings to specify multiple options, or you can separate the option
3611 with a comma (@code{,}).
3612
3613 On the 386/x86_64 and PowerPC backends, the inliner will not inline a
3614 function that has different target options than the caller, unless the
3615 callee has a subset of the target options of the caller.  For example
3616 a function declared with @code{target("sse3")} can inline a function
3617 with @code{target("sse2")}, since @code{-msse3} implies @code{-msse2}.
3618
3619 The @code{target} attribute is not implemented in GCC versions earlier
3620 than 4.4 for the i386/x86_64 and 4.6 for the PowerPC backends.  It is
3621 not currently implemented for other backends.
3622
3623 @item tiny_data
3624 @cindex tiny data section on the H8/300H and H8S
3625 Use this attribute on the H8/300H and H8S to indicate that the specified
3626 variable should be placed into the tiny data section.
3627 The compiler will generate more efficient code for loads and stores
3628 on data in the tiny data section.  Note the tiny data area is limited to
3629 slightly under 32kbytes of data.
3630
3631 @item trap_exit
3632 Use this attribute on the SH for an @code{interrupt_handler} to return using
3633 @code{trapa} instead of @code{rte}.  This attribute expects an integer
3634 argument specifying the trap number to be used.
3635
3636 @item unused
3637 @cindex @code{unused} attribute.
3638 This attribute, attached to a function, means that the function is meant
3639 to be possibly unused.  GCC will not produce a warning for this
3640 function.
3641
3642 @item used
3643 @cindex @code{used} attribute.
3644 This attribute, attached to a function, means that code must be emitted
3645 for the function even if it appears that the function is not referenced.
3646 This is useful, for example, when the function is referenced only in
3647 inline assembly.
3648
3649 @item version_id
3650 @cindex @code{version_id} attribute
3651 This IA64 HP-UX attribute, attached to a global variable or function, renames a
3652 symbol to contain a version string, thus allowing for function level
3653 versioning.  HP-UX system header files may use version level functioning
3654 for some system calls.
3655
3656 @smallexample
3657 extern int foo () __attribute__((version_id ("20040821")));
3658 @end smallexample
3659
3660 Calls to @var{foo} will be mapped to calls to @var{foo@{20040821@}}.
3661
3662 @item visibility ("@var{visibility_type}")
3663 @cindex @code{visibility} attribute
3664 This attribute affects the linkage of the declaration to which it is attached.
3665 There are four supported @var{visibility_type} values: default,
3666 hidden, protected or internal visibility.
3667
3668 @smallexample
3669 void __attribute__ ((visibility ("protected")))
3670 f () @{ /* @r{Do something.} */; @}
3671 int i __attribute__ ((visibility ("hidden")));
3672 @end smallexample
3673
3674 The possible values of @var{visibility_type} correspond to the
3675 visibility settings in the ELF gABI.
3676
3677 @table @dfn
3678 @c keep this list of visibilities in alphabetical order.
3679
3680 @item default
3681 Default visibility is the normal case for the object file format.
3682 This value is available for the visibility attribute to override other
3683 options that may change the assumed visibility of entities.
3684
3685 On ELF, default visibility means that the declaration is visible to other
3686 modules and, in shared libraries, means that the declared entity may be
3687 overridden.
3688
3689 On Darwin, default visibility means that the declaration is visible to
3690 other modules.
3691
3692 Default visibility corresponds to ``external linkage'' in the language.
3693
3694 @item hidden
3695 Hidden visibility indicates that the entity declared will have a new
3696 form of linkage, which we'll call ``hidden linkage''.  Two
3697 declarations of an object with hidden linkage refer to the same object
3698 if they are in the same shared object.
3699
3700 @item internal
3701 Internal visibility is like hidden visibility, but with additional
3702 processor specific semantics.  Unless otherwise specified by the
3703 psABI, GCC defines internal visibility to mean that a function is
3704 @emph{never} called from another module.  Compare this with hidden
3705 functions which, while they cannot be referenced directly by other
3706 modules, can be referenced indirectly via function pointers.  By
3707 indicating that a function cannot be called from outside the module,
3708 GCC may for instance omit the load of a PIC register since it is known
3709 that the calling function loaded the correct value.
3710
3711 @item protected
3712 Protected visibility is like default visibility except that it
3713 indicates that references within the defining module will bind to the
3714 definition in that module.  That is, the declared entity cannot be
3715 overridden by another module.
3716
3717 @end table
3718
3719 All visibilities are supported on many, but not all, ELF targets
3720 (supported when the assembler supports the @samp{.visibility}
3721 pseudo-op).  Default visibility is supported everywhere.  Hidden
3722 visibility is supported on Darwin targets.
3723
3724 The visibility attribute should be applied only to declarations which
3725 would otherwise have external linkage.  The attribute should be applied
3726 consistently, so that the same entity should not be declared with
3727 different settings of the attribute.
3728
3729 In C++, the visibility attribute applies to types as well as functions
3730 and objects, because in C++ types have linkage.  A class must not have
3731 greater visibility than its non-static data member types and bases,
3732 and class members default to the visibility of their class.  Also, a
3733 declaration without explicit visibility is limited to the visibility
3734 of its type.
3735
3736 In C++, you can mark member functions and static member variables of a
3737 class with the visibility attribute.  This is useful if you know a
3738 particular method or static member variable should only be used from
3739 one shared object; then you can mark it hidden while the rest of the
3740 class has default visibility.  Care must be taken to avoid breaking
3741 the One Definition Rule; for example, it is usually not useful to mark
3742 an inline method as hidden without marking the whole class as hidden.
3743
3744 A C++ namespace declaration can also have the visibility attribute.
3745 This attribute applies only to the particular namespace body, not to
3746 other definitions of the same namespace; it is equivalent to using
3747 @samp{#pragma GCC visibility} before and after the namespace
3748 definition (@pxref{Visibility Pragmas}).
3749
3750 In C++, if a template argument has limited visibility, this
3751 restriction is implicitly propagated to the template instantiation.
3752 Otherwise, template instantiations and specializations default to the
3753 visibility of their template.
3754
3755 If both the template and enclosing class have explicit visibility, the
3756 visibility from the template is used.
3757
3758 @item vliw
3759 @cindex @code{vliw} attribute
3760 On MeP, the @code{vliw} attribute tells the compiler to emit
3761 instructions in VLIW mode instead of core mode.  Note that this
3762 attribute is not allowed unless a VLIW coprocessor has been configured
3763 and enabled through command line options.
3764
3765 @item warn_unused_result
3766 @cindex @code{warn_unused_result} attribute
3767 The @code{warn_unused_result} attribute causes a warning to be emitted
3768 if a caller of the function with this attribute does not use its
3769 return value.  This is useful for functions where not checking
3770 the result is either a security problem or always a bug, such as
3771 @code{realloc}.
3772
3773 @smallexample
3774 int fn () __attribute__ ((warn_unused_result));
3775 int foo ()
3776 @{
3777   if (fn () < 0) return -1;
3778   fn ();
3779   return 0;
3780 @}
3781 @end smallexample
3782
3783 results in warning on line 5.
3784
3785 @item weak
3786 @cindex @code{weak} attribute
3787 The @code{weak} attribute causes the declaration to be emitted as a weak
3788 symbol rather than a global.  This is primarily useful in defining
3789 library functions which can be overridden in user code, though it can
3790 also be used with non-function declarations.  Weak symbols are supported
3791 for ELF targets, and also for a.out targets when using the GNU assembler
3792 and linker.
3793
3794 @item weakref
3795 @itemx weakref ("@var{target}")
3796 @cindex @code{weakref} attribute
3797 The @code{weakref} attribute marks a declaration as a weak reference.
3798 Without arguments, it should be accompanied by an @code{alias} attribute
3799 naming the target symbol.  Optionally, the @var{target} may be given as
3800 an argument to @code{weakref} itself.  In either case, @code{weakref}
3801 implicitly marks the declaration as @code{weak}.  Without a
3802 @var{target}, given as an argument to @code{weakref} or to @code{alias},
3803 @code{weakref} is equivalent to @code{weak}.
3804
3805 @smallexample
3806 static int x() __attribute__ ((weakref ("y")));
3807 /* is equivalent to... */
3808 static int x() __attribute__ ((weak, weakref, alias ("y")));
3809 /* and to... */
3810 static int x() __attribute__ ((weakref));
3811 static int x() __attribute__ ((alias ("y")));
3812 @end smallexample
3813
3814 A weak reference is an alias that does not by itself require a
3815 definition to be given for the target symbol.  If the target symbol is
3816 only referenced through weak references, then it becomes a @code{weak}
3817 undefined symbol.  If it is directly referenced, however, then such
3818 strong references prevail, and a definition will be required for the
3819 symbol, not necessarily in the same translation unit.
3820
3821 The effect is equivalent to moving all references to the alias to a
3822 separate translation unit, renaming the alias to the aliased symbol,
3823 declaring it as weak, compiling the two separate translation units and
3824 performing a reloadable link on them.
3825
3826 At present, a declaration to which @code{weakref} is attached can
3827 only be @code{static}.
3828
3829 @end table
3830
3831 You can specify multiple attributes in a declaration by separating them
3832 by commas within the double parentheses or by immediately following an
3833 attribute declaration with another attribute declaration.
3834
3835 @cindex @code{#pragma}, reason for not using
3836 @cindex pragma, reason for not using
3837 Some people object to the @code{__attribute__} feature, suggesting that
3838 ISO C's @code{#pragma} should be used instead.  At the time
3839 @code{__attribute__} was designed, there were two reasons for not doing
3840 this.
3841
3842 @enumerate
3843 @item
3844 It is impossible to generate @code{#pragma} commands from a macro.
3845
3846 @item
3847 There is no telling what the same @code{#pragma} might mean in another
3848 compiler.
3849 @end enumerate
3850
3851 These two reasons applied to almost any application that might have been
3852 proposed for @code{#pragma}.  It was basically a mistake to use
3853 @code{#pragma} for @emph{anything}.
3854
3855 The ISO C99 standard includes @code{_Pragma}, which now allows pragmas
3856 to be generated from macros.  In addition, a @code{#pragma GCC}
3857 namespace is now in use for GCC-specific pragmas.  However, it has been
3858 found convenient to use @code{__attribute__} to achieve a natural
3859 attachment of attributes to their corresponding declarations, whereas
3860 @code{#pragma GCC} is of use for constructs that do not naturally form
3861 part of the grammar.  @xref{Other Directives,,Miscellaneous
3862 Preprocessing Directives, cpp, The GNU C Preprocessor}.
3863
3864 @node Attribute Syntax
3865 @section Attribute Syntax
3866 @cindex attribute syntax
3867
3868 This section describes the syntax with which @code{__attribute__} may be
3869 used, and the constructs to which attribute specifiers bind, for the C
3870 language.  Some details may vary for C++ and Objective-C@.  Because of
3871 infelicities in the grammar for attributes, some forms described here
3872 may not be successfully parsed in all cases.
3873
3874 There are some problems with the semantics of attributes in C++.  For
3875 example, there are no manglings for attributes, although they may affect
3876 code generation, so problems may arise when attributed types are used in
3877 conjunction with templates or overloading.  Similarly, @code{typeid}
3878 does not distinguish between types with different attributes.  Support
3879 for attributes in C++ may be restricted in future to attributes on
3880 declarations only, but not on nested declarators.
3881
3882 @xref{Function Attributes}, for details of the semantics of attributes
3883 applying to functions.  @xref{Variable Attributes}, for details of the
3884 semantics of attributes applying to variables.  @xref{Type Attributes},
3885 for details of the semantics of attributes applying to structure, union
3886 and enumerated types.
3887
3888 An @dfn{attribute specifier} is of the form
3889 @code{__attribute__ ((@var{attribute-list}))}.  An @dfn{attribute list}
3890 is a possibly empty comma-separated sequence of @dfn{attributes}, where
3891 each attribute is one of the following:
3892
3893 @itemize @bullet
3894 @item
3895 Empty.  Empty attributes are ignored.
3896
3897 @item
3898 A word (which may be an identifier such as @code{unused}, or a reserved
3899 word such as @code{const}).
3900
3901 @item
3902 A word, followed by, in parentheses, parameters for the attribute.
3903 These parameters take one of the following forms:
3904
3905 @itemize @bullet
3906 @item
3907 An identifier.  For example, @code{mode} attributes use this form.
3908
3909 @item
3910 An identifier followed by a comma and a non-empty comma-separated list
3911 of expressions.  For example, @code{format} attributes use this form.
3912
3913 @item
3914 A possibly empty comma-separated list of expressions.  For example,
3915 @code{format_arg} attributes use this form with the list being a single
3916 integer constant expression, and @code{alias} attributes use this form
3917 with the list being a single string constant.
3918 @end itemize
3919 @end itemize
3920
3921 An @dfn{attribute specifier list} is a sequence of one or more attribute
3922 specifiers, not separated by any other tokens.
3923
3924 In GNU C, an attribute specifier list may appear after the colon following a
3925 label, other than a @code{case} or @code{default} label.  The only
3926 attribute it makes sense to use after a label is @code{unused}.  This
3927 feature is intended for code generated by programs which contains labels
3928 that may be unused but which is compiled with @option{-Wall}.  It would
3929 not normally be appropriate to use in it human-written code, though it
3930 could be useful in cases where the code that jumps to the label is
3931 contained within an @code{#ifdef} conditional.  GNU C++ only permits
3932 attributes on labels if the attribute specifier is immediately
3933 followed by a semicolon (i.e., the label applies to an empty
3934 statement).  If the semicolon is missing, C++ label attributes are
3935 ambiguous, as it is permissible for a declaration, which could begin
3936 with an attribute list, to be labelled in C++.  Declarations cannot be
3937 labelled in C90 or C99, so the ambiguity does not arise there.
3938
3939 An attribute specifier list may appear as part of a @code{struct},
3940 @code{union} or @code{enum} specifier.  It may go either immediately
3941 after the @code{struct}, @code{union} or @code{enum} keyword, or after
3942 the closing brace.  The former syntax is preferred.
3943 Where attribute specifiers follow the closing brace, they are considered
3944 to relate to the structure, union or enumerated type defined, not to any
3945 enclosing declaration the type specifier appears in, and the type
3946 defined is not complete until after the attribute specifiers.
3947 @c Otherwise, there would be the following problems: a shift/reduce
3948 @c conflict between attributes binding the struct/union/enum and
3949 @c binding to the list of specifiers/qualifiers; and "aligned"
3950 @c attributes could use sizeof for the structure, but the size could be
3951 @c changed later by "packed" attributes.
3952
3953 Otherwise, an attribute specifier appears as part of a declaration,
3954 counting declarations of unnamed parameters and type names, and relates
3955 to that declaration (which may be nested in another declaration, for
3956 example in the case of a parameter declaration), or to a particular declarator
3957 within a declaration.  Where an
3958 attribute specifier is applied to a parameter declared as a function or
3959 an array, it should apply to the function or array rather than the
3960 pointer to which the parameter is implicitly converted, but this is not
3961 yet correctly implemented.
3962
3963 Any list of specifiers and qualifiers at the start of a declaration may
3964 contain attribute specifiers, whether or not such a list may in that
3965 context contain storage class specifiers.  (Some attributes, however,
3966 are essentially in the nature of storage class specifiers, and only make
3967 sense where storage class specifiers may be used; for example,
3968 @code{section}.)  There is one necessary limitation to this syntax: the
3969 first old-style parameter declaration in a function definition cannot
3970 begin with an attribute specifier, because such an attribute applies to
3971 the function instead by syntax described below (which, however, is not
3972 yet implemented in this case).  In some other cases, attribute
3973 specifiers are permitted by this grammar but not yet supported by the
3974 compiler.  All attribute specifiers in this place relate to the
3975 declaration as a whole.  In the obsolescent usage where a type of
3976 @code{int} is implied by the absence of type specifiers, such a list of
3977 specifiers and qualifiers may be an attribute specifier list with no
3978 other specifiers or qualifiers.
3979
3980 At present, the first parameter in a function prototype must have some
3981 type specifier which is not an attribute specifier; this resolves an
3982 ambiguity in the interpretation of @code{void f(int
3983 (__attribute__((foo)) x))}, but is subject to change.  At present, if
3984 the parentheses of a function declarator contain only attributes then
3985 those attributes are ignored, rather than yielding an error or warning
3986 or implying a single parameter of type int, but this is subject to
3987 change.
3988
3989 An attribute specifier list may appear immediately before a declarator
3990 (other than the first) in a comma-separated list of declarators in a
3991 declaration of more than one identifier using a single list of
3992 specifiers and qualifiers.  Such attribute specifiers apply
3993 only to the identifier before whose declarator they appear.  For
3994 example, in
3995
3996 @smallexample
3997 __attribute__((noreturn)) void d0 (void),
3998     __attribute__((format(printf, 1, 2))) d1 (const char *, ...),
3999      d2 (void)
4000 @end smallexample
4001
4002 @noindent
4003 the @code{noreturn} attribute applies to all the functions
4004 declared; the @code{format} attribute only applies to @code{d1}.
4005
4006 An attribute specifier list may appear immediately before the comma,
4007 @code{=} or semicolon terminating the declaration of an identifier other
4008 than a function definition.  Such attribute specifiers apply
4009 to the declared object or function.  Where an
4010 assembler name for an object or function is specified (@pxref{Asm
4011 Labels}), the attribute must follow the @code{asm}
4012 specification.
4013
4014 An attribute specifier list may, in future, be permitted to appear after
4015 the declarator in a function definition (before any old-style parameter
4016 declarations or the function body).
4017
4018 Attribute specifiers may be mixed with type qualifiers appearing inside
4019 the @code{[]} of a parameter array declarator, in the C99 construct by
4020 which such qualifiers are applied to the pointer to which the array is
4021 implicitly converted.  Such attribute specifiers apply to the pointer,
4022 not to the array, but at present this is not implemented and they are
4023 ignored.
4024
4025 An attribute specifier list may appear at the start of a nested
4026 declarator.  At present, there are some limitations in this usage: the
4027 attributes correctly apply to the declarator, but for most individual
4028 attributes the semantics this implies are not implemented.
4029 When attribute specifiers follow the @code{*} of a pointer
4030 declarator, they may be mixed with any type qualifiers present.
4031 The following describes the formal semantics of this syntax.  It will make the
4032 most sense if you are familiar with the formal specification of
4033 declarators in the ISO C standard.
4034
4035 Consider (as in C99 subclause 6.7.5 paragraph 4) a declaration @code{T
4036 D1}, where @code{T} contains declaration specifiers that specify a type
4037 @var{Type} (such as @code{int}) and @code{D1} is a declarator that
4038 contains an identifier @var{ident}.  The type specified for @var{ident}
4039 for derived declarators whose type does not include an attribute
4040 specifier is as in the ISO C standard.
4041
4042 If @code{D1} has the form @code{( @var{attribute-specifier-list} D )},
4043 and the declaration @code{T D} specifies the type
4044 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
4045 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
4046 @var{attribute-specifier-list} @var{Type}'' for @var{ident}.
4047
4048 If @code{D1} has the form @code{*
4049 @var{type-qualifier-and-attribute-specifier-list} D}, and the
4050 declaration @code{T D} specifies the type
4051 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
4052 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
4053 @var{type-qualifier-and-attribute-specifier-list} pointer to @var{Type}'' for
4054 @var{ident}.
4055
4056 For example,
4057
4058 @smallexample
4059 void (__attribute__((noreturn)) ****f) (void);
4060 @end smallexample
4061
4062 @noindent
4063 specifies the type ``pointer to pointer to pointer to pointer to
4064 non-returning function returning @code{void}''.  As another example,
4065
4066 @smallexample
4067 char *__attribute__((aligned(8))) *f;
4068 @end smallexample
4069
4070 @noindent
4071 specifies the type ``pointer to 8-byte-aligned pointer to @code{char}''.
4072 Note again that this does not work with most attributes; for example,
4073 the usage of @samp{aligned} and @samp{noreturn} attributes given above
4074 is not yet supported.
4075
4076 For compatibility with existing code written for compiler versions that
4077 did not implement attributes on nested declarators, some laxity is
4078 allowed in the placing of attributes.  If an attribute that only applies
4079 to types is applied to a declaration, it will be treated as applying to
4080 the type of that declaration.  If an attribute that only applies to
4081 declarations is applied to the type of a declaration, it will be treated
4082 as applying to that declaration; and, for compatibility with code
4083 placing the attributes immediately before the identifier declared, such
4084 an attribute applied to a function return type will be treated as
4085 applying to the function type, and such an attribute applied to an array
4086 element type will be treated as applying to the array type.  If an
4087 attribute that only applies to function types is applied to a
4088 pointer-to-function type, it will be treated as applying to the pointer
4089 target type; if such an attribute is applied to a function return type
4090 that is not a pointer-to-function type, it will be treated as applying
4091 to the function type.
4092
4093 @node Function Prototypes
4094 @section Prototypes and Old-Style Function Definitions
4095 @cindex function prototype declarations
4096 @cindex old-style function definitions
4097 @cindex promotion of formal parameters
4098
4099 GNU C extends ISO C to allow a function prototype to override a later
4100 old-style non-prototype definition.  Consider the following example:
4101
4102 @smallexample
4103 /* @r{Use prototypes unless the compiler is old-fashioned.}  */
4104 #ifdef __STDC__
4105 #define P(x) x
4106 #else
4107 #define P(x) ()
4108 #endif
4109
4110 /* @r{Prototype function declaration.}  */
4111 int isroot P((uid_t));
4112
4113 /* @r{Old-style function definition.}  */
4114 int
4115 isroot (x)   /* @r{??? lossage here ???} */
4116      uid_t x;
4117 @{
4118   return x == 0;
4119 @}
4120 @end smallexample
4121
4122 Suppose the type @code{uid_t} happens to be @code{short}.  ISO C does
4123 not allow this example, because subword arguments in old-style
4124 non-prototype definitions are promoted.  Therefore in this example the
4125 function definition's argument is really an @code{int}, which does not
4126 match the prototype argument type of @code{short}.
4127
4128 This restriction of ISO C makes it hard to write code that is portable
4129 to traditional C compilers, because the programmer does not know
4130 whether the @code{uid_t} type is @code{short}, @code{int}, or
4131 @code{long}.  Therefore, in cases like these GNU C allows a prototype
4132 to override a later old-style definition.  More precisely, in GNU C, a
4133 function prototype argument type overrides the argument type specified
4134 by a later old-style definition if the former type is the same as the
4135 latter type before promotion.  Thus in GNU C the above example is
4136 equivalent to the following:
4137
4138 @smallexample
4139 int isroot (uid_t);
4140
4141 int
4142 isroot (uid_t x)
4143 @{
4144   return x == 0;
4145 @}
4146 @end smallexample
4147
4148 @noindent
4149 GNU C++ does not support old-style function definitions, so this
4150 extension is irrelevant.
4151
4152 @node C++ Comments
4153 @section C++ Style Comments
4154 @cindex @code{//}
4155 @cindex C++ comments
4156 @cindex comments, C++ style
4157
4158 In GNU C, you may use C++ style comments, which start with @samp{//} and
4159 continue until the end of the line.  Many other C implementations allow
4160 such comments, and they are included in the 1999 C standard.  However,
4161 C++ style comments are not recognized if you specify an @option{-std}
4162 option specifying a version of ISO C before C99, or @option{-ansi}
4163 (equivalent to @option{-std=c90}).
4164
4165 @node Dollar Signs
4166 @section Dollar Signs in Identifier Names
4167 @cindex $
4168 @cindex dollar signs in identifier names
4169 @cindex identifier names, dollar signs in
4170
4171 In GNU C, you may normally use dollar signs in identifier names.
4172 This is because many traditional C implementations allow such identifiers.
4173 However, dollar signs in identifiers are not supported on a few target
4174 machines, typically because the target assembler does not allow them.
4175
4176 @node Character Escapes
4177 @section The Character @key{ESC} in Constants
4178
4179 You can use the sequence @samp{\e} in a string or character constant to
4180 stand for the ASCII character @key{ESC}.
4181
4182 @node Alignment
4183 @section Inquiring on Alignment of Types or Variables
4184 @cindex alignment
4185 @cindex type alignment
4186 @cindex variable alignment
4187
4188 The keyword @code{__alignof__} allows you to inquire about how an object
4189 is aligned, or the minimum alignment usually required by a type.  Its
4190 syntax is just like @code{sizeof}.
4191
4192 For example, if the target machine requires a @code{double} value to be
4193 aligned on an 8-byte boundary, then @code{__alignof__ (double)} is 8.
4194 This is true on many RISC machines.  On more traditional machine
4195 designs, @code{__alignof__ (double)} is 4 or even 2.
4196
4197 Some machines never actually require alignment; they allow reference to any
4198 data type even at an odd address.  For these machines, @code{__alignof__}
4199 reports the smallest alignment that GCC will give the data type, usually as
4200 mandated by the target ABI.
4201
4202 If the operand of @code{__alignof__} is an lvalue rather than a type,
4203 its value is the required alignment for its type, taking into account
4204 any minimum alignment specified with GCC's @code{__attribute__}
4205 extension (@pxref{Variable Attributes}).  For example, after this
4206 declaration:
4207
4208 @smallexample
4209 struct foo @{ int x; char y; @} foo1;
4210 @end smallexample
4211
4212 @noindent
4213 the value of @code{__alignof__ (foo1.y)} is 1, even though its actual
4214 alignment is probably 2 or 4, the same as @code{__alignof__ (int)}.
4215
4216 It is an error to ask for the alignment of an incomplete type.
4217
4218 @node Variable Attributes
4219 @section Specifying Attributes of Variables
4220 @cindex attribute of variables
4221 @cindex variable attributes
4222
4223 The keyword @code{__attribute__} allows you to specify special
4224 attributes of variables or structure fields.  This keyword is followed
4225 by an attribute specification inside double parentheses.  Some
4226 attributes are currently defined generically for variables.
4227 Other attributes are defined for variables on particular target
4228 systems.  Other attributes are available for functions
4229 (@pxref{Function Attributes}) and for types (@pxref{Type Attributes}).
4230 Other front ends might define more attributes
4231 (@pxref{C++ Extensions,,Extensions to the C++ Language}).
4232
4233 You may also specify attributes with @samp{__} preceding and following
4234 each keyword.  This allows you to use them in header files without
4235 being concerned about a possible macro of the same name.  For example,
4236 you may use @code{__aligned__} instead of @code{aligned}.
4237
4238 @xref{Attribute Syntax}, for details of the exact syntax for using
4239 attributes.
4240
4241 @table @code
4242 @cindex @code{aligned} attribute
4243 @item aligned (@var{alignment})
4244 This attribute specifies a minimum alignment for the variable or
4245 structure field, measured in bytes.  For example, the declaration:
4246
4247 @smallexample
4248 int x __attribute__ ((aligned (16))) = 0;
4249 @end smallexample
4250
4251 @noindent
4252 causes the compiler to allocate the global variable @code{x} on a
4253 16-byte boundary.  On a 68040, this could be used in conjunction with
4254 an @code{asm} expression to access the @code{move16} instruction which
4255 requires 16-byte aligned operands.
4256
4257 You can also specify the alignment of structure fields.  For example, to
4258 create a double-word aligned @code{int} pair, you could write:
4259
4260 @smallexample
4261 struct foo @{ int x[2] __attribute__ ((aligned (8))); @};
4262 @end smallexample
4263
4264 @noindent
4265 This is an alternative to creating a union with a @code{double} member
4266 that forces the union to be double-word aligned.
4267
4268 As in the preceding examples, you can explicitly specify the alignment
4269 (in bytes) that you wish the compiler to use for a given variable or
4270 structure field.  Alternatively, you can leave out the alignment factor
4271 and just ask the compiler to align a variable or field to the
4272 default alignment for the target architecture you are compiling for.
4273 The default alignment is sufficient for all scalar types, but may not be
4274 enough for all vector types on a target which supports vector operations.
4275 The default alignment is fixed for a particular target ABI.
4276
4277 Gcc also provides a target specific macro @code{__BIGGEST_ALIGNMENT__},
4278 which is the largest alignment ever used for any data type on the
4279 target machine you are compiling for.  For example, you could write:
4280
4281 @smallexample
4282 short array[3] __attribute__ ((aligned (__BIGGEST_ALIGNMENT__)));
4283 @end smallexample
4284
4285 The compiler automatically sets the alignment for the declared
4286 variable or field to @code{__BIGGEST_ALIGNMENT__}.  Doing this can
4287 often make copy operations more efficient, because the compiler can
4288 use whatever instructions copy the biggest chunks of memory when
4289 performing copies to or from the variables or fields that you have
4290 aligned this way.  Note that the value of @code{__BIGGEST_ALIGNMENT__}
4291 may change depending on command line options.
4292
4293 When used on a struct, or struct member, the @code{aligned} attribute can
4294 only increase the alignment; in order to decrease it, the @code{packed}
4295 attribute must be specified as well.  When used as part of a typedef, the
4296 @code{aligned} attribute can both increase and decrease alignment, and
4297 specifying the @code{packed} attribute will generate a warning.
4298
4299 Note that the effectiveness of @code{aligned} attributes may be limited
4300 by inherent limitations in your linker.  On many systems, the linker is
4301 only able to arrange for variables to be aligned up to a certain maximum
4302 alignment.  (For some linkers, the maximum supported alignment may
4303 be very very small.)  If your linker is only able to align variables
4304 up to a maximum of 8 byte alignment, then specifying @code{aligned(16)}
4305 in an @code{__attribute__} will still only provide you with 8 byte
4306 alignment.  See your linker documentation for further information.
4307
4308 The @code{aligned} attribute can also be used for functions 
4309 (@pxref{Function Attributes}.)
4310
4311 @item cleanup (@var{cleanup_function})
4312 @cindex @code{cleanup} attribute
4313 The @code{cleanup} attribute runs a function when the variable goes
4314 out of scope.  This attribute can only be applied to auto function
4315 scope variables; it may not be applied to parameters or variables
4316 with static storage duration.  The function must take one parameter,
4317 a pointer to a type compatible with the variable.  The return value
4318 of the function (if any) is ignored.
4319
4320 If @option{-fexceptions} is enabled, then @var{cleanup_function}
4321 will be run during the stack unwinding that happens during the
4322 processing of the exception.  Note that the @code{cleanup} attribute
4323 does not allow the exception to be caught, only to perform an action.
4324 It is undefined what happens if @var{cleanup_function} does not
4325 return normally.
4326
4327 @item common
4328 @itemx nocommon
4329 @cindex @code{common} attribute
4330 @cindex @code{nocommon} attribute
4331 @opindex fcommon
4332 @opindex fno-common
4333 The @code{common} attribute requests GCC to place a variable in
4334 ``common'' storage.  The @code{nocommon} attribute requests the
4335 opposite---to allocate space for it directly.
4336
4337 These attributes override the default chosen by the
4338 @option{-fno-common} and @option{-fcommon} flags respectively.
4339
4340 @item deprecated
4341 @itemx deprecated (@var{msg})
4342 @cindex @code{deprecated} attribute
4343 The @code{deprecated} attribute results in a warning if the variable
4344 is used anywhere in the source file.  This is useful when identifying
4345 variables that are expected to be removed in a future version of a
4346 program.  The warning also includes the location of the declaration
4347 of the deprecated variable, to enable users to easily find further
4348 information about why the variable is deprecated, or what they should
4349 do instead.  Note that the warning only occurs for uses:
4350
4351 @smallexample
4352 extern int old_var __attribute__ ((deprecated));
4353 extern int old_var;
4354 int new_fn () @{ return old_var; @}
4355 @end smallexample
4356
4357 results in a warning on line 3 but not line 2.  The optional msg
4358 argument, which must be a string, will be printed in the warning if
4359 present.
4360
4361 The @code{deprecated} attribute can also be used for functions and
4362 types (@pxref{Function Attributes}, @pxref{Type Attributes}.)
4363
4364 @item mode (@var{mode})
4365 @cindex @code{mode} attribute
4366 This attribute specifies the data type for the declaration---whichever
4367 type corresponds to the mode @var{mode}.  This in effect lets you
4368 request an integer or floating point type according to its width.
4369
4370 You may also specify a mode of @samp{byte} or @samp{__byte__} to
4371 indicate the mode corresponding to a one-byte integer, @samp{word} or
4372 @samp{__word__} for the mode of a one-word integer, and @samp{pointer}
4373 or @samp{__pointer__} for the mode used to represent pointers.
4374
4375 @item packed
4376 @cindex @code{packed} attribute
4377 The @code{packed} attribute specifies that a variable or structure field
4378 should have the smallest possible alignment---one byte for a variable,
4379 and one bit for a field, unless you specify a larger value with the
4380 @code{aligned} attribute.
4381
4382 Here is a structure in which the field @code{x} is packed, so that it
4383 immediately follows @code{a}:
4384
4385 @smallexample
4386 struct foo
4387 @{
4388   char a;
4389   int x[2] __attribute__ ((packed));
4390 @};
4391 @end smallexample
4392
4393 @emph{Note:} The 4.1, 4.2 and 4.3 series of GCC ignore the
4394 @code{packed} attribute on bit-fields of type @code{char}.  This has
4395 been fixed in GCC 4.4 but the change can lead to differences in the
4396 structure layout.  See the documentation of
4397 @option{-Wpacked-bitfield-compat} for more information.
4398
4399 @item section ("@var{section-name}")
4400 @cindex @code{section} variable attribute
4401 Normally, the compiler places the objects it generates in sections like
4402 @code{data} and @code{bss}.  Sometimes, however, you need additional sections,
4403 or you need certain particular variables to appear in special sections,
4404 for example to map to special hardware.  The @code{section}
4405 attribute specifies that a variable (or function) lives in a particular
4406 section.  For example, this small program uses several specific section names:
4407
4408 @smallexample
4409 struct duart a __attribute__ ((section ("DUART_A"))) = @{ 0 @};
4410 struct duart b __attribute__ ((section ("DUART_B"))) = @{ 0 @};
4411 char stack[10000] __attribute__ ((section ("STACK"))) = @{ 0 @};
4412 int init_data __attribute__ ((section ("INITDATA")));
4413
4414 main()
4415 @{
4416   /* @r{Initialize stack pointer} */
4417   init_sp (stack + sizeof (stack));
4418
4419   /* @r{Initialize initialized data} */
4420   memcpy (&init_data, &data, &edata - &data);
4421
4422   /* @r{Turn on the serial ports} */
4423   init_duart (&a);
4424   init_duart (&b);
4425 @}
4426 @end smallexample
4427
4428 @noindent
4429 Use the @code{section} attribute with
4430 @emph{global} variables and not @emph{local} variables,
4431 as shown in the example.
4432
4433 You may use the @code{section} attribute with initialized or
4434 uninitialized global variables but the linker requires
4435 each object be defined once, with the exception that uninitialized
4436 variables tentatively go in the @code{common} (or @code{bss}) section
4437 and can be multiply ``defined''.  Using the @code{section} attribute
4438 will change what section the variable goes into and may cause the
4439 linker to issue an error if an uninitialized variable has multiple
4440 definitions.  You can force a variable to be initialized with the
4441 @option{-fno-common} flag or the @code{nocommon} attribute.
4442
4443 Some file formats do not support arbitrary sections so the @code{section}
4444 attribute is not available on all platforms.
4445 If you need to map the entire contents of a module to a particular
4446 section, consider using the facilities of the linker instead.
4447
4448 @item shared
4449 @cindex @code{shared} variable attribute
4450 On Microsoft Windows, in addition to putting variable definitions in a named
4451 section, the section can also be shared among all running copies of an
4452 executable or DLL@.  For example, this small program defines shared data
4453 by putting it in a named section @code{shared} and marking the section
4454 shareable:
4455
4456 @smallexample
4457 int foo __attribute__((section ("shared"), shared)) = 0;
4458
4459 int
4460 main()
4461 @{
4462   /* @r{Read and write foo.  All running
4463      copies see the same value.}  */
4464   return 0;
4465 @}
4466 @end smallexample
4467
4468 @noindent
4469 You may only use the @code{shared} attribute along with @code{section}
4470 attribute with a fully initialized global definition because of the way
4471 linkers work.  See @code{section} attribute for more information.
4472
4473 The @code{shared} attribute is only available on Microsoft Windows@.
4474
4475 @item tls_model ("@var{tls_model}")
4476 @cindex @code{tls_model} attribute
4477 The @code{tls_model} attribute sets thread-local storage model
4478 (@pxref{Thread-Local}) of a particular @code{__thread} variable,
4479 overriding @option{-ftls-model=} command-line switch on a per-variable
4480 basis.
4481 The @var{tls_model} argument should be one of @code{global-dynamic},
4482 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
4483
4484 Not all targets support this attribute.
4485
4486 @item unused
4487 This attribute, attached to a variable, means that the variable is meant
4488 to be possibly unused.  GCC will not produce a warning for this
4489 variable.
4490
4491 @item used
4492 This attribute, attached to a variable, means that the variable must be
4493 emitted even if it appears that the variable is not referenced.
4494
4495 @item vector_size (@var{bytes})
4496 This attribute specifies the vector size for the variable, measured in
4497 bytes.  For example, the declaration:
4498
4499 @smallexample
4500 int foo __attribute__ ((vector_size (16)));
4501 @end smallexample
4502
4503 @noindent
4504 causes the compiler to set the mode for @code{foo}, to be 16 bytes,
4505 divided into @code{int} sized units.  Assuming a 32-bit int (a vector of
4506 4 units of 4 bytes), the corresponding mode of @code{foo} will be V4SI@.
4507
4508 This attribute is only applicable to integral and float scalars,
4509 although arrays, pointers, and function return values are allowed in
4510 conjunction with this construct.
4511
4512 Aggregates with this attribute are invalid, even if they are of the same
4513 size as a corresponding scalar.  For example, the declaration:
4514
4515 @smallexample
4516 struct S @{ int a; @};
4517 struct S  __attribute__ ((vector_size (16))) foo;
4518 @end smallexample
4519
4520 @noindent
4521 is invalid even if the size of the structure is the same as the size of
4522 the @code{int}.
4523
4524 @item selectany
4525 The @code{selectany} attribute causes an initialized global variable to
4526 have link-once semantics.  When multiple definitions of the variable are
4527 encountered by the linker, the first is selected and the remainder are
4528 discarded.  Following usage by the Microsoft compiler, the linker is told
4529 @emph{not} to warn about size or content differences of the multiple
4530 definitions.
4531
4532 Although the primary usage of this attribute is for POD types, the
4533 attribute can also be applied to global C++ objects that are initialized
4534 by a constructor.  In this case, the static initialization and destruction
4535 code for the object is emitted in each translation defining the object,
4536 but the calls to the constructor and destructor are protected by a
4537 link-once guard variable.
4538
4539 The @code{selectany} attribute is only available on Microsoft Windows
4540 targets.  You can use @code{__declspec (selectany)} as a synonym for
4541 @code{__attribute__ ((selectany))} for compatibility with other
4542 compilers.
4543
4544 @item weak
4545 The @code{weak} attribute is described in @ref{Function Attributes}.
4546
4547 @item dllimport
4548 The @code{dllimport} attribute is described in @ref{Function Attributes}.
4549
4550 @item dllexport
4551 The @code{dllexport} attribute is described in @ref{Function Attributes}.
4552
4553 @end table
4554
4555 @subsection Blackfin Variable Attributes
4556
4557 Three attributes are currently defined for the Blackfin.
4558
4559 @table @code
4560 @item l1_data
4561 @itemx l1_data_A
4562 @itemx l1_data_B
4563 @cindex @code{l1_data} variable attribute
4564 @cindex @code{l1_data_A} variable attribute
4565 @cindex @code{l1_data_B} variable attribute
4566 Use these attributes on the Blackfin to place the variable into L1 Data SRAM.
4567 Variables with @code{l1_data} attribute will be put into the specific section
4568 named @code{.l1.data}. Those with @code{l1_data_A} attribute will be put into
4569 the specific section named @code{.l1.data.A}. Those with @code{l1_data_B}
4570 attribute will be put into the specific section named @code{.l1.data.B}.
4571
4572 @item l2
4573 @cindex @code{l2} variable attribute
4574 Use this attribute on the Blackfin to place the variable into L2 SRAM.
4575 Variables with @code{l2} attribute will be put into the specific section
4576 named @code{.l2.data}.
4577 @end table
4578
4579 @subsection M32R/D Variable Attributes
4580
4581 One attribute is currently defined for the M32R/D@.
4582
4583 @table @code
4584 @item model (@var{model-name})
4585 @cindex variable addressability on the M32R/D
4586 Use this attribute on the M32R/D to set the addressability of an object.
4587 The identifier @var{model-name} is one of @code{small}, @code{medium},
4588 or @code{large}, representing each of the code models.
4589
4590 Small model objects live in the lower 16MB of memory (so that their
4591 addresses can be loaded with the @code{ld24} instruction).
4592
4593 Medium and large model objects may live anywhere in the 32-bit address space
4594 (the compiler will generate @code{seth/add3} instructions to load their
4595 addresses).
4596 @end table
4597
4598 @anchor{MeP Variable Attributes}
4599 @subsection MeP Variable Attributes
4600
4601 The MeP target has a number of addressing modes and busses.  The
4602 @code{near} space spans the standard memory space's first 16 megabytes
4603 (24 bits).  The @code{far} space spans the entire 32-bit memory space.
4604 The @code{based} space is a 128 byte region in the memory space which
4605 is addressed relative to the @code{$tp} register.  The @code{tiny}
4606 space is a 65536 byte region relative to the @code{$gp} register.  In
4607 addition to these memory regions, the MeP target has a separate 16-bit
4608 control bus which is specified with @code{cb} attributes.
4609
4610 @table @code
4611
4612 @item based
4613 Any variable with the @code{based} attribute will be assigned to the
4614 @code{.based} section, and will be accessed with relative to the
4615 @code{$tp} register.
4616
4617 @item tiny
4618 Likewise, the @code{tiny} attribute assigned variables to the
4619 @code{.tiny} section, relative to the @code{$gp} register.
4620
4621 @item near
4622 Variables with the @code{near} attribute are assumed to have addresses
4623 that fit in a 24-bit addressing mode.  This is the default for large
4624 variables (@code{-mtiny=4} is the default) but this attribute can
4625 override @code{-mtiny=} for small variables, or override @code{-ml}.
4626
4627 @item far
4628 Variables with the @code{far} attribute are addressed using a full
4629 32-bit address.  Since this covers the entire memory space, this
4630 allows modules to make no assumptions about where variables might be
4631 stored.
4632
4633 @item io
4634 @itemx io (@var{addr})
4635 Variables with the @code{io} attribute are used to address
4636 memory-mapped peripherals.  If an address is specified, the variable
4637 is assigned that address, else it is not assigned an address (it is
4638 assumed some other module will assign an address).  Example:
4639
4640 @example
4641 int timer_count __attribute__((io(0x123)));
4642 @end example
4643
4644 @item cb
4645 @itemx cb (@var{addr})
4646 Variables with the @code{cb} attribute are used to access the control
4647 bus, using special instructions.  @code{addr} indicates the control bus
4648 address.  Example:
4649
4650 @example
4651 int cpu_clock __attribute__((cb(0x123)));
4652 @end example
4653
4654 @end table
4655
4656 @anchor{i386 Variable Attributes}
4657 @subsection i386 Variable Attributes
4658
4659 Two attributes are currently defined for i386 configurations:
4660 @code{ms_struct} and @code{gcc_struct}
4661
4662 @table @code
4663 @item ms_struct
4664 @itemx gcc_struct
4665 @cindex @code{ms_struct} attribute
4666 @cindex @code{gcc_struct} attribute
4667
4668 If @code{packed} is used on a structure, or if bit-fields are used
4669 it may be that the Microsoft ABI packs them differently
4670 than GCC would normally pack them.  Particularly when moving packed
4671 data between functions compiled with GCC and the native Microsoft compiler
4672 (either via function call or as data in a file), it may be necessary to access
4673 either format.
4674
4675 Currently @option{-m[no-]ms-bitfields} is provided for the Microsoft Windows X86
4676 compilers to match the native Microsoft compiler.
4677
4678 The Microsoft structure layout algorithm is fairly simple with the exception
4679 of the bitfield packing:
4680
4681 The padding and alignment of members of structures and whether a bit field
4682 can straddle a storage-unit boundary
4683
4684 @enumerate
4685 @item Structure members are stored sequentially in the order in which they are
4686 declared: the first member has the lowest memory address and the last member
4687 the highest.
4688
4689 @item Every data object has an alignment-requirement. The alignment-requirement
4690 for all data except structures, unions, and arrays is either the size of the
4691 object or the current packing size (specified with either the aligned attribute
4692 or the pack pragma), whichever is less. For structures,  unions, and arrays,
4693 the alignment-requirement is the largest alignment-requirement of its members.
4694 Every object is allocated an offset so that:
4695
4696 offset %  alignment-requirement == 0
4697
4698 @item Adjacent bit fields are packed into the same 1-, 2-, or 4-byte allocation
4699 unit if the integral types are the same size and if the next bit field fits
4700 into the current allocation unit without crossing the boundary imposed by the
4701 common alignment requirements of the bit fields.
4702 @end enumerate
4703
4704 Handling of zero-length bitfields:
4705
4706 MSVC interprets zero-length bitfields in the following ways:
4707
4708 @enumerate
4709 @item If a zero-length bitfield is inserted between two bitfields that would
4710 normally be coalesced, the bitfields will not be coalesced.
4711
4712 For example:
4713
4714 @smallexample
4715 struct
4716  @{
4717    unsigned long bf_1 : 12;
4718    unsigned long : 0;
4719    unsigned long bf_2 : 12;
4720  @} t1;
4721 @end smallexample
4722
4723 The size of @code{t1} would be 8 bytes with the zero-length bitfield.  If the
4724 zero-length bitfield were removed, @code{t1}'s size would be 4 bytes.
4725
4726 @item If a zero-length bitfield is inserted after a bitfield, @code{foo}, and the
4727 alignment of the zero-length bitfield is greater than the member that follows it,
4728 @code{bar}, @code{bar} will be aligned as the type of the zero-length bitfield.
4729
4730 For example:
4731
4732 @smallexample
4733 struct
4734  @{
4735    char foo : 4;
4736    short : 0;
4737    char bar;
4738  @} t2;
4739
4740 struct
4741  @{
4742    char foo : 4;
4743    short : 0;
4744    double bar;
4745  @} t3;
4746 @end smallexample
4747
4748 For @code{t2}, @code{bar} will be placed at offset 2, rather than offset 1.
4749 Accordingly, the size of @code{t2} will be 4.  For @code{t3}, the zero-length
4750 bitfield will not affect the alignment of @code{bar} or, as a result, the size
4751 of the structure.
4752
4753 Taking this into account, it is important to note the following:
4754
4755 @enumerate
4756 @item If a zero-length bitfield follows a normal bitfield, the type of the
4757 zero-length bitfield may affect the alignment of the structure as whole. For
4758 example, @code{t2} has a size of 4 bytes, since the zero-length bitfield follows a
4759 normal bitfield, and is of type short.
4760
4761 @item Even if a zero-length bitfield is not followed by a normal bitfield, it may
4762 still affect the alignment of the structure:
4763
4764 @smallexample
4765 struct
4766  @{
4767    char foo : 6;
4768    long : 0;
4769  @} t4;
4770 @end smallexample
4771
4772 Here, @code{t4} will take up 4 bytes.
4773 @end enumerate
4774
4775 @item Zero-length bitfields following non-bitfield members are ignored:
4776
4777 @smallexample
4778 struct
4779  @{
4780    char foo;
4781    long : 0;
4782    char bar;
4783  @} t5;
4784 @end smallexample
4785
4786 Here, @code{t5} will take up 2 bytes.
4787 @end enumerate
4788 @end table
4789
4790 @subsection PowerPC Variable Attributes
4791
4792 Three attributes currently are defined for PowerPC configurations:
4793 @code{altivec}, @code{ms_struct} and @code{gcc_struct}.
4794
4795 For full documentation of the struct attributes please see the
4796 documentation in @ref{i386 Variable Attributes}.
4797
4798 For documentation of @code{altivec} attribute please see the
4799 documentation in @ref{PowerPC Type Attributes}.
4800
4801 @subsection SPU Variable Attributes
4802
4803 The SPU supports the @code{spu_vector} attribute for variables.  For
4804 documentation of this attribute please see the documentation in
4805 @ref{SPU Type Attributes}.
4806
4807 @subsection Xstormy16 Variable Attributes
4808
4809 One attribute is currently defined for xstormy16 configurations:
4810 @code{below100}.
4811
4812 @table @code
4813 @item below100
4814 @cindex @code{below100} attribute
4815
4816 If a variable has the @code{below100} attribute (@code{BELOW100} is
4817 allowed also), GCC will place the variable in the first 0x100 bytes of
4818 memory and use special opcodes to access it.  Such variables will be
4819 placed in either the @code{.bss_below100} section or the
4820 @code{.data_below100} section.
4821
4822 @end table
4823
4824 @subsection AVR Variable Attributes
4825
4826 @table @code
4827 @item progmem
4828 @cindex @code{progmem} variable attribute
4829 The @code{progmem} attribute is used on the AVR to place data in the Program
4830 Memory address space. The AVR is a Harvard Architecture processor and data
4831 normally resides in the Data Memory address space.
4832 @end table
4833
4834 @node Type Attributes
4835 @section Specifying Attributes of Types
4836 @cindex attribute of types
4837 @cindex type attributes
4838
4839 The keyword @code{__attribute__} allows you to specify special
4840 attributes of @code{struct} and @code{union} types when you define
4841 such types.  This keyword is followed by an attribute specification
4842 inside double parentheses.  Seven attributes are currently defined for
4843 types: @code{aligned}, @code{packed}, @code{transparent_union},
4844 @code{unused}, @code{deprecated}, @code{visibility}, and
4845 @code{may_alias}.  Other attributes are defined for functions
4846 (@pxref{Function Attributes}) and for variables (@pxref{Variable
4847 Attributes}).
4848
4849 You may also specify any one of these attributes with @samp{__}
4850 preceding and following its keyword.  This allows you to use these
4851 attributes in header files without being concerned about a possible
4852 macro of the same name.  For example, you may use @code{__aligned__}
4853 instead of @code{aligned}.
4854
4855 You may specify type attributes in an enum, struct or union type
4856 declaration or definition, or for other types in a @code{typedef}
4857 declaration.
4858
4859 For an enum, struct or union type, you may specify attributes either
4860 between the enum, struct or union tag and the name of the type, or
4861 just past the closing curly brace of the @emph{definition}.  The
4862 former syntax is preferred.
4863
4864 @xref{Attribute Syntax}, for details of the exact syntax for using
4865 attributes.
4866
4867 @table @code
4868 @cindex @code{aligned} attribute
4869 @item aligned (@var{alignment})
4870 This attribute specifies a minimum alignment (in bytes) for variables
4871 of the specified type.  For example, the declarations:
4872
4873 @smallexample
4874 struct S @{ short f[3]; @} __attribute__ ((aligned (8)));
4875 typedef int more_aligned_int __attribute__ ((aligned (8)));
4876 @end smallexample
4877
4878 @noindent
4879 force the compiler to insure (as far as it can) that each variable whose
4880 type is @code{struct S} or @code{more_aligned_int} will be allocated and
4881 aligned @emph{at least} on a 8-byte boundary.  On a SPARC, having all
4882 variables of type @code{struct S} aligned to 8-byte boundaries allows
4883 the compiler to use the @code{ldd} and @code{std} (doubleword load and
4884 store) instructions when copying one variable of type @code{struct S} to
4885 another, thus improving run-time efficiency.
4886
4887 Note that the alignment of any given @code{struct} or @code{union} type
4888 is required by the ISO C standard to be at least a perfect multiple of
4889 the lowest common multiple of the alignments of all of the members of
4890 the @code{struct} or @code{union} in question.  This means that you @emph{can}
4891 effectively adjust the alignment of a @code{struct} or @code{union}
4892 type by attaching an @code{aligned} attribute to any one of the members
4893 of such a type, but the notation illustrated in the example above is a
4894 more obvious, intuitive, and readable way to request the compiler to
4895 adjust the alignment of an entire @code{struct} or @code{union} type.
4896
4897 As in the preceding example, you can explicitly specify the alignment
4898 (in bytes) that you wish the compiler to use for a given @code{struct}
4899 or @code{union} type.  Alternatively, you can leave out the alignment factor
4900 and just ask the compiler to align a type to the maximum
4901 useful alignment for the target machine you are compiling for.  For
4902 example, you could write:
4903
4904 @smallexample
4905 struct S @{ short f[3]; @} __attribute__ ((aligned));
4906 @end smallexample
4907
4908 Whenever you leave out the alignment factor in an @code{aligned}
4909 attribute specification, the compiler automatically sets the alignment
4910 for the type to the largest alignment which is ever used for any data
4911 type on the target machine you are compiling for.  Doing this can often
4912 make copy operations more efficient, because the compiler can use
4913 whatever instructions copy the biggest chunks of memory when performing
4914 copies to or from the variables which have types that you have aligned
4915 this way.
4916
4917 In the example above, if the size of each @code{short} is 2 bytes, then
4918 the size of the entire @code{struct S} type is 6 bytes.  The smallest
4919 power of two which is greater than or equal to that is 8, so the
4920 compiler sets the alignment for the entire @code{struct S} type to 8
4921 bytes.
4922
4923 Note that although you can ask the compiler to select a time-efficient
4924 alignment for a given type and then declare only individual stand-alone
4925 objects of that type, the compiler's ability to select a time-efficient
4926 alignment is primarily useful only when you plan to create arrays of
4927 variables having the relevant (efficiently aligned) type.  If you
4928 declare or use arrays of variables of an efficiently-aligned type, then
4929 it is likely that your program will also be doing pointer arithmetic (or
4930 subscripting, which amounts to the same thing) on pointers to the
4931 relevant type, and the code that the compiler generates for these
4932 pointer arithmetic operations will often be more efficient for
4933 efficiently-aligned types than for other types.
4934
4935 The @code{aligned} attribute can only increase the alignment; but you
4936 can decrease it by specifying @code{packed} as well.  See below.
4937
4938 Note that the effectiveness of @code{aligned} attributes may be limited
4939 by inherent limitations in your linker.  On many systems, the linker is
4940 only able to arrange for variables to be aligned up to a certain maximum
4941 alignment.  (For some linkers, the maximum supported alignment may
4942 be very very small.)  If your linker is only able to align variables
4943 up to a maximum of 8 byte alignment, then specifying @code{aligned(16)}
4944 in an @code{__attribute__} will still only provide you with 8 byte
4945 alignment.  See your linker documentation for further information.
4946
4947 @item packed
4948 This attribute, attached to @code{struct} or @code{union} type
4949 definition, specifies that each member (other than zero-width bitfields)
4950 of the structure or union is placed to minimize the memory required.  When
4951 attached to an @code{enum} definition, it indicates that the smallest
4952 integral type should be used.
4953
4954 @opindex fshort-enums
4955 Specifying this attribute for @code{struct} and @code{union} types is
4956 equivalent to specifying the @code{packed} attribute on each of the
4957 structure or union members.  Specifying the @option{-fshort-enums}
4958 flag on the line is equivalent to specifying the @code{packed}
4959 attribute on all @code{enum} definitions.
4960
4961 In the following example @code{struct my_packed_struct}'s members are
4962 packed closely together, but the internal layout of its @code{s} member
4963 is not packed---to do that, @code{struct my_unpacked_struct} would need to
4964 be packed too.
4965
4966 @smallexample
4967 struct my_unpacked_struct
4968  @{
4969     char c;
4970     int i;
4971  @};
4972
4973 struct __attribute__ ((__packed__)) my_packed_struct
4974   @{
4975      char c;
4976      int  i;
4977      struct my_unpacked_struct s;
4978   @};
4979 @end smallexample
4980
4981 You may only specify this attribute on the definition of an @code{enum},
4982 @code{struct} or @code{union}, not on a @code{typedef} which does not
4983 also define the enumerated type, structure or union.
4984
4985 @item transparent_union
4986 This attribute, attached to a @code{union} type definition, indicates
4987 that any function parameter having that union type causes calls to that
4988 function to be treated in a special way.
4989
4990 First, the argument corresponding to a transparent union type can be of
4991 any type in the union; no cast is required.  Also, if the union contains
4992 a pointer type, the corresponding argument can be a null pointer
4993 constant or a void pointer expression; and if the union contains a void
4994 pointer type, the corresponding argument can be any pointer expression.
4995 If the union member type is a pointer, qualifiers like @code{const} on
4996 the referenced type must be respected, just as with normal pointer
4997 conversions.
4998
4999 Second, the argument is passed to the function using the calling
5000 conventions of the first member of the transparent union, not the calling
5001 conventions of the union itself.  All members of the union must have the
5002 same machine representation; this is necessary for this argument passing
5003 to work properly.
5004
5005 Transparent unions are designed for library functions that have multiple
5006 interfaces for compatibility reasons.  For example, suppose the
5007 @code{wait} function must accept either a value of type @code{int *} to
5008 comply with Posix, or a value of type @code{union wait *} to comply with
5009 the 4.1BSD interface.  If @code{wait}'s parameter were @code{void *},
5010 @code{wait} would accept both kinds of arguments, but it would also
5011 accept any other pointer type and this would make argument type checking
5012 less useful.  Instead, @code{<sys/wait.h>} might define the interface
5013 as follows:
5014
5015 @smallexample
5016 typedef union __attribute__ ((__transparent_union__))
5017   @{
5018     int *__ip;
5019     union wait *__up;
5020   @} wait_status_ptr_t;
5021
5022 pid_t wait (wait_status_ptr_t);
5023 @end smallexample
5024
5025 This interface allows either @code{int *} or @code{union wait *}
5026 arguments to be passed, using the @code{int *} calling convention.
5027 The program can call @code{wait} with arguments of either type:
5028
5029 @smallexample
5030 int w1 () @{ int w; return wait (&w); @}
5031 int w2 () @{ union wait w; return wait (&w); @}
5032 @end smallexample
5033
5034 With this interface, @code{wait}'s implementation might look like this:
5035
5036 @smallexample
5037 pid_t wait (wait_status_ptr_t p)
5038 @{
5039   return waitpid (-1, p.__ip, 0);
5040 @}
5041 @end smallexample
5042
5043 @item unused
5044 When attached to a type (including a @code{union} or a @code{struct}),
5045 this attribute means that variables of that type are meant to appear
5046 possibly unused.  GCC will not produce a warning for any variables of
5047 that type, even if the variable appears to do nothing.  This is often
5048 the case with lock or thread classes, which are usually defined and then
5049 not referenced, but contain constructors and destructors that have
5050 nontrivial bookkeeping functions.
5051
5052 @item deprecated
5053 @itemx deprecated (@var{msg})
5054 The @code{deprecated} attribute results in a warning if the type
5055 is used anywhere in the source file.  This is useful when identifying
5056 types that are expected to be removed in a future version of a program.
5057 If possible, the warning also includes the location of the declaration
5058 of the deprecated type, to enable users to easily find further
5059 information about why the type is deprecated, or what they should do
5060 instead.  Note that the warnings only occur for uses and then only
5061 if the type is being applied to an identifier that itself is not being
5062 declared as deprecated.
5063
5064 @smallexample
5065 typedef int T1 __attribute__ ((deprecated));
5066 T1 x;
5067 typedef T1 T2;
5068 T2 y;
5069 typedef T1 T3 __attribute__ ((deprecated));
5070 T3 z __attribute__ ((deprecated));
5071 @end smallexample
5072
5073 results in a warning on line 2 and 3 but not lines 4, 5, or 6.  No
5074 warning is issued for line 4 because T2 is not explicitly
5075 deprecated.  Line 5 has no warning because T3 is explicitly
5076 deprecated.  Similarly for line 6.  The optional msg
5077 argument, which must be a string, will be printed in the warning if
5078 present.
5079
5080 The @code{deprecated} attribute can also be used for functions and
5081 variables (@pxref{Function Attributes}, @pxref{Variable Attributes}.)
5082
5083 @item may_alias
5084 Accesses through pointers to types with this attribute are not subject
5085 to type-based alias analysis, but are instead assumed to be able to alias
5086 any other type of objects.  In the context of 6.5/7 an lvalue expression
5087 dereferencing such a pointer is treated like having a character type.
5088 See @option{-fstrict-aliasing} for more information on aliasing issues.
5089 This extension exists to support some vector APIs, in which pointers to
5090 one vector type are permitted to alias pointers to a different vector type.
5091
5092 Note that an object of a type with this attribute does not have any
5093 special semantics.
5094
5095 Example of use:
5096
5097 @smallexample
5098 typedef short __attribute__((__may_alias__)) short_a;
5099
5100 int
5101 main (void)
5102 @{
5103   int a = 0x12345678;
5104   short_a *b = (short_a *) &a;
5105
5106   b[1] = 0;
5107
5108   if (a == 0x12345678)
5109     abort();
5110
5111   exit(0);
5112 @}
5113 @end smallexample
5114
5115 If you replaced @code{short_a} with @code{short} in the variable
5116 declaration, the above program would abort when compiled with
5117 @option{-fstrict-aliasing}, which is on by default at @option{-O2} or
5118 above in recent GCC versions.
5119
5120 @item visibility
5121 In C++, attribute visibility (@pxref{Function Attributes}) can also be
5122 applied to class, struct, union and enum types.  Unlike other type
5123 attributes, the attribute must appear between the initial keyword and
5124 the name of the type; it cannot appear after the body of the type.
5125
5126 Note that the type visibility is applied to vague linkage entities
5127 associated with the class (vtable, typeinfo node, etc.).  In
5128 particular, if a class is thrown as an exception in one shared object
5129 and caught in another, the class must have default visibility.
5130 Otherwise the two shared objects will be unable to use the same
5131 typeinfo node and exception handling will break.
5132
5133 @end table
5134
5135 @subsection ARM Type Attributes
5136
5137 On those ARM targets that support @code{dllimport} (such as Symbian
5138 OS), you can use the @code{notshared} attribute to indicate that the
5139 virtual table and other similar data for a class should not be
5140 exported from a DLL@.  For example:
5141
5142 @smallexample
5143 class __declspec(notshared) C @{
5144 public:
5145   __declspec(dllimport) C();
5146   virtual void f();
5147 @}
5148
5149 __declspec(dllexport)
5150 C::C() @{@}
5151 @end smallexample
5152
5153 In this code, @code{C::C} is exported from the current DLL, but the
5154 virtual table for @code{C} is not exported.  (You can use
5155 @code{__attribute__} instead of @code{__declspec} if you prefer, but
5156 most Symbian OS code uses @code{__declspec}.)
5157
5158 @anchor{MeP Type Attributes}
5159 @subsection MeP Type Attributes
5160
5161 Many of the MeP variable attributes may be applied to types as well.
5162 Specifically, the @code{based}, @code{tiny}, @code{near}, and
5163 @code{far} attributes may be applied to either.  The @code{io} and
5164 @code{cb} attributes may not be applied to types.
5165
5166 @anchor{i386 Type Attributes}
5167 @subsection i386 Type Attributes
5168
5169 Two attributes are currently defined for i386 configurations:
5170 @code{ms_struct} and @code{gcc_struct}.
5171
5172 @table @code
5173
5174 @item ms_struct
5175 @itemx gcc_struct
5176 @cindex @code{ms_struct}
5177 @cindex @code{gcc_struct}
5178
5179 If @code{packed} is used on a structure, or if bit-fields are used
5180 it may be that the Microsoft ABI packs them differently
5181 than GCC would normally pack them.  Particularly when moving packed
5182 data between functions compiled with GCC and the native Microsoft compiler
5183 (either via function call or as data in a file), it may be necessary to access
5184 either format.
5185
5186 Currently @option{-m[no-]ms-bitfields} is provided for the Microsoft Windows X86
5187 compilers to match the native Microsoft compiler.
5188 @end table
5189
5190 To specify multiple attributes, separate them by commas within the
5191 double parentheses: for example, @samp{__attribute__ ((aligned (16),
5192 packed))}.
5193
5194 @anchor{PowerPC Type Attributes}
5195 @subsection PowerPC Type Attributes
5196
5197 Three attributes currently are defined for PowerPC configurations:
5198 @code{altivec}, @code{ms_struct} and @code{gcc_struct}.
5199
5200 For full documentation of the @code{ms_struct} and @code{gcc_struct} 
5201 attributes please see the documentation in @ref{i386 Type Attributes}.
5202
5203 The @code{altivec} attribute allows one to declare AltiVec vector data
5204 types supported by the AltiVec Programming Interface Manual.  The
5205 attribute requires an argument to specify one of three vector types:
5206 @code{vector__}, @code{pixel__} (always followed by unsigned short),
5207 and @code{bool__} (always followed by unsigned).
5208
5209 @smallexample
5210 __attribute__((altivec(vector__)))
5211 __attribute__((altivec(pixel__))) unsigned short
5212 __attribute__((altivec(bool__))) unsigned
5213 @end smallexample
5214
5215 These attributes mainly are intended to support the @code{__vector},
5216 @code{__pixel}, and @code{__bool} AltiVec keywords.
5217
5218 @anchor{SPU Type Attributes}
5219 @subsection SPU Type Attributes
5220
5221 The SPU supports the @code{spu_vector} attribute for types.  This attribute
5222 allows one to declare vector data types supported by the Sony/Toshiba/IBM SPU
5223 Language Extensions Specification.  It is intended to support the
5224 @code{__vector} keyword.
5225
5226
5227 @node Inline
5228 @section An Inline Function is As Fast As a Macro
5229 @cindex inline functions
5230 @cindex integrating function code
5231 @cindex open coding
5232 @cindex macros, inline alternative
5233
5234 By declaring a function inline, you can direct GCC to make
5235 calls to that function faster.  One way GCC can achieve this is to
5236 integrate that function's code into the code for its callers.  This
5237 makes execution faster by eliminating the function-call overhead; in
5238 addition, if any of the actual argument values are constant, their
5239 known values may permit simplifications at compile time so that not
5240 all of the inline function's code needs to be included.  The effect on
5241 code size is less predictable; object code may be larger or smaller
5242 with function inlining, depending on the particular case.  You can
5243 also direct GCC to try to integrate all ``simple enough'' functions
5244 into their callers with the option @option{-finline-functions}.
5245
5246 GCC implements three different semantics of declaring a function
5247 inline.  One is available with @option{-std=gnu89} or
5248 @option{-fgnu89-inline} or when @code{gnu_inline} attribute is present
5249 on all inline declarations, another when
5250 @option{-std=c99}, @option{-std=c1x},
5251 @option{-std=gnu99} or @option{-std=gnu1x}
5252 (without @option{-fgnu89-inline}), and the third
5253 is used when compiling C++.
5254
5255 To declare a function inline, use the @code{inline} keyword in its
5256 declaration, like this:
5257
5258 @smallexample
5259 static inline int
5260 inc (int *a)
5261 @{
5262   return (*a)++;
5263 @}
5264 @end smallexample
5265
5266 If you are writing a header file to be included in ISO C90 programs, write
5267 @code{__inline__} instead of @code{inline}.  @xref{Alternate Keywords}.
5268
5269 The three types of inlining behave similarly in two important cases:
5270 when the @code{inline} keyword is used on a @code{static} function,
5271 like the example above, and when a function is first declared without
5272 using the @code{inline} keyword and then is defined with
5273 @code{inline}, like this:
5274
5275 @smallexample
5276 extern int inc (int *a);
5277 inline int
5278 inc (int *a)
5279 @{
5280   return (*a)++;
5281 @}
5282 @end smallexample
5283
5284 In both of these common cases, the program behaves the same as if you
5285 had not used the @code{inline} keyword, except for its speed.
5286
5287 @cindex inline functions, omission of
5288 @opindex fkeep-inline-functions
5289 When a function is both inline and @code{static}, if all calls to the
5290 function are integrated into the caller, and the function's address is
5291 never used, then the function's own assembler code is never referenced.
5292 In this case, GCC does not actually output assembler code for the
5293 function, unless you specify the option @option{-fkeep-inline-functions}.
5294 Some calls cannot be integrated for various reasons (in particular,
5295 calls that precede the function's definition cannot be integrated, and
5296 neither can recursive calls within the definition).  If there is a
5297 nonintegrated call, then the function is compiled to assembler code as
5298 usual.  The function must also be compiled as usual if the program
5299 refers to its address, because that can't be inlined.
5300
5301 @opindex Winline
5302 Note that certain usages in a function definition can make it unsuitable
5303 for inline substitution.  Among these usages are: use of varargs, use of
5304 alloca, use of variable sized data types (@pxref{Variable Length}),
5305 use of computed goto (@pxref{Labels as Values}), use of nonlocal goto,
5306 and nested functions (@pxref{Nested Functions}).  Using @option{-Winline}
5307 will warn when a function marked @code{inline} could not be substituted,
5308 and will give the reason for the failure.
5309
5310 @cindex automatic @code{inline} for C++ member fns
5311 @cindex @code{inline} automatic for C++ member fns
5312 @cindex member fns, automatically @code{inline}
5313 @cindex C++ member fns, automatically @code{inline}
5314 @opindex fno-default-inline
5315 As required by ISO C++, GCC considers member functions defined within
5316 the body of a class to be marked inline even if they are
5317 not explicitly declared with the @code{inline} keyword.  You can
5318 override this with @option{-fno-default-inline}; @pxref{C++ Dialect
5319 Options,,Options Controlling C++ Dialect}.
5320
5321 GCC does not inline any functions when not optimizing unless you specify
5322 the @samp{always_inline} attribute for the function, like this:
5323
5324 @smallexample
5325 /* @r{Prototype.}  */
5326 inline void foo (const char) __attribute__((always_inline));
5327 @end smallexample
5328
5329 The remainder of this section is specific to GNU C90 inlining.
5330
5331 @cindex non-static inline function
5332 When an inline function is not @code{static}, then the compiler must assume
5333 that there may be calls from other source files; since a global symbol can
5334 be defined only once in any program, the function must not be defined in
5335 the other source files, so the calls therein cannot be integrated.
5336 Therefore, a non-@code{static} inline function is always compiled on its
5337 own in the usual fashion.
5338
5339 If you specify both @code{inline} and @code{extern} in the function
5340 definition, then the definition is used only for inlining.  In no case
5341 is the function compiled on its own, not even if you refer to its
5342 address explicitly.  Such an address becomes an external reference, as
5343 if you had only declared the function, and had not defined it.
5344
5345 This combination of @code{inline} and @code{extern} has almost the
5346 effect of a macro.  The way to use it is to put a function definition in
5347 a header file with these keywords, and put another copy of the
5348 definition (lacking @code{inline} and @code{extern}) in a library file.
5349 The definition in the header file will cause most calls to the function
5350 to be inlined.  If any uses of the function remain, they will refer to
5351 the single copy in the library.
5352
5353 @node Volatiles
5354 @section When is a Volatile Object Accessed?
5355 @cindex accessing volatiles
5356 @cindex volatile read
5357 @cindex volatile write
5358 @cindex volatile access
5359
5360 C has the concept of volatile objects.  These are normally accessed by
5361 pointers and used for accessing hardware or inter-thread
5362 communication.  The standard encourages compilers to refrain from
5363 optimizations concerning accesses to volatile objects, but leaves it
5364 implementation defined as to what constitutes a volatile access.  The
5365 minimum requirement is that at a sequence point all previous accesses
5366 to volatile objects have stabilized and no subsequent accesses have
5367 occurred.  Thus an implementation is free to reorder and combine
5368 volatile accesses which occur between sequence points, but cannot do
5369 so for accesses across a sequence point.  The use of volatile does
5370 not allow you to violate the restriction on updating objects multiple
5371 times between two sequence points.
5372
5373 Accesses to non-volatile objects are not ordered with respect to
5374 volatile accesses.  You cannot use a volatile object as a memory
5375 barrier to order a sequence of writes to non-volatile memory.  For
5376 instance:
5377
5378 @smallexample
5379 int *ptr = @var{something};
5380 volatile int vobj;
5381 *ptr = @var{something};
5382 vobj = 1;
5383 @end smallexample
5384
5385 Unless @var{*ptr} and @var{vobj} can be aliased, it is not guaranteed
5386 that the write to @var{*ptr} will have occurred by the time the update
5387 of @var{vobj} has happened.  If you need this guarantee, you must use
5388 a stronger memory barrier such as:
5389
5390 @smallexample
5391 int *ptr = @var{something};
5392 volatile int vobj;
5393 *ptr = @var{something};
5394 asm volatile ("" : : : "memory");
5395 vobj = 1;
5396 @end smallexample
5397
5398 A scalar volatile object is read when it is accessed in a void context:
5399
5400 @smallexample
5401 volatile int *src = @var{somevalue};
5402 *src;
5403 @end smallexample
5404
5405 Such expressions are rvalues, and GCC implements this as a
5406 read of the volatile object being pointed to.
5407
5408 Assignments are also expressions and have an rvalue.  However when
5409 assigning to a scalar volatile, the volatile object is not reread,
5410 regardless of whether the assignment expression's rvalue is used or
5411 not.  If the assignment's rvalue is used, the value is that assigned
5412 to the volatile object.  For instance, there is no read of @var{vobj}
5413 in all the following cases:
5414
5415 @smallexample
5416 int obj;
5417 volatile int vobj;
5418 vobj = @var{something};
5419 obj = vobj = @var{something};
5420 obj ? vobj = @var{onething} : vobj = @var{anotherthing};
5421 obj = (@var{something}, vobj = @var{anotherthing});
5422 @end smallexample
5423
5424 If you need to read the volatile object after an assignment has
5425 occurred, you must use a separate expression with an intervening
5426 sequence point.
5427
5428 As bitfields are not individually addressable, volatile bitfields may
5429 be implicitly read when written to, or when adjacent bitfields are
5430 accessed.  Bitfield operations may be optimized such that adjacent
5431 bitfields are only partially accessed, if they straddle a storage unit
5432 boundary.  For these reasons it is unwise to use volatile bitfields to
5433 access hardware.
5434
5435 @node Extended Asm
5436 @section Assembler Instructions with C Expression Operands
5437 @cindex extended @code{asm}
5438 @cindex @code{asm} expressions
5439 @cindex assembler instructions
5440 @cindex registers
5441
5442 In an assembler instruction using @code{asm}, you can specify the
5443 operands of the instruction using C expressions.  This means you need not
5444 guess which registers or memory locations will contain the data you want
5445 to use.
5446
5447 You must specify an assembler instruction template much like what
5448 appears in a machine description, plus an operand constraint string for
5449 each operand.
5450
5451 For example, here is how to use the 68881's @code{fsinx} instruction:
5452
5453 @smallexample
5454 asm ("fsinx %1,%0" : "=f" (result) : "f" (angle));
5455 @end smallexample
5456
5457 @noindent
5458 Here @code{angle} is the C expression for the input operand while
5459 @code{result} is that of the output operand.  Each has @samp{"f"} as its
5460 operand constraint, saying that a floating point register is required.
5461 The @samp{=} in @samp{=f} indicates that the operand is an output; all
5462 output operands' constraints must use @samp{=}.  The constraints use the
5463 same language used in the machine description (@pxref{Constraints}).
5464
5465 Each operand is described by an operand-constraint string followed by
5466 the C expression in parentheses.  A colon separates the assembler
5467 template from the first output operand and another separates the last
5468 output operand from the first input, if any.  Commas separate the
5469 operands within each group.  The total number of operands is currently
5470 limited to 30; this limitation may be lifted in some future version of
5471 GCC@.
5472
5473 If there are no output operands but there are input operands, you must
5474 place two consecutive colons surrounding the place where the output
5475 operands would go.
5476
5477 As of GCC version 3.1, it is also possible to specify input and output
5478 operands using symbolic names which can be referenced within the
5479 assembler code.  These names are specified inside square brackets
5480 preceding the constraint string, and can be referenced inside the
5481 assembler code using @code{%[@var{name}]} instead of a percentage sign
5482 followed by the operand number.  Using named operands the above example
5483 could look like:
5484
5485 @smallexample
5486 asm ("fsinx %[angle],%[output]"
5487      : [output] "=f" (result)
5488      : [angle] "f" (angle));
5489 @end smallexample
5490
5491 @noindent
5492 Note that the symbolic operand names have no relation whatsoever to
5493 other C identifiers.  You may use any name you like, even those of
5494 existing C symbols, but you must ensure that no two operands within the same
5495 assembler construct use the same symbolic name.
5496
5497 Output operand expressions must be lvalues; the compiler can check this.
5498 The input operands need not be lvalues.  The compiler cannot check
5499 whether the operands have data types that are reasonable for the
5500 instruction being executed.  It does not parse the assembler instruction
5501 template and does not know what it means or even whether it is valid
5502 assembler input.  The extended @code{asm} feature is most often used for
5503 machine instructions the compiler itself does not know exist.  If
5504 the output expression cannot be directly addressed (for example, it is a
5505 bit-field), your constraint must allow a register.  In that case, GCC
5506 will use the register as the output of the @code{asm}, and then store
5507 that register into the output.
5508
5509 The ordinary output operands must be write-only; GCC will assume that
5510 the values in these operands before the instruction are dead and need
5511 not be generated.  Extended asm supports input-output or read-write
5512 operands.  Use the constraint character @samp{+} to indicate such an
5513 operand and list it with the output operands.  You should only use
5514 read-write operands when the constraints for the operand (or the
5515 operand in which only some of the bits are to be changed) allow a
5516 register.
5517
5518 You may, as an alternative, logically split its function into two
5519 separate operands, one input operand and one write-only output
5520 operand.  The connection between them is expressed by constraints
5521 which say they need to be in the same location when the instruction
5522 executes.  You can use the same C expression for both operands, or
5523 different expressions.  For example, here we write the (fictitious)
5524 @samp{combine} instruction with @code{bar} as its read-only source
5525 operand and @code{foo} as its read-write destination:
5526
5527 @smallexample
5528 asm ("combine %2,%0" : "=r" (foo) : "0" (foo), "g" (bar));
5529 @end smallexample
5530
5531 @noindent
5532 The constraint @samp{"0"} for operand 1 says that it must occupy the
5533 same location as operand 0.  A number in constraint is allowed only in
5534 an input operand and it must refer to an output operand.
5535
5536 Only a number in the constraint can guarantee that one operand will be in
5537 the same place as another.  The mere fact that @code{foo} is the value
5538 of both operands is not enough to guarantee that they will be in the
5539 same place in the generated assembler code.  The following would not
5540 work reliably:
5541
5542 @smallexample
5543 asm ("combine %2,%0" : "=r" (foo) : "r" (foo), "g" (bar));
5544 @end smallexample
5545
5546 Various optimizations or reloading could cause operands 0 and 1 to be in
5547 different registers; GCC knows no reason not to do so.  For example, the
5548 compiler might find a copy of the value of @code{foo} in one register and
5549 use it for operand 1, but generate the output operand 0 in a different
5550 register (copying it afterward to @code{foo}'s own address).  Of course,
5551 since the register for operand 1 is not even mentioned in the assembler
5552 code, the result will not work, but GCC can't tell that.
5553
5554 As of GCC version 3.1, one may write @code{[@var{name}]} instead of
5555 the operand number for a matching constraint.  For example:
5556
5557 @smallexample
5558 asm ("cmoveq %1,%2,%[result]"
5559      : [result] "=r"(result)
5560      : "r" (test), "r"(new), "[result]"(old));
5561 @end smallexample
5562
5563 Sometimes you need to make an @code{asm} operand be a specific register,
5564 but there's no matching constraint letter for that register @emph{by
5565 itself}.  To force the operand into that register, use a local variable
5566 for the operand and specify the register in the variable declaration.
5567 @xref{Explicit Reg Vars}.  Then for the @code{asm} operand, use any
5568 register constraint letter that matches the register:
5569
5570 @smallexample
5571 register int *p1 asm ("r0") = @dots{};
5572 register int *p2 asm ("r1") = @dots{};
5573 register int *result asm ("r0");
5574 asm ("sysint" : "=r" (result) : "0" (p1), "r" (p2));
5575 @end smallexample
5576
5577 @anchor{Example of asm with clobbered asm reg}
5578 In the above example, beware that a register that is call-clobbered by
5579 the target ABI will be overwritten by any function call in the
5580 assignment, including library calls for arithmetic operators.
5581 Also a register may be clobbered when generating some operations,
5582 like variable shift, memory copy or memory move on x86.
5583 Assuming it is a call-clobbered register, this may happen to @code{r0}
5584 above by the assignment to @code{p2}.  If you have to use such a
5585 register, use temporary variables for expressions between the register
5586 assignment and use:
5587
5588 @smallexample
5589 int t1 = @dots{};
5590 register int *p1 asm ("r0") = @dots{};
5591 register int *p2 asm ("r1") = t1;
5592 register int *result asm ("r0");
5593 asm ("sysint" : "=r" (result) : "0" (p1), "r" (p2));
5594 @end smallexample
5595
5596 Some instructions clobber specific hard registers.  To describe this,
5597 write a third colon after the input operands, followed by the names of
5598 the clobbered hard registers (given as strings).  Here is a realistic
5599 example for the VAX:
5600
5601 @smallexample
5602 asm volatile ("movc3 %0,%1,%2"
5603               : /* @r{no outputs} */
5604               : "g" (from), "g" (to), "g" (count)
5605               : "r0", "r1", "r2", "r3", "r4", "r5");
5606 @end smallexample
5607
5608 You may not write a clobber description in a way that overlaps with an
5609 input or output operand.  For example, you may not have an operand
5610 describing a register class with one member if you mention that register
5611 in the clobber list.  Variables declared to live in specific registers
5612 (@pxref{Explicit Reg Vars}), and used as asm input or output operands must
5613 have no part mentioned in the clobber description.
5614 There is no way for you to specify that an input
5615 operand is modified without also specifying it as an output
5616 operand.  Note that if all the output operands you specify are for this
5617 purpose (and hence unused), you will then also need to specify
5618 @code{volatile} for the @code{asm} construct, as described below, to
5619 prevent GCC from deleting the @code{asm} statement as unused.
5620
5621 If you refer to a particular hardware register from the assembler code,
5622 you will probably have to list the register after the third colon to
5623 tell the compiler the register's value is modified.  In some assemblers,
5624 the register names begin with @samp{%}; to produce one @samp{%} in the
5625 assembler code, you must write @samp{%%} in the input.
5626
5627 If your assembler instruction can alter the condition code register, add
5628 @samp{cc} to the list of clobbered registers.  GCC on some machines
5629 represents the condition codes as a specific hardware register;
5630 @samp{cc} serves to name this register.  On other machines, the
5631 condition code is handled differently, and specifying @samp{cc} has no
5632 effect.  But it is valid no matter what the machine.
5633
5634 If your assembler instructions access memory in an unpredictable
5635 fashion, add @samp{memory} to the list of clobbered registers.  This
5636 will cause GCC to not keep memory values cached in registers across the
5637 assembler instruction and not optimize stores or loads to that memory.
5638 You will also want to add the @code{volatile} keyword if the memory
5639 affected is not listed in the inputs or outputs of the @code{asm}, as
5640 the @samp{memory} clobber does not count as a side-effect of the
5641 @code{asm}.  If you know how large the accessed memory is, you can add
5642 it as input or output but if this is not known, you should add
5643 @samp{memory}.  As an example, if you access ten bytes of a string, you
5644 can use a memory input like:
5645
5646 @smallexample
5647 @{"m"( (@{ struct @{ char x[10]; @} *p = (void *)ptr ; *p; @}) )@}.
5648 @end smallexample
5649
5650 Note that in the following example the memory input is necessary,
5651 otherwise GCC might optimize the store to @code{x} away:
5652 @smallexample
5653 int foo ()
5654 @{
5655   int x = 42;
5656   int *y = &x;
5657   int result;
5658   asm ("magic stuff accessing an 'int' pointed to by '%1'"
5659         "=&d" (r) : "a" (y), "m" (*y));
5660   return result;
5661 @}
5662 @end smallexample
5663
5664 You can put multiple assembler instructions together in a single
5665 @code{asm} template, separated by the characters normally used in assembly
5666 code for the system.  A combination that works in most places is a newline
5667 to break the line, plus a tab character to move to the instruction field
5668 (written as @samp{\n\t}).  Sometimes semicolons can be used, if the
5669 assembler allows semicolons as a line-breaking character.  Note that some
5670 assembler dialects use semicolons to start a comment.
5671 The input operands are guaranteed not to use any of the clobbered
5672 registers, and neither will the output operands' addresses, so you can
5673 read and write the clobbered registers as many times as you like.  Here
5674 is an example of multiple instructions in a template; it assumes the
5675 subroutine @code{_foo} accepts arguments in registers 9 and 10:
5676
5677 @smallexample
5678 asm ("movl %0,r9\n\tmovl %1,r10\n\tcall _foo"
5679      : /* no outputs */
5680      : "g" (from), "g" (to)
5681      : "r9", "r10");
5682 @end smallexample
5683
5684 Unless an output operand has the @samp{&} constraint modifier, GCC
5685 may allocate it in the same register as an unrelated input operand, on
5686 the assumption the inputs are consumed before the outputs are produced.
5687 This assumption may be false if the assembler code actually consists of
5688 more than one instruction.  In such a case, use @samp{&} for each output
5689 operand that may not overlap an input.  @xref{Modifiers}.
5690
5691 If you want to test the condition code produced by an assembler
5692 instruction, you must include a branch and a label in the @code{asm}
5693 construct, as follows:
5694
5695 @smallexample
5696 asm ("clr %0\n\tfrob %1\n\tbeq 0f\n\tmov #1,%0\n0:"
5697      : "g" (result)
5698      : "g" (input));
5699 @end smallexample
5700
5701 @noindent
5702 This assumes your assembler supports local labels, as the GNU assembler
5703 and most Unix assemblers do.
5704
5705 Speaking of labels, jumps from one @code{asm} to another are not
5706 supported.  The compiler's optimizers do not know about these jumps, and
5707 therefore they cannot take account of them when deciding how to
5708 optimize.  @xref{Extended asm with goto}.
5709
5710 @cindex macros containing @code{asm}
5711 Usually the most convenient way to use these @code{asm} instructions is to
5712 encapsulate them in macros that look like functions.  For example,
5713
5714 @smallexample
5715 #define sin(x)       \
5716 (@{ double __value, __arg = (x);   \
5717    asm ("fsinx %1,%0": "=f" (__value): "f" (__arg));  \
5718    __value; @})
5719 @end smallexample
5720
5721 @noindent
5722 Here the variable @code{__arg} is used to make sure that the instruction
5723 operates on a proper @code{double} value, and to accept only those
5724 arguments @code{x} which can convert automatically to a @code{double}.
5725
5726 Another way to make sure the instruction operates on the correct data
5727 type is to use a cast in the @code{asm}.  This is different from using a
5728 variable @code{__arg} in that it converts more different types.  For
5729 example, if the desired type were @code{int}, casting the argument to
5730 @code{int} would accept a pointer with no complaint, while assigning the
5731 argument to an @code{int} variable named @code{__arg} would warn about
5732 using a pointer unless the caller explicitly casts it.
5733
5734 If an @code{asm} has output operands, GCC assumes for optimization
5735 purposes the instruction has no side effects except to change the output
5736 operands.  This does not mean instructions with a side effect cannot be
5737 used, but you must be careful, because the compiler may eliminate them
5738 if the output operands aren't used, or move them out of loops, or
5739 replace two with one if they constitute a common subexpression.  Also,
5740 if your instruction does have a side effect on a variable that otherwise
5741 appears not to change, the old value of the variable may be reused later
5742 if it happens to be found in a register.
5743
5744 You can prevent an @code{asm} instruction from being deleted
5745 by writing the keyword @code{volatile} after
5746 the @code{asm}.  For example:
5747
5748 @smallexample
5749 #define get_and_set_priority(new)              \
5750 (@{ int __old;                                  \
5751    asm volatile ("get_and_set_priority %0, %1" \
5752                  : "=g" (__old) : "g" (new));  \
5753    __old; @})
5754 @end smallexample
5755
5756 @noindent
5757 The @code{volatile} keyword indicates that the instruction has
5758 important side-effects.  GCC will not delete a volatile @code{asm} if
5759 it is reachable.  (The instruction can still be deleted if GCC can
5760 prove that control-flow will never reach the location of the
5761 instruction.)  Note that even a volatile @code{asm} instruction
5762 can be moved relative to other code, including across jump
5763 instructions.  For example, on many targets there is a system
5764 register which can be set to control the rounding mode of
5765 floating point operations.  You might try
5766 setting it with a volatile @code{asm}, like this PowerPC example:
5767
5768 @smallexample
5769        asm volatile("mtfsf 255,%0" : : "f" (fpenv));
5770        sum = x + y;
5771 @end smallexample
5772
5773 @noindent
5774 This will not work reliably, as the compiler may move the addition back
5775 before the volatile @code{asm}.  To make it work you need to add an
5776 artificial dependency to the @code{asm} referencing a variable in the code
5777 you don't want moved, for example:
5778
5779 @smallexample
5780     asm volatile ("mtfsf 255,%1" : "=X"(sum): "f"(fpenv));
5781     sum = x + y;
5782 @end smallexample
5783
5784 Similarly, you can't expect a
5785 sequence of volatile @code{asm} instructions to remain perfectly
5786 consecutive.  If you want consecutive output, use a single @code{asm}.
5787 Also, GCC will perform some optimizations across a volatile @code{asm}
5788 instruction; GCC does not ``forget everything'' when it encounters
5789 a volatile @code{asm} instruction the way some other compilers do.
5790
5791 An @code{asm} instruction without any output operands will be treated
5792 identically to a volatile @code{asm} instruction.
5793
5794 It is a natural idea to look for a way to give access to the condition
5795 code left by the assembler instruction.  However, when we attempted to
5796 implement this, we found no way to make it work reliably.  The problem
5797 is that output operands might need reloading, which would result in
5798 additional following ``store'' instructions.  On most machines, these
5799 instructions would alter the condition code before there was time to
5800 test it.  This problem doesn't arise for ordinary ``test'' and
5801 ``compare'' instructions because they don't have any output operands.
5802
5803 For reasons similar to those described above, it is not possible to give
5804 an assembler instruction access to the condition code left by previous
5805 instructions.
5806
5807 @anchor{Extended asm with goto}
5808 As of GCC version 4.5, @code{asm goto} may be used to have the assembly
5809 jump to one or more C labels.  In this form, a fifth section after the
5810 clobber list contains a list of all C labels to which the assembly may jump.
5811 Each label operand is implicitly self-named.  The @code{asm} is also assumed
5812 to fall through to the next statement.
5813
5814 This form of @code{asm} is restricted to not have outputs.  This is due
5815 to a internal restriction in the compiler that control transfer instructions
5816 cannot have outputs.  This restriction on @code{asm goto} may be lifted
5817 in some future version of the compiler.  In the mean time, @code{asm goto}
5818 may include a memory clobber, and so leave outputs in memory.
5819
5820 @smallexample
5821 int frob(int x)
5822 @{
5823   int y;
5824   asm goto ("frob %%r5, %1; jc %l[error]; mov (%2), %%r5"
5825             : : "r"(x), "r"(&y) : "r5", "memory" : error);
5826   return y;
5827  error:
5828   return -1;
5829 @}
5830 @end smallexample
5831
5832 In this (inefficient) example, the @code{frob} instruction sets the
5833 carry bit to indicate an error.  The @code{jc} instruction detects
5834 this and branches to the @code{error} label.  Finally, the output 
5835 of the @code{frob} instruction (@code{%r5}) is stored into the memory
5836 for variable @code{y}, which is later read by the @code{return} statement.
5837
5838 @smallexample
5839 void doit(void)
5840 @{
5841   int i = 0;
5842   asm goto ("mfsr %%r1, 123; jmp %%r1;"
5843             ".pushsection doit_table;"
5844             ".long %l0, %l1, %l2, %l3;"
5845             ".popsection"
5846             : : : "r1" : label1, label2, label3, label4);
5847   __builtin_unreachable ();
5848
5849  label1:
5850   f1();
5851   return;
5852  label2:
5853   f2();
5854   return;
5855  label3:
5856   i = 1;
5857  label4:
5858   f3(i);
5859 @}
5860 @end smallexample
5861
5862 In this (also inefficient) example, the @code{mfsr} instruction reads
5863 an address from some out-of-band machine register, and the following
5864 @code{jmp} instruction branches to that address.  The address read by
5865 the @code{mfsr} instruction is assumed to have been previously set via
5866 some application-specific mechanism to be one of the four values stored
5867 in the @code{doit_table} section.  Finally, the @code{asm} is followed
5868 by a call to @code{__builtin_unreachable} to indicate that the @code{asm}
5869 does not in fact fall through.
5870
5871 @smallexample
5872 #define TRACE1(NUM)                         \
5873   do @{                                      \
5874     asm goto ("0: nop;"                     \
5875               ".pushsection trace_table;"   \
5876               ".long 0b, %l0;"              \
5877               ".popsection"                 \
5878               : : : : trace#NUM);           \
5879     if (0) @{ trace#NUM: trace(); @}          \
5880   @} while (0)
5881 #define TRACE  TRACE1(__COUNTER__)
5882 @end smallexample
5883
5884 In this example (which in fact inspired the @code{asm goto} feature)
5885 we want on rare occasions to call the @code{trace} function; on other
5886 occasions we'd like to keep the overhead to the absolute minimum.
5887 The normal code path consists of a single @code{nop} instruction.
5888 However, we record the address of this @code{nop} together with the
5889 address of a label that calls the @code{trace} function.  This allows
5890 the @code{nop} instruction to be patched at runtime to be an 
5891 unconditional branch to the stored label.  It is assumed that an
5892 optimizing compiler will move the labeled block out of line, to
5893 optimize the fall through path from the @code{asm}.
5894
5895 If you are writing a header file that should be includable in ISO C
5896 programs, write @code{__asm__} instead of @code{asm}.  @xref{Alternate
5897 Keywords}.
5898
5899 @subsection Size of an @code{asm}
5900
5901 Some targets require that GCC track the size of each instruction used in
5902 order to generate correct code.  Because the final length of an
5903 @code{asm} is only known by the assembler, GCC must make an estimate as
5904 to how big it will be.  The estimate is formed by counting the number of
5905 statements in the pattern of the @code{asm} and multiplying that by the
5906 length of the longest instruction on that processor.  Statements in the
5907 @code{asm} are identified by newline characters and whatever statement
5908 separator characters are supported by the assembler; on most processors
5909 this is the `@code{;}' character.
5910
5911 Normally, GCC's estimate is perfectly adequate to ensure that correct
5912 code is generated, but it is possible to confuse the compiler if you use
5913 pseudo instructions or assembler macros that expand into multiple real
5914 instructions or if you use assembler directives that expand to more
5915 space in the object file than would be needed for a single instruction.
5916 If this happens then the assembler will produce a diagnostic saying that
5917 a label is unreachable.
5918
5919 @subsection i386 floating point asm operands
5920
5921 There are several rules on the usage of stack-like regs in
5922 asm_operands insns.  These rules apply only to the operands that are
5923 stack-like regs:
5924
5925 @enumerate
5926 @item
5927 Given a set of input regs that die in an asm_operands, it is
5928 necessary to know which are implicitly popped by the asm, and
5929 which must be explicitly popped by gcc.
5930
5931 An input reg that is implicitly popped by the asm must be
5932 explicitly clobbered, unless it is constrained to match an
5933 output operand.
5934
5935 @item
5936 For any input reg that is implicitly popped by an asm, it is
5937 necessary to know how to adjust the stack to compensate for the pop.
5938 If any non-popped input is closer to the top of the reg-stack than
5939 the implicitly popped reg, it would not be possible to know what the
5940 stack looked like---it's not clear how the rest of the stack ``slides
5941 up''.
5942
5943 All implicitly popped input regs must be closer to the top of
5944 the reg-stack than any input that is not implicitly popped.
5945
5946 It is possible that if an input dies in an insn, reload might
5947 use the input reg for an output reload.  Consider this example:
5948
5949 @smallexample
5950 asm ("foo" : "=t" (a) : "f" (b));
5951 @end smallexample
5952
5953 This asm says that input B is not popped by the asm, and that
5954 the asm pushes a result onto the reg-stack, i.e., the stack is one
5955 deeper after the asm than it was before.  But, it is possible that
5956 reload will think that it can use the same reg for both the input and
5957 the output, if input B dies in this insn.
5958
5959 If any input operand uses the @code{f} constraint, all output reg
5960 constraints must use the @code{&} earlyclobber.
5961
5962 The asm above would be written as
5963
5964 @smallexample
5965 asm ("foo" : "=&t" (a) : "f" (b));
5966 @end smallexample
5967
5968 @item
5969 Some operands need to be in particular places on the stack.  All
5970 output operands fall in this category---there is no other way to
5971 know which regs the outputs appear in unless the user indicates
5972 this in the constraints.
5973
5974 Output operands must specifically indicate which reg an output
5975 appears in after an asm.  @code{=f} is not allowed: the operand
5976 constraints must select a class with a single reg.
5977
5978 @item
5979 Output operands may not be ``inserted'' between existing stack regs.
5980 Since no 387 opcode uses a read/write operand, all output operands
5981 are dead before the asm_operands, and are pushed by the asm_operands.
5982 It makes no sense to push anywhere but the top of the reg-stack.
5983
5984 Output operands must start at the top of the reg-stack: output
5985 operands may not ``skip'' a reg.
5986
5987 @item
5988 Some asm statements may need extra stack space for internal
5989 calculations.  This can be guaranteed by clobbering stack registers
5990 unrelated to the inputs and outputs.
5991
5992 @end enumerate
5993
5994 Here are a couple of reasonable asms to want to write.  This asm
5995 takes one input, which is internally popped, and produces two outputs.
5996
5997 @smallexample
5998 asm ("fsincos" : "=t" (cos), "=u" (sin) : "0" (inp));
5999 @end smallexample
6000
6001 This asm takes two inputs, which are popped by the @code{fyl2xp1} opcode,
6002 and replaces them with one output.  The user must code the @code{st(1)}
6003 clobber for reg-stack.c to know that @code{fyl2xp1} pops both inputs.
6004
6005 @smallexample
6006 asm ("fyl2xp1" : "=t" (result) : "0" (x), "u" (y) : "st(1)");
6007 @end smallexample
6008
6009 @include md.texi
6010
6011 @node Asm Labels
6012 @section Controlling Names Used in Assembler Code
6013 @cindex assembler names for identifiers
6014 @cindex names used in assembler code
6015 @cindex identifiers, names in assembler code
6016
6017 You can specify the name to be used in the assembler code for a C
6018 function or variable by writing the @code{asm} (or @code{__asm__})
6019 keyword after the declarator as follows:
6020
6021 @smallexample
6022 int foo asm ("myfoo") = 2;
6023 @end smallexample
6024
6025 @noindent
6026 This specifies that the name to be used for the variable @code{foo} in
6027 the assembler code should be @samp{myfoo} rather than the usual
6028 @samp{_foo}.
6029
6030 On systems where an underscore is normally prepended to the name of a C
6031 function or variable, this feature allows you to define names for the
6032 linker that do not start with an underscore.
6033
6034 It does not make sense to use this feature with a non-static local
6035 variable since such variables do not have assembler names.  If you are
6036 trying to put the variable in a particular register, see @ref{Explicit
6037 Reg Vars}.  GCC presently accepts such code with a warning, but will
6038 probably be changed to issue an error, rather than a warning, in the
6039 future.
6040
6041 You cannot use @code{asm} in this way in a function @emph{definition}; but
6042 you can get the same effect by writing a declaration for the function
6043 before its definition and putting @code{asm} there, like this:
6044
6045 @smallexample
6046 extern func () asm ("FUNC");
6047
6048 func (x, y)
6049      int x, y;
6050 /* @r{@dots{}} */
6051 @end smallexample
6052
6053 It is up to you to make sure that the assembler names you choose do not
6054 conflict with any other assembler symbols.  Also, you must not use a
6055 register name; that would produce completely invalid assembler code.  GCC
6056 does not as yet have the ability to store static variables in registers.
6057 Perhaps that will be added.
6058
6059 @node Explicit Reg Vars
6060 @section Variables in Specified Registers
6061 @cindex explicit register variables
6062 @cindex variables in specified registers
6063 @cindex specified registers
6064 @cindex registers, global allocation
6065
6066 GNU C allows you to put a few global variables into specified hardware
6067 registers.  You can also specify the register in which an ordinary
6068 register variable should be allocated.
6069
6070 @itemize @bullet
6071 @item
6072 Global register variables reserve registers throughout the program.
6073 This may be useful in programs such as programming language
6074 interpreters which have a couple of global variables that are accessed
6075 very often.
6076
6077 @item
6078 Local register variables in specific registers do not reserve the
6079 registers, except at the point where they are used as input or output
6080 operands in an @code{asm} statement and the @code{asm} statement itself is
6081 not deleted.  The compiler's data flow analysis is capable of determining
6082 where the specified registers contain live values, and where they are
6083 available for other uses.  Stores into local register variables may be deleted
6084 when they appear to be dead according to dataflow analysis.  References
6085 to local register variables may be deleted or moved or simplified.
6086
6087 These local variables are sometimes convenient for use with the extended
6088 @code{asm} feature (@pxref{Extended Asm}), if you want to write one
6089 output of the assembler instruction directly into a particular register.
6090 (This will work provided the register you specify fits the constraints
6091 specified for that operand in the @code{asm}.)
6092 @end itemize
6093
6094 @menu
6095 * Global Reg Vars::
6096 * Local Reg Vars::
6097 @end menu
6098
6099 @node Global Reg Vars
6100 @subsection Defining Global Register Variables
6101 @cindex global register variables
6102 @cindex registers, global variables in
6103
6104 You can define a global register variable in GNU C like this:
6105
6106 @smallexample
6107 register int *foo asm ("a5");
6108 @end smallexample
6109
6110 @noindent
6111 Here @code{a5} is the name of the register which should be used.  Choose a
6112 register which is normally saved and restored by function calls on your
6113 machine, so that library routines will not clobber it.
6114
6115 Naturally the register name is cpu-dependent, so you would need to
6116 conditionalize your program according to cpu type.  The register
6117 @code{a5} would be a good choice on a 68000 for a variable of pointer
6118 type.  On machines with register windows, be sure to choose a ``global''
6119 register that is not affected magically by the function call mechanism.
6120
6121 In addition, operating systems on one type of cpu may differ in how they
6122 name the registers; then you would need additional conditionals.  For
6123 example, some 68000 operating systems call this register @code{%a5}.
6124
6125 Eventually there may be a way of asking the compiler to choose a register
6126 automatically, but first we need to figure out how it should choose and
6127 how to enable you to guide the choice.  No solution is evident.
6128
6129 Defining a global register variable in a certain register reserves that
6130 register entirely for this use, at least within the current compilation.
6131 The register will not be allocated for any other purpose in the functions
6132 in the current compilation.  The register will not be saved and restored by
6133 these functions.  Stores into this register are never deleted even if they
6134 would appear to be dead, but references may be deleted or moved or
6135 simplified.
6136
6137 It is not safe to access the global register variables from signal
6138 handlers, or from more than one thread of control, because the system
6139 library routines may temporarily use the register for other things (unless
6140 you recompile them specially for the task at hand).
6141
6142 @cindex @code{qsort}, and global register variables
6143 It is not safe for one function that uses a global register variable to
6144 call another such function @code{foo} by way of a third function
6145 @code{lose} that was compiled without knowledge of this variable (i.e.@: in a
6146 different source file in which the variable wasn't declared).  This is
6147 because @code{lose} might save the register and put some other value there.
6148 For example, you can't expect a global register variable to be available in
6149 the comparison-function that you pass to @code{qsort}, since @code{qsort}
6150 might have put something else in that register.  (If you are prepared to
6151 recompile @code{qsort} with the same global register variable, you can
6152 solve this problem.)
6153
6154 If you want to recompile @code{qsort} or other source files which do not
6155 actually use your global register variable, so that they will not use that
6156 register for any other purpose, then it suffices to specify the compiler
6157 option @option{-ffixed-@var{reg}}.  You need not actually add a global
6158 register declaration to their source code.
6159
6160 A function which can alter the value of a global register variable cannot
6161 safely be called from a function compiled without this variable, because it
6162 could clobber the value the caller expects to find there on return.
6163 Therefore, the function which is the entry point into the part of the
6164 program that uses the global register variable must explicitly save and
6165 restore the value which belongs to its caller.
6166
6167 @cindex register variable after @code{longjmp}
6168 @cindex global register after @code{longjmp}
6169 @cindex value after @code{longjmp}
6170 @findex longjmp
6171 @findex setjmp
6172 On most machines, @code{longjmp} will restore to each global register
6173 variable the value it had at the time of the @code{setjmp}.  On some
6174 machines, however, @code{longjmp} will not change the value of global
6175 register variables.  To be portable, the function that called @code{setjmp}
6176 should make other arrangements to save the values of the global register
6177 variables, and to restore them in a @code{longjmp}.  This way, the same
6178 thing will happen regardless of what @code{longjmp} does.
6179
6180 All global register variable declarations must precede all function
6181 definitions.  If such a declaration could appear after function
6182 definitions, the declaration would be too late to prevent the register from
6183 being used for other purposes in the preceding functions.
6184
6185 Global register variables may not have initial values, because an
6186 executable file has no means to supply initial contents for a register.
6187
6188 On the SPARC, there are reports that g3 @dots{} g7 are suitable
6189 registers, but certain library functions, such as @code{getwd}, as well
6190 as the subroutines for division and remainder, modify g3 and g4.  g1 and
6191 g2 are local temporaries.
6192
6193 On the 68000, a2 @dots{} a5 should be suitable, as should d2 @dots{} d7.
6194 Of course, it will not do to use more than a few of those.
6195
6196 @node Local Reg Vars
6197 @subsection Specifying Registers for Local Variables
6198 @cindex local variables, specifying registers
6199 @cindex specifying registers for local variables
6200 @cindex registers for local variables
6201
6202 You can define a local register variable with a specified register
6203 like this:
6204
6205 @smallexample
6206 register int *foo asm ("a5");
6207 @end smallexample
6208
6209 @noindent
6210 Here @code{a5} is the name of the register which should be used.  Note
6211 that this is the same syntax used for defining global register
6212 variables, but for a local variable it would appear within a function.
6213
6214 Naturally the register name is cpu-dependent, but this is not a
6215 problem, since specific registers are most often useful with explicit
6216 assembler instructions (@pxref{Extended Asm}).  Both of these things
6217 generally require that you conditionalize your program according to
6218 cpu type.
6219
6220 In addition, operating systems on one type of cpu may differ in how they
6221 name the registers; then you would need additional conditionals.  For
6222 example, some 68000 operating systems call this register @code{%a5}.
6223
6224 Defining such a register variable does not reserve the register; it
6225 remains available for other uses in places where flow control determines
6226 the variable's value is not live.
6227
6228 This option does not guarantee that GCC will generate code that has
6229 this variable in the register you specify at all times.  You may not
6230 code an explicit reference to this register in the @emph{assembler
6231 instruction template} part of an @code{asm} statement and assume it will
6232 always refer to this variable.  However, using the variable as an
6233 @code{asm} @emph{operand} guarantees that the specified register is used
6234 for the operand.
6235
6236 Stores into local register variables may be deleted when they appear to be dead
6237 according to dataflow analysis.  References to local register variables may
6238 be deleted or moved or simplified.
6239
6240 As for global register variables, it's recommended that you choose a
6241 register which is normally saved and restored by function calls on
6242 your machine, so that library routines will not clobber it.  A common
6243 pitfall is to initialize multiple call-clobbered registers with
6244 arbitrary expressions, where a function call or library call for an
6245 arithmetic operator will overwrite a register value from a previous
6246 assignment, for example @code{r0} below:
6247 @smallexample
6248 register int *p1 asm ("r0") = @dots{};
6249 register int *p2 asm ("r1") = @dots{};
6250 @end smallexample
6251 In those cases, a solution is to use a temporary variable for
6252 each arbitrary expression.   @xref{Example of asm with clobbered asm reg}.
6253
6254 @node Alternate Keywords
6255 @section Alternate Keywords
6256 @cindex alternate keywords
6257 @cindex keywords, alternate
6258
6259 @option{-ansi} and the various @option{-std} options disable certain
6260 keywords.  This causes trouble when you want to use GNU C extensions, or
6261 a general-purpose header file that should be usable by all programs,
6262 including ISO C programs.  The keywords @code{asm}, @code{typeof} and
6263 @code{inline} are not available in programs compiled with
6264 @option{-ansi} or @option{-std} (although @code{inline} can be used in a
6265 program compiled with @option{-std=c99} or @option{-std=c1x}).  The
6266 ISO C99 keyword
6267 @code{restrict} is only available when @option{-std=gnu99} (which will
6268 eventually be the default) or @option{-std=c99} (or the equivalent
6269 @option{-std=iso9899:1999}), or an option for a later standard
6270 version, is used.
6271
6272 The way to solve these problems is to put @samp{__} at the beginning and
6273 end of each problematical keyword.  For example, use @code{__asm__}
6274 instead of @code{asm}, and @code{__inline__} instead of @code{inline}.
6275
6276 Other C compilers won't accept these alternative keywords; if you want to
6277 compile with another compiler, you can define the alternate keywords as
6278 macros to replace them with the customary keywords.  It looks like this:
6279
6280 @smallexample
6281 #ifndef __GNUC__
6282 #define __asm__ asm
6283 #endif
6284 @end smallexample
6285
6286 @findex __extension__
6287 @opindex pedantic
6288 @option{-pedantic} and other options cause warnings for many GNU C extensions.
6289 You can
6290 prevent such warnings within one expression by writing
6291 @code{__extension__} before the expression.  @code{__extension__} has no
6292 effect aside from this.
6293
6294 @node Incomplete Enums
6295 @section Incomplete @code{enum} Types
6296
6297 You can define an @code{enum} tag without specifying its possible values.
6298 This results in an incomplete type, much like what you get if you write
6299 @code{struct foo} without describing the elements.  A later declaration
6300 which does specify the possible values completes the type.
6301
6302 You can't allocate variables or storage using the type while it is
6303 incomplete.  However, you can work with pointers to that type.
6304
6305 This extension may not be very useful, but it makes the handling of
6306 @code{enum} more consistent with the way @code{struct} and @code{union}
6307 are handled.
6308
6309 This extension is not supported by GNU C++.
6310
6311 @node Function Names
6312 @section Function Names as Strings
6313 @cindex @code{__func__} identifier
6314 @cindex @code{__FUNCTION__} identifier
6315 @cindex @code{__PRETTY_FUNCTION__} identifier
6316
6317 GCC provides three magic variables which hold the name of the current
6318 function, as a string.  The first of these is @code{__func__}, which
6319 is part of the C99 standard:
6320
6321 The identifier @code{__func__} is implicitly declared by the translator
6322 as if, immediately following the opening brace of each function
6323 definition, the declaration
6324
6325 @smallexample
6326 static const char __func__[] = "function-name";
6327 @end smallexample
6328
6329 @noindent
6330 appeared, where function-name is the name of the lexically-enclosing
6331 function.  This name is the unadorned name of the function.
6332
6333 @code{__FUNCTION__} is another name for @code{__func__}.  Older
6334 versions of GCC recognize only this name.  However, it is not
6335 standardized.  For maximum portability, we recommend you use
6336 @code{__func__}, but provide a fallback definition with the
6337 preprocessor:
6338
6339 @smallexample
6340 #if __STDC_VERSION__ < 199901L
6341 # if __GNUC__ >= 2
6342 #  define __func__ __FUNCTION__
6343 # else
6344 #  define __func__ "<unknown>"
6345 # endif
6346 #endif
6347 @end smallexample
6348
6349 In C, @code{__PRETTY_FUNCTION__} is yet another name for
6350 @code{__func__}.  However, in C++, @code{__PRETTY_FUNCTION__} contains
6351 the type signature of the function as well as its bare name.  For
6352 example, this program:
6353
6354 @smallexample
6355 extern "C" @{
6356 extern int printf (char *, ...);
6357 @}
6358
6359 class a @{
6360  public:
6361   void sub (int i)
6362     @{
6363       printf ("__FUNCTION__ = %s\n", __FUNCTION__);
6364       printf ("__PRETTY_FUNCTION__ = %s\n", __PRETTY_FUNCTION__);
6365     @}
6366 @};
6367
6368 int
6369 main (void)
6370 @{
6371   a ax;
6372   ax.sub (0);
6373   return 0;
6374 @}
6375 @end smallexample
6376
6377 @noindent
6378 gives this output:
6379
6380 @smallexample
6381 __FUNCTION__ = sub
6382 __PRETTY_FUNCTION__ = void a::sub(int)
6383 @end smallexample
6384
6385 These identifiers are not preprocessor macros.  In GCC 3.3 and
6386 earlier, in C only, @code{__FUNCTION__} and @code{__PRETTY_FUNCTION__}
6387 were treated as string literals; they could be used to initialize
6388 @code{char} arrays, and they could be concatenated with other string
6389 literals.  GCC 3.4 and later treat them as variables, like
6390 @code{__func__}.  In C++, @code{__FUNCTION__} and
6391 @code{__PRETTY_FUNCTION__} have always been variables.
6392
6393 @node Return Address
6394 @section Getting the Return or Frame Address of a Function
6395
6396 These functions may be used to get information about the callers of a
6397 function.
6398
6399 @deftypefn {Built-in Function} {void *} __builtin_return_address (unsigned int @var{level})
6400 This function returns the return address of the current function, or of
6401 one of its callers.  The @var{level} argument is number of frames to
6402 scan up the call stack.  A value of @code{0} yields the return address
6403 of the current function, a value of @code{1} yields the return address
6404 of the caller of the current function, and so forth.  When inlining
6405 the expected behavior is that the function will return the address of
6406 the function that will be returned to.  To work around this behavior use
6407 the @code{noinline} function attribute.
6408
6409 The @var{level} argument must be a constant integer.
6410
6411 On some machines it may be impossible to determine the return address of
6412 any function other than the current one; in such cases, or when the top
6413 of the stack has been reached, this function will return @code{0} or a
6414 random value.  In addition, @code{__builtin_frame_address} may be used
6415 to determine if the top of the stack has been reached.
6416
6417 Additional post-processing of the returned value may be needed, see
6418 @code{__builtin_extract_return_address}.
6419
6420 This function should only be used with a nonzero argument for debugging
6421 purposes.
6422 @end deftypefn
6423
6424 @deftypefn {Built-in Function} {void *} __builtin_extract_return_address (void *@var{addr})
6425 The address as returned by @code{__builtin_return_address} may have to be fed
6426 through this function to get the actual encoded address.  For example, on the
6427 31-bit S/390 platform the highest bit has to be masked out, or on SPARC
6428 platforms an offset has to be added for the true next instruction to be
6429 executed.
6430
6431 If no fixup is needed, this function simply passes through @var{addr}.
6432 @end deftypefn
6433
6434 @deftypefn {Built-in Function} {void *} __builtin_frob_return_address (void *@var{addr})
6435 This function does the reverse of @code{__builtin_extract_return_address}.
6436 @end deftypefn
6437
6438 @deftypefn {Built-in Function} {void *} __builtin_frame_address (unsigned int @var{level})
6439 This function is similar to @code{__builtin_return_address}, but it
6440 returns the address of the function frame rather than the return address
6441 of the function.  Calling @code{__builtin_frame_address} with a value of
6442 @code{0} yields the frame address of the current function, a value of
6443 @code{1} yields the frame address of the caller of the current function,
6444 and so forth.
6445
6446 The frame is the area on the stack which holds local variables and saved
6447 registers.  The frame address is normally the address of the first word
6448 pushed on to the stack by the function.  However, the exact definition
6449 depends upon the processor and the calling convention.  If the processor
6450 has a dedicated frame pointer register, and the function has a frame,
6451 then @code{__builtin_frame_address} will return the value of the frame
6452 pointer register.
6453
6454 On some machines it may be impossible to determine the frame address of
6455 any function other than the current one; in such cases, or when the top
6456 of the stack has been reached, this function will return @code{0} if
6457 the first frame pointer is properly initialized by the startup code.
6458
6459 This function should only be used with a nonzero argument for debugging
6460 purposes.
6461 @end deftypefn
6462
6463 @node Vector Extensions
6464 @section Using vector instructions through built-in functions
6465
6466 On some targets, the instruction set contains SIMD vector instructions that
6467 operate on multiple values contained in one large register at the same time.
6468 For example, on the i386 the MMX, 3DNow!@: and SSE extensions can be used
6469 this way.
6470
6471 The first step in using these extensions is to provide the necessary data
6472 types.  This should be done using an appropriate @code{typedef}:
6473
6474 @smallexample
6475 typedef int v4si __attribute__ ((vector_size (16)));
6476 @end smallexample
6477
6478 The @code{int} type specifies the base type, while the attribute specifies
6479 the vector size for the variable, measured in bytes.  For example, the
6480 declaration above causes the compiler to set the mode for the @code{v4si}
6481 type to be 16 bytes wide and divided into @code{int} sized units.  For
6482 a 32-bit @code{int} this means a vector of 4 units of 4 bytes, and the
6483 corresponding mode of @code{foo} will be @acronym{V4SI}.
6484
6485 The @code{vector_size} attribute is only applicable to integral and
6486 float scalars, although arrays, pointers, and function return values
6487 are allowed in conjunction with this construct.
6488
6489 All the basic integer types can be used as base types, both as signed
6490 and as unsigned: @code{char}, @code{short}, @code{int}, @code{long},
6491 @code{long long}.  In addition, @code{float} and @code{double} can be
6492 used to build floating-point vector types.
6493
6494 Specifying a combination that is not valid for the current architecture
6495 will cause GCC to synthesize the instructions using a narrower mode.
6496 For example, if you specify a variable of type @code{V4SI} and your
6497 architecture does not allow for this specific SIMD type, GCC will
6498 produce code that uses 4 @code{SIs}.
6499
6500 The types defined in this manner can be used with a subset of normal C
6501 operations.  Currently, GCC will allow using the following operators
6502 on these types: @code{+, -, *, /, unary minus, ^, |, &, ~, %}@.
6503
6504 The operations behave like C++ @code{valarrays}.  Addition is defined as
6505 the addition of the corresponding elements of the operands.  For
6506 example, in the code below, each of the 4 elements in @var{a} will be
6507 added to the corresponding 4 elements in @var{b} and the resulting
6508 vector will be stored in @var{c}.
6509
6510 @smallexample
6511 typedef int v4si __attribute__ ((vector_size (16)));
6512
6513 v4si a, b, c;
6514
6515 c = a + b;
6516 @end smallexample
6517
6518 Subtraction, multiplication, division, and the logical operations
6519 operate in a similar manner.  Likewise, the result of using the unary
6520 minus or complement operators on a vector type is a vector whose
6521 elements are the negative or complemented values of the corresponding
6522 elements in the operand.
6523
6524 In C it is possible to use shifting operators @code{<<}, @code{>>} on
6525 integer-type vectors. The operation is defined as following: @code{@{a0,
6526 a1, @dots{}, an@} >> @{b0, b1, @dots{}, bn@} == @{a0 >> b0, a1 >> b1,
6527 @dots{}, an >> bn@}}@. Vector operands must have the same number of
6528 elements.  Additionally second operands can be a scalar integer in which
6529 case the scalar is converted to the type used by the vector operand (with
6530 possible truncation) and each element of this new vector is the scalar's
6531 value.
6532 Consider the following code.
6533
6534 @smallexample
6535 typedef int v4si __attribute__ ((vector_size (16)));
6536
6537 v4si a, b;
6538
6539 b = a >> 1;     /* b = a >> @{1,1,1,1@}; */
6540 @end smallexample
6541
6542 In C vectors can be subscripted as if the vector were an array with
6543 the same number of elements and base type.  Out of bound accesses
6544 invoke undefined behavior at runtime.  Warnings for out of bound
6545 accesses for vector subscription can be enabled with
6546 @option{-Warray-bounds}.
6547
6548 You can declare variables and use them in function calls and returns, as
6549 well as in assignments and some casts.  You can specify a vector type as
6550 a return type for a function.  Vector types can also be used as function
6551 arguments.  It is possible to cast from one vector type to another,
6552 provided they are of the same size (in fact, you can also cast vectors
6553 to and from other datatypes of the same size).
6554
6555 You cannot operate between vectors of different lengths or different
6556 signedness without a cast.
6557
6558 A port that supports hardware vector operations, usually provides a set
6559 of built-in functions that can be used to operate on vectors.  For
6560 example, a function to add two vectors and multiply the result by a
6561 third could look like this:
6562
6563 @smallexample
6564 v4si f (v4si a, v4si b, v4si c)
6565 @{
6566   v4si tmp = __builtin_addv4si (a, b);
6567   return __builtin_mulv4si (tmp, c);
6568 @}
6569
6570 @end smallexample
6571
6572 @node Offsetof
6573 @section Offsetof
6574 @findex __builtin_offsetof
6575
6576 GCC implements for both C and C++ a syntactic extension to implement
6577 the @code{offsetof} macro.
6578
6579 @smallexample
6580 primary:
6581         "__builtin_offsetof" "(" @code{typename} "," offsetof_member_designator ")"
6582
6583 offsetof_member_designator:
6584           @code{identifier}
6585         | offsetof_member_designator "." @code{identifier}
6586         | offsetof_member_designator "[" @code{expr} "]"
6587 @end smallexample
6588
6589 This extension is sufficient such that
6590
6591 @smallexample
6592 #define offsetof(@var{type}, @var{member})  __builtin_offsetof (@var{type}, @var{member})
6593 @end smallexample
6594
6595 is a suitable definition of the @code{offsetof} macro.  In C++, @var{type}
6596 may be dependent.  In either case, @var{member} may consist of a single
6597 identifier, or a sequence of member accesses and array references.
6598
6599 @node Atomic Builtins
6600 @section Built-in functions for atomic memory access
6601
6602 The following builtins are intended to be compatible with those described
6603 in the @cite{Intel Itanium Processor-specific Application Binary Interface},
6604 section 7.4.  As such, they depart from the normal GCC practice of using
6605 the ``__builtin_'' prefix, and further that they are overloaded such that
6606 they work on multiple types.
6607
6608 The definition given in the Intel documentation allows only for the use of
6609 the types @code{int}, @code{long}, @code{long long} as well as their unsigned
6610 counterparts.  GCC will allow any integral scalar or pointer type that is
6611 1, 2, 4 or 8 bytes in length.
6612
6613 Not all operations are supported by all target processors.  If a particular
6614 operation cannot be implemented on the target processor, a warning will be
6615 generated and a call an external function will be generated.  The external
6616 function will carry the same name as the builtin, with an additional suffix
6617 @samp{_@var{n}} where @var{n} is the size of the data type.
6618
6619 @c ??? Should we have a mechanism to suppress this warning?  This is almost
6620 @c useful for implementing the operation under the control of an external
6621 @c mutex.
6622
6623 In most cases, these builtins are considered a @dfn{full barrier}.  That is,
6624 no memory operand will be moved across the operation, either forward or
6625 backward.  Further, instructions will be issued as necessary to prevent the
6626 processor from speculating loads across the operation and from queuing stores
6627 after the operation.
6628
6629 All of the routines are described in the Intel documentation to take
6630 ``an optional list of variables protected by the memory barrier''.  It's
6631 not clear what is meant by that; it could mean that @emph{only} the
6632 following variables are protected, or it could mean that these variables
6633 should in addition be protected.  At present GCC ignores this list and
6634 protects all variables which are globally accessible.  If in the future
6635 we make some use of this list, an empty list will continue to mean all
6636 globally accessible variables.
6637
6638 @table @code
6639 @item @var{type} __sync_fetch_and_add (@var{type} *ptr, @var{type} value, ...)
6640 @itemx @var{type} __sync_fetch_and_sub (@var{type} *ptr, @var{type} value, ...)
6641 @itemx @var{type} __sync_fetch_and_or (@var{type} *ptr, @var{type} value, ...)
6642 @itemx @var{type} __sync_fetch_and_and (@var{type} *ptr, @var{type} value, ...)
6643 @itemx @var{type} __sync_fetch_and_xor (@var{type} *ptr, @var{type} value, ...)
6644 @itemx @var{type} __sync_fetch_and_nand (@var{type} *ptr, @var{type} value, ...)
6645 @findex __sync_fetch_and_add
6646 @findex __sync_fetch_and_sub
6647 @findex __sync_fetch_and_or
6648 @findex __sync_fetch_and_and
6649 @findex __sync_fetch_and_xor
6650 @findex __sync_fetch_and_nand
6651 These builtins perform the operation suggested by the name, and
6652 returns the value that had previously been in memory.  That is,
6653
6654 @smallexample
6655 @{ tmp = *ptr; *ptr @var{op}= value; return tmp; @}
6656 @{ tmp = *ptr; *ptr = ~(tmp & value); return tmp; @}   // nand
6657 @end smallexample
6658
6659 @emph{Note:} GCC 4.4 and later implement @code{__sync_fetch_and_nand}
6660 builtin as @code{*ptr = ~(tmp & value)} instead of @code{*ptr = ~tmp & value}.
6661
6662 @item @var{type} __sync_add_and_fetch (@var{type} *ptr, @var{type} value, ...)
6663 @itemx @var{type} __sync_sub_and_fetch (@var{type} *ptr, @var{type} value, ...)
6664 @itemx @var{type} __sync_or_and_fetch (@var{type} *ptr, @var{type} value, ...)
6665 @itemx @var{type} __sync_and_and_fetch (@var{type} *ptr, @var{type} value, ...)
6666 @itemx @var{type} __sync_xor_and_fetch (@var{type} *ptr, @var{type} value, ...)
6667 @itemx @var{type} __sync_nand_and_fetch (@var{type} *ptr, @var{type} value, ...)
6668 @findex __sync_add_and_fetch
6669 @findex __sync_sub_and_fetch
6670 @findex __sync_or_and_fetch
6671 @findex __sync_and_and_fetch
6672 @findex __sync_xor_and_fetch
6673 @findex __sync_nand_and_fetch
6674 These builtins perform the operation suggested by the name, and
6675 return the new value.  That is,
6676
6677 @smallexample
6678 @{ *ptr @var{op}= value; return *ptr; @}
6679 @{ *ptr = ~(*ptr & value); return *ptr; @}   // nand
6680 @end smallexample
6681
6682 @emph{Note:} GCC 4.4 and later implement @code{__sync_nand_and_fetch}
6683 builtin as @code{*ptr = ~(*ptr & value)} instead of
6684 @code{*ptr = ~*ptr & value}.
6685
6686 @item bool __sync_bool_compare_and_swap (@var{type} *ptr, @var{type} oldval @var{type} newval, ...)
6687 @itemx @var{type} __sync_val_compare_and_swap (@var{type} *ptr, @var{type} oldval @var{type} newval, ...)
6688 @findex __sync_bool_compare_and_swap
6689 @findex __sync_val_compare_and_swap
6690 These builtins perform an atomic compare and swap.  That is, if the current
6691 value of @code{*@var{ptr}} is @var{oldval}, then write @var{newval} into
6692 @code{*@var{ptr}}.
6693
6694 The ``bool'' version returns true if the comparison is successful and
6695 @var{newval} was written.  The ``val'' version returns the contents
6696 of @code{*@var{ptr}} before the operation.
6697
6698 @item __sync_synchronize (...)
6699 @findex __sync_synchronize
6700 This builtin issues a full memory barrier.
6701
6702 @item @var{type} __sync_lock_test_and_set (@var{type} *ptr, @var{type} value, ...)
6703 @findex __sync_lock_test_and_set
6704 This builtin, as described by Intel, is not a traditional test-and-set
6705 operation, but rather an atomic exchange operation.  It writes @var{value}
6706 into @code{*@var{ptr}}, and returns the previous contents of
6707 @code{*@var{ptr}}.
6708
6709 Many targets have only minimal support for such locks, and do not support
6710 a full exchange operation.  In this case, a target may support reduced
6711 functionality here by which the @emph{only} valid value to store is the
6712 immediate constant 1.  The exact value actually stored in @code{*@var{ptr}}
6713 is implementation defined.
6714
6715 This builtin is not a full barrier, but rather an @dfn{acquire barrier}.
6716 This means that references after the builtin cannot move to (or be
6717 speculated to) before the builtin, but previous memory stores may not
6718 be globally visible yet, and previous memory loads may not yet be
6719 satisfied.
6720
6721 @item void __sync_lock_release (@var{type} *ptr, ...)
6722 @findex __sync_lock_release
6723 This builtin releases the lock acquired by @code{__sync_lock_test_and_set}.
6724 Normally this means writing the constant 0 to @code{*@var{ptr}}.
6725
6726 This builtin is not a full barrier, but rather a @dfn{release barrier}.
6727 This means that all previous memory stores are globally visible, and all
6728 previous memory loads have been satisfied, but following memory reads
6729 are not prevented from being speculated to before the barrier.
6730 @end table
6731
6732 @node Object Size Checking
6733 @section Object Size Checking Builtins
6734 @findex __builtin_object_size
6735 @findex __builtin___memcpy_chk
6736 @findex __builtin___mempcpy_chk
6737 @findex __builtin___memmove_chk
6738 @findex __builtin___memset_chk
6739 @findex __builtin___strcpy_chk
6740 @findex __builtin___stpcpy_chk
6741 @findex __builtin___strncpy_chk
6742 @findex __builtin___strcat_chk
6743 @findex __builtin___strncat_chk
6744 @findex __builtin___sprintf_chk
6745 @findex __builtin___snprintf_chk
6746 @findex __builtin___vsprintf_chk
6747 @findex __builtin___vsnprintf_chk
6748 @findex __builtin___printf_chk
6749 @findex __builtin___vprintf_chk
6750 @findex __builtin___fprintf_chk
6751 @findex __builtin___vfprintf_chk
6752
6753 GCC implements a limited buffer overflow protection mechanism
6754 that can prevent some buffer overflow attacks.
6755
6756 @deftypefn {Built-in Function} {size_t} __builtin_object_size (void * @var{ptr}, int @var{type})
6757 is a built-in construct that returns a constant number of bytes from
6758 @var{ptr} to the end of the object @var{ptr} pointer points to
6759 (if known at compile time).  @code{__builtin_object_size} never evaluates
6760 its arguments for side-effects.  If there are any side-effects in them, it
6761 returns @code{(size_t) -1} for @var{type} 0 or 1 and @code{(size_t) 0}
6762 for @var{type} 2 or 3.  If there are multiple objects @var{ptr} can
6763 point to and all of them are known at compile time, the returned number
6764 is the maximum of remaining byte counts in those objects if @var{type} & 2 is
6765 0 and minimum if nonzero.  If it is not possible to determine which objects
6766 @var{ptr} points to at compile time, @code{__builtin_object_size} should
6767 return @code{(size_t) -1} for @var{type} 0 or 1 and @code{(size_t) 0}
6768 for @var{type} 2 or 3.
6769
6770 @var{type} is an integer constant from 0 to 3.  If the least significant
6771 bit is clear, objects are whole variables, if it is set, a closest
6772 surrounding subobject is considered the object a pointer points to.
6773 The second bit determines if maximum or minimum of remaining bytes
6774 is computed.
6775
6776 @smallexample
6777 struct V @{ char buf1[10]; int b; char buf2[10]; @} var;
6778 char *p = &var.buf1[1], *q = &var.b;
6779
6780 /* Here the object p points to is var.  */
6781 assert (__builtin_object_size (p, 0) == sizeof (var) - 1);
6782 /* The subobject p points to is var.buf1.  */
6783 assert (__builtin_object_size (p, 1) == sizeof (var.buf1) - 1);
6784 /* The object q points to is var.  */
6785 assert (__builtin_object_size (q, 0)
6786         == (char *) (&var + 1) - (char *) &var.b);
6787 /* The subobject q points to is var.b.  */
6788 assert (__builtin_object_size (q, 1) == sizeof (var.b));
6789 @end smallexample
6790 @end deftypefn
6791
6792 There are built-in functions added for many common string operation
6793 functions, e.g., for @code{memcpy} @code{__builtin___memcpy_chk}
6794 built-in is provided.  This built-in has an additional last argument,
6795 which is the number of bytes remaining in object the @var{dest}
6796 argument points to or @code{(size_t) -1} if the size is not known.
6797
6798 The built-in functions are optimized into the normal string functions
6799 like @code{memcpy} if the last argument is @code{(size_t) -1} or if
6800 it is known at compile time that the destination object will not
6801 be overflown.  If the compiler can determine at compile time the
6802 object will be always overflown, it issues a warning.
6803
6804 The intended use can be e.g.
6805
6806 @smallexample
6807 #undef memcpy
6808 #define bos0(dest) __builtin_object_size (dest, 0)
6809 #define memcpy(dest, src, n) \
6810   __builtin___memcpy_chk (dest, src, n, bos0 (dest))
6811
6812 char *volatile p;
6813 char buf[10];
6814 /* It is unknown what object p points to, so this is optimized
6815    into plain memcpy - no checking is possible.  */
6816 memcpy (p, "abcde", n);
6817 /* Destination is known and length too.  It is known at compile
6818    time there will be no overflow.  */
6819 memcpy (&buf[5], "abcde", 5);
6820 /* Destination is known, but the length is not known at compile time.
6821    This will result in __memcpy_chk call that can check for overflow
6822    at runtime.  */
6823 memcpy (&buf[5], "abcde", n);
6824 /* Destination is known and it is known at compile time there will
6825    be overflow.  There will be a warning and __memcpy_chk call that
6826    will abort the program at runtime.  */
6827 memcpy (&buf[6], "abcde", 5);
6828 @end smallexample
6829
6830 Such built-in functions are provided for @code{memcpy}, @code{mempcpy},
6831 @code{memmove}, @code{memset}, @code{strcpy}, @code{stpcpy}, @code{strncpy},
6832 @code{strcat} and @code{strncat}.
6833
6834 There are also checking built-in functions for formatted output functions.
6835 @smallexample
6836 int __builtin___sprintf_chk (char *s, int flag, size_t os, const char *fmt, ...);
6837 int __builtin___snprintf_chk (char *s, size_t maxlen, int flag, size_t os,
6838                               const char *fmt, ...);
6839 int __builtin___vsprintf_chk (char *s, int flag, size_t os, const char *fmt,
6840                               va_list ap);
6841 int __builtin___vsnprintf_chk (char *s, size_t maxlen, int flag, size_t os,
6842                                const char *fmt, va_list ap);
6843 @end smallexample
6844
6845 The added @var{flag} argument is passed unchanged to @code{__sprintf_chk}
6846 etc.@: functions and can contain implementation specific flags on what
6847 additional security measures the checking function might take, such as
6848 handling @code{%n} differently.
6849
6850 The @var{os} argument is the object size @var{s} points to, like in the
6851 other built-in functions.  There is a small difference in the behavior
6852 though, if @var{os} is @code{(size_t) -1}, the built-in functions are
6853 optimized into the non-checking functions only if @var{flag} is 0, otherwise
6854 the checking function is called with @var{os} argument set to
6855 @code{(size_t) -1}.
6856
6857 In addition to this, there are checking built-in functions
6858 @code{__builtin___printf_chk}, @code{__builtin___vprintf_chk},
6859 @code{__builtin___fprintf_chk} and @code{__builtin___vfprintf_chk}.
6860 These have just one additional argument, @var{flag}, right before
6861 format string @var{fmt}.  If the compiler is able to optimize them to
6862 @code{fputc} etc.@: functions, it will, otherwise the checking function
6863 should be called and the @var{flag} argument passed to it.
6864
6865 @node Other Builtins
6866 @section Other built-in functions provided by GCC
6867 @cindex built-in functions
6868 @findex __builtin_fpclassify
6869 @findex __builtin_isfinite
6870 @findex __builtin_isnormal
6871 @findex __builtin_isgreater
6872 @findex __builtin_isgreaterequal
6873 @findex __builtin_isinf_sign
6874 @findex __builtin_isless
6875 @findex __builtin_islessequal
6876 @findex __builtin_islessgreater
6877 @findex __builtin_isunordered
6878 @findex __builtin_powi
6879 @findex __builtin_powif
6880 @findex __builtin_powil
6881 @findex _Exit
6882 @findex _exit
6883 @findex abort
6884 @findex abs
6885 @findex acos
6886 @findex acosf
6887 @findex acosh
6888 @findex acoshf
6889 @findex acoshl
6890 @findex acosl
6891 @findex alloca
6892 @findex asin
6893 @findex asinf
6894 @findex asinh
6895 @findex asinhf
6896 @findex asinhl
6897 @findex asinl
6898 @findex atan
6899 @findex atan2
6900 @findex atan2f
6901 @findex atan2l
6902 @findex atanf
6903 @findex atanh
6904 @findex atanhf
6905 @findex atanhl
6906 @findex atanl
6907 @findex bcmp
6908 @findex bzero
6909 @findex cabs
6910 @findex cabsf
6911 @findex cabsl
6912 @findex cacos
6913 @findex cacosf
6914 @findex cacosh
6915 @findex cacoshf
6916 @findex cacoshl
6917 @findex cacosl
6918 @findex calloc
6919 @findex carg
6920 @findex cargf
6921 @findex cargl
6922 @findex casin
6923 @findex casinf
6924 @findex casinh
6925 @findex casinhf
6926 @findex casinhl
6927 @findex casinl
6928 @findex catan
6929 @findex catanf
6930 @findex catanh
6931 @findex catanhf
6932 @findex catanhl
6933 @findex catanl
6934 @findex cbrt
6935 @findex cbrtf
6936 @findex cbrtl
6937 @findex ccos
6938 @findex ccosf
6939 @findex ccosh
6940 @findex ccoshf
6941 @findex ccoshl
6942 @findex ccosl
6943 @findex ceil
6944 @findex ceilf
6945 @findex ceill
6946 @findex cexp
6947 @findex cexpf
6948 @findex cexpl
6949 @findex cimag
6950 @findex cimagf
6951 @findex cimagl
6952 @findex clog
6953 @findex clogf
6954 @findex clogl
6955 @findex conj
6956 @findex conjf
6957 @findex conjl
6958 @findex copysign
6959 @findex copysignf
6960 @findex copysignl
6961 @findex cos
6962 @findex cosf
6963 @findex cosh
6964 @findex coshf
6965 @findex coshl
6966 @findex cosl
6967 @findex cpow
6968 @findex cpowf
6969 @findex cpowl
6970 @findex cproj
6971 @findex cprojf
6972 @findex cprojl
6973 @findex creal
6974 @findex crealf
6975 @findex creall
6976 @findex csin
6977 @findex csinf
6978 @findex csinh
6979 @findex csinhf
6980 @findex csinhl
6981 @findex csinl
6982 @findex csqrt
6983 @findex csqrtf
6984 @findex csqrtl
6985 @findex ctan
6986 @findex ctanf
6987 @findex ctanh
6988 @findex ctanhf
6989 @findex ctanhl
6990 @findex ctanl
6991 @findex dcgettext
6992 @findex dgettext
6993 @findex drem
6994 @findex dremf
6995 @findex dreml
6996 @findex erf
6997 @findex erfc
6998 @findex erfcf
6999 @findex erfcl
7000 @findex erff
7001 @findex erfl
7002 @findex exit
7003 @findex exp
7004 @findex exp10
7005 @findex exp10f
7006 @findex exp10l
7007 @findex exp2
7008 @findex exp2f
7009 @findex exp2l
7010 @findex expf
7011 @findex expl
7012 @findex expm1
7013 @findex expm1f
7014 @findex expm1l
7015 @findex fabs
7016 @findex fabsf
7017 @findex fabsl
7018 @findex fdim
7019 @findex fdimf
7020 @findex fdiml
7021 @findex ffs
7022 @findex floor
7023 @findex floorf
7024 @findex floorl
7025 @findex fma
7026 @findex fmaf
7027 @findex fmal
7028 @findex fmax
7029 @findex fmaxf
7030 @findex fmaxl
7031 @findex fmin
7032 @findex fminf
7033 @findex fminl
7034 @findex fmod
7035 @findex fmodf
7036 @findex fmodl
7037 @findex fprintf
7038 @findex fprintf_unlocked
7039 @findex fputs
7040 @findex fputs_unlocked
7041 @findex frexp
7042 @findex frexpf
7043 @findex frexpl
7044 @findex fscanf
7045 @findex gamma
7046 @findex gammaf
7047 @findex gammal
7048 @findex gamma_r
7049 @findex gammaf_r
7050 @findex gammal_r
7051 @findex gettext
7052 @findex hypot
7053 @findex hypotf
7054 @findex hypotl
7055 @findex ilogb
7056 @findex ilogbf
7057 @findex ilogbl
7058 @findex imaxabs
7059 @findex index
7060 @findex isalnum
7061 @findex isalpha
7062 @findex isascii
7063 @findex isblank
7064 @findex iscntrl
7065 @findex isdigit
7066 @findex isgraph
7067 @findex islower
7068 @findex isprint
7069 @findex ispunct
7070 @findex isspace
7071 @findex isupper
7072 @findex iswalnum
7073 @findex iswalpha
7074 @findex iswblank
7075 @findex iswcntrl
7076 @findex iswdigit
7077 @findex iswgraph
7078 @findex iswlower
7079 @findex iswprint
7080 @findex iswpunct
7081 @findex iswspace
7082 @findex iswupper
7083 @findex iswxdigit
7084 @findex isxdigit
7085 @findex j0
7086 @findex j0f
7087 @findex j0l
7088 @findex j1
7089 @findex j1f
7090 @findex j1l
7091 @findex jn
7092 @findex jnf
7093 @findex jnl
7094 @findex labs
7095 @findex ldexp
7096 @findex ldexpf
7097 @findex ldexpl
7098 @findex lgamma
7099 @findex lgammaf
7100 @findex lgammal
7101 @findex lgamma_r
7102 @findex lgammaf_r
7103 @findex lgammal_r
7104 @findex llabs
7105 @findex llrint
7106 @findex llrintf
7107 @findex llrintl
7108 @findex llround
7109 @findex llroundf
7110 @findex llroundl
7111 @findex log
7112 @findex log10
7113 @findex log10f
7114 @findex log10l
7115 @findex log1p
7116 @findex log1pf
7117 @findex log1pl
7118 @findex log2
7119 @findex log2f
7120 @findex log2l
7121 @findex logb
7122 @findex logbf
7123 @findex logbl
7124 @findex logf
7125 @findex logl
7126 @findex lrint
7127 @findex lrintf
7128 @findex lrintl
7129 @findex lround
7130 @findex lroundf
7131 @findex lroundl
7132 @findex malloc
7133 @findex memchr
7134 @findex memcmp
7135 @findex memcpy
7136 @findex mempcpy
7137 @findex memset
7138 @findex modf
7139 @findex modff
7140 @findex modfl
7141 @findex nearbyint
7142 @findex nearbyintf
7143 @findex nearbyintl
7144 @findex nextafter
7145 @findex nextafterf
7146 @findex nextafterl
7147 @findex nexttoward
7148 @findex nexttowardf
7149 @findex nexttowardl
7150 @findex pow
7151 @findex pow10
7152 @findex pow10f
7153 @findex pow10l
7154 @findex powf
7155 @findex powl
7156 @findex printf
7157 @findex printf_unlocked
7158 @findex putchar
7159 @findex puts
7160 @findex remainder
7161 @findex remainderf
7162 @findex remainderl
7163 @findex remquo
7164 @findex remquof
7165 @findex remquol
7166 @findex rindex
7167 @findex rint
7168 @findex rintf
7169 @findex rintl
7170 @findex round
7171 @findex roundf
7172 @findex roundl
7173 @findex scalb
7174 @findex scalbf
7175 @findex scalbl
7176 @findex scalbln
7177 @findex scalblnf
7178 @findex scalblnf
7179 @findex scalbn
7180 @findex scalbnf
7181 @findex scanfnl
7182 @findex signbit
7183 @findex signbitf
7184 @findex signbitl
7185 @findex signbitd32
7186 @findex signbitd64
7187 @findex signbitd128
7188 @findex significand
7189 @findex significandf
7190 @findex significandl
7191 @findex sin
7192 @findex sincos
7193 @findex sincosf
7194 @findex sincosl
7195 @findex sinf
7196 @findex sinh
7197 @findex sinhf
7198 @findex sinhl
7199 @findex sinl
7200 @findex snprintf
7201 @findex sprintf
7202 @findex sqrt
7203 @findex sqrtf
7204 @findex sqrtl
7205 @findex sscanf
7206 @findex stpcpy
7207 @findex stpncpy
7208 @findex strcasecmp
7209 @findex strcat
7210 @findex strchr
7211 @findex strcmp
7212 @findex strcpy
7213 @findex strcspn
7214 @findex strdup
7215 @findex strfmon
7216 @findex strftime
7217 @findex strlen
7218 @findex strncasecmp
7219 @findex strncat
7220 @findex strncmp
7221 @findex strncpy
7222 @findex strndup
7223 @findex strpbrk
7224 @findex strrchr
7225 @findex strspn
7226 @findex strstr
7227 @findex tan
7228 @findex tanf
7229 @findex tanh
7230 @findex tanhf
7231 @findex tanhl
7232 @findex tanl
7233 @findex tgamma
7234 @findex tgammaf
7235 @findex tgammal
7236 @findex toascii
7237 @findex tolower
7238 @findex toupper
7239 @findex towlower
7240 @findex towupper
7241 @findex trunc
7242 @findex truncf
7243 @findex truncl
7244 @findex vfprintf
7245 @findex vfscanf
7246 @findex vprintf
7247 @findex vscanf
7248 @findex vsnprintf
7249 @findex vsprintf
7250 @findex vsscanf
7251 @findex y0
7252 @findex y0f
7253 @findex y0l
7254 @findex y1
7255 @findex y1f
7256 @findex y1l
7257 @findex yn
7258 @findex ynf
7259 @findex ynl
7260
7261 GCC provides a large number of built-in functions other than the ones
7262 mentioned above.  Some of these are for internal use in the processing
7263 of exceptions or variable-length argument lists and will not be
7264 documented here because they may change from time to time; we do not
7265 recommend general use of these functions.
7266
7267 The remaining functions are provided for optimization purposes.
7268
7269 @opindex fno-builtin
7270 GCC includes built-in versions of many of the functions in the standard
7271 C library.  The versions prefixed with @code{__builtin_} will always be
7272 treated as having the same meaning as the C library function even if you
7273 specify the @option{-fno-builtin} option.  (@pxref{C Dialect Options})
7274 Many of these functions are only optimized in certain cases; if they are
7275 not optimized in a particular case, a call to the library function will
7276 be emitted.
7277
7278 @opindex ansi
7279 @opindex std
7280 Outside strict ISO C mode (@option{-ansi}, @option{-std=c90},
7281 @option{-std=c99} or @option{-std=c1x}), the functions
7282 @code{_exit}, @code{alloca}, @code{bcmp}, @code{bzero},
7283 @code{dcgettext}, @code{dgettext}, @code{dremf}, @code{dreml},
7284 @code{drem}, @code{exp10f}, @code{exp10l}, @code{exp10}, @code{ffsll},
7285 @code{ffsl}, @code{ffs}, @code{fprintf_unlocked},
7286 @code{fputs_unlocked}, @code{gammaf}, @code{gammal}, @code{gamma},
7287 @code{gammaf_r}, @code{gammal_r}, @code{gamma_r}, @code{gettext},
7288 @code{index}, @code{isascii}, @code{j0f}, @code{j0l}, @code{j0},
7289 @code{j1f}, @code{j1l}, @code{j1}, @code{jnf}, @code{jnl}, @code{jn},
7290 @code{lgammaf_r}, @code{lgammal_r}, @code{lgamma_r}, @code{mempcpy},
7291 @code{pow10f}, @code{pow10l}, @code{pow10}, @code{printf_unlocked},
7292 @code{rindex}, @code{scalbf}, @code{scalbl}, @code{scalb},
7293 @code{signbit}, @code{signbitf}, @code{signbitl}, @code{signbitd32},
7294 @code{signbitd64}, @code{signbitd128}, @code{significandf},
7295 @code{significandl}, @code{significand}, @code{sincosf},
7296 @code{sincosl}, @code{sincos}, @code{stpcpy}, @code{stpncpy},
7297 @code{strcasecmp}, @code{strdup}, @code{strfmon}, @code{strncasecmp},
7298 @code{strndup}, @code{toascii}, @code{y0f}, @code{y0l}, @code{y0},
7299 @code{y1f}, @code{y1l}, @code{y1}, @code{ynf}, @code{ynl} and
7300 @code{yn}
7301 may be handled as built-in functions.
7302 All these functions have corresponding versions
7303 prefixed with @code{__builtin_}, which may be used even in strict C90
7304 mode.
7305
7306 The ISO C99 functions
7307 @code{_Exit}, @code{acoshf}, @code{acoshl}, @code{acosh}, @code{asinhf},
7308 @code{asinhl}, @code{asinh}, @code{atanhf}, @code{atanhl}, @code{atanh},
7309 @code{cabsf}, @code{cabsl}, @code{cabs}, @code{cacosf}, @code{cacoshf},
7310 @code{cacoshl}, @code{cacosh}, @code{cacosl}, @code{cacos},
7311 @code{cargf}, @code{cargl}, @code{carg}, @code{casinf}, @code{casinhf},
7312 @code{casinhl}, @code{casinh}, @code{casinl}, @code{casin},
7313 @code{catanf}, @code{catanhf}, @code{catanhl}, @code{catanh},
7314 @code{catanl}, @code{catan}, @code{cbrtf}, @code{cbrtl}, @code{cbrt},
7315 @code{ccosf}, @code{ccoshf}, @code{ccoshl}, @code{ccosh}, @code{ccosl},
7316 @code{ccos}, @code{cexpf}, @code{cexpl}, @code{cexp}, @code{cimagf},
7317 @code{cimagl}, @code{cimag}, @code{clogf}, @code{clogl}, @code{clog},
7318 @code{conjf}, @code{conjl}, @code{conj}, @code{copysignf}, @code{copysignl},
7319 @code{copysign}, @code{cpowf}, @code{cpowl}, @code{cpow}, @code{cprojf},
7320 @code{cprojl}, @code{cproj}, @code{crealf}, @code{creall}, @code{creal},
7321 @code{csinf}, @code{csinhf}, @code{csinhl}, @code{csinh}, @code{csinl},
7322 @code{csin}, @code{csqrtf}, @code{csqrtl}, @code{csqrt}, @code{ctanf},
7323 @code{ctanhf}, @code{ctanhl}, @code{ctanh}, @code{ctanl}, @code{ctan},
7324 @code{erfcf}, @code{erfcl}, @code{erfc}, @code{erff}, @code{erfl},
7325 @code{erf}, @code{exp2f}, @code{exp2l}, @code{exp2}, @code{expm1f},
7326 @code{expm1l}, @code{expm1}, @code{fdimf}, @code{fdiml}, @code{fdim},
7327 @code{fmaf}, @code{fmal}, @code{fmaxf}, @code{fmaxl}, @code{fmax},
7328 @code{fma}, @code{fminf}, @code{fminl}, @code{fmin}, @code{hypotf},
7329 @code{hypotl}, @code{hypot}, @code{ilogbf}, @code{ilogbl}, @code{ilogb},
7330 @code{imaxabs}, @code{isblank}, @code{iswblank}, @code{lgammaf},
7331 @code{lgammal}, @code{lgamma}, @code{llabs}, @code{llrintf}, @code{llrintl},
7332 @code{llrint}, @code{llroundf}, @code{llroundl}, @code{llround},
7333 @code{log1pf}, @code{log1pl}, @code{log1p}, @code{log2f}, @code{log2l},
7334 @code{log2}, @code{logbf}, @code{logbl}, @code{logb}, @code{lrintf},
7335 @code{lrintl}, @code{lrint}, @code{lroundf}, @code{lroundl},
7336 @code{lround}, @code{nearbyintf}, @code{nearbyintl}, @code{nearbyint},
7337 @code{nextafterf}, @code{nextafterl}, @code{nextafter},
7338 @code{nexttowardf}, @code{nexttowardl}, @code{nexttoward},
7339 @code{remainderf}, @code{remainderl}, @code{remainder}, @code{remquof},
7340 @code{remquol}, @code{remquo}, @code{rintf}, @code{rintl}, @code{rint},
7341 @code{roundf}, @code{roundl}, @code{round}, @code{scalblnf},
7342 @code{scalblnl}, @code{scalbln}, @code{scalbnf}, @code{scalbnl},
7343 @code{scalbn}, @code{snprintf}, @code{tgammaf}, @code{tgammal},
7344 @code{tgamma}, @code{truncf}, @code{truncl}, @code{trunc},
7345 @code{vfscanf}, @code{vscanf}, @code{vsnprintf} and @code{vsscanf}
7346 are handled as built-in functions
7347 except in strict ISO C90 mode (@option{-ansi} or @option{-std=c90}).
7348
7349 There are also built-in versions of the ISO C99 functions
7350 @code{acosf}, @code{acosl}, @code{asinf}, @code{asinl}, @code{atan2f},
7351 @code{atan2l}, @code{atanf}, @code{atanl}, @code{ceilf}, @code{ceill},
7352 @code{cosf}, @code{coshf}, @code{coshl}, @code{cosl}, @code{expf},
7353 @code{expl}, @code{fabsf}, @code{fabsl}, @code{floorf}, @code{floorl},
7354 @code{fmodf}, @code{fmodl}, @code{frexpf}, @code{frexpl}, @code{ldexpf},
7355 @code{ldexpl}, @code{log10f}, @code{log10l}, @code{logf}, @code{logl},
7356 @code{modfl}, @code{modf}, @code{powf}, @code{powl}, @code{sinf},
7357 @code{sinhf}, @code{sinhl}, @code{sinl}, @code{sqrtf}, @code{sqrtl},
7358 @code{tanf}, @code{tanhf}, @code{tanhl} and @code{tanl}
7359 that are recognized in any mode since ISO C90 reserves these names for
7360 the purpose to which ISO C99 puts them.  All these functions have
7361 corresponding versions prefixed with @code{__builtin_}.
7362
7363 The ISO C94 functions
7364 @code{iswalnum}, @code{iswalpha}, @code{iswcntrl}, @code{iswdigit},
7365 @code{iswgraph}, @code{iswlower}, @code{iswprint}, @code{iswpunct},
7366 @code{iswspace}, @code{iswupper}, @code{iswxdigit}, @code{towlower} and
7367 @code{towupper}
7368 are handled as built-in functions
7369 except in strict ISO C90 mode (@option{-ansi} or @option{-std=c90}).
7370
7371 The ISO C90 functions
7372 @code{abort}, @code{abs}, @code{acos}, @code{asin}, @code{atan2},
7373 @code{atan}, @code{calloc}, @code{ceil}, @code{cosh}, @code{cos},
7374 @code{exit}, @code{exp}, @code{fabs}, @code{floor}, @code{fmod},
7375 @code{fprintf}, @code{fputs}, @code{frexp}, @code{fscanf},
7376 @code{isalnum}, @code{isalpha}, @code{iscntrl}, @code{isdigit},
7377 @code{isgraph}, @code{islower}, @code{isprint}, @code{ispunct},
7378 @code{isspace}, @code{isupper}, @code{isxdigit}, @code{tolower},
7379 @code{toupper}, @code{labs}, @code{ldexp}, @code{log10}, @code{log},
7380 @code{malloc}, @code{memchr}, @code{memcmp}, @code{memcpy},
7381 @code{memset}, @code{modf}, @code{pow}, @code{printf}, @code{putchar},
7382 @code{puts}, @code{scanf}, @code{sinh}, @code{sin}, @code{snprintf},
7383 @code{sprintf}, @code{sqrt}, @code{sscanf}, @code{strcat},
7384 @code{strchr}, @code{strcmp}, @code{strcpy}, @code{strcspn},
7385 @code{strlen}, @code{strncat}, @code{strncmp}, @code{strncpy},
7386 @code{strpbrk}, @code{strrchr}, @code{strspn}, @code{strstr},
7387 @code{tanh}, @code{tan}, @code{vfprintf}, @code{vprintf} and @code{vsprintf}
7388 are all recognized as built-in functions unless
7389 @option{-fno-builtin} is specified (or @option{-fno-builtin-@var{function}}
7390 is specified for an individual function).  All of these functions have
7391 corresponding versions prefixed with @code{__builtin_}.
7392
7393 GCC provides built-in versions of the ISO C99 floating point comparison
7394 macros that avoid raising exceptions for unordered operands.  They have
7395 the same names as the standard macros ( @code{isgreater},
7396 @code{isgreaterequal}, @code{isless}, @code{islessequal},
7397 @code{islessgreater}, and @code{isunordered}) , with @code{__builtin_}
7398 prefixed.  We intend for a library implementor to be able to simply
7399 @code{#define} each standard macro to its built-in equivalent.
7400 In the same fashion, GCC provides @code{fpclassify}, @code{isfinite},
7401 @code{isinf_sign} and @code{isnormal} built-ins used with
7402 @code{__builtin_} prefixed.  The @code{isinf} and @code{isnan}
7403 builtins appear both with and without the @code{__builtin_} prefix.
7404
7405 @deftypefn {Built-in Function} int __builtin_types_compatible_p (@var{type1}, @var{type2})
7406
7407 You can use the built-in function @code{__builtin_types_compatible_p} to
7408 determine whether two types are the same.
7409
7410 This built-in function returns 1 if the unqualified versions of the
7411 types @var{type1} and @var{type2} (which are types, not expressions) are
7412 compatible, 0 otherwise.  The result of this built-in function can be
7413 used in integer constant expressions.
7414
7415 This built-in function ignores top level qualifiers (e.g., @code{const},
7416 @code{volatile}).  For example, @code{int} is equivalent to @code{const
7417 int}.
7418
7419 The type @code{int[]} and @code{int[5]} are compatible.  On the other
7420 hand, @code{int} and @code{char *} are not compatible, even if the size
7421 of their types, on the particular architecture are the same.  Also, the
7422 amount of pointer indirection is taken into account when determining
7423 similarity.  Consequently, @code{short *} is not similar to
7424 @code{short **}.  Furthermore, two types that are typedefed are
7425 considered compatible if their underlying types are compatible.
7426
7427 An @code{enum} type is not considered to be compatible with another
7428 @code{enum} type even if both are compatible with the same integer
7429 type; this is what the C standard specifies.
7430 For example, @code{enum @{foo, bar@}} is not similar to
7431 @code{enum @{hot, dog@}}.
7432
7433 You would typically use this function in code whose execution varies
7434 depending on the arguments' types.  For example:
7435
7436 @smallexample
7437 #define foo(x)                                                  \
7438   (@{                                                           \
7439     typeof (x) tmp = (x);                                       \
7440     if (__builtin_types_compatible_p (typeof (x), long double)) \
7441       tmp = foo_long_double (tmp);                              \
7442     else if (__builtin_types_compatible_p (typeof (x), double)) \
7443       tmp = foo_double (tmp);                                   \
7444     else if (__builtin_types_compatible_p (typeof (x), float))  \
7445       tmp = foo_float (tmp);                                    \
7446     else                                                        \
7447       abort ();                                                 \
7448     tmp;                                                        \
7449   @})
7450 @end smallexample
7451
7452 @emph{Note:} This construct is only available for C@.
7453
7454 @end deftypefn
7455
7456 @deftypefn {Built-in Function} @var{type} __builtin_choose_expr (@var{const_exp}, @var{exp1}, @var{exp2})
7457
7458 You can use the built-in function @code{__builtin_choose_expr} to
7459 evaluate code depending on the value of a constant expression.  This
7460 built-in function returns @var{exp1} if @var{const_exp}, which is an
7461 integer constant expression, is nonzero.  Otherwise it returns @var{exp2}.
7462
7463 This built-in function is analogous to the @samp{? :} operator in C,
7464 except that the expression returned has its type unaltered by promotion
7465 rules.  Also, the built-in function does not evaluate the expression
7466 that was not chosen.  For example, if @var{const_exp} evaluates to true,
7467 @var{exp2} is not evaluated even if it has side-effects.
7468
7469 This built-in function can return an lvalue if the chosen argument is an
7470 lvalue.
7471
7472 If @var{exp1} is returned, the return type is the same as @var{exp1}'s
7473 type.  Similarly, if @var{exp2} is returned, its return type is the same
7474 as @var{exp2}.
7475
7476 Example:
7477
7478 @smallexample
7479 #define foo(x)                                                    \
7480   __builtin_choose_expr (                                         \
7481     __builtin_types_compatible_p (typeof (x), double),            \
7482     foo_double (x),                                               \
7483     __builtin_choose_expr (                                       \
7484       __builtin_types_compatible_p (typeof (x), float),           \
7485       foo_float (x),                                              \
7486       /* @r{The void expression results in a compile-time error}  \
7487          @r{when assigning the result to something.}  */          \
7488       (void)0))
7489 @end smallexample
7490
7491 @emph{Note:} This construct is only available for C@.  Furthermore, the
7492 unused expression (@var{exp1} or @var{exp2} depending on the value of
7493 @var{const_exp}) may still generate syntax errors.  This may change in
7494 future revisions.
7495
7496 @end deftypefn
7497
7498 @deftypefn {Built-in Function} int __builtin_constant_p (@var{exp})
7499 You can use the built-in function @code{__builtin_constant_p} to
7500 determine if a value is known to be constant at compile-time and hence
7501 that GCC can perform constant-folding on expressions involving that
7502 value.  The argument of the function is the value to test.  The function
7503 returns the integer 1 if the argument is known to be a compile-time
7504 constant and 0 if it is not known to be a compile-time constant.  A
7505 return of 0 does not indicate that the value is @emph{not} a constant,
7506 but merely that GCC cannot prove it is a constant with the specified
7507 value of the @option{-O} option.
7508
7509 You would typically use this function in an embedded application where
7510 memory was a critical resource.  If you have some complex calculation,
7511 you may want it to be folded if it involves constants, but need to call
7512 a function if it does not.  For example:
7513
7514 @smallexample
7515 #define Scale_Value(X)      \
7516   (__builtin_constant_p (X) \
7517   ? ((X) * SCALE + OFFSET) : Scale (X))
7518 @end smallexample
7519
7520 You may use this built-in function in either a macro or an inline
7521 function.  However, if you use it in an inlined function and pass an
7522 argument of the function as the argument to the built-in, GCC will
7523 never return 1 when you call the inline function with a string constant
7524 or compound literal (@pxref{Compound Literals}) and will not return 1
7525 when you pass a constant numeric value to the inline function unless you
7526 specify the @option{-O} option.
7527
7528 You may also use @code{__builtin_constant_p} in initializers for static
7529 data.  For instance, you can write
7530
7531 @smallexample
7532 static const int table[] = @{
7533    __builtin_constant_p (EXPRESSION) ? (EXPRESSION) : -1,
7534    /* @r{@dots{}} */
7535 @};
7536 @end smallexample
7537
7538 @noindent
7539 This is an acceptable initializer even if @var{EXPRESSION} is not a
7540 constant expression, including the case where
7541 @code{__builtin_constant_p} returns 1 because @var{EXPRESSION} can be
7542 folded to a constant but @var{EXPRESSION} contains operands that would
7543 not otherwise be permitted in a static initializer (for example,
7544 @code{0 && foo ()}).  GCC must be more conservative about evaluating the
7545 built-in in this case, because it has no opportunity to perform
7546 optimization.
7547
7548 Previous versions of GCC did not accept this built-in in data
7549 initializers.  The earliest version where it is completely safe is
7550 3.0.1.
7551 @end deftypefn
7552
7553 @deftypefn {Built-in Function} long __builtin_expect (long @var{exp}, long @var{c})
7554 @opindex fprofile-arcs
7555 You may use @code{__builtin_expect} to provide the compiler with
7556 branch prediction information.  In general, you should prefer to
7557 use actual profile feedback for this (@option{-fprofile-arcs}), as
7558 programmers are notoriously bad at predicting how their programs
7559 actually perform.  However, there are applications in which this
7560 data is hard to collect.
7561
7562 The return value is the value of @var{exp}, which should be an integral
7563 expression.  The semantics of the built-in are that it is expected that
7564 @var{exp} == @var{c}.  For example:
7565
7566 @smallexample
7567 if (__builtin_expect (x, 0))
7568   foo ();
7569 @end smallexample
7570
7571 @noindent
7572 would indicate that we do not expect to call @code{foo}, since
7573 we expect @code{x} to be zero.  Since you are limited to integral
7574 expressions for @var{exp}, you should use constructions such as
7575
7576 @smallexample
7577 if (__builtin_expect (ptr != NULL, 1))
7578   error ();
7579 @end smallexample
7580
7581 @noindent
7582 when testing pointer or floating-point values.
7583 @end deftypefn
7584
7585 @deftypefn {Built-in Function} void __builtin_trap (void)
7586 This function causes the program to exit abnormally.  GCC implements
7587 this function by using a target-dependent mechanism (such as
7588 intentionally executing an illegal instruction) or by calling
7589 @code{abort}.  The mechanism used may vary from release to release so
7590 you should not rely on any particular implementation.
7591 @end deftypefn
7592
7593 @deftypefn {Built-in Function} void __builtin_unreachable (void)
7594 If control flow reaches the point of the @code{__builtin_unreachable},
7595 the program is undefined.  It is useful in situations where the
7596 compiler cannot deduce the unreachability of the code.
7597
7598 One such case is immediately following an @code{asm} statement that
7599 will either never terminate, or one that transfers control elsewhere
7600 and never returns.  In this example, without the
7601 @code{__builtin_unreachable}, GCC would issue a warning that control
7602 reaches the end of a non-void function.  It would also generate code
7603 to return after the @code{asm}.
7604
7605 @smallexample
7606 int f (int c, int v)
7607 @{
7608   if (c)
7609     @{
7610       return v;
7611     @}
7612   else
7613     @{
7614       asm("jmp error_handler");
7615       __builtin_unreachable ();
7616     @}
7617 @}
7618 @end smallexample
7619
7620 Because the @code{asm} statement unconditionally transfers control out
7621 of the function, control will never reach the end of the function
7622 body.  The @code{__builtin_unreachable} is in fact unreachable and
7623 communicates this fact to the compiler.
7624
7625 Another use for @code{__builtin_unreachable} is following a call a
7626 function that never returns but that is not declared
7627 @code{__attribute__((noreturn))}, as in this example:
7628
7629 @smallexample
7630 void function_that_never_returns (void);
7631
7632 int g (int c)
7633 @{
7634   if (c)
7635     @{
7636       return 1;
7637     @}
7638   else
7639     @{
7640       function_that_never_returns ();
7641       __builtin_unreachable ();
7642     @}
7643 @}
7644 @end smallexample
7645
7646 @end deftypefn
7647
7648 @deftypefn {Built-in Function} void __builtin___clear_cache (char *@var{begin}, char *@var{end})
7649 This function is used to flush the processor's instruction cache for
7650 the region of memory between @var{begin} inclusive and @var{end}
7651 exclusive.  Some targets require that the instruction cache be
7652 flushed, after modifying memory containing code, in order to obtain
7653 deterministic behavior.
7654
7655 If the target does not require instruction cache flushes,
7656 @code{__builtin___clear_cache} has no effect.  Otherwise either
7657 instructions are emitted in-line to clear the instruction cache or a
7658 call to the @code{__clear_cache} function in libgcc is made.
7659 @end deftypefn
7660
7661 @deftypefn {Built-in Function} void __builtin_prefetch (const void *@var{addr}, ...)
7662 This function is used to minimize cache-miss latency by moving data into
7663 a cache before it is accessed.
7664 You can insert calls to @code{__builtin_prefetch} into code for which
7665 you know addresses of data in memory that is likely to be accessed soon.
7666 If the target supports them, data prefetch instructions will be generated.
7667 If the prefetch is done early enough before the access then the data will
7668 be in the cache by the time it is accessed.
7669
7670 The value of @var{addr} is the address of the memory to prefetch.
7671 There are two optional arguments, @var{rw} and @var{locality}.
7672 The value of @var{rw} is a compile-time constant one or zero; one
7673 means that the prefetch is preparing for a write to the memory address
7674 and zero, the default, means that the prefetch is preparing for a read.
7675 The value @var{locality} must be a compile-time constant integer between
7676 zero and three.  A value of zero means that the data has no temporal
7677 locality, so it need not be left in the cache after the access.  A value
7678 of three means that the data has a high degree of temporal locality and
7679 should be left in all levels of cache possible.  Values of one and two
7680 mean, respectively, a low or moderate degree of temporal locality.  The
7681 default is three.
7682
7683 @smallexample
7684 for (i = 0; i < n; i++)
7685   @{
7686     a[i] = a[i] + b[i];
7687     __builtin_prefetch (&a[i+j], 1, 1);
7688     __builtin_prefetch (&b[i+j], 0, 1);
7689     /* @r{@dots{}} */
7690   @}
7691 @end smallexample
7692
7693 Data prefetch does not generate faults if @var{addr} is invalid, but
7694 the address expression itself must be valid.  For example, a prefetch
7695 of @code{p->next} will not fault if @code{p->next} is not a valid
7696 address, but evaluation will fault if @code{p} is not a valid address.
7697
7698 If the target does not support data prefetch, the address expression
7699 is evaluated if it includes side effects but no other code is generated
7700 and GCC does not issue a warning.
7701 @end deftypefn
7702
7703 @deftypefn {Built-in Function} double __builtin_huge_val (void)
7704 Returns a positive infinity, if supported by the floating-point format,
7705 else @code{DBL_MAX}.  This function is suitable for implementing the
7706 ISO C macro @code{HUGE_VAL}.
7707 @end deftypefn
7708
7709 @deftypefn {Built-in Function} float __builtin_huge_valf (void)
7710 Similar to @code{__builtin_huge_val}, except the return type is @code{float}.
7711 @end deftypefn
7712
7713 @deftypefn {Built-in Function} {long double} __builtin_huge_vall (void)
7714 Similar to @code{__builtin_huge_val}, except the return
7715 type is @code{long double}.
7716 @end deftypefn
7717
7718 @deftypefn {Built-in Function} int __builtin_fpclassify (int, int, int, int, int, ...)
7719 This built-in implements the C99 fpclassify functionality.  The first
7720 five int arguments should be the target library's notion of the
7721 possible FP classes and are used for return values.  They must be
7722 constant values and they must appear in this order: @code{FP_NAN},
7723 @code{FP_INFINITE}, @code{FP_NORMAL}, @code{FP_SUBNORMAL} and
7724 @code{FP_ZERO}.  The ellipsis is for exactly one floating point value
7725 to classify.  GCC treats the last argument as type-generic, which
7726 means it does not do default promotion from float to double.
7727 @end deftypefn
7728
7729 @deftypefn {Built-in Function} double __builtin_inf (void)
7730 Similar to @code{__builtin_huge_val}, except a warning is generated
7731 if the target floating-point format does not support infinities.
7732 @end deftypefn
7733
7734 @deftypefn {Built-in Function} _Decimal32 __builtin_infd32 (void)
7735 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal32}.
7736 @end deftypefn
7737
7738 @deftypefn {Built-in Function} _Decimal64 __builtin_infd64 (void)
7739 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal64}.
7740 @end deftypefn
7741
7742 @deftypefn {Built-in Function} _Decimal128 __builtin_infd128 (void)
7743 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal128}.
7744 @end deftypefn
7745
7746 @deftypefn {Built-in Function} float __builtin_inff (void)
7747 Similar to @code{__builtin_inf}, except the return type is @code{float}.
7748 This function is suitable for implementing the ISO C99 macro @code{INFINITY}.
7749 @end deftypefn
7750
7751 @deftypefn {Built-in Function} {long double} __builtin_infl (void)
7752 Similar to @code{__builtin_inf}, except the return
7753 type is @code{long double}.
7754 @end deftypefn
7755
7756 @deftypefn {Built-in Function} int __builtin_isinf_sign (...)
7757 Similar to @code{isinf}, except the return value will be negative for
7758 an argument of @code{-Inf}.  Note while the parameter list is an
7759 ellipsis, this function only accepts exactly one floating point
7760 argument.  GCC treats this parameter as type-generic, which means it
7761 does not do default promotion from float to double.
7762 @end deftypefn
7763
7764 @deftypefn {Built-in Function} double __builtin_nan (const char *str)
7765 This is an implementation of the ISO C99 function @code{nan}.
7766
7767 Since ISO C99 defines this function in terms of @code{strtod}, which we
7768 do not implement, a description of the parsing is in order.  The string
7769 is parsed as by @code{strtol}; that is, the base is recognized by
7770 leading @samp{0} or @samp{0x} prefixes.  The number parsed is placed
7771 in the significand such that the least significant bit of the number
7772 is at the least significant bit of the significand.  The number is
7773 truncated to fit the significand field provided.  The significand is
7774 forced to be a quiet NaN@.
7775
7776 This function, if given a string literal all of which would have been
7777 consumed by strtol, is evaluated early enough that it is considered a
7778 compile-time constant.
7779 @end deftypefn
7780
7781 @deftypefn {Built-in Function} _Decimal32 __builtin_nand32 (const char *str)
7782 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal32}.
7783 @end deftypefn
7784
7785 @deftypefn {Built-in Function} _Decimal64 __builtin_nand64 (const char *str)
7786 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal64}.
7787 @end deftypefn
7788
7789 @deftypefn {Built-in Function} _Decimal128 __builtin_nand128 (const char *str)
7790 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal128}.
7791 @end deftypefn
7792
7793 @deftypefn {Built-in Function} float __builtin_nanf (const char *str)
7794 Similar to @code{__builtin_nan}, except the return type is @code{float}.
7795 @end deftypefn
7796
7797 @deftypefn {Built-in Function} {long double} __builtin_nanl (const char *str)
7798 Similar to @code{__builtin_nan}, except the return type is @code{long double}.
7799 @end deftypefn
7800
7801 @deftypefn {Built-in Function} double __builtin_nans (const char *str)
7802 Similar to @code{__builtin_nan}, except the significand is forced
7803 to be a signaling NaN@.  The @code{nans} function is proposed by
7804 @uref{http://www.open-std.org/jtc1/sc22/wg14/www/docs/n965.htm,,WG14 N965}.
7805 @end deftypefn
7806
7807 @deftypefn {Built-in Function} float __builtin_nansf (const char *str)
7808 Similar to @code{__builtin_nans}, except the return type is @code{float}.
7809 @end deftypefn
7810
7811 @deftypefn {Built-in Function} {long double} __builtin_nansl (const char *str)
7812 Similar to @code{__builtin_nans}, except the return type is @code{long double}.
7813 @end deftypefn
7814
7815 @deftypefn {Built-in Function} int __builtin_ffs (unsigned int x)
7816 Returns one plus the index of the least significant 1-bit of @var{x}, or
7817 if @var{x} is zero, returns zero.
7818 @end deftypefn
7819
7820 @deftypefn {Built-in Function} int __builtin_clz (unsigned int x)
7821 Returns the number of leading 0-bits in @var{x}, starting at the most
7822 significant bit position.  If @var{x} is 0, the result is undefined.
7823 @end deftypefn
7824
7825 @deftypefn {Built-in Function} int __builtin_ctz (unsigned int x)
7826 Returns the number of trailing 0-bits in @var{x}, starting at the least
7827 significant bit position.  If @var{x} is 0, the result is undefined.
7828 @end deftypefn
7829
7830 @deftypefn {Built-in Function} int __builtin_popcount (unsigned int x)
7831 Returns the number of 1-bits in @var{x}.
7832 @end deftypefn
7833
7834 @deftypefn {Built-in Function} int __builtin_parity (unsigned int x)
7835 Returns the parity of @var{x}, i.e.@: the number of 1-bits in @var{x}
7836 modulo 2.
7837 @end deftypefn
7838
7839 @deftypefn {Built-in Function} int __builtin_ffsl (unsigned long)
7840 Similar to @code{__builtin_ffs}, except the argument type is
7841 @code{unsigned long}.
7842 @end deftypefn
7843
7844 @deftypefn {Built-in Function} int __builtin_clzl (unsigned long)
7845 Similar to @code{__builtin_clz}, except the argument type is
7846 @code{unsigned long}.
7847 @end deftypefn
7848
7849 @deftypefn {Built-in Function} int __builtin_ctzl (unsigned long)
7850 Similar to @code{__builtin_ctz}, except the argument type is
7851 @code{unsigned long}.
7852 @end deftypefn
7853
7854 @deftypefn {Built-in Function} int __builtin_popcountl (unsigned long)
7855 Similar to @code{__builtin_popcount}, except the argument type is
7856 @code{unsigned long}.
7857 @end deftypefn
7858
7859 @deftypefn {Built-in Function} int __builtin_parityl (unsigned long)
7860 Similar to @code{__builtin_parity}, except the argument type is
7861 @code{unsigned long}.
7862 @end deftypefn
7863
7864 @deftypefn {Built-in Function} int __builtin_ffsll (unsigned long long)
7865 Similar to @code{__builtin_ffs}, except the argument type is
7866 @code{unsigned long long}.
7867 @end deftypefn
7868
7869 @deftypefn {Built-in Function} int __builtin_clzll (unsigned long long)
7870 Similar to @code{__builtin_clz}, except the argument type is
7871 @code{unsigned long long}.
7872 @end deftypefn
7873
7874 @deftypefn {Built-in Function} int __builtin_ctzll (unsigned long long)
7875 Similar to @code{__builtin_ctz}, except the argument type is
7876 @code{unsigned long long}.
7877 @end deftypefn
7878
7879 @deftypefn {Built-in Function} int __builtin_popcountll (unsigned long long)
7880 Similar to @code{__builtin_popcount}, except the argument type is
7881 @code{unsigned long long}.
7882 @end deftypefn
7883
7884 @deftypefn {Built-in Function} int __builtin_parityll (unsigned long long)
7885 Similar to @code{__builtin_parity}, except the argument type is
7886 @code{unsigned long long}.
7887 @end deftypefn
7888
7889 @deftypefn {Built-in Function} double __builtin_powi (double, int)
7890 Returns the first argument raised to the power of the second.  Unlike the
7891 @code{pow} function no guarantees about precision and rounding are made.
7892 @end deftypefn
7893
7894 @deftypefn {Built-in Function} float __builtin_powif (float, int)
7895 Similar to @code{__builtin_powi}, except the argument and return types
7896 are @code{float}.
7897 @end deftypefn
7898
7899 @deftypefn {Built-in Function} {long double} __builtin_powil (long double, int)
7900 Similar to @code{__builtin_powi}, except the argument and return types
7901 are @code{long double}.
7902 @end deftypefn
7903
7904 @deftypefn {Built-in Function} int32_t __builtin_bswap32 (int32_t x)
7905 Returns @var{x} with the order of the bytes reversed; for example,
7906 @code{0xaabbccdd} becomes @code{0xddccbbaa}.  Byte here always means
7907 exactly 8 bits.
7908 @end deftypefn
7909
7910 @deftypefn {Built-in Function} int64_t __builtin_bswap64 (int64_t x)
7911 Similar to @code{__builtin_bswap32}, except the argument and return types
7912 are 64-bit.
7913 @end deftypefn
7914
7915 @node Target Builtins
7916 @section Built-in Functions Specific to Particular Target Machines
7917
7918 On some target machines, GCC supports many built-in functions specific
7919 to those machines.  Generally these generate calls to specific machine
7920 instructions, but allow the compiler to schedule those calls.
7921
7922 @menu
7923 * Alpha Built-in Functions::
7924 * ARM iWMMXt Built-in Functions::
7925 * ARM NEON Intrinsics::
7926 * Blackfin Built-in Functions::
7927 * FR-V Built-in Functions::
7928 * X86 Built-in Functions::
7929 * MIPS DSP Built-in Functions::
7930 * MIPS Paired-Single Support::
7931 * MIPS Loongson Built-in Functions::
7932 * Other MIPS Built-in Functions::
7933 * picoChip Built-in Functions::
7934 * PowerPC AltiVec/VSX Built-in Functions::
7935 * RX Built-in Functions::
7936 * SPARC VIS Built-in Functions::
7937 * SPU Built-in Functions::
7938 @end menu
7939
7940 @node Alpha Built-in Functions
7941 @subsection Alpha Built-in Functions
7942
7943 These built-in functions are available for the Alpha family of
7944 processors, depending on the command-line switches used.
7945
7946 The following built-in functions are always available.  They
7947 all generate the machine instruction that is part of the name.
7948
7949 @smallexample
7950 long __builtin_alpha_implver (void)
7951 long __builtin_alpha_rpcc (void)
7952 long __builtin_alpha_amask (long)
7953 long __builtin_alpha_cmpbge (long, long)
7954 long __builtin_alpha_extbl (long, long)
7955 long __builtin_alpha_extwl (long, long)
7956 long __builtin_alpha_extll (long, long)
7957 long __builtin_alpha_extql (long, long)
7958 long __builtin_alpha_extwh (long, long)
7959 long __builtin_alpha_extlh (long, long)
7960 long __builtin_alpha_extqh (long, long)
7961 long __builtin_alpha_insbl (long, long)
7962 long __builtin_alpha_inswl (long, long)
7963 long __builtin_alpha_insll (long, long)
7964 long __builtin_alpha_insql (long, long)
7965 long __builtin_alpha_inswh (long, long)
7966 long __builtin_alpha_inslh (long, long)
7967 long __builtin_alpha_insqh (long, long)
7968 long __builtin_alpha_mskbl (long, long)
7969 long __builtin_alpha_mskwl (long, long)
7970 long __builtin_alpha_mskll (long, long)
7971 long __builtin_alpha_mskql (long, long)
7972 long __builtin_alpha_mskwh (long, long)
7973 long __builtin_alpha_msklh (long, long)
7974 long __builtin_alpha_mskqh (long, long)
7975 long __builtin_alpha_umulh (long, long)
7976 long __builtin_alpha_zap (long, long)
7977 long __builtin_alpha_zapnot (long, long)
7978 @end smallexample
7979
7980 The following built-in functions are always with @option{-mmax}
7981 or @option{-mcpu=@var{cpu}} where @var{cpu} is @code{pca56} or
7982 later.  They all generate the machine instruction that is part
7983 of the name.
7984
7985 @smallexample
7986 long __builtin_alpha_pklb (long)
7987 long __builtin_alpha_pkwb (long)
7988 long __builtin_alpha_unpkbl (long)
7989 long __builtin_alpha_unpkbw (long)
7990 long __builtin_alpha_minub8 (long, long)
7991 long __builtin_alpha_minsb8 (long, long)
7992 long __builtin_alpha_minuw4 (long, long)
7993 long __builtin_alpha_minsw4 (long, long)
7994 long __builtin_alpha_maxub8 (long, long)
7995 long __builtin_alpha_maxsb8 (long, long)
7996 long __builtin_alpha_maxuw4 (long, long)
7997 long __builtin_alpha_maxsw4 (long, long)
7998 long __builtin_alpha_perr (long, long)
7999 @end smallexample
8000
8001 The following built-in functions are always with @option{-mcix}
8002 or @option{-mcpu=@var{cpu}} where @var{cpu} is @code{ev67} or
8003 later.  They all generate the machine instruction that is part
8004 of the name.
8005
8006 @smallexample
8007 long __builtin_alpha_cttz (long)
8008 long __builtin_alpha_ctlz (long)
8009 long __builtin_alpha_ctpop (long)
8010 @end smallexample
8011
8012 The following builtins are available on systems that use the OSF/1
8013 PALcode.  Normally they invoke the @code{rduniq} and @code{wruniq}
8014 PAL calls, but when invoked with @option{-mtls-kernel}, they invoke
8015 @code{rdval} and @code{wrval}.
8016
8017 @smallexample
8018 void *__builtin_thread_pointer (void)
8019 void __builtin_set_thread_pointer (void *)
8020 @end smallexample
8021
8022 @node ARM iWMMXt Built-in Functions
8023 @subsection ARM iWMMXt Built-in Functions
8024
8025 These built-in functions are available for the ARM family of
8026 processors when the @option{-mcpu=iwmmxt} switch is used:
8027
8028 @smallexample
8029 typedef int v2si __attribute__ ((vector_size (8)));
8030 typedef short v4hi __attribute__ ((vector_size (8)));
8031 typedef char v8qi __attribute__ ((vector_size (8)));
8032
8033 int __builtin_arm_getwcx (int)
8034 void __builtin_arm_setwcx (int, int)
8035 int __builtin_arm_textrmsb (v8qi, int)
8036 int __builtin_arm_textrmsh (v4hi, int)
8037 int __builtin_arm_textrmsw (v2si, int)
8038 int __builtin_arm_textrmub (v8qi, int)
8039 int __builtin_arm_textrmuh (v4hi, int)
8040 int __builtin_arm_textrmuw (v2si, int)
8041 v8qi __builtin_arm_tinsrb (v8qi, int)
8042 v4hi __builtin_arm_tinsrh (v4hi, int)
8043 v2si __builtin_arm_tinsrw (v2si, int)
8044 long long __builtin_arm_tmia (long long, int, int)
8045 long long __builtin_arm_tmiabb (long long, int, int)
8046 long long __builtin_arm_tmiabt (long long, int, int)
8047 long long __builtin_arm_tmiaph (long long, int, int)
8048 long long __builtin_arm_tmiatb (long long, int, int)
8049 long long __builtin_arm_tmiatt (long long, int, int)
8050 int __builtin_arm_tmovmskb (v8qi)
8051 int __builtin_arm_tmovmskh (v4hi)
8052 int __builtin_arm_tmovmskw (v2si)
8053 long long __builtin_arm_waccb (v8qi)
8054 long long __builtin_arm_wacch (v4hi)
8055 long long __builtin_arm_waccw (v2si)
8056 v8qi __builtin_arm_waddb (v8qi, v8qi)
8057 v8qi __builtin_arm_waddbss (v8qi, v8qi)
8058 v8qi __builtin_arm_waddbus (v8qi, v8qi)
8059 v4hi __builtin_arm_waddh (v4hi, v4hi)
8060 v4hi __builtin_arm_waddhss (v4hi, v4hi)
8061 v4hi __builtin_arm_waddhus (v4hi, v4hi)
8062 v2si __builtin_arm_waddw (v2si, v2si)
8063 v2si __builtin_arm_waddwss (v2si, v2si)
8064 v2si __builtin_arm_waddwus (v2si, v2si)
8065 v8qi __builtin_arm_walign (v8qi, v8qi, int)
8066 long long __builtin_arm_wand(long long, long long)
8067 long long __builtin_arm_wandn (long long, long long)
8068 v8qi __builtin_arm_wavg2b (v8qi, v8qi)
8069 v8qi __builtin_arm_wavg2br (v8qi, v8qi)
8070 v4hi __builtin_arm_wavg2h (v4hi, v4hi)
8071 v4hi __builtin_arm_wavg2hr (v4hi, v4hi)
8072 v8qi __builtin_arm_wcmpeqb (v8qi, v8qi)
8073 v4hi __builtin_arm_wcmpeqh (v4hi, v4hi)
8074 v2si __builtin_arm_wcmpeqw (v2si, v2si)
8075 v8qi __builtin_arm_wcmpgtsb (v8qi, v8qi)
8076 v4hi __builtin_arm_wcmpgtsh (v4hi, v4hi)
8077 v2si __builtin_arm_wcmpgtsw (v2si, v2si)
8078 v8qi __builtin_arm_wcmpgtub (v8qi, v8qi)
8079 v4hi __builtin_arm_wcmpgtuh (v4hi, v4hi)
8080 v2si __builtin_arm_wcmpgtuw (v2si, v2si)
8081 long long __builtin_arm_wmacs (long long, v4hi, v4hi)
8082 long long __builtin_arm_wmacsz (v4hi, v4hi)
8083 long long __builtin_arm_wmacu (long long, v4hi, v4hi)
8084 long long __builtin_arm_wmacuz (v4hi, v4hi)
8085 v4hi __builtin_arm_wmadds (v4hi, v4hi)
8086 v4hi __builtin_arm_wmaddu (v4hi, v4hi)
8087 v8qi __builtin_arm_wmaxsb (v8qi, v8qi)
8088 v4hi __builtin_arm_wmaxsh (v4hi, v4hi)
8089 v2si __builtin_arm_wmaxsw (v2si, v2si)
8090 v8qi __builtin_arm_wmaxub (v8qi, v8qi)
8091 v4hi __builtin_arm_wmaxuh (v4hi, v4hi)
8092 v2si __builtin_arm_wmaxuw (v2si, v2si)
8093 v8qi __builtin_arm_wminsb (v8qi, v8qi)
8094 v4hi __builtin_arm_wminsh (v4hi, v4hi)
8095 v2si __builtin_arm_wminsw (v2si, v2si)
8096 v8qi __builtin_arm_wminub (v8qi, v8qi)
8097 v4hi __builtin_arm_wminuh (v4hi, v4hi)
8098 v2si __builtin_arm_wminuw (v2si, v2si)
8099 v4hi __builtin_arm_wmulsm (v4hi, v4hi)
8100 v4hi __builtin_arm_wmulul (v4hi, v4hi)
8101 v4hi __builtin_arm_wmulum (v4hi, v4hi)
8102 long long __builtin_arm_wor (long long, long long)
8103 v2si __builtin_arm_wpackdss (long long, long long)
8104 v2si __builtin_arm_wpackdus (long long, long long)
8105 v8qi __builtin_arm_wpackhss (v4hi, v4hi)
8106 v8qi __builtin_arm_wpackhus (v4hi, v4hi)
8107 v4hi __builtin_arm_wpackwss (v2si, v2si)
8108 v4hi __builtin_arm_wpackwus (v2si, v2si)
8109 long long __builtin_arm_wrord (long long, long long)
8110 long long __builtin_arm_wrordi (long long, int)
8111 v4hi __builtin_arm_wrorh (v4hi, long long)
8112 v4hi __builtin_arm_wrorhi (v4hi, int)
8113 v2si __builtin_arm_wrorw (v2si, long long)
8114 v2si __builtin_arm_wrorwi (v2si, int)
8115 v2si __builtin_arm_wsadb (v8qi, v8qi)
8116 v2si __builtin_arm_wsadbz (v8qi, v8qi)
8117 v2si __builtin_arm_wsadh (v4hi, v4hi)
8118 v2si __builtin_arm_wsadhz (v4hi, v4hi)
8119 v4hi __builtin_arm_wshufh (v4hi, int)
8120 long long __builtin_arm_wslld (long long, long long)
8121 long long __builtin_arm_wslldi (long long, int)
8122 v4hi __builtin_arm_wsllh (v4hi, long long)
8123 v4hi __builtin_arm_wsllhi (v4hi, int)
8124 v2si __builtin_arm_wsllw (v2si, long long)
8125 v2si __builtin_arm_wsllwi (v2si, int)
8126 long long __builtin_arm_wsrad (long long, long long)
8127 long long __builtin_arm_wsradi (long long, int)
8128 v4hi __builtin_arm_wsrah (v4hi, long long)
8129 v4hi __builtin_arm_wsrahi (v4hi, int)
8130 v2si __builtin_arm_wsraw (v2si, long long)
8131 v2si __builtin_arm_wsrawi (v2si, int)
8132 long long __builtin_arm_wsrld (long long, long long)
8133 long long __builtin_arm_wsrldi (long long, int)
8134 v4hi __builtin_arm_wsrlh (v4hi, long long)
8135 v4hi __builtin_arm_wsrlhi (v4hi, int)
8136 v2si __builtin_arm_wsrlw (v2si, long long)
8137 v2si __builtin_arm_wsrlwi (v2si, int)
8138 v8qi __builtin_arm_wsubb (v8qi, v8qi)
8139 v8qi __builtin_arm_wsubbss (v8qi, v8qi)
8140 v8qi __builtin_arm_wsubbus (v8qi, v8qi)
8141 v4hi __builtin_arm_wsubh (v4hi, v4hi)
8142 v4hi __builtin_arm_wsubhss (v4hi, v4hi)
8143 v4hi __builtin_arm_wsubhus (v4hi, v4hi)
8144 v2si __builtin_arm_wsubw (v2si, v2si)
8145 v2si __builtin_arm_wsubwss (v2si, v2si)
8146 v2si __builtin_arm_wsubwus (v2si, v2si)
8147 v4hi __builtin_arm_wunpckehsb (v8qi)
8148 v2si __builtin_arm_wunpckehsh (v4hi)
8149 long long __builtin_arm_wunpckehsw (v2si)
8150 v4hi __builtin_arm_wunpckehub (v8qi)
8151 v2si __builtin_arm_wunpckehuh (v4hi)
8152 long long __builtin_arm_wunpckehuw (v2si)
8153 v4hi __builtin_arm_wunpckelsb (v8qi)
8154 v2si __builtin_arm_wunpckelsh (v4hi)
8155 long long __builtin_arm_wunpckelsw (v2si)
8156 v4hi __builtin_arm_wunpckelub (v8qi)
8157 v2si __builtin_arm_wunpckeluh (v4hi)
8158 long long __builtin_arm_wunpckeluw (v2si)
8159 v8qi __builtin_arm_wunpckihb (v8qi, v8qi)
8160 v4hi __builtin_arm_wunpckihh (v4hi, v4hi)
8161 v2si __builtin_arm_wunpckihw (v2si, v2si)
8162 v8qi __builtin_arm_wunpckilb (v8qi, v8qi)
8163 v4hi __builtin_arm_wunpckilh (v4hi, v4hi)
8164 v2si __builtin_arm_wunpckilw (v2si, v2si)
8165 long long __builtin_arm_wxor (long long, long long)
8166 long long __builtin_arm_wzero ()
8167 @end smallexample
8168
8169 @node ARM NEON Intrinsics
8170 @subsection ARM NEON Intrinsics
8171
8172 These built-in intrinsics for the ARM Advanced SIMD extension are available
8173 when the @option{-mfpu=neon} switch is used:
8174
8175 @include arm-neon-intrinsics.texi
8176
8177 @node Blackfin Built-in Functions
8178 @subsection Blackfin Built-in Functions
8179
8180 Currently, there are two Blackfin-specific built-in functions.  These are
8181 used for generating @code{CSYNC} and @code{SSYNC} machine insns without
8182 using inline assembly; by using these built-in functions the compiler can
8183 automatically add workarounds for hardware errata involving these
8184 instructions.  These functions are named as follows:
8185
8186 @smallexample
8187 void __builtin_bfin_csync (void)
8188 void __builtin_bfin_ssync (void)
8189 @end smallexample
8190
8191 @node FR-V Built-in Functions
8192 @subsection FR-V Built-in Functions
8193
8194 GCC provides many FR-V-specific built-in functions.  In general,
8195 these functions are intended to be compatible with those described
8196 by @cite{FR-V Family, Softune C/C++ Compiler Manual (V6), Fujitsu
8197 Semiconductor}.  The two exceptions are @code{__MDUNPACKH} and
8198 @code{__MBTOHE}, the gcc forms of which pass 128-bit values by
8199 pointer rather than by value.
8200
8201 Most of the functions are named after specific FR-V instructions.
8202 Such functions are said to be ``directly mapped'' and are summarized
8203 here in tabular form.
8204
8205 @menu
8206 * Argument Types::
8207 * Directly-mapped Integer Functions::
8208 * Directly-mapped Media Functions::
8209 * Raw read/write Functions::
8210 * Other Built-in Functions::
8211 @end menu
8212
8213 @node Argument Types
8214 @subsubsection Argument Types
8215
8216 The arguments to the built-in functions can be divided into three groups:
8217 register numbers, compile-time constants and run-time values.  In order
8218 to make this classification clear at a glance, the arguments and return
8219 values are given the following pseudo types:
8220
8221 @multitable @columnfractions .20 .30 .15 .35
8222 @item Pseudo type @tab Real C type @tab Constant? @tab Description
8223 @item @code{uh} @tab @code{unsigned short} @tab No @tab an unsigned halfword
8224 @item @code{uw1} @tab @code{unsigned int} @tab No @tab an unsigned word
8225 @item @code{sw1} @tab @code{int} @tab No @tab a signed word
8226 @item @code{uw2} @tab @code{unsigned long long} @tab No
8227 @tab an unsigned doubleword
8228 @item @code{sw2} @tab @code{long long} @tab No @tab a signed doubleword
8229 @item @code{const} @tab @code{int} @tab Yes @tab an integer constant
8230 @item @code{acc} @tab @code{int} @tab Yes @tab an ACC register number
8231 @item @code{iacc} @tab @code{int} @tab Yes @tab an IACC register number
8232 @end multitable
8233
8234 These pseudo types are not defined by GCC, they are simply a notational
8235 convenience used in this manual.
8236
8237 Arguments of type @code{uh}, @code{uw1}, @code{sw1}, @code{uw2}
8238 and @code{sw2} are evaluated at run time.  They correspond to
8239 register operands in the underlying FR-V instructions.
8240
8241 @code{const} arguments represent immediate operands in the underlying
8242 FR-V instructions.  They must be compile-time constants.
8243
8244 @code{acc} arguments are evaluated at compile time and specify the number
8245 of an accumulator register.  For example, an @code{acc} argument of 2
8246 will select the ACC2 register.
8247
8248 @code{iacc} arguments are similar to @code{acc} arguments but specify the
8249 number of an IACC register.  See @pxref{Other Built-in Functions}
8250 for more details.
8251
8252 @node Directly-mapped Integer Functions
8253 @subsubsection Directly-mapped Integer Functions
8254
8255 The functions listed below map directly to FR-V I-type instructions.
8256
8257 @multitable @columnfractions .45 .32 .23
8258 @item Function prototype @tab Example usage @tab Assembly output
8259 @item @code{sw1 __ADDSS (sw1, sw1)}
8260 @tab @code{@var{c} = __ADDSS (@var{a}, @var{b})}
8261 @tab @code{ADDSS @var{a},@var{b},@var{c}}
8262 @item @code{sw1 __SCAN (sw1, sw1)}
8263 @tab @code{@var{c} = __SCAN (@var{a}, @var{b})}
8264 @tab @code{SCAN @var{a},@var{b},@var{c}}
8265 @item @code{sw1 __SCUTSS (sw1)}
8266 @tab @code{@var{b} = __SCUTSS (@var{a})}
8267 @tab @code{SCUTSS @var{a},@var{b}}
8268 @item @code{sw1 __SLASS (sw1, sw1)}
8269 @tab @code{@var{c} = __SLASS (@var{a}, @var{b})}
8270 @tab @code{SLASS @var{a},@var{b},@var{c}}
8271 @item @code{void __SMASS (sw1, sw1)}
8272 @tab @code{__SMASS (@var{a}, @var{b})}
8273 @tab @code{SMASS @var{a},@var{b}}
8274 @item @code{void __SMSSS (sw1, sw1)}
8275 @tab @code{__SMSSS (@var{a}, @var{b})}
8276 @tab @code{SMSSS @var{a},@var{b}}
8277 @item @code{void __SMU (sw1, sw1)}
8278 @tab @code{__SMU (@var{a}, @var{b})}
8279 @tab @code{SMU @var{a},@var{b}}
8280 @item @code{sw2 __SMUL (sw1, sw1)}
8281 @tab @code{@var{c} = __SMUL (@var{a}, @var{b})}
8282 @tab @code{SMUL @var{a},@var{b},@var{c}}
8283 @item @code{sw1 __SUBSS (sw1, sw1)}
8284 @tab @code{@var{c} = __SUBSS (@var{a}, @var{b})}
8285 @tab @code{SUBSS @var{a},@var{b},@var{c}}
8286 @item @code{uw2 __UMUL (uw1, uw1)}
8287 @tab @code{@var{c} = __UMUL (@var{a}, @var{b})}
8288 @tab @code{UMUL @var{a},@var{b},@var{c}}
8289 @end multitable
8290
8291 @node Directly-mapped Media Functions
8292 @subsubsection Directly-mapped Media Functions
8293
8294 The functions listed below map directly to FR-V M-type instructions.
8295
8296 @multitable @columnfractions .45 .32 .23
8297 @item Function prototype @tab Example usage @tab Assembly output
8298 @item @code{uw1 __MABSHS (sw1)}
8299 @tab @code{@var{b} = __MABSHS (@var{a})}
8300 @tab @code{MABSHS @var{a},@var{b}}
8301 @item @code{void __MADDACCS (acc, acc)}
8302 @tab @code{__MADDACCS (@var{b}, @var{a})}
8303 @tab @code{MADDACCS @var{a},@var{b}}
8304 @item @code{sw1 __MADDHSS (sw1, sw1)}
8305 @tab @code{@var{c} = __MADDHSS (@var{a}, @var{b})}
8306 @tab @code{MADDHSS @var{a},@var{b},@var{c}}
8307 @item @code{uw1 __MADDHUS (uw1, uw1)}
8308 @tab @code{@var{c} = __MADDHUS (@var{a}, @var{b})}
8309 @tab @code{MADDHUS @var{a},@var{b},@var{c}}
8310 @item @code{uw1 __MAND (uw1, uw1)}
8311 @tab @code{@var{c} = __MAND (@var{a}, @var{b})}
8312 @tab @code{MAND @var{a},@var{b},@var{c}}
8313 @item @code{void __MASACCS (acc, acc)}
8314 @tab @code{__MASACCS (@var{b}, @var{a})}
8315 @tab @code{MASACCS @var{a},@var{b}}
8316 @item @code{uw1 __MAVEH (uw1, uw1)}
8317 @tab @code{@var{c} = __MAVEH (@var{a}, @var{b})}
8318 @tab @code{MAVEH @var{a},@var{b},@var{c}}
8319 @item @code{uw2 __MBTOH (uw1)}
8320 @tab @code{@var{b} = __MBTOH (@var{a})}
8321 @tab @code{MBTOH @var{a},@var{b}}
8322 @item @code{void __MBTOHE (uw1 *, uw1)}
8323 @tab @code{__MBTOHE (&@var{b}, @var{a})}
8324 @tab @code{MBTOHE @var{a},@var{b}}
8325 @item @code{void __MCLRACC (acc)}
8326 @tab @code{__MCLRACC (@var{a})}
8327 @tab @code{MCLRACC @var{a}}
8328 @item @code{void __MCLRACCA (void)}
8329 @tab @code{__MCLRACCA ()}
8330 @tab @code{MCLRACCA}
8331 @item @code{uw1 __Mcop1 (uw1, uw1)}
8332 @tab @code{@var{c} = __Mcop1 (@var{a}, @var{b})}
8333 @tab @code{Mcop1 @var{a},@var{b},@var{c}}
8334 @item @code{uw1 __Mcop2 (uw1, uw1)}
8335 @tab @code{@var{c} = __Mcop2 (@var{a}, @var{b})}
8336 @tab @code{Mcop2 @var{a},@var{b},@var{c}}
8337 @item @code{uw1 __MCPLHI (uw2, const)}
8338 @tab @code{@var{c} = __MCPLHI (@var{a}, @var{b})}
8339 @tab @code{MCPLHI @var{a},#@var{b},@var{c}}
8340 @item @code{uw1 __MCPLI (uw2, const)}
8341 @tab @code{@var{c} = __MCPLI (@var{a}, @var{b})}
8342 @tab @code{MCPLI @var{a},#@var{b},@var{c}}
8343 @item @code{void __MCPXIS (acc, sw1, sw1)}
8344 @tab @code{__MCPXIS (@var{c}, @var{a}, @var{b})}
8345 @tab @code{MCPXIS @var{a},@var{b},@var{c}}
8346 @item @code{void __MCPXIU (acc, uw1, uw1)}
8347 @tab @code{__MCPXIU (@var{c}, @var{a}, @var{b})}
8348 @tab @code{MCPXIU @var{a},@var{b},@var{c}}
8349 @item @code{void __MCPXRS (acc, sw1, sw1)}
8350 @tab @code{__MCPXRS (@var{c}, @var{a}, @var{b})}
8351 @tab @code{MCPXRS @var{a},@var{b},@var{c}}
8352 @item @code{void __MCPXRU (acc, uw1, uw1)}
8353 @tab @code{__MCPXRU (@var{c}, @var{a}, @var{b})}
8354 @tab @code{MCPXRU @var{a},@var{b},@var{c}}
8355 @item @code{uw1 __MCUT (acc, uw1)}
8356 @tab @code{@var{c} = __MCUT (@var{a}, @var{b})}
8357 @tab @code{MCUT @var{a},@var{b},@var{c}}
8358 @item @code{uw1 __MCUTSS (acc, sw1)}
8359 @tab @code{@var{c} = __MCUTSS (@var{a}, @var{b})}
8360 @tab @code{MCUTSS @var{a},@var{b},@var{c}}
8361 @item @code{void __MDADDACCS (acc, acc)}
8362 @tab @code{__MDADDACCS (@var{b}, @var{a})}
8363 @tab @code{MDADDACCS @var{a},@var{b}}
8364 @item @code{void __MDASACCS (acc, acc)}
8365 @tab @code{__MDASACCS (@var{b}, @var{a})}
8366 @tab @code{MDASACCS @var{a},@var{b}}
8367 @item @code{uw2 __MDCUTSSI (acc, const)}
8368 @tab @code{@var{c} = __MDCUTSSI (@var{a}, @var{b})}
8369 @tab @code{MDCUTSSI @var{a},#@var{b},@var{c}}
8370 @item @code{uw2 __MDPACKH (uw2, uw2)}
8371 @tab @code{@var{c} = __MDPACKH (@var{a}, @var{b})}
8372 @tab @code{MDPACKH @var{a},@var{b},@var{c}}
8373 @item @code{uw2 __MDROTLI (uw2, const)}
8374 @tab @code{@var{c} = __MDROTLI (@var{a}, @var{b})}
8375 @tab @code{MDROTLI @var{a},#@var{b},@var{c}}
8376 @item @code{void __MDSUBACCS (acc, acc)}
8377 @tab @code{__MDSUBACCS (@var{b}, @var{a})}
8378 @tab @code{MDSUBACCS @var{a},@var{b}}
8379 @item @code{void __MDUNPACKH (uw1 *, uw2)}
8380 @tab @code{__MDUNPACKH (&@var{b}, @var{a})}
8381 @tab @code{MDUNPACKH @var{a},@var{b}}
8382 @item @code{uw2 __MEXPDHD (uw1, const)}
8383 @tab @code{@var{c} = __MEXPDHD (@var{a}, @var{b})}
8384 @tab @code{MEXPDHD @var{a},#@var{b},@var{c}}
8385 @item @code{uw1 __MEXPDHW (uw1, const)}
8386 @tab @code{@var{c} = __MEXPDHW (@var{a}, @var{b})}
8387 @tab @code{MEXPDHW @var{a},#@var{b},@var{c}}
8388 @item @code{uw1 __MHDSETH (uw1, const)}
8389 @tab @code{@var{c} = __MHDSETH (@var{a}, @var{b})}
8390 @tab @code{MHDSETH @var{a},#@var{b},@var{c}}
8391 @item @code{sw1 __MHDSETS (const)}
8392 @tab @code{@var{b} = __MHDSETS (@var{a})}
8393 @tab @code{MHDSETS #@var{a},@var{b}}
8394 @item @code{uw1 __MHSETHIH (uw1, const)}
8395 @tab @code{@var{b} = __MHSETHIH (@var{b}, @var{a})}
8396 @tab @code{MHSETHIH #@var{a},@var{b}}
8397 @item @code{sw1 __MHSETHIS (sw1, const)}
8398 @tab @code{@var{b} = __MHSETHIS (@var{b}, @var{a})}
8399 @tab @code{MHSETHIS #@var{a},@var{b}}
8400 @item @code{uw1 __MHSETLOH (uw1, const)}
8401 @tab @code{@var{b} = __MHSETLOH (@var{b}, @var{a})}
8402 @tab @code{MHSETLOH #@var{a},@var{b}}
8403 @item @code{sw1 __MHSETLOS (sw1, const)}
8404 @tab @code{@var{b} = __MHSETLOS (@var{b}, @var{a})}
8405 @tab @code{MHSETLOS #@var{a},@var{b}}
8406 @item @code{uw1 __MHTOB (uw2)}
8407 @tab @code{@var{b} = __MHTOB (@var{a})}
8408 @tab @code{MHTOB @var{a},@var{b}}
8409 @item @code{void __MMACHS (acc, sw1, sw1)}
8410 @tab @code{__MMACHS (@var{c}, @var{a}, @var{b})}
8411 @tab @code{MMACHS @var{a},@var{b},@var{c}}
8412 @item @code{void __MMACHU (acc, uw1, uw1)}
8413 @tab @code{__MMACHU (@var{c}, @var{a}, @var{b})}
8414 @tab @code{MMACHU @var{a},@var{b},@var{c}}
8415 @item @code{void __MMRDHS (acc, sw1, sw1)}
8416 @tab @code{__MMRDHS (@var{c}, @var{a}, @var{b})}
8417 @tab @code{MMRDHS @var{a},@var{b},@var{c}}
8418 @item @code{void __MMRDHU (acc, uw1, uw1)}
8419 @tab @code{__MMRDHU (@var{c}, @var{a}, @var{b})}
8420 @tab @code{MMRDHU @var{a},@var{b},@var{c}}
8421 @item @code{void __MMULHS (acc, sw1, sw1)}
8422 @tab @code{__MMULHS (@var{c}, @var{a}, @var{b})}
8423 @tab @code{MMULHS @var{a},@var{b},@var{c}}
8424 @item @code{void __MMULHU (acc, uw1, uw1)}
8425 @tab @code{__MMULHU (@var{c}, @var{a}, @var{b})}
8426 @tab @code{MMULHU @var{a},@var{b},@var{c}}
8427 @item @code{void __MMULXHS (acc, sw1, sw1)}
8428 @tab @code{__MMULXHS (@var{c}, @var{a}, @var{b})}
8429 @tab @code{MMULXHS @var{a},@var{b},@var{c}}
8430 @item @code{void __MMULXHU (acc, uw1, uw1)}
8431 @tab @code{__MMULXHU (@var{c}, @var{a}, @var{b})}
8432 @tab @code{MMULXHU @var{a},@var{b},@var{c}}
8433 @item @code{uw1 __MNOT (uw1)}
8434 @tab @code{@var{b} = __MNOT (@var{a})}
8435 @tab @code{MNOT @var{a},@var{b}}
8436 @item @code{uw1 __MOR (uw1, uw1)}
8437 @tab @code{@var{c} = __MOR (@var{a}, @var{b})}
8438 @tab @code{MOR @var{a},@var{b},@var{c}}
8439 @item @code{uw1 __MPACKH (uh, uh)}
8440 @tab @code{@var{c} = __MPACKH (@var{a}, @var{b})}
8441 @tab @code{MPACKH @var{a},@var{b},@var{c}}
8442 @item @code{sw2 __MQADDHSS (sw2, sw2)}
8443 @tab @code{@var{c} = __MQADDHSS (@var{a}, @var{b})}
8444 @tab @code{MQADDHSS @var{a},@var{b},@var{c}}
8445 @item @code{uw2 __MQADDHUS (uw2, uw2)}
8446 @tab @code{@var{c} = __MQADDHUS (@var{a}, @var{b})}
8447 @tab @code{MQADDHUS @var{a},@var{b},@var{c}}
8448 @item @code{void __MQCPXIS (acc, sw2, sw2)}
8449 @tab @code{__MQCPXIS (@var{c}, @var{a}, @var{b})}
8450 @tab @code{MQCPXIS @var{a},@var{b},@var{c}}
8451 @item @code{void __MQCPXIU (acc, uw2, uw2)}
8452 @tab @code{__MQCPXIU (@var{c}, @var{a}, @var{b})}
8453 @tab @code{MQCPXIU @var{a},@var{b},@var{c}}
8454 @item @code{void __MQCPXRS (acc, sw2, sw2)}
8455 @tab @code{__MQCPXRS (@var{c}, @var{a}, @var{b})}
8456 @tab @code{MQCPXRS @var{a},@var{b},@var{c}}
8457 @item @code{void __MQCPXRU (acc, uw2, uw2)}
8458 @tab @code{__MQCPXRU (@var{c}, @var{a}, @var{b})}
8459 @tab @code{MQCPXRU @var{a},@var{b},@var{c}}
8460 @item @code{sw2 __MQLCLRHS (sw2, sw2)}
8461 @tab @code{@var{c} = __MQLCLRHS (@var{a}, @var{b})}
8462 @tab @code{MQLCLRHS @var{a},@var{b},@var{c}}
8463 @item @code{sw2 __MQLMTHS (sw2, sw2)}
8464 @tab @code{@var{c} = __MQLMTHS (@var{a}, @var{b})}
8465 @tab @code{MQLMTHS @var{a},@var{b},@var{c}}
8466 @item @code{void __MQMACHS (acc, sw2, sw2)}
8467 @tab @code{__MQMACHS (@var{c}, @var{a}, @var{b})}
8468 @tab @code{MQMACHS @var{a},@var{b},@var{c}}
8469 @item @code{void __MQMACHU (acc, uw2, uw2)}
8470 @tab @code{__MQMACHU (@var{c}, @var{a}, @var{b})}
8471 @tab @code{MQMACHU @var{a},@var{b},@var{c}}
8472 @item @code{void __MQMACXHS (acc, sw2, sw2)}
8473 @tab @code{__MQMACXHS (@var{c}, @var{a}, @var{b})}
8474 @tab @code{MQMACXHS @var{a},@var{b},@var{c}}
8475 @item @code{void __MQMULHS (acc, sw2, sw2)}
8476 @tab @code{__MQMULHS (@var{c}, @var{a}, @var{b})}
8477 @tab @code{MQMULHS @var{a},@var{b},@var{c}}
8478 @item @code{void __MQMULHU (acc, uw2, uw2)}
8479 @tab @code{__MQMULHU (@var{c}, @var{a}, @var{b})}
8480 @tab @code{MQMULHU @var{a},@var{b},@var{c}}
8481 @item @code{void __MQMULXHS (acc, sw2, sw2)}
8482 @tab @code{__MQMULXHS (@var{c}, @var{a}, @var{b})}
8483 @tab @code{MQMULXHS @var{a},@var{b},@var{c}}
8484 @item @code{void __MQMULXHU (acc, uw2, uw2)}
8485 @tab @code{__MQMULXHU (@var{c}, @var{a}, @var{b})}
8486 @tab @code{MQMULXHU @var{a},@var{b},@var{c}}
8487 @item @code{sw2 __MQSATHS (sw2, sw2)}
8488 @tab @code{@var{c} = __MQSATHS (@var{a}, @var{b})}
8489 @tab @code{MQSATHS @var{a},@var{b},@var{c}}
8490 @item @code{uw2 __MQSLLHI (uw2, int)}
8491 @tab @code{@var{c} = __MQSLLHI (@var{a}, @var{b})}
8492 @tab @code{MQSLLHI @var{a},@var{b},@var{c}}
8493 @item @code{sw2 __MQSRAHI (sw2, int)}
8494 @tab @code{@var{c} = __MQSRAHI (@var{a}, @var{b})}
8495 @tab @code{MQSRAHI @var{a},@var{b},@var{c}}
8496 @item @code{sw2 __MQSUBHSS (sw2, sw2)}
8497 @tab @code{@var{c} = __MQSUBHSS (@var{a}, @var{b})}
8498 @tab @code{MQSUBHSS @var{a},@var{b},@var{c}}
8499 @item @code{uw2 __MQSUBHUS (uw2, uw2)}
8500 @tab @code{@var{c} = __MQSUBHUS (@var{a}, @var{b})}
8501 @tab @code{MQSUBHUS @var{a},@var{b},@var{c}}
8502 @item @code{void __MQXMACHS (acc, sw2, sw2)}
8503 @tab @code{__MQXMACHS (@var{c}, @var{a}, @var{b})}
8504 @tab @code{MQXMACHS @var{a},@var{b},@var{c}}
8505 @item @code{void __MQXMACXHS (acc, sw2, sw2)}
8506 @tab @code{__MQXMACXHS (@var{c}, @var{a}, @var{b})}
8507 @tab @code{MQXMACXHS @var{a},@var{b},@var{c}}
8508 @item @code{uw1 __MRDACC (acc)}
8509 @tab @code{@var{b} = __MRDACC (@var{a})}
8510 @tab @code{MRDACC @var{a},@var{b}}
8511 @item @code{uw1 __MRDACCG (acc)}
8512 @tab @code{@var{b} = __MRDACCG (@var{a})}
8513 @tab @code{MRDACCG @var{a},@var{b}}
8514 @item @code{uw1 __MROTLI (uw1, const)}
8515 @tab @code{@var{c} = __MROTLI (@var{a}, @var{b})}
8516 @tab @code{MROTLI @var{a},#@var{b},@var{c}}
8517 @item @code{uw1 __MROTRI (uw1, const)}
8518 @tab @code{@var{c} = __MROTRI (@var{a}, @var{b})}
8519 @tab @code{MROTRI @var{a},#@var{b},@var{c}}
8520 @item @code{sw1 __MSATHS (sw1, sw1)}
8521 @tab @code{@var{c} = __MSATHS (@var{a}, @var{b})}
8522 @tab @code{MSATHS @var{a},@var{b},@var{c}}
8523 @item @code{uw1 __MSATHU (uw1, uw1)}
8524 @tab @code{@var{c} = __MSATHU (@var{a}, @var{b})}
8525 @tab @code{MSATHU @var{a},@var{b},@var{c}}
8526 @item @code{uw1 __MSLLHI (uw1, const)}
8527 @tab @code{@var{c} = __MSLLHI (@var{a}, @var{b})}
8528 @tab @code{MSLLHI @var{a},#@var{b},@var{c}}
8529 @item @code{sw1 __MSRAHI (sw1, const)}
8530 @tab @code{@var{c} = __MSRAHI (@var{a}, @var{b})}
8531 @tab @code{MSRAHI @var{a},#@var{b},@var{c}}
8532 @item @code{uw1 __MSRLHI (uw1, const)}
8533 @tab @code{@var{c} = __MSRLHI (@var{a}, @var{b})}
8534 @tab @code{MSRLHI @var{a},#@var{b},@var{c}}
8535 @item @code{void __MSUBACCS (acc, acc)}
8536 @tab @code{__MSUBACCS (@var{b}, @var{a})}
8537 @tab @code{MSUBACCS @var{a},@var{b}}
8538 @item @code{sw1 __MSUBHSS (sw1, sw1)}
8539 @tab @code{@var{c} = __MSUBHSS (@var{a}, @var{b})}
8540 @tab @code{MSUBHSS @var{a},@var{b},@var{c}}
8541 @item @code{uw1 __MSUBHUS (uw1, uw1)}
8542 @tab @code{@var{c} = __MSUBHUS (@var{a}, @var{b})}
8543 @tab @code{MSUBHUS @var{a},@var{b},@var{c}}
8544 @item @code{void __MTRAP (void)}
8545 @tab @code{__MTRAP ()}
8546 @tab @code{MTRAP}
8547 @item @code{uw2 __MUNPACKH (uw1)}
8548 @tab @code{@var{b} = __MUNPACKH (@var{a})}
8549 @tab @code{MUNPACKH @var{a},@var{b}}
8550 @item @code{uw1 __MWCUT (uw2, uw1)}
8551 @tab @code{@var{c} = __MWCUT (@var{a}, @var{b})}
8552 @tab @code{MWCUT @var{a},@var{b},@var{c}}
8553 @item @code{void __MWTACC (acc, uw1)}
8554 @tab @code{__MWTACC (@var{b}, @var{a})}
8555 @tab @code{MWTACC @var{a},@var{b}}
8556 @item @code{void __MWTACCG (acc, uw1)}
8557 @tab @code{__MWTACCG (@var{b}, @var{a})}
8558 @tab @code{MWTACCG @var{a},@var{b}}
8559 @item @code{uw1 __MXOR (uw1, uw1)}
8560 @tab @code{@var{c} = __MXOR (@var{a}, @var{b})}
8561 @tab @code{MXOR @var{a},@var{b},@var{c}}
8562 @end multitable
8563
8564 @node Raw read/write Functions
8565 @subsubsection Raw read/write Functions
8566
8567 This sections describes built-in functions related to read and write
8568 instructions to access memory.  These functions generate
8569 @code{membar} instructions to flush the I/O load and stores where
8570 appropriate, as described in Fujitsu's manual described above.
8571
8572 @table @code
8573
8574 @item unsigned char __builtin_read8 (void *@var{data})
8575 @item unsigned short __builtin_read16 (void *@var{data})
8576 @item unsigned long __builtin_read32 (void *@var{data})
8577 @item unsigned long long __builtin_read64 (void *@var{data})
8578
8579 @item void __builtin_write8 (void *@var{data}, unsigned char @var{datum})
8580 @item void __builtin_write16 (void *@var{data}, unsigned short @var{datum})
8581 @item void __builtin_write32 (void *@var{data}, unsigned long @var{datum})
8582 @item void __builtin_write64 (void *@var{data}, unsigned long long @var{datum})
8583 @end table
8584
8585 @node Other Built-in Functions
8586 @subsubsection Other Built-in Functions
8587
8588 This section describes built-in functions that are not named after
8589 a specific FR-V instruction.
8590
8591 @table @code
8592 @item sw2 __IACCreadll (iacc @var{reg})
8593 Return the full 64-bit value of IACC0@.  The @var{reg} argument is reserved
8594 for future expansion and must be 0.
8595
8596 @item sw1 __IACCreadl (iacc @var{reg})
8597 Return the value of IACC0H if @var{reg} is 0 and IACC0L if @var{reg} is 1.
8598 Other values of @var{reg} are rejected as invalid.
8599
8600 @item void __IACCsetll (iacc @var{reg}, sw2 @var{x})
8601 Set the full 64-bit value of IACC0 to @var{x}.  The @var{reg} argument
8602 is reserved for future expansion and must be 0.
8603
8604 @item void __IACCsetl (iacc @var{reg}, sw1 @var{x})
8605 Set IACC0H to @var{x} if @var{reg} is 0 and IACC0L to @var{x} if @var{reg}
8606 is 1.  Other values of @var{reg} are rejected as invalid.
8607
8608 @item void __data_prefetch0 (const void *@var{x})
8609 Use the @code{dcpl} instruction to load the contents of address @var{x}
8610 into the data cache.
8611
8612 @item void __data_prefetch (const void *@var{x})
8613 Use the @code{nldub} instruction to load the contents of address @var{x}
8614 into the data cache.  The instruction will be issued in slot I1@.
8615 @end table
8616
8617 @node X86 Built-in Functions
8618 @subsection X86 Built-in Functions
8619
8620 These built-in functions are available for the i386 and x86-64 family
8621 of computers, depending on the command-line switches used.
8622
8623 Note that, if you specify command-line switches such as @option{-msse},
8624 the compiler could use the extended instruction sets even if the built-ins
8625 are not used explicitly in the program.  For this reason, applications
8626 which perform runtime CPU detection must compile separate files for each
8627 supported architecture, using the appropriate flags.  In particular,
8628 the file containing the CPU detection code should be compiled without
8629 these options.
8630
8631 The following machine modes are available for use with MMX built-in functions
8632 (@pxref{Vector Extensions}): @code{V2SI} for a vector of two 32-bit integers,
8633 @code{V4HI} for a vector of four 16-bit integers, and @code{V8QI} for a
8634 vector of eight 8-bit integers.  Some of the built-in functions operate on
8635 MMX registers as a whole 64-bit entity, these use @code{V1DI} as their mode.
8636
8637 If 3DNow!@: extensions are enabled, @code{V2SF} is used as a mode for a vector
8638 of two 32-bit floating point values.
8639
8640 If SSE extensions are enabled, @code{V4SF} is used for a vector of four 32-bit
8641 floating point values.  Some instructions use a vector of four 32-bit
8642 integers, these use @code{V4SI}.  Finally, some instructions operate on an
8643 entire vector register, interpreting it as a 128-bit integer, these use mode
8644 @code{TI}.
8645
8646 In 64-bit mode, the x86-64 family of processors uses additional built-in
8647 functions for efficient use of @code{TF} (@code{__float128}) 128-bit
8648 floating point and @code{TC} 128-bit complex floating point values.
8649
8650 The following floating point built-in functions are available in 64-bit
8651 mode.  All of them implement the function that is part of the name.
8652
8653 @smallexample
8654 __float128 __builtin_fabsq (__float128)
8655 __float128 __builtin_copysignq (__float128, __float128)
8656 @end smallexample
8657
8658 The following floating point built-in functions are made available in the
8659 64-bit mode.
8660
8661 @table @code
8662 @item __float128 __builtin_infq (void)
8663 Similar to @code{__builtin_inf}, except the return type is @code{__float128}.
8664 @findex __builtin_infq
8665
8666 @item __float128 __builtin_huge_valq (void)
8667 Similar to @code{__builtin_huge_val}, except the return type is @code{__float128}.
8668 @findex __builtin_huge_valq
8669 @end table
8670
8671 The following built-in functions are made available by @option{-mmmx}.
8672 All of them generate the machine instruction that is part of the name.
8673
8674 @smallexample
8675 v8qi __builtin_ia32_paddb (v8qi, v8qi)
8676 v4hi __builtin_ia32_paddw (v4hi, v4hi)
8677 v2si __builtin_ia32_paddd (v2si, v2si)
8678 v8qi __builtin_ia32_psubb (v8qi, v8qi)
8679 v4hi __builtin_ia32_psubw (v4hi, v4hi)
8680 v2si __builtin_ia32_psubd (v2si, v2si)
8681 v8qi __builtin_ia32_paddsb (v8qi, v8qi)
8682 v4hi __builtin_ia32_paddsw (v4hi, v4hi)
8683 v8qi __builtin_ia32_psubsb (v8qi, v8qi)
8684 v4hi __builtin_ia32_psubsw (v4hi, v4hi)
8685 v8qi __builtin_ia32_paddusb (v8qi, v8qi)
8686 v4hi __builtin_ia32_paddusw (v4hi, v4hi)
8687 v8qi __builtin_ia32_psubusb (v8qi, v8qi)
8688 v4hi __builtin_ia32_psubusw (v4hi, v4hi)
8689 v4hi __builtin_ia32_pmullw (v4hi, v4hi)
8690 v4hi __builtin_ia32_pmulhw (v4hi, v4hi)
8691 di __builtin_ia32_pand (di, di)
8692 di __builtin_ia32_pandn (di,di)
8693 di __builtin_ia32_por (di, di)
8694 di __builtin_ia32_pxor (di, di)
8695 v8qi __builtin_ia32_pcmpeqb (v8qi, v8qi)
8696 v4hi __builtin_ia32_pcmpeqw (v4hi, v4hi)
8697 v2si __builtin_ia32_pcmpeqd (v2si, v2si)
8698 v8qi __builtin_ia32_pcmpgtb (v8qi, v8qi)
8699 v4hi __builtin_ia32_pcmpgtw (v4hi, v4hi)
8700 v2si __builtin_ia32_pcmpgtd (v2si, v2si)
8701 v8qi __builtin_ia32_punpckhbw (v8qi, v8qi)
8702 v4hi __builtin_ia32_punpckhwd (v4hi, v4hi)
8703 v2si __builtin_ia32_punpckhdq (v2si, v2si)
8704 v8qi __builtin_ia32_punpcklbw (v8qi, v8qi)
8705 v4hi __builtin_ia32_punpcklwd (v4hi, v4hi)
8706 v2si __builtin_ia32_punpckldq (v2si, v2si)
8707 v8qi __builtin_ia32_packsswb (v4hi, v4hi)
8708 v4hi __builtin_ia32_packssdw (v2si, v2si)
8709 v8qi __builtin_ia32_packuswb (v4hi, v4hi)
8710
8711 v4hi __builtin_ia32_psllw (v4hi, v4hi)
8712 v2si __builtin_ia32_pslld (v2si, v2si)
8713 v1di __builtin_ia32_psllq (v1di, v1di)
8714 v4hi __builtin_ia32_psrlw (v4hi, v4hi)
8715 v2si __builtin_ia32_psrld (v2si, v2si)
8716 v1di __builtin_ia32_psrlq (v1di, v1di)
8717 v4hi __builtin_ia32_psraw (v4hi, v4hi)
8718 v2si __builtin_ia32_psrad (v2si, v2si)
8719 v4hi __builtin_ia32_psllwi (v4hi, int)
8720 v2si __builtin_ia32_pslldi (v2si, int)
8721 v1di __builtin_ia32_psllqi (v1di, int)
8722 v4hi __builtin_ia32_psrlwi (v4hi, int)
8723 v2si __builtin_ia32_psrldi (v2si, int)
8724 v1di __builtin_ia32_psrlqi (v1di, int)
8725 v4hi __builtin_ia32_psrawi (v4hi, int)
8726 v2si __builtin_ia32_psradi (v2si, int)
8727
8728 @end smallexample
8729
8730 The following built-in functions are made available either with
8731 @option{-msse}, or with a combination of @option{-m3dnow} and
8732 @option{-march=athlon}.  All of them generate the machine
8733 instruction that is part of the name.
8734
8735 @smallexample
8736 v4hi __builtin_ia32_pmulhuw (v4hi, v4hi)
8737 v8qi __builtin_ia32_pavgb (v8qi, v8qi)
8738 v4hi __builtin_ia32_pavgw (v4hi, v4hi)
8739 v1di __builtin_ia32_psadbw (v8qi, v8qi)
8740 v8qi __builtin_ia32_pmaxub (v8qi, v8qi)
8741 v4hi __builtin_ia32_pmaxsw (v4hi, v4hi)
8742 v8qi __builtin_ia32_pminub (v8qi, v8qi)
8743 v4hi __builtin_ia32_pminsw (v4hi, v4hi)
8744 int __builtin_ia32_pextrw (v4hi, int)
8745 v4hi __builtin_ia32_pinsrw (v4hi, int, int)
8746 int __builtin_ia32_pmovmskb (v8qi)
8747 void __builtin_ia32_maskmovq (v8qi, v8qi, char *)
8748 void __builtin_ia32_movntq (di *, di)
8749 void __builtin_ia32_sfence (void)
8750 @end smallexample
8751
8752 The following built-in functions are available when @option{-msse} is used.
8753 All of them generate the machine instruction that is part of the name.
8754
8755 @smallexample
8756 int __builtin_ia32_comieq (v4sf, v4sf)
8757 int __builtin_ia32_comineq (v4sf, v4sf)
8758 int __builtin_ia32_comilt (v4sf, v4sf)
8759 int __builtin_ia32_comile (v4sf, v4sf)
8760 int __builtin_ia32_comigt (v4sf, v4sf)
8761 int __builtin_ia32_comige (v4sf, v4sf)
8762 int __builtin_ia32_ucomieq (v4sf, v4sf)
8763 int __builtin_ia32_ucomineq (v4sf, v4sf)
8764 int __builtin_ia32_ucomilt (v4sf, v4sf)
8765 int __builtin_ia32_ucomile (v4sf, v4sf)
8766 int __builtin_ia32_ucomigt (v4sf, v4sf)
8767 int __builtin_ia32_ucomige (v4sf, v4sf)
8768 v4sf __builtin_ia32_addps (v4sf, v4sf)
8769 v4sf __builtin_ia32_subps (v4sf, v4sf)
8770 v4sf __builtin_ia32_mulps (v4sf, v4sf)
8771 v4sf __builtin_ia32_divps (v4sf, v4sf)
8772 v4sf __builtin_ia32_addss (v4sf, v4sf)
8773 v4sf __builtin_ia32_subss (v4sf, v4sf)
8774 v4sf __builtin_ia32_mulss (v4sf, v4sf)
8775 v4sf __builtin_ia32_divss (v4sf, v4sf)
8776 v4si __builtin_ia32_cmpeqps (v4sf, v4sf)
8777 v4si __builtin_ia32_cmpltps (v4sf, v4sf)
8778 v4si __builtin_ia32_cmpleps (v4sf, v4sf)
8779 v4si __builtin_ia32_cmpgtps (v4sf, v4sf)
8780 v4si __builtin_ia32_cmpgeps (v4sf, v4sf)
8781 v4si __builtin_ia32_cmpunordps (v4sf, v4sf)
8782 v4si __builtin_ia32_cmpneqps (v4sf, v4sf)
8783 v4si __builtin_ia32_cmpnltps (v4sf, v4sf)
8784 v4si __builtin_ia32_cmpnleps (v4sf, v4sf)
8785 v4si __builtin_ia32_cmpngtps (v4sf, v4sf)
8786 v4si __builtin_ia32_cmpngeps (v4sf, v4sf)
8787 v4si __builtin_ia32_cmpordps (v4sf, v4sf)
8788 v4si __builtin_ia32_cmpeqss (v4sf, v4sf)
8789 v4si __builtin_ia32_cmpltss (v4sf, v4sf)
8790 v4si __builtin_ia32_cmpless (v4sf, v4sf)
8791 v4si __builtin_ia32_cmpunordss (v4sf, v4sf)
8792 v4si __builtin_ia32_cmpneqss (v4sf, v4sf)
8793 v4si __builtin_ia32_cmpnlts (v4sf, v4sf)
8794 v4si __builtin_ia32_cmpnless (v4sf, v4sf)
8795 v4si __builtin_ia32_cmpordss (v4sf, v4sf)
8796 v4sf __builtin_ia32_maxps (v4sf, v4sf)
8797 v4sf __builtin_ia32_maxss (v4sf, v4sf)
8798 v4sf __builtin_ia32_minps (v4sf, v4sf)
8799 v4sf __builtin_ia32_minss (v4sf, v4sf)
8800 v4sf __builtin_ia32_andps (v4sf, v4sf)
8801 v4sf __builtin_ia32_andnps (v4sf, v4sf)
8802 v4sf __builtin_ia32_orps (v4sf, v4sf)
8803 v4sf __builtin_ia32_xorps (v4sf, v4sf)
8804 v4sf __builtin_ia32_movss (v4sf, v4sf)
8805 v4sf __builtin_ia32_movhlps (v4sf, v4sf)
8806 v4sf __builtin_ia32_movlhps (v4sf, v4sf)
8807 v4sf __builtin_ia32_unpckhps (v4sf, v4sf)
8808 v4sf __builtin_ia32_unpcklps (v4sf, v4sf)
8809 v4sf __builtin_ia32_cvtpi2ps (v4sf, v2si)
8810 v4sf __builtin_ia32_cvtsi2ss (v4sf, int)
8811 v2si __builtin_ia32_cvtps2pi (v4sf)
8812 int __builtin_ia32_cvtss2si (v4sf)
8813 v2si __builtin_ia32_cvttps2pi (v4sf)
8814 int __builtin_ia32_cvttss2si (v4sf)
8815 v4sf __builtin_ia32_rcpps (v4sf)
8816 v4sf __builtin_ia32_rsqrtps (v4sf)
8817 v4sf __builtin_ia32_sqrtps (v4sf)
8818 v4sf __builtin_ia32_rcpss (v4sf)
8819 v4sf __builtin_ia32_rsqrtss (v4sf)
8820 v4sf __builtin_ia32_sqrtss (v4sf)
8821 v4sf __builtin_ia32_shufps (v4sf, v4sf, int)
8822 void __builtin_ia32_movntps (float *, v4sf)
8823 int __builtin_ia32_movmskps (v4sf)
8824 @end smallexample
8825
8826 The following built-in functions are available when @option{-msse} is used.
8827
8828 @table @code
8829 @item v4sf __builtin_ia32_loadaps (float *)
8830 Generates the @code{movaps} machine instruction as a load from memory.
8831 @item void __builtin_ia32_storeaps (float *, v4sf)
8832 Generates the @code{movaps} machine instruction as a store to memory.
8833 @item v4sf __builtin_ia32_loadups (float *)
8834 Generates the @code{movups} machine instruction as a load from memory.
8835 @item void __builtin_ia32_storeups (float *, v4sf)
8836 Generates the @code{movups} machine instruction as a store to memory.
8837 @item v4sf __builtin_ia32_loadsss (float *)
8838 Generates the @code{movss} machine instruction as a load from memory.
8839 @item void __builtin_ia32_storess (float *, v4sf)
8840 Generates the @code{movss} machine instruction as a store to memory.
8841 @item v4sf __builtin_ia32_loadhps (v4sf, const v2sf *)
8842 Generates the @code{movhps} machine instruction as a load from memory.
8843 @item v4sf __builtin_ia32_loadlps (v4sf, const v2sf *)
8844 Generates the @code{movlps} machine instruction as a load from memory
8845 @item void __builtin_ia32_storehps (v2sf *, v4sf)
8846 Generates the @code{movhps} machine instruction as a store to memory.
8847 @item void __builtin_ia32_storelps (v2sf *, v4sf)
8848 Generates the @code{movlps} machine instruction as a store to memory.
8849 @end table
8850
8851 The following built-in functions are available when @option{-msse2} is used.
8852 All of them generate the machine instruction that is part of the name.
8853
8854 @smallexample
8855 int __builtin_ia32_comisdeq (v2df, v2df)
8856 int __builtin_ia32_comisdlt (v2df, v2df)
8857 int __builtin_ia32_comisdle (v2df, v2df)
8858 int __builtin_ia32_comisdgt (v2df, v2df)
8859 int __builtin_ia32_comisdge (v2df, v2df)
8860 int __builtin_ia32_comisdneq (v2df, v2df)
8861 int __builtin_ia32_ucomisdeq (v2df, v2df)
8862 int __builtin_ia32_ucomisdlt (v2df, v2df)
8863 int __builtin_ia32_ucomisdle (v2df, v2df)
8864 int __builtin_ia32_ucomisdgt (v2df, v2df)
8865 int __builtin_ia32_ucomisdge (v2df, v2df)
8866 int __builtin_ia32_ucomisdneq (v2df, v2df)
8867 v2df __builtin_ia32_cmpeqpd (v2df, v2df)
8868 v2df __builtin_ia32_cmpltpd (v2df, v2df)
8869 v2df __builtin_ia32_cmplepd (v2df, v2df)
8870 v2df __builtin_ia32_cmpgtpd (v2df, v2df)
8871 v2df __builtin_ia32_cmpgepd (v2df, v2df)
8872 v2df __builtin_ia32_cmpunordpd (v2df, v2df)
8873 v2df __builtin_ia32_cmpneqpd (v2df, v2df)
8874 v2df __builtin_ia32_cmpnltpd (v2df, v2df)
8875 v2df __builtin_ia32_cmpnlepd (v2df, v2df)
8876 v2df __builtin_ia32_cmpngtpd (v2df, v2df)
8877 v2df __builtin_ia32_cmpngepd (v2df, v2df)
8878 v2df __builtin_ia32_cmpordpd (v2df, v2df)
8879 v2df __builtin_ia32_cmpeqsd (v2df, v2df)
8880 v2df __builtin_ia32_cmpltsd (v2df, v2df)
8881 v2df __builtin_ia32_cmplesd (v2df, v2df)
8882 v2df __builtin_ia32_cmpunordsd (v2df, v2df)
8883 v2df __builtin_ia32_cmpneqsd (v2df, v2df)
8884 v2df __builtin_ia32_cmpnltsd (v2df, v2df)
8885 v2df __builtin_ia32_cmpnlesd (v2df, v2df)
8886 v2df __builtin_ia32_cmpordsd (v2df, v2df)
8887 v2di __builtin_ia32_paddq (v2di, v2di)
8888 v2di __builtin_ia32_psubq (v2di, v2di)
8889 v2df __builtin_ia32_addpd (v2df, v2df)
8890 v2df __builtin_ia32_subpd (v2df, v2df)
8891 v2df __builtin_ia32_mulpd (v2df, v2df)
8892 v2df __builtin_ia32_divpd (v2df, v2df)
8893 v2df __builtin_ia32_addsd (v2df, v2df)
8894 v2df __builtin_ia32_subsd (v2df, v2df)
8895 v2df __builtin_ia32_mulsd (v2df, v2df)
8896 v2df __builtin_ia32_divsd (v2df, v2df)
8897 v2df __builtin_ia32_minpd (v2df, v2df)
8898 v2df __builtin_ia32_maxpd (v2df, v2df)
8899 v2df __builtin_ia32_minsd (v2df, v2df)
8900 v2df __builtin_ia32_maxsd (v2df, v2df)
8901 v2df __builtin_ia32_andpd (v2df, v2df)
8902 v2df __builtin_ia32_andnpd (v2df, v2df)
8903 v2df __builtin_ia32_orpd (v2df, v2df)
8904 v2df __builtin_ia32_xorpd (v2df, v2df)
8905 v2df __builtin_ia32_movsd (v2df, v2df)
8906 v2df __builtin_ia32_unpckhpd (v2df, v2df)
8907 v2df __builtin_ia32_unpcklpd (v2df, v2df)
8908 v16qi __builtin_ia32_paddb128 (v16qi, v16qi)
8909 v8hi __builtin_ia32_paddw128 (v8hi, v8hi)
8910 v4si __builtin_ia32_paddd128 (v4si, v4si)
8911 v2di __builtin_ia32_paddq128 (v2di, v2di)
8912 v16qi __builtin_ia32_psubb128 (v16qi, v16qi)
8913 v8hi __builtin_ia32_psubw128 (v8hi, v8hi)
8914 v4si __builtin_ia32_psubd128 (v4si, v4si)
8915 v2di __builtin_ia32_psubq128 (v2di, v2di)
8916 v8hi __builtin_ia32_pmullw128 (v8hi, v8hi)
8917 v8hi __builtin_ia32_pmulhw128 (v8hi, v8hi)
8918 v2di __builtin_ia32_pand128 (v2di, v2di)
8919 v2di __builtin_ia32_pandn128 (v2di, v2di)
8920 v2di __builtin_ia32_por128 (v2di, v2di)
8921 v2di __builtin_ia32_pxor128 (v2di, v2di)
8922 v16qi __builtin_ia32_pavgb128 (v16qi, v16qi)
8923 v8hi __builtin_ia32_pavgw128 (v8hi, v8hi)
8924 v16qi __builtin_ia32_pcmpeqb128 (v16qi, v16qi)
8925 v8hi __builtin_ia32_pcmpeqw128 (v8hi, v8hi)
8926 v4si __builtin_ia32_pcmpeqd128 (v4si, v4si)
8927 v16qi __builtin_ia32_pcmpgtb128 (v16qi, v16qi)
8928 v8hi __builtin_ia32_pcmpgtw128 (v8hi, v8hi)
8929 v4si __builtin_ia32_pcmpgtd128 (v4si, v4si)
8930 v16qi __builtin_ia32_pmaxub128 (v16qi, v16qi)
8931 v8hi __builtin_ia32_pmaxsw128 (v8hi, v8hi)
8932 v16qi __builtin_ia32_pminub128 (v16qi, v16qi)
8933 v8hi __builtin_ia32_pminsw128 (v8hi, v8hi)
8934 v16qi __builtin_ia32_punpckhbw128 (v16qi, v16qi)
8935 v8hi __builtin_ia32_punpckhwd128 (v8hi, v8hi)
8936 v4si __builtin_ia32_punpckhdq128 (v4si, v4si)
8937 v2di __builtin_ia32_punpckhqdq128 (v2di, v2di)
8938 v16qi __builtin_ia32_punpcklbw128 (v16qi, v16qi)
8939 v8hi __builtin_ia32_punpcklwd128 (v8hi, v8hi)
8940 v4si __builtin_ia32_punpckldq128 (v4si, v4si)
8941 v2di __builtin_ia32_punpcklqdq128 (v2di, v2di)
8942 v16qi __builtin_ia32_packsswb128 (v8hi, v8hi)
8943 v8hi __builtin_ia32_packssdw128 (v4si, v4si)
8944 v16qi __builtin_ia32_packuswb128 (v8hi, v8hi)
8945 v8hi __builtin_ia32_pmulhuw128 (v8hi, v8hi)
8946 void __builtin_ia32_maskmovdqu (v16qi, v16qi)
8947 v2df __builtin_ia32_loadupd (double *)
8948 void __builtin_ia32_storeupd (double *, v2df)
8949 v2df __builtin_ia32_loadhpd (v2df, double const *)
8950 v2df __builtin_ia32_loadlpd (v2df, double const *)
8951 int __builtin_ia32_movmskpd (v2df)
8952 int __builtin_ia32_pmovmskb128 (v16qi)
8953 void __builtin_ia32_movnti (int *, int)
8954 void __builtin_ia32_movntpd (double *, v2df)
8955 void __builtin_ia32_movntdq (v2df *, v2df)
8956 v4si __builtin_ia32_pshufd (v4si, int)
8957 v8hi __builtin_ia32_pshuflw (v8hi, int)
8958 v8hi __builtin_ia32_pshufhw (v8hi, int)
8959 v2di __builtin_ia32_psadbw128 (v16qi, v16qi)
8960 v2df __builtin_ia32_sqrtpd (v2df)
8961 v2df __builtin_ia32_sqrtsd (v2df)
8962 v2df __builtin_ia32_shufpd (v2df, v2df, int)
8963 v2df __builtin_ia32_cvtdq2pd (v4si)
8964 v4sf __builtin_ia32_cvtdq2ps (v4si)
8965 v4si __builtin_ia32_cvtpd2dq (v2df)
8966 v2si __builtin_ia32_cvtpd2pi (v2df)
8967 v4sf __builtin_ia32_cvtpd2ps (v2df)
8968 v4si __builtin_ia32_cvttpd2dq (v2df)
8969 v2si __builtin_ia32_cvttpd2pi (v2df)
8970 v2df __builtin_ia32_cvtpi2pd (v2si)
8971 int __builtin_ia32_cvtsd2si (v2df)
8972 int __builtin_ia32_cvttsd2si (v2df)
8973 long long __builtin_ia32_cvtsd2si64 (v2df)
8974 long long __builtin_ia32_cvttsd2si64 (v2df)
8975 v4si __builtin_ia32_cvtps2dq (v4sf)
8976 v2df __builtin_ia32_cvtps2pd (v4sf)
8977 v4si __builtin_ia32_cvttps2dq (v4sf)
8978 v2df __builtin_ia32_cvtsi2sd (v2df, int)
8979 v2df __builtin_ia32_cvtsi642sd (v2df, long long)
8980 v4sf __builtin_ia32_cvtsd2ss (v4sf, v2df)
8981 v2df __builtin_ia32_cvtss2sd (v2df, v4sf)
8982 void __builtin_ia32_clflush (const void *)
8983 void __builtin_ia32_lfence (void)
8984 void __builtin_ia32_mfence (void)
8985 v16qi __builtin_ia32_loaddqu (const char *)
8986 void __builtin_ia32_storedqu (char *, v16qi)
8987 v1di __builtin_ia32_pmuludq (v2si, v2si)
8988 v2di __builtin_ia32_pmuludq128 (v4si, v4si)
8989 v8hi __builtin_ia32_psllw128 (v8hi, v8hi)
8990 v4si __builtin_ia32_pslld128 (v4si, v4si)
8991 v2di __builtin_ia32_psllq128 (v2di, v2di)
8992 v8hi __builtin_ia32_psrlw128 (v8hi, v8hi)
8993 v4si __builtin_ia32_psrld128 (v4si, v4si)
8994 v2di __builtin_ia32_psrlq128 (v2di, v2di)
8995 v8hi __builtin_ia32_psraw128 (v8hi, v8hi)
8996 v4si __builtin_ia32_psrad128 (v4si, v4si)
8997 v2di __builtin_ia32_pslldqi128 (v2di, int)
8998 v8hi __builtin_ia32_psllwi128 (v8hi, int)
8999 v4si __builtin_ia32_pslldi128 (v4si, int)
9000 v2di __builtin_ia32_psllqi128 (v2di, int)
9001 v2di __builtin_ia32_psrldqi128 (v2di, int)
9002 v8hi __builtin_ia32_psrlwi128 (v8hi, int)
9003 v4si __builtin_ia32_psrldi128 (v4si, int)
9004 v2di __builtin_ia32_psrlqi128 (v2di, int)
9005 v8hi __builtin_ia32_psrawi128 (v8hi, int)
9006 v4si __builtin_ia32_psradi128 (v4si, int)
9007 v4si __builtin_ia32_pmaddwd128 (v8hi, v8hi)
9008 v2di __builtin_ia32_movq128 (v2di)
9009 @end smallexample
9010
9011 The following built-in functions are available when @option{-msse3} is used.
9012 All of them generate the machine instruction that is part of the name.
9013
9014 @smallexample
9015 v2df __builtin_ia32_addsubpd (v2df, v2df)
9016 v4sf __builtin_ia32_addsubps (v4sf, v4sf)
9017 v2df __builtin_ia32_haddpd (v2df, v2df)
9018 v4sf __builtin_ia32_haddps (v4sf, v4sf)
9019 v2df __builtin_ia32_hsubpd (v2df, v2df)
9020 v4sf __builtin_ia32_hsubps (v4sf, v4sf)
9021 v16qi __builtin_ia32_lddqu (char const *)
9022 void __builtin_ia32_monitor (void *, unsigned int, unsigned int)
9023 v2df __builtin_ia32_movddup (v2df)
9024 v4sf __builtin_ia32_movshdup (v4sf)
9025 v4sf __builtin_ia32_movsldup (v4sf)
9026 void __builtin_ia32_mwait (unsigned int, unsigned int)
9027 @end smallexample
9028
9029 The following built-in functions are available when @option{-msse3} is used.
9030
9031 @table @code
9032 @item v2df __builtin_ia32_loadddup (double const *)
9033 Generates the @code{movddup} machine instruction as a load from memory.
9034 @end table
9035
9036 The following built-in functions are available when @option{-mssse3} is used.
9037 All of them generate the machine instruction that is part of the name
9038 with MMX registers.
9039
9040 @smallexample
9041 v2si __builtin_ia32_phaddd (v2si, v2si)
9042 v4hi __builtin_ia32_phaddw (v4hi, v4hi)
9043 v4hi __builtin_ia32_phaddsw (v4hi, v4hi)
9044 v2si __builtin_ia32_phsubd (v2si, v2si)
9045 v4hi __builtin_ia32_phsubw (v4hi, v4hi)
9046 v4hi __builtin_ia32_phsubsw (v4hi, v4hi)
9047 v4hi __builtin_ia32_pmaddubsw (v8qi, v8qi)
9048 v4hi __builtin_ia32_pmulhrsw (v4hi, v4hi)
9049 v8qi __builtin_ia32_pshufb (v8qi, v8qi)
9050 v8qi __builtin_ia32_psignb (v8qi, v8qi)
9051 v2si __builtin_ia32_psignd (v2si, v2si)
9052 v4hi __builtin_ia32_psignw (v4hi, v4hi)
9053 v1di __builtin_ia32_palignr (v1di, v1di, int)
9054 v8qi __builtin_ia32_pabsb (v8qi)
9055 v2si __builtin_ia32_pabsd (v2si)
9056 v4hi __builtin_ia32_pabsw (v4hi)
9057 @end smallexample
9058
9059 The following built-in functions are available when @option{-mssse3} is used.
9060 All of them generate the machine instruction that is part of the name
9061 with SSE registers.
9062
9063 @smallexample
9064 v4si __builtin_ia32_phaddd128 (v4si, v4si)
9065 v8hi __builtin_ia32_phaddw128 (v8hi, v8hi)
9066 v8hi __builtin_ia32_phaddsw128 (v8hi, v8hi)
9067 v4si __builtin_ia32_phsubd128 (v4si, v4si)
9068 v8hi __builtin_ia32_phsubw128 (v8hi, v8hi)
9069 v8hi __builtin_ia32_phsubsw128 (v8hi, v8hi)
9070 v8hi __builtin_ia32_pmaddubsw128 (v16qi, v16qi)
9071 v8hi __builtin_ia32_pmulhrsw128 (v8hi, v8hi)
9072 v16qi __builtin_ia32_pshufb128 (v16qi, v16qi)
9073 v16qi __builtin_ia32_psignb128 (v16qi, v16qi)
9074 v4si __builtin_ia32_psignd128 (v4si, v4si)
9075 v8hi __builtin_ia32_psignw128 (v8hi, v8hi)
9076 v2di __builtin_ia32_palignr128 (v2di, v2di, int)
9077 v16qi __builtin_ia32_pabsb128 (v16qi)
9078 v4si __builtin_ia32_pabsd128 (v4si)
9079 v8hi __builtin_ia32_pabsw128 (v8hi)
9080 @end smallexample
9081
9082 The following built-in functions are available when @option{-msse4.1} is
9083 used.  All of them generate the machine instruction that is part of the
9084 name.
9085
9086 @smallexample
9087 v2df __builtin_ia32_blendpd (v2df, v2df, const int)
9088 v4sf __builtin_ia32_blendps (v4sf, v4sf, const int)
9089 v2df __builtin_ia32_blendvpd (v2df, v2df, v2df)
9090 v4sf __builtin_ia32_blendvps (v4sf, v4sf, v4sf)
9091 v2df __builtin_ia32_dppd (v2df, v2df, const int)
9092 v4sf __builtin_ia32_dpps (v4sf, v4sf, const int)
9093 v4sf __builtin_ia32_insertps128 (v4sf, v4sf, const int)
9094 v2di __builtin_ia32_movntdqa (v2di *);
9095 v16qi __builtin_ia32_mpsadbw128 (v16qi, v16qi, const int)
9096 v8hi __builtin_ia32_packusdw128 (v4si, v4si)
9097 v16qi __builtin_ia32_pblendvb128 (v16qi, v16qi, v16qi)
9098 v8hi __builtin_ia32_pblendw128 (v8hi, v8hi, const int)
9099 v2di __builtin_ia32_pcmpeqq (v2di, v2di)
9100 v8hi __builtin_ia32_phminposuw128 (v8hi)
9101 v16qi __builtin_ia32_pmaxsb128 (v16qi, v16qi)
9102 v4si __builtin_ia32_pmaxsd128 (v4si, v4si)
9103 v4si __builtin_ia32_pmaxud128 (v4si, v4si)
9104 v8hi __builtin_ia32_pmaxuw128 (v8hi, v8hi)
9105 v16qi __builtin_ia32_pminsb128 (v16qi, v16qi)
9106 v4si __builtin_ia32_pminsd128 (v4si, v4si)
9107 v4si __builtin_ia32_pminud128 (v4si, v4si)
9108 v8hi __builtin_ia32_pminuw128 (v8hi, v8hi)
9109 v4si __builtin_ia32_pmovsxbd128 (v16qi)
9110 v2di __builtin_ia32_pmovsxbq128 (v16qi)
9111 v8hi __builtin_ia32_pmovsxbw128 (v16qi)
9112 v2di __builtin_ia32_pmovsxdq128 (v4si)
9113 v4si __builtin_ia32_pmovsxwd128 (v8hi)
9114 v2di __builtin_ia32_pmovsxwq128 (v8hi)
9115 v4si __builtin_ia32_pmovzxbd128 (v16qi)
9116 v2di __builtin_ia32_pmovzxbq128 (v16qi)
9117 v8hi __builtin_ia32_pmovzxbw128 (v16qi)
9118 v2di __builtin_ia32_pmovzxdq128 (v4si)
9119 v4si __builtin_ia32_pmovzxwd128 (v8hi)
9120 v2di __builtin_ia32_pmovzxwq128 (v8hi)
9121 v2di __builtin_ia32_pmuldq128 (v4si, v4si)
9122 v4si __builtin_ia32_pmulld128 (v4si, v4si)
9123 int __builtin_ia32_ptestc128 (v2di, v2di)
9124 int __builtin_ia32_ptestnzc128 (v2di, v2di)
9125 int __builtin_ia32_ptestz128 (v2di, v2di)
9126 v2df __builtin_ia32_roundpd (v2df, const int)
9127 v4sf __builtin_ia32_roundps (v4sf, const int)
9128 v2df __builtin_ia32_roundsd (v2df, v2df, const int)
9129 v4sf __builtin_ia32_roundss (v4sf, v4sf, const int)
9130 @end smallexample
9131
9132 The following built-in functions are available when @option{-msse4.1} is
9133 used.
9134
9135 @table @code
9136 @item v4sf __builtin_ia32_vec_set_v4sf (v4sf, float, const int)
9137 Generates the @code{insertps} machine instruction.
9138 @item int __builtin_ia32_vec_ext_v16qi (v16qi, const int)
9139 Generates the @code{pextrb} machine instruction.
9140 @item v16qi __builtin_ia32_vec_set_v16qi (v16qi, int, const int)
9141 Generates the @code{pinsrb} machine instruction.
9142 @item v4si __builtin_ia32_vec_set_v4si (v4si, int, const int)
9143 Generates the @code{pinsrd} machine instruction.
9144 @item v2di __builtin_ia32_vec_set_v2di (v2di, long long, const int)
9145 Generates the @code{pinsrq} machine instruction in 64bit mode.
9146 @end table
9147
9148 The following built-in functions are changed to generate new SSE4.1
9149 instructions when @option{-msse4.1} is used.
9150
9151 @table @code
9152 @item float __builtin_ia32_vec_ext_v4sf (v4sf, const int)
9153 Generates the @code{extractps} machine instruction.
9154 @item int __builtin_ia32_vec_ext_v4si (v4si, const int)
9155 Generates the @code{pextrd} machine instruction.
9156 @item long long __builtin_ia32_vec_ext_v2di (v2di, const int)
9157 Generates the @code{pextrq} machine instruction in 64bit mode.
9158 @end table
9159
9160 The following built-in functions are available when @option{-msse4.2} is
9161 used.  All of them generate the machine instruction that is part of the
9162 name.
9163
9164 @smallexample
9165 v16qi __builtin_ia32_pcmpestrm128 (v16qi, int, v16qi, int, const int)
9166 int __builtin_ia32_pcmpestri128 (v16qi, int, v16qi, int, const int)
9167 int __builtin_ia32_pcmpestria128 (v16qi, int, v16qi, int, const int)
9168 int __builtin_ia32_pcmpestric128 (v16qi, int, v16qi, int, const int)
9169 int __builtin_ia32_pcmpestrio128 (v16qi, int, v16qi, int, const int)
9170 int __builtin_ia32_pcmpestris128 (v16qi, int, v16qi, int, const int)
9171 int __builtin_ia32_pcmpestriz128 (v16qi, int, v16qi, int, const int)
9172 v16qi __builtin_ia32_pcmpistrm128 (v16qi, v16qi, const int)
9173 int __builtin_ia32_pcmpistri128 (v16qi, v16qi, const int)
9174 int __builtin_ia32_pcmpistria128 (v16qi, v16qi, const int)
9175 int __builtin_ia32_pcmpistric128 (v16qi, v16qi, const int)
9176 int __builtin_ia32_pcmpistrio128 (v16qi, v16qi, const int)
9177 int __builtin_ia32_pcmpistris128 (v16qi, v16qi, const int)
9178 int __builtin_ia32_pcmpistriz128 (v16qi, v16qi, const int)
9179 v2di __builtin_ia32_pcmpgtq (v2di, v2di)
9180 @end smallexample
9181
9182 The following built-in functions are available when @option{-msse4.2} is
9183 used.
9184
9185 @table @code
9186 @item unsigned int __builtin_ia32_crc32qi (unsigned int, unsigned char)
9187 Generates the @code{crc32b} machine instruction.
9188 @item unsigned int __builtin_ia32_crc32hi (unsigned int, unsigned short)
9189 Generates the @code{crc32w} machine instruction.
9190 @item unsigned int __builtin_ia32_crc32si (unsigned int, unsigned int)
9191 Generates the @code{crc32l} machine instruction.
9192 @item unsigned long long __builtin_ia32_crc32di (unsigned long long, unsigned long long)
9193 Generates the @code{crc32q} machine instruction.
9194 @end table
9195
9196 The following built-in functions are changed to generate new SSE4.2
9197 instructions when @option{-msse4.2} is used.
9198
9199 @table @code
9200 @item int __builtin_popcount (unsigned int)
9201 Generates the @code{popcntl} machine instruction.
9202 @item int __builtin_popcountl (unsigned long)
9203 Generates the @code{popcntl} or @code{popcntq} machine instruction,
9204 depending on the size of @code{unsigned long}.
9205 @item int __builtin_popcountll (unsigned long long)
9206 Generates the @code{popcntq} machine instruction.
9207 @end table
9208
9209 The following built-in functions are available when @option{-mavx} is
9210 used. All of them generate the machine instruction that is part of the
9211 name.
9212
9213 @smallexample
9214 v4df __builtin_ia32_addpd256 (v4df,v4df)
9215 v8sf __builtin_ia32_addps256 (v8sf,v8sf)
9216 v4df __builtin_ia32_addsubpd256 (v4df,v4df)
9217 v8sf __builtin_ia32_addsubps256 (v8sf,v8sf)
9218 v4df __builtin_ia32_andnpd256 (v4df,v4df)
9219 v8sf __builtin_ia32_andnps256 (v8sf,v8sf)
9220 v4df __builtin_ia32_andpd256 (v4df,v4df)
9221 v8sf __builtin_ia32_andps256 (v8sf,v8sf)
9222 v4df __builtin_ia32_blendpd256 (v4df,v4df,int)
9223 v8sf __builtin_ia32_blendps256 (v8sf,v8sf,int)
9224 v4df __builtin_ia32_blendvpd256 (v4df,v4df,v4df)
9225 v8sf __builtin_ia32_blendvps256 (v8sf,v8sf,v8sf)
9226 v2df __builtin_ia32_cmppd (v2df,v2df,int)
9227 v4df __builtin_ia32_cmppd256 (v4df,v4df,int)
9228 v4sf __builtin_ia32_cmpps (v4sf,v4sf,int)
9229 v8sf __builtin_ia32_cmpps256 (v8sf,v8sf,int)
9230 v2df __builtin_ia32_cmpsd (v2df,v2df,int)
9231 v4sf __builtin_ia32_cmpss (v4sf,v4sf,int)
9232 v4df __builtin_ia32_cvtdq2pd256 (v4si)
9233 v8sf __builtin_ia32_cvtdq2ps256 (v8si)
9234 v4si __builtin_ia32_cvtpd2dq256 (v4df)
9235 v4sf __builtin_ia32_cvtpd2ps256 (v4df)
9236 v8si __builtin_ia32_cvtps2dq256 (v8sf)
9237 v4df __builtin_ia32_cvtps2pd256 (v4sf)
9238 v4si __builtin_ia32_cvttpd2dq256 (v4df)
9239 v8si __builtin_ia32_cvttps2dq256 (v8sf)
9240 v4df __builtin_ia32_divpd256 (v4df,v4df)
9241 v8sf __builtin_ia32_divps256 (v8sf,v8sf)
9242 v8sf __builtin_ia32_dpps256 (v8sf,v8sf,int)
9243 v4df __builtin_ia32_haddpd256 (v4df,v4df)
9244 v8sf __builtin_ia32_haddps256 (v8sf,v8sf)
9245 v4df __builtin_ia32_hsubpd256 (v4df,v4df)
9246 v8sf __builtin_ia32_hsubps256 (v8sf,v8sf)
9247 v32qi __builtin_ia32_lddqu256 (pcchar)
9248 v32qi __builtin_ia32_loaddqu256 (pcchar)
9249 v4df __builtin_ia32_loadupd256 (pcdouble)
9250 v8sf __builtin_ia32_loadups256 (pcfloat)
9251 v2df __builtin_ia32_maskloadpd (pcv2df,v2df)
9252 v4df __builtin_ia32_maskloadpd256 (pcv4df,v4df)
9253 v4sf __builtin_ia32_maskloadps (pcv4sf,v4sf)
9254 v8sf __builtin_ia32_maskloadps256 (pcv8sf,v8sf)
9255 void __builtin_ia32_maskstorepd (pv2df,v2df,v2df)
9256 void __builtin_ia32_maskstorepd256 (pv4df,v4df,v4df)
9257 void __builtin_ia32_maskstoreps (pv4sf,v4sf,v4sf)
9258 void __builtin_ia32_maskstoreps256 (pv8sf,v8sf,v8sf)
9259 v4df __builtin_ia32_maxpd256 (v4df,v4df)
9260 v8sf __builtin_ia32_maxps256 (v8sf,v8sf)
9261 v4df __builtin_ia32_minpd256 (v4df,v4df)
9262 v8sf __builtin_ia32_minps256 (v8sf,v8sf)
9263 v4df __builtin_ia32_movddup256 (v4df)
9264 int __builtin_ia32_movmskpd256 (v4df)
9265 int __builtin_ia32_movmskps256 (v8sf)
9266 v8sf __builtin_ia32_movshdup256 (v8sf)
9267 v8sf __builtin_ia32_movsldup256 (v8sf)
9268 v4df __builtin_ia32_mulpd256 (v4df,v4df)
9269 v8sf __builtin_ia32_mulps256 (v8sf,v8sf)
9270 v4df __builtin_ia32_orpd256 (v4df,v4df)
9271 v8sf __builtin_ia32_orps256 (v8sf,v8sf)
9272 v2df __builtin_ia32_pd_pd256 (v4df)
9273 v4df __builtin_ia32_pd256_pd (v2df)
9274 v4sf __builtin_ia32_ps_ps256 (v8sf)
9275 v8sf __builtin_ia32_ps256_ps (v4sf)
9276 int __builtin_ia32_ptestc256 (v4di,v4di,ptest)
9277 int __builtin_ia32_ptestnzc256 (v4di,v4di,ptest)
9278 int __builtin_ia32_ptestz256 (v4di,v4di,ptest)
9279 v8sf __builtin_ia32_rcpps256 (v8sf)
9280 v4df __builtin_ia32_roundpd256 (v4df,int)
9281 v8sf __builtin_ia32_roundps256 (v8sf,int)
9282 v8sf __builtin_ia32_rsqrtps_nr256 (v8sf)
9283 v8sf __builtin_ia32_rsqrtps256 (v8sf)
9284 v4df __builtin_ia32_shufpd256 (v4df,v4df,int)
9285 v8sf __builtin_ia32_shufps256 (v8sf,v8sf,int)
9286 v4si __builtin_ia32_si_si256 (v8si)
9287 v8si __builtin_ia32_si256_si (v4si)
9288 v4df __builtin_ia32_sqrtpd256 (v4df)
9289 v8sf __builtin_ia32_sqrtps_nr256 (v8sf)
9290 v8sf __builtin_ia32_sqrtps256 (v8sf)
9291 void __builtin_ia32_storedqu256 (pchar,v32qi)
9292 void __builtin_ia32_storeupd256 (pdouble,v4df)
9293 void __builtin_ia32_storeups256 (pfloat,v8sf)
9294 v4df __builtin_ia32_subpd256 (v4df,v4df)
9295 v8sf __builtin_ia32_subps256 (v8sf,v8sf)
9296 v4df __builtin_ia32_unpckhpd256 (v4df,v4df)
9297 v8sf __builtin_ia32_unpckhps256 (v8sf,v8sf)
9298 v4df __builtin_ia32_unpcklpd256 (v4df,v4df)
9299 v8sf __builtin_ia32_unpcklps256 (v8sf,v8sf)
9300 v4df __builtin_ia32_vbroadcastf128_pd256 (pcv2df)
9301 v8sf __builtin_ia32_vbroadcastf128_ps256 (pcv4sf)
9302 v4df __builtin_ia32_vbroadcastsd256 (pcdouble)
9303 v4sf __builtin_ia32_vbroadcastss (pcfloat)
9304 v8sf __builtin_ia32_vbroadcastss256 (pcfloat)
9305 v2df __builtin_ia32_vextractf128_pd256 (v4df,int)
9306 v4sf __builtin_ia32_vextractf128_ps256 (v8sf,int)
9307 v4si __builtin_ia32_vextractf128_si256 (v8si,int)
9308 v4df __builtin_ia32_vinsertf128_pd256 (v4df,v2df,int)
9309 v8sf __builtin_ia32_vinsertf128_ps256 (v8sf,v4sf,int)
9310 v8si __builtin_ia32_vinsertf128_si256 (v8si,v4si,int)
9311 v4df __builtin_ia32_vperm2f128_pd256 (v4df,v4df,int)
9312 v8sf __builtin_ia32_vperm2f128_ps256 (v8sf,v8sf,int)
9313 v8si __builtin_ia32_vperm2f128_si256 (v8si,v8si,int)
9314 v2df __builtin_ia32_vpermil2pd (v2df,v2df,v2di,int)
9315 v4df __builtin_ia32_vpermil2pd256 (v4df,v4df,v4di,int)
9316 v4sf __builtin_ia32_vpermil2ps (v4sf,v4sf,v4si,int)
9317 v8sf __builtin_ia32_vpermil2ps256 (v8sf,v8sf,v8si,int)
9318 v2df __builtin_ia32_vpermilpd (v2df,int)
9319 v4df __builtin_ia32_vpermilpd256 (v4df,int)
9320 v4sf __builtin_ia32_vpermilps (v4sf,int)
9321 v8sf __builtin_ia32_vpermilps256 (v8sf,int)
9322 v2df __builtin_ia32_vpermilvarpd (v2df,v2di)
9323 v4df __builtin_ia32_vpermilvarpd256 (v4df,v4di)
9324 v4sf __builtin_ia32_vpermilvarps (v4sf,v4si)
9325 v8sf __builtin_ia32_vpermilvarps256 (v8sf,v8si)
9326 int __builtin_ia32_vtestcpd (v2df,v2df,ptest)
9327 int __builtin_ia32_vtestcpd256 (v4df,v4df,ptest)
9328 int __builtin_ia32_vtestcps (v4sf,v4sf,ptest)
9329 int __builtin_ia32_vtestcps256 (v8sf,v8sf,ptest)
9330 int __builtin_ia32_vtestnzcpd (v2df,v2df,ptest)
9331 int __builtin_ia32_vtestnzcpd256 (v4df,v4df,ptest)
9332 int __builtin_ia32_vtestnzcps (v4sf,v4sf,ptest)
9333 int __builtin_ia32_vtestnzcps256 (v8sf,v8sf,ptest)
9334 int __builtin_ia32_vtestzpd (v2df,v2df,ptest)
9335 int __builtin_ia32_vtestzpd256 (v4df,v4df,ptest)
9336 int __builtin_ia32_vtestzps (v4sf,v4sf,ptest)
9337 int __builtin_ia32_vtestzps256 (v8sf,v8sf,ptest)
9338 void __builtin_ia32_vzeroall (void)
9339 void __builtin_ia32_vzeroupper (void)
9340 v4df __builtin_ia32_xorpd256 (v4df,v4df)
9341 v8sf __builtin_ia32_xorps256 (v8sf,v8sf)
9342 @end smallexample
9343
9344 The following built-in functions are available when @option{-maes} is
9345 used.  All of them generate the machine instruction that is part of the
9346 name.
9347
9348 @smallexample
9349 v2di __builtin_ia32_aesenc128 (v2di, v2di)
9350 v2di __builtin_ia32_aesenclast128 (v2di, v2di)
9351 v2di __builtin_ia32_aesdec128 (v2di, v2di)
9352 v2di __builtin_ia32_aesdeclast128 (v2di, v2di)
9353 v2di __builtin_ia32_aeskeygenassist128 (v2di, const int)
9354 v2di __builtin_ia32_aesimc128 (v2di)
9355 @end smallexample
9356
9357 The following built-in function is available when @option{-mpclmul} is
9358 used.
9359
9360 @table @code
9361 @item v2di __builtin_ia32_pclmulqdq128 (v2di, v2di, const int)
9362 Generates the @code{pclmulqdq} machine instruction.
9363 @end table
9364
9365 The following built-in function is available when @option{-mfsgsbase} is
9366 used.  All of them generate the machine instruction that is part of the
9367 name.
9368
9369 @smallexample
9370 unsigned int __builtin_ia32_rdfsbase32 (void)
9371 unsigned long long __builtin_ia32_rdfsbase64 (void)
9372 unsigned int __builtin_ia32_rdgsbase32 (void)
9373 unsigned long long __builtin_ia32_rdgsbase64 (void)
9374 void _writefsbase_u32 (unsigned int)
9375 void _writefsbase_u64 (unsigned long long)
9376 void _writegsbase_u32 (unsigned int)
9377 void _writegsbase_u64 (unsigned long long)
9378 @end smallexample
9379
9380 The following built-in function is available when @option{-mrdrnd} is
9381 used.  All of them generate the machine instruction that is part of the
9382 name.
9383
9384 @smallexample
9385 unsigned int __builtin_ia32_rdrand16_step (unsigned short *)
9386 unsigned int __builtin_ia32_rdrand32_step (unsigned int *)
9387 unsigned int __builtin_ia32_rdrand64_step (unsigned long long *)
9388 @end smallexample
9389
9390 The following built-in functions are available when @option{-msse4a} is used.
9391 All of them generate the machine instruction that is part of the name.
9392
9393 @smallexample
9394 void __builtin_ia32_movntsd (double *, v2df)
9395 void __builtin_ia32_movntss (float *, v4sf)
9396 v2di __builtin_ia32_extrq  (v2di, v16qi)
9397 v2di __builtin_ia32_extrqi (v2di, const unsigned int, const unsigned int)
9398 v2di __builtin_ia32_insertq (v2di, v2di)
9399 v2di __builtin_ia32_insertqi (v2di, v2di, const unsigned int, const unsigned int)
9400 @end smallexample
9401
9402 The following built-in functions are available when @option{-mxop} is used.
9403 @smallexample
9404 v2df __builtin_ia32_vfrczpd (v2df)
9405 v4sf __builtin_ia32_vfrczps (v4sf)
9406 v2df __builtin_ia32_vfrczsd (v2df, v2df)
9407 v4sf __builtin_ia32_vfrczss (v4sf, v4sf)
9408 v4df __builtin_ia32_vfrczpd256 (v4df)
9409 v8sf __builtin_ia32_vfrczps256 (v8sf)
9410 v2di __builtin_ia32_vpcmov (v2di, v2di, v2di)
9411 v2di __builtin_ia32_vpcmov_v2di (v2di, v2di, v2di)
9412 v4si __builtin_ia32_vpcmov_v4si (v4si, v4si, v4si)
9413 v8hi __builtin_ia32_vpcmov_v8hi (v8hi, v8hi, v8hi)
9414 v16qi __builtin_ia32_vpcmov_v16qi (v16qi, v16qi, v16qi)
9415 v2df __builtin_ia32_vpcmov_v2df (v2df, v2df, v2df)
9416 v4sf __builtin_ia32_vpcmov_v4sf (v4sf, v4sf, v4sf)
9417 v4di __builtin_ia32_vpcmov_v4di256 (v4di, v4di, v4di)
9418 v8si __builtin_ia32_vpcmov_v8si256 (v8si, v8si, v8si)
9419 v16hi __builtin_ia32_vpcmov_v16hi256 (v16hi, v16hi, v16hi)
9420 v32qi __builtin_ia32_vpcmov_v32qi256 (v32qi, v32qi, v32qi)
9421 v4df __builtin_ia32_vpcmov_v4df256 (v4df, v4df, v4df)
9422 v8sf __builtin_ia32_vpcmov_v8sf256 (v8sf, v8sf, v8sf)
9423 v16qi __builtin_ia32_vpcomeqb (v16qi, v16qi)
9424 v8hi __builtin_ia32_vpcomeqw (v8hi, v8hi)
9425 v4si __builtin_ia32_vpcomeqd (v4si, v4si)
9426 v2di __builtin_ia32_vpcomeqq (v2di, v2di)
9427 v16qi __builtin_ia32_vpcomequb (v16qi, v16qi)
9428 v4si __builtin_ia32_vpcomequd (v4si, v4si)
9429 v2di __builtin_ia32_vpcomequq (v2di, v2di)
9430 v8hi __builtin_ia32_vpcomequw (v8hi, v8hi)
9431 v8hi __builtin_ia32_vpcomeqw (v8hi, v8hi)
9432 v16qi __builtin_ia32_vpcomfalseb (v16qi, v16qi)
9433 v4si __builtin_ia32_vpcomfalsed (v4si, v4si)
9434 v2di __builtin_ia32_vpcomfalseq (v2di, v2di)
9435 v16qi __builtin_ia32_vpcomfalseub (v16qi, v16qi)
9436 v4si __builtin_ia32_vpcomfalseud (v4si, v4si)
9437 v2di __builtin_ia32_vpcomfalseuq (v2di, v2di)
9438 v8hi __builtin_ia32_vpcomfalseuw (v8hi, v8hi)
9439 v8hi __builtin_ia32_vpcomfalsew (v8hi, v8hi)
9440 v16qi __builtin_ia32_vpcomgeb (v16qi, v16qi)
9441 v4si __builtin_ia32_vpcomged (v4si, v4si)
9442 v2di __builtin_ia32_vpcomgeq (v2di, v2di)
9443 v16qi __builtin_ia32_vpcomgeub (v16qi, v16qi)
9444 v4si __builtin_ia32_vpcomgeud (v4si, v4si)
9445 v2di __builtin_ia32_vpcomgeuq (v2di, v2di)
9446 v8hi __builtin_ia32_vpcomgeuw (v8hi, v8hi)
9447 v8hi __builtin_ia32_vpcomgew (v8hi, v8hi)
9448 v16qi __builtin_ia32_vpcomgtb (v16qi, v16qi)
9449 v4si __builtin_ia32_vpcomgtd (v4si, v4si)
9450 v2di __builtin_ia32_vpcomgtq (v2di, v2di)
9451 v16qi __builtin_ia32_vpcomgtub (v16qi, v16qi)
9452 v4si __builtin_ia32_vpcomgtud (v4si, v4si)
9453 v2di __builtin_ia32_vpcomgtuq (v2di, v2di)
9454 v8hi __builtin_ia32_vpcomgtuw (v8hi, v8hi)
9455 v8hi __builtin_ia32_vpcomgtw (v8hi, v8hi)
9456 v16qi __builtin_ia32_vpcomleb (v16qi, v16qi)
9457 v4si __builtin_ia32_vpcomled (v4si, v4si)
9458 v2di __builtin_ia32_vpcomleq (v2di, v2di)
9459 v16qi __builtin_ia32_vpcomleub (v16qi, v16qi)
9460 v4si __builtin_ia32_vpcomleud (v4si, v4si)
9461 v2di __builtin_ia32_vpcomleuq (v2di, v2di)
9462 v8hi __builtin_ia32_vpcomleuw (v8hi, v8hi)
9463 v8hi __builtin_ia32_vpcomlew (v8hi, v8hi)
9464 v16qi __builtin_ia32_vpcomltb (v16qi, v16qi)
9465 v4si __builtin_ia32_vpcomltd (v4si, v4si)
9466 v2di __builtin_ia32_vpcomltq (v2di, v2di)
9467 v16qi __builtin_ia32_vpcomltub (v16qi, v16qi)
9468 v4si __builtin_ia32_vpcomltud (v4si, v4si)
9469 v2di __builtin_ia32_vpcomltuq (v2di, v2di)
9470 v8hi __builtin_ia32_vpcomltuw (v8hi, v8hi)
9471 v8hi __builtin_ia32_vpcomltw (v8hi, v8hi)
9472 v16qi __builtin_ia32_vpcomneb (v16qi, v16qi)
9473 v4si __builtin_ia32_vpcomned (v4si, v4si)
9474 v2di __builtin_ia32_vpcomneq (v2di, v2di)
9475 v16qi __builtin_ia32_vpcomneub (v16qi, v16qi)
9476 v4si __builtin_ia32_vpcomneud (v4si, v4si)
9477 v2di __builtin_ia32_vpcomneuq (v2di, v2di)
9478 v8hi __builtin_ia32_vpcomneuw (v8hi, v8hi)
9479 v8hi __builtin_ia32_vpcomnew (v8hi, v8hi)
9480 v16qi __builtin_ia32_vpcomtrueb (v16qi, v16qi)
9481 v4si __builtin_ia32_vpcomtrued (v4si, v4si)
9482 v2di __builtin_ia32_vpcomtrueq (v2di, v2di)
9483 v16qi __builtin_ia32_vpcomtrueub (v16qi, v16qi)
9484 v4si __builtin_ia32_vpcomtrueud (v4si, v4si)
9485 v2di __builtin_ia32_vpcomtrueuq (v2di, v2di)
9486 v8hi __builtin_ia32_vpcomtrueuw (v8hi, v8hi)
9487 v8hi __builtin_ia32_vpcomtruew (v8hi, v8hi)
9488 v4si __builtin_ia32_vphaddbd (v16qi)
9489 v2di __builtin_ia32_vphaddbq (v16qi)
9490 v8hi __builtin_ia32_vphaddbw (v16qi)
9491 v2di __builtin_ia32_vphadddq (v4si)
9492 v4si __builtin_ia32_vphaddubd (v16qi)
9493 v2di __builtin_ia32_vphaddubq (v16qi)
9494 v8hi __builtin_ia32_vphaddubw (v16qi)
9495 v2di __builtin_ia32_vphaddudq (v4si)
9496 v4si __builtin_ia32_vphadduwd (v8hi)
9497 v2di __builtin_ia32_vphadduwq (v8hi)
9498 v4si __builtin_ia32_vphaddwd (v8hi)
9499 v2di __builtin_ia32_vphaddwq (v8hi)
9500 v8hi __builtin_ia32_vphsubbw (v16qi)
9501 v2di __builtin_ia32_vphsubdq (v4si)
9502 v4si __builtin_ia32_vphsubwd (v8hi)
9503 v4si __builtin_ia32_vpmacsdd (v4si, v4si, v4si)
9504 v2di __builtin_ia32_vpmacsdqh (v4si, v4si, v2di)
9505 v2di __builtin_ia32_vpmacsdql (v4si, v4si, v2di)
9506 v4si __builtin_ia32_vpmacssdd (v4si, v4si, v4si)
9507 v2di __builtin_ia32_vpmacssdqh (v4si, v4si, v2di)
9508 v2di __builtin_ia32_vpmacssdql (v4si, v4si, v2di)
9509 v4si __builtin_ia32_vpmacsswd (v8hi, v8hi, v4si)
9510 v8hi __builtin_ia32_vpmacssww (v8hi, v8hi, v8hi)
9511 v4si __builtin_ia32_vpmacswd (v8hi, v8hi, v4si)
9512 v8hi __builtin_ia32_vpmacsww (v8hi, v8hi, v8hi)
9513 v4si __builtin_ia32_vpmadcsswd (v8hi, v8hi, v4si)
9514 v4si __builtin_ia32_vpmadcswd (v8hi, v8hi, v4si)
9515 v16qi __builtin_ia32_vpperm (v16qi, v16qi, v16qi)
9516 v16qi __builtin_ia32_vprotb (v16qi, v16qi)
9517 v4si __builtin_ia32_vprotd (v4si, v4si)
9518 v2di __builtin_ia32_vprotq (v2di, v2di)
9519 v8hi __builtin_ia32_vprotw (v8hi, v8hi)
9520 v16qi __builtin_ia32_vpshab (v16qi, v16qi)
9521 v4si __builtin_ia32_vpshad (v4si, v4si)
9522 v2di __builtin_ia32_vpshaq (v2di, v2di)
9523 v8hi __builtin_ia32_vpshaw (v8hi, v8hi)
9524 v16qi __builtin_ia32_vpshlb (v16qi, v16qi)
9525 v4si __builtin_ia32_vpshld (v4si, v4si)
9526 v2di __builtin_ia32_vpshlq (v2di, v2di)
9527 v8hi __builtin_ia32_vpshlw (v8hi, v8hi)
9528 @end smallexample
9529
9530 The following built-in functions are available when @option{-mfma4} is used.
9531 All of them generate the machine instruction that is part of the name
9532 with MMX registers.
9533
9534 @smallexample
9535 v2df __builtin_ia32_fmaddpd (v2df, v2df, v2df)
9536 v4sf __builtin_ia32_fmaddps (v4sf, v4sf, v4sf)
9537 v2df __builtin_ia32_fmaddsd (v2df, v2df, v2df)
9538 v4sf __builtin_ia32_fmaddss (v4sf, v4sf, v4sf)
9539 v2df __builtin_ia32_fmsubpd (v2df, v2df, v2df)
9540 v4sf __builtin_ia32_fmsubps (v4sf, v4sf, v4sf)
9541 v2df __builtin_ia32_fmsubsd (v2df, v2df, v2df)
9542 v4sf __builtin_ia32_fmsubss (v4sf, v4sf, v4sf)
9543 v2df __builtin_ia32_fnmaddpd (v2df, v2df, v2df)
9544 v4sf __builtin_ia32_fnmaddps (v4sf, v4sf, v4sf)
9545 v2df __builtin_ia32_fnmaddsd (v2df, v2df, v2df)
9546 v4sf __builtin_ia32_fnmaddss (v4sf, v4sf, v4sf)
9547 v2df __builtin_ia32_fnmsubpd (v2df, v2df, v2df)
9548 v4sf __builtin_ia32_fnmsubps (v4sf, v4sf, v4sf)
9549 v2df __builtin_ia32_fnmsubsd (v2df, v2df, v2df)
9550 v4sf __builtin_ia32_fnmsubss (v4sf, v4sf, v4sf)
9551 v2df __builtin_ia32_fmaddsubpd  (v2df, v2df, v2df)
9552 v4sf __builtin_ia32_fmaddsubps  (v4sf, v4sf, v4sf)
9553 v2df __builtin_ia32_fmsubaddpd  (v2df, v2df, v2df)
9554 v4sf __builtin_ia32_fmsubaddps  (v4sf, v4sf, v4sf)
9555 v4df __builtin_ia32_fmaddpd256 (v4df, v4df, v4df)
9556 v8sf __builtin_ia32_fmaddps256 (v8sf, v8sf, v8sf)
9557 v4df __builtin_ia32_fmsubpd256 (v4df, v4df, v4df)
9558 v8sf __builtin_ia32_fmsubps256 (v8sf, v8sf, v8sf)
9559 v4df __builtin_ia32_fnmaddpd256 (v4df, v4df, v4df)
9560 v8sf __builtin_ia32_fnmaddps256 (v8sf, v8sf, v8sf)
9561 v4df __builtin_ia32_fnmsubpd256 (v4df, v4df, v4df)
9562 v8sf __builtin_ia32_fnmsubps256 (v8sf, v8sf, v8sf)
9563 v4df __builtin_ia32_fmaddsubpd256 (v4df, v4df, v4df)
9564 v8sf __builtin_ia32_fmaddsubps256 (v8sf, v8sf, v8sf)
9565 v4df __builtin_ia32_fmsubaddpd256 (v4df, v4df, v4df)
9566 v8sf __builtin_ia32_fmsubaddps256 (v8sf, v8sf, v8sf)
9567
9568 @end smallexample
9569
9570 The following built-in functions are available when @option{-mlwp} is used.
9571
9572 @smallexample
9573 void __builtin_ia32_llwpcb16 (void *);
9574 void __builtin_ia32_llwpcb32 (void *);
9575 void __builtin_ia32_llwpcb64 (void *);
9576 void * __builtin_ia32_llwpcb16 (void);
9577 void * __builtin_ia32_llwpcb32 (void);
9578 void * __builtin_ia32_llwpcb64 (void);
9579 void __builtin_ia32_lwpval16 (unsigned short, unsigned int, unsigned short)
9580 void __builtin_ia32_lwpval32 (unsigned int, unsigned int, unsigned int)
9581 void __builtin_ia32_lwpval64 (unsigned __int64, unsigned int, unsigned int)
9582 unsigned char __builtin_ia32_lwpins16 (unsigned short, unsigned int, unsigned short)
9583 unsigned char __builtin_ia32_lwpins32 (unsigned int, unsigned int, unsigned int)
9584 unsigned char __builtin_ia32_lwpins64 (unsigned __int64, unsigned int, unsigned int)
9585 @end smallexample
9586
9587 The following built-in functions are available when @option{-mbmi} is used.
9588 All of them generate the machine instruction that is part of the name.
9589 @smallexample
9590 unsigned int __builtin_ia32_bextr_u32(unsigned int, unsigned int);
9591 unsigned long long __builtin_ia32_bextr_u64 (unsigned long long, unsigned long long);
9592 unsigned short __builtin_ia32_lzcnt_16(unsigned short);
9593 unsigned int __builtin_ia32_lzcnt_u32(unsigned int);
9594 unsigned long long __builtin_ia32_lzcnt_u64 (unsigned long long);
9595 @end smallexample
9596
9597 The following built-in functions are available when @option{-mtbm} is used.
9598 Both of them generate the immediate form of the bextr machine instruction.
9599 @smallexample
9600 unsigned int __builtin_ia32_bextri_u32 (unsigned int, const unsigned int);
9601 unsigned long long __builtin_ia32_bextri_u64 (unsigned long long, const unsigned long long);
9602 @end smallexample
9603
9604
9605 The following built-in functions are available when @option{-m3dnow} is used.
9606 All of them generate the machine instruction that is part of the name.
9607
9608 @smallexample
9609 void __builtin_ia32_femms (void)
9610 v8qi __builtin_ia32_pavgusb (v8qi, v8qi)
9611 v2si __builtin_ia32_pf2id (v2sf)
9612 v2sf __builtin_ia32_pfacc (v2sf, v2sf)
9613 v2sf __builtin_ia32_pfadd (v2sf, v2sf)
9614 v2si __builtin_ia32_pfcmpeq (v2sf, v2sf)
9615 v2si __builtin_ia32_pfcmpge (v2sf, v2sf)
9616 v2si __builtin_ia32_pfcmpgt (v2sf, v2sf)
9617 v2sf __builtin_ia32_pfmax (v2sf, v2sf)
9618 v2sf __builtin_ia32_pfmin (v2sf, v2sf)
9619 v2sf __builtin_ia32_pfmul (v2sf, v2sf)
9620 v2sf __builtin_ia32_pfrcp (v2sf)
9621 v2sf __builtin_ia32_pfrcpit1 (v2sf, v2sf)
9622 v2sf __builtin_ia32_pfrcpit2 (v2sf, v2sf)
9623 v2sf __builtin_ia32_pfrsqrt (v2sf)
9624 v2sf __builtin_ia32_pfrsqrtit1 (v2sf, v2sf)
9625 v2sf __builtin_ia32_pfsub (v2sf, v2sf)
9626 v2sf __builtin_ia32_pfsubr (v2sf, v2sf)
9627 v2sf __builtin_ia32_pi2fd (v2si)
9628 v4hi __builtin_ia32_pmulhrw (v4hi, v4hi)
9629 @end smallexample
9630
9631 The following built-in functions are available when both @option{-m3dnow}
9632 and @option{-march=athlon} are used.  All of them generate the machine
9633 instruction that is part of the name.
9634
9635 @smallexample
9636 v2si __builtin_ia32_pf2iw (v2sf)
9637 v2sf __builtin_ia32_pfnacc (v2sf, v2sf)
9638 v2sf __builtin_ia32_pfpnacc (v2sf, v2sf)
9639 v2sf __builtin_ia32_pi2fw (v2si)
9640 v2sf __builtin_ia32_pswapdsf (v2sf)
9641 v2si __builtin_ia32_pswapdsi (v2si)
9642 @end smallexample
9643
9644 @node MIPS DSP Built-in Functions
9645 @subsection MIPS DSP Built-in Functions
9646
9647 The MIPS DSP Application-Specific Extension (ASE) includes new
9648 instructions that are designed to improve the performance of DSP and
9649 media applications.  It provides instructions that operate on packed
9650 8-bit/16-bit integer data, Q7, Q15 and Q31 fractional data.
9651
9652 GCC supports MIPS DSP operations using both the generic
9653 vector extensions (@pxref{Vector Extensions}) and a collection of
9654 MIPS-specific built-in functions.  Both kinds of support are
9655 enabled by the @option{-mdsp} command-line option.
9656
9657 Revision 2 of the ASE was introduced in the second half of 2006.
9658 This revision adds extra instructions to the original ASE, but is
9659 otherwise backwards-compatible with it.  You can select revision 2
9660 using the command-line option @option{-mdspr2}; this option implies
9661 @option{-mdsp}.
9662
9663 The SCOUNT and POS bits of the DSP control register are global.  The
9664 WRDSP, EXTPDP, EXTPDPV and MTHLIP instructions modify the SCOUNT and
9665 POS bits.  During optimization, the compiler will not delete these
9666 instructions and it will not delete calls to functions containing
9667 these instructions.
9668
9669 At present, GCC only provides support for operations on 32-bit
9670 vectors.  The vector type associated with 8-bit integer data is
9671 usually called @code{v4i8}, the vector type associated with Q7
9672 is usually called @code{v4q7}, the vector type associated with 16-bit
9673 integer data is usually called @code{v2i16}, and the vector type
9674 associated with Q15 is usually called @code{v2q15}.  They can be
9675 defined in C as follows:
9676
9677 @smallexample
9678 typedef signed char v4i8 __attribute__ ((vector_size(4)));
9679 typedef signed char v4q7 __attribute__ ((vector_size(4)));
9680 typedef short v2i16 __attribute__ ((vector_size(4)));
9681 typedef short v2q15 __attribute__ ((vector_size(4)));
9682 @end smallexample
9683
9684 @code{v4i8}, @code{v4q7}, @code{v2i16} and @code{v2q15} values are
9685 initialized in the same way as aggregates.  For example:
9686
9687 @smallexample
9688 v4i8 a = @{1, 2, 3, 4@};
9689 v4i8 b;
9690 b = (v4i8) @{5, 6, 7, 8@};
9691
9692 v2q15 c = @{0x0fcb, 0x3a75@};
9693 v2q15 d;
9694 d = (v2q15) @{0.1234 * 0x1.0p15, 0.4567 * 0x1.0p15@};
9695 @end smallexample
9696
9697 @emph{Note:} The CPU's endianness determines the order in which values
9698 are packed.  On little-endian targets, the first value is the least
9699 significant and the last value is the most significant.  The opposite
9700 order applies to big-endian targets.  For example, the code above will
9701 set the lowest byte of @code{a} to @code{1} on little-endian targets
9702 and @code{4} on big-endian targets.
9703
9704 @emph{Note:} Q7, Q15 and Q31 values must be initialized with their integer
9705 representation.  As shown in this example, the integer representation
9706 of a Q7 value can be obtained by multiplying the fractional value by
9707 @code{0x1.0p7}.  The equivalent for Q15 values is to multiply by
9708 @code{0x1.0p15}.  The equivalent for Q31 values is to multiply by
9709 @code{0x1.0p31}.
9710
9711 The table below lists the @code{v4i8} and @code{v2q15} operations for which
9712 hardware support exists.  @code{a} and @code{b} are @code{v4i8} values,
9713 and @code{c} and @code{d} are @code{v2q15} values.
9714
9715 @multitable @columnfractions .50 .50
9716 @item C code @tab MIPS instruction
9717 @item @code{a + b} @tab @code{addu.qb}
9718 @item @code{c + d} @tab @code{addq.ph}
9719 @item @code{a - b} @tab @code{subu.qb}
9720 @item @code{c - d} @tab @code{subq.ph}
9721 @end multitable
9722
9723 The table below lists the @code{v2i16} operation for which
9724 hardware support exists for the DSP ASE REV 2.  @code{e} and @code{f} are
9725 @code{v2i16} values.
9726
9727 @multitable @columnfractions .50 .50
9728 @item C code @tab MIPS instruction
9729 @item @code{e * f} @tab @code{mul.ph}
9730 @end multitable
9731
9732 It is easier to describe the DSP built-in functions if we first define
9733 the following types:
9734
9735 @smallexample
9736 typedef int q31;
9737 typedef int i32;
9738 typedef unsigned int ui32;
9739 typedef long long a64;
9740 @end smallexample
9741
9742 @code{q31} and @code{i32} are actually the same as @code{int}, but we
9743 use @code{q31} to indicate a Q31 fractional value and @code{i32} to
9744 indicate a 32-bit integer value.  Similarly, @code{a64} is the same as
9745 @code{long long}, but we use @code{a64} to indicate values that will
9746 be placed in one of the four DSP accumulators (@code{$ac0},
9747 @code{$ac1}, @code{$ac2} or @code{$ac3}).
9748
9749 Also, some built-in functions prefer or require immediate numbers as
9750 parameters, because the corresponding DSP instructions accept both immediate
9751 numbers and register operands, or accept immediate numbers only.  The
9752 immediate parameters are listed as follows.
9753
9754 @smallexample
9755 imm0_3: 0 to 3.
9756 imm0_7: 0 to 7.
9757 imm0_15: 0 to 15.
9758 imm0_31: 0 to 31.
9759 imm0_63: 0 to 63.
9760 imm0_255: 0 to 255.
9761 imm_n32_31: -32 to 31.
9762 imm_n512_511: -512 to 511.
9763 @end smallexample
9764
9765 The following built-in functions map directly to a particular MIPS DSP
9766 instruction.  Please refer to the architecture specification
9767 for details on what each instruction does.
9768
9769 @smallexample
9770 v2q15 __builtin_mips_addq_ph (v2q15, v2q15)
9771 v2q15 __builtin_mips_addq_s_ph (v2q15, v2q15)
9772 q31 __builtin_mips_addq_s_w (q31, q31)
9773 v4i8 __builtin_mips_addu_qb (v4i8, v4i8)
9774 v4i8 __builtin_mips_addu_s_qb (v4i8, v4i8)
9775 v2q15 __builtin_mips_subq_ph (v2q15, v2q15)
9776 v2q15 __builtin_mips_subq_s_ph (v2q15, v2q15)
9777 q31 __builtin_mips_subq_s_w (q31, q31)
9778 v4i8 __builtin_mips_subu_qb (v4i8, v4i8)
9779 v4i8 __builtin_mips_subu_s_qb (v4i8, v4i8)
9780 i32 __builtin_mips_addsc (i32, i32)
9781 i32 __builtin_mips_addwc (i32, i32)
9782 i32 __builtin_mips_modsub (i32, i32)
9783 i32 __builtin_mips_raddu_w_qb (v4i8)
9784 v2q15 __builtin_mips_absq_s_ph (v2q15)
9785 q31 __builtin_mips_absq_s_w (q31)
9786 v4i8 __builtin_mips_precrq_qb_ph (v2q15, v2q15)
9787 v2q15 __builtin_mips_precrq_ph_w (q31, q31)
9788 v2q15 __builtin_mips_precrq_rs_ph_w (q31, q31)
9789 v4i8 __builtin_mips_precrqu_s_qb_ph (v2q15, v2q15)
9790 q31 __builtin_mips_preceq_w_phl (v2q15)
9791 q31 __builtin_mips_preceq_w_phr (v2q15)
9792 v2q15 __builtin_mips_precequ_ph_qbl (v4i8)
9793 v2q15 __builtin_mips_precequ_ph_qbr (v4i8)
9794 v2q15 __builtin_mips_precequ_ph_qbla (v4i8)
9795 v2q15 __builtin_mips_precequ_ph_qbra (v4i8)
9796 v2q15 __builtin_mips_preceu_ph_qbl (v4i8)
9797 v2q15 __builtin_mips_preceu_ph_qbr (v4i8)
9798 v2q15 __builtin_mips_preceu_ph_qbla (v4i8)
9799 v2q15 __builtin_mips_preceu_ph_qbra (v4i8)
9800 v4i8 __builtin_mips_shll_qb (v4i8, imm0_7)
9801 v4i8 __builtin_mips_shll_qb (v4i8, i32)
9802 v2q15 __builtin_mips_shll_ph (v2q15, imm0_15)
9803 v2q15 __builtin_mips_shll_ph (v2q15, i32)
9804 v2q15 __builtin_mips_shll_s_ph (v2q15, imm0_15)
9805 v2q15 __builtin_mips_shll_s_ph (v2q15, i32)
9806 q31 __builtin_mips_shll_s_w (q31, imm0_31)
9807 q31 __builtin_mips_shll_s_w (q31, i32)
9808 v4i8 __builtin_mips_shrl_qb (v4i8, imm0_7)
9809 v4i8 __builtin_mips_shrl_qb (v4i8, i32)
9810 v2q15 __builtin_mips_shra_ph (v2q15, imm0_15)
9811 v2q15 __builtin_mips_shra_ph (v2q15, i32)
9812 v2q15 __builtin_mips_shra_r_ph (v2q15, imm0_15)
9813 v2q15 __builtin_mips_shra_r_ph (v2q15, i32)
9814 q31 __builtin_mips_shra_r_w (q31, imm0_31)
9815 q31 __builtin_mips_shra_r_w (q31, i32)
9816 v2q15 __builtin_mips_muleu_s_ph_qbl (v4i8, v2q15)
9817 v2q15 __builtin_mips_muleu_s_ph_qbr (v4i8, v2q15)
9818 v2q15 __builtin_mips_mulq_rs_ph (v2q15, v2q15)
9819 q31 __builtin_mips_muleq_s_w_phl (v2q15, v2q15)
9820 q31 __builtin_mips_muleq_s_w_phr (v2q15, v2q15)
9821 a64 __builtin_mips_dpau_h_qbl (a64, v4i8, v4i8)
9822 a64 __builtin_mips_dpau_h_qbr (a64, v4i8, v4i8)
9823 a64 __builtin_mips_dpsu_h_qbl (a64, v4i8, v4i8)
9824 a64 __builtin_mips_dpsu_h_qbr (a64, v4i8, v4i8)
9825 a64 __builtin_mips_dpaq_s_w_ph (a64, v2q15, v2q15)
9826 a64 __builtin_mips_dpaq_sa_l_w (a64, q31, q31)
9827 a64 __builtin_mips_dpsq_s_w_ph (a64, v2q15, v2q15)
9828 a64 __builtin_mips_dpsq_sa_l_w (a64, q31, q31)
9829 a64 __builtin_mips_mulsaq_s_w_ph (a64, v2q15, v2q15)
9830 a64 __builtin_mips_maq_s_w_phl (a64, v2q15, v2q15)
9831 a64 __builtin_mips_maq_s_w_phr (a64, v2q15, v2q15)
9832 a64 __builtin_mips_maq_sa_w_phl (a64, v2q15, v2q15)
9833 a64 __builtin_mips_maq_sa_w_phr (a64, v2q15, v2q15)
9834 i32 __builtin_mips_bitrev (i32)
9835 i32 __builtin_mips_insv (i32, i32)
9836 v4i8 __builtin_mips_repl_qb (imm0_255)
9837 v4i8 __builtin_mips_repl_qb (i32)
9838 v2q15 __builtin_mips_repl_ph (imm_n512_511)
9839 v2q15 __builtin_mips_repl_ph (i32)
9840 void __builtin_mips_cmpu_eq_qb (v4i8, v4i8)
9841 void __builtin_mips_cmpu_lt_qb (v4i8, v4i8)
9842 void __builtin_mips_cmpu_le_qb (v4i8, v4i8)
9843 i32 __builtin_mips_cmpgu_eq_qb (v4i8, v4i8)
9844 i32 __builtin_mips_cmpgu_lt_qb (v4i8, v4i8)
9845 i32 __builtin_mips_cmpgu_le_qb (v4i8, v4i8)
9846 void __builtin_mips_cmp_eq_ph (v2q15, v2q15)
9847 void __builtin_mips_cmp_lt_ph (v2q15, v2q15)
9848 void __builtin_mips_cmp_le_ph (v2q15, v2q15)
9849 v4i8 __builtin_mips_pick_qb (v4i8, v4i8)
9850 v2q15 __builtin_mips_pick_ph (v2q15, v2q15)
9851 v2q15 __builtin_mips_packrl_ph (v2q15, v2q15)
9852 i32 __builtin_mips_extr_w (a64, imm0_31)
9853 i32 __builtin_mips_extr_w (a64, i32)
9854 i32 __builtin_mips_extr_r_w (a64, imm0_31)
9855 i32 __builtin_mips_extr_s_h (a64, i32)
9856 i32 __builtin_mips_extr_rs_w (a64, imm0_31)
9857 i32 __builtin_mips_extr_rs_w (a64, i32)
9858 i32 __builtin_mips_extr_s_h (a64, imm0_31)
9859 i32 __builtin_mips_extr_r_w (a64, i32)
9860 i32 __builtin_mips_extp (a64, imm0_31)
9861 i32 __builtin_mips_extp (a64, i32)
9862 i32 __builtin_mips_extpdp (a64, imm0_31)
9863 i32 __builtin_mips_extpdp (a64, i32)
9864 a64 __builtin_mips_shilo (a64, imm_n32_31)
9865 a64 __builtin_mips_shilo (a64, i32)
9866 a64 __builtin_mips_mthlip (a64, i32)
9867 void __builtin_mips_wrdsp (i32, imm0_63)
9868 i32 __builtin_mips_rddsp (imm0_63)
9869 i32 __builtin_mips_lbux (void *, i32)
9870 i32 __builtin_mips_lhx (void *, i32)
9871 i32 __builtin_mips_lwx (void *, i32)
9872 i32 __builtin_mips_bposge32 (void)
9873 a64 __builtin_mips_madd (a64, i32, i32);
9874 a64 __builtin_mips_maddu (a64, ui32, ui32);
9875 a64 __builtin_mips_msub (a64, i32, i32);
9876 a64 __builtin_mips_msubu (a64, ui32, ui32);
9877 a64 __builtin_mips_mult (i32, i32);
9878 a64 __builtin_mips_multu (ui32, ui32);
9879 @end smallexample
9880
9881 The following built-in functions map directly to a particular MIPS DSP REV 2
9882 instruction.  Please refer to the architecture specification
9883 for details on what each instruction does.
9884
9885 @smallexample
9886 v4q7 __builtin_mips_absq_s_qb (v4q7);
9887 v2i16 __builtin_mips_addu_ph (v2i16, v2i16);
9888 v2i16 __builtin_mips_addu_s_ph (v2i16, v2i16);
9889 v4i8 __builtin_mips_adduh_qb (v4i8, v4i8);
9890 v4i8 __builtin_mips_adduh_r_qb (v4i8, v4i8);
9891 i32 __builtin_mips_append (i32, i32, imm0_31);
9892 i32 __builtin_mips_balign (i32, i32, imm0_3);
9893 i32 __builtin_mips_cmpgdu_eq_qb (v4i8, v4i8);
9894 i32 __builtin_mips_cmpgdu_lt_qb (v4i8, v4i8);
9895 i32 __builtin_mips_cmpgdu_le_qb (v4i8, v4i8);
9896 a64 __builtin_mips_dpa_w_ph (a64, v2i16, v2i16);
9897 a64 __builtin_mips_dps_w_ph (a64, v2i16, v2i16);
9898 v2i16 __builtin_mips_mul_ph (v2i16, v2i16);
9899 v2i16 __builtin_mips_mul_s_ph (v2i16, v2i16);
9900 q31 __builtin_mips_mulq_rs_w (q31, q31);
9901 v2q15 __builtin_mips_mulq_s_ph (v2q15, v2q15);
9902 q31 __builtin_mips_mulq_s_w (q31, q31);
9903 a64 __builtin_mips_mulsa_w_ph (a64, v2i16, v2i16);
9904 v4i8 __builtin_mips_precr_qb_ph (v2i16, v2i16);
9905 v2i16 __builtin_mips_precr_sra_ph_w (i32, i32, imm0_31);
9906 v2i16 __builtin_mips_precr_sra_r_ph_w (i32, i32, imm0_31);
9907 i32 __builtin_mips_prepend (i32, i32, imm0_31);
9908 v4i8 __builtin_mips_shra_qb (v4i8, imm0_7);
9909 v4i8 __builtin_mips_shra_r_qb (v4i8, imm0_7);
9910 v4i8 __builtin_mips_shra_qb (v4i8, i32);
9911 v4i8 __builtin_mips_shra_r_qb (v4i8, i32);
9912 v2i16 __builtin_mips_shrl_ph (v2i16, imm0_15);
9913 v2i16 __builtin_mips_shrl_ph (v2i16, i32);
9914 v2i16 __builtin_mips_subu_ph (v2i16, v2i16);
9915 v2i16 __builtin_mips_subu_s_ph (v2i16, v2i16);
9916 v4i8 __builtin_mips_subuh_qb (v4i8, v4i8);
9917 v4i8 __builtin_mips_subuh_r_qb (v4i8, v4i8);
9918 v2q15 __builtin_mips_addqh_ph (v2q15, v2q15);
9919 v2q15 __builtin_mips_addqh_r_ph (v2q15, v2q15);
9920 q31 __builtin_mips_addqh_w (q31, q31);
9921 q31 __builtin_mips_addqh_r_w (q31, q31);
9922 v2q15 __builtin_mips_subqh_ph (v2q15, v2q15);
9923 v2q15 __builtin_mips_subqh_r_ph (v2q15, v2q15);
9924 q31 __builtin_mips_subqh_w (q31, q31);
9925 q31 __builtin_mips_subqh_r_w (q31, q31);
9926 a64 __builtin_mips_dpax_w_ph (a64, v2i16, v2i16);
9927 a64 __builtin_mips_dpsx_w_ph (a64, v2i16, v2i16);
9928 a64 __builtin_mips_dpaqx_s_w_ph (a64, v2q15, v2q15);
9929 a64 __builtin_mips_dpaqx_sa_w_ph (a64, v2q15, v2q15);
9930 a64 __builtin_mips_dpsqx_s_w_ph (a64, v2q15, v2q15);
9931 a64 __builtin_mips_dpsqx_sa_w_ph (a64, v2q15, v2q15);
9932 @end smallexample
9933
9934
9935 @node MIPS Paired-Single Support
9936 @subsection MIPS Paired-Single Support
9937
9938 The MIPS64 architecture includes a number of instructions that
9939 operate on pairs of single-precision floating-point values.
9940 Each pair is packed into a 64-bit floating-point register,
9941 with one element being designated the ``upper half'' and
9942 the other being designated the ``lower half''.
9943
9944 GCC supports paired-single operations using both the generic
9945 vector extensions (@pxref{Vector Extensions}) and a collection of
9946 MIPS-specific built-in functions.  Both kinds of support are
9947 enabled by the @option{-mpaired-single} command-line option.
9948
9949 The vector type associated with paired-single values is usually
9950 called @code{v2sf}.  It can be defined in C as follows:
9951
9952 @smallexample
9953 typedef float v2sf __attribute__ ((vector_size (8)));
9954 @end smallexample
9955
9956 @code{v2sf} values are initialized in the same way as aggregates.
9957 For example:
9958
9959 @smallexample
9960 v2sf a = @{1.5, 9.1@};
9961 v2sf b;
9962 float e, f;
9963 b = (v2sf) @{e, f@};
9964 @end smallexample
9965
9966 @emph{Note:} The CPU's endianness determines which value is stored in
9967 the upper half of a register and which value is stored in the lower half.
9968 On little-endian targets, the first value is the lower one and the second
9969 value is the upper one.  The opposite order applies to big-endian targets.
9970 For example, the code above will set the lower half of @code{a} to
9971 @code{1.5} on little-endian targets and @code{9.1} on big-endian targets.
9972
9973 @node MIPS Loongson Built-in Functions
9974 @subsection MIPS Loongson Built-in Functions
9975
9976 GCC provides intrinsics to access the SIMD instructions provided by the
9977 ST Microelectronics Loongson-2E and -2F processors.  These intrinsics,
9978 available after inclusion of the @code{loongson.h} header file,
9979 operate on the following 64-bit vector types:
9980
9981 @itemize
9982 @item @code{uint8x8_t}, a vector of eight unsigned 8-bit integers;
9983 @item @code{uint16x4_t}, a vector of four unsigned 16-bit integers;
9984 @item @code{uint32x2_t}, a vector of two unsigned 32-bit integers;
9985 @item @code{int8x8_t}, a vector of eight signed 8-bit integers;
9986 @item @code{int16x4_t}, a vector of four signed 16-bit integers;
9987 @item @code{int32x2_t}, a vector of two signed 32-bit integers.
9988 @end itemize
9989
9990 The intrinsics provided are listed below; each is named after the
9991 machine instruction to which it corresponds, with suffixes added as
9992 appropriate to distinguish intrinsics that expand to the same machine
9993 instruction yet have different argument types.  Refer to the architecture
9994 documentation for a description of the functionality of each
9995 instruction.
9996
9997 @smallexample
9998 int16x4_t packsswh (int32x2_t s, int32x2_t t);
9999 int8x8_t packsshb (int16x4_t s, int16x4_t t);
10000 uint8x8_t packushb (uint16x4_t s, uint16x4_t t);
10001 uint32x2_t paddw_u (uint32x2_t s, uint32x2_t t);
10002 uint16x4_t paddh_u (uint16x4_t s, uint16x4_t t);
10003 uint8x8_t paddb_u (uint8x8_t s, uint8x8_t t);
10004 int32x2_t paddw_s (int32x2_t s, int32x2_t t);
10005 int16x4_t paddh_s (int16x4_t s, int16x4_t t);
10006 int8x8_t paddb_s (int8x8_t s, int8x8_t t);
10007 uint64_t paddd_u (uint64_t s, uint64_t t);
10008 int64_t paddd_s (int64_t s, int64_t t);
10009 int16x4_t paddsh (int16x4_t s, int16x4_t t);
10010 int8x8_t paddsb (int8x8_t s, int8x8_t t);
10011 uint16x4_t paddush (uint16x4_t s, uint16x4_t t);
10012 uint8x8_t paddusb (uint8x8_t s, uint8x8_t t);
10013 uint64_t pandn_ud (uint64_t s, uint64_t t);
10014 uint32x2_t pandn_uw (uint32x2_t s, uint32x2_t t);
10015 uint16x4_t pandn_uh (uint16x4_t s, uint16x4_t t);
10016 uint8x8_t pandn_ub (uint8x8_t s, uint8x8_t t);
10017 int64_t pandn_sd (int64_t s, int64_t t);
10018 int32x2_t pandn_sw (int32x2_t s, int32x2_t t);
10019 int16x4_t pandn_sh (int16x4_t s, int16x4_t t);
10020 int8x8_t pandn_sb (int8x8_t s, int8x8_t t);
10021 uint16x4_t pavgh (uint16x4_t s, uint16x4_t t);
10022 uint8x8_t pavgb (uint8x8_t s, uint8x8_t t);
10023 uint32x2_t pcmpeqw_u (uint32x2_t s, uint32x2_t t);
10024 uint16x4_t pcmpeqh_u (uint16x4_t s, uint16x4_t t);
10025 uint8x8_t pcmpeqb_u (uint8x8_t s, uint8x8_t t);
10026 int32x2_t pcmpeqw_s (int32x2_t s, int32x2_t t);
10027 int16x4_t pcmpeqh_s (int16x4_t s, int16x4_t t);
10028 int8x8_t pcmpeqb_s (int8x8_t s, int8x8_t t);
10029 uint32x2_t pcmpgtw_u (uint32x2_t s, uint32x2_t t);
10030 uint16x4_t pcmpgth_u (uint16x4_t s, uint16x4_t t);
10031 uint8x8_t pcmpgtb_u (uint8x8_t s, uint8x8_t t);
10032 int32x2_t pcmpgtw_s (int32x2_t s, int32x2_t t);
10033 int16x4_t pcmpgth_s (int16x4_t s, int16x4_t t);
10034 int8x8_t pcmpgtb_s (int8x8_t s, int8x8_t t);
10035 uint16x4_t pextrh_u (uint16x4_t s, int field);
10036 int16x4_t pextrh_s (int16x4_t s, int field);
10037 uint16x4_t pinsrh_0_u (uint16x4_t s, uint16x4_t t);
10038 uint16x4_t pinsrh_1_u (uint16x4_t s, uint16x4_t t);
10039 uint16x4_t pinsrh_2_u (uint16x4_t s, uint16x4_t t);
10040 uint16x4_t pinsrh_3_u (uint16x4_t s, uint16x4_t t);
10041 int16x4_t pinsrh_0_s (int16x4_t s, int16x4_t t);
10042 int16x4_t pinsrh_1_s (int16x4_t s, int16x4_t t);
10043 int16x4_t pinsrh_2_s (int16x4_t s, int16x4_t t);
10044 int16x4_t pinsrh_3_s (int16x4_t s, int16x4_t t);
10045 int32x2_t pmaddhw (int16x4_t s, int16x4_t t);
10046 int16x4_t pmaxsh (int16x4_t s, int16x4_t t);
10047 uint8x8_t pmaxub (uint8x8_t s, uint8x8_t t);
10048 int16x4_t pminsh (int16x4_t s, int16x4_t t);
10049 uint8x8_t pminub (uint8x8_t s, uint8x8_t t);
10050 uint8x8_t pmovmskb_u (uint8x8_t s);
10051 int8x8_t pmovmskb_s (int8x8_t s);
10052 uint16x4_t pmulhuh (uint16x4_t s, uint16x4_t t);
10053 int16x4_t pmulhh (int16x4_t s, int16x4_t t);
10054 int16x4_t pmullh (int16x4_t s, int16x4_t t);
10055 int64_t pmuluw (uint32x2_t s, uint32x2_t t);
10056 uint8x8_t pasubub (uint8x8_t s, uint8x8_t t);
10057 uint16x4_t biadd (uint8x8_t s);
10058 uint16x4_t psadbh (uint8x8_t s, uint8x8_t t);
10059 uint16x4_t pshufh_u (uint16x4_t dest, uint16x4_t s, uint8_t order);
10060 int16x4_t pshufh_s (int16x4_t dest, int16x4_t s, uint8_t order);
10061 uint16x4_t psllh_u (uint16x4_t s, uint8_t amount);
10062 int16x4_t psllh_s (int16x4_t s, uint8_t amount);
10063 uint32x2_t psllw_u (uint32x2_t s, uint8_t amount);
10064 int32x2_t psllw_s (int32x2_t s, uint8_t amount);
10065 uint16x4_t psrlh_u (uint16x4_t s, uint8_t amount);
10066 int16x4_t psrlh_s (int16x4_t s, uint8_t amount);
10067 uint32x2_t psrlw_u (uint32x2_t s, uint8_t amount);
10068 int32x2_t psrlw_s (int32x2_t s, uint8_t amount);
10069 uint16x4_t psrah_u (uint16x4_t s, uint8_t amount);
10070 int16x4_t psrah_s (int16x4_t s, uint8_t amount);
10071 uint32x2_t psraw_u (uint32x2_t s, uint8_t amount);
10072 int32x2_t psraw_s (int32x2_t s, uint8_t amount);
10073 uint32x2_t psubw_u (uint32x2_t s, uint32x2_t t);
10074 uint16x4_t psubh_u (uint16x4_t s, uint16x4_t t);
10075 uint8x8_t psubb_u (uint8x8_t s, uint8x8_t t);
10076 int32x2_t psubw_s (int32x2_t s, int32x2_t t);
10077 int16x4_t psubh_s (int16x4_t s, int16x4_t t);
10078 int8x8_t psubb_s (int8x8_t s, int8x8_t t);
10079 uint64_t psubd_u (uint64_t s, uint64_t t);
10080 int64_t psubd_s (int64_t s, int64_t t);
10081 int16x4_t psubsh (int16x4_t s, int16x4_t t);
10082 int8x8_t psubsb (int8x8_t s, int8x8_t t);
10083 uint16x4_t psubush (uint16x4_t s, uint16x4_t t);
10084 uint8x8_t psubusb (uint8x8_t s, uint8x8_t t);
10085 uint32x2_t punpckhwd_u (uint32x2_t s, uint32x2_t t);
10086 uint16x4_t punpckhhw_u (uint16x4_t s, uint16x4_t t);
10087 uint8x8_t punpckhbh_u (uint8x8_t s, uint8x8_t t);
10088 int32x2_t punpckhwd_s (int32x2_t s, int32x2_t t);
10089 int16x4_t punpckhhw_s (int16x4_t s, int16x4_t t);
10090 int8x8_t punpckhbh_s (int8x8_t s, int8x8_t t);
10091 uint32x2_t punpcklwd_u (uint32x2_t s, uint32x2_t t);
10092 uint16x4_t punpcklhw_u (uint16x4_t s, uint16x4_t t);
10093 uint8x8_t punpcklbh_u (uint8x8_t s, uint8x8_t t);
10094 int32x2_t punpcklwd_s (int32x2_t s, int32x2_t t);
10095 int16x4_t punpcklhw_s (int16x4_t s, int16x4_t t);
10096 int8x8_t punpcklbh_s (int8x8_t s, int8x8_t t);
10097 @end smallexample
10098
10099 @menu
10100 * Paired-Single Arithmetic::
10101 * Paired-Single Built-in Functions::
10102 * MIPS-3D Built-in Functions::
10103 @end menu
10104
10105 @node Paired-Single Arithmetic
10106 @subsubsection Paired-Single Arithmetic
10107
10108 The table below lists the @code{v2sf} operations for which hardware
10109 support exists.  @code{a}, @code{b} and @code{c} are @code{v2sf}
10110 values and @code{x} is an integral value.
10111
10112 @multitable @columnfractions .50 .50
10113 @item C code @tab MIPS instruction
10114 @item @code{a + b} @tab @code{add.ps}
10115 @item @code{a - b} @tab @code{sub.ps}
10116 @item @code{-a} @tab @code{neg.ps}
10117 @item @code{a * b} @tab @code{mul.ps}
10118 @item @code{a * b + c} @tab @code{madd.ps}
10119 @item @code{a * b - c} @tab @code{msub.ps}
10120 @item @code{-(a * b + c)} @tab @code{nmadd.ps}
10121 @item @code{-(a * b - c)} @tab @code{nmsub.ps}
10122 @item @code{x ? a : b} @tab @code{movn.ps}/@code{movz.ps}
10123 @end multitable
10124
10125 Note that the multiply-accumulate instructions can be disabled
10126 using the command-line option @code{-mno-fused-madd}.
10127
10128 @node Paired-Single Built-in Functions
10129 @subsubsection Paired-Single Built-in Functions
10130
10131 The following paired-single functions map directly to a particular
10132 MIPS instruction.  Please refer to the architecture specification
10133 for details on what each instruction does.
10134
10135 @table @code
10136 @item v2sf __builtin_mips_pll_ps (v2sf, v2sf)
10137 Pair lower lower (@code{pll.ps}).
10138
10139 @item v2sf __builtin_mips_pul_ps (v2sf, v2sf)
10140 Pair upper lower (@code{pul.ps}).
10141
10142 @item v2sf __builtin_mips_plu_ps (v2sf, v2sf)
10143 Pair lower upper (@code{plu.ps}).
10144
10145 @item v2sf __builtin_mips_puu_ps (v2sf, v2sf)
10146 Pair upper upper (@code{puu.ps}).
10147
10148 @item v2sf __builtin_mips_cvt_ps_s (float, float)
10149 Convert pair to paired single (@code{cvt.ps.s}).
10150
10151 @item float __builtin_mips_cvt_s_pl (v2sf)
10152 Convert pair lower to single (@code{cvt.s.pl}).
10153
10154 @item float __builtin_mips_cvt_s_pu (v2sf)
10155 Convert pair upper to single (@code{cvt.s.pu}).
10156
10157 @item v2sf __builtin_mips_abs_ps (v2sf)
10158 Absolute value (@code{abs.ps}).
10159
10160 @item v2sf __builtin_mips_alnv_ps (v2sf, v2sf, int)
10161 Align variable (@code{alnv.ps}).
10162
10163 @emph{Note:} The value of the third parameter must be 0 or 4
10164 modulo 8, otherwise the result will be unpredictable.  Please read the
10165 instruction description for details.
10166 @end table
10167
10168 The following multi-instruction functions are also available.
10169 In each case, @var{cond} can be any of the 16 floating-point conditions:
10170 @code{f}, @code{un}, @code{eq}, @code{ueq}, @code{olt}, @code{ult},
10171 @code{ole}, @code{ule}, @code{sf}, @code{ngle}, @code{seq}, @code{ngl},
10172 @code{lt}, @code{nge}, @code{le} or @code{ngt}.
10173
10174 @table @code
10175 @item v2sf __builtin_mips_movt_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
10176 @itemx v2sf __builtin_mips_movf_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
10177 Conditional move based on floating point comparison (@code{c.@var{cond}.ps},
10178 @code{movt.ps}/@code{movf.ps}).
10179
10180 The @code{movt} functions return the value @var{x} computed by:
10181
10182 @smallexample
10183 c.@var{cond}.ps @var{cc},@var{a},@var{b}
10184 mov.ps @var{x},@var{c}
10185 movt.ps @var{x},@var{d},@var{cc}
10186 @end smallexample
10187
10188 The @code{movf} functions are similar but use @code{movf.ps} instead
10189 of @code{movt.ps}.
10190
10191 @item int __builtin_mips_upper_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
10192 @itemx int __builtin_mips_lower_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
10193 Comparison of two paired-single values (@code{c.@var{cond}.ps},
10194 @code{bc1t}/@code{bc1f}).
10195
10196 These functions compare @var{a} and @var{b} using @code{c.@var{cond}.ps}
10197 and return either the upper or lower half of the result.  For example:
10198
10199 @smallexample
10200 v2sf a, b;
10201 if (__builtin_mips_upper_c_eq_ps (a, b))
10202   upper_halves_are_equal ();
10203 else
10204   upper_halves_are_unequal ();
10205
10206 if (__builtin_mips_lower_c_eq_ps (a, b))
10207   lower_halves_are_equal ();
10208 else
10209   lower_halves_are_unequal ();
10210 @end smallexample
10211 @end table
10212
10213 @node MIPS-3D Built-in Functions
10214 @subsubsection MIPS-3D Built-in Functions
10215
10216 The MIPS-3D Application-Specific Extension (ASE) includes additional
10217 paired-single instructions that are designed to improve the performance
10218 of 3D graphics operations.  Support for these instructions is controlled
10219 by the @option{-mips3d} command-line option.
10220
10221 The functions listed below map directly to a particular MIPS-3D
10222 instruction.  Please refer to the architecture specification for
10223 more details on what each instruction does.
10224
10225 @table @code
10226 @item v2sf __builtin_mips_addr_ps (v2sf, v2sf)
10227 Reduction add (@code{addr.ps}).
10228
10229 @item v2sf __builtin_mips_mulr_ps (v2sf, v2sf)
10230 Reduction multiply (@code{mulr.ps}).
10231
10232 @item v2sf __builtin_mips_cvt_pw_ps (v2sf)
10233 Convert paired single to paired word (@code{cvt.pw.ps}).
10234
10235 @item v2sf __builtin_mips_cvt_ps_pw (v2sf)
10236 Convert paired word to paired single (@code{cvt.ps.pw}).
10237
10238 @item float __builtin_mips_recip1_s (float)
10239 @itemx double __builtin_mips_recip1_d (double)
10240 @itemx v2sf __builtin_mips_recip1_ps (v2sf)
10241 Reduced precision reciprocal (sequence step 1) (@code{recip1.@var{fmt}}).
10242
10243 @item float __builtin_mips_recip2_s (float, float)
10244 @itemx double __builtin_mips_recip2_d (double, double)
10245 @itemx v2sf __builtin_mips_recip2_ps (v2sf, v2sf)
10246 Reduced precision reciprocal (sequence step 2) (@code{recip2.@var{fmt}}).
10247
10248 @item float __builtin_mips_rsqrt1_s (float)
10249 @itemx double __builtin_mips_rsqrt1_d (double)
10250 @itemx v2sf __builtin_mips_rsqrt1_ps (v2sf)
10251 Reduced precision reciprocal square root (sequence step 1)
10252 (@code{rsqrt1.@var{fmt}}).
10253
10254 @item float __builtin_mips_rsqrt2_s (float, float)
10255 @itemx double __builtin_mips_rsqrt2_d (double, double)
10256 @itemx v2sf __builtin_mips_rsqrt2_ps (v2sf, v2sf)
10257 Reduced precision reciprocal square root (sequence step 2)
10258 (@code{rsqrt2.@var{fmt}}).
10259 @end table
10260
10261 The following multi-instruction functions are also available.
10262 In each case, @var{cond} can be any of the 16 floating-point conditions:
10263 @code{f}, @code{un}, @code{eq}, @code{ueq}, @code{olt}, @code{ult},
10264 @code{ole}, @code{ule}, @code{sf}, @code{ngle}, @code{seq},
10265 @code{ngl}, @code{lt}, @code{nge}, @code{le} or @code{ngt}.
10266
10267 @table @code
10268 @item int __builtin_mips_cabs_@var{cond}_s (float @var{a}, float @var{b})
10269 @itemx int __builtin_mips_cabs_@var{cond}_d (double @var{a}, double @var{b})
10270 Absolute comparison of two scalar values (@code{cabs.@var{cond}.@var{fmt}},
10271 @code{bc1t}/@code{bc1f}).
10272
10273 These functions compare @var{a} and @var{b} using @code{cabs.@var{cond}.s}
10274 or @code{cabs.@var{cond}.d} and return the result as a boolean value.
10275 For example:
10276
10277 @smallexample
10278 float a, b;
10279 if (__builtin_mips_cabs_eq_s (a, b))
10280   true ();
10281 else
10282   false ();
10283 @end smallexample
10284
10285 @item int __builtin_mips_upper_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
10286 @itemx int __builtin_mips_lower_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
10287 Absolute comparison of two paired-single values (@code{cabs.@var{cond}.ps},
10288 @code{bc1t}/@code{bc1f}).
10289
10290 These functions compare @var{a} and @var{b} using @code{cabs.@var{cond}.ps}
10291 and return either the upper or lower half of the result.  For example:
10292
10293 @smallexample
10294 v2sf a, b;
10295 if (__builtin_mips_upper_cabs_eq_ps (a, b))
10296   upper_halves_are_equal ();
10297 else
10298   upper_halves_are_unequal ();
10299
10300 if (__builtin_mips_lower_cabs_eq_ps (a, b))
10301   lower_halves_are_equal ();
10302 else
10303   lower_halves_are_unequal ();
10304 @end smallexample
10305
10306 @item v2sf __builtin_mips_movt_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
10307 @itemx v2sf __builtin_mips_movf_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
10308 Conditional move based on absolute comparison (@code{cabs.@var{cond}.ps},
10309 @code{movt.ps}/@code{movf.ps}).
10310
10311 The @code{movt} functions return the value @var{x} computed by:
10312
10313 @smallexample
10314 cabs.@var{cond}.ps @var{cc},@var{a},@var{b}
10315 mov.ps @var{x},@var{c}
10316 movt.ps @var{x},@var{d},@var{cc}
10317 @end smallexample
10318
10319 The @code{movf} functions are similar but use @code{movf.ps} instead
10320 of @code{movt.ps}.
10321
10322 @item int __builtin_mips_any_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
10323 @itemx int __builtin_mips_all_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
10324 @itemx int __builtin_mips_any_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
10325 @itemx int __builtin_mips_all_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
10326 Comparison of two paired-single values
10327 (@code{c.@var{cond}.ps}/@code{cabs.@var{cond}.ps},
10328 @code{bc1any2t}/@code{bc1any2f}).
10329
10330 These functions compare @var{a} and @var{b} using @code{c.@var{cond}.ps}
10331 or @code{cabs.@var{cond}.ps}.  The @code{any} forms return true if either
10332 result is true and the @code{all} forms return true if both results are true.
10333 For example:
10334
10335 @smallexample
10336 v2sf a, b;
10337 if (__builtin_mips_any_c_eq_ps (a, b))
10338   one_is_true ();
10339 else
10340   both_are_false ();
10341
10342 if (__builtin_mips_all_c_eq_ps (a, b))
10343   both_are_true ();
10344 else
10345   one_is_false ();
10346 @end smallexample
10347
10348 @item int __builtin_mips_any_c_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
10349 @itemx int __builtin_mips_all_c_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
10350 @itemx int __builtin_mips_any_cabs_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
10351 @itemx int __builtin_mips_all_cabs_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
10352 Comparison of four paired-single values
10353 (@code{c.@var{cond}.ps}/@code{cabs.@var{cond}.ps},
10354 @code{bc1any4t}/@code{bc1any4f}).
10355
10356 These functions use @code{c.@var{cond}.ps} or @code{cabs.@var{cond}.ps}
10357 to compare @var{a} with @var{b} and to compare @var{c} with @var{d}.
10358 The @code{any} forms return true if any of the four results are true
10359 and the @code{all} forms return true if all four results are true.
10360 For example:
10361
10362 @smallexample
10363 v2sf a, b, c, d;
10364 if (__builtin_mips_any_c_eq_4s (a, b, c, d))
10365   some_are_true ();
10366 else
10367   all_are_false ();
10368
10369 if (__builtin_mips_all_c_eq_4s (a, b, c, d))
10370   all_are_true ();
10371 else
10372   some_are_false ();
10373 @end smallexample
10374 @end table
10375
10376 @node picoChip Built-in Functions
10377 @subsection picoChip Built-in Functions
10378
10379 GCC provides an interface to selected machine instructions from the
10380 picoChip instruction set.
10381
10382 @table @code
10383 @item int __builtin_sbc (int @var{value})
10384 Sign bit count.  Return the number of consecutive bits in @var{value}
10385 which have the same value as the sign-bit.  The result is the number of
10386 leading sign bits minus one, giving the number of redundant sign bits in
10387 @var{value}.
10388
10389 @item int __builtin_byteswap (int @var{value})
10390 Byte swap.  Return the result of swapping the upper and lower bytes of
10391 @var{value}.
10392
10393 @item int __builtin_brev (int @var{value})
10394 Bit reversal.  Return the result of reversing the bits in
10395 @var{value}.  Bit 15 is swapped with bit 0, bit 14 is swapped with bit 1,
10396 and so on.
10397
10398 @item int __builtin_adds (int @var{x}, int @var{y})
10399 Saturating addition.  Return the result of adding @var{x} and @var{y},
10400 storing the value 32767 if the result overflows.
10401
10402 @item int __builtin_subs (int @var{x}, int @var{y})
10403 Saturating subtraction.  Return the result of subtracting @var{y} from
10404 @var{x}, storing the value @minus{}32768 if the result overflows.
10405
10406 @item void __builtin_halt (void)
10407 Halt.  The processor will stop execution.  This built-in is useful for
10408 implementing assertions.
10409
10410 @end table
10411
10412 @node Other MIPS Built-in Functions
10413 @subsection Other MIPS Built-in Functions
10414
10415 GCC provides other MIPS-specific built-in functions:
10416
10417 @table @code
10418 @item void __builtin_mips_cache (int @var{op}, const volatile void *@var{addr})
10419 Insert a @samp{cache} instruction with operands @var{op} and @var{addr}.
10420 GCC defines the preprocessor macro @code{___GCC_HAVE_BUILTIN_MIPS_CACHE}
10421 when this function is available.
10422 @end table
10423
10424 @node PowerPC AltiVec/VSX Built-in Functions
10425 @subsection PowerPC AltiVec Built-in Functions
10426
10427 GCC provides an interface for the PowerPC family of processors to access
10428 the AltiVec operations described in Motorola's AltiVec Programming
10429 Interface Manual.  The interface is made available by including
10430 @code{<altivec.h>} and using @option{-maltivec} and
10431 @option{-mabi=altivec}.  The interface supports the following vector
10432 types.
10433
10434 @smallexample
10435 vector unsigned char
10436 vector signed char
10437 vector bool char
10438
10439 vector unsigned short
10440 vector signed short
10441 vector bool short
10442 vector pixel
10443
10444 vector unsigned int
10445 vector signed int
10446 vector bool int
10447 vector float
10448 @end smallexample
10449
10450 If @option{-mvsx} is used the following additional vector types are
10451 implemented.
10452
10453 @smallexample
10454 vector unsigned long
10455 vector signed long
10456 vector double
10457 @end smallexample
10458
10459 The long types are only implemented for 64-bit code generation, and
10460 the long type is only used in the floating point/integer conversion
10461 instructions.
10462
10463 GCC's implementation of the high-level language interface available from
10464 C and C++ code differs from Motorola's documentation in several ways.
10465
10466 @itemize @bullet
10467
10468 @item
10469 A vector constant is a list of constant expressions within curly braces.
10470
10471 @item
10472 A vector initializer requires no cast if the vector constant is of the
10473 same type as the variable it is initializing.
10474
10475 @item
10476 If @code{signed} or @code{unsigned} is omitted, the signedness of the
10477 vector type is the default signedness of the base type.  The default
10478 varies depending on the operating system, so a portable program should
10479 always specify the signedness.
10480
10481 @item
10482 Compiling with @option{-maltivec} adds keywords @code{__vector},
10483 @code{vector}, @code{__pixel}, @code{pixel}, @code{__bool} and
10484 @code{bool}.  When compiling ISO C, the context-sensitive substitution
10485 of the keywords @code{vector}, @code{pixel} and @code{bool} is
10486 disabled.  To use them, you must include @code{<altivec.h>} instead.
10487
10488 @item
10489 GCC allows using a @code{typedef} name as the type specifier for a
10490 vector type.
10491
10492 @item
10493 For C, overloaded functions are implemented with macros so the following
10494 does not work:
10495
10496 @smallexample
10497   vec_add ((vector signed int)@{1, 2, 3, 4@}, foo);
10498 @end smallexample
10499
10500 Since @code{vec_add} is a macro, the vector constant in the example
10501 is treated as four separate arguments.  Wrap the entire argument in
10502 parentheses for this to work.
10503 @end itemize
10504
10505 @emph{Note:} Only the @code{<altivec.h>} interface is supported.
10506 Internally, GCC uses built-in functions to achieve the functionality in
10507 the aforementioned header file, but they are not supported and are
10508 subject to change without notice.
10509
10510 The following interfaces are supported for the generic and specific
10511 AltiVec operations and the AltiVec predicates.  In cases where there
10512 is a direct mapping between generic and specific operations, only the
10513 generic names are shown here, although the specific operations can also
10514 be used.
10515
10516 Arguments that are documented as @code{const int} require literal
10517 integral values within the range required for that operation.
10518
10519 @smallexample
10520 vector signed char vec_abs (vector signed char);
10521 vector signed short vec_abs (vector signed short);
10522 vector signed int vec_abs (vector signed int);
10523 vector float vec_abs (vector float);
10524
10525 vector signed char vec_abss (vector signed char);
10526 vector signed short vec_abss (vector signed short);
10527 vector signed int vec_abss (vector signed int);
10528
10529 vector signed char vec_add (vector bool char, vector signed char);
10530 vector signed char vec_add (vector signed char, vector bool char);
10531 vector signed char vec_add (vector signed char, vector signed char);
10532 vector unsigned char vec_add (vector bool char, vector unsigned char);
10533 vector unsigned char vec_add (vector unsigned char, vector bool char);
10534 vector unsigned char vec_add (vector unsigned char,
10535                               vector unsigned char);
10536 vector signed short vec_add (vector bool short, vector signed short);
10537 vector signed short vec_add (vector signed short, vector bool short);
10538 vector signed short vec_add (vector signed short, vector signed short);
10539 vector unsigned short vec_add (vector bool short,
10540                                vector unsigned short);
10541 vector unsigned short vec_add (vector unsigned short,
10542                                vector bool short);
10543 vector unsigned short vec_add (vector unsigned short,
10544                                vector unsigned short);
10545 vector signed int vec_add (vector bool int, vector signed int);
10546 vector signed int vec_add (vector signed int, vector bool int);
10547 vector signed int vec_add (vector signed int, vector signed int);
10548 vector unsigned int vec_add (vector bool int, vector unsigned int);
10549 vector unsigned int vec_add (vector unsigned int, vector bool int);
10550 vector unsigned int vec_add (vector unsigned int, vector unsigned int);
10551 vector float vec_add (vector float, vector float);
10552
10553 vector float vec_vaddfp (vector float, vector float);
10554
10555 vector signed int vec_vadduwm (vector bool int, vector signed int);
10556 vector signed int vec_vadduwm (vector signed int, vector bool int);
10557 vector signed int vec_vadduwm (vector signed int, vector signed int);
10558 vector unsigned int vec_vadduwm (vector bool int, vector unsigned int);
10559 vector unsigned int vec_vadduwm (vector unsigned int, vector bool int);
10560 vector unsigned int vec_vadduwm (vector unsigned int,
10561                                  vector unsigned int);
10562
10563 vector signed short vec_vadduhm (vector bool short,
10564                                  vector signed short);
10565 vector signed short vec_vadduhm (vector signed short,
10566                                  vector bool short);
10567 vector signed short vec_vadduhm (vector signed short,
10568                                  vector signed short);
10569 vector unsigned short vec_vadduhm (vector bool short,
10570                                    vector unsigned short);
10571 vector unsigned short vec_vadduhm (vector unsigned short,
10572                                    vector bool short);
10573 vector unsigned short vec_vadduhm (vector unsigned short,
10574                                    vector unsigned short);
10575
10576 vector signed char vec_vaddubm (vector bool char, vector signed char);
10577 vector signed char vec_vaddubm (vector signed char, vector bool char);
10578 vector signed char vec_vaddubm (vector signed char, vector signed char);
10579 vector unsigned char vec_vaddubm (vector bool char,
10580                                   vector unsigned char);
10581 vector unsigned char vec_vaddubm (vector unsigned char,
10582                                   vector bool char);
10583 vector unsigned char vec_vaddubm (vector unsigned char,
10584                                   vector unsigned char);
10585
10586 vector unsigned int vec_addc (vector unsigned int, vector unsigned int);
10587
10588 vector unsigned char vec_adds (vector bool char, vector unsigned char);
10589 vector unsigned char vec_adds (vector unsigned char, vector bool char);
10590 vector unsigned char vec_adds (vector unsigned char,
10591                                vector unsigned char);
10592 vector signed char vec_adds (vector bool char, vector signed char);
10593 vector signed char vec_adds (vector signed char, vector bool char);
10594 vector signed char vec_adds (vector signed char, vector signed char);
10595 vector unsigned short vec_adds (vector bool short,
10596                                 vector unsigned short);
10597 vector unsigned short vec_adds (vector unsigned short,
10598                                 vector bool short);
10599 vector unsigned short vec_adds (vector unsigned short,
10600                                 vector unsigned short);
10601 vector signed short vec_adds (vector bool short, vector signed short);
10602 vector signed short vec_adds (vector signed short, vector bool short);
10603 vector signed short vec_adds (vector signed short, vector signed short);
10604 vector unsigned int vec_adds (vector bool int, vector unsigned int);
10605 vector unsigned int vec_adds (vector unsigned int, vector bool int);
10606 vector unsigned int vec_adds (vector unsigned int, vector unsigned int);
10607 vector signed int vec_adds (vector bool int, vector signed int);
10608 vector signed int vec_adds (vector signed int, vector bool int);
10609 vector signed int vec_adds (vector signed int, vector signed int);
10610
10611 vector signed int vec_vaddsws (vector bool int, vector signed int);
10612 vector signed int vec_vaddsws (vector signed int, vector bool int);
10613 vector signed int vec_vaddsws (vector signed int, vector signed int);
10614
10615 vector unsigned int vec_vadduws (vector bool int, vector unsigned int);
10616 vector unsigned int vec_vadduws (vector unsigned int, vector bool int);
10617 vector unsigned int vec_vadduws (vector unsigned int,
10618                                  vector unsigned int);
10619
10620 vector signed short vec_vaddshs (vector bool short,
10621                                  vector signed short);
10622 vector signed short vec_vaddshs (vector signed short,
10623                                  vector bool short);
10624 vector signed short vec_vaddshs (vector signed short,
10625                                  vector signed short);
10626
10627 vector unsigned short vec_vadduhs (vector bool short,
10628                                    vector unsigned short);
10629 vector unsigned short vec_vadduhs (vector unsigned short,
10630                                    vector bool short);
10631 vector unsigned short vec_vadduhs (vector unsigned short,
10632                                    vector unsigned short);
10633
10634 vector signed char vec_vaddsbs (vector bool char, vector signed char);
10635 vector signed char vec_vaddsbs (vector signed char, vector bool char);
10636 vector signed char vec_vaddsbs (vector signed char, vector signed char);
10637
10638 vector unsigned char vec_vaddubs (vector bool char,
10639                                   vector unsigned char);
10640 vector unsigned char vec_vaddubs (vector unsigned char,
10641                                   vector bool char);
10642 vector unsigned char vec_vaddubs (vector unsigned char,
10643                                   vector unsigned char);
10644
10645 vector float vec_and (vector float, vector float);
10646 vector float vec_and (vector float, vector bool int);
10647 vector float vec_and (vector bool int, vector float);
10648 vector bool int vec_and (vector bool int, vector bool int);
10649 vector signed int vec_and (vector bool int, vector signed int);
10650 vector signed int vec_and (vector signed int, vector bool int);
10651 vector signed int vec_and (vector signed int, vector signed int);
10652 vector unsigned int vec_and (vector bool int, vector unsigned int);
10653 vector unsigned int vec_and (vector unsigned int, vector bool int);
10654 vector unsigned int vec_and (vector unsigned int, vector unsigned int);
10655 vector bool short vec_and (vector bool short, vector bool short);
10656 vector signed short vec_and (vector bool short, vector signed short);
10657 vector signed short vec_and (vector signed short, vector bool short);
10658 vector signed short vec_and (vector signed short, vector signed short);
10659 vector unsigned short vec_and (vector bool short,
10660                                vector unsigned short);
10661 vector unsigned short vec_and (vector unsigned short,
10662                                vector bool short);
10663 vector unsigned short vec_and (vector unsigned short,
10664                                vector unsigned short);
10665 vector signed char vec_and (vector bool char, vector signed char);
10666 vector bool char vec_and (vector bool char, vector bool char);
10667 vector signed char vec_and (vector signed char, vector bool char);
10668 vector signed char vec_and (vector signed char, vector signed char);
10669 vector unsigned char vec_and (vector bool char, vector unsigned char);
10670 vector unsigned char vec_and (vector unsigned char, vector bool char);
10671 vector unsigned char vec_and (vector unsigned char,
10672                               vector unsigned char);
10673
10674 vector float vec_andc (vector float, vector float);
10675 vector float vec_andc (vector float, vector bool int);
10676 vector float vec_andc (vector bool int, vector float);
10677 vector bool int vec_andc (vector bool int, vector bool int);
10678 vector signed int vec_andc (vector bool int, vector signed int);
10679 vector signed int vec_andc (vector signed int, vector bool int);
10680 vector signed int vec_andc (vector signed int, vector signed int);
10681 vector unsigned int vec_andc (vector bool int, vector unsigned int);
10682 vector unsigned int vec_andc (vector unsigned int, vector bool int);
10683 vector unsigned int vec_andc (vector unsigned int, vector unsigned int);
10684 vector bool short vec_andc (vector bool short, vector bool short);
10685 vector signed short vec_andc (vector bool short, vector signed short);
10686 vector signed short vec_andc (vector signed short, vector bool short);
10687 vector signed short vec_andc (vector signed short, vector signed short);
10688 vector unsigned short vec_andc (vector bool short,
10689                                 vector unsigned short);
10690 vector unsigned short vec_andc (vector unsigned short,
10691                                 vector bool short);
10692 vector unsigned short vec_andc (vector unsigned short,
10693                                 vector unsigned short);
10694 vector signed char vec_andc (vector bool char, vector signed char);
10695 vector bool char vec_andc (vector bool char, vector bool char);
10696 vector signed char vec_andc (vector signed char, vector bool char);
10697 vector signed char vec_andc (vector signed char, vector signed char);
10698 vector unsigned char vec_andc (vector bool char, vector unsigned char);
10699 vector unsigned char vec_andc (vector unsigned char, vector bool char);
10700 vector unsigned char vec_andc (vector unsigned char,
10701                                vector unsigned char);
10702
10703 vector unsigned char vec_avg (vector unsigned char,
10704                               vector unsigned char);
10705 vector signed char vec_avg (vector signed char, vector signed char);
10706 vector unsigned short vec_avg (vector unsigned short,
10707                                vector unsigned short);
10708 vector signed short vec_avg (vector signed short, vector signed short);
10709 vector unsigned int vec_avg (vector unsigned int, vector unsigned int);
10710 vector signed int vec_avg (vector signed int, vector signed int);
10711
10712 vector signed int vec_vavgsw (vector signed int, vector signed int);
10713
10714 vector unsigned int vec_vavguw (vector unsigned int,
10715                                 vector unsigned int);
10716
10717 vector signed short vec_vavgsh (vector signed short,
10718                                 vector signed short);
10719
10720 vector unsigned short vec_vavguh (vector unsigned short,
10721                                   vector unsigned short);
10722
10723 vector signed char vec_vavgsb (vector signed char, vector signed char);
10724
10725 vector unsigned char vec_vavgub (vector unsigned char,
10726                                  vector unsigned char);
10727
10728 vector float vec_copysign (vector float);
10729
10730 vector float vec_ceil (vector float);
10731
10732 vector signed int vec_cmpb (vector float, vector float);
10733
10734 vector bool char vec_cmpeq (vector signed char, vector signed char);
10735 vector bool char vec_cmpeq (vector unsigned char, vector unsigned char);
10736 vector bool short vec_cmpeq (vector signed short, vector signed short);
10737 vector bool short vec_cmpeq (vector unsigned short,
10738                              vector unsigned short);
10739 vector bool int vec_cmpeq (vector signed int, vector signed int);
10740 vector bool int vec_cmpeq (vector unsigned int, vector unsigned int);
10741 vector bool int vec_cmpeq (vector float, vector float);
10742
10743 vector bool int vec_vcmpeqfp (vector float, vector float);
10744
10745 vector bool int vec_vcmpequw (vector signed int, vector signed int);
10746 vector bool int vec_vcmpequw (vector unsigned int, vector unsigned int);
10747
10748 vector bool short vec_vcmpequh (vector signed short,
10749                                 vector signed short);
10750 vector bool short vec_vcmpequh (vector unsigned short,
10751                                 vector unsigned short);
10752
10753 vector bool char vec_vcmpequb (vector signed char, vector signed char);
10754 vector bool char vec_vcmpequb (vector unsigned char,
10755                                vector unsigned char);
10756
10757 vector bool int vec_cmpge (vector float, vector float);
10758
10759 vector bool char vec_cmpgt (vector unsigned char, vector unsigned char);
10760 vector bool char vec_cmpgt (vector signed char, vector signed char);
10761 vector bool short vec_cmpgt (vector unsigned short,
10762                              vector unsigned short);
10763 vector bool short vec_cmpgt (vector signed short, vector signed short);
10764 vector bool int vec_cmpgt (vector unsigned int, vector unsigned int);
10765 vector bool int vec_cmpgt (vector signed int, vector signed int);
10766 vector bool int vec_cmpgt (vector float, vector float);
10767
10768 vector bool int vec_vcmpgtfp (vector float, vector float);
10769
10770 vector bool int vec_vcmpgtsw (vector signed int, vector signed int);
10771
10772 vector bool int vec_vcmpgtuw (vector unsigned int, vector unsigned int);
10773
10774 vector bool short vec_vcmpgtsh (vector signed short,
10775                                 vector signed short);
10776
10777 vector bool short vec_vcmpgtuh (vector unsigned short,
10778                                 vector unsigned short);
10779
10780 vector bool char vec_vcmpgtsb (vector signed char, vector signed char);
10781
10782 vector bool char vec_vcmpgtub (vector unsigned char,
10783                                vector unsigned char);
10784
10785 vector bool int vec_cmple (vector float, vector float);
10786
10787 vector bool char vec_cmplt (vector unsigned char, vector unsigned char);
10788 vector bool char vec_cmplt (vector signed char, vector signed char);
10789 vector bool short vec_cmplt (vector unsigned short,
10790                              vector unsigned short);
10791 vector bool short vec_cmplt (vector signed short, vector signed short);
10792 vector bool int vec_cmplt (vector unsigned int, vector unsigned int);
10793 vector bool int vec_cmplt (vector signed int, vector signed int);
10794 vector bool int vec_cmplt (vector float, vector float);
10795
10796 vector float vec_ctf (vector unsigned int, const int);
10797 vector float vec_ctf (vector signed int, const int);
10798
10799 vector float vec_vcfsx (vector signed int, const int);
10800
10801 vector float vec_vcfux (vector unsigned int, const int);
10802
10803 vector signed int vec_cts (vector float, const int);
10804
10805 vector unsigned int vec_ctu (vector float, const int);
10806
10807 void vec_dss (const int);
10808
10809 void vec_dssall (void);
10810
10811 void vec_dst (const vector unsigned char *, int, const int);
10812 void vec_dst (const vector signed char *, int, const int);
10813 void vec_dst (const vector bool char *, int, const int);
10814 void vec_dst (const vector unsigned short *, int, const int);
10815 void vec_dst (const vector signed short *, int, const int);
10816 void vec_dst (const vector bool short *, int, const int);
10817 void vec_dst (const vector pixel *, int, const int);
10818 void vec_dst (const vector unsigned int *, int, const int);
10819 void vec_dst (const vector signed int *, int, const int);
10820 void vec_dst (const vector bool int *, int, const int);
10821 void vec_dst (const vector float *, int, const int);
10822 void vec_dst (const unsigned char *, int, const int);
10823 void vec_dst (const signed char *, int, const int);
10824 void vec_dst (const unsigned short *, int, const int);
10825 void vec_dst (const short *, int, const int);
10826 void vec_dst (const unsigned int *, int, const int);
10827 void vec_dst (const int *, int, const int);
10828 void vec_dst (const unsigned long *, int, const int);
10829 void vec_dst (const long *, int, const int);
10830 void vec_dst (const float *, int, const int);
10831
10832 void vec_dstst (const vector unsigned char *, int, const int);
10833 void vec_dstst (const vector signed char *, int, const int);
10834 void vec_dstst (const vector bool char *, int, const int);
10835 void vec_dstst (const vector unsigned short *, int, const int);
10836 void vec_dstst (const vector signed short *, int, const int);
10837 void vec_dstst (const vector bool short *, int, const int);
10838 void vec_dstst (const vector pixel *, int, const int);
10839 void vec_dstst (const vector unsigned int *, int, const int);
10840 void vec_dstst (const vector signed int *, int, const int);
10841 void vec_dstst (const vector bool int *, int, const int);
10842 void vec_dstst (const vector float *, int, const int);
10843 void vec_dstst (const unsigned char *, int, const int);
10844 void vec_dstst (const signed char *, int, const int);
10845 void vec_dstst (const unsigned short *, int, const int);
10846 void vec_dstst (const short *, int, const int);
10847 void vec_dstst (const unsigned int *, int, const int);
10848 void vec_dstst (const int *, int, const int);
10849 void vec_dstst (const unsigned long *, int, const int);
10850 void vec_dstst (const long *, int, const int);
10851 void vec_dstst (const float *, int, const int);
10852
10853 void vec_dststt (const vector unsigned char *, int, const int);
10854 void vec_dststt (const vector signed char *, int, const int);
10855 void vec_dststt (const vector bool char *, int, const int);
10856 void vec_dststt (const vector unsigned short *, int, const int);
10857 void vec_dststt (const vector signed short *, int, const int);
10858 void vec_dststt (const vector bool short *, int, const int);
10859 void vec_dststt (const vector pixel *, int, const int);
10860 void vec_dststt (const vector unsigned int *, int, const int);
10861 void vec_dststt (const vector signed int *, int, const int);
10862 void vec_dststt (const vector bool int *, int, const int);
10863 void vec_dststt (const vector float *, int, const int);
10864 void vec_dststt (const unsigned char *, int, const int);
10865 void vec_dststt (const signed char *, int, const int);
10866 void vec_dststt (const unsigned short *, int, const int);
10867 void vec_dststt (const short *, int, const int);
10868 void vec_dststt (const unsigned int *, int, const int);
10869 void vec_dststt (const int *, int, const int);
10870 void vec_dststt (const unsigned long *, int, const int);
10871 void vec_dststt (const long *, int, const int);
10872 void vec_dststt (const float *, int, const int);
10873
10874 void vec_dstt (const vector unsigned char *, int, const int);
10875 void vec_dstt (const vector signed char *, int, const int);
10876 void vec_dstt (const vector bool char *, int, const int);
10877 void vec_dstt (const vector unsigned short *, int, const int);
10878 void vec_dstt (const vector signed short *, int, const int);
10879 void vec_dstt (const vector bool short *, int, const int);
10880 void vec_dstt (const vector pixel *, int, const int);
10881 void vec_dstt (const vector unsigned int *, int, const int);
10882 void vec_dstt (const vector signed int *, int, const int);
10883 void vec_dstt (const vector bool int *, int, const int);
10884 void vec_dstt (const vector float *, int, const int);
10885 void vec_dstt (const unsigned char *, int, const int);
10886 void vec_dstt (const signed char *, int, const int);
10887 void vec_dstt (const unsigned short *, int, const int);
10888 void vec_dstt (const short *, int, const int);
10889 void vec_dstt (const unsigned int *, int, const int);
10890 void vec_dstt (const int *, int, const int);
10891 void vec_dstt (const unsigned long *, int, const int);
10892 void vec_dstt (const long *, int, const int);
10893 void vec_dstt (const float *, int, const int);
10894
10895 vector float vec_expte (vector float);
10896
10897 vector float vec_floor (vector float);
10898
10899 vector float vec_ld (int, const vector float *);
10900 vector float vec_ld (int, const float *);
10901 vector bool int vec_ld (int, const vector bool int *);
10902 vector signed int vec_ld (int, const vector signed int *);
10903 vector signed int vec_ld (int, const int *);
10904 vector signed int vec_ld (int, const long *);
10905 vector unsigned int vec_ld (int, const vector unsigned int *);
10906 vector unsigned int vec_ld (int, const unsigned int *);
10907 vector unsigned int vec_ld (int, const unsigned long *);
10908 vector bool short vec_ld (int, const vector bool short *);
10909 vector pixel vec_ld (int, const vector pixel *);
10910 vector signed short vec_ld (int, const vector signed short *);
10911 vector signed short vec_ld (int, const short *);
10912 vector unsigned short vec_ld (int, const vector unsigned short *);
10913 vector unsigned short vec_ld (int, const unsigned short *);
10914 vector bool char vec_ld (int, const vector bool char *);
10915 vector signed char vec_ld (int, const vector signed char *);
10916 vector signed char vec_ld (int, const signed char *);
10917 vector unsigned char vec_ld (int, const vector unsigned char *);
10918 vector unsigned char vec_ld (int, const unsigned char *);
10919
10920 vector signed char vec_lde (int, const signed char *);
10921 vector unsigned char vec_lde (int, const unsigned char *);
10922 vector signed short vec_lde (int, const short *);
10923 vector unsigned short vec_lde (int, const unsigned short *);
10924 vector float vec_lde (int, const float *);
10925 vector signed int vec_lde (int, const int *);
10926 vector unsigned int vec_lde (int, const unsigned int *);
10927 vector signed int vec_lde (int, const long *);
10928 vector unsigned int vec_lde (int, const unsigned long *);
10929
10930 vector float vec_lvewx (int, float *);
10931 vector signed int vec_lvewx (int, int *);
10932 vector unsigned int vec_lvewx (int, unsigned int *);
10933 vector signed int vec_lvewx (int, long *);
10934 vector unsigned int vec_lvewx (int, unsigned long *);
10935
10936 vector signed short vec_lvehx (int, short *);
10937 vector unsigned short vec_lvehx (int, unsigned short *);
10938
10939 vector signed char vec_lvebx (int, char *);
10940 vector unsigned char vec_lvebx (int, unsigned char *);
10941
10942 vector float vec_ldl (int, const vector float *);
10943 vector float vec_ldl (int, const float *);
10944 vector bool int vec_ldl (int, const vector bool int *);
10945 vector signed int vec_ldl (int, const vector signed int *);
10946 vector signed int vec_ldl (int, const int *);
10947 vector signed int vec_ldl (int, const long *);
10948 vector unsigned int vec_ldl (int, const vector unsigned int *);
10949 vector unsigned int vec_ldl (int, const unsigned int *);
10950 vector unsigned int vec_ldl (int, const unsigned long *);
10951 vector bool short vec_ldl (int, const vector bool short *);
10952 vector pixel vec_ldl (int, const vector pixel *);
10953 vector signed short vec_ldl (int, const vector signed short *);
10954 vector signed short vec_ldl (int, const short *);
10955 vector unsigned short vec_ldl (int, const vector unsigned short *);
10956 vector unsigned short vec_ldl (int, const unsigned short *);
10957 vector bool char vec_ldl (int, const vector bool char *);
10958 vector signed char vec_ldl (int, const vector signed char *);
10959 vector signed char vec_ldl (int, const signed char *);
10960 vector unsigned char vec_ldl (int, const vector unsigned char *);
10961 vector unsigned char vec_ldl (int, const unsigned char *);
10962
10963 vector float vec_loge (vector float);
10964
10965 vector unsigned char vec_lvsl (int, const volatile unsigned char *);
10966 vector unsigned char vec_lvsl (int, const volatile signed char *);
10967 vector unsigned char vec_lvsl (int, const volatile unsigned short *);
10968 vector unsigned char vec_lvsl (int, const volatile short *);
10969 vector unsigned char vec_lvsl (int, const volatile unsigned int *);
10970 vector unsigned char vec_lvsl (int, const volatile int *);
10971 vector unsigned char vec_lvsl (int, const volatile unsigned long *);
10972 vector unsigned char vec_lvsl (int, const volatile long *);
10973 vector unsigned char vec_lvsl (int, const volatile float *);
10974
10975 vector unsigned char vec_lvsr (int, const volatile unsigned char *);
10976 vector unsigned char vec_lvsr (int, const volatile signed char *);
10977 vector unsigned char vec_lvsr (int, const volatile unsigned short *);
10978 vector unsigned char vec_lvsr (int, const volatile short *);
10979 vector unsigned char vec_lvsr (int, const volatile unsigned int *);
10980 vector unsigned char vec_lvsr (int, const volatile int *);
10981 vector unsigned char vec_lvsr (int, const volatile unsigned long *);
10982 vector unsigned char vec_lvsr (int, const volatile long *);
10983 vector unsigned char vec_lvsr (int, const volatile float *);
10984
10985 vector float vec_madd (vector float, vector float, vector float);
10986
10987 vector signed short vec_madds (vector signed short,
10988                                vector signed short,
10989                                vector signed short);
10990
10991 vector unsigned char vec_max (vector bool char, vector unsigned char);
10992 vector unsigned char vec_max (vector unsigned char, vector bool char);
10993 vector unsigned char vec_max (vector unsigned char,
10994                               vector unsigned char);
10995 vector signed char vec_max (vector bool char, vector signed char);
10996 vector signed char vec_max (vector signed char, vector bool char);
10997 vector signed char vec_max (vector signed char, vector signed char);
10998 vector unsigned short vec_max (vector bool short,
10999                                vector unsigned short);
11000 vector unsigned short vec_max (vector unsigned short,
11001                                vector bool short);
11002 vector unsigned short vec_max (vector unsigned short,
11003                                vector unsigned short);
11004 vector signed short vec_max (vector bool short, vector signed short);
11005 vector signed short vec_max (vector signed short, vector bool short);
11006 vector signed short vec_max (vector signed short, vector signed short);
11007 vector unsigned int vec_max (vector bool int, vector unsigned int);
11008 vector unsigned int vec_max (vector unsigned int, vector bool int);
11009 vector unsigned int vec_max (vector unsigned int, vector unsigned int);
11010 vector signed int vec_max (vector bool int, vector signed int);
11011 vector signed int vec_max (vector signed int, vector bool int);
11012 vector signed int vec_max (vector signed int, vector signed int);
11013 vector float vec_max (vector float, vector float);
11014
11015 vector float vec_vmaxfp (vector float, vector float);
11016
11017 vector signed int vec_vmaxsw (vector bool int, vector signed int);
11018 vector signed int vec_vmaxsw (vector signed int, vector bool int);
11019 vector signed int vec_vmaxsw (vector signed int, vector signed int);
11020
11021 vector unsigned int vec_vmaxuw (vector bool int, vector unsigned int);
11022 vector unsigned int vec_vmaxuw (vector unsigned int, vector bool int);
11023 vector unsigned int vec_vmaxuw (vector unsigned int,
11024                                 vector unsigned int);
11025
11026 vector signed short vec_vmaxsh (vector bool short, vector signed short);
11027 vector signed short vec_vmaxsh (vector signed short, vector bool short);
11028 vector signed short vec_vmaxsh (vector signed short,
11029                                 vector signed short);
11030
11031 vector unsigned short vec_vmaxuh (vector bool short,
11032                                   vector unsigned short);
11033 vector unsigned short vec_vmaxuh (vector unsigned short,
11034                                   vector bool short);
11035 vector unsigned short vec_vmaxuh (vector unsigned short,
11036                                   vector unsigned short);
11037
11038 vector signed char vec_vmaxsb (vector bool char, vector signed char);
11039 vector signed char vec_vmaxsb (vector signed char, vector bool char);
11040 vector signed char vec_vmaxsb (vector signed char, vector signed char);
11041
11042 vector unsigned char vec_vmaxub (vector bool char,
11043                                  vector unsigned char);
11044 vector unsigned char vec_vmaxub (vector unsigned char,
11045                                  vector bool char);
11046 vector unsigned char vec_vmaxub (vector unsigned char,
11047                                  vector unsigned char);
11048
11049 vector bool char vec_mergeh (vector bool char, vector bool char);
11050 vector signed char vec_mergeh (vector signed char, vector signed char);
11051 vector unsigned char vec_mergeh (vector unsigned char,
11052                                  vector unsigned char);
11053 vector bool short vec_mergeh (vector bool short, vector bool short);
11054 vector pixel vec_mergeh (vector pixel, vector pixel);
11055 vector signed short vec_mergeh (vector signed short,
11056                                 vector signed short);
11057 vector unsigned short vec_mergeh (vector unsigned short,
11058                                   vector unsigned short);
11059 vector float vec_mergeh (vector float, vector float);
11060 vector bool int vec_mergeh (vector bool int, vector bool int);
11061 vector signed int vec_mergeh (vector signed int, vector signed int);
11062 vector unsigned int vec_mergeh (vector unsigned int,
11063                                 vector unsigned int);
11064
11065 vector float vec_vmrghw (vector float, vector float);
11066 vector bool int vec_vmrghw (vector bool int, vector bool int);
11067 vector signed int vec_vmrghw (vector signed int, vector signed int);
11068 vector unsigned int vec_vmrghw (vector unsigned int,
11069                                 vector unsigned int);
11070
11071 vector bool short vec_vmrghh (vector bool short, vector bool short);
11072 vector signed short vec_vmrghh (vector signed short,
11073                                 vector signed short);
11074 vector unsigned short vec_vmrghh (vector unsigned short,
11075                                   vector unsigned short);
11076 vector pixel vec_vmrghh (vector pixel, vector pixel);
11077
11078 vector bool char vec_vmrghb (vector bool char, vector bool char);
11079 vector signed char vec_vmrghb (vector signed char, vector signed char);
11080 vector unsigned char vec_vmrghb (vector unsigned char,
11081                                  vector unsigned char);
11082
11083 vector bool char vec_mergel (vector bool char, vector bool char);
11084 vector signed char vec_mergel (vector signed char, vector signed char);
11085 vector unsigned char vec_mergel (vector unsigned char,
11086                                  vector unsigned char);
11087 vector bool short vec_mergel (vector bool short, vector bool short);
11088 vector pixel vec_mergel (vector pixel, vector pixel);
11089 vector signed short vec_mergel (vector signed short,
11090                                 vector signed short);
11091 vector unsigned short vec_mergel (vector unsigned short,
11092                                   vector unsigned short);
11093 vector float vec_mergel (vector float, vector float);
11094 vector bool int vec_mergel (vector bool int, vector bool int);
11095 vector signed int vec_mergel (vector signed int, vector signed int);
11096 vector unsigned int vec_mergel (vector unsigned int,
11097                                 vector unsigned int);
11098
11099 vector float vec_vmrglw (vector float, vector float);
11100 vector signed int vec_vmrglw (vector signed int, vector signed int);
11101 vector unsigned int vec_vmrglw (vector unsigned int,
11102                                 vector unsigned int);
11103 vector bool int vec_vmrglw (vector bool int, vector bool int);
11104
11105 vector bool short vec_vmrglh (vector bool short, vector bool short);
11106 vector signed short vec_vmrglh (vector signed short,
11107                                 vector signed short);
11108 vector unsigned short vec_vmrglh (vector unsigned short,
11109                                   vector unsigned short);
11110 vector pixel vec_vmrglh (vector pixel, vector pixel);
11111
11112 vector bool char vec_vmrglb (vector bool char, vector bool char);
11113 vector signed char vec_vmrglb (vector signed char, vector signed char);
11114 vector unsigned char vec_vmrglb (vector unsigned char,
11115                                  vector unsigned char);
11116
11117 vector unsigned short vec_mfvscr (void);
11118
11119 vector unsigned char vec_min (vector bool char, vector unsigned char);
11120 vector unsigned char vec_min (vector unsigned char, vector bool char);
11121 vector unsigned char vec_min (vector unsigned char,
11122                               vector unsigned char);
11123 vector signed char vec_min (vector bool char, vector signed char);
11124 vector signed char vec_min (vector signed char, vector bool char);
11125 vector signed char vec_min (vector signed char, vector signed char);
11126 vector unsigned short vec_min (vector bool short,
11127                                vector unsigned short);
11128 vector unsigned short vec_min (vector unsigned short,
11129                                vector bool short);
11130 vector unsigned short vec_min (vector unsigned short,
11131                                vector unsigned short);
11132 vector signed short vec_min (vector bool short, vector signed short);
11133 vector signed short vec_min (vector signed short, vector bool short);
11134 vector signed short vec_min (vector signed short, vector signed short);
11135 vector unsigned int vec_min (vector bool int, vector unsigned int);
11136 vector unsigned int vec_min (vector unsigned int, vector bool int);
11137 vector unsigned int vec_min (vector unsigned int, vector unsigned int);
11138 vector signed int vec_min (vector bool int, vector signed int);
11139 vector signed int vec_min (vector signed int, vector bool int);
11140 vector signed int vec_min (vector signed int, vector signed int);
11141 vector float vec_min (vector float, vector float);
11142
11143 vector float vec_vminfp (vector float, vector float);
11144
11145 vector signed int vec_vminsw (vector bool int, vector signed int);
11146 vector signed int vec_vminsw (vector signed int, vector bool int);
11147 vector signed int vec_vminsw (vector signed int, vector signed int);
11148
11149 vector unsigned int vec_vminuw (vector bool int, vector unsigned int);
11150 vector unsigned int vec_vminuw (vector unsigned int, vector bool int);
11151 vector unsigned int vec_vminuw (vector unsigned int,
11152                                 vector unsigned int);
11153
11154 vector signed short vec_vminsh (vector bool short, vector signed short);
11155 vector signed short vec_vminsh (vector signed short, vector bool short);
11156 vector signed short vec_vminsh (vector signed short,
11157                                 vector signed short);
11158
11159 vector unsigned short vec_vminuh (vector bool short,
11160                                   vector unsigned short);
11161 vector unsigned short vec_vminuh (vector unsigned short,
11162                                   vector bool short);
11163 vector unsigned short vec_vminuh (vector unsigned short,
11164                                   vector unsigned short);
11165
11166 vector signed char vec_vminsb (vector bool char, vector signed char);
11167 vector signed char vec_vminsb (vector signed char, vector bool char);
11168 vector signed char vec_vminsb (vector signed char, vector signed char);
11169
11170 vector unsigned char vec_vminub (vector bool char,
11171                                  vector unsigned char);
11172 vector unsigned char vec_vminub (vector unsigned char,
11173                                  vector bool char);
11174 vector unsigned char vec_vminub (vector unsigned char,
11175                                  vector unsigned char);
11176
11177 vector signed short vec_mladd (vector signed short,
11178                                vector signed short,
11179                                vector signed short);
11180 vector signed short vec_mladd (vector signed short,
11181                                vector unsigned short,
11182                                vector unsigned short);
11183 vector signed short vec_mladd (vector unsigned short,
11184                                vector signed short,
11185                                vector signed short);
11186 vector unsigned short vec_mladd (vector unsigned short,
11187                                  vector unsigned short,
11188                                  vector unsigned short);
11189
11190 vector signed short vec_mradds (vector signed short,
11191                                 vector signed short,
11192                                 vector signed short);
11193
11194 vector unsigned int vec_msum (vector unsigned char,
11195                               vector unsigned char,
11196                               vector unsigned int);
11197 vector signed int vec_msum (vector signed char,
11198                             vector unsigned char,
11199                             vector signed int);
11200 vector unsigned int vec_msum (vector unsigned short,
11201                               vector unsigned short,
11202                               vector unsigned int);
11203 vector signed int vec_msum (vector signed short,
11204                             vector signed short,
11205                             vector signed int);
11206
11207 vector signed int vec_vmsumshm (vector signed short,
11208                                 vector signed short,
11209                                 vector signed int);
11210
11211 vector unsigned int vec_vmsumuhm (vector unsigned short,
11212                                   vector unsigned short,
11213                                   vector unsigned int);
11214
11215 vector signed int vec_vmsummbm (vector signed char,
11216                                 vector unsigned char,
11217                                 vector signed int);
11218
11219 vector unsigned int vec_vmsumubm (vector unsigned char,
11220                                   vector unsigned char,
11221                                   vector unsigned int);
11222
11223 vector unsigned int vec_msums (vector unsigned short,
11224                                vector unsigned short,
11225                                vector unsigned int);
11226 vector signed int vec_msums (vector signed short,
11227                              vector signed short,
11228                              vector signed int);
11229
11230 vector signed int vec_vmsumshs (vector signed short,
11231                                 vector signed short,
11232                                 vector signed int);
11233
11234 vector unsigned int vec_vmsumuhs (vector unsigned short,
11235                                   vector unsigned short,
11236                                   vector unsigned int);
11237
11238 void vec_mtvscr (vector signed int);
11239 void vec_mtvscr (vector unsigned int);
11240 void vec_mtvscr (vector bool int);
11241 void vec_mtvscr (vector signed short);
11242 void vec_mtvscr (vector unsigned short);
11243 void vec_mtvscr (vector bool short);
11244 void vec_mtvscr (vector pixel);
11245 void vec_mtvscr (vector signed char);
11246 void vec_mtvscr (vector unsigned char);
11247 void vec_mtvscr (vector bool char);
11248
11249 vector unsigned short vec_mule (vector unsigned char,
11250                                 vector unsigned char);
11251 vector signed short vec_mule (vector signed char,
11252                               vector signed char);
11253 vector unsigned int vec_mule (vector unsigned short,
11254                               vector unsigned short);
11255 vector signed int vec_mule (vector signed short, vector signed short);
11256
11257 vector signed int vec_vmulesh (vector signed short,
11258                                vector signed short);
11259
11260 vector unsigned int vec_vmuleuh (vector unsigned short,
11261                                  vector unsigned short);
11262
11263 vector signed short vec_vmulesb (vector signed char,
11264                                  vector signed char);
11265
11266 vector unsigned short vec_vmuleub (vector unsigned char,
11267                                   vector unsigned char);
11268
11269 vector unsigned short vec_mulo (vector unsigned char,
11270                                 vector unsigned char);
11271 vector signed short vec_mulo (vector signed char, vector signed char);
11272 vector unsigned int vec_mulo (vector unsigned short,
11273                               vector unsigned short);
11274 vector signed int vec_mulo (vector signed short, vector signed short);
11275
11276 vector signed int vec_vmulosh (vector signed short,
11277                                vector signed short);
11278
11279 vector unsigned int vec_vmulouh (vector unsigned short,
11280                                  vector unsigned short);
11281
11282 vector signed short vec_vmulosb (vector signed char,
11283                                  vector signed char);
11284
11285 vector unsigned short vec_vmuloub (vector unsigned char,
11286                                    vector unsigned char);
11287
11288 vector float vec_nmsub (vector float, vector float, vector float);
11289
11290 vector float vec_nor (vector float, vector float);
11291 vector signed int vec_nor (vector signed int, vector signed int);
11292 vector unsigned int vec_nor (vector unsigned int, vector unsigned int);
11293 vector bool int vec_nor (vector bool int, vector bool int);
11294 vector signed short vec_nor (vector signed short, vector signed short);
11295 vector unsigned short vec_nor (vector unsigned short,
11296                                vector unsigned short);
11297 vector bool short vec_nor (vector bool short, vector bool short);
11298 vector signed char vec_nor (vector signed char, vector signed char);
11299 vector unsigned char vec_nor (vector unsigned char,
11300                               vector unsigned char);
11301 vector bool char vec_nor (vector bool char, vector bool char);
11302
11303 vector float vec_or (vector float, vector float);
11304 vector float vec_or (vector float, vector bool int);
11305 vector float vec_or (vector bool int, vector float);
11306 vector bool int vec_or (vector bool int, vector bool int);
11307 vector signed int vec_or (vector bool int, vector signed int);
11308 vector signed int vec_or (vector signed int, vector bool int);
11309 vector signed int vec_or (vector signed int, vector signed int);
11310 vector unsigned int vec_or (vector bool int, vector unsigned int);
11311 vector unsigned int vec_or (vector unsigned int, vector bool int);
11312 vector unsigned int vec_or (vector unsigned int, vector unsigned int);
11313 vector bool short vec_or (vector bool short, vector bool short);
11314 vector signed short vec_or (vector bool short, vector signed short);
11315 vector signed short vec_or (vector signed short, vector bool short);
11316 vector signed short vec_or (vector signed short, vector signed short);
11317 vector unsigned short vec_or (vector bool short, vector unsigned short);
11318 vector unsigned short vec_or (vector unsigned short, vector bool short);
11319 vector unsigned short vec_or (vector unsigned short,
11320                               vector unsigned short);
11321 vector signed char vec_or (vector bool char, vector signed char);
11322 vector bool char vec_or (vector bool char, vector bool char);
11323 vector signed char vec_or (vector signed char, vector bool char);
11324 vector signed char vec_or (vector signed char, vector signed char);
11325 vector unsigned char vec_or (vector bool char, vector unsigned char);
11326 vector unsigned char vec_or (vector unsigned char, vector bool char);
11327 vector unsigned char vec_or (vector unsigned char,
11328                              vector unsigned char);
11329
11330 vector signed char vec_pack (vector signed short, vector signed short);
11331 vector unsigned char vec_pack (vector unsigned short,
11332                                vector unsigned short);
11333 vector bool char vec_pack (vector bool short, vector bool short);
11334 vector signed short vec_pack (vector signed int, vector signed int);
11335 vector unsigned short vec_pack (vector unsigned int,
11336                                 vector unsigned int);
11337 vector bool short vec_pack (vector bool int, vector bool int);
11338
11339 vector bool short vec_vpkuwum (vector bool int, vector bool int);
11340 vector signed short vec_vpkuwum (vector signed int, vector signed int);
11341 vector unsigned short vec_vpkuwum (vector unsigned int,
11342                                    vector unsigned int);
11343
11344 vector bool char vec_vpkuhum (vector bool short, vector bool short);
11345 vector signed char vec_vpkuhum (vector signed short,
11346                                 vector signed short);
11347 vector unsigned char vec_vpkuhum (vector unsigned short,
11348                                   vector unsigned short);
11349
11350 vector pixel vec_packpx (vector unsigned int, vector unsigned int);
11351
11352 vector unsigned char vec_packs (vector unsigned short,
11353                                 vector unsigned short);
11354 vector signed char vec_packs (vector signed short, vector signed short);
11355 vector unsigned short vec_packs (vector unsigned int,
11356                                  vector unsigned int);
11357 vector signed short vec_packs (vector signed int, vector signed int);
11358
11359 vector signed short vec_vpkswss (vector signed int, vector signed int);
11360
11361 vector unsigned short vec_vpkuwus (vector unsigned int,
11362                                    vector unsigned int);
11363
11364 vector signed char vec_vpkshss (vector signed short,
11365                                 vector signed short);
11366
11367 vector unsigned char vec_vpkuhus (vector unsigned short,
11368                                   vector unsigned short);
11369
11370 vector unsigned char vec_packsu (vector unsigned short,
11371                                  vector unsigned short);
11372 vector unsigned char vec_packsu (vector signed short,
11373                                  vector signed short);
11374 vector unsigned short vec_packsu (vector unsigned int,
11375                                   vector unsigned int);
11376 vector unsigned short vec_packsu (vector signed int, vector signed int);
11377
11378 vector unsigned short vec_vpkswus (vector signed int,
11379                                    vector signed int);
11380
11381 vector unsigned char vec_vpkshus (vector signed short,
11382                                   vector signed short);
11383
11384 vector float vec_perm (vector float,
11385                        vector float,
11386                        vector unsigned char);
11387 vector signed int vec_perm (vector signed int,
11388                             vector signed int,
11389                             vector unsigned char);
11390 vector unsigned int vec_perm (vector unsigned int,
11391                               vector unsigned int,
11392                               vector unsigned char);
11393 vector bool int vec_perm (vector bool int,
11394                           vector bool int,
11395                           vector unsigned char);
11396 vector signed short vec_perm (vector signed short,
11397                               vector signed short,
11398                               vector unsigned char);
11399 vector unsigned short vec_perm (vector unsigned short,
11400                                 vector unsigned short,
11401                                 vector unsigned char);
11402 vector bool short vec_perm (vector bool short,
11403                             vector bool short,
11404                             vector unsigned char);
11405 vector pixel vec_perm (vector pixel,
11406                        vector pixel,
11407                        vector unsigned char);
11408 vector signed char vec_perm (vector signed char,
11409                              vector signed char,
11410                              vector unsigned char);
11411 vector unsigned char vec_perm (vector unsigned char,
11412                                vector unsigned char,
11413                                vector unsigned char);
11414 vector bool char vec_perm (vector bool char,
11415                            vector bool char,
11416                            vector unsigned char);
11417
11418 vector float vec_re (vector float);
11419
11420 vector signed char vec_rl (vector signed char,
11421                            vector unsigned char);
11422 vector unsigned char vec_rl (vector unsigned char,
11423                              vector unsigned char);
11424 vector signed short vec_rl (vector signed short, vector unsigned short);
11425 vector unsigned short vec_rl (vector unsigned short,
11426                               vector unsigned short);
11427 vector signed int vec_rl (vector signed int, vector unsigned int);
11428 vector unsigned int vec_rl (vector unsigned int, vector unsigned int);
11429
11430 vector signed int vec_vrlw (vector signed int, vector unsigned int);
11431 vector unsigned int vec_vrlw (vector unsigned int, vector unsigned int);
11432
11433 vector signed short vec_vrlh (vector signed short,
11434                               vector unsigned short);
11435 vector unsigned short vec_vrlh (vector unsigned short,
11436                                 vector unsigned short);
11437
11438 vector signed char vec_vrlb (vector signed char, vector unsigned char);
11439 vector unsigned char vec_vrlb (vector unsigned char,
11440                                vector unsigned char);
11441
11442 vector float vec_round (vector float);
11443
11444 vector float vec_recip (vector float, vector float);
11445
11446 vector float vec_rsqrt (vector float);
11447
11448 vector float vec_rsqrte (vector float);
11449
11450 vector float vec_sel (vector float, vector float, vector bool int);
11451 vector float vec_sel (vector float, vector float, vector unsigned int);
11452 vector signed int vec_sel (vector signed int,
11453                            vector signed int,
11454                            vector bool int);
11455 vector signed int vec_sel (vector signed int,
11456                            vector signed int,
11457                            vector unsigned int);
11458 vector unsigned int vec_sel (vector unsigned int,
11459                              vector unsigned int,
11460                              vector bool int);
11461 vector unsigned int vec_sel (vector unsigned int,
11462                              vector unsigned int,
11463                              vector unsigned int);
11464 vector bool int vec_sel (vector bool int,
11465                          vector bool int,
11466                          vector bool int);
11467 vector bool int vec_sel (vector bool int,
11468                          vector bool int,
11469                          vector unsigned int);
11470 vector signed short vec_sel (vector signed short,
11471                              vector signed short,
11472                              vector bool short);
11473 vector signed short vec_sel (vector signed short,
11474                              vector signed short,
11475                              vector unsigned short);
11476 vector unsigned short vec_sel (vector unsigned short,
11477                                vector unsigned short,
11478                                vector bool short);
11479 vector unsigned short vec_sel (vector unsigned short,
11480                                vector unsigned short,
11481                                vector unsigned short);
11482 vector bool short vec_sel (vector bool short,
11483                            vector bool short,
11484                            vector bool short);
11485 vector bool short vec_sel (vector bool short,
11486                            vector bool short,
11487                            vector unsigned short);
11488 vector signed char vec_sel (vector signed char,
11489                             vector signed char,
11490                             vector bool char);
11491 vector signed char vec_sel (vector signed char,
11492                             vector signed char,
11493                             vector unsigned char);
11494 vector unsigned char vec_sel (vector unsigned char,
11495                               vector unsigned char,
11496                               vector bool char);
11497 vector unsigned char vec_sel (vector unsigned char,
11498                               vector unsigned char,
11499                               vector unsigned char);
11500 vector bool char vec_sel (vector bool char,
11501                           vector bool char,
11502                           vector bool char);
11503 vector bool char vec_sel (vector bool char,
11504                           vector bool char,
11505                           vector unsigned char);
11506
11507 vector signed char vec_sl (vector signed char,
11508                            vector unsigned char);
11509 vector unsigned char vec_sl (vector unsigned char,
11510                              vector unsigned char);
11511 vector signed short vec_sl (vector signed short, vector unsigned short);
11512 vector unsigned short vec_sl (vector unsigned short,
11513                               vector unsigned short);
11514 vector signed int vec_sl (vector signed int, vector unsigned int);
11515 vector unsigned int vec_sl (vector unsigned int, vector unsigned int);
11516
11517 vector signed int vec_vslw (vector signed int, vector unsigned int);
11518 vector unsigned int vec_vslw (vector unsigned int, vector unsigned int);
11519
11520 vector signed short vec_vslh (vector signed short,
11521                               vector unsigned short);
11522 vector unsigned short vec_vslh (vector unsigned short,
11523                                 vector unsigned short);
11524
11525 vector signed char vec_vslb (vector signed char, vector unsigned char);
11526 vector unsigned char vec_vslb (vector unsigned char,
11527                                vector unsigned char);
11528
11529 vector float vec_sld (vector float, vector float, const int);
11530 vector signed int vec_sld (vector signed int,
11531                            vector signed int,
11532                            const int);
11533 vector unsigned int vec_sld (vector unsigned int,
11534                              vector unsigned int,
11535                              const int);
11536 vector bool int vec_sld (vector bool int,
11537                          vector bool int,
11538                          const int);
11539 vector signed short vec_sld (vector signed short,
11540                              vector signed short,
11541                              const int);
11542 vector unsigned short vec_sld (vector unsigned short,
11543                                vector unsigned short,
11544                                const int);
11545 vector bool short vec_sld (vector bool short,
11546                            vector bool short,
11547                            const int);
11548 vector pixel vec_sld (vector pixel,
11549                       vector pixel,
11550                       const int);
11551 vector signed char vec_sld (vector signed char,
11552                             vector signed char,
11553                             const int);
11554 vector unsigned char vec_sld (vector unsigned char,
11555                               vector unsigned char,
11556                               const int);
11557 vector bool char vec_sld (vector bool char,
11558                           vector bool char,
11559                           const int);
11560
11561 vector signed int vec_sll (vector signed int,
11562                            vector unsigned int);
11563 vector signed int vec_sll (vector signed int,
11564                            vector unsigned short);
11565 vector signed int vec_sll (vector signed int,
11566                            vector unsigned char);
11567 vector unsigned int vec_sll (vector unsigned int,
11568                              vector unsigned int);
11569 vector unsigned int vec_sll (vector unsigned int,
11570                              vector unsigned short);
11571 vector unsigned int vec_sll (vector unsigned int,
11572                              vector unsigned char);
11573 vector bool int vec_sll (vector bool int,
11574                          vector unsigned int);
11575 vector bool int vec_sll (vector bool int,
11576                          vector unsigned short);
11577 vector bool int vec_sll (vector bool int,
11578                          vector unsigned char);
11579 vector signed short vec_sll (vector signed short,
11580                              vector unsigned int);
11581 vector signed short vec_sll (vector signed short,
11582                              vector unsigned short);
11583 vector signed short vec_sll (vector signed short,
11584                              vector unsigned char);
11585 vector unsigned short vec_sll (vector unsigned short,
11586                                vector unsigned int);
11587 vector unsigned short vec_sll (vector unsigned short,
11588                                vector unsigned short);
11589 vector unsigned short vec_sll (vector unsigned short,
11590                                vector unsigned char);
11591 vector bool short vec_sll (vector bool short, vector unsigned int);
11592 vector bool short vec_sll (vector bool short, vector unsigned short);
11593 vector bool short vec_sll (vector bool short, vector unsigned char);
11594 vector pixel vec_sll (vector pixel, vector unsigned int);
11595 vector pixel vec_sll (vector pixel, vector unsigned short);
11596 vector pixel vec_sll (vector pixel, vector unsigned char);
11597 vector signed char vec_sll (vector signed char, vector unsigned int);
11598 vector signed char vec_sll (vector signed char, vector unsigned short);
11599 vector signed char vec_sll (vector signed char, vector unsigned char);
11600 vector unsigned char vec_sll (vector unsigned char,
11601                               vector unsigned int);
11602 vector unsigned char vec_sll (vector unsigned char,
11603                               vector unsigned short);
11604 vector unsigned char vec_sll (vector unsigned char,
11605                               vector unsigned char);
11606 vector bool char vec_sll (vector bool char, vector unsigned int);
11607 vector bool char vec_sll (vector bool char, vector unsigned short);
11608 vector bool char vec_sll (vector bool char, vector unsigned char);
11609
11610 vector float vec_slo (vector float, vector signed char);
11611 vector float vec_slo (vector float, vector unsigned char);
11612 vector signed int vec_slo (vector signed int, vector signed char);
11613 vector signed int vec_slo (vector signed int, vector unsigned char);
11614 vector unsigned int vec_slo (vector unsigned int, vector signed char);
11615 vector unsigned int vec_slo (vector unsigned int, vector unsigned char);
11616 vector signed short vec_slo (vector signed short, vector signed char);
11617 vector signed short vec_slo (vector signed short, vector unsigned char);
11618 vector unsigned short vec_slo (vector unsigned short,
11619                                vector signed char);
11620 vector unsigned short vec_slo (vector unsigned short,
11621                                vector unsigned char);
11622 vector pixel vec_slo (vector pixel, vector signed char);
11623 vector pixel vec_slo (vector pixel, vector unsigned char);
11624 vector signed char vec_slo (vector signed char, vector signed char);
11625 vector signed char vec_slo (vector signed char, vector unsigned char);
11626 vector unsigned char vec_slo (vector unsigned char, vector signed char);
11627 vector unsigned char vec_slo (vector unsigned char,
11628                               vector unsigned char);
11629
11630 vector signed char vec_splat (vector signed char, const int);
11631 vector unsigned char vec_splat (vector unsigned char, const int);
11632 vector bool char vec_splat (vector bool char, const int);
11633 vector signed short vec_splat (vector signed short, const int);
11634 vector unsigned short vec_splat (vector unsigned short, const int);
11635 vector bool short vec_splat (vector bool short, const int);
11636 vector pixel vec_splat (vector pixel, const int);
11637 vector float vec_splat (vector float, const int);
11638 vector signed int vec_splat (vector signed int, const int);
11639 vector unsigned int vec_splat (vector unsigned int, const int);
11640 vector bool int vec_splat (vector bool int, const int);
11641
11642 vector float vec_vspltw (vector float, const int);
11643 vector signed int vec_vspltw (vector signed int, const int);
11644 vector unsigned int vec_vspltw (vector unsigned int, const int);
11645 vector bool int vec_vspltw (vector bool int, const int);
11646
11647 vector bool short vec_vsplth (vector bool short, const int);
11648 vector signed short vec_vsplth (vector signed short, const int);
11649 vector unsigned short vec_vsplth (vector unsigned short, const int);
11650 vector pixel vec_vsplth (vector pixel, const int);
11651
11652 vector signed char vec_vspltb (vector signed char, const int);
11653 vector unsigned char vec_vspltb (vector unsigned char, const int);
11654 vector bool char vec_vspltb (vector bool char, const int);
11655
11656 vector signed char vec_splat_s8 (const int);
11657
11658 vector signed short vec_splat_s16 (const int);
11659
11660 vector signed int vec_splat_s32 (const int);
11661
11662 vector unsigned char vec_splat_u8 (const int);
11663
11664 vector unsigned short vec_splat_u16 (const int);
11665
11666 vector unsigned int vec_splat_u32 (const int);
11667
11668 vector signed char vec_sr (vector signed char, vector unsigned char);
11669 vector unsigned char vec_sr (vector unsigned char,
11670                              vector unsigned char);
11671 vector signed short vec_sr (vector signed short,
11672                             vector unsigned short);
11673 vector unsigned short vec_sr (vector unsigned short,
11674                               vector unsigned short);
11675 vector signed int vec_sr (vector signed int, vector unsigned int);
11676 vector unsigned int vec_sr (vector unsigned int, vector unsigned int);
11677
11678 vector signed int vec_vsrw (vector signed int, vector unsigned int);
11679 vector unsigned int vec_vsrw (vector unsigned int, vector unsigned int);
11680
11681 vector signed short vec_vsrh (vector signed short,
11682                               vector unsigned short);
11683 vector unsigned short vec_vsrh (vector unsigned short,
11684                                 vector unsigned short);
11685
11686 vector signed char vec_vsrb (vector signed char, vector unsigned char);
11687 vector unsigned char vec_vsrb (vector unsigned char,
11688                                vector unsigned char);
11689
11690 vector signed char vec_sra (vector signed char, vector unsigned char);
11691 vector unsigned char vec_sra (vector unsigned char,
11692                               vector unsigned char);
11693 vector signed short vec_sra (vector signed short,
11694                              vector unsigned short);
11695 vector unsigned short vec_sra (vector unsigned short,
11696                                vector unsigned short);
11697 vector signed int vec_sra (vector signed int, vector unsigned int);
11698 vector unsigned int vec_sra (vector unsigned int, vector unsigned int);
11699
11700 vector signed int vec_vsraw (vector signed int, vector unsigned int);
11701 vector unsigned int vec_vsraw (vector unsigned int,
11702                                vector unsigned int);
11703
11704 vector signed short vec_vsrah (vector signed short,
11705                                vector unsigned short);
11706 vector unsigned short vec_vsrah (vector unsigned short,
11707                                  vector unsigned short);
11708
11709 vector signed char vec_vsrab (vector signed char, vector unsigned char);
11710 vector unsigned char vec_vsrab (vector unsigned char,
11711                                 vector unsigned char);
11712
11713 vector signed int vec_srl (vector signed int, vector unsigned int);
11714 vector signed int vec_srl (vector signed int, vector unsigned short);
11715 vector signed int vec_srl (vector signed int, vector unsigned char);
11716 vector unsigned int vec_srl (vector unsigned int, vector unsigned int);
11717 vector unsigned int vec_srl (vector unsigned int,
11718                              vector unsigned short);
11719 vector unsigned int vec_srl (vector unsigned int, vector unsigned char);
11720 vector bool int vec_srl (vector bool int, vector unsigned int);
11721 vector bool int vec_srl (vector bool int, vector unsigned short);
11722 vector bool int vec_srl (vector bool int, vector unsigned char);
11723 vector signed short vec_srl (vector signed short, vector unsigned int);
11724 vector signed short vec_srl (vector signed short,
11725                              vector unsigned short);
11726 vector signed short vec_srl (vector signed short, vector unsigned char);
11727 vector unsigned short vec_srl (vector unsigned short,
11728                                vector unsigned int);
11729 vector unsigned short vec_srl (vector unsigned short,
11730                                vector unsigned short);
11731 vector unsigned short vec_srl (vector unsigned short,
11732                                vector unsigned char);
11733 vector bool short vec_srl (vector bool short, vector unsigned int);
11734 vector bool short vec_srl (vector bool short, vector unsigned short);
11735 vector bool short vec_srl (vector bool short, vector unsigned char);
11736 vector pixel vec_srl (vector pixel, vector unsigned int);
11737 vector pixel vec_srl (vector pixel, vector unsigned short);
11738 vector pixel vec_srl (vector pixel, vector unsigned char);
11739 vector signed char vec_srl (vector signed char, vector unsigned int);
11740 vector signed char vec_srl (vector signed char, vector unsigned short);
11741 vector signed char vec_srl (vector signed char, vector unsigned char);
11742 vector unsigned char vec_srl (vector unsigned char,
11743                               vector unsigned int);
11744 vector unsigned char vec_srl (vector unsigned char,
11745                               vector unsigned short);
11746 vector unsigned char vec_srl (vector unsigned char,
11747                               vector unsigned char);
11748 vector bool char vec_srl (vector bool char, vector unsigned int);
11749 vector bool char vec_srl (vector bool char, vector unsigned short);
11750 vector bool char vec_srl (vector bool char, vector unsigned char);
11751
11752 vector float vec_sro (vector float, vector signed char);
11753 vector float vec_sro (vector float, vector unsigned char);
11754 vector signed int vec_sro (vector signed int, vector signed char);
11755 vector signed int vec_sro (vector signed int, vector unsigned char);
11756 vector unsigned int vec_sro (vector unsigned int, vector signed char);
11757 vector unsigned int vec_sro (vector unsigned int, vector unsigned char);
11758 vector signed short vec_sro (vector signed short, vector signed char);
11759 vector signed short vec_sro (vector signed short, vector unsigned char);
11760 vector unsigned short vec_sro (vector unsigned short,
11761                                vector signed char);
11762 vector unsigned short vec_sro (vector unsigned short,
11763                                vector unsigned char);
11764 vector pixel vec_sro (vector pixel, vector signed char);
11765 vector pixel vec_sro (vector pixel, vector unsigned char);
11766 vector signed char vec_sro (vector signed char, vector signed char);
11767 vector signed char vec_sro (vector signed char, vector unsigned char);
11768 vector unsigned char vec_sro (vector unsigned char, vector signed char);
11769 vector unsigned char vec_sro (vector unsigned char,
11770                               vector unsigned char);
11771
11772 void vec_st (vector float, int, vector float *);
11773 void vec_st (vector float, int, float *);
11774 void vec_st (vector signed int, int, vector signed int *);
11775 void vec_st (vector signed int, int, int *);
11776 void vec_st (vector unsigned int, int, vector unsigned int *);
11777 void vec_st (vector unsigned int, int, unsigned int *);
11778 void vec_st (vector bool int, int, vector bool int *);
11779 void vec_st (vector bool int, int, unsigned int *);
11780 void vec_st (vector bool int, int, int *);
11781 void vec_st (vector signed short, int, vector signed short *);
11782 void vec_st (vector signed short, int, short *);
11783 void vec_st (vector unsigned short, int, vector unsigned short *);
11784 void vec_st (vector unsigned short, int, unsigned short *);
11785 void vec_st (vector bool short, int, vector bool short *);
11786 void vec_st (vector bool short, int, unsigned short *);
11787 void vec_st (vector pixel, int, vector pixel *);
11788 void vec_st (vector pixel, int, unsigned short *);
11789 void vec_st (vector pixel, int, short *);
11790 void vec_st (vector bool short, int, short *);
11791 void vec_st (vector signed char, int, vector signed char *);
11792 void vec_st (vector signed char, int, signed char *);
11793 void vec_st (vector unsigned char, int, vector unsigned char *);
11794 void vec_st (vector unsigned char, int, unsigned char *);
11795 void vec_st (vector bool char, int, vector bool char *);
11796 void vec_st (vector bool char, int, unsigned char *);
11797 void vec_st (vector bool char, int, signed char *);
11798
11799 void vec_ste (vector signed char, int, signed char *);
11800 void vec_ste (vector unsigned char, int, unsigned char *);
11801 void vec_ste (vector bool char, int, signed char *);
11802 void vec_ste (vector bool char, int, unsigned char *);
11803 void vec_ste (vector signed short, int, short *);
11804 void vec_ste (vector unsigned short, int, unsigned short *);
11805 void vec_ste (vector bool short, int, short *);
11806 void vec_ste (vector bool short, int, unsigned short *);
11807 void vec_ste (vector pixel, int, short *);
11808 void vec_ste (vector pixel, int, unsigned short *);
11809 void vec_ste (vector float, int, float *);
11810 void vec_ste (vector signed int, int, int *);
11811 void vec_ste (vector unsigned int, int, unsigned int *);
11812 void vec_ste (vector bool int, int, int *);
11813 void vec_ste (vector bool int, int, unsigned int *);
11814
11815 void vec_stvewx (vector float, int, float *);
11816 void vec_stvewx (vector signed int, int, int *);
11817 void vec_stvewx (vector unsigned int, int, unsigned int *);
11818 void vec_stvewx (vector bool int, int, int *);
11819 void vec_stvewx (vector bool int, int, unsigned int *);
11820
11821 void vec_stvehx (vector signed short, int, short *);
11822 void vec_stvehx (vector unsigned short, int, unsigned short *);
11823 void vec_stvehx (vector bool short, int, short *);
11824 void vec_stvehx (vector bool short, int, unsigned short *);
11825 void vec_stvehx (vector pixel, int, short *);
11826 void vec_stvehx (vector pixel, int, unsigned short *);
11827
11828 void vec_stvebx (vector signed char, int, signed char *);
11829 void vec_stvebx (vector unsigned char, int, unsigned char *);
11830 void vec_stvebx (vector bool char, int, signed char *);
11831 void vec_stvebx (vector bool char, int, unsigned char *);
11832
11833 void vec_stl (vector float, int, vector float *);
11834 void vec_stl (vector float, int, float *);
11835 void vec_stl (vector signed int, int, vector signed int *);
11836 void vec_stl (vector signed int, int, int *);
11837 void vec_stl (vector unsigned int, int, vector unsigned int *);
11838 void vec_stl (vector unsigned int, int, unsigned int *);
11839 void vec_stl (vector bool int, int, vector bool int *);
11840 void vec_stl (vector bool int, int, unsigned int *);
11841 void vec_stl (vector bool int, int, int *);
11842 void vec_stl (vector signed short, int, vector signed short *);
11843 void vec_stl (vector signed short, int, short *);
11844 void vec_stl (vector unsigned short, int, vector unsigned short *);
11845 void vec_stl (vector unsigned short, int, unsigned short *);
11846 void vec_stl (vector bool short, int, vector bool short *);
11847 void vec_stl (vector bool short, int, unsigned short *);
11848 void vec_stl (vector bool short, int, short *);
11849 void vec_stl (vector pixel, int, vector pixel *);
11850 void vec_stl (vector pixel, int, unsigned short *);
11851 void vec_stl (vector pixel, int, short *);
11852 void vec_stl (vector signed char, int, vector signed char *);
11853 void vec_stl (vector signed char, int, signed char *);
11854 void vec_stl (vector unsigned char, int, vector unsigned char *);
11855 void vec_stl (vector unsigned char, int, unsigned char *);
11856 void vec_stl (vector bool char, int, vector bool char *);
11857 void vec_stl (vector bool char, int, unsigned char *);
11858 void vec_stl (vector bool char, int, signed char *);
11859
11860 vector signed char vec_sub (vector bool char, vector signed char);
11861 vector signed char vec_sub (vector signed char, vector bool char);
11862 vector signed char vec_sub (vector signed char, vector signed char);
11863 vector unsigned char vec_sub (vector bool char, vector unsigned char);
11864 vector unsigned char vec_sub (vector unsigned char, vector bool char);
11865 vector unsigned char vec_sub (vector unsigned char,
11866                               vector unsigned char);
11867 vector signed short vec_sub (vector bool short, vector signed short);
11868 vector signed short vec_sub (vector signed short, vector bool short);
11869 vector signed short vec_sub (vector signed short, vector signed short);
11870 vector unsigned short vec_sub (vector bool short,
11871                                vector unsigned short);
11872 vector unsigned short vec_sub (vector unsigned short,
11873                                vector bool short);
11874 vector unsigned short vec_sub (vector unsigned short,
11875                                vector unsigned short);
11876 vector signed int vec_sub (vector bool int, vector signed int);
11877 vector signed int vec_sub (vector signed int, vector bool int);
11878 vector signed int vec_sub (vector signed int, vector signed int);
11879 vector unsigned int vec_sub (vector bool int, vector unsigned int);
11880 vector unsigned int vec_sub (vector unsigned int, vector bool int);
11881 vector unsigned int vec_sub (vector unsigned int, vector unsigned int);
11882 vector float vec_sub (vector float, vector float);
11883
11884 vector float vec_vsubfp (vector float, vector float);
11885
11886 vector signed int vec_vsubuwm (vector bool int, vector signed int);
11887 vector signed int vec_vsubuwm (vector signed int, vector bool int);
11888 vector signed int vec_vsubuwm (vector signed int, vector signed int);
11889 vector unsigned int vec_vsubuwm (vector bool int, vector unsigned int);
11890 vector unsigned int vec_vsubuwm (vector unsigned int, vector bool int);
11891 vector unsigned int vec_vsubuwm (vector unsigned int,
11892                                  vector unsigned int);
11893
11894 vector signed short vec_vsubuhm (vector bool short,
11895                                  vector signed short);
11896 vector signed short vec_vsubuhm (vector signed short,
11897                                  vector bool short);
11898 vector signed short vec_vsubuhm (vector signed short,
11899                                  vector signed short);
11900 vector unsigned short vec_vsubuhm (vector bool short,
11901                                    vector unsigned short);
11902 vector unsigned short vec_vsubuhm (vector unsigned short,
11903                                    vector bool short);
11904 vector unsigned short vec_vsubuhm (vector unsigned short,
11905                                    vector unsigned short);
11906
11907 vector signed char vec_vsububm (vector bool char, vector signed char);
11908 vector signed char vec_vsububm (vector signed char, vector bool char);
11909 vector signed char vec_vsububm (vector signed char, vector signed char);
11910 vector unsigned char vec_vsububm (vector bool char,
11911                                   vector unsigned char);
11912 vector unsigned char vec_vsububm (vector unsigned char,
11913                                   vector bool char);
11914 vector unsigned char vec_vsububm (vector unsigned char,
11915                                   vector unsigned char);
11916
11917 vector unsigned int vec_subc (vector unsigned int, vector unsigned int);
11918
11919 vector unsigned char vec_subs (vector bool char, vector unsigned char);
11920 vector unsigned char vec_subs (vector unsigned char, vector bool char);
11921 vector unsigned char vec_subs (vector unsigned char,
11922                                vector unsigned char);
11923 vector signed char vec_subs (vector bool char, vector signed char);
11924 vector signed char vec_subs (vector signed char, vector bool char);
11925 vector signed char vec_subs (vector signed char, vector signed char);
11926 vector unsigned short vec_subs (vector bool short,
11927                                 vector unsigned short);
11928 vector unsigned short vec_subs (vector unsigned short,
11929                                 vector bool short);
11930 vector unsigned short vec_subs (vector unsigned short,
11931                                 vector unsigned short);
11932 vector signed short vec_subs (vector bool short, vector signed short);
11933 vector signed short vec_subs (vector signed short, vector bool short);
11934 vector signed short vec_subs (vector signed short, vector signed short);
11935 vector unsigned int vec_subs (vector bool int, vector unsigned int);
11936 vector unsigned int vec_subs (vector unsigned int, vector bool int);
11937 vector unsigned int vec_subs (vector unsigned int, vector unsigned int);
11938 vector signed int vec_subs (vector bool int, vector signed int);
11939 vector signed int vec_subs (vector signed int, vector bool int);
11940 vector signed int vec_subs (vector signed int, vector signed int);
11941
11942 vector signed int vec_vsubsws (vector bool int, vector signed int);
11943 vector signed int vec_vsubsws (vector signed int, vector bool int);
11944 vector signed int vec_vsubsws (vector signed int, vector signed int);
11945
11946 vector unsigned int vec_vsubuws (vector bool int, vector unsigned int);
11947 vector unsigned int vec_vsubuws (vector unsigned int, vector bool int);
11948 vector unsigned int vec_vsubuws (vector unsigned int,
11949                                  vector unsigned int);
11950
11951 vector signed short vec_vsubshs (vector bool short,
11952                                  vector signed short);
11953 vector signed short vec_vsubshs (vector signed short,
11954                                  vector bool short);
11955 vector signed short vec_vsubshs (vector signed short,
11956                                  vector signed short);
11957
11958 vector unsigned short vec_vsubuhs (vector bool short,
11959                                    vector unsigned short);
11960 vector unsigned short vec_vsubuhs (vector unsigned short,
11961                                    vector bool short);
11962 vector unsigned short vec_vsubuhs (vector unsigned short,
11963                                    vector unsigned short);
11964
11965 vector signed char vec_vsubsbs (vector bool char, vector signed char);
11966 vector signed char vec_vsubsbs (vector signed char, vector bool char);
11967 vector signed char vec_vsubsbs (vector signed char, vector signed char);
11968
11969 vector unsigned char vec_vsububs (vector bool char,
11970                                   vector unsigned char);
11971 vector unsigned char vec_vsububs (vector unsigned char,
11972                                   vector bool char);
11973 vector unsigned char vec_vsububs (vector unsigned char,
11974                                   vector unsigned char);
11975
11976 vector unsigned int vec_sum4s (vector unsigned char,
11977                                vector unsigned int);
11978 vector signed int vec_sum4s (vector signed char, vector signed int);
11979 vector signed int vec_sum4s (vector signed short, vector signed int);
11980
11981 vector signed int vec_vsum4shs (vector signed short, vector signed int);
11982
11983 vector signed int vec_vsum4sbs (vector signed char, vector signed int);
11984
11985 vector unsigned int vec_vsum4ubs (vector unsigned char,
11986                                   vector unsigned int);
11987
11988 vector signed int vec_sum2s (vector signed int, vector signed int);
11989
11990 vector signed int vec_sums (vector signed int, vector signed int);
11991
11992 vector float vec_trunc (vector float);
11993
11994 vector signed short vec_unpackh (vector signed char);
11995 vector bool short vec_unpackh (vector bool char);
11996 vector signed int vec_unpackh (vector signed short);
11997 vector bool int vec_unpackh (vector bool short);
11998 vector unsigned int vec_unpackh (vector pixel);
11999
12000 vector bool int vec_vupkhsh (vector bool short);
12001 vector signed int vec_vupkhsh (vector signed short);
12002
12003 vector unsigned int vec_vupkhpx (vector pixel);
12004
12005 vector bool short vec_vupkhsb (vector bool char);
12006 vector signed short vec_vupkhsb (vector signed char);
12007
12008 vector signed short vec_unpackl (vector signed char);
12009 vector bool short vec_unpackl (vector bool char);
12010 vector unsigned int vec_unpackl (vector pixel);
12011 vector signed int vec_unpackl (vector signed short);
12012 vector bool int vec_unpackl (vector bool short);
12013
12014 vector unsigned int vec_vupklpx (vector pixel);
12015
12016 vector bool int vec_vupklsh (vector bool short);
12017 vector signed int vec_vupklsh (vector signed short);
12018
12019 vector bool short vec_vupklsb (vector bool char);
12020 vector signed short vec_vupklsb (vector signed char);
12021
12022 vector float vec_xor (vector float, vector float);
12023 vector float vec_xor (vector float, vector bool int);
12024 vector float vec_xor (vector bool int, vector float);
12025 vector bool int vec_xor (vector bool int, vector bool int);
12026 vector signed int vec_xor (vector bool int, vector signed int);
12027 vector signed int vec_xor (vector signed int, vector bool int);
12028 vector signed int vec_xor (vector signed int, vector signed int);
12029 vector unsigned int vec_xor (vector bool int, vector unsigned int);
12030 vector unsigned int vec_xor (vector unsigned int, vector bool int);
12031 vector unsigned int vec_xor (vector unsigned int, vector unsigned int);
12032 vector bool short vec_xor (vector bool short, vector bool short);
12033 vector signed short vec_xor (vector bool short, vector signed short);
12034 vector signed short vec_xor (vector signed short, vector bool short);
12035 vector signed short vec_xor (vector signed short, vector signed short);
12036 vector unsigned short vec_xor (vector bool short,
12037                                vector unsigned short);
12038 vector unsigned short vec_xor (vector unsigned short,
12039                                vector bool short);
12040 vector unsigned short vec_xor (vector unsigned short,
12041                                vector unsigned short);
12042 vector signed char vec_xor (vector bool char, vector signed char);
12043 vector bool char vec_xor (vector bool char, vector bool char);
12044 vector signed char vec_xor (vector signed char, vector bool char);
12045 vector signed char vec_xor (vector signed char, vector signed char);
12046 vector unsigned char vec_xor (vector bool char, vector unsigned char);
12047 vector unsigned char vec_xor (vector unsigned char, vector bool char);
12048 vector unsigned char vec_xor (vector unsigned char,
12049                               vector unsigned char);
12050
12051 int vec_all_eq (vector signed char, vector bool char);
12052 int vec_all_eq (vector signed char, vector signed char);
12053 int vec_all_eq (vector unsigned char, vector bool char);
12054 int vec_all_eq (vector unsigned char, vector unsigned char);
12055 int vec_all_eq (vector bool char, vector bool char);
12056 int vec_all_eq (vector bool char, vector unsigned char);
12057 int vec_all_eq (vector bool char, vector signed char);
12058 int vec_all_eq (vector signed short, vector bool short);
12059 int vec_all_eq (vector signed short, vector signed short);
12060 int vec_all_eq (vector unsigned short, vector bool short);
12061 int vec_all_eq (vector unsigned short, vector unsigned short);
12062 int vec_all_eq (vector bool short, vector bool short);
12063 int vec_all_eq (vector bool short, vector unsigned short);
12064 int vec_all_eq (vector bool short, vector signed short);
12065 int vec_all_eq (vector pixel, vector pixel);
12066 int vec_all_eq (vector signed int, vector bool int);
12067 int vec_all_eq (vector signed int, vector signed int);
12068 int vec_all_eq (vector unsigned int, vector bool int);
12069 int vec_all_eq (vector unsigned int, vector unsigned int);
12070 int vec_all_eq (vector bool int, vector bool int);
12071 int vec_all_eq (vector bool int, vector unsigned int);
12072 int vec_all_eq (vector bool int, vector signed int);
12073 int vec_all_eq (vector float, vector float);
12074
12075 int vec_all_ge (vector bool char, vector unsigned char);
12076 int vec_all_ge (vector unsigned char, vector bool char);
12077 int vec_all_ge (vector unsigned char, vector unsigned char);
12078 int vec_all_ge (vector bool char, vector signed char);
12079 int vec_all_ge (vector signed char, vector bool char);
12080 int vec_all_ge (vector signed char, vector signed char);
12081 int vec_all_ge (vector bool short, vector unsigned short);
12082 int vec_all_ge (vector unsigned short, vector bool short);
12083 int vec_all_ge (vector unsigned short, vector unsigned short);
12084 int vec_all_ge (vector signed short, vector signed short);
12085 int vec_all_ge (vector bool short, vector signed short);
12086 int vec_all_ge (vector signed short, vector bool short);
12087 int vec_all_ge (vector bool int, vector unsigned int);
12088 int vec_all_ge (vector unsigned int, vector bool int);
12089 int vec_all_ge (vector unsigned int, vector unsigned int);
12090 int vec_all_ge (vector bool int, vector signed int);
12091 int vec_all_ge (vector signed int, vector bool int);
12092 int vec_all_ge (vector signed int, vector signed int);
12093 int vec_all_ge (vector float, vector float);
12094
12095 int vec_all_gt (vector bool char, vector unsigned char);
12096 int vec_all_gt (vector unsigned char, vector bool char);
12097 int vec_all_gt (vector unsigned char, vector unsigned char);
12098 int vec_all_gt (vector bool char, vector signed char);
12099 int vec_all_gt (vector signed char, vector bool char);
12100 int vec_all_gt (vector signed char, vector signed char);
12101 int vec_all_gt (vector bool short, vector unsigned short);
12102 int vec_all_gt (vector unsigned short, vector bool short);
12103 int vec_all_gt (vector unsigned short, vector unsigned short);
12104 int vec_all_gt (vector bool short, vector signed short);
12105 int vec_all_gt (vector signed short, vector bool short);
12106 int vec_all_gt (vector signed short, vector signed short);
12107 int vec_all_gt (vector bool int, vector unsigned int);
12108 int vec_all_gt (vector unsigned int, vector bool int);
12109 int vec_all_gt (vector unsigned int, vector unsigned int);
12110 int vec_all_gt (vector bool int, vector signed int);
12111 int vec_all_gt (vector signed int, vector bool int);
12112 int vec_all_gt (vector signed int, vector signed int);
12113 int vec_all_gt (vector float, vector float);
12114
12115 int vec_all_in (vector float, vector float);
12116
12117 int vec_all_le (vector bool char, vector unsigned char);
12118 int vec_all_le (vector unsigned char, vector bool char);
12119 int vec_all_le (vector unsigned char, vector unsigned char);
12120 int vec_all_le (vector bool char, vector signed char);
12121 int vec_all_le (vector signed char, vector bool char);
12122 int vec_all_le (vector signed char, vector signed char);
12123 int vec_all_le (vector bool short, vector unsigned short);
12124 int vec_all_le (vector unsigned short, vector bool short);
12125 int vec_all_le (vector unsigned short, vector unsigned short);
12126 int vec_all_le (vector bool short, vector signed short);
12127 int vec_all_le (vector signed short, vector bool short);
12128 int vec_all_le (vector signed short, vector signed short);
12129 int vec_all_le (vector bool int, vector unsigned int);
12130 int vec_all_le (vector unsigned int, vector bool int);
12131 int vec_all_le (vector unsigned int, vector unsigned int);
12132 int vec_all_le (vector bool int, vector signed int);
12133 int vec_all_le (vector signed int, vector bool int);
12134 int vec_all_le (vector signed int, vector signed int);
12135 int vec_all_le (vector float, vector float);
12136
12137 int vec_all_lt (vector bool char, vector unsigned char);
12138 int vec_all_lt (vector unsigned char, vector bool char);
12139 int vec_all_lt (vector unsigned char, vector unsigned char);
12140 int vec_all_lt (vector bool char, vector signed char);
12141 int vec_all_lt (vector signed char, vector bool char);
12142 int vec_all_lt (vector signed char, vector signed char);
12143 int vec_all_lt (vector bool short, vector unsigned short);
12144 int vec_all_lt (vector unsigned short, vector bool short);
12145 int vec_all_lt (vector unsigned short, vector unsigned short);
12146 int vec_all_lt (vector bool short, vector signed short);
12147 int vec_all_lt (vector signed short, vector bool short);
12148 int vec_all_lt (vector signed short, vector signed short);
12149 int vec_all_lt (vector bool int, vector unsigned int);
12150 int vec_all_lt (vector unsigned int, vector bool int);
12151 int vec_all_lt (vector unsigned int, vector unsigned int);
12152 int vec_all_lt (vector bool int, vector signed int);
12153 int vec_all_lt (vector signed int, vector bool int);
12154 int vec_all_lt (vector signed int, vector signed int);
12155 int vec_all_lt (vector float, vector float);
12156
12157 int vec_all_nan (vector float);
12158
12159 int vec_all_ne (vector signed char, vector bool char);
12160 int vec_all_ne (vector signed char, vector signed char);
12161 int vec_all_ne (vector unsigned char, vector bool char);
12162 int vec_all_ne (vector unsigned char, vector unsigned char);
12163 int vec_all_ne (vector bool char, vector bool char);
12164 int vec_all_ne (vector bool char, vector unsigned char);
12165 int vec_all_ne (vector bool char, vector signed char);
12166 int vec_all_ne (vector signed short, vector bool short);
12167 int vec_all_ne (vector signed short, vector signed short);
12168 int vec_all_ne (vector unsigned short, vector bool short);
12169 int vec_all_ne (vector unsigned short, vector unsigned short);
12170 int vec_all_ne (vector bool short, vector bool short);
12171 int vec_all_ne (vector bool short, vector unsigned short);
12172 int vec_all_ne (vector bool short, vector signed short);
12173 int vec_all_ne (vector pixel, vector pixel);
12174 int vec_all_ne (vector signed int, vector bool int);
12175 int vec_all_ne (vector signed int, vector signed int);
12176 int vec_all_ne (vector unsigned int, vector bool int);
12177 int vec_all_ne (vector unsigned int, vector unsigned int);
12178 int vec_all_ne (vector bool int, vector bool int);
12179 int vec_all_ne (vector bool int, vector unsigned int);
12180 int vec_all_ne (vector bool int, vector signed int);
12181 int vec_all_ne (vector float, vector float);
12182
12183 int vec_all_nge (vector float, vector float);
12184
12185 int vec_all_ngt (vector float, vector float);
12186
12187 int vec_all_nle (vector float, vector float);
12188
12189 int vec_all_nlt (vector float, vector float);
12190
12191 int vec_all_numeric (vector float);
12192
12193 int vec_any_eq (vector signed char, vector bool char);
12194 int vec_any_eq (vector signed char, vector signed char);
12195 int vec_any_eq (vector unsigned char, vector bool char);
12196 int vec_any_eq (vector unsigned char, vector unsigned char);
12197 int vec_any_eq (vector bool char, vector bool char);
12198 int vec_any_eq (vector bool char, vector unsigned char);
12199 int vec_any_eq (vector bool char, vector signed char);
12200 int vec_any_eq (vector signed short, vector bool short);
12201 int vec_any_eq (vector signed short, vector signed short);
12202 int vec_any_eq (vector unsigned short, vector bool short);
12203 int vec_any_eq (vector unsigned short, vector unsigned short);
12204 int vec_any_eq (vector bool short, vector bool short);
12205 int vec_any_eq (vector bool short, vector unsigned short);
12206 int vec_any_eq (vector bool short, vector signed short);
12207 int vec_any_eq (vector pixel, vector pixel);
12208 int vec_any_eq (vector signed int, vector bool int);
12209 int vec_any_eq (vector signed int, vector signed int);
12210 int vec_any_eq (vector unsigned int, vector bool int);
12211 int vec_any_eq (vector unsigned int, vector unsigned int);
12212 int vec_any_eq (vector bool int, vector bool int);
12213 int vec_any_eq (vector bool int, vector unsigned int);
12214 int vec_any_eq (vector bool int, vector signed int);
12215 int vec_any_eq (vector float, vector float);
12216
12217 int vec_any_ge (vector signed char, vector bool char);
12218 int vec_any_ge (vector unsigned char, vector bool char);
12219 int vec_any_ge (vector unsigned char, vector unsigned char);
12220 int vec_any_ge (vector signed char, vector signed char);
12221 int vec_any_ge (vector bool char, vector unsigned char);
12222 int vec_any_ge (vector bool char, vector signed char);
12223 int vec_any_ge (vector unsigned short, vector bool short);
12224 int vec_any_ge (vector unsigned short, vector unsigned short);
12225 int vec_any_ge (vector signed short, vector signed short);
12226 int vec_any_ge (vector signed short, vector bool short);
12227 int vec_any_ge (vector bool short, vector unsigned short);
12228 int vec_any_ge (vector bool short, vector signed short);
12229 int vec_any_ge (vector signed int, vector bool int);
12230 int vec_any_ge (vector unsigned int, vector bool int);
12231 int vec_any_ge (vector unsigned int, vector unsigned int);
12232 int vec_any_ge (vector signed int, vector signed int);
12233 int vec_any_ge (vector bool int, vector unsigned int);
12234 int vec_any_ge (vector bool int, vector signed int);
12235 int vec_any_ge (vector float, vector float);
12236
12237 int vec_any_gt (vector bool char, vector unsigned char);
12238 int vec_any_gt (vector unsigned char, vector bool char);
12239 int vec_any_gt (vector unsigned char, vector unsigned char);
12240 int vec_any_gt (vector bool char, vector signed char);
12241 int vec_any_gt (vector signed char, vector bool char);
12242 int vec_any_gt (vector signed char, vector signed char);
12243 int vec_any_gt (vector bool short, vector unsigned short);
12244 int vec_any_gt (vector unsigned short, vector bool short);
12245 int vec_any_gt (vector unsigned short, vector unsigned short);
12246 int vec_any_gt (vector bool short, vector signed short);
12247 int vec_any_gt (vector signed short, vector bool short);
12248 int vec_any_gt (vector signed short, vector signed short);
12249 int vec_any_gt (vector bool int, vector unsigned int);
12250 int vec_any_gt (vector unsigned int, vector bool int);
12251 int vec_any_gt (vector unsigned int, vector unsigned int);
12252 int vec_any_gt (vector bool int, vector signed int);
12253 int vec_any_gt (vector signed int, vector bool int);
12254 int vec_any_gt (vector signed int, vector signed int);
12255 int vec_any_gt (vector float, vector float);
12256
12257 int vec_any_le (vector bool char, vector unsigned char);
12258 int vec_any_le (vector unsigned char, vector bool char);
12259 int vec_any_le (vector unsigned char, vector unsigned char);
12260 int vec_any_le (vector bool char, vector signed char);
12261 int vec_any_le (vector signed char, vector bool char);
12262 int vec_any_le (vector signed char, vector signed char);
12263 int vec_any_le (vector bool short, vector unsigned short);
12264 int vec_any_le (vector unsigned short, vector bool short);
12265 int vec_any_le (vector unsigned short, vector unsigned short);
12266 int vec_any_le (vector bool short, vector signed short);
12267 int vec_any_le (vector signed short, vector bool short);
12268 int vec_any_le (vector signed short, vector signed short);
12269 int vec_any_le (vector bool int, vector unsigned int);
12270 int vec_any_le (vector unsigned int, vector bool int);
12271 int vec_any_le (vector unsigned int, vector unsigned int);
12272 int vec_any_le (vector bool int, vector signed int);
12273 int vec_any_le (vector signed int, vector bool int);
12274 int vec_any_le (vector signed int, vector signed int);
12275 int vec_any_le (vector float, vector float);
12276
12277 int vec_any_lt (vector bool char, vector unsigned char);
12278 int vec_any_lt (vector unsigned char, vector bool char);
12279 int vec_any_lt (vector unsigned char, vector unsigned char);
12280 int vec_any_lt (vector bool char, vector signed char);
12281 int vec_any_lt (vector signed char, vector bool char);
12282 int vec_any_lt (vector signed char, vector signed char);
12283 int vec_any_lt (vector bool short, vector unsigned short);
12284 int vec_any_lt (vector unsigned short, vector bool short);
12285 int vec_any_lt (vector unsigned short, vector unsigned short);
12286 int vec_any_lt (vector bool short, vector signed short);
12287 int vec_any_lt (vector signed short, vector bool short);
12288 int vec_any_lt (vector signed short, vector signed short);
12289 int vec_any_lt (vector bool int, vector unsigned int);
12290 int vec_any_lt (vector unsigned int, vector bool int);
12291 int vec_any_lt (vector unsigned int, vector unsigned int);
12292 int vec_any_lt (vector bool int, vector signed int);
12293 int vec_any_lt (vector signed int, vector bool int);
12294 int vec_any_lt (vector signed int, vector signed int);
12295 int vec_any_lt (vector float, vector float);
12296
12297 int vec_any_nan (vector float);
12298
12299 int vec_any_ne (vector signed char, vector bool char);
12300 int vec_any_ne (vector signed char, vector signed char);
12301 int vec_any_ne (vector unsigned char, vector bool char);
12302 int vec_any_ne (vector unsigned char, vector unsigned char);
12303 int vec_any_ne (vector bool char, vector bool char);
12304 int vec_any_ne (vector bool char, vector unsigned char);
12305 int vec_any_ne (vector bool char, vector signed char);
12306 int vec_any_ne (vector signed short, vector bool short);
12307 int vec_any_ne (vector signed short, vector signed short);
12308 int vec_any_ne (vector unsigned short, vector bool short);
12309 int vec_any_ne (vector unsigned short, vector unsigned short);
12310 int vec_any_ne (vector bool short, vector bool short);
12311 int vec_any_ne (vector bool short, vector unsigned short);
12312 int vec_any_ne (vector bool short, vector signed short);
12313 int vec_any_ne (vector pixel, vector pixel);
12314 int vec_any_ne (vector signed int, vector bool int);
12315 int vec_any_ne (vector signed int, vector signed int);
12316 int vec_any_ne (vector unsigned int, vector bool int);
12317 int vec_any_ne (vector unsigned int, vector unsigned int);
12318 int vec_any_ne (vector bool int, vector bool int);
12319 int vec_any_ne (vector bool int, vector unsigned int);
12320 int vec_any_ne (vector bool int, vector signed int);
12321 int vec_any_ne (vector float, vector float);
12322
12323 int vec_any_nge (vector float, vector float);
12324
12325 int vec_any_ngt (vector float, vector float);
12326
12327 int vec_any_nle (vector float, vector float);
12328
12329 int vec_any_nlt (vector float, vector float);
12330
12331 int vec_any_numeric (vector float);
12332
12333 int vec_any_out (vector float, vector float);
12334 @end smallexample
12335
12336 If the vector/scalar (VSX) instruction set is available, the following
12337 additional functions are available:
12338
12339 @smallexample
12340 vector double vec_abs (vector double);
12341 vector double vec_add (vector double, vector double);
12342 vector double vec_and (vector double, vector double);
12343 vector double vec_and (vector double, vector bool long);
12344 vector double vec_and (vector bool long, vector double);
12345 vector double vec_andc (vector double, vector double);
12346 vector double vec_andc (vector double, vector bool long);
12347 vector double vec_andc (vector bool long, vector double);
12348 vector double vec_ceil (vector double);
12349 vector bool long vec_cmpeq (vector double, vector double);
12350 vector bool long vec_cmpge (vector double, vector double);
12351 vector bool long vec_cmpgt (vector double, vector double);
12352 vector bool long vec_cmple (vector double, vector double);
12353 vector bool long vec_cmplt (vector double, vector double);
12354 vector float vec_div (vector float, vector float);
12355 vector double vec_div (vector double, vector double);
12356 vector double vec_floor (vector double);
12357 vector double vec_madd (vector double, vector double, vector double);
12358 vector double vec_max (vector double, vector double);
12359 vector double vec_min (vector double, vector double);
12360 vector float vec_msub (vector float, vector float, vector float);
12361 vector double vec_msub (vector double, vector double, vector double);
12362 vector float vec_mul (vector float, vector float);
12363 vector double vec_mul (vector double, vector double);
12364 vector float vec_nearbyint (vector float);
12365 vector double vec_nearbyint (vector double);
12366 vector float vec_nmadd (vector float, vector float, vector float);
12367 vector double vec_nmadd (vector double, vector double, vector double);
12368 vector double vec_nmsub (vector double, vector double, vector double);
12369 vector double vec_nor (vector double, vector double);
12370 vector double vec_or (vector double, vector double);
12371 vector double vec_or (vector double, vector bool long);
12372 vector double vec_or (vector bool long, vector double);
12373 vector double vec_perm (vector double,
12374                         vector double,
12375                         vector unsigned char);
12376 vector double vec_rint (vector double);
12377 vector double vec_recip (vector double, vector double);
12378 vector double vec_rsqrt (vector double);
12379 vector double vec_rsqrte (vector double);
12380 vector double vec_sel (vector double, vector double, vector bool long);
12381 vector double vec_sel (vector double, vector double, vector unsigned long);
12382 vector double vec_sub (vector double, vector double);
12383 vector float vec_sqrt (vector float);
12384 vector double vec_sqrt (vector double);
12385 vector double vec_trunc (vector double);
12386 vector double vec_xor (vector double, vector double);
12387 vector double vec_xor (vector double, vector bool long);
12388 vector double vec_xor (vector bool long, vector double);
12389 int vec_all_eq (vector double, vector double);
12390 int vec_all_ge (vector double, vector double);
12391 int vec_all_gt (vector double, vector double);
12392 int vec_all_le (vector double, vector double);
12393 int vec_all_lt (vector double, vector double);
12394 int vec_all_nan (vector double);
12395 int vec_all_ne (vector double, vector double);
12396 int vec_all_nge (vector double, vector double);
12397 int vec_all_ngt (vector double, vector double);
12398 int vec_all_nle (vector double, vector double);
12399 int vec_all_nlt (vector double, vector double);
12400 int vec_all_numeric (vector double);
12401 int vec_any_eq (vector double, vector double);
12402 int vec_any_ge (vector double, vector double);
12403 int vec_any_gt (vector double, vector double);
12404 int vec_any_le (vector double, vector double);
12405 int vec_any_lt (vector double, vector double);
12406 int vec_any_nan (vector double);
12407 int vec_any_ne (vector double, vector double);
12408 int vec_any_nge (vector double, vector double);
12409 int vec_any_ngt (vector double, vector double);
12410 int vec_any_nle (vector double, vector double);
12411 int vec_any_nlt (vector double, vector double);
12412 int vec_any_numeric (vector double);
12413 @end smallexample
12414
12415 GCC provides a few other builtins on Powerpc to access certain instructions:
12416 @smallexample
12417 float __builtin_recipdivf (float, float);
12418 float __builtin_rsqrtf (float);
12419 double __builtin_recipdiv (double, double);
12420 double __builtin_rsqrt (double);
12421 long __builtin_bpermd (long, long);
12422 int __builtin_bswap16 (int);
12423 @end smallexample
12424
12425 The @code{vec_rsqrt}, @code{__builtin_rsqrt}, and
12426 @code{__builtin_rsqrtf} functions generate multiple instructions to
12427 implement the reciprocal sqrt functionality using reciprocal sqrt
12428 estimate instructions.
12429
12430 The @code{__builtin_recipdiv}, and @code{__builtin_recipdivf}
12431 functions generate multiple instructions to implement division using
12432 the reciprocal estimate instructions.
12433
12434 @node RX Built-in Functions
12435 @subsection RX Built-in Functions
12436 GCC supports some of the RX instructions which cannot be expressed in
12437 the C programming language via the use of built-in functions.  The
12438 following functions are supported:
12439
12440 @deftypefn {Built-in Function}  void __builtin_rx_brk (void)
12441 Generates the @code{brk} machine instruction.
12442 @end deftypefn
12443
12444 @deftypefn {Built-in Function}  void __builtin_rx_clrpsw (int)
12445 Generates the @code{clrpsw} machine instruction to clear the specified
12446 bit in the processor status word.
12447 @end deftypefn
12448
12449 @deftypefn {Built-in Function}  void __builtin_rx_int (int)
12450 Generates the @code{int} machine instruction to generate an interrupt
12451 with the specified value.
12452 @end deftypefn
12453
12454 @deftypefn {Built-in Function}  void __builtin_rx_machi (int, int)
12455 Generates the @code{machi} machine instruction to add the result of
12456 multiplying the top 16-bits of the two arguments into the
12457 accumulator.
12458 @end deftypefn
12459
12460 @deftypefn {Built-in Function}  void __builtin_rx_maclo (int, int)
12461 Generates the @code{maclo} machine instruction to add the result of
12462 multiplying the bottom 16-bits of the two arguments into the
12463 accumulator.
12464 @end deftypefn
12465
12466 @deftypefn {Built-in Function}  void __builtin_rx_mulhi (int, int)
12467 Generates the @code{mulhi} machine instruction to place the result of
12468 multiplying the top 16-bits of the two arguments into the
12469 accumulator.
12470 @end deftypefn
12471
12472 @deftypefn {Built-in Function}  void __builtin_rx_mullo (int, int)
12473 Generates the @code{mullo} machine instruction to place the result of
12474 multiplying the bottom 16-bits of the two arguments into the
12475 accumulator.
12476 @end deftypefn
12477
12478 @deftypefn {Built-in Function}  int  __builtin_rx_mvfachi (void)
12479 Generates the @code{mvfachi} machine instruction to read the top
12480 32-bits of the accumulator.
12481 @end deftypefn
12482
12483 @deftypefn {Built-in Function}  int  __builtin_rx_mvfacmi (void)
12484 Generates the @code{mvfacmi} machine instruction to read the middle
12485 32-bits of the accumulator.
12486 @end deftypefn
12487
12488 @deftypefn {Built-in Function}  int __builtin_rx_mvfc (int)
12489 Generates the @code{mvfc} machine instruction which reads the control
12490 register specified in its argument and returns its value.
12491 @end deftypefn
12492
12493 @deftypefn {Built-in Function}  void __builtin_rx_mvtachi (int)
12494 Generates the @code{mvtachi} machine instruction to set the top
12495 32-bits of the accumulator.
12496 @end deftypefn
12497
12498 @deftypefn {Built-in Function}  void __builtin_rx_mvtaclo (int)
12499 Generates the @code{mvtaclo} machine instruction to set the bottom
12500 32-bits of the accumulator.
12501 @end deftypefn
12502
12503 @deftypefn {Built-in Function}  void __builtin_rx_mvtc (int reg, int val)
12504 Generates the @code{mvtc} machine instruction which sets control
12505 register number @code{reg} to @code{val}.
12506 @end deftypefn
12507
12508 @deftypefn {Built-in Function}  void __builtin_rx_mvtipl (int)
12509 Generates the @code{mvtipl} machine instruction set the interrupt
12510 priority level.
12511 @end deftypefn
12512
12513 @deftypefn {Built-in Function}  void __builtin_rx_racw (int)
12514 Generates the @code{racw} machine instruction to round the accumulator
12515 according to the specified mode.
12516 @end deftypefn
12517
12518 @deftypefn {Built-in Function}  int __builtin_rx_revw (int)
12519 Generates the @code{revw} machine instruction which swaps the bytes in
12520 the argument so that bits 0--7 now occupy bits 8--15 and vice versa,
12521 and also bits 16--23 occupy bits 24--31 and vice versa.
12522 @end deftypefn
12523
12524 @deftypefn {Built-in Function}  void __builtin_rx_rmpa (void)
12525 Generates the @code{rmpa} machine instruction which initiates a
12526 repeated multiply and accumulate sequence.
12527 @end deftypefn
12528
12529 @deftypefn {Built-in Function}  void __builtin_rx_round (float)
12530 Generates the @code{round} machine instruction which returns the
12531 floating point argument rounded according to the current rounding mode
12532 set in the floating point status word register.
12533 @end deftypefn
12534
12535 @deftypefn {Built-in Function}  int __builtin_rx_sat (int)
12536 Generates the @code{sat} machine instruction which returns the
12537 saturated value of the argument.
12538 @end deftypefn
12539
12540 @deftypefn {Built-in Function}  void __builtin_rx_setpsw (int)
12541 Generates the @code{setpsw} machine instruction to set the specified
12542 bit in the processor status word.
12543 @end deftypefn
12544
12545 @deftypefn {Built-in Function}  void __builtin_rx_wait (void)
12546 Generates the @code{wait} machine instruction.
12547 @end deftypefn
12548
12549 @node SPARC VIS Built-in Functions
12550 @subsection SPARC VIS Built-in Functions
12551
12552 GCC supports SIMD operations on the SPARC using both the generic vector
12553 extensions (@pxref{Vector Extensions}) as well as built-in functions for
12554 the SPARC Visual Instruction Set (VIS).  When you use the @option{-mvis}
12555 switch, the VIS extension is exposed as the following built-in functions:
12556
12557 @smallexample
12558 typedef int v2si __attribute__ ((vector_size (8)));
12559 typedef short v4hi __attribute__ ((vector_size (8)));
12560 typedef short v2hi __attribute__ ((vector_size (4)));
12561 typedef char v8qi __attribute__ ((vector_size (8)));
12562 typedef char v4qi __attribute__ ((vector_size (4)));
12563
12564 void * __builtin_vis_alignaddr (void *, long);
12565 int64_t __builtin_vis_faligndatadi (int64_t, int64_t);
12566 v2si __builtin_vis_faligndatav2si (v2si, v2si);
12567 v4hi __builtin_vis_faligndatav4hi (v4si, v4si);
12568 v8qi __builtin_vis_faligndatav8qi (v8qi, v8qi);
12569
12570 v4hi __builtin_vis_fexpand (v4qi);
12571
12572 v4hi __builtin_vis_fmul8x16 (v4qi, v4hi);
12573 v4hi __builtin_vis_fmul8x16au (v4qi, v4hi);
12574 v4hi __builtin_vis_fmul8x16al (v4qi, v4hi);
12575 v4hi __builtin_vis_fmul8sux16 (v8qi, v4hi);
12576 v4hi __builtin_vis_fmul8ulx16 (v8qi, v4hi);
12577 v2si __builtin_vis_fmuld8sux16 (v4qi, v2hi);
12578 v2si __builtin_vis_fmuld8ulx16 (v4qi, v2hi);
12579
12580 v4qi __builtin_vis_fpack16 (v4hi);
12581 v8qi __builtin_vis_fpack32 (v2si, v2si);
12582 v2hi __builtin_vis_fpackfix (v2si);
12583 v8qi __builtin_vis_fpmerge (v4qi, v4qi);
12584
12585 int64_t __builtin_vis_pdist (v8qi, v8qi, int64_t);
12586 @end smallexample
12587
12588 @node SPU Built-in Functions
12589 @subsection SPU Built-in Functions
12590
12591 GCC provides extensions for the SPU processor as described in the
12592 Sony/Toshiba/IBM SPU Language Extensions Specification, which can be
12593 found at @uref{http://cell.scei.co.jp/} or
12594 @uref{http://www.ibm.com/developerworks/power/cell/}.  GCC's
12595 implementation differs in several ways.
12596
12597 @itemize @bullet
12598
12599 @item
12600 The optional extension of specifying vector constants in parentheses is
12601 not supported.
12602
12603 @item
12604 A vector initializer requires no cast if the vector constant is of the
12605 same type as the variable it is initializing.
12606
12607 @item
12608 If @code{signed} or @code{unsigned} is omitted, the signedness of the
12609 vector type is the default signedness of the base type.  The default
12610 varies depending on the operating system, so a portable program should
12611 always specify the signedness.
12612
12613 @item
12614 By default, the keyword @code{__vector} is added. The macro
12615 @code{vector} is defined in @code{<spu_intrinsics.h>} and can be
12616 undefined.
12617
12618 @item
12619 GCC allows using a @code{typedef} name as the type specifier for a
12620 vector type.
12621
12622 @item
12623 For C, overloaded functions are implemented with macros so the following
12624 does not work:
12625
12626 @smallexample
12627   spu_add ((vector signed int)@{1, 2, 3, 4@}, foo);
12628 @end smallexample
12629
12630 Since @code{spu_add} is a macro, the vector constant in the example
12631 is treated as four separate arguments.  Wrap the entire argument in
12632 parentheses for this to work.
12633
12634 @item
12635 The extended version of @code{__builtin_expect} is not supported.
12636
12637 @end itemize
12638
12639 @emph{Note:} Only the interface described in the aforementioned
12640 specification is supported. Internally, GCC uses built-in functions to
12641 implement the required functionality, but these are not supported and
12642 are subject to change without notice.
12643
12644 @node Target Format Checks
12645 @section Format Checks Specific to Particular Target Machines
12646
12647 For some target machines, GCC supports additional options to the
12648 format attribute
12649 (@pxref{Function Attributes,,Declaring Attributes of Functions}).
12650
12651 @menu
12652 * Solaris Format Checks::
12653 * Darwin Format Checks::
12654 @end menu
12655
12656 @node Solaris Format Checks
12657 @subsection Solaris Format Checks
12658
12659 Solaris targets support the @code{cmn_err} (or @code{__cmn_err__}) format
12660 check.  @code{cmn_err} accepts a subset of the standard @code{printf}
12661 conversions, and the two-argument @code{%b} conversion for displaying
12662 bit-fields.  See the Solaris man page for @code{cmn_err} for more information.
12663
12664 @node Darwin Format Checks
12665 @subsection Darwin Format Checks
12666
12667 Darwin targets support the @code{CFString} (or @code{__CFString__}) in the format 
12668 attribute context.  Declarations made with such attribution will be parsed for correct syntax
12669 and format argument types.  However, parsing of the format string itself is currently undefined
12670 and will not be carried out by this version of the compiler.  
12671
12672 Additionally, @code{CFStringRefs} (defined by the @code{CoreFoundation} headers) may
12673 also be used as format arguments.  Note that the relevant headers are only likely to be
12674 available on Darwin (OSX) installations.  On such installations, the XCode and system
12675 documentation provide descriptions of @code{CFString}, @code{CFStringRefs} and
12676 associated functions.
12677
12678 @node Pragmas
12679 @section Pragmas Accepted by GCC
12680 @cindex pragmas
12681 @cindex @code{#pragma}
12682
12683 GCC supports several types of pragmas, primarily in order to compile
12684 code originally written for other compilers.  Note that in general
12685 we do not recommend the use of pragmas; @xref{Function Attributes},
12686 for further explanation.
12687
12688 @menu
12689 * ARM Pragmas::
12690 * M32C Pragmas::
12691 * MeP Pragmas::
12692 * RS/6000 and PowerPC Pragmas::
12693 * Darwin Pragmas::
12694 * Solaris Pragmas::
12695 * Symbol-Renaming Pragmas::
12696 * Structure-Packing Pragmas::
12697 * Weak Pragmas::
12698 * Diagnostic Pragmas::
12699 * Visibility Pragmas::
12700 * Push/Pop Macro Pragmas::
12701 * Function Specific Option Pragmas::
12702 @end menu
12703
12704 @node ARM Pragmas
12705 @subsection ARM Pragmas
12706
12707 The ARM target defines pragmas for controlling the default addition of
12708 @code{long_call} and @code{short_call} attributes to functions.
12709 @xref{Function Attributes}, for information about the effects of these
12710 attributes.
12711
12712 @table @code
12713 @item long_calls
12714 @cindex pragma, long_calls
12715 Set all subsequent functions to have the @code{long_call} attribute.
12716
12717 @item no_long_calls
12718 @cindex pragma, no_long_calls
12719 Set all subsequent functions to have the @code{short_call} attribute.
12720
12721 @item long_calls_off
12722 @cindex pragma, long_calls_off
12723 Do not affect the @code{long_call} or @code{short_call} attributes of
12724 subsequent functions.
12725 @end table
12726
12727 @node M32C Pragmas
12728 @subsection M32C Pragmas
12729
12730 @table @code
12731 @item GCC memregs @var{number}
12732 @cindex pragma, memregs
12733 Overrides the command-line option @code{-memregs=} for the current
12734 file.  Use with care!  This pragma must be before any function in the
12735 file, and mixing different memregs values in different objects may
12736 make them incompatible.  This pragma is useful when a
12737 performance-critical function uses a memreg for temporary values,
12738 as it may allow you to reduce the number of memregs used.
12739
12740 @item ADDRESS @var{name} @var{address}
12741 @cindex pragma, address
12742 For any declared symbols matching @var{name}, this does three things
12743 to that symbol: it forces the symbol to be located at the given
12744 address (a number), it forces the symbol to be volatile, and it
12745 changes the symbol's scope to be static.  This pragma exists for
12746 compatibility with other compilers, but note that the common
12747 @code{1234H} numeric syntax is not supported (use @code{0x1234}
12748 instead).  Example:
12749
12750 @example
12751 #pragma ADDRESS port3 0x103
12752 char port3;
12753 @end example
12754
12755 @end table
12756
12757 @node MeP Pragmas
12758 @subsection MeP Pragmas
12759
12760 @table @code
12761
12762 @item custom io_volatile (on|off)
12763 @cindex pragma, custom io_volatile
12764 Overrides the command line option @code{-mio-volatile} for the current
12765 file.  Note that for compatibility with future GCC releases, this
12766 option should only be used once before any @code{io} variables in each
12767 file.
12768
12769 @item GCC coprocessor available @var{registers}
12770 @cindex pragma, coprocessor available
12771 Specifies which coprocessor registers are available to the register
12772 allocator.  @var{registers} may be a single register, register range
12773 separated by ellipses, or comma-separated list of those.  Example:
12774
12775 @example
12776 #pragma GCC coprocessor available $c0...$c10, $c28
12777 @end example
12778
12779 @item GCC coprocessor call_saved @var{registers}
12780 @cindex pragma, coprocessor call_saved
12781 Specifies which coprocessor registers are to be saved and restored by
12782 any function using them.  @var{registers} may be a single register,
12783 register range separated by ellipses, or comma-separated list of
12784 those.  Example:
12785
12786 @example
12787 #pragma GCC coprocessor call_saved $c4...$c6, $c31
12788 @end example
12789
12790 @item GCC coprocessor subclass '(A|B|C|D)' = @var{registers}
12791 @cindex pragma, coprocessor subclass
12792 Creates and defines a register class.  These register classes can be
12793 used by inline @code{asm} constructs.  @var{registers} may be a single
12794 register, register range separated by ellipses, or comma-separated
12795 list of those.  Example:
12796
12797 @example
12798 #pragma GCC coprocessor subclass 'B' = $c2, $c4, $c6
12799
12800 asm ("cpfoo %0" : "=B" (x));
12801 @end example
12802
12803 @item GCC disinterrupt @var{name} , @var{name} @dots{}
12804 @cindex pragma, disinterrupt
12805 For the named functions, the compiler adds code to disable interrupts
12806 for the duration of those functions.  Any functions so named, which
12807 are not encountered in the source, cause a warning that the pragma was
12808 not used.  Examples:
12809
12810 @example
12811 #pragma disinterrupt foo
12812 #pragma disinterrupt bar, grill
12813 int foo () @{ @dots{} @}
12814 @end example
12815
12816 @item GCC call @var{name} , @var{name} @dots{}
12817 @cindex pragma, call
12818 For the named functions, the compiler always uses a register-indirect
12819 call model when calling the named functions.  Examples:
12820
12821 @example
12822 extern int foo ();
12823 #pragma call foo
12824 @end example
12825
12826 @end table
12827
12828 @node RS/6000 and PowerPC Pragmas
12829 @subsection RS/6000 and PowerPC Pragmas
12830
12831 The RS/6000 and PowerPC targets define one pragma for controlling
12832 whether or not the @code{longcall} attribute is added to function
12833 declarations by default.  This pragma overrides the @option{-mlongcall}
12834 option, but not the @code{longcall} and @code{shortcall} attributes.
12835 @xref{RS/6000 and PowerPC Options}, for more information about when long
12836 calls are and are not necessary.
12837
12838 @table @code
12839 @item longcall (1)
12840 @cindex pragma, longcall
12841 Apply the @code{longcall} attribute to all subsequent function
12842 declarations.
12843
12844 @item longcall (0)
12845 Do not apply the @code{longcall} attribute to subsequent function
12846 declarations.
12847 @end table
12848
12849 @c Describe h8300 pragmas here.
12850 @c Describe sh pragmas here.
12851 @c Describe v850 pragmas here.
12852
12853 @node Darwin Pragmas
12854 @subsection Darwin Pragmas
12855
12856 The following pragmas are available for all architectures running the
12857 Darwin operating system.  These are useful for compatibility with other
12858 Mac OS compilers.
12859
12860 @table @code
12861 @item mark @var{tokens}@dots{}
12862 @cindex pragma, mark
12863 This pragma is accepted, but has no effect.
12864
12865 @item options align=@var{alignment}
12866 @cindex pragma, options align
12867 This pragma sets the alignment of fields in structures.  The values of
12868 @var{alignment} may be @code{mac68k}, to emulate m68k alignment, or
12869 @code{power}, to emulate PowerPC alignment.  Uses of this pragma nest
12870 properly; to restore the previous setting, use @code{reset} for the
12871 @var{alignment}.
12872
12873 @item segment @var{tokens}@dots{}
12874 @cindex pragma, segment
12875 This pragma is accepted, but has no effect.
12876
12877 @item unused (@var{var} [, @var{var}]@dots{})
12878 @cindex pragma, unused
12879 This pragma declares variables to be possibly unused.  GCC will not
12880 produce warnings for the listed variables.  The effect is similar to
12881 that of the @code{unused} attribute, except that this pragma may appear
12882 anywhere within the variables' scopes.
12883 @end table
12884
12885 @node Solaris Pragmas
12886 @subsection Solaris Pragmas
12887
12888 The Solaris target supports @code{#pragma redefine_extname}
12889 (@pxref{Symbol-Renaming Pragmas}).  It also supports additional
12890 @code{#pragma} directives for compatibility with the system compiler.
12891
12892 @table @code
12893 @item align @var{alignment} (@var{variable} [, @var{variable}]...)
12894 @cindex pragma, align
12895
12896 Increase the minimum alignment of each @var{variable} to @var{alignment}.
12897 This is the same as GCC's @code{aligned} attribute @pxref{Variable
12898 Attributes}).  Macro expansion occurs on the arguments to this pragma
12899 when compiling C and Objective-C@.  It does not currently occur when
12900 compiling C++, but this is a bug which may be fixed in a future
12901 release.
12902
12903 @item fini (@var{function} [, @var{function}]...)
12904 @cindex pragma, fini
12905
12906 This pragma causes each listed @var{function} to be called after
12907 main, or during shared module unloading, by adding a call to the
12908 @code{.fini} section.
12909
12910 @item init (@var{function} [, @var{function}]...)
12911 @cindex pragma, init
12912
12913 This pragma causes each listed @var{function} to be called during
12914 initialization (before @code{main}) or during shared module loading, by
12915 adding a call to the @code{.init} section.
12916
12917 @end table
12918
12919 @node Symbol-Renaming Pragmas
12920 @subsection Symbol-Renaming Pragmas
12921
12922 For compatibility with the Solaris and Tru64 UNIX system headers, GCC
12923 supports two @code{#pragma} directives which change the name used in
12924 assembly for a given declaration.  @code{#pragma extern_prefix} is only 
12925 available on platforms whose system headers need it. To get this effect 
12926 on all platforms supported by GCC, use the asm labels extension (@pxref{Asm
12927 Labels}).
12928
12929 @table @code
12930 @item redefine_extname @var{oldname} @var{newname}
12931 @cindex pragma, redefine_extname
12932
12933 This pragma gives the C function @var{oldname} the assembly symbol
12934 @var{newname}.  The preprocessor macro @code{__PRAGMA_REDEFINE_EXTNAME}
12935 will be defined if this pragma is available (currently on all platforms).
12936
12937 @item extern_prefix @var{string}
12938 @cindex pragma, extern_prefix
12939
12940 This pragma causes all subsequent external function and variable
12941 declarations to have @var{string} prepended to their assembly symbols.
12942 This effect may be terminated with another @code{extern_prefix} pragma
12943 whose argument is an empty string.  The preprocessor macro
12944 @code{__PRAGMA_EXTERN_PREFIX} will be defined if this pragma is
12945 available (currently only on Tru64 UNIX)@.
12946 @end table
12947
12948 These pragmas and the asm labels extension interact in a complicated
12949 manner.  Here are some corner cases you may want to be aware of.
12950
12951 @enumerate
12952 @item Both pragmas silently apply only to declarations with external
12953 linkage.  Asm labels do not have this restriction.
12954
12955 @item In C++, both pragmas silently apply only to declarations with
12956 ``C'' linkage.  Again, asm labels do not have this restriction.
12957
12958 @item If any of the three ways of changing the assembly name of a
12959 declaration is applied to a declaration whose assembly name has
12960 already been determined (either by a previous use of one of these
12961 features, or because the compiler needed the assembly name in order to
12962 generate code), and the new name is different, a warning issues and
12963 the name does not change.
12964
12965 @item The @var{oldname} used by @code{#pragma redefine_extname} is
12966 always the C-language name.
12967
12968 @item If @code{#pragma extern_prefix} is in effect, and a declaration
12969 occurs with an asm label attached, the prefix is silently ignored for
12970 that declaration.
12971
12972 @item If @code{#pragma extern_prefix} and @code{#pragma redefine_extname}
12973 apply to the same declaration, whichever triggered first wins, and a
12974 warning issues if they contradict each other.  (We would like to have
12975 @code{#pragma redefine_extname} always win, for consistency with asm
12976 labels, but if @code{#pragma extern_prefix} triggers first we have no
12977 way of knowing that that happened.)
12978 @end enumerate
12979
12980 @node Structure-Packing Pragmas
12981 @subsection Structure-Packing Pragmas
12982
12983 For compatibility with Microsoft Windows compilers, GCC supports a
12984 set of @code{#pragma} directives which change the maximum alignment of
12985 members of structures (other than zero-width bitfields), unions, and
12986 classes subsequently defined. The @var{n} value below always is required
12987 to be a small power of two and specifies the new alignment in bytes.
12988
12989 @enumerate
12990 @item @code{#pragma pack(@var{n})} simply sets the new alignment.
12991 @item @code{#pragma pack()} sets the alignment to the one that was in
12992 effect when compilation started (see also command-line option
12993 @option{-fpack-struct[=@var{n}]} @pxref{Code Gen Options}).
12994 @item @code{#pragma pack(push[,@var{n}])} pushes the current alignment
12995 setting on an internal stack and then optionally sets the new alignment.
12996 @item @code{#pragma pack(pop)} restores the alignment setting to the one
12997 saved at the top of the internal stack (and removes that stack entry).
12998 Note that @code{#pragma pack([@var{n}])} does not influence this internal
12999 stack; thus it is possible to have @code{#pragma pack(push)} followed by
13000 multiple @code{#pragma pack(@var{n})} instances and finalized by a single
13001 @code{#pragma pack(pop)}.
13002 @end enumerate
13003
13004 Some targets, e.g.@: i386 and powerpc, support the @code{ms_struct}
13005 @code{#pragma} which lays out a structure as the documented
13006 @code{__attribute__ ((ms_struct))}.
13007 @enumerate
13008 @item @code{#pragma ms_struct on} turns on the layout for structures
13009 declared.
13010 @item @code{#pragma ms_struct off} turns off the layout for structures
13011 declared.
13012 @item @code{#pragma ms_struct reset} goes back to the default layout.
13013 @end enumerate
13014
13015 @node Weak Pragmas
13016 @subsection Weak Pragmas
13017
13018 For compatibility with SVR4, GCC supports a set of @code{#pragma}
13019 directives for declaring symbols to be weak, and defining weak
13020 aliases.
13021
13022 @table @code
13023 @item #pragma weak @var{symbol}
13024 @cindex pragma, weak
13025 This pragma declares @var{symbol} to be weak, as if the declaration
13026 had the attribute of the same name.  The pragma may appear before
13027 or after the declaration of @var{symbol}.  It is not an error for
13028 @var{symbol} to never be defined at all.
13029
13030 @item #pragma weak @var{symbol1} = @var{symbol2}
13031 This pragma declares @var{symbol1} to be a weak alias of @var{symbol2}.
13032 It is an error if @var{symbol2} is not defined in the current
13033 translation unit.
13034 @end table
13035
13036 @node Diagnostic Pragmas
13037 @subsection Diagnostic Pragmas
13038
13039 GCC allows the user to selectively enable or disable certain types of
13040 diagnostics, and change the kind of the diagnostic.  For example, a
13041 project's policy might require that all sources compile with
13042 @option{-Werror} but certain files might have exceptions allowing
13043 specific types of warnings.  Or, a project might selectively enable
13044 diagnostics and treat them as errors depending on which preprocessor
13045 macros are defined.
13046
13047 @table @code
13048 @item #pragma GCC diagnostic @var{kind} @var{option}
13049 @cindex pragma, diagnostic
13050
13051 Modifies the disposition of a diagnostic.  Note that not all
13052 diagnostics are modifiable; at the moment only warnings (normally
13053 controlled by @samp{-W@dots{}}) can be controlled, and not all of them.
13054 Use @option{-fdiagnostics-show-option} to determine which diagnostics
13055 are controllable and which option controls them.
13056
13057 @var{kind} is @samp{error} to treat this diagnostic as an error,
13058 @samp{warning} to treat it like a warning (even if @option{-Werror} is
13059 in effect), or @samp{ignored} if the diagnostic is to be ignored.
13060 @var{option} is a double quoted string which matches the command-line
13061 option.
13062
13063 @example
13064 #pragma GCC diagnostic warning "-Wformat"
13065 #pragma GCC diagnostic error "-Wformat"
13066 #pragma GCC diagnostic ignored "-Wformat"
13067 @end example
13068
13069 Note that these pragmas override any command-line options.  GCC keeps
13070 track of the location of each pragma, and issues diagnostics according
13071 to the state as of that point in the source file.  Thus, pragmas occurring
13072 after a line do not affect diagnostics caused by that line.
13073
13074 @item #pragma GCC diagnostic push
13075 @itemx #pragma GCC diagnostic pop
13076
13077 Causes GCC to remember the state of the diagnostics as of each
13078 @code{push}, and restore to that point at each @code{pop}.  If a
13079 @code{pop} has no matching @code{push}, the command line options are
13080 restored.
13081
13082 @example
13083 #pragma GCC diagnostic error "-Wuninitialized"
13084   foo(a);                       /* error is given for this one */
13085 #pragma GCC diagnostic push
13086 #pragma GCC diagnostic ignored "-Wuninitialized"
13087   foo(b);                       /* no diagnostic for this one */
13088 #pragma GCC diagnostic pop
13089   foo(c);                       /* error is given for this one */
13090 #pragma GCC diagnostic pop
13091   foo(d);                       /* depends on command line options */
13092 @end example
13093
13094 @end table
13095
13096 GCC also offers a simple mechanism for printing messages during
13097 compilation.
13098
13099 @table @code
13100 @item #pragma message @var{string}
13101 @cindex pragma, diagnostic
13102
13103 Prints @var{string} as a compiler message on compilation.  The message
13104 is informational only, and is neither a compilation warning nor an error.
13105
13106 @smallexample
13107 #pragma message "Compiling " __FILE__ "..."
13108 @end smallexample
13109
13110 @var{string} may be parenthesized, and is printed with location
13111 information.  For example,
13112
13113 @smallexample
13114 #define DO_PRAGMA(x) _Pragma (#x)
13115 #define TODO(x) DO_PRAGMA(message ("TODO - " #x))
13116
13117 TODO(Remember to fix this)
13118 @end smallexample
13119
13120 prints @samp{/tmp/file.c:4: note: #pragma message:
13121 TODO - Remember to fix this}.
13122
13123 @end table
13124
13125 @node Visibility Pragmas
13126 @subsection Visibility Pragmas
13127
13128 @table @code
13129 @item #pragma GCC visibility push(@var{visibility})
13130 @itemx #pragma GCC visibility pop
13131 @cindex pragma, visibility
13132
13133 This pragma allows the user to set the visibility for multiple
13134 declarations without having to give each a visibility attribute
13135 @xref{Function Attributes}, for more information about visibility and
13136 the attribute syntax.
13137
13138 In C++, @samp{#pragma GCC visibility} affects only namespace-scope
13139 declarations.  Class members and template specializations are not
13140 affected; if you want to override the visibility for a particular
13141 member or instantiation, you must use an attribute.
13142
13143 @end table
13144
13145
13146 @node Push/Pop Macro Pragmas
13147 @subsection Push/Pop Macro Pragmas
13148
13149 For compatibility with Microsoft Windows compilers, GCC supports
13150 @samp{#pragma push_macro(@var{"macro_name"})}
13151 and @samp{#pragma pop_macro(@var{"macro_name"})}.
13152
13153 @table @code
13154 @item #pragma push_macro(@var{"macro_name"})
13155 @cindex pragma, push_macro
13156 This pragma saves the value of the macro named as @var{macro_name} to
13157 the top of the stack for this macro.
13158
13159 @item #pragma pop_macro(@var{"macro_name"})
13160 @cindex pragma, pop_macro
13161 This pragma sets the value of the macro named as @var{macro_name} to
13162 the value on top of the stack for this macro. If the stack for
13163 @var{macro_name} is empty, the value of the macro remains unchanged.
13164 @end table
13165
13166 For example:
13167
13168 @smallexample
13169 #define X  1
13170 #pragma push_macro("X")
13171 #undef X
13172 #define X -1
13173 #pragma pop_macro("X")
13174 int x [X]; 
13175 @end smallexample
13176
13177 In this example, the definition of X as 1 is saved by @code{#pragma
13178 push_macro} and restored by @code{#pragma pop_macro}.
13179
13180 @node Function Specific Option Pragmas
13181 @subsection Function Specific Option Pragmas
13182
13183 @table @code
13184 @item #pragma GCC target (@var{"string"}...)
13185 @cindex pragma GCC target
13186
13187 This pragma allows you to set target specific options for functions
13188 defined later in the source file.  One or more strings can be
13189 specified.  Each function that is defined after this point will be as
13190 if @code{attribute((target("STRING")))} was specified for that
13191 function.  The parenthesis around the options is optional.
13192 @xref{Function Attributes}, for more information about the
13193 @code{target} attribute and the attribute syntax.
13194
13195 The @code{#pragma GCC target} attribute is not implemented in GCC versions earlier
13196 than 4.4 for the i386/x86_64 and 4.6 for the PowerPC backends.  At
13197 present, it is not implemented for other backends.
13198 @end table
13199
13200 @table @code
13201 @item #pragma GCC optimize (@var{"string"}...)
13202 @cindex pragma GCC optimize
13203
13204 This pragma allows you to set global optimization options for functions
13205 defined later in the source file.  One or more strings can be
13206 specified.  Each function that is defined after this point will be as
13207 if @code{attribute((optimize("STRING")))} was specified for that
13208 function.  The parenthesis around the options is optional.
13209 @xref{Function Attributes}, for more information about the
13210 @code{optimize} attribute and the attribute syntax.
13211
13212 The @samp{#pragma GCC optimize} pragma is not implemented in GCC
13213 versions earlier than 4.4.
13214 @end table
13215
13216 @table @code
13217 @item #pragma GCC push_options
13218 @itemx #pragma GCC pop_options
13219 @cindex pragma GCC push_options
13220 @cindex pragma GCC pop_options
13221
13222 These pragmas maintain a stack of the current target and optimization
13223 options.  It is intended for include files where you temporarily want
13224 to switch to using a different @samp{#pragma GCC target} or
13225 @samp{#pragma GCC optimize} and then to pop back to the previous
13226 options.
13227
13228 The @samp{#pragma GCC push_options} and @samp{#pragma GCC pop_options}
13229 pragmas are not implemented in GCC versions earlier than 4.4.
13230 @end table
13231
13232 @table @code
13233 @item #pragma GCC reset_options
13234 @cindex pragma GCC reset_options
13235
13236 This pragma clears the current @code{#pragma GCC target} and
13237 @code{#pragma GCC optimize} to use the default switches as specified
13238 on the command line.
13239
13240 The @samp{#pragma GCC reset_options} pragma is not implemented in GCC
13241 versions earlier than 4.4.
13242 @end table
13243
13244 @node Unnamed Fields
13245 @section Unnamed struct/union fields within structs/unions
13246 @cindex @code{struct}
13247 @cindex @code{union}
13248
13249 As permitted by ISO C1X and for compatibility with other compilers,
13250 GCC allows you to define
13251 a structure or union that contains, as fields, structures and unions
13252 without names.  For example:
13253
13254 @smallexample
13255 struct @{
13256   int a;
13257   union @{
13258     int b;
13259     float c;
13260   @};
13261   int d;
13262 @} foo;
13263 @end smallexample
13264
13265 In this example, the user would be able to access members of the unnamed
13266 union with code like @samp{foo.b}.  Note that only unnamed structs and
13267 unions are allowed, you may not have, for example, an unnamed
13268 @code{int}.
13269
13270 You must never create such structures that cause ambiguous field definitions.
13271 For example, this structure:
13272
13273 @smallexample
13274 struct @{
13275   int a;
13276   struct @{
13277     int a;
13278   @};
13279 @} foo;
13280 @end smallexample
13281
13282 It is ambiguous which @code{a} is being referred to with @samp{foo.a}.
13283 The compiler gives errors for such constructs.
13284
13285 @opindex fms-extensions
13286 Unless @option{-fms-extensions} is used, the unnamed field must be a
13287 structure or union definition without a tag (for example, @samp{struct
13288 @{ int a; @};}), or a @code{typedef} name for such a structure or
13289 union.  If @option{-fms-extensions} is used, the field may
13290 also be a definition with a tag such as @samp{struct foo @{ int a;
13291 @};}, a reference to a previously defined structure or union such as
13292 @samp{struct foo;}, or a reference to a @code{typedef} name for a
13293 previously defined structure or union type with a tag.
13294
13295 @opindex fplan9-extensions
13296 The option @option{-fplan9-extensions} enables
13297 @option{-fms-extensions} as well as two other extensions.  First, a
13298 pointer to a structure is automatically converted to a pointer to an
13299 anonymous field for assignments and function calls.  For example:
13300
13301 @smallexample
13302 struct s1 @{ int a; @};
13303 struct s2 @{ struct s1; @};
13304 extern void f1 (struct s1 *);
13305 void f2 (struct s2 *p) @{ f1 (p); @}
13306 @end smallexample
13307
13308 In the call to @code{f1} inside @code{f2}, the pointer @code{p} is
13309 converted into a pointer to the anonymous field.
13310
13311 Second, when the type of an anonymous field is a @code{typedef} for a
13312 @code{struct} or @code{union}, code may refer to the field using the
13313 name of the @code{typedef}.
13314
13315 @smallexample
13316 typedef struct @{ int a; @} s1;
13317 struct s2 @{ s1; @};
13318 s1 f1 (struct s2 *p) @{ return p->s1; @}
13319 @end smallexample
13320
13321 These usages are only permitted when they are not ambiguous.
13322
13323 @node Thread-Local
13324 @section Thread-Local Storage
13325 @cindex Thread-Local Storage
13326 @cindex @acronym{TLS}
13327 @cindex @code{__thread}
13328
13329 Thread-local storage (@acronym{TLS}) is a mechanism by which variables
13330 are allocated such that there is one instance of the variable per extant
13331 thread.  The run-time model GCC uses to implement this originates
13332 in the IA-64 processor-specific ABI, but has since been migrated
13333 to other processors as well.  It requires significant support from
13334 the linker (@command{ld}), dynamic linker (@command{ld.so}), and
13335 system libraries (@file{libc.so} and @file{libpthread.so}), so it
13336 is not available everywhere.
13337
13338 At the user level, the extension is visible with a new storage
13339 class keyword: @code{__thread}.  For example:
13340
13341 @smallexample
13342 __thread int i;
13343 extern __thread struct state s;
13344 static __thread char *p;
13345 @end smallexample
13346
13347 The @code{__thread} specifier may be used alone, with the @code{extern}
13348 or @code{static} specifiers, but with no other storage class specifier.
13349 When used with @code{extern} or @code{static}, @code{__thread} must appear
13350 immediately after the other storage class specifier.
13351
13352 The @code{__thread} specifier may be applied to any global, file-scoped
13353 static, function-scoped static, or static data member of a class.  It may
13354 not be applied to block-scoped automatic or non-static data member.
13355
13356 When the address-of operator is applied to a thread-local variable, it is
13357 evaluated at run-time and returns the address of the current thread's
13358 instance of that variable.  An address so obtained may be used by any
13359 thread.  When a thread terminates, any pointers to thread-local variables
13360 in that thread become invalid.
13361
13362 No static initialization may refer to the address of a thread-local variable.
13363
13364 In C++, if an initializer is present for a thread-local variable, it must
13365 be a @var{constant-expression}, as defined in 5.19.2 of the ANSI/ISO C++
13366 standard.
13367
13368 See @uref{http://people.redhat.com/drepper/tls.pdf,
13369 ELF Handling For Thread-Local Storage} for a detailed explanation of
13370 the four thread-local storage addressing models, and how the run-time
13371 is expected to function.
13372
13373 @menu
13374 * C99 Thread-Local Edits::
13375 * C++98 Thread-Local Edits::
13376 @end menu
13377
13378 @node C99 Thread-Local Edits
13379 @subsection ISO/IEC 9899:1999 Edits for Thread-Local Storage
13380
13381 The following are a set of changes to ISO/IEC 9899:1999 (aka C99)
13382 that document the exact semantics of the language extension.
13383
13384 @itemize @bullet
13385 @item
13386 @cite{5.1.2  Execution environments}
13387
13388 Add new text after paragraph 1
13389
13390 @quotation
13391 Within either execution environment, a @dfn{thread} is a flow of
13392 control within a program.  It is implementation defined whether
13393 or not there may be more than one thread associated with a program.
13394 It is implementation defined how threads beyond the first are
13395 created, the name and type of the function called at thread
13396 startup, and how threads may be terminated.  However, objects
13397 with thread storage duration shall be initialized before thread
13398 startup.
13399 @end quotation
13400
13401 @item
13402 @cite{6.2.4  Storage durations of objects}
13403
13404 Add new text before paragraph 3
13405
13406 @quotation
13407 An object whose identifier is declared with the storage-class
13408 specifier @w{@code{__thread}} has @dfn{thread storage duration}.
13409 Its lifetime is the entire execution of the thread, and its
13410 stored value is initialized only once, prior to thread startup.
13411 @end quotation
13412
13413 @item
13414 @cite{6.4.1  Keywords}
13415
13416 Add @code{__thread}.
13417
13418 @item
13419 @cite{6.7.1  Storage-class specifiers}
13420
13421 Add @code{__thread} to the list of storage class specifiers in
13422 paragraph 1.
13423
13424 Change paragraph 2 to
13425
13426 @quotation
13427 With the exception of @code{__thread}, at most one storage-class
13428 specifier may be given [@dots{}].  The @code{__thread} specifier may
13429 be used alone, or immediately following @code{extern} or
13430 @code{static}.
13431 @end quotation
13432
13433 Add new text after paragraph 6
13434
13435 @quotation
13436 The declaration of an identifier for a variable that has
13437 block scope that specifies @code{__thread} shall also
13438 specify either @code{extern} or @code{static}.
13439
13440 The @code{__thread} specifier shall be used only with
13441 variables.
13442 @end quotation
13443 @end itemize
13444
13445 @node C++98 Thread-Local Edits
13446 @subsection ISO/IEC 14882:1998 Edits for Thread-Local Storage
13447
13448 The following are a set of changes to ISO/IEC 14882:1998 (aka C++98)
13449 that document the exact semantics of the language extension.
13450
13451 @itemize @bullet
13452 @item
13453 @b{[intro.execution]}
13454
13455 New text after paragraph 4
13456
13457 @quotation
13458 A @dfn{thread} is a flow of control within the abstract machine.
13459 It is implementation defined whether or not there may be more than
13460 one thread.
13461 @end quotation
13462
13463 New text after paragraph 7
13464
13465 @quotation
13466 It is unspecified whether additional action must be taken to
13467 ensure when and whether side effects are visible to other threads.
13468 @end quotation
13469
13470 @item
13471 @b{[lex.key]}
13472
13473 Add @code{__thread}.
13474
13475 @item
13476 @b{[basic.start.main]}
13477
13478 Add after paragraph 5
13479
13480 @quotation
13481 The thread that begins execution at the @code{main} function is called
13482 the @dfn{main thread}.  It is implementation defined how functions
13483 beginning threads other than the main thread are designated or typed.
13484 A function so designated, as well as the @code{main} function, is called
13485 a @dfn{thread startup function}.  It is implementation defined what
13486 happens if a thread startup function returns.  It is implementation
13487 defined what happens to other threads when any thread calls @code{exit}.
13488 @end quotation
13489
13490 @item
13491 @b{[basic.start.init]}
13492
13493 Add after paragraph 4
13494
13495 @quotation
13496 The storage for an object of thread storage duration shall be
13497 statically initialized before the first statement of the thread startup
13498 function.  An object of thread storage duration shall not require
13499 dynamic initialization.
13500 @end quotation
13501
13502 @item
13503 @b{[basic.start.term]}
13504
13505 Add after paragraph 3
13506
13507 @quotation
13508 The type of an object with thread storage duration shall not have a
13509 non-trivial destructor, nor shall it be an array type whose elements
13510 (directly or indirectly) have non-trivial destructors.
13511 @end quotation
13512
13513 @item
13514 @b{[basic.stc]}
13515
13516 Add ``thread storage duration'' to the list in paragraph 1.
13517
13518 Change paragraph 2
13519
13520 @quotation
13521 Thread, static, and automatic storage durations are associated with
13522 objects introduced by declarations [@dots{}].
13523 @end quotation
13524
13525 Add @code{__thread} to the list of specifiers in paragraph 3.
13526
13527 @item
13528 @b{[basic.stc.thread]}
13529
13530 New section before @b{[basic.stc.static]}
13531
13532 @quotation
13533 The keyword @code{__thread} applied to a non-local object gives the
13534 object thread storage duration.
13535
13536 A local variable or class data member declared both @code{static}
13537 and @code{__thread} gives the variable or member thread storage
13538 duration.
13539 @end quotation
13540
13541 @item
13542 @b{[basic.stc.static]}
13543
13544 Change paragraph 1
13545
13546 @quotation
13547 All objects which have neither thread storage duration, dynamic
13548 storage duration nor are local [@dots{}].
13549 @end quotation
13550
13551 @item
13552 @b{[dcl.stc]}
13553
13554 Add @code{__thread} to the list in paragraph 1.
13555
13556 Change paragraph 1
13557
13558 @quotation
13559 With the exception of @code{__thread}, at most one
13560 @var{storage-class-specifier} shall appear in a given
13561 @var{decl-specifier-seq}.  The @code{__thread} specifier may
13562 be used alone, or immediately following the @code{extern} or
13563 @code{static} specifiers.  [@dots{}]
13564 @end quotation
13565
13566 Add after paragraph 5
13567
13568 @quotation
13569 The @code{__thread} specifier can be applied only to the names of objects
13570 and to anonymous unions.
13571 @end quotation
13572
13573 @item
13574 @b{[class.mem]}
13575
13576 Add after paragraph 6
13577
13578 @quotation
13579 Non-@code{static} members shall not be @code{__thread}.
13580 @end quotation
13581 @end itemize
13582
13583 @node Binary constants
13584 @section Binary constants using the @samp{0b} prefix
13585 @cindex Binary constants using the @samp{0b} prefix
13586
13587 Integer constants can be written as binary constants, consisting of a
13588 sequence of @samp{0} and @samp{1} digits, prefixed by @samp{0b} or
13589 @samp{0B}.  This is particularly useful in environments that operate a
13590 lot on the bit-level (like microcontrollers).
13591
13592 The following statements are identical:
13593
13594 @smallexample
13595 i =       42;
13596 i =     0x2a;
13597 i =      052;
13598 i = 0b101010;
13599 @end smallexample
13600
13601 The type of these constants follows the same rules as for octal or
13602 hexadecimal integer constants, so suffixes like @samp{L} or @samp{UL}
13603 can be applied.
13604
13605 @node C++ Extensions
13606 @chapter Extensions to the C++ Language
13607 @cindex extensions, C++ language
13608 @cindex C++ language extensions
13609
13610 The GNU compiler provides these extensions to the C++ language (and you
13611 can also use most of the C language extensions in your C++ programs).  If you
13612 want to write code that checks whether these features are available, you can
13613 test for the GNU compiler the same way as for C programs: check for a
13614 predefined macro @code{__GNUC__}.  You can also use @code{__GNUG__} to
13615 test specifically for GNU C++ (@pxref{Common Predefined Macros,,
13616 Predefined Macros,cpp,The GNU C Preprocessor}).
13617
13618 @menu
13619 * C++ Volatiles::       What constitutes an access to a volatile object.
13620 * Restricted Pointers:: C99 restricted pointers and references.
13621 * Vague Linkage::       Where G++ puts inlines, vtables and such.
13622 * C++ Interface::       You can use a single C++ header file for both
13623                         declarations and definitions.
13624 * Template Instantiation:: Methods for ensuring that exactly one copy of
13625                         each needed template instantiation is emitted.
13626 * Bound member functions:: You can extract a function pointer to the
13627                         method denoted by a @samp{->*} or @samp{.*} expression.
13628 * C++ Attributes::      Variable, function, and type attributes for C++ only.
13629 * Namespace Association:: Strong using-directives for namespace association.
13630 * Type Traits::         Compiler support for type traits
13631 * Java Exceptions::     Tweaking exception handling to work with Java.
13632 * Deprecated Features:: Things will disappear from g++.
13633 * Backwards Compatibility:: Compatibilities with earlier definitions of C++.
13634 @end menu
13635
13636 @node C++ Volatiles
13637 @section When is a Volatile C++ Object Accessed?
13638 @cindex accessing volatiles
13639 @cindex volatile read
13640 @cindex volatile write
13641 @cindex volatile access
13642
13643 The C++ standard differs from the C standard in its treatment of
13644 volatile objects.  It fails to specify what constitutes a volatile
13645 access, except to say that C++ should behave in a similar manner to C
13646 with respect to volatiles, where possible.  However, the different
13647 lvalueness of expressions between C and C++ complicate the behaviour.
13648 G++ behaves the same as GCC for volatile access, @xref{C
13649 Extensions,,Volatiles}, for a description of GCC's behaviour.
13650
13651 The C and C++ language specifications differ when an object is
13652 accessed in a void context:
13653
13654 @smallexample
13655 volatile int *src = @var{somevalue};
13656 *src;
13657 @end smallexample
13658
13659 The C++ standard specifies that such expressions do not undergo lvalue
13660 to rvalue conversion, and that the type of the dereferenced object may
13661 be incomplete.  The C++ standard does not specify explicitly that it
13662 is lvalue to rvalue conversion which is responsible for causing an
13663 access.  There is reason to believe that it is, because otherwise
13664 certain simple expressions become undefined.  However, because it
13665 would surprise most programmers, G++ treats dereferencing a pointer to
13666 volatile object of complete type as GCC would do for an equivalent
13667 type in C@.  When the object has incomplete type, G++ issues a
13668 warning; if you wish to force an error, you must force a conversion to
13669 rvalue with, for instance, a static cast.
13670
13671 When using a reference to volatile, G++ does not treat equivalent
13672 expressions as accesses to volatiles, but instead issues a warning that
13673 no volatile is accessed.  The rationale for this is that otherwise it
13674 becomes difficult to determine where volatile access occur, and not
13675 possible to ignore the return value from functions returning volatile
13676 references.  Again, if you wish to force a read, cast the reference to
13677 an rvalue.
13678
13679 G++ implements the same behaviour as GCC does when assigning to a
13680 volatile object -- there is no reread of the assigned-to object, the
13681 assigned rvalue is reused.  Note that in C++ assignment expressions
13682 are lvalues, and if used as an lvalue, the volatile object will be
13683 referred to.  For instance, @var{vref} will refer to @var{vobj}, as
13684 expected, in the following example:
13685
13686 @smallexample
13687 volatile int vobj;
13688 volatile int &vref = vobj = @var{something};
13689 @end smallexample
13690
13691 @node Restricted Pointers
13692 @section Restricting Pointer Aliasing
13693 @cindex restricted pointers
13694 @cindex restricted references
13695 @cindex restricted this pointer
13696
13697 As with the C front end, G++ understands the C99 feature of restricted pointers,
13698 specified with the @code{__restrict__}, or @code{__restrict} type
13699 qualifier.  Because you cannot compile C++ by specifying the @option{-std=c99}
13700 language flag, @code{restrict} is not a keyword in C++.
13701
13702 In addition to allowing restricted pointers, you can specify restricted
13703 references, which indicate that the reference is not aliased in the local
13704 context.
13705
13706 @smallexample
13707 void fn (int *__restrict__ rptr, int &__restrict__ rref)
13708 @{
13709   /* @r{@dots{}} */
13710 @}
13711 @end smallexample
13712
13713 @noindent
13714 In the body of @code{fn}, @var{rptr} points to an unaliased integer and
13715 @var{rref} refers to a (different) unaliased integer.
13716
13717 You may also specify whether a member function's @var{this} pointer is
13718 unaliased by using @code{__restrict__} as a member function qualifier.
13719
13720 @smallexample
13721 void T::fn () __restrict__
13722 @{
13723   /* @r{@dots{}} */
13724 @}
13725 @end smallexample
13726
13727 @noindent
13728 Within the body of @code{T::fn}, @var{this} will have the effective
13729 definition @code{T *__restrict__ const this}.  Notice that the
13730 interpretation of a @code{__restrict__} member function qualifier is
13731 different to that of @code{const} or @code{volatile} qualifier, in that it
13732 is applied to the pointer rather than the object.  This is consistent with
13733 other compilers which implement restricted pointers.
13734
13735 As with all outermost parameter qualifiers, @code{__restrict__} is
13736 ignored in function definition matching.  This means you only need to
13737 specify @code{__restrict__} in a function definition, rather than
13738 in a function prototype as well.
13739
13740 @node Vague Linkage
13741 @section Vague Linkage
13742 @cindex vague linkage
13743
13744 There are several constructs in C++ which require space in the object
13745 file but are not clearly tied to a single translation unit.  We say that
13746 these constructs have ``vague linkage''.  Typically such constructs are
13747 emitted wherever they are needed, though sometimes we can be more
13748 clever.
13749
13750 @table @asis
13751 @item Inline Functions
13752 Inline functions are typically defined in a header file which can be
13753 included in many different compilations.  Hopefully they can usually be
13754 inlined, but sometimes an out-of-line copy is necessary, if the address
13755 of the function is taken or if inlining fails.  In general, we emit an
13756 out-of-line copy in all translation units where one is needed.  As an
13757 exception, we only emit inline virtual functions with the vtable, since
13758 it will always require a copy.
13759
13760 Local static variables and string constants used in an inline function
13761 are also considered to have vague linkage, since they must be shared
13762 between all inlined and out-of-line instances of the function.
13763
13764 @item VTables
13765 @cindex vtable
13766 C++ virtual functions are implemented in most compilers using a lookup
13767 table, known as a vtable.  The vtable contains pointers to the virtual
13768 functions provided by a class, and each object of the class contains a
13769 pointer to its vtable (or vtables, in some multiple-inheritance
13770 situations).  If the class declares any non-inline, non-pure virtual
13771 functions, the first one is chosen as the ``key method'' for the class,
13772 and the vtable is only emitted in the translation unit where the key
13773 method is defined.
13774
13775 @emph{Note:} If the chosen key method is later defined as inline, the
13776 vtable will still be emitted in every translation unit which defines it.
13777 Make sure that any inline virtuals are declared inline in the class
13778 body, even if they are not defined there.
13779
13780 @item @code{type_info} objects
13781 @cindex @code{type_info}
13782 @cindex RTTI
13783 C++ requires information about types to be written out in order to
13784 implement @samp{dynamic_cast}, @samp{typeid} and exception handling.
13785 For polymorphic classes (classes with virtual functions), the @samp{type_info}
13786 object is written out along with the vtable so that @samp{dynamic_cast}
13787 can determine the dynamic type of a class object at runtime.  For all
13788 other types, we write out the @samp{type_info} object when it is used: when
13789 applying @samp{typeid} to an expression, throwing an object, or
13790 referring to a type in a catch clause or exception specification.
13791
13792 @item Template Instantiations
13793 Most everything in this section also applies to template instantiations,
13794 but there are other options as well.
13795 @xref{Template Instantiation,,Where's the Template?}.
13796
13797 @end table
13798
13799 When used with GNU ld version 2.8 or later on an ELF system such as
13800 GNU/Linux or Solaris 2, or on Microsoft Windows, duplicate copies of
13801 these constructs will be discarded at link time.  This is known as
13802 COMDAT support.
13803
13804 On targets that don't support COMDAT, but do support weak symbols, GCC
13805 will use them.  This way one copy will override all the others, but
13806 the unused copies will still take up space in the executable.
13807
13808 For targets which do not support either COMDAT or weak symbols,
13809 most entities with vague linkage will be emitted as local symbols to
13810 avoid duplicate definition errors from the linker.  This will not happen
13811 for local statics in inlines, however, as having multiple copies will
13812 almost certainly break things.
13813
13814 @xref{C++ Interface,,Declarations and Definitions in One Header}, for
13815 another way to control placement of these constructs.
13816
13817 @node C++ Interface
13818 @section #pragma interface and implementation
13819
13820 @cindex interface and implementation headers, C++
13821 @cindex C++ interface and implementation headers
13822 @cindex pragmas, interface and implementation
13823
13824 @code{#pragma interface} and @code{#pragma implementation} provide the
13825 user with a way of explicitly directing the compiler to emit entities
13826 with vague linkage (and debugging information) in a particular
13827 translation unit.
13828
13829 @emph{Note:} As of GCC 2.7.2, these @code{#pragma}s are not useful in
13830 most cases, because of COMDAT support and the ``key method'' heuristic
13831 mentioned in @ref{Vague Linkage}.  Using them can actually cause your
13832 program to grow due to unnecessary out-of-line copies of inline
13833 functions.  Currently (3.4) the only benefit of these
13834 @code{#pragma}s is reduced duplication of debugging information, and
13835 that should be addressed soon on DWARF 2 targets with the use of
13836 COMDAT groups.
13837
13838 @table @code
13839 @item #pragma interface
13840 @itemx #pragma interface "@var{subdir}/@var{objects}.h"
13841 @kindex #pragma interface
13842 Use this directive in @emph{header files} that define object classes, to save
13843 space in most of the object files that use those classes.  Normally,
13844 local copies of certain information (backup copies of inline member
13845 functions, debugging information, and the internal tables that implement
13846 virtual functions) must be kept in each object file that includes class
13847 definitions.  You can use this pragma to avoid such duplication.  When a
13848 header file containing @samp{#pragma interface} is included in a
13849 compilation, this auxiliary information will not be generated (unless
13850 the main input source file itself uses @samp{#pragma implementation}).
13851 Instead, the object files will contain references to be resolved at link
13852 time.
13853
13854 The second form of this directive is useful for the case where you have
13855 multiple headers with the same name in different directories.  If you
13856 use this form, you must specify the same string to @samp{#pragma
13857 implementation}.
13858
13859 @item #pragma implementation
13860 @itemx #pragma implementation "@var{objects}.h"
13861 @kindex #pragma implementation
13862 Use this pragma in a @emph{main input file}, when you want full output from
13863 included header files to be generated (and made globally visible).  The
13864 included header file, in turn, should use @samp{#pragma interface}.
13865 Backup copies of inline member functions, debugging information, and the
13866 internal tables used to implement virtual functions are all generated in
13867 implementation files.
13868
13869 @cindex implied @code{#pragma implementation}
13870 @cindex @code{#pragma implementation}, implied
13871 @cindex naming convention, implementation headers
13872 If you use @samp{#pragma implementation} with no argument, it applies to
13873 an include file with the same basename@footnote{A file's @dfn{basename}
13874 was the name stripped of all leading path information and of trailing
13875 suffixes, such as @samp{.h} or @samp{.C} or @samp{.cc}.} as your source
13876 file.  For example, in @file{allclass.cc}, giving just
13877 @samp{#pragma implementation}
13878 by itself is equivalent to @samp{#pragma implementation "allclass.h"}.
13879
13880 In versions of GNU C++ prior to 2.6.0 @file{allclass.h} was treated as
13881 an implementation file whenever you would include it from
13882 @file{allclass.cc} even if you never specified @samp{#pragma
13883 implementation}.  This was deemed to be more trouble than it was worth,
13884 however, and disabled.
13885
13886 Use the string argument if you want a single implementation file to
13887 include code from multiple header files.  (You must also use
13888 @samp{#include} to include the header file; @samp{#pragma
13889 implementation} only specifies how to use the file---it doesn't actually
13890 include it.)
13891
13892 There is no way to split up the contents of a single header file into
13893 multiple implementation files.
13894 @end table
13895
13896 @cindex inlining and C++ pragmas
13897 @cindex C++ pragmas, effect on inlining
13898 @cindex pragmas in C++, effect on inlining
13899 @samp{#pragma implementation} and @samp{#pragma interface} also have an
13900 effect on function inlining.
13901
13902 If you define a class in a header file marked with @samp{#pragma
13903 interface}, the effect on an inline function defined in that class is
13904 similar to an explicit @code{extern} declaration---the compiler emits
13905 no code at all to define an independent version of the function.  Its
13906 definition is used only for inlining with its callers.
13907
13908 @opindex fno-implement-inlines
13909 Conversely, when you include the same header file in a main source file
13910 that declares it as @samp{#pragma implementation}, the compiler emits
13911 code for the function itself; this defines a version of the function
13912 that can be found via pointers (or by callers compiled without
13913 inlining).  If all calls to the function can be inlined, you can avoid
13914 emitting the function by compiling with @option{-fno-implement-inlines}.
13915 If any calls were not inlined, you will get linker errors.
13916
13917 @node Template Instantiation
13918 @section Where's the Template?
13919 @cindex template instantiation
13920
13921 C++ templates are the first language feature to require more
13922 intelligence from the environment than one usually finds on a UNIX
13923 system.  Somehow the compiler and linker have to make sure that each
13924 template instance occurs exactly once in the executable if it is needed,
13925 and not at all otherwise.  There are two basic approaches to this
13926 problem, which are referred to as the Borland model and the Cfront model.
13927
13928 @table @asis
13929 @item Borland model
13930 Borland C++ solved the template instantiation problem by adding the code
13931 equivalent of common blocks to their linker; the compiler emits template
13932 instances in each translation unit that uses them, and the linker
13933 collapses them together.  The advantage of this model is that the linker
13934 only has to consider the object files themselves; there is no external
13935 complexity to worry about.  This disadvantage is that compilation time
13936 is increased because the template code is being compiled repeatedly.
13937 Code written for this model tends to include definitions of all
13938 templates in the header file, since they must be seen to be
13939 instantiated.
13940
13941 @item Cfront model
13942 The AT&T C++ translator, Cfront, solved the template instantiation
13943 problem by creating the notion of a template repository, an
13944 automatically maintained place where template instances are stored.  A
13945 more modern version of the repository works as follows: As individual
13946 object files are built, the compiler places any template definitions and
13947 instantiations encountered in the repository.  At link time, the link
13948 wrapper adds in the objects in the repository and compiles any needed
13949 instances that were not previously emitted.  The advantages of this
13950 model are more optimal compilation speed and the ability to use the
13951 system linker; to implement the Borland model a compiler vendor also
13952 needs to replace the linker.  The disadvantages are vastly increased
13953 complexity, and thus potential for error; for some code this can be
13954 just as transparent, but in practice it can been very difficult to build
13955 multiple programs in one directory and one program in multiple
13956 directories.  Code written for this model tends to separate definitions
13957 of non-inline member templates into a separate file, which should be
13958 compiled separately.
13959 @end table
13960
13961 When used with GNU ld version 2.8 or later on an ELF system such as
13962 GNU/Linux or Solaris 2, or on Microsoft Windows, G++ supports the
13963 Borland model.  On other systems, G++ implements neither automatic
13964 model.
13965
13966 A future version of G++ will support a hybrid model whereby the compiler
13967 will emit any instantiations for which the template definition is
13968 included in the compile, and store template definitions and
13969 instantiation context information into the object file for the rest.
13970 The link wrapper will extract that information as necessary and invoke
13971 the compiler to produce the remaining instantiations.  The linker will
13972 then combine duplicate instantiations.
13973
13974 In the mean time, you have the following options for dealing with
13975 template instantiations:
13976
13977 @enumerate
13978 @item
13979 @opindex frepo
13980 Compile your template-using code with @option{-frepo}.  The compiler will
13981 generate files with the extension @samp{.rpo} listing all of the
13982 template instantiations used in the corresponding object files which
13983 could be instantiated there; the link wrapper, @samp{collect2}, will
13984 then update the @samp{.rpo} files to tell the compiler where to place
13985 those instantiations and rebuild any affected object files.  The
13986 link-time overhead is negligible after the first pass, as the compiler
13987 will continue to place the instantiations in the same files.
13988
13989 This is your best option for application code written for the Borland
13990 model, as it will just work.  Code written for the Cfront model will
13991 need to be modified so that the template definitions are available at
13992 one or more points of instantiation; usually this is as simple as adding
13993 @code{#include <tmethods.cc>} to the end of each template header.
13994
13995 For library code, if you want the library to provide all of the template
13996 instantiations it needs, just try to link all of its object files
13997 together; the link will fail, but cause the instantiations to be
13998 generated as a side effect.  Be warned, however, that this may cause
13999 conflicts if multiple libraries try to provide the same instantiations.
14000 For greater control, use explicit instantiation as described in the next
14001 option.
14002
14003 @item
14004 @opindex fno-implicit-templates
14005 Compile your code with @option{-fno-implicit-templates} to disable the
14006 implicit generation of template instances, and explicitly instantiate
14007 all the ones you use.  This approach requires more knowledge of exactly
14008 which instances you need than do the others, but it's less
14009 mysterious and allows greater control.  You can scatter the explicit
14010 instantiations throughout your program, perhaps putting them in the
14011 translation units where the instances are used or the translation units
14012 that define the templates themselves; you can put all of the explicit
14013 instantiations you need into one big file; or you can create small files
14014 like
14015
14016 @smallexample
14017 #include "Foo.h"
14018 #include "Foo.cc"
14019
14020 template class Foo<int>;
14021 template ostream& operator <<
14022                 (ostream&, const Foo<int>&);
14023 @end smallexample
14024
14025 for each of the instances you need, and create a template instantiation
14026 library from those.
14027
14028 If you are using Cfront-model code, you can probably get away with not
14029 using @option{-fno-implicit-templates} when compiling files that don't
14030 @samp{#include} the member template definitions.
14031
14032 If you use one big file to do the instantiations, you may want to
14033 compile it without @option{-fno-implicit-templates} so you get all of the
14034 instances required by your explicit instantiations (but not by any
14035 other files) without having to specify them as well.
14036
14037 G++ has extended the template instantiation syntax given in the ISO
14038 standard to allow forward declaration of explicit instantiations
14039 (with @code{extern}), instantiation of the compiler support data for a
14040 template class (i.e.@: the vtable) without instantiating any of its
14041 members (with @code{inline}), and instantiation of only the static data
14042 members of a template class, without the support data or member
14043 functions (with (@code{static}):
14044
14045 @smallexample
14046 extern template int max (int, int);
14047 inline template class Foo<int>;
14048 static template class Foo<int>;
14049 @end smallexample
14050
14051 @item
14052 Do nothing.  Pretend G++ does implement automatic instantiation
14053 management.  Code written for the Borland model will work fine, but
14054 each translation unit will contain instances of each of the templates it
14055 uses.  In a large program, this can lead to an unacceptable amount of code
14056 duplication.
14057 @end enumerate
14058
14059 @node Bound member functions
14060 @section Extracting the function pointer from a bound pointer to member function
14061 @cindex pmf
14062 @cindex pointer to member function
14063 @cindex bound pointer to member function
14064
14065 In C++, pointer to member functions (PMFs) are implemented using a wide
14066 pointer of sorts to handle all the possible call mechanisms; the PMF
14067 needs to store information about how to adjust the @samp{this} pointer,
14068 and if the function pointed to is virtual, where to find the vtable, and
14069 where in the vtable to look for the member function.  If you are using
14070 PMFs in an inner loop, you should really reconsider that decision.  If
14071 that is not an option, you can extract the pointer to the function that
14072 would be called for a given object/PMF pair and call it directly inside
14073 the inner loop, to save a bit of time.
14074
14075 Note that you will still be paying the penalty for the call through a
14076 function pointer; on most modern architectures, such a call defeats the
14077 branch prediction features of the CPU@.  This is also true of normal
14078 virtual function calls.
14079
14080 The syntax for this extension is
14081
14082 @smallexample
14083 extern A a;
14084 extern int (A::*fp)();
14085 typedef int (*fptr)(A *);
14086
14087 fptr p = (fptr)(a.*fp);
14088 @end smallexample
14089
14090 For PMF constants (i.e.@: expressions of the form @samp{&Klasse::Member}),
14091 no object is needed to obtain the address of the function.  They can be
14092 converted to function pointers directly:
14093
14094 @smallexample
14095 fptr p1 = (fptr)(&A::foo);
14096 @end smallexample
14097
14098 @opindex Wno-pmf-conversions
14099 You must specify @option{-Wno-pmf-conversions} to use this extension.
14100
14101 @node C++ Attributes
14102 @section C++-Specific Variable, Function, and Type Attributes
14103
14104 Some attributes only make sense for C++ programs.
14105
14106 @table @code
14107 @item init_priority (@var{priority})
14108 @cindex @code{init_priority} attribute
14109
14110
14111 In Standard C++, objects defined at namespace scope are guaranteed to be
14112 initialized in an order in strict accordance with that of their definitions
14113 @emph{in a given translation unit}.  No guarantee is made for initializations
14114 across translation units.  However, GNU C++ allows users to control the
14115 order of initialization of objects defined at namespace scope with the
14116 @code{init_priority} attribute by specifying a relative @var{priority},
14117 a constant integral expression currently bounded between 101 and 65535
14118 inclusive.  Lower numbers indicate a higher priority.
14119
14120 In the following example, @code{A} would normally be created before
14121 @code{B}, but the @code{init_priority} attribute has reversed that order:
14122
14123 @smallexample
14124 Some_Class  A  __attribute__ ((init_priority (2000)));
14125 Some_Class  B  __attribute__ ((init_priority (543)));
14126 @end smallexample
14127
14128 @noindent
14129 Note that the particular values of @var{priority} do not matter; only their
14130 relative ordering.
14131
14132 @item java_interface
14133 @cindex @code{java_interface} attribute
14134
14135 This type attribute informs C++ that the class is a Java interface.  It may
14136 only be applied to classes declared within an @code{extern "Java"} block.
14137 Calls to methods declared in this interface will be dispatched using GCJ's
14138 interface table mechanism, instead of regular virtual table dispatch.
14139
14140 @end table
14141
14142 See also @ref{Namespace Association}.
14143
14144 @node Namespace Association
14145 @section Namespace Association
14146
14147 @strong{Caution:} The semantics of this extension are not fully
14148 defined.  Users should refrain from using this extension as its
14149 semantics may change subtly over time.  It is possible that this
14150 extension will be removed in future versions of G++.
14151
14152 A using-directive with @code{__attribute ((strong))} is stronger
14153 than a normal using-directive in two ways:
14154
14155 @itemize @bullet
14156 @item
14157 Templates from the used namespace can be specialized and explicitly
14158 instantiated as though they were members of the using namespace.
14159
14160 @item
14161 The using namespace is considered an associated namespace of all
14162 templates in the used namespace for purposes of argument-dependent
14163 name lookup.
14164 @end itemize
14165
14166 The used namespace must be nested within the using namespace so that
14167 normal unqualified lookup works properly.
14168
14169 This is useful for composing a namespace transparently from
14170 implementation namespaces.  For example:
14171
14172 @smallexample
14173 namespace std @{
14174   namespace debug @{
14175     template <class T> struct A @{ @};
14176   @}
14177   using namespace debug __attribute ((__strong__));
14178   template <> struct A<int> @{ @};   // @r{ok to specialize}
14179
14180   template <class T> void f (A<T>);
14181 @}
14182
14183 int main()
14184 @{
14185   f (std::A<float>());             // @r{lookup finds} std::f
14186   f (std::A<int>());
14187 @}
14188 @end smallexample
14189
14190 @node Type Traits
14191 @section Type Traits
14192
14193 The C++ front-end implements syntactic extensions that allow to
14194 determine at compile time various characteristics of a type (or of a
14195 pair of types).
14196
14197 @table @code
14198 @item __has_nothrow_assign (type)
14199 If @code{type} is const qualified or is a reference type then the trait is
14200 false.  Otherwise if @code{__has_trivial_assign (type)} is true then the trait
14201 is true, else if @code{type} is a cv class or union type with copy assignment
14202 operators that are known not to throw an exception then the trait is true,
14203 else it is false.  Requires: @code{type} shall be a complete type, an array
14204 type of unknown bound, or is a @code{void} type.
14205
14206 @item __has_nothrow_copy (type)
14207 If @code{__has_trivial_copy (type)} is true then the trait is true, else if
14208 @code{type} is a cv class or union type with copy constructors that
14209 are known not to throw an exception then the trait is true, else it is false.
14210 Requires: @code{type} shall be a complete type, an array type of
14211 unknown bound, or is a @code{void} type.
14212
14213 @item __has_nothrow_constructor (type)
14214 If @code{__has_trivial_constructor (type)} is true then the trait is
14215 true, else if @code{type} is a cv class or union type (or array
14216 thereof) with a default constructor that is known not to throw an
14217 exception then the trait is true, else it is false.  Requires:
14218 @code{type} shall be a complete type, an array type of unknown bound,
14219 or is a @code{void} type.
14220
14221 @item __has_trivial_assign (type)
14222 If @code{type} is const qualified or is a reference type then the trait is
14223 false.  Otherwise if @code{__is_pod (type)} is true then the trait is
14224 true, else if @code{type} is a cv class or union type with a trivial
14225 copy assignment ([class.copy]) then the trait is true, else it is
14226 false.  Requires: @code{type} shall be a complete type, an array type
14227 of unknown bound, or is a @code{void} type.
14228
14229 @item __has_trivial_copy (type)
14230 If @code{__is_pod (type)} is true or @code{type} is a reference type 
14231 then the trait is true, else if @code{type} is a cv class or union type
14232 with a trivial copy constructor ([class.copy]) then the trait
14233 is true, else it is false.  Requires: @code{type} shall be a complete
14234 type, an array type of unknown bound, or is a @code{void} type.
14235
14236 @item __has_trivial_constructor (type)
14237 If @code{__is_pod (type)} is true then the trait is true, else if
14238 @code{type} is a cv class or union type (or array thereof) with a
14239 trivial default constructor ([class.ctor]) then the trait is true,
14240 else it is false.  Requires: @code{type} shall be a complete type, an
14241 array type of unknown bound, or is a @code{void} type.
14242
14243 @item __has_trivial_destructor (type)
14244 If @code{__is_pod (type)} is true or @code{type} is a reference type then
14245 the trait is true, else if @code{type} is a cv class or union type (or
14246 array thereof) with a trivial destructor ([class.dtor]) then the trait
14247 is true, else it is false.  Requires: @code{type} shall be a complete
14248 type, an array type of unknown bound, or is a @code{void} type.
14249
14250 @item __has_virtual_destructor (type)
14251 If @code{type} is a class type with a virtual destructor
14252 ([class.dtor]) then the trait is true, else it is false.  Requires:
14253 @code{type}  shall be a complete type, an array type of unknown bound,
14254 or is a @code{void} type.
14255
14256 @item __is_abstract (type)
14257 If @code{type} is an abstract class ([class.abstract]) then the trait
14258 is true, else it is false.  Requires: @code{type} shall be a complete
14259 type, an array type of unknown bound, or is a @code{void} type.
14260
14261 @item __is_base_of (base_type, derived_type)
14262 If @code{base_type} is a base class of @code{derived_type}
14263 ([class.derived]) then the trait is true, otherwise it is false.
14264 Top-level cv qualifications of @code{base_type} and
14265 @code{derived_type} are ignored.  For the purposes of this trait, a
14266 class type is considered is own base.  Requires: if @code{__is_class
14267 (base_type)} and @code{__is_class (derived_type)} are true and
14268 @code{base_type} and @code{derived_type} are not the same type
14269 (disregarding cv-qualifiers), @code{derived_type} shall be a complete
14270 type.  Diagnostic is produced if this requirement is not met.
14271
14272 @item __is_class (type)
14273 If @code{type} is a cv class type, and not a union type
14274 ([basic.compound]) the trait is true, else it is false.
14275
14276 @item __is_empty (type)
14277 If @code{__is_class (type)} is false then the trait is false.
14278 Otherwise @code{type} is considered empty if and only if: @code{type}
14279 has no non-static data members, or all non-static data members, if
14280 any, are bit-fields of length 0, and @code{type} has no virtual
14281 members, and @code{type} has no virtual base classes, and @code{type}
14282 has no base classes @code{base_type} for which 
14283 @code{__is_empty (base_type)} is false.  Requires: @code{type} shall
14284 be a complete type, an array type of unknown bound, or is a
14285 @code{void} type.
14286
14287 @item __is_enum (type)
14288 If @code{type} is a cv enumeration type ([basic.compound]) the trait is
14289 true, else it is false.
14290
14291 @item __is_pod (type)
14292 If @code{type} is a cv POD type ([basic.types]) then the trait is true,
14293 else it is false.  Requires: @code{type} shall be a complete type, 
14294 an array type of unknown bound, or is a @code{void} type.
14295
14296 @item __is_polymorphic (type)
14297 If @code{type} is a polymorphic class ([class.virtual]) then the trait
14298 is true, else it is false.  Requires: @code{type} shall be a complete
14299 type, an array type of unknown bound, or is a @code{void} type.
14300
14301 @item __is_union (type)
14302 If @code{type} is a cv union type ([basic.compound]) the trait is
14303 true, else it is false.
14304
14305 @end table
14306
14307 @node Java Exceptions
14308 @section Java Exceptions
14309
14310 The Java language uses a slightly different exception handling model
14311 from C++.  Normally, GNU C++ will automatically detect when you are
14312 writing C++ code that uses Java exceptions, and handle them
14313 appropriately.  However, if C++ code only needs to execute destructors
14314 when Java exceptions are thrown through it, GCC will guess incorrectly.
14315 Sample problematic code is:
14316
14317 @smallexample
14318   struct S @{ ~S(); @};
14319   extern void bar();    // @r{is written in Java, and may throw exceptions}
14320   void foo()
14321   @{
14322     S s;
14323     bar();
14324   @}
14325 @end smallexample
14326
14327 @noindent
14328 The usual effect of an incorrect guess is a link failure, complaining of
14329 a missing routine called @samp{__gxx_personality_v0}.
14330
14331 You can inform the compiler that Java exceptions are to be used in a
14332 translation unit, irrespective of what it might think, by writing
14333 @samp{@w{#pragma GCC java_exceptions}} at the head of the file.  This
14334 @samp{#pragma} must appear before any functions that throw or catch
14335 exceptions, or run destructors when exceptions are thrown through them.
14336
14337 You cannot mix Java and C++ exceptions in the same translation unit.  It
14338 is believed to be safe to throw a C++ exception from one file through
14339 another file compiled for the Java exception model, or vice versa, but
14340 there may be bugs in this area.
14341
14342 @node Deprecated Features
14343 @section Deprecated Features
14344
14345 In the past, the GNU C++ compiler was extended to experiment with new
14346 features, at a time when the C++ language was still evolving.  Now that
14347 the C++ standard is complete, some of those features are superseded by
14348 superior alternatives.  Using the old features might cause a warning in
14349 some cases that the feature will be dropped in the future.  In other
14350 cases, the feature might be gone already.
14351
14352 While the list below is not exhaustive, it documents some of the options
14353 that are now deprecated:
14354
14355 @table @code
14356 @item -fexternal-templates
14357 @itemx -falt-external-templates
14358 These are two of the many ways for G++ to implement template
14359 instantiation.  @xref{Template Instantiation}.  The C++ standard clearly
14360 defines how template definitions have to be organized across
14361 implementation units.  G++ has an implicit instantiation mechanism that
14362 should work just fine for standard-conforming code.
14363
14364 @item -fstrict-prototype
14365 @itemx -fno-strict-prototype
14366 Previously it was possible to use an empty prototype parameter list to
14367 indicate an unspecified number of parameters (like C), rather than no
14368 parameters, as C++ demands.  This feature has been removed, except where
14369 it is required for backwards compatibility.   @xref{Backwards Compatibility}.
14370 @end table
14371
14372 G++ allows a virtual function returning @samp{void *} to be overridden
14373 by one returning a different pointer type.  This extension to the
14374 covariant return type rules is now deprecated and will be removed from a
14375 future version.
14376
14377 The G++ minimum and maximum operators (@samp{<?} and @samp{>?}) and
14378 their compound forms (@samp{<?=}) and @samp{>?=}) have been deprecated
14379 and are now removed from G++.  Code using these operators should be
14380 modified to use @code{std::min} and @code{std::max} instead.
14381
14382 The named return value extension has been deprecated, and is now
14383 removed from G++.
14384
14385 The use of initializer lists with new expressions has been deprecated,
14386 and is now removed from G++.
14387
14388 Floating and complex non-type template parameters have been deprecated,
14389 and are now removed from G++.
14390
14391 The implicit typename extension has been deprecated and is now
14392 removed from G++.
14393
14394 The use of default arguments in function pointers, function typedefs
14395 and other places where they are not permitted by the standard is
14396 deprecated and will be removed from a future version of G++.
14397
14398 G++ allows floating-point literals to appear in integral constant expressions,
14399 e.g. @samp{ enum E @{ e = int(2.2 * 3.7) @} }
14400 This extension is deprecated and will be removed from a future version.
14401
14402 G++ allows static data members of const floating-point type to be declared
14403 with an initializer in a class definition. The standard only allows
14404 initializers for static members of const integral types and const
14405 enumeration types so this extension has been deprecated and will be removed
14406 from a future version.
14407
14408 @node Backwards Compatibility
14409 @section Backwards Compatibility
14410 @cindex Backwards Compatibility
14411 @cindex ARM [Annotated C++ Reference Manual]
14412
14413 Now that there is a definitive ISO standard C++, G++ has a specification
14414 to adhere to.  The C++ language evolved over time, and features that
14415 used to be acceptable in previous drafts of the standard, such as the ARM
14416 [Annotated C++ Reference Manual], are no longer accepted.  In order to allow
14417 compilation of C++ written to such drafts, G++ contains some backwards
14418 compatibilities.  @emph{All such backwards compatibility features are
14419 liable to disappear in future versions of G++.} They should be considered
14420 deprecated.   @xref{Deprecated Features}.
14421
14422 @table @code
14423 @item For scope
14424 If a variable is declared at for scope, it used to remain in scope until
14425 the end of the scope which contained the for statement (rather than just
14426 within the for scope).  G++ retains this, but issues a warning, if such a
14427 variable is accessed outside the for scope.
14428
14429 @item Implicit C language
14430 Old C system header files did not contain an @code{extern "C" @{@dots{}@}}
14431 scope to set the language.  On such systems, all header files are
14432 implicitly scoped inside a C language scope.  Also, an empty prototype
14433 @code{()} will be treated as an unspecified number of arguments, rather
14434 than no arguments, as C++ demands.
14435 @end table