OSDN Git Service

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