OSDN Git Service

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