1 /* Encoding of types for Objective C.
2 Copyright (C) 1993, 1995, 1996, 1997, 1998, 2000 Free Software Foundation, Inc.
3 Contributed by Kresten Krab Thorup
4 Bitfield support by Ovidiu Predescu
6 This file is part of GNU CC.
8 GNU CC is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GNU CC is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU CC; see the file COPYING. If not, write to
20 the Free Software Foundation, 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 /* As a special exception, if you link this library with files
24 compiled with GCC to produce an executable, this does not cause
25 the resulting executable to be covered by the GNU General Public License.
26 This exception does not however invalidate any other reasons why
27 the executable file might be covered by the GNU General Public License. */
34 ({ typeof(X) __x = (X), __y = (Y); \
35 (__x > __y ? __x : __y); })
38 ({ typeof(X) __x = (X), __y = (Y); \
39 (__x < __y ? __x : __y); })
42 ({ typeof(V) __v=(V); typeof(A) __a=(A); \
43 __a*((__v+__a-1)/__a); })
46 /* Various hacks for objc_layout_record. These are used by the target
49 #define TREE_CODE(TYPE) *TYPE
50 #define TREE_TYPE(TREE) TREE
52 #define RECORD_TYPE _C_STRUCT_B
53 #define UNION_TYPE _C_UNION_B
54 #define QUAL_UNION_TYPE _C_UNION_B
55 #define ARRAY_TYPE _C_ARY_B
57 #define TYPE_FIELDS(TYPE) objc_skip_typespec (TYPE)
59 #define DECL_MODE(TYPE) *(TYPE)
63 #define get_inner_array_type(TYPE) ((TYPE) + 1)
67 atoi (const char* str
)
71 while (isdigit (*str
))
72 res
*= 10, res
+= (*str
++ - '0');
78 return the size of an object specified by type
82 objc_sizeof_type (const char* type
)
84 /* Skip the variable name if any */
87 for (type
++; *type
++ != '"';)
109 return sizeof(unsigned char);
113 return sizeof(short);
117 return sizeof(unsigned short);
125 return sizeof(unsigned int);
133 return sizeof(unsigned long);
137 return sizeof(long long);
141 return sizeof(unsigned long long);
145 return sizeof(float);
149 return sizeof(double);
158 return sizeof(char*);
163 int len
= atoi(type
+1);
164 while (isdigit(*++type
));
165 return len
*objc_aligned_size (type
);
171 /* The new encoding of bitfields is: b 'position' 'type' 'size' */
173 int startByte
, endByte
;
175 position
= atoi (type
+ 1);
176 while (isdigit (*++type
));
177 size
= atoi (type
+ 1);
179 startByte
= position
/ BITS_PER_UNIT
;
180 endByte
= (position
+ size
) / BITS_PER_UNIT
;
181 return endByte
- startByte
;
186 struct objc_struct_layout layout
;
189 objc_layout_structure (type
, &layout
);
190 while (objc_layout_structure_next_member (&layout
))
192 objc_layout_finish_structure (&layout
, &size
, NULL
);
200 while (*type
!= _C_UNION_E
&& *type
++ != '=') /* do nothing */;
201 while (*type
!= _C_UNION_E
)
203 /* Skip the variable name if any */
206 for (type
++; *type
++ != '"';)
209 max_size
= MAX (max_size
, objc_sizeof_type (type
));
210 type
= objc_skip_typespec (type
);
217 objc_error(nil
, OBJC_ERR_BAD_TYPE
, "unknown type %s\n", type
);
225 Return the alignment of an object specified by type
229 objc_alignof_type(const char* type
)
231 /* Skip the variable name if any */
234 for (type
++; *type
++ != '"';)
239 return __alignof__(id
);
243 return __alignof__(Class
);
247 return __alignof__(SEL
);
251 return __alignof__(char);
255 return __alignof__(unsigned char);
259 return __alignof__(short);
263 return __alignof__(unsigned short);
267 return __alignof__(int);
271 return __alignof__(unsigned int);
275 return __alignof__(long);
279 return __alignof__(unsigned long);
283 return __alignof__(long long);
287 return __alignof__(unsigned long long);
291 return __alignof__(float);
295 return __alignof__(double);
301 return __alignof__(char*);
305 while (isdigit(*++type
)) /* do nothing */;
306 return objc_alignof_type (type
);
310 struct objc_struct_layout layout
;
313 objc_layout_structure (type
, &layout
);
314 while (objc_layout_structure_next_member (&layout
))
316 objc_layout_finish_structure (&layout
, NULL
, &align
);
324 while (*type
!= _C_UNION_E
&& *type
++ != '=') /* do nothing */;
325 while (*type
!= _C_UNION_E
)
327 /* Skip the variable name if any */
330 for (type
++; *type
++ != '"';)
333 maxalign
= MAX (maxalign
, objc_alignof_type (type
));
334 type
= objc_skip_typespec (type
);
341 objc_error(nil
, OBJC_ERR_BAD_TYPE
, "unknown type %s\n", type
);
348 The aligned size if the size rounded up to the nearest alignment.
352 objc_aligned_size (const char* type
)
356 /* Skip the variable name */
359 for (type
++; *type
++ != '"';)
363 size
= objc_sizeof_type (type
);
364 align
= objc_alignof_type (type
);
366 return ROUND (size
, align
);
370 The size rounded up to the nearest integral of the wordsize, taken
371 to be the size of a void*.
375 objc_promoted_size (const char* type
)
379 /* Skip the variable name */
382 for (type
++; *type
++ != '"';)
386 size
= objc_sizeof_type (type
);
387 wordsize
= sizeof (void*);
389 return ROUND (size
, wordsize
);
393 Skip type qualifiers. These may eventually precede typespecs
394 occurring in method prototype encodings.
398 objc_skip_type_qualifiers (const char* type
)
400 while (*type
== _C_CONST
404 || *type
== _C_BYCOPY
406 || *type
== _C_ONEWAY
407 || *type
== _C_GCINVISIBLE
)
416 Skip one typespec element. If the typespec is prepended by type
417 qualifiers, these are skipped as well.
421 objc_skip_typespec (const char* type
)
423 /* Skip the variable name if any */
426 for (type
++; *type
++ != '"';)
430 type
= objc_skip_type_qualifiers (type
);
435 /* An id may be annotated by the actual type if it is known
436 with the @"ClassName" syntax */
442 while (*++type
!= '"') /* do nothing */;
446 /* The following are one character type codes */
469 /* skip digits, typespec and closing ']' */
471 while(isdigit(*++type
));
472 type
= objc_skip_typespec(type
);
473 if (*type
== _C_ARY_E
)
477 objc_error(nil
, OBJC_ERR_BAD_TYPE
, "bad array type %s\n", type
);
482 /* The new encoding of bitfields is: b 'position' 'type' 'size' */
483 while (isdigit (*++type
)); /* skip position */
484 while (isdigit (*++type
)); /* skip type and size */
488 /* skip name, and elements until closing '}' */
490 while (*type
!= _C_STRUCT_E
&& *type
++ != '=');
491 while (*type
!= _C_STRUCT_E
) { type
= objc_skip_typespec (type
); }
495 /* skip name, and elements until closing ')' */
497 while (*type
!= _C_UNION_E
&& *type
++ != '=');
498 while (*type
!= _C_UNION_E
) { type
= objc_skip_typespec (type
); }
502 /* Just skip the following typespec */
504 return objc_skip_typespec (++type
);
508 objc_error(nil
, OBJC_ERR_BAD_TYPE
, "unknown type %s\n", type
);
515 Skip an offset as part of a method encoding. This is prepended by a
516 '+' if the argument is passed in registers.
519 objc_skip_offset (const char* type
)
521 if (*type
== '+') type
++;
522 while(isdigit(*++type
));
527 Skip an argument specification of a method encoding.
530 objc_skip_argspec (const char* type
)
532 type
= objc_skip_typespec (type
);
533 type
= objc_skip_offset (type
);
538 Return the number of arguments that the method MTH expects.
539 Note that all methods need two implicit arguments `self' and
543 method_get_number_of_arguments (struct objc_method
* mth
)
546 const char* type
= mth
->method_types
;
549 type
= objc_skip_argspec (type
);
556 Return the size of the argument block needed on the stack to invoke
557 the method MTH. This may be zero, if all arguments are passed in
562 method_get_sizeof_arguments (struct objc_method
* mth
)
564 const char* type
= objc_skip_typespec (mth
->method_types
);
569 Return a pointer to the next argument of ARGFRAME. type points to
570 the last argument. Typical use of this look like:
574 for (datum = method_get_first_argument (method, argframe, &type);
575 datum; datum = method_get_next_argument (argframe, &type))
577 unsigned flags = objc_get_type_qualifiers (type);
578 type = objc_skip_type_qualifiers (type);
580 [portal encodeData: datum ofType: type];
583 if ((flags & _F_IN) == _F_IN)
584 [portal encodeData: *(char**)datum ofType: ++type];
591 method_get_next_argument (arglist_t argframe
,
594 const char *t
= objc_skip_argspec (*type
);
600 t
= objc_skip_typespec (t
);
603 return argframe
->arg_regs
+ atoi (++t
);
605 return argframe
->arg_ptr
+ atoi (t
);
609 Return a pointer to the value of the first argument of the method
610 described in M with the given argumentframe ARGFRAME. The type
611 is returned in TYPE. type must be passed to successive calls of
612 method_get_next_argument.
615 method_get_first_argument (struct objc_method
* m
,
619 *type
= m
->method_types
;
620 return method_get_next_argument (argframe
, type
);
624 Return a pointer to the ARGth argument of the method
625 M from the frame ARGFRAME. The type of the argument
626 is returned in the value-result argument TYPE
630 method_get_nth_argument (struct objc_method
* m
,
631 arglist_t argframe
, int arg
,
634 const char* t
= objc_skip_argspec (m
->method_types
);
636 if (arg
> method_get_number_of_arguments (m
))
640 t
= objc_skip_argspec (t
);
643 t
= objc_skip_typespec (t
);
646 return argframe
->arg_regs
+ atoi (++t
);
648 return argframe
->arg_ptr
+ atoi (t
);
652 objc_get_type_qualifiers (const char* type
)
660 case _C_CONST
: res
|= _F_CONST
; break;
661 case _C_IN
: res
|= _F_IN
; break;
662 case _C_INOUT
: res
|= _F_INOUT
; break;
663 case _C_OUT
: res
|= _F_OUT
; break;
664 case _C_BYCOPY
: res
|= _F_BYCOPY
; break;
665 case _C_BYREF
: res
|= _F_BYREF
; break;
666 case _C_ONEWAY
: res
|= _F_ONEWAY
; break;
667 case _C_GCINVISIBLE
: res
|= _F_GCINVISIBLE
; break;
675 /* The following three functions can be used to determine how a
676 structure is laid out by the compiler. For example:
678 struct objc_struct_layout layout;
681 objc_layout_structure (type, &layout);
682 while (objc_layout_structure_next_member (&layout))
687 objc_layout_structure_get_info (&layout, &position, &align, &type);
688 printf ("element %d has offset %d, alignment %d\n",
689 i++, position, align);
692 These functions are used by objc_sizeof_type and objc_alignof_type
693 functions to compute the size and alignment of structures. The
694 previous method of computing the size and alignment of a structure
695 was not working on some architectures, particulary on AIX, and in
696 the presence of bitfields inside the structure. */
698 objc_layout_structure (const char *type
,
699 struct objc_struct_layout
*layout
)
703 if (*type
++ != _C_STRUCT_B
)
705 objc_error(nil
, OBJC_ERR_BAD_TYPE
,
706 "record type expected in objc_layout_structure, got %s\n",
710 layout
->original_type
= type
;
712 /* Skip "<name>=" if any. Avoid embedded structures and unions. */
714 while (*ntype
!= _C_STRUCT_E
&& *ntype
!= _C_STRUCT_B
&& *ntype
!= _C_UNION_B
718 /* If there's a "<name>=", ntype - 1 points to '='; skip the the name */
719 if (*(ntype
- 1) == '=')
723 layout
->prev_type
= NULL
;
724 layout
->record_size
= 0;
725 layout
->record_align
= BITS_PER_UNIT
;
727 #ifdef STRUCTURE_SIZE_BOUNDARY
728 layout
->record_align
= MAX (layout
->record_align
, STRUCTURE_SIZE_BOUNDARY
);
734 objc_layout_structure_next_member (struct objc_struct_layout
*layout
)
736 register int known_align
= layout
->record_size
;
737 register int desired_align
= 0;
739 /* The following are used only if the field is a bitfield */
740 register const char *bfld_type
;
741 register int bfld_type_size
, bfld_type_align
, bfld_field_size
;
743 /* The current type without the type qualifiers */
746 /* Add the size of the previous field to the size of the record. */
747 if (layout
->prev_type
)
749 type
= objc_skip_type_qualifiers (layout
->prev_type
);
751 if (*type
!= _C_BFLD
)
752 layout
->record_size
+= objc_sizeof_type (type
) * BITS_PER_UNIT
;
754 /* Get the bitfield's type */
755 for (bfld_type
= type
+ 1;
760 bfld_type_size
= objc_sizeof_type (bfld_type
) * BITS_PER_UNIT
;
761 bfld_type_align
= objc_alignof_type (bfld_type
) * BITS_PER_UNIT
;
762 bfld_field_size
= atoi (objc_skip_typespec (bfld_type
));
763 layout
->record_size
+= bfld_field_size
;
767 if (*layout
->type
== _C_STRUCT_E
)
770 /* Skip the variable name if any */
771 if (*layout
->type
== '"')
773 for (layout
->type
++; *layout
->type
++ != '"';)
777 type
= objc_skip_type_qualifiers (layout
->type
);
779 if (*type
!= _C_BFLD
)
780 desired_align
= objc_alignof_type(type
) * BITS_PER_UNIT
;
784 /* Skip the bitfield's offset */
785 for (bfld_type
= type
+ 1; isdigit(*bfld_type
); bfld_type
++)
788 bfld_type_size
= objc_sizeof_type (bfld_type
) * BITS_PER_UNIT
;
789 bfld_type_align
= objc_alignof_type (bfld_type
) * BITS_PER_UNIT
;
790 bfld_field_size
= atoi (objc_skip_typespec (bfld_type
));
793 #ifdef BIGGEST_FIELD_ALIGNMENT
794 desired_align
= MIN (desired_align
, BIGGEST_FIELD_ALIGNMENT
);
796 #ifdef ADJUST_FIELD_ALIGN
797 desired_align
= ADJUST_FIELD_ALIGN (type
, desired_align
);
800 /* Record must have at least as much alignment as any field.
801 Otherwise, the alignment of the field within the record
803 #ifndef PCC_BITFIELD_TYPE_MATTERS
804 layout
->record_align
= MAX (layout
->record_align
, desired_align
);
806 if (*type
== _C_BFLD
)
808 /* For these machines, a zero-length field does not
809 affect the alignment of the structure as a whole.
810 It does, however, affect the alignment of the next field
811 within the structure. */
813 layout
->record_align
= MAX (layout
->record_align
, desired_align
);
815 desired_align
= objc_alignof_type (bfld_type
) * BITS_PER_UNIT
;
817 /* A named bit field of declared type `int'
818 forces the entire structure to have `int' alignment.
819 Q1: How is encoded this thing and how to check for it?
820 Q2: How to determine maximum_field_alignment at runtime? */
822 /* if (DECL_NAME (field) != 0) */
824 int type_align
= bfld_type_align
;
826 if (maximum_field_alignment
!= 0)
827 type_align
= MIN (type_align
, maximum_field_alignment
);
828 else if (DECL_PACKED (field
))
829 type_align
= MIN (type_align
, BITS_PER_UNIT
);
832 layout
->record_align
= MAX (layout
->record_align
, type_align
);
836 layout
->record_align
= MAX (layout
->record_align
, desired_align
);
839 /* Does this field automatically have alignment it needs
840 by virtue of the fields that precede it and the record's
843 if (*type
== _C_BFLD
)
844 layout
->record_size
= atoi (type
+ 1);
845 else if (layout
->record_size
% desired_align
!= 0)
847 /* No, we need to skip space before this field.
848 Bump the cumulative size to multiple of field alignment. */
849 layout
->record_size
= ROUND (layout
->record_size
, desired_align
);
852 /* Jump to the next field in record. */
854 layout
->prev_type
= layout
->type
;
855 layout
->type
= objc_skip_typespec (layout
->type
); /* skip component */
861 void objc_layout_finish_structure (struct objc_struct_layout
*layout
,
865 if (layout
->type
&& *layout
->type
== _C_STRUCT_E
)
867 /* Work out the alignment of the record as one expression and store
868 in the record type. Round it up to a multiple of the record's
871 #if defined(ROUND_TYPE_ALIGN) && !defined(__sparc__)
872 layout
->record_align
= ROUND_TYPE_ALIGN (layout
->original_type
,
874 layout
->record_align
);
876 layout
->record_align
= MAX (1, layout
->record_align
);
879 #ifdef ROUND_TYPE_SIZE
880 layout
->record_size
= ROUND_TYPE_SIZE (layout
->original_type
,
882 layout
->record_align
);
884 /* Round the size up to be a multiple of the required alignment */
885 layout
->record_size
= ROUND (layout
->record_size
, layout
->record_align
);
891 *size
= layout
->record_size
/ BITS_PER_UNIT
;
893 *align
= layout
->record_align
/ BITS_PER_UNIT
;
897 void objc_layout_structure_get_info (struct objc_struct_layout
*layout
,
898 unsigned int *offset
,
903 *offset
= layout
->record_size
/ BITS_PER_UNIT
;
905 *align
= layout
->record_align
/ BITS_PER_UNIT
;
907 *type
= layout
->prev_type
;