1
0
dust/dust-lang/src/vm.rs

788 lines
28 KiB
Rust

//! Virtual machine and errors
use std::{
cmp::Ordering,
fmt::{self, Display, Formatter},
io,
};
use crate::{
compile, AbstractValue, AnnotatedError, Chunk, ChunkError, ConcreteValue, DustError,
Instruction, NativeFunction, NativeFunctionError, Operation, Span, Value, ValueError, ValueRef,
};
pub fn run(source: &str) -> Result<Option<ConcreteValue>, DustError> {
let chunk = compile(source)?;
let mut vm = Vm::new(&chunk, None);
vm.run()
.map_err(|error| DustError::Runtime { error, source })
}
/// Dust virtual machine.
///
/// See the [module-level documentation](index.html) for more information.
#[derive(Debug)]
pub struct Vm<'a> {
chunk: &'a Chunk,
stack: Vec<Register>,
parent: Option<&'a Vm<'a>>,
local_definitions: Vec<Option<u16>>,
ip: usize,
last_assigned_register: Option<u16>,
current_position: Span,
}
impl<'a> Vm<'a> {
const STACK_LIMIT: usize = u16::MAX as usize;
pub fn new(chunk: &'a Chunk, parent: Option<&'a Vm<'a>>) -> Self {
Self {
chunk,
stack: Vec::new(),
parent,
local_definitions: vec![None; chunk.locals().len()],
ip: 0,
last_assigned_register: None,
current_position: Span(0, 0),
}
}
pub fn chunk(&self) -> &Chunk {
self.chunk
}
pub fn current_position(&self) -> Span {
self.current_position
}
pub fn run(&mut self) -> Result<Option<ConcreteValue>, VmError> {
while let Ok(instruction) = self.read() {
log::info!(
"{} | {} | {} | {}",
self.ip - 1,
self.current_position,
instruction.operation(),
instruction.disassembly_info()
);
match instruction.operation() {
Operation::Move => {
let to_register = instruction.a();
let from_register = instruction.b();
let from_register_has_value = self
.stack
.get(from_register as usize)
.is_some_and(|register| !matches!(register, Register::Empty));
let register = Register::Pointer(Pointer::Stack(from_register));
if from_register_has_value {
self.set_register(to_register, register)?;
}
}
Operation::Close => {
let from_register = instruction.b();
let to_register = instruction.c();
if self.stack.len() < to_register as usize {
return Err(VmError::StackUnderflow {
position: self.current_position,
});
}
for register_index in from_register..to_register {
self.stack[register_index as usize] = Register::Empty;
}
}
Operation::LoadBoolean => {
let to_register = instruction.a();
let boolean = instruction.b_as_boolean();
let jump = instruction.c_as_boolean();
let boolean = ConcreteValue::Boolean(boolean);
self.set_register(to_register, Register::ConcreteValue(boolean))?;
if jump {
self.ip += 1;
}
}
Operation::LoadConstant => {
let to_register = instruction.a();
let from_constant = instruction.b();
let jump = instruction.c_as_boolean();
self.set_register(
to_register,
Register::Pointer(Pointer::Constant(from_constant)),
)?;
if jump {
self.ip += 1
}
}
Operation::LoadList => {
let to_register = instruction.a();
let start_register = instruction.b();
let mut pointers = Vec::new();
for register_index in start_register..to_register {
if let Some(Register::Empty) = self.stack.get(register_index as usize) {
continue;
}
let pointer = Pointer::Stack(register_index);
pointers.push(pointer);
}
self.set_register(
to_register,
Register::AbstractValue(AbstractValue::List { items: pointers }),
)?;
}
Operation::LoadSelf => {
let to_register = instruction.a();
let register = Register::AbstractValue(AbstractValue::FunctionSelf);
self.set_register(to_register, register)?;
}
Operation::DefineLocal => {
let from_register = instruction.a();
let to_local = instruction.b();
self.local_definitions[to_local as usize] = Some(from_register);
}
Operation::GetLocal => {
let to_register = instruction.a();
let local_index = instruction.b();
let local_register = self.local_definitions[local_index as usize].ok_or(
VmError::UndefinedLocal {
local_index,
position: self.current_position,
},
)?;
let register = Register::Pointer(Pointer::Stack(local_register));
self.set_register(to_register, register)?;
}
Operation::SetLocal => {
let from_register = instruction.a();
let to_local = instruction.b();
self.local_definitions[to_local as usize] = Some(from_register);
}
Operation::Add => {
let to_register = instruction.a();
let (left, right) = self.get_arguments(instruction)?;
let sum = left.add(right).map_err(|error| VmError::Value {
error,
position: self.current_position,
})?;
self.set_register(to_register, Register::ConcreteValue(sum))?;
}
Operation::Subtract => {
let to_register = instruction.a();
let (left, right) = self.get_arguments(instruction)?;
let difference = left.subtract(right).map_err(|error| VmError::Value {
error,
position: self.current_position,
})?;
self.set_register(to_register, Register::ConcreteValue(difference))?;
}
Operation::Multiply => {
let to_register = instruction.a();
let (left, right) = self.get_arguments(instruction)?;
let product = left.multiply(right).map_err(|error| VmError::Value {
error,
position: self.current_position,
})?;
self.set_register(to_register, Register::ConcreteValue(product))?;
}
Operation::Divide => {
let to_register = instruction.a();
let (left, right) = self.get_arguments(instruction)?;
let quotient = left.divide(right).map_err(|error| VmError::Value {
error,
position: self.current_position,
})?;
self.set_register(to_register, Register::ConcreteValue(quotient))?;
}
Operation::Modulo => {
let to_register = instruction.a();
let (left, right) = self.get_arguments(instruction)?;
let remainder = left.modulo(right).map_err(|error| VmError::Value {
error,
position: self.current_position,
})?;
self.set_register(to_register, Register::ConcreteValue(remainder))?;
}
Operation::Test => {
let test_register = instruction.b();
let test_value = instruction.c_as_boolean();
let value = self.open_register(test_register)?;
let boolean = if let ValueRef::Concrete(ConcreteValue::Boolean(boolean)) = value
{
*boolean
} else {
return Err(VmError::ExpectedBoolean {
found: value.to_concrete_owned(self)?,
position: self.current_position,
});
};
if boolean == test_value {
self.ip += 1;
}
}
Operation::TestSet => {
let to_register = instruction.a();
let test_register = instruction.b();
let test_value = instruction.c_as_boolean();
let value = self.open_register(test_register)?;
let boolean = if let ValueRef::Concrete(ConcreteValue::Boolean(boolean)) = value
{
*boolean
} else {
return Err(VmError::ExpectedBoolean {
found: value.to_concrete_owned(self)?,
position: self.current_position,
});
};
if boolean == test_value {
self.ip += 1;
} else {
let register = Register::Pointer(Pointer::Stack(test_register));
self.set_register(to_register, register)?;
}
}
Operation::Equal => {
let compare_to = instruction.a_as_boolean();
let (left, right) = self.get_arguments(instruction)?;
let equal_result = left.equal(right).map_err(|error| VmError::Value {
error,
position: self.current_position,
})?;
let is_equal = if let ConcreteValue::Boolean(boolean) = equal_result {
boolean
} else {
return Err(VmError::ExpectedBoolean {
found: equal_result.clone(),
position: self.current_position,
});
};
if is_equal == compare_to {
self.ip += 1;
} else {
let jump = self.read()?;
self.jump(jump);
}
}
Operation::Less => {
let compare_to = instruction.a_as_boolean();
let (left, right) = self.get_arguments(instruction)?;
let less_result = left.less_than(right).map_err(|error| VmError::Value {
error,
position: self.current_position,
})?;
let is_less_than = if let ConcreteValue::Boolean(boolean) = less_result {
boolean
} else {
return Err(VmError::ExpectedBoolean {
found: less_result.clone(),
position: self.current_position,
});
};
if is_less_than == compare_to {
self.ip += 1;
} else {
let jump = self.read()?;
self.jump(jump);
}
}
Operation::LessEqual => {
let compare_to = instruction.a_as_boolean();
let (left, right) = self.get_arguments(instruction)?;
let less_or_equal_result =
left.less_than_or_equal(right)
.map_err(|error| VmError::Value {
error,
position: self.current_position,
})?;
let is_less_than_or_equal =
if let ConcreteValue::Boolean(boolean) = less_or_equal_result {
boolean
} else {
return Err(VmError::ExpectedBoolean {
found: less_or_equal_result.clone(),
position: self.current_position,
});
};
if is_less_than_or_equal == compare_to {
self.ip += 1;
} else {
let jump = self.read()?;
self.jump(jump);
}
}
Operation::Negate => {
let value = self.get_argument(instruction.b(), instruction.b_is_constant())?;
let negated = value.negate().map_err(|error| VmError::Value {
error,
position: self.current_position,
})?;
self.set_register(instruction.a(), Register::ConcreteValue(negated))?;
}
Operation::Not => {
let value = self.get_argument(instruction.b(), instruction.b_is_constant())?;
let not = value.not().map_err(|error| VmError::Value {
error,
position: self.current_position,
})?;
self.set_register(instruction.a(), Register::ConcreteValue(not))?;
}
Operation::Jump => self.jump(instruction),
Operation::Call => {
let to_register = instruction.a();
let function_register = instruction.b();
let argument_count = instruction.c();
let value = self.open_register(function_register)?;
let chunk = if let ValueRef::Concrete(ConcreteValue::Function(chunk)) = value {
chunk
} else if let ValueRef::Abstract(AbstractValue::FunctionSelf) = value {
self.chunk
} else {
return Err(VmError::ExpectedFunction {
found: value.to_concrete_owned(self)?,
position: self.current_position,
});
};
let mut function_vm = Vm::new(chunk, Some(self));
let first_argument_index = function_register + 1;
let last_argument_index = first_argument_index + argument_count;
for (argument_index, argument_register_index) in
(first_argument_index..last_argument_index).enumerate()
{
function_vm.set_register(
argument_index as u16,
Register::Pointer(Pointer::ParentStack(argument_register_index)),
)?
}
let return_value = function_vm.run()?;
if let Some(value) = return_value {
self.set_register(to_register, Register::ConcreteValue(value))?;
}
}
Operation::CallNative => {
let native_function = NativeFunction::from(instruction.b());
let return_value = native_function.call(self, instruction)?;
if let Some(value) = return_value {
let to_register = instruction.a();
let register = match value {
Value::Abstract(abstract_value) => {
Register::AbstractValue(abstract_value)
}
Value::Concrete(concrete_value) => {
Register::ConcreteValue(concrete_value)
}
};
self.set_register(to_register, register)?;
}
}
Operation::Return => {
let should_return_value = instruction.b_as_boolean();
if !should_return_value {
return Ok(None);
}
return if let Some(register_index) = self.last_assigned_register {
let return_value = self
.open_register(register_index)?
.to_concrete_owned(self)?;
Ok(Some(return_value))
} else {
Err(VmError::StackUnderflow {
position: self.current_position,
})
};
}
}
}
Ok(None)
}
pub(crate) fn follow_pointer(&self, pointer: Pointer) -> Result<ValueRef, VmError> {
match pointer {
Pointer::Stack(register_index) => self.open_register(register_index),
Pointer::Constant(constant_index) => {
let constant = self.get_constant(constant_index)?;
Ok(ValueRef::Concrete(constant))
}
Pointer::ParentStack(register_index) => {
let parent = self
.parent
.as_ref()
.ok_or_else(|| VmError::ExpectedParent {
position: self.current_position,
})?;
parent.open_register(register_index)
}
Pointer::ParentConstant(constant_index) => {
let parent = self
.parent
.as_ref()
.ok_or_else(|| VmError::ExpectedParent {
position: self.current_position,
})?;
let constant = parent.get_constant(constant_index)?;
Ok(ValueRef::Concrete(constant))
}
}
}
fn open_register(&self, register_index: u16) -> Result<ValueRef, VmError> {
let register_index = register_index as usize;
let register =
self.stack
.get(register_index)
.ok_or_else(|| VmError::RegisterIndexOutOfBounds {
index: register_index,
position: self.current_position,
})?;
log::trace!("Open R{register_index} to {register}");
match register {
Register::ConcreteValue(value) => Ok(ValueRef::Concrete(value)),
Register::Pointer(pointer) => self.follow_pointer(*pointer),
Register::AbstractValue(abstract_value) => Ok(ValueRef::Abstract(abstract_value)),
Register::Empty => Err(VmError::EmptyRegister {
index: register_index,
position: self.current_position,
}),
}
}
pub(crate) fn open_register_allow_empty(
&self,
register_index: u16,
) -> Result<Option<ValueRef>, VmError> {
let register_index = register_index as usize;
let register =
self.stack
.get(register_index)
.ok_or_else(|| VmError::RegisterIndexOutOfBounds {
index: register_index,
position: self.current_position,
})?;
log::trace!("Open R{register_index} to {register}");
match register {
Register::ConcreteValue(value) => Ok(Some(ValueRef::Concrete(value))),
Register::Pointer(pointer) => self.follow_pointer(*pointer).map(Some),
Register::AbstractValue(abstract_value) => Ok(Some(ValueRef::Abstract(abstract_value))),
Register::Empty => Ok(None),
}
}
/// DRY helper for handling JUMP instructions
fn jump(&mut self, jump: Instruction) {
let jump_distance = jump.b();
let is_positive = jump.c_as_boolean();
let new_ip = if is_positive {
self.ip + jump_distance as usize
} else {
self.ip - jump_distance as usize - 1
};
self.ip = new_ip;
}
/// DRY helper to get a constant or register values
fn get_argument(&self, index: u16, is_constant: bool) -> Result<&ConcreteValue, VmError> {
let argument = if is_constant {
self.get_constant(index)?
} else {
match self.open_register(index)? {
ValueRef::Concrete(concrete_value) => concrete_value,
ValueRef::Abstract(abstract_value) => {
return Err(VmError::ExpectedConcreteValue {
found: abstract_value.clone(),
position: self.current_position,
})
}
}
};
Ok(argument)
}
/// DRY helper to get two arguments for binary operations
fn get_arguments(
&self,
instruction: Instruction,
) -> Result<(&ConcreteValue, &ConcreteValue), VmError> {
let left = self.get_argument(instruction.b(), instruction.b_is_constant())?;
let right = self.get_argument(instruction.c(), instruction.c_is_constant())?;
Ok((left, right))
}
fn set_register(&mut self, to_register: u16, register: Register) -> Result<(), VmError> {
self.last_assigned_register = Some(to_register);
let length = self.stack.len();
let to_register = to_register as usize;
if length == Self::STACK_LIMIT {
return Err(VmError::StackOverflow {
position: self.current_position,
});
}
match to_register.cmp(&length) {
Ordering::Less => {
log::trace!("Change R{to_register} to {register}");
self.stack[to_register] = register;
Ok(())
}
Ordering::Equal => {
log::trace!("Set R{to_register} to {register}");
self.stack.push(register);
Ok(())
}
Ordering::Greater => {
let difference = to_register - length;
for index in 0..difference {
log::trace!("Set R{index} to {register}");
self.stack.push(Register::Empty);
}
log::trace!("Set R{to_register} to {register}");
self.stack.push(register);
Ok(())
}
}
}
fn get_constant(&self, index: u16) -> Result<&ConcreteValue, VmError> {
self.chunk
.get_constant(index)
.map_err(|error| VmError::Chunk {
error,
position: self.current_position,
})
}
fn read(&mut self) -> Result<Instruction, VmError> {
let (instruction, _type, position) =
self.chunk
.get_instruction(self.ip)
.map_err(|error| VmError::Chunk {
error,
position: self.current_position,
})?;
self.ip += 1;
self.current_position = *position;
Ok(*instruction)
}
}
#[derive(Clone, Debug, PartialEq)]
pub enum Register {
Empty,
ConcreteValue(ConcreteValue),
AbstractValue(AbstractValue),
Pointer(Pointer),
}
impl Display for Register {
fn fmt(&self, f: &mut Formatter) -> fmt::Result {
match self {
Self::Empty => write!(f, "empty"),
Self::ConcreteValue(value) => write!(f, "{}", value),
Self::Pointer(pointer) => write!(f, "{}", pointer),
Self::AbstractValue(value) => write!(f, "{}", value),
}
}
}
#[derive(Clone, Copy, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub enum Pointer {
Stack(u16),
Constant(u16),
ParentStack(u16),
ParentConstant(u16),
}
impl Display for Pointer {
fn fmt(&self, f: &mut Formatter) -> fmt::Result {
match self {
Self::Stack(index) => write!(f, "R{}", index),
Self::Constant(index) => write!(f, "C{}", index),
Self::ParentStack(index) => write!(f, "PR{}", index),
Self::ParentConstant(index) => write!(f, "PC{}", index),
}
}
}
#[derive(Clone, Debug, PartialEq)]
pub enum VmError {
// Stack errors
StackOverflow {
position: Span,
},
StackUnderflow {
position: Span,
},
// Register errors
EmptyRegister {
index: usize,
position: Span,
},
ExpectedConcreteValue {
found: AbstractValue,
position: Span,
},
ExpectedValue {
found: Register,
position: Span,
},
RegisterIndexOutOfBounds {
index: usize,
position: Span,
},
// Local errors
UndefinedLocal {
local_index: u16,
position: Span,
},
// Execution errors
ExpectedBoolean {
found: ConcreteValue,
position: Span,
},
ExpectedFunction {
found: ConcreteValue,
position: Span,
},
ExpectedParent {
position: Span,
},
ValueDisplay {
error: io::ErrorKind,
position: Span,
},
// Wrappers for foreign errors
Chunk {
error: ChunkError,
position: Span,
},
NativeFunction(NativeFunctionError),
Value {
error: ValueError,
position: Span,
},
}
impl AnnotatedError for VmError {
fn title() -> &'static str {
"Runtime Error"
}
fn description(&self) -> &'static str {
match self {
Self::Chunk { .. } => "Chunk error",
Self::EmptyRegister { .. } => "Empty register",
Self::ExpectedBoolean { .. } => "Expected boolean",
Self::ExpectedConcreteValue { .. } => "Expected concrete value",
Self::ExpectedFunction { .. } => "Expected function",
Self::ExpectedParent { .. } => "Expected parent",
Self::ExpectedValue { .. } => "Expected value",
Self::NativeFunction(error) => error.description(),
Self::RegisterIndexOutOfBounds { .. } => "Register index out of bounds",
Self::StackOverflow { .. } => "Stack overflow",
Self::StackUnderflow { .. } => "Stack underflow",
Self::UndefinedLocal { .. } => "Undefined local",
Self::Value { .. } => "Value error",
Self::ValueDisplay { .. } => "Value display error",
}
}
fn details(&self) -> Option<String> {
match self {
Self::Chunk { error, .. } => Some(error.to_string()),
Self::EmptyRegister { index, .. } => Some(format!("Register R{index} is empty")),
Self::ExpectedFunction { found, .. } => Some(format!("{found} is not a function")),
Self::RegisterIndexOutOfBounds { index, .. } => {
Some(format!("Register {index} does not exist"))
}
Self::NativeFunction(error) => error.details(),
Self::Value { error, .. } => Some(error.to_string()),
Self::ValueDisplay { error, .. } => Some(error.to_string() + " while displaying value"),
_ => None,
}
}
fn position(&self) -> Span {
match self {
Self::Chunk { position, .. } => *position,
Self::EmptyRegister { position, .. } => *position,
Self::ExpectedBoolean { position, .. } => *position,
Self::ExpectedConcreteValue { position, .. } => *position,
Self::ExpectedFunction { position, .. } => *position,
Self::ExpectedParent { position } => *position,
Self::ExpectedValue { position, .. } => *position,
Self::NativeFunction(error) => error.position(),
Self::RegisterIndexOutOfBounds { position, .. } => *position,
Self::StackOverflow { position } => *position,
Self::StackUnderflow { position } => *position,
Self::UndefinedLocal { position, .. } => *position,
Self::Value { position, .. } => *position,
Self::ValueDisplay { position, .. } => *position,
}
}
}