Skip to content

refactor: update CallStack to store reference to VM #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 13, 2024
Merged

refactor: update CallStack to store reference to VM #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions ristretto_vm/src/call_stack.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,46 @@
use crate::arguments::Arguments;
use crate::Error::PoisonedLock;
use crate::Error::{PoisonedLock, RuntimeError};
use crate::{native_methods, Frame, Result, VM};
use ristretto_classloader::Error::MethodNotFound;
use ristretto_classloader::{Class, Method, Value};
use std::sync::{Arc, RwLock};
use std::sync::{Arc, RwLock, Weak};
use tracing::{debug, event_enabled, Level};

/// A call stack is a stack of frames that are executed in order.
#[derive(Debug, Default)]
pub struct CallStack {
pub(crate) vm: Weak<VM>,
pub(crate) frames: Arc<RwLock<Vec<Arc<RwLock<Frame>>>>>,
}

impl CallStack {
/// Create a new call stack.
#[must_use]
pub fn new() -> Self {
pub fn new(vm: &Weak<VM>) -> Self {
CallStack {
vm: vm.clone(),
frames: Arc::new(RwLock::new(Vec::new())),
}
}

/// Get the virtual machine that owns the call stack.
///
/// # Errors
/// if the virtual machine cannot be accessed.
pub fn vm(&self) -> Result<Arc<VM>> {
match self.vm.upgrade() {
Some(vm) => Ok(vm),
None => Err(RuntimeError("VM is not available".to_string())),

Check warning on line 33 in ristretto_vm/src/call_stack.rs

View check run for this annotation

Codecov / codecov/patch

ristretto_vm/src/call_stack.rs#L33 

Added line #L33 was not covered by tests
}
}

/// Add a new frame to the call stack and invoke the method. To invoke a method on an object
/// reference, the object reference must be the first argument in the arguments vector.
///
/// # Errors
/// if the method cannot be invoked.
pub fn execute(
&self,
vm: &VM,
class: &Arc<Class>,
method: &Arc<Method>,
arguments: Vec<Value>,
Expand All @@ -47,7 +59,7 @@

let (result, frame_added) = if let Some(rust_method) = rust_method {
let arguments = Arguments::new(arguments);
let result = rust_method(vm, self, arguments);
let result = rust_method(self, arguments);
(result, false)
} else if method.is_native() {
return Err(MethodNotFound {
Expand All @@ -71,7 +83,7 @@
let mut frame = frame
.write()
.map_err(|error| PoisonedLock(error.to_string()))?;
let result = frame.execute(vm, self);
let result = frame.execute(self);
(result, true)
};

Expand Down
65 changes: 28 additions & 37 deletions ristretto_vm/src/frame.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ use crate::instruction::{
ret, ret_w, saload, sastore, sipush, swap, tableswitch,
};
use crate::Error::{InvalidOperand, InvalidProgramCounter};
use crate::{CallStack, LocalVariables, OperandStack, Result, VM};
use crate::{CallStack, LocalVariables, OperandStack, Result};
use ristretto_classfile::attributes::Instruction;
use ristretto_classloader::{Class, Method, Value};
use std::sync::Arc;
Expand Down Expand Up @@ -72,7 +72,7 @@ impl Frame {
/// # Errors
/// * if the program counter is invalid
/// * if an invalid instruction is encountered
pub fn execute(&mut self, vm: &VM, call_stack: &CallStack) -> Result<Option<Value>> {
pub fn execute(&mut self, call_stack: &CallStack) -> Result<Option<Value>> {
// TODO: avoid cloning code
let code = self.method.code().clone();

Expand All @@ -85,7 +85,7 @@ impl Frame {
self.debug_execute(instruction)?;
}

let result = self.process(vm, call_stack, instruction);
let result = self.process(call_stack, instruction);
match result {
Ok(Continue) => self.program_counter += 1,
Ok(ContinueAtPosition(pc)) => self.program_counter = pc,
Expand Down Expand Up @@ -126,7 +126,6 @@ impl Frame {
#[expect(clippy::too_many_lines)]
fn process(
&mut self,
vm: &VM,
call_stack: &CallStack,
instruction: &Instruction,
) -> Result<ExecutionResult> {
Expand All @@ -149,8 +148,8 @@ impl Frame {
Instruction::Dconst_1 => dconst_1(&mut self.stack),
Instruction::Bipush(value) => bipush(&mut self.stack, *value),
Instruction::Sipush(value) => sipush(&mut self.stack, *value),
Instruction::Ldc(index) => ldc(vm, call_stack, self, *index),
Instruction::Ldc_w(index) => ldc_w(vm, call_stack, self, *index),
Instruction::Ldc(index) => ldc(call_stack, self, *index),
Instruction::Ldc_w(index) => ldc_w(call_stack, self, *index),
Instruction::Ldc2_w(index) => ldc2_w(self, *index),
Instruction::Iload(index) => iload(&self.locals, &mut self.stack, *index),
Instruction::Lload(index) => lload(&self.locals, &mut self.stack, *index),
Expand Down Expand Up @@ -324,14 +323,12 @@ impl Frame {
Instruction::Areturn => areturn(&mut self.stack),
Instruction::Return => Ok(Return(None)),
Instruction::Getstatic(index) => getstatic(
vm,
call_stack,
&mut self.stack,
self.class.constant_pool(),
*index,
),
Instruction::Putstatic(index) => putstatic(
vm,
call_stack,
&mut self.stack,
self.class.constant_pool(),
Expand All @@ -344,51 +341,45 @@ impl Frame {
putfield(&mut self.stack, self.class.constant_pool(), *index)
}
Instruction::Invokevirtual(index) => invokevirtual(
vm,
call_stack,
&mut self.stack,
self.class.constant_pool(),
*index,
),
Instruction::Invokespecial(index) => invokespecial(
vm,
call_stack,
&mut self.stack,
self.class.constant_pool(),
*index,
),
Instruction::Invokestatic(index) => invokestatic(
vm,
call_stack,
&mut self.stack,
self.class.constant_pool(),
*index,
),
Instruction::Invokeinterface(index, count) => invokeinterface(
vm,
call_stack,
&mut self.stack,
self.class.constant_pool(),
*index,
*count,
),
Instruction::Invokedynamic(index) => invokedynamic(
vm,
call_stack,
&mut self.stack,
self.class.constant_pool(),
*index,
),
Instruction::New(index) => new(
vm,
call_stack,
&mut self.stack,
self.class.constant_pool(),
*index,
),
Instruction::Newarray(array_type) => newarray(&mut self.stack, array_type),
Instruction::Anewarray(index) => {
anewarray(vm, call_stack, &mut self.stack, &self.class, *index)
anewarray(call_stack, &mut self.stack, &self.class, *index)
}
Instruction::Arraylength => arraylength(&mut self.stack),
Instruction::Athrow => todo!(),
Expand Down Expand Up @@ -419,7 +410,6 @@ impl Frame {
})
}
Instruction::Multianewarray(index, dimensions) => multianewarray(
vm,
call_stack,
&mut self.stack,
&self.class,
Expand Down Expand Up @@ -458,29 +448,30 @@ mod tests {
use super::*;
use crate::call_stack::CallStack;
use crate::configuration::ConfigurationBuilder;
use crate::VM;
use ristretto_classloader::ClassPath;
use std::path::PathBuf;

fn get_class(class_name: &str) -> Result<(VM, CallStack, Arc<Class>)> {
fn get_class(class_name: &str) -> Result<(CallStack, Arc<Class>)> {
let cargo_manifest = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
let classes_path = cargo_manifest.join("../classes");
let class_path = ClassPath::from(classes_path.to_string_lossy());
let configuration = ConfigurationBuilder::new()
.class_path(class_path.clone())
.build();
let vm = VM::new(configuration)?;
let call_stack = CallStack::new();
let call_stack = CallStack::new(&Arc::downgrade(&vm));
let class = vm.class(&call_stack, class_name)?;
Ok((vm, call_stack, class))
Ok((call_stack, class))
}

#[test]
fn test_execute() -> Result<()> {
let (vm, call_stack, class) = get_class("Expressions")?;
let (call_stack, class) = get_class("Expressions")?;
let method = class.method("add", "(II)I").expect("method not found");
let arguments = vec![Value::Int(1), Value::Int(2)];
let mut frame = Frame::new(&class, &method, arguments)?;
let result = frame.execute(&vm, &call_stack)?;
let result = frame.execute(&call_stack)?;
assert!(matches!(result, Some(Value::Int(3))));
Ok(())
}
Expand All @@ -495,8 +486,8 @@ mod tests {

#[test]
fn test_process_nop() -> Result<()> {
let (vm, call_stack, mut frame) = crate::test::frame()?;
let process_result = frame.process(&vm, &call_stack, &Instruction::Nop)?;
let (_vm, call_stack, mut frame) = crate::test::frame()?;
let process_result = frame.process(&call_stack, &Instruction::Nop)?;
assert_eq!(Continue, process_result);
assert!(frame.locals.is_empty());
assert!(frame.stack.is_empty());
Expand All @@ -505,8 +496,8 @@ mod tests {

#[test]
fn test_process_return() -> Result<()> {
let (vm, call_stack, mut frame) = crate::test::frame()?;
let process_result = frame.process(&vm, &call_stack, &Instruction::Return)?;
let (_vm, call_stack, mut frame) = crate::test::frame()?;
let process_result = frame.process(&call_stack, &Instruction::Return)?;
assert!(matches!(process_result, Return(None)));
Ok(())
}
Expand All @@ -518,27 +509,27 @@ mod tests {

#[test]
fn test_process_monitorenter() -> Result<()> {
let (vm, call_stack, mut frame) = crate::test::frame()?;
let (_vm, call_stack, mut frame) = crate::test::frame()?;
frame.stack.push_object(None)?;
let process_result = frame.process(&vm, &call_stack, &Instruction::Monitorenter)?;
let process_result = frame.process(&call_stack, &Instruction::Monitorenter)?;
assert_eq!(Continue, process_result);
Ok(())
}

#[test]
fn test_process_monitorexit() -> Result<()> {
let (vm, call_stack, mut frame) = crate::test::frame()?;
let (_vm, call_stack, mut frame) = crate::test::frame()?;
frame.stack.push_object(None)?;
let process_result = frame.process(&vm, &call_stack, &Instruction::Monitorexit)?;
let process_result = frame.process(&call_stack, &Instruction::Monitorexit)?;
assert_eq!(Continue, process_result);
Ok(())
}

#[test]
fn test_process_wide() -> Result<()> {
let (vm, call_stack, mut frame) = crate::test::frame()?;
let (_vm, call_stack, mut frame) = crate::test::frame()?;
assert!(matches!(
frame.process(&vm, &call_stack, &Instruction::Wide),
frame.process(&call_stack, &Instruction::Wide),
Err(InvalidOperand {
expected,
actual
Expand All @@ -549,8 +540,8 @@ mod tests {

#[test]
fn test_process_breakpoint() -> Result<()> {
let (vm, call_stack, mut frame) = crate::test::frame()?;
let process_result = frame.process(&vm, &call_stack, &Instruction::Breakpoint)?;
let (_vm, call_stack, mut frame) = crate::test::frame()?;
let process_result = frame.process(&call_stack, &Instruction::Breakpoint)?;
assert_eq!(Continue, process_result);
assert!(frame.locals.is_empty());
assert!(frame.stack.is_empty());
Expand All @@ -559,8 +550,8 @@ mod tests {

#[test]
fn test_process_impdep1() -> Result<()> {
let (vm, call_stack, mut frame) = crate::test::frame()?;
let process_result = frame.process(&vm, &call_stack, &Instruction::Impdep1)?;
let (_vm, call_stack, mut frame) = crate::test::frame()?;
let process_result = frame.process(&call_stack, &Instruction::Impdep1)?;
assert_eq!(Continue, process_result);
assert!(frame.locals.is_empty());
assert!(frame.stack.is_empty());
Expand All @@ -569,8 +560,8 @@ mod tests {

#[test]
fn test_process_impdep2() -> Result<()> {
let (vm, call_stack, mut frame) = crate::test::frame()?;
let process_result = frame.process(&vm, &call_stack, &Instruction::Impdep2)?;
let (_vm, call_stack, mut frame) = crate::test::frame()?;
let process_result = frame.process(&call_stack, &Instruction::Impdep2)?;
assert_eq!(Continue, process_result);
assert!(frame.locals.is_empty());
assert!(frame.stack.is_empty());
Expand Down
Loading