OSDN Git Service

./:
[pf3gnuchains/gcc-fork.git] / gcc / doc / extend.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1996, 1998, 1999, 2000, 2001,
2 @c 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
3 @c Free Software Foundation, Inc.
4
5 @c This is part of the GCC manual.
6 @c For copying conditions, see the file gcc.texi.
7
8 @node C Extensions
9 @chapter Extensions to the C Language Family
10 @cindex extensions, C language
11 @cindex C language extensions
12
13 @opindex pedantic
14 GNU C provides several language features not found in ISO standard C@.
15 (The @option{-pedantic} option directs GCC to print a warning message if
16 any of these features is used.)  To test for the availability of these
17 features in conditional compilation, check for a predefined macro
18 @code{__GNUC__}, which is always defined under GCC@.
19
20 These extensions are available in C and Objective-C@.  Most of them are
21 also available in C++.  @xref{C++ Extensions,,Extensions to the
22 C++ Language}, for extensions that apply @emph{only} to C++.
23
24 Some features that are in ISO C99 but not C89 or C++ are also, as
25 extensions, accepted by GCC in C89 mode and in C++.
26
27 @menu
28 * Statement Exprs::     Putting statements and declarations inside expressions.
29 * Local Labels::        Labels local to a block.
30 * Labels as Values::    Getting pointers to labels, and computed gotos.
31 * Nested Functions::    As in Algol and Pascal, lexical scoping of functions.
32 * Constructing Calls::  Dispatching a call to another function.
33 * Typeof::              @code{typeof}: referring to the type of an expression.
34 * Conditionals::        Omitting the middle operand of a @samp{?:} expression.
35 * Long Long::           Double-word integers---@code{long long int}.
36 * Complex::             Data types for complex numbers.
37 * Floating Types::      Additional Floating Types.
38 * Decimal Float::       Decimal Floating Types. 
39 * Hex Floats::          Hexadecimal floating-point constants.
40 * Fixed-Point::         Fixed-Point Types.
41 * Zero Length::         Zero-length arrays.
42 * Variable Length::     Arrays whose length is computed at run time.
43 * Empty Structures::    Structures with no members.
44 * Variadic Macros::     Macros with a variable number of arguments.
45 * Escaped Newlines::    Slightly looser rules for escaped newlines.
46 * Subscripting::        Any array can be subscripted, even if not an lvalue.
47 * Pointer Arith::       Arithmetic on @code{void}-pointers and function pointers.
48 * Initializers::        Non-constant initializers.
49 * Compound Literals::   Compound literals give structures, unions
50                         or arrays as values.
51 * Designated Inits::    Labeling elements of initializers.
52 * Cast to Union::       Casting to union type from any member of the union.
53 * Case Ranges::         `case 1 ... 9' and such.
54 * Mixed Declarations::  Mixing declarations and code.
55 * Function Attributes:: Declaring that functions have no side effects,
56                         or that they can never return.
57 * Attribute Syntax::    Formal syntax for attributes.
58 * Function Prototypes:: Prototype declarations and old-style definitions.
59 * C++ Comments::        C++ comments are recognized.
60 * Dollar Signs::        Dollar sign is allowed in identifiers.
61 * Character Escapes::   @samp{\e} stands for the character @key{ESC}.
62 * Variable Attributes:: Specifying attributes of variables.
63 * Type Attributes::     Specifying attributes of types.
64 * Alignment::           Inquiring about the alignment of a type or variable.
65 * Inline::              Defining inline functions (as fast as macros).
66 * Extended Asm::        Assembler instructions with C expressions as operands.
67                         (With them you can define ``built-in'' functions.)
68 * Constraints::         Constraints for asm operands
69 * Asm Labels::          Specifying the assembler name to use for a C symbol.
70 * Explicit Reg Vars::   Defining variables residing in specified registers.
71 * Alternate Keywords::  @code{__const__}, @code{__asm__}, etc., for header files.
72 * Incomplete Enums::    @code{enum foo;}, with details to follow.
73 * Function Names::      Printable strings which are the name of the current
74                         function.
75 * Return Address::      Getting the return or frame address of a function.
76 * Vector Extensions::   Using vector instructions through built-in functions.
77 * Offsetof::            Special syntax for implementing @code{offsetof}.
78 * Atomic Builtins::     Built-in functions for atomic memory access.
79 * Object Size Checking:: Built-in functions for limited buffer overflow
80                         checking.
81 * Other Builtins::      Other built-in functions.
82 * Target Builtins::     Built-in functions specific to particular targets.
83 * Target Format Checks:: Format checks specific to particular targets.
84 * Pragmas::             Pragmas accepted by GCC.
85 * Unnamed Fields::      Unnamed struct/union fields within structs/unions.
86 * Thread-Local::        Per-thread variables.
87 * Binary constants::    Binary constants using the @samp{0b} prefix.
88 @end menu
89
90 @node Statement Exprs
91 @section Statements and Declarations in Expressions
92 @cindex statements inside expressions
93 @cindex declarations inside expressions
94 @cindex expressions containing statements
95 @cindex macros, statements in expressions
96
97 @c the above section title wrapped and causes an underfull hbox.. i
98 @c changed it from "within" to "in". --mew 4feb93
99 A compound statement enclosed in parentheses may appear as an expression
100 in GNU C@.  This allows you to use loops, switches, and local variables
101 within an expression.
102
103 Recall that a compound statement is a sequence of statements surrounded
104 by braces; in this construct, parentheses go around the braces.  For
105 example:
106
107 @smallexample
108 (@{ int y = foo (); int z;
109    if (y > 0) z = y;
110    else z = - y;
111    z; @})
112 @end smallexample
113
114 @noindent
115 is a valid (though slightly more complex than necessary) expression
116 for the absolute value of @code{foo ()}.
117
118 The last thing in the compound statement should be an expression
119 followed by a semicolon; the value of this subexpression serves as the
120 value of the entire construct.  (If you use some other kind of statement
121 last within the braces, the construct has type @code{void}, and thus
122 effectively no value.)
123
124 This feature is especially useful in making macro definitions ``safe'' (so
125 that they evaluate each operand exactly once).  For example, the
126 ``maximum'' function is commonly defined as a macro in standard C as
127 follows:
128
129 @smallexample
130 #define max(a,b) ((a) > (b) ? (a) : (b))
131 @end smallexample
132
133 @noindent
134 @cindex side effects, macro argument
135 But this definition computes either @var{a} or @var{b} twice, with bad
136 results if the operand has side effects.  In GNU C, if you know the
137 type of the operands (here taken as @code{int}), you can define
138 the macro safely as follows:
139
140 @smallexample
141 #define maxint(a,b) \
142   (@{int _a = (a), _b = (b); _a > _b ? _a : _b; @})
143 @end smallexample
144
145 Embedded statements are not allowed in constant expressions, such as
146 the value of an enumeration constant, the width of a bit-field, or
147 the initial value of a static variable.
148
149 If you don't know the type of the operand, you can still do this, but you
150 must use @code{typeof} (@pxref{Typeof}).
151
152 In G++, the result value of a statement expression undergoes array and
153 function pointer decay, and is returned by value to the enclosing
154 expression.  For instance, if @code{A} is a class, then
155
156 @smallexample
157         A a;
158
159         (@{a;@}).Foo ()
160 @end smallexample
161
162 @noindent
163 will construct a temporary @code{A} object to hold the result of the
164 statement expression, and that will be used to invoke @code{Foo}.
165 Therefore the @code{this} pointer observed by @code{Foo} will not be the
166 address of @code{a}.
167
168 Any temporaries created within a statement within a statement expression
169 will be destroyed at the statement's end.  This makes statement
170 expressions inside macros slightly different from function calls.  In
171 the latter case temporaries introduced during argument evaluation will
172 be destroyed at the end of the statement that includes the function
173 call.  In the statement expression case they will be destroyed during
174 the statement expression.  For instance,
175
176 @smallexample
177 #define macro(a)  (@{__typeof__(a) b = (a); b + 3; @})
178 template<typename T> T function(T a) @{ T b = a; return b + 3; @}
179
180 void foo ()
181 @{
182   macro (X ());
183   function (X ());
184 @}
185 @end smallexample
186
187 @noindent
188 will have different places where temporaries are destroyed.  For the
189 @code{macro} case, the temporary @code{X} will be destroyed just after
190 the initialization of @code{b}.  In the @code{function} case that
191 temporary will be destroyed when the function returns.
192
193 These considerations mean that it is probably a bad idea to use
194 statement-expressions of this form in header files that are designed to
195 work with C++.  (Note that some versions of the GNU C Library contained
196 header files using statement-expression that lead to precisely this
197 bug.)
198
199 Jumping into a statement expression with @code{goto} or using a
200 @code{switch} statement outside the statement expression with a
201 @code{case} or @code{default} label inside the statement expression is
202 not permitted.  Jumping into a statement expression with a computed
203 @code{goto} (@pxref{Labels as Values}) yields undefined behavior.
204 Jumping out of a statement expression is permitted, but if the
205 statement expression is part of a larger expression then it is
206 unspecified which other subexpressions of that expression have been
207 evaluated except where the language definition requires certain
208 subexpressions to be evaluated before or after the statement
209 expression.  In any case, as with a function call the evaluation of a
210 statement expression is not interleaved with the evaluation of other
211 parts of the containing expression.  For example,
212
213 @smallexample
214   foo (), ((@{ bar1 (); goto a; 0; @}) + bar2 ()), baz();
215 @end smallexample
216
217 @noindent
218 will call @code{foo} and @code{bar1} and will not call @code{baz} but
219 may or may not call @code{bar2}.  If @code{bar2} is called, it will be
220 called after @code{foo} and before @code{bar1}
221
222 @node Local Labels
223 @section Locally Declared Labels
224 @cindex local labels
225 @cindex macros, local labels
226
227 GCC allows you to declare @dfn{local labels} in any nested block
228 scope.  A local label is just like an ordinary label, but you can
229 only reference it (with a @code{goto} statement, or by taking its
230 address) within the block in which it was declared.
231
232 A local label declaration looks like this:
233
234 @smallexample
235 __label__ @var{label};
236 @end smallexample
237
238 @noindent
239 or
240
241 @smallexample
242 __label__ @var{label1}, @var{label2}, /* @r{@dots{}} */;
243 @end smallexample
244
245 Local label declarations must come at the beginning of the block,
246 before any ordinary declarations or statements.
247
248 The label declaration defines the label @emph{name}, but does not define
249 the label itself.  You must do this in the usual way, with
250 @code{@var{label}:}, within the statements of the statement expression.
251
252 The local label feature is useful for complex macros.  If a macro
253 contains nested loops, a @code{goto} can be useful for breaking out of
254 them.  However, an ordinary label whose scope is the whole function
255 cannot be used: if the macro can be expanded several times in one
256 function, the label will be multiply defined in that function.  A
257 local label avoids this problem.  For example:
258
259 @smallexample
260 #define SEARCH(value, array, target)              \
261 do @{                                              \
262   __label__ found;                                \
263   typeof (target) _SEARCH_target = (target);      \
264   typeof (*(array)) *_SEARCH_array = (array);     \
265   int i, j;                                       \
266   int value;                                      \
267   for (i = 0; i < max; i++)                       \
268     for (j = 0; j < max; j++)                     \
269       if (_SEARCH_array[i][j] == _SEARCH_target)  \
270         @{ (value) = i; goto found; @}              \
271   (value) = -1;                                   \
272  found:;                                          \
273 @} while (0)
274 @end smallexample
275
276 This could also be written using a statement-expression:
277
278 @smallexample
279 #define SEARCH(array, target)                     \
280 (@{                                                \
281   __label__ found;                                \
282   typeof (target) _SEARCH_target = (target);      \
283   typeof (*(array)) *_SEARCH_array = (array);     \
284   int i, j;                                       \
285   int value;                                      \
286   for (i = 0; i < max; i++)                       \
287     for (j = 0; j < max; j++)                     \
288       if (_SEARCH_array[i][j] == _SEARCH_target)  \
289         @{ value = i; goto found; @}                \
290   value = -1;                                     \
291  found:                                           \
292   value;                                          \
293 @})
294 @end smallexample
295
296 Local label declarations also make the labels they declare visible to
297 nested functions, if there are any.  @xref{Nested Functions}, for details.
298
299 @node Labels as Values
300 @section Labels as Values
301 @cindex labels as values
302 @cindex computed gotos
303 @cindex goto with computed label
304 @cindex address of a label
305
306 You can get the address of a label defined in the current function
307 (or a containing function) with the unary operator @samp{&&}.  The
308 value has type @code{void *}.  This value is a constant and can be used
309 wherever a constant of that type is valid.  For example:
310
311 @smallexample
312 void *ptr;
313 /* @r{@dots{}} */
314 ptr = &&foo;
315 @end smallexample
316
317 To use these values, you need to be able to jump to one.  This is done
318 with the computed goto statement@footnote{The analogous feature in
319 Fortran is called an assigned goto, but that name seems inappropriate in
320 C, where one can do more than simply store label addresses in label
321 variables.}, @code{goto *@var{exp};}.  For example,
322
323 @smallexample
324 goto *ptr;
325 @end smallexample
326
327 @noindent
328 Any expression of type @code{void *} is allowed.
329
330 One way of using these constants is in initializing a static array that
331 will serve as a jump table:
332
333 @smallexample
334 static void *array[] = @{ &&foo, &&bar, &&hack @};
335 @end smallexample
336
337 Then you can select a label with indexing, like this:
338
339 @smallexample
340 goto *array[i];
341 @end smallexample
342
343 @noindent
344 Note that this does not check whether the subscript is in bounds---array
345 indexing in C never does that.
346
347 Such an array of label values serves a purpose much like that of the
348 @code{switch} statement.  The @code{switch} statement is cleaner, so
349 use that rather than an array unless the problem does not fit a
350 @code{switch} statement very well.
351
352 Another use of label values is in an interpreter for threaded code.
353 The labels within the interpreter function can be stored in the
354 threaded code for super-fast dispatching.
355
356 You may not use this mechanism to jump to code in a different function.
357 If you do that, totally unpredictable things will happen.  The best way to
358 avoid this is to store the label address only in automatic variables and
359 never pass it as an argument.
360
361 An alternate way to write the above example is
362
363 @smallexample
364 static const int array[] = @{ &&foo - &&foo, &&bar - &&foo,
365                              &&hack - &&foo @};
366 goto *(&&foo + array[i]);
367 @end smallexample
368
369 @noindent
370 This is more friendly to code living in shared libraries, as it reduces
371 the number of dynamic relocations that are needed, and by consequence,
372 allows the data to be read-only.
373
374 The @code{&&foo} expressions for the same label might have different values
375 if the containing function is inlined or cloned.  If a program relies on
376 them being always the same, @code{__attribute__((__noinline__))} should
377 be used to prevent inlining.  If @code{&&foo} is used
378 in a static variable initializer, inlining is forbidden.
379
380 @node Nested Functions
381 @section Nested Functions
382 @cindex nested functions
383 @cindex downward funargs
384 @cindex thunks
385
386 A @dfn{nested function} is a function defined inside another function.
387 (Nested functions are not supported for GNU C++.)  The nested function's
388 name is local to the block where it is defined.  For example, here we
389 define a nested function named @code{square}, and call it twice:
390
391 @smallexample
392 @group
393 foo (double a, double b)
394 @{
395   double square (double z) @{ return z * z; @}
396
397   return square (a) + square (b);
398 @}
399 @end group
400 @end smallexample
401
402 The nested function can access all the variables of the containing
403 function that are visible at the point of its definition.  This is
404 called @dfn{lexical scoping}.  For example, here we show a nested
405 function which uses an inherited variable named @code{offset}:
406
407 @smallexample
408 @group
409 bar (int *array, int offset, int size)
410 @{
411   int access (int *array, int index)
412     @{ return array[index + offset]; @}
413   int i;
414   /* @r{@dots{}} */
415   for (i = 0; i < size; i++)
416     /* @r{@dots{}} */ access (array, i) /* @r{@dots{}} */
417 @}
418 @end group
419 @end smallexample
420
421 Nested function definitions are permitted within functions in the places
422 where variable definitions are allowed; that is, in any block, mixed
423 with the other declarations and statements in the block.
424
425 It is possible to call the nested function from outside the scope of its
426 name by storing its address or passing the address to another function:
427
428 @smallexample
429 hack (int *array, int size)
430 @{
431   void store (int index, int value)
432     @{ array[index] = value; @}
433
434   intermediate (store, size);
435 @}
436 @end smallexample
437
438 Here, the function @code{intermediate} receives the address of
439 @code{store} as an argument.  If @code{intermediate} calls @code{store},
440 the arguments given to @code{store} are used to store into @code{array}.
441 But this technique works only so long as the containing function
442 (@code{hack}, in this example) does not exit.
443
444 If you try to call the nested function through its address after the
445 containing function has exited, all hell will break loose.  If you try
446 to call it after a containing scope level has exited, and if it refers
447 to some of the variables that are no longer in scope, you may be lucky,
448 but it's not wise to take the risk.  If, however, the nested function
449 does not refer to anything that has gone out of scope, you should be
450 safe.
451
452 GCC implements taking the address of a nested function using a technique
453 called @dfn{trampolines}.  A paper describing them is available as
454
455 @noindent
456 @uref{http://people.debian.org/~aaronl/Usenix88-lexic.pdf}.
457
458 A nested function can jump to a label inherited from a containing
459 function, provided the label was explicitly declared in the containing
460 function (@pxref{Local Labels}).  Such a jump returns instantly to the
461 containing function, exiting the nested function which did the
462 @code{goto} and any intermediate functions as well.  Here is an example:
463
464 @smallexample
465 @group
466 bar (int *array, int offset, int size)
467 @{
468   __label__ failure;
469   int access (int *array, int index)
470     @{
471       if (index > size)
472         goto failure;
473       return array[index + offset];
474     @}
475   int i;
476   /* @r{@dots{}} */
477   for (i = 0; i < size; i++)
478     /* @r{@dots{}} */ access (array, i) /* @r{@dots{}} */
479   /* @r{@dots{}} */
480   return 0;
481
482  /* @r{Control comes here from @code{access}
483     if it detects an error.}  */
484  failure:
485   return -1;
486 @}
487 @end group
488 @end smallexample
489
490 A nested function always has no linkage.  Declaring one with
491 @code{extern} or @code{static} is erroneous.  If you need to declare the nested function
492 before its definition, use @code{auto} (which is otherwise meaningless
493 for function declarations).
494
495 @smallexample
496 bar (int *array, int offset, int size)
497 @{
498   __label__ failure;
499   auto int access (int *, int);
500   /* @r{@dots{}} */
501   int access (int *array, int index)
502     @{
503       if (index > size)
504         goto failure;
505       return array[index + offset];
506     @}
507   /* @r{@dots{}} */
508 @}
509 @end smallexample
510
511 @node Constructing Calls
512 @section Constructing Function Calls
513 @cindex constructing calls
514 @cindex forwarding calls
515
516 Using the built-in functions described below, you can record
517 the arguments a function received, and call another function
518 with the same arguments, without knowing the number or types
519 of the arguments.
520
521 You can also record the return value of that function call,
522 and later return that value, without knowing what data type
523 the function tried to return (as long as your caller expects
524 that data type).
525
526 However, these built-in functions may interact badly with some
527 sophisticated features or other extensions of the language.  It
528 is, therefore, not recommended to use them outside very simple
529 functions acting as mere forwarders for their arguments.
530
531 @deftypefn {Built-in Function} {void *} __builtin_apply_args ()
532 This built-in function returns a pointer to data
533 describing how to perform a call with the same arguments as were passed
534 to the current function.
535
536 The function saves the arg pointer register, structure value address,
537 and all registers that might be used to pass arguments to a function
538 into a block of memory allocated on the stack.  Then it returns the
539 address of that block.
540 @end deftypefn
541
542 @deftypefn {Built-in Function} {void *} __builtin_apply (void (*@var{function})(), void *@var{arguments}, size_t @var{size})
543 This built-in function invokes @var{function}
544 with a copy of the parameters described by @var{arguments}
545 and @var{size}.
546
547 The value of @var{arguments} should be the value returned by
548 @code{__builtin_apply_args}.  The argument @var{size} specifies the size
549 of the stack argument data, in bytes.
550
551 This function returns a pointer to data describing
552 how to return whatever value was returned by @var{function}.  The data
553 is saved in a block of memory allocated on the stack.
554
555 It is not always simple to compute the proper value for @var{size}.  The
556 value is used by @code{__builtin_apply} to compute the amount of data
557 that should be pushed on the stack and copied from the incoming argument
558 area.
559 @end deftypefn
560
561 @deftypefn {Built-in Function} {void} __builtin_return (void *@var{result})
562 This built-in function returns the value described by @var{result} from
563 the containing function.  You should specify, for @var{result}, a value
564 returned by @code{__builtin_apply}.
565 @end deftypefn
566
567 @deftypefn {Built-in Function} __builtin_va_arg_pack ()
568 This built-in function represents all anonymous arguments of an inline
569 function.  It can be used only in inline functions which will be always
570 inlined, never compiled as a separate function, such as those using
571 @code{__attribute__ ((__always_inline__))} or
572 @code{__attribute__ ((__gnu_inline__))} extern inline functions.
573 It must be only passed as last argument to some other function
574 with variable arguments.  This is useful for writing small wrapper
575 inlines for variable argument functions, when using preprocessor
576 macros is undesirable.  For example:
577 @smallexample
578 extern int myprintf (FILE *f, const char *format, ...);
579 extern inline __attribute__ ((__gnu_inline__)) int
580 myprintf (FILE *f, const char *format, ...)
581 @{
582   int r = fprintf (f, "myprintf: ");
583   if (r < 0)
584     return r;
585   int s = fprintf (f, format, __builtin_va_arg_pack ());
586   if (s < 0)
587     return s;
588   return r + s;
589 @}
590 @end smallexample
591 @end deftypefn
592
593 @deftypefn {Built-in Function} __builtin_va_arg_pack_len ()
594 This built-in function returns the number of anonymous arguments of
595 an inline function.  It can be used only in inline functions which
596 will be always inlined, never compiled as a separate function, such
597 as those using @code{__attribute__ ((__always_inline__))} or
598 @code{__attribute__ ((__gnu_inline__))} extern inline functions.
599 For example following will do link or runtime checking of open
600 arguments for optimized code:
601 @smallexample
602 #ifdef __OPTIMIZE__
603 extern inline __attribute__((__gnu_inline__)) int
604 myopen (const char *path, int oflag, ...)
605 @{
606   if (__builtin_va_arg_pack_len () > 1)
607     warn_open_too_many_arguments ();
608
609   if (__builtin_constant_p (oflag))
610     @{
611       if ((oflag & O_CREAT) != 0 && __builtin_va_arg_pack_len () < 1)
612         @{
613           warn_open_missing_mode ();
614           return __open_2 (path, oflag);
615         @}
616       return open (path, oflag, __builtin_va_arg_pack ());
617     @}
618     
619   if (__builtin_va_arg_pack_len () < 1)
620     return __open_2 (path, oflag);
621
622   return open (path, oflag, __builtin_va_arg_pack ());
623 @}
624 #endif
625 @end smallexample
626 @end deftypefn
627
628 @node Typeof
629 @section Referring to a Type with @code{typeof}
630 @findex typeof
631 @findex sizeof
632 @cindex macros, types of arguments
633
634 Another way to refer to the type of an expression is with @code{typeof}.
635 The syntax of using of this keyword looks like @code{sizeof}, but the
636 construct acts semantically like a type name defined with @code{typedef}.
637
638 There are two ways of writing the argument to @code{typeof}: with an
639 expression or with a type.  Here is an example with an expression:
640
641 @smallexample
642 typeof (x[0](1))
643 @end smallexample
644
645 @noindent
646 This assumes that @code{x} is an array of pointers to functions;
647 the type described is that of the values of the functions.
648
649 Here is an example with a typename as the argument:
650
651 @smallexample
652 typeof (int *)
653 @end smallexample
654
655 @noindent
656 Here the type described is that of pointers to @code{int}.
657
658 If you are writing a header file that must work when included in ISO C
659 programs, write @code{__typeof__} instead of @code{typeof}.
660 @xref{Alternate Keywords}.
661
662 A @code{typeof}-construct can be used anywhere a typedef name could be
663 used.  For example, you can use it in a declaration, in a cast, or inside
664 of @code{sizeof} or @code{typeof}.
665
666 The operand of @code{typeof} is evaluated for its side effects if and
667 only if it is an expression of variably modified type or the name of
668 such a type.
669
670 @code{typeof} is often useful in conjunction with the
671 statements-within-expressions feature.  Here is how the two together can
672 be used to define a safe ``maximum'' macro that operates on any
673 arithmetic type and evaluates each of its arguments exactly once:
674
675 @smallexample
676 #define max(a,b) \
677   (@{ typeof (a) _a = (a); \
678       typeof (b) _b = (b); \
679     _a > _b ? _a : _b; @})
680 @end smallexample
681
682 @cindex underscores in variables in macros
683 @cindex @samp{_} in variables in macros
684 @cindex local variables in macros
685 @cindex variables, local, in macros
686 @cindex macros, local variables in
687
688 The reason for using names that start with underscores for the local
689 variables is to avoid conflicts with variable names that occur within the
690 expressions that are substituted for @code{a} and @code{b}.  Eventually we
691 hope to design a new form of declaration syntax that allows you to declare
692 variables whose scopes start only after their initializers; this will be a
693 more reliable way to prevent such conflicts.
694
695 @noindent
696 Some more examples of the use of @code{typeof}:
697
698 @itemize @bullet
699 @item
700 This declares @code{y} with the type of what @code{x} points to.
701
702 @smallexample
703 typeof (*x) y;
704 @end smallexample
705
706 @item
707 This declares @code{y} as an array of such values.
708
709 @smallexample
710 typeof (*x) y[4];
711 @end smallexample
712
713 @item
714 This declares @code{y} as an array of pointers to characters:
715
716 @smallexample
717 typeof (typeof (char *)[4]) y;
718 @end smallexample
719
720 @noindent
721 It is equivalent to the following traditional C declaration:
722
723 @smallexample
724 char *y[4];
725 @end smallexample
726
727 To see the meaning of the declaration using @code{typeof}, and why it
728 might be a useful way to write, rewrite it with these macros:
729
730 @smallexample
731 #define pointer(T)  typeof(T *)
732 #define array(T, N) typeof(T [N])
733 @end smallexample
734
735 @noindent
736 Now the declaration can be rewritten this way:
737
738 @smallexample
739 array (pointer (char), 4) y;
740 @end smallexample
741
742 @noindent
743 Thus, @code{array (pointer (char), 4)} is the type of arrays of 4
744 pointers to @code{char}.
745 @end itemize
746
747 @emph{Compatibility Note:} In addition to @code{typeof}, GCC 2 supported
748 a more limited extension which permitted one to write
749
750 @smallexample
751 typedef @var{T} = @var{expr};
752 @end smallexample
753
754 @noindent
755 with the effect of declaring @var{T} to have the type of the expression
756 @var{expr}.  This extension does not work with GCC 3 (versions between
757 3.0 and 3.2 will crash; 3.2.1 and later give an error).  Code which
758 relies on it should be rewritten to use @code{typeof}:
759
760 @smallexample
761 typedef typeof(@var{expr}) @var{T};
762 @end smallexample
763
764 @noindent
765 This will work with all versions of GCC@.
766
767 @node Conditionals
768 @section Conditionals with Omitted Operands
769 @cindex conditional expressions, extensions
770 @cindex omitted middle-operands
771 @cindex middle-operands, omitted
772 @cindex extensions, @code{?:}
773 @cindex @code{?:} extensions
774
775 The middle operand in a conditional expression may be omitted.  Then
776 if the first operand is nonzero, its value is the value of the conditional
777 expression.
778
779 Therefore, the expression
780
781 @smallexample
782 x ? : y
783 @end smallexample
784
785 @noindent
786 has the value of @code{x} if that is nonzero; otherwise, the value of
787 @code{y}.
788
789 This example is perfectly equivalent to
790
791 @smallexample
792 x ? x : y
793 @end smallexample
794
795 @cindex side effect in ?:
796 @cindex ?: side effect
797 @noindent
798 In this simple case, the ability to omit the middle operand is not
799 especially useful.  When it becomes useful is when the first operand does,
800 or may (if it is a macro argument), contain a side effect.  Then repeating
801 the operand in the middle would perform the side effect twice.  Omitting
802 the middle operand uses the value already computed without the undesirable
803 effects of recomputing it.
804
805 @node Long Long
806 @section Double-Word Integers
807 @cindex @code{long long} data types
808 @cindex double-word arithmetic
809 @cindex multiprecision arithmetic
810 @cindex @code{LL} integer suffix
811 @cindex @code{ULL} integer suffix
812
813 ISO C99 supports data types for integers that are at least 64 bits wide,
814 and as an extension GCC supports them in C89 mode and in C++.
815 Simply write @code{long long int} for a signed integer, or
816 @code{unsigned long long int} for an unsigned integer.  To make an
817 integer constant of type @code{long long int}, add the suffix @samp{LL}
818 to the integer.  To make an integer constant of type @code{unsigned long
819 long int}, add the suffix @samp{ULL} to the integer.
820
821 You can use these types in arithmetic like any other integer types.
822 Addition, subtraction, and bitwise boolean operations on these types
823 are open-coded on all types of machines.  Multiplication is open-coded
824 if the machine supports fullword-to-doubleword a widening multiply
825 instruction.  Division and shifts are open-coded only on machines that
826 provide special support.  The operations that are not open-coded use
827 special library routines that come with GCC@.
828
829 There may be pitfalls when you use @code{long long} types for function
830 arguments, unless you declare function prototypes.  If a function
831 expects type @code{int} for its argument, and you pass a value of type
832 @code{long long int}, confusion will result because the caller and the
833 subroutine will disagree about the number of bytes for the argument.
834 Likewise, if the function expects @code{long long int} and you pass
835 @code{int}.  The best way to avoid such problems is to use prototypes.
836
837 @node Complex
838 @section Complex Numbers
839 @cindex complex numbers
840 @cindex @code{_Complex} keyword
841 @cindex @code{__complex__} keyword
842
843 ISO C99 supports complex floating data types, and as an extension GCC
844 supports them in C89 mode and in C++, and supports complex integer data
845 types which are not part of ISO C99.  You can declare complex types
846 using the keyword @code{_Complex}.  As an extension, the older GNU
847 keyword @code{__complex__} is also supported.
848
849 For example, @samp{_Complex double x;} declares @code{x} as a
850 variable whose real part and imaginary part are both of type
851 @code{double}.  @samp{_Complex short int y;} declares @code{y} to
852 have real and imaginary parts of type @code{short int}; this is not
853 likely to be useful, but it shows that the set of complex types is
854 complete.
855
856 To write a constant with a complex data type, use the suffix @samp{i} or
857 @samp{j} (either one; they are equivalent).  For example, @code{2.5fi}
858 has type @code{_Complex float} and @code{3i} has type
859 @code{_Complex int}.  Such a constant always has a pure imaginary
860 value, but you can form any complex value you like by adding one to a
861 real constant.  This is a GNU extension; if you have an ISO C99
862 conforming C library (such as GNU libc), and want to construct complex
863 constants of floating type, you should include @code{<complex.h>} and
864 use the macros @code{I} or @code{_Complex_I} instead.
865
866 @cindex @code{__real__} keyword
867 @cindex @code{__imag__} keyword
868 To extract the real part of a complex-valued expression @var{exp}, write
869 @code{__real__ @var{exp}}.  Likewise, use @code{__imag__} to
870 extract the imaginary part.  This is a GNU extension; for values of
871 floating type, you should use the ISO C99 functions @code{crealf},
872 @code{creal}, @code{creall}, @code{cimagf}, @code{cimag} and
873 @code{cimagl}, declared in @code{<complex.h>} and also provided as
874 built-in functions by GCC@.
875
876 @cindex complex conjugation
877 The operator @samp{~} performs complex conjugation when used on a value
878 with a complex type.  This is a GNU extension; for values of
879 floating type, you should use the ISO C99 functions @code{conjf},
880 @code{conj} and @code{conjl}, declared in @code{<complex.h>} and also
881 provided as built-in functions by GCC@.
882
883 GCC can allocate complex automatic variables in a noncontiguous
884 fashion; it's even possible for the real part to be in a register while
885 the imaginary part is on the stack (or vice-versa).  Only the DWARF2
886 debug info format can represent this, so use of DWARF2 is recommended.
887 If you are using the stabs debug info format, GCC describes a noncontiguous
888 complex variable as if it were two separate variables of noncomplex type.
889 If the variable's actual name is @code{foo}, the two fictitious
890 variables are named @code{foo$real} and @code{foo$imag}.  You can
891 examine and set these two fictitious variables with your debugger.
892
893 @node Floating Types
894 @section Additional Floating Types
895 @cindex additional floating types
896 @cindex @code{__float80} data type
897 @cindex @code{__float128} data type
898 @cindex @code{w} floating point suffix
899 @cindex @code{q} floating point suffix
900 @cindex @code{W} floating point suffix
901 @cindex @code{Q} floating point suffix
902
903 As an extension, the GNU C compiler supports additional floating
904 types, @code{__float80} and @code{__float128} to support 80bit
905 (@code{XFmode}) and 128 bit (@code{TFmode}) floating types.
906 Support for additional types includes the arithmetic operators:
907 add, subtract, multiply, divide; unary arithmetic operators;
908 relational operators; equality operators; and conversions to and from
909 integer and other floating types.  Use a suffix @samp{w} or @samp{W}
910 in a literal constant of type @code{__float80} and @samp{q} or @samp{Q}
911 for @code{_float128}.  You can declare complex types using the
912 corresponding internal complex type, @code{XCmode} for @code{__float80}
913 type and @code{TCmode} for @code{__float128} type:
914
915 @smallexample
916 typedef _Complex float __attribute__((mode(TC))) _Complex128;
917 typedef _Complex float __attribute__((mode(XC))) _Complex80;
918 @end smallexample
919
920 Not all targets support additional floating point types.  @code{__float80}
921 is supported on i386, x86_64 and ia64 targets and target @code{__float128}
922 is supported on x86_64 and ia64 targets.
923
924 @node Decimal Float
925 @section Decimal Floating Types
926 @cindex decimal floating types
927 @cindex @code{_Decimal32} data type
928 @cindex @code{_Decimal64} data type
929 @cindex @code{_Decimal128} data type
930 @cindex @code{df} integer suffix
931 @cindex @code{dd} integer suffix
932 @cindex @code{dl} integer suffix
933 @cindex @code{DF} integer suffix
934 @cindex @code{DD} integer suffix
935 @cindex @code{DL} integer suffix
936
937 As an extension, the GNU C compiler supports decimal floating types as
938 defined in the N1312 draft of ISO/IEC WDTR24732.  Support for decimal
939 floating types in GCC will evolve as the draft technical report changes.
940 Calling conventions for any target might also change.  Not all targets
941 support decimal floating types.
942
943 The decimal floating types are @code{_Decimal32}, @code{_Decimal64}, and
944 @code{_Decimal128}.  They use a radix of ten, unlike the floating types
945 @code{float}, @code{double}, and @code{long double} whose radix is not
946 specified by the C standard but is usually two.
947
948 Support for decimal floating types includes the arithmetic operators
949 add, subtract, multiply, divide; unary arithmetic operators;
950 relational operators; equality operators; and conversions to and from
951 integer and other floating types.  Use a suffix @samp{df} or
952 @samp{DF} in a literal constant of type @code{_Decimal32}, @samp{dd}
953 or @samp{DD} for @code{_Decimal64}, and @samp{dl} or @samp{DL} for
954 @code{_Decimal128}.
955
956 GCC support of decimal float as specified by the draft technical report
957 is incomplete:
958
959 @itemize @bullet
960 @item
961 When the value of a decimal floating type cannot be represented in the
962 integer type to which it is being converted, the result is undefined
963 rather than the result value specified by the draft technical report.
964
965 @item
966 GCC does not provide the C library functionality associated with
967 @file{math.h}, @file{fenv.h}, @file{stdio.h}, @file{stdlib.h}, and
968 @file{wchar.h}, which must come from a separate C library implementation.
969 Because of this the GNU C compiler does not define macro
970 @code{__STDC_DEC_FP__} to indicate that the implementation conforms to
971 the technical report.
972 @end itemize
973
974 Types @code{_Decimal32}, @code{_Decimal64}, and @code{_Decimal128}
975 are supported by the DWARF2 debug information format.
976
977 @node Hex Floats
978 @section Hex Floats
979 @cindex hex floats
980
981 ISO C99 supports floating-point numbers written not only in the usual
982 decimal notation, such as @code{1.55e1}, but also numbers such as
983 @code{0x1.fp3} written in hexadecimal format.  As a GNU extension, GCC
984 supports this in C89 mode (except in some cases when strictly
985 conforming) and in C++.  In that format the
986 @samp{0x} hex introducer and the @samp{p} or @samp{P} exponent field are
987 mandatory.  The exponent is a decimal number that indicates the power of
988 2 by which the significant part will be multiplied.  Thus @samp{0x1.f} is
989 @tex
990 $1 {15\over16}$,
991 @end tex
992 @ifnottex
993 1 15/16,
994 @end ifnottex
995 @samp{p3} multiplies it by 8, and the value of @code{0x1.fp3}
996 is the same as @code{1.55e1}.
997
998 Unlike for floating-point numbers in the decimal notation the exponent
999 is always required in the hexadecimal notation.  Otherwise the compiler
1000 would not be able to resolve the ambiguity of, e.g., @code{0x1.f}.  This
1001 could mean @code{1.0f} or @code{1.9375} since @samp{f} is also the
1002 extension for floating-point constants of type @code{float}.
1003
1004 @node Fixed-Point
1005 @section Fixed-Point Types
1006 @cindex fixed-point types
1007 @cindex @code{_Fract} data type
1008 @cindex @code{_Accum} data type
1009 @cindex @code{_Sat} data type
1010 @cindex @code{hr} fixed-suffix
1011 @cindex @code{r} fixed-suffix
1012 @cindex @code{lr} fixed-suffix
1013 @cindex @code{llr} fixed-suffix
1014 @cindex @code{uhr} fixed-suffix
1015 @cindex @code{ur} fixed-suffix
1016 @cindex @code{ulr} fixed-suffix
1017 @cindex @code{ullr} fixed-suffix
1018 @cindex @code{hk} fixed-suffix
1019 @cindex @code{k} fixed-suffix
1020 @cindex @code{lk} fixed-suffix
1021 @cindex @code{llk} fixed-suffix
1022 @cindex @code{uhk} fixed-suffix
1023 @cindex @code{uk} fixed-suffix
1024 @cindex @code{ulk} fixed-suffix
1025 @cindex @code{ullk} fixed-suffix
1026 @cindex @code{HR} fixed-suffix
1027 @cindex @code{R} fixed-suffix
1028 @cindex @code{LR} fixed-suffix
1029 @cindex @code{LLR} fixed-suffix
1030 @cindex @code{UHR} fixed-suffix
1031 @cindex @code{UR} fixed-suffix
1032 @cindex @code{ULR} fixed-suffix
1033 @cindex @code{ULLR} fixed-suffix
1034 @cindex @code{HK} fixed-suffix
1035 @cindex @code{K} fixed-suffix
1036 @cindex @code{LK} fixed-suffix
1037 @cindex @code{LLK} fixed-suffix
1038 @cindex @code{UHK} fixed-suffix
1039 @cindex @code{UK} fixed-suffix
1040 @cindex @code{ULK} fixed-suffix
1041 @cindex @code{ULLK} fixed-suffix
1042
1043 As an extension, the GNU C compiler supports fixed-point types as
1044 defined in the N1169 draft of ISO/IEC DTR 18037.  Support for fixed-point
1045 types in GCC will evolve as the draft technical report changes.
1046 Calling conventions for any target might also change.  Not all targets
1047 support fixed-point types.
1048
1049 The fixed-point types are
1050 @code{short _Fract},
1051 @code{_Fract},
1052 @code{long _Fract},
1053 @code{long long _Fract},
1054 @code{unsigned short _Fract},
1055 @code{unsigned _Fract},
1056 @code{unsigned long _Fract},
1057 @code{unsigned long long _Fract},
1058 @code{_Sat short _Fract},
1059 @code{_Sat _Fract},
1060 @code{_Sat long _Fract},
1061 @code{_Sat long long _Fract},
1062 @code{_Sat unsigned short _Fract},
1063 @code{_Sat unsigned _Fract},
1064 @code{_Sat unsigned long _Fract},
1065 @code{_Sat unsigned long long _Fract},
1066 @code{short _Accum},
1067 @code{_Accum},
1068 @code{long _Accum},
1069 @code{long long _Accum},
1070 @code{unsigned short _Accum},
1071 @code{unsigned _Accum},
1072 @code{unsigned long _Accum},
1073 @code{unsigned long long _Accum},
1074 @code{_Sat short _Accum},
1075 @code{_Sat _Accum},
1076 @code{_Sat long _Accum},
1077 @code{_Sat long long _Accum},
1078 @code{_Sat unsigned short _Accum},
1079 @code{_Sat unsigned _Accum},
1080 @code{_Sat unsigned long _Accum},
1081 @code{_Sat unsigned long long _Accum}.
1082
1083 Fixed-point data values contain fractional and optional integral parts.
1084 The format of fixed-point data varies and depends on the target machine.
1085
1086 Support for fixed-point types includes:
1087 @itemize @bullet
1088 @item
1089 prefix and postfix increment and decrement operators (@code{++}, @code{--})
1090 @item
1091 unary arithmetic operators (@code{+}, @code{-}, @code{!})
1092 @item
1093 binary arithmetic operators (@code{+}, @code{-}, @code{*}, @code{/})
1094 @item
1095 binary shift operators (@code{<<}, @code{>>})
1096 @item
1097 relational operators (@code{<}, @code{<=}, @code{>=}, @code{>})
1098 @item
1099 equality operators (@code{==}, @code{!=})
1100 @item
1101 assignment operators (@code{+=}, @code{-=}, @code{*=}, @code{/=},
1102 @code{<<=}, @code{>>=})
1103 @item
1104 conversions to and from integer, floating-point, or fixed-point types
1105 @end itemize
1106
1107 Use a suffix in a fixed-point literal constant:
1108 @itemize
1109 @item @samp{hr} or @samp{HR} for @code{short _Fract} and
1110 @code{_Sat short _Fract}
1111 @item @samp{r} or @samp{R} for @code{_Fract} and @code{_Sat _Fract}
1112 @item @samp{lr} or @samp{LR} for @code{long _Fract} and
1113 @code{_Sat long _Fract}
1114 @item @samp{llr} or @samp{LLR} for @code{long long _Fract} and
1115 @code{_Sat long long _Fract}
1116 @item @samp{uhr} or @samp{UHR} for @code{unsigned short _Fract} and
1117 @code{_Sat unsigned short _Fract}
1118 @item @samp{ur} or @samp{UR} for @code{unsigned _Fract} and
1119 @code{_Sat unsigned _Fract}
1120 @item @samp{ulr} or @samp{ULR} for @code{unsigned long _Fract} and
1121 @code{_Sat unsigned long _Fract}
1122 @item @samp{ullr} or @samp{ULLR} for @code{unsigned long long _Fract}
1123 and @code{_Sat unsigned long long _Fract}
1124 @item @samp{hk} or @samp{HK} for @code{short _Accum} and
1125 @code{_Sat short _Accum}
1126 @item @samp{k} or @samp{K} for @code{_Accum} and @code{_Sat _Accum}
1127 @item @samp{lk} or @samp{LK} for @code{long _Accum} and
1128 @code{_Sat long _Accum}
1129 @item @samp{llk} or @samp{LLK} for @code{long long _Accum} and
1130 @code{_Sat long long _Accum}
1131 @item @samp{uhk} or @samp{UHK} for @code{unsigned short _Accum} and
1132 @code{_Sat unsigned short _Accum}
1133 @item @samp{uk} or @samp{UK} for @code{unsigned _Accum} and
1134 @code{_Sat unsigned _Accum}
1135 @item @samp{ulk} or @samp{ULK} for @code{unsigned long _Accum} and
1136 @code{_Sat unsigned long _Accum}
1137 @item @samp{ullk} or @samp{ULLK} for @code{unsigned long long _Accum}
1138 and @code{_Sat unsigned long long _Accum}
1139 @end itemize
1140
1141 GCC support of fixed-point types as specified by the draft technical report
1142 is incomplete:
1143
1144 @itemize @bullet
1145 @item
1146 Pragmas to control overflow and rounding behaviors are not implemented.
1147 @end itemize
1148
1149 Fixed-point types are supported by the DWARF2 debug information format.
1150
1151 @node Zero Length
1152 @section Arrays of Length Zero
1153 @cindex arrays of length zero
1154 @cindex zero-length arrays
1155 @cindex length-zero arrays
1156 @cindex flexible array members
1157
1158 Zero-length arrays are allowed in GNU C@.  They are very useful as the
1159 last element of a structure which is really a header for a variable-length
1160 object:
1161
1162 @smallexample
1163 struct line @{
1164   int length;
1165   char contents[0];
1166 @};
1167
1168 struct line *thisline = (struct line *)
1169   malloc (sizeof (struct line) + this_length);
1170 thisline->length = this_length;
1171 @end smallexample
1172
1173 In ISO C90, you would have to give @code{contents} a length of 1, which
1174 means either you waste space or complicate the argument to @code{malloc}.
1175
1176 In ISO C99, you would use a @dfn{flexible array member}, which is
1177 slightly different in syntax and semantics:
1178
1179 @itemize @bullet
1180 @item
1181 Flexible array members are written as @code{contents[]} without
1182 the @code{0}.
1183
1184 @item
1185 Flexible array members have incomplete type, and so the @code{sizeof}
1186 operator may not be applied.  As a quirk of the original implementation
1187 of zero-length arrays, @code{sizeof} evaluates to zero.
1188
1189 @item
1190 Flexible array members may only appear as the last member of a
1191 @code{struct} that is otherwise non-empty.
1192
1193 @item
1194 A structure containing a flexible array member, or a union containing
1195 such a structure (possibly recursively), may not be a member of a
1196 structure or an element of an array.  (However, these uses are
1197 permitted by GCC as extensions.)
1198 @end itemize
1199
1200 GCC versions before 3.0 allowed zero-length arrays to be statically
1201 initialized, as if they were flexible arrays.  In addition to those
1202 cases that were useful, it also allowed initializations in situations
1203 that would corrupt later data.  Non-empty initialization of zero-length
1204 arrays is now treated like any case where there are more initializer
1205 elements than the array holds, in that a suitable warning about "excess
1206 elements in array" is given, and the excess elements (all of them, in
1207 this case) are ignored.
1208
1209 Instead GCC allows static initialization of flexible array members.
1210 This is equivalent to defining a new structure containing the original
1211 structure followed by an array of sufficient size to contain the data.
1212 I.e.@: in the following, @code{f1} is constructed as if it were declared
1213 like @code{f2}.
1214
1215 @smallexample
1216 struct f1 @{
1217   int x; int y[];
1218 @} f1 = @{ 1, @{ 2, 3, 4 @} @};
1219
1220 struct f2 @{
1221   struct f1 f1; int data[3];
1222 @} f2 = @{ @{ 1 @}, @{ 2, 3, 4 @} @};
1223 @end smallexample
1224
1225 @noindent
1226 The convenience of this extension is that @code{f1} has the desired
1227 type, eliminating the need to consistently refer to @code{f2.f1}.
1228
1229 This has symmetry with normal static arrays, in that an array of
1230 unknown size is also written with @code{[]}.
1231
1232 Of course, this extension only makes sense if the extra data comes at
1233 the end of a top-level object, as otherwise we would be overwriting
1234 data at subsequent offsets.  To avoid undue complication and confusion
1235 with initialization of deeply nested arrays, we simply disallow any
1236 non-empty initialization except when the structure is the top-level
1237 object.  For example:
1238
1239 @smallexample
1240 struct foo @{ int x; int y[]; @};
1241 struct bar @{ struct foo z; @};
1242
1243 struct foo a = @{ 1, @{ 2, 3, 4 @} @};        // @r{Valid.}
1244 struct bar b = @{ @{ 1, @{ 2, 3, 4 @} @} @};    // @r{Invalid.}
1245 struct bar c = @{ @{ 1, @{ @} @} @};            // @r{Valid.}
1246 struct foo d[1] = @{ @{ 1 @{ 2, 3, 4 @} @} @};  // @r{Invalid.}
1247 @end smallexample
1248
1249 @node Empty Structures
1250 @section Structures With No Members
1251 @cindex empty structures
1252 @cindex zero-size structures
1253
1254 GCC permits a C structure to have no members:
1255
1256 @smallexample
1257 struct empty @{
1258 @};
1259 @end smallexample
1260
1261 The structure will have size zero.  In C++, empty structures are part
1262 of the language.  G++ treats empty structures as if they had a single
1263 member of type @code{char}.
1264
1265 @node Variable Length
1266 @section Arrays of Variable Length
1267 @cindex variable-length arrays
1268 @cindex arrays of variable length
1269 @cindex VLAs
1270
1271 Variable-length automatic arrays are allowed in ISO C99, and as an
1272 extension GCC accepts them in C89 mode and in C++.  (However, GCC's
1273 implementation of variable-length arrays does not yet conform in detail
1274 to the ISO C99 standard.)  These arrays are
1275 declared like any other automatic arrays, but with a length that is not
1276 a constant expression.  The storage is allocated at the point of
1277 declaration and deallocated when the brace-level is exited.  For
1278 example:
1279
1280 @smallexample
1281 FILE *
1282 concat_fopen (char *s1, char *s2, char *mode)
1283 @{
1284   char str[strlen (s1) + strlen (s2) + 1];
1285   strcpy (str, s1);
1286   strcat (str, s2);
1287   return fopen (str, mode);
1288 @}
1289 @end smallexample
1290
1291 @cindex scope of a variable length array
1292 @cindex variable-length array scope
1293 @cindex deallocating variable length arrays
1294 Jumping or breaking out of the scope of the array name deallocates the
1295 storage.  Jumping into the scope is not allowed; you get an error
1296 message for it.
1297
1298 @cindex @code{alloca} vs variable-length arrays
1299 You can use the function @code{alloca} to get an effect much like
1300 variable-length arrays.  The function @code{alloca} is available in
1301 many other C implementations (but not in all).  On the other hand,
1302 variable-length arrays are more elegant.
1303
1304 There are other differences between these two methods.  Space allocated
1305 with @code{alloca} exists until the containing @emph{function} returns.
1306 The space for a variable-length array is deallocated as soon as the array
1307 name's scope ends.  (If you use both variable-length arrays and
1308 @code{alloca} in the same function, deallocation of a variable-length array
1309 will also deallocate anything more recently allocated with @code{alloca}.)
1310
1311 You can also use variable-length arrays as arguments to functions:
1312
1313 @smallexample
1314 struct entry
1315 tester (int len, char data[len][len])
1316 @{
1317   /* @r{@dots{}} */
1318 @}
1319 @end smallexample
1320
1321 The length of an array is computed once when the storage is allocated
1322 and is remembered for the scope of the array in case you access it with
1323 @code{sizeof}.
1324
1325 If you want to pass the array first and the length afterward, you can
1326 use a forward declaration in the parameter list---another GNU extension.
1327
1328 @smallexample
1329 struct entry
1330 tester (int len; char data[len][len], int len)
1331 @{
1332   /* @r{@dots{}} */
1333 @}
1334 @end smallexample
1335
1336 @cindex parameter forward declaration
1337 The @samp{int len} before the semicolon is a @dfn{parameter forward
1338 declaration}, and it serves the purpose of making the name @code{len}
1339 known when the declaration of @code{data} is parsed.
1340
1341 You can write any number of such parameter forward declarations in the
1342 parameter list.  They can be separated by commas or semicolons, but the
1343 last one must end with a semicolon, which is followed by the ``real''
1344 parameter declarations.  Each forward declaration must match a ``real''
1345 declaration in parameter name and data type.  ISO C99 does not support
1346 parameter forward declarations.
1347
1348 @node Variadic Macros
1349 @section Macros with a Variable Number of Arguments.
1350 @cindex variable number of arguments
1351 @cindex macro with variable arguments
1352 @cindex rest argument (in macro)
1353 @cindex variadic macros
1354
1355 In the ISO C standard of 1999, a macro can be declared to accept a
1356 variable number of arguments much as a function can.  The syntax for
1357 defining the macro is similar to that of a function.  Here is an
1358 example:
1359
1360 @smallexample
1361 #define debug(format, ...) fprintf (stderr, format, __VA_ARGS__)
1362 @end smallexample
1363
1364 Here @samp{@dots{}} is a @dfn{variable argument}.  In the invocation of
1365 such a macro, it represents the zero or more tokens until the closing
1366 parenthesis that ends the invocation, including any commas.  This set of
1367 tokens replaces the identifier @code{__VA_ARGS__} in the macro body
1368 wherever it appears.  See the CPP manual for more information.
1369
1370 GCC has long supported variadic macros, and used a different syntax that
1371 allowed you to give a name to the variable arguments just like any other
1372 argument.  Here is an example:
1373
1374 @smallexample
1375 #define debug(format, args...) fprintf (stderr, format, args)
1376 @end smallexample
1377
1378 This is in all ways equivalent to the ISO C example above, but arguably
1379 more readable and descriptive.
1380
1381 GNU CPP has two further variadic macro extensions, and permits them to
1382 be used with either of the above forms of macro definition.
1383
1384 In standard C, you are not allowed to leave the variable argument out
1385 entirely; but you are allowed to pass an empty argument.  For example,
1386 this invocation is invalid in ISO C, because there is no comma after
1387 the string:
1388
1389 @smallexample
1390 debug ("A message")
1391 @end smallexample
1392
1393 GNU CPP permits you to completely omit the variable arguments in this
1394 way.  In the above examples, the compiler would complain, though since
1395 the expansion of the macro still has the extra comma after the format
1396 string.
1397
1398 To help solve this problem, CPP behaves specially for variable arguments
1399 used with the token paste operator, @samp{##}.  If instead you write
1400
1401 @smallexample
1402 #define debug(format, ...) fprintf (stderr, format, ## __VA_ARGS__)
1403 @end smallexample
1404
1405 and if the variable arguments are omitted or empty, the @samp{##}
1406 operator causes the preprocessor to remove the comma before it.  If you
1407 do provide some variable arguments in your macro invocation, GNU CPP
1408 does not complain about the paste operation and instead places the
1409 variable arguments after the comma.  Just like any other pasted macro
1410 argument, these arguments are not macro expanded.
1411
1412 @node Escaped Newlines
1413 @section Slightly Looser Rules for Escaped Newlines
1414 @cindex escaped newlines
1415 @cindex newlines (escaped)
1416
1417 Recently, the preprocessor has relaxed its treatment of escaped
1418 newlines.  Previously, the newline had to immediately follow a
1419 backslash.  The current implementation allows whitespace in the form
1420 of spaces, horizontal and vertical tabs, and form feeds between the
1421 backslash and the subsequent newline.  The preprocessor issues a
1422 warning, but treats it as a valid escaped newline and combines the two
1423 lines to form a single logical line.  This works within comments and
1424 tokens, as well as between tokens.  Comments are @emph{not} treated as
1425 whitespace for the purposes of this relaxation, since they have not
1426 yet been replaced with spaces.
1427
1428 @node Subscripting
1429 @section Non-Lvalue Arrays May Have Subscripts
1430 @cindex subscripting
1431 @cindex arrays, non-lvalue
1432
1433 @cindex subscripting and function values
1434 In ISO C99, arrays that are not lvalues still decay to pointers, and
1435 may be subscripted, although they may not be modified or used after
1436 the next sequence point and the unary @samp{&} operator may not be
1437 applied to them.  As an extension, GCC allows such arrays to be
1438 subscripted in C89 mode, though otherwise they do not decay to
1439 pointers outside C99 mode.  For example,
1440 this is valid in GNU C though not valid in C89:
1441
1442 @smallexample
1443 @group
1444 struct foo @{int a[4];@};
1445
1446 struct foo f();
1447
1448 bar (int index)
1449 @{
1450   return f().a[index];
1451 @}
1452 @end group
1453 @end smallexample
1454
1455 @node Pointer Arith
1456 @section Arithmetic on @code{void}- and Function-Pointers
1457 @cindex void pointers, arithmetic
1458 @cindex void, size of pointer to
1459 @cindex function pointers, arithmetic
1460 @cindex function, size of pointer to
1461
1462 In GNU C, addition and subtraction operations are supported on pointers to
1463 @code{void} and on pointers to functions.  This is done by treating the
1464 size of a @code{void} or of a function as 1.
1465
1466 A consequence of this is that @code{sizeof} is also allowed on @code{void}
1467 and on function types, and returns 1.
1468
1469 @opindex Wpointer-arith
1470 The option @option{-Wpointer-arith} requests a warning if these extensions
1471 are used.
1472
1473 @node Initializers
1474 @section Non-Constant Initializers
1475 @cindex initializers, non-constant
1476 @cindex non-constant initializers
1477
1478 As in standard C++ and ISO C99, the elements of an aggregate initializer for an
1479 automatic variable are not required to be constant expressions in GNU C@.
1480 Here is an example of an initializer with run-time varying elements:
1481
1482 @smallexample
1483 foo (float f, float g)
1484 @{
1485   float beat_freqs[2] = @{ f-g, f+g @};
1486   /* @r{@dots{}} */
1487 @}
1488 @end smallexample
1489
1490 @node Compound Literals
1491 @section Compound Literals
1492 @cindex constructor expressions
1493 @cindex initializations in expressions
1494 @cindex structures, constructor expression
1495 @cindex expressions, constructor
1496 @cindex compound literals
1497 @c The GNU C name for what C99 calls compound literals was "constructor expressions".
1498
1499 ISO C99 supports compound literals.  A compound literal looks like
1500 a cast containing an initializer.  Its value is an object of the
1501 type specified in the cast, containing the elements specified in
1502 the initializer; it is an lvalue.  As an extension, GCC supports
1503 compound literals in C89 mode and in C++.
1504
1505 Usually, the specified type is a structure.  Assume that
1506 @code{struct foo} and @code{structure} are declared as shown:
1507
1508 @smallexample
1509 struct foo @{int a; char b[2];@} structure;
1510 @end smallexample
1511
1512 @noindent
1513 Here is an example of constructing a @code{struct foo} with a compound literal:
1514
1515 @smallexample
1516 structure = ((struct foo) @{x + y, 'a', 0@});
1517 @end smallexample
1518
1519 @noindent
1520 This is equivalent to writing the following:
1521
1522 @smallexample
1523 @{
1524   struct foo temp = @{x + y, 'a', 0@};
1525   structure = temp;
1526 @}
1527 @end smallexample
1528
1529 You can also construct an array.  If all the elements of the compound literal
1530 are (made up of) simple constant expressions, suitable for use in
1531 initializers of objects of static storage duration, then the compound
1532 literal can be coerced to a pointer to its first element and used in
1533 such an initializer, as shown here:
1534
1535 @smallexample
1536 char **foo = (char *[]) @{ "x", "y", "z" @};
1537 @end smallexample
1538
1539 Compound literals for scalar types and union types are is
1540 also allowed, but then the compound literal is equivalent
1541 to a cast.
1542
1543 As a GNU extension, GCC allows initialization of objects with static storage
1544 duration by compound literals (which is not possible in ISO C99, because
1545 the initializer is not a constant).
1546 It is handled as if the object was initialized only with the bracket
1547 enclosed list if the types of the compound literal and the object match.
1548 The initializer list of the compound literal must be constant.
1549 If the object being initialized has array type of unknown size, the size is
1550 determined by compound literal size.
1551
1552 @smallexample
1553 static struct foo x = (struct foo) @{1, 'a', 'b'@};
1554 static int y[] = (int []) @{1, 2, 3@};
1555 static int z[] = (int [3]) @{1@};
1556 @end smallexample
1557
1558 @noindent
1559 The above lines are equivalent to the following:
1560 @smallexample
1561 static struct foo x = @{1, 'a', 'b'@};
1562 static int y[] = @{1, 2, 3@};
1563 static int z[] = @{1, 0, 0@};
1564 @end smallexample
1565
1566 @node Designated Inits
1567 @section Designated Initializers
1568 @cindex initializers with labeled elements
1569 @cindex labeled elements in initializers
1570 @cindex case labels in initializers
1571 @cindex designated initializers
1572
1573 Standard C89 requires the elements of an initializer to appear in a fixed
1574 order, the same as the order of the elements in the array or structure
1575 being initialized.
1576
1577 In ISO C99 you can give the elements in any order, specifying the array
1578 indices or structure field names they apply to, and GNU C allows this as
1579 an extension in C89 mode as well.  This extension is not
1580 implemented in GNU C++.
1581
1582 To specify an array index, write
1583 @samp{[@var{index}] =} before the element value.  For example,
1584
1585 @smallexample
1586 int a[6] = @{ [4] = 29, [2] = 15 @};
1587 @end smallexample
1588
1589 @noindent
1590 is equivalent to
1591
1592 @smallexample
1593 int a[6] = @{ 0, 0, 15, 0, 29, 0 @};
1594 @end smallexample
1595
1596 @noindent
1597 The index values must be constant expressions, even if the array being
1598 initialized is automatic.
1599
1600 An alternative syntax for this which has been obsolete since GCC 2.5 but
1601 GCC still accepts is to write @samp{[@var{index}]} before the element
1602 value, with no @samp{=}.
1603
1604 To initialize a range of elements to the same value, write
1605 @samp{[@var{first} ... @var{last}] = @var{value}}.  This is a GNU
1606 extension.  For example,
1607
1608 @smallexample
1609 int widths[] = @{ [0 ... 9] = 1, [10 ... 99] = 2, [100] = 3 @};
1610 @end smallexample
1611
1612 @noindent
1613 If the value in it has side-effects, the side-effects will happen only once,
1614 not for each initialized field by the range initializer.
1615
1616 @noindent
1617 Note that the length of the array is the highest value specified
1618 plus one.
1619
1620 In a structure initializer, specify the name of a field to initialize
1621 with @samp{.@var{fieldname} =} before the element value.  For example,
1622 given the following structure,
1623
1624 @smallexample
1625 struct point @{ int x, y; @};
1626 @end smallexample
1627
1628 @noindent
1629 the following initialization
1630
1631 @smallexample
1632 struct point p = @{ .y = yvalue, .x = xvalue @};
1633 @end smallexample
1634
1635 @noindent
1636 is equivalent to
1637
1638 @smallexample
1639 struct point p = @{ xvalue, yvalue @};
1640 @end smallexample
1641
1642 Another syntax which has the same meaning, obsolete since GCC 2.5, is
1643 @samp{@var{fieldname}:}, as shown here:
1644
1645 @smallexample
1646 struct point p = @{ y: yvalue, x: xvalue @};
1647 @end smallexample
1648
1649 @cindex designators
1650 The @samp{[@var{index}]} or @samp{.@var{fieldname}} is known as a
1651 @dfn{designator}.  You can also use a designator (or the obsolete colon
1652 syntax) when initializing a union, to specify which element of the union
1653 should be used.  For example,
1654
1655 @smallexample
1656 union foo @{ int i; double d; @};
1657
1658 union foo f = @{ .d = 4 @};
1659 @end smallexample
1660
1661 @noindent
1662 will convert 4 to a @code{double} to store it in the union using
1663 the second element.  By contrast, casting 4 to type @code{union foo}
1664 would store it into the union as the integer @code{i}, since it is
1665 an integer.  (@xref{Cast to Union}.)
1666
1667 You can combine this technique of naming elements with ordinary C
1668 initialization of successive elements.  Each initializer element that
1669 does not have a designator applies to the next consecutive element of the
1670 array or structure.  For example,
1671
1672 @smallexample
1673 int a[6] = @{ [1] = v1, v2, [4] = v4 @};
1674 @end smallexample
1675
1676 @noindent
1677 is equivalent to
1678
1679 @smallexample
1680 int a[6] = @{ 0, v1, v2, 0, v4, 0 @};
1681 @end smallexample
1682
1683 Labeling the elements of an array initializer is especially useful
1684 when the indices are characters or belong to an @code{enum} type.
1685 For example:
1686
1687 @smallexample
1688 int whitespace[256]
1689   = @{ [' '] = 1, ['\t'] = 1, ['\h'] = 1,
1690       ['\f'] = 1, ['\n'] = 1, ['\r'] = 1 @};
1691 @end smallexample
1692
1693 @cindex designator lists
1694 You can also write a series of @samp{.@var{fieldname}} and
1695 @samp{[@var{index}]} designators before an @samp{=} to specify a
1696 nested subobject to initialize; the list is taken relative to the
1697 subobject corresponding to the closest surrounding brace pair.  For
1698 example, with the @samp{struct point} declaration above:
1699
1700 @smallexample
1701 struct point ptarray[10] = @{ [2].y = yv2, [2].x = xv2, [0].x = xv0 @};
1702 @end smallexample
1703
1704 @noindent
1705 If the same field is initialized multiple times, it will have value from
1706 the last initialization.  If any such overridden initialization has
1707 side-effect, it is unspecified whether the side-effect happens or not.
1708 Currently, GCC will discard them and issue a warning.
1709
1710 @node Case Ranges
1711 @section Case Ranges
1712 @cindex case ranges
1713 @cindex ranges in case statements
1714
1715 You can specify a range of consecutive values in a single @code{case} label,
1716 like this:
1717
1718 @smallexample
1719 case @var{low} ... @var{high}:
1720 @end smallexample
1721
1722 @noindent
1723 This has the same effect as the proper number of individual @code{case}
1724 labels, one for each integer value from @var{low} to @var{high}, inclusive.
1725
1726 This feature is especially useful for ranges of ASCII character codes:
1727
1728 @smallexample
1729 case 'A' ... 'Z':
1730 @end smallexample
1731
1732 @strong{Be careful:} Write spaces around the @code{...}, for otherwise
1733 it may be parsed wrong when you use it with integer values.  For example,
1734 write this:
1735
1736 @smallexample
1737 case 1 ... 5:
1738 @end smallexample
1739
1740 @noindent
1741 rather than this:
1742
1743 @smallexample
1744 case 1...5:
1745 @end smallexample
1746
1747 @node Cast to Union
1748 @section Cast to a Union Type
1749 @cindex cast to a union
1750 @cindex union, casting to a
1751
1752 A cast to union type is similar to other casts, except that the type
1753 specified is a union type.  You can specify the type either with
1754 @code{union @var{tag}} or with a typedef name.  A cast to union is actually
1755 a constructor though, not a cast, and hence does not yield an lvalue like
1756 normal casts.  (@xref{Compound Literals}.)
1757
1758 The types that may be cast to the union type are those of the members
1759 of the union.  Thus, given the following union and variables:
1760
1761 @smallexample
1762 union foo @{ int i; double d; @};
1763 int x;
1764 double y;
1765 @end smallexample
1766
1767 @noindent
1768 both @code{x} and @code{y} can be cast to type @code{union foo}.
1769
1770 Using the cast as the right-hand side of an assignment to a variable of
1771 union type is equivalent to storing in a member of the union:
1772
1773 @smallexample
1774 union foo u;
1775 /* @r{@dots{}} */
1776 u = (union foo) x  @equiv{}  u.i = x
1777 u = (union foo) y  @equiv{}  u.d = y
1778 @end smallexample
1779
1780 You can also use the union cast as a function argument:
1781
1782 @smallexample
1783 void hack (union foo);
1784 /* @r{@dots{}} */
1785 hack ((union foo) x);
1786 @end smallexample
1787
1788 @node Mixed Declarations
1789 @section Mixed Declarations and Code
1790 @cindex mixed declarations and code
1791 @cindex declarations, mixed with code
1792 @cindex code, mixed with declarations
1793
1794 ISO C99 and ISO C++ allow declarations and code to be freely mixed
1795 within compound statements.  As an extension, GCC also allows this in
1796 C89 mode.  For example, you could do:
1797
1798 @smallexample
1799 int i;
1800 /* @r{@dots{}} */
1801 i++;
1802 int j = i + 2;
1803 @end smallexample
1804
1805 Each identifier is visible from where it is declared until the end of
1806 the enclosing block.
1807
1808 @node Function Attributes
1809 @section Declaring Attributes of Functions
1810 @cindex function attributes
1811 @cindex declaring attributes of functions
1812 @cindex functions that never return
1813 @cindex functions that return more than once
1814 @cindex functions that have no side effects
1815 @cindex functions in arbitrary sections
1816 @cindex functions that behave like malloc
1817 @cindex @code{volatile} applied to function
1818 @cindex @code{const} applied to function
1819 @cindex functions with @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style arguments
1820 @cindex functions with non-null pointer arguments
1821 @cindex functions that are passed arguments in registers on the 386
1822 @cindex functions that pop the argument stack on the 386
1823 @cindex functions that do not pop the argument stack on the 386
1824 @cindex functions that have different compilation options on the 386
1825 @cindex functions that have different optimization options
1826
1827 In GNU C, you declare certain things about functions called in your program
1828 which help the compiler optimize function calls and check your code more
1829 carefully.
1830
1831 The keyword @code{__attribute__} allows you to specify special
1832 attributes when making a declaration.  This keyword is followed by an
1833 attribute specification inside double parentheses.  The following
1834 attributes are currently defined for functions on all targets:
1835 @code{aligned}, @code{alloc_size}, @code{noreturn},
1836 @code{returns_twice}, @code{noinline}, @code{always_inline},
1837 @code{flatten}, @code{pure}, @code{const}, @code{nothrow},
1838 @code{sentinel}, @code{format}, @code{format_arg},
1839 @code{no_instrument_function}, @code{section}, @code{constructor},
1840 @code{destructor}, @code{used}, @code{unused}, @code{deprecated},
1841 @code{weak}, @code{malloc}, @code{alias}, @code{warn_unused_result},
1842 @code{nonnull}, @code{gnu_inline}, @code{externally_visible},
1843 @code{hot}, @code{cold}, @code{artificial}, @code{error}
1844 and @code{warning}.
1845 Several other attributes are defined for functions on particular
1846 target systems.  Other attributes, including @code{section} are
1847 supported for variables declarations (@pxref{Variable Attributes}) and
1848 for types (@pxref{Type Attributes}).
1849
1850 You may also specify attributes with @samp{__} preceding and following
1851 each keyword.  This allows you to use them in header files without
1852 being concerned about a possible macro of the same name.  For example,
1853 you may use @code{__noreturn__} instead of @code{noreturn}.
1854
1855 @xref{Attribute Syntax}, for details of the exact syntax for using
1856 attributes.
1857
1858 @table @code
1859 @c Keep this table alphabetized by attribute name.  Treat _ as space.
1860
1861 @item alias ("@var{target}")
1862 @cindex @code{alias} attribute
1863 The @code{alias} attribute causes the declaration to be emitted as an
1864 alias for another symbol, which must be specified.  For instance,
1865
1866 @smallexample
1867 void __f () @{ /* @r{Do something.} */; @}
1868 void f () __attribute__ ((weak, alias ("__f")));
1869 @end smallexample
1870
1871 defines @samp{f} to be a weak alias for @samp{__f}.  In C++, the
1872 mangled name for the target must be used.  It is an error if @samp{__f}
1873 is not defined in the same translation unit.
1874
1875 Not all target machines support this attribute.
1876
1877 @item aligned (@var{alignment})
1878 @cindex @code{aligned} attribute
1879 This attribute specifies a minimum alignment for the function,
1880 measured in bytes.
1881
1882 You cannot use this attribute to decrease the alignment of a function,
1883 only to increase it.  However, when you explicitly specify a function
1884 alignment this will override the effect of the
1885 @option{-falign-functions} (@pxref{Optimize Options}) option for this
1886 function.
1887
1888 Note that the effectiveness of @code{aligned} attributes may be
1889 limited by inherent limitations in your linker.  On many systems, the
1890 linker is only able to arrange for functions to be aligned up to a
1891 certain maximum alignment.  (For some linkers, the maximum supported
1892 alignment may be very very small.)  See your linker documentation for
1893 further information.
1894
1895 The @code{aligned} attribute can also be used for variables and fields
1896 (@pxref{Variable Attributes}.)
1897
1898 @item alloc_size
1899 @cindex @code{alloc_size} attribute
1900 The @code{alloc_size} attribute is used to tell the compiler that the
1901 function return value points to memory, where the size is given by
1902 one or two of the functions parameters.  GCC uses this 
1903 information to improve the correctness of @code{__builtin_object_size}.
1904
1905 The function parameter(s) denoting the allocated size are specified by
1906 one or two integer arguments supplied to the attribute.  The allocated size
1907 is either the value of the single function argument specified or the product
1908 of the two function arguments specified.  Argument numbering starts at
1909 one.
1910
1911 For instance, 
1912
1913 @smallexample
1914 void* my_calloc(size_t, size_t) __attribute__((alloc_size(1,2)))
1915 void my_realloc(void*, size_t) __attribute__((alloc_size(2)))
1916 @end smallexample
1917
1918 declares that my_calloc will return memory of the size given by
1919 the product of parameter 1 and 2 and that my_realloc will return memory
1920 of the size given by parameter 2.
1921
1922 @item always_inline
1923 @cindex @code{always_inline} function attribute
1924 Generally, functions are not inlined unless optimization is specified.
1925 For functions declared inline, this attribute inlines the function even
1926 if no optimization level was specified.
1927
1928 @item gnu_inline
1929 @cindex @code{gnu_inline} function attribute
1930 This attribute should be used with a function which is also declared
1931 with the @code{inline} keyword.  It directs GCC to treat the function
1932 as if it were defined in gnu89 mode even when compiling in C99 or
1933 gnu99 mode.
1934
1935 If the function is declared @code{extern}, then this definition of the
1936 function is used only for inlining.  In no case is the function
1937 compiled as a standalone function, not even if you take its address
1938 explicitly.  Such an address becomes an external reference, as if you
1939 had only declared the function, and had not defined it.  This has
1940 almost the effect of a macro.  The way to use this is to put a
1941 function definition in a header file with this attribute, and put
1942 another copy of the function, without @code{extern}, in a library
1943 file.  The definition in the header file will cause most calls to the
1944 function to be inlined.  If any uses of the function remain, they will
1945 refer to the single copy in the library.  Note that the two
1946 definitions of the functions need not be precisely the same, although
1947 if they do not have the same effect your program may behave oddly.
1948
1949 In C, if the function is neither @code{extern} nor @code{static}, then
1950 the function is compiled as a standalone function, as well as being
1951 inlined where possible.
1952
1953 This is how GCC traditionally handled functions declared
1954 @code{inline}.  Since ISO C99 specifies a different semantics for
1955 @code{inline}, this function attribute is provided as a transition
1956 measure and as a useful feature in its own right.  This attribute is
1957 available in GCC 4.1.3 and later.  It is available if either of the
1958 preprocessor macros @code{__GNUC_GNU_INLINE__} or
1959 @code{__GNUC_STDC_INLINE__} are defined.  @xref{Inline,,An Inline
1960 Function is As Fast As a Macro}.
1961
1962 In C++, this attribute does not depend on @code{extern} in any way,
1963 but it still requires the @code{inline} keyword to enable its special
1964 behavior.
1965
1966 @item artificial
1967 @cindex @code{artificial} function attribute
1968 This attribute is useful for small inline wrappers which if possible
1969 should appear during debugging as a unit, depending on the debug
1970 info format it will either mean marking the function as artificial
1971 or using the caller location for all instructions within the inlined
1972 body.
1973
1974 @item flatten
1975 @cindex @code{flatten} function attribute
1976 Generally, inlining into a function is limited.  For a function marked with
1977 this attribute, every call inside this function will be inlined, if possible.
1978 Whether the function itself is considered for inlining depends on its size and
1979 the current inlining parameters.
1980
1981 @item error ("@var{message}")
1982 @cindex @code{error} function attribute
1983 If this attribute is used on a function declaration and a call to such a function
1984 is not eliminated through dead code elimination or other optimizations, an error
1985 which will include @var{message} will be diagnosed.  This is useful
1986 for compile time checking, especially together with @code{__builtin_constant_p}
1987 and inline functions where checking the inline function arguments is not
1988 possible through @code{extern char [(condition) ? 1 : -1];} tricks.
1989 While it is possible to leave the function undefined and thus invoke
1990 a link failure, when using this attribute the problem will be diagnosed
1991 earlier and with exact location of the call even in presence of inline
1992 functions or when not emitting debugging information.
1993
1994 @item warning ("@var{message}")
1995 @cindex @code{warning} function attribute
1996 If this attribute is used on a function declaration and a call to such a function
1997 is not eliminated through dead code elimination or other optimizations, a warning
1998 which will include @var{message} will be diagnosed.  This is useful
1999 for compile time checking, especially together with @code{__builtin_constant_p}
2000 and inline functions.  While it is possible to define the function with
2001 a message in @code{.gnu.warning*} section, when using this attribute the problem
2002 will be diagnosed earlier and with exact location of the call even in presence
2003 of inline functions or when not emitting debugging information.
2004
2005 @item cdecl
2006 @cindex functions that do pop the argument stack on the 386
2007 @opindex mrtd
2008 On the Intel 386, the @code{cdecl} attribute causes the compiler to
2009 assume that the calling function will pop off the stack space used to
2010 pass arguments.  This is
2011 useful to override the effects of the @option{-mrtd} switch.
2012
2013 @item const
2014 @cindex @code{const} function attribute
2015 Many functions do not examine any values except their arguments, and
2016 have no effects except the return value.  Basically this is just slightly
2017 more strict class than the @code{pure} attribute below, since function is not
2018 allowed to read global memory.
2019
2020 @cindex pointer arguments
2021 Note that a function that has pointer arguments and examines the data
2022 pointed to must @emph{not} be declared @code{const}.  Likewise, a
2023 function that calls a non-@code{const} function usually must not be
2024 @code{const}.  It does not make sense for a @code{const} function to
2025 return @code{void}.
2026
2027 The attribute @code{const} is not implemented in GCC versions earlier
2028 than 2.5.  An alternative way to declare that a function has no side
2029 effects, which works in the current version and in some older versions,
2030 is as follows:
2031
2032 @smallexample
2033 typedef int intfn ();
2034
2035 extern const intfn square;
2036 @end smallexample
2037
2038 This approach does not work in GNU C++ from 2.6.0 on, since the language
2039 specifies that the @samp{const} must be attached to the return value.
2040
2041 @item constructor
2042 @itemx destructor
2043 @itemx constructor (@var{priority})
2044 @itemx destructor (@var{priority})
2045 @cindex @code{constructor} function attribute
2046 @cindex @code{destructor} function attribute
2047 The @code{constructor} attribute causes the function to be called
2048 automatically before execution enters @code{main ()}.  Similarly, the
2049 @code{destructor} attribute causes the function to be called
2050 automatically after @code{main ()} has completed or @code{exit ()} has
2051 been called.  Functions with these attributes are useful for
2052 initializing data that will be used implicitly during the execution of
2053 the program.
2054
2055 You may provide an optional integer priority to control the order in
2056 which constructor and destructor functions are run.  A constructor
2057 with a smaller priority number runs before a constructor with a larger
2058 priority number; the opposite relationship holds for destructors.  So,
2059 if you have a constructor that allocates a resource and a destructor
2060 that deallocates the same resource, both functions typically have the
2061 same priority.  The priorities for constructor and destructor
2062 functions are the same as those specified for namespace-scope C++
2063 objects (@pxref{C++ Attributes}).
2064
2065 These attributes are not currently implemented for Objective-C@.
2066
2067 @item deprecated
2068 @itemx deprecated (@var{msg})
2069 @cindex @code{deprecated} attribute.
2070 The @code{deprecated} attribute results in a warning if the function
2071 is used anywhere in the source file.  This is useful when identifying
2072 functions that are expected to be removed in a future version of a
2073 program.  The warning also includes the location of the declaration
2074 of the deprecated function, to enable users to easily find further
2075 information about why the function is deprecated, or what they should
2076 do instead.  Note that the warnings only occurs for uses:
2077
2078 @smallexample
2079 int old_fn () __attribute__ ((deprecated));
2080 int old_fn ();
2081 int (*fn_ptr)() = old_fn;
2082 @end smallexample
2083
2084 results in a warning on line 3 but not line 2.  The optional msg
2085 argument, which must be a string, will be printed in the warning if
2086 present.
2087
2088 The @code{deprecated} attribute can also be used for variables and
2089 types (@pxref{Variable Attributes}, @pxref{Type Attributes}.)
2090
2091 @item dllexport
2092 @cindex @code{__declspec(dllexport)}
2093 On Microsoft Windows targets and Symbian OS targets the
2094 @code{dllexport} attribute causes the compiler to provide a global
2095 pointer to a pointer in a DLL, so that it can be referenced with the
2096 @code{dllimport} attribute.  On Microsoft Windows targets, the pointer
2097 name is formed by combining @code{_imp__} and the function or variable
2098 name.
2099
2100 You can use @code{__declspec(dllexport)} as a synonym for
2101 @code{__attribute__ ((dllexport))} for compatibility with other
2102 compilers.
2103
2104 On systems that support the @code{visibility} attribute, this
2105 attribute also implies ``default'' visibility.  It is an error to
2106 explicitly specify any other visibility.
2107
2108 Currently, the @code{dllexport} attribute is ignored for inlined
2109 functions, unless the @option{-fkeep-inline-functions} flag has been
2110 used.  The attribute is also ignored for undefined symbols.
2111
2112 When applied to C++ classes, the attribute marks defined non-inlined
2113 member functions and static data members as exports.  Static consts
2114 initialized in-class are not marked unless they are also defined
2115 out-of-class.
2116
2117 For Microsoft Windows targets there are alternative methods for
2118 including the symbol in the DLL's export table such as using a
2119 @file{.def} file with an @code{EXPORTS} section or, with GNU ld, using
2120 the @option{--export-all} linker flag.
2121
2122 @item dllimport
2123 @cindex @code{__declspec(dllimport)}
2124 On Microsoft Windows and Symbian OS targets, the @code{dllimport}
2125 attribute causes the compiler to reference a function or variable via
2126 a global pointer to a pointer that is set up by the DLL exporting the
2127 symbol.  The attribute implies @code{extern}.  On Microsoft Windows
2128 targets, the pointer name is formed by combining @code{_imp__} and the
2129 function or variable name.
2130
2131 You can use @code{__declspec(dllimport)} as a synonym for
2132 @code{__attribute__ ((dllimport))} for compatibility with other
2133 compilers.
2134
2135 On systems that support the @code{visibility} attribute, this
2136 attribute also implies ``default'' visibility.  It is an error to
2137 explicitly specify any other visibility.
2138
2139 Currently, the attribute is ignored for inlined functions.  If the
2140 attribute is applied to a symbol @emph{definition}, an error is reported.
2141 If a symbol previously declared @code{dllimport} is later defined, the
2142 attribute is ignored in subsequent references, and a warning is emitted.
2143 The attribute is also overridden by a subsequent declaration as
2144 @code{dllexport}.
2145
2146 When applied to C++ classes, the attribute marks non-inlined
2147 member functions and static data members as imports.  However, the
2148 attribute is ignored for virtual methods to allow creation of vtables
2149 using thunks.
2150
2151 On the SH Symbian OS target the @code{dllimport} attribute also has
2152 another affect---it can cause the vtable and run-time type information
2153 for a class to be exported.  This happens when the class has a
2154 dllimport'ed constructor or a non-inline, non-pure virtual function
2155 and, for either of those two conditions, the class also has an inline
2156 constructor or destructor and has a key function that is defined in
2157 the current translation unit.
2158
2159 For Microsoft Windows based targets the use of the @code{dllimport}
2160 attribute on functions is not necessary, but provides a small
2161 performance benefit by eliminating a thunk in the DLL@.  The use of the
2162 @code{dllimport} attribute on imported variables was required on older
2163 versions of the GNU linker, but can now be avoided by passing the
2164 @option{--enable-auto-import} switch to the GNU linker.  As with
2165 functions, using the attribute for a variable eliminates a thunk in
2166 the DLL@.
2167
2168 One drawback to using this attribute is that a pointer to a
2169 @emph{variable} marked as @code{dllimport} cannot be used as a constant
2170 address. However, a pointer to a @emph{function} with the
2171 @code{dllimport} attribute can be used as a constant initializer; in
2172 this case, the address of a stub function in the import lib is
2173 referenced.  On Microsoft Windows targets, the attribute can be disabled
2174 for functions by setting the @option{-mnop-fun-dllimport} flag.
2175
2176 @item eightbit_data
2177 @cindex eight bit data on the H8/300, H8/300H, and H8S
2178 Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
2179 variable should be placed into the eight bit data section.
2180 The compiler will generate more efficient code for certain operations
2181 on data in the eight bit data area.  Note the eight bit data area is limited to
2182 256 bytes of data.
2183
2184 You must use GAS and GLD from GNU binutils version 2.7 or later for
2185 this attribute to work correctly.
2186
2187 @item exception_handler
2188 @cindex exception handler functions on the Blackfin processor
2189 Use this attribute on the Blackfin to indicate that the specified function
2190 is an exception handler.  The compiler will generate function entry and
2191 exit sequences suitable for use in an exception handler when this
2192 attribute is present.
2193
2194 @item externally_visible
2195 @cindex @code{externally_visible} attribute.
2196 This attribute, attached to a global variable or function, nullifies
2197 the effect of the @option{-fwhole-program} command-line option, so the
2198 object remains visible outside the current compilation unit.
2199
2200 @item far
2201 @cindex functions which handle memory bank switching
2202 On 68HC11 and 68HC12 the @code{far} attribute causes the compiler to
2203 use a calling convention that takes care of switching memory banks when
2204 entering and leaving a function.  This calling convention is also the
2205 default when using the @option{-mlong-calls} option.
2206
2207 On 68HC12 the compiler will use the @code{call} and @code{rtc} instructions
2208 to call and return from a function.
2209
2210 On 68HC11 the compiler will generate a sequence of instructions
2211 to invoke a board-specific routine to switch the memory bank and call the
2212 real function.  The board-specific routine simulates a @code{call}.
2213 At the end of a function, it will jump to a board-specific routine
2214 instead of using @code{rts}.  The board-specific return routine simulates
2215 the @code{rtc}.
2216
2217 @item fastcall
2218 @cindex functions that pop the argument stack on the 386
2219 On the Intel 386, the @code{fastcall} attribute causes the compiler to
2220 pass the first argument (if of integral type) in the register ECX and
2221 the second argument (if of integral type) in the register EDX@.  Subsequent
2222 and other typed arguments are passed on the stack.  The called function will
2223 pop the arguments off the stack.  If the number of arguments is variable all
2224 arguments are pushed on the stack.
2225
2226 @item format (@var{archetype}, @var{string-index}, @var{first-to-check})
2227 @cindex @code{format} function attribute
2228 @opindex Wformat
2229 The @code{format} attribute specifies that a function takes @code{printf},
2230 @code{scanf}, @code{strftime} or @code{strfmon} style arguments which
2231 should be type-checked against a format string.  For example, the
2232 declaration:
2233
2234 @smallexample
2235 extern int
2236 my_printf (void *my_object, const char *my_format, ...)
2237       __attribute__ ((format (printf, 2, 3)));
2238 @end smallexample
2239
2240 @noindent
2241 causes the compiler to check the arguments in calls to @code{my_printf}
2242 for consistency with the @code{printf} style format string argument
2243 @code{my_format}.
2244
2245 The parameter @var{archetype} determines how the format string is
2246 interpreted, and should be @code{printf}, @code{scanf}, @code{strftime},
2247 @code{gnu_printf}, @code{gnu_scanf}, @code{gnu_strftime} or
2248 @code{strfmon}.  (You can also use @code{__printf__},
2249 @code{__scanf__}, @code{__strftime__} or @code{__strfmon__}.)  On
2250 MinGW targets, @code{ms_printf}, @code{ms_scanf}, and
2251 @code{ms_strftime} are also present.
2252 @var{archtype} values such as @code{printf} refer to the formats accepted
2253 by the system's C run-time library, while @code{gnu_} values always refer
2254 to the formats accepted by the GNU C Library.  On Microsoft Windows
2255 targets, @code{ms_} values refer to the formats accepted by the
2256 @file{msvcrt.dll} library.
2257 The parameter @var{string-index}
2258 specifies which argument is the format string argument (starting
2259 from 1), while @var{first-to-check} is the number of the first
2260 argument to check against the format string.  For functions
2261 where the arguments are not available to be checked (such as
2262 @code{vprintf}), specify the third parameter as zero.  In this case the
2263 compiler only checks the format string for consistency.  For
2264 @code{strftime} formats, the third parameter is required to be zero.
2265 Since non-static C++ methods have an implicit @code{this} argument, the
2266 arguments of such methods should be counted from two, not one, when
2267 giving values for @var{string-index} and @var{first-to-check}.
2268
2269 In the example above, the format string (@code{my_format}) is the second
2270 argument of the function @code{my_print}, and the arguments to check
2271 start with the third argument, so the correct parameters for the format
2272 attribute are 2 and 3.
2273
2274 @opindex ffreestanding
2275 @opindex fno-builtin
2276 The @code{format} attribute allows you to identify your own functions
2277 which take format strings as arguments, so that GCC can check the
2278 calls to these functions for errors.  The compiler always (unless
2279 @option{-ffreestanding} or @option{-fno-builtin} is used) checks formats
2280 for the standard library functions @code{printf}, @code{fprintf},
2281 @code{sprintf}, @code{scanf}, @code{fscanf}, @code{sscanf}, @code{strftime},
2282 @code{vprintf}, @code{vfprintf} and @code{vsprintf} whenever such
2283 warnings are requested (using @option{-Wformat}), so there is no need to
2284 modify the header file @file{stdio.h}.  In C99 mode, the functions
2285 @code{snprintf}, @code{vsnprintf}, @code{vscanf}, @code{vfscanf} and
2286 @code{vsscanf} are also checked.  Except in strictly conforming C
2287 standard modes, the X/Open function @code{strfmon} is also checked as
2288 are @code{printf_unlocked} and @code{fprintf_unlocked}.
2289 @xref{C Dialect Options,,Options Controlling C Dialect}.
2290
2291 The target may provide additional types of format checks.
2292 @xref{Target Format Checks,,Format Checks Specific to Particular
2293 Target Machines}.
2294
2295 @item format_arg (@var{string-index})
2296 @cindex @code{format_arg} function attribute
2297 @opindex Wformat-nonliteral
2298 The @code{format_arg} attribute specifies that a function takes a format
2299 string for a @code{printf}, @code{scanf}, @code{strftime} or
2300 @code{strfmon} style function and modifies it (for example, to translate
2301 it into another language), so the result can be passed to a
2302 @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style
2303 function (with the remaining arguments to the format function the same
2304 as they would have been for the unmodified string).  For example, the
2305 declaration:
2306
2307 @smallexample
2308 extern char *
2309 my_dgettext (char *my_domain, const char *my_format)
2310       __attribute__ ((format_arg (2)));
2311 @end smallexample
2312
2313 @noindent
2314 causes the compiler to check the arguments in calls to a @code{printf},
2315 @code{scanf}, @code{strftime} or @code{strfmon} type function, whose
2316 format string argument is a call to the @code{my_dgettext} function, for
2317 consistency with the format string argument @code{my_format}.  If the
2318 @code{format_arg} attribute had not been specified, all the compiler
2319 could tell in such calls to format functions would be that the format
2320 string argument is not constant; this would generate a warning when
2321 @option{-Wformat-nonliteral} is used, but the calls could not be checked
2322 without the attribute.
2323
2324 The parameter @var{string-index} specifies which argument is the format
2325 string argument (starting from one).  Since non-static C++ methods have
2326 an implicit @code{this} argument, the arguments of such methods should
2327 be counted from two.
2328
2329 The @code{format-arg} attribute allows you to identify your own
2330 functions which modify format strings, so that GCC can check the
2331 calls to @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon}
2332 type function whose operands are a call to one of your own function.
2333 The compiler always treats @code{gettext}, @code{dgettext}, and
2334 @code{dcgettext} in this manner except when strict ISO C support is
2335 requested by @option{-ansi} or an appropriate @option{-std} option, or
2336 @option{-ffreestanding} or @option{-fno-builtin}
2337 is used.  @xref{C Dialect Options,,Options
2338 Controlling C Dialect}.
2339
2340 @item function_vector
2341 @cindex calling functions through the function vector on H8/300, M16C, M32C and SH2A processors
2342 Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
2343 function should be called through the function vector.  Calling a
2344 function through the function vector will reduce code size, however;
2345 the function vector has a limited size (maximum 128 entries on the H8/300
2346 and 64 entries on the H8/300H and H8S) and shares space with the interrupt vector.
2347
2348 In SH2A target, this attribute declares a function to be called using the
2349 TBR relative addressing mode.  The argument to this attribute is the entry
2350 number of the same function in a vector table containing all the TBR
2351 relative addressable functions.  For the successful jump, register TBR
2352 should contain the start address of this TBR relative vector table.
2353 In the startup routine of the user application, user needs to care of this
2354 TBR register initialization.  The TBR relative vector table can have at
2355 max 256 function entries.  The jumps to these functions will be generated
2356 using a SH2A specific, non delayed branch instruction JSR/N @@(disp8,TBR).
2357 You must use GAS and GLD from GNU binutils version 2.7 or later for
2358 this attribute to work correctly.
2359
2360 Please refer the example of M16C target, to see the use of this
2361 attribute while declaring a function,
2362
2363 In an application, for a function being called once, this attribute will
2364 save at least 8 bytes of code; and if other successive calls are being
2365 made to the same function, it will save 2 bytes of code per each of these
2366 calls.
2367
2368 On M16C/M32C targets, the @code{function_vector} attribute declares a
2369 special page subroutine call function. Use of this attribute reduces
2370 the code size by 2 bytes for each call generated to the
2371 subroutine. The argument to the attribute is the vector number entry
2372 from the special page vector table which contains the 16 low-order
2373 bits of the subroutine's entry address. Each vector table has special
2374 page number (18 to 255) which are used in @code{jsrs} instruction.
2375 Jump addresses of the routines are generated by adding 0x0F0000 (in
2376 case of M16C targets) or 0xFF0000 (in case of M32C targets), to the 2
2377 byte addresses set in the vector table. Therefore you need to ensure
2378 that all the special page vector routines should get mapped within the
2379 address range 0x0F0000 to 0x0FFFFF (for M16C) and 0xFF0000 to 0xFFFFFF
2380 (for M32C).
2381
2382 In the following example 2 bytes will be saved for each call to
2383 function @code{foo}.
2384
2385 @smallexample
2386 void foo (void) __attribute__((function_vector(0x18)));
2387 void foo (void)
2388 @{
2389 @}
2390
2391 void bar (void)
2392 @{
2393     foo();
2394 @}
2395 @end smallexample
2396
2397 If functions are defined in one file and are called in another file,
2398 then be sure to write this declaration in both files.
2399
2400 This attribute is ignored for R8C target.
2401
2402 @item interrupt
2403 @cindex interrupt handler functions
2404 Use this attribute on the ARM, AVR, CRX, M32C, M32R/D, m68k, MIPS
2405 and Xstormy16 ports to indicate that the specified function is an
2406 interrupt handler.  The compiler will generate function entry and exit
2407 sequences suitable for use in an interrupt handler when this attribute
2408 is present.
2409
2410 Note, interrupt handlers for the Blackfin, H8/300, H8/300H, H8S, and
2411 SH processors can be specified via the @code{interrupt_handler} attribute.
2412
2413 Note, on the AVR, interrupts will be enabled inside the function.
2414
2415 Note, for the ARM, you can specify the kind of interrupt to be handled by
2416 adding an optional parameter to the interrupt attribute like this:
2417
2418 @smallexample
2419 void f () __attribute__ ((interrupt ("IRQ")));
2420 @end smallexample
2421
2422 Permissible values for this parameter are: IRQ, FIQ, SWI, ABORT and UNDEF@.
2423
2424 On ARMv7-M the interrupt type is ignored, and the attribute means the function
2425 may be called with a word aligned stack pointer.
2426
2427 On MIPS targets, you can use the following attributes to modify the behavior
2428 of an interrupt handler:
2429 @table @code
2430 @item use_shadow_register_set
2431 @cindex @code{use_shadow_register_set} attribute
2432 Assume that the handler uses a shadow register set, instead of
2433 the main general-purpose registers.
2434
2435 @item keep_interrupts_masked
2436 @cindex @code{keep_interrupts_masked} attribute
2437 Keep interrupts masked for the whole function.  Without this attribute,
2438 GCC tries to reenable interrupts for as much of the function as it can.
2439
2440 @item use_debug_exception_return
2441 @cindex @code{use_debug_exception_return} attribute
2442 Return using the @code{deret} instruction.  Interrupt handlers that don't
2443 have this attribute return using @code{eret} instead.
2444 @end table
2445
2446 You can use any combination of these attributes, as shown below:
2447 @smallexample
2448 void __attribute__ ((interrupt)) v0 ();
2449 void __attribute__ ((interrupt, use_shadow_register_set)) v1 ();
2450 void __attribute__ ((interrupt, keep_interrupts_masked)) v2 ();
2451 void __attribute__ ((interrupt, use_debug_exception_return)) v3 ();
2452 void __attribute__ ((interrupt, use_shadow_register_set,
2453                      keep_interrupts_masked)) v4 ();
2454 void __attribute__ ((interrupt, use_shadow_register_set,
2455                      use_debug_exception_return)) v5 ();
2456 void __attribute__ ((interrupt, keep_interrupts_masked,
2457                      use_debug_exception_return)) v6 ();
2458 void __attribute__ ((interrupt, use_shadow_register_set,
2459                      keep_interrupts_masked,
2460                      use_debug_exception_return)) v7 ();
2461 @end smallexample
2462
2463 @item interrupt_handler
2464 @cindex interrupt handler functions on the Blackfin, m68k, H8/300 and SH processors
2465 Use this attribute on the Blackfin, m68k, H8/300, H8/300H, H8S, and SH to
2466 indicate that the specified function is an interrupt handler.  The compiler
2467 will generate function entry and exit sequences suitable for use in an
2468 interrupt handler when this attribute is present.
2469
2470 @item interrupt_thread
2471 @cindex interrupt thread functions on fido
2472 Use this attribute on fido, a subarchitecture of the m68k, to indicate
2473 that the specified function is an interrupt handler that is designed
2474 to run as a thread.  The compiler omits generate prologue/epilogue
2475 sequences and replaces the return instruction with a @code{sleep}
2476 instruction.  This attribute is available only on fido.
2477
2478 @item isr
2479 @cindex interrupt service routines on ARM
2480 Use this attribute on ARM to write Interrupt Service Routines. This is an
2481 alias to the @code{interrupt} attribute above.
2482
2483 @item kspisusp
2484 @cindex User stack pointer in interrupts on the Blackfin
2485 When used together with @code{interrupt_handler}, @code{exception_handler}
2486 or @code{nmi_handler}, code will be generated to load the stack pointer
2487 from the USP register in the function prologue.
2488
2489 @item l1_text
2490 @cindex @code{l1_text} function attribute
2491 This attribute specifies a function to be placed into L1 Instruction
2492 SRAM@. The function will be put into a specific section named @code{.l1.text}.
2493 With @option{-mfdpic}, function calls with a such function as the callee
2494 or caller will use inlined PLT.
2495
2496 @item long_call/short_call
2497 @cindex indirect calls on ARM
2498 This attribute specifies how a particular function is called on
2499 ARM@.  Both attributes override the @option{-mlong-calls} (@pxref{ARM Options})
2500 command line switch and @code{#pragma long_calls} settings.  The
2501 @code{long_call} attribute indicates that the function might be far
2502 away from the call site and require a different (more expensive)
2503 calling sequence.   The @code{short_call} attribute always places
2504 the offset to the function from the call site into the @samp{BL}
2505 instruction directly.
2506
2507 @item longcall/shortcall
2508 @cindex functions called via pointer on the RS/6000 and PowerPC
2509 On the Blackfin, RS/6000 and PowerPC, the @code{longcall} attribute
2510 indicates that the function might be far away from the call site and
2511 require a different (more expensive) calling sequence.  The
2512 @code{shortcall} attribute indicates that the function is always close
2513 enough for the shorter calling sequence to be used.  These attributes
2514 override both the @option{-mlongcall} switch and, on the RS/6000 and
2515 PowerPC, the @code{#pragma longcall} setting.
2516
2517 @xref{RS/6000 and PowerPC Options}, for more information on whether long
2518 calls are necessary.
2519
2520 @item long_call/near/far
2521 @cindex indirect calls on MIPS
2522 These attributes specify how a particular function is called on MIPS@.
2523 The attributes override the @option{-mlong-calls} (@pxref{MIPS Options})
2524 command-line switch.  The @code{long_call} and @code{far} attributes are
2525 synonyms, and cause the compiler to always call
2526 the function by first loading its address into a register, and then using
2527 the contents of that register.  The @code{near} attribute has the opposite
2528 effect; it specifies that non-PIC calls should be made using the more 
2529 efficient @code{jal} instruction.
2530
2531 @item malloc
2532 @cindex @code{malloc} attribute
2533 The @code{malloc} attribute is used to tell the compiler that a function
2534 may be treated as if any non-@code{NULL} pointer it returns cannot
2535 alias any other pointer valid when the function returns.
2536 This will often improve optimization.
2537 Standard functions with this property include @code{malloc} and
2538 @code{calloc}.  @code{realloc}-like functions have this property as
2539 long as the old pointer is never referred to (including comparing it
2540 to the new pointer) after the function returns a non-@code{NULL}
2541 value.
2542
2543 @item mips16/nomips16
2544 @cindex @code{mips16} attribute
2545 @cindex @code{nomips16} attribute
2546
2547 On MIPS targets, you can use the @code{mips16} and @code{nomips16}
2548 function attributes to locally select or turn off MIPS16 code generation.
2549 A function with the @code{mips16} attribute is emitted as MIPS16 code, 
2550 while MIPS16 code generation is disabled for functions with the 
2551 @code{nomips16} attribute.  These attributes override the 
2552 @option{-mips16} and @option{-mno-mips16} options on the command line
2553 (@pxref{MIPS Options}).  
2554
2555 When compiling files containing mixed MIPS16 and non-MIPS16 code, the
2556 preprocessor symbol @code{__mips16} reflects the setting on the command line,
2557 not that within individual functions.  Mixed MIPS16 and non-MIPS16 code
2558 may interact badly with some GCC extensions such as @code{__builtin_apply}
2559 (@pxref{Constructing Calls}).
2560
2561 @item model (@var{model-name})
2562 @cindex function addressability on the M32R/D
2563 @cindex variable addressability on the IA-64
2564
2565 On the M32R/D, use this attribute to set the addressability of an
2566 object, and of the code generated for a function.  The identifier
2567 @var{model-name} is one of @code{small}, @code{medium}, or
2568 @code{large}, representing each of the code models.
2569
2570 Small model objects live in the lower 16MB of memory (so that their
2571 addresses can be loaded with the @code{ld24} instruction), and are
2572 callable with the @code{bl} instruction.
2573
2574 Medium model objects may live anywhere in the 32-bit address space (the
2575 compiler will generate @code{seth/add3} instructions to load their addresses),
2576 and are callable with the @code{bl} instruction.
2577
2578 Large model objects may live anywhere in the 32-bit address space (the
2579 compiler will generate @code{seth/add3} instructions to load their addresses),
2580 and may not be reachable with the @code{bl} instruction (the compiler will
2581 generate the much slower @code{seth/add3/jl} instruction sequence).
2582
2583 On IA-64, use this attribute to set the addressability of an object.
2584 At present, the only supported identifier for @var{model-name} is
2585 @code{small}, indicating addressability via ``small'' (22-bit)
2586 addresses (so that their addresses can be loaded with the @code{addl}
2587 instruction).  Caveat: such addressing is by definition not position
2588 independent and hence this attribute must not be used for objects
2589 defined by shared libraries.
2590
2591 @item ms_abi/sysv_abi
2592 @cindex @code{ms_abi} attribute
2593 @cindex @code{sysv_abi} attribute
2594
2595 On 64-bit x86_64-*-* targets, you can use an ABI attribute to indicate
2596 which calling convention should be used for a function.  The @code{ms_abi}
2597 attribute tells the compiler to use the Microsoft ABI, while the
2598 @code{sysv_abi} attribute tells the compiler to use the ABI used on
2599 GNU/Linux and other systems.  The default is to use the Microsoft ABI
2600 when targeting Windows.  On all other systems, the default is the AMD ABI.
2601
2602 Note, This feature is currently sorried out for Windows targets trying to
2603
2604 @item naked
2605 @cindex function without a prologue/epilogue code
2606 Use this attribute on the ARM, AVR, IP2K and SPU ports to indicate that
2607 the specified function does not need prologue/epilogue sequences generated by
2608 the compiler.  It is up to the programmer to provide these sequences. The 
2609 only statements that can be safely included in naked functions are 
2610 @code{asm} statements that do not have operands.  All other statements,
2611 including declarations of local variables, @code{if} statements, and so 
2612 forth, should be avoided.  Naked functions should be used to implement the 
2613 body of an assembly function, while allowing the compiler to construct
2614 the requisite function declaration for the assembler.
2615
2616 @item near
2617 @cindex functions which do not handle memory bank switching on 68HC11/68HC12
2618 On 68HC11 and 68HC12 the @code{near} attribute causes the compiler to
2619 use the normal calling convention based on @code{jsr} and @code{rts}.
2620 This attribute can be used to cancel the effect of the @option{-mlong-calls}
2621 option.
2622
2623 @item nesting
2624 @cindex Allow nesting in an interrupt handler on the Blackfin processor.
2625 Use this attribute together with @code{interrupt_handler},
2626 @code{exception_handler} or @code{nmi_handler} to indicate that the function
2627 entry code should enable nested interrupts or exceptions.
2628
2629 @item nmi_handler
2630 @cindex NMI handler functions on the Blackfin processor
2631 Use this attribute on the Blackfin to indicate that the specified function
2632 is an NMI handler.  The compiler will generate function entry and
2633 exit sequences suitable for use in an NMI handler when this
2634 attribute is present.
2635
2636 @item no_instrument_function
2637 @cindex @code{no_instrument_function} function attribute
2638 @opindex finstrument-functions
2639 If @option{-finstrument-functions} is given, profiling function calls will
2640 be generated at entry and exit of most user-compiled functions.
2641 Functions with this attribute will not be so instrumented.
2642
2643 @item noinline
2644 @cindex @code{noinline} function attribute
2645 This function attribute prevents a function from being considered for
2646 inlining.
2647 @c Don't enumerate the optimizations by name here; we try to be
2648 @c future-compatible with this mechanism.
2649 If the function does not have side-effects, there are optimizations
2650 other than inlining that causes function calls to be optimized away,
2651 although the function call is live.  To keep such calls from being
2652 optimized away, put
2653 @smallexample
2654 asm ("");
2655 @end smallexample
2656 (@pxref{Extended Asm}) in the called function, to serve as a special
2657 side-effect.
2658
2659 @item nonnull (@var{arg-index}, @dots{})
2660 @cindex @code{nonnull} function attribute
2661 The @code{nonnull} attribute specifies that some function parameters should
2662 be non-null pointers.  For instance, the declaration:
2663
2664 @smallexample
2665 extern void *
2666 my_memcpy (void *dest, const void *src, size_t len)
2667         __attribute__((nonnull (1, 2)));
2668 @end smallexample
2669
2670 @noindent
2671 causes the compiler to check that, in calls to @code{my_memcpy},
2672 arguments @var{dest} and @var{src} are non-null.  If the compiler
2673 determines that a null pointer is passed in an argument slot marked
2674 as non-null, and the @option{-Wnonnull} option is enabled, a warning
2675 is issued.  The compiler may also choose to make optimizations based
2676 on the knowledge that certain function arguments will not be null.
2677
2678 If no argument index list is given to the @code{nonnull} attribute,
2679 all pointer arguments are marked as non-null.  To illustrate, the
2680 following declaration is equivalent to the previous example:
2681
2682 @smallexample
2683 extern void *
2684 my_memcpy (void *dest, const void *src, size_t len)
2685         __attribute__((nonnull));
2686 @end smallexample
2687
2688 @item noreturn
2689 @cindex @code{noreturn} function attribute
2690 A few standard library functions, such as @code{abort} and @code{exit},
2691 cannot return.  GCC knows this automatically.  Some programs define
2692 their own functions that never return.  You can declare them
2693 @code{noreturn} to tell the compiler this fact.  For example,
2694
2695 @smallexample
2696 @group
2697 void fatal () __attribute__ ((noreturn));
2698
2699 void
2700 fatal (/* @r{@dots{}} */)
2701 @{
2702   /* @r{@dots{}} */ /* @r{Print error message.} */ /* @r{@dots{}} */
2703   exit (1);
2704 @}
2705 @end group
2706 @end smallexample
2707
2708 The @code{noreturn} keyword tells the compiler to assume that
2709 @code{fatal} cannot return.  It can then optimize without regard to what
2710 would happen if @code{fatal} ever did return.  This makes slightly
2711 better code.  More importantly, it helps avoid spurious warnings of
2712 uninitialized variables.
2713
2714 The @code{noreturn} keyword does not affect the exceptional path when that
2715 applies: a @code{noreturn}-marked function may still return to the caller
2716 by throwing an exception or calling @code{longjmp}.
2717
2718 Do not assume that registers saved by the calling function are
2719 restored before calling the @code{noreturn} function.
2720
2721 It does not make sense for a @code{noreturn} function to have a return
2722 type other than @code{void}.
2723
2724 The attribute @code{noreturn} is not implemented in GCC versions
2725 earlier than 2.5.  An alternative way to declare that a function does
2726 not return, which works in the current version and in some older
2727 versions, is as follows:
2728
2729 @smallexample
2730 typedef void voidfn ();
2731
2732 volatile voidfn fatal;
2733 @end smallexample
2734
2735 This approach does not work in GNU C++.
2736
2737 @item nothrow
2738 @cindex @code{nothrow} function attribute
2739 The @code{nothrow} attribute is used to inform the compiler that a
2740 function cannot throw an exception.  For example, most functions in
2741 the standard C library can be guaranteed not to throw an exception
2742 with the notable exceptions of @code{qsort} and @code{bsearch} that
2743 take function pointer arguments.  The @code{nothrow} attribute is not
2744 implemented in GCC versions earlier than 3.3.
2745
2746 @item optimize
2747 @cindex @code{optimize} function attribute
2748 The @code{optimize} attribute is used to specify that a function is to
2749 be compiled with different optimization options than specified on the
2750 command line.  Arguments can either be numbers or strings.  Numbers
2751 are assumed to be an optimization level.  Strings that begin with
2752 @code{O} are assumed to be an optimization option, while other options
2753 are assumed to be used with a @code{-f} prefix.  You can also use the
2754 @samp{#pragma GCC optimize} pragma to set the optimization options
2755 that affect more than one function.
2756 @xref{Function Specific Option Pragmas}, for details about the
2757 @samp{#pragma GCC optimize} pragma.
2758
2759 This can be used for instance to have frequently executed functions
2760 compiled with more aggressive optimization options that produce faster
2761 and larger code, while other functions can be called with less
2762 aggressive options.
2763
2764 @item pure
2765 @cindex @code{pure} function attribute
2766 Many functions have no effects except the return value and their
2767 return value depends only on the parameters and/or global variables.
2768 Such a function can be subject
2769 to common subexpression elimination and loop optimization just as an
2770 arithmetic operator would be.  These functions should be declared
2771 with the attribute @code{pure}.  For example,
2772
2773 @smallexample
2774 int square (int) __attribute__ ((pure));
2775 @end smallexample
2776
2777 @noindent
2778 says that the hypothetical function @code{square} is safe to call
2779 fewer times than the program says.
2780
2781 Some of common examples of pure functions are @code{strlen} or @code{memcmp}.
2782 Interesting non-pure functions are functions with infinite loops or those
2783 depending on volatile memory or other system resource, that may change between
2784 two consecutive calls (such as @code{feof} in a multithreading environment).
2785
2786 The attribute @code{pure} is not implemented in GCC versions earlier
2787 than 2.96.
2788
2789 @item hot
2790 @cindex @code{hot} function attribute
2791 The @code{hot} attribute is used to inform the compiler that a function is a
2792 hot spot of the compiled program.  The function is optimized more aggressively
2793 and on many target it is placed into special subsection of the text section so
2794 all hot functions appears close together improving locality.
2795
2796 When profile feedback is available, via @option{-fprofile-use}, hot functions
2797 are automatically detected and this attribute is ignored.
2798
2799 The @code{hot} attribute is not implemented in GCC versions earlier
2800 than 4.3.
2801
2802 @item cold
2803 @cindex @code{cold} function attribute
2804 The @code{cold} attribute is used to inform the compiler that a function is
2805 unlikely executed.  The function is optimized for size rather than speed and on
2806 many targets it is placed into special subsection of the text section so all
2807 cold functions appears close together improving code locality of non-cold parts
2808 of program.  The paths leading to call of cold functions within code are marked
2809 as unlikely by the branch prediction mechanism. It is thus useful to mark
2810 functions used to handle unlikely conditions, such as @code{perror}, as cold to
2811 improve optimization of hot functions that do call marked functions in rare
2812 occasions.
2813
2814 When profile feedback is available, via @option{-fprofile-use}, hot functions
2815 are automatically detected and this attribute is ignored.
2816
2817 The @code{cold} attribute is not implemented in GCC versions earlier than 4.3.
2818
2819 @item regparm (@var{number})
2820 @cindex @code{regparm} attribute
2821 @cindex functions that are passed arguments in registers on the 386
2822 On the Intel 386, the @code{regparm} attribute causes the compiler to
2823 pass arguments number one to @var{number} if they are of integral type
2824 in registers EAX, EDX, and ECX instead of on the stack.  Functions that
2825 take a variable number of arguments will continue to be passed all of their
2826 arguments on the stack.
2827
2828 Beware that on some ELF systems this attribute is unsuitable for
2829 global functions in shared libraries with lazy binding (which is the
2830 default).  Lazy binding will send the first call via resolving code in
2831 the loader, which might assume EAX, EDX and ECX can be clobbered, as
2832 per the standard calling conventions.  Solaris 8 is affected by this.
2833 GNU systems with GLIBC 2.1 or higher, and FreeBSD, are believed to be
2834 safe since the loaders there save EAX, EDX and ECX.  (Lazy binding can be
2835 disabled with the linker or the loader if desired, to avoid the
2836 problem.)
2837
2838 @item sseregparm
2839 @cindex @code{sseregparm} attribute
2840 On the Intel 386 with SSE support, the @code{sseregparm} attribute
2841 causes the compiler to pass up to 3 floating point arguments in
2842 SSE registers instead of on the stack.  Functions that take a
2843 variable number of arguments will continue to pass all of their
2844 floating point arguments on the stack.
2845
2846 @item force_align_arg_pointer
2847 @cindex @code{force_align_arg_pointer} attribute
2848 On the Intel x86, the @code{force_align_arg_pointer} attribute may be
2849 applied to individual function definitions, generating an alternate
2850 prologue and epilogue that realigns the runtime stack if necessary.
2851 This supports mixing legacy codes that run with a 4-byte aligned stack
2852 with modern codes that keep a 16-byte stack for SSE compatibility.
2853
2854 @item resbank
2855 @cindex @code{resbank} attribute
2856 On the SH2A target, this attribute enables the high-speed register
2857 saving and restoration using a register bank for @code{interrupt_handler}
2858 routines.  Saving to the bank is performed automatically after the CPU
2859 accepts an interrupt that uses a register bank.
2860
2861 The nineteen 32-bit registers comprising general register R0 to R14,
2862 control register GBR, and system registers MACH, MACL, and PR and the
2863 vector table address offset are saved into a register bank.  Register
2864 banks are stacked in first-in last-out (FILO) sequence.  Restoration
2865 from the bank is executed by issuing a RESBANK instruction.
2866
2867 @item returns_twice
2868 @cindex @code{returns_twice} attribute
2869 The @code{returns_twice} attribute tells the compiler that a function may
2870 return more than one time.  The compiler will ensure that all registers
2871 are dead before calling such a function and will emit a warning about
2872 the variables that may be clobbered after the second return from the
2873 function.  Examples of such functions are @code{setjmp} and @code{vfork}.
2874 The @code{longjmp}-like counterpart of such function, if any, might need
2875 to be marked with the @code{noreturn} attribute.
2876
2877 @item saveall
2878 @cindex save all registers on the Blackfin, H8/300, H8/300H, and H8S
2879 Use this attribute on the Blackfin, H8/300, H8/300H, and H8S to indicate that
2880 all registers except the stack pointer should be saved in the prologue
2881 regardless of whether they are used or not.
2882
2883 @item section ("@var{section-name}")
2884 @cindex @code{section} function attribute
2885 Normally, the compiler places the code it generates in the @code{text} section.
2886 Sometimes, however, you need additional sections, or you need certain
2887 particular functions to appear in special sections.  The @code{section}
2888 attribute specifies that a function lives in a particular section.
2889 For example, the declaration:
2890
2891 @smallexample
2892 extern void foobar (void) __attribute__ ((section ("bar")));
2893 @end smallexample
2894
2895 @noindent
2896 puts the function @code{foobar} in the @code{bar} section.
2897
2898 Some file formats do not support arbitrary sections so the @code{section}
2899 attribute is not available on all platforms.
2900 If you need to map the entire contents of a module to a particular
2901 section, consider using the facilities of the linker instead.
2902
2903 @item sentinel
2904 @cindex @code{sentinel} function attribute
2905 This function attribute ensures that a parameter in a function call is
2906 an explicit @code{NULL}.  The attribute is only valid on variadic
2907 functions.  By default, the sentinel is located at position zero, the
2908 last parameter of the function call.  If an optional integer position
2909 argument P is supplied to the attribute, the sentinel must be located at
2910 position P counting backwards from the end of the argument list.
2911
2912 @smallexample
2913 __attribute__ ((sentinel))
2914 is equivalent to
2915 __attribute__ ((sentinel(0)))
2916 @end smallexample
2917
2918 The attribute is automatically set with a position of 0 for the built-in
2919 functions @code{execl} and @code{execlp}.  The built-in function
2920 @code{execle} has the attribute set with a position of 1.
2921
2922 A valid @code{NULL} in this context is defined as zero with any pointer
2923 type.  If your system defines the @code{NULL} macro with an integer type
2924 then you need to add an explicit cast.  GCC replaces @code{stddef.h}
2925 with a copy that redefines NULL appropriately.
2926
2927 The warnings for missing or incorrect sentinels are enabled with
2928 @option{-Wformat}.
2929
2930 @item short_call
2931 See long_call/short_call.
2932
2933 @item shortcall
2934 See longcall/shortcall.
2935
2936 @item signal
2937 @cindex signal handler functions on the AVR processors
2938 Use this attribute on the AVR to indicate that the specified
2939 function is a signal handler.  The compiler will generate function
2940 entry and exit sequences suitable for use in a signal handler when this
2941 attribute is present.  Interrupts will be disabled inside the function.
2942
2943 @item sp_switch
2944 Use this attribute on the SH to indicate an @code{interrupt_handler}
2945 function should switch to an alternate stack.  It expects a string
2946 argument that names a global variable holding the address of the
2947 alternate stack.
2948
2949 @smallexample
2950 void *alt_stack;
2951 void f () __attribute__ ((interrupt_handler,
2952                           sp_switch ("alt_stack")));
2953 @end smallexample
2954
2955 @item stdcall
2956 @cindex functions that pop the argument stack on the 386
2957 On the Intel 386, the @code{stdcall} attribute causes the compiler to
2958 assume that the called function will pop off the stack space used to
2959 pass arguments, unless it takes a variable number of arguments.
2960
2961 @item syscall_linkage
2962 @cindex @code{syscall_linkage} attribute
2963 This attribute is used to modify the IA64 calling convention by marking
2964 all input registers as live at all function exits.  This makes it possible
2965 to restart a system call after an interrupt without having to save/restore
2966 the input registers.  This also prevents kernel data from leaking into
2967 application code.
2968
2969 @item target
2970 @cindex @code{target} function attribute
2971 The @code{target} attribute is used to specify that a function is to
2972 be compiled with different target options than specified on the
2973 command line.  This can be used for instance to have functions
2974 compiled with a different ISA (instruction set architecture) than the
2975 default.  You can also use the @samp{#pragma GCC target} pragma to set
2976 more than one function to be compiled with specific target options.
2977 @xref{Function Specific Option Pragmas}, for details about the
2978 @samp{#pragma GCC target} pragma.
2979
2980 For instance on a 386, you could compile one function with
2981 @code{target("sse4.1,arch=core2")} and another with
2982 @code{target("sse4a,arch=amdfam10")} that would be equivalent to
2983 compiling the first function with @option{-msse4.1} and
2984 @option{-march=core2} options, and the second function with
2985 @option{-msse4a} and @option{-march=amdfam10} options.  It is up to the
2986 user to make sure that a function is only invoked on a machine that
2987 supports the particular ISA it was compiled for (for example by using
2988 @code{cpuid} on 386 to determine what feature bits and architecture
2989 family are used).
2990
2991 @smallexample
2992 int core2_func (void) __attribute__ ((__target__ ("arch=core2")));
2993 int sse3_func (void) __attribute__ ((__target__ ("sse3")));
2994 @end smallexample
2995
2996 On the 386, the following options are allowed:
2997
2998 @table @samp
2999 @item abm
3000 @itemx no-abm
3001 @cindex @code{target("abm")} attribute
3002 Enable/disable the generation of the advanced bit instructions.
3003
3004 @item aes
3005 @itemx no-aes
3006 @cindex @code{target("aes")} attribute
3007 Enable/disable the generation of the AES instructions.
3008
3009 @item mmx
3010 @itemx no-mmx
3011 @cindex @code{target("mmx")} attribute
3012 Enable/disable the generation of the MMX instructions.
3013
3014 @item pclmul
3015 @itemx no-pclmul
3016 @cindex @code{target("pclmul")} attribute
3017 Enable/disable the generation of the PCLMUL instructions.
3018
3019 @item popcnt
3020 @itemx no-popcnt
3021 @cindex @code{target("popcnt")} attribute
3022 Enable/disable the generation of the POPCNT instruction.
3023
3024 @item sse
3025 @itemx no-sse
3026 @cindex @code{target("sse")} attribute
3027 Enable/disable the generation of the SSE instructions.
3028
3029 @item sse2
3030 @itemx no-sse2
3031 @cindex @code{target("sse2")} attribute
3032 Enable/disable the generation of the SSE2 instructions.
3033
3034 @item sse3
3035 @itemx no-sse3
3036 @cindex @code{target("sse3")} attribute
3037 Enable/disable the generation of the SSE3 instructions.
3038
3039 @item sse4
3040 @itemx no-sse4
3041 @cindex @code{target("sse4")} attribute
3042 Enable/disable the generation of the SSE4 instructions (both SSE4.1
3043 and SSE4.2).
3044
3045 @item sse4.1
3046 @itemx no-sse4.1
3047 @cindex @code{target("sse4.1")} attribute
3048 Enable/disable the generation of the sse4.1 instructions.
3049
3050 @item sse4.2
3051 @itemx no-sse4.2
3052 @cindex @code{target("sse4.2")} attribute
3053 Enable/disable the generation of the sse4.2 instructions.
3054
3055 @item sse4a
3056 @itemx no-sse4a
3057 @cindex @code{target("sse4a")} attribute
3058 Enable/disable the generation of the SSE4A instructions.
3059
3060 @item sse5
3061 @itemx no-sse5
3062 @cindex @code{target("sse5")} attribute
3063 Enable/disable the generation of the SSE5 instructions.
3064
3065 @item ssse3
3066 @itemx no-ssse3
3067 @cindex @code{target("ssse3")} attribute
3068 Enable/disable the generation of the SSSE3 instructions.
3069
3070 @item cld
3071 @itemx no-cld
3072 @cindex @code{target("cld")} attribute
3073 Enable/disable the generation of the CLD before string moves.
3074
3075 @item fancy-math-387
3076 @itemx no-fancy-math-387
3077 @cindex @code{target("fancy-math-387")} attribute
3078 Enable/disable the generation of the @code{sin}, @code{cos}, and
3079 @code{sqrt} instructions on the 387 floating point unit.
3080
3081 @item fused-madd
3082 @itemx no-fused-madd
3083 @cindex @code{target("fused-madd")} attribute
3084 Enable/disable the generation of the fused multiply/add instructions.
3085
3086 @item ieee-fp
3087 @itemx no-ieee-fp
3088 @cindex @code{target("ieee-fp")} attribute
3089 Enable/disable the generation of floating point that depends on IEEE arithmetic.
3090
3091 @item inline-all-stringops
3092 @itemx no-inline-all-stringops
3093 @cindex @code{target("inline-all-stringops")} attribute
3094 Enable/disable inlining of string operations.
3095
3096 @item inline-stringops-dynamically
3097 @itemx no-inline-stringops-dynamically
3098 @cindex @code{target("inline-stringops-dynamically")} attribute
3099 Enable/disable the generation of the inline code to do small string
3100 operations and calling the library routines for large operations.
3101
3102 @item align-stringops
3103 @itemx no-align-stringops
3104 @cindex @code{target("align-stringops")} attribute
3105 Do/do not align destination of inlined string operations.
3106
3107 @item recip
3108 @itemx no-recip
3109 @cindex @code{target("recip")} attribute
3110 Enable/disable the generation of RCPSS, RCPPS, RSQRTSS and RSQRTPS
3111 instructions followed an additional Newton-Raphson step instead of
3112 doing a floating point division.
3113
3114 @item arch=@var{ARCH}
3115 @cindex @code{target("arch=@var{ARCH}")} attribute
3116 Specify the architecture to generate code for in compiling the function.
3117
3118 @item tune=@var{TUNE}
3119 @cindex @code{target("tune=@var{TUNE}")} attribute
3120 Specify the architecture to tune for in compiling the function.
3121
3122 @item fpmath=@var{FPMATH}
3123 @cindex @code{target("fpmath=@var{FPMATH}")} attribute
3124 Specify which floating point unit to use.  The
3125 @code{target("fpmath=sse,387")} option must be specified as
3126 @code{target("fpmath=sse+387")} because the comma would separate
3127 different options.
3128 @end table
3129
3130 On the 386, you can use either multiple strings to specify multiple
3131 options, or you can separate the option with a comma (@code{,}).
3132
3133 On the 386, the inliner will not inline a function that has different
3134 target options than the caller, unless the callee has a subset of the
3135 target options of the caller.  For example a function declared with
3136 @code{target("sse5")} can inline a function with
3137 @code{target("sse2")}, since @code{-msse5} implies @code{-msse2}.
3138
3139 The @code{target} attribute is not implemented in GCC versions earlier
3140 than 4.4, and at present only the 386 uses it.
3141
3142 @item tiny_data
3143 @cindex tiny data section on the H8/300H and H8S
3144 Use this attribute on the H8/300H and H8S to indicate that the specified
3145 variable should be placed into the tiny data section.
3146 The compiler will generate more efficient code for loads and stores
3147 on data in the tiny data section.  Note the tiny data area is limited to
3148 slightly under 32kbytes of data.
3149
3150 @item trap_exit
3151 Use this attribute on the SH for an @code{interrupt_handler} to return using
3152 @code{trapa} instead of @code{rte}.  This attribute expects an integer
3153 argument specifying the trap number to be used.
3154
3155 @item unused
3156 @cindex @code{unused} attribute.
3157 This attribute, attached to a function, means that the function is meant
3158 to be possibly unused.  GCC will not produce a warning for this
3159 function.
3160
3161 @item used
3162 @cindex @code{used} attribute.
3163 This attribute, attached to a function, means that code must be emitted
3164 for the function even if it appears that the function is not referenced.
3165 This is useful, for example, when the function is referenced only in
3166 inline assembly.
3167
3168 @item version_id
3169 @cindex @code{version_id} attribute
3170 This IA64 HP-UX attribute, attached to a global variable or function, renames a
3171 symbol to contain a version string, thus allowing for function level
3172 versioning.  HP-UX system header files may use version level functioning
3173 for some system calls.
3174
3175 @smallexample
3176 extern int foo () __attribute__((version_id ("20040821")));
3177 @end smallexample
3178
3179 Calls to @var{foo} will be mapped to calls to @var{foo@{20040821@}}.
3180
3181 @item visibility ("@var{visibility_type}")
3182 @cindex @code{visibility} attribute
3183 This attribute affects the linkage of the declaration to which it is attached.
3184 There are four supported @var{visibility_type} values: default,
3185 hidden, protected or internal visibility.
3186
3187 @smallexample
3188 void __attribute__ ((visibility ("protected")))
3189 f () @{ /* @r{Do something.} */; @}
3190 int i __attribute__ ((visibility ("hidden")));
3191 @end smallexample
3192
3193 The possible values of @var{visibility_type} correspond to the
3194 visibility settings in the ELF gABI.
3195
3196 @table @dfn
3197 @c keep this list of visibilities in alphabetical order.
3198
3199 @item default
3200 Default visibility is the normal case for the object file format.
3201 This value is available for the visibility attribute to override other
3202 options that may change the assumed visibility of entities.
3203
3204 On ELF, default visibility means that the declaration is visible to other
3205 modules and, in shared libraries, means that the declared entity may be
3206 overridden.
3207
3208 On Darwin, default visibility means that the declaration is visible to
3209 other modules.
3210
3211 Default visibility corresponds to ``external linkage'' in the language.
3212
3213 @item hidden
3214 Hidden visibility indicates that the entity declared will have a new
3215 form of linkage, which we'll call ``hidden linkage''.  Two
3216 declarations of an object with hidden linkage refer to the same object
3217 if they are in the same shared object.
3218
3219 @item internal
3220 Internal visibility is like hidden visibility, but with additional
3221 processor specific semantics.  Unless otherwise specified by the
3222 psABI, GCC defines internal visibility to mean that a function is
3223 @emph{never} called from another module.  Compare this with hidden
3224 functions which, while they cannot be referenced directly by other
3225 modules, can be referenced indirectly via function pointers.  By
3226 indicating that a function cannot be called from outside the module,
3227 GCC may for instance omit the load of a PIC register since it is known
3228 that the calling function loaded the correct value.
3229
3230 @item protected
3231 Protected visibility is like default visibility except that it
3232 indicates that references within the defining module will bind to the
3233 definition in that module.  That is, the declared entity cannot be
3234 overridden by another module.
3235
3236 @end table
3237
3238 All visibilities are supported on many, but not all, ELF targets
3239 (supported when the assembler supports the @samp{.visibility}
3240 pseudo-op).  Default visibility is supported everywhere.  Hidden
3241 visibility is supported on Darwin targets.
3242
3243 The visibility attribute should be applied only to declarations which
3244 would otherwise have external linkage.  The attribute should be applied
3245 consistently, so that the same entity should not be declared with
3246 different settings of the attribute.
3247
3248 In C++, the visibility attribute applies to types as well as functions
3249 and objects, because in C++ types have linkage.  A class must not have
3250 greater visibility than its non-static data member types and bases,
3251 and class members default to the visibility of their class.  Also, a
3252 declaration without explicit visibility is limited to the visibility
3253 of its type.
3254
3255 In C++, you can mark member functions and static member variables of a
3256 class with the visibility attribute.  This is useful if you know a
3257 particular method or static member variable should only be used from
3258 one shared object; then you can mark it hidden while the rest of the
3259 class has default visibility.  Care must be taken to avoid breaking
3260 the One Definition Rule; for example, it is usually not useful to mark
3261 an inline method as hidden without marking the whole class as hidden.
3262
3263 A C++ namespace declaration can also have the visibility attribute.
3264 This attribute applies only to the particular namespace body, not to
3265 other definitions of the same namespace; it is equivalent to using
3266 @samp{#pragma GCC visibility} before and after the namespace
3267 definition (@pxref{Visibility Pragmas}).
3268
3269 In C++, if a template argument has limited visibility, this
3270 restriction is implicitly propagated to the template instantiation.
3271 Otherwise, template instantiations and specializations default to the
3272 visibility of their template.
3273
3274 If both the template and enclosing class have explicit visibility, the
3275 visibility from the template is used.
3276
3277 @item warn_unused_result
3278 @cindex @code{warn_unused_result} attribute
3279 The @code{warn_unused_result} attribute causes a warning to be emitted
3280 if a caller of the function with this attribute does not use its
3281 return value.  This is useful for functions where not checking
3282 the result is either a security problem or always a bug, such as
3283 @code{realloc}.
3284
3285 @smallexample
3286 int fn () __attribute__ ((warn_unused_result));
3287 int foo ()
3288 @{
3289   if (fn () < 0) return -1;
3290   fn ();
3291   return 0;
3292 @}
3293 @end smallexample
3294
3295 results in warning on line 5.
3296
3297 @item weak
3298 @cindex @code{weak} attribute
3299 The @code{weak} attribute causes the declaration to be emitted as a weak
3300 symbol rather than a global.  This is primarily useful in defining
3301 library functions which can be overridden in user code, though it can
3302 also be used with non-function declarations.  Weak symbols are supported
3303 for ELF targets, and also for a.out targets when using the GNU assembler
3304 and linker.
3305
3306 @item weakref
3307 @itemx weakref ("@var{target}")
3308 @cindex @code{weakref} attribute
3309 The @code{weakref} attribute marks a declaration as a weak reference.
3310 Without arguments, it should be accompanied by an @code{alias} attribute
3311 naming the target symbol.  Optionally, the @var{target} may be given as
3312 an argument to @code{weakref} itself.  In either case, @code{weakref}
3313 implicitly marks the declaration as @code{weak}.  Without a
3314 @var{target}, given as an argument to @code{weakref} or to @code{alias},
3315 @code{weakref} is equivalent to @code{weak}.
3316
3317 @smallexample
3318 static int x() __attribute__ ((weakref ("y")));
3319 /* is equivalent to... */
3320 static int x() __attribute__ ((weak, weakref, alias ("y")));
3321 /* and to... */
3322 static int x() __attribute__ ((weakref));
3323 static int x() __attribute__ ((alias ("y")));
3324 @end smallexample
3325
3326 A weak reference is an alias that does not by itself require a
3327 definition to be given for the target symbol.  If the target symbol is
3328 only referenced through weak references, then the becomes a @code{weak}
3329 undefined symbol.  If it is directly referenced, however, then such
3330 strong references prevail, and a definition will be required for the
3331 symbol, not necessarily in the same translation unit.
3332
3333 The effect is equivalent to moving all references to the alias to a
3334 separate translation unit, renaming the alias to the aliased symbol,
3335 declaring it as weak, compiling the two separate translation units and
3336 performing a reloadable link on them.
3337
3338 At present, a declaration to which @code{weakref} is attached can
3339 only be @code{static}.
3340
3341 @end table
3342
3343 You can specify multiple attributes in a declaration by separating them
3344 by commas within the double parentheses or by immediately following an
3345 attribute declaration with another attribute declaration.
3346
3347 @cindex @code{#pragma}, reason for not using
3348 @cindex pragma, reason for not using
3349 Some people object to the @code{__attribute__} feature, suggesting that
3350 ISO C's @code{#pragma} should be used instead.  At the time
3351 @code{__attribute__} was designed, there were two reasons for not doing
3352 this.
3353
3354 @enumerate
3355 @item
3356 It is impossible to generate @code{#pragma} commands from a macro.
3357
3358 @item
3359 There is no telling what the same @code{#pragma} might mean in another
3360 compiler.
3361 @end enumerate
3362
3363 These two reasons applied to almost any application that might have been
3364 proposed for @code{#pragma}.  It was basically a mistake to use
3365 @code{#pragma} for @emph{anything}.
3366
3367 The ISO C99 standard includes @code{_Pragma}, which now allows pragmas
3368 to be generated from macros.  In addition, a @code{#pragma GCC}
3369 namespace is now in use for GCC-specific pragmas.  However, it has been
3370 found convenient to use @code{__attribute__} to achieve a natural
3371 attachment of attributes to their corresponding declarations, whereas
3372 @code{#pragma GCC} is of use for constructs that do not naturally form
3373 part of the grammar.  @xref{Other Directives,,Miscellaneous
3374 Preprocessing Directives, cpp, The GNU C Preprocessor}.
3375
3376 @node Attribute Syntax
3377 @section Attribute Syntax
3378 @cindex attribute syntax
3379
3380 This section describes the syntax with which @code{__attribute__} may be
3381 used, and the constructs to which attribute specifiers bind, for the C
3382 language.  Some details may vary for C++ and Objective-C@.  Because of
3383 infelicities in the grammar for attributes, some forms described here
3384 may not be successfully parsed in all cases.
3385
3386 There are some problems with the semantics of attributes in C++.  For
3387 example, there are no manglings for attributes, although they may affect
3388 code generation, so problems may arise when attributed types are used in
3389 conjunction with templates or overloading.  Similarly, @code{typeid}
3390 does not distinguish between types with different attributes.  Support
3391 for attributes in C++ may be restricted in future to attributes on
3392 declarations only, but not on nested declarators.
3393
3394 @xref{Function Attributes}, for details of the semantics of attributes
3395 applying to functions.  @xref{Variable Attributes}, for details of the
3396 semantics of attributes applying to variables.  @xref{Type Attributes},
3397 for details of the semantics of attributes applying to structure, union
3398 and enumerated types.
3399
3400 An @dfn{attribute specifier} is of the form
3401 @code{__attribute__ ((@var{attribute-list}))}.  An @dfn{attribute list}
3402 is a possibly empty comma-separated sequence of @dfn{attributes}, where
3403 each attribute is one of the following:
3404
3405 @itemize @bullet
3406 @item
3407 Empty.  Empty attributes are ignored.
3408
3409 @item
3410 A word (which may be an identifier such as @code{unused}, or a reserved
3411 word such as @code{const}).
3412
3413 @item
3414 A word, followed by, in parentheses, parameters for the attribute.
3415 These parameters take one of the following forms:
3416
3417 @itemize @bullet
3418 @item
3419 An identifier.  For example, @code{mode} attributes use this form.
3420
3421 @item
3422 An identifier followed by a comma and a non-empty comma-separated list
3423 of expressions.  For example, @code{format} attributes use this form.
3424
3425 @item
3426 A possibly empty comma-separated list of expressions.  For example,
3427 @code{format_arg} attributes use this form with the list being a single
3428 integer constant expression, and @code{alias} attributes use this form
3429 with the list being a single string constant.
3430 @end itemize
3431 @end itemize
3432
3433 An @dfn{attribute specifier list} is a sequence of one or more attribute
3434 specifiers, not separated by any other tokens.
3435
3436 In GNU C, an attribute specifier list may appear after the colon following a
3437 label, other than a @code{case} or @code{default} label.  The only
3438 attribute it makes sense to use after a label is @code{unused}.  This
3439 feature is intended for code generated by programs which contains labels
3440 that may be unused but which is compiled with @option{-Wall}.  It would
3441 not normally be appropriate to use in it human-written code, though it
3442 could be useful in cases where the code that jumps to the label is
3443 contained within an @code{#ifdef} conditional.  GNU C++ only permits
3444 attributes on labels if the attribute specifier is immediately
3445 followed by a semicolon (i.e., the label applies to an empty
3446 statement).  If the semicolon is missing, C++ label attributes are
3447 ambiguous, as it is permissible for a declaration, which could begin
3448 with an attribute list, to be labelled in C++.  Declarations cannot be
3449 labelled in C90 or C99, so the ambiguity does not arise there.
3450
3451 An attribute specifier list may appear as part of a @code{struct},
3452 @code{union} or @code{enum} specifier.  It may go either immediately
3453 after the @code{struct}, @code{union} or @code{enum} keyword, or after
3454 the closing brace.  The former syntax is preferred.
3455 Where attribute specifiers follow the closing brace, they are considered
3456 to relate to the structure, union or enumerated type defined, not to any
3457 enclosing declaration the type specifier appears in, and the type
3458 defined is not complete until after the attribute specifiers.
3459 @c Otherwise, there would be the following problems: a shift/reduce
3460 @c conflict between attributes binding the struct/union/enum and
3461 @c binding to the list of specifiers/qualifiers; and "aligned"
3462 @c attributes could use sizeof for the structure, but the size could be
3463 @c changed later by "packed" attributes.
3464
3465 Otherwise, an attribute specifier appears as part of a declaration,
3466 counting declarations of unnamed parameters and type names, and relates
3467 to that declaration (which may be nested in another declaration, for
3468 example in the case of a parameter declaration), or to a particular declarator
3469 within a declaration.  Where an
3470 attribute specifier is applied to a parameter declared as a function or
3471 an array, it should apply to the function or array rather than the
3472 pointer to which the parameter is implicitly converted, but this is not
3473 yet correctly implemented.
3474
3475 Any list of specifiers and qualifiers at the start of a declaration may
3476 contain attribute specifiers, whether or not such a list may in that
3477 context contain storage class specifiers.  (Some attributes, however,
3478 are essentially in the nature of storage class specifiers, and only make
3479 sense where storage class specifiers may be used; for example,
3480 @code{section}.)  There is one necessary limitation to this syntax: the
3481 first old-style parameter declaration in a function definition cannot
3482 begin with an attribute specifier, because such an attribute applies to
3483 the function instead by syntax described below (which, however, is not
3484 yet implemented in this case).  In some other cases, attribute
3485 specifiers are permitted by this grammar but not yet supported by the
3486 compiler.  All attribute specifiers in this place relate to the
3487 declaration as a whole.  In the obsolescent usage where a type of
3488 @code{int} is implied by the absence of type specifiers, such a list of
3489 specifiers and qualifiers may be an attribute specifier list with no
3490 other specifiers or qualifiers.
3491
3492 At present, the first parameter in a function prototype must have some
3493 type specifier which is not an attribute specifier; this resolves an
3494 ambiguity in the interpretation of @code{void f(int
3495 (__attribute__((foo)) x))}, but is subject to change.  At present, if
3496 the parentheses of a function declarator contain only attributes then
3497 those attributes are ignored, rather than yielding an error or warning
3498 or implying a single parameter of type int, but this is subject to
3499 change.
3500
3501 An attribute specifier list may appear immediately before a declarator
3502 (other than the first) in a comma-separated list of declarators in a
3503 declaration of more than one identifier using a single list of
3504 specifiers and qualifiers.  Such attribute specifiers apply
3505 only to the identifier before whose declarator they appear.  For
3506 example, in
3507
3508 @smallexample
3509 __attribute__((noreturn)) void d0 (void),
3510     __attribute__((format(printf, 1, 2))) d1 (const char *, ...),
3511      d2 (void)
3512 @end smallexample
3513
3514 @noindent
3515 the @code{noreturn} attribute applies to all the functions
3516 declared; the @code{format} attribute only applies to @code{d1}.
3517
3518 An attribute specifier list may appear immediately before the comma,
3519 @code{=} or semicolon terminating the declaration of an identifier other
3520 than a function definition.  Such attribute specifiers apply
3521 to the declared object or function.  Where an
3522 assembler name for an object or function is specified (@pxref{Asm
3523 Labels}), the attribute must follow the @code{asm}
3524 specification.
3525
3526 An attribute specifier list may, in future, be permitted to appear after
3527 the declarator in a function definition (before any old-style parameter
3528 declarations or the function body).
3529
3530 Attribute specifiers may be mixed with type qualifiers appearing inside
3531 the @code{[]} of a parameter array declarator, in the C99 construct by
3532 which such qualifiers are applied to the pointer to which the array is
3533 implicitly converted.  Such attribute specifiers apply to the pointer,
3534 not to the array, but at present this is not implemented and they are
3535 ignored.
3536
3537 An attribute specifier list may appear at the start of a nested
3538 declarator.  At present, there are some limitations in this usage: the
3539 attributes correctly apply to the declarator, but for most individual
3540 attributes the semantics this implies are not implemented.
3541 When attribute specifiers follow the @code{*} of a pointer
3542 declarator, they may be mixed with any type qualifiers present.
3543 The following describes the formal semantics of this syntax.  It will make the
3544 most sense if you are familiar with the formal specification of
3545 declarators in the ISO C standard.
3546
3547 Consider (as in C99 subclause 6.7.5 paragraph 4) a declaration @code{T
3548 D1}, where @code{T} contains declaration specifiers that specify a type
3549 @var{Type} (such as @code{int}) and @code{D1} is a declarator that
3550 contains an identifier @var{ident}.  The type specified for @var{ident}
3551 for derived declarators whose type does not include an attribute
3552 specifier is as in the ISO C standard.
3553
3554 If @code{D1} has the form @code{( @var{attribute-specifier-list} D )},
3555 and the declaration @code{T D} specifies the type
3556 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
3557 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
3558 @var{attribute-specifier-list} @var{Type}'' for @var{ident}.
3559
3560 If @code{D1} has the form @code{*
3561 @var{type-qualifier-and-attribute-specifier-list} D}, and the
3562 declaration @code{T D} specifies the type
3563 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
3564 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
3565 @var{type-qualifier-and-attribute-specifier-list} @var{Type}'' for
3566 @var{ident}.
3567
3568 For example,
3569
3570 @smallexample
3571 void (__attribute__((noreturn)) ****f) (void);
3572 @end smallexample
3573
3574 @noindent
3575 specifies the type ``pointer to pointer to pointer to pointer to
3576 non-returning function returning @code{void}''.  As another example,
3577
3578 @smallexample
3579 char *__attribute__((aligned(8))) *f;
3580 @end smallexample
3581
3582 @noindent
3583 specifies the type ``pointer to 8-byte-aligned pointer to @code{char}''.
3584 Note again that this does not work with most attributes; for example,
3585 the usage of @samp{aligned} and @samp{noreturn} attributes given above