frame.go

package lua

import "github.com/Azure/golua/lua/vm"

type callStatus uint

const (
	callStatusAllowHook = 1 << iota // original value of 'allowhook'
	// callStatusLua                    // call is running a Lua function
	// callStatusHooked                 // call is running a debug hook
	// callStatusFresh                  // call is running on a fresh invocation of exec
	// callStatusYieldPCall             // call is yieldable protected call
	callStatusTail // call was tail called
	// callStatusHookYield              // last hook called yielded
	// callStatusLEQ                    // using __lt for __le
	// callStatusFinalizer              // call is running a finalizer
)

type (
	// CallInfo holds information about a call.
	CallInfo struct {
		// prev, next *CallInfo // dynamic call link to caller and callee
		// savedpc    int       // saved pc; return address (lua only)
		// status     int       // call status indicating success or failure
		// funcID     int       // function index in the stack
		// nrets      int       // expected number of results
		// top        int       // stack top for this function
		// frame      *Frame    // call frame
	}

	// Frame is the context to execute a function closure.
	Frame struct {
		prev, next *Frame           // dynamic link caller and callee frame
		closure    *Closure         // frame closure
		vararg     []Value          // variable arguments
		locals     []Value          // frame stack locals
		state      *State           // thread state
		depth      int              // call frame ID
		fnID       int              // function index
		rets       int              // # expected returns
		pc         int              // last executed instruction pc
		up         map[int]*upValue // map of open upvalues
		status     callStatus       // callinfo status
	}
)

// checkstack checks that there atleast needed slots available.
func (fr *Frame) checkstack(needed int) bool {
	if space := cap(fr.locals) - fr.gettop(); space < needed {
		fr.extend(needed - space)
	}
	return true
}

// extend grows the frame's locals stack by grow.
func (fr *Frame) extend(grow int) {
	fr.locals = append(
		fr.locals,
		make([]Value, grow, grow)...,
	)[:len(fr.locals)]
}

// absindex converts the acceptable index into an equivalent
// absolute index; that is, one that does not depend on the
// stack top).
func (fr *Frame) absindex(index int) int {
	// zero, positive, or pseudo index
	if index > 0 || isPseudoIndex(index) {
		return index
	}
	// negative
	return fr.gettop() + index + 1
}

// settop sets the locals stack top to top if valid, removing or adding
// elements to adjust the stack.
func (fr *Frame) settop(top int) {
	// if top = fr.absindex(top); top < 0 {
	//     panic(runtimeErr(fmt.Errorf("stack underflow!")))
	// }
	switch diff := fr.gettop() - top; {
	case diff >= 0: // new top < old top
		for i := 0; i < diff; i++ {
			fr.pop()
		}
	case diff < 0: // new top > old top
		for i := 0; i > diff; i-- {
			fr.push(None)
		}
	}
}

// Reverse reverses the frame's locals stack starting from the src to dst indices.
func (fr *Frame) reverse(src, dst int) {
	for locals := fr.locals; src < dst; {
		locals[src], locals[dst] = locals[dst], locals[src]
		src++
		dst--
	}
}

// function returns the frame closure.
func (fr *Frame) function() *Closure {
	if fr != nil && fr.closure != nil {
		return fr.closure
	}
	return nil
}

// replace moves the top element into the given valid index without shifting
// any element (therefore replacing the value at that given index), and then
// pops the top element.
//
// See https://www.lua.org/manual/5.3/manual.html#lua_replace
func (fr *Frame) replace(index int) {
	if v := fr.pop(); fr.gettop() == 0 {
		fr.push(v)
	} else {
		fr.set(index, v)
	}
}

// rotate rotates the stack elements between the valid index and the top of the stack.
//
// The elements are rotated n positions in the direction of the top, if positive;
// otherwise -n positions in the direction of the bottom, if negative.
//
// The absolute value of n must not be greater than the size of the slice being rotated.
//
// This function cannot be called with a pseudo-index, because a pseudo-index is not an
// actual stack position.
//
// Let x = AB, where A is a prefix of length 'n'.
// Then, rotate x n == BA. But BA == (A^r . B^r)^r
//
// See https://www.lua.org/manual/5.3/manual.html#lua_rotate
func (fr *Frame) rotate(index, n int) {
	var (
		abs = fr.absindex(index) - 1 // start of stack segment
		top = fr.gettop() - 1        // top of stack segment
		mid int
	)
	if n >= 0 {
		mid = top - n
	} else {
		mid = abs - n - 1
	}
	fr.reverse(abs, mid)   // reverse prefix with length n
	fr.reverse(mid+1, top) // reverse suffix
	fr.reverse(abs, top)   // reverse segment
}

// Remove removes the element at the given valid index, shifting down the elements
// above this index to fill the gap.
//
// This function cannot be called with a pseudo-index, because a pseudo-index
// is not an actual stack position.
//
// See https://www.lua.org/manual/5.3/manual.html#lua_remove
func (fr *Frame) remove(index int) {
	fr.rotate(fr.absindex(index), -1)
	fr.pop()
}

// Insert moves the top element into the given valid index, shifting up the
// elements above this index to open space.
//
// This function cannot be called with a pseudo-index, because a pseudo-index
// is not an actual stack position.
func (fr *Frame) insert(index int) { fr.rotate(index, 1) }

