diff options
Diffstat (limited to 'method.h')
| -rw-r--r-- | method.h | 299 |
1 files changed, 217 insertions, 82 deletions
@@ -1,3 +1,5 @@ +#ifndef RUBY_METHOD_H +#define RUBY_METHOD_H 1 /********************************************************************** method.h - @@ -8,134 +10,267 @@ Copyright (C) 2009 Koichi Sasada **********************************************************************/ -#ifndef METHOD_H -#define METHOD_H + +#include "internal.h" +#include "internal/imemo.h" +#include "internal/compilers.h" +#include "internal/static_assert.h" +#include "ruby/atomic.h" #ifndef END_OF_ENUMERATION -# ifdef __GNUC__ +# if defined(__GNUC__) &&! defined(__STRICT_ANSI__) # define END_OF_ENUMERATION(key) # else # define END_OF_ENUMERATION(key) END_OF_##key##_PLACEHOLDER = 0 # endif #endif +/* cref */ + typedef enum { - NOEX_PUBLIC = 0x00, - NOEX_NOSUPER = 0x01, - NOEX_PRIVATE = 0x02, - NOEX_PROTECTED = 0x04, - NOEX_MASK = 0x06, - NOEX_BASIC = 0x08, - NOEX_UNDEF = NOEX_NOSUPER, - NOEX_MODFUNC = 0x12, - NOEX_SUPER = 0x20, - NOEX_VCALL = 0x40, - NOEX_RESPONDS = 0x80, - - NOEX_BIT_WIDTH = 8, - NOEX_SAFE_SHIFT_OFFSET = ((NOEX_BIT_WIDTH+3)/4)*4 /* round up to nibble */ -} rb_method_flag_t; - -#define NOEX_SAFE(n) ((int)((n) >> NOEX_SAFE_SHIFT_OFFSET) & 0x0F) -#define NOEX_WITH(n, s) (((s) << NOEX_SAFE_SHIFT_OFFSET) | (n) | (ruby_running ? 0 : NOEX_BASIC)) -#define NOEX_WITH_SAFE(n) NOEX_WITH((n), rb_safe_level()) + METHOD_VISI_UNDEF = 0x00, + METHOD_VISI_PUBLIC = 0x01, + METHOD_VISI_PRIVATE = 0x02, + METHOD_VISI_PROTECTED = 0x03, + + METHOD_VISI_MASK = 0x03 +} rb_method_visibility_t; + +typedef struct rb_scope_visi_struct { + BITFIELD(rb_method_visibility_t, method_visi, 3); + unsigned int module_func : 1; +} rb_scope_visibility_t; + +/*! CREF (Class REFerence) */ +typedef struct rb_cref_struct { + VALUE flags; + VALUE refinements; + VALUE klass_or_self; + struct rb_cref_struct * next; + const rb_scope_visibility_t scope_visi; +} rb_cref_t; /* method data type */ +typedef struct rb_method_entry_struct { + VALUE flags; + VALUE defined_class; + struct rb_method_definition_struct * const def; + ID called_id; + VALUE owner; +} rb_method_entry_t; + +typedef struct rb_callable_method_entry_struct { /* same fields with rb_method_entry_t */ + VALUE flags; + const VALUE defined_class; + struct rb_method_definition_struct * const def; + ID called_id; + const VALUE owner; +} rb_callable_method_entry_t; + +#define METHOD_ENTRY_VISI(me) (rb_method_visibility_t)(((me)->flags & (IMEMO_FL_USER0 | IMEMO_FL_USER1)) >> (IMEMO_FL_USHIFT+0)) +#define METHOD_ENTRY_BASIC(me) (int) (((me)->flags & (IMEMO_FL_USER2 )) >> (IMEMO_FL_USHIFT+2)) +#define METHOD_ENTRY_COMPLEMENTED(me) ((me)->flags & IMEMO_FL_USER3) +#define METHOD_ENTRY_COMPLEMENTED_SET(me) ((me)->flags |= IMEMO_FL_USER3) +#define METHOD_ENTRY_CACHED(me) ((me)->flags & IMEMO_FL_USER4) +#define METHOD_ENTRY_INVALIDATED(me) ((me)->flags & IMEMO_FL_USER5) +#define METHOD_ENTRY_INVALIDATED_SET(me) ((me)->flags |= IMEMO_FL_USER5) + +static inline void +METHOD_ENTRY_CACHED_SET(rb_callable_method_entry_t *me) +{ + if (!METHOD_ENTRY_CACHED(me)) { + me->flags |= IMEMO_FL_USER4; + } +} + +static inline void +METHOD_ENTRY_VISI_SET(rb_method_entry_t *me, rb_method_visibility_t visi) +{ + VM_ASSERT((int)visi >= 0 && visi <= 3); + me->flags = (me->flags & ~(IMEMO_FL_USER0 | IMEMO_FL_USER1)) | (visi << (IMEMO_FL_USHIFT+0)); +} +static inline void +METHOD_ENTRY_BASIC_SET(rb_method_entry_t *me, unsigned int basic) +{ + VM_ASSERT(basic <= 1); + me->flags = (me->flags & ~(IMEMO_FL_USER2 )) | (basic << (IMEMO_FL_USHIFT+2)); +} +static inline void +METHOD_ENTRY_FLAGS_SET(rb_method_entry_t *me, rb_method_visibility_t visi, unsigned int basic) +{ + VM_ASSERT((int)visi >= 0 && visi <= 3); + VM_ASSERT(basic <= 1); + me->flags = + (me->flags & ~(IMEMO_FL_USER0|IMEMO_FL_USER1|IMEMO_FL_USER2)) | + ((visi << (IMEMO_FL_USHIFT+0)) | (basic << (IMEMO_FL_USHIFT+2))); +} +static inline void +METHOD_ENTRY_FLAGS_COPY(rb_method_entry_t *dst, const rb_method_entry_t *src) +{ + dst->flags = + (dst->flags & ~(IMEMO_FL_USER0|IMEMO_FL_USER1|IMEMO_FL_USER2 + |IMEMO_FL_USER3)) | + (src->flags & (IMEMO_FL_USER0|IMEMO_FL_USER1|IMEMO_FL_USER2|IMEMO_FL_USER3)); +} + typedef enum { - VM_METHOD_TYPE_ISEQ, - VM_METHOD_TYPE_CFUNC, - VM_METHOD_TYPE_ATTRSET, - VM_METHOD_TYPE_IVAR, + VM_METHOD_TYPE_ISEQ, /*!< Ruby method */ + VM_METHOD_TYPE_CFUNC, /*!< C method */ + VM_METHOD_TYPE_ATTRSET, /*!< attr_writer or attr_accessor */ + VM_METHOD_TYPE_IVAR, /*!< attr_reader or attr_accessor */ VM_METHOD_TYPE_BMETHOD, VM_METHOD_TYPE_ZSUPER, + VM_METHOD_TYPE_ALIAS, VM_METHOD_TYPE_UNDEF, VM_METHOD_TYPE_NOTIMPLEMENTED, - VM_METHOD_TYPE_OPTIMIZED, /* Kernel#send, Proc#call, etc */ - VM_METHOD_TYPE_MISSING, /* wrapper for method_missing(id) */ - VM_METHOD_TYPE_REFINED, + VM_METHOD_TYPE_OPTIMIZED, /*!< Kernel#send, Proc#call, etc */ + VM_METHOD_TYPE_MISSING, /*!< wrapper for method_missing(id) */ + VM_METHOD_TYPE_REFINED, /*!< refinement */ END_OF_ENUMERATION(VM_METHOD_TYPE) } rb_method_type_t; +#define VM_METHOD_TYPE_MINIMUM_BITS 4 +STATIC_ASSERT(VM_METHOD_TYPE_MINIMUM_BITS, + VM_METHOD_TYPE_REFINED <= (1<<VM_METHOD_TYPE_MINIMUM_BITS)); + +#ifndef rb_iseq_t +typedef struct rb_iseq_struct rb_iseq_t; +#define rb_iseq_t rb_iseq_t +#endif -struct rb_call_info_struct; +typedef struct rb_method_iseq_struct { + const rb_iseq_t * iseqptr; /*!< iseq pointer, should be separated from iseqval */ + rb_cref_t * cref; /*!< class reference, should be marked */ +} rb_method_iseq_t; /* check rb_add_method_iseq() when modify the fields */ +typedef VALUE (*rb_cfunc_t)(ANYARGS); typedef struct rb_method_cfunc_struct { - VALUE (*func)(ANYARGS); - VALUE (*invoker)(VALUE (*func)(ANYARGS), VALUE recv, int argc, const VALUE *argv); + rb_cfunc_t func; + VALUE (*invoker)(VALUE recv, int argc, const VALUE *argv, VALUE (*func)(ANYARGS)); int argc; } rb_method_cfunc_t; typedef struct rb_method_attr_struct { ID id; - VALUE location; + VALUE location; /* should be marked */ } rb_method_attr_t; -typedef struct rb_iseq_struct rb_iseq_t; +typedef struct rb_method_alias_struct { + struct rb_method_entry_struct * original_me; /* original_me->klass is original owner */ +} rb_method_alias_t; + +typedef struct rb_method_refined_struct { + struct rb_method_entry_struct * orig_me; +} rb_method_refined_t; + +typedef struct rb_method_bmethod_struct { + VALUE proc; /* should be marked */ + rb_serial_t defined_ractor_id; + unsigned int local_hooks_cnt; +} rb_method_bmethod_t; + +enum method_optimized_type { + OPTIMIZED_METHOD_TYPE_SEND, + OPTIMIZED_METHOD_TYPE_CALL, + OPTIMIZED_METHOD_TYPE_BLOCK_CALL, + OPTIMIZED_METHOD_TYPE_STRUCT_AREF, + OPTIMIZED_METHOD_TYPE_STRUCT_ASET, + OPTIMIZED_METHOD_TYPE__MAX +}; + +typedef struct rb_method_optimized { + enum method_optimized_type type; + unsigned int index; +} rb_method_optimized_t; + +struct rb_method_definition_struct { + BITFIELD(rb_method_type_t, type, VM_METHOD_TYPE_MINIMUM_BITS); + unsigned int iseq_overload: 1; + unsigned int no_redef_warning: 1; + unsigned int aliased : 1; + + rb_atomic_t reference_count; -typedef struct rb_method_definition_struct { - rb_method_type_t type; /* method type */ - ID original_id; union { - rb_iseq_t *iseq; /* should be mark */ - rb_method_cfunc_t cfunc; - rb_method_attr_t attr; - VALUE proc; /* should be mark */ - enum method_optimized_type { - OPTIMIZED_METHOD_TYPE_SEND, - OPTIMIZED_METHOD_TYPE_CALL, - - OPTIMIZED_METHOD_TYPE__MAX - } optimize_type; - struct rb_method_entry_struct *orig_me; + rb_method_iseq_t iseq; + rb_method_cfunc_t cfunc; + rb_method_attr_t attr; + rb_method_alias_t alias; + rb_method_refined_t refined; + rb_method_bmethod_t bmethod; + rb_method_optimized_t optimized; } body; - int alias_count; -} rb_method_definition_t; -typedef struct rb_method_entry_struct { - rb_method_flag_t flag; - char mark; - rb_method_definition_t *def; - ID called_id; - VALUE klass; /* should be mark */ -} rb_method_entry_t; - -struct unlinked_method_entry_list_entry { - struct unlinked_method_entry_list_entry *next; - rb_method_entry_t *me; + ID original_id; + uintptr_t method_serial; + const rb_box_t *box; }; +struct rb_id_table; +struct rb_ractor_struct; +struct rb_hook_list_struct; + +typedef struct rb_method_definition_struct rb_method_definition_t; +STATIC_ASSERT(sizeof_method_def, offsetof(rb_method_definition_t, body) <= 8); + #define UNDEFINED_METHOD_ENTRY_P(me) (!(me) || !(me)->def || (me)->def->type == VM_METHOD_TYPE_UNDEF) #define UNDEFINED_REFINED_METHOD_P(def) \ ((def)->type == VM_METHOD_TYPE_REFINED && \ - UNDEFINED_METHOD_ENTRY_P((def)->body.orig_me)) + UNDEFINED_METHOD_ENTRY_P((def)->body.refined.orig_me)) -void rb_add_method_cfunc(VALUE klass, ID mid, VALUE (*func)(ANYARGS), int argc, rb_method_flag_t noex); -rb_method_entry_t *rb_add_method(VALUE klass, ID mid, rb_method_type_t type, void *option, rb_method_flag_t noex); -rb_method_entry_t *rb_method_entry(VALUE klass, ID id, VALUE *define_class_ptr); +void rb_add_method(VALUE klass, ID mid, rb_method_type_t type, void *option, rb_method_visibility_t visi); +void rb_add_method_cfunc(VALUE klass, ID mid, VALUE (*func)(ANYARGS), int argc, rb_method_visibility_t visi); +void rb_add_method_iseq(VALUE klass, ID mid, const rb_iseq_t *iseq, rb_cref_t *cref, rb_method_visibility_t visi); +void rb_add_method_optimized(VALUE klass, ID mid, enum method_optimized_type, unsigned int index, rb_method_visibility_t visi); void rb_add_refined_method_entry(VALUE refined_class, ID mid); -rb_method_entry_t *rb_resolve_refined_method(VALUE refinements, - const rb_method_entry_t *me, - VALUE *defined_class_ptr); -rb_method_entry_t *rb_method_entry_with_refinements(VALUE klass, ID id, - VALUE *defined_class_ptr); -rb_method_entry_t *rb_method_entry_without_refinements(VALUE klass, ID id, - VALUE *defined_class_ptr); -rb_method_entry_t *rb_method_entry_get_without_cache(VALUE klass, ID id, VALUE *define_class_ptr); -rb_method_entry_t *rb_method_entry_set(VALUE klass, ID mid, const rb_method_entry_t *, rb_method_flag_t noex); +rb_method_entry_t *rb_method_entry_set(VALUE klass, ID mid, const rb_method_entry_t *, rb_method_visibility_t noex); +rb_method_entry_t *rb_method_entry_create(ID called_id, VALUE klass, rb_method_visibility_t visi, rb_method_definition_t *def); + +const rb_method_entry_t *rb_method_entry_at(VALUE obj, ID id); + +const rb_method_entry_t *rb_method_entry(VALUE klass, ID id); +const rb_method_entry_t *rb_method_entry_with_refinements(VALUE klass, ID id, VALUE *defined_class); +const rb_method_entry_t *rb_method_entry_without_refinements(VALUE klass, ID id, VALUE *defined_class); +const rb_method_entry_t *rb_resolve_refined_method(VALUE refinements, const rb_method_entry_t *me); +RUBY_SYMBOL_EXPORT_BEGIN +const rb_method_entry_t *rb_resolve_me_location(const rb_method_entry_t *, VALUE[5]); +RUBY_SYMBOL_EXPORT_END + +const rb_callable_method_entry_t *rb_callable_method_entry(VALUE klass, ID id); +const rb_callable_method_entry_t *rb_callable_method_entry_or_negative(VALUE klass, ID id); +const rb_callable_method_entry_t *rb_callable_method_entry_with_refinements(VALUE klass, ID id, VALUE *defined_class); +const rb_callable_method_entry_t *rb_callable_method_entry_without_refinements(VALUE klass, ID id, VALUE *defined_class); int rb_method_entry_arity(const rb_method_entry_t *me); int rb_method_entry_eq(const rb_method_entry_t *m1, const rb_method_entry_t *m2); st_index_t rb_hash_method_entry(st_index_t hash, const rb_method_entry_t *me); -VALUE rb_method_entry_location(rb_method_entry_t *me); -VALUE rb_mod_method_location(VALUE mod, ID id); -VALUE rb_obj_method_location(VALUE obj, ID id); +VALUE rb_method_entry_location(const rb_method_entry_t *me); + +void rb_free_method_entry_vm_weak_references(const rb_method_entry_t *me); +void rb_free_method_entry(const rb_method_entry_t *me); + +const rb_method_entry_t *rb_method_entry_clone(const rb_method_entry_t *me); +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); +void rb_method_entry_copy(rb_method_entry_t *dst, const rb_method_entry_t *src); + +void rb_method_table_insert(VALUE klass, struct rb_id_table *table, ID method_id, const rb_method_entry_t *me); +void rb_method_table_insert0(VALUE klass, struct rb_id_table *table, ID method_id, const rb_method_entry_t *me, bool iclass_shared_mtbl); + +void rb_scope_visibility_set(rb_method_visibility_t); + +VALUE rb_unnamed_parameters(int arity); + +void rb_vm_insert_cc_refinement(const struct rb_callcache *cc); +void rb_vm_delete_cc_refinement(const struct rb_callcache *cc); -void rb_mark_method_entry(const rb_method_entry_t *me); -void rb_free_method_entry(rb_method_entry_t *me); -void rb_sweep_method_entry(void *vm); -void rb_free_m_table(st_table *tbl); +void rb_clear_method_cache(VALUE klass_or_module, ID mid); +void rb_clear_all_refinement_method_cache(void); +void rb_invalidate_method_caches(struct rb_id_table *cm_tbl, VALUE cc_tbl); +struct rb_hook_list_struct *rb_method_def_local_hooks(rb_method_definition_t *def, struct rb_ractor_struct *cr, bool create); +void rb_method_definition_addref(rb_method_definition_t *def); +void rb_method_definition_release(rb_method_definition_t *def); -#endif /* METHOD_H */ +#endif /* RUBY_METHOD_H */ |