OSDN Git Service

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