1 /**********************************************************************
2
3 method.h -
4
5 $Author: nobu $
6 created at: Wed Jul 15 20:02:33 2009
7
8 Copyright (C) 2009 Koichi Sasada
9
10 **********************************************************************/
11 #ifndef RUBY_METHOD_H
12 #define RUBY_METHOD_H 1
13
14 #include "internal.h"
15
16 #ifndef END_OF_ENUMERATION
17 # if defined(__GNUC__) &&! defined(__STRICT_ANSI__)
18 # define END_OF_ENUMERATION(key)
19 # else
20 # define END_OF_ENUMERATION(key) END_OF_##key##_PLACEHOLDER = 0
21 # endif
22 #endif
23
24 /* cref */
25
26 typedef enum {
27 METHOD_VISI_UNDEF = 0x00,
28 METHOD_VISI_PUBLIC = 0x01,
29 METHOD_VISI_PRIVATE = 0x02,
30 METHOD_VISI_PROTECTED = 0x03,
31
32 METHOD_VISI_MASK = 0x03
33 } rb_method_visibility_t;
34
35 typedef struct rb_scope_visi_struct {
36 BITFIELD(rb_method_visibility_t, method_visi, 3);
37 unsigned int module_func : 1;
38 } rb_scope_visibility_t;
39
40 /*! CREF (Class REFerence) */
41 typedef struct rb_cref_struct {
42 VALUE flags;
43 const VALUE refinements;
44 const VALUE klass;
45 struct rb_cref_struct * const next;
46 const rb_scope_visibility_t scope_visi;
47 } rb_cref_t;
48
49 /* method data type */
50
51 typedef struct rb_method_entry_struct {
52 VALUE flags;
53 const VALUE defined_class;
54 struct rb_method_definition_struct * const def;
55 ID called_id;
56 const VALUE owner;
57 } rb_method_entry_t;
58
59 typedef struct rb_callable_method_entry_struct { /* same fields with rb_method_entry_t */
60 VALUE flags;
61 const VALUE defined_class;
62 struct rb_method_definition_struct * const def;
63 ID called_id;
64 const VALUE owner;
65 } rb_callable_method_entry_t;
66
67 #define METHOD_ENTRY_VISI(me) (rb_method_visibility_t)(((me)->flags & (IMEMO_FL_USER0 | IMEMO_FL_USER1)) >> (IMEMO_FL_USHIFT+0))
68 #define METHOD_ENTRY_BASIC(me) (int) (((me)->flags & (IMEMO_FL_USER2 )) >> (IMEMO_FL_USHIFT+2))
69 #define METHOD_ENTRY_COMPLEMENTED(me) ((me)->flags & IMEMO_FL_USER3)
70 #define METHOD_ENTRY_COMPLEMENTED_SET(me) ((me)->flags = (me)->flags | IMEMO_FL_USER3)
71
72 static inline void
METHOD_ENTRY_VISI_SET(rb_method_entry_t * me,rb_method_visibility_t visi)73 METHOD_ENTRY_VISI_SET(rb_method_entry_t *me, rb_method_visibility_t visi)
74 {
75 VM_ASSERT((int)visi >= 0 && visi <= 3);
76 me->flags = (me->flags & ~(IMEMO_FL_USER0 | IMEMO_FL_USER1)) | (visi << (IMEMO_FL_USHIFT+0));
77 }
78 static inline void
METHOD_ENTRY_BASIC_SET(rb_method_entry_t * me,unsigned int basic)79 METHOD_ENTRY_BASIC_SET(rb_method_entry_t *me, unsigned int basic)
80 {
81 VM_ASSERT(basic <= 1);
82 me->flags = (me->flags & ~(IMEMO_FL_USER2 )) | (basic << (IMEMO_FL_USHIFT+2));
83 }
84 static inline void
METHOD_ENTRY_FLAGS_SET(rb_method_entry_t * me,rb_method_visibility_t visi,unsigned int basic)85 METHOD_ENTRY_FLAGS_SET(rb_method_entry_t *me, rb_method_visibility_t visi, unsigned int basic)
86 {
87 VM_ASSERT((int)visi >= 0 && visi <= 3);
88 VM_ASSERT(basic <= 1);
89 me->flags =
90 (me->flags & ~(IMEMO_FL_USER0|IMEMO_FL_USER1|IMEMO_FL_USER2)) |
91 ((visi << (IMEMO_FL_USHIFT+0)) | (basic << (IMEMO_FL_USHIFT+2)));
92 }
93 static inline void
METHOD_ENTRY_FLAGS_COPY(rb_method_entry_t * dst,const rb_method_entry_t * src)94 METHOD_ENTRY_FLAGS_COPY(rb_method_entry_t *dst, const rb_method_entry_t *src)
95 {
96 dst->flags =
97 (dst->flags & ~(IMEMO_FL_USER0|IMEMO_FL_USER1|IMEMO_FL_USER2)) |
98 (src->flags & (IMEMO_FL_USER0|IMEMO_FL_USER1|IMEMO_FL_USER2));
99 }
100
101 typedef enum {
102 VM_METHOD_TYPE_ISEQ, /*!< Ruby method */
103 VM_METHOD_TYPE_CFUNC, /*!< C method */
104 VM_METHOD_TYPE_ATTRSET, /*!< attr_writer or attr_accessor */
105 VM_METHOD_TYPE_IVAR, /*!< attr_reader or attr_accessor */
106 VM_METHOD_TYPE_BMETHOD,
107 VM_METHOD_TYPE_ZSUPER,
108 VM_METHOD_TYPE_ALIAS,
109 VM_METHOD_TYPE_UNDEF,
110 VM_METHOD_TYPE_NOTIMPLEMENTED,
111 VM_METHOD_TYPE_OPTIMIZED, /*!< Kernel#send, Proc#call, etc */
112 VM_METHOD_TYPE_MISSING, /*!< wrapper for method_missing(id) */
113 VM_METHOD_TYPE_REFINED, /*!< refinement */
114
115 END_OF_ENUMERATION(VM_METHOD_TYPE)
116 } rb_method_type_t;
117 #define VM_METHOD_TYPE_MINIMUM_BITS 4
118 /* TODO: STATIC_ASSERT for VM_METHOD_TYPE_MINIMUM_BITS */
119
120 #ifndef rb_iseq_t
121 typedef struct rb_iseq_struct rb_iseq_t;
122 #define rb_iseq_t rb_iseq_t
123 #endif
124
125 typedef struct rb_method_iseq_struct {
126 const rb_iseq_t * const iseqptr; /*!< iseq pointer, should be separated from iseqval */
127 rb_cref_t * const cref; /*!< class reference, should be marked */
128 } rb_method_iseq_t; /* check rb_add_method_iseq() when modify the fields */
129
130 typedef struct rb_method_cfunc_struct {
131 VALUE (*func)(ANYARGS);
132 VALUE (*invoker)(VALUE (*func)(ANYARGS), VALUE recv, int argc, const VALUE *argv);
133 int argc;
134 } rb_method_cfunc_t;
135
136 typedef struct rb_method_attr_struct {
137 ID id;
138 const VALUE location; /* should be marked */
139 } rb_method_attr_t;
140
141 typedef struct rb_method_alias_struct {
142 const struct rb_method_entry_struct * const original_me; /* original_me->klass is original owner */
143 } rb_method_alias_t;
144
145 typedef struct rb_method_refined_struct {
146 const struct rb_method_entry_struct * const orig_me;
147 const VALUE owner;
148 } rb_method_refined_t;
149
150 typedef struct rb_method_bmethod_struct {
151 const VALUE proc; /* should be marked */
152 struct rb_hook_list_struct *hooks;
153 } rb_method_bmethod_t;
154
155 enum method_optimized_type {
156 OPTIMIZED_METHOD_TYPE_SEND,
157 OPTIMIZED_METHOD_TYPE_CALL,
158 OPTIMIZED_METHOD_TYPE_BLOCK_CALL,
159 OPTIMIZED_METHOD_TYPE__MAX
160 };
161
162 PACKED_STRUCT_UNALIGNED(struct rb_method_definition_struct {
163 BITFIELD(rb_method_type_t, type, VM_METHOD_TYPE_MINIMUM_BITS);
164 int alias_count : 28;
165 int complemented_count : 28;
166
167 union {
168 rb_method_iseq_t iseq;
169 rb_method_cfunc_t cfunc;
170 rb_method_attr_t attr;
171 rb_method_alias_t alias;
172 rb_method_refined_t refined;
173 rb_method_bmethod_t bmethod;
174
175 enum method_optimized_type optimize_type;
176 } body;
177
178 ID original_id;
179 });
180
181 typedef struct rb_method_definition_struct rb_method_definition_t;
182
183 #define UNDEFINED_METHOD_ENTRY_P(me) (!(me) || !(me)->def || (me)->def->type == VM_METHOD_TYPE_UNDEF)
184 #define UNDEFINED_REFINED_METHOD_P(def) \
185 ((def)->type == VM_METHOD_TYPE_REFINED && \
186 UNDEFINED_METHOD_ENTRY_P((def)->body.refined.orig_me))
187
188 void rb_add_method_cfunc(VALUE klass, ID mid, VALUE (*func)(ANYARGS), int argc, rb_method_visibility_t visi);
189 void rb_add_method_iseq(VALUE klass, ID mid, const rb_iseq_t *iseq, rb_cref_t *cref, rb_method_visibility_t visi);
190 void rb_add_refined_method_entry(VALUE refined_class, ID mid);
191
192 rb_method_entry_t *rb_add_method(VALUE klass, ID mid, rb_method_type_t type, void *option, rb_method_visibility_t visi);
193 rb_method_entry_t *rb_method_entry_set(VALUE klass, ID mid, const rb_method_entry_t *, rb_method_visibility_t noex);
194 rb_method_entry_t *rb_method_entry_create(ID called_id, VALUE klass, rb_method_visibility_t visi, const rb_method_definition_t *def);
195
196 const rb_method_entry_t *rb_method_entry_at(VALUE obj, ID id);
197
198 const rb_method_entry_t *rb_method_entry(VALUE klass, ID id);
199 const rb_method_entry_t *rb_method_entry_without_refinements(VALUE klass, ID id, VALUE *defined_class);
200 const rb_method_entry_t *rb_resolve_refined_method(VALUE refinements, const rb_method_entry_t *me);
201 RUBY_SYMBOL_EXPORT_BEGIN
202 const rb_callable_method_entry_t *rb_resolve_refined_method_callable(VALUE refinements, const rb_callable_method_entry_t *me);
203 const rb_method_entry_t *rb_resolve_me_location(const rb_method_entry_t *, VALUE[5]);
204 RUBY_SYMBOL_EXPORT_END
205
206 const rb_callable_method_entry_t *rb_callable_method_entry(VALUE klass, ID id);
207 const rb_callable_method_entry_t *rb_callable_method_entry_with_refinements(VALUE klass, ID id, VALUE *defined_class);
208 const rb_callable_method_entry_t *rb_callable_method_entry_without_refinements(VALUE klass, ID id, VALUE *defined_class);
209
210 int rb_method_entry_arity(const rb_method_entry_t *me);
211 int rb_method_entry_eq(const rb_method_entry_t *m1, const rb_method_entry_t *m2);
212 st_index_t rb_hash_method_entry(st_index_t hash, const rb_method_entry_t *me);
213
214 VALUE rb_method_entry_location(const rb_method_entry_t *me);
215 VALUE rb_mod_method_location(VALUE mod, ID id);
216 VALUE rb_obj_method_location(VALUE obj, ID id);
217
218 void rb_free_method_entry(const rb_method_entry_t *me);
219 void rb_sweep_method_entry(void *vm);
220
221 const rb_method_entry_t *rb_method_entry_clone(const rb_method_entry_t *me);
222 const rb_callable_method_entry_t *rb_method_entry_complement_defined_class(const rb_method_entry_t *src_me, ID called_id, VALUE defined_class);
223 void rb_method_entry_copy(rb_method_entry_t *dst, const rb_method_entry_t *src);
224
225 void rb_scope_visibility_set(rb_method_visibility_t);
226
227 VALUE rb_unnamed_parameters(int arity);
228
229 #endif /* RUBY_METHOD_H */
230