OSDN Git Service

de3a1211c738d160697cbc159acff14c47dc37c0
[pf3gnuchains/gcc-fork.git] / gcc / doc / extend.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1996, 1998, 1999, 2000,
2 @c 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
3
4 @c This is part of the GCC manual.
5 @c For copying conditions, see the file gcc.texi.
6
7 @node C Extensions
8 @chapter Extensions to the C Language Family
9 @cindex extensions, C language
10 @cindex C language extensions
11
12 @opindex pedantic
13 GNU C provides several language features not found in ISO standard C@.
14 (The @option{-pedantic} option directs GCC to print a warning message if
15 any of these features is used.)  To test for the availability of these
16 features in conditional compilation, check for a predefined macro
17 @code{__GNUC__}, which is always defined under GCC@.
18
19 These extensions are available in C and Objective-C@.  Most of them are
20 also available in C++.  @xref{C++ Extensions,,Extensions to the
21 C++ Language}, for extensions that apply @emph{only} to C++.
22
23 Some features that are in ISO C99 but not C89 or C++ are also, as
24 extensions, accepted by GCC in C89 mode and in C++.
25
26 @menu
27 * Statement Exprs::     Putting statements and declarations inside expressions.
28 * Local Labels::        Labels local to a block.
29 * Labels as Values::    Getting pointers to labels, and computed gotos.
30 * Nested Functions::    As in Algol and Pascal, lexical scoping of functions.
31 * Constructing Calls::  Dispatching a call to another function.
32 * Typeof::              @code{typeof}: referring to the type of an expression.
33 * Conditionals::        Omitting the middle operand of a @samp{?:} expression.
34 * Long Long::           Double-word integers---@code{long long int}.
35 * Complex::             Data types for complex numbers.
36 * Floating Types::      Additional Floating Types.
37 * Decimal Float::       Decimal Floating Types. 
38 * Hex Floats::          Hexadecimal floating-point constants.
39 * Fixed-Point::         Fixed-Point Types.
40 * Zero Length::         Zero-length arrays.
41 * Variable Length::     Arrays whose length is computed at run time.
42 * Empty Structures::    Structures with no members.
43 * Variadic Macros::     Macros with a variable number of arguments.
44 * Escaped Newlines::    Slightly looser rules for escaped newlines.
45 * Subscripting::        Any array can be subscripted, even if not an lvalue.
46 * Pointer Arith::       Arithmetic on @code{void}-pointers and function pointers.
47 * Initializers::        Non-constant initializers.
48 * Compound Literals::   Compound literals give structures, unions
49                          or arrays as values.
50 * Designated Inits::    Labeling elements of initializers.
51 * Cast to Union::       Casting to union type from any member of the union.
52 * Case Ranges::         `case 1 ... 9' and such.
53 * Mixed Declarations::  Mixing declarations and code.
54 * Function Attributes:: Declaring that functions have no side effects,
55                          or that they can never return.
56 * Attribute Syntax::    Formal syntax for attributes.
57 * Function Prototypes:: Prototype declarations and old-style definitions.
58 * C++ Comments::        C++ comments are recognized.
59 * Dollar Signs::        Dollar sign is allowed in identifiers.
60 * Character Escapes::   @samp{\e} stands for the character @key{ESC}.
61 * Variable Attributes:: Specifying attributes of variables.
62 * Type Attributes::     Specifying attributes of types.
63 * Alignment::           Inquiring about the alignment of a type or variable.
64 * Inline::              Defining inline functions (as fast as macros).
65 * Extended Asm::        Assembler instructions with C expressions as operands.
66                          (With them you can define ``built-in'' functions.)
67 * Constraints::         Constraints for asm operands
68 * Asm Labels::          Specifying the assembler name to use for a C symbol.
69 * Explicit Reg Vars::   Defining variables residing in specified registers.
70 * Alternate Keywords::  @code{__const__}, @code{__asm__}, etc., for header files.
71 * Incomplete Enums::    @code{enum foo;}, with details to follow.
72 * Function Names::      Printable strings which are the name of the current
73                          function.
74 * Return Address::      Getting the return or frame address of a function.
75 * Vector Extensions::   Using vector instructions through built-in functions.
76 * Offsetof::            Special syntax for implementing @code{offsetof}.
77 * Atomic Builtins::     Built-in functions for atomic memory access.
78 * Object Size Checking:: Built-in functions for limited buffer overflow
79                         checking.
80 * Other Builtins::      Other built-in functions.
81 * Target Builtins::     Built-in functions specific to particular targets.
82 * Target Format Checks:: Format checks specific to particular targets.
83 * Pragmas::             Pragmas accepted by GCC.
84 * Unnamed Fields::      Unnamed struct/union fields within structs/unions.
85 * Thread-Local::        Per-thread variables.
86 * Binary constants::    Binary constants using the @samp{0b} prefix.
87 @end menu
88
89 @node Statement Exprs
90 @section Statements and Declarations in Expressions
91 @cindex statements inside expressions
92 @cindex declarations inside expressions
93 @cindex expressions containing statements
94 @cindex macros, statements in expressions
95
96 @c the above section title wrapped and causes an underfull hbox.. i
97 @c changed it from "within" to "in". --mew 4feb93
98 A compound statement enclosed in parentheses may appear as an expression
99 in GNU C@.  This allows you to use loops, switches, and local variables
100 within an expression.
101
102 Recall that a compound statement is a sequence of statements surrounded
103 by braces; in this construct, parentheses go around the braces.  For
104 example:
105
106 @smallexample
107 (@{ int y = foo (); int z;
108    if (y > 0) z = y;
109    else z = - y;
110    z; @})
111 @end smallexample
112
113 @noindent
114 is a valid (though slightly more complex than necessary) expression
115 for the absolute value of @code{foo ()}.
116
117 The last thing in the compound statement should be an expression
118 followed by a semicolon; the value of this subexpression serves as the
119 value of the entire construct.  (If you use some other kind of statement
120 last within the braces, the construct has type @code{void}, and thus
121 effectively no value.)
122
123 This feature is especially useful in making macro definitions ``safe'' (so
124 that they evaluate each operand exactly once).  For example, the
125 ``maximum'' function is commonly defined as a macro in standard C as
126 follows:
127
128 @smallexample
129 #define max(a,b) ((a) > (b) ? (a) : (b))
130 @end smallexample
131
132 @noindent
133 @cindex side effects, macro argument
134 But this definition computes either @var{a} or @var{b} twice, with bad
135 results if the operand has side effects.  In GNU C, if you know the
136 type of the operands (here taken as @code{int}), you can define
137 the macro safely as follows:
138
139 @smallexample
140 #define maxint(a,b) \
141   (@{int _a = (a), _b = (b); _a > _b ? _a : _b; @})
142 @end smallexample
143
144 Embedded statements are not allowed in constant expressions, such as
145 the value of an enumeration constant, the width of a bit-field, or
146 the initial value of a static variable.
147
148 If you don't know the type of the operand, you can still do this, but you
149 must use @code{typeof} (@pxref{Typeof}).
150
151 In G++, the result value of a statement expression undergoes array and
152 function pointer decay, and is returned by value to the enclosing
153 expression.  For instance, if @code{A} is a class, then
154
155 @smallexample
156         A a;
157
158         (@{a;@}).Foo ()
159 @end smallexample
160
161 @noindent
162 will construct a temporary @code{A} object to hold the result of the
163 statement expression, and that will be used to invoke @code{Foo}.
164 Therefore the @code{this} pointer observed by @code{Foo} will not be the
165 address of @code{a}.
166
167 Any temporaries created within a statement within a statement expression
168 will be destroyed at the statement's end.  This makes statement
169 expressions inside macros slightly different from function calls.  In
170 the latter case temporaries introduced during argument evaluation will
171 be destroyed at the end of the statement that includes the function
172 call.  In the statement expression case they will be destroyed during
173 the statement expression.  For instance,
174
175 @smallexample
176 #define macro(a)  (@{__typeof__(a) b = (a); b + 3; @})
177 template<typename T> T function(T a) @{ T b = a; return b + 3; @}
178
179 void foo ()
180 @{
181   macro (X ());
182   function (X ());
183 @}
184 @end smallexample
185
186 @noindent
187 will have different places where temporaries are destroyed.  For the
188 @code{macro} case, the temporary @code{X} will be destroyed just after
189 the initialization of @code{b}.  In the @code{function} case that
190 temporary will be destroyed when the function returns.
191
192 These considerations mean that it is probably a bad idea to use
193 statement-expressions of this form in header files that are designed to
194 work with C++.  (Note that some versions of the GNU C Library contained
195 header files using statement-expression that lead to precisely this
196 bug.)
197
198 Jumping into a statement expression with @code{goto} or using a
199 @code{switch} statement outside the statement expression with a
200 @code{case} or @code{default} label inside the statement expression is
201 not permitted.  Jumping into a statement expression with a computed
202 @code{goto} (@pxref{Labels as Values}) yields undefined behavior.
203 Jumping out of a statement expression is permitted, but if the
204 statement expression is part of a larger expression then it is
205 unspecified which other subexpressions of that expression have been
206 evaluated except where the language definition requires certain
207 subexpressions to be evaluated before or after the statement
208 expression.  In any case, as with a function call the evaluation of a
209 statement expression is not interleaved with the evaluation of other
210 parts of the containing expression.  For example,
211
212 @smallexample
213   foo (), ((@{ bar1 (); goto a; 0; @}) + bar2 ()), baz();
214 @end smallexample
215
216 @noindent
217 will call @code{foo} and @code{bar1} and will not call @code{baz} but
218 may or may not call @code{bar2}.  If @code{bar2} is called, it will be
219 called after @code{foo} and before @code{bar1}
220
221 @node Local Labels
222 @section Locally Declared Labels
223 @cindex local labels
224 @cindex macros, local labels
225
226 GCC allows you to declare @dfn{local labels} in any nested block
227 scope.  A local label is just like an ordinary label, but you can
228 only reference it (with a @code{goto} statement, or by taking its
229 address) within the block in which it was declared.
230
231 A local label declaration looks like this:
232
233 @smallexample
234 __label__ @var{label};
235 @end smallexample
236
237 @noindent
238 or
239
240 @smallexample
241 __label__ @var{label1}, @var{label2}, /* @r{@dots{}} */;
242 @end smallexample
243
244 Local label declarations must come at the beginning of the block,
245 before any ordinary declarations or statements.
246
247 The label declaration defines the label @emph{name}, but does not define
248 the label itself.  You must do this in the usual way, with
249 @code{@var{label}:}, within the statements of the statement expression.
250
251 The local label feature is useful for complex macros.  If a macro
252 contains nested loops, a @code{goto} can be useful for breaking out of
253 them.  However, an ordinary label whose scope is the whole function
254 cannot be used: if the macro can be expanded several times in one
255 function, the label will be multiply defined in that function.  A
256 local label avoids this problem.  For example:
257
258 @smallexample
259 #define SEARCH(value, array, target)              \
260 do @{                                              \
261   __label__ found;                                \
262   typeof (target) _SEARCH_target = (target);      \
263   typeof (*(array)) *_SEARCH_array = (array);     \
264   int i, j;                                       \
265   int value;                                      \
266   for (i = 0; i < max; i++)                       \
267     for (j = 0; j < max; j++)                     \
268       if (_SEARCH_array[i][j] == _SEARCH_target)  \
269         @{ (value) = i; goto found; @}              \
270   (value) = -1;                                   \
271  found:;                                          \
272 @} while (0)
273 @end smallexample
274
275 This could also be written using a statement-expression:
276
277 @smallexample
278 #define SEARCH(array, target)                     \
279 (@{                                                \
280   __label__ found;                                \
281   typeof (target) _SEARCH_target = (target);      \
282   typeof (*(array)) *_SEARCH_array = (array);     \
283   int i, j;                                       \
284   int value;                                      \
285   for (i = 0; i < max; i++)                       \
286     for (j = 0; j < max; j++)                     \
287       if (_SEARCH_array[i][j] == _SEARCH_target)  \
288         @{ value = i; goto found; @}                \
289   value = -1;                                     \
290  found:                                           \
291   value;                                          \
292 @})
293 @end smallexample
294
295 Local label declarations also make the labels they declare visible to
296 nested functions, if there are any.  @xref{Nested Functions}, for details.
297
298 @node Labels as Values
299 @section Labels as Values
300 @cindex labels as values
301 @cindex computed gotos
302 @cindex goto with computed label
303 @cindex address of a label
304
305 You can get the address of a label defined in the current function
306 (or a containing function) with the unary operator @samp{&&}.  The
307 value has type @code{void *}.  This value is a constant and can be used
308 wherever a constant of that type is valid.  For example:
309
310 @smallexample
311 void *ptr;
312 /* @r{@dots{}} */
313 ptr = &&foo;
314 @end smallexample
315
316 To use these values, you need to be able to jump to one.  This is done
317 with the computed goto statement@footnote{The analogous feature in
318 Fortran is called an assigned goto, but that name seems inappropriate in
319 C, where one can do more than simply store label addresses in label
320 variables.}, @code{goto *@var{exp};}.  For example,
321
322 @smallexample
323 goto *ptr;
324 @end smallexample
325
326 @noindent
327 Any expression of type @code{void *} is allowed.
328
329 One way of using these constants is in initializing a static array that
330 will serve as a jump table:
331
332 @smallexample
333 static void *array[] = @{ &&foo, &&bar, &&hack @};
334 @end smallexample
335
336 Then you can select a label with indexing, like this:
337
338 @smallexample
339 goto *array[i];
340 @end smallexample
341
342 @noindent
343 Note that this does not check whether the subscript is in bounds---array
344 indexing in C never does that.
345
346 Such an array of label values serves a purpose much like that of the
347 @code{switch} statement.  The @code{switch} statement is cleaner, so
348 use that rather than an array unless the problem does not fit a
349 @code{switch} statement very well.
350
351 Another use of label values is in an interpreter for threaded code.
352 The labels within the interpreter function can be stored in the
353 threaded code for super-fast dispatching.
354
355 You may not use this mechanism to jump to code in a different function.
356 If you do that, totally unpredictable things will happen.  The best way to
357 avoid this is to store the label address only in automatic variables and
358 never pass it as an argument.
359
360 An alternate way to write the above example is
361
362 @smallexample
363 static const int array[] = @{ &&foo - &&foo, &&bar - &&foo,
364                              &&hack - &&foo @};
365 goto *(&&foo + array[i]);
366 @end smallexample
367
368 @noindent
369 This is more friendly to code living in shared libraries, as it reduces
370 the number of dynamic relocations that are needed, and by consequence,
371 allows the data to be read-only.
372
373 @node Nested Functions
374 @section Nested Functions
375 @cindex nested functions
376 @cindex downward funargs
377 @cindex thunks
378
379 A @dfn{nested function} is a function defined inside another function.
380 (Nested functions are not supported for GNU C++.)  The nested function's
381 name is local to the block where it is defined.  For example, here we
382 define a nested function named @code{square}, and call it twice:
383
384 @smallexample
385 @group
386 foo (double a, double b)
387 @{
388   double square (double z) @{ return z * z; @}
389
390   return square (a) + square (b);
391 @}
392 @end group
393 @end smallexample
394
395 The nested function can access all the variables of the containing
396 function that are visible at the point of its definition.  This is
397 called @dfn{lexical scoping}.  For example, here we show a nested
398 function which uses an inherited variable named @code{offset}:
399
400 @smallexample
401 @group
402 bar (int *array, int offset, int size)
403 @{
404   int access (int *array, int index)
405     @{ return array[index + offset]; @}
406   int i;
407   /* @r{@dots{}} */
408   for (i = 0; i < size; i++)
409     /* @r{@dots{}} */ access (array, i) /* @r{@dots{}} */
410 @}
411 @end group
412 @end smallexample
413
414 Nested function definitions are permitted within functions in the places
415 where variable definitions are allowed; that is, in any block, mixed
416 with the other declarations and statements in the block.
417
418 It is possible to call the nested function from outside the scope of its
419 name by storing its address or passing the address to another function:
420
421 @smallexample
422 hack (int *array, int size)
423 @{
424   void store (int index, int value)
425     @{ array[index] = value; @}
426
427   intermediate (store, size);
428 @}
429 @end smallexample
430
431 Here, the function @code{intermediate} receives the address of
432 @code{store} as an argument.  If @code{intermediate} calls @code{store},
433 the arguments given to @code{store} are used to store into @code{array}.
434 But this technique works only so long as the containing function
435 (@code{hack}, in this example) does not exit.
436
437 If you try to call the nested function through its address after the
438 containing function has exited, all hell will break loose.  If you try
439 to call it after a containing scope level has exited, and if it refers
440 to some of the variables that are no longer in scope, you may be lucky,
441 but it's not wise to take the risk.  If, however, the nested function
442 does not refer to anything that has gone out of scope, you should be
443 safe.
444
445 GCC implements taking the address of a nested function using a technique
446 called @dfn{trampolines}.  A paper describing them is available as
447
448 @noindent
449 @uref{http://people.debian.org/~aaronl/Usenix88-lexic.pdf}.
450
451 A nested function can jump to a label inherited from a containing
452 function, provided the label was explicitly declared in the containing
453 function (@pxref{Local Labels}).  Such a jump returns instantly to the
454 containing function, exiting the nested function which did the
455 @code{goto} and any intermediate functions as well.  Here is an example:
456
457 @smallexample
458 @group
459 bar (int *array, int offset, int size)
460 @{
461   __label__ failure;
462   int access (int *array, int index)
463     @{
464       if (index > size)
465         goto failure;
466       return array[index + offset];
467     @}
468   int i;
469   /* @r{@dots{}} */
470   for (i = 0; i < size; i++)
471     /* @r{@dots{}} */ access (array, i) /* @r{@dots{}} */
472   /* @r{@dots{}} */
473   return 0;
474
475  /* @r{Control comes here from @code{access}
476     if it detects an error.}  */
477  failure:
478   return -1;
479 @}
480 @end group
481 @end smallexample
482
483 A nested function always has no linkage.  Declaring one with
484 @code{extern} or @code{static} is erroneous.  If you need to declare the nested function
485 before its definition, use @code{auto} (which is otherwise meaningless
486 for function declarations).
487
488 @smallexample
489 bar (int *array, int offset, int size)
490 @{
491   __label__ failure;
492   auto int access (int *, int);
493   /* @r{@dots{}} */
494   int access (int *array, int index)
495     @{
496       if (index > size)
497         goto failure;
498       return array[index + offset];
499     @}
500   /* @r{@dots{}} */
501 @}
502 @end smallexample
503
504 @node Constructing Calls
505 @section Constructing Function Calls
506 @cindex constructing calls
507 @cindex forwarding calls
508
509 Using the built-in functions described below, you can record
510 the arguments a function received, and call another function
511 with the same arguments, without knowing the number or types
512 of the arguments.
513
514 You can also record the return value of that function call,
515 and later return that value, without knowing what data type
516 the function tried to return (as long as your caller expects
517 that data type).
518
519 However, these built-in functions may interact badly with some
520 sophisticated features or other extensions of the language.  It
521 is, therefore, not recommended to use them outside very simple
522 functions acting as mere forwarders for their arguments.
523
524 @deftypefn {Built-in Function} {void *} __builtin_apply_args ()
525 This built-in function returns a pointer to data
526 describing how to perform a call with the same arguments as were passed
527 to the current function.
528
529 The function saves the arg pointer register, structure value address,
530 and all registers that might be used to pass arguments to a function
531 into a block of memory allocated on the stack.  Then it returns the
532 address of that block.
533 @end deftypefn
534
535 @deftypefn {Built-in Function} {void *} __builtin_apply (void (*@var{function})(), void *@var{arguments}, size_t @var{size})
536 This built-in function invokes @var{function}
537 with a copy of the parameters described by @var{arguments}
538 and @var{size}.
539
540 The value of @var{arguments} should be the value returned by
541 @code{__builtin_apply_args}.  The argument @var{size} specifies the size
542 of the stack argument data, in bytes.
543
544 This function returns a pointer to data describing
545 how to return whatever value was returned by @var{function}.  The data
546 is saved in a block of memory allocated on the stack.
547
548 It is not always simple to compute the proper value for @var{size}.  The
549 value is used by @code{__builtin_apply} to compute the amount of data
550 that should be pushed on the stack and copied from the incoming argument
551 area.
552 @end deftypefn
553
554 @deftypefn {Built-in Function} {void} __builtin_return (void *@var{result})
555 This built-in function returns the value described by @var{result} from
556 the containing function.  You should specify, for @var{result}, a value
557 returned by @code{__builtin_apply}.
558 @end deftypefn
559
560 @deftypefn {Built-in Function} __builtin_va_arg_pack ()
561 This built-in function represents all anonymous arguments of an inline
562 function.  It can be used only in inline functions which will be always
563 inlined, never compiled as a separate function, such as those using
564 @code{__attribute__ ((__always_inline__))} or
565 @code{__attribute__ ((__gnu_inline__))} extern inline functions.
566 It must be only passed as last argument to some other function
567 with variable arguments.  This is useful for writing small wrapper
568 inlines for variable argument functions, when using preprocessor
569 macros is undesirable.  For example:
570 @smallexample
571 extern int myprintf (FILE *f, const char *format, ...);
572 extern inline __attribute__ ((__gnu_inline__)) int
573 myprintf (FILE *f, const char *format, ...)
574 @{
575   int r = fprintf (f, "myprintf: ");
576   if (r < 0)
577     return r;
578   int s = fprintf (f, format, __builtin_va_arg_pack ());
579   if (s < 0)
580     return s;
581   return r + s;
582 @}
583 @end smallexample
584 @end deftypefn
585
586 @deftypefn {Built-in Function} __builtin_va_arg_pack_len ()
587 This built-in function returns the number of anonymous arguments of
588 an inline function.  It can be used only in inline functions which
589 will be always inlined, never compiled as a separate function, such
590 as those using @code{__attribute__ ((__always_inline__))} or
591 @code{__attribute__ ((__gnu_inline__))} extern inline functions.
592 For example following will do link or runtime checking of open
593 arguments for optimized code:
594 @smallexample
595 #ifdef __OPTIMIZE__
596 extern inline __attribute__((__gnu_inline__)) int
597 myopen (const char *path, int oflag, ...)
598 @{
599   if (__builtin_va_arg_pack_len () > 1)
600     warn_open_too_many_arguments ();
601
602   if (__builtin_constant_p (oflag))
603     @{
604       if ((oflag & O_CREAT) != 0 && __builtin_va_arg_pack_len () < 1)
605         @{
606           warn_open_missing_mode ();
607           return __open_2 (path, oflag);
608         @}
609       return open (path, oflag, __builtin_va_arg_pack ());
610     @}
611     
612   if (__builtin_va_arg_pack_len () < 1)
613     return __open_2 (path, oflag);
614
615   return open (path, oflag, __builtin_va_arg_pack ());
616 @}
617 #endif
618 @end smallexample
619 @end deftypefn
620
621 @node Typeof
622 @section Referring to a Type with @code{typeof}
623 @findex typeof
624 @findex sizeof
625 @cindex macros, types of arguments
626
627 Another way to refer to the type of an expression is with @code{typeof}.
628 The syntax of using of this keyword looks like @code{sizeof}, but the
629 construct acts semantically like a type name defined with @code{typedef}.
630
631 There are two ways of writing the argument to @code{typeof}: with an
632 expression or with a type.  Here is an example with an expression:
633
634 @smallexample
635 typeof (x[0](1))
636 @end smallexample
637
638 @noindent
639 This assumes that @code{x} is an array of pointers to functions;
640 the type described is that of the values of the functions.
641
642 Here is an example with a typename as the argument:
643
644 @smallexample
645 typeof (int *)
646 @end smallexample
647
648 @noindent
649 Here the type described is that of pointers to @code{int}.
650
651 If you are writing a header file that must work when included in ISO C
652 programs, write @code{__typeof__} instead of @code{typeof}.
653 @xref{Alternate Keywords}.
654
655 A @code{typeof}-construct can be used anywhere a typedef name could be
656 used.  For example, you can use it in a declaration, in a cast, or inside
657 of @code{sizeof} or @code{typeof}.
658
659 @code{typeof} is often useful in conjunction with the
660 statements-within-expressions feature.  Here is how the two together can
661 be used to define a safe ``maximum'' macro that operates on any
662 arithmetic type and evaluates each of its arguments exactly once:
663
664 @smallexample
665 #define max(a,b) \
666   (@{ typeof (a) _a = (a); \
667       typeof (b) _b = (b); \
668     _a > _b ? _a : _b; @})
669 @end smallexample
670
671 @cindex underscores in variables in macros
672 @cindex @samp{_} in variables in macros
673 @cindex local variables in macros
674 @cindex variables, local, in macros
675 @cindex macros, local variables in
676
677 The reason for using names that start with underscores for the local
678 variables is to avoid conflicts with variable names that occur within the
679 expressions that are substituted for @code{a} and @code{b}.  Eventually we
680 hope to design a new form of declaration syntax that allows you to declare
681 variables whose scopes start only after their initializers; this will be a
682 more reliable way to prevent such conflicts.
683
684 @noindent
685 Some more examples of the use of @code{typeof}:
686
687 @itemize @bullet
688 @item
689 This declares @code{y} with the type of what @code{x} points to.
690
691 @smallexample
692 typeof (*x) y;
693 @end smallexample
694
695 @item
696 This declares @code{y} as an array of such values.
697
698 @smallexample
699 typeof (*x) y[4];
700 @end smallexample
701
702 @item
703 This declares @code{y} as an array of pointers to characters:
704
705 @smallexample
706 typeof (typeof (char *)[4]) y;
707 @end smallexample
708
709 @noindent
710 It is equivalent to the following traditional C declaration:
711
712 @smallexample
713 char *y[4];
714 @end smallexample
715
716 To see the meaning of the declaration using @code{typeof}, and why it
717 might be a useful way to write, rewrite it with these macros:
718
719 @smallexample
720 #define pointer(T)  typeof(T *)
721 #define array(T, N) typeof(T [N])
722 @end smallexample
723
724 @noindent
725 Now the declaration can be rewritten this way:
726
727 @smallexample
728 array (pointer (char), 4) y;
729 @end smallexample
730
731 @noindent
732 Thus, @code{array (pointer (char), 4)} is the type of arrays of 4
733 pointers to @code{char}.
734 @end itemize
735
736 @emph{Compatibility Note:} In addition to @code{typeof}, GCC 2 supported
737 a more limited extension which permitted one to write
738
739 @smallexample
740 typedef @var{T} = @var{expr};
741 @end smallexample
742
743 @noindent
744 with the effect of declaring @var{T} to have the type of the expression
745 @var{expr}.  This extension does not work with GCC 3 (versions between
746 3.0 and 3.2 will crash; 3.2.1 and later give an error).  Code which
747 relies on it should be rewritten to use @code{typeof}:
748
749 @smallexample
750 typedef typeof(@var{expr}) @var{T};
751 @end smallexample
752
753 @noindent
754 This will work with all versions of GCC@.
755
756 @node Conditionals
757 @section Conditionals with Omitted Operands
758 @cindex conditional expressions, extensions
759 @cindex omitted middle-operands
760 @cindex middle-operands, omitted
761 @cindex extensions, @code{?:}
762 @cindex @code{?:} extensions
763
764 The middle operand in a conditional expression may be omitted.  Then
765 if the first operand is nonzero, its value is the value of the conditional
766 expression.
767
768 Therefore, the expression
769
770 @smallexample
771 x ? : y
772 @end smallexample
773
774 @noindent
775 has the value of @code{x} if that is nonzero; otherwise, the value of
776 @code{y}.
777
778 This example is perfectly equivalent to
779
780 @smallexample
781 x ? x : y
782 @end smallexample
783
784 @cindex side effect in ?:
785 @cindex ?: side effect
786 @noindent
787 In this simple case, the ability to omit the middle operand is not
788 especially useful.  When it becomes useful is when the first operand does,
789 or may (if it is a macro argument), contain a side effect.  Then repeating
790 the operand in the middle would perform the side effect twice.  Omitting
791 the middle operand uses the value already computed without the undesirable
792 effects of recomputing it.
793
794 @node Long Long
795 @section Double-Word Integers
796 @cindex @code{long long} data types
797 @cindex double-word arithmetic
798 @cindex multiprecision arithmetic
799 @cindex @code{LL} integer suffix
800 @cindex @code{ULL} integer suffix
801
802 ISO C99 supports data types for integers that are at least 64 bits wide,
803 and as an extension GCC supports them in C89 mode and in C++.
804 Simply write @code{long long int} for a signed integer, or
805 @code{unsigned long long int} for an unsigned integer.  To make an
806 integer constant of type @code{long long int}, add the suffix @samp{LL}
807 to the integer.  To make an integer constant of type @code{unsigned long
808 long int}, add the suffix @samp{ULL} to the integer.
809
810 You can use these types in arithmetic like any other integer types.
811 Addition, subtraction, and bitwise boolean operations on these types
812 are open-coded on all types of machines.  Multiplication is open-coded
813 if the machine supports fullword-to-doubleword a widening multiply
814 instruction.  Division and shifts are open-coded only on machines that
815 provide special support.  The operations that are not open-coded use
816 special library routines that come with GCC@.
817
818 There may be pitfalls when you use @code{long long} types for function
819 arguments, unless you declare function prototypes.  If a function
820 expects type @code{int} for its argument, and you pass a value of type
821 @code{long long int}, confusion will result because the caller and the
822 subroutine will disagree about the number of bytes for the argument.
823 Likewise, if the function expects @code{long long int} and you pass
824 @code{int}.  The best way to avoid such problems is to use prototypes.
825
826 @node Complex
827 @section Complex Numbers
828 @cindex complex numbers
829 @cindex @code{_Complex} keyword
830 @cindex @code{__complex__} keyword
831
832 ISO C99 supports complex floating data types, and as an extension GCC
833 supports them in C89 mode and in C++, and supports complex integer data
834 types which are not part of ISO C99.  You can declare complex types
835 using the keyword @code{_Complex}.  As an extension, the older GNU
836 keyword @code{__complex__} is also supported.
837
838 For example, @samp{_Complex double x;} declares @code{x} as a
839 variable whose real part and imaginary part are both of type
840 @code{double}.  @samp{_Complex short int y;} declares @code{y} to
841 have real and imaginary parts of type @code{short int}; this is not
842 likely to be useful, but it shows that the set of complex types is
843 complete.
844
845 To write a constant with a complex data type, use the suffix @samp{i} or
846 @samp{j} (either one; they are equivalent).  For example, @code{2.5fi}
847 has type @code{_Complex float} and @code{3i} has type
848 @code{_Complex int}.  Such a constant always has a pure imaginary
849 value, but you can form any complex value you like by adding one to a
850 real constant.  This is a GNU extension; if you have an ISO C99
851 conforming C library (such as GNU libc), and want to construct complex
852 constants of floating type, you should include @code{<complex.h>} and
853 use the macros @code{I} or @code{_Complex_I} instead.
854
855 @cindex @code{__real__} keyword
856 @cindex @code{__imag__} keyword
857 To extract the real part of a complex-valued expression @var{exp}, write
858 @code{__real__ @var{exp}}.  Likewise, use @code{__imag__} to
859 extract the imaginary part.  This is a GNU extension; for values of
860 floating type, you should use the ISO C99 functions @code{crealf},
861 @code{creal}, @code{creall}, @code{cimagf}, @code{cimag} and
862 @code{cimagl}, declared in @code{<complex.h>} and also provided as
863 built-in functions by GCC@.
864
865 @cindex complex conjugation
866 The operator @samp{~} performs complex conjugation when used on a value
867 with a complex type.  This is a GNU extension; for values of
868 floating type, you should use the ISO C99 functions @code{conjf},
869 @code{conj} and @code{conjl}, declared in @code{<complex.h>} and also
870 provided as built-in functions by GCC@.
871
872 GCC can allocate complex automatic variables in a noncontiguous
873 fashion; it's even possible for the real part to be in a register while
874 the imaginary part is on the stack (or vice-versa).  Only the DWARF2
875 debug info format can represent this, so use of DWARF2 is recommended.
876 If you are using the stabs debug info format, GCC describes a noncontiguous
877 complex variable as if it were two separate variables of noncomplex type.
878 If the variable's actual name is @code{foo}, the two fictitious
879 variables are named @code{foo$real} and @code{foo$imag}.  You can
880 examine and set these two fictitious variables with your debugger.
881
882 @node Floating Types
883 @section Additional Floating Types
884 @cindex additional floating types
885 @cindex @code{__float80} data type
886 @cindex @code{__float128} data type
887 @cindex @code{w} floating point suffix
888 @cindex @code{q} floating point suffix
889 @cindex @code{W} floating point suffix
890 @cindex @code{Q} floating point suffix
891
892 As an extension, the GNU C compiler supports additional floating
893 types, @code{__float80} and @code{__float128} to support 80bit
894 (@code{XFmode}) and 128 bit (@code{TFmode}) floating types.
895 Support for additional types includes the arithmetic operators:
896 add, subtract, multiply, divide; unary arithmetic operators;
897 relational operators; equality operators; and conversions to and from
898 integer and other floating types.  Use a suffix @samp{w} or @samp{W}
899 in a literal constant of type @code{__float80} and @samp{q} or @samp{Q}
900 for @code{_float128}.  You can declare complex types using the
901 corresponding internal complex type, @code{XCmode} for @code{__float80}
902 type and @code{TCmode} for @code{__float128} type:
903
904 @smallexample
905 typedef _Complex float __attribute__((mode(TC))) _Complex128;
906 typedef _Complex float __attribute__((mode(XC))) _Complex80;
907 @end smallexample
908
909 Not all targets support additional floating point types.  @code{__float80}
910 is supported on i386, x86_64 and ia64 targets and target @code{__float128}
911 is supported on x86_64 and ia64 targets.
912
913 @node Decimal Float
914 @section Decimal Floating Types
915 @cindex decimal floating types
916 @cindex @code{_Decimal32} data type
917 @cindex @code{_Decimal64} data type
918 @cindex @code{_Decimal128} data type
919 @cindex @code{df} integer suffix
920 @cindex @code{dd} integer suffix
921 @cindex @code{dl} integer suffix
922 @cindex @code{DF} integer suffix
923 @cindex @code{DD} integer suffix
924 @cindex @code{DL} integer suffix
925
926 As an extension, the GNU C compiler supports decimal floating types as
927 defined in the N1176 draft of ISO/IEC WDTR24732.  Support for decimal
928 floating types in GCC will evolve as the draft technical report changes.
929 Calling conventions for any target might also change.  Not all targets
930 support decimal floating types.
931
932 The decimal floating types are @code{_Decimal32}, @code{_Decimal64}, and
933 @code{_Decimal128}.  They use a radix of ten, unlike the floating types
934 @code{float}, @code{double}, and @code{long double} whose radix is not
935 specified by the C standard but is usually two.
936
937 Support for decimal floating types includes the arithmetic operators
938 add, subtract, multiply, divide; unary arithmetic operators;
939 relational operators; equality operators; and conversions to and from
940 integer and other floating types.  Use a suffix @samp{df} or
941 @samp{DF} in a literal constant of type @code{_Decimal32}, @samp{dd}
942 or @samp{DD} for @code{_Decimal64}, and @samp{dl} or @samp{DL} for
943 @code{_Decimal128}.
944
945 GCC support of decimal float as specified by the draft technical report
946 is incomplete:
947
948 @itemize @bullet
949 @item
950 Translation time data type (TTDT) is not supported.
951
952 @item
953 When the value of a decimal floating type cannot be represented in the
954 integer type to which it is being converted, the result is undefined
955 rather than the result value specified by the draft technical report.
956 @end itemize
957
958 Types @code{_Decimal32}, @code{_Decimal64}, and @code{_Decimal128}
959 are supported by the DWARF2 debug information format.
960
961 @node Hex Floats
962 @section Hex Floats
963 @cindex hex floats
964
965 ISO C99 supports floating-point numbers written not only in the usual
966 decimal notation, such as @code{1.55e1}, but also numbers such as
967 @code{0x1.fp3} written in hexadecimal format.  As a GNU extension, GCC
968 supports this in C89 mode (except in some cases when strictly
969 conforming) and in C++.  In that format the
970 @samp{0x} hex introducer and the @samp{p} or @samp{P} exponent field are
971 mandatory.  The exponent is a decimal number that indicates the power of
972 2 by which the significant part will be multiplied.  Thus @samp{0x1.f} is
973 @tex
974 $1 {15\over16}$,
975 @end tex
976 @ifnottex
977 1 15/16,
978 @end ifnottex
979 @samp{p3} multiplies it by 8, and the value of @code{0x1.fp3}
980 is the same as @code{1.55e1}.
981
982 Unlike for floating-point numbers in the decimal notation the exponent
983 is always required in the hexadecimal notation.  Otherwise the compiler
984 would not be able to resolve the ambiguity of, e.g., @code{0x1.f}.  This
985 could mean @code{1.0f} or @code{1.9375} since @samp{f} is also the
986 extension for floating-point constants of type @code{float}.
987
988 @node Fixed-Point
989 @section Fixed-Point Types
990 @cindex fixed-point types
991 @cindex @code{_Fract} data type
992 @cindex @code{_Accum} data type
993 @cindex @code{_Sat} data type
994 @cindex @code{hr} fixed-suffix
995 @cindex @code{r} fixed-suffix
996 @cindex @code{lr} fixed-suffix
997 @cindex @code{llr} fixed-suffix
998 @cindex @code{uhr} fixed-suffix
999 @cindex @code{ur} fixed-suffix
1000 @cindex @code{ulr} fixed-suffix
1001 @cindex @code{ullr} fixed-suffix
1002 @cindex @code{hk} fixed-suffix
1003 @cindex @code{k} fixed-suffix
1004 @cindex @code{lk} fixed-suffix
1005 @cindex @code{llk} fixed-suffix
1006 @cindex @code{uhk} fixed-suffix
1007 @cindex @code{uk} fixed-suffix
1008 @cindex @code{ulk} fixed-suffix
1009 @cindex @code{ullk} fixed-suffix
1010 @cindex @code{HR} fixed-suffix
1011 @cindex @code{R} fixed-suffix
1012 @cindex @code{LR} fixed-suffix
1013 @cindex @code{LLR} fixed-suffix
1014 @cindex @code{UHR} fixed-suffix
1015 @cindex @code{UR} fixed-suffix
1016 @cindex @code{ULR} fixed-suffix
1017 @cindex @code{ULLR} fixed-suffix
1018 @cindex @code{HK} fixed-suffix
1019 @cindex @code{K} fixed-suffix
1020 @cindex @code{LK} fixed-suffix
1021 @cindex @code{LLK} fixed-suffix
1022 @cindex @code{UHK} fixed-suffix
1023 @cindex @code{UK} fixed-suffix
1024 @cindex @code{ULK} fixed-suffix
1025 @cindex @code{ULLK} fixed-suffix
1026
1027 As an extension, the GNU C compiler supports fixed-point types as
1028 defined in the N1169 draft of ISO/IEC DTR 18037.  Support for fixed-point
1029 types in GCC will evolve as the draft technical report changes.
1030 Calling conventions for any target might also change.  Not all targets
1031 support fixed-point types.
1032
1033 The fixed-point types are
1034 @code{short _Fract},
1035 @code{_Fract},
1036 @code{long _Fract},
1037 @code{long long _Fract},
1038 @code{unsigned short _Fract},
1039 @code{unsigned _Fract},
1040 @code{unsigned long _Fract},
1041 @code{unsigned long long _Fract},
1042 @code{_Sat short _Fract},
1043 @code{_Sat _Fract},
1044 @code{_Sat long _Fract},
1045 @code{_Sat long long _Fract},
1046 @code{_Sat unsigned short _Fract},
1047 @code{_Sat unsigned _Fract},
1048 @code{_Sat unsigned long _Fract},
1049 @code{_Sat unsigned long long _Fract},
1050 @code{short _Accum},
1051 @code{_Accum},
1052 @code{long _Accum},
1053 @code{long long _Accum},
1054 @code{unsigned short _Accum},
1055 @code{unsigned _Accum},
1056 @code{unsigned long _Accum},
1057 @code{unsigned long long _Accum},
1058 @code{_Sat short _Accum},
1059 @code{_Sat _Accum},
1060 @code{_Sat long _Accum},
1061 @code{_Sat long long _Accum},
1062 @code{_Sat unsigned short _Accum},
1063 @code{_Sat unsigned _Accum},
1064 @code{_Sat unsigned long _Accum},
1065 @code{_Sat unsigned long long _Accum}.
1066 Fixed-point data values contain fractional and optional integral parts.
1067 The format of fixed-point data varies and depends on the target machine.
1068
1069 Support for fixed-point types includes prefix and postfix increment
1070 and decrement operators (@code{++}, @code{--}); unary arithmetic operators
1071 (@code{+}, @code{-}, @code{!}); binary arithmetic operators (@code{+},
1072 @code{-}, @code{*}, @code{/}); binary shift operators (@code{<<}, @code{>>});
1073 relational operators (@code{<}, @code{<=}, @code{>=}, @code{>});
1074 equality operators (@code{==}, @code{!=}); assignment operators
1075 (@code{+=}, @code{-=}, @code{*=}, @code{/=}, @code{<<=}, @code{>>=});
1076 and conversions to and from integer, floating-point, or fixed-point types.
1077
1078 Use a suffix @samp{hr} or @samp{HR} in a literal constant of type
1079 @code{short _Fract} and @code{_Sat short _Fract},
1080 @samp{r} or @samp{R} for @code{_Fract} and @code{_Sat _Fract},
1081 @samp{lr} or @samp{LR} for @code{long _Fract} and @code{_Sat long _Fract},
1082 @samp{llr} or @samp{LLR} for @code{long long _Fract} and
1083 @code{_Sat long long _Fract},
1084 @samp{uhr} or @samp{UHR} for @code{unsigned short _Fract} and
1085 @code{_Sat unsigned short _Fract},
1086 @samp{ur} or @samp{UR} for @code{unsigned _Fract} and
1087 @code{_Sat unsigned _Fract},
1088 @samp{ulr} or @samp{ULR} for @code{unsigned long _Fract} and
1089 @code{_Sat unsigned long _Fract},
1090 @samp{ullr} or @samp{ULLR} for @code{unsigned long long _Fract}
1091 and @code{_Sat unsigned long long _Fract},
1092 @samp{hk} or @samp{HK} for @code{short _Accum} and @code{_Sat short _Accum},
1093 @samp{k} or @samp{K} for @code{_Accum} and @code{_Sat _Accum},
1094 @samp{lk} or @samp{LK} for @code{long _Accum} and @code{_Sat long _Accum},
1095 @samp{llk} or @samp{LLK} for @code{long long _Accum} and
1096 @code{_Sat long long _Accum},
1097 @samp{uhk} or @samp{UHK} for @code{unsigned short _Accum} and
1098 @code{_Sat unsigned short _Accum},
1099 @samp{uk} or @samp{UK} for @code{unsigned _Accum} and
1100 @code{_Sat unsigned _Accum},
1101 @samp{ulk} or @samp{ULK} for @code{unsigned long _Accum} and
1102 @code{_Sat unsigned long _Accum},
1103 and @samp{ullk} or @samp{ULLK} for @code{unsigned long long _Accum}
1104 and @code{_Sat unsigned long long _Accum}.
1105
1106 GCC support of fixed-point types as specified by the draft technical report
1107 is incomplete:
1108
1109 @itemize @bullet
1110 @item
1111 Pragmas to control overflow and rounding behaviors are not implemented.
1112 @end itemize
1113
1114 Fixed-point types are supported by the DWARF2 debug information format.
1115
1116 @node Zero Length
1117 @section Arrays of Length Zero
1118 @cindex arrays of length zero
1119 @cindex zero-length arrays
1120 @cindex length-zero arrays
1121 @cindex flexible array members
1122
1123 Zero-length arrays are allowed in GNU C@.  They are very useful as the
1124 last element of a structure which is really a header for a variable-length
1125 object:
1126
1127 @smallexample
1128 struct line @{
1129   int length;
1130   char contents[0];
1131 @};
1132
1133 struct line *thisline = (struct line *)
1134   malloc (sizeof (struct line) + this_length);
1135 thisline->length = this_length;
1136 @end smallexample
1137
1138 In ISO C90, you would have to give @code{contents} a length of 1, which
1139 means either you waste space or complicate the argument to @code{malloc}.
1140
1141 In ISO C99, you would use a @dfn{flexible array member}, which is
1142 slightly different in syntax and semantics:
1143
1144 @itemize @bullet
1145 @item
1146 Flexible array members are written as @code{contents[]} without
1147 the @code{0}.
1148
1149 @item
1150 Flexible array members have incomplete type, and so the @code{sizeof}
1151 operator may not be applied.  As a quirk of the original implementation
1152 of zero-length arrays, @code{sizeof} evaluates to zero.
1153
1154 @item
1155 Flexible array members may only appear as the last member of a
1156 @code{struct} that is otherwise non-empty.
1157
1158 @item
1159 A structure containing a flexible array member, or a union containing
1160 such a structure (possibly recursively), may not be a member of a
1161 structure or an element of an array.  (However, these uses are
1162 permitted by GCC as extensions.)
1163 @end itemize
1164
1165 GCC versions before 3.0 allowed zero-length arrays to be statically
1166 initialized, as if they were flexible arrays.  In addition to those
1167 cases that were useful, it also allowed initializations in situations
1168 that would corrupt later data.  Non-empty initialization of zero-length
1169 arrays is now treated like any case where there are more initializer
1170 elements than the array holds, in that a suitable warning about "excess
1171 elements in array" is given, and the excess elements (all of them, in
1172 this case) are ignored.
1173
1174 Instead GCC allows static initialization of flexible array members.
1175 This is equivalent to defining a new structure containing the original
1176 structure followed by an array of sufficient size to contain the data.
1177 I.e.@: in the following, @code{f1} is constructed as if it were declared
1178 like @code{f2}.
1179
1180 @smallexample
1181 struct f1 @{
1182   int x; int y[];
1183 @} f1 = @{ 1, @{ 2, 3, 4 @} @};
1184
1185 struct f2 @{
1186   struct f1 f1; int data[3];
1187 @} f2 = @{ @{ 1 @}, @{ 2, 3, 4 @} @};
1188 @end smallexample
1189
1190 @noindent
1191 The convenience of this extension is that @code{f1} has the desired
1192 type, eliminating the need to consistently refer to @code{f2.f1}.
1193
1194 This has symmetry with normal static arrays, in that an array of
1195 unknown size is also written with @code{[]}.
1196
1197 Of course, this extension only makes sense if the extra data comes at
1198 the end of a top-level object, as otherwise we would be overwriting
1199 data at subsequent offsets.  To avoid undue complication and confusion
1200 with initialization of deeply nested arrays, we simply disallow any
1201 non-empty initialization except when the structure is the top-level
1202 object.  For example:
1203
1204 @smallexample
1205 struct foo @{ int x; int y[]; @};
1206 struct bar @{ struct foo z; @};
1207
1208 struct foo a = @{ 1, @{ 2, 3, 4 @} @};        // @r{Valid.}
1209 struct bar b = @{ @{ 1, @{ 2, 3, 4 @} @} @};    // @r{Invalid.}
1210 struct bar c = @{ @{ 1, @{ @} @} @};            // @r{Valid.}
1211 struct foo d[1] = @{ @{ 1 @{ 2, 3, 4 @} @} @};  // @r{Invalid.}
1212 @end smallexample
1213
1214 @node Empty Structures
1215 @section Structures With No Members
1216 @cindex empty structures
1217 @cindex zero-size structures
1218
1219 GCC permits a C structure to have no members:
1220
1221 @smallexample
1222 struct empty @{
1223 @};
1224 @end smallexample
1225
1226 The structure will have size zero.  In C++, empty structures are part
1227 of the language.  G++ treats empty structures as if they had a single
1228 member of type @code{char}.
1229
1230 @node Variable Length
1231 @section Arrays of Variable Length
1232 @cindex variable-length arrays
1233 @cindex arrays of variable length
1234 @cindex VLAs
1235
1236 Variable-length automatic arrays are allowed in ISO C99, and as an
1237 extension GCC accepts them in C89 mode and in C++.  (However, GCC's
1238 implementation of variable-length arrays does not yet conform in detail
1239 to the ISO C99 standard.)  These arrays are
1240 declared like any other automatic arrays, but with a length that is not
1241 a constant expression.  The storage is allocated at the point of
1242 declaration and deallocated when the brace-level is exited.  For
1243 example:
1244
1245 @smallexample
1246 FILE *
1247 concat_fopen (char *s1, char *s2, char *mode)
1248 @{
1249   char str[strlen (s1) + strlen (s2) + 1];
1250   strcpy (str, s1);
1251   strcat (str, s2);
1252   return fopen (str, mode);
1253 @}
1254 @end smallexample
1255
1256 @cindex scope of a variable length array
1257 @cindex variable-length array scope
1258 @cindex deallocating variable length arrays
1259 Jumping or breaking out of the scope of the array name deallocates the
1260 storage.  Jumping into the scope is not allowed; you get an error
1261 message for it.
1262
1263 @cindex @code{alloca} vs variable-length arrays
1264 You can use the function @code{alloca} to get an effect much like
1265 variable-length arrays.  The function @code{alloca} is available in
1266 many other C implementations (but not in all).  On the other hand,
1267 variable-length arrays are more elegant.
1268
1269 There are other differences between these two methods.  Space allocated
1270 with @code{alloca} exists until the containing @emph{function} returns.
1271 The space for a variable-length array is deallocated as soon as the array
1272 name's scope ends.  (If you use both variable-length arrays and
1273 @code{alloca} in the same function, deallocation of a variable-length array
1274 will also deallocate anything more recently allocated with @code{alloca}.)
1275
1276 You can also use variable-length arrays as arguments to functions:
1277
1278 @smallexample
1279 struct entry
1280 tester (int len, char data[len][len])
1281 @{
1282   /* @r{@dots{}} */
1283 @}
1284 @end smallexample
1285
1286 The length of an array is computed once when the storage is allocated
1287 and is remembered for the scope of the array in case you access it with
1288 @code{sizeof}.
1289
1290 If you want to pass the array first and the length afterward, you can
1291 use a forward declaration in the parameter list---another GNU extension.
1292
1293 @smallexample
1294 struct entry
1295 tester (int len; char data[len][len], int len)
1296 @{
1297   /* @r{@dots{}} */
1298 @}
1299 @end smallexample
1300
1301 @cindex parameter forward declaration
1302 The @samp{int len} before the semicolon is a @dfn{parameter forward
1303 declaration}, and it serves the purpose of making the name @code{len}
1304 known when the declaration of @code{data} is parsed.
1305
1306 You can write any number of such parameter forward declarations in the
1307 parameter list.  They can be separated by commas or semicolons, but the
1308 last one must end with a semicolon, which is followed by the ``real''
1309 parameter declarations.  Each forward declaration must match a ``real''
1310 declaration in parameter name and data type.  ISO C99 does not support
1311 parameter forward declarations.
1312
1313 @node Variadic Macros
1314 @section Macros with a Variable Number of Arguments.
1315 @cindex variable number of arguments
1316 @cindex macro with variable arguments
1317 @cindex rest argument (in macro)
1318 @cindex variadic macros
1319
1320 In the ISO C standard of 1999, a macro can be declared to accept a
1321 variable number of arguments much as a function can.  The syntax for
1322 defining the macro is similar to that of a function.  Here is an
1323 example:
1324
1325 @smallexample
1326 #define debug(format, ...) fprintf (stderr, format, __VA_ARGS__)
1327 @end smallexample
1328
1329 Here @samp{@dots{}} is a @dfn{variable argument}.  In the invocation of
1330 such a macro, it represents the zero or more tokens until the closing
1331 parenthesis that ends the invocation, including any commas.  This set of
1332 tokens replaces the identifier @code{__VA_ARGS__} in the macro body
1333 wherever it appears.  See the CPP manual for more information.
1334
1335 GCC has long supported variadic macros, and used a different syntax that
1336 allowed you to give a name to the variable arguments just like any other
1337 argument.  Here is an example:
1338
1339 @smallexample
1340 #define debug(format, args...) fprintf (stderr, format, args)
1341 @end smallexample
1342
1343 This is in all ways equivalent to the ISO C example above, but arguably
1344 more readable and descriptive.
1345
1346 GNU CPP has two further variadic macro extensions, and permits them to
1347 be used with either of the above forms of macro definition.
1348
1349 In standard C, you are not allowed to leave the variable argument out
1350 entirely; but you are allowed to pass an empty argument.  For example,
1351 this invocation is invalid in ISO C, because there is no comma after
1352 the string:
1353
1354 @smallexample
1355 debug ("A message")
1356 @end smallexample
1357
1358 GNU CPP permits you to completely omit the variable arguments in this
1359 way.  In the above examples, the compiler would complain, though since
1360 the expansion of the macro still has the extra comma after the format
1361 string.
1362
1363 To help solve this problem, CPP behaves specially for variable arguments
1364 used with the token paste operator, @samp{##}.  If instead you write
1365
1366 @smallexample
1367 #define debug(format, ...) fprintf (stderr, format, ## __VA_ARGS__)
1368 @end smallexample
1369
1370 and if the variable arguments are omitted or empty, the @samp{##}
1371 operator causes the preprocessor to remove the comma before it.  If you
1372 do provide some variable arguments in your macro invocation, GNU CPP
1373 does not complain about the paste operation and instead places the
1374 variable arguments after the comma.  Just like any other pasted macro
1375 argument, these arguments are not macro expanded.
1376
1377 @node Escaped Newlines
1378 @section Slightly Looser Rules for Escaped Newlines
1379 @cindex escaped newlines
1380 @cindex newlines (escaped)
1381
1382 Recently, the preprocessor has relaxed its treatment of escaped
1383 newlines.  Previously, the newline had to immediately follow a
1384 backslash.  The current implementation allows whitespace in the form
1385 of spaces, horizontal and vertical tabs, and form feeds between the
1386 backslash and the subsequent newline.  The preprocessor issues a
1387 warning, but treats it as a valid escaped newline and combines the two
1388 lines to form a single logical line.  This works within comments and
1389 tokens, as well as between tokens.  Comments are @emph{not} treated as
1390 whitespace for the purposes of this relaxation, since they have not
1391 yet been replaced with spaces.
1392
1393 @node Subscripting
1394 @section Non-Lvalue Arrays May Have Subscripts
1395 @cindex subscripting
1396 @cindex arrays, non-lvalue
1397
1398 @cindex subscripting and function values
1399 In ISO C99, arrays that are not lvalues still decay to pointers, and
1400 may be subscripted, although they may not be modified or used after
1401 the next sequence point and the unary @samp{&} operator may not be
1402 applied to them.  As an extension, GCC allows such arrays to be
1403 subscripted in C89 mode, though otherwise they do not decay to
1404 pointers outside C99 mode.  For example,
1405 this is valid in GNU C though not valid in C89:
1406
1407 @smallexample
1408 @group
1409 struct foo @{int a[4];@};
1410
1411 struct foo f();
1412
1413 bar (int index)
1414 @{
1415   return f().a[index];
1416 @}
1417 @end group
1418 @end smallexample
1419
1420 @node Pointer Arith
1421 @section Arithmetic on @code{void}- and Function-Pointers
1422 @cindex void pointers, arithmetic
1423 @cindex void, size of pointer to
1424 @cindex function pointers, arithmetic
1425 @cindex function, size of pointer to
1426
1427 In GNU C, addition and subtraction operations are supported on pointers to
1428 @code{void} and on pointers to functions.  This is done by treating the
1429 size of a @code{void} or of a function as 1.
1430
1431 A consequence of this is that @code{sizeof} is also allowed on @code{void}
1432 and on function types, and returns 1.
1433
1434 @opindex Wpointer-arith
1435 The option @option{-Wpointer-arith} requests a warning if these extensions
1436 are used.
1437
1438 @node Initializers
1439 @section Non-Constant Initializers
1440 @cindex initializers, non-constant
1441 @cindex non-constant initializers
1442
1443 As in standard C++ and ISO C99, the elements of an aggregate initializer for an
1444 automatic variable are not required to be constant expressions in GNU C@.
1445 Here is an example of an initializer with run-time varying elements:
1446
1447 @smallexample
1448 foo (float f, float g)
1449 @{
1450   float beat_freqs[2] = @{ f-g, f+g @};
1451   /* @r{@dots{}} */
1452 @}
1453 @end smallexample
1454
1455 @node Compound Literals
1456 @section Compound Literals
1457 @cindex constructor expressions
1458 @cindex initializations in expressions
1459 @cindex structures, constructor expression
1460 @cindex expressions, constructor
1461 @cindex compound literals
1462 @c The GNU C name for what C99 calls compound literals was "constructor expressions".
1463
1464 ISO C99 supports compound literals.  A compound literal looks like
1465 a cast containing an initializer.  Its value is an object of the
1466 type specified in the cast, containing the elements specified in
1467 the initializer; it is an lvalue.  As an extension, GCC supports
1468 compound literals in C89 mode and in C++.
1469
1470 Usually, the specified type is a structure.  Assume that
1471 @code{struct foo} and @code{structure} are declared as shown:
1472
1473 @smallexample
1474 struct foo @{int a; char b[2];@} structure;
1475 @end smallexample
1476
1477 @noindent
1478 Here is an example of constructing a @code{struct foo} with a compound literal:
1479
1480 @smallexample
1481 structure = ((struct foo) @{x + y, 'a', 0@});
1482 @end smallexample
1483
1484 @noindent
1485 This is equivalent to writing the following:
1486
1487 @smallexample
1488 @{
1489   struct foo temp = @{x + y, 'a', 0@};
1490   structure = temp;
1491 @}
1492 @end smallexample
1493
1494 You can also construct an array.  If all the elements of the compound literal
1495 are (made up of) simple constant expressions, suitable for use in
1496 initializers of objects of static storage duration, then the compound
1497 literal can be coerced to a pointer to its first element and used in
1498 such an initializer, as shown here:
1499
1500 @smallexample
1501 char **foo = (char *[]) @{ "x", "y", "z" @};
1502 @end smallexample
1503
1504 Compound literals for scalar types and union types are is
1505 also allowed, but then the compound literal is equivalent
1506 to a cast.
1507
1508 As a GNU extension, GCC allows initialization of objects with static storage
1509 duration by compound literals (which is not possible in ISO C99, because
1510 the initializer is not a constant).
1511 It is handled as if the object was initialized only with the bracket
1512 enclosed list if the types of the compound literal and the object match.
1513 The initializer list of the compound literal must be constant.
1514 If the object being initialized has array type of unknown size, the size is
1515 determined by compound literal size.
1516
1517 @smallexample
1518 static struct foo x = (struct foo) @{1, 'a', 'b'@};
1519 static int y[] = (int []) @{1, 2, 3@};
1520 static int z[] = (int [3]) @{1@};
1521 @end smallexample
1522
1523 @noindent
1524 The above lines are equivalent to the following:
1525 @smallexample
1526 static struct foo x = @{1, 'a', 'b'@};
1527 static int y[] = @{1, 2, 3@};
1528 static int z[] = @{1, 0, 0@};
1529 @end smallexample
1530
1531 @node Designated Inits
1532 @section Designated Initializers
1533 @cindex initializers with labeled elements
1534 @cindex labeled elements in initializers
1535 @cindex case labels in initializers
1536 @cindex designated initializers
1537
1538 Standard C89 requires the elements of an initializer to appear in a fixed
1539 order, the same as the order of the elements in the array or structure
1540 being initialized.
1541
1542 In ISO C99 you can give the elements in any order, specifying the array
1543 indices or structure field names they apply to, and GNU C allows this as
1544 an extension in C89 mode as well.  This extension is not
1545 implemented in GNU C++.
1546
1547 To specify an array index, write
1548 @samp{[@var{index}] =} before the element value.  For example,
1549
1550 @smallexample
1551 int a[6] = @{ [4] = 29, [2] = 15 @};
1552 @end smallexample
1553
1554 @noindent
1555 is equivalent to
1556
1557 @smallexample
1558 int a[6] = @{ 0, 0, 15, 0, 29, 0 @};
1559 @end smallexample
1560
1561 @noindent
1562 The index values must be constant expressions, even if the array being
1563 initialized is automatic.
1564
1565 An alternative syntax for this which has been obsolete since GCC 2.5 but
1566 GCC still accepts is to write @samp{[@var{index}]} before the element
1567 value, with no @samp{=}.
1568
1569 To initialize a range of elements to the same value, write
1570 @samp{[@var{first} ... @var{last}] = @var{value}}.  This is a GNU
1571 extension.  For example,
1572
1573 @smallexample
1574 int widths[] = @{ [0 ... 9] = 1, [10 ... 99] = 2, [100] = 3 @};
1575 @end smallexample
1576
1577 @noindent
1578 If the value in it has side-effects, the side-effects will happen only once,
1579 not for each initialized field by the range initializer.
1580
1581 @noindent
1582 Note that the length of the array is the highest value specified
1583 plus one.
1584
1585 In a structure initializer, specify the name of a field to initialize
1586 with @samp{.@var{fieldname} =} before the element value.  For example,
1587 given the following structure,
1588
1589 @smallexample
1590 struct point @{ int x, y; @};
1591 @end smallexample
1592
1593 @noindent
1594 the following initialization
1595
1596 @smallexample
1597 struct point p = @{ .y = yvalue, .x = xvalue @};
1598 @end smallexample
1599
1600 @noindent
1601 is equivalent to
1602
1603 @smallexample
1604 struct point p = @{ xvalue, yvalue @};
1605 @end smallexample
1606
1607 Another syntax which has the same meaning, obsolete since GCC 2.5, is
1608 @samp{@var{fieldname}:}, as shown here:
1609
1610 @smallexample
1611 struct point p = @{ y: yvalue, x: xvalue @};
1612 @end smallexample
1613
1614 @cindex designators
1615 The @samp{[@var{index}]} or @samp{.@var{fieldname}} is known as a
1616 @dfn{designator}.  You can also use a designator (or the obsolete colon
1617 syntax) when initializing a union, to specify which element of the union
1618 should be used.  For example,
1619
1620 @smallexample
1621 union foo @{ int i; double d; @};
1622
1623 union foo f = @{ .d = 4 @};
1624 @end smallexample
1625
1626 @noindent
1627 will convert 4 to a @code{double} to store it in the union using
1628 the second element.  By contrast, casting 4 to type @code{union foo}
1629 would store it into the union as the integer @code{i}, since it is
1630 an integer.  (@xref{Cast to Union}.)
1631
1632 You can combine this technique of naming elements with ordinary C
1633 initialization of successive elements.  Each initializer element that
1634 does not have a designator applies to the next consecutive element of the
1635 array or structure.  For example,
1636
1637 @smallexample
1638 int a[6] = @{ [1] = v1, v2, [4] = v4 @};
1639 @end smallexample
1640
1641 @noindent
1642 is equivalent to
1643
1644 @smallexample
1645 int a[6] = @{ 0, v1, v2, 0, v4, 0 @};
1646 @end smallexample
1647
1648 Labeling the elements of an array initializer is especially useful
1649 when the indices are characters or belong to an @code{enum} type.
1650 For example:
1651
1652 @smallexample
1653 int whitespace[256]
1654   = @{ [' '] = 1, ['\t'] = 1, ['\h'] = 1,
1655       ['\f'] = 1, ['\n'] = 1, ['\r'] = 1 @};
1656 @end smallexample
1657
1658 @cindex designator lists
1659 You can also write a series of @samp{.@var{fieldname}} and
1660 @samp{[@var{index}]} designators before an @samp{=} to specify a
1661 nested subobject to initialize; the list is taken relative to the
1662 subobject corresponding to the closest surrounding brace pair.  For
1663 example, with the @samp{struct point} declaration above:
1664
1665 @smallexample
1666 struct point ptarray[10] = @{ [2].y = yv2, [2].x = xv2, [0].x = xv0 @};
1667 @end smallexample
1668
1669 @noindent
1670 If the same field is initialized multiple times, it will have value from
1671 the last initialization.  If any such overridden initialization has
1672 side-effect, it is unspecified whether the side-effect happens or not.
1673 Currently, GCC will discard them and issue a warning.
1674
1675 @node Case Ranges
1676 @section Case Ranges
1677 @cindex case ranges
1678 @cindex ranges in case statements
1679
1680 You can specify a range of consecutive values in a single @code{case} label,
1681 like this:
1682
1683 @smallexample
1684 case @var{low} ... @var{high}:
1685 @end smallexample
1686
1687 @noindent
1688 This has the same effect as the proper number of individual @code{case}
1689 labels, one for each integer value from @var{low} to @var{high}, inclusive.
1690
1691 This feature is especially useful for ranges of ASCII character codes:
1692
1693 @smallexample
1694 case 'A' ... 'Z':
1695 @end smallexample
1696
1697 @strong{Be careful:} Write spaces around the @code{...}, for otherwise
1698 it may be parsed wrong when you use it with integer values.  For example,
1699 write this:
1700
1701 @smallexample
1702 case 1 ... 5:
1703 @end smallexample
1704
1705 @noindent
1706 rather than this:
1707
1708 @smallexample
1709 case 1...5:
1710 @end smallexample
1711
1712 @node Cast to Union
1713 @section Cast to a Union Type
1714 @cindex cast to a union
1715 @cindex union, casting to a
1716
1717 A cast to union type is similar to other casts, except that the type
1718 specified is a union type.  You can specify the type either with
1719 @code{union @var{tag}} or with a typedef name.  A cast to union is actually
1720 a constructor though, not a cast, and hence does not yield an lvalue like
1721 normal casts.  (@xref{Compound Literals}.)
1722
1723 The types that may be cast to the union type are those of the members
1724 of the union.  Thus, given the following union and variables:
1725
1726 @smallexample
1727 union foo @{ int i; double d; @};
1728 int x;
1729 double y;
1730 @end smallexample
1731
1732 @noindent
1733 both @code{x} and @code{y} can be cast to type @code{union foo}.
1734
1735 Using the cast as the right-hand side of an assignment to a variable of
1736 union type is equivalent to storing in a member of the union:
1737
1738 @smallexample
1739 union foo u;
1740 /* @r{@dots{}} */
1741 u = (union foo) x  @equiv{}  u.i = x
1742 u = (union foo) y  @equiv{}  u.d = y
1743 @end smallexample
1744
1745 You can also use the union cast as a function argument:
1746
1747 @smallexample
1748 void hack (union foo);
1749 /* @r{@dots{}} */
1750 hack ((union foo) x);
1751 @end smallexample
1752
1753 @node Mixed Declarations
1754 @section Mixed Declarations and Code
1755 @cindex mixed declarations and code
1756 @cindex declarations, mixed with code
1757 @cindex code, mixed with declarations
1758
1759 ISO C99 and ISO C++ allow declarations and code to be freely mixed
1760 within compound statements.  As an extension, GCC also allows this in
1761 C89 mode.  For example, you could do:
1762
1763 @smallexample
1764 int i;
1765 /* @r{@dots{}} */
1766 i++;
1767 int j = i + 2;
1768 @end smallexample
1769
1770 Each identifier is visible from where it is declared until the end of
1771 the enclosing block.
1772
1773 @node Function Attributes
1774 @section Declaring Attributes of Functions
1775 @cindex function attributes
1776 @cindex declaring attributes of functions
1777 @cindex functions that never return
1778 @cindex functions that return more than once
1779 @cindex functions that have no side effects
1780 @cindex functions in arbitrary sections
1781 @cindex functions that behave like malloc
1782 @cindex @code{volatile} applied to function
1783 @cindex @code{const} applied to function
1784 @cindex functions with @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style arguments
1785 @cindex functions with non-null pointer arguments
1786 @cindex functions that are passed arguments in registers on the 386
1787 @cindex functions that pop the argument stack on the 386
1788 @cindex functions that do not pop the argument stack on the 386
1789
1790 In GNU C, you declare certain things about functions called in your program
1791 which help the compiler optimize function calls and check your code more
1792 carefully.
1793
1794 The keyword @code{__attribute__} allows you to specify special
1795 attributes when making a declaration.  This keyword is followed by an
1796 attribute specification inside double parentheses.  The following
1797 attributes are currently defined for functions on all targets:
1798 @code{aligned}, @code{alloc_size}, @code{noreturn},
1799 @code{returns_twice}, @code{noinline}, @code{always_inline},
1800 @code{flatten}, @code{pure}, @code{const}, @code{nothrow},
1801 @code{sentinel}, @code{format}, @code{format_arg},
1802 @code{no_instrument_function}, @code{section}, @code{constructor},
1803 @code{destructor}, @code{used}, @code{unused}, @code{deprecated},
1804 @code{weak}, @code{malloc}, @code{alias}, @code{warn_unused_result},
1805 @code{nonnull}, @code{gnu_inline}, @code{externally_visible},
1806 @code{hot}, @code{cold} and @code{artificial}.
1807 Several other attributes are defined for functions on particular
1808 target systems.  Other attributes, including @code{section} are
1809 supported for variables declarations (@pxref{Variable Attributes}) and
1810 for types (@pxref{Type Attributes}).
1811
1812 You may also specify attributes with @samp{__} preceding and following
1813 each keyword.  This allows you to use them in header files without
1814 being concerned about a possible macro of the same name.  For example,
1815 you may use @code{__noreturn__} instead of @code{noreturn}.
1816
1817 @xref{Attribute Syntax}, for details of the exact syntax for using
1818 attributes.
1819
1820 @table @code
1821 @c Keep this table alphabetized by attribute name.  Treat _ as space.
1822
1823 @item alias ("@var{target}")
1824 @cindex @code{alias} attribute
1825 The @code{alias} attribute causes the declaration to be emitted as an
1826 alias for another symbol, which must be specified.  For instance,
1827
1828 @smallexample
1829 void __f () @{ /* @r{Do something.} */; @}
1830 void f () __attribute__ ((weak, alias ("__f")));
1831 @end smallexample
1832
1833 defines @samp{f} to be a weak alias for @samp{__f}.  In C++, the
1834 mangled name for the target must be used.  It is an error if @samp{__f}
1835 is not defined in the same translation unit.
1836
1837 Not all target machines support this attribute.
1838
1839 @item aligned (@var{alignment})
1840 @cindex @code{aligned} attribute
1841 This attribute specifies a minimum alignment for the function,
1842 measured in bytes.
1843
1844 You cannot use this attribute to decrease the alignment of a function,
1845 only to increase it.  However, when you explicitly specify a function
1846 alignment this will override the effect of the
1847 @option{-falign-functions} (@pxref{Optimize Options}) option for this
1848 function.
1849
1850 Note that the effectiveness of @code{aligned} attributes may be
1851 limited by inherent limitations in your linker.  On many systems, the
1852 linker is only able to arrange for functions to be aligned up to a
1853 certain maximum alignment.  (For some linkers, the maximum supported
1854 alignment may be very very small.)  See your linker documentation for
1855 further information.
1856
1857 The @code{aligned} attribute can also be used for variables and fields
1858 (@pxref{Variable Attributes}.)
1859
1860 @item alloc_size
1861 @cindex @code{alloc_size} attribute
1862 The @code{alloc_size} attribute is used to tell the compiler that the
1863 function return value points to memory, where the size is given by
1864 one or two of the functions parameters.  GCC uses this 
1865 information to improve the correctness of @code{__builtin_object_size}.
1866
1867 The function parameter(s) denoting the allocated size are specified by
1868 one or two integer arguments supplied to the attribute.  The allocated size
1869 is either the value of the single function argument specified or the product
1870 of the two function arguments specified.  Argument numbering starts at
1871 one.
1872
1873 For instance, 
1874
1875 @smallexample
1876 void* my_calloc(size_t, size_t) __attribute__((alloc_size(1,2)))
1877 void my_realloc(void* size_t) __attribute__((alloc_size(2)))
1878 @end smallexample
1879
1880 declares that my_calloc will return memory of the size given by
1881 the product of parameter 1 and 2 and that my_realloc will return memory
1882 of the size given by parameter 2.
1883
1884 @item always_inline
1885 @cindex @code{always_inline} function attribute
1886 Generally, functions are not inlined unless optimization is specified.
1887 For functions declared inline, this attribute inlines the function even
1888 if no optimization level was specified.
1889
1890 @item gnu_inline
1891 @cindex @code{gnu_inline} function attribute
1892 This attribute should be used with a function which is also declared
1893 with the @code{inline} keyword.  It directs GCC to treat the function
1894 as if it were defined in gnu89 mode even when compiling in C99 or
1895 gnu99 mode.
1896
1897 If the function is declared @code{extern}, then this definition of the
1898 function is used only for inlining.  In no case is the function
1899 compiled as a standalone function, not even if you take its address
1900 explicitly.  Such an address becomes an external reference, as if you
1901 had only declared the function, and had not defined it.  This has
1902 almost the effect of a macro.  The way to use this is to put a
1903 function definition in a header file with this attribute, and put
1904 another copy of the function, without @code{extern}, in a library
1905 file.  The definition in the header file will cause most calls to the
1906 function to be inlined.  If any uses of the function remain, they will
1907 refer to the single copy in the library.  Note that the two
1908 definitions of the functions need not be precisely the same, although
1909 if they do not have the same effect your program may behave oddly.
1910
1911 In C, if the function is neither @code{extern} nor @code{static}, then
1912 the function is compiled as a standalone function, as well as being
1913 inlined where possible.
1914
1915 This is how GCC traditionally handled functions declared
1916 @code{inline}.  Since ISO C99 specifies a different semantics for
1917 @code{inline}, this function attribute is provided as a transition
1918 measure and as a useful feature in its own right.  This attribute is
1919 available in GCC 4.1.3 and later.  It is available if either of the
1920 preprocessor macros @code{__GNUC_GNU_INLINE__} or
1921 @code{__GNUC_STDC_INLINE__} are defined.  @xref{Inline,,An Inline
1922 Function is As Fast As a Macro}.
1923
1924 In C++, this attribute does not depend on @code{extern} in any way,
1925 but it still requires the @code{inline} keyword to enable its special
1926 behavior.
1927
1928 @cindex @code{artificial} function attribute
1929 @item artificial
1930 This attribute is useful for small inline wrappers which if possible
1931 should appear during debugging as a unit, depending on the debug
1932 info format it will either mean marking the function as artificial
1933 or using the caller location for all instructions within the inlined
1934 body.
1935
1936 @cindex @code{flatten} function attribute
1937 @item flatten
1938 Generally, inlining into a function is limited.  For a function marked with
1939 this attribute, every call inside this function will be inlined, if possible.
1940 Whether the function itself is considered for inlining depends on its size and
1941 the current inlining parameters.  The @code{flatten} attribute only works
1942 reliably in unit-at-a-time mode.
1943
1944 @item cdecl
1945 @cindex functions that do pop the argument stack on the 386
1946 @opindex mrtd
1947 On the Intel 386, the @code{cdecl} attribute causes the compiler to
1948 assume that the calling function will pop off the stack space used to
1949 pass arguments.  This is
1950 useful to override the effects of the @option{-mrtd} switch.
1951
1952 @item const
1953 @cindex @code{const} function attribute
1954 Many functions do not examine any values except their arguments, and
1955 have no effects except the return value.  Basically this is just slightly
1956 more strict class than the @code{pure} attribute below, since function is not
1957 allowed to read global memory.
1958
1959 @cindex pointer arguments
1960 Note that a function that has pointer arguments and examines the data
1961 pointed to must @emph{not} be declared @code{const}.  Likewise, a
1962 function that calls a non-@code{const} function usually must not be
1963 @code{const}.  It does not make sense for a @code{const} function to
1964 return @code{void}.
1965
1966 The attribute @code{const} is not implemented in GCC versions earlier
1967 than 2.5.  An alternative way to declare that a function has no side
1968 effects, which works in the current version and in some older versions,
1969 is as follows:
1970
1971 @smallexample
1972 typedef int intfn ();
1973
1974 extern const intfn square;
1975 @end smallexample
1976
1977 This approach does not work in GNU C++ from 2.6.0 on, since the language
1978 specifies that the @samp{const} must be attached to the return value.
1979
1980 @item constructor
1981 @itemx destructor
1982 @itemx constructor (@var{priority})
1983 @itemx destructor (@var{priority})
1984 @cindex @code{constructor} function attribute
1985 @cindex @code{destructor} function attribute
1986 The @code{constructor} attribute causes the function to be called
1987 automatically before execution enters @code{main ()}.  Similarly, the
1988 @code{destructor} attribute causes the function to be called
1989 automatically after @code{main ()} has completed or @code{exit ()} has
1990 been called.  Functions with these attributes are useful for
1991 initializing data that will be used implicitly during the execution of
1992 the program.
1993
1994 You may provide an optional integer priority to control the order in
1995 which constructor and destructor functions are run.  A constructor
1996 with a smaller priority number runs before a constructor with a larger
1997 priority number; the opposite relationship holds for destructors.  So,
1998 if you have a constructor that allocates a resource and a destructor
1999 that deallocates the same resource, both functions typically have the
2000 same priority.  The priorities for constructor and destructor
2001 functions are the same as those specified for namespace-scope C++
2002 objects (@pxref{C++ Attributes}).
2003
2004 These attributes are not currently implemented for Objective-C@.
2005
2006 @item deprecated
2007 @cindex @code{deprecated} attribute.
2008 The @code{deprecated} attribute results in a warning if the function
2009 is used anywhere in the source file.  This is useful when identifying
2010 functions that are expected to be removed in a future version of a
2011 program.  The warning also includes the location of the declaration
2012 of the deprecated function, to enable users to easily find further
2013 information about why the function is deprecated, or what they should
2014 do instead.  Note that the warnings only occurs for uses:
2015
2016 @smallexample
2017 int old_fn () __attribute__ ((deprecated));
2018 int old_fn ();
2019 int (*fn_ptr)() = old_fn;
2020 @end smallexample
2021
2022 results in a warning on line 3 but not line 2.
2023
2024 The @code{deprecated} attribute can also be used for variables and
2025 types (@pxref{Variable Attributes}, @pxref{Type Attributes}.)
2026
2027 @item dllexport
2028 @cindex @code{__declspec(dllexport)}
2029 On Microsoft Windows targets and Symbian OS targets the
2030 @code{dllexport} attribute causes the compiler to provide a global
2031 pointer to a pointer in a DLL, so that it can be referenced with the
2032 @code{dllimport} attribute.  On Microsoft Windows targets, the pointer
2033 name is formed by combining @code{_imp__} and the function or variable
2034 name.
2035
2036 You can use @code{__declspec(dllexport)} as a synonym for
2037 @code{__attribute__ ((dllexport))} for compatibility with other
2038 compilers.
2039
2040 On systems that support the @code{visibility} attribute, this
2041 attribute also implies ``default'' visibility.  It is an error to
2042 explicitly specify any other visibility.
2043
2044 Currently, the @code{dllexport} attribute is ignored for inlined
2045 functions, unless the @option{-fkeep-inline-functions} flag has been
2046 used.  The attribute is also ignored for undefined symbols.
2047
2048 When applied to C++ classes, the attribute marks defined non-inlined
2049 member functions and static data members as exports.  Static consts
2050 initialized in-class are not marked unless they are also defined
2051 out-of-class.
2052
2053 For Microsoft Windows targets there are alternative methods for
2054 including the symbol in the DLL's export table such as using a
2055 @file{.def} file with an @code{EXPORTS} section or, with GNU ld, using
2056 the @option{--export-all} linker flag.
2057
2058 @item dllimport
2059 @cindex @code{__declspec(dllimport)}
2060 On Microsoft Windows and Symbian OS targets, the @code{dllimport}
2061 attribute causes the compiler to reference a function or variable via
2062 a global pointer to a pointer that is set up by the DLL exporting the
2063 symbol.  The attribute implies @code{extern}.  On Microsoft Windows
2064 targets, the pointer name is formed by combining @code{_imp__} and the
2065 function or variable name.
2066
2067 You can use @code{__declspec(dllimport)} as a synonym for
2068 @code{__attribute__ ((dllimport))} for compatibility with other
2069 compilers.
2070
2071 On systems that support the @code{visibility} attribute, this
2072 attribute also implies ``default'' visibility.  It is an error to
2073 explicitly specify any other visibility.
2074
2075 Currently, the attribute is ignored for inlined functions.  If the
2076 attribute is applied to a symbol @emph{definition}, an error is reported.
2077 If a symbol previously declared @code{dllimport} is later defined, the
2078 attribute is ignored in subsequent references, and a warning is emitted.
2079 The attribute is also overridden by a subsequent declaration as
2080 @code{dllexport}.
2081
2082 When applied to C++ classes, the attribute marks non-inlined
2083 member functions and static data members as imports.  However, the
2084 attribute is ignored for virtual methods to allow creation of vtables
2085 using thunks.
2086
2087 On the SH Symbian OS target the @code{dllimport} attribute also has
2088 another affect---it can cause the vtable and run-time type information
2089 for a class to be exported.  This happens when the class has a
2090 dllimport'ed constructor or a non-inline, non-pure virtual function
2091 and, for either of those two conditions, the class also has a inline
2092 constructor or destructor and has a key function that is defined in
2093 the current translation unit.
2094
2095 For Microsoft Windows based targets the use of the @code{dllimport}
2096 attribute on functions is not necessary, but provides a small
2097 performance benefit by eliminating a thunk in the DLL@.  The use of the
2098 @code{dllimport} attribute on imported variables was required on older
2099 versions of the GNU linker, but can now be avoided by passing the
2100 @option{--enable-auto-import} switch to the GNU linker.  As with
2101 functions, using the attribute for a variable eliminates a thunk in
2102 the DLL@.
2103
2104 One drawback to using this attribute is that a pointer to a function
2105 or variable marked as @code{dllimport} cannot be used as a constant
2106 address.  On Microsoft Windows targets, the attribute can be disabled
2107 for functions by setting the @option{-mnop-fun-dllimport} flag.
2108
2109 @item eightbit_data
2110 @cindex eight bit data on the H8/300, H8/300H, and H8S
2111 Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
2112 variable should be placed into the eight bit data section.
2113 The compiler will generate more efficient code for certain operations
2114 on data in the eight bit data area.  Note the eight bit data area is limited to
2115 256 bytes of data.
2116
2117 You must use GAS and GLD from GNU binutils version 2.7 or later for
2118 this attribute to work correctly.
2119
2120 @item exception_handler
2121 @cindex exception handler functions on the Blackfin processor
2122 Use this attribute on the Blackfin to indicate that the specified function
2123 is an exception handler.  The compiler will generate function entry and
2124 exit sequences suitable for use in an exception handler when this
2125 attribute is present.
2126
2127 @item far
2128 @cindex functions which handle memory bank switching
2129 On 68HC11 and 68HC12 the @code{far} attribute causes the compiler to
2130 use a calling convention that takes care of switching memory banks when
2131 entering and leaving a function.  This calling convention is also the
2132 default when using the @option{-mlong-calls} option.
2133
2134 On 68HC12 the compiler will use the @code{call} and @code{rtc} instructions
2135 to call and return from a function.
2136
2137 On 68HC11 the compiler will generate a sequence of instructions
2138 to invoke a board-specific routine to switch the memory bank and call the
2139 real function.  The board-specific routine simulates a @code{call}.
2140 At the end of a function, it will jump to a board-specific routine
2141 instead of using @code{rts}.  The board-specific return routine simulates
2142 the @code{rtc}.
2143
2144 @item fastcall
2145 @cindex functions that pop the argument stack on the 386
2146 On the Intel 386, the @code{fastcall} attribute causes the compiler to
2147 pass the first argument (if of integral type) in the register ECX and
2148 the second argument (if of integral type) in the register EDX@.  Subsequent
2149 and other typed arguments are passed on the stack.  The called function will
2150 pop the arguments off the stack.  If the number of arguments is variable all
2151 arguments are pushed on the stack.
2152
2153 @item format (@var{archetype}, @var{string-index}, @var{first-to-check})
2154 @cindex @code{format} function attribute
2155 @opindex Wformat
2156 The @code{format} attribute specifies that a function takes @code{printf},
2157 @code{scanf}, @code{strftime} or @code{strfmon} style arguments which
2158 should be type-checked against a format string.  For example, the
2159 declaration:
2160
2161 @smallexample
2162 extern int
2163 my_printf (void *my_object, const char *my_format, ...)
2164       __attribute__ ((format (printf, 2, 3)));
2165 @end smallexample
2166
2167 @noindent
2168 causes the compiler to check the arguments in calls to @code{my_printf}
2169 for consistency with the @code{printf} style format string argument
2170 @code{my_format}.
2171
2172 The parameter @var{archetype} determines how the format string is
2173 interpreted, and should be @code{printf}, @code{scanf}, @code{strftime}
2174 or @code{strfmon}.  (You can also use @code{__printf__},
2175 @code{__scanf__}, @code{__strftime__} or @code{__strfmon__}.)  The
2176 parameter @var{string-index} specifies which argument is the format
2177 string argument (starting from 1), while @var{first-to-check} is the
2178 number of the first argument to check against the format string.  For
2179 functions where the arguments are not available to be checked (such as
2180 @code{vprintf}), specify the third parameter as zero.  In this case the
2181 compiler only checks the format string for consistency.  For
2182 @code{strftime} formats, the third parameter is required to be zero.
2183 Since non-static C++ methods have an implicit @code{this} argument, the
2184 arguments of such methods should be counted from two, not one, when
2185 giving values for @var{string-index} and @var{first-to-check}.
2186
2187 In the example above, the format string (@code{my_format}) is the second
2188 argument of the function @code{my_print}, and the arguments to check
2189 start with the third argument, so the correct parameters for the format
2190 attribute are 2 and 3.
2191
2192 @opindex ffreestanding
2193 @opindex fno-builtin
2194 The @code{format} attribute allows you to identify your own functions
2195 which take format strings as arguments, so that GCC can check the
2196 calls to these functions for errors.  The compiler always (unless
2197 @option{-ffreestanding} or @option{-fno-builtin} is used) checks formats
2198 for the standard library functions @code{printf}, @code{fprintf},
2199 @code{sprintf}, @code{scanf}, @code{fscanf}, @code{sscanf}, @code{strftime},
2200 @code{vprintf}, @code{vfprintf} and @code{vsprintf} whenever such
2201 warnings are requested (using @option{-Wformat}), so there is no need to
2202 modify the header file @file{stdio.h}.  In C99 mode, the functions
2203 @code{snprintf}, @code{vsnprintf}, @code{vscanf}, @code{vfscanf} and
2204 @code{vsscanf} are also checked.  Except in strictly conforming C
2205 standard modes, the X/Open function @code{strfmon} is also checked as
2206 are @code{printf_unlocked} and @code{fprintf_unlocked}.
2207 @xref{C Dialect Options,,Options Controlling C Dialect}.
2208
2209 The target may provide additional types of format checks.
2210 @xref{Target Format Checks,,Format Checks Specific to Particular
2211 Target Machines}.
2212
2213 @item format_arg (@var{string-index})
2214 @cindex @code{format_arg} function attribute
2215 @opindex Wformat-nonliteral
2216 The @code{format_arg} attribute specifies that a function takes a format
2217 string for a @code{printf}, @code{scanf}, @code{strftime} or
2218 @code{strfmon} style function and modifies it (for example, to translate
2219 it into another language), so the result can be passed to a
2220 @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style
2221 function (with the remaining arguments to the format function the same
2222 as they would have been for the unmodified string).  For example, the
2223 declaration:
2224
2225 @smallexample
2226 extern char *
2227 my_dgettext (char *my_domain, const char *my_format)
2228       __attribute__ ((format_arg (2)));
2229 @end smallexample
2230
2231 @noindent
2232 causes the compiler to check the arguments in calls to a @code{printf},
2233 @code{scanf}, @code{strftime} or @code{strfmon} type function, whose
2234 format string argument is a call to the @code{my_dgettext} function, for
2235 consistency with the format string argument @code{my_format}.  If the
2236 @code{format_arg} attribute had not been specified, all the compiler
2237 could tell in such calls to format functions would be that the format
2238 string argument is not constant; this would generate a warning when
2239 @option{-Wformat-nonliteral} is used, but the calls could not be checked
2240 without the attribute.
2241
2242 The parameter @var{string-index} specifies which argument is the format
2243 string argument (starting from one).  Since non-static C++ methods have
2244 an implicit @code{this} argument, the arguments of such methods should
2245 be counted from two.
2246
2247 The @code{format-arg} attribute allows you to identify your own
2248 functions which modify format strings, so that GCC can check the
2249 calls to @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon}
2250 type function whose operands are a call to one of your own function.
2251 The compiler always treats @code{gettext}, @code{dgettext}, and
2252 @code{dcgettext} in this manner except when strict ISO C support is
2253 requested by @option{-ansi} or an appropriate @option{-std} option, or
2254 @option{-ffreestanding} or @option{-fno-builtin}
2255 is used.  @xref{C Dialect Options,,Options
2256 Controlling C Dialect}.
2257
2258 @item function_vector
2259 @cindex calling functions through the function vector on H8/300, M16C, and M32C processors
2260 Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
2261 function should be called through the function vector.  Calling a
2262 function through the function vector will reduce code size, however;
2263 the function vector has a limited size (maximum 128 entries on the H8/300
2264 and 64 entries on the H8/300H and H8S) and shares space with the interrupt vector.
2265
2266 You must use GAS and GLD from GNU binutils version 2.7 or later for
2267 this attribute to work correctly.
2268
2269 On M16C/M32C targets, the @code{function_vector} attribute declares a
2270 special page subroutine call function. Use of this attribute reduces
2271 the code size by 2 bytes for each call generated to the
2272 subroutine. The argument to the attribute is the vector number entry
2273 from the special page vector table which contains the 16 low-order
2274 bits of the subroutine's entry address. Each vector table has special
2275 page number (18 to 255) which are used in @code{jsrs} instruction.
2276 Jump addresses of the routines are generated by adding 0x0F0000 (in
2277 case of M16C targets) or 0xFF0000 (in case of M32C targets), to the 2
2278 byte addresses set in the vector table. Therefore you need to ensure
2279 that all the special page vector routines should get mapped within the
2280 address range 0x0F0000 to 0x0FFFFF (for M16C) and 0xFF0000 to 0xFFFFFF
2281 (for M32C).
2282
2283 In the following example 2 bytes will be saved for each call to
2284 function @code{foo}.
2285
2286 @smallexample
2287 void foo (void) __attribute__((function_vector(0x18)));
2288 void foo (void)
2289 @{
2290 @}
2291
2292 void bar (void)
2293 @{
2294     foo();
2295 @}
2296 @end smallexample
2297
2298 If functions are defined in one file and are called in another file,
2299 then be sure to write this declaration in both files.
2300
2301 This attribute is ignored for R8C target.
2302
2303 @item interrupt
2304 @cindex interrupt handler functions
2305 Use this attribute on the ARM, AVR, C4x, CRX, M32C, M32R/D, m68k, MS1,
2306 and Xstormy16 ports to indicate that the specified function is an
2307 interrupt handler.  The compiler will generate function entry and exit
2308 sequences suitable for use in an interrupt handler when this attribute
2309 is present.
2310
2311 Note, interrupt handlers for the Blackfin, H8/300, H8/300H, H8S, and
2312 SH processors can be specified via the @code{interrupt_handler} attribute.
2313
2314 Note, on the AVR, interrupts will be enabled inside the function.
2315
2316 Note, for the ARM, you can specify the kind of interrupt to be handled by
2317 adding an optional parameter to the interrupt attribute like this:
2318
2319 @smallexample
2320 void f () __attribute__ ((interrupt ("IRQ")));
2321 @end smallexample
2322
2323 Permissible values for this parameter are: IRQ, FIQ, SWI, ABORT and UNDEF@.
2324
2325 On ARMv7-M the interrupt type is ignored, and the attribute means the function
2326 may be called with a word aligned stack pointer.
2327
2328 @item interrupt_handler
2329 @cindex interrupt handler functions on the Blackfin, m68k, H8/300 and SH processors
2330 Use this attribute on the Blackfin, m68k, H8/300, H8/300H, H8S, and SH to
2331 indicate that the specified function is an interrupt handler.  The compiler
2332 will generate function entry and exit sequences suitable for use in an
2333 interrupt handler when this attribute is present.
2334
2335 @item interrupt_thread
2336 @cindex interrupt thread functions on fido
2337 Use this attribute on fido, a subarchitecture of the m68k, to indicate
2338 that the specified function is an interrupt handler that is designed
2339 to run as a thread.  The compiler omits generate prologue/epilogue
2340 sequences and replaces the return instruction with a @code{sleep}
2341 instruction.  This attribute is available only on fido.
2342
2343 @item kspisusp
2344 @cindex User stack pointer in interrupts on the Blackfin
2345 When used together with @code{interrupt_handler}, @code{exception_handler}
2346 or @code{nmi_handler}, code will be generated to load the stack pointer
2347 from the USP register in the function prologue.
2348
2349 @item l1_text
2350 @cindex @code{l1_text} function attribute
2351 This attribute specifies a function to be placed into L1 Instruction
2352 SRAM. The function will be put into a specific section named @code{.l1.text}.
2353 With @option{-mfdpic}, function calls with a such function as the callee
2354 or caller will use inlined PLT.
2355
2356 @item long_call/short_call
2357 @cindex indirect calls on ARM
2358 This attribute specifies how a particular function is called on
2359 ARM@.  Both attributes override the @option{-mlong-calls} (@pxref{ARM Options})
2360 command line switch and @code{#pragma long_calls} settings.  The
2361 @code{long_call} attribute indicates that the function might be far
2362 away from the call site and require a different (more expensive)
2363 calling sequence.   The @code{short_call} attribute always places
2364 the offset to the function from the call site into the @samp{BL}
2365 instruction directly.
2366
2367 @item longcall/shortcall
2368 @cindex functions called via pointer on the RS/6000 and PowerPC
2369 On the Blackfin, RS/6000 and PowerPC, the @code{longcall} attribute
2370 indicates that the function might be far away from the call site and
2371 require a different (more expensive) calling sequence.  The
2372 @code{shortcall} attribute indicates that the function is always close
2373 enough for the shorter calling sequence to be used.  These attributes
2374 override both the @option{-mlongcall} switch and, on the RS/6000 and
2375 PowerPC, the @code{#pragma longcall} setting.
2376
2377 @xref{RS/6000 and PowerPC Options}, for more information on whether long
2378 calls are necessary.
2379
2380 @item long_call/near/far
2381 @cindex indirect calls on MIPS
2382 These attributes specify how a particular function is called on MIPS@.
2383 The attributes override the @option{-mlong-calls} (@pxref{MIPS Options})
2384 command-line switch.  The @code{long_call} and @code{far} attributes are
2385 synonyms, and cause the compiler to always call
2386 the function by first loading its address into a register, and then using
2387 the contents of that register.  The @code{near} attribute has the opposite
2388 effect; it specifies that non-PIC calls should be made using the more 
2389 efficient @code{jal} instruction.
2390
2391 @item malloc
2392 @cindex @code{malloc} attribute
2393 The @code{malloc} attribute is used to tell the compiler that a function
2394 may be treated as if any non-@code{NULL} pointer it returns cannot
2395 alias any other pointer valid when the function returns.
2396 This will often improve optimization.
2397 Standard functions with this property include @code{malloc} and
2398 @code{calloc}.  @code{realloc}-like functions have this property as
2399 long as the old pointer is never referred to (including comparing it
2400 to the new pointer) after the function returns a non-@code{NULL}
2401 value.
2402
2403 @item mips16/nomips16
2404 @cindex @code{mips16} attribute
2405 @cindex @code{nomips16} attribute
2406
2407 On MIPS targets, you can use the @code{mips16} and @code{nomips16}
2408 function attributes to locally select or turn off MIPS16 code generation.
2409 A function with the @code{mips16} attribute is emitted as MIPS16 code, 
2410 while MIPS16 code generation is disabled for functions with the 
2411 @code{nomips16} attribute.  These attributes override the 
2412 @option{-mips16} and @option{-mno-mips16} options on the command line
2413 (@pxref{MIPS Options}).  
2414
2415 When compiling files containing mixed MIPS16 and non-MIPS16 code, the
2416 preprocessor symbol @code{__mips16} reflects the setting on the command line,
2417 not that within individual functions.  Mixed MIPS16 and non-MIPS16 code
2418 may interact badly with some GCC extensions such as @code{__builtin_apply}
2419 (@pxref{Constructing Calls}).
2420
2421 @item model (@var{model-name})
2422 @cindex function addressability on the M32R/D
2423 @cindex variable addressability on the IA-64
2424
2425 On the M32R/D, use this attribute to set the addressability of an
2426 object, and of the code generated for a function.  The identifier
2427 @var{model-name} is one of @code{small}, @code{medium}, or
2428 @code{large}, representing each of the code models.
2429
2430 Small model objects live in the lower 16MB of memory (so that their
2431 addresses can be loaded with the @code{ld24} instruction), and are
2432 callable with the @code{bl} instruction.
2433
2434 Medium model objects may live anywhere in the 32-bit address space (the
2435 compiler will generate @code{seth/add3} instructions to load their addresses),
2436 and are callable with the @code{bl} instruction.
2437
2438 Large model objects may live anywhere in the 32-bit address space (the
2439 compiler will generate @code{seth/add3} instructions to load their addresses),
2440 and may not be reachable with the @code{bl} instruction (the compiler will
2441 generate the much slower @code{seth/add3/jl} instruction sequence).
2442
2443 On IA-64, use this attribute to set the addressability of an object.
2444 At present, the only supported identifier for @var{model-name} is
2445 @code{small}, indicating addressability via ``small'' (22-bit)
2446 addresses (so that their addresses can be loaded with the @code{addl}
2447 instruction).  Caveat: such addressing is by definition not position
2448 independent and hence this attribute must not be used for objects
2449 defined by shared libraries.
2450
2451 @item naked
2452 @cindex function without a prologue/epilogue code
2453 Use this attribute on the ARM, AVR, C4x, IP2K and SPU ports to indicate that
2454 the specified function does not need prologue/epilogue sequences generated by
2455 the compiler.  It is up to the programmer to provide these sequences.
2456
2457 @item near
2458 @cindex functions which do not handle memory bank switching on 68HC11/68HC12
2459 On 68HC11 and 68HC12 the @code{near} attribute causes the compiler to
2460 use the normal calling convention based on @code{jsr} and @code{rts}.
2461 This attribute can be used to cancel the effect of the @option{-mlong-calls}
2462 option.
2463
2464 @item nesting
2465 @cindex Allow nesting in an interrupt handler on the Blackfin processor.
2466 Use this attribute together with @code{interrupt_handler},
2467 @code{exception_handler} or @code{nmi_handler} to indicate that the function
2468 entry code should enable nested interrupts or exceptions.
2469
2470 @item nmi_handler
2471 @cindex NMI handler functions on the Blackfin processor
2472 Use this attribute on the Blackfin to indicate that the specified function
2473 is an NMI handler.  The compiler will generate function entry and
2474 exit sequences suitable for use in an NMI handler when this
2475 attribute is present.
2476
2477 @item no_instrument_function
2478 @cindex @code{no_instrument_function} function attribute
2479 @opindex finstrument-functions
2480 If @option{-finstrument-functions} is given, profiling function calls will
2481 be generated at entry and exit of most user-compiled functions.
2482 Functions with this attribute will not be so instrumented.
2483
2484 @item noinline
2485 @cindex @code{noinline} function attribute
2486 This function attribute prevents a function from being considered for
2487 inlining.
2488
2489 @item nonnull (@var{arg-index}, @dots{})
2490 @cindex @code{nonnull} function attribute
2491 The @code{nonnull} attribute specifies that some function parameters should
2492 be non-null pointers.  For instance, the declaration:
2493
2494 @smallexample
2495 extern void *
2496 my_memcpy (void *dest, const void *src, size_t len)
2497         __attribute__((nonnull (1, 2)));
2498 @end smallexample
2499
2500 @noindent
2501 causes the compiler to check that, in calls to @code{my_memcpy},
2502 arguments @var{dest} and @var{src} are non-null.  If the compiler
2503 determines that a null pointer is passed in an argument slot marked
2504 as non-null, and the @option{-Wnonnull} option is enabled, a warning
2505 is issued.  The compiler may also choose to make optimizations based
2506 on the knowledge that certain function arguments will not be null.
2507
2508 If no argument index list is given to the @code{nonnull} attribute,
2509 all pointer arguments are marked as non-null.  To illustrate, the
2510 following declaration is equivalent to the previous example:
2511
2512 @smallexample
2513 extern void *
2514 my_memcpy (void *dest, const void *src, size_t len)
2515         __attribute__((nonnull));
2516 @end smallexample
2517
2518 @item noreturn
2519 @cindex @code{noreturn} function attribute
2520 A few standard library functions, such as @code{abort} and @code{exit},
2521 cannot return.  GCC knows this automatically.  Some programs define
2522 their own functions that never return.  You can declare them
2523 @code{noreturn} to tell the compiler this fact.  For example,
2524
2525 @smallexample
2526 @group
2527 void fatal () __attribute__ ((noreturn));
2528
2529 void
2530 fatal (/* @r{@dots{}} */)
2531 @{
2532   /* @r{@dots{}} */ /* @r{Print error message.} */ /* @r{@dots{}} */
2533   exit (1);
2534 @}
2535 @end group
2536 @end smallexample
2537
2538 The @code{noreturn} keyword tells the compiler to assume that
2539 @code{fatal} cannot return.  It can then optimize without regard to what
2540 would happen if @code{fatal} ever did return.  This makes slightly
2541 better code.  More importantly, it helps avoid spurious warnings of
2542 uninitialized variables.
2543
2544 The @code{noreturn} keyword does not affect the exceptional path when that
2545 applies: a @code{noreturn}-marked function may still return to the caller
2546 by throwing an exception or calling @code{longjmp}.
2547
2548 Do not assume that registers saved by the calling function are
2549 restored before calling the @code{noreturn} function.
2550
2551 It does not make sense for a @code{noreturn} function to have a return
2552 type other than @code{void}.
2553
2554 The attribute @code{noreturn} is not implemented in GCC versions
2555 earlier than 2.5.  An alternative way to declare that a function does
2556 not return, which works in the current version and in some older
2557 versions, is as follows:
2558
2559 @smallexample
2560 typedef void voidfn ();
2561
2562 volatile voidfn fatal;
2563 @end smallexample
2564
2565 This approach does not work in GNU C++.
2566
2567 @item nothrow
2568 @cindex @code{nothrow} function attribute
2569 The @code{nothrow} attribute is used to inform the compiler that a
2570 function cannot throw an exception.  For example, most functions in
2571 the standard C library can be guaranteed not to throw an exception
2572 with the notable exceptions of @code{qsort} and @code{bsearch} that
2573 take function pointer arguments.  The @code{nothrow} attribute is not
2574 implemented in GCC versions earlier than 3.3.
2575
2576 @item pure
2577 @cindex @code{pure} function attribute
2578 Many functions have no effects except the return value and their
2579 return value depends only on the parameters and/or global variables.
2580 Such a function can be subject
2581 to common subexpression elimination and loop optimization just as an
2582 arithmetic operator would be.  These functions should be declared
2583 with the attribute @code{pure}.  For example,
2584
2585 @smallexample
2586 int square (int) __attribute__ ((pure));
2587 @end smallexample
2588
2589 @noindent
2590 says that the hypothetical function @code{square} is safe to call
2591 fewer times than the program says.
2592
2593 Some of common examples of pure functions are @code{strlen} or @code{memcmp}.
2594 Interesting non-pure functions are functions with infinite loops or those
2595 depending on volatile memory or other system resource, that may change between
2596 two consecutive calls (such as @code{feof} in a multithreading environment).
2597
2598 The attribute @code{pure} is not implemented in GCC versions earlier
2599 than 2.96.
2600
2601 @item hot
2602 @cindex @code{hot} function attribute
2603 The @code{hot} attribute is used to inform the compiler that a function is a
2604 hot spot of the compiled program.  The function is optimized more aggressively
2605 and on many target it is placed into special subsection of the text section so
2606 all hot functions appears close together improving locality.
2607
2608 When profile feedback is available, via @option{-fprofile-use}, hot functions
2609 are automatically detected and this attribute is ignored.
2610
2611 The @code{hot} attribute is not implemented in GCC versions earlier than 4.3.
2612
2613 @item cold
2614 @cindex @code{cold} function attribute
2615 The @code{cold} attribute is used to inform the compiler that a function is
2616 unlikely executed.  The function is optimized for size rather than speed and on
2617 many targets it is placed into special subsection of the text section so all
2618 cold functions appears close together improving code locality of non-cold parts
2619 of program.  The paths leading to call of cold functions within code are marked
2620 as unlikely by the branch prediction mechanism. It is thus useful to mark
2621 functions used to handle unlikely conditions, such as @code{perror}, as cold to
2622 improve optimization of hot functions that do call marked functions in rare
2623 occasions.
2624
2625 When profile feedback is available, via @option{-fprofile-use}, hot functions
2626 are automatically detected and this attribute is ignored.
2627
2628 The @code{hot} attribute is not implemented in GCC versions earlier than 4.3.
2629
2630 @item regparm (@var{number})
2631 @cindex @code{regparm} attribute
2632 @cindex functions that are passed arguments in registers on the 386
2633 On the Intel 386, the @code{regparm} attribute causes the compiler to
2634 pass arguments number one to @var{number} if they are of integral type
2635 in registers EAX, EDX, and ECX instead of on the stack.  Functions that
2636 take a variable number of arguments will continue to be passed all of their
2637 arguments on the stack.
2638
2639 Beware that on some ELF systems this attribute is unsuitable for
2640 global functions in shared libraries with lazy binding (which is the
2641 default).  Lazy binding will send the first call via resolving code in
2642 the loader, which might assume EAX, EDX and ECX can be clobbered, as
2643 per the standard calling conventions.  Solaris 8 is affected by this.
2644 GNU systems with GLIBC 2.1 or higher, and FreeBSD, are believed to be
2645 safe since the loaders there save all registers.  (Lazy binding can be
2646 disabled with the linker or the loader if desired, to avoid the
2647 problem.)
2648
2649 @item sseregparm
2650 @cindex @code{sseregparm} attribute
2651 On the Intel 386 with SSE support, the @code{sseregparm} attribute
2652 causes the compiler to pass up to 3 floating point arguments in
2653 SSE registers instead of on the stack.  Functions that take a
2654 variable number of arguments will continue to pass all of their
2655 floating point arguments on the stack.
2656
2657 @item force_align_arg_pointer
2658 @cindex @code{force_align_arg_pointer} attribute
2659 On the Intel x86, the @code{force_align_arg_pointer} attribute may be
2660 applied to individual function definitions, generating an alternate
2661 prologue and epilogue that realigns the runtime stack.  This supports
2662 mixing legacy codes that run with a 4-byte aligned stack with modern
2663 codes that keep a 16-byte stack for SSE compatibility.  The alternate
2664 prologue and epilogue are slower and bigger than the regular ones, and
2665 the alternate prologue requires a scratch register; this lowers the
2666 number of registers available if used in conjunction with the
2667 @code{regparm} attribute.  The @code{force_align_arg_pointer}
2668 attribute is incompatible with nested functions; this is considered a
2669 hard error.
2670
2671 @item returns_twice
2672 @cindex @code{returns_twice} attribute
2673 The @code{returns_twice} attribute tells the compiler that a function may
2674 return more than one time.  The compiler will ensure that all registers
2675 are dead before calling such a function and will emit a warning about
2676 the variables that may be clobbered after the second return from the
2677 function.  Examples of such functions are @code{setjmp} and @code{vfork}.
2678 The @code{longjmp}-like counterpart of such function, if any, might need
2679 to be marked with the @code{noreturn} attribute.
2680
2681 @item saveall
2682 @cindex save all registers on the Blackfin, H8/300, H8/300H, and H8S
2683 Use this attribute on the Blackfin, H8/300, H8/300H, and H8S to indicate that
2684 all registers except the stack pointer should be saved in the prologue
2685 regardless of whether they are used or not.
2686
2687 @item section ("@var{section-name}")
2688 @cindex @code{section} function attribute
2689 Normally, the compiler places the code it generates in the @code{text} section.
2690 Sometimes, however, you need additional sections, or you need certain
2691 particular functions to appear in special sections.  The @code{section}
2692 attribute specifies that a function lives in a particular section.
2693 For example, the declaration:
2694
2695 @smallexample
2696 extern void foobar (void) __attribute__ ((section ("bar")));
2697 @end smallexample
2698
2699 @noindent
2700 puts the function @code{foobar} in the @code{bar} section.
2701
2702 Some file formats do not support arbitrary sections so the @code{section}
2703 attribute is not available on all platforms.
2704 If you need to map the entire contents of a module to a particular
2705 section, consider using the facilities of the linker instead.
2706
2707 @item sentinel
2708 @cindex @code{sentinel} function attribute
2709 This function attribute ensures that a parameter in a function call is
2710 an explicit @code{NULL}.  The attribute is only valid on variadic
2711 functions.  By default, the sentinel is located at position zero, the
2712 last parameter of the function call.  If an optional integer position
2713 argument P is supplied to the attribute, the sentinel must be located at
2714 position P counting backwards from the end of the argument list.
2715
2716 @smallexample
2717 __attribute__ ((sentinel))
2718 is equivalent to
2719 __attribute__ ((sentinel(0)))
2720 @end smallexample
2721
2722 The attribute is automatically set with a position of 0 for the built-in
2723 functions @code{execl} and @code{execlp}.  The built-in function
2724 @code{execle} has the attribute set with a position of 1.
2725
2726 A valid @code{NULL} in this context is defined as zero with any pointer
2727 type.  If your system defines the @code{NULL} macro with an integer type
2728 then you need to add an explicit cast.  GCC replaces @code{stddef.h}
2729 with a copy that redefines NULL appropriately.
2730
2731 The warnings for missing or incorrect sentinels are enabled with
2732 @option{-Wformat}.
2733
2734 @item short_call
2735 See long_call/short_call.
2736
2737 @item shortcall
2738 See longcall/shortcall.
2739
2740 @item signal
2741 @cindex signal handler functions on the AVR processors
2742 Use this attribute on the AVR to indicate that the specified
2743 function is a signal handler.  The compiler will generate function
2744 entry and exit sequences suitable for use in a signal handler when this
2745 attribute is present.  Interrupts will be disabled inside the function.
2746
2747 @item sp_switch
2748 Use this attribute on the SH to indicate an @code{interrupt_handler}
2749 function should switch to an alternate stack.  It expects a string
2750 argument that names a global variable holding the address of the
2751 alternate stack.
2752
2753 @smallexample
2754 void *alt_stack;
2755 void f () __attribute__ ((interrupt_handler,
2756                           sp_switch ("alt_stack")));
2757 @end smallexample
2758
2759 @item stdcall
2760 @cindex functions that pop the argument stack on the 386
2761 On the Intel 386, the @code{stdcall} attribute causes the compiler to
2762 assume that the called function will pop off the stack space used to
2763 pass arguments, unless it takes a variable number of arguments.
2764
2765 @item tiny_data
2766 @cindex tiny data section on the H8/300H and H8S
2767 Use this attribute on the H8/300H and H8S to indicate that the specified
2768 variable should be placed into the tiny data section.
2769 The compiler will generate more efficient code for loads and stores
2770 on data in the tiny data section.  Note the tiny data area is limited to
2771 slightly under 32kbytes of data.
2772
2773 @item trap_exit
2774 Use this attribute on the SH for an @code{interrupt_handler} to return using
2775 @code{trapa} instead of @code{rte}.  This attribute expects an integer
2776 argument specifying the trap number to be used.
2777
2778 @item unused
2779 @cindex @code{unused} attribute.
2780 This attribute, attached to a function, means that the function is meant
2781 to be possibly unused.  GCC will not produce a warning for this
2782 function.
2783
2784 @item used
2785 @cindex @code{used} attribute.
2786 This attribute, attached to a function, means that code must be emitted
2787 for the function even if it appears that the function is not referenced.
2788 This is useful, for example, when the function is referenced only in
2789 inline assembly.
2790
2791 @item version_id
2792 @cindex @code{version_id} attribute on IA64 HP-UX
2793 This attribute, attached to a global variable or function, renames a
2794 symbol to contain a version string, thus allowing for function level
2795 versioning.  HP-UX system header files may use version level functioning
2796 for some system calls.
2797
2798 @smallexample
2799 extern int foo () __attribute__((version_id ("20040821")));
2800 @end smallexample
2801
2802 Calls to @var{foo} will be mapped to calls to @var{foo@{20040821@}}.
2803
2804 @item visibility ("@var{visibility_type}")
2805 @cindex @code{visibility} attribute
2806 This attribute affects the linkage of the declaration to which it is attached.
2807 There are four supported @var{visibility_type} values: default,
2808 hidden, protected or internal visibility.
2809
2810 @smallexample
2811 void __attribute__ ((visibility ("protected")))
2812 f () @{ /* @r{Do something.} */; @}
2813 int i __attribute__ ((visibility ("hidden")));
2814 @end smallexample
2815
2816 The possible values of @var{visibility_type} correspond to the
2817 visibility settings in the ELF gABI.
2818
2819 @table @dfn
2820 @c keep this list of visibilities in alphabetical order.
2821
2822 @item default
2823 Default visibility is the normal case for the object file format.
2824 This value is available for the visibility attribute to override other
2825 options that may change the assumed visibility of entities.
2826
2827 On ELF, default visibility means that the declaration is visible to other
2828 modules and, in shared libraries, means that the declared entity may be
2829 overridden.
2830
2831 On Darwin, default visibility means that the declaration is visible to
2832 other modules.
2833
2834 Default visibility corresponds to ``external linkage'' in the language.
2835
2836 @item hidden
2837 Hidden visibility indicates that the entity declared will have a new
2838 form of linkage, which we'll call ``hidden linkage''.  Two
2839 declarations of an object with hidden linkage refer to the same object
2840 if they are in the same shared object.
2841
2842 @item internal
2843 Internal visibility is like hidden visibility, but with additional
2844 processor specific semantics.  Unless otherwise specified by the
2845 psABI, GCC defines internal visibility to mean that a function is
2846 @emph{never} called from another module.  Compare this with hidden
2847 functions which, while they cannot be referenced directly by other
2848 modules, can be referenced indirectly via function pointers.  By
2849 indicating that a function cannot be called from outside the module,
2850 GCC may for instance omit the load of a PIC register since it is known
2851 that the calling function loaded the correct value.
2852
2853 @item protected
2854 Protected visibility is like default visibility except that it
2855 indicates that references within the defining module will bind to the
2856 definition in that module.  That is, the declared entity cannot be
2857 overridden by another module.
2858
2859 @end table
2860
2861 All visibilities are supported on many, but not all, ELF targets
2862 (supported when the assembler supports the @samp{.visibility}
2863 pseudo-op).  Default visibility is supported everywhere.  Hidden
2864 visibility is supported on Darwin targets.
2865
2866 The visibility attribute should be applied only to declarations which
2867 would otherwise have external linkage.  The attribute should be applied
2868 consistently, so that the same entity should not be declared with
2869 different settings of the attribute.
2870
2871 In C++, the visibility attribute applies to types as well as functions
2872 and objects, because in C++ types have linkage.  A class must not have
2873 greater visibility than its non-static data member types and bases,
2874 and class members default to the visibility of their class.  Also, a
2875 declaration without explicit visibility is limited to the visibility
2876 of its type.
2877
2878 In C++, you can mark member functions and static member variables of a
2879 class with the visibility attribute.  This is useful if if you know a
2880 particular method or static member variable should only be used from
2881 one shared object; then you can mark it hidden while the rest of the
2882 class has default visibility.  Care must be taken to avoid breaking
2883 the One Definition Rule; for example, it is usually not useful to mark
2884 an inline method as hidden without marking the whole class as hidden.
2885
2886 A C++ namespace declaration can also have the visibility attribute.
2887 This attribute applies only to the particular namespace body, not to
2888 other definitions of the same namespace; it is equivalent to using
2889 @samp{#pragma GCC visibility} before and after the namespace
2890 definition (@pxref{Visibility Pragmas}).
2891
2892 In C++, if a template argument has limited visibility, this
2893 restriction is implicitly propagated to the template instantiation.
2894 Otherwise, template instantiations and specializations default to the
2895 visibility of their template.
2896
2897 If both the template and enclosing class have explicit visibility, the
2898 visibility from the template is used.
2899
2900 @item warn_unused_result
2901 @cindex @code{warn_unused_result} attribute
2902 The @code{warn_unused_result} attribute causes a warning to be emitted
2903 if a caller of the function with this attribute does not use its
2904 return value.  This is useful for functions where not checking
2905 the result is either a security problem or always a bug, such as
2906 @code{realloc}.
2907
2908 @smallexample
2909 int fn () __attribute__ ((warn_unused_result));
2910 int foo ()
2911 @{
2912   if (fn () < 0) return -1;
2913   fn ();
2914   return 0;
2915 @}
2916 @end smallexample
2917
2918 results in warning on line 5.
2919
2920 @item weak
2921 @cindex @code{weak} attribute
2922 The @code{weak} attribute causes the declaration to be emitted as a weak
2923 symbol rather than a global.  This is primarily useful in defining
2924 library functions which can be overridden in user code, though it can
2925 also be used with non-function declarations.  Weak symbols are supported
2926 for ELF targets, and also for a.out targets when using the GNU assembler
2927 and linker.
2928
2929 @item weakref
2930 @itemx weakref ("@var{target}")
2931 @cindex @code{weakref} attribute
2932 The @code{weakref} attribute marks a declaration as a weak reference.
2933 Without arguments, it should be accompanied by an @code{alias} attribute
2934 naming the target symbol.  Optionally, the @var{target} may be given as
2935 an argument to @code{weakref} itself.  In either case, @code{weakref}
2936 implicitly marks the declaration as @code{weak}.  Without a
2937 @var{target}, given as an argument to @code{weakref} or to @code{alias},
2938 @code{weakref} is equivalent to @code{weak}.
2939
2940 @smallexample
2941 static int x() __attribute__ ((weakref ("y")));
2942 /* is equivalent to... */
2943 static int x() __attribute__ ((weak, weakref, alias ("y")));
2944 /* and to... */
2945 static int x() __attribute__ ((weakref));
2946 static int x() __attribute__ ((alias ("y")));
2947 @end smallexample
2948
2949 A weak reference is an alias that does not by itself require a
2950 definition to be given for the target symbol.  If the target symbol is
2951 only referenced through weak references, then the becomes a @code{weak}
2952 undefined symbol.  If it is directly referenced, however, then such
2953 strong references prevail, and a definition will be required for the
2954 symbol, not necessarily in the same translation unit.
2955
2956 The effect is equivalent to moving all references to the alias to a
2957 separate translation unit, renaming the alias to the aliased symbol,
2958 declaring it as weak, compiling the two separate translation units and
2959 performing a reloadable link on them.
2960
2961 At present, a declaration to which @code{weakref} is attached can
2962 only be @code{static}.
2963
2964 @item externally_visible
2965 @cindex @code{externally_visible} attribute.
2966 This attribute, attached to a global variable or function nullify
2967 effect of @option{-fwhole-program} command line option, so the object
2968 remain visible outside the current compilation unit
2969
2970 @end table
2971
2972 You can specify multiple attributes in a declaration by separating them
2973 by commas within the double parentheses or by immediately following an
2974 attribute declaration with another attribute declaration.
2975
2976 @cindex @code{#pragma}, reason for not using
2977 @cindex pragma, reason for not using
2978 Some people object to the @code{__attribute__} feature, suggesting that
2979 ISO C's @code{#pragma} should be used instead.  At the time
2980 @code{__attribute__} was designed, there were two reasons for not doing
2981 this.
2982
2983 @enumerate
2984 @item
2985 It is impossible to generate @code{#pragma} commands from a macro.
2986
2987 @item
2988 There is no telling what the same @code{#pragma} might mean in another
2989 compiler.
2990 @end enumerate
2991
2992 These two reasons applied to almost any application that might have been
2993 proposed for @code{#pragma}.  It was basically a mistake to use
2994 @code{#pragma} for @emph{anything}.
2995
2996 The ISO C99 standard includes @code{_Pragma}, which now allows pragmas
2997 to be generated from macros.  In addition, a @code{#pragma GCC}
2998 namespace is now in use for GCC-specific pragmas.  However, it has been
2999 found convenient to use @code{__attribute__} to achieve a natural
3000 attachment of attributes to their corresponding declarations, whereas
3001 @code{#pragma GCC} is of use for constructs that do not naturally form
3002 part of the grammar.  @xref{Other Directives,,Miscellaneous
3003 Preprocessing Directives, cpp, The GNU C Preprocessor}.
3004
3005 @node Attribute Syntax
3006 @section Attribute Syntax
3007 @cindex attribute syntax
3008
3009 This section describes the syntax with which @code{__attribute__} may be
3010 used, and the constructs to which attribute specifiers bind, for the C
3011 language.  Some details may vary for C++ and Objective-C@.  Because of
3012 infelicities in the grammar for attributes, some forms described here
3013 may not be successfully parsed in all cases.
3014
3015 There are some problems with the semantics of attributes in C++.  For
3016 example, there are no manglings for attributes, although they may affect
3017 code generation, so problems may arise when attributed types are used in
3018 conjunction with templates or overloading.  Similarly, @code{typeid}
3019 does not distinguish between types with different attributes.  Support
3020 for attributes in C++ may be restricted in future to attributes on
3021 declarations only, but not on nested declarators.
3022
3023 @xref{Function Attributes}, for details of the semantics of attributes
3024 applying to functions.  @xref{Variable Attributes}, for details of the
3025 semantics of attributes applying to variables.  @xref{Type Attributes},
3026 for details of the semantics of attributes applying to structure, union
3027 and enumerated types.
3028
3029 An @dfn{attribute specifier} is of the form
3030 @code{__attribute__ ((@var{attribute-list}))}.  An @dfn{attribute list}
3031 is a possibly empty comma-separated sequence of @dfn{attributes}, where
3032 each attribute is one of the following:
3033
3034 @itemize @bullet
3035 @item
3036 Empty.  Empty attributes are ignored.
3037
3038 @item
3039 A word (which may be an identifier such as @code{unused}, or a reserved
3040 word such as @code{const}).
3041
3042 @item
3043 A word, followed by, in parentheses, parameters for the attribute.
3044 These parameters take one of the following forms:
3045
3046 @itemize @bullet
3047 @item
3048 An identifier.  For example, @code{mode} attributes use this form.
3049
3050 @item
3051 An identifier followed by a comma and a non-empty comma-separated list
3052 of expressions.  For example, @code{format} attributes use this form.
3053
3054 @item
3055 A possibly empty comma-separated list of expressions.  For example,
3056 @code{format_arg} attributes use this form with the list being a single
3057 integer constant expression, and @code{alias} attributes use this form
3058 with the list being a single string constant.
3059 @end itemize
3060 @end itemize
3061
3062 An @dfn{attribute specifier list} is a sequence of one or more attribute
3063 specifiers, not separated by any other tokens.
3064
3065 In GNU C, an attribute specifier list may appear after the colon following a
3066 label, other than a @code{case} or @code{default} label.  The only
3067 attribute it makes sense to use after a label is @code{unused}.  This
3068 feature is intended for code generated by programs which contains labels
3069 that may be unused but which is compiled with @option{-Wall}.  It would
3070 not normally be appropriate to use in it human-written code, though it
3071 could be useful in cases where the code that jumps to the label is
3072 contained within an @code{#ifdef} conditional.  GNU C++ does not permit
3073 such placement of attribute lists, as it is permissible for a
3074 declaration, which could begin with an attribute list, to be labelled in
3075 C++.  Declarations cannot be labelled in C90 or C99, so the ambiguity
3076 does not arise there.
3077
3078 An attribute specifier list may appear as part of a @code{struct},
3079 @code{union} or @code{enum} specifier.  It may go either immediately
3080 after the @code{struct}, @code{union} or @code{enum} keyword, or after
3081 the closing brace.  The former syntax is preferred.
3082 Where attribute specifiers follow the closing brace, they are considered
3083 to relate to the structure, union or enumerated type defined, not to any
3084 enclosing declaration the type specifier appears in, and the type
3085 defined is not complete until after the attribute specifiers.
3086 @c Otherwise, there would be the following problems: a shift/reduce
3087 @c conflict between attributes binding the struct/union/enum and
3088 @c binding to the list of specifiers/qualifiers; and "aligned"
3089 @c attributes could use sizeof for the structure, but the size could be
3090 @c changed later by "packed" attributes.
3091
3092 Otherwise, an attribute specifier appears as part of a declaration,
3093 counting declarations of unnamed parameters and type names, and relates
3094 to that declaration (which may be nested in another declaration, for
3095 example in the case of a parameter declaration), or to a particular declarator
3096 within a declaration.  Where an
3097 attribute specifier is applied to a parameter declared as a function or
3098 an array, it should apply to the function or array rather than the
3099 pointer to which the parameter is implicitly converted, but this is not
3100 yet correctly implemented.
3101
3102 Any list of specifiers and qualifiers at the start of a declaration may
3103 contain attribute specifiers, whether or not such a list may in that
3104 context contain storage class specifiers.  (Some attributes, however,
3105 are essentially in the nature of storage class specifiers, and only make
3106 sense where storage class specifiers may be used; for example,
3107 @code{section}.)  There is one necessary limitation to this syntax: the
3108 first old-style parameter declaration in a function definition cannot
3109 begin with an attribute specifier, because such an attribute applies to
3110 the function instead by syntax described below (which, however, is not
3111 yet implemented in this case).  In some other cases, attribute
3112 specifiers are permitted by this grammar but not yet supported by the
3113 compiler.  All attribute specifiers in this place relate to the
3114 declaration as a whole.  In the obsolescent usage where a type of
3115 @code{int} is implied by the absence of type specifiers, such a list of
3116 specifiers and qualifiers may be an attribute specifier list with no
3117 other specifiers or qualifiers.
3118
3119 At present, the first parameter in a function prototype must have some
3120 type specifier which is not an attribute specifier; this resolves an
3121 ambiguity in the interpretation of @code{void f(int
3122 (__attribute__((foo)) x))}, but is subject to change.  At present, if
3123 the parentheses of a function declarator contain only attributes then
3124 those attributes are ignored, rather than yielding an error or warning
3125 or implying a single parameter of type int, but this is subject to
3126 change.
3127
3128 An attribute specifier list may appear immediately before a declarator
3129 (other than the first) in a comma-separated list of declarators in a
3130 declaration of more than one identifier using a single list of
3131 specifiers and qualifiers.  Such attribute specifiers apply
3132 only to the identifier before whose declarator they appear.  For
3133 example, in
3134
3135 @smallexample
3136 __attribute__((noreturn)) void d0 (void),
3137     __attribute__((format(printf, 1, 2))) d1 (const char *, ...),
3138      d2 (void)
3139 @end smallexample
3140
3141 @noindent
3142 the @code{noreturn} attribute applies to all the functions
3143 declared; the @code{format} attribute only applies to @code{d1}.
3144
3145 An attribute specifier list may appear immediately before the comma,
3146 @code{=} or semicolon terminating the declaration of an identifier other
3147 than a function definition.  Such attribute specifiers apply
3148 to the declared object or function.  Where an
3149 assembler name for an object or function is specified (@pxref{Asm
3150 Labels}), the attribute must follow the @code{asm}
3151 specification.
3152
3153 An attribute specifier list may, in future, be permitted to appear after
3154 the declarator in a function definition (before any old-style parameter
3155 declarations or the function body).
3156
3157 Attribute specifiers may be mixed with type qualifiers appearing inside
3158 the @code{[]} of a parameter array declarator, in the C99 construct by
3159 which such qualifiers are applied to the pointer to which the array is
3160 implicitly converted.  Such attribute specifiers apply to the pointer,
3161 not to the array, but at present this is not implemented and they are
3162 ignored.
3163
3164 An attribute specifier list may appear at the start of a nested
3165 declarator.  At present, there are some limitations in this usage: the
3166 attributes correctly apply to the declarator, but for most individual
3167 attributes the semantics this implies are not implemented.
3168 When attribute specifiers follow the @code{*} of a pointer
3169 declarator, they may be mixed with any type qualifiers present.
3170 The following describes the formal semantics of this syntax.  It will make the
3171 most sense if you are familiar with the formal specification of
3172 declarators in the ISO C standard.
3173
3174 Consider (as in C99 subclause 6.7.5 paragraph 4) a declaration @code{T
3175 D1}, where @code{T} contains declaration specifiers that specify a type
3176 @var{Type} (such as @code{int}) and @code{D1} is a declarator that
3177 contains an identifier @var{ident}.  The type specified for @var{ident}
3178 for derived declarators whose type does not include an attribute
3179 specifier is as in the ISO C standard.
3180
3181 If @code{D1} has the form @code{( @var{attribute-specifier-list} D )},
3182 and the declaration @code{T D} specifies the type
3183 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
3184 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
3185 @var{attribute-specifier-list} @var{Type}'' for @var{ident}.
3186
3187 If @code{D1} has the form @code{*
3188 @var{type-qualifier-and-attribute-specifier-list} D}, and the
3189 declaration @code{T D} specifies the type
3190 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
3191 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
3192 @var{type-qualifier-and-attribute-specifier-list} @var{Type}'' for
3193 @var{ident}.
3194
3195 For example,
3196
3197 @smallexample
3198 void (__attribute__((noreturn)) ****f) (void);
3199 @end smallexample
3200
3201 @noindent
3202 specifies the type ``pointer to pointer to pointer to pointer to
3203 non-returning function returning @code{void}''.  As another example,
3204
3205 @smallexample
3206 char *__attribute__((aligned(8))) *f;
3207 @end smallexample
3208
3209 @noindent
3210 specifies the type ``pointer to 8-byte-aligned pointer to @code{char}''.
3211 Note again that this does not work with most attributes; for example,
3212 the usage of @samp{aligned} and @samp{noreturn} attributes given above
3213 is not yet supported.
3214
3215 For compatibility with existing code written for compiler versions that
3216 did not implement attributes on nested declarators, some laxity is
3217 allowed in the placing of attributes.  If an attribute that only applies
3218 to types is applied to a declaration, it will be treated as applying to
3219 the type of that declaration.  If an attribute that only applies to
3220 declarations is applied to the type of a declaration, it will be treated
3221 as applying to that declaration; and, for compatibility with code
3222 placing the attributes immediately before the identifier declared, such
3223 an attribute applied to a function return type will be treated as
3224 applying to the function type, and such an attribute applied to an array
3225 element type will be treated as applying to the array type.  If an
3226 attribute that only applies to function types is applied to a
3227 pointer-to-function type, it will be treated as applying to the pointer
3228 target type; if such an attribute is applied to a function return type
3229 that is not a pointer-to-function type, it will be treated as applying
3230 to the function type.
3231
3232 @node Function Prototypes
3233 @section Prototypes and Old-Style Function Definitions
3234 @cindex function prototype declarations
3235 @cindex old-style function definitions
3236 @cindex promotion of formal parameters
3237
3238 GNU C extends ISO C to allow a function prototype to override a later
3239 old-style non-prototype definition.  Consider the following example:
3240
3241 @smallexample
3242 /* @r{Use prototypes unless the compiler is old-fashioned.}  */
3243 #ifdef __STDC__
3244 #define P(x) x
3245 #else
3246 #define P(x) ()
3247 #endif
3248
3249 /* @r{Prototype function declaration.}  */
3250 int isroot P((uid_t));
3251
3252 /* @r{Old-style function definition.}  */
3253 int
3254 isroot (x)   /* @r{??? lossage here ???} */
3255      uid_t x;
3256 @{
3257   return x == 0;
3258 @}
3259 @end smallexample
3260
3261 Suppose the type @code{uid_t} happens to be @code{short}.  ISO C does
3262 not allow this example, because subword arguments in old-style
3263 non-prototype definitions are promoted.  Therefore in this example the
3264 function definition's argument is really an @code{int}, which does not
3265 match the prototype argument type of @code{short}.
3266
3267 This restriction of ISO C makes it hard to write code that is portable
3268 to traditional C compilers, because the programmer does not know
3269 whether the @code{uid_t} type is @code{short}, @code{int}, or
3270 @code{long}.  Therefore, in cases like these GNU C allows a prototype
3271 to override a later old-style definition.  More precisely, in GNU C, a
3272 function prototype argument type overrides the argument type specified
3273 by a later old-style definition if the former type is the same as the
3274 latter type before promotion.  Thus in GNU C the above example is
3275 equivalent to the following:
3276
3277 @smallexample
3278 int isroot (uid_t);
3279
3280 int
3281 isroot (uid_t x)
3282 @{
3283   return x == 0;
3284 @}
3285 @end smallexample
3286
3287 @noindent
3288 GNU C++ does not support old-style function definitions, so this
3289 extension is irrelevant.
3290
3291 @node C++ Comments
3292 @section C++ Style Comments
3293 @cindex //
3294 @cindex C++ comments
3295 @cindex comments, C++ style
3296
3297 In GNU C, you may use C++ style comments, which start with @samp{//} and
3298 continue until the end of the line.  Many other C implementations allow
3299 such comments, and they are included in the 1999 C standard.  However,
3300 C++ style comments are not recognized if you specify an @option{-std}
3301 option specifying a version of ISO C before C99, or @option{-ansi}
3302 (equivalent to @option{-std=c89}).
3303
3304 @node Dollar Signs
3305 @section Dollar Signs in Identifier Names
3306 @cindex $
3307 @cindex dollar signs in identifier names
3308 @cindex identifier names, dollar signs in
3309
3310 In GNU C, you may normally use dollar signs in identifier names.
3311 This is because many traditional C implementations allow such identifiers.
3312 However, dollar signs in identifiers are not supported on a few target
3313 machines, typically because the target assembler does not allow them.
3314
3315 @node Character Escapes
3316 @section The Character @key{ESC} in Constants
3317
3318 You can use the sequence @samp{\e} in a string or character constant to
3319 stand for the ASCII character @key{ESC}.
3320
3321 @node Alignment
3322 @section Inquiring on Alignment of Types or Variables
3323 @cindex alignment
3324 @cindex type alignment
3325 @cindex variable alignment
3326
3327 The keyword @code{__alignof__} allows you to inquire about how an object
3328 is aligned, or the minimum alignment usually required by a type.  Its
3329 syntax is just like @code{sizeof}.
3330
3331 For example, if the target machine requires a @code{double} value to be
3332 aligned on an 8-byte boundary, then @code{__alignof__ (double)} is 8.
3333 This is true on many RISC machines.  On more traditional machine
3334 designs, @code{__alignof__ (double)} is 4 or even 2.
3335
3336 Some machines never actually require alignment; they allow reference to any
3337 data type even at an odd address.  For these machines, @code{__alignof__}
3338 reports the @emph{recommended} alignment of a type.
3339
3340 If the operand of @code{__alignof__} is an lvalue rather than a type,
3341 its value is the required alignment for its type, taking into account
3342 any minimum alignment specified with GCC's @code{__attribute__}
3343 extension (@pxref{Variable Attributes}).  For example, after this
3344 declaration:
3345
3346 @smallexample
3347 struct foo @{ int x; char y; @} foo1;
3348 @end smallexample
3349
3350 @noindent
3351 the value of @code{__alignof__ (foo1.y)} is 1, even though its actual
3352 alignment is probably 2 or 4, the same as @code{__alignof__ (int)}.
3353
3354 It is an error to ask for the alignment of an incomplete type.
3355
3356 @node Variable Attributes
3357 @section Specifying Attributes of Variables
3358 @cindex attribute of variables
3359 @cindex variable attributes
3360
3361 The keyword @code{__attribute__} allows you to specify special
3362 attributes of variables or structure fields.  This keyword is followed
3363 by an attribute specification inside double parentheses.  Some
3364 attributes are currently defined generically for variables.
3365 Other attributes are defined for variables on particular target
3366 systems.  Other attributes are available for functions
3367 (@pxref{Function Attributes}) and for types (@pxref{Type Attributes}).
3368 Other front ends might define more attributes
3369 (@pxref{C++ Extensions,,Extensions to the C++ Language}).
3370
3371 You may also specify attributes with @samp{__} preceding and following
3372 each keyword.  This allows you to use them in header files without
3373 being concerned about a possible macro of the same name.  For example,
3374 you may use @code{__aligned__} instead of @code{aligned}.
3375
3376 @xref{Attribute Syntax}, for details of the exact syntax for using
3377 attributes.
3378
3379 @table @code
3380 @cindex @code{aligned} attribute
3381 @item aligned (@var{alignment})
3382 This attribute specifies a minimum alignment for the variable or
3383 structure field, measured in bytes.  For example, the declaration:
3384
3385 @smallexample
3386 int x __attribute__ ((aligned (16))) = 0;
3387 @end smallexample
3388
3389 @noindent
3390 causes the compiler to allocate the global variable @code{x} on a
3391 16-byte boundary.  On a 68040, this could be used in conjunction with
3392 an @code{asm} expression to access the @code{move16} instruction which
3393 requires 16-byte aligned operands.
3394
3395 You can also specify the alignment of structure fields.  For example, to
3396 create a double-word aligned @code{int} pair, you could write:
3397
3398 @smallexample
3399 struct foo @{ int x[2] __attribute__ ((aligned (8))); @};
3400 @end smallexample
3401
3402 @noindent
3403 This is an alternative to creating a union with a @code{double} member
3404 that forces the union to be double-word aligned.
3405
3406 As in the preceding examples, you can explicitly specify the alignment
3407 (in bytes) that you wish the compiler to use for a given variable or
3408 structure field.  Alternatively, you can leave out the alignment factor
3409 and just ask the compiler to align a variable or field to the maximum
3410 useful alignment for the target machine you are compiling for.  For
3411 example, you could write:
3412
3413 @smallexample
3414 short array[3] __attribute__ ((aligned));
3415 @end smallexample
3416
3417 Whenever you leave out the alignment factor in an @code{aligned} attribute
3418 specification, the compiler automatically sets the alignment for the declared
3419 variable or field to the largest alignment which is ever used for any data
3420 type on the target machine you are compiling for.  Doing this can often make
3421 copy operations more efficient, because the compiler can use whatever
3422 instructions copy the biggest chunks of memory when performing copies to
3423 or from the variables or fields that you have aligned this way.
3424
3425 When used on a struct, or struct member, the @code{aligned} attribute can
3426 only increase the alignment; in order to decrease it, the @code{packed}
3427 attribute must be specified as well.  When used as part of a typedef, the
3428 @code{aligned} attribute can both increase and decrease alignment, and
3429 specifying the @code{packed} attribute will generate a warning.
3430
3431 Note that the effectiveness of @code{aligned} attributes may be limited
3432 by inherent limitations in your linker.  On many systems, the linker is
3433 only able to arrange for variables to be aligned up to a certain maximum
3434 alignment.  (For some linkers, the maximum supported alignment may
3435 be very very small.)  If your linker is only able to align variables
3436 up to a maximum of 8 byte alignment, then specifying @code{aligned(16)}
3437 in an @code{__attribute__} will still only provide you with 8 byte
3438 alignment.  See your linker documentation for further information.
3439
3440 The @code{aligned} attribute can also be used for functions 
3441 (@pxref{Function Attributes}.)
3442
3443 @item cleanup (@var{cleanup_function})
3444 @cindex @code{cleanup} attribute
3445 The @code{cleanup} attribute runs a function when the variable goes
3446 out of scope.  This attribute can only be applied to auto function
3447 scope variables; it may not be applied to parameters or variables
3448 with static storage duration.  The function must take one parameter,
3449 a pointer to a type compatible with the variable.  The return value
3450 of the function (if any) is ignored.
3451
3452 If @option{-fexceptions} is enabled, then @var{cleanup_function}
3453 will be run during the stack unwinding that happens during the
3454 processing of the exception.  Note that the @code{cleanup} attribute
3455 does not allow the exception to be caught, only to perform an action.
3456 It is undefined what happens if @var{cleanup_function} does not
3457 return normally.
3458
3459 @item common
3460 @itemx nocommon
3461 @cindex @code{common} attribute
3462 @cindex @code{nocommon} attribute
3463 @opindex fcommon
3464 @opindex fno-common
3465 The @code{common} attribute requests GCC to place a variable in
3466 ``common'' storage.  The @code{nocommon} attribute requests the
3467 opposite---to allocate space for it directly.
3468
3469 These attributes override the default chosen by the
3470 @option{-fno-common} and @option{-fcommon} flags respectively.
3471
3472 @item deprecated
3473 @cindex @code{deprecated} attribute
3474 The @code{deprecated} attribute results in a warning if the variable
3475 is used anywhere in the source file.  This is useful when identifying
3476 variables that are expected to be removed in a future version of a
3477 program.  The warning also includes the location of the declaration
3478 of the deprecated variable, to enable users to easily find further
3479 information about why the variable is deprecated, or what they should
3480 do instead.  Note that the warning only occurs for uses:
3481
3482 @smallexample
3483 extern int old_var __attribute__ ((deprecated));
3484 extern int old_var;
3485 int new_fn () @{ return old_var; @}
3486 @end smallexample
3487
3488 results in a warning on line 3 but not line 2.
3489
3490 The @code{deprecated} attribute can also be used for functions and
3491 types (@pxref{Function Attributes}, @pxref{Type Attributes}.)
3492
3493 @item mode (@var{mode})
3494 @cindex @code{mode} attribute
3495 This attribute specifies the data type for the declaration---whichever
3496 type corresponds to the mode @var{mode}.  This in effect lets you
3497 request an integer or floating point type according to its width.
3498
3499 You may also specify a mode of @samp{byte} or @samp{__byte__} to
3500 indicate the mode corresponding to a one-byte integer, @samp{word} or
3501 @samp{__word__} for the mode of a one-word integer, and @samp{pointer}
3502 or @samp{__pointer__} for the mode used to represent pointers.
3503
3504 @item packed
3505 @cindex @code{packed} attribute
3506 The @code{packed} attribute specifies that a variable or structure field
3507 should have the smallest possible alignment---one byte for a variable,
3508 and one bit for a field, unless you specify a larger value with the
3509 @code{aligned} attribute.
3510
3511 Here is a structure in which the field @code{x} is packed, so that it
3512 immediately follows @code{a}:
3513
3514 @smallexample
3515 struct foo
3516 @{
3517   char a;
3518   int x[2] __attribute__ ((packed));
3519 @};
3520 @end smallexample
3521
3522 @item section ("@var{section-name}")
3523 @cindex @code{section} variable attribute
3524 Normally, the compiler places the objects it generates in sections like
3525 @code{data} and @code{bss}.  Sometimes, however, you need additional sections,
3526 or you need certain particular variables to appear in special sections,
3527 for example to map to special hardware.  The @code{section}
3528 attribute specifies that a variable (or function) lives in a particular
3529 section.  For example, this small program uses several specific section names:
3530
3531 @smallexample
3532 struct duart a __attribute__ ((section ("DUART_A"))) = @{ 0 @};
3533 struct duart b __attribute__ ((section ("DUART_B"))) = @{ 0 @};
3534 char stack[10000] __attribute__ ((section ("STACK"))) = @{ 0 @};
3535 int init_data __attribute__ ((section ("INITDATA"))) = 0;
3536
3537 main()
3538 @{
3539   /* @r{Initialize stack pointer} */
3540   init_sp (stack + sizeof (stack));
3541
3542   /* @r{Initialize initialized data} */
3543   memcpy (&init_data, &data, &edata - &data);
3544
3545   /* @r{Turn on the serial ports} */
3546   init_duart (&a);
3547   init_duart (&b);
3548 @}
3549 @end smallexample
3550
3551 @noindent
3552 Use the @code{section} attribute with an @emph{initialized} definition
3553 of a @emph{global} variable, as shown in the example.  GCC issues
3554 a warning and otherwise ignores the @code{section} attribute in
3555 uninitialized variable declarations.
3556
3557 You may only use the @code{section} attribute with a fully initialized
3558 global definition because of the way linkers work.  The linker requires
3559 each object be defined once, with the exception that uninitialized
3560 variables tentatively go in the @code{common} (or @code{bss}) section
3561 and can be multiply ``defined''.  You can force a variable to be
3562 initialized with the @option{-fno-common} flag or the @code{nocommon}
3563 attribute.
3564
3565 Some file formats do not support arbitrary sections so the @code{section}
3566 attribute is not available on all platforms.
3567 If you need to map the entire contents of a module to a particular
3568 section, consider using the facilities of the linker instead.
3569
3570 @item shared
3571 @cindex @code{shared} variable attribute
3572 On Microsoft Windows, in addition to putting variable definitions in a named
3573 section, the section can also be shared among all running copies of an
3574 executable or DLL@.  For example, this small program defines shared data
3575 by putting it in a named section @code{shared} and marking the section
3576 shareable:
3577
3578 @smallexample
3579 int foo __attribute__((section ("shared"), shared)) = 0;
3580
3581 int
3582 main()
3583 @{
3584   /* @r{Read and write foo.  All running
3585      copies see the same value.}  */
3586   return 0;
3587 @}
3588 @end smallexample
3589
3590 @noindent
3591 You may only use the @code{shared} attribute along with @code{section}
3592 attribute with a fully initialized global definition because of the way
3593 linkers work.  See @code{section} attribute for more information.
3594
3595 The @code{shared} attribute is only available on Microsoft Windows@.
3596
3597 @item tls_model ("@var{tls_model}")
3598 @cindex @code{tls_model} attribute
3599 The @code{tls_model} attribute sets thread-local storage model
3600 (@pxref{Thread-Local}) of a particular @code{__thread} variable,
3601 overriding @option{-ftls-model=} command line switch on a per-variable
3602 basis.
3603 The @var{tls_model} argument should be one of @code{global-dynamic},
3604 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
3605
3606 Not all targets support this attribute.
3607
3608 @item unused
3609 This attribute, attached to a variable, means that the variable is meant
3610 to be possibly unused.  GCC will not produce a warning for this
3611 variable.
3612
3613 @item used
3614 This attribute, attached to a variable, means that the variable must be
3615 emitted even if it appears that the variable is not referenced.
3616
3617 @item vector_size (@var{bytes})
3618 This attribute specifies the vector size for the variable, measured in
3619 bytes.  For example, the declaration:
3620
3621 @smallexample
3622 int foo __attribute__ ((vector_size (16)));
3623 @end smallexample
3624
3625 @noindent
3626 causes the compiler to set the mode for @code{foo}, to be 16 bytes,
3627 divided into @code{int} sized units.  Assuming a 32-bit int (a vector of
3628 4 units of 4 bytes), the corresponding mode of @code{foo} will be V4SI@.
3629
3630 This attribute is only applicable to integral and float scalars,
3631 although arrays, pointers, and function return values are allowed in
3632 conjunction with this construct.
3633
3634 Aggregates with this attribute are invalid, even if they are of the same
3635 size as a corresponding scalar.  For example, the declaration:
3636
3637 @smallexample
3638 struct S @{ int a; @};
3639 struct S  __attribute__ ((vector_size (16))) foo;
3640 @end smallexample
3641
3642 @noindent
3643 is invalid even if the size of the structure is the same as the size of
3644 the @code{int}.
3645
3646 @item selectany
3647 The @code{selectany} attribute causes an initialized global variable to
3648 have link-once semantics.  When multiple definitions of the variable are
3649 encountered by the linker, the first is selected and the remainder are
3650 discarded.  Following usage by the Microsoft compiler, the linker is told
3651 @emph{not} to warn about size or content differences of the multiple
3652 definitions.
3653
3654 Although the primary usage of this attribute is for POD types, the
3655 attribute can also be applied to global C++ objects that are initialized
3656 by a constructor.  In this case, the static initialization and destruction
3657 code for the object is emitted in each translation defining the object,
3658 but the calls to the constructor and destructor are protected by a
3659 link-once guard variable.
3660
3661 The @code{selectany} attribute is only available on Microsoft Windows
3662 targets.  You can use @code{__declspec (selectany)} as a synonym for
3663 @code{__attribute__ ((selectany))} for compatibility with other
3664 compilers.
3665
3666 @item weak
3667 The @code{weak} attribute is described in @xref{Function Attributes}.
3668
3669 @item dllimport
3670 The @code{dllimport} attribute is described in @xref{Function Attributes}.
3671
3672 @item dllexport
3673 The @code{dllexport} attribute is described in @xref{Function Attributes}.
3674
3675 @end table
3676
3677 @subsection Blackfin Variable Attributes
3678
3679 Three attributes are currently defined for the Blackfin.
3680
3681 @table @code
3682 @item l1_data
3683 @item l1_data_A
3684 @item l1_data_B
3685 @cindex @code{l1_data} variable attribute
3686 @cindex @code{l1_data_A} variable attribute
3687 @cindex @code{l1_data_B} variable attribute
3688 Use these attributes on the Blackfin to place the variable into L1 Data SRAM.
3689 Variables with @code{l1_data} attribute will be put into the specific section
3690 named @code{.l1.data}. Those with @code{l1_data_A} attribute will be put into
3691 the specific section named @code{.l1.data.A}. Those with @code{l1_data_B}
3692 attribute will be put into the specific section named @code{.l1.data.B}.
3693 @end table
3694
3695 @subsection M32R/D Variable Attributes
3696
3697 One attribute is currently defined for the M32R/D@.
3698
3699 @table @code
3700 @item model (@var{model-name})
3701 @cindex variable addressability on the M32R/D
3702 Use this attribute on the M32R/D to set the addressability of an object.
3703 The identifier @var{model-name} is one of @code{small}, @code{medium},
3704 or @code{large}, representing each of the code models.
3705
3706 Small model objects live in the lower 16MB of memory (so that their
3707 addresses can be loaded with the @code{ld24} instruction).
3708
3709 Medium and large model objects may live anywhere in the 32-bit address space
3710 (the compiler will generate @code{seth/add3} instructions to load their
3711 addresses).
3712 @end table
3713
3714 @anchor{i386 Variable Attributes}
3715 @subsection i386 Variable Attributes
3716
3717 Two attributes are currently defined for i386 configurations:
3718 @code{ms_struct} and @code{gcc_struct}
3719
3720 @table @code
3721 @item ms_struct
3722 @itemx gcc_struct
3723 @cindex @code{ms_struct} attribute
3724 @cindex @code{gcc_struct} attribute
3725
3726 If @code{packed} is used on a structure, or if bit-fields are used
3727 it may be that the Microsoft ABI packs them differently
3728 than GCC would normally pack them.  Particularly when moving packed
3729 data between functions compiled with GCC and the native Microsoft compiler
3730 (either via function call or as data in a file), it may be necessary to access
3731 either format.
3732
3733 Currently @option{-m[no-]ms-bitfields} is provided for the Microsoft Windows X86
3734 compilers to match the native Microsoft compiler.
3735
3736 The Microsoft structure layout algorithm is fairly simple with the exception
3737 of the bitfield packing:
3738
3739 The padding and alignment of members of structures and whether a bit field
3740 can straddle a storage-unit boundary
3741
3742 @enumerate
3743 @item Structure members are stored sequentially in the order in which they are
3744 declared: the first member has the lowest memory address and the last member
3745 the highest.
3746
3747 @item Every data object has an alignment-requirement. The alignment-requirement
3748 for all data except structures, unions, and arrays is either the size of the
3749 object or the current packing size (specified with either the aligned attribute
3750 or the pack pragma), whichever is less. For structures,  unions, and arrays,
3751 the alignment-requirement is the largest alignment-requirement of its members.
3752 Every object is allocated an offset so that:
3753
3754 offset %  alignment-requirement == 0
3755
3756 @item Adjacent bit fields are packed into the same 1-, 2-, or 4-byte allocation
3757 unit if the integral types are the same size and if the next bit field fits
3758 into the current allocation unit without crossing the boundary imposed by the
3759 common alignment requirements of the bit fields.
3760 @end enumerate
3761
3762 Handling of zero-length bitfields:
3763
3764 MSVC interprets zero-length bitfields in the following ways:
3765
3766 @enumerate
3767 @item If a zero-length bitfield is inserted between two bitfields that would
3768 normally be coalesced, the bitfields will not be coalesced.
3769
3770 For example:
3771
3772 @smallexample
3773 struct
3774  @{
3775    unsigned long bf_1 : 12;
3776    unsigned long : 0;
3777    unsigned long bf_2 : 12;
3778  @} t1;
3779 @end smallexample
3780
3781 The size of @code{t1} would be 8 bytes with the zero-length bitfield.  If the
3782 zero-length bitfield were removed, @code{t1}'s size would be 4 bytes.
3783
3784 @item If a zero-length bitfield is inserted after a bitfield, @code{foo}, and the
3785 alignment of the zero-length bitfield is greater than the member that follows it,
3786 @code{bar}, @code{bar} will be aligned as the type of the zero-length bitfield.
3787
3788 For example:
3789
3790 @smallexample
3791 struct
3792  @{
3793    char foo : 4;
3794    short : 0;
3795    char bar;
3796  @} t2;
3797
3798 struct
3799  @{
3800    char foo : 4;
3801    short : 0;
3802    double bar;
3803  @} t3;
3804 @end smallexample
3805
3806 For @code{t2}, @code{bar} will be placed at offset 2, rather than offset 1.
3807 Accordingly, the size of @code{t2} will be 4.  For @code{t3}, the zero-length
3808 bitfield will not affect the alignment of @code{bar} or, as a result, the size
3809 of the structure.
3810
3811 Taking this into account, it is important to note the following:
3812
3813 @enumerate
3814 @item If a zero-length bitfield follows a normal bitfield, the type of the
3815 zero-length bitfield may affect the alignment of the structure as whole. For
3816 example, @code{t2} has a size of 4 bytes, since the zero-length bitfield follows a
3817 normal bitfield, and is of type short.
3818
3819 @item Even if a zero-length bitfield is not followed by a normal bitfield, it may
3820 still affect the alignment of the structure:
3821
3822 @smallexample
3823 struct
3824  @{
3825    char foo : 6;
3826    long : 0;
3827  @} t4;
3828 @end smallexample
3829
3830 Here, @code{t4} will take up 4 bytes.
3831 @end enumerate
3832
3833 @item Zero-length bitfields following non-bitfield members are ignored:
3834
3835 @smallexample
3836 struct
3837  @{
3838    char foo;
3839    long : 0;
3840    char bar;
3841  @} t5;
3842 @end smallexample
3843
3844 Here, @code{t5} will take up 2 bytes.
3845 @end enumerate
3846 @end table
3847
3848 @subsection PowerPC Variable Attributes
3849
3850 Three attributes currently are defined for PowerPC configurations:
3851 @code{altivec}, @code{ms_struct} and @code{gcc_struct}.
3852
3853 For full documentation of the struct attributes please see the
3854 documentation in the @xref{i386 Variable Attributes}, section.
3855
3856 For documentation of @code{altivec} attribute please see the
3857 documentation in the @xref{PowerPC Type Attributes}, section.
3858
3859 @subsection SPU Variable Attributes
3860
3861 The SPU supports the @code{spu_vector} attribute for variables.  For
3862 documentation of this attribute please see the documentation in the
3863 @xref{SPU Type Attributes}, section.
3864
3865 @subsection Xstormy16 Variable Attributes
3866
3867 One attribute is currently defined for xstormy16 configurations:
3868 @code{below100}
3869
3870 @table @code
3871 @item below100
3872 @cindex @code{below100} attribute
3873
3874 If a variable has the @code{below100} attribute (@code{BELOW100} is
3875 allowed also), GCC will place the variable in the first 0x100 bytes of
3876 memory and use special opcodes to access it.  Such variables will be
3877 placed in either the @code{.bss_below100} section or the
3878 @code{.data_below100} section.
3879
3880 @end table
3881
3882 @subsection AVR Variable Attributes
3883
3884 @table @code
3885 @item progmem
3886 @cindex @code{progmem} variable attribute
3887 The @code{progmem} attribute is used on the AVR to place data in the Program
3888 Memory address space. The AVR is a Harvard Architecture processor and data
3889 normally resides in the Data Memory address space.
3890 @end table
3891
3892 @node Type Attributes
3893 @section Specifying Attributes of Types
3894 @cindex attribute of types
3895 @cindex type attributes
3896
3897 The keyword @code{__attribute__} allows you to specify special
3898 attributes of @code{struct} and @code{union} types when you define
3899 such types.  This keyword is followed by an attribute specification
3900 inside double parentheses.  Seven attributes are currently defined for
3901 types: @code{aligned}, @code{packed}, @code{transparent_union},
3902 @code{unused}, @code{deprecated}, @code{visibility}, and
3903 @code{may_alias}.  Other attributes are defined for functions
3904 (@pxref{Function Attributes}) and for variables (@pxref{Variable
3905 Attributes}).
3906
3907 You may also specify any one of these attributes with @samp{__}
3908 preceding and following its keyword.  This allows you to use these
3909 attributes in header files without being concerned about a possible
3910 macro of the same name.  For example, you may use @code{__aligned__}
3911 instead of @code{aligned}.
3912
3913 You may specify type attributes either in a @code{typedef} declaration
3914 or in an enum, struct or union type declaration or definition.
3915
3916 For an enum, struct or union type, you may specify attributes either
3917 between the enum, struct or union tag and the name of the type, or
3918 just past the closing curly brace of the @emph{definition}.  The
3919 former syntax is preferred.
3920
3921 @xref{Attribute Syntax}, for details of the exact syntax for using
3922 attributes.
3923
3924 @table @code
3925 @cindex @code{aligned} attribute
3926 @item aligned (@var{alignment})
3927 This attribute specifies a minimum alignment (in bytes) for variables
3928 of the specified type.  For example, the declarations:
3929
3930 @smallexample
3931 struct S @{ short f[3]; @} __attribute__ ((aligned (8)));
3932 typedef int more_aligned_int __attribute__ ((aligned (8)));
3933 @end smallexample
3934
3935 @noindent
3936 force the compiler to insure (as far as it can) that each variable whose
3937 type is @code{struct S} or @code{more_aligned_int} will be allocated and
3938 aligned @emph{at least} on a 8-byte boundary.  On a SPARC, having all
3939 variables of type @code{struct S} aligned to 8-byte boundaries allows
3940 the compiler to use the @code{ldd} and @code{std} (doubleword load and
3941 store) instructions when copying one variable of type @code{struct S} to
3942 another, thus improving run-time efficiency.
3943
3944 Note that the alignment of any given @code{struct} or @code{union} type
3945 is required by the ISO C standard to be at least a perfect multiple of
3946 the lowest common multiple of the alignments of all of the members of
3947 the @code{struct} or @code{union} in question.  This means that you @emph{can}
3948 effectively adjust the alignment of a @code{struct} or @code{union}
3949 type by attaching an @code{aligned} attribute to any one of the members
3950 of such a type, but the notation illustrated in the example above is a
3951 more obvious, intuitive, and readable way to request the compiler to
3952 adjust the alignment of an entire @code{struct} or @code{union} type.
3953
3954 As in the preceding example, you can explicitly specify the alignment
3955 (in bytes) that you wish the compiler to use for a given @code{struct}
3956 or @code{union} type.  Alternatively, you can leave out the alignment factor
3957 and just ask the compiler to align a type to the maximum
3958 useful alignment for the target machine you are compiling for.  For
3959 example, you could write:
3960
3961 @smallexample
3962 struct S @{ short f[3]; @} __attribute__ ((aligned));
3963 @end smallexample
3964
3965 Whenever you leave out the alignment factor in an @code{aligned}
3966 attribute specification, the compiler automatically sets the alignment
3967 for the type to the largest alignment which is ever used for any data
3968 type on the target machine you are compiling for.  Doing this can often
3969 make copy operations more efficient, because the compiler can use
3970 whatever instructions copy the biggest chunks of memory when performing
3971 copies to or from the variables which have types that you have aligned
3972 this way.
3973
3974 In the example above, if the size of each @code{short} is 2 bytes, then
3975 the size of the entire @code{struct S} type is 6 bytes.  The smallest
3976 power of two which is greater than or equal to that is 8, so the
3977 compiler sets the alignment for the entire @code{struct S} type to 8
3978 bytes.
3979
3980 Note that although you can ask the compiler to select a time-efficient
3981 alignment for a given type and then declare only individual stand-alone
3982 objects of that type, the compiler's ability to select a time-efficient
3983 alignment is primarily useful only when you plan to create arrays of
3984 variables having the relevant (efficiently aligned) type.  If you
3985 declare or use arrays of variables of an efficiently-aligned type, then
3986 it is likely that your program will also be doing pointer arithmetic (or
3987 subscripting, which amounts to the same thing) on pointers to the
3988 relevant type, and the code that the compiler generates for these
3989 pointer arithmetic operations will often be more efficient for
3990 efficiently-aligned types than for other types.
3991
3992 The @code{aligned} attribute can only increase the alignment; but you
3993 can decrease it by specifying @code{packed} as well.  See below.
3994
3995 Note that the effectiveness of @code{aligned} attributes may be limited
3996 by inherent limitations in your linker.  On many systems, the linker is
3997 only able to arrange for variables to be aligned up to a certain maximum
3998 alignment.  (For some linkers, the maximum supported alignment may
3999 be very very small.)  If your linker is only able to align variables
4000 up to a maximum of 8 byte alignment, then specifying @code{aligned(16)}
4001 in an @code{__attribute__} will still only provide you with 8 byte
4002 alignment.  See your linker documentation for further information.
4003
4004 @item packed
4005 This attribute, attached to @code{struct} or @code{union} type
4006 definition, specifies that each member (other than zero-width bitfields)
4007 of the structure or union is placed to minimize the memory required.  When
4008 attached to an @code{enum} definition, it indicates that the smallest
4009 integral type should be used.
4010
4011 @opindex fshort-enums
4012 Specifying this attribute for @code{struct} and @code{union} types is
4013 equivalent to specifying the @code{packed} attribute on each of the
4014 structure or union members.  Specifying the @option{-fshort-enums}
4015 flag on the line is equivalent to specifying the @code{packed}
4016 attribute on all @code{enum} definitions.
4017
4018 In the following example @code{struct my_packed_struct}'s members are
4019 packed closely together, but the internal layout of its @code{s} member
4020 is not packed---to do that, @code{struct my_unpacked_struct} would need to
4021 be packed too.
4022
4023 @smallexample
4024 struct my_unpacked_struct
4025  @{
4026     char c;
4027     int i;
4028  @};
4029
4030 struct __attribute__ ((__packed__)) my_packed_struct
4031   @{
4032      char c;
4033      int  i;
4034      struct my_unpacked_struct s;
4035   @};
4036 @end smallexample
4037
4038 You may only specify this attribute on the definition of a @code{enum},
4039 @code{struct} or @code{union}, not on a @code{typedef} which does not
4040 also define the enumerated type, structure or union.
4041
4042 @item transparent_union
4043 This attribute, attached to a @code{union} type definition, indicates
4044 that any function parameter having that union type causes calls to that
4045 function to be treated in a special way.
4046
4047 First, the argument corresponding to a transparent union type can be of
4048 any type in the union; no cast is required.  Also, if the union contains
4049 a pointer type, the corresponding argument can be a null pointer
4050 constant or a void pointer expression; and if the union contains a void
4051 pointer type, the corresponding argument can be any pointer expression.
4052 If the union member type is a pointer, qualifiers like @code{const} on
4053 the referenced type must be respected, just as with normal pointer
4054 conversions.
4055
4056 Second, the argument is passed to the function using the calling
4057 conventions of the first member of the transparent union, not the calling
4058 conventions of the union itself.  All members of the union must have the
4059 same machine representation; this is necessary for this argument passing
4060 to work properly.
4061
4062 Transparent unions are designed for library functions that have multiple
4063 interfaces for compatibility reasons.  For example, suppose the
4064 @code{wait} function must accept either a value of type @code{int *} to
4065 comply with Posix, or a value of type @code{union wait *} to comply with
4066 the 4.1BSD interface.  If @code{wait}'s parameter were @code{void *},
4067 @code{wait} would accept both kinds of arguments, but it would also
4068 accept any other pointer type and this would make argument type checking
4069 less useful.  Instead, @code{<sys/wait.h>} might define the interface
4070 as follows:
4071
4072 @smallexample
4073 typedef union
4074   @{
4075     int *__ip;
4076     union wait *__up;
4077   @} wait_status_ptr_t __attribute__ ((__transparent_union__));
4078
4079 pid_t wait (wait_status_ptr_t);
4080 @end smallexample
4081
4082 This interface allows either @code{int *} or @code{union wait *}
4083 arguments to be passed, using the @code{int *} calling convention.
4084 The program can call @code{wait} with arguments of either type:
4085
4086 @smallexample
4087 int w1 () @{ int w; return wait (&w); @}
4088 int w2 () @{ union wait w; return wait (&w); @}
4089 @end smallexample
4090
4091 With this interface, @code{wait}'s implementation might look like this:
4092
4093 @smallexample
4094 pid_t wait (wait_status_ptr_t p)
4095 @{
4096   return waitpid (-1, p.__ip, 0);
4097 @}
4098 @end smallexample
4099
4100 @item unused
4101 When attached to a type (including a @code{union} or a @code{struct}),
4102 this attribute means that variables of that type are meant to appear
4103 possibly unused.  GCC will not produce a warning for any variables of
4104 that type, even if the variable appears to do nothing.  This is often
4105 the case with lock or thread classes, which are usually defined and then
4106 not referenced, but contain constructors and destructors that have
4107 nontrivial bookkeeping functions.
4108
4109 @item deprecated
4110 The @code{deprecated} attribute results in a warning if the type
4111 is used anywhere in the source file.  This is useful when identifying
4112 types that are expected to be removed in a future version of a program.
4113 If possible, the warning also includes the location of the declaration
4114 of the deprecated type, to enable users to easily find further
4115 information about why the type is deprecated, or what they should do
4116 instead.  Note that the warnings only occur for uses and then only
4117 if the type is being applied to an identifier that itself is not being
4118 declared as deprecated.
4119
4120 @smallexample
4121 typedef int T1 __attribute__ ((deprecated));
4122 T1 x;
4123 typedef T1 T2;
4124 T2 y;
4125 typedef T1 T3 __attribute__ ((deprecated));
4126 T3 z __attribute__ ((deprecated));
4127 @end smallexample
4128
4129 results in a warning on line 2 and 3 but not lines 4, 5, or 6.  No
4130 warning is issued for line 4 because T2 is not explicitly
4131 deprecated.  Line 5 has no warning because T3 is explicitly
4132 deprecated.  Similarly for line 6.
4133
4134 The @code{deprecated} attribute can also be used for functions and
4135 variables (@pxref{Function Attributes}, @pxref{Variable Attributes}.)
4136
4137 @item may_alias
4138 Accesses to objects with types with this attribute are not subjected to
4139 type-based alias analysis, but are instead assumed to be able to alias
4140 any other type of objects, just like the @code{char} type.  See
4141 @option{-fstrict-aliasing} for more information on aliasing issues.
4142
4143 Example of use:
4144
4145 @smallexample
4146 typedef short __attribute__((__may_alias__)) short_a;
4147
4148 int
4149 main (void)
4150 @{
4151   int a = 0x12345678;
4152   short_a *b = (short_a *) &a;
4153
4154   b[1] = 0;
4155
4156   if (a == 0x12345678)
4157     abort();
4158
4159   exit(0);
4160 @}
4161 @end smallexample
4162
4163 If you replaced @code{short_a} with @code{short} in the variable
4164 declaration, the above program would abort when compiled with
4165 @option{-fstrict-aliasing}, which is on by default at @option{-O2} or
4166 above in recent GCC versions.
4167
4168 @item visibility
4169 In C++, attribute visibility (@pxref{Function Attributes}) can also be
4170 applied to class, struct, union and enum types.  Unlike other type
4171 attributes, the attribute must appear between the initial keyword and
4172 the name of the type; it cannot appear after the body of the type.
4173
4174 Note that the type visibility is applied to vague linkage entities
4175 associated with the class (vtable, typeinfo node, etc.).  In
4176 particular, if a class is thrown as an exception in one shared object
4177 and caught in another, the class must have default visibility.
4178 Otherwise the two shared objects will be unable to use the same
4179 typeinfo node and exception handling will break.
4180
4181 @subsection ARM Type Attributes
4182
4183 On those ARM targets that support @code{dllimport} (such as Symbian
4184 OS), you can use the @code{notshared} attribute to indicate that the
4185 virtual table and other similar data for a class should not be
4186 exported from a DLL@.  For example:
4187
4188 @smallexample
4189 class __declspec(notshared) C @{
4190 public:
4191   __declspec(dllimport) C();
4192   virtual void f();
4193 @}
4194
4195 __declspec(dllexport)
4196 C::C() @{@}
4197 @end smallexample
4198
4199 In this code, @code{C::C} is exported from the current DLL, but the
4200 virtual table for @code{C} is not exported.  (You can use
4201 @code{__attribute__} instead of @code{__declspec} if you prefer, but
4202 most Symbian OS code uses @code{__declspec}.)
4203
4204 @anchor{i386 Type Attributes}
4205 @subsection i386 Type Attributes
4206
4207 Two attributes are currently defined for i386 configurations:
4208 @code{ms_struct} and @code{gcc_struct}
4209
4210 @item ms_struct
4211 @itemx gcc_struct
4212 @cindex @code{ms_struct}
4213 @cindex @code{gcc_struct}
4214
4215 If @code{packed} is used on a structure, or if bit-fields are used
4216 it may be that the Microsoft ABI packs them differently
4217 than GCC would normally pack them.  Particularly when moving packed
4218 data between functions compiled with GCC and the native Microsoft compiler
4219 (either via function call or as data in a file), it may be necessary to access
4220 either format.
4221
4222 Currently @option{-m[no-]ms-bitfields} is provided for the Microsoft Windows X86
4223 compilers to match the native Microsoft compiler.
4224 @end table
4225
4226 To specify multiple attributes, separate them by commas within the
4227 double parentheses: for example, @samp{__attribute__ ((aligned (16),
4228 packed))}.
4229
4230 @anchor{PowerPC Type Attributes}
4231 @subsection PowerPC Type Attributes
4232
4233 Three attributes currently are defined for PowerPC configurations:
4234 @code{altivec}, @code{ms_struct} and @code{gcc_struct}.
4235
4236 For full documentation of the struct attributes please see the
4237 documentation in the @xref{i386 Type Attributes}, section.
4238
4239 The @code{altivec} attribute allows one to declare AltiVec vector data
4240 types supported by the AltiVec Programming Interface Manual.  The
4241 attribute requires an argument to specify one of three vector types:
4242 @code{vector__}, @code{pixel__} (always followed by unsigned short),
4243 and @code{bool__} (always followed by unsigned).
4244
4245 @smallexample
4246 __attribute__((altivec(vector__)))
4247 __attribute__((altivec(pixel__))) unsigned short
4248 __attribute__((altivec(bool__))) unsigned
4249 @end smallexample
4250
4251 These attributes mainly are intended to support the @code{__vector},
4252 @code{__pixel}, and @code{__bool} AltiVec keywords.
4253
4254 @anchor{SPU Type Attributes}
4255 @subsection SPU Type Attributes
4256
4257 The SPU supports the @code{spu_vector} attribute for types.  This attribute
4258 allows one to declare vector data types supported by the Sony/Toshiba/IBM SPU
4259 Language Extensions Specification.  It is intended to support the
4260 @code{__vector} keyword.
4261
4262
4263 @node Inline
4264 @section An Inline Function is As Fast As a Macro
4265 @cindex inline functions
4266 @cindex integrating function code
4267 @cindex open coding
4268 @cindex macros, inline alternative
4269
4270 By declaring a function inline, you can direct GCC to make
4271 calls to that function faster.  One way GCC can achieve this is to
4272 integrate that function's code into the code for its callers.  This
4273 makes execution faster by eliminating the function-call overhead; in
4274 addition, if any of the actual argument values are constant, their
4275 known values may permit simplifications at compile time so that not
4276 all of the inline function's code needs to be included.  The effect on
4277 code size is less predictable; object code may be larger or smaller
4278 with function inlining, depending on the particular case.  You can
4279 also direct GCC to try to integrate all ``simple enough'' functions
4280 into their callers with the option @option{-finline-functions}.
4281
4282 GCC implements three different semantics of declaring a function
4283 inline.  One is available with @option{-std=gnu89} or
4284 @option{-fgnu89-inline} or when @code{gnu_inline} attribute is present
4285 on all inline declarations, another when @option{-std=c99} or
4286 @option{-std=gnu99} (without @option{-fgnu89-inline}), and the third
4287 is used when compiling C++.
4288
4289 To declare a function inline, use the @code{inline} keyword in its
4290 declaration, like this:
4291
4292 @smallexample
4293 static inline int
4294 inc (int *a)
4295 @{
4296   (*a)++;
4297 @}
4298 @end smallexample
4299
4300 If you are writing a header file to be included in ISO C89 programs, write
4301 @code{__inline__} instead of @code{inline}.  @xref{Alternate Keywords}.
4302
4303 The three types of inlining behave similarly in two important cases:
4304 when the @code{inline} keyword is used on a @code{static} function,
4305 like the example above, and when a function is first declared without
4306 using the @code{inline} keyword and then is defined with
4307 @code{inline}, like this:
4308
4309 @smallexample
4310 extern int inc (int *a);
4311 inline int
4312 inc (int *a)
4313 @{
4314   (*a)++;
4315 @}
4316 @end smallexample
4317
4318 In both of these common cases, the program behaves the same as if you
4319 had not used the @code{inline} keyword, except for its speed.
4320
4321 @cindex inline functions, omission of
4322 @opindex fkeep-inline-functions
4323 When a function is both inline and @code{static}, if all calls to the
4324 function are integrated into the caller, and the function's address is
4325 never used, then the function's own assembler code is never referenced.
4326 In this case, GCC does not actually output assembler code for the
4327 function, unless you specify the option @option{-fkeep-inline-functions}.
4328 Some calls cannot be integrated for various reasons (in particular,
4329 calls that precede the function's definition cannot be integrated, and
4330 neither can recursive calls within the definition).  If there is a
4331 nonintegrated call, then the function is compiled to assembler code as
4332 usual.  The function must also be compiled as usual if the program
4333 refers to its address, because that can't be inlined.
4334
4335 @opindex Winline
4336 Note that certain usages in a function definition can make it unsuitable
4337 for inline substitution.  Among these usages are: use of varargs, use of
4338 alloca, use of variable sized data types (@pxref{Variable Length}),
4339 use of computed goto (@pxref{Labels as Values}), use of nonlocal goto,
4340 and nested functions (@pxref{Nested Functions}).  Using @option{-Winline}
4341 will warn when a function marked @code{inline} could not be substituted,
4342 and will give the reason for the failure.
4343
4344 @cindex automatic @code{inline} for C++ member fns
4345 @cindex @code{inline} automatic for C++ member fns
4346 @cindex member fns, automatically @code{inline}
4347 @cindex C++ member fns, automatically @code{inline}
4348 @opindex fno-default-inline
4349 As required by ISO C++, GCC considers member functions defined within
4350 the body of a class to be marked inline even if they are
4351 not explicitly declared with the @code{inline} keyword.  You can
4352 override this with @option{-fno-default-inline}; @pxref{C++ Dialect
4353 Options,,Options Controlling C++ Dialect}.
4354
4355 GCC does not inline any functions when not optimizing unless you specify
4356 the @samp{always_inline} attribute for the function, like this:
4357
4358 @smallexample
4359 /* @r{Prototype.}  */
4360 inline void foo (const char) __attribute__((always_inline));
4361 @end smallexample
4362
4363 The remainder of this section is specific to GNU C89 inlining.
4364
4365 @cindex non-static inline function
4366 When an inline function is not @code{static}, then the compiler must assume
4367 that there may be calls from other source files; since a global symbol can
4368 be defined only once in any program, the function must not be defined in
4369 the other source files, so the calls therein cannot be integrated.
4370 Therefore, a non-@code{static} inline function is always compiled on its
4371 own in the usual fashion.
4372
4373 If you specify both @code{inline} and @code{extern} in the function
4374 definition, then the definition is used only for inlining.  In no case
4375 is the function compiled on its own, not even if you refer to its
4376 address explicitly.  Such an address becomes an external reference, as
4377 if you had only declared the function, and had not defined it.
4378
4379 This combination of @code{inline} and @code{extern} has almost the
4380 effect of a macro.  The way to use it is to put a function definition in
4381 a header file with these keywords, and put another copy of the
4382 definition (lacking @code{inline} and @code{extern}) in a library file.
4383 The definition in the header file will cause most calls to the function
4384 to be inlined.  If any uses of the function remain, they will refer to
4385 the single copy in the library.
4386
4387 @node Extended Asm
4388 @section Assembler Instructions with C Expression Operands
4389 @cindex extended @code{asm}
4390 @cindex @code{asm} expressions
4391 @cindex assembler instructions
4392 @cindex registers
4393
4394 In an assembler instruction using @code{asm}, you can specify the
4395 operands of the instruction using C expressions.  This means you need not
4396 guess which registers or memory locations will contain the data you want
4397 to use.
4398
4399 You must specify an assembler instruction template much like what
4400 appears in a machine description, plus an operand constraint string for
4401 each operand.
4402
4403 For example, here is how to use the 68881's @code{fsinx} instruction:
4404
4405 @smallexample
4406 asm ("fsinx %1,%0" : "=f" (result) : "f" (angle));
4407 @end smallexample
4408
4409 @noindent
4410 Here @code{angle} is the C expression for the input operand while
4411 @code{result} is that of the output operand.  Each has @samp{"f"} as its
4412 operand constraint, saying that a floating point register is required.
4413 The @samp{=} in @samp{=f} indicates that the operand is an output; all
4414 output operands' constraints must use @samp{=}.  The constraints use the
4415 same language used in the machine description (@pxref{Constraints}).
4416
4417 Each operand is described by an operand-constraint string followed by
4418 the C expression in parentheses.  A colon separates the assembler
4419 template from the first output operand and another separates the last
4420 output operand from the first input, if any.  Commas separate the
4421 operands within each group.  The total number of operands is currently
4422 limited to 30; this limitation may be lifted in some future version of
4423 GCC@.
4424
4425 If there are no output operands but there are input operands, you must
4426 place two consecutive colons surrounding the place where the output
4427 operands would go.
4428
4429 As of GCC version 3.1, it is also possible to specify input and output
4430 operands using symbolic names which can be referenced within the
4431 assembler code.  These names are specified inside square brackets
4432 preceding the constraint string, and can be referenced inside the
4433 assembler code using @code{%[@var{name}]} instead of a percentage sign
4434 followed by the operand number.  Using named operands the above example
4435 could look like:
4436
4437 @smallexample
4438 asm ("fsinx %[angle],%[output]"
4439      : [output] "=f" (result)
4440      : [angle] "f" (angle));
4441 @end smallexample
4442
4443 @noindent
4444 Note that the symbolic operand names have no relation whatsoever to
4445 other C identifiers.  You may use any name you like, even those of
4446 existing C symbols, but you must ensure that no two operands within the same
4447 assembler construct use the same symbolic name.
4448
4449 Output operand expressions must be lvalues; the compiler can check this.
4450 The input operands need not be lvalues.  The compiler cannot check
4451 whether the operands have data types that are reasonable for the
4452 instruction being executed.  It does not parse the assembler instruction
4453 template and does not know what it means or even whether it is valid
4454 assembler input.  The extended @code{asm} feature is most often used for
4455 machine instructions the compiler itself does not know exist.  If
4456 the output expression cannot be directly addressed (for example, it is a
4457 bit-field), your constraint must allow a register.  In that case, GCC
4458 will use the register as the output of the @code{asm}, and then store
4459 that register into the output.
4460
4461 The ordinary output operands must be write-only; GCC will assume that
4462 the values in these operands before the instruction are dead and need
4463 not be generated.  Extended asm supports input-output or read-write
4464 operands.  Use the constraint character @samp{+} to indicate such an
4465 operand and list it with the output operands.  You should only use
4466 read-write operands when the constraints for the operand (or the
4467 operand in which only some of the bits are to be changed) allow a
4468 register.
4469
4470 You may, as an alternative, logically split its function into two
4471 separate operands, one input operand and one write-only output
4472 operand.  The connection between them is expressed by constraints
4473 which say they need to be in the same location when the instruction
4474 executes.  You can use the same C expression for both operands, or
4475 different expressions.  For example, here we write the (fictitious)
4476 @samp{combine} instruction with @code{bar} as its read-only source
4477 operand and @code{foo} as its read-write destination:
4478
4479 @smallexample
4480 asm ("combine %2,%0" : "=r" (foo) : "0" (foo), "g" (bar));
4481 @end smallexample
4482
4483 @noindent
4484 The constraint @samp{"0"} for operand 1 says that it must occupy the
4485 same location as operand 0.  A number in constraint is allowed only in
4486 an input operand and it must refer to an output operand.
4487
4488 Only a number in the constraint can guarantee that one operand will be in
4489 the same place as another.  The mere fact that @code{foo} is the value
4490 of both operands is not enough to guarantee that they will be in the
4491 same place in the generated assembler code.  The following would not
4492 work reliably:
4493
4494 @smallexample
4495 asm ("combine %2,%0" : "=r" (foo) : "r" (foo), "g" (bar));
4496 @end smallexample
4497
4498 Various optimizations or reloading could cause operands 0 and 1 to be in
4499 different registers; GCC knows no reason not to do so.  For example, the
4500 compiler might find a copy of the value of @code{foo} in one register and
4501 use it for operand 1, but generate the output operand 0 in a different
4502 register (copying it afterward to @code{foo}'s own address).  Of course,
4503 since the register for operand 1 is not even mentioned in the assembler
4504 code, the result will not work, but GCC can't tell that.
4505
4506 As of GCC version 3.1, one may write @code{[@var{name}]} instead of
4507 the operand number for a matching constraint.  For example:
4508
4509 @smallexample
4510 asm ("cmoveq %1,%2,%[result]"
4511      : [result] "=r"(result)
4512      : "r" (test), "r"(new), "[result]"(old));
4513 @end smallexample
4514
4515 Sometimes you need to make an @code{asm} operand be a specific register,
4516 but there's no matching constraint letter for that register @emph{by
4517 itself}.  To force the operand into that register, use a local variable
4518 for the operand and specify the register in the variable declaration.
4519 @xref{Explicit Reg Vars}.  Then for the @code{asm} operand, use any
4520 register constraint letter that matches the register:
4521
4522 @smallexample
4523 register int *p1 asm ("r0") = @dots{};
4524 register int *p2 asm ("r1") = @dots{};
4525 register int *result asm ("r0");
4526 asm ("sysint" : "=r" (result) : "0" (p1), "r" (p2));
4527 @end smallexample
4528
4529 @anchor{Example of asm with clobbered asm reg}
4530 In the above example, beware that a register that is call-clobbered by
4531 the target ABI will be overwritten by any function call in the
4532 assignment, including library calls for arithmetic operators.
4533 Assuming it is a call-clobbered register, this may happen to @code{r0}
4534 above by the assignment to @code{p2}.  If you have to use such a
4535 register, use temporary variables for expressions between the register
4536 assignment and use:
4537
4538 @smallexample
4539 int t1 = @dots{};
4540 register int *p1 asm ("r0") = @dots{};
4541 register int *p2 asm ("r1") = t1;
4542 register int *result asm ("r0");
4543 asm ("sysint" : "=r" (result) : "0" (p1), "r" (p2));
4544 @end smallexample
4545
4546 Some instructions clobber specific hard registers.  To describe this,
4547 write a third colon after the input operands, followed by the names of
4548 the clobbered hard registers (given as strings).  Here is a realistic
4549 example for the VAX:
4550
4551 @smallexample
4552 asm volatile ("movc3 %0,%1,%2"
4553               : /* @r{no outputs} */
4554               : "g" (from), "g" (to), "g" (count)
4555               : "r0", "r1", "r2", "r3", "r4", "r5");
4556 @end smallexample
4557
4558 You may not write a clobber description in a way that overlaps with an
4559 input or output operand.  For example, you may not have an operand
4560 describing a register class with one member if you mention that register
4561 in the clobber list.  Variables declared to live in specific registers
4562 (@pxref{Explicit Reg Vars}), and used as asm input or output operands must
4563 have no part mentioned in the clobber description.
4564 There is no way for you to specify that an input
4565 operand is modified without also specifying it as an output
4566 operand.  Note that if all the output operands you specify are for this
4567 purpose (and hence unused), you will then also need to specify
4568 @code{volatile} for the @code{asm} construct, as described below, to
4569 prevent GCC from deleting the @code{asm} statement as unused.
4570
4571 If you refer to a particular hardware register from the assembler code,
4572 you will probably have to list the register after the third colon to
4573 tell the compiler the register's value is modified.  In some assemblers,
4574 the register names begin with @samp{%}; to produce one @samp{%} in the
4575 assembler code, you must write @samp{%%} in the input.
4576
4577 If your assembler instruction can alter the condition code register, add
4578 @samp{cc} to the list of clobbered registers.  GCC on some machines
4579 represents the condition codes as a specific hardware register;
4580 @samp{cc} serves to name this register.  On other machines, the
4581 condition code is handled differently, and specifying @samp{cc} has no
4582 effect.  But it is valid no matter what the machine.
4583
4584 If your assembler instructions access memory in an unpredictable
4585 fashion, add @samp{memory} to the list of clobbered registers.  This
4586 will cause GCC to not keep memory values cached in registers across the
4587 assembler instruction and not optimize stores or loads to that memory.
4588 You will also want to add the @code{volatile} keyword if the memory
4589 affected is not listed in the inputs or outputs of the @code{asm}, as
4590 the @samp{memory} clobber does not count as a side-effect of the
4591 @code{asm}.  If you know how large the accessed memory is, you can add
4592 it as input or output but if this is not known, you should add
4593 @samp{memory}.  As an example, if you access ten bytes of a string, you
4594 can use a memory input like:
4595
4596 @smallexample
4597 @{"m"( (@{ struct @{ char x[10]; @} *p = (void *)ptr ; *p; @}) )@}.
4598 @end smallexample
4599
4600 Note that in the following example the memory input is necessary,
4601 otherwise GCC might optimize the store to @code{x} away:
4602 @smallexample
4603 int foo ()
4604 @{
4605   int x = 42;
4606   int *y = &x;
4607   int result;
4608   asm ("magic stuff accessing an 'int' pointed to by '%1'"
4609         "=&d" (r) : "a" (y), "m" (*y));
4610   return result;
4611 @}
4612 @end smallexample
4613
4614 You can put multiple assembler instructions together in a single
4615 @code{asm} template, separated by the characters normally used in assembly
4616 code for the system.  A combination that works in most places is a newline
4617 to break the line, plus a tab character to move to the instruction field
4618 (written as @samp{\n\t}).  Sometimes semicolons can be used, if the
4619 assembler allows semicolons as a line-breaking character.  Note that some
4620 assembler dialects use semicolons to start a comment.
4621 The input operands are guaranteed not to use any of the clobbered
4622 registers, and neither will the output operands' addresses, so you can
4623 read and write the clobbered registers as many times as you like.  Here
4624 is an example of multiple instructions in a template; it assumes the
4625 subroutine @code{_foo} accepts arguments in registers 9 and 10:
4626
4627 @smallexample
4628 asm ("movl %0,r9\n\tmovl %1,r10\n\tcall _foo"
4629      : /* no outputs */
4630      : "g" (from), "g" (to)
4631      : "r9", "r10");
4632 @end smallexample
4633
4634 Unless an output operand has the @samp{&} constraint modifier, GCC
4635 may allocate it in the same register as an unrelated input operand, on
4636 the assumption the inputs are consumed before the outputs are produced.
4637 This assumption may be false if the assembler code actually consists of
4638 more than one instruction.  In such a case, use @samp{&} for each output
4639 operand that may not overlap an input.  @xref{Modifiers}.
4640
4641 If you want to test the condition code produced by an assembler
4642 instruction, you must include a branch and a label in the @code{asm}
4643 construct, as follows:
4644
4645 @smallexample
4646 asm ("clr %0\n\tfrob %1\n\tbeq 0f\n\tmov #1,%0\n0:"
4647      : "g" (result)
4648      : "g" (input));
4649 @end smallexample
4650
4651 @noindent
4652 This assumes your assembler supports local labels, as the GNU assembler
4653 and most Unix assemblers do.
4654
4655 Speaking of labels, jumps from one @code{asm} to another are not
4656 supported.  The compiler's optimizers do not know about these jumps, and
4657 therefore they cannot take account of them when deciding how to
4658 optimize.
4659
4660 @cindex macros containing @code{asm}
4661 Usually the most convenient way to use these @code{asm} instructions is to
4662 encapsulate them in macros that look like functions.  For example,
4663
4664 @smallexample
4665 #define sin(x)       \
4666 (@{ double __value, __arg = (x);   \
4667    asm ("fsinx %1,%0": "=f" (__value): "f" (__arg));  \
4668    __value; @})
4669 @end smallexample
4670
4671 @noindent
4672 Here the variable @code{__arg} is used to make sure that the instruction
4673 operates on a proper @code{double} value, and to accept only those
4674 arguments @code{x} which can convert automatically to a @code{double}.
4675
4676 Another way to make sure the instruction operates on the correct data
4677 type is to use a cast in the @code{asm}.  This is different from using a
4678 variable @code{__arg} in that it converts more different types.  For
4679 example, if the desired type were @code{int}, casting the argument to
4680 @code{int} would accept a pointer with no complaint, while assigning the
4681 argument to an @code{int} variable named @code{__arg} would warn about
4682 using a pointer unless the caller explicitly casts it.
4683
4684 If an @code{asm} has output operands, GCC assumes for optimization
4685 purposes the instruction has no side effects except to change the output
4686 operands.  This does not mean instructions with a side effect cannot be
4687 used, but you must be careful, because the compiler may eliminate them
4688 if the output operands aren't used, or move them out of loops, or
4689 replace two with one if they constitute a common subexpression.  Also,
4690 if your instruction does have a side effect on a variable that otherwise
4691 appears not to change, the old value of the variable may be reused later
4692 if it happens to be found in a register.
4693
4694 You can prevent an @code{asm} instruction from being deleted
4695 by writing the keyword @code{volatile} after
4696 the @code{asm}.  For example:
4697
4698 @smallexample
4699 #define get_and_set_priority(new)              \
4700 (@{ int __old;                                  \
4701    asm volatile ("get_and_set_priority %0, %1" \
4702                  : "=g" (__old) : "g" (new));  \
4703    __old; @})
4704 @end smallexample
4705
4706 @noindent
4707 The @code{volatile} keyword indicates that the instruction has
4708 important side-effects.  GCC will not delete a volatile @code{asm} if
4709 it is reachable.  (The instruction can still be deleted if GCC can
4710 prove that control-flow will never reach the location of the
4711 instruction.)  Note that even a volatile @code{asm} instruction
4712 can be moved relative to other code, including across jump
4713 instructions.  For example, on many targets there is a system
4714 register which can be set to control the rounding mode of
4715 floating point operations.  You might try
4716 setting it with a volatile @code{asm}, like this PowerPC example:
4717
4718 @smallexample
4719        asm volatile("mtfsf 255,%0" : : "f" (fpenv));
4720        sum = x + y;
4721 @end smallexample
4722
4723 @noindent
4724 This will not work reliably, as the compiler may move the addition back
4725 before the volatile @code{asm}.  To make it work you need to add an
4726 artificial dependency to the @code{asm} referencing a variable in the code
4727 you don't want moved, for example:
4728
4729 @smallexample
4730     asm volatile ("mtfsf 255,%1" : "=X"(sum): "f"(fpenv));
4731     sum = x + y;
4732 @end smallexample
4733
4734 Similarly, you can't expect a
4735 sequence of volatile @code{asm} instructions to remain perfectly
4736 consecutive.  If you want consecutive output, use a single @code{asm}.
4737 Also, GCC will perform some optimizations across a volatile @code{asm}
4738 instruction; GCC does not ``forget everything'' when it encounters
4739 a volatile @code{asm} instruction the way some other compilers do.
4740
4741 An @code{asm} instruction without any output operands will be treated
4742 identically to a volatile @code{asm} instruction.
4743
4744 It is a natural idea to look for a way to give access to the condition
4745 code left by the assembler instruction.  However, when we attempted to
4746 implement this, we found no way to make it work reliably.  The problem
4747 is that output operands might need reloading, which would result in
4748 additional following ``store'' instructions.  On most machines, these
4749 instructions would alter the condition code before there was time to
4750 test it.  This problem doesn't arise for ordinary ``test'' and
4751 ``compare'' instructions because they don't have any output operands.
4752
4753 For reasons similar to those described above, it is not possible to give
4754 an assembler instruction access to the condition code left by previous
4755 instructions.
4756
4757 If you are writing a header file that should be includable in ISO C
4758 programs, write @code{__asm__} instead of @code{asm}.  @xref{Alternate
4759 Keywords}.
4760
4761 @subsection Size of an @code{asm}
4762
4763 Some targets require that GCC track the size of each instruction used in
4764 order to generate correct code.  Because the final length of an
4765 @code{asm} is only known by the assembler, GCC must make an estimate as
4766 to how big it will be.  The estimate is formed by counting the number of
4767 statements in the pattern of the @code{asm} and multiplying that by the
4768 length of the longest instruction on that processor.  Statements in the
4769 @code{asm} are identified by newline characters and whatever statement
4770 separator characters are supported by the assembler; on most processors
4771 this is the `@code{;}' character.
4772
4773 Normally, GCC's estimate is perfectly adequate to ensure that correct
4774 code is generated, but it is possible to confuse the compiler if you use
4775 pseudo instructions or assembler macros that expand into multiple real
4776 instructions or if you use assembler directives that expand to more
4777 space in the object file than would be needed for a single instruction.
4778 If this happens then the assembler will produce a diagnostic saying that
4779 a label is unreachable.
4780
4781 @subsection i386 floating point asm operands
4782
4783 There are several rules on the usage of stack-like regs in
4784 asm_operands insns.  These rules apply only to the operands that are
4785 stack-like regs:
4786
4787 @enumerate
4788 @item
4789 Given a set of input regs that die in an asm_operands, it is
4790 necessary to know which are implicitly popped by the asm, and
4791 which must be explicitly popped by gcc.
4792
4793 An input reg that is implicitly popped by the asm must be
4794 explicitly clobbered, unless it is constrained to match an
4795 output operand.
4796
4797 @item
4798 For any input reg that is implicitly popped by an asm, it is
4799 necessary to know how to adjust the stack to compensate for the pop.
4800 If any non-popped input is closer to the top of the reg-stack than
4801 the implicitly popped reg, it would not be possible to know what the
4802 stack looked like---it's not clear how the rest of the stack ``slides
4803 up''.
4804
4805 All implicitly popped input regs must be closer to the top of
4806 the reg-stack than any input that is not implicitly popped.
4807
4808 It is possible that if an input dies in an insn, reload might
4809 use the input reg for an output reload.  Consider this example:
4810
4811 @smallexample
4812 asm ("foo" : "=t" (a) : "f" (b));
4813 @end smallexample
4814
4815 This asm says that input B is not popped by the asm, and that
4816 the asm pushes a result onto the reg-stack, i.e., the stack is one
4817 deeper after the asm than it was before.  But, it is possible that
4818 reload will think that it can use the same reg for both the input and
4819 the output, if input B dies in this insn.
4820
4821 If any input operand uses the @code{f} constraint, all output reg
4822 constraints must use the @code{&} earlyclobber.
4823
4824 The asm above would be written as
4825
4826 @smallexample
4827 asm ("foo" : "=&t" (a) : "f" (b));
4828 @end smallexample
4829
4830 @item
4831 Some operands need to be in particular places on the stack.  All
4832 output operands fall in this category---there is no other way to
4833 know which regs the outputs appear in unless the user indicates
4834 this in the constraints.
4835
4836 Output operands must specifically indicate which reg an output
4837 appears in after an asm.  @code{=f} is not allowed: the operand
4838 constraints must select a class with a single reg.
4839
4840 @item
4841 Output operands may not be ``inserted'' between existing stack regs.
4842 Since no 387 opcode uses a read/write operand, all output operands
4843 are dead before the asm_operands, and are pushed by the asm_operands.
4844 It makes no sense to push anywhere but the top of the reg-stack.
4845
4846 Output operands must start at the top of the reg-stack: output
4847 operands may not ``skip'' a reg.
4848
4849 @item
4850 Some asm statements may need extra stack space for internal
4851 calculations.  This can be guaranteed by clobbering stack registers
4852 unrelated to the inputs and outputs.
4853
4854 @end enumerate
4855
4856 Here are a couple of reasonable asms to want to write.  This asm
4857 takes one input, which is internally popped, and produces two outputs.
4858
4859 @smallexample
4860 asm ("fsincos" : "=t" (cos), "=u" (sin) : "0" (inp));
4861 @end smallexample
4862
4863 This asm takes two inputs, which are popped by the @code{fyl2xp1} opcode,
4864 and replaces them with one output.  The user must code the @code{st(1)}
4865 clobber for reg-stack.c to know that @code{fyl2xp1} pops both inputs.
4866
4867 @smallexample
4868 asm ("fyl2xp1" : "=t" (result) : "0" (x), "u" (y) : "st(1)");
4869 @end smallexample
4870
4871 @include md.texi
4872
4873 @node Asm Labels
4874 @section Controlling Names Used in Assembler Code
4875 @cindex assembler names for identifiers
4876 @cindex names used in assembler code
4877 @cindex identifiers, names in assembler code
4878
4879 You can specify the name to be used in the assembler code for a C
4880 function or variable by writing the @code{asm} (or @code{__asm__})
4881 keyword after the declarator as follows:
4882
4883 @smallexample
4884 int foo asm ("myfoo") = 2;
4885 @end smallexample
4886
4887 @noindent
4888 This specifies that the name to be used for the variable @code{foo} in
4889 the assembler code should be @samp{myfoo} rather than the usual
4890 @samp{_foo}.
4891
4892 On systems where an underscore is normally prepended to the name of a C
4893 function or variable, this feature allows you to define names for the
4894 linker that do not start with an underscore.
4895
4896 It does not make sense to use this feature with a non-static local
4897 variable since such variables do not have assembler names.  If you are
4898 trying to put the variable in a particular register, see @ref{Explicit
4899 Reg Vars}.  GCC presently accepts such code with a warning, but will
4900 probably be changed to issue an error, rather than a warning, in the
4901 future.
4902
4903 You cannot use @code{asm} in this way in a function @emph{definition}; but
4904 you can get the same effect by writing a declaration for the function
4905 before its definition and putting @code{asm} there, like this:
4906
4907 @smallexample
4908 extern func () asm ("FUNC");
4909
4910 func (x, y)
4911      int x, y;
4912 /* @r{@dots{}} */
4913 @end smallexample
4914
4915 It is up to you to make sure that the assembler names you choose do not
4916 conflict with any other assembler symbols.  Also, you must not use a
4917 register name; that would produce completely invalid assembler code.  GCC
4918 does not as yet have the ability to store static variables in registers.
4919 Perhaps that will be added.
4920
4921 @node Explicit Reg Vars
4922 @section Variables in Specified Registers
4923 @cindex explicit register variables
4924 @cindex variables in specified registers
4925 @cindex specified registers
4926 @cindex registers, global allocation
4927
4928 GNU C allows you to put a few global variables into specified hardware
4929 registers.  You can also specify the register in which an ordinary
4930 register variable should be allocated.
4931
4932 @itemize @bullet
4933 @item
4934 Global register variables reserve registers throughout the program.
4935 This may be useful in programs such as programming language
4936 interpreters which have a couple of global variables that are accessed
4937 very often.
4938
4939 @item
4940 Local register variables in specific registers do not reserve the
4941 registers, except at the point where they are used as input or output
4942 operands in an @code{asm} statement and the @code{asm} statement itself is
4943 not deleted.  The compiler's data flow analysis is capable of determining
4944 where the specified registers contain live values, and where they are
4945 available for other uses.  Stores into local register variables may be deleted
4946 when they appear to be dead according to dataflow analysis.  References
4947 to local register variables may be deleted or moved or simplified.
4948
4949 These local variables are sometimes convenient for use with the extended
4950 @code{asm} feature (@pxref{Extended Asm}), if you want to write one
4951 output of the assembler instruction directly into a particular register.
4952 (This will work provided the register you specify fits the constraints
4953 specified for that operand in the @code{asm}.)
4954 @end itemize
4955
4956 @menu
4957 * Global Reg Vars::
4958 * Local Reg Vars::
4959 @end menu
4960
4961 @node Global Reg Vars
4962 @subsection Defining Global Register Variables
4963 @cindex global register variables
4964 @cindex registers, global variables in
4965
4966 You can define a global register variable in GNU C like this:
4967
4968 @smallexample
4969 register int *foo asm ("a5");
4970 @end smallexample
4971
4972 @noindent
4973 Here @code{a5} is the name of the register which should be used.  Choose a
4974 register which is normally saved and restored by function calls on your
4975 machine, so that library routines will not clobber it.
4976
4977 Naturally the register name is cpu-dependent, so you would need to
4978 conditionalize your program according to cpu type.  The register
4979 @code{a5} would be a good choice on a 68000 for a variable of pointer
4980 type.  On machines with register windows, be sure to choose a ``global''
4981 register that is not affected magically by the function call mechanism.
4982
4983 In addition, operating systems on one type of cpu may differ in how they
4984 name the registers; then you would need additional conditionals.  For
4985 example, some 68000 operating systems call this register @code{%a5}.
4986
4987 Eventually there may be a way of asking the compiler to choose a register
4988 automatically, but first we need to figure out how it should choose and
4989 how to enable you to guide the choice.  No solution is evident.
4990
4991 Defining a global register variable in a certain register reserves that
4992 register entirely for this use, at least within the current compilation.
4993 The register will not be allocated for any other purpose in the functions
4994 in the current compilation.  The register will not be saved and restored by
4995 these functions.  Stores into this register are never deleted even if they
4996 would appear to be dead, but references may be deleted or moved or
4997 simplified.
4998
4999 It is not safe to access the global register variables from signal
5000 handlers, or from more than one thread of control, because the system
5001 library routines may temporarily use the register for other things (unless
5002 you recompile them specially for the task at hand).
5003
5004 @cindex @code{qsort}, and global register variables
5005 It is not safe for one function that uses a global register variable to
5006 call another such function @code{foo} by way of a third function
5007 @code{lose} that was compiled without knowledge of this variable (i.e.@: in a
5008 different source file in which the variable wasn't declared).  This is
5009 because @code{lose} might save the register and put some other value there.
5010 For example, you can't expect a global register variable to be available in
5011 the comparison-function that you pass to @code{qsort}, since @code{qsort}
5012 might have put something else in that register.  (If you are prepared to
5013 recompile @code{qsort} with the same global register variable, you can
5014 solve this problem.)
5015
5016 If you want to recompile @code{qsort} or other source files which do not
5017 actually use your global register variable, so that they will not use that
5018 register for any other purpose, then it suffices to specify the compiler
5019 option @option{-ffixed-@var{reg}}.  You need not actually add a global
5020 register declaration to their source code.
5021
5022 A function which can alter the value of a global register variable cannot
5023 safely be called from a function compiled without this variable, because it
5024 could clobber the value the caller expects to find there on return.
5025 Therefore, the function which is the entry point into the part of the
5026 program that uses the global register variable must explicitly save and
5027 restore the value which belongs to its caller.
5028
5029 @cindex register variable after @code{longjmp}
5030 @cindex global register after @code{longjmp}
5031 @cindex value after @code{longjmp}
5032 @findex longjmp
5033 @findex setjmp
5034 On most machines, @code{longjmp} will restore to each global register
5035 variable the value it had at the time of the @code{setjmp}.  On some
5036 machines, however, @code{longjmp} will not change the value of global
5037 register variables.  To be portable, the function that called @code{setjmp}
5038 should make other arrangements to save the values of the global register
5039 variables, and to restore them in a @code{longjmp}.  This way, the same
5040 thing will happen regardless of what @code{longjmp} does.
5041
5042 All global register variable declarations must precede all function
5043 definitions.  If such a declaration could appear after function
5044 definitions, the declaration would be too late to prevent the register from
5045 being used for other purposes in the preceding functions.
5046
5047 Global register variables may not have initial values, because an
5048 executable file has no means to supply initial contents for a register.
5049
5050 On the SPARC, there are reports that g3 @dots{} g7 are suitable
5051 registers, but certain library functions, such as @code{getwd}, as well
5052 as the subroutines for division and remainder, modify g3 and g4.  g1 and
5053 g2 are local temporaries.
5054
5055 On the 68000, a2 @dots{} a5 should be suitable, as should d2 @dots{} d7.
5056 Of course, it will not do to use more than a few of those.
5057
5058 @node Local Reg Vars
5059 @subsection Specifying Registers for Local Variables
5060 @cindex local variables, specifying registers
5061 @cindex specifying registers for local variables
5062 @cindex registers for local variables
5063
5064 You can define a local register variable with a specified register
5065 like this:
5066
5067 @smallexample
5068 register int *foo asm ("a5");
5069 @end smallexample
5070
5071 @noindent
5072 Here @code{a5} is the name of the register which should be used.  Note
5073 that this is the same syntax used for defining global register
5074 variables, but for a local variable it would appear within a function.
5075
5076 Naturally the register name is cpu-dependent, but this is not a
5077 problem, since specific registers are most often useful with explicit
5078 assembler instructions (@pxref{Extended Asm}).  Both of these things
5079 generally require that you conditionalize your program according to
5080 cpu type.
5081
5082 In addition, operating systems on one type of cpu may differ in how they
5083 name the registers; then you would need additional conditionals.  For
5084 example, some 68000 operating systems call this register @code{%a5}.
5085
5086 Defining such a register variable does not reserve the register; it
5087 remains available for other uses in places where flow control determines
5088 the variable's value is not live.
5089
5090 This option does not guarantee that GCC will generate code that has
5091 this variable in the register you specify at all times.  You may not
5092 code an explicit reference to this register in the @emph{assembler
5093 instruction template} part of an @code{asm} statement and assume it will
5094 always refer to this variable.  However, using the variable as an
5095 @code{asm} @emph{operand} guarantees that the specified register is used
5096 for the operand.
5097
5098 Stores into local register variables may be deleted when they appear to be dead
5099 according to dataflow analysis.  References to local register variables may
5100 be deleted or moved or simplified.
5101
5102 As for global register variables, it's recommended that you choose a
5103 register which is normally saved and restored by function calls on
5104 your machine, so that library routines will not clobber it.  A common
5105 pitfall is to initialize multiple call-clobbered registers with
5106 arbitrary expressions, where a function call or library call for an
5107 arithmetic operator will overwrite a register value from a previous
5108 assignment, for example @code{r0} below:
5109 @smallexample
5110 register int *p1 asm ("r0") = @dots{};
5111 register int *p2 asm ("r1") = @dots{};
5112 @end smallexample
5113 In those cases, a solution is to use a temporary variable for
5114 each arbitrary expression.   @xref{Example of asm with clobbered asm reg}.
5115
5116 @node Alternate Keywords
5117 @section Alternate Keywords
5118 @cindex alternate keywords
5119 @cindex keywords, alternate
5120
5121 @option{-ansi} and the various @option{-std} options disable certain
5122 keywords.  This causes trouble when you want to use GNU C extensions, or
5123 a general-purpose header file that should be usable by all programs,
5124 including ISO C programs.  The keywords @code{asm}, @code{typeof} and
5125 @code{inline} are not available in programs compiled with
5126 @option{-ansi} or @option{-std} (although @code{inline} can be used in a
5127 program compiled with @option{-std=c99}).  The ISO C99 keyword
5128 @code{restrict} is only available when @option{-std=gnu99} (which will
5129 eventually be the default) or @option{-std=c99} (or the equivalent
5130 @option{-std=iso9899:1999}) is used.
5131
5132 The way to solve these problems is to put @samp{__} at the beginning and
5133 end of each problematical keyword.  For example, use @code{__asm__}
5134 instead of @code{asm}, and @code{__inline__} instead of @code{inline}.
5135
5136 Other C compilers won't accept these alternative keywords; if you want to
5137 compile with another compiler, you can define the alternate keywords as
5138 macros to replace them with the customary keywords.  It looks like this:
5139
5140 @smallexample
5141 #ifndef __GNUC__
5142 #define __asm__ asm
5143 #endif
5144 @end smallexample
5145
5146 @findex __extension__
5147 @opindex pedantic
5148 @option{-pedantic} and other options cause warnings for many GNU C extensions.
5149 You can
5150 prevent such warnings within one expression by writing
5151 @code{__extension__} before the expression.  @code{__extension__} has no
5152 effect aside from this.
5153
5154 @node Incomplete Enums
5155 @section Incomplete @code{enum} Types
5156
5157 You can define an @code{enum} tag without specifying its possible values.
5158 This results in an incomplete type, much like what you get if you write
5159 @code{struct foo} without describing the elements.  A later declaration
5160 which does specify the possible values completes the type.
5161
5162 You can't allocate variables or storage using the type while it is
5163 incomplete.  However, you can work with pointers to that type.
5164
5165 This extension may not be very useful, but it makes the handling of
5166 @code{enum} more consistent with the way @code{struct} and @code{union}
5167 are handled.
5168
5169 This extension is not supported by GNU C++.
5170
5171 @node Function Names
5172 @section Function Names as Strings
5173 @cindex @code{__func__} identifier
5174 @cindex @code{__FUNCTION__} identifier
5175 @cindex @code{__PRETTY_FUNCTION__} identifier
5176
5177 GCC provides three magic variables which hold the name of the current
5178 function, as a string.  The first of these is @code{__func__}, which
5179 is part of the C99 standard:
5180
5181 @display
5182 The identifier @code{__func__} is implicitly declared by the translator
5183 as if, immediately following the opening brace of each function
5184 definition, the declaration
5185
5186 @smallexample
5187 static const char __func__[] = "function-name";
5188 @end smallexample
5189
5190 appeared, where function-name is the name of the lexically-enclosing
5191 function.  This name is the unadorned name of the function.
5192 @end display
5193
5194 @code{__FUNCTION__} is another name for @code{__func__}.  Older
5195 versions of GCC recognize only this name.  However, it is not
5196 standardized.  For maximum portability, we recommend you use
5197 @code{__func__}, but provide a fallback definition with the
5198 preprocessor:
5199
5200 @smallexample
5201 #if __STDC_VERSION__ < 199901L
5202 # if __GNUC__ >= 2
5203 #  define __func__ __FUNCTION__
5204 # else
5205 #  define __func__ "<unknown>"
5206 # endif
5207 #endif
5208 @end smallexample
5209
5210 In C, @code{__PRETTY_FUNCTION__} is yet another name for
5211 @code{__func__}.  However, in C++, @code{__PRETTY_FUNCTION__} contains
5212 the type signature of the function as well as its bare name.  For
5213 example, this program:
5214
5215 @smallexample
5216 extern "C" @{
5217 extern int printf (char *, ...);
5218 @}
5219
5220 class a @{
5221  public:
5222   void sub (int i)
5223     @{
5224       printf ("__FUNCTION__ = %s\n", __FUNCTION__);
5225       printf ("__PRETTY_FUNCTION__ = %s\n", __PRETTY_FUNCTION__);
5226     @}
5227 @};
5228
5229 int
5230 main (void)
5231 @{
5232   a ax;
5233   ax.sub (0);
5234   return 0;
5235 @}
5236 @end smallexample
5237
5238 @noindent
5239 gives this output:
5240
5241 @smallexample
5242 __FUNCTION__ = sub
5243 __PRETTY_FUNCTION__ = void a::sub(int)
5244 @end smallexample
5245
5246 These identifiers are not preprocessor macros.  In GCC 3.3 and
5247 earlier, in C only, @code{__FUNCTION__} and @code{__PRETTY_FUNCTION__}
5248 were treated as string literals; they could be used to initialize
5249 @code{char} arrays, and they could be concatenated with other string
5250 literals.  GCC 3.4 and later treat them as variables, like
5251 @code{__func__}.  In C++, @code{__FUNCTION__} and
5252 @code{__PRETTY_FUNCTION__} have always been variables.
5253
5254 @node Return Address
5255 @section Getting the Return or Frame Address of a Function
5256
5257 These functions may be used to get information about the callers of a
5258 function.
5259
5260 @deftypefn {Built-in Function} {void *} __builtin_return_address (unsigned int @var{level})
5261 This function returns the return address of the current function, or of
5262 one of its callers.  The @var{level} argument is number of frames to
5263 scan up the call stack.  A value of @code{0} yields the return address
5264 of the current function, a value of @code{1} yields the return address
5265 of the caller of the current function, and so forth.  When inlining
5266 the expected behavior is that the function will return the address of
5267 the function that will be returned to.  To work around this behavior use
5268 the @code{noinline} function attribute.
5269
5270 The @var{level} argument must be a constant integer.
5271
5272 On some machines it may be impossible to determine the return address of
5273 any function other than the current one; in such cases, or when the top
5274 of the stack has been reached, this function will return @code{0} or a
5275 random value.  In addition, @code{__builtin_frame_address} may be used
5276 to determine if the top of the stack has been reached.
5277
5278 This function should only be used with a nonzero argument for debugging
5279 purposes.
5280 @end deftypefn
5281
5282 @deftypefn {Built-in Function} {void *} __builtin_frame_address (unsigned int @var{level})
5283 This function is similar to @code{__builtin_return_address}, but it
5284 returns the address of the function frame rather than the return address
5285 of the function.  Calling @code{__builtin_frame_address} with a value of
5286 @code{0} yields the frame address of the current function, a value of
5287 @code{1} yields the frame address of the caller of the current function,
5288 and so forth.
5289
5290 The frame is the area on the stack which holds local variables and saved
5291 registers.  The frame address is normally the address of the first word
5292 pushed on to the stack by the function.  However, the exact definition
5293 depends upon the processor and the calling convention.  If the processor
5294 has a dedicated frame pointer register, and the function has a frame,
5295 then @code{__builtin_frame_address} will return the value of the frame
5296 pointer register.
5297
5298 On some machines it may be impossible to determine the frame address of
5299 any function other than the current one; in such cases, or when the top
5300 of the stack has been reached, this function will return @code{0} if
5301 the first frame pointer is properly initialized by the startup code.
5302
5303 This function should only be used with a nonzero argument for debugging
5304 purposes.
5305 @end deftypefn
5306
5307 @node Vector Extensions
5308 @section Using vector instructions through built-in functions
5309
5310 On some targets, the instruction set contains SIMD vector instructions that
5311 operate on multiple values contained in one large register at the same time.
5312 For example, on the i386 the MMX, 3Dnow! and SSE extensions can be used
5313 this way.
5314
5315 The first step in using these extensions is to provide the necessary data
5316 types.  This should be done using an appropriate @code{typedef}:
5317
5318 @smallexample
5319 typedef int v4si __attribute__ ((vector_size (16)));
5320 @end smallexample
5321
5322 The @code{int} type specifies the base type, while the attribute specifies
5323 the vector size for the variable, measured in bytes.  For example, the
5324 declaration above causes the compiler to set the mode for the @code{v4si}
5325 type to be 16 bytes wide and divided into @code{int} sized units.  For
5326 a 32-bit @code{int} this means a vector of 4 units of 4 bytes, and the
5327 corresponding mode of @code{foo} will be @acronym{V4SI}.
5328
5329 The @code{vector_size} attribute is only applicable to integral and
5330 float scalars, although arrays, pointers, and function return values
5331 are allowed in conjunction with this construct.
5332
5333 All the basic integer types can be used as base types, both as signed
5334 and as unsigned: @code{char}, @code{short}, @code{int}, @code{long},
5335 @code{long long}.  In addition, @code{float} and @code{double} can be
5336 used to build floating-point vector types.
5337
5338 Specifying a combination that is not valid for the current architecture
5339 will cause GCC to synthesize the instructions using a narrower mode.
5340 For example, if you specify a variable of type @code{V4SI} and your
5341 architecture does not allow for this specific SIMD type, GCC will
5342 produce code that uses 4 @code{SIs}.
5343
5344 The types defined in this manner can be used with a subset of normal C
5345 operations.  Currently, GCC will allow using the following operators
5346 on these types: @code{+, -, *, /, unary minus, ^, |, &, ~}@.
5347
5348 The operations behave like C++ @code{valarrays}.  Addition is defined as
5349 the addition of the corresponding elements of the operands.  For
5350 example, in the code below, each of the 4 elements in @var{a} will be
5351 added to the corresponding 4 elements in @var{b} and the resulting
5352 vector will be stored in @var{c}.
5353
5354 @smallexample
5355 typedef int v4si __attribute__ ((vector_size (16)));
5356
5357 v4si a, b, c;
5358
5359 c = a + b;
5360 @end smallexample
5361
5362 Subtraction, multiplication, division, and the logical operations
5363 operate in a similar manner.  Likewise, the result of using the unary
5364 minus or complement operators on a vector type is a vector whose
5365 elements are the negative or complemented values of the corresponding
5366 elements in the operand.
5367
5368 You can declare variables and use them in function calls and returns, as
5369 well as in assignments and some casts.  You can specify a vector type as
5370 a return type for a function.  Vector types can also be used as function
5371 arguments.  It is possible to cast from one vector type to another,
5372 provided they are of the same size (in fact, you can also cast vectors
5373 to and from other datatypes of the same size).
5374
5375 You cannot operate between vectors of different lengths or different
5376 signedness without a cast.
5377
5378 A port that supports hardware vector operations, usually provides a set
5379 of built-in functions that can be used to operate on vectors.  For
5380 example, a function to add two vectors and multiply the result by a
5381 third could look like this:
5382
5383 @smallexample
5384 v4si f (v4si a, v4si b, v4si c)
5385 @{
5386   v4si tmp = __builtin_addv4si (a, b);
5387   return __builtin_mulv4si (tmp, c);
5388 @}
5389
5390 @end smallexample
5391
5392 @node Offsetof
5393 @section Offsetof
5394 @findex __builtin_offsetof
5395
5396 GCC implements for both C and C++ a syntactic extension to implement
5397 the @code{offsetof} macro.
5398
5399 @smallexample
5400 primary:
5401         "__builtin_offsetof" "(" @code{typename} "," offsetof_member_designator ")"
5402
5403 offsetof_member_designator:
5404           @code{identifier}
5405         | offsetof_member_designator "." @code{identifier}
5406         | offsetof_member_designator "[" @code{expr} "]"
5407 @end smallexample
5408
5409 This extension is sufficient such that
5410
5411 @smallexample
5412 #define offsetof(@var{type}, @var{member})  __builtin_offsetof (@var{type}, @var{member})
5413 @end smallexample
5414
5415 is a suitable definition of the @code{offsetof} macro.  In C++, @var{type}
5416 may be dependent.  In either case, @var{member} may consist of a single
5417 identifier, or a sequence of member accesses and array references.
5418
5419 @node Atomic Builtins
5420 @section Built-in functions for atomic memory access
5421
5422 The following builtins are intended to be compatible with those described
5423 in the @cite{Intel Itanium Processor-specific Application Binary Interface},
5424 section 7.4.  As such, they depart from the normal GCC practice of using
5425 the ``__builtin_'' prefix, and further that they are overloaded such that
5426 they work on multiple types.
5427
5428 The definition given in the Intel documentation allows only for the use of
5429 the types @code{int}, @code{long}, @code{long long} as well as their unsigned
5430 counterparts.  GCC will allow any integral scalar or pointer type that is
5431 1, 2, 4 or 8 bytes in length.
5432
5433 Not all operations are supported by all target processors.  If a particular
5434 operation cannot be implemented on the target processor, a warning will be
5435 generated and a call an external function will be generated.  The external
5436 function will carry the same name as the builtin, with an additional suffix
5437 @samp{_@var{n}} where @var{n} is the size of the data type.
5438
5439 @c ??? Should we have a mechanism to suppress this warning?  This is almost
5440 @c useful for implementing the operation under the control of an external
5441 @c mutex.
5442
5443 In most cases, these builtins are considered a @dfn{full barrier}.  That is,
5444 no memory operand will be moved across the operation, either forward or
5445 backward.  Further, instructions will be issued as necessary to prevent the
5446 processor from speculating loads across the operation and from queuing stores
5447 after the operation.
5448
5449 All of the routines are are described in the Intel documentation to take
5450 ``an optional list of variables protected by the memory barrier''.  It's
5451 not clear what is meant by that; it could mean that @emph{only} the
5452 following variables are protected, or it could mean that these variables
5453 should in addition be protected.  At present GCC ignores this list and
5454 protects all variables which are globally accessible.  If in the future
5455 we make some use of this list, an empty list will continue to mean all
5456 globally accessible variables.
5457
5458 @table @code
5459 @item @var{type} __sync_fetch_and_add (@var{type} *ptr, @var{type} value, ...)
5460 @itemx @var{type} __sync_fetch_and_sub (@var{type} *ptr, @var{type} value, ...)
5461 @itemx @var{type} __sync_fetch_and_or (@var{type} *ptr, @var{type} value, ...)
5462 @itemx @var{type} __sync_fetch_and_and (@var{type} *ptr, @var{type} value, ...)
5463 @itemx @var{type} __sync_fetch_and_xor (@var{type} *ptr, @var{type} value, ...)
5464 @itemx @var{type} __sync_fetch_and_nand (@var{type} *ptr, @var{type} value, ...)
5465 @findex __sync_fetch_and_add
5466 @findex __sync_fetch_and_sub
5467 @findex __sync_fetch_and_or
5468 @findex __sync_fetch_and_and
5469 @findex __sync_fetch_and_xor
5470 @findex __sync_fetch_and_nand
5471 These builtins perform the operation suggested by the name, and
5472 returns the value that had previously been in memory.  That is,
5473
5474 @smallexample
5475 @{ tmp = *ptr; *ptr @var{op}= value; return tmp; @}
5476 @{ tmp = *ptr; *ptr = ~tmp & value; return tmp; @}   // nand
5477 @end smallexample
5478
5479 @item @var{type} __sync_add_and_fetch (@var{type} *ptr, @var{type} value, ...)
5480 @itemx @var{type} __sync_sub_and_fetch (@var{type} *ptr, @var{type} value, ...)
5481 @itemx @var{type} __sync_or_and_fetch (@var{type} *ptr, @var{type} value, ...)
5482 @itemx @var{type} __sync_and_and_fetch (@var{type} *ptr, @var{type} value, ...)
5483 @itemx @var{type} __sync_xor_and_fetch (@var{type} *ptr, @var{type} value, ...)
5484 @itemx @var{type} __sync_nand_and_fetch (@var{type} *ptr, @var{type} value, ...)
5485 @findex __sync_add_and_fetch
5486 @findex __sync_sub_and_fetch
5487 @findex __sync_or_and_fetch
5488 @findex __sync_and_and_fetch
5489 @findex __sync_xor_and_fetch
5490 @findex __sync_nand_and_fetch
5491 These builtins perform the operation suggested by the name, and
5492 return the new value.  That is,
5493
5494 @smallexample
5495 @{ *ptr @var{op}= value; return *ptr; @}
5496 @{ *ptr = ~*ptr & value; return *ptr; @}   // nand
5497 @end smallexample
5498
5499 @item bool __sync_bool_compare_and_swap (@var{type} *ptr, @var{type} oldval @var{type} newval, ...)
5500 @itemx @var{type} __sync_val_compare_and_swap (@var{type} *ptr, @var{type} oldval @var{type} newval, ...)
5501 @findex __sync_bool_compare_and_swap
5502 @findex __sync_val_compare_and_swap
5503 These builtins perform an atomic compare and swap.  That is, if the current
5504 value of @code{*@var{ptr}} is @var{oldval}, then write @var{newval} into
5505 @code{*@var{ptr}}.
5506
5507 The ``bool'' version returns true if the comparison is successful and
5508 @var{newval} was written.  The ``val'' version returns the contents
5509 of @code{*@var{ptr}} before the operation.
5510
5511 @item __sync_synchronize (...)
5512 @findex __sync_synchronize
5513 This builtin issues a full memory barrier.
5514
5515 @item @var{type} __sync_lock_test_and_set (@var{type} *ptr, @var{type} value, ...)
5516 @findex __sync_lock_test_and_set
5517 This builtin, as described by Intel, is not a traditional test-and-set
5518 operation, but rather an atomic exchange operation.  It writes @var{value}
5519 into @code{*@var{ptr}}, and returns the previous contents of
5520 @code{*@var{ptr}}.
5521
5522 Many targets have only minimal support for such locks, and do not support
5523 a full exchange operation.  In this case, a target may support reduced
5524 functionality here by which the @emph{only} valid value to store is the
5525 immediate constant 1.  The exact value actually stored in @code{*@var{ptr}}
5526 is implementation defined.
5527
5528 This builtin is not a full barrier, but rather an @dfn{acquire barrier}.
5529 This means that references after the builtin cannot move to (or be
5530 speculated to) before the builtin, but previous memory stores may not
5531 be globally visible yet, and previous memory loads may not yet be
5532 satisfied.
5533
5534 @item void __sync_lock_release (@var{type} *ptr, ...)
5535 @findex __sync_lock_release
5536 This builtin releases the lock acquired by @code{__sync_lock_test_and_set}.
5537 Normally this means writing the constant 0 to @code{*@var{ptr}}.
5538
5539 This builtin is not a full barrier, but rather a @dfn{release barrier}.
5540 This means that all previous memory stores are globally visible, and all
5541 previous memory loads have been satisfied, but following memory reads
5542 are not prevented from being speculated to before the barrier.
5543 @end table
5544
5545 @node Object Size Checking
5546 @section Object Size Checking Builtins
5547 @findex __builtin_object_size
5548 @findex __builtin___memcpy_chk
5549 @findex __builtin___mempcpy_chk
5550 @findex __builtin___memmove_chk
5551 @findex __builtin___memset_chk
5552 @findex __builtin___strcpy_chk
5553 @findex __builtin___stpcpy_chk
5554 @findex __builtin___strncpy_chk
5555 @findex __builtin___strcat_chk
5556 @findex __builtin___strncat_chk
5557 @findex __builtin___sprintf_chk
5558 @findex __builtin___snprintf_chk
5559 @findex __builtin___vsprintf_chk
5560 @findex __builtin___vsnprintf_chk
5561 @findex __builtin___printf_chk
5562 @findex __builtin___vprintf_chk
5563 @findex __builtin___fprintf_chk
5564 @findex __builtin___vfprintf_chk
5565
5566 GCC implements a limited buffer overflow protection mechanism
5567 that can prevent some buffer overflow attacks.
5568
5569 @deftypefn {Built-in Function} {size_t} __builtin_object_size (void * @var{ptr}, int @var{type})
5570 is a built-in construct that returns a constant number of bytes from
5571 @var{ptr} to the end of the object @var{ptr} pointer points to
5572 (if known at compile time).  @code{__builtin_object_size} never evaluates
5573 its arguments for side-effects.  If there are any side-effects in them, it
5574 returns @code{(size_t) -1} for @var{type} 0 or 1 and @code{(size_t) 0}
5575 for @var{type} 2 or 3.  If there are multiple objects @var{ptr} can
5576 point to and all of them are known at compile time, the returned number
5577 is the maximum of remaining byte counts in those objects if @var{type} & 2 is
5578 0 and minimum if nonzero.  If it is not possible to determine which objects
5579 @var{ptr} points to at compile time, @code{__builtin_object_size} should
5580 return @code{(size_t) -1} for @var{type} 0 or 1 and @code{(size_t) 0}
5581 for @var{type} 2 or 3.
5582
5583 @var{type} is an integer constant from 0 to 3.  If the least significant
5584 bit is clear, objects are whole variables, if it is set, a closest
5585 surrounding subobject is considered the object a pointer points to.
5586 The second bit determines if maximum or minimum of remaining bytes
5587 is computed.
5588
5589 @smallexample
5590 struct V @{ char buf1[10]; int b; char buf2[10]; @} var;
5591 char *p = &var.buf1[1], *q = &var.b;
5592
5593 /* Here the object p points to is var.  */
5594 assert (__builtin_object_size (p, 0) == sizeof (var) - 1);
5595 /* The subobject p points to is var.buf1.  */
5596 assert (__builtin_object_size (p, 1) == sizeof (var.buf1) - 1);
5597 /* The object q points to is var.  */
5598 assert (__builtin_object_size (q, 0)
5599         == (char *) (&var + 1) - (char *) &var.b);
5600 /* The subobject q points to is var.b.  */
5601 assert (__builtin_object_size (q, 1) == sizeof (var.b));
5602 @end smallexample
5603 @end deftypefn
5604
5605 There are built-in functions added for many common string operation
5606 functions, e.g. for @code{memcpy} @code{__builtin___memcpy_chk}
5607 built-in is provided.  This built-in has an additional last argument,
5608 which is the number of bytes remaining in object the @var{dest}
5609 argument points to or @code{(size_t) -1} if the size is not known.
5610
5611 The built-in functions are optimized into the normal string functions
5612 like @code{memcpy} if the last argument is @code{(size_t) -1} or if
5613 it is known at compile time that the destination object will not
5614 be overflown.  If the compiler can determine at compile time the
5615 object will be always overflown, it issues a warning.
5616
5617 The intended use can be e.g.
5618
5619 @smallexample
5620 #undef memcpy
5621 #define bos0(dest) __builtin_object_size (dest, 0)
5622 #define memcpy(dest, src, n) \
5623   __builtin___memcpy_chk (dest, src, n, bos0 (dest))
5624
5625 char *volatile p;
5626 char buf[10];
5627 /* It is unknown what object p points to, so this is optimized
5628    into plain memcpy - no checking is possible.  */
5629 memcpy (p, "abcde", n);
5630 /* Destination is known and length too.  It is known at compile
5631    time there will be no overflow.  */
5632 memcpy (&buf[5], "abcde", 5);
5633 /* Destination is known, but the length is not known at compile time.
5634    This will result in __memcpy_chk call that can check for overflow
5635    at runtime.  */
5636 memcpy (&buf[5], "abcde", n);
5637 /* Destination is known and it is known at compile time there will
5638    be overflow.  There will be a warning and __memcpy_chk call that
5639    will abort the program at runtime.  */
5640 memcpy (&buf[6], "abcde", 5);
5641 @end smallexample
5642
5643 Such built-in functions are provided for @code{memcpy}, @code{mempcpy},
5644 @code{memmove}, @code{memset}, @code{strcpy}, @code{stpcpy}, @code{strncpy},
5645 @code{strcat} and @code{strncat}.
5646
5647 There are also checking built-in functions for formatted output functions.
5648 @smallexample
5649 int __builtin___sprintf_chk (char *s, int flag, size_t os, const char *fmt, ...);
5650 int __builtin___snprintf_chk (char *s, size_t maxlen, int flag, size_t os,
5651                               const char *fmt, ...);
5652 int __builtin___vsprintf_chk (char *s, int flag, size_t os, const char *fmt,
5653                               va_list ap);
5654 int __builtin___vsnprintf_chk (char *s, size_t maxlen, int flag, size_t os,
5655                                const char *fmt, va_list ap);
5656 @end smallexample
5657
5658 The added @var{flag} argument is passed unchanged to @code{__sprintf_chk}
5659 etc. functions and can contain implementation specific flags on what
5660 additional security measures the checking function might take, such as
5661 handling @code{%n} differently.
5662
5663 The @var{os} argument is the object size @var{s} points to, like in the
5664 other built-in functions.  There is a small difference in the behavior
5665 though, if @var{os} is @code{(size_t) -1}, the built-in functions are
5666 optimized into the non-checking functions only if @var{flag} is 0, otherwise
5667 the checking function is called with @var{os} argument set to
5668 @code{(size_t) -1}.
5669
5670 In addition to this, there are checking built-in functions
5671 @code{__builtin___printf_chk}, @code{__builtin___vprintf_chk},
5672 @code{__builtin___fprintf_chk} and @code{__builtin___vfprintf_chk}.
5673 These have just one additional argument, @var{flag}, right before
5674 format string @var{fmt}.  If the compiler is able to optimize them to
5675 @code{fputc} etc. functions, it will, otherwise the checking function
5676 should be called and the @var{flag} argument passed to it.
5677
5678 @node Other Builtins
5679 @section Other built-in functions provided by GCC
5680 @cindex built-in functions
5681 @findex __builtin_isfinite
5682 @findex __builtin_isnormal
5683 @findex __builtin_isgreater
5684 @findex __builtin_isgreaterequal
5685 @findex __builtin_isless
5686 @findex __builtin_islessequal
5687 @findex __builtin_islessgreater
5688 @findex __builtin_isunordered
5689 @findex __builtin_powi
5690 @findex __builtin_powif
5691 @findex __builtin_powil
5692 @findex _Exit
5693 @findex _exit
5694 @findex abort
5695 @findex abs
5696 @findex acos
5697 @findex acosf
5698 @findex acosh
5699 @findex acoshf
5700 @findex acoshl
5701 @findex acosl
5702 @findex alloca
5703 @findex asin
5704 @findex asinf
5705 @findex asinh
5706 @findex asinhf
5707 @findex asinhl
5708 @findex asinl
5709 @findex atan
5710 @findex atan2
5711 @findex atan2f
5712 @findex atan2l
5713 @findex atanf
5714 @findex atanh
5715 @findex atanhf
5716 @findex atanhl
5717 @findex atanl
5718 @findex bcmp
5719 @findex bzero
5720 @findex cabs
5721 @findex cabsf
5722 @findex cabsl
5723 @findex cacos
5724 @findex cacosf
5725 @findex cacosh
5726 @findex cacoshf
5727 @findex cacoshl
5728 @findex cacosl
5729 @findex calloc
5730 @findex carg
5731 @findex cargf
5732 @findex cargl
5733 @findex casin
5734 @findex casinf
5735 @findex casinh
5736 @findex casinhf
5737 @findex casinhl
5738 @findex casinl
5739 @findex catan
5740 @findex catanf
5741 @findex catanh
5742 @findex catanhf
5743 @findex catanhl
5744 @findex catanl
5745 @findex cbrt
5746 @findex cbrtf
5747 @findex cbrtl
5748 @findex ccos
5749 @findex ccosf
5750 @findex ccosh
5751 @findex ccoshf
5752 @findex ccoshl
5753 @findex ccosl
5754 @findex ceil
5755 @findex ceilf
5756 @findex ceill
5757 @findex cexp
5758 @findex cexpf
5759 @findex cexpl
5760 @findex cimag
5761 @findex cimagf
5762 @findex cimagl
5763 @findex clog
5764 @findex clogf
5765 @findex clogl
5766 @findex conj
5767 @findex conjf
5768 @findex conjl
5769 @findex copysign
5770 @findex copysignf
5771 @findex copysignl
5772 @findex cos
5773 @findex cosf
5774 @findex cosh
5775 @findex coshf
5776 @findex coshl
5777 @findex cosl
5778 @findex cpow
5779 @findex cpowf
5780 @findex cpowl
5781 @findex cproj
5782 @findex cprojf
5783 @findex cprojl
5784 @findex creal
5785 @findex crealf
5786 @findex creall
5787 @findex csin
5788 @findex csinf
5789 @findex csinh
5790 @findex csinhf
5791 @findex csinhl
5792 @findex csinl
5793 @findex csqrt
5794 @findex csqrtf
5795 @findex csqrtl
5796 @findex ctan
5797 @findex ctanf
5798 @findex ctanh
5799 @findex ctanhf
5800 @findex ctanhl
5801 @findex ctanl
5802 @findex dcgettext
5803 @findex dgettext
5804 @findex drem
5805 @findex dremf
5806 @findex dreml
5807 @findex erf
5808 @findex erfc
5809 @findex erfcf
5810 @findex erfcl
5811 @findex erff
5812 @findex erfl
5813 @findex exit
5814 @findex exp
5815 @findex exp10
5816 @findex exp10f
5817 @findex exp10l
5818 @findex exp2
5819 @findex exp2f
5820 @findex exp2l
5821 @findex expf
5822 @findex expl
5823 @findex expm1
5824 @findex expm1f
5825 @findex expm1l
5826 @findex fabs
5827 @findex fabsf
5828 @findex fabsl
5829 @findex fdim
5830 @findex fdimf
5831 @findex fdiml
5832 @findex ffs
5833 @findex floor
5834 @findex floorf
5835 @findex floorl
5836 @findex fma
5837 @findex fmaf
5838 @findex fmal
5839 @findex fmax
5840 @findex fmaxf
5841 @findex fmaxl
5842 @findex fmin
5843 @findex fminf
5844 @findex fminl
5845 @findex fmod
5846 @findex fmodf
5847 @findex fmodl
5848 @findex fprintf
5849 @findex fprintf_unlocked
5850 @findex fputs
5851 @findex fputs_unlocked
5852 @findex frexp
5853 @findex frexpf
5854 @findex frexpl
5855 @findex fscanf
5856 @findex gamma
5857 @findex gammaf
5858 @findex gammal
5859 @findex gamma_r
5860 @findex gammaf_r
5861 @findex gammal_r
5862 @findex gettext
5863 @findex hypot
5864 @findex hypotf
5865 @findex hypotl
5866 @findex ilogb
5867 @findex ilogbf
5868 @findex ilogbl
5869 @findex imaxabs
5870 @findex index
5871 @findex isalnum
5872 @findex isalpha
5873 @findex isascii
5874 @findex isblank
5875 @findex iscntrl
5876 @findex isdigit
5877 @findex isgraph
5878 @findex islower
5879 @findex isprint
5880 @findex ispunct
5881 @findex isspace
5882 @findex isupper
5883 @findex iswalnum
5884 @findex iswalpha
5885 @findex iswblank
5886 @findex iswcntrl
5887 @findex iswdigit
5888 @findex iswgraph
5889 @findex iswlower
5890 @findex iswprint
5891 @findex iswpunct
5892 @findex iswspace
5893 @findex iswupper
5894 @findex iswxdigit
5895 @findex isxdigit
5896 @findex j0
5897 @findex j0f
5898 @findex j0l
5899 @findex j1
5900 @findex j1f
5901 @findex j1l
5902 @findex jn
5903 @findex jnf
5904 @findex jnl
5905 @findex labs
5906 @findex ldexp
5907 @findex ldexpf
5908 @findex ldexpl
5909 @findex lgamma
5910 @findex lgammaf
5911 @findex lgammal
5912 @findex lgamma_r
5913 @findex lgammaf_r
5914 @findex lgammal_r
5915 @findex llabs
5916 @findex llrint
5917 @findex llrintf
5918 @findex llrintl
5919 @findex llround
5920 @findex llroundf
5921 @findex llroundl
5922 @findex log
5923 @findex log10
5924 @findex log10f
5925 @findex log10l
5926 @findex log1p
5927 @findex log1pf
5928 @findex log1pl
5929 @findex log2
5930 @findex log2f
5931 @findex log2l
5932 @findex logb
5933 @findex logbf
5934 @findex logbl
5935 @findex logf
5936 @findex logl
5937 @findex lrint
5938 @findex lrintf
5939 @findex lrintl
5940 @findex lround
5941 @findex lroundf
5942 @findex lroundl
5943 @findex malloc
5944 @findex memchr
5945 @findex memcmp
5946 @findex memcpy
5947 @findex mempcpy
5948 @findex memset
5949 @findex modf
5950 @findex modff
5951 @findex modfl
5952 @findex nearbyint
5953 @findex nearbyintf
5954 @findex nearbyintl
5955 @findex nextafter
5956 @findex nextafterf
5957 @findex nextafterl
5958 @findex nexttoward
5959 @findex nexttowardf
5960 @findex nexttowardl
5961 @findex pow
5962 @findex pow10
5963 @findex pow10f
5964 @findex pow10l
5965 @findex powf
5966 @findex powl
5967 @findex printf
5968 @findex printf_unlocked
5969 @findex putchar
5970 @findex puts
5971 @findex remainder
5972 @findex remainderf
5973 @findex remainderl
5974 @findex remquo
5975 @findex remquof
5976 @findex remquol
5977 @findex rindex
5978 @findex rint
5979 @findex rintf
5980 @findex rintl
5981 @findex round
5982 @findex roundf
5983 @findex roundl
5984 @findex scalb
5985 @findex scalbf
5986 @findex scalbl
5987 @findex scalbln
5988 @findex scalblnf
5989 @findex scalblnf
5990 @findex scalbn
5991 @findex scalbnf
5992 @findex scanfnl
5993 @findex signbit
5994 @findex signbitf
5995 @findex signbitl
5996 @findex signbitd32
5997 @findex signbitd64
5998 @findex signbitd128
5999 @findex significand
6000 @findex significandf
6001 @findex significandl
6002 @findex sin
6003 @findex sincos
6004 @findex sincosf
6005 @findex sincosl
6006 @findex sinf
6007 @findex sinh
6008 @findex sinhf
6009 @findex sinhl
6010 @findex sinl
6011 @findex snprintf
6012 @findex sprintf
6013 @findex sqrt
6014 @findex sqrtf
6015 @findex sqrtl
6016 @findex sscanf
6017 @findex stpcpy
6018 @findex stpncpy
6019 @findex strcasecmp
6020 @findex strcat
6021 @findex strchr
6022 @findex strcmp
6023 @findex strcpy
6024 @findex strcspn
6025 @findex strdup
6026 @findex strfmon
6027 @findex strftime
6028 @findex strlen
6029 @findex strncasecmp
6030 @findex strncat
6031 @findex strncmp
6032 @findex strncpy
6033 @findex strndup
6034 @findex strpbrk
6035 @findex strrchr
6036 @findex strspn
6037 @findex strstr
6038 @findex tan
6039 @findex tanf
6040 @findex tanh
6041 @findex tanhf
6042 @findex tanhl
6043 @findex tanl
6044 @findex tgamma
6045 @findex tgammaf
6046 @findex tgammal
6047 @findex toascii
6048 @findex tolower
6049 @findex toupper
6050 @findex towlower
6051 @findex towupper
6052 @findex trunc
6053 @findex truncf
6054 @findex truncl
6055 @findex vfprintf
6056 @findex vfscanf
6057 @findex vprintf
6058 @findex vscanf
6059 @findex vsnprintf
6060 @findex vsprintf
6061 @findex vsscanf
6062 @findex y0
6063 @findex y0f
6064 @findex y0l
6065 @findex y1
6066 @findex y1f
6067 @findex y1l
6068 @findex yn
6069 @findex ynf
6070 @findex ynl
6071
6072 GCC provides a large number of built-in functions other than the ones
6073 mentioned above.  Some of these are for internal use in the processing
6074 of exceptions or variable-length argument lists and will not be
6075 documented here because they may change from time to time; we do not
6076 recommend general use of these functions.
6077
6078 The remaining functions are provided for optimization purposes.
6079
6080 @opindex fno-builtin
6081 GCC includes built-in versions of many of the functions in the standard
6082 C library.  The versions prefixed with @code{__builtin_} will always be
6083 treated as having the same meaning as the C library function even if you
6084 specify the @option{-fno-builtin} option.  (@pxref{C Dialect Options})
6085 Many of these functions are only optimized in certain cases; if they are
6086 not optimized in a particular case, a call to the library function will
6087 be emitted.
6088
6089 @opindex ansi
6090 @opindex std
6091 Outside strict ISO C mode (@option{-ansi}, @option{-std=c89} or
6092 @option{-std=c99}), the functions
6093 @code{_exit}, @code{alloca}, @code{bcmp}, @code{bzero},
6094 @code{dcgettext}, @code{dgettext}, @code{dremf}, @code{dreml},
6095 @code{drem}, @code{exp10f}, @code{exp10l}, @code{exp10}, @code{ffsll},
6096 @code{ffsl}, @code{ffs}, @code{fprintf_unlocked},
6097 @code{fputs_unlocked}, @code{gammaf}, @code{gammal}, @code{gamma},
6098 @code{gammaf_r}, @code{gammal_r}, @code{gamma_r}, @code{gettext},
6099 @code{index}, @code{isascii}, @code{j0f}, @code{j0l}, @code{j0},
6100 @code{j1f}, @code{j1l}, @code{j1}, @code{jnf}, @code{jnl}, @code{jn},
6101 @code{lgammaf_r}, @code{lgammal_r}, @code{lgamma_r}, @code{mempcpy},
6102 @code{pow10f}, @code{pow10l}, @code{pow10}, @code{printf_unlocked},
6103 @code{rindex}, @code{scalbf}, @code{scalbl}, @code{scalb},
6104 @code{signbit}, @code{signbitf}, @code{signbitl}, @code{signbitd32},
6105 @code{signbitd64}, @code{signbitd128}, @code{significandf},
6106 @code{significandl}, @code{significand}, @code{sincosf},
6107 @code{sincosl}, @code{sincos}, @code{stpcpy}, @code{stpncpy},
6108 @code{strcasecmp}, @code{strdup}, @code{strfmon}, @code{strncasecmp},
6109 @code{strndup}, @code{toascii}, @code{y0f}, @code{y0l}, @code{y0},
6110 @code{y1f}, @code{y1l}, @code{y1}, @code{ynf}, @code{ynl} and
6111 @code{yn}
6112 may be handled as built-in functions.
6113 All these functions have corresponding versions
6114 prefixed with @code{__builtin_}, which may be used even in strict C89
6115 mode.
6116
6117 The ISO C99 functions
6118 @code{_Exit}, @code{acoshf}, @code{acoshl}, @code{acosh}, @code{asinhf},
6119 @code{asinhl}, @code{asinh}, @code{atanhf}, @code{atanhl}, @code{atanh},
6120 @code{cabsf}, @code{cabsl}, @code{cabs}, @code{cacosf}, @code{cacoshf},
6121 @code{cacoshl}, @code{cacosh}, @code{cacosl}, @code{cacos},
6122 @code{cargf}, @code{cargl}, @code{carg}, @code{casinf}, @code{casinhf},
6123 @code{casinhl}, @code{casinh}, @code{casinl}, @code{casin},
6124 @code{catanf}, @code{catanhf}, @code{catanhl}, @code{catanh},
6125 @code{catanl}, @code{catan}, @code{cbrtf}, @code{cbrtl}, @code{cbrt},
6126 @code{ccosf}, @code{ccoshf}, @code{ccoshl}, @code{ccosh}, @code{ccosl},
6127 @code{ccos}, @code{cexpf}, @code{cexpl}, @code{cexp}, @code{cimagf},
6128 @code{cimagl}, @code{cimag}, @code{clogf}, @code{clogl}, @code{clog},
6129 @code{conjf}, @code{conjl}, @code{conj}, @code{copysignf}, @code{copysignl},
6130 @code{copysign}, @code{cpowf}, @code{cpowl}, @code{cpow}, @code{cprojf},
6131 @code{cprojl}, @code{cproj}, @code{crealf}, @code{creall}, @code{creal},
6132 @code{csinf}, @code{csinhf}, @code{csinhl}, @code{csinh}, @code{csinl},
6133 @code{csin}, @code{csqrtf}, @code{csqrtl}, @code{csqrt}, @code{ctanf},
6134 @code{ctanhf}, @code{ctanhl}, @code{ctanh}, @code{ctanl}, @code{ctan},
6135 @code{erfcf}, @code{erfcl}, @code{erfc}, @code{erff}, @code{erfl},
6136 @code{erf}, @code{exp2f}, @code{exp2l}, @code{exp2}, @code{expm1f},
6137 @code{expm1l}, @code{expm1}, @code{fdimf}, @code{fdiml}, @code{fdim},
6138 @code{fmaf}, @code{fmal}, @code{fmaxf}, @code{fmaxl}, @code{fmax},
6139 @code{fma}, @code{fminf}, @code{fminl}, @code{fmin}, @code{hypotf},
6140 @code{hypotl}, @code{hypot}, @code{ilogbf}, @code{ilogbl}, @code{ilogb},
6141 @code{imaxabs}, @code{isblank}, @code{iswblank}, @code{lgammaf},
6142 @code{lgammal}, @code{lgamma}, @code{llabs}, @code{llrintf}, @code{llrintl},
6143 @code{llrint}, @code{llroundf}, @code{llroundl}, @code{llround},
6144 @code{log1pf}, @code{log1pl}, @code{log1p}, @code{log2f}, @code{log2l},
6145 @code{log2}, @code{logbf}, @code{logbl}, @code{logb}, @code{lrintf},
6146 @code{lrintl}, @code{lrint}, @code{lroundf}, @code{lroundl},
6147 @code{lround}, @code{nearbyintf}, @code{nearbyintl}, @code{nearbyint},
6148 @code{nextafterf}, @code{nextafterl}, @code{nextafter},
6149 @code{nexttowardf}, @code{nexttowardl}, @code{nexttoward},
6150 @code{remainderf}, @code{remainderl}, @code{remainder}, @code{remquof},
6151 @code{remquol}, @code{remquo}, @code{rintf}, @code{rintl}, @code{rint},
6152 @code{roundf}, @code{roundl}, @code{round}, @code{scalblnf},
6153 @code{scalblnl}, @code{scalbln}, @code{scalbnf}, @code{scalbnl},
6154 @code{scalbn}, @code{snprintf}, @code{tgammaf}, @code{tgammal},
6155 @code{tgamma}, @code{truncf}, @code{truncl}, @code{trunc},
6156 @code{vfscanf}, @code{vscanf}, @code{vsnprintf} and @code{vsscanf}
6157 are handled as built-in functions
6158 except in strict ISO C90 mode (@option{-ansi} or @option{-std=c89}).
6159
6160 There are also built-in versions of the ISO C99 functions
6161 @code{acosf}, @code{acosl}, @code{asinf}, @code{asinl}, @code{atan2f},
6162 @code{atan2l}, @code{atanf}, @code{atanl}, @code{ceilf}, @code{ceill},
6163 @code{cosf}, @code{coshf}, @code{coshl}, @code{cosl}, @code{expf},
6164 @code{expl}, @code{fabsf}, @code{fabsl}, @code{floorf}, @code{floorl},
6165 @code{fmodf}, @code{fmodl}, @code{frexpf}, @code{frexpl}, @code{ldexpf},
6166 @code{ldexpl}, @code{log10f}, @code{log10l}, @code{logf}, @code{logl},
6167 @code{modfl}, @code{modf}, @code{powf}, @code{powl}, @code{sinf},
6168 @code{sinhf}, @code{sinhl}, @code{sinl}, @code{sqrtf}, @code{sqrtl},
6169 @code{tanf}, @code{tanhf}, @code{tanhl} and @code{tanl}
6170 that are recognized in any mode since ISO C90 reserves these names for
6171 the purpose to which ISO C99 puts them.  All these functions have
6172 corresponding versions prefixed with @code{__builtin_}.
6173
6174 The ISO C94 functions
6175 @code{iswalnum}, @code{iswalpha}, @code{iswcntrl}, @code{iswdigit},
6176 @code{iswgraph}, @code{iswlower}, @code{iswprint}, @code{iswpunct},
6177 @code{iswspace}, @code{iswupper}, @code{iswxdigit}, @code{towlower} and
6178 @code{towupper}
6179 are handled as built-in functions
6180 except in strict ISO C90 mode (@option{-ansi} or @option{-std=c89}).
6181
6182 The ISO C90 functions
6183 @code{abort}, @code{abs}, @code{acos}, @code{asin}, @code{atan2},
6184 @code{atan}, @code{calloc}, @code{ceil}, @code{cosh}, @code{cos},
6185 @code{exit}, @code{exp}, @code{fabs}, @code{floor}, @code{fmod},
6186 @code{fprintf}, @code{fputs}, @code{frexp}, @code{fscanf},
6187 @code{isalnum}, @code{isalpha}, @code{iscntrl}, @code{isdigit},
6188 @code{isgraph}, @code{islower}, @code{isprint}, @code{ispunct},
6189 @code{isspace}, @code{isupper}, @code{isxdigit}, @code{tolower},
6190 @code{toupper}, @code{labs}, @code{ldexp}, @code{log10}, @code{log},
6191 @code{malloc}, @code{memchr}, @code{memcmp}, @code{memcpy},
6192 @code{memset}, @code{modf}, @code{pow}, @code{printf}, @code{putchar},
6193 @code{puts}, @code{scanf}, @code{sinh}, @code{sin}, @code{snprintf},
6194 @code{sprintf}, @code{sqrt}, @code{sscanf}, @code{strcat},
6195 @code{strchr}, @code{strcmp}, @code{strcpy}, @code{strcspn},
6196 @code{strlen}, @code{strncat}, @code{strncmp}, @code{strncpy},
6197 @code{strpbrk}, @code{strrchr}, @code{strspn}, @code{strstr},
6198 @code{tanh}, @code{tan}, @code{vfprintf}, @code{vprintf} and @code{vsprintf}
6199 are all recognized as built-in functions unless
6200 @option{-fno-builtin} is specified (or @option{-fno-builtin-@var{function}}
6201 is specified for an individual function).  All of these functions have
6202 corresponding versions prefixed with @code{__builtin_}.
6203
6204 GCC provides built-in versions of the ISO C99 floating point comparison
6205 macros that avoid raising exceptions for unordered operands.  They have
6206 the same names as the standard macros ( @code{isgreater},
6207 @code{isgreaterequal}, @code{isless}, @code{islessequal},
6208 @code{islessgreater}, and @code{isunordered}) , with @code{__builtin_}
6209 prefixed.  We intend for a library implementor to be able to simply
6210 @code{#define} each standard macro to its built-in equivalent.
6211 In the same fashion, GCC provides @code{isfinite} and @code{isnormal}
6212 built-ins used with @code{__builtin_} prefixed.
6213
6214 @deftypefn {Built-in Function} int __builtin_types_compatible_p (@var{type1}, @var{type2})
6215
6216 You can use the built-in function @code{__builtin_types_compatible_p} to
6217 determine whether two types are the same.
6218
6219 This built-in function returns 1 if the unqualified versions of the
6220 types @var{type1} and @var{type2} (which are types, not expressions) are
6221 compatible, 0 otherwise.  The result of this built-in function can be
6222 used in integer constant expressions.
6223
6224 This built-in function ignores top level qualifiers (e.g., @code{const},
6225 @code{volatile}).  For example, @code{int} is equivalent to @code{const
6226 int}.
6227
6228 The type @code{int[]} and @code{int[5]} are compatible.  On the other
6229 hand, @code{int} and @code{char *} are not compatible, even if the size
6230 of their types, on the particular architecture are the same.  Also, the
6231 amount of pointer indirection is taken into account when determining
6232 similarity.  Consequently, @code{short *} is not similar to
6233 @code{short **}.  Furthermore, two types that are typedefed are
6234 considered compatible if their underlying types are compatible.
6235
6236 An @code{enum} type is not considered to be compatible with another
6237 @code{enum} type even if both are compatible with the same integer
6238 type; this is what the C standard specifies.
6239 For example, @code{enum @{foo, bar@}} is not similar to
6240 @code{enum @{hot, dog@}}.
6241
6242 You would typically use this function in code whose execution varies
6243 depending on the arguments' types.  For example:
6244
6245 @smallexample
6246 #define foo(x)                                                  \
6247   (@{                                                           \
6248     typeof (x) tmp = (x);                                       \
6249     if (__builtin_types_compatible_p (typeof (x), long double)) \
6250       tmp = foo_long_double (tmp);                              \
6251     else if (__builtin_types_compatible_p (typeof (x), double)) \
6252       tmp = foo_double (tmp);                                   \
6253     else if (__builtin_types_compatible_p (typeof (x), float))  \
6254       tmp = foo_float (tmp);                                    \
6255     else                                                        \
6256       abort ();                                                 \
6257     tmp;                                                        \
6258   @})
6259 @end smallexample
6260
6261 @emph{Note:} This construct is only available for C@.
6262
6263 @end deftypefn
6264
6265 @deftypefn {Built-in Function} @var{type} __builtin_choose_expr (@var{const_exp}, @var{exp1}, @var{exp2})
6266
6267 You can use the built-in function @code{__builtin_choose_expr} to
6268 evaluate code depending on the value of a constant expression.  This
6269 built-in function returns @var{exp1} if @var{const_exp}, which is a
6270 constant expression that must be able to be determined at compile time,
6271 is nonzero.  Otherwise it returns 0.
6272
6273 This built-in function is analogous to the @samp{? :} operator in C,
6274 except that the expression returned has its type unaltered by promotion
6275 rules.  Also, the built-in function does not evaluate the expression
6276 that was not chosen.  For example, if @var{const_exp} evaluates to true,
6277 @var{exp2} is not evaluated even if it has side-effects.
6278
6279 This built-in function can return an lvalue if the chosen argument is an
6280 lvalue.
6281
6282 If @var{exp1} is returned, the return type is the same as @var{exp1}'s
6283 type.  Similarly, if @var{exp2} is returned, its return type is the same
6284 as @var{exp2}.
6285
6286 Example:
6287
6288 @smallexample
6289 #define foo(x)                                                    \
6290   __builtin_choose_expr (                                         \
6291     __builtin_types_compatible_p (typeof (x), double),            \
6292     foo_double (x),                                               \
6293     __builtin_choose_expr (                                       \
6294       __builtin_types_compatible_p (typeof (x), float),           \
6295       foo_float (x),                                              \
6296       /* @r{The void expression results in a compile-time error}  \
6297          @r{when assigning the result to something.}  */          \
6298       (void)0))
6299 @end smallexample
6300
6301 @emph{Note:} This construct is only available for C@.  Furthermore, the
6302 unused expression (@var{exp1} or @var{exp2} depending on the value of
6303 @var{const_exp}) may still generate syntax errors.  This may change in
6304 future revisions.
6305
6306 @end deftypefn
6307
6308 @deftypefn {Built-in Function} int __builtin_constant_p (@var{exp})
6309 You can use the built-in function @code{__builtin_constant_p} to
6310 determine if a value is known to be constant at compile-time and hence
6311 that GCC can perform constant-folding on expressions involving that
6312 value.  The argument of the function is the value to test.  The function
6313 returns the integer 1 if the argument is known to be a compile-time
6314 constant and 0 if it is not known to be a compile-time constant.  A
6315 return of 0 does not indicate that the value is @emph{not} a constant,
6316 but merely that GCC cannot prove it is a constant with the specified
6317 value of the @option{-O} option.
6318
6319 You would typically use this function in an embedded application where
6320 memory was a critical resource.  If you have some complex calculation,
6321 you may want it to be folded if it involves constants, but need to call
6322 a function if it does not.  For example:
6323
6324 @smallexample
6325 #define Scale_Value(X)      \
6326   (__builtin_constant_p (X) \
6327   ? ((X) * SCALE + OFFSET) : Scale (X))
6328 @end smallexample
6329
6330 You may use this built-in function in either a macro or an inline
6331 function.  However, if you use it in an inlined function and pass an
6332 argument of the function as the argument to the built-in, GCC will
6333 never return 1 when you call the inline function with a string constant
6334 or compound literal (@pxref{Compound Literals}) and will not return 1
6335 when you pass a constant numeric value to the inline function unless you
6336 specify the @option{-O} option.
6337
6338 You may also use @code{__builtin_constant_p} in initializers for static
6339 data.  For instance, you can write
6340
6341 @smallexample
6342 static const int table[] = @{
6343    __builtin_constant_p (EXPRESSION) ? (EXPRESSION) : -1,
6344    /* @r{@dots{}} */
6345 @};
6346 @end smallexample
6347
6348 @noindent
6349 This is an acceptable initializer even if @var{EXPRESSION} is not a
6350 constant expression.  GCC must be more conservative about evaluating the
6351 built-in in this case, because it has no opportunity to perform
6352 optimization.
6353
6354 Previous versions of GCC did not accept this built-in in data
6355 initializers.  The earliest version where it is completely safe is
6356 3.0.1.
6357 @end deftypefn
6358
6359 @deftypefn {Built-in Function} long __builtin_expect (long @var{exp}, long @var{c})
6360 @opindex fprofile-arcs
6361 You may use @code{__builtin_expect} to provide the compiler with
6362 branch prediction information.  In general, you should prefer to
6363 use actual profile feedback for this (@option{-fprofile-arcs}), as
6364 programmers are notoriously bad at predicting how their programs
6365 actually perform.  However, there are applications in which this
6366 data is hard to collect.
6367
6368 The return value is the value of @var{exp}, which should be an integral
6369 expression.  The semantics of the built-in are that it is expected that
6370 @var{exp} == @var{c}.  For example:
6371
6372 @smallexample
6373 if (__builtin_expect (x, 0))
6374   foo ();
6375 @end smallexample
6376
6377 @noindent
6378 would indicate that we do not expect to call @code{foo}, since
6379 we expect @code{x} to be zero.  Since you are limited to integral
6380 expressions for @var{exp}, you should use constructions such as
6381
6382 @smallexample
6383 if (__builtin_expect (ptr != NULL, 1))
6384   error ();
6385 @end smallexample
6386
6387 @noindent
6388 when testing pointer or floating-point values.
6389 @end deftypefn
6390
6391 @deftypefn {Built-in Function} void __builtin___clear_cache (char *@var{begin}, char *@var{end})
6392 This function is used to flush the processor's instruction cache for
6393 the region of memory between @var{begin} inclusive and @var{end}
6394 exclusive.  Some targets require that the instruction cache be
6395 flushed, after modifying memory containing code, in order to obtain
6396 deterministic behavior.
6397
6398 If the target does not require instruction cache flushes,
6399 @code{__builtin___clear_cache} has no effect.  Otherwise either
6400 instructions are emitted in-line to clear the instruction cache or a
6401 call to the @code{__clear_cache} function in libgcc is made.
6402 @end deftypefn
6403
6404 @deftypefn {Built-in Function} void __builtin_prefetch (const void *@var{addr}, ...)
6405 This function is used to minimize cache-miss latency by moving data into
6406 a cache before it is accessed.
6407 You can insert calls to @code{__builtin_prefetch} into code for which
6408 you know addresses of data in memory that is likely to be accessed soon.
6409 If the target supports them, data prefetch instructions will be generated.
6410 If the prefetch is done early enough before the access then the data will
6411 be in the cache by the time it is accessed.
6412
6413 The value of @var{addr} is the address of the memory to prefetch.
6414 There are two optional arguments, @var{rw} and @var{locality}.
6415 The value of @var{rw} is a compile-time constant one or zero; one
6416 means that the prefetch is preparing for a write to the memory address
6417 and zero, the default, means that the prefetch is preparing for a read.
6418 The value @var{locality} must be a compile-time constant integer between
6419 zero and three.  A value of zero means that the data has no temporal
6420 locality, so it need not be left in the cache after the access.  A value
6421 of three means that the data has a high degree of temporal locality and
6422 should be left in all levels of cache possible.  Values of one and two
6423 mean, respectively, a low or moderate degree of temporal locality.  The
6424 default is three.
6425
6426 @smallexample
6427 for (i = 0; i < n; i++)
6428   @{
6429     a[i] = a[i] + b[i];
6430     __builtin_prefetch (&a[i+j], 1, 1);
6431     __builtin_prefetch (&b[i+j], 0, 1);
6432     /* @r{@dots{}} */
6433   @}
6434 @end smallexample
6435
6436 Data prefetch does not generate faults if @var{addr} is invalid, but
6437 the address expression itself must be valid.  For example, a prefetch
6438 of @code{p->next} will not fault if @code{p->next} is not a valid
6439 address, but evaluation will fault if @code{p} is not a valid address.
6440
6441 If the target does not support data prefetch, the address expression
6442 is evaluated if it includes side effects but no other code is generated
6443 and GCC does not issue a warning.
6444 @end deftypefn
6445
6446 @deftypefn {Built-in Function} double __builtin_huge_val (void)
6447 Returns a positive infinity, if supported by the floating-point format,
6448 else @code{DBL_MAX}.  This function is suitable for implementing the
6449 ISO C macro @code{HUGE_VAL}.
6450 @end deftypefn
6451
6452 @deftypefn {Built-in Function} float __builtin_huge_valf (void)
6453 Similar to @code{__builtin_huge_val}, except the return type is @code{float}.
6454 @end deftypefn
6455
6456 @deftypefn {Built-in Function} {long double} __builtin_huge_vall (void)
6457 Similar to @code{__builtin_huge_val}, except the return
6458 type is @code{long double}.
6459 @end deftypefn
6460
6461 @deftypefn {Built-in Function} double __builtin_inf (void)
6462 Similar to @code{__builtin_huge_val}, except a warning is generated
6463 if the target floating-point format does not support infinities.
6464 @end deftypefn
6465
6466 @deftypefn {Built-in Function} _Decimal32 __builtin_infd32 (void)
6467 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal32}.
6468 @end deftypefn
6469
6470 @deftypefn {Built-in Function} _Decimal64 __builtin_infd64 (void)
6471 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal64}.
6472 @end deftypefn
6473
6474 @deftypefn {Built-in Function} _Decimal128 __builtin_infd128 (void)
6475 Similar to @code{__builtin_inf}, except the return type is @code{_Decimal128}.
6476 @end deftypefn
6477
6478 @deftypefn {Built-in Function} float __builtin_inff (void)
6479 Similar to @code{__builtin_inf}, except the return type is @code{float}.
6480 This function is suitable for implementing the ISO C99 macro @code{INFINITY}.
6481 @end deftypefn
6482
6483 @deftypefn {Built-in Function} {long double} __builtin_infl (void)
6484 Similar to @code{__builtin_inf}, except the return
6485 type is @code{long double}.
6486 @end deftypefn
6487
6488 @deftypefn {Built-in Function} double __builtin_nan (const char *str)
6489 This is an implementation of the ISO C99 function @code{nan}.
6490
6491 Since ISO C99 defines this function in terms of @code{strtod}, which we
6492 do not implement, a description of the parsing is in order.  The string
6493 is parsed as by @code{strtol}; that is, the base is recognized by
6494 leading @samp{0} or @samp{0x} prefixes.  The number parsed is placed
6495 in the significand such that the least significant bit of the number
6496 is at the least significant bit of the significand.  The number is
6497 truncated to fit the significand field provided.  The significand is
6498 forced to be a quiet NaN@.
6499
6500 This function, if given a string literal all of which would have been
6501 consumed by strtol, is evaluated early enough that it is considered a
6502 compile-time constant.
6503 @end deftypefn
6504
6505 @deftypefn {Built-in Function} _Decimal32 __builtin_nand32 (const char *str)
6506 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal32}.
6507 @end deftypefn
6508
6509 @deftypefn {Built-in Function} _Decimal64 __builtin_nand64 (const char *str)
6510 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal64}.
6511 @end deftypefn
6512
6513 @deftypefn {Built-in Function} _Decimal128 __builtin_nand128 (const char *str)
6514 Similar to @code{__builtin_nan}, except the return type is @code{_Decimal128}.
6515 @end deftypefn
6516
6517 @deftypefn {Built-in Function} float __builtin_nanf (const char *str)
6518 Similar to @code{__builtin_nan}, except the return type is @code{float}.
6519 @end deftypefn
6520
6521 @deftypefn {Built-in Function} {long double} __builtin_nanl (const char *str)
6522 Similar to @code{__builtin_nan}, except the return type is @code{long double}.
6523 @end deftypefn
6524
6525 @deftypefn {Built-in Function} double __builtin_nans (const char *str)
6526 Similar to @code{__builtin_nan}, except the significand is forced
6527 to be a signaling NaN@.  The @code{nans} function is proposed by
6528 @uref{http://www.open-std.org/jtc1/sc22/wg14/www/docs/n965.htm,,WG14 N965}.
6529 @end deftypefn
6530
6531 @deftypefn {Built-in Function} float __builtin_nansf (const char *str)
6532 Similar to @code{__builtin_nans}, except the return type is @code{float}.
6533 @end deftypefn
6534
6535 @deftypefn {Built-in Function} {long double} __builtin_nansl (const char *str)
6536 Similar to @code{__builtin_nans}, except the return type is @code{long double}.
6537 @end deftypefn
6538
6539 @deftypefn {Built-in Function} int __builtin_ffs (unsigned int x)
6540 Returns one plus the index of the least significant 1-bit of @var{x}, or
6541 if @var{x} is zero, returns zero.
6542 @end deftypefn
6543
6544 @deftypefn {Built-in Function} int __builtin_clz (unsigned int x)
6545 Returns the number of leading 0-bits in @var{x}, starting at the most
6546 significant bit position.  If @var{x} is 0, the result is undefined.
6547 @end deftypefn
6548
6549 @deftypefn {Built-in Function} int __builtin_ctz (unsigned int x)
6550 Returns the number of trailing 0-bits in @var{x}, starting at the least
6551 significant bit position.  If @var{x} is 0, the result is undefined.
6552 @end deftypefn
6553
6554 @deftypefn {Built-in Function} int __builtin_popcount (unsigned int x)
6555 Returns the number of 1-bits in @var{x}.
6556 @end deftypefn
6557
6558 @deftypefn {Built-in Function} int __builtin_parity (unsigned int x)
6559 Returns the parity of @var{x}, i.e.@: the number of 1-bits in @var{x}
6560 modulo 2.
6561 @end deftypefn
6562
6563 @deftypefn {Built-in Function} int __builtin_ffsl (unsigned long)
6564 Similar to @code{__builtin_ffs}, except the argument type is
6565 @code{unsigned long}.
6566 @end deftypefn
6567
6568 @deftypefn {Built-in Function} int __builtin_clzl (unsigned long)
6569 Similar to @code{__builtin_clz}, except the argument type is
6570 @code{unsigned long}.
6571 @end deftypefn
6572
6573 @deftypefn {Built-in Function} int __builtin_ctzl (unsigned long)
6574 Similar to @code{__builtin_ctz}, except the argument type is
6575 @code{unsigned long}.
6576 @end deftypefn
6577
6578 @deftypefn {Built-in Function} int __builtin_popcountl (unsigned long)
6579 Similar to @code{__builtin_popcount}, except the argument type is
6580 @code{unsigned long}.
6581 @end deftypefn
6582
6583 @deftypefn {Built-in Function} int __builtin_parityl (unsigned long)
6584 Similar to @code{__builtin_parity}, except the argument type is
6585 @code{unsigned long}.
6586 @end deftypefn
6587
6588 @deftypefn {Built-in Function} int __builtin_ffsll (unsigned long long)
6589 Similar to @code{__builtin_ffs}, except the argument type is
6590 @code{unsigned long long}.
6591 @end deftypefn
6592
6593 @deftypefn {Built-in Function} int __builtin_clzll (unsigned long long)
6594 Similar to @code{__builtin_clz}, except the argument type is
6595 @code{unsigned long long}.
6596 @end deftypefn
6597
6598 @deftypefn {Built-in Function} int __builtin_ctzll (unsigned long long)
6599 Similar to @code{__builtin_ctz}, except the argument type is
6600 @code{unsigned long long}.
6601 @end deftypefn
6602
6603 @deftypefn {Built-in Function} int __builtin_popcountll (unsigned long long)
6604 Similar to @code{__builtin_popcount}, except the argument type is
6605 @code{unsigned long long}.
6606 @end deftypefn
6607
6608 @deftypefn {Built-in Function} int __builtin_parityll (unsigned long long)
6609 Similar to @code{__builtin_parity}, except the argument type is
6610 @code{unsigned long long}.
6611 @end deftypefn
6612
6613 @deftypefn {Built-in Function} double __builtin_powi (double, int)
6614 Returns the first argument raised to the power of the second.  Unlike the
6615 @code{pow} function no guarantees about precision and rounding are made.
6616 @end deftypefn
6617
6618 @deftypefn {Built-in Function} float __builtin_powif (float, int)
6619 Similar to @code{__builtin_powi}, except the argument and return types
6620 are @code{float}.
6621 @end deftypefn
6622
6623 @deftypefn {Built-in Function} {long double} __builtin_powil (long double, int)
6624 Similar to @code{__builtin_powi}, except the argument and return types
6625 are @code{long double}.
6626 @end deftypefn
6627
6628 @deftypefn {Built-in Function} int32_t __builtin_bswap32 (int32_t x)
6629 Returns @var{x} with the order of the bytes reversed; for example,
6630 @code{0xaabbccdd} becomes @code{0xddccbbaa}.  Byte here always means
6631 exactly 8 bits.
6632 @end deftypefn
6633
6634 @deftypefn {Built-in Function} int64_t __builtin_bswap64 (int64_t x)
6635 Similar to @code{__builtin_bswap32}, except the argument and return types
6636 are 64-bit.
6637 @end deftypefn
6638
6639 @node Target Builtins
6640 @section Built-in Functions Specific to Particular Target Machines
6641
6642 On some target machines, GCC supports many built-in functions specific
6643 to those machines.  Generally these generate calls to specific machine
6644 instructions, but allow the compiler to schedule those calls.
6645
6646 @menu
6647 * Alpha Built-in Functions::
6648 * ARM iWMMXt Built-in Functions::
6649 * ARM NEON Intrinsics::
6650 * Blackfin Built-in Functions::
6651 * FR-V Built-in Functions::
6652 * X86 Built-in Functions::
6653 * MIPS DSP Built-in Functions::
6654 * MIPS Paired-Single Support::
6655 * PowerPC AltiVec Built-in Functions::
6656 * SPARC VIS Built-in Functions::
6657 * SPU Built-in Functions::
6658 @end menu
6659
6660 @node Alpha Built-in Functions
6661 @subsection Alpha Built-in Functions
6662
6663 These built-in functions are available for the Alpha family of
6664 processors, depending on the command-line switches used.
6665
6666 The following built-in functions are always available.  They
6667 all generate the machine instruction that is part of the name.
6668
6669 @smallexample
6670 long __builtin_alpha_implver (void)
6671 long __builtin_alpha_rpcc (void)
6672 long __builtin_alpha_amask (long)
6673 long __builtin_alpha_cmpbge (long, long)
6674 long __builtin_alpha_extbl (long, long)
6675 long __builtin_alpha_extwl (long, long)
6676 long __builtin_alpha_extll (long, long)
6677 long __builtin_alpha_extql (long, long)
6678 long __builtin_alpha_extwh (long, long)
6679 long __builtin_alpha_extlh (long, long)
6680 long __builtin_alpha_extqh (long, long)
6681 long __builtin_alpha_insbl (long, long)
6682 long __builtin_alpha_inswl (long, long)
6683 long __builtin_alpha_insll (long, long)
6684 long __builtin_alpha_insql (long, long)
6685 long __builtin_alpha_inswh (long, long)
6686 long __builtin_alpha_inslh (long, long)
6687 long __builtin_alpha_insqh (long, long)
6688 long __builtin_alpha_mskbl (long, long)
6689 long __builtin_alpha_mskwl (long, long)
6690 long __builtin_alpha_mskll (long, long)
6691 long __builtin_alpha_mskql (long, long)
6692 long __builtin_alpha_mskwh (long, long)
6693 long __builtin_alpha_msklh (long, long)
6694 long __builtin_alpha_mskqh (long, long)
6695 long __builtin_alpha_umulh (long, long)
6696 long __builtin_alpha_zap (long, long)
6697 long __builtin_alpha_zapnot (long, long)
6698 @end smallexample
6699
6700 The following built-in functions are always with @option{-mmax}
6701 or @option{-mcpu=@var{cpu}} where @var{cpu} is @code{pca56} or
6702 later.  They all generate the machine instruction that is part
6703 of the name.
6704
6705 @smallexample
6706 long __builtin_alpha_pklb (long)
6707 long __builtin_alpha_pkwb (long)
6708 long __builtin_alpha_unpkbl (long)
6709 long __builtin_alpha_unpkbw (long)
6710 long __builtin_alpha_minub8 (long, long)
6711 long __builtin_alpha_minsb8 (long, long)
6712 long __builtin_alpha_minuw4 (long, long)
6713 long __builtin_alpha_minsw4 (long, long)
6714 long __builtin_alpha_maxub8 (long, long)
6715 long __builtin_alpha_maxsb8 (long, long)
6716 long __builtin_alpha_maxuw4 (long, long)
6717 long __builtin_alpha_maxsw4 (long, long)
6718 long __builtin_alpha_perr (long, long)
6719 @end smallexample
6720
6721 The following built-in functions are always with @option{-mcix}
6722 or @option{-mcpu=@var{cpu}} where @var{cpu} is @code{ev67} or
6723 later.  They all generate the machine instruction that is part
6724 of the name.
6725
6726 @smallexample
6727 long __builtin_alpha_cttz (long)
6728 long __builtin_alpha_ctlz (long)
6729 long __builtin_alpha_ctpop (long)
6730 @end smallexample
6731
6732 The following builtins are available on systems that use the OSF/1
6733 PALcode.  Normally they invoke the @code{rduniq} and @code{wruniq}
6734 PAL calls, but when invoked with @option{-mtls-kernel}, they invoke
6735 @code{rdval} and @code{wrval}.
6736
6737 @smallexample
6738 void *__builtin_thread_pointer (void)
6739 void __builtin_set_thread_pointer (void *)
6740 @end smallexample
6741
6742 @node ARM iWMMXt Built-in Functions
6743 @subsection ARM iWMMXt Built-in Functions
6744
6745 These built-in functions are available for the ARM family of
6746 processors when the @option{-mcpu=iwmmxt} switch is used:
6747
6748 @smallexample
6749 typedef int v2si __attribute__ ((vector_size (8)));
6750 typedef short v4hi __attribute__ ((vector_size (8)));
6751 typedef char v8qi __attribute__ ((vector_size (8)));
6752
6753 int __builtin_arm_getwcx (int)
6754 void __builtin_arm_setwcx (int, int)
6755 int __builtin_arm_textrmsb (v8qi, int)
6756 int __builtin_arm_textrmsh (v4hi, int)
6757 int __builtin_arm_textrmsw (v2si, int)
6758 int __builtin_arm_textrmub (v8qi, int)
6759 int __builtin_arm_textrmuh (v4hi, int)
6760 int __builtin_arm_textrmuw (v2si, int)
6761 v8qi __builtin_arm_tinsrb (v8qi, int)
6762 v4hi __builtin_arm_tinsrh (v4hi, int)
6763 v2si __builtin_arm_tinsrw (v2si, int)
6764 long long __builtin_arm_tmia (long long, int, int)
6765 long long __builtin_arm_tmiabb (long long, int, int)
6766 long long __builtin_arm_tmiabt (long long, int, int)
6767 long long __builtin_arm_tmiaph (long long, int, int)
6768 long long __builtin_arm_tmiatb (long long, int, int)
6769 long long __builtin_arm_tmiatt (long long, int, int)
6770 int __builtin_arm_tmovmskb (v8qi)
6771 int __builtin_arm_tmovmskh (v4hi)
6772 int __builtin_arm_tmovmskw (v2si)
6773 long long __builtin_arm_waccb (v8qi)
6774 long long __builtin_arm_wacch (v4hi)
6775 long long __builtin_arm_waccw (v2si)
6776 v8qi __builtin_arm_waddb (v8qi, v8qi)
6777 v8qi __builtin_arm_waddbss (v8qi, v8qi)
6778 v8qi __builtin_arm_waddbus (v8qi, v8qi)
6779 v4hi __builtin_arm_waddh (v4hi, v4hi)
6780 v4hi __builtin_arm_waddhss (v4hi, v4hi)
6781 v4hi __builtin_arm_waddhus (v4hi, v4hi)
6782 v2si __builtin_arm_waddw (v2si, v2si)
6783 v2si __builtin_arm_waddwss (v2si, v2si)
6784 v2si __builtin_arm_waddwus (v2si, v2si)
6785 v8qi __builtin_arm_walign (v8qi, v8qi, int)
6786 long long __builtin_arm_wand(long long, long long)
6787 long long __builtin_arm_wandn (long long, long long)
6788 v8qi __builtin_arm_wavg2b (v8qi, v8qi)
6789 v8qi __builtin_arm_wavg2br (v8qi, v8qi)
6790 v4hi __builtin_arm_wavg2h (v4hi, v4hi)
6791 v4hi __builtin_arm_wavg2hr (v4hi, v4hi)
6792 v8qi __builtin_arm_wcmpeqb (v8qi, v8qi)
6793 v4hi __builtin_arm_wcmpeqh (v4hi, v4hi)
6794 v2si __builtin_arm_wcmpeqw (v2si, v2si)
6795 v8qi __builtin_arm_wcmpgtsb (v8qi, v8qi)
6796 v4hi __builtin_arm_wcmpgtsh (v4hi, v4hi)
6797 v2si __builtin_arm_wcmpgtsw (v2si, v2si)
6798 v8qi __builtin_arm_wcmpgtub (v8qi, v8qi)
6799 v4hi __builtin_arm_wcmpgtuh (v4hi, v4hi)
6800 v2si __builtin_arm_wcmpgtuw (v2si, v2si)
6801 long long __builtin_arm_wmacs (long long, v4hi, v4hi)
6802 long long __builtin_arm_wmacsz (v4hi, v4hi)
6803 long long __builtin_arm_wmacu (long long, v4hi, v4hi)
6804 long long __builtin_arm_wmacuz (v4hi, v4hi)
6805 v4hi __builtin_arm_wmadds (v4hi, v4hi)
6806 v4hi __builtin_arm_wmaddu (v4hi, v4hi)
6807 v8qi __builtin_arm_wmaxsb (v8qi, v8qi)
6808 v4hi __builtin_arm_wmaxsh (v4hi, v4hi)
6809 v2si __builtin_arm_wmaxsw (v2si, v2si)
6810 v8qi __builtin_arm_wmaxub (v8qi, v8qi)
6811 v4hi __builtin_arm_wmaxuh (v4hi, v4hi)
6812 v2si __builtin_arm_wmaxuw (v2si, v2si)
6813 v8qi __builtin_arm_wminsb (v8qi, v8qi)
6814 v4hi __builtin_arm_wminsh (v4hi, v4hi)
6815 v2si __builtin_arm_wminsw (v2si, v2si)
6816 v8qi __builtin_arm_wminub (v8qi, v8qi)
6817 v4hi __builtin_arm_wminuh (v4hi, v4hi)
6818 v2si __builtin_arm_wminuw (v2si, v2si)
6819 v4hi __builtin_arm_wmulsm (v4hi, v4hi)
6820 v4hi __builtin_arm_wmulul (v4hi, v4hi)
6821 v4hi __builtin_arm_wmulum (v4hi, v4hi)
6822 long long __builtin_arm_wor (long long, long long)
6823 v2si __builtin_arm_wpackdss (long long, long long)
6824 v2si __builtin_arm_wpackdus (long long, long long)
6825 v8qi __builtin_arm_wpackhss (v4hi, v4hi)
6826 v8qi __builtin_arm_wpackhus (v4hi, v4hi)
6827 v4hi __builtin_arm_wpackwss (v2si, v2si)
6828 v4hi __builtin_arm_wpackwus (v2si, v2si)
6829 long long __builtin_arm_wrord (long long, long long)
6830 long long __builtin_arm_wrordi (long long, int)
6831 v4hi __builtin_arm_wrorh (v4hi, long long)
6832 v4hi __builtin_arm_wrorhi (v4hi, int)
6833 v2si __builtin_arm_wrorw (v2si, long long)
6834 v2si __builtin_arm_wrorwi (v2si, int)
6835 v2si __builtin_arm_wsadb (v8qi, v8qi)
6836 v2si __builtin_arm_wsadbz (v8qi, v8qi)
6837 v2si __builtin_arm_wsadh (v4hi, v4hi)
6838 v2si __builtin_arm_wsadhz (v4hi, v4hi)
6839 v4hi __builtin_arm_wshufh (v4hi, int)
6840 long long __builtin_arm_wslld (long long, long long)
6841 long long __builtin_arm_wslldi (long long, int)
6842 v4hi __builtin_arm_wsllh (v4hi, long long)
6843 v4hi __builtin_arm_wsllhi (v4hi, int)
6844 v2si __builtin_arm_wsllw (v2si, long long)
6845 v2si __builtin_arm_wsllwi (v2si, int)
6846 long long __builtin_arm_wsrad (long long, long long)
6847 long long __builtin_arm_wsradi (long long, int)
6848 v4hi __builtin_arm_wsrah (v4hi, long long)
6849 v4hi __builtin_arm_wsrahi (v4hi, int)
6850 v2si __builtin_arm_wsraw (v2si, long long)
6851 v2si __builtin_arm_wsrawi (v2si, int)
6852 long long __builtin_arm_wsrld (long long, long long)
6853 long long __builtin_arm_wsrldi (long long, int)
6854 v4hi __builtin_arm_wsrlh (v4hi, long long)
6855 v4hi __builtin_arm_wsrlhi (v4hi, int)
6856 v2si __builtin_arm_wsrlw (v2si, long long)
6857 v2si __builtin_arm_wsrlwi (v2si, int)
6858 v8qi __builtin_arm_wsubb (v8qi, v8qi)
6859 v8qi __builtin_arm_wsubbss (v8qi, v8qi)
6860 v8qi __builtin_arm_wsubbus (v8qi, v8qi)
6861 v4hi __builtin_arm_wsubh (v4hi, v4hi)
6862 v4hi __builtin_arm_wsubhss (v4hi, v4hi)
6863 v4hi __builtin_arm_wsubhus (v4hi, v4hi)
6864 v2si __builtin_arm_wsubw (v2si, v2si)
6865 v2si __builtin_arm_wsubwss (v2si, v2si)
6866 v2si __builtin_arm_wsubwus (v2si, v2si)
6867 v4hi __builtin_arm_wunpckehsb (v8qi)
6868 v2si __builtin_arm_wunpckehsh (v4hi)
6869 long long __builtin_arm_wunpckehsw (v2si)
6870 v4hi __builtin_arm_wunpckehub (v8qi)
6871 v2si __builtin_arm_wunpckehuh (v4hi)
6872 long long __builtin_arm_wunpckehuw (v2si)
6873 v4hi __builtin_arm_wunpckelsb (v8qi)
6874 v2si __builtin_arm_wunpckelsh (v4hi)
6875 long long __builtin_arm_wunpckelsw (v2si)
6876 v4hi __builtin_arm_wunpckelub (v8qi)
6877 v2si __builtin_arm_wunpckeluh (v4hi)
6878 long long __builtin_arm_wunpckeluw (v2si)
6879 v8qi __builtin_arm_wunpckihb (v8qi, v8qi)
6880 v4hi __builtin_arm_wunpckihh (v4hi, v4hi)
6881 v2si __builtin_arm_wunpckihw (v2si, v2si)
6882 v8qi __builtin_arm_wunpckilb (v8qi, v8qi)
6883 v4hi __builtin_arm_wunpckilh (v4hi, v4hi)
6884 v2si __builtin_arm_wunpckilw (v2si, v2si)
6885 long long __builtin_arm_wxor (long long, long long)
6886 long long __builtin_arm_wzero ()
6887 @end smallexample
6888
6889 @node ARM NEON Intrinsics
6890 @subsection ARM NEON Intrinsics
6891
6892 These built-in intrinsics for the ARM Advanced SIMD extension are available
6893 when the @option{-mfpu=neon} switch is used:
6894
6895 @include arm-neon-intrinsics.texi
6896
6897 @node Blackfin Built-in Functions
6898 @subsection Blackfin Built-in Functions
6899
6900 Currently, there are two Blackfin-specific built-in functions.  These are
6901 used for generating @code{CSYNC} and @code{SSYNC} machine insns without
6902 using inline assembly; by using these built-in functions the compiler can
6903 automatically add workarounds for hardware errata involving these
6904 instructions.  These functions are named as follows:
6905
6906 @smallexample
6907 void __builtin_bfin_csync (void)
6908 void __builtin_bfin_ssync (void)
6909 @end smallexample
6910
6911 @node FR-V Built-in Functions
6912 @subsection FR-V Built-in Functions
6913
6914 GCC provides many FR-V-specific built-in functions.  In general,
6915 these functions are intended to be compatible with those described
6916 by @cite{FR-V Family, Softune C/C++ Compiler Manual (V6), Fujitsu
6917 Semiconductor}.  The two exceptions are @code{__MDUNPACKH} and
6918 @code{__MBTOHE}, the gcc forms of which pass 128-bit values by
6919 pointer rather than by value.
6920
6921 Most of the functions are named after specific FR-V instructions.
6922 Such functions are said to be ``directly mapped'' and are summarized
6923 here in tabular form.
6924
6925 @menu
6926 * Argument Types::
6927 * Directly-mapped Integer Functions::
6928 * Directly-mapped Media Functions::
6929 * Raw read/write Functions::
6930 * Other Built-in Functions::
6931 @end menu
6932
6933 @node Argument Types
6934 @subsubsection Argument Types
6935
6936 The arguments to the built-in functions can be divided into three groups:
6937 register numbers, compile-time constants and run-time values.  In order
6938 to make this classification clear at a glance, the arguments and return
6939 values are given the following pseudo types:
6940
6941 @multitable @columnfractions .20 .30 .15 .35
6942 @item Pseudo type @tab Real C type @tab Constant? @tab Description
6943 @item @code{uh} @tab @code{unsigned short} @tab No @tab an unsigned halfword
6944 @item @code{uw1} @tab @code{unsigned int} @tab No @tab an unsigned word
6945 @item @code{sw1} @tab @code{int} @tab No @tab a signed word
6946 @item @code{uw2} @tab @code{unsigned long long} @tab No
6947 @tab an unsigned doubleword
6948 @item @code{sw2} @tab @code{long long} @tab No @tab a signed doubleword
6949 @item @code{const} @tab @code{int} @tab Yes @tab an integer constant
6950 @item @code{acc} @tab @code{int} @tab Yes @tab an ACC register number
6951 @item @code{iacc} @tab @code{int} @tab Yes @tab an IACC register number
6952 @end multitable
6953
6954 These pseudo types are not defined by GCC, they are simply a notational
6955 convenience used in this manual.
6956
6957 Arguments of type @code{uh}, @code{uw1}, @code{sw1}, @code{uw2}
6958 and @code{sw2} are evaluated at run time.  They correspond to
6959 register operands in the underlying FR-V instructions.
6960
6961 @code{const} arguments represent immediate operands in the underlying
6962 FR-V instructions.  They must be compile-time constants.
6963
6964 @code{acc} arguments are evaluated at compile time and specify the number
6965 of an accumulator register.  For example, an @code{acc} argument of 2
6966 will select the ACC2 register.
6967
6968 @code{iacc} arguments are similar to @code{acc} arguments but specify the
6969 number of an IACC register.  See @pxref{Other Built-in Functions}
6970 for more details.
6971
6972 @node Directly-mapped Integer Functions
6973 @subsubsection Directly-mapped Integer Functions
6974
6975 The functions listed below map directly to FR-V I-type instructions.
6976
6977 @multitable @columnfractions .45 .32 .23
6978 @item Function prototype @tab Example usage @tab Assembly output
6979 @item @code{sw1 __ADDSS (sw1, sw1)}
6980 @tab @code{@var{c} = __ADDSS (@var{a}, @var{b})}
6981 @tab @code{ADDSS @var{a},@var{b},@var{c}}
6982 @item @code{sw1 __SCAN (sw1, sw1)}
6983 @tab @code{@var{c} = __SCAN (@var{a}, @var{b})}
6984 @tab @code{SCAN @var{a},@var{b},@var{c}}
6985 @item @code{sw1 __SCUTSS (sw1)}
6986 @tab @code{@var{b} = __SCUTSS (@var{a})}
6987 @tab @code{SCUTSS @var{a},@var{b}}
6988 @item @code{sw1 __SLASS (sw1, sw1)}
6989 @tab @code{@var{c} = __SLASS (@var{a}, @var{b})}
6990 @tab @code{SLASS @var{a},@var{b},@var{c}}
6991 @item @code{void __SMASS (sw1, sw1)}
6992 @tab @code{__SMASS (@var{a}, @var{b})}
6993 @tab @code{SMASS @var{a},@var{b}}
6994 @item @code{void __SMSSS (sw1, sw1)}
6995 @tab @code{__SMSSS (@var{a}, @var{b})}
6996 @tab @code{SMSSS @var{a},@var{b}}
6997 @item @code{void __SMU (sw1, sw1)}
6998 @tab @code{__SMU (@var{a}, @var{b})}
6999 @tab @code{SMU @var{a},@var{b}}
7000 @item @code{sw2 __SMUL (sw1, sw1)}
7001 @tab @code{@var{c} = __SMUL (@var{a}, @var{b})}
7002 @tab @code{SMUL @var{a},@var{b},@var{c}}
7003 @item @code{sw1 __SUBSS (sw1, sw1)}
7004 @tab @code{@var{c} = __SUBSS (@var{a}, @var{b})}
7005 @tab @code{SUBSS @var{a},@var{b},@var{c}}
7006 @item @code{uw2 __UMUL (uw1, uw1)}
7007 @tab @code{@var{c} = __UMUL (@var{a}, @var{b})}
7008 @tab @code{UMUL @var{a},@var{b},@var{c}}
7009 @end multitable
7010
7011 @node Directly-mapped Media Functions
7012 @subsubsection Directly-mapped Media Functions
7013
7014 The functions listed below map directly to FR-V M-type instructions.
7015
7016 @multitable @columnfractions .45 .32 .23
7017 @item Function prototype @tab Example usage @tab Assembly output
7018 @item @code{uw1 __MABSHS (sw1)}
7019 @tab @code{@var{b} = __MABSHS (@var{a})}
7020 @tab @code{MABSHS @var{a},@var{b}}
7021 @item @code{void __MADDACCS (acc, acc)}
7022 @tab @code{__MADDACCS (@var{b}, @var{a})}
7023 @tab @code{MADDACCS @var{a},@var{b}}
7024 @item @code{sw1 __MADDHSS (sw1, sw1)}
7025 @tab @code{@var{c} = __MADDHSS (@var{a}, @var{b})}
7026 @tab @code{MADDHSS @var{a},@var{b},@var{c}}
7027 @item @code{uw1 __MADDHUS (uw1, uw1)}
7028 @tab @code{@var{c} = __MADDHUS (@var{a}, @var{b})}
7029 @tab @code{MADDHUS @var{a},@var{b},@var{c}}
7030 @item @code{uw1 __MAND (uw1, uw1)}
7031 @tab @code{@var{c} = __MAND (@var{a}, @var{b})}
7032 @tab @code{MAND @var{a},@var{b},@var{c}}
7033 @item @code{void __MASACCS (acc, acc)}
7034 @tab @code{__MASACCS (@var{b}, @var{a})}
7035 @tab @code{MASACCS @var{a},@var{b}}
7036 @item @code{uw1 __MAVEH (uw1, uw1)}
7037 @tab @code{@var{c} = __MAVEH (@var{a}, @var{b})}
7038 @tab @code{MAVEH @var{a},@var{b},@var{c}}
7039 @item @code{uw2 __MBTOH (uw1)}
7040 @tab @code{@var{b} = __MBTOH (@var{a})}
7041 @tab @code{MBTOH @var{a},@var{b}}
7042 @item @code{void __MBTOHE (uw1 *, uw1)}
7043 @tab @code{__MBTOHE (&@var{b}, @var{a})}
7044 @tab @code{MBTOHE @var{a},@var{b}}
7045 @item @code{void __MCLRACC (acc)}
7046 @tab @code{__MCLRACC (@var{a})}
7047 @tab @code{MCLRACC @var{a}}
7048 @item @code{void __MCLRACCA (void)}
7049 @tab @code{__MCLRACCA ()}
7050 @tab @code{MCLRACCA}
7051 @item @code{uw1 __Mcop1 (uw1, uw1)}
7052 @tab @code{@var{c} = __Mcop1 (@var{a}, @var{b})}
7053 @tab @code{Mcop1 @var{a},@var{b},@var{c}}
7054 @item @code{uw1 __Mcop2 (uw1, uw1)}
7055 @tab @code{@var{c} = __Mcop2 (@var{a}, @var{b})}
7056 @tab @code{Mcop2 @var{a},@var{b},@var{c}}
7057 @item @code{uw1 __MCPLHI (uw2, const)}
7058 @tab @code{@var{c} = __MCPLHI (@var{a}, @var{b})}
7059 @tab @code{MCPLHI @var{a},#@var{b},@var{c}}
7060 @item @code{uw1 __MCPLI (uw2, const)}
7061 @tab @code{@var{c} = __MCPLI (@var{a}, @var{b})}
7062 @tab @code{MCPLI @var{a},#@var{b},@var{c}}
7063 @item @code{void __MCPXIS (acc, sw1, sw1)}
7064 @tab @code{__MCPXIS (@var{c}, @var{a}, @var{b})}
7065 @tab @code{MCPXIS @var{a},@var{b},@var{c}}
7066 @item @code{void __MCPXIU (acc, uw1, uw1)}
7067 @tab @code{__MCPXIU (@var{c}, @var{a}, @var{b})}
7068 @tab @code{MCPXIU @var{a},@var{b},@var{c}}
7069 @item @code{void __MCPXRS (acc, sw1, sw1)}
7070 @tab @code{__MCPXRS (@var{c}, @var{a}, @var{b})}
7071 @tab @code{MCPXRS @var{a},@var{b},@var{c}}
7072 @item @code{void __MCPXRU (acc, uw1, uw1)}
7073 @tab @code{__MCPXRU (@var{c}, @var{a}, @var{b})}
7074 @tab @code{MCPXRU @var{a},@var{b},@var{c}}
7075 @item @code{uw1 __MCUT (acc, uw1)}
7076 @tab @code{@var{c} = __MCUT (@var{a}, @var{b})}
7077 @tab @code{MCUT @var{a},@var{b},@var{c}}
7078 @item @code{uw1 __MCUTSS (acc, sw1)}
7079 @tab @code{@var{c} = __MCUTSS (@var{a}, @var{b})}
7080 @tab @code{MCUTSS @var{a},@var{b},@var{c}}
7081 @item @code{void __MDADDACCS (acc, acc)}
7082 @tab @code{__MDADDACCS (@var{b}, @var{a})}
7083 @tab @code{MDADDACCS @var{a},@var{b}}
7084 @item @code{void __MDASACCS (acc, acc)}
7085 @tab @code{__MDASACCS (@var{b}, @var{a})}
7086 @tab @code{MDASACCS @var{a},@var{b}}
7087 @item @code{uw2 __MDCUTSSI (acc, const)}
7088 @tab @code{@var{c} = __MDCUTSSI (@var{a}, @var{b})}
7089 @tab @code{MDCUTSSI @var{a},#@var{b},@var{c}}
7090 @item @code{uw2 __MDPACKH (uw2, uw2)}
7091 @tab @code{@var{c} = __MDPACKH (@var{a}, @var{b})}
7092 @tab @code{MDPACKH @var{a},@var{b},@var{c}}
7093 @item @code{uw2 __MDROTLI (uw2, const)}
7094 @tab @code{@var{c} = __MDROTLI (@var{a}, @var{b})}
7095 @tab @code{MDROTLI @var{a},#@var{b},@var{c}}
7096 @item @code{void __MDSUBACCS (acc, acc)}
7097 @tab @code{__MDSUBACCS (@var{b}, @var{a})}
7098 @tab @code{MDSUBACCS @var{a},@var{b}}
7099 @item @code{void __MDUNPACKH (uw1 *, uw2)}
7100 @tab @code{__MDUNPACKH (&@var{b}, @var{a})}
7101 @tab @code{MDUNPACKH @var{a},@var{b}}
7102 @item @code{uw2 __MEXPDHD (uw1, const)}
7103 @tab @code{@var{c} = __MEXPDHD (@var{a}, @var{b})}
7104 @tab @code{MEXPDHD @var{a},#@var{b},@var{c}}
7105 @item @code{uw1 __MEXPDHW (uw1, const)}
7106 @tab @code{@var{c} = __MEXPDHW (@var{a}, @var{b})}
7107 @tab @code{MEXPDHW @var{a},#@var{b},@var{c}}
7108 @item @code{uw1 __MHDSETH (uw1, const)}
7109 @tab @code{@var{c} = __MHDSETH (@var{a}, @var{b})}
7110 @tab @code{MHDSETH @var{a},#@var{b},@var{c}}
7111 @item @code{sw1 __MHDSETS (const)}
7112 @tab @code{@var{b} = __MHDSETS (@var{a})}
7113 @tab @code{MHDSETS #@var{a},@var{b}}
7114 @item @code{uw1 __MHSETHIH (uw1, const)}
7115 @tab @code{@var{b} = __MHSETHIH (@var{b}, @var{a})}
7116 @tab @code{MHSETHIH #@var{a},@var{b}}
7117 @item @code{sw1 __MHSETHIS (sw1, const)}
7118 @tab @code{@var{b} = __MHSETHIS (@var{b}, @var{a})}
7119 @tab @code{MHSETHIS #@var{a},@var{b}}
7120 @item @code{uw1 __MHSETLOH (uw1, const)}
7121 @tab @code{@var{b} = __MHSETLOH (@var{b}, @var{a})}
7122 @tab @code{MHSETLOH #@var{a},@var{b}}
7123 @item @code{sw1 __MHSETLOS (sw1, const)}
7124 @tab @code{@var{b} = __MHSETLOS (@var{b}, @var{a})}
7125 @tab @code{MHSETLOS #@var{a},@var{b}}
7126 @item @code{uw1 __MHTOB (uw2)}
7127 @tab @code{@var{b} = __MHTOB (@var{a})}
7128 @tab @code{MHTOB @var{a},@var{b}}
7129 @item @code{void __MMACHS (acc, sw1, sw1)}
7130 @tab @code{__MMACHS (@var{c}, @var{a}, @var{b})}
7131 @tab @code{MMACHS @var{a},@var{b},@var{c}}
7132 @item @code{void __MMACHU (acc, uw1, uw1)}
7133 @tab @code{__MMACHU (@var{c}, @var{a}, @var{b})}
7134 @tab @code{MMACHU @var{a},@var{b},@var{c}}
7135 @item @code{void __MMRDHS (acc, sw1, sw1)}
7136 @tab @code{__MMRDHS (@var{c}, @var{a}, @var{b})}
7137 @tab @code{MMRDHS @var{a},@var{b},@var{c}}
7138 @item @code{void __MMRDHU (acc, uw1, uw1)}
7139 @tab @code{__MMRDHU (@var{c}, @var{a}, @var{b})}
7140 @tab @code{MMRDHU @var{a},@var{b},@var{c}}
7141 @item @code{void __MMULHS (acc, sw1, sw1)}
7142 @tab @code{__MMULHS (@var{c}, @var{a}, @var{b})}
7143 @tab @code{MMULHS @var{a},@var{b},@var{c}}
7144 @item @code{void __MMULHU (acc, uw1, uw1)}
7145 @tab @code{__MMULHU (@var{c}, @var{a}, @var{b})}
7146 @tab @code{MMULHU @var{a},@var{b},@var{c}}
7147 @item @code{void __MMULXHS (acc, sw1, sw1)}
7148 @tab @code{__MMULXHS (@var{c}, @var{a}, @var{b})}
7149 @tab @code{MMULXHS @var{a},@var{b},@var{c}}
7150 @item @code{void __MMULXHU (acc, uw1, uw1)}
7151 @tab @code{__MMULXHU (@var{c}, @var{a}, @var{b})}
7152 @tab @code{MMULXHU @var{a},@var{b},@var{c}}
7153 @item @code{uw1 __MNOT (uw1)}
7154 @tab @code{@var{b} = __MNOT (@var{a})}
7155 @tab @code{MNOT @var{a},@var{b}}
7156 @item @code{uw1 __MOR (uw1, uw1)}
7157 @tab @code{@var{c} = __MOR (@var{a}, @var{b})}
7158 @tab @code{MOR @var{a},@var{b},@var{c}}
7159 @item @code{uw1 __MPACKH (uh, uh)}
7160 @tab @code{@var{c} = __MPACKH (@var{a}, @var{b})}
7161 @tab @code{MPACKH @var{a},@var{b},@var{c}}
7162 @item @code{sw2 __MQADDHSS (sw2, sw2)}
7163 @tab @code{@var{c} = __MQADDHSS (@var{a}, @var{b})}
7164 @tab @code{MQADDHSS @var{a},@var{b},@var{c}}
7165 @item @code{uw2 __MQADDHUS (uw2, uw2)}
7166 @tab @code{@var{c} = __MQADDHUS (@var{a}, @var{b})}
7167 @tab @code{MQADDHUS @var{a},@var{b},@var{c}}
7168 @item @code{void __MQCPXIS (acc, sw2, sw2)}
7169 @tab @code{__MQCPXIS (@var{c}, @var{a}, @var{b})}
7170 @tab @code{MQCPXIS @var{a},@var{b},@var{c}}
7171 @item @code{void __MQCPXIU (acc, uw2, uw2)}
7172 @tab @code{__MQCPXIU (@var{c}, @var{a}, @var{b})}
7173 @tab @code{MQCPXIU @var{a},@var{b},@var{c}}
7174 @item @code{void __MQCPXRS (acc, sw2, sw2)}
7175 @tab @code{__MQCPXRS (@var{c}, @var{a}, @var{b})}
7176 @tab @code{MQCPXRS @var{a},@var{b},@var{c}}
7177 @item @code{void __MQCPXRU (acc, uw2, uw2)}
7178 @tab @code{__MQCPXRU (@var{c}, @var{a}, @var{b})}
7179 @tab @code{MQCPXRU @var{a},@var{b},@var{c}}
7180 @item @code{sw2 __MQLCLRHS (sw2, sw2)}
7181 @tab @code{@var{c} = __MQLCLRHS (@var{a}, @var{b})}
7182 @tab @code{MQLCLRHS @var{a},@var{b},@var{c}}
7183 @item @code{sw2 __MQLMTHS (sw2, sw2)}
7184 @tab @code{@var{c} = __MQLMTHS (@var{a}, @var{b})}
7185 @tab @code{MQLMTHS @var{a},@var{b},@var{c}}
7186 @item @code{void __MQMACHS (acc, sw2, sw2)}
7187 @tab @code{__MQMACHS (@var{c}, @var{a}, @var{b})}
7188 @tab @code{MQMACHS @var{a},@var{b},@var{c}}
7189 @item @code{void __MQMACHU (acc, uw2, uw2)}
7190 @tab @code{__MQMACHU (@var{c}, @var{a}, @var{b})}
7191 @tab @code{MQMACHU @var{a},@var{b},@var{c}}
7192 @item @code{void __MQMACXHS (acc, sw2, sw2)}
7193 @tab @code{__MQMACXHS (@var{c}, @var{a}, @var{b})}
7194 @tab @code{MQMACXHS @var{a},@var{b},@var{c}}
7195 @item @code{void __MQMULHS (acc, sw2, sw2)}
7196 @tab @code{__MQMULHS (@var{c}, @var{a}, @var{b})}
7197 @tab @code{MQMULHS @var{a},@var{b},@var{c}}
7198 @item @code{void __MQMULHU (acc, uw2, uw2)}
7199 @tab @code{__MQMULHU (@var{c}, @var{a}, @var{b})}
7200 @tab @code{MQMULHU @var{a},@var{b},@var{c}}
7201 @item @code{void __MQMULXHS (acc, sw2, sw2)}
7202 @tab @code{__MQMULXHS (@var{c}, @var{a}, @var{b})}
7203 @tab @code{MQMULXHS @var{a},@var{b},@var{c}}
7204 @item @code{void __MQMULXHU (acc, uw2, uw2)}
7205 @tab @code{__MQMULXHU (@var{c}, @var{a}, @var{b})}
7206 @tab @code{MQMULXHU @var{a},@var{b},@var{c}}
7207 @item @code{sw2 __MQSATHS (sw2, sw2)}
7208 @tab @code{@var{c} = __MQSATHS (@var{a}, @var{b})}
7209 @tab @code{MQSATHS @var{a},@var{b},@var{c}}
7210 @item @code{uw2 __MQSLLHI (uw2, int)}
7211 @tab @code{@var{c} = __MQSLLHI (@var{a}, @var{b})}
7212 @tab @code{MQSLLHI @var{a},@var{b},@var{c}}
7213 @item @code{sw2 __MQSRAHI (sw2, int)}
7214 @tab @code{@var{c} = __MQSRAHI (@var{a}, @var{b})}
7215 @tab @code{MQSRAHI @var{a},@var{b},@var{c}}
7216 @item @code{sw2 __MQSUBHSS (sw2, sw2)}
7217 @tab @code{@var{c} = __MQSUBHSS (@var{a}, @var{b})}
7218 @tab @code{MQSUBHSS @var{a},@var{b},@var{c}}
7219 @item @code{uw2 __MQSUBHUS (uw2, uw2)}
7220 @tab @code{@var{c} = __MQSUBHUS (@var{a}, @var{b})}
7221 @tab @code{MQSUBHUS @var{a},@var{b},@var{c}}
7222 @item @code{void __MQXMACHS (acc, sw2, sw2)}
7223 @tab @code{__MQXMACHS (@var{c}, @var{a}, @var{b})}
7224 @tab @code{MQXMACHS @var{a},@var{b},@var{c}}
7225 @item @code{void __MQXMACXHS (acc, sw2, sw2)}
7226 @tab @code{__MQXMACXHS (@var{c}, @var{a}, @var{b})}
7227 @tab @code{MQXMACXHS @var{a},@var{b},@var{c}}
7228 @item @code{uw1 __MRDACC (acc)}
7229 @tab @code{@var{b} = __MRDACC (@var{a})}
7230 @tab @code{MRDACC @var{a},@var{b}}
7231 @item @code{uw1 __MRDACCG (acc)}
7232 @tab @code{@var{b} = __MRDACCG (@var{a})}
7233 @tab @code{MRDACCG @var{a},@var{b}}
7234 @item @code{uw1 __MROTLI (uw1, const)}
7235 @tab @code{@var{c} = __MROTLI (@var{a}, @var{b})}
7236 @tab @code{MROTLI @var{a},#@var{b},@var{c}}
7237 @item @code{uw1 __MROTRI (uw1, const)}
7238 @tab @code{@var{c} = __MROTRI (@var{a}, @var{b})}
7239 @tab @code{MROTRI @var{a},#@var{b},@var{c}}
7240 @item @code{sw1 __MSATHS (sw1, sw1)}
7241 @tab @code{@var{c} = __MSATHS (@var{a}, @var{b})}
7242 @tab @code{MSATHS @var{a},@var{b},@var{c}}
7243 @item @code{uw1 __MSATHU (uw1, uw1)}
7244 @tab @code{@var{c} = __MSATHU (@var{a}, @var{b})}
7245 @tab @code{MSATHU @var{a},@var{b},@var{c}}
7246 @item @code{uw1 __MSLLHI (uw1, const)}
7247 @tab @code{@var{c} = __MSLLHI (@var{a}, @var{b})}
7248 @tab @code{MSLLHI @var{a},#@var{b},@var{c}}
7249 @item @code{sw1 __MSRAHI (sw1, const)}
7250 @tab @code{@var{c} = __MSRAHI (@var{a}, @var{b})}
7251 @tab @code{MSRAHI @var{a},#@var{b},@var{c}}
7252 @item @code{uw1 __MSRLHI (uw1, const)}
7253 @tab @code{@var{c} = __MSRLHI (@var{a}, @var{b})}
7254 @tab @code{MSRLHI @var{a},#@var{b},@var{c}}
7255 @item @code{void __MSUBACCS (acc, acc)}
7256 @tab @code{__MSUBACCS (@var{b}, @var{a})}
7257 @tab @code{MSUBACCS @var{a},@var{b}}
7258 @item @code{sw1 __MSUBHSS (sw1, sw1)}
7259 @tab @code{@var{c} = __MSUBHSS (@var{a}, @var{b})}
7260 @tab @code{MSUBHSS @var{a},@var{b},@var{c}}
7261 @item @code{uw1 __MSUBHUS (uw1, uw1)}
7262 @tab @code{@var{c} = __MSUBHUS (@var{a}, @var{b})}
7263 @tab @code{MSUBHUS @var{a},@var{b},@var{c}}
7264 @item @code{void __MTRAP (void)}
7265 @tab @code{__MTRAP ()}
7266 @tab @code{MTRAP}
7267 @item @code{uw2 __MUNPACKH (uw1)}
7268 @tab @code{@var{b} = __MUNPACKH (@var{a})}
7269 @tab @code{MUNPACKH @var{a},@var{b}}
7270 @item @code{uw1 __MWCUT (uw2, uw1)}
7271 @tab @code{@var{c} = __MWCUT (@var{a}, @var{b})}
7272 @tab @code{MWCUT @var{a},@var{b},@var{c}}
7273 @item @code{void __MWTACC (acc, uw1)}
7274 @tab @code{__MWTACC (@var{b}, @var{a})}
7275 @tab @code{MWTACC @var{a},@var{b}}
7276 @item @code{void __MWTACCG (acc, uw1)}
7277 @tab @code{__MWTACCG (@var{b}, @var{a})}
7278 @tab @code{MWTACCG @var{a},@var{b}}
7279 @item @code{uw1 __MXOR (uw1, uw1)}
7280 @tab @code{@var{c} = __MXOR (@var{a}, @var{b})}
7281 @tab @code{MXOR @var{a},@var{b},@var{c}}
7282 @end multitable
7283
7284 @node Raw read/write Functions
7285 @subsubsection Raw read/write Functions
7286
7287 This sections describes built-in functions related to read and write
7288 instructions to access memory.  These functions generate
7289 @code{membar} instructions to flush the I/O load and stores where
7290 appropriate, as described in Fujitsu's manual described above.
7291
7292 @table @code
7293
7294 @item unsigned char __builtin_read8 (void *@var{data})
7295 @item unsigned short __builtin_read16 (void *@var{data})
7296 @item unsigned long __builtin_read32 (void *@var{data})
7297 @item unsigned long long __builtin_read64 (void *@var{data})
7298
7299 @item void __builtin_write8 (void *@var{data}, unsigned char @var{datum})
7300 @item void __builtin_write16 (void *@var{data}, unsigned short @var{datum})
7301 @item void __builtin_write32 (void *@var{data}, unsigned long @var{datum})
7302 @item void __builtin_write64 (void *@var{data}, unsigned long long @var{datum})
7303 @end table
7304
7305 @node Other Built-in Functions
7306 @subsubsection Other Built-in Functions
7307
7308 This section describes built-in functions that are not named after
7309 a specific FR-V instruction.
7310
7311 @table @code
7312 @item sw2 __IACCreadll (iacc @var{reg})
7313 Return the full 64-bit value of IACC0@.  The @var{reg} argument is reserved
7314 for future expansion and must be 0.
7315
7316 @item sw1 __IACCreadl (iacc @var{reg})
7317 Return the value of IACC0H if @var{reg} is 0 and IACC0L if @var{reg} is 1.
7318 Other values of @var{reg} are rejected as invalid.
7319
7320 @item void __IACCsetll (iacc @var{reg}, sw2 @var{x})
7321 Set the full 64-bit value of IACC0 to @var{x}.  The @var{reg} argument
7322 is reserved for future expansion and must be 0.
7323
7324 @item void __IACCsetl (iacc @var{reg}, sw1 @var{x})
7325 Set IACC0H to @var{x} if @var{reg} is 0 and IACC0L to @var{x} if @var{reg}
7326 is 1.  Other values of @var{reg} are rejected as invalid.
7327
7328 @item void __data_prefetch0 (const void *@var{x})
7329 Use the @code{dcpl} instruction to load the contents of address @var{x}
7330 into the data cache.
7331
7332 @item void __data_prefetch (const void *@var{x})
7333 Use the @code{nldub} instruction to load the contents of address @var{x}
7334 into the data cache.  The instruction will be issued in slot I1@.
7335 @end table
7336
7337 @node X86 Built-in Functions
7338 @subsection X86 Built-in Functions
7339
7340 These built-in functions are available for the i386 and x86-64 family
7341 of computers, depending on the command-line switches used.
7342
7343 Note that, if you specify command-line switches such as @option{-msse},
7344 the compiler could use the extended instruction sets even if the built-ins
7345 are not used explicitly in the program.  For this reason, applications
7346 which perform runtime CPU detection must compile separate files for each
7347 supported architecture, using the appropriate flags.  In particular,
7348 the file containing the CPU detection code should be compiled without
7349 these options.
7350
7351 The following machine modes are available for use with MMX built-in functions
7352 (@pxref{Vector Extensions}): @code{V2SI} for a vector of two 32-bit integers,
7353 @code{V4HI} for a vector of four 16-bit integers, and @code{V8QI} for a
7354 vector of eight 8-bit integers.  Some of the built-in functions operate on
7355 MMX registers as a whole 64-bit entity, these use @code{DI} as their mode.
7356
7357 If 3Dnow extensions are enabled, @code{V2SF} is used as a mode for a vector
7358 of two 32-bit floating point values.
7359
7360 If SSE extensions are enabled, @code{V4SF} is used for a vector of four 32-bit
7361 floating point values.  Some instructions use a vector of four 32-bit
7362 integers, these use @code{V4SI}.  Finally, some instructions operate on an
7363 entire vector register, interpreting it as a 128-bit integer, these use mode
7364 @code{TI}.
7365
7366 In the 64-bit mode, x86-64 family of processors uses additional built-in
7367 functions for efficient use of @code{TF} (@code{__float128}) 128-bit
7368 floating point and @code{TC} 128-bit complex floating point values.
7369
7370 The following floating point built-in functions are made available in the
7371 64-bit mode.  All of them implement the function that is part of the name.
7372
7373 @smallexample
7374 __float128 __builtin_fabsq (__float128)
7375 __float128 __builtin_copysignq (__float128, __float128)
7376 @end smallexample
7377
7378 The following floating point built-in functions are made available in the
7379 64-bit mode.
7380
7381 @table @code
7382 @item __float128 __builtin_infq (void)
7383 Similar to @code{__builtin_inf}, except the return type is @code{__float128}.
7384 @end table
7385
7386 The following built-in functions are made available by @option{-mmmx}.
7387 All of them generate the machine instruction that is part of the name.
7388
7389 @smallexample
7390 v8qi __builtin_ia32_paddb (v8qi, v8qi)
7391 v4hi __builtin_ia32_paddw (v4hi, v4hi)
7392 v2si __builtin_ia32_paddd (v2si, v2si)
7393 v8qi __builtin_ia32_psubb (v8qi, v8qi)
7394 v4hi __builtin_ia32_psubw (v4hi, v4hi)
7395 v2si __builtin_ia32_psubd (v2si, v2si)
7396 v8qi __builtin_ia32_paddsb (v8qi, v8qi)
7397 v4hi __builtin_ia32_paddsw (v4hi, v4hi)
7398 v8qi __builtin_ia32_psubsb (v8qi, v8qi)
7399 v4hi __builtin_ia32_psubsw (v4hi, v4hi)
7400 v8qi __builtin_ia32_paddusb (v8qi, v8qi)
7401 v4hi __builtin_ia32_paddusw (v4hi, v4hi)
7402 v8qi __builtin_ia32_psubusb (v8qi, v8qi)
7403 v4hi __builtin_ia32_psubusw (v4hi, v4hi)
7404 v4hi __builtin_ia32_pmullw (v4hi, v4hi)
7405 v4hi __builtin_ia32_pmulhw (v4hi, v4hi)
7406 di __builtin_ia32_pand (di, di)
7407 di __builtin_ia32_pandn (di,di)
7408 di __builtin_ia32_por (di, di)
7409 di __builtin_ia32_pxor (di, di)
7410 v8qi __builtin_ia32_pcmpeqb (v8qi, v8qi)
7411 v4hi __builtin_ia32_pcmpeqw (v4hi, v4hi)
7412 v2si __builtin_ia32_pcmpeqd (v2si, v2si)
7413 v8qi __builtin_ia32_pcmpgtb (v8qi, v8qi)
7414 v4hi __builtin_ia32_pcmpgtw (v4hi, v4hi)
7415 v2si __builtin_ia32_pcmpgtd (v2si, v2si)
7416 v8qi __builtin_ia32_punpckhbw (v8qi, v8qi)
7417 v4hi __builtin_ia32_punpckhwd (v4hi, v4hi)
7418 v2si __builtin_ia32_punpckhdq (v2si, v2si)
7419 v8qi __builtin_ia32_punpcklbw (v8qi, v8qi)
7420 v4hi __builtin_ia32_punpcklwd (v4hi, v4hi)
7421 v2si __builtin_ia32_punpckldq (v2si, v2si)
7422 v8qi __builtin_ia32_packsswb (v4hi, v4hi)
7423 v4hi __builtin_ia32_packssdw (v2si, v2si)
7424 v8qi __builtin_ia32_packuswb (v4hi, v4hi)
7425 @end smallexample
7426
7427 The following built-in functions are made available either with
7428 @option{-msse}, or with a combination of @option{-m3dnow} and
7429 @option{-march=athlon}.  All of them generate the machine
7430 instruction that is part of the name.
7431
7432 @smallexample
7433 v4hi __builtin_ia32_pmulhuw (v4hi, v4hi)
7434 v8qi __builtin_ia32_pavgb (v8qi, v8qi)
7435 v4hi __builtin_ia32_pavgw (v4hi, v4hi)
7436 v4hi __builtin_ia32_psadbw (v8qi, v8qi)
7437 v8qi __builtin_ia32_pmaxub (v8qi, v8qi)
7438 v4hi __builtin_ia32_pmaxsw (v4hi, v4hi)
7439 v8qi __builtin_ia32_pminub (v8qi, v8qi)
7440 v4hi __builtin_ia32_pminsw (v4hi, v4hi)
7441 int __builtin_ia32_pextrw (v4hi, int)
7442 v4hi __builtin_ia32_pinsrw (v4hi, int, int)
7443 int __builtin_ia32_pmovmskb (v8qi)
7444 void __builtin_ia32_maskmovq (v8qi, v8qi, char *)
7445 void __builtin_ia32_movntq (di *, di)
7446 void __builtin_ia32_sfence (void)
7447 @end smallexample
7448
7449 The following built-in functions are available when @option{-msse} is used.
7450 All of them generate the machine instruction that is part of the name.
7451
7452 @smallexample
7453 int __builtin_ia32_comieq (v4sf, v4sf)
7454 int __builtin_ia32_comineq (v4sf, v4sf)
7455 int __builtin_ia32_comilt (v4sf, v4sf)
7456 int __builtin_ia32_comile (v4sf, v4sf)
7457 int __builtin_ia32_comigt (v4sf, v4sf)
7458 int __builtin_ia32_comige (v4sf, v4sf)
7459 int __builtin_ia32_ucomieq (v4sf, v4sf)
7460 int __builtin_ia32_ucomineq (v4sf, v4sf)
7461 int __builtin_ia32_ucomilt (v4sf, v4sf)
7462 int __builtin_ia32_ucomile (v4sf, v4sf)
7463 int __builtin_ia32_ucomigt (v4sf, v4sf)
7464 int __builtin_ia32_ucomige (v4sf, v4sf)
7465 v4sf __builtin_ia32_addps (v4sf, v4sf)
7466 v4sf __builtin_ia32_subps (v4sf, v4sf)
7467 v4sf __builtin_ia32_mulps (v4sf, v4sf)
7468 v4sf __builtin_ia32_divps (v4sf, v4sf)
7469 v4sf __builtin_ia32_addss (v4sf, v4sf)
7470 v4sf __builtin_ia32_subss (v4sf, v4sf)
7471 v4sf __builtin_ia32_mulss (v4sf, v4sf)
7472 v4sf __builtin_ia32_divss (v4sf, v4sf)
7473 v4si __builtin_ia32_cmpeqps (v4sf, v4sf)
7474 v4si __builtin_ia32_cmpltps (v4sf, v4sf)
7475 v4si __builtin_ia32_cmpleps (v4sf, v4sf)
7476 v4si __builtin_ia32_cmpgtps (v4sf, v4sf)
7477 v4si __builtin_ia32_cmpgeps (v4sf, v4sf)
7478 v4si __builtin_ia32_cmpunordps (v4sf, v4sf)
7479 v4si __builtin_ia32_cmpneqps (v4sf, v4sf)
7480 v4si __builtin_ia32_cmpnltps (v4sf, v4sf)
7481 v4si __builtin_ia32_cmpnleps (v4sf, v4sf)
7482 v4si __builtin_ia32_cmpngtps (v4sf, v4sf)
7483 v4si __builtin_ia32_cmpngeps (v4sf, v4sf)
7484 v4si __builtin_ia32_cmpordps (v4sf, v4sf)
7485 v4si __builtin_ia32_cmpeqss (v4sf, v4sf)
7486 v4si __builtin_ia32_cmpltss (v4sf, v4sf)
7487 v4si __builtin_ia32_cmpless (v4sf, v4sf)
7488 v4si __builtin_ia32_cmpunordss (v4sf, v4sf)
7489 v4si __builtin_ia32_cmpneqss (v4sf, v4sf)
7490 v4si __builtin_ia32_cmpnlts (v4sf, v4sf)
7491 v4si __builtin_ia32_cmpnless (v4sf, v4sf)
7492 v4si __builtin_ia32_cmpordss (v4sf, v4sf)
7493 v4sf __builtin_ia32_maxps (v4sf, v4sf)
7494 v4sf __builtin_ia32_maxss (v4sf, v4sf)
7495 v4sf __builtin_ia32_minps (v4sf, v4sf)
7496 v4sf __builtin_ia32_minss (v4sf, v4sf)
7497 v4sf __builtin_ia32_andps (v4sf, v4sf)
7498 v4sf __builtin_ia32_andnps (v4sf, v4sf)
7499 v4sf __builtin_ia32_orps (v4sf, v4sf)
7500 v4sf __builtin_ia32_xorps (v4sf, v4sf)
7501 v4sf __builtin_ia32_movss (v4sf, v4sf)
7502 v4sf __builtin_ia32_movhlps (v4sf, v4sf)
7503 v4sf __builtin_ia32_movlhps (v4sf, v4sf)
7504 v4sf __builtin_ia32_unpckhps (v4sf, v4sf)
7505 v4sf __builtin_ia32_unpcklps (v4sf, v4sf)
7506 v4sf __builtin_ia32_cvtpi2ps (v4sf, v2si)
7507 v4sf __builtin_ia32_cvtsi2ss (v4sf, int)
7508 v2si __builtin_ia32_cvtps2pi (v4sf)
7509 int __builtin_ia32_cvtss2si (v4sf)
7510 v2si __builtin_ia32_cvttps2pi (v4sf)
7511 int __builtin_ia32_cvttss2si (v4sf)
7512 v4sf __builtin_ia32_rcpps (v4sf)
7513 v4sf __builtin_ia32_rsqrtps (v4sf)
7514 v4sf __builtin_ia32_sqrtps (v4sf)
7515 v4sf __builtin_ia32_rcpss (v4sf)
7516 v4sf __builtin_ia32_rsqrtss (v4sf)
7517 v4sf __builtin_ia32_sqrtss (v4sf)
7518 v4sf __builtin_ia32_shufps (v4sf, v4sf, int)
7519 void __builtin_ia32_movntps (float *, v4sf)
7520 int __builtin_ia32_movmskps (v4sf)
7521 @end smallexample
7522
7523 The following built-in functions are available when @option{-msse} is used.
7524
7525 @table @code
7526 @item v4sf __builtin_ia32_loadaps (float *)
7527 Generates the @code{movaps} machine instruction as a load from memory.
7528 @item void __builtin_ia32_storeaps (float *, v4sf)
7529 Generates the @code{movaps} machine instruction as a store to memory.
7530 @item v4sf __builtin_ia32_loadups (float *)
7531 Generates the @code{movups} machine instruction as a load from memory.
7532 @item void __builtin_ia32_storeups (float *, v4sf)
7533 Generates the @code{movups} machine instruction as a store to memory.
7534 @item v4sf __builtin_ia32_loadsss (float *)
7535 Generates the @code{movss} machine instruction as a load from memory.
7536 @item void __builtin_ia32_storess (float *, v4sf)
7537 Generates the @code{movss} machine instruction as a store to memory.
7538 @item v4sf __builtin_ia32_loadhps (v4sf, v2si *)
7539 Generates the @code{movhps} machine instruction as a load from memory.
7540 @item v4sf __builtin_ia32_loadlps (v4sf, v2si *)
7541 Generates the @code{movlps} machine instruction as a load from memory
7542 @item void __builtin_ia32_storehps (v4sf, v2si *)
7543 Generates the @code{movhps} machine instruction as a store to memory.
7544 @item void __builtin_ia32_storelps (v4sf, v2si *)
7545 Generates the @code{movlps} machine instruction as a store to memory.
7546 @end table
7547
7548 The following built-in functions are available when @option{-msse2} is used.
7549 All of them generate the machine instruction that is part of the name.
7550
7551 @smallexample
7552 int __builtin_ia32_comisdeq (v2df, v2df)
7553 int __builtin_ia32_comisdlt (v2df, v2df)
7554 int __builtin_ia32_comisdle (v2df, v2df)
7555 int __builtin_ia32_comisdgt (v2df, v2df)
7556 int __builtin_ia32_comisdge (v2df, v2df)
7557 int __builtin_ia32_comisdneq (v2df, v2df)
7558 int __builtin_ia32_ucomisdeq (v2df, v2df)
7559 int __builtin_ia32_ucomisdlt (v2df, v2df)
7560 int __builtin_ia32_ucomisdle (v2df, v2df)
7561 int __builtin_ia32_ucomisdgt (v2df, v2df)
7562 int __builtin_ia32_ucomisdge (v2df, v2df)
7563 int __builtin_ia32_ucomisdneq (v2df, v2df)
7564 v2df __builtin_ia32_cmpeqpd (v2df, v2df)
7565 v2df __builtin_ia32_cmpltpd (v2df, v2df)
7566 v2df __builtin_ia32_cmplepd (v2df, v2df)
7567 v2df __builtin_ia32_cmpgtpd (v2df, v2df)
7568 v2df __builtin_ia32_cmpgepd (v2df, v2df)
7569 v2df __builtin_ia32_cmpunordpd (v2df, v2df)
7570 v2df __builtin_ia32_cmpneqpd (v2df, v2df)
7571 v2df __builtin_ia32_cmpnltpd (v2df, v2df)
7572 v2df __builtin_ia32_cmpnlepd (v2df, v2df)
7573 v2df __builtin_ia32_cmpngtpd (v2df, v2df)
7574 v2df __builtin_ia32_cmpngepd (v2df, v2df)
7575 v2df __builtin_ia32_cmpordpd (v2df, v2df)
7576 v2df __builtin_ia32_cmpeqsd (v2df, v2df)
7577 v2df __builtin_ia32_cmpltsd (v2df, v2df)
7578 v2df __builtin_ia32_cmplesd (v2df, v2df)
7579 v2df __builtin_ia32_cmpunordsd (v2df, v2df)
7580 v2df __builtin_ia32_cmpneqsd (v2df, v2df)
7581 v2df __builtin_ia32_cmpnltsd (v2df, v2df)
7582 v2df __builtin_ia32_cmpnlesd (v2df, v2df)
7583 v2df __builtin_ia32_cmpordsd (v2df, v2df)
7584 v2di __builtin_ia32_paddq (v2di, v2di)
7585 v2di __builtin_ia32_psubq (v2di, v2di)
7586 v2df __builtin_ia32_addpd (v2df, v2df)
7587 v2df __builtin_ia32_subpd (v2df, v2df)
7588 v2df __builtin_ia32_mulpd (v2df, v2df)
7589 v2df __builtin_ia32_divpd (v2df, v2df)
7590 v2df __builtin_ia32_addsd (v2df, v2df)
7591 v2df __builtin_ia32_subsd (v2df, v2df)
7592 v2df __builtin_ia32_mulsd (v2df, v2df)
7593 v2df __builtin_ia32_divsd (v2df, v2df)
7594 v2df __builtin_ia32_minpd (v2df, v2df)
7595 v2df __builtin_ia32_maxpd (v2df, v2df)
7596 v2df __builtin_ia32_minsd (v2df, v2df)
7597 v2df __builtin_ia32_maxsd (v2df, v2df)
7598 v2df __builtin_ia32_andpd (v2df, v2df)
7599 v2df __builtin_ia32_andnpd (v2df, v2df)
7600 v2df __builtin_ia32_orpd (v2df, v2df)
7601 v2df __builtin_ia32_xorpd (v2df, v2df)
7602 v2df __builtin_ia32_movsd (v2df, v2df)
7603 v2df __builtin_ia32_unpckhpd (v2df, v2df)
7604 v2df __builtin_ia32_unpcklpd (v2df, v2df)
7605 v16qi __builtin_ia32_paddb128 (v16qi, v16qi)
7606 v8hi __builtin_ia32_paddw128 (v8hi, v8hi)
7607 v4si __builtin_ia32_paddd128 (v4si, v4si)
7608 v2di __builtin_ia32_paddq128 (v2di, v2di)
7609 v16qi __builtin_ia32_psubb128 (v16qi, v16qi)
7610 v8hi __builtin_ia32_psubw128 (v8hi, v8hi)
7611 v4si __builtin_ia32_psubd128 (v4si, v4si)
7612 v2di __builtin_ia32_psubq128 (v2di, v2di)
7613 v8hi __builtin_ia32_pmullw128 (v8hi, v8hi)
7614 v8hi __builtin_ia32_pmulhw128 (v8hi, v8hi)
7615 v2di __builtin_ia32_pand128 (v2di, v2di)
7616 v2di __builtin_ia32_pandn128 (v2di, v2di)
7617 v2di __builtin_ia32_por128 (v2di, v2di)
7618 v2di __builtin_ia32_pxor128 (v2di, v2di)
7619 v16qi __builtin_ia32_pavgb128 (v16qi, v16qi)
7620 v8hi __builtin_ia32_pavgw128 (v8hi, v8hi)
7621 v16qi __builtin_ia32_pcmpeqb128 (v16qi, v16qi)
7622 v8hi __builtin_ia32_pcmpeqw128 (v8hi, v8hi)
7623 v4si __builtin_ia32_pcmpeqd128 (v4si, v4si)
7624 v16qi __builtin_ia32_pcmpgtb128 (v16qi, v16qi)
7625 v8hi __builtin_ia32_pcmpgtw128 (v8hi, v8hi)
7626 v4si __builtin_ia32_pcmpgtd128 (v4si, v4si)
7627 v16qi __builtin_ia32_pmaxub128 (v16qi, v16qi)
7628 v8hi __builtin_ia32_pmaxsw128 (v8hi, v8hi)
7629 v16qi __builtin_ia32_pminub128 (v16qi, v16qi)
7630 v8hi __builtin_ia32_pminsw128 (v8hi, v8hi)
7631 v16qi __builtin_ia32_punpckhbw128 (v16qi, v16qi)
7632 v8hi __builtin_ia32_punpckhwd128 (v8hi, v8hi)
7633 v4si __builtin_ia32_punpckhdq128 (v4si, v4si)
7634 v2di __builtin_ia32_punpckhqdq128 (v2di, v2di)
7635 v16qi __builtin_ia32_punpcklbw128 (v16qi, v16qi)
7636 v8hi __builtin_ia32_punpcklwd128 (v8hi, v8hi)
7637 v4si __builtin_ia32_punpckldq128 (v4si, v4si)
7638 v2di __builtin_ia32_punpcklqdq128 (v2di, v2di)
7639 v16qi __builtin_ia32_packsswb128 (v16qi, v16qi)
7640 v8hi __builtin_ia32_packssdw128 (v8hi, v8hi)
7641 v16qi __builtin_ia32_packuswb128 (v16qi, v16qi)
7642 v8hi __builtin_ia32_pmulhuw128 (v8hi, v8hi)
7643 void __builtin_ia32_maskmovdqu (v16qi, v16qi)
7644 v2df __builtin_ia32_loadupd (double *)
7645 void __builtin_ia32_storeupd (double *, v2df)
7646 v2df __builtin_ia32_loadhpd (v2df, double *)
7647 v2df __builtin_ia32_loadlpd (v2df, double *)
7648 int __builtin_ia32_movmskpd (v2df)
7649 int __builtin_ia32_pmovmskb128 (v16qi)
7650 void __builtin_ia32_movnti (int *, int)
7651 void __builtin_ia32_movntpd (double *, v2df)
7652 void __builtin_ia32_movntdq (v2df *, v2df)
7653 v4si __builtin_ia32_pshufd (v4si, int)
7654 v8hi __builtin_ia32_pshuflw (v8hi, int)
7655 v8hi __builtin_ia32_pshufhw (v8hi, int)
7656 v2di __builtin_ia32_psadbw128 (v16qi, v16qi)
7657 v2df __builtin_ia32_sqrtpd (v2df)
7658 v2df __builtin_ia32_sqrtsd (v2df)
7659 v2df __builtin_ia32_shufpd (v2df, v2df, int)
7660 v2df __builtin_ia32_cvtdq2pd (v4si)
7661 v4sf __builtin_ia32_cvtdq2ps (v4si)
7662 v4si __builtin_ia32_cvtpd2dq (v2df)
7663 v2si __builtin_ia32_cvtpd2pi (v2df)
7664 v4sf __builtin_ia32_cvtpd2ps (v2df)
7665 v4si __builtin_ia32_cvttpd2dq (v2df)
7666 v2si __builtin_ia32_cvttpd2pi (v2df)
7667 v2df __builtin_ia32_cvtpi2pd (v2si)
7668 int __builtin_ia32_cvtsd2si (v2df)
7669 int __builtin_ia32_cvttsd2si (v2df)
7670 long long __builtin_ia32_cvtsd2si64 (v2df)
7671 long long __builtin_ia32_cvttsd2si64 (v2df)
7672 v4si __builtin_ia32_cvtps2dq (v4sf)
7673 v2df __builtin_ia32_cvtps2pd (v4sf)
7674 v4si __builtin_ia32_cvttps2dq (v4sf)
7675 v2df __builtin_ia32_cvtsi2sd (v2df, int)
7676 v2df __builtin_ia32_cvtsi642sd (v2df, long long)
7677 v4sf __builtin_ia32_cvtsd2ss (v4sf, v2df)
7678 v2df __builtin_ia32_cvtss2sd (v2df, v4sf)
7679 void __builtin_ia32_clflush (const void *)
7680 void __builtin_ia32_lfence (void)
7681 void __builtin_ia32_mfence (void)
7682 v16qi __builtin_ia32_loaddqu (const char *)
7683 void __builtin_ia32_storedqu (char *, v16qi)
7684 unsigned long long __builtin_ia32_pmuludq (v2si, v2si)
7685 v2di __builtin_ia32_pmuludq128 (v4si, v4si)
7686 v8hi __builtin_ia32_psllw128 (v8hi, v2di)
7687 v4si __builtin_ia32_pslld128 (v4si, v2di)
7688 v2di __builtin_ia32_psllq128 (v4si, v2di)
7689 v8hi __builtin_ia32_psrlw128 (v8hi, v2di)
7690 v4si __builtin_ia32_psrld128 (v4si, v2di)
7691 v2di __builtin_ia32_psrlq128 (v2di, v2di)
7692 v8hi __builtin_ia32_psraw128 (v8hi, v2di)
7693 v4si __builtin_ia32_psrad128 (v4si, v2di)
7694 v2di __builtin_ia32_pslldqi128 (v2di, int)
7695 v8hi __builtin_ia32_psllwi128 (v8hi, int)
7696 v4si __builtin_ia32_pslldi128 (v4si, int)
7697 v2di __builtin_ia32_psllqi128 (v2di, int)
7698 v2di __builtin_ia32_psrldqi128 (v2di, int)
7699 v8hi __builtin_ia32_psrlwi128 (v8hi, int)
7700 v4si __builtin_ia32_psrldi128 (v4si, int)
7701 v2di __builtin_ia32_psrlqi128 (v2di, int)
7702 v8hi __builtin_ia32_psrawi128 (v8hi, int)
7703 v4si __builtin_ia32_psradi128 (v4si, int)
7704 v4si __builtin_ia32_pmaddwd128 (v8hi, v8hi)
7705 @end smallexample
7706
7707 The following built-in functions are available when @option{-msse3} is used.
7708 All of them generate the machine instruction that is part of the name.
7709
7710 @smallexample
7711 v2df __builtin_ia32_addsubpd (v2df, v2df)
7712 v4sf __builtin_ia32_addsubps (v4sf, v4sf)
7713 v2df __builtin_ia32_haddpd (v2df, v2df)
7714 v4sf __builtin_ia32_haddps (v4sf, v4sf)
7715 v2df __builtin_ia32_hsubpd (v2df, v2df)
7716 v4sf __builtin_ia32_hsubps (v4sf, v4sf)
7717 v16qi __builtin_ia32_lddqu (char const *)
7718 void __builtin_ia32_monitor (void *, unsigned int, unsigned int)
7719 v2df __builtin_ia32_movddup (v2df)
7720 v4sf __builtin_ia32_movshdup (v4sf)
7721 v4sf __builtin_ia32_movsldup (v4sf)
7722 void __builtin_ia32_mwait (unsigned int, unsigned int)
7723 @end smallexample
7724
7725 The following built-in functions are available when @option{-msse3} is used.
7726
7727 @table @code
7728 @item v2df __builtin_ia32_loadddup (double const *)
7729 Generates the @code{movddup} machine instruction as a load from memory.
7730 @end table
7731
7732 The following built-in functions are available when @option{-mssse3} is used.
7733 All of them generate the machine instruction that is part of the name
7734 with MMX registers.
7735
7736 @smallexample
7737 v2si __builtin_ia32_phaddd (v2si, v2si)
7738 v4hi __builtin_ia32_phaddw (v4hi, v4hi)
7739 v4hi __builtin_ia32_phaddsw (v4hi, v4hi)
7740 v2si __builtin_ia32_phsubd (v2si, v2si)
7741 v4hi __builtin_ia32_phsubw (v4hi, v4hi)
7742 v4hi __builtin_ia32_phsubsw (v4hi, v4hi)
7743 v8qi __builtin_ia32_pmaddubsw (v8qi, v8qi)
7744 v4hi __builtin_ia32_pmulhrsw (v4hi, v4hi)
7745 v8qi __builtin_ia32_pshufb (v8qi, v8qi)
7746 v8qi __builtin_ia32_psignb (v8qi, v8qi)
7747 v2si __builtin_ia32_psignd (v2si, v2si)
7748 v4hi __builtin_ia32_psignw (v4hi, v4hi)
7749 long long __builtin_ia32_palignr (long long, long long, int)
7750 v8qi __builtin_ia32_pabsb (v8qi)
7751 v2si __builtin_ia32_pabsd (v2si)
7752 v4hi __builtin_ia32_pabsw (v4hi)
7753 @end smallexample
7754
7755 The following built-in functions are available when @option{-mssse3} is used.
7756 All of them generate the machine instruction that is part of the name
7757 with SSE registers.
7758
7759 @smallexample
7760 v4si __builtin_ia32_phaddd128 (v4si, v4si)
7761 v8hi __builtin_ia32_phaddw128 (v8hi, v8hi)
7762 v8hi __builtin_ia32_phaddsw128 (v8hi, v8hi)
7763 v4si __builtin_ia32_phsubd128 (v4si, v4si)
7764 v8hi __builtin_ia32_phsubw128 (v8hi, v8hi)
7765 v8hi __builtin_ia32_phsubsw128 (v8hi, v8hi)
7766 v16qi __builtin_ia32_pmaddubsw128 (v16qi, v16qi)
7767 v8hi __builtin_ia32_pmulhrsw128 (v8hi, v8hi)
7768 v16qi __builtin_ia32_pshufb128 (v16qi, v16qi)
7769 v16qi __builtin_ia32_psignb128 (v16qi, v16qi)
7770 v4si __builtin_ia32_psignd128 (v4si, v4si)
7771 v8hi __builtin_ia32_psignw128 (v8hi, v8hi)
7772 v2di __builtin_ia32_palignr (v2di, v2di, int)
7773 v16qi __builtin_ia32_pabsb128 (v16qi)
7774 v4si __builtin_ia32_pabsd128 (v4si)
7775 v8hi __builtin_ia32_pabsw128 (v8hi)
7776 @end smallexample
7777
7778 The following built-in functions are available when @option{-msse4.1} is
7779 used.  All of them generate the machine instruction that is part of the
7780 name.
7781
7782 @smallexample
7783 v2df __builtin_ia32_blendpd (v2df, v2df, const int)
7784 v4sf __builtin_ia32_blendps (v4sf, v4sf, const int)
7785 v2df __builtin_ia32_blendvpd (v2df, v2df, v2df)
7786 v4sf __builtin_ia32_blendvps (v4sf, v4sf, v4sf)
7787 v2df __builtin_ia32_dppd (v2df, v2df, const int)
7788 v4sf __builtin_ia32_dpps (v4sf, v4sf, const int)
7789 v4sf __builtin_ia32_insertps128 (v4sf, v4sf, const int)
7790 v2di __builtin_ia32_movntdqa (v2di *);
7791 v16qi __builtin_ia32_mpsadbw128 (v16qi, v16qi, const int)
7792 v8hi __builtin_ia32_packusdw128 (v4si, v4si)
7793 v16qi __builtin_ia32_pblendvb128 (v16qi, v16qi, v16qi)
7794 v8hi __builtin_ia32_pblendw128 (v8hi, v8hi, const int)
7795 v2di __builtin_ia32_pcmpeqq (v2di, v2di)
7796 v8hi __builtin_ia32_phminposuw128 (v8hi)
7797 v16qi __builtin_ia32_pmaxsb128 (v16qi, v16qi)
7798 v4si __builtin_ia32_pmaxsd128 (v4si, v4si)
7799 v4si __builtin_ia32_pmaxud128 (v4si, v4si)
7800 v8hi __builtin_ia32_pmaxuw128 (v8hi, v8hi)
7801 v16qi __builtin_ia32_pminsb128 (v16qi, v16qi)
7802 v4si __builtin_ia32_pminsd128 (v4si, v4si)
7803 v4si __builtin_ia32_pminud128 (v4si, v4si)
7804 v8hi __builtin_ia32_pminuw128 (v8hi, v8hi)
7805 v4si __builtin_ia32_pmovsxbd128 (v16qi)
7806 v2di __builtin_ia32_pmovsxbq128 (v16qi)
7807 v8hi __builtin_ia32_pmovsxbw128 (v16qi)
7808 v2di __builtin_ia32_pmovsxdq128 (v4si)
7809 v4si __builtin_ia32_pmovsxwd128 (v8hi)
7810 v2di __builtin_ia32_pmovsxwq128 (v8hi)
7811 v4si __builtin_ia32_pmovzxbd128 (v16qi)
7812 v2di __builtin_ia32_pmovzxbq128 (v16qi)
7813 v8hi __builtin_ia32_pmovzxbw128 (v16qi)
7814 v2di __builtin_ia32_pmovzxdq128 (v4si)
7815 v4si __builtin_ia32_pmovzxwd128 (v8hi)
7816 v2di __builtin_ia32_pmovzxwq128 (v8hi)
7817 v2di __builtin_ia32_pmuldq128 (v4si, v4si)
7818 v4si __builtin_ia32_pmulld128 (v4si, v4si)
7819 int __builtin_ia32_ptestc128 (v2di, v2di)
7820 int __builtin_ia32_ptestnzc128 (v2di, v2di)
7821 int __builtin_ia32_ptestz128 (v2di, v2di)
7822 v2df __builtin_ia32_roundpd (v2df, const int)
7823 v4sf __builtin_ia32_roundps (v4sf, const int)
7824 v2df __builtin_ia32_roundsd (v2df, v2df, const int)
7825 v4sf __builtin_ia32_roundss (v4sf, v4sf, const int)
7826 @end smallexample
7827
7828 The following built-in functions are available when @option{-msse4.1} is
7829 used.
7830
7831 @table @code
7832 @item v4sf __builtin_ia32_vec_set_v4sf (v4sf, float, const int)
7833 Generates the @code{insertps} machine instruction.
7834 @item int __builtin_ia32_vec_ext_v16qi (v16qi, const int)
7835 Generates the @code{pextrb} machine instruction.
7836 @item v16qi __builtin_ia32_vec_set_v16qi (v16qi, int, const int)
7837 Generates the @code{pinsrb} machine instruction.
7838 @item v4si __builtin_ia32_vec_set_v4si (v4si, int, const int)
7839 Generates the @code{pinsrd} machine instruction.
7840 @item v2di __builtin_ia32_vec_set_v2di (v2di, long long, const int)
7841 Generates the @code{pinsrq} machine instruction in 64bit mode.
7842 @end table
7843
7844 The following built-in functions are changed to generate new SSE4.1
7845 instructions when @option{-msse4.1} is used.
7846
7847 @table @code
7848 @item float __builtin_ia32_vec_ext_v4sf (v4sf, const int)
7849 Generates the @code{extractps} machine instruction.
7850 @item int __builtin_ia32_vec_ext_v4si (v4si, const int)
7851 Generates the @code{pextrd} machine instruction.
7852 @item long long __builtin_ia32_vec_ext_v2di (v2di, const int)
7853 Generates the @code{pextrq} machine instruction in 64bit mode.
7854 @end table
7855
7856 The following built-in functions are available when @option{-msse4.2} is
7857 used.  All of them generate the machine instruction that is part of the
7858 name.
7859
7860 @smallexample
7861 v16qi __builtin_ia32_pcmpestrm128 (v16qi, int, v16qi, int, const int)
7862 int __builtin_ia32_pcmpestri128 (v16qi, int, v16qi, int, const int)
7863 int __builtin_ia32_pcmpestria128 (v16qi, int, v16qi, int, const int)
7864 int __builtin_ia32_pcmpestric128 (v16qi, int, v16qi, int, const int)
7865 int __builtin_ia32_pcmpestrio128 (v16qi, int, v16qi, int, const int)
7866 int __builtin_ia32_pcmpestris128 (v16qi, int, v16qi, int, const int)
7867 int __builtin_ia32_pcmpestriz128 (v16qi, int, v16qi, int, const int)
7868 v16qi __builtin_ia32_pcmpistrm128 (v16qi, v16qi, const int)
7869 int __builtin_ia32_pcmpistri128 (v16qi, v16qi, const int)
7870 int __builtin_ia32_pcmpistria128 (v16qi, v16qi, const int)
7871 int __builtin_ia32_pcmpistric128 (v16qi, v16qi, const int)
7872 int __builtin_ia32_pcmpistrio128 (v16qi, v16qi, const int)
7873 int __builtin_ia32_pcmpistris128 (v16qi, v16qi, const int)
7874 int __builtin_ia32_pcmpistriz128 (v16qi, v16qi, const int)
7875 v2di __builtin_ia32_pcmpgtq (v2di, v2di)
7876 @end smallexample
7877
7878 The following built-in functions are available when @option{-msse4.2} is
7879 used.
7880
7881 @table @code
7882 @item unsigned int __builtin_ia32_crc32qi (unsigned int, unsigned char)
7883 Generates the @code{crc32b} machine instruction.
7884 @item unsigned int __builtin_ia32_crc32hi (unsigned int, unsigned short)
7885 Generates the @code{crc32w} machine instruction.
7886 @item unsigned int __builtin_ia32_crc32si (unsigned int, unsigned int)
7887 Generates the @code{crc32l} machine instruction.
7888 @item unsigned long long __builtin_ia32_crc32di (unsigned int, unsigned long long)
7889 @end table
7890
7891 The following built-in functions are changed to generate new SSE4.2
7892 instructions when @option{-msse4.2} is used.
7893
7894 @table @code
7895 @item int __builtin_popcount (unsigned int)
7896 Generates the @code{popcntl} machine instruction.
7897 @item int __builtin_popcountl (unsigned long)
7898 Generates the @code{popcntl} or @code{popcntq} machine instruction,
7899 depending on the size of @code{unsigned long}.
7900 @item int __builtin_popcountll (unsigned long long)
7901 Generates the @code{popcntq} machine instruction.
7902 @end table
7903
7904 The following built-in functions are available when @option{-msse4a} is used.
7905 All of them generate the machine instruction that is part of the name.
7906
7907 @smallexample
7908 void __builtin_ia32_movntsd (double *, v2df)
7909 void __builtin_ia32_movntss (float *, v4sf)
7910 v2di __builtin_ia32_extrq  (v2di, v16qi)
7911 v2di __builtin_ia32_extrqi (v2di, const unsigned int, const unsigned int)
7912 v2di __builtin_ia32_insertq (v2di, v2di)
7913 v2di __builtin_ia32_insertqi (v2di, v2di, const unsigned int, const unsigned int)
7914 @end smallexample
7915
7916 The following built-in functions are available when @option{-msse5} is used.
7917 All of them generate the machine instruction that is part of the name
7918 with MMX registers.
7919
7920 @smallexample
7921 v2df __builtin_ia32_comeqpd (v2df, v2df)
7922 v2df __builtin_ia32_comeqps (v2df, v2df)
7923 v4sf __builtin_ia32_comeqsd (v4sf, v4sf)
7924 v4sf __builtin_ia32_comeqss (v4sf, v4sf)
7925 v2df __builtin_ia32_comfalsepd (v2df, v2df)
7926 v2df __builtin_ia32_comfalseps (v2df, v2df)
7927 v4sf __builtin_ia32_comfalsesd (v4sf, v4sf)
7928 v4sf __builtin_ia32_comfalsess (v4sf, v4sf)
7929 v2df __builtin_ia32_comgepd (v2df, v2df)
7930 v2df __builtin_ia32_comgeps (v2df, v2df)
7931 v4sf __builtin_ia32_comgesd (v4sf, v4sf)
7932 v4sf __builtin_ia32_comgess (v4sf, v4sf)
7933 v2df __builtin_ia32_comgtpd (v2df, v2df)
7934 v2df __builtin_ia32_comgtps (v2df, v2df)
7935 v4sf __builtin_ia32_comgtsd (v4sf, v4sf)
7936 v4sf __builtin_ia32_comgtss (v4sf, v4sf)
7937 v2df __builtin_ia32_comlepd (v2df, v2df)
7938 v2df __builtin_ia32_comleps (v2df, v2df)
7939 v4sf __builtin_ia32_comlesd (v4sf, v4sf)
7940 v4sf __builtin_ia32_comless (v4sf, v4sf)
7941 v2df __builtin_ia32_comltpd (v2df, v2df)
7942 v2df __builtin_ia32_comltps (v2df, v2df)
7943 v4sf __builtin_ia32_comltsd (v4sf, v4sf)
7944 v4sf __builtin_ia32_comltss (v4sf, v4sf)
7945 v2df __builtin_ia32_comnepd (v2df, v2df)
7946 v2df __builtin_ia32_comneps (v2df, v2df)
7947 v4sf __builtin_ia32_comnesd (v4sf, v4sf)
7948 v4sf __builtin_ia32_comness (v4sf, v4sf)
7949 v2df __builtin_ia32_comordpd (v2df, v2df)
7950 v2df __builtin_ia32_comordps (v2df, v2df)
7951 v4sf __builtin_ia32_comordsd (v4sf, v4sf)
7952 v4sf __builtin_ia32_comordss (v4sf, v4sf)
7953 v2df __builtin_ia32_comtruepd (v2df, v2df)
7954 v2df __builtin_ia32_comtrueps (v2df, v2df)
7955 v4sf __builtin_ia32_comtruesd (v4sf, v4sf)
7956 v4sf __builtin_ia32_comtruess (v4sf, v4sf)
7957 v2df __builtin_ia32_comueqpd (v2df, v2df)
7958 v2df __builtin_ia32_comueqps (v2df, v2df)
7959 v4sf __builtin_ia32_comueqsd (v4sf, v4sf)
7960 v4sf __builtin_ia32_comueqss (v4sf, v4sf)
7961 v2df __builtin_ia32_comugepd (v2df, v2df)
7962 v2df __builtin_ia32_comugeps (v2df, v2df)
7963 v4sf __builtin_ia32_comugesd (v4sf, v4sf)
7964 v4sf __builtin_ia32_comugess (v4sf, v4sf)
7965 v2df __builtin_ia32_comugtpd (v2df, v2df)
7966 v2df __builtin_ia32_comugtps (v2df, v2df)
7967 v4sf __builtin_ia32_comugtsd (v4sf, v4sf)
7968 v4sf __builtin_ia32_comugtss (v4sf, v4sf)
7969 v2df __builtin_ia32_comulepd (v2df, v2df)
7970 v2df __builtin_ia32_comuleps (v2df, v2df)
7971 v4sf __builtin_ia32_comulesd (v4sf, v4sf)
7972 v4sf __builtin_ia32_comuless (v4sf, v4sf)
7973 v2df __builtin_ia32_comultpd (v2df, v2df)
7974 v2df __builtin_ia32_comultps (v2df, v2df)
7975 v4sf __builtin_ia32_comultsd (v4sf, v4sf)
7976 v4sf __builtin_ia32_comultss (v4sf, v4sf)
7977 v2df __builtin_ia32_comunepd (v2df, v2df)
7978 v2df __builtin_ia32_comuneps (v2df, v2df)
7979 v4sf __builtin_ia32_comunesd (v4sf, v4sf)
7980 v4sf __builtin_ia32_comuness (v4sf, v4sf)
7981 v2df __builtin_ia32_comunordpd (v2df, v2df)
7982 v2df __builtin_ia32_comunordps (v2df, v2df)
7983 v4sf __builtin_ia32_comunordsd (v4sf, v4sf)
7984 v4sf __builtin_ia32_comunordss (v4sf, v4sf)
7985 v2df __builtin_ia32_fmaddpd (v2df, v2df, v2df)
7986 v4sf __builtin_ia32_fmaddps (v4sf, v4sf, v4sf)
7987 v2df __builtin_ia32_fmaddsd (v2df, v2df, v2df)
7988 v4sf __builtin_ia32_fmaddss (v4sf, v4sf, v4sf)
7989 v2df __builtin_ia32_fmsubpd (v2df, v2df, v2df)
7990 v4sf __builtin_ia32_fmsubps (v4sf, v4sf, v4sf)
7991 v2df __builtin_ia32_fmsubsd (v2df, v2df, v2df)
7992 v4sf __builtin_ia32_fmsubss (v4sf, v4sf, v4sf)
7993 v2df __builtin_ia32_fnmaddpd (v2df, v2df, v2df)
7994 v4sf __builtin_ia32_fnmaddps (v4sf, v4sf, v4sf)
7995 v2df __builtin_ia32_fnmaddsd (v2df, v2df, v2df)
7996 v4sf __builtin_ia32_fnmaddss (v4sf, v4sf, v4sf)
7997 v2df __builtin_ia32_fnmsubpd (v2df, v2df, v2df)
7998 v4sf __builtin_ia32_fnmsubps (v4sf, v4sf, v4sf)
7999 v2df __builtin_ia32_fnmsubsd (v2df, v2df, v2df)
8000 v4sf __builtin_ia32_fnmsubss (v4sf, v4sf, v4sf)
8001 v2df __builtin_ia32_frczpd (v2df)
8002 v4sf __builtin_ia32_frczps (v4sf)
8003 v2df __builtin_ia32_frczsd (v2df, v2df)
8004 v4sf __builtin_ia32_frczss (v4sf, v4sf)
8005 v2di __builtin_ia32_pcmov (v2di, v2di, v2di)
8006 v2di __builtin_ia32_pcmov_v2di (v2di, v2di, v2di)
8007 v4si __builtin_ia32_pcmov_v4si (v4si, v4si, v4si)
8008 v8hi __builtin_ia32_pcmov_v8hi (v8hi, v8hi, v8hi)
8009 v16qi __builtin_ia32_pcmov_v16qi (v16qi, v16qi, v16qi)
8010 v2df __builtin_ia32_pcmov_v2df (v2df, v2df, v2df)
8011 v4sf __builtin_ia32_pcmov_v4sf (v4sf, v4sf, v4sf)
8012 v16qi __builtin_ia32_pcomeqb (v16qi, v16qi)
8013 v8hi __builtin_ia32_pcomeqw (v8hi, v8hi)
8014 v4si __builtin_ia32_pcomeqd (v4si, v4si)
8015 v2di __builtin_ia32_pcomeqq (v2di, v2di)
8016 v16qi __builtin_ia32_pcomequb (v16qi, v16qi)
8017 v4si __builtin_ia32_pcomequd (v4si, v4si)
8018 v2di __builtin_ia32_pcomequq (v2di, v2di)
8019 v8hi __builtin_ia32_pcomequw (v8hi, v8hi)
8020 v8hi __builtin_ia32_pcomeqw (v8hi, v8hi)
8021 v16qi __builtin_ia32_pcomfalseb (v16qi, v16qi)
8022 v4si __builtin_ia32_pcomfalsed (v4si, v4si)
8023 v2di __builtin_ia32_pcomfalseq (v2di, v2di)
8024 v16qi __builtin_ia32_pcomfalseub (v16qi, v16qi)
8025 v4si __builtin_ia32_pcomfalseud (v4si, v4si)
8026 v2di __builtin_ia32_pcomfalseuq (v2di, v2di)
8027 v8hi __builtin_ia32_pcomfalseuw (v8hi, v8hi)
8028 v8hi __builtin_ia32_pcomfalsew (v8hi, v8hi)
8029 v16qi __builtin_ia32_pcomgeb (v16qi, v16qi)
8030 v4si __builtin_ia32_pcomged (v4si, v4si)
8031 v2di __builtin_ia32_pcomgeq (v2di, v2di)
8032 v16qi __builtin_ia32_pcomgeub (v16qi, v16qi)
8033 v4si __builtin_ia32_pcomgeud (v4si, v4si)
8034 v2di __builtin_ia32_pcomgeuq (v2di, v2di)
8035 v8hi __builtin_ia32_pcomgeuw (v8hi, v8hi)
8036 v8hi __builtin_ia32_pcomgew (v8hi, v8hi)
8037 v16qi __builtin_ia32_pcomgtb (v16qi, v16qi)
8038 v4si __builtin_ia32_pcomgtd (v4si, v4si)
8039 v2di __builtin_ia32_pcomgtq (v2di, v2di)
8040 v16qi __builtin_ia32_pcomgtub (v16qi, v16qi)
8041 v4si __builtin_ia32_pcomgtud (v4si, v4si)
8042 v2di __builtin_ia32_pcomgtuq (v2di, v2di)
8043 v8hi __builtin_ia32_pcomgtuw (v8hi, v8hi)
8044 v8hi __builtin_ia32_pcomgtw (v8hi, v8hi)
8045 v16qi __builtin_ia32_pcomleb (v16qi, v16qi)
8046 v4si __builtin_ia32_pcomled (v4si, v4si)
8047 v2di __builtin_ia32_pcomleq (v2di, v2di)
8048 v16qi __builtin_ia32_pcomleub (v16qi, v16qi)
8049 v4si __builtin_ia32_pcomleud (v4si, v4si)
8050 v2di __builtin_ia32_pcomleuq (v2di, v2di)
8051 v8hi __builtin_ia32_pcomleuw (v8hi, v8hi)
8052 v8hi __builtin_ia32_pcomlew (v8hi, v8hi)
8053 v16qi __builtin_ia32_pcomltb (v16qi, v16qi)
8054 v4si __builtin_ia32_pcomltd (v4si, v4si)
8055 v2di __builtin_ia32_pcomltq (v2di, v2di)
8056 v16qi __builtin_ia32_pcomltub (v16qi, v16qi)
8057 v4si __builtin_ia32_pcomltud (v4si, v4si)
8058 v2di __builtin_ia32_pcomltuq (v2di, v2di)
8059 v8hi __builtin_ia32_pcomltuw (v8hi, v8hi)
8060 v8hi __builtin_ia32_pcomltw (v8hi, v8hi)
8061 v16qi __builtin_ia32_pcomneb (v16qi, v16qi)
8062 v4si __builtin_ia32_pcomned (v4si, v4si)
8063 v2di __builtin_ia32_pcomneq (v2di, v2di)
8064 v16qi __builtin_ia32_pcomneub (v16qi, v16qi)
8065 v4si __builtin_ia32_pcomneud (v4si, v4si)
8066 v2di __builtin_ia32_pcomneuq (v2di, v2di)
8067 v8hi __builtin_ia32_pcomneuw (v8hi, v8hi)
8068 v8hi __builtin_ia32_pcomnew (v8hi, v8hi)
8069 v16qi __builtin_ia32_pcomtrueb (v16qi, v16qi)
8070 v4si __builtin_ia32_pcomtrued (v4si, v4si)
8071 v2di __builtin_ia32_pcomtrueq (v2di, v2di)
8072 v16qi __builtin_ia32_pcomtrueub (v16qi, v16qi)
8073 v4si __builtin_ia32_pcomtrueud (v4si, v4si)
8074 v2di __builtin_ia32_pcomtrueuq (v2di, v2di)
8075 v8hi __builtin_ia32_pcomtrueuw (v8hi, v8hi)
8076 v8hi __builtin_ia32_pcomtruew (v8hi, v8hi)
8077 v4df __builtin_ia32_permpd (v2df, v2df, v16qi)
8078 v4sf __builtin_ia32_permps (v4sf, v4sf, v16qi)
8079 v4si __builtin_ia32_phaddbd (v16qi)
8080 v2di __builtin_ia32_phaddbq (v16qi)
8081 v8hi __builtin_ia32_phaddbw (v16qi)
8082 v2di __builtin_ia32_phadddq (v4si)
8083 v4si __builtin_ia32_phaddubd (v16qi)
8084 v2di __builtin_ia32_phaddubq (v16qi)
8085 v8hi __builtin_ia32_phaddubw (v16qi)
8086 v2di __builtin_ia32_phaddudq (v4si)
8087 v4si __builtin_ia32_phadduwd (v8hi)
8088 v2di __builtin_ia32_phadduwq (v8hi)
8089 v4si __builtin_ia32_phaddwd (v8hi)
8090 v2di __builtin_ia32_phaddwq (v8hi)
8091 v8hi __builtin_ia32_phsubbw (v16qi)
8092 v2di __builtin_ia32_phsubdq (v4si)
8093 v4si __builtin_ia32_phsubwd (v8hi)
8094 v4si __builtin_ia32_pmacsdd (v4si, v4si, v4si)
8095 v2di __builtin_ia32_pmacsdqh (v4si, v4si, v2di)
8096 v2di __builtin_ia32_pmacsdql (v4si, v4si, v2di)
8097 v4si __builtin_ia32_pmacssdd (v4si, v4si, v4si)
8098 v2di __builtin_ia32_pmacssdqh (v4si, v4si, v2di)
8099 v2di __builtin_ia32_pmacssdql (v4si, v4si, v2di)
8100 v4si __builtin_ia32_pmacsswd (v8hi, v8hi, v4si)
8101 v8hi __builtin_ia32_pmacssww (v8hi, v8hi, v8hi)
8102 v4si __builtin_ia32_pmacswd (v8hi, v8hi, v4si)
8103 v8hi __builtin_ia32_pmacsww (v8hi, v8hi, v8hi)
8104 v4si __builtin_ia32_pmadcsswd (v8hi, v8hi, v4si)
8105 v4si __builtin_ia32_pmadcswd (v8hi, v8hi, v4si)
8106 v16qi __builtin_ia32_pperm (v16qi, v16qi, v16qi)
8107 v16qi __builtin_ia32_protb (v16qi, v16qi)
8108 v4si __builtin_ia32_protd (v4si, v4si)
8109 v2di __builtin_ia32_protq (v2di, v2di)
8110 v8hi __builtin_ia32_protw (v8hi, v8hi)
8111 v16qi __builtin_ia32_pshab (v16qi, v16qi)
8112 v4si __builtin_ia32_pshad (v4si, v4si)
8113 v2di __builtin_ia32_pshaq (v2di, v2di)
8114 v8hi __builtin_ia32_pshaw (v8hi, v8hi)
8115 v16qi __builtin_ia32_pshlb (v16qi, v16qi)
8116 v4si __builtin_ia32_pshld (v4si, v4si)
8117 v2di __builtin_ia32_pshlq (v2di, v2di)
8118 v8hi __builtin_ia32_pshlw (v8hi, v8hi)
8119 @end smallexample
8120
8121 The following builtin-in functions are avaialble when @option{-msse5}
8122 is used.  The second argument must be an integer constant and generate
8123 the machine instruction that is part of the name with the @samp{_imm}
8124 suffix removed.
8125
8126 @smallexample
8127 v16qi __builtin_ia32_protb_imm (v16qi, int)
8128 v4si __builtin_ia32_protd_imm (v4si, int)
8129 v2di __builtin_ia32_protq_imm (v2di, int)
8130 v8hi __builtin_ia32_protw_imm (v8hi, int)
8131 @end smallexample
8132
8133 The following built-in functions are available when @option{-m3dnow} is used.
8134 All of them generate the machine instruction that is part of the name.
8135
8136 @smallexample
8137 void __builtin_ia32_femms (void)
8138 v8qi __builtin_ia32_pavgusb (v8qi, v8qi)
8139 v2si __builtin_ia32_pf2id (v2sf)
8140 v2sf __builtin_ia32_pfacc (v2sf, v2sf)
8141 v2sf __builtin_ia32_pfadd (v2sf, v2sf)
8142 v2si __builtin_ia32_pfcmpeq (v2sf, v2sf)
8143 v2si __builtin_ia32_pfcmpge (v2sf, v2sf)
8144 v2si __builtin_ia32_pfcmpgt (v2sf, v2sf)
8145 v2sf __builtin_ia32_pfmax (v2sf, v2sf)
8146 v2sf __builtin_ia32_pfmin (v2sf, v2sf)
8147 v2sf __builtin_ia32_pfmul (v2sf, v2sf)
8148 v2sf __builtin_ia32_pfrcp (v2sf)
8149 v2sf __builtin_ia32_pfrcpit1 (v2sf, v2sf)
8150 v2sf __builtin_ia32_pfrcpit2 (v2sf, v2sf)
8151 v2sf __builtin_ia32_pfrsqrt (v2sf)
8152 v2sf __builtin_ia32_pfrsqrtit1 (v2sf, v2sf)
8153 v2sf __builtin_ia32_pfsub (v2sf, v2sf)
8154 v2sf __builtin_ia32_pfsubr (v2sf, v2sf)
8155 v2sf __builtin_ia32_pi2fd (v2si)
8156 v4hi __builtin_ia32_pmulhrw (v4hi, v4hi)
8157 @end smallexample
8158
8159 The following built-in functions are available when both @option{-m3dnow}
8160 and @option{-march=athlon} are used.  All of them generate the machine
8161 instruction that is part of the name.
8162
8163 @smallexample
8164 v2si __builtin_ia32_pf2iw (v2sf)
8165 v2sf __builtin_ia32_pfnacc (v2sf, v2sf)
8166 v2sf __builtin_ia32_pfpnacc (v2sf, v2sf)
8167 v2sf __builtin_ia32_pi2fw (v2si)
8168 v2sf __builtin_ia32_pswapdsf (v2sf)
8169 v2si __builtin_ia32_pswapdsi (v2si)
8170 @end smallexample
8171
8172 @node MIPS DSP Built-in Functions
8173 @subsection MIPS DSP Built-in Functions
8174
8175 The MIPS DSP Application-Specific Extension (ASE) includes new
8176 instructions that are designed to improve the performance of DSP and
8177 media applications.  It provides instructions that operate on packed
8178 8-bit/16-bit integer data, Q7, Q15 and Q31 fractional data.
8179
8180 GCC supports MIPS DSP operations using both the generic
8181 vector extensions (@pxref{Vector Extensions}) and a collection of
8182 MIPS-specific built-in functions.  Both kinds of support are
8183 enabled by the @option{-mdsp} command-line option.
8184
8185 Revision 2 of the ASE was introduced in the second half of 2006.
8186 This revision adds extra instructions to the original ASE, but is
8187 otherwise backwards-compatible with it.  You can select revision 2
8188 using the command-line option @option{-mdspr2}; this option implies
8189 @option{-mdsp}.
8190
8191 At present, GCC only provides support for operations on 32-bit
8192 vectors.  The vector type associated with 8-bit integer data is
8193 usually called @code{v4i8}, the vector type associated with Q7
8194 is usually called @code{v4q7}, the vector type associated with 16-bit
8195 integer data is usually called @code{v2i16}, and the vector type
8196 associated with Q15 is usually called @code{v2q15}.  They can be
8197 defined in C as follows:
8198
8199 @smallexample
8200 typedef signed char v4i8 __attribute__ ((vector_size(4)));
8201 typedef signed char v4q7 __attribute__ ((vector_size(4)));
8202 typedef short v2i16 __attribute__ ((vector_size(4)));
8203 typedef short v2q15 __attribute__ ((vector_size(4)));
8204 @end smallexample
8205
8206 @code{v4i8}, @code{v4q7}, @code{v2i16} and @code{v2q15} values are
8207 initialized in the same way as aggregates.  For example:
8208
8209 @smallexample
8210 v4i8 a = @{1, 2, 3, 4@};
8211 v4i8 b;
8212 b = (v4i8) @{5, 6, 7, 8@};
8213
8214 v2q15 c = @{0x0fcb, 0x3a75@};
8215 v2q15 d;
8216 d = (v2q15) @{0.1234 * 0x1.0p15, 0.4567 * 0x1.0p15@};
8217 @end smallexample
8218
8219 @emph{Note:} The CPU's endianness determines the order in which values
8220 are packed.  On little-endian targets, the first value is the least
8221 significant and the last value is the most significant.  The opposite
8222 order applies to big-endian targets.  For example, the code above will
8223 set the lowest byte of @code{a} to @code{1} on little-endian targets
8224 and @code{4} on big-endian targets.
8225
8226 @emph{Note:} Q7, Q15 and Q31 values must be initialized with their integer
8227 representation.  As shown in this example, the integer representation
8228 of a Q7 value can be obtained by multiplying the fractional value by
8229 @code{0x1.0p7}.  The equivalent for Q15 values is to multiply by
8230 @code{0x1.0p15}.  The equivalent for Q31 values is to multiply by
8231 @code{0x1.0p31}.
8232
8233 The table below lists the @code{v4i8} and @code{v2q15} operations for which
8234 hardware support exists.  @code{a} and @code{b} are @code{v4i8} values,
8235 and @code{c} and @code{d} are @code{v2q15} values.
8236
8237 @multitable @columnfractions .50 .50
8238 @item C code @tab MIPS instruction
8239 @item @code{a + b} @tab @code{addu.qb}
8240 @item @code{c + d} @tab @code{addq.ph}
8241 @item @code{a - b} @tab @code{subu.qb}
8242 @item @code{c - d} @tab @code{subq.ph}
8243 @end multitable
8244
8245 The table below lists the @code{v2i16} operation for which
8246 hardware support exists for the DSP ASE REV 2.  @code{e} and @code{f} are
8247 @code{v2i16} values.
8248
8249 @multitable @columnfractions .50 .50
8250 @item C code @tab MIPS instruction
8251 @item @code{e * f} @tab @code{mul.ph}
8252 @end multitable
8253
8254 It is easier to describe the DSP built-in functions if we first define
8255 the following types:
8256
8257 @smallexample
8258 typedef int q31;
8259 typedef int i32;
8260 typedef unsigned int ui32;
8261 typedef long long a64;
8262 @end smallexample
8263
8264 @code{q31} and @code{i32} are actually the same as @code{int}, but we
8265 use @code{q31} to indicate a Q31 fractional value and @code{i32} to
8266 indicate a 32-bit integer value.  Similarly, @code{a64} is the same as
8267 @code{long long}, but we use @code{a64} to indicate values that will
8268 be placed in one of the four DSP accumulators (@code{$ac0},
8269 @code{$ac1}, @code{$ac2} or @code{$ac3}).
8270
8271 Also, some built-in functions prefer or require immediate numbers as
8272 parameters, because the corresponding DSP instructions accept both immediate
8273 numbers and register operands, or accept immediate numbers only.  The
8274 immediate parameters are listed as follows.
8275
8276 @smallexample
8277 imm0_3: 0 to 3.
8278 imm0_7: 0 to 7.
8279 imm0_15: 0 to 15.
8280 imm0_31: 0 to 31.
8281 imm0_63: 0 to 63.
8282 imm0_255: 0 to 255.
8283 imm_n32_31: -32 to 31.
8284 imm_n512_511: -512 to 511.
8285 @end smallexample
8286
8287 The following built-in functions map directly to a particular MIPS DSP
8288 instruction.  Please refer to the architecture specification
8289 for details on what each instruction does.
8290
8291 @smallexample
8292 v2q15 __builtin_mips_addq_ph (v2q15, v2q15)
8293 v2q15 __builtin_mips_addq_s_ph (v2q15, v2q15)
8294 q31 __builtin_mips_addq_s_w (q31, q31)
8295 v4i8 __builtin_mips_addu_qb (v4i8, v4i8)
8296 v4i8 __builtin_mips_addu_s_qb (v4i8, v4i8)
8297 v2q15 __builtin_mips_subq_ph (v2q15, v2q15)
8298 v2q15 __builtin_mips_subq_s_ph (v2q15, v2q15)
8299 q31 __builtin_mips_subq_s_w (q31, q31)
8300 v4i8 __builtin_mips_subu_qb (v4i8, v4i8)
8301 v4i8 __builtin_mips_subu_s_qb (v4i8, v4i8)
8302 i32 __builtin_mips_addsc (i32, i32)
8303 i32 __builtin_mips_addwc (i32, i32)
8304 i32 __builtin_mips_modsub (i32, i32)
8305 i32 __builtin_mips_raddu_w_qb (v4i8)
8306 v2q15 __builtin_mips_absq_s_ph (v2q15)
8307 q31 __builtin_mips_absq_s_w (q31)
8308 v4i8 __builtin_mips_precrq_qb_ph (v2q15, v2q15)
8309 v2q15 __builtin_mips_precrq_ph_w (q31, q31)
8310 v2q15 __builtin_mips_precrq_rs_ph_w (q31, q31)
8311 v4i8 __builtin_mips_precrqu_s_qb_ph (v2q15, v2q15)
8312 q31 __builtin_mips_preceq_w_phl (v2q15)
8313 q31 __builtin_mips_preceq_w_phr (v2q15)
8314 v2q15 __builtin_mips_precequ_ph_qbl (v4i8)
8315 v2q15 __builtin_mips_precequ_ph_qbr (v4i8)
8316 v2q15 __builtin_mips_precequ_ph_qbla (v4i8)
8317 v2q15 __builtin_mips_precequ_ph_qbra (v4i8)
8318 v2q15 __builtin_mips_preceu_ph_qbl (v4i8)
8319 v2q15 __builtin_mips_preceu_ph_qbr (v4i8)
8320 v2q15 __builtin_mips_preceu_ph_qbla (v4i8)
8321 v2q15 __builtin_mips_preceu_ph_qbra (v4i8)
8322 v4i8 __builtin_mips_shll_qb (v4i8, imm0_7)
8323 v4i8 __builtin_mips_shll_qb (v4i8, i32)
8324 v2q15 __builtin_mips_shll_ph (v2q15, imm0_15)
8325 v2q15 __builtin_mips_shll_ph (v2q15, i32)
8326 v2q15 __builtin_mips_shll_s_ph (v2q15, imm0_15)
8327 v2q15 __builtin_mips_shll_s_ph (v2q15, i32)
8328 q31 __builtin_mips_shll_s_w (q31, imm0_31)
8329 q31 __builtin_mips_shll_s_w (q31, i32)
8330 v4i8 __builtin_mips_shrl_qb (v4i8, imm0_7)
8331 v4i8 __builtin_mips_shrl_qb (v4i8, i32)
8332 v2q15 __builtin_mips_shra_ph (v2q15, imm0_15)
8333 v2q15 __builtin_mips_shra_ph (v2q15, i32)
8334 v2q15 __builtin_mips_shra_r_ph (v2q15, imm0_15)
8335 v2q15 __builtin_mips_shra_r_ph (v2q15, i32)
8336 q31 __builtin_mips_shra_r_w (q31, imm0_31)
8337 q31 __builtin_mips_shra_r_w (q31, i32)
8338 v2q15 __builtin_mips_muleu_s_ph_qbl (v4i8, v2q15)
8339 v2q15 __builtin_mips_muleu_s_ph_qbr (v4i8, v2q15)
8340 v2q15 __builtin_mips_mulq_rs_ph (v2q15, v2q15)
8341 q31 __builtin_mips_muleq_s_w_phl (v2q15, v2q15)
8342 q31 __builtin_mips_muleq_s_w_phr (v2q15, v2q15)
8343 a64 __builtin_mips_dpau_h_qbl (a64, v4i8, v4i8)
8344 a64 __builtin_mips_dpau_h_qbr (a64, v4i8, v4i8)
8345 a64 __builtin_mips_dpsu_h_qbl (a64, v4i8, v4i8)
8346 a64 __builtin_mips_dpsu_h_qbr (a64, v4i8, v4i8)
8347 a64 __builtin_mips_dpaq_s_w_ph (a64, v2q15, v2q15)
8348 a64 __builtin_mips_dpaq_sa_l_w (a64, q31, q31)
8349 a64 __builtin_mips_dpsq_s_w_ph (a64, v2q15, v2q15)
8350 a64 __builtin_mips_dpsq_sa_l_w (a64, q31, q31)
8351 a64 __builtin_mips_mulsaq_s_w_ph (a64, v2q15, v2q15)
8352 a64 __builtin_mips_maq_s_w_phl (a64, v2q15, v2q15)
8353 a64 __builtin_mips_maq_s_w_phr (a64, v2q15, v2q15)
8354 a64 __builtin_mips_maq_sa_w_phl (a64, v2q15, v2q15)
8355 a64 __builtin_mips_maq_sa_w_phr (a64, v2q15, v2q15)
8356 i32 __builtin_mips_bitrev (i32)
8357 i32 __builtin_mips_insv (i32, i32)
8358 v4i8 __builtin_mips_repl_qb (imm0_255)
8359 v4i8 __builtin_mips_repl_qb (i32)
8360 v2q15 __builtin_mips_repl_ph (imm_n512_511)
8361 v2q15 __builtin_mips_repl_ph (i32)
8362 void __builtin_mips_cmpu_eq_qb (v4i8, v4i8)
8363 void __builtin_mips_cmpu_lt_qb (v4i8, v4i8)
8364 void __builtin_mips_cmpu_le_qb (v4i8, v4i8)
8365 i32 __builtin_mips_cmpgu_eq_qb (v4i8, v4i8)
8366 i32 __builtin_mips_cmpgu_lt_qb (v4i8, v4i8)
8367 i32 __builtin_mips_cmpgu_le_qb (v4i8, v4i8)
8368 void __builtin_mips_cmp_eq_ph (v2q15, v2q15)
8369 void __builtin_mips_cmp_lt_ph (v2q15, v2q15)
8370 void __builtin_mips_cmp_le_ph (v2q15, v2q15)
8371 v4i8 __builtin_mips_pick_qb (v4i8, v4i8)
8372 v2q15 __builtin_mips_pick_ph (v2q15, v2q15)
8373 v2q15 __builtin_mips_packrl_ph (v2q15, v2q15)
8374 i32 __builtin_mips_extr_w (a64, imm0_31)
8375 i32 __builtin_mips_extr_w (a64, i32)
8376 i32 __builtin_mips_extr_r_w (a64, imm0_31)
8377 i32 __builtin_mips_extr_s_h (a64, i32)
8378 i32 __builtin_mips_extr_rs_w (a64, imm0_31)
8379 i32 __builtin_mips_extr_rs_w (a64, i32)
8380 i32 __builtin_mips_extr_s_h (a64, imm0_31)
8381 i32 __builtin_mips_extr_r_w (a64, i32)
8382 i32 __builtin_mips_extp (a64, imm0_31)
8383 i32 __builtin_mips_extp (a64, i32)
8384 i32 __builtin_mips_extpdp (a64, imm0_31)
8385 i32 __builtin_mips_extpdp (a64, i32)
8386 a64 __builtin_mips_shilo (a64, imm_n32_31)
8387 a64 __builtin_mips_shilo (a64, i32)
8388 a64 __builtin_mips_mthlip (a64, i32)
8389 void __builtin_mips_wrdsp (i32, imm0_63)
8390 i32 __builtin_mips_rddsp (imm0_63)
8391 i32 __builtin_mips_lbux (void *, i32)
8392 i32 __builtin_mips_lhx (void *, i32)
8393 i32 __builtin_mips_lwx (void *, i32)
8394 i32 __builtin_mips_bposge32 (void)
8395 @end smallexample
8396
8397 The following built-in functions map directly to a particular MIPS DSP REV 2
8398 instruction.  Please refer to the architecture specification
8399 for details on what each instruction does.
8400
8401 @smallexample
8402 v4q7 __builtin_mips_absq_s_qb (v4q7);
8403 v2i16 __builtin_mips_addu_ph (v2i16, v2i16);
8404 v2i16 __builtin_mips_addu_s_ph (v2i16, v2i16);
8405 v4i8 __builtin_mips_adduh_qb (v4i8, v4i8);
8406 v4i8 __builtin_mips_adduh_r_qb (v4i8, v4i8);
8407 i32 __builtin_mips_append (i32, i32, imm0_31);
8408 i32 __builtin_mips_balign (i32, i32, imm0_3);
8409 i32 __builtin_mips_cmpgdu_eq_qb (v4i8, v4i8);
8410 i32 __builtin_mips_cmpgdu_lt_qb (v4i8, v4i8);
8411 i32 __builtin_mips_cmpgdu_le_qb (v4i8, v4i8);
8412 a64 __builtin_mips_dpa_w_ph (a64, v2i16, v2i16);
8413 a64 __builtin_mips_dps_w_ph (a64, v2i16, v2i16);
8414 a64 __builtin_mips_madd (a64, i32, i32);
8415 a64 __builtin_mips_maddu (a64, ui32, ui32);
8416 a64 __builtin_mips_msub (a64, i32, i32);
8417 a64 __builtin_mips_msubu (a64, ui32, ui32);
8418 v2i16 __builtin_mips_mul_ph (v2i16, v2i16);
8419 v2i16 __builtin_mips_mul_s_ph (v2i16, v2i16);
8420 q31 __builtin_mips_mulq_rs_w (q31, q31);
8421 v2q15 __builtin_mips_mulq_s_ph (v2q15, v2q15);
8422 q31 __builtin_mips_mulq_s_w (q31, q31);
8423 a64 __builtin_mips_mulsa_w_ph (a64, v2i16, v2i16);
8424 a64 __builtin_mips_mult (i32, i32);
8425 a64 __builtin_mips_multu (ui32, ui32);
8426 v4i8 __builtin_mips_precr_qb_ph (v2i16, v2i16);
8427 v2i16 __builtin_mips_precr_sra_ph_w (i32, i32, imm0_31);
8428 v2i16 __builtin_mips_precr_sra_r_ph_w (i32, i32, imm0_31);
8429 i32 __builtin_mips_prepend (i32, i32, imm0_31);
8430 v4i8 __builtin_mips_shra_qb (v4i8, imm0_7);
8431 v4i8 __builtin_mips_shra_r_qb (v4i8, imm0_7);
8432 v4i8 __builtin_mips_shra_qb (v4i8, i32);
8433 v4i8 __builtin_mips_shra_r_qb (v4i8, i32);
8434 v2i16 __builtin_mips_shrl_ph (v2i16, imm0_15);
8435 v2i16 __builtin_mips_shrl_ph (v2i16, i32);
8436 v2i16 __builtin_mips_subu_ph (v2i16, v2i16);
8437 v2i16 __builtin_mips_subu_s_ph (v2i16, v2i16);
8438 v4i8 __builtin_mips_subuh_qb (v4i8, v4i8);
8439 v4i8 __builtin_mips_subuh_r_qb (v4i8, v4i8);
8440 v2q15 __builtin_mips_addqh_ph (v2q15, v2q15);
8441 v2q15 __builtin_mips_addqh_r_ph (v2q15, v2q15);
8442 q31 __builtin_mips_addqh_w (q31, q31);
8443 q31 __builtin_mips_addqh_r_w (q31, q31);
8444 v2q15 __builtin_mips_subqh_ph (v2q15, v2q15);
8445 v2q15 __builtin_mips_subqh_r_ph (v2q15, v2q15);
8446 q31 __builtin_mips_subqh_w (q31, q31);
8447 q31 __builtin_mips_subqh_r_w (q31, q31);
8448 a64 __builtin_mips_dpax_w_ph (a64, v2i16, v2i16);
8449 a64 __builtin_mips_dpsx_w_ph (a64, v2i16, v2i16);
8450 a64 __builtin_mips_dpaqx_s_w_ph (a64, v2q15, v2q15);
8451 a64 __builtin_mips_dpaqx_sa_w_ph (a64, v2q15, v2q15);
8452 a64 __builtin_mips_dpsqx_s_w_ph (a64, v2q15, v2q15);
8453 a64 __builtin_mips_dpsqx_sa_w_ph (a64, v2q15, v2q15);
8454 @end smallexample
8455
8456
8457 @node MIPS Paired-Single Support
8458 @subsection MIPS Paired-Single Support
8459
8460 The MIPS64 architecture includes a number of instructions that
8461 operate on pairs of single-precision floating-point values.
8462 Each pair is packed into a 64-bit floating-point register,
8463 with one element being designated the ``upper half'' and
8464 the other being designated the ``lower half''.
8465
8466 GCC supports paired-single operations using both the generic
8467 vector extensions (@pxref{Vector Extensions}) and a collection of
8468 MIPS-specific built-in functions.  Both kinds of support are
8469 enabled by the @option{-mpaired-single} command-line option.
8470
8471 The vector type associated with paired-single values is usually
8472 called @code{v2sf}.  It can be defined in C as follows:
8473
8474 @smallexample
8475 typedef float v2sf __attribute__ ((vector_size (8)));
8476 @end smallexample
8477
8478 @code{v2sf} values are initialized in the same way as aggregates.
8479 For example:
8480
8481 @smallexample
8482 v2sf a = @{1.5, 9.1@};
8483 v2sf b;
8484 float e, f;
8485 b = (v2sf) @{e, f@};
8486 @end smallexample
8487
8488 @emph{Note:} The CPU's endianness determines which value is stored in
8489 the upper half of a register and which value is stored in the lower half.
8490 On little-endian targets, the first value is the lower one and the second
8491 value is the upper one.  The opposite order applies to big-endian targets.
8492 For example, the code above will set the lower half of @code{a} to
8493 @code{1.5} on little-endian targets and @code{9.1} on big-endian targets.
8494
8495 @menu
8496 * Paired-Single Arithmetic::
8497 * Paired-Single Built-in Functions::
8498 * MIPS-3D Built-in Functions::
8499 @end menu
8500
8501 @node Paired-Single Arithmetic
8502 @subsubsection Paired-Single Arithmetic
8503
8504 The table below lists the @code{v2sf} operations for which hardware
8505 support exists.  @code{a}, @code{b} and @code{c} are @code{v2sf}
8506 values and @code{x} is an integral value.
8507
8508 @multitable @columnfractions .50 .50
8509 @item C code @tab MIPS instruction
8510 @item @code{a + b} @tab @code{add.ps}
8511 @item @code{a - b} @tab @code{sub.ps}
8512 @item @code{-a} @tab @code{neg.ps}
8513 @item @code{a * b} @tab @code{mul.ps}
8514 @item @code{a * b + c} @tab @code{madd.ps}
8515 @item @code{a * b - c} @tab @code{msub.ps}
8516 @item @code{-(a * b + c)} @tab @code{nmadd.ps}
8517 @item @code{-(a * b - c)} @tab @code{nmsub.ps}
8518 @item @code{x ? a : b} @tab @code{movn.ps}/@code{movz.ps}
8519 @end multitable
8520
8521 Note that the multiply-accumulate instructions can be disabled
8522 using the command-line option @code{-mno-fused-madd}.
8523
8524 @node Paired-Single Built-in Functions
8525 @subsubsection Paired-Single Built-in Functions
8526
8527 The following paired-single functions map directly to a particular
8528 MIPS instruction.  Please refer to the architecture specification
8529 for details on what each instruction does.
8530
8531 @table @code
8532 @item v2sf __builtin_mips_pll_ps (v2sf, v2sf)
8533 Pair lower lower (@code{pll.ps}).
8534
8535 @item v2sf __builtin_mips_pul_ps (v2sf, v2sf)
8536 Pair upper lower (@code{pul.ps}).
8537
8538 @item v2sf __builtin_mips_plu_ps (v2sf, v2sf)
8539 Pair lower upper (@code{plu.ps}).
8540
8541 @item v2sf __builtin_mips_puu_ps (v2sf, v2sf)
8542 Pair upper upper (@code{puu.ps}).
8543
8544 @item v2sf __builtin_mips_cvt_ps_s (float, float)
8545 Convert pair to paired single (@code{cvt.ps.s}).
8546
8547 @item float __builtin_mips_cvt_s_pl (v2sf)
8548 Convert pair lower to single (@code{cvt.s.pl}).
8549
8550 @item float __builtin_mips_cvt_s_pu (v2sf)
8551 Convert pair upper to single (@code{cvt.s.pu}).
8552
8553 @item v2sf __builtin_mips_abs_ps (v2sf)
8554 Absolute value (@code{abs.ps}).
8555
8556 @item v2sf __builtin_mips_alnv_ps (v2sf, v2sf, int)
8557 Align variable (@code{alnv.ps}).
8558
8559 @emph{Note:} The value of the third parameter must be 0 or 4
8560 modulo 8, otherwise the result will be unpredictable.  Please read the
8561 instruction description for details.
8562 @end table
8563
8564 The following multi-instruction functions are also available.
8565 In each case, @var{cond} can be any of the 16 floating-point conditions:
8566 @code{f}, @code{un}, @code{eq}, @code{ueq}, @code{olt}, @code{ult},
8567 @code{ole}, @code{ule}, @code{sf}, @code{ngle}, @code{seq}, @code{ngl},
8568 @code{lt}, @code{nge}, @code{le} or @code{ngt}.
8569
8570 @table @code
8571 @item v2sf __builtin_mips_movt_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
8572 @itemx v2sf __builtin_mips_movf_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
8573 Conditional move based on floating point comparison (@code{c.@var{cond}.ps},
8574 @code{movt.ps}/@code{movf.ps}).
8575
8576 The @code{movt} functions return the value @var{x} computed by:
8577
8578 @smallexample
8579 c.@var{cond}.ps @var{cc},@var{a},@var{b}
8580 mov.ps @var{x},@var{c}
8581 movt.ps @var{x},@var{d},@var{cc}
8582 @end smallexample
8583
8584 The @code{movf} functions are similar but use @code{movf.ps} instead
8585 of @code{movt.ps}.
8586
8587 @item int __builtin_mips_upper_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
8588 @itemx int __builtin_mips_lower_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
8589 Comparison of two paired-single values (@code{c.@var{cond}.ps},
8590 @code{bc1t}/@code{bc1f}).
8591
8592 These functions compare @var{a} and @var{b} using @code{c.@var{cond}.ps}
8593 and return either the upper or lower half of the result.  For example:
8594
8595 @smallexample
8596 v2sf a, b;
8597 if (__builtin_mips_upper_c_eq_ps (a, b))
8598   upper_halves_are_equal ();
8599 else
8600   upper_halves_are_unequal ();
8601
8602 if (__builtin_mips_lower_c_eq_ps (a, b))
8603   lower_halves_are_equal ();
8604 else
8605   lower_halves_are_unequal ();
8606 @end smallexample
8607 @end table
8608
8609 @node MIPS-3D Built-in Functions
8610 @subsubsection MIPS-3D Built-in Functions
8611
8612 The MIPS-3D Application-Specific Extension (ASE) includes additional
8613 paired-single instructions that are designed to improve the performance
8614 of 3D graphics operations.  Support for these instructions is controlled
8615 by the @option{-mips3d} command-line option.
8616
8617 The functions listed below map directly to a particular MIPS-3D
8618 instruction.  Please refer to the architecture specification for
8619 more details on what each instruction does.
8620
8621 @table @code
8622 @item v2sf __builtin_mips_addr_ps (v2sf, v2sf)
8623 Reduction add (@code{addr.ps}).
8624
8625 @item v2sf __builtin_mips_mulr_ps (v2sf, v2sf)
8626 Reduction multiply (@code{mulr.ps}).
8627
8628 @item v2sf __builtin_mips_cvt_pw_ps (v2sf)
8629 Convert paired single to paired word (@code{cvt.pw.ps}).
8630
8631 @item v2sf __builtin_mips_cvt_ps_pw (v2sf)
8632 Convert paired word to paired single (@code{cvt.ps.pw}).
8633
8634 @item float __builtin_mips_recip1_s (float)
8635 @itemx double __builtin_mips_recip1_d (double)
8636 @itemx v2sf __builtin_mips_recip1_ps (v2sf)
8637 Reduced precision reciprocal (sequence step 1) (@code{recip1.@var{fmt}}).
8638
8639 @item float __builtin_mips_recip2_s (float, float)
8640 @itemx double __builtin_mips_recip2_d (double, double)
8641 @itemx v2sf __builtin_mips_recip2_ps (v2sf, v2sf)
8642 Reduced precision reciprocal (sequence step 2) (@code{recip2.@var{fmt}}).
8643
8644 @item float __builtin_mips_rsqrt1_s (float)
8645 @itemx double __builtin_mips_rsqrt1_d (double)
8646 @itemx v2sf __builtin_mips_rsqrt1_ps (v2sf)
8647 Reduced precision reciprocal square root (sequence step 1)
8648 (@code{rsqrt1.@var{fmt}}).
8649
8650 @item float __builtin_mips_rsqrt2_s (float, float)
8651 @itemx double __builtin_mips_rsqrt2_d (double, double)
8652 @itemx v2sf __builtin_mips_rsqrt2_ps (v2sf, v2sf)
8653 Reduced precision reciprocal square root (sequence step 2)
8654 (@code{rsqrt2.@var{fmt}}).
8655 @end table
8656
8657 The following multi-instruction functions are also available.
8658 In each case, @var{cond} can be any of the 16 floating-point conditions:
8659 @code{f}, @code{un}, @code{eq}, @code{ueq}, @code{olt}, @code{ult},
8660 @code{ole}, @code{ule}, @code{sf}, @code{ngle}, @code{seq},
8661 @code{ngl}, @code{lt}, @code{nge}, @code{le} or @code{ngt}.
8662
8663 @table @code
8664 @item int __builtin_mips_cabs_@var{cond}_s (float @var{a}, float @var{b})
8665 @itemx int __builtin_mips_cabs_@var{cond}_d (double @var{a}, double @var{b})
8666 Absolute comparison of two scalar values (@code{cabs.@var{cond}.@var{fmt}},
8667 @code{bc1t}/@code{bc1f}).
8668
8669 These functions compare @var{a} and @var{b} using @code{cabs.@var{cond}.s}
8670 or @code{cabs.@var{cond}.d} and return the result as a boolean value.
8671 For example:
8672
8673 @smallexample
8674 float a, b;
8675 if (__builtin_mips_cabs_eq_s (a, b))
8676   true ();
8677 else
8678   false ();
8679 @end smallexample
8680
8681 @item int __builtin_mips_upper_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
8682 @itemx int __builtin_mips_lower_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
8683 Absolute comparison of two paired-single values (@code{cabs.@var{cond}.ps},
8684 @code{bc1t}/@code{bc1f}).
8685
8686 These functions compare @var{a} and @var{b} using @code{cabs.@var{cond}.ps}
8687 and return either the upper or lower half of the result.  For example:
8688
8689 @smallexample
8690 v2sf a, b;
8691 if (__builtin_mips_upper_cabs_eq_ps (a, b))
8692   upper_halves_are_equal ();
8693 else
8694   upper_halves_are_unequal ();
8695
8696 if (__builtin_mips_lower_cabs_eq_ps (a, b))
8697   lower_halves_are_equal ();
8698 else
8699   lower_halves_are_unequal ();
8700 @end smallexample
8701
8702 @item v2sf __builtin_mips_movt_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
8703 @itemx v2sf __builtin_mips_movf_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
8704 Conditional move based on absolute comparison (@code{cabs.@var{cond}.ps},
8705 @code{movt.ps}/@code{movf.ps}).
8706
8707 The @code{movt} functions return the value @var{x} computed by:
8708
8709 @smallexample
8710 cabs.@var{cond}.ps @var{cc},@var{a},@var{b}
8711 mov.ps @var{x},@var{c}
8712 movt.ps @var{x},@var{d},@var{cc}
8713 @end smallexample
8714
8715 The @code{movf} functions are similar but use @code{movf.ps} instead
8716 of @code{movt.ps}.
8717
8718 @item int __builtin_mips_any_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
8719 @itemx int __builtin_mips_all_c_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
8720 @itemx int __builtin_mips_any_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
8721 @itemx int __builtin_mips_all_cabs_@var{cond}_ps (v2sf @var{a}, v2sf @var{b})
8722 Comparison of two paired-single values
8723 (@code{c.@var{cond}.ps}/@code{cabs.@var{cond}.ps},
8724 @code{bc1any2t}/@code{bc1any2f}).
8725
8726 These functions compare @var{a} and @var{b} using @code{c.@var{cond}.ps}
8727 or @code{cabs.@var{cond}.ps}.  The @code{any} forms return true if either
8728 result is true and the @code{all} forms return true if both results are true.
8729 For example:
8730
8731 @smallexample
8732 v2sf a, b;
8733 if (__builtin_mips_any_c_eq_ps (a, b))
8734   one_is_true ();
8735 else
8736   both_are_false ();
8737
8738 if (__builtin_mips_all_c_eq_ps (a, b))
8739   both_are_true ();
8740 else
8741   one_is_false ();
8742 @end smallexample
8743
8744 @item int __builtin_mips_any_c_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
8745 @itemx int __builtin_mips_all_c_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
8746 @itemx int __builtin_mips_any_cabs_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
8747 @itemx int __builtin_mips_all_cabs_@var{cond}_4s (v2sf @var{a}, v2sf @var{b}, v2sf @var{c}, v2sf @var{d})
8748 Comparison of four paired-single values
8749 (@code{c.@var{cond}.ps}/@code{cabs.@var{cond}.ps},
8750 @code{bc1any4t}/@code{bc1any4f}).
8751
8752 These functions use @code{c.@var{cond}.ps} or @code{cabs.@var{cond}.ps}
8753 to compare @var{a} with @var{b} and to compare @var{c} with @var{d}.
8754 The @code{any} forms return true if any of the four results are true
8755 and the @code{all} forms return true if all four results are true.
8756 For example:
8757
8758 @smallexample
8759 v2sf a, b, c, d;
8760 if (__builtin_mips_any_c_eq_4s (a, b, c, d))
8761   some_are_true ();
8762 else
8763   all_are_false ();
8764
8765 if (__builtin_mips_all_c_eq_4s (a, b, c, d))
8766   all_are_true ();
8767 else
8768   some_are_false ();
8769 @end smallexample
8770 @end table
8771
8772 @node PowerPC AltiVec Built-in Functions
8773 @subsection PowerPC AltiVec Built-in Functions
8774
8775 GCC provides an interface for the PowerPC family of processors to access
8776 the AltiVec operations described in Motorola's AltiVec Programming
8777 Interface Manual.  The interface is made available by including
8778 @code{<altivec.h>} and using @option{-maltivec} and
8779 @option{-mabi=altivec}.  The interface supports the following vector
8780 types.
8781
8782 @smallexample
8783 vector unsigned char
8784 vector signed char
8785 vector bool char
8786
8787 vector unsigned short
8788 vector signed short
8789 vector bool short
8790 vector pixel
8791
8792 vector unsigned int
8793 vector signed int
8794 vector bool int
8795 vector float
8796 @end smallexample
8797
8798 GCC's implementation of the high-level language interface available from
8799 C and C++ code differs from Motorola's documentation in several ways.
8800
8801 @itemize @bullet
8802
8803 @item
8804 A vector constant is a list of constant expressions within curly braces.
8805
8806 @item
8807 A vector initializer requires no cast if the vector constant is of the
8808 same type as the variable it is initializing.
8809
8810 @item
8811 If @code{signed} or @code{unsigned} is omitted, the signedness of the
8812 vector type is the default signedness of the base type.  The default
8813 varies depending on the operating system, so a portable program should
8814 always specify the signedness.
8815
8816 @item
8817 Compiling with @option{-maltivec} adds keywords @code{__vector},
8818 @code{__pixel}, and @code{__bool}.  Macros @option{vector},
8819 @code{pixel}, and @code{bool} are defined in @code{<altivec.h>} and can
8820 be undefined.
8821
8822 @item
8823 GCC allows using a @code{typedef} name as the type specifier for a
8824 vector type.
8825
8826 @item
8827 For C, overloaded functions are implemented with macros so the following
8828 does not work:
8829
8830 @smallexample
8831   vec_add ((vector signed int)@{1, 2, 3, 4@}, foo);
8832 @end smallexample
8833
8834 Since @code{vec_add} is a macro, the vector constant in the example
8835 is treated as four separate arguments.  Wrap the entire argument in
8836 parentheses for this to work.
8837 @end itemize
8838
8839 @emph{Note:} Only the @code{<altivec.h>} interface is supported.
8840 Internally, GCC uses built-in functions to achieve the functionality in
8841 the aforementioned header file, but they are not supported and are
8842 subject to change without notice.
8843
8844 The following interfaces are supported for the generic and specific
8845 AltiVec operations and the AltiVec predicates.  In cases where there
8846 is a direct mapping between generic and specific operations, only the
8847 generic names are shown here, although the specific operations can also
8848 be used.
8849
8850 Arguments that are documented as @code{const int} require literal
8851 integral values within the range required for that operation.
8852
8853 @smallexample
8854 vector signed char vec_abs (vector signed char);
8855 vector signed short vec_abs (vector signed short);
8856 vector signed int vec_abs (vector signed int);
8857 vector float vec_abs (vector float);
8858
8859 vector signed char vec_abss (vector signed char);
8860 vector signed short vec_abss (vector signed short);
8861 vector signed int vec_abss (vector signed int);
8862
8863 vector signed char vec_add (vector bool char, vector signed char);
8864 vector signed char vec_add (vector signed char, vector bool char);
8865 vector signed char vec_add (vector signed char, vector signed char);
8866 vector unsigned char vec_add (vector bool char, vector unsigned char);
8867 vector unsigned char vec_add (vector unsigned char, vector bool char);
8868 vector unsigned char vec_add (vector unsigned char,
8869                               vector unsigned char);
8870 vector signed short vec_add (vector bool short, vector signed short);
8871 vector signed short vec_add (vector signed short, vector bool short);
8872 vector signed short vec_add (vector signed short, vector signed short);
8873 vector unsigned short vec_add (vector bool short,
8874                                vector unsigned short);
8875 vector unsigned short vec_add (vector unsigned short,
8876                                vector bool short);
8877 vector unsigned short vec_add (vector unsigned short,
8878                                vector unsigned short);
8879 vector signed int vec_add (vector bool int, vector signed int);
8880 vector signed int vec_add (vector signed int, vector bool int);
8881 vector signed int vec_add (vector signed int, vector signed int);
8882 vector unsigned int vec_add (vector bool int, vector unsigned int);
8883 vector unsigned int vec_add (vector unsigned int, vector bool int);
8884 vector unsigned int vec_add (vector unsigned int, vector unsigned int);
8885 vector float vec_add (vector float, vector float);
8886
8887 vector float vec_vaddfp (vector float, vector float);
8888
8889 vector signed int vec_vadduwm (vector bool int, vector signed int);
8890 vector signed int vec_vadduwm (vector signed int, vector bool int);
8891 vector signed int vec_vadduwm (vector signed int, vector signed int);
8892 vector unsigned int vec_vadduwm (vector bool int, vector unsigned int);
8893 vector unsigned int vec_vadduwm (vector unsigned int, vector bool int);
8894 vector unsigned int vec_vadduwm (vector unsigned int,
8895                                  vector unsigned int);
8896
8897 vector signed short vec_vadduhm (vector bool short,
8898                                  vector signed short);
8899 vector signed short vec_vadduhm (vector signed short,
8900                                  vector bool short);
8901 vector signed short vec_vadduhm (vector signed short,
8902                                  vector signed short);
8903 vector unsigned short vec_vadduhm (vector bool short,
8904                                    vector unsigned short);
8905 vector unsigned short vec_vadduhm (vector unsigned short,
8906                                    vector bool short);
8907 vector unsigned short vec_vadduhm (vector unsigned short,
8908                                    vector unsigned short);
8909
8910 vector signed char vec_vaddubm (vector bool char, vector signed char);
8911 vector signed char vec_vaddubm (vector signed char, vector bool char);
8912 vector signed char vec_vaddubm (vector signed char, vector signed char);
8913 vector unsigned char vec_vaddubm (vector bool char,
8914                                   vector unsigned char);
8915 vector unsigned char vec_vaddubm (vector unsigned char,
8916                                   vector bool char);
8917 vector unsigned char vec_vaddubm (vector unsigned char,
8918                                   vector unsigned char);
8919
8920 vector unsigned int vec_addc (vector unsigned int, vector unsigned int);
8921
8922 vector unsigned char vec_adds (vector bool char, vector unsigned char);
8923 vector unsigned char vec_adds (vector unsigned char, vector bool char);
8924 vector unsigned char vec_adds (vector unsigned char,
8925                                vector unsigned char);
8926 vector signed char vec_adds (vector bool char, vector signed char);
8927 vector signed char vec_adds (vector signed char, vector bool char);
8928 vector signed char vec_adds (vector signed char, vector signed char);
8929 vector unsigned short vec_adds (vector bool short,
8930                                 vector unsigned short);
8931 vector unsigned short vec_adds (vector unsigned short,
8932                                 vector bool short);
8933 vector unsigned short vec_adds (vector unsigned short,
8934                                 vector unsigned short);
8935 vector signed short vec_adds (vector bool short, vector signed short);
8936 vector signed short vec_adds (vector signed short, vector bool short);
8937 vector signed short vec_adds (vector signed short, vector signed short);
8938 vector unsigned int vec_adds (vector bool int, vector unsigned int);
8939 vector unsigned int vec_adds (vector unsigned int, vector bool int);
8940 vector unsigned int vec_adds (vector unsigned int, vector unsigned int);
8941 vector signed int vec_adds (vector bool int, vector signed int);
8942 vector signed int vec_adds (vector signed int, vector bool int);
8943 vector signed int vec_adds (vector signed int, vector signed int);
8944
8945 vector signed int vec_vaddsws (vector bool int, vector signed int);
8946 vector signed int vec_vaddsws (vector signed int, vector bool int);
8947 vector signed int vec_vaddsws (vector signed int, vector signed int);
8948
8949 vector unsigned int vec_vadduws (vector bool int, vector unsigned int);
8950 vector unsigned int vec_vadduws (vector unsigned int, vector bool int);
8951 vector unsigned int vec_vadduws (vector unsigned int,
8952                                  vector unsigned int);
8953
8954 vector signed short vec_vaddshs (vector bool short,
8955                                  vector signed short);
8956 vector signed short vec_vaddshs (vector signed short,
8957                                  vector bool short);
8958 vector signed short vec_vaddshs (vector signed short,
8959                                  vector signed short);
8960
8961 vector unsigned short vec_vadduhs (vector bool short,
8962                                    vector unsigned short);
8963 vector unsigned short vec_vadduhs (vector unsigned short,
8964                                    vector bool short);
8965 vector unsigned short vec_vadduhs (vector unsigned short,
8966                                    vector unsigned short);
8967
8968 vector signed char vec_vaddsbs (vector bool char, vector signed char);
8969 vector signed char vec_vaddsbs (vector signed char, vector bool char);
8970 vector signed char vec_vaddsbs (vector signed char, vector signed char);
8971
8972 vector unsigned char vec_vaddubs (vector bool char,
8973                                   vector unsigned char);
8974 vector unsigned char vec_vaddubs (vector unsigned char,
8975                                   vector bool char);
8976 vector unsigned char vec_vaddubs (vector unsigned char,
8977                                   vector unsigned char);
8978
8979 vector float vec_and (vector float, vector float);
8980 vector float vec_and (vector float, vector bool int);
8981 vector float vec_and (vector bool int, vector float);
8982 vector bool int vec_and (vector bool int, vector bool int);
8983 vector signed int vec_and (vector bool int, vector signed int);
8984 vector signed int vec_and (vector signed int, vector bool int);
8985 vector signed int vec_and (vector signed int, vector signed int);
8986 vector unsigned int vec_and (vector bool int, vector unsigned int);
8987 vector unsigned int vec_and (vector unsigned int, vector bool int);
8988 vector unsigned int vec_and (vector unsigned int, vector unsigned int);
8989 vector bool short vec_and (vector bool short, vector bool short);
8990 vector signed short vec_and (vector bool short, vector signed short);
8991 vector signed short vec_and (vector signed short, vector bool short);
8992 vector signed short vec_and (vector signed short, vector signed short);
8993 vector unsigned short vec_and (vector bool short,
8994                                vector unsigned short);
8995 vector unsigned short vec_and (vector unsigned short,
8996                                vector bool short);
8997 vector unsigned short vec_and (vector unsigned short,
8998                                vector unsigned short);
8999 vector signed char vec_and (vector bool char, vector signed char);
9000 vector bool char vec_and (vector bool char, vector bool char);
9001 vector signed char vec_and (vector signed char, vector bool char);
9002 vector signed char vec_and (vector signed char, vector signed char);
9003 vector unsigned char vec_and (vector bool char, vector unsigned char);
9004 vector unsigned char vec_and (vector unsigned char, vector bool char);
9005 vector unsigned char vec_and (vector unsigned char,
9006                               vector unsigned char);
9007
9008 vector float vec_andc (vector float, vector float);
9009 vector float vec_andc (vector float, vector bool int);
9010 vector float vec_andc (vector bool int, vector float);
9011 vector bool int vec_andc (vector bool int, vector bool int);
9012 vector signed int vec_andc (vector bool int, vector signed int);
9013 vector signed int vec_andc (vector signed int, vector bool int);
9014 vector signed int vec_andc (vector signed int, vector signed int);
9015 vector unsigned int vec_andc (vector bool int, vector unsigned int);
9016 vector unsigned int vec_andc (vector unsigned int, vector bool int);
9017 vector unsigned int vec_andc (vector unsigned int, vector unsigned int);
9018 vector bool short vec_andc (vector bool short, vector bool short);
9019 vector signed short vec_andc (vector bool short, vector signed short);
9020 vector signed short vec_andc (vector signed short, vector bool short);
9021 vector signed short vec_andc (vector signed short, vector signed short);
9022 vector unsigned short vec_andc (vector bool short,
9023                                 vector unsigned short);
9024 vector unsigned short vec_andc (vector unsigned short,
9025                                 vector bool short);
9026 vector unsigned short vec_andc (vector unsigned short,
9027                                 vector unsigned short);
9028 vector signed char vec_andc (vector bool char, vector signed char);
9029 vector bool char vec_andc (vector bool char, vector bool char);
9030 vector signed char vec_andc (vector signed char, vector bool char);
9031 vector signed char vec_andc (vector signed char, vector signed char);
9032 vector unsigned char vec_andc (vector bool char, vector unsigned char);
9033 vector unsigned char vec_andc (vector unsigned char, vector bool char);
9034 vector unsigned char vec_andc (vector unsigned char,
9035                                vector unsigned char);
9036
9037 vector unsigned char vec_avg (vector unsigned char,
9038                               vector unsigned char);
9039 vector signed char vec_avg (vector signed char, vector signed char);
9040 vector unsigned short vec_avg (vector unsigned short,
9041                                vector unsigned short);
9042 vector signed short vec_avg (vector signed short, vector signed short);
9043 vector unsigned int vec_avg (vector unsigned int, vector unsigned int);
9044 vector signed int vec_avg (vector signed int, vector signed int);
9045
9046 vector signed int vec_vavgsw (vector signed int, vector signed int);
9047
9048 vector unsigned int vec_vavguw (vector unsigned int,
9049                                 vector unsigned int);
9050
9051 vector signed short vec_vavgsh (vector signed short,
9052                                 vector signed short);
9053
9054 vector unsigned short vec_vavguh (vector unsigned short,
9055                                   vector unsigned short);
9056
9057 vector signed char vec_vavgsb (vector signed char, vector signed char);
9058
9059 vector unsigned char vec_vavgub (vector unsigned char,
9060                                  vector unsigned char);
9061
9062 vector float vec_ceil (vector float);
9063
9064 vector signed int vec_cmpb (vector float, vector float);
9065
9066 vector bool char vec_cmpeq (vector signed char, vector signed char);
9067 vector bool char vec_cmpeq (vector unsigned char, vector unsigned char);
9068 vector bool short vec_cmpeq (vector signed short, vector signed short);
9069 vector bool short vec_cmpeq (vector unsigned short,
9070                              vector unsigned short);
9071 vector bool int vec_cmpeq (vector signed int, vector signed int);
9072 vector bool int vec_cmpeq (vector unsigned int, vector unsigned int);
9073 vector bool int vec_cmpeq (vector float, vector float);
9074
9075 vector bool int vec_vcmpeqfp (vector float, vector float);
9076
9077 vector bool int vec_vcmpequw (vector signed int, vector signed int);
9078 vector bool int vec_vcmpequw (vector unsigned int, vector unsigned int);
9079
9080 vector bool short vec_vcmpequh (vector signed short,
9081                                 vector signed short);
9082 vector bool short vec_vcmpequh (vector unsigned short,
9083                                 vector unsigned short);
9084
9085 vector bool char vec_vcmpequb (vector signed char, vector signed char);
9086 vector bool char vec_vcmpequb (vector unsigned char,
9087                                vector unsigned char);
9088
9089 vector bool int vec_cmpge (vector float, vector float);
9090
9091 vector bool char vec_cmpgt (vector unsigned char, vector unsigned char);
9092 vector bool char vec_cmpgt (vector signed char, vector signed char);
9093 vector bool short vec_cmpgt (vector unsigned short,
9094                              vector unsigned short);
9095 vector bool short vec_cmpgt (vector signed short, vector signed short);
9096 vector bool int vec_cmpgt (vector unsigned int, vector unsigned int);
9097 vector bool int vec_cmpgt (vector signed int, vector signed int);
9098 vector bool int vec_cmpgt (vector float, vector float);
9099
9100 vector bool int vec_vcmpgtfp (vector float, vector float);
9101
9102 vector bool int vec_vcmpgtsw (vector signed int, vector signed int);
9103
9104 vector bool int vec_vcmpgtuw (vector unsigned int, vector unsigned int);
9105
9106 vector bool short vec_vcmpgtsh (vector signed short,
9107                                 vector signed short);
9108
9109 vector bool short vec_vcmpgtuh (vector unsigned short,
9110                                 vector unsigned short);
9111
9112 vector bool char vec_vcmpgtsb (vector signed char, vector signed char);
9113
9114 vector bool char vec_vcmpgtub (vector unsigned char,
9115                                vector unsigned char);
9116
9117 vector bool int vec_cmple (vector float, vector float);
9118
9119 vector bool char vec_cmplt (vector unsigned char, vector unsigned char);
9120 vector bool char vec_cmplt (vector signed char, vector signed char);
9121 vector bool short vec_cmplt (vector unsigned short,
9122                              vector unsigned short);
9123 vector bool short vec_cmplt (vector signed short, vector signed short);
9124 vector bool int vec_cmplt (vector unsigned int, vector unsigned int);
9125 vector bool int vec_cmplt (vector signed int, vector signed int);
9126 vector bool int vec_cmplt (vector float, vector float);
9127
9128 vector float vec_ctf (vector unsigned int, const int);
9129 vector float vec_ctf (vector signed int, const int);
9130
9131 vector float vec_vcfsx (vector signed int, const int);
9132
9133 vector float vec_vcfux (vector unsigned int, const int);
9134
9135 vector signed int vec_cts (vector float, const int);
9136
9137 vector unsigned int vec_ctu (vector float, const int);
9138
9139 void vec_dss (const int);
9140
9141 void vec_dssall (void);
9142
9143 void vec_dst (const vector unsigned char *, int, const int);
9144 void vec_dst (const vector signed char *, int, const int);
9145 void vec_dst (const vector bool char *, int, const int);
9146 void vec_dst (const vector unsigned short *, int, const int);
9147 void vec_dst (const vector signed short *, int, const int);
9148 void vec_dst (const vector bool short *, int, const int);
9149 void vec_dst (const vector pixel *, int, const int);
9150 void vec_dst (const vector unsigned int *, int, const int);
9151 void vec_dst (const vector signed int *, int, const int);
9152 void vec_dst (const vector bool int *, int, const int);
9153 void vec_dst (const vector float *, int, const int);
9154 void vec_dst (const unsigned char *, int, const int);
9155 void vec_dst (const signed char *, int, const int);
9156 void vec_dst (const unsigned short *, int, const int);
9157 void vec_dst (const short *, int, const int);
9158 void vec_dst (const unsigned int *, int, const int);
9159 void vec_dst (const int *, int, const int);
9160 void vec_dst (const unsigned long *, int, const int);
9161 void vec_dst (const long *, int, const int);
9162 void vec_dst (const float *, int, const int);
9163
9164 void vec_dstst (const vector unsigned char *, int, const int);
9165 void vec_dstst (const vector signed char *, int, const int);
9166 void vec_dstst (const vector bool char *, int, const int);
9167 void vec_dstst (const vector unsigned short *, int, const int);
9168 void vec_dstst (const vector signed short *, int, const int);
9169 void vec_dstst (const vector bool short *, int, const int);
9170 void vec_dstst (const vector pixel *, int, const int);
9171 void vec_dstst (const vector unsigned int *, int, const int);
9172 void vec_dstst (const vector signed int *, int, const int);
9173 void vec_dstst (const vector bool int *, int, const int);
9174 void vec_dstst (const vector float *, int, const int);
9175 void vec_dstst (const unsigned char *, int, const int);
9176 void vec_dstst (const signed char *, int, const int);
9177 void vec_dstst (const unsigned short *, int, const int);
9178 void vec_dstst (const short *, int, const int);
9179 void vec_dstst (const unsigned int *, int, const int);
9180 void vec_dstst (const int *, int, const int);
9181 void vec_dstst (const unsigned long *, int, const int);
9182 void vec_dstst (const long *, int, const int);
9183 void vec_dstst (const float *, int, const int);
9184
9185 void vec_dststt (const vector unsigned char *, int, const int);
9186 void vec_dststt (const vector signed char *, int, const int);
9187 void vec_dststt (const vector bool char *, int, const int);
9188 void vec_dststt (const vector unsigned short *, int, const int);
9189 void vec_dststt (const vector signed short *, int, const int);
9190 void vec_dststt (const vector bool short *, int, const int);
9191 void vec_dststt (const vector pixel *, int, const int);
9192 void vec_dststt (const vector unsigned int *, int, const int);
9193 void vec_dststt (const vector signed int *, int, const int);
9194 void vec_dststt (const vector bool int *, int, const int);
9195 void vec_dststt (const vector float *, int, const int);
9196 void vec_dststt (const unsigned char *, int, const int);
9197 void vec_dststt (const signed char *, int, const int);
9198 void vec_dststt (const unsigned short *, int, const int);
9199 void vec_dststt (const short *, int, const int);
9200 void vec_dststt (const unsigned int *, int, const int);
9201 void vec_dststt (const int *, int, const int);
9202 void vec_dststt (const unsigned long *, int, const int);
9203 void vec_dststt (const long *, int, const int);
9204 void vec_dststt (const float *, int, const int);
9205
9206 void vec_dstt (const vector unsigned char *, int, const int);
9207 void vec_dstt (const vector signed char *, int, const int);
9208 void vec_dstt (const vector bool char *, int, const int);
9209 void vec_dstt (const vector unsigned short *, int, const int);
9210 void vec_dstt (const vector signed short *, int, const int);
9211 void vec_dstt (const vector bool short *, int, const int);
9212 void vec_dstt (const vector pixel *, int, const int);
9213 void vec_dstt (const vector unsigned int *, int, const int);
9214 void vec_dstt (const vector signed int *, int, const int);
9215 void vec_dstt (const vector bool int *, int, const int);
9216 void vec_dstt (const vector float *, int, const int);
9217 void vec_dstt (const unsigned char *, int, const int);
9218 void vec_dstt (const signed char *, int, const int);
9219 void vec_dstt (const unsigned short *, int, const int);
9220 void vec_dstt (const short *, int, const int);
9221 void vec_dstt (const unsigned int *, int, const int);
9222 void vec_dstt (const int *, int, const int);
9223 void vec_dstt (const unsigned long *, int, const int);
9224 void vec_dstt (const long *, int, const int);
9225 void vec_dstt (const float *, int, const int);
9226
9227 vector float vec_expte (vector float);
9228
9229 vector float vec_floor (vector float);
9230
9231 vector float vec_ld (int, const vector float *);
9232 vector float vec_ld (int, const float *);
9233 vector bool int vec_ld (int, const vector bool int *);
9234 vector signed int vec_ld (int, const vector signed int *);
9235 vector signed int vec_ld (int, const int *);
9236 vector signed int vec_ld (int, const long *);
9237 vector unsigned int vec_ld (int, const vector unsigned int *);
9238 vector unsigned int vec_ld (int, const unsigned int *);
9239 vector unsigned int vec_ld (int, const unsigned long *);
9240 vector bool short vec_ld (int, const vector bool short *);
9241 vector pixel vec_ld (int, const vector pixel *);
9242 vector signed short vec_ld (int, const vector signed short *);
9243 vector signed short vec_ld (int, const short *);
9244 vector unsigned short vec_ld (int, const vector unsigned short *);
9245 vector unsigned short vec_ld (int, const unsigned short *);
9246 vector bool char vec_ld (int, const vector bool char *);
9247 vector signed char vec_ld (int, const vector signed char *);
9248 vector signed char vec_ld (int, const signed char *);
9249 vector unsigned char vec_ld (int, const vector unsigned char *);
9250 vector unsigned char vec_ld (int, const unsigned char *);
9251
9252 vector signed char vec_lde (int, const signed char *);
9253 vector unsigned char vec_lde (int, const unsigned char *);
9254 vector signed short vec_lde (int, const short *);
9255 vector unsigned short vec_lde (int, const unsigned short *);
9256 vector float vec_lde (int, const float *);
9257 vector signed int vec_lde (int, const int *);
9258 vector unsigned int vec_lde (int, const unsigned int *);
9259 vector signed int vec_lde (int, const long *);
9260 vector unsigned int vec_lde (int, const unsigned long *);
9261
9262 vector float vec_lvewx (int, float *);
9263 vector signed int vec_lvewx (int, int *);
9264 vector unsigned int vec_lvewx (int, unsigned int *);
9265 vector signed int vec_lvewx (int, long *);
9266 vector unsigned int vec_lvewx (int, unsigned long *);
9267
9268 vector signed short vec_lvehx (int, short *);
9269 vector unsigned short vec_lvehx (int, unsigned short *);
9270
9271 vector signed char vec_lvebx (int, char *);
9272 vector unsigned char vec_lvebx (int, unsigned char *);
9273
9274 vector float vec_ldl (int, const vector float *);
9275 vector float vec_ldl (int, const float *);
9276 vector bool int vec_ldl (int, const vector bool int *);
9277 vector signed int vec_ldl (int, const vector signed int *);
9278 vector signed int vec_ldl (int, const int *);
9279 vector signed int vec_ldl (int, const long *);
9280 vector unsigned int vec_ldl (int, const vector unsigned int *);
9281 vector unsigned int vec_ldl (int, const unsigned int *);
9282 vector unsigned int vec_ldl (int, const unsigned long *);
9283 vector bool short vec_ldl (int, const vector bool short *);
9284 vector pixel vec_ldl (int, const vector pixel *);
9285 vector signed short vec_ldl (int, const vector signed short *);
9286 vector signed short vec_ldl (int, const short *);
9287 vector unsigned short vec_ldl (int, const vector unsigned short *);
9288 vector unsigned short vec_ldl (int, const unsigned short *);
9289 vector bool char vec_ldl (int, const vector bool char *);
9290 vector signed char vec_ldl (int, const vector signed char *);
9291 vector signed char vec_ldl (int, const signed char *);
9292 vector unsigned char vec_ldl (int, const vector unsigned char *);
9293 vector unsigned char vec_ldl (int, const unsigned char *);
9294
9295 vector float vec_loge (vector float);
9296
9297 vector unsigned char vec_lvsl (int, const volatile unsigned char *);
9298 vector unsigned char vec_lvsl (int, const volatile signed char *);
9299 vector unsigned char vec_lvsl (int, const volatile unsigned short *);
9300 vector unsigned char vec_lvsl (int, const volatile short *);
9301 vector unsigned char vec_lvsl (int, const volatile unsigned int *);
9302 vector unsigned char vec_lvsl (int, const volatile int *);
9303 vector unsigned char vec_lvsl (int, const volatile unsigned long *);
9304 vector unsigned char vec_lvsl (int, const volatile long *);
9305 vector unsigned char vec_lvsl (int, const volatile float *);
9306
9307 vector unsigned char vec_lvsr (int, const volatile unsigned char *);
9308 vector unsigned char vec_lvsr (int, const volatile signed char *);
9309 vector unsigned char vec_lvsr (int, const volatile unsigned short *);
9310 vector unsigned char vec_lvsr (int, const volatile short *);
9311 vector unsigned char vec_lvsr (int, const volatile unsigned int *);
9312 vector unsigned char vec_lvsr (int, const volatile int *);
9313 vector unsigned char vec_lvsr (int, const volatile unsigned long *);
9314 vector unsigned char vec_lvsr (int, const volatile long *);
9315 vector unsigned char vec_lvsr (int, const volatile float *);
9316
9317 vector float vec_madd (vector float, vector float, vector float);
9318
9319 vector signed short vec_madds (vector signed short,
9320                                vector signed short,
9321                                vector signed short);
9322
9323 vector unsigned char vec_max (vector bool char, vector unsigned char);
9324 vector unsigned char vec_max (vector unsigned char, vector bool char);
9325 vector unsigned char vec_max (vector unsigned char,
9326                               vector unsigned char);
9327 vector signed char vec_max (vector bool char, vector signed char);
9328 vector signed char vec_max (vector signed char, vector bool char);
9329 vector signed char vec_max (vector signed char, vector signed char);
9330 vector unsigned short vec_max (vector bool short,
9331                                vector unsigned short);
9332 vector unsigned short vec_max (vector unsigned short,
9333                                vector bool short);
9334 vector unsigned short vec_max (vector unsigned short,
9335                                vector unsigned short);
9336 vector signed short vec_max (vector bool short, vector signed short);
9337 vector signed short vec_max (vector signed short, vector bool short);
9338 vector signed short vec_max (vector signed short, vector signed short);
9339 vector unsigned int vec_max (vector bool int, vector unsigned int);
9340 vector unsigned int vec_max (vector unsigned int, vector bool int);
9341 vector unsigned int vec_max (vector unsigned int, vector unsigned int);
9342 vector signed int vec_max (vector bool int, vector signed int);
9343 vector signed int vec_max (vector signed int, vector bool int);
9344 vector signed int vec_max (vector signed int, vector signed int);
9345 vector float vec_max (vector float, vector float);
9346
9347 vector float vec_vmaxfp (vector float, vector float);
9348
9349 vector signed int vec_vmaxsw (vector bool int, vector signed int);
9350 vector signed int vec_vmaxsw (vector signed int, vector bool int);
9351 vector signed int vec_vmaxsw (vector signed int, vector signed int);
9352
9353 vector unsigned int vec_vmaxuw (vector bool int, vector unsigned int);
9354 vector unsigned int vec_vmaxuw (vector unsigned int, vector bool int);
9355 vector unsigned int vec_vmaxuw (vector unsigned int,
9356                                 vector unsigned int);
9357
9358 vector signed short vec_vmaxsh (vector bool short, vector signed short);
9359 vector signed short vec_vmaxsh (vector signed short, vector bool short);
9360 vector signed short vec_vmaxsh (vector signed short,
9361                                 vector signed short);
9362
9363 vector unsigned short vec_vmaxuh (vector bool short,
9364                                   vector unsigned short);
9365 vector unsigned short vec_vmaxuh (vector unsigned short,
9366                                   vector bool short);
9367 vector unsigned short vec_vmaxuh (vector unsigned short,
9368                                   vector unsigned short);
9369
9370 vector signed char vec_vmaxsb (vector bool char, vector signed char);
9371 vector signed char vec_vmaxsb (vector signed char, vector bool char);
9372 vector signed char vec_vmaxsb (vector signed char, vector signed char);
9373
9374 vector unsigned char vec_vmaxub (vector bool char,
9375                                  vector unsigned char);
9376 vector unsigned char vec_vmaxub (vector unsigned char,
9377                                  vector bool char);
9378 vector unsigned char vec_vmaxub (vector unsigned char,
9379                                  vector unsigned char);
9380
9381 vector bool char vec_mergeh (vector bool char, vector bool char);
9382 vector signed char vec_mergeh (vector signed char, vector signed char);
9383 vector unsigned char vec_mergeh (vector unsigned char,
9384                                  vector unsigned char);
9385 vector bool short vec_mergeh (vector bool short, vector bool short);
9386 vector pixel vec_mergeh (vector pixel, vector pixel);
9387 vector signed short vec_mergeh (vector signed short,
9388                                 vector signed short);
9389 vector unsigned short vec_mergeh (vector unsigned short,
9390                                   vector unsigned short);
9391 vector float vec_mergeh (vector float, vector float);
9392 vector bool int vec_mergeh (vector bool int, vector bool int);
9393 vector signed int vec_mergeh (vector signed int, vector signed int);
9394 vector unsigned int vec_mergeh (vector unsigned int,
9395                                 vector unsigned int);
9396
9397 vector float vec_vmrghw (vector float, vector float);
9398 vector bool int vec_vmrghw (vector bool int, vector bool int);
9399 vector signed int vec_vmrghw (vector signed int, vector signed int);
9400 vector unsigned int vec_vmrghw (vector unsigned int,
9401                                 vector unsigned int);
9402
9403 vector bool short vec_vmrghh (vector bool short, vector bool short);
9404 vector signed short vec_vmrghh (vector signed short,
9405                                 vector signed short);
9406 vector unsigned short vec_vmrghh (vector unsigned short,
9407                                   vector unsigned short);
9408 vector pixel vec_vmrghh (vector pixel, vector pixel);
9409
9410 vector bool char vec_vmrghb (vector bool char, vector bool char);
9411 vector signed char vec_vmrghb (vector signed char, vector signed char);
9412 vector unsigned char vec_vmrghb (vector unsigned char,
9413                                  vector unsigned char);
9414
9415 vector bool char vec_mergel (vector bool char, vector bool char);
9416 vector signed char vec_mergel (vector signed char, vector signed char);
9417 vector unsigned char vec_mergel (vector unsigned char,
9418                                  vector unsigned char);
9419 vector bool short vec_mergel (vector bool short, vector bool short);
9420 vector pixel vec_mergel (vector pixel, vector pixel);
9421 vector signed short vec_mergel (vector signed short,
9422                                 vector signed short);
9423 vector unsigned short vec_mergel (vector unsigned short,
9424                                   vector unsigned short);
9425 vector float vec_mergel (vector float, vector float);
9426 vector bool int vec_mergel (vector bool int, vector bool int);
9427 vector signed int vec_mergel (vector signed int, vector signed int);
9428 vector unsigned int vec_mergel (vector unsigned int,
9429                                 vector unsigned int);
9430
9431 vector float vec_vmrglw (vector float, vector float);
9432 vector signed int vec_vmrglw (vector signed int, vector signed int);
9433 vector unsigned int vec_vmrglw (vector unsigned int,
9434                                 vector unsigned int);
9435 vector bool int vec_vmrglw (vector bool int, vector bool int);
9436
9437 vector bool short vec_vmrglh (vector bool short, vector bool short);
9438 vector signed short vec_vmrglh (vector signed short,
9439                                 vector signed short);
9440 vector unsigned short vec_vmrglh (vector unsigned short,
9441                                   vector unsigned short);
9442 vector pixel vec_vmrglh (vector pixel, vector pixel);
9443
9444 vector bool char vec_vmrglb (vector bool char, vector bool char);
9445 vector signed char vec_vmrglb (vector signed char, vector signed char);
9446 vector unsigned char vec_vmrglb (vector unsigned char,
9447                                  vector unsigned char);
9448
9449 vector unsigned short vec_mfvscr (void);
9450
9451 vector unsigned char vec_min (vector bool char, vector unsigned char);
9452 vector unsigned char vec_min (vector unsigned char, vector bool char);
9453 vector unsigned char vec_min (vector unsigned char,
9454                               vector unsigned char);
9455 vector signed char vec_min (vector bool char, vector signed char);
9456 vector signed char vec_min (vector signed char, vector bool char);
9457 vector signed char vec_min (vector signed char, vector signed char);
9458 vector unsigned short vec_min (vector bool short,
9459                                vector unsigned short);
9460 vector unsigned short vec_min (vector unsigned short,
9461                                vector bool short);
9462 vector unsigned short vec_min (vector unsigned short,
9463                                vector unsigned short);
9464 vector signed short vec_min (vector bool short, vector signed short);
9465 vector signed short vec_min (vector signed short, vector bool short);
9466 vector signed short vec_min (vector signed short, vector signed short);
9467 vector unsigned int vec_min (vector bool int, vector unsigned int);
9468 vector unsigned int vec_min (vector unsigned int, vector bool int);
9469 vector unsigned int vec_min (vector unsigned int, vector unsigned int);
9470 vector signed int vec_min (vector bool int, vector signed int);
9471 vector signed int vec_min (vector signed int, vector bool int);
9472 vector signed int vec_min (vector signed int, vector signed int);
9473 vector float vec_min (vector float, vector float);
9474
9475 vector float vec_vminfp (vector float, vector float);
9476
9477 vector signed int vec_vminsw (vector bool int, vector signed int);
9478 vector signed int vec_vminsw (vector signed int, vector bool int);
9479 vector signed int vec_vminsw (vector signed int, vector signed int);
9480
9481 vector unsigned int vec_vminuw (vector bool int, vector unsigned int);
9482 vector unsigned int vec_vminuw (vector unsigned int, vector bool int);
9483 vector unsigned int vec_vminuw (vector unsigned int,
9484                                 vector unsigned int);
9485
9486 vector signed short vec_vminsh (vector bool short, vector signed short);
9487 vector signed short vec_vminsh (vector signed short, vector bool short);
9488 vector signed short vec_vminsh (vector signed short,
9489                                 vector signed short);
9490
9491 vector unsigned short vec_vminuh (vector bool short,
9492                                   vector unsigned short);
9493 vector unsigned short vec_vminuh (vector unsigned short,
9494                                   vector bool short);
9495 vector unsigned short vec_vminuh (vector unsigned short,
9496                                   vector unsigned short);
9497
9498 vector signed char vec_vminsb (vector bool char, vector signed char);
9499 vector signed char vec_vminsb (vector signed char, vector bool char);
9500 vector signed char vec_vminsb (vector signed char, vector signed char);
9501
9502 vector unsigned char vec_vminub (vector bool char,
9503                                  vector unsigned char);
9504 vector unsigned char vec_vminub (vector unsigned char,
9505                                  vector bool char);
9506 vector unsigned char vec_vminub (vector unsigned char,
9507                                  vector unsigned char);
9508
9509 vector signed short vec_mladd (vector signed short,
9510                                vector signed short,
9511                                vector signed short);
9512 vector signed short vec_mladd (vector signed short,
9513                                vector unsigned short,
9514                                vector unsigned short);
9515 vector signed short vec_mladd (vector unsigned short,
9516                                vector signed short,
9517                                vector signed short);
9518 vector unsigned short vec_mladd (vector unsigned short,
9519                                  vector unsigned short,
9520                                  vector unsigned short);
9521
9522 vector signed short vec_mradds (vector signed short,
9523                                 vector signed short,
9524                                 vector signed short);
9525
9526 vector unsigned int vec_msum (vector unsigned char,
9527                               vector unsigned char,
9528                               vector unsigned int);
9529 vector signed int vec_msum (vector signed char,
9530                             vector unsigned char,
9531                             vector signed int);
9532 vector unsigned int vec_msum (vector unsigned short,
9533                               vector unsigned short,
9534                               vector unsigned int);
9535 vector signed int vec_msum (vector signed short,
9536                             vector signed short,
9537                             vector signed int);
9538
9539 vector signed int vec_vmsumshm (vector signed short,
9540                                 vector signed short,
9541                                 vector signed int);
9542
9543 vector unsigned int vec_vmsumuhm (vector unsigned short,
9544                                   vector unsigned short,
9545                                   vector unsigned int);
9546
9547 vector signed int vec_vmsummbm (vector signed char,
9548                                 vector unsigned char,
9549                                 vector signed int);
9550
9551 vector unsigned int vec_vmsumubm (vector unsigned char,
9552                                   vector unsigned char,
9553                                   vector unsigned int);
9554
9555 vector unsigned int vec_msums (vector unsigned short,
9556                                vector unsigned short,
9557                                vector unsigned int);
9558 vector signed int vec_msums (vector signed short,
9559                              vector signed short,
9560                              vector signed int);
9561
9562 vector signed int vec_vmsumshs (vector signed short,
9563                                 vector signed short,
9564                                 vector signed int);
9565
9566 vector unsigned int vec_vmsumuhs (vector unsigned short,
9567                                   vector unsigned short,
9568                                   vector unsigned int);
9569
9570 void vec_mtvscr (vector signed int);
9571 void vec_mtvscr (vector unsigned int);
9572 void vec_mtvscr (vector bool int);
9573 void vec_mtvscr (vector signed short);
9574 void vec_mtvscr (vector unsigned short);
9575 void vec_mtvscr (vector bool short);
9576 void vec_mtvscr (vector pixel);
9577 void vec_mtvscr (vector signed char);
9578 void vec_mtvscr (vector unsigned char);
9579 void vec_mtvscr (vector bool char);
9580
9581 vector unsigned short vec_mule (vector unsigned char,
9582                                 vector unsigned char);
9583 vector signed short vec_mule (vector signed char,
9584                               vector signed char);
9585 vector unsigned int vec_mule (vector unsigned short,
9586                               vector unsigned short);
9587 vector signed int vec_mule (vector signed short, vector signed short);
9588
9589 vector signed int vec_vmulesh (vector signed short,
9590                                vector signed short);
9591
9592 vector unsigned int vec_vmuleuh (vector unsigned short,
9593                                  vector unsigned short);
9594
9595 vector signed short vec_vmulesb (vector signed char,
9596                                  vector signed char);
9597
9598 vector unsigned short vec_vmuleub (vector unsigned char,
9599                                   vector unsigned char);
9600
9601 vector unsigned short vec_mulo (vector unsigned char,
9602                                 vector unsigned char);
9603 vector signed short vec_mulo (vector signed char, vector signed char);
9604 vector unsigned int vec_mulo (vector unsigned short,
9605                               vector unsigned short);
9606 vector signed int vec_mulo (vector signed short, vector signed short);
9607
9608 vector signed int vec_vmulosh (vector signed short,
9609                                vector signed short);
9610
9611 vector unsigned int vec_vmulouh (vector unsigned short,
9612                                  vector unsigned short);
9613
9614 vector signed short vec_vmulosb (vector signed char,
9615                                  vector signed char);
9616
9617 vector unsigned short vec_vmuloub (vector unsigned char,
9618                                    vector unsigned char);
9619
9620 vector float vec_nmsub (vector float, vector float, vector float);
9621
9622 vector float vec_nor (vector float, vector float);
9623 vector signed int vec_nor (vector signed int, vector signed int);
9624 vector unsigned int vec_nor (vector unsigned int, vector unsigned int);
9625 vector bool int vec_nor (vector bool int, vector bool int);
9626 vector signed short vec_nor (vector signed short, vector signed short);
9627 vector unsigned short vec_nor (vector unsigned short,
9628                                vector unsigned short);
9629 vector bool short vec_nor (vector bool short, vector bool short);
9630 vector signed char vec_nor (vector signed char, vector signed char);
9631 vector unsigned char vec_nor (vector unsigned char,
9632                               vector unsigned char);
9633 vector bool char vec_nor (vector bool char, vector bool char);
9634
9635 vector float vec_or (vector float, vector float);
9636 vector float vec_or (vector float, vector bool int);
9637 vector float vec_or (vector bool int, vector float);
9638 vector bool int vec_or (vector bool int, vector bool int);
9639 vector signed int vec_or (vector bool int, vector signed int);
9640 vector signed int vec_or (vector signed int, vector bool int);
9641 vector signed int vec_or (vector signed int, vector signed int);
9642 vector unsigned int vec_or (vector bool int, vector unsigned int);
9643 vector unsigned int vec_or (vector unsigned int, vector bool int);
9644 vector unsigned int vec_or (vector unsigned int, vector unsigned int);
9645 vector bool short vec_or (vector bool short, vector bool short);
9646 vector signed short vec_or (vector bool short, vector signed short);
9647 vector signed short vec_or (vector signed short, vector bool short);
9648 vector signed short vec_or (vector signed short, vector signed short);
9649 vector unsigned short vec_or (vector bool short, vector unsigned short);
9650 vector unsigned short vec_or (vector unsigned short, vector bool short);
9651 vector unsigned short vec_or (vector unsigned short,
9652                               vector unsigned short);
9653 vector signed char vec_or (vector bool char, vector signed char);
9654 vector bool char vec_or (vector bool char, vector bool char);
9655 vector signed char vec_or (vector signed char, vector bool char);
9656 vector signed char vec_or (vector signed char, vector signed char);
9657 vector unsigned char vec_or (vector bool char, vector unsigned char);
9658 vector unsigned char vec_or (vector unsigned char, vector bool char);
9659 vector unsigned char vec_or (vector unsigned char,
9660                              vector unsigned char);
9661
9662 vector signed char vec_pack (vector signed short, vector signed short);
9663 vector unsigned char vec_pack (vector unsigned short,
9664                                vector unsigned short);
9665 vector bool char vec_pack (vector bool short, vector bool short);
9666 vector signed short vec_pack (vector signed int, vector signed int);
9667 vector unsigned short vec_pack (vector unsigned int,
9668                                 vector unsigned int);
9669 vector bool short vec_pack (vector bool int, vector bool int);
9670
9671 vector bool short vec_vpkuwum (vector bool int, vector bool int);
9672 vector signed short vec_vpkuwum (vector signed int, vector signed int);
9673 vector unsigned short vec_vpkuwum (vector unsigned int,
9674                                    vector unsigned int);
9675
9676 vector bool char vec_vpkuhum (vector bool short, vector bool short);
9677 vector signed char vec_vpkuhum (vector signed short,
9678                                 vector signed short);
9679 vector unsigned char vec_vpkuhum (vector unsigned short,
9680                                   vector unsigned short);
9681
9682 vector pixel vec_packpx (vector unsigned int, vector unsigned int);
9683
9684 vector unsigned char vec_packs (vector unsigned short,
9685                                 vector unsigned short);
9686 vector signed char vec_packs (vector signed short, vector signed short);
9687 vector unsigned short vec_packs (vector unsigned int,
9688                                  vector unsigned int);
9689 vector signed short vec_packs (vector signed int, vector signed int);
9690
9691 vector signed short vec_vpkswss (vector signed int, vector signed int);
9692
9693 vector unsigned short vec_vpkuwus (vector unsigned int,
9694                                    vector unsigned int);
9695
9696 vector signed char vec_vpkshss (vector signed short,
9697                                 vector signed short);
9698
9699 vector unsigned char vec_vpkuhus (vector unsigned short,
9700                                   vector unsigned short);
9701
9702 vector unsigned char vec_packsu (vector unsigned short,
9703                                  vector unsigned short);
9704 vector unsigned char vec_packsu (vector signed short,
9705                                  vector signed short);
9706 vector unsigned short vec_packsu (vector unsigned int,
9707                                   vector unsigned int);
9708 vector unsigned short vec_packsu (vector signed int, vector signed int);
9709
9710 vector unsigned short vec_vpkswus (vector signed int,
9711                                    vector signed int);
9712
9713 vector unsigned char vec_vpkshus (vector signed short,
9714                                   vector signed short);
9715
9716 vector float vec_perm (vector float,
9717                        vector float,
9718                        vector unsigned char);
9719 vector signed int vec_perm (vector signed int,
9720                             vector signed int,
9721                             vector unsigned char);
9722 vector unsigned int vec_perm (vector unsigned int,
9723                               vector unsigned int,
9724                               vector unsigned char);
9725 vector bool int vec_perm (vector bool int,
9726                           vector bool int,
9727                           vector unsigned char);
9728 vector signed short vec_perm (vector signed short,
9729                               vector signed short,
9730                               vector unsigned char);
9731 vector unsigned short vec_perm (vector unsigned short,
9732                                 vector unsigned short,
9733                                 vector unsigned char);
9734 vector bool short vec_perm (vector bool short,
9735                             vector bool short,
9736                             vector unsigned char);
9737 vector pixel vec_perm (vector pixel,
9738                        vector pixel,
9739                        vector unsigned char);
9740 vector signed char vec_perm (vector signed char,
9741                              vector signed char,
9742                              vector unsigned char);
9743 vector unsigned char vec_perm (vector unsigned char,
9744                                vector unsigned char,
9745                                vector unsigned char);
9746 vector bool char vec_perm (vector bool char,
9747                            vector bool char,
9748                            vector unsigned char);
9749
9750 vector float vec_re (vector float);
9751
9752 vector signed char vec_rl (vector signed char,
9753                            vector unsigned char);
9754 vector unsigned char vec_rl (vector unsigned char,
9755                              vector unsigned char);
9756 vector signed short vec_rl (vector signed short, vector unsigned short);
9757 vector unsigned short vec_rl (vector unsigned short,
9758                               vector unsigned short);
9759 vector signed int vec_rl (vector signed int, vector unsigned int);
9760 vector unsigned int vec_rl (vector unsigned int, vector unsigned int);
9761
9762 vector signed int vec_vrlw (vector signed int, vector unsigned int);
9763 vector unsigned int vec_vrlw (vector unsigned int, vector unsigned int);
9764
9765 vector signed short vec_vrlh (vector signed short,
9766                               vector unsigned short);
9767 vector unsigned short vec_vrlh (vector unsigned short,
9768                                 vector unsigned short);
9769
9770 vector signed char vec_vrlb (vector signed char, vector unsigned char);
9771 vector unsigned char vec_vrlb (vector unsigned char,
9772                                vector unsigned char);
9773
9774 vector float vec_round (vector float);
9775
9776 vector float vec_rsqrte (vector float);
9777
9778 vector float vec_sel (vector float, vector float, vector bool int);
9779 vector float vec_sel (vector float, vector float, vector unsigned int);
9780 vector signed int vec_sel (vector signed int,
9781                            vector signed int,
9782                            vector bool int);
9783 vector signed int vec_sel (vector signed int,
9784                            vector signed int,
9785                            vector unsigned int);
9786 vector unsigned int vec_sel (vector unsigned int,
9787                              vector unsigned int,
9788                              vector bool int);
9789 vector unsigned int vec_sel (vector unsigned int,
9790                              vector unsigned int,
9791                              vector unsigned int);
9792 vector bool int vec_sel (vector bool int,
9793                          vector bool int,
9794                          vector bool int);
9795 vector bool int vec_sel (vector bool int,
9796                          vector bool int,
9797                          vector unsigned int);
9798 vector signed short vec_sel (vector signed short,
9799                              vector signed short,
9800                              vector bool short);
9801 vector signed short vec_sel (vector signed short,
9802                              vector signed short,
9803                              vector unsigned short);
9804 vector unsigned short vec_sel (vector unsigned short,
9805                                vector unsigned short,
9806                                vector bool short);
9807 vector unsigned short vec_sel (vector unsigned short,
9808                                vector unsigned short,
9809                                vector unsigned short);
9810 vector bool short vec_sel (vector bool short,
9811                            vector bool short,
9812                            vector bool short);
9813 vector bool short vec_sel (vector bool short,
9814                            vector bool short,
9815                            vector unsigned short);
9816 vector signed char vec_sel (vector signed char,
9817                             vector signed char,
9818                             vector bool char);
9819 vector signed char vec_sel (vector signed char,
9820                             vector signed char,
9821                             vector unsigned char);
9822 vector unsigned char vec_sel (vector unsigned char,
9823                               vector unsigned char,
9824                               vector bool char);
9825 vector unsigned char vec_sel (vector unsigned char,
9826                               vector unsigned char,
9827                               vector unsigned char);
9828 vector bool char vec_sel (vector bool char,
9829                           vector bool char,
9830                           vector bool char);
9831 vector bool char vec_sel (vector bool char,
9832                           vector bool char,
9833                           vector unsigned char);
9834
9835 vector signed char vec_sl (vector signed char,
9836                            vector unsigned char);
9837 vector unsigned char vec_sl (vector unsigned char,
9838                              vector unsigned char);
9839 vector signed short vec_sl (vector signed short, vector unsigned short);
9840 vector unsigned short vec_sl (vector unsigned short,
9841                               vector unsigned short);
9842 vector signed int vec_sl (vector signed int, vector unsigned int);
9843 vector unsigned int vec_sl (vector unsigned int, vector unsigned int);
9844
9845 vector signed int vec_vslw (vector signed int, vector unsigned int);
9846 vector unsigned int vec_vslw (vector unsigned int, vector unsigned int);
9847
9848 vector signed short vec_vslh (vector signed short,
9849                               vector unsigned short);
9850 vector unsigned short vec_vslh (vector unsigned short,
9851                                 vector unsigned short);
9852
9853 vector signed char vec_vslb (vector signed char, vector unsigned char);
9854 vector unsigned char vec_vslb (vector unsigned char,
9855                                vector unsigned char);
9856
9857 vector float vec_sld (vector float, vector float, const int);
9858 vector signed int vec_sld (vector signed int,
9859                            vector signed int,
9860                            const int);
9861 vector unsigned int vec_sld (vector unsigned int,
9862                              vector unsigned int,
9863                              const int);
9864 vector bool int vec_sld (vector bool int,
9865                          vector bool int,
9866                          const int);
9867 vector signed short vec_sld (vector signed short,
9868                              vector signed short,
9869                              const int);
9870 vector unsigned short vec_sld (vector unsigned short,
9871                                vector unsigned short,
9872                                const int);
9873 vector bool short vec_sld (vector bool short,
9874                            vector bool short,
9875                            const int);
9876 vector pixel vec_sld (vector pixel,
9877                       vector pixel,
9878                       const int);
9879 vector signed char vec_sld (vector signed char,
9880                             vector signed char,
9881                             const int);
9882 vector unsigned char vec_sld (vector unsigned char,
9883                               vector unsigned char,
9884                               const int);
9885 vector bool char vec_sld (vector bool char,
9886                           vector bool char,
9887                           const int);
9888
9889 vector signed int vec_sll (vector signed int,
9890                            vector unsigned int);
9891 vector signed int vec_sll (vector signed int,
9892                            vector unsigned short);
9893 vector signed int vec_sll (vector signed int,
9894                            vector unsigned char);
9895 vector unsigned int vec_sll (vector unsigned int,
9896                              vector unsigned int);
9897 vector unsigned int vec_sll (vector unsigned int,
9898                              vector unsigned short);
9899 vector unsigned int vec_sll (vector unsigned int,
9900                              vector unsigned char);
9901 vector bool int vec_sll (vector bool int,
9902                          vector unsigned int);
9903 vector bool int vec_sll (vector bool int,
9904                          vector unsigned short);
9905 vector bool int vec_sll (vector bool int,
9906                          vector unsigned char);
9907 vector signed short vec_sll (vector signed short,
9908                              vector unsigned int);
9909 vector signed short vec_sll (vector signed short,
9910                              vector unsigned short);
9911 vector signed short vec_sll (vector signed short,
9912                              vector unsigned char);
9913 vector unsigned short vec_sll (vector unsigned short,
9914                                vector unsigned int);
9915 vector unsigned short vec_sll (vector unsigned short,
9916                                vector unsigned short);
9917 vector unsigned short vec_sll (vector unsigned short,
9918                                vector unsigned char);
9919 vector bool short vec_sll (vector bool short, vector unsigned int);
9920 vector bool short vec_sll (vector bool short, vector unsigned short);
9921 vector bool short vec_sll (vector bool short, vector unsigned char);
9922 vector pixel vec_sll (vector pixel, vector unsigned int);
9923 vector pixel vec_sll (vector pixel, vector unsigned short);
9924 vector pixel vec_sll (vector pixel, vector unsigned char);
9925 vector signed char vec_sll (vector signed char, vector unsigned int);
9926 vector signed char vec_sll (vector signed char, vector unsigned short);
9927 vector signed char vec_sll (vector signed char, vector unsigned char);
9928 vector unsigned char vec_sll (vector unsigned char,
9929                               vector unsigned int);
9930 vector unsigned char vec_sll (vector unsigned char,
9931                               vector unsigned short);
9932 vector unsigned char vec_sll (vector unsigned char,
9933                               vector unsigned char);
9934 vector bool char vec_sll (vector bool char, vector unsigned int);
9935 vector bool char vec_sll (vector bool char, vector unsigned short);
9936 vector bool char vec_sll (vector bool char, vector unsigned char);
9937
9938 vector float vec_slo (vector float, vector signed char);
9939 vector float vec_slo (vector float, vector unsigned char);
9940 vector signed int vec_slo (vector signed int, vector signed char);
9941 vector signed int vec_slo (vector signed int, vector unsigned char);
9942 vector unsigned int vec_slo (vector unsigned int, vector signed char);
9943 vector unsigned int vec_slo (vector unsigned int, vector unsigned char);
9944 vector signed short vec_slo (vector signed short, vector signed char);
9945 vector signed short vec_slo (vector signed short, vector unsigned char);
9946 vector unsigned short vec_slo (vector unsigned short,
9947                                vector signed char);
9948 vector unsigned short vec_slo (vector unsigned short,
9949                                vector unsigned char);
9950 vector pixel vec_slo (vector pixel, vector signed char);
9951 vector pixel vec_slo (vector pixel, vector unsigned char);
9952 vector signed char vec_slo (vector signed char, vector signed char);
9953 vector signed char vec_slo (vector signed char, vector unsigned char);
9954 vector unsigned char vec_slo (vector unsigned char, vector signed char);
9955 vector unsigned char vec_slo (vector unsigned char,
9956                               vector unsigned char);
9957
9958 vector signed char vec_splat (vector signed char, const int);
9959 vector unsigned char vec_splat (vector unsigned char, const int);
9960 vector bool char vec_splat (vector bool char, const int);
9961 vector signed short vec_splat (vector signed short, const int);
9962 vector unsigned short vec_splat (vector unsigned short, const int);
9963 vector bool short vec_splat (vector bool short, const int);
9964 vector pixel vec_splat (vector pixel, const int);
9965 vector float vec_splat (vector float, const int);
9966 vector signed int vec_splat (vector signed int, const int);
9967 vector unsigned int vec_splat (vector unsigned int, const int);
9968 vector bool int vec_splat (vector bool int, const int);
9969
9970 vector float vec_vspltw (vector float, const int);
9971 vector signed int vec_vspltw (vector signed int, const int);
9972 vector unsigned int vec_vspltw (vector unsigned int, const int);
9973 vector bool int vec_vspltw (vector bool int, const int);
9974
9975 vector bool short vec_vsplth (vector bool short, const int);
9976 vector signed short vec_vsplth (vector signed short, const int);
9977 vector unsigned short vec_vsplth (vector unsigned short, const int);
9978 vector pixel vec_vsplth (vector pixel, const int);
9979
9980 vector signed char vec_vspltb (vector signed char, const int);
9981 vector unsigned char vec_vspltb (vector unsigned char, const int);
9982 vector bool char vec_vspltb (vector bool char, const int);
9983
9984 vector signed char vec_splat_s8 (const int);
9985
9986 vector signed short vec_splat_s16 (const int);
9987
9988 vector signed int vec_splat_s32 (const int);
9989
9990 vector unsigned char vec_splat_u8 (const int);
9991
9992 vector unsigned short vec_splat_u16 (const int);
9993
9994 vector unsigned int vec_splat_u32 (const int);
9995
9996 vector signed char vec_sr (vector signed char, vector unsigned char);
9997 vector unsigned char vec_sr (vector unsigned char,
9998                              vector unsigned char);
9999 vector signed short vec_sr (vector signed short,
10000                             vector unsigned short);
10001 vector unsigned short vec_sr (vector unsigned short,
10002                               vector unsigned short);
10003 vector signed int vec_sr (vector signed int, vector unsigned int);
10004 vector unsigned int vec_sr (vector unsigned int, vector unsigned int);
10005
10006 vector signed int vec_vsrw (vector signed int, vector unsigned int);
10007 vector unsigned int vec_vsrw (vector unsigned int, vector unsigned int);
10008
10009 vector signed short vec_vsrh (vector signed short,
10010                               vector unsigned short);
10011 vector unsigned short vec_vsrh (vector unsigned short,
10012                                 vector unsigned short);
10013
10014 vector signed char vec_vsrb (vector signed char, vector unsigned char);
10015 vector unsigned char vec_vsrb (vector unsigned char,
10016                                vector unsigned char);
10017
10018 vector signed char vec_sra (vector signed char, vector unsigned char);
10019 vector unsigned char vec_sra (vector unsigned char,
10020                               vector unsigned char);
10021 vector signed short vec_sra (vector signed short,
10022                              vector unsigned short);
10023 vector unsigned short vec_sra (vector unsigned short,
10024                                vector unsigned short);
10025 vector signed int vec_sra (vector signed int, vector unsigned int);
10026 vector unsigned int vec_sra (vector unsigned int, vector unsigned int);
10027
10028 vector signed int vec_vsraw (vector signed int, vector unsigned int);
10029 vector unsigned int vec_vsraw (vector unsigned int,
10030                                vector unsigned int);
10031
10032 vector signed short vec_vsrah (vector signed short,
10033                                vector unsigned short);
10034 vector unsigned short vec_vsrah (vector unsigned short,
10035                                  vector unsigned short);
10036
10037 vector signed char vec_vsrab (vector signed char, vector unsigned char);
10038 vector unsigned char vec_vsrab (vector unsigned char,
10039                                 vector unsigned char);
10040
10041 vector signed int vec_srl (vector signed int, vector unsigned int);
10042 vector signed int vec_srl (vector signed int, vector unsigned short);
10043 vector signed int vec_srl (vector signed int, vector unsigned char);
10044 vector unsigned int vec_srl (vector unsigned int, vector unsigned int);
10045 vector unsigned int vec_srl (vector unsigned int,
10046                              vector unsigned short);
10047 vector unsigned int vec_srl (vector unsigned int, vector unsigned char);
10048 vector bool int vec_srl (vector bool int, vector unsigned int);
10049 vector bool int vec_srl (vector bool int, vector unsigned short);
10050 vector bool int vec_srl (vector bool int, vector unsigned char);
10051 vector signed short vec_srl (vector signed short, vector unsigned int);
10052 vector signed short vec_srl (vector signed short,
10053                              vector unsigned short);
10054 vector signed short vec_srl (vector signed short, vector unsigned char);
10055 vector unsigned short vec_srl (vector unsigned short,
10056                                vector unsigned int);
10057 vector unsigned short vec_srl (vector unsigned short,
10058                                vector unsigned short);
10059 vector unsigned short vec_srl (vector unsigned short,
10060                                vector unsigned char);
10061 vector bool short vec_srl (vector bool short, vector unsigned int);
10062 vector bool short vec_srl (vector bool short, vector unsigned short);
10063 vector bool short vec_srl (vector bool short, vector unsigned char);
10064 vector pixel vec_srl (vector pixel, vector unsigned int);
10065 vector pixel vec_srl (vector pixel, vector unsigned short);
10066 vector pixel vec_srl (vector pixel, vector unsigned char);
10067 vector signed char vec_srl (vector signed char, vector unsigned int);
10068 vector signed char vec_srl (vector signed char, vector unsigned short);
10069 vector signed char vec_srl (vector signed char, vector unsigned char);
10070 vector unsigned char vec_srl (vector unsigned char,
10071                               vector unsigned int);
10072 vector unsigned char vec_srl (vector unsigned char,
10073                               vector unsigned short);
10074 vector unsigned char vec_srl (vector unsigned char,
10075                               vector unsigned char);
10076 vector bool char vec_srl (vector bool char, vector unsigned int);
10077 vector bool char vec_srl (vector bool char, vector unsigned short);
10078 vector bool char vec_srl (vector bool char, vector unsigned char);
10079
10080 vector float vec_sro (vector float, vector signed char);
10081 vector float vec_sro (vector float, vector unsigned char);
10082 vector signed int vec_sro (vector signed int, vector signed char);
10083 vector signed int vec_sro (vector signed int, vector unsigned char);
10084 vector unsigned int vec_sro (vector unsigned int, vector signed char);
10085 vector unsigned int vec_sro (vector unsigned int, vector unsigned char);
10086 vector signed short vec_sro (vector signed short, vector signed char);
10087 vector signed short vec_sro (vector signed short, vector unsigned char);
10088 vector unsigned short vec_sro (vector unsigned short,
10089                                vector signed char);
10090 vector unsigned short vec_sro (vector unsigned short,
10091                                vector unsigned char);
10092 vector pixel vec_sro (vector pixel, vector signed char);
10093 vector pixel vec_sro (vector pixel, vector unsigned char);
10094 vector signed char vec_sro (vector signed char, vector signed char);
10095 vector signed char vec_sro (vector signed char, vector unsigned char);
10096 vector unsigned char vec_sro (vector unsigned char, vector signed char);
10097 vector unsigned char vec_sro (vector unsigned char,
10098                               vector unsigned char);
10099
10100 void vec_st (vector float, int, vector float *);
10101 void vec_st (vector float, int, float *);
10102 void vec_st (vector signed int, int, vector signed int *);
10103 void vec_st (vector signed int, int, int *);
10104 void vec_st (vector unsigned int, int, vector unsigned int *);
10105 void vec_st (vector unsigned int, int, unsigned int *);
10106 void vec_st (vector bool int, int, vector bool int *);
10107 void vec_st (vector bool int, int, unsigned int *);
10108 void vec_st (vector bool int, int, int *);
10109 void vec_st (vector signed short, int, vector signed short *);
10110 void vec_st (vector signed short, int, short *);
10111 void vec_st (vector unsigned short, int, vector unsigned short *);
10112 void vec_st (vector unsigned short, int, unsigned short *);
10113 void vec_st (vector bool short, int, vector bool short *);
10114 void vec_st (vector bool short, int, unsigned short *);
10115 void vec_st (vector pixel, int, vector pixel *);
10116 void vec_st (vector pixel, int, unsigned short *);
10117 void vec_st (vector pixel, int, short *);
10118 void vec_st (vector bool short, int, short *);
10119 void vec_st (vector signed char, int, vector signed char *);
10120 void vec_st (vector signed char, int, signed char *);
10121 void vec_st (vector unsigned char, int, vector unsigned char *);
10122 void vec_st (vector unsigned char, int, unsigned char *);
10123 void vec_st (vector bool char, int, vector bool char *);
10124 void vec_st (vector bool char, int, unsigned char *);
10125 void vec_st (vector bool char, int, signed char *);
10126
10127 void vec_ste (vector signed char, int, signed char *);
10128 void vec_ste (vector unsigned char, int, unsigned char *);
10129 void vec_ste (vector bool char, int, signed char *);
10130 void vec_ste (vector bool char, int, unsigned char *);
10131 void vec_ste (vector signed short, int, short *);
10132 void vec_ste (vector unsigned short, int, unsigned short *);
10133 void vec_ste (vector bool short, int, short *);
10134 void vec_ste (vector bool short, int, unsigned short *);
10135 void vec_ste (vector pixel, int, short *);
10136 void vec_ste (vector pixel, int, unsigned short *);
10137 void vec_ste (vector float, int, float *);
10138 void vec_ste (vector signed int, int, int *);
10139 void vec_ste (vector unsigned int, int, unsigned int *);
10140 void vec_ste (vector bool int, int, int *);
10141 void vec_ste (vector bool int, int, unsigned int *);
10142
10143 void vec_stvewx (vector float, int, float *);
10144 void vec_stvewx (vector signed int, int, int *);
10145 void vec_stvewx (vector unsigned int, int, unsigned int *);
10146 void vec_stvewx (vector bool int, int, int *);
10147 void vec_stvewx (vector bool int, int, unsigned int *);
10148
10149 void vec_stvehx (vector signed short, int, short *);
10150 void vec_stvehx (vector unsigned short, int, unsigned short *);
10151 void vec_stvehx (vector bool short, int, short *);
10152 void vec_stvehx (vector bool short, int, unsigned short *);
10153 void vec_stvehx (vector pixel, int, short *);
10154 void vec_stvehx (vector pixel, int, unsigned short *);
10155
10156 void vec_stvebx (vector signed char, int, signed char *);
10157 void vec_stvebx (vector unsigned char, int, unsigned char *);
10158 void vec_stvebx (vector bool char, int, signed char *);
10159 void vec_stvebx (vector bool char, int, unsigned char *);
10160
10161 void vec_stl (vector float, int, vector float *);
10162 void vec_stl (vector float, int, float *);
10163 void vec_stl (vector signed int, int, vector signed int *);
10164 void vec_stl (vector signed int, int, int *);
10165 void vec_stl (vector unsigned int, int, vector unsigned int *);
10166 void vec_stl (vector unsigned int, int, unsigned int *);
10167 void vec_stl (vector bool int, int, vector bool int *);
10168 void vec_stl (vector bool int, int, unsigned int *);
10169 void vec_stl (vector bool int, int, int *);
10170 void vec_stl (vector signed short, int, vector signed short *);
10171 void vec_stl (vector signed short, int, short *);
10172 void vec_stl (vector unsigned short, int, vector unsigned short *);
10173 void vec_stl (vector unsigned short, int, unsigned short *);
10174 void vec_stl (vector bool short, int, vector bool short *);
10175 void vec_stl (vector bool short, int, unsigned short *);
10176 void vec_stl (vector bool short, int, short *);
10177 void vec_stl (vector pixel, int, vector pixel *);
10178 void vec_stl (vector pixel, int, unsigned short *);
10179 void vec_stl (vector pixel, int, short *);
10180 void vec_stl (vector signed char, int, vector signed char *);
10181 void vec_stl (vector signed char, int, signed char *);
10182 void vec_stl (vector unsigned char, int, vector unsigned char *);
10183 void vec_stl (vector unsigned char, int, unsigned char *);
10184 void vec_stl (vector bool char, int, vector bool char *);
10185 void vec_stl (vector bool char, int, unsigned char *);
10186 void vec_stl (vector bool char, int, signed char *);
10187
10188 vector signed char vec_sub (vector bool char, vector signed char);
10189 vector signed char vec_sub (vector signed char, vector bool char);
10190 vector signed char vec_sub (vector signed char, vector signed char);
10191 vector unsigned char vec_sub (vector bool char, vector unsigned char);
10192 vector unsigned char vec_sub (vector unsigned char, vector bool char);
10193 vector unsigned char vec_sub (vector unsigned char,
10194                               vector unsigned char);
10195 vector signed short vec_sub (vector bool short, vector signed short);
10196 vector signed short vec_sub (vector signed short, vector bool short);
10197 vector signed short vec_sub (vector signed short, vector signed short);
10198 vector unsigned short vec_sub (vector bool short,
10199                                vector unsigned short);
10200 vector unsigned short vec_sub (vector unsigned short,
10201                                vector bool short);
10202 vector unsigned short vec_sub (vector unsigned short,
10203                                vector unsigned short);
10204 vector signed int vec_sub (vector bool int, vector signed int);
10205 vector signed int vec_sub (vector signed int, vector bool int);
10206 vector signed int vec_sub (vector signed int, vector signed int);
10207 vector unsigned int vec_sub (vector bool int, vector unsigned int);
10208 vector unsigned int vec_sub (vector unsigned int, vector bool int);
10209 vector unsigned int vec_sub (vector unsigned int, vector unsigned int);
10210 vector float vec_sub (vector float, vector float);
10211
10212 vector float vec_vsubfp (vector float, vector float);
10213
10214 vector signed int vec_vsubuwm (vector bool int, vector signed int);
10215 vector signed int vec_vsubuwm (vector signed int, vector bool int);
10216 vector signed int vec_vsubuwm (vector signed int, vector signed int);
10217 vector unsigned int vec_vsubuwm (vector bool int, vector unsigned int);
10218 vector unsigned int vec_vsubuwm (vector unsigned int, vector bool int);
10219 vector unsigned int vec_vsubuwm (vector unsigned int,
10220                                  vector unsigned int);
10221
10222 vector signed short vec_vsubuhm (vector bool short,
10223                                  vector signed short);
10224 vector signed short vec_vsubuhm (vector signed short,
10225                                  vector bool short);
10226 vector signed short vec_vsubuhm (vector signed short,
10227                                  vector signed short);
10228 vector unsigned short vec_vsubuhm (vector bool short,
10229                                    vector unsigned short);
10230 vector unsigned short vec_vsubuhm (vector unsigned short,
10231                                    vector bool short);
10232 vector unsigned short vec_vsubuhm (vector unsigned short,
10233                                    vector unsigned short);
10234
10235 vector signed char vec_vsububm (vector bool char, vector signed char);
10236 vector signed char vec_vsububm (vector signed char, vector bool char);
10237 vector signed char vec_vsububm (vector signed char, vector signed char);
10238 vector unsigned char vec_vsububm (vector bool char,
10239                                   vector unsigned char);
10240 vector unsigned char vec_vsububm (vector unsigned char,
10241                                   vector bool char);
10242 vector unsigned char vec_vsububm (vector unsigned char,
10243                                   vector unsigned char);
10244
10245 vector unsigned int vec_subc (vector unsigned int, vector unsigned int);
10246
10247 vector unsigned char vec_subs (vector bool char, vector unsigned char);
10248 vector unsigned char vec_subs (vector unsigned char, vector bool char);
10249 vector unsigned char vec_subs (vector unsigned char,
10250                                vector unsigned char);
10251 vector signed char vec_subs (vector bool char, vector signed char);
10252 vector signed char vec_subs (vector signed char, vector bool char);
10253 vector signed char vec_subs (vector signed char, vector signed char);
10254 vector unsigned short vec_subs (vector bool short,
10255                                 vector unsigned short);
10256 vector unsigned short vec_subs (vector unsigned short,
10257                                 vector bool short);
10258 vector unsigned short vec_subs (vector unsigned short,
10259                                 vector unsigned short);
10260 vector signed short vec_subs (vector bool short, vector signed short);
10261 vector signed short vec_subs (vector signed short, vector bool short);
10262 vector signed short vec_subs (vector signed short, vector signed short);
10263 vector unsigned int vec_subs (vector bool int, vector unsigned int);
10264 vector unsigned int vec_subs (vector unsigned int, vector bool int);
10265 vector unsigned int vec_subs (vector unsigned int, vector unsigned int);
10266 vector signed int vec_subs (vector bool int, vector signed int);
10267 vector signed int vec_subs (vector signed int, vector bool int);
10268 vector signed int vec_subs (vector signed int, vector signed int);
10269
10270 vector signed int vec_vsubsws (vector bool int, vector signed int);
10271 vector signed int vec_vsubsws (vector signed int, vector bool int);
10272 vector signed int vec_vsubsws (vector signed int, vector signed int);
10273
10274 vector unsigned int vec_vsubuws (vector bool int, vector unsigned int);
10275 vector unsigned int vec_vsubuws (vector unsigned int, vector bool int);
10276 vector unsigned int vec_vsubuws (vector unsigned int,
10277                                  vector unsigned int);
10278
10279 vector signed short vec_vsubshs (vector bool short,
10280                                  vector signed short);
10281 vector signed short vec_vsubshs (vector signed short,
10282                                  vector bool short);
10283 vector signed short vec_vsubshs (vector signed short,
10284                                  vector signed short);
10285
10286 vector unsigned short vec_vsubuhs (vector bool short,
10287                                    vector unsigned short);
10288 vector unsigned short vec_vsubuhs (vector unsigned short,
10289                                    vector bool short);
10290 vector unsigned short vec_vsubuhs (vector unsigned short,
10291                                    vector unsigned short);
10292
10293 vector signed char vec_vsubsbs (vector bool char, vector signed char);
10294 vector signed char vec_vsubsbs (vector signed char, vector bool char);
10295 vector signed char vec_vsubsbs (vector signed char, vector signed char);
10296
10297 vector unsigned char vec_vsububs (vector bool char,
10298                                   vector unsigned char);
10299 vector unsigned char vec_vsububs (vector unsigned char,
10300                                   vector bool char);
10301 vector unsigned char vec_vsububs (vector unsigned char,
10302                                   vector unsigned char);
10303
10304 vector unsigned int vec_sum4s (vector unsigned char,
10305                                vector unsigned int);
10306 vector signed int vec_sum4s (vector signed char, vector signed int);
10307 vector signed int vec_sum4s (vector signed short, vector signed int);
10308
10309 vector signed int vec_vsum4shs (vector signed short, vector signed int);
10310
10311 vector signed int vec_vsum4sbs (vector signed char, vector signed int);
10312
10313 vector unsigned int vec_vsum4ubs (vector unsigned char,
10314                                   vector unsigned int);
10315
10316 vector signed int vec_sum2s (vector signed int, vector signed int);
10317
10318 vector signed int vec_sums (vector signed int, vector signed int);
10319
10320 vector float vec_trunc (vector float);
10321
10322 vector signed short vec_unpackh (vector signed char);
10323 vector bool short vec_unpackh (vector bool char);
10324 vector signed int vec_unpackh (vector signed short);
10325 vector bool int vec_unpackh (vector bool short);
10326 vector unsigned int vec_unpackh (vector pixel);
10327
10328 vector bool int vec_vupkhsh (vector bool short);
10329 vector signed int vec_vupkhsh (vector signed short);
10330
10331 vector unsigned int vec_vupkhpx (vector pixel);
10332
10333 vector bool short vec_vupkhsb (vector bool char);
10334 vector signed short vec_vupkhsb (vector signed char);
10335
10336 vector signed short vec_unpackl (vector signed char);
10337 vector bool short vec_unpackl (vector bool char);
10338 vector unsigned int vec_unpackl (vector pixel);
10339 vector signed int vec_unpackl (vector signed short);
10340 vector bool int vec_unpackl (vector bool short);
10341
10342 vector unsigned int vec_vupklpx (vector pixel);
10343
10344 vector bool int vec_vupklsh (vector bool short);
10345 vector signed int vec_vupklsh (vector signed short);
10346
10347 vector bool short vec_vupklsb (vector bool char);
10348 vector signed short vec_vupklsb (vector signed char);
10349
10350 vector float vec_xor (vector float, vector float);
10351 vector float vec_xor (vector float, vector bool int);
10352 vector float vec_xor (vector bool int, vector float);
10353 vector bool int vec_xor (vector bool int, vector bool int);
10354 vector signed int vec_xor (vector bool int, vector signed int);
10355 vector signed int vec_xor (vector signed int, vector bool int);
10356 vector signed int vec_xor (vector signed int, vector signed int);
10357 vector unsigned int vec_xor (vector bool int, vector unsigned int);
10358 vector unsigned int vec_xor (vector unsigned int, vector bool int);
10359 vector unsigned int vec_xor (vector unsigned int, vector unsigned int);
10360 vector bool short vec_xor (vector bool short, vector bool short);
10361 vector signed short vec_xor (vector bool short, vector signed short);
10362 vector signed short vec_xor (vector signed short, vector bool short);
10363 vector signed short vec_xor (vector signed short, vector signed short);
10364 vector unsigned short vec_xor (vector bool short,
10365                                vector unsigned short);
10366 vector unsigned short vec_xor (vector unsigned short,
10367                                vector bool short);
10368 vector unsigned short vec_xor (vector unsigned short,
10369                                vector unsigned short);
10370 vector signed char vec_xor (vector bool char, vector signed char);
10371 vector bool char vec_xor (vector bool char, vector bool char);
10372 vector signed char vec_xor (vector signed char, vector bool char);
10373 vector signed char vec_xor (vector signed char, vector signed char);
10374 vector unsigned char vec_xor (vector bool char, vector unsigned char);
10375 vector unsigned char vec_xor (vector unsigned char, vector bool char);
10376 vector unsigned char vec_xor (vector unsigned char,
10377                               vector unsigned char);
10378
10379 int vec_all_eq (vector signed char, vector bool char);
10380 int vec_all_eq (vector signed char, vector signed char);
10381 int vec_all_eq (vector unsigned char, vector bool char);
10382 int vec_all_eq (vector unsigned char, vector unsigned char);
10383 int vec_all_eq (vector bool char, vector bool char);
10384 int vec_all_eq (vector bool char, vector unsigned char);
10385 int vec_all_eq (vector bool char, vector signed char);
10386 int vec_all_eq (vector signed short, vector bool short);
10387 int vec_all_eq (vector signed short, vector signed short);
10388 int vec_all_eq (vector unsigned short, vector bool short);
10389 int vec_all_eq (vector unsigned short, vector unsigned short);
10390 int vec_all_eq (vector bool short, vector bool short);
10391 int vec_all_eq (vector bool short, vector unsigned short);
10392 int vec_all_eq (vector bool short, vector signed short);
10393 int vec_all_eq (vector pixel, vector pixel);
10394 int vec_all_eq (vector signed int, vector bool int);
10395 int vec_all_eq (vector signed int, vector signed int);
10396 int vec_all_eq (vector unsigned int, vector bool int);
10397 int vec_all_eq (vector unsigned int, vector unsigned int);
10398 int vec_all_eq (vector bool int, vector bool int);
10399 int vec_all_eq (vector bool int, vector unsigned int);
10400 int vec_all_eq (vector bool int, vector signed int);
10401 int vec_all_eq (vector float, vector float);
10402
10403 int vec_all_ge (vector bool char, vector unsigned char);
10404 int vec_all_ge (vector unsigned char, vector bool char);
10405 int vec_all_ge (vector unsigned char, vector unsigned char);
10406 int vec_all_ge (vector bool char, vector signed char);
10407 int vec_all_ge (vector signed char, vector bool char);
10408 int vec_all_ge (vector signed char, vector signed char);
10409 int vec_all_ge (vector bool short, vector unsigned short);
10410 int vec_all_ge (vector unsigned short, vector bool short);
10411 int vec_all_ge (vector unsigned short, vector unsigned short);
10412 int vec_all_ge (vector signed short, vector signed short);
10413 int vec_all_ge (vector bool short, vector signed short);
10414 int vec_all_ge (vector signed short, vector bool short);
10415 int vec_all_ge (vector bool int, vector unsigned int);
10416 int vec_all_ge (vector unsigned int, vector bool int);
10417 int vec_all_ge (vector unsigned int, vector unsigned int);
10418 int vec_all_ge (vector bool int, vector signed int);
10419 int vec_all_ge (vector signed int, vector bool int);
10420 int vec_all_ge (vector signed int, vector signed int);
10421 int vec_all_ge (vector float, vector float);
10422
10423 int vec_all_gt (vector bool char, vector unsigned char);
10424 int vec_all_gt (vector unsigned char, vector bool char);
10425 int vec_all_gt (vector unsigned char, vector unsigned char);
10426 int vec_all_gt (vector bool char, vector signed char);
10427 int vec_all_gt (vector signed char, vector bool char);
10428 int vec_all_gt (vector signed char, vector signed char);
10429 int vec_all_gt (vector bool short, vector unsigned short);
10430 int vec_all_gt (vector unsigned short, vector bool short);
10431 int vec_all_gt (vector unsigned short, vector unsigned short);
10432 int vec_all_gt (vector bool short, vector signed short);
10433 int vec_all_gt (vector signed short, vector bool short);
10434 int vec_all_gt (vector signed short, vector signed short);
10435 int vec_all_gt (vector bool int, vector unsigned int);
10436 int vec_all_gt (vector unsigned int, vector bool int);
10437 int vec_all_gt (vector unsigned int, vector unsigned int);
10438 int vec_all_gt (vector bool int, vector signed int);
10439 int vec_all_gt (vector signed int, vector bool int);
10440 int vec_all_gt (vector signed int, vector signed int);
10441 int vec_all_gt (vector float, vector float);
10442
10443 int vec_all_in (vector float, vector float);
10444
10445 int vec_all_le (vector bool char, vector unsigned char);
10446 int vec_all_le (vector unsigned char, vector bool char);
10447 int vec_all_le (vector unsigned char, vector unsigned char);
10448 int vec_all_le (vector bool char, vector signed char);
10449 int vec_all_le (vector signed char, vector bool char);
10450 int vec_all_le (vector signed char, vector signed char);
10451 int vec_all_le (vector bool short, vector unsigned short);
10452 int vec_all_le (vector unsigned short, vector bool short);
10453 int vec_all_le (vector unsigned short, vector unsigned short);
10454 int vec_all_le (vector bool short, vector signed short);
10455 int vec_all_le (vector signed short, vector bool short);
10456 int vec_all_le (vector signed short, vector signed short);
10457 int vec_all_le (vector bool int, vector unsigned int);
10458 int vec_all_le (vector unsigned int, vector bool int);
10459 int vec_all_le (vector unsigned int, vector unsigned int);
10460 int vec_all_le (vector bool int, vector signed int);
10461 int vec_all_le (vector signed int, vector bool int);
10462 int vec_all_le (vector signed int, vector signed int);
10463 int vec_all_le (vector float, vector float);
10464
10465 int vec_all_lt (vector bool char, vector unsigned char);
10466 int vec_all_lt (vector unsigned char, vector bool char);
10467 int vec_all_lt (vector unsigned char, vector unsigned char);
10468 int vec_all_lt (vector bool char, vector signed char);
10469 int vec_all_lt (vector signed char, vector bool char);
10470 int vec_all_lt (vector signed char, vector signed char);
10471 int vec_all_lt (vector bool short, vector unsigned short);
10472 int vec_all_lt (vector unsigned short, vector bool short);
10473 int vec_all_lt (vector unsigned short, vector unsigned short);
10474 int vec_all_lt (vector bool short, vector signed short);
10475 int vec_all_lt (vector signed short, vector bool short);
10476 int vec_all_lt (vector signed short, vector signed short);
10477 int vec_all_lt (vector bool int, vector unsigned int);
10478 int vec_all_lt (vector unsigned int, vector bool int);
10479 int vec_all_lt (vector unsigned int, vector unsigned int);
10480 int vec_all_lt (vector bool int, vector signed int);
10481 int vec_all_lt (vector signed int, vector bool int);
10482 int vec_all_lt (vector signed int, vector signed int);
10483 int vec_all_lt (vector float, vector float);
10484
10485 int vec_all_nan (vector float);
10486
10487 int vec_all_ne (vector signed char, vector bool char);
10488 int vec_all_ne (vector signed char, vector signed char);
10489 int vec_all_ne (vector unsigned char, vector bool char);
10490 int vec_all_ne (vector unsigned char, vector unsigned char);
10491 int vec_all_ne (vector bool char, vector bool char);
10492 int vec_all_ne (vector bool char, vector unsigned char);
10493 int vec_all_ne (vector bool char, vector signed char);
10494 int vec_all_ne (vector signed short, vector bool short);
10495 int vec_all_ne (vector signed short, vector signed short);
10496 int vec_all_ne (vector unsigned short, vector bool short);
10497 int vec_all_ne (vector unsigned short, vector unsigned short);
10498 int vec_all_ne (vector bool short, vector bool short);
10499 int vec_all_ne (vector bool short, vector unsigned short);
10500 int vec_all_ne (vector bool short, vector signed short);
10501 int vec_all_ne (vector pixel, vector pixel);
10502 int vec_all_ne (vector signed int, vector bool int);
10503 int vec_all_ne (vector signed int, vector signed int);
10504 int vec_all_ne (vector unsigned int, vector bool int);
10505 int vec_all_ne (vector unsigned int, vector unsigned int);
10506 int vec_all_ne (vector bool int, vector bool int);
10507 int vec_all_ne (vector bool int, vector unsigned int);
10508 int vec_all_ne (vector bool int, vector signed int);
10509 int vec_all_ne (vector float, vector float);
10510
10511 int vec_all_nge (vector float, vector float);
10512
10513 int vec_all_ngt (vector float, vector float);
10514
10515 int vec_all_nle (vector float, vector float);
10516
10517 int vec_all_nlt (vector float, vector float);
10518
10519 int vec_all_numeric (vector float);
10520
10521 int vec_any_eq (vector signed char, vector bool char);
10522 int vec_any_eq (vector signed char, vector signed char);
10523 int vec_any_eq (vector unsigned char, vector bool char);
10524 int vec_any_eq (vector unsigned char, vector unsigned char);
10525 int vec_any_eq (vector bool char, vector bool char);
10526 int vec_any_eq (vector bool char, vector unsigned char);
10527 int vec_any_eq (vector bool char, vector signed char);
10528 int vec_any_eq (vector signed short, vector bool short);
10529 int vec_any_eq (vector signed short, vector signed short);
10530 int vec_any_eq (vector unsigned short, vector bool short);
10531 int vec_any_eq (vector unsigned short, vector unsigned short);
10532 int vec_any_eq (vector bool short, vector bool short);
10533 int vec_any_eq (vector bool short, vector unsigned short);
10534 int vec_any_eq (vector bool short, vector signed short);
10535 int vec_any_eq (vector pixel, vector pixel);
10536 int vec_any_eq (vector signed int, vector bool int);
10537 int vec_any_eq (vector signed int, vector signed int);
10538 int vec_any_eq (vector unsigned int, vector bool int);
10539 int vec_any_eq (vector unsigned int, vector unsigned int);
10540 int vec_any_eq (vector bool int, vector bool int);
10541 int vec_any_eq (vector bool int, vector unsigned int);
10542 int vec_any_eq (vector bool int, vector signed int);
10543 int vec_any_eq (vector float, vector float);
10544
10545 int vec_any_ge (vector signed char, vector bool char);
10546 int vec_any_ge (vector unsigned char, vector bool char);
10547 int vec_any_ge (vector unsigned char, vector unsigned char);
10548 int vec_any_ge (vector signed char, vector signed char);
10549 int vec_any_ge (vector bool char, vector unsigned char);
10550 int vec_any_ge (vector bool char, vector signed char);
10551 int vec_any_ge (vector unsigned short, vector bool short);
10552 int vec_any_ge (vector unsigned short, vector unsigned short);
10553 int vec_any_ge (vector signed short, vector signed short);
10554 int vec_any_ge (vector signed short, vector bool short);
10555 int vec_any_ge (vector bool short, vector unsigned short);
10556 int vec_any_ge (vector bool short, vector signed short);
10557 int vec_any_ge (vector signed int, vector bool int);
10558 int vec_any_ge (vector unsigned int, vector bool int);
10559 int vec_any_ge (vector unsigned int, vector unsigned int);
10560 int vec_any_ge (vector signed int, vector signed int);
10561 int vec_any_ge (vector bool int, vector unsigned int);
10562 int vec_any_ge (vector bool int, vector signed int);
10563 int vec_any_ge (vector float, vector float);
10564
10565 int vec_any_gt (vector bool char, vector unsigned char);
10566 int vec_any_gt (vector unsigned char, vector bool char);
10567 int vec_any_gt (vector unsigned char, vector unsigned char);
10568 int vec_any_gt (vector bool char, vector signed char);
10569 int vec_any_gt (vector signed char, vector bool char);
10570 int vec_any_gt (vector signed char, vector signed char);
10571 int vec_any_gt (vector bool short, vector unsigned short);
10572 int vec_any_gt (vector unsigned short, vector bool short);
10573 int vec_any_gt (vector unsigned short, vector unsigned short);
10574 int vec_any_gt (vector bool short, vector signed short);
10575 int vec_any_gt (vector signed short, vector bool short);
10576 int vec_any_gt (vector signed short, vector signed short);
10577 int vec_any_gt (vector bool int, vector unsigned int);
10578 int vec_any_gt (vector unsigned int, vector bool int);
10579 int vec_any_gt (vector unsigned int, vector unsigned int);
10580 int vec_any_gt (vector bool int, vector signed int);
10581 int vec_any_gt (vector signed int, vector bool int);
10582 int vec_any_gt (vector signed int, vector signed int);
10583 int vec_any_gt (vector float, vector float);
10584
10585 int vec_any_le (vector bool char, vector unsigned char);
10586 int vec_any_le (vector unsigned char, vector bool char);
10587 int vec_any_le (vector unsigned char, vector unsigned char);
10588 int vec_any_le (vector bool char, vector signed char);
10589 int vec_any_le (vector signed char, vector bool char);
10590 int vec_any_le (vector signed char, vector signed char);
10591 int vec_any_le (vector bool short, vector unsigned short);
10592 int vec_any_le (vector unsigned short, vector bool short);
10593 int vec_any_le (vector unsigned short, vector unsigned short);
10594 int vec_any_le (vector bool short, vector signed short);
10595 int vec_any_le (vector signed short, vector bool short);
10596 int vec_any_le (vector signed short, vector signed short);
10597 int vec_any_le (vector bool int, vector unsigned int);
10598 int vec_any_le (vector unsigned int, vector bool int);
10599 int vec_any_le (vector unsigned int, vector unsigned int);
10600 int vec_any_le (vector bool int, vector signed int);
10601 int vec_any_le (vector signed int, vector bool int);
10602 int vec_any_le (vector signed int, vector signed int);
10603 int vec_any_le (vector float, vector float);
10604
10605 int vec_any_lt (vector bool char, vector unsigned char);
10606 int vec_any_lt (vector unsigned char, vector bool char);
10607 int vec_any_lt (vector unsigned char, vector unsigned char);
10608 int vec_any_lt (vector bool char, vector signed char);
10609 int vec_any_lt (vector signed char, vector bool char);
10610 int vec_any_lt (vector signed char, vector signed char);
10611 int vec_any_lt (vector bool short, vector unsigned short);
10612 int vec_any_lt (vector unsigned short, vector bool short);
10613 int vec_any_lt (vector unsigned short, vector unsigned short);
10614 int vec_any_lt (vector bool short, vector signed short);
10615 int vec_any_lt (vector signed short, vector bool short);
10616 int vec_any_lt (vector signed short, vector signed short);
10617 int vec_any_lt (vector bool int, vector unsigned int);
10618 int vec_any_lt (vector unsigned int, vector bool int);
10619 int vec_any_lt (vector unsigned int, vector unsigned int);
10620 int vec_any_lt (vector bool int, vector signed int);
10621 int vec_any_lt (vector signed int, vector bool int);
10622 int vec_any_lt (vector signed int, vector signed int);
10623 int vec_any_lt (vector float, vector float);
10624
10625 int vec_any_nan (vector float);
10626
10627 int vec_any_ne (vector signed char, vector bool char);
10628 int vec_any_ne (vector signed char, vector signed char);
10629 int vec_any_ne (vector unsigned char, vector bool char);
10630 int vec_any_ne (vector unsigned char, vector unsigned char);
10631 int vec_any_ne (vector bool char, vector bool char);
10632 int vec_any_ne (vector bool char, vector unsigned char);
10633 int vec_any_ne (vector bool char, vector signed char);
10634 int vec_any_ne (vector signed short, vector bool short);
10635 int vec_any_ne (vector signed short, vector signed short);
10636 int vec_any_ne (vector unsigned short, vector bool short);
10637 int vec_any_ne (vector unsigned short, vector unsigned short);
10638 int vec_any_ne (vector bool short, vector bool short);
10639 int vec_any_ne (vector bool short, vector unsigned short);
10640 int vec_any_ne (vector bool short, vector signed short);
10641 int vec_any_ne (vector pixel, vector pixel);
10642 int vec_any_ne (vector signed int, vector bool int);
10643 int vec_any_ne (vector signed int, vector signed int);
10644 int vec_any_ne (vector unsigned int, vector bool int);
10645 int vec_any_ne (vector unsigned int, vector unsigned int);
10646 int vec_any_ne (vector bool int, vector bool int);
10647 int vec_any_ne (vector bool int, vector unsigned int);
10648 int vec_any_ne (vector bool int, vector signed int);
10649 int vec_any_ne (vector float, vector float);
10650
10651 int vec_any_nge (vector float, vector float);
10652
10653 int vec_any_ngt (vector float, vector float);
10654
10655 int vec_any_nle (vector float, vector float);
10656
10657 int vec_any_nlt (vector float, vector float);
10658
10659 int vec_any_numeric (vector float);
10660
10661 int vec_any_out (vector float, vector float);
10662 @end smallexample
10663
10664 @node SPARC VIS Built-in Functions
10665 @subsection SPARC VIS Built-in Functions
10666
10667 GCC supports SIMD operations on the SPARC using both the generic vector
10668 extensions (@pxref{Vector Extensions}) as well as built-in functions for
10669 the SPARC Visual Instruction Set (VIS).  When you use the @option{-mvis}
10670 switch, the VIS extension is exposed as the following built-in functions:
10671
10672 @smallexample
10673 typedef int v2si __attribute__ ((vector_size (8)));
10674 typedef short v4hi __attribute__ ((vector_size (8)));
10675 typedef short v2hi __attribute__ ((vector_size (4)));
10676 typedef char v8qi __attribute__ ((vector_size (8)));
10677 typedef char v4qi __attribute__ ((vector_size (4)));
10678
10679 void * __builtin_vis_alignaddr (void *, long);
10680 int64_t __builtin_vis_faligndatadi (int64_t, int64_t);
10681 v2si __builtin_vis_faligndatav2si (v2si, v2si);
10682 v4hi __builtin_vis_faligndatav4hi (v4si, v4si);
10683 v8qi __builtin_vis_faligndatav8qi (v8qi, v8qi);
10684
10685 v4hi __builtin_vis_fexpand (v4qi);
10686
10687 v4hi __builtin_vis_fmul8x16 (v4qi, v4hi);
10688 v4hi __builtin_vis_fmul8x16au (v4qi, v4hi);
10689 v4hi __builtin_vis_fmul8x16al (v4qi, v4hi);
10690 v4hi __builtin_vis_fmul8sux16 (v8qi, v4hi);
10691 v4hi __builtin_vis_fmul8ulx16 (v8qi, v4hi);
10692 v2si __builtin_vis_fmuld8sux16 (v4qi, v2hi);
10693 v2si __builtin_vis_fmuld8ulx16 (v4qi, v2hi);
10694
10695 v4qi __builtin_vis_fpack16 (v4hi);
10696 v8qi __builtin_vis_fpack32 (v2si, v2si);
10697 v2hi __builtin_vis_fpackfix (v2si);
10698 v8qi __builtin_vis_fpmerge (v4qi, v4qi);
10699
10700 int64_t __builtin_vis_pdist (v8qi, v8qi, int64_t);
10701 @end smallexample
10702
10703 @node SPU Built-in Functions
10704 @subsection SPU Built-in Functions
10705
10706 GCC provides extensions for the SPU processor as described in the
10707 Sony/Toshiba/IBM SPU Language Extensions Specification, which can be
10708 found at @uref{http://cell.scei.co.jp/} or
10709 @uref{http://www.ibm.com/developerworks/power/cell/}.  GCC's
10710 implementation differs in several ways.
10711
10712 @itemize @bullet
10713
10714 @item
10715 The optional extension of specifying vector constants in parentheses is
10716 not supported.
10717
10718 @item
10719 A vector initializer requires no cast if the vector constant is of the
10720 same type as the variable it is initializing.
10721
10722 @item
10723 If @code{signed} or @code{unsigned} is omitted, the signedness of the
10724 vector type is the default signedness of the base type.  The default
10725 varies depending on the operating system, so a portable program should
10726 always specify the signedness.
10727
10728 @item
10729 By default, the keyword @code{__vector} is added. The macro
10730 @code{vector} is defined in @code{<spu_intrinsics.h>} and can be
10731 undefined.
10732
10733 @item
10734 GCC allows using a @code{typedef} name as the type specifier for a
10735 vector type.
10736
10737 @item
10738 For C, overloaded functions are implemented with macros so the following
10739 does not work:
10740
10741 @smallexample
10742   spu_add ((vector signed int)@{1, 2, 3, 4@}, foo);
10743 @end smallexample
10744
10745 Since @code{spu_add} is a macro, the vector constant in the example
10746 is treated as four separate arguments.  Wrap the entire argument in
10747 parentheses for this to work.
10748
10749 @item
10750 The extended version of @code{__builtin_expect} is not supported.
10751
10752 @end itemize
10753
10754 @emph{Note:} Only the interface described in the aforementioned
10755 specification is supported. Internally, GCC uses built-in functions to
10756 implement the required functionality, but these are not supported and
10757 are subject to change without notice.
10758
10759 @node Target Format Checks
10760 @section Format Checks Specific to Particular Target Machines
10761
10762 For some target machines, GCC supports additional options to the
10763 format attribute
10764 (@pxref{Function Attributes,,Declaring Attributes of Functions}).
10765
10766 @menu
10767 * Solaris Format Checks::
10768 @end menu
10769
10770 @node Solaris Format Checks
10771 @subsection Solaris Format Checks
10772
10773 Solaris targets support the @code{cmn_err} (or @code{__cmn_err__}) format
10774 check.  @code{cmn_err} accepts a subset of the standard @code{printf}
10775 conversions, and the two-argument @code{%b} conversion for displaying
10776 bit-fields.  See the Solaris man page for @code{cmn_err} for more information.
10777
10778 @node Pragmas
10779 @section Pragmas Accepted by GCC
10780 @cindex pragmas
10781 @cindex #pragma
10782
10783 GCC supports several types of pragmas, primarily in order to compile
10784 code originally written for other compilers.  Note that in general
10785 we do not recommend the use of pragmas; @xref{Function Attributes},
10786 for further explanation.
10787
10788 @menu
10789 * ARM Pragmas::
10790 * M32C Pragmas::
10791 * RS/6000 and PowerPC Pragmas::
10792 * Darwin Pragmas::
10793 * Solaris Pragmas::
10794 * Symbol-Renaming Pragmas::
10795 * Structure-Packing Pragmas::
10796 * Weak Pragmas::
10797 * Diagnostic Pragmas::
10798 * Visibility Pragmas::
10799 @end menu
10800
10801 @node ARM Pragmas
10802 @subsection ARM Pragmas
10803
10804 The ARM target defines pragmas for controlling the default addition of
10805 @code{long_call} and @code{short_call} attributes to functions.
10806 @xref{Function Attributes}, for information about the effects of these
10807 attributes.
10808
10809 @table @code
10810 @item long_calls
10811 @cindex pragma, long_calls
10812 Set all subsequent functions to have the @code{long_call} attribute.
10813
10814 @item no_long_calls
10815 @cindex pragma, no_long_calls
10816 Set all subsequent functions to have the @code{short_call} attribute.
10817
10818 @item long_calls_off
10819 @cindex pragma, long_calls_off
10820 Do not affect the @code{long_call} or @code{short_call} attributes of
10821 subsequent functions.
10822 @end table
10823
10824 @node M32C Pragmas
10825 @subsection M32C Pragmas
10826
10827 @table @code
10828 @item memregs @var{number}
10829 @cindex pragma, memregs
10830 Overrides the command line option @code{-memregs=} for the current
10831 file.  Use with care!  This pragma must be before any function in the
10832 file, and mixing different memregs values in different objects may
10833 make them incompatible.  This pragma is useful when a
10834 performance-critical function uses a memreg for temporary values,
10835 as it may allow you to reduce the number of memregs used.
10836
10837 @end table
10838
10839 @node RS/6000 and PowerPC Pragmas
10840 @subsection RS/6000 and PowerPC Pragmas
10841
10842 The RS/6000 and PowerPC targets define one pragma for controlling
10843 whether or not the @code{longcall} attribute is added to function
10844 declarations by default.  This pragma overrides the @option{-mlongcall}
10845 option, but not the @code{longcall} and @code{shortcall} attributes.
10846 @xref{RS/6000 and PowerPC Options}, for more information about when long
10847 calls are and are not necessary.
10848
10849 @table @code
10850 @item longcall (1)
10851 @cindex pragma, longcall
10852 Apply the @code{longcall} attribute to all subsequent function
10853 declarations.
10854
10855 @item longcall (0)
10856 Do not apply the @code{longcall} attribute to subsequent function
10857 declarations.
10858 @end table
10859
10860 @c Describe c4x pragmas here.
10861 @c Describe h8300 pragmas here.
10862 @c Describe sh pragmas here.
10863 @c Describe v850 pragmas here.
10864
10865 @node Darwin Pragmas
10866 @subsection Darwin Pragmas
10867
10868 The following pragmas are available for all architectures running the
10869 Darwin operating system.  These are useful for compatibility with other
10870 Mac OS compilers.
10871
10872 @table @code
10873 @item mark @var{tokens}@dots{}
10874 @cindex pragma, mark
10875 This pragma is accepted, but has no effect.
10876
10877 @item options align=@var{alignment}
10878 @cindex pragma, options align
10879 This pragma sets the alignment of fields in structures.  The values of
10880 @var{alignment} may be @code{mac68k}, to emulate m68k alignment, or
10881 @code{power}, to emulate PowerPC alignment.  Uses of this pragma nest
10882 properly; to restore the previous setting, use @code{reset} for the
10883 @var{alignment}.
10884
10885 @item segment @var{tokens}@dots{}
10886 @cindex pragma, segment
10887 This pragma is accepted, but has no effect.
10888
10889 @item unused (@var{var} [, @var{var}]@dots{})
10890 @cindex pragma, unused
10891 This pragma declares variables to be possibly unused.  GCC will not
10892 produce warnings for the listed variables.  The effect is similar to
10893 that of the @code{unused} attribute, except that this pragma may appear
10894 anywhere within the variables' scopes.
10895 @end table
10896
10897 @node Solaris Pragmas
10898 @subsection Solaris Pragmas
10899
10900 The Solaris target supports @code{#pragma redefine_extname}
10901 (@pxref{Symbol-Renaming Pragmas}).  It also supports additional
10902 @code{#pragma} directives for compatibility with the system compiler.
10903
10904 @table @code
10905 @item align @var{alignment} (@var{variable} [, @var{variable}]...)
10906 @cindex pragma, align
10907
10908 Increase the minimum alignment of each @var{variable} to @var{alignment}.
10909 This is the same as GCC's @code{aligned} attribute @pxref{Variable
10910 Attributes}).  Macro expansion occurs on the arguments to this pragma
10911 when compiling C and Objective-C.  It does not currently occur when
10912 compiling C++, but this is a bug which may be fixed in a future
10913 release.
10914
10915 @item fini (@var{function} [, @var{function}]...)
10916 @cindex pragma, fini
10917
10918 This pragma causes each listed @var{function} to be called after
10919 main, or during shared module unloading, by adding a call to the
10920 @code{.fini} section.
10921
10922 @item init (@var{function} [, @var{function}]...)
10923 @cindex pragma, init
10924
10925 This pragma causes each listed @var{function} to be called during
10926 initialization (before @code{main}) or during shared module loading, by
10927 adding a call to the @code{.init} section.
10928
10929 @end table
10930
10931 @node Symbol-Renaming Pragmas
10932 @subsection Symbol-Renaming Pragmas
10933
10934 For compatibility with the Solaris and Tru64 UNIX system headers, GCC
10935 supports two @code{#pragma} directives which change the name used in
10936 assembly for a given declaration.  These pragmas are only available on
10937 platforms whose system headers need them.  To get this effect on all
10938 platforms supported by GCC, use the asm labels extension (@pxref{Asm
10939 Labels}).
10940
10941 @table @code
10942 @item redefine_extname @var{oldname} @var{newname}
10943 @cindex pragma, redefine_extname
10944
10945 This pragma gives the C function @var{oldname} the assembly symbol
10946 @var{newname}.  The preprocessor macro @code{__PRAGMA_REDEFINE_EXTNAME}
10947 will be defined if this pragma is available (currently only on
10948 Solaris).
10949
10950 @item extern_prefix @var{string}
10951 @cindex pragma, extern_prefix
10952
10953 This pragma causes all subsequent external function and variable
10954 declarations to have @var{string} prepended to their assembly symbols.
10955 This effect may be terminated with another @code{extern_prefix} pragma
10956 whose argument is an empty string.  The preprocessor macro
10957 @code{__PRAGMA_EXTERN_PREFIX} will be defined if this pragma is
10958 available (currently only on Tru64 UNIX)@.
10959 @end table
10960
10961 These pragmas and the asm labels extension interact in a complicated
10962 manner.  Here are some corner cases you may want to be aware of.
10963
10964 @enumerate
10965 @item Both pragmas silently apply only to declarations with external
10966 linkage.  Asm labels do not have this restriction.
10967
10968 @item In C++, both pragmas silently apply only to declarations with
10969 ``C'' linkage.  Again, asm labels do not have this restriction.
10970
10971 @item If any of the three ways of changing the assembly name of a
10972 declaration is applied to a declaration whose assembly name has
10973 already been determined (either by a previous use of one of these
10974 features, or because the compiler needed the assembly name in order to
10975 generate code), and the new name is different, a warning issues and
10976 the name does not change.
10977
10978 @item The @var{oldname} used by @code{#pragma redefine_extname} is
10979 always the C-language name.
10980
10981 @item If @code{#pragma extern_prefix} is in effect, and a declaration
10982 occurs with an asm label attached, the prefix is silently ignored for
10983 that declaration.
10984
10985 @item If @code{#pragma extern_prefix} and @code{#pragma redefine_extname}
10986 apply to the same declaration, whichever triggered first wins, and a
10987 warning issues if they contradict each other.  (We would like to have
10988 @code{#pragma redefine_extname} always win, for consistency with asm
10989 labels, but if @code{#pragma extern_prefix} triggers first we have no
10990 way of knowing that that happened.)
10991 @end enumerate
10992
10993 @node Structure-Packing Pragmas
10994 @subsection Structure-Packing Pragmas
10995
10996 For compatibility with Win32, GCC supports a set of @code{#pragma}
10997 directives which change the maximum alignment of members of structures
10998 (other than zero-width bitfields), unions, and classes subsequently
10999 defined.  The @var{n} value below always is required to be a small power
11000 of two and specifies the new alignment in bytes.
11001
11002 @enumerate
11003 @item @code{#pragma pack(@var{n})} simply sets the new alignment.
11004 @item @code{#pragma pack()} sets the alignment to the one that was in
11005 effect when compilation started (see also command line option
11006 @option{-fpack-struct[=<n>]} @pxref{Code Gen Options}).
11007 @item @code{#pragma pack(push[,@var{n}])} pushes the current alignment
11008 setting on an internal stack and then optionally sets the new alignment.
11009 @item @code{#pragma pack(pop)} restores the alignment setting to the one
11010 saved at the top of the internal stack (and removes that stack entry).
11011 Note that @code{#pragma pack([@var{n}])} does not influence this internal
11012 stack; thus it is possible to have @code{#pragma pack(push)} followed by
11013 multiple @code{#pragma pack(@var{n})} instances and finalized by a single
11014 @code{#pragma pack(pop)}.
11015 @end enumerate
11016
11017 Some targets, e.g. i386 and powerpc, support the @code{ms_struct}
11018 @code{#pragma} which lays out a structure as the documented
11019 @code{__attribute__ ((ms_struct))}.
11020 @enumerate
11021 @item @code{#pragma ms_struct on} turns on the layout for structures
11022 declared.
11023 @item @code{#pragma ms_struct off} turns off the layout for structures
11024 declared.
11025 @item @code{#pragma ms_struct reset} goes back to the default layout.
11026 @end enumerate
11027
11028 @node Weak Pragmas
11029 @subsection Weak Pragmas
11030
11031 For compatibility with SVR4, GCC supports a set of @code{#pragma}
11032 directives for declaring symbols to be weak, and defining weak
11033 aliases.
11034
11035 @table @code
11036 @item #pragma weak @var{symbol}
11037 @cindex pragma, weak
11038 This pragma declares @var{symbol} to be weak, as if the declaration
11039 had the attribute of the same name.  The pragma may appear before
11040 or after the declaration of @var{symbol}, but must appear before
11041 either its first use or its definition.  It is not an error for
11042 @var{symbol} to never be defined at all.
11043
11044 @item #pragma weak @var{symbol1} = @var{symbol2}
11045 This pragma declares @var{symbol1} to be a weak alias of @var{symbol2}.
11046 It is an error if @var{symbol2} is not defined in the current
11047 translation unit.
11048 @end table
11049
11050 @node Diagnostic Pragmas
11051 @subsection Diagnostic Pragmas
11052
11053 GCC allows the user to selectively enable or disable certain types of
11054 diagnostics, and change the kind of the diagnostic.  For example, a
11055 project's policy might require that all sources compile with
11056 @option{-Werror} but certain files might have exceptions allowing
11057 specific types of warnings.  Or, a project might selectively enable
11058 diagnostics and treat them as errors depending on which preprocessor
11059 macros are defined.
11060
11061 @table @code
11062 @item #pragma GCC diagnostic @var{kind} @var{option}
11063 @cindex pragma, diagnostic
11064
11065 Modifies the disposition of a diagnostic.  Note that not all
11066 diagnostics are modifiable; at the moment only warnings (normally
11067 controlled by @samp{-W...}) can be controlled, and not all of them.
11068 Use @option{-fdiagnostics-show-option} to determine which diagnostics
11069 are controllable and which option controls them.
11070
11071 @var{kind} is @samp{error} to treat this diagnostic as an error,
11072 @samp{warning} to treat it like a warning (even if @option{-Werror} is
11073 in effect), or @samp{ignored} if the diagnostic is to be ignored.
11074 @var{option} is a double quoted string which matches the command line
11075 option.
11076
11077 @example
11078 #pragma GCC diagnostic warning "-Wformat"
11079 #pragma GCC diagnostic error "-Wformat"
11080 #pragma GCC diagnostic ignored "-Wformat"
11081 @end example
11082
11083 Note that these pragmas override any command line options.  Also,
11084 while it is syntactically valid to put these pragmas anywhere in your
11085 sources, the only supported location for them is before any data or
11086 functions are defined.  Doing otherwise may result in unpredictable
11087 results depending on how the optimizer manages your sources.  If the
11088 same option is listed multiple times, the last one specified is the
11089 one that is in effect.  This pragma is not intended to be a general
11090 purpose replacement for command line options, but for implementing
11091 strict control over project policies.
11092
11093 @end table
11094
11095 @node Visibility Pragmas
11096 @subsection Visibility Pragmas
11097
11098 @table @code
11099 @item #pragma GCC visibility push(@var{visibility})
11100 @itemx #pragma GCC visibility pop
11101 @cindex pragma, visibility
11102
11103 This pragma allows the user to set the visibility for multiple
11104 declarations without having to give each a visibility attribute
11105 @xref{Function Attributes}, for more information about visibility and
11106 the attribute syntax.
11107
11108 In C++, @samp{#pragma GCC visibility} affects only namespace-scope
11109 declarations.  Class members and template specializations are not
11110 affected; if you want to override the visibility for a particular
11111 member or instantiation, you must use an attribute.
11112
11113 @end table
11114
11115 @node Unnamed Fields
11116 @section Unnamed struct/union fields within structs/unions
11117 @cindex struct
11118 @cindex union
11119
11120 For compatibility with other compilers, GCC allows you to define
11121 a structure or union that contains, as fields, structures and unions
11122 without names.  For example:
11123
11124 @smallexample
11125 struct @{
11126   int a;
11127   union @{
11128     int b;
11129     float c;
11130   @};
11131   int d;
11132 @} foo;
11133 @end smallexample
11134
11135 In this example, the user would be able to access members of the unnamed
11136 union with code like @samp{foo.b}.  Note that only unnamed structs and
11137 unions are allowed, you may not have, for example, an unnamed
11138 @code{int}.
11139
11140 You must never create such structures that cause ambiguous field definitions.
11141 For example, this structure:
11142
11143 @smallexample
11144 struct @{
11145   int a;
11146   struct @{
11147     int a;
11148   @};
11149 @} foo;
11150 @end smallexample
11151
11152 It is ambiguous which @code{a} is being referred to with @samp{foo.a}.
11153 Such constructs are not supported and must be avoided.  In the future,
11154 such constructs may be detected and treated as compilation errors.
11155
11156 @opindex fms-extensions
11157 Unless @option{-fms-extensions} is used, the unnamed field must be a
11158 structure or union definition without a tag (for example, @samp{struct
11159 @{ int a; @};}).  If @option{-fms-extensions} is used, the field may
11160 also be a definition with a tag such as @samp{struct foo @{ int a;
11161 @};}, a reference to a previously defined structure or union such as
11162 @samp{struct foo;}, or a reference to a @code{typedef} name for a
11163 previously defined structure or union type.
11164
11165 @node Thread-Local
11166 @section Thread-Local Storage
11167 @cindex Thread-Local Storage
11168 @cindex @acronym{TLS}
11169 @cindex __thread
11170
11171 Thread-local storage (@acronym{TLS}) is a mechanism by which variables
11172 are allocated such that there is one instance of the variable per extant
11173 thread.  The run-time model GCC uses to implement this originates
11174 in the IA-64 processor-specific ABI, but has since been migrated
11175 to other processors as well.  It requires significant support from
11176 the linker (@command{ld}), dynamic linker (@command{ld.so}), and
11177 system libraries (@file{libc.so} and @file{libpthread.so}), so it
11178 is not available everywhere.
11179
11180 At the user level, the extension is visible with a new storage
11181 class keyword: @code{__thread}.  For example:
11182
11183 @smallexample
11184 __thread int i;
11185 extern __thread struct state s;
11186 static __thread char *p;
11187 @end smallexample
11188
11189 The @code{__thread} specifier may be used alone, with the @code{extern}
11190 or @code{static} specifiers, but with no other storage class specifier.
11191 When used with @code{extern} or @code{static}, @code{__thread} must appear
11192 immediately after the other storage class specifier.
11193
11194 The @code{__thread} specifier may be applied to any global, file-scoped
11195 static, function-scoped static, or static data member of a class.  It may
11196 not be applied to block-scoped automatic or non-static data member.
11197
11198 When the address-of operator is applied to a thread-local variable, it is
11199 evaluated at run-time and returns the address of the current thread's
11200 instance of that variable.  An address so obtained may be used by any
11201 thread.  When a thread terminates, any pointers to thread-local variables
11202 in that thread become invalid.
11203
11204 No static initialization may refer to the address of a thread-local variable.
11205
11206 In C++, if an initializer is present for a thread-local variable, it must
11207 be a @var{constant-expression}, as defined in 5.19.2 of the ANSI/ISO C++
11208 standard.
11209
11210 See @uref{http://people.redhat.com/drepper/tls.pdf,
11211 ELF Handling For Thread-Local Storage} for a detailed explanation of
11212 the four thread-local storage addressing models, and how the run-time
11213 is expected to function.
11214
11215 @menu
11216 * C99 Thread-Local Edits::
11217 * C++98 Thread-Local Edits::
11218 @end menu
11219
11220 @node C99 Thread-Local Edits
11221 @subsection ISO/IEC 9899:1999 Edits for Thread-Local Storage
11222
11223 The following are a set of changes to ISO/IEC 9899:1999 (aka C99)
11224 that document the exact semantics of the language extension.
11225
11226 @itemize @bullet
11227 @item
11228 @cite{5.1.2  Execution environments}
11229
11230 Add new text after paragraph 1
11231
11232 @quotation
11233 Within either execution environment, a @dfn{thread} is a flow of
11234 control within a program.  It is implementation defined whether
11235 or not there may be more than one thread associated with a program.
11236 It is implementation defined how threads beyond the first are
11237 created, the name and type of the function called at thread
11238 startup, and how threads may be terminated.  However, objects
11239 with thread storage duration shall be initialized before thread
11240 startup.
11241 @end quotation
11242
11243 @item
11244 @cite{6.2.4  Storage durations of objects}
11245
11246 Add new text before paragraph 3
11247
11248 @quotation
11249 An object whose identifier is declared with the storage-class
11250 specifier @w{@code{__thread}} has @dfn{thread storage duration}.
11251 Its lifetime is the entire execution of the thread, and its
11252 stored value is initialized only once, prior to thread startup.
11253 @end quotation
11254
11255 @item
11256 @cite{6.4.1  Keywords}
11257
11258 Add @code{__thread}.
11259
11260 @item
11261 @cite{6.7.1  Storage-class specifiers}
11262
11263 Add @code{__thread} to the list of storage class specifiers in
11264 paragraph 1.
11265
11266 Change paragraph 2 to
11267
11268 @quotation
11269 With the exception of @code{__thread}, at most one storage-class
11270 specifier may be given [@dots{}].  The @code{__thread} specifier may
11271 be used alone, or immediately following @code{extern} or
11272 @code{static}.
11273 @end quotation
11274
11275 Add new text after paragraph 6
11276
11277 @quotation
11278 The declaration of an identifier for a variable that has
11279 block scope that specifies @code{__thread} shall also
11280 specify either @code{extern} or @code{static}.
11281
11282 The @code{__thread} specifier shall be used only with
11283 variables.
11284 @end quotation
11285 @end itemize
11286
11287 @node C++98 Thread-Local Edits
11288 @subsection ISO/IEC 14882:1998 Edits for Thread-Local Storage
11289
11290 The following are a set of changes to ISO/IEC 14882:1998 (aka C++98)
11291 that document the exact semantics of the language extension.
11292
11293 @itemize @bullet
11294 @item
11295 @b{[intro.execution]}
11296
11297 New text after paragraph 4
11298
11299 @quotation
11300 A @dfn{thread} is a flow of control within the abstract machine.
11301 It is implementation defined whether or not there may be more than
11302 one thread.
11303 @end quotation
11304
11305 New text after paragraph 7
11306
11307 @quotation
11308 It is unspecified whether additional action must be taken to
11309 ensure when and whether side effects are visible to other threads.
11310 @end quotation
11311
11312 @item
11313 @b{[lex.key]}
11314
11315 Add @code{__thread}.
11316
11317 @item
11318 @b{[basic.start.main]}
11319
11320 Add after paragraph 5
11321
11322 @quotation
11323 The thread that begins execution at the @code{main} function is called
11324 the @dfn{main thread}.  It is implementation defined how functions
11325 beginning threads other than the main thread are designated or typed.
11326 A function so designated, as well as the @code{main} function, is called
11327 a @dfn{thread startup function}.  It is implementation defined what
11328 happens if a thread startup function returns.  It is implementation
11329 defined what happens to other threads when any thread calls @code{exit}.
11330 @end quotation
11331
11332 @item
11333 @b{[basic.start.init]}
11334
11335 Add after paragraph 4
11336
11337 @quotation
11338 The storage for an object of thread storage duration shall be
11339 statically initialized before the first statement of the thread startup
11340 function.  An object of thread storage duration shall not require
11341 dynamic initialization.
11342 @end quotation
11343
11344 @item
11345 @b{[basic.start.term]}
11346
11347 Add after paragraph 3
11348
11349 @quotation
11350 The type of an object with thread storage duration shall not have a
11351 non-trivial destructor, nor shall it be an array type whose elements
11352 (directly or indirectly) have non-trivial destructors.
11353 @end quotation
11354
11355 @item
11356 @b{[basic.stc]}
11357
11358 Add ``thread storage duration'' to the list in paragraph 1.
11359
11360 Change paragraph 2
11361
11362 @quotation
11363 Thread, static, and automatic storage durations are associated with
11364 objects introduced by declarations [@dots{}].
11365 @end quotation
11366
11367 Add @code{__thread} to the list of specifiers in paragraph 3.
11368
11369 @item
11370 @b{[basic.stc.thread]}
11371
11372 New section before @b{[basic.stc.static]}
11373
11374 @quotation
11375 The keyword @code{__thread} applied to a non-local object gives the
11376 object thread storage duration.
11377
11378 A local variable or class data member declared both @code{static}
11379 and @code{__thread} gives the variable or member thread storage
11380 duration.
11381 @end quotation
11382
11383 @item
11384 @b{[basic.stc.static]}
11385
11386 Change paragraph 1
11387
11388 @quotation
11389 All objects which have neither thread storage duration, dynamic
11390 storage duration nor are local [@dots{}].
11391 @end quotation
11392
11393 @item
11394 @b{[dcl.stc]}
11395
11396 Add @code{__thread} to the list in paragraph 1.
11397
11398 Change paragraph 1
11399
11400 @quotation
11401 With the exception of @code{__thread}, at most one
11402 @var{storage-class-specifier} shall appear in a given
11403 @var{decl-specifier-seq}.  The @code{__thread} specifier may
11404 be used alone, or immediately following the @code{extern} or
11405 @code{static} specifiers.  [@dots{}]
11406 @end quotation
11407
11408 Add after paragraph 5
11409
11410 @quotation
11411 The @code{__thread} specifier can be applied only to the names of objects
11412 and to anonymous unions.
11413 @end quotation
11414
11415 @item
11416 @b{[class.mem]}
11417
11418 Add after paragraph 6
11419
11420 @quotation
11421 Non-@code{static} members shall not be @code{__thread}.
11422 @end quotation
11423 @end itemize
11424
11425 @node Binary constants
11426 @section Binary constants using the @samp{0b} prefix
11427 @cindex Binary constants using the @samp{0b} prefix
11428
11429 Integer constants can be written as binary constants, consisting of a
11430 sequence of @samp{0} and @samp{1} digits, prefixed by @samp{0b} or
11431 @samp{0B}.  This is particularly useful in environments that operate a
11432 lot on the bit-level (like microcontrollers).
11433
11434 The following statements are identical:
11435
11436 @smallexample
11437 i =       42;
11438 i =     0x2a;
11439 i =      052;
11440 i = 0b101010;
11441 @end smallexample
11442
11443 The type of these constants follows the same rules as for octal or
11444 hexadecimal integer constants, so suffixes like @samp{L} or @samp{UL}
11445 can be applied.
11446
11447 @node C++ Extensions
11448 @chapter Extensions to the C++ Language
11449 @cindex extensions, C++ language
11450 @cindex C++ language extensions
11451
11452 The GNU compiler provides these extensions to the C++ language (and you
11453 can also use most of the C language extensions in your C++ programs).  If you
11454 want to write code that checks whether these features are available, you can
11455 test for the GNU compiler the same way as for C programs: check for a
11456 predefined macro @code{__GNUC__}.  You can also use @code{__GNUG__} to
11457 test specifically for GNU C++ (@pxref{Common Predefined Macros,,
11458 Predefined Macros,cpp,The GNU C Preprocessor}).
11459
11460 @menu
11461 * Volatiles::           What constitutes an access to a volatile object.
11462 * Restricted Pointers:: C99 restricted pointers and references.
11463 * Vague Linkage::       Where G++ puts inlines, vtables and such.
11464 * C++ Interface::       You can use a single C++ header file for both
11465                         declarations and definitions.
11466 * Template Instantiation:: Methods for ensuring that exactly one copy of
11467                         each needed template instantiation is emitted.
11468 * Bound member functions:: You can extract a function pointer to the
11469                         method denoted by a @samp{->*} or @samp{.*} expression.
11470 * C++ Attributes::      Variable, function, and type attributes for C++ only.
11471 * Namespace Association:: Strong using-directives for namespace association.
11472 * Type Traits::         Compiler support for type traits
11473 * Java Exceptions::     Tweaking exception handling to work with Java.
11474 * Deprecated Features:: Things will disappear from g++.
11475 * Backwards Compatibility:: Compatibilities with earlier definitions of C++.
11476 @end menu
11477
11478 @node Volatiles
11479 @section When is a Volatile Object Accessed?
11480 @cindex accessing volatiles
11481 @cindex volatile read
11482 @cindex volatile write
11483 @cindex volatile access
11484
11485 Both the C and C++ standard have the concept of volatile objects.  These
11486 are normally accessed by pointers and used for accessing hardware.  The
11487 standards encourage compilers to refrain from optimizations concerning
11488 accesses to volatile objects.  The C standard leaves it implementation
11489 defined  as to what constitutes a volatile access.  The C++ standard omits
11490 to specify this, except to say that C++ should behave in a similar manner
11491 to C with respect to volatiles, where possible.  The minimum either
11492 standard specifies is that at a sequence point all previous accesses to
11493 volatile objects have stabilized and no subsequent accesses have
11494 occurred.  Thus an implementation is free to reorder and combine
11495 volatile accesses which occur between sequence points, but cannot do so
11496 for accesses across a sequence point.  The use of volatiles does not
11497 allow you to violate the restriction on updating objects multiple times
11498 within a sequence point.
11499
11500 @xref{Qualifiers implementation, , Volatile qualifier and the C compiler}.
11501
11502 The behavior differs slightly between C and C++ in the non-obvious cases:
11503
11504 @smallexample
11505 volatile int *src = @var{somevalue};
11506 *src;
11507 @end smallexample
11508
11509 With C, such expressions are rvalues, and GCC interprets this either as a
11510 read of the volatile object being pointed to or only as request to evaluate
11511 the side-effects.  The C++ standard specifies that such expressions do not
11512 undergo lvalue to rvalue conversion, and that the type of the dereferenced
11513 object may be incomplete.  The C++ standard does not specify explicitly
11514 that it is this lvalue to rvalue conversion which may be responsible for
11515 causing an access.  However, there is reason to believe that it is,
11516 because otherwise certain simple expressions become undefined.  However,
11517 because it would surprise most programmers, G++ treats dereferencing a
11518 pointer to volatile object of complete type when the value is unused as
11519 GCC would do for an equivalent type in C.  When the object has incomplete
11520 type, G++ issues a warning; if you wish to force an error, you must
11521 force a conversion to rvalue with, for instance, a static cast.
11522
11523 When using a reference to volatile, G++ does not treat equivalent
11524 expressions as accesses to volatiles, but instead issues a warning that
11525 no volatile is accessed.  The rationale for this is that otherwise it
11526 becomes difficult to determine where volatile access occur, and not
11527 possible to ignore the return value from functions returning volatile
11528 references.  Again, if you wish to force a read, cast the reference to
11529 an rvalue.
11530
11531 @node Restricted Pointers
11532 @section Restricting Pointer Aliasing
11533 @cindex restricted pointers
11534 @cindex restricted references
11535 @cindex restricted this pointer
11536
11537 As with the C front end, G++ understands the C99 feature of restricted pointers,
11538 specified with the @code{__restrict__}, or @code{__restrict} type
11539 qualifier.  Because you cannot compile C++ by specifying the @option{-std=c99}
11540 language flag, @code{restrict} is not a keyword in C++.
11541
11542 In addition to allowing restricted pointers, you can specify restricted
11543 references, which indicate that the reference is not aliased in the local
11544 context.
11545
11546 @smallexample
11547 void fn (int *__restrict__ rptr, int &__restrict__ rref)
11548 @{
11549   /* @r{@dots{}} */
11550 @}
11551 @end smallexample
11552
11553 @noindent
11554 In the body of @code{fn}, @var{rptr} points to an unaliased integer and
11555 @var{rref} refers to a (different) unaliased integer.
11556
11557 You may also specify whether a member function's @var{this} pointer is
11558 unaliased by using @code{__restrict__} as a member function qualifier.
11559
11560 @smallexample
11561 void T::fn () __restrict__
11562 @{
11563   /* @r{@dots{}} */
11564 @}
11565 @end smallexample
11566
11567 @noindent
11568 Within the body of @code{T::fn}, @var{this} will have the effective
11569 definition @code{T *__restrict__ const this}.  Notice that the
11570 interpretation of a @code{__restrict__} member function qualifier is
11571 different to that of @code{const} or @code{volatile} qualifier, in that it
11572 is applied to the pointer rather than the object.  This is consistent with
11573 other compilers which implement restricted pointers.
11574
11575 As with all outermost parameter qualifiers, @code{__restrict__} is
11576 ignored in function definition matching.  This means you only need to
11577 specify @code{__restrict__} in a function definition, rather than
11578 in a function prototype as well.
11579
11580 @node Vague Linkage
11581 @section Vague Linkage
11582 @cindex vague linkage
11583
11584 There are several constructs in C++ which require space in the object
11585 file but are not clearly tied to a single translation unit.  We say that
11586 these constructs have ``vague linkage''.  Typically such constructs are
11587 emitted wherever they are needed, though sometimes we can be more
11588 clever.
11589
11590 @table @asis
11591 @item Inline Functions
11592 Inline functions are typically defined in a header file which can be
11593 included in many different compilations.  Hopefully they can usually be
11594 inlined, but sometimes an out-of-line copy is necessary, if the address
11595 of the function is taken or if inlining fails.  In general, we emit an
11596 out-of-line copy in all translation units where one is needed.  As an
11597 exception, we only emit inline virtual functions with the vtable, since
11598 it will always require a copy.
11599
11600 Local static variables and string constants used in an inline function
11601 are also considered to have vague linkage, since they must be shared
11602 between all inlined and out-of-line instances of the function.
11603
11604 @item VTables
11605 @cindex vtable
11606 C++ virtual functions are implemented in most compilers using a lookup
11607 table, known as a vtable.  The vtable contains pointers to the virtual
11608 functions provided by a class, and each object of the class contains a
11609 pointer to its vtable (or vtables, in some multiple-inheritance
11610 situations).  If the class declares any non-inline, non-pure virtual
11611 functions, the first one is chosen as the ``key method'' for the class,
11612 and the vtable is only emitted in the translation unit where the key
11613 method is defined.
11614
11615 @emph{Note:} If the chosen key method is later defined as inline, the
11616 vtable will still be emitted in every translation unit which defines it.
11617 Make sure that any inline virtuals are declared inline in the class
11618 body, even if they are not defined there.
11619
11620 @item type_info objects
11621 @cindex type_info
11622 @cindex RTTI
11623 C++ requires information about types to be written out in order to
11624 implement @samp{dynamic_cast}, @samp{typeid} and exception handling.
11625 For polymorphic classes (classes with virtual functions), the type_info
11626 object is written out along with the vtable so that @samp{dynamic_cast}
11627 can determine the dynamic type of a class object at runtime.  For all
11628 other types, we write out the type_info object when it is used: when
11629 applying @samp{typeid} to an expression, throwing an object, or
11630 referring to a type in a catch clause or exception specification.
11631
11632 @item Template Instantiations
11633 Most everything in this section also applies to template instantiations,
11634 but there are other options as well.
11635 @xref{Template Instantiation,,Where's the Template?}.
11636
11637 @end table
11638
11639 When used with GNU ld version 2.8 or later on an ELF system such as
11640 GNU/Linux or Solaris 2, or on Microsoft Windows, duplicate copies of
11641 these constructs will be discarded at link time.  This is known as
11642 COMDAT support.
11643
11644 On targets that don't support COMDAT, but do support weak symbols, GCC
11645 will use them.  This way one copy will override all the others, but
11646 the unused copies will still take up space in the executable.
11647
11648 For targets which do not support either COMDAT or weak symbols,
11649 most entities with vague linkage will be emitted as local symbols to
11650 avoid duplicate definition errors from the linker.  This will not happen
11651 for local statics in inlines, however, as having multiple copies will
11652 almost certainly break things.
11653
11654 @xref{C++ Interface,,Declarations and Definitions in One Header}, for
11655 another way to control placement of these constructs.
11656
11657 @node C++ Interface
11658 @section #pragma interface and implementation
11659
11660 @cindex interface and implementation headers, C++
11661 @cindex C++ interface and implementation headers
11662 @cindex pragmas, interface and implementation
11663
11664 @code{#pragma interface} and @code{#pragma implementation} provide the
11665 user with a way of explicitly directing the compiler to emit entities
11666 with vague linkage (and debugging information) in a particular
11667 translation unit.
11668
11669 @emph{Note:} As of GCC 2.7.2, these @code{#pragma}s are not useful in
11670 most cases, because of COMDAT support and the ``key method'' heuristic
11671 mentioned in @ref{Vague Linkage}.  Using them can actually cause your
11672 program to grow due to unnecessary out-of-line copies of inline
11673 functions.  Currently (3.4) the only benefit of these
11674 @code{#pragma}s is reduced duplication of debugging information, and
11675 that should be addressed soon on DWARF 2 targets with the use of
11676 COMDAT groups.
11677
11678 @table @code
11679 @item #pragma interface
11680 @itemx #pragma interface "@var{subdir}/@var{objects}.h"
11681 @kindex #pragma interface
11682 Use this directive in @emph{header files} that define object classes, to save
11683 space in most of the object files that use those classes.  Normally,
11684 local copies of certain information (backup copies of inline member
11685 functions, debugging information, and the internal tables that implement
11686 virtual functions) must be kept in each object file that includes class
11687 definitions.  You can use this pragma to avoid such duplication.  When a
11688 header file containing @samp{#pragma interface} is included in a
11689 compilation, this auxiliary information will not be generated (unless
11690 the main input source file itself uses @samp{#pragma implementation}).
11691 Instead, the object files will contain references to be resolved at link
11692 time.
11693
11694 The second form of this directive is useful for the case where you have
11695 multiple headers with the same name in different directories.  If you
11696 use this form, you must specify the same string to @samp{#pragma
11697 implementation}.
11698
11699 @item #pragma implementation
11700 @itemx #pragma implementation "@var{objects}.h"
11701 @kindex #pragma implementation
11702 Use this pragma in a @emph{main input file}, when you want full output from
11703 included header files to be generated (and made globally visible).  The
11704 included header file, in turn, should use @samp{#pragma interface}.
11705 Backup copies of inline member functions, debugging information, and the
11706 internal tables used to implement virtual functions are all generated in
11707 implementation files.
11708
11709 @cindex implied @code{#pragma implementation}
11710 @cindex @code{#pragma implementation}, implied
11711 @cindex naming convention, implementation headers
11712 If you use @samp{#pragma implementation} with no argument, it applies to
11713 an include file with the same basename@footnote{A file's @dfn{basename}
11714 was the name stripped of all leading path information and of trailing
11715 suffixes, such as @samp{.h} or @samp{.C} or @samp{.cc}.} as your source
11716 file.  For example, in @file{allclass.cc}, giving just
11717 @samp{#pragma implementation}
11718 by itself is equivalent to @samp{#pragma implementation "allclass.h"}.
11719
11720 In versions of GNU C++ prior to 2.6.0 @file{allclass.h} was treated as
11721 an implementation file whenever you would include it from
11722 @file{allclass.cc} even if you never specified @samp{#pragma
11723 implementation}.  This was deemed to be more trouble than it was worth,
11724 however, and disabled.
11725
11726 Use the string argument if you want a single implementation file to
11727 include code from multiple header files.  (You must also use
11728 @samp{#include} to include the header file; @samp{#pragma
11729 implementation} only specifies how to use the file---it doesn't actually
11730 include it.)
11731
11732 There is no way to split up the contents of a single header file into
11733 multiple implementation files.
11734 @end table
11735
11736 @cindex inlining and C++ pragmas
11737 @cindex C++ pragmas, effect on inlining
11738 @cindex pragmas in C++, effect on inlining
11739 @samp{#pragma implementation} and @samp{#pragma interface} also have an
11740 effect on function inlining.
11741
11742 If you define a class in a header file marked with @samp{#pragma
11743 interface}, the effect on an inline function defined in that class is
11744 similar to an explicit @code{extern} declaration---the compiler emits
11745 no code at all to define an independent version of the function.  Its
11746 definition is used only for inlining with its callers.
11747
11748 @opindex fno-implement-inlines
11749 Conversely, when you include the same header file in a main source file
11750 that declares it as @samp{#pragma implementation}, the compiler emits
11751 code for the function itself; this defines a version of the function
11752 that can be found via pointers (or by callers compiled without
11753 inlining).  If all calls to the function can be inlined, you can avoid
11754 emitting the function by compiling with @option{-fno-implement-inlines}.
11755 If any calls were not inlined, you will get linker errors.
11756
11757 @node Template Instantiation
11758 @section Where's the Template?
11759 @cindex template instantiation
11760
11761 C++ templates are the first language feature to require more
11762 intelligence from the environment than one usually finds on a UNIX
11763 system.  Somehow the compiler and linker have to make sure that each
11764 template instance occurs exactly once in the executable if it is needed,
11765 and not at all otherwise.  There are two basic approaches to this
11766 problem, which are referred to as the Borland model and the Cfront model.
11767
11768 @table @asis
11769 @item Borland model
11770 Borland C++ solved the template instantiation problem by adding the code
11771 equivalent of common blocks to their linker; the compiler emits template
11772 instances in each translation unit that uses them, and the linker
11773 collapses them together.  The advantage of this model is that the linker
11774 only has to consider the object files themselves; there is no external
11775 complexity to worry about.  This disadvantage is that compilation time
11776 is increased because the template code is being compiled repeatedly.
11777 Code written for this model tends to include definitions of all
11778 templates in the header file, since they must be seen to be
11779 instantiated.
11780
11781 @item Cfront model
11782 The AT&T C++ translator, Cfront, solved the template instantiation
11783 problem by creating the notion of a template repository, an
11784 automatically maintained place where template instances are stored.  A
11785 more modern version of the repository works as follows: As individual
11786 object files are built, the compiler places any template definitions and
11787 instantiations encountered in the repository.  At link time, the link
11788 wrapper adds in the objects in the repository and compiles any needed
11789 instances that were not previously emitted.  The advantages of this
11790 model are more optimal compilation speed and the ability to use the
11791 system linker; to implement the Borland model a compiler vendor also
11792 needs to replace the linker.  The disadvantages are vastly increased
11793 complexity, and thus potential for error; for some code this can be
11794 just as transparent, but in practice it can been very difficult to build
11795 multiple programs in one directory and one program in multiple
11796 directories.  Code written for this model tends to separate definitions
11797 of non-inline member templates into a separate file, which should be
11798 compiled separately.
11799 @end table
11800
11801 When used with GNU ld version 2.8 or later on an ELF system such as
11802 GNU/Linux or Solaris 2, or on Microsoft Windows, G++ supports the
11803 Borland model.  On other systems, G++ implements neither automatic
11804 model.
11805
11806 A future version of G++ will support a hybrid model whereby the compiler
11807 will emit any instantiations for which the template definition is
11808 included in the compile, and store template definitions and
11809 instantiation context information into the object file for the rest.
11810 The link wrapper will extract that information as necessary and invoke
11811 the compiler to produce the remaining instantiations.  The linker will
11812 then combine duplicate instantiations.
11813
11814 In the mean time, you have the following options for dealing with
11815 template instantiations:
11816
11817 @enumerate
11818 @item
11819 @opindex frepo
11820 Compile your template-using code with @option{-frepo}.  The compiler will
11821 generate files with the extension @samp{.rpo} listing all of the
11822 template instantiations used in the corresponding object files which
11823 could be instantiated there; the link wrapper, @samp{collect2}, will
11824 then update the @samp{.rpo} files to tell the compiler where to place
11825 those instantiations and rebuild any affected object files.  The
11826 link-time overhead is negligible after the first pass, as the compiler
11827 will continue to place the instantiations in the same files.
11828
11829 This is your best option for application code written for the Borland
11830 model, as it will just work.  Code written for the Cfront model will
11831 need to be modified so that the template definitions are available at
11832 one or more points of instantiation; usually this is as simple as adding
11833 @code{#include <tmethods.cc>} to the end of each template header.
11834
11835 For library code, if you want the library to provide all of the template
11836 instantiations it needs, just try to link all of its object files
11837 together; the link will fail, but cause the instantiations to be
11838 generated as a side effect.  Be warned, however, that this may cause
11839 conflicts if multiple libraries try to provide the same instantiations.
11840 For greater control, use explicit instantiation as described in the next
11841 option.
11842
11843 @item
11844 @opindex fno-implicit-templates
11845 Compile your code with @option{-fno-implicit-templates} to disable the
11846 implicit generation of template instances, and explicitly instantiate
11847 all the ones you use.  This approach requires more knowledge of exactly
11848 which instances you need than do the others, but it's less
11849 mysterious and allows greater control.  You can scatter the explicit
11850 instantiations throughout your program, perhaps putting them in the
11851 translation units where the instances are used or the translation units
11852 that define the templates themselves; you can put all of the explicit
11853 instantiations you need into one big file; or you can create small files
11854 like
11855
11856 @smallexample
11857 #include "Foo.h"
11858 #include "Foo.cc"
11859
11860 template class Foo<int>;
11861 template ostream& operator <<
11862                 (ostream&, const Foo<int>&);
11863 @end smallexample
11864
11865 for each of the instances you need, and create a template instantiation
11866 library from those.
11867
11868 If you are using Cfront-model code, you can probably get away with not
11869 using @option{-fno-implicit-templates} when compiling files that don't
11870 @samp{#include} the member template definitions.
11871
11872 If you use one big file to do the instantiations, you may want to
11873 compile it without @option{-fno-implicit-templates} so you get all of the
11874 instances required by your explicit instantiations (but not by any
11875 other files) without having to specify them as well.
11876
11877 G++ has extended the template instantiation syntax given in the ISO
11878 standard to allow forward declaration of explicit instantiations
11879 (with @code{extern}), instantiation of the compiler support data for a
11880 template class (i.e.@: the vtable) without instantiating any of its
11881 members (with @code{inline}), and instantiation of only the static data
11882 members of a template class, without the support data or member
11883 functions (with (@code{static}):
11884
11885 @smallexample
11886 extern template int max (int, int);
11887 inline template class Foo<int>;
11888 static template class Foo<int>;
11889 @end smallexample
11890
11891 @item
11892 Do nothing.  Pretend G++ does implement automatic instantiation
11893 management.  Code written for the Borland model will work fine, but
11894 each translation unit will contain instances of each of the templates it
11895 uses.  In a large program, this can lead to an unacceptable amount of code
11896 duplication.
11897 @end enumerate
11898
11899 @node Bound member functions
11900 @section Extracting the function pointer from a bound pointer to member function
11901 @cindex pmf
11902 @cindex pointer to member function
11903 @cindex bound pointer to member function
11904
11905 In C++, pointer to member functions (PMFs) are implemented using a wide
11906 pointer of sorts to handle all the possible call mechanisms; the PMF
11907 needs to store information about how to adjust the @samp{this} pointer,
11908 and if the function pointed to is virtual, where to find the vtable, and
11909 where in the vtable to look for the member function.  If you are using
11910 PMFs in an inner loop, you should really reconsider that decision.  If
11911 that is not an option, you can extract the pointer to the function that
11912 would be called for a given object/PMF pair and call it directly inside
11913 the inner loop, to save a bit of time.
11914
11915 Note that you will still be paying the penalty for the call through a
11916 function pointer; on most modern architectures, such a call defeats the
11917 branch prediction features of the CPU@.  This is also true of normal
11918 virtual function calls.
11919
11920 The syntax for this extension is
11921
11922 @smallexample
11923 extern A a;
11924 extern int (A::*fp)();
11925 typedef int (*fptr)(A *);
11926
11927 fptr p = (fptr)(a.*fp);
11928 @end smallexample
11929
11930 For PMF constants (i.e.@: expressions of the form @samp{&Klasse::Member}),
11931 no object is needed to obtain the address of the function.  They can be
11932 converted to function pointers directly:
11933
11934 @smallexample
11935 fptr p1 = (fptr)(&A::foo);
11936 @end smallexample
11937
11938 @opindex Wno-pmf-conversions
11939 You must specify @option{-Wno-pmf-conversions} to use this extension.
11940
11941 @node C++ Attributes
11942 @section C++-Specific Variable, Function, and Type Attributes
11943
11944 Some attributes only make sense for C++ programs.
11945
11946 @table @code
11947 @item init_priority (@var{priority})
11948 @cindex init_priority attribute
11949
11950
11951 In Standard C++, objects defined at namespace scope are guaranteed to be
11952 initialized in an order in strict accordance with that of their definitions
11953 @emph{in a given translation unit}.  No guarantee is made for initializations
11954 across translation units.  However, GNU C++ allows users to control the
11955 order of initialization of objects defined at namespace scope with the
11956 @code{init_priority} attribute by specifying a relative @var{priority},
11957 a constant integral expression currently bounded between 101 and 65535
11958 inclusive.  Lower numbers indicate a higher priority.
11959
11960 In the following example, @code{A} would normally be created before
11961 @code{B}, but the @code{init_priority} attribute has reversed that order:
11962
11963 @smallexample
11964 Some_Class  A  __attribute__ ((init_priority (2000)));
11965 Some_Class  B  __attribute__ ((init_priority (543)));
11966 @end smallexample
11967
11968 @noindent
11969 Note that the particular values of @var{priority} do not matter; only their
11970 relative ordering.
11971
11972 @item java_interface
11973 @cindex java_interface attribute
11974
11975 This type attribute informs C++ that the class is a Java interface.  It may
11976 only be applied to classes declared within an @code{extern "Java"} block.
11977 Calls to methods declared in this interface will be dispatched using GCJ's
11978 interface table mechanism, instead of regular virtual table dispatch.
11979
11980 @end table
11981
11982 See also @xref{Namespace Association}.
11983
11984 @node Namespace Association
11985 @section Namespace Association
11986
11987 @strong{Caution:} The semantics of this extension are not fully
11988 defined.  Users should refrain from using this extension as its
11989 semantics may change subtly over time.  It is possible that this
11990 extension will be removed in future versions of G++.
11991
11992 A using-directive with @code{__attribute ((strong))} is stronger
11993 than a normal using-directive in two ways:
11994
11995 @itemize @bullet
11996 @item
11997 Templates from the used namespace can be specialized and explicitly
11998 instantiated as though they were members of the using namespace.
11999
12000 @item
12001 The using namespace is considered an associated namespace of all
12002 templates in the used namespace for purposes of argument-dependent
12003 name lookup.
12004 @end itemize
12005
12006 The used namespace must be nested within the using namespace so that
12007 normal unqualified lookup works properly.
12008
12009 This is useful for composing a namespace transparently from
12010 implementation namespaces.  For example:
12011
12012 @smallexample
12013 namespace std @{
12014   namespace debug @{
12015     template <class T> struct A @{ @};
12016   @}
12017   using namespace debug __attribute ((__strong__));
12018   template <> struct A<int> @{ @};   // @r{ok to specialize}
12019
12020   template <class T> void f (A<T>);
12021 @}
12022
12023 int main()
12024 @{
12025   f (std::A<float>());             // @r{lookup finds} std::f
12026   f (std::A<int>());
12027 @}
12028 @end smallexample
12029
12030 @node Type Traits
12031 @section Type Traits
12032
12033 The C++ front-end implements syntactic extensions that allow to
12034 determine at compile time various characteristics of a type (or of a
12035 pair of types).
12036
12037 @table @code
12038 @item __has_nothrow_assign (type)
12039 If @code{type} is const qualified or is a reference type then the trait is
12040 false.  Otherwise if @code{__has_trivial_assign (type)} is true then the trait
12041 is true, else if @code{type} is a cv class or union type with copy assignment
12042 operators that are known not to throw an exception then the trait is true,
12043 else it is false.  Requires: @code{type} shall be a complete type, an array
12044 type of unknown bound, or is a @code{void} type.
12045
12046 @item __has_nothrow_copy (type)
12047 If @code{__has_trivial_copy (type)} is true then the trait is true, else if
12048 @code{type} is a cv class or union type with copy constructors that
12049 are known not to throw an exception then the trait is true, else it is false.
12050 Requires: @code{type} shall be a complete type, an array type of
12051 unknown bound, or is a @code{void} type.
12052
12053 @item __has_nothrow_constructor (type)
12054 If @code{__has_trivial_constructor (type)} is true then the trait is
12055 true, else if @code{type} is a cv class or union type (or array
12056 thereof) with a default constructor that is known not to throw an
12057 exception then the trait is true, else it is false.  Requires:
12058 @code{type} shall be a complete type, an array type of unknown bound,
12059 or is a @code{void} type.
12060
12061 @item __has_trivial_assign (type)
12062 If @code{type} is const qualified or is a reference type then the trait is
12063 false.  Otherwise if @code{__is_pod (type)} is true then the trait is
12064 true, else if @code{type} is a cv class or union type with a trivial
12065 copy assignment ([class.copy]) then the trait is true, else it is
12066 false.  Requires: @code{type} shall be a complete type, an array type
12067 of unknown bound, or is a @code{void} type.
12068
12069 @item __has_trivial_copy (type)
12070 If @code{__is_pod (type)} is true or @code{type} is a reference type 
12071 then the trait is true, else if @code{type} is a cv class or union type
12072 with a trivial copy constructor ([class.copy]) then the trait
12073 is true, else it is false.  Requires: @code{type} shall be a complete
12074 type, an array type of unknown bound, or is a @code{void} type.
12075
12076 @item __has_trivial_constructor (type)
12077 If @code{__is_pod (type)} is true then the trait is true, else if
12078 @code{type} is a cv class or union type (or array thereof) with a
12079 trivial default constructor ([class.ctor]) then the trait is true,
12080 else it is false.  Requires: @code{type} shall be a complete type, an
12081 array type of unknown bound, or is a @code{void} type.
12082
12083 @item __has_trivial_destructor (type)
12084 If @code{__is_pod (type)} is true or @code{type} is a reference type then
12085 the trait is true, else if @code{type} is a cv class or union type (or
12086 array thereof) with a trivial destructor ([class.dtor]) then the trait
12087 is true, else it is false.  Requires: @code{type} shall be a complete
12088 type, an array type of unknown bound, or is a @code{void} type.
12089
12090 @item __has_virtual_destructor (type)
12091 If @code{type} is a class type with a virtual destructor
12092 ([class.dtor]) then the trait is true, else it is false.  Requires:
12093 @code{type}  shall be a complete type, an array type of unknown bound,
12094 or is a @code{void} type.
12095
12096 @item __is_abstract (type)
12097 If @code{type} is an abstract class ([class.abstract]) then the trait
12098 is true, else it is false.  Requires: @code{type} shall be a complete
12099 type, an array type of unknown bound, or is a @code{void} type.
12100
12101 @item __is_base_of (base_type, derived_type)
12102 If @code{base_type} is a base class of @code{derived_type}
12103 ([class.derived]) then the trait is true, otherwise it is false.
12104 Top-level cv qualifications of @code{base_type} and
12105 @code{derived_type} are ignored.  For the purposes of this trait, a
12106 class type is considered is own base.  Requires: if @code{__is_class
12107 (base_type)} and @code{__is_class (derived_type)} are true and
12108 @code{base_type} and @code{derived_type} are not the same type
12109 (disregarding cv-qualifiers), @code{derived_type} shall be a complete
12110 type.  Diagnostic is produced if this requirement is not met.
12111
12112 @item __is_class (type)
12113 If @code{type} is a cv class type, and not a union type
12114 ([basic.compound]) the the trait is true, else it is false.
12115
12116 @item __is_empty (type)
12117 If @code{__is_class (type)} is false then the trait is false.
12118 Otherwise @code{type} is considered empty if and only if: @code{type}
12119 has no non-static data members, or all non-static data members, if
12120 any, are bit-fields of lenght 0, and @code{type} has no virtual
12121 members, and @code{type} has no virtual base classes, and @code{type}
12122 has no base classes @code{base_type} for which 
12123 @code{__is_empty (base_type)} is false.  Requires: @code{type} shall
12124 be a complete type, an array type of unknown bound, or is a
12125 @code{void} type.
12126
12127 @item __is_enum (type)
12128 If @code{type} is a cv enumeration type ([basic.compound]) the the trait is 
12129 true, else it is false.
12130
12131 @item __is_pod (type)
12132 If @code{type} is a cv POD type ([basic.types]) then the trait is true,
12133 else it is false.  Requires: @code{type} shall be a complete type, 
12134 an array type of unknown bound, or is a @code{void} type.
12135
12136 @item __is_polymorphic (type)
12137 If @code{type} is a polymorphic class ([class.virtual]) then the trait
12138 is true, else it is false.  Requires: @code{type} shall be a complete
12139 type, an array type of unknown bound, or is a @code{void} type.
12140
12141 @item __is_union (type)
12142 If @code{type} is a cv union type ([basic.compound]) the the trait is 
12143 true, else it is false.
12144
12145 @end table
12146
12147 @node Java Exceptions
12148 @section Java Exceptions
12149
12150 The Java language uses a slightly different exception handling model
12151 from C++.  Normally, GNU C++ will automatically detect when you are
12152 writing C++ code that uses Java exceptions, and handle them
12153 appropriately.  However, if C++ code only needs to execute destructors
12154 when Java exceptions are thrown through it, GCC will guess incorrectly.
12155 Sample problematic code is:
12156
12157 @smallexample
12158   struct S @{ ~S(); @};
12159   extern void bar();    // @r{is written in Java, and may throw exceptions}
12160   void foo()
12161   @{
12162     S s;
12163     bar();
12164   @}
12165 @end smallexample
12166
12167 @noindent
12168 The usual effect of an incorrect guess is a link failure, complaining of
12169 a missing routine called @samp{__gxx_personality_v0}.
12170
12171 You can inform the compiler that Java exceptions are to be used in a
12172 translation unit, irrespective of what it might think, by writing
12173 @samp{@w{#pragma GCC java_exceptions}} at the head of the file.  This
12174 @samp{#pragma} must appear before any functions that throw or catch
12175 exceptions, or run destructors when exceptions are thrown through them.
12176
12177 You cannot mix Java and C++ exceptions in the same translation unit.  It
12178 is believed to be safe to throw a C++ exception from one file through
12179 another file compiled for the Java exception model, or vice versa, but
12180 there may be bugs in this area.
12181
12182 @node Deprecated Features
12183 @section Deprecated Features
12184
12185 In the past, the GNU C++ compiler was extended to experiment with new
12186 features, at a time when the C++ language was still evolving.  Now that
12187 the C++ standard is complete, some of those features are superseded by
12188 superior alternatives.  Using the old features might cause a warning in
12189 some cases that the feature will be dropped in the future.  In other
12190 cases, the feature might be gone already.
12191
12192 While the list below is not exhaustive, it documents some of the options
12193 that are now deprecated:
12194
12195 @table @code
12196 @item -fexternal-templates
12197 @itemx -falt-external-templates
12198 These are two of the many ways for G++ to implement template
12199 instantiation.  @xref{Template Instantiation}.  The C++ standard clearly
12200 defines how template definitions have to be organized across
12201 implementation units.  G++ has an implicit instantiation mechanism that
12202 should work just fine for standard-conforming code.
12203
12204 @item -fstrict-prototype
12205 @itemx -fno-strict-prototype
12206 Previously it was possible to use an empty prototype parameter list to
12207 indicate an unspecified number of parameters (like C), rather than no
12208 parameters, as C++ demands.  This feature has been removed, except where
12209 it is required for backwards compatibility @xref{Backwards Compatibility}.
12210 @end table
12211
12212 G++ allows a virtual function returning @samp{void *} to be overridden
12213 by one returning a different pointer type.  This extension to the
12214 covariant return type rules is now deprecated and will be removed from a
12215 future version.
12216
12217 The G++ minimum and maximum operators (@samp{<?} and @samp{>?}) and
12218 their compound forms (@samp{<?=}) and @samp{>?=}) have been deprecated
12219 and will be removed in a future version.  Code using these operators
12220 should be modified to use @code{std::min} and @code{std::max} instead.
12221
12222 The named return value extension has been deprecated, and is now
12223 removed from G++.
12224
12225 The use of initializer lists with new expressions has been deprecated,
12226 and is now removed from G++.
12227
12228 Floating and complex non-type template parameters have been deprecated,
12229 and are now removed from G++.
12230
12231 The implicit typename extension has been deprecated and is now
12232 removed from G++.
12233
12234 The use of default arguments in function pointers, function typedefs
12235 and other places where they are not permitted by the standard is
12236 deprecated and will be removed from a future version of G++.
12237
12238 G++ allows floating-point literals to appear in integral constant expressions,
12239 e.g. @samp{ enum E @{ e = int(2.2 * 3.7) @} }
12240 This extension is deprecated and will be removed from a future version.
12241
12242 G++ allows static data members of const floating-point type to be declared
12243 with an initializer in a class definition. The standard only allows
12244 initializers for static members of const integral types and const
12245 enumeration types so this extension has been deprecated and will be removed
12246 from a future version.
12247
12248 @node Backwards Compatibility
12249 @section Backwards Compatibility
12250 @cindex Backwards Compatibility
12251 @cindex ARM [Annotated C++ Reference Manual]
12252
12253 Now that there is a definitive ISO standard C++, G++ has a specification
12254 to adhere to.  The C++ language evolved over time, and features that
12255 used to be acceptable in previous drafts of the standard, such as the ARM
12256 [Annotated C++ Reference Manual], are no longer accepted.  In order to allow
12257 compilation of C++ written to such drafts, G++ contains some backwards
12258 compatibilities.  @emph{All such backwards compatibility features are
12259 liable to disappear in future versions of G++.} They should be considered
12260 deprecated @xref{Deprecated Features}.
12261
12262 @table @code
12263 @item For scope
12264 If a variable is declared at for scope, it used to remain in scope until
12265 the end of the scope which contained the for statement (rather than just
12266 within the for scope).  G++ retains this, but issues a warning, if such a
12267 variable is accessed outside the for scope.
12268
12269 @item Implicit C language
12270 Old C system header files did not contain an @code{extern "C" @{@dots{}@}}
12271 scope to set the language.  On such systems, all header files are
12272 implicitly scoped inside a C language scope.  Also, an empty prototype
12273 @code{()} will be treated as an unspecified number of arguments, rather
12274 than no arguments, as C++ demands.
12275 @end table