re PR c/16833 (-fno-builtin prevents automatic format checks for standard functions)
[gcc.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 @opindex fno-builtin
1768 The @code{format} attribute allows you to identify your own functions
1769 which take format strings as arguments, so that GCC can check the
1770 calls to these functions for errors. The compiler always (unless
1771 @option{-ffreestanding} or @option{-fno-builtin} is used) checks formats
1772 for the standard library functions @code{printf}, @code{fprintf},
1773 @code{sprintf}, @code{scanf}, @code{fscanf}, @code{sscanf}, @code{strftime},
1774 @code{vprintf}, @code{vfprintf} and @code{vsprintf} whenever such
1775 warnings are requested (using @option{-Wformat}), so there is no need to
1776 modify the header file @file{stdio.h}. In C99 mode, the functions
1777 @code{snprintf}, @code{vsnprintf}, @code{vscanf}, @code{vfscanf} and
1778 @code{vsscanf} are also checked. Except in strictly conforming C
1779 standard modes, the X/Open function @code{strfmon} is also checked as
1780 are @code{printf_unlocked} and @code{fprintf_unlocked}.
1781 @xref{C Dialect Options,,Options Controlling C Dialect}.
1782
1783 The target may provide additional types of format checks.
1784 @xref{Target Format Checks,,Format Checks Specific to Particular
1785 Target Machines}.
1786
1787 @item format_arg (@var{string-index})
1788 @cindex @code{format_arg} function attribute
1789 @opindex Wformat-nonliteral
1790 The @code{format_arg} attribute specifies that a function takes a format
1791 string for a @code{printf}, @code{scanf}, @code{strftime} or
1792 @code{strfmon} style function and modifies it (for example, to translate
1793 it into another language), so the result can be passed to a
1794 @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style
1795 function (with the remaining arguments to the format function the same
1796 as they would have been for the unmodified string). For example, the
1797 declaration:
1798
1799 @smallexample
1800 extern char *
1801 my_dgettext (char *my_domain, const char *my_format)
1802 __attribute__ ((format_arg (2)));
1803 @end smallexample
1804
1805 @noindent
1806 causes the compiler to check the arguments in calls to a @code{printf},
1807 @code{scanf}, @code{strftime} or @code{strfmon} type function, whose
1808 format string argument is a call to the @code{my_dgettext} function, for
1809 consistency with the format string argument @code{my_format}. If the
1810 @code{format_arg} attribute had not been specified, all the compiler
1811 could tell in such calls to format functions would be that the format
1812 string argument is not constant; this would generate a warning when
1813 @option{-Wformat-nonliteral} is used, but the calls could not be checked
1814 without the attribute.
1815
1816 The parameter @var{string-index} specifies which argument is the format
1817 string argument (starting from one). Since non-static C++ methods have
1818 an implicit @code{this} argument, the arguments of such methods should
1819 be counted from two.
1820
1821 The @code{format-arg} attribute allows you to identify your own
1822 functions which modify format strings, so that GCC can check the
1823 calls to @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon}
1824 type function whose operands are a call to one of your own function.
1825 The compiler always treats @code{gettext}, @code{dgettext}, and
1826 @code{dcgettext} in this manner except when strict ISO C support is
1827 requested by @option{-ansi} or an appropriate @option{-std} option, or
1828 @option{-ffreestanding} or @option{-fno-builtin}
1829 is used. @xref{C Dialect Options,,Options
1830 Controlling C Dialect}.
1831
1832 @item function_vector
1833 @cindex calling functions through the function vector on the H8/300 processors
1834 Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
1835 function should be called through the function vector. Calling a
1836 function through the function vector will reduce code size, however;
1837 the function vector has a limited size (maximum 128 entries on the H8/300
1838 and 64 entries on the H8/300H and H8S) and shares space with the interrupt vector.
1839
1840 You must use GAS and GLD from GNU binutils version 2.7 or later for
1841 this attribute to work correctly.
1842
1843 @item interrupt
1844 @cindex interrupt handler functions
1845 Use this attribute on the ARM, AVR, C4x, M32R/D and Xstormy16 ports to indicate
1846 that the specified function is an interrupt handler. The compiler will
1847 generate function entry and exit sequences suitable for use in an
1848 interrupt handler when this attribute is present.
1849
1850 Note, interrupt handlers for the m68k, H8/300, H8/300H, H8S, and SH processors
1851 can be specified via the @code{interrupt_handler} attribute.
1852
1853 Note, on the AVR, interrupts will be enabled inside the function.
1854
1855 Note, for the ARM, you can specify the kind of interrupt to be handled by
1856 adding an optional parameter to the interrupt attribute like this:
1857
1858 @smallexample
1859 void f () __attribute__ ((interrupt ("IRQ")));
1860 @end smallexample
1861
1862 Permissible values for this parameter are: IRQ, FIQ, SWI, ABORT and UNDEF@.
1863
1864 @item interrupt_handler
1865 @cindex interrupt handler functions on the m68k, H8/300 and SH processors
1866 Use this attribute on the m68k, H8/300, H8/300H, H8S, and SH to indicate that
1867 the specified function is an interrupt handler. The compiler will generate
1868 function entry and exit sequences suitable for use in an interrupt
1869 handler when this attribute is present.
1870
1871 @item long_call/short_call
1872 @cindex indirect calls on ARM
1873 This attribute specifies how a particular function is called on
1874 ARM@. Both attributes override the @option{-mlong-calls} (@pxref{ARM Options})
1875 command line switch and @code{#pragma long_calls} settings. The
1876 @code{long_call} attribute causes the compiler to always call the
1877 function by first loading its address into a register and then using the
1878 contents of that register. The @code{short_call} attribute always places
1879 the offset to the function from the call site into the @samp{BL}
1880 instruction directly.
1881
1882 @item longcall/shortcall
1883 @cindex functions called via pointer on the RS/6000 and PowerPC
1884 On the RS/6000 and PowerPC, the @code{longcall} attribute causes the
1885 compiler to always call this function via a pointer, just as it would if
1886 the @option{-mlongcall} option had been specified. The @code{shortcall}
1887 attribute causes the compiler not to do this. These attributes override
1888 both the @option{-mlongcall} switch and the @code{#pragma longcall}
1889 setting.
1890
1891 @xref{RS/6000 and PowerPC Options}, for more information on whether long
1892 calls are necessary.
1893
1894 @item malloc
1895 @cindex @code{malloc} attribute
1896 The @code{malloc} attribute is used to tell the compiler that a function
1897 may be treated as if any non-@code{NULL} pointer it returns cannot
1898 alias any other pointer valid when the function returns.
1899 This will often improve optimization.
1900 Standard functions with this property include @code{malloc} and
1901 @code{calloc}. @code{realloc}-like functions have this property as
1902 long as the old pointer is never referred to (including comparing it
1903 to the new pointer) after the function returns a non-@code{NULL}
1904 value.
1905
1906 @item model (@var{model-name})
1907 @cindex function addressability on the M32R/D
1908 @cindex variable addressability on the IA-64
1909
1910 On the M32R/D, use this attribute to set the addressability of an
1911 object, and of the code generated for a function. The identifier
1912 @var{model-name} is one of @code{small}, @code{medium}, or
1913 @code{large}, representing each of the code models.
1914
1915 Small model objects live in the lower 16MB of memory (so that their
1916 addresses can be loaded with the @code{ld24} instruction), and are
1917 callable with the @code{bl} instruction.
1918
1919 Medium model objects may live anywhere in the 32-bit address space (the
1920 compiler will generate @code{seth/add3} instructions to load their addresses),
1921 and are callable with the @code{bl} instruction.
1922
1923 Large model objects may live anywhere in the 32-bit address space (the
1924 compiler will generate @code{seth/add3} instructions to load their addresses),
1925 and may not be reachable with the @code{bl} instruction (the compiler will
1926 generate the much slower @code{seth/add3/jl} instruction sequence).
1927
1928 On IA-64, use this attribute to set the addressability of an object.
1929 At present, the only supported identifier for @var{model-name} is
1930 @code{small}, indicating addressability via ``small'' (22-bit)
1931 addresses (so that their addresses can be loaded with the @code{addl}
1932 instruction). Caveat: such addressing is by definition not position
1933 independent and hence this attribute must not be used for objects
1934 defined by shared libraries.
1935
1936 @item naked
1937 @cindex function without a prologue/epilogue code
1938 Use this attribute on the ARM, AVR, C4x and IP2K ports to indicate that the
1939 specified function does not need prologue/epilogue sequences generated by
1940 the compiler. It is up to the programmer to provide these sequences.
1941
1942 @item near
1943 @cindex functions which do not handle memory bank switching on 68HC11/68HC12
1944 On 68HC11 and 68HC12 the @code{near} attribute causes the compiler to
1945 use the normal calling convention based on @code{jsr} and @code{rts}.
1946 This attribute can be used to cancel the effect of the @option{-mlong-calls}
1947 option.
1948
1949 @item no_instrument_function
1950 @cindex @code{no_instrument_function} function attribute
1951 @opindex finstrument-functions
1952 If @option{-finstrument-functions} is given, profiling function calls will
1953 be generated at entry and exit of most user-compiled functions.
1954 Functions with this attribute will not be so instrumented.
1955
1956 @item noinline
1957 @cindex @code{noinline} function attribute
1958 This function attribute prevents a function from being considered for
1959 inlining.
1960
1961 @item nonnull (@var{arg-index}, @dots{})
1962 @cindex @code{nonnull} function attribute
1963 The @code{nonnull} attribute specifies that some function parameters should
1964 be non-null pointers. For instance, the declaration:
1965
1966 @smallexample
1967 extern void *
1968 my_memcpy (void *dest, const void *src, size_t len)
1969 __attribute__((nonnull (1, 2)));
1970 @end smallexample
1971
1972 @noindent
1973 causes the compiler to check that, in calls to @code{my_memcpy},
1974 arguments @var{dest} and @var{src} are non-null. If the compiler
1975 determines that a null pointer is passed in an argument slot marked
1976 as non-null, and the @option{-Wnonnull} option is enabled, a warning
1977 is issued. The compiler may also choose to make optimizations based
1978 on the knowledge that certain function arguments will not be null.
1979
1980 If no argument index list is given to the @code{nonnull} attribute,
1981 all pointer arguments are marked as non-null. To illustrate, the
1982 following declaration is equivalent to the previous example:
1983
1984 @smallexample
1985 extern void *
1986 my_memcpy (void *dest, const void *src, size_t len)
1987 __attribute__((nonnull));
1988 @end smallexample
1989
1990 @item noreturn
1991 @cindex @code{noreturn} function attribute
1992 A few standard library functions, such as @code{abort} and @code{exit},
1993 cannot return. GCC knows this automatically. Some programs define
1994 their own functions that never return. You can declare them
1995 @code{noreturn} to tell the compiler this fact. For example,
1996
1997 @smallexample
1998 @group
1999 void fatal () __attribute__ ((noreturn));
2000
2001 void
2002 fatal (/* @r{@dots{}} */)
2003 @{
2004 /* @r{@dots{}} */ /* @r{Print error message.} */ /* @r{@dots{}} */
2005 exit (1);
2006 @}
2007 @end group
2008 @end smallexample
2009
2010 The @code{noreturn} keyword tells the compiler to assume that
2011 @code{fatal} cannot return. It can then optimize without regard to what
2012 would happen if @code{fatal} ever did return. This makes slightly
2013 better code. More importantly, it helps avoid spurious warnings of
2014 uninitialized variables.
2015
2016 The @code{noreturn} keyword does not affect the exceptional path when that
2017 applies: a @code{noreturn}-marked function may still return to the caller
2018 by throwing an exception.
2019
2020 Do not assume that registers saved by the calling function are
2021 restored before calling the @code{noreturn} function.
2022
2023 It does not make sense for a @code{noreturn} function to have a return
2024 type other than @code{void}.
2025
2026 The attribute @code{noreturn} is not implemented in GCC versions
2027 earlier than 2.5. An alternative way to declare that a function does
2028 not return, which works in the current version and in some older
2029 versions, is as follows:
2030
2031 @smallexample
2032 typedef void voidfn ();
2033
2034 volatile voidfn fatal;
2035 @end smallexample
2036
2037 @item nothrow
2038 @cindex @code{nothrow} function attribute
2039 The @code{nothrow} attribute is used to inform the compiler that a
2040 function cannot throw an exception. For example, most functions in
2041 the standard C library can be guaranteed not to throw an exception
2042 with the notable exceptions of @code{qsort} and @code{bsearch} that
2043 take function pointer arguments. The @code{nothrow} attribute is not
2044 implemented in GCC versions earlier than 3.3.
2045
2046 @item pure
2047 @cindex @code{pure} function attribute
2048 Many functions have no effects except the return value and their
2049 return value depends only on the parameters and/or global variables.
2050 Such a function can be subject
2051 to common subexpression elimination and loop optimization just as an
2052 arithmetic operator would be. These functions should be declared
2053 with the attribute @code{pure}. For example,
2054
2055 @smallexample
2056 int square (int) __attribute__ ((pure));
2057 @end smallexample
2058
2059 @noindent
2060 says that the hypothetical function @code{square} is safe to call
2061 fewer times than the program says.
2062
2063 Some of common examples of pure functions are @code{strlen} or @code{memcmp}.
2064 Interesting non-pure functions are functions with infinite loops or those
2065 depending on volatile memory or other system resource, that may change between
2066 two consecutive calls (such as @code{feof} in a multithreading environment).
2067
2068 The attribute @code{pure} is not implemented in GCC versions earlier
2069 than 2.96.
2070
2071 @item regparm (@var{number})
2072 @cindex @code{regparm} attribute
2073 @cindex functions that are passed arguments in registers on the 386
2074 On the Intel 386, the @code{regparm} attribute causes the compiler to
2075 pass up to @var{number} integer arguments in registers EAX,
2076 EDX, and ECX instead of on the stack. Functions that take a
2077 variable number of arguments will continue to be passed all of their
2078 arguments on the stack.
2079
2080 Beware that on some ELF systems this attribute is unsuitable for
2081 global functions in shared libraries with lazy binding (which is the
2082 default). Lazy binding will send the first call via resolving code in
2083 the loader, which might assume EAX, EDX and ECX can be clobbered, as
2084 per the standard calling conventions. Solaris 8 is affected by this.
2085 GNU systems with GLIBC 2.1 or higher, and FreeBSD, are believed to be
2086 safe since the loaders there save all registers. (Lazy binding can be
2087 disabled with the linker or the loader if desired, to avoid the
2088 problem.)
2089
2090 @item saveall
2091 @cindex save all registers on the H8/300, H8/300H, and H8S
2092 Use this attribute on the H8/300, H8/300H, and H8S to indicate that
2093 all registers except the stack pointer should be saved in the prologue
2094 regardless of whether they are used or not.
2095
2096 @item section ("@var{section-name}")
2097 @cindex @code{section} function attribute
2098 Normally, the compiler places the code it generates in the @code{text} section.
2099 Sometimes, however, you need additional sections, or you need certain
2100 particular functions to appear in special sections. The @code{section}
2101 attribute specifies that a function lives in a particular section.
2102 For example, the declaration:
2103
2104 @smallexample
2105 extern void foobar (void) __attribute__ ((section ("bar")));
2106 @end smallexample
2107
2108 @noindent
2109 puts the function @code{foobar} in the @code{bar} section.
2110
2111 Some file formats do not support arbitrary sections so the @code{section}
2112 attribute is not available on all platforms.
2113 If you need to map the entire contents of a module to a particular
2114 section, consider using the facilities of the linker instead.
2115
2116 @item sentinel
2117 @cindex @code{sentinel} function attribute
2118 This function attribute ensures that a parameter in a function call is
2119 an explicit @code{NULL}. The attribute is only valid on variadic
2120 functions. By default, the sentinel is located at position zero, the
2121 last parameter of the function call. If an optional integer position
2122 argument P is supplied to the attribute, the sentinel must be located at
2123 position P counting backwards from the end of the argument list.
2124
2125 @smallexample
2126 __attribute__ ((sentinel))
2127 is equivalent to
2128 __attribute__ ((sentinel(0)))
2129 @end smallexample
2130
2131 The attribute is automatically set with a position of 0 for the built-in
2132 functions @code{execl} and @code{execlp}. The built-in function
2133 @code{execle} has the attribute set with a position of 1.
2134
2135 A valid @code{NULL} in this context is defined as zero with any pointer
2136 type. If your system defines the @code{NULL} macro with an integer type
2137 then you need to add an explicit cast. GCC replaces @code{stddef.h}
2138 with a copy that redefines NULL appropriately.
2139
2140 The warnings for missing or incorrect sentinels are enabled with
2141 @option{-Wformat}.
2142
2143 @item short_call
2144 See long_call/short_call.
2145
2146 @item shortcall
2147 See longcall/shortcall.
2148
2149 @item signal
2150 @cindex signal handler functions on the AVR processors
2151 Use this attribute on the AVR to indicate that the specified
2152 function is a signal handler. The compiler will generate function
2153 entry and exit sequences suitable for use in a signal handler when this
2154 attribute is present. Interrupts will be disabled inside the function.
2155
2156 @item sp_switch
2157 Use this attribute on the SH to indicate an @code{interrupt_handler}
2158 function should switch to an alternate stack. It expects a string
2159 argument that names a global variable holding the address of the
2160 alternate stack.
2161
2162 @smallexample
2163 void *alt_stack;
2164 void f () __attribute__ ((interrupt_handler,
2165 sp_switch ("alt_stack")));
2166 @end smallexample
2167
2168 @item stdcall
2169 @cindex functions that pop the argument stack on the 386
2170 On the Intel 386, the @code{stdcall} attribute causes the compiler to
2171 assume that the called function will pop off the stack space used to
2172 pass arguments, unless it takes a variable number of arguments.
2173
2174 @item tiny_data
2175 @cindex tiny data section on the H8/300H and H8S
2176 Use this attribute on the H8/300H and H8S to indicate that the specified
2177 variable should be placed into the tiny data section.
2178 The compiler will generate more efficient code for loads and stores
2179 on data in the tiny data section. Note the tiny data area is limited to
2180 slightly under 32kbytes of data.
2181
2182 @item trap_exit
2183 Use this attribute on the SH for an @code{interrupt_handler} to return using
2184 @code{trapa} instead of @code{rte}. This attribute expects an integer
2185 argument specifying the trap number to be used.
2186
2187 @item unused
2188 @cindex @code{unused} attribute.
2189 This attribute, attached to a function, means that the function is meant
2190 to be possibly unused. GCC will not produce a warning for this
2191 function.
2192
2193 @item used
2194 @cindex @code{used} attribute.
2195 This attribute, attached to a function, means that code must be emitted
2196 for the function even if it appears that the function is not referenced.
2197 This is useful, for example, when the function is referenced only in
2198 inline assembly.
2199
2200 @item visibility ("@var{visibility_type}")
2201 @cindex @code{visibility} attribute
2202 The @code{visibility} attribute on ELF targets causes the declaration
2203 to be emitted with default, hidden, protected or internal visibility.
2204
2205 @smallexample
2206 void __attribute__ ((visibility ("protected")))
2207 f () @{ /* @r{Do something.} */; @}
2208 int i __attribute__ ((visibility ("hidden")));
2209 @end smallexample
2210
2211 See the ELF gABI for complete details, but the short story is:
2212
2213 @table @dfn
2214 @c keep this list of visibilities in alphabetical order.
2215
2216 @item default
2217 Default visibility is the normal case for ELF. This value is
2218 available for the visibility attribute to override other options
2219 that may change the assumed visibility of symbols.
2220
2221 @item hidden
2222 Hidden visibility indicates that the symbol will not be placed into
2223 the dynamic symbol table, so no other @dfn{module} (executable or
2224 shared library) can reference it directly.
2225
2226 @item internal
2227 Internal visibility is like hidden visibility, but with additional
2228 processor specific semantics. Unless otherwise specified by the psABI,
2229 GCC defines internal visibility to mean that the function is @emph{never}
2230 called from another module. Note that hidden symbols, while they cannot
2231 be referenced directly by other modules, can be referenced indirectly via
2232 function pointers. By indicating that a symbol cannot be called from
2233 outside the module, GCC may for instance omit the load of a PIC register
2234 since it is known that the calling function loaded the correct value.
2235
2236 @item protected
2237 Protected visibility indicates that the symbol will be placed in the
2238 dynamic symbol table, but that references within the defining module
2239 will bind to the local symbol. That is, the symbol cannot be overridden
2240 by another module.
2241
2242 @end table
2243
2244 Not all ELF targets support this attribute.
2245
2246 @item warn_unused_result
2247 @cindex @code{warn_unused_result} attribute
2248 The @code{warn_unused_result} attribute causes a warning to be emitted
2249 if a caller of the function with this attribute does not use its
2250 return value. This is useful for functions where not checking
2251 the result is either a security problem or always a bug, such as
2252 @code{realloc}.
2253
2254 @smallexample
2255 int fn () __attribute__ ((warn_unused_result));
2256 int foo ()
2257 @{
2258 if (fn () < 0) return -1;
2259 fn ();
2260 return 0;
2261 @}
2262 @end smallexample
2263
2264 results in warning on line 5.
2265
2266 @item weak
2267 @cindex @code{weak} attribute
2268 The @code{weak} attribute causes the declaration to be emitted as a weak
2269 symbol rather than a global. This is primarily useful in defining
2270 library functions which can be overridden in user code, though it can
2271 also be used with non-function declarations. Weak symbols are supported
2272 for ELF targets, and also for a.out targets when using the GNU assembler
2273 and linker.
2274
2275 @end table
2276
2277 You can specify multiple attributes in a declaration by separating them
2278 by commas within the double parentheses or by immediately following an
2279 attribute declaration with another attribute declaration.
2280
2281 @cindex @code{#pragma}, reason for not using
2282 @cindex pragma, reason for not using
2283 Some people object to the @code{__attribute__} feature, suggesting that
2284 ISO C's @code{#pragma} should be used instead. At the time
2285 @code{__attribute__} was designed, there were two reasons for not doing
2286 this.
2287
2288 @enumerate
2289 @item
2290 It is impossible to generate @code{#pragma} commands from a macro.
2291
2292 @item
2293 There is no telling what the same @code{#pragma} might mean in another
2294 compiler.
2295 @end enumerate
2296
2297 These two reasons applied to almost any application that might have been
2298 proposed for @code{#pragma}. It was basically a mistake to use
2299 @code{#pragma} for @emph{anything}.
2300
2301 The ISO C99 standard includes @code{_Pragma}, which now allows pragmas
2302 to be generated from macros. In addition, a @code{#pragma GCC}
2303 namespace is now in use for GCC-specific pragmas. However, it has been
2304 found convenient to use @code{__attribute__} to achieve a natural
2305 attachment of attributes to their corresponding declarations, whereas
2306 @code{#pragma GCC} is of use for constructs that do not naturally form
2307 part of the grammar. @xref{Other Directives,,Miscellaneous
2308 Preprocessing Directives, cpp, The GNU C Preprocessor}.
2309
2310 @node Attribute Syntax
2311 @section Attribute Syntax
2312 @cindex attribute syntax
2313
2314 This section describes the syntax with which @code{__attribute__} may be
2315 used, and the constructs to which attribute specifiers bind, for the C
2316 language. Some details may vary for C++ and Objective-C@. Because of
2317 infelicities in the grammar for attributes, some forms described here
2318 may not be successfully parsed in all cases.
2319
2320 There are some problems with the semantics of attributes in C++. For
2321 example, there are no manglings for attributes, although they may affect
2322 code generation, so problems may arise when attributed types are used in
2323 conjunction with templates or overloading. Similarly, @code{typeid}
2324 does not distinguish between types with different attributes. Support
2325 for attributes in C++ may be restricted in future to attributes on
2326 declarations only, but not on nested declarators.
2327
2328 @xref{Function Attributes}, for details of the semantics of attributes
2329 applying to functions. @xref{Variable Attributes}, for details of the
2330 semantics of attributes applying to variables. @xref{Type Attributes},
2331 for details of the semantics of attributes applying to structure, union
2332 and enumerated types.
2333
2334 An @dfn{attribute specifier} is of the form
2335 @code{__attribute__ ((@var{attribute-list}))}. An @dfn{attribute list}
2336 is a possibly empty comma-separated sequence of @dfn{attributes}, where
2337 each attribute is one of the following:
2338
2339 @itemize @bullet
2340 @item
2341 Empty. Empty attributes are ignored.
2342
2343 @item
2344 A word (which may be an identifier such as @code{unused}, or a reserved
2345 word such as @code{const}).
2346
2347 @item
2348 A word, followed by, in parentheses, parameters for the attribute.
2349 These parameters take one of the following forms:
2350
2351 @itemize @bullet
2352 @item
2353 An identifier. For example, @code{mode} attributes use this form.
2354
2355 @item
2356 An identifier followed by a comma and a non-empty comma-separated list
2357 of expressions. For example, @code{format} attributes use this form.
2358
2359 @item
2360 A possibly empty comma-separated list of expressions. For example,
2361 @code{format_arg} attributes use this form with the list being a single
2362 integer constant expression, and @code{alias} attributes use this form
2363 with the list being a single string constant.
2364 @end itemize
2365 @end itemize
2366
2367 An @dfn{attribute specifier list} is a sequence of one or more attribute
2368 specifiers, not separated by any other tokens.
2369
2370 In GNU C, an attribute specifier list may appear after the colon following a
2371 label, other than a @code{case} or @code{default} label. The only
2372 attribute it makes sense to use after a label is @code{unused}. This
2373 feature is intended for code generated by programs which contains labels
2374 that may be unused but which is compiled with @option{-Wall}. It would
2375 not normally be appropriate to use in it human-written code, though it
2376 could be useful in cases where the code that jumps to the label is
2377 contained within an @code{#ifdef} conditional. GNU C++ does not permit
2378 such placement of attribute lists, as it is permissible for a
2379 declaration, which could begin with an attribute list, to be labelled in
2380 C++. Declarations cannot be labelled in C90 or C99, so the ambiguity
2381 does not arise there.
2382
2383 An attribute specifier list may appear as part of a @code{struct},
2384 @code{union} or @code{enum} specifier. It may go either immediately
2385 after the @code{struct}, @code{union} or @code{enum} keyword, or after
2386 the closing brace. It is ignored if the content of the structure, union
2387 or enumerated type is not defined in the specifier in which the
2388 attribute specifier list is used---that is, in usages such as
2389 @code{struct __attribute__((foo)) bar} with no following opening brace.
2390 Where attribute specifiers follow the closing brace, they are considered
2391 to relate to the structure, union or enumerated type defined, not to any
2392 enclosing declaration the type specifier appears in, and the type
2393 defined is not complete until after the attribute specifiers.
2394 @c Otherwise, there would be the following problems: a shift/reduce
2395 @c conflict between attributes binding the struct/union/enum and
2396 @c binding to the list of specifiers/qualifiers; and "aligned"
2397 @c attributes could use sizeof for the structure, but the size could be
2398 @c changed later by "packed" attributes.
2399
2400 Otherwise, an attribute specifier appears as part of a declaration,
2401 counting declarations of unnamed parameters and type names, and relates
2402 to that declaration (which may be nested in another declaration, for
2403 example in the case of a parameter declaration), or to a particular declarator
2404 within a declaration. Where an
2405 attribute specifier is applied to a parameter declared as a function or
2406 an array, it should apply to the function or array rather than the
2407 pointer to which the parameter is implicitly converted, but this is not
2408 yet correctly implemented.
2409
2410 Any list of specifiers and qualifiers at the start of a declaration may
2411 contain attribute specifiers, whether or not such a list may in that
2412 context contain storage class specifiers. (Some attributes, however,
2413 are essentially in the nature of storage class specifiers, and only make
2414 sense where storage class specifiers may be used; for example,
2415 @code{section}.) There is one necessary limitation to this syntax: the
2416 first old-style parameter declaration in a function definition cannot
2417 begin with an attribute specifier, because such an attribute applies to
2418 the function instead by syntax described below (which, however, is not
2419 yet implemented in this case). In some other cases, attribute
2420 specifiers are permitted by this grammar but not yet supported by the
2421 compiler. All attribute specifiers in this place relate to the
2422 declaration as a whole. In the obsolescent usage where a type of
2423 @code{int} is implied by the absence of type specifiers, such a list of
2424 specifiers and qualifiers may be an attribute specifier list with no
2425 other specifiers or qualifiers.
2426
2427 An attribute specifier list may appear immediately before a declarator
2428 (other than the first) in a comma-separated list of declarators in a
2429 declaration of more than one identifier using a single list of
2430 specifiers and qualifiers. Such attribute specifiers apply
2431 only to the identifier before whose declarator they appear. For
2432 example, in
2433
2434 @smallexample
2435 __attribute__((noreturn)) void d0 (void),
2436 __attribute__((format(printf, 1, 2))) d1 (const char *, ...),
2437 d2 (void)
2438 @end smallexample
2439
2440 @noindent
2441 the @code{noreturn} attribute applies to all the functions
2442 declared; the @code{format} attribute only applies to @code{d1}.
2443
2444 An attribute specifier list may appear immediately before the comma,
2445 @code{=} or semicolon terminating the declaration of an identifier other
2446 than a function definition. At present, such attribute specifiers apply
2447 to the declared object or function, but in future they may attach to the
2448 outermost adjacent declarator. In simple cases there is no difference,
2449 but, for example, in
2450
2451 @smallexample
2452 void (****f)(void) __attribute__((noreturn));
2453 @end smallexample
2454
2455 @noindent
2456 at present the @code{noreturn} attribute applies to @code{f}, which
2457 causes a warning since @code{f} is not a function, but in future it may
2458 apply to the function @code{****f}. The precise semantics of what
2459 attributes in such cases will apply to are not yet specified. Where an
2460 assembler name for an object or function is specified (@pxref{Asm
2461 Labels}), at present the attribute must follow the @code{asm}
2462 specification; in future, attributes before the @code{asm} specification
2463 may apply to the adjacent declarator, and those after it to the declared
2464 object or function.
2465
2466 An attribute specifier list may, in future, be permitted to appear after
2467 the declarator in a function definition (before any old-style parameter
2468 declarations or the function body).
2469
2470 Attribute specifiers may be mixed with type qualifiers appearing inside
2471 the @code{[]} of a parameter array declarator, in the C99 construct by
2472 which such qualifiers are applied to the pointer to which the array is
2473 implicitly converted. Such attribute specifiers apply to the pointer,
2474 not to the array, but at present this is not implemented and they are
2475 ignored.
2476
2477 An attribute specifier list may appear at the start of a nested
2478 declarator. At present, there are some limitations in this usage: the
2479 attributes correctly apply to the declarator, but for most individual
2480 attributes the semantics this implies are not implemented.
2481 When attribute specifiers follow the @code{*} of a pointer
2482 declarator, they may be mixed with any type qualifiers present.
2483 The following describes the formal semantics of this syntax. It will make the
2484 most sense if you are familiar with the formal specification of
2485 declarators in the ISO C standard.
2486
2487 Consider (as in C99 subclause 6.7.5 paragraph 4) a declaration @code{T
2488 D1}, where @code{T} contains declaration specifiers that specify a type
2489 @var{Type} (such as @code{int}) and @code{D1} is a declarator that
2490 contains an identifier @var{ident}. The type specified for @var{ident}
2491 for derived declarators whose type does not include an attribute
2492 specifier is as in the ISO C standard.
2493
2494 If @code{D1} has the form @code{( @var{attribute-specifier-list} D )},
2495 and the declaration @code{T D} specifies the type
2496 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
2497 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
2498 @var{attribute-specifier-list} @var{Type}'' for @var{ident}.
2499
2500 If @code{D1} has the form @code{*
2501 @var{type-qualifier-and-attribute-specifier-list} D}, and the
2502 declaration @code{T D} specifies the type
2503 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
2504 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
2505 @var{type-qualifier-and-attribute-specifier-list} @var{Type}'' for
2506 @var{ident}.
2507
2508 For example,
2509
2510 @smallexample
2511 void (__attribute__((noreturn)) ****f) (void);
2512 @end smallexample
2513
2514 @noindent
2515 specifies the type ``pointer to pointer to pointer to pointer to
2516 non-returning function returning @code{void}''. As another example,
2517
2518 @smallexample
2519 char *__attribute__((aligned(8))) *f;
2520 @end smallexample
2521
2522 @noindent
2523 specifies the type ``pointer to 8-byte-aligned pointer to @code{char}''.
2524 Note again that this does not work with most attributes; for example,
2525 the usage of @samp{aligned} and @samp{noreturn} attributes given above
2526 is not yet supported.
2527
2528 For compatibility with existing code written for compiler versions that
2529 did not implement attributes on nested declarators, some laxity is
2530 allowed in the placing of attributes. If an attribute that only applies
2531 to types is applied to a declaration, it will be treated as applying to
2532 the type of that declaration. If an attribute that only applies to
2533 declarations is applied to the type of a declaration, it will be treated
2534 as applying to that declaration; and, for compatibility with code
2535 placing the attributes immediately before the identifier declared, such
2536 an attribute applied to a function return type will be treated as
2537 applying to the function type, and such an attribute applied to an array
2538 element type will be treated as applying to the array type. If an
2539 attribute that only applies to function types is applied to a
2540 pointer-to-function type, it will be treated as applying to the pointer
2541 target type; if such an attribute is applied to a function return type
2542 that is not a pointer-to-function type, it will be treated as applying
2543 to the function type.
2544
2545 @node Function Prototypes
2546 @section Prototypes and Old-Style Function Definitions
2547 @cindex function prototype declarations
2548 @cindex old-style function definitions
2549 @cindex promotion of formal parameters
2550
2551 GNU C extends ISO C to allow a function prototype to override a later
2552 old-style non-prototype definition. Consider the following example:
2553
2554 @smallexample
2555 /* @r{Use prototypes unless the compiler is old-fashioned.} */
2556 #ifdef __STDC__
2557 #define P(x) x
2558 #else
2559 #define P(x) ()
2560 #endif
2561
2562 /* @r{Prototype function declaration.} */
2563 int isroot P((uid_t));
2564
2565 /* @r{Old-style function definition.} */
2566 int
2567 isroot (x) /* ??? lossage here ??? */
2568 uid_t x;
2569 @{
2570 return x == 0;
2571 @}
2572 @end smallexample
2573
2574 Suppose the type @code{uid_t} happens to be @code{short}. ISO C does
2575 not allow this example, because subword arguments in old-style
2576 non-prototype definitions are promoted. Therefore in this example the
2577 function definition's argument is really an @code{int}, which does not
2578 match the prototype argument type of @code{short}.
2579
2580 This restriction of ISO C makes it hard to write code that is portable
2581 to traditional C compilers, because the programmer does not know
2582 whether the @code{uid_t} type is @code{short}, @code{int}, or
2583 @code{long}. Therefore, in cases like these GNU C allows a prototype
2584 to override a later old-style definition. More precisely, in GNU C, a
2585 function prototype argument type overrides the argument type specified
2586 by a later old-style definition if the former type is the same as the
2587 latter type before promotion. Thus in GNU C the above example is
2588 equivalent to the following:
2589
2590 @smallexample
2591 int isroot (uid_t);
2592
2593 int
2594 isroot (uid_t x)
2595 @{
2596 return x == 0;
2597 @}
2598 @end smallexample
2599
2600 @noindent
2601 GNU C++ does not support old-style function definitions, so this
2602 extension is irrelevant.
2603
2604 @node C++ Comments
2605 @section C++ Style Comments
2606 @cindex //
2607 @cindex C++ comments
2608 @cindex comments, C++ style
2609
2610 In GNU C, you may use C++ style comments, which start with @samp{//} and
2611 continue until the end of the line. Many other C implementations allow
2612 such comments, and they are included in the 1999 C standard. However,
2613 C++ style comments are not recognized if you specify an @option{-std}
2614 option specifying a version of ISO C before C99, or @option{-ansi}
2615 (equivalent to @option{-std=c89}).
2616
2617 @node Dollar Signs
2618 @section Dollar Signs in Identifier Names
2619 @cindex $
2620 @cindex dollar signs in identifier names
2621 @cindex identifier names, dollar signs in
2622
2623 In GNU C, you may normally use dollar signs in identifier names.
2624 This is because many traditional C implementations allow such identifiers.
2625 However, dollar signs in identifiers are not supported on a few target
2626 machines, typically because the target assembler does not allow them.
2627
2628 @node Character Escapes
2629 @section The Character @key{ESC} in Constants
2630
2631 You can use the sequence @samp{\e} in a string or character constant to
2632 stand for the ASCII character @key{ESC}.
2633
2634 @node Alignment
2635 @section Inquiring on Alignment of Types or Variables
2636 @cindex alignment
2637 @cindex type alignment
2638 @cindex variable alignment
2639
2640 The keyword @code{__alignof__} allows you to inquire about how an object
2641 is aligned, or the minimum alignment usually required by a type. Its
2642 syntax is just like @code{sizeof}.
2643
2644 For example, if the target machine requires a @code{double} value to be
2645 aligned on an 8-byte boundary, then @code{__alignof__ (double)} is 8.
2646 This is true on many RISC machines. On more traditional machine
2647 designs, @code{__alignof__ (double)} is 4 or even 2.
2648
2649 Some machines never actually require alignment; they allow reference to any
2650 data type even at an odd address. For these machines, @code{__alignof__}
2651 reports the @emph{recommended} alignment of a type.
2652
2653 If the operand of @code{__alignof__} is an lvalue rather than a type,
2654 its value is the required alignment for its type, taking into account
2655 any minimum alignment specified with GCC's @code{__attribute__}
2656 extension (@pxref{Variable Attributes}). For example, after this
2657 declaration:
2658
2659 @smallexample
2660 struct foo @{ int x; char y; @} foo1;
2661 @end smallexample
2662
2663 @noindent
2664 the value of @code{__alignof__ (foo1.y)} is 1, even though its actual
2665 alignment is probably 2 or 4, the same as @code{__alignof__ (int)}.
2666
2667 It is an error to ask for the alignment of an incomplete type.
2668
2669 @node Variable Attributes
2670 @section Specifying Attributes of Variables
2671 @cindex attribute of variables
2672 @cindex variable attributes
2673
2674 The keyword @code{__attribute__} allows you to specify special
2675 attributes of variables or structure fields. This keyword is followed
2676 by an attribute specification inside double parentheses. Some
2677 attributes are currently defined generically for variables.
2678 Other attributes are defined for variables on particular target
2679 systems. Other attributes are available for functions
2680 (@pxref{Function Attributes}) and for types (@pxref{Type Attributes}).
2681 Other front ends might define more attributes
2682 (@pxref{C++ Extensions,,Extensions to the C++ Language}).
2683
2684 You may also specify attributes with @samp{__} preceding and following
2685 each keyword. This allows you to use them in header files without
2686 being concerned about a possible macro of the same name. For example,
2687 you may use @code{__aligned__} instead of @code{aligned}.
2688
2689 @xref{Attribute Syntax}, for details of the exact syntax for using
2690 attributes.
2691
2692 @table @code
2693 @cindex @code{aligned} attribute
2694 @item aligned (@var{alignment})
2695 This attribute specifies a minimum alignment for the variable or
2696 structure field, measured in bytes. For example, the declaration:
2697
2698 @smallexample
2699 int x __attribute__ ((aligned (16))) = 0;
2700 @end smallexample
2701
2702 @noindent
2703 causes the compiler to allocate the global variable @code{x} on a
2704 16-byte boundary. On a 68040, this could be used in conjunction with
2705 an @code{asm} expression to access the @code{move16} instruction which
2706 requires 16-byte aligned operands.
2707
2708 You can also specify the alignment of structure fields. For example, to
2709 create a double-word aligned @code{int} pair, you could write:
2710
2711 @smallexample
2712 struct foo @{ int x[2] __attribute__ ((aligned (8))); @};
2713 @end smallexample
2714
2715 @noindent
2716 This is an alternative to creating a union with a @code{double} member
2717 that forces the union to be double-word aligned.
2718
2719 As in the preceding examples, you can explicitly specify the alignment
2720 (in bytes) that you wish the compiler to use for a given variable or
2721 structure field. Alternatively, you can leave out the alignment factor
2722 and just ask the compiler to align a variable or field to the maximum
2723 useful alignment for the target machine you are compiling for. For
2724 example, you could write:
2725
2726 @smallexample
2727 short array[3] __attribute__ ((aligned));
2728 @end smallexample
2729
2730 Whenever you leave out the alignment factor in an @code{aligned} attribute
2731 specification, the compiler automatically sets the alignment for the declared
2732 variable or field to the largest alignment which is ever used for any data
2733 type on the target machine you are compiling for. Doing this can often make
2734 copy operations more efficient, because the compiler can use whatever
2735 instructions copy the biggest chunks of memory when performing copies to
2736 or from the variables or fields that you have aligned this way.
2737
2738 The @code{aligned} attribute can only increase the alignment; but you
2739 can decrease it by specifying @code{packed} as well. See below.
2740
2741 Note that the effectiveness of @code{aligned} attributes may be limited
2742 by inherent limitations in your linker. On many systems, the linker is
2743 only able to arrange for variables to be aligned up to a certain maximum
2744 alignment. (For some linkers, the maximum supported alignment may
2745 be very very small.) If your linker is only able to align variables
2746 up to a maximum of 8 byte alignment, then specifying @code{aligned(16)}
2747 in an @code{__attribute__} will still only provide you with 8 byte
2748 alignment. See your linker documentation for further information.
2749
2750 @item cleanup (@var{cleanup_function})
2751 @cindex @code{cleanup} attribute
2752 The @code{cleanup} attribute runs a function when the variable goes
2753 out of scope. This attribute can only be applied to auto function
2754 scope variables; it may not be applied to parameters or variables
2755 with static storage duration. The function must take one parameter,
2756 a pointer to a type compatible with the variable. The return value
2757 of the function (if any) is ignored.
2758
2759 If @option{-fexceptions} is enabled, then @var{cleanup_function}
2760 will be run during the stack unwinding that happens during the
2761 processing of the exception. Note that the @code{cleanup} attribute
2762 does not allow the exception to be caught, only to perform an action.
2763 It is undefined what happens if @var{cleanup_function} does not
2764 return normally.
2765
2766 @item common
2767 @itemx nocommon
2768 @cindex @code{common} attribute
2769 @cindex @code{nocommon} attribute
2770 @opindex fcommon
2771 @opindex fno-common
2772 The @code{common} attribute requests GCC to place a variable in
2773 ``common'' storage. The @code{nocommon} attribute requests the
2774 opposite -- to allocate space for it directly.
2775
2776 These attributes override the default chosen by the
2777 @option{-fno-common} and @option{-fcommon} flags respectively.
2778
2779 @item deprecated
2780 @cindex @code{deprecated} attribute
2781 The @code{deprecated} attribute results in a warning if the variable
2782 is used anywhere in the source file. This is useful when identifying
2783 variables that are expected to be removed in a future version of a
2784 program. The warning also includes the location of the declaration
2785 of the deprecated variable, to enable users to easily find further
2786 information about why the variable is deprecated, or what they should
2787 do instead. Note that the warning only occurs for uses:
2788
2789 @smallexample
2790 extern int old_var __attribute__ ((deprecated));
2791 extern int old_var;
2792 int new_fn () @{ return old_var; @}
2793 @end smallexample
2794
2795 results in a warning on line 3 but not line 2.
2796
2797 The @code{deprecated} attribute can also be used for functions and
2798 types (@pxref{Function Attributes}, @pxref{Type Attributes}.)
2799
2800 @item mode (@var{mode})
2801 @cindex @code{mode} attribute
2802 This attribute specifies the data type for the declaration---whichever
2803 type corresponds to the mode @var{mode}. This in effect lets you
2804 request an integer or floating point type according to its width.
2805
2806 You may also specify a mode of @samp{byte} or @samp{__byte__} to
2807 indicate the mode corresponding to a one-byte integer, @samp{word} or
2808 @samp{__word__} for the mode of a one-word integer, and @samp{pointer}
2809 or @samp{__pointer__} for the mode used to represent pointers.
2810
2811 @item packed
2812 @cindex @code{packed} attribute
2813 The @code{packed} attribute specifies that a variable or structure field
2814 should have the smallest possible alignment---one byte for a variable,
2815 and one bit for a field, unless you specify a larger value with the
2816 @code{aligned} attribute.
2817
2818 Here is a structure in which the field @code{x} is packed, so that it
2819 immediately follows @code{a}:
2820
2821 @smallexample
2822 struct foo
2823 @{
2824 char a;
2825 int x[2] __attribute__ ((packed));
2826 @};
2827 @end smallexample
2828
2829 @item section ("@var{section-name}")
2830 @cindex @code{section} variable attribute
2831 Normally, the compiler places the objects it generates in sections like
2832 @code{data} and @code{bss}. Sometimes, however, you need additional sections,
2833 or you need certain particular variables to appear in special sections,
2834 for example to map to special hardware. The @code{section}
2835 attribute specifies that a variable (or function) lives in a particular
2836 section. For example, this small program uses several specific section names:
2837
2838 @smallexample
2839 struct duart a __attribute__ ((section ("DUART_A"))) = @{ 0 @};
2840 struct duart b __attribute__ ((section ("DUART_B"))) = @{ 0 @};
2841 char stack[10000] __attribute__ ((section ("STACK"))) = @{ 0 @};
2842 int init_data __attribute__ ((section ("INITDATA"))) = 0;
2843
2844 main()
2845 @{
2846 /* Initialize stack pointer */
2847 init_sp (stack + sizeof (stack));
2848
2849 /* Initialize initialized data */
2850 memcpy (&init_data, &data, &edata - &data);
2851
2852 /* Turn on the serial ports */
2853 init_duart (&a);
2854 init_duart (&b);
2855 @}
2856 @end smallexample
2857
2858 @noindent
2859 Use the @code{section} attribute with an @emph{initialized} definition
2860 of a @emph{global} variable, as shown in the example. GCC issues
2861 a warning and otherwise ignores the @code{section} attribute in
2862 uninitialized variable declarations.
2863
2864 You may only use the @code{section} attribute with a fully initialized
2865 global definition because of the way linkers work. The linker requires
2866 each object be defined once, with the exception that uninitialized
2867 variables tentatively go in the @code{common} (or @code{bss}) section
2868 and can be multiply ``defined''. You can force a variable to be
2869 initialized with the @option{-fno-common} flag or the @code{nocommon}
2870 attribute.
2871
2872 Some file formats do not support arbitrary sections so the @code{section}
2873 attribute is not available on all platforms.
2874 If you need to map the entire contents of a module to a particular
2875 section, consider using the facilities of the linker instead.
2876
2877 @item shared
2878 @cindex @code{shared} variable attribute
2879 On Microsoft Windows, in addition to putting variable definitions in a named
2880 section, the section can also be shared among all running copies of an
2881 executable or DLL@. For example, this small program defines shared data
2882 by putting it in a named section @code{shared} and marking the section
2883 shareable:
2884
2885 @smallexample
2886 int foo __attribute__((section ("shared"), shared)) = 0;
2887
2888 int
2889 main()
2890 @{
2891 /* Read and write foo. All running
2892 copies see the same value. */
2893 return 0;
2894 @}
2895 @end smallexample
2896
2897 @noindent
2898 You may only use the @code{shared} attribute along with @code{section}
2899 attribute with a fully initialized global definition because of the way
2900 linkers work. See @code{section} attribute for more information.
2901
2902 The @code{shared} attribute is only available on Microsoft Windows@.
2903
2904 @item tls_model ("@var{tls_model}")
2905 @cindex @code{tls_model} attribute
2906 The @code{tls_model} attribute sets thread-local storage model
2907 (@pxref{Thread-Local}) of a particular @code{__thread} variable,
2908 overriding @option{-ftls-model=} command line switch on a per-variable
2909 basis.
2910 The @var{tls_model} argument should be one of @code{global-dynamic},
2911 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
2912
2913 Not all targets support this attribute.
2914
2915 @item transparent_union
2916 This attribute, attached to a function parameter which is a union, means
2917 that the corresponding argument may have the type of any union member,
2918 but the argument is passed as if its type were that of the first union
2919 member. For more details see @xref{Type Attributes}. You can also use
2920 this attribute on a @code{typedef} for a union data type; then it
2921 applies to all function parameters with that type.
2922
2923 @item unused
2924 This attribute, attached to a variable, means that the variable is meant
2925 to be possibly unused. GCC will not produce a warning for this
2926 variable.
2927
2928 @item vector_size (@var{bytes})
2929 This attribute specifies the vector size for the variable, measured in
2930 bytes. For example, the declaration:
2931
2932 @smallexample
2933 int foo __attribute__ ((vector_size (16)));
2934 @end smallexample
2935
2936 @noindent
2937 causes the compiler to set the mode for @code{foo}, to be 16 bytes,
2938 divided into @code{int} sized units. Assuming a 32-bit int (a vector of
2939 4 units of 4 bytes), the corresponding mode of @code{foo} will be V4SI@.
2940
2941 This attribute is only applicable to integral and float scalars,
2942 although arrays, pointers, and function return values are allowed in
2943 conjunction with this construct.
2944
2945 Aggregates with this attribute are invalid, even if they are of the same
2946 size as a corresponding scalar. For example, the declaration:
2947
2948 @smallexample
2949 struct S @{ int a; @};
2950 struct S __attribute__ ((vector_size (16))) foo;
2951 @end smallexample
2952
2953 @noindent
2954 is invalid even if the size of the structure is the same as the size of
2955 the @code{int}.
2956
2957 @item weak
2958 The @code{weak} attribute is described in @xref{Function Attributes}.
2959
2960 @item dllimport
2961 The @code{dllimport} attribute is described in @xref{Function Attributes}.
2962
2963 @item dlexport
2964 The @code{dllexport} attribute is described in @xref{Function Attributes}.
2965
2966 @end table
2967
2968 @subsection M32R/D Variable Attributes
2969
2970 One attribute is currently defined for the M32R/D.
2971
2972 @table @code
2973 @item model (@var{model-name})
2974 @cindex variable addressability on the M32R/D
2975 Use this attribute on the M32R/D to set the addressability of an object.
2976 The identifier @var{model-name} is one of @code{small}, @code{medium},
2977 or @code{large}, representing each of the code models.
2978
2979 Small model objects live in the lower 16MB of memory (so that their
2980 addresses can be loaded with the @code{ld24} instruction).
2981
2982 Medium and large model objects may live anywhere in the 32-bit address space
2983 (the compiler will generate @code{seth/add3} instructions to load their
2984 addresses).
2985 @end table
2986
2987 @subsection i386 Variable Attributes
2988
2989 Two attributes are currently defined for i386 configurations:
2990 @code{ms_struct} and @code{gcc_struct}
2991
2992 @table @code
2993 @item ms_struct
2994 @itemx gcc_struct
2995 @cindex @code{ms_struct} attribute
2996 @cindex @code{gcc_struct} attribute
2997
2998 If @code{packed} is used on a structure, or if bit-fields are used
2999 it may be that the Microsoft ABI packs them differently
3000 than GCC would normally pack them. Particularly when moving packed
3001 data between functions compiled with GCC and the native Microsoft compiler
3002 (either via function call or as data in a file), it may be necessary to access
3003 either format.
3004
3005 Currently @option{-m[no-]ms-bitfields} is provided for the Microsoft Windows X86
3006 compilers to match the native Microsoft compiler.
3007 @end table
3008
3009 @subsection Xstormy16 Variable Attributes
3010
3011 One attribute is currently defined for xstormy16 configurations:
3012 @code{below100}
3013
3014 @table @code
3015 @item below100
3016 @cindex @code{below100} attribute
3017
3018 If a variable has the @code{below100} attribute (@code{BELOW100} is
3019 allowed also), GCC will place the variable in the first 0x100 bytes of
3020 memory and use special opcodes to access it. Such variables will be
3021 placed in either the @code{.bss_below100} section or the
3022 @code{.data_below100} section.
3023
3024 @end table
3025
3026 @node Type Attributes
3027 @section Specifying Attributes of Types
3028 @cindex attribute of types
3029 @cindex type attributes
3030
3031 The keyword @code{__attribute__} allows you to specify special
3032 attributes of @code{struct} and @code{union} types when you define such
3033 types. This keyword is followed by an attribute specification inside
3034 double parentheses. Six attributes are currently defined for types:
3035 @code{aligned}, @code{packed}, @code{transparent_union}, @code{unused},
3036 @code{deprecated} and @code{may_alias}. Other attributes are defined for
3037 functions (@pxref{Function Attributes}) and for variables
3038 (@pxref{Variable Attributes}).
3039
3040 You may also specify any one of these attributes with @samp{__}
3041 preceding and following its keyword. This allows you to use these
3042 attributes in header files without being concerned about a possible
3043 macro of the same name. For example, you may use @code{__aligned__}
3044 instead of @code{aligned}.
3045
3046 You may specify the @code{aligned} and @code{transparent_union}
3047 attributes either in a @code{typedef} declaration or just past the
3048 closing curly brace of a complete enum, struct or union type
3049 @emph{definition} and the @code{packed} attribute only past the closing
3050 brace of a definition.
3051
3052 You may also specify attributes between the enum, struct or union
3053 tag and the name of the type rather than after the closing brace.
3054
3055 @xref{Attribute Syntax}, for details of the exact syntax for using
3056 attributes.
3057
3058 @table @code
3059 @cindex @code{aligned} attribute
3060 @item aligned (@var{alignment})
3061 This attribute specifies a minimum alignment (in bytes) for variables
3062 of the specified type. For example, the declarations:
3063
3064 @smallexample
3065 struct S @{ short f[3]; @} __attribute__ ((aligned (8)));
3066 typedef int more_aligned_int __attribute__ ((aligned (8)));
3067 @end smallexample
3068
3069 @noindent
3070 force the compiler to insure (as far as it can) that each variable whose
3071 type is @code{struct S} or @code{more_aligned_int} will be allocated and
3072 aligned @emph{at least} on a 8-byte boundary. On a SPARC, having all
3073 variables of type @code{struct S} aligned to 8-byte boundaries allows
3074 the compiler to use the @code{ldd} and @code{std} (doubleword load and
3075 store) instructions when copying one variable of type @code{struct S} to
3076 another, thus improving run-time efficiency.
3077
3078 Note that the alignment of any given @code{struct} or @code{union} type
3079 is required by the ISO C standard to be at least a perfect multiple of
3080 the lowest common multiple of the alignments of all of the members of
3081 the @code{struct} or @code{union} in question. This means that you @emph{can}
3082 effectively adjust the alignment of a @code{struct} or @code{union}
3083 type by attaching an @code{aligned} attribute to any one of the members
3084 of such a type, but the notation illustrated in the example above is a
3085 more obvious, intuitive, and readable way to request the compiler to
3086 adjust the alignment of an entire @code{struct} or @code{union} type.
3087
3088 As in the preceding example, you can explicitly specify the alignment
3089 (in bytes) that you wish the compiler to use for a given @code{struct}
3090 or @code{union} type. Alternatively, you can leave out the alignment factor
3091 and just ask the compiler to align a type to the maximum
3092 useful alignment for the target machine you are compiling for. For
3093 example, you could write:
3094
3095 @smallexample
3096 struct S @{ short f[3]; @} __attribute__ ((aligned));
3097 @end smallexample
3098
3099 Whenever you leave out the alignment factor in an @code{aligned}
3100 attribute specification, the compiler automatically sets the alignment
3101 for the type to the largest alignment which is ever used for any data
3102 type on the target machine you are compiling for. Doing this can often
3103 make copy operations more efficient, because the compiler can use
3104 whatever instructions copy the biggest chunks of memory when performing
3105 copies to or from the variables which have types that you have aligned
3106 this way.
3107
3108 In the example above, if the size of each @code{short} is 2 bytes, then
3109 the size of the entire @code{struct S} type is 6 bytes. The smallest
3110 power of two which is greater than or equal to that is 8, so the
3111 compiler sets the alignment for the entire @code{struct S} type to 8
3112 bytes.
3113
3114 Note that although you can ask the compiler to select a time-efficient
3115 alignment for a given type and then declare only individual stand-alone
3116 objects of that type, the compiler's ability to select a time-efficient
3117 alignment is primarily useful only when you plan to create arrays of
3118 variables having the relevant (efficiently aligned) type. If you
3119 declare or use arrays of variables of an efficiently-aligned type, then
3120 it is likely that your program will also be doing pointer arithmetic (or
3121 subscripting, which amounts to the same thing) on pointers to the
3122 relevant type, and the code that the compiler generates for these
3123 pointer arithmetic operations will often be more efficient for
3124 efficiently-aligned types than for other types.
3125
3126 The @code{aligned} attribute can only increase the alignment; but you
3127 can decrease it by specifying @code{packed} as well. See below.
3128
3129 Note that the effectiveness of @code{aligned} attributes may be limited
3130 by inherent limitations in your linker. On many systems, the linker is
3131 only able to arrange for variables to be aligned up to a certain maximum
3132 alignment. (For some linkers, the maximum supported alignment may
3133 be very very small.) If your linker is only able to align variables
3134 up to a maximum of 8 byte alignment, then specifying @code{aligned(16)}
3135 in an @code{__attribute__} will still only provide you with 8 byte
3136 alignment. See your linker documentation for further information.
3137
3138 @item packed
3139 This attribute, attached to @code{struct} or @code{union} type
3140 definition, specifies that each member of the structure or union is
3141 placed to minimize the memory required. When attached to an @code{enum}
3142 definition, it indicates that the smallest integral type should be used.
3143
3144 @opindex fshort-enums
3145 Specifying this attribute for @code{struct} and @code{union} types is
3146 equivalent to specifying the @code{packed} attribute on each of the
3147 structure or union members. Specifying the @option{-fshort-enums}
3148 flag on the line is equivalent to specifying the @code{packed}
3149 attribute on all @code{enum} definitions.
3150
3151 In the following example @code{struct my_packed_struct}'s members are
3152 packed closely together, but the internal layout of its @code{s} member
3153 is not packed -- to do that, @code{struct my_unpacked_struct} would need to
3154 be packed too.
3155
3156 @smallexample
3157 struct my_unpacked_struct
3158 @{
3159 char c;
3160 int i;
3161 @};
3162
3163 struct my_packed_struct __attribute__ ((__packed__))
3164 @{
3165 char c;
3166 int i;
3167 struct my_unpacked_struct s;
3168 @};
3169 @end smallexample
3170
3171 You may only specify this attribute on the definition of a @code{enum},
3172 @code{struct} or @code{union}, not on a @code{typedef} which does not
3173 also define the enumerated type, structure or union.
3174
3175 @item transparent_union
3176 This attribute, attached to a @code{union} type definition, indicates
3177 that any function parameter having that union type causes calls to that
3178 function to be treated in a special way.
3179
3180 First, the argument corresponding to a transparent union type can be of
3181 any type in the union; no cast is required. Also, if the union contains
3182 a pointer type, the corresponding argument can be a null pointer
3183 constant or a void pointer expression; and if the union contains a void
3184 pointer type, the corresponding argument can be any pointer expression.
3185 If the union member type is a pointer, qualifiers like @code{const} on
3186 the referenced type must be respected, just as with normal pointer
3187 conversions.
3188
3189 Second, the argument is passed to the function using the calling
3190 conventions of the first member of the transparent union, not the calling
3191 conventions of the union itself. All members of the union must have the
3192 same machine representation; this is necessary for this argument passing
3193 to work properly.
3194
3195 Transparent unions are designed for library functions that have multiple
3196 interfaces for compatibility reasons. For example, suppose the
3197 @code{wait} function must accept either a value of type @code{int *} to
3198 comply with Posix, or a value of type @code{union wait *} to comply with
3199 the 4.1BSD interface. If @code{wait}'s parameter were @code{void *},
3200 @code{wait} would accept both kinds of arguments, but it would also
3201 accept any other pointer type and this would make argument type checking
3202 less useful. Instead, @code{<sys/wait.h>} might define the interface
3203 as follows:
3204
3205 @smallexample
3206 typedef union
3207 @{
3208 int *__ip;
3209 union wait *__up;
3210 @} wait_status_ptr_t __attribute__ ((__transparent_union__));
3211
3212 pid_t wait (wait_status_ptr_t);
3213 @end smallexample
3214
3215 This interface allows either @code{int *} or @code{union wait *}
3216 arguments to be passed, using the @code{int *} calling convention.
3217 The program can call @code{wait} with arguments of either type:
3218
3219 @smallexample
3220 int w1 () @{ int w; return wait (&w); @}
3221 int w2 () @{ union wait w; return wait (&w); @}
3222 @end smallexample
3223
3224 With this interface, @code{wait}'s implementation might look like this:
3225
3226 @smallexample
3227 pid_t wait (wait_status_ptr_t p)
3228 @{
3229 return waitpid (-1, p.__ip, 0);
3230 @}
3231 @end smallexample
3232
3233 @item unused
3234 When attached to a type (including a @code{union} or a @code{struct}),
3235 this attribute means that variables of that type are meant to appear
3236 possibly unused. GCC will not produce a warning for any variables of
3237 that type, even if the variable appears to do nothing. This is often
3238 the case with lock or thread classes, which are usually defined and then
3239 not referenced, but contain constructors and destructors that have
3240 nontrivial bookkeeping functions.
3241
3242 @item deprecated
3243 The @code{deprecated} attribute results in a warning if the type
3244 is used anywhere in the source file. This is useful when identifying
3245 types that are expected to be removed in a future version of a program.
3246 If possible, the warning also includes the location of the declaration
3247 of the deprecated type, to enable users to easily find further
3248 information about why the type is deprecated, or what they should do
3249 instead. Note that the warnings only occur for uses and then only
3250 if the type is being applied to an identifier that itself is not being
3251 declared as deprecated.
3252
3253 @smallexample
3254 typedef int T1 __attribute__ ((deprecated));
3255 T1 x;
3256 typedef T1 T2;
3257 T2 y;
3258 typedef T1 T3 __attribute__ ((deprecated));
3259 T3 z __attribute__ ((deprecated));
3260 @end smallexample
3261
3262 results in a warning on line 2 and 3 but not lines 4, 5, or 6. No
3263 warning is issued for line 4 because T2 is not explicitly
3264 deprecated. Line 5 has no warning because T3 is explicitly
3265 deprecated. Similarly for line 6.
3266
3267 The @code{deprecated} attribute can also be used for functions and
3268 variables (@pxref{Function Attributes}, @pxref{Variable Attributes}.)
3269
3270 @item may_alias
3271 Accesses to objects with types with this attribute are not subjected to
3272 type-based alias analysis, but are instead assumed to be able to alias
3273 any other type of objects, just like the @code{char} type. See
3274 @option{-fstrict-aliasing} for more information on aliasing issues.
3275
3276 Example of use:
3277
3278 @smallexample
3279 typedef short __attribute__((__may_alias__)) short_a;
3280
3281 int
3282 main (void)
3283 @{
3284 int a = 0x12345678;
3285 short_a *b = (short_a *) &a;
3286
3287 b[1] = 0;
3288
3289 if (a == 0x12345678)
3290 abort();
3291
3292 exit(0);
3293 @}
3294 @end smallexample
3295
3296 If you replaced @code{short_a} with @code{short} in the variable
3297 declaration, the above program would abort when compiled with
3298 @option{-fstrict-aliasing}, which is on by default at @option{-O2} or
3299 above in recent GCC versions.
3300
3301 @subsection i386 Type Attributes
3302
3303 Two attributes are currently defined for i386 configurations:
3304 @code{ms_struct} and @code{gcc_struct}
3305
3306 @item ms_struct
3307 @itemx gcc_struct
3308 @cindex @code{ms_struct}
3309 @cindex @code{gcc_struct}
3310
3311 If @code{packed} is used on a structure, or if bit-fields are used
3312 it may be that the Microsoft ABI packs them differently
3313 than GCC would normally pack them. Particularly when moving packed
3314 data between functions compiled with GCC and the native Microsoft compiler
3315 (either via function call or as data in a file), it may be necessary to access
3316 either format.
3317
3318 Currently @option{-m[no-]ms-bitfields} is provided for the Microsoft Windows X86
3319 compilers to match the native Microsoft compiler.
3320 @end table
3321
3322 To specify multiple attributes, separate them by commas within the
3323 double parentheses: for example, @samp{__attribute__ ((aligned (16),
3324 packed))}.
3325
3326 @node Inline
3327 @section An Inline Function is As Fast As a Macro
3328 @cindex inline functions
3329 @cindex integrating function code
3330 @cindex open coding
3331 @cindex macros, inline alternative
3332
3333 By declaring a function @code{inline}, you can direct GCC to
3334 integrate that function's code into the code for its callers. This
3335 makes execution faster by eliminating the function-call overhead; in
3336 addition, if any of the actual argument values are constant, their known
3337 values may permit simplifications at compile time so that not all of the
3338 inline function's code needs to be included. The effect on code size is
3339 less predictable; object code may be larger or smaller with function
3340 inlining, depending on the particular case. Inlining of functions is an
3341 optimization and it really ``works'' only in optimizing compilation. If
3342 you don't use @option{-O}, no function is really inline.
3343
3344 Inline functions are included in the ISO C99 standard, but there are
3345 currently substantial differences between what GCC implements and what
3346 the ISO C99 standard requires.
3347
3348 To declare a function inline, use the @code{inline} keyword in its
3349 declaration, like this:
3350
3351 @smallexample
3352 inline int
3353 inc (int *a)
3354 @{
3355 (*a)++;
3356 @}
3357 @end smallexample
3358
3359 (If you are writing a header file to be included in ISO C programs, write
3360 @code{__inline__} instead of @code{inline}. @xref{Alternate Keywords}.)
3361 You can also make all ``simple enough'' functions inline with the option
3362 @option{-finline-functions}.
3363
3364 @opindex Winline
3365 Note that certain usages in a function definition can make it unsuitable
3366 for inline substitution. Among these usages are: use of varargs, use of
3367 alloca, use of variable sized data types (@pxref{Variable Length}),
3368 use of computed goto (@pxref{Labels as Values}), use of nonlocal goto,
3369 and nested functions (@pxref{Nested Functions}). Using @option{-Winline}
3370 will warn when a function marked @code{inline} could not be substituted,
3371 and will give the reason for the failure.
3372
3373 Note that in C and Objective-C, unlike C++, the @code{inline} keyword
3374 does not affect the linkage of the function.
3375
3376 @cindex automatic @code{inline} for C++ member fns
3377 @cindex @code{inline} automatic for C++ member fns
3378 @cindex member fns, automatically @code{inline}
3379 @cindex C++ member fns, automatically @code{inline}
3380 @opindex fno-default-inline
3381 GCC automatically inlines member functions defined within the class
3382 body of C++ programs even if they are not explicitly declared
3383 @code{inline}. (You can override this with @option{-fno-default-inline};
3384 @pxref{C++ Dialect Options,,Options Controlling C++ Dialect}.)
3385
3386 @cindex inline functions, omission of
3387 @opindex fkeep-inline-functions
3388 When a function is both inline and @code{static}, if all calls to the
3389 function are integrated into the caller, and the function's address is
3390 never used, then the function's own assembler code is never referenced.
3391 In this case, GCC does not actually output assembler code for the
3392 function, unless you specify the option @option{-fkeep-inline-functions}.
3393 Some calls cannot be integrated for various reasons (in particular,
3394 calls that precede the function's definition cannot be integrated, and
3395 neither can recursive calls within the definition). If there is a
3396 nonintegrated call, then the function is compiled to assembler code as
3397 usual. The function must also be compiled as usual if the program
3398 refers to its address, because that can't be inlined.
3399
3400 @cindex non-static inline function
3401 When an inline function is not @code{static}, then the compiler must assume
3402 that there may be calls from other source files; since a global symbol can
3403 be defined only once in any program, the function must not be defined in
3404 the other source files, so the calls therein cannot be integrated.
3405 Therefore, a non-@code{static} inline function is always compiled on its
3406 own in the usual fashion.
3407
3408 If you specify both @code{inline} and @code{extern} in the function
3409 definition, then the definition is used only for inlining. In no case
3410 is the function compiled on its own, not even if you refer to its
3411 address explicitly. Such an address becomes an external reference, as
3412 if you had only declared the function, and had not defined it.
3413
3414 This combination of @code{inline} and @code{extern} has almost the
3415 effect of a macro. The way to use it is to put a function definition in
3416 a header file with these keywords, and put another copy of the
3417 definition (lacking @code{inline} and @code{extern}) in a library file.
3418 The definition in the header file will cause most calls to the function
3419 to be inlined. If any uses of the function remain, they will refer to
3420 the single copy in the library.
3421
3422 Since GCC eventually will implement ISO C99 semantics for
3423 inline functions, it is best to use @code{static inline} only
3424 to guarantee compatibility. (The
3425 existing semantics will remain available when @option{-std=gnu89} is
3426 specified, but eventually the default will be @option{-std=gnu99} and
3427 that will implement the C99 semantics, though it does not do so yet.)
3428
3429 GCC does not inline any functions when not optimizing unless you specify
3430 the @samp{always_inline} attribute for the function, like this:
3431
3432 @smallexample
3433 /* Prototype. */
3434 inline void foo (const char) __attribute__((always_inline));
3435 @end smallexample
3436
3437 @node Extended Asm
3438 @section Assembler Instructions with C Expression Operands
3439 @cindex extended @code{asm}
3440 @cindex @code{asm} expressions
3441 @cindex assembler instructions
3442 @cindex registers
3443
3444 In an assembler instruction using @code{asm}, you can specify the
3445 operands of the instruction using C expressions. This means you need not
3446 guess which registers or memory locations will contain the data you want
3447 to use.
3448
3449 You must specify an assembler instruction template much like what
3450 appears in a machine description, plus an operand constraint string for
3451 each operand.
3452
3453 For example, here is how to use the 68881's @code{fsinx} instruction:
3454
3455 @smallexample
3456 asm ("fsinx %1,%0" : "=f" (result) : "f" (angle));
3457 @end smallexample
3458
3459 @noindent
3460 Here @code{angle} is the C expression for the input operand while
3461 @code{result} is that of the output operand. Each has @samp{"f"} as its
3462 operand constraint, saying that a floating point register is required.
3463 The @samp{=} in @samp{=f} indicates that the operand is an output; all
3464 output operands' constraints must use @samp{=}. The constraints use the
3465 same language used in the machine description (@pxref{Constraints}).
3466
3467 Each operand is described by an operand-constraint string followed by
3468 the C expression in parentheses. A colon separates the assembler
3469 template from the first output operand and another separates the last
3470 output operand from the first input, if any. Commas separate the
3471 operands within each group. The total number of operands is currently
3472 limited to 30; this limitation may be lifted in some future version of
3473 GCC.
3474
3475 If there are no output operands but there are input operands, you must
3476 place two consecutive colons surrounding the place where the output
3477 operands would go.
3478
3479 As of GCC version 3.1, it is also possible to specify input and output
3480 operands using symbolic names which can be referenced within the
3481 assembler code. These names are specified inside square brackets
3482 preceding the constraint string, and can be referenced inside the
3483 assembler code using @code{%[@var{name}]} instead of a percentage sign
3484 followed by the operand number. Using named operands the above example
3485 could look like:
3486
3487 @smallexample
3488 asm ("fsinx %[angle],%[output]"
3489 : [output] "=f" (result)
3490 : [angle] "f" (angle));
3491 @end smallexample
3492
3493 @noindent
3494 Note that the symbolic operand names have no relation whatsoever to
3495 other C identifiers. You may use any name you like, even those of
3496 existing C symbols, but you must ensure that no two operands within the same
3497 assembler construct use the same symbolic name.
3498
3499 Output operand expressions must be lvalues; the compiler can check this.
3500 The input operands need not be lvalues. The compiler cannot check
3501 whether the operands have data types that are reasonable for the
3502 instruction being executed. It does not parse the assembler instruction
3503 template and does not know what it means or even whether it is valid
3504 assembler input. The extended @code{asm} feature is most often used for
3505 machine instructions the compiler itself does not know exist. If
3506 the output expression cannot be directly addressed (for example, it is a
3507 bit-field), your constraint must allow a register. In that case, GCC
3508 will use the register as the output of the @code{asm}, and then store
3509 that register into the output.
3510
3511 The ordinary output operands must be write-only; GCC will assume that
3512 the values in these operands before the instruction are dead and need
3513 not be generated. Extended asm supports input-output or read-write
3514 operands. Use the constraint character @samp{+} to indicate such an
3515 operand and list it with the output operands. You should only use
3516 read-write operands when the constraints for the operand (or the
3517 operand in which only some of the bits are to be changed) allow a
3518 register.
3519
3520 You may, as an alternative, logically split its function into two
3521 separate operands, one input operand and one write-only output
3522 operand. The connection between them is expressed by constraints
3523 which say they need to be in the same location when the instruction
3524 executes. You can use the same C expression for both operands, or
3525 different expressions. For example, here we write the (fictitious)
3526 @samp{combine} instruction with @code{bar} as its read-only source
3527 operand and @code{foo} as its read-write destination:
3528
3529 @smallexample
3530 asm ("combine %2,%0" : "=r" (foo) : "0" (foo), "g" (bar));
3531 @end smallexample
3532
3533 @noindent
3534 The constraint @samp{"0"} for operand 1 says that it must occupy the
3535 same location as operand 0. A number in constraint is allowed only in
3536 an input operand and it must refer to an output operand.
3537
3538 Only a number in the constraint can guarantee that one operand will be in
3539 the same place as another. The mere fact that @code{foo} is the value
3540 of both operands is not enough to guarantee that they will be in the
3541 same place in the generated assembler code. The following would not
3542 work reliably:
3543
3544 @smallexample
3545 asm ("combine %2,%0" : "=r" (foo) : "r" (foo), "g" (bar));
3546 @end smallexample
3547
3548 Various optimizations or reloading could cause operands 0 and 1 to be in
3549 different registers; GCC knows no reason not to do so. For example, the
3550 compiler might find a copy of the value of @code{foo} in one register and
3551 use it for operand 1, but generate the output operand 0 in a different
3552 register (copying it afterward to @code{foo}'s own address). Of course,
3553 since the register for operand 1 is not even mentioned in the assembler
3554 code, the result will not work, but GCC can't tell that.
3555
3556 As of GCC version 3.1, one may write @code{[@var{name}]} instead of
3557 the operand number for a matching constraint. For example:
3558
3559 @smallexample
3560 asm ("cmoveq %1,%2,%[result]"
3561 : [result] "=r"(result)
3562 : "r" (test), "r"(new), "[result]"(old));
3563 @end smallexample
3564
3565 Some instructions clobber specific hard registers. To describe this,
3566 write a third colon after the input operands, followed by the names of
3567 the clobbered hard registers (given as strings). Here is a realistic
3568 example for the VAX:
3569
3570 @smallexample
3571 asm volatile ("movc3 %0,%1,%2"
3572 : /* no outputs */
3573 : "g" (from), "g" (to), "g" (count)
3574 : "r0", "r1", "r2", "r3", "r4", "r5");
3575 @end smallexample
3576
3577 You may not write a clobber description in a way that overlaps with an
3578 input or output operand. For example, you may not have an operand
3579 describing a register class with one member if you mention that register
3580 in the clobber list. Variables declared to live in specific registers
3581 (@pxref{Explicit Reg Vars}), and used as asm input or output operands must
3582 have no part mentioned in the clobber description.
3583 There is no way for you to specify that an input
3584 operand is modified without also specifying it as an output
3585 operand. Note that if all the output operands you specify are for this
3586 purpose (and hence unused), you will then also need to specify
3587 @code{volatile} for the @code{asm} construct, as described below, to
3588 prevent GCC from deleting the @code{asm} statement as unused.
3589
3590 If you refer to a particular hardware register from the assembler code,
3591 you will probably have to list the register after the third colon to
3592 tell the compiler the register's value is modified. In some assemblers,
3593 the register names begin with @samp{%}; to produce one @samp{%} in the
3594 assembler code, you must write @samp{%%} in the input.
3595
3596 If your assembler instruction can alter the condition code register, add
3597 @samp{cc} to the list of clobbered registers. GCC on some machines
3598 represents the condition codes as a specific hardware register;
3599 @samp{cc} serves to name this register. On other machines, the
3600 condition code is handled differently, and specifying @samp{cc} has no
3601 effect. But it is valid no matter what the machine.
3602
3603 If your assembler instructions access memory in an unpredictable
3604 fashion, add @samp{memory} to the list of clobbered registers. This
3605 will cause GCC to not keep memory values cached in registers across the
3606 assembler instruction and not optimize stores or loads to that memory.
3607 You will also want to add the @code{volatile} keyword if the memory
3608 affected is not listed in the inputs or outputs of the @code{asm}, as
3609 the @samp{memory} clobber does not count as a side-effect of the
3610 @code{asm}. If you know how large the accessed memory is, you can add
3611 it as input or output but if this is not known, you should add
3612 @samp{memory}. As an example, if you access ten bytes of a string, you
3613 can use a memory input like:
3614
3615 @smallexample
3616 @{"m"( (@{ struct @{ char x[10]; @} *p = (void *)ptr ; *p; @}) )@}.
3617 @end smallexample
3618
3619 Note that in the following example the memory input is necessary,
3620 otherwise GCC might optimize the store to @code{x} away:
3621 @smallexample
3622 int foo ()
3623 @{
3624 int x = 42;
3625 int *y = &x;
3626 int result;
3627 asm ("magic stuff accessing an 'int' pointed to by '%1'"
3628 "=&d" (r) : "a" (y), "m" (*y));
3629 return result;
3630 @}
3631 @end smallexample
3632
3633 You can put multiple assembler instructions together in a single
3634 @code{asm} template, separated by the characters normally used in assembly
3635 code for the system. A combination that works in most places is a newline
3636 to break the line, plus a tab character to move to the instruction field
3637 (written as @samp{\n\t}). Sometimes semicolons can be used, if the
3638 assembler allows semicolons as a line-breaking character. Note that some
3639 assembler dialects use semicolons to start a comment.
3640 The input operands are guaranteed not to use any of the clobbered
3641 registers, and neither will the output operands' addresses, so you can
3642 read and write the clobbered registers as many times as you like. Here
3643 is an example of multiple instructions in a template; it assumes the
3644 subroutine @code{_foo} accepts arguments in registers 9 and 10:
3645
3646 @smallexample
3647 asm ("movl %0,r9\n\tmovl %1,r10\n\tcall _foo"
3648 : /* no outputs */
3649 : "g" (from), "g" (to)
3650 : "r9", "r10");
3651 @end smallexample
3652
3653 Unless an output operand has the @samp{&} constraint modifier, GCC
3654 may allocate it in the same register as an unrelated input operand, on
3655 the assumption the inputs are consumed before the outputs are produced.
3656 This assumption may be false if the assembler code actually consists of
3657 more than one instruction. In such a case, use @samp{&} for each output
3658 operand that may not overlap an input. @xref{Modifiers}.
3659
3660 If you want to test the condition code produced by an assembler
3661 instruction, you must include a branch and a label in the @code{asm}
3662 construct, as follows:
3663
3664 @smallexample
3665 asm ("clr %0\n\tfrob %1\n\tbeq 0f\n\tmov #1,%0\n0:"
3666 : "g" (result)
3667 : "g" (input));
3668 @end smallexample
3669
3670 @noindent
3671 This assumes your assembler supports local labels, as the GNU assembler
3672 and most Unix assemblers do.
3673
3674 Speaking of labels, jumps from one @code{asm} to another are not
3675 supported. The compiler's optimizers do not know about these jumps, and
3676 therefore they cannot take account of them when deciding how to
3677 optimize.
3678
3679 @cindex macros containing @code{asm}
3680 Usually the most convenient way to use these @code{asm} instructions is to
3681 encapsulate them in macros that look like functions. For example,
3682
3683 @smallexample
3684 #define sin(x) \
3685 (@{ double __value, __arg = (x); \
3686 asm ("fsinx %1,%0": "=f" (__value): "f" (__arg)); \
3687 __value; @})
3688 @end smallexample
3689
3690 @noindent
3691 Here the variable @code{__arg} is used to make sure that the instruction
3692 operates on a proper @code{double} value, and to accept only those
3693 arguments @code{x} which can convert automatically to a @code{double}.
3694
3695 Another way to make sure the instruction operates on the correct data
3696 type is to use a cast in the @code{asm}. This is different from using a
3697 variable @code{__arg} in that it converts more different types. For
3698 example, if the desired type were @code{int}, casting the argument to
3699 @code{int} would accept a pointer with no complaint, while assigning the
3700 argument to an @code{int} variable named @code{__arg} would warn about
3701 using a pointer unless the caller explicitly casts it.
3702
3703 If an @code{asm} has output operands, GCC assumes for optimization
3704 purposes the instruction has no side effects except to change the output
3705 operands. This does not mean instructions with a side effect cannot be
3706 used, but you must be careful, because the compiler may eliminate them
3707 if the output operands aren't used, or move them out of loops, or
3708 replace two with one if they constitute a common subexpression. Also,
3709 if your instruction does have a side effect on a variable that otherwise
3710 appears not to change, the old value of the variable may be reused later
3711 if it happens to be found in a register.
3712
3713 You can prevent an @code{asm} instruction from being deleted, moved
3714 significantly, or combined, by writing the keyword @code{volatile} after
3715 the @code{asm}. For example:
3716
3717 @smallexample
3718 #define get_and_set_priority(new) \
3719 (@{ int __old; \
3720 asm volatile ("get_and_set_priority %0, %1" \
3721 : "=g" (__old) : "g" (new)); \
3722 __old; @})
3723 @end smallexample
3724
3725 @noindent
3726 If you write an @code{asm} instruction with no outputs, GCC will know
3727 the instruction has side-effects and will not delete the instruction or
3728 move it outside of loops.
3729
3730 The @code{volatile} keyword indicates that the instruction has
3731 important side-effects. GCC will not delete a volatile @code{asm} if
3732 it is reachable. (The instruction can still be deleted if GCC can
3733 prove that control-flow will never reach the location of the
3734 instruction.) In addition, GCC will not reschedule instructions
3735 across a volatile @code{asm} instruction. For example:
3736
3737 @smallexample
3738 *(volatile int *)addr = foo;
3739 asm volatile ("eieio" : : );
3740 @end smallexample
3741
3742 @noindent
3743 Assume @code{addr} contains the address of a memory mapped device
3744 register. The PowerPC @code{eieio} instruction (Enforce In-order
3745 Execution of I/O) tells the CPU to make sure that the store to that
3746 device register happens before it issues any other I/O@.
3747
3748 Note that even a volatile @code{asm} instruction can be moved in ways
3749 that appear insignificant to the compiler, such as across jump
3750 instructions. You can't expect a sequence of volatile @code{asm}
3751 instructions to remain perfectly consecutive. If you want consecutive
3752 output, use a single @code{asm}. Also, GCC will perform some
3753 optimizations across a volatile @code{asm} instruction; GCC does not
3754 ``forget everything'' when it encounters a volatile @code{asm}
3755 instruction the way some other compilers do.
3756
3757 An @code{asm} instruction without any operands or clobbers (an ``old
3758 style'' @code{asm}) will be treated identically to a volatile
3759 @code{asm} instruction.
3760
3761 It is a natural idea to look for a way to give access to the condition
3762 code left by the assembler instruction. However, when we attempted to
3763 implement this, we found no way to make it work reliably. The problem
3764 is that output operands might need reloading, which would result in
3765 additional following ``store'' instructions. On most machines, these
3766 instructions would alter the condition code before there was time to
3767 test it. This problem doesn't arise for ordinary ``test'' and
3768 ``compare'' instructions because they don't have any output operands.
3769
3770 For reasons similar to those described above, it is not possible to give
3771 an assembler instruction access to the condition code left by previous
3772 instructions.
3773
3774 If you are writing a header file that should be includable in ISO C
3775 programs, write @code{__asm__} instead of @code{asm}. @xref{Alternate
3776 Keywords}.
3777
3778 @subsection Size of an @code{asm}
3779
3780 Some targets require that GCC track the size of each instruction used in
3781 order to generate correct code. Because the final length of an
3782 @code{asm} is only known by the assembler, GCC must make an estimate as
3783 to how big it will be. The estimate is formed by counting the number of
3784 statements in the pattern of the @code{asm} and multiplying that by the
3785 length of the longest instruction on that processor. Statements in the
3786 @code{asm} are identified by newline characters and whatever statement
3787 separator characters are supported by the assembler; on most processors
3788 this is the `@code{;}' character.
3789
3790 Normally, GCC's estimate is perfectly adequate to ensure that correct
3791 code is generated, but it is possible to confuse the compiler if you use
3792 pseudo instructions or assembler macros that expand into multiple real
3793 instructions or if you use assembler directives that expand to more
3794 space in the object file than would be needed for a single instruction.
3795 If this happens then the assembler will produce a diagnostic saying that
3796 a label is unreachable.
3797
3798 @subsection i386 floating point asm operands
3799
3800 There are several rules on the usage of stack-like regs in
3801 asm_operands insns. These rules apply only to the operands that are
3802 stack-like regs:
3803
3804 @enumerate
3805 @item
3806 Given a set of input regs that die in an asm_operands, it is
3807 necessary to know which are implicitly popped by the asm, and
3808 which must be explicitly popped by gcc.
3809
3810 An input reg that is implicitly popped by the asm must be
3811 explicitly clobbered, unless it is constrained to match an
3812 output operand.
3813
3814 @item
3815 For any input reg that is implicitly popped by an asm, it is
3816 necessary to know how to adjust the stack to compensate for the pop.
3817 If any non-popped input is closer to the top of the reg-stack than
3818 the implicitly popped reg, it would not be possible to know what the
3819 stack looked like---it's not clear how the rest of the stack ``slides
3820 up''.
3821
3822 All implicitly popped input regs must be closer to the top of
3823 the reg-stack than any input that is not implicitly popped.
3824
3825 It is possible that if an input dies in an insn, reload might
3826 use the input reg for an output reload. Consider this example:
3827
3828 @smallexample
3829 asm ("foo" : "=t" (a) : "f" (b));
3830 @end smallexample
3831
3832 This asm says that input B is not popped by the asm, and that
3833 the asm pushes a result onto the reg-stack, i.e., the stack is one
3834 deeper after the asm than it was before. But, it is possible that
3835 reload will think that it can use the same reg for both the input and
3836 the output, if input B dies in this insn.
3837
3838 If any input operand uses the @code{f} constraint, all output reg
3839 constraints must use the @code{&} earlyclobber.
3840
3841 The asm above would be written as
3842
3843 @smallexample
3844 asm ("foo" : "=&t" (a) : "f" (b));
3845 @end smallexample
3846
3847 @item
3848 Some operands need to be in particular places on the stack. All
3849 output operands fall in this category---there is no other way to
3850 know which regs the outputs appear in unless the user indicates
3851 this in the constraints.
3852
3853 Output operands must specifically indicate which reg an output
3854 appears in after an asm. @code{=f} is not allowed: the operand
3855 constraints must select a class with a single reg.
3856
3857 @item
3858 Output operands may not be ``inserted'' between existing stack regs.
3859 Since no 387 opcode uses a read/write operand, all output operands
3860 are dead before the asm_operands, and are pushed by the asm_operands.
3861 It makes no sense to push anywhere but the top of the reg-stack.
3862
3863 Output operands must start at the top of the reg-stack: output
3864 operands may not ``skip'' a reg.
3865
3866 @item
3867 Some asm statements may need extra stack space for internal
3868 calculations. This can be guaranteed by clobbering stack registers
3869 unrelated to the inputs and outputs.
3870
3871 @end enumerate
3872
3873 Here are a couple of reasonable asms to want to write. This asm
3874 takes one input, which is internally popped, and produces two outputs.
3875
3876 @smallexample
3877 asm ("fsincos" : "=t" (cos), "=u" (sin) : "0" (inp));
3878 @end smallexample
3879
3880 This asm takes two inputs, which are popped by the @code{fyl2xp1} opcode,
3881 and replaces them with one output. The user must code the @code{st(1)}
3882 clobber for reg-stack.c to know that @code{fyl2xp1} pops both inputs.
3883
3884 @smallexample
3885 asm ("fyl2xp1" : "=t" (result) : "0" (x), "u" (y) : "st(1)");
3886 @end smallexample
3887
3888 @include md.texi
3889
3890 @node Asm Labels
3891 @section Controlling Names Used in Assembler Code
3892 @cindex assembler names for identifiers
3893 @cindex names used in assembler code
3894 @cindex identifiers, names in assembler code
3895
3896 You can specify the name to be used in the assembler code for a C
3897 function or variable by writing the @code{asm} (or @code{__asm__})
3898 keyword after the declarator as follows:
3899
3900 @smallexample
3901 int foo asm ("myfoo") = 2;
3902 @end smallexample
3903
3904 @noindent
3905 This specifies that the name to be used for the variable @code{foo} in
3906 the assembler code should be @samp{myfoo} rather than the usual
3907 @samp{_foo}.
3908
3909 On systems where an underscore is normally prepended to the name of a C
3910 function or variable, this feature allows you to define names for the
3911 linker that do not start with an underscore.
3912
3913 It does not make sense to use this feature with a non-static local
3914 variable since such variables do not have assembler names. If you are
3915 trying to put the variable in a particular register, see @ref{Explicit
3916 Reg Vars}. GCC presently accepts such code with a warning, but will
3917 probably be changed to issue an error, rather than a warning, in the
3918 future.
3919
3920 You cannot use @code{asm} in this way in a function @emph{definition}; but
3921 you can get the same effect by writing a declaration for the function
3922 before its definition and putting @code{asm} there, like this:
3923
3924 @smallexample
3925 extern func () asm ("FUNC");
3926
3927 func (x, y)
3928 int x, y;
3929 /* @r{@dots{}} */
3930 @end smallexample
3931
3932 It is up to you to make sure that the assembler names you choose do not
3933 conflict with any other assembler symbols. Also, you must not use a
3934 register name; that would produce completely invalid assembler code. GCC
3935 does not as yet have the ability to store static variables in registers.
3936 Perhaps that will be added.
3937
3938 @node Explicit Reg Vars
3939 @section Variables in Specified Registers
3940 @cindex explicit register variables
3941 @cindex variables in specified registers
3942 @cindex specified registers
3943 @cindex registers, global allocation
3944
3945 GNU C allows you to put a few global variables into specified hardware
3946 registers. You can also specify the register in which an ordinary
3947 register variable should be allocated.
3948
3949 @itemize @bullet
3950 @item
3951 Global register variables reserve registers throughout the program.
3952 This may be useful in programs such as programming language
3953 interpreters which have a couple of global variables that are accessed
3954 very often.
3955
3956 @item
3957 Local register variables in specific registers do not reserve the
3958 registers. The compiler's data flow analysis is capable of determining
3959 where the specified registers contain live values, and where they are
3960 available for other uses. Stores into local register variables may be deleted
3961 when they appear to be dead according to dataflow analysis. References
3962 to local register variables may be deleted or moved or simplified.
3963
3964 These local variables are sometimes convenient for use with the extended
3965 @code{asm} feature (@pxref{Extended Asm}), if you want to write one
3966 output of the assembler instruction directly into a particular register.
3967 (This will work provided the register you specify fits the constraints
3968 specified for that operand in the @code{asm}.)
3969 @end itemize
3970
3971 @menu
3972 * Global Reg Vars::
3973 * Local Reg Vars::
3974 @end menu
3975
3976 @node Global Reg Vars
3977 @subsection Defining Global Register Variables
3978 @cindex global register variables
3979 @cindex registers, global variables in
3980
3981 You can define a global register variable in GNU C like this:
3982
3983 @smallexample
3984 register int *foo asm ("a5");
3985 @end smallexample
3986
3987 @noindent
3988 Here @code{a5} is the name of the register which should be used. Choose a
3989 register which is normally saved and restored by function calls on your
3990 machine, so that library routines will not clobber it.
3991
3992 Naturally the register name is cpu-dependent, so you would need to
3993 conditionalize your program according to cpu type. The register
3994 @code{a5} would be a good choice on a 68000 for a variable of pointer
3995 type. On machines with register windows, be sure to choose a ``global''
3996 register that is not affected magically by the function call mechanism.
3997
3998 In addition, operating systems on one type of cpu may differ in how they
3999 name the registers; then you would need additional conditionals. For
4000 example, some 68000 operating systems call this register @code{%a5}.
4001
4002 Eventually there may be a way of asking the compiler to choose a register
4003 automatically, but first we need to figure out how it should choose and
4004 how to enable you to guide the choice. No solution is evident.
4005
4006 Defining a global register variable in a certain register reserves that
4007 register entirely for this use, at least within the current compilation.
4008 The register will not be allocated for any other purpose in the functions
4009 in the current compilation. The register will not be saved and restored by
4010 these functions. Stores into this register are never deleted even if they
4011 would appear to be dead, but references may be deleted or moved or
4012 simplified.
4013
4014 It is not safe to access the global register variables from signal
4015 handlers, or from more than one thread of control, because the system
4016 library routines may temporarily use the register for other things (unless
4017 you recompile them specially for the task at hand).
4018
4019 @cindex @code{qsort}, and global register variables
4020 It is not safe for one function that uses a global register variable to
4021 call another such function @code{foo} by way of a third function
4022 @code{lose} that was compiled without knowledge of this variable (i.e.@: in a
4023 different source file in which the variable wasn't declared). This is
4024 because @code{lose} might save the register and put some other value there.
4025 For example, you can't expect a global register variable to be available in
4026 the comparison-function that you pass to @code{qsort}, since @code{qsort}
4027 might have put something else in that register. (If you are prepared to
4028 recompile @code{qsort} with the same global register variable, you can
4029 solve this problem.)
4030
4031 If you want to recompile @code{qsort} or other source files which do not
4032 actually use your global register variable, so that they will not use that
4033 register for any other purpose, then it suffices to specify the compiler
4034 option @option{-ffixed-@var{reg}}. You need not actually add a global
4035 register declaration to their source code.
4036
4037 A function which can alter the value of a global register variable cannot
4038 safely be called from a function compiled without this variable, because it
4039 could clobber the value the caller expects to find there on return.
4040 Therefore, the function which is the entry point into the part of the
4041 program that uses the global register variable must explicitly save and
4042 restore the value which belongs to its caller.
4043
4044 @cindex register variable after @code{longjmp}
4045 @cindex global register after @code{longjmp}
4046 @cindex value after @code{longjmp}
4047 @findex longjmp
4048 @findex setjmp
4049 On most machines, @code{longjmp} will restore to each global register
4050 variable the value it had at the time of the @code{setjmp}. On some
4051 machines, however, @code{longjmp} will not change the value of global
4052 register variables. To be portable, the function that called @code{setjmp}
4053 should make other arrangements to save the values of the global register
4054 variables, and to restore them in a @code{longjmp}. This way, the same
4055 thing will happen regardless of what @code{longjmp} does.
4056
4057 All global register variable declarations must precede all function
4058 definitions. If such a declaration could appear after function
4059 definitions, the declaration would be too late to prevent the register from
4060 being used for other purposes in the preceding functions.
4061
4062 Global register variables may not have initial values, because an
4063 executable file has no means to supply initial contents for a register.
4064
4065 On the SPARC, there are reports that g3 @dots{} g7 are suitable
4066 registers, but certain library functions, such as @code{getwd}, as well
4067 as the subroutines for division and remainder, modify g3 and g4. g1 and
4068 g2 are local temporaries.
4069
4070 On the 68000, a2 @dots{} a5 should be suitable, as should d2 @dots{} d7.
4071 Of course, it will not do to use more than a few of those.
4072
4073 @node Local Reg Vars
4074 @subsection Specifying Registers for Local Variables
4075 @cindex local variables, specifying registers
4076 @cindex specifying registers for local variables
4077 @cindex registers for local variables
4078
4079 You can define a local register variable with a specified register
4080 like this:
4081
4082 @smallexample
4083 register int *foo asm ("a5");
4084 @end smallexample
4085
4086 @noindent
4087 Here @code{a5} is the name of the register which should be used. Note
4088 that this is the same syntax used for defining global register
4089 variables, but for a local variable it would appear within a function.
4090
4091 Naturally the register name is cpu-dependent, but this is not a
4092 problem, since specific registers are most often useful with explicit
4093 assembler instructions (@pxref{Extended Asm}). Both of these things
4094 generally require that you conditionalize your program according to
4095 cpu type.
4096
4097 In addition, operating systems on one type of cpu may differ in how they
4098 name the registers; then you would need additional conditionals. For
4099 example, some 68000 operating systems call this register @code{%a5}.
4100
4101 Defining such a register variable does not reserve the register; it
4102 remains available for other uses in places where flow control determines
4103 the variable's value is not live.
4104
4105 This option does not guarantee that GCC will generate code that has
4106 this variable in the register you specify at all times. You may not
4107 code an explicit reference to this register in an @code{asm} statement
4108 and assume it will always refer to this variable.
4109
4110 Stores into local register variables may be deleted when they appear to be dead
4111 according to dataflow analysis. References to local register variables may
4112 be deleted or moved or simplified.
4113
4114 @node Alternate Keywords
4115 @section Alternate Keywords
4116 @cindex alternate keywords
4117 @cindex keywords, alternate
4118
4119 @option{-ansi} and the various @option{-std} options disable certain
4120 keywords. This causes trouble when you want to use GNU C extensions, or
4121 a general-purpose header file that should be usable by all programs,
4122 including ISO C programs. The keywords @code{asm}, @code{typeof} and
4123 @code{inline} are not available in programs compiled with
4124 @option{-ansi} or @option{-std} (although @code{inline} can be used in a
4125 program compiled with @option{-std=c99}). The ISO C99 keyword
4126 @code{restrict} is only available when @option{-std=gnu99} (which will
4127 eventually be the default) or @option{-std=c99} (or the equivalent
4128 @option{-std=iso9899:1999}) is used.
4129
4130 The way to solve these problems is to put @samp{__} at the beginning and
4131 end of each problematical keyword. For example, use @code{__asm__}
4132 instead of @code{asm}, and @code{__inline__} instead of @code{inline}.
4133
4134 Other C compilers won't accept these alternative keywords; if you want to
4135 compile with another compiler, you can define the alternate keywords as
4136 macros to replace them with the customary keywords. It looks like this:
4137
4138 @smallexample
4139 #ifndef __GNUC__
4140 #define __asm__ asm
4141 #endif
4142 @end smallexample
4143
4144 @findex __extension__
4145 @opindex pedantic
4146 @option{-pedantic} and other options cause warnings for many GNU C extensions.
4147 You can
4148 prevent such warnings within one expression by writing
4149 @code{__extension__} before the expression. @code{__extension__} has no
4150 effect aside from this.
4151
4152 @node Incomplete Enums
4153 @section Incomplete @code{enum} Types
4154
4155 You can define an @code{enum} tag without specifying its possible values.
4156 This results in an incomplete type, much like what you get if you write
4157 @code{struct foo} without describing the elements. A later declaration
4158 which does specify the possible values completes the type.
4159
4160 You can't allocate variables or storage using the type while it is
4161 incomplete. However, you can work with pointers to that type.
4162
4163 This extension may not be very useful, but it makes the handling of
4164 @code{enum} more consistent with the way @code{struct} and @code{union}
4165 are handled.
4166
4167 This extension is not supported by GNU C++.
4168
4169 @node Function Names
4170 @section Function Names as Strings
4171 @cindex @code{__func__} identifier
4172 @cindex @code{__FUNCTION__} identifier
4173 @cindex @code{__PRETTY_FUNCTION__} identifier
4174
4175 GCC provides three magic variables which hold the name of the current
4176 function, as a string. The first of these is @code{__func__}, which
4177 is part of the C99 standard:
4178
4179 @display
4180 The identifier @code{__func__} is implicitly declared by the translator
4181 as if, immediately following the opening brace of each function
4182 definition, the declaration
4183
4184 @smallexample
4185 static const char __func__[] = "function-name";
4186 @end smallexample
4187
4188 appeared, where function-name is the name of the lexically-enclosing
4189 function. This name is the unadorned name of the function.
4190 @end display
4191
4192 @code{__FUNCTION__} is another name for @code{__func__}. Older
4193 versions of GCC recognize only this name. However, it is not
4194 standardized. For maximum portability, we recommend you use
4195 @code{__func__}, but provide a fallback definition with the
4196 preprocessor:
4197
4198 @smallexample
4199 #if __STDC_VERSION__ < 199901L
4200 # if __GNUC__ >= 2
4201 # define __func__ __FUNCTION__
4202 # else
4203 # define __func__ "<unknown>"
4204 # endif
4205 #endif
4206 @end smallexample
4207
4208 In C, @code{__PRETTY_FUNCTION__} is yet another name for
4209 @code{__func__}. However, in C++, @code{__PRETTY_FUNCTION__} contains
4210 the type signature of the function as well as its bare name. For
4211 example, this program:
4212
4213 @smallexample
4214 extern "C" @{
4215 extern int printf (char *, ...);
4216 @}
4217
4218 class a @{
4219 public:
4220 void sub (int i)
4221 @{
4222 printf ("__FUNCTION__ = %s\n", __FUNCTION__);
4223 printf ("__PRETTY_FUNCTION__ = %s\n", __PRETTY_FUNCTION__);
4224 @}
4225 @};
4226
4227 int
4228 main (void)
4229 @{
4230 a ax;
4231 ax.sub (0);
4232 return 0;
4233 @}
4234 @end smallexample
4235
4236 @noindent
4237 gives this output:
4238
4239 @smallexample
4240 __FUNCTION__ = sub
4241 __PRETTY_FUNCTION__ = void a::sub(int)
4242 @end smallexample
4243
4244 These identifiers are not preprocessor macros. In GCC 3.3 and
4245 earlier, in C only, @code{__FUNCTION__} and @code{__PRETTY_FUNCTION__}
4246 were treated as string literals; they could be used to initialize
4247 @code{char} arrays, and they could be concatenated with other string
4248 literals. GCC 3.4 and later treat them as variables, like
4249 @code{__func__}. In C++, @code{__FUNCTION__} and
4250 @code{__PRETTY_FUNCTION__} have always been variables.
4251
4252 @node Return Address
4253 @section Getting the Return or Frame Address of a Function
4254
4255 These functions may be used to get information about the callers of a
4256 function.
4257
4258 @deftypefn {Built-in Function} {void *} __builtin_return_address (unsigned int @var{level})
4259 This function returns the return address of the current function, or of
4260 one of its callers. The @var{level} argument is number of frames to
4261 scan up the call stack. A value of @code{0} yields the return address
4262 of the current function, a value of @code{1} yields the return address
4263 of the caller of the current function, and so forth. When inlining
4264 the expected behavior is that the function will return the address of
4265 the function that will be returned to. To work around this behavior use
4266 the @code{noinline} function attribute.
4267
4268 The @var{level} argument must be a constant integer.
4269
4270 On some machines it may be impossible to determine the return address of
4271 any function other than the current one; in such cases, or when the top
4272 of the stack has been reached, this function will return @code{0} or a
4273 random value. In addition, @code{__builtin_frame_address} may be used
4274 to determine if the top of the stack has been reached.
4275
4276 This function should only be used with a nonzero argument for debugging
4277 purposes.
4278 @end deftypefn
4279
4280 @deftypefn {Built-in Function} {void *} __builtin_frame_address (unsigned int @var{level})
4281 This function is similar to @code{__builtin_return_address}, but it
4282 returns the address of the function frame rather than the return address
4283 of the function. Calling @code{__builtin_frame_address} with a value of
4284 @code{0} yields the frame address of the current function, a value of
4285 @code{1} yields the frame address of the caller of the current function,
4286 and so forth.
4287
4288 The frame is the area on the stack which holds local variables and saved
4289 registers. The frame address is normally the address of the first word
4290 pushed on to the stack by the function. However, the exact definition
4291 depends upon the processor and the calling convention. If the processor
4292 has a dedicated frame pointer register, and the function has a frame,
4293 then @code{__builtin_frame_address} will return the value of the frame
4294 pointer register.
4295
4296 On some machines it may be impossible to determine the frame address of
4297 any function other than the current one; in such cases, or when the top
4298 of the stack has been reached, this function will return @code{0} if
4299 the first frame pointer is properly initialized by the startup code.
4300
4301 This function should only be used with a nonzero argument for debugging
4302 purposes.
4303 @end deftypefn
4304
4305 @node Vector Extensions
4306 @section Using vector instructions through built-in functions
4307
4308 On some targets, the instruction set contains SIMD vector instructions that
4309 operate on multiple values contained in one large register at the same time.
4310 For example, on the i386 the MMX, 3Dnow! and SSE extensions can be used
4311 this way.
4312
4313 The first step in using these extensions is to provide the necessary data
4314 types. This should be done using an appropriate @code{typedef}:
4315
4316 @smallexample
4317 typedef int v4si __attribute__ ((vector_size (16)));
4318 @end smallexample
4319
4320 The @code{int} type specifies the base type, while the attribute specifies
4321 the vector size for the variable, measured in bytes. For example, the
4322 declaration above causes the compiler to set the mode for the @code{v4si}
4323 type to be 16 bytes wide and divided into @code{int} sized units. For
4324 a 32-bit @code{int} this means a vector of 4 units of 4 bytes, and the
4325 corresponding mode of @code{foo} will be @acronym{V4SI}.
4326
4327 The @code{vector_size} attribute is only applicable to integral and
4328 float scalars, although arrays, pointers, and function return values
4329 are allowed in conjunction with this construct.
4330
4331 All the basic integer types can be used as base types, both as signed
4332 and as unsigned: @code{char}, @code{short}, @code{int}, @code{long},
4333 @code{long long}. In addition, @code{float} and @code{double} can be
4334 used to build floating-point vector types.
4335
4336 Specifying a combination that is not valid for the current architecture
4337 will cause GCC to synthesize the instructions using a narrower mode.
4338 For example, if you specify a variable of type @code{V4SI} and your
4339 architecture does not allow for this specific SIMD type, GCC will
4340 produce code that uses 4 @code{SIs}.
4341
4342 The types defined in this manner can be used with a subset of normal C
4343 operations. Currently, GCC will allow using the following operators
4344 on these types: @code{+, -, *, /, unary minus, ^, |, &, ~}@.
4345
4346 The operations behave like C++ @code{valarrays}. Addition is defined as
4347 the addition of the corresponding elements of the operands. For
4348 example, in the code below, each of the 4 elements in @var{a} will be
4349 added to the corresponding 4 elements in @var{b} and the resulting
4350 vector will be stored in @var{c}.
4351
4352 @smallexample
4353 typedef int v4si __attribute__ ((vector_size (16)));
4354
4355 v4si a, b, c;
4356
4357 c = a + b;
4358 @end smallexample
4359
4360 Subtraction, multiplication, division, and the logical operations
4361 operate in a similar manner. Likewise, the result of using the unary
4362 minus or complement operators on a vector type is a vector whose
4363 elements are the negative or complemented values of the corresponding
4364 elements in the operand.
4365
4366 You can declare variables and use them in function calls and returns, as
4367 well as in assignments and some casts. You can specify a vector type as
4368 a return type for a function. Vector types can also be used as function
4369 arguments. It is possible to cast from one vector type to another,
4370 provided they are of the same size (in fact, you can also cast vectors
4371 to and from other datatypes of the same size).
4372
4373 You cannot operate between vectors of different lengths or different
4374 signedness without a cast.
4375
4376 A port that supports hardware vector operations, usually provides a set
4377 of built-in functions that can be used to operate on vectors. For
4378 example, a function to add two vectors and multiply the result by a
4379 third could look like this:
4380
4381 @smallexample
4382 v4si f (v4si a, v4si b, v4si c)
4383 @{
4384 v4si tmp = __builtin_addv4si (a, b);
4385 return __builtin_mulv4si (tmp, c);
4386 @}
4387
4388 @end smallexample
4389
4390 @node Offsetof
4391 @section Offsetof
4392 @findex __builtin_offsetof
4393
4394 GCC implements for both C and C++ a syntactic extension to implement
4395 the @code{offsetof} macro.
4396
4397 @smallexample
4398 primary:
4399 "__builtin_offsetof" "(" @code{typename} "," offsetof_member_designator ")"
4400
4401 offsetof_member_designator:
4402 @code{identifier}
4403 | offsetof_member_designator "." @code{identifier}
4404 | offsetof_member_designator "[" @code{expr} "]"
4405 @end smallexample
4406
4407 This extension is sufficient such that
4408
4409 @smallexample
4410 #define offsetof(@var{type}, @var{member}) __builtin_offsetof (@var{type}, @var{member})
4411 @end smallexample
4412
4413 is a suitable definition of the @code{offsetof} macro. In C++, @var{type}
4414 may be dependent. In either case, @var{member} may consist of a single
4415 identifier, or a sequence of member accesses and array references.
4416
4417 @node Other Builtins
4418 @section Other built-in functions provided by GCC
4419 @cindex built-in functions
4420 @findex __builtin_isgreater
4421 @findex __builtin_isgreaterequal
4422 @findex __builtin_isless
4423 @findex __builtin_islessequal
4424 @findex __builtin_islessgreater
4425 @findex __builtin_isunordered
4426 @findex _Exit
4427 @findex _exit
4428 @findex abort
4429 @findex abs
4430 @findex acos
4431 @findex acosf
4432 @findex acosh
4433 @findex acoshf
4434 @findex acoshl
4435 @findex acosl
4436 @findex alloca
4437 @findex asin
4438 @findex asinf
4439 @findex asinh
4440 @findex asinhf
4441 @findex asinhl
4442 @findex asinl
4443 @findex atan
4444 @findex atan2
4445 @findex atan2f
4446 @findex atan2l
4447 @findex atanf
4448 @findex atanh
4449 @findex atanhf
4450 @findex atanhl
4451 @findex atanl
4452 @findex bcmp
4453 @findex bzero
4454 @findex cabs
4455 @findex cabsf
4456 @findex cabsl
4457 @findex cacos
4458 @findex cacosf
4459 @findex cacosh
4460 @findex cacoshf
4461 @findex cacoshl
4462 @findex cacosl
4463 @findex calloc
4464 @findex carg
4465 @findex cargf
4466 @findex cargl
4467 @findex casin
4468 @findex casinf
4469 @findex casinh
4470 @findex casinhf
4471 @findex casinhl
4472 @findex casinl
4473 @findex catan
4474 @findex catanf
4475 @findex catanh
4476 @findex catanhf
4477 @findex catanhl
4478 @findex catanl
4479 @findex cbrt
4480 @findex cbrtf
4481 @findex cbrtl
4482 @findex ccos
4483 @findex ccosf
4484 @findex ccosh
4485 @findex ccoshf
4486 @findex ccoshl
4487 @findex ccosl
4488 @findex ceil
4489 @findex ceilf
4490 @findex ceill
4491 @findex cexp
4492 @findex cexpf
4493 @findex cexpl
4494 @findex cimag
4495 @findex cimagf
4496 @findex cimagl
4497 @findex conj
4498 @findex conjf
4499 @findex conjl
4500 @findex copysign
4501 @findex copysignf
4502 @findex copysignl
4503 @findex cos
4504 @findex cosf
4505 @findex cosh
4506 @findex coshf
4507 @findex coshl
4508 @findex cosl
4509 @findex cpow
4510 @findex cpowf
4511 @findex cpowl
4512 @findex cproj
4513 @findex cprojf
4514 @findex cprojl
4515 @findex creal
4516 @findex crealf
4517 @findex creall
4518 @findex csin
4519 @findex csinf
4520 @findex csinh
4521 @findex csinhf
4522 @findex csinhl
4523 @findex csinl
4524 @findex csqrt
4525 @findex csqrtf
4526 @findex csqrtl
4527 @findex ctan
4528 @findex ctanf
4529 @findex ctanh
4530 @findex ctanhf
4531 @findex ctanhl
4532 @findex ctanl
4533 @findex dcgettext
4534 @findex dgettext
4535 @findex drem
4536 @findex dremf
4537 @findex dreml
4538 @findex erf
4539 @findex erfc
4540 @findex erfcf
4541 @findex erfcl
4542 @findex erff
4543 @findex erfl
4544 @findex exit
4545 @findex exp
4546 @findex exp10
4547 @findex exp10f
4548 @findex exp10l
4549 @findex exp2
4550 @findex exp2f
4551 @findex exp2l
4552 @findex expf
4553 @findex expl
4554 @findex expm1
4555 @findex expm1f
4556 @findex expm1l
4557 @findex fabs
4558 @findex fabsf
4559 @findex fabsl
4560 @findex fdim
4561 @findex fdimf
4562 @findex fdiml
4563 @findex ffs
4564 @findex floor
4565 @findex floorf
4566 @findex floorl
4567 @findex fma
4568 @findex fmaf
4569 @findex fmal
4570 @findex fmax
4571 @findex fmaxf
4572 @findex fmaxl
4573 @findex fmin
4574 @findex fminf
4575 @findex fminl
4576 @findex fmod
4577 @findex fmodf
4578 @findex fmodl
4579 @findex fprintf
4580 @findex fprintf_unlocked
4581 @findex fputs
4582 @findex fputs_unlocked
4583 @findex frexp
4584 @findex frexpf
4585 @findex frexpl
4586 @findex fscanf
4587 @findex gamma
4588 @findex gammaf
4589 @findex gammal
4590 @findex gettext
4591 @findex hypot
4592 @findex hypotf
4593 @findex hypotl
4594 @findex ilogb
4595 @findex ilogbf
4596 @findex ilogbl
4597 @findex imaxabs
4598 @findex index
4599 @findex isalnum
4600 @findex isalpha
4601 @findex isascii
4602 @findex isblank
4603 @findex iscntrl
4604 @findex isdigit
4605 @findex isgraph
4606 @findex islower
4607 @findex isprint
4608 @findex ispunct
4609 @findex isspace
4610 @findex isupper
4611 @findex iswalnum
4612 @findex iswalpha
4613 @findex iswblank
4614 @findex iswcntrl
4615 @findex iswdigit
4616 @findex iswgraph
4617 @findex iswlower
4618 @findex iswprint
4619 @findex iswpunct
4620 @findex iswspace
4621 @findex iswupper
4622 @findex iswxdigit
4623 @findex isxdigit
4624 @findex j0
4625 @findex j0f
4626 @findex j0l
4627 @findex j1
4628 @findex j1f
4629 @findex j1l
4630 @findex jn
4631 @findex jnf
4632 @findex jnl
4633 @findex labs
4634 @findex ldexp
4635 @findex ldexpf
4636 @findex ldexpl
4637 @findex lgamma
4638 @findex lgammaf
4639 @findex lgammal
4640 @findex llabs
4641 @findex llrint
4642 @findex llrintf
4643 @findex llrintl
4644 @findex llround
4645 @findex llroundf
4646 @findex llroundl
4647 @findex log
4648 @findex log10
4649 @findex log10f
4650 @findex log10l
4651 @findex log1p
4652 @findex log1pf
4653 @findex log1pl
4654 @findex log2
4655 @findex log2f
4656 @findex log2l
4657 @findex logb
4658 @findex logbf
4659 @findex logbl
4660 @findex logf
4661 @findex logl
4662 @findex lrint
4663 @findex lrintf
4664 @findex lrintl
4665 @findex lround
4666 @findex lroundf
4667 @findex lroundl
4668 @findex malloc
4669 @findex memcmp
4670 @findex memcpy
4671 @findex mempcpy
4672 @findex memset
4673 @findex modf
4674 @findex modff
4675 @findex modfl
4676 @findex nearbyint
4677 @findex nearbyintf
4678 @findex nearbyintl
4679 @findex nextafter
4680 @findex nextafterf
4681 @findex nextafterl
4682 @findex nexttoward
4683 @findex nexttowardf
4684 @findex nexttowardl
4685 @findex pow
4686 @findex pow10
4687 @findex pow10f
4688 @findex pow10l
4689 @findex powf
4690 @findex powl
4691 @findex printf
4692 @findex printf_unlocked
4693 @findex putchar
4694 @findex puts
4695 @findex remainder
4696 @findex remainderf
4697 @findex remainderl
4698 @findex remquo
4699 @findex remquof
4700 @findex remquol
4701 @findex rindex
4702 @findex rint
4703 @findex rintf
4704 @findex rintl
4705 @findex round
4706 @findex roundf
4707 @findex roundl
4708 @findex scalb
4709 @findex scalbf
4710 @findex scalbl
4711 @findex scalbln
4712 @findex scalblnf
4713 @findex scalblnf
4714 @findex scalbn
4715 @findex scalbnf
4716 @findex scanfnl
4717 @findex signbit
4718 @findex signbitf
4719 @findex signbitl
4720 @findex significand
4721 @findex significandf
4722 @findex significandl
4723 @findex sin
4724 @findex sincos
4725 @findex sincosf
4726 @findex sincosl
4727 @findex sinf
4728 @findex sinh
4729 @findex sinhf
4730 @findex sinhl
4731 @findex sinl
4732 @findex snprintf
4733 @findex sprintf
4734 @findex sqrt
4735 @findex sqrtf
4736 @findex sqrtl
4737 @findex sscanf
4738 @findex stpcpy
4739 @findex strcat
4740 @findex strchr
4741 @findex strcmp
4742 @findex strcpy
4743 @findex strcspn
4744 @findex strdup
4745 @findex strfmon
4746 @findex strftime
4747 @findex strlen
4748 @findex strncat
4749 @findex strncmp
4750 @findex strncpy
4751 @findex strpbrk
4752 @findex strrchr
4753 @findex strspn
4754 @findex strstr
4755 @findex tan
4756 @findex tanf
4757 @findex tanh
4758 @findex tanhf
4759 @findex tanhl
4760 @findex tanl
4761 @findex tgamma
4762 @findex tgammaf
4763 @findex tgammal
4764 @findex toascii
4765 @findex tolower
4766 @findex toupper
4767 @findex towlower
4768 @findex towupper
4769 @findex trunc
4770 @findex truncf
4771 @findex truncl
4772 @findex vfprintf
4773 @findex vfscanf
4774 @findex vprintf
4775 @findex vscanf
4776 @findex vsnprintf
4777 @findex vsprintf
4778 @findex vsscanf
4779 @findex y0
4780 @findex y0f
4781 @findex y0l
4782 @findex y1
4783 @findex y1f
4784 @findex y1l
4785 @findex yn
4786 @findex ynf
4787 @findex ynl
4788
4789 GCC provides a large number of built-in functions other than the ones
4790 mentioned above. Some of these are for internal use in the processing
4791 of exceptions or variable-length argument lists and will not be
4792 documented here because they may change from time to time; we do not
4793 recommend general use of these functions.
4794
4795 The remaining functions are provided for optimization purposes.
4796
4797 @opindex fno-builtin
4798 GCC includes built-in versions of many of the functions in the standard
4799 C library. The versions prefixed with @code{__builtin_} will always be
4800 treated as having the same meaning as the C library function even if you
4801 specify the @option{-fno-builtin} option. (@pxref{C Dialect Options})
4802 Many of these functions are only optimized in certain cases; if they are
4803 not optimized in a particular case, a call to the library function will
4804 be emitted.
4805
4806 @opindex ansi
4807 @opindex std
4808 Outside strict ISO C mode (@option{-ansi}, @option{-std=c89} or
4809 @option{-std=c99}), the functions
4810 @code{_exit}, @code{alloca}, @code{bcmp}, @code{bzero},
4811 @code{dcgettext}, @code{dgettext}, @code{dremf}, @code{dreml},
4812 @code{drem}, @code{exp10f}, @code{exp10l}, @code{exp10}, @code{ffsll},
4813 @code{ffsl}, @code{ffs}, @code{fprintf_unlocked}, @code{fputs_unlocked},
4814 @code{gammaf}, @code{gammal}, @code{gamma}, @code{gettext},
4815 @code{index}, @code{isascii}, @code{j0f}, @code{j0l}, @code{j0},
4816 @code{j1f}, @code{j1l}, @code{j1}, @code{jnf}, @code{jnl}, @code{jn},
4817 @code{mempcpy}, @code{pow10f}, @code{pow10l}, @code{pow10},
4818 @code{printf_unlocked}, @code{rindex}, @code{scalbf}, @code{scalbl},
4819 @code{scalb}, @code{signbit}, @code{signbitf}, @code{signbitl},
4820 @code{significandf}, @code{significandl}, @code{significand},
4821 @code{sincosf}, @code{sincosl}, @code{sincos}, @code{stpcpy},
4822 @code{strdup}, @code{strfmon}, @code{toascii}, @code{y0f}, @code{y0l},
4823 @code{y0}, @code{y1f}, @code{y1l}, @code{y1}, @code{ynf}, @code{ynl} and
4824 @code{yn}
4825 may be handled as built-in functions.
4826 All these functions have corresponding versions
4827 prefixed with @code{__builtin_}, which may be used even in strict C89
4828 mode.
4829
4830 The ISO C99 functions
4831 @code{_Exit}, @code{acoshf}, @code{acoshl}, @code{acosh}, @code{asinhf},
4832 @code{asinhl}, @code{asinh}, @code{atanhf}, @code{atanhl}, @code{atanh},
4833 @code{cabsf}, @code{cabsl}, @code{cabs}, @code{cacosf}, @code{cacoshf},
4834 @code{cacoshl}, @code{cacosh}, @code{cacosl}, @code{cacos},
4835 @code{cargf}, @code{cargl}, @code{carg}, @code{casinf}, @code{casinhf},
4836 @code{casinhl}, @code{casinh}, @code{casinl}, @code{casin},
4837 @code{catanf}, @code{catanhf}, @code{catanhl}, @code{catanh},
4838 @code{catanl}, @code{catan}, @code{cbrtf}, @code{cbrtl}, @code{cbrt},
4839 @code{ccosf}, @code{ccoshf}, @code{ccoshl}, @code{ccosh}, @code{ccosl},
4840 @code{ccos}, @code{cexpf}, @code{cexpl}, @code{cexp}, @code{cimagf},
4841 @code{cimagl}, @code{cimag}, @code{conjf}, @code{conjl}, @code{conj},
4842 @code{copysignf}, @code{copysignl}, @code{copysign}, @code{cpowf},
4843 @code{cpowl}, @code{cpow}, @code{cprojf}, @code{cprojl}, @code{cproj},
4844 @code{crealf}, @code{creall}, @code{creal}, @code{csinf}, @code{csinhf},
4845 @code{csinhl}, @code{csinh}, @code{csinl}, @code{csin}, @code{csqrtf},
4846 @code{csqrtl}, @code{csqrt}, @code{ctanf}, @code{ctanhf}, @code{ctanhl},
4847 @code{ctanh}, @code{ctanl}, @code{ctan}, @code{erfcf}, @code{erfcl},
4848 @code{erfc}, @code{erff}, @code{erfl}, @code{erf}, @code{exp2f},
4849 @code{exp2l}, @code{exp2}, @code{expm1f}, @code{expm1l}, @code{expm1},
4850 @code{fdimf}, @code{fdiml}, @code{fdim}, @code{fmaf}, @code{fmal},
4851 @code{fmaxf}, @code{fmaxl}, @code{fmax}, @code{fma}, @code{fminf},
4852 @code{fminl}, @code{fmin}, @code{hypotf}, @code{hypotl}, @code{hypot},
4853 @code{ilogbf}, @code{ilogbl}, @code{ilogb}, @code{imaxabs},
4854 @code{isblank}, @code{iswblank}, @code{lgammaf}, @code{lgammal},
4855 @code{lgamma}, @code{llabs}, @code{llrintf}, @code{llrintl},
4856 @code{llrint}, @code{llroundf}, @code{llroundl}, @code{llround},
4857 @code{log1pf}, @code{log1pl}, @code{log1p}, @code{log2f}, @code{log2l},
4858 @code{log2}, @code{logbf}, @code{logbl}, @code{logb}, @code{lrintf},
4859 @code{lrintl}, @code{lrint}, @code{lroundf}, @code{lroundl},
4860 @code{lround}, @code{nearbyintf}, @code{nearbyintl}, @code{nearbyint},
4861 @code{nextafterf}, @code{nextafterl}, @code{nextafter},
4862 @code{nexttowardf}, @code{nexttowardl}, @code{nexttoward},
4863 @code{remainderf}, @code{remainderl}, @code{remainder}, @code{remquof},
4864 @code{remquol}, @code{remquo}, @code{rintf}, @code{rintl}, @code{rint},
4865 @code{roundf}, @code{roundl}, @code{round}, @code{scalblnf},
4866 @code{scalblnl}, @code{scalbln}, @code{scalbnf}, @code{scalbnl},
4867 @code{scalbn}, @code{snprintf}, @code{tgammaf}, @code{tgammal},
4868 @code{tgamma}, @code{truncf}, @code{truncl}, @code{trunc},
4869 @code{vfscanf}, @code{vscanf}, @code{vsnprintf} and @code{vsscanf}
4870 are handled as built-in functions
4871 except in strict ISO C90 mode (@option{-ansi} or @option{-std=c89}).
4872
4873 There are also built-in versions of the ISO C99 functions
4874 @code{acosf}, @code{acosl}, @code{asinf}, @code{asinl}, @code{atan2f},
4875 @code{atan2l}, @code{atanf}, @code{atanl}, @code{ceilf}, @code{ceill},
4876 @code{cosf}, @code{coshf}, @code{coshl}, @code{cosl}, @code{expf},
4877 @code{expl}, @code{fabsf}, @code{fabsl}, @code{floorf}, @code{floorl},
4878 @code{fmodf}, @code{fmodl}, @code{frexpf}, @code{frexpl}, @code{ldexpf},
4879 @code{ldexpl}, @code{log10f}, @code{log10l}, @code{logf}, @code{logl},
4880 @code{modfl}, @code{modf}, @code{powf}, @code{powl}, @code{sinf},
4881 @code{sinhf}, @code{sinhl}, @code{sinl}, @code{sqrtf}, @code{sqrtl},
4882 @code{tanf}, @code{tanhf}, @code{tanhl} and @code{tanl}
4883 that are recognized in any mode since ISO C90 reserves these names for
4884 the purpose to which ISO C99 puts them. All these functions have
4885 corresponding versions prefixed with @code{__builtin_}.
4886
4887 The ISO C94 functions
4888 @code{iswalnum}, @code{iswalpha}, @code{iswcntrl}, @code{iswdigit},
4889 @code{iswgraph}, @code{iswlower}, @code{iswprint}, @code{iswpunct},
4890 @code{iswspace}, @code{iswupper}, @code{iswxdigit}, @code{towlower} and
4891 @code{towupper}
4892 are handled as built-in functions
4893 except in strict ISO C90 mode (@option{-ansi} or @option{-std=c89}).
4894
4895 The ISO C90 functions
4896 @code{abort}, @code{abs}, @code{acos}, @code{asin}, @code{atan2},
4897 @code{atan}, @code{calloc}, @code{ceil}, @code{cosh}, @code{cos},
4898 @code{exit}, @code{exp}, @code{fabs}, @code{floor}, @code{fmod},
4899 @code{fprintf}, @code{fputs}, @code{frexp}, @code{fscanf},
4900 @code{isalnum}, @code{isalpha}, @code{iscntrl}, @code{isdigit},
4901 @code{isgraph}, @code{islower}, @code{isprint}, @code{ispunct},
4902 @code{isspace}, @code{isupper}, @code{isxdigit}, @code{tolower},
4903 @code{toupper}, @code{labs}, @code{ldexp}, @code{log10}, @code{log},
4904 @code{malloc}, @code{memcmp}, @code{memcpy}, @code{memset}, @code{modf},
4905 @code{pow}, @code{printf}, @code{putchar}, @code{puts}, @code{scanf},
4906 @code{sinh}, @code{sin}, @code{snprintf}, @code{sprintf}, @code{sqrt},
4907 @code{sscanf}, @code{strcat}, @code{strchr}, @code{strcmp},
4908 @code{strcpy}, @code{strcspn}, @code{strlen}, @code{strncat},
4909 @code{strncmp}, @code{strncpy}, @code{strpbrk}, @code{strrchr},
4910 @code{strspn}, @code{strstr}, @code{tanh}, @code{tan}, @code{vfprintf},
4911 @code{vprintf} and @code{vsprintf}
4912 are all recognized as built-in functions unless
4913 @option{-fno-builtin} is specified (or @option{-fno-builtin-@var{function}}
4914 is specified for an individual function). All of these functions have
4915 corresponding versions prefixed with @code{__builtin_}.
4916
4917 GCC provides built-in versions of the ISO C99 floating point comparison
4918 macros that avoid raising exceptions for unordered operands. They have
4919 the same names as the standard macros ( @code{isgreater},
4920 @code{isgreaterequal}, @code{isless}, @code{islessequal},
4921 @code{islessgreater}, and @code{isunordered}) , with @code{__builtin_}
4922 prefixed. We intend for a library implementor to be able to simply
4923 @code{#define} each standard macro to its built-in equivalent.
4924
4925 @deftypefn {Built-in Function} int __builtin_types_compatible_p (@var{type1}, @var{type2})
4926
4927 You can use the built-in function @code{__builtin_types_compatible_p} to
4928 determine whether two types are the same.
4929
4930 This built-in function returns 1 if the unqualified versions of the
4931 types @var{type1} and @var{type2} (which are types, not expressions) are
4932 compatible, 0 otherwise. The result of this built-in function can be
4933 used in integer constant expressions.
4934
4935 This built-in function ignores top level qualifiers (e.g., @code{const},
4936 @code{volatile}). For example, @code{int} is equivalent to @code{const
4937 int}.
4938
4939 The type @code{int[]} and @code{int[5]} are compatible. On the other
4940 hand, @code{int} and @code{char *} are not compatible, even if the size
4941 of their types, on the particular architecture are the same. Also, the
4942 amount of pointer indirection is taken into account when determining
4943 similarity. Consequently, @code{short *} is not similar to
4944 @code{short **}. Furthermore, two types that are typedefed are
4945 considered compatible if their underlying types are compatible.
4946
4947 An @code{enum} type is not considered to be compatible with another
4948 @code{enum} type even if both are compatible with the same integer
4949 type; this is what the C standard specifies.
4950 For example, @code{enum @{foo, bar@}} is not similar to
4951 @code{enum @{hot, dog@}}.
4952
4953 You would typically use this function in code whose execution varies
4954 depending on the arguments' types. For example:
4955
4956 @smallexample
4957 #define foo(x) \
4958 (@{ \
4959 typeof (x) tmp; \
4960 if (__builtin_types_compatible_p (typeof (x), long double)) \
4961 tmp = foo_long_double (tmp); \
4962 else if (__builtin_types_compatible_p (typeof (x), double)) \
4963 tmp = foo_double (tmp); \
4964 else if (__builtin_types_compatible_p (typeof (x), float)) \
4965 tmp = foo_float (tmp); \
4966 else \
4967 abort (); \
4968 tmp; \
4969 @})
4970 @end smallexample
4971
4972 @emph{Note:} This construct is only available for C.
4973
4974 @end deftypefn
4975
4976 @deftypefn {Built-in Function} @var{type} __builtin_choose_expr (@var{const_exp}, @var{exp1}, @var{exp2})
4977
4978 You can use the built-in function @code{__builtin_choose_expr} to
4979 evaluate code depending on the value of a constant expression. This
4980 built-in function returns @var{exp1} if @var{const_exp}, which is a
4981 constant expression that must be able to be determined at compile time,
4982 is nonzero. Otherwise it returns 0.
4983
4984 This built-in function is analogous to the @samp{? :} operator in C,
4985 except that the expression returned has its type unaltered by promotion
4986 rules. Also, the built-in function does not evaluate the expression
4987 that was not chosen. For example, if @var{const_exp} evaluates to true,
4988 @var{exp2} is not evaluated even if it has side-effects.
4989
4990 This built-in function can return an lvalue if the chosen argument is an
4991 lvalue.
4992
4993 If @var{exp1} is returned, the return type is the same as @var{exp1}'s
4994 type. Similarly, if @var{exp2} is returned, its return type is the same
4995 as @var{exp2}.
4996
4997 Example:
4998
4999 @smallexample
5000 #define foo(x) \
5001 __builtin_choose_expr ( \
5002 __builtin_types_compatible_p (typeof (x), double), \
5003 foo_double (x), \
5004 __builtin_choose_expr ( \
5005 __builtin_types_compatible_p (typeof (x), float), \
5006 foo_float (x), \
5007 /* @r{The void expression results in a compile-time error} \
5008 @r{when assigning the result to something.} */ \
5009 (void)0))
5010 @end smallexample
5011
5012 @emph{Note:} This construct is only available for C. Furthermore, the
5013 unused expression (@var{exp1} or @var{exp2} depending on the value of
5014 @var{const_exp}) may still generate syntax errors. This may change in
5015 future revisions.
5016
5017 @end deftypefn
5018
5019 @deftypefn {Built-in Function} int __builtin_constant_p (@var{exp})
5020 You can use the built-in function @code{__builtin_constant_p} to
5021 determine if a value is known to be constant at compile-time and hence
5022 that GCC can perform constant-folding on expressions involving that
5023 value. The argument of the function is the value to test. The function
5024 returns the integer 1 if the argument is known to be a compile-time
5025 constant and 0 if it is not known to be a compile-time constant. A
5026 return of 0 does not indicate that the value is @emph{not} a constant,
5027 but merely that GCC cannot prove it is a constant with the specified
5028 value of the @option{-O} option.
5029
5030 You would typically use this function in an embedded application where
5031 memory was a critical resource. If you have some complex calculation,
5032 you may want it to be folded if it involves constants, but need to call
5033 a function if it does not. For example:
5034
5035 @smallexample
5036 #define Scale_Value(X) \
5037 (__builtin_constant_p (X) \
5038 ? ((X) * SCALE + OFFSET) : Scale (X))
5039 @end smallexample
5040
5041 You may use this built-in function in either a macro or an inline
5042 function. However, if you use it in an inlined function and pass an
5043 argument of the function as the argument to the built-in, GCC will
5044 never return 1 when you call the inline function with a string constant
5045 or compound literal (@pxref{Compound Literals}) and will not return 1
5046 when you pass a constant numeric value to the inline function unless you
5047 specify the @option{-O} option.
5048
5049 You may also use @code{__builtin_constant_p} in initializers for static
5050 data. For instance, you can write
5051
5052 @smallexample
5053 static const int table[] = @{
5054 __builtin_constant_p (EXPRESSION) ? (EXPRESSION) : -1,
5055 /* @r{@dots{}} */
5056 @};
5057 @end smallexample
5058
5059 @noindent
5060 This is an acceptable initializer even if @var{EXPRESSION} is not a
5061 constant expression. GCC must be more conservative about evaluating the
5062 built-in in this case, because it has no opportunity to perform
5063 optimization.
5064
5065 Previous versions of GCC did not accept this built-in in data
5066 initializers. The earliest version where it is completely safe is
5067 3.0.1.
5068 @end deftypefn
5069
5070 @deftypefn {Built-in Function} long __builtin_expect (long @var{exp}, long @var{c})
5071 @opindex fprofile-arcs
5072 You may use @code{__builtin_expect} to provide the compiler with
5073 branch prediction information. In general, you should prefer to
5074 use actual profile feedback for this (@option{-fprofile-arcs}), as
5075 programmers are notoriously bad at predicting how their programs
5076 actually perform. However, there are applications in which this
5077 data is hard to collect.
5078
5079 The return value is the value of @var{exp}, which should be an
5080 integral expression. The value of @var{c} must be a compile-time
5081 constant. The semantics of the built-in are that it is expected
5082 that @var{exp} == @var{c}. For example:
5083
5084 @smallexample
5085 if (__builtin_expect (x, 0))
5086 foo ();
5087 @end smallexample
5088
5089 @noindent
5090 would indicate that we do not expect to call @code{foo}, since
5091 we expect @code{x} to be zero. Since you are limited to integral
5092 expressions for @var{exp}, you should use constructions such as
5093
5094 @smallexample
5095 if (__builtin_expect (ptr != NULL, 1))
5096 error ();
5097 @end smallexample
5098
5099 @noindent
5100 when testing pointer or floating-point values.
5101 @end deftypefn
5102
5103 @deftypefn {Built-in Function} void __builtin_prefetch (const void *@var{addr}, ...)
5104 This function is used to minimize cache-miss latency by moving data into
5105 a cache before it is accessed.
5106 You can insert calls to @code{__builtin_prefetch} into code for which
5107 you know addresses of data in memory that is likely to be accessed soon.
5108 If the target supports them, data prefetch instructions will be generated.
5109 If the prefetch is done early enough before the access then the data will
5110 be in the cache by the time it is accessed.
5111
5112 The value of @var{addr} is the address of the memory to prefetch.
5113 There are two optional arguments, @var{rw} and @var{locality}.
5114 The value of @var{rw} is a compile-time constant one or zero; one
5115 means that the prefetch is preparing for a write to the memory address
5116 and zero, the default, means that the prefetch is preparing for a read.
5117 The value @var{locality} must be a compile-time constant integer between
5118 zero and three. A value of zero means that the data has no temporal
5119 locality, so it need not be left in the cache after the access. A value
5120 of three means that the data has a high degree of temporal locality and
5121 should be left in all levels of cache possible. Values of one and two
5122 mean, respectively, a low or moderate degree of temporal locality. The
5123 default is three.
5124
5125 @smallexample
5126 for (i = 0; i < n; i++)
5127 @{
5128 a[i] = a[i] + b[i];
5129 __builtin_prefetch (&a[i+j], 1, 1);
5130 __builtin_prefetch (&b[i+j], 0, 1);
5131 /* @r{@dots{}} */
5132 @}
5133 @end smallexample
5134
5135 Data prefetch does not generate faults if @var{addr} is invalid, but
5136 the address expression itself must be valid. For example, a prefetch
5137 of @code{p->next} will not fault if @code{p->next} is not a valid
5138 address, but evaluation will fault if @code{p} is not a valid address.
5139
5140 If the target does not support data prefetch, the address expression
5141 is evaluated if it includes side effects but no other code is generated
5142 and GCC does not issue a warning.
5143 @end deftypefn
5144
5145 @deftypefn {Built-in Function} double __builtin_huge_val (void)
5146 Returns a positive infinity, if supported by the floating-point format,
5147 else @code{DBL_MAX}. This function is suitable for implementing the
5148 ISO C macro @code{HUGE_VAL}.
5149 @end deftypefn
5150
5151 @deftypefn {Built-in Function} float __builtin_huge_valf (void)
5152 Similar to @code{__builtin_huge_val}, except the return type is @code{float}.
5153 @end deftypefn
5154
5155 @deftypefn {Built-in Function} {long double} __builtin_huge_vall (void)
5156 Similar to @code{__builtin_huge_val}, except the return
5157 type is @code{long double}.
5158 @end deftypefn
5159
5160 @deftypefn {Built-in Function} double __builtin_inf (void)
5161 Similar to @code{__builtin_huge_val}, except a warning is generated
5162 if the target floating-point format does not support infinities.
5163 This function is suitable for implementing the ISO C99 macro @code{INFINITY}.
5164 @end deftypefn
5165
5166 @deftypefn {Built-in Function} float __builtin_inff (void)
5167 Similar to @code{__builtin_inf}, except the return type is @code{float}.
5168 @end deftypefn
5169
5170 @deftypefn {Built-in Function} {long double} __builtin_infl (void)
5171 Similar to @code{__builtin_inf}, except the return
5172 type is @code{long double}.
5173 @end deftypefn
5174
5175 @deftypefn {Built-in Function} double __builtin_nan (const char *str)
5176 This is an implementation of the ISO C99 function @code{nan}.
5177
5178 Since ISO C99 defines this function in terms of @code{strtod}, which we
5179 do not implement, a description of the parsing is in order. The string
5180 is parsed as by @code{strtol}; that is, the base is recognized by
5181 leading @samp{0} or @samp{0x} prefixes. The number parsed is placed
5182 in the significand such that the least significant bit of the number
5183 is at the least significant bit of the significand. The number is
5184 truncated to fit the significand field provided. The significand is
5185 forced to be a quiet NaN.
5186
5187 This function, if given a string literal, is evaluated early enough
5188 that it is considered a compile-time constant.
5189 @end deftypefn
5190
5191 @deftypefn {Built-in Function} float __builtin_nanf (const char *str)
5192 Similar to @code{__builtin_nan}, except the return type is @code{float}.
5193 @end deftypefn
5194
5195 @deftypefn {Built-in Function} {long double} __builtin_nanl (const char *str)
5196 Similar to @code{__builtin_nan}, except the return type is @code{long double}.
5197 @end deftypefn
5198
5199 @deftypefn {Built-in Function} double __builtin_nans (const char *str)
5200 Similar to @code{__builtin_nan}, except the significand is forced
5201 to be a signaling NaN. The @code{nans} function is proposed by
5202 @uref{http://www.open-std.org/jtc1/sc22/wg14/www/docs/n965.htm,,WG14 N965}.
5203 @end deftypefn
5204
5205 @deftypefn {Built-in Function} float __builtin_nansf (const char *str)
5206 Similar to @code{__builtin_nans}, except the return type is @code{float}.
5207 @end deftypefn
5208
5209 @deftypefn {Built-in Function} {long double} __builtin_nansl (const char *str)
5210 Similar to @code{__builtin_nans}, except the return type is @code{long double}.
5211 @end deftypefn
5212
5213 @deftypefn {Built-in Function} int __builtin_ffs (unsigned int x)
5214 Returns one plus the index of the least significant 1-bit of @var{x}, or
5215 if @var{x} is zero, returns zero.
5216 @end deftypefn
5217
5218 @deftypefn {Built-in Function} int __builtin_clz (unsigned int x)
5219 Returns the number of leading 0-bits in @var{x}, starting at the most
5220 significant bit position. If @var{x} is 0, the result is undefined.
5221 @end deftypefn
5222
5223 @deftypefn {Built-in Function} int __builtin_ctz (unsigned int x)
5224 Returns the number of trailing 0-bits in @var{x}, starting at the least
5225 significant bit position. If @var{x} is 0, the result is undefined.
5226 @end deftypefn
5227
5228 @deftypefn {Built-in Function} int __builtin_popcount (unsigned int x)
5229 Returns the number of 1-bits in @var{x}.
5230 @end deftypefn
5231
5232 @deftypefn {Built-in Function} int __builtin_parity (unsigned int x)
5233 Returns the parity of @var{x}, i.@:e. the number of 1-bits in @var{x}
5234 modulo 2.
5235 @end deftypefn
5236
5237 @deftypefn {Built-in Function} int __builtin_ffsl (unsigned long)
5238 Similar to @code{__builtin_ffs}, except the argument type is
5239 @code{unsigned long}.
5240 @end deftypefn
5241
5242 @deftypefn {Built-in Function} int __builtin_clzl (unsigned long)
5243 Similar to @code{__builtin_clz}, except the argument type is
5244 @code{unsigned long}.
5245 @end deftypefn
5246
5247 @deftypefn {Built-in Function} int __builtin_ctzl (unsigned long)
5248 Similar to @code{__builtin_ctz}, except the argument type is
5249 @code{unsigned long}.
5250 @end deftypefn
5251
5252 @deftypefn {Built-in Function} int __builtin_popcountl (unsigned long)
5253 Similar to @code{__builtin_popcount}, except the argument type is
5254 @code{unsigned long}.
5255 @end deftypefn
5256
5257 @deftypefn {Built-in Function} int __builtin_parityl (unsigned long)
5258 Similar to @code{__builtin_parity}, except the argument type is
5259 @code{unsigned long}.
5260 @end deftypefn
5261
5262 @deftypefn {Built-in Function} int __builtin_ffsll (unsigned long long)
5263 Similar to @code{__builtin_ffs}, except the argument type is
5264 @code{unsigned long long}.
5265 @end deftypefn
5266
5267 @deftypefn {Built-in Function} int __builtin_clzll (unsigned long long)
5268 Similar to @code{__builtin_clz}, except the argument type is
5269 @code{unsigned long long}.
5270 @end deftypefn
5271
5272 @deftypefn {Built-in Function} int __builtin_ctzll (unsigned long long)
5273 Similar to @code{__builtin_ctz}, except the argument type is
5274 @code{unsigned long long}.
5275 @end deftypefn
5276
5277 @deftypefn {Built-in Function} int __builtin_popcountll (unsigned long long)
5278 Similar to @code{__builtin_popcount}, except the argument type is
5279 @code{unsigned long long}.
5280 @end deftypefn
5281
5282 @deftypefn {Built-in Function} int __builtin_parityll (unsigned long long)
5283 Similar to @code{__builtin_parity}, except the argument type is
5284 @code{unsigned long long}.
5285 @end deftypefn
5286
5287
5288 @node Target Builtins
5289 @section Built-in Functions Specific to Particular Target Machines
5290
5291 On some target machines, GCC supports many built-in functions specific
5292 to those machines. Generally these generate calls to specific machine
5293 instructions, but allow the compiler to schedule those calls.
5294
5295 @menu
5296 * Alpha Built-in Functions::
5297 * ARM Built-in Functions::
5298 * FR-V Built-in Functions::
5299 * X86 Built-in Functions::
5300 * PowerPC AltiVec Built-in Functions::
5301 @end menu
5302
5303 @node Alpha Built-in Functions
5304 @subsection Alpha Built-in Functions
5305
5306 These built-in functions are available for the Alpha family of
5307 processors, depending on the command-line switches used.
5308
5309 The following built-in functions are always available. They
5310 all generate the machine instruction that is part of the name.
5311
5312 @smallexample
5313 long __builtin_alpha_implver (void)
5314 long __builtin_alpha_rpcc (void)
5315 long __builtin_alpha_amask (long)
5316 long __builtin_alpha_cmpbge (long, long)
5317 long __builtin_alpha_extbl (long, long)
5318 long __builtin_alpha_extwl (long, long)
5319 long __builtin_alpha_extll (long, long)
5320 long __builtin_alpha_extql (long, long)
5321 long __builtin_alpha_extwh (long, long)
5322 long __builtin_alpha_extlh (long, long)
5323 long __builtin_alpha_extqh (long, long)
5324 long __builtin_alpha_insbl (long, long)
5325 long __builtin_alpha_inswl (long, long)
5326 long __builtin_alpha_insll (long, long)
5327 long __builtin_alpha_insql (long, long)
5328 long __builtin_alpha_inswh (long, long)
5329 long __builtin_alpha_inslh (long, long)
5330 long __builtin_alpha_insqh (long, long)
5331 long __builtin_alpha_mskbl (long, long)
5332 long __builtin_alpha_mskwl (long, long)
5333 long __builtin_alpha_mskll (long, long)
5334 long __builtin_alpha_mskql (long, long)
5335 long __builtin_alpha_mskwh (long, long)
5336 long __builtin_alpha_msklh (long, long)
5337 long __builtin_alpha_mskqh (long, long)
5338 long __builtin_alpha_umulh (long, long)
5339 long __builtin_alpha_zap (long, long)
5340 long __builtin_alpha_zapnot (long, long)
5341 @end smallexample
5342
5343 The following built-in functions are always with @option{-mmax}
5344 or @option{-mcpu=@var{cpu}} where @var{cpu} is @code{pca56} or
5345 later. They all generate the machine instruction that is part
5346 of the name.
5347
5348 @smallexample
5349 long __builtin_alpha_pklb (long)
5350 long __builtin_alpha_pkwb (long)
5351 long __builtin_alpha_unpkbl (long)
5352 long __builtin_alpha_unpkbw (long)
5353 long __builtin_alpha_minub8 (long, long)
5354 long __builtin_alpha_minsb8 (long, long)
5355 long __builtin_alpha_minuw4 (long, long)
5356 long __builtin_alpha_minsw4 (long, long)
5357 long __builtin_alpha_maxub8 (long, long)
5358 long __builtin_alpha_maxsb8 (long, long)
5359 long __builtin_alpha_maxuw4 (long, long)
5360 long __builtin_alpha_maxsw4 (long, long)
5361 long __builtin_alpha_perr (long, long)
5362 @end smallexample
5363
5364 The following built-in functions are always with @option{-mcix}
5365 or @option{-mcpu=@var{cpu}} where @var{cpu} is @code{ev67} or
5366 later. They all generate the machine instruction that is part
5367 of the name.
5368
5369 @smallexample
5370 long __builtin_alpha_cttz (long)
5371 long __builtin_alpha_ctlz (long)
5372 long __builtin_alpha_ctpop (long)
5373 @end smallexample
5374
5375 The following builtins are available on systems that use the OSF/1
5376 PALcode. Normally they invoke the @code{rduniq} and @code{wruniq}
5377 PAL calls, but when invoked with @option{-mtls-kernel}, they invoke
5378 @code{rdval} and @code{wrval}.
5379
5380 @smallexample
5381 void *__builtin_thread_pointer (void)
5382 void __builtin_set_thread_pointer (void *)
5383 @end smallexample
5384
5385 @node ARM Built-in Functions
5386 @subsection ARM Built-in Functions
5387
5388 These built-in functions are available for the ARM family of
5389 processors, when the @option{-mcpu=iwmmxt} switch is used:
5390
5391 @smallexample
5392 typedef int v2si __attribute__ ((vector_size (8)));
5393 typedef short v4hi __attribute__ ((vector_size (8)));
5394 typedef char v8qi __attribute__ ((vector_size (8)));
5395
5396 int __builtin_arm_getwcx (int)
5397 void __builtin_arm_setwcx (int, int)
5398 int __builtin_arm_textrmsb (v8qi, int)
5399 int __builtin_arm_textrmsh (v4hi, int)
5400 int __builtin_arm_textrmsw (v2si, int)
5401 int __builtin_arm_textrmub (v8qi, int)
5402 int __builtin_arm_textrmuh (v4hi, int)
5403 int __builtin_arm_textrmuw (v2si, int)
5404 v8qi __builtin_arm_tinsrb (v8qi, int)
5405 v4hi __builtin_arm_tinsrh (v4hi, int)
5406 v2si __builtin_arm_tinsrw (v2si, int)
5407 long long __builtin_arm_tmia (long long, int, int)
5408 long long __builtin_arm_tmiabb (long long, int, int)
5409 long long __builtin_arm_tmiabt (long long, int, int)
5410 long long __builtin_arm_tmiaph (long long, int, int)
5411 long long __builtin_arm_tmiatb (long long, int, int)
5412 long long __builtin_arm_tmiatt (long long, int, int)
5413 int __builtin_arm_tmovmskb (v8qi)
5414 int __builtin_arm_tmovmskh (v4hi)
5415 int __builtin_arm_tmovmskw (v2si)
5416 long long __builtin_arm_waccb (v8qi)
5417 long long __builtin_arm_wacch (v4hi)
5418 long long __builtin_arm_waccw (v2si)
5419 v8qi __builtin_arm_waddb (v8qi, v8qi)
5420 v8qi __builtin_arm_waddbss (v8qi, v8qi)
5421 v8qi __builtin_arm_waddbus (v8qi, v8qi)
5422 v4hi __builtin_arm_waddh (v4hi, v4hi)
5423 v4hi __builtin_arm_waddhss (v4hi, v4hi)
5424 v4hi __builtin_arm_waddhus (v4hi, v4hi)
5425 v2si __builtin_arm_waddw (v2si, v2si)
5426 v2si __builtin_arm_waddwss (v2si, v2si)
5427 v2si __builtin_arm_waddwus (v2si, v2si)
5428 v8qi __builtin_arm_walign (v8qi, v8qi, int)
5429 long long __builtin_arm_wand(long long, long long)
5430 long long __builtin_arm_wandn (long long, long long)
5431 v8qi __builtin_arm_wavg2b (v8qi, v8qi)
5432 v8qi __builtin_arm_wavg2br (v8qi, v8qi)
5433 v4hi __builtin_arm_wavg2h (v4hi, v4hi)
5434 v4hi __builtin_arm_wavg2hr (v4hi, v4hi)
5435 v8qi __builtin_arm_wcmpeqb (v8qi, v8qi)
5436 v4hi __builtin_arm_wcmpeqh (v4hi, v4hi)
5437 v2si __builtin_arm_wcmpeqw (v2si, v2si)
5438 v8qi __builtin_arm_wcmpgtsb (v8qi, v8qi)
5439 v4hi __builtin_arm_wcmpgtsh (v4hi, v4hi)
5440 v2si __builtin_arm_wcmpgtsw (v2si, v2si)
5441 v8qi __builtin_arm_wcmpgtub (v8qi, v8qi)
5442 v4hi __builtin_arm_wcmpgtuh (v4hi, v4hi)
5443 v2si __builtin_arm_wcmpgtuw (v2si, v2si)
5444 long long __builtin_arm_wmacs (long long, v4hi, v4hi)
5445 long long __builtin_arm_wmacsz (v4hi, v4hi)
5446 long long __builtin_arm_wmacu (long long, v4hi, v4hi)
5447 long long __builtin_arm_wmacuz (v4hi, v4hi)
5448 v4hi __builtin_arm_wmadds (v4hi, v4hi)
5449 v4hi __builtin_arm_wmaddu (v4hi, v4hi)
5450 v8qi __builtin_arm_wmaxsb (v8qi, v8qi)
5451 v4hi __builtin_arm_wmaxsh (v4hi, v4hi)
5452 v2si __builtin_arm_wmaxsw (v2si, v2si)
5453 v8qi __builtin_arm_wmaxub (v8qi, v8qi)
5454 v4hi __builtin_arm_wmaxuh (v4hi, v4hi)
5455 v2si __builtin_arm_wmaxuw (v2si, v2si)
5456 v8qi __builtin_arm_wminsb (v8qi, v8qi)
5457 v4hi __builtin_arm_wminsh (v4hi, v4hi)
5458 v2si __builtin_arm_wminsw (v2si, v2si)
5459 v8qi __builtin_arm_wminub (v8qi, v8qi)
5460 v4hi __builtin_arm_wminuh (v4hi, v4hi)
5461 v2si __builtin_arm_wminuw (v2si, v2si)
5462 v4hi __builtin_arm_wmulsm (v4hi, v4hi)
5463 v4hi __builtin_arm_wmulul (v4hi, v4hi)
5464 v4hi __builtin_arm_wmulum (v4hi, v4hi)
5465 long long __builtin_arm_wor (long long, long long)
5466 v2si __builtin_arm_wpackdss (long long, long long)
5467 v2si __builtin_arm_wpackdus (long long, long long)
5468 v8qi __builtin_arm_wpackhss (v4hi, v4hi)
5469 v8qi __builtin_arm_wpackhus (v4hi, v4hi)
5470 v4hi __builtin_arm_wpackwss (v2si, v2si)
5471 v4hi __builtin_arm_wpackwus (v2si, v2si)
5472 long long __builtin_arm_wrord (long long, long long)
5473 long long __builtin_arm_wrordi (long long, int)
5474 v4hi __builtin_arm_wrorh (v4hi, long long)
5475 v4hi __builtin_arm_wrorhi (v4hi, int)
5476 v2si __builtin_arm_wrorw (v2si, long long)
5477 v2si __builtin_arm_wrorwi (v2si, int)
5478 v2si __builtin_arm_wsadb (v8qi, v8qi)
5479 v2si __builtin_arm_wsadbz (v8qi, v8qi)
5480 v2si __builtin_arm_wsadh (v4hi, v4hi)
5481 v2si __builtin_arm_wsadhz (v4hi, v4hi)
5482 v4hi __builtin_arm_wshufh (v4hi, int)
5483 long long __builtin_arm_wslld (long long, long long)
5484 long long __builtin_arm_wslldi (long long, int)
5485 v4hi __builtin_arm_wsllh (v4hi, long long)
5486 v4hi __builtin_arm_wsllhi (v4hi, int)
5487 v2si __builtin_arm_wsllw (v2si, long long)
5488 v2si __builtin_arm_wsllwi (v2si, int)
5489 long long __builtin_arm_wsrad (long long, long long)
5490 long long __builtin_arm_wsradi (long long, int)
5491 v4hi __builtin_arm_wsrah (v4hi, long long)
5492 v4hi __builtin_arm_wsrahi (v4hi, int)
5493 v2si __builtin_arm_wsraw (v2si, long long)
5494 v2si __builtin_arm_wsrawi (v2si, int)
5495 long long __builtin_arm_wsrld (long long, long long)
5496 long long __builtin_arm_wsrldi (long long, int)
5497 v4hi __builtin_arm_wsrlh (v4hi, long long)
5498 v4hi __builtin_arm_wsrlhi (v4hi, int)
5499 v2si __builtin_arm_wsrlw (v2si, long long)
5500 v2si __builtin_arm_wsrlwi (v2si, int)
5501 v8qi __builtin_arm_wsubb (v8qi, v8qi)
5502 v8qi __builtin_arm_wsubbss (v8qi, v8qi)
5503 v8qi __builtin_arm_wsubbus (v8qi, v8qi)
5504 v4hi __builtin_arm_wsubh (v4hi, v4hi)
5505 v4hi __builtin_arm_wsubhss (v4hi, v4hi)
5506 v4hi __builtin_arm_wsubhus (v4hi, v4hi)
5507 v2si __builtin_arm_wsubw (v2si, v2si)
5508 v2si __builtin_arm_wsubwss (v2si, v2si)
5509 v2si __builtin_arm_wsubwus (v2si, v2si)
5510 v4hi __builtin_arm_wunpckehsb (v8qi)
5511 v2si __builtin_arm_wunpckehsh (v4hi)
5512 long long __builtin_arm_wunpckehsw (v2si)
5513 v4hi __builtin_arm_wunpckehub (v8qi)
5514 v2si __builtin_arm_wunpckehuh (v4hi)
5515 long long __builtin_arm_wunpckehuw (v2si)
5516 v4hi __builtin_arm_wunpckelsb (v8qi)
5517 v2si __builtin_arm_wunpckelsh (v4hi)
5518 long long __builtin_arm_wunpckelsw (v2si)
5519 v4hi __builtin_arm_wunpckelub (v8qi)
5520 v2si __builtin_arm_wunpckeluh (v4hi)
5521 long long __builtin_arm_wunpckeluw (v2si)
5522 v8qi __builtin_arm_wunpckihb (v8qi, v8qi)
5523 v4hi __builtin_arm_wunpckihh (v4hi, v4hi)
5524 v2si __builtin_arm_wunpckihw (v2si, v2si)
5525 v8qi __builtin_arm_wunpckilb (v8qi, v8qi)
5526 v4hi __builtin_arm_wunpckilh (v4hi, v4hi)
5527 v2si __builtin_arm_wunpckilw (v2si, v2si)
5528 long long __builtin_arm_wxor (long long, long long)
5529 long long __builtin_arm_wzero ()
5530 @end smallexample
5531
5532 @node FR-V Built-in Functions
5533 @subsection FR-V Built-in Functions
5534
5535 GCC provides many FR-V-specific built-in functions. In general,
5536 these functions are intended to be compatible with those described
5537 by @cite{FR-V Family, Softune C/C++ Compiler Manual (V6), Fujitsu
5538 Semiconductor}. The two exceptions are @code{__MDUNPACKH} and
5539 @code{__MBTOHE}, the gcc forms of which pass 128-bit values by
5540 pointer rather than by value.
5541
5542 Most of the functions are named after specific FR-V instructions.
5543 Such functions are said to be ``directly mapped'' and are summarized
5544 here in tabular form.
5545
5546 @menu
5547 * Argument Types::
5548 * Directly-mapped Integer Functions::
5549 * Directly-mapped Media Functions::
5550 * Other Built-in Functions::
5551 @end menu
5552
5553 @node Argument Types
5554 @subsubsection Argument Types
5555
5556 The arguments to the built-in functions can be divided into three groups:
5557 register numbers, compile-time constants and run-time values. In order
5558 to make this classification clear at a glance, the arguments and return
5559 values are given the following pseudo types:
5560
5561 @multitable @columnfractions .20 .30 .15 .35
5562 @item Pseudo type @tab Real C type @tab Constant? @tab Description
5563 @item @code{uh} @tab @code{unsigned short} @tab No @tab an unsigned halfword
5564 @item @code{uw1} @tab @code{unsigned int} @tab No @tab an unsigned word
5565 @item @code{sw1} @tab @code{int} @tab No @tab a signed word
5566 @item @code{uw2} @tab @code{unsigned long long} @tab No
5567 @tab an unsigned doubleword
5568 @item @code{sw2} @tab @code{long long} @tab No @tab a signed doubleword
5569 @item @code{const} @tab @code{int} @tab Yes @tab an integer constant
5570 @item @code{acc} @tab @code{int} @tab Yes @tab an ACC register number
5571 @item @code{iacc} @tab @code{int} @tab Yes @tab an IACC register number
5572 @end multitable
5573
5574 These pseudo types are not defined by GCC, they are simply a notational
5575 convenience used in this manual.
5576
5577 Arguments of type @code{uh}, @code{uw1}, @code{sw1}, @code{uw2}
5578 and @code{sw2} are evaluated at run time. They correspond to
5579 register operands in the underlying FR-V instructions.
5580
5581 @code{const} arguments represent immediate operands in the underlying
5582 FR-V instructions. They must be compile-time constants.
5583
5584 @code{acc} arguments are evaluated at compile time and specify the number
5585 of an accumulator register. For example, an @code{acc} argument of 2
5586 will select the ACC2 register.
5587
5588 @code{iacc} arguments are similar to @code{acc} arguments but specify the
5589 number of an IACC register. See @pxref{Other Built-in Functions}
5590 for more details.
5591
5592 @node Directly-mapped Integer Functions
5593 @subsubsection Directly-mapped Integer Functions
5594
5595 The functions listed below map directly to FR-V I-type instructions.
5596
5597 @multitable @columnfractions .45 .32 .23
5598 @item Function prototype @tab Example usage @tab Assembly output
5599 @item @code{sw1 __ADDSS (sw1, sw1)}
5600 @tab @code{@var{c} = __ADDSS (@var{a}, @var{b})}
5601 @tab @code{ADDSS @var{a},@var{b},@var{c}}
5602 @item @code{sw1 __SCAN (sw1, sw1)}
5603 @tab @code{@var{c} = __SCAN (@var{a}, @var{b})}
5604 @tab @code{SCAN @var{a},@var{b},@var{c}}
5605 @item @code{sw1 __SCUTSS (sw1)}
5606 @tab @code{@var{b} = __SCUTSS (@var{a})}
5607 @tab @code{SCUTSS @var{a},@var{b}}
5608 @item @code{sw1 __SLASS (sw1, sw1)}
5609 @tab @code{@var{c} = __SLASS (@var{a}, @var{b})}
5610 @tab @code{SLASS @var{a},@var{b},@var{c}}
5611 @item @code{void __SMASS (sw1, sw1)}
5612 @tab @code{__SMASS (@var{a}, @var{b})}
5613 @tab @code{SMASS @var{a},@var{b}}
5614 @item @code{void __SMSSS (sw1, sw1)}
5615 @tab @code{__SMSSS (@var{a}, @var{b})}
5616 @tab @code{SMSSS @var{a},@var{b}}
5617 @item @code{void __SMU (sw1, sw1)}
5618 @tab @code{__SMU (@var{a}, @var{b})}
5619 @tab @code{SMU @var{a},@var{b}}
5620 @item @code{sw2 __SMUL (sw1, sw1)}
5621 @tab @code{@var{c} = __SMUL (@var{a}, @var{b})}
5622 @tab @code{SMUL @var{a},@var{b},@var{c}}
5623 @item @code{sw1 __SUBSS (sw1, sw1)}
5624 @tab @code{@var{c} = __SUBSS (@var{a}, @var{b})}
5625 @tab @code{SUBSS @var{a},@var{b},@var{c}}
5626 @item @code{uw2 __UMUL (uw1, uw1)}
5627 @tab @code{@var{c} = __UMUL (@var{a}, @var{b})}
5628 @tab @code{UMUL @var{a},@var{b},@var{c}}
5629 @end multitable
5630
5631 @node Directly-mapped Media Functions
5632 @subsubsection Directly-mapped Media Functions
5633
5634 The functions listed below map directly to FR-V M-type instructions.
5635
5636 @multitable @columnfractions .45 .32 .23
5637 @item Function prototype @tab Example usage @tab Assembly output
5638 @item @code{uw1 __MABSHS (sw1)}
5639 @tab @code{@var{b} = __MABSHS (@var{a})}
5640 @tab @code{MABSHS @var{a},@var{b}}
5641 @item @code{void __MADDACCS (acc, acc)}
5642 @tab @code{__MADDACCS (@var{b}, @var{a})}
5643 @tab @code{MADDACCS @var{a},@var{b}}
5644 @item @code{sw1 __MADDHSS (sw1, sw1)}
5645 @tab @code{@var{c} = __MADDHSS (@var{a}, @var{b})}
5646 @tab @code{MADDHSS @var{a},@var{b},@var{c}}
5647 @item @code{uw1 __MADDHUS (uw1, uw1)}
5648 @tab @code{@var{c} = __MADDHUS (@var{a}, @var{b})}
5649 @tab @code{MADDHUS @var{a},@var{b},@var{c}}
5650 @item @code{uw1 __MAND (uw1, uw1)}
5651 @tab @code{@var{c} = __MAND (@var{a}, @var{b})}
5652 @tab @code{MAND @var{a},@var{b},@var{c}}
5653 @item @code{void __MASACCS (acc, acc)}
5654 @tab @code{__MASACCS (@var{b}, @var{a})}
5655 @tab @code{MASACCS @var{a},@var{b}}
5656 @item @code{uw1 __MAVEH (uw1, uw1)}
5657 @tab @code{@var{c} = __MAVEH (@var{a}, @var{b})}
5658 @tab @code{MAVEH @var{a},@var{b},@var{c}}
5659 @item @code{uw2 __MBTOH (uw1)}
5660 @tab @code{@var{b} = __MBTOH (@var{a})}
5661 @tab @code{MBTOH @var{a},@var{b}}
5662 @item @code{void __MBTOHE (uw1 *, uw1)}
5663 @tab @code{__MBTOHE (&@var{b}, @var{a})}
5664 @tab @code{MBTOHE @var{a},@var{b}}
5665 @item @code{void __MCLRACC (acc)}
5666 @tab @code{__MCLRACC (@var{a})}
5667 @tab @code{MCLRACC @var{a}}
5668 @item @code{void __MCLRACCA (void)}
5669 @tab @code{__MCLRACCA ()}
5670 @tab @code{MCLRACCA}
5671 @item @code{uw1 __Mcop1 (uw1, uw1)}
5672 @tab @code{@var{c} = __Mcop1 (@var{a}, @var{b})}
5673 @tab @code{Mcop1 @var{a},@var{b},@var{c}}
5674 @item @code{uw1 __Mcop2 (uw1, uw1)}
5675 @tab @code{@var{c} = __Mcop2 (@var{a}, @var{b})}
5676 @tab @code{Mcop2 @var{a},@var{b},@var{c}}
5677 @item @code{uw1 __MCPLHI (uw2, const)}
5678 @tab @code{@var{c} = __MCPLHI (@var{a}, @var{b})}
5679 @tab @code{MCPLHI @var{a},#@var{b},@var{c}}
5680 @item @code{uw1 __MCPLI (uw2, const)}
5681 @tab @code{@var{c} = __MCPLI (@var{a}, @var{b})}
5682 @tab @code{MCPLI @var{a},#@var{b},@var{c}}
5683 @item @code{void __MCPXIS (acc, sw1, sw1)}
5684 @tab @code{__MCPXIS (@var{c}, @var{a}, @var{b})}
5685 @tab @code{MCPXIS @var{a},@var{b},@var{c}}
5686 @item @code{void __MCPXIU (acc, uw1, uw1)}
5687 @tab @code{__MCPXIU (@var{c}, @var{a}, @var{b})}
5688 @tab @code{MCPXIU @var{a},@var{b},@var{c}}
5689 @item @code{void __MCPXRS (acc, sw1, sw1)}
5690 @tab @code{__MCPXRS (@var{c}, @var{a}, @var{b})}
5691 @tab @code{MCPXRS @var{a},@var{b},@var{c}}
5692 @item @code{void __MCPXRU (acc, uw1, uw1)}
5693 @tab @code{__MCPXRU (@var{c}, @var{a}, @var{b})}
5694 @tab @code{MCPXRU @var{a},@var{b},@var{c}}
5695 @item @code{uw1 __MCUT (acc, uw1)}
5696 @tab @code{@var{c} = __MCUT (@var{a}, @var{b})}
5697 @tab @code{MCUT @var{a},@var{b},@var{c}}
5698 @item @code{uw1 __MCUTSS (acc, sw1)}
5699 @tab @code{@var{c} = __MCUTSS (@var{a}, @var{b})}
5700 @tab @code{MCUTSS @var{a},@var{b},@var{c}}
5701 @item @code{void __MDADDACCS (acc, acc)}
5702 @tab @code{__MDADDACCS (@var{b}, @var{a})}
5703 @tab @code{MDADDACCS @var{a},@var{b}}
5704 @item @code{void __MDASACCS (acc, acc)}
5705 @tab @code{__MDASACCS (@var{b}, @var{a})}
5706 @tab @code{MDASACCS @var{a},@var{b}}
5707 @item @code{uw2 __MDCUTSSI (acc, const)}
5708 @tab @code{@var{c} = __MDCUTSSI (@var{a}, @var{b})}
5709 @tab @code{MDCUTSSI @var{a},#@var{b},@var{c}}
5710 @item @code{uw2 __MDPACKH (uw2, uw2)}
5711 @tab @code{@var{c} = __MDPACKH (@var{a}, @var{b})}
5712 @tab @code{MDPACKH @var{a},@var{b},@var{c}}
5713 @item @code{uw2 __MDROTLI (uw2, const)}
5714 @tab @code{@var{c} = __MDROTLI (@var{a}, @var{b})}
5715 @tab @code{MDROTLI @var{a},#@var{b},@var{c}}
5716 @item @code{void __MDSUBACCS (acc, acc)}
5717 @tab @code{__MDSUBACCS (@var{b}, @var{a})}
5718 @tab @code{MDSUBACCS @var{a},@var{b}}
5719 @item @code{void __MDUNPACKH (uw1 *, uw2)}
5720 @tab @code{__MDUNPACKH (&@var{b}, @var{a})}
5721 @tab @code{MDUNPACKH @var{a},@var{b}}
5722 @item @code{uw2 __MEXPDHD (uw1, const)}
5723 @tab @code{@var{c} = __MEXPDHD (@var{a}, @var{b})}
5724 @tab @code{MEXPDHD @var{a},#@var{b},@var{c}}
5725 @item @code{uw1 __MEXPDHW (uw1, const)}
5726 @tab @code{@var{c} = __MEXPDHW (@var{a}, @var{b})}
5727 @tab @code{MEXPDHW @var{a},#@var{b},@var{c}}
5728 @item @code{uw1 __MHDSETH (uw1, const)}
5729 @tab @code{@var{c} = __MHDSETH (@var{a}, @var{b})}
5730 @tab @code{MHDSETH @var{a},#@var{b},@var{c}}
5731 @item @code{sw1 __MHDSETS (const)}
5732 @tab @code{@var{b} = __MHDSETS (@var{a})}
5733 @tab @code{MHDSETS #@var{a},@var{b}}
5734 @item @code{uw1 __MHSETHIH (uw1, const)}
5735 @tab @code{@var{b} = __MHSETHIH (@var{b}, @var{a})}
5736 @tab @code{MHSETHIH #@var{a},@var{b}}
5737 @item @code{sw1 __MHSETHIS (sw1, const)}
5738 @tab @code{@var{b} = __MHSETHIS (@var{b}, @var{a})}
5739 @tab @code{MHSETHIS #@var{a},@var{b}}
5740 @item @code{uw1 __MHSETLOH (uw1, const)}
5741 @tab @code{@var{b} = __MHSETLOH (@var{b}, @var{a})}
5742 @tab @code{MHSETLOH #@var{a},@var{b}}
5743 @item @code{sw1 __MHSETLOS (sw1, const)}
5744 @tab @code{@var{b} = __MHSETLOS (@var{b}, @var{a})}
5745 @tab @code{MHSETLOS #@var{a},@var{b}}
5746 @item @code{uw1 __MHTOB (uw2)}
5747 @tab @code{@var{b} = __MHTOB (@var{a})}
5748 @tab @code{MHTOB @var{a},@var{b}}
5749 @item @code{void __MMACHS (acc, sw1, sw1)}
5750 @tab @code{__MMACHS (@var{c}, @var{a}, @var{b})}
5751 @tab @code{MMACHS @var{a},@var{b},@var{c}}
5752 @item @code{void __MMACHU (acc, uw1, uw1)}
5753 @tab @code{__MMACHU (@var{c}, @var{a}, @var{b})}
5754 @tab @code{MMACHU @var{a},@var{b},@var{c}}
5755 @item @code{void __MMRDHS (acc, sw1, sw1)}
5756 @tab @code{__MMRDHS (@var{c}, @var{a}, @var{b})}
5757 @tab @code{MMRDHS @var{a},@var{b},@var{c}}
5758 @item @code{void __MMRDHU (acc, uw1, uw1)}
5759 @tab @code{__MMRDHU (@var{c}, @var{a}, @var{b})}
5760 @tab @code{MMRDHU @var{a},@var{b},@var{c}}
5761 @item @code{void __MMULHS (acc, sw1, sw1)}
5762 @tab @code{__MMULHS (@var{c}, @var{a}, @var{b})}
5763 @tab @code{MMULHS @var{a},@var{b},@var{c}}
5764 @item @code{void __MMULHU (acc, uw1, uw1)}
5765 @tab @code{__MMULHU (@var{c}, @var{a}, @var{b})}
5766 @tab @code{MMULHU @var{a},@var{b},@var{c}}
5767 @item @code{void __MMULXHS (acc, sw1, sw1)}
5768 @tab @code{__MMULXHS (@var{c}, @var{a}, @var{b})}
5769 @tab @code{MMULXHS @var{a},@var{b},@var{c}}
5770 @item @code{void __MMULXHU (acc, uw1, uw1)}
5771 @tab @code{__MMULXHU (@var{c}, @var{a}, @var{b})}
5772 @tab @code{MMULXHU @var{a},@var{b},@var{c}}
5773 @item @code{uw1 __MNOT (uw1)}
5774 @tab @code{@var{b} = __MNOT (@var{a})}
5775 @tab @code{MNOT @var{a},@var{b}}
5776 @item @code{uw1 __MOR (uw1, uw1)}
5777 @tab @code{@var{c} = __MOR (@var{a}, @var{b})}
5778 @tab @code{MOR @var{a},@var{b},@var{c}}
5779 @item @code{uw1 __MPACKH (uh, uh)}
5780 @tab @code{@var{c} = __MPACKH (@var{a}, @var{b})}
5781 @tab @code{MPACKH @var{a},@var{b},@var{c}}
5782 @item @code{sw2 __MQADDHSS (sw2, sw2)}
5783 @tab @code{@var{c} = __MQADDHSS (@var{a}, @var{b})}
5784 @tab @code{MQADDHSS @var{a},@var{b},@var{c}}
5785 @item @code{uw2 __MQADDHUS (uw2, uw2)}
5786 @tab @code{@var{c} = __MQADDHUS (@var{a}, @var{b})}
5787 @tab @code{MQADDHUS @var{a},@var{b},@var{c}}
5788 @item @code{void __MQCPXIS (acc, sw2, sw2)}
5789 @tab @code{__MQCPXIS (@var{c}, @var{a}, @var{b})}
5790 @tab @code{MQCPXIS @var{a},@var{b},@var{c}}
5791 @item @code{void __MQCPXIU (acc, uw2, uw2)}
5792 @tab @code{__MQCPXIU (@var{c}, @var{a}, @var{b})}
5793 @tab @code{MQCPXIU @var{a},@var{b},@var{c}}
5794 @item @code{void __MQCPXRS (acc, sw2, sw2)}
5795 @tab @code{__MQCPXRS (@var{c}, @var{a}, @var{b})}
5796 @tab @code{MQCPXRS @var{a},@var{b},@var{c}}
5797 @item @code{void __MQCPXRU (acc, uw2, uw2)}
5798 @tab @code{__MQCPXRU (@var{c}, @var{a}, @var{b})}
5799 @tab @code{MQCPXRU @var{a},@var{b},@var{c}}
5800 @item @code{sw2 __MQLCLRHS (sw2, sw2)}
5801 @tab @code{@var{c} = __MQLCLRHS (@var{a}, @var{b})}
5802 @tab @code{MQLCLRHS @var{a},@var{b},@var{c}}
5803 @item @code{sw2 __MQLMTHS (sw2, sw2)}
5804 @tab @code{@var{c} = __MQLMTHS (@var{a}, @var{b})}
5805 @tab @code{MQLMTHS @var{a},@var{b},@var{c}}
5806 @item @code{void __MQMACHS (acc, sw2, sw2)}
5807 @tab @code{__MQMACHS (@var{c}, @var{a}, @var{b})}
5808 @tab @code{MQMACHS @var{a},@var{b},@var{c}}
5809 @item @code{void __MQMACHU (acc, uw2, uw2)}
5810 @tab @code{__MQMACHU (@var{c}, @var{a}, @var{b})}
5811 @tab @code{MQMACHU @var{a},@var{b},@var{c}}
5812 @item @code{void __MQMACXHS (acc, sw2, sw2)}
5813 @tab @code{__MQMACXHS (@var{c}, @var{a}, @var{b})}
5814 @tab @code{MQMACXHS @var{a},@var{b},@var{c}}
5815 @item @code{void __MQMULHS (acc, sw2, sw2)}
5816 @tab @code{__MQMULHS (@var{c}, @var{a}, @var{b})}
5817 @tab @code{MQMULHS @var{a},@var{b},@var{c}}
5818 @item @code{void __MQMULHU (acc, uw2, uw2)}
5819 @tab @code{__MQMULHU (@var{c}, @var{a}, @var{b})}
5820 @tab @code{MQMULHU @var{a},@var{b},@var{c}}
5821 @item @code{void __MQMULXHS (acc, sw2, sw2)}
5822 @tab @code{__MQMULXHS (@var{c}, @var{a}, @var{b})}
5823 @tab @code{MQMULXHS @var{a},@var{b},@var{c}}
5824 @item @code{void __MQMULXHU (acc, uw2, uw2)}
5825 @tab @code{__MQMULXHU (@var{c}, @var{a}, @var{b})}
5826 @tab @code{MQMULXHU @var{a},@var{b},@var{c}}
5827 @item @code{sw2 __MQSATHS (sw2, sw2)}
5828 @tab @code{@var{c} = __MQSATHS (@var{a}, @var{b})}
5829 @tab @code{MQSATHS @var{a},@var{b},@var{c}}
5830 @item @code{uw2 __MQSLLHI (uw2, int)}
5831 @tab @code{@var{c} = __MQSLLHI (@var{a}, @var{b})}
5832 @tab @code{MQSLLHI @var{a},@var{b},@var{c}}
5833 @item @code{sw2 __MQSRAHI (sw2, int)}
5834 @tab @code{@var{c} = __MQSRAHI (@var{a}, @var{b})}
5835 @tab @code{MQSRAHI @var{a},@var{b},@var{c}}
5836 @item @code{sw2 __MQSUBHSS (sw2, sw2)}
5837 @tab @code{@var{c} = __MQSUBHSS (@var{a}, @var{b})}
5838 @tab @code{MQSUBHSS @var{a},@var{b},@var{c}}
5839 @item @code{uw2 __MQSUBHUS (uw2, uw2)}
5840 @tab @code{@var{c} = __MQSUBHUS (@var{a}, @var{b})}
5841 @tab @code{MQSUBHUS @var{a},@var{b},@var{c}}
5842 @item @code{void __MQXMACHS (acc, sw2, sw2)}
5843 @tab @code{__MQXMACHS (@var{c}, @var{a}, @var{b})}
5844 @tab @code{MQXMACHS @var{a},@var{b},@var{c}}
5845 @item @code{void __MQXMACXHS (acc, sw2, sw2)}
5846 @tab @code{__MQXMACXHS (@var{c}, @var{a}, @var{b})}
5847 @tab @code{MQXMACXHS @var{a},@var{b},@var{c}}
5848 @item @code{uw1 __MRDACC (acc)}
5849 @tab @code{@var{b} = __MRDACC (@var{a})}
5850 @tab @code{MRDACC @var{a},@var{b}}
5851 @item @code{uw1 __MRDACCG (acc)}
5852 @tab @code{@var{b} = __MRDACCG (@var{a})}
5853 @tab @code{MRDACCG @var{a},@var{b}}
5854 @item @code{uw1 __MROTLI (uw1, const)}
5855 @tab @code{@var{c} = __MROTLI (@var{a}, @var{b})}
5856 @tab @code{MROTLI @var{a},#@var{b},@var{c}}
5857 @item @code{uw1 __MROTRI (uw1, const)}
5858 @tab @code{@var{c} = __MROTRI (@var{a}, @var{b})}
5859 @tab @code{MROTRI @var{a},#@var{b},@var{c}}
5860 @item @code{sw1 __MSATHS (sw1, sw1)}
5861 @tab @code{@var{c} = __MSATHS (@var{a}, @var{b})}
5862 @tab @code{MSATHS @var{a},@var{b},@var{c}}
5863 @item @code{uw1 __MSATHU (uw1, uw1)}
5864 @tab @code{@var{c} = __MSATHU (@var{a}, @var{b})}
5865 @tab @code{MSATHU @var{a},@var{b},@var{c}}
5866 @item @code{uw1 __MSLLHI (uw1, const)}
5867 @tab @code{@var{c} = __MSLLHI (@var{a}, @var{b})}
5868 @tab @code{MSLLHI @var{a},#@var{b},@var{c}}
5869 @item @code{sw1 __MSRAHI (sw1, const)}
5870 @tab @code{@var{c} = __MSRAHI (@var{a}, @var{b})}
5871 @tab @code{MSRAHI @var{a},#@var{b},@var{c}}
5872 @item @code{uw1 __MSRLHI (uw1, const)}
5873 @tab @code{@var{c} = __MSRLHI (@var{a}, @var{b})}
5874 @tab @code{MSRLHI @var{a},#@var{b},@var{c}}
5875 @item @code{void __MSUBACCS (acc, acc)}
5876 @tab @code{__MSUBACCS (@var{b}, @var{a})}
5877 @tab @code{MSUBACCS @var{a},@var{b}}
5878 @item @code{sw1 __MSUBHSS (sw1, sw1)}
5879 @tab @code{@var{c} = __MSUBHSS (@var{a}, @var{b})}
5880 @tab @code{MSUBHSS @var{a},@var{b},@var{c}}
5881 @item @code{uw1 __MSUBHUS (uw1, uw1)}
5882 @tab @code{@var{c} = __MSUBHUS (@var{a}, @var{b})}
5883 @tab @code{MSUBHUS @var{a},@var{b},@var{c}}
5884 @item @code{void __MTRAP (void)}
5885 @tab @code{__MTRAP ()}
5886 @tab @code{MTRAP}
5887 @item @code{uw2 __MUNPACKH (uw1)}
5888 @tab @code{@var{b} = __MUNPACKH (@var{a})}
5889 @tab @code{MUNPACKH @var{a},@var{b}}
5890 @item @code{uw1 __MWCUT (uw2, uw1)}
5891 @tab @code{@var{c} = __MWCUT (@var{a}, @var{b})}
5892 @tab @code{MWCUT @var{a},@var{b},@var{c}}
5893 @item @code{void __MWTACC (acc, uw1)}
5894 @tab @code{__MWTACC (@var{b}, @var{a})}
5895 @tab @code{MWTACC @var{a},@var{b}}
5896 @item @code{void __MWTACCG (acc, uw1)}
5897 @tab @code{__MWTACCG (@var{b}, @var{a})}
5898 @tab @code{MWTACCG @var{a},@var{b}}
5899 @item @code{uw1 __MXOR (uw1, uw1)}
5900 @tab @code{@var{c} = __MXOR (@var{a}, @var{b})}
5901 @tab @code{MXOR @var{a},@var{b},@var{c}}
5902 @end multitable
5903
5904 @node Other Built-in Functions
5905 @subsubsection Other Built-in Functions
5906
5907 This section describes built-in functions that are not named after
5908 a specific FR-V instruction.
5909
5910 @table @code
5911 @item sw2 __IACCreadll (iacc @var{reg})
5912 Return the full 64-bit value of IACC0@. The @var{reg} argument is reserved
5913 for future expansion and must be 0.
5914
5915 @item sw1 __IACCreadl (iacc @var{reg})
5916 Return the value of IACC0H if @var{reg} is 0 and IACC0L if @var{reg} is 1.
5917 Other values of @var{reg} are rejected as invalid.
5918
5919 @item void __IACCsetll (iacc @var{reg}, sw2 @var{x})
5920 Set the full 64-bit value of IACC0 to @var{x}. The @var{reg} argument
5921 is reserved for future expansion and must be 0.
5922
5923 @item void __IACCsetl (iacc @var{reg}, sw1 @var{x})
5924 Set IACC0H to @var{x} if @var{reg} is 0 and IACC0L to @var{x} if @var{reg}
5925 is 1. Other values of @var{reg} are rejected as invalid.
5926
5927 @item void __data_prefetch0 (const void *@var{x})
5928 Use the @code{dcpl} instruction to load the contents of address @var{x}
5929 into the data cache.
5930
5931 @item void __data_prefetch (const void *@var{x})
5932 Use the @code{nldub} instruction to load the contents of address @var{x}
5933 into the data cache. The instruction will be issued in slot I1@.
5934 @end table
5935
5936 @node X86 Built-in Functions
5937 @subsection X86 Built-in Functions
5938
5939 These built-in functions are available for the i386 and x86-64 family
5940 of computers, depending on the command-line switches used.
5941
5942 The following machine modes are available for use with MMX built-in functions
5943 (@pxref{Vector Extensions}): @code{V2SI} for a vector of two 32-bit integers,
5944 @code{V4HI} for a vector of four 16-bit integers, and @code{V8QI} for a
5945 vector of eight 8-bit integers. Some of the built-in functions operate on
5946 MMX registers as a whole 64-bit entity, these use @code{DI} as their mode.
5947
5948 If 3Dnow extensions are enabled, @code{V2SF} is used as a mode for a vector
5949 of two 32-bit floating point values.
5950
5951 If SSE extensions are enabled, @code{V4SF} is used for a vector of four 32-bit
5952 floating point values. Some instructions use a vector of four 32-bit
5953 integers, these use @code{V4SI}. Finally, some instructions operate on an
5954 entire vector register, interpreting it as a 128-bit integer, these use mode
5955 @code{TI}.
5956
5957 The following built-in functions are made available by @option{-mmmx}.
5958 All of them generate the machine instruction that is part of the name.
5959
5960 @smallexample
5961 v8qi __builtin_ia32_paddb (v8qi, v8qi)
5962 v4hi __builtin_ia32_paddw (v4hi, v4hi)
5963 v2si __builtin_ia32_paddd (v2si, v2si)
5964 v8qi __builtin_ia32_psubb (v8qi, v8qi)
5965 v4hi __builtin_ia32_psubw (v4hi, v4hi)
5966 v2si __builtin_ia32_psubd (v2si, v2si)
5967 v8qi __builtin_ia32_paddsb (v8qi, v8qi)
5968 v4hi __builtin_ia32_paddsw (v4hi, v4hi)
5969 v8qi __builtin_ia32_psubsb (v8qi, v8qi)
5970 v4hi __builtin_ia32_psubsw (v4hi, v4hi)
5971 v8qi __builtin_ia32_paddusb (v8qi, v8qi)
5972 v4hi __builtin_ia32_paddusw (v4hi, v4hi)
5973 v8qi __builtin_ia32_psubusb (v8qi, v8qi)
5974 v4hi __builtin_ia32_psubusw (v4hi, v4hi)
5975 v4hi __builtin_ia32_pmullw (v4hi, v4hi)
5976 v4hi __builtin_ia32_pmulhw (v4hi, v4hi)
5977 di __builtin_ia32_pand (di, di)
5978 di __builtin_ia32_pandn (di,di)
5979 di __builtin_ia32_por (di, di)
5980 di __builtin_ia32_pxor (di, di)
5981 v8qi __builtin_ia32_pcmpeqb (v8qi, v8qi)
5982 v4hi __builtin_ia32_pcmpeqw (v4hi, v4hi)
5983 v2si __builtin_ia32_pcmpeqd (v2si, v2si)
5984 v8qi __builtin_ia32_pcmpgtb (v8qi, v8qi)
5985 v4hi __builtin_ia32_pcmpgtw (v4hi, v4hi)
5986 v2si __builtin_ia32_pcmpgtd (v2si, v2si)
5987 v8qi __builtin_ia32_punpckhbw (v8qi, v8qi)
5988 v4hi __builtin_ia32_punpckhwd (v4hi, v4hi)
5989 v2si __builtin_ia32_punpckhdq (v2si, v2si)
5990 v8qi __builtin_ia32_punpcklbw (v8qi, v8qi)
5991 v4hi __builtin_ia32_punpcklwd (v4hi, v4hi)
5992 v2si __builtin_ia32_punpckldq (v2si, v2si)
5993 v8qi __builtin_ia32_packsswb (v4hi, v4hi)
5994 v4hi __builtin_ia32_packssdw (v2si, v2si)
5995 v8qi __builtin_ia32_packuswb (v4hi, v4hi)
5996 @end smallexample
5997
5998 The following built-in functions are made available either with
5999 @option{-msse}, or with a combination of @option{-m3dnow} and
6000 @option{-march=athlon}. All of them generate the machine
6001 instruction that is part of the name.
6002
6003 @smallexample
6004 v4hi __builtin_ia32_pmulhuw (v4hi, v4hi)
6005 v8qi __builtin_ia32_pavgb (v8qi, v8qi)
6006 v4hi __builtin_ia32_pavgw (v4hi, v4hi)
6007 v4hi __builtin_ia32_psadbw (v8qi, v8qi)
6008 v8qi __builtin_ia32_pmaxub (v8qi, v8qi)
6009 v4hi __builtin_ia32_pmaxsw (v4hi, v4hi)
6010 v8qi __builtin_ia32_pminub (v8qi, v8qi)
6011 v4hi __builtin_ia32_pminsw (v4hi, v4hi)
6012 int __builtin_ia32_pextrw (v4hi, int)
6013 v4hi __builtin_ia32_pinsrw (v4hi, int, int)
6014 int __builtin_ia32_pmovmskb (v8qi)
6015 void __builtin_ia32_maskmovq (v8qi, v8qi, char *)
6016 void __builtin_ia32_movntq (di *, di)
6017 void __builtin_ia32_sfence (void)
6018 @end smallexample
6019
6020 The following built-in functions are available when @option{-msse} is used.
6021 All of them generate the machine instruction that is part of the name.
6022
6023 @smallexample
6024 int __builtin_ia32_comieq (v4sf, v4sf)
6025 int __builtin_ia32_comineq (v4sf, v4sf)
6026 int __builtin_ia32_comilt (v4sf, v4sf)
6027 int __builtin_ia32_comile (v4sf, v4sf)
6028 int __builtin_ia32_comigt (v4sf, v4sf)
6029 int __builtin_ia32_comige (v4sf, v4sf)
6030 int __builtin_ia32_ucomieq (v4sf, v4sf)
6031 int __builtin_ia32_ucomineq (v4sf, v4sf)
6032 int __builtin_ia32_ucomilt (v4sf, v4sf)
6033 int __builtin_ia32_ucomile (v4sf, v4sf)
6034 int __builtin_ia32_ucomigt (v4sf, v4sf)
6035 int __builtin_ia32_ucomige (v4sf, v4sf)
6036 v4sf __builtin_ia32_addps (v4sf, v4sf)
6037 v4sf __builtin_ia32_subps (v4sf, v4sf)
6038 v4sf __builtin_ia32_mulps (v4sf, v4sf)
6039 v4sf __builtin_ia32_divps (v4sf, v4sf)
6040 v4sf __builtin_ia32_addss (v4sf, v4sf)
6041 v4sf __builtin_ia32_subss (v4sf, v4sf)
6042 v4sf __builtin_ia32_mulss (v4sf, v4sf)
6043 v4sf __builtin_ia32_divss (v4sf, v4sf)
6044 v4si __builtin_ia32_cmpeqps (v4sf, v4sf)
6045 v4si __builtin_ia32_cmpltps (v4sf, v4sf)
6046 v4si __builtin_ia32_cmpleps (v4sf, v4sf)
6047 v4si __builtin_ia32_cmpgtps (v4sf, v4sf)
6048 v4si __builtin_ia32_cmpgeps (v4sf, v4sf)
6049 v4si __builtin_ia32_cmpunordps (v4sf, v4sf)
6050 v4si __builtin_ia32_cmpneqps (v4sf, v4sf)
6051 v4si __builtin_ia32_cmpnltps (v4sf, v4sf)
6052 v4si __builtin_ia32_cmpnleps (v4sf, v4sf)
6053 v4si __builtin_ia32_cmpngtps (v4sf, v4sf)
6054 v4si __builtin_ia32_cmpngeps (v4sf, v4sf)
6055 v4si __builtin_ia32_cmpordps (v4sf, v4sf)
6056 v4si __builtin_ia32_cmpeqss (v4sf, v4sf)
6057 v4si __builtin_ia32_cmpltss (v4sf, v4sf)
6058 v4si __builtin_ia32_cmpless (v4sf, v4sf)
6059 v4si __builtin_ia32_cmpunordss (v4sf, v4sf)
6060 v4si __builtin_ia32_cmpneqss (v4sf, v4sf)
6061 v4si __builtin_ia32_cmpnlts (v4sf, v4sf)
6062 v4si __builtin_ia32_cmpnless (v4sf, v4sf)
6063 v4si __builtin_ia32_cmpordss (v4sf, v4sf)
6064 v4sf __builtin_ia32_maxps (v4sf, v4sf)
6065 v4sf __builtin_ia32_maxss (v4sf, v4sf)
6066 v4sf __builtin_ia32_minps (v4sf, v4sf)
6067 v4sf __builtin_ia32_minss (v4sf, v4sf)
6068 v4sf __builtin_ia32_andps (v4sf, v4sf)
6069 v4sf __builtin_ia32_andnps (v4sf, v4sf)
6070 v4sf __builtin_ia32_orps (v4sf, v4sf)
6071 v4sf __builtin_ia32_xorps (v4sf, v4sf)
6072 v4sf __builtin_ia32_movss (v4sf, v4sf)
6073 v4sf __builtin_ia32_movhlps (v4sf, v4sf)
6074 v4sf __builtin_ia32_movlhps (v4sf, v4sf)
6075 v4sf __builtin_ia32_unpckhps (v4sf, v4sf)
6076 v4sf __builtin_ia32_unpcklps (v4sf, v4sf)
6077 v4sf __builtin_ia32_cvtpi2ps (v4sf, v2si)
6078 v4sf __builtin_ia32_cvtsi2ss (v4sf, int)
6079 v2si __builtin_ia32_cvtps2pi (v4sf)
6080 int __builtin_ia32_cvtss2si (v4sf)
6081 v2si __builtin_ia32_cvttps2pi (v4sf)
6082 int __builtin_ia32_cvttss2si (v4sf)
6083 v4sf __builtin_ia32_rcpps (v4sf)
6084 v4sf __builtin_ia32_rsqrtps (v4sf)
6085 v4sf __builtin_ia32_sqrtps (v4sf)
6086 v4sf __builtin_ia32_rcpss (v4sf)
6087 v4sf __builtin_ia32_rsqrtss (v4sf)
6088 v4sf __builtin_ia32_sqrtss (v4sf)
6089 v4sf __builtin_ia32_shufps (v4sf, v4sf, int)
6090 void __builtin_ia32_movntps (float *, v4sf)
6091 int __builtin_ia32_movmskps (v4sf)
6092 @end smallexample
6093
6094 The following built-in functions are available when @option{-msse} is used.
6095
6096 @table @code
6097 @item v4sf __builtin_ia32_loadaps (float *)
6098 Generates the @code{movaps} machine instruction as a load from memory.
6099 @item void __builtin_ia32_storeaps (float *, v4sf)
6100 Generates the @code{movaps} machine instruction as a store to memory.
6101 @item v4sf __builtin_ia32_loadups (float *)
6102 Generates the @code{movups} machine instruction as a load from memory.
6103 @item void __builtin_ia32_storeups (float *, v4sf)
6104 Generates the @code{movups} machine instruction as a store to memory.
6105 @item v4sf __builtin_ia32_loadsss (float *)
6106 Generates the @code{movss} machine instruction as a load from memory.
6107 @item void __builtin_ia32_storess (float *, v4sf)
6108 Generates the @code{movss} machine instruction as a store to memory.
6109 @item v4sf __builtin_ia32_loadhps (v4sf, v2si *)
6110 Generates the @code{movhps} machine instruction as a load from memory.
6111 @item v4sf __builtin_ia32_loadlps (v4sf, v2si *)
6112 Generates the @code{movlps} machine instruction as a load from memory
6113 @item void __builtin_ia32_storehps (v4sf, v2si *)
6114 Generates the @code{movhps} machine instruction as a store to memory.
6115 @item void __builtin_ia32_storelps (v4sf, v2si *)
6116 Generates the @code{movlps} machine instruction as a store to memory.
6117 @end table
6118
6119 The following built-in functions are available when @option{-msse3} is used.
6120 All of them generate the machine instruction that is part of the name.
6121
6122 @smallexample
6123 v2df __builtin_ia32_addsubpd (v2df, v2df)
6124 v2df __builtin_ia32_addsubps (v2df, v2df)
6125 v2df __builtin_ia32_haddpd (v2df, v2df)
6126 v2df __builtin_ia32_haddps (v2df, v2df)
6127 v2df __builtin_ia32_hsubpd (v2df, v2df)
6128 v2df __builtin_ia32_hsubps (v2df, v2df)
6129 v16qi __builtin_ia32_lddqu (char const *)
6130 void __builtin_ia32_monitor (void *, unsigned int, unsigned int)
6131 v2df __builtin_ia32_movddup (v2df)
6132 v4sf __builtin_ia32_movshdup (v4sf)
6133 v4sf __builtin_ia32_movsldup (v4sf)
6134 void __builtin_ia32_mwait (unsigned int, unsigned int)
6135 @end smallexample
6136
6137 The following built-in functions are available when @option{-msse3} is used.
6138
6139 @table @code
6140 @item v2df __builtin_ia32_loadddup (double const *)
6141 Generates the @code{movddup} machine instruction as a load from memory.
6142 @end table
6143
6144 The following built-in functions are available when @option{-m3dnow} is used.
6145 All of them generate the machine instruction that is part of the name.
6146
6147 @smallexample
6148 void __builtin_ia32_femms (void)
6149 v8qi __builtin_ia32_pavgusb (v8qi, v8qi)
6150 v2si __builtin_ia32_pf2id (v2sf)
6151 v2sf __builtin_ia32_pfacc (v2sf, v2sf)
6152 v2sf __builtin_ia32_pfadd (v2sf, v2sf)
6153 v2si __builtin_ia32_pfcmpeq (v2sf, v2sf)
6154 v2si __builtin_ia32_pfcmpge (v2sf, v2sf)
6155 v2si __builtin_ia32_pfcmpgt (v2sf, v2sf)
6156 v2sf __builtin_ia32_pfmax (v2sf, v2sf)
6157 v2sf __builtin_ia32_pfmin (v2sf, v2sf)
6158 v2sf __builtin_ia32_pfmul (v2sf, v2sf)
6159 v2sf __builtin_ia32_pfrcp (v2sf)
6160 v2sf __builtin_ia32_pfrcpit1 (v2sf, v2sf)
6161 v2sf __builtin_ia32_pfrcpit2 (v2sf, v2sf)
6162 v2sf __builtin_ia32_pfrsqrt (v2sf)
6163 v2sf __builtin_ia32_pfrsqrtit1 (v2sf, v2sf)
6164 v2sf __builtin_ia32_pfsub (v2sf, v2sf)
6165 v2sf __builtin_ia32_pfsubr (v2sf, v2sf)
6166 v2sf __builtin_ia32_pi2fd (v2si)
6167 v4hi __builtin_ia32_pmulhrw (v4hi, v4hi)
6168 @end smallexample
6169
6170 The following built-in functions are available when both @option{-m3dnow}
6171 and @option{-march=athlon} are used. All of them generate the machine
6172 instruction that is part of the name.
6173
6174 @smallexample
6175 v2si __builtin_ia32_pf2iw (v2sf)
6176 v2sf __builtin_ia32_pfnacc (v2sf, v2sf)
6177 v2sf __builtin_ia32_pfpnacc (v2sf, v2sf)
6178 v2sf __builtin_ia32_pi2fw (v2si)
6179 v2sf __builtin_ia32_pswapdsf (v2sf)
6180 v2si __builtin_ia32_pswapdsi (v2si)
6181 @end smallexample
6182
6183 @node PowerPC AltiVec Built-in Functions
6184 @subsection PowerPC AltiVec Built-in Functions
6185
6186 GCC provides an interface for the PowerPC family of processors to access
6187 the AltiVec operations described in Motorola's AltiVec Programming
6188 Interface Manual. The interface is made available by including
6189 @code{<altivec.h>} and using @option{-maltivec} and
6190 @option{-mabi=altivec}. The interface supports the following vector
6191 types.
6192
6193 @smallexample
6194 vector unsigned char
6195 vector signed char
6196 vector bool char
6197
6198 vector unsigned short
6199 vector signed short
6200 vector bool short
6201 vector pixel
6202
6203 vector unsigned int
6204 vector signed int
6205 vector bool int
6206 vector float
6207 @end smallexample
6208
6209 GCC's implementation of the high-level language interface available from
6210 C and C++ code differs from Motorola's documentation in several ways.
6211
6212 @itemize @bullet
6213
6214 @item
6215 A vector constant is a list of constant expressions within curly braces.
6216
6217 @item
6218 A vector initializer requires no cast if the vector constant is of the
6219 same type as the variable it is initializing.
6220
6221 @item
6222 If @code{signed} or @code{unsigned} is omitted, the vector type defaults
6223 to @code{signed} for @code{vector int} or @code{vector short} and to
6224 @code{unsigned} for @code{vector char}.
6225
6226 @item
6227 Compiling with @option{-maltivec} adds keywords @code{__vector},
6228 @code{__pixel}, and @code{__bool}. Macros @option{vector},
6229 @code{pixel}, and @code{bool} are defined in @code{<altivec.h>} and can
6230 be undefined.
6231
6232 @item
6233 GCC allows using a @code{typedef} name as the type specifier for a
6234 vector type.
6235
6236 @item
6237 For C, overloaded functions are implemented with macros so the following
6238 does not work:
6239
6240 @smallexample
6241 vec_add ((vector signed int)@{1, 2, 3, 4@}, foo);
6242 @end smallexample
6243
6244 Since @code{vec_add} is a macro, the vector constant in the example
6245 is treated as four separate arguments. Wrap the entire argument in
6246 parentheses for this to work.
6247 @end itemize
6248
6249 @emph{Note:} Only the @code{<altivec.h>} interface is supported.
6250 Internally, GCC uses built-in functions to achieve the functionality in
6251 the aforementioned header file, but they are not supported and are
6252 subject to change without notice.
6253
6254 The following interfaces are supported for the generic and specific
6255 AltiVec operations and the AltiVec predicates. In cases where there
6256 is a direct mapping between generic and specific operations, only the
6257 generic names are shown here, although the specific operations can also
6258 be used.
6259
6260 Arguments that are documented as @code{const int} require literal
6261 integral values within the range required for that operation.
6262
6263 @smallexample
6264 vector signed char vec_abs (vector signed char);
6265 vector signed short vec_abs (vector signed short);
6266 vector signed int vec_abs (vector signed int);
6267 vector float vec_abs (vector float);
6268
6269 vector signed char vec_abss (vector signed char);
6270 vector signed short vec_abss (vector signed short);
6271 vector signed int vec_abss (vector signed int);
6272
6273 vector signed char vec_add (vector bool char, vector signed char);
6274 vector signed char vec_add (vector signed char, vector bool char);
6275 vector signed char vec_add (vector signed char, vector signed char);
6276 vector unsigned char vec_add (vector bool char, vector unsigned char);
6277 vector unsigned char vec_add (vector unsigned char, vector bool char);
6278 vector unsigned char vec_add (vector unsigned char,
6279 vector unsigned char);
6280 vector signed short vec_add (vector bool short, vector signed short);
6281 vector signed short vec_add (vector signed short, vector bool short);
6282 vector signed short vec_add (vector signed short, vector signed short);
6283 vector unsigned short vec_add (vector bool short,
6284 vector unsigned short);
6285 vector unsigned short vec_add (vector unsigned short,
6286 vector bool short);
6287 vector unsigned short vec_add (vector unsigned short,
6288 vector unsigned short);
6289 vector signed int vec_add (vector bool int, vector signed int);
6290 vector signed int vec_add (vector signed int, vector bool int);
6291 vector signed int vec_add (vector signed int, vector signed int);
6292 vector unsigned int vec_add (vector bool int, vector unsigned int);
6293 vector unsigned int vec_add (vector unsigned int, vector bool int);
6294 vector unsigned int vec_add (vector unsigned int, vector unsigned int);
6295 vector float vec_add (vector float, vector float);
6296
6297 vector float vec_vaddfp (vector float, vector float);
6298
6299 vector signed int vec_vadduwm (vector bool int, vector signed int);
6300 vector signed int vec_vadduwm (vector signed int, vector bool int);
6301 vector signed int vec_vadduwm (vector signed int, vector signed int);
6302 vector unsigned int vec_vadduwm (vector bool int, vector unsigned int);
6303 vector unsigned int vec_vadduwm (vector unsigned int, vector bool int);
6304 vector unsigned int vec_vadduwm (vector unsigned int,
6305 vector unsigned int);
6306
6307 vector signed short vec_vadduhm (vector bool short,
6308 vector signed short);
6309 vector signed short vec_vadduhm (vector signed short,
6310 vector bool short);
6311 vector signed short vec_vadduhm (vector signed short,
6312 vector signed short);
6313 vector unsigned short vec_vadduhm (vector bool short,
6314 vector unsigned short);
6315 vector unsigned short vec_vadduhm (vector unsigned short,
6316 vector bool short);
6317 vector unsigned short vec_vadduhm (vector unsigned short,
6318 vector unsigned short);
6319
6320 vector signed char vec_vaddubm (vector bool char, vector signed char);
6321 vector signed char vec_vaddubm (vector signed char, vector bool char);
6322 vector signed char vec_vaddubm (vector signed char, vector signed char);
6323 vector unsigned char vec_vaddubm (vector bool char,
6324 vector unsigned char);
6325 vector unsigned char vec_vaddubm (vector unsigned char,
6326 vector bool char);
6327 vector unsigned char vec_vaddubm (vector unsigned char,
6328 vector unsigned char);
6329
6330 vector unsigned int vec_addc (vector unsigned int, vector unsigned int);
6331
6332 vector unsigned char vec_adds (vector bool char, vector unsigned char);
6333 vector unsigned char vec_adds (vector unsigned char, vector bool char);
6334 vector unsigned char vec_adds (vector unsigned char,
6335 vector unsigned char);
6336 vector signed char vec_adds (vector bool char, vector signed char);
6337 vector signed char vec_adds (vector signed char, vector bool char);
6338 vector signed char vec_adds (vector signed char, vector signed char);
6339 vector unsigned short vec_adds (vector bool short,
6340 vector unsigned short);
6341 vector unsigned short vec_adds (vector unsigned short,
6342 vector bool short);
6343 vector unsigned short vec_adds (vector unsigned short,
6344 vector unsigned short);
6345 vector signed short vec_adds (vector bool short, vector signed short);
6346 vector signed short vec_adds (vector signed short, vector bool short);
6347 vector signed short vec_adds (vector signed short, vector signed short);
6348 vector unsigned int vec_adds (vector bool int, vector unsigned int);
6349 vector unsigned int vec_adds (vector unsigned int, vector bool int);
6350 vector unsigned int vec_adds (vector unsigned int, vector unsigned int);
6351 vector signed int vec_adds (vector bool int, vector signed int);
6352 vector signed int vec_adds (vector signed int, vector bool int);
6353 vector signed int vec_adds (vector signed int, vector signed int);
6354
6355 vector signed int vec_vaddsws (vector bool int, vector signed int);
6356 vector signed int vec_vaddsws (vector signed int, vector bool int);
6357 vector signed int vec_vaddsws (vector signed int, vector signed int);
6358
6359 vector unsigned int vec_vadduws (vector bool int, vector unsigned int);
6360 vector unsigned int vec_vadduws (vector unsigned int, vector bool int);
6361 vector unsigned int vec_vadduws (vector unsigned int,
6362 vector unsigned int);
6363
6364 vector signed short vec_vaddshs (vector bool short,
6365 vector signed short);
6366 vector signed short vec_vaddshs (vector signed short,
6367 vector bool short);
6368 vector signed short vec_vaddshs (vector signed short,
6369 vector signed short);
6370
6371 vector unsigned short vec_vadduhs (vector bool short,
6372 vector unsigned short);
6373 vector unsigned short vec_vadduhs (vector unsigned short,
6374 vector bool short);
6375 vector unsigned short vec_vadduhs (vector unsigned short,
6376 vector unsigned short);
6377
6378 vector signed char vec_vaddsbs (vector bool char, vector signed char);
6379 vector signed char vec_vaddsbs (vector signed char, vector bool char);
6380 vector signed char vec_vaddsbs (vector signed char, vector signed char);
6381
6382 vector unsigned char vec_vaddubs (vector bool char,
6383 vector unsigned char);
6384 vector unsigned char vec_vaddubs (vector unsigned char,
6385 vector bool char);
6386 vector unsigned char vec_vaddubs (vector unsigned char,
6387 vector unsigned char);
6388
6389 vector float vec_and (vector float, vector float);
6390 vector float vec_and (vector float, vector bool int);
6391 vector float vec_and (vector bool int, vector float);
6392 vector bool int vec_and (vector bool int, vector bool int);
6393 vector signed int vec_and (vector bool int, vector signed int);
6394 vector signed int vec_and (vector signed int, vector bool int);
6395 vector signed int vec_and (vector signed int, vector signed int);
6396 vector unsigned int vec_and (vector bool int, vector unsigned int);
6397 vector unsigned int vec_and (vector unsigned int, vector bool int);
6398 vector unsigned int vec_and (vector unsigned int, vector unsigned int);
6399 vector bool short vec_and (vector bool short, vector bool short);
6400 vector signed short vec_and (vector bool short, vector signed short);
6401 vector signed short vec_and (vector signed short, vector bool short);
6402 vector signed short vec_and (vector signed short, vector signed short);
6403 vector unsigned short vec_and (vector bool short,
6404 vector unsigned short);
6405 vector unsigned short vec_and (vector unsigned short,
6406 vector bool short);
6407 vector unsigned short vec_and (vector unsigned short,
6408 vector unsigned short);
6409 vector signed char vec_and (vector bool char, vector signed char);
6410 vector bool char vec_and (vector bool char, vector bool char);
6411 vector signed char vec_and (vector signed char, vector bool char);
6412 vector signed char vec_and (vector signed char, vector signed char);
6413 vector unsigned char vec_and (vector bool char, vector unsigned char);
6414 vector unsigned char vec_and (vector unsigned char, vector bool char);
6415 vector unsigned char vec_and (vector unsigned char,
6416 vector unsigned char);
6417
6418 vector float vec_andc (vector float, vector float);
6419 vector float vec_andc (vector float, vector bool int);
6420 vector float vec_andc (vector bool int, vector float);
6421 vector bool int vec_andc (vector bool int, vector bool int);
6422 vector signed int vec_andc (vector bool int, vector signed int);
6423 vector signed int vec_andc (vector signed int, vector bool int);
6424 vector signed int vec_andc (vector signed int, vector signed int);
6425 vector unsigned int vec_andc (vector bool int, vector unsigned int);
6426 vector unsigned int vec_andc (vector unsigned int, vector bool int);
6427 vector unsigned int vec_andc (vector unsigned int, vector unsigned int);
6428 vector bool short vec_andc (vector bool short, vector bool short);
6429 vector signed short vec_andc (vector bool short, vector signed short);
6430 vector signed short vec_andc (vector signed short, vector bool short);
6431 vector signed short vec_andc (vector signed short, vector signed short);
6432 vector unsigned short vec_andc (vector bool short,
6433 vector unsigned short);
6434 vector unsigned short vec_andc (vector unsigned short,
6435 vector bool short);
6436 vector unsigned short vec_andc (vector unsigned short,
6437 vector unsigned short);
6438 vector signed char vec_andc (vector bool char, vector signed char);
6439 vector bool char vec_andc (vector bool char, vector bool char);
6440 vector signed char vec_andc (vector signed char, vector bool char);
6441 vector signed char vec_andc (vector signed char, vector signed char);
6442 vector unsigned char vec_andc (vector bool char, vector unsigned char);
6443 vector unsigned char vec_andc (vector unsigned char, vector bool char);
6444 vector unsigned char vec_andc (vector unsigned char,
6445 vector unsigned char);
6446
6447 vector unsigned char vec_avg (vector unsigned char,
6448 vector unsigned char);
6449 vector signed char vec_avg (vector signed char, vector signed char);
6450 vector unsigned short vec_avg (vector unsigned short,
6451 vector unsigned short);
6452 vector signed short vec_avg (vector signed short, vector signed short);
6453 vector unsigned int vec_avg (vector unsigned int, vector unsigned int);
6454 vector signed int vec_avg (vector signed int, vector signed int);
6455
6456 vector signed int vec_vavgsw (vector signed int, vector signed int);
6457
6458 vector unsigned int vec_vavguw (vector unsigned int,
6459 vector unsigned int);
6460
6461 vector signed short vec_vavgsh (vector signed short,
6462 vector signed short);
6463
6464 vector unsigned short vec_vavguh (vector unsigned short,
6465 vector unsigned short);
6466
6467 vector signed char vec_vavgsb (vector signed char, vector signed char);
6468
6469 vector unsigned char vec_vavgub (vector unsigned char,
6470 vector unsigned char);
6471
6472 vector float vec_ceil (vector float);
6473
6474 vector signed int vec_cmpb (vector float, vector float);
6475
6476 vector bool char vec_cmpeq (vector signed char, vector signed char);
6477 vector bool char vec_cmpeq (vector unsigned char, vector unsigned char);
6478 vector bool short vec_cmpeq (vector signed short, vector signed short);
6479 vector bool short vec_cmpeq (vector unsigned short,
6480 vector unsigned short);
6481 vector bool int vec_cmpeq (vector signed int, vector signed int);
6482 vector bool int vec_cmpeq (vector unsigned int, vector unsigned int);
6483 vector bool int vec_cmpeq (vector float, vector float);
6484
6485 vector bool int vec_vcmpeqfp (vector float, vector float);
6486
6487 vector bool int vec_vcmpequw (vector signed int, vector signed int);
6488 vector bool int vec_vcmpequw (vector unsigned int, vector unsigned int);
6489
6490 vector bool short vec_vcmpequh (vector signed short,
6491 vector signed short);
6492 vector bool short vec_vcmpequh (vector unsigned short,
6493 vector unsigned short);
6494
6495 vector bool char vec_vcmpequb (vector signed char, vector signed char);
6496 vector bool char vec_vcmpequb (vector unsigned char,
6497 vector unsigned char);
6498
6499 vector bool int vec_cmpge (vector float, vector float);
6500
6501 vector bool char vec_cmpgt (vector unsigned char, vector unsigned char);
6502 vector bool char vec_cmpgt (vector signed char, vector signed char);
6503 vector bool short vec_cmpgt (vector unsigned short,
6504 vector unsigned short);
6505 vector bool short vec_cmpgt (vector signed short, vector signed short);
6506 vector bool int vec_cmpgt (vector unsigned int, vector unsigned int);
6507 vector bool int vec_cmpgt (vector signed int, vector signed int);
6508 vector bool int vec_cmpgt (vector float, vector float);
6509
6510 vector bool int vec_vcmpgtfp (vector float, vector float);
6511
6512 vector bool int vec_vcmpgtsw (vector signed int, vector signed int);
6513
6514 vector bool int vec_vcmpgtuw (vector unsigned int, vector unsigned int);
6515
6516 vector bool short vec_vcmpgtsh (vector signed short,
6517 vector signed short);
6518
6519 vector bool short vec_vcmpgtuh (vector unsigned short,
6520 vector unsigned short);
6521
6522 vector bool char vec_vcmpgtsb (vector signed char, vector signed char);
6523
6524 vector bool char vec_vcmpgtub (vector unsigned char,
6525 vector unsigned char);
6526
6527 vector bool int vec_cmple (vector float, vector float);
6528
6529 vector bool char vec_cmplt (vector unsigned char, vector unsigned char);
6530 vector bool char vec_cmplt (vector signed char, vector signed char);
6531 vector bool short vec_cmplt (vector unsigned short,
6532 vector unsigned short);
6533 vector bool short vec_cmplt (vector signed short, vector signed short);
6534 vector bool int vec_cmplt (vector unsigned int, vector unsigned int);
6535 vector bool int vec_cmplt (vector signed int, vector signed int);
6536 vector bool int vec_cmplt (vector float, vector float);
6537
6538 vector float vec_ctf (vector unsigned int, const int);
6539 vector float vec_ctf (vector signed int, const int);
6540
6541 vector float vec_vcfsx (vector signed int, const int);
6542
6543 vector float vec_vcfux (vector unsigned int, const int);
6544
6545 vector signed int vec_cts (vector float, const int);
6546
6547 vector unsigned int vec_ctu (vector float, const int);
6548
6549 void vec_dss (const int);
6550
6551 void vec_dssall (void);
6552
6553 void vec_dst (const vector unsigned char *, int, const int);
6554 void vec_dst (const vector signed char *, int, const int);
6555 void vec_dst (const vector bool char *, int, const int);
6556 void vec_dst (const vector unsigned short *, int, const int);
6557 void vec_dst (const vector signed short *, int, const int);
6558 void vec_dst (const vector bool short *, int, const int);
6559 void vec_dst (const vector pixel *, int, const int);
6560 void vec_dst (const vector unsigned int *, int, const int);
6561 void vec_dst (const vector signed int *, int, const int);
6562 void vec_dst (const vector bool int *, int, const int);
6563 void vec_dst (const vector float *, int, const int);
6564 void vec_dst (const unsigned char *, int, const int);
6565 void vec_dst (const signed char *, int, const int);
6566 void vec_dst (const unsigned short *, int, const int);
6567 void vec_dst (const short *, int, const int);
6568 void vec_dst (const unsigned int *, int, const int);
6569 void vec_dst (const int *, int, const int);
6570 void vec_dst (const unsigned long *, int, const int);
6571 void vec_dst (const long *, int, const int);
6572 void vec_dst (const float *, int, const int);
6573
6574 void vec_dstst (const vector unsigned char *, int, const int);
6575 void vec_dstst (const vector signed char *, int, const int);
6576 void vec_dstst (const vector bool char *, int, const int);
6577 void vec_dstst (const vector unsigned short *, int, const int);
6578 void vec_dstst (const vector signed short *, int, const int);
6579 void vec_dstst (const vector bool short *, int, const int);
6580 void vec_dstst (const vector pixel *, int, const int);
6581 void vec_dstst (const vector unsigned int *, int, const int);
6582 void vec_dstst (const vector signed int *, int, const int);
6583 void vec_dstst (const vector bool int *, int, const int);
6584 void vec_dstst (const vector float *, int, const int);
6585 void vec_dstst (const unsigned char *, int, const int);
6586 void vec_dstst (const signed char *, int, const int);
6587 void vec_dstst (const unsigned short *, int, const int);
6588 void vec_dstst (const short *, int, const int);
6589 void vec_dstst (const unsigned int *, int, const int);
6590 void vec_dstst (const int *, int, const int);
6591 void vec_dstst (const unsigned long *, int, const int);
6592 void vec_dstst (const long *, int, const int);
6593 void vec_dstst (const float *, int, const int);
6594
6595 void vec_dststt (const vector unsigned char *, int, const int);
6596 void vec_dststt (const vector signed char *, int, const int);
6597 void vec_dststt (const vector bool char *, int, const int);
6598 void vec_dststt (const vector unsigned short *, int, const int);
6599 void vec_dststt (const vector signed short *, int, const int);
6600 void vec_dststt (const vector bool short *, int, const int);
6601 void vec_dststt (const vector pixel *, int, const int);
6602 void vec_dststt (const vector unsigned int *, int, const int);
6603 void vec_dststt (const vector signed int *, int, const int);
6604 void vec_dststt (const vector bool int *, int, const int);
6605 void vec_dststt (const vector float *, int, const int);
6606 void vec_dststt (const unsigned char *, int, const int);
6607 void vec_dststt (const signed char *, int, const int);
6608 void vec_dststt (const unsigned short *, int, const int);
6609 void vec_dststt (const short *, int, const int);
6610 void vec_dststt (const unsigned int *, int, const int);
6611 void vec_dststt (const int *, int, const int);
6612 void vec_dststt (const unsigned long *, int, const int);
6613 void vec_dststt (const long *, int, const int);
6614 void vec_dststt (const float *, int, const int);
6615
6616 void vec_dstt (const vector unsigned char *, int, const int);
6617 void vec_dstt (const vector signed char *, int, const int);
6618 void vec_dstt (const vector bool char *, int, const int);
6619 void vec_dstt (const vector unsigned short *, int, const int);
6620 void vec_dstt (const vector signed short *, int, const int);
6621 void vec_dstt (const vector bool short *, int, const int);
6622 void vec_dstt (const vector pixel *, int, const int);
6623 void vec_dstt (const vector unsigned int *, int, const int);
6624 void vec_dstt (const vector signed int *, int, const int);
6625 void vec_dstt (const vector bool int *, int, const int);
6626 void vec_dstt (const vector float *, int, const int);
6627 void vec_dstt (const unsigned char *, int, const int);
6628 void vec_dstt (const signed char *, int, const int);
6629 void vec_dstt (const unsigned short *, int, const int);
6630 void vec_dstt (const short *, int, const int);
6631 void vec_dstt (const unsigned int *, int, const int);
6632 void vec_dstt (const int *, int, const int);
6633 void vec_dstt (const unsigned long *, int, const int);
6634 void vec_dstt (const long *, int, const int);
6635 void vec_dstt (const float *, int, const int);
6636
6637 vector float vec_expte (vector float);
6638
6639 vector float vec_floor (vector float);
6640
6641 vector float vec_ld (int, const vector float *);
6642 vector float vec_ld (int, const float *);
6643 vector bool int vec_ld (int, const vector bool int *);
6644 vector signed int vec_ld (int, const vector signed int *);
6645 vector signed int vec_ld (int, const int *);
6646 vector signed int vec_ld (int, const long *);
6647 vector unsigned int vec_ld (int, const vector unsigned int *);
6648 vector unsigned int vec_ld (int, const unsigned int *);
6649 vector unsigned int vec_ld (int, const unsigned long *);
6650 vector bool short vec_ld (int, const vector bool short *);
6651 vector pixel vec_ld (int, const vector pixel *);
6652 vector signed short vec_ld (int, const vector signed short *);
6653 vector signed short vec_ld (int, const short *);
6654 vector unsigned short vec_ld (int, const vector unsigned short *);
6655 vector unsigned short vec_ld (int, const unsigned short *);
6656 vector bool char vec_ld (int, const vector bool char *);
6657 vector signed char vec_ld (int, const vector signed char *);
6658 vector signed char vec_ld (int, const signed char *);
6659 vector unsigned char vec_ld (int, const vector unsigned char *);
6660 vector unsigned char vec_ld (int, const unsigned char *);
6661
6662 vector signed char vec_lde (int, const signed char *);
6663 vector unsigned char vec_lde (int, const unsigned char *);
6664 vector signed short vec_lde (int, const short *);
6665 vector unsigned short vec_lde (int, const unsigned short *);
6666 vector float vec_lde (int, const float *);
6667 vector signed int vec_lde (int, const int *);
6668 vector unsigned int vec_lde (int, const unsigned int *);
6669 vector signed int vec_lde (int, const long *);
6670 vector unsigned int vec_lde (int, const unsigned long *);
6671
6672 vector float vec_lvewx (int, float *);
6673 vector signed int vec_lvewx (int, int *);
6674 vector unsigned int vec_lvewx (int, unsigned int *);
6675 vector signed int vec_lvewx (int, long *);
6676 vector unsigned int vec_lvewx (int, unsigned long *);
6677
6678 vector signed short vec_lvehx (int, short *);
6679 vector unsigned short vec_lvehx (int, unsigned short *);
6680
6681 vector signed char vec_lvebx (int, char *);
6682 vector unsigned char vec_lvebx (int, unsigned char *);
6683
6684 vector float vec_ldl (int, const vector float *);
6685 vector float vec_ldl (int, const float *);
6686 vector bool int vec_ldl (int, const vector bool int *);
6687 vector signed int vec_ldl (int, const vector signed int *);
6688 vector signed int vec_ldl (int, const int *);
6689 vector signed int vec_ldl (int, const long *);
6690 vector unsigned int vec_ldl (int, const vector unsigned int *);
6691 vector unsigned int vec_ldl (int, const unsigned int *);
6692 vector unsigned int vec_ldl (int, const unsigned long *);
6693 vector bool short vec_ldl (int, const vector bool short *);
6694 vector pixel vec_ldl (int, const vector pixel *);
6695 vector signed short vec_ldl (int, const vector signed short *);
6696 vector signed short vec_ldl (int, const short *);
6697 vector unsigned short vec_ldl (int, const vector unsigned short *);
6698 vector unsigned short vec_ldl (int, const unsigned short *);
6699 vector bool char vec_ldl (int, const vector bool char *);
6700 vector signed char vec_ldl (int, const vector signed char *);
6701 vector signed char vec_ldl (int, const signed char *);
6702 vector unsigned char vec_ldl (int, const vector unsigned char *);
6703 vector unsigned char vec_ldl (int, const unsigned char *);
6704
6705 vector float vec_loge (vector float);
6706
6707 vector unsigned char vec_lvsl (int, const volatile unsigned char *);
6708 vector unsigned char vec_lvsl (int, const volatile signed char *);
6709 vector unsigned char vec_lvsl (int, const volatile unsigned short *);
6710 vector unsigned char vec_lvsl (int, const volatile short *);
6711 vector unsigned char vec_lvsl (int, const volatile unsigned int *);
6712 vector unsigned char vec_lvsl (int, const volatile int *);
6713 vector unsigned char vec_lvsl (int, const volatile unsigned long *);
6714 vector unsigned char vec_lvsl (int, const volatile long *);
6715 vector unsigned char vec_lvsl (int, const volatile float *);
6716
6717 vector unsigned char vec_lvsr (int, const volatile unsigned char *);
6718 vector unsigned char vec_lvsr (int, const volatile signed char *);
6719 vector unsigned char vec_lvsr (int, const volatile unsigned short *);
6720 vector unsigned char vec_lvsr (int, const volatile short *);
6721 vector unsigned char vec_lvsr (int, const volatile unsigned int *);
6722 vector unsigned char vec_lvsr (int, const volatile int *);
6723 vector unsigned char vec_lvsr (int, const volatile unsigned long *);
6724 vector unsigned char vec_lvsr (int, const volatile long *);
6725 vector unsigned char vec_lvsr (int, const volatile float *);
6726
6727 vector float vec_madd (vector float, vector float, vector float);
6728
6729 vector signed short vec_madds (vector signed short,
6730 vector signed short,
6731 vector signed short);
6732
6733 vector unsigned char vec_max (vector bool char, vector unsigned char);
6734 vector unsigned char vec_max (vector unsigned char, vector bool char);
6735 vector unsigned char vec_max (vector unsigned char,
6736 vector unsigned char);
6737 vector signed char vec_max (vector bool char, vector signed char);
6738 vector signed char vec_max (vector signed char, vector bool char);
6739 vector signed char vec_max (vector signed char, vector signed char);
6740 vector unsigned short vec_max (vector bool short,
6741 vector unsigned short);
6742 vector unsigned short vec_max (vector unsigned short,
6743 vector bool short);
6744 vector unsigned short vec_max (vector unsigned short,
6745 vector unsigned short);
6746 vector signed short vec_max (vector bool short, vector signed short);
6747 vector signed short vec_max (vector signed short, vector bool short);
6748 vector signed short vec_max (vector signed short, vector signed short);
6749 vector unsigned int vec_max (vector bool int, vector unsigned int);
6750 vector unsigned int vec_max (vector unsigned int, vector bool int);
6751 vector unsigned int vec_max (vector unsigned int, vector unsigned int);
6752 vector signed int vec_max (vector bool int, vector signed int);
6753 vector signed int vec_max (vector signed int, vector bool int);
6754 vector signed int vec_max (vector signed int, vector signed int);
6755 vector float vec_max (vector float, vector float);
6756
6757 vector float vec_vmaxfp (vector float, vector float);
6758
6759 vector signed int vec_vmaxsw (vector bool int, vector signed int);
6760 vector signed int vec_vmaxsw (vector signed int, vector bool int);
6761 vector signed int vec_vmaxsw (vector signed int, vector signed int);
6762
6763 vector unsigned int vec_vmaxuw (vector bool int, vector unsigned int);
6764 vector unsigned int vec_vmaxuw (vector unsigned int, vector bool int);
6765 vector unsigned int vec_vmaxuw (vector unsigned int,
6766 vector unsigned int);
6767
6768 vector signed short vec_vmaxsh (vector bool short, vector signed short);
6769 vector signed short vec_vmaxsh (vector signed short, vector bool short);
6770 vector signed short vec_vmaxsh (vector signed short,
6771 vector signed short);
6772
6773 vector unsigned short vec_vmaxuh (vector bool short,
6774 vector unsigned short);
6775 vector unsigned short vec_vmaxuh (vector unsigned short,
6776 vector bool short);
6777 vector unsigned short vec_vmaxuh (vector unsigned short,
6778 vector unsigned short);
6779
6780 vector signed char vec_vmaxsb (vector bool char, vector signed char);
6781 vector signed char vec_vmaxsb (vector signed char, vector bool char);
6782 vector signed char vec_vmaxsb (vector signed char, vector signed char);
6783
6784 vector unsigned char vec_vmaxub (vector bool char,
6785 vector unsigned char);
6786 vector unsigned char vec_vmaxub (vector unsigned char,
6787 vector bool char);
6788 vector unsigned char vec_vmaxub (vector unsigned char,
6789 vector unsigned char);
6790
6791 vector bool char vec_mergeh (vector bool char, vector bool char);
6792 vector signed char vec_mergeh (vector signed char, vector signed char);
6793 vector unsigned char vec_mergeh (vector unsigned char,
6794 vector unsigned char);
6795 vector bool short vec_mergeh (vector bool short, vector bool short);
6796 vector pixel vec_mergeh (vector pixel, vector pixel);
6797 vector signed short vec_mergeh (vector signed short,
6798 vector signed short);
6799 vector unsigned short vec_mergeh (vector unsigned short,
6800 vector unsigned short);
6801 vector float vec_mergeh (vector float, vector float);
6802 vector bool int vec_mergeh (vector bool int, vector bool int);
6803 vector signed int vec_mergeh (vector signed int, vector signed int);
6804 vector unsigned int vec_mergeh (vector unsigned int,
6805 vector unsigned int);
6806
6807 vector float vec_vmrghw (vector float, vector float);
6808 vector bool int vec_vmrghw (vector bool int, vector bool int);
6809 vector signed int vec_vmrghw (vector signed int, vector signed int);
6810 vector unsigned int vec_vmrghw (vector unsigned int,
6811 vector unsigned int);
6812
6813 vector bool short vec_vmrghh (vector bool short, vector bool short);
6814 vector signed short vec_vmrghh (vector signed short,
6815 vector signed short);
6816 vector unsigned short vec_vmrghh (vector unsigned short,
6817 vector unsigned short);
6818 vector pixel vec_vmrghh (vector pixel, vector pixel);
6819
6820 vector bool char vec_vmrghb (vector bool char, vector bool char);
6821 vector signed char vec_vmrghb (vector signed char, vector signed char);
6822 vector unsigned char vec_vmrghb (vector unsigned char,
6823 vector unsigned char);
6824
6825 vector bool char vec_mergel (vector bool char, vector bool char);
6826 vector signed char vec_mergel (vector signed char, vector signed char);
6827 vector unsigned char vec_mergel (vector unsigned char,
6828 vector unsigned char);
6829 vector bool short vec_mergel (vector bool short, vector bool short);
6830 vector pixel vec_mergel (vector pixel, vector pixel);
6831 vector signed short vec_mergel (vector signed short,
6832 vector signed short);
6833 vector unsigned short vec_mergel (vector unsigned short,
6834 vector unsigned short);
6835 vector float vec_mergel (vector float, vector float);
6836 vector bool int vec_mergel (vector bool int, vector bool int);
6837 vector signed int vec_mergel (vector signed int, vector signed int);
6838 vector unsigned int vec_mergel (vector unsigned int,
6839 vector unsigned int);
6840
6841 vector float vec_vmrglw (vector float, vector float);
6842 vector signed int vec_vmrglw (vector signed int, vector signed int);
6843 vector unsigned int vec_vmrglw (vector unsigned int,
6844 vector unsigned int);
6845 vector bool int vec_vmrglw (vector bool int, vector bool int);
6846
6847 vector bool short vec_vmrglh (vector bool short, vector bool short);
6848 vector signed short vec_vmrglh (vector signed short,
6849 vector signed short);
6850 vector unsigned short vec_vmrglh (vector unsigned short,
6851 vector unsigned short);
6852 vector pixel vec_vmrglh (vector pixel, vector pixel);
6853
6854 vector bool char vec_vmrglb (vector bool char, vector bool char);
6855 vector signed char vec_vmrglb (vector signed char, vector signed char);
6856 vector unsigned char vec_vmrglb (vector unsigned char,
6857 vector unsigned char);
6858
6859 vector unsigned short vec_mfvscr (void);
6860
6861 vector unsigned char vec_min (vector bool char, vector unsigned char);
6862 vector unsigned char vec_min (vector unsigned char, vector bool char);
6863 vector unsigned char vec_min (vector unsigned char,
6864 vector unsigned char);
6865 vector signed char vec_min (vector bool char, vector signed char);
6866 vector signed char vec_min (vector signed char, vector bool char);
6867 vector signed char vec_min (vector signed char, vector signed char);
6868 vector unsigned short vec_min (vector bool short,
6869 vector unsigned short);
6870 vector unsigned short vec_min (vector unsigned short,
6871 vector bool short);
6872 vector unsigned short vec_min (vector unsigned short,
6873 vector unsigned short);
6874 vector signed short vec_min (vector bool short, vector signed short);
6875 vector signed short vec_min (vector signed short, vector bool short);
6876 vector signed short vec_min (vector signed short, vector signed short);
6877 vector unsigned int vec_min (vector bool int, vector unsigned int);
6878 vector unsigned int vec_min (vector unsigned int, vector bool int);
6879 vector unsigned int vec_min (vector unsigned int, vector unsigned int);
6880 vector signed int vec_min (vector bool int, vector signed int);
6881 vector signed int vec_min (vector signed int, vector bool int);
6882 vector signed int vec_min (vector signed int, vector signed int);
6883 vector float vec_min (vector float, vector float);
6884
6885 vector float vec_vminfp (vector float, vector float);
6886
6887 vector signed int vec_vminsw (vector bool int, vector signed int);
6888 vector signed int vec_vminsw (vector signed int, vector bool int);
6889 vector signed int vec_vminsw (vector signed int, vector signed int);
6890
6891 vector unsigned int vec_vminuw (vector bool int, vector unsigned int);
6892 vector unsigned int vec_vminuw (vector unsigned int, vector bool int);
6893 vector unsigned int vec_vminuw (vector unsigned int,
6894 vector unsigned int);
6895
6896 vector signed short vec_vminsh (vector bool short, vector signed short);
6897 vector signed short vec_vminsh (vector signed short, vector bool short);
6898 vector signed short vec_vminsh (vector signed short,
6899 vector signed short);
6900
6901 vector unsigned short vec_vminuh (vector bool short,
6902 vector unsigned short);
6903 vector unsigned short vec_vminuh (vector unsigned short,
6904 vector bool short);
6905 vector unsigned short vec_vminuh (vector unsigned short,
6906 vector unsigned short);
6907
6908 vector signed char vec_vminsb (vector bool char, vector signed char);
6909 vector signed char vec_vminsb (vector signed char, vector bool char);
6910 vector signed char vec_vminsb (vector signed char, vector signed char);
6911
6912 vector unsigned char vec_vminub (vector bool char,
6913 vector unsigned char);
6914 vector unsigned char vec_vminub (vector unsigned char,
6915 vector bool char);
6916 vector unsigned char vec_vminub (vector unsigned char,
6917 vector unsigned char);
6918
6919 vector signed short vec_mladd (vector signed short,
6920 vector signed short,
6921 vector signed short);
6922 vector signed short vec_mladd (vector signed short,
6923 vector unsigned short,
6924 vector unsigned short);
6925 vector signed short vec_mladd (vector unsigned short,
6926 vector signed short,
6927 vector signed short);
6928 vector unsigned short vec_mladd (vector unsigned short,
6929 vector unsigned short,
6930 vector unsigned short);
6931
6932 vector signed short vec_mradds (vector signed short,
6933 vector signed short,
6934 vector signed short);
6935
6936 vector unsigned int vec_msum (vector unsigned char,
6937 vector unsigned char,
6938 vector unsigned int);
6939 vector signed int vec_msum (vector signed char,
6940 vector unsigned char,
6941 vector signed int);
6942 vector unsigned int vec_msum (vector unsigned short,
6943 vector unsigned short,
6944 vector unsigned int);
6945 vector signed int vec_msum (vector signed short,
6946 vector signed short,
6947 vector signed int);
6948
6949 vector signed int vec_vmsumshm (vector signed short,
6950 vector signed short,
6951 vector signed int);
6952
6953 vector unsigned int vec_vmsumuhm (vector unsigned short,
6954 vector unsigned short,
6955 vector unsigned int);
6956
6957 vector signed int vec_vmsummbm (vector signed char,
6958 vector unsigned char,
6959 vector signed int);
6960
6961 vector unsigned int vec_vmsumubm (vector unsigned char,
6962 vector unsigned char,
6963 vector unsigned int);
6964
6965 vector unsigned int vec_msums (vector unsigned short,
6966 vector unsigned short,
6967 vector unsigned int);
6968 vector signed int vec_msums (vector signed short,
6969 vector signed short,
6970 vector signed int);
6971
6972 vector signed int vec_vmsumshs (vector signed short,
6973 vector signed short,
6974 vector signed int);
6975
6976 vector unsigned int vec_vmsumuhs (vector unsigned short,
6977 vector unsigned short,
6978 vector unsigned int);
6979
6980 void vec_mtvscr (vector signed int);
6981 void vec_mtvscr (vector unsigned int);
6982 void vec_mtvscr (vector bool int);
6983 void vec_mtvscr (vector signed short);
6984 void vec_mtvscr (vector unsigned short);
6985 void vec_mtvscr (vector bool short);
6986 void vec_mtvscr (vector pixel);
6987 void vec_mtvscr (vector signed char);
6988 void vec_mtvscr (vector unsigned char);
6989 void vec_mtvscr (vector bool char);
6990
6991 vector unsigned short vec_mule (vector unsigned char,
6992 vector unsigned char);
6993 vector signed short vec_mule (vector signed char,
6994 vector signed char);
6995 vector unsigned int vec_mule (vector unsigned short,
6996 vector unsigned short);
6997 vector signed int vec_mule (vector signed short, vector signed short);
6998
6999 vector signed int vec_vmulesh (vector signed short,
7000 vector signed short);
7001
7002 vector unsigned int vec_vmuleuh (vector unsigned short,
7003 vector unsigned short);
7004
7005 vector signed short vec_vmulesb (vector signed char,
7006 vector signed char);
7007
7008 vector unsigned short vec_vmuleub (vector unsigned char,
7009 vector unsigned char);
7010
7011 vector unsigned short vec_mulo (vector unsigned char,
7012 vector unsigned char);
7013 vector signed short vec_mulo (vector signed char, vector signed char);
7014 vector unsigned int vec_mulo (vector unsigned short,
7015 vector unsigned short);
7016 vector signed int vec_mulo (vector signed short, vector signed short);
7017
7018 vector signed int vec_vmulosh (vector signed short,
7019 vector signed short);
7020
7021 vector unsigned int vec_vmulouh (vector unsigned short,
7022 vector unsigned short);
7023
7024 vector signed short vec_vmulosb (vector signed char,
7025 vector signed char);
7026
7027 vector unsigned short vec_vmuloub (vector unsigned char,
7028 vector unsigned char);
7029
7030 vector float vec_nmsub (vector float, vector float, vector float);
7031
7032 vector float vec_nor (vector float, vector float);
7033 vector signed int vec_nor (vector signed int, vector signed int);
7034 vector unsigned int vec_nor (vector unsigned int, vector unsigned int);
7035 vector bool int vec_nor (vector bool int, vector bool int);
7036 vector signed short vec_nor (vector signed short, vector signed short);
7037 vector unsigned short vec_nor (vector unsigned short,
7038 vector unsigned short);
7039 vector bool short vec_nor (vector bool short, vector bool short);
7040 vector signed char vec_nor (vector signed char, vector signed char);
7041 vector unsigned char vec_nor (vector unsigned char,
7042 vector unsigned char);
7043 vector bool char vec_nor (vector bool char, vector bool char);
7044
7045 vector float vec_or (vector float, vector float);
7046 vector float vec_or (vector float, vector bool int);
7047 vector float vec_or (vector bool int, vector float);
7048 vector bool int vec_or (vector bool int, vector bool int);
7049 vector signed int vec_or (vector bool int, vector signed int);
7050 vector signed int vec_or (vector signed int, vector bool int);
7051 vector signed int vec_or (vector signed int, vector signed int);
7052 vector unsigned int vec_or (vector bool int, vector unsigned int);
7053 vector unsigned int vec_or (vector unsigned int, vector bool int);
7054 vector unsigned int vec_or (vector unsigned int, vector unsigned int);
7055 vector bool short vec_or (vector bool short, vector bool short);
7056 vector signed short vec_or (vector bool short, vector signed short);
7057 vector signed short vec_or (vector signed short, vector bool short);
7058 vector signed short vec_or (vector signed short, vector signed short);
7059 vector unsigned short vec_or (vector bool short, vector unsigned short);
7060 vector unsigned short vec_or (vector unsigned short, vector bool short);
7061 vector unsigned short vec_or (vector unsigned short,
7062 vector unsigned short);
7063 vector signed char vec_or (vector bool char, vector signed char);
7064 vector bool char vec_or (vector bool char, vector bool char);
7065 vector signed char vec_or (vector signed char, vector bool char);
7066 vector signed char vec_or (vector signed char, vector signed char);
7067 vector unsigned char vec_or (vector bool char, vector unsigned char);
7068 vector unsigned char vec_or (vector unsigned char, vector bool char);
7069 vector unsigned char vec_or (vector unsigned char,
7070 vector unsigned char);
7071
7072 vector signed char vec_pack (vector signed short, vector signed short);
7073 vector unsigned char vec_pack (vector unsigned short,
7074 vector unsigned short);
7075 vector bool char vec_pack (vector bool short, vector bool short);
7076 vector signed short vec_pack (vector signed int, vector signed int);
7077 vector unsigned short vec_pack (vector unsigned int,
7078 vector unsigned int);
7079 vector bool short vec_pack (vector bool int, vector bool int);
7080
7081 vector bool short vec_vpkuwum (vector bool int, vector bool int);
7082 vector signed short vec_vpkuwum (vector signed int, vector signed int);
7083 vector unsigned short vec_vpkuwum (vector unsigned int,
7084 vector unsigned int);
7085
7086 vector bool char vec_vpkuhum (vector bool short, vector bool short);
7087 vector signed char vec_vpkuhum (vector signed short,
7088 vector signed short);
7089 vector unsigned char vec_vpkuhum (vector unsigned short,
7090 vector unsigned short);
7091
7092 vector pixel vec_packpx (vector unsigned int, vector unsigned int);
7093
7094 vector unsigned char vec_packs (vector unsigned short,
7095 vector unsigned short);
7096 vector signed char vec_packs (vector signed short, vector signed short);
7097 vector unsigned short vec_packs (vector unsigned int,
7098 vector unsigned int);
7099 vector signed short vec_packs (vector signed int, vector signed int);
7100
7101 vector signed short vec_vpkswss (vector signed int, vector signed int);
7102
7103 vector unsigned short vec_vpkuwus (vector unsigned int,
7104 vector unsigned int);
7105
7106 vector signed char vec_vpkshss (vector signed short,
7107 vector signed short);
7108
7109 vector unsigned char vec_vpkuhus (vector unsigned short,
7110 vector unsigned short);
7111
7112 vector unsigned char vec_packsu (vector unsigned short,
7113 vector unsigned short);
7114 vector unsigned char vec_packsu (vector signed short,
7115 vector signed short);
7116 vector unsigned short vec_packsu (vector unsigned int,
7117 vector unsigned int);
7118 vector unsigned short vec_packsu (vector signed int, vector signed int);
7119
7120 vector unsigned short vec_vpkswus (vector signed int,
7121 vector signed int);
7122
7123 vector unsigned char vec_vpkshus (vector signed short,
7124 vector signed short);
7125
7126 vector float vec_perm (vector float,
7127 vector float,
7128 vector unsigned char);
7129 vector signed int vec_perm (vector signed int,
7130 vector signed int,
7131 vector unsigned char);
7132 vector unsigned int vec_perm (vector unsigned int,
7133 vector unsigned int,
7134 vector unsigned char);
7135 vector bool int vec_perm (vector bool int,
7136 vector bool int,
7137 vector unsigned char);
7138 vector signed short vec_perm (vector signed short,
7139 vector signed short,
7140 vector unsigned char);
7141 vector unsigned short vec_perm (vector unsigned short,
7142 vector unsigned short,
7143 vector unsigned char);
7144 vector bool short vec_perm (vector bool short,
7145 vector bool short,
7146 vector unsigned char);
7147 vector pixel vec_perm (vector pixel,
7148 vector pixel,
7149 vector unsigned char);
7150 vector signed char vec_perm (vector signed char,
7151 vector signed char,
7152 vector unsigned char);
7153 vector unsigned char vec_perm (vector unsigned char,
7154 vector unsigned char,
7155 vector unsigned char);
7156 vector bool char vec_perm (vector bool char,
7157 vector bool char,
7158 vector unsigned char);
7159
7160 vector float vec_re (vector float);
7161
7162 vector signed char vec_rl (vector signed char,
7163 vector unsigned char);
7164 vector unsigned char vec_rl (vector unsigned char,
7165 vector unsigned char);
7166 vector signed short vec_rl (vector signed short, vector unsigned short);
7167 vector unsigned short vec_rl (vector unsigned short,
7168 vector unsigned short);
7169 vector signed int vec_rl (vector signed int, vector unsigned int);
7170 vector unsigned int vec_rl (vector unsigned int, vector unsigned int);
7171
7172 vector signed int vec_vrlw (vector signed int, vector unsigned int);
7173 vector unsigned int vec_vrlw (vector unsigned int, vector unsigned int);
7174
7175 vector signed short vec_vrlh (vector signed short,
7176 vector unsigned short);
7177 vector unsigned short vec_vrlh (vector unsigned short,
7178 vector unsigned short);
7179
7180 vector signed char vec_vrlb (vector signed char, vector unsigned char);
7181 vector unsigned char vec_vrlb (vector unsigned char,
7182 vector unsigned char);
7183
7184 vector float vec_round (vector float);
7185
7186 vector float vec_rsqrte (vector float);
7187
7188 vector float vec_sel (vector float, vector float, vector bool int);
7189 vector float vec_sel (vector float, vector float, vector unsigned int);
7190 vector signed int vec_sel (vector signed int,
7191 vector signed int,
7192 vector bool int);
7193 vector signed int vec_sel (vector signed int,
7194 vector signed int,
7195 vector unsigned int);
7196 vector unsigned int vec_sel (vector unsigned int,
7197 vector unsigned int,
7198 vector bool int);
7199 vector unsigned int vec_sel (vector unsigned int,
7200 vector unsigned int,
7201 vector unsigned int);
7202 vector bool int vec_sel (vector bool int,
7203 vector bool int,
7204 vector bool int);
7205 vector bool int vec_sel (vector bool int,
7206 vector bool int,
7207 vector unsigned int);
7208 vector signed short vec_sel (vector signed short,
7209 vector signed short,
7210 vector bool short);
7211 vector signed short vec_sel (vector signed short,
7212 vector signed short,
7213 vector unsigned short);
7214 vector unsigned short vec_sel (vector unsigned short,
7215 vector unsigned short,
7216 vector bool short);
7217 vector unsigned short vec_sel (vector unsigned short,
7218 vector unsigned short,
7219 vector unsigned short);
7220 vector bool short vec_sel (vector bool short,
7221 vector bool short,
7222 vector bool short);
7223 vector bool short vec_sel (vector bool short,
7224 vector bool short,
7225 vector unsigned short);
7226 vector signed char vec_sel (vector signed char,
7227 vector signed char,
7228 vector bool char);
7229 vector signed char vec_sel (vector signed char,
7230 vector signed char,
7231 vector unsigned char);
7232 vector unsigned char vec_sel (vector unsigned char,
7233 vector unsigned char,
7234 vector bool char);
7235 vector unsigned char vec_sel (vector unsigned char,
7236 vector unsigned char,
7237 vector unsigned char);
7238 vector bool char vec_sel (vector bool char,
7239 vector bool char,
7240 vector bool char);
7241 vector bool char vec_sel (vector bool char,
7242 vector bool char,
7243 vector unsigned char);
7244
7245 vector signed char vec_sl (vector signed char,
7246 vector unsigned char);
7247 vector unsigned char vec_sl (vector unsigned char,
7248 vector unsigned char);
7249 vector signed short vec_sl (vector signed short, vector unsigned short);
7250 vector unsigned short vec_sl (vector unsigned short,
7251 vector unsigned short);
7252 vector signed int vec_sl (vector signed int, vector unsigned int);
7253 vector unsigned int vec_sl (vector unsigned int, vector unsigned int);
7254
7255 vector signed int vec_vslw (vector signed int, vector unsigned int);
7256 vector unsigned int vec_vslw (vector unsigned int, vector unsigned int);
7257
7258 vector signed short vec_vslh (vector signed short,
7259 vector unsigned short);
7260 vector unsigned short vec_vslh (vector unsigned short,
7261 vector unsigned short);
7262
7263 vector signed char vec_vslb (vector signed char, vector unsigned char);
7264 vector unsigned char vec_vslb (vector unsigned char,
7265 vector unsigned char);
7266
7267 vector float vec_sld (vector float, vector float, const int);
7268 vector signed int vec_sld (vector signed int,
7269 vector signed int,
7270 const int);
7271 vector unsigned int vec_sld (vector unsigned int,
7272 vector unsigned int,
7273 const int);
7274 vector bool int vec_sld (vector bool int,
7275 vector bool int,
7276 const int);
7277 vector signed short vec_sld (vector signed short,
7278 vector signed short,
7279 const int);
7280 vector unsigned short vec_sld (vector unsigned short,
7281 vector unsigned short,
7282 const int);
7283 vector bool short vec_sld (vector bool short,
7284 vector bool short,
7285 const int);
7286 vector pixel vec_sld (vector pixel,
7287 vector pixel,
7288 const int);
7289 vector signed char vec_sld (vector signed char,
7290 vector signed char,
7291 const int);
7292 vector unsigned char vec_sld (vector unsigned char,
7293 vector unsigned char,
7294 const int);
7295 vector bool char vec_sld (vector bool char,
7296 vector bool char,
7297 const int);
7298
7299 vector signed int vec_sll (vector signed int,
7300 vector unsigned int);
7301 vector signed int vec_sll (vector signed int,
7302 vector unsigned short);
7303 vector signed int vec_sll (vector signed int,
7304 vector unsigned char);
7305 vector unsigned int vec_sll (vector unsigned int,
7306 vector unsigned int);
7307 vector unsigned int vec_sll (vector unsigned int,
7308 vector unsigned short);
7309 vector unsigned int vec_sll (vector unsigned int,
7310 vector unsigned char);
7311 vector bool int vec_sll (vector bool int,
7312 vector unsigned int);
7313 vector bool int vec_sll (vector bool int,
7314 vector unsigned short);
7315 vector bool int vec_sll (vector bool int,
7316 vector unsigned char);
7317 vector signed short vec_sll (vector signed short,
7318 vector unsigned int);
7319 vector signed short vec_sll (vector signed short,
7320 vector unsigned short);
7321 vector signed short vec_sll (vector signed short,
7322 vector unsigned char);
7323 vector unsigned short vec_sll (vector unsigned short,
7324 vector unsigned int);
7325 vector unsigned short vec_sll (vector unsigned short,
7326 vector unsigned short);
7327 vector unsigned short vec_sll (vector unsigned short,
7328 vector unsigned char);
7329 vector bool short vec_sll (vector bool short, vector unsigned int);
7330 vector bool short vec_sll (vector bool short, vector unsigned short);
7331 vector bool short vec_sll (vector bool short, vector unsigned char);
7332 vector pixel vec_sll (vector pixel, vector unsigned int);
7333 vector pixel vec_sll (vector pixel, vector unsigned short);
7334 vector pixel vec_sll (vector pixel, vector unsigned char);
7335 vector signed char vec_sll (vector signed char, vector unsigned int);
7336 vector signed char vec_sll (vector signed char, vector unsigned short);
7337 vector signed char vec_sll (vector signed char, vector unsigned char);
7338 vector unsigned char vec_sll (vector unsigned char,
7339 vector unsigned int);
7340 vector unsigned char vec_sll (vector unsigned char,
7341 vector unsigned short);
7342 vector unsigned char vec_sll (vector unsigned char,
7343 vector unsigned char);
7344 vector bool char vec_sll (vector bool char, vector unsigned int);
7345 vector bool char vec_sll (vector bool char, vector unsigned short);
7346 vector bool char vec_sll (vector bool char, vector unsigned char);
7347
7348 vector float vec_slo (vector float, vector signed char);
7349 vector float vec_slo (vector float, vector unsigned char);
7350 vector signed int vec_slo (vector signed int, vector signed char);
7351 vector signed int vec_slo (vector signed int, vector unsigned char);
7352 vector unsigned int vec_slo (vector unsigned int, vector signed char);
7353 vector unsigned int vec_slo (vector unsigned int, vector unsigned char);
7354 vector signed short vec_slo (vector signed short, vector signed char);
7355 vector signed short vec_slo (vector signed short, vector unsigned char);
7356 vector unsigned short vec_slo (vector unsigned short,
7357 vector signed char);
7358 vector unsigned short vec_slo (vector unsigned short,
7359 vector unsigned char);
7360 vector pixel vec_slo (vector pixel, vector signed char);
7361 vector pixel vec_slo (vector pixel, vector unsigned char);
7362 vector signed char vec_slo (vector signed char, vector signed char);
7363 vector signed char vec_slo (vector signed char, vector unsigned char);
7364 vector unsigned char vec_slo (vector unsigned char, vector signed char);
7365 vector unsigned char vec_slo (vector unsigned char,
7366 vector unsigned char);
7367
7368 vector signed char vec_splat (vector signed char, const int);
7369 vector unsigned char vec_splat (vector unsigned char, const int);
7370 vector bool char vec_splat (vector bool char, const int);
7371 vector signed short vec_splat (vector signed short, const int);
7372 vector unsigned short vec_splat (vector unsigned short, const int);
7373 vector bool short vec_splat (vector bool short, const int);
7374 vector pixel vec_splat (vector pixel, const int);
7375 vector float vec_splat (vector float, const int);
7376 vector signed int vec_splat (vector signed int, const int);
7377 vector unsigned int vec_splat (vector unsigned int, const int);
7378 vector bool int vec_splat (vector bool int, const int);
7379
7380 vector float vec_vspltw (vector float, const int);
7381 vector signed int vec_vspltw (vector signed int, const int);
7382 vector unsigned int vec_vspltw (vector unsigned int, const int);
7383 vector bool int vec_vspltw (vector bool int, const int);
7384
7385 vector bool short vec_vsplth (vector bool short, const int);
7386 vector signed short vec_vsplth (vector signed short, const int);
7387 vector unsigned short vec_vsplth (vector unsigned short, const int);
7388 vector pixel vec_vsplth (vector pixel, const int);
7389
7390 vector signed char vec_vspltb (vector signed char, const int);
7391 vector unsigned char vec_vspltb (vector unsigned char, const int);
7392 vector bool char vec_vspltb (vector bool char, const int);
7393
7394 vector signed char vec_splat_s8 (const int);
7395
7396 vector signed short vec_splat_s16 (const int);
7397
7398 vector signed int vec_splat_s32 (const int);
7399
7400 vector unsigned char vec_splat_u8 (const int);
7401
7402 vector unsigned short vec_splat_u16 (const int);
7403
7404 vector unsigned int vec_splat_u32 (const int);
7405
7406 vector signed char vec_sr (vector signed char, vector unsigned char);
7407 vector unsigned char vec_sr (vector unsigned char,
7408 vector unsigned char);
7409 vector signed short vec_sr (vector signed short,
7410 vector unsigned short);
7411 vector unsigned short vec_sr (vector unsigned short,
7412 vector unsigned short);
7413 vector signed int vec_sr (vector signed int, vector unsigned int);
7414 vector unsigned int vec_sr (vector unsigned int, vector unsigned int);
7415
7416 vector signed int vec_vsrw (vector signed int, vector unsigned int);
7417 vector unsigned int vec_vsrw (vector unsigned int, vector unsigned int);
7418
7419 vector signed short vec_vsrh (vector signed short,
7420 vector unsigned short);
7421 vector unsigned short vec_vsrh (vector unsigned short,
7422 vector unsigned short);
7423
7424 vector signed char vec_vsrb (vector signed char, vector unsigned char);
7425 vector unsigned char vec_vsrb (vector unsigned char,
7426 vector unsigned char);
7427
7428 vector signed char vec_sra (vector signed char, vector unsigned char);
7429 vector unsigned char vec_sra (vector unsigned char,
7430 vector unsigned char);
7431 vector signed short vec_sra (vector signed short,
7432 vector unsigned short);
7433 vector unsigned short vec_sra (vector unsigned short,
7434 vector unsigned short);
7435 vector signed int vec_sra (vector signed int, vector unsigned int);
7436 vector unsigned int vec_sra (vector unsigned int, vector unsigned int);
7437
7438 vector signed int vec_vsraw (vector signed int, vector unsigned int);
7439 vector unsigned int vec_vsraw (vector unsigned int,
7440 vector unsigned int);
7441
7442 vector signed short vec_vsrah (vector signed short,
7443 vector unsigned short);
7444 vector unsigned short vec_vsrah (vector unsigned short,
7445 vector unsigned short);
7446
7447 vector signed char vec_vsrab (vector signed char, vector unsigned char);
7448 vector unsigned char vec_vsrab (vector unsigned char,
7449 vector unsigned char);
7450
7451 vector signed int vec_srl (vector signed int, vector unsigned int);
7452 vector signed int vec_srl (vector signed int, vector unsigned short);
7453 vector signed int vec_srl (vector signed int, vector unsigned char);
7454 vector unsigned int vec_srl (vector unsigned int, vector unsigned int);
7455 vector unsigned int vec_srl (vector unsigned int,
7456 vector unsigned short);
7457 vector unsigned int vec_srl (vector unsigned int, vector unsigned char);
7458 vector bool int vec_srl (vector bool int, vector unsigned int);
7459 vector bool int vec_srl (vector bool int, vector unsigned short);
7460 vector bool int vec_srl (vector bool int, vector unsigned char);
7461 vector signed short vec_srl (vector signed short, vector unsigned int);
7462 vector signed short vec_srl (vector signed short,
7463 vector unsigned short);
7464 vector signed short vec_srl (vector signed short, vector unsigned char);
7465 vector unsigned short vec_srl (vector unsigned short,
7466 vector unsigned int);
7467 vector unsigned short vec_srl (vector unsigned short,
7468 vector unsigned short);
7469 vector unsigned short vec_srl (vector unsigned short,
7470 vector unsigned char);
7471 vector bool short vec_srl (vector bool short, vector unsigned int);
7472 vector bool short vec_srl (vector bool short, vector unsigned short);
7473 vector bool short vec_srl (vector bool short, vector unsigned char);
7474 vector pixel vec_srl (vector pixel, vector unsigned int);
7475 vector pixel vec_srl (vector pixel, vector unsigned short);
7476 vector pixel vec_srl (vector pixel, vector unsigned char);
7477 vector signed char vec_srl (vector signed char, vector unsigned int);
7478 vector signed char vec_srl (vector signed char, vector unsigned short);
7479 vector signed char vec_srl (vector signed char, vector unsigned char);
7480 vector unsigned char vec_srl (vector unsigned char,
7481 vector unsigned int);
7482 vector unsigned char vec_srl (vector unsigned char,
7483 vector unsigned short);
7484 vector unsigned char vec_srl (vector unsigned char,
7485 vector unsigned char);
7486 vector bool char vec_srl (vector bool char, vector unsigned int);
7487 vector bool char vec_srl (vector bool char, vector unsigned short);
7488 vector bool char vec_srl (vector bool char, vector unsigned char);
7489
7490 vector float vec_sro (vector float, vector signed char);
7491 vector float vec_sro (vector float, vector unsigned char);
7492 vector signed int vec_sro (vector signed int, vector signed char);
7493 vector signed int vec_sro (vector signed int, vector unsigned char);
7494 vector unsigned int vec_sro (vector unsigned int, vector signed char);
7495 vector unsigned int vec_sro (vector unsigned int, vector unsigned char);
7496 vector signed short vec_sro (vector signed short, vector signed char);
7497 vector signed short vec_sro (vector signed short, vector unsigned char);
7498 vector unsigned short vec_sro (vector unsigned short,
7499 vector signed char);
7500 vector unsigned short vec_sro (vector unsigned short,
7501 vector unsigned char);
7502 vector pixel vec_sro (vector pixel, vector signed char);
7503 vector pixel vec_sro (vector pixel, vector unsigned char);
7504 vector signed char vec_sro (vector signed char, vector signed char);
7505 vector signed char vec_sro (vector signed char, vector unsigned char);
7506 vector unsigned char vec_sro (vector unsigned char, vector signed char);
7507 vector unsigned char vec_sro (vector unsigned char,
7508 vector unsigned char);
7509
7510 void vec_st (vector float, int, vector float *);
7511 void vec_st (vector float, int, float *);
7512 void vec_st (vector signed int, int, vector signed int *);
7513 void vec_st (vector signed int, int, int *);
7514 void vec_st (vector unsigned int, int, vector unsigned int *);
7515 void vec_st (vector unsigned int, int, unsigned int *);
7516 void vec_st (vector bool int, int, vector bool int *);
7517 void vec_st (vector bool int, int, unsigned int *);
7518 void vec_st (vector bool int, int, int *);
7519 void vec_st (vector signed short, int, vector signed short *);
7520 void vec_st (vector signed short, int, short *);
7521 void vec_st (vector unsigned short, int, vector unsigned short *);
7522 void vec_st (vector unsigned short, int, unsigned short *);
7523 void vec_st (vector bool short, int, vector bool short *);
7524 void vec_st (vector bool short, int, unsigned short *);
7525 void vec_st (vector pixel, int, vector pixel *);
7526 void vec_st (vector pixel, int, unsigned short *);
7527 void vec_st (vector pixel, int, short *);
7528 void vec_st (vector bool short, int, short *);
7529 void vec_st (vector signed char, int, vector signed char *);
7530 void vec_st (vector signed char, int, signed char *);
7531 void vec_st (vector unsigned char, int, vector unsigned char *);
7532 void vec_st (vector unsigned char, int, unsigned char *);
7533 void vec_st (vector bool char, int, vector bool char *);
7534 void vec_st (vector bool char, int, unsigned char *);
7535 void vec_st (vector bool char, int, signed char *);
7536
7537 void vec_ste (vector signed char, int, signed char *);
7538 void vec_ste (vector unsigned char, int, unsigned char *);
7539 void vec_ste (vector bool char, int, signed char *);
7540 void vec_ste (vector bool char, int, unsigned char *);
7541 void vec_ste (vector signed short, int, short *);
7542 void vec_ste (vector unsigned short, int, unsigned short *);
7543 void vec_ste (vector bool short, int, short *);
7544 void vec_ste (vector bool short, int, unsigned short *);
7545 void vec_ste (vector pixel, int, short *);
7546 void vec_ste (vector pixel, int, unsigned short *);
7547 void vec_ste (vector float, int, float *);
7548 void vec_ste (vector signed int, int, int *);
7549 void vec_ste (vector unsigned int, int, unsigned int *);
7550 void vec_ste (vector bool int, int, int *);
7551 void vec_ste (vector bool int, int, unsigned int *);
7552
7553 void vec_stvewx (vector float, int, float *);
7554 void vec_stvewx (vector signed int, int, int *);
7555 void vec_stvewx (vector unsigned int, int, unsigned int *);
7556 void vec_stvewx (vector bool int, int, int *);
7557 void vec_stvewx (vector bool int, int, unsigned int *);
7558
7559 void vec_stvehx (vector signed short, int, short *);
7560 void vec_stvehx (vector unsigned short, int, unsigned short *);
7561 void vec_stvehx (vector bool short, int, short *);
7562 void vec_stvehx (vector bool short, int, unsigned short *);
7563 void vec_stvehx (vector pixel, int, short *);
7564 void vec_stvehx (vector pixel, int, unsigned short *);
7565
7566 void vec_stvebx (vector signed char, int, signed char *);
7567 void vec_stvebx (vector unsigned char, int, unsigned char *);
7568 void vec_stvebx (vector bool char, int, signed char *);
7569 void vec_stvebx (vector bool char, int, unsigned char *);
7570
7571 void vec_stl (vector float, int, vector float *);
7572 void vec_stl (vector float, int, float *);
7573 void vec_stl (vector signed int, int, vector signed int *);
7574 void vec_stl (vector signed int, int, int *);
7575 void vec_stl (vector unsigned int, int, vector unsigned int *);
7576 void vec_stl (vector unsigned int, int, unsigned int *);
7577 void vec_stl (vector bool int, int, vector bool int *);
7578 void vec_stl (vector bool int, int, unsigned int *);
7579 void vec_stl (vector bool int, int, int *);
7580 void vec_stl (vector signed short, int, vector signed short *);
7581 void vec_stl (vector signed short, int, short *);
7582 void vec_stl (vector unsigned short, int, vector unsigned short *);
7583 void vec_stl (vector unsigned short, int, unsigned short *);
7584 void vec_stl (vector bool short, int, vector bool short *);
7585 void vec_stl (vector bool short, int, unsigned short *);
7586 void vec_stl (vector bool short, int, short *);
7587 void vec_stl (vector pixel, int, vector pixel *);
7588 void vec_stl (vector pixel, int, unsigned short *);
7589 void vec_stl (vector pixel, int, short *);
7590 void vec_stl (vector signed char, int, vector signed char *);
7591 void vec_stl (vector signed char, int, signed char *);
7592 void vec_stl (vector unsigned char, int, vector unsigned char *);
7593 void vec_stl (vector unsigned char, int, unsigned char *);
7594 void vec_stl (vector bool char, int, vector bool char *);
7595 void vec_stl (vector bool char, int, unsigned char *);
7596 void vec_stl (vector bool char, int, signed char *);
7597
7598 vector signed char vec_sub (vector bool char, vector signed char);
7599 vector signed char vec_sub (vector signed char, vector bool char);
7600 vector signed char vec_sub (vector signed char, vector signed char);
7601 vector unsigned char vec_sub (vector bool char, vector unsigned char);
7602 vector unsigned char vec_sub (vector unsigned char, vector bool char);
7603 vector unsigned char vec_sub (vector unsigned char,
7604 vector unsigned char);
7605 vector signed short vec_sub (vector bool short, vector signed short);
7606 vector signed short vec_sub (vector signed short, vector bool short);
7607 vector signed short vec_sub (vector signed short, vector signed short);
7608 vector unsigned short vec_sub (vector bool short,
7609 vector unsigned short);
7610 vector unsigned short vec_sub (vector unsigned short,
7611 vector bool short);
7612 vector unsigned short vec_sub (vector unsigned short,
7613 vector unsigned short);
7614 vector signed int vec_sub (vector bool int, vector signed int);
7615 vector signed int vec_sub (vector signed int, vector bool int);
7616 vector signed int vec_sub (vector signed int, vector signed int);
7617 vector unsigned int vec_sub (vector bool int, vector unsigned int);
7618 vector unsigned int vec_sub (vector unsigned int, vector bool int);
7619 vector unsigned int vec_sub (vector unsigned int, vector unsigned int);
7620 vector float vec_sub (vector float, vector float);
7621
7622 vector float vec_vsubfp (vector float, vector float);
7623
7624 vector signed int vec_vsubuwm (vector bool int, vector signed int);
7625 vector signed int vec_vsubuwm (vector signed int, vector bool int);
7626 vector signed int vec_vsubuwm (vector signed int, vector signed int);
7627 vector unsigned int vec_vsubuwm (vector bool int, vector unsigned int);
7628 vector unsigned int vec_vsubuwm (vector unsigned int, vector bool int);
7629 vector unsigned int vec_vsubuwm (vector unsigned int,
7630 vector unsigned int);
7631
7632 vector signed short vec_vsubuhm (vector bool short,
7633 vector signed short);
7634 vector signed short vec_vsubuhm (vector signed short,
7635 vector bool short);
7636 vector signed short vec_vsubuhm (vector signed short,
7637 vector signed short);
7638 vector unsigned short vec_vsubuhm (vector bool short,
7639 vector unsigned short);
7640 vector unsigned short vec_vsubuhm (vector unsigned short,
7641 vector bool short);
7642 vector unsigned short vec_vsubuhm (vector unsigned short,
7643 vector unsigned short);
7644
7645 vector signed char vec_vsububm (vector bool char, vector signed char);
7646 vector signed char vec_vsububm (vector signed char, vector bool char);
7647 vector signed char vec_vsububm (vector signed char, vector signed char);
7648 vector unsigned char vec_vsububm (vector bool char,
7649 vector unsigned char);
7650 vector unsigned char vec_vsububm (vector unsigned char,
7651 vector bool char);
7652 vector unsigned char vec_vsububm (vector unsigned char,
7653 vector unsigned char);
7654
7655 vector unsigned int vec_subc (vector unsigned int, vector unsigned int);
7656
7657 vector unsigned char vec_subs (vector bool char, vector unsigned char);
7658 vector unsigned char vec_subs (vector unsigned char, vector bool char);
7659 vector unsigned char vec_subs (vector unsigned char,
7660 vector unsigned char);
7661 vector signed char vec_subs (vector bool char, vector signed char);
7662 vector signed char vec_subs (vector signed char, vector bool char);
7663 vector signed char vec_subs (vector signed char, vector signed char);
7664 vector unsigned short vec_subs (vector bool short,
7665 vector unsigned short);
7666 vector unsigned short vec_subs (vector unsigned short,
7667 vector bool short);
7668 vector unsigned short vec_subs (vector unsigned short,
7669 vector unsigned short);
7670 vector signed short vec_subs (vector bool short, vector signed short);
7671 vector signed short vec_subs (vector signed short, vector bool short);
7672 vector signed short vec_subs (vector signed short, vector signed short);
7673 vector unsigned int vec_subs (vector bool int, vector unsigned int);
7674 vector unsigned int vec_subs (vector unsigned int, vector bool int);
7675 vector unsigned int vec_subs (vector unsigned int, vector unsigned int);
7676 vector signed int vec_subs (vector bool int, vector signed int);
7677 vector signed int vec_subs (vector signed int, vector bool int);
7678 vector signed int vec_subs (vector signed int, vector signed int);
7679
7680 vector signed int vec_vsubsws (vector bool int, vector signed int);
7681 vector signed int vec_vsubsws (vector signed int, vector bool int);
7682 vector signed int vec_vsubsws (vector signed int, vector signed int);
7683
7684 vector unsigned int vec_vsubuws (vector bool int, vector unsigned int);
7685 vector unsigned int vec_vsubuws (vector unsigned int, vector bool int);
7686 vector unsigned int vec_vsubuws (vector unsigned int,
7687 vector unsigned int);
7688
7689 vector signed short vec_vsubshs (vector bool short,
7690 vector signed short);
7691 vector signed short vec_vsubshs (vector signed short,
7692 vector bool short);
7693 vector signed short vec_vsubshs (vector signed short,
7694 vector signed short);
7695
7696 vector unsigned short vec_vsubuhs (vector bool short,
7697 vector unsigned short);
7698 vector unsigned short vec_vsubuhs (vector unsigned short,
7699 vector bool short);
7700 vector unsigned short vec_vsubuhs (vector unsigned short,
7701 vector unsigned short);
7702
7703 vector signed char vec_vsubsbs (vector bool char, vector signed char);
7704 vector signed char vec_vsubsbs (vector signed char, vector bool char);
7705 vector signed char vec_vsubsbs (vector signed char, vector signed char);
7706
7707 vector unsigned char vec_vsububs (vector bool char,
7708 vector unsigned char);
7709 vector unsigned char vec_vsububs (vector unsigned char,
7710 vector bool char);
7711 vector unsigned char vec_vsububs (vector unsigned char,
7712 vector unsigned char);
7713
7714 vector unsigned int vec_sum4s (vector unsigned char,
7715 vector unsigned int);
7716 vector signed int vec_sum4s (vector signed char, vector signed int);
7717 vector signed int vec_sum4s (vector signed short, vector signed int);
7718
7719 vector signed int vec_vsum4shs (vector signed short, vector signed int);
7720
7721 vector signed int vec_vsum4sbs (vector signed char, vector signed int);
7722
7723 vector unsigned int vec_vsum4ubs (vector unsigned char,
7724 vector unsigned int);
7725
7726 vector signed int vec_sum2s (vector signed int, vector signed int);
7727
7728 vector signed int vec_sums (vector signed int, vector signed int);
7729
7730 vector float vec_trunc (vector float);
7731
7732 vector signed short vec_unpackh (vector signed char);
7733 vector bool short vec_unpackh (vector bool char);
7734 vector signed int vec_unpackh (vector signed short);
7735 vector bool int vec_unpackh (vector bool short);
7736 vector unsigned int vec_unpackh (vector pixel);
7737
7738 vector bool int vec_vupkhsh (vector bool short);
7739 vector signed int vec_vupkhsh (vector signed short);
7740
7741 vector unsigned int vec_vupkhpx (vector pixel);
7742
7743 vector bool short vec_vupkhsb (vector bool char);
7744 vector signed short vec_vupkhsb (vector signed char);
7745
7746 vector signed short vec_unpackl (vector signed char);
7747 vector bool short vec_unpackl (vector bool char);
7748 vector unsigned int vec_unpackl (vector pixel);
7749 vector signed int vec_unpackl (vector signed short);
7750 vector bool int vec_unpackl (vector bool short);
7751
7752 vector unsigned int vec_vupklpx (vector pixel);
7753
7754 vector bool int vec_vupklsh (vector bool short);
7755 vector signed int vec_vupklsh (vector signed short);
7756
7757 vector bool short vec_vupklsb (vector bool char);
7758 vector signed short vec_vupklsb (vector signed char);
7759
7760 vector float vec_xor (vector float, vector float);
7761 vector float vec_xor (vector float, vector bool int);
7762 vector float vec_xor (vector bool int, vector float);
7763 vector bool int vec_xor (vector bool int, vector bool int);
7764 vector signed int vec_xor (vector bool int, vector signed int);
7765 vector signed int vec_xor (vector signed int, vector bool int);
7766 vector signed int vec_xor (vector signed int, vector signed int);
7767 vector unsigned int vec_xor (vector bool int, vector unsigned int);
7768 vector unsigned int vec_xor (vector unsigned int, vector bool int);
7769 vector unsigned int vec_xor (vector unsigned int, vector unsigned int);
7770 vector bool short vec_xor (vector bool short, vector bool short);
7771 vector signed short vec_xor (vector bool short, vector signed short);
7772 vector signed short vec_xor (vector signed short, vector bool short);
7773 vector signed short vec_xor (vector signed short, vector signed short);
7774 vector unsigned short vec_xor (vector bool short,
7775 vector unsigned short);
7776 vector unsigned short vec_xor (vector unsigned short,
7777 vector bool short);
7778 vector unsigned short vec_xor (vector unsigned short,
7779 vector unsigned short);
7780 vector signed char vec_xor (vector bool char, vector signed char);
7781 vector bool char vec_xor (vector bool char, vector bool char);
7782 vector signed char vec_xor (vector signed char, vector bool char);
7783 vector signed char vec_xor (vector signed char, vector signed char);
7784 vector unsigned char vec_xor (vector bool char, vector unsigned char);
7785 vector unsigned char vec_xor (vector unsigned char, vector bool char);
7786 vector unsigned char vec_xor (vector unsigned char,
7787 vector unsigned char);
7788
7789 int vec_all_eq (vector signed char, vector bool char);
7790 int vec_all_eq (vector signed char, vector signed char);
7791 int vec_all_eq (vector unsigned char, vector bool char);
7792 int vec_all_eq (vector unsigned char, vector unsigned char);
7793 int vec_all_eq (vector bool char, vector bool char);
7794 int vec_all_eq (vector bool char, vector unsigned char);
7795 int vec_all_eq (vector bool char, vector signed char);
7796 int vec_all_eq (vector signed short, vector bool short);
7797 int vec_all_eq (vector signed short, vector signed short);
7798 int vec_all_eq (vector unsigned short, vector bool short);
7799 int vec_all_eq (vector unsigned short, vector unsigned short);
7800 int vec_all_eq (vector bool short, vector bool short);
7801 int vec_all_eq (vector bool short, vector unsigned short);
7802 int vec_all_eq (vector bool short, vector signed short);
7803 int vec_all_eq (vector pixel, vector pixel);
7804 int vec_all_eq (vector signed int, vector bool int);
7805 int vec_all_eq (vector signed int, vector signed int);
7806 int vec_all_eq (vector unsigned int, vector bool int);
7807 int vec_all_eq (vector unsigned int, vector unsigned int);
7808 int vec_all_eq (vector bool int, vector bool int);
7809 int vec_all_eq (vector bool int, vector unsigned int);
7810 int vec_all_eq (vector bool int, vector signed int);
7811 int vec_all_eq (vector float, vector float);
7812
7813 int vec_all_ge (vector bool char, vector unsigned char);
7814 int vec_all_ge (vector unsigned char, vector bool char);
7815 int vec_all_ge (vector unsigned char, vector unsigned char);
7816 int vec_all_ge (vector bool char, vector signed char);
7817 int vec_all_ge (vector signed char, vector bool char);
7818 int vec_all_ge (vector signed char, vector signed char);
7819 int vec_all_ge (vector bool short, vector unsigned short);
7820 int vec_all_ge (vector unsigned short, vector bool short);
7821 int vec_all_ge (vector unsigned short, vector unsigned short);
7822 int vec_all_ge (vector signed short, vector signed short);
7823 int vec_all_ge (vector bool short, vector signed short);
7824 int vec_all_ge (vector signed short, vector bool short);
7825 int vec_all_ge (vector bool int, vector unsigned int);
7826 int vec_all_ge (vector unsigned int, vector bool int);
7827 int vec_all_ge (vector unsigned int, vector unsigned int);
7828 int vec_all_ge (vector bool int, vector signed int);
7829 int vec_all_ge (vector signed int, vector bool int);
7830 int vec_all_ge (vector signed int, vector signed int);
7831 int vec_all_ge (vector float, vector float);
7832
7833 int vec_all_gt (vector bool char, vector unsigned char);
7834 int vec_all_gt (vector unsigned char, vector bool char);
7835 int vec_all_gt (vector unsigned char, vector unsigned char);
7836 int vec_all_gt (vector bool char, vector signed char);
7837 int vec_all_gt (vector signed char, vector bool char);
7838 int vec_all_gt (vector signed char, vector signed char);
7839 int vec_all_gt (vector bool short, vector unsigned short);
7840 int vec_all_gt (vector unsigned short, vector bool short);
7841 int vec_all_gt (vector unsigned short, vector unsigned short);
7842 int vec_all_gt (vector bool short, vector signed short);
7843 int vec_all_gt (vector signed short, vector bool short);
7844 int vec_all_gt (vector signed short, vector signed short);
7845 int vec_all_gt (vector bool int, vector unsigned int);
7846 int vec_all_gt (vector unsigned int, vector bool int);
7847 int vec_all_gt (vector unsigned int, vector unsigned int);
7848 int vec_all_gt (vector bool int, vector signed int);
7849 int vec_all_gt (vector signed int, vector bool int);
7850 int vec_all_gt (vector signed int, vector signed int);
7851 int vec_all_gt (vector float, vector float);
7852
7853 int vec_all_in (vector float, vector float);
7854
7855 int vec_all_le (vector bool char, vector unsigned char);
7856 int vec_all_le (vector unsigned char, vector bool char);
7857 int vec_all_le (vector unsigned char, vector unsigned char);
7858 int vec_all_le (vector bool char, vector signed char);
7859 int vec_all_le (vector signed char, vector bool char);
7860 int vec_all_le (vector signed char, vector signed char);
7861 int vec_all_le (vector bool short, vector unsigned short);
7862 int vec_all_le (vector unsigned short, vector bool short);
7863 int vec_all_le (vector unsigned short, vector unsigned short);
7864 int vec_all_le (vector bool short, vector signed short);
7865 int vec_all_le (vector signed short, vector bool short);
7866 int vec_all_le (vector signed short, vector signed short);
7867 int vec_all_le (vector bool int, vector unsigned int);
7868 int vec_all_le (vector unsigned int, vector bool int);
7869 int vec_all_le (vector unsigned int, vector unsigned int);
7870 int vec_all_le (vector bool int, vector signed int);
7871 int vec_all_le (vector signed int, vector bool int);
7872 int vec_all_le (vector signed int, vector signed int);
7873 int vec_all_le (vector float, vector float);
7874
7875 int vec_all_lt (vector bool char, vector unsigned char);
7876 int vec_all_lt (vector unsigned char, vector bool char);
7877 int vec_all_lt (vector unsigned char, vector unsigned char);
7878 int vec_all_lt (vector bool char, vector signed char);
7879 int vec_all_lt (vector signed char, vector bool char);
7880 int vec_all_lt (vector signed char, vector signed char);
7881 int vec_all_lt (vector bool short, vector unsigned short);
7882 int vec_all_lt (vector unsigned short, vector bool short);
7883 int vec_all_lt (vector unsigned short, vector unsigned short);
7884 int vec_all_lt (vector bool short, vector signed short);
7885 int vec_all_lt (vector signed short, vector bool short);
7886 int vec_all_lt (vector signed short, vector signed short);
7887 int vec_all_lt (vector bool int, vector unsigned int);
7888 int vec_all_lt (vector unsigned int, vector bool int);
7889 int vec_all_lt (vector unsigned int, vector unsigned int);
7890 int vec_all_lt (vector bool int, vector signed int);
7891 int vec_all_lt (vector signed int, vector bool int);
7892 int vec_all_lt (vector signed int, vector signed int);
7893 int vec_all_lt (vector float, vector float);
7894
7895 int vec_all_nan (vector float);
7896
7897 int vec_all_ne (vector signed char, vector bool char);
7898 int vec_all_ne (vector signed char, vector signed char);
7899 int vec_all_ne (vector unsigned char, vector bool char);
7900 int vec_all_ne (vector unsigned char, vector unsigned char);
7901 int vec_all_ne (vector bool char, vector bool char);
7902 int vec_all_ne (vector bool char, vector unsigned char);
7903 int vec_all_ne (vector bool char, vector signed char);
7904 int vec_all_ne (vector signed short, vector bool short);
7905 int vec_all_ne (vector signed short, vector signed short);
7906 int vec_all_ne (vector unsigned short, vector bool short);
7907 int vec_all_ne (vector unsigned short, vector unsigned short);
7908 int vec_all_ne (vector bool short, vector bool short);
7909 int vec_all_ne (vector bool short, vector unsigned short);
7910 int vec_all_ne (vector bool short, vector signed short);
7911 int vec_all_ne (vector pixel, vector pixel);
7912 int vec_all_ne (vector signed int, vector bool int);
7913 int vec_all_ne (vector signed int, vector signed int);
7914 int vec_all_ne (vector unsigned int, vector bool int);
7915 int vec_all_ne (vector unsigned int, vector unsigned int);
7916 int vec_all_ne (vector bool int, vector bool int);
7917 int vec_all_ne (vector bool int, vector unsigned int);
7918 int vec_all_ne (vector bool int, vector signed int);
7919 int vec_all_ne (vector float, vector float);
7920
7921 int vec_all_nge (vector float, vector float);
7922
7923 int vec_all_ngt (vector float, vector float);
7924
7925 int vec_all_nle (vector float, vector float);
7926
7927 int vec_all_nlt (vector float, vector float);
7928
7929 int vec_all_numeric (vector float);
7930
7931 int vec_any_eq (vector signed char, vector bool char);
7932 int vec_any_eq (vector signed char, vector signed char);
7933 int vec_any_eq (vector unsigned char, vector bool char);
7934 int vec_any_eq (vector unsigned char, vector unsigned char);
7935 int vec_any_eq (vector bool char, vector bool char);
7936 int vec_any_eq (vector bool char, vector unsigned char);
7937 int vec_any_eq (vector bool char, vector signed char);
7938 int vec_any_eq (vector signed short, vector bool short);
7939 int vec_any_eq (vector signed short, vector signed short);
7940 int vec_any_eq (vector unsigned short, vector bool short);
7941 int vec_any_eq (vector unsigned short, vector unsigned short);
7942 int vec_any_eq (vector bool short, vector bool short);
7943 int vec_any_eq (vector bool short, vector unsigned short);
7944 int vec_any_eq (vector bool short, vector signed short);
7945 int vec_any_eq (vector pixel, vector pixel);
7946 int vec_any_eq (vector signed int, vector bool int);
7947 int vec_any_eq (vector signed int, vector signed int);
7948 int vec_any_eq (vector unsigned int, vector bool int);
7949 int vec_any_eq (vector unsigned int, vector unsigned int);
7950 int vec_any_eq (vector bool int, vector bool int);
7951 int vec_any_eq (vector bool int, vector unsigned int);
7952 int vec_any_eq (vector bool int, vector signed int);
7953 int vec_any_eq (vector float, vector float);
7954
7955 int vec_any_ge (vector signed char, vector bool char);
7956 int vec_any_ge (vector unsigned char, vector bool char);
7957 int vec_any_ge (vector unsigned char, vector unsigned char);
7958 int vec_any_ge (vector signed char, vector signed char);
7959 int vec_any_ge (vector bool char, vector unsigned char);
7960 int vec_any_ge (vector bool char, vector signed char);
7961 int vec_any_ge (vector unsigned short, vector bool short);
7962 int vec_any_ge (vector unsigned short, vector unsigned short);
7963 int vec_any_ge (vector signed short, vector signed short);
7964 int vec_any_ge (vector signed short, vector bool short);
7965 int vec_any_ge (vector bool short, vector unsigned short);
7966 int vec_any_ge (vector bool short, vector signed short);
7967 int vec_any_ge (vector signed int, vector bool int);
7968 int vec_any_ge (vector unsigned int, vector bool int);
7969 int vec_any_ge (vector unsigned int, vector unsigned int);
7970 int vec_any_ge (vector signed int, vector signed int);
7971 int vec_any_ge (vector bool int, vector unsigned int);
7972 int vec_any_ge (vector bool int, vector signed int);
7973 int vec_any_ge (vector float, vector float);
7974
7975 int vec_any_gt (vector bool char, vector unsigned char);
7976 int vec_any_gt (vector unsigned char, vector bool char);
7977 int vec_any_gt (vector unsigned char, vector unsigned char);
7978 int vec_any_gt (vector bool char, vector signed char);
7979 int vec_any_gt (vector signed char, vector bool char);
7980 int vec_any_gt (vector signed char, vector signed char);
7981 int vec_any_gt (vector bool short, vector unsigned short);
7982 int vec_any_gt (vector unsigned short, vector bool short);
7983 int vec_any_gt (vector unsigned short, vector unsigned short);
7984 int vec_any_gt (vector bool short, vector signed short);
7985 int vec_any_gt (vector signed short, vector bool short);
7986 int vec_any_gt (vector signed short, vector signed short);
7987 int vec_any_gt (vector bool int, vector unsigned int);
7988 int vec_any_gt (vector unsigned int, vector bool int);
7989 int vec_any_gt (vector unsigned int, vector unsigned int);
7990 int vec_any_gt (vector bool int, vector signed int);
7991 int vec_any_gt (vector signed int, vector bool int);
7992 int vec_any_gt (vector signed int, vector signed int);
7993 int vec_any_gt (vector float, vector float);
7994
7995 int vec_any_le (vector bool char, vector unsigned char);
7996 int vec_any_le (vector unsigned char, vector bool char);
7997 int vec_any_le (vector unsigned char, vector unsigned char);
7998 int vec_any_le (vector bool char, vector signed char);
7999 int vec_any_le (vector signed char, vector bool char);
8000 int vec_any_le (vector signed char, vector signed char);
8001 int vec_any_le (vector bool short, vector unsigned short);
8002 int vec_any_le (vector unsigned short, vector bool short);
8003 int vec_any_le (vector unsigned short, vector unsigned short);
8004 int vec_any_le (vector bool short, vector signed short);
8005 int vec_any_le (vector signed short, vector bool short);
8006 int vec_any_le (vector signed short, vector signed short);
8007 int vec_any_le (vector bool int, vector unsigned int);
8008 int vec_any_le (vector unsigned int, vector bool int);
8009 int vec_any_le (vector unsigned int, vector unsigned int);
8010 int vec_any_le (vector bool int, vector signed int);
8011 int vec_any_le (vector signed int, vector bool int);
8012 int vec_any_le (vector signed int, vector signed int);
8013 int vec_any_le (vector float, vector float);
8014
8015 int vec_any_lt (vector bool char, vector unsigned char);
8016 int vec_any_lt (vector unsigned char, vector bool char);
8017 int vec_any_lt (vector unsigned char, vector unsigned char);
8018 int vec_any_lt (vector bool char, vector signed char);
8019 int vec_any_lt (vector signed char, vector bool char);
8020 int vec_any_lt (vector signed char, vector signed char);
8021 int vec_any_lt (vector bool short, vector unsigned short);
8022 int vec_any_lt (vector unsigned short, vector bool short);
8023 int vec_any_lt (vector unsigned short, vector unsigned short);
8024 int vec_any_lt (vector bool short, vector signed short);
8025 int vec_any_lt (vector signed short, vector bool short);
8026 int vec_any_lt (vector signed short, vector signed short);
8027 int vec_any_lt (vector bool int, vector unsigned int);
8028 int vec_any_lt (vector unsigned int, vector bool int);
8029 int vec_any_lt (vector unsigned int, vector unsigned int);
8030 int vec_any_lt (vector bool int, vector signed int);
8031 int vec_any_lt (vector signed int, vector bool int);
8032 int vec_any_lt (vector signed int, vector signed int);
8033 int vec_any_lt (vector float, vector float);
8034
8035 int vec_any_nan (vector float);
8036
8037 int vec_any_ne (vector signed char, vector bool char);
8038 int vec_any_ne (vector signed char, vector signed char);
8039 int vec_any_ne (vector unsigned char, vector bool char);
8040 int vec_any_ne (vector unsigned char, vector unsigned char);
8041 int vec_any_ne (vector bool char, vector bool char);
8042 int vec_any_ne (vector bool char, vector unsigned char);
8043 int vec_any_ne (vector bool char, vector signed char);
8044 int vec_any_ne (vector signed short, vector bool short);
8045 int vec_any_ne (vector signed short, vector signed short);
8046 int vec_any_ne (vector unsigned short, vector bool short);
8047 int vec_any_ne (vector unsigned short, vector unsigned short);
8048 int vec_any_ne (vector bool short, vector bool short);
8049 int vec_any_ne (vector bool short, vector unsigned short);
8050 int vec_any_ne (vector bool short, vector signed short);
8051 int vec_any_ne (vector pixel, vector pixel);
8052 int vec_any_ne (vector signed int, vector bool int);
8053 int vec_any_ne (vector signed int, vector signed int);
8054 int vec_any_ne (vector unsigned int, vector bool int);
8055 int vec_any_ne (vector unsigned int, vector unsigned int);
8056 int vec_any_ne (vector bool int, vector bool int);
8057 int vec_any_ne (vector bool int, vector unsigned int);
8058 int vec_any_ne (vector bool int, vector signed int);
8059 int vec_any_ne (vector float, vector float);
8060
8061 int vec_any_nge (vector float, vector float);
8062
8063 int vec_any_ngt (vector float, vector float);
8064
8065 int vec_any_nle (vector float, vector float);
8066
8067 int vec_any_nlt (vector float, vector float);
8068
8069 int vec_any_numeric (vector float);
8070
8071 int vec_any_out (vector float, vector float);
8072 @end smallexample
8073
8074 @node Target Format Checks
8075 @section Format Checks Specific to Particular Target Machines
8076
8077 For some target machines, GCC supports additional options to the
8078 format attribute
8079 (@pxref{Function Attributes,,Declaring Attributes of Functions}).
8080
8081 @menu
8082 * Solaris Format Checks::
8083 @end menu
8084
8085 @node Solaris Format Checks
8086 @subsection Solaris Format Checks
8087
8088 Solaris targets support the @code{cmn_err} (or @code{__cmn_err__}) format
8089 check. @code{cmn_err} accepts a subset of the standard @code{printf}
8090 conversions, and the two-argument @code{%b} conversion for displaying
8091 bit-fields. See the Solaris man page for @code{cmn_err} for more information.
8092
8093 @node Pragmas
8094 @section Pragmas Accepted by GCC
8095 @cindex pragmas
8096 @cindex #pragma
8097
8098 GCC supports several types of pragmas, primarily in order to compile
8099 code originally written for other compilers. Note that in general
8100 we do not recommend the use of pragmas; @xref{Function Attributes},
8101 for further explanation.
8102
8103 @menu
8104 * ARM Pragmas::
8105 * RS/6000 and PowerPC Pragmas::
8106 * Darwin Pragmas::
8107 * Solaris Pragmas::
8108 * Symbol-Renaming Pragmas::
8109 * Structure-Packing Pragmas::
8110 @end menu
8111
8112 @node ARM Pragmas
8113 @subsection ARM Pragmas
8114
8115 The ARM target defines pragmas for controlling the default addition of
8116 @code{long_call} and @code{short_call} attributes to functions.
8117 @xref{Function Attributes}, for information about the effects of these
8118 attributes.
8119
8120 @table @code
8121 @item long_calls
8122 @cindex pragma, long_calls
8123 Set all subsequent functions to have the @code{long_call} attribute.
8124
8125 @item no_long_calls
8126 @cindex pragma, no_long_calls
8127 Set all subsequent functions to have the @code{short_call} attribute.
8128
8129 @item long_calls_off
8130 @cindex pragma, long_calls_off
8131 Do not affect the @code{long_call} or @code{short_call} attributes of
8132 subsequent functions.
8133 @end table
8134
8135 @node RS/6000 and PowerPC Pragmas
8136 @subsection RS/6000 and PowerPC Pragmas
8137
8138 The RS/6000 and PowerPC targets define one pragma for controlling
8139 whether or not the @code{longcall} attribute is added to function
8140 declarations by default. This pragma overrides the @option{-mlongcall}
8141 option, but not the @code{longcall} and @code{shortcall} attributes.
8142 @xref{RS/6000 and PowerPC Options}, for more information about when long
8143 calls are and are not necessary.
8144
8145 @table @code
8146 @item longcall (1)
8147 @cindex pragma, longcall
8148 Apply the @code{longcall} attribute to all subsequent function
8149 declarations.
8150
8151 @item longcall (0)
8152 Do not apply the @code{longcall} attribute to subsequent function
8153 declarations.
8154 @end table
8155
8156 @c Describe c4x pragmas here.
8157 @c Describe h8300 pragmas here.
8158 @c Describe sh pragmas here.
8159 @c Describe v850 pragmas here.
8160
8161 @node Darwin Pragmas
8162 @subsection Darwin Pragmas
8163
8164 The following pragmas are available for all architectures running the
8165 Darwin operating system. These are useful for compatibility with other
8166 Mac OS compilers.
8167
8168 @table @code
8169 @item mark @var{tokens}@dots{}
8170 @cindex pragma, mark
8171 This pragma is accepted, but has no effect.
8172
8173 @item options align=@var{alignment}
8174 @cindex pragma, options align
8175 This pragma sets the alignment of fields in structures. The values of
8176 @var{alignment} may be @code{mac68k}, to emulate m68k alignment, or
8177 @code{power}, to emulate PowerPC alignment. Uses of this pragma nest
8178 properly; to restore the previous setting, use @code{reset} for the
8179 @var{alignment}.
8180
8181 @item segment @var{tokens}@dots{}
8182 @cindex pragma, segment
8183 This pragma is accepted, but has no effect.
8184
8185 @item unused (@var{var} [, @var{var}]@dots{})
8186 @cindex pragma, unused
8187 This pragma declares variables to be possibly unused. GCC will not
8188 produce warnings for the listed variables. The effect is similar to
8189 that of the @code{unused} attribute, except that this pragma may appear
8190 anywhere within the variables' scopes.
8191 @end table
8192
8193 @node Solaris Pragmas
8194 @subsection Solaris Pragmas
8195
8196 The Solaris target supports @code{#pragma redefine_extname}
8197 (@pxref{Symbol-Renaming Pragmas}). It also supports additional
8198 @code{#pragma} directives for compatibility with the system compiler.
8199
8200 @table @code
8201 @item align @var{alignment} (@var{variable} [, @var{variable}]...)
8202 @cindex pragma, align
8203
8204 Increase the minimum alignment of each @var{variable} to @var{alignment}.
8205 This is the same as GCC's @code{aligned} attribute @pxref{Variable
8206 Attributes}).
8207
8208 @item fini (@var{function} [, @var{function}]...)
8209 @cindex pragma, fini
8210
8211 This pragma causes each listed @var{function} to be called after
8212 main, or during shared module unloading, by adding a call to the
8213 @code{.fini} section.
8214
8215 @item init (@var{function} [, @var{function}]...)
8216 @cindex pragma, init
8217
8218 This pragma causes each listed @var{function} to be called during
8219 initialization (before @code{main}) or during shared module loading, by
8220 adding a call to the @code{.init} section.
8221
8222 @end table
8223
8224 @node Symbol-Renaming Pragmas
8225 @subsection Symbol-Renaming Pragmas
8226
8227 For compatibility with the Solaris and Tru64 UNIX system headers, GCC
8228 supports two @code{#pragma} directives which change the name used in
8229 assembly for a given declaration. These pragmas are only available on
8230 platforms whose system headers need them. To get this effect on all
8231 platforms supported by GCC, use the asm labels extension (@pxref{Asm
8232 Labels}).
8233
8234 @table @code
8235 @item redefine_extname @var{oldname} @var{newname}
8236 @cindex pragma, redefine_extname
8237
8238 This pragma gives the C function @var{oldname} the assembly symbol
8239 @var{newname}. The preprocessor macro @code{__PRAGMA_REDEFINE_EXTNAME}
8240 will be defined if this pragma is available (currently only on
8241 Solaris).
8242
8243 @item extern_prefix @var{string}
8244 @cindex pragma, extern_prefix
8245
8246 This pragma causes all subsequent external function and variable
8247 declarations to have @var{string} prepended to their assembly symbols.
8248 This effect may be terminated with another @code{extern_prefix} pragma
8249 whose argument is an empty string. The preprocessor macro
8250 @code{__PRAGMA_EXTERN_PREFIX} will be defined if this pragma is
8251 available (currently only on Tru64 UNIX).
8252 @end table
8253
8254 These pragmas and the asm labels extension interact in a complicated
8255 manner. Here are some corner cases you may want to be aware of.
8256
8257 @enumerate
8258 @item Both pragmas silently apply only to declarations with external
8259 linkage. Asm labels do not have this restriction.
8260
8261 @item In C++, both pragmas silently apply only to declarations with
8262 ``C'' linkage. Again, asm labels do not have this restriction.
8263
8264 @item If any of the three ways of changing the assembly name of a
8265 declaration is applied to a declaration whose assembly name has
8266 already been determined (either by a previous use of one of these
8267 features, or because the compiler needed the assembly name in order to
8268 generate code), and the new name is different, a warning issues and
8269 the name does not change.
8270
8271 @item The @var{oldname} used by @code{#pragma redefine_extname} is
8272 always the C-language name.
8273
8274 @item If @code{#pragma extern_prefix} is in effect, and a declaration
8275 occurs with an asm label attached, the prefix is silently ignored for
8276 that declaration.
8277
8278 @item If @code{#pragma extern_prefix} and @code{#pragma redefine_extname}
8279 apply to the same declaration, whichever triggered first wins, and a
8280 warning issues if they contradict each other. (We would like to have
8281 @code{#pragma redefine_extname} always win, for consistency with asm
8282 labels, but if @code{#pragma extern_prefix} triggers first we have no
8283 way of knowing that that happened.)
8284 @end enumerate
8285
8286 @node Structure-Packing Pragmas
8287 @subsection Structure-Packing Pragmas
8288
8289 For compatibility with Win32, GCC supports as set of @code{#pragma}
8290 directives which change the maximum alignment of members of structures,
8291 unions, and classes subsequently defined. The @var{n} value below always
8292 is required to be a small power of two and specifies the new alignment
8293 in bytes.
8294
8295 @enumerate
8296 @item @code{#pragma pack(@var{n})} simply sets the new alignment.
8297 @item @code{#pragma pack()} sets the alignment to the one that was in
8298 effect when compilation started (see also command line option
8299 @option{-fpack-struct[=<n>]} @pxref{Code Gen Options}).
8300 @item @code{#pragma pack(push[,@var{n}])} pushes the current alignment
8301 setting on an internal stack and then optionally sets the new alignment.
8302 @item @code{#pragma pack(pop)} restores the alignment setting to the one
8303 saved at the top of the internal stack (and removes that stack entry).
8304 Note that @code{#pragma pack([@var{n}])} does not influence this internal
8305 stack; thus it is possible to have @code{#pragma pack(push)} followed by
8306 multiple @code{#pragma pack(@var{n})} instances and finalized by a single
8307 @code{#pragma pack(pop)}.
8308 @end enumerate
8309
8310 @node Unnamed Fields
8311 @section Unnamed struct/union fields within structs/unions.
8312 @cindex struct
8313 @cindex union
8314
8315 For compatibility with other compilers, GCC allows you to define
8316 a structure or union that contains, as fields, structures and unions
8317 without names. For example:
8318
8319 @smallexample
8320 struct @{
8321 int a;
8322 union @{
8323 int b;
8324 float c;
8325 @};
8326 int d;
8327 @} foo;
8328 @end smallexample
8329
8330 In this example, the user would be able to access members of the unnamed
8331 union with code like @samp{foo.b}. Note that only unnamed structs and
8332 unions are allowed, you may not have, for example, an unnamed
8333 @code{int}.
8334
8335 You must never create such structures that cause ambiguous field definitions.
8336 For example, this structure:
8337
8338 @smallexample
8339 struct @{
8340 int a;
8341 struct @{
8342 int a;
8343 @};
8344 @} foo;
8345 @end smallexample
8346
8347 It is ambiguous which @code{a} is being referred to with @samp{foo.a}.
8348 Such constructs are not supported and must be avoided. In the future,
8349 such constructs may be detected and treated as compilation errors.
8350
8351 @node Thread-Local
8352 @section Thread-Local Storage
8353 @cindex Thread-Local Storage
8354 @cindex @acronym{TLS}
8355 @cindex __thread
8356
8357 Thread-local storage (@acronym{TLS}) is a mechanism by which variables
8358 are allocated such that there is one instance of the variable per extant
8359 thread. The run-time model GCC uses to implement this originates
8360 in the IA-64 processor-specific ABI, but has since been migrated
8361 to other processors as well. It requires significant support from
8362 the linker (@command{ld}), dynamic linker (@command{ld.so}), and
8363 system libraries (@file{libc.so} and @file{libpthread.so}), so it
8364 is not available everywhere.
8365
8366 At the user level, the extension is visible with a new storage
8367 class keyword: @code{__thread}. For example:
8368
8369 @smallexample
8370 __thread int i;
8371 extern __thread struct state s;
8372 static __thread char *p;
8373 @end smallexample
8374
8375 The @code{__thread} specifier may be used alone, with the @code{extern}
8376 or @code{static} specifiers, but with no other storage class specifier.
8377 When used with @code{extern} or @code{static}, @code{__thread} must appear
8378 immediately after the other storage class specifier.
8379
8380 The @code{__thread} specifier may be applied to any global, file-scoped
8381 static, function-scoped static, or static data member of a class. It may
8382 not be applied to block-scoped automatic or non-static data member.
8383
8384 When the address-of operator is applied to a thread-local variable, it is
8385 evaluated at run-time and returns the address of the current thread's
8386 instance of that variable. An address so obtained may be used by any
8387 thread. When a thread terminates, any pointers to thread-local variables
8388 in that thread become invalid.
8389
8390 No static initialization may refer to the address of a thread-local variable.
8391
8392 In C++, if an initializer is present for a thread-local variable, it must
8393 be a @var{constant-expression}, as defined in 5.19.2 of the ANSI/ISO C++
8394 standard.
8395
8396 See @uref{http://people.redhat.com/drepper/tls.pdf,
8397 ELF Handling For Thread-Local Storage} for a detailed explanation of
8398 the four thread-local storage addressing models, and how the run-time
8399 is expected to function.
8400
8401 @menu
8402 * C99 Thread-Local Edits::
8403 * C++98 Thread-Local Edits::
8404 @end menu
8405
8406 @node C99 Thread-Local Edits
8407 @subsection ISO/IEC 9899:1999 Edits for Thread-Local Storage
8408
8409 The following are a set of changes to ISO/IEC 9899:1999 (aka C99)
8410 that document the exact semantics of the language extension.
8411
8412 @itemize @bullet
8413 @item
8414 @cite{5.1.2 Execution environments}
8415
8416 Add new text after paragraph 1
8417
8418 @quotation
8419 Within either execution environment, a @dfn{thread} is a flow of
8420 control within a program. It is implementation defined whether
8421 or not there may be more than one thread associated with a program.
8422 It is implementation defined how threads beyond the first are
8423 created, the name and type of the function called at thread
8424 startup, and how threads may be terminated. However, objects
8425 with thread storage duration shall be initialized before thread
8426 startup.
8427 @end quotation
8428
8429 @item
8430 @cite{6.2.4 Storage durations of objects}
8431
8432 Add new text before paragraph 3
8433
8434 @quotation
8435 An object whose identifier is declared with the storage-class
8436 specifier @w{@code{__thread}} has @dfn{thread storage duration}.
8437 Its lifetime is the entire execution of the thread, and its
8438 stored value is initialized only once, prior to thread startup.
8439 @end quotation
8440
8441 @item
8442 @cite{6.4.1 Keywords}
8443
8444 Add @code{__thread}.
8445
8446 @item
8447 @cite{6.7.1 Storage-class specifiers}
8448
8449 Add @code{__thread} to the list of storage class specifiers in
8450 paragraph 1.
8451
8452 Change paragraph 2 to
8453
8454 @quotation
8455 With the exception of @code{__thread}, at most one storage-class
8456 specifier may be given [@dots{}]. The @code{__thread} specifier may
8457 be used alone, or immediately following @code{extern} or
8458 @code{static}.
8459 @end quotation
8460
8461 Add new text after paragraph 6
8462
8463 @quotation
8464 The declaration of an identifier for a variable that has
8465 block scope that specifies @code{__thread} shall also
8466 specify either @code{extern} or @code{static}.
8467
8468 The @code{__thread} specifier shall be used only with
8469 variables.
8470 @end quotation
8471 @end itemize
8472
8473 @node C++98 Thread-Local Edits
8474 @subsection ISO/IEC 14882:1998 Edits for Thread-Local Storage
8475
8476 The following are a set of changes to ISO/IEC 14882:1998 (aka C++98)
8477 that document the exact semantics of the language extension.
8478
8479 @itemize @bullet
8480 @item
8481 @b{[intro.execution]}
8482
8483 New text after paragraph 4
8484
8485 @quotation
8486 A @dfn{thread} is a flow of control within the abstract machine.
8487 It is implementation defined whether or not there may be more than
8488 one thread.
8489 @end quotation
8490
8491 New text after paragraph 7
8492
8493 @quotation
8494 It is unspecified whether additional action must be taken to
8495 ensure when and whether side effects are visible to other threads.
8496 @end quotation
8497
8498 @item
8499 @b{[lex.key]}
8500
8501 Add @code{__thread}.
8502
8503 @item
8504 @b{[basic.start.main]}
8505
8506 Add after paragraph 5
8507
8508 @quotation
8509 The thread that begins execution at the @code{main} function is called
8510 the @dfn{main thread}. It is implementation defined how functions
8511 beginning threads other than the main thread are designated or typed.
8512 A function so designated, as well as the @code{main} function, is called
8513 a @dfn{thread startup function}. It is implementation defined what
8514 happens if a thread startup function returns. It is implementation
8515 defined what happens to other threads when any thread calls @code{exit}.
8516 @end quotation
8517
8518 @item
8519 @b{[basic.start.init]}
8520
8521 Add after paragraph 4
8522
8523 @quotation
8524 The storage for an object of thread storage duration shall be
8525 statically initialized before the first statement of the thread startup
8526 function. An object of thread storage duration shall not require
8527 dynamic initialization.
8528 @end quotation
8529
8530 @item
8531 @b{[basic.start.term]}
8532
8533 Add after paragraph 3
8534
8535 @quotation
8536 The type of an object with thread storage duration shall not have a
8537 non-trivial destructor, nor shall it be an array type whose elements
8538 (directly or indirectly) have non-trivial destructors.
8539 @end quotation
8540
8541 @item
8542 @b{[basic.stc]}
8543
8544 Add ``thread storage duration'' to the list in paragraph 1.
8545
8546 Change paragraph 2
8547
8548 @quotation
8549 Thread, static, and automatic storage durations are associated with
8550 objects introduced by declarations [@dots{}].
8551 @end quotation
8552
8553 Add @code{__thread} to the list of specifiers in paragraph 3.
8554
8555 @item
8556 @b{[basic.stc.thread]}
8557
8558 New section before @b{[basic.stc.static]}
8559
8560 @quotation
8561 The keyword @code{__thread} applied to a non-local object gives the
8562 object thread storage duration.
8563
8564 A local variable or class data member declared both @code{static}
8565 and @code{__thread} gives the variable or member thread storage
8566 duration.
8567 @end quotation
8568
8569 @item
8570 @b{[basic.stc.static]}
8571
8572 Change paragraph 1
8573
8574 @quotation
8575 All objects which have neither thread storage duration, dynamic
8576 storage duration nor are local [@dots{}].
8577 @end quotation
8578
8579 @item
8580 @b{[dcl.stc]}
8581
8582 Add @code{__thread} to the list in paragraph 1.
8583
8584 Change paragraph 1
8585
8586 @quotation
8587 With the exception of @code{__thread}, at most one
8588 @var{storage-class-specifier} shall appear in a given
8589 @var{decl-specifier-seq}. The @code{__thread} specifier may
8590 be used alone, or immediately following the @code{extern} or
8591 @code{static} specifiers. [@dots{}]
8592 @end quotation
8593
8594 Add after paragraph 5
8595
8596 @quotation
8597 The @code{__thread} specifier can be applied only to the names of objects
8598 and to anonymous unions.
8599 @end quotation
8600
8601 @item
8602 @b{[class.mem]}
8603
8604 Add after paragraph 6
8605
8606 @quotation
8607 Non-@code{static} members shall not be @code{__thread}.
8608 @end quotation
8609 @end itemize
8610
8611 @node C++ Extensions
8612 @chapter Extensions to the C++ Language
8613 @cindex extensions, C++ language
8614 @cindex C++ language extensions
8615
8616 The GNU compiler provides these extensions to the C++ language (and you
8617 can also use most of the C language extensions in your C++ programs). If you
8618 want to write code that checks whether these features are available, you can
8619 test for the GNU compiler the same way as for C programs: check for a
8620 predefined macro @code{__GNUC__}. You can also use @code{__GNUG__} to
8621 test specifically for GNU C++ (@pxref{Common Predefined Macros,,
8622 Predefined Macros,cpp,The GNU C Preprocessor}).
8623
8624 @menu
8625 * Min and Max:: C++ Minimum and maximum operators.
8626 * Volatiles:: What constitutes an access to a volatile object.
8627 * Restricted Pointers:: C99 restricted pointers and references.
8628 * Vague Linkage:: Where G++ puts inlines, vtables and such.
8629 * C++ Interface:: You can use a single C++ header file for both
8630 declarations and definitions.
8631 * Template Instantiation:: Methods for ensuring that exactly one copy of
8632 each needed template instantiation is emitted.
8633 * Bound member functions:: You can extract a function pointer to the
8634 method denoted by a @samp{->*} or @samp{.*} expression.
8635 * C++ Attributes:: Variable, function, and type attributes for C++ only.
8636 * Strong Using:: Strong using-directives for namespace composition.
8637 * Java Exceptions:: Tweaking exception handling to work with Java.
8638 * Deprecated Features:: Things will disappear from g++.
8639 * Backwards Compatibility:: Compatibilities with earlier definitions of C++.
8640 @end menu
8641
8642 @node Min and Max
8643 @section Minimum and Maximum Operators in C++
8644
8645 It is very convenient to have operators which return the ``minimum'' or the
8646 ``maximum'' of two arguments. In GNU C++ (but not in GNU C),
8647
8648 @table @code
8649 @item @var{a} <? @var{b}
8650 @findex <?
8651 @cindex minimum operator
8652 is the @dfn{minimum}, returning the smaller of the numeric values
8653 @var{a} and @var{b};
8654
8655 @item @var{a} >? @var{b}
8656 @findex >?
8657 @cindex maximum operator
8658 is the @dfn{maximum}, returning the larger of the numeric values @var{a}
8659 and @var{b}.
8660 @end table
8661
8662 These operations are not primitive in ordinary C++, since you can
8663 use a macro to return the minimum of two things in C++, as in the
8664 following example.
8665
8666 @smallexample
8667 #define MIN(X,Y) ((X) < (Y) ? : (X) : (Y))
8668 @end smallexample
8669
8670 @noindent
8671 You might then use @w{@samp{int min = MIN (i, j);}} to set @var{min} to
8672 the minimum value of variables @var{i} and @var{j}.
8673
8674 However, side effects in @code{X} or @code{Y} may cause unintended
8675 behavior. For example, @code{MIN (i++, j++)} will fail, incrementing
8676 the smaller counter twice. The GNU C @code{typeof} extension allows you
8677 to write safe macros that avoid this kind of problem (@pxref{Typeof}).
8678 However, writing @code{MIN} and @code{MAX} as macros also forces you to
8679 use function-call notation for a fundamental arithmetic operation.
8680 Using GNU C++ extensions, you can write @w{@samp{int min = i <? j;}}
8681 instead.
8682
8683 Since @code{<?} and @code{>?} are built into the compiler, they properly
8684 handle expressions with side-effects; @w{@samp{int min = i++ <? j++;}}
8685 works correctly.
8686
8687 @node Volatiles
8688 @section When is a Volatile Object Accessed?
8689 @cindex accessing volatiles
8690 @cindex volatile read
8691 @cindex volatile write
8692 @cindex volatile access
8693
8694 Both the C and C++ standard have the concept of volatile objects. These
8695 are normally accessed by pointers and used for accessing hardware. The
8696 standards encourage compilers to refrain from optimizations
8697 concerning accesses to volatile objects that it might perform on
8698 non-volatile objects. The C standard leaves it implementation defined
8699 as to what constitutes a volatile access. The C++ standard omits to
8700 specify this, except to say that C++ should behave in a similar manner
8701 to C with respect to volatiles, where possible. The minimum either
8702 standard specifies is that at a sequence point all previous accesses to
8703 volatile objects have stabilized and no subsequent accesses have
8704 occurred. Thus an implementation is free to reorder and combine
8705 volatile accesses which occur between sequence points, but cannot do so
8706 for accesses across a sequence point. The use of volatiles does not
8707 allow you to violate the restriction on updating objects multiple times
8708 within a sequence point.
8709
8710 In most expressions, it is intuitively obvious what is a read and what is
8711 a write. For instance
8712
8713 @smallexample
8714 volatile int *dst = @var{somevalue};
8715 volatile int *src = @var{someothervalue};
8716 *dst = *src;
8717 @end smallexample
8718
8719 @noindent
8720 will cause a read of the volatile object pointed to by @var{src} and stores the
8721 value into the volatile object pointed to by @var{dst}. There is no
8722 guarantee that these reads and writes are atomic, especially for objects
8723 larger than @code{int}.
8724
8725 Less obvious expressions are where something which looks like an access
8726 is used in a void context. An example would be,
8727
8728 @smallexample
8729 volatile int *src = @var{somevalue};
8730 *src;
8731 @end smallexample
8732
8733 With C, such expressions are rvalues, and as rvalues cause a read of
8734 the object, GCC interprets this as a read of the volatile being pointed
8735 to. The C++ standard specifies that such expressions do not undergo
8736 lvalue to rvalue conversion, and that the type of the dereferenced
8737 object may be incomplete. The C++ standard does not specify explicitly
8738 that it is this lvalue to rvalue conversion which is responsible for
8739 causing an access. However, there is reason to believe that it is,
8740 because otherwise certain simple expressions become undefined. However,
8741 because it would surprise most programmers, G++ treats dereferencing a
8742 pointer to volatile object of complete type in a void context as a read
8743 of the object. When the object has incomplete type, G++ issues a
8744 warning.
8745
8746 @smallexample
8747 struct S;
8748 struct T @{int m;@};
8749 volatile S *ptr1 = @var{somevalue};
8750 volatile T *ptr2 = @var{somevalue};
8751 *ptr1;
8752 *ptr2;
8753 @end smallexample
8754
8755 In this example, a warning is issued for @code{*ptr1}, and @code{*ptr2}
8756 causes a read of the object pointed to. If you wish to force an error on
8757 the first case, you must force a conversion to rvalue with, for instance
8758 a static cast, @code{static_cast<S>(*ptr1)}.
8759
8760 When using a reference to volatile, G++ does not treat equivalent
8761 expressions as accesses to volatiles, but instead issues a warning that
8762 no volatile is accessed. The rationale for this is that otherwise it
8763 becomes difficult to determine where volatile access occur, and not
8764 possible to ignore the return value from functions returning volatile
8765 references. Again, if you wish to force a read, cast the reference to
8766 an rvalue.
8767
8768 @node Restricted Pointers
8769 @section Restricting Pointer Aliasing
8770 @cindex restricted pointers
8771 @cindex restricted references
8772 @cindex restricted this pointer
8773
8774 As with the C front end, G++ understands the C99 feature of restricted pointers,
8775 specified with the @code{__restrict__}, or @code{__restrict} type
8776 qualifier. Because you cannot compile C++ by specifying the @option{-std=c99}
8777 language flag, @code{restrict} is not a keyword in C++.
8778
8779 In addition to allowing restricted pointers, you can specify restricted
8780 references, which indicate that the reference is not aliased in the local
8781 context.
8782
8783 @smallexample
8784 void fn (int *__restrict__ rptr, int &__restrict__ rref)
8785 @{
8786 /* @r{@dots{}} */
8787 @}
8788 @end smallexample
8789
8790 @noindent
8791 In the body of @code{fn}, @var{rptr} points to an unaliased integer and
8792 @var{rref} refers to a (different) unaliased integer.
8793
8794 You may also specify whether a member function's @var{this} pointer is
8795 unaliased by using @code{__restrict__} as a member function qualifier.
8796
8797 @smallexample
8798 void T::fn () __restrict__
8799 @{
8800 /* @r{@dots{}} */
8801 @}
8802 @end smallexample
8803
8804 @noindent
8805 Within the body of @code{T::fn}, @var{this} will have the effective
8806 definition @code{T *__restrict__ const this}. Notice that the
8807 interpretation of a @code{__restrict__} member function qualifier is
8808 different to that of @code{const} or @code{volatile} qualifier, in that it
8809 is applied to the pointer rather than the object. This is consistent with
8810 other compilers which implement restricted pointers.
8811
8812 As with all outermost parameter qualifiers, @code{__restrict__} is
8813 ignored in function definition matching. This means you only need to
8814 specify @code{__restrict__} in a function definition, rather than
8815 in a function prototype as well.
8816
8817 @node Vague Linkage
8818 @section Vague Linkage
8819 @cindex vague linkage
8820
8821 There are several constructs in C++ which require space in the object
8822 file but are not clearly tied to a single translation unit. We say that
8823 these constructs have ``vague linkage''. Typically such constructs are
8824 emitted wherever they are needed, though sometimes we can be more
8825 clever.
8826
8827 @table @asis
8828 @item Inline Functions
8829 Inline functions are typically defined in a header file which can be
8830 included in many different compilations. Hopefully they can usually be
8831 inlined, but sometimes an out-of-line copy is necessary, if the address
8832 of the function is taken or if inlining fails. In general, we emit an
8833 out-of-line copy in all translation units where one is needed. As an
8834 exception, we only emit inline virtual functions with the vtable, since
8835 it will always require a copy.
8836
8837 Local static variables and string constants used in an inline function
8838 are also considered to have vague linkage, since they must be shared
8839 between all inlined and out-of-line instances of the function.
8840
8841 @item VTables
8842 @cindex vtable
8843 C++ virtual functions are implemented in most compilers using a lookup
8844 table, known as a vtable. The vtable contains pointers to the virtual
8845 functions provided by a class, and each object of the class contains a
8846 pointer to its vtable (or vtables, in some multiple-inheritance
8847 situations). If the class declares any non-inline, non-pure virtual
8848 functions, the first one is chosen as the ``key method'' for the class,
8849 and the vtable is only emitted in the translation unit where the key
8850 method is defined.
8851
8852 @emph{Note:} If the chosen key method is later defined as inline, the
8853 vtable will still be emitted in every translation unit which defines it.
8854 Make sure that any inline virtuals are declared inline in the class
8855 body, even if they are not defined there.
8856
8857 @item type_info objects
8858 @cindex type_info
8859 @cindex RTTI
8860 C++ requires information about types to be written out in order to
8861 implement @samp{dynamic_cast}, @samp{typeid} and exception handling.
8862 For polymorphic classes (classes with virtual functions), the type_info
8863 object is written out along with the vtable so that @samp{dynamic_cast}
8864 can determine the dynamic type of a class object at runtime. For all
8865 other types, we write out the type_info object when it is used: when
8866 applying @samp{typeid} to an expression, throwing an object, or
8867 referring to a type in a catch clause or exception specification.
8868
8869 @item Template Instantiations
8870 Most everything in this section also applies to template instantiations,
8871 but there are other options as well.
8872 @xref{Template Instantiation,,Where's the Template?}.
8873
8874 @end table
8875
8876 When used with GNU ld version 2.8 or later on an ELF system such as
8877 GNU/Linux or Solaris 2, or on Microsoft Windows, duplicate copies of
8878 these constructs will be discarded at link time. This is known as
8879 COMDAT support.
8880
8881 On targets that don't support COMDAT, but do support weak symbols, GCC
8882 will use them. This way one copy will override all the others, but
8883 the unused copies will still take up space in the executable.
8884
8885 For targets which do not support either COMDAT or weak symbols,
8886 most entities with vague linkage will be emitted as local symbols to
8887 avoid duplicate definition errors from the linker. This will not happen
8888 for local statics in inlines, however, as having multiple copies will
8889 almost certainly break things.
8890
8891 @xref{C++ Interface,,Declarations and Definitions in One Header}, for
8892 another way to control placement of these constructs.
8893
8894 @node C++ Interface
8895 @section #pragma interface and implementation
8896
8897 @cindex interface and implementation headers, C++
8898 @cindex C++ interface and implementation headers
8899 @cindex pragmas, interface and implementation
8900
8901 @code{#pragma interface} and @code{#pragma implementation} provide the
8902 user with a way of explicitly directing the compiler to emit entities
8903 with vague linkage (and debugging information) in a particular
8904 translation unit.
8905
8906 @emph{Note:} As of GCC 2.7.2, these @code{#pragma}s are not useful in
8907 most cases, because of COMDAT support and the ``key method'' heuristic
8908 mentioned in @ref{Vague Linkage}. Using them can actually cause your
8909 program to grow due to unnecessary out-of-line copies of inline
8910 functions. Currently (3.4) the only benefit of these
8911 @code{#pragma}s is reduced duplication of debugging information, and
8912 that should be addressed soon on DWARF 2 targets with the use of
8913 COMDAT groups.
8914
8915 @table @code
8916 @item #pragma interface
8917 @itemx #pragma interface "@var{subdir}/@var{objects}.h"
8918 @kindex #pragma interface
8919 Use this directive in @emph{header files} that define object classes, to save
8920 space in most of the object files that use those classes. Normally,
8921 local copies of certain information (backup copies of inline member
8922 functions, debugging information, and the internal tables that implement
8923 virtual functions) must be kept in each object file that includes class
8924 definitions. You can use this pragma to avoid such duplication. When a
8925 header file containing @samp{#pragma interface} is included in a
8926 compilation, this auxiliary information will not be generated (unless
8927 the main input source file itself uses @samp{#pragma implementation}).
8928 Instead, the object files will contain references to be resolved at link
8929 time.
8930
8931 The second form of this directive is useful for the case where you have
8932 multiple headers with the same name in different directories. If you
8933 use this form, you must specify the same string to @samp{#pragma
8934 implementation}.
8935
8936 @item #pragma implementation
8937 @itemx #pragma implementation "@var{objects}.h"
8938 @kindex #pragma implementation
8939 Use this pragma in a @emph{main input file}, when you want full output from
8940 included header files to be generated (and made globally visible). The
8941 included header file, in turn, should use @samp{#pragma interface}.
8942 Backup copies of inline member functions, debugging information, and the
8943 internal tables used to implement virtual functions are all generated in
8944 implementation files.
8945
8946 @cindex implied @code{#pragma implementation}
8947 @cindex @code{#pragma implementation}, implied
8948 @cindex naming convention, implementation headers
8949 If you use @samp{#pragma implementation} with no argument, it applies to
8950 an include file with the same basename@footnote{A file's @dfn{basename}
8951 was the name stripped of all leading path information and of trailing
8952 suffixes, such as @samp{.h} or @samp{.C} or @samp{.cc}.} as your source
8953 file. For example, in @file{allclass.cc}, giving just
8954 @samp{#pragma implementation}
8955 by itself is equivalent to @samp{#pragma implementation "allclass.h"}.
8956
8957 In versions of GNU C++ prior to 2.6.0 @file{allclass.h} was treated as
8958 an implementation file whenever you would include it from
8959 @file{allclass.cc} even if you never specified @samp{#pragma
8960 implementation}. This was deemed to be more trouble than it was worth,
8961 however, and disabled.
8962
8963 Use the string argument if you want a single implementation file to
8964 include code from multiple header files. (You must also use
8965 @samp{#include} to include the header file; @samp{#pragma
8966 implementation} only specifies how to use the file---it doesn't actually
8967 include it.)
8968
8969 There is no way to split up the contents of a single header file into
8970 multiple implementation files.
8971 @end table
8972
8973 @cindex inlining and C++ pragmas
8974 @cindex C++ pragmas, effect on inlining
8975 @cindex pragmas in C++, effect on inlining
8976 @samp{#pragma implementation} and @samp{#pragma interface} also have an
8977 effect on function inlining.
8978
8979 If you define a class in a header file marked with @samp{#pragma
8980 interface}, the effect on an inline function defined in that class is
8981 similar to an explicit @code{extern} declaration---the compiler emits
8982 no code at all to define an independent version of the function. Its
8983 definition is used only for inlining with its callers.
8984
8985 @opindex fno-implement-inlines
8986 Conversely, when you include the same header file in a main source file
8987 that declares it as @samp{#pragma implementation}, the compiler emits
8988 code for the function itself; this defines a version of the function
8989 that can be found via pointers (or by callers compiled without
8990 inlining). If all calls to the function can be inlined, you can avoid
8991 emitting the function by compiling with @option{-fno-implement-inlines}.
8992 If any calls were not inlined, you will get linker errors.
8993
8994 @node Template Instantiation
8995 @section Where's the Template?
8996 @cindex template instantiation
8997
8998 C++ templates are the first language feature to require more
8999 intelligence from the environment than one usually finds on a UNIX
9000 system. Somehow the compiler and linker have to make sure that each
9001 template instance occurs exactly once in the executable if it is needed,
9002 and not at all otherwise. There are two basic approaches to this
9003 problem, which are referred to as the Borland model and the Cfront model.
9004
9005 @table @asis
9006 @item Borland model
9007 Borland C++ solved the template instantiation problem by adding the code
9008 equivalent of common blocks to their linker; the compiler emits template
9009 instances in each translation unit that uses them, and the linker
9010 collapses them together. The advantage of this model is that the linker
9011 only has to consider the object files themselves; there is no external
9012 complexity to worry about. This disadvantage is that compilation time
9013 is increased because the template code is being compiled repeatedly.
9014 Code written for this model tends to include definitions of all
9015 templates in the header file, since they must be seen to be
9016 instantiated.
9017
9018 @item Cfront model
9019 The AT&T C++ translator, Cfront, solved the template instantiation
9020 problem by creating the notion of a template repository, an
9021 automatically maintained place where template instances are stored. A
9022 more modern version of the repository works as follows: As individual
9023 object files are built, the compiler places any template definitions and
9024 instantiations encountered in the repository. At link time, the link
9025 wrapper adds in the objects in the repository and compiles any needed
9026 instances that were not previously emitted. The advantages of this
9027 model are more optimal compilation speed and the ability to use the
9028 system linker; to implement the Borland model a compiler vendor also
9029 needs to replace the linker. The disadvantages are vastly increased
9030 complexity, and thus potential for error; for some code this can be
9031 just as transparent, but in practice it can been very difficult to build
9032 multiple programs in one directory and one program in multiple
9033 directories. Code written for this model tends to separate definitions
9034 of non-inline member templates into a separate file, which should be
9035 compiled separately.
9036 @end table
9037
9038 When used with GNU ld version 2.8 or later on an ELF system such as
9039 GNU/Linux or Solaris 2, or on Microsoft Windows, G++ supports the
9040 Borland model. On other systems, G++ implements neither automatic
9041 model.
9042
9043 A future version of G++ will support a hybrid model whereby the compiler
9044 will emit any instantiations for which the template definition is
9045 included in the compile, and store template definitions and
9046 instantiation context information into the object file for the rest.
9047 The link wrapper will extract that information as necessary and invoke
9048 the compiler to produce the remaining instantiations. The linker will
9049 then combine duplicate instantiations.
9050
9051 In the mean time, you have the following options for dealing with
9052 template instantiations:
9053
9054 @enumerate
9055 @item
9056 @opindex frepo
9057 Compile your template-using code with @option{-frepo}. The compiler will
9058 generate files with the extension @samp{.rpo} listing all of the
9059 template instantiations used in the corresponding object files which
9060 could be instantiated there; the link wrapper, @samp{collect2}, will
9061 then update the @samp{.rpo} files to tell the compiler where to place
9062 those instantiations and rebuild any affected object files. The
9063 link-time overhead is negligible after the first pass, as the compiler
9064 will continue to place the instantiations in the same files.
9065
9066 This is your best option for application code written for the Borland
9067 model, as it will just work. Code written for the Cfront model will
9068 need to be modified so that the template definitions are available at
9069 one or more points of instantiation; usually this is as simple as adding
9070 @code{#include <tmethods.cc>} to the end of each template header.
9071
9072 For library code, if you want the library to provide all of the template
9073 instantiations it needs, just try to link all of its object files
9074 together; the link will fail, but cause the instantiations to be
9075 generated as a side effect. Be warned, however, that this may cause
9076 conflicts if multiple libraries try to provide the same instantiations.
9077 For greater control, use explicit instantiation as described in the next
9078 option.
9079
9080 @item
9081 @opindex fno-implicit-templates
9082 Compile your code with @option{-fno-implicit-templates} to disable the
9083 implicit generation of template instances, and explicitly instantiate
9084 all the ones you use. This approach requires more knowledge of exactly
9085 which instances you need than do the others, but it's less
9086 mysterious and allows greater control. You can scatter the explicit
9087 instantiations throughout your program, perhaps putting them in the
9088 translation units where the instances are used or the translation units
9089 that define the templates themselves; you can put all of the explicit
9090 instantiations you need into one big file; or you can create small files
9091 like
9092
9093 @smallexample
9094 #include "Foo.h"
9095 #include "Foo.cc"
9096
9097 template class Foo<int>;
9098 template ostream& operator <<
9099 (ostream&, const Foo<int>&);
9100 @end smallexample
9101
9102 for each of the instances you need, and create a template instantiation
9103 library from those.
9104
9105 If you are using Cfront-model code, you can probably get away with not
9106 using @option{-fno-implicit-templates} when compiling files that don't
9107 @samp{#include} the member template definitions.
9108
9109 If you use one big file to do the instantiations, you may want to
9110 compile it without @option{-fno-implicit-templates} so you get all of the
9111 instances required by your explicit instantiations (but not by any
9112 other files) without having to specify them as well.
9113
9114 G++ has extended the template instantiation syntax given in the ISO
9115 standard to allow forward declaration of explicit instantiations
9116 (with @code{extern}), instantiation of the compiler support data for a
9117 template class (i.e.@: the vtable) without instantiating any of its
9118 members (with @code{inline}), and instantiation of only the static data
9119 members of a template class, without the support data or member
9120 functions (with (@code{static}):
9121
9122 @smallexample
9123 extern template int max (int, int);
9124 inline template class Foo<int>;
9125 static template class Foo<int>;
9126 @end smallexample
9127
9128 @item
9129 Do nothing. Pretend G++ does implement automatic instantiation
9130 management. Code written for the Borland model will work fine, but
9131 each translation unit will contain instances of each of the templates it
9132 uses. In a large program, this can lead to an unacceptable amount of code
9133 duplication.
9134 @end enumerate
9135
9136 @node Bound member functions
9137 @section Extracting the function pointer from a bound pointer to member function
9138 @cindex pmf
9139 @cindex pointer to member function
9140 @cindex bound pointer to member function
9141
9142 In C++, pointer to member functions (PMFs) are implemented using a wide
9143 pointer of sorts to handle all the possible call mechanisms; the PMF
9144 needs to store information about how to adjust the @samp{this} pointer,
9145 and if the function pointed to is virtual, where to find the vtable, and
9146 where in the vtable to look for the member function. If you are using
9147 PMFs in an inner loop, you should really reconsider that decision. If
9148 that is not an option, you can extract the pointer to the function that
9149 would be called for a given object/PMF pair and call it directly inside
9150 the inner loop, to save a bit of time.
9151
9152 Note that you will still be paying the penalty for the call through a
9153 function pointer; on most modern architectures, such a call defeats the
9154 branch prediction features of the CPU@. This is also true of normal
9155 virtual function calls.
9156
9157 The syntax for this extension is
9158
9159 @smallexample
9160 extern A a;
9161 extern int (A::*fp)();
9162 typedef int (*fptr)(A *);
9163
9164 fptr p = (fptr)(a.*fp);
9165 @end smallexample
9166
9167 For PMF constants (i.e.@: expressions of the form @samp{&Klasse::Member}),
9168 no object is needed to obtain the address of the function. They can be
9169 converted to function pointers directly:
9170
9171 @smallexample
9172 fptr p1 = (fptr)(&A::foo);
9173 @end smallexample
9174
9175 @opindex Wno-pmf-conversions
9176 You must specify @option{-Wno-pmf-conversions} to use this extension.
9177
9178 @node C++ Attributes
9179 @section C++-Specific Variable, Function, and Type Attributes
9180
9181 Some attributes only make sense for C++ programs.
9182
9183 @table @code
9184 @item init_priority (@var{priority})
9185 @cindex init_priority attribute
9186
9187
9188 In Standard C++, objects defined at namespace scope are guaranteed to be
9189 initialized in an order in strict accordance with that of their definitions
9190 @emph{in a given translation unit}. No guarantee is made for initializations
9191 across translation units. However, GNU C++ allows users to control the
9192 order of initialization of objects defined at namespace scope with the
9193 @code{init_priority} attribute by specifying a relative @var{priority},
9194 a constant integral expression currently bounded between 101 and 65535
9195 inclusive. Lower numbers indicate a higher priority.
9196
9197 In the following example, @code{A} would normally be created before
9198 @code{B}, but the @code{init_priority} attribute has reversed that order:
9199
9200 @smallexample
9201 Some_Class A __attribute__ ((init_priority (2000)));
9202 Some_Class B __attribute__ ((init_priority (543)));
9203 @end smallexample
9204
9205 @noindent
9206 Note that the particular values of @var{priority} do not matter; only their
9207 relative ordering.
9208
9209 @item java_interface
9210 @cindex java_interface attribute
9211
9212 This type attribute informs C++ that the class is a Java interface. It may
9213 only be applied to classes declared within an @code{extern "Java"} block.
9214 Calls to methods declared in this interface will be dispatched using GCJ's
9215 interface table mechanism, instead of regular virtual table dispatch.
9216
9217 @end table
9218
9219 See also @xref{Strong Using}.
9220
9221 @node Strong Using
9222 @section Strong Using
9223
9224 @strong{Caution:} The semantics of this extension are not fully
9225 defined. Users should refrain from using this extension as its
9226 semantics may change subtly over time. It is possible that this
9227 extension wil be removed in future versions of G++.
9228
9229 A using-directive with @code{__attribute ((strong))} is stronger
9230 than a normal using-directive in two ways:
9231
9232 @itemize @bullet
9233 @item
9234 Templates from the used namespace can be specialized as though they were members of the using namespace.
9235
9236 @item
9237 The using namespace is considered an associated namespace of all
9238 templates in the used namespace for purposes of argument-dependent
9239 name lookup.
9240 @end itemize
9241
9242 This is useful for composing a namespace transparently from
9243 implementation namespaces. For example:
9244
9245 @smallexample
9246 namespace std @{
9247 namespace debug @{
9248 template <class T> struct A @{ @};
9249 @}
9250 using namespace debug __attribute ((__strong__));
9251 template <> struct A<int> @{ @}; // @r{ok to specialize}
9252
9253 template <class T> void f (A<T>);
9254 @}
9255
9256 int main()
9257 @{
9258 f (std::A<float>()); // @r{lookup finds} std::f
9259 f (std::A<int>());
9260 @}
9261 @end smallexample
9262
9263 @node Java Exceptions
9264 @section Java Exceptions
9265
9266 The Java language uses a slightly different exception handling model
9267 from C++. Normally, GNU C++ will automatically detect when you are
9268 writing C++ code that uses Java exceptions, and handle them
9269 appropriately. However, if C++ code only needs to execute destructors
9270 when Java exceptions are thrown through it, GCC will guess incorrectly.
9271 Sample problematic code is:
9272
9273 @smallexample
9274 struct S @{ ~S(); @};
9275 extern void bar(); // @r{is written in Java, and may throw exceptions}
9276 void foo()
9277 @{
9278 S s;
9279 bar();
9280 @}
9281 @end smallexample
9282
9283 @noindent
9284 The usual effect of an incorrect guess is a link failure, complaining of
9285 a missing routine called @samp{__gxx_personality_v0}.
9286
9287 You can inform the compiler that Java exceptions are to be used in a
9288 translation unit, irrespective of what it might think, by writing
9289 @samp{@w{#pragma GCC java_exceptions}} at the head of the file. This
9290 @samp{#pragma} must appear before any functions that throw or catch
9291 exceptions, or run destructors when exceptions are thrown through them.
9292
9293 You cannot mix Java and C++ exceptions in the same translation unit. It
9294 is believed to be safe to throw a C++ exception from one file through
9295 another file compiled for the Java exception model, or vice versa, but
9296 there may be bugs in this area.
9297
9298 @node Deprecated Features
9299 @section Deprecated Features
9300
9301 In the past, the GNU C++ compiler was extended to experiment with new
9302 features, at a time when the C++ language was still evolving. Now that
9303 the C++ standard is complete, some of those features are superseded by
9304 superior alternatives. Using the old features might cause a warning in
9305 some cases that the feature will be dropped in the future. In other
9306 cases, the feature might be gone already.
9307
9308 While the list below is not exhaustive, it documents some of the options
9309 that are now deprecated:
9310
9311 @table @code
9312 @item -fexternal-templates
9313 @itemx -falt-external-templates
9314 These are two of the many ways for G++ to implement template
9315 instantiation. @xref{Template Instantiation}. The C++ standard clearly
9316 defines how template definitions have to be organized across
9317 implementation units. G++ has an implicit instantiation mechanism that
9318 should work just fine for standard-conforming code.
9319
9320 @item -fstrict-prototype
9321 @itemx -fno-strict-prototype
9322 Previously it was possible to use an empty prototype parameter list to
9323 indicate an unspecified number of parameters (like C), rather than no
9324 parameters, as C++ demands. This feature has been removed, except where
9325 it is required for backwards compatibility @xref{Backwards Compatibility}.
9326 @end table
9327
9328 The named return value extension has been deprecated, and is now
9329 removed from G++.
9330
9331 The use of initializer lists with new expressions has been deprecated,
9332 and is now removed from G++.
9333
9334 Floating and complex non-type template parameters have been deprecated,
9335 and are now removed from G++.
9336
9337 The implicit typename extension has been deprecated and is now
9338 removed from G++.
9339
9340 The use of default arguments in function pointers, function typedefs and
9341 and other places where they are not permitted by the standard is
9342 deprecated and will be removed from a future version of G++.
9343
9344 @node Backwards Compatibility
9345 @section Backwards Compatibility
9346 @cindex Backwards Compatibility
9347 @cindex ARM [Annotated C++ Reference Manual]
9348
9349 Now that there is a definitive ISO standard C++, G++ has a specification
9350 to adhere to. The C++ language evolved over time, and features that
9351 used to be acceptable in previous drafts of the standard, such as the ARM
9352 [Annotated C++ Reference Manual], are no longer accepted. In order to allow
9353 compilation of C++ written to such drafts, G++ contains some backwards
9354 compatibilities. @emph{All such backwards compatibility features are
9355 liable to disappear in future versions of G++.} They should be considered
9356 deprecated @xref{Deprecated Features}.
9357
9358 @table @code
9359 @item For scope
9360 If a variable is declared at for scope, it used to remain in scope until
9361 the end of the scope which contained the for statement (rather than just
9362 within the for scope). G++ retains this, but issues a warning, if such a
9363 variable is accessed outside the for scope.
9364
9365 @item Implicit C language
9366 Old C system header files did not contain an @code{extern "C" @{@dots{}@}}
9367 scope to set the language. On such systems, all header files are
9368 implicitly scoped inside a C language scope. Also, an empty prototype
9369 @code{()} will be treated as an unspecified number of arguments, rather
9370 than no arguments, as C++ demands.
9371 @end table