// caller returns the frame's caller frame.
func (fr *Frame) caller() *Frame {
	if fp := fr.prev; fr.state != nil && fp != &fr.state.base {
		return fp
	}
	return nil
}

// callee returns the frame's callee frame (if any).
func (fr *Frame) callee() *Frame {
	if fp := fr.next; fr.state != nil && fp != &fr.state.base {
		return fp
	}
	return nil
}

// varargs returns the values in vararg upto n; if n == 0, then
// then varargs returns all values in the expression.
func (fr *Frame) varargs(n int) []Value {
	// n > len(fr.vararg)
	// n < len(fr.vararg)
	if n <= 0 {
		return fr.vararg
	}
	va := make([]Value, n)
	for i := 0; i < min(len(fr.vararg), n); i++ {
		va[i] = fr.vararg[i]
	}
	return va
}

// upvalue returns the upvalue at index.
func (fr *Frame) getUp(index int) *upValue { return fr.closure.getUp(index) }

// setupval set the upvalue at index to value
func (fr *Frame) setUp(index int, value Value) { fr.closure.setUp(index, value) }

// openUp opens the upvalues for the closure.
func (fr *Frame) openUp(cls *Closure) {
	if cls.isLua() {
		for i, up := range cls.binary.UpValues {
			fr.state.Logf("open up (%d) @ %d (local = %t)", i, up.AtIndex(), up.IsLocal())

			if up.IsLocal() { // upvalue is local?
				cls.upvals[i] = fr.findUp(up.AtIndex())
			} else { // otherwise upvalue is in enclosing function.
				cls.upvals[i] = fr.closure.upvals[up.AtIndex()]
			}
		}
	}
}

// findupval searches for the upvalue (open or closed) in the
// frame's locals stack.
func (fr *Frame) findUp(index int) *upValue {
	if fr.up == nil {
		fr.up = make(map[int]*upValue)
	}
	if up, open := fr.up[index]; open {
		return up
	}
	up := &upValue{frame: fr, index: index}
	fr.up[index] = up
	return up
}

// closeUp closes upvalues below the index upto.
func (fr *Frame) closeUp(upto int) {
	for i, up := range fr.up {
		delete(fr.up, i)
		up.close()
	}
}

// gettop returns the index of the top element in the stack.
//
// Because indices start at 1, this result is equal to the
// number of elements in the stack; in particular, 0 means
// an empty stack.
func (fr *Frame) gettop() int { return len(fr.locals) }

// local returns the n'th local in the frame's stack.
//
// TODO: bounds check
func (fr *Frame) local(index int) Value {
	if index = fr.absindex(index); fr.instack(index) {
		return fr.locals[index-1]
	}
	return None
}

// pushN pushes N values onto the frame's stack.
//
// TODO: ensure stack
func (fr *Frame) pushN(vs []Value) {
	// fmt.Printf("frame #%d: push %v\n", fr.depth, vs)
	for _, v := range vs {
		fr.push(v)
	}
}

// Copy copies the element at index src into the valid index dst,
// replacing the value at that position.
//
// Values at other positions are not affected.
//
// TODO: bounds check
func (fr *Frame) copy(src, dst int) { fr.set(src, fr.get(dst)) }

// push pushes 1 values onto the frame's stack.
//
// TODO: ensure stack
func (fr *Frame) push(v Value) {
	fr.locals = append(fr.locals, v)
}

// pop pops 1 value from the frame's stack.
//
// TODO: ensure stack
func (fr *Frame) pop() Value {
	if fr.gettop() == 0 {
		return None
	}
	top := fr.gettop() - 1
	val := fr.locals[top]
	fr.locals = fr.locals[:top]
	return val
}

// popN pops N values from the frame's stack.
//
// TODO: ensure stack
func (fr *Frame) popN(n int) (vs []Value) {
	if n > 0 {
		vs = make([]Value, n)
		for i := n - 1; i >= 0; i-- {
			vs[i] = fr.pop()
		}
	}
	return vs
}

// step returns the next instruction for the frame's
// current instruction pointer and increments by n.
//
// TODO: bounds check
func (fr *Frame) step(n int) vm.Instr {
	i := vm.Instr(fr.closure.binary.Code[fr.pc])
	fr.pc += n
	return i
}

// code returns the instruction for pc.
//
// TODO: bounds check
func (fr *Frame) code(pc int) vm.Instr {
	return vm.Instr(fr.closure.binary.Code[pc])
}

// set sets the frame local value at index to value.
//
// TODO: pseudo & upvalue indices.
// TODO: bounds and stack check.
func (fr *Frame) set(index int, value Value) {
	if fr.gettop() == 0 || fr.gettop() == index {
		fr.push(value)
		return
	}
	fr.locals[index] = value
}

// get returns the value located in the frame's locals
// stack, or at pseudo- & upvalue- index.
//
// TODO: pseudo & upvalue indices.
// TODO: bounds and stack check.
func (fr *Frame) get(index int) Value {
	if index >= 0 && index < len(fr.locals) {
		return fr.locals[index]
	}
	return None
}

// instack reports whether index is in the frame's locals stack.
func (fr *Frame) instack(index int) bool {
	return index > 0 && index <= fr.gettop()
}