1 /* Encoding of types for Objective C.
2 Copyright (C) 1993, 1995, 1996, 1997, 1998, 2000, 2002, 2004
3 Free Software Foundation, Inc.
4 Contributed by Kresten Krab Thorup
5 Bitfield support by Ovidiu Predescu
7 This file is part of GCC.
9 GCC 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 GCC 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 GCC; see the file COPYING. If not, write to
21 the Free Software Foundation, 51 Franklin Street, Fifth Floor,
22 Boston, MA 02110-1301, 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"
35 #include "objc/objc-api.h"
36 #include "objc/encoding.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. */
83 #define BITS_PER_UNIT 8
85 #undef STRUCTURE_SIZE_BOUNDARY
86 #define STRUCTURE_SIZE_BOUNDARY (BITS_PER_UNIT * sizeof (struct{char a;}))
88 /* Some ROUND_TYPE_ALIGN macros use TARGET_foo, and consequently
89 target_flags. Define a dummy entry here to so we don't die.
90 We have to rename it because target_flags may already have been
92 #define target_flags not_target_flags
93 static int __attribute__ ((__unused__
)) not_target_flags
= 0;
95 /* Some ROUND_TYPE_ALIGN use ALTIVEC_VECTOR_MODE (rs6000 darwin).
96 Define a dummy ALTIVEC_VECTOR_MODE so it will not die. */
97 #undef ALTIVEC_VECTOR_MODE
98 #define ALTIVEC_VECTOR_MODE(MODE) (0)
101 /* FIXME: while this file has no business including tm.h, this
102 definitely has no business defining this macro but it
103 is only way around without really rewritting this file,
104 should look after the branch of 3.4 to fix this. */
105 #define rs6000_special_round_type_align(STRUCT, COMPUTED, SPECIFIED) \
106 ((TYPE_FIELDS (STRUCT) != 0 \
107 && DECL_MODE (TYPE_FIELDS (STRUCT)) == DFmode) \
108 ? MAX (MAX (COMPUTED, SPECIFIED), 64) \
109 : MAX (COMPUTED, SPECIFIED))
112 return the size of an object specified by type
116 objc_sizeof_type (const char *type
)
118 /* Skip the variable name if any */
121 for (type
++; *type
++ != '"';)
131 return sizeof (Class
);
139 return sizeof (char);
143 return sizeof (unsigned char);
147 return sizeof (short);
151 return sizeof (unsigned short);
159 return sizeof (unsigned int);
163 return sizeof (long);
167 return sizeof (unsigned long);
171 return sizeof (long long);
175 return sizeof (unsigned long long);
179 return sizeof (float);
183 return sizeof (double);
187 return sizeof (void);
193 return sizeof (char *);
198 int len
= atoi (type
+ 1);
199 while (isdigit ((unsigned char)*++type
))
201 return len
* objc_aligned_size (type
);
207 /* The new encoding of bitfields is: b 'position' 'type' 'size' */
209 int startByte
, endByte
;
211 position
= atoi (type
+ 1);
212 while (isdigit ((unsigned char)*++type
))
214 size
= atoi (type
+ 1);
216 startByte
= position
/ BITS_PER_UNIT
;
217 endByte
= (position
+ size
) / BITS_PER_UNIT
;
218 return endByte
- startByte
;
223 struct objc_struct_layout layout
;
226 objc_layout_structure (type
, &layout
);
227 while (objc_layout_structure_next_member (&layout
))
229 objc_layout_finish_structure (&layout
, &size
, NULL
);
237 while (*type
!= _C_UNION_E
&& *type
++ != '=')
239 while (*type
!= _C_UNION_E
)
241 /* Skip the variable name if any */
244 for (type
++; *type
++ != '"';)
247 max_size
= MAX (max_size
, objc_sizeof_type (type
));
248 type
= objc_skip_typespec (type
);
255 objc_error (nil
, OBJC_ERR_BAD_TYPE
, "unknown type %s\n", type
);
263 Return the alignment of an object specified by type
267 objc_alignof_type (const char *type
)
269 /* Skip the variable name if any */
272 for (type
++; *type
++ != '"';)
277 return __alignof__ (id
);
281 return __alignof__ (Class
);
285 return __alignof__ (SEL
);
289 return __alignof__ (char);
293 return __alignof__ (unsigned char);
297 return __alignof__ (short);
301 return __alignof__ (unsigned short);
305 return __alignof__ (int);
309 return __alignof__ (unsigned int);
313 return __alignof__ (long);
317 return __alignof__ (unsigned long);
321 return __alignof__ (long long);
325 return __alignof__ (unsigned long long);
329 return __alignof__ (float);
333 return __alignof__ (double);
339 return __alignof__ (char *);
343 while (isdigit ((unsigned char)*++type
))
345 return objc_alignof_type (type
);
349 struct objc_struct_layout layout
;
352 objc_layout_structure (type
, &layout
);
353 while (objc_layout_structure_next_member (&layout
))
355 objc_layout_finish_structure (&layout
, NULL
, &align
);
363 while (*type
!= _C_UNION_E
&& *type
++ != '=')
365 while (*type
!= _C_UNION_E
)
367 /* Skip the variable name if any */
370 for (type
++; *type
++ != '"';)
373 maxalign
= MAX (maxalign
, objc_alignof_type (type
));
374 type
= objc_skip_typespec (type
);
381 objc_error (nil
, OBJC_ERR_BAD_TYPE
, "unknown type %s\n", type
);
388 The aligned size if the size rounded up to the nearest alignment.
392 objc_aligned_size (const char *type
)
396 /* Skip the variable name */
399 for (type
++; *type
++ != '"';)
403 size
= objc_sizeof_type (type
);
404 align
= objc_alignof_type (type
);
406 return ROUND (size
, align
);
410 The size rounded up to the nearest integral of the wordsize, taken
411 to be the size of a void *.
415 objc_promoted_size (const char *type
)
419 /* Skip the variable name */
422 for (type
++; *type
++ != '"';)
426 size
= objc_sizeof_type (type
);
427 wordsize
= sizeof (void *);
429 return ROUND (size
, wordsize
);
433 Skip type qualifiers. These may eventually precede typespecs
434 occurring in method prototype encodings.
438 objc_skip_type_qualifiers (const char *type
)
440 while (*type
== _C_CONST
444 || *type
== _C_BYCOPY
446 || *type
== _C_ONEWAY
447 || *type
== _C_GCINVISIBLE
)
456 Skip one typespec element. If the typespec is prepended by type
457 qualifiers, these are skipped as well.
461 objc_skip_typespec (const char *type
)
463 /* Skip the variable name if any */
466 for (type
++; *type
++ != '"';)
470 type
= objc_skip_type_qualifiers (type
);
475 /* An id may be annotated by the actual type if it is known
476 with the @"ClassName" syntax */
482 while (*++type
!= '"')
487 /* The following are one character type codes */
510 /* skip digits, typespec and closing ']' */
512 while (isdigit ((unsigned char)*++type
))
514 type
= objc_skip_typespec (type
);
515 if (*type
== _C_ARY_E
)
519 objc_error (nil
, OBJC_ERR_BAD_TYPE
, "bad array type %s\n", type
);
524 /* The new encoding of bitfields is: b 'position' 'type' 'size' */
525 while (isdigit ((unsigned char)*++type
))
526 ; /* skip position */
527 while (isdigit ((unsigned char)*++type
))
528 ; /* skip type and size */
532 /* skip name, and elements until closing '}' */
534 while (*type
!= _C_STRUCT_E
&& *type
++ != '=')
536 while (*type
!= _C_STRUCT_E
)
538 type
= objc_skip_typespec (type
);
543 /* skip name, and elements until closing ')' */
545 while (*type
!= _C_UNION_E
&& *type
++ != '=')
547 while (*type
!= _C_UNION_E
)
549 type
= objc_skip_typespec (type
);
554 /* Just skip the following typespec */
556 return objc_skip_typespec (++type
);
560 objc_error (nil
, OBJC_ERR_BAD_TYPE
, "unknown type %s\n", type
);
567 Skip an offset as part of a method encoding. This is prepended by a
568 '+' if the argument is passed in registers.
571 objc_skip_offset (const char *type
)
575 while (isdigit ((unsigned char) *++type
))
581 Skip an argument specification of a method encoding.
584 objc_skip_argspec (const char *type
)
586 type
= objc_skip_typespec (type
);
587 type
= objc_skip_offset (type
);
592 Return the number of arguments that the method MTH expects.
593 Note that all methods need two implicit arguments `self' and
597 method_get_number_of_arguments (struct objc_method
*mth
)
600 const char *type
= mth
->method_types
;
603 type
= objc_skip_argspec (type
);
610 Return the size of the argument block needed on the stack to invoke
611 the method MTH. This may be zero, if all arguments are passed in
616 method_get_sizeof_arguments (struct objc_method
*mth
)
618 const char *type
= objc_skip_typespec (mth
->method_types
);
623 Return a pointer to the next argument of ARGFRAME. type points to
624 the last argument. Typical use of this look like:
628 for (datum = method_get_first_argument (method, argframe, &type);
629 datum; datum = method_get_next_argument (argframe, &type))
631 unsigned flags = objc_get_type_qualifiers (type);
632 type = objc_skip_type_qualifiers (type);
634 [portal encodeData: datum ofType: type];
637 if ((flags & _F_IN) == _F_IN)
638 [portal encodeData: *(char **) datum ofType: ++type];
645 method_get_next_argument (arglist_t argframe
, const char **type
)
647 const char *t
= objc_skip_argspec (*type
);
653 t
= objc_skip_typespec (t
);
656 return argframe
->arg_regs
+ atoi (++t
);
658 return argframe
->arg_ptr
+ atoi (t
);
662 Return a pointer to the value of the first argument of the method
663 described in M with the given argumentframe ARGFRAME. The type
664 is returned in TYPE. type must be passed to successive calls of
665 method_get_next_argument.
668 method_get_first_argument (struct objc_method
*m
,
672 *type
= m
->method_types
;
673 return method_get_next_argument (argframe
, type
);
677 Return a pointer to the ARGth argument of the method
678 M from the frame ARGFRAME. The type of the argument
679 is returned in the value-result argument TYPE
683 method_get_nth_argument (struct objc_method
*m
,
684 arglist_t argframe
, int arg
,
687 const char *t
= objc_skip_argspec (m
->method_types
);
689 if (arg
> method_get_number_of_arguments (m
))
693 t
= objc_skip_argspec (t
);
696 t
= objc_skip_typespec (t
);
699 return argframe
->arg_regs
+ atoi (++t
);
701 return argframe
->arg_ptr
+ atoi (t
);
705 objc_get_type_qualifiers (const char *type
)
713 case _C_CONST
: res
|= _F_CONST
; break;
714 case _C_IN
: res
|= _F_IN
; break;
715 case _C_INOUT
: res
|= _F_INOUT
; break;
716 case _C_OUT
: res
|= _F_OUT
; break;
717 case _C_BYCOPY
: res
|= _F_BYCOPY
; break;
718 case _C_BYREF
: res
|= _F_BYREF
; break;
719 case _C_ONEWAY
: res
|= _F_ONEWAY
; break;
720 case _C_GCINVISIBLE
: res
|= _F_GCINVISIBLE
; break;
728 /* The following three functions can be used to determine how a
729 structure is laid out by the compiler. For example:
731 struct objc_struct_layout layout;
734 objc_layout_structure (type, &layout);
735 while (objc_layout_structure_next_member (&layout))
740 objc_layout_structure_get_info (&layout, &position, &align, &type);
741 printf ("element %d has offset %d, alignment %d\n",
742 i++, position, align);
745 These functions are used by objc_sizeof_type and objc_alignof_type
746 functions to compute the size and alignment of structures. The
747 previous method of computing the size and alignment of a structure
748 was not working on some architectures, particulary on AIX, and in
749 the presence of bitfields inside the structure. */
751 objc_layout_structure (const char *type
,
752 struct objc_struct_layout
*layout
)
756 if (*type
++ != _C_STRUCT_B
)
758 objc_error (nil
, OBJC_ERR_BAD_TYPE
,
759 "record type expected in objc_layout_structure, got %s\n",
763 layout
->original_type
= type
;
765 /* Skip "<name>=" if any. Avoid embedded structures and unions. */
767 while (*ntype
!= _C_STRUCT_E
&& *ntype
!= _C_STRUCT_B
&& *ntype
!= _C_UNION_B
771 /* If there's a "<name>=", ntype - 1 points to '='; skip the the name */
772 if (*(ntype
- 1) == '=')
776 layout
->prev_type
= NULL
;
777 layout
->record_size
= 0;
778 layout
->record_align
= BITS_PER_UNIT
;
780 layout
->record_align
= MAX (layout
->record_align
, STRUCTURE_SIZE_BOUNDARY
);
785 objc_layout_structure_next_member (struct objc_struct_layout
*layout
)
787 register int desired_align
= 0;
789 /* The following are used only if the field is a bitfield */
790 register const char *bfld_type
= 0;
791 register int bfld_type_size
, bfld_type_align
= 0, bfld_field_size
= 0;
793 /* The current type without the type qualifiers */
796 /* Add the size of the previous field to the size of the record. */
797 if (layout
->prev_type
)
799 type
= objc_skip_type_qualifiers (layout
->prev_type
);
801 if (*type
!= _C_BFLD
)
802 layout
->record_size
+= objc_sizeof_type (type
) * BITS_PER_UNIT
;
804 /* Get the bitfield's type */
805 for (bfld_type
= type
+ 1;
806 isdigit ((unsigned char)*bfld_type
);
810 bfld_type_size
= objc_sizeof_type (bfld_type
) * BITS_PER_UNIT
;
811 bfld_type_align
= objc_alignof_type (bfld_type
) * BITS_PER_UNIT
;
812 bfld_field_size
= atoi (objc_skip_typespec (bfld_type
));
813 layout
->record_size
+= bfld_field_size
;
817 if (*layout
->type
== _C_STRUCT_E
)
820 /* Skip the variable name if any */
821 if (*layout
->type
== '"')
823 for (layout
->type
++; *layout
->type
++ != '"';)
827 type
= objc_skip_type_qualifiers (layout
->type
);
829 if (*type
!= _C_BFLD
)
830 desired_align
= objc_alignof_type (type
) * BITS_PER_UNIT
;
834 /* Skip the bitfield's offset */
835 for (bfld_type
= type
+ 1;
836 isdigit ((unsigned char) *bfld_type
);
840 bfld_type_size
= objc_sizeof_type (bfld_type
) * BITS_PER_UNIT
;
841 bfld_type_align
= objc_alignof_type (bfld_type
) * BITS_PER_UNIT
;
842 bfld_field_size
= atoi (objc_skip_typespec (bfld_type
));
845 #ifdef BIGGEST_FIELD_ALIGNMENT
846 desired_align
= MIN (desired_align
, BIGGEST_FIELD_ALIGNMENT
);
848 #ifdef ADJUST_FIELD_ALIGN
849 desired_align
= ADJUST_FIELD_ALIGN (type
, desired_align
);
852 /* Record must have at least as much alignment as any field.
853 Otherwise, the alignment of the field within the record
855 #ifndef PCC_BITFIELD_TYPE_MATTERS
856 layout
->record_align
= MAX (layout
->record_align
, desired_align
);
857 #else /* PCC_BITFIELD_TYPE_MATTERS */
858 if (*type
== _C_BFLD
)
860 /* For these machines, a zero-length field does not
861 affect the alignment of the structure as a whole.
862 It does, however, affect the alignment of the next field
863 within the structure. */
865 layout
->record_align
= MAX (layout
->record_align
, desired_align
);
867 desired_align
= objc_alignof_type (bfld_type
) * BITS_PER_UNIT
;
869 /* A named bit field of declared type `int'
870 forces the entire structure to have `int' alignment.
871 Q1: How is encoded this thing and how to check for it?
872 Q2: How to determine maximum_field_alignment at runtime? */
874 /* if (DECL_NAME (field) != 0) */
876 int type_align
= bfld_type_align
;
878 if (maximum_field_alignment
!= 0)
879 type_align
= MIN (type_align
, maximum_field_alignment
);
880 else if (DECL_PACKED (field
))
881 type_align
= MIN (type_align
, BITS_PER_UNIT
);
884 layout
->record_align
= MAX (layout
->record_align
, type_align
);
888 layout
->record_align
= MAX (layout
->record_align
, desired_align
);
889 #endif /* PCC_BITFIELD_TYPE_MATTERS */
891 /* Does this field automatically have alignment it needs
892 by virtue of the fields that precede it and the record's
895 if (*type
== _C_BFLD
)
896 layout
->record_size
= atoi (type
+ 1);
897 else if (layout
->record_size
% desired_align
!= 0)
899 /* No, we need to skip space before this field.
900 Bump the cumulative size to multiple of field alignment. */
901 layout
->record_size
= ROUND (layout
->record_size
, desired_align
);
904 /* Jump to the next field in record. */
906 layout
->prev_type
= layout
->type
;
907 layout
->type
= objc_skip_typespec (layout
->type
); /* skip component */
913 void objc_layout_finish_structure (struct objc_struct_layout
*layout
,
917 if (layout
->type
&& *layout
->type
== _C_STRUCT_E
)
919 /* Work out the alignment of the record as one expression and store
920 in the record type. Round it up to a multiple of the record's
923 #if defined (ROUND_TYPE_ALIGN) && ! defined (__sparc__)
924 layout
->record_align
= ROUND_TYPE_ALIGN (layout
->original_type
,
926 layout
->record_align
);
928 layout
->record_align
= MAX (1, layout
->record_align
);
931 #ifdef ROUND_TYPE_SIZE
932 layout
->record_size
= ROUND_TYPE_SIZE (layout
->original_type
,
934 layout
->record_align
);
936 /* Round the size up to be a multiple of the required alignment */
937 layout
->record_size
= ROUND (layout
->record_size
, layout
->record_align
);
943 *size
= layout
->record_size
/ BITS_PER_UNIT
;
945 *align
= layout
->record_align
/ BITS_PER_UNIT
;
949 void objc_layout_structure_get_info (struct objc_struct_layout
*layout
,
950 unsigned int *offset
,
955 *offset
= layout
->record_size
/ BITS_PER_UNIT
;
957 *align
= layout
->record_align
/ BITS_PER_UNIT
;
959 *type
= layout
->prev_type
;