OSDN Git Service

gcc:
[pf3gnuchains/gcc-fork.git] / gcc / doc / extend.texi
1 @c Copyright (C) 1988,1989,1992,1993,1994,1996,1998,1999,2000,2001,2002,2003,2004
2 @c Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @node C Extensions
7 @chapter Extensions to the C Language Family
8 @cindex extensions, C language
9 @cindex C language extensions
10
11 @opindex pedantic
12 GNU C provides several language features not found in ISO standard C@.
13 (The @option{-pedantic} option directs GCC to print a warning message if
14 any of these features is used.)  To test for the availability of these
15 features in conditional compilation, check for a predefined macro
16 @code{__GNUC__}, which is always defined under GCC@.
17
18 These extensions are available in C and Objective-C@.  Most of them are
19 also available in C++.  @xref{C++ Extensions,,Extensions to the
20 C++ Language}, for extensions that apply @emph{only} to C++.
21
22 Some features that are in ISO C99 but not C89 or C++ are also, as
23 extensions, accepted by GCC in C89 mode and in C++.
24
25 @menu
26 * Statement Exprs::     Putting statements and declarations inside expressions.
27 * Local Labels::        Labels local to a block.
28 * Labels as Values::    Getting pointers to labels, and computed gotos.
29 * Nested Functions::    As in Algol and Pascal, lexical scoping of functions.
30 * Constructing Calls::  Dispatching a call to another function.
31 * Typeof::              @code{typeof}: referring to the type of an expression.
32 * Conditionals::        Omitting the middle operand of a @samp{?:} expression.
33 * Long Long::           Double-word integers---@code{long long int}.
34 * Complex::             Data types for complex numbers.
35 * Hex Floats::          Hexadecimal floating-point constants.
36 * Zero Length::         Zero-length arrays.
37 * Variable Length::     Arrays whose length is computed at run time.
38 * Empty Structures::    Structures with no members.
39 * Variadic Macros::     Macros with a variable number of arguments.
40 * Escaped Newlines::    Slightly looser rules for escaped newlines.
41 * Subscripting::        Any array can be subscripted, even if not an lvalue.
42 * Pointer Arith::       Arithmetic on @code{void}-pointers and function pointers.
43 * Initializers::        Non-constant initializers.
44 * Compound Literals::   Compound literals give structures, unions
45                          or arrays as values.
46 * Designated Inits::    Labeling elements of initializers.
47 * Cast to Union::       Casting to union type from any member of the union.
48 * Case Ranges::         `case 1 ... 9' and such.
49 * Mixed Declarations::  Mixing declarations and code.
50 * Function Attributes:: Declaring that functions have no side effects,
51                          or that they can never return.
52 * Attribute Syntax::    Formal syntax for attributes.
53 * Function Prototypes:: Prototype declarations and old-style definitions.
54 * C++ Comments::        C++ comments are recognized.
55 * Dollar Signs::        Dollar sign is allowed in identifiers.
56 * Character Escapes::   @samp{\e} stands for the character @key{ESC}.
57 * Variable Attributes:: Specifying attributes of variables.
58 * Type Attributes::     Specifying attributes of types.
59 * Alignment::           Inquiring about the alignment of a type or variable.
60 * Inline::              Defining inline functions (as fast as macros).
61 * Extended Asm::        Assembler instructions with C expressions as operands.
62                          (With them you can define ``built-in'' functions.)
63 * Constraints::         Constraints for asm operands
64 * Asm Labels::          Specifying the assembler name to use for a C symbol.
65 * Explicit Reg Vars::   Defining variables residing in specified registers.
66 * Alternate Keywords::  @code{__const__}, @code{__asm__}, etc., for header files.
67 * Incomplete Enums::    @code{enum foo;}, with details to follow.
68 * Function Names::      Printable strings which are the name of the current
69                          function.
70 * Return Address::      Getting the return or frame address of a function.
71 * Vector Extensions::   Using vector instructions through built-in functions.
72 * Offsetof::            Special syntax for implementing @code{offsetof}.
73 * Other Builtins::      Other built-in functions.
74 * Target Builtins::     Built-in functions specific to particular targets.
75 * Target Format Checks:: Format checks specific to particular targets.
76 * Pragmas::             Pragmas accepted by GCC.
77 * Unnamed Fields::      Unnamed struct/union fields within structs/unions.
78 * Thread-Local::        Per-thread variables.
79 @end menu
80
81 @node Statement Exprs
82 @section Statements and Declarations in Expressions
83 @cindex statements inside expressions
84 @cindex declarations inside expressions
85 @cindex expressions containing statements
86 @cindex macros, statements in expressions
87
88 @c the above section title wrapped and causes an underfull hbox.. i
89 @c changed it from "within" to "in". --mew 4feb93
90 A compound statement enclosed in parentheses may appear as an expression
91 in GNU C@.  This allows you to use loops, switches, and local variables
92 within an expression.
93
94 Recall that a compound statement is a sequence of statements surrounded
95 by braces; in this construct, parentheses go around the braces.  For
96 example:
97
98 @smallexample
99 (@{ int y = foo (); int z;
100    if (y > 0) z = y;
101    else z = - y;
102    z; @})
103 @end smallexample
104
105 @noindent
106 is a valid (though slightly more complex than necessary) expression
107 for the absolute value of @code{foo ()}.
108
109 The last thing in the compound statement should be an expression
110 followed by a semicolon; the value of this subexpression serves as the
111 value of the entire construct.  (If you use some other kind of statement
112 last within the braces, the construct has type @code{void}, and thus
113 effectively no value.)
114
115 This feature is especially useful in making macro definitions ``safe'' (so
116 that they evaluate each operand exactly once).  For example, the
117 ``maximum'' function is commonly defined as a macro in standard C as
118 follows:
119
120 @smallexample
121 #define max(a,b) ((a) > (b) ? (a) : (b))
122 @end smallexample
123
124 @noindent
125 @cindex side effects, macro argument
126 But this definition computes either @var{a} or @var{b} twice, with bad
127 results if the operand has side effects.  In GNU C, if you know the
128 type of the operands (here taken as @code{int}), you can define
129 the macro safely as follows:
130
131 @smallexample
132 #define maxint(a,b) \
133   (@{int _a = (a), _b = (b); _a > _b ? _a : _b; @})
134 @end smallexample
135
136 Embedded statements are not allowed in constant expressions, such as
137 the value of an enumeration constant, the width of a bit-field, or
138 the initial value of a static variable.
139
140 If you don't know the type of the operand, you can still do this, but you
141 must use @code{typeof} (@pxref{Typeof}).
142
143 In G++, the result value of a statement expression undergoes array and
144 function pointer decay, and is returned by value to the enclosing
145 expression. For instance, if @code{A} is a class, then
146
147 @smallexample
148         A a;
149
150         (@{a;@}).Foo ()
151 @end smallexample
152
153 @noindent
154 will construct a temporary @code{A} object to hold the result of the
155 statement expression, and that will be used to invoke @code{Foo}.
156 Therefore the @code{this} pointer observed by @code{Foo} will not be the
157 address of @code{a}.
158
159 Any temporaries created within a statement within a statement expression
160 will be destroyed at the statement's end.  This makes statement
161 expressions inside macros slightly different from function calls.  In
162 the latter case temporaries introduced during argument evaluation will
163 be destroyed at the end of the statement that includes the function
164 call.  In the statement expression case they will be destroyed during
165 the statement expression.  For instance,
166
167 @smallexample
168 #define macro(a)  (@{__typeof__(a) b = (a); b + 3; @})
169 template<typename T> T function(T a) @{ T b = a; return b + 3; @}
170
171 void foo ()
172 @{
173   macro (X ());
174   function (X ());
175 @}
176 @end smallexample
177
178 @noindent
179 will have different places where temporaries are destroyed.  For the
180 @code{macro} case, the temporary @code{X} will be destroyed just after
181 the initialization of @code{b}.  In the @code{function} case that
182 temporary will be destroyed when the function returns.
183
184 These considerations mean that it is probably a bad idea to use
185 statement-expressions of this form in header files that are designed to
186 work with C++.  (Note that some versions of the GNU C Library contained
187 header files using statement-expression that lead to precisely this
188 bug.)
189
190 @node Local Labels
191 @section Locally Declared Labels
192 @cindex local labels
193 @cindex macros, local labels
194
195 GCC allows you to declare @dfn{local labels} in any nested block
196 scope. A local label is just like an ordinary label, but you can
197 only reference it (with a @code{goto} statement, or by taking its
198 address) within the block in which it was declared.
199
200 A local label declaration looks like this:
201
202 @smallexample
203 __label__ @var{label};
204 @end smallexample
205
206 @noindent
207 or
208
209 @smallexample
210 __label__ @var{label1}, @var{label2}, /* @r{@dots{}} */;
211 @end smallexample
212
213 Local label declarations must come at the beginning of the block,
214 before any ordinary declarations or statements.
215
216 The label declaration defines the label @emph{name}, but does not define
217 the label itself.  You must do this in the usual way, with
218 @code{@var{label}:}, within the statements of the statement expression.
219
220 The local label feature is useful for complex macros.  If a macro
221 contains nested loops, a @code{goto} can be useful for breaking out of
222 them.  However, an ordinary label whose scope is the whole function
223 cannot be used: if the macro can be expanded several times in one
224 function, the label will be multiply defined in that function.  A
225 local label avoids this problem.  For example:
226
227 @smallexample
228 #define SEARCH(value, array, target)              \
229 do @{                                              \
230   __label__ found;                                \
231   typeof (target) _SEARCH_target = (target);      \
232   typeof (*(array)) *_SEARCH_array = (array);     \
233   int i, j;                                       \
234   int value;                                      \
235   for (i = 0; i < max; i++)                       \
236     for (j = 0; j < max; j++)                     \
237       if (_SEARCH_array[i][j] == _SEARCH_target)  \
238         @{ (value) = i; goto found; @}              \
239   (value) = -1;                                   \
240  found:;                                          \
241 @} while (0)
242 @end smallexample
243
244 This could also be written using a statement-expression:
245
246 @smallexample
247 #define SEARCH(array, target)                     \
248 (@{                                                \
249   __label__ found;                                \
250   typeof (target) _SEARCH_target = (target);      \
251   typeof (*(array)) *_SEARCH_array = (array);     \
252   int i, j;                                       \
253   int value;                                      \
254   for (i = 0; i < max; i++)                       \
255     for (j = 0; j < max; j++)                     \
256       if (_SEARCH_array[i][j] == _SEARCH_target)  \
257         @{ value = i; goto found; @}                \
258   value = -1;                                     \
259  found:                                           \
260   value;                                          \
261 @})
262 @end smallexample
263
264 Local label declarations also make the labels they declare visible to
265 nested functions, if there are any.  @xref{Nested Functions}, for details.
266
267 @node Labels as Values
268 @section Labels as Values
269 @cindex labels as values
270 @cindex computed gotos
271 @cindex goto with computed label
272 @cindex address of a label
273
274 You can get the address of a label defined in the current function
275 (or a containing function) with the unary operator @samp{&&}.  The
276 value has type @code{void *}.  This value is a constant and can be used
277 wherever a constant of that type is valid.  For example:
278
279 @smallexample
280 void *ptr;
281 /* @r{@dots{}} */
282 ptr = &&foo;
283 @end smallexample
284
285 To use these values, you need to be able to jump to one.  This is done
286 with the computed goto statement@footnote{The analogous feature in
287 Fortran is called an assigned goto, but that name seems inappropriate in
288 C, where one can do more than simply store label addresses in label
289 variables.}, @code{goto *@var{exp};}.  For example,
290
291 @smallexample
292 goto *ptr;
293 @end smallexample
294
295 @noindent
296 Any expression of type @code{void *} is allowed.
297
298 One way of using these constants is in initializing a static array that
299 will serve as a jump table:
300
301 @smallexample
302 static void *array[] = @{ &&foo, &&bar, &&hack @};
303 @end smallexample
304
305 Then you can select a label with indexing, like this:
306
307 @smallexample
308 goto *array[i];
309 @end smallexample
310
311 @noindent
312 Note that this does not check whether the subscript is in bounds---array
313 indexing in C never does that.
314
315 Such an array of label values serves a purpose much like that of the
316 @code{switch} statement.  The @code{switch} statement is cleaner, so
317 use that rather than an array unless the problem does not fit a
318 @code{switch} statement very well.
319
320 Another use of label values is in an interpreter for threaded code.
321 The labels within the interpreter function can be stored in the
322 threaded code for super-fast dispatching.
323
324 You may not use this mechanism to jump to code in a different function.
325 If you do that, totally unpredictable things will happen.  The best way to
326 avoid this is to store the label address only in automatic variables and
327 never pass it as an argument.
328
329 An alternate way to write the above example is
330
331 @smallexample
332 static const int array[] = @{ &&foo - &&foo, &&bar - &&foo,
333                              &&hack - &&foo @};
334 goto *(&&foo + array[i]);
335 @end smallexample
336
337 @noindent
338 This is more friendly to code living in shared libraries, as it reduces
339 the number of dynamic relocations that are needed, and by consequence,
340 allows the data to be read-only.
341
342 @node Nested Functions
343 @section Nested Functions
344 @cindex nested functions
345 @cindex downward funargs
346 @cindex thunks
347
348 A @dfn{nested function} is a function defined inside another function.
349 (Nested functions are not supported for GNU C++.)  The nested function's
350 name is local to the block where it is defined.  For example, here we
351 define a nested function named @code{square}, and call it twice:
352
353 @smallexample
354 @group
355 foo (double a, double b)
356 @{
357   double square (double z) @{ return z * z; @}
358
359   return square (a) + square (b);
360 @}
361 @end group
362 @end smallexample
363
364 The nested function can access all the variables of the containing
365 function that are visible at the point of its definition.  This is
366 called @dfn{lexical scoping}.  For example, here we show a nested
367 function which uses an inherited variable named @code{offset}:
368
369 @smallexample
370 @group
371 bar (int *array, int offset, int size)
372 @{
373   int access (int *array, int index)
374     @{ return array[index + offset]; @}
375   int i;
376   /* @r{@dots{}} */
377   for (i = 0; i < size; i++)
378     /* @r{@dots{}} */ access (array, i) /* @r{@dots{}} */
379 @}
380 @end group
381 @end smallexample
382
383 Nested function definitions are permitted within functions in the places
384 where variable definitions are allowed; that is, in any block, before
385 the first statement in the block.
386
387 It is possible to call the nested function from outside the scope of its
388 name by storing its address or passing the address to another function:
389
390 @smallexample
391 hack (int *array, int size)
392 @{
393   void store (int index, int value)
394     @{ array[index] = value; @}
395
396   intermediate (store, size);
397 @}
398 @end smallexample
399
400 Here, the function @code{intermediate} receives the address of
401 @code{store} as an argument.  If @code{intermediate} calls @code{store},
402 the arguments given to @code{store} are used to store into @code{array}.
403 But this technique works only so long as the containing function
404 (@code{hack}, in this example) does not exit.
405
406 If you try to call the nested function through its address after the
407 containing function has exited, all hell will break loose.  If you try
408 to call it after a containing scope level has exited, and if it refers
409 to some of the variables that are no longer in scope, you may be lucky,
410 but it's not wise to take the risk.  If, however, the nested function
411 does not refer to anything that has gone out of scope, you should be
412 safe.
413
414 GCC implements taking the address of a nested function using a technique
415 called @dfn{trampolines}.  A paper describing them is available as
416
417 @noindent
418 @uref{http://people.debian.org/~aaronl/Usenix88-lexic.pdf}.
419
420 A nested function can jump to a label inherited from a containing
421 function, provided the label was explicitly declared in the containing
422 function (@pxref{Local Labels}).  Such a jump returns instantly to the
423 containing function, exiting the nested function which did the
424 @code{goto} and any intermediate functions as well.  Here is an example:
425
426 @smallexample
427 @group
428 bar (int *array, int offset, int size)
429 @{
430   __label__ failure;
431   int access (int *array, int index)
432     @{
433       if (index > size)
434         goto failure;
435       return array[index + offset];
436     @}
437   int i;
438   /* @r{@dots{}} */
439   for (i = 0; i < size; i++)
440     /* @r{@dots{}} */ access (array, i) /* @r{@dots{}} */
441   /* @r{@dots{}} */
442   return 0;
443
444  /* @r{Control comes here from @code{access}
445     if it detects an error.}  */
446  failure:
447   return -1;
448 @}
449 @end group
450 @end smallexample
451
452 A nested function always has internal linkage.  Declaring one with
453 @code{extern} is erroneous.  If you need to declare the nested function
454 before its definition, use @code{auto} (which is otherwise meaningless
455 for function declarations).
456
457 @smallexample
458 bar (int *array, int offset, int size)
459 @{
460   __label__ failure;
461   auto int access (int *, int);
462   /* @r{@dots{}} */
463   int access (int *array, int index)
464     @{
465       if (index > size)
466         goto failure;
467       return array[index + offset];
468     @}
469   /* @r{@dots{}} */
470 @}
471 @end smallexample
472
473 @node Constructing Calls
474 @section Constructing Function Calls
475 @cindex constructing calls
476 @cindex forwarding calls
477
478 Using the built-in functions described below, you can record
479 the arguments a function received, and call another function
480 with the same arguments, without knowing the number or types
481 of the arguments.
482
483 You can also record the return value of that function call,
484 and later return that value, without knowing what data type
485 the function tried to return (as long as your caller expects
486 that data type).
487
488 However, these built-in functions may interact badly with some
489 sophisticated features or other extensions of the language.  It
490 is, therefore, not recommended to use them outside very simple
491 functions acting as mere forwarders for their arguments.
492
493 @deftypefn {Built-in Function} {void *} __builtin_apply_args ()
494 This built-in function returns a pointer to data
495 describing how to perform a call with the same arguments as were passed
496 to the current function.
497
498 The function saves the arg pointer register, structure value address,
499 and all registers that might be used to pass arguments to a function
500 into a block of memory allocated on the stack.  Then it returns the
501 address of that block.
502 @end deftypefn
503
504 @deftypefn {Built-in Function} {void *} __builtin_apply (void (*@var{function})(), void *@var{arguments}, size_t @var{size})
505 This built-in function invokes @var{function}
506 with a copy of the parameters described by @var{arguments}
507 and @var{size}.
508
509 The value of @var{arguments} should be the value returned by
510 @code{__builtin_apply_args}.  The argument @var{size} specifies the size
511 of the stack argument data, in bytes.
512
513 This function returns a pointer to data describing
514 how to return whatever value was returned by @var{function}.  The data
515 is saved in a block of memory allocated on the stack.
516
517 It is not always simple to compute the proper value for @var{size}.  The
518 value is used by @code{__builtin_apply} to compute the amount of data
519 that should be pushed on the stack and copied from the incoming argument
520 area.
521 @end deftypefn
522
523 @deftypefn {Built-in Function} {void} __builtin_return (void *@var{result})
524 This built-in function returns the value described by @var{result} from
525 the containing function.  You should specify, for @var{result}, a value
526 returned by @code{__builtin_apply}.
527 @end deftypefn
528
529 @node Typeof
530 @section Referring to a Type with @code{typeof}
531 @findex typeof
532 @findex sizeof
533 @cindex macros, types of arguments
534
535 Another way to refer to the type of an expression is with @code{typeof}.
536 The syntax of using of this keyword looks like @code{sizeof}, but the
537 construct acts semantically like a type name defined with @code{typedef}.
538
539 There are two ways of writing the argument to @code{typeof}: with an
540 expression or with a type.  Here is an example with an expression:
541
542 @smallexample
543 typeof (x[0](1))
544 @end smallexample
545
546 @noindent
547 This assumes that @code{x} is an array of pointers to functions;
548 the type described is that of the values of the functions.
549
550 Here is an example with a typename as the argument:
551
552 @smallexample
553 typeof (int *)
554 @end smallexample
555
556 @noindent
557 Here the type described is that of pointers to @code{int}.
558
559 If you are writing a header file that must work when included in ISO C
560 programs, write @code{__typeof__} instead of @code{typeof}.
561 @xref{Alternate Keywords}.
562
563 A @code{typeof}-construct can be used anywhere a typedef name could be
564 used.  For example, you can use it in a declaration, in a cast, or inside
565 of @code{sizeof} or @code{typeof}.
566
567 @code{typeof} is often useful in conjunction with the
568 statements-within-expressions feature.  Here is how the two together can
569 be used to define a safe ``maximum'' macro that operates on any
570 arithmetic type and evaluates each of its arguments exactly once:
571
572 @smallexample
573 #define max(a,b) \
574   (@{ typeof (a) _a = (a); \
575       typeof (b) _b = (b); \
576     _a > _b ? _a : _b; @})
577 @end smallexample
578
579 @cindex underscores in variables in macros
580 @cindex @samp{_} in variables in macros
581 @cindex local variables in macros
582 @cindex variables, local, in macros
583 @cindex macros, local variables in
584
585 The reason for using names that start with underscores for the local
586 variables is to avoid conflicts with variable names that occur within the
587 expressions that are substituted for @code{a} and @code{b}.  Eventually we
588 hope to design a new form of declaration syntax that allows you to declare
589 variables whose scopes start only after their initializers; this will be a
590 more reliable way to prevent such conflicts.
591
592 @noindent
593 Some more examples of the use of @code{typeof}:
594
595 @itemize @bullet
596 @item
597 This declares @code{y} with the type of what @code{x} points to.
598
599 @smallexample
600 typeof (*x) y;
601 @end smallexample
602
603 @item
604 This declares @code{y} as an array of such values.
605
606 @smallexample
607 typeof (*x) y[4];
608 @end smallexample
609
610 @item
611 This declares @code{y} as an array of pointers to characters:
612
613 @smallexample
614 typeof (typeof (char *)[4]) y;
615 @end smallexample
616
617 @noindent
618 It is equivalent to the following traditional C declaration:
619
620 @smallexample
621 char *y[4];
622 @end smallexample
623
624 To see the meaning of the declaration using @code{typeof}, and why it
625 might be a useful way to write, rewrite it with these macros:
626
627 @smallexample
628 #define pointer(T)  typeof(T *)
629 #define array(T, N) typeof(T [N])
630 @end smallexample
631
632 @noindent
633 Now the declaration can be rewritten this way:
634
635 @smallexample
636 array (pointer (char), 4) y;
637 @end smallexample
638
639 @noindent
640 Thus, @code{array (pointer (char), 4)} is the type of arrays of 4
641 pointers to @code{char}.
642 @end itemize
643
644 @emph{Compatibility Note:} In addition to @code{typeof}, GCC 2 supported
645 a more limited extension which permitted one to write
646
647 @smallexample
648 typedef @var{T} = @var{expr};
649 @end smallexample
650
651 @noindent
652 with the effect of declaring @var{T} to have the type of the expression
653 @var{expr}.  This extension does not work with GCC 3 (versions between
654 3.0 and 3.2 will crash; 3.2.1 and later give an error).  Code which
655 relies on it should be rewritten to use @code{typeof}:
656
657 @smallexample
658 typedef typeof(@var{expr}) @var{T};
659 @end smallexample
660
661 @noindent
662 This will work with all versions of GCC@.
663
664 @node Conditionals
665 @section Conditionals with Omitted Operands
666 @cindex conditional expressions, extensions
667 @cindex omitted middle-operands
668 @cindex middle-operands, omitted
669 @cindex extensions, @code{?:}
670 @cindex @code{?:} extensions
671
672 The middle operand in a conditional expression may be omitted.  Then
673 if the first operand is nonzero, its value is the value of the conditional
674 expression.
675
676 Therefore, the expression
677
678 @smallexample
679 x ? : y
680 @end smallexample
681
682 @noindent
683 has the value of @code{x} if that is nonzero; otherwise, the value of
684 @code{y}.
685
686 This example is perfectly equivalent to
687
688 @smallexample
689 x ? x : y
690 @end smallexample
691
692 @cindex side effect in ?:
693 @cindex ?: side effect
694 @noindent
695 In this simple case, the ability to omit the middle operand is not
696 especially useful.  When it becomes useful is when the first operand does,
697 or may (if it is a macro argument), contain a side effect.  Then repeating
698 the operand in the middle would perform the side effect twice.  Omitting
699 the middle operand uses the value already computed without the undesirable
700 effects of recomputing it.
701
702 @node Long Long
703 @section Double-Word Integers
704 @cindex @code{long long} data types
705 @cindex double-word arithmetic
706 @cindex multiprecision arithmetic
707 @cindex @code{LL} integer suffix
708 @cindex @code{ULL} integer suffix
709
710 ISO C99 supports data types for integers that are at least 64 bits wide,
711 and as an extension GCC supports them in C89 mode and in C++.
712 Simply write @code{long long int} for a signed integer, or
713 @code{unsigned long long int} for an unsigned integer.  To make an
714 integer constant of type @code{long long int}, add the suffix @samp{LL}
715 to the integer.  To make an integer constant of type @code{unsigned long
716 long int}, add the suffix @samp{ULL} to the integer.
717
718 You can use these types in arithmetic like any other integer types.
719 Addition, subtraction, and bitwise boolean operations on these types
720 are open-coded on all types of machines.  Multiplication is open-coded
721 if the machine supports fullword-to-doubleword a widening multiply
722 instruction.  Division and shifts are open-coded only on machines that
723 provide special support.  The operations that are not open-coded use
724 special library routines that come with GCC@.
725
726 There may be pitfalls when you use @code{long long} types for function
727 arguments, unless you declare function prototypes.  If a function
728 expects type @code{int} for its argument, and you pass a value of type
729 @code{long long int}, confusion will result because the caller and the
730 subroutine will disagree about the number of bytes for the argument.
731 Likewise, if the function expects @code{long long int} and you pass
732 @code{int}.  The best way to avoid such problems is to use prototypes.
733
734 @node Complex
735 @section Complex Numbers
736 @cindex complex numbers
737 @cindex @code{_Complex} keyword
738 @cindex @code{__complex__} keyword
739
740 ISO C99 supports complex floating data types, and as an extension GCC
741 supports them in C89 mode and in C++, and supports complex integer data
742 types which are not part of ISO C99.  You can declare complex types
743 using the keyword @code{_Complex}.  As an extension, the older GNU
744 keyword @code{__complex__} is also supported.
745
746 For example, @samp{_Complex double x;} declares @code{x} as a
747 variable whose real part and imaginary part are both of type
748 @code{double}.  @samp{_Complex short int y;} declares @code{y} to
749 have real and imaginary parts of type @code{short int}; this is not
750 likely to be useful, but it shows that the set of complex types is
751 complete.
752
753 To write a constant with a complex data type, use the suffix @samp{i} or
754 @samp{j} (either one; they are equivalent).  For example, @code{2.5fi}
755 has type @code{_Complex float} and @code{3i} has type
756 @code{_Complex int}.  Such a constant always has a pure imaginary
757 value, but you can form any complex value you like by adding one to a
758 real constant.  This is a GNU extension; if you have an ISO C99
759 conforming C library (such as GNU libc), and want to construct complex
760 constants of floating type, you should include @code{<complex.h>} and
761 use the macros @code{I} or @code{_Complex_I} instead.
762
763 @cindex @code{__real__} keyword
764 @cindex @code{__imag__} keyword
765 To extract the real part of a complex-valued expression @var{exp}, write
766 @code{__real__ @var{exp}}.  Likewise, use @code{__imag__} to
767 extract the imaginary part.  This is a GNU extension; for values of
768 floating type, you should use the ISO C99 functions @code{crealf},
769 @code{creal}, @code{creall}, @code{cimagf}, @code{cimag} and
770 @code{cimagl}, declared in @code{<complex.h>} and also provided as
771 built-in functions by GCC@.
772
773 @cindex complex conjugation
774 The operator @samp{~} performs complex conjugation when used on a value
775 with a complex type.  This is a GNU extension; for values of
776 floating type, you should use the ISO C99 functions @code{conjf},
777 @code{conj} and @code{conjl}, declared in @code{<complex.h>} and also
778 provided as built-in functions by GCC@.
779
780 GCC can allocate complex automatic variables in a noncontiguous
781 fashion; it's even possible for the real part to be in a register while
782 the imaginary part is on the stack (or vice-versa).  Only the DWARF2
783 debug info format can represent this, so use of DWARF2 is recommended.
784 If you are using the stabs debug info format, GCC describes a noncontiguous
785 complex variable as if it were two separate variables of noncomplex type.
786 If the variable's actual name is @code{foo}, the two fictitious
787 variables are named @code{foo$real} and @code{foo$imag}.  You can
788 examine and set these two fictitious variables with your debugger.
789
790 @node Hex Floats
791 @section Hex Floats
792 @cindex hex floats
793
794 ISO C99 supports floating-point numbers written not only in the usual
795 decimal notation, such as @code{1.55e1}, but also numbers such as
796 @code{0x1.fp3} written in hexadecimal format.  As a GNU extension, GCC
797 supports this in C89 mode (except in some cases when strictly
798 conforming) and in C++.  In that format the
799 @samp{0x} hex introducer and the @samp{p} or @samp{P} exponent field are
800 mandatory.  The exponent is a decimal number that indicates the power of
801 2 by which the significant part will be multiplied.  Thus @samp{0x1.f} is
802 @tex
803 $1 {15\over16}$,
804 @end tex
805 @ifnottex
806 1 15/16,
807 @end ifnottex
808 @samp{p3} multiplies it by 8, and the value of @code{0x1.fp3}
809 is the same as @code{1.55e1}.
810
811 Unlike for floating-point numbers in the decimal notation the exponent
812 is always required in the hexadecimal notation.  Otherwise the compiler
813 would not be able to resolve the ambiguity of, e.g., @code{0x1.f}.  This
814 could mean @code{1.0f} or @code{1.9375} since @samp{f} is also the
815 extension for floating-point constants of type @code{float}.
816
817 @node Zero Length
818 @section Arrays of Length Zero
819 @cindex arrays of length zero
820 @cindex zero-length arrays
821 @cindex length-zero arrays
822 @cindex flexible array members
823
824 Zero-length arrays are allowed in GNU C@.  They are very useful as the
825 last element of a structure which is really a header for a variable-length
826 object:
827
828 @smallexample
829 struct line @{
830   int length;
831   char contents[0];
832 @};
833
834 struct line *thisline = (struct line *)
835   malloc (sizeof (struct line) + this_length);
836 thisline->length = this_length;
837 @end smallexample
838
839 In ISO C90, you would have to give @code{contents} a length of 1, which
840 means either you waste space or complicate the argument to @code{malloc}.
841
842 In ISO C99, you would use a @dfn{flexible array member}, which is
843 slightly different in syntax and semantics:
844
845 @itemize @bullet
846 @item
847 Flexible array members are written as @code{contents[]} without
848 the @code{0}.
849
850 @item
851 Flexible array members have incomplete type, and so the @code{sizeof}
852 operator may not be applied.  As a quirk of the original implementation
853 of zero-length arrays, @code{sizeof} evaluates to zero.
854
855 @item
856 Flexible array members may only appear as the last member of a
857 @code{struct} that is otherwise non-empty.
858
859 @item
860 A structure containing a flexible array member, or a union containing
861 such a structure (possibly recursively), may not be a member of a
862 structure or an element of an array.  (However, these uses are
863 permitted by GCC as extensions.)
864 @end itemize
865
866 GCC versions before 3.0 allowed zero-length arrays to be statically
867 initialized, as if they were flexible arrays.  In addition to those
868 cases that were useful, it also allowed initializations in situations
869 that would corrupt later data.  Non-empty initialization of zero-length
870 arrays is now treated like any case where there are more initializer
871 elements than the array holds, in that a suitable warning about "excess
872 elements in array" is given, and the excess elements (all of them, in
873 this case) are ignored.
874
875 Instead GCC allows static initialization of flexible array members.
876 This is equivalent to defining a new structure containing the original
877 structure followed by an array of sufficient size to contain the data.
878 I.e.@: in the following, @code{f1} is constructed as if it were declared
879 like @code{f2}.
880
881 @smallexample
882 struct f1 @{
883   int x; int y[];
884 @} f1 = @{ 1, @{ 2, 3, 4 @} @};
885
886 struct f2 @{
887   struct f1 f1; int data[3];
888 @} f2 = @{ @{ 1 @}, @{ 2, 3, 4 @} @};
889 @end smallexample
890
891 @noindent
892 The convenience of this extension is that @code{f1} has the desired
893 type, eliminating the need to consistently refer to @code{f2.f1}.
894
895 This has symmetry with normal static arrays, in that an array of
896 unknown size is also written with @code{[]}.
897
898 Of course, this extension only makes sense if the extra data comes at
899 the end of a top-level object, as otherwise we would be overwriting
900 data at subsequent offsets.  To avoid undue complication and confusion
901 with initialization of deeply nested arrays, we simply disallow any
902 non-empty initialization except when the structure is the top-level
903 object.  For example:
904
905 @smallexample
906 struct foo @{ int x; int y[]; @};
907 struct bar @{ struct foo z; @};
908
909 struct foo a = @{ 1, @{ 2, 3, 4 @} @};        // @r{Valid.}
910 struct bar b = @{ @{ 1, @{ 2, 3, 4 @} @} @};    // @r{Invalid.}
911 struct bar c = @{ @{ 1, @{ @} @} @};            // @r{Valid.}
912 struct foo d[1] = @{ @{ 1 @{ 2, 3, 4 @} @} @};  // @r{Invalid.}
913 @end smallexample
914
915 @node Empty Structures
916 @section Structures With No Members
917 @cindex empty structures
918 @cindex zero-size structures
919
920 GCC permits a C structure to have no members:
921
922 @smallexample
923 struct empty @{
924 @};
925 @end smallexample
926
927 The structure will have size zero.  In C++, empty structures are part
928 of the language.  G++ treats empty structures as if they had a single
929 member of type @code{char}.
930
931 @node Variable Length
932 @section Arrays of Variable Length
933 @cindex variable-length arrays
934 @cindex arrays of variable length
935 @cindex VLAs
936
937 Variable-length automatic arrays are allowed in ISO C99, and as an
938 extension GCC accepts them in C89 mode and in C++.  (However, GCC's
939 implementation of variable-length arrays does not yet conform in detail
940 to the ISO C99 standard.)  These arrays are
941 declared like any other automatic arrays, but with a length that is not
942 a constant expression.  The storage is allocated at the point of
943 declaration and deallocated when the brace-level is exited.  For
944 example:
945
946 @smallexample
947 FILE *
948 concat_fopen (char *s1, char *s2, char *mode)
949 @{
950   char str[strlen (s1) + strlen (s2) + 1];
951   strcpy (str, s1);
952   strcat (str, s2);
953   return fopen (str, mode);
954 @}
955 @end smallexample
956
957 @cindex scope of a variable length array
958 @cindex variable-length array scope
959 @cindex deallocating variable length arrays
960 Jumping or breaking out of the scope of the array name deallocates the
961 storage.  Jumping into the scope is not allowed; you get an error
962 message for it.
963
964 @cindex @code{alloca} vs variable-length arrays
965 You can use the function @code{alloca} to get an effect much like
966 variable-length arrays.  The function @code{alloca} is available in
967 many other C implementations (but not in all).  On the other hand,
968 variable-length arrays are more elegant.
969
970 There are other differences between these two methods.  Space allocated
971 with @code{alloca} exists until the containing @emph{function} returns.
972 The space for a variable-length array is deallocated as soon as the array
973 name's scope ends.  (If you use both variable-length arrays and
974 @code{alloca} in the same function, deallocation of a variable-length array
975 will also deallocate anything more recently allocated with @code{alloca}.)
976
977 You can also use variable-length arrays as arguments to functions:
978
979 @smallexample
980 struct entry
981 tester (int len, char data[len][len])
982 @{
983   /* @r{@dots{}} */
984 @}
985 @end smallexample
986
987 The length of an array is computed once when the storage is allocated
988 and is remembered for the scope of the array in case you access it with
989 @code{sizeof}.
990
991 If you want to pass the array first and the length afterward, you can
992 use a forward declaration in the parameter list---another GNU extension.
993
994 @smallexample
995 struct entry
996 tester (int len; char data[len][len], int len)
997 @{
998   /* @r{@dots{}} */
999 @}
1000 @end smallexample
1001
1002 @cindex parameter forward declaration
1003 The @samp{int len} before the semicolon is a @dfn{parameter forward
1004 declaration}, and it serves the purpose of making the name @code{len}
1005 known when the declaration of @code{data} is parsed.
1006
1007 You can write any number of such parameter forward declarations in the
1008 parameter list.  They can be separated by commas or semicolons, but the
1009 last one must end with a semicolon, which is followed by the ``real''
1010 parameter declarations.  Each forward declaration must match a ``real''
1011 declaration in parameter name and data type.  ISO C99 does not support
1012 parameter forward declarations.
1013
1014 @node Variadic Macros
1015 @section Macros with a Variable Number of Arguments.
1016 @cindex variable number of arguments
1017 @cindex macro with variable arguments
1018 @cindex rest argument (in macro)
1019 @cindex variadic macros
1020
1021 In the ISO C standard of 1999, a macro can be declared to accept a
1022 variable number of arguments much as a function can.  The syntax for
1023 defining the macro is similar to that of a function.  Here is an
1024 example:
1025
1026 @smallexample
1027 #define debug(format, ...) fprintf (stderr, format, __VA_ARGS__)
1028 @end smallexample
1029
1030 Here @samp{@dots{}} is a @dfn{variable argument}.  In the invocation of
1031 such a macro, it represents the zero or more tokens until the closing
1032 parenthesis that ends the invocation, including any commas.  This set of
1033 tokens replaces the identifier @code{__VA_ARGS__} in the macro body
1034 wherever it appears.  See the CPP manual for more information.
1035
1036 GCC has long supported variadic macros, and used a different syntax that
1037 allowed you to give a name to the variable arguments just like any other
1038 argument.  Here is an example:
1039
1040 @smallexample
1041 #define debug(format, args...) fprintf (stderr, format, args)
1042 @end smallexample
1043
1044 This is in all ways equivalent to the ISO C example above, but arguably
1045 more readable and descriptive.
1046
1047 GNU CPP has two further variadic macro extensions, and permits them to
1048 be used with either of the above forms of macro definition.
1049
1050 In standard C, you are not allowed to leave the variable argument out
1051 entirely; but you are allowed to pass an empty argument.  For example,
1052 this invocation is invalid in ISO C, because there is no comma after
1053 the string:
1054
1055 @smallexample
1056 debug ("A message")
1057 @end smallexample
1058
1059 GNU CPP permits you to completely omit the variable arguments in this
1060 way.  In the above examples, the compiler would complain, though since
1061 the expansion of the macro still has the extra comma after the format
1062 string.
1063
1064 To help solve this problem, CPP behaves specially for variable arguments
1065 used with the token paste operator, @samp{##}.  If instead you write
1066
1067 @smallexample
1068 #define debug(format, ...) fprintf (stderr, format, ## __VA_ARGS__)
1069 @end smallexample
1070
1071 and if the variable arguments are omitted or empty, the @samp{##}
1072 operator causes the preprocessor to remove the comma before it.  If you
1073 do provide some variable arguments in your macro invocation, GNU CPP
1074 does not complain about the paste operation and instead places the
1075 variable arguments after the comma.  Just like any other pasted macro
1076 argument, these arguments are not macro expanded.
1077
1078 @node Escaped Newlines
1079 @section Slightly Looser Rules for Escaped Newlines
1080 @cindex escaped newlines
1081 @cindex newlines (escaped)
1082
1083 Recently, the preprocessor has relaxed its treatment of escaped
1084 newlines.  Previously, the newline had to immediately follow a
1085 backslash.  The current implementation allows whitespace in the form
1086 of spaces, horizontal and vertical tabs, and form feeds between the
1087 backslash and the subsequent newline.  The preprocessor issues a
1088 warning, but treats it as a valid escaped newline and combines the two
1089 lines to form a single logical line.  This works within comments and
1090 tokens, as well as between tokens.  Comments are @emph{not} treated as
1091 whitespace for the purposes of this relaxation, since they have not
1092 yet been replaced with spaces.
1093
1094 @node Subscripting
1095 @section Non-Lvalue Arrays May Have Subscripts
1096 @cindex subscripting
1097 @cindex arrays, non-lvalue
1098
1099 @cindex subscripting and function values
1100 In ISO C99, arrays that are not lvalues still decay to pointers, and
1101 may be subscripted, although they may not be modified or used after
1102 the next sequence point and the unary @samp{&} operator may not be
1103 applied to them.  As an extension, GCC allows such arrays to be
1104 subscripted in C89 mode, though otherwise they do not decay to
1105 pointers outside C99 mode.  For example,
1106 this is valid in GNU C though not valid in C89:
1107
1108 @smallexample
1109 @group
1110 struct foo @{int a[4];@};
1111
1112 struct foo f();
1113
1114 bar (int index)
1115 @{
1116   return f().a[index];
1117 @}
1118 @end group
1119 @end smallexample
1120
1121 @node Pointer Arith
1122 @section Arithmetic on @code{void}- and Function-Pointers
1123 @cindex void pointers, arithmetic
1124 @cindex void, size of pointer to
1125 @cindex function pointers, arithmetic
1126 @cindex function, size of pointer to
1127
1128 In GNU C, addition and subtraction operations are supported on pointers to
1129 @code{void} and on pointers to functions.  This is done by treating the
1130 size of a @code{void} or of a function as 1.
1131
1132 A consequence of this is that @code{sizeof} is also allowed on @code{void}
1133 and on function types, and returns 1.
1134
1135 @opindex Wpointer-arith
1136 The option @option{-Wpointer-arith} requests a warning if these extensions
1137 are used.
1138
1139 @node Initializers
1140 @section Non-Constant Initializers
1141 @cindex initializers, non-constant
1142 @cindex non-constant initializers
1143
1144 As in standard C++ and ISO C99, the elements of an aggregate initializer for an
1145 automatic variable are not required to be constant expressions in GNU C@.
1146 Here is an example of an initializer with run-time varying elements:
1147
1148 @smallexample
1149 foo (float f, float g)
1150 @{
1151   float beat_freqs[2] = @{ f-g, f+g @};
1152   /* @r{@dots{}} */
1153 @}
1154 @end smallexample
1155
1156 @node Compound Literals
1157 @section Compound Literals
1158 @cindex constructor expressions
1159 @cindex initializations in expressions
1160 @cindex structures, constructor expression
1161 @cindex expressions, constructor
1162 @cindex compound literals
1163 @c The GNU C name for what C99 calls compound literals was "constructor expressions".
1164
1165 ISO C99 supports compound literals.  A compound literal looks like
1166 a cast containing an initializer.  Its value is an object of the
1167 type specified in the cast, containing the elements specified in
1168 the initializer; it is an lvalue.  As an extension, GCC supports
1169 compound literals in C89 mode and in C++.
1170
1171 Usually, the specified type is a structure.  Assume that
1172 @code{struct foo} and @code{structure} are declared as shown:
1173
1174 @smallexample
1175 struct foo @{int a; char b[2];@} structure;
1176 @end smallexample
1177
1178 @noindent
1179 Here is an example of constructing a @code{struct foo} with a compound literal:
1180
1181 @smallexample
1182 structure = ((struct foo) @{x + y, 'a', 0@});
1183 @end smallexample
1184
1185 @noindent
1186 This is equivalent to writing the following:
1187
1188 @smallexample
1189 @{
1190   struct foo temp = @{x + y, 'a', 0@};
1191   structure = temp;
1192 @}
1193 @end smallexample
1194
1195 You can also construct an array.  If all the elements of the compound literal
1196 are (made up of) simple constant expressions, suitable for use in
1197 initializers of objects of static storage duration, then the compound
1198 literal can be coerced to a pointer to its first element and used in
1199 such an initializer, as shown here:
1200
1201 @smallexample
1202 char **foo = (char *[]) @{ "x", "y", "z" @};
1203 @end smallexample
1204
1205 Compound literals for scalar types and union types are is
1206 also allowed, but then the compound literal is equivalent
1207 to a cast.
1208
1209 As a GNU extension, GCC allows initialization of objects with static storage
1210 duration by compound literals (which is not possible in ISO C99, because
1211 the initializer is not a constant).
1212 It is handled as if the object was initialized only with the bracket
1213 enclosed list if compound literal's and object types match.
1214 The initializer list of the compound literal must be constant.
1215 If the object being initialized has array type of unknown size, the size is
1216 determined by compound literal size.
1217
1218 @smallexample
1219 static struct foo x = (struct foo) @{1, 'a', 'b'@};
1220 static int y[] = (int []) @{1, 2, 3@};
1221 static int z[] = (int [3]) @{1@};
1222 @end smallexample
1223
1224 @noindent
1225 The above lines are equivalent to the following:
1226 @smallexample
1227 static struct foo x = @{1, 'a', 'b'@};
1228 static int y[] = @{1, 2, 3@};
1229 static int z[] = @{1, 0, 0@};
1230 @end smallexample
1231
1232 @node Designated Inits
1233 @section Designated Initializers
1234 @cindex initializers with labeled elements
1235 @cindex labeled elements in initializers
1236 @cindex case labels in initializers
1237 @cindex designated initializers
1238
1239 Standard C89 requires the elements of an initializer to appear in a fixed
1240 order, the same as the order of the elements in the array or structure
1241 being initialized.
1242
1243 In ISO C99 you can give the elements in any order, specifying the array
1244 indices or structure field names they apply to, and GNU C allows this as
1245 an extension in C89 mode as well.  This extension is not
1246 implemented in GNU C++.
1247
1248 To specify an array index, write
1249 @samp{[@var{index}] =} before the element value.  For example,
1250
1251 @smallexample
1252 int a[6] = @{ [4] = 29, [2] = 15 @};
1253 @end smallexample
1254
1255 @noindent
1256 is equivalent to
1257
1258 @smallexample
1259 int a[6] = @{ 0, 0, 15, 0, 29, 0 @};
1260 @end smallexample
1261
1262 @noindent
1263 The index values must be constant expressions, even if the array being
1264 initialized is automatic.
1265
1266 An alternative syntax for this which has been obsolete since GCC 2.5 but
1267 GCC still accepts is to write @samp{[@var{index}]} before the element
1268 value, with no @samp{=}.
1269
1270 To initialize a range of elements to the same value, write
1271 @samp{[@var{first} ... @var{last}] = @var{value}}.  This is a GNU
1272 extension.  For example,
1273
1274 @smallexample
1275 int widths[] = @{ [0 ... 9] = 1, [10 ... 99] = 2, [100] = 3 @};
1276 @end smallexample
1277
1278 @noindent
1279 If the value in it has side-effects, the side-effects will happen only once,
1280 not for each initialized field by the range initializer.
1281
1282 @noindent
1283 Note that the length of the array is the highest value specified
1284 plus one.
1285
1286 In a structure initializer, specify the name of a field to initialize
1287 with @samp{.@var{fieldname} =} before the element value.  For example,
1288 given the following structure,
1289
1290 @smallexample
1291 struct point @{ int x, y; @};
1292 @end smallexample
1293
1294 @noindent
1295 the following initialization
1296
1297 @smallexample
1298 struct point p = @{ .y = yvalue, .x = xvalue @};
1299 @end smallexample
1300
1301 @noindent
1302 is equivalent to
1303
1304 @smallexample
1305 struct point p = @{ xvalue, yvalue @};
1306 @end smallexample
1307
1308 Another syntax which has the same meaning, obsolete since GCC 2.5, is
1309 @samp{@var{fieldname}:}, as shown here:
1310
1311 @smallexample
1312 struct point p = @{ y: yvalue, x: xvalue @};
1313 @end smallexample
1314
1315 @cindex designators
1316 The @samp{[@var{index}]} or @samp{.@var{fieldname}} is known as a
1317 @dfn{designator}.  You can also use a designator (or the obsolete colon
1318 syntax) when initializing a union, to specify which element of the union
1319 should be used.  For example,
1320
1321 @smallexample
1322 union foo @{ int i; double d; @};
1323
1324 union foo f = @{ .d = 4 @};
1325 @end smallexample
1326
1327 @noindent
1328 will convert 4 to a @code{double} to store it in the union using
1329 the second element.  By contrast, casting 4 to type @code{union foo}
1330 would store it into the union as the integer @code{i}, since it is
1331 an integer.  (@xref{Cast to Union}.)
1332
1333 You can combine this technique of naming elements with ordinary C
1334 initialization of successive elements.  Each initializer element that
1335 does not have a designator applies to the next consecutive element of the
1336 array or structure.  For example,
1337
1338 @smallexample
1339 int a[6] = @{ [1] = v1, v2, [4] = v4 @};
1340 @end smallexample
1341
1342 @noindent
1343 is equivalent to
1344
1345 @smallexample
1346 int a[6] = @{ 0, v1, v2, 0, v4, 0 @};
1347 @end smallexample
1348
1349 Labeling the elements of an array initializer is especially useful
1350 when the indices are characters or belong to an @code{enum} type.
1351 For example:
1352
1353 @smallexample
1354 int whitespace[256]
1355   = @{ [' '] = 1, ['\t'] = 1, ['\h'] = 1,
1356       ['\f'] = 1, ['\n'] = 1, ['\r'] = 1 @};
1357 @end smallexample
1358
1359 @cindex designator lists
1360 You can also write a series of @samp{.@var{fieldname}} and
1361 @samp{[@var{index}]} designators before an @samp{=} to specify a
1362 nested subobject to initialize; the list is taken relative to the
1363 subobject corresponding to the closest surrounding brace pair.  For
1364 example, with the @samp{struct point} declaration above:
1365
1366 @smallexample
1367 struct point ptarray[10] = @{ [2].y = yv2, [2].x = xv2, [0].x = xv0 @};
1368 @end smallexample
1369
1370 @noindent
1371 If the same field is initialized multiple times, it will have value from
1372 the last initialization.  If any such overridden initialization has
1373 side-effect, it is unspecified whether the side-effect happens or not.
1374 Currently, GCC will discard them and issue a warning.
1375
1376 @node Case Ranges
1377 @section Case Ranges
1378 @cindex case ranges
1379 @cindex ranges in case statements
1380
1381 You can specify a range of consecutive values in a single @code{case} label,
1382 like this:
1383
1384 @smallexample
1385 case @var{low} ... @var{high}:
1386 @end smallexample
1387
1388 @noindent
1389 This has the same effect as the proper number of individual @code{case}
1390 labels, one for each integer value from @var{low} to @var{high}, inclusive.
1391
1392 This feature is especially useful for ranges of ASCII character codes:
1393
1394 @smallexample
1395 case 'A' ... 'Z':
1396 @end smallexample
1397
1398 @strong{Be careful:} Write spaces around the @code{...}, for otherwise
1399 it may be parsed wrong when you use it with integer values.  For example,
1400 write this:
1401
1402 @smallexample
1403 case 1 ... 5:
1404 @end smallexample
1405
1406 @noindent
1407 rather than this:
1408
1409 @smallexample
1410 case 1...5:
1411 @end smallexample
1412
1413 @node Cast to Union
1414 @section Cast to a Union Type
1415 @cindex cast to a union
1416 @cindex union, casting to a
1417
1418 A cast to union type is similar to other casts, except that the type
1419 specified is a union type.  You can specify the type either with
1420 @code{union @var{tag}} or with a typedef name.  A cast to union is actually
1421 a constructor though, not a cast, and hence does not yield an lvalue like
1422 normal casts.  (@xref{Compound Literals}.)
1423
1424 The types that may be cast to the union type are those of the members
1425 of the union.  Thus, given the following union and variables:
1426
1427 @smallexample
1428 union foo @{ int i; double d; @};
1429 int x;
1430 double y;
1431 @end smallexample
1432
1433 @noindent
1434 both @code{x} and @code{y} can be cast to type @code{union foo}.
1435
1436 Using the cast as the right-hand side of an assignment to a variable of
1437 union type is equivalent to storing in a member of the union:
1438
1439 @smallexample
1440 union foo u;
1441 /* @r{@dots{}} */
1442 u = (union foo) x  @equiv{}  u.i = x
1443 u = (union foo) y  @equiv{}  u.d = y
1444 @end smallexample
1445
1446 You can also use the union cast as a function argument:
1447
1448 @smallexample
1449 void hack (union foo);
1450 /* @r{@dots{}} */
1451 hack ((union foo) x);
1452 @end smallexample
1453
1454 @node Mixed Declarations
1455 @section Mixed Declarations and Code
1456 @cindex mixed declarations and code
1457 @cindex declarations, mixed with code
1458 @cindex code, mixed with declarations
1459
1460 ISO C99 and ISO C++ allow declarations and code to be freely mixed
1461 within compound statements.  As an extension, GCC also allows this in
1462 C89 mode.  For example, you could do:
1463
1464 @smallexample
1465 int i;
1466 /* @r{@dots{}} */
1467 i++;
1468 int j = i + 2;
1469 @end smallexample
1470
1471 Each identifier is visible from where it is declared until the end of
1472 the enclosing block.
1473
1474 @node Function Attributes
1475 @section Declaring Attributes of Functions
1476 @cindex function attributes
1477 @cindex declaring attributes of functions
1478 @cindex functions that never return
1479 @cindex functions that have no side effects
1480 @cindex functions in arbitrary sections
1481 @cindex functions that behave like malloc
1482 @cindex @code{volatile} applied to function
1483 @cindex @code{const} applied to function
1484 @cindex functions with @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style arguments
1485 @cindex functions with non-null pointer arguments
1486 @cindex functions that are passed arguments in registers on the 386
1487 @cindex functions that pop the argument stack on the 386
1488 @cindex functions that do not pop the argument stack on the 386
1489
1490 In GNU C, you declare certain things about functions called in your program
1491 which help the compiler optimize function calls and check your code more
1492 carefully.
1493
1494 The keyword @code{__attribute__} allows you to specify special
1495 attributes when making a declaration.  This keyword is followed by an
1496 attribute specification inside double parentheses.  The following
1497 attributes are currently defined for functions on all targets:
1498 @code{noreturn}, @code{noinline}, @code{always_inline},
1499 @code{pure}, @code{const}, @code{nothrow}, @code{sentinel},
1500 @code{format}, @code{format_arg}, @code{no_instrument_function},
1501 @code{section}, @code{constructor}, @code{destructor}, @code{used},
1502 @code{unused}, @code{deprecated}, @code{weak}, @code{malloc},
1503 @code{alias}, @code{warn_unused_result} and @code{nonnull}.  Several other
1504 attributes are defined for functions on particular target systems.  Other
1505 attributes, including @code{section} are supported for variables declarations
1506 (@pxref{Variable Attributes}) and for types (@pxref{Type Attributes}).
1507
1508 You may also specify attributes with @samp{__} preceding and following
1509 each keyword.  This allows you to use them in header files without
1510 being concerned about a possible macro of the same name.  For example,
1511 you may use @code{__noreturn__} instead of @code{noreturn}.
1512
1513 @xref{Attribute Syntax}, for details of the exact syntax for using
1514 attributes.
1515
1516 @table @code
1517 @c Keep this table alphabetized by attribute name. Treat _ as space.
1518
1519 @item alias ("@var{target}")
1520 @cindex @code{alias} attribute
1521 The @code{alias} attribute causes the declaration to be emitted as an
1522 alias for another symbol, which must be specified.  For instance,
1523
1524 @smallexample
1525 void __f () @{ /* @r{Do something.} */; @}
1526 void f () __attribute__ ((weak, alias ("__f")));
1527 @end smallexample
1528
1529 declares @samp{f} to be a weak alias for @samp{__f}.  In C++, the
1530 mangled name for the target must be used.
1531
1532 Not all target machines support this attribute.
1533
1534 @item always_inline
1535 @cindex @code{always_inline} function attribute
1536 Generally, functions are not inlined unless optimization is specified.
1537 For functions declared inline, this attribute inlines the function even
1538 if no optimization level was specified.
1539
1540 @item cdecl
1541 @cindex functions that do pop the argument stack on the 386
1542 @opindex mrtd
1543 On the Intel 386, the @code{cdecl} attribute causes the compiler to
1544 assume that the calling function will pop off the stack space used to
1545 pass arguments.  This is
1546 useful to override the effects of the @option{-mrtd} switch.
1547
1548 @item const
1549 @cindex @code{const} function attribute
1550 Many functions do not examine any values except their arguments, and
1551 have no effects except the return value.  Basically this is just slightly
1552 more strict class than the @code{pure} attribute above, since function is not
1553 allowed to read global memory.
1554
1555 @cindex pointer arguments
1556 Note that a function that has pointer arguments and examines the data
1557 pointed to must @emph{not} be declared @code{const}.  Likewise, a
1558 function that calls a non-@code{const} function usually must not be
1559 @code{const}.  It does not make sense for a @code{const} function to
1560 return @code{void}.
1561
1562 The attribute @code{const} is not implemented in GCC versions earlier
1563 than 2.5.  An alternative way to declare that a function has no side
1564 effects, which works in the current version and in some older versions,
1565 is as follows:
1566
1567 @smallexample
1568 typedef int intfn ();
1569
1570 extern const intfn square;
1571 @end smallexample
1572
1573 This approach does not work in GNU C++ from 2.6.0 on, since the language
1574 specifies that the @samp{const} must be attached to the return value.
1575
1576 @item constructor
1577 @itemx destructor
1578 @cindex @code{constructor} function attribute
1579 @cindex @code{destructor} function attribute
1580 The @code{constructor} attribute causes the function to be called
1581 automatically before execution enters @code{main ()}.  Similarly, the
1582 @code{destructor} attribute causes the function to be called
1583 automatically after @code{main ()} has completed or @code{exit ()} has
1584 been called.  Functions with these attributes are useful for
1585 initializing data that will be used implicitly during the execution of
1586 the program.
1587
1588 These attributes are not currently implemented for Objective-C@.
1589
1590 @item deprecated
1591 @cindex @code{deprecated} attribute.
1592 The @code{deprecated} attribute results in a warning if the function
1593 is used anywhere in the source file.  This is useful when identifying
1594 functions that are expected to be removed in a future version of a
1595 program.  The warning also includes the location of the declaration
1596 of the deprecated function, to enable users to easily find further
1597 information about why the function is deprecated, or what they should
1598 do instead.  Note that the warnings only occurs for uses:
1599
1600 @smallexample
1601 int old_fn () __attribute__ ((deprecated));
1602 int old_fn ();
1603 int (*fn_ptr)() = old_fn;
1604 @end smallexample
1605
1606 results in a warning on line 3 but not line 2.
1607
1608 The @code{deprecated} attribute can also be used for variables and
1609 types (@pxref{Variable Attributes}, @pxref{Type Attributes}.)
1610
1611 @item dllexport
1612 @cindex @code{__declspec(dllexport)}
1613 On Microsoft Windows targets and Symbian OS targets the
1614 @code{dllexport} attribute causes the compiler to provide a global
1615 pointer to a pointer in a DLL, so that it can be referenced with the
1616 @code{dllimport} attribute.  On Microsoft Windows targets, the pointer
1617 name is formed by combining @code{_imp__} and the function or variable
1618 name.
1619
1620 You can use @code{__declspec(dllexport)} as a synonym for
1621 @code{__attribute__ ((dllexport))} for compatibility with other
1622 compilers.
1623
1624 On systems that support the @code{visibility} attribute, this
1625 attribute also implies ``default'' visibility, unless a
1626 @code{visibility} attribute is explicitly specified.  You should avoid
1627 the use of @code{dllexport} with ``hidden'' or ``internal''
1628 visibility; in the future GCC may issue an error for those cases.
1629
1630 Currently, the @code{dllexport} attribute is ignored for inlined
1631 functions, unless the @option{-fkeep-inline-functions} flag has been
1632 used.  The attribute is also ignored for undefined symbols.
1633
1634 When applied to C++ classes. the attribute marks defined non-inlined
1635 member functions and static data members as exports. Static consts
1636 initialized in-class are not marked unless they are also defined
1637 out-of-class.
1638
1639 For Microsoft Windows targets there are alternative methods for
1640 including the symbol in the DLL's export table such as using a
1641 @file{.def} file with an @code{EXPORTS} section or, with GNU ld, using
1642 the @option{--export-all} linker flag.
1643
1644 @item dllimport
1645 @cindex @code{__declspec(dllimport)}
1646 On Microsoft Windows and Symbian OS targets, the @code{dllimport}
1647 attribute causes the compiler to reference a function or variable via
1648 a global pointer to a pointer that is set up by the DLL exporting the
1649 symbol. The attribute implies @code{extern} storage.  On Microsoft
1650 Windows targets, the pointer name is formed by combining @code{_imp__}
1651 and the function or variable name.
1652
1653 You can use @code{__declspec(dllimport)} as a synonym for
1654 @code{__attribute__ ((dllimport))} for compatibility with other
1655 compilers.
1656
1657 Currently, the attribute is ignored for inlined functions. If the
1658 attribute is applied to a symbol @emph{definition}, an error is reported.
1659 If a symbol previously declared @code{dllimport} is later defined, the
1660 attribute is ignored in subsequent references, and a warning is emitted.
1661 The attribute is also overridden by a subsequent declaration as
1662 @code{dllexport}.
1663
1664 When applied to C++ classes, the attribute marks non-inlined
1665 member functions and static data members as imports.  However, the
1666 attribute is ignored for virtual methods to allow creation of vtables
1667 using thunks.
1668
1669 On the SH Symbian OS target the @code{dllimport} attribute also has
1670 another affect - it can cause the vtable and run-time type information
1671 for a class to be exported.  This happens when the class has a
1672 dllimport'ed constructor or a non-inline, non-pure virtual function
1673 and, for either of those two conditions, the class also has a inline
1674 constructor or destructor and has a key function that is defined in
1675 the current translation unit.
1676
1677 For Microsoft Windows based targets the use of the @code{dllimport}
1678 attribute on functions is not necessary, but provides a small
1679 performance benefit by eliminating a thunk in the DLL. The use of the
1680 @code{dllimport} attribute on imported variables was required on older
1681 versions of the GNU linker, but can now be avoided by passing the
1682 @option{--enable-auto-import} switch to the GNU linker. As with
1683 functions, using the attribute for a variable eliminates a thunk in
1684 the DLL.
1685
1686 One drawback to using this attribute is that a pointer to a function
1687 or variable marked as @code{dllimport} cannot be used as a constant
1688 address.  On Microsoft Windows targets, the attribute can be disabled
1689 for functions by setting the @option{-mnop-fun-dllimport} flag.
1690
1691 @item eightbit_data
1692 @cindex eight bit data on the H8/300, H8/300H, and H8S
1693 Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
1694 variable should be placed into the eight bit data section.
1695 The compiler will generate more efficient code for certain operations
1696 on data in the eight bit data area.  Note the eight bit data area is limited to
1697 256 bytes of data.
1698
1699 You must use GAS and GLD from GNU binutils version 2.7 or later for
1700 this attribute to work correctly.
1701
1702 @item far
1703 @cindex functions which handle memory bank switching
1704 On 68HC11 and 68HC12 the @code{far} attribute causes the compiler to
1705 use a calling convention that takes care of switching memory banks when
1706 entering and leaving a function.  This calling convention is also the
1707 default when using the @option{-mlong-calls} option.
1708
1709 On 68HC12 the compiler will use the @code{call} and @code{rtc} instructions
1710 to call and return from a function.
1711
1712 On 68HC11 the compiler will generate a sequence of instructions
1713 to invoke a board-specific routine to switch the memory bank and call the
1714 real function. The board-specific routine simulates a @code{call}.
1715 At the end of a function, it will jump to a board-specific routine
1716 instead of using @code{rts}. The board-specific return routine simulates
1717 the @code{rtc}.
1718
1719 @item fastcall
1720 @cindex functions that pop the argument stack on the 386
1721 On the Intel 386, the @code{fastcall} attribute causes the compiler to
1722 pass the first two arguments in the registers ECX and EDX. Subsequent
1723 arguments are passed on the stack. The called function will pop the
1724 arguments off the stack. If the number of arguments is variable all
1725 arguments are pushed on the stack.
1726
1727 @item format (@var{archetype}, @var{string-index}, @var{first-to-check})
1728 @cindex @code{format} function attribute
1729 @opindex Wformat
1730 The @code{format} attribute specifies that a function takes @code{printf},
1731 @code{scanf}, @code{strftime} or @code{strfmon} style arguments which
1732 should be type-checked against a format string.  For example, the
1733 declaration:
1734
1735 @smallexample
1736 extern int
1737 my_printf (void *my_object, const char *my_format, ...)
1738       __attribute__ ((format (printf, 2, 3)));
1739 @end smallexample
1740
1741 @noindent
1742 causes the compiler to check the arguments in calls to @code{my_printf}
1743 for consistency with the @code{printf} style format string argument
1744 @code{my_format}.
1745
1746 The parameter @var{archetype} determines how the format string is
1747 interpreted, and should be @code{printf}, @code{scanf}, @code{strftime}
1748 or @code{strfmon}.  (You can also use @code{__printf__},
1749 @code{__scanf__}, @code{__strftime__} or @code{__strfmon__}.)  The
1750 parameter @var{string-index} specifies which argument is the format
1751 string argument (starting from 1), while @var{first-to-check} is the
1752 number of the first argument to check against the format string.  For
1753 functions where the arguments are not available to be checked (such as
1754 @code{vprintf}), specify the third parameter as zero.  In this case the
1755 compiler only checks the format string for consistency.  For
1756 @code{strftime} formats, the third parameter is required to be zero.
1757 Since non-static C++ methods have an implicit @code{this} argument, the
1758 arguments of such methods should be counted from two, not one, when
1759 giving values for @var{string-index} and @var{first-to-check}.
1760
1761 In the example above, the format string (@code{my_format}) is the second
1762 argument of the function @code{my_print}, and the arguments to check
1763 start with the third argument, so the correct parameters for the format
1764 attribute are 2 and 3.
1765
1766 @opindex ffreestanding
1767 The @code{format} attribute allows you to identify your own functions
1768 which take format strings as arguments, so that GCC can check the
1769 calls to these functions for errors.  The compiler always (unless
1770 @option{-ffreestanding} is used) checks formats
1771 for the standard library functions @code{printf}, @code{fprintf},
1772 @code{sprintf}, @code{scanf}, @code{fscanf}, @code{sscanf}, @code{strftime},
1773 @code{vprintf}, @code{vfprintf} and @code{vsprintf} whenever such
1774 warnings are requested (using @option{-Wformat}), so there is no need to
1775 modify the header file @file{stdio.h}.  In C99 mode, the functions
1776 @code{snprintf}, @code{vsnprintf}, @code{vscanf}, @code{vfscanf} and
1777 @code{vsscanf} are also checked.  Except in strictly conforming C
1778 standard modes, the X/Open function @code{strfmon} is also checked as
1779 are @code{printf_unlocked} and @code{fprintf_unlocked}.
1780 @xref{C Dialect Options,,Options Controlling C Dialect}.
1781
1782 The target may provide additional types of format checks.
1783 @xref{Target Format Checks,,Format Checks Specific to Particular
1784 Target Machines}.
1785
1786 @item format_arg (@var{string-index})
1787 @cindex @code{format_arg} function attribute
1788 @opindex Wformat-nonliteral
1789 The @code{format_arg} attribute specifies that a function takes a format
1790 string for a @code{printf}, @code{scanf}, @code{strftime} or
1791 @code{strfmon} style function and modifies it (for example, to translate
1792 it into another language), so the result can be passed to a
1793 @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style
1794 function (with the remaining arguments to the format function the same
1795 as they would have been for the unmodified string).  For example, the
1796 declaration:
1797
1798 @smallexample
1799 extern char *
1800 my_dgettext (char *my_domain, const char *my_format)
1801       __attribute__ ((format_arg (2)));
1802 @end smallexample
1803
1804 @noindent
1805 causes the compiler to check the arguments in calls to a @code{printf},
1806 @code{scanf}, @code{strftime} or @code{strfmon} type function, whose
1807 format string argument is a call to the @code{my_dgettext} function, for
1808 consistency with the format string argument @code{my_format}.  If the
1809 @code{format_arg} attribute had not been specified, all the compiler
1810 could tell in such calls to format functions would be that the format
1811 string argument is not constant; this would generate a warning when
1812 @option{-Wformat-nonliteral} is used, but the calls could not be checked
1813 without the attribute.
1814
1815 The parameter @var{string-index} specifies which argument is the format
1816 string argument (starting from one).  Since non-static C++ methods have
1817 an implicit @code{this} argument, the arguments of such methods should
1818 be counted from two.
1819
1820 The @code{format-arg} attribute allows you to identify your own
1821 functions which modify format strings, so that GCC can check the
1822 calls to @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon}
1823 type function whose operands are a call to one of your own function.
1824 The compiler always treats @code{gettext}, @code{dgettext}, and
1825 @code{dcgettext} in this manner except when strict ISO C support is
1826 requested by @option{-ansi} or an appropriate @option{-std} option, or
1827 @option{-ffreestanding} is used.  @xref{C Dialect Options,,Options
1828 Controlling C Dialect}.
1829
1830 @item function_vector
1831 @cindex calling functions through the function vector on the H8/300 processors
1832 Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
1833 function should be called through the function vector.  Calling a
1834 function through the function vector will reduce code size, however;
1835 the function vector has a limited size (maximum 128 entries on the H8/300
1836 and 64 entries on the H8/300H and H8S) and shares space with the interrupt vector.
1837
1838 You must use GAS and GLD from GNU binutils version 2.7 or later for
1839 this attribute to work correctly.
1840
1841 @item interrupt
1842 @cindex interrupt handler functions
1843 Use this attribute on the ARM, AVR, C4x, M32R/D and Xstormy16 ports to indicate
1844 that the specified function is an interrupt handler.  The compiler will
1845 generate function entry and exit sequences suitable for use in an
1846 interrupt handler when this attribute is present.
1847
1848 Note, interrupt handlers for the m68k, H8/300, H8/300H, H8S, and SH processors
1849 can be specified via the @code{interrupt_handler} attribute.
1850
1851 Note, on the AVR, interrupts will be enabled inside the function.
1852
1853 Note, for the ARM, you can specify the kind of interrupt to be handled by
1854 adding an optional parameter to the interrupt attribute like this:
1855
1856 @smallexample
1857 void f () __attribute__ ((interrupt ("IRQ")));
1858 @end smallexample
1859
1860 Permissible values for this parameter are: IRQ, FIQ, SWI, ABORT and UNDEF@.
1861
1862 @item interrupt_handler
1863 @cindex interrupt handler functions on the m68k, H8/300 and SH processors
1864 Use this attribute on the m68k, H8/300, H8/300H, H8S, and SH to indicate that
1865 the specified function is an interrupt handler.  The compiler will generate
1866 function entry and exit sequences suitable for use in an interrupt
1867 handler when this attribute is present.
1868
1869 @item long_call/short_call
1870 @cindex indirect calls on ARM
1871 This attribute specifies how a particular function is called on
1872 ARM@.  Both attributes override the @option{-mlong-calls} (@pxref{ARM Options})
1873 command line switch and @code{#pragma long_calls} settings.  The
1874 @code{long_call} attribute causes the compiler to always call the
1875 function by first loading its address into a register and then using the
1876 contents of that register.   The @code{short_call} attribute always places
1877 the offset to the function from the call site into the @samp{BL}
1878 instruction directly.
1879
1880 @item longcall/shortcall
1881 @cindex functions called via pointer on the RS/6000 and PowerPC
1882 On the RS/6000 and PowerPC, the @code{longcall} attribute causes the
1883 compiler to always call this function via a pointer, just as it would if
1884 the @option{-mlongcall} option had been specified.  The @code{shortcall}
1885 attribute causes the compiler not to do this.  These attributes override
1886 both the @option{-mlongcall} switch and the @code{#pragma longcall}
1887 setting.
1888
1889 @xref{RS/6000 and PowerPC Options}, for more information on whether long
1890 calls are necessary.
1891
1892 @item malloc
1893 @cindex @code{malloc} attribute
1894 The @code{malloc} attribute is used to tell the compiler that a function
1895 may be treated as if any non-@code{NULL} pointer it returns cannot
1896 alias any other pointer valid when the function returns.
1897 This will often improve optimization.
1898 Standard functions with this property include @code{malloc} and
1899 @code{calloc}.  @code{realloc}-like functions have this property as
1900 long as the old pointer is never referred to (including comparing it
1901 to the new pointer) after the function returns a non-@code{NULL}
1902 value.
1903
1904 @item model (@var{model-name})
1905 @cindex function addressability on the M32R/D
1906 @cindex variable addressability on the IA-64
1907
1908 On the M32R/D, use this attribute to set the addressability of an
1909 object, and of the code generated for a function.  The identifier
1910 @var{model-name} is one of @code{small}, @code{medium}, or
1911 @code{large}, representing each of the code models.
1912
1913 Small model objects live in the lower 16MB of memory (so that their
1914 addresses can be loaded with the @code{ld24} instruction), and are
1915 callable with the @code{bl} instruction.
1916
1917 Medium model objects may live anywhere in the 32-bit address space (the
1918 compiler will generate @code{seth/add3} instructions to load their addresses),
1919 and are callable with the @code{bl} instruction.
1920
1921 Large model objects may live anywhere in the 32-bit address space (the
1922 compiler will generate @code{seth/add3} instructions to load their addresses),
1923 and may not be reachable with the @code{bl} instruction (the compiler will
1924 generate the much slower @code{seth/add3/jl} instruction sequence).
1925
1926 On IA-64, use this attribute to set the addressability of an object.
1927 At present, the only supported identifier for @var{model-name} is
1928 @code{small}, indicating addressability via ``small'' (22-bit)
1929 addresses (so that their addresses can be loaded with the @code{addl}
1930 instruction).  Caveat: such addressing is by definition not position
1931 independent and hence this attribute must not be used for objects
1932 defined by shared libraries.
1933
1934 @item naked
1935 @cindex function without a prologue/epilogue code
1936 Use this attribute on the ARM, AVR, C4x and IP2K ports to indicate that the
1937 specified function does not need prologue/epilogue sequences generated by
1938 the compiler.  It is up to the programmer to provide these sequences.
1939
1940 @item near
1941 @cindex functions which do not handle memory bank switching on 68HC11/68HC12
1942 On 68HC11 and 68HC12 the @code{near} attribute causes the compiler to
1943 use the normal calling convention based on @code{jsr} and @code{rts}.
1944 This attribute can be used to cancel the effect of the @option{-mlong-calls}
1945 option.
1946
1947 @item no_instrument_function
1948 @cindex @code{no_instrument_function} function attribute
1949 @opindex finstrument-functions
1950 If @option{-finstrument-functions} is given, profiling function calls will
1951 be generated at entry and exit of most user-compiled functions.
1952 Functions with this attribute will not be so instrumented.
1953
1954 @item noinline
1955 @cindex @code{noinline} function attribute
1956 This function attribute prevents a function from being considered for
1957 inlining.
1958
1959 @item nonnull (@var{arg-index}, @dots{})
1960 @cindex @code{nonnull} function attribute
1961 The @code{nonnull} attribute specifies that some function parameters should
1962 be non-null pointers.  For instance, the declaration:
1963
1964 @smallexample
1965 extern void *
1966 my_memcpy (void *dest, const void *src, size_t len)
1967         __attribute__((nonnull (1, 2)));
1968 @end smallexample
1969
1970 @noindent
1971 causes the compiler to check that, in calls to @code{my_memcpy},
1972 arguments @var{dest} and @var{src} are non-null.  If the compiler
1973 determines that a null pointer is passed in an argument slot marked
1974 as non-null, and the @option{-Wnonnull} option is enabled, a warning
1975 is issued.  The compiler may also choose to make optimizations based
1976 on the knowledge that certain function arguments will not be null.
1977
1978 If no argument index list is given to the @code{nonnull} attribute,
1979 all pointer arguments are marked as non-null.  To illustrate, the
1980 following declaration is equivalent to the previous example:
1981
1982 @smallexample
1983 extern void *
1984 my_memcpy (void *dest, const void *src, size_t len)
1985         __attribute__((nonnull));
1986 @end smallexample
1987
1988 @item noreturn
1989 @cindex @code{noreturn} function attribute
1990 A few standard library functions, such as @code{abort} and @code{exit},
1991 cannot return.  GCC knows this automatically.  Some programs define
1992 their own functions that never return.  You can declare them
1993 @code{noreturn} to tell the compiler this fact.  For example,
1994
1995 @smallexample
1996 @group
1997 void fatal () __attribute__ ((noreturn));
1998
1999 void
2000 fatal (/* @r{@dots{}} */)
2001 @{
2002   /* @r{@dots{}} */ /* @r{Print error message.} */ /* @r{@dots{}} */
2003   exit (1);
2004 @}
2005 @end group
2006 @end smallexample
2007
2008 The @code{noreturn} keyword tells the compiler to assume that
2009 @code{fatal} cannot return.  It can then optimize without regard to what
2010 would happen if @code{fatal} ever did return.  This makes slightly
2011 better code.  More importantly, it helps avoid spurious warnings of
2012 uninitialized variables.
2013
2014 The @code{noreturn} keyword does not affect the exceptional path when that
2015 applies: a @code{noreturn}-marked function may still return to the caller
2016 by throwing an exception.
2017
2018 Do not assume that registers saved by the calling function are
2019 restored before calling the @code{noreturn} function.
2020
2021 It does not make sense for a @code{noreturn} function to have a return
2022 type other than @code{void}.
2023
2024 The attribute @code{noreturn} is not implemented in GCC versions
2025 earlier than 2.5.  An alternative way to declare that a function does
2026 not return, which works in the current version and in some older
2027 versions, is as follows:
2028
2029 @smallexample
2030 typedef void voidfn ();
2031
2032 volatile voidfn fatal;
2033 @end smallexample
2034
2035 @item nothrow
2036 @cindex @code{nothrow} function attribute
2037 The @code{nothrow} attribute is used to inform the compiler that a
2038 function cannot throw an exception.  For example, most functions in
2039 the standard C library can be guaranteed not to throw an exception
2040 with the notable exceptions of @code{qsort} and @code{bsearch} that
2041 take function pointer arguments.  The @code{nothrow} attribute is not
2042 implemented in GCC versions earlier than 3.2.
2043
2044 @item pure
2045 @cindex @code{pure} function attribute
2046 Many functions have no effects except the return value and their
2047 return value depends only on the parameters and/or global variables.
2048 Such a function can be subject
2049 to common subexpression elimination and loop optimization just as an
2050 arithmetic operator would be.  These functions should be declared
2051 with the attribute @code{pure}.  For example,
2052
2053 @smallexample
2054 int square (int) __attribute__ ((pure));
2055 @end smallexample
2056
2057 @noindent
2058 says that the hypothetical function @code{square} is safe to call
2059 fewer times than the program says.
2060
2061 Some of common examples of pure functions are @code{strlen} or @code{memcmp}.
2062 Interesting non-pure functions are functions with infinite loops or those
2063 depending on volatile memory or other system resource, that may change between
2064 two consecutive calls (such as @code{feof} in a multithreading environment).
2065
2066 The attribute @code{pure} is not implemented in GCC versions earlier
2067 than 2.96.
2068
2069 @item regparm (@var{number})
2070 @cindex @code{regparm} attribute
2071 @cindex functions that are passed arguments in registers on the 386
2072 On the Intel 386, the @code{regparm} attribute causes the compiler to
2073 pass up to @var{number} integer arguments in registers EAX,
2074 EDX, and ECX instead of on the stack.  Functions that take a
2075 variable number of arguments will continue to be passed all of their
2076 arguments on the stack.
2077
2078 Beware that on some ELF systems this attribute is unsuitable for
2079 global functions in shared libraries with lazy binding (which is the
2080 default).  Lazy binding will send the first call via resolving code in
2081 the loader, which might assume EAX, EDX and ECX can be clobbered, as
2082 per the standard calling conventions.  Solaris 8 is affected by this.
2083 GNU systems with GLIBC 2.1 or higher, and FreeBSD, are believed to be
2084 safe since the loaders there save all registers.  (Lazy binding can be
2085 disabled with the linker or the loader if desired, to avoid the
2086 problem.)
2087
2088 @item saveall
2089 @cindex save all registers on the H8/300, H8/300H, and H8S
2090 Use this attribute on the H8/300, H8/300H, and H8S to indicate that
2091 all registers except the stack pointer should be saved in the prologue
2092 regardless of whether they are used or not.
2093
2094 @item section ("@var{section-name}")
2095 @cindex @code{section} function attribute
2096 Normally, the compiler places the code it generates in the @code{text} section.
2097 Sometimes, however, you need additional sections, or you need certain
2098 particular functions to appear in special sections.  The @code{section}
2099 attribute specifies that a function lives in a particular section.
2100 For example, the declaration:
2101
2102 @smallexample
2103 extern void foobar (void) __attribute__ ((section ("bar")));
2104 @end smallexample
2105
2106 @noindent
2107 puts the function @code{foobar} in the @code{bar} section.
2108
2109 Some file formats do not support arbitrary sections so the @code{section}
2110 attribute is not available on all platforms.
2111 If you need to map the entire contents of a module to a particular
2112 section, consider using the facilities of the linker instead.
2113
2114 @item sentinel
2115 @cindex @code{sentinel} function attribute
2116 This function attribute ensures that the last parameter in a function
2117 call is an explicit @code{NULL}.  The attribute is only valid on
2118 variadic functions.  For example the attribute is automatically set for
2119 the built-in functions @code{execl} and @code{execlp} where @code{NULL}
2120 is the marker for argument list termination.  A valid @code{NULL} in
2121 this context is defined as zero with any pointer type.  If your system
2122 defines the @code{NULL} macro with an integer type then you need to add
2123 an explicit cast.  The warnings for missing or incorrect sentinels are
2124 enabled with @option{-Wformat}.
2125
2126 @item short_call
2127 See long_call/short_call.
2128
2129 @item shortcall
2130 See longcall/shortcall.
2131
2132 @item signal
2133 @cindex signal handler functions on the AVR processors
2134 Use this attribute on the AVR to indicate that the specified
2135 function is a signal handler.  The compiler will generate function
2136 entry and exit sequences suitable for use in a signal handler when this
2137 attribute is present.  Interrupts will be disabled inside the function.
2138
2139 @item sp_switch
2140 Use this attribute on the SH to indicate an @code{interrupt_handler}
2141 function should switch to an alternate stack.  It expects a string
2142 argument that names a global variable holding the address of the
2143 alternate stack.
2144
2145 @smallexample
2146 void *alt_stack;
2147 void f () __attribute__ ((interrupt_handler,
2148                           sp_switch ("alt_stack")));
2149 @end smallexample
2150
2151 @item stdcall
2152 @cindex functions that pop the argument stack on the 386
2153 On the Intel 386, the @code{stdcall} attribute causes the compiler to
2154 assume that the called function will pop off the stack space used to
2155 pass arguments, unless it takes a variable number of arguments.
2156
2157 @item tiny_data
2158 @cindex tiny data section on the H8/300H and H8S
2159 Use this attribute on the H8/300H and H8S to indicate that the specified
2160 variable should be placed into the tiny data section.
2161 The compiler will generate more efficient code for loads and stores
2162 on data in the tiny data section.  Note the tiny data area is limited to
2163 slightly under 32kbytes of data.
2164
2165 @item trap_exit
2166 Use this attribute on the SH for an @code{interrupt_handler} to return using
2167 @code{trapa} instead of @code{rte}.  This attribute expects an integer
2168 argument specifying the trap number to be used.
2169
2170 @item unused
2171 @cindex @code{unused} attribute.
2172 This attribute, attached to a function, means that the function is meant
2173 to be possibly unused.  GCC will not produce a warning for this
2174 function.
2175
2176 @item used
2177 @cindex @code{used} attribute.
2178 This attribute, attached to a function, means that code must be emitted
2179 for the function even if it appears that the function is not referenced.
2180 This is useful, for example, when the function is referenced only in
2181 inline assembly.
2182
2183 @item visibility ("@var{visibility_type}")
2184 @cindex @code{visibility} attribute
2185 The @code{visibility} attribute on ELF targets causes the declaration
2186 to be emitted with default, hidden, protected or internal visibility.
2187
2188 @smallexample
2189 void __attribute__ ((visibility ("protected")))
2190 f () @{ /* @r{Do something.} */; @}
2191 int i __attribute__ ((visibility ("hidden")));
2192 @end smallexample
2193
2194 See the ELF gABI for complete details, but the short story is:
2195
2196 @table @dfn
2197 @c keep this list of visibilities in alphabetical order.
2198
2199 @item default
2200 Default visibility is the normal case for ELF.  This value is
2201 available for the visibility attribute to override other options
2202 that may change the assumed visibility of symbols.
2203
2204 @item hidden
2205 Hidden visibility indicates that the symbol will not be placed into
2206 the dynamic symbol table, so no other @dfn{module} (executable or
2207 shared library) can reference it directly.
2208
2209 @item internal
2210 Internal visibility is like hidden visibility, but with additional
2211 processor specific semantics.  Unless otherwise specified by the psABI,
2212 GCC defines internal visibility to mean that the function is @emph{never}
2213 called from another module.  Note that hidden symbols, while they cannot
2214 be referenced directly by other modules, can be referenced indirectly via
2215 function pointers.  By indicating that a symbol cannot be called from
2216 outside the module, GCC may for instance omit the load of a PIC register
2217 since it is known that the calling function loaded the correct value.
2218
2219 @item protected
2220 Protected visibility indicates that the symbol will be placed in the
2221 dynamic symbol table, but that references within the defining module
2222 will bind to the local symbol.  That is, the symbol cannot be overridden
2223 by another module.
2224
2225 @end table
2226
2227 Not all ELF targets support this attribute.
2228
2229 @item warn_unused_result
2230 @cindex @code{warn_unused_result} attribute
2231 The @code{warn_unused_result} attribute causes a warning to be emitted
2232 if a caller of the function with this attribute does not use its
2233 return value.  This is useful for functions where not checking
2234 the result is either a security problem or always a bug, such as
2235 @code{realloc}.
2236
2237 @smallexample
2238 int fn () __attribute__ ((warn_unused_result));
2239 int foo ()
2240 @{
2241   if (fn () < 0) return -1;
2242   fn ();
2243   return 0;
2244 @}
2245 @end smallexample
2246
2247 results in warning on line 5.
2248
2249 @item weak
2250 @cindex @code{weak} attribute
2251 The @code{weak} attribute causes the declaration to be emitted as a weak
2252 symbol rather than a global.  This is primarily useful in defining
2253 library functions which can be overridden in user code, though it can
2254 also be used with non-function declarations.  Weak symbols are supported
2255 for ELF targets, and also for a.out targets when using the GNU assembler
2256 and linker.
2257
2258 @end table
2259
2260 You can specify multiple attributes in a declaration by separating them
2261 by commas within the double parentheses or by immediately following an
2262 attribute declaration with another attribute declaration.
2263
2264 @cindex @code{#pragma}, reason for not using
2265 @cindex pragma, reason for not using
2266 Some people object to the @code{__attribute__} feature, suggesting that
2267 ISO C's @code{#pragma} should be used instead.  At the time
2268 @code{__attribute__} was designed, there were two reasons for not doing
2269 this.
2270
2271 @enumerate
2272 @item
2273 It is impossible to generate @code{#pragma} commands from a macro.
2274
2275 @item
2276 There is no telling what the same @code{#pragma} might mean in another
2277 compiler.
2278 @end enumerate
2279
2280 These two reasons applied to almost any application that might have been
2281 proposed for @code{#pragma}.  It was basically a mistake to use
2282 @code{#pragma} for @emph{anything}.
2283
2284 The ISO C99 standard includes @code{_Pragma}, which now allows pragmas
2285 to be generated from macros.  In addition, a @code{#pragma GCC}
2286 namespace is now in use for GCC-specific pragmas.  However, it has been
2287 found convenient to use @code{__attribute__} to achieve a natural
2288 attachment of attributes to their corresponding declarations, whereas
2289 @code{#pragma GCC} is of use for constructs that do not naturally form
2290 part of the grammar.  @xref{Other Directives,,Miscellaneous
2291 Preprocessing Directives, cpp, The GNU C Preprocessor}.
2292
2293 @node Attribute Syntax
2294 @section Attribute Syntax
2295 @cindex attribute syntax
2296
2297 This section describes the syntax with which @code{__attribute__} may be
2298 used, and the constructs to which attribute specifiers bind, for the C
2299 language.  Some details may vary for C++ and Objective-C@.  Because of
2300 infelicities in the grammar for attributes, some forms described here
2301 may not be successfully parsed in all cases.
2302
2303 There are some problems with the semantics of attributes in C++.  For
2304 example, there are no manglings for attributes, although they may affect
2305 code generation, so problems may arise when attributed types are used in
2306 conjunction with templates or overloading.  Similarly, @code{typeid}
2307 does not distinguish between types with different attributes.  Support
2308 for attributes in C++ may be restricted in future to attributes on
2309 declarations only, but not on nested declarators.
2310
2311 @xref{Function Attributes}, for details of the semantics of attributes
2312 applying to functions.  @xref{Variable Attributes}, for details of the
2313 semantics of attributes applying to variables.  @xref{Type Attributes},
2314 for details of the semantics of attributes applying to structure, union
2315 and enumerated types.
2316
2317 An @dfn{attribute specifier} is of the form
2318 @code{__attribute__ ((@var{attribute-list}))}.  An @dfn{attribute list}
2319 is a possibly empty comma-separated sequence of @dfn{attributes}, where
2320 each attribute is one of the following:
2321
2322 @itemize @bullet
2323 @item
2324 Empty.  Empty attributes are ignored.
2325
2326 @item
2327 A word (which may be an identifier such as @code{unused}, or a reserved
2328 word such as @code{const}).
2329
2330 @item
2331 A word, followed by, in parentheses, parameters for the attribute.
2332 These parameters take one of the following forms:
2333
2334 @itemize @bullet
2335 @item
2336 An identifier.  For example, @code{mode} attributes use this form.
2337
2338 @item
2339 An identifier followed by a comma and a non-empty comma-separated list
2340 of expressions.  For example, @code{format} attributes use this form.
2341
2342 @item
2343 A possibly empty comma-separated list of expressions.  For example,
2344 @code{format_arg} attributes use this form with the list being a single
2345 integer constant expression, and @code{alias} attributes use this form
2346 with the list being a single string constant.
2347 @end itemize
2348 @end itemize
2349
2350 An @dfn{attribute specifier list} is a sequence of one or more attribute
2351 specifiers, not separated by any other tokens.
2352
2353 In GNU C, an attribute specifier list may appear after the colon following a
2354 label, other than a @code{case} or @code{default} label.  The only
2355 attribute it makes sense to use after a label is @code{unused}.  This
2356 feature is intended for code generated by programs which contains labels
2357 that may be unused but which is compiled with @option{-Wall}.  It would
2358 not normally be appropriate to use in it human-written code, though it
2359 could be useful in cases where the code that jumps to the label is
2360 contained within an @code{#ifdef} conditional. GNU C++ does not permit
2361 such placement of attribute lists, as it is permissible for a
2362 declaration, which could begin with an attribute list, to be labelled in
2363 C++. Declarations cannot be labelled in C90 or C99, so the ambiguity
2364 does not arise there.
2365
2366 An attribute specifier list may appear as part of a @code{struct},
2367 @code{union} or @code{enum} specifier.  It may go either immediately
2368 after the @code{struct}, @code{union} or @code{enum} keyword, or after
2369 the closing brace.  It is ignored if the content of the structure, union
2370 or enumerated type is not defined in the specifier in which the
2371 attribute specifier list is used---that is, in usages such as
2372 @code{struct __attribute__((foo)) bar} with no following opening brace.
2373 Where attribute specifiers follow the closing brace, they are considered
2374 to relate to the structure, union or enumerated type defined, not to any
2375 enclosing declaration the type specifier appears in, and the type
2376 defined is not complete until after the attribute specifiers.
2377 @c Otherwise, there would be the following problems: a shift/reduce
2378 @c conflict between attributes binding the struct/union/enum and
2379 @c binding to the list of specifiers/qualifiers; and "aligned"
2380 @c attributes could use sizeof for the structure, but the size could be
2381 @c changed later by "packed" attributes.
2382
2383 Otherwise, an attribute specifier appears as part of a declaration,
2384 counting declarations of unnamed parameters and type names, and relates
2385 to that declaration (which may be nested in another declaration, for
2386 example in the case of a parameter declaration), or to a particular declarator
2387 within a declaration.  Where an
2388 attribute specifier is applied to a parameter declared as a function or
2389 an array, it should apply to the function or array rather than the
2390 pointer to which the parameter is implicitly converted, but this is not
2391 yet correctly implemented.
2392
2393 Any list of specifiers and qualifiers at the start of a declaration may
2394 contain attribute specifiers, whether or not such a list may in that
2395 context contain storage class specifiers.  (Some attributes, however,
2396 are essentially in the nature of storage class specifiers, and only make
2397 sense where storage class specifiers may be used; for example,
2398 @code{section}.)  There is one necessary limitation to this syntax: the
2399 first old-style parameter declaration in a function definition cannot
2400 begin with an attribute specifier, because such an attribute applies to
2401 the function instead by syntax described below (which, however, is not
2402 yet implemented in this case).  In some other cases, attribute
2403 specifiers are permitted by this grammar but not yet supported by the
2404 compiler.  All attribute specifiers in this place relate to the
2405 declaration as a whole.  In the obsolescent usage where a type of
2406 @code{int} is implied by the absence of type specifiers, such a list of
2407 specifiers and qualifiers may be an attribute specifier list with no
2408 other specifiers or qualifiers.
2409
2410 An attribute specifier list may appear immediately before a declarator
2411 (other than the first) in a comma-separated list of declarators in a
2412 declaration of more than one identifier using a single list of
2413 specifiers and qualifiers.  Such attribute specifiers apply
2414 only to the identifier before whose declarator they appear.  For
2415 example, in
2416
2417 @smallexample
2418 __attribute__((noreturn)) void d0 (void),
2419     __attribute__((format(printf, 1, 2))) d1 (const char *, ...),
2420      d2 (void)
2421 @end smallexample
2422
2423 @noindent
2424 the @code{noreturn} attribute applies to all the functions
2425 declared; the @code{format} attribute only applies to @code{d1}.
2426
2427 An attribute specifier list may appear immediately before the comma,
2428 @code{=} or semicolon terminating the declaration of an identifier other
2429 than a function definition.  At present, such attribute specifiers apply
2430 to the declared object or function, but in future they may attach to the
2431 outermost adjacent declarator.  In simple cases there is no difference,
2432 but, for example, in
2433
2434 @smallexample
2435 void (****f)(void) __attribute__((noreturn));
2436 @end smallexample
2437
2438 @noindent
2439 at present the @code{noreturn} attribute applies to @code{f}, which
2440 causes a warning since @code{f} is not a function, but in future it may
2441 apply to the function @code{****f}.  The precise semantics of what
2442 attributes in such cases will apply to are not yet specified.  Where an
2443 assembler name for an object or function is specified (@pxref{Asm
2444 Labels}), at present the attribute must follow the @code{asm}
2445 specification; in future, attributes before the @code{asm} specification
2446 may apply to the adjacent declarator, and those after it to the declared
2447 object or function.
2448
2449 An attribute specifier list may, in future, be permitted to appear after
2450 the declarator in a function definition (before any old-style parameter
2451 declarations or the function body).
2452
2453 Attribute specifiers may be mixed with type qualifiers appearing inside
2454 the @code{[]} of a parameter array declarator, in the C99 construct by
2455 which such qualifiers are applied to the pointer to which the array is
2456 implicitly converted.  Such attribute specifiers apply to the pointer,
2457 not to the array, but at present this is not implemented and they are
2458 ignored.
2459
2460 An attribute specifier list may appear at the start of a nested
2461 declarator.  At present, there are some limitations in this usage: the
2462 attributes correctly apply to the declarator, but for most individual
2463 attributes the semantics this implies are not implemented.
2464 When attribute specifiers follow the @code{*} of a pointer
2465 declarator, they may be mixed with any type qualifiers present.
2466 The following describes the formal semantics of this syntax.  It will make the
2467 most sense if you are familiar with the formal specification of
2468 declarators in the ISO C standard.
2469
2470 Consider (as in C99 subclause 6.7.5 paragraph 4) a declaration @code{T
2471 D1}, where @code{T} contains declaration specifiers that specify a type
2472 @var{Type} (such as @code{int}) and @code{D1} is a declarator that
2473 contains an identifier @var{ident}.  The type specified for @var{ident}
2474 for derived declarators whose type does not include an attribute
2475 specifier is as in the ISO C standard.
2476
2477 If @code{D1} has the form @code{( @var{attribute-specifier-list} D )},
2478 and the declaration @code{T D} specifies the type
2479 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
2480 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
2481 @var{attribute-specifier-list} @var{Type}'' for @var{ident}.
2482
2483 If @code{D1} has the form @code{*
2484 @var{type-qualifier-and-attribute-specifier-list} D}, and the
2485 declaration @code{T D} specifies the type
2486 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
2487 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
2488 @var{type-qualifier-and-attribute-specifier-list} @var{Type}'' for
2489 @var{ident}.
2490
2491 For example,
2492
2493 @smallexample
2494 void (__attribute__((noreturn)) ****f) (void);
2495 @end smallexample
2496
2497 @noindent
2498 specifies the type ``pointer to pointer to pointer to pointer to
2499 non-returning function returning @code{void}''.  As another example,
2500
2501 @smallexample
2502 char *__attribute__((aligned(8))) *f;
2503 @end smallexample
2504
2505 @noindent
2506 specifies the type ``pointer to 8-byte-aligned pointer to @code{char}''.
2507 Note again that this does not work with most attributes; for example,
2508 the usage of @samp{aligned} and @samp{noreturn} attributes given above
2509 is not yet supported.
2510
2511 For compatibility with existing code written for compiler versions that
2512 did not implement attributes on nested declarators, some laxity is
2513 allowed in the placing of attributes.  If an attribute that only applies
2514 to types is applied to a declaration, it will be treated as applying to
2515 the type of that declaration.  If an attribute that only applies to
2516 declarations is applied to the type of a declaration, it will be treated
2517 as applying to that declaration; and, for compatibility with code
2518 placing the attributes immediately before the identifier declared, such
2519 an attribute applied to a function return type will be treated as
2520 applying to the function type, and such an attribute applied to an array
2521 element type will be treated as applying to the array type.  If an
2522 attribute that only applies to function types is applied to a
2523 pointer-to-function type, it will be treated as applying to the pointer
2524 target type; if such an attribute is applied to a function return type
2525 that is not a pointer-to-function type, it will be treated as applying
2526 to the function type.
2527
2528 @node Function Prototypes
2529 @section Prototypes and Old-Style Function Definitions
2530 @cindex function prototype declarations
2531 @cindex old-style function definitions
2532 @cindex promotion of formal parameters
2533
2534 GNU C extends ISO C to allow a function prototype to override a later
2535 old-style non-prototype definition.  Consider the following example:
2536
2537 @smallexample
2538 /* @r{Use prototypes unless the compiler is old-fashioned.}  */
2539 #ifdef __STDC__
2540 #define P(x) x
2541 #else
2542 #define P(x) ()
2543 #endif
2544
2545 /* @r{Prototype function declaration.}  */
2546 int isroot P((uid_t));
2547
2548 /* @r{Old-style function definition.}  */
2549 int
2550 isroot (x)   /* ??? lossage here ??? */
2551      uid_t x;
2552 @{
2553   return x == 0;
2554 @}
2555 @end smallexample
2556
2557 Suppose the type @code{uid_t} happens to be @code{short}.  ISO C does
2558 not allow this example, because subword arguments in old-style
2559 non-prototype definitions are promoted.  Therefore in this example the
2560 function definition's argument is really an @code{int}, which does not
2561 match the prototype argument type of @code{short}.
2562
2563 This restriction of ISO C makes it hard to write code that is portable
2564 to traditional C compilers, because the programmer does not know
2565 whether the @code{uid_t} type is @code{short}, @code{int}, or
2566 @code{long}.  Therefore, in cases like these GNU C allows a prototype
2567 to override a later old-style definition.  More precisely, in GNU C, a
2568 function prototype argument type overrides the argument type specified
2569 by a later old-style definition if the former type is the same as the
2570 latter type before promotion.  Thus in GNU C the above example is
2571 equivalent to the following:
2572
2573 @smallexample
2574 int isroot (uid_t);
2575
2576 int
2577 isroot (uid_t x)
2578 @{
2579   return x == 0;
2580 @}
2581 @end smallexample
2582
2583 @noindent
2584 GNU C++ does not support old-style function definitions, so this
2585 extension is irrelevant.
2586
2587 @node C++ Comments
2588 @section C++ Style Comments
2589 @cindex //
2590 @cindex C++ comments
2591 @cindex comments, C++ style
2592
2593 In GNU C, you may use C++ style comments, which start with @samp{//} and
2594 continue until the end of the line.  Many other C implementations allow
2595 such comments, and they are included in the 1999 C standard.  However,
2596 C++ style comments are not recognized if you specify an @option{-std}
2597 option specifying a version of ISO C before C99, or @option{-ansi}
2598 (equivalent to @option{-std=c89}).
2599
2600 @node Dollar Signs
2601 @section Dollar Signs in Identifier Names
2602 @cindex $
2603 @cindex dollar signs in identifier names
2604 @cindex identifier names, dollar signs in
2605
2606 In GNU C, you may normally use dollar signs in identifier names.
2607 This is because many traditional C implementations allow such identifiers.
2608 However, dollar signs in identifiers are not supported on a few target
2609 machines, typically because the target assembler does not allow them.
2610
2611 @node Character Escapes
2612 @section The Character @key{ESC} in Constants
2613
2614 You can use the sequence @samp{\e} in a string or character constant to
2615 stand for the ASCII character @key{ESC}.
2616
2617 @node Alignment
2618 @section Inquiring on Alignment of Types or Variables
2619 @cindex alignment
2620 @cindex type alignment
2621 @cindex variable alignment
2622
2623 The keyword @code{__alignof__} allows you to inquire about how an object
2624 is aligned, or the minimum alignment usually required by a type.  Its
2625 syntax is just like @code{sizeof}.
2626
2627 For example, if the target machine requires a @code{double} value to be
2628 aligned on an 8-byte boundary, then @code{__alignof__ (double)} is 8.
2629 This is true on many RISC machines.  On more traditional machine
2630 designs, @code{__alignof__ (double)} is 4 or even 2.
2631
2632 Some machines never actually require alignment; they allow reference to any
2633 data type even at an odd address.  For these machines, @code{__alignof__}
2634 reports the @emph{recommended} alignment of a type.
2635
2636 If the operand of @code{__alignof__} is an lvalue rather than a type,
2637 its value is the required alignment for its type, taking into account
2638 any minimum alignment specified with GCC's @code{__attribute__}
2639 extension (@pxref{Variable Attributes}).  For example, after this
2640 declaration:
2641
2642 @smallexample
2643 struct foo @{ int x; char y; @} foo1;
2644 @end smallexample
2645
2646 @noindent
2647 the value of @code{__alignof__ (foo1.y)} is 1, even though its actual
2648 alignment is probably 2 or 4, the same as @code{__alignof__ (int)}.
2649
2650 It is an error to ask for the alignment of an incomplete type.
2651
2652 @node Variable Attributes
2653 @section Specifying Attributes of Variables
2654 @cindex attribute of variables
2655 @cindex variable attributes
2656
2657 The keyword @code{__attribute__} allows you to specify special
2658 attributes of variables or structure fields.  This keyword is followed
2659 by an attribute specification inside double parentheses.  Some
2660 attributes are currently defined generically for variables.
2661 Other attributes are defined for variables on particular target
2662 systems.  Other attributes are available for functions
2663 (@pxref{Function Attributes}) and for types (@pxref{Type Attributes}).
2664 Other front ends might define more attributes
2665 (@pxref{C++ Extensions,,Extensions to the C++ Language}).
2666
2667 You may also specify attributes with @samp{__} preceding and following
2668 each keyword.  This allows you to use them in header files without
2669 being concerned about a possible macro of the same name.  For example,
2670 you may use @code{__aligned__} instead of @code{aligned}.
2671
2672 @xref{Attribute Syntax}, for details of the exact syntax for using
2673 attributes.
2674
2675 @table @code
2676 @cindex @code{aligned} attribute
2677 @item aligned (@var{alignment})
2678 This attribute specifies a minimum alignment for the variable or
2679 structure field, measured in bytes.  For example, the declaration:
2680
2681 @smallexample
2682 int x __attribute__ ((aligned (16))) = 0;
2683 @end smallexample
2684
2685 @noindent
2686 causes the compiler to allocate the global variable @code{x} on a
2687 16-byte boundary.  On a 68040, this could be used in conjunction with
2688 an @code{asm} expression to access the @code{move16} instruction which
2689 requires 16-byte aligned operands.
2690
2691 You can also specify the alignment of structure fields.  For example, to
2692 create a double-word aligned @code{int} pair, you could write:
2693
2694 @smallexample
2695 struct foo @{ int x[2] __attribute__ ((aligned (8))); @};
2696 @end smallexample
2697
2698 @noindent
2699 This is an alternative to creating a union with a @code{double} member
2700 that forces the union to be double-word aligned.
2701
2702 As in the preceding examples, you can explicitly specify the alignment
2703 (in bytes) that you wish the compiler to use for a given variable or
2704 structure field.  Alternatively, you can leave out the alignment factor
2705 and just ask the compiler to align a variable or field to the maximum
2706 useful alignment for the target machine you are compiling for.  For
2707 example, you could write:
2708
2709 @smallexample
2710 short array[3] __attribute__ ((aligned));
2711 @end smallexample
2712
2713 Whenever you leave out the alignment factor in an @code{aligned} attribute
2714 specification, the compiler automatically sets the alignment for the declared
2715 variable or field to the largest alignment which is ever used for any data
2716 type on the target machine you are compiling for.  Doing this can often make
2717 copy operations more efficient, because the compiler can use whatever
2718 instructions copy the biggest chunks of memory when performing copies to
2719 or from the variables or fields that you have aligned this way.
2720
2721 The @code{aligned} attribute can only increase the alignment; but you
2722 can decrease it by specifying @code{packed} as well.  See below.
2723
2724 Note that the effectiveness of @code{aligned} attributes may be limited
2725 by inherent limitations in your linker.  On many systems, the linker is
2726 only able to arrange for variables to be aligned up to a certain maximum
2727 alignment.  (For some linkers, the maximum supported alignment may
2728 be very very small.)  If your linker is only able to align variables
2729 up to a maximum of 8 byte alignment, then specifying @code{aligned(16)}
2730 in an @code{__attribute__} will still only provide you with 8 byte
2731 alignment.  See your linker documentation for further information.
2732
2733 @item cleanup (@var{cleanup_function})
2734 @cindex @code{cleanup} attribute
2735 The @code{cleanup} attribute runs a function when the variable goes
2736 out of scope.  This attribute can only be applied to auto function
2737 scope variables; it may not be applied to parameters or variables
2738 with static storage duration.  The function must take one parameter,
2739 a pointer to a type compatible with the variable.  The return value
2740 of the function (if any) is ignored.
2741
2742 If @option{-fexceptions} is enabled, then @var{cleanup_function}
2743 will be run during the stack unwinding that happens during the
2744 processing of the exception.  Note that the @code{cleanup} attribute
2745 does not allow the exception to be caught, only to perform an action.
2746 It is undefined what happens if @var{cleanup_function} does not
2747 return normally.
2748
2749 @item common
2750 @itemx nocommon
2751 @cindex @code{common} attribute
2752 @cindex @code{nocommon} attribute
2753 @opindex fcommon
2754 @opindex fno-common
2755 The @code{common} attribute requests GCC to place a variable in
2756 ``common'' storage.  The @code{nocommon} attribute requests the
2757 opposite -- to allocate space for it directly.
2758
2759 These attributes override the default chosen by the
2760 @option{-fno-common} and @option{-fcommon} flags respectively.
2761
2762 @item deprecated
2763 @cindex @code{deprecated} attribute
2764 The @code{deprecated} attribute results in a warning if the variable
2765 is used anywhere in the source file.  This is useful when identifying
2766 variables that are expected to be removed in a future version of a
2767 program.  The warning also includes the location of the declaration
2768 of the deprecated variable, to enable users to easily find further
2769 information about why the variable is deprecated, or what they should
2770 do instead.  Note that the warning only occurs for uses:
2771
2772 @smallexample
2773 extern int old_var __attribute__ ((deprecated));
2774 extern int old_var;
2775 int new_fn () @{ return old_var; @}
2776 @end smallexample
2777
2778 results in a warning on line 3 but not line 2.
2779
2780 The @code{deprecated} attribute can also be used for functions and
2781 types (@pxref{Function Attributes}, @pxref{Type Attributes}.)
2782
2783 @item mode (@var{mode})
2784 @cindex @code{mode} attribute
2785 This attribute specifies the data type for the declaration---whichever
2786 type corresponds to the mode @var{mode}.  This in effect lets you
2787 request an integer or floating point type according to its width.
2788
2789 You may also specify a mode of @samp{byte} or @samp{__byte__} to
2790 indicate the mode corresponding to a one-byte integer, @samp{word} or
2791 @samp{__word__} for the mode of a one-word integer, and @samp{pointer}
2792 or @samp{__pointer__} for the mode used to represent pointers.
2793
2794 @item packed
2795 @cindex @code{packed} attribute
2796 The @code{packed} attribute specifies that a variable or structure field
2797 should have the smallest possible alignment---one byte for a variable,
2798 and one bit for a field, unless you specify a larger value with the
2799 @code{aligned} attribute.
2800
2801 Here is a structure in which the field @code{x} is packed, so that it
2802 immediately follows @code{a}:
2803
2804 @smallexample
2805 struct foo
2806 @{
2807   char a;
2808   int x[2] __attribute__ ((packed));
2809 @};
2810 @end smallexample
2811
2812 @item section ("@var{section-name}")
2813 @cindex @code{section} variable attribute
2814 Normally, the compiler places the objects it generates in sections like
2815 @code{data} and @code{bss}.  Sometimes, however, you need additional sections,
2816 or you need certain particular variables to appear in special sections,
2817 for example to map to special hardware.  The @code{section}
2818 attribute specifies that a variable (or function) lives in a particular
2819 section.  For example, this small program uses several specific section names:
2820
2821 @smallexample
2822 struct duart a __attribute__ ((section ("DUART_A"))) = @{ 0 @};
2823 struct duart b __attribute__ ((section ("DUART_B"))) = @{ 0 @};
2824 char stack[10000] __attribute__ ((section ("STACK"))) = @{ 0 @};
2825 int init_data __attribute__ ((section ("INITDATA"))) = 0;
2826
2827 main()
2828 @{
2829   /* Initialize stack pointer */
2830   init_sp (stack + sizeof (stack));
2831
2832   /* Initialize initialized data */
2833   memcpy (&init_data, &data, &edata - &data);
2834
2835   /* Turn on the serial ports */
2836   init_duart (&a);
2837   init_duart (&b);
2838 @}
2839 @end smallexample
2840
2841 @noindent
2842 Use the @code{section} attribute with an @emph{initialized} definition
2843 of a @emph{global} variable, as shown in the example.  GCC issues
2844 a warning and otherwise ignores the @code{section} attribute in
2845 uninitialized variable declarations.
2846
2847 You may only use the @code{section} attribute with a fully initialized
2848 global definition because of the way linkers work.  The linker requires
2849 each object be defined once, with the exception that uninitialized
2850 variables tentatively go in the @code{common} (or @code{bss}) section
2851 and can be multiply ``defined''.  You can force a variable to be
2852 initialized with the @option{-fno-common} flag or the @code{nocommon}
2853 attribute.
2854
2855 Some file formats do not support arbitrary sections so the @code{section}
2856 attribute is not available on all platforms.
2857 If you need to map the entire contents of a module to a particular
2858 section, consider using the facilities of the linker instead.
2859
2860 @item shared
2861 @cindex @code{shared} variable attribute
2862 On Microsoft Windows, in addition to putting variable definitions in a named
2863 section, the section can also be shared among all running copies of an
2864 executable or DLL@.  For example, this small program defines shared data
2865 by putting it in a named section @code{shared} and marking the section
2866 shareable:
2867
2868 @smallexample
2869 int foo __attribute__((section ("shared"), shared)) = 0;
2870
2871 int
2872 main()
2873 @{
2874   /* Read and write foo.  All running
2875      copies see the same value.  */
2876   return 0;
2877 @}
2878 @end smallexample
2879
2880 @noindent
2881 You may only use the @code{shared} attribute along with @code{section}
2882 attribute with a fully initialized global definition because of the way
2883 linkers work.  See @code{section} attribute for more information.
2884
2885 The @code{shared} attribute is only available on Microsoft Windows@.
2886
2887 @item tls_model ("@var{tls_model}")
2888 @cindex @code{tls_model} attribute
2889 The @code{tls_model} attribute sets thread-local storage model
2890 (@pxref{Thread-Local}) of a particular @code{__thread} variable,
2891 overriding @code{-ftls-model=} command line switch on a per-variable
2892 basis.
2893 The @var{tls_model} argument should be one of @code{global-dynamic},
2894 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
2895
2896 Not all targets support this attribute.
2897
2898 @item transparent_union
2899 This attribute, attached to a function parameter which is a union, means
2900 that the corresponding argument may have the type of any union member,
2901 but the argument is passed as if its type were that of the first union
2902 member.  For more details see @xref{Type Attributes}.  You can also use
2903 this attribute on a @code{typedef} for a union data type; then it
2904 applies to all function parameters with that type.
2905
2906 @item unused
2907 This attribute, attached to a variable, means that the variable is meant
2908 to be possibly unused.  GCC will not produce a warning for this
2909 variable.
2910
2911 @item vector_size (@var{bytes})
2912 This attribute specifies the vector size for the variable, measured in
2913 bytes.  For example, the declaration:
2914
2915 @smallexample
2916 int foo __attribute__ ((vector_size (16)));
2917 @end smallexample
2918
2919 @noindent
2920 causes the compiler to set the mode for @code{foo}, to be 16 bytes,
2921 divided into @code{int} sized units.  Assuming a 32-bit int (a vector of
2922 4 units of 4 bytes), the corresponding mode of @code{foo} will be V4SI@.
2923
2924 This attribute is only applicable to integral and float scalars,
2925 although arrays, pointers, and function return values are allowed in
2926 conjunction with this construct.
2927
2928 Aggregates with this attribute are invalid, even if they are of the same
2929 size as a corresponding scalar.  For example, the declaration:
2930
2931 @smallexample
2932 struct S @{ int a; @};
2933 struct S  __attribute__ ((vector_size (16))) foo;
2934 @end smallexample
2935
2936 @noindent
2937 is invalid even if the size of the structure is the same as the size of
2938 the @code{int}.
2939
2940 @item weak
2941 The @code{weak} attribute is described in @xref{Function Attributes}.
2942
2943 @item dllimport
2944 The @code{dllimport} attribute is described in @xref{Function Attributes}.
2945
2946 @item dlexport
2947 The @code{dllexport} attribute is described in @xref{Function Attributes}.
2948
2949 @end table
2950
2951 @subsection M32R/D Variable Attributes
2952
2953 One attribute is currently defined for the M32R/D.
2954
2955 @table @code
2956 @item model (@var{model-name})
2957 @cindex variable addressability on the M32R/D
2958 Use this attribute on the M32R/D to set the addressability of an object.
2959 The identifier @var{model-name} is one of @code{small}, @code{medium},
2960 or @code{large}, representing each of the code models.
2961
2962 Small model objects live in the lower 16MB of memory (so that their
2963 addresses can be loaded with the @code{ld24} instruction).
2964
2965 Medium and large model objects may live anywhere in the 32-bit address space
2966 (the compiler will generate @code{seth/add3} instructions to load their
2967 addresses).
2968 @end table
2969
2970 @subsection i386 Variable Attributes
2971
2972 Two attributes are currently defined for i386 configurations:
2973 @code{ms_struct} and @code{gcc_struct}
2974
2975 @table @code
2976 @item ms_struct
2977 @itemx gcc_struct
2978 @cindex @code{ms_struct} attribute
2979 @cindex @code{gcc_struct} attribute
2980
2981 If @code{packed} is used on a structure, or if bit-fields are used
2982 it may be that the Microsoft ABI packs them differently
2983 than GCC would normally pack them.  Particularly when moving packed
2984 data between functions compiled with GCC and the native Microsoft compiler
2985 (either via function call or as data in a file), it may be necessary to access
2986 either format.
2987
2988 Currently @option{-m[no-]ms-bitfields} is provided for the Microsoft Windows X86
2989 compilers to match the native Microsoft compiler.
2990 @end table
2991
2992 @subsection Xstormy16 Variable Attributes
2993
2994 One attribute is currently defined for xstormy16 configurations:
2995 @code{below100}
2996
2997 @table @code
2998 @item below100
2999 @cindex @code{below100} attribute
3000
3001 If a variable has the @code{below100} attribute (@code{BELOW100} is
3002 allowed also), GCC will place the variable in the first 0x100 bytes of
3003 memory and use special opcodes to access it.  Such variables will be
3004 placed in either the @code{.bss_below100} section or the
3005 @code{.data_below100} section.
3006
3007 @end table
3008
3009 @node Type Attributes
3010 @section Specifying Attributes of Types
3011 @cindex attribute of types
3012 @cindex type attributes
3013
3014 The keyword @code{__attribute__} allows you to specify special
3015 attributes of @code{struct} and @code{union} types when you define such
3016 types.  This keyword is followed by an attribute specification inside
3017 double parentheses.  Six attributes are currently defined for types:
3018 @code{aligned}, @code{packed}, @code{transparent_union}, @code{unused},
3019 @code{deprecated} and @code{may_alias}.  Other attributes are defined for
3020 functions (@pxref{Function Attributes}) and for variables
3021 (@pxref{Variable Attributes}).
3022
3023 You may also specify any one of these attributes with @samp{__}
3024 preceding and following its keyword.  This allows you to use these
3025 attributes in header files without being concerned about a possible
3026 macro of the same name.  For example, you may use @code{__aligned__}
3027 instead of @code{aligned}.
3028
3029 You may specify the @code{aligned} and @code{transparent_union}
3030 attributes either in a @code{typedef} declaration or just past the
3031 closing curly brace of a complete enum, struct or union type
3032 @emph{definition} and the @code{packed} attribute only past the closing
3033 brace of a definition.
3034
3035 You may also specify attributes between the enum, struct or union
3036 tag and the name of the type rather than after the closing brace.
3037
3038 @xref{Attribute Syntax}, for details of the exact syntax for using
3039 attributes.
3040
3041 @table @code
3042 @cindex @code{aligned} attribute
3043 @item aligned (@var{alignment})
3044 This attribute specifies a minimum alignment (in bytes) for variables
3045 of the specified type.  For example, the declarations:
3046
3047 @smallexample
3048 struct S @{ short f[3]; @} __attribute__ ((aligned (8)));
3049 typedef int more_aligned_int __attribute__ ((aligned (8)));
3050 @end smallexample
3051
3052 @noindent
3053 force the compiler to insure (as far as it can) that each variable whose
3054 type is @code{struct S} or @code{more_aligned_int} will be allocated and
3055 aligned @emph{at least} on a 8-byte boundary.  On a SPARC, having all
3056 variables of type @code{struct S} aligned to 8-byte boundaries allows
3057 the compiler to use the @code{ldd} and @code{std} (doubleword load and
3058 store) instructions when copying one variable of type @code{struct S} to
3059 another, thus improving run-time efficiency.
3060
3061 Note that the alignment of any given @code{struct} or @code{union} type
3062 is required by the ISO C standard to be at least a perfect multiple of
3063 the lowest common multiple of the alignments of all of the members of
3064 the @code{struct} or @code{union} in question.  This means that you @emph{can}
3065 effectively adjust the alignment of a @code{struct} or @code{union}
3066 type by attaching an @code{aligned} attribute to any one of the members
3067 of such a type, but the notation illustrated in the example above is a
3068 more obvious, intuitive, and readable way to request the compiler to
3069 adjust the alignment of an entire @code{struct} or @code{union} type.
3070
3071 As in the preceding example, you can explicitly specify the alignment
3072 (in bytes) that you wish the compiler to use for a given @code{struct}
3073 or @code{union} type.  Alternatively, you can leave out the alignment factor
3074 and just ask the compiler to align a type to the maximum
3075 useful alignment for the target machine you are compiling for.  For
3076 example, you could write:
3077
3078 @smallexample
3079 struct S @{ short f[3]; @} __attribute__ ((aligned));
3080 @end smallexample
3081
3082 Whenever you leave out the alignment factor in an @code{aligned}
3083 attribute specification, the compiler automatically sets the alignment
3084 for the type to the largest alignment which is ever used for any data
3085 type on the target machine you are compiling for.  Doing this can often
3086 make copy operations more efficient, because the compiler can use
3087 whatever instructions copy the biggest chunks of memory when performing
3088 copies to or from the variables which have types that you have aligned
3089 this way.
3090
3091 In the example above, if the size of each @code{short} is 2 bytes, then
3092 the size of the entire @code{struct S} type is 6 bytes.  The smallest
3093 power of two which is greater than or equal to that is 8, so the
3094 compiler sets the alignment for the entire @code{struct S} type to 8
3095 bytes.
3096
3097 Note that although you can ask the compiler to select a time-efficient
3098 alignment for a given type and then declare only individual stand-alone
3099 objects of that type, the compiler's ability to select a time-efficient
3100 alignment is primarily useful only when you plan to create arrays of
3101 variables having the relevant (efficiently aligned) type.  If you
3102 declare or use arrays of variables of an efficiently-aligned type, then
3103 it is likely that your program will also be doing pointer arithmetic (or
3104 subscripting, which amounts to the same thing) on pointers to the
3105 relevant type, and the code that the compiler generates for these
3106 pointer arithmetic operations will often be more efficient for
3107 efficiently-aligned types than for other types.
3108
3109 The @code{aligned} attribute can only increase the alignment; but you
3110 can decrease it by specifying @code{packed} as well.  See below.
3111
3112 Note that the effectiveness of @code{aligned} attributes may be limited
3113 by inherent limitations in your linker.  On many systems, the linker is
3114 only able to arrange for variables to be aligned up to a certain maximum
3115 alignment.  (For some linkers, the maximum supported alignment may
3116 be very very small.)  If your linker is only able to align variables
3117 up to a maximum of 8 byte alignment, then specifying @code{aligned(16)}
3118 in an @code{__attribute__} will still only provide you with 8 byte
3119 alignment.  See your linker documentation for further information.
3120
3121 @item packed
3122 This attribute, attached to @code{struct} or @code{union} type
3123 definition, specifies that each member of the structure or union is
3124 placed to minimize the memory required. When attached to an @code{enum}
3125 definition, it indicates that the smallest integral type should be used.
3126
3127 @opindex fshort-enums
3128 Specifying this attribute for @code{struct} and @code{union} types is
3129 equivalent to specifying the @code{packed} attribute on each of the
3130 structure or union members.  Specifying the @option{-fshort-enums}
3131 flag on the line is equivalent to specifying the @code{packed}
3132 attribute on all @code{enum} definitions.
3133
3134 In the following example @code{struct my_packed_struct}'s members are
3135 packed closely together, but the internal layout of its @code{s} member
3136 is not packed -- to do that, @code{struct my_unpacked_struct} would need to
3137 be packed too.
3138
3139 @smallexample
3140 struct my_unpacked_struct
3141  @{
3142     char c;
3143     int i;
3144  @};
3145
3146 struct my_packed_struct __attribute__ ((__packed__))
3147   @{
3148      char c;
3149      int  i;
3150      struct my_unpacked_struct s;
3151   @};
3152 @end smallexample
3153
3154 You may only specify this attribute on the definition of a @code{enum},
3155 @code{struct} or @code{union}, not on a @code{typedef} which does not
3156 also define the enumerated type, structure or union.
3157
3158 @item transparent_union
3159 This attribute, attached to a @code{union} type definition, indicates
3160 that any function parameter having that union type causes calls to that
3161 function to be treated in a special way.
3162
3163 First, the argument corresponding to a transparent union type can be of
3164 any type in the union; no cast is required.  Also, if the union contains
3165 a pointer type, the corresponding argument can be a null pointer
3166 constant or a void pointer expression; and if the union contains a void
3167 pointer type, the corresponding argument can be any pointer expression.
3168 If the union member type is a pointer, qualifiers like @code{const} on
3169 the referenced type must be respected, just as with normal pointer
3170 conversions.
3171
3172 Second, the argument is passed to the function using the calling
3173 conventions of the first member of the transparent union, not the calling
3174 conventions of the union itself.  All members of the union must have the
3175 same machine representation; this is necessary for this argument passing
3176 to work properly.
3177
3178 Transparent unions are designed for library functions that have multiple
3179 interfaces for compatibility reasons.  For example, suppose the
3180 @code{wait} function must accept either a value of type @code{int *} to
3181 comply with Posix, or a value of type @code{union wait *} to comply with
3182 the 4.1BSD interface.  If @code{wait}'s parameter were @code{void *},
3183 @code{wait} would accept both kinds of arguments, but it would also
3184 accept any other pointer type and this would make argument type checking
3185 less useful.  Instead, @code{<sys/wait.h>} might define the interface
3186 as follows:
3187
3188 @smallexample
3189 typedef union
3190   @{
3191     int *__ip;
3192     union wait *__up;
3193   @} wait_status_ptr_t __attribute__ ((__transparent_union__));
3194
3195 pid_t wait (wait_status_ptr_t);
3196 @end smallexample
3197
3198 This interface allows either @code{int *} or @code{union wait *}
3199 arguments to be passed, using the @code{int *} calling convention.
3200 The program can call @code{wait} with arguments of either type:
3201
3202 @smallexample
3203 int w1 () @{ int w; return wait (&w); @}
3204 int w2 () @{ union wait w; return wait (&w); @}
3205 @end smallexample
3206
3207 With this interface, @code{wait}'s implementation might look like this:
3208
3209 @smallexample
3210 pid_t wait (wait_status_ptr_t p)
3211 @{
3212   return waitpid (-1, p.__ip, 0);
3213 @}
3214 @end smallexample
3215
3216 @item unused
3217 When attached to a type (including a @code{union} or a @code{struct}),
3218 this attribute means that variables of that type are meant to appear
3219 possibly unused.  GCC will not produce a warning for any variables of
3220 that type, even if the variable appears to do nothing.  This is often
3221 the case with lock or thread classes, which are usually defined and then
3222 not referenced, but contain constructors and destructors that have
3223 nontrivial bookkeeping functions.
3224
3225 @item deprecated
3226 The @code{deprecated} attribute results in a warning if the type
3227 is used anywhere in the source file.  This is useful when identifying
3228 types that are expected to be removed in a future version of a program.
3229 If possible, the warning also includes the location of the declaration
3230 of the deprecated type, to enable users to easily find further
3231 information about why the type is deprecated, or what they should do
3232 instead.  Note that the warnings only occur for uses and then only
3233 if the type is being applied to an identifier that itself is not being
3234 declared as deprecated.
3235
3236 @smallexample
3237 typedef int T1 __attribute__ ((deprecated));
3238 T1 x;
3239 typedef T1 T2;
3240 T2 y;
3241 typedef T1 T3 __attribute__ ((deprecated));
3242 T3 z __attribute__ ((deprecated));
3243 @end smallexample
3244
3245 results in a warning on line 2 and 3 but not lines 4, 5, or 6.  No
3246 warning is issued for line 4 because T2 is not explicitly
3247 deprecated.  Line 5 has no warning because T3 is explicitly
3248 deprecated.  Similarly for line 6.
3249
3250 The @code{deprecated} attribute can also be used for functions and
3251 variables (@pxref{Function Attributes}, @pxref{Variable Attributes}.)
3252
3253 @item may_alias
3254 Accesses to objects with types with this attribute are not subjected to
3255 type-based alias analysis, but are instead assumed to be able to alias
3256 any other type of objects, just like the @code{char} type.  See
3257 @option{-fstrict-aliasing} for more information on aliasing issues.
3258
3259 Example of use:
3260
3261 @smallexample
3262 typedef short __attribute__((__may_alias__)) short_a;
3263
3264 int
3265 main (void)
3266 @{
3267   int a = 0x12345678;
3268   short_a *b = (short_a *) &a;
3269
3270   b[1] = 0;
3271
3272   if (a == 0x12345678)
3273     abort();
3274
3275   exit(0);
3276 @}
3277 @end smallexample
3278
3279 If you replaced @code{short_a} with @code{short} in the variable
3280 declaration, the above program would abort when compiled with
3281 @option{-fstrict-aliasing}, which is on by default at @option{-O2} or
3282 above in recent GCC versions.
3283
3284 @subsection i386 Type Attributes
3285
3286 Two attributes are currently defined for i386 configurations:
3287 @code{ms_struct} and @code{gcc_struct}
3288
3289 @item ms_struct
3290 @itemx gcc_struct
3291 @cindex @code{ms_struct}
3292 @cindex @code{gcc_struct}
3293
3294 If @code{packed} is used on a structure, or if bit-fields are used
3295 it may be that the Microsoft ABI packs them differently
3296 than GCC would normally pack them.  Particularly when moving packed
3297 data between functions compiled with GCC and the native Microsoft compiler
3298 (either via function call or as data in a file), it may be necessary to access
3299 either format.
3300
3301 Currently @option{-m[no-]ms-bitfields} is provided for the Microsoft Windows X86
3302 compilers to match the native Microsoft compiler.
3303 @end table
3304
3305 To specify multiple attributes, separate them by commas within the
3306 double parentheses: for example, @samp{__attribute__ ((aligned (16),
3307 packed))}.
3308
3309 @node Inline
3310 @section An Inline Function is As Fast As a Macro
3311 @cindex inline functions
3312 @cindex integrating function code
3313 @cindex open coding
3314 @cindex macros, inline alternative
3315
3316 By declaring a function @code{inline}, you can direct GCC to
3317 integrate that function's code into the code for its callers.  This
3318 makes execution faster by eliminating the function-call overhead; in
3319 addition, if any of the actual argument values are constant, their known
3320 values may permit simplifications at compile time so that not all of the
3321 inline function's code needs to be included.  The effect on code size is
3322 less predictable; object code may be larger or smaller with function
3323 inlining, depending on the particular case.  Inlining of functions is an
3324 optimization and it really ``works'' only in optimizing compilation.  If
3325 you don't use @option{-O}, no function is really inline.
3326
3327 Inline functions are included in the ISO C99 standard, but there are
3328 currently substantial differences between what GCC implements and what
3329 the ISO C99 standard requires.
3330
3331 To declare a function inline, use the @code{inline} keyword in its
3332 declaration, like this:
3333
3334 @smallexample
3335 inline int
3336 inc (int *a)
3337 @{
3338   (*a)++;
3339 @}
3340 @end smallexample
3341
3342 (If you are writing a header file to be included in ISO C programs, write
3343 @code{__inline__} instead of @code{inline}.  @xref{Alternate Keywords}.)
3344 You can also make all ``simple enough'' functions inline with the option
3345 @option{-finline-functions}.
3346
3347 @opindex Winline
3348 Note that certain usages in a function definition can make it unsuitable
3349 for inline substitution.  Among these usages are: use of varargs, use of
3350 alloca, use of variable sized data types (@pxref{Variable Length}),
3351 use of computed goto (@pxref{Labels as Values}), use of nonlocal goto,
3352 and nested functions (@pxref{Nested Functions}).  Using @option{-Winline}
3353 will warn when a function marked @code{inline} could not be substituted,
3354 and will give the reason for the failure.
3355
3356 Note that in C and Objective-C, unlike C++, the @code{inline} keyword
3357 does not affect the linkage of the function.
3358
3359 @cindex automatic @code{inline} for C++ member fns
3360 @cindex @code{inline} automatic for C++ member fns
3361 @cindex member fns, automatically @code{inline}
3362 @cindex C++ member fns, automatically @code{inline}
3363 @opindex fno-default-inline
3364 GCC automatically inlines member functions defined within the class
3365 body of C++ programs even if they are not explicitly declared
3366 @code{inline}.  (You can override this with @option{-fno-default-inline};
3367 @pxref{C++ Dialect Options,,Options Controlling C++ Dialect}.)
3368
3369 @cindex inline functions, omission of
3370 @opindex fkeep-inline-functions
3371 When a function is both inline and @code{static}, if all calls to the
3372 function are integrated into the caller, and the function's address is
3373 never used, then the function's own assembler code is never referenced.
3374 In this case, GCC does not actually output assembler code for the
3375 function, unless you specify the option @option{-fkeep-inline-functions}.
3376 Some calls cannot be integrated for various reasons (in particular,
3377 calls that precede the function's definition cannot be integrated, and
3378 neither can recursive calls within the definition).  If there is a
3379 nonintegrated call, then the function is compiled to assembler code as
3380 usual.  The function must also be compiled as usual if the program
3381 refers to its address, because that can't be inlined.
3382
3383 @cindex non-static inline function
3384 When an inline function is not @code{static}, then the compiler must assume
3385 that there may be calls from other source files; since a global symbol can
3386 be defined only once in any program, the function must not be defined in
3387 the other source files, so the calls therein cannot be integrated.
3388 Therefore, a non-@code{static} inline function is always compiled on its
3389 own in the usual fashion.
3390
3391 If you specify both @code{inline} and @code{extern} in the function
3392 definition, then the definition is used only for inlining.  In no case
3393 is the function compiled on its own, not even if you refer to its
3394 address explicitly.  Such an address becomes an external reference, as
3395 if you had only declared the function, and had not defined it.
3396
3397 This combination of @code{inline} and @code{extern} has almost the
3398 effect of a macro.  The way to use it is to put a function definition in
3399 a header file with these keywords, and put another copy of the
3400 definition (lacking @code{inline} and @code{extern}) in a library file.
3401 The definition in the header file will cause most calls to the function
3402 to be inlined.  If any uses of the function remain, they will refer to
3403 the single copy in the library.
3404
3405 Since GCC eventually will implement ISO C99 semantics for
3406 inline functions, it is best to use @code{static inline} only
3407 to guarantee compatibility.  (The
3408 existing semantics will remain available when @option{-std=gnu89} is
3409 specified, but eventually the default will be @option{-std=gnu99} and
3410 that will implement the C99 semantics, though it does not do so yet.)
3411
3412 GCC does not inline any functions when not optimizing unless you specify
3413 the @samp{always_inline} attribute for the function, like this:
3414
3415 @smallexample
3416 /* Prototype.  */
3417 inline void foo (const char) __attribute__((always_inline));
3418 @end smallexample
3419
3420 @node Extended Asm
3421 @section Assembler Instructions with C Expression Operands
3422 @cindex extended @code{asm}
3423 @cindex @code{asm} expressions
3424 @cindex assembler instructions
3425 @cindex registers
3426
3427 In an assembler instruction using @code{asm}, you can specify the
3428 operands of the instruction using C expressions.  This means you need not
3429 guess which registers or memory locations will contain the data you want
3430 to use.
3431
3432 You must specify an assembler instruction template much like what
3433 appears in a machine description, plus an operand constraint string for
3434 each operand.
3435
3436 For example, here is how to use the 68881's @code{fsinx} instruction:
3437
3438 @smallexample
3439 asm ("fsinx %1,%0" : "=f" (result) : "f" (angle));
3440 @end smallexample
3441
3442 @noindent
3443 Here @code{angle} is the C expression for the input operand while
3444 @code{result} is that of the output operand.  Each has @samp{"f"} as its
3445 operand constraint, saying that a floating point register is required.
3446 The @samp{=} in @samp{=f} indicates that the operand is an output; all
3447 output operands' constraints must use @samp{=}.  The constraints use the
3448 same language used in the machine description (@pxref{Constraints}).
3449
3450 Each operand is described by an operand-constraint string followed by
3451 the C expression in parentheses.  A colon separates the assembler
3452 template from the first output operand and another separates the last
3453 output operand from the first input, if any.  Commas separate the
3454 operands within each group.  The total number of operands is currently
3455 limited to 30; this limitation may be lifted in some future version of
3456 GCC.
3457
3458 If there are no output operands but there are input operands, you must
3459 place two consecutive colons surrounding the place where the output
3460 operands would go.
3461
3462 As of GCC version 3.1, it is also possible to specify input and output
3463 operands using symbolic names which can be referenced within the
3464 assembler code.  These names are specified inside square brackets
3465 preceding the constraint string, and can be referenced inside the
3466 assembler code using @code{%[@var{name}]} instead of a percentage sign
3467 followed by the operand number.  Using named operands the above example
3468 could look like:
3469
3470 @smallexample
3471 asm ("fsinx %[angle],%[output]"
3472      : [output] "=f" (result)
3473      : [angle] "f" (angle));
3474 @end smallexample
3475
3476 @noindent
3477 Note that the symbolic operand names have no relation whatsoever to
3478 other C identifiers.  You may use any name you like, even those of
3479 existing C symbols, but you must ensure that no two operands within the same
3480 assembler construct use the same symbolic name.
3481
3482 Output operand expressions must be lvalues; the compiler can check this.
3483 The input operands need not be lvalues.  The compiler cannot check
3484 whether the operands have data types that are reasonable for the
3485 instruction being executed.  It does not parse the assembler instruction
3486 template and does not know what it means or even whether it is valid
3487 assembler input.  The extended @code{asm} feature is most often used for
3488 machine instructions the compiler itself does not know exist.  If
3489 the output expression cannot be directly addressed (for example, it is a
3490 bit-field), your constraint must allow a register.  In that case, GCC
3491 will use the register as the output of the @code{asm}, and then store
3492 that register into the output.
3493
3494 The ordinary output operands must be write-only; GCC will assume that
3495 the values in these operands before the instruction are dead and need
3496 not be generated.  Extended asm supports input-output or read-write
3497 operands.  Use the constraint character @samp{+} to indicate such an
3498 operand and list it with the output operands.  You should only use
3499 read-write operands when the constraints for the operand (or the
3500 operand in which only some of the bits are to be changed) allow a
3501 register.
3502
3503 You may, as an alternative, logically split its function into two
3504 separate operands, one input operand and one write-only output
3505 operand.  The connection between them is expressed by constraints
3506 which say they need to be in the same location when the instruction
3507 executes.  You can use the same C expression for both operands, or
3508 different expressions.  For example, here we write the (fictitious)
3509 @samp{combine} instruction with @code{bar} as its read-only source
3510 operand and @code{foo} as its read-write destination:
3511
3512 @smallexample
3513 asm ("combine %2,%0" : "=r" (foo) : "0" (foo), "g" (bar));
3514 @end smallexample
3515
3516 @noindent
3517 The constraint @samp{"0"} for operand 1 says that it must occupy the
3518 same location as operand 0.  A number in constraint is allowed only in
3519 an input operand and it must refer to an output operand.
3520
3521 Only a number in the constraint can guarantee that one operand will be in
3522 the same place as another.  The mere fact that @code{foo} is the value
3523 of both operands is not enough to guarantee that they will be in the
3524 same place in the generated assembler code.  The following would not
3525 work reliably:
3526
3527 @smallexample
3528 asm ("combine %2,%0" : "=r" (foo) : "r" (foo), "g" (bar));
3529 @end smallexample
3530
3531 Various optimizations or reloading could cause operands 0 and 1 to be in
3532 different registers; GCC knows no reason not to do so.  For example, the
3533 compiler might find a copy of the value of @code{foo} in one register and
3534 use it for operand 1, but generate the output operand 0 in a different
3535 register (copying it afterward to @code{foo}'s own address).  Of course,
3536 since the register for operand 1 is not even mentioned in the assembler
3537 code, the result will not work, but GCC can't tell that.
3538
3539 As of GCC version 3.1, one may write @code{[@var{name}]} instead of
3540 the operand number for a matching constraint.  For example:
3541
3542 @smallexample
3543 asm ("cmoveq %1,%2,%[result]"
3544      : [result] "=r"(result)
3545      : "r" (test), "r"(new), "[result]"(old));
3546 @end smallexample
3547
3548 Some instructions clobber specific hard registers.  To describe this,
3549 write a third colon after the input operands, followed by the names of
3550 the clobbered hard registers (given as strings).  Here is a realistic
3551 example for the VAX:
3552
3553 @smallexample
3554 asm volatile ("movc3 %0,%1,%2"
3555               : /* no outputs */
3556               : "g" (from), "g" (to), "g" (count)
3557               : "r0", "r1", "r2", "r3", "r4", "r5");
3558 @end smallexample
3559
3560 You may not write a clobber description in a way that overlaps with an
3561 input or output operand.  For example, you may not have an operand
3562 describing a register class with one member if you mention that register
3563 in the clobber list.  Variables declared to live in specific registers
3564 (@pxref{Explicit Reg Vars}), and used as asm input or output operands must
3565 have no part mentioned in the clobber description.
3566 There is no way for you to specify that an input
3567 operand is modified without also specifying it as an output
3568 operand.  Note that if all the output operands you specify are for this
3569 purpose (and hence unused), you will then also need to specify
3570 @code{volatile} for the @code{asm} construct, as described below, to
3571 prevent GCC from deleting the @code{asm} statement as unused.
3572
3573 If you refer to a particular hardware register from the assembler code,
3574 you will probably have to list the register after the third colon to
3575 tell the compiler the register's value is modified.  In some assemblers,
3576 the register names begin with @samp{%}; to produce one @samp{%} in the
3577 assembler code, you must write @samp{%%} in the input.
3578
3579 If your assembler instruction can alter the condition code register, add
3580 @samp{cc} to the list of clobbered registers.  GCC on some machines
3581 represents the condition codes as a specific hardware register;
3582 @samp{cc} serves to name this register.  On other machines, the
3583 condition code is handled differently, and specifying @samp{cc} has no
3584 effect.  But it is valid no matter what the machine.
3585
3586 If your assembler instructions access memory in an unpredictable
3587 fashion, add @samp{memory} to the list of clobbered registers.  This
3588 will cause GCC to not keep memory values cached in registers across the
3589 assembler instruction and not optimize stores or loads to that memory.
3590 You will also want to add the @code{volatile} keyword if the memory
3591 affected is not listed in the inputs or outputs of the @code{asm}, as
3592 the @samp{memory} clobber does not count as a side-effect of the
3593 @code{asm}.  If you know how large the accessed memory is, you can add
3594 it as input or output but if this is not known, you should add
3595 @samp{memory}.  As an example, if you access ten bytes of a string, you
3596 can use a memory input like:
3597
3598 @example
3599 @{"m"( (@{ struct @{ char x[10]; @} *p = (void *)ptr ; *p; @}) )@}.
3600 @end example
3601
3602 Note that in the following example the memory input is necessary,
3603 otherwise GCC might optimize the store to @code{x} away:
3604 @example
3605 int foo ()
3606 @{
3607   int x = 42;
3608   int *y = &x;
3609   int result;
3610   asm ("magic stuff accessing an 'int' pointed to by '%1'"
3611         "=&d" (r) : "a" (y), "m" (*y));
3612   return result;     
3613 @}
3614 @end example
3615
3616 You can put multiple assembler instructions together in a single
3617 @code{asm} template, separated by the characters normally used in assembly
3618 code for the system.  A combination that works in most places is a newline
3619 to break the line, plus a tab character to move to the instruction field
3620 (written as @samp{\n\t}).  Sometimes semicolons can be used, if the
3621 assembler allows semicolons as a line-breaking character.  Note that some
3622 assembler dialects use semicolons to start a comment.
3623 The input operands are guaranteed not to use any of the clobbered
3624 registers, and neither will the output operands' addresses, so you can
3625 read and write the clobbered registers as many times as you like.  Here
3626 is an example of multiple instructions in a template; it assumes the
3627 subroutine @code{_foo} accepts arguments in registers 9 and 10:
3628
3629 @smallexample
3630 asm ("movl %0,r9\n\tmovl %1,r10\n\tcall _foo"
3631      : /* no outputs */
3632      : "g" (from), "g" (to)
3633      : "r9", "r10");
3634 @end smallexample
3635
3636 Unless an output operand has the @samp{&} constraint modifier, GCC
3637 may allocate it in the same register as an unrelated input operand, on
3638 the assumption the inputs are consumed before the outputs are produced.
3639 This assumption may be false if the assembler code actually consists of
3640 more than one instruction.  In such a case, use @samp{&} for each output
3641 operand that may not overlap an input.  @xref{Modifiers}.
3642
3643 If you want to test the condition code produced by an assembler
3644 instruction, you must include a branch and a label in the @code{asm}
3645 construct, as follows:
3646
3647 @smallexample
3648 asm ("clr %0\n\tfrob %1\n\tbeq 0f\n\tmov #1,%0\n0:"
3649      : "g" (result)
3650      : "g" (input));
3651 @end smallexample
3652
3653 @noindent
3654 This assumes your assembler supports local labels, as the GNU assembler
3655 and most Unix assemblers do.
3656
3657 Speaking of labels, jumps from one @code{asm} to another are not
3658 supported.  The compiler's optimizers do not know about these jumps, and
3659 therefore they cannot take account of them when deciding how to
3660 optimize.
3661
3662 @cindex macros containing @code{asm}
3663 Usually the most convenient way to use these @code{asm} instructions is to
3664 encapsulate them in macros that look like functions.  For example,
3665
3666 @smallexample
3667 #define sin(x)       \
3668 (@{ double __value, __arg = (x);   \
3669    asm ("fsinx %1,%0": "=f" (__value): "f" (__arg));  \
3670    __value; @})
3671 @end smallexample
3672
3673 @noindent
3674 Here the variable @code{__arg} is used to make sure that the instruction
3675 operates on a proper @code{double} value, and to accept only those
3676 arguments @code{x} which can convert automatically to a @code{double}.
3677
3678 Another way to make sure the instruction operates on the correct data
3679 type is to use a cast in the @code{asm}.  This is different from using a
3680 variable @code{__arg} in that it converts more different types.  For
3681 example, if the desired type were @code{int}, casting the argument to
3682 @code{int} would accept a pointer with no complaint, while assigning the
3683 argument to an @code{int} variable named @code{__arg} would warn about
3684 using a pointer unless the caller explicitly casts it.
3685
3686 If an @code{asm} has output operands, GCC assumes for optimization
3687 purposes the instruction has no side effects except to change the output
3688 operands.  This does not mean instructions with a side effect cannot be
3689 used, but you must be careful, because the compiler may eliminate them
3690 if the output operands aren't used, or move them out of loops, or
3691 replace two with one if they constitute a common subexpression.  Also,
3692 if your instruction does have a side effect on a variable that otherwise
3693 appears not to change, the old value of the variable may be reused later
3694 if it happens to be found in a register.
3695
3696 You can prevent an @code{asm} instruction from being deleted, moved
3697 significantly, or combined, by writing the keyword @code{volatile} after
3698 the @code{asm}.  For example:
3699
3700 @smallexample
3701 #define get_and_set_priority(new)              \
3702 (@{ int __old;                                  \
3703    asm volatile ("get_and_set_priority %0, %1" \
3704                  : "=g" (__old) : "g" (new));  \
3705    __old; @})
3706 @end smallexample
3707
3708 @noindent
3709 If you write an @code{asm} instruction with no outputs, GCC will know
3710 the instruction has side-effects and will not delete the instruction or
3711 move it outside of loops.
3712
3713 The @code{volatile} keyword indicates that the instruction has
3714 important side-effects.  GCC will not delete a volatile @code{asm} if
3715 it is reachable.  (The instruction can still be deleted if GCC can
3716 prove that control-flow will never reach the location of the
3717 instruction.)  In addition, GCC will not reschedule instructions
3718 across a volatile @code{asm} instruction.  For example:
3719
3720 @smallexample
3721 *(volatile int *)addr = foo;
3722 asm volatile ("eieio" : : );
3723 @end smallexample
3724
3725 @noindent
3726 Assume @code{addr} contains the address of a memory mapped device
3727 register.  The PowerPC @code{eieio} instruction (Enforce In-order
3728 Execution of I/O) tells the CPU to make sure that the store to that
3729 device register happens before it issues any other I/O@.
3730
3731 Note that even a volatile @code{asm} instruction can be moved in ways
3732 that appear insignificant to the compiler, such as across jump
3733 instructions.  You can't expect a sequence of volatile @code{asm}
3734 instructions to remain perfectly consecutive.  If you want consecutive
3735 output, use a single @code{asm}.  Also, GCC will perform some
3736 optimizations across a volatile @code{asm} instruction; GCC does not
3737 ``forget everything'' when it encounters a volatile @code{asm}
3738 instruction the way some other compilers do.
3739
3740 An @code{asm} instruction without any operands or clobbers (an ``old
3741 style'' @code{asm}) will be treated identically to a volatile
3742 @code{asm} instruction.
3743
3744 It is a natural idea to look for a way to give access to the condition
3745 code left by the assembler instruction.  However, when we attempted to
3746 implement this, we found no way to make it work reliably.  The problem
3747 is that output operands might need reloading, which would result in
3748 additional following ``store'' instructions.  On most machines, these
3749 instructions would alter the condition code before there was time to
3750 test it.  This problem doesn't arise for ordinary ``test'' and
3751 ``compare'' instructions because they don't have any output operands.
3752
3753 For reasons similar to those described above, it is not possible to give
3754 an assembler instruction access to the condition code left by previous
3755 instructions.
3756
3757 If you are writing a header file that should be includable in ISO C
3758 programs, write @code{__asm__} instead of @code{asm}.  @xref{Alternate
3759 Keywords}.
3760
3761 @subsection Size of an @code{asm}
3762
3763 Some targets require that GCC track the size of each instruction used in
3764 order to generate correct code.  Because the final length of an
3765 @code{asm} is only known by the assembler, GCC must make an estimate as
3766 to how big it will be.  The estimate is formed by counting the number of
3767 statements in the pattern of the @code{asm} and multiplying that by the
3768 length of the longest instruction on that processor.  Statements in the
3769 @code{asm} are identified by newline characters and whatever statement
3770 separator characters are supported by the assembler; on most processors
3771 this is the `@code{;}' character.
3772
3773 Normally, GCC's estimate is perfectly adequate to ensure that correct
3774 code is generated, but it is possible to confuse the compiler if you use
3775 pseudo instructions or assembler macros that expand into multiple real
3776 instructions or if you use assembler directives that expand to more
3777 space in the object file than would be needed for a single instruction.
3778 If this happens then the assembler will produce a diagnostic saying that
3779 a label is unreachable.
3780
3781 @subsection i386 floating point asm operands
3782
3783 There are several rules on the usage of stack-like regs in
3784 asm_operands insns.  These rules apply only to the operands that are
3785 stack-like regs:
3786
3787 @enumerate
3788 @item
3789 Given a set of input regs that die in an asm_operands, it is
3790 necessary to know which are implicitly popped by the asm, and
3791 which must be explicitly popped by gcc.
3792
3793 An input reg that is implicitly popped by the asm must be
3794 explicitly clobbered, unless it is constrained to match an
3795 output operand.
3796
3797 @item
3798 For any input reg that is implicitly popped by an asm, it is
3799 necessary to know how to adjust the stack to compensate for the pop.
3800 If any non-popped input is closer to the top of the reg-stack than
3801 the implicitly popped reg, it would not be possible to know what the
3802 stack looked like---it's not clear how the rest of the stack ``slides
3803 up''.
3804
3805 All implicitly popped input regs must be closer to the top of
3806 the reg-stack than any input that is not implicitly popped.
3807
3808 It is possible that if an input dies in an insn, reload might
3809 use the input reg for an output reload.  Consider this example:
3810
3811 @smallexample
3812 asm ("foo" : "=t" (a) : "f" (b));
3813 @end smallexample
3814
3815 This asm says that input B is not popped by the asm, and that
3816 the asm pushes a result onto the reg-stack, i.e., the stack is one
3817 deeper after the asm than it was before.  But, it is possible that
3818 reload will think that it can use the same reg for both the input and
3819 the output, if input B dies in this insn.
3820
3821 If any input operand uses the @code{f} constraint, all output reg
3822 constraints must use the @code{&} earlyclobber.
3823
3824 The asm above would be written as
3825
3826 @smallexample
3827 asm ("foo" : "=&t" (a) : "f" (b));
3828 @end smallexample
3829
3830 @item
3831 Some operands need to be in particular places on the stack.  All
3832 output operands fall in this category---there is no other way to
3833 know which regs the outputs appear in unless the user indicates
3834 this in the constraints.
3835
3836 Output operands must specifically indicate which reg an output
3837 appears in after an asm.  @code{=f} is not allowed: the operand
3838 constraints must select a class with a single reg.
3839
3840 @item
3841 Output operands may not be ``inserted'' between existing stack regs.
3842 Since no 387 opcode uses a read/write operand, all output operands
3843 are dead before the asm_operands, and are pushed by the asm_operands.
3844 It makes no sense to push anywhere but the top of the reg-stack.
3845
3846 Output operands must start at the top of the reg-stack: output
3847 operands may not ``skip'' a reg.
3848
3849 @item
3850 Some asm statements may need extra stack space for internal
3851 calculations.  This can be guaranteed by clobbering stack registers
3852 unrelated to the inputs and outputs.
3853
3854 @end enumerate
3855
3856 Here are a couple of reasonable asms to want to write.  This asm
3857 takes one input, which is internally popped, and produces two outputs.
3858
3859 @smallexample
3860 asm ("fsincos" : "=t" (cos), "=u" (sin) : "0" (inp));
3861 @end smallexample
3862
3863 This asm takes two inputs, which are popped by the @code{fyl2xp1} opcode,
3864 and replaces them with one output.  The user must code the @code{st(1)}
3865 clobber for reg-stack.c to know that @code{fyl2xp1} pops both inputs.
3866
3867 @smallexample
3868 asm ("fyl2xp1" : "=t" (result) : "0" (x), "u" (y) : "st(1)");
3869 @end smallexample
3870
3871 @include md.texi
3872
3873 @node Asm Labels
3874 @section Controlling Names Used in Assembler Code
3875 @cindex assembler names for identifiers
3876 @cindex names used in assembler code
3877 @cindex identifiers, names in assembler code
3878
3879 You can specify the name to be used in the assembler code for a C
3880 function or variable by writing the @code{asm} (or @code{__asm__})
3881 keyword after the declarator as follows:
3882
3883 @smallexample
3884 int foo asm ("myfoo") = 2;
3885 @end smallexample
3886
3887 @noindent
3888 This specifies that the name to be used for the variable @code{foo} in
3889 the assembler code should be @samp{myfoo} rather than the usual
3890 @samp{_foo}.
3891
3892 On systems where an underscore is normally prepended to the name of a C
3893 function or variable, this feature allows you to define names for the
3894 linker that do not start with an underscore.
3895
3896 It does not make sense to use this feature with a non-static local
3897 variable since such variables do not have assembler names.  If you are
3898 trying to put the variable in a particular register, see @ref{Explicit
3899 Reg Vars}.  GCC presently accepts such code with a warning, but will
3900 probably be changed to issue an error, rather than a warning, in the
3901 future.
3902
3903 You cannot use @code{asm} in this way in a function @emph{definition}; but
3904 you can get the same effect by writing a declaration for the function
3905 before its definition and putting @code{asm} there, like this:
3906
3907 @smallexample
3908 extern func () asm ("FUNC");
3909
3910 func (x, y)
3911      int x, y;
3912 /* @r{@dots{}} */
3913 @end smallexample
3914
3915 It is up to you to make sure that the assembler names you choose do not
3916 conflict with any other assembler symbols.  Also, you must not use a
3917 register name; that would produce completely invalid assembler code.  GCC
3918 does not as yet have the ability to store static variables in registers.
3919 Perhaps that will be added.
3920
3921 @node Explicit Reg Vars
3922 @section Variables in Specified Registers
3923 @cindex explicit register variables
3924 @cindex variables in specified registers
3925 @cindex specified registers
3926 @cindex registers, global allocation
3927
3928 GNU C allows you to put a few global variables into specified hardware
3929 registers.  You can also specify the register in which an ordinary
3930 register variable should be allocated.
3931
3932 @itemize @bullet
3933 @item
3934 Global register variables reserve registers throughout the program.
3935 This may be useful in programs such as programming language
3936 interpreters which have a couple of global variables that are accessed
3937 very often.
3938
3939 @item
3940 Local register variables in specific registers do not reserve the
3941 registers.  The compiler's data flow analysis is capable of determining
3942 where the specified registers contain live values, and where they are
3943 available for other uses.  Stores into local register variables may be deleted
3944 when they appear to be dead according to dataflow analysis.  References
3945 to local register variables may be deleted or moved or simplified.
3946
3947 These local variables are sometimes convenient for use with the extended
3948 @code{asm} feature (@pxref{Extended Asm}), if you want to write one
3949 output of the assembler instruction directly into a particular register.
3950 (This will work provided the register you specify fits the constraints
3951 specified for that operand in the @code{asm}.)
3952 @end itemize
3953
3954 @menu
3955 * Global Reg Vars::
3956 * Local Reg Vars::
3957 @end menu
3958
3959 @node Global Reg Vars
3960 @subsection Defining Global Register Variables
3961 @cindex global register variables
3962 @cindex registers, global variables in
3963
3964 You can define a global register variable in GNU C like this:
3965
3966 @smallexample
3967 register int *foo asm ("a5");
3968 @end smallexample
3969
3970 @noindent
3971 Here @code{a5} is the name of the register which should be used.  Choose a
3972 register which is normally saved and restored by function calls on your
3973 machine, so that library routines will not clobber it.
3974
3975 Naturally the register name is cpu-dependent, so you would need to
3976 conditionalize your program according to cpu type.  The register
3977 @code{a5} would be a good choice on a 68000 for a variable of pointer
3978 type.  On machines with register windows, be sure to choose a ``global''
3979 register that is not affected magically by the function call mechanism.
3980
3981 In addition, operating systems on one type of cpu may differ in how they
3982 name the registers; then you would need additional conditionals.  For
3983 example, some 68000 operating systems call this register @code{%a5}.
3984
3985 Eventually there may be a way of asking the compiler to choose a register
3986 automatically, but first we need to figure out how it should choose and
3987 how to enable you to guide the choice.  No solution is evident.
3988
3989 Defining a global register variable in a certain register reserves that
3990 register entirely for this use, at least within the current compilation.
3991 The register will not be allocated for any other purpose in the functions
3992 in the current compilation.  The register will not be saved and restored by
3993 these functions.  Stores into this register are never deleted even if they
3994 would appear to be dead, but references may be deleted or moved or
3995 simplified.
3996
3997 It is not safe to access the global register variables from signal
3998 handlers, or from more than one thread of control, because the system
3999 library routines may temporarily use the register for other things (unless
4000 you recompile them specially for the task at hand).
4001
4002 @cindex @code{qsort}, and global register variables
4003 It is not safe for one function that uses a global register variable to
4004 call another such function @code{foo} by way of a third function
4005 @code{lose} that was compiled without knowledge of this variable (i.e.@: in a
4006 different source file in which the variable wasn't declared).  This is
4007 because @code{lose} might save the register and put some other value there.
4008 For example, you can't expect a global register variable to be available in
4009 the comparison-function that you pass to @code{qsort}, since @code{qsort}
4010 might have put something else in that register.  (If you are prepared to
4011 recompile @code{qsort} with the same global register variable, you can
4012 solve this problem.)
4013
4014 If you want to recompile @code{qsort} or other source files which do not
4015 actually use your global register variable, so that they will not use that
4016 register for any other purpose, then it suffices to specify the compiler
4017 option @option{-ffixed-@var{reg}}.  You need not actually add a global
4018 register declaration to their source code.
4019
4020 A function which can alter the value of a global register variable cannot
4021 safely be called from a function compiled without this variable, because it
4022 could clobber the value the caller expects to find there on return.
4023 Therefore, the function which is the entry point into the part of the
4024 program that uses the global register variable must explicitly save and
4025 restore the value which belongs to its caller.
4026
4027 @cindex register variable after @code{longjmp}
4028 @cindex global register after @code{longjmp}
4029 @cindex value after @code{longjmp}
4030 @findex longjmp
4031 @findex setjmp
4032 On most machines, @code{longjmp} will restore to each global register
4033 variable the value it had at the time of the @code{setjmp}.  On some
4034 machines, however, @code{longjmp} will not change the value of global
4035 register variables.  To be portable, the function that called @code{setjmp}
4036 should make other arrangements to save the values of the global register
4037 variables, and to restore them in a @code{longjmp}.  This way, the same
4038 thing will happen regardless of what @code{longjmp} does.
4039
4040 All global register variable declarations must precede all function
4041 definitions.  If such a declaration could appear after function
4042 definitions, the declaration would be too late to prevent the register from
4043 being used for other purposes in the preceding functions.
4044
4045 Global register variables may not have initial values, because an
4046 executable file has no means to supply initial contents for a register.
4047
4048 On the SPARC, there are reports that g3 @dots{} g7 are suitable
4049 registers, but certain library functions, such as @code{getwd}, as well
4050 as the subroutines for division and remainder, modify g3 and g4.  g1 and
4051 g2 are local temporaries.
4052
4053 On the 68000, a2 @dots{} a5 should be suitable, as should d2 @dots{} d7.
4054 Of course, it will not do to use more than a few of those.
4055
4056 @node Local Reg Vars
4057 @subsection Specifying Registers for Local Variables
4058 @cindex local variables, specifying registers
4059 @cindex specifying registers for local variables
4060 @cindex registers for local variables
4061
4062 You can define a local register variable with a specified register
4063 like this:
4064
4065 @smallexample
4066 register int *foo asm ("a5");
4067 @end smallexample
4068
4069 @noindent
4070 Here @code{a5} is the name of the register which should be used.  Note
4071 that this is the same syntax used for defining global register
4072 variables, but for a local variable it would appear within a function.
4073
4074 Naturally the register name is cpu-dependent, but this is not a
4075 problem, since specific registers are most often useful with explicit
4076 assembler instructions (@pxref{Extended Asm}).  Both of these things
4077 generally require that you conditionalize your program according to
4078 cpu type.
4079
4080 In addition, operating systems on one type of cpu may differ in how they
4081 name the registers; then you would need additional conditionals.  For
4082 example, some 68000 operating systems call this register @code{%a5}.
4083
4084 Defining such a register variable does not reserve the register; it
4085 remains available for other uses in places where flow control determines
4086 the variable's value is not live.
4087
4088 This option does not guarantee that GCC will generate code that has
4089 this variable in the register you specify at all times.  You may not
4090 code an explicit reference to this register in an @code{asm} statement
4091 and assume it will always refer to this variable.
4092
4093 Stores into local register variables may be deleted when they appear to be dead
4094 according to dataflow analysis.  References to local register variables may
4095 be deleted or moved or simplified.
4096
4097 @node Alternate Keywords
4098 @section Alternate Keywords
4099 @cindex alternate keywords
4100 @cindex keywords, alternate
4101
4102 @option{-ansi} and the various @option{-std} options disable certain
4103 keywords.  This causes trouble when you want to use GNU C extensions, or
4104 a general-purpose header file that should be usable by all programs,
4105 including ISO C programs.  The keywords @code{asm}, @code{typeof} and
4106 @code{inline} are not available in programs compiled with
4107 @option{-ansi} or @option{-std} (although @code{inline} can be used in a
4108 program compiled with @option{-std=c99}).  The ISO C99 keyword
4109 @code{restrict} is only available when @option{-std=gnu99} (which will
4110 eventually be the default) or @option{-std=c99} (or the equivalent
4111 @option{-std=iso9899:1999}) is used.
4112
4113 The way to solve these problems is to put @samp{__} at the beginning and
4114 end of each problematical keyword.  For example, use @code{__asm__}
4115 instead of @code{asm}, and @code{__inline__} instead of @code{inline}.
4116
4117 Other C compilers won't accept these alternative keywords; if you want to
4118 compile with another compiler, you can define the alternate keywords as
4119 macros to replace them with the customary keywords.  It looks like this:
4120
4121 @smallexample
4122 #ifndef __GNUC__
4123 #define __asm__ asm
4124 #endif
4125 @end smallexample
4126
4127 @findex __extension__
4128 @opindex pedantic
4129 @option{-pedantic} and other options cause warnings for many GNU C extensions.
4130 You can
4131 prevent such warnings within one expression by writing
4132 @code{__extension__} before the expression.  @code{__extension__} has no
4133 effect aside from this.
4134
4135 @node Incomplete Enums
4136 @section Incomplete @code{enum} Types
4137
4138 You can define an @code{enum} tag without specifying its possible values.
4139 This results in an incomplete type, much like what you get if you write
4140 @code{struct foo} without describing the elements.  A later declaration
4141 which does specify the possible values completes the type.
4142
4143 You can't allocate variables or storage using the type while it is
4144 incomplete.  However, you can work with pointers to that type.
4145
4146 This extension may not be very useful, but it makes the handling of
4147 @code{enum} more consistent with the way @code{struct} and @code{union}
4148 are handled.
4149
4150 This extension is not supported by GNU C++.
4151
4152 @node Function Names
4153 @section Function Names as Strings
4154 @cindex @code{__func__} identifier
4155 @cindex @code{__FUNCTION__} identifier
4156 @cindex @code{__PRETTY_FUNCTION__} identifier
4157
4158 GCC provides three magic variables which hold the name of the current
4159 function, as a string.  The first of these is @code{__func__}, which
4160 is part of the C99 standard:
4161
4162 @display
4163 The identifier @code{__func__} is implicitly declared by the translator
4164 as if, immediately following the opening brace of each function
4165 definition, the declaration
4166
4167 @smallexample
4168 static const char __func__[] = "function-name";
4169 @end smallexample
4170
4171 appeared, where function-name is the name of the lexically-enclosing
4172 function.  This name is the unadorned name of the function.
4173 @end display
4174
4175 @code{__FUNCTION__} is another name for @code{__func__}.  Older
4176 versions of GCC recognize only this name.  However, it is not
4177 standardized.  For maximum portability, we recommend you use
4178 @code{__func__}, but provide a fallback definition with the
4179 preprocessor:
4180
4181 @smallexample
4182 #if __STDC_VERSION__ < 199901L
4183 # if __GNUC__ >= 2
4184 #  define __func__ __FUNCTION__
4185 # else
4186 #  define __func__ "<unknown>"
4187 # endif
4188 #endif
4189 @end smallexample
4190
4191 In C, @code{__PRETTY_FUNCTION__} is yet another name for
4192 @code{__func__}.  However, in C++, @code{__PRETTY_FUNCTION__} contains
4193 the type signature of the function as well as its bare name.  For
4194 example, this program:
4195
4196 @smallexample
4197 extern "C" @{
4198 extern int printf (char *, ...);
4199 @}
4200
4201 class a @{
4202  public:
4203   void sub (int i)
4204     @{
4205       printf ("__FUNCTION__ = %s\n", __FUNCTION__);
4206       printf ("__PRETTY_FUNCTION__ = %s\n", __PRETTY_FUNCTION__);
4207     @}
4208 @};
4209
4210 int
4211 main (void)
4212 @{
4213   a ax;
4214   ax.sub (0);
4215   return 0;
4216 @}
4217 @end smallexample
4218
4219 @noindent
4220 gives this output:
4221
4222 @smallexample
4223 __FUNCTION__ = sub
4224 __PRETTY_FUNCTION__ = void a::sub(int)
4225 @end smallexample
4226
4227 These identifiers are not preprocessor macros.  In GCC 3.3 and
4228 earlier, in C only, @code{__FUNCTION__} and @code{__PRETTY_FUNCTION__}
4229 were treated as string literals; they could be used to initialize
4230 @code{char} arrays, and they could be concatenated with other string
4231 literals.  GCC 3.4 and later treat them as variables, like
4232 @code{__func__}.  In C++, @code{__FUNCTION__} and
4233 @code{__PRETTY_FUNCTION__} have always been variables.
4234
4235 @node Return Address
4236 @section Getting the Return or Frame Address of a Function
4237
4238 These functions may be used to get information about the callers of a
4239 function.
4240
4241 @deftypefn {Built-in Function} {void *} __builtin_return_address (unsigned int @var{level})
4242 This function returns the return address of the current function, or of
4243 one of its callers.  The @var{level} argument is number of frames to
4244 scan up the call stack.  A value of @code{0} yields the return address
4245 of the current function, a value of @code{1} yields the return address
4246 of the caller of the current function, and so forth. When inlining
4247 the expected behavior is that the function will return the address of
4248 the function that will be returned to.  To work around this behavior use
4249 the @code{noinline} function attribute.
4250
4251 The @var{level} argument must be a constant integer.
4252
4253 On some machines it may be impossible to determine the return address of
4254 any function other than the current one; in such cases, or when the top
4255 of the stack has been reached, this function will return @code{0} or a
4256 random value. In addition, @code{__builtin_frame_address} may be used
4257 to determine if the top of the stack has been reached.
4258
4259 This function should only be used with a nonzero argument for debugging
4260 purposes.
4261 @end deftypefn
4262
4263 @deftypefn {Built-in Function} {void *} __builtin_frame_address (unsigned int @var{level})
4264 This function is similar to @code{__builtin_return_address}, but it
4265 returns the address of the function frame rather than the return address
4266 of the function.  Calling @code{__builtin_frame_address} with a value of
4267 @code{0} yields the frame address of the current function, a value of
4268 @code{1} yields the frame address of the caller of the current function,
4269 and so forth.
4270
4271 The frame is the area on the stack which holds local variables and saved
4272 registers.  The frame address is normally the address of the first word
4273 pushed on to the stack by the function.  However, the exact definition
4274 depends upon the processor and the calling convention.  If the processor
4275 has a dedicated frame pointer register, and the function has a frame,
4276 then @code{__builtin_frame_address} will return the value of the frame
4277 pointer register.
4278
4279 On some machines it may be impossible to determine the frame address of
4280 any function other than the current one; in such cases, or when the top
4281 of the stack has been reached, this function will return @code{0} if
4282 the first frame pointer is properly initialized by the startup code.
4283
4284 This function should only be used with a nonzero argument for debugging
4285 purposes.
4286 @end deftypefn
4287
4288 @node Vector Extensions
4289 @section Using vector instructions through built-in functions
4290
4291 On some targets, the instruction set contains SIMD vector instructions that
4292 operate on multiple values contained in one large register at the same time.
4293 For example, on the i386 the MMX, 3Dnow! and SSE extensions can be used
4294 this way.
4295
4296 The first step in using these extensions is to provide the necessary data
4297 types.  This should be done using an appropriate @code{typedef}:
4298
4299 @smallexample
4300 typedef int v4si __attribute__ ((vector_size (16)));
4301 @end smallexample
4302
4303 The @code{int} type specifies the base type, while the attribute specifies
4304 the vector size for the variable, measured in bytes.  For example, the
4305 declaration above causes the compiler to set the mode for the @code{v4si}
4306 type to be 16 bytes wide and divided into @code{int} sized units.  For
4307 a 32-bit @code{int} this means a vector of 4 units of 4 bytes, and the
4308 corresponding mode of @code{foo} will be @acronym{V4SI}.
4309
4310 The @code{vector_size} attribute is only applicable to integral and
4311 float scalars, although arrays, pointers, and function return values
4312 are allowed in conjunction with this construct.
4313
4314 All the basic integer types can be used as base types, both as signed
4315 and as unsigned: @code{char}, @code{short}, @code{int}, @code{long},
4316 @code{long long}.  In addition, @code{float} and @code{double} can be
4317 used to build floating-point vector types.
4318
4319 Specifying a combination that is not valid for the current architecture
4320 will cause GCC to synthesize the instructions using a narrower mode.
4321 For example, if you specify a variable of type @code{V4SI} and your
4322 architecture does not allow for this specific SIMD type, GCC will
4323 produce code that uses 4 @code{SIs}.
4324
4325 The types defined in this manner can be used with a subset of normal C
4326 operations.  Currently, GCC will allow using the following operators
4327 on these types: @code{+, -, *, /, unary minus, ^, |, &, ~}@.
4328
4329 The operations behave like C++ @code{valarrays}.  Addition is defined as
4330 the addition of the corresponding elements of the operands.  For
4331 example, in the code below, each of the 4 elements in @var{a} will be
4332 added to the corresponding 4 elements in @var{b} and the resulting
4333 vector will be stored in @var{c}.
4334
4335 @smallexample
4336 typedef int v4si __attribute__ ((vector_size (16)));
4337
4338 v4si a, b, c;
4339
4340 c = a + b;
4341 @end smallexample
4342
4343 Subtraction, multiplication, division, and the logical operations
4344 operate in a similar manner.  Likewise, the result of using the unary
4345 minus or complement operators on a vector type is a vector whose
4346 elements are the negative or complemented values of the corresponding
4347 elements in the operand.
4348
4349 You can declare variables and use them in function calls and returns, as
4350 well as in assignments and some casts.  You can specify a vector type as
4351 a return type for a function.  Vector types can also be used as function
4352 arguments.  It is possible to cast from one vector type to another,
4353 provided they are of the same size (in fact, you can also cast vectors
4354 to and from other datatypes of the same size).
4355
4356 You cannot operate between vectors of different lengths or different
4357 signedness without a cast.
4358
4359 A port that supports hardware vector operations, usually provides a set
4360 of built-in functions that can be used to operate on vectors.  For
4361 example, a function to add two vectors and multiply the result by a
4362 third could look like this:
4363
4364 @smallexample
4365 v4si f (v4si a, v4si b, v4si c)
4366 @{
4367   v4si tmp = __builtin_addv4si (a, b);
4368   return __builtin_mulv4si (tmp, c);
4369 @}
4370
4371 @end smallexample
4372
4373 @node Offsetof
4374 @section Offsetof
4375 @findex __builtin_offsetof
4376
4377 GCC implements for both C and C++ a syntactic extension to implement
4378 the @code{offsetof} macro.
4379
4380 @smallexample
4381 primary:
4382         "__builtin_offsetof" "(" @code{typename} "," offsetof_member_designator ")"
4383
4384 offsetof_member_designator:
4385           @code{identifier}
4386         | offsetof_member_designator "." @code{identifier}
4387         | offsetof_member_designator "[" @code{expr} "]"
4388 @end smallexample
4389
4390 This extension is sufficient such that
4391
4392 @smallexample
4393 #define offsetof(@var{type}, @var{member})  __builtin_offsetof (@var{type}, @var{member})
4394 @end smallexample
4395
4396 is a suitable definition of the @code{offsetof} macro.  In C++, @var{type}
4397 may be dependent.  In either case, @var{member} may consist of a single
4398 identifier, or a sequence of member accesses and array references.
4399
4400 @node Other Builtins
4401 @section Other built-in functions provided by GCC
4402 @cindex built-in functions
4403 @findex __builtin_isgreater
4404 @findex __builtin_isgreaterequal
4405 @findex __builtin_isless
4406 @findex __builtin_islessequal
4407 @findex __builtin_islessgreater
4408 @findex __builtin_isunordered
4409 @findex _Exit
4410 @findex _exit
4411 @findex abort
4412 @findex abs
4413 @findex acos
4414 @findex acosf
4415 @findex acosh
4416 @findex acoshf
4417 @findex acoshl
4418 @findex acosl
4419 @findex alloca
4420 @findex asin
4421 @findex asinf
4422 @findex asinh
4423 @findex asinhf
4424 @findex asinhl
4425 @findex asinl
4426 @findex atan
4427 @findex atan2
4428 @findex atan2f
4429 @findex atan2l
4430 @findex atanf
4431 @findex atanh
4432 @findex atanhf
4433 @findex atanhl
4434 @findex atanl
4435 @findex bcmp
4436 @findex bzero
4437 @findex cabs
4438 @findex cabsf
4439 @findex cabsl
4440 @findex cacos
4441 @findex cacosf
4442 @findex cacosh
4443 @findex cacoshf
4444 @findex cacoshl
4445 @findex cacosl
4446 @findex calloc
4447 @findex carg
4448 @findex cargf
4449 @findex cargl
4450 @findex casin
4451 @findex casinf
4452 @findex casinh
4453 @findex casinhf
4454 @findex casinhl
4455 @findex casinl
4456 @findex catan
4457 @findex catanf
4458 @findex catanh
4459 @findex catanhf
4460 @findex catanhl
4461 @findex catanl
4462 @findex cbrt
4463 @findex cbrtf
4464 @findex cbrtl
4465 @findex ccos
4466 @findex ccosf
4467 @findex ccosh
4468 @findex ccoshf
4469 @findex ccoshl
4470 @findex ccosl
4471 @findex ceil
4472 @findex ceilf
4473 @findex ceill
4474 @findex cexp
4475 @findex cexpf
4476 @findex cexpl
4477 @findex cimag
4478 @findex cimagf
4479 @findex cimagl
4480 @findex conj
4481 @findex conjf
4482 @findex conjl
4483 @findex copysign
4484 @findex copysignf
4485 @findex copysignl
4486 @findex cos
4487 @findex cosf
4488 @findex cosh
4489 @findex coshf
4490 @findex coshl
4491 @findex cosl
4492 @findex cpow
4493 @findex cpowf
4494 @findex cpowl
4495 @findex cproj
4496 @findex cprojf
4497 @findex cprojl
4498 @findex creal
4499 @findex crealf
4500 @findex creall
4501 @findex csin
4502 @findex csinf
4503 @findex csinh
4504 @findex csinhf
4505 @findex csinhl
4506 @findex csinl
4507 @findex csqrt
4508 @findex csqrtf
4509 @findex csqrtl
4510 @findex ctan
4511 @findex ctanf
4512 @findex ctanh
4513 @findex ctanhf
4514 @findex ctanhl
4515 @findex ctanl
4516 @findex dcgettext
4517 @findex dgettext
4518 @findex drem
4519 @findex dremf
4520 @findex dreml
4521 @findex erf
4522 @findex erfc
4523 @findex erfcf
4524 @findex erfcl
4525 @findex erff
4526 @findex erfl
4527 @findex exit
4528 @findex exp
4529 @findex exp10
4530 @findex exp10f
4531 @findex exp10l
4532 @findex exp2
4533 @findex exp2f
4534 @findex exp2l
4535 @findex expf
4536 @findex expl
4537 @findex expm1
4538 @findex expm1f
4539 @findex expm1l
4540 @findex fabs
4541 @findex fabsf
4542 @findex fabsl
4543 @findex fdim
4544 @findex fdimf
4545 @findex fdiml
4546 @findex ffs
4547 @findex floor
4548 @findex floorf
4549 @findex floorl
4550 @findex fma
4551 @findex fmaf
4552 @findex fmal
4553 @findex fmax
4554 @findex fmaxf
4555 @findex fmaxl
4556 @findex fmin
4557 @findex fminf
4558 @findex fminl
4559 @findex fmod
4560 @findex fmodf
4561 @findex fmodl
4562 @findex fprintf
4563 @findex fprintf_unlocked
4564 @findex fputs
4565 @findex fputs_unlocked
4566 @findex frexp
4567 @findex frexpf
4568 @findex frexpl
4569 @findex fscanf
4570 @findex gamma
4571 @findex gammaf
4572 @findex gammal
4573 @findex gettext
4574 @findex hypot
4575 @findex hypotf
4576 @findex hypotl
4577 @findex ilogb
4578 @findex ilogbf
4579 @findex ilogbl
4580 @findex imaxabs
4581 @findex index
4582 @findex isalnum
4583 @findex isalpha
4584 @findex isascii
4585 @findex isblank
4586 @findex iscntrl
4587 @findex isdigit
4588 @findex isgraph
4589 @findex islower
4590 @findex isprint
4591 @findex ispunct
4592 @findex isspace
4593 @findex isupper
4594 @findex iswalnum
4595 @findex iswalpha
4596 @findex iswblank
4597 @findex iswcntrl
4598 @findex iswdigit
4599 @findex iswgraph
4600 @findex iswlower
4601 @findex iswprint
4602 @findex iswpunct
4603 @findex iswspace
4604 @findex iswupper
4605 @findex iswxdigit
4606 @findex isxdigit
4607 @findex j0
4608 @findex j0f
4609 @findex j0l
4610 @findex j1
4611 @findex j1f
4612 @findex j1l
4613 @findex jn
4614 @findex jnf
4615 @findex jnl
4616 @findex labs
4617 @findex ldexp
4618 @findex ldexpf
4619 @findex ldexpl
4620 @findex lgamma
4621 @findex lgammaf
4622 @findex lgammal
4623 @findex llabs
4624 @findex llrint
4625 @findex llrintf
4626 @findex llrintl
4627 @findex llround
4628 @findex llroundf
4629 @findex llroundl
4630 @findex log
4631 @findex log10
4632 @findex log10f
4633 @findex log10l
4634 @findex log1p
4635 @findex log1pf
4636 @findex log1pl
4637 @findex log2
4638 @findex log2f
4639 @findex log2l
4640 @findex logb
4641 @findex logbf
4642 @findex logbl
4643 @findex logf
4644 @findex logl
4645 @findex lrint
4646 @findex lrintf
4647 @findex lrintl
4648 @findex lround
4649 @findex lroundf
4650 @findex lroundl
4651 @findex malloc
4652 @findex memcmp
4653 @findex memcpy
4654 @findex mempcpy
4655 @findex memset
4656 @findex modf
4657 @findex modff
4658 @findex modfl
4659 @findex nearbyint
4660 @findex nearbyintf
4661 @findex nearbyintl
4662 @findex nextafter
4663 @findex nextafterf
4664 @findex nextafterl
4665 @findex nexttoward
4666 @findex nexttowardf
4667 @findex nexttowardl
4668 @findex pow
4669 @findex pow10
4670 @findex pow10f
4671 @findex pow10l
4672 @findex powf
4673 @findex powl
4674 @findex printf
4675 @findex printf_unlocked
4676 @findex putchar
4677 @findex puts
4678 @findex remainder
4679 @findex remainderf
4680 @findex remainderl
4681 @findex remquo
4682 @findex remquof
4683 @findex remquol
4684 @findex rindex
4685 @findex rint
4686 @findex rintf
4687 @findex rintl
4688 @findex round
4689 @findex roundf
4690 @findex roundl
4691 @findex scalb
4692 @findex scalbf
4693 @findex scalbl
4694 @findex scalbln
4695 @findex scalblnf
4696 @findex scalblnf
4697 @findex scalbn
4698 @findex scalbnf
4699 @findex scanfnl
4700 @findex signbit
4701 @findex signbitf
4702 @findex signbitl
4703 @findex significand
4704 @findex significandf
4705 @findex significandl
4706 @findex sin
4707 @findex sincos
4708 @findex sincosf
4709 @findex sincosl
4710 @findex sinf
4711 @findex sinh
4712 @findex sinhf
4713 @findex sinhl
4714 @findex sinl
4715 @findex snprintf
4716 @findex sprintf
4717 @findex sqrt
4718 @findex sqrtf
4719 @findex sqrtl
4720 @findex sscanf
4721 @findex stpcpy
4722 @findex strcat
4723 @findex strchr
4724 @findex strcmp
4725 @findex strcpy
4726 @findex strcspn
4727 @findex strdup
4728 @findex strfmon
4729 @findex strftime
4730 @findex strlen
4731 @findex strncat
4732 @findex strncmp
4733 @findex strncpy
4734 @findex strpbrk
4735 @findex strrchr
4736 @findex strspn
4737 @findex strstr
4738 @findex tan
4739 @findex tanf
4740 @findex tanh
4741 @findex tanhf
4742 @findex tanhl
4743 @findex tanl
4744 @findex tgamma
4745 @findex tgammaf
4746 @findex tgammal
4747 @findex toascii
4748 @findex tolower
4749 @findex toupper
4750 @findex towlower
4751 @findex towupper
4752 @findex trunc
4753 @findex truncf
4754 @findex truncl
4755 @findex vfprintf
4756 @findex vfscanf
4757 @findex vprintf
4758 @findex vscanf
4759 @findex vsnprintf
4760 @findex vsprintf
4761 @findex vsscanf
4762 @findex y0
4763 @findex y0f
4764 @findex y0l
4765 @findex y1
4766 @findex y1f
4767 @findex y1l
4768 @findex yn
4769 @findex ynf
4770 @findex ynl
4771
4772 GCC provides a large number of built-in functions other than the ones
4773 mentioned above.  Some of these are for internal use in the processing
4774 of exceptions or variable-length argument lists and will not be
4775 documented here because they may change from time to time; we do not
4776 recommend general use of these functions.
4777
4778 The remaining functions are provided for optimization purposes.
4779
4780 @opindex fno-builtin
4781 GCC includes built-in versions of many of the functions in the standard
4782 C library.  The versions prefixed with @code{__builtin_} will always be
4783 treated as having the same meaning as the C library function even if you
4784 specify the @option{-fno-builtin} option. (@pxref{C Dialect Options})
4785 Many of these functions are only optimized in certain cases; if they are
4786 not optimized in a particular case, a call to the library function will
4787 be emitted.
4788
4789 @opindex ansi
4790 @opindex std
4791 Outside strict ISO C mode (@option{-ansi}, @option{-std=c89} or
4792 @option{-std=c99}), the functions
4793 @code{_exit}, @code{alloca}, @code{bcmp}, @code{bzero},
4794 @code{dcgettext}, @code{dgettext}, @code{dremf}, @code{dreml},
4795 @code{drem}, @code{exp10f}, @code{exp10l}, @code{exp10}, @code{ffsll},
4796 @code{ffsl}, @code{ffs}, @code{fprintf_unlocked}, @code{fputs_unlocked},
4797 @code{gammaf}, @code{gammal}, @code{gamma}, @code{gettext},
4798 @code{index}, @code{isascii}, @code{j0f}, @code{j0l}, @code{j0},
4799 @code{j1f}, @code{j1l}, @code{j1}, @code{jnf}, @code{jnl}, @code{jn},
4800 @code{mempcpy}, @code{pow10f}, @code{pow10l}, @code{pow10},
4801 @code{printf_unlocked}, @code{rindex}, @code{scalbf}, @code{scalbl},
4802 @code{scalb}, @code{signbit}, @code{signbitf}, @code{signbitl},
4803 @code{significandf}, @code{significandl}, @code{significand},
4804 @code{sincosf}, @code{sincosl}, @code{sincos}, @code{stpcpy},
4805 @code{strdup}, @code{strfmon}, @code{toascii}, @code{y0f}, @code{y0l},
4806 @code{y0}, @code{y1f}, @code{y1l}, @code{y1}, @code{ynf}, @code{ynl} and
4807 @code{yn}
4808 may be handled as built-in functions.
4809 All these functions have corresponding versions
4810 prefixed with @code{__builtin_}, which may be used even in strict C89
4811 mode.
4812
4813 The ISO C99 functions
4814 @code{_Exit}, @code{acoshf}, @code{acoshl}, @code{acosh}, @code{asinhf},
4815 @code{asinhl}, @code{asinh}, @code{atanhf}, @code{atanhl}, @code{atanh},
4816 @code{cabsf}, @code{cabsl}, @code{cabs}, @code{cacosf}, @code{cacoshf},
4817 @code{cacoshl}, @code{cacosh}, @code{cacosl}, @code{cacos},
4818 @code{cargf}, @code{cargl}, @code{carg}, @code{casinf}, @code{casinhf},
4819 @code{casinhl}, @code{casinh}, @code{casinl}, @code{casin},
4820 @code{catanf}, @code{catanhf}, @code{catanhl}, @code{catanh},
4821 @code{catanl}, @code{catan}, @code{cbrtf}, @code{cbrtl}, @code{cbrt},
4822 @code{ccosf}, @code{ccoshf}, @code{ccoshl}, @code{ccosh}, @code{ccosl},
4823 @code{ccos}, @code{cexpf}, @code{cexpl}, @code{cexp}, @code{cimagf},
4824 @code{cimagl}, @code{cimag}, @code{conjf}, @code{conjl}, @code{conj},
4825 @code{copysignf}, @code{copysignl}, @code{copysign}, @code{cpowf},
4826 @code{cpowl}, @code{cpow}, @code{cprojf}, @code{cprojl}, @code{cproj},
4827 @code{crealf}, @code{creall}, @code{creal}, @code{csinf}, @code{csinhf},
4828 @code{csinhl}, @code{csinh}, @code{csinl}, @code{csin}, @code{csqrtf},
4829 @code{csqrtl}, @code{csqrt}, @code{ctanf}, @code{ctanhf}, @code{ctanhl},
4830 @code{ctanh}, @code{ctanl}, @code{ctan}, @code{erfcf}, @code{erfcl},
4831 @code{erfc}, @code{erff}, @code{erfl}, @code{erf}, @code{exp2f},
4832 @code{exp2l}, @code{exp2}, @code{expm1f}, @code{expm1l}, @code{expm1},
4833 @code{fdimf}, @code{fdiml}, @code{fdim}, @code{fmaf}, @code{fmal},
4834 @code{fmaxf}, @code{fmaxl}, @code{fmax}, @code{fma}, @code{fminf},
4835 @code{fminl}, @code{fmin}, @code{hypotf}, @code{hypotl}, @code{hypot},
4836 @code{ilogbf}, @code{ilogbl}, @code{ilogb}, @code{imaxabs},
4837 @code{isblank}, @code{iswblank}, @code{lgammaf}, @code{lgammal},
4838 @code{lgamma}, @code{llabs}, @code{llrintf}, @code{llrintl},
4839 @code{llrint}, @code{llroundf}, @code{llroundl}, @code{llround},
4840 @code{log1pf}, @code{log1pl}, @code{log1p}, @code{log2f}, @code{log2l},
4841 @code{log2}, @code{logbf}, @code{logbl}, @code{logb}, @code{lrintf},
4842 @code{lrintl}, @code{lrint}, @code{lroundf}, @code{lroundl},
4843 @code{lround}, @code{nearbyintf}, @code{nearbyintl}, @code{nearbyint},
4844 @code{nextafterf}, @code{nextafterl}, @code{nextafter},
4845 @code{nexttowardf}, @code{nexttowardl}, @code{nexttoward},
4846 @code{remainderf}, @code{remainderl}, @code{remainder}, @code{remquof},
4847 @code{remquol}, @code{remquo}, @code{rintf}, @code{rintl}, @code{rint},
4848 @code{roundf}, @code{roundl}, @code{round}, @code{scalblnf},
4849 @code{scalblnl}, @code{scalbln}, @code{scalbnf}, @code{scalbnl},
4850 @code{scalbn}, @code{snprintf}, @code{tgammaf}, @code{tgammal},
4851 @code{tgamma}, @code{truncf}, @code{truncl}, @code{trunc},
4852 @code{vfscanf}, @code{vscanf}, @code{vsnprintf} and @code{vsscanf}
4853 are handled as built-in functions
4854 except in strict ISO C90 mode (@option{-ansi} or @option{-std=c89}).
4855
4856 There are also built-in versions of the ISO C99 functions
4857 @code{acosf}, @code{acosl}, @code{asinf}, @code{asinl}, @code{atan2f},
4858 @code{atan2l}, @code{atanf}, @code{atanl}, @code{ceilf}, @code{ceill},
4859 @code{cosf}, @code{coshf}, @code{coshl}, @code{cosl}, @code{expf},
4860 @code{expl}, @code{fabsf}, @code{fabsl}, @code{floorf}, @code{floorl},
4861 @code{fmodf}, @code{fmodl}, @code{frexpf}, @code{frexpl}, @code{ldexpf},
4862 @code{ldexpl}, @code{log10f}, @code{log10l}, @code{logf}, @code{logl},
4863 @code{modfl}, @code{modf}, @code{powf}, @code{powl}, @code{sinf},
4864 @code{sinhf}, @code{sinhl}, @code{sinl}, @code{sqrtf}, @code{sqrtl},
4865 @code{tanf}, @code{tanhf}, @code{tanhl} and @code{tanl}
4866 that are recognized in any mode since ISO C90 reserves these names for
4867 the purpose to which ISO C99 puts them.  All these functions have
4868 corresponding versions prefixed with @code{__builtin_}.
4869
4870 The ISO C94 functions
4871 @code{iswalnum}, @code{iswalpha}, @code{iswcntrl}, @code{iswdigit},
4872 @code{iswgraph}, @code{iswlower}, @code{iswprint}, @code{iswpunct},
4873 @code{iswspace}, @code{iswupper}, @code{iswxdigit}, @code{towlower} and
4874 @code{towupper}
4875 are handled as built-in functions
4876 except in strict ISO C90 mode (@option{-ansi} or @option{-std=c89}).
4877
4878 The ISO C90 functions
4879 @code{abort}, @code{abs}, @code{acos}, @code{asin}, @code{atan2},
4880 @code{atan}, @code{calloc}, @code{ceil}, @code{cosh}, @code{cos},
4881 @code{exit}, @code{exp}, @code{fabs}, @code{floor}, @code{fmod},
4882 @code{fprintf}, @code{fputs}, @code{frexp}, @code{fscanf},
4883 @code{isalnum}, @code{isalpha}, @code{iscntrl}, @code{isdigit},
4884 @code{isgraph}, @code{islower}, @code{isprint}, @code{ispunct},
4885 @code{isspace}, @code{isupper}, @code{isxdigit}, @code{tolower},
4886 @code{toupper}, @code{labs}, @code{ldexp}, @code{log10}, @code{log},
4887 @code{malloc}, @code{memcmp}, @code{memcpy}, @code{memset}, @code{modf},
4888 @code{pow}, @code{printf}, @code{putchar}, @code{puts}, @code{scanf},
4889 @code{sinh}, @code{sin}, @code{snprintf}, @code{sprintf}, @code{sqrt},
4890 @code{sscanf}, @code{strcat}, @code{strchr}, @code{strcmp},
4891 @code{strcpy}, @code{strcspn}, @code{strlen}, @code{strncat},
4892 @code{strncmp}, @code{strncpy}, @code{strpbrk}, @code{strrchr},
4893 @code{strspn}, @code{strstr}, @code{tanh}, @code{tan}, @code{vfprintf},
4894 @code{vprintf} and @code{vsprintf}
4895 are all recognized as built-in functions unless
4896 @option{-fno-builtin} is specified (or @option{-fno-builtin-@var{function}}
4897 is specified for an individual function).  All of these functions have
4898 corresponding versions prefixed with @code{__builtin_}.
4899
4900 GCC provides built-in versions of the ISO C99 floating point comparison
4901 macros that avoid raising exceptions for unordered operands.  They have
4902 the same names as the standard macros ( @code{isgreater},
4903 @code{isgreaterequal}, @code{isless}, @code{islessequal},
4904 @code{islessgreater}, and @code{isunordered}) , with @code{__builtin_}
4905 prefixed.  We intend for a library implementor to be able to simply
4906 @code{#define} each standard macro to its built-in equivalent.
4907
4908 @deftypefn {Built-in Function} int __builtin_types_compatible_p (@var{type1}, @var{type2})
4909
4910 You can use the built-in function @code{__builtin_types_compatible_p} to
4911 determine whether two types are the same.
4912
4913 This built-in function returns 1 if the unqualified versions of the
4914 types @var{type1} and @var{type2} (which are types, not expressions) are
4915 compatible, 0 otherwise.  The result of this built-in function can be
4916 used in integer constant expressions.
4917
4918 This built-in function ignores top level qualifiers (e.g., @code{const},
4919 @code{volatile}).  For example, @code{int} is equivalent to @code{const
4920 int}.
4921
4922 The type @code{int[]} and @code{int[5]} are compatible.  On the other
4923 hand, @code{int} and @code{char *} are not compatible, even if the size
4924 of their types, on the particular architecture are the same.  Also, the
4925 amount of pointer indirection is taken into account when determining
4926 similarity.  Consequently, @code{short *} is not similar to
4927 @code{short **}.  Furthermore, two types that are typedefed are
4928 considered compatible if their underlying types are compatible.
4929
4930 An @code{enum} type is not considered to be compatible with another
4931 @code{enum} type even if both are compatible with the same integer
4932 type; this is what the C standard specifies.
4933 For example, @code{enum @{foo, bar@}} is not similar to
4934 @code{enum @{hot, dog@}}.
4935
4936 You would typically use this function in code whose execution varies
4937 depending on the arguments' types.  For example:
4938
4939 @smallexample
4940 #define foo(x)                                                  \
4941   (@{                                                           \
4942     typeof (x) tmp;                                             \
4943     if (__builtin_types_compatible_p (typeof (x), long double)) \
4944       tmp = foo_long_double (tmp);                              \
4945     else if (__builtin_types_compatible_p (typeof (x), double)) \
4946       tmp = foo_double (tmp);                                   \
4947     else if (__builtin_types_compatible_p (typeof (x), float))  \
4948       tmp = foo_float (tmp);                                    \
4949     else                                                        \
4950       abort ();                                                 \
4951     tmp;                                                        \
4952   @})
4953 @end smallexample
4954
4955 @emph{Note:} This construct is only available for C.
4956
4957 @end deftypefn
4958
4959 @deftypefn {Built-in Function} @var{type} __builtin_choose_expr (@var{const_exp}, @var{exp1}, @var{exp2})
4960
4961 You can use the built-in function @code{__builtin_choose_expr} to
4962 evaluate code depending on the value of a constant expression.  This
4963 built-in function returns @var{exp1} if @var{const_exp}, which is a
4964 constant expression that must be able to be determined at compile time,
4965 is nonzero.  Otherwise it returns 0.
4966
4967 This built-in function is analogous to the @samp{? :} operator in C,
4968 except that the expression returned has its type unaltered by promotion
4969 rules.  Also, the built-in function does not evaluate the expression
4970 that was not chosen.  For example, if @var{const_exp} evaluates to true,
4971 @var{exp2} is not evaluated even if it has side-effects.
4972
4973 This built-in function can return an lvalue if the chosen argument is an
4974 lvalue.
4975
4976 If @var{exp1} is returned, the return type is the same as @var{exp1}'s
4977 type.  Similarly, if @var{exp2} is returned, its return type is the same
4978 as @var{exp2}.
4979
4980 Example:
4981
4982 @smallexample
4983 #define foo(x)                                                    \
4984   __builtin_choose_expr (                                         \
4985     __builtin_types_compatible_p (typeof (x), double),            \
4986     foo_double (x),                                               \
4987     __builtin_choose_expr (                                       \
4988       __builtin_types_compatible_p (typeof (x), float),           \
4989       foo_float (x),                                              \
4990       /* @r{The void expression results in a compile-time error}  \
4991          @r{when assigning the result to something.}  */          \
4992       (void)0))
4993 @end smallexample
4994
4995 @emph{Note:} This construct is only available for C.  Furthermore, the
4996 unused expression (@var{exp1} or @var{exp2} depending on the value of
4997 @var{const_exp}) may still generate syntax errors.  This may change in
4998 future revisions.
4999
5000 @end deftypefn
5001
5002 @deftypefn {Built-in Function} int __builtin_constant_p (@var{exp})
5003 You can use the built-in function @code{__builtin_constant_p} to
5004 determine if a value is known to be constant at compile-time and hence
5005 that GCC can perform constant-folding on expressions involving that
5006 value.  The argument of the function is the value to test.  The function
5007 returns the integer 1 if the argument is known to be a compile-time
5008 constant and 0 if it is not known to be a compile-time constant.  A
5009 return of 0 does not indicate that the value is @emph{not} a constant,
5010 but merely that GCC cannot prove it is a constant with the specified
5011 value of the @option{-O} option.
5012
5013 You would typically use this function in an embedded application where
5014 memory was a critical resource.  If you have some complex calculation,
5015 you may want it to be folded if it involves constants, but need to call
5016 a function if it does not.  For example:
5017
5018 @smallexample
5019 #define Scale_Value(X)      \
5020   (__builtin_constant_p (X) \
5021   ? ((X) * SCALE + OFFSET) : Scale (X))
5022 @end smallexample
5023
5024 You may use this built-in function in either a macro or an inline
5025 function.  However, if you use it in an inlined function and pass an
5026 argument of the function as the argument to the built-in, GCC will
5027 never return 1 when you call the inline function with a string constant
5028 or compound literal (@pxref{Compound Literals}) and will not return 1
5029 when you pass a constant numeric value to the inline function unless you
5030 specify the @option{-O} option.
5031
5032 You may also use @code{__builtin_constant_p} in initializers for static
5033 data.  For instance, you can write
5034
5035 @smallexample
5036 static const int table[] = @{
5037    __builtin_constant_p (EXPRESSION) ? (EXPRESSION) : -1,
5038    /* @r{@dots{}} */
5039 @};
5040 @end smallexample
5041
5042 @noindent
5043 This is an acceptable initializer even if @var{EXPRESSION} is not a
5044 constant expression.  GCC must be more conservative about evaluating the
5045 built-in in this case, because it has no opportunity to perform
5046 optimization.
5047
5048 Previous versions of GCC did not accept this built-in in data
5049 initializers.  The earliest version where it is completely safe is
5050 3.0.1.
5051 @end deftypefn
5052
5053 @deftypefn {Built-in Function} long __builtin_expect (long @var{exp}, long @var{c})
5054 @opindex fprofile-arcs
5055 You may use @code{__builtin_expect} to provide the compiler with
5056 branch prediction information.  In general, you should prefer to
5057 use actual profile feedback for this (@option{-fprofile-arcs}), as
5058 programmers are notoriously bad at predicting how their programs
5059 actually perform.  However, there are applications in which this
5060 data is hard to collect.
5061
5062 The return value is the value of @var{exp}, which should be an
5063 integral expression.  The value of @var{c} must be a compile-time
5064 constant.  The semantics of the built-in are that it is expected
5065 that @var{exp} == @var{c}.  For example:
5066
5067 @smallexample
5068 if (__builtin_expect (x, 0))
5069   foo ();
5070 @end smallexample
5071
5072 @noindent
5073 would indicate that we do not expect to call @code{foo}, since
5074 we expect @code{x} to be zero.  Since you are limited to integral
5075 expressions for @var{exp}, you should use constructions such as
5076
5077 @smallexample
5078 if (__builtin_expect (ptr != NULL, 1))
5079   error ();
5080 @end smallexample
5081
5082 @noindent
5083 when testing pointer or floating-point values.
5084 @end deftypefn
5085
5086 @deftypefn {Built-in Function} void __builtin_prefetch (const void *@var{addr}, ...)
5087 This function is used to minimize cache-miss latency by moving data into
5088 a cache before it is accessed.
5089 You can insert calls to @code{__builtin_prefetch} into code for which
5090 you know addresses of data in memory that is likely to be accessed soon.
5091 If the target supports them, data prefetch instructions will be generated.
5092 If the prefetch is done early enough before the access then the data will
5093 be in the cache by the time it is accessed.
5094
5095 The value of @var{addr} is the address of the memory to prefetch.
5096 There are two optional arguments, @var{rw} and @var{locality}.
5097 The value of @var{rw} is a compile-time constant one or zero; one
5098 means that the prefetch is preparing for a write to the memory address
5099 and zero, the default, means that the prefetch is preparing for a read.
5100 The value @var{locality} must be a compile-time constant integer between
5101 zero and three.  A value of zero means that the data has no temporal
5102 locality, so it need not be left in the cache after the access.  A value
5103 of three means that the data has a high degree of temporal locality and
5104 should be left in all levels of cache possible.  Values of one and two
5105 mean, respectively, a low or moderate degree of temporal locality.  The
5106 default is three.
5107
5108 @smallexample
5109 for (i = 0; i < n; i++)
5110   @{
5111     a[i] = a[i] + b[i];
5112     __builtin_prefetch (&a[i+j], 1, 1);
5113     __builtin_prefetch (&b[i+j], 0, 1);
5114     /* @r{@dots{}} */
5115   @}
5116 @end smallexample
5117
5118 Data prefetch does not generate faults if @var{addr} is invalid, but
5119 the address expression itself must be valid.  For example, a prefetch
5120 of @code{p->next} will not fault if @code{p->next} is not a valid
5121 address, but evaluation will fault if @code{p} is not a valid address.
5122
5123 If the target does not support data prefetch, the address expression
5124 is evaluated if it includes side effects but no other code is generated
5125 and GCC does not issue a warning.
5126 @end deftypefn
5127
5128 @deftypefn {Built-in Function} double __builtin_huge_val (void)
5129 Returns a positive infinity, if supported by the floating-point format,
5130 else @code{DBL_MAX}.  This function is suitable for implementing the
5131 ISO C macro @code{HUGE_VAL}.
5132 @end deftypefn
5133
5134 @deftypefn {Built-in Function} float __builtin_huge_valf (void)
5135 Similar to @code{__builtin_huge_val}, except the return type is @code{float}.
5136 @end deftypefn
5137
5138 @deftypefn {Built-in Function} {long double} __builtin_huge_vall (void)
5139 Similar to @code{__builtin_huge_val}, except the return
5140 type is @code{long double}.
5141 @end deftypefn
5142
5143 @deftypefn {Built-in Function} double __builtin_inf (void)
5144 Similar to @code{__builtin_huge_val}, except a warning is generated
5145 if the target floating-point format does not support infinities.
5146 This function is suitable for implementing the ISO C99 macro @code{INFINITY}.
5147 @end deftypefn
5148
5149 @deftypefn {Built-in Function} float __builtin_inff (void)
5150 Similar to @code{__builtin_inf}, except the return type is @code{float}.
5151 @end deftypefn
5152
5153 @deftypefn {Built-in Function} {long double} __builtin_infl (void)
5154 Similar to @code{__builtin_inf}, except the return
5155 type is @code{long double}.
5156 @end deftypefn
5157
5158 @deftypefn {Built-in Function} double __builtin_nan (const char *str)
5159 This is an implementation of the ISO C99 function @code{nan}.
5160
5161 Since ISO C99 defines this function in terms of @code{strtod}, which we
5162 do not implement, a description of the parsing is in order.  The string
5163 is parsed as by @code{strtol}; that is, the base is recognized by
5164 leading @samp{0} or @samp{0x} prefixes.  The number parsed is placed
5165 in the significand such that the least significant bit of the number
5166 is at the least significant bit of the significand.  The number is
5167 truncated to fit the significand field provided.  The significand is
5168 forced to be a quiet NaN.
5169
5170 This function, if given a string literal, is evaluated early enough
5171 that it is considered a compile-time constant.
5172 @end deftypefn
5173
5174 @deftypefn {Built-in Function} float __builtin_nanf (const char *str)
5175 Similar to @code{__builtin_nan}, except the return type is @code{float}.
5176 @end deftypefn
5177
5178 @deftypefn {Built-in Function} {long double} __builtin_nanl (const char *str)
5179 Similar to @code{__builtin_nan}, except the return type is @code{long double}.
5180 @end deftypefn
5181
5182 @deftypefn {Built-in Function} double __builtin_nans (const char *str)
5183 Similar to @code{__builtin_nan}, except the significand is forced
5184 to be a signaling NaN.  The @code{nans} function is proposed by
5185 @uref{http://www.open-std.org/jtc1/sc22/wg14/www/docs/n965.htm,,WG14 N965}.
5186 @end deftypefn
5187
5188 @deftypefn {Built-in Function} float __builtin_nansf (const char *str)
5189 Similar to @code{__builtin_nans}, except the return type is @code{float}.
5190 @end deftypefn
5191
5192 @deftypefn {Built-in Function} {long double} __builtin_nansl (const char *str)
5193 Similar to @code{__builtin_nans}, except the return type is @code{long double}.
5194 @end deftypefn
5195
5196 @deftypefn {Built-in Function} int __builtin_ffs (unsigned int x)
5197 Returns one plus the index of the least significant 1-bit of @var{x}, or
5198 if @var{x} is zero, returns zero.
5199 @end deftypefn
5200
5201 @deftypefn {Built-in Function} int __builtin_clz (unsigned int x)
5202 Returns the number of leading 0-bits in @var{x}, starting at the most
5203 significant bit position.  If @var{x} is 0, the result is undefined.
5204 @end deftypefn
5205
5206 @deftypefn {Built-in Function} int __builtin_ctz (unsigned int x)
5207 Returns the number of trailing 0-bits in @var{x}, starting at the least
5208 significant bit position.  If @var{x} is 0, the result is undefined.
5209 @end deftypefn
5210
5211 @deftypefn {Built-in Function} int __builtin_popcount (unsigned int x)
5212 Returns the number of 1-bits in @var{x}.
5213 @end deftypefn
5214
5215 @deftypefn {Built-in Function} int __builtin_parity (unsigned int x)
5216 Returns the parity of @var{x}, i.@:e. the number of 1-bits in @var{x}
5217 modulo 2.
5218 @end deftypefn
5219
5220 @deftypefn {Built-in Function} int __builtin_ffsl (unsigned long)
5221 Similar to @code{__builtin_ffs}, except the argument type is
5222 @code{unsigned long}.
5223 @end deftypefn
5224
5225 @deftypefn {Built-in Function} int __builtin_clzl (unsigned long)
5226 Similar to @code{__builtin_clz}, except the argument type is
5227 @code{unsigned long}.
5228 @end deftypefn
5229
5230 @deftypefn {Built-in Function} int __builtin_ctzl (unsigned long)
5231 Similar to @code{__builtin_ctz}, except the argument type is
5232 @code{unsigned long}.
5233 @end deftypefn
5234
5235 @deftypefn {Built-in Function} int __builtin_popcountl (unsigned long)
5236 Similar to @code{__builtin_popcount}, except the argument type is
5237 @code{unsigned long}.
5238 @end deftypefn
5239
5240 @deftypefn {Built-in Function} int __builtin_parityl (unsigned long)
5241 Similar to @code{__builtin_parity}, except the argument type is
5242 @code{unsigned long}.
5243 @end deftypefn
5244
5245 @deftypefn {Built-in Function} int __builtin_ffsll (unsigned long long)
5246 Similar to @code{__builtin_ffs}, except the argument type is
5247 @code{unsigned long long}.
5248 @end deftypefn
5249
5250 @deftypefn {Built-in Function} int __builtin_clzll (unsigned long long)
5251 Similar to @code{__builtin_clz}, except the argument type is
5252 @code{unsigned long long}.
5253 @end deftypefn
5254
5255 @deftypefn {Built-in Function} int __builtin_ctzll (unsigned long long)
5256 Similar to @code{__builtin_ctz}, except the argument type is
5257 @code{unsigned long long}.
5258 @end deftypefn
5259
5260 @deftypefn {Built-in Function} int __builtin_popcountll (unsigned long long)
5261 Similar to @code{__builtin_popcount}, except the argument type is
5262 @code{unsigned long long}.
5263 @end deftypefn
5264
5265 @deftypefn {Built-in Function} int __builtin_parityll (unsigned long long)
5266 Similar to @code{__builtin_parity}, except the argument type is
5267 @code{unsigned long long}.
5268 @end deftypefn
5269
5270
5271 @node Target Builtins
5272 @section Built-in Functions Specific to Particular Target Machines
5273
5274 On some target machines, GCC supports many built-in functions specific
5275 to those machines.  Generally these generate calls to specific machine
5276 instructions, but allow the compiler to schedule those calls.
5277
5278 @menu
5279 * Alpha Built-in Functions::
5280 * ARM Built-in Functions::
5281 * X86 Built-in Functions::
5282 * PowerPC AltiVec Built-in Functions::
5283 @end menu
5284
5285 @node Alpha Built-in Functions
5286 @subsection Alpha Built-in Functions
5287
5288 These built-in functions are available for the Alpha family of
5289 processors, depending on the command-line switches used.
5290
5291 The following built-in functions are always available.  They
5292 all generate the machine instruction that is part of the name.
5293
5294 @smallexample
5295 long __builtin_alpha_implver (void)
5296 long __builtin_alpha_rpcc (void)
5297 long __builtin_alpha_amask (long)
5298 long __builtin_alpha_cmpbge (long, long)
5299 long __builtin_alpha_extbl (long, long)
5300 long __builtin_alpha_extwl (long, long)
5301 long __builtin_alpha_extll (long, long)
5302 long __builtin_alpha_extql (long, long)
5303 long __builtin_alpha_extwh (long, long)
5304 long __builtin_alpha_extlh (long, long)
5305 long __builtin_alpha_extqh (long, long)
5306 long __builtin_alpha_insbl (long, long)
5307 long __builtin_alpha_inswl (long, long)
5308 long __builtin_alpha_insll (long, long)
5309 long __builtin_alpha_insql (long, long)
5310 long __builtin_alpha_inswh (long, long)
5311 long __builtin_alpha_inslh (long, long)
5312 long __builtin_alpha_insqh (long, long)
5313 long __builtin_alpha_mskbl (long, long)
5314 long __builtin_alpha_mskwl (long, long)
5315 long __builtin_alpha_mskll (long, long)
5316 long __builtin_alpha_mskql (long, long)
5317 long __builtin_alpha_mskwh (long, long)
5318 long __builtin_alpha_msklh (long, long)
5319 long __builtin_alpha_mskqh (long, long)
5320 long __builtin_alpha_umulh (long, long)
5321 long __builtin_alpha_zap (long, long)
5322 long __builtin_alpha_zapnot (long, long)
5323 @end smallexample
5324
5325 The following built-in functions are always with @option{-mmax}
5326 or @option{-mcpu=@var{cpu}} where @var{cpu} is @code{pca56} or
5327 later.  They all generate the machine instruction that is part
5328 of the name.
5329
5330 @smallexample
5331 long __builtin_alpha_pklb (long)
5332 long __builtin_alpha_pkwb (long)
5333 long __builtin_alpha_unpkbl (long)
5334 long __builtin_alpha_unpkbw (long)
5335 long __builtin_alpha_minub8 (long, long)
5336 long __builtin_alpha_minsb8 (long, long)
5337 long __builtin_alpha_minuw4 (long, long)
5338 long __builtin_alpha_minsw4 (long, long)
5339 long __builtin_alpha_maxub8 (long, long)
5340 long __builtin_alpha_maxsb8 (long, long)
5341 long __builtin_alpha_maxuw4 (long, long)
5342 long __builtin_alpha_maxsw4 (long, long)
5343 long __builtin_alpha_perr (long, long)
5344 @end smallexample
5345
5346 The following built-in functions are always with @option{-mcix}
5347 or @option{-mcpu=@var{cpu}} where @var{cpu} is @code{ev67} or
5348 later.  They all generate the machine instruction that is part
5349 of the name.
5350
5351 @smallexample
5352 long __builtin_alpha_cttz (long)
5353 long __builtin_alpha_ctlz (long)
5354 long __builtin_alpha_ctpop (long)
5355 @end smallexample
5356
5357 The following builtins are available on systems that use the OSF/1
5358 PALcode.  Normally they invoke the @code{rduniq} and @code{wruniq}
5359 PAL calls, but when invoked with @option{-mtls-kernel}, they invoke
5360 @code{rdval} and @code{wrval}.
5361
5362 @smallexample
5363 void *__builtin_thread_pointer (void)
5364 void __builtin_set_thread_pointer (void *)
5365 @end smallexample
5366
5367 @node ARM Built-in Functions
5368 @subsection ARM Built-in Functions
5369
5370 These built-in functions are available for the ARM family of
5371 processors, when the @option{-mcpu=iwmmxt} switch is used:
5372
5373 @smallexample
5374 typedef int v2si __attribute__ ((vector_size (8)));
5375 typedef short v4hi __attribute__ ((vector_size (8)));
5376 typedef char v8qi __attribute__ ((vector_size (8)));
5377
5378 int __builtin_arm_getwcx (int)
5379 void __builtin_arm_setwcx (int, int)
5380 int __builtin_arm_textrmsb (v8qi, int)
5381 int __builtin_arm_textrmsh (v4hi, int)
5382 int __builtin_arm_textrmsw (v2si, int)
5383 int __builtin_arm_textrmub (v8qi, int)
5384 int __builtin_arm_textrmuh (v4hi, int)
5385 int __builtin_arm_textrmuw (v2si, int)
5386 v8qi __builtin_arm_tinsrb (v8qi, int)
5387 v4hi __builtin_arm_tinsrh (v4hi, int)
5388 v2si __builtin_arm_tinsrw (v2si, int)
5389 long long __builtin_arm_tmia (long long, int, int)
5390 long long __builtin_arm_tmiabb (long long, int, int)
5391 long long __builtin_arm_tmiabt (long long, int, int)
5392 long long __builtin_arm_tmiaph (long long, int, int)
5393 long long __builtin_arm_tmiatb (long long, int, int)
5394 long long __builtin_arm_tmiatt (long long, int, int)
5395 int __builtin_arm_tmovmskb (v8qi)
5396 int __builtin_arm_tmovmskh (v4hi)
5397 int __builtin_arm_tmovmskw (v2si)
5398 long long __builtin_arm_waccb (v8qi)
5399 long long __builtin_arm_wacch (v4hi)
5400 long long __builtin_arm_waccw (v2si)
5401 v8qi __builtin_arm_waddb (v8qi, v8qi)
5402 v8qi __builtin_arm_waddbss (v8qi, v8qi)
5403 v8qi __builtin_arm_waddbus (v8qi, v8qi)
5404 v4hi __builtin_arm_waddh (v4hi, v4hi)
5405 v4hi __builtin_arm_waddhss (v4hi, v4hi)
5406 v4hi __builtin_arm_waddhus (v4hi, v4hi)
5407 v2si __builtin_arm_waddw (v2si, v2si)
5408 v2si __builtin_arm_waddwss (v2si, v2si)
5409 v2si __builtin_arm_waddwus (v2si, v2si)
5410 v8qi __builtin_arm_walign (v8qi, v8qi, int)
5411 long long __builtin_arm_wand(long long, long long)
5412 long long __builtin_arm_wandn (long long, long long)
5413 v8qi __builtin_arm_wavg2b (v8qi, v8qi)
5414 v8qi __builtin_arm_wavg2br (v8qi, v8qi)
5415 v4hi __builtin_arm_wavg2h (v4hi, v4hi)
5416 v4hi __builtin_arm_wavg2hr (v4hi, v4hi)
5417 v8qi __builtin_arm_wcmpeqb (v8qi, v8qi)
5418 v4hi __builtin_arm_wcmpeqh (v4hi, v4hi)
5419 v2si __builtin_arm_wcmpeqw (v2si, v2si)
5420 v8qi __builtin_arm_wcmpgtsb (v8qi, v8qi)
5421 v4hi __builtin_arm_wcmpgtsh (v4hi, v4hi)
5422 v2si __builtin_arm_wcmpgtsw (v2si, v2si)
5423 v8qi __builtin_arm_wcmpgtub (v8qi, v8qi)
5424 v4hi __builtin_arm_wcmpgtuh (v4hi, v4hi)
5425 v2si __builtin_arm_wcmpgtuw (v2si, v2si)
5426 long long __builtin_arm_wmacs (long long, v4hi, v4hi)
5427 long long __builtin_arm_wmacsz (v4hi, v4hi)
5428 long long __builtin_arm_wmacu (long long, v4hi, v4hi)
5429 long long __builtin_arm_wmacuz (v4hi, v4hi)
5430 v4hi __builtin_arm_wmadds (v4hi, v4hi)
5431 v4hi __builtin_arm_wmaddu (v4hi, v4hi)
5432 v8qi __builtin_arm_wmaxsb (v8qi, v8qi)
5433 v4hi __builtin_arm_wmaxsh (v4hi, v4hi)
5434 v2si __builtin_arm_wmaxsw (v2si, v2si)
5435 v8qi __builtin_arm_wmaxub (v8qi, v8qi)
5436 v4hi __builtin_arm_wmaxuh (v4hi, v4hi)
5437 v2si __builtin_arm_wmaxuw (v2si, v2si)
5438 v8qi __builtin_arm_wminsb (v8qi, v8qi)
5439 v4hi __builtin_arm_wminsh (v4hi, v4hi)
5440 v2si __builtin_arm_wminsw (v2si, v2si)
5441 v8qi __builtin_arm_wminub (v8qi, v8qi)
5442 v4hi __builtin_arm_wminuh (v4hi, v4hi)
5443 v2si __builtin_arm_wminuw (v2si, v2si)
5444 v4hi __builtin_arm_wmulsm (v4hi, v4hi)
5445 v4hi __builtin_arm_wmulul (v4hi, v4hi)
5446 v4hi __builtin_arm_wmulum (v4hi, v4hi)
5447 long long __builtin_arm_wor (long long, long long)
5448 v2si __builtin_arm_wpackdss (long long, long long)
5449 v2si __builtin_arm_wpackdus (long long, long long)
5450 v8qi __builtin_arm_wpackhss (v4hi, v4hi)
5451 v8qi __builtin_arm_wpackhus (v4hi, v4hi)
5452 v4hi __builtin_arm_wpackwss (v2si, v2si)
5453 v4hi __builtin_arm_wpackwus (v2si, v2si)
5454 long long __builtin_arm_wrord (long long, long long)
5455 long long __builtin_arm_wrordi (long long, int)
5456 v4hi __builtin_arm_wrorh (v4hi, long long)
5457 v4hi __builtin_arm_wrorhi (v4hi, int)
5458 v2si __builtin_arm_wrorw (v2si, long long)
5459 v2si __builtin_arm_wrorwi (v2si, int)
5460 v2si __builtin_arm_wsadb (v8qi, v8qi)
5461 v2si __builtin_arm_wsadbz (v8qi, v8qi)
5462 v2si __builtin_arm_wsadh (v4hi, v4hi)
5463 v2si __builtin_arm_wsadhz (v4hi, v4hi)
5464 v4hi __builtin_arm_wshufh (v4hi, int)
5465 long long __builtin_arm_wslld (long long, long long)
5466 long long __builtin_arm_wslldi (long long, int)
5467 v4hi __builtin_arm_wsllh (v4hi, long long)
5468 v4hi __builtin_arm_wsllhi (v4hi, int)
5469 v2si __builtin_arm_wsllw (v2si, long long)
5470 v2si __builtin_arm_wsllwi (v2si, int)
5471 long long __builtin_arm_wsrad (long long, long long)
5472 long long __builtin_arm_wsradi (long long, int)
5473 v4hi __builtin_arm_wsrah (v4hi, long long)
5474 v4hi __builtin_arm_wsrahi (v4hi, int)
5475 v2si __builtin_arm_wsraw (v2si, long long)
5476 v2si __builtin_arm_wsrawi (v2si, int)
5477 long long __builtin_arm_wsrld (long long, long long)
5478 long long __builtin_arm_wsrldi (long long, int)
5479 v4hi __builtin_arm_wsrlh (v4hi, long long)
5480 v4hi __builtin_arm_wsrlhi (v4hi, int)
5481 v2si __builtin_arm_wsrlw (v2si, long long)
5482 v2si __builtin_arm_wsrlwi (v2si, int)
5483 v8qi __builtin_arm_wsubb (v8qi, v8qi)
5484 v8qi __builtin_arm_wsubbss (v8qi, v8qi)
5485 v8qi __builtin_arm_wsubbus (v8qi, v8qi)
5486 v4hi __builtin_arm_wsubh (v4hi, v4hi)
5487 v4hi __builtin_arm_wsubhss (v4hi, v4hi)
5488 v4hi __builtin_arm_wsubhus (v4hi, v4hi)
5489 v2si __builtin_arm_wsubw (v2si, v2si)
5490 v2si __builtin_arm_wsubwss (v2si, v2si)
5491 v2si __builtin_arm_wsubwus (v2si, v2si)
5492 v4hi __builtin_arm_wunpckehsb (v8qi)
5493 v2si __builtin_arm_wunpckehsh (v4hi)
5494 long long __builtin_arm_wunpckehsw (v2si)
5495 v4hi __builtin_arm_wunpckehub (v8qi)
5496 v2si __builtin_arm_wunpckehuh (v4hi)
5497 long long __builtin_arm_wunpckehuw (v2si)
5498 v4hi __builtin_arm_wunpckelsb (v8qi)
5499 v2si __builtin_arm_wunpckelsh (v4hi)
5500 long long __builtin_arm_wunpckelsw (v2si)
5501 v4hi __builtin_arm_wunpckelub (v8qi)
5502 v2si __builtin_arm_wunpckeluh (v4hi)
5503 long long __builtin_arm_wunpckeluw (v2si)
5504 v8qi __builtin_arm_wunpckihb (v8qi, v8qi)
5505 v4hi __builtin_arm_wunpckihh (v4hi, v4hi)
5506 v2si __builtin_arm_wunpckihw (v2si, v2si)
5507 v8qi __builtin_arm_wunpckilb (v8qi, v8qi)
5508 v4hi __builtin_arm_wunpckilh (v4hi, v4hi)
5509 v2si __builtin_arm_wunpckilw (v2si, v2si)
5510 long long __builtin_arm_wxor (long long, long long)
5511 long long __builtin_arm_wzero ()
5512 @end smallexample
5513
5514 @node X86 Built-in Functions
5515 @subsection X86 Built-in Functions
5516
5517 These built-in functions are available for the i386 and x86-64 family
5518 of computers, depending on the command-line switches used.
5519
5520 The following machine modes are available for use with MMX built-in functions
5521 (@pxref{Vector Extensions}): @code{V2SI} for a vector of two 32-bit integers,
5522 @code{V4HI} for a vector of four 16-bit integers, and @code{V8QI} for a
5523 vector of eight 8-bit integers.  Some of the built-in functions operate on
5524 MMX registers as a whole 64-bit entity, these use @code{DI} as their mode.
5525
5526 If 3Dnow extensions are enabled, @code{V2SF} is used as a mode for a vector
5527 of two 32-bit floating point values.
5528
5529 If SSE extensions are enabled, @code{V4SF} is used for a vector of four 32-bit
5530 floating point values.  Some instructions use a vector of four 32-bit
5531 integers, these use @code{V4SI}.  Finally, some instructions operate on an
5532 entire vector register, interpreting it as a 128-bit integer, these use mode
5533 @code{TI}.
5534
5535 The following built-in functions are made available by @option{-mmmx}.
5536 All of them generate the machine instruction that is part of the name.
5537
5538 @smallexample
5539 v8qi __builtin_ia32_paddb (v8qi, v8qi)
5540 v4hi __builtin_ia32_paddw (v4hi, v4hi)
5541 v2si __builtin_ia32_paddd (v2si, v2si)
5542 v8qi __builtin_ia32_psubb (v8qi, v8qi)
5543 v4hi __builtin_ia32_psubw (v4hi, v4hi)
5544 v2si __builtin_ia32_psubd (v2si, v2si)
5545 v8qi __builtin_ia32_paddsb (v8qi, v8qi)
5546 v4hi __builtin_ia32_paddsw (v4hi, v4hi)
5547 v8qi __builtin_ia32_psubsb (v8qi, v8qi)
5548 v4hi __builtin_ia32_psubsw (v4hi, v4hi)
5549 v8qi __builtin_ia32_paddusb (v8qi, v8qi)
5550 v4hi __builtin_ia32_paddusw (v4hi, v4hi)
5551 v8qi __builtin_ia32_psubusb (v8qi, v8qi)
5552 v4hi __builtin_ia32_psubusw (v4hi, v4hi)
5553 v4hi __builtin_ia32_pmullw (v4hi, v4hi)
5554 v4hi __builtin_ia32_pmulhw (v4hi, v4hi)
5555 di __builtin_ia32_pand (di, di)
5556 di __builtin_ia32_pandn (di,di)
5557 di __builtin_ia32_por (di, di)
5558 di __builtin_ia32_pxor (di, di)
5559 v8qi __builtin_ia32_pcmpeqb (v8qi, v8qi)
5560 v4hi __builtin_ia32_pcmpeqw (v4hi, v4hi)
5561 v2si __builtin_ia32_pcmpeqd (v2si, v2si)
5562 v8qi __builtin_ia32_pcmpgtb (v8qi, v8qi)
5563 v4hi __builtin_ia32_pcmpgtw (v4hi, v4hi)
5564 v2si __builtin_ia32_pcmpgtd (v2si, v2si)
5565 v8qi __builtin_ia32_punpckhbw (v8qi, v8qi)
5566 v4hi __builtin_ia32_punpckhwd (v4hi, v4hi)
5567 v2si __builtin_ia32_punpckhdq (v2si, v2si)
5568 v8qi __builtin_ia32_punpcklbw (v8qi, v8qi)
5569 v4hi __builtin_ia32_punpcklwd (v4hi, v4hi)
5570 v2si __builtin_ia32_punpckldq (v2si, v2si)
5571 v8qi __builtin_ia32_packsswb (v4hi, v4hi)
5572 v4hi __builtin_ia32_packssdw (v2si, v2si)
5573 v8qi __builtin_ia32_packuswb (v4hi, v4hi)
5574 @end smallexample
5575
5576 The following built-in functions are made available either with
5577 @option{-msse}, or with a combination of @option{-m3dnow} and
5578 @option{-march=athlon}.  All of them generate the machine
5579 instruction that is part of the name.
5580
5581 @smallexample
5582 v4hi __builtin_ia32_pmulhuw (v4hi, v4hi)
5583 v8qi __builtin_ia32_pavgb (v8qi, v8qi)
5584 v4hi __builtin_ia32_pavgw (v4hi, v4hi)
5585 v4hi __builtin_ia32_psadbw (v8qi, v8qi)
5586 v8qi __builtin_ia32_pmaxub (v8qi, v8qi)
5587 v4hi __builtin_ia32_pmaxsw (v4hi, v4hi)
5588 v8qi __builtin_ia32_pminub (v8qi, v8qi)
5589 v4hi __builtin_ia32_pminsw (v4hi, v4hi)
5590 int __builtin_ia32_pextrw (v4hi, int)
5591 v4hi __builtin_ia32_pinsrw (v4hi, int, int)
5592 int __builtin_ia32_pmovmskb (v8qi)
5593 void __builtin_ia32_maskmovq (v8qi, v8qi, char *)
5594 void __builtin_ia32_movntq (di *, di)
5595 void __builtin_ia32_sfence (void)
5596 @end smallexample
5597
5598 The following built-in functions are available when @option{-msse} is used.
5599 All of them generate the machine instruction that is part of the name.
5600
5601 @smallexample
5602 int __builtin_ia32_comieq (v4sf, v4sf)
5603 int __builtin_ia32_comineq (v4sf, v4sf)
5604 int __builtin_ia32_comilt (v4sf, v4sf)
5605 int __builtin_ia32_comile (v4sf, v4sf)
5606 int __builtin_ia32_comigt (v4sf, v4sf)
5607 int __builtin_ia32_comige (v4sf, v4sf)
5608 int __builtin_ia32_ucomieq (v4sf, v4sf)
5609 int __builtin_ia32_ucomineq (v4sf, v4sf)
5610 int __builtin_ia32_ucomilt (v4sf, v4sf)
5611 int __builtin_ia32_ucomile (v4sf, v4sf)
5612 int __builtin_ia32_ucomigt (v4sf, v4sf)
5613 int __builtin_ia32_ucomige (v4sf, v4sf)
5614 v4sf __builtin_ia32_addps (v4sf, v4sf)
5615 v4sf __builtin_ia32_subps (v4sf, v4sf)
5616 v4sf __builtin_ia32_mulps (v4sf, v4sf)
5617 v4sf __builtin_ia32_divps (v4sf, v4sf)
5618 v4sf __builtin_ia32_addss (v4sf, v4sf)
5619 v4sf __builtin_ia32_subss (v4sf, v4sf)
5620 v4sf __builtin_ia32_mulss (v4sf, v4sf)
5621 v4sf __builtin_ia32_divss (v4sf, v4sf)
5622 v4si __builtin_ia32_cmpeqps (v4sf, v4sf)
5623 v4si __builtin_ia32_cmpltps (v4sf, v4sf)
5624 v4si __builtin_ia32_cmpleps (v4sf, v4sf)
5625 v4si __builtin_ia32_cmpgtps (v4sf, v4sf)
5626 v4si __builtin_ia32_cmpgeps (v4sf, v4sf)
5627 v4si __builtin_ia32_cmpunordps (v4sf, v4sf)
5628 v4si __builtin_ia32_cmpneqps (v4sf, v4sf)
5629 v4si __builtin_ia32_cmpnltps (v4sf, v4sf)
5630 v4si __builtin_ia32_cmpnleps (v4sf, v4sf)
5631 v4si __builtin_ia32_cmpngtps (v4sf, v4sf)
5632 v4si __builtin_ia32_cmpngeps (v4sf, v4sf)
5633 v4si __builtin_ia32_cmpordps (v4sf, v4sf)
5634 v4si __builtin_ia32_cmpeqss (v4sf, v4sf)
5635 v4si __builtin_ia32_cmpltss (v4sf, v4sf)
5636 v4si __builtin_ia32_cmpless (v4sf, v4sf)
5637 v4si __builtin_ia32_cmpunordss (v4sf, v4sf)
5638 v4si __builtin_ia32_cmpneqss (v4sf, v4sf)
5639 v4si __builtin_ia32_cmpnlts (v4sf, v4sf)
5640 v4si __builtin_ia32_cmpnless (v4sf, v4sf)
5641 v4si __builtin_ia32_cmpordss (v4sf, v4sf)
5642 v4sf __builtin_ia32_maxps (v4sf, v4sf)
5643 v4sf __builtin_ia32_maxss (v4sf, v4sf)
5644 v4sf __builtin_ia32_minps (v4sf, v4sf)
5645 v4sf __builtin_ia32_minss (v4sf, v4sf)
5646 v4sf __builtin_ia32_andps (v4sf, v4sf)
5647 v4sf __builtin_ia32_andnps (v4sf, v4sf)
5648 v4sf __builtin_ia32_orps (v4sf, v4sf)
5649 v4sf __builtin_ia32_xorps (v4sf, v4sf)
5650 v4sf __builtin_ia32_movss (v4sf, v4sf)
5651 v4sf __builtin_ia32_movhlps (v4sf, v4sf)
5652 v4sf __builtin_ia32_movlhps (v4sf, v4sf)
5653 v4sf __builtin_ia32_unpckhps (v4sf, v4sf)
5654 v4sf __builtin_ia32_unpcklps (v4sf, v4sf)
5655 v4sf __builtin_ia32_cvtpi2ps (v4sf, v2si)
5656 v4sf __builtin_ia32_cvtsi2ss (v4sf, int)
5657 v2si __builtin_ia32_cvtps2pi (v4sf)
5658 int __builtin_ia32_cvtss2si (v4sf)
5659 v2si __builtin_ia32_cvttps2pi (v4sf)
5660 int __builtin_ia32_cvttss2si (v4sf)
5661 v4sf __builtin_ia32_rcpps (v4sf)
5662 v4sf __builtin_ia32_rsqrtps (v4sf)
5663 v4sf __builtin_ia32_sqrtps (v4sf)
5664 v4sf __builtin_ia32_rcpss (v4sf)
5665 v4sf __builtin_ia32_rsqrtss (v4sf)
5666 v4sf __builtin_ia32_sqrtss (v4sf)
5667 v4sf __builtin_ia32_shufps (v4sf, v4sf, int)
5668 void __builtin_ia32_movntps (float *, v4sf)
5669 int __builtin_ia32_movmskps (v4sf)
5670 @end smallexample
5671
5672 The following built-in functions are available when @option{-msse} is used.
5673
5674 @table @code
5675 @item v4sf __builtin_ia32_loadaps (float *)
5676 Generates the @code{movaps} machine instruction as a load from memory.
5677 @item void __builtin_ia32_storeaps (float *, v4sf)
5678 Generates the @code{movaps} machine instruction as a store to memory.
5679 @item v4sf __builtin_ia32_loadups (float *)
5680 Generates the @code{movups} machine instruction as a load from memory.
5681 @item void __builtin_ia32_storeups (float *, v4sf)
5682 Generates the @code{movups} machine instruction as a store to memory.
5683 @item v4sf __builtin_ia32_loadsss (float *)
5684 Generates the @code{movss} machine instruction as a load from memory.
5685 @item void __builtin_ia32_storess (float *, v4sf)
5686 Generates the @code{movss} machine instruction as a store to memory.
5687 @item v4sf __builtin_ia32_loadhps (v4sf, v2si *)
5688 Generates the @code{movhps} machine instruction as a load from memory.
5689 @item v4sf __builtin_ia32_loadlps (v4sf, v2si *)
5690 Generates the @code{movlps} machine instruction as a load from memory
5691 @item void __builtin_ia32_storehps (v4sf, v2si *)
5692 Generates the @code{movhps} machine instruction as a store to memory.
5693 @item void __builtin_ia32_storelps (v4sf, v2si *)
5694 Generates the @code{movlps} machine instruction as a store to memory.
5695 @end table
5696
5697 The following built-in functions are available when @option{-msse3} is used.
5698 All of them generate the machine instruction that is part of the name.
5699
5700 @smallexample
5701 v2df __builtin_ia32_addsubpd (v2df, v2df)
5702 v2df __builtin_ia32_addsubps (v2df, v2df)
5703 v2df __builtin_ia32_haddpd (v2df, v2df)
5704 v2df __builtin_ia32_haddps (v2df, v2df)
5705 v2df __builtin_ia32_hsubpd (v2df, v2df)
5706 v2df __builtin_ia32_hsubps (v2df, v2df)
5707 v16qi __builtin_ia32_lddqu (char const *)
5708 void __builtin_ia32_monitor (void *, unsigned int, unsigned int)
5709 v2df __builtin_ia32_movddup (v2df)
5710 v4sf __builtin_ia32_movshdup (v4sf)
5711 v4sf __builtin_ia32_movsldup (v4sf)
5712 void __builtin_ia32_mwait (unsigned int, unsigned int)
5713 @end smallexample
5714
5715 The following built-in functions are available when @option{-msse3} is used.
5716
5717 @table @code
5718 @item v2df __builtin_ia32_loadddup (double const *)
5719 Generates the @code{movddup} machine instruction as a load from memory.
5720 @end table
5721
5722 The following built-in functions are available when @option{-m3dnow} is used.
5723 All of them generate the machine instruction that is part of the name.
5724
5725 @smallexample
5726 void __builtin_ia32_femms (void)
5727 v8qi __builtin_ia32_pavgusb (v8qi, v8qi)
5728 v2si __builtin_ia32_pf2id (v2sf)
5729 v2sf __builtin_ia32_pfacc (v2sf, v2sf)
5730 v2sf __builtin_ia32_pfadd (v2sf, v2sf)
5731 v2si __builtin_ia32_pfcmpeq (v2sf, v2sf)
5732 v2si __builtin_ia32_pfcmpge (v2sf, v2sf)
5733 v2si __builtin_ia32_pfcmpgt (v2sf, v2sf)
5734 v2sf __builtin_ia32_pfmax (v2sf, v2sf)
5735 v2sf __builtin_ia32_pfmin (v2sf, v2sf)
5736 v2sf __builtin_ia32_pfmul (v2sf, v2sf)
5737 v2sf __builtin_ia32_pfrcp (v2sf)
5738 v2sf __builtin_ia32_pfrcpit1 (v2sf, v2sf)
5739 v2sf __builtin_ia32_pfrcpit2 (v2sf, v2sf)
5740 v2sf __builtin_ia32_pfrsqrt (v2sf)
5741 v2sf __builtin_ia32_pfrsqrtit1 (v2sf, v2sf)
5742 v2sf __builtin_ia32_pfsub (v2sf, v2sf)
5743 v2sf __builtin_ia32_pfsubr (v2sf, v2sf)
5744 v2sf __builtin_ia32_pi2fd (v2si)
5745 v4hi __builtin_ia32_pmulhrw (v4hi, v4hi)
5746 @end smallexample
5747
5748 The following built-in functions are available when both @option{-m3dnow}
5749 and @option{-march=athlon} are used.  All of them generate the machine
5750 instruction that is part of the name.
5751
5752 @smallexample
5753 v2si __builtin_ia32_pf2iw (v2sf)
5754 v2sf __builtin_ia32_pfnacc (v2sf, v2sf)
5755 v2sf __builtin_ia32_pfpnacc (v2sf, v2sf)
5756 v2sf __builtin_ia32_pi2fw (v2si)
5757 v2sf __builtin_ia32_pswapdsf (v2sf)
5758 v2si __builtin_ia32_pswapdsi (v2si)
5759 @end smallexample
5760
5761 @node PowerPC AltiVec Built-in Functions
5762 @subsection PowerPC AltiVec Built-in Functions
5763
5764 GCC provides an interface for the PowerPC family of processors to access
5765 the AltiVec operations described in Motorola's AltiVec Programming
5766 Interface Manual.  The interface is made available by including
5767 @code{<altivec.h>} and using @option{-maltivec} and
5768 @option{-mabi=altivec}.  The interface supports the following vector
5769 types.
5770
5771 @smallexample
5772 vector unsigned char
5773 vector signed char
5774 vector bool char
5775
5776 vector unsigned short
5777 vector signed short
5778 vector bool short
5779 vector pixel
5780
5781 vector unsigned int
5782 vector signed int
5783 vector bool int
5784 vector float
5785 @end smallexample
5786
5787 GCC's implementation of the high-level language interface available from
5788 C and C++ code differs from Motorola's documentation in several ways.
5789
5790 @itemize @bullet
5791
5792 @item
5793 A vector constant is a list of constant expressions within curly braces.
5794
5795 @item
5796 A vector initializer requires no cast if the vector constant is of the
5797 same type as the variable it is initializing.
5798
5799 @item
5800 If @code{signed} or @code{unsigned} is omitted, the vector type defaults
5801 to @code{signed} for @code{vector int} or @code{vector short} and to
5802 @code{unsigned} for @code{vector char}.
5803
5804 @item
5805 Compiling with @option{-maltivec} adds keywords @code{__vector},
5806 @code{__pixel}, and @code{__bool}.  Macros @option{vector},
5807 @code{pixel}, and @code{bool} are defined in @code{<altivec.h>} and can
5808 be undefined.
5809
5810 @item
5811 GCC allows using a @code{typedef} name as the type specifier for a
5812 vector type.
5813
5814 @item
5815 For C, overloaded functions are implemented with macros so the following
5816 does not work:
5817
5818 @smallexample
5819   vec_add ((vector signed int)@{1, 2, 3, 4@}, foo);
5820 @end smallexample
5821
5822 Since @code{vec_add} is a macro, the vector constant in the example
5823 is treated as four separate arguments.  Wrap the entire argument in
5824 parentheses for this to work.
5825 @end itemize
5826
5827 @emph{Note:} Only the @code{<altivec.h>} interface is supported.
5828 Internally, GCC uses built-in functions to achieve the functionality in
5829 the aforementioned header file, but they are not supported and are
5830 subject to change without notice.
5831
5832 The following interfaces are supported for the generic and specific
5833 AltiVec operations and the AltiVec predicates.  In cases where there
5834 is a direct mapping between generic and specific operations, only the
5835 generic names are shown here, although the specific operations can also
5836 be used.
5837
5838 Arguments that are documented as @code{const int} require literal
5839 integral values within the range required for that operation.
5840
5841 @smallexample
5842 vector signed char vec_abs (vector signed char);
5843 vector signed short vec_abs (vector signed short);
5844 vector signed int vec_abs (vector signed int);
5845 vector float vec_abs (vector float);
5846
5847 vector signed char vec_abss (vector signed char);
5848 vector signed short vec_abss (vector signed short);
5849 vector signed int vec_abss (vector signed int);
5850
5851 vector signed char vec_add (vector bool char, vector signed char);
5852 vector signed char vec_add (vector signed char, vector bool char);
5853 vector signed char vec_add (vector signed char, vector signed char);
5854 vector unsigned char vec_add (vector bool char, vector unsigned char);
5855 vector unsigned char vec_add (vector unsigned char, vector bool char);
5856 vector unsigned char vec_add (vector unsigned char,
5857                               vector unsigned char);
5858 vector signed short vec_add (vector bool short, vector signed short);
5859 vector signed short vec_add (vector signed short, vector bool short);
5860 vector signed short vec_add (vector signed short, vector signed short);
5861 vector unsigned short vec_add (vector bool short,
5862                                vector unsigned short);
5863 vector unsigned short vec_add (vector unsigned short,
5864                                vector bool short);
5865 vector unsigned short vec_add (vector unsigned short,
5866                                vector unsigned short);
5867 vector signed int vec_add (vector bool int, vector signed int);
5868 vector signed int vec_add (vector signed int, vector bool int);
5869 vector signed int vec_add (vector signed int, vector signed int);
5870 vector unsigned int vec_add (vector bool int, vector unsigned int);
5871 vector unsigned int vec_add (vector unsigned int, vector bool int);
5872 vector unsigned int vec_add (vector unsigned int, vector unsigned int);
5873 vector float vec_add (vector float, vector float);
5874
5875 vector float vec_vaddfp (vector float, vector float);
5876
5877 vector signed int vec_vadduwm (vector bool int, vector signed int);
5878 vector signed int vec_vadduwm (vector signed int, vector bool int);
5879 vector signed int vec_vadduwm (vector signed int, vector signed int);
5880 vector unsigned int vec_vadduwm (vector bool int, vector unsigned int);
5881 vector unsigned int vec_vadduwm (vector unsigned int, vector bool int);
5882 vector unsigned int vec_vadduwm (vector unsigned int,
5883                                  vector unsigned int);
5884
5885 vector signed short vec_vadduhm (vector bool short,
5886                                  vector signed short);
5887 vector signed short vec_vadduhm (vector signed short,
5888                                  vector bool short);
5889 vector signed short vec_vadduhm (vector signed short,
5890                                  vector signed short);
5891 vector unsigned short vec_vadduhm (vector bool short,
5892                                    vector unsigned short);
5893 vector unsigned short vec_vadduhm (vector unsigned short,
5894                                    vector bool short);
5895 vector unsigned short vec_vadduhm (vector unsigned short,
5896                                    vector unsigned short);
5897
5898 vector signed char vec_vaddubm (vector bool char, vector signed char);
5899 vector signed char vec_vaddubm (vector signed char, vector bool char);
5900 vector signed char vec_vaddubm (vector signed char, vector signed char);
5901 vector unsigned char vec_vaddubm (vector bool char,
5902                                   vector unsigned char);
5903 vector unsigned char vec_vaddubm (vector unsigned char,
5904                                   vector bool char);
5905 vector unsigned char vec_vaddubm (vector unsigned char,
5906                                   vector unsigned char);
5907
5908 vector unsigned int vec_addc (vector unsigned int, vector unsigned int);
5909
5910 vector unsigned char vec_adds (vector bool char, vector unsigned char);
5911 vector unsigned char vec_adds (vector unsigned char, vector bool char);
5912 vector unsigned char vec_adds (vector unsigned char,
5913                                vector unsigned char);
5914 vector signed char vec_adds (vector bool char, vector signed char);
5915 vector signed char vec_adds (vector signed char, vector bool char);
5916 vector signed char vec_adds (vector signed char, vector signed char);
5917 vector unsigned short vec_adds (vector bool short,
5918                                 vector unsigned short);
5919 vector unsigned short vec_adds (vector unsigned short,
5920                                 vector bool short);
5921 vector unsigned short vec_adds (vector unsigned short,
5922                                 vector unsigned short);
5923 vector signed short vec_adds (vector bool short, vector signed short);
5924 vector signed short vec_adds (vector signed short, vector bool short);
5925 vector signed short vec_adds (vector signed short, vector signed short);
5926 vector unsigned int vec_adds (vector bool int, vector unsigned int);
5927 vector unsigned int vec_adds (vector unsigned int, vector bool int);
5928 vector unsigned int vec_adds (vector unsigned int, vector unsigned int);
5929 vector signed int vec_adds (vector bool int, vector signed int);
5930 vector signed int vec_adds (vector signed int, vector bool int);
5931 vector signed int vec_adds (vector signed int, vector signed int);
5932
5933 vector signed int vec_vaddsws (vector bool int, vector signed int);
5934 vector signed int vec_vaddsws (vector signed int, vector bool int);
5935 vector signed int vec_vaddsws (vector signed int, vector signed int);
5936
5937 vector unsigned int vec_vadduws (vector bool int, vector unsigned int);
5938 vector unsigned int vec_vadduws (vector unsigned int, vector bool int);
5939 vector unsigned int vec_vadduws (vector unsigned int,
5940                                  vector unsigned int);
5941
5942 vector signed short vec_vaddshs (vector bool short,
5943                                  vector signed short);
5944 vector signed short vec_vaddshs (vector signed short,
5945                                  vector bool short);
5946 vector signed short vec_vaddshs (vector signed short,
5947                                  vector signed short);
5948
5949 vector unsigned short vec_vadduhs (vector bool short,
5950                                    vector unsigned short);
5951 vector unsigned short vec_vadduhs (vector unsigned short,
5952                                    vector bool short);
5953 vector unsigned short vec_vadduhs (vector unsigned short,
5954                                    vector unsigned short);
5955
5956 vector signed char vec_vaddsbs (vector bool char, vector signed char);
5957 vector signed char vec_vaddsbs (vector signed char, vector bool char);
5958 vector signed char vec_vaddsbs (vector signed char, vector signed char);
5959
5960 vector unsigned char vec_vaddubs (vector bool char,
5961                                   vector unsigned char);
5962 vector unsigned char vec_vaddubs (vector unsigned char,
5963                                   vector bool char);
5964 vector unsigned char vec_vaddubs (vector unsigned char,
5965                                   vector unsigned char);
5966
5967 vector float vec_and (vector float, vector float);
5968 vector float vec_and (vector float, vector bool int);
5969 vector float vec_and (vector bool int, vector float);
5970 vector bool int vec_and (vector bool int, vector bool int);
5971 vector signed int vec_and (vector bool int, vector signed int);
5972 vector signed int vec_and (vector signed int, vector bool int);
5973 vector signed int vec_and (vector signed int, vector signed int);
5974 vector unsigned int vec_and (vector bool int, vector unsigned int);
5975 vector unsigned int vec_and (vector unsigned int, vector bool int);
5976 vector unsigned int vec_and (vector unsigned int, vector unsigned int);
5977 vector bool short vec_and (vector bool short, vector bool short);
5978 vector signed short vec_and (vector bool short, vector signed short);
5979 vector signed short vec_and (vector signed short, vector bool short);
5980 vector signed short vec_and (vector signed short, vector signed short);
5981 vector unsigned short vec_and (vector bool short,
5982                                vector unsigned short);
5983 vector unsigned short vec_and (vector unsigned short,
5984                                vector bool short);
5985 vector unsigned short vec_and (vector unsigned short,
5986                                vector unsigned short);
5987 vector signed char vec_and (vector bool char, vector signed char);
5988 vector bool char vec_and (vector bool char, vector bool char);
5989 vector signed char vec_and (vector signed char, vector bool char);
5990 vector signed char vec_and (vector signed char, vector signed char);
5991 vector unsigned char vec_and (vector bool char, vector unsigned char);
5992 vector unsigned char vec_and (vector unsigned char, vector bool char);
5993 vector unsigned char vec_and (vector unsigned char,
5994                               vector unsigned char);
5995
5996 vector float vec_andc (vector float, vector float);
5997 vector float vec_andc (vector float, vector bool int);
5998 vector float vec_andc (vector bool int, vector float);
5999 vector bool int vec_andc (vector bool int, vector bool int);
6000 vector signed int vec_andc (vector bool int, vector signed int);
6001 vector signed int vec_andc (vector signed int, vector bool int);
6002 vector signed int vec_andc (vector signed int, vector signed int);
6003 vector unsigned int vec_andc (vector bool int, vector unsigned int);
6004 vector unsigned int vec_andc (vector unsigned int, vector bool int);
6005 vector unsigned int vec_andc (vector unsigned int, vector unsigned int);
6006 vector bool short vec_andc (vector bool short, vector bool short);
6007 vector signed short vec_andc (vector bool short, vector signed short);
6008 vector signed short vec_andc (vector signed short, vector bool short);
6009 vector signed short vec_andc (vector signed short, vector signed short);
6010 vector unsigned short vec_andc (vector bool short,
6011                                 vector unsigned short);
6012 vector unsigned short vec_andc (vector unsigned short,
6013                                 vector bool short);
6014 vector unsigned short vec_andc (vector unsigned short,
6015                                 vector unsigned short);
6016 vector signed char vec_andc (vector bool char, vector signed char);
6017 vector bool char vec_andc (vector bool char, vector bool char);
6018 vector signed char vec_andc (vector signed char, vector bool char);
6019 vector signed char vec_andc (vector signed char, vector signed char);
6020 vector unsigned char vec_andc (vector bool char, vector unsigned char);
6021 vector unsigned char vec_andc (vector unsigned char, vector bool char);
6022 vector unsigned char vec_andc (vector unsigned char,
6023                                vector unsigned char);
6024
6025 vector unsigned char vec_avg (vector unsigned char,
6026                               vector unsigned char);
6027 vector signed char vec_avg (vector signed char, vector signed char);
6028 vector unsigned short vec_avg (vector unsigned short,
6029                                vector unsigned short);
6030 vector signed short vec_avg (vector signed short, vector signed short);
6031 vector unsigned int vec_avg (vector unsigned int, vector unsigned int);
6032 vector signed int vec_avg (vector signed int, vector signed int);
6033
6034 vector signed int vec_vavgsw (vector signed int, vector signed int);
6035
6036 vector unsigned int vec_vavguw (vector unsigned int,
6037                                 vector unsigned int);
6038
6039 vector signed short vec_vavgsh (vector signed short,
6040                                 vector signed short);
6041
6042 vector unsigned short vec_vavguh (vector unsigned short,
6043                                   vector unsigned short);
6044
6045 vector signed char vec_vavgsb (vector signed char, vector signed char);
6046
6047 vector unsigned char vec_vavgub (vector unsigned char,
6048                                  vector unsigned char);
6049
6050 vector float vec_ceil (vector float);
6051
6052 vector signed int vec_cmpb (vector float, vector float);
6053
6054 vector bool char vec_cmpeq (vector signed char, vector signed char);
6055 vector bool char vec_cmpeq (vector unsigned char, vector unsigned char);
6056 vector bool short vec_cmpeq (vector signed short, vector signed short);
6057 vector bool short vec_cmpeq (vector unsigned short,
6058                              vector unsigned short);
6059 vector bool int vec_cmpeq (vector signed int, vector signed int);
6060 vector bool int vec_cmpeq (vector unsigned int, vector unsigned int);
6061 vector bool int vec_cmpeq (vector float, vector float);
6062
6063 vector bool int vec_vcmpeqfp (vector float, vector float);
6064
6065 vector bool int vec_vcmpequw (vector signed int, vector signed int);
6066 vector bool int vec_vcmpequw (vector unsigned int, vector unsigned int);
6067
6068 vector bool short vec_vcmpequh (vector signed short,
6069                                 vector signed short);
6070 vector bool short vec_vcmpequh (vector unsigned short,
6071                                 vector unsigned short);
6072
6073 vector bool char vec_vcmpequb (vector signed char, vector signed char);
6074 vector bool char vec_vcmpequb (vector unsigned char,
6075                                vector unsigned char);
6076
6077 vector bool int vec_cmpge (vector float, vector float);
6078
6079 vector bool char vec_cmpgt (vector unsigned char, vector unsigned char);
6080 vector bool char vec_cmpgt (vector signed char, vector signed char);
6081 vector bool short vec_cmpgt (vector unsigned short,
6082                              vector unsigned short);
6083 vector bool short vec_cmpgt (vector signed short, vector signed short);
6084 vector bool int vec_cmpgt (vector unsigned int, vector unsigned int);
6085 vector bool int vec_cmpgt (vector signed int, vector signed int);
6086 vector bool int vec_cmpgt (vector float, vector float);
6087
6088 vector bool int vec_vcmpgtfp (vector float, vector float);
6089
6090 vector bool int vec_vcmpgtsw (vector signed int, vector signed int);
6091
6092 vector bool int vec_vcmpgtuw (vector unsigned int, vector unsigned int);
6093
6094 vector bool short vec_vcmpgtsh (vector signed short,
6095                                 vector signed short);
6096
6097 vector bool short vec_vcmpgtuh (vector unsigned short,
6098                                 vector unsigned short);
6099
6100 vector bool char vec_vcmpgtsb (vector signed char, vector signed char);
6101
6102 vector bool char vec_vcmpgtub (vector unsigned char,
6103                                vector unsigned char);
6104
6105 vector bool int vec_cmple (vector float, vector float);
6106
6107 vector bool char vec_cmplt (vector unsigned char, vector unsigned char);
6108 vector bool char vec_cmplt (vector signed char, vector signed char);
6109 vector bool short vec_cmplt (vector unsigned short,
6110                              vector unsigned short);
6111 vector bool short vec_cmplt (vector signed short, vector signed short);
6112 vector bool int vec_cmplt (vector unsigned int, vector unsigned int);
6113 vector bool int vec_cmplt (vector signed int, vector signed int);
6114 vector bool int vec_cmplt (vector float, vector float);
6115
6116 vector float vec_ctf (vector unsigned int, const int);
6117 vector float vec_ctf (vector signed int, const int);
6118
6119 vector float vec_vcfsx (vector signed int, const int);
6120
6121 vector float vec_vcfux (vector unsigned int, const int);
6122
6123 vector signed int vec_cts (vector float, const int);
6124
6125 vector unsigned int vec_ctu (vector float, const int);
6126
6127 void vec_dss (const int);
6128
6129 void vec_dssall (void);
6130
6131 void vec_dst (const vector unsigned char *, int, const int);
6132 void vec_dst (const vector signed char *, int, const int);
6133 void vec_dst (const vector bool char *, int, const int);
6134 void vec_dst (const vector unsigned short *, int, const int);
6135 void vec_dst (const vector signed short *, int, const int);
6136 void vec_dst (const vector bool short *, int, const int);
6137 void vec_dst (const vector pixel *, int, const int);
6138 void vec_dst (const vector unsigned int *, int, const int);
6139 void vec_dst (const vector signed int *, int, const int);
6140 void vec_dst (const vector bool int *, int, const int);
6141 void vec_dst (const vector float *, int, const int);
6142 void vec_dst (const unsigned char *, int, const int);
6143 void vec_dst (const signed char *, int, const int);
6144 void vec_dst (const unsigned short *, int, const int);
6145 void vec_dst (const short *, int, const int);
6146 void vec_dst (const unsigned int *, int, const int);
6147 void vec_dst (const int *, int, const int);
6148 void vec_dst (const unsigned long *, int, const int);
6149 void vec_dst (const long *, int, const int);
6150 void vec_dst (const float *, int, const int);
6151
6152 void vec_dstst (const vector unsigned char *, int, const int);
6153 void vec_dstst (const vector signed char *, int, const int);
6154 void vec_dstst (const vector bool char *, int, const int);
6155 void vec_dstst (const vector unsigned short *, int, const int);
6156 void vec_dstst (const vector signed short *, int, const int);
6157 void vec_dstst (const vector bool short *, int, const int);
6158 void vec_dstst (const vector pixel *, int, const int);
6159 void vec_dstst (const vector unsigned int *, int, const int);
6160 void vec_dstst (const vector signed int *, int, const int);
6161 void vec_dstst (const vector bool int *, int, const int);
6162 void vec_dstst (const vector float *, int, const int);
6163 void vec_dstst (const unsigned char *, int, const int);
6164 void vec_dstst (const signed char *, int, const int);
6165 void vec_dstst (const unsigned short *, int, const int);
6166 void vec_dstst (const short *, int, const int);
6167 void vec_dstst (const unsigned int *, int, const int);
6168 void vec_dstst (const int *, int, const int);
6169 void vec_dstst (const unsigned long *, int, const int);
6170 void vec_dstst (const long *, int, const int);
6171 void vec_dstst (const float *, int, const int);
6172
6173 void vec_dststt (const vector unsigned char *, int, const int);
6174 void vec_dststt (const vector signed char *, int, const int);
6175 void vec_dststt (const vector bool char *, int, const int);
6176 void vec_dststt (const vector unsigned short *, int, const int);
6177 void vec_dststt (const vector signed short *, int, const int);
6178 void vec_dststt (const vector bool short *, int, const int);
6179 void vec_dststt (const vector pixel *, int, const int);
6180 void vec_dststt (const vector unsigned int *, int, const int);
6181 void vec_dststt (const vector signed int *, int, const int);
6182 void vec_dststt (const vector bool int *, int, const int);
6183 void vec_dststt (const vector float *, int, const int);
6184 void vec_dststt (const unsigned char *, int, const int);
6185 void vec_dststt (const signed char *, int, const int);
6186 void vec_dststt (const unsigned short *, int, const int);
6187 void vec_dststt (const short *, int, const int);
6188 void vec_dststt (const unsigned int *, int, const int);
6189 void vec_dststt (const int *, int, const int);
6190 void vec_dststt (const unsigned long *, int, const int);
6191 void vec_dststt (const long *, int, const int);
6192 void vec_dststt (const float *, int, const int);
6193
6194 void vec_dstt (const vector unsigned char *, int, const int);
6195 void vec_dstt (const vector signed char *, int, const int);
6196 void vec_dstt (const vector bool char *, int, const int);
6197 void vec_dstt (const vector unsigned short *, int, const int);
6198 void vec_dstt (const vector signed short *, int, const int);
6199 void vec_dstt (const vector bool short *, int, const int);
6200 void vec_dstt (const vector pixel *, int, const int);
6201 void vec_dstt (const vector unsigned int *, int, const int);
6202 void vec_dstt (const vector signed int *, int, const int);
6203 void vec_dstt (const vector bool int *, int, const int);
6204 void vec_dstt (const vector float *, int, const int);
6205 void vec_dstt (const unsigned char *, int, const int);
6206 void vec_dstt (const signed char *, int, const int);
6207 void vec_dstt (const unsigned short *, int, const int);
6208 void vec_dstt (const short *, int, const int);
6209 void vec_dstt (const unsigned int *, int, const int);
6210 void vec_dstt (const int *, int, const int);
6211 void vec_dstt (const unsigned long *, int, const int);
6212 void vec_dstt (const long *, int, const int);
6213 void vec_dstt (const float *, int, const int);
6214
6215 vector float vec_expte (vector float);
6216
6217 vector float vec_floor (vector float);
6218
6219 vector float vec_ld (int, const vector float *);
6220 vector float vec_ld (int, const float *);
6221 vector bool int vec_ld (int, const vector bool int *);
6222 vector signed int vec_ld (int, const vector signed int *);
6223 vector signed int vec_ld (int, const int *);
6224 vector signed int vec_ld (int, const long *);
6225 vector unsigned int vec_ld (int, const vector unsigned int *);
6226 vector unsigned int vec_ld (int, const unsigned int *);
6227 vector unsigned int vec_ld (int, const unsigned long *);
6228 vector bool short vec_ld (int, const vector bool short *);
6229 vector pixel vec_ld (int, const vector pixel *);
6230 vector signed short vec_ld (int, const vector signed short *);
6231 vector signed short vec_ld (int, const short *);
6232 vector unsigned short vec_ld (int, const vector unsigned short *);
6233 vector unsigned short vec_ld (int, const unsigned short *);
6234 vector bool char vec_ld (int, const vector bool char *);
6235 vector signed char vec_ld (int, const vector signed char *);
6236 vector signed char vec_ld (int, const signed char *);
6237 vector unsigned char vec_ld (int, const vector unsigned char *);
6238 vector unsigned char vec_ld (int, const unsigned char *);
6239
6240 vector signed char vec_lde (int, const signed char *);
6241 vector unsigned char vec_lde (int, const unsigned char *);
6242 vector signed short vec_lde (int, const short *);
6243 vector unsigned short vec_lde (int, const unsigned short *);
6244 vector float vec_lde (int, const float *);
6245 vector signed int vec_lde (int, const int *);
6246 vector unsigned int vec_lde (int, const unsigned int *);
6247 vector signed int vec_lde (int, const long *);
6248 vector unsigned int vec_lde (int, const unsigned long *);
6249
6250 vector float vec_lvewx (int, float *);
6251 vector signed int vec_lvewx (int, int *);
6252 vector unsigned int vec_lvewx (int, unsigned int *);
6253 vector signed int vec_lvewx (int, long *);
6254 vector unsigned int vec_lvewx (int, unsigned long *);
6255
6256 vector signed short vec_lvehx (int, short *);
6257 vector unsigned short vec_lvehx (int, unsigned short *);
6258
6259 vector signed char vec_lvebx (int, char *);
6260 vector unsigned char vec_lvebx (int, unsigned char *);
6261
6262 vector float vec_ldl (int, const vector float *);
6263 vector float vec_ldl (int, const float *);
6264 vector bool int vec_ldl (int, const vector bool int *);
6265 vector signed int vec_ldl (int, const vector signed int *);
6266 vector signed int vec_ldl (int, const int *);
6267 vector signed int vec_ldl (int, const long *);
6268 vector unsigned int vec_ldl (int, const vector unsigned int *);
6269 vector unsigned int vec_ldl (int, const unsigned int *);
6270 vector unsigned int vec_ldl (int, const unsigned long *);
6271 vector bool short vec_ldl (int, const vector bool short *);
6272 vector pixel vec_ldl (int, const vector pixel *);
6273 vector signed short vec_ldl (int, const vector signed short *);
6274 vector signed short vec_ldl (int, const short *);
6275 vector unsigned short vec_ldl (int, const vector unsigned short *);
6276 vector unsigned short vec_ldl (int, const unsigned short *);
6277 vector bool char vec_ldl (int, const vector bool char *);
6278 vector signed char vec_ldl (int, const vector signed char *);
6279 vector signed char vec_ldl (int, const signed char *);
6280 vector unsigned char vec_ldl (int, const vector unsigned char *);
6281 vector unsigned char vec_ldl (int, const unsigned char *);
6282
6283 vector float vec_loge (vector float);
6284
6285 vector unsigned char vec_lvsl (int, const volatile unsigned char *);
6286 vector unsigned char vec_lvsl (int, const volatile signed char *);
6287 vector unsigned char vec_lvsl (int, const volatile unsigned short *);
6288 vector unsigned char vec_lvsl (int, const volatile short *);
6289 vector unsigned char vec_lvsl (int, const volatile unsigned int *);
6290 vector unsigned char vec_lvsl (int, const volatile int *);
6291 vector unsigned char vec_lvsl (int, const volatile unsigned long *);
6292 vector unsigned char vec_lvsl (int, const volatile long *);
6293 vector unsigned char vec_lvsl (int, const volatile float *);
6294
6295 vector unsigned char vec_lvsr (int, const volatile unsigned char *);
6296 vector unsigned char vec_lvsr (int, const volatile signed char *);
6297 vector unsigned char vec_lvsr (int, const volatile unsigned short *);
6298 vector unsigned char vec_lvsr (int, const volatile short *);
6299 vector unsigned char vec_lvsr (int, const volatile unsigned int *);
6300 vector unsigned char vec_lvsr (int, const volatile int *);
6301 vector unsigned char vec_lvsr (int, const volatile unsigned long *);
6302 vector unsigned char vec_lvsr (int, const volatile long *);
6303 vector unsigned char vec_lvsr (int, const volatile float *);
6304
6305 vector float vec_madd (vector float, vector float, vector float);
6306
6307 vector signed short vec_madds (vector signed short,
6308                                vector signed short,
6309                                vector signed short);
6310
6311 vector unsigned char vec_max (vector bool char, vector unsigned char);
6312 vector unsigned char vec_max (vector unsigned char, vector bool char);
6313 vector unsigned char vec_max (vector unsigned char,
6314                               vector unsigned char);
6315 vector signed char vec_max (vector bool char, vector signed char);
6316 vector signed char vec_max (vector signed char, vector bool char);
6317 vector signed char vec_max (vector signed char, vector signed char);
6318 vector unsigned short vec_max (vector bool short,
6319                                vector unsigned short);
6320 vector unsigned short vec_max (vector unsigned short,
6321                                vector bool short);
6322 vector unsigned short vec_max (vector unsigned short,
6323                                vector unsigned short);
6324 vector signed short vec_max (vector bool short, vector signed short);
6325 vector signed short vec_max (vector signed short, vector bool short);
6326 vector signed short vec_max (vector signed short, vector signed short);
6327 vector unsigned int vec_max (vector bool int, vector unsigned int);
6328 vector unsigned int vec_max (vector unsigned int, vector bool int);
6329 vector unsigned int vec_max (vector unsigned int, vector unsigned int);
6330 vector signed int vec_max (vector bool int, vector signed int);
6331 vector signed int vec_max (vector signed int, vector bool int);
6332 vector signed int vec_max (vector signed int, vector signed int);
6333 vector float vec_max (vector float, vector float);
6334
6335 vector float vec_vmaxfp (vector float, vector float);
6336
6337 vector signed int vec_vmaxsw (vector bool int, vector signed int);
6338 vector signed int vec_vmaxsw (vector signed int, vector bool int);
6339 vector signed int vec_vmaxsw (vector signed int, vector signed int);
6340
6341 vector unsigned int vec_vmaxuw (vector bool int, vector unsigned int);
6342 vector unsigned int vec_vmaxuw (vector unsigned int, vector bool int);
6343 vector unsigned int vec_vmaxuw (vector unsigned int,
6344                                 vector unsigned int);
6345
6346 vector signed short vec_vmaxsh (vector bool short, vector signed short);
6347 vector signed short vec_vmaxsh (vector signed short, vector bool short);
6348 vector signed short vec_vmaxsh (vector signed short,
6349                                 vector signed short);
6350
6351 vector unsigned short vec_vmaxuh (vector bool short,
6352                                   vector unsigned short);
6353 vector unsigned short vec_vmaxuh (vector unsigned short,
6354                                   vector bool short);
6355 vector unsigned short vec_vmaxuh (vector unsigned short,
6356                                   vector unsigned short);
6357
6358 vector signed char vec_vmaxsb (vector bool char, vector signed char);
6359 vector signed char vec_vmaxsb (vector signed char, vector bool char);
6360 vector signed char vec_vmaxsb (vector signed char, vector signed char);
6361
6362 vector unsigned char vec_vmaxub (vector bool char,
6363                                  vector unsigned char);
6364 vector unsigned char vec_vmaxub (vector unsigned char,
6365                                  vector bool char);
6366 vector unsigned char vec_vmaxub (vector unsigned char,
6367                                  vector unsigned char);
6368
6369 vector bool char vec_mergeh (vector bool char, vector bool char);
6370 vector signed char vec_mergeh (vector signed char, vector signed char);
6371 vector unsigned char vec_mergeh (vector unsigned char,
6372                                  vector unsigned char);
6373 vector bool short vec_mergeh (vector bool short, vector bool short);
6374 vector pixel vec_mergeh (vector pixel, vector pixel);
6375 vector signed short vec_mergeh (vector signed short,
6376                                 vector signed short);
6377 vector unsigned short vec_mergeh (vector unsigned short,
6378                                   vector unsigned short);
6379 vector float vec_mergeh (vector float, vector float);
6380 vector bool int vec_mergeh (vector bool int, vector bool int);
6381 vector signed int vec_mergeh (vector signed int, vector signed int);
6382 vector unsigned int vec_mergeh (vector unsigned int,
6383                                 vector unsigned int);
6384
6385 vector float vec_vmrghw (vector float, vector float);
6386 vector bool int vec_vmrghw (vector bool int, vector bool int);
6387 vector signed int vec_vmrghw (vector signed int, vector signed int);
6388 vector unsigned int vec_vmrghw (vector unsigned int,
6389                                 vector unsigned int);
6390
6391 vector bool short vec_vmrghh (vector bool short, vector bool short);
6392 vector signed short vec_vmrghh (vector signed short,
6393                                 vector signed short);
6394 vector unsigned short vec_vmrghh (vector unsigned short,
6395                                   vector unsigned short);
6396 vector pixel vec_vmrghh (vector pixel, vector pixel);
6397
6398 vector bool char vec_vmrghb (vector bool char, vector bool char);
6399 vector signed char vec_vmrghb (vector signed char, vector signed char);
6400 vector unsigned char vec_vmrghb (vector unsigned char,
6401                                  vector unsigned char);
6402
6403 vector bool char vec_mergel (vector bool char, vector bool char);
6404 vector signed char vec_mergel (vector signed char, vector signed char);
6405 vector unsigned char vec_mergel (vector unsigned char,
6406                                  vector unsigned char);
6407 vector bool short vec_mergel (vector bool short, vector bool short);
6408 vector pixel vec_mergel (vector pixel, vector pixel);
6409 vector signed short vec_mergel (vector signed short,
6410                                 vector signed short);
6411 vector unsigned short vec_mergel (vector unsigned short,
6412                                   vector unsigned short);
6413 vector float vec_mergel (vector float, vector float);
6414 vector bool int vec_mergel (vector bool int, vector bool int);
6415 vector signed int vec_mergel (vector signed int, vector signed int);
6416 vector unsigned int vec_mergel (vector unsigned int,
6417                                 vector unsigned int);
6418
6419 vector float vec_vmrglw (vector float, vector float);
6420 vector signed int vec_vmrglw (vector signed int, vector signed int);
6421 vector unsigned int vec_vmrglw (vector unsigned int,
6422                                 vector unsigned int);
6423 vector bool int vec_vmrglw (vector bool int, vector bool int);
6424
6425 vector bool short vec_vmrglh (vector bool short, vector bool short);
6426 vector signed short vec_vmrglh (vector signed short,
6427                                 vector signed short);
6428 vector unsigned short vec_vmrglh (vector unsigned short,
6429                                   vector unsigned short);
6430 vector pixel vec_vmrglh (vector pixel, vector pixel);
6431
6432 vector bool char vec_vmrglb (vector bool char, vector bool char);
6433 vector signed char vec_vmrglb (vector signed char, vector signed char);
6434 vector unsigned char vec_vmrglb (vector unsigned char,
6435                                  vector unsigned char);
6436
6437 vector unsigned short vec_mfvscr (void);
6438
6439 vector unsigned char vec_min (vector bool char, vector unsigned char);
6440 vector unsigned char vec_min (vector unsigned char, vector bool char);
6441 vector unsigned char vec_min (vector unsigned char,
6442                               vector unsigned char);
6443 vector signed char vec_min (vector bool char, vector signed char);
6444 vector signed char vec_min (vector signed char, vector bool char);
6445 vector signed char vec_min (vector signed char, vector signed char);
6446 vector unsigned short vec_min (vector bool short,
6447                                vector unsigned short);
6448 vector unsigned short vec_min (vector unsigned short,
6449                                vector bool short);
6450 vector unsigned short vec_min (vector unsigned short,
6451                                vector unsigned short);
6452 vector signed short vec_min (vector bool short, vector signed short);
6453 vector signed short vec_min (vector signed short, vector bool short);
6454 vector signed short vec_min (vector signed short, vector signed short);
6455 vector unsigned int vec_min (vector bool int, vector unsigned int);
6456 vector unsigned int vec_min (vector unsigned int, vector bool int);
6457 vector unsigned int vec_min (vector unsigned int, vector unsigned int);
6458 vector signed int vec_min (vector bool int, vector signed int);
6459 vector signed int vec_min (vector signed int, vector bool int);
6460 vector signed int vec_min (vector signed int, vector signed int);
6461 vector float vec_min (vector float, vector float);
6462
6463 vector float vec_vminfp (vector float, vector float);
6464
6465 vector signed int vec_vminsw (vector bool int, vector signed int);
6466 vector signed int vec_vminsw (vector signed int, vector bool int);
6467 vector signed int vec_vminsw (vector signed int, vector signed int);
6468
6469 vector unsigned int vec_vminuw (vector bool int, vector unsigned int);
6470 vector unsigned int vec_vminuw (vector unsigned int, vector bool int);
6471 vector unsigned int vec_vminuw (vector unsigned int,
6472                                 vector unsigned int);
6473
6474 vector signed short vec_vminsh (vector bool short, vector signed short);
6475 vector signed short vec_vminsh (vector signed short, vector bool short);
6476 vector signed short vec_vminsh (vector signed short,
6477                                 vector signed short);
6478
6479 vector unsigned short vec_vminuh (vector bool short,
6480                                   vector unsigned short);
6481 vector unsigned short vec_vminuh (vector unsigned short,
6482                                   vector bool short);
6483 vector unsigned short vec_vminuh (vector unsigned short,
6484                                   vector unsigned short);
6485
6486 vector signed char vec_vminsb (vector bool char, vector signed char);
6487 vector signed char vec_vminsb (vector signed char, vector bool char);
6488 vector signed char vec_vminsb (vector signed char, vector signed char);
6489
6490 vector unsigned char vec_vminub (vector bool char,
6491                                  vector unsigned char);
6492 vector unsigned char vec_vminub (vector unsigned char,
6493                                  vector bool char);
6494 vector unsigned char vec_vminub (vector unsigned char,
6495                                  vector unsigned char);
6496
6497 vector signed short vec_mladd (vector signed short,
6498                                vector signed short,
6499                                vector signed short);
6500 vector signed short vec_mladd (vector signed short,
6501                                vector unsigned short,
6502                                vector unsigned short);
6503 vector signed short vec_mladd (vector unsigned short,
6504                                vector signed short,
6505                                vector signed short);
6506 vector unsigned short vec_mladd (vector unsigned short,
6507                                  vector unsigned short,
6508                                  vector unsigned short);
6509
6510 vector signed short vec_mradds (vector signed short,
6511                                 vector signed short,
6512                                 vector signed short);
6513
6514 vector unsigned int vec_msum (vector unsigned char,
6515                               vector unsigned char,
6516                               vector unsigned int);
6517 vector signed int vec_msum (vector signed char,
6518                             vector unsigned char,
6519                             vector signed int);
6520 vector unsigned int vec_msum (vector unsigned short,
6521                               vector unsigned short,
6522                               vector unsigned int);
6523 vector signed int vec_msum (vector signed short,
6524                             vector signed short,
6525                             vector signed int);
6526
6527 vector signed int vec_vmsumshm (vector signed short,
6528                                 vector signed short,
6529                                 vector signed int);
6530
6531 vector unsigned int vec_vmsumuhm (vector unsigned short,
6532                                   vector unsigned short,
6533                                   vector unsigned int);
6534
6535 vector signed int vec_vmsummbm (vector signed char,
6536                                 vector unsigned char,
6537                                 vector signed int);
6538
6539 vector unsigned int vec_vmsumubm (vector unsigned char,
6540                                   vector unsigned char,
6541                                   vector unsigned int);
6542
6543 vector unsigned int vec_msums (vector unsigned short,
6544                                vector unsigned short,
6545                                vector unsigned int);
6546 vector signed int vec_msums (vector signed short,
6547                              vector signed short,
6548                              vector signed int);
6549
6550 vector signed int vec_vmsumshs (vector signed short,
6551                                 vector signed short,
6552                                 vector signed int);
6553
6554 vector unsigned int vec_vmsumuhs (vector unsigned short,
6555                                   vector unsigned short,
6556                                   vector unsigned int);
6557
6558 void vec_mtvscr (vector signed int);
6559 void vec_mtvscr (vector unsigned int);
6560 void vec_mtvscr (vector bool int);
6561 void vec_mtvscr (vector signed short);
6562 void vec_mtvscr (vector unsigned short);
6563 void vec_mtvscr (vector bool short);
6564 void vec_mtvscr (vector pixel);
6565 void vec_mtvscr (vector signed char);
6566 void vec_mtvscr (vector unsigned char);
6567 void vec_mtvscr (vector bool char);
6568
6569 vector unsigned short vec_mule (vector unsigned char,
6570                                 vector unsigned char);
6571 vector signed short vec_mule (vector signed char,
6572                               vector signed char);
6573 vector unsigned int vec_mule (vector unsigned short,
6574                               vector unsigned short);
6575 vector signed int vec_mule (vector signed short, vector signed short);
6576
6577 vector signed int vec_vmulesh (vector signed short,
6578                                vector signed short);
6579
6580 vector unsigned int vec_vmuleuh (vector unsigned short,
6581                                  vector unsigned short);
6582
6583 vector signed short vec_vmulesb (vector signed char,
6584                                  vector signed char);
6585
6586 vector unsigned short vec_vmuleub (vector unsigned char,
6587                                   vector unsigned char);
6588
6589 vector unsigned short vec_mulo (vector unsigned char,
6590                                 vector unsigned char);
6591 vector signed short vec_mulo (vector signed char, vector signed char);
6592 vector unsigned int vec_mulo (vector unsigned short,
6593                               vector unsigned short);
6594 vector signed int vec_mulo (vector signed short, vector signed short);
6595
6596 vector signed int vec_vmulosh (vector signed short,
6597                                vector signed short);
6598
6599 vector unsigned int vec_vmulouh (vector unsigned short,
6600                                  vector unsigned short);
6601
6602 vector signed short vec_vmulosb (vector signed char,
6603                                  vector signed char);
6604
6605 vector unsigned short vec_vmuloub (vector unsigned char,
6606                                    vector unsigned char);
6607
6608 vector float vec_nmsub (vector float, vector float, vector float);
6609
6610 vector float vec_nor (vector float, vector float);
6611 vector signed int vec_nor (vector signed int, vector signed int);
6612 vector unsigned int vec_nor (vector unsigned int, vector unsigned int);
6613 vector bool int vec_nor (vector bool int, vector bool int);
6614 vector signed short vec_nor (vector signed short, vector signed short);
6615 vector unsigned short vec_nor (vector unsigned short,
6616                                vector unsigned short);
6617 vector bool short vec_nor (vector bool short, vector bool short);
6618 vector signed char vec_nor (vector signed char, vector signed char);
6619 vector unsigned char vec_nor (vector unsigned char,
6620                               vector unsigned char);
6621 vector bool char vec_nor (vector bool char, vector bool char);
6622
6623 vector float vec_or (vector float, vector float);
6624 vector float vec_or (vector float, vector bool int);
6625 vector float vec_or (vector bool int, vector float);
6626 vector bool int vec_or (vector bool int, vector bool int);
6627 vector signed int vec_or (vector bool int, vector signed int);
6628 vector signed int vec_or (vector signed int, vector bool int);
6629 vector signed int vec_or (vector signed int, vector signed int);
6630 vector unsigned int vec_or (vector bool int, vector unsigned int);
6631 vector unsigned int vec_or (vector unsigned int, vector bool int);
6632 vector unsigned int vec_or (vector unsigned int, vector unsigned int);
6633 vector bool short vec_or (vector bool short, vector bool short);
6634 vector signed short vec_or (vector bool short, vector signed short);
6635 vector signed short vec_or (vector signed short, vector bool short);
6636 vector signed short vec_or (vector signed short, vector signed short);
6637 vector unsigned short vec_or (vector bool short, vector unsigned short);
6638 vector unsigned short vec_or (vector unsigned short, vector bool short);
6639 vector unsigned short vec_or (vector unsigned short,
6640                               vector unsigned short);
6641 vector signed char vec_or (vector bool char, vector signed char);
6642 vector bool char vec_or (vector bool char, vector bool char);
6643 vector signed char vec_or (vector signed char, vector bool char);
6644 vector signed char vec_or (vector signed char, vector signed char);
6645 vector unsigned char vec_or (vector bool char, vector unsigned char);
6646 vector unsigned char vec_or (vector unsigned char, vector bool char);
6647 vector unsigned char vec_or (vector unsigned char,
6648                              vector unsigned char);
6649
6650 vector signed char vec_pack (vector signed short, vector signed short);
6651 vector unsigned char vec_pack (vector unsigned short,
6652                                vector unsigned short);
6653 vector bool char vec_pack (vector bool short, vector bool short);
6654 vector signed short vec_pack (vector signed int, vector signed int);
6655 vector unsigned short vec_pack (vector unsigned int,
6656                                 vector unsigned int);
6657 vector bool short vec_pack (vector bool int, vector bool int);
6658
6659 vector bool short vec_vpkuwum (vector bool int, vector bool int);
6660 vector signed short vec_vpkuwum (vector signed int, vector signed int);
6661 vector unsigned short vec_vpkuwum (vector unsigned int,
6662                                    vector unsigned int);
6663
6664 vector bool char vec_vpkuhum (vector bool short, vector bool short);
6665 vector signed char vec_vpkuhum (vector signed short,
6666                                 vector signed short);
6667 vector unsigned char vec_vpkuhum (vector unsigned short,
6668                                   vector unsigned short);
6669
6670 vector pixel vec_packpx (vector unsigned int, vector unsigned int);
6671
6672 vector unsigned char vec_packs (vector unsigned short,
6673                                 vector unsigned short);
6674 vector signed char vec_packs (vector signed short, vector signed short);
6675 vector unsigned short vec_packs (vector unsigned int,
6676                                  vector unsigned int);
6677 vector signed short vec_packs (vector signed int, vector signed int);
6678
6679 vector signed short vec_vpkswss (vector signed int, vector signed int);
6680
6681 vector unsigned short vec_vpkuwus (vector unsigned int,
6682                                    vector unsigned int);
6683
6684 vector signed char vec_vpkshss (vector signed short,
6685                                 vector signed short);
6686
6687 vector unsigned char vec_vpkuhus (vector unsigned short,
6688                                   vector unsigned short);
6689
6690 vector unsigned char vec_packsu (vector unsigned short,
6691                                  vector unsigned short);
6692 vector unsigned char vec_packsu (vector signed short,
6693                                  vector signed short);
6694 vector unsigned short vec_packsu (vector unsigned int,
6695                                   vector unsigned int);
6696 vector unsigned short vec_packsu (vector signed int, vector signed int);
6697
6698 vector unsigned short vec_vpkswus (vector signed int,
6699                                    vector signed int);
6700
6701 vector unsigned char vec_vpkshus (vector signed short,
6702                                   vector signed short);
6703
6704 vector float vec_perm (vector float,
6705                        vector float,
6706                        vector unsigned char);
6707 vector signed int vec_perm (vector signed int,
6708                             vector signed int,
6709                             vector unsigned char);
6710 vector unsigned int vec_perm (vector unsigned int,
6711                               vector unsigned int,
6712                               vector unsigned char);
6713 vector bool int vec_perm (vector bool int,
6714                           vector bool int,
6715                           vector unsigned char);
6716 vector signed short vec_perm (vector signed short,
6717                               vector signed short,
6718                               vector unsigned char);
6719 vector unsigned short vec_perm (vector unsigned short,
6720                                 vector unsigned short,
6721                                 vector unsigned char);
6722 vector bool short vec_perm (vector bool short,
6723                             vector bool short,
6724                             vector unsigned char);
6725 vector pixel vec_perm (vector pixel,
6726                        vector pixel,
6727                        vector unsigned char);
6728 vector signed char vec_perm (vector signed char,
6729                              vector signed char,
6730                              vector unsigned char);
6731 vector unsigned char vec_perm (vector unsigned char,
6732                                vector unsigned char,
6733                                vector unsigned char);
6734 vector bool char vec_perm (vector bool char,
6735                            vector bool char,
6736                            vector unsigned char);
6737
6738 vector float vec_re (vector float);
6739
6740 vector signed char vec_rl (vector signed char,
6741                            vector unsigned char);
6742 vector unsigned char vec_rl (vector unsigned char,
6743                              vector unsigned char);
6744 vector signed short vec_rl (vector signed short, vector unsigned short);
6745 vector unsigned short vec_rl (vector unsigned short,
6746                               vector unsigned short);
6747 vector signed int vec_rl (vector signed int, vector unsigned int);
6748 vector unsigned int vec_rl (vector unsigned int, vector unsigned int);
6749
6750 vector signed int vec_vrlw (vector signed int, vector unsigned int);
6751 vector unsigned int vec_vrlw (vector unsigned int, vector unsigned int);
6752
6753 vector signed short vec_vrlh (vector signed short,
6754                               vector unsigned short);
6755 vector unsigned short vec_vrlh (vector unsigned short,
6756                                 vector unsigned short);
6757
6758 vector signed char vec_vrlb (vector signed char, vector unsigned char);
6759 vector unsigned char vec_vrlb (vector unsigned char,
6760                                vector unsigned char);
6761
6762 vector float vec_round (vector float);
6763
6764 vector float vec_rsqrte (vector float);
6765
6766 vector float vec_sel (vector float, vector float, vector bool int);
6767 vector float vec_sel (vector float, vector float, vector unsigned int);
6768 vector signed int vec_sel (vector signed int,
6769                            vector signed int,
6770                            vector bool int);
6771 vector signed int vec_sel (vector signed int,
6772                            vector signed int,
6773                            vector unsigned int);
6774 vector unsigned int vec_sel (vector unsigned int,
6775                              vector unsigned int,
6776                              vector bool int);
6777 vector unsigned int vec_sel (vector unsigned int,
6778                              vector unsigned int,
6779                              vector unsigned int);
6780 vector bool int vec_sel (vector bool int,
6781                          vector bool int,
6782                          vector bool int);
6783 vector bool int vec_sel (vector bool int,
6784                          vector bool int,
6785                          vector unsigned int);
6786 vector signed short vec_sel (vector signed short,
6787                              vector signed short,
6788                              vector bool short);
6789 vector signed short vec_sel (vector signed short,
6790                              vector signed short,
6791                              vector unsigned short);
6792 vector unsigned short vec_sel (vector unsigned short,
6793                                vector unsigned short,
6794                                vector bool short);
6795 vector unsigned short vec_sel (vector unsigned short,
6796                                vector unsigned short,
6797                                vector unsigned short);
6798 vector bool short vec_sel (vector bool short,
6799                            vector bool short,
6800                            vector bool short);
6801 vector bool short vec_sel (vector bool short,
6802                            vector bool short,
6803                            vector unsigned short);
6804 vector signed char vec_sel (vector signed char,
6805                             vector signed char,
6806                             vector bool char);
6807 vector signed char vec_sel (vector signed char,
6808                             vector signed char,
6809                             vector unsigned char);
6810 vector unsigned char vec_sel (vector unsigned char,
6811                               vector unsigned char,
6812                               vector bool char);
6813 vector unsigned char vec_sel (vector unsigned char,
6814                               vector unsigned char,
6815                               vector unsigned char);
6816 vector bool char vec_sel (vector bool char,
6817                           vector bool char,
6818                           vector bool char);
6819 vector bool char vec_sel (vector bool char,
6820                           vector bool char,
6821                           vector unsigned char);
6822
6823 vector signed char vec_sl (vector signed char,
6824                            vector unsigned char);
6825 vector unsigned char vec_sl (vector unsigned char,
6826                              vector unsigned char);
6827 vector signed short vec_sl (vector signed short, vector unsigned short);
6828 vector unsigned short vec_sl (vector unsigned short,
6829                               vector unsigned short);
6830 vector signed int vec_sl (vector signed int, vector unsigned int);
6831 vector unsigned int vec_sl (vector unsigned int, vector unsigned int);
6832
6833 vector signed int vec_vslw (vector signed int, vector unsigned int);
6834 vector unsigned int vec_vslw (vector unsigned int, vector unsigned int);
6835
6836 vector signed short vec_vslh (vector signed short,
6837                               vector unsigned short);
6838 vector unsigned short vec_vslh (vector unsigned short,
6839                                 vector unsigned short);
6840
6841 vector signed char vec_vslb (vector signed char, vector unsigned char);
6842 vector unsigned char vec_vslb (vector unsigned char,
6843                                vector unsigned char);
6844
6845 vector float vec_sld (vector float, vector float, const int);
6846 vector signed int vec_sld (vector signed int,
6847                            vector signed int,
6848                            const int);
6849 vector unsigned int vec_sld (vector unsigned int,
6850                              vector unsigned int,
6851                              const int);
6852 vector bool int vec_sld (vector bool int,
6853                          vector bool int,
6854                          const int);
6855 vector signed short vec_sld (vector signed short,
6856                              vector signed short,
6857                              const int);
6858 vector unsigned short vec_sld (vector unsigned short,
6859                                vector unsigned short,
6860                                const int);
6861 vector bool short vec_sld (vector bool short,
6862                            vector bool short,
6863                            const int);
6864 vector pixel vec_sld (vector pixel,
6865                       vector pixel,
6866                       const int);
6867 vector signed char vec_sld (vector signed char,
6868                             vector signed char,
6869                             const int);
6870 vector unsigned char vec_sld (vector unsigned char,
6871                               vector unsigned char,
6872                               const int);
6873 vector bool char vec_sld (vector bool char,
6874                           vector bool char,
6875                           const int);
6876
6877 vector signed int vec_sll (vector signed int,
6878                            vector unsigned int);
6879 vector signed int vec_sll (vector signed int,
6880                            vector unsigned short);
6881 vector signed int vec_sll (vector signed int,
6882                            vector unsigned char);
6883 vector unsigned int vec_sll (vector unsigned int,
6884                              vector unsigned int);
6885 vector unsigned int vec_sll (vector unsigned int,
6886                              vector unsigned short);
6887 vector unsigned int vec_sll (vector unsigned int,
6888                              vector unsigned char);
6889 vector bool int vec_sll (vector bool int,
6890                          vector unsigned int);
6891 vector bool int vec_sll (vector bool int,
6892                          vector unsigned short);
6893 vector bool int vec_sll (vector bool int,
6894                          vector unsigned char);
6895 vector signed short vec_sll (vector signed short,
6896                              vector unsigned int);
6897 vector signed short vec_sll (vector signed short,
6898                              vector unsigned short);
6899 vector signed short vec_sll (vector signed short,
6900                              vector unsigned char);
6901 vector unsigned short vec_sll (vector unsigned short,
6902                                vector unsigned int);
6903 vector unsigned short vec_sll (vector unsigned short,
6904                                vector unsigned short);
6905 vector unsigned short vec_sll (vector unsigned short,
6906                                vector unsigned char);
6907 vector bool short vec_sll (vector bool short, vector unsigned int);
6908 vector bool short vec_sll (vector bool short, vector unsigned short);
6909 vector bool short vec_sll (vector bool short, vector unsigned char);
6910 vector pixel vec_sll (vector pixel, vector unsigned int);
6911 vector pixel vec_sll (vector pixel, vector unsigned short);
6912 vector pixel vec_sll (vector pixel, vector unsigned char);
6913 vector signed char vec_sll (vector signed char, vector unsigned int);
6914 vector signed char vec_sll (vector signed char, vector unsigned short);
6915 vector signed char vec_sll (vector signed char, vector unsigned char);
6916 vector unsigned char vec_sll (vector unsigned char,
6917                               vector unsigned int);
6918 vector unsigned char vec_sll (vector unsigned char,
6919                               vector unsigned short);
6920 vector unsigned char vec_sll (vector unsigned char,
6921                               vector unsigned char);
6922 vector bool char vec_sll (vector bool char, vector unsigned int);
6923 vector bool char vec_sll (vector bool char, vector unsigned short);
6924 vector bool char vec_sll (vector bool char, vector unsigned char);
6925
6926 vector float vec_slo (vector float, vector signed char);
6927 vector float vec_slo (vector float, vector unsigned char);
6928 vector signed int vec_slo (vector signed int, vector signed char);
6929 vector signed int vec_slo (vector signed int, vector unsigned char);
6930 vector unsigned int vec_slo (vector unsigned int, vector signed char);
6931 vector unsigned int vec_slo (vector unsigned int, vector unsigned char);
6932 vector signed short vec_slo (vector signed short, vector signed char);
6933 vector signed short vec_slo (vector signed short, vector unsigned char);
6934 vector unsigned short vec_slo (vector unsigned short,
6935                                vector signed char);
6936 vector unsigned short vec_slo (vector unsigned short,
6937                                vector unsigned char);
6938 vector pixel vec_slo (vector pixel, vector signed char);
6939 vector pixel vec_slo (vector pixel, vector unsigned char);
6940 vector signed char vec_slo (vector signed char, vector signed char);
6941 vector signed char vec_slo (vector signed char, vector unsigned char);
6942 vector unsigned char vec_slo (vector unsigned char, vector signed char);
6943 vector unsigned char vec_slo (vector unsigned char,
6944                               vector unsigned char);
6945
6946 vector signed char vec_splat (vector signed char, const int);
6947 vector unsigned char vec_splat (vector unsigned char, const int);
6948 vector bool char vec_splat (vector bool char, const int);
6949 vector signed short vec_splat (vector signed short, const int);
6950 vector unsigned short vec_splat (vector unsigned short, const int);
6951 vector bool short vec_splat (vector bool short, const int);
6952 vector pixel vec_splat (vector pixel, const int);
6953 vector float vec_splat (vector float, const int);
6954 vector signed int vec_splat (vector signed int, const int);
6955 vector unsigned int vec_splat (vector unsigned int, const int);
6956 vector bool int vec_splat (vector bool int, const int);
6957
6958 vector float vec_vspltw (vector float, const int);
6959 vector signed int vec_vspltw (vector signed int, const int);
6960 vector unsigned int vec_vspltw (vector unsigned int, const int);
6961 vector bool int vec_vspltw (vector bool int, const int);
6962
6963 vector bool short vec_vsplth (vector bool short, const int);
6964 vector signed short vec_vsplth (vector signed short, const int);
6965 vector unsigned short vec_vsplth (vector unsigned short, const int);
6966 vector pixel vec_vsplth (vector pixel, const int);
6967
6968 vector signed char vec_vspltb (vector signed char, const int);
6969 vector unsigned char vec_vspltb (vector unsigned char, const int);
6970 vector bool char vec_vspltb (vector bool char, const int);
6971
6972 vector signed char vec_splat_s8 (const int);
6973
6974 vector signed short vec_splat_s16 (const int);
6975
6976 vector signed int vec_splat_s32 (const int);
6977
6978 vector unsigned char vec_splat_u8 (const int);
6979
6980 vector unsigned short vec_splat_u16 (const int);
6981
6982 vector unsigned int vec_splat_u32 (const int);
6983
6984 vector signed char vec_sr (vector signed char, vector unsigned char);
6985 vector unsigned char vec_sr (vector unsigned char,
6986                              vector unsigned char);
6987 vector signed short vec_sr (vector signed short,
6988                             vector unsigned short);
6989 vector unsigned short vec_sr (vector unsigned short,
6990                               vector unsigned short);
6991 vector signed int vec_sr (vector signed int, vector unsigned int);
6992 vector unsigned int vec_sr (vector unsigned int, vector unsigned int);
6993
6994 vector signed int vec_vsrw (vector signed int, vector unsigned int);
6995 vector unsigned int vec_vsrw (vector unsigned int, vector unsigned int);
6996
6997 vector signed short vec_vsrh (vector signed short,
6998                               vector unsigned short);
6999 vector unsigned short vec_vsrh (vector unsigned short,
7000                                 vector unsigned short);
7001
7002 vector signed char vec_vsrb (vector signed char, vector unsigned char);
7003 vector unsigned char vec_vsrb (vector unsigned char,
7004                                vector unsigned char);
7005
7006 vector signed char vec_sra (vector signed char, vector unsigned char);
7007 vector unsigned char vec_sra (vector unsigned char,
7008                               vector unsigned char);
7009 vector signed short vec_sra (vector signed short,
7010                              vector unsigned short);
7011 vector unsigned short vec_sra (vector unsigned short,
7012                                vector unsigned short);
7013 vector signed int vec_sra (vector signed int, vector unsigned int);
7014 vector unsigned int vec_sra (vector unsigned int, vector unsigned int);
7015
7016 vector signed int vec_vsraw (vector signed int, vector unsigned int);
7017 vector unsigned int vec_vsraw (vector unsigned int,
7018                                vector unsigned int);
7019
7020 vector signed short vec_vsrah (vector signed short,
7021                                vector unsigned short);
7022 vector unsigned short vec_vsrah (vector unsigned short,
7023                                  vector unsigned short);
7024
7025 vector signed char vec_vsrab (vector signed char, vector unsigned char);
7026 vector unsigned char vec_vsrab (vector unsigned char,
7027                                 vector unsigned char);
7028
7029 vector signed int vec_srl (vector signed int, vector unsigned int);
7030 vector signed int vec_srl (vector signed int, vector unsigned short);
7031 vector signed int vec_srl (vector signed int, vector unsigned char);
7032 vector unsigned int vec_srl (vector unsigned int, vector unsigned int);
7033 vector unsigned int vec_srl (vector unsigned int,
7034                              vector unsigned short);
7035 vector unsigned int vec_srl (vector unsigned int, vector unsigned char);
7036 vector bool int vec_srl (vector bool int, vector unsigned int);
7037 vector bool int vec_srl (vector bool int, vector unsigned short);
7038 vector bool int vec_srl (vector bool int, vector unsigned char);
7039 vector signed short vec_srl (vector signed short, vector unsigned int);
7040 vector signed short vec_srl (vector signed short,
7041                              vector unsigned short);
7042 vector signed short vec_srl (vector signed short, vector unsigned char);
7043 vector unsigned short vec_srl (vector unsigned short,
7044                                vector unsigned int);
7045 vector unsigned short vec_srl (vector unsigned short,
7046                                vector unsigned short);
7047 vector unsigned short vec_srl (vector unsigned short,
7048                                vector unsigned char);
7049 vector bool short vec_srl (vector bool short, vector unsigned int);
7050 vector bool short vec_srl (vector bool short, vector unsigned short);
7051 vector bool short vec_srl (vector bool short, vector unsigned char);
7052 vector pixel vec_srl (vector pixel, vector unsigned int);
7053 vector pixel vec_srl (vector pixel, vector unsigned short);
7054 vector pixel vec_srl (vector pixel, vector unsigned char);
7055 vector signed char vec_srl (vector signed char, vector unsigned int);
7056 vector signed char vec_srl (vector signed char, vector unsigned short);
7057 vector signed char vec_srl (vector signed char, vector unsigned char);
7058 vector unsigned char vec_srl (vector unsigned char,
7059                               vector unsigned int);
7060 vector unsigned char vec_srl (vector unsigned char,
7061                               vector unsigned short);
7062 vector unsigned char vec_srl (vector unsigned char,
7063                               vector unsigned char);
7064 vector bool char vec_srl (vector bool char, vector unsigned int);
7065 vector bool char vec_srl (vector bool char, vector unsigned short);
7066 vector bool char vec_srl (vector bool char, vector unsigned char);
7067
7068 vector float vec_sro (vector float, vector signed char);
7069 vector float vec_sro (vector float, vector unsigned char);
7070 vector signed int vec_sro (vector signed int, vector signed char);
7071 vector signed int vec_sro (vector signed int, vector unsigned char);
7072 vector unsigned int vec_sro (vector unsigned int, vector signed char);
7073 vector unsigned int vec_sro (vector unsigned int, vector unsigned char);
7074 vector signed short vec_sro (vector signed short, vector signed char);
7075 vector signed short vec_sro (vector signed short, vector unsigned char);
7076 vector unsigned short vec_sro (vector unsigned short,
7077                                vector signed char);
7078 vector unsigned short vec_sro (vector unsigned short,
7079                                vector unsigned char);
7080 vector pixel vec_sro (vector pixel, vector signed char);
7081 vector pixel vec_sro (vector pixel, vector unsigned char);
7082 vector signed char vec_sro (vector signed char, vector signed char);
7083 vector signed char vec_sro (vector signed char, vector unsigned char);
7084 vector unsigned char vec_sro (vector unsigned char, vector signed char);
7085 vector unsigned char vec_sro (vector unsigned char,
7086                               vector unsigned char);
7087
7088 void vec_st (vector float, int, vector float *);
7089 void vec_st (vector float, int, float *);
7090 void vec_st (vector signed int, int, vector signed int *);
7091 void vec_st (vector signed int, int, int *);
7092 void vec_st (vector unsigned int, int, vector unsigned int *);
7093 void vec_st (vector unsigned int, int, unsigned int *);
7094 void vec_st (vector bool int, int, vector bool int *);
7095 void vec_st (vector bool int, int, unsigned int *);
7096 void vec_st (vector bool int, int, int *);
7097 void vec_st (vector signed short, int, vector signed short *);
7098 void vec_st (vector signed short, int, short *);
7099 void vec_st (vector unsigned short, int, vector unsigned short *);
7100 void vec_st (vector unsigned short, int, unsigned short *);
7101 void vec_st (vector bool short, int, vector bool short *);
7102 void vec_st (vector bool short, int, unsigned short *);
7103 void vec_st (vector pixel, int, vector pixel *);
7104 void vec_st (vector pixel, int, unsigned short *);
7105 void vec_st (vector pixel, int, short *);
7106 void vec_st (vector bool short, int, short *);
7107 void vec_st (vector signed char, int, vector signed char *);
7108 void vec_st (vector signed char, int, signed char *);
7109 void vec_st (vector unsigned char, int, vector unsigned char *);
7110 void vec_st (vector unsigned char, int, unsigned char *);
7111 void vec_st (vector bool char, int, vector bool char *);
7112 void vec_st (vector bool char, int, unsigned char *);
7113 void vec_st (vector bool char, int, signed char *);
7114
7115 void vec_ste (vector signed char, int, signed char *);
7116 void vec_ste (vector unsigned char, int, unsigned char *);
7117 void vec_ste (vector bool char, int, signed char *);
7118 void vec_ste (vector bool char, int, unsigned char *);
7119 void vec_ste (vector signed short, int, short *);
7120 void vec_ste (vector unsigned short, int, unsigned short *);
7121 void vec_ste (vector bool short, int, short *);
7122 void vec_ste (vector bool short, int, unsigned short *);
7123 void vec_ste (vector pixel, int, short *);
7124 void vec_ste (vector pixel, int, unsigned short *);
7125 void vec_ste (vector float, int, float *);
7126 void vec_ste (vector signed int, int, int *);
7127 void vec_ste (vector unsigned int, int, unsigned int *);
7128 void vec_ste (vector bool int, int, int *);
7129 void vec_ste (vector bool int, int, unsigned int *);
7130
7131 void vec_stvewx (vector float, int, float *);
7132 void vec_stvewx (vector signed int, int, int *);
7133 void vec_stvewx (vector unsigned int, int, unsigned int *);
7134 void vec_stvewx (vector bool int, int, int *);
7135 void vec_stvewx (vector bool int, int, unsigned int *);
7136
7137 void vec_stvehx (vector signed short, int, short *);
7138 void vec_stvehx (vector unsigned short, int, unsigned short *);
7139 void vec_stvehx (vector bool short, int, short *);
7140 void vec_stvehx (vector bool short, int, unsigned short *);
7141 void vec_stvehx (vector pixel, int, short *);
7142 void vec_stvehx (vector pixel, int, unsigned short *);
7143
7144 void vec_stvebx (vector signed char, int, signed char *);
7145 void vec_stvebx (vector unsigned char, int, unsigned char *);
7146 void vec_stvebx (vector bool char, int, signed char *);
7147 void vec_stvebx (vector bool char, int, unsigned char *);
7148
7149 void vec_stl (vector float, int, vector float *);
7150 void vec_stl (vector float, int, float *);
7151 void vec_stl (vector signed int, int, vector signed int *);
7152 void vec_stl (vector signed int, int, int *);
7153 void vec_stl (vector unsigned int, int, vector unsigned int *);
7154 void vec_stl (vector unsigned int, int, unsigned int *);
7155 void vec_stl (vector bool int, int, vector bool int *);
7156 void vec_stl (vector bool int, int, unsigned int *);
7157 void vec_stl (vector bool int, int, int *);
7158 void vec_stl (vector signed short, int, vector signed short *);
7159 void vec_stl (vector signed short, int, short *);
7160 void vec_stl (vector unsigned short, int, vector unsigned short *);
7161 void vec_stl (vector unsigned short, int, unsigned short *);
7162 void vec_stl (vector bool short, int, vector bool short *);
7163 void vec_stl (vector bool short, int, unsigned short *);
7164 void vec_stl (vector bool short, int, short *);
7165 void vec_stl (vector pixel, int, vector pixel *);
7166 void vec_stl (vector pixel, int, unsigned short *);
7167 void vec_stl (vector pixel, int, short *);
7168 void vec_stl (vector signed char, int, vector signed char *);
7169 void vec_stl (vector signed char, int, signed char *);
7170 void vec_stl (vector unsigned char, int, vector unsigned char *);
7171 void vec_stl (vector unsigned char, int, unsigned char *);
7172 void vec_stl (vector bool char, int, vector bool char *);
7173 void vec_stl (vector bool char, int, unsigned char *);
7174 void vec_stl (vector bool char, int, signed char *);
7175
7176 vector signed char vec_sub (vector bool char, vector signed char);
7177 vector signed char vec_sub (vector signed char, vector bool char);
7178 vector signed char vec_sub (vector signed char, vector signed char);
7179 vector unsigned char vec_sub (vector bool char, vector unsigned char);
7180 vector unsigned char vec_sub (vector unsigned char, vector bool char);
7181 vector unsigned char vec_sub (vector unsigned char,
7182                               vector unsigned char);
7183 vector signed short vec_sub (vector bool short, vector signed short);
7184 vector signed short vec_sub (vector signed short, vector bool short);
7185 vector signed short vec_sub (vector signed short, vector signed short);
7186 vector unsigned short vec_sub (vector bool short,
7187                                vector unsigned short);
7188 vector unsigned short vec_sub (vector unsigned short,
7189                                vector bool short);
7190 vector unsigned short vec_sub (vector unsigned short,
7191                                vector unsigned short);
7192 vector signed int vec_sub (vector bool int, vector signed int);
7193 vector signed int vec_sub (vector signed int, vector bool int);
7194 vector signed int vec_sub (vector signed int, vector signed int);
7195 vector unsigned int vec_sub (vector bool int, vector unsigned int);
7196 vector unsigned int vec_sub (vector unsigned int, vector bool int);
7197 vector unsigned int vec_sub (vector unsigned int, vector unsigned int);
7198 vector float vec_sub (vector float, vector float);
7199
7200 vector float vec_vsubfp (vector float, vector float);
7201
7202 vector signed int vec_vsubuwm (vector bool int, vector signed int);
7203 vector signed int vec_vsubuwm (vector signed int, vector bool int);
7204 vector signed int vec_vsubuwm (vector signed int, vector signed int);
7205 vector unsigned int vec_vsubuwm (vector bool int, vector unsigned int);
7206 vector unsigned int vec_vsubuwm (vector unsigned int, vector bool int);
7207 vector unsigned int vec_vsubuwm (vector unsigned int,
7208                                  vector unsigned int);
7209
7210 vector signed short vec_vsubuhm (vector bool short,
7211                                  vector signed short);
7212 vector signed short vec_vsubuhm (vector signed short,
7213                                  vector bool short);
7214 vector signed short vec_vsubuhm (vector signed short,
7215                                  vector signed short);
7216 vector unsigned short vec_vsubuhm (vector bool short,
7217                                    vector unsigned short);
7218 vector unsigned short vec_vsubuhm (vector unsigned short,
7219                                    vector bool short);
7220 vector unsigned short vec_vsubuhm (vector unsigned short,
7221                                    vector unsigned short);
7222
7223 vector signed char vec_vsububm (vector bool char, vector signed char);
7224 vector signed char vec_vsububm (vector signed char, vector bool char);
7225 vector signed char vec_vsububm (vector signed char, vector signed char);
7226 vector unsigned char vec_vsububm (vector bool char,
7227                                   vector unsigned char);
7228 vector unsigned char vec_vsububm (vector unsigned char,
7229                                   vector bool char);
7230 vector unsigned char vec_vsububm (vector unsigned char,
7231                                   vector unsigned char);
7232
7233 vector unsigned int vec_subc (vector unsigned int, vector unsigned int);
7234
7235 vector unsigned char vec_subs (vector bool char, vector unsigned char);
7236 vector unsigned char vec_subs (vector unsigned char, vector bool char);
7237 vector unsigned char vec_subs (vector unsigned char,
7238                                vector unsigned char);
7239 vector signed char vec_subs (vector bool char, vector signed char);
7240 vector signed char vec_subs (vector signed char, vector bool char);
7241 vector signed char vec_subs (vector signed char, vector signed char);
7242 vector unsigned short vec_subs (vector bool short,
7243                                 vector unsigned short);
7244 vector unsigned short vec_subs (vector unsigned short,
7245                                 vector bool short);
7246 vector unsigned short vec_subs (vector unsigned short,
7247                                 vector unsigned short);
7248 vector signed short vec_subs (vector bool short, vector signed short);
7249 vector signed short vec_subs (vector signed short, vector bool short);
7250 vector signed short vec_subs (vector signed short, vector signed short);
7251 vector unsigned int vec_subs (vector bool int, vector unsigned int);
7252 vector unsigned int vec_subs (vector unsigned int, vector bool int);
7253 vector unsigned int vec_subs (vector unsigned int, vector unsigned int);
7254 vector signed int vec_subs (vector bool int, vector signed int);
7255 vector signed int vec_subs (vector signed int, vector bool int);
7256 vector signed int vec_subs (vector signed int, vector signed int);
7257
7258 vector signed int vec_vsubsws (vector bool int, vector signed int);
7259 vector signed int vec_vsubsws (vector signed int, vector bool int);
7260 vector signed int vec_vsubsws (vector signed int, vector signed int);
7261
7262 vector unsigned int vec_vsubuws (vector bool int, vector unsigned int);
7263 vector unsigned int vec_vsubuws (vector unsigned int, vector bool int);
7264 vector unsigned int vec_vsubuws (vector unsigned int,
7265                                  vector unsigned int);
7266
7267 vector signed short vec_vsubshs (vector bool short,
7268                                  vector signed short);
7269 vector signed short vec_vsubshs (vector signed short,
7270                                  vector bool short);
7271 vector signed short vec_vsubshs (vector signed short,
7272                                  vector signed short);
7273
7274 vector unsigned short vec_vsubuhs (vector bool short,
7275                                    vector unsigned short);
7276 vector unsigned short vec_vsubuhs (vector unsigned short,
7277                                    vector bool short);
7278 vector unsigned short vec_vsubuhs (vector unsigned short,
7279                                    vector unsigned short);
7280
7281 vector signed char vec_vsubsbs (vector bool char, vector signed char);
7282 vector signed char vec_vsubsbs (vector signed char, vector bool char);
7283 vector signed char vec_vsubsbs (vector signed char, vector signed char);
7284
7285 vector unsigned char vec_vsububs (vector bool char,
7286                                   vector unsigned char);
7287 vector unsigned char vec_vsububs (vector unsigned char,
7288                                   vector bool char);
7289 vector unsigned char vec_vsububs (vector unsigned char,
7290                                   vector unsigned char);
7291
7292 vector unsigned int vec_sum4s (vector unsigned char,
7293                                vector unsigned int);
7294 vector signed int vec_sum4s (vector signed char, vector signed int);
7295 vector signed int vec_sum4s (vector signed short, vector signed int);
7296
7297 vector signed int vec_vsum4shs (vector signed short, vector signed int);
7298
7299 vector signed int vec_vsum4sbs (vector signed char, vector signed int);
7300
7301 vector unsigned int vec_vsum4ubs (vector unsigned char,
7302                                   vector unsigned int);
7303
7304 vector signed int vec_sum2s (vector signed int, vector signed int);
7305
7306 vector signed int vec_sums (vector signed int, vector signed int);
7307
7308 vector float vec_trunc (vector float);
7309
7310 vector signed short vec_unpackh (vector signed char);
7311 vector bool short vec_unpackh (vector bool char);
7312 vector signed int vec_unpackh (vector signed short);
7313 vector bool int vec_unpackh (vector bool short);
7314 vector unsigned int vec_unpackh (vector pixel);
7315
7316 vector bool int vec_vupkhsh (vector bool short);
7317 vector signed int vec_vupkhsh (vector signed short);
7318
7319 vector unsigned int vec_vupkhpx (vector pixel);
7320
7321 vector bool short vec_vupkhsb (vector bool char);
7322 vector signed short vec_vupkhsb (vector signed char);
7323
7324 vector signed short vec_unpackl (vector signed char);
7325 vector bool short vec_unpackl (vector bool char);
7326 vector unsigned int vec_unpackl (vector pixel);
7327 vector signed int vec_unpackl (vector signed short);
7328 vector bool int vec_unpackl (vector bool short);
7329
7330 vector unsigned int vec_vupklpx (vector pixel);
7331
7332 vector bool int vec_vupklsh (vector bool short);
7333 vector signed int vec_vupklsh (vector signed short);
7334
7335 vector bool short vec_vupklsb (vector bool char);
7336 vector signed short vec_vupklsb (vector signed char);
7337
7338 vector float vec_xor (vector float, vector float);
7339 vector float vec_xor (vector float, vector bool int);
7340 vector float vec_xor (vector bool int, vector float);
7341 vector bool int vec_xor (vector bool int, vector bool int);
7342 vector signed int vec_xor (vector bool int, vector signed int);
7343 vector signed int vec_xor (vector signed int, vector bool int);
7344 vector signed int vec_xor (vector signed int, vector signed int);
7345 vector unsigned int vec_xor (vector bool int, vector unsigned int);
7346 vector unsigned int vec_xor (vector unsigned int, vector bool int);
7347 vector unsigned int vec_xor (vector unsigned int, vector unsigned int);
7348 vector bool short vec_xor (vector bool short, vector bool short);
7349 vector signed short vec_xor (vector bool short, vector signed short);
7350 vector signed short vec_xor (vector signed short, vector bool short);
7351 vector signed short vec_xor (vector signed short, vector signed short);
7352 vector unsigned short vec_xor (vector bool short,
7353                                vector unsigned short);
7354 vector unsigned short vec_xor (vector unsigned short,
7355                                vector bool short);
7356 vector unsigned short vec_xor (vector unsigned short,
7357                                vector unsigned short);
7358 vector signed char vec_xor (vector bool char, vector signed char);
7359 vector bool char vec_xor (vector bool char, vector bool char);
7360 vector signed char vec_xor (vector signed char, vector bool char);
7361 vector signed char vec_xor (vector signed char, vector signed char);
7362 vector unsigned char vec_xor (vector bool char, vector unsigned char);
7363 vector unsigned char vec_xor (vector unsigned char, vector bool char);
7364 vector unsigned char vec_xor (vector unsigned char,
7365                               vector unsigned char);
7366
7367 int vec_all_eq (vector signed char, vector bool char);
7368 int vec_all_eq (vector signed char, vector signed char);
7369 int vec_all_eq (vector unsigned char, vector bool char);
7370 int vec_all_eq (vector unsigned char, vector unsigned char);
7371 int vec_all_eq (vector bool char, vector bool char);
7372 int vec_all_eq (vector bool char, vector unsigned char);
7373 int vec_all_eq (vector bool char, vector signed char);
7374 int vec_all_eq (vector signed short, vector bool short);
7375 int vec_all_eq (vector signed short, vector signed short);
7376 int vec_all_eq (vector unsigned short, vector bool short);
7377 int vec_all_eq (vector unsigned short, vector unsigned short);
7378 int vec_all_eq (vector bool short, vector bool short);
7379 int vec_all_eq (vector bool short, vector unsigned short);
7380 int vec_all_eq (vector bool short, vector signed short);
7381 int vec_all_eq (vector pixel, vector pixel);
7382 int vec_all_eq (vector signed int, vector bool int);
7383 int vec_all_eq (vector signed int, vector signed int);
7384 int vec_all_eq (vector unsigned int, vector bool int);
7385 int vec_all_eq (vector unsigned int, vector unsigned int);
7386 int vec_all_eq (vector bool int, vector bool int);
7387 int vec_all_eq (vector bool int, vector unsigned int);
7388 int vec_all_eq (vector bool int, vector signed int);
7389 int vec_all_eq (vector float, vector float);
7390
7391 int vec_all_ge (vector bool char, vector unsigned char);
7392 int vec_all_ge (vector unsigned char, vector bool char);
7393 int vec_all_ge (vector unsigned char, vector unsigned char);
7394 int vec_all_ge (vector bool char, vector signed char);
7395 int vec_all_ge (vector signed char, vector bool char);
7396 int vec_all_ge (vector signed char, vector signed char);
7397 int vec_all_ge (vector bool short, vector unsigned short);
7398 int vec_all_ge (vector unsigned short, vector bool short);
7399 int vec_all_ge (vector unsigned short, vector unsigned short);
7400 int vec_all_ge (vector signed short, vector signed short);
7401 int vec_all_ge (vector bool short, vector signed short);
7402 int vec_all_ge (vector signed short, vector bool short);
7403 int vec_all_ge (vector bool int, vector unsigned int);
7404 int vec_all_ge (vector unsigned int, vector bool int);
7405 int vec_all_ge (vector unsigned int, vector unsigned int);
7406 int vec_all_ge (vector bool int, vector signed int);
7407 int vec_all_ge (vector signed int, vector bool int);
7408 int vec_all_ge (vector signed int, vector signed int);
7409 int vec_all_ge (vector float, vector float);
7410
7411 int vec_all_gt (vector bool char, vector unsigned char);
7412 int vec_all_gt (vector unsigned char, vector bool char);
7413 int vec_all_gt (vector unsigned char, vector unsigned char);
7414 int vec_all_gt (vector bool char, vector signed char);
7415 int vec_all_gt (vector signed char, vector bool char);
7416 int vec_all_gt (vector signed char, vector signed char);
7417 int vec_all_gt (vector bool short, vector unsigned short);
7418 int vec_all_gt (vector unsigned short, vector bool short);
7419 int vec_all_gt (vector unsigned short, vector unsigned short);
7420 int vec_all_gt (vector bool short, vector signed short);
7421 int vec_all_gt (vector signed short, vector bool short);
7422 int vec_all_gt (vector signed short, vector signed short);
7423 int vec_all_gt (vector bool int, vector unsigned int);
7424 int vec_all_gt (vector unsigned int, vector bool int);
7425 int vec_all_gt (vector unsigned int, vector unsigned int);
7426 int vec_all_gt (vector bool int, vector signed int);
7427 int vec_all_gt (vector signed int, vector bool int);
7428 int vec_all_gt (vector signed int, vector signed int);
7429 int vec_all_gt (vector float, vector float);
7430
7431 int vec_all_in (vector float, vector float);
7432
7433 int vec_all_le (vector bool char, vector unsigned char);
7434 int vec_all_le (vector unsigned char, vector bool char);
7435 int vec_all_le (vector unsigned char, vector unsigned char);
7436 int vec_all_le (vector bool char, vector signed char);
7437 int vec_all_le (vector signed char, vector bool char);
7438 int vec_all_le (vector signed char, vector signed char);
7439 int vec_all_le (vector bool short, vector unsigned short);
7440 int vec_all_le (vector unsigned short, vector bool short);
7441 int vec_all_le (vector unsigned short, vector unsigned short);
7442 int vec_all_le (vector bool short, vector signed short);
7443 int vec_all_le (vector signed short, vector bool short);
7444 int vec_all_le (vector signed short, vector signed short);
7445 int vec_all_le (vector bool int, vector unsigned int);
7446 int vec_all_le (vector unsigned int, vector bool int);
7447 int vec_all_le (vector unsigned int, vector unsigned int);
7448 int vec_all_le (vector bool int, vector signed int);
7449 int vec_all_le (vector signed int, vector bool int);
7450 int vec_all_le (vector signed int, vector signed int);
7451 int vec_all_le (vector float, vector float);
7452
7453 int vec_all_lt (vector bool char, vector unsigned char);
7454 int vec_all_lt (vector unsigned char, vector bool char);
7455 int vec_all_lt (vector unsigned char, vector unsigned char);
7456 int vec_all_lt (vector bool char, vector signed char);
7457 int vec_all_lt (vector signed char, vector bool char);
7458 int vec_all_lt (vector signed char, vector signed char);
7459 int vec_all_lt (vector bool short, vector unsigned short);
7460 int vec_all_lt (vector unsigned short, vector bool short);
7461 int vec_all_lt (vector unsigned short, vector unsigned short);
7462 int vec_all_lt (vector bool short, vector signed short);
7463 int vec_all_lt (vector signed short, vector bool short);
7464 int vec_all_lt (vector signed short, vector signed short);
7465 int vec_all_lt (vector bool int, vector unsigned int);
7466 int vec_all_lt (vector unsigned int, vector bool int);
7467 int vec_all_lt (vector unsigned int, vector unsigned int);
7468 int vec_all_lt (vector bool int, vector signed int);
7469 int vec_all_lt (vector signed int, vector bool int);
7470 int vec_all_lt (vector signed int, vector signed int);
7471 int vec_all_lt (vector float, vector float);
7472
7473 int vec_all_nan (vector float);
7474
7475 int vec_all_ne (vector signed char, vector bool char);
7476 int vec_all_ne (vector signed char, vector signed char);
7477 int vec_all_ne (vector unsigned char, vector bool char);
7478 int vec_all_ne (vector unsigned char, vector unsigned char);
7479 int vec_all_ne (vector bool char, vector bool char);
7480 int vec_all_ne (vector bool char, vector unsigned char);
7481 int vec_all_ne (vector bool char, vector signed char);
7482 int vec_all_ne (vector signed short, vector bool short);
7483 int vec_all_ne (vector signed short, vector signed short);
7484 int vec_all_ne (vector unsigned short, vector bool short);
7485 int vec_all_ne (vector unsigned short, vector unsigned short);
7486 int vec_all_ne (vector bool short, vector bool short);
7487 int vec_all_ne (vector bool short, vector unsigned short);
7488 int vec_all_ne (vector bool short, vector signed short);
7489 int vec_all_ne (vector pixel, vector pixel);
7490 int vec_all_ne (vector signed int, vector bool int);
7491 int vec_all_ne (vector signed int, vector signed int);
7492 int vec_all_ne (vector unsigned int, vector bool int);
7493 int vec_all_ne (vector unsigned int, vector unsigned int);
7494 int vec_all_ne (vector bool int, vector bool int);
7495 int vec_all_ne (vector bool int, vector unsigned int);
7496 int vec_all_ne (vector bool int, vector signed int);
7497 int vec_all_ne (vector float, vector float);
7498
7499 int vec_all_nge (vector float, vector float);
7500
7501 int vec_all_ngt (vector float, vector float);
7502
7503 int vec_all_nle (vector float, vector float);
7504
7505 int vec_all_nlt (vector float, vector float);
7506
7507 int vec_all_numeric (vector float);
7508
7509 int vec_any_eq (vector signed char, vector bool char);
7510 int vec_any_eq (vector signed char, vector signed char);
7511 int vec_any_eq (vector unsigned char, vector bool char);
7512 int vec_any_eq (vector unsigned char, vector unsigned char);
7513 int vec_any_eq (vector bool char, vector bool char);
7514 int vec_any_eq (vector bool char, vector unsigned char);
7515 int vec_any_eq (vector bool char, vector signed char);
7516 int vec_any_eq (vector signed short, vector bool short);
7517 int vec_any_eq (vector signed short, vector signed short);
7518 int vec_any_eq (vector unsigned short, vector bool short);
7519 int vec_any_eq (vector unsigned short, vector unsigned short);
7520 int vec_any_eq (vector bool short, vector bool short);
7521 int vec_any_eq (vector bool short, vector unsigned short);
7522 int vec_any_eq (vector bool short, vector signed short);
7523 int vec_any_eq (vector pixel, vector pixel);
7524 int vec_any_eq (vector signed int, vector bool int);
7525 int vec_any_eq (vector signed int, vector signed int);
7526 int vec_any_eq (vector unsigned int, vector bool int);
7527 int vec_any_eq (vector unsigned int, vector unsigned int);
7528 int vec_any_eq (vector bool int, vector bool int);
7529 int vec_any_eq (vector bool int, vector unsigned int);
7530 int vec_any_eq (vector bool int, vector signed int);
7531 int vec_any_eq (vector float, vector float);
7532
7533 int vec_any_ge (vector signed char, vector bool char);
7534 int vec_any_ge (vector unsigned char, vector bool char);
7535 int vec_any_ge (vector unsigned char, vector unsigned char);
7536 int vec_any_ge (vector signed char, vector signed char);
7537 int vec_any_ge (vector bool char, vector unsigned char);
7538 int vec_any_ge (vector bool char, vector signed char);
7539 int vec_any_ge (vector unsigned short, vector bool short);
7540 int vec_any_ge (vector unsigned short, vector unsigned short);
7541 int vec_any_ge (vector signed short, vector signed short);
7542 int vec_any_ge (vector signed short, vector bool short);
7543 int vec_any_ge (vector bool short, vector unsigned short);
7544 int vec_any_ge (vector bool short, vector signed short);
7545 int vec_any_ge (vector signed int, vector bool int);
7546 int vec_any_ge (vector unsigned int, vector bool int);
7547 int vec_any_ge (vector unsigned int, vector unsigned int);
7548 int vec_any_ge (vector signed int, vector signed int);
7549 int vec_any_ge (vector bool int, vector unsigned int);
7550 int vec_any_ge (vector bool int, vector signed int);
7551 int vec_any_ge (vector float, vector float);
7552
7553 int vec_any_gt (vector bool char, vector unsigned char);
7554 int vec_any_gt (vector unsigned char, vector bool char);
7555 int vec_any_gt (vector unsigned char, vector unsigned char);
7556 int vec_any_gt (vector bool char, vector signed char);
7557 int vec_any_gt (vector signed char, vector bool char);
7558 int vec_any_gt (vector signed char, vector signed char);
7559 int vec_any_gt (vector bool short, vector unsigned short);
7560 int vec_any_gt (vector unsigned short, vector bool short);
7561 int vec_any_gt (vector unsigned short, vector unsigned short);
7562 int vec_any_gt (vector bool short, vector signed short);
7563 int vec_any_gt (vector signed short, vector bool short);
7564 int vec_any_gt (vector signed short, vector signed short);
7565 int vec_any_gt (vector bool int, vector unsigned int);
7566 int vec_any_gt (vector unsigned int, vector bool int);
7567 int vec_any_gt (vector unsigned int, vector unsigned int);
7568 int vec_any_gt (vector bool int, vector signed int);
7569 int vec_any_gt (vector signed int, vector bool int);
7570 int vec_any_gt (vector signed int, vector signed int);
7571 int vec_any_gt (vector float, vector float);
7572
7573 int vec_any_le (vector bool char, vector unsigned char);
7574 int vec_any_le (vector unsigned char, vector bool char);
7575 int vec_any_le (vector unsigned char, vector unsigned char);
7576 int vec_any_le (vector bool char, vector signed char);
7577 int vec_any_le (vector signed char, vector bool char);
7578 int vec_any_le (vector signed char, vector signed char);
7579 int vec_any_le (vector bool short, vector unsigned short);
7580 int vec_any_le (vector unsigned short, vector bool short);
7581 int vec_any_le (vector unsigned short, vector unsigned short);
7582 int vec_any_le (vector bool short, vector signed short);
7583 int vec_any_le (vector signed short, vector bool short);
7584 int vec_any_le (vector signed short, vector signed short);
7585 int vec_any_le (vector bool int, vector unsigned int);
7586 int vec_any_le (vector unsigned int, vector bool int);
7587 int vec_any_le (vector unsigned int, vector unsigned int);
7588 int vec_any_le (vector bool int, vector signed int);
7589 int vec_any_le (vector signed int, vector bool int);
7590 int vec_any_le (vector signed int, vector signed int);
7591 int vec_any_le (vector float, vector float);
7592
7593 int vec_any_lt (vector bool char, vector unsigned char);
7594 int vec_any_lt (vector unsigned char, vector bool char);
7595 int vec_any_lt (vector unsigned char, vector unsigned char);
7596 int vec_any_lt (vector bool char, vector signed char);
7597 int vec_any_lt (vector signed char, vector bool char);
7598 int vec_any_lt (vector signed char, vector signed char);
7599 int vec_any_lt (vector bool short, vector unsigned short);
7600 int vec_any_lt (vector unsigned short, vector bool short);
7601 int vec_any_lt (vector unsigned short, vector unsigned short);
7602 int vec_any_lt (vector bool short, vector signed short);
7603 int vec_any_lt (vector signed short, vector bool short);
7604 int vec_any_lt (vector signed short, vector signed short);
7605 int vec_any_lt (vector bool int, vector unsigned int);
7606 int vec_any_lt (vector unsigned int, vector bool int);
7607 int vec_any_lt (vector unsigned int, vector unsigned int);
7608 int vec_any_lt (vector bool int, vector signed int);
7609 int vec_any_lt (vector signed int, vector bool int);
7610 int vec_any_lt (vector signed int, vector signed int);
7611 int vec_any_lt (vector float, vector float);
7612
7613 int vec_any_nan (vector float);
7614
7615 int vec_any_ne (vector signed char, vector bool char);
7616 int vec_any_ne (vector signed char, vector signed char);
7617 int vec_any_ne (vector unsigned char, vector bool char);
7618 int vec_any_ne (vector unsigned char, vector unsigned char);
7619 int vec_any_ne (vector bool char, vector bool char);
7620 int vec_any_ne (vector bool char, vector unsigned char);
7621 int vec_any_ne (vector bool char, vector signed char);
7622 int vec_any_ne (vector signed short, vector bool short);
7623 int vec_any_ne (vector signed short, vector signed short);
7624 int vec_any_ne (vector unsigned short, vector bool short);
7625 int vec_any_ne (vector unsigned short, vector unsigned short);
7626 int vec_any_ne (vector bool short, vector bool short);
7627 int vec_any_ne (vector bool short, vector unsigned short);
7628 int vec_any_ne (vector bool short, vector signed short);
7629 int vec_any_ne (vector pixel, vector pixel);
7630 int vec_any_ne (vector signed int, vector bool int);
7631 int vec_any_ne (vector signed int, vector signed int);
7632 int vec_any_ne (vector unsigned int, vector bool int);
7633 int vec_any_ne (vector unsigned int, vector unsigned int);
7634 int vec_any_ne (vector bool int, vector bool int);
7635 int vec_any_ne (vector bool int, vector unsigned int);
7636 int vec_any_ne (vector bool int, vector signed int);
7637 int vec_any_ne (vector float, vector float);
7638
7639 int vec_any_nge (vector float, vector float);
7640
7641 int vec_any_ngt (vector float, vector float);
7642
7643 int vec_any_nle (vector float, vector float);
7644
7645 int vec_any_nlt (vector float, vector float);
7646
7647 int vec_any_numeric (vector float);
7648
7649 int vec_any_out (vector float, vector float);
7650 @end smallexample
7651
7652 @node Target Format Checks
7653 @section Format Checks Specific to Particular Target Machines
7654
7655 For some target machines, GCC supports additional options to the
7656 format attribute
7657 (@pxref{Function Attributes,,Declaring Attributes of Functions}).
7658
7659 @menu
7660 * Solaris Format Checks::
7661 @end menu
7662
7663 @node Solaris Format Checks
7664 @subsection Solaris Format Checks
7665
7666 Solaris targets support the @code{cmn_err} (or @code{__cmn_err__}) format
7667 check.  @code{cmn_err} accepts a subset of the standard @code{printf}
7668 conversions, and the two-argument @code{%b} conversion for displaying
7669 bit-fields.  See the Solaris man page for @code{cmn_err} for more information.
7670
7671 @node Pragmas
7672 @section Pragmas Accepted by GCC
7673 @cindex pragmas
7674 @cindex #pragma
7675
7676 GCC supports several types of pragmas, primarily in order to compile
7677 code originally written for other compilers.  Note that in general
7678 we do not recommend the use of pragmas; @xref{Function Attributes},
7679 for further explanation.
7680
7681 @menu
7682 * ARM Pragmas::
7683 * RS/6000 and PowerPC Pragmas::
7684 * Darwin Pragmas::
7685 * Solaris Pragmas::
7686 * Symbol-Renaming Pragmas::
7687 * Structure-Packing Pragmas::
7688 @end menu
7689
7690 @node ARM Pragmas
7691 @subsection ARM Pragmas
7692
7693 The ARM target defines pragmas for controlling the default addition of
7694 @code{long_call} and @code{short_call} attributes to functions.
7695 @xref{Function Attributes}, for information about the effects of these
7696 attributes.
7697
7698 @table @code
7699 @item long_calls
7700 @cindex pragma, long_calls
7701 Set all subsequent functions to have the @code{long_call} attribute.
7702
7703 @item no_long_calls
7704 @cindex pragma, no_long_calls
7705 Set all subsequent functions to have the @code{short_call} attribute.
7706
7707 @item long_calls_off
7708 @cindex pragma, long_calls_off
7709 Do not affect the @code{long_call} or @code{short_call} attributes of
7710 subsequent functions.
7711 @end table
7712
7713 @node RS/6000 and PowerPC Pragmas
7714 @subsection RS/6000 and PowerPC Pragmas
7715
7716 The RS/6000 and PowerPC targets define one pragma for controlling
7717 whether or not the @code{longcall} attribute is added to function
7718 declarations by default.  This pragma overrides the @option{-mlongcall}
7719 option, but not the @code{longcall} and @code{shortcall} attributes.
7720 @xref{RS/6000 and PowerPC Options}, for more information about when long
7721 calls are and are not necessary.
7722
7723 @table @code
7724 @item longcall (1)
7725 @cindex pragma, longcall
7726 Apply the @code{longcall} attribute to all subsequent function
7727 declarations.
7728
7729 @item longcall (0)
7730 Do not apply the @code{longcall} attribute to subsequent function
7731 declarations.
7732 @end table
7733
7734 @c Describe c4x pragmas here.
7735 @c Describe h8300 pragmas here.
7736 @c Describe sh pragmas here.
7737 @c Describe v850 pragmas here.
7738
7739 @node Darwin Pragmas
7740 @subsection Darwin Pragmas
7741
7742 The following pragmas are available for all architectures running the
7743 Darwin operating system.  These are useful for compatibility with other
7744 Mac OS compilers.
7745
7746 @table @code
7747 @item mark @var{tokens}@dots{}
7748 @cindex pragma, mark
7749 This pragma is accepted, but has no effect.
7750
7751 @item options align=@var{alignment}
7752 @cindex pragma, options align
7753 This pragma sets the alignment of fields in structures.  The values of
7754 @var{alignment} may be @code{mac68k}, to emulate m68k alignment, or
7755 @code{power}, to emulate PowerPC alignment.  Uses of this pragma nest
7756 properly; to restore the previous setting, use @code{reset} for the
7757 @var{alignment}.
7758
7759 @item segment @var{tokens}@dots{}
7760 @cindex pragma, segment
7761 This pragma is accepted, but has no effect.
7762
7763 @item unused (@var{var} [, @var{var}]@dots{})
7764 @cindex pragma, unused
7765 This pragma declares variables to be possibly unused.  GCC will not
7766 produce warnings for the listed variables.  The effect is similar to
7767 that of the @code{unused} attribute, except that this pragma may appear
7768 anywhere within the variables' scopes.
7769 @end table
7770
7771 @node Solaris Pragmas
7772 @subsection Solaris Pragmas
7773
7774 The Solaris target supports @code{#pragma redefine_extname}
7775 (@pxref{Symbol-Renaming Pragmas}).  It also supports additional
7776 @code{#pragma} directives for compatibility with the system compiler.
7777
7778 @table @code
7779 @item align @var{alignment} (@var{variable} [, @var{variable}]...)
7780 @cindex pragma, align
7781
7782 Increase the minimum alignment of each @var{variable} to @var{alignment}.
7783 This is the same as GCC's @code{aligned} attribute @pxref{Variable
7784 Attributes}).
7785
7786 @item fini (@var{function} [, @var{function}]...)
7787 @cindex pragma, fini
7788
7789 This pragma causes each listed @var{function} to be called after
7790 main, or during shared module unloading, by adding a call to the
7791 @code{.fini} section.
7792
7793 @item init (@var{function} [, @var{function}]...)
7794 @cindex pragma, init
7795
7796 This pragma causes each listed @var{function} to be called during
7797 initialization (before @code{main}) or during shared module loading, by
7798 adding a call to the @code{.init} section.
7799
7800 @end table
7801
7802 @node Symbol-Renaming Pragmas
7803 @subsection Symbol-Renaming Pragmas
7804
7805 For compatibility with the Solaris and Tru64 UNIX system headers, GCC
7806 supports two @code{#pragma} directives which change the name used in
7807 assembly for a given declaration.  These pragmas are only available on
7808 platforms whose system headers need them.  To get this effect on all
7809 platforms supported by GCC, use the asm labels extension (@pxref{Asm
7810 Labels}).
7811
7812 @table @code
7813 @item redefine_extname @var{oldname} @var{newname}
7814 @cindex pragma, redefine_extname
7815
7816 This pragma gives the C function @var{oldname} the assembly symbol
7817 @var{newname}.  The preprocessor macro @code{__PRAGMA_REDEFINE_EXTNAME}
7818 will be defined if this pragma is available (currently only on
7819 Solaris).
7820
7821 @item extern_prefix @var{string}
7822 @cindex pragma, extern_prefix
7823
7824 This pragma causes all subsequent external function and variable
7825 declarations to have @var{string} prepended to their assembly symbols.
7826 This effect may be terminated with another @code{extern_prefix} pragma
7827 whose argument is an empty string.  The preprocessor macro
7828 @code{__PRAGMA_EXTERN_PREFIX} will be defined if this pragma is
7829 available (currently only on Tru64 UNIX).
7830 @end table
7831
7832 These pragmas and the asm labels extension interact in a complicated
7833 manner.  Here are some corner cases you may want to be aware of.
7834
7835 @enumerate
7836 @item Both pragmas silently apply only to declarations with external
7837 linkage.  Asm labels do not have this restriction.
7838
7839 @item In C++, both pragmas silently apply only to declarations with
7840 ``C'' linkage.  Again, asm labels do not have this restriction.
7841
7842 @item If any of the three ways of changing the assembly name of a
7843 declaration is applied to a declaration whose assembly name has
7844 already been determined (either by a previous use of one of these
7845 features, or because the compiler needed the assembly name in order to
7846 generate code), and the new name is different, a warning issues and
7847 the name does not change.
7848
7849 @item The @var{oldname} used by @code{#pragma redefine_extname} is
7850 always the C-language name.
7851
7852 @item If @code{#pragma extern_prefix} is in effect, and a declaration
7853 occurs with an asm label attached, the prefix is silently ignored for
7854 that declaration.
7855
7856 @item If @code{#pragma extern_prefix} and @code{#pragma redefine_extname}
7857 apply to the same declaration, whichever triggered first wins, and a
7858 warning issues if they contradict each other.  (We would like to have
7859 @code{#pragma redefine_extname} always win, for consistency with asm
7860 labels, but if @code{#pragma extern_prefix} triggers first we have no
7861 way of knowing that that happened.)
7862 @end enumerate
7863
7864 @node Structure-Packing Pragmas
7865 @subsection Structure-Packing Pragmas
7866
7867 For compatibility with Win32, GCC supports as set of @code{#pragma}
7868 directives which change the maximum alignment of members of structures,
7869 unions, and classes subsequently defined.  The @var{n} value below always
7870 is required to be a small power of two and specifies the new alignment
7871 in bytes.
7872
7873 @enumerate
7874 @item @code{#pragma pack(@var{n})} simply sets the new alignment.
7875 @item @code{#pragma pack()} sets the alignment to the one that was in
7876 effect when compilation started (see also command line option
7877 @option{-fpack-struct[=<n>]} @pxref{Code Gen Options}).
7878 @item @code{#pragma pack(push[,@var{n}])} pushes the current alignment
7879 setting on an internal stack and then optionally sets the new alignment.
7880 @item @code{#pragma pack(pop)} restores the alignment setting to the one
7881 saved at the top of the internal stack (and removes that stack entry).
7882 Note that @code{#pragma pack([@var{n}])} does not influence this internal
7883 stack; thus it is possible to have @code{#pragma pack(push)} followed by
7884 multiple @code{#pragma pack(@var{n})} instances and finalized by a single
7885 @code{#pragma pack(pop)}.
7886 @end enumerate
7887
7888 @node Unnamed Fields
7889 @section Unnamed struct/union fields within structs/unions.
7890 @cindex struct
7891 @cindex union
7892
7893 For compatibility with other compilers, GCC allows you to define
7894 a structure or union that contains, as fields, structures and unions
7895 without names.  For example:
7896
7897 @smallexample
7898 struct @{
7899   int a;
7900   union @{
7901     int b;
7902     float c;
7903   @};
7904   int d;
7905 @} foo;
7906 @end smallexample
7907
7908 In this example, the user would be able to access members of the unnamed
7909 union with code like @samp{foo.b}.  Note that only unnamed structs and
7910 unions are allowed, you may not have, for example, an unnamed
7911 @code{int}.
7912
7913 You must never create such structures that cause ambiguous field definitions.
7914 For example, this structure:
7915
7916 @smallexample
7917 struct @{
7918   int a;
7919   struct @{
7920     int a;
7921   @};
7922 @} foo;
7923 @end smallexample
7924
7925 It is ambiguous which @code{a} is being referred to with @samp{foo.a}.
7926 Such constructs are not supported and must be avoided.  In the future,
7927 such constructs may be detected and treated as compilation errors.
7928
7929 @node Thread-Local
7930 @section Thread-Local Storage
7931 @cindex Thread-Local Storage
7932 @cindex @acronym{TLS}
7933 @cindex __thread
7934
7935 Thread-local storage (@acronym{TLS}) is a mechanism by which variables
7936 are allocated such that there is one instance of the variable per extant
7937 thread.  The run-time model GCC uses to implement this originates
7938 in the IA-64 processor-specific ABI, but has since been migrated
7939 to other processors as well.  It requires significant support from
7940 the linker (@command{ld}), dynamic linker (@command{ld.so}), and
7941 system libraries (@file{libc.so} and @file{libpthread.so}), so it
7942 is not available everywhere.
7943
7944 At the user level, the extension is visible with a new storage
7945 class keyword: @code{__thread}.  For example:
7946
7947 @smallexample
7948 __thread int i;
7949 extern __thread struct state s;
7950 static __thread char *p;
7951 @end smallexample
7952
7953 The @code{__thread} specifier may be used alone, with the @code{extern}
7954 or @code{static} specifiers, but with no other storage class specifier.
7955 When used with @code{extern} or @code{static}, @code{__thread} must appear
7956 immediately after the other storage class specifier.
7957
7958 The @code{__thread} specifier may be applied to any global, file-scoped
7959 static, function-scoped static, or static data member of a class.  It may
7960 not be applied to block-scoped automatic or non-static data member.
7961
7962 When the address-of operator is applied to a thread-local variable, it is
7963 evaluated at run-time and returns the address of the current thread's
7964 instance of that variable.  An address so obtained may be used by any
7965 thread.  When a thread terminates, any pointers to thread-local variables
7966 in that thread become invalid.
7967
7968 No static initialization may refer to the address of a thread-local variable.
7969
7970 In C++, if an initializer is present for a thread-local variable, it must
7971 be a @var{constant-expression}, as defined in 5.19.2 of the ANSI/ISO C++
7972 standard.
7973
7974 See @uref{http://people.redhat.com/drepper/tls.pdf,
7975 ELF Handling For Thread-Local Storage} for a detailed explanation of
7976 the four thread-local storage addressing models, and how the run-time
7977 is expected to function.
7978
7979 @menu
7980 * C99 Thread-Local Edits::
7981 * C++98 Thread-Local Edits::
7982 @end menu
7983
7984 @node C99 Thread-Local Edits
7985 @subsection ISO/IEC 9899:1999 Edits for Thread-Local Storage
7986
7987 The following are a set of changes to ISO/IEC 9899:1999 (aka C99)
7988 that document the exact semantics of the language extension.
7989
7990 @itemize @bullet
7991 @item
7992 @cite{5.1.2  Execution environments}
7993
7994 Add new text after paragraph 1
7995
7996 @quotation
7997 Within either execution environment, a @dfn{thread} is a flow of
7998 control within a program.  It is implementation defined whether
7999 or not there may be more than one thread associated with a program.
8000 It is implementation defined how threads beyond the first are
8001 created, the name and type of the function called at thread
8002 startup, and how threads may be terminated.  However, objects
8003 with thread storage duration shall be initialized before thread
8004 startup.
8005 @end quotation
8006
8007 @item
8008 @cite{6.2.4  Storage durations of objects}
8009
8010 Add new text before paragraph 3
8011
8012 @quotation
8013 An object whose identifier is declared with the storage-class
8014 specifier @w{@code{__thread}} has @dfn{thread storage duration}.
8015 Its lifetime is the entire execution of the thread, and its
8016 stored value is initialized only once, prior to thread startup.
8017 @end quotation
8018
8019 @item
8020 @cite{6.4.1  Keywords}
8021
8022 Add @code{__thread}.
8023
8024 @item
8025 @cite{6.7.1  Storage-class specifiers}
8026
8027 Add @code{__thread} to the list of storage class specifiers in
8028 paragraph 1.
8029
8030 Change paragraph 2 to
8031
8032 @quotation
8033 With the exception of @code{__thread}, at most one storage-class
8034 specifier may be given [@dots{}].  The @code{__thread} specifier may
8035 be used alone, or immediately following @code{extern} or
8036 @code{static}.
8037 @end quotation
8038
8039 Add new text after paragraph 6
8040
8041 @quotation
8042 The declaration of an identifier for a variable that has
8043 block scope that specifies @code{__thread} shall also
8044 specify either @code{extern} or @code{static}.
8045
8046 The @code{__thread} specifier shall be used only with
8047 variables.
8048 @end quotation
8049 @end itemize
8050
8051 @node C++98 Thread-Local Edits
8052 @subsection ISO/IEC 14882:1998 Edits for Thread-Local Storage
8053
8054 The following are a set of changes to ISO/IEC 14882:1998 (aka C++98)
8055 that document the exact semantics of the language extension.
8056
8057 @itemize @bullet
8058 @item
8059 @b{[intro.execution]}
8060
8061 New text after paragraph 4
8062
8063 @quotation
8064 A @dfn{thread} is a flow of control within the abstract machine.
8065 It is implementation defined whether or not there may be more than
8066 one thread.
8067 @end quotation
8068
8069 New text after paragraph 7
8070
8071 @quotation
8072 It is unspecified whether additional action must be taken to
8073 ensure when and whether side effects are visible to other threads.
8074 @end quotation
8075
8076 @item
8077 @b{[lex.key]}
8078
8079 Add @code{__thread}.
8080
8081 @item
8082 @b{[basic.start.main]}
8083
8084 Add after paragraph 5
8085
8086 @quotation
8087 The thread that begins execution at the @code{main} function is called
8088 the @dfn{main thread}.  It is implementation defined how functions
8089 beginning threads other than the main thread are designated or typed.
8090 A function so designated, as well as the @code{main} function, is called
8091 a @dfn{thread startup function}.  It is implementation defined what
8092 happens if a thread startup function returns.  It is implementation
8093 defined what happens to other threads when any thread calls @code{exit}.
8094 @end quotation
8095
8096 @item
8097 @b{[basic.start.init]}
8098
8099 Add after paragraph 4
8100
8101 @quotation
8102 The storage for an object of thread storage duration shall be
8103 statically initialized before the first statement of the thread startup
8104 function.  An object of thread storage duration shall not require
8105 dynamic initialization.
8106 @end quotation
8107
8108 @item
8109 @b{[basic.start.term]}
8110
8111 Add after paragraph 3
8112
8113 @quotation
8114 The type of an object with thread storage duration shall not have a
8115 non-trivial destructor, nor shall it be an array type whose elements
8116 (directly or indirectly) have non-trivial destructors.
8117 @end quotation
8118
8119 @item
8120 @b{[basic.stc]}
8121
8122 Add ``thread storage duration'' to the list in paragraph 1.
8123
8124 Change paragraph 2
8125
8126 @quotation
8127 Thread, static, and automatic storage durations are associated with
8128 objects introduced by declarations [@dots{}].
8129 @end quotation
8130
8131 Add @code{__thread} to the list of specifiers in paragraph 3.
8132
8133 @item
8134 @b{[basic.stc.thread]}
8135
8136 New section before @b{[basic.stc.static]}
8137
8138 @quotation
8139 The keyword @code{__thread} applied to a non-local object gives the
8140 object thread storage duration.
8141
8142 A local variable or class data member declared both @code{static}
8143 and @code{__thread} gives the variable or member thread storage
8144 duration.
8145 @end quotation
8146
8147 @item
8148 @b{[basic.stc.static]}
8149
8150 Change paragraph 1
8151
8152 @quotation
8153 All objects which have neither thread storage duration, dynamic
8154 storage duration nor are local [@dots{}].
8155 @end quotation
8156
8157 @item
8158 @b{[dcl.stc]}
8159
8160 Add @code{__thread} to the list in paragraph 1.
8161
8162 Change paragraph 1
8163
8164 @quotation
8165 With the exception of @code{__thread}, at most one
8166 @var{storage-class-specifier} shall appear in a given
8167 @var{decl-specifier-seq}.  The @code{__thread} specifier may
8168 be used alone, or immediately following the @code{extern} or
8169 @code{static} specifiers.  [@dots{}]
8170 @end quotation
8171
8172 Add after paragraph 5
8173
8174 @quotation
8175 The @code{__thread} specifier can be applied only to the names of objects
8176 and to anonymous unions.
8177 @end quotation
8178
8179 @item
8180 @b{[class.mem]}
8181
8182 Add after paragraph 6
8183
8184 @quotation
8185 Non-@code{static} members shall not be @code{__thread}.
8186 @end quotation
8187 @end itemize
8188
8189 @node C++ Extensions
8190 @chapter Extensions to the C++ Language
8191 @cindex extensions, C++ language
8192 @cindex C++ language extensions
8193
8194 The GNU compiler provides these extensions to the C++ language (and you
8195 can also use most of the C language extensions in your C++ programs).  If you
8196 want to write code that checks whether these features are available, you can
8197 test for the GNU compiler the same way as for C programs: check for a
8198 predefined macro @code{__GNUC__}.  You can also use @code{__GNUG__} to
8199 test specifically for GNU C++ (@pxref{Common Predefined Macros,,
8200 Predefined Macros,cpp,The GNU C Preprocessor}).
8201
8202 @menu
8203 * Min and Max::         C++ Minimum and maximum operators.
8204 * Volatiles::           What constitutes an access to a volatile object.
8205 * Restricted Pointers:: C99 restricted pointers and references.
8206 * Vague Linkage::       Where G++ puts inlines, vtables and such.
8207 * C++ Interface::       You can use a single C++ header file for both
8208                         declarations and definitions.
8209 * Template Instantiation:: Methods for ensuring that exactly one copy of
8210                         each needed template instantiation is emitted.
8211 * Bound member functions:: You can extract a function pointer to the
8212                         method denoted by a @samp{->*} or @samp{.*} expression.
8213 * C++ Attributes::      Variable, function, and type attributes for C++ only.
8214 * Strong Using::      Strong using-directives for namespace composition.
8215 * Java Exceptions::     Tweaking exception handling to work with Java.
8216 * Deprecated Features:: Things will disappear from g++.
8217 * Backwards Compatibility:: Compatibilities with earlier definitions of C++.
8218 @end menu
8219
8220 @node Min and Max
8221 @section Minimum and Maximum Operators in C++
8222
8223 It is very convenient to have operators which return the ``minimum'' or the
8224 ``maximum'' of two arguments.  In GNU C++ (but not in GNU C),
8225
8226 @table @code
8227 @item @var{a} <? @var{b}
8228 @findex <?
8229 @cindex minimum operator
8230 is the @dfn{minimum}, returning the smaller of the numeric values
8231 @var{a} and @var{b};
8232
8233 @item @var{a} >? @var{b}
8234 @findex >?
8235 @cindex maximum operator
8236 is the @dfn{maximum}, returning the larger of the numeric values @var{a}
8237 and @var{b}.
8238 @end table
8239
8240 These operations are not primitive in ordinary C++, since you can
8241 use a macro to return the minimum of two things in C++, as in the
8242 following example.
8243
8244 @smallexample
8245 #define MIN(X,Y) ((X) < (Y) ? : (X) : (Y))
8246 @end smallexample
8247
8248 @noindent
8249 You might then use @w{@samp{int min = MIN (i, j);}} to set @var{min} to
8250 the minimum value of variables @var{i} and @var{j}.
8251
8252 However, side effects in @code{X} or @code{Y} may cause unintended
8253 behavior.  For example, @code{MIN (i++, j++)} will fail, incrementing
8254 the smaller counter twice.  The GNU C @code{typeof} extension allows you
8255 to write safe macros that avoid this kind of problem (@pxref{Typeof}).
8256 However, writing @code{MIN} and @code{MAX} as macros also forces you to
8257 use function-call notation for a fundamental arithmetic operation.
8258 Using GNU C++ extensions, you can write @w{@samp{int min = i <? j;}}
8259 instead.
8260
8261 Since @code{<?} and @code{>?} are built into the compiler, they properly
8262 handle expressions with side-effects;  @w{@samp{int min = i++ <? j++;}}
8263 works correctly.
8264
8265 @node Volatiles
8266 @section When is a Volatile Object Accessed?
8267 @cindex accessing volatiles
8268 @cindex volatile read
8269 @cindex volatile write
8270 @cindex volatile access
8271
8272 Both the C and C++ standard have the concept of volatile objects.  These
8273 are normally accessed by pointers and used for accessing hardware.  The
8274 standards encourage compilers to refrain from optimizations
8275 concerning accesses to volatile objects that it might perform on
8276 non-volatile objects.  The C standard leaves it implementation defined
8277 as to what constitutes a volatile access.  The C++ standard omits to
8278 specify this, except to say that C++ should behave in a similar manner
8279 to C with respect to volatiles, where possible.  The minimum either
8280 standard specifies is that at a sequence point all previous accesses to
8281 volatile objects have stabilized and no subsequent accesses have
8282 occurred.  Thus an implementation is free to reorder and combine
8283 volatile accesses which occur between sequence points, but cannot do so
8284 for accesses across a sequence point.  The use of volatiles does not
8285 allow you to violate the restriction on updating objects multiple times
8286 within a sequence point.
8287
8288 In most expressions, it is intuitively obvious what is a read and what is
8289 a write.  For instance
8290
8291 @smallexample
8292 volatile int *dst = @var{somevalue};
8293 volatile int *src = @var{someothervalue};
8294 *dst = *src;
8295 @end smallexample
8296
8297 @noindent
8298 will cause a read of the volatile object pointed to by @var{src} and stores the
8299 value into the volatile object pointed to by @var{dst}.  There is no
8300 guarantee that these reads and writes are atomic, especially for objects
8301 larger than @code{int}.
8302
8303 Less obvious expressions are where something which looks like an access
8304 is used in a void context.  An example would be,
8305
8306 @smallexample
8307 volatile int *src = @var{somevalue};
8308 *src;
8309 @end smallexample
8310
8311 With C, such expressions are rvalues, and as rvalues cause a read of
8312 the object, GCC interprets this as a read of the volatile being pointed
8313 to.  The C++ standard specifies that such expressions do not undergo
8314 lvalue to rvalue conversion, and that the type of the dereferenced
8315 object may be incomplete.  The C++ standard does not specify explicitly
8316 that it is this lvalue to rvalue conversion which is responsible for
8317 causing an access.  However, there is reason to believe that it is,
8318 because otherwise certain simple expressions become undefined.  However,
8319 because it would surprise most programmers, G++ treats dereferencing a
8320 pointer to volatile object of complete type in a void context as a read
8321 of the object.  When the object has incomplete type, G++ issues a
8322 warning.
8323
8324 @smallexample
8325 struct S;
8326 struct T @{int m;@};
8327 volatile S *ptr1 = @var{somevalue};
8328 volatile T *ptr2 = @var{somevalue};
8329 *ptr1;
8330 *ptr2;
8331 @end smallexample
8332
8333 In this example, a warning is issued for @code{*ptr1}, and @code{*ptr2}
8334 causes a read of the object pointed to.  If you wish to force an error on
8335 the first case, you must force a conversion to rvalue with, for instance
8336 a static cast, @code{static_cast<S>(*ptr1)}.
8337
8338 When using a reference to volatile, G++ does not treat equivalent
8339 expressions as accesses to volatiles, but instead issues a warning that
8340 no volatile is accessed.  The rationale for this is that otherwise it
8341 becomes difficult to determine where volatile access occur, and not
8342 possible to ignore the return value from functions returning volatile
8343 references.  Again, if you wish to force a read, cast the reference to
8344 an rvalue.
8345
8346 @node Restricted Pointers
8347 @section Restricting Pointer Aliasing
8348 @cindex restricted pointers
8349 @cindex restricted references
8350 @cindex restricted this pointer
8351
8352 As with the C front end, G++ understands the C99 feature of restricted pointers,
8353 specified with the @code{__restrict__}, or @code{__restrict} type
8354 qualifier.  Because you cannot compile C++ by specifying the @option{-std=c99}
8355 language flag, @code{restrict} is not a keyword in C++.
8356
8357 In addition to allowing restricted pointers, you can specify restricted
8358 references, which indicate that the reference is not aliased in the local
8359 context.
8360
8361 @smallexample
8362 void fn (int *__restrict__ rptr, int &__restrict__ rref)
8363 @{
8364   /* @r{@dots{}} */
8365 @}
8366 @end smallexample
8367
8368 @noindent
8369 In the body of @code{fn}, @var{rptr} points to an unaliased integer and
8370 @var{rref} refers to a (different) unaliased integer.
8371
8372 You may also specify whether a member function's @var{this} pointer is
8373 unaliased by using @code{__restrict__} as a member function qualifier.
8374
8375 @smallexample
8376 void T::fn () __restrict__
8377 @{
8378   /* @r{@dots{}} */
8379 @}
8380 @end smallexample
8381
8382 @noindent
8383 Within the body of @code{T::fn}, @var{this} will have the effective
8384 definition @code{T *__restrict__ const this}.  Notice that the
8385 interpretation of a @code{__restrict__} member function qualifier is
8386 different to that of @code{const} or @code{volatile} qualifier, in that it
8387 is applied to the pointer rather than the object.  This is consistent with
8388 other compilers which implement restricted pointers.
8389
8390 As with all outermost parameter qualifiers, @code{__restrict__} is
8391 ignored in function definition matching.  This means you only need to
8392 specify @code{__restrict__} in a function definition, rather than
8393 in a function prototype as well.
8394
8395 @node Vague Linkage
8396 @section Vague Linkage
8397 @cindex vague linkage
8398
8399 There are several constructs in C++ which require space in the object
8400 file but are not clearly tied to a single translation unit.  We say that
8401 these constructs have ``vague linkage''.  Typically such constructs are
8402 emitted wherever they are needed, though sometimes we can be more
8403 clever.
8404
8405 @table @asis
8406 @item Inline Functions
8407 Inline functions are typically defined in a header file which can be
8408 included in many different compilations.  Hopefully they can usually be
8409 inlined, but sometimes an out-of-line copy is necessary, if the address
8410 of the function is taken or if inlining fails.  In general, we emit an
8411 out-of-line copy in all translation units where one is needed.  As an
8412 exception, we only emit inline virtual functions with the vtable, since
8413 it will always require a copy.
8414
8415 Local static variables and string constants used in an inline function
8416 are also considered to have vague linkage, since they must be shared
8417 between all inlined and out-of-line instances of the function.
8418
8419 @item VTables
8420 @cindex vtable
8421 C++ virtual functions are implemented in most compilers using a lookup
8422 table, known as a vtable.  The vtable contains pointers to the virtual
8423 functions provided by a class, and each object of the class contains a
8424 pointer to its vtable (or vtables, in some multiple-inheritance
8425 situations).  If the class declares any non-inline, non-pure virtual
8426 functions, the first one is chosen as the ``key method'' for the class,
8427 and the vtable is only emitted in the translation unit where the key
8428 method is defined.
8429
8430 @emph{Note:} If the chosen key method is later defined as inline, the
8431 vtable will still be emitted in every translation unit which defines it.
8432 Make sure that any inline virtuals are declared inline in the class
8433 body, even if they are not defined there.
8434
8435 @item type_info objects
8436 @cindex type_info
8437 @cindex RTTI
8438 C++ requires information about types to be written out in order to
8439 implement @samp{dynamic_cast}, @samp{typeid} and exception handling.
8440 For polymorphic classes (classes with virtual functions), the type_info
8441 object is written out along with the vtable so that @samp{dynamic_cast}
8442 can determine the dynamic type of a class object at runtime.  For all
8443 other types, we write out the type_info object when it is used: when
8444 applying @samp{typeid} to an expression, throwing an object, or
8445 referring to a type in a catch clause or exception specification.
8446
8447 @item Template Instantiations
8448 Most everything in this section also applies to template instantiations,
8449 but there are other options as well.
8450 @xref{Template Instantiation,,Where's the Template?}.
8451
8452 @end table
8453
8454 When used with GNU ld version 2.8 or later on an ELF system such as
8455 GNU/Linux or Solaris 2, or on Microsoft Windows, duplicate copies of
8456 these constructs will be discarded at link time.  This is known as
8457 COMDAT support.
8458
8459 On targets that don't support COMDAT, but do support weak symbols, GCC
8460 will use them.  This way one copy will override all the others, but
8461 the unused copies will still take up space in the executable.
8462
8463 For targets which do not support either COMDAT or weak symbols,
8464 most entities with vague linkage will be emitted as local symbols to
8465 avoid duplicate definition errors from the linker.  This will not happen
8466 for local statics in inlines, however, as having multiple copies will
8467 almost certainly break things.
8468
8469 @xref{C++ Interface,,Declarations and Definitions in One Header}, for
8470 another way to control placement of these constructs.
8471
8472 @node C++ Interface
8473 @section #pragma interface and implementation
8474
8475 @cindex interface and implementation headers, C++
8476 @cindex C++ interface and implementation headers
8477 @cindex pragmas, interface and implementation
8478
8479 @code{#pragma interface} and @code{#pragma implementation} provide the
8480 user with a way of explicitly directing the compiler to emit entities
8481 with vague linkage (and debugging information) in a particular
8482 translation unit.
8483
8484 @emph{Note:} As of GCC 2.7.2, these @code{#pragma}s are not useful in
8485 most cases, because of COMDAT support and the ``key method'' heuristic
8486 mentioned in @ref{Vague Linkage}.  Using them can actually cause your
8487 program to grow due to unnecesary out-of-line copies of inline
8488 functions.  Currently (3.4) the only benefit of these
8489 @code{#pragma}s is reduced duplication of debugging information, and
8490 that should be addressed soon on DWARF 2 targets with the use of
8491 COMDAT groups.
8492
8493 @table @code
8494 @item #pragma interface
8495 @itemx #pragma interface "@var{subdir}/@var{objects}.h"
8496 @kindex #pragma interface
8497 Use this directive in @emph{header files} that define object classes, to save
8498 space in most of the object files that use those classes.  Normally,
8499 local copies of certain information (backup copies of inline member
8500 functions, debugging information, and the internal tables that implement
8501 virtual functions) must be kept in each object file that includes class
8502 definitions.  You can use this pragma to avoid such duplication.  When a
8503 header file containing @samp{#pragma interface} is included in a
8504 compilation, this auxiliary information will not be generated (unless
8505 the main input source file itself uses @samp{#pragma implementation}).
8506 Instead, the object files will contain references to be resolved at link
8507 time.
8508
8509 The second form of this directive is useful for the case where you have
8510 multiple headers with the same name in different directories.  If you
8511 use this form, you must specify the same string to @samp{#pragma
8512 implementation}.
8513
8514 @item #pragma implementation
8515 @itemx #pragma implementation "@var{objects}.h"
8516 @kindex #pragma implementation
8517 Use this pragma in a @emph{main input file}, when you want full output from
8518 included header files to be generated (and made globally visible).  The
8519 included header file, in turn, should use @samp{#pragma interface}.
8520 Backup copies of inline member functions, debugging information, and the
8521 internal tables used to implement virtual functions are all generated in
8522 implementation files.
8523
8524 @cindex implied @code{#pragma implementation}
8525 @cindex @code{#pragma implementation}, implied
8526 @cindex naming convention, implementation headers
8527 If you use @samp{#pragma implementation} with no argument, it applies to
8528 an include file with the same basename@footnote{A file's @dfn{basename}
8529 was the name stripped of all leading path information and of trailing
8530 suffixes, such as @samp{.h} or @samp{.C} or @samp{.cc}.} as your source
8531 file.  For example, in @file{allclass.cc}, giving just
8532 @samp{#pragma implementation}
8533 by itself is equivalent to @samp{#pragma implementation "allclass.h"}.
8534
8535 In versions of GNU C++ prior to 2.6.0 @file{allclass.h} was treated as
8536 an implementation file whenever you would include it from
8537 @file{allclass.cc} even if you never specified @samp{#pragma
8538 implementation}.  This was deemed to be more trouble than it was worth,
8539 however, and disabled.
8540
8541 Use the string argument if you want a single implementation file to
8542 include code from multiple header files.  (You must also use
8543 @samp{#include} to include the header file; @samp{#pragma
8544 implementation} only specifies how to use the file---it doesn't actually
8545 include it.)
8546
8547 There is no way to split up the contents of a single header file into
8548 multiple implementation files.
8549 @end table
8550
8551 @cindex inlining and C++ pragmas
8552 @cindex C++ pragmas, effect on inlining
8553 @cindex pragmas in C++, effect on inlining
8554 @samp{#pragma implementation} and @samp{#pragma interface} also have an
8555 effect on function inlining.
8556
8557 If you define a class in a header file marked with @samp{#pragma
8558 interface}, the effect on an inline function defined in that class is
8559 similar to an explicit @code{extern} declaration---the compiler emits
8560 no code at all to define an independent version of the function.  Its
8561 definition is used only for inlining with its callers.
8562
8563 @opindex fno-implement-inlines
8564 Conversely, when you include the same header file in a main source file
8565 that declares it as @samp{#pragma implementation}, the compiler emits
8566 code for the function itself; this defines a version of the function
8567 that can be found via pointers (or by callers compiled without
8568 inlining).  If all calls to the function can be inlined, you can avoid
8569 emitting the function by compiling with @option{-fno-implement-inlines}.
8570 If any calls were not inlined, you will get linker errors.
8571
8572 @node Template Instantiation
8573 @section Where's the Template?
8574 @cindex template instantiation
8575
8576 C++ templates are the first language feature to require more
8577 intelligence from the environment than one usually finds on a UNIX
8578 system.  Somehow the compiler and linker have to make sure that each
8579 template instance occurs exactly once in the executable if it is needed,
8580 and not at all otherwise.  There are two basic approaches to this
8581 problem, which are referred to as the Borland model and the Cfront model.
8582
8583 @table @asis
8584 @item Borland model
8585 Borland C++ solved the template instantiation problem by adding the code
8586 equivalent of common blocks to their linker; the compiler emits template
8587 instances in each translation unit that uses them, and the linker
8588 collapses them together.  The advantage of this model is that the linker
8589 only has to consider the object files themselves; there is no external
8590 complexity to worry about.  This disadvantage is that compilation time
8591 is increased because the template code is being compiled repeatedly.
8592 Code written for this model tends to include definitions of all
8593 templates in the header file, since they must be seen to be
8594 instantiated.
8595
8596 @item Cfront model
8597 The AT&T C++ translator, Cfront, solved the template instantiation
8598 problem by creating the notion of a template repository, an
8599 automatically maintained place where template instances are stored.  A
8600 more modern version of the repository works as follows: As individual
8601 object files are built, the compiler places any template definitions and
8602 instantiations encountered in the repository.  At link time, the link
8603 wrapper adds in the objects in the repository and compiles any needed
8604 instances that were not previously emitted.  The advantages of this
8605 model are more optimal compilation speed and the ability to use the
8606 system linker; to implement the Borland model a compiler vendor also
8607 needs to replace the linker.  The disadvantages are vastly increased
8608 complexity, and thus potential for error; for some code this can be
8609 just as transparent, but in practice it can been very difficult to build
8610 multiple programs in one directory and one program in multiple
8611 directories.  Code written for this model tends to separate definitions
8612 of non-inline member templates into a separate file, which should be
8613 compiled separately.
8614 @end table
8615
8616 When used with GNU ld version 2.8 or later on an ELF system such as
8617 GNU/Linux or Solaris 2, or on Microsoft Windows, G++ supports the
8618 Borland model.  On other systems, G++ implements neither automatic
8619 model.
8620
8621 A future version of G++ will support a hybrid model whereby the compiler
8622 will emit any instantiations for which the template definition is
8623 included in the compile, and store template definitions and
8624 instantiation context information into the object file for the rest.
8625 The link wrapper will extract that information as necessary and invoke
8626 the compiler to produce the remaining instantiations.  The linker will
8627 then combine duplicate instantiations.
8628
8629 In the mean time, you have the following options for dealing with
8630 template instantiations:
8631
8632 @enumerate
8633 @item
8634 @opindex frepo
8635 Compile your template-using code with @option{-frepo}.  The compiler will
8636 generate files with the extension @samp{.rpo} listing all of the
8637 template instantiations used in the corresponding object files which
8638 could be instantiated there; the link wrapper, @samp{collect2}, will
8639 then update the @samp{.rpo} files to tell the compiler where to place
8640 those instantiations and rebuild any affected object files.  The
8641 link-time overhead is negligible after the first pass, as the compiler
8642 will continue to place the instantiations in the same files.
8643
8644 This is your best option for application code written for the Borland
8645 model, as it will just work.  Code written for the Cfront model will
8646 need to be modified so that the template definitions are available at
8647 one or more points of instantiation; usually this is as simple as adding
8648 @code{#include <tmethods.cc>} to the end of each template header.
8649
8650 For library code, if you want the library to provide all of the template
8651 instantiations it needs, just try to link all of its object files
8652 together; the link will fail, but cause the instantiations to be
8653 generated as a side effect.  Be warned, however, that this may cause
8654 conflicts if multiple libraries try to provide the same instantiations.
8655 For greater control, use explicit instantiation as described in the next
8656 option.
8657
8658 @item
8659 @opindex fno-implicit-templates
8660 Compile your code with @option{-fno-implicit-templates} to disable the
8661 implicit generation of template instances, and explicitly instantiate
8662 all the ones you use.  This approach requires more knowledge of exactly
8663 which instances you need than do the others, but it's less
8664 mysterious and allows greater control.  You can scatter the explicit
8665 instantiations throughout your program, perhaps putting them in the
8666 translation units where the instances are used or the translation units
8667 that define the templates themselves; you can put all of the explicit
8668 instantiations you need into one big file; or you can create small files
8669 like
8670
8671 @smallexample
8672 #include "Foo.h"
8673 #include "Foo.cc"
8674
8675 template class Foo<int>;
8676 template ostream& operator <<
8677                 (ostream&, const Foo<int>&);
8678 @end smallexample
8679
8680 for each of the instances you need, and create a template instantiation
8681 library from those.
8682
8683 If you are using Cfront-model code, you can probably get away with not
8684 using @option{-fno-implicit-templates} when compiling files that don't
8685 @samp{#include} the member template definitions.
8686
8687 If you use one big file to do the instantiations, you may want to
8688 compile it without @option{-fno-implicit-templates} so you get all of the
8689 instances required by your explicit instantiations (but not by any
8690 other files) without having to specify them as well.
8691
8692 G++ has extended the template instantiation syntax given in the ISO
8693 standard to allow forward declaration of explicit instantiations
8694 (with @code{extern}), instantiation of the compiler support data for a
8695 template class (i.e.@: the vtable) without instantiating any of its
8696 members (with @code{inline}), and instantiation of only the static data
8697 members of a template class, without the support data or member
8698 functions (with (@code{static}):
8699
8700 @smallexample
8701 extern template int max (int, int);
8702 inline template class Foo<int>;
8703 static template class Foo<int>;
8704 @end smallexample
8705
8706 @item
8707 Do nothing.  Pretend G++ does implement automatic instantiation
8708 management.  Code written for the Borland model will work fine, but
8709 each translation unit will contain instances of each of the templates it
8710 uses.  In a large program, this can lead to an unacceptable amount of code
8711 duplication.
8712 @end enumerate
8713
8714 @node Bound member functions
8715 @section Extracting the function pointer from a bound pointer to member function
8716 @cindex pmf
8717 @cindex pointer to member function
8718 @cindex bound pointer to member function
8719
8720 In C++, pointer to member functions (PMFs) are implemented using a wide
8721 pointer of sorts to handle all the possible call mechanisms; the PMF
8722 needs to store information about how to adjust the @samp{this} pointer,
8723 and if the function pointed to is virtual, where to find the vtable, and
8724 where in the vtable to look for the member function.  If you are using
8725 PMFs in an inner loop, you should really reconsider that decision.  If
8726 that is not an option, you can extract the pointer to the function that
8727 would be called for a given object/PMF pair and call it directly inside
8728 the inner loop, to save a bit of time.
8729
8730 Note that you will still be paying the penalty for the call through a
8731 function pointer; on most modern architectures, such a call defeats the
8732 branch prediction features of the CPU@.  This is also true of normal
8733 virtual function calls.
8734
8735 The syntax for this extension is
8736
8737 @smallexample
8738 extern A a;
8739 extern int (A::*fp)();
8740 typedef int (*fptr)(A *);
8741
8742 fptr p = (fptr)(a.*fp);
8743 @end smallexample
8744
8745 For PMF constants (i.e.@: expressions of the form @samp{&Klasse::Member}),
8746 no object is needed to obtain the address of the function.  They can be
8747 converted to function pointers directly:
8748
8749 @smallexample
8750 fptr p1 = (fptr)(&A::foo);
8751 @end smallexample
8752
8753 @opindex Wno-pmf-conversions
8754 You must specify @option{-Wno-pmf-conversions} to use this extension.
8755
8756 @node C++ Attributes
8757 @section C++-Specific Variable, Function, and Type Attributes
8758
8759 Some attributes only make sense for C++ programs.
8760
8761 @table @code
8762 @item init_priority (@var{priority})
8763 @cindex init_priority attribute
8764
8765
8766 In Standard C++, objects defined at namespace scope are guaranteed to be
8767 initialized in an order in strict accordance with that of their definitions
8768 @emph{in a given translation unit}.  No guarantee is made for initializations
8769 across translation units.  However, GNU C++ allows users to control the
8770 order of initialization of objects defined at namespace scope with the
8771 @code{init_priority} attribute by specifying a relative @var{priority},
8772 a constant integral expression currently bounded between 101 and 65535
8773 inclusive.  Lower numbers indicate a higher priority.
8774
8775 In the following example, @code{A} would normally be created before
8776 @code{B}, but the @code{init_priority} attribute has reversed that order:
8777
8778 @smallexample
8779 Some_Class  A  __attribute__ ((init_priority (2000)));
8780 Some_Class  B  __attribute__ ((init_priority (543)));
8781 @end smallexample
8782
8783 @noindent
8784 Note that the particular values of @var{priority} do not matter; only their
8785 relative ordering.
8786
8787 @item java_interface
8788 @cindex java_interface attribute
8789
8790 This type attribute informs C++ that the class is a Java interface.  It may
8791 only be applied to classes declared within an @code{extern "Java"} block.
8792 Calls to methods declared in this interface will be dispatched using GCJ's
8793 interface table mechanism, instead of regular virtual table dispatch.
8794
8795 @end table
8796
8797 See also @xref{Strong Using}.
8798
8799 @node Strong Using
8800 @section Strong Using
8801
8802 @strong{Caution:} The semantics of this extension are not fully
8803 defined.  Users should refrain from using this extension as its
8804 semantics may change subtly over time.  It is possible that this
8805 extension wil be removed in future versions of G++.
8806
8807 A using-directive with @code{__attribute ((strong))} is stronger
8808 than a normal using-directive in two ways:
8809
8810 @itemize @bullet
8811 @item
8812 Templates from the used namespace can be specialized as though they were members of the using namespace.
8813
8814 @item
8815 The using namespace is considered an associated namespace of all
8816 templates in the used namespace for purposes of argument-dependent
8817 name lookup.
8818 @end itemize
8819
8820 This is useful for composing a namespace transparently from
8821 implementation namespaces.  For example:
8822
8823 @smallexample
8824 namespace std @{
8825   namespace debug @{
8826     template <class T> struct A @{ @};
8827   @}
8828   using namespace debug __attribute ((__strong__));
8829   template <> struct A<int> @{ @};   // ok to specialize
8830
8831   template <class T> void f (A<T>);
8832 @}
8833
8834 int main()
8835 @{
8836   f (std::A<float>());             // lookup finds std::f
8837   f (std::A<int>());
8838 @}
8839 @end smallexample
8840
8841 @node Java Exceptions
8842 @section Java Exceptions
8843
8844 The Java language uses a slightly different exception handling model
8845 from C++.  Normally, GNU C++ will automatically detect when you are
8846 writing C++ code that uses Java exceptions, and handle them
8847 appropriately.  However, if C++ code only needs to execute destructors
8848 when Java exceptions are thrown through it, GCC will guess incorrectly.
8849 Sample problematic code is:
8850
8851 @smallexample
8852   struct S @{ ~S(); @};
8853   extern void bar();    // is written in Java, and may throw exceptions
8854   void foo()
8855   @{
8856     S s;
8857     bar();
8858   @}
8859 @end smallexample
8860
8861 @noindent
8862 The usual effect of an incorrect guess is a link failure, complaining of
8863 a missing routine called @samp{__gxx_personality_v0}.
8864
8865 You can inform the compiler that Java exceptions are to be used in a
8866 translation unit, irrespective of what it might think, by writing
8867 @samp{@w{#pragma GCC java_exceptions}} at the head of the file.  This
8868 @samp{#pragma} must appear before any functions that throw or catch
8869 exceptions, or run destructors when exceptions are thrown through them.
8870
8871 You cannot mix Java and C++ exceptions in the same translation unit.  It
8872 is believed to be safe to throw a C++ exception from one file through
8873 another file compiled for the Java exception model, or vice versa, but
8874 there may be bugs in this area.
8875
8876 @node Deprecated Features
8877 @section Deprecated Features
8878
8879 In the past, the GNU C++ compiler was extended to experiment with new
8880 features, at a time when the C++ language was still evolving.  Now that
8881 the C++ standard is complete, some of those features are superseded by
8882 superior alternatives.  Using the old features might cause a warning in
8883 some cases that the feature will be dropped in the future.  In other
8884 cases, the feature might be gone already.
8885
8886 While the list below is not exhaustive, it documents some of the options
8887 that are now deprecated:
8888
8889 @table @code
8890 @item -fexternal-templates
8891 @itemx -falt-external-templates
8892 These are two of the many ways for G++ to implement template
8893 instantiation.  @xref{Template Instantiation}.  The C++ standard clearly
8894 defines how template definitions have to be organized across
8895 implementation units.  G++ has an implicit instantiation mechanism that
8896 should work just fine for standard-conforming code.
8897
8898 @item -fstrict-prototype
8899 @itemx -fno-strict-prototype
8900 Previously it was possible to use an empty prototype parameter list to
8901 indicate an unspecified number of parameters (like C), rather than no
8902 parameters, as C++ demands.  This feature has been removed, except where
8903 it is required for backwards compatibility @xref{Backwards Compatibility}.
8904 @end table
8905
8906 The named return value extension has been deprecated, and is now
8907 removed from G++.
8908
8909 The use of initializer lists with new expressions has been deprecated,
8910 and is now removed from G++.
8911
8912 Floating and complex non-type template parameters have been deprecated,
8913 and are now removed from G++.
8914
8915 The implicit typename extension has been deprecated and is now
8916 removed from G++.
8917
8918 The use of default arguments in function pointers, function typedefs and
8919 and other places where they are not permitted by the standard is
8920 deprecated and will be removed from a future version of G++.
8921
8922 @node Backwards Compatibility
8923 @section Backwards Compatibility
8924 @cindex Backwards Compatibility
8925 @cindex ARM [Annotated C++ Reference Manual]
8926
8927 Now that there is a definitive ISO standard C++, G++ has a specification
8928 to adhere to.  The C++ language evolved over time, and features that
8929 used to be acceptable in previous drafts of the standard, such as the ARM
8930 [Annotated C++ Reference Manual], are no longer accepted.  In order to allow
8931 compilation of C++ written to such drafts, G++ contains some backwards
8932 compatibilities.  @emph{All such backwards compatibility features are
8933 liable to disappear in future versions of G++.} They should be considered
8934 deprecated @xref{Deprecated Features}.
8935
8936 @table @code
8937 @item For scope
8938 If a variable is declared at for scope, it used to remain in scope until
8939 the end of the scope which contained the for statement (rather than just
8940 within the for scope).  G++ retains this, but issues a warning, if such a
8941 variable is accessed outside the for scope.
8942
8943 @item Implicit C language
8944 Old C system header files did not contain an @code{extern "C" @{@dots{}@}}
8945 scope to set the language.  On such systems, all header files are
8946 implicitly scoped inside a C language scope.  Also, an empty prototype
8947 @code{()} will be treated as an unspecified number of arguments, rather
8948 than no arguments, as C++ demands.
8949 @end table