Skip to content
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.

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

add InstructionTable struct #27

Merged
merged 9 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,5 @@ clap = { version = "4.3.10", features = ["derive"] }
stwo-prover = { git = "https://github.com/starkware-libs/stwo", rev = "f6214d1" }
tracing = "0.1"
tracing-subscriber = "0.3"
num-traits = "0.2.19"
thiserror = "2.0"
1 change: 1 addition & 0 deletions crates/brainfuck_prover/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ workspace = true

[dependencies]
stwo-prover.workspace = true
num-traits.workspace = true
1 change: 1 addition & 0 deletions crates/brainfuck_prover/src/components/instruction/mod.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pub mod table;
179 changes: 179 additions & 0 deletions crates/brainfuck_prover/src/components/instruction/table.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
use stwo_prover::core::fields::m31::BaseField;

/// Represents a single row in the Instruction Table.
///
/// The Instruction Table stores:
/// - The instruction pointer (`ip`),
/// - The current instruction (`ci`),
/// - The next instruction (`ni`).
#[derive(Debug, Default, PartialEq, Eq, Clone)]
pub struct InstructionTableRow {
/// Instruction pointer: points to the current instruction in the program.
pub ip: BaseField,
/// Current instruction: the instruction at the current instruction pointer.
pub ci: BaseField,
/// Next instruction:
/// - The instruction that follows `ci` in the program,
/// - 0 if out of bounds.
pub ni: BaseField,
}

/// Represents the Instruction Table, which holds the instruction sequence
/// for the Brainfuck virtual machine.
///
/// The Instruction Table is constructed by concatenating the program's list of
/// instructions with the execution trace, and then sorting by instruction
/// pointer and cycle. It is used to verify that the program being executed
/// matches the correct instruction sequence.
#[derive(Debug, Default, PartialEq, Eq, Clone)]
pub struct InstructionTable {
/// A vector of [`InstructionTableRow`] representing the table rows.
pub table: Vec<InstructionTableRow>,
}

impl InstructionTable {
/// Creates a new, empty [`InstructionTable`].
///
/// # Returns
/// A new instance of [`InstructionTable`] with an empty table.
pub const fn new() -> Self {
Self { table: Vec::new() }
}

/// Adds a new row to the Instruction Table from the provided registers.
///
/// # Arguments
/// * `ip` - The instruction pointer for the new row.
/// * `ci` - The current instruction for the new row.
/// * `ni` - The next instruction for the new row.
///
/// This method pushes a new [`InstructionTableRow`] onto the `table` vector.
pub fn add_row_from_registers(&mut self, ip: BaseField, ci: BaseField, ni: BaseField) {
self.table.push(InstructionTableRow { ip, ci, ni });
}

/// Adds a new row to the Instruction Table.
///
/// # Arguments
/// * `row` - The [`InstructionTableRow`] to add to the table.
///
/// This method pushes a new [`InstructionTableRow`] onto the `table` vector.
pub fn add_row(&mut self, row: InstructionTableRow) {
self.table.push(row);
}

/// Adds multiple rows to the Instruction Table.
///
/// # Arguments
/// * `rows` - A vector of [`InstructionTableRow`] to add to the table.
///
/// This method extends the `table` vector with the provided rows.
pub fn add_rows(&mut self, rows: Vec<InstructionTableRow>) {
self.table.extend(rows);
}

/// Retrieves a reference to a specific row in the Instruction Table.
///
/// # Arguments
/// * `row` - The [`InstructionTableRow`] to search for in the table.
///
/// # Returns
/// An `Option` containing a reference to the matching row if found,
/// or `None` if the row does not exist in the table.
pub fn get_row(&self, row: &InstructionTableRow) -> Option<&InstructionTableRow> {
self.table.iter().find(|r| *r == row)
}
}

#[cfg(test)]
mod tests {
use super::*;
use num_traits::Zero;

#[test]
fn test_instruction_table_new() {
let instruction_table = InstructionTable::new();
assert!(
instruction_table.table.is_empty(),
"Instruction table should be empty upon initialization."
);
}

#[test]
fn test_add_row() {
let mut instruction_table = InstructionTable::new();
// Create a row to add to the table
let row = InstructionTableRow {
ip: BaseField::zero(),
ci: BaseField::from(43),
ni: BaseField::from(91),
};
// Add the row to the table
instruction_table.add_row_from_registers(
BaseField::zero(),
BaseField::from(43),
BaseField::from(91),
);
// Check that the table contains the added row
assert_eq!(instruction_table.table, vec![row], "Added row should match the expected row.");
}

#[test]
fn test_add_multiple_rows() {
let mut instruction_table = InstructionTable::new();
// Create a vector of rows to add to the table
let rows = vec![
InstructionTableRow {
ip: BaseField::from(0),
ci: BaseField::from(43),
ni: BaseField::from(91),
},
InstructionTableRow {
ip: BaseField::from(1),
ci: BaseField::from(91),
ni: BaseField::from(9),
},
InstructionTableRow {
ip: BaseField::from(2),
ci: BaseField::from(62),
ni: BaseField::from(43),
},
];
// Add the rows to the table
instruction_table.add_rows(rows.clone());
// Check that the table contains the added rows
assert_eq!(instruction_table, InstructionTable { table: rows });
}

#[test]
fn test_get_existing_row() {
let mut instruction_table = InstructionTable::new();
// Create a row to add to the table
let row = InstructionTableRow {
ip: BaseField::from(0),
ci: BaseField::from(43),
ni: BaseField::from(91),
};
// Add the row to the table
instruction_table.add_row(row.clone());
// Retrieve the row from the table
let retrieved = instruction_table.get_row(&row);
// Check that the retrieved row matches the added row
assert_eq!(retrieved.unwrap(), &row, "Retrieved row should match the added row.");
}

#[test]
fn test_get_non_existing_row() {
let instruction_table = InstructionTable::new();
// Create a row to search for in the table
let row = InstructionTableRow {
ip: BaseField::from(0),
ci: BaseField::from(43),
ni: BaseField::from(91),
};
// Try to retrieve the non-existing row from the table
let retrieved = instruction_table.get_row(&row);
// Check that the retrieved row is None
assert!(retrieved.is_none(), "Should return None for a non-existing row.");
}
}
2 changes: 1 addition & 1 deletion crates/brainfuck_prover/src/components/mod.rs
Original file line number Diff line number Diff line change
@@ -1 +1 @@

pub mod instruction;
2 changes: 1 addition & 1 deletion crates/brainfuck_vm/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ workspace = true

[dependencies]
clap = { workspace = true, features = ["derive"] }
num-traits = "0.2.19"
num-traits.workspace = true
stwo-prover.workspace = true
tracing.workspace = true
tracing-subscriber = { workspace = true, features = ["env-filter"] }
Expand Down