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
++ != '"';)
127 return sizeof (_Bool
);
135 return sizeof (Class
);
143 return sizeof (char);
147 return sizeof (unsigned char);
151 return sizeof (short);
155 return sizeof (unsigned short);
163 return sizeof (unsigned int);
167 return sizeof (long);
171 return sizeof (unsigned long);
175 return sizeof (long long);
179 return sizeof (unsigned long long);
183 return sizeof (float);
187 return sizeof (double);
191 return sizeof (void);
197 return sizeof (char *);
202 int len
= atoi (type
+ 1);
203 while (isdigit ((unsigned char)*++type
))
205 return len
* objc_aligned_size (type
);
211 /* The new encoding of bitfields is: b 'position' 'type' 'size' */
213 int startByte
, endByte
;
215 position
= atoi (type
+ 1);
216 while (isdigit ((unsigned char)*++type
))
218 size
= atoi (type
+ 1);
220 startByte
= position
/ BITS_PER_UNIT
;
221 endByte
= (position
+ size
) / BITS_PER_UNIT
;
222 return endByte
- startByte
;
227 struct objc_struct_layout layout
;
230 objc_layout_structure (type
, &layout
);
231 while (objc_layout_structure_next_member (&layout
))
233 objc_layout_finish_structure (&layout
, &size
, NULL
);
241 while (*type
!= _C_UNION_E
&& *type
++ != '=')
243 while (*type
!= _C_UNION_E
)
245 /* Skip the variable name if any */
248 for (type
++; *type
++ != '"';)
251 max_size
= MAX (max_size
, objc_sizeof_type (type
));
252 type
= objc_skip_typespec (type
);
259 objc_error (nil
, OBJC_ERR_BAD_TYPE
, "unknown type %s\n", type
);
267 Return the alignment of an object specified by type
271 objc_alignof_type (const char *type
)
273 /* Skip the variable name if any */
276 for (type
++; *type
++ != '"';)
281 return __alignof__ (_Bool
);
285 return __alignof__ (id
);
289 return __alignof__ (Class
);
293 return __alignof__ (SEL
);
297 return __alignof__ (char);
301 return __alignof__ (unsigned char);
305 return __alignof__ (short);
309 return __alignof__ (unsigned short);
313 return __alignof__ (int);
317 return __alignof__ (unsigned int);
321 return __alignof__ (long);
325 return __alignof__ (unsigned long);
329 return __alignof__ (long long);
333 return __alignof__ (unsigned long long);
337 return __alignof__ (float);
341 return __alignof__ (double);
347 return __alignof__ (char *);
351 while (isdigit ((unsigned char)*++type
))
353 return objc_alignof_type (type
);
357 struct objc_struct_layout layout
;
360 objc_layout_structure (type
, &layout
);
361 while (objc_layout_structure_next_member (&layout
))
363 objc_layout_finish_structure (&layout
, NULL
, &align
);
371 while (*type
!= _C_UNION_E
&& *type
++ != '=')
373 while (*type
!= _C_UNION_E
)
375 /* Skip the variable name if any */
378 for (type
++; *type
++ != '"';)
381 maxalign
= MAX (maxalign
, objc_alignof_type (type
));
382 type
= objc_skip_typespec (type
);
389 objc_error (nil
, OBJC_ERR_BAD_TYPE
, "unknown type %s\n", type
);
396 The aligned size if the size rounded up to the nearest alignment.
400 objc_aligned_size (const char *type
)
404 /* Skip the variable name */
407 for (type
++; *type
++ != '"';)
411 size
= objc_sizeof_type (type
);
412 align
= objc_alignof_type (type
);
414 return ROUND (size
, align
);
418 The size rounded up to the nearest integral of the wordsize, taken
419 to be the size of a void *.
423 objc_promoted_size (const char *type
)
427 /* Skip the variable name */
430 for (type
++; *type
++ != '"';)
434 size
= objc_sizeof_type (type
);
435 wordsize
= sizeof (void *);
437 return ROUND (size
, wordsize
);
441 Skip type qualifiers. These may eventually precede typespecs
442 occurring in method prototype encodings.
446 objc_skip_type_qualifiers (const char *type
)
448 while (*type
== _C_CONST
452 || *type
== _C_BYCOPY
454 || *type
== _C_ONEWAY
455 || *type
== _C_GCINVISIBLE
)
464 Skip one typespec element. If the typespec is prepended by type
465 qualifiers, these are skipped as well.
469 objc_skip_typespec (const char *type
)
471 /* Skip the variable name if any */
474 for (type
++; *type
++ != '"';)
478 type
= objc_skip_type_qualifiers (type
);
483 /* An id may be annotated by the actual type if it is known
484 with the @"ClassName" syntax */
490 while (*++type
!= '"')
495 /* The following are one character type codes */
519 /* skip digits, typespec and closing ']' */
521 while (isdigit ((unsigned char)*++type
))
523 type
= objc_skip_typespec (type
);
524 if (*type
== _C_ARY_E
)
528 objc_error (nil
, OBJC_ERR_BAD_TYPE
, "bad array type %s\n", type
);
533 /* The new encoding of bitfields is: b 'position' 'type' 'size' */
534 while (isdigit ((unsigned char)*++type
))
535 ; /* skip position */
536 while (isdigit ((unsigned char)*++type
))
537 ; /* skip type and size */
541 /* skip name, and elements until closing '}' */
543 while (*type
!= _C_STRUCT_E
&& *type
++ != '=')
545 while (*type
!= _C_STRUCT_E
)
547 type
= objc_skip_typespec (type
);
552 /* skip name, and elements until closing ')' */
554 while (*type
!= _C_UNION_E
&& *type
++ != '=')
556 while (*type
!= _C_UNION_E
)
558 type
= objc_skip_typespec (type
);
563 /* Just skip the following typespec */
565 return objc_skip_typespec (++type
);
569 objc_error (nil
, OBJC_ERR_BAD_TYPE
, "unknown type %s\n", type
);
576 Skip an offset as part of a method encoding. This is prepended by a
577 '+' if the argument is passed in registers.
580 objc_skip_offset (const char *type
)
584 while (isdigit ((unsigned char) *++type
))
590 Skip an argument specification of a method encoding.
593 objc_skip_argspec (const char *type
)
595 type
= objc_skip_typespec (type
);
596 type
= objc_skip_offset (type
);
601 Return the number of arguments that the method MTH expects.
602 Note that all methods need two implicit arguments `self' and
606 method_get_number_of_arguments (struct objc_method
*mth
)
609 const char *type
= mth
->method_types
;
612 type
= objc_skip_argspec (type
);
619 Return the size of the argument block needed on the stack to invoke
620 the method MTH. This may be zero, if all arguments are passed in
625 method_get_sizeof_arguments (struct objc_method
*mth
)
627 const char *type
= objc_skip_typespec (mth
->method_types
);
632 Return a pointer to the next argument of ARGFRAME. type points to
633 the last argument. Typical use of this look like:
637 for (datum = method_get_first_argument (method, argframe, &type);
638 datum; datum = method_get_next_argument (argframe, &type))
640 unsigned flags = objc_get_type_qualifiers (type);
641 type = objc_skip_type_qualifiers (type);
643 [portal encodeData: datum ofType: type];
646 if ((flags & _F_IN) == _F_IN)
647 [portal encodeData: *(char **) datum ofType: ++type];
654 method_get_next_argument (arglist_t argframe
, const char **type
)
656 const char *t
= objc_skip_argspec (*type
);
662 t
= objc_skip_typespec (t
);
665 return argframe
->arg_regs
+ atoi (++t
);
667 return argframe
->arg_ptr
+ atoi (t
);
671 Return a pointer to the value of the first argument of the method
672 described in M with the given argumentframe ARGFRAME. The type
673 is returned in TYPE. type must be passed to successive calls of
674 method_get_next_argument.
677 method_get_first_argument (struct objc_method
*m
,
681 *type
= m
->method_types
;
682 return method_get_next_argument (argframe
, type
);
686 Return a pointer to the ARGth argument of the method
687 M from the frame ARGFRAME. The type of the argument
688 is returned in the value-result argument TYPE
692 method_get_nth_argument (struct objc_method
*m
,
693 arglist_t argframe
, int arg
,
696 const char *t
= objc_skip_argspec (m
->method_types
);
698 if (arg
> method_get_number_of_arguments (m
))
702 t
= objc_skip_argspec (t
);
705 t
= objc_skip_typespec (t
);
708 return argframe
->arg_regs
+ atoi (++t
);
710 return argframe
->arg_ptr
+ atoi (t
);
714 objc_get_type_qualifiers (const char *type
)
722 case _C_CONST
: res
|= _F_CONST
; break;
723 case _C_IN
: res
|= _F_IN
; break;
724 case _C_INOUT
: res
|= _F_INOUT
; break;
725 case _C_OUT
: res
|= _F_OUT
; break;
726 case _C_BYCOPY
: res
|= _F_BYCOPY
; break;
727 case _C_BYREF
: res
|= _F_BYREF
; break;
728 case _C_ONEWAY
: res
|= _F_ONEWAY
; break;
729 case _C_GCINVISIBLE
: res
|= _F_GCINVISIBLE
; break;
737 /* The following three functions can be used to determine how a
738 structure is laid out by the compiler. For example:
740 struct objc_struct_layout layout;
743 objc_layout_structure (type, &layout);
744 while (objc_layout_structure_next_member (&layout))
749 objc_layout_structure_get_info (&layout, &position, &align, &type);
750 printf ("element %d has offset %d, alignment %d\n",
751 i++, position, align);
754 These functions are used by objc_sizeof_type and objc_alignof_type
755 functions to compute the size and alignment of structures. The
756 previous method of computing the size and alignment of a structure
757 was not working on some architectures, particulary on AIX, and in
758 the presence of bitfields inside the structure. */
760 objc_layout_structure (const char *type
,
761 struct objc_struct_layout
*layout
)
765 if (*type
++ != _C_STRUCT_B
)
767 objc_error (nil
, OBJC_ERR_BAD_TYPE
,
768 "record type expected in objc_layout_structure, got %s\n",
772 layout
->original_type
= type
;
774 /* Skip "<name>=" if any. Avoid embedded structures and unions. */
776 while (*ntype
!= _C_STRUCT_E
&& *ntype
!= _C_STRUCT_B
&& *ntype
!= _C_UNION_B
780 /* If there's a "<name>=", ntype - 1 points to '='; skip the the name */
781 if (*(ntype
- 1) == '=')
785 layout
->prev_type
= NULL
;
786 layout
->record_size
= 0;
787 layout
->record_align
= BITS_PER_UNIT
;
789 layout
->record_align
= MAX (layout
->record_align
, STRUCTURE_SIZE_BOUNDARY
);
794 objc_layout_structure_next_member (struct objc_struct_layout
*layout
)
796 register int desired_align
= 0;
798 /* The following are used only if the field is a bitfield */
799 register const char *bfld_type
= 0;
800 register int bfld_type_size
, bfld_type_align
= 0, bfld_field_size
= 0;
802 /* The current type without the type qualifiers */
805 /* Add the size of the previous field to the size of the record. */
806 if (layout
->prev_type
)
808 type
= objc_skip_type_qualifiers (layout
->prev_type
);
810 if (*type
!= _C_BFLD
)
811 layout
->record_size
+= objc_sizeof_type (type
) * BITS_PER_UNIT
;
813 /* Get the bitfield's type */
814 for (bfld_type
= type
+ 1;
815 isdigit ((unsigned char)*bfld_type
);
819 bfld_type_size
= objc_sizeof_type (bfld_type
) * BITS_PER_UNIT
;
820 bfld_type_align
= objc_alignof_type (bfld_type
) * BITS_PER_UNIT
;
821 bfld_field_size
= atoi (objc_skip_typespec (bfld_type
));
822 layout
->record_size
+= bfld_field_size
;
826 if (*layout
->type
== _C_STRUCT_E
)
829 /* Skip the variable name if any */
830 if (*layout
->type
== '"')
832 for (layout
->type
++; *layout
->type
++ != '"';)
836 type
= objc_skip_type_qualifiers (layout
->type
);
838 if (*type
!= _C_BFLD
)
839 desired_align
= objc_alignof_type (type
) * BITS_PER_UNIT
;
843 /* Skip the bitfield's offset */
844 for (bfld_type
= type
+ 1;
845 isdigit ((unsigned char) *bfld_type
);
849 bfld_type_size
= objc_sizeof_type (bfld_type
) * BITS_PER_UNIT
;
850 bfld_type_align
= objc_alignof_type (bfld_type
) * BITS_PER_UNIT
;
851 bfld_field_size
= atoi (objc_skip_typespec (bfld_type
));
854 #ifdef BIGGEST_FIELD_ALIGNMENT
855 desired_align
= MIN (desired_align
, BIGGEST_FIELD_ALIGNMENT
);
857 #ifdef ADJUST_FIELD_ALIGN
858 desired_align
= ADJUST_FIELD_ALIGN (type
, desired_align
);
861 /* Record must have at least as much alignment as any field.
862 Otherwise, the alignment of the field within the record
864 #ifndef PCC_BITFIELD_TYPE_MATTERS
865 layout
->record_align
= MAX (layout
->record_align
, desired_align
);
866 #else /* PCC_BITFIELD_TYPE_MATTERS */
867 if (*type
== _C_BFLD
)
869 /* For these machines, a zero-length field does not
870 affect the alignment of the structure as a whole.
871 It does, however, affect the alignment of the next field
872 within the structure. */
874 layout
->record_align
= MAX (layout
->record_align
, desired_align
);
876 desired_align
= objc_alignof_type (bfld_type
) * BITS_PER_UNIT
;
878 /* A named bit field of declared type `int'
879 forces the entire structure to have `int' alignment.
880 Q1: How is encoded this thing and how to check for it?
881 Q2: How to determine maximum_field_alignment at runtime? */
883 /* if (DECL_NAME (field) != 0) */
885 int type_align
= bfld_type_align
;
887 if (maximum_field_alignment
!= 0)
888 type_align
= MIN (type_align
, maximum_field_alignment
);
889 else if (DECL_PACKED (field
))
890 type_align
= MIN (type_align
, BITS_PER_UNIT
);
893 layout
->record_align
= MAX (layout
->record_align
, type_align
);
897 layout
->record_align
= MAX (layout
->record_align
, desired_align
);
898 #endif /* PCC_BITFIELD_TYPE_MATTERS */
900 /* Does this field automatically have alignment it needs
901 by virtue of the fields that precede it and the record's
904 if (*type
== _C_BFLD
)
905 layout
->record_size
= atoi (type
+ 1);
906 else if (layout
->record_size
% desired_align
!= 0)
908 /* No, we need to skip space before this field.
909 Bump the cumulative size to multiple of field alignment. */
910 layout
->record_size
= ROUND (layout
->record_size
, desired_align
);
913 /* Jump to the next field in record. */
915 layout
->prev_type
= layout
->type
;
916 layout
->type
= objc_skip_typespec (layout
->type
); /* skip component */
922 void objc_layout_finish_structure (struct objc_struct_layout
*layout
,
926 if (layout
->type
&& *layout
->type
== _C_STRUCT_E
)
928 /* Work out the alignment of the record as one expression and store
929 in the record type. Round it up to a multiple of the record's
932 #if defined (ROUND_TYPE_ALIGN) && ! defined (__sparc__)
933 layout
->record_align
= ROUND_TYPE_ALIGN (layout
->original_type
,
935 layout
->record_align
);
937 layout
->record_align
= MAX (1, layout
->record_align
);
940 #ifdef ROUND_TYPE_SIZE
941 layout
->record_size
= ROUND_TYPE_SIZE (layout
->original_type
,
943 layout
->record_align
);
945 /* Round the size up to be a multiple of the required alignment */
946 layout
->record_size
= ROUND (layout
->record_size
, layout
->record_align
);
952 *size
= layout
->record_size
/ BITS_PER_UNIT
;
954 *align
= layout
->record_align
/ BITS_PER_UNIT
;
958 void objc_layout_structure_get_info (struct objc_struct_layout
*layout
,
959 unsigned int *offset
,
964 *offset
= layout
->record_size
/ BITS_PER_UNIT
;
966 *align
= layout
->record_align
/ BITS_PER_UNIT
;
968 *type
= layout
->prev_type
;