Skip to content

Add export preprocessed roots dev util. #1420

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

Open
gilbens-starkware wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add export preprocessed roots dev util. #1420

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
1 change: 1 addition & 0 deletions stwo_cairo_prover/Cargo.lock
View file
Open in desktop

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

4 changes: 4 additions & 0 deletions stwo_cairo_prover/crates/dev_utils/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ edition.workspace = true
name = "extract_mem_trace"
required-features = ["stwo-cairo-adapter/extract-mem-trace"]

[[bin]]
name = "export_preprocessed_roots"

[dependencies]
anyhow.workspace = true
cairo-air.workspace = true
Expand All @@ -25,6 +28,7 @@ log.workspace = true
regex = "1.11.1"
num-bigint = "0.4.6"
bincode = "1.3.3"
itertools.workspace = true

serde_json.workspace = true
cairo-vm.workspace = true
Expand Down
52 changes: 52 additions & 0 deletions stwo_cairo_prover/crates/dev_utils/src/bin/export_preprocessed_roots.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
use clap::{Parser, ValueEnum};
use dev_utils::preprocessed_roots::{export_preprocessed_roots, HashSelection};

#[derive(Copy, Clone, Debug, Eq, PartialEq, ValueEnum)]
enum HashArg {
Blake,
Poseidon,
Both,
}

impl From<HashArg> for HashSelection {
fn from(value: HashArg) -> Self {
match value {
HashArg::Blake => HashSelection::Blake,
HashArg::Poseidon => HashSelection::Poseidon,
HashArg::Both => HashSelection::Both,
}
}
}

/// Export preprocessed commitment roots for Cairo preprocessed traces.
///
/// Computes the commitment roots for Blake2s and/or Poseidon252 Merkle channels for all
/// log blowup factors in the range 1..=max.
///
/// Performance note: This computation is slow. It is strongly recommended to run with
/// release optimizations:
///
/// cargo run --release --bin export_preprocessed_roots -- [OPTIONS]
///
/// Examples:
/// # Compute both sets of roots up to the default max (2)
/// cargo run --release --bin export_preprocessed_roots
///
/// # Compute only Blake roots up to 4
/// cargo run --release --bin export_preprocessed_roots -- -m 4 --hash blake
#[derive(Parser, Debug)]
#[command(name = "export_preprocessed_roots")]
struct Args {
/// Maximum log blowup factor (inclusive), computes for 1..=max
#[arg(short = 'm', long = "max-log-blowup-factor", default_value_t = 2)]
max_log_blowup_factor: u32,

/// Hash function to compute roots for: blake, poseidon, or both
#[arg(long = "hash", value_enum, default_value_t = HashArg::Both)]
hash: HashArg,
}

fn main() {
let args = Args::parse();
export_preprocessed_roots(args.max_log_blowup_factor, args.hash.into());
}
1 change: 1 addition & 0 deletions stwo_cairo_prover/crates/dev_utils/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
pub mod preprocessed_roots;
pub mod utils;
71 changes: 71 additions & 0 deletions stwo_cairo_prover/crates/dev_utils/src/preprocessed_roots.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
use cairo_air::PreProcessedTraceVariant;
use itertools::Itertools;
use stwo::core::channel::MerkleChannel;
use stwo::core::vcs::blake2_merkle::Blake2sMerkleChannel;
use stwo::core::vcs::poseidon252_merkle::Poseidon252MerkleChannel;
use stwo::core::vcs::MerkleHasher;
use stwo::prover::backend::BackendForChannel;
use stwo_cairo_prover::witness::preprocessed_trace::generate_preprocessed_commitment_root;

#[derive(Clone, Copy, Debug)]
pub enum HashSelection {
Blake,
Poseidon,
Both,
}

fn get_preprocessed_roots<MC: MerkleChannel>(
max_log_blowup_factor: u32,
preprocessed_trace: PreProcessedTraceVariant,
) -> Vec<<MC::H as MerkleHasher>::Hash>
where
stwo::prover::backend::simd::SimdBackend: BackendForChannel<MC>,
{
(1..=max_log_blowup_factor)
.map(|i| generate_preprocessed_commitment_root::<MC>(i, preprocessed_trace))
.collect_vec()
}

pub fn export_preprocessed_roots(max_log_blowup_factor: u32, selection: HashSelection) {
match selection {
HashSelection::Blake => {
let roots = get_preprocessed_roots::<Blake2sMerkleChannel>(
max_log_blowup_factor,
PreProcessedTraceVariant::Canonical,
);
roots.iter().enumerate().for_each(|(i, root)| {
let root_bytes = root.0;
let u32s_hex = root_bytes
.as_slice()
.chunks_exact(4)
.map(|bytes| {
let arr: [u8; 4] = bytes.try_into().expect("chunk size");
format!("{:#010x}", u32::from_le_bytes(arr))
})
.collect_vec()
.join(", ");
println!("log_blowup_factor: {}, blake root: [{}]", i + 1, u32s_hex);
});
}
HashSelection::Poseidon => {
println!("Starting Poseidon roots");
get_preprocessed_roots::<Poseidon252MerkleChannel>(
max_log_blowup_factor,
PreProcessedTraceVariant::CanonicalWithoutPedersen,
)
.into_iter()
.enumerate()
.for_each(|(i, root)| {
println!(
"log_blowup_factor: {}, poseidon root: [{:#010x}]",
i + 1,
root
);
});
}
HashSelection::Both => {
export_preprocessed_roots(max_log_blowup_factor, HashSelection::Blake);
export_preprocessed_roots(max_log_blowup_factor, HashSelection::Poseidon);
}
}
}
4 changes: 0 additions & 4 deletions stwo_cairo_prover/crates/prover/src/witness/preprocessed_trace.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ use stwo::prover::poly::circle::PolyOps;
use stwo::prover::CommitmentTreeProver;

