OSDN Git Service

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