Skip to content

use bincode for faster writing prover input info #2074

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

Merged
merged 1 commit into from
Apr 29, 2025
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
24 changes: 18 additions & 6 deletions cairo-vm-cli/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,10 @@
conflicts_with_all = ["proof_mode", "air_private_input", "air_public_input"]
)]
cairo_pie_output: Option<String>,
#[arg(long = "prover_input_info",
requires_all = ["proof_mode"])]
#[arg(long = "prover_input_info", requires_all = ["proof_mode"])]
prover_input_info: Option<String>,
#[arg(long = "prover_input_info_json", requires_all = ["proof_mode"])]
prover_input_info_json: Option<String>,
#[arg(long = "merge_extra_segments")]
merge_extra_segments: bool,
#[arg(long = "allow_missing_builtins")]
Expand Down Expand Up @@ -175,7 +176,8 @@

let trace_enabled = args.trace_file.is_some()
|| args.air_public_input.is_some()
|| args.prover_input_info.is_some();
|| args.prover_input_info.is_some()
|| args.prover_input_info_json.is_some();

let cairo_layout_params = match args.cairo_layout_params_file {
Some(file) => Some(CairoLayoutParams::from_file(&file)?),
Expand All @@ -191,7 +193,8 @@
secure_run: args.secure_run,
allow_missing_builtins: args.allow_missing_builtins,
dynamic_layout_params: cairo_layout_params,
disable_trace_padding: args.prover_input_info.is_some(),
disable_trace_padding: args.prover_input_info.is_some()
|| args.prover_input_info_json.is_some(),
};

let mut cairo_runner = match if args.run_from_cairo_pie {
Expand Down Expand Up @@ -242,13 +245,22 @@
memory_writer.flush()?;
}

if let Some(prover_input_info_path) = args.prover_input_info {
if let Some(path) = args.prover_input_info {
let prover_input_info = cairo_runner.get_prover_input_info().map_err(|error| {
eprintln!("{error}");
CairoRunError::Runner(error)

Check warning on line 251 in cairo-vm-cli/src/main.rs

View check run for this annotation

Codecov / codecov/patch

cairo-vm-cli/src/main.rs#L250-L251

Added lines #L250 - L251 were not covered by tests
})?;
let bytes = prover_input_info.serialize()?;
std::fs::write(path, bytes)?;
}

if let Some(path) = args.prover_input_info_json {
let prover_input_info = cairo_runner.get_prover_input_info().map_err(|error| {
eprintln!("{error}");
CairoRunError::Runner(error)
})?;
let json = prover_input_info.serialize_json()?;
std::fs::write(prover_input_info_path, json)?;
std::fs::write(path, json)?;

Check warning on line 263 in cairo-vm-cli/src/main.rs

View check run for this annotation

Codecov / codecov/patch

cairo-vm-cli/src/main.rs#L263

Added line #L263 was not covered by tests
}

if let Some(file_path) = args.air_public_input {
Expand Down
2 changes: 1 addition & 1 deletion vm/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ num-integer = { workspace = true }
serde = { workspace = true }
serde_json = { workspace = true }
hex = { workspace = true }
bincode = { workspace = true }
bincode = { workspace = true , features = ["alloc"]}
starknet-crypto = { workspace = true }
sha3 = { workspace = true }
indoc = { workspace = true }
Expand Down
52 changes: 31 additions & 21 deletions vm/src/vm/runners/cairo_runner.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1551,7 +1551,7 @@ impl CairoRunner {
//* ----------------------
/// This struct contains all relevant data for the prover.
/// All addresses are relocatable.
#[derive(Deserialize, Serialize)]
#[derive(Deserialize, Serialize, PartialEq)]
pub struct ProverInputInfo {
/// A vector of trace entries, i.e. pc, ap, fp, where pc is relocatable.
pub relocatable_trace: Vec<TraceEntry>,
Expand All @@ -1567,13 +1567,19 @@ impl ProverInputInfo {
pub fn serialize_json(&self) -> Result<String, ProverInputInfoError> {
serde_json::to_string_pretty(&self).map_err(ProverInputInfoError::from)
}
pub fn serialize(&self) -> Result<Vec<u8>, ProverInputInfoError> {
bincode::serde::encode_to_vec(self, bincode::config::standard())
.map_err(ProverInputInfoError::from)
}
}

// TODO(Stav): add TraceNotEnabled error.
#[derive(Debug, Error)]
pub enum ProverInputInfoError {
#[error("Failed to (de)serialize data")]
Serde(#[from] serde_json::Error),
#[error("Failed to (de)serialize data using bincode")]
SerdeBincode(#[from] bincode::error::EncodeError),
#[error("Failed to (de)serialize data using json")]
SerdeJson(#[from] serde_json::Error),
}

#[derive(Clone, Debug, Eq, PartialEq)]
Expand Down Expand Up @@ -5708,25 +5714,29 @@ mod tests {
};
let runner = crate::cairo_run::cairo_run(program_content, &config, &mut crate::hint_processor::builtin_hint_processor::builtin_hint_processor_definition::BuiltinHintProcessor::new_empty()).unwrap();
let prover_input_info = runner.get_prover_input_info().unwrap();
let serialized_prover_input_info = prover_input_info.serialize_json().unwrap();
let deserialized_prover_input_info: ProverInputInfo =
serde_json::from_str(&serialized_prover_input_info).unwrap();
// Check that the deserialized prover input info is equal to the original one.
assert_eq!(
prover_input_info.relocatable_memory,
deserialized_prover_input_info.relocatable_memory
);
assert_eq!(
prover_input_info.relocatable_trace,
deserialized_prover_input_info.relocatable_trace
);
assert_eq!(
prover_input_info.builtins_segments,
deserialized_prover_input_info.builtins_segments

// Using bincode.
let serialized_prover_input_info = prover_input_info.serialize().unwrap();
let (deserialized_prover_input_info, _): (ProverInputInfo, usize) =
bincode::serde::decode_from_slice(
&serialized_prover_input_info,
bincode::config::standard(),
)
.unwrap();

assert!(
prover_input_info == deserialized_prover_input_info,
"Deserialized ProverInputInfo with bincode does not match the original one."
);
assert_eq!(
prover_input_info.public_memory_offsets,
deserialized_prover_input_info.public_memory_offsets

// Using json.
let serialized_prover_input_info_json = prover_input_info.serialize_json().unwrap();
let deserialized_prover_input_info_json: ProverInputInfo =
serde_json::from_str(&serialized_prover_input_info_json).unwrap();

assert!(
prover_input_info == deserialized_prover_input_info_json,
"Deserialized ProverInputInfo with json does not match the original one."
);
}
}
Loading