1 /* Encoding of types for Objective C.
2 Copyright (C) 1993, 1995, 1996, 1997, 1998, 2000, 2002
3 Free Software Foundation, Inc.
4 Contributed by Kresten Krab Thorup
5 Bitfield support by Ovidiu Predescu
7 This file is part of GNU CC.
9 GNU CC is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2, or (at your option)
14 GNU CC is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with GNU CC; see the file COPYING. If not, write to
21 the Free Software Foundation, 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
24 /* As a special exception, if you link this library with files
25 compiled with GCC to produce an executable, this does not cause
26 the resulting executable to be covered by the GNU General Public License.
27 This exception does not however invalidate any other reasons why
28 the executable file might be covered by the GNU General Public License. */
30 /* FIXME: This file has no business including tm.h. */
33 #include "coretypes.h"
41 ({ typeof (X) __x = (X), __y = (Y); \
42 (__x > __y ? __x : __y); })
46 ({ typeof (X) __x = (X), __y = (Y); \
47 (__x < __y ? __x : __y); })
51 ({ typeof (V) __v = (V); typeof (A) __a = (A); \
52 __a * ((__v+__a - 1)/__a); })
55 /* Various hacks for objc_layout_record. These are used by the target
58 #define TREE_CODE(TYPE) *(TYPE)
59 #define TREE_TYPE(TREE) (TREE)
61 #define RECORD_TYPE _C_STRUCT_B
62 #define UNION_TYPE _C_UNION_B
63 #define QUAL_UNION_TYPE _C_UNION_B
64 #define ARRAY_TYPE _C_ARY_B
66 #define REAL_TYPE _C_DBL
68 #define VECTOR_TYPE _C_VECTOR
70 #define TYPE_FIELDS(TYPE) objc_skip_typespec (TYPE)
72 #define DECL_MODE(TYPE) *(TYPE)
73 #define TYPE_MODE(TYPE) *(TYPE)
77 #define get_inner_array_type(TYPE) ((TYPE) + 1)
79 /* Some ports (eg ARM) allow the structure size boundary to be
80 selected at compile-time. We override the normal definition with
81 one that has a constant value for this compilation. */
82 #undef STRUCTURE_SIZE_BOUNDARY
83 #define STRUCTURE_SIZE_BOUNDARY (BITS_PER_UNIT * sizeof (struct{char a;}))
85 /* Some ROUND_TYPE_ALIGN macros use TARGET_foo, and consequently
86 target_flags. Define a dummy entry here to so we don't die. */
87 /* ??? FIXME: As of 2002-06-21, the attribute `unused' doesn't seem to
88 eliminate the warning. */
89 static int __attribute__ ((__unused__
)) target_flags
= 0;
92 return the size of an object specified by type
96 objc_sizeof_type (const char *type
)
98 /* Skip the variable name if any */
101 for (type
++; *type
++ != '"';)
111 return sizeof (Class
);
119 return sizeof (char);
123 return sizeof (unsigned char);
127 return sizeof (short);
131 return sizeof (unsigned short);
139 return sizeof (unsigned int);
143 return sizeof (long);
147 return sizeof (unsigned long);
151 return sizeof (long long);
155 return sizeof (unsigned long long);
159 return sizeof (float);
163 return sizeof (double);
167 return sizeof (void);
173 return sizeof (char *);
178 int len
= atoi (type
+ 1);
179 while (isdigit ((unsigned char)*++type
))
181 return len
* objc_aligned_size (type
);
187 /* The new encoding of bitfields is: b 'position' 'type' 'size' */
189 int startByte
, endByte
;
191 position
= atoi (type
+ 1);
192 while (isdigit ((unsigned char)*++type
))
194 size
= atoi (type
+ 1);
196 startByte
= position
/ BITS_PER_UNIT
;
197 endByte
= (position
+ size
) / BITS_PER_UNIT
;
198 return endByte
- startByte
;
203 struct objc_struct_layout layout
;
206 objc_layout_structure (type
, &layout
);
207 while (objc_layout_structure_next_member (&layout
))
209 objc_layout_finish_structure (&layout
, &size
, NULL
);
217 while (*type
!= _C_UNION_E
&& *type
++ != '=')
219 while (*type
!= _C_UNION_E
)
221 /* Skip the variable name if any */
224 for (type
++; *type
++ != '"';)
227 max_size
= MAX (max_size
, objc_sizeof_type (type
));
228 type
= objc_skip_typespec (type
);
235 objc_error (nil
, OBJC_ERR_BAD_TYPE
, "unknown type %s\n", type
);
243 Return the alignment of an object specified by type
247 objc_alignof_type (const char *type
)
249 /* Skip the variable name if any */
252 for (type
++; *type
++ != '"';)
257 return __alignof__ (id
);
261 return __alignof__ (Class
);
265 return __alignof__ (SEL
);
269 return __alignof__ (char);
273 return __alignof__ (unsigned char);
277 return __alignof__ (short);
281 return __alignof__ (unsigned short);
285 return __alignof__ (int);
289 return __alignof__ (unsigned int);
293 return __alignof__ (long);
297 return __alignof__ (unsigned long);
301 return __alignof__ (long long);
305 return __alignof__ (unsigned long long);
309 return __alignof__ (float);
313 return __alignof__ (double);
319 return __alignof__ (char *);
323 while (isdigit ((unsigned char)*++type
))
325 return objc_alignof_type (type
);
329 struct objc_struct_layout layout
;
332 objc_layout_structure (type
, &layout
);
333 while (objc_layout_structure_next_member (&layout
))
335 objc_layout_finish_structure (&layout
, NULL
, &align
);
343 while (*type
!= _C_UNION_E
&& *type
++ != '=')
345 while (*type
!= _C_UNION_E
)
347 /* Skip the variable name if any */
350 for (type
++; *type
++ != '"';)
353 maxalign
= MAX (maxalign
, objc_alignof_type (type
));
354 type
= objc_skip_typespec (type
);
361 objc_error (nil
, OBJC_ERR_BAD_TYPE
, "unknown type %s\n", type
);
368 The aligned size if the size rounded up to the nearest alignment.
372 objc_aligned_size (const char *type
)
376 /* Skip the variable name */
379 for (type
++; *type
++ != '"';)
383 size
= objc_sizeof_type (type
);
384 align
= objc_alignof_type (type
);
386 return ROUND (size
, align
);
390 The size rounded up to the nearest integral of the wordsize, taken
391 to be the size of a void *.
395 objc_promoted_size (const char *type
)
399 /* Skip the variable name */
402 for (type
++; *type
++ != '"';)
406 size
= objc_sizeof_type (type
);
407 wordsize
= sizeof (void *);
409 return ROUND (size
, wordsize
);
413 Skip type qualifiers. These may eventually precede typespecs
414 occurring in method prototype encodings.
418 objc_skip_type_qualifiers (const char *type
)
420 while (*type
== _C_CONST
424 || *type
== _C_BYCOPY
426 || *type
== _C_ONEWAY
427 || *type
== _C_GCINVISIBLE
)
436 Skip one typespec element. If the typespec is prepended by type
437 qualifiers, these are skipped as well.
441 objc_skip_typespec (const char *type
)
443 /* Skip the variable name if any */
446 for (type
++; *type
++ != '"';)
450 type
= objc_skip_type_qualifiers (type
);
455 /* An id may be annotated by the actual type if it is known
456 with the @"ClassName" syntax */
462 while (*++type
!= '"')
467 /* The following are one character type codes */
490 /* skip digits, typespec and closing ']' */
492 while (isdigit ((unsigned char)*++type
))
494 type
= objc_skip_typespec (type
);
495 if (*type
== _C_ARY_E
)
499 objc_error (nil
, OBJC_ERR_BAD_TYPE
, "bad array type %s\n", type
);
504 /* The new encoding of bitfields is: b 'position' 'type' 'size' */
505 while (isdigit ((unsigned char)*++type
))
506 ; /* skip position */
507 while (isdigit ((unsigned char)*++type
))
508 ; /* skip type and size */
512 /* skip name, and elements until closing '}' */
514 while (*type
!= _C_STRUCT_E
&& *type
++ != '=')
516 while (*type
!= _C_STRUCT_E
)
518 type
= objc_skip_typespec (type
);
523 /* skip name, and elements until closing ')' */
525 while (*type
!= _C_UNION_E
&& *type
++ != '=')
527 while (*type
!= _C_UNION_E
)
529 type
= objc_skip_typespec (type
);
534 /* Just skip the following typespec */
536 return objc_skip_typespec (++type
);
540 objc_error (nil
, OBJC_ERR_BAD_TYPE
, "unknown type %s\n", type
);
547 Skip an offset as part of a method encoding. This is prepended by a
548 '+' if the argument is passed in registers.
551 objc_skip_offset (const char *type
)
555 while (isdigit ((unsigned char) *++type
))
561 Skip an argument specification of a method encoding.
564 objc_skip_argspec (const char *type
)
566 type
= objc_skip_typespec (type
);
567 type
= objc_skip_offset (type
);
572 Return the number of arguments that the method MTH expects.
573 Note that all methods need two implicit arguments `self' and
577 method_get_number_of_arguments (struct objc_method
*mth
)
580 const char *type
= mth
->method_types
;
583 type
= objc_skip_argspec (type
);
590 Return the size of the argument block needed on the stack to invoke
591 the method MTH. This may be zero, if all arguments are passed in
596 method_get_sizeof_arguments (struct objc_method
*mth
)
598 const char *type
= objc_skip_typespec (mth
->method_types
);
603 Return a pointer to the next argument of ARGFRAME. type points to
604 the last argument. Typical use of this look like:
608 for (datum = method_get_first_argument (method, argframe, &type);
609 datum; datum = method_get_next_argument (argframe, &type))
611 unsigned flags = objc_get_type_qualifiers (type);
612 type = objc_skip_type_qualifiers (type);
614 [portal encodeData: datum ofType: type];
617 if ((flags & _F_IN) == _F_IN)
618 [portal encodeData: *(char **) datum ofType: ++type];
625 method_get_next_argument (arglist_t argframe
, const char **type
)
627 const char *t
= objc_skip_argspec (*type
);
633 t
= objc_skip_typespec (t
);
636 return argframe
->arg_regs
+ atoi (++t
);
638 return argframe
->arg_ptr
+ atoi (t
);
642 Return a pointer to the value of the first argument of the method
643 described in M with the given argumentframe ARGFRAME. The type
644 is returned in TYPE. type must be passed to successive calls of
645 method_get_next_argument.
648 method_get_first_argument (struct objc_method
*m
,
652 *type
= m
->method_types
;
653 return method_get_next_argument (argframe
, type
);
657 Return a pointer to the ARGth argument of the method
658 M from the frame ARGFRAME. The type of the argument
659 is returned in the value-result argument TYPE
663 method_get_nth_argument (struct objc_method
*m
,
664 arglist_t argframe
, int arg
,
667 const char *t
= objc_skip_argspec (m
->method_types
);
669 if (arg
> method_get_number_of_arguments (m
))
673 t
= objc_skip_argspec (t
);
676 t
= objc_skip_typespec (t
);
679 return argframe
->arg_regs
+ atoi (++t
);
681 return argframe
->arg_ptr
+ atoi (t
);
685 objc_get_type_qualifiers (const char *type
)
693 case _C_CONST
: res
|= _F_CONST
; break;
694 case _C_IN
: res
|= _F_IN
; break;
695 case _C_INOUT
: res
|= _F_INOUT
; break;
696 case _C_OUT
: res
|= _F_OUT
; break;
697 case _C_BYCOPY
: res
|= _F_BYCOPY
; break;
698 case _C_BYREF
: res
|= _F_BYREF
; break;
699 case _C_ONEWAY
: res
|= _F_ONEWAY
; break;
700 case _C_GCINVISIBLE
: res
|= _F_GCINVISIBLE
; break;
708 /* The following three functions can be used to determine how a
709 structure is laid out by the compiler. For example:
711 struct objc_struct_layout layout;
714 objc_layout_structure (type, &layout);
715 while (objc_layout_structure_next_member (&layout))
720 objc_layout_structure_get_info (&layout, &position, &align, &type);
721 printf ("element %d has offset %d, alignment %d\n",
722 i++, position, align);
725 These functions are used by objc_sizeof_type and objc_alignof_type
726 functions to compute the size and alignment of structures. The
727 previous method of computing the size and alignment of a structure
728 was not working on some architectures, particulary on AIX, and in
729 the presence of bitfields inside the structure. */
731 objc_layout_structure (const char *type
,
732 struct objc_struct_layout
*layout
)
736 if (*type
++ != _C_STRUCT_B
)
738 objc_error (nil
, OBJC_ERR_BAD_TYPE
,
739 "record type expected in objc_layout_structure, got %s\n",
743 layout
->original_type
= type
;
745 /* Skip "<name>=" if any. Avoid embedded structures and unions. */
747 while (*ntype
!= _C_STRUCT_E
&& *ntype
!= _C_STRUCT_B
&& *ntype
!= _C_UNION_B
751 /* If there's a "<name>=", ntype - 1 points to '='; skip the the name */
752 if (*(ntype
- 1) == '=')
756 layout
->prev_type
= NULL
;
757 layout
->record_size
= 0;
758 layout
->record_align
= BITS_PER_UNIT
;
760 layout
->record_align
= MAX (layout
->record_align
, STRUCTURE_SIZE_BOUNDARY
);
765 objc_layout_structure_next_member (struct objc_struct_layout
*layout
)
767 register int desired_align
= 0;
769 /* The following are used only if the field is a bitfield */
770 register const char *bfld_type
= 0;
771 register int bfld_type_size
, bfld_type_align
= 0, bfld_field_size
= 0;
773 /* The current type without the type qualifiers */
776 /* Add the size of the previous field to the size of the record. */
777 if (layout
->prev_type
)
779 type
= objc_skip_type_qualifiers (layout
->prev_type
);
781 if (*type
!= _C_BFLD
)
782 layout
->record_size
+= objc_sizeof_type (type
) * BITS_PER_UNIT
;
784 /* Get the bitfield's type */
785 for (bfld_type
= type
+ 1;
786 isdigit ((unsigned char)*bfld_type
);
790 bfld_type_size
= objc_sizeof_type (bfld_type
) * BITS_PER_UNIT
;
791 bfld_type_align
= objc_alignof_type (bfld_type
) * BITS_PER_UNIT
;
792 bfld_field_size
= atoi (objc_skip_typespec (bfld_type
));
793 layout
->record_size
+= bfld_field_size
;
797 if (*layout
->type
== _C_STRUCT_E
)
800 /* Skip the variable name if any */
801 if (*layout
->type
== '"')
803 for (layout
->type
++; *layout
->type
++ != '"';)
807 type
= objc_skip_type_qualifiers (layout
->type
);
809 if (*type
!= _C_BFLD
)
810 desired_align
= objc_alignof_type (type
) * BITS_PER_UNIT
;
814 /* Skip the bitfield's offset */
815 for (bfld_type
= type
+ 1;
816 isdigit ((unsigned char) *bfld_type
);
820 bfld_type_size
= objc_sizeof_type (bfld_type
) * BITS_PER_UNIT
;
821 bfld_type_align
= objc_alignof_type (bfld_type
) * BITS_PER_UNIT
;
822 bfld_field_size
= atoi (objc_skip_typespec (bfld_type
));
825 #ifdef BIGGEST_FIELD_ALIGNMENT
826 desired_align
= MIN (desired_align
, BIGGEST_FIELD_ALIGNMENT
);
828 #ifdef ADJUST_FIELD_ALIGN
829 desired_align
= ADJUST_FIELD_ALIGN (type
, desired_align
);
832 /* Record must have at least as much alignment as any field.
833 Otherwise, the alignment of the field within the record
835 #ifndef PCC_BITFIELD_TYPE_MATTERS
836 layout
->record_align
= MAX (layout
->record_align
, desired_align
);
837 #else /* PCC_BITFIELD_TYPE_MATTERS */
838 if (*type
== _C_BFLD
)
840 /* For these machines, a zero-length field does not
841 affect the alignment of the structure as a whole.
842 It does, however, affect the alignment of the next field
843 within the structure. */
845 layout
->record_align
= MAX (layout
->record_align
, desired_align
);
847 desired_align
= objc_alignof_type (bfld_type
) * BITS_PER_UNIT
;
849 /* A named bit field of declared type `int'
850 forces the entire structure to have `int' alignment.
851 Q1: How is encoded this thing and how to check for it?
852 Q2: How to determine maximum_field_alignment at runtime? */
854 /* if (DECL_NAME (field) != 0) */
856 int type_align
= bfld_type_align
;
858 if (maximum_field_alignment
!= 0)
859 type_align
= MIN (type_align
, maximum_field_alignment
);
860 else if (DECL_PACKED (field
))
861 type_align
= MIN (type_align
, BITS_PER_UNIT
);
864 layout
->record_align
= MAX (layout
->record_align
, type_align
);
868 layout
->record_align
= MAX (layout
->record_align
, desired_align
);
869 #endif /* PCC_BITFIELD_TYPE_MATTERS */
871 /* Does this field automatically have alignment it needs
872 by virtue of the fields that precede it and the record's
875 if (*type
== _C_BFLD
)
876 layout
->record_size
= atoi (type
+ 1);
877 else if (layout
->record_size
% desired_align
!= 0)
879 /* No, we need to skip space before this field.
880 Bump the cumulative size to multiple of field alignment. */
881 layout
->record_size
= ROUND (layout
->record_size
, desired_align
);
884 /* Jump to the next field in record. */
886 layout
->prev_type
= layout
->type
;
887 layout
->type
= objc_skip_typespec (layout
->type
); /* skip component */
893 void objc_layout_finish_structure (struct objc_struct_layout
*layout
,
897 if (layout
->type
&& *layout
->type
== _C_STRUCT_E
)
899 /* Work out the alignment of the record as one expression and store
900 in the record type. Round it up to a multiple of the record's
903 #if defined (ROUND_TYPE_ALIGN) && ! defined (__sparc__)
904 layout
->record_align
= ROUND_TYPE_ALIGN (layout
->original_type
,
906 layout
->record_align
);
908 layout
->record_align
= MAX (1, layout
->record_align
);
911 #ifdef ROUND_TYPE_SIZE
912 layout
->record_size
= ROUND_TYPE_SIZE (layout
->original_type
,
914 layout
->record_align
);
916 /* Round the size up to be a multiple of the required alignment */
917 layout
->record_size
= ROUND (layout
->record_size
, layout
->record_align
);
923 *size
= layout
->record_size
/ BITS_PER_UNIT
;
925 *align
= layout
->record_align
/ BITS_PER_UNIT
;
929 void objc_layout_structure_get_info (struct objc_struct_layout
*layout
,
930 unsigned int *offset
,
935 *offset
= layout
->record_size
/ BITS_PER_UNIT
;
937 *align
= layout
->record_align
/ BITS_PER_UNIT
;
939 *type
= layout
->prev_type
;