1#ifndef RUBY_VM_CALLINFO_H
2#define RUBY_VM_CALLINFO_H
11#include "debug_counter.h"
12#include "internal/class.h"
15enum vm_call_flag_bits {
16 VM_CALL_ARGS_SPLAT_bit,
17 VM_CALL_ARGS_BLOCKARG_bit,
20 VM_CALL_ARGS_SIMPLE_bit,
27 VM_CALL_KW_SPLAT_MUT_bit,
28 VM_CALL_ARGS_SPLAT_MUT_bit,
29 VM_CALL_FORWARDING_bit,
33#define VM_CALL_ARGS_SPLAT (0x01 << VM_CALL_ARGS_SPLAT_bit)
34#define VM_CALL_ARGS_BLOCKARG (0x01 << VM_CALL_ARGS_BLOCKARG_bit)
35#define VM_CALL_FCALL (0x01 << VM_CALL_FCALL_bit)
36#define VM_CALL_VCALL (0x01 << VM_CALL_VCALL_bit)
37#define VM_CALL_ARGS_SIMPLE (0x01 << VM_CALL_ARGS_SIMPLE_bit)
38#define VM_CALL_KWARG (0x01 << VM_CALL_KWARG_bit)
39#define VM_CALL_KW_SPLAT (0x01 << VM_CALL_KW_SPLAT_bit)
40#define VM_CALL_TAILCALL (0x01 << VM_CALL_TAILCALL_bit)
41#define VM_CALL_SUPER (0x01 << VM_CALL_SUPER_bit)
42#define VM_CALL_ZSUPER (0x01 << VM_CALL_ZSUPER_bit)
43#define VM_CALL_OPT_SEND (0x01 << VM_CALL_OPT_SEND_bit)
44#define VM_CALL_KW_SPLAT_MUT (0x01 << VM_CALL_KW_SPLAT_MUT_bit)
45#define VM_CALL_ARGS_SPLAT_MUT (0x01 << VM_CALL_ARGS_SPLAT_MUT_bit)
46#define VM_CALL_FORWARDING (0x01 << VM_CALL_FORWARDING_bit)
55rb_callinfo_kwarg_bytes(
int keyword_len)
57 return rb_size_mul_add_or_raise(
74 ruby_sized_xfree(kwarg, rb_callinfo_kwarg_bytes(kwarg->keyword_len));
87#if !defined(USE_EMBED_CI) || (USE_EMBED_CI+0)
96#define CI_EMBED_TAG_bits 1
97#define CI_EMBED_ARGC_bits 15
98#define CI_EMBED_FLAG_bits 16
99#define CI_EMBED_ID_bits 32
100#elif SIZEOF_VALUE == 4
101#define CI_EMBED_TAG_bits 1
102#define CI_EMBED_ARGC_bits 3
103#define CI_EMBED_FLAG_bits 13
104#define CI_EMBED_ID_bits 15
107#if (CI_EMBED_TAG_bits + CI_EMBED_ARGC_bits + CI_EMBED_FLAG_bits + CI_EMBED_ID_bits) != (SIZEOF_VALUE * 8)
111#define CI_EMBED_FLAG 0x01
112#define CI_EMBED_ARGC_SHFT (CI_EMBED_TAG_bits)
113#define CI_EMBED_ARGC_MASK ((((VALUE)1)<<CI_EMBED_ARGC_bits) - 1)
114#define CI_EMBED_FLAG_SHFT (CI_EMBED_TAG_bits + CI_EMBED_ARGC_bits)
115#define CI_EMBED_FLAG_MASK ((((VALUE)1)<<CI_EMBED_FLAG_bits) - 1)
116#define CI_EMBED_ID_SHFT (CI_EMBED_TAG_bits + CI_EMBED_ARGC_bits + CI_EMBED_FLAG_bits)
117#define CI_EMBED_ID_MASK ((((VALUE)1)<<CI_EMBED_ID_bits) - 1)
125 if (LIKELY(((
VALUE)ci) & 0x01)) {
129 VM_ASSERT(IMEMO_TYPE_P(ci, imemo_callinfo));
137 if (vm_ci_packed_p(ci) || IMEMO_TYPE_P(ci, imemo_callinfo)) {
148 if (vm_ci_packed_p(ci)) {
149 return (((
VALUE)ci) >> CI_EMBED_ID_SHFT) & CI_EMBED_ID_MASK;
156static inline unsigned int
159 if (vm_ci_packed_p(ci)) {
160 return (
unsigned int)((((
VALUE)ci) >> CI_EMBED_FLAG_SHFT) & CI_EMBED_FLAG_MASK);
163 return (
unsigned int)ci->flag;
167static inline unsigned int
170 if (vm_ci_packed_p(ci)) {
171 return (
unsigned int)((((
VALUE)ci) >> CI_EMBED_ARGC_SHFT) & CI_EMBED_ARGC_MASK);
174 return (
unsigned int)ci->argc;
181 if (vm_ci_packed_p(ci)) {
192 if (vm_ci_packed_p(ci)) {
193 ruby_debug_printf(
"packed_ci ID:%s flag:%x argc:%u\n",
194 rb_id2name(vm_ci_mid(ci)), vm_ci_flag(ci), vm_ci_argc(ci));
201#define vm_ci_new(mid, flag, argc, kwarg) vm_ci_new_(mid, flag, argc, kwarg, __FILE__, __LINE__)
202#define vm_ci_new_runtime(mid, flag, argc, kwarg) vm_ci_new_runtime_(mid, flag, argc, kwarg, __FILE__, __LINE__)
205#define VM_CI_EMBEDDABLE_P(mid, flag, argc, kwarg) \
206 (((mid ) & ~CI_EMBED_ID_MASK) ? false : \
207 ((flag) & ~CI_EMBED_FLAG_MASK) ? false : \
208 ((argc) & ~CI_EMBED_ARGC_MASK) ? false : \
209 (kwarg) ? false : true)
211#define vm_ci_new_id(mid, flag, argc, must_zero) \
212 ((const struct rb_callinfo *) \
213 ((((VALUE)(mid )) << CI_EMBED_ID_SHFT) | \
214 (((VALUE)(flag)) << CI_EMBED_FLAG_SHFT) | \
215 (((VALUE)(argc)) << CI_EMBED_ARGC_SHFT) | \
223vm_ci_new_(
ID mid,
unsigned int flag,
unsigned int argc,
const struct rb_callinfo_kwarg *kwarg,
const char *file,
int line)
225 if (USE_EMBED_CI && VM_CI_EMBEDDABLE_P(mid, flag, argc, kwarg)) {
226 RB_DEBUG_COUNTER_INC(ci_packed);
227 return vm_ci_new_id(mid, flag, argc, kwarg);
230 const bool debug = 0;
231 if (debug) ruby_debug_printf(
"%s:%d ", file, line);
233 const struct rb_callinfo *ci = rb_vm_ci_lookup(mid, flag, argc, kwarg);
237 RB_DEBUG_COUNTER_INC(ci_kw);
240 RB_DEBUG_COUNTER_INC(ci_nokw);
243 VM_ASSERT(vm_ci_flag(ci) == flag);
244 VM_ASSERT(vm_ci_argc(ci) == argc);
251vm_ci_new_runtime_(
ID mid,
unsigned int flag,
unsigned int argc,
const struct rb_callinfo_kwarg *kwarg,
const char *file,
int line)
253 RB_DEBUG_COUNTER_INC(ci_runtime);
254 return vm_ci_new_(mid, flag, argc, kwarg, file, line);
257#define VM_CALLINFO_NOT_UNDER_GC IMEMO_FL_USER0
265 else if (vm_ci_packed_p(ci)) {
269 VM_ASSERT(IMEMO_TYPE_P(ci, imemo_callinfo));
274#define VM_CI_ON_STACK(mid_, flags_, argc_, kwarg_) \
275 (struct rb_callinfo) { \
277 (imemo_callinfo << FL_USHIFT) | \
278 VM_CALLINFO_NOT_UNDER_GC, \
285typedef VALUE (*vm_call_handler)(
300 const vm_call_handler call_;
306 const enum method_missing_reason method_missing_reason;
313#define VM_CALLCACHE_IVAR IMEMO_FL_USER0
314#define VM_CALLCACHE_BF IMEMO_FL_USER1
315#define VM_CALLCACHE_SUPER IMEMO_FL_USER2
316#define VM_CALLCACHE_REFINEMENT IMEMO_FL_USER3
317#define VM_CALLCACHE_UNMARKABLE IMEMO_FL_USER4
318#define VM_CALLCACHE_ON_STACK IMEMO_FL_USER5
319#define VM_CALLCACHE_INVALID_SUPER IMEMO_FL_USER6
328extern const struct rb_callcache *rb_vm_empty_cc_for_super(
void);
330#define vm_cc_empty() rb_vm_empty_cc()
332static inline void vm_cc_attr_index_set(
const struct rb_callcache *cc, attr_index_t index, shape_id_t dest_shape_id);
335vm_cc_attr_index_initialize(
const struct rb_callcache *cc, shape_id_t shape_id)
337 vm_cc_attr_index_set(cc, (attr_index_t)-1, shape_id);
341cc_check_class(
VALUE klass)
349void rb_vm_cc_table_delete(
VALUE table,
ID mid);
352vm_cc_new(
VALUE klass,
354 vm_call_handler call,
355 enum vm_cc_type
type)
357 cc_check_class(klass);
360 *((vm_call_handler *)&cc->call_) = call;
366 *(
VALUE *)&cc->flags |= VM_CALLCACHE_SUPER;
368 case cc_type_refinement:
369 *(
VALUE *)&cc->flags |= VM_CALLCACHE_REFINEMENT;
370 rb_vm_insert_cc_refinement(cc);
375 if (cme->def->type == VM_METHOD_TYPE_ATTRSET || cme->def->type == VM_METHOD_TYPE_IVAR) {
376 vm_cc_attr_index_initialize(cc, INVALID_SHAPE_ID);
380 *(
VALUE *)&cc->flags |= VM_CALLCACHE_INVALID_SUPER;
383 RB_DEBUG_COUNTER_INC(cc_new);
390 return (cc->flags & VM_CALLCACHE_SUPER) != 0;
396 return (cc->flags & VM_CALLCACHE_REFINEMENT) != 0;
399#define VM_CC_ON_STACK(clazz, call, aux, cme) \
400 (struct rb_callcache) { \
402 (imemo_callcache << FL_USHIFT) | \
403 VM_CALLCACHE_UNMARKABLE | \
404 VM_CALLCACHE_ON_STACK, \
405 .klass = cc_check_class(clazz), \
414 VM_ASSERT(IMEMO_TYPE_P(cc, imemo_callcache));
415 VM_ASSERT(cc_check_class(cc->klass));
416 return cc->klass == klass;
422 VM_ASSERT(IMEMO_TYPE_P(cc, imemo_callcache));
429 VM_ASSERT(IMEMO_TYPE_P(cc, imemo_callcache));
437 VM_ASSERT(IMEMO_TYPE_P(cc, imemo_callcache));
438 VM_ASSERT(cc_check_class(cc->klass));
440 return !UNDEF_P(cc->klass);
446 VM_ASSERT(IMEMO_TYPE_P(cc, imemo_callcache));
447 VM_ASSERT(cc->klass !=
Qundef || !vm_cc_markable(cc) || vm_cc_invalid_super(cc));
448 VM_ASSERT(cc_check_class(cc->klass));
449 VM_ASSERT(cc->call_ == NULL ||
450 !vm_cc_markable(cc) ||
451 vm_cc_invalid_super(cc) ||
457static inline vm_call_handler
460 VM_ASSERT(IMEMO_TYPE_P(cc, imemo_callcache));
461 VM_ASSERT(cc->call_ != NULL);
462 VM_ASSERT(cc->klass !=
Qundef || !vm_cc_markable(cc) || vm_cc_invalid_super(cc));
463 VM_ASSERT(cc_check_class(cc->klass));
468vm_unpack_shape_and_index(
const uint64_t cache_value, shape_id_t *shape_id, attr_index_t *index)
473 *shape_id = cache.unpack.shape_id;
474 *index = cache.unpack.index - 1;
478vm_cc_atomic_shape_and_index(
const struct rb_callcache *cc, shape_id_t *shape_id, attr_index_t *index)
480 vm_unpack_shape_and_index(ATOMIC_U64_LOAD_RELAXED(cc->aux_.attr.value), shape_id, index);
486 vm_unpack_shape_and_index(ATOMIC_U64_LOAD_RELAXED(ic->value), shape_id, index);
489static inline unsigned int
490vm_cc_cmethod_missing_reason(
const struct rb_callcache *cc)
492 VM_ASSERT(IMEMO_TYPE_P(cc, imemo_callcache));
493 return cc->aux_.method_missing_reason;
499 if (vm_cc_valid(cc) && !METHOD_ENTRY_INVALIDATED(vm_cc_cme(cc))) {
510vm_cc_call_set(
const struct rb_callcache *cc, vm_call_handler call)
512 VM_ASSERT(IMEMO_TYPE_P(cc, imemo_callcache));
513 VM_ASSERT(cc != vm_cc_empty());
514 *(vm_call_handler *)&cc->call_ = call;
520 *(
VALUE *)&cc->flags |= VM_CALLCACHE_IVAR;
523static inline uint64_t
524vm_pack_shape_and_index(shape_id_t shape_id, attr_index_t index)
528 .shape_id = shape_id,
536vm_cc_attr_index_set(
const struct rb_callcache *cc, attr_index_t index, shape_id_t dest_shape_id)
538 uint64_t *attr_value = (uint64_t *)&cc->aux_.attr.value;
539 if (!vm_cc_markable(cc)) {
540 *attr_value = vm_pack_shape_and_index(INVALID_SHAPE_ID, ATTR_INDEX_NOT_SET);
543 VM_ASSERT(IMEMO_TYPE_P(cc, imemo_callcache));
544 VM_ASSERT(cc != vm_cc_empty());
545 *attr_value = vm_pack_shape_and_index(dest_shape_id, index);
552 return (cc->flags & VM_CALLCACHE_IVAR) != 0;
556vm_ic_attr_index_set(
const rb_iseq_t *iseq,
struct iseq_inline_iv_cache_entry *ic, attr_index_t index, shape_id_t dest_shape_id)
558 ATOMIC_U64_SET_RELAXED(ic->value, vm_pack_shape_and_index(dest_shape_id, index));
564 ATOMIC_U64_SET_RELAXED(ic->value, vm_pack_shape_and_index(shape_id, ATTR_INDEX_NOT_SET));
568vm_cc_method_missing_reason_set(
const struct rb_callcache *cc,
enum method_missing_reason reason)
570 VM_ASSERT(IMEMO_TYPE_P(cc, imemo_callcache));
571 VM_ASSERT(cc != vm_cc_empty());
572 *(
enum method_missing_reason *)&cc->aux_.method_missing_reason = reason;
578 VM_ASSERT(IMEMO_TYPE_P(cc, imemo_callcache));
579 VM_ASSERT(cc != vm_cc_empty());
581 *(
VALUE *)&cc->flags |= VM_CALLCACHE_BF;
587 return (cc->flags & VM_CALLCACHE_BF) != 0;
593 VM_ASSERT(IMEMO_TYPE_P(cc, imemo_callcache));
594 VM_ASSERT(cc != vm_cc_empty());
596 VM_ASSERT(cc->klass !=
Qundef || rb_multi_ractor_p());
599 RB_DEBUG_COUNTER_INC(cc_ent_invalidate);
620 unsigned short kw_len;
621 } entries[FLEX_ARY_LEN];
625STATIC_ASSERT(cc_entries_flag_fits_in_short, VM_CALL__END <= 16);
629#define VM_CALL_KW_LEN_MAX UINT16_MAX
632vm_ccs_alloc_size(
size_t capa)
639const rb_callable_method_entry_t *rb_vm_lookup_overloaded_cme(
const rb_callable_method_entry_t *cme);
640void rb_vm_dump_overloaded_cme_table(
void);
645 return ccs->debug_sig == ~(
VALUE)ccs;
649vm_cc_check_cme(
const struct rb_callcache *cc,
const rb_callable_method_entry_t *cme)
652 RB_VM_LOCKING_NO_BARRIER() {
653 valid = vm_cc_cme(cc) == cme ||
654 (cme->def->iseq_overload && vm_cc_cme(cc) == rb_vm_lookup_overloaded_cme(cme));
662 fprintf(stderr,
"iseq_overload:%d, cme:%p (def:%p), cm_cc_cme(cc):%p (def:%p)\n",
663 (
int)cme->def->iseq_overload,
665 vm_cc_cme(cc), vm_cc_cme(cc)->def);
668 rp(rb_vm_lookup_overloaded_cme(cme));
#define RUBY_ATOMIC_INC(var)
Atomically increments the value pointed by var.
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
#define RUBY_ATOMIC_FETCH_SUB(var, val)
Atomically replaces the value pointed by var with the result of subtraction of val to the old value o...
#define Qundef
Old name of RUBY_Qundef.
#define T_ICLASS
Old name of RUBY_T_ICLASS.
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
#define FL_ANY_RAW
Old name of RB_FL_ANY_RAW.
#define T_CLASS
Old name of RUBY_T_CLASS.
VALUE rb_eRuntimeError
RuntimeError exception.
int capa
Designed capacity of the buffer.
VALUE type(ANYARGS)
ANYARGS-ed function type.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
uintptr_t VALUE
Type that represents a Ruby object.
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.