OSDN Git Service

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