OSDN Git Service

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