OSDN Git Service

e33d604da99f713490168464400105e8f0c3ba07
[pf3gnuchains/gcc-fork.git] / gcc / doc / extend.texi
1 @c Copyright (C) 1988,1989,1992,1993,1994,1996,1998,1999,2000,2001,2002,2003,2004
2 @c Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @node C 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 @smallexample
498 (@{ int y = foo (); int z;
499    if (y > 0) z = y;
500    else z = - y;
501    z; @})
502 @end smallexample
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 @smallexample
520 #define max(a,b) ((a) > (b) ? (a) : (b))
521 @end smallexample
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 @smallexample
531 #define maxint(a,b) \
532   (@{int _a = (a), _b = (b); _a > _b ? _a : _b; @})
533 @end smallexample
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 @smallexample
602 __label__ @var{label};
603 @end smallexample
604
605 @noindent
606 or
607
608 @smallexample
609 __label__ @var{label1}, @var{label2}, /* @r{@dots{}} */;
610 @end smallexample
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 @smallexample
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 smallexample
642
643 This could also be written using a statement-expression:
644
645 @smallexample
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 smallexample
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 @smallexample
679 void *ptr;
680 /* @r{@dots{}} */
681 ptr = &&foo;
682 @end smallexample
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 @smallexample
691 goto *ptr;
692 @end smallexample
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 @smallexample
701 static void *array[] = @{ &&foo, &&bar, &&hack @};
702 @end smallexample
703
704 Then you can select a label with indexing, like this:
705
706 @smallexample
707 goto *array[i];
708 @end smallexample
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 @smallexample
731 static const int array[] = @{ &&foo - &&foo, &&bar - &&foo,
732                              &&hack - &&foo @};
733 goto *(&&foo + array[i]);
734 @end smallexample
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 @smallexample
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 smallexample
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 @smallexample
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 smallexample
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 @smallexample
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 smallexample
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 @smallexample
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 smallexample
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 @smallexample
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 smallexample
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 However, these built-in functions may interact badly with some
888 sophisticated features or other extensions of the language.  It
889 is, therefore, not recommended to use them outside very simple
890 functions acting as mere forwarders for their arguments.
891
892 @deftypefn {Built-in Function} {void *} __builtin_apply_args ()
893 This built-in function returns a pointer to data
894 describing how to perform a call with the same arguments as were passed
895 to the current function.
896
897 The function saves the arg pointer register, structure value address,
898 and all registers that might be used to pass arguments to a function
899 into a block of memory allocated on the stack.  Then it returns the
900 address of that block.
901 @end deftypefn
902
903 @deftypefn {Built-in Function} {void *} __builtin_apply (void (*@var{function})(), void *@var{arguments}, size_t @var{size})
904 This built-in function invokes @var{function}
905 with a copy of the parameters described by @var{arguments}
906 and @var{size}.
907
908 The value of @var{arguments} should be the value returned by
909 @code{__builtin_apply_args}.  The argument @var{size} specifies the size
910 of the stack argument data, in bytes.
911
912 This function returns a pointer to data describing
913 how to return whatever value was returned by @var{function}.  The data
914 is saved in a block of memory allocated on the stack.
915
916 It is not always simple to compute the proper value for @var{size}.  The
917 value is used by @code{__builtin_apply} to compute the amount of data
918 that should be pushed on the stack and copied from the incoming argument
919 area.
920 @end deftypefn
921
922 @deftypefn {Built-in Function} {void} __builtin_return (void *@var{result})
923 This built-in function returns the value described by @var{result} from
924 the containing function.  You should specify, for @var{result}, a value
925 returned by @code{__builtin_apply}.
926 @end deftypefn
927
928 @node Typeof
929 @section Referring to a Type with @code{typeof}
930 @findex typeof
931 @findex sizeof
932 @cindex macros, types of arguments
933
934 Another way to refer to the type of an expression is with @code{typeof}.
935 The syntax of using of this keyword looks like @code{sizeof}, but the
936 construct acts semantically like a type name defined with @code{typedef}.
937
938 There are two ways of writing the argument to @code{typeof}: with an
939 expression or with a type.  Here is an example with an expression:
940
941 @smallexample
942 typeof (x[0](1))
943 @end smallexample
944
945 @noindent
946 This assumes that @code{x} is an array of pointers to functions;
947 the type described is that of the values of the functions.
948
949 Here is an example with a typename as the argument:
950
951 @smallexample
952 typeof (int *)
953 @end smallexample
954
955 @noindent
956 Here the type described is that of pointers to @code{int}.
957
958 If you are writing a header file that must work when included in ISO C
959 programs, write @code{__typeof__} instead of @code{typeof}.
960 @xref{Alternate Keywords}.
961
962 A @code{typeof}-construct can be used anywhere a typedef name could be
963 used.  For example, you can use it in a declaration, in a cast, or inside
964 of @code{sizeof} or @code{typeof}.
965
966 @code{typeof} is often useful in conjunction with the
967 statements-within-expressions feature.  Here is how the two together can
968 be used to define a safe ``maximum'' macro that operates on any
969 arithmetic type and evaluates each of its arguments exactly once:
970
971 @smallexample
972 #define max(a,b) \
973   (@{ typeof (a) _a = (a); \
974       typeof (b) _b = (b); \
975     _a > _b ? _a : _b; @})
976 @end smallexample
977
978 @cindex underscores in variables in macros
979 @cindex @samp{_} in variables in macros
980 @cindex local variables in macros
981 @cindex variables, local, in macros
982 @cindex macros, local variables in
983
984 The reason for using names that start with underscores for the local
985 variables is to avoid conflicts with variable names that occur within the
986 expressions that are substituted for @code{a} and @code{b}.  Eventually we
987 hope to design a new form of declaration syntax that allows you to declare
988 variables whose scopes start only after their initializers; this will be a
989 more reliable way to prevent such conflicts.
990
991 @noindent
992 Some more examples of the use of @code{typeof}:
993
994 @itemize @bullet
995 @item
996 This declares @code{y} with the type of what @code{x} points to.
997
998 @smallexample
999 typeof (*x) y;
1000 @end smallexample
1001
1002 @item
1003 This declares @code{y} as an array of such values.
1004
1005 @smallexample
1006 typeof (*x) y[4];
1007 @end smallexample
1008
1009 @item
1010 This declares @code{y} as an array of pointers to characters:
1011
1012 @smallexample
1013 typeof (typeof (char *)[4]) y;
1014 @end smallexample
1015
1016 @noindent
1017 It is equivalent to the following traditional C declaration:
1018
1019 @smallexample
1020 char *y[4];
1021 @end smallexample
1022
1023 To see the meaning of the declaration using @code{typeof}, and why it
1024 might be a useful way to write, let's rewrite it with these macros:
1025
1026 @smallexample
1027 #define pointer(T)  typeof(T *)
1028 #define array(T, N) typeof(T [N])
1029 @end smallexample
1030
1031 @noindent
1032 Now the declaration can be rewritten this way:
1033
1034 @smallexample
1035 array (pointer (char), 4) y;
1036 @end smallexample
1037
1038 @noindent
1039 Thus, @code{array (pointer (char), 4)} is the type of arrays of 4
1040 pointers to @code{char}.
1041 @end itemize
1042
1043 @emph{Compatibility Note:} In addition to @code{typeof}, GCC 2 supported
1044 a more limited extension which permitted one to write
1045
1046 @smallexample
1047 typedef @var{T} = @var{expr};
1048 @end smallexample
1049
1050 @noindent
1051 with the effect of declaring @var{T} to have the type of the expression
1052 @var{expr}.  This extension does not work with GCC 3 (versions between
1053 3.0 and 3.2 will crash; 3.2.1 and later give an error).  Code which
1054 relies on it should be rewritten to use @code{typeof}:
1055
1056 @smallexample
1057 typedef typeof(@var{expr}) @var{T};
1058 @end smallexample
1059
1060 @noindent
1061 This will work with all versions of GCC@.
1062
1063 @node Lvalues
1064 @section Generalized Lvalues
1065 @cindex compound expressions as lvalues
1066 @cindex expressions, compound, as lvalues
1067 @cindex conditional expressions as lvalues
1068 @cindex expressions, conditional, as lvalues
1069 @cindex casts as lvalues
1070 @cindex generalized lvalues
1071 @cindex lvalues, generalized
1072 @cindex extensions, @code{?:}
1073 @cindex @code{?:} extensions
1074
1075 Compound expressions, conditional expressions and casts are allowed as
1076 lvalues provided their operands are lvalues.  This means that you can take
1077 their addresses or store values into them.  All these extensions are
1078 deprecated.
1079
1080 Standard C++ allows compound expressions and conditional expressions
1081 as lvalues, and permits casts to reference type, so use of this
1082 extension is not supported for C++ code.
1083
1084 For example, a compound expression can be assigned, provided the last
1085 expression in the sequence is an lvalue.  These two expressions are
1086 equivalent:
1087
1088 @smallexample
1089 (a, b) += 5
1090 a, (b += 5)
1091 @end smallexample
1092
1093 Similarly, the address of the compound expression can be taken.  These two
1094 expressions are equivalent:
1095
1096 @smallexample
1097 &(a, b)
1098 a, &b
1099 @end smallexample
1100
1101 A conditional expression is a valid lvalue if its type is not void and the
1102 true and false branches are both valid lvalues.  For example, these two
1103 expressions are equivalent:
1104
1105 @smallexample
1106 (a ? b : c) = 5
1107 (a ? b = 5 : (c = 5))
1108 @end smallexample
1109
1110 A cast is a valid lvalue if its operand is an lvalue.  This extension
1111 is deprecated.  A simple
1112 assignment whose left-hand side is a cast works by converting the
1113 right-hand side first to the specified type, then to the type of the
1114 inner left-hand side expression.  After this is stored, the value is
1115 converted back to the specified type to become the value of the
1116 assignment.  Thus, if @code{a} has type @code{char *}, the following two
1117 expressions are equivalent:
1118
1119 @smallexample
1120 (int)a = 5
1121 (int)(a = (char *)(int)5)
1122 @end smallexample
1123
1124 An assignment-with-arithmetic operation such as @samp{+=} applied to a cast
1125 performs the arithmetic using the type resulting from the cast, and then
1126 continues as in the previous case.  Therefore, these two expressions are
1127 equivalent:
1128
1129 @smallexample
1130 (int)a += 5
1131 (int)(a = (char *)(int) ((int)a + 5))
1132 @end smallexample
1133
1134 You cannot take the address of an lvalue cast, because the use of its
1135 address would not work out coherently.  Suppose that @code{&(int)f} were
1136 permitted, where @code{f} has type @code{float}.  Then the following
1137 statement would try to store an integer bit-pattern where a floating
1138 point number belongs:
1139
1140 @smallexample
1141 *&(int)f = 1;
1142 @end smallexample
1143
1144 This is quite different from what @code{(int)f = 1} would do---that
1145 would convert 1 to floating point and store it.  Rather than cause this
1146 inconsistency, we think it is better to prohibit use of @samp{&} on a cast.
1147
1148 If you really do want an @code{int *} pointer with the address of
1149 @code{f}, you can simply write @code{(int *)&f}.
1150
1151 @node Conditionals
1152 @section Conditionals with Omitted Operands
1153 @cindex conditional expressions, extensions
1154 @cindex omitted middle-operands
1155 @cindex middle-operands, omitted
1156 @cindex extensions, @code{?:}
1157 @cindex @code{?:} extensions
1158
1159 The middle operand in a conditional expression may be omitted.  Then
1160 if the first operand is nonzero, its value is the value of the conditional
1161 expression.
1162
1163 Therefore, the expression
1164
1165 @smallexample
1166 x ? : y
1167 @end smallexample
1168
1169 @noindent
1170 has the value of @code{x} if that is nonzero; otherwise, the value of
1171 @code{y}.
1172
1173 This example is perfectly equivalent to
1174
1175 @smallexample
1176 x ? x : y
1177 @end smallexample
1178
1179 @cindex side effect in ?:
1180 @cindex ?: side effect
1181 @noindent
1182 In this simple case, the ability to omit the middle operand is not
1183 especially useful.  When it becomes useful is when the first operand does,
1184 or may (if it is a macro argument), contain a side effect.  Then repeating
1185 the operand in the middle would perform the side effect twice.  Omitting
1186 the middle operand uses the value already computed without the undesirable
1187 effects of recomputing it.
1188
1189 @node Long Long
1190 @section Double-Word Integers
1191 @cindex @code{long long} data types
1192 @cindex double-word arithmetic
1193 @cindex multiprecision arithmetic
1194 @cindex @code{LL} integer suffix
1195 @cindex @code{ULL} integer suffix
1196
1197 ISO C99 supports data types for integers that are at least 64 bits wide,
1198 and as an extension GCC supports them in C89 mode and in C++.
1199 Simply write @code{long long int} for a signed integer, or
1200 @code{unsigned long long int} for an unsigned integer.  To make an
1201 integer constant of type @code{long long int}, add the suffix @samp{LL}
1202 to the integer.  To make an integer constant of type @code{unsigned long
1203 long int}, add the suffix @samp{ULL} to the integer.
1204
1205 You can use these types in arithmetic like any other integer types.
1206 Addition, subtraction, and bitwise boolean operations on these types
1207 are open-coded on all types of machines.  Multiplication is open-coded
1208 if the machine supports fullword-to-doubleword a widening multiply
1209 instruction.  Division and shifts are open-coded only on machines that
1210 provide special support.  The operations that are not open-coded use
1211 special library routines that come with GCC@.
1212
1213 There may be pitfalls when you use @code{long long} types for function
1214 arguments, unless you declare function prototypes.  If a function
1215 expects type @code{int} for its argument, and you pass a value of type
1216 @code{long long int}, confusion will result because the caller and the
1217 subroutine will disagree about the number of bytes for the argument.
1218 Likewise, if the function expects @code{long long int} and you pass
1219 @code{int}.  The best way to avoid such problems is to use prototypes.
1220
1221 @node Complex
1222 @section Complex Numbers
1223 @cindex complex numbers
1224 @cindex @code{_Complex} keyword
1225 @cindex @code{__complex__} keyword
1226
1227 ISO C99 supports complex floating data types, and as an extension GCC
1228 supports them in C89 mode and in C++, and supports complex integer data
1229 types which are not part of ISO C99.  You can declare complex types
1230 using the keyword @code{_Complex}.  As an extension, the older GNU
1231 keyword @code{__complex__} is also supported.
1232
1233 For example, @samp{_Complex double x;} declares @code{x} as a
1234 variable whose real part and imaginary part are both of type
1235 @code{double}.  @samp{_Complex short int y;} declares @code{y} to
1236 have real and imaginary parts of type @code{short int}; this is not
1237 likely to be useful, but it shows that the set of complex types is
1238 complete.
1239
1240 To write a constant with a complex data type, use the suffix @samp{i} or
1241 @samp{j} (either one; they are equivalent).  For example, @code{2.5fi}
1242 has type @code{_Complex float} and @code{3i} has type
1243 @code{_Complex int}.  Such a constant always has a pure imaginary
1244 value, but you can form any complex value you like by adding one to a
1245 real constant.  This is a GNU extension; if you have an ISO C99
1246 conforming C library (such as GNU libc), and want to construct complex
1247 constants of floating type, you should include @code{<complex.h>} and
1248 use the macros @code{I} or @code{_Complex_I} instead.
1249
1250 @cindex @code{__real__} keyword
1251 @cindex @code{__imag__} keyword
1252 To extract the real part of a complex-valued expression @var{exp}, write
1253 @code{__real__ @var{exp}}.  Likewise, use @code{__imag__} to
1254 extract the imaginary part.  This is a GNU extension; for values of
1255 floating type, you should use the ISO C99 functions @code{crealf},
1256 @code{creal}, @code{creall}, @code{cimagf}, @code{cimag} and
1257 @code{cimagl}, declared in @code{<complex.h>} and also provided as
1258 built-in functions by GCC@.
1259
1260 @cindex complex conjugation
1261 The operator @samp{~} performs complex conjugation when used on a value
1262 with a complex type.  This is a GNU extension; for values of
1263 floating type, you should use the ISO C99 functions @code{conjf},
1264 @code{conj} and @code{conjl}, declared in @code{<complex.h>} and also
1265 provided as built-in functions by GCC@.
1266
1267 GCC can allocate complex automatic variables in a noncontiguous
1268 fashion; it's even possible for the real part to be in a register while
1269 the imaginary part is on the stack (or vice-versa).  Only the DWARF2
1270 debug info format can represent this, so use of DWARF2 is recommended.
1271 If you are using the stabs debug info format, GCC describes a noncontiguous
1272 complex variable as if it were two separate variables of noncomplex type.
1273 If the variable's actual name is @code{foo}, the two fictitious
1274 variables are named @code{foo$real} and @code{foo$imag}.  You can
1275 examine and set these two fictitious variables with your debugger.
1276
1277 @node Hex Floats
1278 @section Hex Floats
1279 @cindex hex floats
1280
1281 ISO C99 supports floating-point numbers written not only in the usual
1282 decimal notation, such as @code{1.55e1}, but also numbers such as
1283 @code{0x1.fp3} written in hexadecimal format.  As a GNU extension, GCC
1284 supports this in C89 mode (except in some cases when strictly
1285 conforming) and in C++.  In that format the
1286 @samp{0x} hex introducer and the @samp{p} or @samp{P} exponent field are
1287 mandatory.  The exponent is a decimal number that indicates the power of
1288 2 by which the significant part will be multiplied.  Thus @samp{0x1.f} is
1289 @tex
1290 $1 {15\over16}$,
1291 @end tex
1292 @ifnottex
1293 1 15/16,
1294 @end ifnottex
1295 @samp{p3} multiplies it by 8, and the value of @code{0x1.fp3}
1296 is the same as @code{1.55e1}.
1297
1298 Unlike for floating-point numbers in the decimal notation the exponent
1299 is always required in the hexadecimal notation.  Otherwise the compiler
1300 would not be able to resolve the ambiguity of, e.g., @code{0x1.f}.  This
1301 could mean @code{1.0f} or @code{1.9375} since @samp{f} is also the
1302 extension for floating-point constants of type @code{float}.
1303
1304 @node Zero Length
1305 @section Arrays of Length Zero
1306 @cindex arrays of length zero
1307 @cindex zero-length arrays
1308 @cindex length-zero arrays
1309 @cindex flexible array members
1310
1311 Zero-length arrays are allowed in GNU C@.  They are very useful as the
1312 last element of a structure which is really a header for a variable-length
1313 object:
1314
1315 @smallexample
1316 struct line @{
1317   int length;
1318   char contents[0];
1319 @};
1320
1321 struct line *thisline = (struct line *)
1322   malloc (sizeof (struct line) + this_length);
1323 thisline->length = this_length;
1324 @end smallexample
1325
1326 In ISO C90, you would have to give @code{contents} a length of 1, which
1327 means either you waste space or complicate the argument to @code{malloc}.
1328
1329 In ISO C99, you would use a @dfn{flexible array member}, which is
1330 slightly different in syntax and semantics:
1331
1332 @itemize @bullet
1333 @item
1334 Flexible array members are written as @code{contents[]} without
1335 the @code{0}.
1336
1337 @item
1338 Flexible array members have incomplete type, and so the @code{sizeof}
1339 operator may not be applied.  As a quirk of the original implementation
1340 of zero-length arrays, @code{sizeof} evaluates to zero.
1341
1342 @item
1343 Flexible array members may only appear as the last member of a
1344 @code{struct} that is otherwise non-empty.
1345
1346 @item
1347 A structure containing a flexible array member, or a union containing
1348 such a structure (possibly recursively), may not be a member of a
1349 structure or an element of an array.  (However, these uses are
1350 permitted by GCC as extensions.)
1351 @end itemize
1352
1353 GCC versions before 3.0 allowed zero-length arrays to be statically
1354 initialized, as if they were flexible arrays.  In addition to those
1355 cases that were useful, it also allowed initializations in situations
1356 that would corrupt later data.  Non-empty initialization of zero-length
1357 arrays is now treated like any case where there are more initializer
1358 elements than the array holds, in that a suitable warning about "excess
1359 elements in array" is given, and the excess elements (all of them, in
1360 this case) are ignored.
1361
1362 Instead GCC allows static initialization of flexible array members.
1363 This is equivalent to defining a new structure containing the original
1364 structure followed by an array of sufficient size to contain the data.
1365 I.e.@: in the following, @code{f1} is constructed as if it were declared
1366 like @code{f2}.
1367
1368 @smallexample
1369 struct f1 @{
1370   int x; int y[];
1371 @} f1 = @{ 1, @{ 2, 3, 4 @} @};
1372
1373 struct f2 @{
1374   struct f1 f1; int data[3];
1375 @} f2 = @{ @{ 1 @}, @{ 2, 3, 4 @} @};
1376 @end smallexample
1377
1378 @noindent
1379 The convenience of this extension is that @code{f1} has the desired
1380 type, eliminating the need to consistently refer to @code{f2.f1}.
1381
1382 This has symmetry with normal static arrays, in that an array of
1383 unknown size is also written with @code{[]}.
1384
1385 Of course, this extension only makes sense if the extra data comes at
1386 the end of a top-level object, as otherwise we would be overwriting
1387 data at subsequent offsets.  To avoid undue complication and confusion
1388 with initialization of deeply nested arrays, we simply disallow any
1389 non-empty initialization except when the structure is the top-level
1390 object.  For example:
1391
1392 @smallexample
1393 struct foo @{ int x; int y[]; @};
1394 struct bar @{ struct foo z; @};
1395
1396 struct foo a = @{ 1, @{ 2, 3, 4 @} @};        // @r{Valid.}
1397 struct bar b = @{ @{ 1, @{ 2, 3, 4 @} @} @};    // @r{Invalid.}
1398 struct bar c = @{ @{ 1, @{ @} @} @};            // @r{Valid.}
1399 struct foo d[1] = @{ @{ 1 @{ 2, 3, 4 @} @} @};  // @r{Invalid.}
1400 @end smallexample
1401
1402 @node Empty Structures
1403 @section Structures With No Members
1404 @cindex empty structures
1405 @cindex zero-size structures
1406
1407 GCC permits a C structure to have no members:
1408
1409 @smallexample
1410 struct empty @{
1411 @};
1412 @end smallexample
1413
1414 The structure will have size zero.  In C++, empty structures are part
1415 of the language.  G++ treats empty structures as if they had a single
1416 member of type @code{char}.
1417
1418 @node Variable Length
1419 @section Arrays of Variable Length
1420 @cindex variable-length arrays
1421 @cindex arrays of variable length
1422 @cindex VLAs
1423
1424 Variable-length automatic arrays are allowed in ISO C99, and as an
1425 extension GCC accepts them in C89 mode and in C++.  (However, GCC's
1426 implementation of variable-length arrays does not yet conform in detail
1427 to the ISO C99 standard.)  These arrays are
1428 declared like any other automatic arrays, but with a length that is not
1429 a constant expression.  The storage is allocated at the point of
1430 declaration and deallocated when the brace-level is exited.  For
1431 example:
1432
1433 @smallexample
1434 FILE *
1435 concat_fopen (char *s1, char *s2, char *mode)
1436 @{
1437   char str[strlen (s1) + strlen (s2) + 1];
1438   strcpy (str, s1);
1439   strcat (str, s2);
1440   return fopen (str, mode);
1441 @}
1442 @end smallexample
1443
1444 @cindex scope of a variable length array
1445 @cindex variable-length array scope
1446 @cindex deallocating variable length arrays
1447 Jumping or breaking out of the scope of the array name deallocates the
1448 storage.  Jumping into the scope is not allowed; you get an error
1449 message for it.
1450
1451 @cindex @code{alloca} vs variable-length arrays
1452 You can use the function @code{alloca} to get an effect much like
1453 variable-length arrays.  The function @code{alloca} is available in
1454 many other C implementations (but not in all).  On the other hand,
1455 variable-length arrays are more elegant.
1456
1457 There are other differences between these two methods.  Space allocated
1458 with @code{alloca} exists until the containing @emph{function} returns.
1459 The space for a variable-length array is deallocated as soon as the array
1460 name's scope ends.  (If you use both variable-length arrays and
1461 @code{alloca} in the same function, deallocation of a variable-length array
1462 will also deallocate anything more recently allocated with @code{alloca}.)
1463
1464 You can also use variable-length arrays as arguments to functions:
1465
1466 @smallexample
1467 struct entry
1468 tester (int len, char data[len][len])
1469 @{
1470   /* @r{@dots{}} */
1471 @}
1472 @end smallexample
1473
1474 The length of an array is computed once when the storage is allocated
1475 and is remembered for the scope of the array in case you access it with
1476 @code{sizeof}.
1477
1478 If you want to pass the array first and the length afterward, you can
1479 use a forward declaration in the parameter list---another GNU extension.
1480
1481 @smallexample
1482 struct entry
1483 tester (int len; char data[len][len], int len)
1484 @{
1485   /* @r{@dots{}} */
1486 @}
1487 @end smallexample
1488
1489 @cindex parameter forward declaration
1490 The @samp{int len} before the semicolon is a @dfn{parameter forward
1491 declaration}, and it serves the purpose of making the name @code{len}
1492 known when the declaration of @code{data} is parsed.
1493
1494 You can write any number of such parameter forward declarations in the
1495 parameter list.  They can be separated by commas or semicolons, but the
1496 last one must end with a semicolon, which is followed by the ``real''
1497 parameter declarations.  Each forward declaration must match a ``real''
1498 declaration in parameter name and data type.  ISO C99 does not support
1499 parameter forward declarations.
1500
1501 @node Variadic Macros
1502 @section Macros with a Variable Number of Arguments.
1503 @cindex variable number of arguments
1504 @cindex macro with variable arguments
1505 @cindex rest argument (in macro)
1506 @cindex variadic macros
1507
1508 In the ISO C standard of 1999, a macro can be declared to accept a
1509 variable number of arguments much as a function can.  The syntax for
1510 defining the macro is similar to that of a function.  Here is an
1511 example:
1512
1513 @smallexample
1514 #define debug(format, ...) fprintf (stderr, format, __VA_ARGS__)
1515 @end smallexample
1516
1517 Here @samp{@dots{}} is a @dfn{variable argument}.  In the invocation of
1518 such a macro, it represents the zero or more tokens until the closing
1519 parenthesis that ends the invocation, including any commas.  This set of
1520 tokens replaces the identifier @code{__VA_ARGS__} in the macro body
1521 wherever it appears.  See the CPP manual for more information.
1522
1523 GCC has long supported variadic macros, and used a different syntax that
1524 allowed you to give a name to the variable arguments just like any other
1525 argument.  Here is an example:
1526
1527 @smallexample
1528 #define debug(format, args...) fprintf (stderr, format, args)
1529 @end smallexample
1530
1531 This is in all ways equivalent to the ISO C example above, but arguably
1532 more readable and descriptive.
1533
1534 GNU CPP has two further variadic macro extensions, and permits them to
1535 be used with either of the above forms of macro definition.
1536
1537 In standard C, you are not allowed to leave the variable argument out
1538 entirely; but you are allowed to pass an empty argument.  For example,
1539 this invocation is invalid in ISO C, because there is no comma after
1540 the string:
1541
1542 @smallexample
1543 debug ("A message")
1544 @end smallexample
1545
1546 GNU CPP permits you to completely omit the variable arguments in this
1547 way.  In the above examples, the compiler would complain, though since
1548 the expansion of the macro still has the extra comma after the format
1549 string.
1550
1551 To help solve this problem, CPP behaves specially for variable arguments
1552 used with the token paste operator, @samp{##}.  If instead you write
1553
1554 @smallexample
1555 #define debug(format, ...) fprintf (stderr, format, ## __VA_ARGS__)
1556 @end smallexample
1557
1558 and if the variable arguments are omitted or empty, the @samp{##}
1559 operator causes the preprocessor to remove the comma before it.  If you
1560 do provide some variable arguments in your macro invocation, GNU CPP
1561 does not complain about the paste operation and instead places the
1562 variable arguments after the comma.  Just like any other pasted macro
1563 argument, these arguments are not macro expanded.
1564
1565 @node Escaped Newlines
1566 @section Slightly Looser Rules for Escaped Newlines
1567 @cindex escaped newlines
1568 @cindex newlines (escaped)
1569
1570 Recently, the preprocessor has relaxed its treatment of escaped
1571 newlines.  Previously, the newline had to immediately follow a
1572 backslash.  The current implementation allows whitespace in the form
1573 of spaces, horizontal and vertical tabs, and form feeds between the
1574 backslash and the subsequent newline.  The preprocessor issues a
1575 warning, but treats it as a valid escaped newline and combines the two
1576 lines to form a single logical line.  This works within comments and
1577 tokens, as well as between tokens.  Comments are @emph{not} treated as
1578 whitespace for the purposes of this relaxation, since they have not
1579 yet been replaced with spaces.
1580
1581 @node Subscripting
1582 @section Non-Lvalue Arrays May Have Subscripts
1583 @cindex subscripting
1584 @cindex arrays, non-lvalue
1585
1586 @cindex subscripting and function values
1587 In ISO C99, arrays that are not lvalues still decay to pointers, and
1588 may be subscripted, although they may not be modified or used after
1589 the next sequence point and the unary @samp{&} operator may not be
1590 applied to them.  As an extension, GCC allows such arrays to be
1591 subscripted in C89 mode, though otherwise they do not decay to
1592 pointers outside C99 mode.  For example,
1593 this is valid in GNU C though not valid in C89:
1594
1595 @smallexample
1596 @group
1597 struct foo @{int a[4];@};
1598
1599 struct foo f();
1600
1601 bar (int index)
1602 @{
1603   return f().a[index];
1604 @}
1605 @end group
1606 @end smallexample
1607
1608 @node Pointer Arith
1609 @section Arithmetic on @code{void}- and Function-Pointers
1610 @cindex void pointers, arithmetic
1611 @cindex void, size of pointer to
1612 @cindex function pointers, arithmetic
1613 @cindex function, size of pointer to
1614
1615 In GNU C, addition and subtraction operations are supported on pointers to
1616 @code{void} and on pointers to functions.  This is done by treating the
1617 size of a @code{void} or of a function as 1.
1618
1619 A consequence of this is that @code{sizeof} is also allowed on @code{void}
1620 and on function types, and returns 1.
1621
1622 @opindex Wpointer-arith
1623 The option @option{-Wpointer-arith} requests a warning if these extensions
1624 are used.
1625
1626 @node Initializers
1627 @section Non-Constant Initializers
1628 @cindex initializers, non-constant
1629 @cindex non-constant initializers
1630
1631 As in standard C++ and ISO C99, the elements of an aggregate initializer for an
1632 automatic variable are not required to be constant expressions in GNU C@.
1633 Here is an example of an initializer with run-time varying elements:
1634
1635 @smallexample
1636 foo (float f, float g)
1637 @{
1638   float beat_freqs[2] = @{ f-g, f+g @};
1639   /* @r{@dots{}} */
1640 @}
1641 @end smallexample
1642
1643 @node Compound Literals
1644 @section Compound Literals
1645 @cindex constructor expressions
1646 @cindex initializations in expressions
1647 @cindex structures, constructor expression
1648 @cindex expressions, constructor
1649 @cindex compound literals
1650 @c The GNU C name for what C99 calls compound literals was "constructor expressions".
1651
1652 ISO C99 supports compound literals.  A compound literal looks like
1653 a cast containing an initializer.  Its value is an object of the
1654 type specified in the cast, containing the elements specified in
1655 the initializer; it is an lvalue.  As an extension, GCC supports
1656 compound literals in C89 mode and in C++.
1657
1658 Usually, the specified type is a structure.  Assume that
1659 @code{struct foo} and @code{structure} are declared as shown:
1660
1661 @smallexample
1662 struct foo @{int a; char b[2];@} structure;
1663 @end smallexample
1664
1665 @noindent
1666 Here is an example of constructing a @code{struct foo} with a compound literal:
1667
1668 @smallexample
1669 structure = ((struct foo) @{x + y, 'a', 0@});
1670 @end smallexample
1671
1672 @noindent
1673 This is equivalent to writing the following:
1674
1675 @smallexample
1676 @{
1677   struct foo temp = @{x + y, 'a', 0@};
1678   structure = temp;
1679 @}
1680 @end smallexample
1681
1682 You can also construct an array.  If all the elements of the compound literal
1683 are (made up of) simple constant expressions, suitable for use in
1684 initializers of objects of static storage duration, then the compound
1685 literal can be coerced to a pointer to its first element and used in
1686 such an initializer, as shown here:
1687
1688 @smallexample
1689 char **foo = (char *[]) @{ "x", "y", "z" @};
1690 @end smallexample
1691
1692 Compound literals for scalar types and union types are is
1693 also allowed, but then the compound literal is equivalent
1694 to a cast.
1695
1696 As a GNU extension, GCC allows initialization of objects with static storage
1697 duration by compound literals (which is not possible in ISO C99, because
1698 the initializer is not a constant).
1699 It is handled as if the object was initialized only with the bracket
1700 enclosed list if compound literal's and object types match.
1701 The initializer list of the compound literal must be constant.
1702 If the object being initialized has array type of unknown size, the size is
1703 determined by compound literal size.
1704
1705 @smallexample
1706 static struct foo x = (struct foo) @{1, 'a', 'b'@};
1707 static int y[] = (int []) @{1, 2, 3@};
1708 static int z[] = (int [3]) @{1@};
1709 @end smallexample
1710
1711 @noindent
1712 The above lines are equivalent to the following:
1713 @smallexample
1714 static struct foo x = @{1, 'a', 'b'@};
1715 static int y[] = @{1, 2, 3@};
1716 static int z[] = @{1, 0, 0@};
1717 @end smallexample
1718
1719 @node Designated Inits
1720 @section Designated Initializers
1721 @cindex initializers with labeled elements
1722 @cindex labeled elements in initializers
1723 @cindex case labels in initializers
1724 @cindex designated initializers
1725
1726 Standard C89 requires the elements of an initializer to appear in a fixed
1727 order, the same as the order of the elements in the array or structure
1728 being initialized.
1729
1730 In ISO C99 you can give the elements in any order, specifying the array
1731 indices or structure field names they apply to, and GNU C allows this as
1732 an extension in C89 mode as well.  This extension is not
1733 implemented in GNU C++.
1734
1735 To specify an array index, write
1736 @samp{[@var{index}] =} before the element value.  For example,
1737
1738 @smallexample
1739 int a[6] = @{ [4] = 29, [2] = 15 @};
1740 @end smallexample
1741
1742 @noindent
1743 is equivalent to
1744
1745 @smallexample
1746 int a[6] = @{ 0, 0, 15, 0, 29, 0 @};
1747 @end smallexample
1748
1749 @noindent
1750 The index values must be constant expressions, even if the array being
1751 initialized is automatic.
1752
1753 An alternative syntax for this which has been obsolete since GCC 2.5 but
1754 GCC still accepts is to write @samp{[@var{index}]} before the element
1755 value, with no @samp{=}.
1756
1757 To initialize a range of elements to the same value, write
1758 @samp{[@var{first} ... @var{last}] = @var{value}}.  This is a GNU
1759 extension.  For example,
1760
1761 @smallexample
1762 int widths[] = @{ [0 ... 9] = 1, [10 ... 99] = 2, [100] = 3 @};
1763 @end smallexample
1764
1765 @noindent
1766 If the value in it has side-effects, the side-effects will happen only once,
1767 not for each initialized field by the range initializer.
1768
1769 @noindent
1770 Note that the length of the array is the highest value specified
1771 plus one.
1772
1773 In a structure initializer, specify the name of a field to initialize
1774 with @samp{.@var{fieldname} =} before the element value.  For example,
1775 given the following structure,
1776
1777 @smallexample
1778 struct point @{ int x, y; @};
1779 @end smallexample
1780
1781 @noindent
1782 the following initialization
1783
1784 @smallexample
1785 struct point p = @{ .y = yvalue, .x = xvalue @};
1786 @end smallexample
1787
1788 @noindent
1789 is equivalent to
1790
1791 @smallexample
1792 struct point p = @{ xvalue, yvalue @};
1793 @end smallexample
1794
1795 Another syntax which has the same meaning, obsolete since GCC 2.5, is
1796 @samp{@var{fieldname}:}, as shown here:
1797
1798 @smallexample
1799 struct point p = @{ y: yvalue, x: xvalue @};
1800 @end smallexample
1801
1802 @cindex designators
1803 The @samp{[@var{index}]} or @samp{.@var{fieldname}} is known as a
1804 @dfn{designator}.  You can also use a designator (or the obsolete colon
1805 syntax) when initializing a union, to specify which element of the union
1806 should be used.  For example,
1807
1808 @smallexample
1809 union foo @{ int i; double d; @};
1810
1811 union foo f = @{ .d = 4 @};
1812 @end smallexample
1813
1814 @noindent
1815 will convert 4 to a @code{double} to store it in the union using
1816 the second element.  By contrast, casting 4 to type @code{union foo}
1817 would store it into the union as the integer @code{i}, since it is
1818 an integer.  (@xref{Cast to Union}.)
1819
1820 You can combine this technique of naming elements with ordinary C
1821 initialization of successive elements.  Each initializer element that
1822 does not have a designator applies to the next consecutive element of the
1823 array or structure.  For example,
1824
1825 @smallexample
1826 int a[6] = @{ [1] = v1, v2, [4] = v4 @};
1827 @end smallexample
1828
1829 @noindent
1830 is equivalent to
1831
1832 @smallexample
1833 int a[6] = @{ 0, v1, v2, 0, v4, 0 @};
1834 @end smallexample
1835
1836 Labeling the elements of an array initializer is especially useful
1837 when the indices are characters or belong to an @code{enum} type.
1838 For example:
1839
1840 @smallexample
1841 int whitespace[256]
1842   = @{ [' '] = 1, ['\t'] = 1, ['\h'] = 1,
1843       ['\f'] = 1, ['\n'] = 1, ['\r'] = 1 @};
1844 @end smallexample
1845
1846 @cindex designator lists
1847 You can also write a series of @samp{.@var{fieldname}} and
1848 @samp{[@var{index}]} designators before an @samp{=} to specify a
1849 nested subobject to initialize; the list is taken relative to the
1850 subobject corresponding to the closest surrounding brace pair.  For
1851 example, with the @samp{struct point} declaration above:
1852
1853 @smallexample
1854 struct point ptarray[10] = @{ [2].y = yv2, [2].x = xv2, [0].x = xv0 @};
1855 @end smallexample
1856
1857 @noindent
1858 If the same field is initialized multiple times, it will have value from
1859 the last initialization.  If any such overridden initialization has
1860 side-effect, it is unspecified whether the side-effect happens or not.
1861 Currently, gcc will discard them and issue a warning.
1862
1863 @node Case Ranges
1864 @section Case Ranges
1865 @cindex case ranges
1866 @cindex ranges in case statements
1867
1868 You can specify a range of consecutive values in a single @code{case} label,
1869 like this:
1870
1871 @smallexample
1872 case @var{low} ... @var{high}:
1873 @end smallexample
1874
1875 @noindent
1876 This has the same effect as the proper number of individual @code{case}
1877 labels, one for each integer value from @var{low} to @var{high}, inclusive.
1878
1879 This feature is especially useful for ranges of ASCII character codes:
1880
1881 @smallexample
1882 case 'A' ... 'Z':
1883 @end smallexample
1884
1885 @strong{Be careful:} Write spaces around the @code{...}, for otherwise
1886 it may be parsed wrong when you use it with integer values.  For example,
1887 write this:
1888
1889 @smallexample
1890 case 1 ... 5:
1891 @end smallexample
1892
1893 @noindent
1894 rather than this:
1895
1896 @smallexample
1897 case 1...5:
1898 @end smallexample
1899
1900 @node Cast to Union
1901 @section Cast to a Union Type
1902 @cindex cast to a union
1903 @cindex union, casting to a
1904
1905 A cast to union type is similar to other casts, except that the type
1906 specified is a union type.  You can specify the type either with
1907 @code{union @var{tag}} or with a typedef name.  A cast to union is actually
1908 a constructor though, not a cast, and hence does not yield an lvalue like
1909 normal casts.  (@xref{Compound Literals}.)
1910
1911 The types that may be cast to the union type are those of the members
1912 of the union.  Thus, given the following union and variables:
1913
1914 @smallexample
1915 union foo @{ int i; double d; @};
1916 int x;
1917 double y;
1918 @end smallexample
1919
1920 @noindent
1921 both @code{x} and @code{y} can be cast to type @code{union foo}.
1922
1923 Using the cast as the right-hand side of an assignment to a variable of
1924 union type is equivalent to storing in a member of the union:
1925
1926 @smallexample
1927 union foo u;
1928 /* @r{@dots{}} */
1929 u = (union foo) x  @equiv{}  u.i = x
1930 u = (union foo) y  @equiv{}  u.d = y
1931 @end smallexample
1932
1933 You can also use the union cast as a function argument:
1934
1935 @smallexample
1936 void hack (union foo);
1937 /* @r{@dots{}} */
1938 hack ((union foo) x);
1939 @end smallexample
1940
1941 @node Mixed Declarations
1942 @section Mixed Declarations and Code
1943 @cindex mixed declarations and code
1944 @cindex declarations, mixed with code
1945 @cindex code, mixed with declarations
1946
1947 ISO C99 and ISO C++ allow declarations and code to be freely mixed
1948 within compound statements.  As an extension, GCC also allows this in
1949 C89 mode.  For example, you could do:
1950
1951 @smallexample
1952 int i;
1953 /* @r{@dots{}} */
1954 i++;
1955 int j = i + 2;
1956 @end smallexample
1957
1958 Each identifier is visible from where it is declared until the end of
1959 the enclosing block.
1960
1961 @node Function Attributes
1962 @section Declaring Attributes of Functions
1963 @cindex function attributes
1964 @cindex declaring attributes of functions
1965 @cindex functions that never return
1966 @cindex functions that have no side effects
1967 @cindex functions in arbitrary sections
1968 @cindex functions that behave like malloc
1969 @cindex @code{volatile} applied to function
1970 @cindex @code{const} applied to function
1971 @cindex functions with @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style arguments
1972 @cindex functions with non-null pointer arguments
1973 @cindex functions that are passed arguments in registers on the 386
1974 @cindex functions that pop the argument stack on the 386
1975 @cindex functions that do not pop the argument stack on the 386
1976
1977 In GNU C, you declare certain things about functions called in your program
1978 which help the compiler optimize function calls and check your code more
1979 carefully.
1980
1981 The keyword @code{__attribute__} allows you to specify special
1982 attributes when making a declaration.  This keyword is followed by an
1983 attribute specification inside double parentheses.  The following
1984 attributes are currently defined for functions on all targets:
1985 @code{noreturn}, @code{noinline}, @code{always_inline},
1986 @code{pure}, @code{const}, @code{nothrow},
1987 @code{format}, @code{format_arg}, @code{no_instrument_function},
1988 @code{section}, @code{constructor}, @code{destructor}, @code{used},
1989 @code{unused}, @code{deprecated}, @code{weak}, @code{malloc},
1990 @code{alias}, @code{warn_unused_result} and @code{nonnull}.  Several other
1991 attributes are defined for functions on particular target systems.  Other
1992 attributes, including @code{section} are supported for variables declarations
1993 (@pxref{Variable Attributes}) and for types (@pxref{Type Attributes}).
1994
1995 You may also specify attributes with @samp{__} preceding and following
1996 each keyword.  This allows you to use them in header files without
1997 being concerned about a possible macro of the same name.  For example,
1998 you may use @code{__noreturn__} instead of @code{noreturn}.
1999
2000 @xref{Attribute Syntax}, for details of the exact syntax for using
2001 attributes.
2002
2003 @table @code
2004 @cindex @code{noreturn} function attribute
2005 @item noreturn
2006 A few standard library functions, such as @code{abort} and @code{exit},
2007 cannot return.  GCC knows this automatically.  Some programs define
2008 their own functions that never return.  You can declare them
2009 @code{noreturn} to tell the compiler this fact.  For example,
2010
2011 @smallexample
2012 @group
2013 void fatal () __attribute__ ((noreturn));
2014
2015 void
2016 fatal (/* @r{@dots{}} */)
2017 @{
2018   /* @r{@dots{}} */ /* @r{Print error message.} */ /* @r{@dots{}} */
2019   exit (1);
2020 @}
2021 @end group
2022 @end smallexample
2023
2024 The @code{noreturn} keyword tells the compiler to assume that
2025 @code{fatal} cannot return.  It can then optimize without regard to what
2026 would happen if @code{fatal} ever did return.  This makes slightly
2027 better code.  More importantly, it helps avoid spurious warnings of
2028 uninitialized variables.
2029
2030 The @code{noreturn} keyword does not affect the exceptional path when that
2031 applies: a @code{noreturn}-marked function may still return to the caller
2032 by throwing an exception.
2033
2034 Do not assume that registers saved by the calling function are
2035 restored before calling the @code{noreturn} function.
2036
2037 It does not make sense for a @code{noreturn} function to have a return
2038 type other than @code{void}.
2039
2040 The attribute @code{noreturn} is not implemented in GCC versions
2041 earlier than 2.5.  An alternative way to declare that a function does
2042 not return, which works in the current version and in some older
2043 versions, is as follows:
2044
2045 @smallexample
2046 typedef void voidfn ();
2047
2048 volatile voidfn fatal;
2049 @end smallexample
2050
2051 @cindex @code{noinline} function attribute
2052 @item noinline
2053 This function attribute prevents a function from being considered for
2054 inlining.
2055
2056 @cindex @code{always_inline} function attribute
2057 @item always_inline
2058 Generally, functions are not inlined unless optimization is specified.
2059 For functions declared inline, this attribute inlines the function even
2060 if no optimization level was specified.
2061
2062 @cindex @code{pure} function attribute
2063 @item pure
2064 Many functions have no effects except the return value and their
2065 return value depends only on the parameters and/or global variables.
2066 Such a function can be subject
2067 to common subexpression elimination and loop optimization just as an
2068 arithmetic operator would be.  These functions should be declared
2069 with the attribute @code{pure}.  For example,
2070
2071 @smallexample
2072 int square (int) __attribute__ ((pure));
2073 @end smallexample
2074
2075 @noindent
2076 says that the hypothetical function @code{square} is safe to call
2077 fewer times than the program says.
2078
2079 Some of common examples of pure functions are @code{strlen} or @code{memcmp}.
2080 Interesting non-pure functions are functions with infinite loops or those
2081 depending on volatile memory or other system resource, that may change between
2082 two consecutive calls (such as @code{feof} in a multithreading environment).
2083
2084 The attribute @code{pure} is not implemented in GCC versions earlier
2085 than 2.96.
2086 @cindex @code{const} function attribute
2087 @item const
2088 Many functions do not examine any values except their arguments, and
2089 have no effects except the return value.  Basically this is just slightly
2090 more strict class than the @code{pure} attribute above, since function is not
2091 allowed to read global memory.
2092
2093 @cindex pointer arguments
2094 Note that a function that has pointer arguments and examines the data
2095 pointed to must @emph{not} be declared @code{const}.  Likewise, a
2096 function that calls a non-@code{const} function usually must not be
2097 @code{const}.  It does not make sense for a @code{const} function to
2098 return @code{void}.
2099
2100 The attribute @code{const} is not implemented in GCC versions earlier
2101 than 2.5.  An alternative way to declare that a function has no side
2102 effects, which works in the current version and in some older versions,
2103 is as follows:
2104
2105 @smallexample
2106 typedef int intfn ();
2107
2108 extern const intfn square;
2109 @end smallexample
2110
2111 This approach does not work in GNU C++ from 2.6.0 on, since the language
2112 specifies that the @samp{const} must be attached to the return value.
2113
2114 @cindex @code{nothrow} function attribute
2115 @item nothrow
2116 The @code{nothrow} attribute is used to inform the compiler that a
2117 function cannot throw an exception.  For example, most functions in
2118 the standard C library can be guaranteed not to throw an exception
2119 with the notable exceptions of @code{qsort} and @code{bsearch} that
2120 take function pointer arguments.  The @code{nothrow} attribute is not
2121 implemented in GCC versions earlier than 3.2.
2122
2123 @item format (@var{archetype}, @var{string-index}, @var{first-to-check})
2124 @cindex @code{format} function attribute
2125 @opindex Wformat
2126 The @code{format} attribute specifies that a function takes @code{printf},
2127 @code{scanf}, @code{strftime} or @code{strfmon} style arguments which
2128 should be type-checked against a format string.  For example, the
2129 declaration:
2130
2131 @smallexample
2132 extern int
2133 my_printf (void *my_object, const char *my_format, ...)
2134       __attribute__ ((format (printf, 2, 3)));
2135 @end smallexample
2136
2137 @noindent
2138 causes the compiler to check the arguments in calls to @code{my_printf}
2139 for consistency with the @code{printf} style format string argument
2140 @code{my_format}.
2141
2142 The parameter @var{archetype} determines how the format string is
2143 interpreted, and should be @code{printf}, @code{scanf}, @code{strftime}
2144 or @code{strfmon}.  (You can also use @code{__printf__},
2145 @code{__scanf__}, @code{__strftime__} or @code{__strfmon__}.)  The
2146 parameter @var{string-index} specifies which argument is the format
2147 string argument (starting from 1), while @var{first-to-check} is the
2148 number of the first argument to check against the format string.  For
2149 functions where the arguments are not available to be checked (such as
2150 @code{vprintf}), specify the third parameter as zero.  In this case the
2151 compiler only checks the format string for consistency.  For
2152 @code{strftime} formats, the third parameter is required to be zero.
2153 Since non-static C++ methods have an implicit @code{this} argument, the
2154 arguments of such methods should be counted from two, not one, when
2155 giving values for @var{string-index} and @var{first-to-check}.
2156
2157 In the example above, the format string (@code{my_format}) is the second
2158 argument of the function @code{my_print}, and the arguments to check
2159 start with the third argument, so the correct parameters for the format
2160 attribute are 2 and 3.
2161
2162 @opindex ffreestanding
2163 The @code{format} attribute allows you to identify your own functions
2164 which take format strings as arguments, so that GCC can check the
2165 calls to these functions for errors.  The compiler always (unless
2166 @option{-ffreestanding} is used) checks formats
2167 for the standard library functions @code{printf}, @code{fprintf},
2168 @code{sprintf}, @code{scanf}, @code{fscanf}, @code{sscanf}, @code{strftime},
2169 @code{vprintf}, @code{vfprintf} and @code{vsprintf} whenever such
2170 warnings are requested (using @option{-Wformat}), so there is no need to
2171 modify the header file @file{stdio.h}.  In C99 mode, the functions
2172 @code{snprintf}, @code{vsnprintf}, @code{vscanf}, @code{vfscanf} and
2173 @code{vsscanf} are also checked.  Except in strictly conforming C
2174 standard modes, the X/Open function @code{strfmon} is also checked as
2175 are @code{printf_unlocked} and @code{fprintf_unlocked}.
2176 @xref{C Dialect Options,,Options Controlling C Dialect}.
2177
2178 @item format_arg (@var{string-index})
2179 @cindex @code{format_arg} function attribute
2180 @opindex Wformat-nonliteral
2181 The @code{format_arg} attribute specifies that a function takes a format
2182 string for a @code{printf}, @code{scanf}, @code{strftime} or
2183 @code{strfmon} style function and modifies it (for example, to translate
2184 it into another language), so the result can be passed to a
2185 @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style
2186 function (with the remaining arguments to the format function the same
2187 as they would have been for the unmodified string).  For example, the
2188 declaration:
2189
2190 @smallexample
2191 extern char *
2192 my_dgettext (char *my_domain, const char *my_format)
2193       __attribute__ ((format_arg (2)));
2194 @end smallexample
2195
2196 @noindent
2197 causes the compiler to check the arguments in calls to a @code{printf},
2198 @code{scanf}, @code{strftime} or @code{strfmon} type function, whose
2199 format string argument is a call to the @code{my_dgettext} function, for
2200 consistency with the format string argument @code{my_format}.  If the
2201 @code{format_arg} attribute had not been specified, all the compiler
2202 could tell in such calls to format functions would be that the format
2203 string argument is not constant; this would generate a warning when
2204 @option{-Wformat-nonliteral} is used, but the calls could not be checked
2205 without the attribute.
2206
2207 The parameter @var{string-index} specifies which argument is the format
2208 string argument (starting from one).  Since non-static C++ methods have
2209 an implicit @code{this} argument, the arguments of such methods should
2210 be counted from two.
2211
2212 The @code{format-arg} attribute allows you to identify your own
2213 functions which modify format strings, so that GCC can check the
2214 calls to @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon}
2215 type function whose operands are a call to one of your own function.
2216 The compiler always treats @code{gettext}, @code{dgettext}, and
2217 @code{dcgettext} in this manner except when strict ISO C support is
2218 requested by @option{-ansi} or an appropriate @option{-std} option, or
2219 @option{-ffreestanding} is used.  @xref{C Dialect Options,,Options
2220 Controlling C Dialect}.
2221
2222 @item nonnull (@var{arg-index}, @dots{})
2223 @cindex @code{nonnull} function attribute
2224 The @code{nonnull} attribute specifies that some function parameters should
2225 be non-null pointers.  For instance, the declaration:
2226
2227 @smallexample
2228 extern void *
2229 my_memcpy (void *dest, const void *src, size_t len)
2230         __attribute__((nonnull (1, 2)));
2231 @end smallexample
2232
2233 @noindent
2234 causes the compiler to check that, in calls to @code{my_memcpy},
2235 arguments @var{dest} and @var{src} are non-null.  If the compiler
2236 determines that a null pointer is passed in an argument slot marked
2237 as non-null, and the @option{-Wnonnull} option is enabled, a warning
2238 is issued.  The compiler may also choose to make optimizations based
2239 on the knowledge that certain function arguments will not be null.
2240
2241 If no argument index list is given to the @code{nonnull} attribute,
2242 all pointer arguments are marked as non-null.  To illustrate, the
2243 following declaration is equivalent to the previous example:
2244
2245 @smallexample
2246 extern void *
2247 my_memcpy (void *dest, const void *src, size_t len)
2248         __attribute__((nonnull));
2249 @end smallexample
2250
2251 @item no_instrument_function
2252 @cindex @code{no_instrument_function} function attribute
2253 @opindex finstrument-functions
2254 If @option{-finstrument-functions} is given, profiling function calls will
2255 be generated at entry and exit of most user-compiled functions.
2256 Functions with this attribute will not be so instrumented.
2257
2258 @item section ("@var{section-name}")
2259 @cindex @code{section} function attribute
2260 Normally, the compiler places the code it generates in the @code{text} section.
2261 Sometimes, however, you need additional sections, or you need certain
2262 particular functions to appear in special sections.  The @code{section}
2263 attribute specifies that a function lives in a particular section.
2264 For example, the declaration:
2265
2266 @smallexample
2267 extern void foobar (void) __attribute__ ((section ("bar")));
2268 @end smallexample
2269
2270 @noindent
2271 puts the function @code{foobar} in the @code{bar} section.
2272
2273 Some file formats do not support arbitrary sections so the @code{section}
2274 attribute is not available on all platforms.
2275 If you need to map the entire contents of a module to a particular
2276 section, consider using the facilities of the linker instead.
2277
2278 @item constructor
2279 @itemx destructor
2280 @cindex @code{constructor} function attribute
2281 @cindex @code{destructor} function attribute
2282 The @code{constructor} attribute causes the function to be called
2283 automatically before execution enters @code{main ()}.  Similarly, the
2284 @code{destructor} attribute causes the function to be called
2285 automatically after @code{main ()} has completed or @code{exit ()} has
2286 been called.  Functions with these attributes are useful for
2287 initializing data that will be used implicitly during the execution of
2288 the program.
2289
2290 These attributes are not currently implemented for Objective-C@.
2291
2292 @cindex @code{unused} attribute.
2293 @item unused
2294 This attribute, attached to a function, means that the function is meant
2295 to be possibly unused.  GCC will not produce a warning for this
2296 function.
2297
2298 @cindex @code{used} attribute.
2299 @item used
2300 This attribute, attached to a function, means that code must be emitted
2301 for the function even if it appears that the function is not referenced.
2302 This is useful, for example, when the function is referenced only in
2303 inline assembly.
2304
2305 @cindex @code{deprecated} attribute.
2306 @item deprecated
2307 The @code{deprecated} attribute results in a warning if the function
2308 is used anywhere in the source file.  This is useful when identifying
2309 functions that are expected to be removed in a future version of a
2310 program.  The warning also includes the location of the declaration
2311 of the deprecated function, to enable users to easily find further
2312 information about why the function is deprecated, or what they should
2313 do instead.  Note that the warnings only occurs for uses:
2314
2315 @smallexample
2316 int old_fn () __attribute__ ((deprecated));
2317 int old_fn ();
2318 int (*fn_ptr)() = old_fn;
2319 @end smallexample
2320
2321 results in a warning on line 3 but not line 2.
2322
2323 The @code{deprecated} attribute can also be used for variables and
2324 types (@pxref{Variable Attributes}, @pxref{Type Attributes}.)
2325
2326 @item warn_unused_result
2327 @cindex @code{warn_unused_result} attribute
2328 The @code{warn_unused_result} attribute causes a warning to be emitted
2329 if a caller of the function with this attribute does not use its
2330 return value.  This is useful for functions where not checking
2331 the result is either a security problem or always a bug, such as
2332 @code{realloc}.
2333
2334 @smallexample
2335 int fn () __attribute__ ((warn_unused_result));
2336 int foo ()
2337 @{
2338   if (fn () < 0) return -1;
2339   fn ();
2340   return 0;
2341 @}
2342 @end smallexample
2343
2344 results in warning on line 5.
2345
2346 @item weak
2347 @cindex @code{weak} attribute
2348 The @code{weak} attribute causes the declaration to be emitted as a weak
2349 symbol rather than a global.  This is primarily useful in defining
2350 library functions which can be overridden in user code, though it can
2351 also be used with non-function declarations.  Weak symbols are supported
2352 for ELF targets, and also for a.out targets when using the GNU assembler
2353 and linker.
2354
2355 @item malloc
2356 @cindex @code{malloc} attribute
2357 The @code{malloc} attribute is used to tell the compiler that a function
2358 may be treated as if any non-@code{NULL} pointer it returns cannot
2359 alias any other pointer valid when the function returns.
2360 This will often improve optimization.
2361 Standard functions with this property include @code{malloc} and
2362 @code{calloc}.  @code{realloc}-like functions have this property as
2363 long as the old pointer is never referred to (including comparing it
2364 to the new pointer) after the function returns a non-@code{NULL}
2365 value.
2366
2367 @item alias ("@var{target}")
2368 @cindex @code{alias} attribute
2369 The @code{alias} attribute causes the declaration to be emitted as an
2370 alias for another symbol, which must be specified.  For instance,
2371
2372 @smallexample
2373 void __f () @{ /* @r{Do something.} */; @}
2374 void f () __attribute__ ((weak, alias ("__f")));
2375 @end smallexample
2376
2377 declares @samp{f} to be a weak alias for @samp{__f}.  In C++, the
2378 mangled name for the target must be used.
2379
2380 Not all target machines support this attribute.
2381
2382 @item visibility ("@var{visibility_type}")
2383 @cindex @code{visibility} attribute
2384 The @code{visibility} attribute on ELF targets causes the declaration
2385 to be emitted with default, hidden, protected or internal visibility.
2386
2387 @smallexample
2388 void __attribute__ ((visibility ("protected")))
2389 f () @{ /* @r{Do something.} */; @}
2390 int i __attribute__ ((visibility ("hidden")));
2391 @end smallexample
2392
2393 See the ELF gABI for complete details, but the short story is:
2394
2395 @table @dfn
2396 @item default
2397 Default visibility is the normal case for ELF.  This value is 
2398 available for the visibility attribute to override other options
2399 that may change the assumed visibility of symbols.
2400
2401 @item hidden
2402 Hidden visibility indicates that the symbol will not be placed into
2403 the dynamic symbol table, so no other @dfn{module} (executable or
2404 shared library) can reference it directly.
2405
2406 @item protected
2407 Protected visibility indicates that the symbol will be placed in the
2408 dynamic symbol table, but that references within the defining module
2409 will bind to the local symbol.  That is, the symbol cannot be overridden
2410 by another module.
2411
2412 @item internal
2413 Internal visibility is like hidden visibility, but with additional
2414 processor specific semantics.  Unless otherwise specified by the psABI,
2415 gcc defines internal visibility to mean that the function is @emph{never}
2416 called from another module.  Note that hidden symbols, while they cannot
2417 be referenced directly by other modules, can be referenced indirectly via
2418 function pointers.  By indicating that a symbol cannot be called from
2419 outside the module, gcc may for instance omit the load of a PIC register
2420 since it is known that the calling function loaded the correct value.
2421 @end table
2422
2423 Not all ELF targets support this attribute.
2424
2425 @item regparm (@var{number})
2426 @cindex @code{regparm} attribute
2427 @cindex functions that are passed arguments in registers on the 386
2428 On the Intel 386, the @code{regparm} attribute causes the compiler to
2429 pass up to @var{number} integer arguments in registers EAX,
2430 EDX, and ECX instead of on the stack.  Functions that take a
2431 variable number of arguments will continue to be passed all of their
2432 arguments on the stack.
2433
2434 Beware that on some ELF systems this attribute is unsuitable for
2435 global functions in shared libraries with lazy binding (which is the
2436 default).  Lazy binding will send the first call via resolving code in
2437 the loader, which might assume EAX, EDX and ECX can be clobbered, as
2438 per the standard calling conventions.  Solaris 8 is affected by this.
2439 GNU systems with GLIBC 2.1 or higher, and FreeBSD, are believed to be
2440 safe since the loaders there save all registers.  (Lazy binding can be
2441 disabled with the linker or the loader if desired, to avoid the
2442 problem.)
2443
2444 @item stdcall
2445 @cindex functions that pop the argument stack on the 386
2446 On the Intel 386, the @code{stdcall} attribute causes the compiler to
2447 assume that the called function will pop off the stack space used to
2448 pass arguments, unless it takes a variable number of arguments.
2449
2450 @item fastcall
2451 @cindex functions that pop the argument stack on the 386
2452 On the Intel 386, the @code{fastcall} attribute causes the compiler to
2453 pass the first two arguments in the registers ECX and EDX. Subsequent
2454 arguments are passed on the stack. The called function will pop the 
2455 arguments off the stack. If the number of arguments is variable all
2456 arguments are pushed on the stack.
2457
2458 @item cdecl
2459 @cindex functions that do pop the argument stack on the 386
2460 @opindex mrtd
2461 On the Intel 386, the @code{cdecl} attribute causes the compiler to
2462 assume that the calling function will pop off the stack space used to
2463 pass arguments.  This is
2464 useful to override the effects of the @option{-mrtd} switch.
2465
2466 @item longcall/shortcall
2467 @cindex functions called via pointer on the RS/6000 and PowerPC
2468 On the RS/6000 and PowerPC, the @code{longcall} attribute causes the
2469 compiler to always call this function via a pointer, just as it would if
2470 the @option{-mlongcall} option had been specified.  The @code{shortcall}
2471 attribute causes the compiler not to do this.  These attributes override
2472 both the @option{-mlongcall} switch and the @code{#pragma longcall}
2473 setting.
2474
2475 @xref{RS/6000 and PowerPC Options}, for more information on whether long
2476 calls are necessary.
2477
2478 @item long_call/short_call
2479 @cindex indirect calls on ARM
2480 This attribute specifies how a particular function is called on
2481 ARM@.  Both attributes override the @option{-mlong-calls} (@pxref{ARM Options})
2482 command line switch and @code{#pragma long_calls} settings.  The
2483 @code{long_call} attribute causes the compiler to always call the
2484 function by first loading its address into a register and then using the
2485 contents of that register.   The @code{short_call} attribute always places
2486 the offset to the function from the call site into the @samp{BL}
2487 instruction directly.
2488
2489 @item function_vector
2490 @cindex calling functions through the function vector on the H8/300 processors
2491 Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
2492 function should be called through the function vector.  Calling a
2493 function through the function vector will reduce code size, however;
2494 the function vector has a limited size (maximum 128 entries on the H8/300
2495 and 64 entries on the H8/300H and H8S) and shares space with the interrupt vector.
2496
2497 You must use GAS and GLD from GNU binutils version 2.7 or later for
2498 this attribute to work correctly.
2499
2500 @item interrupt
2501 @cindex interrupt handler functions
2502 Use this attribute on the ARM, AVR, C4x, M32R/D and Xstormy16 ports to indicate
2503 that the specified function is an interrupt handler.  The compiler will
2504 generate function entry and exit sequences suitable for use in an
2505 interrupt handler when this attribute is present.
2506
2507 Note, interrupt handlers for the m68k, H8/300, H8/300H, H8S, and SH processors
2508 can be specified via the @code{interrupt_handler} attribute.
2509
2510 Note, on the AVR, interrupts will be enabled inside the function.
2511
2512 Note, for the ARM, you can specify the kind of interrupt to be handled by
2513 adding an optional parameter to the interrupt attribute like this:
2514
2515 @smallexample
2516 void f () __attribute__ ((interrupt ("IRQ")));
2517 @end smallexample
2518
2519 Permissible values for this parameter are: IRQ, FIQ, SWI, ABORT and UNDEF@.
2520
2521 @item interrupt_handler
2522 @cindex interrupt handler functions on the m68k, H8/300 and SH processors
2523 Use this attribute on the m68k, H8/300, H8/300H, H8S, and SH to indicate that
2524 the specified function is an interrupt handler.  The compiler will generate
2525 function entry and exit sequences suitable for use in an interrupt
2526 handler when this attribute is present.
2527
2528 @item sp_switch
2529 Use this attribute on the SH to indicate an @code{interrupt_handler}
2530 function should switch to an alternate stack.  It expects a string
2531 argument that names a global variable holding the address of the
2532 alternate stack.
2533
2534 @smallexample
2535 void *alt_stack;
2536 void f () __attribute__ ((interrupt_handler,
2537                           sp_switch ("alt_stack")));
2538 @end smallexample
2539
2540 @item trap_exit
2541 Use this attribute on the SH for an @code{interrupt_handler} to return using
2542 @code{trapa} instead of @code{rte}.  This attribute expects an integer
2543 argument specifying the trap number to be used.
2544
2545 @item eightbit_data
2546 @cindex eight bit data on the H8/300, H8/300H, and H8S
2547 Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
2548 variable should be placed into the eight bit data section.
2549 The compiler will generate more efficient code for certain operations
2550 on data in the eight bit data area.  Note the eight bit data area is limited to
2551 256 bytes of data.
2552
2553 You must use GAS and GLD from GNU binutils version 2.7 or later for
2554 this attribute to work correctly.
2555
2556 @item tiny_data
2557 @cindex tiny data section on the H8/300H and H8S
2558 Use this attribute on the H8/300H and H8S to indicate that the specified
2559 variable should be placed into the tiny data section.
2560 The compiler will generate more efficient code for loads and stores
2561 on data in the tiny data section.  Note the tiny data area is limited to
2562 slightly under 32kbytes of data.
2563
2564 @item saveall
2565 @cindex save all registers on the H8/300, H8/300H, and H8S
2566 Use this attribute on the H8/300, H8/300H, and H8S to indicate that
2567 all registers except the stack pointer should be saved in the prologue
2568 regardless of whether they are used or not.
2569
2570 @item signal
2571 @cindex signal handler functions on the AVR processors
2572 Use this attribute on the AVR to indicate that the specified
2573 function is a signal handler.  The compiler will generate function
2574 entry and exit sequences suitable for use in a signal handler when this
2575 attribute is present.  Interrupts will be disabled inside the function.
2576
2577 @item naked
2578 @cindex function without a prologue/epilogue code
2579 Use this attribute on the ARM, AVR, C4x and IP2K ports to indicate that the
2580 specified function does not need prologue/epilogue sequences generated by
2581 the compiler.  It is up to the programmer to provide these sequences.
2582
2583 @item model (@var{model-name})
2584 @cindex function addressability on the M32R/D
2585 @cindex variable addressability on the IA-64
2586
2587 On the M32R/D, use this attribute to set the addressability of an
2588 object, and of the code generated for a function.  The identifier
2589 @var{model-name} is one of @code{small}, @code{medium}, or
2590 @code{large}, representing each of the code models.
2591
2592 Small model objects live in the lower 16MB of memory (so that their
2593 addresses can be loaded with the @code{ld24} instruction), and are
2594 callable with the @code{bl} instruction.
2595
2596 Medium model objects may live anywhere in the 32-bit address space (the
2597 compiler will generate @code{seth/add3} instructions to load their addresses),
2598 and are callable with the @code{bl} instruction.
2599
2600 Large model objects may live anywhere in the 32-bit address space (the
2601 compiler will generate @code{seth/add3} instructions to load their addresses),
2602 and may not be reachable with the @code{bl} instruction (the compiler will
2603 generate the much slower @code{seth/add3/jl} instruction sequence).
2604
2605 On IA-64, use this attribute to set the addressability of an object.
2606 At present, the only supported identifier for @var{model-name} is
2607 @code{small}, indicating addressability via ``small'' (22-bit)
2608 addresses (so that their addresses can be loaded with the @code{addl}
2609 instruction).  Caveat: such addressing is by definition not position
2610 independent and hence this attribute must not be used for objects
2611 defined by shared libraries.
2612
2613 @item far
2614 @cindex functions which handle memory bank switching
2615 On 68HC11 and 68HC12 the @code{far} attribute causes the compiler to
2616 use a calling convention that takes care of switching memory banks when
2617 entering and leaving a function.  This calling convention is also the
2618 default when using the @option{-mlong-calls} option.
2619
2620 On 68HC12 the compiler will use the @code{call} and @code{rtc} instructions
2621 to call and return from a function.
2622
2623 On 68HC11 the compiler will generate a sequence of instructions
2624 to invoke a board-specific routine to switch the memory bank and call the
2625 real function. The board-specific routine simulates a @code{call}.
2626 At the end of a function, it will jump to a board-specific routine
2627 instead of using @code{rts}. The board-specific return routine simulates
2628 the @code{rtc}.
2629
2630 @item near
2631 @cindex functions which do not handle memory bank switching on 68HC11/68HC12
2632 On 68HC11 and 68HC12 the @code{near} attribute causes the compiler to
2633 use the normal calling convention based on @code{jsr} and @code{rts}.
2634 This attribute can be used to cancel the effect of the @option{-mlong-calls}
2635 option.
2636
2637 @item dllimport
2638 @cindex @code{__declspec(dllimport)}
2639 On Microsoft Windows targets, the @code{dllimport} attribute causes the compiler
2640 to reference a function or variable via a global pointer to a pointer
2641 that is set up by the Microsoft Windows dll library. The pointer name is formed by
2642 combining @code{_imp__} and the function or variable name. The attribute
2643 implies @code{extern} storage.
2644
2645 Currently, the attribute is ignored for inlined functions. If the
2646 attribute is applied to a symbol @emph{definition}, an error is reported.
2647 If a symbol previously declared @code{dllimport} is later defined, the
2648 attribute is ignored in subsequent references, and a warning is emitted.
2649 The attribute is also overridden by a subsequent declaration as
2650 @code{dllexport}. 
2651
2652 When applied to C++ classes, the attribute marks non-inlined
2653 member functions and static data members as imports.  However, the
2654 attribute is ignored for virtual methods to allow creation of vtables
2655 using thunks.
2656
2657 On cygwin, mingw and arm-pe targets, @code{__declspec(dllimport)} is
2658 recognized as a synonym for @code{__attribute__ ((dllimport))} for
2659 compatibility with other Microsoft Windows compilers.
2660
2661 The use of the @code{dllimport} attribute on functions is not necessary,
2662 but provides a small performance benefit by eliminating a thunk in the
2663 dll. The use of the @code{dllimport} attribute on imported variables was
2664 required on older versions of GNU ld, but can now be avoided by passing
2665 the @option{--enable-auto-import} switch to ld. As with functions, using
2666 the attribute for a variable eliminates a thunk in the dll. 
2667
2668 One drawback to using this attribute is that a pointer to a function or
2669 variable marked as dllimport cannot be used as a constant address. The
2670 attribute can be disabled for functions by setting the
2671 @option{-mnop-fun-dllimport} flag.
2672
2673 @item dllexport
2674 @cindex @code{__declspec(dllexport)}
2675 On Microsoft Windows targets the @code{dllexport} attribute causes the compiler to
2676 provide a global pointer to a pointer in a dll, so that it can be
2677 referenced with the @code{dllimport} attribute. The pointer name is
2678 formed by combining @code{_imp__} and the function or variable name.
2679
2680 Currently, the @code{dllexport}attribute is ignored for inlined
2681 functions, but export can be forced by using the
2682 @option{-fkeep-inline-functions} flag. The attribute is also ignored for
2683 undefined symbols.
2684
2685 When applied to C++ classes. the attribute marks defined non-inlined
2686 member functions and static data members as exports. Static consts
2687 initialized in-class are not marked unless they are also defined
2688 out-of-class.
2689
2690 On cygwin, mingw and arm-pe targets, @code{__declspec(dllexport)} is
2691 recognized as a synonym for @code{__attribute__ ((dllexport))} for
2692 compatibility with other Microsoft Windows compilers.
2693
2694 Alternative methods for including the symbol in the dll's export table
2695 are to use a .def file with an @code{EXPORTS} section or, with GNU ld,
2696 using the @option{--export-all} linker flag.
2697
2698 @end table
2699
2700 You can specify multiple attributes in a declaration by separating them
2701 by commas within the double parentheses or by immediately following an
2702 attribute declaration with another attribute declaration.
2703
2704 @cindex @code{#pragma}, reason for not using
2705 @cindex pragma, reason for not using
2706 Some people object to the @code{__attribute__} feature, suggesting that
2707 ISO C's @code{#pragma} should be used instead.  At the time
2708 @code{__attribute__} was designed, there were two reasons for not doing
2709 this.
2710
2711 @enumerate
2712 @item
2713 It is impossible to generate @code{#pragma} commands from a macro.
2714
2715 @item
2716 There is no telling what the same @code{#pragma} might mean in another
2717 compiler.
2718 @end enumerate
2719
2720 These two reasons applied to almost any application that might have been
2721 proposed for @code{#pragma}.  It was basically a mistake to use
2722 @code{#pragma} for @emph{anything}.
2723
2724 The ISO C99 standard includes @code{_Pragma}, which now allows pragmas
2725 to be generated from macros.  In addition, a @code{#pragma GCC}
2726 namespace is now in use for GCC-specific pragmas.  However, it has been
2727 found convenient to use @code{__attribute__} to achieve a natural
2728 attachment of attributes to their corresponding declarations, whereas
2729 @code{#pragma GCC} is of use for constructs that do not naturally form
2730 part of the grammar.  @xref{Other Directives,,Miscellaneous
2731 Preprocessing Directives, cpp, The GNU C Preprocessor}.
2732
2733 @node Attribute Syntax
2734 @section Attribute Syntax
2735 @cindex attribute syntax
2736
2737 This section describes the syntax with which @code{__attribute__} may be
2738 used, and the constructs to which attribute specifiers bind, for the C
2739 language.  Some details may vary for C++ and Objective-C@.  Because of
2740 infelicities in the grammar for attributes, some forms described here
2741 may not be successfully parsed in all cases.
2742
2743 There are some problems with the semantics of attributes in C++.  For
2744 example, there are no manglings for attributes, although they may affect
2745 code generation, so problems may arise when attributed types are used in
2746 conjunction with templates or overloading.  Similarly, @code{typeid}
2747 does not distinguish between types with different attributes.  Support
2748 for attributes in C++ may be restricted in future to attributes on
2749 declarations only, but not on nested declarators.
2750
2751 @xref{Function Attributes}, for details of the semantics of attributes
2752 applying to functions.  @xref{Variable Attributes}, for details of the
2753 semantics of attributes applying to variables.  @xref{Type Attributes},
2754 for details of the semantics of attributes applying to structure, union
2755 and enumerated types.
2756
2757 An @dfn{attribute specifier} is of the form
2758 @code{__attribute__ ((@var{attribute-list}))}.  An @dfn{attribute list}
2759 is a possibly empty comma-separated sequence of @dfn{attributes}, where
2760 each attribute is one of the following:
2761
2762 @itemize @bullet
2763 @item
2764 Empty.  Empty attributes are ignored.
2765
2766 @item
2767 A word (which may be an identifier such as @code{unused}, or a reserved
2768 word such as @code{const}).
2769
2770 @item
2771 A word, followed by, in parentheses, parameters for the attribute.
2772 These parameters take one of the following forms:
2773
2774 @itemize @bullet
2775 @item
2776 An identifier.  For example, @code{mode} attributes use this form.
2777
2778 @item
2779 An identifier followed by a comma and a non-empty comma-separated list
2780 of expressions.  For example, @code{format} attributes use this form.
2781
2782 @item
2783 A possibly empty comma-separated list of expressions.  For example,
2784 @code{format_arg} attributes use this form with the list being a single
2785 integer constant expression, and @code{alias} attributes use this form
2786 with the list being a single string constant.
2787 @end itemize
2788 @end itemize
2789
2790 An @dfn{attribute specifier list} is a sequence of one or more attribute
2791 specifiers, not separated by any other tokens.
2792
2793 In GNU C, an attribute specifier list may appear after the colon following a
2794 label, other than a @code{case} or @code{default} label.  The only
2795 attribute it makes sense to use after a label is @code{unused}.  This
2796 feature is intended for code generated by programs which contains labels
2797 that may be unused but which is compiled with @option{-Wall}.  It would
2798 not normally be appropriate to use in it human-written code, though it
2799 could be useful in cases where the code that jumps to the label is
2800 contained within an @code{#ifdef} conditional. GNU C++ does not permit
2801 such placement of attribute lists, as it is permissible for a
2802 declaration, which could begin with an attribute list, to be labelled in
2803 C++. Declarations cannot be labelled in C90 or C99, so the ambiguity
2804 does not arise there.
2805
2806 An attribute specifier list may appear as part of a @code{struct},
2807 @code{union} or @code{enum} specifier.  It may go either immediately
2808 after the @code{struct}, @code{union} or @code{enum} keyword, or after
2809 the closing brace.  It is ignored if the content of the structure, union
2810 or enumerated type is not defined in the specifier in which the
2811 attribute specifier list is used---that is, in usages such as
2812 @code{struct __attribute__((foo)) bar} with no following opening brace.
2813 Where attribute specifiers follow the closing brace, they are considered
2814 to relate to the structure, union or enumerated type defined, not to any
2815 enclosing declaration the type specifier appears in, and the type
2816 defined is not complete until after the attribute specifiers.
2817 @c Otherwise, there would be the following problems: a shift/reduce
2818 @c conflict between attributes binding the struct/union/enum and
2819 @c binding to the list of specifiers/qualifiers; and "aligned"
2820 @c attributes could use sizeof for the structure, but the size could be
2821 @c changed later by "packed" attributes.
2822
2823 Otherwise, an attribute specifier appears as part of a declaration,
2824 counting declarations of unnamed parameters and type names, and relates
2825 to that declaration (which may be nested in another declaration, for
2826 example in the case of a parameter declaration), or to a particular declarator
2827 within a declaration.  Where an
2828 attribute specifier is applied to a parameter declared as a function or
2829 an array, it should apply to the function or array rather than the
2830 pointer to which the parameter is implicitly converted, but this is not
2831 yet correctly implemented.
2832
2833 Any list of specifiers and qualifiers at the start of a declaration may
2834 contain attribute specifiers, whether or not such a list may in that
2835 context contain storage class specifiers.  (Some attributes, however,
2836 are essentially in the nature of storage class specifiers, and only make
2837 sense where storage class specifiers may be used; for example,
2838 @code{section}.)  There is one necessary limitation to this syntax: the
2839 first old-style parameter declaration in a function definition cannot
2840 begin with an attribute specifier, because such an attribute applies to
2841 the function instead by syntax described below (which, however, is not
2842 yet implemented in this case).  In some other cases, attribute
2843 specifiers are permitted by this grammar but not yet supported by the
2844 compiler.  All attribute specifiers in this place relate to the
2845 declaration as a whole.  In the obsolescent usage where a type of
2846 @code{int} is implied by the absence of type specifiers, such a list of
2847 specifiers and qualifiers may be an attribute specifier list with no
2848 other specifiers or qualifiers.
2849
2850 An attribute specifier list may appear immediately before a declarator
2851 (other than the first) in a comma-separated list of declarators in a
2852 declaration of more than one identifier using a single list of
2853 specifiers and qualifiers.  Such attribute specifiers apply
2854 only to the identifier before whose declarator they appear.  For
2855 example, in
2856
2857 @smallexample
2858 __attribute__((noreturn)) void d0 (void),
2859     __attribute__((format(printf, 1, 2))) d1 (const char *, ...),
2860      d2 (void)
2861 @end smallexample
2862
2863 @noindent
2864 the @code{noreturn} attribute applies to all the functions
2865 declared; the @code{format} attribute only applies to @code{d1}.
2866
2867 An attribute specifier list may appear immediately before the comma,
2868 @code{=} or semicolon terminating the declaration of an identifier other
2869 than a function definition.  At present, such attribute specifiers apply
2870 to the declared object or function, but in future they may attach to the
2871 outermost adjacent declarator.  In simple cases there is no difference,
2872 but, for example, in
2873
2874 @smallexample
2875 void (****f)(void) __attribute__((noreturn));
2876 @end smallexample
2877
2878 @noindent
2879 at present the @code{noreturn} attribute applies to @code{f}, which
2880 causes a warning since @code{f} is not a function, but in future it may
2881 apply to the function @code{****f}.  The precise semantics of what
2882 attributes in such cases will apply to are not yet specified.  Where an
2883 assembler name for an object or function is specified (@pxref{Asm
2884 Labels}), at present the attribute must follow the @code{asm}
2885 specification; in future, attributes before the @code{asm} specification
2886 may apply to the adjacent declarator, and those after it to the declared
2887 object or function.
2888
2889 An attribute specifier list may, in future, be permitted to appear after
2890 the declarator in a function definition (before any old-style parameter
2891 declarations or the function body).
2892
2893 Attribute specifiers may be mixed with type qualifiers appearing inside
2894 the @code{[]} of a parameter array declarator, in the C99 construct by
2895 which such qualifiers are applied to the pointer to which the array is
2896 implicitly converted.  Such attribute specifiers apply to the pointer,
2897 not to the array, but at present this is not implemented and they are
2898 ignored.
2899
2900 An attribute specifier list may appear at the start of a nested
2901 declarator.  At present, there are some limitations in this usage: the
2902 attributes correctly apply to the declarator, but for most individual
2903 attributes the semantics this implies are not implemented.
2904 When attribute specifiers follow the @code{*} of a pointer
2905 declarator, they may be mixed with any type qualifiers present.
2906 The following describes the formal semantics of this syntax.  It will make the
2907 most sense if you are familiar with the formal specification of
2908 declarators in the ISO C standard.
2909
2910 Consider (as in C99 subclause 6.7.5 paragraph 4) a declaration @code{T
2911 D1}, where @code{T} contains declaration specifiers that specify a type
2912 @var{Type} (such as @code{int}) and @code{D1} is a declarator that
2913 contains an identifier @var{ident}.  The type specified for @var{ident}
2914 for derived declarators whose type does not include an attribute
2915 specifier is as in the ISO C standard.
2916
2917 If @code{D1} has the form @code{( @var{attribute-specifier-list} D )},
2918 and the declaration @code{T D} specifies the type
2919 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
2920 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
2921 @var{attribute-specifier-list} @var{Type}'' for @var{ident}.
2922
2923 If @code{D1} has the form @code{*
2924 @var{type-qualifier-and-attribute-specifier-list} D}, and the
2925 declaration @code{T D} specifies the type
2926 ``@var{derived-declarator-type-list} @var{Type}'' for @var{ident}, then
2927 @code{T D1} specifies the type ``@var{derived-declarator-type-list}
2928 @var{type-qualifier-and-attribute-specifier-list} @var{Type}'' for
2929 @var{ident}.
2930
2931 For example,
2932
2933 @smallexample
2934 void (__attribute__((noreturn)) ****f) (void);
2935 @end smallexample
2936
2937 @noindent
2938 specifies the type ``pointer to pointer to pointer to pointer to
2939 non-returning function returning @code{void}''.  As another example,
2940
2941 @smallexample
2942 char *__attribute__((aligned(8))) *f;
2943 @end smallexample
2944
2945 @noindent
2946 specifies the type ``pointer to 8-byte-aligned pointer to @code{char}''.
2947 Note again that this does not work with most attributes; for example,
2948 the usage of @samp{aligned} and @samp{noreturn} attributes given above
2949 is not yet supported.
2950
2951 For compatibility with existing code written for compiler versions that
2952 did not implement attributes on nested declarators, some laxity is
2953 allowed in the placing of attributes.  If an attribute that only applies
2954 to types is applied to a declaration, it will be treated as applying to
2955 the type of that declaration.  If an attribute that only applies to
2956 declarations is applied to the type of a declaration, it will be treated
2957 as applying to that declaration; and, for compatibility with code
2958 placing the attributes immediately before the identifier declared, such
2959 an attribute applied to a function return type will be treated as
2960 applying to the function type, and such an attribute applied to an array
2961 element type will be treated as applying to the array type.  If an
2962 attribute that only applies to function types is applied to a
2963 pointer-to-function type, it will be treated as applying to the pointer
2964 target type; if such an attribute is applied to a function return type
2965 that is not a pointer-to-function type, it will be treated as applying
2966 to the function type.
2967
2968 @node Function Prototypes
2969 @section Prototypes and Old-Style Function Definitions
2970 @cindex function prototype declarations
2971 @cindex old-style function definitions
2972 @cindex promotion of formal parameters
2973
2974 GNU C extends ISO C to allow a function prototype to override a later
2975 old-style non-prototype definition.  Consider the following example:
2976
2977 @smallexample
2978 /* @r{Use prototypes unless the compiler is old-fashioned.}  */
2979 #ifdef __STDC__
2980 #define P(x) x
2981 #else
2982 #define P(x) ()
2983 #endif
2984
2985 /* @r{Prototype function declaration.}  */
2986 int isroot P((uid_t));
2987
2988 /* @r{Old-style function definition.}  */
2989 int
2990 isroot (x)   /* ??? lossage here ??? */
2991      uid_t x;
2992 @{
2993   return x == 0;
2994 @}
2995 @end smallexample
2996
2997 Suppose the type @code{uid_t} happens to be @code{short}.  ISO C does
2998 not allow this example, because subword arguments in old-style
2999 non-prototype definitions are promoted.  Therefore in this example the
3000 function definition's argument is really an @code{int}, which does not
3001 match the prototype argument type of @code{short}.
3002
3003 This restriction of ISO C makes it hard to write code that is portable
3004 to traditional C compilers, because the programmer does not know
3005 whether the @code{uid_t} type is @code{short}, @code{int}, or
3006 @code{long}.  Therefore, in cases like these GNU C allows a prototype
3007 to override a later old-style definition.  More precisely, in GNU C, a
3008 function prototype argument type overrides the argument type specified
3009 by a later old-style definition if the former type is the same as the
3010 latter type before promotion.  Thus in GNU C the above example is
3011 equivalent to the following:
3012
3013 @smallexample
3014 int isroot (uid_t);
3015
3016 int
3017 isroot (uid_t x)
3018 @{
3019   return x == 0;
3020 @}
3021 @end smallexample
3022
3023 @noindent
3024 GNU C++ does not support old-style function definitions, so this
3025 extension is irrelevant.
3026
3027 @node C++ Comments
3028 @section C++ Style Comments
3029 @cindex //
3030 @cindex C++ comments
3031 @cindex comments, C++ style
3032
3033 In GNU C, you may use C++ style comments, which start with @samp{//} and
3034 continue until the end of the line.  Many other C implementations allow
3035 such comments, and they are included in the 1999 C standard.  However,
3036 C++ style comments are not recognized if you specify an @option{-std}
3037 option specifying a version of ISO C before C99, or @option{-ansi}
3038 (equivalent to @option{-std=c89}).
3039
3040 @node Dollar Signs
3041 @section Dollar Signs in Identifier Names
3042 @cindex $
3043 @cindex dollar signs in identifier names
3044 @cindex identifier names, dollar signs in
3045
3046 In GNU C, you may normally use dollar signs in identifier names.
3047 This is because many traditional C implementations allow such identifiers.
3048 However, dollar signs in identifiers are not supported on a few target
3049 machines, typically because the target assembler does not allow them.
3050
3051 @node Character Escapes
3052 @section The Character @key{ESC} in Constants
3053
3054 You can use the sequence @samp{\e} in a string or character constant to
3055 stand for the ASCII character @key{ESC}.
3056
3057 @node Alignment
3058 @section Inquiring on Alignment of Types or Variables
3059 @cindex alignment
3060 @cindex type alignment
3061 @cindex variable alignment
3062
3063 The keyword @code{__alignof__} allows you to inquire about how an object
3064 is aligned, or the minimum alignment usually required by a type.  Its
3065 syntax is just like @code{sizeof}.
3066
3067 For example, if the target machine requires a @code{double} value to be
3068 aligned on an 8-byte boundary, then @code{__alignof__ (double)} is 8.
3069 This is true on many RISC machines.  On more traditional machine
3070 designs, @code{__alignof__ (double)} is 4 or even 2.
3071
3072 Some machines never actually require alignment; they allow reference to any
3073 data type even at an odd address.  For these machines, @code{__alignof__}
3074 reports the @emph{recommended} alignment of a type.
3075
3076 If the operand of @code{__alignof__} is an lvalue rather than a type,
3077 its value is the required alignment for its type, taking into account
3078 any minimum alignment specified with GCC's @code{__attribute__}
3079 extension (@pxref{Variable Attributes}).  For example, after this
3080 declaration:
3081
3082 @smallexample
3083 struct foo @{ int x; char y; @} foo1;
3084 @end smallexample
3085
3086 @noindent
3087 the value of @code{__alignof__ (foo1.y)} is 1, even though its actual
3088 alignment is probably 2 or 4, the same as @code{__alignof__ (int)}.
3089
3090 It is an error to ask for the alignment of an incomplete type.
3091
3092 @node Variable Attributes
3093 @section Specifying Attributes of Variables
3094 @cindex attribute of variables
3095 @cindex variable attributes
3096
3097 The keyword @code{__attribute__} allows you to specify special
3098 attributes of variables or structure fields.  This keyword is followed
3099 by an attribute specification inside double parentheses.  Some
3100 attributes are currently defined generically for variables.
3101 Other attributes are defined for variables on particular target
3102 systems.  Other attributes are available for functions
3103 (@pxref{Function Attributes}) and for types (@pxref{Type Attributes}).
3104 Other front ends might define more attributes
3105 (@pxref{C++ Extensions,,Extensions to the C++ Language}).
3106
3107 You may also specify attributes with @samp{__} preceding and following
3108 each keyword.  This allows you to use them in header files without
3109 being concerned about a possible macro of the same name.  For example,
3110 you may use @code{__aligned__} instead of @code{aligned}.
3111
3112 @xref{Attribute Syntax}, for details of the exact syntax for using
3113 attributes.
3114
3115 @table @code
3116 @cindex @code{aligned} attribute
3117 @item aligned (@var{alignment})
3118 This attribute specifies a minimum alignment for the variable or
3119 structure field, measured in bytes.  For example, the declaration:
3120
3121 @smallexample
3122 int x __attribute__ ((aligned (16))) = 0;
3123 @end smallexample
3124
3125 @noindent
3126 causes the compiler to allocate the global variable @code{x} on a
3127 16-byte boundary.  On a 68040, this could be used in conjunction with
3128 an @code{asm} expression to access the @code{move16} instruction which
3129 requires 16-byte aligned operands.
3130
3131 You can also specify the alignment of structure fields.  For example, to
3132 create a double-word aligned @code{int} pair, you could write:
3133
3134 @smallexample
3135 struct foo @{ int x[2] __attribute__ ((aligned (8))); @};
3136 @end smallexample
3137
3138 @noindent
3139 This is an alternative to creating a union with a @code{double} member
3140 that forces the union to be double-word aligned.
3141
3142 As in the preceding examples, you can explicitly specify the alignment
3143 (in bytes) that you wish the compiler to use for a given variable or
3144 structure field.  Alternatively, you can leave out the alignment factor
3145 and just ask the compiler to align a variable or field to the maximum
3146 useful alignment for the target machine you are compiling for.  For
3147 example, you could write:
3148
3149 @smallexample
3150 short array[3] __attribute__ ((aligned));
3151 @end smallexample
3152
3153 Whenever you leave out the alignment factor in an @code{aligned} attribute
3154 specification, the compiler automatically sets the alignment for the declared
3155 variable or field to the largest alignment which is ever used for any data
3156 type on the target machine you are compiling for.  Doing this can often make
3157 copy operations more efficient, because the compiler can use whatever
3158 instructions copy the biggest chunks of memory when performing copies to
3159 or from the variables or fields that you have aligned this way.
3160
3161 The @code{aligned} attribute can only increase the alignment; but you
3162 can decrease it by specifying @code{packed} as well.  See below.
3163
3164 Note that the effectiveness of @code{aligned} attributes may be limited
3165 by inherent limitations in your linker.  On many systems, the linker is
3166 only able to arrange for variables to be aligned up to a certain maximum
3167 alignment.  (For some linkers, the maximum supported alignment may
3168 be very very small.)  If your linker is only able to align variables
3169 up to a maximum of 8 byte alignment, then specifying @code{aligned(16)}
3170 in an @code{__attribute__} will still only provide you with 8 byte
3171 alignment.  See your linker documentation for further information.
3172
3173 @item cleanup (@var{cleanup_function})
3174 @cindex @code{cleanup} attribute
3175 The @code{cleanup} attribute runs a function when the variable goes
3176 out of scope.  This attribute can only be applied to auto function
3177 scope variables; it may not be applied to parameters or variables
3178 with static storage duration.  The function must take one parameter,
3179 a pointer to a type compatible with the variable.  The return value
3180 of the function (if any) is ignored.
3181
3182 If @option{-fexceptions} is enabled, then @var{cleanup_function}
3183 will be run during the stack unwinding that happens during the
3184 processing of the exception.  Note that the @code{cleanup} attribute
3185 does not allow the exception to be caught, only to perform an action.
3186 It is undefined what happens if @var{cleanup_function} does not
3187 return normally.
3188
3189 @item common
3190 @itemx nocommon
3191 @cindex @code{common} attribute
3192 @cindex @code{nocommon} attribute
3193 @opindex fcommon
3194 @opindex fno-common
3195 The @code{common} attribute requests GCC to place a variable in
3196 ``common'' storage.  The @code{nocommon} attribute requests the
3197 opposite -- to allocate space for it directly.
3198
3199 These attributes override the default chosen by the 
3200 @option{-fno-common} and @option{-fcommon} flags respectively.
3201
3202 @item deprecated
3203 @cindex @code{deprecated} attribute
3204 The @code{deprecated} attribute results in a warning if the variable
3205 is used anywhere in the source file.  This is useful when identifying
3206 variables that are expected to be removed in a future version of a
3207 program.  The warning also includes the location of the declaration
3208 of the deprecated variable, to enable users to easily find further
3209 information about why the variable is deprecated, or what they should
3210 do instead.  Note that the warning only occurs for uses:
3211
3212 @smallexample
3213 extern int old_var __attribute__ ((deprecated));
3214 extern int old_var;
3215 int new_fn () @{ return old_var; @}
3216 @end smallexample
3217
3218 results in a warning on line 3 but not line 2.
3219
3220 The @code{deprecated} attribute can also be used for functions and
3221 types (@pxref{Function Attributes}, @pxref{Type Attributes}.)
3222
3223 @item mode (@var{mode})
3224 @cindex @code{mode} attribute
3225 This attribute specifies the data type for the declaration---whichever
3226 type corresponds to the mode @var{mode}.  This in effect lets you
3227 request an integer or floating point type according to its width.
3228
3229 You may also specify a mode of @samp{byte} or @samp{__byte__} to
3230 indicate the mode corresponding to a one-byte integer, @samp{word} or
3231 @samp{__word__} for the mode of a one-word integer, and @samp{pointer}
3232 or @samp{__pointer__} for the mode used to represent pointers.
3233
3234 @item packed
3235 @cindex @code{packed} attribute
3236 The @code{packed} attribute specifies that a variable or structure field
3237 should have the smallest possible alignment---one byte for a variable,
3238 and one bit for a field, unless you specify a larger value with the
3239 @code{aligned} attribute.
3240
3241 Here is a structure in which the field @code{x} is packed, so that it
3242 immediately follows @code{a}:
3243
3244 @smallexample
3245 struct foo
3246 @{
3247   char a;
3248   int x[2] __attribute__ ((packed));
3249 @};
3250 @end smallexample
3251
3252 @item section ("@var{section-name}")
3253 @cindex @code{section} variable attribute
3254 Normally, the compiler places the objects it generates in sections like
3255 @code{data} and @code{bss}.  Sometimes, however, you need additional sections,
3256 or you need certain particular variables to appear in special sections,
3257 for example to map to special hardware.  The @code{section}
3258 attribute specifies that a variable (or function) lives in a particular
3259 section.  For example, this small program uses several specific section names:
3260
3261 @smallexample
3262 struct duart a __attribute__ ((section ("DUART_A"))) = @{ 0 @};
3263 struct duart b __attribute__ ((section ("DUART_B"))) = @{ 0 @};
3264 char stack[10000] __attribute__ ((section ("STACK"))) = @{ 0 @};
3265 int init_data __attribute__ ((section ("INITDATA"))) = 0;
3266
3267 main()
3268 @{
3269   /* Initialize stack pointer */
3270   init_sp (stack + sizeof (stack));
3271
3272   /* Initialize initialized data */
3273   memcpy (&init_data, &data, &edata - &data);
3274
3275   /* Turn on the serial ports */
3276   init_duart (&a);
3277   init_duart (&b);
3278 @}
3279 @end smallexample
3280
3281 @noindent
3282 Use the @code{section} attribute with an @emph{initialized} definition
3283 of a @emph{global} variable, as shown in the example.  GCC issues
3284 a warning and otherwise ignores the @code{section} attribute in
3285 uninitialized variable declarations.
3286
3287 You may only use the @code{section} attribute with a fully initialized
3288 global definition because of the way linkers work.  The linker requires
3289 each object be defined once, with the exception that uninitialized
3290 variables tentatively go in the @code{common} (or @code{bss}) section
3291 and can be multiply ``defined''.  You can force a variable to be
3292 initialized with the @option{-fno-common} flag or the @code{nocommon}
3293 attribute.
3294
3295 Some file formats do not support arbitrary sections so the @code{section}
3296 attribute is not available on all platforms.
3297 If you need to map the entire contents of a module to a particular
3298 section, consider using the facilities of the linker instead.
3299
3300 @item shared
3301 @cindex @code{shared} variable attribute
3302 On Microsoft Windows, in addition to putting variable definitions in a named
3303 section, the section can also be shared among all running copies of an
3304 executable or DLL@.  For example, this small program defines shared data
3305 by putting it in a named section @code{shared} and marking the section
3306 shareable:
3307
3308 @smallexample
3309 int foo __attribute__((section ("shared"), shared)) = 0;
3310
3311 int
3312 main()
3313 @{
3314   /* Read and write foo.  All running
3315      copies see the same value.  */
3316   return 0;
3317 @}
3318 @end smallexample
3319
3320 @noindent
3321 You may only use the @code{shared} attribute along with @code{section}
3322 attribute with a fully initialized global definition because of the way
3323 linkers work.  See @code{section} attribute for more information.
3324
3325 The @code{shared} attribute is only available on Microsoft Windows@.
3326
3327 @item tls_model ("@var{tls_model}")
3328 @cindex @code{tls_model} attribute
3329 The @code{tls_model} attribute sets thread-local storage model
3330 (@pxref{Thread-Local}) of a particular @code{__thread} variable,
3331 overriding @code{-ftls-model=} command line switch on a per-variable
3332 basis.
3333 The @var{tls_model} argument should be one of @code{global-dynamic},
3334 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
3335
3336 Not all targets support this attribute.
3337
3338 @item transparent_union
3339 This attribute, attached to a function parameter which is a union, means
3340 that the corresponding argument may have the type of any union member,
3341 but the argument is passed as if its type were that of the first union
3342 member.  For more details see @xref{Type Attributes}.  You can also use
3343 this attribute on a @code{typedef} for a union data type; then it
3344 applies to all function parameters with that type.
3345
3346 @item unused
3347 This attribute, attached to a variable, means that the variable is meant
3348 to be possibly unused.  GCC will not produce a warning for this
3349 variable.
3350
3351 @item vector_size (@var{bytes})
3352 This attribute specifies the vector size for the variable, measured in
3353 bytes.  For example, the declaration:
3354
3355 @smallexample
3356 int foo __attribute__ ((vector_size (16)));
3357 @end smallexample
3358
3359 @noindent
3360 causes the compiler to set the mode for @code{foo}, to be 16 bytes,
3361 divided into @code{int} sized units.  Assuming a 32-bit int (a vector of
3362 4 units of 4 bytes), the corresponding mode of @code{foo} will be V4SI@.
3363
3364 This attribute is only applicable to integral and float scalars,
3365 although arrays, pointers, and function return values are allowed in
3366 conjunction with this construct.
3367
3368 Aggregates with this attribute are invalid, even if they are of the same
3369 size as a corresponding scalar.  For example, the declaration:
3370
3371 @smallexample
3372 struct S @{ int a; @};
3373 struct S  __attribute__ ((vector_size (16))) foo;
3374 @end smallexample
3375
3376 @noindent
3377 is invalid even if the size of the structure is the same as the size of
3378 the @code{int}.
3379
3380 @item weak
3381 The @code{weak} attribute is described in @xref{Function Attributes}.
3382
3383 @item dllimport
3384 The @code{dllimport} attribute is described in @xref{Function Attributes}.
3385
3386 @item dlexport
3387 The @code{dllexport} attribute is described in @xref{Function Attributes}.
3388
3389 @end table
3390
3391 @subsection M32R/D Variable Attributes
3392
3393 One attribute is currently defined for the M32R/D.
3394
3395 @table @code
3396 @item model (@var{model-name})
3397 @cindex variable addressability on the M32R/D
3398 Use this attribute on the M32R/D to set the addressability of an object.
3399 The identifier @var{model-name} is one of @code{small}, @code{medium},
3400 or @code{large}, representing each of the code models.
3401
3402 Small model objects live in the lower 16MB of memory (so that their
3403 addresses can be loaded with the @code{ld24} instruction).
3404
3405 Medium and large model objects may live anywhere in the 32-bit address space
3406 (the compiler will generate @code{seth/add3} instructions to load their
3407 addresses).
3408 @end table
3409
3410 @subsection i386 Variable Attributes
3411
3412 Two attributes are currently defined for i386 configurations:
3413 @code{ms_struct} and @code{gcc_struct}
3414
3415 @table @code
3416 @item ms_struct
3417 @itemx gcc_struct
3418 @cindex @code{ms_struct} attribute
3419 @cindex @code{gcc_struct} attribute
3420
3421 If @code{packed} is used on a structure, or if bit-fields are used
3422 it may be that the Microsoft ABI packs them differently
3423 than GCC would normally pack them.  Particularly when moving packed
3424 data between functions compiled with GCC and the native Microsoft compiler
3425 (either via function call or as data in a file), it may be necessary to access
3426 either format.
3427
3428 Currently @option{-m[no-]ms-bitfields} is provided for the Microsoft Windows X86
3429 compilers to match the native Microsoft compiler.
3430 @end table
3431
3432 @node Type Attributes
3433 @section Specifying Attributes of Types
3434 @cindex attribute of types
3435 @cindex type attributes
3436
3437 The keyword @code{__attribute__} allows you to specify special
3438 attributes of @code{struct} and @code{union} types when you define such
3439 types.  This keyword is followed by an attribute specification inside
3440 double parentheses.  Six attributes are currently defined for types:
3441 @code{aligned}, @code{packed}, @code{transparent_union}, @code{unused},
3442 @code{deprecated} and @code{may_alias}.  Other attributes are defined for
3443 functions (@pxref{Function Attributes}) and for variables
3444 (@pxref{Variable Attributes}).
3445
3446 You may also specify any one of these attributes with @samp{__}
3447 preceding and following its keyword.  This allows you to use these
3448 attributes in header files without being concerned about a possible
3449 macro of the same name.  For example, you may use @code{__aligned__}
3450 instead of @code{aligned}.
3451
3452 You may specify the @code{aligned} and @code{transparent_union}
3453 attributes either in a @code{typedef} declaration or just past the
3454 closing curly brace of a complete enum, struct or union type
3455 @emph{definition} and the @code{packed} attribute only past the closing
3456 brace of a definition.
3457
3458 You may also specify attributes between the enum, struct or union
3459 tag and the name of the type rather than after the closing brace.
3460
3461 @xref{Attribute Syntax}, for details of the exact syntax for using
3462 attributes.
3463
3464 @table @code
3465 @cindex @code{aligned} attribute
3466 @item aligned (@var{alignment})
3467 This attribute specifies a minimum alignment (in bytes) for variables
3468 of the specified type.  For example, the declarations:
3469
3470 @smallexample
3471 struct S @{ short f[3]; @} __attribute__ ((aligned (8)));
3472 typedef int more_aligned_int __attribute__ ((aligned (8)));
3473 @end smallexample
3474
3475 @noindent
3476 force the compiler to insure (as far as it can) that each variable whose
3477 type is @code{struct S} or @code{more_aligned_int} will be allocated and
3478 aligned @emph{at least} on a 8-byte boundary.  On a SPARC, having all
3479 variables of type @code{struct S} aligned to 8-byte boundaries allows
3480 the compiler to use the @code{ldd} and @code{std} (doubleword load and
3481 store) instructions when copying one variable of type @code{struct S} to
3482 another, thus improving run-time efficiency.
3483
3484 Note that the alignment of any given @code{struct} or @code{union} type
3485 is required by the ISO C standard to be at least a perfect multiple of
3486 the lowest common multiple of the alignments of all of the members of
3487 the @code{struct} or @code{union} in question.  This means that you @emph{can}
3488 effectively adjust the alignment of a @code{struct} or @code{union}
3489 type by attaching an @code{aligned} attribute to any one of the members
3490 of such a type, but the notation illustrated in the example above is a
3491 more obvious, intuitive, and readable way to request the compiler to
3492 adjust the alignment of an entire @code{struct} or @code{union} type.
3493
3494 As in the preceding example, you can explicitly specify the alignment
3495 (in bytes) that you wish the compiler to use for a given @code{struct}
3496 or @code{union} type.  Alternatively, you can leave out the alignment factor
3497 and just ask the compiler to align a type to the maximum
3498 useful alignment for the target machine you are compiling for.  For
3499 example, you could write:
3500
3501 @smallexample
3502 struct S @{ short f[3]; @} __attribute__ ((aligned));
3503 @end smallexample
3504
3505 Whenever you leave out the alignment factor in an @code{aligned}
3506 attribute specification, the compiler automatically sets the alignment
3507 for the type to the largest alignment which is ever used for any data
3508 type on the target machine you are compiling for.  Doing this can often
3509 make copy operations more efficient, because the compiler can use
3510 whatever instructions copy the biggest chunks of memory when performing
3511 copies to or from the variables which have types that you have aligned
3512 this way.
3513
3514 In the example above, if the size of each @code{short} is 2 bytes, then
3515 the size of the entire @code{struct S} type is 6 bytes.  The smallest
3516 power of two which is greater than or equal to that is 8, so the
3517 compiler sets the alignment for the entire @code{struct S} type to 8
3518 bytes.
3519
3520 Note that although you can ask the compiler to select a time-efficient
3521 alignment for a given type and then declare only individual stand-alone
3522 objects of that type, the compiler's ability to select a time-efficient
3523 alignment is primarily useful only when you plan to create arrays of
3524 variables having the relevant (efficiently aligned) type.  If you
3525 declare or use arrays of variables of an efficiently-aligned type, then
3526 it is likely that your program will also be doing pointer arithmetic (or
3527 subscripting, which amounts to the same thing) on pointers to the
3528 relevant type, and the code that the compiler generates for these
3529 pointer arithmetic operations will often be more efficient for
3530 efficiently-aligned types than for other types.
3531
3532 The @code{aligned} attribute can only increase the alignment; but you
3533 can decrease it by specifying @code{packed} as well.  See below.
3534
3535 Note that the effectiveness of @code{aligned} attributes may be limited
3536 by inherent limitations in your linker.  On many systems, the linker is
3537 only able to arrange for variables to be aligned up to a certain maximum
3538 alignment.  (For some linkers, the maximum supported alignment may
3539 be very very small.)  If your linker is only able to align variables
3540 up to a maximum of 8 byte alignment, then specifying @code{aligned(16)}
3541 in an @code{__attribute__} will still only provide you with 8 byte
3542 alignment.  See your linker documentation for further information.
3543
3544 @item packed
3545 This attribute, attached to @code{struct} or @code{union} type
3546 definition, specifies that each member of the structure or union is
3547 placed to minimize the memory required. When attached to an @code{enum}
3548 definition, it indicates that the smallest integral type should be used.
3549
3550 @opindex fshort-enums
3551 Specifying this attribute for @code{struct} and @code{union} types is
3552 equivalent to specifying the @code{packed} attribute on each of the
3553 structure or union members.  Specifying the @option{-fshort-enums}
3554 flag on the line is equivalent to specifying the @code{packed}
3555 attribute on all @code{enum} definitions.
3556
3557 In the following example @code{struct my_packed_struct}'s members are
3558 packed closely together, but the internal layout of its @code{s} member
3559 is not packed -- to do that, @code{struct my_unpacked_struct} would need to
3560 be packed too.
3561
3562 @smallexample
3563 struct my_unpacked_struct
3564  @{
3565     char c;
3566     int i;
3567  @};
3568
3569 struct my_packed_struct __attribute__ ((__packed__))
3570   @{
3571      char c;
3572      int  i;
3573      struct my_unpacked_struct s;
3574   @};
3575 @end smallexample
3576
3577 You may only specify this attribute on the definition of a @code{enum},
3578 @code{struct} or @code{union}, not on a @code{typedef} which does not
3579 also define the enumerated type, structure or union.
3580
3581 @item transparent_union
3582 This attribute, attached to a @code{union} type definition, indicates
3583 that any function parameter having that union type causes calls to that
3584 function to be treated in a special way.
3585
3586 First, the argument corresponding to a transparent union type can be of
3587 any type in the union; no cast is required.  Also, if the union contains
3588 a pointer type, the corresponding argument can be a null pointer
3589 constant or a void pointer expression; and if the union contains a void
3590 pointer type, the corresponding argument can be any pointer expression.
3591 If the union member type is a pointer, qualifiers like @code{const} on
3592 the referenced type must be respected, just as with normal pointer
3593 conversions.
3594
3595 Second, the argument is passed to the function using the calling
3596 conventions of the first member of the transparent union, not the calling
3597 conventions of the union itself.  All members of the union must have the
3598 same machine representation; this is necessary for this argument passing
3599 to work properly.
3600
3601 Transparent unions are designed for library functions that have multiple
3602 interfaces for compatibility reasons.  For example, suppose the
3603 @code{wait} function must accept either a value of type @code{int *} to
3604 comply with Posix, or a value of type @code{union wait *} to comply with
3605 the 4.1BSD interface.  If @code{wait}'s parameter were @code{void *},
3606 @code{wait} would accept both kinds of arguments, but it would also
3607 accept any other pointer type and this would make argument type checking
3608 less useful.  Instead, @code{<sys/wait.h>} might define the interface
3609 as follows:
3610
3611 @smallexample
3612 typedef union
3613   @{
3614     int *__ip;
3615     union wait *__up;
3616   @} wait_status_ptr_t __attribute__ ((__transparent_union__));
3617
3618 pid_t wait (wait_status_ptr_t);
3619 @end smallexample
3620
3621 This interface allows either @code{int *} or @code{union wait *}
3622 arguments to be passed, using the @code{int *} calling convention.
3623 The program can call @code{wait} with arguments of either type:
3624
3625 @smallexample
3626 int w1 () @{ int w; return wait (&w); @}
3627 int w2 () @{ union wait w; return wait (&w); @}
3628 @end smallexample
3629
3630 With this interface, @code{wait}'s implementation might look like this:
3631
3632 @smallexample
3633 pid_t wait (wait_status_ptr_t p)
3634 @{
3635   return waitpid (-1, p.__ip, 0);
3636 @}
3637 @end smallexample
3638
3639 @item unused
3640 When attached to a type (including a @code{union} or a @code{struct}),
3641 this attribute means that variables of that type are meant to appear
3642 possibly unused.  GCC will not produce a warning for any variables of
3643 that type, even if the variable appears to do nothing.  This is often
3644 the case with lock or thread classes, which are usually defined and then
3645 not referenced, but contain constructors and destructors that have
3646 nontrivial bookkeeping functions.
3647
3648 @item deprecated
3649 The @code{deprecated} attribute results in a warning if the type
3650 is used anywhere in the source file.  This is useful when identifying
3651 types that are expected to be removed in a future version of a program.
3652 If possible, the warning also includes the location of the declaration
3653 of the deprecated type, to enable users to easily find further
3654 information about why the type is deprecated, or what they should do
3655 instead.  Note that the warnings only occur for uses and then only
3656 if the type is being applied to an identifier that itself is not being
3657 declared as deprecated.
3658
3659 @smallexample
3660 typedef int T1 __attribute__ ((deprecated));
3661 T1 x;
3662 typedef T1 T2;
3663 T2 y;
3664 typedef T1 T3 __attribute__ ((deprecated));
3665 T3 z __attribute__ ((deprecated));
3666 @end smallexample
3667
3668 results in a warning on line 2 and 3 but not lines 4, 5, or 6.  No
3669 warning is issued for line 4 because T2 is not explicitly
3670 deprecated.  Line 5 has no warning because T3 is explicitly
3671 deprecated.  Similarly for line 6.
3672
3673 The @code{deprecated} attribute can also be used for functions and
3674 variables (@pxref{Function Attributes}, @pxref{Variable Attributes}.)
3675
3676 @item may_alias
3677 Accesses to objects with types with this attribute are not subjected to
3678 type-based alias analysis, but are instead assumed to be able to alias
3679 any other type of objects, just like the @code{char} type.  See
3680 @option{-fstrict-aliasing} for more information on aliasing issues.
3681
3682 Example of use:
3683
3684 @smallexample
3685 typedef short __attribute__((__may_alias__)) short_a;
3686
3687 int
3688 main (void)
3689 @{
3690   int a = 0x12345678;
3691   short_a *b = (short_a *) &a;
3692
3693   b[1] = 0;
3694
3695   if (a == 0x12345678)
3696     abort();
3697
3698   exit(0);
3699 @}
3700 @end smallexample
3701
3702 If you replaced @code{short_a} with @code{short} in the variable
3703 declaration, the above program would abort when compiled with
3704 @option{-fstrict-aliasing}, which is on by default at @option{-O2} or
3705 above in recent GCC versions.
3706
3707 @subsection i386 Type Attributes
3708
3709 Two attributes are currently defined for i386 configurations:
3710 @code{ms_struct} and @code{gcc_struct}
3711
3712 @item ms_struct
3713 @itemx gcc_struct
3714 @cindex @code{ms_struct}
3715 @cindex @code{gcc_struct}
3716
3717 If @code{packed} is used on a structure, or if bit-fields are used
3718 it may be that the Microsoft ABI packs them differently
3719 than GCC would normally pack them.  Particularly when moving packed
3720 data between functions compiled with GCC and the native Microsoft compiler
3721 (either via function call or as data in a file), it may be necessary to access
3722 either format.
3723
3724 Currently @option{-m[no-]ms-bitfields} is provided for the Microsoft Windows X86
3725 compilers to match the native Microsoft compiler.
3726 @end table
3727
3728 To specify multiple attributes, separate them by commas within the
3729 double parentheses: for example, @samp{__attribute__ ((aligned (16),
3730 packed))}.
3731
3732 @node Inline
3733 @section An Inline Function is As Fast As a Macro
3734 @cindex inline functions
3735 @cindex integrating function code
3736 @cindex open coding
3737 @cindex macros, inline alternative
3738
3739 By declaring a function @code{inline}, you can direct GCC to
3740 integrate that function's code into the code for its callers.  This
3741 makes execution faster by eliminating the function-call overhead; in
3742 addition, if any of the actual argument values are constant, their known
3743 values may permit simplifications at compile time so that not all of the
3744 inline function's code needs to be included.  The effect on code size is
3745 less predictable; object code may be larger or smaller with function
3746 inlining, depending on the particular case.  Inlining of functions is an
3747 optimization and it really ``works'' only in optimizing compilation.  If
3748 you don't use @option{-O}, no function is really inline.
3749
3750 Inline functions are included in the ISO C99 standard, but there are
3751 currently substantial differences between what GCC implements and what
3752 the ISO C99 standard requires.
3753
3754 To declare a function inline, use the @code{inline} keyword in its
3755 declaration, like this:
3756
3757 @smallexample
3758 inline int
3759 inc (int *a)
3760 @{
3761   (*a)++;
3762 @}
3763 @end smallexample
3764
3765 (If you are writing a header file to be included in ISO C programs, write
3766 @code{__inline__} instead of @code{inline}.  @xref{Alternate Keywords}.)
3767 You can also make all ``simple enough'' functions inline with the option
3768 @option{-finline-functions}.
3769
3770 @opindex Winline
3771 Note that certain usages in a function definition can make it unsuitable
3772 for inline substitution.  Among these usages are: use of varargs, use of
3773 alloca, use of variable sized data types (@pxref{Variable Length}),
3774 use of computed goto (@pxref{Labels as Values}), use of nonlocal goto,
3775 and nested functions (@pxref{Nested Functions}).  Using @option{-Winline}
3776 will warn when a function marked @code{inline} could not be substituted,
3777 and will give the reason for the failure.
3778
3779 Note that in C and Objective-C, unlike C++, the @code{inline} keyword
3780 does not affect the linkage of the function.
3781
3782 @cindex automatic @code{inline} for C++ member fns
3783 @cindex @code{inline} automatic for C++ member fns
3784 @cindex member fns, automatically @code{inline}
3785 @cindex C++ member fns, automatically @code{inline}
3786 @opindex fno-default-inline
3787 GCC automatically inlines member functions defined within the class
3788 body of C++ programs even if they are not explicitly declared
3789 @code{inline}.  (You can override this with @option{-fno-default-inline};
3790 @pxref{C++ Dialect Options,,Options Controlling C++ Dialect}.)
3791
3792 @cindex inline functions, omission of
3793 @opindex fkeep-inline-functions
3794 When a function is both inline and @code{static}, if all calls to the
3795 function are integrated into the caller, and the function's address is
3796 never used, then the function's own assembler code is never referenced.
3797 In this case, GCC does not actually output assembler code for the
3798 function, unless you specify the option @option{-fkeep-inline-functions}.
3799 Some calls cannot be integrated for various reasons (in particular,
3800 calls that precede the function's definition cannot be integrated, and
3801 neither can recursive calls within the definition).  If there is a
3802 nonintegrated call, then the function is compiled to assembler code as
3803 usual.  The function must also be compiled as usual if the program
3804 refers to its address, because that can't be inlined.
3805
3806 @cindex non-static inline function
3807 When an inline function is not @code{static}, then the compiler must assume
3808 that there may be calls from other source files; since a global symbol can
3809 be defined only once in any program, the function must not be defined in
3810 the other source files, so the calls therein cannot be integrated.
3811 Therefore, a non-@code{static} inline function is always compiled on its
3812 own in the usual fashion.
3813
3814 If you specify both @code{inline} and @code{extern} in the function
3815 definition, then the definition is used only for inlining.  In no case
3816 is the function compiled on its own, not even if you refer to its
3817 address explicitly.  Such an address becomes an external reference, as
3818 if you had only declared the function, and had not defined it.
3819
3820 This combination of @code{inline} and @code{extern} has almost the
3821 effect of a macro.  The way to use it is to put a function definition in
3822 a header file with these keywords, and put another copy of the
3823 definition (lacking @code{inline} and @code{extern}) in a library file.
3824 The definition in the header file will cause most calls to the function
3825 to be inlined.  If any uses of the function remain, they will refer to
3826 the single copy in the library.
3827
3828 Since GCC eventually will implement ISO C99 semantics for
3829 inline functions, it is best to use @code{static inline} only
3830 to guarantee compatibility.  (The
3831 existing semantics will remain available when @option{-std=gnu89} is
3832 specified, but eventually the default will be @option{-std=gnu99} and
3833 that will implement the C99 semantics, though it does not do so yet.)
3834
3835 GCC does not inline any functions when not optimizing unless you specify
3836 the @samp{always_inline} attribute for the function, like this:
3837
3838 @smallexample
3839 /* Prototype.  */
3840 inline void foo (const char) __attribute__((always_inline));
3841 @end smallexample
3842
3843 @node Extended Asm
3844 @section Assembler Instructions with C Expression Operands
3845 @cindex extended @code{asm}
3846 @cindex @code{asm} expressions
3847 @cindex assembler instructions
3848 @cindex registers
3849
3850 In an assembler instruction using @code{asm}, you can specify the
3851 operands of the instruction using C expressions.  This means you need not
3852 guess which registers or memory locations will contain the data you want
3853 to use.
3854
3855 You must specify an assembler instruction template much like what
3856 appears in a machine description, plus an operand constraint string for
3857 each operand.
3858
3859 For example, here is how to use the 68881's @code{fsinx} instruction:
3860
3861 @smallexample
3862 asm ("fsinx %1,%0" : "=f" (result) : "f" (angle));
3863 @end smallexample
3864
3865 @noindent
3866 Here @code{angle} is the C expression for the input operand while
3867 @code{result} is that of the output operand.  Each has @samp{"f"} as its
3868 operand constraint, saying that a floating point register is required.
3869 The @samp{=} in @samp{=f} indicates that the operand is an output; all
3870 output operands' constraints must use @samp{=}.  The constraints use the
3871 same language used in the machine description (@pxref{Constraints}).
3872
3873 Each operand is described by an operand-constraint string followed by
3874 the C expression in parentheses.  A colon separates the assembler
3875 template from the first output operand and another separates the last
3876 output operand from the first input, if any.  Commas separate the
3877 operands within each group.  The total number of operands is currently
3878 limited to 30; this limitation may be lifted in some future version of
3879 GCC.
3880
3881 If there are no output operands but there are input operands, you must
3882 place two consecutive colons surrounding the place where the output
3883 operands would go.
3884
3885 As of GCC version 3.1, it is also possible to specify input and output
3886 operands using symbolic names which can be referenced within the
3887 assembler code.  These names are specified inside square brackets
3888 preceding the constraint string, and can be referenced inside the
3889 assembler code using @code{%[@var{name}]} instead of a percentage sign
3890 followed by the operand number.  Using named operands the above example
3891 could look like:
3892
3893 @smallexample
3894 asm ("fsinx %[angle],%[output]"
3895      : [output] "=f" (result)
3896      : [angle] "f" (angle));
3897 @end smallexample
3898
3899 @noindent
3900 Note that the symbolic operand names have no relation whatsoever to
3901 other C identifiers.  You may use any name you like, even those of
3902 existing C symbols, but you must ensure that no two operands within the same
3903 assembler construct use the same symbolic name.
3904
3905 Output operand expressions must be lvalues; the compiler can check this.
3906 The input operands need not be lvalues.  The compiler cannot check
3907 whether the operands have data types that are reasonable for the
3908 instruction being executed.  It does not parse the assembler instruction
3909 template and does not know what it means or even whether it is valid
3910 assembler input.  The extended @code{asm} feature is most often used for
3911 machine instructions the compiler itself does not know exist.  If
3912 the output expression cannot be directly addressed (for example, it is a
3913 bit-field), your constraint must allow a register.  In that case, GCC
3914 will use the register as the output of the @code{asm}, and then store
3915 that register into the output.
3916
3917 The ordinary output operands must be write-only; GCC will assume that
3918 the values in these operands before the instruction are dead and need
3919 not be generated.  Extended asm supports input-output or read-write
3920 operands.  Use the constraint character @samp{+} to indicate such an
3921 operand and list it with the output operands.  You should only use
3922 read-write operands when the constraints for the operand (or the
3923 operand in which only some of the bits are to be changed) allow a
3924 register.
3925
3926 You may, as an alternative, logically split its function into two
3927 separate operands, one input operand and one write-only output
3928 operand.  The connection between them is expressed by constraints
3929 which say they need to be in the same location when the instruction
3930 executes.  You can use the same C expression for both operands, or
3931 different expressions.  For example, here we write the (fictitious)
3932 @samp{combine} instruction with @code{bar} as its read-only source
3933 operand and @code{foo} as its read-write destination:
3934
3935 @smallexample
3936 asm ("combine %2,%0" : "=r" (foo) : "0" (foo), "g" (bar));
3937 @end smallexample
3938
3939 @noindent
3940 The constraint @samp{"0"} for operand 1 says that it must occupy the
3941 same location as operand 0.  A number in constraint is allowed only in
3942 an input operand and it must refer to an output operand.
3943
3944 Only a number in the constraint can guarantee that one operand will be in
3945 the same place as another.  The mere fact that @code{foo} is the value
3946 of both operands is not enough to guarantee that they will be in the
3947 same place in the generated assembler code.  The following would not
3948 work reliably:
3949
3950 @smallexample
3951 asm ("combine %2,%0" : "=r" (foo) : "r" (foo), "g" (bar));
3952 @end smallexample
3953
3954 Various optimizations or reloading could cause operands 0 and 1 to be in
3955 different registers; GCC knows no reason not to do so.  For example, the
3956 compiler might find a copy of the value of @code{foo} in one register and
3957 use it for operand 1, but generate the output operand 0 in a different
3958 register (copying it afterward to @code{foo}'s own address).  Of course,
3959 since the register for operand 1 is not even mentioned in the assembler
3960 code, the result will not work, but GCC can't tell that.
3961
3962 As of GCC version 3.1, one may write @code{[@var{name}]} instead of
3963 the operand number for a matching constraint.  For example:
3964
3965 @smallexample
3966 asm ("cmoveq %1,%2,%[result]"
3967      : [result] "=r"(result)
3968      : "r" (test), "r"(new), "[result]"(old));
3969 @end smallexample
3970
3971 Some instructions clobber specific hard registers.  To describe this,
3972 write a third colon after the input operands, followed by the names of
3973 the clobbered hard registers (given as strings).  Here is a realistic
3974 example for the VAX:
3975
3976 @smallexample
3977 asm volatile ("movc3 %0,%1,%2"
3978               : /* no outputs */
3979               : "g" (from), "g" (to), "g" (count)
3980               : "r0", "r1", "r2", "r3", "r4", "r5");
3981 @end smallexample
3982
3983 You may not write a clobber description in a way that overlaps with an
3984 input or output operand.  For example, you may not have an operand
3985 describing a register class with one member if you mention that register
3986 in the clobber list.  Variables declared to live in specific registers
3987 (@pxref{Explicit Reg Vars}), and used as asm input or output operands must
3988 have no part mentioned in the clobber description.
3989 There is no way for you to specify that an input
3990 operand is modified without also specifying it as an output
3991 operand.  Note that if all the output operands you specify are for this
3992 purpose (and hence unused), you will then also need to specify
3993 @code{volatile} for the @code{asm} construct, as described below, to
3994 prevent GCC from deleting the @code{asm} statement as unused.
3995
3996 If you refer to a particular hardware register from the assembler code,
3997 you will probably have to list the register after the third colon to
3998 tell the compiler the register's value is modified.  In some assemblers,
3999 the register names begin with @samp{%}; to produce one @samp{%} in the
4000 assembler code, you must write @samp{%%} in the input.
4001
4002 If your assembler instruction can alter the condition code register, add
4003 @samp{cc} to the list of clobbered registers.  GCC on some machines
4004 represents the condition codes as a specific hardware register;
4005 @samp{cc} serves to name this register.  On other machines, the
4006 condition code is handled differently, and specifying @samp{cc} has no
4007 effect.  But it is valid no matter what the machine.
4008
4009 If your assembler instruction modifies memory in an unpredictable
4010 fashion, add @samp{memory} to the list of clobbered registers.  This
4011 will cause GCC to not keep memory values cached in registers across
4012 the assembler instruction.  You will also want to add the
4013 @code{volatile} keyword if the memory affected is not listed in the
4014 inputs or outputs of the @code{asm}, as the @samp{memory} clobber does
4015 not count as a side-effect of the @code{asm}.
4016
4017 You can put multiple assembler instructions together in a single
4018 @code{asm} template, separated by the characters normally used in assembly
4019 code for the system.  A combination that works in most places is a newline
4020 to break the line, plus a tab character to move to the instruction field
4021 (written as @samp{\n\t}).  Sometimes semicolons can be used, if the
4022 assembler allows semicolons as a line-breaking character.  Note that some
4023 assembler dialects use semicolons to start a comment.
4024 The input operands are guaranteed not to use any of the clobbered
4025 registers, and neither will the output operands' addresses, so you can
4026 read and write the clobbered registers as many times as you like.  Here
4027 is an example of multiple instructions in a template; it assumes the
4028 subroutine @code{_foo} accepts arguments in registers 9 and 10:
4029
4030 @smallexample
4031 asm ("movl %0,r9\n\tmovl %1,r10\n\tcall _foo"
4032      : /* no outputs */
4033      : "g" (from), "g" (to)
4034      : "r9", "r10");
4035 @end smallexample
4036
4037 Unless an output operand has the @samp{&} constraint modifier, GCC
4038 may allocate it in the same register as an unrelated input operand, on
4039 the assumption the inputs are consumed before the outputs are produced.
4040 This assumption may be false if the assembler code actually consists of
4041 more than one instruction.  In such a case, use @samp{&} for each output
4042 operand that may not overlap an input.  @xref{Modifiers}.
4043
4044 If you want to test the condition code produced by an assembler
4045 instruction, you must include a branch and a label in the @code{asm}
4046 construct, as follows:
4047
4048 @smallexample
4049 asm ("clr %0\n\tfrob %1\n\tbeq 0f\n\tmov #1,%0\n0:"
4050      : "g" (result)
4051      : "g" (input));
4052 @end smallexample
4053
4054 @noindent
4055 This assumes your assembler supports local labels, as the GNU assembler
4056 and most Unix assemblers do.
4057
4058 Speaking of labels, jumps from one @code{asm} to another are not
4059 supported.  The compiler's optimizers do not know about these jumps, and
4060 therefore they cannot take account of them when deciding how to
4061 optimize.
4062
4063 @cindex macros containing @code{asm}
4064 Usually the most convenient way to use these @code{asm} instructions is to
4065 encapsulate them in macros that look like functions.  For example,
4066
4067 @smallexample
4068 #define sin(x)       \
4069 (@{ double __value, __arg = (x);   \
4070    asm ("fsinx %1,%0": "=f" (__value): "f" (__arg));  \
4071    __value; @})
4072 @end smallexample
4073
4074 @noindent
4075 Here the variable @code{__arg} is used to make sure that the instruction
4076 operates on a proper @code{double} value, and to accept only those
4077 arguments @code{x} which can convert automatically to a @code{double}.
4078
4079 Another way to make sure the instruction operates on the correct data
4080 type is to use a cast in the @code{asm}.  This is different from using a
4081 variable @code{__arg} in that it converts more different types.  For
4082 example, if the desired type were @code{int}, casting the argument to
4083 @code{int} would accept a pointer with no complaint, while assigning the
4084 argument to an @code{int} variable named @code{__arg} would warn about
4085 using a pointer unless the caller explicitly casts it.
4086
4087 If an @code{asm} has output operands, GCC assumes for optimization
4088 purposes the instruction has no side effects except to change the output
4089 operands.  This does not mean instructions with a side effect cannot be
4090 used, but you must be careful, because the compiler may eliminate them
4091 if the output operands aren't used, or move them out of loops, or
4092 replace two with one if they constitute a common subexpression.  Also,
4093 if your instruction does have a side effect on a variable that otherwise
4094 appears not to change, the old value of the variable may be reused later
4095 if it happens to be found in a register.
4096
4097 You can prevent an @code{asm} instruction from being deleted, moved
4098 significantly, or combined, by writing the keyword @code{volatile} after
4099 the @code{asm}.  For example:
4100
4101 @smallexample
4102 #define get_and_set_priority(new)              \
4103 (@{ int __old;                                  \
4104    asm volatile ("get_and_set_priority %0, %1" \
4105                  : "=g" (__old) : "g" (new));  \
4106    __old; @})
4107 @end smallexample
4108
4109 @noindent
4110 If you write an @code{asm} instruction with no outputs, GCC will know
4111 the instruction has side-effects and will not delete the instruction or
4112 move it outside of loops.
4113
4114 The @code{volatile} keyword indicates that the instruction has
4115 important side-effects.  GCC will not delete a volatile @code{asm} if
4116 it is reachable.  (The instruction can still be deleted if GCC can
4117 prove that control-flow will never reach the location of the
4118 instruction.)  In addition, GCC will not reschedule instructions
4119 across a volatile @code{asm} instruction.  For example:
4120
4121 @smallexample
4122 *(volatile int *)addr = foo;
4123 asm volatile ("eieio" : : );
4124 @end smallexample
4125
4126 @noindent
4127 Assume @code{addr} contains the address of a memory mapped device
4128 register.  The PowerPC @code{eieio} instruction (Enforce In-order
4129 Execution of I/O) tells the CPU to make sure that the store to that
4130 device register happens before it issues any other I/O@.
4131
4132 Note that even a volatile @code{asm} instruction can be moved in ways
4133 that appear insignificant to the compiler, such as across jump
4134 instructions.  You can't expect a sequence of volatile @code{asm}
4135 instructions to remain perfectly consecutive.  If you want consecutive
4136 output, use a single @code{asm}.  Also, GCC will perform some
4137 optimizations across a volatile @code{asm} instruction; GCC does not
4138 ``forget everything'' when it encounters a volatile @code{asm}
4139 instruction the way some other compilers do.
4140
4141 An @code{asm} instruction without any operands or clobbers (an ``old
4142 style'' @code{asm}) will be treated identically to a volatile
4143 @code{asm} instruction.
4144
4145 It is a natural idea to look for a way to give access to the condition
4146 code left by the assembler instruction.  However, when we attempted to
4147 implement this, we found no way to make it work reliably.  The problem
4148 is that output operands might need reloading, which would result in
4149 additional following ``store'' instructions.  On most machines, these
4150 instructions would alter the condition code before there was time to
4151 test it.  This problem doesn't arise for ordinary ``test'' and
4152 ``compare'' instructions because they don't have any output operands.
4153
4154 For reasons similar to those described above, it is not possible to give
4155 an assembler instruction access to the condition code left by previous
4156 instructions.
4157
4158 If you are writing a header file that should be includable in ISO C
4159 programs, write @code{__asm__} instead of @code{asm}.  @xref{Alternate
4160 Keywords}.
4161
4162 @subsection Size of an @code{asm}
4163
4164 Some targets require that GCC track the size of each instruction used in
4165 order to generate correct code.  Because the final length of an
4166 @code{asm} is only known by the assembler, GCC must make an estimate as
4167 to how big it will be.  The estimate is formed by counting the number of
4168 statements in the pattern of the @code{asm} and multiplying that by the
4169 length of the longest instruction on that processor.  Statements in the
4170 @code{asm} are identified by newline characters and whatever statement
4171 separator characters are supported by the assembler; on most processors
4172 this is the `@code{;}' character.
4173
4174 Normally, GCC's estimate is perfectly adequate to ensure that correct
4175 code is generated, but it is possible to confuse the compiler if you use
4176 pseudo instructions or assembler macros that expand into multiple real
4177 instructions or if you use assembler directives that expand to more
4178 space in the object file than would be needed for a single instruction.
4179 If this happens then the assembler will produce a diagnostic saying that
4180 a label is unreachable.
4181
4182 @subsection i386 floating point asm operands
4183
4184 There are several rules on the usage of stack-like regs in
4185 asm_operands insns.  These rules apply only to the operands that are
4186 stack-like regs:
4187
4188 @enumerate
4189 @item
4190 Given a set of input regs that die in an asm_operands, it is
4191 necessary to know which are implicitly popped by the asm, and
4192 which must be explicitly popped by gcc.
4193
4194 An input reg that is implicitly popped by the asm must be
4195 explicitly clobbered, unless it is constrained to match an
4196 output operand.
4197
4198 @item
4199 For any input reg that is implicitly popped by an asm, it is
4200 necessary to know how to adjust the stack to compensate for the pop.
4201 If any non-popped input is closer to the top of the reg-stack than
4202 the implicitly popped reg, it would not be possible to know what the
4203 stack looked like---it's not clear how the rest of the stack ``slides
4204 up''.
4205
4206 All implicitly popped input regs must be closer to the top of
4207 the reg-stack than any input that is not implicitly popped.
4208
4209 It is possible that if an input dies in an insn, reload might
4210 use the input reg for an output reload.  Consider this example:
4211
4212 @smallexample
4213 asm ("foo" : "=t" (a) : "f" (b));
4214 @end smallexample
4215
4216 This asm says that input B is not popped by the asm, and that
4217 the asm pushes a result onto the reg-stack, i.e., the stack is one
4218 deeper after the asm than it was before.  But, it is possible that
4219 reload will think that it can use the same reg for both the input and
4220 the output, if input B dies in this insn.
4221
4222 If any input operand uses the @code{f} constraint, all output reg
4223 constraints must use the @code{&} earlyclobber.
4224
4225 The asm above would be written as
4226
4227 @smallexample
4228 asm ("foo" : "=&t" (a) : "f" (b));
4229 @end smallexample
4230
4231 @item
4232 Some operands need to be in particular places on the stack.  All
4233 output operands fall in this category---there is no other way to
4234 know which regs the outputs appear in unless the user indicates
4235 this in the constraints.
4236
4237 Output operands must specifically indicate which reg an output
4238 appears in after an asm.  @code{=f} is not allowed: the operand
4239 constraints must select a class with a single reg.
4240
4241 @item
4242 Output operands may not be ``inserted'' between existing stack regs.
4243 Since no 387 opcode uses a read/write&nb