/* Creates a frame that is suitable for deserializing a context into. Does not
* try to use the frame pool, since we'll typically never recycle these. */
MVMFrame * MVM_frame_create_context_only(MVMThreadContext *tc, MVMStaticFrame *static_frame,
MVMObject *code_ref) {
MVMFrame *frame;
/* If the frame was never invoked before, need initial calculations
* and verification. */
if (!static_frame->body.invoked)
prepare_and_verify_static_frame(tc, static_frame);
frame = malloc(sizeof(MVMFrame));
memset(frame, 0, sizeof(MVMFrame));
/* Copy thread context into the frame. */
frame->tc = tc;
/* Set static frame. */
frame->static_info = static_frame;
/* Store the code ref. */
frame->code_ref = code_ref;
/* Allocate space for lexicals, copying the default lexical environment
* into place. */
if (static_frame->body.env_size) {
frame->env = malloc(static_frame->body.env_size);
memcpy(frame->env, static_frame->body.static_env, static_frame->body.env_size);
}
/* Initial reference count is 0 (will become referenced by being set as
* an outer context). So just return it now. */
return frame;
}
/* Takes a static frame and a thread context. Invokes the static frame. */
void MVM_frame_invoke(MVMThreadContext *tc, MVMStaticFrame *static_frame,
MVMCallsite *callsite, MVMRegister *args,
MVMFrame *outer, MVMObject *code_ref) {
MVMFrame *frame;
MVMuint32 pool_index;
MVMFrame *node;
int fresh = 0;
MVMStaticFrameBody *static_frame_body = &static_frame->body;
/* If the frame was never invoked before, need initial calculations
* and verification. */
if (!static_frame_body->invoked)
prepare_and_verify_static_frame(tc, static_frame);
pool_index = static_frame_body->pool_index;
node = tc->frame_pool_table[pool_index];
if (node == NULL) {
fresh = 1;
frame = malloc(sizeof(MVMFrame));
frame->params.named_used = NULL;
/* Ensure special return pointer is null. */
frame->special_return = NULL;
}
else {
tc->frame_pool_table[pool_index] = node->outer;
node->outer = NULL;
frame = node;
}
/* Copy thread context (back?) into the frame. */
frame->tc = tc;
/* Set static frame. */
frame->static_info = static_frame;
/* Store the code ref (NULL at the top-level). */
frame->code_ref = code_ref;
/* Allocate space for lexicals and work area, copying the default lexical
* environment into place. */
if (static_frame_body->env_size) {
if (fresh)
frame->env = malloc(static_frame_body->env_size);
memcpy(frame->env, static_frame_body->static_env, static_frame_body->env_size);
}
else {
frame->env = NULL;
}
if (static_frame_body->work_size) {
if (fresh)
frame->work = malloc(static_frame_body->work_size);
memset(frame->work, 0, static_frame_body->work_size);
}
else {
frame->work = NULL;
}
/* Calculate args buffer position. */
frame->args = static_frame_body->work_size ?
frame->work + static_frame_body->num_locals :
NULL;
/* Outer. */
if (outer) {
/* We were provided with an outer frame; just ensure that it is
* based on the correct static frame. */
// if (outer->static_info == static_frame_body->outer)
frame->outer = outer;
// else
// MVM_exception_throw_adhoc(tc,
// "Provided outer frame %p (%s %s) does not match expected static frame type %p (%s %s)",
// outer->static_info,
// MVM_string_utf8_encode_C_string(tc, MVM_repr_get_by_id(tc, REPR(outer->static_info)->ID)->name),
// outer->static_info->body.name ? MVM_string_utf8_encode_C_string(tc, outer->static_info->body.name) : "<anonymous static frame>",
// static_frame_body->outer,
// MVM_string_utf8_encode_C_string(tc, MVM_repr_get_by_id(tc, REPR(static_frame_body->outer)->ID)->name),
// static_frame_body->outer->body.name ? MVM_string_utf8_encode_C_string(tc, static_frame_body->outer->body.name) : "<anonymous static frame>");
}
else if (static_frame_body->outer) {
/* We need an outer, but none was provided by a closure. See if
* we can find an appropriate frame on the current call stack. */
MVMFrame *candidate = tc->cur_frame;
frame->outer = NULL;
while (candidate) {
if (candidate->static_info == static_frame_body->outer) {
frame->outer = candidate;
break;
}
candidate = candidate->caller;
}
if (!frame->outer) {
frame->outer = static_frame_body->outer->body.prior_invocation;
if (!frame->outer)
MVM_exception_throw_adhoc(tc,
"Cannot locate an outer frame for the call");
}
}
else {
frame->outer = NULL;
}
if (frame->outer)
MVM_frame_inc_ref(tc, frame->outer);
/* Caller is current frame in the thread context. */
if (tc->cur_frame)
frame->caller = MVM_frame_inc_ref(tc, tc->cur_frame);
else
frame->caller = NULL;
/* Initial reference count is 1 by virtue of it being the currently
* executing frame. */
frame->ref_count = 1;
frame->gc_seq_number = 0;
/* Initialize argument processing. */
MVM_args_proc_init(tc, &frame->params, callsite, args);
/* Update interpreter and thread context, so next execution will use this
* frame. */
tc->cur_frame = frame;
*(tc->interp_cur_op) = static_frame_body->bytecode;
*(tc->interp_bytecode_start) = static_frame_body->bytecode;
*(tc->interp_reg_base) = frame->work;
*(tc->interp_cu) = static_frame_body->cu;
}
/* Takes a static frame and a thread context. Invokes the static frame. */
void MVM_frame_invoke(MVMThreadContext *tc, MVMStaticFrame *static_frame,
MVMCallsite *callsite, MVMRegister *args,
MVMFrame *outer, MVMObject *code_ref) {
MVMFrame *frame;
MVMuint32 pool_index, found_spesh;
MVMFrame *node;
int fresh = 0;
MVMStaticFrameBody *static_frame_body = &static_frame->body;
/* If the frame was never invoked before, need initial calculations
* and verification. */
if (!static_frame_body->invoked)
prepare_and_verify_static_frame(tc, static_frame);
/* Get frame body from the re-use pool, or allocate it. */
pool_index = static_frame_body->pool_index;
if (pool_index >= tc->frame_pool_table_size)
grow_frame_pool(tc, pool_index);
node = tc->frame_pool_table[pool_index];
if (node == NULL) {
fresh = 1;
frame = malloc(sizeof(MVMFrame));
frame->params.named_used = NULL;
/* Ensure special return pointers and continuation tags are null. */
frame->special_return = NULL;
frame->special_unwind = NULL;
frame->continuation_tags = NULL;
}
else {
tc->frame_pool_table[pool_index] = node->outer;
node->outer = NULL;
frame = node;
}
#if MVM_HLL_PROFILE_CALLS
frame->profile_index = tc->profile_index;
tc->profile_data[frame->profile_index].duration_nanos = MVM_platform_now();
tc->profile_data[frame->profile_index].callsite_id = 0; /* XXX get a real callsite id */
tc->profile_data[frame->profile_index].code_id = 0; /* XXX get a real code id */
/* increment the profile data index */
++tc->profile_index;
if (tc->profile_index == tc->profile_data_size) {
tc->profile_data_size *= 2;
tc->profile_data = realloc(tc->profile_data, tc->profile_data_size);
}
#endif
/* Copy thread context (back?) into the frame. */
frame->tc = tc;
/* Set static frame. */
frame->static_info = static_frame;
/* Store the code ref (NULL at the top-level). */
frame->code_ref = code_ref;
/* Allocate space for lexicals and work area, copying the default lexical
* environment into place. */
if (static_frame_body->env_size) {
if (fresh)
frame->env = malloc(static_frame_body->env_size);
memcpy(frame->env, static_frame_body->static_env, static_frame_body->env_size);
}
else {
frame->env = NULL;
}
if (static_frame_body->work_size) {
if (fresh || !frame->work)
frame->work = malloc(static_frame_body->work_size);
memset(frame->work, 0, static_frame_body->work_size);
}
else {
frame->work = NULL;
}
/* Calculate args buffer position and make sure current call site starts
* empty. */
frame->args = static_frame_body->work_size ?
frame->work + static_frame_body->num_locals :
NULL;
frame->cur_args_callsite = NULL;
/* Outer. */
if (outer) {
/* We were provided with an outer frame; just ensure that it is
* based on the correct static frame (compare on bytecode address
* to come with nqp::freshcoderef). */
if (outer->static_info->body.bytecode == static_frame_body->outer->body.bytecode)
frame->outer = outer;
else
MVM_exception_throw_adhoc(tc,
"When invoking %s, Provided outer frame %p (%s %s) does not match expected static frame type %p (%s %s)",
static_frame_body->name ? MVM_string_utf8_encode_C_string(tc, static_frame_body->name) : "<anonymous static frame>",
outer->static_info,
MVM_repr_get_by_id(tc, REPR(outer->static_info)->ID)->name,
outer->static_info->body.name ? MVM_string_utf8_encode_C_string(tc, outer->static_info->body.name) : "<anonymous static frame>",
static_frame_body->outer,
MVM_repr_get_by_id(tc, REPR(static_frame_body->outer)->ID)->name,
static_frame_body->outer->body.name ? MVM_string_utf8_encode_C_string(tc, static_frame_body->outer->body.name) : "<anonymous static frame>");
}
else if (static_frame_body->static_code && static_frame_body->static_code->body.outer) {
/* We're lacking an outer, but our static code object may have one.
* This comes up in the case of cloned protoregexes, for example. */
frame->outer = static_frame_body->static_code->body.outer;
}
else if (static_frame_body->outer) {
/* Auto-close, and cache it in the static frame. */
frame->outer = autoclose(tc, static_frame_body->outer);
static_frame_body->static_code->body.outer = MVM_frame_inc_ref(tc, frame->outer);
}
else {
frame->outer = NULL;
}
if (frame->outer)
MVM_frame_inc_ref(tc, frame->outer);
/* Caller is current frame in the thread context. */
if (tc->cur_frame)
frame->caller = MVM_frame_inc_ref(tc, tc->cur_frame);
else
frame->caller = NULL;
frame->keep_caller = 0;
frame->in_continuation = 0;
/* Initial reference count is 1 by virtue of it being the currently
* executing frame. */
MVM_store(&frame->ref_count, 1);
MVM_store(&frame->gc_seq_number, 0);
/* Initialize argument processing. */
MVM_args_proc_init(tc, &frame->params, callsite, args);
/* Make sure there's no frame context pointer and special return data
* won't be marked. */
frame->context_object = NULL;
frame->mark_special_return_data = NULL;
/* Clear frame flags. */
frame->flags = 0;
/* See if any specializations apply. */
found_spesh = 0;
if (++static_frame_body->invocations >= 10 && callsite->is_interned) {
/* Look for specialized bytecode. */
MVMint32 num_spesh = static_frame_body->num_spesh_candidates;
MVMint32 i, j;
for (i = 0; i < num_spesh; i++) {
MVMSpeshCandidate *cand = &static_frame_body->spesh_candidates[i];
if (cand->cs == callsite) {
MVMint32 match = 1;
for (j = 0; j < cand->num_guards; j++) {
MVMint32 pos = cand->guards[j].slot;
MVMSTable *st = (MVMSTable *)cand->guards[j].match;
MVMObject *arg = args[pos].o;
if (!arg) {
match = 0;
break;
}
switch (cand->guards[j].kind) {
case MVM_SPESH_GUARD_CONC:
if (!IS_CONCRETE(arg) || STABLE(arg) != st)
match = 0;
break;
case MVM_SPESH_GUARD_TYPE:
if (IS_CONCRETE(arg) || STABLE(arg) != st)
match = 0;
break;
case MVM_SPESH_GUARD_DC_CONC: {
MVMRegister dc;
STABLE(arg)->container_spec->fetch(tc, arg, &dc);
if (!dc.o || !IS_CONCRETE(dc.o) || STABLE(dc.o) != st)
match = 0;
break;
}
case MVM_SPESH_GUARD_DC_TYPE: {
MVMRegister dc;
STABLE(arg)->container_spec->fetch(tc, arg, &dc);
if (!dc.o || IS_CONCRETE(dc.o) || STABLE(dc.o) != st)
match = 0;
break;
}
}
if (!match)
break;
}
if (match) {
frame->effective_bytecode = cand->bytecode;
frame->effective_handlers = cand->handlers;
frame->effective_spesh_slots = cand->spesh_slots;
frame->spesh_cand = cand;
found_spesh = 1;
break;
}
}
}
/* If we didn't find any, and we're below the limit, can generate a
* specialization. */
if (!found_spesh && num_spesh < MVM_SPESH_LIMIT && tc->instance->spesh_enabled) {
MVMSpeshCandidate *cand = MVM_spesh_candidate_generate(tc, static_frame,
callsite, args);
if (cand) {
frame->effective_bytecode = cand->bytecode;
frame->effective_handlers = cand->handlers;
frame->effective_spesh_slots = cand->spesh_slots;
frame->spesh_cand = cand;
found_spesh = 1;
}
}
}
if (!found_spesh) {
frame->effective_bytecode = static_frame_body->bytecode;
frame->effective_handlers = static_frame_body->handlers;
frame->spesh_cand = NULL;
}
/* Update interpreter and thread context, so next execution will use this
* frame. */
tc->cur_frame = frame;
*(tc->interp_cur_op) = frame->effective_bytecode;
*(tc->interp_bytecode_start) = frame->effective_bytecode;
*(tc->interp_reg_base) = frame->work;
*(tc->interp_cu) = static_frame_body->cu;
/* If we need to do so, make clones of things in the lexical environment
* that need it. Note that we do this after tc->cur_frame became the
* current frame, to make sure these new objects will certainly get
* marked if GC is triggered along the way. */
if (static_frame_body->static_env_flags) {
/* Drag everything out of static_frame_body before we start,
* as GC action may invalidate it. */
MVMuint8 *flags = static_frame_body->static_env_flags;
MVMint64 numlex = static_frame_body->num_lexicals;
MVMRegister *state = NULL;
MVMint64 state_act = 0; /* 0 = none so far, 1 = first time, 2 = later */
MVMint64 i;
for (i = 0; i < numlex; i++) {
switch (flags[i]) {
case 0: break;
case 1:
frame->env[i].o = MVM_repr_clone(tc, frame->env[i].o);
break;
case 2:
redo_state:
switch (state_act) {
case 0:
if (!frame->code_ref)
MVM_exception_throw_adhoc(tc,
"Frame must have code-ref to have state variables");
state = ((MVMCode *)frame->code_ref)->body.state_vars;
if (state) {
/* Already have state vars; pull them from this. */
state_act = 2;
}
else {
/* Allocate storage for state vars. */
state = malloc(frame->static_info->body.env_size);
memset(state, 0, frame->static_info->body.env_size);
((MVMCode *)frame->code_ref)->body.state_vars = state;
state_act = 1;
/* Note that this frame should run state init code. */
frame->flags |= MVM_FRAME_FLAG_STATE_INIT;
}
goto redo_state;
case 1:
frame->env[i].o = MVM_repr_clone(tc, frame->env[i].o);
MVM_ASSIGN_REF(tc, &(frame->code_ref->header), state[i].o, frame->env[i].o);
break;
case 2:
frame->env[i].o = state[i].o;
break;
}
break;
default:
MVM_exception_throw_adhoc(tc,
"Unknown lexical environment setup flag");
}
}
}
}