/// Generates the root of the preprocessed trace commitment tree for a given `log_blowup_factor`.
// TODO(Shahars): remove allow.
#[allow(unused)]
pub fn generate_preprocessed_commitment_root<MC: MerkleChannel>(
log_blowup_factor: u32,
preprocessed_trace: PreProcessedTraceVariant,
Expand All @@ -18,15 +16,13 @@ where
SimdBackend: BackendForChannel<MC>,
{
let preprocessed_trace = preprocessed_trace.to_preprocessed_trace();

// Precompute twiddles for the commitment scheme.
let max_log_size = preprocessed_trace.log_sizes().into_iter().max().unwrap();
let twiddles = SimdBackend::precompute_twiddles(
CanonicCoset::new(max_log_size + log_blowup_factor)
.circle_domain()
.half_coset,
);

// Generate the commitment tree.
let polys = SimdBackend::interpolate_columns(preprocessed_trace.gen_trace(), &twiddles);
let commitment_scheme = CommitmentTreeProver::<SimdBackend, MC>::new(
Expand Down
57 changes: 0 additions & 57 deletions stwo_cairo_prover/crates/prover/src/witness/utils.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
use std::sync::atomic::{AtomicU32, Ordering};

use cairo_air::air::CairoClaim;
use cairo_air::PreProcessedTraceVariant;
use itertools::Itertools;
use num_traits::{One, Zero};
use stwo::core::channel::MerkleChannel;
use stwo::core::fields::m31::M31;
use stwo::core::pcs::{TreeSubspan, TreeVec};
use stwo::core::vcs::blake2_merkle::Blake2sMerkleChannel;
use stwo::core::vcs::poseidon252_merkle::Poseidon252MerkleChannel;
use stwo::core::vcs::MerkleHasher;
use stwo::prover::backend::simd::column::BaseColumn;
use stwo::prover::backend::simd::conversion::Pack;
use stwo::prover::backend::simd::m31::{PackedM31, N_LANES};
Expand All @@ -19,8 +14,6 @@ use stwo::prover::poly::BitReversedOrder;
use stwo_cairo_common::preprocessed_columns::preprocessed_trace::PreProcessedTrace;
use stwo_constraint_framework::PREPROCESSED_TRACE_IDX;

use crate::witness::preprocessed_trace::generate_preprocessed_commitment_root;

pub fn pack_values<T: Pack>(values: &[T]) -> Vec<T::SimdType> {
values
.array_chunks::<N_LANES>()
Expand Down Expand Up @@ -130,56 +123,6 @@ pub fn witness_trace_cells(claim: &CairoClaim, pp_trace: &PreProcessedTrace) ->
tree_trace_cells(log_sizes)
}

fn get_preprocessed_roots<MC: MerkleChannel>(
max_log_blowup_factor: u32,
preprocessed_trace: PreProcessedTraceVariant,
) -> Vec<<MC::H as MerkleHasher>::Hash>
where
stwo::prover::backend::simd::SimdBackend: BackendForChannel<MC>,
{
(1..=max_log_blowup_factor)
.map(|i| generate_preprocessed_commitment_root::<MC>(i, preprocessed_trace))
.collect_vec()
}

/// Exports the preprocessed roots for both Blake2s and Poseidon252 channels.
/// Note: This function is very slow and is intended for generating the preprocessed roots when
/// needed.
pub fn export_preprocessed_roots() {
let max_log_blowup_factor = 5;

// Blake2s roots.
let blake_roots = get_preprocessed_roots::<Blake2sMerkleChannel>(
max_log_blowup_factor,
PreProcessedTraceVariant::Canonical,
);
blake_roots.iter().enumerate().for_each(|(i, root)| {
let root_bytes = root.0;
let u32s_hex = root_bytes
.array_chunks::<4>()
.map(|&bytes| format!("{:#010x}", u32::from_le_bytes(bytes)))
.collect_vec()
.join(", ");

println!("log_blowup_factor: {}, blake root: [{}]", i + 1, u32s_hex);
});

// Poseidon252 roots.
get_preprocessed_roots::<Poseidon252MerkleChannel>(
max_log_blowup_factor,
PreProcessedTraceVariant::CanonicalWithoutPedersen,
)
.into_iter()
.enumerate()
.for_each(|(i, root)| {
println!(
"log_blowup_factor: {}, poseidon root: [{:#010x}]",
i + 1,
root
);
});
}

#[cfg(test)]
mod tests {
use rand::rngs::SmallRng;
Expand Down
Loading